4 * This file is a library of database access functions for RackTables.
8 function escapeString ($value, $do_db_escape = TRUE)
10 $ret = htmlspecialchars ($value, ENT_QUOTES
, 'UTF-8');
14 $ret = substr ($dbxlink->quote ($ret), 1, -1);
19 function getRackspace ($tagfilter = array(), $tfmode = 'any')
21 $whereclause = getWhereClause ($tagfilter);
23 "select dict_key as row_id, dict_value as row_name " .
24 "from Chapter natural join Dictionary left join Rack on Rack.row_id = dict_key " .
25 "left join TagStorage on Rack.id = TagStorage.target_id and target_realm = 'rack' " .
26 "where chapter_name = 'RackRow' " .
28 " order by dict_value";
29 $result = useSelectBlade ($query, __FUNCTION__
);
31 $clist = array ('row_id', 'row_name');
32 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
33 foreach ($clist as $cname)
34 $ret[$row['row_id']][$cname] = $row[$cname];
35 $result->closeCursor();
39 // Return detailed information about one rack row.
40 function getRackRowInfo ($rackrow_id)
43 "select dict_key as id, dict_value as name, count(Rack.id) as count, " .
44 "if(isnull(sum(Rack.height)),0,sum(Rack.height)) as sum " .
45 "from Chapter natural join Dictionary left join Rack on Rack.row_id = dict_key " .
46 "where chapter_name = 'RackRow' and dict_key = ${rackrow_id} " .
48 $result = useSelectBlade ($query, __FUNCTION__
);
49 if ($row = $result->fetch (PDO
::FETCH_ASSOC
))
55 // This function returns id->name map for all object types. The map is used
56 // to build <select> input for objects.
57 function getObjectTypeList ()
59 return readChapter ('RackObjectType');
62 // Return a part of SQL query suitable for embeding into a bigger text.
63 // The returned result should list all tag IDs shown in the tag filter.
64 function getWhereClause ($tagfilter = array())
67 if (count ($tagfilter))
69 $whereclause .= ' and (';
71 foreach ($tagfilter as $tag_id)
73 $whereclause .= $conj . 'tag_id = ' . $tag_id;
81 // Return a simple object list w/o related information.
82 function getNarrowObjectList ($type_id = 0)
87 showError ('Invalid argument', __FUNCTION__
);
90 // object type id is known and constant, but it's Ok to have this standard overhead
92 "select RackObject.id as id, RackObject.name as name, dict_value as objtype_name, " .
94 "RackObject inner join Dictionary on objtype_id=dict_key natural join Chapter " .
95 "where RackObject.deleted = 'no' and chapter_name = 'RackObjectType' " .
96 "and objtype_id = ${type_id} " .
98 $result = useSelectBlade ($query, __FUNCTION__
);
99 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
107 $ret[$row['id']][$cname] = $row[$cname];
108 $ret[$row['id']]['dname'] = displayedName ($ret[$row['id']]);
113 // Return a filtered, detailed object list.
114 function getObjectList ($type_id = 0, $tagfilter = array(), $tfmode = 'any')
116 $whereclause = getWhereClause ($tagfilter);
118 $whereclause .= " and objtype_id = '${type_id}' ";
120 "select distinct RackObject.id as id , RackObject.name as name, dict_value as objtype_name, " .
121 "RackObject.label as label, RackObject.barcode as barcode, " .
122 "dict_key as objtype_id, asset_no, rack_id, Rack.name as Rack_name from " .
123 "((RackObject inner join Dictionary on objtype_id=dict_key natural join Chapter) " .
124 "left join RackSpace on RackObject.id = object_id) " .
125 "left join Rack on rack_id = Rack.id " .
126 "left join TagStorage on RackObject.id = TagStorage.target_id and target_realm = 'object' " .
127 "where RackObject.deleted = 'no' and chapter_name = 'RackObjectType' " .
130 $result = useSelectBlade ($query, __FUNCTION__
);
132 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
145 $ret[$row['id']][$cname] = $row[$cname];
146 $ret[$row['id']]['dname'] = displayedName ($ret[$row['id']]);
148 $result->closeCursor();
152 function getRacksForRow ($row_id = 0, $tagfilter = array(), $tfmode = 'any')
155 "select Rack.id, Rack.name, height, Rack.comment, row_id, " .
156 "'yes' as left_is_front, 'yes' as bottom_is_unit1, dict_value as row_name " .
157 "from Rack left join Dictionary on row_id = dict_key natural join Chapter " .
158 "left join TagStorage on Rack.id = TagStorage.target_id and target_realm = 'rack' " .
159 "where chapter_name = 'RackRow' and Rack.deleted = 'no' " .
160 (($row_id == 0) ?
"" : "and row_id = ${row_id} ") .
161 getWhereClause ($tagfilter) .
162 " order by row_name, Rack.id";
163 $result = useSelectBlade ($query, __FUNCTION__
);
176 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
177 foreach ($clist as $cname)
178 $ret[$row['id']][$cname] = $row[$cname];
179 $result->closeCursor();
180 usort ($ret, 'sortRacks');
181 $ret = restoreRackIDs ($ret);
185 // This is a popular helper for getting information about
186 // a particular rack and its rackspace at once.
187 function getRackData ($rack_id = 0, $silent = FALSE)
191 if ($silent == FALSE)
192 showError ('Invalid rack_id', __FUNCTION__
);
196 "select Rack.id, Rack.name, row_id, height, Rack.comment, " .
197 "'yes' as left_is_front, 'yes' as bottom_is_unit1, dict_value as row_name from " .
198 "Rack left join Dictionary on Rack.row_id = dict_key natural join Chapter " .
199 "where chapter_name = 'RackRow' and Rack.id='${rack_id}' and Rack.deleted = 'no' limit 1";
200 $result = useSelectBlade ($query, __FUNCTION__
);
201 if (($row = $result->fetch (PDO
::FETCH_ASSOC
)) == NULL)
203 if ($silent == FALSE)
204 showError ('Query #1 succeded, but returned no data', __FUNCTION__
);
220 foreach ($clist as $cname)
221 $rack[$cname] = $row[$cname];
222 $result->closeCursor();
225 // start with default rackspace
226 for ($i = $rack['height']; $i > 0; $i--)
227 for ($locidx = 0; $locidx < 3; $locidx++
)
228 $rack[$i][$locidx]['state'] = 'F';
232 "select unit_no, atom, state, object_id " .
233 "from RackSpace where rack_id = ${rack_id} and " .
234 "unit_no between 1 and " . $rack['height'] . " order by unit_no";
235 $result = useSelectBlade ($query, __FUNCTION__
);
237 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
239 $rack[$row['unit_no']][$loclist[$row['atom']]]['state'] = $row['state'];
240 $rack[$row['unit_no']][$loclist[$row['atom']]]['object_id'] = $row['object_id'];
242 $result->closeCursor();
246 // This is a popular helper.
247 function getObjectInfo ($object_id = 0)
251 showError ('Invalid object_id', __FUNCTION__
);
255 "select id, name, label, barcode, dict_value as objtype_name, asset_no, dict_key as objtype_id, has_problems, comment from " .
256 "RackObject inner join Dictionary on objtype_id = dict_key natural join Chapter " .
257 "where id = '${object_id}' and deleted = 'no' and chapter_name = 'RackObjectType' limit 1";
258 $result = useSelectBlade ($query, __FUNCTION__
);
259 if (($row = $result->fetch (PDO
::FETCH_ASSOC
)) == NULL)
261 showError ('Query succeeded, but returned no data', __FUNCTION__
);
266 $ret['id'] = $row['id'];
267 $ret['name'] = $row['name'];
268 $ret['label'] = $row['label'];
269 $ret['barcode'] = $row['barcode'];
270 $ret['objtype_name'] = $row['objtype_name'];
271 $ret['objtype_id'] = $row['objtype_id'];
272 $ret['has_problems'] = $row['has_problems'];
273 $ret['asset_no'] = $row['asset_no'];
274 $ret['dname'] = displayedName ($ret);
275 $ret['comment'] = $row['comment'];
277 $result->closeCursor();
282 function getPortTypes ()
284 return readChapter ('PortType');
287 function getObjectPortsAndLinks ($object_id = 0)
291 showError ('Invalid object_id', __FUNCTION__
);
295 "select Port.id as Port_id, ".
296 "Port.name as Port_name, ".
297 "Port.label as Port_label, ".
298 "Port.l2address as Port_l2address, ".
299 "Port.type as Port_type, ".
300 "Port.reservation_comment as Port_reservation_comment, " .
301 "dict_value as PortType_name, ".
302 "RemotePort.id as RemotePort_id, ".
303 "RemotePort.name as RemotePort_name, ".
304 "RemotePort.object_id as RemotePort_object_id, ".
305 "RackObject.name as RackObject_name ".
309 "Port inner join Dictionary on Port.type = dict_key natural join Chapter".
311 "left join Link on Port.id=Link.porta or Port.id=Link.portb ".
313 "left join Port as RemotePort on Link.portb=RemotePort.id or Link.porta=RemotePort.id ".
315 "left join RackObject on RemotePort.object_id=RackObject.id ".
316 "where chapter_name = 'PortType' and Port.object_id=${object_id} ".
317 "and (Port.id != RemotePort.id or RemotePort.id is null) ".
318 "order by Port_name";
319 $result = useSelectBlade ($query, __FUNCTION__
);
322 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
324 $ret[$count]['id'] = $row['Port_id'];
325 $ret[$count]['name'] = $row['Port_name'];
326 $ret[$count]['l2address'] = l2addressFromDatabase ($row['Port_l2address']);
327 $ret[$count]['label'] = $row['Port_label'];
328 $ret[$count]['type_id'] = $row['Port_type'];
329 $ret[$count]['type'] = $row['PortType_name'];
330 $ret[$count]['reservation_comment'] = $row['Port_reservation_comment'];
331 $ret[$count]['remote_id'] = $row['RemotePort_id'];
332 $ret[$count]['remote_name'] = htmlentities ($row['RemotePort_name'], ENT_QUOTES
);
333 $ret[$count]['remote_object_id'] = $row['RemotePort_object_id'];
334 $ret[$count]['remote_object_name'] = $row['RackObject_name'];
335 // Save on displayedName() calls.
336 if (empty ($row['RackObject_name']) and !empty ($row['RemotePort_object_id']))
338 $oi = getObjectInfo ($row['RemotePort_object_id']);
339 $ret[$count]['remote_object_name'] = displayedName ($oi);
343 $result->closeCursor();
347 function commitAddRack ($name, $height = 0, $row_id = 0, $comment, $taglist)
349 if ($row_id <= 0 or $height <= 0 or empty ($name))
351 $result = useInsertBlade
357 'name' => "'${name}'",
359 'comment' => "'${comment}'"
364 showError ('useInsertBlade() failed', __FUNCTION__
);
367 $last_insert_id = lastInsertID();
368 return (produceTagsForLastRecord ('rack', $taglist, $last_insert_id) == '') and recordHistory ('Rack', "id = ${last_insert_id}");
371 function commitAddObject ($new_name, $new_label, $new_barcode, $new_type_id, $new_asset_no, $taglist = array())
374 // Maintain UNIQUE INDEX for common names and asset tags by
375 // filtering out empty strings (not NULLs).
376 $result1 = useInsertBlade
381 'name' => empty ($new_name) ?
'NULL' : "'${new_name}'",
382 'label' => "'${new_label}'",
383 'barcode' => empty ($new_barcode) ?
'NULL' : "'${new_barcode}'",
384 'objtype_id' => $new_type_id,
385 'asset_no' => empty ($new_asset_no) ?
'NULL' : "'${new_asset_no}'"
388 if ($result1 == NULL)
390 showError ("SQL query #1 failed", __FUNCTION__
);
393 $last_insert_id = lastInsertID();
394 // Do AutoPorts magic
395 executeAutoPorts ($last_insert_id, $new_type_id);
397 $error = produceTagsForLastRecord ('object', $taglist, $last_insert_id);
400 showError ("Error adding tags for the object: ${error}");
403 return recordHistory ('RackObject', "id = ${last_insert_id}");
406 function commitUpdateObject ($object_id = 0, $new_name = '', $new_label = '', $new_barcode = '', $new_type_id = 0, $new_has_problems = 'no', $new_asset_no = '', $new_comment = '')
408 if ($object_id == 0 ||
$new_type_id == 0)
410 showError ('Not all required args are present.', __FUNCTION__
);
414 $new_asset_no = empty ($new_asset_no) ?
'NULL' : "'${new_asset_no}'";
415 $new_barcode = empty ($new_barcode) ?
'NULL' : "'${new_barcode}'";
416 $new_name = empty ($new_name) ?
'NULL' : "'${new_name}'";
417 $query = "update RackObject set name=${new_name}, label='${new_label}', barcode=${new_barcode}, objtype_id='${new_type_id}', " .
418 "has_problems='${new_has_problems}', asset_no=${new_asset_no}, comment='${new_comment}' " .
419 "where id='${object_id}' limit 1";
420 $result = $dbxlink->query ($query);
423 showError ("SQL query '${query}' failed", __FUNCTION__
);
426 $result->closeCursor();
427 return recordHistory ('RackObject', "id = ${object_id}");
430 function commitUpdateRack ($rack_id, $new_name, $new_height, $new_row_id, $new_comment)
432 if (empty ($rack_id) ||
empty ($new_name) ||
empty ($new_height))
434 showError ('Not all required args are present.', __FUNCTION__
);
438 $query = "update Rack set name='${new_name}', height='${new_height}', comment='${new_comment}', row_id=${new_row_id} " .
439 "where id='${rack_id}' limit 1";
440 $result1 = $dbxlink->query ($query);
441 if ($result1->rowCount() != 1)
443 showError ('Error updating rack information', __FUNCTION__
);
446 return recordHistory ('Rack', "id = ${rack_id}");
449 // This function accepts rack data returned by getRackData(), validates and applies changes
450 // supplied in $_REQUEST and returns resulting array. Only those changes are examined, which
451 // correspond to current rack ID.
452 // 1st arg is rackdata, 2nd arg is unchecked state, 3rd arg is checked state.
453 // If 4th arg is present, object_id fields will be updated accordingly to the new state.
454 // The function returns the modified rack upon success.
455 function processGridForm (&$rackData, $unchecked_state, $checked_state, $object_id = 0)
457 global $loclist, $dbxlink;
458 $rack_id = $rackData['id'];
459 $rack_name = $rackData['name'];
460 $rackchanged = FALSE;
461 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
463 for ($locidx = 0; $locidx < 3; $locidx++
)
465 if ($rackData[$unit_no][$locidx]['enabled'] != TRUE)
468 $state = $rackData[$unit_no][$locidx]['state'];
469 if (isset ($_REQUEST["atom_${rack_id}_${unit_no}_${locidx}"]) and $_REQUEST["atom_${rack_id}_${unit_no}_${locidx}"] == 'on')
470 $newstate = $checked_state;
472 $newstate = $unchecked_state;
473 if ($state == $newstate)
477 $atom = $loclist[$locidx];
478 // The only changes allowed are those introduced by checkbox grid.
481 !($state == $checked_state && $newstate == $unchecked_state) &&
482 !($state == $unchecked_state && $newstate == $checked_state)
484 return array ('code' => 500, 'message' => "${rack_name}: Rack ID ${rack_id}, unit ${unit_no}, 'atom ${atom}', cannot change state from '${state}' to '${newstate}'");
485 // Here we avoid using ON DUPLICATE KEY UPDATE by first performing DELETE
486 // anyway and then looking for probable need of INSERT.
488 "delete from RackSpace where rack_id = ${rack_id} and " .
489 "unit_no = ${unit_no} and atom = '${atom}' limit 1";
490 $r = $dbxlink->query ($query);
492 return array ('code' => 500, 'message' => __FUNCTION__
. ": ${rack_name}: SQL DELETE query failed");
493 if ($newstate != 'F')
496 "insert into RackSpace(rack_id, unit_no, atom, state) " .
497 "values(${rack_id}, ${unit_no}, '${atom}', '${newstate}') ";
498 $r = $dbxlink->query ($query);
500 return array ('code' => 500, 'message' => __FUNCTION__
. ": ${rack_name}: SQL INSERT query failed");
502 if ($newstate == 'T' and $object_id != 0)
504 // At this point we already have a record in RackSpace.
506 "update RackSpace set object_id=${object_id} " .
507 "where rack_id=${rack_id} and unit_no=${unit_no} and atom='${atom}' limit 1";
508 $r = $dbxlink->query ($query);
509 if ($r->rowCount() == 1)
510 $rackData[$unit_no][$locidx]['object_id'] = $object_id;
512 return array ('code' => 500, 'message' => "${rack_name}: Rack ID ${rack_id}, unit ${unit_no}, atom '${atom}' failed to set object_id to '${object_id}'");
518 resetThumbCache ($rack_id);
519 return array ('code' => 200, 'message' => "${rack_name}: All changes were successfully saved.");
522 return array ('code' => 300, 'message' => "${rack_name}: No changes.");
525 // This function builds a list of rack-unit-atom records, which are assigned to
526 // the requested object.
527 function getMoleculeForObject ($object_id = 0)
531 showError ("object_id == 0", __FUNCTION__
);
535 "select rack_id, unit_no, atom from RackSpace " .
536 "where state = 'T' and object_id = ${object_id} order by rack_id, unit_no, atom";
537 $result = useSelectBlade ($query, __FUNCTION__
);
538 $ret = $result->fetchAll (PDO
::FETCH_ASSOC
);
539 $result->closeCursor();
543 // This function builds a list of rack-unit-atom records for requested molecule.
544 function getMolecule ($mid = 0)
548 showError ("mid == 0", __FUNCTION__
);
552 "select rack_id, unit_no, atom from Atom " .
553 "where molecule_id=${mid}";
554 $result = useSelectBlade ($query, __FUNCTION__
);
555 $ret = $result->fetchAll (PDO
::FETCH_ASSOC
);
556 $result->closeCursor();
560 // returns exactly what is's named after
561 function lastInsertID ()
563 if (NULL == ($result = useSelectBlade ('select last_insert_id()', __FUNCTION__
)))
565 showError ('SQL query failed!', __FUNCTION__
);
568 $row = $result->fetch (PDO
::FETCH_NUM
);
572 // This function creates a new record in Molecule and number of linked
573 // R-U-A records in Atom.
574 function createMolecule ($molData)
577 $query = "insert into Molecule values()";
578 $result1 = $dbxlink->query ($query);
579 if ($result1->rowCount() != 1)
581 showError ('Error inserting into Molecule', __FUNCTION__
);
584 $molecule_id = lastInsertID();
585 foreach ($molData as $rua)
587 $rack_id = $rua['rack_id'];
588 $unit_no = $rua['unit_no'];
589 $atom = $rua['atom'];
591 "insert into Atom(molecule_id, rack_id, unit_no, atom) " .
592 "values (${molecule_id}, ${rack_id}, ${unit_no}, '${atom}')";
593 $result3 = $dbxlink->query ($query);
594 if ($result3 == NULL or $result3->rowCount() != 1)
596 showError ('Error inserting into Atom', __FUNCTION__
);
603 // History logger. This function assumes certain table naming convention and
605 // 1. History table name equals to dictionary table name plus 'History'.
606 // 2. History table must have the same row set (w/o keys) plus one row named
607 // 'ctime' of type 'timestamp'.
608 function recordHistory ($tableName, $whereClause)
610 global $dbxlink, $remote_username;
611 $query = "insert into ${tableName}History select *, current_timestamp(), '${remote_username}' from ${tableName} where ${whereClause}";
612 $result = $dbxlink->query ($query);
613 if ($result == NULL or $result->rowCount() != 1)
615 showError ("SQL query '${query}' failed for table ${tableName}", __FUNCTION__
);
621 function getRackspaceHistory ()
624 "select mo.id as mo_id, ro.id as ro_id, ro.name, mo.ctime, mo.comment, dict_value as objtype_name, user_name from " .
625 "MountOperation as mo inner join RackObject as ro on mo.object_id = ro.id " .
626 "inner join Dictionary on objtype_id = dict_key natural join Chapter " .
627 "where chapter_name = 'RackObjectType' order by ctime desc";
628 $result = useSelectBlade ($query, __FUNCTION__
);
629 $ret = $result->fetchAll(PDO
::FETCH_ASSOC
);
630 $result->closeCursor();
634 // This function is used in renderRackspaceHistory()
635 function getOperationMolecules ($op_id = 0)
639 showError ("Missing argument", __FUNCTION__
);
642 $query = "select old_molecule_id, new_molecule_id from MountOperation where id = ${op_id}";
643 $result = useSelectBlade ($query, __FUNCTION__
);
644 // We expect one row.
645 $row = $result->fetch (PDO
::FETCH_ASSOC
);
648 showError ("SQL query succeded, but returned no results.", __FUNCTION__
);
651 $omid = $row['old_molecule_id'];
652 $nmid = $row['new_molecule_id'];
653 $result->closeCursor();
654 return array ($omid, $nmid);
657 function getResidentRacksData ($object_id = 0, $fetch_rackdata = TRUE)
661 showError ('Invalid object_id', __FUNCTION__
);
664 $query = "select distinct rack_id from RackSpace where object_id = ${object_id} order by rack_id";
665 $result = useSelectBlade ($query, __FUNCTION__
);
666 $rows = $result->fetchAll (PDO
::FETCH_NUM
);
667 $result->closeCursor();
669 foreach ($rows as $row)
671 if (!$fetch_rackdata)
673 $ret[$row[0]] = $row[0];
676 $rackData = getRackData ($row[0]);
677 if ($rackData == NULL)
679 showError ('getRackData() failed', __FUNCTION__
);
682 $ret[$row[0]] = $rackData;
684 $result->closeCursor();
688 function getObjectGroupInfo ()
691 'select dict_key as id, dict_value as name, count(id) as count from ' .
692 'Dictionary natural join Chapter left join RackObject on dict_key = objtype_id ' .
693 'where chapter_name = "RackObjectType" ' .
694 'group by dict_key order by dict_value';
695 $result = useSelectBlade ($query, __FUNCTION__
);
697 $ret[0] = array ('id' => 0, 'name' => 'ALL types');
698 $clist = array ('id', 'name', 'count');
700 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
701 if ($row['count'] > 0)
703 $total +
= $row['count'];
704 foreach ($clist as $cname)
705 $ret[$row['id']][$cname] = $row[$cname];
707 $result->closeCursor();
708 $ret[0]['count'] = $total;
712 // This function returns objects, which have no rackspace assigned to them.
713 // Additionally it keeps rack_id parameter, so we can silently pre-select
714 // the rack required.
715 function getUnmountedObjects ()
718 'select dict_value as objtype_name, dict_key as objtype_id, name, label, barcode, id, asset_no from ' .
719 'RackObject inner join Dictionary on objtype_id = dict_key natural join Chapter ' .
720 'left join RackSpace on id = object_id '.
721 'where rack_id is null and chapter_name = "RackObjectType" order by dict_value, name, label, asset_no, barcode';
722 $result = useSelectBlade ($query, __FUNCTION__
);
724 $clist = array ('id', 'name', 'label', 'barcode', 'objtype_name', 'objtype_id', 'asset_no');
725 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
727 foreach ($clist as $cname)
728 $ret[$row['id']][$cname] = $row[$cname];
729 $ret[$row['id']]['dname'] = displayedName ($ret[$row['id']]);
731 $result->closeCursor();
735 function getProblematicObjects ()
738 'select dict_value as objtype_name, dict_key as objtype_id, name, id, asset_no from ' .
739 'RackObject inner join Dictionary on objtype_id = dict_key natural join Chapter '.
740 'where has_problems = "yes" and chapter_name = "RackObjectType" order by objtype_name, name';
741 $result = useSelectBlade ($query, __FUNCTION__
);
743 $clist = array ('id', 'name', 'objtype_name', 'objtype_id', 'asset_no');
744 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
746 foreach ($clist as $cname)
747 $ret[$row['id']][$cname] = $row[$cname];
748 $ret[$row['id']]['dname'] = displayedName ($ret[$row['id']]);
750 $result->closeCursor();
754 function commitAddPort ($object_id = 0, $port_name, $port_type_id, $port_label, $port_l2address)
758 showError ('Invalid object_id', __FUNCTION__
);
761 $port_l2address = l2addressForDatabase ($port_l2address);
762 $result = useInsertBlade
767 'name' => "'${port_name}'",
768 'object_id' => "'${object_id}'",
769 'label' => "'${port_label}'",
770 'type' => "'${port_type_id}'",
771 'l2address' => "${port_l2address}"
777 return 'SQL query failed';
780 // The fifth argument may be either explicit 'NULL' or some (already quoted by the upper layer)
781 // string value. In case it is omitted, we just assign it its current value.
782 // It would be nice to simplify this semantics later.
783 function commitUpdatePort ($port_id, $port_name, $port_label, $port_l2address, $port_reservation_comment = 'reservation_comment')
786 $port_l2address = l2addressForDatabase ($port_l2address);
788 "update Port set name='$port_name', label='$port_label', " .
789 "reservation_comment = ${port_reservation_comment}, l2address=${port_l2address} " .
790 "where id='$port_id'";
791 $result = $dbxlink->exec ($query);
794 $errorInfo = $dbxlink->errorInfo();
795 // We could update nothing.
796 if ($errorInfo[0] == '00000')
798 return $errorInfo[2];
801 function delObjectPort ($port_id)
803 if (unlinkPort ($port_id) != '')
804 return __FUNCTION__
. ': unlinkPort() failed';
805 if (useDeleteBlade ('Port', 'id', $port_id) != TRUE)
806 return __FUNCTION__
. ': useDeleteBlade() failed';
810 function getAllIPv4Allocations ()
813 "select object_id as object_id, ".
814 "RackObject.name as object_name, ".
815 "IPBonds.name as name, ".
816 "INET_NTOA(ip) as ip ".
817 "from IPBonds join RackObject on id=object_id ";
818 $result = useSelectBlade ($query, __FUNCTION__
);
821 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
823 $ret[$count]['object_id']=$row['object_id'];
824 $ret[$count]['object_name']=$row['object_name'];
825 $ret[$count]['name']=$row['name'];
826 $ret[$count]['ip']=$row['ip'];
829 $result->closeCursor();
833 function getEmptyPortsOfType ($type_id)
836 "select distinct Port.id as Port_id, ".
837 "Port.object_id as Port_object_id, ".
838 "RackObject.name as Object_name, ".
839 "Port.name as Port_name, ".
840 "Port.type as Port_type_id, ".
841 "dict_value as Port_type_name ".
844 " Port inner join Dictionary on Port.type = dict_key natural join Chapter ".
846 " join RackObject on Port.object_id = RackObject.id ".
848 "left join Link on Port.id=Link.porta or Port.id=Link.portb ".
849 "inner join PortCompat on Port.type = PortCompat.type2 ".
850 "where chapter_name = 'PortType' and PortCompat.type1 = '$type_id' and Link.porta is NULL ".
851 "and Port.reservation_comment is null order by Object_name, Port_name";
852 $result = useSelectBlade ($query, __FUNCTION__
);
855 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
857 $ret[$count]['Port_id']=$row['Port_id'];
858 $ret[$count]['Port_object_id']=$row['Port_object_id'];
859 $ret[$count]['Object_name']=$row['Object_name'];
860 $ret[$count]['Port_name']=$row['Port_name'];
861 $ret[$count]['Port_type_id']=$row['Port_type_id'];
862 $ret[$count]['Port_type_name']=$row['Port_type_name'];
865 $result->closeCursor();
869 function linkPorts ($porta, $portb)
871 if ($porta == $portb)
872 return "Ports can't be the same";
880 $query1 = "insert into Link set porta='${porta}', portb='{$portb}'";
881 $query2 = "update Port set reservation_comment = NULL where id = ${porta} or id = ${portb} limit 2";
882 // FIXME: who cares about the return value?
883 $result = $dbxlink->exec ($query1);
884 $result = $dbxlink->exec ($query2);
888 function unlinkPort ($port)
892 "delete from Link where porta='$port' or portb='$port'";
893 $result = $dbxlink->exec ($query);
897 // Return all IPv4 addresses allocated to the objects. Attach detailed
898 // info about address to each alocation records. Index result by dotted-quad
900 function getObjectIPv4Allocations ($object_id = 0)
903 $query = 'select name as osif, type, inet_ntoa(ip) as dottedquad from IPBonds ' .
904 "where object_id = ${object_id} " .
906 $result = useSelectBlade ($query, __FUNCTION__
);
907 // don't spawn a sub-query with unfetched buffer, it may fail
908 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
909 $ret[$row['dottedquad']] = array ('osif' => $row['osif'], 'type' => $row['type']);
911 foreach (array_keys ($ret) as $dottedquad)
912 $ret[$dottedquad]['addrinfo'] = getIPv4Address ($dottedquad);
916 // Return minimal IPv4 address, optionally with "ip" key set, if requested.
917 function constructIPv4Address ($dottedquad = NULL)
929 if ($dottedquad != NULL)
930 $ret['ip'] = $dottedquad;
934 // Check the range requested for meaningful IPv4 records, build them
935 // into a list and return. Return an empty list if nothing matched.
936 // Both arguments are expected in signed int32 form. The resulting list
937 // is keyed by uint32 form of each IP address, items aren't sorted.
938 // LATER: accept a list of pairs and build WHERE sub-expression accordingly
939 function scanIPv4Space ($pairlist)
942 if (!count ($pairlist)) // this is normal for a network completely divided into smaller parts
944 $dnamechache = array();
945 // FIXME: this is a copy-and-paste prototype
953 foreach ($pairlist as $tmp)
955 $db_first = sprintf ('%u', 0x00000000 +
$tmp['i32_first']);
956 $db_last = sprintf ('%u', 0x00000000 +
$tmp['i32_last']);
957 $whereexpr1 .= $or . "ip between ${db_first} and ${db_last}";
958 $whereexpr2 .= $or . "ip between ${db_first} and ${db_last}";
959 $whereexpr3 .= $or . "vip between ${db_first} and ${db_last}";
960 $whereexpr4 .= $or . "rsip between ${db_first} and ${db_last}";
961 $whereexpr5a .= $or . "remoteip between ${db_first} and ${db_last}";
962 $whereexpr5b .= $or . "localip between ${db_first} and ${db_last}";
972 // 1. collect labels and reservations
973 $query = "select INET_NTOA(ip) as ip, name, reserved from IPAddress ".
974 "where ${whereexpr1} and (reserved = 'yes' or name != '')";
975 $result = useSelectBlade ($query, __FUNCTION__
);
976 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
978 $ip_bin = ip2long ($row['ip']);
979 if (!isset ($ret[$ip_bin]))
980 $ret[$ip_bin] = constructIPv4Address ($row['ip']);
981 $ret[$ip_bin]['name'] = $row['name'];
982 $ret[$ip_bin]['reserved'] = $row['reserved'];
986 // 2. check for allocations
988 "select INET_NTOA(ipb.ip) as ip, ro.id as object_id, " .
989 "ro.name as object_name, ipb.name, ipb.type, objtype_id, " .
990 "dict_value as objtype_name from " .
991 "IPBonds as ipb inner join RackObject as ro on ipb.object_id = ro.id " .
992 "left join Dictionary on objtype_id=dict_key natural join Chapter " .
993 "where ${whereexpr2} " .
994 "and chapter_name = 'RackObjectType'" .
995 "order by ipb.type, object_name";
996 $result = useSelectBlade ($query, __FUNCTION__
);
997 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
999 $ip_bin = ip2long ($row['ip']);
1000 if (!isset ($ret[$ip_bin]))
1001 $ret[$ip_bin] = constructIPv4Address ($row['ip']);
1002 if (!isset ($dnamecache[$row['object_id']]))
1004 $quasiobject['name'] = $row['object_name'];
1005 $quasiobject['objtype_id'] = $row['objtype_id'];
1006 $quasiobject['objtype_name'] = $row['objtype_name'];
1007 $dnamecache[$row['object_id']] = displayedName ($quasiobject);
1010 foreach (array ('object_id', 'type', 'name') as $cname)
1011 $tmp[$cname] = $row[$cname];
1012 $tmp['object_name'] = $dnamecache[$row['object_id']];
1013 $ret[$ip_bin]['allocs'][] = $tmp;
1017 // 3. look for virtual services and related LB
1018 $query = "select vs_id, inet_ntoa(vip) as ip, vport, proto, vs.name, " .
1019 "object_id, objtype_id, ro.name as object_name, dict_value as objtype_name from " .
1020 "IPVirtualService as vs inner join IPLoadBalancer as lb on vs.id = lb.vs_id " .
1021 "inner join RackObject as ro on lb.object_id = ro.id " .
1022 "left join Dictionary on objtype_id=dict_key " .
1023 "natural join Chapter " .
1024 "where ${whereexpr3} " .
1025 "and chapter_name = 'RackObjectType'" .
1026 "order by vport, proto, ro.name, object_id";
1027 $result = useSelectBlade ($query, __FUNCTION__
);
1028 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
1030 $ip_bin = ip2long ($row['ip']);
1031 if (!isset ($ret[$ip_bin]))
1032 $ret[$ip_bin] = constructIPv4Address ($row['ip']);
1033 if (!isset ($dnamecache[$row['object_id']]))
1035 $quasiobject['name'] = $row['object_name'];
1036 $quasiobject['objtype_id'] = $row['objtype_id'];
1037 $quasiobject['objtype_name'] = $row['objtype_name'];
1038 $dnamecache[$row['object_id']] = displayedName ($quasiobject);
1041 foreach (array ('object_id', 'vport', 'proto', 'vs_id', 'name') as $cname)
1042 $tmp[$cname] = $row[$cname];
1043 $tmp['object_name'] = $dnamecache[$row['object_id']];
1044 $tmp['vip'] = $row['ip'];
1045 $ret[$ip_bin]['lblist'][] = $tmp;
1049 // 4. don't forget about real servers along with pools
1050 $query = "select inet_ntoa(rsip) as ip, inservice, rsport, rspool_id, rsp.name as rspool_name from " .
1051 "IPRealServer as rs inner join IPRSPool as rsp on rs.rspool_id = rsp.id " .
1052 "where ${whereexpr4} " .
1053 "order by ip, rsport, rspool_id";
1054 $result = useSelectBlade ($query, __FUNCTION__
);
1055 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
1057 $ip_bin = ip2long ($row['ip']);
1058 if (!isset ($ret[$ip_bin]))
1059 $ret[$ip_bin] = constructIPv4Address ($row['ip']);
1061 foreach (array ('rspool_id', 'rsport', 'rspool_name', 'inservice') as $cname)
1062 $tmp[$cname] = $row[$cname];
1063 $ret[$ip_bin]['rslist'][] = $tmp;
1067 // 5. add NAT rules, part 1
1071 "INET_NTOA(localip) as localip, " .
1073 "INET_NTOA(remoteip) as remoteip, " .
1076 "from PortForwarding " .
1077 "where ${whereexpr5a} " .
1078 "order by localip, localport, remoteip, remoteport, proto";
1079 $result = useSelectBlade ($query, __FUNCTION__
);
1080 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
1082 $remoteip_bin = ip2long ($row['remoteip']);
1083 if (!isset ($ret[$remoteip_bin]))
1084 $ret[$remoteip_bin] = constructIPv4Address ($row['remoteip']);
1085 $ret[$remoteip_bin]['inpf'][] = $row;
1088 // 5. add NAT rules, part 2
1092 "INET_NTOA(localip) as localip, " .
1094 "INET_NTOA(remoteip) as remoteip, " .
1097 "from PortForwarding " .
1098 "where ${whereexpr5b} " .
1099 "order by localip, localport, remoteip, remoteport, proto";
1100 $result = useSelectBlade ($query, __FUNCTION__
);
1101 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
1103 $localip_bin = ip2long ($row['localip']);
1104 if (!isset ($ret[$localip_bin]))
1105 $ret[$localip_bin] = constructIPv4Address ($row['localip']);
1106 $ret[$localip_bin]['outpf'][] = $row;
1112 // Return summary data about an IPv4 prefix, if it exists, or NULL otherwise.
1113 function getIPv4NetworkInfo ($id = 0)
1117 showError ('Invalid arg', __FUNCTION__
);
1120 $query = "select INET_NTOA(ip) as ip, mask, name ".
1121 "from IPRanges where id = $id";
1122 $result = useSelectBlade ($query, __FUNCTION__
);
1123 $ret = $result->fetch (PDO
::FETCH_ASSOC
);
1128 $ret['ip_bin'] = ip2long ($ret['ip']);
1129 $ret['mask_bin'] = binMaskFromDec ($ret['mask']);
1130 $ret['mask_bin_inv'] = binInvMaskFromDec ($ret['mask']);
1131 $ret['db_first'] = sprintf ('%u', 0x00000000 +
$ret['ip_bin'] & $ret['mask_bin']);
1132 $ret['db_last'] = sprintf ('%u', 0x00000000 +
$ret['ip_bin'] |
($ret['mask_bin_inv']));
1133 $ret['parent_id'] = getIPv4AddressNetworkId ($ret['ip'], $ret['mask']);
1137 function getIPv4Address ($dottedquad = '')
1139 if ($dottedquad == '')
1141 showError ('Invalid arg', __FUNCTION__
);
1144 $i32 = ip2long ($dottedquad); // signed 32 bit
1145 $scanres = scanIPv4Space (array (array ('i32_first' => $i32, 'i32_last' => $i32)));
1146 if (!isset ($scanres[$i32]))
1147 //$scanres[$i32] = constructIPv4Address ($dottedquad); // XXX: this should be verified to not break things
1148 return constructIPv4Address ($dottedquad);
1149 markupIPv4AddrList ($scanres);
1150 return $scanres[$i32];
1153 function bindIpToObject ($ip = '', $object_id = 0, $name = '', $type = '')
1155 $result = useInsertBlade
1160 'ip' => "INET_ATON('$ip')",
1161 'object_id' => "'${object_id}'",
1162 'name' => "'${name}'",
1163 'type' => "'${type}'"
1166 return $result ?
'' : (__FUNCTION__
. '(): useInsertBlade() failed');
1169 function getIPv4NetworkList ($tagfilter = array(), $tfmode = 'any')
1171 $whereclause = getWhereClause ($tagfilter);
1173 "select distinct id ".
1174 "from IPRanges left join TagStorage on id = target_id and target_realm = 'ipv4net' " .
1175 "where true ${whereclause} order by ip";
1176 $result = useSelectBlade ($query, __FUNCTION__
);
1178 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
1179 $ret[$row['id']] = NULL;
1181 $keys = array_keys ($ret);
1182 foreach ($keys as $netid)
1184 $ret[$netid] = getIPv4NetworkInfo ($netid);
1185 if ($ret[$netid]['parent_id'] and !in_array ($ret[$netid]['parent_id'], $keys))
1187 $ret[$netid]['real_parent_id'] = $ret[$netid]['parent_id'];
1188 $ret[$netid]['parent_id'] = NULL;
1194 // Return the id of the smallest IPv4 network containing the given IPv4 address
1195 // or NULL, if nothing was found. When finding the covering network for
1196 // another network, it is important to filter out matched records with longer
1197 // masks (they aren't going to be the right pick).
1198 function getIPv4AddressNetworkId ($dottedquad, $masklen = 32)
1200 // N.B. To perform the same for IPv6 address and networks, some pre-requisites
1201 // are necessary and a different query. IPv6 addresses are 128 bit long, which
1202 // is too much for both PHP and MySQL data types. These values must be split
1203 // into 4 32-byte long parts (b_u32_0, b_u32_1, b_u32_2, b_u32_3).
1204 // Then each network must have its 128-bit netmask split same way and either
1205 // stored right in its record or JOINed from decoder and accessible as m_u32_0,
1206 // m_u32_1, m_u32_2, m_u32_3. After that the query to pick the smallest network
1207 // covering the given address would look as follows:
1208 // $query = 'select id from IPv6Network as n where ' .
1209 // "(${b_u32_0} & n.m_u32_0 = n.b_u32_0) and " .
1210 // "(${b_u32_1} & n.m_u32_1 = n.b_u32_1) and " .
1211 // "(${b_u32_2} & n.m_u32_2 = n.b_u32_2) and " .
1212 // "(${b_u32_3} & n.m_u32_3 = n.b_u32_3) and " .
1213 // "mask < ${masklen} " .
1214 // 'order by mask desc limit 1';
1216 $query = 'select id from IPRanges where ' .
1217 "inet_aton('${dottedquad}') & (4294967295 >> (32 - mask)) << (32 - mask) = ip " .
1218 "and mask < ${masklen} " .
1219 'order by mask desc limit 1';
1220 $result = useSelectBlade ($query, __FUNCTION__
);
1221 if ($row = $result->fetch (PDO
::FETCH_ASSOC
))
1226 function updateRange ($id=0, $name='')
1230 "update IPRanges set name='$name' where id='$id'";
1231 $result = $dbxlink->exec ($query);
1235 // This function is actually used not only to update, but also to create records,
1236 // that's why ON DUPLICATE KEY UPDATE was replaced by DELETE-INSERT pair
1237 // (MySQL 4.0 workaround).
1238 function updateAddress ($ip = 0, $name = '', $reserved = 'no')
1240 // DELETE may safely fail.
1241 $r = useDeleteBlade ('IPAddress', 'ip', "INET_ATON('${ip}')");
1242 // INSERT may appear not necessary.
1243 if ($name == '' and $reserved == 'no')
1245 if (useInsertBlade ('IPAddress', array ('name' => "'${name}'", 'reserved' => "'${reserved}'", 'ip' => "INET_ATON('${ip}')")))
1248 return __FUNCTION__
. '(): useInsertBlade() failed';
1251 function updateBond ($ip='', $object_id=0, $name='', $type='')
1256 "update IPBonds set name='$name', type='$type' where ip=INET_ATON('$ip') and object_id='$object_id'";
1257 $result = $dbxlink->exec ($query);
1261 function unbindIpFromObject ($ip='', $object_id=0)
1266 "delete from IPBonds where ip=INET_ATON('$ip') and object_id='$object_id'";
1267 $result = $dbxlink->exec ($query);
1271 // This function returns either all or one user account. Array key is user name.
1272 function getUserAccounts ($tagfilter = array(), $tfmode = 'any')
1274 $whereclause = getWhereClause ($tagfilter);
1276 'select user_id, user_name, user_password_hash, user_realname, user_enabled ' .
1277 'from UserAccount left join TagStorage ' .
1278 "on UserAccount.user_id = TagStorage.target_id and target_realm = 'user' " .
1279 "where true ${whereclause} " .
1280 'order by user_name';
1281 $result = useSelectBlade ($query, __FUNCTION__
);
1283 $clist = array ('user_id', 'user_name', 'user_realname', 'user_password_hash', 'user_enabled');
1284 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
1285 foreach ($clist as $cname)
1286 $ret[$row['user_name']][$cname] = $row[$cname];
1287 $result->closeCursor();
1291 function searchByl2address ($l2addr)
1293 $l2addr = l2addressForDatabase ($l2addr);
1294 $query = "select object_id, Port.id as port_id from RackObject as ro inner join Port on ro.id = Port.object_id " .
1295 "where l2address = ${l2addr}";
1296 $result = useSelectBlade ($query, __FUNCTION__
);
1297 $rows = $result->fetchAll (PDO
::FETCH_ASSOC
);
1298 $result->closeCursor();
1299 if (count ($rows) == 0) // No results.
1301 if (count ($rows) == 1) // Target found.
1303 showError ('More than one results was found. This is probably a broken unique key.', __FUNCTION__
);
1307 function getIPv4PrefixSearchResult ($terms)
1309 $query = "select id, inet_ntoa(ip) as ip, mask, name from IPRanges where ";
1311 foreach (explode (' ', $terms) as $term)
1313 $query .= $or . "name like '%${term}%'";
1316 $result = useSelectBlade ($query, __FUNCTION__
);
1318 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
1323 function getIPv4AddressSearchResult ($terms)
1325 $query = "select inet_ntoa(ip) as ip, name from IPAddress where ";
1327 foreach (explode (' ', $terms) as $term)
1329 $query .= $or . "name like '%${term}%'";
1332 $result = useSelectBlade ($query, __FUNCTION__
);
1334 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
1339 function getIPv4RSPoolSearchResult ($terms)
1341 $query = "select id as pool_id, name from IPRSPool where ";
1343 foreach (explode (' ', $terms) as $term)
1345 $query .= $or . "name like '%${term}%'";
1348 $result = useSelectBlade ($query, __FUNCTION__
);
1350 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
1355 function getIPv4VServiceSearchResult ($terms)
1357 $query = "select id, inet_ntoa(vip) as vip, vport, proto, name from IPVirtualService where ";
1359 foreach (explode (' ', $terms) as $term)
1361 $query .= $or . "name like '%${term}%'";
1364 $result = useSelectBlade ($query, __FUNCTION__
);
1366 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
1371 function getAccountSearchResult ($terms)
1373 $byUsername = getSearchResultByField
1376 array ('user_id', 'user_name', 'user_realname'),
1381 $byRealname = getSearchResultByField
1384 array ('user_id', 'user_name', 'user_realname'),
1389 // Filter out dupes.
1390 foreach ($byUsername as $res1)
1391 foreach (array_keys ($byRealname) as $key2)
1392 if ($res1['user_id'] == $byRealname[$key2]['user_id'])
1394 unset ($byRealname[$key2]);
1397 return array_merge ($byUsername, $byRealname);
1400 function getSearchResultByField ($tname, $rcolumns, $scolumn, $terms, $ocolumn = '')
1404 foreach ($rcolumns as $col)
1406 $query .= $pfx . $col;
1410 $query .= " from ${tname} where ";
1411 foreach (explode (' ', $terms) as $term)
1413 $query .= $pfx . "${scolumn} like '%${term}%'";
1417 $query .= " order by ${ocolumn}";
1418 $result = useSelectBlade ($query, __FUNCTION__
);
1420 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
1425 // This function returns either port ID or NULL for specified arguments.
1426 function getPortID ($object_id, $port_name)
1428 $query = "select id from Port where object_id=${object_id} and name='${port_name}' limit 2";
1429 $result = useSelectBlade ($query, __FUNCTION__
);
1430 $rows = $result->fetchAll (PDO
::FETCH_NUM
);
1431 if (count ($rows) != 1)
1434 $result->closeCursor();
1438 function commitCreateUserAccount ($username, $realname, $password)
1440 return useInsertBlade
1445 'user_name' => "'${username}'",
1446 'user_realname' => "'${realname}'",
1447 'user_password_hash' => "'${password}'"
1452 function commitUpdateUserAccount ($id, $new_username, $new_realname, $new_password)
1456 "update UserAccount set user_name = '${new_username}', user_realname = '${new_realname}', " .
1457 "user_password_hash = '${new_password}' where user_id = ${id} limit 1";
1458 $result = $dbxlink->query ($query);
1459 if ($result == NULL)
1461 showError ('SQL query failed', __FUNCTION__
);
1467 function commitEnableUserAccount ($id, $new_enabled_value)
1471 "update UserAccount set user_enabled = '${new_enabled_value}' " .
1472 "where user_id = ${id} limit 1";
1473 $result = $dbxlink->query ($query);
1474 if ($result == NULL)
1476 showError ('SQL query failed', __FUNCTION__
);
1482 // This function returns an array of all port type pairs from PortCompat table.
1483 function getPortCompat ()
1486 "select type1, type2, d1.dict_value as type1name, d2.dict_value as type2name from " .
1487 "PortCompat as pc inner join Dictionary as d1 on pc.type1 = d1.dict_key " .
1488 "inner join Dictionary as d2 on pc.type2 = d2.dict_key " .
1489 "inner join Chapter as c1 on d1.chapter_no = c1.chapter_no " .
1490 "inner join Chapter as c2 on d2.chapter_no = c2.chapter_no " .
1491 "where c1.chapter_name = 'PortType' and c2.chapter_name = 'PortType'";
1492 $result = useSelectBlade ($query, __FUNCTION__
);
1493 $ret = $result->fetchAll (PDO
::FETCH_ASSOC
);
1494 $result->closeCursor();
1498 function removePortCompat ($type1 = 0, $type2 = 0)
1501 if ($type1 == 0 or $type2 == 0)
1503 showError ('Invalid arguments', __FUNCTION__
);
1506 $query = "delete from PortCompat where type1 = ${type1} and type2 = ${type2} limit 1";
1507 $result = $dbxlink->query ($query);
1508 if ($result == NULL)
1510 showError ('SQL query failed', __FUNCTION__
);
1516 function addPortCompat ($type1 = 0, $type2 = 0)
1518 if ($type1 <= 0 or $type2 <= 0)
1520 showError ('Invalid arguments', __FUNCTION__
);
1523 return useInsertBlade
1526 array ('type1' => $type1, 'type2' => $type2)
1530 // This function returns the dictionary as an array of trees, each tree
1531 // representing a single chapter. Each element has 'id', 'name', 'sticky'
1532 // and 'word' keys with the latter holding all the words within the chapter.
1533 function getDict ($parse_links = FALSE)
1536 "select chapter_name, Chapter.chapter_no, dict_key, dict_value, sticky from " .
1537 "Chapter natural left join Dictionary order by chapter_name, dict_value";
1538 $result = useSelectBlade ($query1, __FUNCTION__
);
1540 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
1542 $chapter_no = $row['chapter_no'];
1543 if (!isset ($dict[$chapter_no]))
1545 $dict[$chapter_no]['no'] = $chapter_no;
1546 $dict[$chapter_no]['name'] = $row['chapter_name'];
1547 $dict[$chapter_no]['sticky'] = $row['sticky'] == 'yes' ?
TRUE : FALSE;
1548 $dict[$chapter_no]['word'] = array();
1550 if ($row['dict_key'] != NULL)
1552 $dict[$chapter_no]['word'][$row['dict_key']] = $parse_links ?
1553 parseWikiLink ($row['dict_value'], 'a') : $row['dict_value'];
1554 $dict[$chapter_no]['refcnt'][$row['dict_key']] = 0;
1557 $result->closeCursor();
1559 // Find the list of all assigned values of dictionary-addressed attributes, each with
1560 // chapter/word keyed reference counters. Use the structure to adjust reference counters
1561 // of the returned disctionary words.
1562 $query2 = "select a.attr_id, am.chapter_no, uint_value, count(object_id) as refcnt " .
1563 "from Attribute as a inner join AttributeMap as am on a.attr_id = am.attr_id " .
1564 "inner join AttributeValue as av on a.attr_id = av.attr_id " .
1565 "inner join Dictionary as d on am.chapter_no = d.chapter_no and av.uint_value = d.dict_key " .
1566 "where attr_type = 'dict' group by a.attr_id, am.chapter_no, uint_value " .
1567 "order by a.attr_id, am.chapter_no, uint_value";
1568 $result = useSelectBlade ($query2, __FUNCTION__
);
1569 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
1570 $dict[$row['chapter_no']]['refcnt'][$row['uint_value']] = $row['refcnt'];
1571 $result->closeCursor();
1575 function getDictStats ()
1577 $stock_chapters = array (1, 2, 3, 11, 12, 13, 14, 16, 17, 18, 19, 20, 21, 22, 23);
1579 "select Chapter.chapter_no, chapter_name, count(dict_key) as wc from " .
1580 "Chapter natural left join Dictionary group by Chapter.chapter_no";
1581 $result = useSelectBlade ($query, __FUNCTION__
);
1582 $tc = $tw = $uc = $uw = 0;
1583 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
1587 if (in_array ($row['chapter_no'], $stock_chapters))
1592 $result->closeCursor();
1594 $query = "select count(attr_id) as attrc from RackObject as ro left join " .
1595 "AttributeValue as av on ro.id = av.object_id group by ro.id";
1596 $result = useSelectBlade ($query, __FUNCTION__
);
1597 $to = $ta = $so = 0;
1598 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
1601 if ($row['attrc'] != 0)
1604 $ta +
= $row['attrc'];
1607 $result->closeCursor();
1609 $ret['Total chapters in dictionary'] = $tc;
1610 $ret['Total words in dictionary'] = $tw;
1611 $ret['User chapters'] = $uc;
1612 $ret['Words in user chapters'] = $uw;
1613 $ret['Total objects'] = $to;
1614 $ret['Objects with stickers'] = $so;
1615 $ret['Total stickers attached'] = $ta;
1619 function getIPv4Stats ()
1623 $subject[] = array ('q' => 'select count(id) from IPRanges', 'txt' => 'Networks');
1624 $subject[] = array ('q' => 'select count(ip) from IPAddress', 'txt' => 'Addresses commented/reserved');
1625 $subject[] = array ('q' => 'select count(ip) from IPBonds', 'txt' => 'Addresses allocated');
1626 $subject[] = array ('q' => 'select count(*) from PortForwarding', 'txt' => 'NAT rules');
1627 $subject[] = array ('q' => 'select count(id) from IPVirtualService', 'txt' => 'Virtual services');
1628 $subject[] = array ('q' => 'select count(id) from IPRSPool', 'txt' => 'Real server pools');
1629 $subject[] = array ('q' => 'select count(id) from IPRealServer', 'txt' => 'Real servers');
1630 $subject[] = array ('q' => 'select count(distinct object_id) from IPLoadBalancer', 'txt' => 'Load balancers');
1632 foreach ($subject as $item)
1634 $result = useSelectBlade ($item['q'], __FUNCTION__
);
1635 $row = $result->fetch (PDO
::FETCH_NUM
);
1636 $ret[$item['txt']] = $row[0];
1637 $result->closeCursor();
1643 function getRackspaceStats ()
1647 $subject[] = array ('q' => 'select count(*) from Dictionary where chapter_no = 3', 'txt' => 'Rack rows');
1648 $subject[] = array ('q' => 'select count(*) from Rack', 'txt' => 'Racks');
1649 $subject[] = array ('q' => 'select avg(height) from Rack', 'txt' => 'Average rack height');
1650 $subject[] = array ('q' => 'select sum(height) from Rack', 'txt' => 'Total rack units in field');
1652 foreach ($subject as $item)
1654 $result = useSelectBlade ($item['q'], __FUNCTION__
);
1655 $row = $result->fetch (PDO
::FETCH_NUM
);
1656 $ret[$item['txt']] = empty ($row[0]) ?
0 : $row[0];
1657 $result->closeCursor();
1663 function renderTagStats ()
1665 global $taglist, $root;
1666 $query = "select id, tag, count(tag_id) as refcnt from " .
1667 "TagTree inner join TagStorage on TagTree.id = TagStorage.tag_id " .
1668 "group by tag_id order by refcnt desc limit 50";
1669 // The same data is already present in pre-loaded tag list, but not in
1670 // the form we need. So let's ask the DB server for cooked top list and
1671 // use the cooked tag list to break it down.
1672 $result = useSelectBlade ($query, __FUNCTION__
);
1673 $refc = $result->fetchAll (PDO
::FETCH_ASSOC
);
1674 echo '<table border=1><tr><th>tag</th><th>total</th><th>objects</th><th>IPv4 nets</th><th>racks</th>';
1675 echo '<th>IPv4 VS</th><th>IPv4 RS pools</th><th>users</th></tr>';
1676 $pagebyrealm = array
1678 'object' => 'objgroup&group_id=0',
1679 'ipv4net' => 'ipv4space&tab=default',
1680 'rack' => 'rackspace&tab=default',
1681 'ipv4vs' => 'ipv4vslist&tab=default',
1682 'ipv4rspool' => 'ipv4rsplist&tab=default',
1683 'user' => 'userlist&tab=default'
1685 foreach ($refc as $ref)
1687 echo "<tr><td>${ref['tag']}</td><td>${ref['refcnt']}</td>";
1688 foreach (array ('object', 'ipv4net', 'rack', 'ipv4vs', 'ipv4rspool', 'user') as $realm)
1691 if (!isset ($taglist[$ref['id']]['refcnt'][$realm]))
1695 echo "<a href='${root}?page=" . $pagebyrealm[$realm] . "&tagfilter[]=${ref['id']}'>";
1696 echo $taglist[$ref['id']]['refcnt'][$realm] . '</a>';
1707 The following allows figuring out records in TagStorage, which refer to non-existing entities:
1709 mysql> select target_id from TagStorage left join IPRanges on target_id = id where target_realm = 'ipv4net' and id is null;
1710 mysql> select target_id from TagStorage left join RackObject on target_id = id where target_realm = 'object' and id is null;
1711 mysql> select target_id from TagStorage left join Rack on target_id = id where target_realm = 'rack' and id is null;
1712 mysql> select target_id from TagStorage left join IPVirtualService on target_id = id where target_realm = 'ipv4vs' and id is null;
1713 mysql> select target_id from TagStorage left join IPRSPool on target_id = id where target_realm = 'ipv4rspool' and id is null;
1714 mysql> select target_id from TagStorage left join UserAccount on target_id = user_id where target_realm = 'user' and user_id is null;
1716 Accordingly, these are the records, which refer to non-existent tags:
1718 mysql> select tag_id from TagStorage left join TagTree on tag_id = id where id is null;
1722 function commitUpdateDictionary ($chapter_no = 0, $dict_key = 0, $dict_value = '')
1724 if ($chapter_no <= 0 or $dict_key <= 0 or empty ($dict_value))
1726 showError ('Invalid args', __FUNCTION__
);
1731 "update Dictionary set dict_value = '${dict_value}' where chapter_no=${chapter_no} " .
1732 "and dict_key=${dict_key} limit 1";
1733 $result = $dbxlink->query ($query);
1734 if ($result == NULL)
1736 showError ('SQL query failed', __FUNCTION__
);
1742 function commitSupplementDictionary ($chapter_no = 0, $dict_value = '')
1744 if ($chapter_no <= 0 or empty ($dict_value))
1746 showError ('Invalid args', __FUNCTION__
);
1749 return useInsertBlade
1752 array ('chapter_no' => $chapter_no, 'dict_value' => "'${dict_value}'")
1756 function commitReduceDictionary ($chapter_no = 0, $dict_key = 0)
1758 if ($chapter_no <= 0 or $dict_key <= 0)
1760 showError ('Invalid args', __FUNCTION__
);
1765 "delete from Dictionary where chapter_no=${chapter_no} " .
1766 "and dict_key=${dict_key} limit 1";
1767 $result = $dbxlink->query ($query);
1768 if ($result == NULL)
1770 showError ('SQL query failed', __FUNCTION__
);
1776 function commitAddChapter ($chapter_name = '')
1778 if (empty ($chapter_name))
1780 showError ('Invalid args', __FUNCTION__
);
1783 return useInsertBlade
1786 array ('chapter_name' => "'${chapter_name}'")
1790 function commitUpdateChapter ($chapter_no = 0, $chapter_name = '')
1792 if ($chapter_no <= 0 or empty ($chapter_name))
1794 showError ('Invalid args', __FUNCTION__
);
1799 "update Chapter set chapter_name = '${chapter_name}' where chapter_no = ${chapter_no} " .
1800 "and sticky = 'no' limit 1";
1801 $result = $dbxlink->query ($query);
1802 if ($result == NULL)
1804 showError ('SQL query failed', __FUNCTION__
);
1810 function commitDeleteChapter ($chapter_no = 0)
1812 if ($chapter_no <= 0)
1814 showError ('Invalid args', __FUNCTION__
);
1819 "delete from Chapter where chapter_no = ${chapter_no} and sticky = 'no' limit 1";
1820 $result = $dbxlink->query ($query);
1821 if ($result == NULL)
1823 showError ('SQL query failed', __FUNCTION__
);
1829 // This is a dictionary accessor. We perform link rendering, so the user sees
1830 // nice <select> drop-downs.
1831 function readChapter ($chapter_name = '')
1833 if (empty ($chapter_name))
1835 showError ('invalid argument', __FUNCTION__
);
1839 "select dict_key, dict_value from Dictionary natural join Chapter " .
1840 "where chapter_name = '${chapter_name}'";
1841 $result = useSelectBlade ($query, __FUNCTION__
);
1843 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
1844 $chapter[$row['dict_key']] = parseWikiLink ($row['dict_value'], 'o');
1845 $result->closeCursor();
1846 // SQL ORDER BY had no sense, because we need to sort after link rendering, not before.
1851 function getAttrMap ()
1854 "select a.attr_id, a.attr_type, a.attr_name, am.objtype_id, " .
1855 "d.dict_value as objtype_name, am.chapter_no, c2.chapter_name from " .
1856 "Attribute as a natural left join AttributeMap as am " .
1857 "left join Dictionary as d on am.objtype_id = d.dict_key " .
1858 "left join Chapter as c1 on d.chapter_no = c1.chapter_no " .
1859 "left join Chapter as c2 on am.chapter_no = c2.chapter_no " .
1860 "where c1.chapter_name = 'RackObjectType' or c1.chapter_name is null " .
1861 "order by attr_name";
1862 $result = useSelectBlade ($query, __FUNCTION__
);
1864 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
1866 $attr_id = $row['attr_id'];
1867 if (!isset ($ret[$attr_id]))
1869 $ret[$attr_id]['id'] = $attr_id;
1870 $ret[$attr_id]['type'] = $row['attr_type'];
1871 $ret[$attr_id]['name'] = $row['attr_name'];
1872 $ret[$attr_id]['application'] = array();
1874 if ($row['objtype_id'] == '')
1876 $application['objtype_id'] = $row['objtype_id'];
1877 $application['objtype_name'] = $row['objtype_name'];
1878 if ($row['attr_type'] == 'dict')
1880 $application['chapter_no'] = $row['chapter_no'];
1881 $application['chapter_name'] = $row['chapter_name'];
1883 $ret[$attr_id]['application'][] = $application;
1885 $result->closeCursor();
1889 function commitUpdateAttribute ($attr_id = 0, $attr_name = '')
1891 if ($attr_id <= 0 or empty ($attr_name))
1893 showError ('Invalid args', __FUNCTION__
);
1898 "update Attribute set attr_name = '${attr_name}' " .
1899 "where attr_id = ${attr_id} limit 1";
1900 $result = $dbxlink->query ($query);
1901 if ($result == NULL)
1903 showError ("SQL query '${query}' failed", __FUNCTION__
);
1909 function commitAddAttribute ($attr_name = '', $attr_type = '')
1911 if (empty ($attr_name))
1913 showError ('Invalid args', __FUNCTION__
);
1924 showError ('Invalid args', __FUNCTION__
);
1927 return useInsertBlade
1930 array ('attr_name' => "'${attr_name}'", 'attr_type' => "'${attr_type}'")
1934 function commitDeleteAttribute ($attr_id = 0)
1938 showError ('Invalid args', __FUNCTION__
);
1941 return useDeleteBlade ('Attribute', 'attr_id', $attr_id);
1944 // FIXME: don't store garbage in chapter_no for non-dictionary types.
1945 function commitSupplementAttrMap ($attr_id = 0, $objtype_id = 0, $chapter_no = 0)
1947 if ($attr_id <= 0 or $objtype_id <= 0 or $chapter_no <= 0)
1949 showError ('Invalid args', __FUNCTION__
);
1952 return useInsertBlade
1957 'attr_id' => $attr_id,
1958 'objtype_id' => $objtype_id,
1959 'chapter_no' => $chapter_no
1964 function commitReduceAttrMap ($attr_id = 0, $objtype_id)
1966 if ($attr_id <= 0 or $objtype_id <= 0)
1968 showError ('Invalid args', __FUNCTION__
);
1973 "delete from AttributeMap where attr_id=${attr_id} " .
1974 "and objtype_id=${objtype_id} limit 1";
1975 $result = $dbxlink->query ($query);
1976 if ($result == NULL)
1978 showError ('SQL query failed', __FUNCTION__
);
1984 // This function returns all optional attributes for requested object
1985 // as an array of records. NULL is returned on error and empty array
1986 // is returned, if there are no attributes found.
1987 function getAttrValues ($object_id, $strip_optgroup = FALSE)
1989 if ($object_id <= 0)
1991 showError ('Invalid argument', __FUNCTION__
);
1996 "select A.attr_id, A.attr_name, A.attr_type, C.chapter_name, " .
1997 "AV.uint_value, AV.float_value, AV.string_value, D.dict_value from " .
1998 "RackObject as RO inner join AttributeMap as AM on RO.objtype_id = AM.objtype_id " .
1999 "inner join Attribute as A using (attr_id) " .
2000 "left join AttributeValue as AV on AV.attr_id = AM.attr_id and AV.object_id = RO.id " .
2001 "left join Dictionary as D on D.dict_key = AV.uint_value and AM.chapter_no = D.chapter_no " .
2002 "left join Chapter as C on AM.chapter_no = C.chapter_no " .
2003 "where RO.id = ${object_id} order by A.attr_type, A.attr_name";
2004 $result = useSelectBlade ($query, __FUNCTION__
);
2005 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
2008 $record['id'] = $row['attr_id'];
2009 $record['name'] = $row['attr_name'];
2010 $record['type'] = $row['attr_type'];
2011 switch ($row['attr_type'])
2016 $record['value'] = $row[$row['attr_type'] . '_value'];
2017 $record['a_value'] = parseWikiLink ($record['value'], 'a');
2020 $record['value'] = parseWikiLink ($row[$row['attr_type'] . '_value'], 'o', $strip_optgroup);
2021 $record['a_value'] = parseWikiLink ($row[$row['attr_type'] . '_value'], 'a', $strip_optgroup);
2022 $record['chapter_name'] = $row['chapter_name'];
2023 $record['key'] = $row['uint_value'];
2026 $record['value'] = NULL;
2029 $ret[$row['attr_id']] = $record;
2031 $result->closeCursor();
2035 function commitResetAttrValue ($object_id = 0, $attr_id = 0)
2037 if ($object_id <= 0 or $attr_id <= 0)
2039 showError ('Invalid arguments', __FUNCTION__
);
2043 $query = "delete from AttributeValue where object_id = ${object_id} and attr_id = ${attr_id} limit 1";
2044 $result = $dbxlink->query ($query);
2045 if ($result == NULL)
2047 showError ('SQL query failed', __FUNCTION__
);
2053 // FIXME: don't share common code with use commitResetAttrValue()
2054 function commitUpdateAttrValue ($object_id = 0, $attr_id = 0, $value = '')
2056 if ($object_id <= 0 or $attr_id <= 0)
2058 showError ('Invalid arguments', __FUNCTION__
);
2062 return commitResetAttrValue ($object_id, $attr_id);
2064 $query1 = "select attr_type from Attribute where attr_id = ${attr_id}";
2065 $result = $dbxlink->query ($query1);
2066 if ($result == NULL)
2068 showError ('SQL query #1 failed', __FUNCTION__
);
2071 $row = $result->fetch (PDO
::FETCH_NUM
);
2074 showError ('SQL query #1 returned no results', __FUNCTION__
);
2077 $attr_type = $row[0];
2078 $result->closeCursor();
2084 $column = $attr_type . '_value';
2087 $column = 'uint_value';
2090 showError ("Unknown attribute type '${attr_type}' met", __FUNCTION__
);
2094 "delete from AttributeValue where " .
2095 "object_id = ${object_id} and attr_id = ${attr_id} limit 1";
2096 $result = $dbxlink->query ($query2);
2097 if ($result == NULL)
2099 showError ('SQL query #2 failed', __FUNCTION__
);
2102 // We know $value isn't empty here.
2104 "insert into AttributeValue set ${column} = '${value}', " .
2105 "object_id = ${object_id}, attr_id = ${attr_id} ";
2106 $result = $dbxlink->query ($query3);
2107 if ($result == NULL)
2109 showError ('SQL query #3 failed', __FUNCTION__
);
2115 function commitUseupPort ($port_id = 0)
2119 showError ("Invalid argument", __FUNCTION__
);
2123 $query = "update Port set reservation_comment = NULL where id = ${port_id} limit 1";
2124 $result = $dbxlink->exec ($query);
2125 if ($result == NULL)
2127 showError ("SQL query failed", __FUNCTION__
);
2134 // This is a swiss-knife blade to insert a record into a table.
2135 // The first argument is table name.
2136 // The second argument is an array of "name" => "value" pairs.
2137 // The function returns either TRUE or FALSE (we expect one row
2139 function useInsertBlade ($tablename, $values)
2142 $namelist = $valuelist = '';
2143 foreach ($values as $name => $value)
2145 $namelist = $namelist . ($namelist == '' ?
"(${name}" : ", ${name}");
2146 $valuelist = $valuelist . ($valuelist == '' ?
"(${value}" : ", ${value}");
2148 $query = "insert into ${tablename} ${namelist}) values ${valuelist})";
2149 $result = $dbxlink->exec ($query);
2155 // This swiss-knife blade deletes one record from the specified table
2156 // using the specified key name and value.
2157 function useDeleteBlade ($tablename, $keyname, $keyvalue)
2160 return 1 === $dbxlink->exec ("delete from ${tablename} where ${keyname}=${keyvalue} limit 1");
2163 function useSelectBlade ($query, $caller = 'N/A')
2166 $result = $dbxlink->query ($query);
2167 if ($result == NULL)
2169 $ei = $dbxlink->errorInfo();
2170 showError ("SQL query '${query}'\n failed in useSelectBlade with error ${ei[1]} (${ei[2]})", $caller);
2176 function loadConfigCache ()
2178 $query = 'SELECT varname, varvalue, vartype, is_hidden, emptyok, description FROM Config ORDER BY varname';
2179 $result = useSelectBlade ($query, __FUNCTION__
);
2181 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
2182 $cache[$row['varname']] = $row;
2183 $result->closeCursor();
2187 // setConfigVar() is expected to perform all necessary filtering
2188 function storeConfigVar ($varname = NULL, $varvalue = NULL)
2191 if (empty ($varname) ||
$varvalue === NULL)
2193 showError ('Invalid arguments', __FUNCTION__
);
2196 $query = "update Config set varvalue='${varvalue}' where varname='${varname}' limit 1";
2197 $result = $dbxlink->query ($query);
2198 if ($result == NULL)
2200 showError ("SQL query '${query}' failed", __FUNCTION__
);
2203 $rc = $result->rowCount();
2204 $result->closeCursor();
2205 if ($rc == 0 or $rc == 1)
2207 showError ("Something went wrong for args '${varname}', '${varvalue}'", __FUNCTION__
);
2211 // Database version detector. Should behave corretly on any
2212 // working dataset a user might have.
2213 function getDatabaseVersion ()
2216 $query = "select varvalue from Config where varname = 'DB_VERSION' and vartype = 'string'";
2217 $result = $dbxlink->query ($query);
2218 if ($result == NULL)
2220 $errorInfo = $dbxlink->errorInfo();
2221 if ($errorInfo[0] == '42S02') // ER_NO_SUCH_TABLE
2223 die (__FUNCTION__
. ': SQL query #1 failed with error ' . $errorInfo[2]);
2225 $rows = $result->fetchAll (PDO
::FETCH_NUM
);
2226 if (count ($rows) != 1 ||
empty ($rows[0][0]))
2228 $result->closeCursor();
2229 die (__FUNCTION__
. ': Cannot guess database version. Config table is present, but DB_VERSION is missing or invalid. Giving up.');
2232 $result->closeCursor();
2236 // Return an array of virtual services. For each of them list real server pools
2237 // with their load balancers and other stats.
2238 function getSLBSummary ()
2240 $query = 'select vs.id as vsid, inet_ntoa(vip) as vip, vport, proto, vs.name, object_id, ' .
2241 'lb.rspool_id, pool.name as pool_name, count(rs.id) as rscount ' .
2242 'from IPVirtualService as vs inner join IPLoadBalancer as lb on vs.id = lb.vs_id ' .
2243 'inner join IPRSPool as pool on lb.rspool_id = pool.id ' .
2244 'left join IPRealServer as rs on rs.rspool_id = lb.rspool_id ' .
2245 'group by vs.id, object_id order by vs.vip, object_id';
2246 $result = useSelectBlade ($query, __FUNCTION__
);
2248 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
2250 $vsid = $row['vsid'];
2251 $object_id = $row['object_id'];
2252 if (!isset ($ret[$vsid]))
2254 $ret[$vsid] = array();
2255 foreach (array ('vip', 'vport', 'proto', 'name') as $cname)
2256 $ret[$vsid][$cname] = $row[$cname];
2257 $ret[$vsid]['lblist'] = array();
2259 // There's only one assigned RS pool possible for each LB-VS combination.
2260 $ret[$vsid]['lblist'][$row['object_id']] = array
2262 'id' => $row['rspool_id'],
2263 'size' => $row['rscount'],
2264 'name' => $row['pool_name']
2267 $result->closeCursor();
2271 // Get the detailed composition of a particular virtual service, namely the list
2272 // of all pools, each shown with the list of objects servicing it. VS/RS configs
2273 // will be returned as well.
2274 function getVServiceInfo ($vsid = 0)
2276 $query1 = "select inet_ntoa(vip) as vip, vport, proto, name, vsconfig, rsconfig " .
2277 "from IPVirtualService where id = ${vsid}";
2278 $result = useSelectBlade ($query1, __FUNCTION__
);
2280 $row = $result->fetch (PDO
::FETCH_ASSOC
);
2283 foreach (array ('vip', 'vport', 'proto', 'name', 'vsconfig', 'rsconfig') as $cname)
2284 $vsinfo[$cname] = $row[$cname];
2285 $vsinfo['rspool'] = array();
2286 $result->closeCursor();
2288 $query2 = "select pool.id, name, pool.vsconfig, pool.rsconfig, object_id, " .
2289 "lb.vsconfig as lb_vsconfig, lb.rsconfig as lb_rsconfig from " .
2290 "IPRSPool as pool left join IPLoadBalancer as lb on pool.id = lb.rspool_id " .
2291 "where vs_id = ${vsid} order by pool.name, object_id";
2292 $result = useSelectBlade ($query2, __FUNCTION__
);
2293 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
2295 if (!isset ($vsinfo['rspool'][$row['id']]))
2297 $vsinfo['rspool'][$row['id']]['name'] = $row['name'];
2298 $vsinfo['rspool'][$row['id']]['vsconfig'] = $row['vsconfig'];
2299 $vsinfo['rspool'][$row['id']]['rsconfig'] = $row['rsconfig'];
2300 $vsinfo['rspool'][$row['id']]['lblist'] = array();
2302 if ($row['object_id'] == NULL)
2304 $vsinfo['rspool'][$row['id']]['lblist'][$row['object_id']] = array
2306 'vsconfig' => $row['lb_vsconfig'],
2307 'rsconfig' => $row['lb_rsconfig']
2310 $result->closeCursor();
2314 // Collect and return the following info about the given real server pool:
2315 // basic information
2316 // parent virtual service information
2317 // load balancers list (each with a list of VSes)
2318 // real servers list
2320 function getRSPoolInfo ($id = 0)
2322 $query1 = "select id, name, vsconfig, rsconfig from " .
2323 "IPRSPool where id = ${id}";
2324 $result = useSelectBlade ($query1, __FUNCTION__
);
2326 $row = $result->fetch (PDO
::FETCH_ASSOC
);
2329 foreach (array ('id', 'name', 'vsconfig', 'rsconfig') as $c)
2330 $ret[$c] = $row[$c];
2331 $result->closeCursor();
2333 $ret['lblist'] = array();
2334 $ret['rslist'] = array();
2335 $query2 = "select object_id, vs_id, vsconfig, rsconfig from IPLoadBalancer " .
2336 "where rspool_id = ${id} order by object_id, vs_id";
2337 $result = useSelectBlade ($query2, __FUNCTION__
);
2338 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
2339 foreach (array ('vsconfig', 'rsconfig') as $c)
2340 $ret['lblist'][$row['object_id']][$row['vs_id']][$c] = $row[$c];
2341 $result->closeCursor();
2343 $query3 = "select id, inservice, inet_ntoa(rsip) as rsip, rsport, rsconfig from " .
2344 "IPRealServer where rspool_id = ${id} order by IPRealServer.rsip, rsport";
2345 $result = useSelectBlade ($query3, __FUNCTION__
);
2346 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
2347 foreach (array ('inservice', 'rsip', 'rsport', 'rsconfig') as $c)
2348 $ret['rslist'][$row['id']][$c] = $row[$c];
2349 $result->closeCursor();
2353 function addRStoRSPool ($pool_id = 0, $rsip = '', $rsport = 0, $inservice = 'no', $rsconfig = '')
2357 showError ('Invalid arguments', __FUNCTION__
);
2360 if (empty ($rsport) or $rsport == 0)
2362 return useInsertBlade
2367 'rsip' => "inet_aton('${rsip}')",
2368 'rsport' => $rsport,
2369 'rspool_id' => $pool_id,
2370 'inservice' => ($inservice == 'yes' ?
"'yes'" : "'no'"),
2371 'rsconfig' => (empty ($rsconfig) ?
'NULL' : "'${rsconfig}'")
2376 function commitCreateVS ($vip = '', $vport = 0, $proto = '', $name = '', $vsconfig, $rsconfig, $taglist = array())
2378 if (empty ($vip) or $vport <= 0 or empty ($proto))
2379 return __FUNCTION__
. ': invalid arguments';
2385 'vip' => "inet_aton('${vip}')",
2387 'proto' => "'${proto}'",
2388 'name' => (empty ($name) ?
'NULL' : "'${name}'"),
2389 'vsconfig' => (empty ($vsconfig) ?
'NULL' : "'${vsconfig}'"),
2390 'rsconfig' => (empty ($rsconfig) ?
'NULL' : "'${rsconfig}'")
2393 return __FUNCTION__
. ': SQL insertion failed';
2394 return produceTagsForLastRecord ('ipv4vs', $taglist);
2397 function addLBtoRSPool ($pool_id = 0, $object_id = 0, $vs_id = 0, $vsconfig = '', $rsconfig = '')
2399 if ($pool_id <= 0 or $object_id <= 0 or $vs_id <= 0)
2401 showError ('Invalid arguments', __FUNCTION__
);
2404 return useInsertBlade
2409 'object_id' => $object_id,
2410 'rspool_id' => $pool_id,
2412 'vsconfig' => (empty ($vsconfig) ?
'NULL' : "'${vsconfig}'"),
2413 'rsconfig' => (empty ($rsconfig) ?
'NULL' : "'${rsconfig}'")
2418 function commitDeleteRS ($id = 0)
2422 return useDeleteBlade ('IPRealServer', 'id', $id);
2425 function commitDeleteVS ($id = 0)
2429 return useDeleteBlade ('IPVirtualService', 'id', $id) && destroyTagsForEntity ('ipv4vs', $id);
2432 function commitDeleteLB ($object_id = 0, $pool_id = 0, $vs_id = 0)
2435 if ($object_id <= 0 or $pool_id <= 0 or $vs_id <= 0)
2437 $query = "delete from IPLoadBalancer where object_id = ${object_id} and " .
2438 "rspool_id = ${pool_id} and vs_id = ${vs_id} limit 1";
2439 $result = $dbxlink->exec ($query);
2440 if ($result === NULL)
2442 elseif ($result != 1)
2448 function commitUpdateRS ($rsid = 0, $rsip = '', $rsport = 0, $rsconfig = '')
2452 showError ('Invalid args', __FUNCTION__
);
2455 if (long2ip (ip2long ($rsip)) !== $rsip)
2457 showError ("Invalid IP address '${rsip}'", __FUNCTION__
);
2460 if (empty ($rsport) or $rsport == 0)
2464 "update IPRealServer set rsip = inet_aton('${rsip}'), rsport = ${rsport}, rsconfig = " .
2465 (empty ($rsconfig) ?
'NULL' : "'${rsconfig}'") .
2466 " where id = ${rsid} limit 1";
2467 $result = $dbxlink->query ($query);
2468 if ($result == NULL)
2470 showError ("SQL query '${query}' failed", __FUNCTION__
);
2476 function commitUpdateLB ($object_id = 0, $pool_id = 0, $vs_id = 0, $vsconfig = '', $rsconfig = '')
2478 if ($object_id <= 0 or $pool_id <= 0 or $vs_id <= 0)
2480 showError ('Invalid args', __FUNCTION__
);
2485 "update IPLoadBalancer set vsconfig = " .
2486 (empty ($vsconfig) ?
'NULL' : "'${vsconfig}'") .
2488 (empty ($rsconfig) ?
'NULL' : "'${rsconfig}'") .
2489 " where object_id = ${object_id} and rspool_id = ${pool_id} " .
2490 "and vs_id = ${vs_id} limit 1";
2491 $result = $dbxlink->exec ($query);
2492 if ($result === NULL)
2498 function commitUpdateVS ($vsid = 0, $vip = '', $vport = 0, $proto = '', $name = '', $vsconfig = '', $rsconfig = '')
2500 if ($vsid <= 0 or empty ($vip) or $vport <= 0 or empty ($proto))
2502 showError ('Invalid args', __FUNCTION__
);
2506 $query = "update IPVirtualService set " .
2507 "vip = inet_aton('${vip}'), " .
2508 "vport = ${vport}, " .
2509 "proto = '${proto}', " .
2510 'name = ' . (empty ($name) ?
'NULL,' : "'${name}', ") .
2511 'vsconfig = ' . (empty ($vsconfig) ?
'NULL,' : "'${vsconfig}', ") .
2512 'rsconfig = ' . (empty ($rsconfig) ?
'NULL' : "'${rsconfig}'") .
2513 " where id = ${vsid} limit 1";
2514 $result = $dbxlink->exec ($query);
2515 if ($result === NULL)
2521 // Return the list of virtual services, indexed by vs_id.
2522 // Each record will be shown with its basic info plus RS pools counter.
2523 function getVSList ($tagfilter = array(), $tfmode = 'any')
2525 $whereclause = getWhereClause ($tagfilter);
2526 $query = "select vs.id, inet_ntoa(vip) as vip, vport, proto, vs.name, vs.vsconfig, vs.rsconfig, count(rspool_id) as poolcount " .
2527 "from IPVirtualService as vs left join IPLoadBalancer as lb on vs.id = lb.vs_id " .
2528 "left join TagStorage on vs.id = TagStorage.target_id and target_realm = 'ipv4vs' " .
2529 "where true ${whereclause} group by vs.id order by vs.vip, proto, vport";
2530 $result = useSelectBlade ($query, __FUNCTION__
);
2532 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
2533 foreach (array ('vip', 'vport', 'proto', 'name', 'vsconfig', 'rsconfig', 'poolcount') as $cname)
2534 $ret[$row['id']][$cname] = $row[$cname];
2535 $result->closeCursor();
2539 // Return the list of RS pool, indexed by pool id.
2540 function getRSPoolList ($tagfilter = array(), $tfmode = 'any')
2542 $whereclause = getWhereClause ($tagfilter);
2543 $query = "select pool.id, pool.name, count(rspool_id) as refcnt, pool.vsconfig, pool.rsconfig " .
2544 "from IPRSPool as pool left join IPLoadBalancer as lb on pool.id = lb.rspool_id " .
2545 "left join TagStorage on pool.id = TagStorage.target_id and target_realm = 'ipv4rspool' " .
2546 "where true ${whereclause} group by pool.id order by pool.name, pool.id";
2547 $result = useSelectBlade ($query, __FUNCTION__
);
2549 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
2550 foreach (array ('name', 'refcnt', 'vsconfig', 'rsconfig') as $cname)
2551 $ret[$row['id']][$cname] = $row[$cname];
2552 $result->closeCursor();
2556 function loadThumbCache ($rack_id = 0)
2559 $query = "select thumb_data from Rack where id = ${rack_id} and thumb_data is not null limit 1";
2560 $result = useSelectBlade ($query, __FUNCTION__
);
2561 $row = $result->fetch (PDO
::FETCH_ASSOC
);
2563 $ret = base64_decode ($row['thumb_data']);
2564 $result->closeCursor();
2568 function saveThumbCache ($rack_id = 0, $cache = NULL)
2571 if ($rack_id == 0 or $cache == NULL)
2573 showError ('Invalid arguments', __FUNCTION__
);
2576 $data = base64_encode ($cache);
2577 $query = "update Rack set thumb_data = '${data}' where id = ${rack_id} limit 1";
2578 $result = $dbxlink->exec ($query);
2581 function resetThumbCache ($rack_id = 0)
2586 showError ('Invalid argument', __FUNCTION__
);
2589 $query = "update Rack set thumb_data = NULL where id = ${rack_id} limit 1";
2590 $result = $dbxlink->exec ($query);
2593 // Return the list of attached RS pools for the given object. As long as we have
2594 // the LB-VS UNIQUE in IPLoadBalancer table, it is Ok to key returned records
2595 // by vs_id, because there will be only one RS pool listed for each VS of the
2597 function getRSPoolsForObject ($object_id = 0)
2599 if ($object_id <= 0)
2601 showError ('Invalid object_id', __FUNCTION__
);
2604 $query = 'select vs_id, inet_ntoa(vip) as vip, vport, proto, vs.name, pool.id as pool_id, ' .
2605 'pool.name as pool_name, count(rsip) as rscount, lb.vsconfig, lb.rsconfig from ' .
2606 'IPLoadBalancer as lb inner join IPRSPool as pool on lb.rspool_id = pool.id ' .
2607 'inner join IPVirtualService as vs on lb.vs_id = vs.id ' .
2608 'left join IPRealServer as rs on lb.rspool_id = rs.rspool_id ' .
2609 "where lb.object_id = ${object_id} " .
2610 'group by lb.rspool_id, lb.vs_id order by vs.vip, vport, proto, pool.name';
2611 $result = useSelectBlade ($query, __FUNCTION__
);
2613 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
2614 foreach (array ('vip', 'vport', 'proto', 'name', 'pool_id', 'pool_name', 'rscount', 'vsconfig', 'rsconfig') as $cname)
2615 $ret[$row['vs_id']][$cname] = $row[$cname];
2616 $result->closeCursor();
2620 function commitCreateRSPool ($name = '', $vsconfig = '', $rsconfig = '', $taglist = array())
2623 return __FUNCTION__
. ': invalid arguments';
2629 'name' => (empty ($name) ?
'NULL' : "'${name}'"),
2630 'vsconfig' => (empty ($vsconfig) ?
'NULL' : "'${vsconfig}'"),
2631 'rsconfig' => (empty ($rsconfig) ?
'NULL' : "'${rsconfig}'")
2634 return __FUNCTION__
. ': SQL insertion failed';
2635 return produceTagsForLastRecord ('ipv4rspool', $taglist);
2638 function commitDeleteRSPool ($pool_id = 0)
2643 return useDeleteBlade ('IPRSPool', 'id', $pool_id) && destroyTagsForEntity ('ipv4rspool', $pool_id);
2646 function commitUpdateRSPool ($pool_id = 0, $name = '', $vsconfig = '', $rsconfig = '')
2650 showError ('Invalid arg', __FUNCTION__
);
2654 $query = "update IPRSPool set " .
2655 'name = ' . (empty ($name) ?
'NULL,' : "'${name}', ") .
2656 'vsconfig = ' . (empty ($vsconfig) ?
'NULL,' : "'${vsconfig}', ") .
2657 'rsconfig = ' . (empty ($rsconfig) ?
'NULL' : "'${rsconfig}'") .
2658 " where id = ${pool_id} limit 1";
2659 $result = $dbxlink->exec ($query);
2660 if ($result === NULL)
2662 elseif ($result != 1)
2668 function getRSList ()
2670 $query = "select id, inservice, inet_ntoa(rsip) as rsip, rsport, rspool_id, rsconfig " .
2671 "from IPRealServer order by rspool_id, IPRealServer.rsip, rsport";
2672 $result = useSelectBlade ($query, __FUNCTION__
);
2674 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
2675 foreach (array ('inservice', 'rsip', 'rsport', 'rspool_id', 'rsconfig') as $cname)
2676 $ret[$row['id']][$cname] = $row[$cname];
2677 $result->closeCursor();
2681 // Return the list of all currently configured load balancers with their pool count.
2682 function getLBList ()
2684 $query = "select object_id, count(rspool_id) as poolcount " .
2685 "from IPLoadBalancer group by object_id order by object_id";
2686 $result = useSelectBlade ($query, __FUNCTION__
);
2688 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
2689 $ret[$row['object_id']] = $row['poolcount'];
2690 $result->closeCursor();
2694 // For the given object return: it vsconfig/rsconfig; the list of RS pools
2695 // attached (each with vsconfig/rsconfig in turn), each with the list of
2696 // virtual services terminating the pool. Each pool also lists all real
2697 // servers with rsconfig.
2698 function getSLBConfig ($object_id)
2700 if ($object_id <= 0)
2702 showError ('Invalid arg', __FUNCTION__
);
2706 $query = 'select vs_id, inet_ntoa(vip) as vip, vport, proto, vs.name as vs_name, ' .
2707 'vs.vsconfig as vs_vsconfig, vs.rsconfig as vs_rsconfig, ' .
2708 'lb.vsconfig as lb_vsconfig, lb.rsconfig as lb_rsconfig, pool.id as pool_id, pool.name as pool_name, ' .
2709 'pool.vsconfig as pool_vsconfig, pool.rsconfig as pool_rsconfig, ' .
2710 'rs.id as rs_id, inet_ntoa(rsip) as rsip, rsport, rs.rsconfig as rs_rsconfig from ' .
2711 'IPLoadBalancer as lb inner join IPRSPool as pool on lb.rspool_id = pool.id ' .
2712 'inner join IPVirtualService as vs on lb.vs_id = vs.id ' .
2713 'inner join IPRealServer as rs on lb.rspool_id = rs.rspool_id ' .
2714 "where lb.object_id = ${object_id} and rs.inservice = 'yes' " .
2715 "order by vs.vip, vport, proto, pool.name, rs.rsip, rs.rsport";
2716 $result = useSelectBlade ($query, __FUNCTION__
);
2717 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
2719 $vs_id = $row['vs_id'];
2720 if (!isset ($ret[$vs_id]))
2722 foreach (array ('vip', 'vport', 'proto', 'vs_name', 'vs_vsconfig', 'vs_rsconfig', 'lb_vsconfig', 'lb_rsconfig', 'pool_vsconfig', 'pool_rsconfig', 'pool_id', 'pool_name') as $c)
2723 $ret[$vs_id][$c] = $row[$c];
2724 $ret[$vs_id]['rslist'] = array();
2726 foreach (array ('rsip', 'rsport', 'rs_rsconfig') as $c)
2727 $ret[$vs_id]['rslist'][$row['rs_id']][$c] = $row[$c];
2729 $result->closeCursor();
2733 function commitSetInService ($rs_id = 0, $inservice = '')
2735 if ($rs_id <= 0 or empty ($inservice))
2737 showError ('Invalid args', __FUNCTION__
);
2741 $query = "update IPRealServer set inservice = '${inservice}' where id = ${rs_id} limit 1";
2742 $result = $dbxlink->exec ($query);
2743 if ($result === NULL)
2745 elseif ($result != 1)
2751 function executeAutoPorts ($object_id = 0, $type_id = 0)
2753 if ($object_id == 0 or $type_id == 0)
2755 showError ('Invalid arguments', __FUNCTION__
);
2759 foreach (getAutoPorts ($type_id) as $autoport)
2760 $ret = $ret and '' == commitAddPort ($object_id, $autoport['name'], $autoport['type'], '', '');
2764 // Return only implicitly listed tags, the rest of the chain will be
2765 // generated/deducted later at higher levels.
2766 // Result is a chain: randomly indexed taginfo list.
2767 function loadEntityTags ($entity_realm = '', $entity_id = 0)
2769 if ($entity_realm == '' or $entity_id <= 0)
2771 showError ('Invalid or missing arguments', __FUNCTION__
);
2775 $query = "select tt.id, tag from " .
2776 "TagStorage as ts inner join TagTree as tt on ts.tag_id = tt.id " .
2777 "where target_realm = '${entity_realm}' and target_id = ${entity_id} " .
2779 $result = useSelectBlade ($query, __FUNCTION__
);
2780 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
2781 $ret[$row['id']] = $row;
2782 $result->closeCursor();
2783 return getExplicitTagsOnly ($ret);
2786 function loadRackObjectTags ($id)
2788 return loadEntityTags ('object', $id);
2791 function loadIPv4PrefixTags ($id)
2793 return loadEntityTags ('ipv4net', $id);
2796 function loadRackTags ($id)
2798 return loadEntityTags ('rack', $id);
2801 function loadIPv4VSTags ($id)
2803 return loadEntityTags ('ipv4vs', $id);
2806 function loadIPv4RSPoolTags ($id)
2808 return loadEntityTags ('ipv4rspool', $id);
2811 function loadUserTags ($user_id)
2813 return loadEntityTags ('user', $user_id);
2816 // Return a tag chain with all DB tags on it.
2817 function getTagList ()
2820 $query = "select id, parent_id, tag, target_realm as realm, count(target_id) as refcnt " .
2821 "from TagTree left join TagStorage on id = tag_id " .
2822 "group by id, target_realm order by tag";
2823 $result = useSelectBlade ($query, __FUNCTION__
);
2824 $ci = 0; // Collation index. The resulting rows are ordered according to default collation,
2825 // which is utf8_general_ci for UTF-8.
2826 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
2828 if (!isset ($ret[$row['id']]))
2829 $ret[$row['id']] = array
2832 'tag' => $row['tag'],
2834 'parent_id' => $row['parent_id'],
2838 $ret[$row['id']]['refcnt'][$row['realm']] = $row['refcnt'];
2840 $result->closeCursor();
2844 function commitCreateTag ($tagname = '', $parent_id = 0)
2846 if ($tagname == '' or $parent_id === 0)
2847 return "Invalid args to " . __FUNCTION__
;
2848 $result = useInsertBlade
2853 'tag' => "'${tagname}'",
2854 'parent_id' => $parent_id
2860 return "SQL query failed in " . __FUNCTION__
;
2863 function commitDestroyTag ($tagid = 0)
2866 return 'Invalid arg to ' . __FUNCTION__
;
2867 if (useDeleteBlade ('TagTree', 'id', $tagid))
2870 return 'useDeleteBlade() failed in ' . __FUNCTION__
;
2873 function commitUpdateTag ($tag_id, $tag_name, $parent_id)
2875 if ($parent_id == 0)
2876 $parent_id = 'NULL';
2878 $query = "update TagTree set tag = '${tag_name}', parent_id = ${parent_id} " .
2879 "where id = ${tag_id} limit 1";
2880 $result = $dbxlink->exec ($query);
2881 if ($result === NULL)
2882 return 'SQL query failed in ' . __FUNCTION__
;
2886 // Drop the whole chain stored.
2887 function destroyTagsForEntity ($entity_realm, $entity_id)
2890 $query = "delete from TagStorage where target_realm = '${entity_realm}' and target_id = ${entity_id}";
2891 $result = $dbxlink->exec ($query);
2892 if ($result === NULL)
2898 // Drop only one record. This operation doesn't involve retossing other tags, unlike when adding.
2899 function deleteTagForEntity ($entity_realm, $entity_id, $tag_id)
2902 $query = "delete from TagStorage where target_realm = '${entity_realm}' and target_id = ${entity_id} and tag_id = ${tag_id}";
2903 $result = $dbxlink->exec ($query);
2904 if ($result === NULL)
2910 // Push a record into TagStorage unconditionally.
2911 function addTagForEntity ($realm = '', $entity_id, $tag_id)
2915 return useInsertBlade
2920 'target_realm' => "'${realm}'",
2921 'target_id' => $entity_id,
2922 'tag_id' => $tag_id,
2927 // Add records into TagStorage, if this makes sense (IOW, they don't appear
2928 // on the implicit list already). Then remove any other records, which
2929 // appear on the "implicit" side of the chain. This will make sure,
2930 // that both the tag base is still minimal and all requested tags appear on
2931 // the resulting tag chain.
2932 // Return TRUE, if any changes were committed.
2933 function rebuildTagChainForEntity ($realm, $entity_id, $extrachain = array())
2935 // Put the current explicit sub-chain into a buffer and merge all tags from
2936 // the extra chain, which aren't there yet.
2937 $newchain = $oldchain = loadEntityTags ($realm, $entity_id);
2938 foreach ($extrachain as $extratag)
2939 if (!tagOnChain ($extratag, $newchain))
2940 $newchain[] = $extratag;
2941 // Then minimize the working buffer and check if it differs from the original
2942 // chain we started with. If it is so, save the work and signal the upper layer.
2943 $newchain = getExplicitTagsOnly ($newchain);
2944 if (tagChainCmp ($oldchain, $newchain))
2946 destroyTagsForEntity ($realm, $entity_id);
2947 foreach ($newchain as $taginfo)
2948 addTagForEntity ($realm, $entity_id, $taginfo['id']);
2954 // Presume, that the target record has no tags attached.
2955 function produceTagsForLastRecord ($realm, $tagidlist, $last_insert_id = 0)
2957 if (!count ($tagidlist))
2959 if (!$last_insert_id)
2960 $last_insert_id = lastInsertID();
2962 foreach (getExplicitTagsOnly (buildTagChainFromIds ($tagidlist)) as $taginfo)
2963 if (addTagForEntity ($realm, $last_insert_id, $taginfo['id']) == FALSE)
2968 return "Experienced ${errcount} errors adding tags in realm '${realm}' for entity ID == ${last_insert_id}";
2971 function createIPv4Prefix ($range = '', $name = '', $is_bcast = FALSE, $taglist = array())
2973 // $range is in x.x.x.x/x format, split into ip/mask vars
2974 $rangeArray = explode('/', $range);
2975 if (count ($rangeArray) != 2)
2976 return "Invalid IPv4 prefix '${range}'";
2977 $ip = $rangeArray[0];
2978 $mask = $rangeArray[1];
2980 if (empty ($ip) or empty ($mask))
2981 return "Invalid IPv4 prefix '${range}'";
2982 $ipL = ip2long($ip);
2983 $maskL = ip2long($mask);
2984 if ($ipL == -1 ||
$ipL === FALSE)
2985 return 'Bad IPv4 address';
2986 if ($mask < 32 && $mask > 0)
2990 $maskB = decbin($maskL);
2991 if (strlen($maskB)!=32)
2992 return 'Invalid netmask';
2995 foreach( str_split ($maskB) as $digit)
3002 if ($zeroes == TRUE)
3003 return 'Invalid netmask';
3008 $binmask = binMaskFromDec($maskL);
3009 $ipL = $ipL & $binmask;
3010 $result = useInsertBlade
3015 'ip' => sprintf ('%u', $ipL),
3016 'mask' => "'${maskL}'",
3017 'name' => "'${name}'"
3021 if ($is_bcast and $maskL < 31)
3023 $network_addr = long2ip ($ipL);
3024 $broadcast_addr = long2ip ($ipL |
binInvMaskFromDec ($maskL));
3025 updateAddress ($network_addr, 'network', 'yes');
3026 updateAddress ($broadcast_addr, 'broadcast', 'yes');
3028 return produceTagsForLastRecord ('ipv4net', $taglist);
3031 // FIXME: This function doesn't wipe relevant records from IPAddress table.
3032 function destroyIPv4Prefix ($id = 0)
3035 return __FUNCTION__
. ': Invalid IPv4 prefix ID';
3036 if (!useDeleteBlade ('IPRanges', 'id', $id))
3037 return __FUNCTION__
. ': SQL query #1 failed';
3038 if (!destroyTagsForEntity ('ipv4net', $id))
3039 return __FUNCTION__
. ': SQL query #2 failed';
3043 function loadScript ($name)
3045 $result = useSelectBlade ("select script_text from Script where script_name = '${name}'");
3046 $row = $result->fetch (PDO
::FETCH_NUM
);
3053 function saveScript ($name, $text)
3057 showError ('Invalid argument');
3060 // delete regardless of existence
3061 useDeleteBlade ('Script', 'script_name', "'${name}'");
3062 return useInsertBlade
3067 'script_name' => "'${name}'",
3068 'script_text' => "'${text}'"
3073 function saveUserPassword ($user_id, $newp)
3075 $newhash = hash (PASSWORD_HASH
, $newp);
3076 $query = "update UserAccount set user_password_hash = ${newhash} where user_id = ${user_id} limit 1";
3079 function objectIsPortless ($id = 0)
3083 showError ('Invalid argument', __FUNCTION__
);
3086 if (($result = useSelectBlade ("select count(id) from Port where object_id = ${id}", __FUNCTION__
)) == NULL)
3088 showError ('SQL query failed', __FUNCTION__
);
3091 $row = $result->fetch (PDO
::FETCH_NUM
);
3093 $result->closeCursor();
3095 return $count === '0';
3098 function recordExists ($id = 0, $realm = 'object')
3104 'object' => 'RackObject',
3105 'ipv4net' => 'IPRanges',
3106 'user' => 'UserAccount',
3112 'user' => 'user_id',
3114 $query = 'select count(*) from ' . $table[$realm] . ' where ' . $idcol[$realm] . ' = ' . $id;
3115 if (($result = useSelectBlade ($query, __FUNCTION__
)) == NULL)
3117 showError ('SQL query failed', __FUNCTION__
);
3120 $row = $result->fetch (PDO
::FETCH_NUM
);
3122 $result->closeCursor();
3124 return $count === '1';
3127 function tagExistsInDatabase ($tname)
3129 $result = useSelectBlade ("select count(*) from TagTree where lower(tag) = lower('${tname}')");
3130 $row = $result->fetch (PDO
::FETCH_NUM
);
3132 $result->closeCursor();
3134 return $count !== '0';
3137 function newPortForwarding ($object_id, $localip, $localport, $remoteip, $remoteport, $proto, $description)
3139 if (NULL === getIPv4AddressNetworkId ($localip))
3140 return "$localip: Non existant ip";
3141 if (NULL === getIPv4AddressNetworkId ($localip))
3142 return "$remoteip: Non existant ip";
3143 if ( ($localport <= 0) or ($localport >= 65536) )
3144 return "$localport: invaild port";
3145 if ( ($remoteport <= 0) or ($remoteport >= 65536) )
3146 return "$remoteport: invaild port";
3148 $result = useInsertBlade
3153 'object_id' => $object_id,
3154 'localip' => "INET_ATON('${localip}')",
3155 'remoteip' => "INET_ATON('$remoteip')",
3156 'localport' => $localport,
3157 'remoteport' => $remoteport,
3158 'proto' => "'${proto}'",
3159 'description' => "'${description}'",
3165 return __FUNCTION__
. ': Failed to insert the rule.';
3168 function deletePortForwarding ($object_id, $localip, $localport, $remoteip, $remoteport, $proto)
3173 "delete from PortForwarding where object_id='$object_id' and localip=INET_ATON('$localip') and remoteip=INET_ATON('$remoteip') and localport='$localport' and remoteport='$remoteport' and proto='$proto'";
3174 $result = $dbxlink->exec ($query);
3178 function updatePortForwarding ($object_id, $localip, $localport, $remoteip, $remoteport, $proto, $description)
3183 "update PortForwarding set description='$description' where object_id='$object_id' and localip=INET_ATON('$localip') and remoteip=INET_ATON('$remoteip') and localport='$localport' and remoteport='$remoteport' and proto='$proto'";
3184 $result = $dbxlink->exec ($query);
3188 function getNATv4ForObject ($object_id)
3191 $ret['out'] = array();
3192 $ret['in'] = array();
3196 "INET_NTOA(localip) as localip, ".
3198 "INET_NTOA(remoteip) as remoteip, ".
3200 "ipa1.name as local_addr_name, " .
3201 "ipa2.name as remote_addr_name, " .
3203 "from PortForwarding ".
3204 "left join IPAddress as ipa1 on PortForwarding.localip = ipa1.ip " .
3205 "left join IPAddress as ipa2 on PortForwarding.remoteip = ipa2.ip " .
3206 "where object_id='$object_id' ".
3207 "order by localip, localport, proto, remoteip, remoteport";
3208 $result = useSelectBlade ($query, __FUNCTION__
);
3210 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
3212 foreach (array ('proto', 'localport', 'localip', 'remoteport', 'remoteip', 'description', 'local_addr_name', 'remote_addr_name') as $cname)
3213 $ret['out'][$count][$cname] = $row[$cname];
3216 $result->closeCursor();
3222 "INET_NTOA(localip) as localip, ".
3224 "INET_NTOA(remoteip) as remoteip, ".
3226 "PortForwarding.object_id as object_id, ".
3227 "RackObject.name as object_name, ".
3229 "from ((PortForwarding join IPBonds on remoteip=IPBonds.ip) join RackObject on PortForwarding.object_id=RackObject.id) ".
3230 "where IPBonds.object_id='$object_id' ".
3231 "order by remoteip, remoteport, proto, localip, localport";
3232 $result = useSelectBlade ($query, __FUNCTION__
);
3234 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
3236 foreach (array ('proto', 'localport', 'localip', 'remoteport', 'remoteip', 'object_id', 'object_name', 'description') as $cname)
3237 $ret['in'][$count][$cname] = $row[$cname];
3240 $result->closeCursor();
3245 // This function performs search and then calculates score for each result.
3246 // Given previous search results in $objects argument, it adds new results
3247 // to the array and updates score for existing results, if it is greater than
3249 function mergeSearchResults (&$objects, $terms, $fieldname)
3253 "select name, label, asset_no, barcode, ro.id, dict_key as objtype_id, " .
3254 "dict_value as objtype_name, asset_no from RackObject as ro inner join Dictionary " .
3255 "on objtype_id = dict_key natural join Chapter where chapter_name = 'RackObjectType' and ";
3257 foreach (explode (' ', $terms) as $term)
3259 if ($count) $query .= ' or ';
3260 $query .= "${fieldname} like '%$term%'";
3263 $query .= " order by ${fieldname}";
3264 $result = useSelectBlade ($query, __FUNCTION__
);
3265 // FIXME: this dead call was executed 4 times per 1 object search!
3266 // $typeList = getObjectTypeList();
3267 $clist = array ('id', 'name', 'label', 'asset_no', 'barcode', 'objtype_id', 'objtype_name');
3268 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
3270 foreach ($clist as $cname)
3271 $object[$cname] = $row[$cname];
3272 $object['score'] = 0;
3273 $object['dname'] = displayedName ($object);
3274 unset ($object['objtype_id']);
3275 foreach (explode (' ', $terms) as $term)
3276 if (strstr ($object['name'], $term))
3277 $object['score'] +
= 1;
3278 unset ($object['name']);
3279 if (!isset ($objects[$row['id']]))
3280 $objects[$row['id']] = $object;
3281 elseif ($objects[$row['id']]['score'] < $object['score'])
3282 $objects[$row['id']]['score'] = $object['score'];
3287 function getLostIPv4Addresses ()