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