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