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