cf5bcb2bab7952462e78102d3efe24e70ddd7d75
4 * This file is a library of computational functions for RackTables.
9 $loclist[1] = 'interior';
11 $loclist['front'] = 0;
12 $loclist['interior'] = 1;
14 $template[0] = array (TRUE, TRUE, TRUE);
15 $template[1] = array (TRUE, TRUE, FALSE);
16 $template[2] = array (FALSE, TRUE, TRUE);
17 $template[3] = array (TRUE, FALSE, FALSE);
18 $template[4] = array (FALSE, TRUE, FALSE);
19 $template[5] = array (FALSE, FALSE, TRUE);
20 $templateWidth[0] = 3;
21 $templateWidth[1] = 2;
22 $templateWidth[2] = 2;
23 $templateWidth[3] = 1;
24 $templateWidth[4] = 1;
25 $templateWidth[5] = 1;
27 // Objects of some types should be explicitly shown as
28 // anonymous (labelless). This function is a single place where the
29 // decision about displayed name is made.
30 function displayedName ($objectData)
32 if ($objectData['name'] != '')
33 return $objectData['name'];
34 elseif (in_array ($objectData['objtype_id'], explode (',', getConfigVar ('NAMEFUL_OBJTYPES'))))
35 return "ANONYMOUS " . $objectData['objtype_name'];
37 return "[${objectData['objtype_name']}]";
40 // This function finds height of solid rectangle of atoms, which are all
41 // assigned to the same object. Rectangle base is defined by specified
43 function rectHeight ($rackData, $startRow, $template_idx)
46 // The first met object_id is used to match all the folowing IDs.
51 for ($locidx = 0; $locidx < 3; $locidx++
)
53 // At least one value in template is TRUE, but the following block
54 // can meet 'skipped' atoms. Let's ensure we have something after processing
56 if ($template[$template_idx][$locidx])
58 if (isset ($rackData[$startRow - $height][$locidx]['skipped']))
60 if (isset ($rackData[$startRow - $height][$locidx]['rowspan']))
62 if (isset ($rackData[$startRow - $height][$locidx]['colspan']))
64 if ($rackData[$startRow - $height][$locidx]['state'] != 'T')
67 $object_id = $rackData[$startRow - $height][$locidx]['object_id'];
68 if ($object_id != $rackData[$startRow - $height][$locidx]['object_id'])
72 // If the first row can't offer anything, bail out.
73 if ($height == 0 and $object_id == 0)
77 while ($startRow - $height > 0);
78 # echo "for startRow==${startRow} and template==(" . ($template[$template_idx][0] ? 'T' : 'F');
79 # echo ', ' . ($template[$template_idx][1] ? 'T' : 'F') . ', ' . ($template[$template_idx][2] ? 'T' : 'F');
80 # echo ") height==${height}<br>\n";
84 // This function marks atoms to be avoided by rectHeight() and assigns rowspan/colspan
86 function markSpan (&$rackData, $startRow, $maxheight, $template_idx)
88 global $template, $templateWidth;
90 for ($height = 0; $height < $maxheight; $height++
)
92 for ($locidx = 0; $locidx < 3; $locidx++
)
94 if ($template[$template_idx][$locidx])
96 // Add colspan/rowspan to the first row met and mark the following ones to skip.
97 // Explicitly show even single-cell spanned atoms, because rectHeight()
98 // is expeciting this data for correct calculation.
100 $rackData[$startRow - $height][$locidx]['skipped'] = TRUE;
103 $colspan = $templateWidth[$template_idx];
105 $rackData[$startRow - $height][$locidx]['colspan'] = $colspan;
107 $rackData[$startRow - $height][$locidx]['rowspan'] = $maxheight;
115 // This function sets rowspan/solspan/skipped atom attributes for renderRack()
116 // What we actually have to do is to find _all_ possible rectangles for each unit
117 // and then select the widest of those with the maximal square.
118 function markAllSpans (&$rackData = NULL)
120 if ($rackData == NULL)
122 showError ('Invalid rackData', __FUNCTION__
);
125 for ($i = $rackData['height']; $i > 0; $i--)
126 while (markBestSpan ($rackData, $i));
129 // Calculate height of 6 possible span templates (array is presorted by width
130 // descending) and mark the best (if any).
131 function markBestSpan (&$rackData, $i)
133 global $template, $templateWidth;
134 for ($j = 0; $j < 6; $j++
)
136 $height[$j] = rectHeight ($rackData, $i, $j);
137 $square[$j] = $height[$j] * $templateWidth[$j];
139 // find the widest rectangle of those with maximal height
140 $maxsquare = max ($square);
143 $best_template_index = 0;
144 for ($j = 0; $j < 6; $j++
)
145 if ($square[$j] == $maxsquare)
147 $best_template_index = $j;
148 $bestheight = $height[$j];
151 // distribute span marks
152 markSpan ($rackData, $i, $bestheight, $best_template_index);
156 // We can mount 'F' atoms and unmount our own 'T' atoms.
157 function applyObjectMountMask (&$rackData, $object_id)
159 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
160 for ($locidx = 0; $locidx < 3; $locidx++
)
161 switch ($rackData[$unit_no][$locidx]['state'])
164 $rackData[$unit_no][$locidx]['enabled'] = TRUE;
167 $rackData[$unit_no][$locidx]['enabled'] = ($rackData[$unit_no][$locidx]['object_id'] == $object_id);
170 $rackData[$unit_no][$locidx]['enabled'] = FALSE;
174 // Design change means transition between 'F' and 'A' and back.
175 function applyRackDesignMask (&$rackData)
177 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
178 for ($locidx = 0; $locidx < 3; $locidx++
)
179 switch ($rackData[$unit_no][$locidx]['state'])
183 $rackData[$unit_no][$locidx]['enabled'] = TRUE;
186 $rackData[$unit_no][$locidx]['enabled'] = FALSE;
190 // The same for 'F' and 'U'.
191 function applyRackProblemMask (&$rackData)
193 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
194 for ($locidx = 0; $locidx < 3; $locidx++
)
195 switch ($rackData[$unit_no][$locidx]['state'])
199 $rackData[$unit_no][$locidx]['enabled'] = TRUE;
202 $rackData[$unit_no][$locidx]['enabled'] = FALSE;
206 // This mask should allow toggling 'T' and 'W' on object's rackspace.
207 function applyObjectProblemMask (&$rackData)
209 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
210 for ($locidx = 0; $locidx < 3; $locidx++
)
211 switch ($rackData[$unit_no][$locidx]['state'])
215 $rackData[$unit_no][$locidx]['enabled'] = ($rackData[$unit_no][$locidx]['object_id'] == $object_id);
218 $rackData[$unit_no][$locidx]['enabled'] = FALSE;
222 // This function highlights specified object (and removes previous highlight).
223 function highlightObject (&$rackData, $object_id)
225 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
226 for ($locidx = 0; $locidx < 3; $locidx++
)
229 $rackData[$unit_no][$locidx]['state'] == 'T' and
230 $rackData[$unit_no][$locidx]['object_id'] == $object_id
232 $rackData[$unit_no][$locidx]['hl'] = 'h';
234 unset ($rackData[$unit_no][$locidx]['hl']);
237 // This function marks atoms to selected or not depending on their current state.
238 function markupAtomGrid (&$data, $checked_state)
240 for ($unit_no = $data['height']; $unit_no > 0; $unit_no--)
241 for ($locidx = 0; $locidx < 3; $locidx++
)
243 if (!($data[$unit_no][$locidx]['enabled'] === TRUE))
245 if ($data[$unit_no][$locidx]['state'] == $checked_state)
246 $data[$unit_no][$locidx]['checked'] = ' checked';
248 $data[$unit_no][$locidx]['checked'] = '';
252 // This function is almost a clone of processGridForm(), but doesn't save anything to database
253 // Return value is the changed rack data.
254 // Here we assume that correct filter has already been applied, so we just
255 // set or unset checkbox inputs w/o changing atom state.
256 function mergeGridFormToRack (&$rackData)
258 $rack_id = $rackData['id'];
259 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
260 for ($locidx = 0; $locidx < 3; $locidx++
)
262 if ($rackData[$unit_no][$locidx]['enabled'] != TRUE)
264 $inputname = "atom_${rack_id}_${unit_no}_${locidx}";
265 if (isset ($_REQUEST[$inputname]) and $_REQUEST[$inputname] == 'on')
266 $rackData[$unit_no][$locidx]['checked'] = ' checked';
268 $rackData[$unit_no][$locidx]['checked'] = '';
272 // netmask conversion from length to number
273 function binMaskFromDec ($maskL)
275 $map_straight = array (
310 return $map_straight[$maskL];
313 // complementary value
314 function binInvMaskFromDec ($maskL)
351 return $map_compl[$maskL];
354 // This function looks up 'has_problems' flag for 'T' atoms
355 // and modifies 'hl' key. May be, this should be better done
356 // in getRackData(). We don't honour 'skipped' key, because
357 // the function is also used for thumb creation.
358 function markupObjectProblems (&$rackData)
360 for ($i = $rackData['height']; $i > 0; $i--)
361 for ($locidx = 0; $locidx < 3; $locidx++
)
362 if ($rackData[$i][$locidx]['state'] == 'T')
364 $object = getObjectInfo ($rackData[$i][$locidx]['object_id']);
365 if ($object['has_problems'] == 'yes')
367 // Object can be already highlighted.
368 if (isset ($rackData[$i][$locidx]['hl']))
369 $rackData[$i][$locidx]['hl'] = $rackData[$i][$locidx]['hl'] . 'w';
371 $rackData[$i][$locidx]['hl'] = 'w';
376 function search_cmpObj ($a, $b)
378 return ($a['score'] > $b['score'] ?
-1 : 1);
381 // This function performs search and then calculates score for each result.
382 // Given previous search results in $objects argument, it adds new results
383 // to the array and updates score for existing results, if it is greater than
385 function mergeSearchResults (&$objects, $terms, $fieldname)
389 "select name, label, asset_no, barcode, ro.id, dict_key as objtype_id, " .
390 "dict_value as objtype_name, asset_no from RackObject as ro inner join Dictionary " .
391 "on objtype_id = dict_key natural join Chapter where chapter_name = 'RackObjectType' and ";
393 foreach (explode (' ', $terms) as $term)
395 if ($count) $query .= ' or ';
396 $query .= "${fieldname} like '%$term%'";
399 $query .= " order by ${fieldname}";
400 $result = useSelectBlade ($query, __FUNCTION__
);
401 // FIXME: this dead call was executed 4 times per 1 object search!
402 // $typeList = getObjectTypeList();
403 $clist = array ('id', 'name', 'label', 'asset_no', 'barcode', 'objtype_id', 'objtype_name');
404 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
406 foreach ($clist as $cname)
407 $object[$cname] = $row[$cname];
408 $object['score'] = 0;
409 $object['dname'] = displayedName ($object);
410 unset ($object['objtype_id']);
411 foreach (explode (' ', $terms) as $term)
412 if (strstr ($object['name'], $term))
413 $object['score'] +
= 1;
414 unset ($object['name']);
415 if (!isset ($objects[$row['id']]))
416 $objects[$row['id']] = $object;
417 elseif ($objects[$row['id']]['score'] < $object['score'])
418 $objects[$row['id']]['score'] = $object['score'];
423 function getObjectSearchResults ($terms)
426 mergeSearchResults ($objects, $terms, 'name');
427 mergeSearchResults ($objects, $terms, 'label');
428 mergeSearchResults ($objects, $terms, 'asset_no');
429 mergeSearchResults ($objects, $terms, 'barcode');
430 if (count ($objects) == 1)
431 usort ($objects, 'search_cmpObj');
435 // This function removes all colons and dots from a string.
436 function l2addressForDatabase ($string)
440 $pieces = explode (':', $string);
441 // This workaround is for SunOS ifconfig.
442 foreach ($pieces as &$byte)
443 if (strlen ($byte) == 1)
445 // And this workaround is for PHP.
447 $string = implode ('', $pieces);
448 $pieces = explode ('.', $string);
449 $string = implode ('', $pieces);
450 $string = strtoupper ($string);
454 function l2addressFromDatabase ($string)
456 switch (strlen ($string))
460 $ret = implode (':', str_split ($string, 2));
469 // The following 2 functions return previous and next rack IDs for
470 // a given rack ID. The order of racks is the same as in renderRackspace()
472 function getPrevIDforRack ($row_id = 0, $rack_id = 0)
474 if ($row_id <= 0 or $rack_id <= 0)
476 showError ('Invalid arguments passed', __FUNCTION__
);
479 $rackList = getRacksForRow ($row_id);
480 doubleLink ($rackList);
481 if (isset ($rackList[$rack_id]['prev_key']))
482 return $rackList[$rack_id]['prev_key'];
486 function getNextIDforRack ($row_id = 0, $rack_id = 0)
488 if ($row_id <= 0 or $rack_id <= 0)
490 showError ('Invalid arguments passed', __FUNCTION__
);
493 $rackList = getRacksForRow ($row_id);
494 doubleLink ($rackList);
495 if (isset ($rackList[$rack_id]['next_key']))
496 return $rackList[$rack_id]['next_key'];
500 // This function finds previous and next array keys for each array key and
501 // modifies its argument accordingly.
502 function doubleLink (&$array)
505 foreach (array_keys ($array) as $key)
509 $array[$key]['prev_key'] = $prev_key;
510 $array[$prev_key]['next_key'] = $key;
516 // After applying usort() to a rack list we will lose original array keys.
517 // This function restores the keys so they are equal to rack IDs.
518 function restoreRackIDs ($racks)
521 foreach ($racks as $rack)
522 $ret[$rack['id']] = $rack;
526 function sortTokenize ($a, $b)
532 $a = ereg_replace('[^a-zA-Z0-9]',' ',$a);
533 $a = ereg_replace('([0-9])([a-zA-Z])','\\1 \\2',$a);
534 $a = ereg_replace('([a-zA-Z])([0-9])','\\1 \\2',$a);
541 $b = ereg_replace('[^a-zA-Z0-9]',' ',$b);
542 $b = ereg_replace('([0-9])([a-zA-Z])','\\1 \\2',$b);
543 $b = ereg_replace('([a-zA-Z])([0-9])','\\1 \\2',$b);
548 $ar = explode(' ', $a);
549 $br = explode(' ', $b);
550 for ($i=0; $i<count($ar) && $i<count($br); $i++
)
553 if (is_numeric($ar[$i]) and is_numeric($br[$i]))
554 $ret = ($ar[$i]==$br[$i])?
0:($ar[$i]<$br[$i]?
-1:1);
556 $ret = strcasecmp($ar[$i], $br[$i]);
567 function sortByName ($a, $b)
569 return sortTokenize($a['name'], $b['name']);
572 function sortRacks ($a, $b)
574 return sortTokenize($a['row_name'] . ': ' . $a['name'], $b['row_name'] . ': ' . $b['name']);
582 function neq ($a, $b)
587 function countRefsOfType ($refs, $type, $eq)
590 foreach ($refs as $ref)
592 if ($eq($ref['type'], $type))
598 function sortEmptyPorts ($a, $b)
600 $objname_cmp = sortTokenize($a['Object_name'], $b['Object_name']);
601 if ($objname_cmp == 0)
603 return sortTokenize($a['Port_name'], $b['Port_name']);
608 function sortObjectAddressesAndNames ($a, $b)
610 $objname_cmp = sortTokenize($a['object_name'], $b['object_name']);
611 if ($objname_cmp == 0)
613 $name_a = (isset ($a['port_name'])) ?
$a['port_name'] : '';
614 $name_b = (isset ($b['port_name'])) ?
$b['port_name'] : '';
615 $objname_cmp = sortTokenize($name_a, $name_b);
616 if ($objname_cmp == 0)
617 sortTokenize($a['ip'], $b['ip']);
625 function sortAddresses ($a, $b)
627 $name_cmp = sortTokenize($a['name'], $b['name']);
630 return sortTokenize($a['ip'], $b['ip']);
635 // This function expands port compat list into a matrix.
636 function buildPortCompatMatrixFromList ($portTypeList, $portCompatList)
639 // Create type matrix and markup compatible types.
640 foreach (array_keys ($portTypeList) as $type1)
641 foreach (array_keys ($portTypeList) as $type2)
642 $matrix[$type1][$type2] = FALSE;
643 foreach ($portCompatList as $pair)
644 $matrix[$pair['type1']][$pair['type2']] = TRUE;
648 function newPortForwarding($object_id, $localip, $localport, $remoteip, $remoteport, $proto, $description)
650 if (NULL === getIPv4AddressNetworkId ($localip))
651 return "$localip: Non existant ip";
652 if (NULL === getIPv4AddressNetworkId ($localip))
653 return "$remoteip: Non existant ip";
654 if ( ($localport <= 0) or ($localport >= 65536) )
655 return "$localport: invaild port";
656 if ( ($remoteport <= 0) or ($remoteport >= 65536) )
657 return "$remoteport: invaild port";
659 $result = useInsertBlade
664 'object_id' => $object_id,
665 'localip' => "INET_ATON('${localip}')",
666 'remoteip' => "INET_ATON('$remoteip')",
667 'localport' => $localport,
668 'remoteport' => $remoteport,
669 'proto' => "'${proto}'",
670 'description' => "'${description}'",
676 return __FUNCTION__
. ': Failed to insert the rule.';
679 function deletePortForwarding($object_id, $localip, $localport, $remoteip, $remoteport, $proto)
684 "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'";
685 $result = $dbxlink->exec ($query);
689 function updatePortForwarding($object_id, $localip, $localport, $remoteip, $remoteport, $proto, $description)
694 "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'";
695 $result = $dbxlink->exec ($query);
699 function getNATv4ForObject ($object_id)
702 $ret['out'] = array();
703 $ret['in'] = array();
707 "INET_NTOA(localip) as localip, ".
709 "INET_NTOA(remoteip) as remoteip, ".
711 "ipa1.name as local_addr_name, " .
712 "ipa2.name as remote_addr_name, " .
714 "from PortForwarding ".
715 "left join IPAddress as ipa1 on PortForwarding.localip = ipa1.ip " .
716 "left join IPAddress as ipa2 on PortForwarding.remoteip = ipa2.ip " .
717 "where object_id='$object_id' ".
718 "order by localip, localport, proto, remoteip, remoteport";
719 $result = useSelectBlade ($query, __FUNCTION__
);
721 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
723 foreach (array ('proto', 'localport', 'localip', 'remoteport', 'remoteip', 'description', 'local_addr_name', 'remote_addr_name') as $cname)
724 $ret['out'][$count][$cname] = $row[$cname];
727 $result->closeCursor();
733 "INET_NTOA(localip) as localip, ".
735 "INET_NTOA(remoteip) as remoteip, ".
737 "PortForwarding.object_id as object_id, ".
738 "RackObject.name as object_name, ".
740 "from ((PortForwarding join IPBonds on remoteip=IPBonds.ip) join RackObject on PortForwarding.object_id=RackObject.id) ".
741 "where IPBonds.object_id='$object_id' ".
742 "order by remoteip, remoteport, proto, localip, localport";
743 $result = useSelectBlade ($query, __FUNCTION__
);
745 while ($row = $result->fetch (PDO
::FETCH_ASSOC
))
747 foreach (array ('proto', 'localport', 'localip', 'remoteport', 'remoteip', 'object_id', 'object_name', 'description') as $cname)
748 $ret['in'][$count][$cname] = $row[$cname];
751 $result->closeCursor();
756 // This function returns an array of single element of object's FQDN attribute,
757 // if FQDN is set. The next choice is object's common name, if it looks like a
758 // hostname. Otherwise an array of all 'regular' IP addresses of the
759 // object is returned (which may appear 0 and more elements long).
760 function findAllEndpoints ($object_id, $fallback = '')
762 $values = getAttrValues ($object_id);
763 foreach ($values as $record)
764 if ($record['name'] == 'FQDN' && !empty ($record['value']))
765 return array ($record['value']);
767 foreach (getObjectIPv4Allocations ($object_id) as $dottedquad => $alloc)
768 if ($alloc['type'] == 'regular')
769 $regular[] = $dottedquad;
770 if (!count ($regular) && !empty ($fallback))
771 return array ($fallback);
775 // Some records in the dictionary may be written as plain text or as Wiki
776 // link in the following syntax:
778 // 2. [[word URL]] // FIXME: this isn't working
779 // 3. [[word word word | URL]]
780 // This function parses the line and returns text suitable for either A
781 // (rendering <A HREF>) or O (for <OPTION>).
782 function parseWikiLink ($line, $which, $strip_optgroup = FALSE)
784 if (preg_match ('/^\[\[.+\]\]$/', $line) == 0)
787 return ereg_replace ('^.+%GSKIP%', '', ereg_replace ('^(.+)%GPASS%', '\\1 ', $line));
791 $line = preg_replace ('/^\[\[(.+)\]\]$/', '$1', $line);
792 $s = explode ('|', $line);
793 $o_value = trim ($s[0]);
795 $o_value = ereg_replace ('^.+%GSKIP%', '', ereg_replace ('^(.+)%GPASS%', '\\1 ', $o_value));
796 $a_value = trim ($s[1]);
798 return "<a href='${a_value}'>${o_value}</a>";
803 function buildVServiceName ($vsinfo = NULL)
807 showError ('NULL argument', __FUNCTION__
);
810 return $vsinfo['vip'] . ':' . $vsinfo['vport'] . '/' . $vsinfo['proto'];
813 function buildRSPoolName ($rspool = NULL)
817 showError ('NULL argument', __FUNCTION__
);
820 return strlen ($rspool['name']) ?
$rspool['name'] : 'ANONYMOUS pool';
823 // rackspace usage for a single rack
824 // (T + W + U) / (height * 3 - A)
825 function getRSUforRack ($data = NULL)
829 showError ('Invalid argument', __FUNCTION__
);
832 $counter = array ('A' => 0, 'U' => 0, 'T' => 0, 'W' => 0, 'F' => 0);
833 for ($unit_no = $data['height']; $unit_no > 0; $unit_no--)
834 for ($locidx = 0; $locidx < 3; $locidx++
)
835 $counter[$data[$unit_no][$locidx]['state']]++
;
836 return ($counter['T'] +
$counter['W'] +
$counter['U']) / ($counter['T'] +
$counter['W'] +
$counter['U'] +
$counter['F']);
840 function getRSUforRackRow ($rowData = NULL)
842 if ($rowData === NULL)
844 showError ('Invalid argument', __FUNCTION__
);
847 if (!count ($rowData))
849 $counter = array ('A' => 0, 'U' => 0, 'T' => 0, 'W' => 0, 'F' => 0);
851 foreach (array_keys ($rowData) as $rack_id)
853 $data = getRackData ($rack_id);
854 $total_height +
= $data['height'];
855 for ($unit_no = $data['height']; $unit_no > 0; $unit_no--)
856 for ($locidx = 0; $locidx < 3; $locidx++
)
857 $counter[$data[$unit_no][$locidx]['state']]++
;
859 return ($counter['T'] +
$counter['W'] +
$counter['U']) / ($counter['T'] +
$counter['W'] +
$counter['U'] +
$counter['F']);
862 function getObjectCount ($rackData)
865 for ($i = $rackData['height']; $i > 0; $i--)
866 for ($locidx = 0; $locidx < 3; $locidx++
)
869 $rackData[$i][$locidx]['state'] == 'T' and
870 !in_array ($rackData[$i][$locidx]['object_id'], $objects)
872 $objects[] = $rackData[$i][$locidx]['object_id'];
873 return count ($objects);
876 // Make sure the string is always wrapped with LF characters
877 function lf_wrap ($str)
879 $ret = trim ($str, "\r\n");
885 // Adopted from Mantis BTS code.
886 function string_insert_hrefs ($s)
888 if (getConfigVar ('DETECT_URLS') != 'yes')
890 # Find any URL in a string and replace it by a clickable link
891 $s = preg_replace( '/(([[:alpha:]][-+.[:alnum:]]*):\/\/(%[[:digit:]A-Fa-f]{2}|[-_.!~*\';\/?%^\\\\:@&={\|}+$#\(\),\[\][:alnum:]])+)/se',
892 "'<a href=\"'.rtrim('\\1','.').'\">\\1</a> [<a href=\"'.rtrim('\\1','.').'\" target=\"_blank\">^</a>]'",
894 $s = preg_replace( '/\b' . email_regex_simple() . '\b/i',
895 '<a href="mailto:\0">\0</a>',
901 function email_regex_simple ()
903 return "(([a-z0-9!#*+\/=?^_{|}~-]+(?:\.[a-z0-9!#*+\/=?^_{|}~-]+)*)" . # recipient
904 "\@((?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?))"; # @domain
907 // Parse AUTOPORTS_CONFIG and return a list of generated pairs (port_type, port_name)
908 // for the requested object_type_id.
909 function getAutoPorts ($type_id)
912 $typemap = explode (';', str_replace (' ', '', getConfigVar ('AUTOPORTS_CONFIG')));
913 foreach ($typemap as $equation)
915 $tmp = explode ('=', $equation);
916 if (count ($tmp) != 2)
918 $objtype_id = $tmp[0];
919 if ($objtype_id != $type_id)
922 foreach (explode ('+', $portlist) as $product)
924 $tmp = explode ('*', $product);
925 if (count ($tmp) != 3)
928 $port_type = $tmp[1];
930 for ($i = 0; $i < $nports; $i++
)
931 $ret[] = array ('type' => $port_type, 'name' => @sprintf
($format, $i));
937 // Find if a particular tag id exists on the tree, then attach the
938 // given child tag to it. If the parent tag doesn't exist, return FALSE.
939 function attachChildTag (&$tree, $parent_id, $child_id, $child_info)
941 foreach ($tree as $tagid => $taginfo)
943 if ($tagid == $parent_id)
945 $tree[$tagid]['kids'][$child_id] = $child_info;
948 elseif (attachChildTag ($tree[$tagid]['kids'], $parent_id, $child_id, $child_info))
954 // Build a tree from the tag list and return it.
955 function getTagTree ()
958 $mytaglist = $taglist;
960 while (count ($mytaglist) > 0)
963 foreach ($mytaglist as $tagid => $taginfo)
965 $taginfo['kids'] = array();
966 if ($taginfo['parent_id'] == NULL)
968 $ret[$tagid] = $taginfo;
970 unset ($mytaglist[$tagid]);
972 elseif (attachChildTag ($ret, $taginfo['parent_id'], $tagid, $taginfo))
975 unset ($mytaglist[$tagid]);
978 if (!$picked) // Only orphaned items on the list.
984 // Build a tree from the tag list and return everything _except_ the tree.
985 function getOrphanedTags ()
988 $mytaglist = $taglist;
990 while (count ($mytaglist) > 0)
993 foreach ($mytaglist as $tagid => $taginfo)
995 $taginfo['kids'] = array();
996 if ($taginfo['parent_id'] == NULL)
998 $dummy[$tagid] = $taginfo;
1000 unset ($mytaglist[$tagid]);
1002 elseif (attachChildTag ($dummy, $taginfo['parent_id'], $tagid, $taginfo))
1005 unset ($mytaglist[$tagid]);
1008 if (!$picked) // Only orphaned items on the list.
1014 function serializeTags ($chain, $baseurl = '')
1018 foreach ($chain as $taginfo)
1021 ($baseurl == '' ?
'' : "<a href='${baseurl}tagfilter[]=${taginfo['id']}'>") .
1023 ($baseurl == '' ?
'' : '</a>');
1029 // a helper for getTagChainExpansion()
1030 function traceTagChain ($tree, $chain)
1032 // For each tag find its path from the root, then combine items
1033 // of all paths and add them to the chain, if they aren't there yet.
1035 foreach ($tree as $taginfo1)
1038 foreach ($chain as $taginfo2)
1039 if ($taginfo1['id'] == $taginfo2['id'])
1044 if (count ($taginfo1['kids']) > 0)
1046 $subsearch = traceTagChain ($taginfo1['kids'], $chain);
1047 if (count ($subsearch))
1050 $ret = array_merge ($ret, $subsearch);
1059 // For each tag add all its parent tags onto the list. Don't expect anything
1060 // except user's tags on the chain.
1061 function getTagChainExpansion ($chain)
1064 return traceTagChain ($tagtree, $chain);
1067 // Return the list of missing implicit tags.
1068 function getImplicitTags ($oldtags)
1071 $newtags = getTagChainExpansion ($oldtags);
1072 foreach ($newtags as $newtag)
1074 $already_exists = FALSE;
1075 foreach ($oldtags as $oldtag)
1076 if ($newtag['id'] == $oldtag['id'])
1078 $already_exists = TRUE;
1081 if ($already_exists)
1083 $ret[] = array ('id' => $newtag['id'], 'tag' => $newtag['tag'], 'parent_id' => $newtag['parent_id']);
1088 // Minimize the chain: exclude all implicit tags and return the result.
1089 function getExplicitTagsOnly ($chain, $tree = NULL)
1095 foreach ($tree as $taginfo)
1097 if (isset ($taginfo['kids']))
1099 $harvest = getExplicitTagsOnly ($chain, $taginfo['kids']);
1100 if (count ($harvest) > 0)
1102 $ret = array_merge ($ret, $harvest);
1106 // This tag isn't implicit, test is for being explicit.
1107 foreach ($chain as $testtag)
1108 if ($taginfo['id'] == $testtag['id'])
1117 // Maximize the chain: for each tag add all tags, for which it is direct or indirect parent.
1118 // Unlike other functions, this one accepts and returns a list of integer tag IDs, not
1119 // a list of tag structures.
1120 function complementByKids ($idlist, $tree = NULL, $getall = FALSE)
1125 $getallkids = $getall;
1127 foreach ($tree as $taginfo)
1129 foreach ($idlist as $test_id)
1130 if ($getall or $taginfo['id'] == $test_id)
1132 $ret[] = $taginfo['id'];
1133 // Once matched node makes all sub-nodes match, but don't make
1134 // a mistake of matching every other node at the current level.
1138 if (isset ($taginfo['kids']))
1139 $ret = array_merge ($ret, complementByKids ($idlist, $taginfo['kids'], $getallkids));
1140 $getallkids = FALSE;
1145 function getUserAutoTags ($username = NULL)
1147 global $remote_username, $accounts;
1148 if ($username == NULL)
1149 $username = $remote_username;
1151 $ret[] = array ('tag' => '$username_' . $username);
1152 if (isset ($accounts[$username]['user_id']))
1153 $ret[] = array ('tag' => '$userid_' . $accounts[$username]['user_id']);
1157 function loadRackObjectAutoTags ()
1159 assertUIntArg ('object_id', __FUNCTION__
);
1160 $object_id = $_REQUEST['object_id'];
1161 $oinfo = getObjectInfo ($object_id);
1163 $ret[] = array ('tag' => '$id_' . $object_id);
1164 $ret[] = array ('tag' => '$typeid_' . $oinfo['objtype_id']);
1165 $ret[] = array ('tag' => '$any_object');
1166 if (validTagName ($oinfo['name']))
1167 $ret[] = array ('tag' => '$cn_' . $oinfo['name']);
1171 // Common code for both prefix and address tag listers.
1172 function getIPv4PrefixTags ($netid)
1174 $netinfo = getIPv4NetworkInfo ($netid);
1176 $ret[] = array ('tag' => '$ip4net-' . str_replace ('.', '-', $netinfo['ip']) . '-' . $netinfo['mask']);
1177 // FIXME: find and list tags for all parent networks?
1178 $ret[] = array ('tag' => '$any_ip4net');
1179 $ret[] = array ('tag' => '$any_net');
1183 function loadIPv4PrefixAutoTags ()
1185 assertUIntArg ('id', __FUNCTION__
);
1188 array (array ('tag' => '$ip4netid_' . $_REQUEST['id'])),
1189 getIPv4PrefixTags ($_REQUEST['id'])
1193 function loadIPv4AddressAutoTags ()
1195 assertIPv4Arg ('ip', __FUNCTION__
);
1198 array (array ('tag' => '$ip4net-' . str_replace ('.', '-', $_REQUEST['ip']) . '-32')),
1199 getIPv4PrefixTags (getIPv4AddressNetworkId ($_REQUEST['ip']))
1203 function loadRackAutoTags ()
1205 assertUIntArg ('rack_id', __FUNCTION__
);
1207 $ret[] = array ('tag' => '$rackid_' . $_REQUEST['rack_id']);
1208 $ret[] = array ('tag' => '$any_rack');
1212 function loadIPv4VSAutoTags ()
1214 assertUIntArg ('vs_id', __FUNCTION__
);
1216 $ret[] = array ('tag' => '$ipv4vsid_' . $_REQUEST['vs_id']);
1217 $ret[] = array ('tag' => '$any_ipv4vs');
1218 $ret[] = array ('tag' => '$any_vs');
1222 function loadIPv4RSPoolAutoTags ()
1224 assertUIntArg ('pool_id', __FUNCTION__
);
1226 $ret[] = array ('tag' => '$ipv4rspid_' . $_REQUEST['pool_id']);
1227 $ret[] = array ('tag' => '$any_ipv4rsp');
1228 $ret[] = array ('tag' => '$any_rsp');
1232 // If the page-tab-op triplet is final, make $expl_tags and $impl_tags
1233 // hold all appropriate (explicit and implicit) tags respectively.
1234 // Otherwise some limited redirection is necessary (only page and tab
1235 // names are preserved, ophandler name change isn't handled).
1236 function fixContext ()
1238 global $pageno, $tabno, $auto_tags, $expl_tags, $impl_tags, $page;
1242 'accounts' => 'userlist',
1243 'rspools' => 'ipv4rsplist',
1244 'rspool' => 'ipv4rsp',
1245 'vservices' => 'ipv4vslist',
1246 'vservice' => 'ipv4vs',
1249 $tmap['objects']['newmulti'] = 'addmore';
1250 $tmap['objects']['newobj'] = 'addmore';
1251 $tmap['object']['switchvlans'] = 'livevlans';
1252 $tmap['object']['slb'] = 'editrspvs';
1253 $tmap['object']['portfwrd'] = 'nat4';
1254 $tmap['object']['network'] = 'ipv4';
1255 if (isset ($pmap[$pageno]))
1256 redirectUser ($pmap[$pageno], $tabno);
1257 if (isset ($tmap[$pageno][$tabno]))
1258 redirectUser ($pageno, $tmap[$pageno][$tabno]);
1260 if (isset ($page[$pageno]['autotagloader']))
1261 $auto_tags = $page[$pageno]['autotagloader'] ();
1264 isset ($page[$pageno]['tagloader']) and
1265 isset ($page[$pageno]['bypass']) and
1266 isset ($_REQUEST[$page[$pageno]['bypass']])
1269 $expl_tags = $page[$pageno]['tagloader'] ($_REQUEST[$page[$pageno]['bypass']]);
1270 $impl_tags = getImplicitTags ($expl_tags);
1274 // Build a tag chain from supplied tag id list and return it.
1275 function buildTagChainFromIds ($tagidlist)
1279 foreach ($tagidlist as $tag_id)
1280 if (isset ($taglist[$tag_id]))
1281 $ret[] = $taglist[$tag_id];
1285 // Process a given tag tree and return only meaningful branches. The resulting
1286 // (sub)tree will have refcnt leaves on every last branch.
1287 function getObjectiveTagTree ($tree, $realm)
1290 foreach ($tree as $taginfo)
1292 $subsearch = array();
1294 if (count ($taginfo['kids']))
1296 $subsearch = getObjectiveTagTree ($taginfo['kids'], $realm);
1297 $pick = count ($subsearch) > 0;
1299 if (isset ($taginfo['refcnt'][$realm]))
1305 'id' => $taginfo['id'],
1306 'tag' => $taginfo['tag'],
1307 'parent_id' => $taginfo['parent_id'],
1308 'refcnt' => $taginfo['refcnt'],
1309 'kids' => $subsearch
1315 function getTagFilter ()
1317 return isset ($_REQUEST['tagfilter']) ?
complementByKids ($_REQUEST['tagfilter']) : array();
1320 function getTagFilterStr ($tagfilter = array())
1323 foreach (getExplicitTagsOnly (buildTagChainFromIds ($tagfilter)) as $taginfo)
1324 $ret .= "&tagfilter[]=" . $taginfo['id'];
1328 function buildWideRedirectURL ($log, $nextpage = NULL, $nexttab = NULL)
1330 global $root, $page, $pageno, $tabno;
1331 if ($nextpage === NULL)
1332 $nextpage = $pageno;
1333 if ($nexttab === NULL)
1335 $url = "${root}?page=${nextpage}&tab=${nexttab}";
1336 if (isset ($page[$nextpage]['bypass']))
1337 $url .= '&' . $page[$nextpage]['bypass'] . '=' . $_REQUEST[$page[$nextpage]['bypass']];
1338 $url .= "&log=" . urlencode (base64_encode (serialize ($log)));
1342 function buildRedirectURL ($status, $args = array(), $nextpage = NULL, $nexttab = NULL)
1344 global $msgcode, $pageno, $tabno, $op;
1345 if ($nextpage === NULL)
1346 $nextpage = $pageno;
1347 if ($nexttab === NULL)
1349 return buildWideRedirectURL (oneLiner ($msgcode[$pageno][$tabno][$op][$status], $args), $nextpage, $nexttab);
1352 // Return a message log consisting of only one message.
1353 function oneLiner ($code, $args = array())
1355 $ret = array ('v' => 2);
1356 $ret['m'][] = count ($args) ?
array ('c' => $code, 'a' => $args) : array ('c' => $code);
1360 // Return mesage code by status code.
1361 function getMessageCode ($status)
1363 global $pageno, $tabno, $op, $msgcode;
1364 return $msgcode[$pageno][$tabno][$op][$status];
1367 function validTagName ($s, $allow_autotag = FALSE)
1369 if (1 == mb_ereg (TAGNAME_REGEXP
, $s))
1371 if ($allow_autotag and 1 == mb_ereg (AUTOTAGNAME_REGEXP
, $s))
1376 function redirectUser ($p, $t)
1378 global $page, $root;
1379 $l = "{$root}?page=${p}&tab=${t}";
1380 if (isset ($page[$p]['bypass']) and isset ($_REQUEST[$page[$p]['bypass']]))
1381 $l .= '&' . $page[$p]['bypass'] . '=' . $_REQUEST[$page[$p]['bypass']];
1382 header ("Location: " . $l);
1386 function getRackCodeStats ()
1389 $defc = $grantc = 0;
1390 foreach ($rackCode as $s)
1393 case 'SYNT_DEFINITION':
1402 $ret = array ('Definition sentences' => $defc, 'Grant sentences' => $grantc);
1406 function getRackImageWidth ()
1408 return 3 +
getConfigVar ('rtwidth_0') +
getConfigVar ('rtwidth_1') +
getConfigVar ('rtwidth_2') +
3;
1411 function getRackImageHeight ($units)
1413 return 3 +
3 +
$units * 2;
1416 // Perform substitutions and return resulting string
1417 // used solely by buildLVSConfig()
1418 function apply_macros ($macros, $subject)
1421 foreach ($macros as $search => $replace)
1422 $ret = str_replace ($search, $replace, $ret);
1426 function buildLVSConfig ($object_id = 0)
1428 if ($object_id <= 0)
1430 showError ('Invalid argument', __FUNCTION__
);
1433 $oInfo = getObjectInfo ($object_id);
1434 $lbconfig = getSLBConfig ($object_id);
1435 if ($lbconfig === NULL)
1437 showError ('getSLBConfig() failed', __FUNCTION__
);
1440 $newconfig = "#\n#\n# This configuration has been generated automatically by RackTables\n";
1441 $newconfig .= "# for object_id == ${object_id}\n# object name: ${oInfo['name']}\n#\n#\n\n\n";
1442 foreach ($lbconfig as $vs_id => $vsinfo)
1444 $newconfig .= "########################################################\n" .
1445 "# VS (id == ${vs_id}): " . (empty ($vsinfo['vs_name']) ?
'NO NAME' : $vsinfo['vs_name']) . "\n" .
1446 "# RS pool (id == ${vsinfo['pool_id']}): " . (empty ($vsinfo['pool_name']) ?
'ANONYMOUS' : $vsinfo['pool_name']) . "\n" .
1447 "########################################################\n";
1448 # The order of inheritance is: VS -> LB -> pool [ -> RS ]
1451 '%VIP%' => $vsinfo['vip'],
1452 '%VPORT%' => $vsinfo['vport'],
1453 '%PROTO%' => $vsinfo['proto'],
1454 '%VNAME%' => $vsinfo['vs_name'],
1455 '%RSPOOLNAME%' => $vsinfo['pool_name']
1457 $newconfig .= "virtual_server ${vsinfo['vip']} ${vsinfo['vport']} {\n";
1458 $newconfig .= "\tprotocol ${vsinfo['proto']}\n";
1459 $newconfig .= apply_macros
1462 lf_wrap ($vsinfo['vs_vsconfig']) .
1463 lf_wrap ($vsinfo['lb_vsconfig']) .
1464 lf_wrap ($vsinfo['pool_vsconfig'])
1466 foreach ($vsinfo['rslist'] as $rs)
1468 $macros['%RSIP%'] = $rs['rsip'];
1469 $macros['%RSPORT%'] = $rs['rsport'];
1470 $newconfig .= "\treal_server ${rs['rsip']} ${rs['rsport']} {\n";
1471 $newconfig .= apply_macros
1474 lf_wrap ($vsinfo['vs_rsconfig']) .
1475 lf_wrap ($vsinfo['lb_rsconfig']) .
1476 lf_wrap ($vsinfo['pool_rsconfig']) .
1477 lf_wrap ($rs['rs_rsconfig'])
1479 $newconfig .= "\t}\n";
1481 $newconfig .= "}\n\n\n";
1486 // Indicate occupation state of each IP address: none, ordinary or problematic.
1487 function markupIPv4AddrList (&$addrlist)
1489 foreach (array_keys ($addrlist) as $ip_bin)
1492 $nvirtual = countRefsOfType ($addrlist[$ip_bin]['allocs'], 'shared', 'eq');
1493 $nloopback = countRefsOfType ($addrlist[$ip_bin]['allocs'], 'virtual', 'eq');
1494 $nconnected = countRefsOfType ($addrlist[$ip_bin]['allocs'], 'regular', 'eq');
1495 $nrouter = countRefsOfType ($addrlist[$ip_bin]['allocs'], 'router', 'eq');
1496 $nsl = ($nvirtual +
$nloopback > 0) ?
1 : 0;
1497 $nrsv = ($addrlist[$ip_bin]['reserved'] == 'yes') ?
1 : 0;
1498 $nrealms = $nrsv +
$nsl +
$nconnected +
$nrouter;
1501 $addrlist[$ip_bin]['class'] = 'trbusy';
1502 elseif ($nrealms > 1)
1503 $addrlist[$ip_bin]['class'] = 'trerror';
1505 $addrlist[$ip_bin]['class'] = '';
1509 // Scan the given address list (returned by scanIPv4Space) and return a list of all routers found.
1510 function findRouters ($addrlist)
1513 foreach ($addrlist as $addr)
1514 foreach ($addr['allocs'] as $alloc)
1515 if ($alloc['type'] == 'router')
1518 'id' => $alloc['object_id'],
1519 'iface' => $alloc['name'],
1520 'dname' => $alloc['object_name'],
1521 'addr' => $addr['ip']