r3155 - don't display IPv4 address comment as a header, but put it into navigation...
[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 sortObjectAddressesAndNames ($a, $b)
665{
666 $objname_cmp = sortTokenize($a['object_name'], $b['object_name']);
667 if ($objname_cmp == 0)
668 {
79f22c3d
DO
669 $name_a = (isset ($a['port_name'])) ? $a['port_name'] : '';
670 $name_b = (isset ($b['port_name'])) ? $b['port_name'] : '';
671 $objname_cmp = sortTokenize($name_a, $name_b);
e673ee24 672 if ($objname_cmp == 0)
e673ee24 673 sortTokenize($a['ip'], $b['ip']);
e673ee24
DO
674 return $objname_cmp;
675 }
676 return $objname_cmp;
677}
678
c31cd72c 679// This function returns an array of single element of object's FQDN attribute,
f321b50a
DO
680// if FQDN is set. The next choice is object's common name, if it looks like a
681// hostname. Otherwise an array of all 'regular' IP addresses of the
c31cd72c 682// object is returned (which may appear 0 and more elements long).
f321b50a 683function findAllEndpoints ($object_id, $fallback = '')
c31cd72c 684{
7fa7047a
DO
685 foreach (getAttrValues ($object_id) as $record)
686 if ($record['id'] == 3 && strlen ($record['value'])) // FQDN
c31cd72c 687 return array ($record['value']);
c31cd72c 688 $regular = array();
85970da2
DO
689 foreach (getObjectIPv4Allocations ($object_id) as $dottedquad => $alloc)
690 if ($alloc['type'] == 'regular')
691 $regular[] = $dottedquad;
59a83bd8 692 if (!count ($regular) && strlen ($fallback))
f321b50a 693 return array ($fallback);
c31cd72c
DO
694 return $regular;
695}
696
83ba6670
DO
697// Some records in the dictionary may be written as plain text or as Wiki
698// link in the following syntax:
699// 1. word
700// 2. [[word URL]] // FIXME: this isn't working
701// 3. [[word word word | URL]]
702// This function parses the line and returns text suitable for either A
703// (rendering <A HREF>) or O (for <OPTION>).
7fa7047a 704function parseWikiLink ($line, $which)
83ba6670 705{
010231c2 706 if (preg_match ('/^\[\[.+\]\]$/', $line) == 0)
24cbe8af 707 {
7fa7047a
DO
708 // always strip the marker for A-data, but let cookOptgroup()
709 // do this later (otherwise it can't sort groups out)
710 if ($which == 'a')
f0b540a3 711 return ereg_replace ('^.+%GSKIP%', '', ereg_replace ('^(.+)%GPASS%', '\\1 ', $line));
24cbe8af
DO
712 else
713 return $line;
714 }
010231c2
DO
715 $line = preg_replace ('/^\[\[(.+)\]\]$/', '$1', $line);
716 $s = explode ('|', $line);
83ba6670 717 $o_value = trim ($s[0]);
83ba6670
DO
718 if ($which == 'o')
719 return $o_value;
7fa7047a
DO
720 $o_value = ereg_replace ('^.+%GSKIP%', '', ereg_replace ('^(.+)%GPASS%', '\\1 ', $o_value));
721 $a_value = trim ($s[1]);
722 return "<a href='${a_value}'>${o_value}</a>";
83ba6670
DO
723}
724
c9edf725
DO
725// FIXME: should this be saved as "P-data"?
726function execGMarker ($line)
727{
728 return ereg_replace ('^.+%GSKIP%', '', ereg_replace ('^(.+)%GPASS%', '\\1 ', $line));
729}
730
177b1e9b
DO
731// rackspace usage for a single rack
732// (T + W + U) / (height * 3 - A)
11df133a 733function getRSUforRack ($data = NULL)
177b1e9b 734{
11df133a 735 if ($data == NULL)
177b1e9b
DO
736 {
737 showError ('Invalid argument', __FUNCTION__);
738 return NULL;
739 }
6ffba290 740 $counter = array ('A' => 0, 'U' => 0, 'T' => 0, 'W' => 0, 'F' => 0);
9e60f7df
DO
741 for ($unit_no = $data['height']; $unit_no > 0; $unit_no--)
742 for ($locidx = 0; $locidx < 3; $locidx++)
743 $counter[$data[$unit_no][$locidx]['state']]++;
dfa3c075 744 return ($counter['T'] + $counter['W'] + $counter['U']) / ($counter['T'] + $counter['W'] + $counter['U'] + $counter['F']);
177b1e9b
DO
745}
746
11df133a
DO
747// Same for row.
748function getRSUforRackRow ($rowData = NULL)
749{
bb26a59e 750 if ($rowData === NULL)
11df133a
DO
751 {
752 showError ('Invalid argument', __FUNCTION__);
753 return NULL;
754 }
bb26a59e
DO
755 if (!count ($rowData))
756 return 0;
11df133a 757 $counter = array ('A' => 0, 'U' => 0, 'T' => 0, 'W' => 0, 'F' => 0);
f81a2012 758 $total_height = 0;
dfa3c075
DO
759 foreach (array_keys ($rowData) as $rack_id)
760 {
61a1d996
DO
761 $data = spotEntity ('rack', $rack_id);
762 amplifyCell ($data);
dfa3c075 763 $total_height += $data['height'];
11df133a
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
DO
767 }
768 return ($counter['T'] + $counter['W'] + $counter['U']) / ($counter['T'] + $counter['W'] + $counter['U'] + $counter['F']);
11df133a
DO
769}
770
9af110b4
DO
771// Make sure the string is always wrapped with LF characters
772function lf_wrap ($str)
773{
774 $ret = trim ($str, "\r\n");
59a83bd8 775 if (strlen ($ret))
9af110b4
DO
776 $ret .= "\n";
777 return $ret;
778}
779
e6e7d8b3
DO
780// Adopted from Mantis BTS code.
781function string_insert_hrefs ($s)
782{
783 if (getConfigVar ('DETECT_URLS') != 'yes')
784 return $s;
785 # Find any URL in a string and replace it by a clickable link
786 $s = preg_replace( '/(([[:alpha:]][-+.[:alnum:]]*):\/\/(%[[:digit:]A-Fa-f]{2}|[-_.!~*\';\/?%^\\\\:@&={\|}+$#\(\),\[\][:alnum:]])+)/se',
787 "'<a href=\"'.rtrim('\\1','.').'\">\\1</a> [<a href=\"'.rtrim('\\1','.').'\" target=\"_blank\">^</a>]'",
788 $s);
789 $s = preg_replace( '/\b' . email_regex_simple() . '\b/i',
790 '<a href="mailto:\0">\0</a>',
791 $s);
792 return $s;
793}
794
795// Idem.
796function email_regex_simple ()
797{
798 return "(([a-z0-9!#*+\/=?^_{|}~-]+(?:\.[a-z0-9!#*+\/=?^_{|}~-]+)*)" . # recipient
799 "\@((?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?))"; # @domain
800}
801
118e4c38
DO
802// Parse AUTOPORTS_CONFIG and return a list of generated pairs (port_type, port_name)
803// for the requested object_type_id.
804function getAutoPorts ($type_id)
805{
806 $ret = array();
807 $typemap = explode (';', str_replace (' ', '', getConfigVar ('AUTOPORTS_CONFIG')));
808 foreach ($typemap as $equation)
809 {
810 $tmp = explode ('=', $equation);
811 if (count ($tmp) != 2)
812 continue;
813 $objtype_id = $tmp[0];
814 if ($objtype_id != $type_id)
815 continue;
816 $portlist = $tmp[1];
817 foreach (explode ('+', $portlist) as $product)
818 {
819 $tmp = explode ('*', $product);
820 if (count ($tmp) != 3)
821 continue;
822 $nports = $tmp[0];
823 $port_type = $tmp[1];
824 $format = $tmp[2];
825 for ($i = 0; $i < $nports; $i++)
826 $ret[] = array ('type' => $port_type, 'name' => @sprintf ($format, $i));
827 }
828 }
829 return $ret;
830}
831
86256b96
DO
832// Use pre-served trace to traverse the tree, then place given node where it belongs.
833function pokeNode (&$tree, $trace, $key, $value, $threshold = 0)
834{
835 // This function needs the trace to be followed FIFO-way. The fastest
836 // way to do so is to use array_push() for putting values into the
837 // list and array_shift() for getting them out. This exposed up to 11%
838 // performance gain compared to other patterns of array_push/array_unshift/
839 // array_reverse/array_pop/array_shift conjunction.
840 $myid = array_shift ($trace);
841 if (!count ($trace)) // reached the target
9dfd4cc9 842 {
86256b96
DO
843 if (!$threshold or ($threshold and $tree[$myid]['kidc'] + 1 < $threshold))
844 $tree[$myid]['kids'][$key] = $value;
845 // Reset accumulated records once, when the limit is reached, not each time
846 // after that.
847 if (++$tree[$myid]['kidc'] == $threshold)
848 $tree[$myid]['kids'] = array();
849 }
850 else // not yet
851 {
852 $self = __FUNCTION__;
853 $self ($tree[$myid]['kids'], $trace, $key, $value, $threshold);
9dfd4cc9 854 }
9dfd4cc9
DO
855}
856
0ba76ca2
DO
857// Likewise traverse the tree with the trace and return the final node.
858function peekNode ($tree, $trace, $target_id)
859{
860 $self = __FUNCTION__;
861 if (NULL === ($next = array_shift ($trace))) // warm
862 {
863 foreach ($tree as $node)
f1e27fe5 864 if (array_key_exists ('id', $node) and $node['id'] == $target_id) // hot
0ba76ca2
DO
865 return $node;
866 }
867 else // cold
868 {
869 foreach ($tree as $node)
870 if ($node['id'] == $next) // warmer
871 return $self ($node['kids'], $trace, $target_id);
872 }
873 // HCF
874 return NULL;
875}
876
d65353ad
DO
877// Build a tree from the item list and return it. Input and output data is
878// indexed by item id (nested items in output are recursively stored in 'kids'
51b6651a
DO
879// key, which is in turn indexed by id. Functions, which are ready to handle
880// tree collapsion/expansion themselves, may request non-zero threshold value
881// for smaller resulting tree.
3fb336f6 882function treeFromList (&$orig_nodelist, $threshold = 0, $return_main_payload = TRUE)
d65353ad 883{
86256b96 884 $tree = array();
3fb336f6 885 $nodelist = $orig_nodelist;
86256b96
DO
886 // Array equivalent of traceEntity() function.
887 $trace = array();
888 // set kidc and kids only once
889 foreach (array_keys ($nodelist) as $nodeid)
890 {
891 $nodelist[$nodeid]['kidc'] = 0;
892 $nodelist[$nodeid]['kids'] = array();
893 }
894 do
9dfd4cc9 895 {
86256b96
DO
896 $nextpass = FALSE;
897 foreach (array_keys ($nodelist) as $nodeid)
9dfd4cc9 898 {
86256b96
DO
899 // When adding a node to the working tree, book another
900 // iteration, because the new item could make a way for
901 // others onto the tree. Also remove any item added from
902 // the input list, so iteration base shrinks.
903 // First check if we can assign directly.
904 if ($nodelist[$nodeid]['parent_id'] == NULL)
9dfd4cc9 905 {
86256b96
DO
906 $tree[$nodeid] = $nodelist[$nodeid];
907 $trace[$nodeid] = array(); // Trace to root node is empty
908 unset ($nodelist[$nodeid]);
909 $nextpass = TRUE;
9dfd4cc9 910 }
86256b96
DO
911 // Now look if it fits somewhere on already built tree.
912 elseif (isset ($trace[$nodelist[$nodeid]['parent_id']]))
9dfd4cc9 913 {
86256b96
DO
914 // Trace to a node is a trace to its parent plus parent id.
915 $trace[$nodeid] = $trace[$nodelist[$nodeid]['parent_id']];
916 $trace[$nodeid][] = $nodelist[$nodeid]['parent_id'];
917 pokeNode ($tree, $trace[$nodeid], $nodeid, $nodelist[$nodeid], $threshold);
918 // path to any other node is made of all parent nodes plus the added node itself
919 unset ($nodelist[$nodeid]);
920 $nextpass = TRUE;
9dfd4cc9
DO
921 }
922 }
9dfd4cc9 923 }
86256b96 924 while ($nextpass);
3fb336f6 925 if (!$return_main_payload)
86256b96 926 return $nodelist;
3fb336f6
DO
927 // update each input node with its backtrace route
928 foreach ($trace as $nodeid => $route)
929 $orig_nodelist[$nodeid]['trace'] = $route;
930 return $tree;
9dfd4cc9
DO
931}
932
49fb1027 933// Build a tree from the tag list and return everything _except_ the tree.
573214e0
DO
934// IOW, return taginfo items, which have parent_id set and pointing outside
935// of the "normal" tree, which originates from the root.
49fb1027
DO
936function getOrphanedTags ()
937{
938 global $taglist;
86256b96 939 return treeFromList ($taglist, 0, FALSE);
49fb1027
DO
940}
941
6e49bd1f 942function serializeTags ($chain, $baseurl = '')
ba93bd98
DO
943{
944 $comma = '';
945 $ret = '';
6e49bd1f 946 foreach ($chain as $taginfo)
ba93bd98 947 {
e2ac59cf 948 $ret .= $comma .
a8efc03e 949 ($baseurl == '' ? '' : "<a href='${baseurl}cft[]=${taginfo['id']}'>") .
e2ac59cf
DO
950 $taginfo['tag'] .
951 ($baseurl == '' ? '' : '</a>');
ba93bd98
DO
952 $comma = ', ';
953 }
954 return $ret;
955}
956
ba93bd98
DO
957// Return the list of missing implicit tags.
958function getImplicitTags ($oldtags)
959{
3fb336f6
DO
960 global $taglist;
961 $tmp = array();
962 foreach ($oldtags as $taginfo)
963 $tmp = array_merge ($tmp, $taglist[$taginfo['id']]['trace']);
964 // don't call array_unique here, it is in the function we will call now
965 return buildTagChainFromIds ($tmp);
ba93bd98
DO
966}
967
6e49bd1f 968// Minimize the chain: exclude all implicit tags and return the result.
5fd2a004
DO
969// This function makes use of an external cache with a miss/hit ratio
970// about 3/7 (ticket:255).
3fb336f6 971function getExplicitTagsOnly ($chain)
ab379543 972{
5fd2a004 973 global $taglist, $tagRelCache;
ab379543 974 $ret = array();
5fd2a004
DO
975 foreach (array_keys ($chain) as $keyA) // check each A
976 {
977 $tagidA = $chain[$keyA]['id'];
978 // do not include A in result, if A is seen on the trace of any B!=A
979 foreach (array_keys ($chain) as $keyB)
980 {
981 $tagidB = $chain[$keyB]['id'];
982 if ($tagidA == $tagidB)
983 continue;
984 if (!isset ($tagRelCache[$tagidA][$tagidB]))
0745db4d 985 $tagRelCache[$tagidA][$tagidB] = in_array ($tagidA, $taglist[$tagidB]['trace']);
5fd2a004
DO
986 if ($tagRelCache[$tagidA][$tagidB] === TRUE) // A is ancestor of B
987 continue 2; // skip this A
988 }
989 $ret[] = $chain[$keyA];
990 }
74ccacff
DO
991 return $ret;
992}
993
2c21a10c 994// Universal autotags generator, a complementing function for loadEntityTags().
2c21a10c 995// Bypass key isn't strictly typed, but interpreted depending on the realm.
d16af52f 996function generateEntityAutoTags ($cell)
cce6b057 997{
cce6b057 998 $ret = array();
d16af52f 999 switch ($cell['realm'])
2c21a10c
DO
1000 {
1001 case 'rack':
d16af52f 1002 $ret[] = array ('tag' => '$rackid_' . $cell['id']);
2c21a10c
DO
1003 $ret[] = array ('tag' => '$any_rack');
1004 break;
4c9d35ec 1005 case 'object':
d16af52f
DO
1006 $ret[] = array ('tag' => '$id_' . $cell['id']);
1007 $ret[] = array ('tag' => '$typeid_' . $cell['objtype_id']);
2c21a10c 1008 $ret[] = array ('tag' => '$any_object');
588b2b79 1009 if (validTagName ('$cn_' . $cell['name'], TRUE))
d16af52f
DO
1010 $ret[] = array ('tag' => '$cn_' . $cell['name']);
1011 if (!strlen ($cell['rack_id']))
914b439b 1012 $ret[] = array ('tag' => '$unmounted');
6d472f26
DO
1013 if (!$cell['nports'])
1014 $ret[] = array ('tag' => '$portless');
2c21a10c 1015 break;
4c9d35ec 1016 case 'ipv4net':
d16af52f
DO
1017 $ret[] = array ('tag' => '$ip4netid_' . $cell['id']);
1018 $ret[] = array ('tag' => '$ip4net-' . str_replace ('.', '-', $cell['ip']) . '-' . $cell['mask']);
b9b915d5
DO
1019 for ($i = 8; $i < 32; $i++)
1020 {
1021 // these conditions hit 1 to 3 times per each i
1022 if ($cell['mask'] >= $i)
1023 $ret[] = array ('tag' => '$masklen_ge_' . $i);
1024 if ($cell['mask'] <= $i)
1025 $ret[] = array ('tag' => '$masklen_le_' . $i);
1026 if ($cell['mask'] == $i)
1027 $ret[] = array ('tag' => '$masklen_eq_' . $i);
1028 }
2c21a10c
DO
1029 $ret[] = array ('tag' => '$any_ip4net');
1030 $ret[] = array ('tag' => '$any_net');
1031 break;
1032 case 'ipv4vs':
d16af52f 1033 $ret[] = array ('tag' => '$ipv4vsid_' . $cell['id']);
2c21a10c
DO
1034 $ret[] = array ('tag' => '$any_ipv4vs');
1035 $ret[] = array ('tag' => '$any_vs');
1036 break;
1037 case 'ipv4rspool':
d16af52f 1038 $ret[] = array ('tag' => '$ipv4rspid_' . $cell['id']);
2c21a10c
DO
1039 $ret[] = array ('tag' => '$any_ipv4rsp');
1040 $ret[] = array ('tag' => '$any_rsp');
1041 break;
1042 case 'user':
b82cce3f
DO
1043 // {$username_XXX} autotag is generated always, but {$userid_XXX}
1044 // appears only for accounts, which exist in local database.
d16af52f
DO
1045 $ret[] = array ('tag' => '$username_' . $cell['user_name']);
1046 if (isset ($cell['user_id']))
1047 $ret[] = array ('tag' => '$userid_' . $cell['user_id']);
2c21a10c
DO
1048 break;
1049 case 'file':
d16af52f 1050 $ret[] = array ('tag' => '$fileid_' . $cell['id']);
2c21a10c
DO
1051 $ret[] = array ('tag' => '$any_file');
1052 break;
d16af52f 1053 default: // HCF!
2c21a10c
DO
1054 break;
1055 }
4c9d35ec
DO
1056 // {$tagless} doesn't apply to users
1057 switch ($cell['realm'])
1058 {
1059 case 'rack':
1060 case 'object':
1061 case 'ipv4net':
1062 case 'ipv4vs':
1063 case 'ipv4rspool':
1064 case 'file':
1065 if (!count ($cell['etags']))
1066 $ret[] = array ('tag' => '$untagged');
1067 break;
1068 default:
1069 break;
1070 }
f9bc186f
DO
1071 return $ret;
1072}
1073
abef7149
DO
1074// Check, if the given tag is present on the chain (will only work
1075// for regular tags with tag ID set.
1076function tagOnChain ($taginfo, $tagchain)
1077{
1078 if (!isset ($taginfo['id']))
1079 return FALSE;
1080 foreach ($tagchain as $test)
1081 if ($test['id'] == $taginfo['id'])
1082 return TRUE;
1083 return FALSE;
1084}
1085
f8821b96
DO
1086function tagNameOnChain ($tagname, $tagchain)
1087{
1088 foreach ($tagchain as $test)
1089 if ($test['tag'] == $tagname)
1090 return TRUE;
1091 return FALSE;
1092}
1093
abef7149
DO
1094// Return TRUE, if two tags chains differ (order of tags doesn't matter).
1095// Assume, that neither of the lists contains duplicates.
1096// FIXME: a faster, than O(x^2) method is possible for this calculation.
1097function tagChainCmp ($chain1, $chain2)
1098{
1099 if (count ($chain1) != count ($chain2))
1100 return TRUE;
1101 foreach ($chain1 as $taginfo1)
1102 if (!tagOnChain ($taginfo1, $chain2))
1103 return TRUE;
1104 return FALSE;
1105}
1106
0df8c52b 1107function redirectIfNecessary ()
da958e52 1108{
0df8c52b 1109 global $pageno, $tabno;
53bae67b
DO
1110 $pmap = array
1111 (
1112 'accounts' => 'userlist',
1113 'rspools' => 'ipv4rsplist',
1114 'rspool' => 'ipv4rsp',
1115 'vservices' => 'ipv4vslist',
1116 'vservice' => 'ipv4vs',
c78a40ec
DO
1117 'objects' => 'depot',
1118 'objgroup' => 'depot',
53bae67b
DO
1119 );
1120 $tmap = array();
1121 $tmap['objects']['newmulti'] = 'addmore';
1122 $tmap['objects']['newobj'] = 'addmore';
1123 $tmap['object']['switchvlans'] = 'livevlans';
1124 $tmap['object']['slb'] = 'editrspvs';
72d8ced3
DO
1125 $tmap['object']['portfwrd'] = 'nat4';
1126 $tmap['object']['network'] = 'ipv4';
53bae67b
DO
1127 if (isset ($pmap[$pageno]))
1128 redirectUser ($pmap[$pageno], $tabno);
1129 if (isset ($tmap[$pageno][$tabno]))
1130 redirectUser ($pageno, $tmap[$pageno][$tabno]);
0df8c52b
DO
1131}
1132
1133function fixContext ($target = NULL)
1134{
1135 global
1136 $pageno,
1137 $auto_tags,
1138 $expl_tags,
1139 $impl_tags,
1140 $target_given_tags,
1141 $user_given_tags,
1142 $etype_by_pageno,
1143 $page;
53bae67b 1144
0df8c52b
DO
1145 if ($target !== NULL)
1146 {
1147 $target_given_tags = $target['etags'];
1148 // Don't reset autochain, because auth procedures could push stuff there in.
1149 // Another important point is to ignore 'user' realm, so we don't infuse effective
1150 // context with autotags of the displayed account.
1151 if ($target['realm'] != 'user')
1152 $auto_tags = array_merge ($auto_tags, $target['atags']);
1153 }
1154 elseif (array_key_exists ($pageno, $etype_by_pageno))
53da7dca
DO
1155 {
1156 // Each page listed in the map above requires one uint argument.
0a50efb4 1157 $target_realm = $etype_by_pageno[$pageno];
0df8c52b 1158 assertUIntArg ($page[$pageno]['bypass'], __FUNCTION__);
0a50efb4 1159 $target_id = $_REQUEST[$page[$pageno]['bypass']];
b135a49d 1160 $target = spotEntity ($target_realm, $target_id);
53da7dca 1161 $target_given_tags = $target['etags'];
0df8c52b 1162 if ($target['realm'] != 'user')
53da7dca
DO
1163 $auto_tags = array_merge ($auto_tags, $target['atags']);
1164 }
4c9b513a
DO
1165 // Explicit and implicit chains should be normally empty at this point, so
1166 // overwrite the contents anyway.
1167 $expl_tags = mergeTagChains ($user_given_tags, $target_given_tags);
1168 $impl_tags = getImplicitTags ($expl_tags);
da958e52
DO
1169}
1170
abef7149
DO
1171// Take a list of user-supplied tag IDs to build a list of valid taginfo
1172// records indexed by tag IDs (tag chain).
6e49bd1f 1173function buildTagChainFromIds ($tagidlist)
ab379543 1174{
20c901a7 1175 global $taglist;
ab379543 1176 $ret = array();
abef7149 1177 foreach (array_unique ($tagidlist) as $tag_id)
ab379543
DO
1178 if (isset ($taglist[$tag_id]))
1179 $ret[] = $taglist[$tag_id];
1180 return $ret;
1181}
1182
7cc02fc1
DO
1183// Process a given tag tree and return only meaningful branches. The resulting
1184// (sub)tree will have refcnt leaves on every last branch.
a26a6ccc 1185function getObjectiveTagTree ($tree, $realm, $preselect)
7cc02fc1 1186{
51b6651a 1187 $self = __FUNCTION__;
7cc02fc1
DO
1188 $ret = array();
1189 foreach ($tree as $taginfo)
1190 {
a26a6ccc
DO
1191 $subsearch = $self ($taginfo['kids'], $realm, $preselect);
1192 // If the current node addresses something, add it to the result
1193 // regardless of how many sub-nodes it features.
1194 if
7cc02fc1 1195 (
a26a6ccc
DO
1196 isset ($taginfo['refcnt'][$realm]) or
1197 count ($subsearch) > 1 or
3fb336f6 1198 in_array ($taginfo['id'], $preselect)
a26a6ccc
DO
1199 )
1200 $ret[] = array
1201 (
1202 'id' => $taginfo['id'],
1203 'tag' => $taginfo['tag'],
1204 'parent_id' => $taginfo['parent_id'],
1205 'refcnt' => $taginfo['refcnt'],
1206 'kids' => $subsearch
1207 );
1208 else
1209 $ret = array_merge ($ret, $subsearch);
7cc02fc1
DO
1210 }
1211 return $ret;
1212}
1213
7ddb2c05
DO
1214// Get taginfo record by tag name, return NULL, if record doesn't exist.
1215function getTagByName ($target_name)
1216{
1217 global $taglist;
1218 foreach ($taglist as $taginfo)
1219 if ($taginfo['tag'] == $target_name)
1220 return $taginfo;
1221 return NULL;
1222}
1223
fc73c734
DO
1224// Merge two chains, filtering dupes out. Return the resulting superset.
1225function mergeTagChains ($chainA, $chainB)
1226{
1227 // $ret = $chainA;
1228 // Reindex by tag id in any case.
1229 $ret = array();
1230 foreach ($chainA as $tag)
1231 $ret[$tag['id']] = $tag;
1232 foreach ($chainB as $tag)
1233 if (!isset ($ret[$tag['id']]))
1234 $ret[$tag['id']] = $tag;
1235 return $ret;
1236}
1237
31c941ec
DO
1238function getCellFilter ()
1239{
7da7450c 1240 global $sic;
3d670bba 1241 if (isset ($_REQUEST['tagfilter']) and is_array ($_REQUEST['tagfilter']))
23cdc7e9
DO
1242 {
1243 $_REQUEST['cft'] = $_REQUEST['tagfilter'];
1244 unset ($_REQUEST['tagfilter']);
1245 }
3d670bba
DO
1246 $ret = array
1247 (
23cdc7e9
DO
1248 'tagidlist' => array(),
1249 'tnamelist' => array(),
1250 'pnamelist' => array(),
1251 'andor' => '',
3d670bba 1252 'text' => '',
23cdc7e9
DO
1253 'extratext' => '',
1254 'expression' => array(),
a8efc03e 1255 'urlextra' => '', // Just put text here and let makeHref call urlencode().
3d670bba 1256 );
23cdc7e9 1257 switch (TRUE)
31c941ec 1258 {
23cdc7e9
DO
1259 case (!isset ($_REQUEST['andor'])):
1260 $andor2 = getConfigVar ('FILTER_DEFAULT_ANDOR');
3d670bba 1261 break;
23cdc7e9
DO
1262 case ($_REQUEST['andor'] == 'and'):
1263 case ($_REQUEST['andor'] == 'or'):
1264 $ret['andor'] = $andor2 = $_REQUEST['andor'];
a8efc03e 1265 $ret['urlextra'] .= '&andor=' . $ret['andor'];
3d670bba
DO
1266 break;
1267 default:
23cdc7e9 1268 showError ('Invalid and/or switch value in submitted form', __FUNCTION__);
3d670bba 1269 return NULL;
31c941ec 1270 }
23cdc7e9
DO
1271 $andor1 = '';
1272 // Both tags and predicates, which don't exist, should be
1273 // handled somehow. Discard them silently for now.
1274 if (isset ($_REQUEST['cft']) and is_array ($_REQUEST['cft']))
31c941ec 1275 {
23cdc7e9
DO
1276 global $taglist;
1277 foreach ($_REQUEST['cft'] as $req_id)
1278 if (isset ($taglist[$req_id]))
1279 {
1280 $ret['tagidlist'][] = $req_id;
1281 $ret['tnamelist'][] = $taglist[$req_id]['tag'];
1282 $ret['text'] .= $andor1 . '{' . $taglist[$req_id]['tag'] . '}';
1283 $andor1 = ' ' . $andor2 . ' ';
a8efc03e 1284 $ret['urlextra'] .= '&cft[]=' . $req_id;
23cdc7e9
DO
1285 }
1286 }
1287 if (isset ($_REQUEST['cfp']) and is_array ($_REQUEST['cfp']))
1288 {
1289 global $pTable;
1290 foreach ($_REQUEST['cfp'] as $req_name)
1291 if (isset ($pTable[$req_name]))
1292 {
1293 $ret['pnamelist'][] = $req_name;
1294 $ret['text'] .= $andor1 . '[' . $req_name . ']';
1295 $andor1 = ' ' . $andor2 . ' ';
a8efc03e 1296 $ret['urlextra'] .= '&cfp[]=' . $req_name;
23cdc7e9
DO
1297 }
1298 }
7da7450c
DO
1299 // Extra text comes from TEXTAREA and is easily screwed by standard escaping function.
1300 if (isset ($sic['cfe']))
a8efc03e 1301 {
7da7450c
DO
1302 // Only consider extra text, when it is a correct RackCode expression.
1303 $parse = spotPayload ($sic['cfe'], 'SYNT_EXPR');
1304 if ($parse['result'] == 'ACK')
1305 {
1306 $ret['extratext'] = trim ($sic['cfe']);
1307 $ret['urlextra'] .= '&cfe=' . $ret['extratext'];
1308 }
a8efc03e 1309 }
23cdc7e9
DO
1310 $finaltext = array();
1311 if (strlen ($ret['text']))
1312 $finaltext[] = '(' . $ret['text'] . ')';
1313 if (strlen ($ret['extratext']))
1314 $finaltext[] = '(' . $ret['extratext'] . ')';
1315 $finaltext = implode (' ' . $andor2 . ' ', $finaltext);
1316 if (strlen ($finaltext))
1317 {
1318 $parse = spotPayload ($finaltext, 'SYNT_EXPR');
1319 $ret['expression'] = $parse['result'] == 'ACK' ? $parse['load'] : NULL;
8c699525
DO
1320 // It's not quite fair enough to put the blame of the whole text onto
1321 // non-empty "extra" portion of it, but it's the only user-generated portion
1322 // of it, thus the most probable cause of parse error.
1323 if (strlen ($ret['extratext']))
1324 $ret['extraclass'] = $parse['result'] == 'ACK' ? 'validation-success' : 'validation-error';
31c941ec 1325 }
3d670bba 1326 return $ret;
31c941ec
DO
1327}
1328
db55cf54
DO
1329// Return an empty message log.
1330function emptyLog ()
1331{
1332 return array
1333 (
1334 'v' => 2,
1335 'm' => array()
1336 );
1337}
1338
2987fc1f
DO
1339// Return a message log consisting of only one message.
1340function oneLiner ($code, $args = array())
1341{
db55cf54 1342 $ret = emptyLog();
2987fc1f
DO
1343 $ret['m'][] = count ($args) ? array ('c' => $code, 'a' => $args) : array ('c' => $code);
1344 return $ret;
46f92ff7
DO
1345}
1346
e53b1246
DO
1347// Merge message payload from two message logs given and return the result.
1348function mergeLogs ($log1, $log2)
1349{
1350 $ret = emptyLog();
1351 $ret['m'] = array_merge ($log1['m'], $log2['m']);
1352 return $ret;
1353}
1354
9f54e6e9 1355function validTagName ($s, $allow_autotag = FALSE)
2eeeca80 1356{
9f54e6e9
DO
1357 if (1 == mb_ereg (TAGNAME_REGEXP, $s))
1358 return TRUE;
1359 if ($allow_autotag and 1 == mb_ereg (AUTOTAGNAME_REGEXP, $s))
1360 return TRUE;
1361 return FALSE;
2eeeca80
DO
1362}
1363
53bae67b
DO
1364function redirectUser ($p, $t)
1365{
790a60e8
DO
1366 global $page;
1367 $l = "index.php?page=${p}&tab=${t}";
53bae67b
DO
1368 if (isset ($page[$p]['bypass']) and isset ($_REQUEST[$page[$p]['bypass']]))
1369 $l .= '&' . $page[$p]['bypass'] . '=' . $_REQUEST[$page[$p]['bypass']];
1370 header ("Location: " . $l);
1371 die;
1372}
1373
9f3e5caa
DO
1374function getRackCodeStats ()
1375{
1376 global $rackCode;
914b439b 1377 $defc = $grantc = $modc = 0;
9f3e5caa
DO
1378 foreach ($rackCode as $s)
1379 switch ($s['type'])
1380 {
1381 case 'SYNT_DEFINITION':
1382 $defc++;
1383 break;
1384 case 'SYNT_GRANT':
1385 $grantc++;
1386 break;
914b439b
DO
1387 case 'SYNT_CTXMOD':
1388 $modc++;
1389 break;
9f3e5caa
DO
1390 default:
1391 break;
1392 }
914b439b
DO
1393 $ret = array
1394 (
1395 'Definition sentences' => $defc,
1396 'Grant sentences' => $grantc,
1397 'Context mod sentences' => $modc
1398 );
9f3e5caa
DO
1399 return $ret;
1400}
1401
d5157018
DO
1402function getRackImageWidth ()
1403{
529eac25
DO
1404 global $rtwidth;
1405 return 3 + $rtwidth[0] + $rtwidth[1] + $rtwidth[2] + 3;
d5157018
DO
1406}
1407
1408function getRackImageHeight ($units)
1409{
1410 return 3 + 3 + $units * 2;
1411}
1412
2987fc1f
DO
1413// Perform substitutions and return resulting string
1414// used solely by buildLVSConfig()
1415function apply_macros ($macros, $subject)
1416{
1417 $ret = $subject;
1418 foreach ($macros as $search => $replace)
1419 $ret = str_replace ($search, $replace, $ret);
1420 return $ret;
1421}
1422
1423function buildLVSConfig ($object_id = 0)
1424{
1425 if ($object_id <= 0)
1426 {
1427 showError ('Invalid argument', __FUNCTION__);
1428 return;
1429 }
6297d584 1430 $oInfo = spotEntity ('object', $object_id);
2987fc1f
DO
1431 $lbconfig = getSLBConfig ($object_id);
1432 if ($lbconfig === NULL)
1433 {
1434 showError ('getSLBConfig() failed', __FUNCTION__);
1435 return;
1436 }
1437 $newconfig = "#\n#\n# This configuration has been generated automatically by RackTables\n";
1438 $newconfig .= "# for object_id == ${object_id}\n# object name: ${oInfo['name']}\n#\n#\n\n\n";
1439 foreach ($lbconfig as $vs_id => $vsinfo)
1440 {
1441 $newconfig .= "########################################################\n" .
59a83bd8
DO
1442 "# VS (id == ${vs_id}): " . (!strlen ($vsinfo['vs_name']) ? 'NO NAME' : $vsinfo['vs_name']) . "\n" .
1443 "# RS pool (id == ${vsinfo['pool_id']}): " . (!strlen ($vsinfo['pool_name']) ? 'ANONYMOUS' : $vsinfo['pool_name']) . "\n" .
2987fc1f
DO
1444 "########################################################\n";
1445 # The order of inheritance is: VS -> LB -> pool [ -> RS ]
1446 $macros = array
1447 (
1448 '%VIP%' => $vsinfo['vip'],
1449 '%VPORT%' => $vsinfo['vport'],
1450 '%PROTO%' => $vsinfo['proto'],
1451 '%VNAME%' => $vsinfo['vs_name'],
1452 '%RSPOOLNAME%' => $vsinfo['pool_name']
1453 );
1454 $newconfig .= "virtual_server ${vsinfo['vip']} ${vsinfo['vport']} {\n";
1455 $newconfig .= "\tprotocol ${vsinfo['proto']}\n";
1456 $newconfig .= apply_macros
1457 (
1458 $macros,
1459 lf_wrap ($vsinfo['vs_vsconfig']) .
1460 lf_wrap ($vsinfo['lb_vsconfig']) .
1461 lf_wrap ($vsinfo['pool_vsconfig'])
1462 );
1463 foreach ($vsinfo['rslist'] as $rs)
1464 {
59a83bd8 1465 if (!strlen ($rs['rsport']))
79a9edb4 1466 $rs['rsport'] = $vsinfo['vport'];
2987fc1f
DO
1467 $macros['%RSIP%'] = $rs['rsip'];
1468 $macros['%RSPORT%'] = $rs['rsport'];
1469 $newconfig .= "\treal_server ${rs['rsip']} ${rs['rsport']} {\n";
1470 $newconfig .= apply_macros
1471 (
1472 $macros,
1473 lf_wrap ($vsinfo['vs_rsconfig']) .
1474 lf_wrap ($vsinfo['lb_rsconfig']) .
1475 lf_wrap ($vsinfo['pool_rsconfig']) .
1476 lf_wrap ($rs['rs_rsconfig'])
1477 );
1478 $newconfig .= "\t}\n";
1479 }
1480 $newconfig .= "}\n\n\n";
1481 }
3dd72e34
DO
1482 // FIXME: deal somehow with Mac-styled text, the below replacement will screw it up
1483 return str_replace ("\r", '', $newconfig);
2987fc1f
DO
1484}
1485
2d318652
DO
1486// Indicate occupation state of each IP address: none, ordinary or problematic.
1487function markupIPv4AddrList (&$addrlist)
1488{
1489 foreach (array_keys ($addrlist) as $ip_bin)
1490 {
d983f70a
DO
1491 $refc = array
1492 (
00c5d8cb
DO
1493 'shared' => 0, // virtual
1494 'virtual' => 0, // loopback
1495 'regular' => 0, // connected host
1496 'router' => 0 // connected gateway
d983f70a
DO
1497 );
1498 foreach ($addrlist[$ip_bin]['allocs'] as $a)
1499 $refc[$a['type']]++;
00c5d8cb 1500 $nvirtloopback = ($refc['shared'] + $refc['virtual'] > 0) ? 1 : 0; // modulus of virtual + shared
d983f70a
DO
1501 $nreserved = ($addrlist[$ip_bin]['reserved'] == 'yes') ? 1 : 0; // only one reservation is possible ever
1502 $nrealms = $nreserved + $nvirtloopback + $refc['regular'] + $refc['router']; // latter two are connected and router allocations
2d318652
DO
1503
1504 if ($nrealms == 1)
1505 $addrlist[$ip_bin]['class'] = 'trbusy';
1506 elseif ($nrealms > 1)
1507 $addrlist[$ip_bin]['class'] = 'trerror';
1508 else
1509 $addrlist[$ip_bin]['class'] = '';
1510 }
1511}
1512
04d619d0
DO
1513// Scan the given address list (returned by scanIPv4Space) and return a list of all routers found.
1514function findRouters ($addrlist)
1515{
1516 $ret = array();
1517 foreach ($addrlist as $addr)
1518 foreach ($addr['allocs'] as $alloc)
1519 if ($alloc['type'] == 'router')
1520 $ret[] = array
1521 (
1522 'id' => $alloc['object_id'],
1523 'iface' => $alloc['name'],
1524 'dname' => $alloc['object_name'],
1525 'addr' => $addr['ip']
1526 );
1527 return $ret;
1528}
1529
fb7a4967
DO
1530// Assist in tag chain sorting.
1531function taginfoCmp ($tagA, $tagB)
1532{
1533 return $tagA['ci'] - $tagB['ci'];
1534}
1535
1327d9dd
DO
1536// Compare networks. When sorting a tree, the records on the list will have
1537// distinct base IP addresses.
3444ecf2
DO
1538// "The comparison function must return an integer less than, equal to, or greater
1539// than zero if the first argument is considered to be respectively less than,
1540// equal to, or greater than the second." (c) PHP manual
1327d9dd
DO
1541function IPv4NetworkCmp ($netA, $netB)
1542{
2d75c30b
DO
1543 // There's a problem just substracting one u32 integer from another,
1544 // because the result may happen big enough to become a negative i32
1545 // integer itself (PHP tries to cast everything it sees to signed int)
3444ecf2
DO
1546 // The comparison below must treat positive and negative values of both
1547 // arguments.
1548 // Equal values give instant decision regardless of their [equal] sign.
1549 if ($netA['ip_bin'] == $netB['ip_bin'])
2d75c30b 1550 return 0;
3444ecf2
DO
1551 // Same-signed values compete arithmetically within one of i32 contiguous ranges:
1552 // 0x00000001~0x7fffffff 1~2147483647
1553 // 0 doesn't have any sign, and network 0.0.0.0 isn't allowed
1554 // 0x80000000~0xffffffff -2147483648~-1
1555 $signA = $netA['ip_bin'] / abs ($netA['ip_bin']);
1556 $signB = $netB['ip_bin'] / abs ($netB['ip_bin']);
1557 if ($signA == $signB)
1558 {
1559 if ($netA['ip_bin'] > $netB['ip_bin'])
1560 return 1;
1561 else
1562 return -1;
1563 }
1564 else // With only one of two values being negative, it... wins!
1565 {
1566 if ($netA['ip_bin'] < $netB['ip_bin'])
1567 return 1;
1568 else
1569 return -1;
1570 }
1327d9dd
DO
1571}
1572
fb7a4967 1573// Modify the given tag tree so, that each level's items are sorted alphabetically.
1327d9dd 1574function sortTree (&$tree, $sortfunc = '')
fb7a4967 1575{
59a83bd8 1576 if (!strlen ($sortfunc))
1327d9dd 1577 return;
51b6651a 1578 $self = __FUNCTION__;
1327d9dd 1579 usort ($tree, $sortfunc);
fb7a4967
DO
1580 // Don't make a mistake of directly iterating over the items of current level, because this way
1581 // the sorting will be performed on a _copy_ if each item, not the item itself.
1582 foreach (array_keys ($tree) as $tagid)
51b6651a 1583 $self ($tree[$tagid]['kids'], $sortfunc);
fb7a4967
DO
1584}
1585
0137d53c
DO
1586function iptree_fill (&$netdata)
1587{
59a83bd8 1588 if (!isset ($netdata['kids']) or !count ($netdata['kids']))
0137d53c 1589 return;
a987ff52 1590 // If we really have nested prefixes, they must fit into the tree.
0137d53c
DO
1591 $worktree = array
1592 (
1593 'ip_bin' => $netdata['ip_bin'],
1594 'mask' => $netdata['mask']
1595 );
1596 foreach ($netdata['kids'] as $pfx)
1597 iptree_embed ($worktree, $pfx);
1598 $netdata['kids'] = iptree_construct ($worktree);
1599 $netdata['kidc'] = count ($netdata['kids']);
1600}
1601
1602function iptree_construct ($node)
1603{
1604 $self = __FUNCTION__;
1605
1606 if (!isset ($node['right']))
1607 {
1608 if (!isset ($node['ip']))
1609 {
1610 $node['ip'] = long2ip ($node['ip_bin']);
1611 $node['kids'] = array();
fec0c8da 1612 $node['kidc'] = 0;
0137d53c
DO
1613 $node['name'] = '';
1614 }
1615 return array ($node);
1616 }
1617 else
1618 return array_merge ($self ($node['left']), $self ($node['right']));
1619}
1620
1621function iptree_embed (&$node, $pfx)
1622{
1623 $self = __FUNCTION__;
1624
1625 // hit?
1626 if ($node['ip_bin'] == $pfx['ip_bin'] and $node['mask'] == $pfx['mask'])
1627 {
1628 $node = $pfx;
1629 return;
1630 }
1631 if ($node['mask'] == $pfx['mask'])
1632 {
1633 showError ('Internal error, the recurring loop lost control', __FUNCTION__);
1634 die;
1635 }
1636
1637 // split?
1638 if (!isset ($node['right']))
1639 {
a987ff52
DO
1640 // Fill in db_first/db_last to make it possible to run scanIPv4Space() on the node.
1641 $node['left']['mask'] = $node['mask'] + 1;
0137d53c 1642 $node['left']['ip_bin'] = $node['ip_bin'];
a987ff52
DO
1643 $node['left']['db_first'] = sprintf ('%u', $node['left']['ip_bin']);
1644 $node['left']['db_last'] = sprintf ('%u', $node['left']['ip_bin'] | binInvMaskFromDec ($node['left']['mask']));
1645
1646 $node['right']['mask'] = $node['mask'] + 1;
0137d53c 1647 $node['right']['ip_bin'] = $node['ip_bin'] + binInvMaskFromDec ($node['mask'] + 1) + 1;
a987ff52
DO
1648 $node['right']['db_first'] = sprintf ('%u', $node['right']['ip_bin']);
1649 $node['right']['db_last'] = sprintf ('%u', $node['right']['ip_bin'] | binInvMaskFromDec ($node['right']['mask']));
0137d53c
DO
1650 }
1651
1652 // repeat!
1653 if (($node['left']['ip_bin'] & binMaskFromDec ($node['left']['mask'])) == ($pfx['ip_bin'] & binMaskFromDec ($node['left']['mask'])))
1654 $self ($node['left'], $pfx);
1655 elseif (($node['right']['ip_bin'] & binMaskFromDec ($node['right']['mask'])) == ($pfx['ip_bin'] & binMaskFromDec ($node['left']['mask'])))
1656 $self ($node['right'], $pfx);
1657 else
1658 {
1659 showError ('Internal error, cannot decide between left and right', __FUNCTION__);
1660 die;
1661 }
1662}
1663
3b81cb98 1664function treeApplyFunc (&$tree, $func = '', $stopfunc = '')
0137d53c 1665{
59a83bd8 1666 if (!strlen ($func))
0137d53c
DO
1667 return;
1668 $self = __FUNCTION__;
1669 foreach (array_keys ($tree) as $key)
1670 {
1671 $func ($tree[$key]);
59a83bd8 1672 if (strlen ($stopfunc) and $stopfunc ($tree[$key]))
c3315231 1673 continue;
0137d53c
DO
1674 $self ($tree[$key]['kids'], $func);
1675 }
1676}
1677
a987ff52
DO
1678function loadIPv4AddrList (&$netinfo)
1679{
1680 loadOwnIPv4Addresses ($netinfo);
1681 markupIPv4AddrList ($netinfo['addrlist']);
1682}
b18d26dc 1683
b6b87070 1684function countOwnIPv4Addresses (&$node)
b18d26dc 1685{
b6b87070 1686 $toscan = array();
737a3f72 1687 $node['addrt'] = 0;
4d0dbd87
DO
1688 $node['mask_bin'] = binMaskFromDec ($node['mask']);
1689 $node['mask_bin_inv'] = binInvMaskFromDec ($node['mask']);
1690 $node['db_first'] = sprintf ('%u', 0x00000000 + $node['ip_bin'] & $node['mask_bin']);
1691 $node['db_last'] = sprintf ('%u', 0x00000000 + $node['ip_bin'] | ($node['mask_bin_inv']));
59a83bd8 1692 if (!count ($node['kids']))
737a3f72 1693 {
f7414fa5 1694 $toscan[] = array ('i32_first' => $node['db_first'], 'i32_last' => $node['db_last']);
737a3f72
DO
1695 $node['addrt'] = binInvMaskFromDec ($node['mask']) + 1;
1696 }
b18d26dc 1697 else
b6b87070 1698 foreach ($node['kids'] as $nested)
b18d26dc 1699 if (!isset ($nested['id'])) // spare
737a3f72 1700 {
f7414fa5 1701 $toscan[] = array ('i32_first' => $nested['db_first'], 'i32_last' => $nested['db_last']);
737a3f72
DO
1702 $node['addrt'] += binInvMaskFromDec ($nested['mask']) + 1;
1703 }
4d0dbd87
DO
1704 // Don't do anything more, because the displaying function will load the addresses anyway.
1705 return;
f7414fa5 1706 $node['addrc'] = count (scanIPv4Space ($toscan));
b6b87070
DO
1707}
1708
c3315231
DO
1709function nodeIsCollapsed ($node)
1710{
1711 return $node['symbol'] == 'node-collapsed';
1712}
1713
b6b87070
DO
1714function loadOwnIPv4Addresses (&$node)
1715{
1716 $toscan = array();
43eb71f1 1717 if (!isset ($node['kids']) or !count ($node['kids']))
f7414fa5 1718 $toscan[] = array ('i32_first' => $node['db_first'], 'i32_last' => $node['db_last']);
b6b87070
DO
1719 else
1720 foreach ($node['kids'] as $nested)
1721 if (!isset ($nested['id'])) // spare
f7414fa5
DO
1722 $toscan[] = array ('i32_first' => $nested['db_first'], 'i32_last' => $nested['db_last']);
1723 $node['addrlist'] = scanIPv4Space ($toscan);
b6b87070 1724 $node['addrc'] = count ($node['addrlist']);
b18d26dc
DO
1725}
1726
fec0c8da
DO
1727function prepareIPv4Tree ($netlist, $expanded_id = 0)
1728{
573214e0
DO
1729 // treeFromList() requires parent_id to be correct for an item to get onto the tree,
1730 // so perform necessary pre-processing to make orphans belong to root. This trick
1731 // was earlier performed by getIPv4NetworkList().
1732 $netids = array_keys ($netlist);
1733 foreach ($netids as $cid)
1734 if (!in_array ($netlist[$cid]['parent_id'], $netids))
1735 $netlist[$cid]['parent_id'] = NULL;
fec0c8da
DO
1736 $tree = treeFromList ($netlist); // medium call
1737 sortTree ($tree, 'IPv4NetworkCmp');
fec0c8da 1738 // complement the tree before markup to make the spare networks have "symbol" set
c3315231
DO
1739 treeApplyFunc ($tree, 'iptree_fill');
1740 iptree_markup_collapsion ($tree, getConfigVar ('TREE_THRESHOLD'), $expanded_id);
1741 // count addresses after the markup to skip computation for hidden tree nodes
1742 treeApplyFunc ($tree, 'countOwnIPv4Addresses', 'nodeIsCollapsed');
fec0c8da
DO
1743 return $tree;
1744}
1745
1746// Check all items of the tree recursively, until the requested target id is
1747// found. Mark all items leading to this item as "expanded", collapsing all
1748// the rest, which exceed the given threshold (if the threshold is given).
1749function iptree_markup_collapsion (&$tree, $threshold = 1024, $target = 0)
1750{
1751 $self = __FUNCTION__;
1752 $ret = FALSE;
1753 foreach (array_keys ($tree) as $key)
1754 {
5388794d 1755 $here = ($target === 'ALL' or ($target > 0 and isset ($tree[$key]['id']) and $tree[$key]['id'] == $target));
fec0c8da
DO
1756 $below = $self ($tree[$key]['kids'], $threshold, $target);
1757 if (!$tree[$key]['kidc']) // terminal node
1758 $tree[$key]['symbol'] = 'spacer';
1759 elseif ($tree[$key]['kidc'] < $threshold)
1760 $tree[$key]['symbol'] = 'node-expanded-static';
1761 elseif ($here or $below)
1762 $tree[$key]['symbol'] = 'node-expanded';
1763 else
1764 $tree[$key]['symbol'] = 'node-collapsed';
1765 $ret = ($ret or $here or $below); // parentheses are necessary for this to be computed correctly
1766 }
1767 return $ret;
1768}
1769
e1ae3fb4
AD
1770// Convert entity name to human-readable value
1771function formatEntityName ($name) {
1772 switch ($name)
1773 {
1774 case 'ipv4net':
1775 return 'IPv4 Network';
1776 case 'ipv4rspool':
1777 return 'IPv4 RS Pool';
1778 case 'ipv4vs':
1779 return 'IPv4 Virtual Service';
1780 case 'object':
1781 return 'Object';
1782 case 'rack':
1783 return 'Rack';
1784 case 'user':
1785 return 'User';
1786 }
1787 return 'invalid';
1788}
1789
1790// Take a MySQL or other generic timestamp and make it prettier
1791function formatTimestamp ($timestamp) {
1792 return date('n/j/y g:iA', strtotime($timestamp));
1793}
1794
8bc5d1e4
DO
1795// Display hrefs for all of a file's parents. If scissors are requested,
1796// prepend cutting button to each of them.
1797function serializeFileLinks ($links, $scissors = FALSE)
e1ae3fb4 1798{
e1ae3fb4
AD
1799 $comma = '';
1800 $ret = '';
1801 foreach ($links as $link_id => $li)
1802 {
1803 switch ($li['entity_type'])
1804 {
1805 case 'ipv4net':
1806 $params = "page=ipv4net&id=";
1807 break;
1808 case 'ipv4rspool':
1809 $params = "page=ipv4rspool&pool_id=";
1810 break;
1811 case 'ipv4vs':
1812 $params = "page=ipv4vs&vs_id=";
1813 break;
1814 case 'object':
1815 $params = "page=object&object_id=";
1816 break;
1817 case 'rack':
1818 $params = "page=rack&rack_id=";
1819 break;
1820 case 'user':
1821 $params = "page=user&user_id=";
1822 break;
1823 }
8bc5d1e4
DO
1824 $ret .= $comma;
1825 if ($scissors)
1826 {
1827 $ret .= "<a href='" . makeHrefProcess(array('op'=>'unlinkFile', 'link_id'=>$link_id)) . "'";
1828 $ret .= getImageHREF ('cut') . '</a> ';
1829 }
790a60e8 1830 $ret .= sprintf("<a href='index.php?%s%s'>%s</a>", $params, $li['entity_id'], $li['name']);
8bc5d1e4 1831 $comma = '<br>';
e1ae3fb4 1832 }
e1ae3fb4
AD
1833 return $ret;
1834}
1835
1836// Convert filesize to appropriate unit and make it human-readable
1837function formatFileSize ($bytes) {
1838 // bytes
1839 if($bytes < 1024) // bytes
1840 return "${bytes} bytes";
1841
1842 // kilobytes
1843 if ($bytes < 1024000)
1844 return sprintf ("%.1fk", round (($bytes / 1024), 1));
1845
1846 // megabytes
1847 return sprintf ("%.1f MB", round (($bytes / 1024000), 1));
1848}
1849
1850// Reverse of formatFileSize, it converts human-readable value to bytes
1851function convertToBytes ($value) {
1852 $value = trim($value);
1853 $last = strtolower($value[strlen($value)-1]);
1854 switch ($last)
1855 {
1856 case 'g':
1857 $value *= 1024;
1858 case 'm':
1859 $value *= 1024;
1860 case 'k':
1861 $value *= 1024;
1862 }
1863
1864 return $value;
1865}
1866
4fbb5a00
DY
1867function ip_quad2long ($ip)
1868{
1869 return sprintf("%u", ip2long($ip));
1870}
1871
1872function ip_long2quad ($quad)
1873{
1874 return long2ip($quad);
1875}
1876
1877function makeHref($params = array())
1878{
790a60e8 1879 $ret = 'index.php?';
4fbb5a00 1880 $first = true;
4fbb5a00
DY
1881 foreach($params as $key=>$value)
1882 {
1883 if (!$first)
1884 $ret.='&';
1885 $ret .= urlencode($key).'='.urlencode($value);
1886 $first = false;
1887 }
1888 return $ret;
1889}
1890
1891function makeHrefProcess($params = array())
1892{
790a60e8
DO
1893 global $pageno, $tabno;
1894 $ret = 'process.php?';
4fbb5a00 1895 $first = true;
9f14a7ef
DY
1896 if (!isset($params['page']))
1897 $params['page'] = $pageno;
1898 if (!isset($params['tab']))
1899 $params['tab'] = $tabno;
4fbb5a00
DY
1900 foreach($params as $key=>$value)
1901 {
1902 if (!$first)
1903 $ret.='&';
1904 $ret .= urlencode($key).'='.urlencode($value);
1905 $first = false;
1906 }
1907 return $ret;
1908}
1909
39106006 1910function makeHrefForHelper ($helper_name, $params = array())
4fbb5a00 1911{
790a60e8 1912 $ret = 'popup.php?helper=' . $helper_name;
4fbb5a00 1913 foreach($params as $key=>$value)
39106006 1914 $ret .= '&'.urlencode($key).'='.urlencode($value);
4fbb5a00
DY
1915 return $ret;
1916}
1917
f3d274bf
DO
1918// Process the given list of records to build data suitable for printNiftySelect()
1919// (like it was formerly executed by printSelect()). Screen out vendors according
1920// to VENDOR_SIEVE, if object type ID is provided. However, the OPTGROUP with already
1921// selected OPTION is protected from being screened.
1922function cookOptgroups ($recordList, $object_type_id = 0, $existing_value = 0)
1923{
1924 $ret = array();
1925 // Always keep "other" OPTGROUP at the SELECT bottom.
1926 $therest = array();
1927 foreach ($recordList as $dict_key => $dict_value)
1928 if (strpos ($dict_value, '%GSKIP%') !== FALSE)
1929 {
1930 $tmp = explode ('%GSKIP%', $dict_value, 2);
1931 $ret[$tmp[0]][$dict_key] = $tmp[1];
1932 }
1933 elseif (strpos ($dict_value, '%GPASS%') !== FALSE)
1934 {
1935 $tmp = explode ('%GPASS%', $dict_value, 2);
1936 $ret[$tmp[0]][$dict_key] = $tmp[1];
1937 }
1938 else
1939 $therest[$dict_key] = $dict_value;
1940 if ($object_type_id != 0)
1941 {
1942 $screenlist = array();
1943 foreach (explode (';', getConfigVar ('VENDOR_SIEVE')) as $sieve)
1944 if (FALSE !== mb_ereg ("^([^@]+)(@${object_type_id})?\$", trim ($sieve), $regs))
1945 $screenlist[] = $regs[1];
1946 foreach (array_keys ($ret) as $vendor)
1947 if (in_array ($vendor, $screenlist))
1948 {
1949 $ok_to_screen = TRUE;
1950 if ($existing_value)
1951 foreach (array_keys ($ret[$vendor]) as $recordkey)
1952 if ($recordkey == $existing_value)
1953 {
1954 $ok_to_screen = FALSE;
1955 break;
1956 }
1957 if ($ok_to_screen)
1958 unset ($ret[$vendor]);
1959 }
1960 }
1961 $ret['other'] = $therest;
1962 return $ret;
1963}
1964
f8874cdb
DO
1965function dos2unix ($text)
1966{
1967 return str_replace ("\r\n", "\n", $text);
1968}
1969
a0527aef 1970function buildPredicateTable ($parsetree)
2c21a10c 1971{
a0527aef
DO
1972 $ret = array();
1973 foreach ($parsetree as $sentence)
72e8baf6 1974 if ($sentence['type'] == 'SYNT_DEFINITION')
a0527aef 1975 $ret[$sentence['term']] = $sentence['definition'];
72e8baf6
DO
1976 // Now we have predicate table filled in with the latest definitions of each
1977 // particular predicate met. This isn't as chik, as on-the-fly predicate
1978 // overloading during allow/deny scan, but quite sufficient for this task.
a0527aef
DO
1979 return $ret;
1980}
1981
1982// Take a list of records and filter against given RackCode expression. Return
1983// the original list intact, if there was no filter requested, but return an
1984// empty list, if there was an error.
573214e0 1985function filterCellList ($list_in, $expression = array())
d08d766d
DO
1986{
1987 if ($expression === NULL)
1988 return array();
1989 if (!count ($expression))
1990 return $list_in;
d08d766d
DO
1991 $list_out = array();
1992 foreach ($list_in as $item_key => $item_value)
573214e0 1993 if (TRUE === judgeCell ($item_value, $expression))
d08d766d
DO
1994 $list_out[$item_key] = $item_value;
1995 return $list_out;
1996}
1997
212c9d8a 1998// Tell, if the given expression is true for the given entity. Take complete record on input.
573214e0 1999function judgeCell ($cell, $expression)
d08d766d
DO
2000{
2001 global $pTable;
2002 return eval_expression
2003 (
2004 $expression,
2005 array_merge
2006 (
573214e0
DO
2007 $cell['etags'],
2008 $cell['itags'],
2009 $cell['atags']
d08d766d
DO
2010 ),
2011 $pTable,
2012 TRUE
2013 );
2014}
2015
7ddbcf59 2016// Tell, if a constraint from config option permits given record.
212c9d8a 2017function considerConfiguredConstraint ($cell, $varname)
c6bc0ac5 2018{
7ddbcf59 2019 if (!strlen (getConfigVar ($varname)))
c6bc0ac5 2020 return TRUE; // no restriction
7ddbcf59
DO
2021 global $parseCache;
2022 if (!isset ($parseCache[$varname]))
2023 // getConfigVar() doesn't re-read the value from DB because of its
2024 // own cache, so there is no race condition here between two calls.
2025 $parseCache[$varname] = spotPayload (getConfigVar ($varname), 'SYNT_EXPR');
2026 if ($parseCache[$varname]['result'] != 'ACK')
2027 return FALSE; // constraint set, but cannot be used due to compilation error
212c9d8a 2028 return judgeCell ($cell, $parseCache[$varname]['load']);
c6bc0ac5
DO
2029}
2030
17112e81
DO
2031// Return list of records in the given realm, which conform to
2032// the given RackCode expression. If the realm is unknown or text
2033// doesn't validate as a RackCode expression, return NULL.
2034// Otherwise (successful scan) return a list of all matched
2035// records, even if the list is empty (array() !== NULL). If the
2036// text is an empty string, return all found records in the given
2037// realm.
2038function scanRealmByText ($realm = NULL, $ftext = '')
2039{
2040 switch ($realm)
2041 {
2042 case 'object':
2043 case 'user':
2044 case 'ipv4net':
2045 case 'file':
39776127 2046 case 'ipv4vs':
41780975 2047 case 'ipv4rspool':
17112e81
DO
2048 if (!strlen ($ftext = trim ($ftext)))
2049 $fexpr = array();
2050 else
2051 {
2052 $fparse = spotPayload ($ftext, 'SYNT_EXPR');
2053 if ($fparse['result'] != 'ACK')
2054 return NULL;
2055 $fexpr = $fparse['load'];
2056 }
2057 return filterCellList (listCells ($realm), $fexpr);
2058 default:
c5f84f48 2059 throw new InvalidArgException ('$realm', $realm);
17112e81
DO
2060 }
2061
2062}
39776127
DO
2063
2064function getIPv4VSOptions ()
2065{
2066 $ret = array();
2067 foreach (listCells ('ipv4vs') as $vsid => $vsinfo)
59a83bd8 2068 $ret[$vsid] = $vsinfo['dname'] . (!strlen ($vsinfo['name']) ? '' : " (${vsinfo['name']})");
39776127
DO
2069 return $ret;
2070}
2071
41780975
DO
2072function getIPv4RSPoolOptions ()
2073{
2074 $ret = array();
2075 foreach (listCells ('ipv4rspool') as $pool_id => $poolInfo)
2076 $ret[$pool_id] = $poolInfo['name'];
2077 return $ret;
2078}
2079
d16af52f
DO
2080// Derive a complete cell structure from the given username regardless
2081// if it is a local account or not.
2082function constructUserCell ($username)
2083{
2084 if (NULL !== ($userid = getUserIDByUsername ($username)))
2085 return spotEntity ('user', $userid);
2086 $ret = array
2087 (
2088 'realm' => 'user',
2089 'user_name' => $username,
2090 'user_realname' => '',
2091 'etags' => array(),
2092 'itags' => array(),
d16af52f 2093 );
5689cefd 2094 $ret['atags'] = generateEntityAutoTags ($ret);
d16af52f
DO
2095 return $ret;
2096}
2097
56a797ef
DO
2098// Let's have this debug helper here to enable debugging of process.php w/o interface.php.
2099function dump ($var)
2100{
2101 echo '<div align=left><pre>';
2102 print_r ($var);
2103 echo '</pre></div>';
2104}
2105
9e51318b
DO
2106function getTagChart ($limit = 0, $realm = 'total', $special_tags = array())
2107{
2108 global $taglist;
2109 // first build top-N chart...
2110 $toplist = array();
2111 foreach ($taglist as $taginfo)
2112 if (isset ($taginfo['refcnt'][$realm]))
2113 $toplist[$taginfo['id']] = $taginfo['refcnt'][$realm];
2114 arsort ($toplist, SORT_NUMERIC);
2115 $ret = array();
2116 $done = 0;
2117 foreach (array_keys ($toplist) as $tag_id)
2118 {
2119 $ret[$tag_id] = $taglist[$tag_id];
2120 if (++$done == $limit)
2121 break;
2122 }
2123 // ...then make sure, that every item of the special list is shown
2124 // (using the same sort order)
2125 $extra = array();
2126 foreach ($special_tags as $taginfo)
2127 if (!array_key_exists ($taginfo['id'], $ret))
2128 $extra[$taginfo['id']] = $taglist[$taginfo['id']]['refcnt'][$realm];
2129 arsort ($extra, SORT_NUMERIC);
2130 foreach (array_keys ($extra) as $tag_id)
2131 $ret[] = $taglist[$tag_id];
2132 return $ret;
2133}
2134
7fa7047a
DO
2135function decodeObjectType ($objtype_id, $style = 'r')
2136{
2137 static $types = array();
2138 if (!count ($types))
2139 $types = array
2140 (
2141 'r' => readChapter (CHAP_OBJTYPE),
2142 'a' => readChapter (CHAP_OBJTYPE, 'a'),
2143 'o' => readChapter (CHAP_OBJTYPE, 'o')
2144 );
2145 return $types[$style][$objtype_id];
2146}
2147
0df8c52b
DO
2148function isolatedPermission ($p, $t, $cell)
2149{
2150 // This function is called from both "file" page and a number of other pages,
2151 // which have already fixed security context and authorized the user for it.
2152 // OTOH, it is necessary here to authorize against the current file, which
2153 // means saving the current context and building a new one.
2154 global
2155 $expl_tags,
2156 $impl_tags,
2157 $target_given_tags,
2158 $auto_tags;
2159 // push current context
2160 $orig_expl_tags = $expl_tags;
2161 $orig_impl_tags = $impl_tags;
2162 $orig_target_given_tags = $target_given_tags;
2163 $orig_auto_tags = $auto_tags;
2164 // retarget
2165 fixContext ($cell);
2166 // remember decision
2167 $ret = permitted ($p, $t);
2168 // pop context
2169 $expl_tags = $orig_expl_tags;
2170 $impl_tags = $orig_impl_tags;
2171 $target_given_tags = $orig_target_given_tags;
2172 $auto_tags = $orig_auto_tags;
2173 return $ret;
2174}
2175
3153a326
DO
2176function getPortListPrefs()
2177{
2178 $ret = array();
2179 if (0 >= ($ret['iif_pick'] = getConfigVar ('DEFAULT_PORT_IIF_ID')))
2180 $ret['iif_pick'] = 1;
2181 $ret['oif_picks'] = array();
2182 foreach (explode (';', getConfigVar ('DEFAULT_PORT_OIF_IDS')) as $tmp)
2183 {
2184 $tmp = explode ('=', trim ($tmp));
2185 if (count ($tmp) == 2 and $tmp[0] > 0 and $tmp[1] > 0)
2186 $ret['oif_picks'][$tmp[0]] = $tmp[1];
2187 }
2188 // enforce default value
2189 if (!array_key_exists (1, $ret['oif_picks']))
2190 $ret['oif_picks'][1] = 24;
2191 $ret['selected'] = $ret['iif_pick'] . '-' . $ret['oif_picks'][$ret['iif_pick']];
2192 return $ret;
2193}
2194
2dfa1b73
DO
2195// Return data for printNiftySelect() with port type options. All OIF options
2196// for the default IIF will be shown, but only the default OIFs will be present
2197// for each other IIFs. IIFs, for which there is no default OIF, will not
2198// be listed.
2199// This SELECT will be used for the "add new port" form.
2200function getNewPortTypeOptions()
2201{
2202 $ret = array();
2203 $prefs = getPortListPrefs();
2204 foreach (getPortInterfaceCompat() as $row)
2205 {
2206 if ($row['iif_id'] == $prefs['iif_pick'])
2207 $optgroup = $row['iif_name'];
2208 elseif (array_key_exists ($row['iif_id'], $prefs['oif_picks']) and $prefs['oif_picks'][$row['iif_id']] == $row['oif_id'])
2209 $optgroup = 'other';
2210 else
2211 continue;
2212 if (!array_key_exists ($optgroup, $ret))
2213 $ret[$optgroup] = array();
2214 $ret[$optgroup][$row['iif_id'] . '-' . $row['oif_id']] = $row['oif_name'];
2215 }
2216 return $ret;
2217}
2218
e673ee24 2219?>