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