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