r2673 - new config option: FILTER_PREDICATE_SIEVE
[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
482c7f35
DO
27// Entity type by page number mapping is 1:1 atm, but may change later.
28$etype_by_pageno = array
29(
30 'ipv4net' => 'ipv4net',
31 'ipv4rspool' => 'ipv4rspool',
32 'ipv4vs' => 'ipv4vs',
33 'object' => 'object',
34 'rack' => 'rack',
35 'user' => 'user',
36 'file' => 'file',
ab440a82 37 'ipaddress' => 'ipaddress',
482c7f35
DO
38);
39
e673ee24
DO
40// Objects of some types should be explicitly shown as
41// anonymous (labelless). This function is a single place where the
42// decision about displayed name is made.
43function displayedName ($objectData)
44{
45 if ($objectData['name'] != '')
46 return $objectData['name'];
c6bc0ac5 47 elseif (considerConfiguredConstraint ('object', $objectData['id'], 'NAMEWARN_LISTSRC'))
a0ec6295 48 return "ANONYMOUS " . $objectData['objtype_name'];
e673ee24 49 else
a0ec6295 50 return "[${objectData['objtype_name']}]";
e673ee24
DO
51}
52
53// This function finds height of solid rectangle of atoms, which are all
54// assigned to the same object. Rectangle base is defined by specified
55// template.
56function rectHeight ($rackData, $startRow, $template_idx)
57{
58 $height = 0;
59 // The first met object_id is used to match all the folowing IDs.
60 $object_id = 0;
61 global $template;
62 do
63 {
64 for ($locidx = 0; $locidx < 3; $locidx++)
65 {
66 // At least one value in template is TRUE, but the following block
67 // can meet 'skipped' atoms. Let's ensure we have something after processing
68 // the first row.
69 if ($template[$template_idx][$locidx])
70 {
71 if (isset ($rackData[$startRow - $height][$locidx]['skipped']))
72 break 2;
93e02204
DO
73 if (isset ($rackData[$startRow - $height][$locidx]['rowspan']))
74 break 2;
75 if (isset ($rackData[$startRow - $height][$locidx]['colspan']))
76 break 2;
e673ee24
DO
77 if ($rackData[$startRow - $height][$locidx]['state'] != 'T')
78 break 2;
79 if ($object_id == 0)
80 $object_id = $rackData[$startRow - $height][$locidx]['object_id'];
81 if ($object_id != $rackData[$startRow - $height][$locidx]['object_id'])
82 break 2;
83 }
84 }
85 // If the first row can't offer anything, bail out.
86 if ($height == 0 and $object_id == 0)
87 break;
88 $height++;
89 }
90 while ($startRow - $height > 0);
93e02204
DO
91# echo "for startRow==${startRow} and template==(" . ($template[$template_idx][0] ? 'T' : 'F');
92# echo ', ' . ($template[$template_idx][1] ? 'T' : 'F') . ', ' . ($template[$template_idx][2] ? 'T' : 'F');
93# echo ") height==${height}<br>\n";
e673ee24
DO
94 return $height;
95}
96
97// This function marks atoms to be avoided by rectHeight() and assigns rowspan/colspan
98// attributes.
99function markSpan (&$rackData, $startRow, $maxheight, $template_idx)
100{
101 global $template, $templateWidth;
102 $colspan = 0;
103 for ($height = 0; $height < $maxheight; $height++)
104 {
105 for ($locidx = 0; $locidx < 3; $locidx++)
106 {
107 if ($template[$template_idx][$locidx])
108 {
109 // Add colspan/rowspan to the first row met and mark the following ones to skip.
93e02204
DO
110 // Explicitly show even single-cell spanned atoms, because rectHeight()
111 // is expeciting this data for correct calculation.
e673ee24
DO
112 if ($colspan != 0)
113 $rackData[$startRow - $height][$locidx]['skipped'] = TRUE;
114 else
115 {
116 $colspan = $templateWidth[$template_idx];
93e02204 117 if ($colspan >= 1)
e673ee24 118 $rackData[$startRow - $height][$locidx]['colspan'] = $colspan;
93e02204 119 if ($maxheight >= 1)
e673ee24
DO
120 $rackData[$startRow - $height][$locidx]['rowspan'] = $maxheight;
121 }
122 }
123 }
124 }
125 return;
126}
127
93e02204
DO
128// This function sets rowspan/solspan/skipped atom attributes for renderRack()
129// What we actually have to do is to find _all_ possible rectangles for each unit
130// and then select the widest of those with the maximal square.
e673ee24
DO
131function markAllSpans (&$rackData = NULL)
132{
133 if ($rackData == NULL)
134 {
61e269b5 135 showError ('Invalid rackData', __FUNCTION__);
e673ee24
DO
136 return;
137 }
138 for ($i = $rackData['height']; $i > 0; $i--)
93e02204
DO
139 while (markBestSpan ($rackData, $i));
140}
141
142// Calculate height of 6 possible span templates (array is presorted by width
143// descending) and mark the best (if any).
144function markBestSpan (&$rackData, $i)
145{
146 global $template, $templateWidth;
147 for ($j = 0; $j < 6; $j++)
e673ee24 148 {
93e02204
DO
149 $height[$j] = rectHeight ($rackData, $i, $j);
150 $square[$j] = $height[$j] * $templateWidth[$j];
151 }
152 // find the widest rectangle of those with maximal height
153 $maxsquare = max ($square);
154 if (!$maxsquare)
155 return FALSE;
156 $best_template_index = 0;
157 for ($j = 0; $j < 6; $j++)
158 if ($square[$j] == $maxsquare)
e673ee24 159 {
93e02204
DO
160 $best_template_index = $j;
161 $bestheight = $height[$j];
162 break;
e673ee24 163 }
93e02204
DO
164 // distribute span marks
165 markSpan ($rackData, $i, $bestheight, $best_template_index);
166 return TRUE;
e673ee24
DO
167}
168
e673ee24
DO
169// We can mount 'F' atoms and unmount our own 'T' atoms.
170function applyObjectMountMask (&$rackData, $object_id)
171{
172 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
173 for ($locidx = 0; $locidx < 3; $locidx++)
174 switch ($rackData[$unit_no][$locidx]['state'])
175 {
176 case 'F':
177 $rackData[$unit_no][$locidx]['enabled'] = TRUE;
178 break;
179 case 'T':
180 $rackData[$unit_no][$locidx]['enabled'] = ($rackData[$unit_no][$locidx]['object_id'] == $object_id);
181 break;
182 default:
183 $rackData[$unit_no][$locidx]['enabled'] = FALSE;
184 }
185}
186
187// Design change means transition between 'F' and 'A' and back.
188function applyRackDesignMask (&$rackData)
189{
190 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
191 for ($locidx = 0; $locidx < 3; $locidx++)
192 switch ($rackData[$unit_no][$locidx]['state'])
193 {
194 case 'F':
195 case 'A':
196 $rackData[$unit_no][$locidx]['enabled'] = TRUE;
197 break;
198 default:
199 $rackData[$unit_no][$locidx]['enabled'] = FALSE;
200 }
201}
202
203// The same for 'F' and 'U'.
204function applyRackProblemMask (&$rackData)
205{
206 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
207 for ($locidx = 0; $locidx < 3; $locidx++)
208 switch ($rackData[$unit_no][$locidx]['state'])
209 {
210 case 'F':
211 case 'U':
212 $rackData[$unit_no][$locidx]['enabled'] = TRUE;
213 break;
214 default:
215 $rackData[$unit_no][$locidx]['enabled'] = FALSE;
216 }
217}
218
219// This mask should allow toggling 'T' and 'W' on object's rackspace.
220function applyObjectProblemMask (&$rackData)
221{
222 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
223 for ($locidx = 0; $locidx < 3; $locidx++)
224 switch ($rackData[$unit_no][$locidx]['state'])
225 {
226 case 'T':
227 case 'W':
228 $rackData[$unit_no][$locidx]['enabled'] = ($rackData[$unit_no][$locidx]['object_id'] == $object_id);
229 break;
230 default:
231 $rackData[$unit_no][$locidx]['enabled'] = FALSE;
232 }
233}
234
235// This function highlights specified object (and removes previous highlight).
236function highlightObject (&$rackData, $object_id)
237{
238 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
239 for ($locidx = 0; $locidx < 3; $locidx++)
240 if
241 (
242 $rackData[$unit_no][$locidx]['state'] == 'T' and
243 $rackData[$unit_no][$locidx]['object_id'] == $object_id
244 )
245 $rackData[$unit_no][$locidx]['hl'] = 'h';
246 else
247 unset ($rackData[$unit_no][$locidx]['hl']);
248}
249
250// This function marks atoms to selected or not depending on their current state.
251function markupAtomGrid (&$data, $checked_state)
252{
253 for ($unit_no = $data['height']; $unit_no > 0; $unit_no--)
254 for ($locidx = 0; $locidx < 3; $locidx++)
255 {
256 if (!($data[$unit_no][$locidx]['enabled'] === TRUE))
257 continue;
258 if ($data[$unit_no][$locidx]['state'] == $checked_state)
259 $data[$unit_no][$locidx]['checked'] = ' checked';
260 else
261 $data[$unit_no][$locidx]['checked'] = '';
262 }
263}
264
265// This function is almost a clone of processGridForm(), but doesn't save anything to database
266// Return value is the changed rack data.
267// Here we assume that correct filter has already been applied, so we just
268// set or unset checkbox inputs w/o changing atom state.
269function mergeGridFormToRack (&$rackData)
270{
271 $rack_id = $rackData['id'];
272 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
273 for ($locidx = 0; $locidx < 3; $locidx++)
274 {
275 if ($rackData[$unit_no][$locidx]['enabled'] != TRUE)
276 continue;
277 $inputname = "atom_${rack_id}_${unit_no}_${locidx}";
278 if (isset ($_REQUEST[$inputname]) and $_REQUEST[$inputname] == 'on')
279 $rackData[$unit_no][$locidx]['checked'] = ' checked';
280 else
281 $rackData[$unit_no][$locidx]['checked'] = '';
282 }
283}
284
bb0a44e9 285// netmask conversion from length to number
e673ee24
DO
286function binMaskFromDec ($maskL)
287{
bb0a44e9
DO
288 $map_straight = array (
289 0 => 0x00000000,
290 1 => 0x80000000,
291 2 => 0xc0000000,
292 3 => 0xe0000000,
293 4 => 0xf0000000,
294 5 => 0xf8000000,
295 6 => 0xfc000000,
296 7 => 0xfe000000,
297 8 => 0xff000000,
298 9 => 0xff800000,
299 10 => 0xffc00000,
300 11 => 0xffe00000,
301 12 => 0xfff00000,
302 13 => 0xfff80000,
303 14 => 0xfffc0000,
304 15 => 0xfffe0000,
305 16 => 0xffff0000,
306 17 => 0xffff8000,
307 18 => 0xffffc000,
308 19 => 0xffffe000,
309 20 => 0xfffff000,
310 21 => 0xfffff800,
311 22 => 0xfffffc00,
312 23 => 0xfffffe00,
313 24 => 0xffffff00,
314 25 => 0xffffff80,
315 26 => 0xffffffc0,
316 27 => 0xffffffe0,
317 28 => 0xfffffff0,
318 29 => 0xfffffff8,
319 30 => 0xfffffffc,
320 31 => 0xfffffffe,
321 32 => 0xffffffff,
322 );
323 return $map_straight[$maskL];
e673ee24
DO
324}
325
bb0a44e9 326// complementary value
e673ee24
DO
327function binInvMaskFromDec ($maskL)
328{
bb0a44e9
DO
329 $map_compl = array (
330 0 => 0xffffffff,
331 1 => 0x7fffffff,
332 2 => 0x3fffffff,
333 3 => 0x1fffffff,
334 4 => 0x0fffffff,
335 5 => 0x07ffffff,
336 6 => 0x03ffffff,
337 7 => 0x01ffffff,
338 8 => 0x00ffffff,
339 9 => 0x007fffff,
340 10 => 0x003fffff,
341 11 => 0x001fffff,
342 12 => 0x000fffff,
343 13 => 0x0007ffff,
344 14 => 0x0003ffff,
345 15 => 0x0001ffff,
346 16 => 0x0000ffff,
347 17 => 0x00007fff,
348 18 => 0x00003fff,
349 19 => 0x00001fff,
350 20 => 0x00000fff,
351 21 => 0x000007ff,
352 22 => 0x000003ff,
353 23 => 0x000001ff,
354 24 => 0x000000ff,
355 25 => 0x0000007f,
356 26 => 0x0000003f,
357 27 => 0x0000001f,
358 28 => 0x0000000f,
359 29 => 0x00000007,
360 30 => 0x00000003,
361 31 => 0x00000001,
362 32 => 0x00000000,
363 );
364 return $map_compl[$maskL];
e673ee24
DO
365}
366
e673ee24
DO
367// This function looks up 'has_problems' flag for 'T' atoms
368// and modifies 'hl' key. May be, this should be better done
369// in getRackData(). We don't honour 'skipped' key, because
370// the function is also used for thumb creation.
371function markupObjectProblems (&$rackData)
372{
373 for ($i = $rackData['height']; $i > 0; $i--)
374 for ($locidx = 0; $locidx < 3; $locidx++)
375 if ($rackData[$i][$locidx]['state'] == 'T')
376 {
7ddbcf59 377 $object = getObjectInfo ($rackData[$i][$locidx]['object_id'], FALSE);
e673ee24
DO
378 if ($object['has_problems'] == 'yes')
379 {
380 // Object can be already highlighted.
381 if (isset ($rackData[$i][$locidx]['hl']))
382 $rackData[$i][$locidx]['hl'] = $rackData[$i][$locidx]['hl'] . 'w';
383 else
384 $rackData[$i][$locidx]['hl'] = 'w';
385 }
386 }
387}
388
389function search_cmpObj ($a, $b)
390{
391 return ($a['score'] > $b['score'] ? -1 : 1);
392}
393
ea5fc465 394function getObjectSearchResults ($terms)
e673ee24
DO
395{
396 $objects = array();
397 mergeSearchResults ($objects, $terms, 'name');
398 mergeSearchResults ($objects, $terms, 'label');
399 mergeSearchResults ($objects, $terms, 'asset_no');
400 mergeSearchResults ($objects, $terms, 'barcode');
401 if (count ($objects) == 1)
402 usort ($objects, 'search_cmpObj');
403 return $objects;
404}
405
406// This function removes all colons and dots from a string.
407function l2addressForDatabase ($string)
408{
e673ee24 409 $string = strtoupper ($string);
05771508
DO
410 switch (TRUE)
411 {
412 case ($string == '' or preg_match (RE_L2_SOLID, $string)):
413 return $string;
414 case (preg_match (RE_L2_IFCFG, $string)):
415 $pieces = explode (':', $string);
416 // This workaround is for SunOS ifconfig.
417 foreach ($pieces as &$byte)
418 if (strlen ($byte) == 1)
419 $byte = '0' . $byte;
420 // And this workaround is for PHP.
421 unset ($byte);
422 return implode ('', $pieces);
423 case (preg_match (RE_L2_CISCO, $string)):
424 return implode ('', explode ('.', $string));
1930dc7f
DO
425 case (preg_match (RE_L2_IPCFG, $string)):
426 return implode ('', explode ('-', $string));
05771508
DO
427 default:
428 return NULL;
429 }
e673ee24
DO
430}
431
432function l2addressFromDatabase ($string)
433{
434 switch (strlen ($string))
435 {
436 case 12: // Ethernet
437 case 16: // FireWire
438 $ret = implode (':', str_split ($string, 2));
439 break;
440 default:
441 $ret = $string;
442 break;
443 }
444 return $ret;
445}
446
447// The following 2 functions return previous and next rack IDs for
448// a given rack ID. The order of racks is the same as in renderRackspace()
449// or renderRow().
450function getPrevIDforRack ($row_id = 0, $rack_id = 0)
451{
452 if ($row_id <= 0 or $rack_id <= 0)
453 {
61e269b5 454 showError ('Invalid arguments passed', __FUNCTION__);
e673ee24
DO
455 return NULL;
456 }
457 $rackList = getRacksForRow ($row_id);
458 doubleLink ($rackList);
459 if (isset ($rackList[$rack_id]['prev_key']))
460 return $rackList[$rack_id]['prev_key'];
461 return NULL;
462}
463
464function getNextIDforRack ($row_id = 0, $rack_id = 0)
465{
466 if ($row_id <= 0 or $rack_id <= 0)
467 {
61e269b5 468 showError ('Invalid arguments passed', __FUNCTION__);
e673ee24
DO
469 return NULL;
470 }
471 $rackList = getRacksForRow ($row_id);
472 doubleLink ($rackList);
473 if (isset ($rackList[$rack_id]['next_key']))
474 return $rackList[$rack_id]['next_key'];
475 return NULL;
476}
477
478// This function finds previous and next array keys for each array key and
479// modifies its argument accordingly.
480function doubleLink (&$array)
481{
482 $prev_key = NULL;
483 foreach (array_keys ($array) as $key)
484 {
485 if ($prev_key)
486 {
487 $array[$key]['prev_key'] = $prev_key;
488 $array[$prev_key]['next_key'] = $key;
489 }
490 $prev_key = $key;
491 }
492}
493
e673ee24
DO
494function sortTokenize ($a, $b)
495{
496 $aold='';
497 while ($a != $aold)
498 {
499 $aold=$a;
500 $a = ereg_replace('[^a-zA-Z0-9]',' ',$a);
501 $a = ereg_replace('([0-9])([a-zA-Z])','\\1 \\2',$a);
502 $a = ereg_replace('([a-zA-Z])([0-9])','\\1 \\2',$a);
503 }
504
505 $bold='';
506 while ($b != $bold)
507 {
508 $bold=$b;
509 $b = ereg_replace('[^a-zA-Z0-9]',' ',$b);
510 $b = ereg_replace('([0-9])([a-zA-Z])','\\1 \\2',$b);
511 $b = ereg_replace('([a-zA-Z])([0-9])','\\1 \\2',$b);
512 }
513
514
515
516 $ar = explode(' ', $a);
517 $br = explode(' ', $b);
518 for ($i=0; $i<count($ar) && $i<count($br); $i++)
519 {
520 $ret = 0;
521 if (is_numeric($ar[$i]) and is_numeric($br[$i]))
522 $ret = ($ar[$i]==$br[$i])?0:($ar[$i]<$br[$i]?-1:1);
523 else
524 $ret = strcasecmp($ar[$i], $br[$i]);
525 if ($ret != 0)
526 return $ret;
527 }
528 if ($i<count($ar))
529 return 1;
530 if ($i<count($br))
531 return -1;
532 return 0;
533}
534
535function sortByName ($a, $b)
536{
537 return sortTokenize($a['name'], $b['name']);
538}
539
e673ee24
DO
540function sortEmptyPorts ($a, $b)
541{
542 $objname_cmp = sortTokenize($a['Object_name'], $b['Object_name']);
543 if ($objname_cmp == 0)
544 {
545 return sortTokenize($a['Port_name'], $b['Port_name']);
546 }
547 return $objname_cmp;
548}
549
550function sortObjectAddressesAndNames ($a, $b)
551{
552 $objname_cmp = sortTokenize($a['object_name'], $b['object_name']);
553 if ($objname_cmp == 0)
554 {
79f22c3d
DO
555 $name_a = (isset ($a['port_name'])) ? $a['port_name'] : '';
556 $name_b = (isset ($b['port_name'])) ? $b['port_name'] : '';
557 $objname_cmp = sortTokenize($name_a, $name_b);
e673ee24 558 if ($objname_cmp == 0)
e673ee24 559 sortTokenize($a['ip'], $b['ip']);
e673ee24
DO
560 return $objname_cmp;
561 }
562 return $objname_cmp;
563}
564
e673ee24
DO
565function sortAddresses ($a, $b)
566{
567 $name_cmp = sortTokenize($a['name'], $b['name']);
568 if ($name_cmp == 0)
569 {
570 return sortTokenize($a['ip'], $b['ip']);
571 }
572 return $name_cmp;
573}
574
575// This function expands port compat list into a matrix.
576function buildPortCompatMatrixFromList ($portTypeList, $portCompatList)
577{
578 $matrix = array();
579 // Create type matrix and markup compatible types.
580 foreach (array_keys ($portTypeList) as $type1)
581 foreach (array_keys ($portTypeList) as $type2)
582 $matrix[$type1][$type2] = FALSE;
583 foreach ($portCompatList as $pair)
584 $matrix[$pair['type1']][$pair['type2']] = TRUE;
585 return $matrix;
586}
587
c31cd72c 588// This function returns an array of single element of object's FQDN attribute,
f321b50a
DO
589// if FQDN is set. The next choice is object's common name, if it looks like a
590// hostname. Otherwise an array of all 'regular' IP addresses of the
c31cd72c 591// object is returned (which may appear 0 and more elements long).
f321b50a 592function findAllEndpoints ($object_id, $fallback = '')
c31cd72c
DO
593{
594 $values = getAttrValues ($object_id);
595 foreach ($values as $record)
f321b50a 596 if ($record['name'] == 'FQDN' && !empty ($record['value']))
c31cd72c 597 return array ($record['value']);
c31cd72c 598 $regular = array();
85970da2
DO
599 foreach (getObjectIPv4Allocations ($object_id) as $dottedquad => $alloc)
600 if ($alloc['type'] == 'regular')
601 $regular[] = $dottedquad;
f321b50a
DO
602 if (!count ($regular) && !empty ($fallback))
603 return array ($fallback);
c31cd72c
DO
604 return $regular;
605}
606
83ba6670
DO
607// Some records in the dictionary may be written as plain text or as Wiki
608// link in the following syntax:
609// 1. word
610// 2. [[word URL]] // FIXME: this isn't working
611// 3. [[word word word | URL]]
612// This function parses the line and returns text suitable for either A
613// (rendering <A HREF>) or O (for <OPTION>).
24cbe8af 614function parseWikiLink ($line, $which, $strip_optgroup = FALSE)
83ba6670 615{
010231c2 616 if (preg_match ('/^\[\[.+\]\]$/', $line) == 0)
24cbe8af
DO
617 {
618 if ($strip_optgroup)
f0b540a3 619 return ereg_replace ('^.+%GSKIP%', '', ereg_replace ('^(.+)%GPASS%', '\\1 ', $line));
24cbe8af
DO
620 else
621 return $line;
622 }
010231c2
DO
623 $line = preg_replace ('/^\[\[(.+)\]\]$/', '$1', $line);
624 $s = explode ('|', $line);
83ba6670 625 $o_value = trim ($s[0]);
24cbe8af 626 if ($strip_optgroup)
f0b540a3 627 $o_value = ereg_replace ('^.+%GSKIP%', '', ereg_replace ('^(.+)%GPASS%', '\\1 ', $o_value));
83ba6670
DO
628 $a_value = trim ($s[1]);
629 if ($which == 'a')
010231c2 630 return "<a href='${a_value}'>${o_value}</a>";
83ba6670
DO
631 if ($which == 'o')
632 return $o_value;
633}
634
2de490b7
DO
635function buildVServiceName ($vsinfo = NULL)
636{
637 if ($vsinfo == NULL)
638 {
639 showError ('NULL argument', __FUNCTION__);
640 return NULL;
641 }
8d790216 642 return $vsinfo['vip'] . ':' . $vsinfo['vport'] . '/' . $vsinfo['proto'];
2de490b7
DO
643}
644
177b1e9b
DO
645// rackspace usage for a single rack
646// (T + W + U) / (height * 3 - A)
11df133a 647function getRSUforRack ($data = NULL)
177b1e9b 648{
11df133a 649 if ($data == NULL)
177b1e9b
DO
650 {
651 showError ('Invalid argument', __FUNCTION__);
652 return NULL;
653 }
6ffba290 654 $counter = array ('A' => 0, 'U' => 0, 'T' => 0, 'W' => 0, 'F' => 0);
9e60f7df
DO
655 for ($unit_no = $data['height']; $unit_no > 0; $unit_no--)
656 for ($locidx = 0; $locidx < 3; $locidx++)
657 $counter[$data[$unit_no][$locidx]['state']]++;
dfa3c075 658 return ($counter['T'] + $counter['W'] + $counter['U']) / ($counter['T'] + $counter['W'] + $counter['U'] + $counter['F']);
177b1e9b
DO
659}
660
11df133a
DO
661// Same for row.
662function getRSUforRackRow ($rowData = NULL)
663{
bb26a59e 664 if ($rowData === NULL)
11df133a
DO
665 {
666 showError ('Invalid argument', __FUNCTION__);
667 return NULL;
668 }
bb26a59e
DO
669 if (!count ($rowData))
670 return 0;
11df133a 671 $counter = array ('A' => 0, 'U' => 0, 'T' => 0, 'W' => 0, 'F' => 0);
f81a2012 672 $total_height = 0;
dfa3c075
DO
673 foreach (array_keys ($rowData) as $rack_id)
674 {
675 $data = getRackData ($rack_id);
676 $total_height += $data['height'];
11df133a
DO
677 for ($unit_no = $data['height']; $unit_no > 0; $unit_no--)
678 for ($locidx = 0; $locidx < 3; $locidx++)
679 $counter[$data[$unit_no][$locidx]['state']]++;
dfa3c075
DO
680 }
681 return ($counter['T'] + $counter['W'] + $counter['U']) / ($counter['T'] + $counter['W'] + $counter['U'] + $counter['F']);
11df133a
DO
682}
683
abef7149
DO
684// Return a list of object IDs, which can be found in the given rackspace block.
685function stuffInRackspace ($rackData)
f1a0477d
DO
686{
687 $objects = array();
688 for ($i = $rackData['height']; $i > 0; $i--)
689 for ($locidx = 0; $locidx < 3; $locidx++)
690 if
691 (
692 $rackData[$i][$locidx]['state'] == 'T' and
693 !in_array ($rackData[$i][$locidx]['object_id'], $objects)
694 )
695 $objects[] = $rackData[$i][$locidx]['object_id'];
abef7149 696 return $objects;
f1a0477d
DO
697}
698
9af110b4
DO
699// Make sure the string is always wrapped with LF characters
700function lf_wrap ($str)
701{
702 $ret = trim ($str, "\r\n");
703 if (!empty ($ret))
704 $ret .= "\n";
705 return $ret;
706}
707
e6e7d8b3
DO
708// Adopted from Mantis BTS code.
709function string_insert_hrefs ($s)
710{
711 if (getConfigVar ('DETECT_URLS') != 'yes')
712 return $s;
713 # Find any URL in a string and replace it by a clickable link
714 $s = preg_replace( '/(([[:alpha:]][-+.[:alnum:]]*):\/\/(%[[:digit:]A-Fa-f]{2}|[-_.!~*\';\/?%^\\\\:@&={\|}+$#\(\),\[\][:alnum:]])+)/se',
715 "'<a href=\"'.rtrim('\\1','.').'\">\\1</a> [<a href=\"'.rtrim('\\1','.').'\" target=\"_blank\">^</a>]'",
716 $s);
717 $s = preg_replace( '/\b' . email_regex_simple() . '\b/i',
718 '<a href="mailto:\0">\0</a>',
719 $s);
720 return $s;
721}
722
723// Idem.
724function email_regex_simple ()
725{
726 return "(([a-z0-9!#*+\/=?^_{|}~-]+(?:\.[a-z0-9!#*+\/=?^_{|}~-]+)*)" . # recipient
727 "\@((?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?))"; # @domain
728}
729
118e4c38
DO
730// Parse AUTOPORTS_CONFIG and return a list of generated pairs (port_type, port_name)
731// for the requested object_type_id.
732function getAutoPorts ($type_id)
733{
734 $ret = array();
735 $typemap = explode (';', str_replace (' ', '', getConfigVar ('AUTOPORTS_CONFIG')));
736 foreach ($typemap as $equation)
737 {
738 $tmp = explode ('=', $equation);
739 if (count ($tmp) != 2)
740 continue;
741 $objtype_id = $tmp[0];
742 if ($objtype_id != $type_id)
743 continue;
744 $portlist = $tmp[1];
745 foreach (explode ('+', $portlist) as $product)
746 {
747 $tmp = explode ('*', $product);
748 if (count ($tmp) != 3)
749 continue;
750 $nports = $tmp[0];
751 $port_type = $tmp[1];
752 $format = $tmp[2];
753 for ($i = 0; $i < $nports; $i++)
754 $ret[] = array ('type' => $port_type, 'name' => @sprintf ($format, $i));
755 }
756 }
757 return $ret;
758}
759
86256b96
DO
760// Use pre-served trace to traverse the tree, then place given node where it belongs.
761function pokeNode (&$tree, $trace, $key, $value, $threshold = 0)
762{
763 // This function needs the trace to be followed FIFO-way. The fastest
764 // way to do so is to use array_push() for putting values into the
765 // list and array_shift() for getting them out. This exposed up to 11%
766 // performance gain compared to other patterns of array_push/array_unshift/
767 // array_reverse/array_pop/array_shift conjunction.
768 $myid = array_shift ($trace);
769 if (!count ($trace)) // reached the target
9dfd4cc9 770 {
86256b96
DO
771 if (!$threshold or ($threshold and $tree[$myid]['kidc'] + 1 < $threshold))
772 $tree[$myid]['kids'][$key] = $value;
773 // Reset accumulated records once, when the limit is reached, not each time
774 // after that.
775 if (++$tree[$myid]['kidc'] == $threshold)
776 $tree[$myid]['kids'] = array();
777 }
778 else // not yet
779 {
780 $self = __FUNCTION__;
781 $self ($tree[$myid]['kids'], $trace, $key, $value, $threshold);
9dfd4cc9 782 }
9dfd4cc9
DO
783}
784
d65353ad
DO
785// Build a tree from the item list and return it. Input and output data is
786// indexed by item id (nested items in output are recursively stored in 'kids'
51b6651a
DO
787// key, which is in turn indexed by id. Functions, which are ready to handle
788// tree collapsion/expansion themselves, may request non-zero threshold value
789// for smaller resulting tree.
86256b96 790function treeFromList ($nodelist, $threshold = 0, $return_main_payload = TRUE)
d65353ad 791{
86256b96
DO
792 $tree = array();
793 // Array equivalent of traceEntity() function.
794 $trace = array();
795 // set kidc and kids only once
796 foreach (array_keys ($nodelist) as $nodeid)
797 {
798 $nodelist[$nodeid]['kidc'] = 0;
799 $nodelist[$nodeid]['kids'] = array();
800 }
801 do
9dfd4cc9 802 {
86256b96
DO
803 $nextpass = FALSE;
804 foreach (array_keys ($nodelist) as $nodeid)
9dfd4cc9 805 {
86256b96
DO
806 // When adding a node to the working tree, book another
807 // iteration, because the new item could make a way for
808 // others onto the tree. Also remove any item added from
809 // the input list, so iteration base shrinks.
810 // First check if we can assign directly.
811 if ($nodelist[$nodeid]['parent_id'] == NULL)
9dfd4cc9 812 {
86256b96
DO
813 $tree[$nodeid] = $nodelist[$nodeid];
814 $trace[$nodeid] = array(); // Trace to root node is empty
815 unset ($nodelist[$nodeid]);
816 $nextpass = TRUE;
9dfd4cc9 817 }
86256b96
DO
818 // Now look if it fits somewhere on already built tree.
819 elseif (isset ($trace[$nodelist[$nodeid]['parent_id']]))
9dfd4cc9 820 {
86256b96
DO
821 // Trace to a node is a trace to its parent plus parent id.
822 $trace[$nodeid] = $trace[$nodelist[$nodeid]['parent_id']];
823 $trace[$nodeid][] = $nodelist[$nodeid]['parent_id'];
824 pokeNode ($tree, $trace[$nodeid], $nodeid, $nodelist[$nodeid], $threshold);
825 // path to any other node is made of all parent nodes plus the added node itself
826 unset ($nodelist[$nodeid]);
827 $nextpass = TRUE;
9dfd4cc9
DO
828 }
829 }
9dfd4cc9 830 }
86256b96
DO
831 while ($nextpass);
832 if ($return_main_payload)
833 return $tree;
834 else
835 return $nodelist;
9dfd4cc9
DO
836}
837
49fb1027 838// Build a tree from the tag list and return everything _except_ the tree.
573214e0
DO
839// IOW, return taginfo items, which have parent_id set and pointing outside
840// of the "normal" tree, which originates from the root.
49fb1027
DO
841function getOrphanedTags ()
842{
843 global $taglist;
86256b96 844 return treeFromList ($taglist, 0, FALSE);
49fb1027
DO
845}
846
6e49bd1f 847function serializeTags ($chain, $baseurl = '')
ba93bd98
DO
848{
849 $comma = '';
850 $ret = '';
6e49bd1f 851 foreach ($chain as $taginfo)
ba93bd98 852 {
e2ac59cf
DO
853 $ret .= $comma .
854 ($baseurl == '' ? '' : "<a href='${baseurl}tagfilter[]=${taginfo['id']}'>") .
855 $taginfo['tag'] .
856 ($baseurl == '' ? '' : '</a>');
ba93bd98
DO
857 $comma = ', ';
858 }
859 return $ret;
860}
861
3b81cb98
DO
862// For each tag add all its parent tags onto the list. Don't expect anything
863// except user's tags on the chain.
864function getTagChainExpansion ($chain, $tree = NULL)
ba93bd98 865{
51b6651a 866 $self = __FUNCTION__;
3b81cb98
DO
867 if ($tree === NULL)
868 {
869 global $tagtree;
870 $tree = $tagtree;
871 }
ba93bd98 872 // For each tag find its path from the root, then combine items
6e49bd1f 873 // of all paths and add them to the chain, if they aren't there yet.
ba93bd98
DO
874 $ret = array();
875 foreach ($tree as $taginfo1)
876 {
877 $hit = FALSE;
6e49bd1f 878 foreach ($chain as $taginfo2)
ba93bd98
DO
879 if ($taginfo1['id'] == $taginfo2['id'])
880 {
881 $hit = TRUE;
882 break;
883 }
884 if (count ($taginfo1['kids']) > 0)
885 {
3b81cb98 886 $subsearch = $self ($chain, $taginfo1['kids']);
ba93bd98
DO
887 if (count ($subsearch))
888 {
889 $hit = TRUE;
890 $ret = array_merge ($ret, $subsearch);
891 }
892 }
893 if ($hit)
894 $ret[] = $taginfo1;
895 }
896 return $ret;
897}
898
ba93bd98
DO
899// Return the list of missing implicit tags.
900function getImplicitTags ($oldtags)
901{
902 $ret = array();
6e49bd1f 903 $newtags = getTagChainExpansion ($oldtags);
ba93bd98
DO
904 foreach ($newtags as $newtag)
905 {
906 $already_exists = FALSE;
907 foreach ($oldtags as $oldtag)
908 if ($newtag['id'] == $oldtag['id'])
909 {
910 $already_exists = TRUE;
911 break;
912 }
913 if ($already_exists)
914 continue;
d6089951 915 $ret[] = array ('id' => $newtag['id'], 'tag' => $newtag['tag'], 'parent_id' => $newtag['parent_id']);
ba93bd98
DO
916 }
917 return $ret;
918}
919
6e49bd1f
DO
920// Minimize the chain: exclude all implicit tags and return the result.
921function getExplicitTagsOnly ($chain, $tree = NULL)
ab379543 922{
51b6651a 923 $self = __FUNCTION__;
20c901a7 924 global $tagtree;
ab379543 925 if ($tree === NULL)
20c901a7 926 $tree = $tagtree;
ab379543
DO
927 $ret = array();
928 foreach ($tree as $taginfo)
929 {
930 if (isset ($taginfo['kids']))
931 {
51b6651a 932 $harvest = $self ($chain, $taginfo['kids']);
ab379543
DO
933 if (count ($harvest) > 0)
934 {
935 $ret = array_merge ($ret, $harvest);
936 continue;
937 }
938 }
939 // This tag isn't implicit, test is for being explicit.
6e49bd1f 940 foreach ($chain as $testtag)
ab379543
DO
941 if ($taginfo['id'] == $testtag['id'])
942 {
943 $ret[] = $testtag;
944 break;
945 }
946 }
947 return $ret;
948}
949
6e49bd1f 950// Maximize the chain: for each tag add all tags, for which it is direct or indirect parent.
74ccacff 951// Unlike other functions, this one accepts and returns a list of integer tag IDs, not
e07bb730 952// a list of tag structures. Same structure (tag ID list) is returned after processing.
74ccacff
DO
953function complementByKids ($idlist, $tree = NULL, $getall = FALSE)
954{
51b6651a 955 $self = __FUNCTION__;
20c901a7 956 global $tagtree;
74ccacff 957 if ($tree === NULL)
20c901a7 958 $tree = $tagtree;
74ccacff
DO
959 $getallkids = $getall;
960 $ret = array();
961 foreach ($tree as $taginfo)
962 {
963 foreach ($idlist as $test_id)
964 if ($getall or $taginfo['id'] == $test_id)
965 {
966 $ret[] = $taginfo['id'];
967 // Once matched node makes all sub-nodes match, but don't make
968 // a mistake of matching every other node at the current level.
969 $getallkids = TRUE;
970 break;
971 }
972 if (isset ($taginfo['kids']))
51b6651a 973 $ret = array_merge ($ret, $self ($idlist, $taginfo['kids'], $getallkids));
74ccacff
DO
974 $getallkids = FALSE;
975 }
976 return $ret;
977}
978
2c21a10c
DO
979// Universal autotags generator, a complementing function for loadEntityTags().
980// An important extension is that 'ipaddress' quasi-realm is also handled.
981// Bypass key isn't strictly typed, but interpreted depending on the realm.
982function generateEntityAutoTags ($entity_realm = '', $bypass_value = '')
cce6b057 983{
cce6b057 984 $ret = array();
2c21a10c
DO
985 switch ($entity_realm)
986 {
987 case 'rack':
988 $ret[] = array ('tag' => '$rackid_' . $bypass_value);
989 $ret[] = array ('tag' => '$any_rack');
990 break;
991 case 'object':
7ddbcf59 992 $oinfo = getObjectInfo ($bypass_value, FALSE);
2c21a10c
DO
993 $ret[] = array ('tag' => '$id_' . $bypass_value);
994 $ret[] = array ('tag' => '$typeid_' . $oinfo['objtype_id']);
995 $ret[] = array ('tag' => '$any_object');
7ddbcf59 996 if (validTagName ('$cn_' . $oinfo['name']))
2c21a10c 997 $ret[] = array ('tag' => '$cn_' . $oinfo['name']);
914b439b
DO
998 if (!count (getResidentRacksData ($bypass_value, FALSE)))
999 $ret[] = array ('tag' => '$unmounted');
2c21a10c
DO
1000 break;
1001 case 'ipv4net':
1002 $netinfo = getIPv4NetworkInfo ($bypass_value);
1003 $ret[] = array ('tag' => '$ip4netid_' . $bypass_value);
1004 $ret[] = array ('tag' => '$ip4net-' . str_replace ('.', '-', $netinfo['ip']) . '-' . $netinfo['mask']);
1005 $ret[] = array ('tag' => '$any_ip4net');
1006 $ret[] = array ('tag' => '$any_net');
1007 break;
1008 case 'ipaddress':
1009 $netinfo = getIPv4NetworkInfo (getIPv4AddressNetworkId ($bypass_value));
1010 $ret[] = array ('tag' => '$ip4net-' . str_replace ('.', '-', $bypass_value) . '-32');
1011 $ret[] = array ('tag' => '$ip4net-' . str_replace ('.', '-', $netinfo['ip']) . '-' . $netinfo['mask']);
1012 $ret[] = array ('tag' => '$any_ip4net');
1013 $ret[] = array ('tag' => '$any_net');
1014 break;
1015 case 'ipv4vs':
1016 $ret[] = array ('tag' => '$ipv4vsid_' . $bypass_value);
1017 $ret[] = array ('tag' => '$any_ipv4vs');
1018 $ret[] = array ('tag' => '$any_vs');
1019 break;
1020 case 'ipv4rspool':
1021 $ret[] = array ('tag' => '$ipv4rspid_' . $bypass_value);
1022 $ret[] = array ('tag' => '$any_ipv4rsp');
1023 $ret[] = array ('tag' => '$any_rsp');
1024 break;
1025 case 'user':
b82cce3f
DO
1026 // {$username_XXX} autotag is generated always, but {$userid_XXX}
1027 // appears only for accounts, which exist in local database.
2c21a10c 1028 $ret[] = array ('tag' => '$username_' . $bypass_value);
b82cce3f
DO
1029 if (NULL !== ($userid = getUserIDByUsername ($bypass_value)))
1030 $ret[] = array ('tag' => '$userid_' . $userid);
2c21a10c
DO
1031 break;
1032 case 'file':
1033 $ret[] = array ('tag' => '$fileid_' . $bypass_value);
1034 $ret[] = array ('tag' => '$any_file');
1035 break;
1036 default:
1037 break;
1038 }
f9bc186f
DO
1039 return $ret;
1040}
1041
abef7149
DO
1042// Check, if the given tag is present on the chain (will only work
1043// for regular tags with tag ID set.
1044function tagOnChain ($taginfo, $tagchain)
1045{
1046 if (!isset ($taginfo['id']))
1047 return FALSE;
1048 foreach ($tagchain as $test)
1049 if ($test['id'] == $taginfo['id'])
1050 return TRUE;
1051 return FALSE;
1052}
1053
1054// Idem, but use ID list instead of chain.
1055function tagOnIdList ($taginfo, $tagidlist)
1056{
1057 if (!isset ($taginfo['id']))
1058 return FALSE;
1059 foreach ($tagidlist as $tagid)
61a61189 1060 if ($taginfo['id'] == $tagid)
abef7149
DO
1061 return TRUE;
1062 return FALSE;
1063}
1064
1065// Return TRUE, if two tags chains differ (order of tags doesn't matter).
1066// Assume, that neither of the lists contains duplicates.
1067// FIXME: a faster, than O(x^2) method is possible for this calculation.
1068function tagChainCmp ($chain1, $chain2)
1069{
1070 if (count ($chain1) != count ($chain2))
1071 return TRUE;
1072 foreach ($chain1 as $taginfo1)
1073 if (!tagOnChain ($taginfo1, $chain2))
1074 return TRUE;
1075 return FALSE;
1076}
1077
53bae67b
DO
1078// If the page-tab-op triplet is final, make $expl_tags and $impl_tags
1079// hold all appropriate (explicit and implicit) tags respectively.
1080// Otherwise some limited redirection is necessary (only page and tab
1081// names are preserved, ophandler name change isn't handled).
da958e52
DO
1082function fixContext ()
1083{
4c9b513a
DO
1084 global
1085 $pageno,
1086 $tabno,
1087 $auto_tags,
1088 $expl_tags,
1089 $impl_tags,
1090 $target_given_tags,
1091 $user_given_tags,
25186565 1092 $etype_by_pageno,
4c9b513a 1093 $page;
53bae67b
DO
1094
1095 $pmap = array
1096 (
1097 'accounts' => 'userlist',
1098 'rspools' => 'ipv4rsplist',
1099 'rspool' => 'ipv4rsp',
1100 'vservices' => 'ipv4vslist',
1101 'vservice' => 'ipv4vs',
1102 );
1103 $tmap = array();
1104 $tmap['objects']['newmulti'] = 'addmore';
1105 $tmap['objects']['newobj'] = 'addmore';
1106 $tmap['object']['switchvlans'] = 'livevlans';
1107 $tmap['object']['slb'] = 'editrspvs';
72d8ced3
DO
1108 $tmap['object']['portfwrd'] = 'nat4';
1109 $tmap['object']['network'] = 'ipv4';
53bae67b
DO
1110 if (isset ($pmap[$pageno]))
1111 redirectUser ($pmap[$pageno], $tabno);
1112 if (isset ($tmap[$pageno][$tabno]))
1113 redirectUser ($pageno, $tmap[$pageno][$tabno]);
1114
2c21a10c
DO
1115 // Don't reset autochain, because auth procedures could push stuff there in.
1116 // Another important point is to ignore 'user' realm, so we don't infuse effective
1117 // context with autotags of the displayed account and don't try using uint
1118 // bypass, where string is expected.
da958e52
DO
1119 if
1120 (
2c21a10c 1121 $pageno != 'user' and
ab440a82 1122 isset ($etype_by_pageno[$pageno]) and
da958e52
DO
1123 isset ($page[$pageno]['bypass']) and
1124 isset ($_REQUEST[$page[$pageno]['bypass']])
1125 )
25186565 1126 $auto_tags = array_merge ($auto_tags, generateEntityAutoTags ($etype_by_pageno[$pageno], $_REQUEST[$page[$pageno]['bypass']]));
2c21a10c
DO
1127 if
1128 (
1129 isset ($page[$pageno]['bypass']) and
1130 isset ($page[$pageno]['bypass_type']) and
1131 $page[$pageno]['bypass_type'] == 'uint' and
1132 isset ($_REQUEST[$page[$pageno]['bypass']])
1133 )
1134 $target_given_tags = loadEntityTags ($pageno, $_REQUEST[$page[$pageno]['bypass']]);
4c9b513a
DO
1135 // Explicit and implicit chains should be normally empty at this point, so
1136 // overwrite the contents anyway.
1137 $expl_tags = mergeTagChains ($user_given_tags, $target_given_tags);
1138 $impl_tags = getImplicitTags ($expl_tags);
da958e52
DO
1139}
1140
abef7149
DO
1141// Take a list of user-supplied tag IDs to build a list of valid taginfo
1142// records indexed by tag IDs (tag chain).
6e49bd1f 1143function buildTagChainFromIds ($tagidlist)
ab379543 1144{
20c901a7 1145 global $taglist;
ab379543 1146 $ret = array();
abef7149 1147 foreach (array_unique ($tagidlist) as $tag_id)
ab379543
DO
1148 if (isset ($taglist[$tag_id]))
1149 $ret[] = $taglist[$tag_id];
1150 return $ret;
1151}
1152
7cc02fc1
DO
1153// Process a given tag tree and return only meaningful branches. The resulting
1154// (sub)tree will have refcnt leaves on every last branch.
1155function getObjectiveTagTree ($tree, $realm)
1156{
51b6651a 1157 $self = __FUNCTION__;
7cc02fc1
DO
1158 $ret = array();
1159 foreach ($tree as $taginfo)
1160 {
1161 $subsearch = array();
1162 $pick = FALSE;
1163 if (count ($taginfo['kids']))
1164 {
51b6651a 1165 $subsearch = $self ($taginfo['kids'], $realm);
7cc02fc1
DO
1166 $pick = count ($subsearch) > 0;
1167 }
5bdc04ec 1168 if (isset ($taginfo['refcnt'][$realm]))
7cc02fc1
DO
1169 $pick = TRUE;
1170 if (!$pick)
1171 continue;
1172 $ret[] = array
1173 (
1174 'id' => $taginfo['id'],
1175 'tag' => $taginfo['tag'],
1176 'parent_id' => $taginfo['parent_id'],
1177 'refcnt' => $taginfo['refcnt'],
1178 'kids' => $subsearch
1179 );
1180 }
1181 return $ret;
1182}
1183
7ddb2c05
DO
1184// Get taginfo record by tag name, return NULL, if record doesn't exist.
1185function getTagByName ($target_name)
1186{
1187 global $taglist;
1188 foreach ($taglist as $taginfo)
1189 if ($taginfo['tag'] == $target_name)
1190 return $taginfo;
1191 return NULL;
1192}
1193
fc73c734
DO
1194// Merge two chains, filtering dupes out. Return the resulting superset.
1195function mergeTagChains ($chainA, $chainB)
1196{
1197 // $ret = $chainA;
1198 // Reindex by tag id in any case.
1199 $ret = array();
1200 foreach ($chainA as $tag)
1201 $ret[$tag['id']] = $tag;
1202 foreach ($chainB as $tag)
1203 if (!isset ($ret[$tag['id']]))
1204 $ret[$tag['id']] = $tag;
1205 return $ret;
1206}
1207
a0d54e7e 1208function getTagFilter ()
7cc02fc1 1209{
a0d54e7e 1210 return isset ($_REQUEST['tagfilter']) ? complementByKids ($_REQUEST['tagfilter']) : array();
7cc02fc1
DO
1211}
1212
a0d54e7e 1213function getTagFilterStr ($tagfilter = array())
932cf41f 1214{
a0d54e7e 1215 $ret = '';
6e49bd1f 1216 foreach (getExplicitTagsOnly (buildTagChainFromIds ($tagfilter)) as $taginfo)
a0d54e7e
DO
1217 $ret .= "&tagfilter[]=" . $taginfo['id'];
1218 return $ret;
932cf41f 1219}
a0d54e7e 1220
573214e0
DO
1221// Generate RackCode expression according to provided tag filter.
1222function buildCellFilter ()
1223{
1224 if (!isset ($_REQUEST['tagfilter']) or !is_array ($_REQUEST['tagfilter']))
1225 return array();
1226 $ret = array();
1227 $or = $text = '';
1228 global $taglist;
1229 foreach ($_REQUEST['tagfilter'] as $req_id)
1230 if (isset ($taglist[$req_id]))
1231 {
1232 $text .= $or . '{' . $taglist[$req_id]['tag'] . '}';
1233 $or = ' or ';
1234 }
1235 $expr = spotPayload ($text, 'SYNT_EXPR');
1236 return $expr['load'];
1237}
1238
31c941ec
DO
1239function getCellFilter ()
1240{
1241 $boolop = '';
1242 if (!isset ($_REQUEST['cfv']) or $_REQUEST['cfv'] == 1 or $_REQUEST['cfv'] == 2)
1243 {
1244 $ret = array
1245 (
1246 'version' => 1,
1247 'tagidlist' => array(),
1248 'tnamelist' => array(),
590e1281 1249 'pnamelist' => array(),
31c941ec
DO
1250 'text' => '',
1251 'expression' => array()
1252 );
1253 global $taglist;
1254 // Both tags and predicates, which don't exist, should be
1255 // handled somehow. Discard them silently for now.
1256 if (isset ($_REQUEST['tagfilter']) and is_array ($_REQUEST['tagfilter']))
1257 foreach ($_REQUEST['tagfilter'] as $req_id)
1258 if (isset ($taglist[$req_id]))
1259 {
1260 $ret['tagidlist'][] = $req_id;
1261 $ret['tnamelist'][] = $taglist[$req_id]['tag'];
1262 $ret['text'] .= $boolop . '{' . $taglist[$req_id]['tag'] . '}';
1263 $boolop = ' or ';
1264 }
1265 if ($_REQUEST['cfv'] == 2)
1266 {
1267 $ret['version'] = 2;
31c941ec
DO
1268 global $pTable;
1269 if (isset ($_REQUEST['cfp']) and is_array ($_REQUEST['cfp']))
1270 foreach ($_REQUEST['cfp'] as $req_name)
1271 if (isset ($pTable[$req_name]))
1272 {
1273 $ret['pnamelist'][] = $req_name;
1274 $ret['text'] .= $boolop . '[' . $req_name . ']';
1275 $boolop = ' or ';
1276 }
1277 }
1278 if (!empty ($ret['text']))
1279 {
1280 $parse = spotPayload ($ret['text'], 'SYNT_EXPR');
1281 $ret['expression'] = $parse['load'];
1282 }
1283 return $ret;
1284 }
1285 elseif ($_REQUEST['cfv'] == 3)
1286 {
1287 $ret = array
1288 (
1289 'version' => 3,
1290 'text' => '',
1291 'expression' => array()
1292 );
1293 if (isset ($_REQUEST['cfe']))
1294 {
1295 $parse = spotPayload ($_REQUEST['cfe'], 'SYNT_EXPR');
1296 if ($parse['result'] == 'ACK')
1297 {
1298 $ret['text'] = $_REQUEST['cfe'];
1299 $ret['expression'] = $parse['load'];
1300 }
1301 }
1302 return $ret;
1303 }
1304 else
1305 {
1306 showError ('Cannot dispatch cell list filter data', __FUNCTION__);
1307 return NULL;
1308 }
1309}
1310
4fbb5a00 1311function buildWideRedirectURL ($log, $nextpage = NULL, $nexttab = NULL, $moreArgs = array())
da958e52 1312{
46f92ff7 1313 global $root, $page, $pageno, $tabno;
baf37d01
DO
1314 if ($nextpage === NULL)
1315 $nextpage = $pageno;
1316 if ($nexttab === NULL)
1317 $nexttab = $tabno;
1318 $url = "${root}?page=${nextpage}&tab=${nexttab}";
1319 if (isset ($page[$nextpage]['bypass']))
1320 $url .= '&' . $page[$nextpage]['bypass'] . '=' . $_REQUEST[$page[$nextpage]['bypass']];
83555c04 1321
4fbb5a00
DY
1322 if (count($moreArgs)>0)
1323 {
1324 foreach($moreArgs as $arg=>$value)
1325 {
1326 if (gettype($value) == 'array')
1327 {
1328 foreach ($value as $v)
1329 {
1330 $url .= '&'.urlencode($arg.'[]').'='.urlencode($v);
1331 }
1332 }
1333 else
1334 $url .= '&'.urlencode($arg).'='.urlencode($value);
1335 }
1336 }
83555c04
DY
1337
1338 $_SESSION['log'] = $log;
da958e52
DO
1339 return $url;
1340}
1341
135080d8 1342function buildRedirectURL ($callfunc, $status, $args = array(), $nextpage = NULL, $nexttab = NULL)
46f92ff7 1343{
b3029d5c 1344 global $pageno, $tabno, $msgcode;
baf37d01
DO
1345 if ($nextpage === NULL)
1346 $nextpage = $pageno;
1347 if ($nexttab === NULL)
1348 $nexttab = $tabno;
b3029d5c 1349 return buildWideRedirectURL (oneLiner ($msgcode[$callfunc][$status], $args), $nextpage, $nexttab);
2987fc1f
DO
1350}
1351
db55cf54
DO
1352// Return an empty message log.
1353function emptyLog ()
1354{
1355 return array
1356 (
1357 'v' => 2,
1358 'm' => array()
1359 );
1360}
1361
2987fc1f
DO
1362// Return a message log consisting of only one message.
1363function oneLiner ($code, $args = array())
1364{
db55cf54 1365 $ret = emptyLog();
2987fc1f
DO
1366 $ret['m'][] = count ($args) ? array ('c' => $code, 'a' => $args) : array ('c' => $code);
1367 return $ret;
46f92ff7
DO
1368}
1369
e53b1246
DO
1370// Merge message payload from two message logs given and return the result.
1371function mergeLogs ($log1, $log2)
1372{
1373 $ret = emptyLog();
1374 $ret['m'] = array_merge ($log1['m'], $log2['m']);
1375 return $ret;
1376}
1377
9f54e6e9 1378function validTagName ($s, $allow_autotag = FALSE)
2eeeca80 1379{
9f54e6e9
DO
1380 if (1 == mb_ereg (TAGNAME_REGEXP, $s))
1381 return TRUE;
1382 if ($allow_autotag and 1 == mb_ereg (AUTOTAGNAME_REGEXP, $s))
1383 return TRUE;
1384 return FALSE;
2eeeca80
DO
1385}
1386
53bae67b
DO
1387function redirectUser ($p, $t)
1388{
1389 global $page, $root;
1390 $l = "{$root}?page=${p}&tab=${t}";
1391 if (isset ($page[$p]['bypass']) and isset ($_REQUEST[$page[$p]['bypass']]))
1392 $l .= '&' . $page[$p]['bypass'] . '=' . $_REQUEST[$page[$p]['bypass']];
1393 header ("Location: " . $l);
1394 die;
1395}
1396
9f3e5caa
DO
1397function getRackCodeStats ()
1398{
1399 global $rackCode;
914b439b 1400 $defc = $grantc = $modc = 0;
9f3e5caa
DO
1401 foreach ($rackCode as $s)
1402 switch ($s['type'])
1403 {
1404 case 'SYNT_DEFINITION':
1405 $defc++;
1406 break;
1407 case 'SYNT_GRANT':
1408 $grantc++;
1409 break;
914b439b
DO
1410 case 'SYNT_CTXMOD':
1411 $modc++;
1412 break;
9f3e5caa
DO
1413 default:
1414 break;
1415 }
914b439b
DO
1416 $ret = array
1417 (
1418 'Definition sentences' => $defc,
1419 'Grant sentences' => $grantc,
1420 'Context mod sentences' => $modc
1421 );
9f3e5caa
DO
1422 return $ret;
1423}
1424
d5157018
DO
1425function getRackImageWidth ()
1426{
529eac25
DO
1427 global $rtwidth;
1428 return 3 + $rtwidth[0] + $rtwidth[1] + $rtwidth[2] + 3;
d5157018
DO
1429}
1430
1431function getRackImageHeight ($units)
1432{
1433 return 3 + 3 + $units * 2;
1434}
1435
2987fc1f
DO
1436// Perform substitutions and return resulting string
1437// used solely by buildLVSConfig()
1438function apply_macros ($macros, $subject)
1439{
1440 $ret = $subject;
1441 foreach ($macros as $search => $replace)
1442 $ret = str_replace ($search, $replace, $ret);
1443 return $ret;
1444}
1445
1446function buildLVSConfig ($object_id = 0)
1447{
1448 if ($object_id <= 0)
1449 {
1450 showError ('Invalid argument', __FUNCTION__);
1451 return;
1452 }
7ddbcf59 1453 $oInfo = getObjectInfo ($object_id, FALSE);
2987fc1f
DO
1454 $lbconfig = getSLBConfig ($object_id);
1455 if ($lbconfig === NULL)
1456 {
1457 showError ('getSLBConfig() failed', __FUNCTION__);
1458 return;
1459 }
1460 $newconfig = "#\n#\n# This configuration has been generated automatically by RackTables\n";
1461 $newconfig .= "# for object_id == ${object_id}\n# object name: ${oInfo['name']}\n#\n#\n\n\n";
1462 foreach ($lbconfig as $vs_id => $vsinfo)
1463 {
1464 $newconfig .= "########################################################\n" .
1465 "# VS (id == ${vs_id}): " . (empty ($vsinfo['vs_name']) ? 'NO NAME' : $vsinfo['vs_name']) . "\n" .
1466 "# RS pool (id == ${vsinfo['pool_id']}): " . (empty ($vsinfo['pool_name']) ? 'ANONYMOUS' : $vsinfo['pool_name']) . "\n" .
1467 "########################################################\n";
1468 # The order of inheritance is: VS -> LB -> pool [ -> RS ]
1469 $macros = array
1470 (
1471 '%VIP%' => $vsinfo['vip'],
1472 '%VPORT%' => $vsinfo['vport'],
1473 '%PROTO%' => $vsinfo['proto'],
1474 '%VNAME%' => $vsinfo['vs_name'],
1475 '%RSPOOLNAME%' => $vsinfo['pool_name']
1476 );
1477 $newconfig .= "virtual_server ${vsinfo['vip']} ${vsinfo['vport']} {\n";
1478 $newconfig .= "\tprotocol ${vsinfo['proto']}\n";
1479 $newconfig .= apply_macros
1480 (
1481 $macros,
1482 lf_wrap ($vsinfo['vs_vsconfig']) .
1483 lf_wrap ($vsinfo['lb_vsconfig']) .
1484 lf_wrap ($vsinfo['pool_vsconfig'])
1485 );
1486 foreach ($vsinfo['rslist'] as $rs)
1487 {
79a9edb4
DO
1488 if (empty ($rs['rsport']))
1489 $rs['rsport'] = $vsinfo['vport'];
2987fc1f
DO
1490 $macros['%RSIP%'] = $rs['rsip'];
1491 $macros['%RSPORT%'] = $rs['rsport'];
1492 $newconfig .= "\treal_server ${rs['rsip']} ${rs['rsport']} {\n";
1493 $newconfig .= apply_macros
1494 (
1495 $macros,
1496 lf_wrap ($vsinfo['vs_rsconfig']) .
1497 lf_wrap ($vsinfo['lb_rsconfig']) .
1498 lf_wrap ($vsinfo['pool_rsconfig']) .
1499 lf_wrap ($rs['rs_rsconfig'])
1500 );
1501 $newconfig .= "\t}\n";
1502 }
1503 $newconfig .= "}\n\n\n";
1504 }
3dd72e34
DO
1505 // FIXME: deal somehow with Mac-styled text, the below replacement will screw it up
1506 return str_replace ("\r", '', $newconfig);
2987fc1f
DO
1507}
1508
2d318652
DO
1509// Indicate occupation state of each IP address: none, ordinary or problematic.
1510function markupIPv4AddrList (&$addrlist)
1511{
1512 foreach (array_keys ($addrlist) as $ip_bin)
1513 {
d983f70a
DO
1514 $refc = array
1515 (
00c5d8cb
DO
1516 'shared' => 0, // virtual
1517 'virtual' => 0, // loopback
1518 'regular' => 0, // connected host
1519 'router' => 0 // connected gateway
d983f70a
DO
1520 );
1521 foreach ($addrlist[$ip_bin]['allocs'] as $a)
1522 $refc[$a['type']]++;
00c5d8cb 1523 $nvirtloopback = ($refc['shared'] + $refc['virtual'] > 0) ? 1 : 0; // modulus of virtual + shared
d983f70a
DO
1524 $nreserved = ($addrlist[$ip_bin]['reserved'] == 'yes') ? 1 : 0; // only one reservation is possible ever
1525 $nrealms = $nreserved + $nvirtloopback + $refc['regular'] + $refc['router']; // latter two are connected and router allocations
2d318652
DO
1526
1527 if ($nrealms == 1)
1528 $addrlist[$ip_bin]['class'] = 'trbusy';
1529 elseif ($nrealms > 1)
1530 $addrlist[$ip_bin]['class'] = 'trerror';
1531 else
1532 $addrlist[$ip_bin]['class'] = '';
1533 }
1534}
1535
04d619d0
DO
1536// Scan the given address list (returned by scanIPv4Space) and return a list of all routers found.
1537function findRouters ($addrlist)
1538{
1539 $ret = array();
1540 foreach ($addrlist as $addr)
1541 foreach ($addr['allocs'] as $alloc)
1542 if ($alloc['type'] == 'router')
1543 $ret[] = array
1544 (
1545 'id' => $alloc['object_id'],
1546 'iface' => $alloc['name'],
1547 'dname' => $alloc['object_name'],
1548 'addr' => $addr['ip']
1549 );
1550 return $ret;
1551}
1552
fb7a4967
DO
1553// Assist in tag chain sorting.
1554function taginfoCmp ($tagA, $tagB)
1555{
1556 return $tagA['ci'] - $tagB['ci'];
1557}
1558
1327d9dd
DO
1559// Compare networks. When sorting a tree, the records on the list will have
1560// distinct base IP addresses.
3444ecf2
DO
1561// "The comparison function must return an integer less than, equal to, or greater
1562// than zero if the first argument is considered to be respectively less than,
1563// equal to, or greater than the second." (c) PHP manual
1327d9dd
DO
1564function IPv4NetworkCmp ($netA, $netB)
1565{
2d75c30b
DO
1566 // There's a problem just substracting one u32 integer from another,
1567 // because the result may happen big enough to become a negative i32
1568 // integer itself (PHP tries to cast everything it sees to signed int)
3444ecf2
DO
1569 // The comparison below must treat positive and negative values of both
1570 // arguments.
1571 // Equal values give instant decision regardless of their [equal] sign.
1572 if ($netA['ip_bin'] == $netB['ip_bin'])
2d75c30b 1573 return 0;
3444ecf2
DO
1574 // Same-signed values compete arithmetically within one of i32 contiguous ranges:
1575 // 0x00000001~0x7fffffff 1~2147483647
1576 // 0 doesn't have any sign, and network 0.0.0.0 isn't allowed
1577 // 0x80000000~0xffffffff -2147483648~-1
1578 $signA = $netA['ip_bin'] / abs ($netA['ip_bin']);
1579 $signB = $netB['ip_bin'] / abs ($netB['ip_bin']);
1580 if ($signA == $signB)
1581 {
1582 if ($netA['ip_bin'] > $netB['ip_bin'])
1583 return 1;
1584 else
1585 return -1;
1586 }
1587 else // With only one of two values being negative, it... wins!
1588 {
1589 if ($netA['ip_bin'] < $netB['ip_bin'])
1590 return 1;
1591 else
1592 return -1;
1593 }
1327d9dd
DO
1594}
1595
fb7a4967 1596// Modify the given tag tree so, that each level's items are sorted alphabetically.
1327d9dd 1597function sortTree (&$tree, $sortfunc = '')
fb7a4967 1598{
1327d9dd
DO
1599 if (empty ($sortfunc))
1600 return;
51b6651a 1601 $self = __FUNCTION__;
1327d9dd 1602 usort ($tree, $sortfunc);
fb7a4967
DO
1603 // Don't make a mistake of directly iterating over the items of current level, because this way
1604 // the sorting will be performed on a _copy_ if each item, not the item itself.
1605 foreach (array_keys ($tree) as $tagid)
51b6651a 1606 $self ($tree[$tagid]['kids'], $sortfunc);
fb7a4967
DO
1607}
1608
0137d53c
DO
1609function iptree_fill (&$netdata)
1610{
1611 if (!isset ($netdata['kids']) or empty ($netdata['kids']))
1612 return;
a987ff52 1613 // If we really have nested prefixes, they must fit into the tree.
0137d53c
DO
1614 $worktree = array
1615 (
1616 'ip_bin' => $netdata['ip_bin'],
1617 'mask' => $netdata['mask']
1618 );
1619 foreach ($netdata['kids'] as $pfx)
1620 iptree_embed ($worktree, $pfx);
1621 $netdata['kids'] = iptree_construct ($worktree);
1622 $netdata['kidc'] = count ($netdata['kids']);
1623}
1624
1625function iptree_construct ($node)
1626{
1627 $self = __FUNCTION__;
1628
1629 if (!isset ($node['right']))
1630 {
1631 if (!isset ($node['ip']))
1632 {
1633 $node['ip'] = long2ip ($node['ip_bin']);
1634 $node['kids'] = array();
fec0c8da 1635 $node['kidc'] = 0;
0137d53c
DO
1636 $node['name'] = '';
1637 }
1638 return array ($node);
1639 }
1640 else
1641 return array_merge ($self ($node['left']), $self ($node['right']));
1642}
1643
1644function iptree_embed (&$node, $pfx)
1645{
1646 $self = __FUNCTION__;
1647
1648 // hit?
1649 if ($node['ip_bin'] == $pfx['ip_bin'] and $node['mask'] == $pfx['mask'])
1650 {
1651 $node = $pfx;
1652 return;
1653 }
1654 if ($node['mask'] == $pfx['mask'])
1655 {
1656 showError ('Internal error, the recurring loop lost control', __FUNCTION__);
1657 die;
1658 }
1659
1660 // split?
1661 if (!isset ($node['right']))
1662 {
a987ff52
DO
1663 // Fill in db_first/db_last to make it possible to run scanIPv4Space() on the node.
1664 $node['left']['mask'] = $node['mask'] + 1;
0137d53c 1665 $node['left']['ip_bin'] = $node['ip_bin'];
a987ff52
DO
1666 $node['left']['db_first'] = sprintf ('%u', $node['left']['ip_bin']);
1667 $node['left']['db_last'] = sprintf ('%u', $node['left']['ip_bin'] | binInvMaskFromDec ($node['left']['mask']));
1668
1669 $node['right']['mask'] = $node['mask'] + 1;
0137d53c 1670 $node['right']['ip_bin'] = $node['ip_bin'] + binInvMaskFromDec ($node['mask'] + 1) + 1;
a987ff52
DO
1671 $node['right']['db_first'] = sprintf ('%u', $node['right']['ip_bin']);
1672 $node['right']['db_last'] = sprintf ('%u', $node['right']['ip_bin'] | binInvMaskFromDec ($node['right']['mask']));
0137d53c
DO
1673 }
1674
1675 // repeat!
1676 if (($node['left']['ip_bin'] & binMaskFromDec ($node['left']['mask'])) == ($pfx['ip_bin'] & binMaskFromDec ($node['left']['mask'])))
1677 $self ($node['left'], $pfx);
1678 elseif (($node['right']['ip_bin'] & binMaskFromDec ($node['right']['mask'])) == ($pfx['ip_bin'] & binMaskFromDec ($node['left']['mask'])))
1679 $self ($node['right'], $pfx);
1680 else
1681 {
1682 showError ('Internal error, cannot decide between left and right', __FUNCTION__);
1683 die;
1684 }
1685}
1686
3b81cb98 1687function treeApplyFunc (&$tree, $func = '', $stopfunc = '')
0137d53c
DO
1688{
1689 if (empty ($func))
1690 return;
1691 $self = __FUNCTION__;
1692 foreach (array_keys ($tree) as $key)
1693 {
1694 $func ($tree[$key]);
c3315231
DO
1695 if (!empty ($stopfunc) and $stopfunc ($tree[$key]))
1696 continue;
0137d53c
DO
1697 $self ($tree[$key]['kids'], $func);
1698 }
1699}
1700
a987ff52
DO
1701function loadIPv4AddrList (&$netinfo)
1702{
1703 loadOwnIPv4Addresses ($netinfo);
1704 markupIPv4AddrList ($netinfo['addrlist']);
1705}
b18d26dc 1706
b6b87070 1707function countOwnIPv4Addresses (&$node)
b18d26dc 1708{
b6b87070 1709 $toscan = array();
737a3f72 1710 $node['addrt'] = 0;
4d0dbd87
DO
1711 $node['mask_bin'] = binMaskFromDec ($node['mask']);
1712 $node['mask_bin_inv'] = binInvMaskFromDec ($node['mask']);
1713 $node['db_first'] = sprintf ('%u', 0x00000000 + $node['ip_bin'] & $node['mask_bin']);
1714 $node['db_last'] = sprintf ('%u', 0x00000000 + $node['ip_bin'] | ($node['mask_bin_inv']));
b6b87070 1715 if (empty ($node['kids']))
737a3f72 1716 {
f7414fa5 1717 $toscan[] = array ('i32_first' => $node['db_first'], 'i32_last' => $node['db_last']);
737a3f72
DO
1718 $node['addrt'] = binInvMaskFromDec ($node['mask']) + 1;
1719 }
b18d26dc 1720 else
b6b87070 1721 foreach ($node['kids'] as $nested)
b18d26dc 1722 if (!isset ($nested['id'])) // spare
737a3f72 1723 {
f7414fa5 1724 $toscan[] = array ('i32_first' => $nested['db_first'], 'i32_last' => $nested['db_last']);
737a3f72
DO
1725 $node['addrt'] += binInvMaskFromDec ($nested['mask']) + 1;
1726 }
4d0dbd87
DO
1727 // Don't do anything more, because the displaying function will load the addresses anyway.
1728 return;
f7414fa5 1729 $node['addrc'] = count (scanIPv4Space ($toscan));
b6b87070
DO
1730}
1731
c3315231
DO
1732function nodeIsCollapsed ($node)
1733{
1734 return $node['symbol'] == 'node-collapsed';
1735}
1736
b6b87070
DO
1737function loadOwnIPv4Addresses (&$node)
1738{
1739 $toscan = array();
1740 if (empty ($node['kids']))
f7414fa5 1741 $toscan[] = array ('i32_first' => $node['db_first'], 'i32_last' => $node['db_last']);
b6b87070
DO
1742 else
1743 foreach ($node['kids'] as $nested)
1744 if (!isset ($nested['id'])) // spare
f7414fa5
DO
1745 $toscan[] = array ('i32_first' => $nested['db_first'], 'i32_last' => $nested['db_last']);
1746 $node['addrlist'] = scanIPv4Space ($toscan);
b6b87070 1747 $node['addrc'] = count ($node['addrlist']);
b18d26dc
DO
1748}
1749
fec0c8da
DO
1750function prepareIPv4Tree ($netlist, $expanded_id = 0)
1751{
573214e0
DO
1752 // treeFromList() requires parent_id to be correct for an item to get onto the tree,
1753 // so perform necessary pre-processing to make orphans belong to root. This trick
1754 // was earlier performed by getIPv4NetworkList().
1755 $netids = array_keys ($netlist);
1756 foreach ($netids as $cid)
1757 if (!in_array ($netlist[$cid]['parent_id'], $netids))
1758 $netlist[$cid]['parent_id'] = NULL;
fec0c8da
DO
1759 $tree = treeFromList ($netlist); // medium call
1760 sortTree ($tree, 'IPv4NetworkCmp');
fec0c8da 1761 // complement the tree before markup to make the spare networks have "symbol" set
c3315231
DO
1762 treeApplyFunc ($tree, 'iptree_fill');
1763 iptree_markup_collapsion ($tree, getConfigVar ('TREE_THRESHOLD'), $expanded_id);
1764 // count addresses after the markup to skip computation for hidden tree nodes
1765 treeApplyFunc ($tree, 'countOwnIPv4Addresses', 'nodeIsCollapsed');
fec0c8da
DO
1766 return $tree;
1767}
1768
1769// Check all items of the tree recursively, until the requested target id is
1770// found. Mark all items leading to this item as "expanded", collapsing all
1771// the rest, which exceed the given threshold (if the threshold is given).
1772function iptree_markup_collapsion (&$tree, $threshold = 1024, $target = 0)
1773{
1774 $self = __FUNCTION__;
1775 $ret = FALSE;
1776 foreach (array_keys ($tree) as $key)
1777 {
5388794d 1778 $here = ($target === 'ALL' or ($target > 0 and isset ($tree[$key]['id']) and $tree[$key]['id'] == $target));
fec0c8da
DO
1779 $below = $self ($tree[$key]['kids'], $threshold, $target);
1780 if (!$tree[$key]['kidc']) // terminal node
1781 $tree[$key]['symbol'] = 'spacer';
1782 elseif ($tree[$key]['kidc'] < $threshold)
1783 $tree[$key]['symbol'] = 'node-expanded-static';
1784 elseif ($here or $below)
1785 $tree[$key]['symbol'] = 'node-expanded';
1786 else
1787 $tree[$key]['symbol'] = 'node-collapsed';
1788 $ret = ($ret or $here or $below); // parentheses are necessary for this to be computed correctly
1789 }
1790 return $ret;
1791}
1792
e1ae3fb4
AD
1793// Convert entity name to human-readable value
1794function formatEntityName ($name) {
1795 switch ($name)
1796 {
1797 case 'ipv4net':
1798 return 'IPv4 Network';
1799 case 'ipv4rspool':
1800 return 'IPv4 RS Pool';
1801 case 'ipv4vs':
1802 return 'IPv4 Virtual Service';
1803 case 'object':
1804 return 'Object';
1805 case 'rack':
1806 return 'Rack';
1807 case 'user':
1808 return 'User';
1809 }
1810 return 'invalid';
1811}
1812
1813// Take a MySQL or other generic timestamp and make it prettier
1814function formatTimestamp ($timestamp) {
1815 return date('n/j/y g:iA', strtotime($timestamp));
1816}
1817
8bc5d1e4
DO
1818// Display hrefs for all of a file's parents. If scissors are requested,
1819// prepend cutting button to each of them.
1820function serializeFileLinks ($links, $scissors = FALSE)
e1ae3fb4
AD
1821{
1822 global $root;
1823
1824 $comma = '';
1825 $ret = '';
1826 foreach ($links as $link_id => $li)
1827 {
1828 switch ($li['entity_type'])
1829 {
1830 case 'ipv4net':
1831 $params = "page=ipv4net&id=";
1832 break;
1833 case 'ipv4rspool':
1834 $params = "page=ipv4rspool&pool_id=";
1835 break;
1836 case 'ipv4vs':
1837 $params = "page=ipv4vs&vs_id=";
1838 break;
1839 case 'object':
1840 $params = "page=object&object_id=";
1841 break;
1842 case 'rack':
1843 $params = "page=rack&rack_id=";
1844 break;
1845 case 'user':
1846 $params = "page=user&user_id=";
1847 break;
1848 }
8bc5d1e4
DO
1849 $ret .= $comma;
1850 if ($scissors)
1851 {
1852 $ret .= "<a href='" . makeHrefProcess(array('op'=>'unlinkFile', 'link_id'=>$link_id)) . "'";
1853 $ret .= getImageHREF ('cut') . '</a> ';
1854 }
1855 $ret .= sprintf("<a href='%s?%s%s'>%s</a>", $root, $params, $li['entity_id'], $li['name']);
1856 $comma = '<br>';
e1ae3fb4 1857 }
e1ae3fb4
AD
1858 return $ret;
1859}
1860
1861// Convert filesize to appropriate unit and make it human-readable
1862function formatFileSize ($bytes) {
1863 // bytes
1864 if($bytes < 1024) // bytes
1865 return "${bytes} bytes";
1866
1867 // kilobytes
1868 if ($bytes < 1024000)
1869 return sprintf ("%.1fk", round (($bytes / 1024), 1));
1870
1871 // megabytes
1872 return sprintf ("%.1f MB", round (($bytes / 1024000), 1));
1873}
1874
1875// Reverse of formatFileSize, it converts human-readable value to bytes
1876function convertToBytes ($value) {
1877 $value = trim($value);
1878 $last = strtolower($value[strlen($value)-1]);
1879 switch ($last)
1880 {
1881 case 'g':
1882 $value *= 1024;
1883 case 'm':
1884 $value *= 1024;
1885 case 'k':
1886 $value *= 1024;
1887 }
1888
1889 return $value;
1890}
1891
4fbb5a00
DY
1892function ip_quad2long ($ip)
1893{
1894 return sprintf("%u", ip2long($ip));
1895}
1896
1897function ip_long2quad ($quad)
1898{
1899 return long2ip($quad);
1900}
1901
1902function makeHref($params = array())
1903{
1904 global $head_revision, $numeric_revision, $root;
1905 $ret = $root.'?';
1906 $first = true;
1907 if (!isset($params['r']) and ($numeric_revision != $head_revision))
1908 {
1909 $params['r'] = $numeric_revision;
1910 }
1911 foreach($params as $key=>$value)
1912 {
1913 if (!$first)
1914 $ret.='&';
1915 $ret .= urlencode($key).'='.urlencode($value);
1916 $first = false;
1917 }
1918 return $ret;
1919}
1920
1921function makeHrefProcess($params = array())
1922{
1923 global $head_revision, $numeric_revision, $root, $pageno, $tabno;
1924 $ret = $root.'process.php'.'?';
1925 $first = true;
1926 if ($numeric_revision != $head_revision)
1927 {
1928 error_log("Can't make a process link when not in head revision");
1929 die();
1930 }
9f14a7ef
DY
1931 if (!isset($params['page']))
1932 $params['page'] = $pageno;
1933 if (!isset($params['tab']))
1934 $params['tab'] = $tabno;
4fbb5a00
DY
1935 foreach($params as $key=>$value)
1936 {
1937 if (!$first)
1938 $ret.='&';
1939 $ret .= urlencode($key).'='.urlencode($value);
1940 $first = false;
1941 }
1942 return $ret;
1943}
1944
39106006 1945function makeHrefForHelper ($helper_name, $params = array())
4fbb5a00
DY
1946{
1947 global $head_revision, $numeric_revision, $root;
e8dd0422 1948 $ret = $root.'popup.php'.'?helper='.$helper_name;
4fbb5a00
DY
1949 if ($numeric_revision != $head_revision)
1950 {
1951 error_log("Can't make a process link when not in head revision");
1952 die();
1953 }
1954 foreach($params as $key=>$value)
39106006 1955 $ret .= '&'.urlencode($key).'='.urlencode($value);
4fbb5a00
DY
1956 return $ret;
1957}
1958
f3d274bf
DO
1959// Process the given list of records to build data suitable for printNiftySelect()
1960// (like it was formerly executed by printSelect()). Screen out vendors according
1961// to VENDOR_SIEVE, if object type ID is provided. However, the OPTGROUP with already
1962// selected OPTION is protected from being screened.
1963function cookOptgroups ($recordList, $object_type_id = 0, $existing_value = 0)
1964{
1965 $ret = array();
1966 // Always keep "other" OPTGROUP at the SELECT bottom.
1967 $therest = array();
1968 foreach ($recordList as $dict_key => $dict_value)
1969 if (strpos ($dict_value, '%GSKIP%') !== FALSE)
1970 {
1971 $tmp = explode ('%GSKIP%', $dict_value, 2);
1972 $ret[$tmp[0]][$dict_key] = $tmp[1];
1973 }
1974 elseif (strpos ($dict_value, '%GPASS%') !== FALSE)
1975 {
1976 $tmp = explode ('%GPASS%', $dict_value, 2);
1977 $ret[$tmp[0]][$dict_key] = $tmp[1];
1978 }
1979 else
1980 $therest[$dict_key] = $dict_value;
1981 if ($object_type_id != 0)
1982 {
1983 $screenlist = array();
1984 foreach (explode (';', getConfigVar ('VENDOR_SIEVE')) as $sieve)
1985 if (FALSE !== mb_ereg ("^([^@]+)(@${object_type_id})?\$", trim ($sieve), $regs))
1986 $screenlist[] = $regs[1];
1987 foreach (array_keys ($ret) as $vendor)
1988 if (in_array ($vendor, $screenlist))
1989 {
1990 $ok_to_screen = TRUE;
1991 if ($existing_value)
1992 foreach (array_keys ($ret[$vendor]) as $recordkey)
1993 if ($recordkey == $existing_value)
1994 {
1995 $ok_to_screen = FALSE;
1996 break;
1997 }
1998 if ($ok_to_screen)
1999 unset ($ret[$vendor]);
2000 }
2001 }
2002 $ret['other'] = $therest;
2003 return $ret;
2004}
2005
f8874cdb
DO
2006function dos2unix ($text)
2007{
2008 return str_replace ("\r\n", "\n", $text);
2009}
2010
a0527aef 2011function buildPredicateTable ($parsetree)
2c21a10c 2012{
a0527aef
DO
2013 $ret = array();
2014 foreach ($parsetree as $sentence)
72e8baf6 2015 if ($sentence['type'] == 'SYNT_DEFINITION')
a0527aef 2016 $ret[$sentence['term']] = $sentence['definition'];
72e8baf6
DO
2017 // Now we have predicate table filled in with the latest definitions of each
2018 // particular predicate met. This isn't as chik, as on-the-fly predicate
2019 // overloading during allow/deny scan, but quite sufficient for this task.
a0527aef
DO
2020 return $ret;
2021}
2022
2023// Take a list of records and filter against given RackCode expression. Return
2024// the original list intact, if there was no filter requested, but return an
2025// empty list, if there was an error.
2026function filterEntityList ($list_in, $realm, $expression = array())
2027{
7f3dc533
DO
2028 if ($expression === NULL)
2029 return array();
a0527aef
DO
2030 if (!count ($expression))
2031 return $list_in;
a0527aef 2032 $list_out = array();
2c21a10c 2033 foreach ($list_in as $item_key => $item_value)
7ddbcf59 2034 if (TRUE === judgeEntity ($realm, $item_key, $expression))
2c21a10c 2035 $list_out[$item_key] = $item_value;
2c21a10c
DO
2036 return $list_out;
2037}
2038
573214e0 2039function filterCellList ($list_in, $expression = array())
d08d766d
DO
2040{
2041 if ($expression === NULL)
2042 return array();
2043 if (!count ($expression))
2044 return $list_in;
d08d766d
DO
2045 $list_out = array();
2046 foreach ($list_in as $item_key => $item_value)
573214e0 2047 if (TRUE === judgeCell ($item_value, $expression))
d08d766d
DO
2048 $list_out[$item_key] = $item_value;
2049 return $list_out;
2050}
2051
a0527aef 2052// Tell, if the given expression is true for the given entity.
7ddbcf59 2053function judgeEntity ($realm, $id, $expression)
a0527aef
DO
2054{
2055 $item_explicit_tags = loadEntityTags ($realm, $id);
7ddbcf59 2056 global $pTable;
a0527aef
DO
2057 return eval_expression
2058 (
2059 $expression,
2060 array_merge
2061 (
2062 $item_explicit_tags,
2063 getImplicitTags ($item_explicit_tags),
2064 generateEntityAutoTags ($realm, $id)
2065 ),
7ddbcf59 2066 $pTable,
a0527aef
DO
2067 TRUE
2068 );
2069}
2070
d08d766d 2071// Idem, but use complete record instead of key.
573214e0 2072function judgeCell ($cell, $expression)
d08d766d
DO
2073{
2074 global $pTable;
2075 return eval_expression
2076 (
2077 $expression,
2078 array_merge
2079 (
573214e0
DO
2080 $cell['etags'],
2081 $cell['itags'],
2082 $cell['atags']
d08d766d
DO
2083 ),
2084 $pTable,
2085 TRUE
2086 );
2087}
2088
7f3dc533
DO
2089// If the requested predicate exists, return its [last] definition.
2090// Otherwise return NULL (to signal filterEntityList() about error).
2091// Also detect "not set" option selected.
2092function interpretPredicate ($pname)
2093{
2094 if ($pname == '_')
2095 return array();
854aec3f
DO
2096 global $pTable;
2097 if (isset ($pTable[$pname]))
2098 return $pTable[$pname];
2099 return NULL;
7f3dc533
DO
2100}
2101
7ddbcf59 2102// Tell, if a constraint from config option permits given record.
c6bc0ac5
DO
2103function considerConfiguredConstraint ($entity_realm, $entity_id, $varname)
2104{
7ddbcf59 2105 if (!strlen (getConfigVar ($varname)))
c6bc0ac5 2106 return TRUE; // no restriction
7ddbcf59
DO
2107 global $parseCache;
2108 if (!isset ($parseCache[$varname]))
2109 // getConfigVar() doesn't re-read the value from DB because of its
2110 // own cache, so there is no race condition here between two calls.
2111 $parseCache[$varname] = spotPayload (getConfigVar ($varname), 'SYNT_EXPR');
2112 if ($parseCache[$varname]['result'] != 'ACK')
2113 return FALSE; // constraint set, but cannot be used due to compilation error
2114 return judgeEntity ($entity_realm, $entity_id, $parseCache[$varname]['load']);
c6bc0ac5
DO
2115}
2116
e673ee24 2117?>