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