r3342 index.php: employ call_user_func() for callback
[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
ef4b16fb
DO
39// Rack thumbnail image width summands: "front", "interior" and "rear" elements w/o surrounding border.
40$rtwidth = array
41(
42 0 => 9,
43 1 => 21,
44 2 => 9
45);
46
c8824ff4
DO
47$netmaskbylen = array
48(
49 32 => '255.255.255.255',
50 31 => '255.255.255.254',
51 30 => '255.255.255.252',
52 29 => '255.255.255.248',
53 28 => '255.255.255.240',
54 27 => '255.255.255.224',
55 26 => '255.255.255.192',
56 25 => '255.255.255.128',
57 24 => '255.255.255.0',
58 23 => '255.255.254.0',
59 22 => '255.255.252.0',
60 21 => '255.255.248.0',
61 20 => '255.255.240.0',
62 19 => '255.255.224.0',
63 18 => '255.255.192.0',
64 17 => '255.255.128.0',
65 16 => '255.255.0.0',
66 15 => '255.254.0.0',
67 14 => '255.252.0.0',
68 13 => '255.248.0.0',
69 12 => '255.240.0.0',
70 11 => '255.224.0.0',
71 10 => '255.192.0.0',
72 9 => '255.128.0.0',
73 8 => '255.0.0.0',
74 7 => '254.0.0.0',
75 6 => '252.0.0.0',
76 5 => '248.0.0.0',
77 4 => '240.0.0.0',
78 3 => '224.0.0.0',
79 2 => '192.0.0.0',
80 1 => '128.0.0.0'
81);
82
83$wildcardbylen = array
84(
85 32 => '0.0.0.0',
86 31 => '0.0.0.1',
87 30 => '0.0.0.3',
88 29 => '0.0.0.7',
89 28 => '0.0.0.15',
90 27 => '0.0.0.31',
91 26 => '0.0.0.63',
92 25 => '0.0.0.127',
93 24 => '0.0.0.255',
94 23 => '0.0.1.255',
95 22 => '0.0.3.255',
96 21 => '0.0.7.255',
97 20 => '0.0.15.255',
98 19 => '0.0.31.255',
99 18 => '0.0.63.255',
100 17 => '0.0.127.255',
101 16 => '0.0.255.25',
102 15 => '0.1.255.255',
103 14 => '0.3.255.255',
104 13 => '0.7.255.255',
105 12 => '0.15.255.255',
106 11 => '0.31.255.255',
107 10 => '0.63.255.255',
108 9 => '0.127.255.255',
109 8 => '0.255.255.255',
110 7 => '1.255.255.255',
111 6 => '3.255.255.255',
112 5 => '7.255.255.255',
113 4 => '15.255.255.255',
114 3 => '31.255.255.255',
115 2 => '63.255.255.255',
116 1 => '127.255.255.255'
117);
118
f77323f1
DO
119// This function assures that specified argument was passed
120// and is a number greater than zero.
0cc24e9a 121function assertUIntArg ($argname, $allow_zero = FALSE)
f77323f1
DO
122{
123 if (!isset ($_REQUEST[$argname]))
5847d944 124 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'parameter is missing');
f77323f1 125 if (!is_numeric ($_REQUEST[$argname]))
5847d944 126 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'parameter is not a number');
f77323f1 127 if ($_REQUEST[$argname] < 0)
5847d944 128 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'parameter is less than zero');
f77323f1 129 if (!$allow_zero and $_REQUEST[$argname] === 0)
5847d944 130 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'parameter is zero');
f77323f1
DO
131}
132
133// This function assures that specified argument was passed
134// and is a non-empty string.
0cc24e9a 135function assertStringArg ($argname, $ok_if_empty = FALSE)
f77323f1
DO
136{
137 if (!isset ($_REQUEST[$argname]))
5847d944 138 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'parameter is missing');
f77323f1 139 if (!is_string ($_REQUEST[$argname]))
5847d944 140 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'parameter is not a string');
f77323f1 141 if (!$ok_if_empty and !strlen ($_REQUEST[$argname]))
5847d944 142 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'parameter is an empty string');
f77323f1
DO
143}
144
0cc24e9a 145function assertBoolArg ($argname, $ok_if_empty = FALSE)
f77323f1
DO
146{
147 if (!isset ($_REQUEST[$argname]))
5847d944 148 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'parameter is missing');
f77323f1 149 if (!is_string ($_REQUEST[$argname]) or $_REQUEST[$argname] != 'on')
5847d944 150 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'parameter is not a string');
f77323f1 151 if (!$ok_if_empty and !strlen ($_REQUEST[$argname]))
5847d944 152 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'parameter is an empty string');
f77323f1
DO
153}
154
0cc24e9a 155function assertIPv4Arg ($argname, $ok_if_empty = FALSE)
f77323f1 156{
0cc24e9a 157 assertStringArg ($argname, $ok_if_empty);
f77323f1 158 if (strlen ($_REQUEST[$argname]) and long2ip (ip2long ($_REQUEST[$argname])) !== $_REQUEST[$argname])
5847d944 159 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'parameter is not a valid ipv4 address');
f77323f1
DO
160}
161
e673ee24
DO
162// Objects of some types should be explicitly shown as
163// anonymous (labelless). This function is a single place where the
164// decision about displayed name is made.
cfa8f3cf 165function setDisplayedName (&$cell)
e673ee24 166{
cfa8f3cf
DO
167 if ($cell['name'] != '')
168 $cell['dname'] = $cell['name'];
e673ee24 169 else
212c9d8a 170 {
cfa8f3cf
DO
171 $cell['atags'][] = array ('tag' => '$nameless');
172 if (considerConfiguredConstraint ($cell, 'NAMEWARN_LISTSRC'))
7fa7047a 173 $cell['dname'] = 'ANONYMOUS ' . decodeObjectType ($cell['objtype_id'], 'o');
212c9d8a 174 else
7fa7047a 175 $cell['dname'] = '[' . decodeObjectType ($cell['objtype_id'], 'o') . ']';
212c9d8a 176 }
e673ee24
DO
177}
178
179// This function finds height of solid rectangle of atoms, which are all
180// assigned to the same object. Rectangle base is defined by specified
181// template.
182function rectHeight ($rackData, $startRow, $template_idx)
183{
184 $height = 0;
185 // The first met object_id is used to match all the folowing IDs.
186 $object_id = 0;
187 global $template;
188 do
189 {
190 for ($locidx = 0; $locidx < 3; $locidx++)
191 {
192 // At least one value in template is TRUE, but the following block
193 // can meet 'skipped' atoms. Let's ensure we have something after processing
194 // the first row.
195 if ($template[$template_idx][$locidx])
196 {
197 if (isset ($rackData[$startRow - $height][$locidx]['skipped']))
198 break 2;
93e02204
DO
199 if (isset ($rackData[$startRow - $height][$locidx]['rowspan']))
200 break 2;
201 if (isset ($rackData[$startRow - $height][$locidx]['colspan']))
202 break 2;
e673ee24
DO
203 if ($rackData[$startRow - $height][$locidx]['state'] != 'T')
204 break 2;
205 if ($object_id == 0)
206 $object_id = $rackData[$startRow - $height][$locidx]['object_id'];
207 if ($object_id != $rackData[$startRow - $height][$locidx]['object_id'])
208 break 2;
209 }
210 }
211 // If the first row can't offer anything, bail out.
212 if ($height == 0 and $object_id == 0)
213 break;
214 $height++;
215 }
216 while ($startRow - $height > 0);
93e02204
DO
217# echo "for startRow==${startRow} and template==(" . ($template[$template_idx][0] ? 'T' : 'F');
218# echo ', ' . ($template[$template_idx][1] ? 'T' : 'F') . ', ' . ($template[$template_idx][2] ? 'T' : 'F');
219# echo ") height==${height}<br>\n";
e673ee24
DO
220 return $height;
221}
222
223// This function marks atoms to be avoided by rectHeight() and assigns rowspan/colspan
224// attributes.
225function markSpan (&$rackData, $startRow, $maxheight, $template_idx)
226{
227 global $template, $templateWidth;
228 $colspan = 0;
229 for ($height = 0; $height < $maxheight; $height++)
230 {
231 for ($locidx = 0; $locidx < 3; $locidx++)
232 {
233 if ($template[$template_idx][$locidx])
234 {
235 // Add colspan/rowspan to the first row met and mark the following ones to skip.
93e02204
DO
236 // Explicitly show even single-cell spanned atoms, because rectHeight()
237 // is expeciting this data for correct calculation.
e673ee24
DO
238 if ($colspan != 0)
239 $rackData[$startRow - $height][$locidx]['skipped'] = TRUE;
240 else
241 {
242 $colspan = $templateWidth[$template_idx];
93e02204 243 if ($colspan >= 1)
e673ee24 244 $rackData[$startRow - $height][$locidx]['colspan'] = $colspan;
93e02204 245 if ($maxheight >= 1)
e673ee24
DO
246 $rackData[$startRow - $height][$locidx]['rowspan'] = $maxheight;
247 }
248 }
249 }
250 }
251 return;
252}
253
93e02204
DO
254// This function sets rowspan/solspan/skipped atom attributes for renderRack()
255// What we actually have to do is to find _all_ possible rectangles for each unit
256// and then select the widest of those with the maximal square.
e673ee24
DO
257function markAllSpans (&$rackData = NULL)
258{
259 if ($rackData == NULL)
260 {
0cc24e9a 261 showWarning ('Invalid rackData', __FUNCTION__);
e673ee24
DO
262 return;
263 }
264 for ($i = $rackData['height']; $i > 0; $i--)
93e02204
DO
265 while (markBestSpan ($rackData, $i));
266}
267
268// Calculate height of 6 possible span templates (array is presorted by width
269// descending) and mark the best (if any).
270function markBestSpan (&$rackData, $i)
271{
272 global $template, $templateWidth;
273 for ($j = 0; $j < 6; $j++)
e673ee24 274 {
93e02204
DO
275 $height[$j] = rectHeight ($rackData, $i, $j);
276 $square[$j] = $height[$j] * $templateWidth[$j];
277 }
278 // find the widest rectangle of those with maximal height
279 $maxsquare = max ($square);
280 if (!$maxsquare)
281 return FALSE;
282 $best_template_index = 0;
283 for ($j = 0; $j < 6; $j++)
284 if ($square[$j] == $maxsquare)
e673ee24 285 {
93e02204
DO
286 $best_template_index = $j;
287 $bestheight = $height[$j];
288 break;
e673ee24 289 }
93e02204
DO
290 // distribute span marks
291 markSpan ($rackData, $i, $bestheight, $best_template_index);
292 return TRUE;
e673ee24
DO
293}
294
e673ee24
DO
295// We can mount 'F' atoms and unmount our own 'T' atoms.
296function applyObjectMountMask (&$rackData, $object_id)
297{
298 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
299 for ($locidx = 0; $locidx < 3; $locidx++)
300 switch ($rackData[$unit_no][$locidx]['state'])
301 {
302 case 'F':
303 $rackData[$unit_no][$locidx]['enabled'] = TRUE;
304 break;
305 case 'T':
306 $rackData[$unit_no][$locidx]['enabled'] = ($rackData[$unit_no][$locidx]['object_id'] == $object_id);
307 break;
308 default:
309 $rackData[$unit_no][$locidx]['enabled'] = FALSE;
310 }
311}
312
313// Design change means transition between 'F' and 'A' and back.
314function applyRackDesignMask (&$rackData)
315{
316 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
317 for ($locidx = 0; $locidx < 3; $locidx++)
318 switch ($rackData[$unit_no][$locidx]['state'])
319 {
320 case 'F':
321 case 'A':
322 $rackData[$unit_no][$locidx]['enabled'] = TRUE;
323 break;
324 default:
325 $rackData[$unit_no][$locidx]['enabled'] = FALSE;
326 }
327}
328
329// The same for 'F' and 'U'.
330function applyRackProblemMask (&$rackData)
331{
332 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
333 for ($locidx = 0; $locidx < 3; $locidx++)
334 switch ($rackData[$unit_no][$locidx]['state'])
335 {
336 case 'F':
337 case 'U':
338 $rackData[$unit_no][$locidx]['enabled'] = TRUE;
339 break;
340 default:
341 $rackData[$unit_no][$locidx]['enabled'] = FALSE;
342 }
343}
344
e673ee24
DO
345// This function highlights specified object (and removes previous highlight).
346function highlightObject (&$rackData, $object_id)
347{
348 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
349 for ($locidx = 0; $locidx < 3; $locidx++)
350 if
351 (
352 $rackData[$unit_no][$locidx]['state'] == 'T' and
353 $rackData[$unit_no][$locidx]['object_id'] == $object_id
354 )
355 $rackData[$unit_no][$locidx]['hl'] = 'h';
356 else
357 unset ($rackData[$unit_no][$locidx]['hl']);
358}
359
360// This function marks atoms to selected or not depending on their current state.
361function markupAtomGrid (&$data, $checked_state)
362{
363 for ($unit_no = $data['height']; $unit_no > 0; $unit_no--)
364 for ($locidx = 0; $locidx < 3; $locidx++)
365 {
366 if (!($data[$unit_no][$locidx]['enabled'] === TRUE))
367 continue;
368 if ($data[$unit_no][$locidx]['state'] == $checked_state)
369 $data[$unit_no][$locidx]['checked'] = ' checked';
370 else
371 $data[$unit_no][$locidx]['checked'] = '';
372 }
373}
374
375// This function is almost a clone of processGridForm(), but doesn't save anything to database
376// Return value is the changed rack data.
377// Here we assume that correct filter has already been applied, so we just
378// set or unset checkbox inputs w/o changing atom state.
379function mergeGridFormToRack (&$rackData)
380{
381 $rack_id = $rackData['id'];
382 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
383 for ($locidx = 0; $locidx < 3; $locidx++)
384 {
385 if ($rackData[$unit_no][$locidx]['enabled'] != TRUE)
386 continue;
387 $inputname = "atom_${rack_id}_${unit_no}_${locidx}";
388 if (isset ($_REQUEST[$inputname]) and $_REQUEST[$inputname] == 'on')
389 $rackData[$unit_no][$locidx]['checked'] = ' checked';
390 else
391 $rackData[$unit_no][$locidx]['checked'] = '';
392 }
393}
394
bb0a44e9 395// netmask conversion from length to number
e673ee24
DO
396function binMaskFromDec ($maskL)
397{
bb0a44e9
DO
398 $map_straight = array (
399 0 => 0x00000000,
400 1 => 0x80000000,
401 2 => 0xc0000000,
402 3 => 0xe0000000,
403 4 => 0xf0000000,
404 5 => 0xf8000000,
405 6 => 0xfc000000,
406 7 => 0xfe000000,
407 8 => 0xff000000,
408 9 => 0xff800000,
409 10 => 0xffc00000,
410 11 => 0xffe00000,
411 12 => 0xfff00000,
412 13 => 0xfff80000,
413 14 => 0xfffc0000,
414 15 => 0xfffe0000,
415 16 => 0xffff0000,
416 17 => 0xffff8000,
417 18 => 0xffffc000,
418 19 => 0xffffe000,
419 20 => 0xfffff000,
420 21 => 0xfffff800,
421 22 => 0xfffffc00,
422 23 => 0xfffffe00,
423 24 => 0xffffff00,
424 25 => 0xffffff80,
425 26 => 0xffffffc0,
426 27 => 0xffffffe0,
427 28 => 0xfffffff0,
428 29 => 0xfffffff8,
429 30 => 0xfffffffc,
430 31 => 0xfffffffe,
431 32 => 0xffffffff,
432 );
433 return $map_straight[$maskL];
e673ee24
DO
434}
435
bb0a44e9 436// complementary value
e673ee24
DO
437function binInvMaskFromDec ($maskL)
438{
bb0a44e9
DO
439 $map_compl = array (
440 0 => 0xffffffff,
441 1 => 0x7fffffff,
442 2 => 0x3fffffff,
443 3 => 0x1fffffff,
444 4 => 0x0fffffff,
445 5 => 0x07ffffff,
446 6 => 0x03ffffff,
447 7 => 0x01ffffff,
448 8 => 0x00ffffff,
449 9 => 0x007fffff,
450 10 => 0x003fffff,
451 11 => 0x001fffff,
452 12 => 0x000fffff,
453 13 => 0x0007ffff,
454 14 => 0x0003ffff,
455 15 => 0x0001ffff,
456 16 => 0x0000ffff,
457 17 => 0x00007fff,
458 18 => 0x00003fff,
459 19 => 0x00001fff,
460 20 => 0x00000fff,
461 21 => 0x000007ff,
462 22 => 0x000003ff,
463 23 => 0x000001ff,
464 24 => 0x000000ff,
465 25 => 0x0000007f,
466 26 => 0x0000003f,
467 27 => 0x0000001f,
468 28 => 0x0000000f,
469 29 => 0x00000007,
470 30 => 0x00000003,
471 31 => 0x00000001,
472 32 => 0x00000000,
473 );
474 return $map_compl[$maskL];
e673ee24
DO
475}
476
e673ee24
DO
477// This function looks up 'has_problems' flag for 'T' atoms
478// and modifies 'hl' key. May be, this should be better done
61a1d996 479// in amplifyCell(). We don't honour 'skipped' key, because
e673ee24
DO
480// the function is also used for thumb creation.
481function markupObjectProblems (&$rackData)
482{
483 for ($i = $rackData['height']; $i > 0; $i--)
484 for ($locidx = 0; $locidx < 3; $locidx++)
485 if ($rackData[$i][$locidx]['state'] == 'T')
486 {
6297d584 487 $object = spotEntity ('object', $rackData[$i][$locidx]['object_id']);
e673ee24
DO
488 if ($object['has_problems'] == 'yes')
489 {
490 // Object can be already highlighted.
491 if (isset ($rackData[$i][$locidx]['hl']))
492 $rackData[$i][$locidx]['hl'] = $rackData[$i][$locidx]['hl'] . 'w';
493 else
494 $rackData[$i][$locidx]['hl'] = 'w';
495 }
496 }
497}
498
d516d719
DO
499// Return a uniformly (010203040506 or 0102030405060708) formatted address, if it is present
500// in the provided string, an empty string for an empty string or NULL for error.
e673ee24
DO
501function l2addressForDatabase ($string)
502{
e673ee24 503 $string = strtoupper ($string);
05771508
DO
504 switch (TRUE)
505 {
d516d719 506 case ($string == '' or preg_match (RE_L2_SOLID, $string) or preg_match (RE_L2_WWN_SOLID, $string)):
05771508 507 return $string;
d516d719
DO
508 case (preg_match (RE_L2_IFCFG, $string) or preg_match (RE_L2_WWN_COLON, $string)):
509 // reformat output of SunOS ifconfig
510 $ret = '';
511 foreach (explode (':', $string) as $byte)
512 $ret .= (strlen ($byte) == 1 ? '0' : '') . $byte;
513 return $ret;
05771508 514 case (preg_match (RE_L2_CISCO, $string)):
d516d719
DO
515 return str_replace ('.', '', $string);
516 case (preg_match (RE_L2_IPCFG, $string) or preg_match (RE_L2_WWN_HYPHEN, $string)):
517 return str_replace ('-', '', $string);
05771508
DO
518 default:
519 return NULL;
520 }
e673ee24
DO
521}
522
523function l2addressFromDatabase ($string)
524{
525 switch (strlen ($string))
526 {
527 case 12: // Ethernet
d516d719 528 case 16: // FireWire/Fibre Channel
e673ee24
DO
529 $ret = implode (':', str_split ($string, 2));
530 break;
531 default:
532 $ret = $string;
533 break;
534 }
535 return $ret;
536}
537
538// The following 2 functions return previous and next rack IDs for
539// a given rack ID. The order of racks is the same as in renderRackspace()
540// or renderRow().
541function getPrevIDforRack ($row_id = 0, $rack_id = 0)
542{
543 if ($row_id <= 0 or $rack_id <= 0)
544 {
0cc24e9a 545 showWarning ('Invalid arguments passed', __FUNCTION__);
e673ee24
DO
546 return NULL;
547 }
a8efc03e 548 $rackList = listCells ('rack', $row_id);
e673ee24
DO
549 doubleLink ($rackList);
550 if (isset ($rackList[$rack_id]['prev_key']))
551 return $rackList[$rack_id]['prev_key'];
552 return NULL;
553}
554
555function getNextIDforRack ($row_id = 0, $rack_id = 0)
556{
557 if ($row_id <= 0 or $rack_id <= 0)
558 {
0cc24e9a 559 showWarning ('Invalid arguments passed', __FUNCTION__);
e673ee24
DO
560 return NULL;
561 }
a8efc03e 562 $rackList = listCells ('rack', $row_id);
e673ee24
DO
563 doubleLink ($rackList);
564 if (isset ($rackList[$rack_id]['next_key']))
565 return $rackList[$rack_id]['next_key'];
566 return NULL;
567}
568
569// This function finds previous and next array keys for each array key and
570// modifies its argument accordingly.
571function doubleLink (&$array)
572{
573 $prev_key = NULL;
574 foreach (array_keys ($array) as $key)
575 {
576 if ($prev_key)
577 {
578 $array[$key]['prev_key'] = $prev_key;
579 $array[$prev_key]['next_key'] = $key;
580 }
581 $prev_key = $key;
582 }
583}
584
e673ee24
DO
585function sortTokenize ($a, $b)
586{
587 $aold='';
588 while ($a != $aold)
589 {
590 $aold=$a;
591 $a = ereg_replace('[^a-zA-Z0-9]',' ',$a);
592 $a = ereg_replace('([0-9])([a-zA-Z])','\\1 \\2',$a);
593 $a = ereg_replace('([a-zA-Z])([0-9])','\\1 \\2',$a);
594 }
595
596 $bold='';
597 while ($b != $bold)
598 {
599 $bold=$b;
600 $b = ereg_replace('[^a-zA-Z0-9]',' ',$b);
601 $b = ereg_replace('([0-9])([a-zA-Z])','\\1 \\2',$b);
602 $b = ereg_replace('([a-zA-Z])([0-9])','\\1 \\2',$b);
603 }
604
605
606
607 $ar = explode(' ', $a);
608 $br = explode(' ', $b);
609 for ($i=0; $i<count($ar) && $i<count($br); $i++)
610 {
611 $ret = 0;
612 if (is_numeric($ar[$i]) and is_numeric($br[$i]))
613 $ret = ($ar[$i]==$br[$i])?0:($ar[$i]<$br[$i]?-1:1);
614 else
615 $ret = strcasecmp($ar[$i], $br[$i]);
616 if ($ret != 0)
617 return $ret;
618 }
619 if ($i<count($ar))
620 return 1;
621 if ($i<count($br))
622 return -1;
623 return 0;
624}
625
626function sortByName ($a, $b)
627{
bbeb64fd
DO
628 $result = sortTokenize ($a['name'], $b['name']);
629 if ($result != 0)
630 return $result;
631 if ($a['iif_id'] != $b['iif_id'])
632 return $a['iif_id'] - $b['iif_id'];
633 $result = strcmp ($a['label'], $b['label']);
634 if ($result != 0)
635 return $result;
636 $result = strcmp ($a['l2address'], $b['l2address']);
637 if ($result != 0)
638 return $result;
639 return $a['id'] - $b['id'];
e673ee24
DO
640}
641
e673ee24
DO
642function sortObjectAddressesAndNames ($a, $b)
643{
644 $objname_cmp = sortTokenize($a['object_name'], $b['object_name']);
645 if ($objname_cmp == 0)
646 {
79f22c3d
DO
647 $name_a = (isset ($a['port_name'])) ? $a['port_name'] : '';
648 $name_b = (isset ($b['port_name'])) ? $b['port_name'] : '';
649 $objname_cmp = sortTokenize($name_a, $name_b);
e673ee24 650 if ($objname_cmp == 0)
e673ee24 651 sortTokenize($a['ip'], $b['ip']);
e673ee24
DO
652 return $objname_cmp;
653 }
654 return $objname_cmp;
655}
656
c31cd72c 657// This function returns an array of single element of object's FQDN attribute,
f321b50a
DO
658// if FQDN is set. The next choice is object's common name, if it looks like a
659// hostname. Otherwise an array of all 'regular' IP addresses of the
c31cd72c 660// object is returned (which may appear 0 and more elements long).
f321b50a 661function findAllEndpoints ($object_id, $fallback = '')
c31cd72c 662{
7fa7047a
DO
663 foreach (getAttrValues ($object_id) as $record)
664 if ($record['id'] == 3 && strlen ($record['value'])) // FQDN
c31cd72c 665 return array ($record['value']);
c31cd72c 666 $regular = array();
85970da2
DO
667 foreach (getObjectIPv4Allocations ($object_id) as $dottedquad => $alloc)
668 if ($alloc['type'] == 'regular')
669 $regular[] = $dottedquad;
59a83bd8 670 if (!count ($regular) && strlen ($fallback))
f321b50a 671 return array ($fallback);
c31cd72c
DO
672 return $regular;
673}
674
83ba6670
DO
675// Some records in the dictionary may be written as plain text or as Wiki
676// link in the following syntax:
677// 1. word
678// 2. [[word URL]] // FIXME: this isn't working
679// 3. [[word word word | URL]]
680// This function parses the line and returns text suitable for either A
681// (rendering <A HREF>) or O (for <OPTION>).
7fa7047a 682function parseWikiLink ($line, $which)
83ba6670 683{
010231c2 684 if (preg_match ('/^\[\[.+\]\]$/', $line) == 0)
24cbe8af 685 {
7fa7047a
DO
686 // always strip the marker for A-data, but let cookOptgroup()
687 // do this later (otherwise it can't sort groups out)
688 if ($which == 'a')
f0b540a3 689 return ereg_replace ('^.+%GSKIP%', '', ereg_replace ('^(.+)%GPASS%', '\\1 ', $line));
24cbe8af
DO
690 else
691 return $line;
692 }
010231c2
DO
693 $line = preg_replace ('/^\[\[(.+)\]\]$/', '$1', $line);
694 $s = explode ('|', $line);
83ba6670 695 $o_value = trim ($s[0]);
83ba6670
DO
696 if ($which == 'o')
697 return $o_value;
7fa7047a
DO
698 $o_value = ereg_replace ('^.+%GSKIP%', '', ereg_replace ('^(.+)%GPASS%', '\\1 ', $o_value));
699 $a_value = trim ($s[1]);
700 return "<a href='${a_value}'>${o_value}</a>";
83ba6670
DO
701}
702
c9edf725
DO
703// FIXME: should this be saved as "P-data"?
704function execGMarker ($line)
705{
706 return ereg_replace ('^.+%GSKIP%', '', ereg_replace ('^(.+)%GPASS%', '\\1 ', $line));
707}
708
177b1e9b
DO
709// rackspace usage for a single rack
710// (T + W + U) / (height * 3 - A)
11df133a 711function getRSUforRack ($data = NULL)
177b1e9b 712{
11df133a 713 if ($data == NULL)
177b1e9b 714 {
0cc24e9a 715 showWarning ('Invalid argument', __FUNCTION__);
177b1e9b
DO
716 return NULL;
717 }
6ffba290 718 $counter = array ('A' => 0, 'U' => 0, 'T' => 0, 'W' => 0, 'F' => 0);
9e60f7df
DO
719 for ($unit_no = $data['height']; $unit_no > 0; $unit_no--)
720 for ($locidx = 0; $locidx < 3; $locidx++)
721 $counter[$data[$unit_no][$locidx]['state']]++;
dfa3c075 722 return ($counter['T'] + $counter['W'] + $counter['U']) / ($counter['T'] + $counter['W'] + $counter['U'] + $counter['F']);
177b1e9b
DO
723}
724
11df133a
DO
725// Same for row.
726function getRSUforRackRow ($rowData = NULL)
727{
bb26a59e 728 if ($rowData === NULL)
11df133a 729 {
0cc24e9a 730 showWarning ('Invalid argument', __FUNCTION__);
11df133a
DO
731 return NULL;
732 }
bb26a59e
DO
733 if (!count ($rowData))
734 return 0;
11df133a 735 $counter = array ('A' => 0, 'U' => 0, 'T' => 0, 'W' => 0, 'F' => 0);
f81a2012 736 $total_height = 0;
dfa3c075
DO
737 foreach (array_keys ($rowData) as $rack_id)
738 {
61a1d996
DO
739 $data = spotEntity ('rack', $rack_id);
740 amplifyCell ($data);
dfa3c075 741 $total_height += $data['height'];
11df133a
DO
742 for ($unit_no = $data['height']; $unit_no > 0; $unit_no--)
743 for ($locidx = 0; $locidx < 3; $locidx++)
744 $counter[$data[$unit_no][$locidx]['state']]++;
dfa3c075
DO
745 }
746 return ($counter['T'] + $counter['W'] + $counter['U']) / ($counter['T'] + $counter['W'] + $counter['U'] + $counter['F']);
11df133a
DO
747}
748
9af110b4
DO
749// Make sure the string is always wrapped with LF characters
750function lf_wrap ($str)
751{
752 $ret = trim ($str, "\r\n");
59a83bd8 753 if (strlen ($ret))
9af110b4
DO
754 $ret .= "\n";
755 return $ret;
756}
757
e6e7d8b3
DO
758// Adopted from Mantis BTS code.
759function string_insert_hrefs ($s)
760{
761 if (getConfigVar ('DETECT_URLS') != 'yes')
762 return $s;
763 # Find any URL in a string and replace it by a clickable link
764 $s = preg_replace( '/(([[:alpha:]][-+.[:alnum:]]*):\/\/(%[[:digit:]A-Fa-f]{2}|[-_.!~*\';\/?%^\\\\:@&={\|}+$#\(\),\[\][:alnum:]])+)/se',
765 "'<a href=\"'.rtrim('\\1','.').'\">\\1</a> [<a href=\"'.rtrim('\\1','.').'\" target=\"_blank\">^</a>]'",
766 $s);
767 $s = preg_replace( '/\b' . email_regex_simple() . '\b/i',
768 '<a href="mailto:\0">\0</a>',
769 $s);
770 return $s;
771}
772
773// Idem.
774function email_regex_simple ()
775{
776 return "(([a-z0-9!#*+\/=?^_{|}~-]+(?:\.[a-z0-9!#*+\/=?^_{|}~-]+)*)" . # recipient
777 "\@((?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?))"; # @domain
778}
779
118e4c38
DO
780// Parse AUTOPORTS_CONFIG and return a list of generated pairs (port_type, port_name)
781// for the requested object_type_id.
782function getAutoPorts ($type_id)
783{
784 $ret = array();
785 $typemap = explode (';', str_replace (' ', '', getConfigVar ('AUTOPORTS_CONFIG')));
786 foreach ($typemap as $equation)
787 {
788 $tmp = explode ('=', $equation);
789 if (count ($tmp) != 2)
790 continue;
791 $objtype_id = $tmp[0];
792 if ($objtype_id != $type_id)
793 continue;
794 $portlist = $tmp[1];
795 foreach (explode ('+', $portlist) as $product)
796 {
797 $tmp = explode ('*', $product);
798 if (count ($tmp) != 3)
799 continue;
800 $nports = $tmp[0];
801 $port_type = $tmp[1];
802 $format = $tmp[2];
803 for ($i = 0; $i < $nports; $i++)
804 $ret[] = array ('type' => $port_type, 'name' => @sprintf ($format, $i));
805 }
806 }
807 return $ret;
808}
809
86256b96
DO
810// Use pre-served trace to traverse the tree, then place given node where it belongs.
811function pokeNode (&$tree, $trace, $key, $value, $threshold = 0)
812{
813 // This function needs the trace to be followed FIFO-way. The fastest
814 // way to do so is to use array_push() for putting values into the
815 // list and array_shift() for getting them out. This exposed up to 11%
816 // performance gain compared to other patterns of array_push/array_unshift/
817 // array_reverse/array_pop/array_shift conjunction.
818 $myid = array_shift ($trace);
819 if (!count ($trace)) // reached the target
9dfd4cc9 820 {
86256b96
DO
821 if (!$threshold or ($threshold and $tree[$myid]['kidc'] + 1 < $threshold))
822 $tree[$myid]['kids'][$key] = $value;
823 // Reset accumulated records once, when the limit is reached, not each time
824 // after that.
825 if (++$tree[$myid]['kidc'] == $threshold)
826 $tree[$myid]['kids'] = array();
827 }
828 else // not yet
829 {
830 $self = __FUNCTION__;
831 $self ($tree[$myid]['kids'], $trace, $key, $value, $threshold);
9dfd4cc9 832 }
9dfd4cc9
DO
833}
834
0ba76ca2
DO
835// Likewise traverse the tree with the trace and return the final node.
836function peekNode ($tree, $trace, $target_id)
837{
838 $self = __FUNCTION__;
839 if (NULL === ($next = array_shift ($trace))) // warm
840 {
841 foreach ($tree as $node)
f1e27fe5 842 if (array_key_exists ('id', $node) and $node['id'] == $target_id) // hot
0ba76ca2
DO
843 return $node;
844 }
845 else // cold
846 {
847 foreach ($tree as $node)
3e576410 848 if (array_key_exists ('id', $node) and $node['id'] == $next) // warmer
0ba76ca2
DO
849 return $self ($node['kids'], $trace, $target_id);
850 }
851 // HCF
852 return NULL;
853}
854
d65353ad
DO
855// Build a tree from the item list and return it. Input and output data is
856// indexed by item id (nested items in output are recursively stored in 'kids'
51b6651a
DO
857// key, which is in turn indexed by id. Functions, which are ready to handle
858// tree collapsion/expansion themselves, may request non-zero threshold value
859// for smaller resulting tree.
3fb336f6 860function treeFromList (&$orig_nodelist, $threshold = 0, $return_main_payload = TRUE)
d65353ad 861{
86256b96 862 $tree = array();
3fb336f6 863 $nodelist = $orig_nodelist;
86256b96
DO
864 // Array equivalent of traceEntity() function.
865 $trace = array();
866 // set kidc and kids only once
867 foreach (array_keys ($nodelist) as $nodeid)
868 {
869 $nodelist[$nodeid]['kidc'] = 0;
870 $nodelist[$nodeid]['kids'] = array();
871 }
872 do
9dfd4cc9 873 {
86256b96
DO
874 $nextpass = FALSE;
875 foreach (array_keys ($nodelist) as $nodeid)
9dfd4cc9 876 {
86256b96
DO
877 // When adding a node to the working tree, book another
878 // iteration, because the new item could make a way for
879 // others onto the tree. Also remove any item added from
880 // the input list, so iteration base shrinks.
881 // First check if we can assign directly.
882 if ($nodelist[$nodeid]['parent_id'] == NULL)
9dfd4cc9 883 {
86256b96
DO
884 $tree[$nodeid] = $nodelist[$nodeid];
885 $trace[$nodeid] = array(); // Trace to root node is empty
886 unset ($nodelist[$nodeid]);
887 $nextpass = TRUE;
9dfd4cc9 888 }
86256b96
DO
889 // Now look if it fits somewhere on already built tree.
890 elseif (isset ($trace[$nodelist[$nodeid]['parent_id']]))
9dfd4cc9 891 {
86256b96
DO
892 // Trace to a node is a trace to its parent plus parent id.
893 $trace[$nodeid] = $trace[$nodelist[$nodeid]['parent_id']];
894 $trace[$nodeid][] = $nodelist[$nodeid]['parent_id'];
895 pokeNode ($tree, $trace[$nodeid], $nodeid, $nodelist[$nodeid], $threshold);
896 // path to any other node is made of all parent nodes plus the added node itself
897 unset ($nodelist[$nodeid]);
898 $nextpass = TRUE;
9dfd4cc9
DO
899 }
900 }
9dfd4cc9 901 }
86256b96 902 while ($nextpass);
3fb336f6 903 if (!$return_main_payload)
86256b96 904 return $nodelist;
3fb336f6
DO
905 // update each input node with its backtrace route
906 foreach ($trace as $nodeid => $route)
907 $orig_nodelist[$nodeid]['trace'] = $route;
908 return $tree;
9dfd4cc9
DO
909}
910
49fb1027 911// Build a tree from the tag list and return everything _except_ the tree.
573214e0
DO
912// IOW, return taginfo items, which have parent_id set and pointing outside
913// of the "normal" tree, which originates from the root.
49fb1027
DO
914function getOrphanedTags ()
915{
916 global $taglist;
86256b96 917 return treeFromList ($taglist, 0, FALSE);
49fb1027
DO
918}
919
6e49bd1f 920function serializeTags ($chain, $baseurl = '')
ba93bd98
DO
921{
922 $comma = '';
923 $ret = '';
6e49bd1f 924 foreach ($chain as $taginfo)
ba93bd98 925 {
e2ac59cf 926 $ret .= $comma .
a8efc03e 927 ($baseurl == '' ? '' : "<a href='${baseurl}cft[]=${taginfo['id']}'>") .
e2ac59cf
DO
928 $taginfo['tag'] .
929 ($baseurl == '' ? '' : '</a>');
ba93bd98
DO
930 $comma = ', ';
931 }
932 return $ret;
933}
934
ba93bd98
DO
935// Return the list of missing implicit tags.
936function getImplicitTags ($oldtags)
937{
3fb336f6
DO
938 global $taglist;
939 $tmp = array();
940 foreach ($oldtags as $taginfo)
941 $tmp = array_merge ($tmp, $taglist[$taginfo['id']]['trace']);
942 // don't call array_unique here, it is in the function we will call now
943 return buildTagChainFromIds ($tmp);
ba93bd98
DO
944}
945
6e49bd1f 946// Minimize the chain: exclude all implicit tags and return the result.
5fd2a004
DO
947// This function makes use of an external cache with a miss/hit ratio
948// about 3/7 (ticket:255).
3fb336f6 949function getExplicitTagsOnly ($chain)
ab379543 950{
5fd2a004 951 global $taglist, $tagRelCache;
ab379543 952 $ret = array();
5fd2a004
DO
953 foreach (array_keys ($chain) as $keyA) // check each A
954 {
955 $tagidA = $chain[$keyA]['id'];
956 // do not include A in result, if A is seen on the trace of any B!=A
957 foreach (array_keys ($chain) as $keyB)
958 {
959 $tagidB = $chain[$keyB]['id'];
960 if ($tagidA == $tagidB)
961 continue;
962 if (!isset ($tagRelCache[$tagidA][$tagidB]))
0745db4d 963 $tagRelCache[$tagidA][$tagidB] = in_array ($tagidA, $taglist[$tagidB]['trace']);
5fd2a004
DO
964 if ($tagRelCache[$tagidA][$tagidB] === TRUE) // A is ancestor of B
965 continue 2; // skip this A
966 }
967 $ret[] = $chain[$keyA];
968 }
74ccacff
DO
969 return $ret;
970}
971
2c21a10c 972// Universal autotags generator, a complementing function for loadEntityTags().
2c21a10c 973// Bypass key isn't strictly typed, but interpreted depending on the realm.
d16af52f 974function generateEntityAutoTags ($cell)
cce6b057 975{
cce6b057 976 $ret = array();
d16af52f 977 switch ($cell['realm'])
2c21a10c
DO
978 {
979 case 'rack':
d16af52f 980 $ret[] = array ('tag' => '$rackid_' . $cell['id']);
2c21a10c
DO
981 $ret[] = array ('tag' => '$any_rack');
982 break;
4c9d35ec 983 case 'object':
d16af52f
DO
984 $ret[] = array ('tag' => '$id_' . $cell['id']);
985 $ret[] = array ('tag' => '$typeid_' . $cell['objtype_id']);
2c21a10c 986 $ret[] = array ('tag' => '$any_object');
588b2b79 987 if (validTagName ('$cn_' . $cell['name'], TRUE))
d16af52f
DO
988 $ret[] = array ('tag' => '$cn_' . $cell['name']);
989 if (!strlen ($cell['rack_id']))
914b439b 990 $ret[] = array ('tag' => '$unmounted');
6d472f26
DO
991 if (!$cell['nports'])
992 $ret[] = array ('tag' => '$portless');
5d6de575
DO
993 if ($cell['asset_no'] == '')
994 $ret[] = array ('tag' => '$no_asset_tag');
2c21a10c 995 break;
4c9d35ec 996 case 'ipv4net':
d16af52f
DO
997 $ret[] = array ('tag' => '$ip4netid_' . $cell['id']);
998 $ret[] = array ('tag' => '$ip4net-' . str_replace ('.', '-', $cell['ip']) . '-' . $cell['mask']);
b9b915d5
DO
999 for ($i = 8; $i < 32; $i++)
1000 {
1001 // these conditions hit 1 to 3 times per each i
1002 if ($cell['mask'] >= $i)
1003 $ret[] = array ('tag' => '$masklen_ge_' . $i);
1004 if ($cell['mask'] <= $i)
1005 $ret[] = array ('tag' => '$masklen_le_' . $i);
1006 if ($cell['mask'] == $i)
1007 $ret[] = array ('tag' => '$masklen_eq_' . $i);
1008 }
2c21a10c
DO
1009 $ret[] = array ('tag' => '$any_ip4net');
1010 $ret[] = array ('tag' => '$any_net');
1011 break;
1012 case 'ipv4vs':
d16af52f 1013 $ret[] = array ('tag' => '$ipv4vsid_' . $cell['id']);
2c21a10c
DO
1014 $ret[] = array ('tag' => '$any_ipv4vs');
1015 $ret[] = array ('tag' => '$any_vs');
1016 break;
1017 case 'ipv4rspool':
d16af52f 1018 $ret[] = array ('tag' => '$ipv4rspid_' . $cell['id']);
2c21a10c
DO
1019 $ret[] = array ('tag' => '$any_ipv4rsp');
1020 $ret[] = array ('tag' => '$any_rsp');
1021 break;
1022 case 'user':
b82cce3f
DO
1023 // {$username_XXX} autotag is generated always, but {$userid_XXX}
1024 // appears only for accounts, which exist in local database.
d16af52f
DO
1025 $ret[] = array ('tag' => '$username_' . $cell['user_name']);
1026 if (isset ($cell['user_id']))
1027 $ret[] = array ('tag' => '$userid_' . $cell['user_id']);
2c21a10c
DO
1028 break;
1029 case 'file':
d16af52f 1030 $ret[] = array ('tag' => '$fileid_' . $cell['id']);
2c21a10c
DO
1031 $ret[] = array ('tag' => '$any_file');
1032 break;
d16af52f 1033 default: // HCF!
2c21a10c
DO
1034 break;
1035 }
4c9d35ec
DO
1036 // {$tagless} doesn't apply to users
1037 switch ($cell['realm'])
1038 {
1039 case 'rack':
1040 case 'object':
1041 case 'ipv4net':
1042 case 'ipv4vs':
1043 case 'ipv4rspool':
1044 case 'file':
1045 if (!count ($cell['etags']))
1046 $ret[] = array ('tag' => '$untagged');
1047 break;
1048 default:
1049 break;
1050 }
f9bc186f
DO
1051 return $ret;
1052}
1053
abef7149
DO
1054// Check, if the given tag is present on the chain (will only work
1055// for regular tags with tag ID set.
1056function tagOnChain ($taginfo, $tagchain)
1057{
1058 if (!isset ($taginfo['id']))
1059 return FALSE;
1060 foreach ($tagchain as $test)
1061 if ($test['id'] == $taginfo['id'])
1062 return TRUE;
1063 return FALSE;
1064}
1065
f8821b96
DO
1066function tagNameOnChain ($tagname, $tagchain)
1067{
1068 foreach ($tagchain as $test)
1069 if ($test['tag'] == $tagname)
1070 return TRUE;
1071 return FALSE;
1072}
1073
abef7149
DO
1074// Return TRUE, if two tags chains differ (order of tags doesn't matter).
1075// Assume, that neither of the lists contains duplicates.
1076// FIXME: a faster, than O(x^2) method is possible for this calculation.
1077function tagChainCmp ($chain1, $chain2)
1078{
1079 if (count ($chain1) != count ($chain2))
1080 return TRUE;
1081 foreach ($chain1 as $taginfo1)
1082 if (!tagOnChain ($taginfo1, $chain2))
1083 return TRUE;
1084 return FALSE;
1085}
1086
0df8c52b 1087function redirectIfNecessary ()
da958e52 1088{
750d26d2
DO
1089 global
1090 $trigger,
1091 $pageno,
1092 $tabno;
53bae67b
DO
1093 $pmap = array
1094 (
1095 'accounts' => 'userlist',
1096 'rspools' => 'ipv4rsplist',
1097 'rspool' => 'ipv4rsp',
1098 'vservices' => 'ipv4vslist',
1099 'vservice' => 'ipv4vs',
c78a40ec
DO
1100 'objects' => 'depot',
1101 'objgroup' => 'depot',
53bae67b
DO
1102 );
1103 $tmap = array();
1104 $tmap['objects']['newmulti'] = 'addmore';
1105 $tmap['objects']['newobj'] = 'addmore';
1106 $tmap['object']['switchvlans'] = 'livevlans';
1107 $tmap['object']['slb'] = 'editrspvs';
72d8ced3
DO
1108 $tmap['object']['portfwrd'] = 'nat4';
1109 $tmap['object']['network'] = 'ipv4';
53bae67b
DO
1110 if (isset ($pmap[$pageno]))
1111 redirectUser ($pmap[$pageno], $tabno);
1112 if (isset ($tmap[$pageno][$tabno]))
1113 redirectUser ($pageno, $tmap[$pageno][$tabno]);
750d26d2 1114 // check if we accidentaly got on a dynamic tab that shouldn't be shown for this object
3a7bdcc6
DO
1115 if
1116 (
1117 isset ($trigger[$pageno][$tabno]) and
1118 !strlen (call_user_func ($trigger[$pageno][$tabno]))
1119 )
750d26d2 1120 redirectUser ($pageno, 'default');
0df8c52b
DO
1121}
1122
329ec966
DY
1123function prepareNavigation() {
1124 global
1125 $pageno,
1126 $tabno;
1127
1128 $pageno = (isset ($_REQUEST['page'])) ? $_REQUEST['page'] : 'index';
1129
1130// Special handling of tab number to substitute the "last" index where applicable.
1131// Always show explicitly requested tab, substitute the last used name in case
1132// it is awailable, fall back to the default one.
1133
1134 if (isset ($_REQUEST['tab'])) {
1135 $tabno = $_REQUEST['tab'];
329ec966 1136 } elseif (basename($_SERVER['PHP_SELF']) == 'index.php' and getConfigVar ('SHOW_LAST_TAB') == 'yes' and isset ($_SESSION['RTLT'][$pageno])) {
750d26d2 1137 redirectUser ($pageno, $_SESSION['RTLT'][$pageno]);
329ec966
DY
1138 } else {
1139 $tabno = 'default';
1140 }
1141}
1142
0df8c52b
DO
1143function fixContext ($target = NULL)
1144{
1145 global
1146 $pageno,
1147 $auto_tags,
1148 $expl_tags,
1149 $impl_tags,
1150 $target_given_tags,
1151 $user_given_tags,
1152 $etype_by_pageno,
1153 $page;
53bae67b 1154
0df8c52b
DO
1155 if ($target !== NULL)
1156 {
1157 $target_given_tags = $target['etags'];
1158 // Don't reset autochain, because auth procedures could push stuff there in.
1159 // Another important point is to ignore 'user' realm, so we don't infuse effective
1160 // context with autotags of the displayed account.
1161 if ($target['realm'] != 'user')
1162 $auto_tags = array_merge ($auto_tags, $target['atags']);
1163 }
1164 elseif (array_key_exists ($pageno, $etype_by_pageno))
53da7dca
DO
1165 {
1166 // Each page listed in the map above requires one uint argument.
0a50efb4 1167 $target_realm = $etype_by_pageno[$pageno];
0cc24e9a 1168 assertUIntArg ($page[$pageno]['bypass']);
0a50efb4 1169 $target_id = $_REQUEST[$page[$pageno]['bypass']];
b135a49d 1170 $target = spotEntity ($target_realm, $target_id);
53da7dca 1171 $target_given_tags = $target['etags'];
0df8c52b 1172 if ($target['realm'] != 'user')
53da7dca
DO
1173 $auto_tags = array_merge ($auto_tags, $target['atags']);
1174 }
4c9b513a
DO
1175 // Explicit and implicit chains should be normally empty at this point, so
1176 // overwrite the contents anyway.
1177 $expl_tags = mergeTagChains ($user_given_tags, $target_given_tags);
1178 $impl_tags = getImplicitTags ($expl_tags);
da958e52
DO
1179}
1180
abef7149
DO
1181// Take a list of user-supplied tag IDs to build a list of valid taginfo
1182// records indexed by tag IDs (tag chain).
6e49bd1f 1183function buildTagChainFromIds ($tagidlist)
ab379543 1184{
20c901a7 1185 global $taglist;
ab379543 1186 $ret = array();
abef7149 1187 foreach (array_unique ($tagidlist) as $tag_id)
ab379543
DO
1188 if (isset ($taglist[$tag_id]))
1189 $ret[] = $taglist[$tag_id];
1190 return $ret;
1191}
1192
7cc02fc1
DO
1193// Process a given tag tree and return only meaningful branches. The resulting
1194// (sub)tree will have refcnt leaves on every last branch.
a26a6ccc 1195function getObjectiveTagTree ($tree, $realm, $preselect)
7cc02fc1 1196{
51b6651a 1197 $self = __FUNCTION__;
7cc02fc1
DO
1198 $ret = array();
1199 foreach ($tree as $taginfo)
1200 {
a26a6ccc
DO
1201 $subsearch = $self ($taginfo['kids'], $realm, $preselect);
1202 // If the current node addresses something, add it to the result
1203 // regardless of how many sub-nodes it features.
1204 if
7cc02fc1 1205 (
a26a6ccc
DO
1206 isset ($taginfo['refcnt'][$realm]) or
1207 count ($subsearch) > 1 or
3fb336f6 1208 in_array ($taginfo['id'], $preselect)
a26a6ccc
DO
1209 )
1210 $ret[] = array
1211 (
1212 'id' => $taginfo['id'],
1213 'tag' => $taginfo['tag'],
1214 'parent_id' => $taginfo['parent_id'],
1215 'refcnt' => $taginfo['refcnt'],
1216 'kids' => $subsearch
1217 );
1218 else
1219 $ret = array_merge ($ret, $subsearch);
7cc02fc1
DO
1220 }
1221 return $ret;
1222}
1223
7ddb2c05
DO
1224// Get taginfo record by tag name, return NULL, if record doesn't exist.
1225function getTagByName ($target_name)
1226{
1227 global $taglist;
1228 foreach ($taglist as $taginfo)
1229 if ($taginfo['tag'] == $target_name)
1230 return $taginfo;
1231 return NULL;
1232}
1233
fc73c734
DO
1234// Merge two chains, filtering dupes out. Return the resulting superset.
1235function mergeTagChains ($chainA, $chainB)
1236{
1237 // $ret = $chainA;
1238 // Reindex by tag id in any case.
1239 $ret = array();
1240 foreach ($chainA as $tag)
1241 $ret[$tag['id']] = $tag;
1242 foreach ($chainB as $tag)
1243 if (!isset ($ret[$tag['id']]))
1244 $ret[$tag['id']] = $tag;
1245 return $ret;
1246}
1247
31c941ec
DO
1248function getCellFilter ()
1249{
7da7450c 1250 global $sic;
3d670bba 1251 if (isset ($_REQUEST['tagfilter']) and is_array ($_REQUEST['tagfilter']))
23cdc7e9
DO
1252 {
1253 $_REQUEST['cft'] = $_REQUEST['tagfilter'];
1254 unset ($_REQUEST['tagfilter']);
1255 }
3d670bba
DO
1256 $ret = array
1257 (
23cdc7e9
DO
1258 'tagidlist' => array(),
1259 'tnamelist' => array(),
1260 'pnamelist' => array(),
1261 'andor' => '',
3d670bba 1262 'text' => '',
23cdc7e9
DO
1263 'extratext' => '',
1264 'expression' => array(),
a8efc03e 1265 'urlextra' => '', // Just put text here and let makeHref call urlencode().
3d670bba 1266 );
23cdc7e9 1267 switch (TRUE)
31c941ec 1268 {
23cdc7e9
DO
1269 case (!isset ($_REQUEST['andor'])):
1270 $andor2 = getConfigVar ('FILTER_DEFAULT_ANDOR');
3d670bba 1271 break;
23cdc7e9
DO
1272 case ($_REQUEST['andor'] == 'and'):
1273 case ($_REQUEST['andor'] == 'or'):
1274 $ret['andor'] = $andor2 = $_REQUEST['andor'];
a8efc03e 1275 $ret['urlextra'] .= '&andor=' . $ret['andor'];
3d670bba
DO
1276 break;
1277 default:
0cc24e9a 1278 showWarning ('Invalid and/or switch value in submitted form', __FUNCTION__);
3d670bba 1279 return NULL;
31c941ec 1280 }
23cdc7e9
DO
1281 $andor1 = '';
1282 // Both tags and predicates, which don't exist, should be
1283 // handled somehow. Discard them silently for now.
1284 if (isset ($_REQUEST['cft']) and is_array ($_REQUEST['cft']))
31c941ec 1285 {
23cdc7e9
DO
1286 global $taglist;
1287 foreach ($_REQUEST['cft'] as $req_id)
1288 if (isset ($taglist[$req_id]))
1289 {
1290 $ret['tagidlist'][] = $req_id;
1291 $ret['tnamelist'][] = $taglist[$req_id]['tag'];
1292 $ret['text'] .= $andor1 . '{' . $taglist[$req_id]['tag'] . '}';
1293 $andor1 = ' ' . $andor2 . ' ';
a8efc03e 1294 $ret['urlextra'] .= '&cft[]=' . $req_id;
23cdc7e9
DO
1295 }
1296 }
1297 if (isset ($_REQUEST['cfp']) and is_array ($_REQUEST['cfp']))
1298 {
1299 global $pTable;
1300 foreach ($_REQUEST['cfp'] as $req_name)
1301 if (isset ($pTable[$req_name]))
1302 {
1303 $ret['pnamelist'][] = $req_name;
1304 $ret['text'] .= $andor1 . '[' . $req_name . ']';
1305 $andor1 = ' ' . $andor2 . ' ';
a8efc03e 1306 $ret['urlextra'] .= '&cfp[]=' . $req_name;
23cdc7e9
DO
1307 }
1308 }
7da7450c
DO
1309 // Extra text comes from TEXTAREA and is easily screwed by standard escaping function.
1310 if (isset ($sic['cfe']))
a8efc03e 1311 {
7da7450c
DO
1312 // Only consider extra text, when it is a correct RackCode expression.
1313 $parse = spotPayload ($sic['cfe'], 'SYNT_EXPR');
1314 if ($parse['result'] == 'ACK')
1315 {
1316 $ret['extratext'] = trim ($sic['cfe']);
1317 $ret['urlextra'] .= '&cfe=' . $ret['extratext'];
1318 }
a8efc03e 1319 }
23cdc7e9
DO
1320 $finaltext = array();
1321 if (strlen ($ret['text']))
1322 $finaltext[] = '(' . $ret['text'] . ')';
1323 if (strlen ($ret['extratext']))
1324 $finaltext[] = '(' . $ret['extratext'] . ')';
1325 $finaltext = implode (' ' . $andor2 . ' ', $finaltext);
1326 if (strlen ($finaltext))
1327 {
1328 $parse = spotPayload ($finaltext, 'SYNT_EXPR');
1329 $ret['expression'] = $parse['result'] == 'ACK' ? $parse['load'] : NULL;
8c699525
DO
1330 // It's not quite fair enough to put the blame of the whole text onto
1331 // non-empty "extra" portion of it, but it's the only user-generated portion
1332 // of it, thus the most probable cause of parse error.
1333 if (strlen ($ret['extratext']))
1334 $ret['extraclass'] = $parse['result'] == 'ACK' ? 'validation-success' : 'validation-error';
31c941ec 1335 }
3d670bba 1336 return $ret;
31c941ec
DO
1337}
1338
db55cf54
DO
1339// Return an empty message log.
1340function emptyLog ()
1341{
1342 return array
1343 (
1344 'v' => 2,
1345 'm' => array()
1346 );
1347}
1348
2987fc1f
DO
1349// Return a message log consisting of only one message.
1350function oneLiner ($code, $args = array())
1351{
db55cf54 1352 $ret = emptyLog();
2987fc1f
DO
1353 $ret['m'][] = count ($args) ? array ('c' => $code, 'a' => $args) : array ('c' => $code);
1354 return $ret;
46f92ff7
DO
1355}
1356
e53b1246
DO
1357// Merge message payload from two message logs given and return the result.
1358function mergeLogs ($log1, $log2)
1359{
1360 $ret = emptyLog();
1361 $ret['m'] = array_merge ($log1['m'], $log2['m']);
1362 return $ret;
1363}
1364
9f54e6e9 1365function validTagName ($s, $allow_autotag = FALSE)
2eeeca80 1366{
9f54e6e9
DO
1367 if (1 == mb_ereg (TAGNAME_REGEXP, $s))
1368 return TRUE;
1369 if ($allow_autotag and 1 == mb_ereg (AUTOTAGNAME_REGEXP, $s))
1370 return TRUE;
1371 return FALSE;
2eeeca80
DO
1372}
1373
53bae67b
DO
1374function redirectUser ($p, $t)
1375{
790a60e8
DO
1376 global $page;
1377 $l = "index.php?page=${p}&tab=${t}";
53bae67b
DO
1378 if (isset ($page[$p]['bypass']) and isset ($_REQUEST[$page[$p]['bypass']]))
1379 $l .= '&' . $page[$p]['bypass'] . '=' . $_REQUEST[$page[$p]['bypass']];
1380 header ("Location: " . $l);
1381 die;
1382}
1383
9f3e5caa
DO
1384function getRackCodeStats ()
1385{
1386 global $rackCode;
914b439b 1387 $defc = $grantc = $modc = 0;
9f3e5caa
DO
1388 foreach ($rackCode as $s)
1389 switch ($s['type'])
1390 {
1391 case 'SYNT_DEFINITION':
1392 $defc++;
1393 break;
1394 case 'SYNT_GRANT':
1395 $grantc++;
1396 break;
914b439b
DO
1397 case 'SYNT_CTXMOD':
1398 $modc++;
1399 break;
9f3e5caa
DO
1400 default:
1401 break;
1402 }
914b439b
DO
1403 $ret = array
1404 (
1405 'Definition sentences' => $defc,
1406 'Grant sentences' => $grantc,
1407 'Context mod sentences' => $modc
1408 );
9f3e5caa
DO
1409 return $ret;
1410}
1411
d5157018
DO
1412function getRackImageWidth ()
1413{
529eac25
DO
1414 global $rtwidth;
1415 return 3 + $rtwidth[0] + $rtwidth[1] + $rtwidth[2] + 3;
d5157018
DO
1416}
1417
1418function getRackImageHeight ($units)
1419{
1420 return 3 + 3 + $units * 2;
1421}
1422
2987fc1f
DO
1423// Perform substitutions and return resulting string
1424// used solely by buildLVSConfig()
1425function apply_macros ($macros, $subject)
1426{
1427 $ret = $subject;
1428 foreach ($macros as $search => $replace)
1429 $ret = str_replace ($search, $replace, $ret);
1430 return $ret;
1431}
1432
1433function buildLVSConfig ($object_id = 0)
1434{
1435 if ($object_id <= 0)
1436 {
0cc24e9a 1437 showWarning ('Invalid argument', __FUNCTION__);
2987fc1f
DO
1438 return;
1439 }
6297d584 1440 $oInfo = spotEntity ('object', $object_id);
2987fc1f
DO
1441 $lbconfig = getSLBConfig ($object_id);
1442 if ($lbconfig === NULL)
1443 {
0cc24e9a 1444 showWarning ('getSLBConfig() failed', __FUNCTION__);
2987fc1f
DO
1445 return;
1446 }
1447 $newconfig = "#\n#\n# This configuration has been generated automatically by RackTables\n";
1448 $newconfig .= "# for object_id == ${object_id}\n# object name: ${oInfo['name']}\n#\n#\n\n\n";
1449 foreach ($lbconfig as $vs_id => $vsinfo)
1450 {
1451 $newconfig .= "########################################################\n" .
59a83bd8
DO
1452 "# VS (id == ${vs_id}): " . (!strlen ($vsinfo['vs_name']) ? 'NO NAME' : $vsinfo['vs_name']) . "\n" .
1453 "# RS pool (id == ${vsinfo['pool_id']}): " . (!strlen ($vsinfo['pool_name']) ? 'ANONYMOUS' : $vsinfo['pool_name']) . "\n" .
2987fc1f
DO
1454 "########################################################\n";
1455 # The order of inheritance is: VS -> LB -> pool [ -> RS ]
1456 $macros = array
1457 (
1458 '%VIP%' => $vsinfo['vip'],
1459 '%VPORT%' => $vsinfo['vport'],
1460 '%PROTO%' => $vsinfo['proto'],
1461 '%VNAME%' => $vsinfo['vs_name'],
1462 '%RSPOOLNAME%' => $vsinfo['pool_name']
1463 );
1464 $newconfig .= "virtual_server ${vsinfo['vip']} ${vsinfo['vport']} {\n";
1465 $newconfig .= "\tprotocol ${vsinfo['proto']}\n";
1466 $newconfig .= apply_macros
1467 (
1468 $macros,
1469 lf_wrap ($vsinfo['vs_vsconfig']) .
1470 lf_wrap ($vsinfo['lb_vsconfig']) .
1471 lf_wrap ($vsinfo['pool_vsconfig'])
1472 );
1473 foreach ($vsinfo['rslist'] as $rs)
1474 {
59a83bd8 1475 if (!strlen ($rs['rsport']))
79a9edb4 1476 $rs['rsport'] = $vsinfo['vport'];
2987fc1f
DO
1477 $macros['%RSIP%'] = $rs['rsip'];
1478 $macros['%RSPORT%'] = $rs['rsport'];
1479 $newconfig .= "\treal_server ${rs['rsip']} ${rs['rsport']} {\n";
1480 $newconfig .= apply_macros
1481 (
1482 $macros,
1483 lf_wrap ($vsinfo['vs_rsconfig']) .
1484 lf_wrap ($vsinfo['lb_rsconfig']) .
1485 lf_wrap ($vsinfo['pool_rsconfig']) .
1486 lf_wrap ($rs['rs_rsconfig'])
1487 );
1488 $newconfig .= "\t}\n";
1489 }
1490 $newconfig .= "}\n\n\n";
1491 }
3dd72e34
DO
1492 // FIXME: deal somehow with Mac-styled text, the below replacement will screw it up
1493 return str_replace ("\r", '', $newconfig);
2987fc1f
DO
1494}
1495
2d318652
DO
1496// Indicate occupation state of each IP address: none, ordinary or problematic.
1497function markupIPv4AddrList (&$addrlist)
1498{
1499 foreach (array_keys ($addrlist) as $ip_bin)
1500 {
d983f70a
DO
1501 $refc = array
1502 (
00c5d8cb
DO
1503 'shared' => 0, // virtual
1504 'virtual' => 0, // loopback
1505 'regular' => 0, // connected host
1506 'router' => 0 // connected gateway
d983f70a
DO
1507 );
1508 foreach ($addrlist[$ip_bin]['allocs'] as $a)
1509 $refc[$a['type']]++;
00c5d8cb 1510 $nvirtloopback = ($refc['shared'] + $refc['virtual'] > 0) ? 1 : 0; // modulus of virtual + shared
d983f70a
DO
1511 $nreserved = ($addrlist[$ip_bin]['reserved'] == 'yes') ? 1 : 0; // only one reservation is possible ever
1512 $nrealms = $nreserved + $nvirtloopback + $refc['regular'] + $refc['router']; // latter two are connected and router allocations
2d318652
DO
1513
1514 if ($nrealms == 1)
1515 $addrlist[$ip_bin]['class'] = 'trbusy';
1516 elseif ($nrealms > 1)
1517 $addrlist[$ip_bin]['class'] = 'trerror';
1518 else
1519 $addrlist[$ip_bin]['class'] = '';
1520 }
1521}
1522
04d619d0
DO
1523// Scan the given address list (returned by scanIPv4Space) and return a list of all routers found.
1524function findRouters ($addrlist)
1525{
1526 $ret = array();
1527 foreach ($addrlist as $addr)
1528 foreach ($addr['allocs'] as $alloc)
1529 if ($alloc['type'] == 'router')
1530 $ret[] = array
1531 (
1532 'id' => $alloc['object_id'],
1533 'iface' => $alloc['name'],
1534 'dname' => $alloc['object_name'],
1535 'addr' => $addr['ip']
1536 );
1537 return $ret;
1538}
1539
fb7a4967
DO
1540// Assist in tag chain sorting.
1541function taginfoCmp ($tagA, $tagB)
1542{
1543 return $tagA['ci'] - $tagB['ci'];
1544}
1545
1327d9dd
DO
1546// Compare networks. When sorting a tree, the records on the list will have
1547// distinct base IP addresses.
3444ecf2
DO
1548// "The comparison function must return an integer less than, equal to, or greater
1549// than zero if the first argument is considered to be respectively less than,
1550// equal to, or greater than the second." (c) PHP manual
1327d9dd
DO
1551function IPv4NetworkCmp ($netA, $netB)
1552{
2d75c30b
DO
1553 // There's a problem just substracting one u32 integer from another,
1554 // because the result may happen big enough to become a negative i32
1555 // integer itself (PHP tries to cast everything it sees to signed int)
3444ecf2
DO
1556 // The comparison below must treat positive and negative values of both
1557 // arguments.
1558 // Equal values give instant decision regardless of their [equal] sign.
1559 if ($netA['ip_bin'] == $netB['ip_bin'])
2d75c30b 1560 return 0;
3444ecf2
DO
1561 // Same-signed values compete arithmetically within one of i32 contiguous ranges:
1562 // 0x00000001~0x7fffffff 1~2147483647
1563 // 0 doesn't have any sign, and network 0.0.0.0 isn't allowed
1564 // 0x80000000~0xffffffff -2147483648~-1
1565 $signA = $netA['ip_bin'] / abs ($netA['ip_bin']);
1566 $signB = $netB['ip_bin'] / abs ($netB['ip_bin']);
1567 if ($signA == $signB)
1568 {
1569 if ($netA['ip_bin'] > $netB['ip_bin'])
1570 return 1;
1571 else
1572 return -1;
1573 }
1574 else // With only one of two values being negative, it... wins!
1575 {
1576 if ($netA['ip_bin'] < $netB['ip_bin'])
1577 return 1;
1578 else
1579 return -1;
1580 }
1327d9dd
DO
1581}
1582
fb7a4967 1583// Modify the given tag tree so, that each level's items are sorted alphabetically.
1327d9dd 1584function sortTree (&$tree, $sortfunc = '')
fb7a4967 1585{
59a83bd8 1586 if (!strlen ($sortfunc))
1327d9dd 1587 return;
51b6651a 1588 $self = __FUNCTION__;
1327d9dd 1589 usort ($tree, $sortfunc);
fb7a4967
DO
1590 // Don't make a mistake of directly iterating over the items of current level, because this way
1591 // the sorting will be performed on a _copy_ if each item, not the item itself.
1592 foreach (array_keys ($tree) as $tagid)
51b6651a 1593 $self ($tree[$tagid]['kids'], $sortfunc);
fb7a4967
DO
1594}
1595
0137d53c
DO
1596function iptree_fill (&$netdata)
1597{
59a83bd8 1598 if (!isset ($netdata['kids']) or !count ($netdata['kids']))
0137d53c 1599 return;
a987ff52 1600 // If we really have nested prefixes, they must fit into the tree.
0137d53c
DO
1601 $worktree = array
1602 (
1603 'ip_bin' => $netdata['ip_bin'],
1604 'mask' => $netdata['mask']
1605 );
1606 foreach ($netdata['kids'] as $pfx)
1607 iptree_embed ($worktree, $pfx);
1608 $netdata['kids'] = iptree_construct ($worktree);
1609 $netdata['kidc'] = count ($netdata['kids']);
1610}
1611
1612function iptree_construct ($node)
1613{
1614 $self = __FUNCTION__;
1615
1616 if (!isset ($node['right']))
1617 {
1618 if (!isset ($node['ip']))
1619 {
1620 $node['ip'] = long2ip ($node['ip_bin']);
1621 $node['kids'] = array();
fec0c8da 1622 $node['kidc'] = 0;
0137d53c
DO
1623 $node['name'] = '';
1624 }
1625 return array ($node);
1626 }
1627 else
1628 return array_merge ($self ($node['left']), $self ($node['right']));
1629}
1630
1631function iptree_embed (&$node, $pfx)
1632{
1633 $self = __FUNCTION__;
1634
1635 // hit?
1636 if ($node['ip_bin'] == $pfx['ip_bin'] and $node['mask'] == $pfx['mask'])
1637 {
1638 $node = $pfx;
1639 return;
1640 }
1641 if ($node['mask'] == $pfx['mask'])
1642 {
0cc24e9a 1643 throw new RuntimeException('Internal error, the recurring loop lost control');
0137d53c
DO
1644 }
1645
1646 // split?
1647 if (!isset ($node['right']))
1648 {
a987ff52
DO
1649 // Fill in db_first/db_last to make it possible to run scanIPv4Space() on the node.
1650 $node['left']['mask'] = $node['mask'] + 1;
0137d53c 1651 $node['left']['ip_bin'] = $node['ip_bin'];
a987ff52
DO
1652 $node['left']['db_first'] = sprintf ('%u', $node['left']['ip_bin']);
1653 $node['left']['db_last'] = sprintf ('%u', $node['left']['ip_bin'] | binInvMaskFromDec ($node['left']['mask']));
1654
1655 $node['right']['mask'] = $node['mask'] + 1;
0137d53c 1656 $node['right']['ip_bin'] = $node['ip_bin'] + binInvMaskFromDec ($node['mask'] + 1) + 1;
a987ff52
DO
1657 $node['right']['db_first'] = sprintf ('%u', $node['right']['ip_bin']);
1658 $node['right']['db_last'] = sprintf ('%u', $node['right']['ip_bin'] | binInvMaskFromDec ($node['right']['mask']));
0137d53c
DO
1659 }
1660
1661 // repeat!
1662 if (($node['left']['ip_bin'] & binMaskFromDec ($node['left']['mask'])) == ($pfx['ip_bin'] & binMaskFromDec ($node['left']['mask'])))
1663 $self ($node['left'], $pfx);
1664 elseif (($node['right']['ip_bin'] & binMaskFromDec ($node['right']['mask'])) == ($pfx['ip_bin'] & binMaskFromDec ($node['left']['mask'])))
1665 $self ($node['right'], $pfx);
1666 else
1667 {
0cc24e9a 1668 throw new RuntimeException ('Internal error, cannot decide between left and right');
0137d53c
DO
1669 }
1670}
1671
3b81cb98 1672function treeApplyFunc (&$tree, $func = '', $stopfunc = '')
0137d53c 1673{
59a83bd8 1674 if (!strlen ($func))
0137d53c
DO
1675 return;
1676 $self = __FUNCTION__;
1677 foreach (array_keys ($tree) as $key)
1678 {
1679 $func ($tree[$key]);
59a83bd8 1680 if (strlen ($stopfunc) and $stopfunc ($tree[$key]))
c3315231 1681 continue;
0137d53c
DO
1682 $self ($tree[$key]['kids'], $func);
1683 }
1684}
1685
a987ff52
DO
1686function loadIPv4AddrList (&$netinfo)
1687{
1688 loadOwnIPv4Addresses ($netinfo);
1689 markupIPv4AddrList ($netinfo['addrlist']);
1690}
b18d26dc 1691
b6b87070 1692function countOwnIPv4Addresses (&$node)
b18d26dc 1693{
b6b87070 1694 $toscan = array();
737a3f72 1695 $node['addrt'] = 0;
4d0dbd87
DO
1696 $node['mask_bin'] = binMaskFromDec ($node['mask']);
1697 $node['mask_bin_inv'] = binInvMaskFromDec ($node['mask']);
1698 $node['db_first'] = sprintf ('%u', 0x00000000 + $node['ip_bin'] & $node['mask_bin']);
1699 $node['db_last'] = sprintf ('%u', 0x00000000 + $node['ip_bin'] | ($node['mask_bin_inv']));
59a83bd8 1700 if (!count ($node['kids']))
737a3f72 1701 {
f7414fa5 1702 $toscan[] = array ('i32_first' => $node['db_first'], 'i32_last' => $node['db_last']);
737a3f72
DO
1703 $node['addrt'] = binInvMaskFromDec ($node['mask']) + 1;
1704 }
b18d26dc 1705 else
b6b87070 1706 foreach ($node['kids'] as $nested)
b18d26dc 1707 if (!isset ($nested['id'])) // spare
737a3f72 1708 {
f7414fa5 1709 $toscan[] = array ('i32_first' => $nested['db_first'], 'i32_last' => $nested['db_last']);
737a3f72
DO
1710 $node['addrt'] += binInvMaskFromDec ($nested['mask']) + 1;
1711 }
4d0dbd87
DO
1712 // Don't do anything more, because the displaying function will load the addresses anyway.
1713 return;
f7414fa5 1714 $node['addrc'] = count (scanIPv4Space ($toscan));
b6b87070
DO
1715}
1716
c3315231
DO
1717function nodeIsCollapsed ($node)
1718{
1719 return $node['symbol'] == 'node-collapsed';
1720}
1721
b6b87070
DO
1722function loadOwnIPv4Addresses (&$node)
1723{
1724 $toscan = array();
43eb71f1 1725 if (!isset ($node['kids']) or !count ($node['kids']))
f7414fa5 1726 $toscan[] = array ('i32_first' => $node['db_first'], 'i32_last' => $node['db_last']);
b6b87070
DO
1727 else
1728 foreach ($node['kids'] as $nested)
1729 if (!isset ($nested['id'])) // spare
f7414fa5
DO
1730 $toscan[] = array ('i32_first' => $nested['db_first'], 'i32_last' => $nested['db_last']);
1731 $node['addrlist'] = scanIPv4Space ($toscan);
b6b87070 1732 $node['addrc'] = count ($node['addrlist']);
b18d26dc
DO
1733}
1734
fec0c8da
DO
1735function prepareIPv4Tree ($netlist, $expanded_id = 0)
1736{
573214e0
DO
1737 // treeFromList() requires parent_id to be correct for an item to get onto the tree,
1738 // so perform necessary pre-processing to make orphans belong to root. This trick
1739 // was earlier performed by getIPv4NetworkList().
1740 $netids = array_keys ($netlist);
1741 foreach ($netids as $cid)
1742 if (!in_array ($netlist[$cid]['parent_id'], $netids))
1743 $netlist[$cid]['parent_id'] = NULL;
fec0c8da
DO
1744 $tree = treeFromList ($netlist); // medium call
1745 sortTree ($tree, 'IPv4NetworkCmp');
fec0c8da 1746 // complement the tree before markup to make the spare networks have "symbol" set
c3315231
DO
1747 treeApplyFunc ($tree, 'iptree_fill');
1748 iptree_markup_collapsion ($tree, getConfigVar ('TREE_THRESHOLD'), $expanded_id);
1749 // count addresses after the markup to skip computation for hidden tree nodes
1750 treeApplyFunc ($tree, 'countOwnIPv4Addresses', 'nodeIsCollapsed');
fec0c8da
DO
1751 return $tree;
1752}
1753
1754// Check all items of the tree recursively, until the requested target id is
1755// found. Mark all items leading to this item as "expanded", collapsing all
1756// the rest, which exceed the given threshold (if the threshold is given).
1757function iptree_markup_collapsion (&$tree, $threshold = 1024, $target = 0)
1758{
1759 $self = __FUNCTION__;
1760 $ret = FALSE;
1761 foreach (array_keys ($tree) as $key)
1762 {
5388794d 1763 $here = ($target === 'ALL' or ($target > 0 and isset ($tree[$key]['id']) and $tree[$key]['id'] == $target));
fec0c8da
DO
1764 $below = $self ($tree[$key]['kids'], $threshold, $target);
1765 if (!$tree[$key]['kidc']) // terminal node
1766 $tree[$key]['symbol'] = 'spacer';
1767 elseif ($tree[$key]['kidc'] < $threshold)
1768 $tree[$key]['symbol'] = 'node-expanded-static';
1769 elseif ($here or $below)
1770 $tree[$key]['symbol'] = 'node-expanded';
1771 else
1772 $tree[$key]['symbol'] = 'node-collapsed';
1773 $ret = ($ret or $here or $below); // parentheses are necessary for this to be computed correctly
1774 }
1775 return $ret;
1776}
1777
e1ae3fb4
AD
1778// Convert entity name to human-readable value
1779function formatEntityName ($name) {
1780 switch ($name)
1781 {
1782 case 'ipv4net':
1783 return 'IPv4 Network';
1784 case 'ipv4rspool':
1785 return 'IPv4 RS Pool';
1786 case 'ipv4vs':
1787 return 'IPv4 Virtual Service';
1788 case 'object':
1789 return 'Object';
1790 case 'rack':
1791 return 'Rack';
1792 case 'user':
1793 return 'User';
1794 }
1795 return 'invalid';
1796}
1797
1798// Take a MySQL or other generic timestamp and make it prettier
1799function formatTimestamp ($timestamp) {
1800 return date('n/j/y g:iA', strtotime($timestamp));
1801}
1802
8bc5d1e4
DO
1803// Display hrefs for all of a file's parents. If scissors are requested,
1804// prepend cutting button to each of them.
1805function serializeFileLinks ($links, $scissors = FALSE)
e1ae3fb4 1806{
e1ae3fb4
AD
1807 $comma = '';
1808 $ret = '';
1809 foreach ($links as $link_id => $li)
1810 {
1811 switch ($li['entity_type'])
1812 {
1813 case 'ipv4net':
1814 $params = "page=ipv4net&id=";
1815 break;
1816 case 'ipv4rspool':
1817 $params = "page=ipv4rspool&pool_id=";
1818 break;
1819 case 'ipv4vs':
1820 $params = "page=ipv4vs&vs_id=";
1821 break;
1822 case 'object':
1823 $params = "page=object&object_id=";
1824 break;
1825 case 'rack':
1826 $params = "page=rack&rack_id=";
1827 break;
1828 case 'user':
1829 $params = "page=user&user_id=";
1830 break;
1831 }
8bc5d1e4
DO
1832 $ret .= $comma;
1833 if ($scissors)
1834 {
1835 $ret .= "<a href='" . makeHrefProcess(array('op'=>'unlinkFile', 'link_id'=>$link_id)) . "'";
1836 $ret .= getImageHREF ('cut') . '</a> ';
1837 }
790a60e8 1838 $ret .= sprintf("<a href='index.php?%s%s'>%s</a>", $params, $li['entity_id'], $li['name']);
8bc5d1e4 1839 $comma = '<br>';
e1ae3fb4 1840 }
e1ae3fb4
AD
1841 return $ret;
1842}
1843
1844// Convert filesize to appropriate unit and make it human-readable
1845function formatFileSize ($bytes) {
1846 // bytes
1847 if($bytes < 1024) // bytes
1848 return "${bytes} bytes";
1849
1850 // kilobytes
1851 if ($bytes < 1024000)
1852 return sprintf ("%.1fk", round (($bytes / 1024), 1));
1853
1854 // megabytes
1855 return sprintf ("%.1f MB", round (($bytes / 1024000), 1));
1856}
1857
1858// Reverse of formatFileSize, it converts human-readable value to bytes
1859function convertToBytes ($value) {
1860 $value = trim($value);
1861 $last = strtolower($value[strlen($value)-1]);
1862 switch ($last)
1863 {
1864 case 'g':
1865 $value *= 1024;
1866 case 'm':
1867 $value *= 1024;
1868 case 'k':
1869 $value *= 1024;
1870 }
1871
1872 return $value;
1873}
1874
4fbb5a00
DY
1875function ip_quad2long ($ip)
1876{
1877 return sprintf("%u", ip2long($ip));
1878}
1879
1880function ip_long2quad ($quad)
1881{
1882 return long2ip($quad);
1883}
1884
1885function makeHref($params = array())
1886{
790a60e8 1887 $ret = 'index.php?';
4fbb5a00 1888 $first = true;
4fbb5a00
DY
1889 foreach($params as $key=>$value)
1890 {
1891 if (!$first)
1892 $ret.='&';
1893 $ret .= urlencode($key).'='.urlencode($value);
1894 $first = false;
1895 }
1896 return $ret;
1897}
1898
1899function makeHrefProcess($params = array())
1900{
790a60e8
DO
1901 global $pageno, $tabno;
1902 $ret = 'process.php?';
4fbb5a00 1903 $first = true;
9f14a7ef
DY
1904 if (!isset($params['page']))
1905 $params['page'] = $pageno;
1906 if (!isset($params['tab']))
1907 $params['tab'] = $tabno;
4fbb5a00
DY
1908 foreach($params as $key=>$value)
1909 {
1910 if (!$first)
1911 $ret.='&';
1912 $ret .= urlencode($key).'='.urlencode($value);
1913 $first = false;
1914 }
1915 return $ret;
1916}
1917
39106006 1918function makeHrefForHelper ($helper_name, $params = array())
4fbb5a00 1919{
790a60e8 1920 $ret = 'popup.php?helper=' . $helper_name;
4fbb5a00 1921 foreach($params as $key=>$value)
39106006 1922 $ret .= '&'.urlencode($key).'='.urlencode($value);
4fbb5a00
DY
1923 return $ret;
1924}
1925
f3d274bf
DO
1926// Process the given list of records to build data suitable for printNiftySelect()
1927// (like it was formerly executed by printSelect()). Screen out vendors according
1928// to VENDOR_SIEVE, if object type ID is provided. However, the OPTGROUP with already
1929// selected OPTION is protected from being screened.
1930function cookOptgroups ($recordList, $object_type_id = 0, $existing_value = 0)
1931{
1932 $ret = array();
1933 // Always keep "other" OPTGROUP at the SELECT bottom.
1934 $therest = array();
1935 foreach ($recordList as $dict_key => $dict_value)
1936 if (strpos ($dict_value, '%GSKIP%') !== FALSE)
1937 {
1938 $tmp = explode ('%GSKIP%', $dict_value, 2);
1939 $ret[$tmp[0]][$dict_key] = $tmp[1];
1940 }
1941 elseif (strpos ($dict_value, '%GPASS%') !== FALSE)
1942 {
1943 $tmp = explode ('%GPASS%', $dict_value, 2);
1944 $ret[$tmp[0]][$dict_key] = $tmp[1];
1945 }
1946 else
1947 $therest[$dict_key] = $dict_value;
1948 if ($object_type_id != 0)
1949 {
1950 $screenlist = array();
1951 foreach (explode (';', getConfigVar ('VENDOR_SIEVE')) as $sieve)
1952 if (FALSE !== mb_ereg ("^([^@]+)(@${object_type_id})?\$", trim ($sieve), $regs))
1953 $screenlist[] = $regs[1];
1954 foreach (array_keys ($ret) as $vendor)
1955 if (in_array ($vendor, $screenlist))
1956 {
1957 $ok_to_screen = TRUE;
1958 if ($existing_value)
1959 foreach (array_keys ($ret[$vendor]) as $recordkey)
1960 if ($recordkey == $existing_value)
1961 {
1962 $ok_to_screen = FALSE;
1963 break;
1964 }
1965 if ($ok_to_screen)
1966 unset ($ret[$vendor]);
1967 }
1968 }
1969 $ret['other'] = $therest;
1970 return $ret;
1971}
1972
f8874cdb
DO
1973function dos2unix ($text)
1974{
1975 return str_replace ("\r\n", "\n", $text);
1976}
1977
9dd73255
DO
1978function unix2dos ($text)
1979{
1980 return str_replace ("\n", "\r\n", $text);
1981}
1982
a0527aef 1983function buildPredicateTable ($parsetree)
2c21a10c 1984{
a0527aef
DO
1985 $ret = array();
1986 foreach ($parsetree as $sentence)
72e8baf6 1987 if ($sentence['type'] == 'SYNT_DEFINITION')
a0527aef 1988 $ret[$sentence['term']] = $sentence['definition'];
72e8baf6
DO
1989 // Now we have predicate table filled in with the latest definitions of each
1990 // particular predicate met. This isn't as chik, as on-the-fly predicate
1991 // overloading during allow/deny scan, but quite sufficient for this task.
a0527aef
DO
1992 return $ret;
1993}
1994
1995// Take a list of records and filter against given RackCode expression. Return
1996// the original list intact, if there was no filter requested, but return an
1997// empty list, if there was an error.
573214e0 1998function filterCellList ($list_in, $expression = array())
d08d766d
DO
1999{
2000 if ($expression === NULL)
2001 return array();
2002 if (!count ($expression))
2003 return $list_in;
d08d766d
DO
2004 $list_out = array();
2005 foreach ($list_in as $item_key => $item_value)
573214e0 2006 if (TRUE === judgeCell ($item_value, $expression))
d08d766d
DO
2007 $list_out[$item_key] = $item_value;
2008 return $list_out;
2009}
2010
212c9d8a 2011// Tell, if the given expression is true for the given entity. Take complete record on input.
573214e0 2012function judgeCell ($cell, $expression)
d08d766d
DO
2013{
2014 global $pTable;
2015 return eval_expression
2016 (
2017 $expression,
2018 array_merge
2019 (
573214e0
DO
2020 $cell['etags'],
2021 $cell['itags'],
2022 $cell['atags']
d08d766d
DO
2023 ),
2024 $pTable,
2025 TRUE
2026 );
2027}
2028
7ddbcf59 2029// Tell, if a constraint from config option permits given record.
212c9d8a 2030function considerConfiguredConstraint ($cell, $varname)
c6bc0ac5 2031{
7ddbcf59 2032 if (!strlen (getConfigVar ($varname)))
c6bc0ac5 2033 return TRUE; // no restriction
7ddbcf59
DO
2034 global $parseCache;
2035 if (!isset ($parseCache[$varname]))
2036 // getConfigVar() doesn't re-read the value from DB because of its
2037 // own cache, so there is no race condition here between two calls.
2038 $parseCache[$varname] = spotPayload (getConfigVar ($varname), 'SYNT_EXPR');
2039 if ($parseCache[$varname]['result'] != 'ACK')
2040 return FALSE; // constraint set, but cannot be used due to compilation error
212c9d8a 2041 return judgeCell ($cell, $parseCache[$varname]['load']);
c6bc0ac5
DO
2042}
2043
17112e81
DO
2044// Return list of records in the given realm, which conform to
2045// the given RackCode expression. If the realm is unknown or text
2046// doesn't validate as a RackCode expression, return NULL.
2047// Otherwise (successful scan) return a list of all matched
2048// records, even if the list is empty (array() !== NULL). If the
2049// text is an empty string, return all found records in the given
2050// realm.
2051function scanRealmByText ($realm = NULL, $ftext = '')
2052{
2053 switch ($realm)
2054 {
2055 case 'object':
2056 case 'user':
2057 case 'ipv4net':
2058 case 'file':
39776127 2059 case 'ipv4vs':
41780975 2060 case 'ipv4rspool':
17112e81
DO
2061 if (!strlen ($ftext = trim ($ftext)))
2062 $fexpr = array();
2063 else
2064 {
2065 $fparse = spotPayload ($ftext, 'SYNT_EXPR');
2066 if ($fparse['result'] != 'ACK')
2067 return NULL;
2068 $fexpr = $fparse['load'];
2069 }
2070 return filterCellList (listCells ($realm), $fexpr);
2071 default:
c5f84f48 2072 throw new InvalidArgException ('$realm', $realm);
17112e81
DO
2073 }
2074
2075}
39776127
DO
2076
2077function getIPv4VSOptions ()
2078{
2079 $ret = array();
2080 foreach (listCells ('ipv4vs') as $vsid => $vsinfo)
59a83bd8 2081 $ret[$vsid] = $vsinfo['dname'] . (!strlen ($vsinfo['name']) ? '' : " (${vsinfo['name']})");
39776127
DO
2082 return $ret;
2083}
2084
41780975
DO
2085function getIPv4RSPoolOptions ()
2086{
2087 $ret = array();
2088 foreach (listCells ('ipv4rspool') as $pool_id => $poolInfo)
2089 $ret[$pool_id] = $poolInfo['name'];
2090 return $ret;
2091}
2092
d16af52f
DO
2093// Derive a complete cell structure from the given username regardless
2094// if it is a local account or not.
2095function constructUserCell ($username)
2096{
2097 if (NULL !== ($userid = getUserIDByUsername ($username)))
2098 return spotEntity ('user', $userid);
2099 $ret = array
2100 (
2101 'realm' => 'user',
2102 'user_name' => $username,
2103 'user_realname' => '',
2104 'etags' => array(),
2105 'itags' => array(),
d16af52f 2106 );
5689cefd 2107 $ret['atags'] = generateEntityAutoTags ($ret);
d16af52f
DO
2108 return $ret;
2109}
2110
56a797ef
DO
2111// Let's have this debug helper here to enable debugging of process.php w/o interface.php.
2112function dump ($var)
2113{
2114 echo '<div align=left><pre>';
2115 print_r ($var);
2116 echo '</pre></div>';
2117}
2118
9e51318b
DO
2119function getTagChart ($limit = 0, $realm = 'total', $special_tags = array())
2120{
2121 global $taglist;
2122 // first build top-N chart...
2123 $toplist = array();
2124 foreach ($taglist as $taginfo)
2125 if (isset ($taginfo['refcnt'][$realm]))
2126 $toplist[$taginfo['id']] = $taginfo['refcnt'][$realm];
2127 arsort ($toplist, SORT_NUMERIC);
2128 $ret = array();
2129 $done = 0;
2130 foreach (array_keys ($toplist) as $tag_id)
2131 {
2132 $ret[$tag_id] = $taglist[$tag_id];
2133 if (++$done == $limit)
2134 break;
2135 }
2136 // ...then make sure, that every item of the special list is shown
2137 // (using the same sort order)
2138 $extra = array();
2139 foreach ($special_tags as $taginfo)
2140 if (!array_key_exists ($taginfo['id'], $ret))
2141 $extra[$taginfo['id']] = $taglist[$taginfo['id']]['refcnt'][$realm];
2142 arsort ($extra, SORT_NUMERIC);
2143 foreach (array_keys ($extra) as $tag_id)
2144 $ret[] = $taglist[$tag_id];
2145 return $ret;
2146}
2147
7fa7047a
DO
2148function decodeObjectType ($objtype_id, $style = 'r')
2149{
2150 static $types = array();
2151 if (!count ($types))
2152 $types = array
2153 (
2154 'r' => readChapter (CHAP_OBJTYPE),
2155 'a' => readChapter (CHAP_OBJTYPE, 'a'),
2156 'o' => readChapter (CHAP_OBJTYPE, 'o')
2157 );
2158 return $types[$style][$objtype_id];
2159}
2160
0df8c52b
DO
2161function isolatedPermission ($p, $t, $cell)
2162{
2163 // This function is called from both "file" page and a number of other pages,
2164 // which have already fixed security context and authorized the user for it.
2165 // OTOH, it is necessary here to authorize against the current file, which
2166 // means saving the current context and building a new one.
2167 global
2168 $expl_tags,
2169 $impl_tags,
2170 $target_given_tags,
2171 $auto_tags;
2172 // push current context
2173 $orig_expl_tags = $expl_tags;
2174 $orig_impl_tags = $impl_tags;
2175 $orig_target_given_tags = $target_given_tags;
2176 $orig_auto_tags = $auto_tags;
2177 // retarget
2178 fixContext ($cell);
2179 // remember decision
2180 $ret = permitted ($p, $t);
2181 // pop context
2182 $expl_tags = $orig_expl_tags;
2183 $impl_tags = $orig_impl_tags;
2184 $target_given_tags = $orig_target_given_tags;
2185 $auto_tags = $orig_auto_tags;
2186 return $ret;
2187}
2188
3153a326
DO
2189function getPortListPrefs()
2190{
2191 $ret = array();
2192 if (0 >= ($ret['iif_pick'] = getConfigVar ('DEFAULT_PORT_IIF_ID')))
2193 $ret['iif_pick'] = 1;
2194 $ret['oif_picks'] = array();
2195 foreach (explode (';', getConfigVar ('DEFAULT_PORT_OIF_IDS')) as $tmp)
2196 {
2197 $tmp = explode ('=', trim ($tmp));
2198 if (count ($tmp) == 2 and $tmp[0] > 0 and $tmp[1] > 0)
2199 $ret['oif_picks'][$tmp[0]] = $tmp[1];
2200 }
2201 // enforce default value
2202 if (!array_key_exists (1, $ret['oif_picks']))
2203 $ret['oif_picks'][1] = 24;
2204 $ret['selected'] = $ret['iif_pick'] . '-' . $ret['oif_picks'][$ret['iif_pick']];
2205 return $ret;
2206}
2207
2dfa1b73
DO
2208// Return data for printNiftySelect() with port type options. All OIF options
2209// for the default IIF will be shown, but only the default OIFs will be present
2210// for each other IIFs. IIFs, for which there is no default OIF, will not
2211// be listed.
2212// This SELECT will be used for the "add new port" form.
2213function getNewPortTypeOptions()
2214{
2215 $ret = array();
2216 $prefs = getPortListPrefs();
2217 foreach (getPortInterfaceCompat() as $row)
2218 {
2219 if ($row['iif_id'] == $prefs['iif_pick'])
2220 $optgroup = $row['iif_name'];
2221 elseif (array_key_exists ($row['iif_id'], $prefs['oif_picks']) and $prefs['oif_picks'][$row['iif_id']] == $row['oif_id'])
2222 $optgroup = 'other';
2223 else
2224 continue;
2225 if (!array_key_exists ($optgroup, $ret))
2226 $ret[$optgroup] = array();
2227 $ret[$optgroup][$row['iif_id'] . '-' . $row['oif_id']] = $row['oif_name'];
2228 }
2229 return $ret;
2230}
2231
8198f2c6
DO
2232function getVLANDomain ($vdid)
2233{
2234 $ret = getVLANDomainInfo ($vdid);
2235 $ret['vlanlist'] = array();
8198f2c6
DO
2236 foreach (getDomainVLANs ($vdid) as $vlan_id => $vlan_descr)
2237 $ret['vlanlist'][$vlan_id] = $vlan_descr;
2238 $ret['switchlist'] = getVLANDomainSwitches ($vdid);
2239 return $ret;
2240}
2241
2242// Return a serialized version of VLAN configuration for a port.
2243// If a native VLAN is defined, print it first. All other VLANs
d0dadd80
DO
2244// are tagged and are listed after a plus sign. When no configuration
2245// is set for a port, return "default" string.
2246function serializeVLANPack ($native_vid = 0, $allowed_vids = array())
8198f2c6
DO
2247{
2248 $tagged = array();
2249 foreach ($allowed_vids as $vlan_id)
2250 if ($vlan_id != $native_vid)
2251 $tagged[] = $vlan_id;
2252 sort ($tagged);
d0dadd80 2253 $ret = $native_vid ? $native_vid : '';
e9be55de
DO
2254 $tagged_bits = array();
2255 $id_from = $id_to = 0;
2256 foreach ($tagged as $next_id)
2257 {
2258 if ($id_to)
2259 {
2260 if ($next_id == $id_to + 1) // merge
2261 {
2262 $id_to = $next_id;
2263 continue;
2264 }
2265 // flush
2266 $tagged_bits[] = $id_from == $id_to ? $id_from : "${id_from}-${id_to}";
2267 }
2268 $id_from = $id_to = $next_id; // start next pair
2269 }
2270 // pull last pair
2271 if ($id_to)
2272 $tagged_bits[] = $id_from == $id_to ? $id_from : "${id_from}-${id_to}";
8198f2c6 2273 if (count ($tagged))
e9be55de 2274 $ret .= '+' . implode (',', $tagged_bits);
d0dadd80 2275 return strlen ($ret) ? $ret : 'default';
8198f2c6
DO
2276}
2277
8846b060
DO
2278// Decode VLAN compound key (which is a string formatted DOMAINID-VLANID) and
2279// return the numbers as an array of two.
2280function decodeVLANCK ($string)
2281{
2282 $matches = array();
2283 if (1 != preg_match ('/^([[:digit:]]+)-([[:digit:]]+)$/', $string, $matches))
2284 throw new InvalidArgException ('VLAN compound key', $string);
2285 return array ($matches[1], $matches[2]);
2286}
2287
ce85f5c8
DO
2288// Return VLAN name formatted for HTML output (note, that input
2289// argument comes from database unescaped).
2290function formatVLANName ($vlaninfo)
2291{
5847d944 2292 $ret = '<tt>VLAN' . $vlaninfo['vlan_id'] . '</tt>';
ce85f5c8 2293 if (strlen ($vlaninfo['vlan_descr']))
5847d944 2294 $ret .= ' <i>(' . niftyString ($vlaninfo['vlan_descr']) . ')</i>';
ce85f5c8
DO
2295 return $ret;
2296}
2297
f10dd5cc
DO
2298// Read given running-config and return a list of work items in a format
2299// similar to the one, which setSwitchVLANConfig() understands.
ef6653b1 2300function ios12ReadVLANConfig ($input)
f10dd5cc 2301{
ef6653b1
DO
2302 $ret = array
2303 (
2304 'vlanlist' => array(),
2305 'portdata' => array(),
2306 );
2307 $procfunc = 'ios12ScanTopLevel';
f10dd5cc
DO
2308 foreach (explode ("\n", $input) as $line)
2309 $procfunc = $procfunc ($ret, $line);
2310 return $ret;
2311}
2312
ef6653b1 2313function ios12ScanTopLevel (&$work, $line)
f10dd5cc
DO
2314{
2315 $matches = array();
ef6653b1
DO
2316 switch (TRUE)
2317 {
2318 case (preg_match ('@^interface ((Ethernet|FastEthernet|GigabitEthernet|TenGigabitEthernet)[[:digit:]]+(/[[:digit:]]+)*)$@', $line, $matches)):
2319 // map interface name
2320 $matches[1] = preg_replace ('@^Ethernet(.+)$@', 'et\\1', $matches[1]);
2321 $matches[1] = preg_replace ('@^FastEthernet(.+)$@', 'fa\\1', $matches[1]);
2322 $matches[1] = preg_replace ('@^GigabitEthernet(.+)$@', 'gi\\1', $matches[1]);
2323 $matches[1] = preg_replace ('@^TenGigabitEthernet(.+)$@', 'te\\1', $matches[1]);
2324 $work['current'] = array ('port_name' => $matches[1]);
2325 return 'ios12PickSwitchportCommand'; // switch to interface block reading
2326 case (preg_match ('/^VLAN Name Status Ports$/', $line, $matches)):
2327 return 'ios12PickVLANCommand';
2328 default:
f10dd5cc 2329 return __FUNCTION__; // continue scan
ef6653b1 2330 }
f10dd5cc
DO
2331}
2332
ef6653b1 2333function ios12PickSwitchportCommand (&$work, $line)
f10dd5cc
DO
2334{
2335 if ($line[0] != ' ') // end of interface section
2336 {
2337 $boiled = array ('port_name' => $work['current']['port_name']);
2338 // fill in defaults
2339 if (!array_key_exists ('mode', $work['current']))
2340 $work['current']['mode'] = 'access';
2341 if (!array_key_exists ('access vlan', $work['current']))
2342 $work['current']['access vlan'] = 1;
2343 if (!array_key_exists ('trunk native vlan', $work['current']))
2344 $work['current']['trunk native vlan'] = 1;
2345 if (!array_key_exists ('trunk allowed vlan', $work['current']))
2346 $work['current']['trunk allowed vlan'] = range (VLAN_MIN_ID, VLAN_MAX_ID);
2347 // save work, if it makes sense
2348 switch ($work['current']['mode'])
2349 {
2350 case 'access':
ac210c9e 2351 $work['portdata'][$work['current']['port_name']] = array
f10dd5cc 2352 (
f10dd5cc
DO
2353 'allowed' => array ($work['current']['access vlan']),
2354 'native' => $work['current']['access vlan'],
2355 );
2356 break;
2357 case 'trunk':
48c286aa
DO
2358 // Having configured VLAN as "native" doesn't mean anything
2359 // as long as it's not listed on the "allowed" line.
2360 $effective_native = in_array
2361 (
2362 $work['current']['trunk native vlan'],
2363 $work['current']['trunk allowed vlan']
2364 ) ? $work['current']['trunk native vlan'] : 0;
ac210c9e 2365 $work['portdata'][$work['current']['port_name']] = array
f10dd5cc 2366 (
e9be55de 2367 'allowed' => $work['current']['trunk allowed vlan'],
48c286aa 2368 'native' => $effective_native,
f10dd5cc
DO
2369 );
2370 break;
2371 default:
2372 // dot1q-tunnel, dynamic, private-vlan --- skip these
2373 }
2374 unset ($work['current']);
ef6653b1 2375 return 'ios12ScanTopLevel';
f10dd5cc
DO
2376 }
2377 // not yet
2378 $matches = array();
2379 switch (TRUE)
2380 {
2381 case (preg_match ('@^ switchport mode (.+)$@', $line, $matches)):
2382 $work['current']['mode'] = $matches[1];
2383 break;
2384 case (preg_match ('@^ switchport access vlan (.+)$@', $line, $matches)):
2385 $work['current']['access vlan'] = $matches[1];
2386 break;
2387 case (preg_match ('@^ switchport trunk native vlan (.+)$@', $line, $matches)):
2388 $work['current']['trunk native vlan'] = $matches[1];
2389 break;
2390 case (preg_match ('@^ switchport trunk allowed vlan add (.+)$@', $line, $matches)):
2391 $work['current']['trunk allowed vlan'] = array_merge
2392 (
2393 $work['current']['trunk allowed vlan'],
2394 iosParseVLANString ($matches[1])
2395 );
2396 break;
2397 case (preg_match ('@^ switchport trunk allowed vlan (.+)$@', $line, $matches)):
2398 $work['current']['trunk allowed vlan'] = iosParseVLANString ($matches[1]);
2399 break;
2400 default: // suppress warning on irrelevant config clause
2401 }
2402 return __FUNCTION__;
2403}
2404
ef6653b1
DO
2405function ios12PickVLANCommand (&$work, $line)
2406{
2407 $matches = array();
2408 switch (TRUE)
2409 {
2410 case ($line == '---- -------------------------------- --------- -------------------------------'):
2411 // ignore the rest of VLAN table header;
2412 break;
2413 case (preg_match ('@! END OF VLAN LIST$@', $line)):
2414 return 'ios12ScanTopLevel';
2415 case (preg_match ('@^([[:digit:]]+) {1,4}.{32} active @', $line, $matches)):
2416 if (!array_key_exists ($matches[1], $work['vlanlist']))
2417 $work['vlanlist'][] = $matches[1];
2418 break;
2419 default:
2420 }
2421 return __FUNCTION__;
2422}
2423
f10dd5cc
DO
2424function iosParseVLANString ($string)
2425{
2426 $ret = array();
2427 foreach (explode (',', $string) as $item)
2428 {
2429 $matches = array();
2430 if (preg_match ('/^([[:digit:]]+)$/', $item, $matches))
2431 $ret[] = $matches[1];
2432 elseif (preg_match ('/^([[:digit:]]+)-([[:digit:]]+)$/', $item, $matches))
2433 $ret = array_merge ($ret, range ($matches[1], $matches[2]));
2434 }
2435 return $ret;
2436}
2437
dbc00990
DO
2438// Another finite automata to read a dialect of Foundry configuration.
2439function fdry5ReadVLANConfig ($input)
2440{
ef6653b1
DO
2441 $ret = array
2442 (
2443 'vlanlist' => array(),
2444 'portdata' => array(),
2445 );
dbc00990
DO
2446 $procfunc = 'fdry5ScanTopLevel';
2447 foreach (explode ("\n", $input) as $line)
2448 $procfunc = $procfunc ($ret, $line);
2449 return $ret;
2450}
2451
2452function fdry5ScanTopLevel (&$work, $line)
2453{
2454 $matches = array();
2455 switch (TRUE)
2456 {
2457 case (preg_match ('@^vlan ([[:digit:]]+)( name .+)? (by port)$@', $line, $matches)):
ef6653b1
DO
2458 if (!array_key_exists ($matches[1], $work['vlanlist']))
2459 $work['vlanlist'][] = $matches[1];
dbc00990
DO
2460 $work['current'] = array ('vlan_id' => $matches[1]);
2461 return 'fdry5PickVLANSubcommand';
2462 case (preg_match ('@^interface ethernet ([[:digit:]]+/[[:digit:]]+/[[:digit:]]+)$@', $line, $matches)):
2463 $work['current'] = array ('port_name' => 'e' . $matches[1]);
2464 return 'fdry5PickInterfaceSubcommand';
2465 default:
2466 return __FUNCTION__;
2467 }
2468}
2469
2470function fdry5PickVLANSubcommand (&$work, $line)
2471{
2472 if ($line[0] != ' ') // end of VLAN section
2473 {
2474 unset ($work['current']);
2475 return 'fdry5ScanTopLevel';
2476 }
2477 // not yet
2478 $matches = array();
2479 switch (TRUE)
2480 {
2481 case (preg_match ('@^ tagged (.+)$@', $line, $matches)):
2482 // add current VLAN to 'allowed' list of each mentioned port
2483 foreach (fdry5ParsePortString ($matches[1]) as $port_name)
ac210c9e
DO
2484 if (array_key_exists ($port_name, $work['portdata']))
2485 $work['portdata'][$port_name]['allowed'][] = $work['current']['vlan_id'];
dbc00990 2486 else
ac210c9e 2487 $work['portdata'][$port_name] = array
dbc00990 2488 (
dbc00990
DO
2489 'allowed' => array ($work['current']['vlan_id']),
2490 'native' => 0, // can be updated later
2491 );
2492 break;
2493 case (preg_match ('@^ untagged (.+)$@', $line, $matches)):
2494 // replace 'native' column of each mentioned port with current VLAN ID
2495 foreach (fdry5ParsePortString ($matches[1]) as $port_name)
ac210c9e 2496 if (array_key_exists ($port_name, $work['portdata']))
dbc00990 2497 {
ac210c9e
DO
2498 $work['portdata'][$port_name]['native'] = $work['current']['vlan_id'];
2499 $work['portdata'][$port_name]['allowed'][] = $work['current']['vlan_id'];
dbc00990
DO
2500 }
2501 else
ac210c9e 2502 $work['portdata'][$port_name] = array
dbc00990 2503 (
dbc00990
DO
2504 'allowed' => array ($work['current']['vlan_id']),
2505 'native' => $work['current']['vlan_id'],
2506 );
2507 break;
2508 default: // nom-nom
2509 }
2510 return __FUNCTION__;
2511}
2512
2513function fdry5PickInterfaceSubcommand (&$work, $line)
2514{
2515 if ($line[0] != ' ') // end of interface section
2516 {
2517 if (array_key_exists ('dual-mode', $work['current']))
2518 {
ac210c9e 2519 if (array_key_exists ($work['current']['port_name'], $work['portdata']))
dbc00990 2520 // update existing record
ac210c9e 2521 $work['portdata'][$work['current']['port_name']]['native'] = $work['current']['dual-mode'];
dbc00990
DO
2522 else
2523 // add new
ac210c9e 2524 $work['portdata'][$work['current']['port_name']] = array
dbc00990 2525 (
dbc00990
DO
2526 'allowed' => array ($work['current']['dual-mode']),
2527 'native' => $work['current']['dual-mode'],
2528 );
2529 }
2530 unset ($work['current']);
2531 return 'fdry5ScanTopLevel';
2532 }
2533 $matches = array();
2534 switch (TRUE)
2535 {
2536 case (preg_match ('@^ dual-mode( +[[:digit:]]+ *)?$@', $line, $matches)):
2537 // default VLAN ID for dual-mode command is 1
2538 $work['current']['dual-mode'] = strlen (trim ($matches[1])) ? trim ($matches[1]) : 1;
2539 break;
2540 default: // nom-nom
2541 }
2542 return __FUNCTION__;
2543}
2544
2545function fdry5ParsePortString ($string)
2546{
2547 $ret = array();
2548 $tokens = explode (' ', trim ($string));
2549 while (count ($tokens))
2550 {
2551 $letters = array_shift ($tokens); // "ethe", "to"
2552 $numbers = array_shift ($tokens); // "x", "x/x", "x/x/x"
2553 switch ($letters)
2554 {
2555 case 'ethe':
2556 if ($prev_numbers != NULL)
2557 $ret[] = 'e' . $prev_numbers;
2558 $prev_numbers = $numbers;
2559 break;
2560 case 'to':
2561 $ret = array_merge ($ret, fdry5GenPortRange ($prev_numbers, $numbers));
2562 $prev_numbers = NULL; // no action on next token
2563 break;
2564 default: // ???
2565 return array();
2566 }
2567 }
2568 // flush delayed item
2569 if ($prev_numbers != NULL)
2570 $ret[] = 'e' . $prev_numbers;
2571 return $ret;
2572}
2573
2574// Take two indices in form "x", "x/x" or "x/x/x" and return the range of
2575// ports spanning from the first to the last. The switch software makes it
2576// easier to perform, because "ethe x/x/x to y/y/y" ranges never cross
2577// unit/slot boundary (every index except the last remains constant).
2578function fdry5GenPortRange ($from, $to)
2579{
2580 $matches = array();
2581 if (1 !== preg_match ('@^([[:digit:]]+/)?([[:digit:]]+/)?([[:digit:]]+)$@', $from, $matches))
2582 return array();
2583 $prefix = 'e' . $matches[1] . $matches[2];
2584 $from_idx = $matches[3];
2585 if (1 !== preg_match ('@^([[:digit:]]+/)?([[:digit:]]+/)?([[:digit:]]+)$@', $to, $matches))
2586 return array();
2587 $to_idx = $matches[3];
2588 for ($i = $from_idx; $i <= $to_idx; $i++)
2589 $ret[] = $prefix . $i;
2590 return $ret;
2591}
2592
2593// Scan given work accumulator array and return the key, which
2594// addresses the port with requested name (or NULL if there is none such).
19350222
DO
2595// Note that 0 and NULL mean completely different things and thus
2596// require strict checking (=== and !===).
dbc00990
DO
2597function scanArrayForItem ($table, $scan_column, $scan_value)
2598{
2599 foreach ($table as $key => $row)
2600 if ($row[$scan_column] == $scan_value)
2601 return $key;
2602 return NULL;
2603}
2604
5456f90f
DO
2605function computeSwitchPushRequest ($object_id, $which_ports)
2606{
2607 $vswitch = getVLANSwitchInfo ($object_id);
2608 $vdomain = getVLANDomain ($vswitch['domain_id']);
2609 $device_config = getDevice8021QConfig ($object_id);
ac210c9e 2610 // only ignore VLANs, which exist and are explicitly shown as "alien"
5456f90f
DO
2611 $old_managed_vlans = array();
2612 foreach ($device_config['vlanlist'] as $vlan_id)
ac210c9e
DO
2613 if
2614 (
2615 !array_key_exists ($vlan_id, $vdomain['vlanlist']) or
2616 $vdomain['vlanlist'][$vlan_id]['vlan_type'] != 'alien'
2617 )
5456f90f 2618 $old_managed_vlans[] = $vlan_id;
de47b574 2619 $db_config = getDesired8021QConfig ($object_id);
5456f90f 2620 $ports_to_do = array();
a18c2042 2621 foreach ($which_ports as $port_name)
f56f0f20
DO
2622 if (array_key_exists ($port_name, $db_config))
2623 $ports_to_do[$port_name] = array
2624 (
ac210c9e
DO
2625 'old_allowed' => array_key_exists ($port_name, $device_config['portdata']) ?
2626 $device_config['portdata'][$port_name]['allowed'] :
f56f0f20 2627 array(),
ac210c9e
DO
2628 'old_native' => array_key_exists ($port_name, $device_config['portdata']) ?
2629 $device_config['portdata'][$port_name]['native'] :
f56f0f20
DO
2630 0,
2631 'new_allowed' => $db_config[$port_name]['allowed'],
2632 'new_native' => $db_config[$port_name]['native'],
2633 );
ac210c9e
DO
2634 // New VLAN table is a union of:
2635 // 1. all compulsory VLANs
2636 // 2. all "current" allowed VLANs of those ports, which are left
2637 // intact (including VLANs, which don't exist in current domain)
2638 // 3. all "new" allowed VLANs of those ports, which we do "push" now
2639 // Like for old_managed_vlans, a VLANs is never listed, only if it
2640 // exists and belongs to "alien" type.
5456f90f
DO
2641 $new_managed_vlans = array();
2642 foreach ($vdomain['vlanlist'] as $vlan_id => $vlan)
a18c2042 2643 if ($vlan['vlan_type'] == 'compulsory')
5456f90f 2644 $new_managed_vlans[] = $vlan_id;
ac210c9e
DO
2645 foreach ($device_config['portdata'] as $port_name => $port)
2646 if (!in_array ($port_name, $ports_to_do))
2647 foreach ($port['allowed'] as $vlan_id)
2648 if
2649 (
2650 (!array_key_exists ($vlan_id, $vdomain['vlanlist']) or
2651 $vdomain['vlanlist'][$vlan_id]['vlan_type'] != 'alien') and
2652 !in_array ($vlan_id, $new_managed_vlans)
2653 )
2654 $new_managed_vlans[] = $vlan_id;
2655 foreach ($ports_to_do as $port)
2656 foreach ($port['new_allowed'] as $vlan_id)
f56f0f20
DO
2657 if
2658 (
2659 $vdomain['vlanlist'][$vlan_id]['vlan_type'] == 'ondemand' and
2660 !in_array ($vlan_id, $new_managed_vlans)
2661 )
5456f90f 2662 $new_managed_vlans[] = $vlan_id;
a18c2042 2663 $ret = array();
a18c2042
DO
2664 // Before removing old VLANs as such it is necessary to unassign
2665 // ports from them (to remove VLANs from ports' list of "allowed"
2666 // VLANs. This change in turn requires, that "native" VLAN isn't
2667 // set to the one being removed.
f56f0f20 2668 foreach ($ports_to_do as $port_name => $port)
a18c2042 2669 {
f56f0f20
DO
2670 // "old" native is set and differs from the "new" native
2671 if ($port['old_native'] and $port['old_native'] != $port['new_native'])
a18c2042
DO
2672 $ret[] = array
2673 (
2674 'opcode' => 'unset native',
f56f0f20
DO
2675 'arg1' => $port_name,
2676 'arg2' => $port['old_native'],
a18c2042 2677 );
f56f0f20 2678 foreach (array_diff ($port['old_allowed'], $port['new_allowed']) as $vlan_id)
a18c2042
DO
2679 $ret[] = array
2680 (
2681 'opcode' => 'rem allowed',
f56f0f20
DO
2682 'arg1' => $port_name,
2683 'arg2' => $vlan_id,
a18c2042
DO
2684 );
2685 }
f56f0f20
DO
2686 // Now it is safe to unconfigure VLANs, which still exist on device,
2687 // but are not present on the "new" list.
a18c2042
DO
2688 foreach (array_diff ($old_managed_vlans, $new_managed_vlans) as $vlan_id)
2689 $ret[] = array
2690 (
f56f0f20
DO
2691 'opcode' => 'destroy VLAN',
2692 'arg1' => $vlan_id,
a18c2042 2693 );
f56f0f20 2694 // Configure VLANs, which must be present on the device, but are not yet.
a18c2042
DO
2695 foreach (array_diff ($new_managed_vlans, $old_managed_vlans) as $vlan_id)
2696 $ret[] = array
2697 (
f56f0f20
DO
2698 'opcode' => 'create VLAN',
2699 'arg1' => $vlan_id,
a18c2042
DO
2700 );
2701 // Now, when all new VLANs are created (queued), it is safe to assign (queue)
2702 // ports to the new VLANs.
f56f0f20 2703 foreach ($ports_to_do as $port_name => $port)
a18c2042
DO
2704 {
2705 // For each allowed VLAN, which is present on the "new" list and missing from
2706 // the "old" one, queue a command to assign current port to that VLAN.
f56f0f20 2707 foreach (array_diff ($port['new_allowed'], $port['old_allowed']) as $vlan_id)
a18c2042
DO
2708 $ret[] = array
2709 (
2710 'opcode' => 'add allowed',
f56f0f20
DO
2711 'arg1' => $port_name,
2712 'arg2' => $vlan_id,
a18c2042
DO
2713 );
2714 // One of the "allowed" VLANs for this port may probably be "native".
f56f0f20
DO
2715 // "new native" is set and differs from "old native"
2716 if ($port['new_native'] and $port['new_native'] != $port['old_native'])
a18c2042
DO
2717 $ret[] = array
2718 (
2719 'opcode' => 'set native',
f56f0f20
DO
2720 'arg1' => $port_name,
2721 'arg2' => $port['new_native'],
a18c2042
DO
2722 );
2723
2724 }
f56f0f20
DO
2725 return $ret;
2726}
2727
2728// Get a list of VLAN management pseudo-commands and return a text
2729// of real vendor-specific commands, which implement the work.
2730function ios12TranslatePushQueue ($queue)
2731{
2732 $ret = "conf t\n";
2733 foreach ($queue as $cmd)
2734 switch ($cmd['opcode'])
2735 {
2736 case 'create VLAN':
2737 $ret .= "vlan ${cmd['arg1']}\nexit\n";
2738 break;
2739 case 'destroy VLAN':
2740 $ret .= "no vlan ${cmd['arg1']}\n";
2741 break;
2742 case 'add allowed':
2743 $ret .= "interface ${cmd['arg1']}\nswitchport trunk allowed vlan add ${cmd['arg2']}\nexit\n";
2744 break;
2745 case 'rem allowed':
2746 $ret .= "interface ${cmd['arg1']}\nswitchport trunk allowed vlan remove ${cmd['arg2']}\nexit\n";
2747 break;
2748 case 'set native':
2749 $ret .= "interface ${cmd['arg1']}\nswitchport trunk native vlan ${cmd['arg2']}\nexit\n";
2750 break;
2751 case 'unset native':
2752 $ret .= "interface ${cmd['arg1']}\nno switchport trunk native vlan ${cmd['arg2']}\nexit\n";
2753 break;
2754 }
2755 $ret .= "end\n";
2756 return $ret;
2757}
2758
2759function fdry5TranslatePushQueue ($queue)
2760{
2761 $ret = "conf t\n";
2762 foreach ($queue as $cmd)
2763 switch ($cmd['opcode'])
2764 {
2765 case 'create VLAN':
2766 $ret .= "vlan ${cmd['arg1']}\nexit\n";
2767 break;
2768 case 'destroy VLAN':
2769 $ret .= "no vlan ${cmd['arg1']}\n";
2770 break;
2771 case 'add allowed':
2772 $ret .= "vlan ${cmd['arg2']}\ntagged ${cmd['arg1']}\nexit\n";
2773 break;
2774 case 'rem allowed':
2775 $ret .= "vlan ${cmd['arg2']}\nno tagged ${cmd['arg1']}\nexit\n";
2776 break;
2777 case 'set native':
2778 $ret .= "interface ${cmd['arg1']}\ndual-mode ${cmd['arg2']}\nexit\n";
2779 break;
2780 case 'unset native':
2781 $ret .= "interface ${cmd['arg1']}\nno dual-mode ${cmd['arg2']}\nexit\n";
2782 break;
2783 }
2784 $ret .= "end\n";
a18c2042 2785 return $ret;
5456f90f
DO
2786}
2787
e673ee24 2788?>