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