r2267 - renderPortsForObject(): finally use printSelect() and remove the warnings...
[racktables] / inc / functions.php
CommitLineData
b325120a 1<?php
e673ee24
DO
2/*
3*
4* This file is a library of computational functions for RackTables.
5*
6*/
7
8$loclist[0] = 'front';
9$loclist[1] = 'interior';
10$loclist[2] = 'rear';
11$loclist['front'] = 0;
12$loclist['interior'] = 1;
13$loclist['rear'] = 2;
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;
26
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.
30function displayedName ($objectData)
31{
32 if ($objectData['name'] != '')
33 return $objectData['name'];
9c0b0016 34 elseif (in_array ($objectData['objtype_id'], explode (',', getConfigVar ('NAMEFUL_OBJTYPES'))))
a0ec6295 35 return "ANONYMOUS " . $objectData['objtype_name'];
e673ee24 36 else
a0ec6295 37 return "[${objectData['objtype_name']}]";
e673ee24
DO
38}
39
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
42// template.
43function rectHeight ($rackData, $startRow, $template_idx)
44{
45 $height = 0;
46 // The first met object_id is used to match all the folowing IDs.
47 $object_id = 0;
48 global $template;
49 do
50 {
51 for ($locidx = 0; $locidx < 3; $locidx++)
52 {
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
55 // the first row.
56 if ($template[$template_idx][$locidx])
57 {
58 if (isset ($rackData[$startRow - $height][$locidx]['skipped']))
59 break 2;
93e02204
DO
60 if (isset ($rackData[$startRow - $height][$locidx]['rowspan']))
61 break 2;
62 if (isset ($rackData[$startRow - $height][$locidx]['colspan']))
63 break 2;
e673ee24
DO
64 if ($rackData[$startRow - $height][$locidx]['state'] != 'T')
65 break 2;
66 if ($object_id == 0)
67 $object_id = $rackData[$startRow - $height][$locidx]['object_id'];
68 if ($object_id != $rackData[$startRow - $height][$locidx]['object_id'])
69 break 2;
70 }
71 }
72 // If the first row can't offer anything, bail out.
73 if ($height == 0 and $object_id == 0)
74 break;
75 $height++;
76 }
77 while ($startRow - $height > 0);
93e02204
DO
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";
e673ee24
DO
81 return $height;
82}
83
84// This function marks atoms to be avoided by rectHeight() and assigns rowspan/colspan
85// attributes.
86function markSpan (&$rackData, $startRow, $maxheight, $template_idx)
87{
88 global $template, $templateWidth;
89 $colspan = 0;
90 for ($height = 0; $height < $maxheight; $height++)
91 {
92 for ($locidx = 0; $locidx < 3; $locidx++)
93 {
94 if ($template[$template_idx][$locidx])
95 {
96 // Add colspan/rowspan to the first row met and mark the following ones to skip.
93e02204
DO
97 // Explicitly show even single-cell spanned atoms, because rectHeight()
98 // is expeciting this data for correct calculation.
e673ee24
DO
99 if ($colspan != 0)
100 $rackData[$startRow - $height][$locidx]['skipped'] = TRUE;
101 else
102 {
103 $colspan = $templateWidth[$template_idx];
93e02204 104 if ($colspan >= 1)
e673ee24 105 $rackData[$startRow - $height][$locidx]['colspan'] = $colspan;
93e02204 106 if ($maxheight >= 1)
e673ee24
DO
107 $rackData[$startRow - $height][$locidx]['rowspan'] = $maxheight;
108 }
109 }
110 }
111 }
112 return;
113}
114
93e02204
DO
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.
e673ee24
DO
118function markAllSpans (&$rackData = NULL)
119{
120 if ($rackData == NULL)
121 {
61e269b5 122 showError ('Invalid rackData', __FUNCTION__);
e673ee24
DO
123 return;
124 }
125 for ($i = $rackData['height']; $i > 0; $i--)
93e02204
DO
126 while (markBestSpan ($rackData, $i));
127}
128
129// Calculate height of 6 possible span templates (array is presorted by width
130// descending) and mark the best (if any).
131function markBestSpan (&$rackData, $i)
132{
133 global $template, $templateWidth;
134 for ($j = 0; $j < 6; $j++)
e673ee24 135 {
93e02204
DO
136 $height[$j] = rectHeight ($rackData, $i, $j);
137 $square[$j] = $height[$j] * $templateWidth[$j];
138 }
139 // find the widest rectangle of those with maximal height
140 $maxsquare = max ($square);
141 if (!$maxsquare)
142 return FALSE;
143 $best_template_index = 0;
144 for ($j = 0; $j < 6; $j++)
145 if ($square[$j] == $maxsquare)
e673ee24 146 {
93e02204
DO
147 $best_template_index = $j;
148 $bestheight = $height[$j];
149 break;
e673ee24 150 }
93e02204
DO
151 // distribute span marks
152 markSpan ($rackData, $i, $bestheight, $best_template_index);
153 return TRUE;
e673ee24
DO
154}
155
e673ee24
DO
156// We can mount 'F' atoms and unmount our own 'T' atoms.
157function applyObjectMountMask (&$rackData, $object_id)
158{
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'])
162 {
163 case 'F':
164 $rackData[$unit_no][$locidx]['enabled'] = TRUE;
165 break;
166 case 'T':
167 $rackData[$unit_no][$locidx]['enabled'] = ($rackData[$unit_no][$locidx]['object_id'] == $object_id);
168 break;
169 default:
170 $rackData[$unit_no][$locidx]['enabled'] = FALSE;
171 }
172}
173
174// Design change means transition between 'F' and 'A' and back.
175function applyRackDesignMask (&$rackData)
176{
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'])
180 {
181 case 'F':
182 case 'A':
183 $rackData[$unit_no][$locidx]['enabled'] = TRUE;
184 break;
185 default:
186 $rackData[$unit_no][$locidx]['enabled'] = FALSE;
187 }
188}
189
190// The same for 'F' and 'U'.
191function applyRackProblemMask (&$rackData)
192{
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'])
196 {
197 case 'F':
198 case 'U':
199 $rackData[$unit_no][$locidx]['enabled'] = TRUE;
200 break;
201 default:
202 $rackData[$unit_no][$locidx]['enabled'] = FALSE;
203 }
204}
205
206// This mask should allow toggling 'T' and 'W' on object's rackspace.
207function applyObjectProblemMask (&$rackData)
208{
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'])
212 {
213 case 'T':
214 case 'W':
215 $rackData[$unit_no][$locidx]['enabled'] = ($rackData[$unit_no][$locidx]['object_id'] == $object_id);
216 break;
217 default:
218 $rackData[$unit_no][$locidx]['enabled'] = FALSE;
219 }
220}
221
222// This function highlights specified object (and removes previous highlight).
223function highlightObject (&$rackData, $object_id)
224{
225 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
226 for ($locidx = 0; $locidx < 3; $locidx++)
227 if
228 (
229 $rackData[$unit_no][$locidx]['state'] == 'T' and
230 $rackData[$unit_no][$locidx]['object_id'] == $object_id
231 )
232 $rackData[$unit_no][$locidx]['hl'] = 'h';
233 else
234 unset ($rackData[$unit_no][$locidx]['hl']);
235}
236
237// This function marks atoms to selected or not depending on their current state.
238function markupAtomGrid (&$data, $checked_state)
239{
240 for ($unit_no = $data['height']; $unit_no > 0; $unit_no--)
241 for ($locidx = 0; $locidx < 3; $locidx++)
242 {
243 if (!($data[$unit_no][$locidx]['enabled'] === TRUE))
244 continue;
245 if ($data[$unit_no][$locidx]['state'] == $checked_state)
246 $data[$unit_no][$locidx]['checked'] = ' checked';
247 else
248 $data[$unit_no][$locidx]['checked'] = '';
249 }
250}
251
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.
256function mergeGridFormToRack (&$rackData)
257{
258 $rack_id = $rackData['id'];
259 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
260 for ($locidx = 0; $locidx < 3; $locidx++)
261 {
262 if ($rackData[$unit_no][$locidx]['enabled'] != TRUE)
263 continue;
264 $inputname = "atom_${rack_id}_${unit_no}_${locidx}";
265 if (isset ($_REQUEST[$inputname]) and $_REQUEST[$inputname] == 'on')
266 $rackData[$unit_no][$locidx]['checked'] = ' checked';
267 else
268 $rackData[$unit_no][$locidx]['checked'] = '';
269 }
270}
271
bb0a44e9 272// netmask conversion from length to number
e673ee24
DO
273function binMaskFromDec ($maskL)
274{
bb0a44e9
DO
275 $map_straight = array (
276 0 => 0x00000000,
277 1 => 0x80000000,
278 2 => 0xc0000000,
279 3 => 0xe0000000,
280 4 => 0xf0000000,
281 5 => 0xf8000000,
282 6 => 0xfc000000,
283 7 => 0xfe000000,
284 8 => 0xff000000,
285 9 => 0xff800000,
286 10 => 0xffc00000,
287 11 => 0xffe00000,
288 12 => 0xfff00000,
289 13 => 0xfff80000,
290 14 => 0xfffc0000,
291 15 => 0xfffe0000,
292 16 => 0xffff0000,
293 17 => 0xffff8000,
294 18 => 0xffffc000,
295 19 => 0xffffe000,
296 20 => 0xfffff000,
297 21 => 0xfffff800,
298 22 => 0xfffffc00,
299 23 => 0xfffffe00,
300 24 => 0xffffff00,
301 25 => 0xffffff80,
302 26 => 0xffffffc0,
303 27 => 0xffffffe0,
304 28 => 0xfffffff0,
305 29 => 0xfffffff8,
306 30 => 0xfffffffc,
307 31 => 0xfffffffe,
308 32 => 0xffffffff,
309 );
310 return $map_straight[$maskL];
e673ee24
DO
311}
312
bb0a44e9 313// complementary value
e673ee24
DO
314function binInvMaskFromDec ($maskL)
315{
bb0a44e9
DO
316 $map_compl = array (
317 0 => 0xffffffff,
318 1 => 0x7fffffff,
319 2 => 0x3fffffff,
320 3 => 0x1fffffff,
321 4 => 0x0fffffff,
322 5 => 0x07ffffff,
323 6 => 0x03ffffff,
324 7 => 0x01ffffff,
325 8 => 0x00ffffff,
326 9 => 0x007fffff,
327 10 => 0x003fffff,
328 11 => 0x001fffff,
329 12 => 0x000fffff,
330 13 => 0x0007ffff,
331 14 => 0x0003ffff,
332 15 => 0x0001ffff,
333 16 => 0x0000ffff,
334 17 => 0x00007fff,
335 18 => 0x00003fff,
336 19 => 0x00001fff,
337 20 => 0x00000fff,
338 21 => 0x000007ff,
339 22 => 0x000003ff,
340 23 => 0x000001ff,
341 24 => 0x000000ff,
342 25 => 0x0000007f,
343 26 => 0x0000003f,
344 27 => 0x0000001f,
345 28 => 0x0000000f,
346 29 => 0x00000007,
347 30 => 0x00000003,
348 31 => 0x00000001,
349 32 => 0x00000000,
350 );
351 return $map_compl[$maskL];
e673ee24
DO
352}
353
e673ee24
DO
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.
358function markupObjectProblems (&$rackData)
359{
360 for ($i = $rackData['height']; $i > 0; $i--)
361 for ($locidx = 0; $locidx < 3; $locidx++)
362 if ($rackData[$i][$locidx]['state'] == 'T')
363 {
364 $object = getObjectInfo ($rackData[$i][$locidx]['object_id']);
365 if ($object['has_problems'] == 'yes')
366 {
367 // Object can be already highlighted.
368 if (isset ($rackData[$i][$locidx]['hl']))
369 $rackData[$i][$locidx]['hl'] = $rackData[$i][$locidx]['hl'] . 'w';
370 else
371 $rackData[$i][$locidx]['hl'] = 'w';
372 }
373 }
374}
375
376function search_cmpObj ($a, $b)
377{
378 return ($a['score'] > $b['score'] ? -1 : 1);
379}
380
ea5fc465 381function getObjectSearchResults ($terms)
e673ee24
DO
382{
383 $objects = array();
384 mergeSearchResults ($objects, $terms, 'name');
385 mergeSearchResults ($objects, $terms, 'label');
386 mergeSearchResults ($objects, $terms, 'asset_no');
387 mergeSearchResults ($objects, $terms, 'barcode');
388 if (count ($objects) == 1)
389 usort ($objects, 'search_cmpObj');
390 return $objects;
391}
392
393// This function removes all colons and dots from a string.
394function l2addressForDatabase ($string)
395{
396 if (empty ($string))
397 return 'NULL';
398 $pieces = explode (':', $string);
399 // This workaround is for SunOS ifconfig.
400 foreach ($pieces as &$byte)
401 if (strlen ($byte) == 1)
402 $byte = '0' . $byte;
403 // And this workaround is for PHP.
404 unset ($byte);
405 $string = implode ('', $pieces);
406 $pieces = explode ('.', $string);
407 $string = implode ('', $pieces);
408 $string = strtoupper ($string);
409 return "'$string'";
410}
411
412function l2addressFromDatabase ($string)
413{
414 switch (strlen ($string))
415 {
416 case 12: // Ethernet
417 case 16: // FireWire
418 $ret = implode (':', str_split ($string, 2));
419 break;
420 default:
421 $ret = $string;
422 break;
423 }
424 return $ret;
425}
426
427// The following 2 functions return previous and next rack IDs for
428// a given rack ID. The order of racks is the same as in renderRackspace()
429// or renderRow().
430function getPrevIDforRack ($row_id = 0, $rack_id = 0)
431{
432 if ($row_id <= 0 or $rack_id <= 0)
433 {
61e269b5 434 showError ('Invalid arguments passed', __FUNCTION__);
e673ee24
DO
435 return NULL;
436 }
437 $rackList = getRacksForRow ($row_id);
438 doubleLink ($rackList);
439 if (isset ($rackList[$rack_id]['prev_key']))
440 return $rackList[$rack_id]['prev_key'];
441 return NULL;
442}
443
444function getNextIDforRack ($row_id = 0, $rack_id = 0)
445{
446 if ($row_id <= 0 or $rack_id <= 0)
447 {
61e269b5 448 showError ('Invalid arguments passed', __FUNCTION__);
e673ee24
DO
449 return NULL;
450 }
451 $rackList = getRacksForRow ($row_id);
452 doubleLink ($rackList);
453 if (isset ($rackList[$rack_id]['next_key']))
454 return $rackList[$rack_id]['next_key'];
455 return NULL;
456}
457
458// This function finds previous and next array keys for each array key and
459// modifies its argument accordingly.
460function doubleLink (&$array)
461{
462 $prev_key = NULL;
463 foreach (array_keys ($array) as $key)
464 {
465 if ($prev_key)
466 {
467 $array[$key]['prev_key'] = $prev_key;
468 $array[$prev_key]['next_key'] = $key;
469 }
470 $prev_key = $key;
471 }
472}
473
474// After applying usort() to a rack list we will lose original array keys.
475// This function restores the keys so they are equal to rack IDs.
476function restoreRackIDs ($racks)
477{
478 $ret = array();
479 foreach ($racks as $rack)
480 $ret[$rack['id']] = $rack;
481 return $ret;
482}
483
484function sortTokenize ($a, $b)
485{
486 $aold='';
487 while ($a != $aold)
488 {
489 $aold=$a;
490 $a = ereg_replace('[^a-zA-Z0-9]',' ',$a);
491 $a = ereg_replace('([0-9])([a-zA-Z])','\\1 \\2',$a);
492 $a = ereg_replace('([a-zA-Z])([0-9])','\\1 \\2',$a);
493 }
494
495 $bold='';
496 while ($b != $bold)
497 {
498 $bold=$b;
499 $b = ereg_replace('[^a-zA-Z0-9]',' ',$b);
500 $b = ereg_replace('([0-9])([a-zA-Z])','\\1 \\2',$b);
501 $b = ereg_replace('([a-zA-Z])([0-9])','\\1 \\2',$b);
502 }
503
504
505
506 $ar = explode(' ', $a);
507 $br = explode(' ', $b);
508 for ($i=0; $i<count($ar) && $i<count($br); $i++)
509 {
510 $ret = 0;
511 if (is_numeric($ar[$i]) and is_numeric($br[$i]))
512 $ret = ($ar[$i]==$br[$i])?0:($ar[$i]<$br[$i]?-1:1);
513 else
514 $ret = strcasecmp($ar[$i], $br[$i]);
515 if ($ret != 0)
516 return $ret;
517 }
518 if ($i<count($ar))
519 return 1;
520 if ($i<count($br))
521 return -1;
522 return 0;
523}
524
525function sortByName ($a, $b)
526{
527 return sortTokenize($a['name'], $b['name']);
528}
529
6a3a37b2
DO
530function sortRacks ($a, $b)
531{
532 return sortTokenize($a['row_name'] . ': ' . $a['name'], $b['row_name'] . ': ' . $b['name']);
533}
534
e673ee24
DO
535function sortEmptyPorts ($a, $b)
536{
537 $objname_cmp = sortTokenize($a['Object_name'], $b['Object_name']);
538 if ($objname_cmp == 0)
539 {
540 return sortTokenize($a['Port_name'], $b['Port_name']);
541 }
542 return $objname_cmp;
543}
544
545function sortObjectAddressesAndNames ($a, $b)
546{
547 $objname_cmp = sortTokenize($a['object_name'], $b['object_name']);
548 if ($objname_cmp == 0)
549 {
79f22c3d
DO
550 $name_a = (isset ($a['port_name'])) ? $a['port_name'] : '';
551 $name_b = (isset ($b['port_name'])) ? $b['port_name'] : '';
552 $objname_cmp = sortTokenize($name_a, $name_b);
e673ee24 553 if ($objname_cmp == 0)
e673ee24 554 sortTokenize($a['ip'], $b['ip']);
e673ee24
DO
555 return $objname_cmp;
556 }
557 return $objname_cmp;
558}
559
e673ee24
DO
560function sortAddresses ($a, $b)
561{
562 $name_cmp = sortTokenize($a['name'], $b['name']);
563 if ($name_cmp == 0)
564 {
565 return sortTokenize($a['ip'], $b['ip']);
566 }
567 return $name_cmp;
568}
569
570// This function expands port compat list into a matrix.
571function buildPortCompatMatrixFromList ($portTypeList, $portCompatList)
572{
573 $matrix = array();
574 // Create type matrix and markup compatible types.
575 foreach (array_keys ($portTypeList) as $type1)
576 foreach (array_keys ($portTypeList) as $type2)
577 $matrix[$type1][$type2] = FALSE;
578 foreach ($portCompatList as $pair)
579 $matrix[$pair['type1']][$pair['type2']] = TRUE;
580 return $matrix;
581}
582
c31cd72c 583// This function returns an array of single element of object's FQDN attribute,
f321b50a
DO
584// if FQDN is set. The next choice is object's common name, if it looks like a
585// hostname. Otherwise an array of all 'regular' IP addresses of the
c31cd72c 586// object is returned (which may appear 0 and more elements long).
f321b50a 587function findAllEndpoints ($object_id, $fallback = '')
c31cd72c
DO
588{
589 $values = getAttrValues ($object_id);
590 foreach ($values as $record)
f321b50a 591 if ($record['name'] == 'FQDN' && !empty ($record['value']))
c31cd72c 592 return array ($record['value']);
c31cd72c 593 $regular = array();
85970da2
DO
594 foreach (getObjectIPv4Allocations ($object_id) as $dottedquad => $alloc)
595 if ($alloc['type'] == 'regular')
596 $regular[] = $dottedquad;
f321b50a
DO
597 if (!count ($regular) && !empty ($fallback))
598 return array ($fallback);
c31cd72c
DO
599 return $regular;
600}
601
83ba6670
DO
602// Some records in the dictionary may be written as plain text or as Wiki
603// link in the following syntax:
604// 1. word
605// 2. [[word URL]] // FIXME: this isn't working
606// 3. [[word word word | URL]]
607// This function parses the line and returns text suitable for either A
608// (rendering <A HREF>) or O (for <OPTION>).
24cbe8af 609function parseWikiLink ($line, $which, $strip_optgroup = FALSE)
83ba6670 610{
010231c2 611 if (preg_match ('/^\[\[.+\]\]$/', $line) == 0)
24cbe8af
DO
612 {
613 if ($strip_optgroup)
f0b540a3 614 return ereg_replace ('^.+%GSKIP%', '', ereg_replace ('^(.+)%GPASS%', '\\1 ', $line));
24cbe8af
DO
615 else
616 return $line;
617 }
010231c2
DO
618 $line = preg_replace ('/^\[\[(.+)\]\]$/', '$1', $line);
619 $s = explode ('|', $line);
83ba6670 620 $o_value = trim ($s[0]);
24cbe8af 621 if ($strip_optgroup)
f0b540a3 622 $o_value = ereg_replace ('^.+%GSKIP%', '', ereg_replace ('^(.+)%GPASS%', '\\1 ', $o_value));
83ba6670
DO
623 $a_value = trim ($s[1]);
624 if ($which == 'a')
010231c2 625 return "<a href='${a_value}'>${o_value}</a>";
83ba6670
DO
626 if ($which == 'o')
627 return $o_value;
628}
629
2de490b7
DO
630function buildVServiceName ($vsinfo = NULL)
631{
632 if ($vsinfo == NULL)
633 {
634 showError ('NULL argument', __FUNCTION__);
635 return NULL;
636 }
8d790216 637 return $vsinfo['vip'] . ':' . $vsinfo['vport'] . '/' . $vsinfo['proto'];
2de490b7
DO
638}
639
05411ccd
DO
640function buildRSPoolName ($rspool = NULL)
641{
642 if ($rspool == NULL)
643 {
644 showError ('NULL argument', __FUNCTION__);
645 return NULL;
646 }
647 return strlen ($rspool['name']) ? $rspool['name'] : 'ANONYMOUS pool';
648}
649
177b1e9b
DO
650// rackspace usage for a single rack
651// (T + W + U) / (height * 3 - A)
11df133a 652function getRSUforRack ($data = NULL)
177b1e9b 653{
11df133a 654 if ($data == NULL)
177b1e9b
DO
655 {
656 showError ('Invalid argument', __FUNCTION__);
657 return NULL;
658 }
6ffba290 659 $counter = array ('A' => 0, 'U' => 0, 'T' => 0, 'W' => 0, 'F' => 0);
9e60f7df
DO
660 for ($unit_no = $data['height']; $unit_no > 0; $unit_no--)
661 for ($locidx = 0; $locidx < 3; $locidx++)
662 $counter[$data[$unit_no][$locidx]['state']]++;
dfa3c075 663 return ($counter['T'] + $counter['W'] + $counter['U']) / ($counter['T'] + $counter['W'] + $counter['U'] + $counter['F']);
177b1e9b
DO
664}
665
11df133a
DO
666// Same for row.
667function getRSUforRackRow ($rowData = NULL)
668{
bb26a59e 669 if ($rowData === NULL)
11df133a
DO
670 {
671 showError ('Invalid argument', __FUNCTION__);
672 return NULL;
673 }
bb26a59e
DO
674 if (!count ($rowData))
675 return 0;
11df133a 676 $counter = array ('A' => 0, 'U' => 0, 'T' => 0, 'W' => 0, 'F' => 0);
f81a2012 677 $total_height = 0;
dfa3c075
DO
678 foreach (array_keys ($rowData) as $rack_id)
679 {
680 $data = getRackData ($rack_id);
681 $total_height += $data['height'];
11df133a
DO
682 for ($unit_no = $data['height']; $unit_no > 0; $unit_no--)
683 for ($locidx = 0; $locidx < 3; $locidx++)
684 $counter[$data[$unit_no][$locidx]['state']]++;
dfa3c075
DO
685 }
686 return ($counter['T'] + $counter['W'] + $counter['U']) / ($counter['T'] + $counter['W'] + $counter['U'] + $counter['F']);
11df133a
DO
687}
688
abef7149
DO
689// Return a list of object IDs, which can be found in the given rackspace block.
690function stuffInRackspace ($rackData)
f1a0477d
DO
691{
692 $objects = array();
693 for ($i = $rackData['height']; $i > 0; $i--)
694 for ($locidx = 0; $locidx < 3; $locidx++)
695 if
696 (
697 $rackData[$i][$locidx]['state'] == 'T' and
698 !in_array ($rackData[$i][$locidx]['object_id'], $objects)
699 )
700 $objects[] = $rackData[$i][$locidx]['object_id'];
abef7149 701 return $objects;
f1a0477d
DO
702}
703
9af110b4
DO
704// Make sure the string is always wrapped with LF characters
705function lf_wrap ($str)
706{
707 $ret = trim ($str, "\r\n");
708 if (!empty ($ret))
709 $ret .= "\n";
710 return $ret;
711}
712
e6e7d8b3
DO
713// Adopted from Mantis BTS code.
714function string_insert_hrefs ($s)
715{
716 if (getConfigVar ('DETECT_URLS') != 'yes')
717 return $s;
718 # Find any URL in a string and replace it by a clickable link
719 $s = preg_replace( '/(([[:alpha:]][-+.[:alnum:]]*):\/\/(%[[:digit:]A-Fa-f]{2}|[-_.!~*\';\/?%^\\\\:@&={\|}+$#\(\),\[\][:alnum:]])+)/se',
720 "'<a href=\"'.rtrim('\\1','.').'\">\\1</a> [<a href=\"'.rtrim('\\1','.').'\" target=\"_blank\">^</a>]'",
721 $s);
722 $s = preg_replace( '/\b' . email_regex_simple() . '\b/i',
723 '<a href="mailto:\0">\0</a>',
724 $s);
725 return $s;
726}
727
728// Idem.
729function email_regex_simple ()
730{
731 return "(([a-z0-9!#*+\/=?^_{|}~-]+(?:\.[a-z0-9!#*+\/=?^_{|}~-]+)*)" . # recipient
732 "\@((?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?))"; # @domain
733}
734
118e4c38
DO
735// Parse AUTOPORTS_CONFIG and return a list of generated pairs (port_type, port_name)
736// for the requested object_type_id.
737function getAutoPorts ($type_id)
738{
739 $ret = array();
740 $typemap = explode (';', str_replace (' ', '', getConfigVar ('AUTOPORTS_CONFIG')));
741 foreach ($typemap as $equation)
742 {
743 $tmp = explode ('=', $equation);
744 if (count ($tmp) != 2)
745 continue;
746 $objtype_id = $tmp[0];
747 if ($objtype_id != $type_id)
748 continue;
749 $portlist = $tmp[1];
750 foreach (explode ('+', $portlist) as $product)
751 {
752 $tmp = explode ('*', $product);
753 if (count ($tmp) != 3)
754 continue;
755 $nports = $tmp[0];
756 $port_type = $tmp[1];
757 $format = $tmp[2];
758 for ($i = 0; $i < $nports; $i++)
759 $ret[] = array ('type' => $port_type, 'name' => @sprintf ($format, $i));
760 }
761 }
762 return $ret;
763}
764
9dfd4cc9
DO
765// Find if a particular tag id exists on the tree, then attach the
766// given child tag to it. If the parent tag doesn't exist, return FALSE.
51b6651a 767function attachChildTag (&$tree, $parent_id, $child_id, $child_info, $threshold = 0)
9dfd4cc9 768{
51b6651a 769 $self = __FUNCTION__;
048b53b9 770 foreach (array_keys ($tree) as $tagid)
9dfd4cc9
DO
771 {
772 if ($tagid == $parent_id)
773 {
51b6651a
DO
774 if (!$threshold or ($threshold and $tree[$tagid]['kidc'] + 1 < $threshold))
775 $tree[$tagid]['kids'][$child_id] = $child_info;
776 // Reset the list only once.
777 if (++$tree[$tagid]['kidc'] == $threshold)
778 $tree[$tagid]['kids'] = array();
9dfd4cc9
DO
779 return TRUE;
780 }
51b6651a 781 elseif ($self ($tree[$tagid]['kids'], $parent_id, $child_id, $child_info, $threshold))
9dfd4cc9
DO
782 return TRUE;
783 }
784 return FALSE;
785}
786
d65353ad
DO
787// Build a tree from the item list and return it. Input and output data is
788// indexed by item id (nested items in output are recursively stored in 'kids'
51b6651a
DO
789// key, which is in turn indexed by id. Functions, which are ready to handle
790// tree collapsion/expansion themselves, may request non-zero threshold value
791// for smaller resulting tree.
792function treeFromList ($mytaglist, $threshold = 0)
d65353ad 793{
20c901a7
DO
794 $ret = array();
795 while (count ($mytaglist) > 0)
9dfd4cc9
DO
796 {
797 $picked = FALSE;
20c901a7 798 foreach ($mytaglist as $tagid => $taginfo)
9dfd4cc9 799 {
51b6651a 800 $taginfo['kidc'] = 0;
9dfd4cc9
DO
801 $taginfo['kids'] = array();
802 if ($taginfo['parent_id'] == NULL)
803 {
20c901a7 804 $ret[$tagid] = $taginfo;
9dfd4cc9 805 $picked = TRUE;
20c901a7 806 unset ($mytaglist[$tagid]);
9dfd4cc9 807 }
51b6651a 808 elseif (attachChildTag ($ret, $taginfo['parent_id'], $tagid, $taginfo, $threshold))
9dfd4cc9
DO
809 {
810 $picked = TRUE;
20c901a7 811 unset ($mytaglist[$tagid]);
9dfd4cc9
DO
812 }
813 }
814 if (!$picked) // Only orphaned items on the list.
815 break;
816 }
20c901a7 817 return $ret;
9dfd4cc9
DO
818}
819
49fb1027
DO
820// Build a tree from the tag list and return everything _except_ the tree.
821function getOrphanedTags ()
822{
823 global $taglist;
824 $mytaglist = $taglist;
825 $dummy = array();
826 while (count ($mytaglist) > 0)
827 {
828 $picked = FALSE;
829 foreach ($mytaglist as $tagid => $taginfo)
830 {
831 $taginfo['kids'] = array();
832 if ($taginfo['parent_id'] == NULL)
833 {
834 $dummy[$tagid] = $taginfo;
835 $picked = TRUE;
836 unset ($mytaglist[$tagid]);
837 }
838 elseif (attachChildTag ($dummy, $taginfo['parent_id'], $tagid, $taginfo))
839 {
840 $picked = TRUE;
841 unset ($mytaglist[$tagid]);
842 }
843 }
844 if (!$picked) // Only orphaned items on the list.
845 return $mytaglist;
846 }
847 return array();
848}
849
6e49bd1f 850function serializeTags ($chain, $baseurl = '')
ba93bd98
DO
851{
852 $comma = '';
853 $ret = '';
6e49bd1f 854 foreach ($chain as $taginfo)
ba93bd98 855 {
e2ac59cf
DO
856 $ret .= $comma .
857 ($baseurl == '' ? '' : "<a href='${baseurl}tagfilter[]=${taginfo['id']}'>") .
858 $taginfo['tag'] .
859 ($baseurl == '' ? '' : '</a>');
ba93bd98
DO
860 $comma = ', ';
861 }
862 return $ret;
863}
864
3b81cb98
DO
865// For each tag add all its parent tags onto the list. Don't expect anything
866// except user's tags on the chain.
867function getTagChainExpansion ($chain, $tree = NULL)
ba93bd98 868{
51b6651a 869 $self = __FUNCTION__;
3b81cb98
DO
870 if ($tree === NULL)
871 {
872 global $tagtree;
873 $tree = $tagtree;
874 }
ba93bd98 875 // For each tag find its path from the root, then combine items
6e49bd1f 876 // of all paths and add them to the chain, if they aren't there yet.
ba93bd98
DO
877 $ret = array();
878 foreach ($tree as $taginfo1)
879 {
880 $hit = FALSE;
6e49bd1f 881 foreach ($chain as $taginfo2)
ba93bd98
DO
882 if ($taginfo1['id'] == $taginfo2['id'])
883 {
884 $hit = TRUE;
885 break;
886 }
887 if (count ($taginfo1['kids']) > 0)
888 {
3b81cb98 889 $subsearch = $self ($chain, $taginfo1['kids']);
ba93bd98
DO
890 if (count ($subsearch))
891 {
892 $hit = TRUE;
893 $ret = array_merge ($ret, $subsearch);
894 }
895 }
896 if ($hit)
897 $ret[] = $taginfo1;
898 }
899 return $ret;
900}
901
ba93bd98
DO
902// Return the list of missing implicit tags.
903function getImplicitTags ($oldtags)
904{
905 $ret = array();
6e49bd1f 906 $newtags = getTagChainExpansion ($oldtags);
ba93bd98
DO
907 foreach ($newtags as $newtag)
908 {
909 $already_exists = FALSE;
910 foreach ($oldtags as $oldtag)
911 if ($newtag['id'] == $oldtag['id'])
912 {
913 $already_exists = TRUE;
914 break;
915 }
916 if ($already_exists)
917 continue;
d6089951 918 $ret[] = array ('id' => $newtag['id'], 'tag' => $newtag['tag'], 'parent_id' => $newtag['parent_id']);
ba93bd98
DO
919 }
920 return $ret;
921}
922
6e49bd1f
DO
923// Minimize the chain: exclude all implicit tags and return the result.
924function getExplicitTagsOnly ($chain, $tree = NULL)
ab379543 925{
51b6651a 926 $self = __FUNCTION__;
20c901a7 927 global $tagtree;
ab379543 928 if ($tree === NULL)
20c901a7 929 $tree = $tagtree;
ab379543
DO
930 $ret = array();
931 foreach ($tree as $taginfo)
932 {
933 if (isset ($taginfo['kids']))
934 {
51b6651a 935 $harvest = $self ($chain, $taginfo['kids']);
ab379543
DO
936 if (count ($harvest) > 0)
937 {
938 $ret = array_merge ($ret, $harvest);
939 continue;
940 }
941 }
942 // This tag isn't implicit, test is for being explicit.
6e49bd1f 943 foreach ($chain as $testtag)
ab379543
DO
944 if ($taginfo['id'] == $testtag['id'])
945 {
946 $ret[] = $testtag;
947 break;
948 }
949 }
950 return $ret;
951}
952
6e49bd1f 953// Maximize the chain: for each tag add all tags, for which it is direct or indirect parent.
74ccacff 954// Unlike other functions, this one accepts and returns a list of integer tag IDs, not
e07bb730 955// a list of tag structures. Same structure (tag ID list) is returned after processing.
74ccacff
DO
956function complementByKids ($idlist, $tree = NULL, $getall = FALSE)
957{
51b6651a 958 $self = __FUNCTION__;
20c901a7 959 global $tagtree;
74ccacff 960 if ($tree === NULL)
20c901a7 961 $tree = $tagtree;
74ccacff
DO
962 $getallkids = $getall;
963 $ret = array();
964 foreach ($tree as $taginfo)
965 {
966 foreach ($idlist as $test_id)
967 if ($getall or $taginfo['id'] == $test_id)
968 {
969 $ret[] = $taginfo['id'];
970 // Once matched node makes all sub-nodes match, but don't make
971 // a mistake of matching every other node at the current level.
972 $getallkids = TRUE;
973 break;
974 }
975 if (isset ($taginfo['kids']))
51b6651a 976 $ret = array_merge ($ret, $self ($idlist, $taginfo['kids'], $getallkids));
74ccacff
DO
977 $getallkids = FALSE;
978 }
979 return $ret;
980}
981
cce6b057
DO
982function getUserAutoTags ($username = NULL)
983{
984 global $remote_username, $accounts;
985 if ($username == NULL)
986 $username = $remote_username;
987 $ret = array();
988 $ret[] = array ('tag' => '$username_' . $username);
989 if (isset ($accounts[$username]['user_id']))
990 $ret[] = array ('tag' => '$userid_' . $accounts[$username]['user_id']);
991 return $ret;
992}
993
68225375 994function loadRackObjectAutoTags ()
ba93bd98 995{
2c6c7645 996 assertUIntArg ('object_id', __FUNCTION__);
2fb24351
DO
997 $object_id = $_REQUEST['object_id'];
998 $oinfo = getObjectInfo ($object_id);
999 $ret = array();
0e692350 1000 $ret[] = array ('tag' => '$id_' . $object_id);
fae80c2b 1001 $ret[] = array ('tag' => '$typeid_' . $oinfo['objtype_id']);
d817ba03 1002 $ret[] = array ('tag' => '$any_object');
c396cbf4
DO
1003 if (validTagName ($oinfo['name']))
1004 $ret[] = array ('tag' => '$cn_' . $oinfo['name']);
2fb24351
DO
1005 return $ret;
1006}
1007
68225375 1008// Common code for both prefix and address tag listers.
bb0a44e9 1009function getIPv4PrefixTags ($netid)
f9bc186f 1010{
bb0a44e9 1011 $netinfo = getIPv4NetworkInfo ($netid);
f9bc186f 1012 $ret = array();
bb0a44e9 1013 $ret[] = array ('tag' => '$ip4net-' . str_replace ('.', '-', $netinfo['ip']) . '-' . $netinfo['mask']);
da958e52
DO
1014 // FIXME: find and list tags for all parent networks?
1015 $ret[] = array ('tag' => '$any_ip4net');
d817ba03 1016 $ret[] = array ('tag' => '$any_net');
41bd8c87
DO
1017 return $ret;
1018}
1019
68225375 1020function loadIPv4PrefixAutoTags ()
41bd8c87 1021{
68225375
DO
1022 assertUIntArg ('id', __FUNCTION__);
1023 return array_merge
1024 (
da958e52 1025 array (array ('tag' => '$ip4netid_' . $_REQUEST['id'])),
bb0a44e9 1026 getIPv4PrefixTags ($_REQUEST['id'])
68225375 1027 );
d817ba03
DO
1028}
1029
68225375 1030function loadIPv4AddressAutoTags ()
d817ba03 1031{
2c6c7645 1032 assertIPv4Arg ('ip', __FUNCTION__);
68225375
DO
1033 return array_merge
1034 (
da958e52 1035 array (array ('tag' => '$ip4net-' . str_replace ('.', '-', $_REQUEST['ip']) . '-32')),
bb0a44e9 1036 getIPv4PrefixTags (getIPv4AddressNetworkId ($_REQUEST['ip']))
68225375
DO
1037 );
1038}
1039
1040function loadRackAutoTags ()
1041{
1042 assertUIntArg ('rack_id', __FUNCTION__);
d817ba03 1043 $ret = array();
da958e52 1044 $ret[] = array ('tag' => '$rackid_' . $_REQUEST['rack_id']);
68225375 1045 $ret[] = array ('tag' => '$any_rack');
d817ba03
DO
1046 return $ret;
1047}
1048
68225375 1049function loadIPv4VSAutoTags ()
d817ba03 1050{
49fb2686 1051 assertUIntArg ('vs_id', __FUNCTION__);
d817ba03 1052 $ret = array();
0e692350 1053 $ret[] = array ('tag' => '$ipv4vsid_' . $_REQUEST['vs_id']);
d817ba03
DO
1054 $ret[] = array ('tag' => '$any_ipv4vs');
1055 $ret[] = array ('tag' => '$any_vs');
1056 return $ret;
1057}
1058
68225375 1059function loadIPv4RSPoolAutoTags ()
d817ba03 1060{
2c6c7645 1061 assertUIntArg ('pool_id', __FUNCTION__);
d817ba03 1062 $ret = array();
0e692350
DO
1063 $ret[] = array ('tag' => '$ipv4rspid_' . $_REQUEST['pool_id']);
1064 $ret[] = array ('tag' => '$any_ipv4rsp');
1065 $ret[] = array ('tag' => '$any_rsp');
f9bc186f
DO
1066 return $ret;
1067}
1068
abef7149
DO
1069// Check, if the given tag is present on the chain (will only work
1070// for regular tags with tag ID set.
1071function tagOnChain ($taginfo, $tagchain)
1072{
1073 if (!isset ($taginfo['id']))
1074 return FALSE;
1075 foreach ($tagchain as $test)
1076 if ($test['id'] == $taginfo['id'])
1077 return TRUE;
1078 return FALSE;
1079}
1080
1081// Idem, but use ID list instead of chain.
1082function tagOnIdList ($taginfo, $tagidlist)
1083{
1084 if (!isset ($taginfo['id']))
1085 return FALSE;
1086 foreach ($tagidlist as $tagid)
61a61189 1087 if ($taginfo['id'] == $tagid)
abef7149
DO
1088 return TRUE;
1089 return FALSE;
1090}
1091
1092// Return TRUE, if two tags chains differ (order of tags doesn't matter).
1093// Assume, that neither of the lists contains duplicates.
1094// FIXME: a faster, than O(x^2) method is possible for this calculation.
1095function tagChainCmp ($chain1, $chain2)
1096{
1097 if (count ($chain1) != count ($chain2))
1098 return TRUE;
1099 foreach ($chain1 as $taginfo1)
1100 if (!tagOnChain ($taginfo1, $chain2))
1101 return TRUE;
1102 return FALSE;
1103}
1104
53bae67b
DO
1105// If the page-tab-op triplet is final, make $expl_tags and $impl_tags
1106// hold all appropriate (explicit and implicit) tags respectively.
1107// Otherwise some limited redirection is necessary (only page and tab
1108// names are preserved, ophandler name change isn't handled).
da958e52
DO
1109function fixContext ()
1110{
1111 global $pageno, $tabno, $auto_tags, $expl_tags, $impl_tags, $page;
53bae67b
DO
1112
1113 $pmap = array
1114 (
1115 'accounts' => 'userlist',
1116 'rspools' => 'ipv4rsplist',
1117 'rspool' => 'ipv4rsp',
1118 'vservices' => 'ipv4vslist',
1119 'vservice' => 'ipv4vs',
1120 );
1121 $tmap = array();
1122 $tmap['objects']['newmulti'] = 'addmore';
1123 $tmap['objects']['newobj'] = 'addmore';
1124 $tmap['object']['switchvlans'] = 'livevlans';
1125 $tmap['object']['slb'] = 'editrspvs';
72d8ced3
DO
1126 $tmap['object']['portfwrd'] = 'nat4';
1127 $tmap['object']['network'] = 'ipv4';
53bae67b
DO
1128 if (isset ($pmap[$pageno]))
1129 redirectUser ($pmap[$pageno], $tabno);
1130 if (isset ($tmap[$pageno][$tabno]))
1131 redirectUser ($pageno, $tmap[$pageno][$tabno]);
1132
da958e52
DO
1133 if (isset ($page[$pageno]['autotagloader']))
1134 $auto_tags = $page[$pageno]['autotagloader'] ();
1135 if
1136 (
1137 isset ($page[$pageno]['tagloader']) and
1138 isset ($page[$pageno]['bypass']) and
1139 isset ($_REQUEST[$page[$pageno]['bypass']])
1140 )
1141 {
1142 $expl_tags = $page[$pageno]['tagloader'] ($_REQUEST[$page[$pageno]['bypass']]);
1143 $impl_tags = getImplicitTags ($expl_tags);
1144 }
1145}
1146
abef7149
DO
1147// Take a list of user-supplied tag IDs to build a list of valid taginfo
1148// records indexed by tag IDs (tag chain).
6e49bd1f 1149function buildTagChainFromIds ($tagidlist)
ab379543 1150{
20c901a7 1151 global $taglist;
ab379543 1152 $ret = array();
abef7149 1153 foreach (array_unique ($tagidlist) as $tag_id)
ab379543
DO
1154 if (isset ($taglist[$tag_id]))
1155 $ret[] = $taglist[$tag_id];
1156 return $ret;
1157}
1158
7cc02fc1
DO
1159// Process a given tag tree and return only meaningful branches. The resulting
1160// (sub)tree will have refcnt leaves on every last branch.
1161function getObjectiveTagTree ($tree, $realm)
1162{
51b6651a 1163 $self = __FUNCTION__;
7cc02fc1
DO
1164 $ret = array();
1165 foreach ($tree as $taginfo)
1166 {
1167 $subsearch = array();
1168 $pick = FALSE;
1169 if (count ($taginfo['kids']))
1170 {
51b6651a 1171 $subsearch = $self ($taginfo['kids'], $realm);
7cc02fc1
DO
1172 $pick = count ($subsearch) > 0;
1173 }
5bdc04ec 1174 if (isset ($taginfo['refcnt'][$realm]))
7cc02fc1
DO
1175 $pick = TRUE;
1176 if (!$pick)
1177 continue;
1178 $ret[] = array
1179 (
1180 'id' => $taginfo['id'],
1181 'tag' => $taginfo['tag'],
1182 'parent_id' => $taginfo['parent_id'],
1183 'refcnt' => $taginfo['refcnt'],
1184 'kids' => $subsearch
1185 );
1186 }
1187 return $ret;
1188}
1189
a0d54e7e 1190function getTagFilter ()
7cc02fc1 1191{
a0d54e7e 1192 return isset ($_REQUEST['tagfilter']) ? complementByKids ($_REQUEST['tagfilter']) : array();
7cc02fc1
DO
1193}
1194
a0d54e7e 1195function getTagFilterStr ($tagfilter = array())
932cf41f 1196{
a0d54e7e 1197 $ret = '';
6e49bd1f 1198 foreach (getExplicitTagsOnly (buildTagChainFromIds ($tagfilter)) as $taginfo)
a0d54e7e
DO
1199 $ret .= "&tagfilter[]=" . $taginfo['id'];
1200 return $ret;
932cf41f 1201}
a0d54e7e 1202
baf37d01 1203function buildWideRedirectURL ($log, $nextpage = NULL, $nexttab = NULL)
da958e52 1204{
46f92ff7 1205 global $root, $page, $pageno, $tabno;
baf37d01
DO
1206 if ($nextpage === NULL)
1207 $nextpage = $pageno;
1208 if ($nexttab === NULL)
1209 $nexttab = $tabno;
1210 $url = "${root}?page=${nextpage}&tab=${nexttab}";
1211 if (isset ($page[$nextpage]['bypass']))
1212 $url .= '&' . $page[$nextpage]['bypass'] . '=' . $_REQUEST[$page[$nextpage]['bypass']];
0f3c6639 1213 $url .= "&log=" . urlencode (base64_encode (serialize ($log)));
da958e52
DO
1214 return $url;
1215}
1216
ebb5441d 1217function buildRedirectURL ($status, $args = array(), $nextpage = NULL, $nexttab = NULL)
46f92ff7 1218{
baf37d01
DO
1219 global $msgcode, $pageno, $tabno, $op;
1220 if ($nextpage === NULL)
1221 $nextpage = $pageno;
1222 if ($nexttab === NULL)
1223 $nexttab = $tabno;
2987fc1f
DO
1224 return buildWideRedirectURL (oneLiner ($msgcode[$pageno][$tabno][$op][$status], $args), $nextpage, $nexttab);
1225}
1226
1227// Return a message log consisting of only one message.
1228function oneLiner ($code, $args = array())
1229{
1230 $ret = array ('v' => 2);
1231 $ret['m'][] = count ($args) ? array ('c' => $code, 'a' => $args) : array ('c' => $code);
1232 return $ret;
46f92ff7
DO
1233}
1234
f19c75d6
DO
1235// Return mesage code by status code.
1236function getMessageCode ($status)
1237{
1238 global $pageno, $tabno, $op, $msgcode;
1239 return $msgcode[$pageno][$tabno][$op][$status];
1240}
1241
9f54e6e9 1242function validTagName ($s, $allow_autotag = FALSE)
2eeeca80 1243{
9f54e6e9
DO
1244 if (1 == mb_ereg (TAGNAME_REGEXP, $s))
1245 return TRUE;
1246 if ($allow_autotag and 1 == mb_ereg (AUTOTAGNAME_REGEXP, $s))
1247 return TRUE;
1248 return FALSE;
2eeeca80
DO
1249}
1250
53bae67b
DO
1251function redirectUser ($p, $t)
1252{
1253 global $page, $root;
1254 $l = "{$root}?page=${p}&tab=${t}";
1255 if (isset ($page[$p]['bypass']) and isset ($_REQUEST[$page[$p]['bypass']]))
1256 $l .= '&' . $page[$p]['bypass'] . '=' . $_REQUEST[$page[$p]['bypass']];
1257 header ("Location: " . $l);
1258 die;
1259}
1260
9f3e5caa
DO
1261function getRackCodeStats ()
1262{
1263 global $rackCode;
1264 $defc = $grantc = 0;
1265 foreach ($rackCode as $s)
1266 switch ($s['type'])
1267 {
1268 case 'SYNT_DEFINITION':
1269 $defc++;
1270 break;
1271 case 'SYNT_GRANT':
1272 $grantc++;
1273 break;
1274 default:
1275 break;
1276 }
1277 $ret = array ('Definition sentences' => $defc, 'Grant sentences' => $grantc);
1278 return $ret;
1279}
1280
d5157018
DO
1281function getRackImageWidth ()
1282{
1283 return 3 + getConfigVar ('rtwidth_0') + getConfigVar ('rtwidth_1') + getConfigVar ('rtwidth_2') + 3;
1284}
1285
1286function getRackImageHeight ($units)
1287{
1288 return 3 + 3 + $units * 2;
1289}
1290
2987fc1f
DO
1291// Perform substitutions and return resulting string
1292// used solely by buildLVSConfig()
1293function apply_macros ($macros, $subject)
1294{
1295 $ret = $subject;
1296 foreach ($macros as $search => $replace)
1297 $ret = str_replace ($search, $replace, $ret);
1298 return $ret;
1299}
1300
1301function buildLVSConfig ($object_id = 0)
1302{
1303 if ($object_id <= 0)
1304 {
1305 showError ('Invalid argument', __FUNCTION__);
1306 return;
1307 }
1308 $oInfo = getObjectInfo ($object_id);
1309 $lbconfig = getSLBConfig ($object_id);
1310 if ($lbconfig === NULL)
1311 {
1312 showError ('getSLBConfig() failed', __FUNCTION__);
1313 return;
1314 }
1315 $newconfig = "#\n#\n# This configuration has been generated automatically by RackTables\n";
1316 $newconfig .= "# for object_id == ${object_id}\n# object name: ${oInfo['name']}\n#\n#\n\n\n";
1317 foreach ($lbconfig as $vs_id => $vsinfo)
1318 {
1319 $newconfig .= "########################################################\n" .
1320 "# VS (id == ${vs_id}): " . (empty ($vsinfo['vs_name']) ? 'NO NAME' : $vsinfo['vs_name']) . "\n" .
1321 "# RS pool (id == ${vsinfo['pool_id']}): " . (empty ($vsinfo['pool_name']) ? 'ANONYMOUS' : $vsinfo['pool_name']) . "\n" .
1322 "########################################################\n";
1323 # The order of inheritance is: VS -> LB -> pool [ -> RS ]
1324 $macros = array
1325 (
1326 '%VIP%' => $vsinfo['vip'],
1327 '%VPORT%' => $vsinfo['vport'],
1328 '%PROTO%' => $vsinfo['proto'],
1329 '%VNAME%' => $vsinfo['vs_name'],
1330 '%RSPOOLNAME%' => $vsinfo['pool_name']
1331 );
1332 $newconfig .= "virtual_server ${vsinfo['vip']} ${vsinfo['vport']} {\n";
1333 $newconfig .= "\tprotocol ${vsinfo['proto']}\n";
1334 $newconfig .= apply_macros
1335 (
1336 $macros,
1337 lf_wrap ($vsinfo['vs_vsconfig']) .
1338 lf_wrap ($vsinfo['lb_vsconfig']) .
1339 lf_wrap ($vsinfo['pool_vsconfig'])
1340 );
1341 foreach ($vsinfo['rslist'] as $rs)
1342 {
79a9edb4
DO
1343 if (empty ($rs['rsport']))
1344 $rs['rsport'] = $vsinfo['vport'];
2987fc1f
DO
1345 $macros['%RSIP%'] = $rs['rsip'];
1346 $macros['%RSPORT%'] = $rs['rsport'];
1347 $newconfig .= "\treal_server ${rs['rsip']} ${rs['rsport']} {\n";
1348 $newconfig .= apply_macros
1349 (
1350 $macros,
1351 lf_wrap ($vsinfo['vs_rsconfig']) .
1352 lf_wrap ($vsinfo['lb_rsconfig']) .
1353 lf_wrap ($vsinfo['pool_rsconfig']) .
1354 lf_wrap ($rs['rs_rsconfig'])
1355 );
1356 $newconfig .= "\t}\n";
1357 }
1358 $newconfig .= "}\n\n\n";
1359 }
3dd72e34
DO
1360 // FIXME: deal somehow with Mac-styled text, the below replacement will screw it up
1361 return str_replace ("\r", '', $newconfig);
2987fc1f
DO
1362}
1363
2d318652
DO
1364// Indicate occupation state of each IP address: none, ordinary or problematic.
1365function markupIPv4AddrList (&$addrlist)
1366{
1367 foreach (array_keys ($addrlist) as $ip_bin)
1368 {
d983f70a
DO
1369 $refc = array
1370 (
00c5d8cb
DO
1371 'shared' => 0, // virtual
1372 'virtual' => 0, // loopback
1373 'regular' => 0, // connected host
1374 'router' => 0 // connected gateway
d983f70a
DO
1375 );
1376 foreach ($addrlist[$ip_bin]['allocs'] as $a)
1377 $refc[$a['type']]++;
00c5d8cb 1378 $nvirtloopback = ($refc['shared'] + $refc['virtual'] > 0) ? 1 : 0; // modulus of virtual + shared
d983f70a
DO
1379 $nreserved = ($addrlist[$ip_bin]['reserved'] == 'yes') ? 1 : 0; // only one reservation is possible ever
1380 $nrealms = $nreserved + $nvirtloopback + $refc['regular'] + $refc['router']; // latter two are connected and router allocations
2d318652
DO
1381
1382 if ($nrealms == 1)
1383 $addrlist[$ip_bin]['class'] = 'trbusy';
1384 elseif ($nrealms > 1)
1385 $addrlist[$ip_bin]['class'] = 'trerror';
1386 else
1387 $addrlist[$ip_bin]['class'] = '';
1388 }
1389}
1390
04d619d0
DO
1391// Scan the given address list (returned by scanIPv4Space) and return a list of all routers found.
1392function findRouters ($addrlist)
1393{
1394 $ret = array();
1395 foreach ($addrlist as $addr)
1396 foreach ($addr['allocs'] as $alloc)
1397 if ($alloc['type'] == 'router')
1398 $ret[] = array
1399 (
1400 'id' => $alloc['object_id'],
1401 'iface' => $alloc['name'],
1402 'dname' => $alloc['object_name'],
1403 'addr' => $addr['ip']
1404 );
1405 return $ret;
1406}
1407
fb7a4967
DO
1408// Assist in tag chain sorting.
1409function taginfoCmp ($tagA, $tagB)
1410{
1411 return $tagA['ci'] - $tagB['ci'];
1412}
1413
1327d9dd
DO
1414// Compare networks. When sorting a tree, the records on the list will have
1415// distinct base IP addresses.
1416function IPv4NetworkCmp ($netA, $netB)
1417{
2d75c30b
DO
1418// return bccomp ("${netA['db_first']}", "${netB['db_first']}");
1419 // There's a problem just substracting one u32 integer from another,
1420 // because the result may happen big enough to become a negative i32
1421 // integer itself (PHP tries to cast everything it sees to signed int)
1422 if ($netA['db_first'] > $netB['db_first'])
1423 return 1;
1424 elseif ($netA['db_first'] < $netB['db_first'])
1425 return -1;
1426 else
1427 return 0;
1327d9dd
DO
1428}
1429
fb7a4967 1430// Modify the given tag tree so, that each level's items are sorted alphabetically.
1327d9dd 1431function sortTree (&$tree, $sortfunc = '')
fb7a4967 1432{
1327d9dd
DO
1433 if (empty ($sortfunc))
1434 return;
51b6651a 1435 $self = __FUNCTION__;
1327d9dd 1436 usort ($tree, $sortfunc);
fb7a4967
DO
1437 // Don't make a mistake of directly iterating over the items of current level, because this way
1438 // the sorting will be performed on a _copy_ if each item, not the item itself.
1439 foreach (array_keys ($tree) as $tagid)
51b6651a 1440 $self ($tree[$tagid]['kids'], $sortfunc);
fb7a4967
DO
1441}
1442
0137d53c
DO
1443function iptree_fill (&$netdata)
1444{
1445 if (!isset ($netdata['kids']) or empty ($netdata['kids']))
1446 return;
a987ff52 1447 // If we really have nested prefixes, they must fit into the tree.
0137d53c
DO
1448 $worktree = array
1449 (
1450 'ip_bin' => $netdata['ip_bin'],
1451 'mask' => $netdata['mask']
1452 );
1453 foreach ($netdata['kids'] as $pfx)
1454 iptree_embed ($worktree, $pfx);
1455 $netdata['kids'] = iptree_construct ($worktree);
1456 $netdata['kidc'] = count ($netdata['kids']);
1457}
1458
1459function iptree_construct ($node)
1460{
1461 $self = __FUNCTION__;
1462
1463 if (!isset ($node['right']))
1464 {
1465 if (!isset ($node['ip']))
1466 {
1467 $node['ip'] = long2ip ($node['ip_bin']);
1468 $node['kids'] = array();
fec0c8da 1469 $node['kidc'] = 0;
0137d53c
DO
1470 $node['name'] = '';
1471 }
1472 return array ($node);
1473 }
1474 else
1475 return array_merge ($self ($node['left']), $self ($node['right']));
1476}
1477
1478function iptree_embed (&$node, $pfx)
1479{
1480 $self = __FUNCTION__;
1481
1482 // hit?
1483 if ($node['ip_bin'] == $pfx['ip_bin'] and $node['mask'] == $pfx['mask'])
1484 {
1485 $node = $pfx;
1486 return;
1487 }
1488 if ($node['mask'] == $pfx['mask'])
1489 {
1490 showError ('Internal error, the recurring loop lost control', __FUNCTION__);
1491 die;
1492 }
1493
1494 // split?
1495 if (!isset ($node['right']))
1496 {
a987ff52
DO
1497 // Fill in db_first/db_last to make it possible to run scanIPv4Space() on the node.
1498 $node['left']['mask'] = $node['mask'] + 1;
0137d53c 1499 $node['left']['ip_bin'] = $node['ip_bin'];
a987ff52
DO
1500 $node['left']['db_first'] = sprintf ('%u', $node['left']['ip_bin']);
1501 $node['left']['db_last'] = sprintf ('%u', $node['left']['ip_bin'] | binInvMaskFromDec ($node['left']['mask']));
1502
1503 $node['right']['mask'] = $node['mask'] + 1;
0137d53c 1504 $node['right']['ip_bin'] = $node['ip_bin'] + binInvMaskFromDec ($node['mask'] + 1) + 1;
a987ff52
DO
1505 $node['right']['db_first'] = sprintf ('%u', $node['right']['ip_bin']);
1506 $node['right']['db_last'] = sprintf ('%u', $node['right']['ip_bin'] | binInvMaskFromDec ($node['right']['mask']));
0137d53c
DO
1507 }
1508
1509 // repeat!
1510 if (($node['left']['ip_bin'] & binMaskFromDec ($node['left']['mask'])) == ($pfx['ip_bin'] & binMaskFromDec ($node['left']['mask'])))
1511 $self ($node['left'], $pfx);
1512 elseif (($node['right']['ip_bin'] & binMaskFromDec ($node['right']['mask'])) == ($pfx['ip_bin'] & binMaskFromDec ($node['left']['mask'])))
1513 $self ($node['right'], $pfx);
1514 else
1515 {
1516 showError ('Internal error, cannot decide between left and right', __FUNCTION__);
1517 die;
1518 }
1519}
1520
3b81cb98 1521function treeApplyFunc (&$tree, $func = '', $stopfunc = '')
0137d53c
DO
1522{
1523 if (empty ($func))
1524 return;
1525 $self = __FUNCTION__;
1526 foreach (array_keys ($tree) as $key)
1527 {
1528 $func ($tree[$key]);
c3315231
DO
1529 if (!empty ($stopfunc) and $stopfunc ($tree[$key]))
1530 continue;
0137d53c
DO
1531 $self ($tree[$key]['kids'], $func);
1532 }
1533}
1534
a987ff52
DO
1535function loadIPv4AddrList (&$netinfo)
1536{
1537 loadOwnIPv4Addresses ($netinfo);
1538 markupIPv4AddrList ($netinfo['addrlist']);
1539}
b18d26dc 1540
b6b87070 1541function countOwnIPv4Addresses (&$node)
b18d26dc 1542{
b6b87070 1543 $toscan = array();
737a3f72 1544 $node['addrt'] = 0;
b6b87070 1545 if (empty ($node['kids']))
737a3f72 1546 {
f7414fa5 1547 $toscan[] = array ('i32_first' => $node['db_first'], 'i32_last' => $node['db_last']);
737a3f72
DO
1548 $node['addrt'] = binInvMaskFromDec ($node['mask']) + 1;
1549 }
b18d26dc 1550 else
b6b87070 1551 foreach ($node['kids'] as $nested)
b18d26dc 1552 if (!isset ($nested['id'])) // spare
737a3f72 1553 {
f7414fa5 1554 $toscan[] = array ('i32_first' => $nested['db_first'], 'i32_last' => $nested['db_last']);
737a3f72
DO
1555 $node['addrt'] += binInvMaskFromDec ($nested['mask']) + 1;
1556 }
f7414fa5 1557 $node['addrc'] = count (scanIPv4Space ($toscan));
b6b87070
DO
1558}
1559
c3315231
DO
1560function nodeIsCollapsed ($node)
1561{
1562 return $node['symbol'] == 'node-collapsed';
1563}
1564
b6b87070
DO
1565function loadOwnIPv4Addresses (&$node)
1566{
1567 $toscan = array();
1568 if (empty ($node['kids']))
f7414fa5 1569 $toscan[] = array ('i32_first' => $node['db_first'], 'i32_last' => $node['db_last']);
b6b87070
DO
1570 else
1571 foreach ($node['kids'] as $nested)
1572 if (!isset ($nested['id'])) // spare
f7414fa5
DO
1573 $toscan[] = array ('i32_first' => $nested['db_first'], 'i32_last' => $nested['db_last']);
1574 $node['addrlist'] = scanIPv4Space ($toscan);
b6b87070 1575 $node['addrc'] = count ($node['addrlist']);
b18d26dc
DO
1576}
1577
fec0c8da
DO
1578function prepareIPv4Tree ($netlist, $expanded_id = 0)
1579{
1580 $tree = treeFromList ($netlist); // medium call
1581 sortTree ($tree, 'IPv4NetworkCmp');
fec0c8da 1582 // complement the tree before markup to make the spare networks have "symbol" set
c3315231
DO
1583 treeApplyFunc ($tree, 'iptree_fill');
1584 iptree_markup_collapsion ($tree, getConfigVar ('TREE_THRESHOLD'), $expanded_id);
1585 // count addresses after the markup to skip computation for hidden tree nodes
1586 treeApplyFunc ($tree, 'countOwnIPv4Addresses', 'nodeIsCollapsed');
fec0c8da
DO
1587 return $tree;
1588}
1589
1590// Check all items of the tree recursively, until the requested target id is
1591// found. Mark all items leading to this item as "expanded", collapsing all
1592// the rest, which exceed the given threshold (if the threshold is given).
1593function iptree_markup_collapsion (&$tree, $threshold = 1024, $target = 0)
1594{
1595 $self = __FUNCTION__;
1596 $ret = FALSE;
1597 foreach (array_keys ($tree) as $key)
1598 {
048b53b9 1599 $here = ($target and isset ($tree[$key]['id']) and $tree[$key]['id'] == $target);
fec0c8da
DO
1600 $below = $self ($tree[$key]['kids'], $threshold, $target);
1601 if (!$tree[$key]['kidc']) // terminal node
1602 $tree[$key]['symbol'] = 'spacer';
1603 elseif ($tree[$key]['kidc'] < $threshold)
1604 $tree[$key]['symbol'] = 'node-expanded-static';
1605 elseif ($here or $below)
1606 $tree[$key]['symbol'] = 'node-expanded';
1607 else
1608 $tree[$key]['symbol'] = 'node-collapsed';
1609 $ret = ($ret or $here or $below); // parentheses are necessary for this to be computed correctly
1610 }
1611 return $ret;
1612}
1613
3b81cb98
DO
1614// Get a tree and target entity ID on it. Return the list of IDs, which make the path
1615// from the target entity to tree root. If such a path exists, it will consist of at
1616// least the target ID. Otherwise an empty list will be returned. The "list" is a randomly
1617// indexed array of values.
1618function traceEntity ($tree, $target_id)
1619{
1620 $self = __FUNCTION__;
1621 foreach ($tree as $node)
1622 {
1623 if ($node['id'] == $target_id) // here!
1624 return array ($target_id);
1625 $subtrace = $self ($node['kids'], $target_id); // below?
1626 if (count ($subtrace))
1627 {
1628 array_push ($subtrace, $node['id']);
1629 return $subtrace;
1630 }
1631 // next...
1632 }
1633 return array();
1634}
1635
e673ee24 1636?>