5af7b8534f7939e080d3e4440fe6f426745ba955
4 * This file is a library of database access functions for RackTables.
12 'table' => 'RackObject',
18 'barcode' => 'barcode',
19 'asset_no' => 'asset_no',
20 'objtype_id' => 'objtype_id',
21 'rack_id' => '(select rack_id from RackSpace where object_id = id order by rack_id asc limit 1)',
22 'Rack_name' => '(select name from Rack where id = rack_id)',
23 'row_id' => '(select row_id from Rack where id = rack_id)',
24 'Row_name' => '(select name from RackRow where id = row_id)',
25 'has_problems' => 'has_problems',
26 'comment' => 'comment',
27 'nports' => '(SELECT COUNT(*) FROM Port WHERE object_id = RackObject.id)',
28 'runs8021Q' => '(SELECT 1 FROM VLANSwitch WHERE object_id = id LIMIT 1)',
31 'ordcolumns' => array ('RackObject.name'),
35 'table' => 'UserAccount',
38 'user_id' => 'user_id',
39 'user_name' => 'user_name',
40 'user_password_hash' => 'user_password_hash',
41 'user_realname' => 'user_realname',
43 'keycolumn' => 'user_id',
44 'ordcolumns' => array ('UserAccount.user_name'),
48 'table' => 'IPv4Network',
52 'ip' => 'INET_NTOA(IPv4Network.ip)',
55 'comment' => 'comment',
56 'parent_id' => '(SELECT id FROM IPv4Network AS subt WHERE IPv4Network.ip & (4294967295 >> (32 - subt.mask)) << (32 - subt.mask) = subt.ip and subt.mask < IPv4Network.mask ORDER BY subt.mask DESC limit 1)',
57 'vlanc' => '(SELECT COUNT(*) FROM VLANIPv4 WHERE ipv4net_id = id)',
60 'ordcolumns' => array ('IPv4Network.ip', 'IPv4Network.mask'),
64 'table' => 'IPv6Network',
71 'comment' => 'comment',
72 'parent_id' => '(SELECT id FROM IPv6Network AS subt WHERE IPv6Network.ip >= subt.ip AND IPv6Network.last_ip <= subt.last_ip AND IPv6Network.mask > subt.mask ORDER BY subt.mask DESC limit 1)',
73 'vlanc' => '(SELECT COUNT(*) FROM VLANIPv6 WHERE ipv6net_id = id)',
76 'ordcolumns' => array ('IPv6Network.ip', 'IPv6Network.mask'),
90 'comment' => 'comment',
93 'ordcolumns' => array ('File.name'),
101 'vip' => 'INET_NTOA(vip)',
105 'vsconfig' => 'vsconfig',
106 'rsconfig' => 'rsconfig',
107 'poolcount' => '(select count(vs_id) from IPv4LB where vs_id = id)',
108 'dname' => 'CONCAT_WS("/", CONCAT_WS(":", INET_NTOA(vip), vport), proto)',
111 'ordcolumns' => array ('IPv4VS.vip', 'IPv4VS.proto', 'IPv4VS.vport'),
113 'ipv4rspool' => array
115 'table' => 'IPv4RSPool',
120 'refcnt' => '(select count(rspool_id) from IPv4LB where rspool_id = id)',
121 'rscount' => '(select count(rspool_id) from IPv4RS where rspool_id = IPv4RSPool.id)',
122 'vsconfig' => 'vsconfig',
123 'rsconfig' => 'rsconfig',
126 'ordcolumns' => array ('IPv4RSPool.name', 'IPv4RSPool.id'),
135 'height' => 'height',
136 'comment' => 'comment',
137 'row_id' => 'row_id',
138 'row_name' => '(select name from RackRow where RackRow.id = row_id)',
141 'ordcolumns' => array ('row_name', 'Rack.name'),
142 'pidcolumn' => 'row_id',
150 'by_sticker' => 'getStickerSearchResults',
151 'by_port' => 'getPortSearchResults',
152 'by_attr' => 'getObjectAttrsSearchResults',
153 'by_iface' => 'getObjectIfacesSearchResults',
154 'by_nat' => 'getObjectNATSearchResults',
158 $tablemap_8021q = array
162 'pvm' => 'PortVLANMode',
163 'pav' => 'PortAllowedVLAN',
164 'pnv' => 'PortNativeVLAN',
168 'pvm' => 'CachedPVM',
169 'pav' => 'CachedPAV',
170 'pnv' => 'CachedPNV',
175 $port_role_options = array
178 'access' => 'user: access only',
179 'trunk' => 'user: trunk only',
180 'anymode' => 'user: any mode',
181 'uplink' => 'system: uplink trunk',
182 'downlink' => 'system: downlink trunk',
185 $object_attribute_cache = array();
187 function escapeString ($value, $do_db_escape = FALSE)
189 $ret = htmlspecialchars ($value, ENT_QUOTES
, 'UTF-8');
193 $ret = substr ($dbxlink->quote ($ret), 1, -1);
198 // Return detailed information about one rack row.
199 function getRackRowInfo ($rackrow_id)
202 "select RackRow.id as id, RackRow.name as name, count(Rack.id) as count, " .
203 "if(isnull(sum(Rack.height)),0,sum(Rack.height)) as sum " .
204 "from RackRow left join Rack on Rack.row_id = RackRow.id " .
205 "where RackRow.id = ? " .
206 "group by RackRow.id";
207 $result = usePreparedSelectBlade ($query, array ($rackrow_id));
208 if ($row = $result->fetch (PDO
::FETCH_ASSOC
))
211 throw new EntityNotFoundException ('rackrow', $rackrow_id);
214 function getRackRows ()
216 $result = usePreparedSelectBlade ('SELECT id, name FROM RackRow ORDER BY name');
218 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
219 $rows[$row['id']] = $row['name'];
223 // Return a simple object list w/o related information, so that the returned value
224 // can be directly used by printSelect(). An optional argument is the name of config
225 // option with constraint in RackCode.
226 function getNarrowObjectList ($varname = '')
228 $wideList = listCells ('object');
229 if (strlen ($varname) and strlen (getConfigVar ($varname)))
232 if (!isset ($parseCache[$varname]))
233 $parseCache[$varname] = spotPayload (getConfigVar ($varname), 'SYNT_EXPR');
234 if ($parseCache[$varname]['result'] != 'ACK')
236 $wideList = filterCellList ($wideList, $parseCache[$varname]['load']);
239 foreach ($wideList as $cell)
240 $ret[$cell['id']] = $cell['dname'];
244 // For a given realm return a list of entity records, each with
245 // enough information for judgeCell() to execute.
246 function listCells ($realm, $parent_id = 0)
251 if (isset ($entityCache['complete'][$realm]))
252 return $entityCache['complete'][$realm];
255 if (!isset ($SQLSchema[$realm]))
256 throw new InvalidArgException ('realm', $realm);
257 $SQLinfo = $SQLSchema[$realm];
260 foreach ($SQLinfo['columns'] as $alias => $expression)
261 // Automatically prepend table name to each single column, but leave all others intact.
262 $query .= ($alias == $expression ?
"${SQLinfo['table']}.${alias}" : "${expression} as ${alias}") . ', ';
263 $query = trim($query, ', ');
264 $query .= " FROM ${SQLinfo['table']}";
265 if (isset ($SQLinfo['pidcolumn']) and $parent_id)
267 $query .= " WHERE ${SQLinfo['table']}.${SQLinfo['pidcolumn']} = ?";
268 $qparams[] = $parent_id;
270 $query .= " ORDER BY ";
271 foreach ($SQLinfo['ordcolumns'] as $oc)
273 $query = trim($query, ', ');
274 $result = usePreparedSelectBlade ($query, $qparams);
276 // Index returned result by the value of key column.
277 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
279 $entity_id = $row[$SQLinfo['keycolumn']];
280 $ret[$entity_id] = array ('realm' => $realm);
281 $ret[$entity_id]['etags'] = array();
282 foreach (array_keys ($SQLinfo['columns']) as $alias)
283 $ret[$entity_id][$alias] = $row[$alias];
287 // select tags and link them to previosly fetched entities
288 $query = 'SELECT entity_id, tag_id FROM TagStorage WHERE entity_realm = ?';
289 $result = usePreparedSelectBlade ($query, array($realm));
291 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
293 if (array_key_exists($row['entity_id'], $ret))
294 $ret[$row['entity_id']]['etags'][] = array
296 'id' => $row['tag_id'],
297 'tag' => $taglist[$row['tag_id']]['tag'],
298 'parent_id' => $taglist[$row['tag_id']]['parent_id'],
302 // Add necessary finish to the list before returning it. Maintain caches.
304 unset ($entityCache['partial'][$realm]);
305 if ($realm == 'object') // cache all attributes of all objects to speed up autotags calculation
306 cacheAllObjectsAttributes();
307 foreach (array_keys ($ret) as $entity_id)
309 $ret[$entity_id]['etags'] = getExplicitTagsOnly ($ret[$entity_id]['etags']);
310 $ret[$entity_id]['itags'] = getImplicitTags ($ret[$entity_id]['etags']);
311 $ret[$entity_id]['atags'] = generateEntityAutoTags ($ret[$entity_id]);
315 setDisplayedName ($ret[$entity_id]);
318 $ret[$entity_id]['ip_bin'] = ip2long ($ret[$entity_id]['ip']);
319 $ret[$entity_id]['mask_bin'] = binMaskFromDec ($ret[$entity_id]['mask']);
320 $ret[$entity_id]['mask_bin_inv'] = binInvMaskFromDec ($ret[$entity_id]['mask']);
321 $ret[$entity_id]['db_first'] = sprintf ('%u', 0x00000000 +
$ret[$entity_id]['ip_bin'] & $ret[$entity_id]['mask_bin']);
322 $ret[$entity_id]['db_last'] = sprintf ('%u', 0x00000000 +
$ret[$entity_id]['ip_bin'] |
($ret[$entity_id]['mask_bin_inv']));
325 $ret[$entity_id]['ip_bin'] = new IPv6Address ($ret[$entity_id]['ip_bin']);
326 $ret[$entity_id]['ip'] = $ret[$entity_id]['ip_bin']->format();
327 $ret[$entity_id]['db_first'] = $ret[$entity_id]['ip_bin']->get_first_subnet_address($ret[$entity_id]['mask']);
328 $ret[$entity_id]['db_last'] = $ret[$entity_id]['ip_bin']->get_last_subnet_address($ret[$entity_id]['mask']);
334 $entityCache['complete'][$realm][$entity_id] = $ret[$entity_id];
336 $entityCache['partial'][$realm][$entity_id] = $ret[$entity_id];
341 // Very much like listCells(), but return only one record requested (or NULL,
342 // if it does not exist).
343 function spotEntity ($realm, $id)
346 if (isset ($entityCache['complete'][$realm]))
347 // Emphasize the absence of record, if listCells() has already been called.
348 if (isset ($entityCache['complete'][$realm][$id]))
349 return $entityCache['complete'][$realm][$id];
351 throw new EntityNotFoundException ($realm, $id);
352 elseif (isset ($entityCache['partial'][$realm][$id]))
353 return $entityCache['partial'][$realm][$id];
355 if (!isset ($SQLSchema[$realm]))
356 throw new InvalidArgException ('realm', $realm);
357 $SQLinfo = $SQLSchema[$realm];
358 $query = 'SELECT tag_id';
359 foreach ($SQLinfo['columns'] as $alias => $expression)
360 // Automatically prepend table name to each single column, but leave all others intact.
361 $query .= ', ' . ($alias == $expression ?
"${SQLinfo['table']}.${alias}" : "${expression} as ${alias}");
362 $query .= " FROM ${SQLinfo['table']} LEFT JOIN TagStorage on entity_realm = ? and entity_id = ${SQLinfo['table']}.${SQLinfo['keycolumn']}";
363 $query .= " WHERE ${SQLinfo['table']}.${SQLinfo['keycolumn']} = ?";
364 $query .= " ORDER BY tag_id";
365 $result = usePreparedSelectBlade ($query, array ($realm, $id));
368 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
369 if (!isset ($ret['realm']))
371 $ret = array ('realm' => $realm);
372 foreach (array_keys ($SQLinfo['columns']) as $alias)
373 $ret[$alias] = $row[$alias];
374 $ret['etags'] = array();
375 if ($row['tag_id'] != NULL && isset ($taglist[$row['tag_id']]))
376 $ret['etags'][] = array
378 'id' => $row['tag_id'],
379 'tag' => $taglist[$row['tag_id']]['tag'],
380 'parent_id' => $taglist[$row['tag_id']]['parent_id'],
383 elseif (isset ($taglist[$row['tag_id']]))
384 $ret['etags'][] = array
386 'id' => $row['tag_id'],
387 'tag' => $taglist[$row['tag_id']]['tag'],
388 'parent_id' => $taglist[$row['tag_id']]['parent_id'],
391 if (!isset ($ret['realm'])) // no rows were returned
392 throw new EntityNotFoundException ($realm, $id);
393 $ret['etags'] = getExplicitTagsOnly ($ret['etags']);
394 $ret['itags'] = getImplicitTags ($ret['etags']);
395 $ret['atags'] = generateEntityAutoTags ($ret);
399 setDisplayedName ($ret);
402 $ret['ip_bin'] = ip2long ($ret['ip']);
403 $ret['mask_bin'] = binMaskFromDec ($ret['mask']);
404 $ret['mask_bin_inv'] = binInvMaskFromDec ($ret['mask']);
405 $ret['db_first'] = sprintf ('%u', 0x00000000 +
$ret['ip_bin'] & $ret['mask_bin']);
406 $ret['db_last'] = sprintf ('%u', 0x00000000 +
$ret['ip_bin'] |
($ret['mask_bin_inv']));
409 $ret['ip_bin'] = new IPv6Address ($ret['ip_bin']);
410 $ret['ip'] = $ret['ip_bin']->format();
411 $ret['db_first'] = $ret['ip_bin']->get_first_subnet_address($ret['mask']);
412 $ret['db_last'] = $ret['ip_bin']->get_last_subnet_address($ret['mask']);
417 $entityCache['partial'][$realm][$id] = $ret;
421 // This function can be used with array_walk().
422 function amplifyCell (&$record, $dummy = NULL)
424 switch ($record['realm'])
427 $record['ports'] = getObjectPortsAndLinks ($record['id']);
428 $record['ipv4'] = getObjectIPv4Allocations ($record['id']);
429 $record['ipv6'] = getObjectIPv6Allocations ($record['id']);
430 $record['nat4'] = getNATv4ForObject ($record['id']);
431 $record['ipv4rspools'] = getRSPoolsForObject ($record['id']);
432 $record['files'] = getFilesOfEntity ($record['realm'], $record['id']);
435 $record['links'] = getFileLinks ($record['id']);
438 $record['lblist'] = array();
439 $query = "select object_id, vs_id, lb.vsconfig, lb.rsconfig, lb.prio from " .
440 "IPv4LB as lb inner join IPv4VS as vs on lb.vs_id = vs.id " .
441 "where rspool_id = ? order by object_id, vip, vport";
442 $result = usePreparedSelectBlade ($query, array ($record['id']));
443 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
444 $record['lblist'][$row['object_id']][$row['vs_id']] = array
446 'rsconfig' => $row['rsconfig'],
447 'vsconfig' => $row['vsconfig'],
448 'prio' => $row['prio'],
451 $record['rslist'] = array();
452 $query = "select id, inservice, inet_ntoa(rsip) as rsip, rsport, rsconfig from " .
453 "IPv4RS where rspool_id = ? order by IPv4RS.rsip, rsport";
454 $result = usePreparedSelectBlade ($query, array ($record['id']));
455 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
456 $record['rslist'][$row['id']] = array
458 'inservice' => $row['inservice'],
459 'rsip' => $row['rsip'],
460 'rsport' => $row['rsport'],
461 'rsconfig' => $row['rsconfig'],
466 // Get the detailed composition of a particular virtual service, namely the list
467 // of all pools, each shown with the list of objects servicing it. VS/RS configs
468 // will be returned as well.
469 $record['rspool'] = array();
470 $query = "select pool.id, name, pool.vsconfig, pool.rsconfig, object_id, " .
471 "lb.vsconfig as lb_vsconfig, lb.rsconfig as lb_rsconfig, lb.prio from " .
472 "IPv4RSPool as pool left join IPv4LB as lb on pool.id = lb.rspool_id " .
473 "where vs_id = ? order by pool.name, object_id";
474 $result = usePreparedSelectBlade ($query, array ($record['id']));
475 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
477 if (!isset ($record['rspool'][$row['id']]))
478 $record['rspool'][$row['id']] = array
480 'name' => $row['name'],
481 'vsconfig' => $row['vsconfig'],
482 'rsconfig' => $row['rsconfig'],
485 if ($row['object_id'] == NULL)
487 $record['rspool'][$row['id']]['lblist'][$row['object_id']] = array
489 'vsconfig' => $row['lb_vsconfig'],
490 'rsconfig' => $row['lb_rsconfig'],
491 'prio' => $row['prio'],
497 $record['mountedObjects'] = array();
498 // start with default rackspace
499 for ($i = $record['height']; $i > 0; $i--)
500 for ($locidx = 0; $locidx < 3; $locidx++
)
501 $record[$i][$locidx]['state'] = 'F';
504 "select unit_no, atom, state, object_id " .
505 "from RackSpace where rack_id = ? and " .
506 "unit_no between 1 and ? order by unit_no";
507 $result = usePreparedSelectBlade ($query, array ($record['id'], $record['height']));
509 $mounted_objects = array();
510 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
512 $record[$row['unit_no']][$loclist[$row['atom']]]['state'] = $row['state'];
513 $record[$row['unit_no']][$loclist[$row['atom']]]['object_id'] = $row['object_id'];
514 if ($row['state'] == 'T' and $row['object_id'] != NULL)
515 $mounted_objects[$row['object_id']] = TRUE;
517 $record['mountedObjects'] = array_keys ($mounted_objects);
521 $record['8021q'] = getIPv4Network8021QBindings ($record['id']);
524 $record['8021q'] = getIPv6Network8021QBindings ($record['id']);
530 function getObjectPortsAndLinks ($object_id)
532 $query = "SELECT id, name, label, l2address, iif_id, (SELECT iif_name FROM PortInnerInterface WHERE id = iif_id) AS iif_name, " .
533 "type AS oif_id, (SELECT dict_value FROM Dictionary WHERE dict_key = type) AS oif_name, reservation_comment " .
534 "FROM Port WHERE object_id = ?";
535 // list and decode all ports of the current object
536 $result = usePreparedSelectBlade ($query, array ($object_id));
538 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
540 $row['l2address'] = l2addressFromDatabase ($row['l2address']);
541 $row['remote_id'] = NULL;
542 $row['remote_name'] = NULL;
543 $row['remote_object_id'] = NULL;
547 // now find and decode remote ends for all locally terminated connections
548 // FIXME: can't this data be extracted in one pass with sub-queries?
549 foreach (array_keys ($ret) as $tmpkey)
551 $portid = $ret[$tmpkey]['id'];
553 $query = "select porta, portb, cable from Link where porta = ? or portb = ?";
554 $result = usePreparedSelectBlade ($query, array ($portid, $portid));
555 $cable = "CableID n/a";
556 if ($row = $result->fetch (PDO
::FETCH_ASSOC
))
558 if ($portid != $row['porta'])
559 $remote_id = $row['porta'];
560 elseif ($portid != $row['portb'])
561 $remote_id = $row['portb'];
562 $cable = $row['cable'];
565 if ($remote_id) // there's a remote end here
567 $query = "SELECT name, object_id FROM Port WHERE id = ?";
568 $result = usePreparedSelectBlade ($query, array ($remote_id));
569 if ($row = $result->fetch (PDO
::FETCH_ASSOC
))
571 $ret[$tmpkey]['remote_name'] = $row['name'];
572 $ret[$tmpkey]['remote_object_id'] = $row['object_id'];
573 $ret[$tmpkey]['cableid'] = $cable;
575 $ret[$tmpkey]['remote_id'] = $remote_id;
579 return sortPortList ($ret, TRUE);
582 function commitAddRack ($name, $height, $row_id, $comment, $taglist)
584 usePreparedInsertBlade
592 'comment' => $comment
595 $last_insert_id = lastInsertID();
596 produceTagsForLastRecord ('rack', $taglist, $last_insert_id);
597 recordHistory ('Rack', $last_insert_id);
600 function commitAddObject ($new_name, $new_label, $new_barcode, $new_type_id, $new_asset_no, $taglist = array())
602 // Maintain UNIQUE INDEX for common names and asset tags by
603 // filtering out empty strings (not NULLs).
604 $result1 = usePreparedInsertBlade
609 'name' => !strlen ($new_name) ?
NULL : $new_name,
610 'label' => $new_label,
611 'barcode' => !strlen ($new_barcode) ?
NULL : $new_barcode,
612 'objtype_id' => $new_type_id,
613 'asset_no' => !strlen ($new_asset_no) ?
NULL : $new_asset_no,
616 $last_insert_id = lastInsertID();
617 // Do AutoPorts magic
618 executeAutoPorts ($last_insert_id, $new_type_id);
620 produceTagsForLastRecord ('object', $taglist, $last_insert_id);
622 recordHistory ('RackObject', $last_insert_id);
624 return $last_insert_id;
627 function commitUpdateObject ($object_id, $new_name, $new_label, $new_barcode, $new_has_problems, $new_asset_no, $new_comment)
629 usePreparedUpdateBlade
634 'name' => !mb_strlen ($new_name) ?
NULL : $new_name,
635 'label' => !mb_strlen ($new_label) ?
NULL : $new_label,
636 'barcode' => !mb_strlen ($new_barcode) ?
NULL : $new_barcode,
637 'has_problems' => $new_has_problems,
638 'asset_no' => !mb_strlen ($new_asset_no) ?
NULL : $new_asset_no,
639 'comment' => $new_comment,
646 return recordHistory ('RackObject', $object_id);
649 // find either parents or children of a record
650 function getEntityRelatives ($type, $entity_type, $entity_id)
652 if ($type == 'parents')
654 // searching for parents
656 'SELECT id, parent_entity_type AS entity_type, parent_entity_id AS entity_id FROM EntityLink ' .
657 'WHERE child_entity_type = ? AND child_entity_id = ?';
661 // searching for children
663 'SELECT id, child_entity_type AS entity_type, child_entity_id AS entity_id FROM EntityLink ' .
664 'WHERE parent_entity_type = ? AND parent_entity_id = ?';
666 $query = usePreparedSelectBlade ($sql, array ($entity_type, $entity_id));
667 $rows = $query->fetchAll (PDO
::FETCH_ASSOC
);
669 foreach ($rows as $row)
671 // get info of the relative (only objects supported now, others may be added later)
672 switch ($row['entity_type'])
676 $id_name = 'object_id';
677 $relative = spotEntity ($row['entity_type'], $row['entity_id']);
678 $name = $relative['dname'];
682 // name needs to have some value for hrefs to work
684 $name = sprintf("[Unnamed %s]", formatEntityName($row['entity_type']));
686 $ret[$row['id']] = array(
688 'id_name' => $id_name,
689 'entity_type' => $row['entity_type'],
690 'entity_id' => $row['entity_id'],
694 // FIXME: .amd - doesn't work when getEntityRelatives is called twice
697 function compare_name ($a, $b)
699 return strnatcmp($a['name'], $b['name']);
701 uasort($ret, 'compare_name');
706 function commitUnlinkEntities ($link_id)
708 return usePreparedDeleteBlade ('EntityLink', array ('id' => $link_id));
711 // The following functions return stats about VM-related info.
712 // TODO: simplify the queries
713 function getVMClusterSummary ()
715 $result = usePreparedSelectBlade
717 "SELECT RO.id, RO.name, " .
718 "(SELECT COUNT(*) FROM EntityLink EL " .
719 "LEFT JOIN RackObject RO_H ON EL.child_entity_id = RO_H.id " .
720 "LEFT JOIN AttributeValue AV ON RO_H.id = AV.object_id " .
721 "WHERE EL.parent_entity_type = 'object' " .
722 "AND EL.child_entity_type = 'object' " .
723 "AND EL.parent_entity_id = RO.id " .
724 "AND RO_H.objtype_id = 4 " .
725 "AND AV.attr_id = 26 " .
726 "AND AV.uint_value = 1501) AS hypervisors, " .
727 "(SELECT COUNT(*) FROM EntityLink EL " .
728 "LEFT JOIN RackObject RO_VM ON EL.child_entity_id = RO_VM.id " .
729 "WHERE EL.parent_entity_type = 'object' " .
730 "AND EL.child_entity_type = 'object' " .
731 "AND EL.parent_entity_id = RO.id " .
732 "AND RO_VM.objtype_id = 1504) AS VMs " .
733 "FROM RackObject RO " .
734 "WHERE RO.objtype_id = 1505 " .
737 return $result->fetchAll (PDO
::FETCH_ASSOC
);
740 function getVMResourcePoolSummary ()
742 $result = usePreparedSelectBlade
744 "SELECT RO.id, RO.name, " .
746 "FROM EntityLink EL " .
747 "LEFT JOIN RackObject RO_C ON EL.parent_entity_id = RO_C.id " .
748 "WHERE EL.child_entity_id = RO.id " .
749 "AND EL.parent_entity_type = 'object' " .
750 "AND EL.child_entity_type = 'object' " .
751 "AND RO_C.objtype_id = 1505) AS cluster_id, " .
752 "(SELECT RO_C.name " .
753 "FROM EntityLink EL " .
754 "LEFT JOIN RackObject RO_C ON EL.parent_entity_id = RO_C.id " .
755 "WHERE EL.child_entity_id = RO.id " .
756 "AND EL.parent_entity_type = 'object' " .
757 "AND EL.child_entity_type = 'object' " .
758 "AND RO_C.objtype_id = 1505) AS cluster_name, " .
759 "(SELECT COUNT(*) FROM EntityLink EL " .
760 "LEFT JOIN RackObject RO_VM ON EL.child_entity_id = RO_VM.id " .
761 "WHERE EL.parent_entity_type = 'object' " .
762 "AND EL.child_entity_type = 'object' " .
763 "AND EL.parent_entity_id = RO.id " .
764 "AND RO_VM.objtype_id = 1504) AS VMs " .
765 "FROM RackObject RO " .
766 "WHERE RO.objtype_id = 1506 " .
769 return $result->fetchAll (PDO
::FETCH_ASSOC
);
772 function getVMHypervisorSummary ()
774 $result = usePreparedSelectBlade
776 "SELECT RO.id, RO.name, " .
778 "FROM EntityLink EL " .
779 "LEFT JOIN RackObject RO_C ON EL.parent_entity_id = RO_C.id " .
780 "WHERE EL.child_entity_id = RO.id " .
781 "AND EL.parent_entity_type = 'object' " .
782 "AND EL.child_entity_type = 'object' " .
783 "AND RO_C.objtype_id = 1505) AS cluster_id, " .
784 "(SELECT RO_C.name " .
785 "FROM EntityLink EL " .
786 "LEFT JOIN RackObject RO_C ON EL.parent_entity_id = RO_C.id " .
787 "WHERE EL.child_entity_id = RO.id " .
788 "AND EL.parent_entity_type = 'object' " .
789 "AND EL.child_entity_type = 'object' " .
790 "AND RO_C.objtype_id = 1505) AS cluster_name, " .
791 "(SELECT COUNT(*) FROM EntityLink EL " .
792 "LEFT JOIN RackObject RO_VM ON EL.child_entity_id = RO_VM.id " .
793 "WHERE EL.parent_entity_type = 'object' " .
794 "AND EL.child_entity_type = 'object' " .
795 "AND EL.parent_entity_id = RO.id " .
796 "AND RO_VM.objtype_id = 1504) AS VMs " .
797 "FROM RackObject RO " .
798 "LEFT JOIN AttributeValue AV ON RO.id = AV.object_id " .
799 "WHERE RO.objtype_id = 4 " .
800 "AND AV.attr_id = 26 " .
801 "AND AV.uint_value = 1501 " .
804 return $result->fetchAll (PDO
::FETCH_ASSOC
);
807 function getVMSwitchSummary ()
809 $result = usePreparedSelectBlade
811 "SELECT RO.id, RO.name " .
812 "FROM RackObject RO " .
813 "WHERE RO.objtype_id = 1507 " .
816 return $result->fetchAll (PDO
::FETCH_ASSOC
);
819 // Remove file links related to the entity, but leave the entity and file(s) intact.
820 function releaseFiles ($entity_realm, $entity_id)
822 usePreparedDeleteBlade ('FileLink', array ('entity_type' => $entity_realm, 'entity_id' => $entity_id));
825 // There are times when you want to delete all traces of an object
826 function commitDeleteObject ($object_id = 0)
828 // Reset most of stuff
829 commitResetObject ($object_id);
831 usePreparedDeleteBlade ('RackObject', array ('id' => $object_id));
834 function commitResetObject ($object_id = 0)
836 releaseFiles ('object', $object_id);
837 destroyTagsForEntity ('object', $object_id);
838 usePreparedDeleteBlade ('IPv4LB', array ('object_id' => $object_id));
839 usePreparedDeleteBlade ('IPv4Allocation', array ('object_id' => $object_id));
840 usePreparedDeleteBlade ('IPv6Allocation', array ('object_id' => $object_id));
841 usePreparedDeleteBlade ('IPv4NAT', array ('object_id' => $object_id));
843 usePreparedExecuteBlade ('DELETE FROM Atom WHERE molecule_id IN (SELECT new_molecule_id FROM MountOperation WHERE object_id = ?)', array ($object_id));
844 usePreparedExecuteBlade ('DELETE FROM Molecule WHERE id IN (SELECT new_molecule_id FROM MountOperation WHERE object_id = ?)', array ($object_id));
845 usePreparedDeleteBlade ('MountOperation', array ('object_id' => $object_id));
846 usePreparedDeleteBlade ('RackSpace', array ('object_id' => $object_id));
848 usePreparedDeleteBlade ('PortVLANMode', array ('object_id' => $object_id));
849 usePreparedDeleteBlade ('PortNativeVLAN', array ('object_id' => $object_id));
850 usePreparedDeleteBlade ('PortAllowedVLAN', array ('object_id' => $object_id));
851 usePreparedDeleteBlade ('CachedPVM', array ('object_id' => $object_id));
852 usePreparedDeleteBlade ('VLANSwitch', array ('object_id' => $object_id));
854 usePreparedDeleteBlade ('Port', array ('object_id' => $object_id));
856 usePreparedUpdateBlade ('RackObject', array ('name' => NULL, 'label' => ''), array ('id' => $object_id));
858 commitUpdateAttrValue ($object_id, 3, "");
860 recordHistory ('RackObject', $object_id);
863 function commitDeleteRack($rack_id)
865 releaseFiles ('rack', $rack_id);
866 destroyTagsForEntity ('rack', $rack_id);
867 usePreparedDeleteBlade ('RackSpace', array ('rack_id' => $rack_id));
868 usePreparedDeleteBlade ('RackHistory', array ('id' => $rack_id));
869 usePreparedDeleteBlade ('Rack', array ('id' => $rack_id));
873 function commitUpdateRack ($rack_id, $new_name, $new_height, $new_row_id, $new_comment)
875 // Can't shrink a rack if rows being deleted contain mounted objects
876 $check_result = usePreparedSelectBlade ('SELECT COUNT(*) AS count FROM RackSpace WHERE rack_id = ? AND unit_no > ?', array ($rack_id, $new_height));
877 $check_row = $check_result->fetch (PDO
::FETCH_ASSOC
);
878 unset ($check_result);
879 if ($check_row['count'] > 0)
880 throw new InvalidArgException ('new_height', $new_height, 'Cannot shrink rack, objects are still mounted there');
881 usePreparedUpdateBlade
887 'height' => $new_height,
888 'comment' => $new_comment,
889 'row_id' => $new_row_id,
896 return recordHistory ('Rack', $rack_id);
899 // This function accepts rack data returned by amplifyCell(), validates and applies changes
900 // supplied in $_REQUEST and returns resulting array. Only those changes are examined, which
901 // correspond to current rack ID.
902 // 1st arg is rackdata, 2nd arg is unchecked state, 3rd arg is checked state.
903 // If 4th arg is present, object_id fields will be updated accordingly to the new state.
904 // The function returns the modified rack upon success.
905 function processGridForm (&$rackData, $unchecked_state, $checked_state, $object_id = 0)
908 $rack_id = $rackData['id'];
909 $rack_name = $rackData['name'];
910 $rackchanged = FALSE;
911 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
913 for ($locidx = 0; $locidx < 3; $locidx++
)
915 if ($rackData[$unit_no][$locidx]['enabled'] != TRUE)
918 $state = $rackData[$unit_no][$locidx]['state'];
919 if (isset ($_REQUEST["atom_${rack_id}_${unit_no}_${locidx}"]) and $_REQUEST["atom_${rack_id}_${unit_no}_${locidx}"] == 'on')
920 $newstate = $checked_state;
922 $newstate = $unchecked_state;
923 if ($state == $newstate)
927 $atom = $loclist[$locidx];
928 // The only changes allowed are those introduced by checkbox grid.
931 !($state == $checked_state && $newstate == $unchecked_state) &&
932 !($state == $unchecked_state && $newstate == $checked_state)
934 return array ('code' => 500, 'message' => "${rack_name}: Rack ID ${rack_id}, unit ${unit_no}, 'atom ${atom}', cannot change state from '${state}' to '${newstate}'");
935 // Here we avoid using ON DUPLICATE KEY UPDATE by first performing DELETE
936 // anyway and then looking for probable need of INSERT.
937 usePreparedDeleteBlade ('RackSpace', array ('rack_id' => $rack_id, 'unit_no' => $unit_no, 'atom' => $atom));
938 if ($newstate != 'F')
939 usePreparedInsertBlade ('RackSpace', array ('rack_id' => $rack_id, 'unit_no' => $unit_no, 'atom' => $atom, 'state' => $newstate));
940 if ($newstate == 'T' and $object_id != 0)
942 // At this point we already have a record in RackSpace.
943 $r = usePreparedUpdateBlade
946 array ('object_id' => $object_id),
949 'rack_id' => $rack_id,
950 'unit_no' => $unit_no,
955 return array ('code' => 500, 'message' => "${rack_name}: Rack ID ${rack_id}, unit ${unit_no}, atom '${atom}' failed to set object_id to '${object_id}'");
956 $rackData[$unit_no][$locidx]['object_id'] = $object_id;
962 usePreparedUpdateBlade ('Rack', array ('thumb_data' => NULL), array ('id' => $rack_id));
963 return array ('code' => 200, 'message' => "${rack_name}: All changes were successfully saved.");
966 return array ('code' => 300, 'message' => "${rack_name}: No changes.");
969 // This function builds a list of rack-unit-atom records, which are assigned to
970 // the requested object.
971 function getMoleculeForObject ($object_id)
973 $result = usePreparedSelectBlade
975 'SELECT rack_id, unit_no, atom FROM RackSpace ' .
976 'WHERE state = "T" AND object_id = ? ORDER BY rack_id, unit_no, atom',
979 return $result->fetchAll (PDO
::FETCH_ASSOC
);
982 // This function builds a list of rack-unit-atom records for requested molecule.
983 function getMolecule ($mid = 0)
985 $result = usePreparedSelectBlade ('SELECT rack_id, unit_no, atom FROM Atom WHERE molecule_id = ?', array ($mid));
986 return $result->fetchAll (PDO
::FETCH_ASSOC
);
989 // returns exactly what is's named after
990 function lastInsertID ()
992 $result = usePreparedSelectBlade ('select last_insert_id()');
993 $row = $result->fetch (PDO
::FETCH_NUM
);
997 // This function creates a new record in Molecule and number of linked
998 // R-U-A records in Atom.
999 function createMolecule ($molData)
1001 usePreparedExecuteBlade ('INSERT INTO Molecule VALUES()');
1002 $molecule_id = lastInsertID();
1003 foreach ($molData as $rua)
1004 usePreparedInsertBlade
1009 'molecule_id' => $molecule_id,
1010 'rack_id' => $rua['rack_id'],
1011 'unit_no' => $rua['unit_no'],
1012 'atom' => $rua['atom'],
1015 return $molecule_id;
1018 // History logger. This function assumes certain table naming convention and
1020 // 1. History table name equals to dictionary table name plus 'History'.
1021 // 2. History table must have the same row set (w/o keys) plus one row named
1022 // 'ctime' of type 'timestamp'.
1023 function recordHistory ($tableName, $orig_id)
1025 global $remote_username;
1026 return FALSE !== usePreparedExecuteBlade
1028 "INSERT INTO ${tableName}History SELECT *, CURRENT_TIMESTAMP(), ? " .
1029 "FROM ${tableName} WHERE id=?",
1030 array ($remote_username, $orig_id)
1034 function getRackspaceHistory ()
1036 $result = usePreparedSelectBlade
1038 "SELECT id as mo_id, object_id as ro_id, ctime, comment, user_name FROM " .
1039 "MountOperation ORDER BY ctime DESC"
1041 return $result->fetchAll (PDO
::FETCH_ASSOC
);
1044 // This function is used in renderRackspaceHistory()
1045 function getOperationMolecules ($op_id = 0)
1047 $result = usePreparedSelectBlade ('SELECT old_molecule_id, new_molecule_id FROM MountOperation WHERE id = ?', array ($op_id));
1048 // We expect one row.
1049 $row = $result->fetch (PDO
::FETCH_ASSOC
);
1050 return array ($row['old_molecule_id'], $row['new_molecule_id']);
1053 function getResidentRacksData ($object_id = 0, $fetch_rackdata = TRUE)
1055 $result = usePreparedSelectBlade ('SELECT DISTINCT rack_id FROM RackSpace WHERE object_id = ? ORDER BY rack_id', array ($object_id));
1056 $rows = $result->fetchAll (PDO
::FETCH_NUM
);
1059 foreach ($rows as $row)
1061 if (!$fetch_rackdata)
1063 $ret[$row[0]] = $row[0];
1066 $rackData = spotEntity ('rack', $row[0]);
1067 amplifyCell ($rackData);
1068 $ret[$row[0]] = $rackData;
1073 function commitAddPort ($object_id = 0, $port_name, $port_type_id, $port_label, $port_l2address)
1075 $db_l2address = l2addressForDatabase ($port_l2address);
1077 $dbxlink->exec ('LOCK TABLES Port WRITE');
1078 if (alreadyUsedL2Address ($db_l2address, $object_id))
1080 $dbxlink->exec ('UNLOCK TABLES');
1081 throw new InvalidRequestArgException ('port_l2address', $port_l2address, 'address belongs to another object');
1086 case preg_match ('/^([[:digit:]]+)-([[:digit:]]+)$/', $port_type_id, $matches):
1087 $iif_id = $matches[1];
1088 $oif_id = $matches[2];
1090 case preg_match ('/^([[:digit:]]+)$/', $port_type_id, $matches):
1092 $oif_id = $matches[1];
1095 $dbxlink->exec ('UNLOCK TABLES');
1096 throw new InvalidArgException ('port_type_id', $port_type_id, 'format error');
1098 $result = usePreparedInsertBlade
1103 'name' => $port_name,
1104 'object_id' => $object_id,
1105 'label' => $port_label,
1106 'iif_id' => $iif_id,
1108 'l2address' => ($db_l2address === '') ?
NULL : $db_l2address,
1111 $dbxlink->exec ('UNLOCK TABLES');
1114 // The fifth argument may be either explicit 'NULL' or some (already quoted by the upper layer)
1115 // string value. In case it is omitted, we just assign it its current value.
1116 // It would be nice to simplify this semantics later.
1117 function commitUpdatePort ($object_id, $port_id, $port_name, $port_type_id, $port_label, $port_l2address, $port_reservation_comment)
1119 $db_l2address = l2addressForDatabase ($port_l2address);
1121 $dbxlink->exec ('LOCK TABLES Port WRITE');
1122 if (alreadyUsedL2Address ($db_l2address, $object_id))
1124 $dbxlink->exec ('UNLOCK TABLES');
1125 // FIXME: it is more correct to throw InvalidArgException here
1126 // and convert it to InvalidRequestArgException at upper level,
1127 // when there is a mean to do that.
1128 throw new InvalidRequestArgException ('port_l2address', $db_l2address, 'address belongs to another object');
1130 usePreparedUpdateBlade
1135 'name' => $port_name,
1136 'type' => $port_type_id,
1137 'label' => $port_label,
1138 'reservation_comment' => mb_strlen ($port_reservation_comment) ?
$port_reservation_comment : NULL,
1139 'l2address' => ($db_l2address === '') ?
NULL : $db_l2address,
1144 'object_id' => $object_id
1147 $dbxlink->exec ('UNLOCK TABLES');
1150 function getAllIPv4Allocations ()
1152 $result = usePreparedSelectBlade
1154 "select object_id as object_id, ".
1155 "RackObject.name as object_name, ".
1156 "IPv4Allocation.name as name, ".
1157 "INET_NTOA(ip) as ip ".
1158 "from IPv4Allocation join RackObject on id=object_id "
1161 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
1166 function linkPorts ($porta, $portb, $cable = NULL)
1168 if ($porta == $portb)
1169 throw new InvalidArgException ('porta/portb', $porta, "Ports can't be the same");
1172 $dbxlink->exec ('LOCK TABLES Link WRITE');
1173 $result = usePreparedSelectBlade
1175 'SELECT COUNT(*) FROM Link WHERE porta IN (?,?) OR portb IN (?,?)',
1176 array ($porta, $portb, $porta, $portb)
1178 if ($result->fetchColumn () != 0)
1180 $dbxlink->exec ('UNLOCK TABLES');
1181 return "Port ${porta} or ${portb} is already linked";
1183 if ($porta > $portb)
1189 $ret = FALSE !== usePreparedInsertBlade ('Link', array ('porta' => $porta, 'portb' => $portb, 'cable' => $cable));
1190 $dbxlink->exec ('UNLOCK TABLES');
1191 $ret = $ret and FALSE !== usePreparedExecuteBlade
1193 'UPDATE Port SET reservation_comment=NULL WHERE id IN(?, ?)',
1194 array ($porta, $portb)
1196 return $ret ?
'' : 'query failed';
1199 // Return all IPv4 addresses allocated to the objects. Attach detailed
1200 // info about address to each alocation records. Index result by dotted-quad
1202 function getObjectIPv4Allocations ($object_id = 0)
1205 $result = usePreparedSelectBlade
1207 'SELECT name AS osif, type, inet_ntoa(ip) AS dottedquad FROM IPv4Allocation ' .
1208 'WHERE object_id = ? ORDER BY ip',
1211 // don't spawn a sub-query with unfetched buffer, it may fail
1212 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
1213 $ret[$row['dottedquad']] = array ('osif' => $row['osif'], 'type' => $row['type']);
1215 foreach (array_keys ($ret) as $dottedquad)
1216 $ret[$dottedquad]['addrinfo'] = getIPv4Address ($dottedquad);
1220 // Return all IPv6 addresses allocated to the objects. Attach detailed
1221 // info about address to each alocation records. Index result by binary string of IPv6
1222 function getObjectIPv6Allocations ($object_id = 0)
1225 $result = usePreparedSelectBlade
1227 'SELECT name AS osif, type, ip AS ip FROM IPv6Allocation ' .
1228 'WHERE object_id = ? ORDER BY ip',
1231 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
1232 $ret[$row['ip']] = array ('osif' => $row['osif'], 'type' => $row['type']);
1234 foreach (array_keys ($ret) as $ip_bin)
1235 $ret[$ip_bin]['addrinfo'] = getIPv6Address (new IPv6Address ($ip_bin));
1239 // Return minimal IPv4 address, optionally with "ip" key set, if requested.
1240 function constructIPv4Address ($dottedquad = NULL)
1249 'rslist' => array(),
1250 'allocs' => array(),
1253 if ($dottedquad != NULL)
1254 $ret['ip'] = $dottedquad;
1258 // Return minimal IPv6 address, optionally with "ip" key set, if requested.
1259 function constructIPv6Address ($bin_ip = NULL)
1266 'allocs' => array(),
1268 if ($bin_ip != NULL)
1269 $ret['ip'] = $bin_ip->format();
1273 // Check the range requested for meaningful IPv4 records, build them
1274 // into a list and return. Return an empty list if nothing matched.
1275 // Both arguments are expected in signed int32 form. The resulting list
1276 // is keyed by uint32 form of each IP address, items aren't sorted.
1277 // LATER: accept a list of pairs and build WHERE sub-expression accordingly
1278 function scanIPv4Space ($pairlist)
1281 if (!count ($pairlist)) // this is normal for a network completely divided into smaller parts
1283 // FIXME: this is a copy-and-paste prototype
1292 foreach ($pairlist as $tmp)
1294 $db_first = sprintf ('%u', 0x00000000 +
$tmp['i32_first']);
1295 $db_last = sprintf ('%u', 0x00000000 +
$tmp['i32_last']);
1296 $whereexpr1 .= $or . "ip between ? and ?";
1297 $whereexpr2 .= $or . "ip between ? and ?";
1298 $whereexpr3 .= $or . "vip between ? and ?";
1299 $whereexpr4 .= $or . "rsip between ? and ?";
1300 $whereexpr5a .= $or . "remoteip between ? and ?";
1301 $whereexpr5b .= $or . "localip between ? and ?";
1303 $qparams[] = $db_first;
1304 $qparams[] = $db_last;
1310 $whereexpr5a .= ')';
1311 $whereexpr5b .= ')';
1313 // 1. collect labels and reservations
1314 $query = "select INET_NTOA(ip) as ip, name, reserved from IPv4Address ".
1315 "where ${whereexpr1} and (reserved = 'yes' or name != '')";
1316 $result = usePreparedSelectBlade ($query, $qparams);
1317 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
1319 $ip_bin = ip2long ($row['ip']);
1320 if (!isset ($ret[$ip_bin]))
1321 $ret[$ip_bin] = constructIPv4Address ($row['ip']);
1322 $ret[$ip_bin]['name'] = $row['name'];
1323 $ret[$ip_bin]['reserved'] = $row['reserved'];
1327 // 2. check for allocations
1329 "select INET_NTOA(ip) as ip, object_id, name, type " .
1330 "from IPv4Allocation where ${whereexpr2} order by type";
1331 $result = usePreparedSelectBlade ($query, $qparams);
1332 // release DBX early to avoid issues with nested spotEntity() calls
1333 $allRows = $result->fetchAll (PDO
::FETCH_ASSOC
);
1335 foreach ($allRows as $row)
1337 $ip_bin = ip2long ($row['ip']);
1338 if (!isset ($ret[$ip_bin]))
1339 $ret[$ip_bin] = constructIPv4Address ($row['ip']);
1340 $oinfo = spotEntity ('object', $row['object_id']);
1341 $ret[$ip_bin]['allocs'][] = array
1343 'type' => $row['type'],
1344 'name' => $row['name'],
1345 'object_id' => $row['object_id'],
1346 'object_name' => $oinfo['dname'],
1350 // 3. look for virtual services and related LB
1351 $query = "select vs_id, inet_ntoa(vip) as ip, vport, proto, vs.name, object_id " .
1352 "from IPv4VS as vs inner join IPv4LB as lb on vs.id = lb.vs_id " .
1353 "where ${whereexpr3} order by vport, proto, object_id";
1354 $result = usePreparedSelectBlade ($query, $qparams);
1355 $allRows = $result->fetchAll (PDO
::FETCH_ASSOC
);
1357 foreach ($allRows as $row)
1359 $ip_bin = ip2long ($row['ip']);
1360 if (!isset ($ret[$ip_bin]))
1361 $ret[$ip_bin] = constructIPv4Address ($row['ip']);
1362 $oinfo = spotEntity ('object', $row['object_id']);
1363 $ret[$ip_bin]['lblist'][] = array
1365 'vport' => $row['vport'],
1366 'proto' => $row['proto'],
1367 'vs_id' => $row['vs_id'],
1368 'name' => $row['name'],
1369 'vip' => $row['ip'],
1370 'object_id' => $row['object_id'],
1371 'object_name' => $oinfo['dname'],
1375 // 4. don't forget about real servers along with pools
1376 $query = "select inet_ntoa(rsip) as ip, inservice, rsport, rspool_id, rsp.name as rspool_name from " .
1377 "IPv4RS as rs inner join IPv4RSPool as rsp on rs.rspool_id = rsp.id " .
1378 "where ${whereexpr4} " .
1379 "order by ip, rsport, rspool_id";
1380 $result = usePreparedSelectBlade ($query, $qparams);
1381 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
1383 $ip_bin = ip2long ($row['ip']);
1384 if (!isset ($ret[$ip_bin]))
1385 $ret[$ip_bin] = constructIPv4Address ($row['ip']);
1387 foreach (array ('rspool_id', 'rsport', 'rspool_name', 'inservice') as $cname)
1388 $tmp[$cname] = $row[$cname];
1389 $ret[$ip_bin]['rslist'][] = $tmp;
1393 // 5. add NAT rules, part 1
1397 "INET_NTOA(localip) as localip, " .
1399 "INET_NTOA(remoteip) as remoteip, " .
1403 "where ${whereexpr5a} " .
1404 "order by localip, localport, remoteip, remoteport, proto";
1405 $result = usePreparedSelectBlade ($query, $qparams);
1406 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
1408 $remoteip_bin = ip2long ($row['remoteip']);
1409 if (!isset ($ret[$remoteip_bin]))
1410 $ret[$remoteip_bin] = constructIPv4Address ($row['remoteip']);
1411 $ret[$remoteip_bin]['inpf'][] = $row;
1414 // 5. add NAT rules, part 2
1418 "INET_NTOA(localip) as localip, " .
1420 "INET_NTOA(remoteip) as remoteip, " .
1424 "where ${whereexpr5b} " .
1425 "order by localip, localport, remoteip, remoteport, proto";
1426 $result = usePreparedSelectBlade ($query, $qparams);
1427 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
1429 $localip_bin = ip2long ($row['localip']);
1430 if (!isset ($ret[$localip_bin]))
1431 $ret[$localip_bin] = constructIPv4Address ($row['localip']);
1432 $ret[$localip_bin]['outpf'][] = $row;
1438 // Check the range requested for meaningful IPv6 records, build them
1439 // into a list and return. Return an empty list if nothing matched.
1440 // Both arguments are expected as instances of IPv6Address class. The resulting list
1441 // is keyed by uint32 form of each IP address, items aren't sorted.
1442 function scanIPv6Space ($pairlist)
1446 foreach ($pairlist as $pair)
1448 $wheres[] = "ip >= ? AND ip <= ?";
1449 $qparams[] = (string) $pair['first'];
1450 $qparams[] = (string) $pair['last'];
1452 if (! count ($wheres)) // this is normal for a network completely divided into smaller parts
1454 $whereexpr = '(' .implode (' OR ', $wheres) . ')';
1456 // 1. collect labels and reservations
1457 $query = "select ip, name, reserved from IPv6Address ".
1458 "where ${whereexpr} and (reserved = 'yes' or name != '')";
1459 $result = usePreparedSelectBlade ($query, $qparams);
1460 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
1462 $ip_bin = new IPv6Address ($row['ip']);
1463 $key = (string)$ip_bin;
1464 if (!isset ($ret[$key]))
1465 $ret[$key] = constructIPv6Address ($ip_bin);
1466 $ret[$key]['name'] = $row['name'];
1467 $ret[$key]['reserved'] = $row['reserved'];
1471 // 2. check for allocations
1473 "select ip, object_id, name, type " .
1474 "from IPv6Allocation where ${whereexpr} order by type";
1475 $result = usePreparedSelectBlade ($query, $qparams);
1476 // release DBX early to avoid issues with nested spotEntity() calls
1477 $allRows = $result->fetchAll (PDO
::FETCH_ASSOC
);
1479 foreach ($allRows as $row)
1481 $ip_bin = new IPv6Address ($row['ip']);
1482 $key = (string)$ip_bin;
1483 if (!isset ($ret[$key]))
1484 $ret[$key] = constructIPv6Address ($ip_bin);
1485 $oinfo = spotEntity ('object', $row['object_id']);
1486 $ret[$key]['allocs'][] = array
1488 'type' => $row['type'],
1489 'name' => $row['name'],
1490 'object_id' => $row['object_id'],
1491 'object_name' => $oinfo['dname'],
1497 // this is a wrapper around getIPv4Address and getIPv6Address
1498 // You can pass dotted IPv4, human representation of IPv6, or instance of IPv6Address
1499 function getIPAddress ($ip)
1501 if (is_a ($ip, 'IPv6Address'))
1502 return getIPv6Address ($ip);
1503 $ipv6 = new IPv6Address
;
1504 if ($ipv6->parse ($ip))
1505 return getIPv6Address ($ipv6);
1506 return getIPv4Address ($ip);
1509 function getIPv4Address ($dottedquad = '')
1511 if ($dottedquad == '')
1512 throw new InvalidArgException ('$dottedquad', $dottedquad);
1513 $i32 = ip2long ($dottedquad); // signed 32 bit
1514 $scanres = scanIPv4Space (array (array ('i32_first' => $i32, 'i32_last' => $i32)));
1515 if (empty ($scanres))
1516 //$scanres[$i32] = constructIPv4Address ($dottedquad); // XXX: this should be verified to not break things
1517 return constructIPv4Address ($dottedquad);
1518 markupIPAddrList ($scanres);
1519 return $scanres[$i32];
1522 // returns the array of structure described by constructIPv6Address
1523 function getIPv6Address ($v6addr)
1525 if (! is_object ($v6addr))
1526 throw new InvalidArgException ('$v6addr', $v6addr);
1527 $scanres = scanIPv6Space (array (array ('first' => $v6addr, 'last' => $v6addr)));
1528 if (empty ($scanres))
1529 return constructIPv6Address ($v6addr);
1530 markupIPAddrList ($scanres);
1531 return array_shift ($scanres);
1534 function bindIpToObject ($ip = '', $object_id = 0, $name = '', $type = '')
1536 return usePreparedExecuteBlade
1538 'INSERT INTO IPv4Allocation (ip, object_id, name, type) VALUES (INET_ATON(?), ?, ?, ?)',
1539 array ($ip, $object_id, $name, $type)
1543 function bindIPv6ToObject ($ip = '', $object_id = 0, $name = '', $type = '')
1545 return usePreparedInsertBlade
1548 array ('ip' => $ip, 'object_id' => $object_id, 'name' => $name, 'type' => $type)
1552 // Return the id of the smallest IPv4 network containing the given IPv4 address
1553 // or NULL, if nothing was found. When finding the covering network for
1554 // another network, it is important to filter out matched records with longer
1555 // masks (they aren't going to be the right pick).
1556 function getIPv4AddressNetworkId ($dottedquad, $masklen = 32)
1558 $query = 'select id from IPv4Network where ' .
1559 "inet_aton(?) & (4294967295 >> (32 - mask)) << (32 - mask) = ip " .
1561 'order by mask desc limit 1';
1562 $result = usePreparedSelectBlade ($query, array ($dottedquad, $masklen));
1563 if ($row = $result->fetch (PDO
::FETCH_ASSOC
))
1568 // Return the id of the smallest IPv6 network containing the given IPv6 address
1569 // ($ip is an instance of IPv4Address class) or NULL, if nothing was found.
1570 function getIPv6AddressNetworkId ($ip, $masklen = 128)
1572 $query = 'select id from IPv6Network where ip <= ? AND last_ip >= ? and mask < ? order by mask desc limit 1';
1573 $result = usePreparedSelectBlade ($query, array ((string)$ip, (string)$ip, $masklen));
1574 if ($row = $result->fetch (PDO
::FETCH_ASSOC
))
1579 // It is a wrapper around updateV4Address and updateV6Address.
1580 // You can pass dotted IPv4, human representation of IPv6, or instance of IPv6Address
1581 function updateAddress ($ip = 0, $name = '', $reserved = 'no')
1583 if (is_a ($ip, 'IPv6Address'))
1584 return updateV6Address ($ip, $name, $reserved);
1585 $ipv6 = new IPv6Address
;
1586 if ($ipv6->parse ($ip))
1587 return updateV6Address ($ipv6, $name, $reserved);
1588 return updateV4Address ($ip, $name, $reserved);
1591 // This function is actually used not only to update, but also to create records,
1592 // that's why ON DUPLICATE KEY UPDATE was replaced by DELETE-INSERT pair
1593 // (MySQL 4.0 workaround).
1594 function updateV4Address ($ip = 0, $name = '', $reserved = 'no')
1596 usePreparedExecuteBlade ('DELETE FROM IPv4Address WHERE ip = INET_ATON(?)', array ($ip));
1597 // INSERT may appear not necessary.
1598 if ($name == '' and $reserved == 'no')
1600 $ret = usePreparedExecuteBlade
1602 'INSERT INTO IPv4Address (name, reserved, ip) VALUES (?, ?, INET_ATON(?))',
1603 array ($name, $reserved, $ip)
1605 return $ret !== FALSE ?
'' : (__FUNCTION__
. 'query failed');
1608 function updateV6Address ($ip, $name = '', $reserved = 'no')
1610 usePreparedDeleteBlade ('IPv6Address', array ('ip' => $ip));
1611 // INSERT may appear not necessary.
1612 if ($name == '' and $reserved == 'no')
1614 $ret = usePreparedInsertBlade
1617 array ('name' => $name, 'reserved' => $reserved, 'ip' => $ip)
1619 return $ret !== FALSE ?
'' : (__FUNCTION__
. 'query failed');
1622 function updateBond ($ip='', $object_id=0, $name='', $type='')
1624 return usePreparedExecuteBlade
1626 'UPDATE IPv4Allocation SET name=?, type=? WHERE ip=INET_ATON(?) AND object_id=?',
1627 array ($name, $type, $ip, $object_id)
1631 function updateIPv6Bond ($ip='', $object_id=0, $name='', $type='')
1633 return usePreparedUpdateBlade
1644 'object_id' => $object_id,
1649 function unbindIpFromObject ($ip, $object_id)
1651 return usePreparedExecuteBlade
1653 'DELETE FROM IPv4Allocation WHERE ip=INET_ATON(?) AND object_id=?',
1654 array ($ip, $object_id)
1658 function unbindIPv6FromObject ($ip, $object_id)
1660 return usePreparedDeleteBlade
1663 array ('ip' => $ip, 'object_id' => $object_id)
1667 function getIPv4PrefixSearchResult ($terms)
1669 $byname = getSearchResultByField
1678 foreach ($byname as $row)
1679 $ret[$row['id']] = spotEntity ('ipv4net', $row['id']);
1683 function getIPv6PrefixSearchResult ($terms)
1685 $byname = getSearchResultByField
1694 foreach ($byname as $row)
1695 $ret[$row['id']] = spotEntity ('ipv6net', $row['id']);
1699 function getIPv4AddressSearchResult ($terms)
1701 $query = "select inet_ntoa(ip) as ip, name from IPv4Address where ";
1704 foreach (explode (' ', $terms) as $term)
1706 $query .= $or . "name like ?";
1708 $qparams[] = "%${term}%";
1710 $result = usePreparedSelectBlade ($query, $qparams);
1712 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
1713 $ret[$row['ip']] = $row;
1717 function getIPv6AddressSearchResult ($terms)
1719 $query = "select ip, name from IPv6Address where ";
1722 foreach (explode (' ', $terms) as $term)
1724 $query .= $or . "name like ?";
1726 $qparams[] = "%${term}%";
1728 $result = usePreparedSelectBlade ($query, $qparams);
1730 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
1731 $ret[$row['ip']] = $row;
1735 function getIPv4RSPoolSearchResult ($terms)
1737 $byname = getSearchResultByField
1746 foreach ($byname as $row)
1747 $ret[$row['id']] = spotEntity ('ipv4rspool', $row['id']);
1751 function getIPv4VServiceSearchResult ($terms)
1753 $byname = getSearchResultByField
1762 foreach ($byname as $row)
1763 $ret[$row['id']] = spotEntity ('ipv4vs', $row['id']);
1767 function getAccountSearchResult ($terms)
1769 $byUsername = getSearchResultByField
1772 array ('user_id', 'user_name', 'user_realname'),
1777 $byRealname = getSearchResultByField
1780 array ('user_id', 'user_name', 'user_realname'),
1785 // Merge it together, if duplicates persist, byUsername wins
1786 foreach (array ($byRealname, $byUsername) as $array)
1787 foreach ($array as $user)
1789 $user['realm'] = 'user';
1790 $ret[$user['user_id']] = $user;
1795 function getFileSearchResult ($terms)
1797 $byName = getSearchResultByField
1805 $byComment = getSearchResultByField
1813 // Filter out dupes.
1814 foreach ($byName as $res1)
1815 foreach (array_keys ($byComment) as $key2)
1816 if ($res1['id'] == $byComment[$key2]['id'])
1818 unset ($byComment[$key2]);
1822 foreach (array_merge ($byName, $byComment) as $row)
1823 $ret[$row['id']] = spotEntity ('file', $row['id']);
1827 function getRackSearchResult ($terms)
1829 $byName = getSearchResultByField
1837 $byComment = getSearchResultByField
1845 // Filter out dupes.
1846 foreach ($byName as $res1)
1847 foreach (array_keys ($byComment) as $key2)
1848 if ($res1['id'] == $byComment[$key2]['id'])
1850 unset ($byComment[$key2]);
1854 foreach (array_merge ($byName, $byComment) as $row)
1855 $ret[$row['id']] = spotEntity ('rack', $row['id']);
1859 function getVLANSearchResult ($terms)
1863 if (preg_match ('/^vlan\s*(\d+)$/i', $terms, $matches))
1865 $byID = getSearchResultByField
1868 array ('domain_id', 'vlan_id'),
1874 foreach ($byID as $row)
1876 $vlan_ck = $row['domain_id'] . '-' . $row['vlan_id'];
1877 $ret[$vlan_ck] = $vlan_ck;
1882 $byDescr = getSearchResultByField
1885 array ('domain_id', 'vlan_id'),
1889 foreach ($byDescr as $row)
1891 $vlan_ck = $row['domain_id'] . '-' . $row['vlan_id'];
1892 $ret[$vlan_ck] = $vlan_ck;
1898 function getSearchResultByField ($tname, $rcolumns, $scolumn, $terms, $ocolumn = '', $exactness = 0)
1903 foreach ($rcolumns as $col)
1905 $query .= $pfx . $col;
1909 $query .= " from ${tname} where ";
1910 foreach (explode (' ', $terms) as $term)
1914 case 2: // does this work as expected?
1915 $query .= $pfx . "binary ${scolumn} = ?";
1919 $query .= $pfx . "${scolumn} = ?";
1923 $query .= $pfx . "${scolumn} like ?";
1924 $qparams[] = "%${term}%";
1930 $query .= " order by ${ocolumn}";
1931 $result = usePreparedSelectBlade ($query, $qparams);
1933 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
1938 function getObjectSearchResults ($what)
1942 foreach ($searchfunc['object'] as $method => $func)
1943 foreach ($func ($what) as $objRecord)
1945 $ret[$objRecord['id']]['id'] = $objRecord['id'];
1946 $ret[$objRecord['id']][$method] = $objRecord[$method];
1951 function getObjectAttrsSearchResults ($what)
1954 foreach (array ('name', 'label', 'asset_no', 'barcode') as $column)
1956 $tmp = getSearchResultByField
1964 foreach ($tmp as $row)
1966 $ret[$row['id']]['id'] = $row['id'];
1967 $ret[$row['id']]['by_attr'][] = $column;
1973 // Look for EXACT value in stickers and return a list of pairs "object_id-attribute_id",
1974 // which matched. A partilar object_id could be returned more, than once, if it has
1975 // multiple matching stickers. Search is only performed on "string" attributes.
1976 function getStickerSearchResults ($what, $exactness = 0)
1978 $stickers = getSearchResultByField
1981 array ('object_id', 'attr_id'),
1987 $map = getAttrMap();
1989 foreach ($stickers as $sticker)
1990 if ($map[$sticker['attr_id']]['type'] == 'string')
1992 $ret[$sticker['object_id']]['id'] = $sticker['object_id'];
1993 $ret[$sticker['object_id']]['by_sticker'][] = $sticker['attr_id'];
1998 // search in port "reservation comment", "label" and "L2 address" columns
1999 function getPortSearchResults ($what)
2002 $ports = getSearchResultByField
2005 array ('object_id', 'id', 'reservation_comment'),
2006 'reservation_comment',
2011 foreach ($ports as $port)
2013 $ret[$port['object_id']]['id'] = $port['object_id'];
2014 $ret[$port['object_id']]['by_port'][$port['id']] = $port['reservation_comment'];
2016 $ports = getSearchResultByField
2019 array ('object_id', 'id', 'label'),
2025 foreach ($ports as $port)
2027 $ret[$port['object_id']]['id'] = $port['object_id'];
2028 $ret[$port['object_id']]['by_port'][$port['id']] = $port['label'];
2032 $db_l2address = l2addressForDatabase ($what);
2034 catch (InvalidArgException
$e)
2038 $ports = getSearchResultByField
2041 array ('object_id', 'id', 'l2address'),
2047 foreach ($ports as $port)
2049 $ret[$port['object_id']]['id'] = $port['object_id'];
2050 $ret[$port['object_id']]['by_port'][$port['id']] = $port['l2address'];
2055 // search in IPv4 allocations
2056 function getObjectIfacesSearchResults ($what)
2059 $ifaces4 = getSearchResultByField
2062 array ('object_id', 'name'),
2067 $ifaces6 = getSearchResultByField
2070 array ('object_id', 'name'),
2075 foreach (array_merge ($ifaces4, $ifaces6) as $row)
2077 $ret[$row['object_id']]['id'] = $row['object_id'];
2078 $ret[$row['object_id']]['by_iface'][] = $row['name'];
2083 function getObjectNATSearchResults ($what)
2086 $ifaces = getSearchResultByField
2089 array ('object_id', 'description'),
2094 foreach ($ifaces as $row)
2096 $ret[$row['object_id']]['id'] = $row['object_id'];
2097 $ret[$row['object_id']]['by_nat'][] = $row['description'];
2102 // This function returns either port ID or NULL for specified arguments.
2103 function getPortIDs ($object_id, $port_name)
2106 $result = usePreparedSelectBlade ('SELECT id FROM Port WHERE object_id = ? AND name = ?', array ($object_id, $port_name));
2107 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
2108 $ret[] = $row['id'];
2112 // Search in "FQDN" attribute only, and return object ID, when there is exactly
2113 // one result found (and NULL in any other case).
2114 function searchByMgmtHostname ($string)
2116 $result = usePreparedSelectBlade ('SELECT object_id FROM AttributeValue WHERE attr_id = 3 AND string_value = ? LIMIT 2', array ($string));
2117 $rows = $result->fetchAll (PDO
::FETCH_NUM
);
2118 if (count ($rows) != 1)
2123 function commitCreateUserAccount ($username, $realname, $password)
2125 return usePreparedInsertBlade
2130 'user_name' => $username,
2131 'user_realname' => $realname,
2132 'user_password_hash' => $password,
2137 function commitUpdateUserAccount ($id, $new_username, $new_realname, $new_password)
2139 return usePreparedUpdateBlade
2144 'user_name' => $new_username,
2145 'user_realname' => $new_realname,
2146 'user_password_hash' => $new_password,
2148 array ('user_id' => $id)
2152 // This function returns an array of all port type pairs from PortCompat table.
2153 function getPortOIFCompat ()
2156 "select type1, type2, d1.dict_value as type1name, d2.dict_value as type2name from " .
2157 "PortCompat as pc inner join Dictionary as d1 on pc.type1 = d1.dict_key " .
2158 "inner join Dictionary as d2 on pc.type2 = d2.dict_key " .
2159 'ORDER BY type1name, type2name';
2160 $result = usePreparedSelectBlade ($query);
2161 return $result->fetchAll (PDO
::FETCH_ASSOC
);
2164 // Returns an array of all object type pairs from the ObjectParentCompat table.
2165 function getObjectParentCompat ()
2168 'SELECT parent_objtype_id, child_objtype_id, d1.dict_value AS parent_name, d2.dict_value AS child_name FROM ' .
2169 'ObjectParentCompat AS pc INNER JOIN Dictionary AS d1 ON pc.parent_objtype_id = d1.dict_key ' .
2170 'INNER JOIN Dictionary AS d2 ON pc.child_objtype_id = d2.dict_key ' .
2171 'ORDER BY parent_name, child_name';
2172 $result = usePreparedSelectBlade ($query);
2173 return $result->fetchAll (PDO
::FETCH_ASSOC
);
2176 // Used to determine if a type of object may have a parent or not
2177 function rackObjectTypeMayHaveParent ($objtype_id)
2179 $result = usePreparedSelectBlade ('SELECT COUNT(*) FROM ObjectParentCompat WHERE child_objtype_id = ?', array ($objtype_id));
2180 $row = $result->fetch (PDO
::FETCH_NUM
);
2186 // Add a pair to the ObjectParentCompat table.
2187 function commitSupplementOPC ($parent_objtype_id, $child_objtype_id)
2189 if ($parent_objtype_id <= 0)
2190 throw new InvalidArgException ('parent_objtype_id', $parent_objtype_id);
2191 if ($child_objtype_id <= 0)
2192 throw new InvalidArgException ('child_objtype_id', $child_objtype_id);
2193 return usePreparedInsertBlade
2195 'ObjectParentCompat',
2196 array ('parent_objtype_id' => $parent_objtype_id, 'child_objtype_id' => $child_objtype_id)
2200 // Remove a pair from the ObjectParentCompat table.
2201 function commitReduceOPC ($parent_objtype_id, $child_objtype_id)
2203 return usePreparedDeleteBlade ('ObjectParentCompat', array ('parent_objtype_id' => $parent_objtype_id, 'child_objtype_id' => $child_objtype_id));
2206 function getDictStats ()
2208 $stock_chapters = array (1, 2, 11, 12, 13, 14, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28);
2209 $result = usePreparedSelectBlade
2211 "select Chapter.id as chapter_no, Chapter.name as chapter_name, count(dict_key) as wc from " .
2212 "Chapter left join Dictionary on Chapter.id = Dictionary.chapter_id group by Chapter.id"
2214 $tc = $tw = $uc = $uw = 0;
2215 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
2219 if (in_array ($row['chapter_no'], $stock_chapters))
2225 $result = usePreparedSelectBlade
2227 "select count(object_id) as attrc from RackObject as ro left join " .
2228 "AttributeValue as av on ro.id = av.object_id group by ro.id"
2230 $to = $ta = $so = 0;
2231 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
2234 if ($row['attrc'] != 0)
2237 $ta +
= $row['attrc'];
2242 $ret['Total chapters in dictionary'] = $tc;
2243 $ret['Total words in dictionary'] = $tw;
2244 $ret['User chapters'] = $uc;
2245 $ret['Words in user chapters'] = $uw;
2246 $ret['Total objects'] = $to;
2247 $ret['Objects with stickers'] = $so;
2248 $ret['Total stickers attached'] = $ta;
2252 function getIPv4Stats ()
2256 $subject[] = array ('q' => 'select count(id) from IPv4Network', 'txt' => 'Networks');
2257 $subject[] = array ('q' => 'select count(ip) from IPv4Address', 'txt' => 'Addresses commented/reserved');
2258 $subject[] = array ('q' => 'select count(ip) from IPv4Allocation', 'txt' => 'Addresses allocated');
2259 $subject[] = array ('q' => 'select count(*) from IPv4NAT', 'txt' => 'NAT rules');
2260 $subject[] = array ('q' => 'select count(id) from IPv4VS', 'txt' => 'Virtual services');
2261 $subject[] = array ('q' => 'select count(id) from IPv4RSPool', 'txt' => 'Real server pools');
2262 $subject[] = array ('q' => 'select count(id) from IPv4RS', 'txt' => 'Real servers');
2263 $subject[] = array ('q' => 'select count(distinct object_id) from IPv4LB', 'txt' => 'Load balancers');
2265 foreach ($subject as $item)
2267 $result = usePreparedSelectBlade ($item['q']);
2268 $row = $result->fetch (PDO
::FETCH_NUM
);
2269 $ret[$item['txt']] = $row[0];
2275 function getIPv6Stats ()
2279 $subject[] = array ('q' => 'select count(id) from IPv6Network', 'txt' => 'Networks');
2280 $subject[] = array ('q' => 'select count(ip) from IPv6Address', 'txt' => 'Addresses commented/reserved');
2281 $subject[] = array ('q' => 'select count(ip) from IPv6Allocation', 'txt' => 'Addresses allocated');
2283 foreach ($subject as $item)
2285 $result = usePreparedSelectBlade ($item['q']);
2286 $row = $result->fetch (PDO
::FETCH_NUM
);
2287 $ret[$item['txt']] = $row[0];
2293 function getRackspaceStats ()
2297 $subject[] = array ('q' => 'select count(*) from RackRow', 'txt' => 'Rack rows');
2298 $subject[] = array ('q' => 'select count(*) from Rack', 'txt' => 'Racks');
2299 $subject[] = array ('q' => 'select avg(height) from Rack', 'txt' => 'Average rack height');
2300 $subject[] = array ('q' => 'select sum(height) from Rack', 'txt' => 'Total rack units in field');
2302 foreach ($subject as $item)
2304 $result = usePreparedSelectBlade ($item['q']);
2305 $row = $result->fetch (PDO
::FETCH_NUM
);
2306 $ret[$item['txt']] = !strlen ($row[0]) ?
0 : $row[0];
2314 The following allows figuring out records in TagStorage, which refer to non-existing entities:
2316 mysql> select entity_id from TagStorage left join Files on entity_id = id where entity_realm = 'file' and id is null;
2317 mysql> select entity_id from TagStorage left join IPv4Network on entity_id = id where entity_realm = 'ipv4net' and id is null;
2318 mysql> select entity_id from TagStorage left join RackObject on entity_id = id where entity_realm = 'object' and id is null;
2319 mysql> select entity_id from TagStorage left join Rack on entity_id = id where entity_realm = 'rack' and id is null;
2320 mysql> select entity_id from TagStorage left join IPv4VS on entity_id = id where entity_realm = 'ipv4vs' and id is null;
2321 mysql> select entity_id from TagStorage left join IPv4RSPool on entity_id = id where entity_realm = 'ipv4rspool' and id is null;
2322 mysql> select entity_id from TagStorage left join UserAccount on entity_id = user_id where entity_realm = 'user' and user_id is null;
2324 Accordingly, these are the records, which refer to non-existent tags:
2326 mysql> select tag_id from TagStorage left join TagTree on tag_id = id where id is null;
2330 function commitDeleteChapter ($chapter_no = 0)
2332 return usePreparedDeleteBlade ('Chapter', array ('id' => $chapter_no, 'sticky' => 'no'));
2335 // This is a dictionary accessor. We perform link rendering, so the user sees
2336 // nice <select> drop-downs.
2337 function readChapter ($chapter_id = 0, $style = '')
2339 $result = usePreparedSelectBlade
2341 "select dict_key, dict_value from Dictionary " .
2342 "where chapter_id = ?",
2346 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
2347 $chapter[$row['dict_key']] = $style == '' ?
$row['dict_value'] : parseWikiLink ($row['dict_value'], $style);
2348 // SQL ORDER BY had no sense, because we need to sort after link rendering, not before.
2353 // Return refcounters for all given keys of the given chapter.
2354 function getChapterRefc ($chapter_id, $keylist)
2357 foreach ($keylist as $key)
2359 switch ($chapter_id)
2362 // RackObjectType chapter is referenced by AttributeMap and RackObject tables
2363 $query = 'select dict_key as uint_value, (select count(*) from AttributeMap where objtype_id = dict_key) + ' .
2364 "(select count(*) from RackObject where objtype_id = dict_key) as refcnt from Dictionary where chapter_id = ?";
2367 // PortOuterInterface chapter is referenced by PortCompat, PortInterfaceCompat and Port tables
2368 $query = 'select dict_key as uint_value, (select count(*) from PortCompat where type1 = dict_key or type2 = dict_key) + ' .
2369 '(select count(*) from Port where type = dict_key) + (SELECT COUNT(*) FROM PortInterfaceCompat WHERE oif_id = dict_key) as refcnt ' .
2370 "from Dictionary where chapter_id = ?";
2373 // Find the list of all assigned values of dictionary-addressed attributes, each with
2374 // chapter/word keyed reference counters.
2375 $query = "select uint_value, count(object_id) as refcnt
2376 from AttributeMap am
2377 inner join AttributeValue av on am.attr_id = av.attr_id
2378 inner join RackObject ro on ro.id = av.object_id
2379 where am.chapter_id = ? and ro.objtype_id = am.objtype_id
2380 group by uint_value";
2383 $result = usePreparedSelectBlade ($query, array ($chapter_id));
2384 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
2385 $ret[$row['uint_value']] = $row['refcnt'];
2389 // Return a list of all stickers with sticker map applied. Each sticker records will
2390 // list all its ways on the map with refcnt set.
2391 function getAttrMap ()
2393 $result = usePreparedSelectBlade
2395 'SELECT id, type, name, chapter_id, (SELECT dict_value FROM Dictionary WHERE dict_key = objtype_id) '.
2396 'AS objtype_name, (SELECT name FROM Chapter WHERE id = chapter_id) ' .
2397 'AS chapter_name, objtype_id, (SELECT COUNT(object_id) FROM AttributeValue AS av INNER JOIN RackObject AS ro ' .
2398 'ON av.object_id = ro.id WHERE av.attr_id = Attribute.id AND ro.objtype_id = AttributeMap.objtype_id) ' .
2399 'AS refcnt FROM Attribute LEFT JOIN AttributeMap ON id = attr_id ORDER BY Attribute.name, objtype_name'
2402 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
2404 if (!isset ($ret[$row['id']]))
2405 $ret[$row['id']] = array
2408 'type' => $row['type'],
2409 'name' => $row['name'],
2410 'application' => array(),
2412 if ($row['objtype_id'] == '')
2414 $application = array
2416 'objtype_id' => $row['objtype_id'],
2417 'refcnt' => $row['refcnt'],
2419 if ($row['type'] == 'dict')
2421 $application['chapter_no'] = $row['chapter_id'];
2422 $application['chapter_name'] = $row['chapter_name'];
2424 $ret[$row['id']]['application'][] = $application;
2429 // FIXME: don't store garbage in chapter_no for non-dictionary types.
2430 function commitSupplementAttrMap ($attr_id = 0, $objtype_id = 0, $chapter_no = 0)
2433 throw new InvalidArgException ('$attr_id', $attr_id);
2434 if ($objtype_id <= 0)
2435 throw new InvalidArgException ('$objtype_id', $objtype_id);
2437 return usePreparedInsertBlade
2442 'attr_id' => $attr_id,
2443 'objtype_id' => $objtype_id,
2444 'chapter_id' => $chapter_no
2449 function cacheAllObjectsAttributes()
2451 global $object_attribute_cache;
2452 $object_attribute_cache = fetchAttrsForObjects(NULL);
2455 // Fetches a list of attributes for each object in $object_set array.
2456 // If $object_set is not set, returns attributes for all objects in DB
2457 // Returns an array with object_id keys
2458 function fetchAttrsForObjects($object_set)
2462 "select A.id as attr_id, A.name as attr_name, A.type as attr_type, C.name as chapter_name, " .
2463 "C.id as chapter_id, AV.uint_value, AV.float_value, AV.string_value, D.dict_value, RO.id as object_id from " .
2464 "RackObject as RO inner join AttributeMap as AM on RO.objtype_id = AM.objtype_id " .
2465 "inner join Attribute as A on AM.attr_id = A.id " .
2466 "left join AttributeValue as AV on AV.attr_id = AM.attr_id and AV.object_id = RO.id " .
2467 "left join Dictionary as D on D.dict_key = AV.uint_value and AM.chapter_id = D.chapter_id " .
2468 "left join Chapter as C on AM.chapter_id = C.id";
2469 if (is_array ($object_set) && !empty ($object_set))
2471 $query .= ' WHERE RO.id IN (';
2472 foreach ($object_set as $object_id)
2473 $query .= intval ($object_id) . ', ';
2474 $query = trim ($query, ', ') . ')';
2476 $query .= " order by A.name, A.type";
2478 $result = usePreparedSelectBlade ($query);
2479 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
2481 $object_id = $row['object_id'];
2482 $attr_id = $row['attr_id'];
2483 if (!array_key_exists ($object_id, $ret))
2484 $ret[$object_id] = array();
2487 $record['id'] = $row['attr_id'];
2488 $record['name'] = $row['attr_name'];
2489 $record['type'] = $row['attr_type'];
2490 switch ($row['attr_type'])
2493 $record['chapter_id'] = $row['chapter_id'];
2494 $record['chapter_name'] = $row['chapter_name'];
2495 $record['key'] = $row['uint_value'];
2500 $record['value'] = $row[$row['attr_type'] . '_value'];
2501 $record['o_value'] = parseWikiLink ($record['value'], 'o');
2502 $record['a_value'] = parseWikiLink ($record['value'], 'a');
2505 $record['value'] = NULL;
2508 $ret[$object_id][$attr_id] = $record;
2513 // This function returns all optional attributes for requested object
2514 // as an array of records.
2515 // Empty array is returned, if there are no attributes found.
2516 function getAttrValues ($object_id)
2518 global $object_attribute_cache;
2519 if (isset ($object_attribute_cache[$object_id]))
2520 return $object_attribute_cache[$object_id];
2522 $ret = fetchAttrsForObjects(array($object_id));
2524 if (isset ($ret[$object_id]))
2526 $attrs = $ret[$object_id];
2527 $object_attribute_cache[$object_id] = $attrs;
2532 function commitResetAttrValue ($object_id = 0, $attr_id = 0)
2534 return usePreparedDeleteBlade ('AttributeValue', array ('object_id' => $object_id, 'attr_id' => $attr_id));
2537 function commitUpdateAttrValue ($object_id = 0, $attr_id = 0, $value = '')
2539 if ($object_id <= 0)
2540 throw new InvalidArgException ('$objtype_id', $objtype_id);
2542 throw new InvalidArgException ('$attr_id', $attr_id);
2543 if (!strlen ($value))
2544 return commitResetAttrValue ($object_id, $attr_id);
2545 $result = usePreparedSelectBlade ('select type as attr_type from Attribute where id = ?', array ($attr_id));
2546 $row = $result->fetch (PDO
::FETCH_NUM
);
2547 $attr_type = $row[0];
2554 $column = $attr_type . '_value';
2557 $column = 'uint_value';
2560 throw new InvalidArgException ('$attr_type', $attr_type, 'Unknown attribute type found in object #'.$object_id.', attribute #'.$attr_id);
2562 usePreparedDeleteBlade ('AttributeValue', array ('object_id' => $object_id, 'attr_id' => $attr_id));
2563 // We know $value isn't empty here.
2564 usePreparedInsertBlade
2570 'object_id' => $object_id,
2571 'attr_id' => $attr_id,
2577 function convertPDOException ($e)
2579 switch ($e->getCode() . '-' . $e->errorInfo
[1])
2582 $text = 'such record already exists';
2585 $text = 'such record already exists';
2589 $text = 'foreign key violation';
2592 $text = 'lock wait timeout';
2597 return new RTDatabaseError ($text);
2600 // This is a swiss-knife blade to insert a record into a table.
2601 // The first argument is table name.
2602 // The second argument is an array of "name" => "value" pairs.
2603 function usePreparedInsertBlade ($tablename, $columns)
2606 $query = "INSERT INTO ${tablename} (" . implode (', ', array_keys ($columns));
2607 $query .= ') VALUES (' . questionMarks (count ($columns)) . ')';
2608 // Now the query should be as follows:
2609 // INSERT INTO table (c1, c2, c3) VALUES (?, ?, ?)
2612 $prepared = $dbxlink->prepare ($query);
2613 if (!$prepared->execute (array_values ($columns)))
2615 return $prepared->rowCount() == 1;
2617 catch (PDOException
$e)
2619 throw convertPDOException ($e);
2623 // This swiss-knife blade deletes any number of records from the specified table
2624 // using the specified key names and values.
2625 function usePreparedDeleteBlade ($tablename, $columns, $conjunction = 'AND')
2629 $query = "DELETE FROM ${tablename} WHERE ";
2630 foreach ($columns as $colname => $colvalue)
2632 $query .= " ${conj} ${colname}=?";
2633 $conj = $conjunction;
2637 $prepared = $dbxlink->prepare ($query);
2638 if (!$prepared->execute (array_values ($columns)))
2640 return $prepared->rowCount(); // FALSE !== 0
2642 catch (PDOException
$e)
2644 throw convertPDOException ($e);
2648 function usePreparedSelectBlade ($query, $args = array())
2651 $prepared = $dbxlink->prepare ($query);
2654 if (!$prepared->execute ($args))
2658 catch (PDOException
$e)
2660 throw convertPDOException ($e);
2664 function usePreparedUpdateBlade ($tablename, $set_columns, $where_columns, $conjunction = 'AND')
2668 $query = "UPDATE ${tablename} SET ";
2669 foreach (array_keys ($set_columns) as $colname)
2671 $query .= "${conj}${colname}=?";
2675 $query .= ' WHERE ';
2676 foreach (array_keys ($where_columns) as $colname)
2678 $query .= "${conj} ${colname}=?";
2679 $conj = $conjunction;
2683 $prepared = $dbxlink->prepare ($query);
2684 $prepared->execute (array_merge (array_values ($set_columns), array_values ($where_columns)));
2686 catch (PDOException
$e)
2688 throw convertPDOException ($e);
2692 // Prepare and execute the statement with parameters, then return number of
2693 // rows affected (or FALSE in case of an error).
2694 function usePreparedExecuteBlade ($query, $args = array())
2699 if (!$prepared = $dbxlink->prepare ($query))
2701 if (!$prepared->execute ($args))
2703 return $prepared->rowCount();
2705 catch (PDOException
$e)
2707 throw convertPDOException ($e);
2711 function loadConfigCache ()
2713 $result = usePreparedSelectBlade ('SELECT varname, varvalue, vartype, is_hidden, emptyok, description, is_userdefined FROM Config ORDER BY varname');
2715 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
2716 $cache[$row['varname']] = $row;
2720 function loadUserConfigCache ($username = NULL)
2722 if (!strlen ($username))
2723 throw new InvalidArgException ('$username', $username);
2724 $result = usePreparedSelectBlade ('SELECT varname, varvalue FROM UserConfig WHERE user = ?', array ($username));
2726 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
2727 $cache[$row['varname']] = $row;
2731 // Database version detector. Should behave corretly on any
2732 // working dataset a user might have.
2733 function getDatabaseVersion ()
2735 $result = usePreparedSelectBlade ('SELECT varvalue FROM Config WHERE varname = "DB_VERSION" and vartype = "string"');
2736 if ($result == NULL)
2738 // FIXME: this code is never executed, but an exception thrown instead
2740 $errorInfo = $dbxlink->errorInfo();
2741 if ($errorInfo[0] == '42S02') // ER_NO_SUCH_TABLE
2743 die (__FUNCTION__
. ': SQL query #1 failed with error ' . $errorInfo[2]);
2745 $rows = $result->fetchAll (PDO
::FETCH_NUM
);
2747 if (count ($rows) != 1 ||
!strlen ($rows[0][0]))
2748 die (__FUNCTION__
. ': Cannot guess database version. Config table is present, but DB_VERSION is missing or invalid. Giving up.');
2753 // Return an array of virtual services. For each of them list real server pools
2754 // with their load balancers and other stats.
2755 function getSLBSummary ()
2757 $result = usePreparedSelectBlade
2759 'select vs.id as vsid, inet_ntoa(vip) as vip, vport, proto, vs.name, object_id, ' .
2760 'lb.rspool_id, pool.name as pool_name, count(rs.id) as rscount ' .
2761 'from IPv4VS as vs inner join IPv4LB as lb on vs.id = lb.vs_id ' .
2762 'inner join IPv4RSPool as pool on lb.rspool_id = pool.id ' .
2763 'left join IPv4RS as rs on rs.rspool_id = lb.rspool_id ' .
2764 'group by vs.id, object_id order by vs.vip, object_id'
2767 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
2769 $vsid = $row['vsid'];
2770 $object_id = $row['object_id'];
2771 if (!isset ($ret[$vsid]))
2773 $ret[$vsid] = array();
2774 foreach (array ('vip', 'vport', 'proto', 'name') as $cname)
2775 $ret[$vsid][$cname] = $row[$cname];
2776 $ret[$vsid]['lblist'] = array();
2778 // There's only one assigned RS pool possible for each LB-VS combination.
2779 $ret[$vsid]['lblist'][$row['object_id']] = array
2781 'id' => $row['rspool_id'],
2782 'size' => $row['rscount'],
2783 'name' => $row['pool_name']
2789 function addRStoRSPool ($pool_id = 0, $rsip = '', $rsport = 0, $inservice = 'no', $rsconfig = '')
2791 return usePreparedExecuteBlade
2793 'INSERT INTO IPv4RS (rsip, rsport, rspool_id, inservice, rsconfig) VALUES (INET_ATON(?), ?, ?, ?, ?)',
2797 (!strlen ($rsport) or $rsport === 0) ?
NULL : $rsport,
2799 $inservice == 'yes' ?
'yes' : 'no',
2800 !strlen ($rsconfig) ?
NULL : $rsconfig
2805 function addLBtoRSPool ($pool_id = 0, $object_id = 0, $vs_id = 0, $vsconfig = '', $rsconfig = '', $prio = '')
2807 return usePreparedInsertBlade
2812 'object_id' => $object_id,
2813 'rspool_id' => $pool_id,
2815 'vsconfig' => (!strlen ($vsconfig) ?
NULL : $vsconfig),
2816 'rsconfig' => (!strlen ($rsconfig) ?
NULL : $rsconfig),
2817 'prio' => (!strlen ($prio) ?
NULL : $prio),
2822 function commitDeleteVS ($id = 0)
2824 releaseFiles ('ipv4vs', $id);
2825 return FALSE !== usePreparedDeleteBlade ('IPv4VS', array ('id' => $id)) && FALSE !== destroyTagsForEntity ('ipv4vs', $id);
2828 function commitUpdateRS ($rsid = 0, $rsip = '', $rsport = 0, $rsconfig = '')
2830 if (long2ip (ip2long ($rsip)) !== $rsip)
2831 throw new InvalidArgException ('$rsip', $rsip);
2832 return usePreparedExecuteBlade
2834 'UPDATE IPv4RS SET rsip=INET_ATON(?), rsport=?, rsconfig=? WHERE id=?',
2838 (!strlen ($rsport) or $rsport === 0) ?
NULL : $rsport,
2839 !strlen ($rsconfig) ?
NULL : $rsconfig,
2845 function commitUpdateVS ($vsid = 0, $vip = '', $vport = 0, $proto = '', $name = '', $vsconfig = '', $rsconfig = '')
2848 throw new InvalidArgException ('$vip', $vip);
2850 throw new InvalidArgException ('$vport', $vport);
2851 if (!strlen ($proto))
2852 throw new InvalidArgException ('$proto', $proto);
2853 return usePreparedExecuteBlade
2855 'UPDATE IPv4VS SET vip=INET_ATON(?), vport=?, proto=?, name=?, vsconfig=?, rsconfig=? WHERE id=?',
2861 !strlen ($name) ?
NULL : $name,
2862 !strlen ($vsconfig) ?
NULL : $vsconfig,
2863 !strlen ($rsconfig) ?
NULL : $rsconfig,
2869 function loadThumbCache ($rack_id = 0)
2872 $result = usePreparedSelectBlade ("SELECT thumb_data FROM Rack WHERE id = ? AND thumb_data IS NOT NULL", array ($rack_id));
2873 $row = $result->fetch (PDO
::FETCH_ASSOC
);
2875 $ret = base64_decode ($row['thumb_data']);
2879 // Return the list of attached RS pools for the given object. As long as we have
2880 // the LB-VS UNIQUE in IPv4LB table, it is Ok to key returned records
2881 // by vs_id, because there will be only one RS pool listed for each VS of the
2883 function getRSPoolsForObject ($object_id = 0)
2885 $result = usePreparedSelectBlade
2887 'select vs_id, inet_ntoa(vip) as vip, vport, proto, vs.name, pool.id as pool_id, ' .
2888 'pool.name as pool_name, count(rsip) as rscount, lb.vsconfig, lb.rsconfig, lb.prio from ' .
2889 'IPv4LB as lb inner join IPv4RSPool as pool on lb.rspool_id = pool.id ' .
2890 'inner join IPv4VS as vs on lb.vs_id = vs.id ' .
2891 'left join IPv4RS as rs on lb.rspool_id = rs.rspool_id ' .
2892 'where lb.object_id = ? ' .
2893 'group by lb.rspool_id, lb.vs_id order by vs.vip, vport, proto, pool.name',
2897 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
2898 foreach (array ('vip', 'vport', 'proto', 'name', 'pool_id', 'pool_name', 'rscount', 'vsconfig', 'rsconfig', 'prio') as $cname)
2899 $ret[$row['vs_id']][$cname] = $row[$cname];
2903 function commitCreateRSPool ($name = '', $vsconfig = '', $rsconfig = '', $taglist = array())
2905 usePreparedInsertBlade
2910 'name' => (!strlen ($name) ?
NULL : $name),
2911 'vsconfig' => (!strlen ($vsconfig) ?
NULL : $vsconfig),
2912 'rsconfig' => (!strlen ($rsconfig) ?
NULL : $rsconfig)
2915 produceTagsForLastRecord ('ipv4rspool', $taglist);
2918 function commitDeleteRSPool ($pool_id = 0)
2920 releaseFiles ('ipv4rspool', $pool_id);
2921 return usePreparedDeleteBlade ('IPv4RSPool', array ('id' => $pool_id)) && destroyTagsForEntity ('ipv4rspool', $pool_id);
2924 function getRSList ()
2926 $result = usePreparedSelectBlade
2928 "select id, inservice, inet_ntoa(rsip) as rsip, rsport, rspool_id, rsconfig " .
2929 "from IPv4RS order by rspool_id, IPv4RS.rsip, rsport"
2932 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
2933 foreach (array ('inservice', 'rsip', 'rsport', 'rspool_id', 'rsconfig') as $cname)
2934 $ret[$row['id']][$cname] = $row[$cname];
2938 // Return the list of all currently configured load balancers with their pool count.
2939 function getLBList ()
2941 $result = usePreparedSelectBlade
2943 "select object_id, count(rspool_id) as poolcount " .
2944 "from IPv4LB group by object_id order by object_id"
2947 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
2948 $ret[$row['object_id']] = $row['poolcount'];
2952 // For the given object return: its vsconfig/rsconfig; the list of RS pools
2953 // attached (each with vsconfig/rsconfig in turn), each with the list of
2954 // virtual services terminating the pool. Each pool also lists all real
2955 // servers with rsconfig.
2956 function getSLBConfig ($object_id)
2959 $result = usePreparedSelectBlade
2961 'select vs_id, inet_ntoa(vip) as vip, vport, proto, vs.name as vs_name, ' .
2962 'vs.vsconfig as vs_vsconfig, vs.rsconfig as vs_rsconfig, ' .
2963 'lb.vsconfig as lb_vsconfig, lb.rsconfig as lb_rsconfig, lb.prio as prio, pool.id as pool_id, pool.name as pool_name, ' .
2964 'pool.vsconfig as pool_vsconfig, pool.rsconfig as pool_rsconfig, ' .
2965 'rs.id as rs_id, inet_ntoa(rsip) as rsip, rsport, rs.rsconfig as rs_rsconfig from ' .
2966 'IPv4LB as lb inner join IPv4RSPool as pool on lb.rspool_id = pool.id ' .
2967 'inner join IPv4VS as vs on lb.vs_id = vs.id ' .
2968 'inner join IPv4RS as rs on lb.rspool_id = rs.rspool_id ' .
2969 "where lb.object_id = ? and rs.inservice = 'yes' " .
2970 "order by vs.vip, vport, proto, pool.name, rs.rsip, rs.rsport",
2973 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
2975 $vs_id = $row['vs_id'];
2976 if (!isset ($ret[$vs_id]))
2978 foreach (array ('vip', 'vport', 'proto', 'vs_name', 'vs_vsconfig', 'vs_rsconfig', 'lb_vsconfig', 'lb_rsconfig', 'pool_vsconfig', 'pool_rsconfig', 'pool_id', 'pool_name', 'prio') as $c)
2979 $ret[$vs_id][$c] = $row[$c];
2980 $ret[$vs_id]['rslist'] = array();
2982 foreach (array ('rsip', 'rsport', 'rs_rsconfig') as $c)
2983 $ret[$vs_id]['rslist'][$row['rs_id']][$c] = $row[$c];
2988 function commitUpdateSLBDefConf ($data)
2990 return saveScript('DefaultVSConfig', $data['vs']) &&
2991 saveScript('DefaultRSConfig', $data['rs']);
2994 function getSLBDefaults ($do_cache_result = FALSE) {
2995 static $ret = array();
2997 if (! $do_cache_result)
2999 elseif (! empty ($ret))
3002 $ret['vs'] = loadScript('DefaultVSConfig');
3003 $ret['rs'] = loadScript('DefaultRSConfig');
3007 function commitSetInService ($rs_id = 0, $inservice = '')
3009 if (! in_array ($inservice, array ('yes', 'no')))
3010 throw new InvalidArgException ('$inservice', $inservice);
3011 return usePreparedUpdateBlade ('IPv4RS', array ('inservice' => $inservice), array ('id' => $rs_id));
3014 function executeAutoPorts ($object_id = 0, $type_id = 0)
3016 if ($object_id == 0)
3017 throw new InvalidArgException ('$object_id', $object_id);
3019 throw new InvalidArgException ('$type_id', $type_id);
3020 foreach (getAutoPorts ($type_id) as $autoport)
3021 commitAddPort ($object_id, $autoport['name'], $autoport['type'], '', '');
3024 // Return only implicitly listed tags, the rest of the chain will be
3025 // generated/deducted later at higher levels.
3026 // Result is a chain: randomly indexed taginfo list.
3027 function loadEntityTags ($entity_realm = '', $entity_id = 0)
3030 $result = usePreparedSelectBlade
3032 "select tt.id, tag from " .
3033 "TagStorage as ts inner join TagTree as tt on ts.tag_id = tt.id " .
3034 "where entity_realm = ? and entity_id = ? " .
3036 array ($entity_realm, $entity_id)
3038 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
3039 $ret[$row['id']] = $row;
3040 return getExplicitTagsOnly ($ret);
3043 // Return a tag chain with all DB tags on it.
3044 function getTagList ()
3047 $result = usePreparedSelectBlade
3049 "select id, parent_id, tag, entity_realm as realm, count(entity_id) as refcnt " .
3050 "from TagTree left join TagStorage on id = tag_id " .
3051 "group by id, entity_realm order by tag"
3053 // Collation index. The resulting rows are ordered according to default collation,
3054 // which is utf8_general_ci for UTF-8.
3056 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
3058 if (!isset ($ret[$row['id']]))
3059 $ret[$row['id']] = array
3062 'tag' => $row['tag'],
3064 'parent_id' => $row['parent_id'],
3065 'refcnt' => array ('total' => 0)
3069 $ret[$row['id']]['refcnt'][$row['realm']] = $row['refcnt'];
3070 $ret[$row['id']]['refcnt']['total'] +
= $row['refcnt'];
3071 // introduce the 'pseudo'-ream 'ipnet' which combines 'ipv4net' and 'ipv6net' realms.
3072 if ($row['realm'] == 'ipv4net' ||
$row['realm'] == 'ipv6net')
3073 if (isset ($ret[$row['id']]['refcnt']['ipnet']))
3074 $ret[$row['id']]['refcnt']['ipnet'] +
= $row['refcnt'];
3076 $ret[$row['id']]['refcnt']['ipnet'] = $row['refcnt'];
3082 // Drop the whole chain stored.
3083 function destroyTagsForEntity ($entity_realm, $entity_id)
3085 return usePreparedDeleteBlade ('TagStorage', array ('entity_realm' => $entity_realm, 'entity_id' => $entity_id));
3088 // Drop only one record. This operation doesn't involve retossing other tags, unlike when adding.
3089 // FIXME: this function could be used by 3rd-party scripts, dismiss it at some later point,
3091 function deleteTagForEntity ($entity_realm, $entity_id, $tag_id)
3093 return usePreparedDeleteBlade ('TagStorage', array ('entity_realm' => $entity_realm, 'entity_id' => $entity_id, 'tag_id' => $tag_id));
3096 // Push a record into TagStorage unconditionally.
3097 function addTagForEntity ($realm, $entity_id, $tag_id)
3100 if (! array_key_exists ($realm, $SQLSchema))
3101 throw new InvalidArgException ('realm', $realm);
3102 // spotEntity ($realm, $entity_id) would be a more expensive way
3103 // to validate two parameters
3104 return usePreparedInsertBlade
3109 'entity_realm' => $realm,
3110 'entity_id' => $entity_id,
3111 'tag_id' => $tag_id,
3116 // Add records into TagStorage, if this makes sense (IOW, they don't appear
3117 // on the implicit list already). Then remove any other records, which
3118 // appear on the "implicit" side of the chain. This will make sure,
3119 // that both the tag base is still minimal and all requested tags appear on
3120 // the resulting tag chain.
3121 // Return TRUE, if any changes were committed.
3122 function rebuildTagChainForEntity ($realm, $entity_id, $extrachain = array())
3124 // Put the current explicit sub-chain into a buffer and merge all tags from
3125 // the extra chain, which aren't there yet.
3126 $newchain = $oldchain = loadEntityTags ($realm, $entity_id);
3127 foreach ($extrachain as $extratag)
3128 if (!tagOnChain ($extratag, $newchain))
3129 $newchain[] = $extratag;
3130 // Then minimize the working buffer and check if it differs from the original
3131 // chain we started with. If it is so, save the work and signal the upper layer.
3132 $newchain = getExplicitTagsOnly ($newchain);
3133 if (tagChainCmp ($oldchain, $newchain))
3135 destroyTagsForEntity ($realm, $entity_id);
3136 foreach ($newchain as $taginfo)
3137 addTagForEntity ($realm, $entity_id, $taginfo['id']);
3143 // Presume, that the target record has no tags attached.
3144 function produceTagsForLastRecord ($realm, $tagidlist, $last_insert_id = 0)
3146 if (!$last_insert_id)
3147 $last_insert_id = lastInsertID();
3148 foreach (getExplicitTagsOnly (buildTagChainFromIds ($tagidlist)) as $taginfo)
3149 addTagForEntity ($realm, $last_insert_id, $taginfo['id']);
3152 function createIPv4Prefix ($range = '', $name = '', $is_bcast = FALSE, $taglist = array())
3154 // $range is in x.x.x.x/x format, split into ip/mask vars
3155 $rangeArray = explode('/', $range);
3156 if (count ($rangeArray) != 2)
3157 throw new InvalidRequestArgException ('range', $range, 'Invalid IPv4 prefix');
3158 $ip = $rangeArray[0];
3159 $mask = $rangeArray[1];
3161 if (!strlen ($ip) or !strlen ($mask))
3162 throw new InvalidRequestArgException ('range', $range, 'Invalid IPv4 prefix');
3163 $ipL = ip2long($ip);
3164 $maskL = ip2long($mask);
3165 if ($ipL == -1 ||
$ipL === FALSE)
3166 throw new InvalidRequestArgException ('range', $range, 'Invalid IPv4 address');
3167 if ($mask < 32 && $mask > 0)
3171 $maskB = decbin($maskL);
3172 if (strlen($maskB)!=32)
3173 throw new InvalidRequestArgException ('range', $range, 'Invalid netmask');
3176 foreach( str_split ($maskB) as $digit)
3183 if ($zeroes == TRUE)
3184 throw new InvalidRequestArgException ('range', $range, 'Invalid netmask');
3189 $binmask = binMaskFromDec($maskL);
3190 $ipL = $ipL & $binmask;
3191 usePreparedInsertBlade
3196 'ip' => sprintf ('%u', $ipL),
3202 if ($is_bcast and $maskL < 31)
3204 $network_addr = long2ip ($ipL);
3205 $broadcast_addr = long2ip ($ipL |
binInvMaskFromDec ($maskL));
3206 updateV4Address ($network_addr, 'network', 'yes');
3207 updateV4Address ($broadcast_addr, 'broadcast', 'yes');
3209 produceTagsForLastRecord ('ipv4net', $taglist);
3212 function createIPv6Prefix ($range = '', $name = '', $taglist = array())
3214 // $range is in aaa0:b::c:d/x format, split into ip/mask vars
3215 $rangeArray = explode ('/', $range);
3216 if (count ($rangeArray) != 2)
3217 throw new InvalidRequestArgException ('range', $range, 'Invalid IPv6 prefix');
3218 $ip = $rangeArray[0];
3219 $mask = $rangeArray[1];
3220 $address = new IPv6Address
;
3221 if (!strlen ($ip) or !strlen ($mask) or ! $address->parse ($ip))
3222 throw new InvalidRequestArgException ('range', $range, 'Invalid IPv4 prefix');
3223 $network_addr = $address->get_first_subnet_address ($mask);
3224 $broadcast_addr = $address->get_last_subnet_address ($mask);
3225 if (! $network_addr ||
! $broadcast_addr)
3226 throw new InvalidRequestArgException ('range', $range, 'Invalid netmask');
3227 usePreparedInsertBlade
3232 'ip' => $network_addr,
3233 'last_ip' => $broadcast_addr,
3238 produceTagsForLastRecord ('ipv6net', $taglist);
3241 // FIXME: This function doesn't wipe relevant records from IPv4Address table.
3242 function destroyIPv4Prefix ($id)
3244 releaseFiles ('ipv4net', $id);
3245 usePreparedDeleteBlade ('IPv4Network', array ('id' => $id));
3246 destroyTagsForEntity ('ipv4net', $id);
3249 // FIXME: This function doesn't wipe relevant records from IPv6Address table.
3250 function destroyIPv6Prefix ($id)
3252 releaseFiles ('ipv6net', $id);
3253 usePreparedDeleteBlade ('IPv6Network', array ('id' => $id));
3254 destroyTagsForEntity ('ipv6net', $id);
3257 function loadScript ($name)
3259 $result = usePreparedSelectBlade ("select script_text from Script where script_name = ?", array ($name));
3260 $row = $result->fetch (PDO
::FETCH_NUM
);
3267 function saveScript ($name = '', $text)
3269 if (!strlen ($name))
3270 throw new InvalidArgException ('$name', $name);
3271 return usePreparedExecuteBlade
3273 'INSERT INTO Script (script_name, script_text) VALUES (?, ?) ' .
3274 'ON DUPLICATE KEY UPDATE script_text=?',
3275 array ($name, $text, $text)
3279 function newPortForwarding ($object_id, $localip, $localport, $remoteip, $remoteport, $proto, $description)
3281 if (NULL === getIPv4AddressNetworkId ($localip))
3282 return "$localip: Non existant ip";
3283 if (NULL === getIPv4AddressNetworkId ($remoteip))
3284 return "$remoteip: Non existant ip";
3285 if ( ($localport <= 0) or ($localport >= 65536) )
3286 return "$localport: invaild port";
3287 if ( ($remoteport <= 0) or ($remoteport >= 65536) )
3288 return "$remoteport: invaild port";
3290 $result = usePreparedExecuteBlade
3292 'INSERT INTO IPv4NAT (object_id, localip, remoteip, localport, remoteport, proto, description) ' .
3293 'VALUES (?, INET_ATON(?), INET_ATON(?), ?, ?, ?, ?)',
3305 return $result !== FALSE ?
'' : (__FUNCTION__
. '(): failed to insert the rule');
3308 function deletePortForwarding ($object_id, $localip, $localport, $remoteip, $remoteport, $proto)
3310 return usePreparedExecuteBlade
3312 'DELETE FROM IPv4NAT WHERE object_id=? AND localip=INET_ATON(?) AND ' .
3313 'remoteip=INET_ATON(?) AND localport=? AND remoteport=? AND proto=?',
3314 array ($object_id, $localip, $remoteip, $localport, $remoteport, $proto)
3318 function updatePortForwarding ($object_id, $localip, $localport, $remoteip, $remoteport, $proto, $description)
3320 return usePreparedExecuteBlade
3322 'UPDATE IPv4NAT SET description=? WHERE object_id=? AND localip=INET_ATON(?) AND remoteip=INET_ATON(?) ' .
3323 'AND localport=? AND remoteport=? AND proto=?',
3324 array ($description, $object_id, $localip, $remoteip, $localport, $remoteport, $proto)
3328 function getNATv4ForObject ($object_id)
3331 $ret['out'] = array();
3332 $ret['in'] = array();
3333 $result = usePreparedSelectBlade
3337 "INET_NTOA(localip) as localip, ".
3339 "INET_NTOA(remoteip) as remoteip, ".
3341 "ipa1.name as local_addr_name, " .
3342 "ipa2.name as remote_addr_name, " .
3345 "left join IPv4Address as ipa1 on IPv4NAT.localip = ipa1.ip " .
3346 "left join IPv4Address as ipa2 on IPv4NAT.remoteip = ipa2.ip " .
3347 "where object_id=? ".
3348 "order by localip, localport, proto, remoteip, remoteport",
3352 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
3354 foreach (array ('proto', 'localport', 'localip', 'remoteport', 'remoteip', 'description', 'local_addr_name', 'remote_addr_name') as $cname)
3355 $ret['out'][$count][$cname] = $row[$cname];
3360 $result = usePreparedSelectBlade
3364 "INET_NTOA(localip) as localip, ".
3366 "INET_NTOA(remoteip) as remoteip, ".
3368 "IPv4NAT.object_id as object_id, ".
3369 "RackObject.name as object_name, ".
3371 "from ((IPv4NAT join IPv4Allocation on remoteip=IPv4Allocation.ip) join RackObject on IPv4NAT.object_id=RackObject.id) ".
3372 "where IPv4Allocation.object_id=? ".
3373 "order by remoteip, remoteport, proto, localip, localport",
3377 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
3379 foreach (array ('proto', 'localport', 'localip', 'remoteport', 'remoteip', 'object_id', 'object_name', 'description') as $cname)
3380 $ret['in'][$count][$cname] = $row[$cname];
3386 // Return a list of files, which are not linked to the specified record. This list