r2666 - introduced LDAPCache table (ticket:193)
[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 getRackData(). 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 = getRacksForRow ($row_id);
458 doubleLink ($rackList);
459 if (isset ($rackList[$rack_id]['prev_key']))
460 return $rackList[$rack_id]['prev_key'];
461 return NULL;
462 }
463
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 = getRacksForRow ($row_id);
472 doubleLink ($rackList);
473 if (isset ($rackList[$rack_id]['next_key']))
474 return $rackList[$rack_id]['next_key'];
475 return NULL;
476 }
477
478 // This function finds previous and next array keys for each array key and
479 // modifies its argument accordingly.
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 = getRackData ($rack_id);
676 $total_height += $data['height'];
677 for ($unit_no = $data['height']; $unit_no > 0; $unit_no--)
678 for ($locidx = 0; $locidx < 3; $locidx++)
679 $counter[$data[$unit_no][$locidx]['state']]++;
680 }
681 return ($counter['T'] + $counter['W'] + $counter['U']) / ($counter['T'] + $counter['W'] + $counter['U'] + $counter['F']);
682 }
683
684 // Return a list of object IDs, which can be found in the given rackspace block.
685 function stuffInRackspace ($rackData)
686 {
687 $objects = array();
688 for ($i = $rackData['height']; $i > 0; $i--)
689 for ($locidx = 0; $locidx < 3; $locidx++)
690 if
691 (
692 $rackData[$i][$locidx]['state'] == 'T' and
693 !in_array ($rackData[$i][$locidx]['object_id'], $objects)
694 )
695 $objects[] = $rackData[$i][$locidx]['object_id'];
696 return $objects;
697 }
698
699 // Make sure the string is always wrapped with LF characters
700 function lf_wrap ($str)
701 {
702 $ret = trim ($str, "\r\n");
703 if (!empty ($ret))
704 $ret .= "\n";
705 return $ret;
706 }
707
708 // Adopted from Mantis BTS code.
709 function string_insert_hrefs ($s)
710 {
711 if (getConfigVar ('DETECT_URLS') != 'yes')
712 return $s;
713 # Find any URL in a string and replace it by a clickable link
714 $s = preg_replace( '/(([[:alpha:]][-+.[:alnum:]]*):\/\/(%[[:digit:]A-Fa-f]{2}|[-_.!~*\';\/?%^\\\\:@&={\|}+$#\(\),\[\][:alnum:]])+)/se',
715 "'<a href=\"'.rtrim('\\1','.').'\">\\1</a> [<a href=\"'.rtrim('\\1','.').'\" target=\"_blank\">^</a>]'",
716 $s);
717 $s = preg_replace( '/\b' . email_regex_simple() . '\b/i',
718 '<a href="mailto:\0">\0</a>',
719 $s);
720 return $s;
721 }
722
723 // Idem.
724 function email_regex_simple ()
725 {
726 return "(([a-z0-9!#*+\/=?^_{|}~-]+(?:\.[a-z0-9!#*+\/=?^_{|}~-]+)*)" . # recipient
727 "\@((?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?))"; # @domain
728 }
729
730 // Parse AUTOPORTS_CONFIG and return a list of generated pairs (port_type, port_name)
731 // for the requested object_type_id.
732 function getAutoPorts ($type_id)
733 {
734 $ret = array();
735 $typemap = explode (';', str_replace (' ', '', getConfigVar ('AUTOPORTS_CONFIG')));
736 foreach ($typemap as $equation)
737 {
738 $tmp = explode ('=', $equation);
739 if (count ($tmp) != 2)
740 continue;
741 $objtype_id = $tmp[0];
742 if ($objtype_id != $type_id)
743 continue;
744 $portlist = $tmp[1];
745 foreach (explode ('+', $portlist) as $product)
746 {
747 $tmp = explode ('*', $product);
748 if (count ($tmp) != 3)
749 continue;
750 $nports = $tmp[0];
751 $port_type = $tmp[1];
752 $format = $tmp[2];
753 for ($i = 0; $i < $nports; $i++)
754 $ret[] = array ('type' => $port_type, 'name' => @sprintf ($format, $i));
755 }
756 }
757 return $ret;
758 }
759
760 // Use pre-served trace to traverse the tree, then place given node where it belongs.
761 function pokeNode (&$tree, $trace, $key, $value, $threshold = 0)
762 {
763 // This function needs the trace to be followed FIFO-way. The fastest
764 // way to do so is to use array_push() for putting values into the
765 // list and array_shift() for getting them out. This exposed up to 11%
766 // performance gain compared to other patterns of array_push/array_unshift/
767 // array_reverse/array_pop/array_shift conjunction.
768 $myid = array_shift ($trace);
769 if (!count ($trace)) // reached the target
770 {
771 if (!$threshold or ($threshold and $tree[$myid]['kidc'] + 1 < $threshold))
772 $tree[$myid]['kids'][$key] = $value;
773 // Reset accumulated records once, when the limit is reached, not each time
774 // after that.
775 if (++$tree[$myid]['kidc'] == $threshold)
776 $tree[$myid]['kids'] = array();
777 }
778 else // not yet
779 {
780 $self = __FUNCTION__;
781 $self ($tree[$myid]['kids'], $trace, $key, $value, $threshold);
782 }
783 }
784
785 // Build a tree from the item list and return it. Input and output data is
786 // indexed by item id (nested items in output are recursively stored in 'kids'
787 // key, which is in turn indexed by id. Functions, which are ready to handle
788 // tree collapsion/expansion themselves, may request non-zero threshold value
789 // for smaller resulting tree.
790 function treeFromList ($nodelist, $threshold = 0, $return_main_payload = TRUE)
791 {
792 $tree = array();
793 // Array equivalent of traceEntity() function.
794 $trace = array();
795 // set kidc and kids only once
796 foreach (array_keys ($nodelist) as $nodeid)
797 {
798 $nodelist[$nodeid]['kidc'] = 0;
799 $nodelist[$nodeid]['kids'] = array();
800 }
801 do
802 {
803 $nextpass = FALSE;
804 foreach (array_keys ($nodelist) as $nodeid)
805 {
806 // When adding a node to the working tree, book another
807 // iteration, because the new item could make a way for
808 // others onto the tree. Also remove any item added from
809 // the input list, so iteration base shrinks.
810 // First check if we can assign directly.
811 if ($nodelist[$nodeid]['parent_id'] == NULL)
812 {
813 $tree[$nodeid] = $nodelist[$nodeid];
814 $trace[$nodeid] = array(); // Trace to root node is empty
815 unset ($nodelist[$nodeid]);
816 $nextpass = TRUE;
817 }
818 // Now look if it fits somewhere on already built tree.
819 elseif (isset ($trace[$nodelist[$nodeid]['parent_id']]))
820 {
821 // Trace to a node is a trace to its parent plus parent id.
822 $trace[$nodeid] = $trace[$nodelist[$nodeid]['parent_id']];
823 $trace[$nodeid][] = $nodelist[$nodeid]['parent_id'];
824 pokeNode ($tree, $trace[$nodeid], $nodeid, $nodelist[$nodeid], $threshold);
825 // path to any other node is made of all parent nodes plus the added node itself
826 unset ($nodelist[$nodeid]);
827 $nextpass = TRUE;
828 }
829 }
830 }
831 while ($nextpass);
832 if ($return_main_payload)
833 return $tree;
834 else
835 return $nodelist;
836 }
837
838 // Build a tree from the tag list and return everything _except_ the tree.
839 // IOW, return taginfo items, which have parent_id set and pointing outside
840 // of the "normal" tree, which originates from the root.
841 function getOrphanedTags ()
842 {
843 global $taglist;
844 return treeFromList ($taglist, 0, FALSE);
845 }
846
847 function serializeTags ($chain, $baseurl = '')
848 {
849 $comma = '';
850 $ret = '';
851 foreach ($chain as $taginfo)
852 {
853 $ret .= $comma .
854 ($baseurl == '' ? '' : "<a href='${baseurl}tagfilter[]=${taginfo['id']}'>") .
855 $taginfo['tag'] .
856 ($baseurl == '' ? '' : '</a>');
857 $comma = ', ';
858 }
859 return $ret;
860 }
861
862 // For each tag add all its parent tags onto the list. Don't expect anything
863 // except user's tags on the chain.
864 function getTagChainExpansion ($chain, $tree = NULL)
865 {
866 $self = __FUNCTION__;
867 if ($tree === NULL)
868 {
869 global $tagtree;
870 $tree = $tagtree;
871 }
872 // For each tag find its path from the root, then combine items
873 // of all paths and add them to the chain, if they aren't there yet.
874 $ret = array();
875 foreach ($tree as $taginfo1)
876 {
877 $hit = FALSE;
878 foreach ($chain as $taginfo2)
879 if ($taginfo1['id'] == $taginfo2['id'])
880 {
881 $hit = TRUE;
882 break;
883 }
884 if (count ($taginfo1['kids']) > 0)
885 {
886 $subsearch = $self ($chain, $taginfo1['kids']);
887 if (count ($subsearch))
888 {
889 $hit = TRUE;
890 $ret = array_merge ($ret, $subsearch);
891 }
892 }
893 if ($hit)
894 $ret[] = $taginfo1;
895 }
896 return $ret;
897 }
898
899 // Return the list of missing implicit tags.
900 function getImplicitTags ($oldtags)
901 {
902 $ret = array();
903 $newtags = getTagChainExpansion ($oldtags);
904 foreach ($newtags as $newtag)
905 {
906 $already_exists = FALSE;
907 foreach ($oldtags as $oldtag)
908 if ($newtag['id'] == $oldtag['id'])
909 {
910 $already_exists = TRUE;
911 break;
912 }
913 if ($already_exists)
914 continue;
915 $ret[] = array ('id' => $newtag['id'], 'tag' => $newtag['tag'], 'parent_id' => $newtag['parent_id']);
916 }
917 return $ret;
918 }
919
920 // Minimize the chain: exclude all implicit tags and return the result.
921 function getExplicitTagsOnly ($chain, $tree = NULL)
922 {
923 $self = __FUNCTION__;
924 global $tagtree;
925 if ($tree === NULL)
926 $tree = $tagtree;
927 $ret = array();
928 foreach ($tree as $taginfo)
929 {
930 if (isset ($taginfo['kids']))
931 {
932 $harvest = $self ($chain, $taginfo['kids']);
933 if (count ($harvest) > 0)
934 {
935 $ret = array_merge ($ret, $harvest);
936 continue;
937 }
938 }
939 // This tag isn't implicit, test is for being explicit.
940 foreach ($chain as $testtag)
941 if ($taginfo['id'] == $testtag['id'])
942 {
943 $ret[] = $testtag;
944 break;
945 }
946 }
947 return $ret;
948 }
949
950 // Maximize the chain: for each tag add all tags, for which it is direct or indirect parent.
951 // Unlike other functions, this one accepts and returns a list of integer tag IDs, not
952 // a list of tag structures. Same structure (tag ID list) is returned after processing.
953 function complementByKids ($idlist, $tree = NULL, $getall = FALSE)
954 {
955 $self = __FUNCTION__;
956 global $tagtree;
957 if ($tree === NULL)
958 $tree = $tagtree;
959 $getallkids = $getall;
960 $ret = array();
961 foreach ($tree as $taginfo)
962 {
963 foreach ($idlist as $test_id)
964 if ($getall or $taginfo['id'] == $test_id)
965 {
966 $ret[] = $taginfo['id'];
967 // Once matched node makes all sub-nodes match, but don't make
968 // a mistake of matching every other node at the current level.
969 $getallkids = TRUE;
970 break;
971 }
972 if (isset ($taginfo['kids']))
973 $ret = array_merge ($ret, $self ($idlist, $taginfo['kids'], $getallkids));
974 $getallkids = FALSE;
975 }
976 return $ret;
977 }
978
979 // Universal autotags generator, a complementing function for loadEntityTags().
980 // An important extension is that 'ipaddress' quasi-realm is also handled.
981 // Bypass key isn't strictly typed, but interpreted depending on the realm.
982 function generateEntityAutoTags ($entity_realm = '', $bypass_value = '')
983 {
984 $ret = array();
985 switch ($entity_realm)
986 {
987 case 'rack':
988 $ret[] = array ('tag' => '$rackid_' . $bypass_value);
989 $ret[] = array ('tag' => '$any_rack');
990 break;
991 case 'object':
992 $oinfo = getObjectInfo ($bypass_value, FALSE);
993 $ret[] = array ('tag' => '$id_' . $bypass_value);
994 $ret[] = array ('tag' => '$typeid_' . $oinfo['objtype_id']);
995 $ret[] = array ('tag' => '$any_object');
996 if (validTagName ('$cn_' . $oinfo['name']))
997 $ret[] = array ('tag' => '$cn_' . $oinfo['name']);
998 if (!count (getResidentRacksData ($bypass_value, FALSE)))
999 $ret[] = array ('tag' => '$unmounted');
1000 break;
1001 case 'ipv4net':
1002 $netinfo = getIPv4NetworkInfo ($bypass_value);
1003 $ret[] = array ('tag' => '$ip4netid_' . $bypass_value);
1004 $ret[] = array ('tag' => '$ip4net-' . str_replace ('.', '-', $netinfo['ip']) . '-' . $netinfo['mask']);
1005 $ret[] = array ('tag' => '$any_ip4net');
1006 $ret[] = array ('tag' => '$any_net');
1007 break;
1008 case 'ipaddress':
1009 $netinfo = getIPv4NetworkInfo (getIPv4AddressNetworkId ($bypass_value));
1010 $ret[] = array ('tag' => '$ip4net-' . str_replace ('.', '-', $bypass_value) . '-32');
1011 $ret[] = array ('tag' => '$ip4net-' . str_replace ('.', '-', $netinfo['ip']) . '-' . $netinfo['mask']);
1012 $ret[] = array ('tag' => '$any_ip4net');
1013 $ret[] = array ('tag' => '$any_net');
1014 break;
1015 case 'ipv4vs':
1016 $ret[] = array ('tag' => '$ipv4vsid_' . $bypass_value);
1017 $ret[] = array ('tag' => '$any_ipv4vs');
1018 $ret[] = array ('tag' => '$any_vs');
1019 break;
1020 case 'ipv4rspool':
1021 $ret[] = array ('tag' => '$ipv4rspid_' . $bypass_value);
1022 $ret[] = array ('tag' => '$any_ipv4rsp');
1023 $ret[] = array ('tag' => '$any_rsp');
1024 break;
1025 case 'user':
1026 global $accounts;
1027 $ret[] = array ('tag' => '$username_' . $bypass_value);
1028 if (isset ($accounts[$bypass_value]['user_id']))
1029 $ret[] = array ('tag' => '$userid_' . $accounts[$bypass_value]['user_id']);
1030 break;
1031 case 'file':
1032 $ret[] = array ('tag' => '$fileid_' . $bypass_value);
1033 $ret[] = array ('tag' => '$any_file');
1034 break;
1035 default:
1036 break;
1037 }
1038 return $ret;
1039 }
1040
1041 // Check, if the given tag is present on the chain (will only work
1042 // for regular tags with tag ID set.
1043 function tagOnChain ($taginfo, $tagchain)
1044 {
1045 if (!isset ($taginfo['id']))
1046 return FALSE;
1047 foreach ($tagchain as $test)
1048 if ($test['id'] == $taginfo['id'])
1049 return TRUE;
1050 return FALSE;
1051 }
1052
1053 // Idem, but use ID list instead of chain.
1054 function tagOnIdList ($taginfo, $tagidlist)
1055 {
1056 if (!isset ($taginfo['id']))
1057 return FALSE;
1058 foreach ($tagidlist as $tagid)
1059 if ($taginfo['id'] == $tagid)
1060 return TRUE;
1061 return FALSE;
1062 }
1063
1064 // Return TRUE, if two tags chains differ (order of tags doesn't matter).
1065 // Assume, that neither of the lists contains duplicates.
1066 // FIXME: a faster, than O(x^2) method is possible for this calculation.
1067 function tagChainCmp ($chain1, $chain2)
1068 {
1069 if (count ($chain1) != count ($chain2))
1070 return TRUE;
1071 foreach ($chain1 as $taginfo1)
1072 if (!tagOnChain ($taginfo1, $chain2))
1073 return TRUE;
1074 return FALSE;
1075 }
1076
1077 // If the page-tab-op triplet is final, make $expl_tags and $impl_tags
1078 // hold all appropriate (explicit and implicit) tags respectively.
1079 // Otherwise some limited redirection is necessary (only page and tab
1080 // names are preserved, ophandler name change isn't handled).
1081 function fixContext ()
1082 {
1083 global
1084 $pageno,
1085 $tabno,
1086 $auto_tags,
1087 $expl_tags,
1088 $impl_tags,
1089 $target_given_tags,
1090 $user_given_tags,
1091 $etype_by_pageno,
1092 $page;
1093
1094 $pmap = array
1095 (
1096 'accounts' => 'userlist',
1097 'rspools' => 'ipv4rsplist',
1098 'rspool' => 'ipv4rsp',
1099 'vservices' => 'ipv4vslist',
1100 'vservice' => 'ipv4vs',
1101 );
1102 $tmap = array();
1103 $tmap['objects']['newmulti'] = 'addmore';
1104 $tmap['objects']['newobj'] = 'addmore';
1105 $tmap['object']['switchvlans'] = 'livevlans';
1106 $tmap['object']['slb'] = 'editrspvs';
1107 $tmap['object']['portfwrd'] = 'nat4';
1108 $tmap['object']['network'] = 'ipv4';
1109 if (isset ($pmap[$pageno]))
1110 redirectUser ($pmap[$pageno], $tabno);
1111 if (isset ($tmap[$pageno][$tabno]))
1112 redirectUser ($pageno, $tmap[$pageno][$tabno]);
1113
1114 // Don't reset autochain, because auth procedures could push stuff there in.
1115 // Another important point is to ignore 'user' realm, so we don't infuse effective
1116 // context with autotags of the displayed account and don't try using uint
1117 // bypass, where string is expected.
1118 if
1119 (
1120 $pageno != 'user' and
1121 isset ($etype_by_pageno[$pageno]) and
1122 isset ($page[$pageno]['bypass']) and
1123 isset ($_REQUEST[$page[$pageno]['bypass']])
1124 )
1125 $auto_tags = array_merge ($auto_tags, generateEntityAutoTags ($etype_by_pageno[$pageno], $_REQUEST[$page[$pageno]['bypass']]));
1126 if
1127 (
1128 isset ($page[$pageno]['bypass']) and
1129 isset ($page[$pageno]['bypass_type']) and
1130 $page[$pageno]['bypass_type'] == 'uint' and
1131 isset ($_REQUEST[$page[$pageno]['bypass']])
1132 )
1133 $target_given_tags = loadEntityTags ($pageno, $_REQUEST[$page[$pageno]['bypass']]);
1134 // Explicit and implicit chains should be normally empty at this point, so
1135 // overwrite the contents anyway.
1136 $expl_tags = mergeTagChains ($user_given_tags, $target_given_tags);
1137 $impl_tags = getImplicitTags ($expl_tags);
1138 }
1139
1140 // Take a list of user-supplied tag IDs to build a list of valid taginfo
1141 // records indexed by tag IDs (tag chain).
1142 function buildTagChainFromIds ($tagidlist)
1143 {
1144 global $taglist;
1145 $ret = array();
1146 foreach (array_unique ($tagidlist) as $tag_id)
1147 if (isset ($taglist[$tag_id]))
1148 $ret[] = $taglist[$tag_id];
1149 return $ret;
1150 }
1151
1152 // Process a given tag tree and return only meaningful branches. The resulting
1153 // (sub)tree will have refcnt leaves on every last branch.
1154 function getObjectiveTagTree ($tree, $realm)
1155 {
1156 $self = __FUNCTION__;
1157 $ret = array();
1158 foreach ($tree as $taginfo)
1159 {
1160 $subsearch = array();
1161 $pick = FALSE;
1162 if (count ($taginfo['kids']))
1163 {
1164 $subsearch = $self ($taginfo['kids'], $realm);
1165 $pick = count ($subsearch) > 0;
1166 }
1167 if (isset ($taginfo['refcnt'][$realm]))
1168 $pick = TRUE;
1169 if (!$pick)
1170 continue;
1171 $ret[] = array
1172 (
1173 'id' => $taginfo['id'],
1174 'tag' => $taginfo['tag'],
1175 'parent_id' => $taginfo['parent_id'],
1176 'refcnt' => $taginfo['refcnt'],
1177 'kids' => $subsearch
1178 );
1179 }
1180 return $ret;
1181 }
1182
1183 // Get taginfo record by tag name, return NULL, if record doesn't exist.
1184 function getTagByName ($target_name)
1185 {
1186 global $taglist;
1187 foreach ($taglist as $taginfo)
1188 if ($taginfo['tag'] == $target_name)
1189 return $taginfo;
1190 return NULL;
1191 }
1192
1193 // Merge two chains, filtering dupes out. Return the resulting superset.
1194 function mergeTagChains ($chainA, $chainB)
1195 {
1196 // $ret = $chainA;
1197 // Reindex by tag id in any case.
1198 $ret = array();
1199 foreach ($chainA as $tag)
1200 $ret[$tag['id']] = $tag;
1201 foreach ($chainB as $tag)
1202 if (!isset ($ret[$tag['id']]))
1203 $ret[$tag['id']] = $tag;
1204 return $ret;
1205 }
1206
1207 function getTagFilter ()
1208 {
1209 return isset ($_REQUEST['tagfilter']) ? complementByKids ($_REQUEST['tagfilter']) : array();
1210 }
1211
1212 function getTagFilterStr ($tagfilter = array())
1213 {
1214 $ret = '';
1215 foreach (getExplicitTagsOnly (buildTagChainFromIds ($tagfilter)) as $taginfo)
1216 $ret .= "&tagfilter[]=" . $taginfo['id'];
1217 return $ret;
1218 }
1219
1220 // Generate RackCode expression according to provided tag filter.
1221 function buildCellFilter ()
1222 {
1223 if (!isset ($_REQUEST['tagfilter']) or !is_array ($_REQUEST['tagfilter']))
1224 return array();
1225 $ret = array();
1226 $or = $text = '';
1227 global $taglist;
1228 foreach ($_REQUEST['tagfilter'] as $req_id)
1229 if (isset ($taglist[$req_id]))
1230 {
1231 $text .= $or . '{' . $taglist[$req_id]['tag'] . '}';
1232 $or = ' or ';
1233 }
1234 $expr = spotPayload ($text, 'SYNT_EXPR');
1235 return $expr['load'];
1236 }
1237
1238 function buildWideRedirectURL ($log, $nextpage = NULL, $nexttab = NULL, $moreArgs = array())
1239 {
1240 global $root, $page, $pageno, $tabno;
1241 if ($nextpage === NULL)
1242 $nextpage = $pageno;
1243 if ($nexttab === NULL)
1244 $nexttab = $tabno;
1245 $url = "${root}?page=${nextpage}&tab=${nexttab}";
1246 if (isset ($page[$nextpage]['bypass']))
1247 $url .= '&' . $page[$nextpage]['bypass'] . '=' . $_REQUEST[$page[$nextpage]['bypass']];
1248
1249 if (count($moreArgs)>0)
1250 {
1251 foreach($moreArgs as $arg=>$value)
1252 {
1253 if (gettype($value) == 'array')
1254 {
1255 foreach ($value as $v)
1256 {
1257 $url .= '&'.urlencode($arg.'[]').'='.urlencode($v);
1258 }
1259 }
1260 else
1261 $url .= '&'.urlencode($arg).'='.urlencode($value);
1262 }
1263 }
1264
1265 $_SESSION['log'] = $log;
1266 return $url;
1267 }
1268
1269 function buildRedirectURL ($callfunc, $status, $args = array(), $nextpage = NULL, $nexttab = NULL)
1270 {
1271 global $pageno, $tabno, $msgcode;
1272 if ($nextpage === NULL)
1273 $nextpage = $pageno;
1274 if ($nexttab === NULL)
1275 $nexttab = $tabno;
1276 return buildWideRedirectURL (oneLiner ($msgcode[$callfunc][$status], $args), $nextpage, $nexttab);
1277 }
1278
1279 // Return an empty message log.
1280 function emptyLog ()
1281 {
1282 return array
1283 (
1284 'v' => 2,
1285 'm' => array()
1286 );
1287 }
1288
1289 // Return a message log consisting of only one message.
1290 function oneLiner ($code, $args = array())
1291 {
1292 $ret = emptyLog();
1293 $ret['m'][] = count ($args) ? array ('c' => $code, 'a' => $args) : array ('c' => $code);
1294 return $ret;
1295 }
1296
1297 // Merge message payload from two message logs given and return the result.
1298 function mergeLogs ($log1, $log2)
1299 {
1300 $ret = emptyLog();
1301 $ret['m'] = array_merge ($log1['m'], $log2['m']);
1302 return $ret;
1303 }
1304
1305 function validTagName ($s, $allow_autotag = FALSE)
1306 {
1307 if (1 == mb_ereg (TAGNAME_REGEXP, $s))
1308 return TRUE;
1309 if ($allow_autotag and 1 == mb_ereg (AUTOTAGNAME_REGEXP, $s))
1310 return TRUE;
1311 return FALSE;
1312 }
1313
1314 function redirectUser ($p, $t)
1315 {
1316 global $page, $root;
1317 $l = "{$root}?page=${p}&tab=${t}";
1318 if (isset ($page[$p]['bypass']) and isset ($_REQUEST[$page[$p]['bypass']]))
1319 $l .= '&' . $page[$p]['bypass'] . '=' . $_REQUEST[$page[$p]['bypass']];
1320 header ("Location: " . $l);
1321 die;
1322 }
1323
1324 function getRackCodeStats ()
1325 {
1326 global $rackCode;
1327 $defc = $grantc = $modc = 0;
1328 foreach ($rackCode as $s)
1329 switch ($s['type'])
1330 {
1331 case 'SYNT_DEFINITION':
1332 $defc++;
1333 break;
1334 case 'SYNT_GRANT':
1335 $grantc++;
1336 break;
1337 case 'SYNT_CTXMOD':
1338 $modc++;
1339 break;
1340 default:
1341 break;
1342 }
1343 $ret = array
1344 (
1345 'Definition sentences' => $defc,
1346 'Grant sentences' => $grantc,
1347 'Context mod sentences' => $modc
1348 );
1349 return $ret;
1350 }
1351
1352 function getRackImageWidth ()
1353 {
1354 global $rtwidth;
1355 return 3 + $rtwidth[0] + $rtwidth[1] + $rtwidth[2] + 3;
1356 }
1357
1358 function getRackImageHeight ($units)
1359 {
1360 return 3 + 3 + $units * 2;
1361 }
1362
1363 // Perform substitutions and return resulting string
1364 // used solely by buildLVSConfig()
1365 function apply_macros ($macros, $subject)
1366 {
1367 $ret = $subject;
1368 foreach ($macros as $search => $replace)
1369 $ret = str_replace ($search, $replace, $ret);
1370 return $ret;
1371 }
1372
1373 function buildLVSConfig ($object_id = 0)
1374 {
1375 if ($object_id <= 0)
1376 {
1377 showError ('Invalid argument', __FUNCTION__);
1378 return;
1379 }
1380 $oInfo = getObjectInfo ($object_id, FALSE);
1381 $lbconfig = getSLBConfig ($object_id);
1382 if ($lbconfig === NULL)
1383 {
1384 showError ('getSLBConfig() failed', __FUNCTION__);
1385 return;
1386 }
1387 $newconfig = "#\n#\n# This configuration has been generated automatically by RackTables\n";
1388 $newconfig .= "# for object_id == ${object_id}\n# object name: ${oInfo['name']}\n#\n#\n\n\n";
1389 foreach ($lbconfig as $vs_id => $vsinfo)
1390 {
1391 $newconfig .= "########################################################\n" .
1392 "# VS (id == ${vs_id}): " . (empty ($vsinfo['vs_name']) ? 'NO NAME' : $vsinfo['vs_name']) . "\n" .
1393 "# RS pool (id == ${vsinfo['pool_id']}): " . (empty ($vsinfo['pool_name']) ? 'ANONYMOUS' : $vsinfo['pool_name']) . "\n" .
1394 "########################################################\n";
1395 # The order of inheritance is: VS -> LB -> pool [ -> RS ]
1396 $macros = array
1397 (
1398 '%VIP%' => $vsinfo['vip'],
1399 '%VPORT%' => $vsinfo['vport'],
1400 '%PROTO%' => $vsinfo['proto'],
1401 '%VNAME%' => $vsinfo['vs_name'],
1402 '%RSPOOLNAME%' => $vsinfo['pool_name']
1403 );
1404 $newconfig .= "virtual_server ${vsinfo['vip']} ${vsinfo['vport']} {\n";
1405 $newconfig .= "\tprotocol ${vsinfo['proto']}\n";
1406 $newconfig .= apply_macros
1407 (
1408 $macros,
1409 lf_wrap ($vsinfo['vs_vsconfig']) .
1410 lf_wrap ($vsinfo['lb_vsconfig']) .
1411 lf_wrap ($vsinfo['pool_vsconfig'])
1412 );
1413 foreach ($vsinfo['rslist'] as $rs)
1414 {
1415 if (empty ($rs['rsport']))
1416 $rs['rsport'] = $vsinfo['vport'];
1417 $macros['%RSIP%'] = $rs['rsip'];
1418 $macros['%RSPORT%'] = $rs['rsport'];
1419 $newconfig .= "\treal_server ${rs['rsip']} ${rs['rsport']} {\n";
1420 $newconfig .= apply_macros
1421 (
1422 $macros,
1423 lf_wrap ($vsinfo['vs_rsconfig']) .
1424 lf_wrap ($vsinfo['lb_rsconfig']) .
1425 lf_wrap ($vsinfo['pool_rsconfig']) .
1426 lf_wrap ($rs['rs_rsconfig'])
1427 );
1428 $newconfig .= "\t}\n";
1429 }
1430 $newconfig .= "}\n\n\n";
1431 }
1432 // FIXME: deal somehow with Mac-styled text, the below replacement will screw it up
1433 return str_replace ("\r", '', $newconfig);
1434 }
1435
1436 // Indicate occupation state of each IP address: none, ordinary or problematic.
1437 function markupIPv4AddrList (&$addrlist)
1438 {
1439 foreach (array_keys ($addrlist) as $ip_bin)
1440 {
1441 $refc = array
1442 (
1443 'shared' => 0, // virtual
1444 'virtual' => 0, // loopback
1445 'regular' => 0, // connected host
1446 'router' => 0 // connected gateway
1447 );
1448 foreach ($addrlist[$ip_bin]['allocs'] as $a)
1449 $refc[$a['type']]++;
1450 $nvirtloopback = ($refc['shared'] + $refc['virtual'] > 0) ? 1 : 0; // modulus of virtual + shared
1451 $nreserved = ($addrlist[$ip_bin]['reserved'] == 'yes') ? 1 : 0; // only one reservation is possible ever
1452 $nrealms = $nreserved + $nvirtloopback + $refc['regular'] + $refc['router']; // latter two are connected and router allocations
1453
1454 if ($nrealms == 1)
1455 $addrlist[$ip_bin]['class'] = 'trbusy';
1456 elseif ($nrealms > 1)
1457 $addrlist[$ip_bin]['class'] = 'trerror';
1458 else
1459 $addrlist[$ip_bin]['class'] = '';
1460 }
1461 }
1462
1463 // Scan the given address list (returned by scanIPv4Space) and return a list of all routers found.
1464 function findRouters ($addrlist)
1465 {
1466 $ret = array();
1467 foreach ($addrlist as $addr)
1468 foreach ($addr['allocs'] as $alloc)
1469 if ($alloc['type'] == 'router')
1470 $ret[] = array
1471 (
1472 'id' => $alloc['object_id'],
1473 'iface' => $alloc['name'],
1474 'dname' => $alloc['object_name'],
1475 'addr' => $addr['ip']
1476 );
1477 return $ret;
1478 }
1479
1480 // Assist in tag chain sorting.
1481 function taginfoCmp ($tagA, $tagB)
1482 {
1483 return $tagA['ci'] - $tagB['ci'];
1484 }
1485
1486 // Compare networks. When sorting a tree, the records on the list will have
1487 // distinct base IP addresses.
1488 // "The comparison function must return an integer less than, equal to, or greater
1489 // than zero if the first argument is considered to be respectively less than,
1490 // equal to, or greater than the second." (c) PHP manual
1491 function IPv4NetworkCmp ($netA, $netB)
1492 {
1493 // There's a problem just substracting one u32 integer from another,
1494 // because the result may happen big enough to become a negative i32
1495 // integer itself (PHP tries to cast everything it sees to signed int)
1496 // The comparison below must treat positive and negative values of both
1497 // arguments.
1498 // Equal values give instant decision regardless of their [equal] sign.
1499 if ($netA['ip_bin'] == $netB['ip_bin'])
1500 return 0;
1501 // Same-signed values compete arithmetically within one of i32 contiguous ranges:
1502 // 0x00000001~0x7fffffff 1~2147483647
1503 // 0 doesn't have any sign, and network 0.0.0.0 isn't allowed
1504 // 0x80000000~0xffffffff -2147483648~-1
1505 $signA = $netA['ip_bin'] / abs ($netA['ip_bin']);
1506 $signB = $netB['ip_bin'] / abs ($netB['ip_bin']);
1507 if ($signA == $signB)
1508 {
1509 if ($netA['ip_bin'] > $netB['ip_bin'])
1510 return 1;
1511 else
1512 return -1;
1513 }
1514 else // With only one of two values being negative, it... wins!
1515 {
1516 if ($netA['ip_bin'] < $netB['ip_bin'])
1517 return 1;
1518 else
1519 return -1;
1520 }
1521 }
1522
1523 // Modify the given tag tree so, that each level's items are sorted alphabetically.
1524 function sortTree (&$tree, $sortfunc = '')
1525 {
1526 if (empty ($sortfunc))
1527 return;
1528 $self = __FUNCTION__;
1529 usort ($tree, $sortfunc);
1530 // Don't make a mistake of directly iterating over the items of current level, because this way
1531 // the sorting will be performed on a _copy_ if each item, not the item itself.
1532 foreach (array_keys ($tree) as $tagid)
1533 $self ($tree[$tagid]['kids'], $sortfunc);
1534 }
1535
1536 function iptree_fill (&$netdata)
1537 {
1538 if (!isset ($netdata['kids']) or empty ($netdata['kids']))
1539 return;
1540 // If we really have nested prefixes, they must fit into the tree.
1541 $worktree = array
1542 (
1543 'ip_bin' => $netdata['ip_bin'],
1544 'mask' => $netdata['mask']
1545 );
1546 foreach ($netdata['kids'] as $pfx)
1547 iptree_embed ($worktree, $pfx);
1548 $netdata['kids'] = iptree_construct ($worktree);
1549 $netdata['kidc'] = count ($netdata['kids']);
1550 }
1551
1552 function iptree_construct ($node)
1553 {
1554 $self = __FUNCTION__;
1555
1556 if (!isset ($node['right']))
1557 {
1558 if (!isset ($node['ip']))
1559 {
1560 $node['ip'] = long2ip ($node['ip_bin']);
1561 $node['kids'] = array();
1562 $node['kidc'] = 0;
1563 $node['name'] = '';
1564 }
1565 return array ($node);
1566 }
1567 else
1568 return array_merge ($self ($node['left']), $self ($node['right']));
1569 }
1570
1571 function iptree_embed (&$node, $pfx)
1572 {
1573 $self = __FUNCTION__;
1574
1575 // hit?
1576 if ($node['ip_bin'] == $pfx['ip_bin'] and $node['mask'] == $pfx['mask'])
1577 {
1578 $node = $pfx;
1579 return;
1580 }
1581 if ($node['mask'] == $pfx['mask'])
1582 {
1583 showError ('Internal error, the recurring loop lost control', __FUNCTION__);
1584 die;
1585 }
1586
1587 // split?
1588 if (!isset ($node['right']))
1589 {
1590 // Fill in db_first/db_last to make it possible to run scanIPv4Space() on the node.
1591 $node['left']['mask'] = $node['mask'] + 1;
1592 $node['left']['ip_bin'] = $node['ip_bin'];
1593 $node['left']['db_first'] = sprintf ('%u', $node['left']['ip_bin']);
1594 $node['left']['db_last'] = sprintf ('%u', $node['left']['ip_bin'] | binInvMaskFromDec ($node['left']['mask']));
1595
1596 $node['right']['mask'] = $node['mask'] + 1;
1597 $node['right']['ip_bin'] = $node['ip_bin'] + binInvMaskFromDec ($node['mask'] + 1) + 1;
1598 $node['right']['db_first'] = sprintf ('%u', $node['right']['ip_bin']);
1599 $node['right']['db_last'] = sprintf ('%u', $node['right']['ip_bin'] | binInvMaskFromDec ($node['right']['mask']));
1600 }
1601
1602 // repeat!
1603 if (($node['left']['ip_bin'] & binMaskFromDec ($node['left']['mask'])) == ($pfx['ip_bin'] & binMaskFromDec ($node['left']['mask'])))
1604 $self ($node['left'], $pfx);
1605 elseif (($node['right']['ip_bin'] & binMaskFromDec ($node['right']['mask'])) == ($pfx['ip_bin'] & binMaskFromDec ($node['left']['mask'])))
1606 $self ($node['right'], $pfx);
1607 else
1608 {
1609 showError ('Internal error, cannot decide between left and right', __FUNCTION__);
1610 die;
1611 }
1612 }
1613
1614 function treeApplyFunc (&$tree, $func = '', $stopfunc = '')
1615 {
1616 if (empty ($func))
1617 return;
1618 $self = __FUNCTION__;
1619 foreach (array_keys ($tree) as $key)
1620 {
1621 $func ($tree[$key]);
1622 if (!empty ($stopfunc) and $stopfunc ($tree[$key]))
1623 continue;
1624 $self ($tree[$key]['kids'], $func);
1625 }
1626 }
1627
1628 function loadIPv4AddrList (&$netinfo)
1629 {
1630 loadOwnIPv4Addresses ($netinfo);
1631 markupIPv4AddrList ($netinfo['addrlist']);
1632 }
1633
1634 function countOwnIPv4Addresses (&$node)
1635 {
1636 $toscan = array();
1637 $node['addrt'] = 0;
1638 $node['mask_bin'] = binMaskFromDec ($node['mask']);
1639 $node['mask_bin_inv'] = binInvMaskFromDec ($node['mask']);
1640 $node['db_first'] = sprintf ('%u', 0x00000000 + $node['ip_bin'] & $node['mask_bin']);
1641 $node['db_last'] = sprintf ('%u', 0x00000000 + $node['ip_bin'] | ($node['mask_bin_inv']));
1642 if (empty ($node['kids']))
1643 {
1644 $toscan[] = array ('i32_first' => $node['db_first'], 'i32_last' => $node['db_last']);
1645 $node['addrt'] = binInvMaskFromDec ($node['mask']) + 1;
1646 }
1647 else
1648 foreach ($node['kids'] as $nested)
1649 if (!isset ($nested['id'])) // spare
1650 {
1651 $toscan[] = array ('i32_first' => $nested['db_first'], 'i32_last' => $nested['db_last']);
1652 $node['addrt'] += binInvMaskFromDec ($nested['mask']) + 1;
1653 }
1654 // Don't do anything more, because the displaying function will load the addresses anyway.
1655 return;
1656 $node['addrc'] = count (scanIPv4Space ($toscan));
1657 }
1658
1659 function nodeIsCollapsed ($node)
1660 {
1661 return $node['symbol'] == 'node-collapsed';
1662 }
1663
1664 function loadOwnIPv4Addresses (&$node)
1665 {
1666 $toscan = array();
1667 if (empty ($node['kids']))
1668 $toscan[] = array ('i32_first' => $node['db_first'], 'i32_last' => $node['db_last']);
1669 else
1670 foreach ($node['kids'] as $nested)
1671 if (!isset ($nested['id'])) // spare
1672 $toscan[] = array ('i32_first' => $nested['db_first'], 'i32_last' => $nested['db_last']);
1673 $node['addrlist'] = scanIPv4Space ($toscan);
1674 $node['addrc'] = count ($node['addrlist']);
1675 }
1676
1677 function prepareIPv4Tree ($netlist, $expanded_id = 0)
1678 {
1679 // treeFromList() requires parent_id to be correct for an item to get onto the tree,
1680 // so perform necessary pre-processing to make orphans belong to root. This trick
1681 // was earlier performed by getIPv4NetworkList().
1682 $netids = array_keys ($netlist);
1683 foreach ($netids as $cid)
1684 if (!in_array ($netlist[$cid]['parent_id'], $netids))
1685 $netlist[$cid]['parent_id'] = NULL;
1686 $tree = treeFromList ($netlist); // medium call
1687 sortTree ($tree, 'IPv4NetworkCmp');
1688 // complement the tree before markup to make the spare networks have "symbol" set
1689 treeApplyFunc ($tree, 'iptree_fill');
1690 iptree_markup_collapsion ($tree, getConfigVar ('TREE_THRESHOLD'), $expanded_id);
1691 // count addresses after the markup to skip computation for hidden tree nodes
1692 treeApplyFunc ($tree, 'countOwnIPv4Addresses', 'nodeIsCollapsed');
1693 return $tree;
1694 }
1695
1696 // Check all items of the tree recursively, until the requested target id is
1697 // found. Mark all items leading to this item as "expanded", collapsing all
1698 // the rest, which exceed the given threshold (if the threshold is given).
1699 function iptree_markup_collapsion (&$tree, $threshold = 1024, $target = 0)
1700 {
1701 $self = __FUNCTION__;
1702 $ret = FALSE;
1703 foreach (array_keys ($tree) as $key)
1704 {
1705 $here = ($target === 'ALL' or ($target > 0 and isset ($tree[$key]['id']) and $tree[$key]['id'] == $target));
1706 $below = $self ($tree[$key]['kids'], $threshold, $target);
1707 if (!$tree[$key]['kidc']) // terminal node
1708 $tree[$key]['symbol'] = 'spacer';
1709 elseif ($tree[$key]['kidc'] < $threshold)
1710 $tree[$key]['symbol'] = 'node-expanded-static';
1711 elseif ($here or $below)
1712 $tree[$key]['symbol'] = 'node-expanded';
1713 else
1714 $tree[$key]['symbol'] = 'node-collapsed';
1715 $ret = ($ret or $here or $below); // parentheses are necessary for this to be computed correctly
1716 }
1717 return $ret;
1718 }
1719
1720 // Convert entity name to human-readable value
1721 function formatEntityName ($name) {
1722 switch ($name)
1723 {
1724 case 'ipv4net':
1725 return 'IPv4 Network';
1726 case 'ipv4rspool':
1727 return 'IPv4 RS Pool';
1728 case 'ipv4vs':
1729 return 'IPv4 Virtual Service';
1730 case 'object':
1731 return 'Object';
1732 case 'rack':
1733 return 'Rack';
1734 case 'user':
1735 return 'User';
1736 }
1737 return 'invalid';
1738 }
1739
1740 // Take a MySQL or other generic timestamp and make it prettier
1741 function formatTimestamp ($timestamp) {
1742 return date('n/j/y g:iA', strtotime($timestamp));
1743 }
1744
1745 // Display hrefs for all of a file's parents. If scissors are requested,
1746 // prepend cutting button to each of them.
1747 function serializeFileLinks ($links, $scissors = FALSE)
1748 {
1749 global $root;
1750
1751 $comma = '';
1752 $ret = '';
1753 foreach ($links as $link_id => $li)
1754 {
1755 switch ($li['entity_type'])
1756 {
1757 case 'ipv4net':
1758 $params = "page=ipv4net&id=";
1759 break;
1760 case 'ipv4rspool':
1761 $params = "page=ipv4rspool&pool_id=";
1762 break;
1763 case 'ipv4vs':
1764 $params = "page=ipv4vs&vs_id=";
1765 break;
1766 case 'object':
1767 $params = "page=object&object_id=";
1768 break;
1769 case 'rack':
1770 $params = "page=rack&rack_id=";
1771 break;
1772 case 'user':
1773 $params = "page=user&user_id=";
1774 break;
1775 }
1776 $ret .= $comma;
1777 if ($scissors)
1778 {
1779 $ret .= "<a href='" . makeHrefProcess(array('op'=>'unlinkFile', 'link_id'=>$link_id)) . "'";
1780 $ret .= getImageHREF ('cut') . '</a> ';
1781 }
1782 $ret .= sprintf("<a href='%s?%s%s'>%s</a>", $root, $params, $li['entity_id'], $li['name']);
1783 $comma = '<br>';
1784 }
1785 return $ret;
1786 }
1787
1788 // Convert filesize to appropriate unit and make it human-readable
1789 function formatFileSize ($bytes) {
1790 // bytes
1791 if($bytes < 1024) // bytes
1792 return "${bytes} bytes";
1793
1794 // kilobytes
1795 if ($bytes < 1024000)
1796 return sprintf ("%.1fk", round (($bytes / 1024), 1));
1797
1798 // megabytes
1799 return sprintf ("%.1f MB", round (($bytes / 1024000), 1));
1800 }
1801
1802 // Reverse of formatFileSize, it converts human-readable value to bytes
1803 function convertToBytes ($value) {
1804 $value = trim($value);
1805 $last = strtolower($value[strlen($value)-1]);
1806 switch ($last)
1807 {
1808 case 'g':
1809 $value *= 1024;
1810 case 'm':
1811 $value *= 1024;
1812 case 'k':
1813 $value *= 1024;
1814 }
1815
1816 return $value;
1817 }
1818
1819 function ip_quad2long ($ip)
1820 {
1821 return sprintf("%u", ip2long($ip));
1822 }
1823
1824 function ip_long2quad ($quad)
1825 {
1826 return long2ip($quad);
1827 }
1828
1829 function makeHref($params = array())
1830 {
1831 global $head_revision, $numeric_revision, $root;
1832 $ret = $root.'?';
1833 $first = true;
1834 if (!isset($params['r']) and ($numeric_revision != $head_revision))
1835 {
1836 $params['r'] = $numeric_revision;
1837 }
1838 foreach($params as $key=>$value)
1839 {
1840 if (!$first)
1841 $ret.='&';
1842 $ret .= urlencode($key).'='.urlencode($value);
1843 $first = false;
1844 }
1845 return $ret;
1846 }
1847
1848 function makeHrefProcess($params = array())
1849 {
1850 global $head_revision, $numeric_revision, $root, $pageno, $tabno;
1851 $ret = $root.'process.php'.'?';
1852 $first = true;
1853 if ($numeric_revision != $head_revision)
1854 {
1855 error_log("Can't make a process link when not in head revision");
1856 die();
1857 }
1858 if (!isset($params['page']))
1859 $params['page'] = $pageno;
1860 if (!isset($params['tab']))
1861 $params['tab'] = $tabno;
1862 foreach($params as $key=>$value)
1863 {
1864 if (!$first)
1865 $ret.='&';
1866 $ret .= urlencode($key).'='.urlencode($value);
1867 $first = false;
1868 }
1869 return $ret;
1870 }
1871
1872 function makeHrefForHelper ($helper_name, $params = array())
1873 {
1874 global $head_revision, $numeric_revision, $root;
1875 $ret = $root.'popup.php'.'?helper='.$helper_name;
1876 if ($numeric_revision != $head_revision)
1877 {
1878 error_log("Can't make a process link when not in head revision");
1879 die();
1880 }
1881 foreach($params as $key=>$value)
1882 $ret .= '&'.urlencode($key).'='.urlencode($value);
1883 return $ret;
1884 }
1885
1886 // Process the given list of records to build data suitable for printNiftySelect()
1887 // (like it was formerly executed by printSelect()). Screen out vendors according
1888 // to VENDOR_SIEVE, if object type ID is provided. However, the OPTGROUP with already
1889 // selected OPTION is protected from being screened.
1890 function cookOptgroups ($recordList, $object_type_id = 0, $existing_value = 0)
1891 {
1892 $ret = array();
1893 // Always keep "other" OPTGROUP at the SELECT bottom.
1894 $therest = array();
1895 foreach ($recordList as $dict_key => $dict_value)
1896 if (strpos ($dict_value, '%GSKIP%') !== FALSE)
1897 {
1898 $tmp = explode ('%GSKIP%', $dict_value, 2);
1899 $ret[$tmp[0]][$dict_key] = $tmp[1];
1900 }
1901 elseif (strpos ($dict_value, '%GPASS%') !== FALSE)
1902 {
1903 $tmp = explode ('%GPASS%', $dict_value, 2);
1904 $ret[$tmp[0]][$dict_key] = $tmp[1];
1905 }
1906 else
1907 $therest[$dict_key] = $dict_value;
1908 if ($object_type_id != 0)
1909 {
1910 $screenlist = array();
1911 foreach (explode (';', getConfigVar ('VENDOR_SIEVE')) as $sieve)
1912 if (FALSE !== mb_ereg ("^([^@]+)(@${object_type_id})?\$", trim ($sieve), $regs))
1913 $screenlist[] = $regs[1];
1914 foreach (array_keys ($ret) as $vendor)
1915 if (in_array ($vendor, $screenlist))
1916 {
1917 $ok_to_screen = TRUE;
1918 if ($existing_value)
1919 foreach (array_keys ($ret[$vendor]) as $recordkey)
1920 if ($recordkey == $existing_value)
1921 {
1922 $ok_to_screen = FALSE;
1923 break;
1924 }
1925 if ($ok_to_screen)
1926 unset ($ret[$vendor]);
1927 }
1928 }
1929 $ret['other'] = $therest;
1930 return $ret;
1931 }
1932
1933 function dos2unix ($text)
1934 {
1935 return str_replace ("\r\n", "\n", $text);
1936 }
1937
1938 function buildPredicateTable ($parsetree)
1939 {
1940 $ret = array();
1941 foreach ($parsetree as $sentence)
1942 if ($sentence['type'] == 'SYNT_DEFINITION')
1943 $ret[$sentence['term']] = $sentence['definition'];
1944 // Now we have predicate table filled in with the latest definitions of each
1945 // particular predicate met. This isn't as chik, as on-the-fly predicate
1946 // overloading during allow/deny scan, but quite sufficient for this task.
1947 return $ret;
1948 }
1949
1950 // Take a list of records and filter against given RackCode expression. Return
1951 // the original list intact, if there was no filter requested, but return an
1952 // empty list, if there was an error.
1953 function filterEntityList ($list_in, $realm, $expression = array())
1954 {
1955 if ($expression === NULL)
1956 return array();
1957 if (!count ($expression))
1958 return $list_in;
1959 $list_out = array();
1960 foreach ($list_in as $item_key => $item_value)
1961 if (TRUE === judgeEntity ($realm, $item_key, $expression))
1962 $list_out[$item_key] = $item_value;
1963 return $list_out;
1964 }
1965
1966 function filterCellList ($list_in, $expression = array())
1967 {
1968 if ($expression === NULL)
1969 return array();
1970 if (!count ($expression))
1971 return $list_in;
1972 $list_out = array();
1973 foreach ($list_in as $item_key => $item_value)
1974 if (TRUE === judgeCell ($item_value, $expression))
1975 $list_out[$item_key] = $item_value;
1976 return $list_out;
1977 }
1978
1979 // Tell, if the given expression is true for the given entity.
1980 function judgeEntity ($realm, $id, $expression)
1981 {
1982 $item_explicit_tags = loadEntityTags ($realm, $id);
1983 global $pTable;
1984 return eval_expression
1985 (
1986 $expression,
1987 array_merge
1988 (
1989 $item_explicit_tags,
1990 getImplicitTags ($item_explicit_tags),
1991 generateEntityAutoTags ($realm, $id)
1992 ),
1993 $pTable,
1994 TRUE
1995 );
1996 }
1997
1998 // Idem, but use complete record instead of key.
1999 function judgeCell ($cell, $expression)
2000 {
2001 global $pTable;
2002 return eval_expression
2003 (
2004 $expression,
2005 array_merge
2006 (
2007 $cell['etags'],
2008 $cell['itags'],
2009 $cell['atags']
2010 ),
2011 $pTable,
2012 TRUE
2013 );
2014 }
2015
2016 // If the requested predicate exists, return its [last] definition.
2017 // Otherwise return NULL (to signal filterEntityList() about error).
2018 // Also detect "not set" option selected.
2019 function interpretPredicate ($pname)
2020 {
2021 if ($pname == '_')
2022 return array();
2023 global $pTable;
2024 if (isset ($pTable[$pname]))
2025 return $pTable[$pname];
2026 return NULL;
2027 }
2028
2029 // Tell, if a constraint from config option permits given record.
2030 function considerConfiguredConstraint ($entity_realm, $entity_id, $varname)
2031 {
2032 if (!strlen (getConfigVar ($varname)))
2033 return TRUE; // no restriction
2034 global $parseCache;
2035 if (!isset ($parseCache[$varname]))
2036 // getConfigVar() doesn't re-read the value from DB because of its
2037 // own cache, so there is no race condition here between two calls.
2038 $parseCache[$varname] = spotPayload (getConfigVar ($varname), 'SYNT_EXPR');
2039 if ($parseCache[$varname]['result'] != 'ACK')
2040 return FALSE; // constraint set, but cannot be used due to compilation error
2041 return judgeEntity ($entity_realm, $entity_id, $parseCache[$varname]['load']);
2042 }
2043
2044 ?>