r3554 moved CSS.
[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
e0d188ef
DO
162function assertPCREArg ($argname)
163{
164 assertStringArg ($argname, TRUE); // empty pattern is Ok
664ec705 165 if (FALSE === preg_match ($_REQUEST[$argname], 'test'))
e0d188ef
DO
166 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'PCRE validation failed');
167}
168
e673ee24
DO
169// Objects of some types should be explicitly shown as
170// anonymous (labelless). This function is a single place where the
171// decision about displayed name is made.
cfa8f3cf 172function setDisplayedName (&$cell)
e673ee24 173{
cfa8f3cf
DO
174 if ($cell['name'] != '')
175 $cell['dname'] = $cell['name'];
e673ee24 176 else
212c9d8a 177 {
cfa8f3cf
DO
178 $cell['atags'][] = array ('tag' => '$nameless');
179 if (considerConfiguredConstraint ($cell, 'NAMEWARN_LISTSRC'))
7fa7047a 180 $cell['dname'] = 'ANONYMOUS ' . decodeObjectType ($cell['objtype_id'], 'o');
212c9d8a 181 else
7fa7047a 182 $cell['dname'] = '[' . decodeObjectType ($cell['objtype_id'], 'o') . ']';
212c9d8a 183 }
e673ee24
DO
184}
185
186// This function finds height of solid rectangle of atoms, which are all
187// assigned to the same object. Rectangle base is defined by specified
188// template.
189function rectHeight ($rackData, $startRow, $template_idx)
190{
191 $height = 0;
192 // The first met object_id is used to match all the folowing IDs.
193 $object_id = 0;
194 global $template;
195 do
196 {
197 for ($locidx = 0; $locidx < 3; $locidx++)
198 {
199 // At least one value in template is TRUE, but the following block
200 // can meet 'skipped' atoms. Let's ensure we have something after processing
201 // the first row.
202 if ($template[$template_idx][$locidx])
203 {
204 if (isset ($rackData[$startRow - $height][$locidx]['skipped']))
205 break 2;
93e02204
DO
206 if (isset ($rackData[$startRow - $height][$locidx]['rowspan']))
207 break 2;
208 if (isset ($rackData[$startRow - $height][$locidx]['colspan']))
209 break 2;
e673ee24
DO
210 if ($rackData[$startRow - $height][$locidx]['state'] != 'T')
211 break 2;
212 if ($object_id == 0)
213 $object_id = $rackData[$startRow - $height][$locidx]['object_id'];
214 if ($object_id != $rackData[$startRow - $height][$locidx]['object_id'])
215 break 2;
216 }
217 }
218 // If the first row can't offer anything, bail out.
219 if ($height == 0 and $object_id == 0)
220 break;
221 $height++;
222 }
223 while ($startRow - $height > 0);
93e02204
DO
224# echo "for startRow==${startRow} and template==(" . ($template[$template_idx][0] ? 'T' : 'F');
225# echo ', ' . ($template[$template_idx][1] ? 'T' : 'F') . ', ' . ($template[$template_idx][2] ? 'T' : 'F');
226# echo ") height==${height}<br>\n";
e673ee24
DO
227 return $height;
228}
229
230// This function marks atoms to be avoided by rectHeight() and assigns rowspan/colspan
231// attributes.
232function markSpan (&$rackData, $startRow, $maxheight, $template_idx)
233{
234 global $template, $templateWidth;
235 $colspan = 0;
236 for ($height = 0; $height < $maxheight; $height++)
237 {
238 for ($locidx = 0; $locidx < 3; $locidx++)
239 {
240 if ($template[$template_idx][$locidx])
241 {
242 // Add colspan/rowspan to the first row met and mark the following ones to skip.
93e02204
DO
243 // Explicitly show even single-cell spanned atoms, because rectHeight()
244 // is expeciting this data for correct calculation.
e673ee24
DO
245 if ($colspan != 0)
246 $rackData[$startRow - $height][$locidx]['skipped'] = TRUE;
247 else
248 {
249 $colspan = $templateWidth[$template_idx];
93e02204 250 if ($colspan >= 1)
e673ee24 251 $rackData[$startRow - $height][$locidx]['colspan'] = $colspan;
93e02204 252 if ($maxheight >= 1)
e673ee24
DO
253 $rackData[$startRow - $height][$locidx]['rowspan'] = $maxheight;
254 }
255 }
256 }
257 }
258 return;
259}
260
93e02204
DO
261// This function sets rowspan/solspan/skipped atom attributes for renderRack()
262// What we actually have to do is to find _all_ possible rectangles for each unit
263// and then select the widest of those with the maximal square.
e673ee24
DO
264function markAllSpans (&$rackData = NULL)
265{
266 if ($rackData == NULL)
267 {
0cc24e9a 268 showWarning ('Invalid rackData', __FUNCTION__);
e673ee24
DO
269 return;
270 }
271 for ($i = $rackData['height']; $i > 0; $i--)
93e02204
DO
272 while (markBestSpan ($rackData, $i));
273}
274
275// Calculate height of 6 possible span templates (array is presorted by width
276// descending) and mark the best (if any).
277function markBestSpan (&$rackData, $i)
278{
279 global $template, $templateWidth;
280 for ($j = 0; $j < 6; $j++)
e673ee24 281 {
93e02204
DO
282 $height[$j] = rectHeight ($rackData, $i, $j);
283 $square[$j] = $height[$j] * $templateWidth[$j];
284 }
285 // find the widest rectangle of those with maximal height
286 $maxsquare = max ($square);
287 if (!$maxsquare)
288 return FALSE;
289 $best_template_index = 0;
290 for ($j = 0; $j < 6; $j++)
291 if ($square[$j] == $maxsquare)
e673ee24 292 {
93e02204
DO
293 $best_template_index = $j;
294 $bestheight = $height[$j];
295 break;
e673ee24 296 }
93e02204
DO
297 // distribute span marks
298 markSpan ($rackData, $i, $bestheight, $best_template_index);
299 return TRUE;
e673ee24
DO
300}
301
e673ee24
DO
302// We can mount 'F' atoms and unmount our own 'T' atoms.
303function applyObjectMountMask (&$rackData, $object_id)
304{
305 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
306 for ($locidx = 0; $locidx < 3; $locidx++)
307 switch ($rackData[$unit_no][$locidx]['state'])
308 {
309 case 'F':
310 $rackData[$unit_no][$locidx]['enabled'] = TRUE;
311 break;
312 case 'T':
313 $rackData[$unit_no][$locidx]['enabled'] = ($rackData[$unit_no][$locidx]['object_id'] == $object_id);
314 break;
315 default:
316 $rackData[$unit_no][$locidx]['enabled'] = FALSE;
317 }
318}
319
320// Design change means transition between 'F' and 'A' and back.
321function applyRackDesignMask (&$rackData)
322{
323 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
324 for ($locidx = 0; $locidx < 3; $locidx++)
325 switch ($rackData[$unit_no][$locidx]['state'])
326 {
327 case 'F':
328 case 'A':
329 $rackData[$unit_no][$locidx]['enabled'] = TRUE;
330 break;
331 default:
332 $rackData[$unit_no][$locidx]['enabled'] = FALSE;
333 }
334}
335
336// The same for 'F' and 'U'.
337function applyRackProblemMask (&$rackData)
338{
339 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
340 for ($locidx = 0; $locidx < 3; $locidx++)
341 switch ($rackData[$unit_no][$locidx]['state'])
342 {
343 case 'F':
344 case 'U':
345 $rackData[$unit_no][$locidx]['enabled'] = TRUE;
346 break;
347 default:
348 $rackData[$unit_no][$locidx]['enabled'] = FALSE;
349 }
350}
351
e673ee24
DO
352// This function highlights specified object (and removes previous highlight).
353function highlightObject (&$rackData, $object_id)
354{
355 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
356 for ($locidx = 0; $locidx < 3; $locidx++)
357 if
358 (
359 $rackData[$unit_no][$locidx]['state'] == 'T' and
360 $rackData[$unit_no][$locidx]['object_id'] == $object_id
361 )
362 $rackData[$unit_no][$locidx]['hl'] = 'h';
363 else
364 unset ($rackData[$unit_no][$locidx]['hl']);
365}
366
367// This function marks atoms to selected or not depending on their current state.
368function markupAtomGrid (&$data, $checked_state)
369{
370 for ($unit_no = $data['height']; $unit_no > 0; $unit_no--)
371 for ($locidx = 0; $locidx < 3; $locidx++)
372 {
373 if (!($data[$unit_no][$locidx]['enabled'] === TRUE))
374 continue;
375 if ($data[$unit_no][$locidx]['state'] == $checked_state)
376 $data[$unit_no][$locidx]['checked'] = ' checked';
377 else
378 $data[$unit_no][$locidx]['checked'] = '';
379 }
380}
381
382// This function is almost a clone of processGridForm(), but doesn't save anything to database
383// Return value is the changed rack data.
384// Here we assume that correct filter has already been applied, so we just
385// set or unset checkbox inputs w/o changing atom state.
386function mergeGridFormToRack (&$rackData)
387{
388 $rack_id = $rackData['id'];
389 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
390 for ($locidx = 0; $locidx < 3; $locidx++)
391 {
392 if ($rackData[$unit_no][$locidx]['enabled'] != TRUE)
393 continue;
394 $inputname = "atom_${rack_id}_${unit_no}_${locidx}";
395 if (isset ($_REQUEST[$inputname]) and $_REQUEST[$inputname] == 'on')
396 $rackData[$unit_no][$locidx]['checked'] = ' checked';
397 else
398 $rackData[$unit_no][$locidx]['checked'] = '';
399 }
400}
401
bb0a44e9 402// netmask conversion from length to number
e673ee24
DO
403function binMaskFromDec ($maskL)
404{
bb0a44e9
DO
405 $map_straight = array (
406 0 => 0x00000000,
407 1 => 0x80000000,
408 2 => 0xc0000000,
409 3 => 0xe0000000,
410 4 => 0xf0000000,
411 5 => 0xf8000000,
412 6 => 0xfc000000,
413 7 => 0xfe000000,
414 8 => 0xff000000,
415 9 => 0xff800000,
416 10 => 0xffc00000,
417 11 => 0xffe00000,
418 12 => 0xfff00000,
419 13 => 0xfff80000,
420 14 => 0xfffc0000,
421 15 => 0xfffe0000,
422 16 => 0xffff0000,
423 17 => 0xffff8000,
424 18 => 0xffffc000,
425 19 => 0xffffe000,
426 20 => 0xfffff000,
427 21 => 0xfffff800,
428 22 => 0xfffffc00,
429 23 => 0xfffffe00,
430 24 => 0xffffff00,
431 25 => 0xffffff80,
432 26 => 0xffffffc0,
433 27 => 0xffffffe0,
434 28 => 0xfffffff0,
435 29 => 0xfffffff8,
436 30 => 0xfffffffc,
437 31 => 0xfffffffe,
438 32 => 0xffffffff,
439 );
440 return $map_straight[$maskL];
e673ee24
DO
441}
442
bb0a44e9 443// complementary value
e673ee24
DO
444function binInvMaskFromDec ($maskL)
445{
bb0a44e9
DO
446 $map_compl = array (
447 0 => 0xffffffff,
448 1 => 0x7fffffff,
449 2 => 0x3fffffff,
450 3 => 0x1fffffff,
451 4 => 0x0fffffff,
452 5 => 0x07ffffff,
453 6 => 0x03ffffff,
454 7 => 0x01ffffff,
455 8 => 0x00ffffff,
456 9 => 0x007fffff,
457 10 => 0x003fffff,
458 11 => 0x001fffff,
459 12 => 0x000fffff,
460 13 => 0x0007ffff,
461 14 => 0x0003ffff,
462 15 => 0x0001ffff,
463 16 => 0x0000ffff,
464 17 => 0x00007fff,
465 18 => 0x00003fff,
466 19 => 0x00001fff,
467 20 => 0x00000fff,
468 21 => 0x000007ff,
469 22 => 0x000003ff,
470 23 => 0x000001ff,
471 24 => 0x000000ff,
472 25 => 0x0000007f,
473 26 => 0x0000003f,
474 27 => 0x0000001f,
475 28 => 0x0000000f,
476 29 => 0x00000007,
477 30 => 0x00000003,
478 31 => 0x00000001,
479 32 => 0x00000000,
480 );
481 return $map_compl[$maskL];
e673ee24
DO
482}
483
e673ee24
DO
484// This function looks up 'has_problems' flag for 'T' atoms
485// and modifies 'hl' key. May be, this should be better done
61a1d996 486// in amplifyCell(). We don't honour 'skipped' key, because
e673ee24
DO
487// the function is also used for thumb creation.
488function markupObjectProblems (&$rackData)
489{
490 for ($i = $rackData['height']; $i > 0; $i--)
491 for ($locidx = 0; $locidx < 3; $locidx++)
492 if ($rackData[$i][$locidx]['state'] == 'T')
493 {
6297d584 494 $object = spotEntity ('object', $rackData[$i][$locidx]['object_id']);
e673ee24
DO
495 if ($object['has_problems'] == 'yes')
496 {
497 // Object can be already highlighted.
498 if (isset ($rackData[$i][$locidx]['hl']))
499 $rackData[$i][$locidx]['hl'] = $rackData[$i][$locidx]['hl'] . 'w';
500 else
501 $rackData[$i][$locidx]['hl'] = 'w';
502 }
503 }
504}
505
d516d719
DO
506// Return a uniformly (010203040506 or 0102030405060708) formatted address, if it is present
507// in the provided string, an empty string for an empty string or NULL for error.
e673ee24
DO
508function l2addressForDatabase ($string)
509{
e673ee24 510 $string = strtoupper ($string);
05771508
DO
511 switch (TRUE)
512 {
d516d719 513 case ($string == '' or preg_match (RE_L2_SOLID, $string) or preg_match (RE_L2_WWN_SOLID, $string)):
05771508 514 return $string;
d516d719
DO
515 case (preg_match (RE_L2_IFCFG, $string) or preg_match (RE_L2_WWN_COLON, $string)):
516 // reformat output of SunOS ifconfig
517 $ret = '';
518 foreach (explode (':', $string) as $byte)
519 $ret .= (strlen ($byte) == 1 ? '0' : '') . $byte;
520 return $ret;
05771508 521 case (preg_match (RE_L2_CISCO, $string)):
d516d719
DO
522 return str_replace ('.', '', $string);
523 case (preg_match (RE_L2_IPCFG, $string) or preg_match (RE_L2_WWN_HYPHEN, $string)):
524 return str_replace ('-', '', $string);
05771508
DO
525 default:
526 return NULL;
527 }
e673ee24
DO
528}
529
530function l2addressFromDatabase ($string)
531{
532 switch (strlen ($string))
533 {
534 case 12: // Ethernet
d516d719 535 case 16: // FireWire/Fibre Channel
e673ee24
DO
536 $ret = implode (':', str_split ($string, 2));
537 break;
538 default:
539 $ret = $string;
540 break;
541 }
542 return $ret;
543}
544
545// The following 2 functions return previous and next rack IDs for
546// a given rack ID. The order of racks is the same as in renderRackspace()
547// or renderRow().
548function getPrevIDforRack ($row_id = 0, $rack_id = 0)
549{
550 if ($row_id <= 0 or $rack_id <= 0)
551 {
0cc24e9a 552 showWarning ('Invalid arguments passed', __FUNCTION__);
e673ee24
DO
553 return NULL;
554 }
a8efc03e 555 $rackList = listCells ('rack', $row_id);
e673ee24
DO
556 doubleLink ($rackList);
557 if (isset ($rackList[$rack_id]['prev_key']))
558 return $rackList[$rack_id]['prev_key'];
559 return NULL;
560}
561
562function getNextIDforRack ($row_id = 0, $rack_id = 0)
563{
564 if ($row_id <= 0 or $rack_id <= 0)
565 {
0cc24e9a 566 showWarning ('Invalid arguments passed', __FUNCTION__);
e673ee24
DO
567 return NULL;
568 }
a8efc03e 569 $rackList = listCells ('rack', $row_id);
e673ee24
DO
570 doubleLink ($rackList);
571 if (isset ($rackList[$rack_id]['next_key']))
572 return $rackList[$rack_id]['next_key'];
573 return NULL;
574}
575
576// This function finds previous and next array keys for each array key and
577// modifies its argument accordingly.
578function doubleLink (&$array)
579{
580 $prev_key = NULL;
581 foreach (array_keys ($array) as $key)
582 {
583 if ($prev_key)
584 {
585 $array[$key]['prev_key'] = $prev_key;
586 $array[$prev_key]['next_key'] = $key;
587 }
588 $prev_key = $key;
589 }
590}
591
e673ee24
DO
592function sortTokenize ($a, $b)
593{
594 $aold='';
595 while ($a != $aold)
596 {
597 $aold=$a;
84986395
DO
598 $a = preg_replace('/[^a-zA-Z0-9]/',' ',$a);
599 $a = preg_replace('/([0-9])([a-zA-Z])/','\\1 \\2',$a);
600 $a = preg_replace('/([a-zA-Z])([0-9])/','\\1 \\2',$a);
e673ee24
DO
601 }
602
603 $bold='';
604 while ($b != $bold)
605 {
606 $bold=$b;
84986395
DO
607 $b = preg_replace('/[^a-zA-Z0-9]/',' ',$b);
608 $b = preg_replace('/([0-9])([a-zA-Z])/','\\1 \\2',$b);
609 $b = preg_replace('/([a-zA-Z])([0-9])/','\\1 \\2',$b);
e673ee24
DO
610 }
611
612
613
614 $ar = explode(' ', $a);
615 $br = explode(' ', $b);
616 for ($i=0; $i<count($ar) && $i<count($br); $i++)
617 {
618 $ret = 0;
619 if (is_numeric($ar[$i]) and is_numeric($br[$i]))
620 $ret = ($ar[$i]==$br[$i])?0:($ar[$i]<$br[$i]?-1:1);
621 else
622 $ret = strcasecmp($ar[$i], $br[$i]);
623 if ($ret != 0)
624 return $ret;
625 }
626 if ($i<count($ar))
627 return 1;
628 if ($i<count($br))
629 return -1;
630 return 0;
631}
632
633function sortByName ($a, $b)
634{
bbeb64fd
DO
635 $result = sortTokenize ($a['name'], $b['name']);
636 if ($result != 0)
637 return $result;
638 if ($a['iif_id'] != $b['iif_id'])
639 return $a['iif_id'] - $b['iif_id'];
640 $result = strcmp ($a['label'], $b['label']);
641 if ($result != 0)
642 return $result;
643 $result = strcmp ($a['l2address'], $b['l2address']);
644 if ($result != 0)
645 return $result;
646 return $a['id'] - $b['id'];
e673ee24
DO
647}
648
e673ee24
DO
649function sortObjectAddressesAndNames ($a, $b)
650{
651 $objname_cmp = sortTokenize($a['object_name'], $b['object_name']);
652 if ($objname_cmp == 0)
653 {
79f22c3d
DO
654 $name_a = (isset ($a['port_name'])) ? $a['port_name'] : '';
655 $name_b = (isset ($b['port_name'])) ? $b['port_name'] : '';
656 $objname_cmp = sortTokenize($name_a, $name_b);
e673ee24 657 if ($objname_cmp == 0)
e673ee24 658 sortTokenize($a['ip'], $b['ip']);
e673ee24
DO
659 return $objname_cmp;
660 }
661 return $objname_cmp;
662}
663
c31cd72c 664// This function returns an array of single element of object's FQDN attribute,
f321b50a
DO
665// if FQDN is set. The next choice is object's common name, if it looks like a
666// hostname. Otherwise an array of all 'regular' IP addresses of the
c31cd72c 667// object is returned (which may appear 0 and more elements long).
f321b50a 668function findAllEndpoints ($object_id, $fallback = '')
c31cd72c 669{
7fa7047a
DO
670 foreach (getAttrValues ($object_id) as $record)
671 if ($record['id'] == 3 && strlen ($record['value'])) // FQDN
c31cd72c 672 return array ($record['value']);
c31cd72c 673 $regular = array();
85970da2
DO
674 foreach (getObjectIPv4Allocations ($object_id) as $dottedquad => $alloc)
675 if ($alloc['type'] == 'regular')
676 $regular[] = $dottedquad;
59a83bd8 677 if (!count ($regular) && strlen ($fallback))
f321b50a 678 return array ($fallback);
c31cd72c
DO
679 return $regular;
680}
681
83ba6670
DO
682// Some records in the dictionary may be written as plain text or as Wiki
683// link in the following syntax:
684// 1. word
685// 2. [[word URL]] // FIXME: this isn't working
686// 3. [[word word word | URL]]
687// This function parses the line and returns text suitable for either A
688// (rendering <A HREF>) or O (for <OPTION>).
7fa7047a 689function parseWikiLink ($line, $which)
83ba6670 690{
010231c2 691 if (preg_match ('/^\[\[.+\]\]$/', $line) == 0)
24cbe8af 692 {
7fa7047a
DO
693 // always strip the marker for A-data, but let cookOptgroup()
694 // do this later (otherwise it can't sort groups out)
695 if ($which == 'a')
84986395 696 return preg_replace ('/^.+%GSKIP%/', '', preg_replace ('/^(.+)%GPASS%/', '\\1 ', $line));
24cbe8af
DO
697 else
698 return $line;
699 }
010231c2
DO
700 $line = preg_replace ('/^\[\[(.+)\]\]$/', '$1', $line);
701 $s = explode ('|', $line);
83ba6670 702 $o_value = trim ($s[0]);
83ba6670
DO
703 if ($which == 'o')
704 return $o_value;
84986395 705 $o_value = preg_replace ('/^.+%GSKIP%/', '', preg_replace ('/^(.+)%GPASS%/', '\\1 ', $o_value));
7fa7047a
DO
706 $a_value = trim ($s[1]);
707 return "<a href='${a_value}'>${o_value}</a>";
83ba6670
DO
708}
709
c9edf725
DO
710// FIXME: should this be saved as "P-data"?
711function execGMarker ($line)
712{
84986395 713 return preg_replace ('/^.+%GSKIP%/', '', preg_replace ('/^(.+)%GPASS%/', '\\1 ', $line));
c9edf725
DO
714}
715
177b1e9b
DO
716// rackspace usage for a single rack
717// (T + W + U) / (height * 3 - A)
11df133a 718function getRSUforRack ($data = NULL)
177b1e9b 719{
11df133a 720 if ($data == NULL)
177b1e9b 721 {
0cc24e9a 722 showWarning ('Invalid argument', __FUNCTION__);
177b1e9b
DO
723 return NULL;
724 }
6ffba290 725 $counter = array ('A' => 0, 'U' => 0, 'T' => 0, 'W' => 0, 'F' => 0);
9e60f7df
DO
726 for ($unit_no = $data['height']; $unit_no > 0; $unit_no--)
727 for ($locidx = 0; $locidx < 3; $locidx++)
728 $counter[$data[$unit_no][$locidx]['state']]++;
dfa3c075 729 return ($counter['T'] + $counter['W'] + $counter['U']) / ($counter['T'] + $counter['W'] + $counter['U'] + $counter['F']);
177b1e9b
DO
730}
731
11df133a
DO
732// Same for row.
733function getRSUforRackRow ($rowData = NULL)
734{
bb26a59e 735 if ($rowData === NULL)
11df133a 736 {
0cc24e9a 737 showWarning ('Invalid argument', __FUNCTION__);
11df133a
DO
738 return NULL;
739 }
bb26a59e
DO
740 if (!count ($rowData))
741 return 0;
11df133a 742 $counter = array ('A' => 0, 'U' => 0, 'T' => 0, 'W' => 0, 'F' => 0);
f81a2012 743 $total_height = 0;
dfa3c075
DO
744 foreach (array_keys ($rowData) as $rack_id)
745 {
61a1d996
DO
746 $data = spotEntity ('rack', $rack_id);
747 amplifyCell ($data);
dfa3c075 748 $total_height += $data['height'];
11df133a
DO
749 for ($unit_no = $data['height']; $unit_no > 0; $unit_no--)
750 for ($locidx = 0; $locidx < 3; $locidx++)
751 $counter[$data[$unit_no][$locidx]['state']]++;
dfa3c075
DO
752 }
753 return ($counter['T'] + $counter['W'] + $counter['U']) / ($counter['T'] + $counter['W'] + $counter['U'] + $counter['F']);
11df133a
DO
754}
755
9af110b4
DO
756// Make sure the string is always wrapped with LF characters
757function lf_wrap ($str)
758{
759 $ret = trim ($str, "\r\n");
59a83bd8 760 if (strlen ($ret))
9af110b4
DO
761 $ret .= "\n";
762 return $ret;
763}
764
e6e7d8b3
DO
765// Adopted from Mantis BTS code.
766function string_insert_hrefs ($s)
767{
768 if (getConfigVar ('DETECT_URLS') != 'yes')
769 return $s;
770 # Find any URL in a string and replace it by a clickable link
771 $s = preg_replace( '/(([[:alpha:]][-+.[:alnum:]]*):\/\/(%[[:digit:]A-Fa-f]{2}|[-_.!~*\';\/?%^\\\\:@&={\|}+$#\(\),\[\][:alnum:]])+)/se',
772 "'<a href=\"'.rtrim('\\1','.').'\">\\1</a> [<a href=\"'.rtrim('\\1','.').'\" target=\"_blank\">^</a>]'",
773 $s);
774 $s = preg_replace( '/\b' . email_regex_simple() . '\b/i',
775 '<a href="mailto:\0">\0</a>',
776 $s);
777 return $s;
778}
779
780// Idem.
781function email_regex_simple ()
782{
783 return "(([a-z0-9!#*+\/=?^_{|}~-]+(?:\.[a-z0-9!#*+\/=?^_{|}~-]+)*)" . # recipient
784 "\@((?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?))"; # @domain
785}
786
118e4c38
DO
787// Parse AUTOPORTS_CONFIG and return a list of generated pairs (port_type, port_name)
788// for the requested object_type_id.
789function getAutoPorts ($type_id)
790{
791 $ret = array();
792 $typemap = explode (';', str_replace (' ', '', getConfigVar ('AUTOPORTS_CONFIG')));
793 foreach ($typemap as $equation)
794 {
795 $tmp = explode ('=', $equation);
796 if (count ($tmp) != 2)
797 continue;
798 $objtype_id = $tmp[0];
799 if ($objtype_id != $type_id)
800 continue;
801 $portlist = $tmp[1];
802 foreach (explode ('+', $portlist) as $product)
803 {
804 $tmp = explode ('*', $product);
805 if (count ($tmp) != 3)
806 continue;
807 $nports = $tmp[0];
808 $port_type = $tmp[1];
809 $format = $tmp[2];
810 for ($i = 0; $i < $nports; $i++)
811 $ret[] = array ('type' => $port_type, 'name' => @sprintf ($format, $i));
812 }
813 }
814 return $ret;
815}
816
86256b96
DO
817// Use pre-served trace to traverse the tree, then place given node where it belongs.
818function pokeNode (&$tree, $trace, $key, $value, $threshold = 0)
819{
820 // This function needs the trace to be followed FIFO-way. The fastest
821 // way to do so is to use array_push() for putting values into the
822 // list and array_shift() for getting them out. This exposed up to 11%
823 // performance gain compared to other patterns of array_push/array_unshift/
824 // array_reverse/array_pop/array_shift conjunction.
825 $myid = array_shift ($trace);
826 if (!count ($trace)) // reached the target
9dfd4cc9 827 {
86256b96
DO
828 if (!$threshold or ($threshold and $tree[$myid]['kidc'] + 1 < $threshold))
829 $tree[$myid]['kids'][$key] = $value;
830 // Reset accumulated records once, when the limit is reached, not each time
831 // after that.
832 if (++$tree[$myid]['kidc'] == $threshold)
833 $tree[$myid]['kids'] = array();
834 }
835 else // not yet
836 {
837 $self = __FUNCTION__;
838 $self ($tree[$myid]['kids'], $trace, $key, $value, $threshold);
9dfd4cc9 839 }
9dfd4cc9
DO
840}
841
0ba76ca2
DO
842// Likewise traverse the tree with the trace and return the final node.
843function peekNode ($tree, $trace, $target_id)
844{
845 $self = __FUNCTION__;
846 if (NULL === ($next = array_shift ($trace))) // warm
847 {
848 foreach ($tree as $node)
f1e27fe5 849 if (array_key_exists ('id', $node) and $node['id'] == $target_id) // hot
0ba76ca2
DO
850 return $node;
851 }
852 else // cold
853 {
854 foreach ($tree as $node)
3e576410 855 if (array_key_exists ('id', $node) and $node['id'] == $next) // warmer
0ba76ca2
DO
856 return $self ($node['kids'], $trace, $target_id);
857 }
858 // HCF
859 return NULL;
860}
861
d65353ad
DO
862// Build a tree from the item list and return it. Input and output data is
863// indexed by item id (nested items in output are recursively stored in 'kids'
51b6651a
DO
864// key, which is in turn indexed by id. Functions, which are ready to handle
865// tree collapsion/expansion themselves, may request non-zero threshold value
866// for smaller resulting tree.
3fb336f6 867function treeFromList (&$orig_nodelist, $threshold = 0, $return_main_payload = TRUE)
d65353ad 868{
86256b96 869 $tree = array();
3fb336f6 870 $nodelist = $orig_nodelist;
86256b96
DO
871 // Array equivalent of traceEntity() function.
872 $trace = array();
873 // set kidc and kids only once
874 foreach (array_keys ($nodelist) as $nodeid)
875 {
876 $nodelist[$nodeid]['kidc'] = 0;
877 $nodelist[$nodeid]['kids'] = array();
878 }
879 do
9dfd4cc9 880 {
86256b96
DO
881 $nextpass = FALSE;
882 foreach (array_keys ($nodelist) as $nodeid)
9dfd4cc9 883 {
86256b96
DO
884 // When adding a node to the working tree, book another
885 // iteration, because the new item could make a way for
886 // others onto the tree. Also remove any item added from
887 // the input list, so iteration base shrinks.
888 // First check if we can assign directly.
889 if ($nodelist[$nodeid]['parent_id'] == NULL)
9dfd4cc9 890 {
86256b96
DO
891 $tree[$nodeid] = $nodelist[$nodeid];
892 $trace[$nodeid] = array(); // Trace to root node is empty
893 unset ($nodelist[$nodeid]);
894 $nextpass = TRUE;
9dfd4cc9 895 }
86256b96
DO
896 // Now look if it fits somewhere on already built tree.
897 elseif (isset ($trace[$nodelist[$nodeid]['parent_id']]))
9dfd4cc9 898 {
86256b96
DO
899 // Trace to a node is a trace to its parent plus parent id.
900 $trace[$nodeid] = $trace[$nodelist[$nodeid]['parent_id']];
901 $trace[$nodeid][] = $nodelist[$nodeid]['parent_id'];
902 pokeNode ($tree, $trace[$nodeid], $nodeid, $nodelist[$nodeid], $threshold);
903 // path to any other node is made of all parent nodes plus the added node itself
904 unset ($nodelist[$nodeid]);
905 $nextpass = TRUE;
9dfd4cc9
DO
906 }
907 }
9dfd4cc9 908 }
86256b96 909 while ($nextpass);
3fb336f6 910 if (!$return_main_payload)
86256b96 911 return $nodelist;
3fb336f6
DO
912 // update each input node with its backtrace route
913 foreach ($trace as $nodeid => $route)
914 $orig_nodelist[$nodeid]['trace'] = $route;
915 return $tree;
9dfd4cc9
DO
916}
917
49fb1027 918// Build a tree from the tag list and return everything _except_ the tree.
573214e0
DO
919// IOW, return taginfo items, which have parent_id set and pointing outside
920// of the "normal" tree, which originates from the root.
49fb1027
DO
921function getOrphanedTags ()
922{
923 global $taglist;
86256b96 924 return treeFromList ($taglist, 0, FALSE);
49fb1027
DO
925}
926
6e49bd1f 927function serializeTags ($chain, $baseurl = '')
ba93bd98
DO
928{
929 $comma = '';
930 $ret = '';
6e49bd1f 931 foreach ($chain as $taginfo)
ba93bd98 932 {
e2ac59cf 933 $ret .= $comma .
a8efc03e 934 ($baseurl == '' ? '' : "<a href='${baseurl}cft[]=${taginfo['id']}'>") .
e2ac59cf
DO
935 $taginfo['tag'] .
936 ($baseurl == '' ? '' : '</a>');
ba93bd98
DO
937 $comma = ', ';
938 }
939 return $ret;
940}
941
ba93bd98
DO
942// Return the list of missing implicit tags.
943function getImplicitTags ($oldtags)
944{
3fb336f6
DO
945 global $taglist;
946 $tmp = array();
947 foreach ($oldtags as $taginfo)
948 $tmp = array_merge ($tmp, $taglist[$taginfo['id']]['trace']);
949 // don't call array_unique here, it is in the function we will call now
950 return buildTagChainFromIds ($tmp);
ba93bd98
DO
951}
952
6e49bd1f 953// Minimize the chain: exclude all implicit tags and return the result.
5fd2a004
DO
954// This function makes use of an external cache with a miss/hit ratio
955// about 3/7 (ticket:255).
3fb336f6 956function getExplicitTagsOnly ($chain)
ab379543 957{
5fd2a004 958 global $taglist, $tagRelCache;
ab379543 959 $ret = array();
5fd2a004
DO
960 foreach (array_keys ($chain) as $keyA) // check each A
961 {
962 $tagidA = $chain[$keyA]['id'];
963 // do not include A in result, if A is seen on the trace of any B!=A
964 foreach (array_keys ($chain) as $keyB)
965 {
966 $tagidB = $chain[$keyB]['id'];
967 if ($tagidA == $tagidB)
968 continue;
969 if (!isset ($tagRelCache[$tagidA][$tagidB]))
0745db4d 970 $tagRelCache[$tagidA][$tagidB] = in_array ($tagidA, $taglist[$tagidB]['trace']);
5fd2a004
DO
971 if ($tagRelCache[$tagidA][$tagidB] === TRUE) // A is ancestor of B
972 continue 2; // skip this A
973 }
974 $ret[] = $chain[$keyA];
975 }
74ccacff
DO
976 return $ret;
977}
978
2c21a10c 979// Universal autotags generator, a complementing function for loadEntityTags().
2c21a10c 980// Bypass key isn't strictly typed, but interpreted depending on the realm.
d16af52f 981function generateEntityAutoTags ($cell)
cce6b057 982{
cce6b057 983 $ret = array();
d16af52f 984 switch ($cell['realm'])
2c21a10c
DO
985 {
986 case 'rack':
d16af52f 987 $ret[] = array ('tag' => '$rackid_' . $cell['id']);
2c21a10c
DO
988 $ret[] = array ('tag' => '$any_rack');
989 break;
4c9d35ec 990 case 'object':
d16af52f
DO
991 $ret[] = array ('tag' => '$id_' . $cell['id']);
992 $ret[] = array ('tag' => '$typeid_' . $cell['objtype_id']);
2c21a10c 993 $ret[] = array ('tag' => '$any_object');
588b2b79 994 if (validTagName ('$cn_' . $cell['name'], TRUE))
d16af52f
DO
995 $ret[] = array ('tag' => '$cn_' . $cell['name']);
996 if (!strlen ($cell['rack_id']))
914b439b 997 $ret[] = array ('tag' => '$unmounted');
6d472f26
DO
998 if (!$cell['nports'])
999 $ret[] = array ('tag' => '$portless');
5d6de575
DO
1000 if ($cell['asset_no'] == '')
1001 $ret[] = array ('tag' => '$no_asset_tag');
2c21a10c 1002 break;
4c9d35ec 1003 case 'ipv4net':
d16af52f
DO
1004 $ret[] = array ('tag' => '$ip4netid_' . $cell['id']);
1005 $ret[] = array ('tag' => '$ip4net-' . str_replace ('.', '-', $cell['ip']) . '-' . $cell['mask']);
b9b915d5
DO
1006 for ($i = 8; $i < 32; $i++)
1007 {
1008 // these conditions hit 1 to 3 times per each i
1009 if ($cell['mask'] >= $i)
1010 $ret[] = array ('tag' => '$masklen_ge_' . $i);
1011 if ($cell['mask'] <= $i)
1012 $ret[] = array ('tag' => '$masklen_le_' . $i);
1013 if ($cell['mask'] == $i)
1014 $ret[] = array ('tag' => '$masklen_eq_' . $i);
1015 }
2c21a10c
DO
1016 $ret[] = array ('tag' => '$any_ip4net');
1017 $ret[] = array ('tag' => '$any_net');
1018 break;
1019 case 'ipv4vs':
d16af52f 1020 $ret[] = array ('tag' => '$ipv4vsid_' . $cell['id']);
2c21a10c
DO
1021 $ret[] = array ('tag' => '$any_ipv4vs');
1022 $ret[] = array ('tag' => '$any_vs');
1023 break;
1024 case 'ipv4rspool':
d16af52f 1025 $ret[] = array ('tag' => '$ipv4rspid_' . $cell['id']);
2c21a10c
DO
1026 $ret[] = array ('tag' => '$any_ipv4rsp');
1027 $ret[] = array ('tag' => '$any_rsp');
1028 break;
1029 case 'user':
b82cce3f
DO
1030 // {$username_XXX} autotag is generated always, but {$userid_XXX}
1031 // appears only for accounts, which exist in local database.
d16af52f
DO
1032 $ret[] = array ('tag' => '$username_' . $cell['user_name']);
1033 if (isset ($cell['user_id']))
1034 $ret[] = array ('tag' => '$userid_' . $cell['user_id']);
2c21a10c
DO
1035 break;
1036 case 'file':
d16af52f 1037 $ret[] = array ('tag' => '$fileid_' . $cell['id']);
2c21a10c
DO
1038 $ret[] = array ('tag' => '$any_file');
1039 break;
d16af52f 1040 default: // HCF!
2c21a10c
DO
1041 break;
1042 }
4c9d35ec
DO
1043 // {$tagless} doesn't apply to users
1044 switch ($cell['realm'])
1045 {
1046 case 'rack':
1047 case 'object':
1048 case 'ipv4net':
1049 case 'ipv4vs':
1050 case 'ipv4rspool':
1051 case 'file':
1052 if (!count ($cell['etags']))
1053 $ret[] = array ('tag' => '$untagged');
1054 break;
1055 default:
1056 break;
1057 }
f9bc186f
DO
1058 return $ret;
1059}
1060
abef7149
DO
1061// Check, if the given tag is present on the chain (will only work
1062// for regular tags with tag ID set.
1063function tagOnChain ($taginfo, $tagchain)
1064{
1065 if (!isset ($taginfo['id']))
1066 return FALSE;
1067 foreach ($tagchain as $test)
1068 if ($test['id'] == $taginfo['id'])
1069 return TRUE;
1070 return FALSE;
1071}
1072
f8821b96
DO
1073function tagNameOnChain ($tagname, $tagchain)
1074{
1075 foreach ($tagchain as $test)
1076 if ($test['tag'] == $tagname)
1077 return TRUE;
1078 return FALSE;
1079}
1080
abef7149
DO
1081// Return TRUE, if two tags chains differ (order of tags doesn't matter).
1082// Assume, that neither of the lists contains duplicates.
1083// FIXME: a faster, than O(x^2) method is possible for this calculation.
1084function tagChainCmp ($chain1, $chain2)
1085{
1086 if (count ($chain1) != count ($chain2))
1087 return TRUE;
1088 foreach ($chain1 as $taginfo1)
1089 if (!tagOnChain ($taginfo1, $chain2))
1090 return TRUE;
1091 return FALSE;
1092}
1093
0df8c52b 1094function redirectIfNecessary ()
da958e52 1095{
750d26d2
DO
1096 global
1097 $trigger,
1098 $pageno,
1099 $tabno;
53bae67b
DO
1100 $pmap = array
1101 (
1102 'accounts' => 'userlist',
1103 'rspools' => 'ipv4rsplist',
1104 'rspool' => 'ipv4rsp',
1105 'vservices' => 'ipv4vslist',
1106 'vservice' => 'ipv4vs',
c78a40ec
DO
1107 'objects' => 'depot',
1108 'objgroup' => 'depot',
53bae67b
DO
1109 );
1110 $tmap = array();
1111 $tmap['objects']['newmulti'] = 'addmore';
1112 $tmap['objects']['newobj'] = 'addmore';
1113 $tmap['object']['switchvlans'] = 'livevlans';
1114 $tmap['object']['slb'] = 'editrspvs';
72d8ced3
DO
1115 $tmap['object']['portfwrd'] = 'nat4';
1116 $tmap['object']['network'] = 'ipv4';
53bae67b
DO
1117 if (isset ($pmap[$pageno]))
1118 redirectUser ($pmap[$pageno], $tabno);
1119 if (isset ($tmap[$pageno][$tabno]))
1120 redirectUser ($pageno, $tmap[$pageno][$tabno]);
750d26d2 1121 // check if we accidentaly got on a dynamic tab that shouldn't be shown for this object
3a7bdcc6
DO
1122 if
1123 (
1124 isset ($trigger[$pageno][$tabno]) and
1125 !strlen (call_user_func ($trigger[$pageno][$tabno]))
1126 )
750d26d2 1127 redirectUser ($pageno, 'default');
0df8c52b
DO
1128}
1129
329ec966
DY
1130function prepareNavigation() {
1131 global
1132 $pageno,
1133 $tabno;
1134
1135 $pageno = (isset ($_REQUEST['page'])) ? $_REQUEST['page'] : 'index';
1136
1137// Special handling of tab number to substitute the "last" index where applicable.
1138// Always show explicitly requested tab, substitute the last used name in case
1139// it is awailable, fall back to the default one.
1140
1141 if (isset ($_REQUEST['tab'])) {
1142 $tabno = $_REQUEST['tab'];
329ec966 1143 } elseif (basename($_SERVER['PHP_SELF']) == 'index.php' and getConfigVar ('SHOW_LAST_TAB') == 'yes' and isset ($_SESSION['RTLT'][$pageno])) {
750d26d2 1144 redirectUser ($pageno, $_SESSION['RTLT'][$pageno]);
329ec966
DY
1145 } else {
1146 $tabno = 'default';
1147 }
1148}
1149
0df8c52b
DO
1150function fixContext ($target = NULL)
1151{
1152 global
1153 $pageno,
1154 $auto_tags,
1155 $expl_tags,
1156 $impl_tags,
1157 $target_given_tags,
1158 $user_given_tags,
1159 $etype_by_pageno,
1160 $page;
53bae67b 1161
0df8c52b
DO
1162 if ($target !== NULL)
1163 {
1164 $target_given_tags = $target['etags'];
1165 // Don't reset autochain, because auth procedures could push stuff there in.
1166 // Another important point is to ignore 'user' realm, so we don't infuse effective
1167 // context with autotags of the displayed account.
1168 if ($target['realm'] != 'user')
1169 $auto_tags = array_merge ($auto_tags, $target['atags']);
1170 }
1171 elseif (array_key_exists ($pageno, $etype_by_pageno))
53da7dca
DO
1172 {
1173 // Each page listed in the map above requires one uint argument.
0a50efb4 1174 $target_realm = $etype_by_pageno[$pageno];
0cc24e9a 1175 assertUIntArg ($page[$pageno]['bypass']);
0a50efb4 1176 $target_id = $_REQUEST[$page[$pageno]['bypass']];
b135a49d 1177 $target = spotEntity ($target_realm, $target_id);
53da7dca 1178 $target_given_tags = $target['etags'];
0df8c52b 1179 if ($target['realm'] != 'user')
53da7dca
DO
1180 $auto_tags = array_merge ($auto_tags, $target['atags']);
1181 }
4c9b513a
DO
1182 // Explicit and implicit chains should be normally empty at this point, so
1183 // overwrite the contents anyway.
1184 $expl_tags = mergeTagChains ($user_given_tags, $target_given_tags);
1185 $impl_tags = getImplicitTags ($expl_tags);
da958e52
DO
1186}
1187
abef7149
DO
1188// Take a list of user-supplied tag IDs to build a list of valid taginfo
1189// records indexed by tag IDs (tag chain).
6e49bd1f 1190function buildTagChainFromIds ($tagidlist)
ab379543 1191{
20c901a7 1192 global $taglist;
ab379543 1193 $ret = array();
abef7149 1194 foreach (array_unique ($tagidlist) as $tag_id)
ab379543
DO
1195 if (isset ($taglist[$tag_id]))
1196 $ret[] = $taglist[$tag_id];
1197 return $ret;
1198}
1199
7cc02fc1
DO
1200// Process a given tag tree and return only meaningful branches. The resulting
1201// (sub)tree will have refcnt leaves on every last branch.
a26a6ccc 1202function getObjectiveTagTree ($tree, $realm, $preselect)
7cc02fc1 1203{
51b6651a 1204 $self = __FUNCTION__;
7cc02fc1
DO
1205 $ret = array();
1206 foreach ($tree as $taginfo)
1207 {
a26a6ccc
DO
1208 $subsearch = $self ($taginfo['kids'], $realm, $preselect);
1209 // If the current node addresses something, add it to the result
1210 // regardless of how many sub-nodes it features.
1211 if
7cc02fc1 1212 (
a26a6ccc
DO
1213 isset ($taginfo['refcnt'][$realm]) or
1214 count ($subsearch) > 1 or
3fb336f6 1215 in_array ($taginfo['id'], $preselect)
a26a6ccc
DO
1216 )
1217 $ret[] = array
1218 (
1219 'id' => $taginfo['id'],
1220 'tag' => $taginfo['tag'],
1221 'parent_id' => $taginfo['parent_id'],
1222 'refcnt' => $taginfo['refcnt'],
1223 'kids' => $subsearch
1224 );
1225 else
1226 $ret = array_merge ($ret, $subsearch);
7cc02fc1
DO
1227 }
1228 return $ret;
1229}
1230
7ddb2c05
DO
1231// Get taginfo record by tag name, return NULL, if record doesn't exist.
1232function getTagByName ($target_name)
1233{
1234 global $taglist;
1235 foreach ($taglist as $taginfo)
1236 if ($taginfo['tag'] == $target_name)
1237 return $taginfo;
1238 return NULL;
1239}
1240
fc73c734
DO
1241// Merge two chains, filtering dupes out. Return the resulting superset.
1242function mergeTagChains ($chainA, $chainB)
1243{
1244 // $ret = $chainA;
1245 // Reindex by tag id in any case.
1246 $ret = array();
1247 foreach ($chainA as $tag)
1248 $ret[$tag['id']] = $tag;
1249 foreach ($chainB as $tag)
1250 if (!isset ($ret[$tag['id']]))
1251 $ret[$tag['id']] = $tag;
1252 return $ret;
1253}
1254
31c941ec
DO
1255function getCellFilter ()
1256{
7da7450c 1257 global $sic;
eca0114c 1258 global $pageno;
01b9a31a 1259 $staticFilter = getConfigVar ('STATIC_FILTER');
3d670bba 1260 if (isset ($_REQUEST['tagfilter']) and is_array ($_REQUEST['tagfilter']))
23cdc7e9
DO
1261 {
1262 $_REQUEST['cft'] = $_REQUEST['tagfilter'];
1263 unset ($_REQUEST['tagfilter']);
1264 }
01b9a31a 1265 if (isset ($_SESSION[$pageno]['tagfilter']) and is_array ($_SESSION[$pageno]['tagfilter']) and !(isset($_REQUEST['cft'])) and $staticFilter == 'yes')
b8970c7e 1266 {
eca0114c 1267 $_REQUEST['cft'] = $_SESSION[$pageno]['tagfilter'];
b8970c7e 1268 }
01b9a31a 1269 if (isset ($_SESSION[$pageno]['cfe']) and !(isset($sic['cfe'])) and $staticFilter == 'yes')
b8970c7e 1270 {
eca0114c 1271 $sic['cfe'] = $_SESSION[$pageno]['cfe'];
b8970c7e 1272 }
01b9a31a 1273 if (isset ($_SESSION[$pageno]['andor']) and !(isset($_REQUEST['andor'])) and $staticFilter == 'yes')
b8970c7e 1274 {
eca0114c 1275 $_REQUEST['andor'] = $_SESSION[$pageno]['andor'];
b8970c7e
RF
1276 }
1277
eca0114c 1278
3d670bba
DO
1279 $ret = array
1280 (
23cdc7e9
DO
1281 'tagidlist' => array(),
1282 'tnamelist' => array(),
1283 'pnamelist' => array(),
1284 'andor' => '',
3d670bba 1285 'text' => '',
23cdc7e9
DO
1286 'extratext' => '',
1287 'expression' => array(),
a8efc03e 1288 'urlextra' => '', // Just put text here and let makeHref call urlencode().
3d670bba 1289 );
23cdc7e9 1290 switch (TRUE)
31c941ec 1291 {
23cdc7e9
DO
1292 case (!isset ($_REQUEST['andor'])):
1293 $andor2 = getConfigVar ('FILTER_DEFAULT_ANDOR');
3d670bba 1294 break;
23cdc7e9
DO
1295 case ($_REQUEST['andor'] == 'and'):
1296 case ($_REQUEST['andor'] == 'or'):
eca0114c 1297 $_SESSION[$pageno]['andor'] = $_REQUEST['andor'];
23cdc7e9 1298 $ret['andor'] = $andor2 = $_REQUEST['andor'];
a8efc03e 1299 $ret['urlextra'] .= '&andor=' . $ret['andor'];
3d670bba
DO
1300 break;
1301 default:
0cc24e9a 1302 showWarning ('Invalid and/or switch value in submitted form', __FUNCTION__);
3d670bba 1303 return NULL;
31c941ec 1304 }
23cdc7e9
DO
1305 $andor1 = '';
1306 // Both tags and predicates, which don't exist, should be
1307 // handled somehow. Discard them silently for now.
1308 if (isset ($_REQUEST['cft']) and is_array ($_REQUEST['cft']))
31c941ec 1309 {
eca0114c 1310 $_SESSION[$pageno]['tagfilter'] = $_REQUEST['cft'];
23cdc7e9
DO
1311 global $taglist;
1312 foreach ($_REQUEST['cft'] as $req_id)
1313 if (isset ($taglist[$req_id]))
1314 {
1315 $ret['tagidlist'][] = $req_id;
1316 $ret['tnamelist'][] = $taglist[$req_id]['tag'];
1317 $ret['text'] .= $andor1 . '{' . $taglist[$req_id]['tag'] . '}';
1318 $andor1 = ' ' . $andor2 . ' ';
a8efc03e 1319 $ret['urlextra'] .= '&cft[]=' . $req_id;
23cdc7e9
DO
1320 }
1321 }
1322 if (isset ($_REQUEST['cfp']) and is_array ($_REQUEST['cfp']))
1323 {
1324 global $pTable;
1325 foreach ($_REQUEST['cfp'] as $req_name)
1326 if (isset ($pTable[$req_name]))
1327 {
1328 $ret['pnamelist'][] = $req_name;
1329 $ret['text'] .= $andor1 . '[' . $req_name . ']';
1330 $andor1 = ' ' . $andor2 . ' ';
a8efc03e 1331 $ret['urlextra'] .= '&cfp[]=' . $req_name;
23cdc7e9
DO
1332 }
1333 }
7da7450c
DO
1334 // Extra text comes from TEXTAREA and is easily screwed by standard escaping function.
1335 if (isset ($sic['cfe']))
a8efc03e 1336 {
eca0114c 1337 $_SESSION[$pageno]['cfe'] = $sic['cfe'];
7da7450c
DO
1338 // Only consider extra text, when it is a correct RackCode expression.
1339 $parse = spotPayload ($sic['cfe'], 'SYNT_EXPR');
1340 if ($parse['result'] == 'ACK')
1341 {
1342 $ret['extratext'] = trim ($sic['cfe']);
1343 $ret['urlextra'] .= '&cfe=' . $ret['extratext'];
1344 }
a8efc03e 1345 }
23cdc7e9
DO
1346 $finaltext = array();
1347 if (strlen ($ret['text']))
1348 $finaltext[] = '(' . $ret['text'] . ')';
1349 if (strlen ($ret['extratext']))
1350 $finaltext[] = '(' . $ret['extratext'] . ')';
1351 $finaltext = implode (' ' . $andor2 . ' ', $finaltext);
1352 if (strlen ($finaltext))
1353 {
1354 $parse = spotPayload ($finaltext, 'SYNT_EXPR');
1355 $ret['expression'] = $parse['result'] == 'ACK' ? $parse['load'] : NULL;
8c699525
DO
1356 // It's not quite fair enough to put the blame of the whole text onto
1357 // non-empty "extra" portion of it, but it's the only user-generated portion
1358 // of it, thus the most probable cause of parse error.
1359 if (strlen ($ret['extratext']))
1360 $ret['extraclass'] = $parse['result'] == 'ACK' ? 'validation-success' : 'validation-error';
31c941ec 1361 }
3d670bba 1362 return $ret;
31c941ec
DO
1363}
1364
db55cf54
DO
1365// Return an empty message log.
1366function emptyLog ()
1367{
1368 return array
1369 (
1370 'v' => 2,
1371 'm' => array()
1372 );
1373}
1374
2987fc1f
DO
1375// Return a message log consisting of only one message.
1376function oneLiner ($code, $args = array())
1377{
db55cf54 1378 $ret = emptyLog();
2987fc1f
DO
1379 $ret['m'][] = count ($args) ? array ('c' => $code, 'a' => $args) : array ('c' => $code);
1380 return $ret;
46f92ff7
DO
1381}
1382
e53b1246
DO
1383// Merge message payload from two message logs given and return the result.
1384function mergeLogs ($log1, $log2)
1385{
1386 $ret = emptyLog();
1387 $ret['m'] = array_merge ($log1['m'], $log2['m']);
1388 return $ret;
1389}
1390
9f54e6e9 1391function validTagName ($s, $allow_autotag = FALSE)
2eeeca80 1392{
84986395 1393 if (1 == preg_match (TAGNAME_REGEXP, $s))
9f54e6e9 1394 return TRUE;
84986395 1395 if ($allow_autotag and 1 == preg_match (AUTOTAGNAME_REGEXP, $s))
9f54e6e9
DO
1396 return TRUE;
1397 return FALSE;
2eeeca80
DO
1398}
1399
53bae67b
DO
1400function redirectUser ($p, $t)
1401{
790a60e8
DO
1402 global $page;
1403 $l = "index.php?page=${p}&tab=${t}";
53bae67b
DO
1404 if (isset ($page[$p]['bypass']) and isset ($_REQUEST[$page[$p]['bypass']]))
1405 $l .= '&' . $page[$p]['bypass'] . '=' . $_REQUEST[$page[$p]['bypass']];
1406 header ("Location: " . $l);
1407 die;
1408}
1409
9f3e5caa
DO
1410function getRackCodeStats ()
1411{
1412 global $rackCode;
914b439b 1413 $defc = $grantc = $modc = 0;
9f3e5caa
DO
1414 foreach ($rackCode as $s)
1415 switch ($s['type'])
1416 {
1417 case 'SYNT_DEFINITION':
1418 $defc++;
1419 break;
1420 case 'SYNT_GRANT':
1421 $grantc++;
1422 break;
914b439b
DO
1423 case 'SYNT_CTXMOD':
1424 $modc++;
1425 break;
9f3e5caa
DO
1426 default:
1427 break;
1428 }
914b439b
DO
1429 $ret = array
1430 (
1431 'Definition sentences' => $defc,
1432 'Grant sentences' => $grantc,
1433 'Context mod sentences' => $modc
1434 );
9f3e5caa
DO
1435 return $ret;
1436}
1437
d5157018
DO
1438function getRackImageWidth ()
1439{
529eac25
DO
1440 global $rtwidth;
1441 return 3 + $rtwidth[0] + $rtwidth[1] + $rtwidth[2] + 3;
d5157018
DO
1442}
1443
1444function getRackImageHeight ($units)
1445{
1446 return 3 + 3 + $units * 2;
1447}
1448
2987fc1f
DO
1449// Perform substitutions and return resulting string
1450// used solely by buildLVSConfig()
1451function apply_macros ($macros, $subject)
1452{
1453 $ret = $subject;
1454 foreach ($macros as $search => $replace)
1455 $ret = str_replace ($search, $replace, $ret);
1456 return $ret;
1457}
1458
1459function buildLVSConfig ($object_id = 0)
1460{
1461 if ($object_id <= 0)
1462 {
0cc24e9a 1463 showWarning ('Invalid argument', __FUNCTION__);
2987fc1f
DO
1464 return;
1465 }
6297d584 1466 $oInfo = spotEntity ('object', $object_id);
2987fc1f
DO
1467 $lbconfig = getSLBConfig ($object_id);
1468 if ($lbconfig === NULL)
1469 {
0cc24e9a 1470 showWarning ('getSLBConfig() failed', __FUNCTION__);
2987fc1f
DO
1471 return;
1472 }
1473 $newconfig = "#\n#\n# This configuration has been generated automatically by RackTables\n";
1474 $newconfig .= "# for object_id == ${object_id}\n# object name: ${oInfo['name']}\n#\n#\n\n\n";
1475 foreach ($lbconfig as $vs_id => $vsinfo)
1476 {
1477 $newconfig .= "########################################################\n" .
59a83bd8
DO
1478 "# VS (id == ${vs_id}): " . (!strlen ($vsinfo['vs_name']) ? 'NO NAME' : $vsinfo['vs_name']) . "\n" .
1479 "# RS pool (id == ${vsinfo['pool_id']}): " . (!strlen ($vsinfo['pool_name']) ? 'ANONYMOUS' : $vsinfo['pool_name']) . "\n" .
2987fc1f
DO
1480 "########################################################\n";
1481 # The order of inheritance is: VS -> LB -> pool [ -> RS ]
1482 $macros = array
1483 (
1484 '%VIP%' => $vsinfo['vip'],
1485 '%VPORT%' => $vsinfo['vport'],
1486 '%PROTO%' => $vsinfo['proto'],
1487 '%VNAME%' => $vsinfo['vs_name'],
1488 '%RSPOOLNAME%' => $vsinfo['pool_name']
1489 );
1490 $newconfig .= "virtual_server ${vsinfo['vip']} ${vsinfo['vport']} {\n";
1491 $newconfig .= "\tprotocol ${vsinfo['proto']}\n";
1492 $newconfig .= apply_macros
1493 (
1494 $macros,
1495 lf_wrap ($vsinfo['vs_vsconfig']) .
1496 lf_wrap ($vsinfo['lb_vsconfig']) .
1497 lf_wrap ($vsinfo['pool_vsconfig'])
1498 );
1499 foreach ($vsinfo['rslist'] as $rs)
1500 {
59a83bd8 1501 if (!strlen ($rs['rsport']))
79a9edb4 1502 $rs['rsport'] = $vsinfo['vport'];
2987fc1f
DO
1503 $macros['%RSIP%'] = $rs['rsip'];
1504 $macros['%RSPORT%'] = $rs['rsport'];
1505 $newconfig .= "\treal_server ${rs['rsip']} ${rs['rsport']} {\n";
1506 $newconfig .= apply_macros
1507 (
1508 $macros,
1509 lf_wrap ($vsinfo['vs_rsconfig']) .
1510 lf_wrap ($vsinfo['lb_rsconfig']) .
1511 lf_wrap ($vsinfo['pool_rsconfig']) .
1512 lf_wrap ($rs['rs_rsconfig'])
1513 );
1514 $newconfig .= "\t}\n";
1515 }
1516 $newconfig .= "}\n\n\n";
1517 }
3dd72e34
DO
1518 // FIXME: deal somehow with Mac-styled text, the below replacement will screw it up
1519 return str_replace ("\r", '', $newconfig);
2987fc1f
DO
1520}
1521
2d318652
DO
1522// Indicate occupation state of each IP address: none, ordinary or problematic.
1523function markupIPv4AddrList (&$addrlist)
1524{
1525 foreach (array_keys ($addrlist) as $ip_bin)
1526 {
d983f70a
DO
1527 $refc = array
1528 (
00c5d8cb
DO
1529 'shared' => 0, // virtual
1530 'virtual' => 0, // loopback
1531 'regular' => 0, // connected host
1532 'router' => 0 // connected gateway
d983f70a
DO
1533 );
1534 foreach ($addrlist[$ip_bin]['allocs'] as $a)
1535 $refc[$a['type']]++;
00c5d8cb 1536 $nvirtloopback = ($refc['shared'] + $refc['virtual'] > 0) ? 1 : 0; // modulus of virtual + shared
d983f70a
DO
1537 $nreserved = ($addrlist[$ip_bin]['reserved'] == 'yes') ? 1 : 0; // only one reservation is possible ever
1538 $nrealms = $nreserved + $nvirtloopback + $refc['regular'] + $refc['router']; // latter two are connected and router allocations
2d318652
DO
1539
1540 if ($nrealms == 1)
1541 $addrlist[$ip_bin]['class'] = 'trbusy';
1542 elseif ($nrealms > 1)
1543 $addrlist[$ip_bin]['class'] = 'trerror';
1544 else
1545 $addrlist[$ip_bin]['class'] = '';
1546 }
1547}
1548
04d619d0
DO
1549// Scan the given address list (returned by scanIPv4Space) and return a list of all routers found.
1550function findRouters ($addrlist)
1551{
1552 $ret = array();
1553 foreach ($addrlist as $addr)
1554 foreach ($addr['allocs'] as $alloc)
1555 if ($alloc['type'] == 'router')
1556 $ret[] = array
1557 (
1558 'id' => $alloc['object_id'],
1559 'iface' => $alloc['name'],
1560 'dname' => $alloc['object_name'],
1561 'addr' => $addr['ip']
1562 );
1563 return $ret;
1564}
1565
fb7a4967
DO
1566// Assist in tag chain sorting.
1567function taginfoCmp ($tagA, $tagB)
1568{
1569 return $tagA['ci'] - $tagB['ci'];
1570}
1571
1327d9dd
DO
1572// Compare networks. When sorting a tree, the records on the list will have
1573// distinct base IP addresses.
3444ecf2
DO
1574// "The comparison function must return an integer less than, equal to, or greater
1575// than zero if the first argument is considered to be respectively less than,
1576// equal to, or greater than the second." (c) PHP manual
1327d9dd
DO
1577function IPv4NetworkCmp ($netA, $netB)
1578{
2d75c30b
DO
1579 // There's a problem just substracting one u32 integer from another,
1580 // because the result may happen big enough to become a negative i32
1581 // integer itself (PHP tries to cast everything it sees to signed int)
3444ecf2
DO
1582 // The comparison below must treat positive and negative values of both
1583 // arguments.
1584 // Equal values give instant decision regardless of their [equal] sign.
1585 if ($netA['ip_bin'] == $netB['ip_bin'])
2d75c30b 1586 return 0;
3444ecf2
DO
1587 // Same-signed values compete arithmetically within one of i32 contiguous ranges:
1588 // 0x00000001~0x7fffffff 1~2147483647
1589 // 0 doesn't have any sign, and network 0.0.0.0 isn't allowed
1590 // 0x80000000~0xffffffff -2147483648~-1
1591 $signA = $netA['ip_bin'] / abs ($netA['ip_bin']);
1592 $signB = $netB['ip_bin'] / abs ($netB['ip_bin']);
1593 if ($signA == $signB)
1594 {
1595 if ($netA['ip_bin'] > $netB['ip_bin'])
1596 return 1;
1597 else
1598 return -1;
1599 }
1600 else // With only one of two values being negative, it... wins!
1601 {
1602 if ($netA['ip_bin'] < $netB['ip_bin'])
1603 return 1;
1604 else
1605 return -1;
1606 }
1327d9dd
DO
1607}
1608
fb7a4967 1609// Modify the given tag tree so, that each level's items are sorted alphabetically.
1327d9dd 1610function sortTree (&$tree, $sortfunc = '')
fb7a4967 1611{
59a83bd8 1612 if (!strlen ($sortfunc))
1327d9dd 1613 return;
51b6651a 1614 $self = __FUNCTION__;
1327d9dd 1615 usort ($tree, $sortfunc);
fb7a4967
DO
1616 // Don't make a mistake of directly iterating over the items of current level, because this way
1617 // the sorting will be performed on a _copy_ if each item, not the item itself.
1618 foreach (array_keys ($tree) as $tagid)
51b6651a 1619 $self ($tree[$tagid]['kids'], $sortfunc);
fb7a4967
DO
1620}
1621
0137d53c
DO
1622function iptree_fill (&$netdata)
1623{
59a83bd8 1624 if (!isset ($netdata['kids']) or !count ($netdata['kids']))
0137d53c 1625 return;
a987ff52 1626 // If we really have nested prefixes, they must fit into the tree.
0137d53c
DO
1627 $worktree = array
1628 (
1629 'ip_bin' => $netdata['ip_bin'],
1630 'mask' => $netdata['mask']
1631 );
1632 foreach ($netdata['kids'] as $pfx)
1633 iptree_embed ($worktree, $pfx);
1634 $netdata['kids'] = iptree_construct ($worktree);
1635 $netdata['kidc'] = count ($netdata['kids']);
1636}
1637
1638function iptree_construct ($node)
1639{
1640 $self = __FUNCTION__;
1641
1642 if (!isset ($node['right']))
1643 {
1644 if (!isset ($node['ip']))
1645 {
1646 $node['ip'] = long2ip ($node['ip_bin']);
1647 $node['kids'] = array();
fec0c8da 1648 $node['kidc'] = 0;
0137d53c
DO
1649 $node['name'] = '';
1650 }
1651 return array ($node);
1652 }
1653 else
1654 return array_merge ($self ($node['left']), $self ($node['right']));
1655}
1656
1657function iptree_embed (&$node, $pfx)
1658{
1659 $self = __FUNCTION__;
1660
1661 // hit?
1662 if ($node['ip_bin'] == $pfx['ip_bin'] and $node['mask'] == $pfx['mask'])
1663 {
1664 $node = $pfx;
1665 return;
1666 }
1667 if ($node['mask'] == $pfx['mask'])
1668 {
0cc24e9a 1669 throw new RuntimeException('Internal error, the recurring loop lost control');
0137d53c
DO
1670 }
1671
1672 // split?
1673 if (!isset ($node['right']))
1674 {
a987ff52
DO
1675 // Fill in db_first/db_last to make it possible to run scanIPv4Space() on the node.
1676 $node['left']['mask'] = $node['mask'] + 1;
0137d53c 1677 $node['left']['ip_bin'] = $node['ip_bin'];
a987ff52
DO
1678 $node['left']['db_first'] = sprintf ('%u', $node['left']['ip_bin']);
1679 $node['left']['db_last'] = sprintf ('%u', $node['left']['ip_bin'] | binInvMaskFromDec ($node['left']['mask']));
1680
1681 $node['right']['mask'] = $node['mask'] + 1;
0137d53c 1682 $node['right']['ip_bin'] = $node['ip_bin'] + binInvMaskFromDec ($node['mask'] + 1) + 1;
a987ff52
DO
1683 $node['right']['db_first'] = sprintf ('%u', $node['right']['ip_bin']);
1684 $node['right']['db_last'] = sprintf ('%u', $node['right']['ip_bin'] | binInvMaskFromDec ($node['right']['mask']));
0137d53c
DO
1685 }
1686
1687 // repeat!
1688 if (($node['left']['ip_bin'] & binMaskFromDec ($node['left']['mask'])) == ($pfx['ip_bin'] & binMaskFromDec ($node['left']['mask'])))
1689 $self ($node['left'], $pfx);
1690 elseif (($node['right']['ip_bin'] & binMaskFromDec ($node['right']['mask'])) == ($pfx['ip_bin'] & binMaskFromDec ($node['left']['mask'])))
1691 $self ($node['right'], $pfx);
1692 else
1693 {
0cc24e9a 1694 throw new RuntimeException ('Internal error, cannot decide between left and right');
0137d53c
DO
1695 }
1696}
1697
3b81cb98 1698function treeApplyFunc (&$tree, $func = '', $stopfunc = '')
0137d53c 1699{
59a83bd8 1700 if (!strlen ($func))
0137d53c
DO
1701 return;
1702 $self = __FUNCTION__;
1703 foreach (array_keys ($tree) as $key)
1704 {
1705 $func ($tree[$key]);
59a83bd8 1706 if (strlen ($stopfunc) and $stopfunc ($tree[$key]))
c3315231 1707 continue;
0137d53c
DO
1708 $self ($tree[$key]['kids'], $func);
1709 }
1710}
1711
a987ff52
DO
1712function loadIPv4AddrList (&$netinfo)
1713{
1714 loadOwnIPv4Addresses ($netinfo);
1715 markupIPv4AddrList ($netinfo['addrlist']);
1716}
b18d26dc 1717
b6b87070 1718function countOwnIPv4Addresses (&$node)
b18d26dc 1719{
b6b87070 1720 $toscan = array();
737a3f72 1721 $node['addrt'] = 0;
4d0dbd87
DO
1722 $node['mask_bin'] = binMaskFromDec ($node['mask']);
1723 $node['mask_bin_inv'] = binInvMaskFromDec ($node['mask']);
1724 $node['db_first'] = sprintf ('%u', 0x00000000 + $node['ip_bin'] & $node['mask_bin']);
1725 $node['db_last'] = sprintf ('%u', 0x00000000 + $node['ip_bin'] | ($node['mask_bin_inv']));
59a83bd8 1726 if (!count ($node['kids']))
737a3f72 1727 {
f7414fa5 1728 $toscan[] = array ('i32_first' => $node['db_first'], 'i32_last' => $node['db_last']);
737a3f72
DO
1729 $node['addrt'] = binInvMaskFromDec ($node['mask']) + 1;
1730 }
b18d26dc 1731 else
b6b87070 1732 foreach ($node['kids'] as $nested)
b18d26dc 1733 if (!isset ($nested['id'])) // spare
737a3f72 1734 {
f7414fa5 1735 $toscan[] = array ('i32_first' => $nested['db_first'], 'i32_last' => $nested['db_last']);
737a3f72
DO
1736 $node['addrt'] += binInvMaskFromDec ($nested['mask']) + 1;
1737 }
4d0dbd87
DO
1738 // Don't do anything more, because the displaying function will load the addresses anyway.
1739 return;
f7414fa5 1740 $node['addrc'] = count (scanIPv4Space ($toscan));
b6b87070
DO
1741}
1742
c3315231
DO
1743function nodeIsCollapsed ($node)
1744{
1745 return $node['symbol'] == 'node-collapsed';
1746}
1747
b6b87070
DO
1748function loadOwnIPv4Addresses (&$node)
1749{
1750 $toscan = array();
43eb71f1 1751 if (!isset ($node['kids']) or !count ($node['kids']))
f7414fa5 1752 $toscan[] = array ('i32_first' => $node['db_first'], 'i32_last' => $node['db_last']);
b6b87070
DO
1753 else
1754 foreach ($node['kids'] as $nested)
1755 if (!isset ($nested['id'])) // spare
f7414fa5
DO
1756 $toscan[] = array ('i32_first' => $nested['db_first'], 'i32_last' => $nested['db_last']);
1757 $node['addrlist'] = scanIPv4Space ($toscan);
b6b87070 1758 $node['addrc'] = count ($node['addrlist']);
b18d26dc
DO
1759}
1760
fec0c8da
DO
1761function prepareIPv4Tree ($netlist, $expanded_id = 0)
1762{
573214e0
DO
1763 // treeFromList() requires parent_id to be correct for an item to get onto the tree,
1764 // so perform necessary pre-processing to make orphans belong to root. This trick
1765 // was earlier performed by getIPv4NetworkList().
1766 $netids = array_keys ($netlist);
1767 foreach ($netids as $cid)
1768 if (!in_array ($netlist[$cid]['parent_id'], $netids))
1769 $netlist[$cid]['parent_id'] = NULL;
fec0c8da
DO
1770 $tree = treeFromList ($netlist); // medium call
1771 sortTree ($tree, 'IPv4NetworkCmp');
fec0c8da 1772 // complement the tree before markup to make the spare networks have "symbol" set
c3315231
DO
1773 treeApplyFunc ($tree, 'iptree_fill');
1774 iptree_markup_collapsion ($tree, getConfigVar ('TREE_THRESHOLD'), $expanded_id);
1775 // count addresses after the markup to skip computation for hidden tree nodes
1776 treeApplyFunc ($tree, 'countOwnIPv4Addresses', 'nodeIsCollapsed');
fec0c8da
DO
1777 return $tree;
1778}
1779
1780// Check all items of the tree recursively, until the requested target id is
1781// found. Mark all items leading to this item as "expanded", collapsing all
1782// the rest, which exceed the given threshold (if the threshold is given).
1783function iptree_markup_collapsion (&$tree, $threshold = 1024, $target = 0)
1784{
1785 $self = __FUNCTION__;
1786 $ret = FALSE;
1787 foreach (array_keys ($tree) as $key)
1788 {
5388794d 1789 $here = ($target === 'ALL' or ($target > 0 and isset ($tree[$key]['id']) and $tree[$key]['id'] == $target));
fec0c8da
DO
1790 $below = $self ($tree[$key]['kids'], $threshold, $target);
1791 if (!$tree[$key]['kidc']) // terminal node
1792 $tree[$key]['symbol'] = 'spacer';
1793 elseif ($tree[$key]['kidc'] < $threshold)
1794 $tree[$key]['symbol'] = 'node-expanded-static';
1795 elseif ($here or $below)
1796 $tree[$key]['symbol'] = 'node-expanded';
1797 else
1798 $tree[$key]['symbol'] = 'node-collapsed';
1799 $ret = ($ret or $here or $below); // parentheses are necessary for this to be computed correctly
1800 }
1801 return $ret;
1802}
1803
e1ae3fb4
AD
1804// Convert entity name to human-readable value
1805function formatEntityName ($name) {
1806 switch ($name)
1807 {
1808 case 'ipv4net':
1809 return 'IPv4 Network';
1810 case 'ipv4rspool':
1811 return 'IPv4 RS Pool';
1812 case 'ipv4vs':
1813 return 'IPv4 Virtual Service';
1814 case 'object':
1815 return 'Object';
1816 case 'rack':
1817 return 'Rack';
1818 case 'user':
1819 return 'User';
1820 }
1821 return 'invalid';
1822}
1823
1824// Take a MySQL or other generic timestamp and make it prettier
1825function formatTimestamp ($timestamp) {
1826 return date('n/j/y g:iA', strtotime($timestamp));
1827}
1828
8bc5d1e4
DO
1829// Display hrefs for all of a file's parents. If scissors are requested,
1830// prepend cutting button to each of them.
1831function serializeFileLinks ($links, $scissors = FALSE)
e1ae3fb4 1832{
e1ae3fb4
AD
1833 $comma = '';
1834 $ret = '';
1835 foreach ($links as $link_id => $li)
1836 {
1837 switch ($li['entity_type'])
1838 {
1839 case 'ipv4net':
1840 $params = "page=ipv4net&id=";
1841 break;
1842 case 'ipv4rspool':
1843 $params = "page=ipv4rspool&pool_id=";
1844 break;
1845 case 'ipv4vs':
1846 $params = "page=ipv4vs&vs_id=";
1847 break;
1848 case 'object':
1849 $params = "page=object&object_id=";
1850 break;
1851 case 'rack':
1852 $params = "page=rack&rack_id=";
1853 break;
1854 case 'user':
1855 $params = "page=user&user_id=";
1856 break;
1857 }
8bc5d1e4
DO
1858 $ret .= $comma;
1859 if ($scissors)
1860 {
1861 $ret .= "<a href='" . makeHrefProcess(array('op'=>'unlinkFile', 'link_id'=>$link_id)) . "'";
1862 $ret .= getImageHREF ('cut') . '</a> ';
1863 }
790a60e8 1864 $ret .= sprintf("<a href='index.php?%s%s'>%s</a>", $params, $li['entity_id'], $li['name']);
8bc5d1e4 1865 $comma = '<br>';
e1ae3fb4 1866 }
e1ae3fb4
AD
1867 return $ret;
1868}
1869
1870// Convert filesize to appropriate unit and make it human-readable
1871function formatFileSize ($bytes) {
1872 // bytes
1873 if($bytes < 1024) // bytes
1874 return "${bytes} bytes";
1875
1876 // kilobytes
1877 if ($bytes < 1024000)
1878 return sprintf ("%.1fk", round (($bytes / 1024), 1));
1879
1880 // megabytes
1881 return sprintf ("%.1f MB", round (($bytes / 1024000), 1));
1882}
1883
1884// Reverse of formatFileSize, it converts human-readable value to bytes
1885function convertToBytes ($value) {
1886 $value = trim($value);
1887 $last = strtolower($value[strlen($value)-1]);
1888 switch ($last)
1889 {
1890 case 'g':
1891 $value *= 1024;
1892 case 'm':
1893 $value *= 1024;
1894 case 'k':
1895 $value *= 1024;
1896 }
1897
1898 return $value;
1899}
1900
4fbb5a00
DY
1901function ip_quad2long ($ip)
1902{
1903 return sprintf("%u", ip2long($ip));
1904}
1905
1906function ip_long2quad ($quad)
1907{
1908 return long2ip($quad);
1909}
1910
1911function makeHref($params = array())
1912{
790a60e8 1913 $ret = 'index.php?';
4fbb5a00 1914 $first = true;
4fbb5a00
DY
1915 foreach($params as $key=>$value)
1916 {
1917 if (!$first)
1918 $ret.='&';
1919 $ret .= urlencode($key).'='.urlencode($value);
1920 $first = false;
1921 }
1922 return $ret;
1923}
1924
1925function makeHrefProcess($params = array())
1926{
790a60e8
DO
1927 global $pageno, $tabno;
1928 $ret = 'process.php?';
4fbb5a00 1929 $first = true;
9f14a7ef
DY
1930 if (!isset($params['page']))
1931 $params['page'] = $pageno;
1932 if (!isset($params['tab']))
1933 $params['tab'] = $tabno;
4fbb5a00
DY
1934 foreach($params as $key=>$value)
1935 {
1936 if (!$first)
1937 $ret.='&';
1938 $ret .= urlencode($key).'='.urlencode($value);
1939 $first = false;
1940 }
1941 return $ret;
1942}
1943
39106006 1944function makeHrefForHelper ($helper_name, $params = array())
4fbb5a00 1945{
790a60e8 1946 $ret = 'popup.php?helper=' . $helper_name;
4fbb5a00 1947 foreach($params as $key=>$value)
39106006 1948 $ret .= '&'.urlencode($key).'='.urlencode($value);
4fbb5a00
DY
1949 return $ret;
1950}
1951
f3d274bf
DO
1952// Process the given list of records to build data suitable for printNiftySelect()
1953// (like it was formerly executed by printSelect()). Screen out vendors according
1954// to VENDOR_SIEVE, if object type ID is provided. However, the OPTGROUP with already
1955// selected OPTION is protected from being screened.
1956function cookOptgroups ($recordList, $object_type_id = 0, $existing_value = 0)
1957{
1958 $ret = array();
1959 // Always keep "other" OPTGROUP at the SELECT bottom.
1960 $therest = array();
1961 foreach ($recordList as $dict_key => $dict_value)
1962 if (strpos ($dict_value, '%GSKIP%') !== FALSE)
1963 {
1964 $tmp = explode ('%GSKIP%', $dict_value, 2);
1965 $ret[$tmp[0]][$dict_key] = $tmp[1];
1966 }
1967 elseif (strpos ($dict_value, '%GPASS%') !== FALSE)
1968 {
1969 $tmp = explode ('%GPASS%', $dict_value, 2);
1970 $ret[$tmp[0]][$dict_key] = $tmp[1];
1971 }
1972 else
1973 $therest[$dict_key] = $dict_value;
1974 if ($object_type_id != 0)
1975 {
1976 $screenlist = array();
1977 foreach (explode (';', getConfigVar ('VENDOR_SIEVE')) as $sieve)
84986395 1978 if (FALSE !== preg_match ("/^([^@]+)(@${object_type_id})?\$/", trim ($sieve), $regs))
f3d274bf
DO
1979 $screenlist[] = $regs[1];
1980 foreach (array_keys ($ret) as $vendor)
1981 if (in_array ($vendor, $screenlist))
1982 {
1983 $ok_to_screen = TRUE;
1984 if ($existing_value)
1985 foreach (array_keys ($ret[$vendor]) as $recordkey)
1986 if ($recordkey == $existing_value)
1987 {
1988 $ok_to_screen = FALSE;
1989 break;
1990 }
1991 if ($ok_to_screen)
1992 unset ($ret[$vendor]);
1993 }
1994 }
1995 $ret['other'] = $therest;
1996 return $ret;
1997}
1998
f8874cdb
DO
1999function dos2unix ($text)
2000{
2001 return str_replace ("\r\n", "\n", $text);
2002}
2003
9dd73255
DO
2004function unix2dos ($text)
2005{
2006 return str_replace ("\n", "\r\n", $text);
2007}
2008
a0527aef 2009function buildPredicateTable ($parsetree)
2c21a10c 2010{
a0527aef
DO
2011 $ret = array();
2012 foreach ($parsetree as $sentence)
72e8baf6 2013 if ($sentence['type'] == 'SYNT_DEFINITION')
a0527aef 2014 $ret[$sentence['term']] = $sentence['definition'];
72e8baf6
DO
2015 // Now we have predicate table filled in with the latest definitions of each
2016 // particular predicate met. This isn't as chik, as on-the-fly predicate
2017 // overloading during allow/deny scan, but quite sufficient for this task.
a0527aef
DO
2018 return $ret;
2019}
2020
2021// Take a list of records and filter against given RackCode expression. Return
2022// the original list intact, if there was no filter requested, but return an
2023// empty list, if there was an error.
573214e0 2024function filterCellList ($list_in, $expression = array())
d08d766d
DO
2025{
2026 if ($expression === NULL)
2027 return array();
2028 if (!count ($expression))
2029 return $list_in;
d08d766d
DO
2030 $list_out = array();
2031 foreach ($list_in as $item_key => $item_value)
573214e0 2032 if (TRUE === judgeCell ($item_value, $expression))
d08d766d
DO
2033 $list_out[$item_key] = $item_value;
2034 return $list_out;
2035}
2036
212c9d8a 2037// Tell, if the given expression is true for the given entity. Take complete record on input.
573214e0 2038function judgeCell ($cell, $expression)
d08d766d
DO
2039{
2040 global $pTable;
2041 return eval_expression
2042 (
2043 $expression,
2044 array_merge
2045 (
573214e0
DO
2046 $cell['etags'],
2047 $cell['itags'],
2048 $cell['atags']
d08d766d
DO
2049 ),
2050 $pTable,
2051 TRUE
2052 );
2053}
2054
7ddbcf59 2055// Tell, if a constraint from config option permits given record.
212c9d8a 2056function considerConfiguredConstraint ($cell, $varname)
c6bc0ac5 2057{
7ddbcf59 2058 if (!strlen (getConfigVar ($varname)))
c6bc0ac5 2059 return TRUE; // no restriction
7ddbcf59
DO
2060 global $parseCache;
2061 if (!isset ($parseCache[$varname]))
2062 // getConfigVar() doesn't re-read the value from DB because of its
2063 // own cache, so there is no race condition here between two calls.
2064 $parseCache[$varname] = spotPayload (getConfigVar ($varname), 'SYNT_EXPR');
2065 if ($parseCache[$varname]['result'] != 'ACK')
2066 return FALSE; // constraint set, but cannot be used due to compilation error
212c9d8a 2067 return judgeCell ($cell, $parseCache[$varname]['load']);
c6bc0ac5
DO
2068}
2069
17112e81
DO
2070// Return list of records in the given realm, which conform to
2071// the given RackCode expression. If the realm is unknown or text
2072// doesn't validate as a RackCode expression, return NULL.
2073// Otherwise (successful scan) return a list of all matched
2074// records, even if the list is empty (array() !== NULL). If the
2075// text is an empty string, return all found records in the given
2076// realm.
2077function scanRealmByText ($realm = NULL, $ftext = '')
2078{
2079 switch ($realm)
2080 {
2081 case 'object':
2082 case 'user':
2083 case 'ipv4net':
2084 case 'file':
39776127 2085 case 'ipv4vs':
41780975 2086 case 'ipv4rspool':
17112e81
DO
2087 if (!strlen ($ftext = trim ($ftext)))
2088 $fexpr = array();
2089 else
2090 {
2091 $fparse = spotPayload ($ftext, 'SYNT_EXPR');
2092 if ($fparse['result'] != 'ACK')
2093 return NULL;
2094 $fexpr = $fparse['load'];
2095 }
2096 return filterCellList (listCells ($realm), $fexpr);
2097 default:
c5f84f48 2098 throw new InvalidArgException ('$realm', $realm);
17112e81
DO
2099 }
2100
2101}
39776127
DO
2102
2103function getIPv4VSOptions ()
2104{
2105 $ret = array();
2106 foreach (listCells ('ipv4vs') as $vsid => $vsinfo)
59a83bd8 2107 $ret[$vsid] = $vsinfo['dname'] . (!strlen ($vsinfo['name']) ? '' : " (${vsinfo['name']})");
39776127
DO
2108 return $ret;
2109}
2110
41780975
DO
2111function getIPv4RSPoolOptions ()
2112{
2113 $ret = array();
2114 foreach (listCells ('ipv4rspool') as $pool_id => $poolInfo)
2115 $ret[$pool_id] = $poolInfo['name'];
2116 return $ret;
2117}
2118
d16af52f
DO
2119// Derive a complete cell structure from the given username regardless
2120// if it is a local account or not.
2121function constructUserCell ($username)
2122{
2123 if (NULL !== ($userid = getUserIDByUsername ($username)))
2124 return spotEntity ('user', $userid);
2125 $ret = array
2126 (
2127 'realm' => 'user',
2128 'user_name' => $username,
2129 'user_realname' => '',
2130 'etags' => array(),
2131 'itags' => array(),
d16af52f 2132 );
5689cefd 2133 $ret['atags'] = generateEntityAutoTags ($ret);
d16af52f
DO
2134 return $ret;
2135}
2136
56a797ef
DO
2137// Let's have this debug helper here to enable debugging of process.php w/o interface.php.
2138function dump ($var)
2139{
2140 echo '<div align=left><pre>';
2141 print_r ($var);
2142 echo '</pre></div>';
2143}
2144
9e51318b
DO
2145function getTagChart ($limit = 0, $realm = 'total', $special_tags = array())
2146{
2147 global $taglist;
2148 // first build top-N chart...
2149 $toplist = array();
2150 foreach ($taglist as $taginfo)
2151 if (isset ($taginfo['refcnt'][$realm]))
2152 $toplist[$taginfo['id']] = $taginfo['refcnt'][$realm];
2153 arsort ($toplist, SORT_NUMERIC);
2154 $ret = array();
2155 $done = 0;
2156 foreach (array_keys ($toplist) as $tag_id)
2157 {
2158 $ret[$tag_id] = $taglist[$tag_id];
2159 if (++$done == $limit)
2160 break;
2161 }
2162 // ...then make sure, that every item of the special list is shown
2163 // (using the same sort order)
2164 $extra = array();
2165 foreach ($special_tags as $taginfo)
2166 if (!array_key_exists ($taginfo['id'], $ret))
2167 $extra[$taginfo['id']] = $taglist[$taginfo['id']]['refcnt'][$realm];
2168 arsort ($extra, SORT_NUMERIC);
2169 foreach (array_keys ($extra) as $tag_id)
2170 $ret[] = $taglist[$tag_id];
2171 return $ret;
2172}
2173
7fa7047a
DO
2174function decodeObjectType ($objtype_id, $style = 'r')
2175{
2176 static $types = array();
2177 if (!count ($types))
2178 $types = array
2179 (
2180 'r' => readChapter (CHAP_OBJTYPE),
2181 'a' => readChapter (CHAP_OBJTYPE, 'a'),
2182 'o' => readChapter (CHAP_OBJTYPE, 'o')
2183 );
2184 return $types[$style][$objtype_id];
2185}
2186
0df8c52b
DO
2187function isolatedPermission ($p, $t, $cell)
2188{
2189 // This function is called from both "file" page and a number of other pages,
2190 // which have already fixed security context and authorized the user for it.
2191 // OTOH, it is necessary here to authorize against the current file, which
2192 // means saving the current context and building a new one.
2193 global
2194 $expl_tags,
2195 $impl_tags,
2196 $target_given_tags,
2197 $auto_tags;
2198 // push current context
2199 $orig_expl_tags = $expl_tags;
2200 $orig_impl_tags = $impl_tags;
2201 $orig_target_given_tags = $target_given_tags;
2202 $orig_auto_tags = $auto_tags;
2203 // retarget
2204 fixContext ($cell);
2205 // remember decision
2206 $ret = permitted ($p, $t);
2207 // pop context
2208 $expl_tags = $orig_expl_tags;
2209 $impl_tags = $orig_impl_tags;
2210 $target_given_tags = $orig_target_given_tags;
2211 $auto_tags = $orig_auto_tags;
2212 return $ret;
2213}
2214
3153a326
DO
2215function getPortListPrefs()
2216{
2217 $ret = array();
2218 if (0 >= ($ret['iif_pick'] = getConfigVar ('DEFAULT_PORT_IIF_ID')))
2219 $ret['iif_pick'] = 1;
2220 $ret['oif_picks'] = array();
2221 foreach (explode (';', getConfigVar ('DEFAULT_PORT_OIF_IDS')) as $tmp)
2222 {
2223 $tmp = explode ('=', trim ($tmp));
2224 if (count ($tmp) == 2 and $tmp[0] > 0 and $tmp[1] > 0)
2225 $ret['oif_picks'][$tmp[0]] = $tmp[1];
2226 }
2227 // enforce default value
2228 if (!array_key_exists (1, $ret['oif_picks']))
2229 $ret['oif_picks'][1] = 24;
2230 $ret['selected'] = $ret['iif_pick'] . '-' . $ret['oif_picks'][$ret['iif_pick']];
2231 return $ret;
2232}
2233
2dfa1b73
DO
2234// Return data for printNiftySelect() with port type options. All OIF options
2235// for the default IIF will be shown, but only the default OIFs will be present
2236// for each other IIFs. IIFs, for which there is no default OIF, will not
2237// be listed.
2238// This SELECT will be used for the "add new port" form.
2239function getNewPortTypeOptions()
2240{
2241 $ret = array();
2242 $prefs = getPortListPrefs();
2243 foreach (getPortInterfaceCompat() as $row)
2244 {
2245 if ($row['iif_id'] == $prefs['iif_pick'])
2246 $optgroup = $row['iif_name'];
2247 elseif (array_key_exists ($row['iif_id'], $prefs['oif_picks']) and $prefs['oif_picks'][$row['iif_id']] == $row['oif_id'])
2248 $optgroup = 'other';
2249 else
2250 continue;
2251 if (!array_key_exists ($optgroup, $ret))
2252 $ret[$optgroup] = array();
2253 $ret[$optgroup][$row['iif_id'] . '-' . $row['oif_id']] = $row['oif_name'];
2254 }
2255 return $ret;
2256}
2257
8198f2c6
DO
2258function getVLANDomain ($vdid)
2259{
2260 $ret = getVLANDomainInfo ($vdid);
2261 $ret['vlanlist'] = array();
8198f2c6
DO
2262 foreach (getDomainVLANs ($vdid) as $vlan_id => $vlan_descr)
2263 $ret['vlanlist'][$vlan_id] = $vlan_descr;
2264 $ret['switchlist'] = getVLANDomainSwitches ($vdid);
2265 return $ret;
2266}
2267
2268// Return a serialized version of VLAN configuration for a port.
2269// If a native VLAN is defined, print it first. All other VLANs
d0dadd80
DO
2270// are tagged and are listed after a plus sign. When no configuration
2271// is set for a port, return "default" string.
4f860864 2272function serializeVLANPack ($vlanport)
8198f2c6 2273{
4f860864
DO
2274 if (!array_key_exists ('mode', $vlanport))
2275 return 'error';
2276 switch ($vlanport['mode'])
2277 {
2278 case 'none':
2279 return 'none';
2280 case 'access':
2281 $ret = 'A';
2282 break;
2283 case 'trunk':
2284 $ret = 'T';
2285 break;
36a70b71
DO
2286 case 'uplink':
2287 $ret = 'U';
2288 break;
2289 case 'downlink':
2290 $ret = 'D';
2291 break;
4f860864
DO
2292 default:
2293 return 'error';
2294 }
8198f2c6 2295 $tagged = array();
4f860864
DO
2296 foreach ($vlanport['allowed'] as $vlan_id)
2297 if ($vlan_id != $vlanport['native'])
8198f2c6
DO
2298 $tagged[] = $vlan_id;
2299 sort ($tagged);
4f860864 2300 $ret .= $vlanport['native'] ? $vlanport['native'] : '';
e9be55de
DO
2301 $tagged_bits = array();
2302 $id_from = $id_to = 0;
2303 foreach ($tagged as $next_id)
2304 {
2305 if ($id_to)
2306 {
2307 if ($next_id == $id_to + 1) // merge
2308 {
2309 $id_to = $next_id;
2310 continue;
2311 }
2312 // flush
2313 $tagged_bits[] = $id_from == $id_to ? $id_from : "${id_from}-${id_to}";
2314 }
2315 $id_from = $id_to = $next_id; // start next pair
2316 }
2317 // pull last pair
2318 if ($id_to)
2319 $tagged_bits[] = $id_from == $id_to ? $id_from : "${id_from}-${id_to}";
8198f2c6 2320 if (count ($tagged))
a9953bf1 2321 $ret .= '+' . implode (', ', $tagged_bits);
d0dadd80 2322 return strlen ($ret) ? $ret : 'default';
8198f2c6
DO
2323}
2324
8846b060
DO
2325// Decode VLAN compound key (which is a string formatted DOMAINID-VLANID) and
2326// return the numbers as an array of two.
2327function decodeVLANCK ($string)
2328{
2329 $matches = array();
2330 if (1 != preg_match ('/^([[:digit:]]+)-([[:digit:]]+)$/', $string, $matches))
2331 throw new InvalidArgException ('VLAN compound key', $string);
2332 return array ($matches[1], $matches[2]);
2333}
2334
ce85f5c8
DO
2335// Return VLAN name formatted for HTML output (note, that input
2336// argument comes from database unescaped).
4f860864 2337function formatVLANName ($vlaninfo, $plaintext = FALSE)
ce85f5c8 2338{
4f860864 2339 $ret = ($plaintext ? '' : '<tt>') . 'VLAN' . $vlaninfo['vlan_id'] . ($plaintext ? '' : '</tt>');
ce85f5c8 2340 if (strlen ($vlaninfo['vlan_descr']))
4f860864 2341 $ret .= ' ' . ($plaintext ? '' : '<i>') . '(' . niftyString ($vlaninfo['vlan_descr']) . ')' . ($plaintext ? '' : '</i>');
ce85f5c8
DO
2342 return $ret;
2343}
2344
ef6653b1 2345function ios12ReadVLANConfig ($input)
f10dd5cc 2346{
ef6653b1
DO
2347 $ret = array
2348 (
2349 'vlanlist' => array(),
2350 'portdata' => array(),
2351 );
2352 $procfunc = 'ios12ScanTopLevel';
f10dd5cc
DO
2353 foreach (explode ("\n", $input) as $line)
2354 $procfunc = $procfunc ($ret, $line);
2355 return $ret;
2356}
2357
ef6653b1 2358function ios12ScanTopLevel (&$work, $line)
f10dd5cc
DO
2359{
2360 $matches = array();
ef6653b1
DO
2361 switch (TRUE)
2362 {
d0642bae 2363 case (preg_match ('@^interface ((Ethernet|FastEthernet|GigabitEthernet|TenGigabitEthernet|Port-channel)[[:digit:]]+(/[[:digit:]]+)*)$@', $line, $matches)):
ef6653b1
DO
2364 // map interface name
2365 $matches[1] = preg_replace ('@^Ethernet(.+)$@', 'et\\1', $matches[1]);
2366 $matches[1] = preg_replace ('@^FastEthernet(.+)$@', 'fa\\1', $matches[1]);
2367 $matches[1] = preg_replace ('@^GigabitEthernet(.+)$@', 'gi\\1', $matches[1]);
2368 $matches[1] = preg_replace ('@^TenGigabitEthernet(.+)$@', 'te\\1', $matches[1]);
d0642bae 2369 $matches[1] = preg_replace ('@^Port-channel(.+)$@', 'po\\1', $matches[1]);
ef6653b1
DO
2370 $work['current'] = array ('port_name' => $matches[1]);
2371 return 'ios12PickSwitchportCommand'; // switch to interface block reading
2372 case (preg_match ('/^VLAN Name Status Ports$/', $line, $matches)):
2373 return 'ios12PickVLANCommand';
2374 default:
f10dd5cc 2375 return __FUNCTION__; // continue scan
ef6653b1 2376 }
f10dd5cc
DO
2377}
2378
ef6653b1 2379function ios12PickSwitchportCommand (&$work, $line)
f10dd5cc
DO
2380{
2381 if ($line[0] != ' ') // end of interface section
2382 {
f10dd5cc
DO
2383 // fill in defaults
2384 if (!array_key_exists ('mode', $work['current']))
2385 $work['current']['mode'] = 'access';
2386 if (!array_key_exists ('access vlan', $work['current']))
2387 $work['current']['access vlan'] = 1;
2388 if (!array_key_exists ('trunk native vlan', $work['current']))
2389 $work['current']['trunk native vlan'] = 1;
2390 if (!array_key_exists ('trunk allowed vlan', $work['current']))
2391 $work['current']['trunk allowed vlan'] = range (VLAN_MIN_ID, VLAN_MAX_ID);
2392 // save work, if it makes sense
2393 switch ($work['current']['mode'])
2394 {
2395 case 'access':
ac210c9e 2396 $work['portdata'][$work['current']['port_name']] = array
f10dd5cc 2397 (
4f860864 2398 'mode' => 'access',
f10dd5cc
DO
2399 'allowed' => array ($work['current']['access vlan']),
2400 'native' => $work['current']['access vlan'],
2401 );
2402 break;
2403 case 'trunk':
48c286aa
DO
2404 // Having configured VLAN as "native" doesn't mean anything
2405 // as long as it's not listed on the "allowed" line.
2406 $effective_native = in_array
2407 (
2408 $work['current']['trunk native vlan'],
2409 $work['current']['trunk allowed vlan']
2410 ) ? $work['current']['trunk native vlan'] : 0;
ac210c9e 2411 $work['portdata'][$work['current']['port_name']] = array
f10dd5cc 2412 (
4f860864 2413 'mode' => 'trunk',
e9be55de 2414 'allowed' => $work['current']['trunk allowed vlan'],
48c286aa 2415 'native' => $effective_native,
f10dd5cc
DO
2416 );
2417 break;
2418 default:
2419 // dot1q-tunnel, dynamic, private-vlan --- skip these
2420 }
2421 unset ($work['current']);
ef6653b1 2422 return 'ios12ScanTopLevel';
f10dd5cc
DO
2423 }
2424 // not yet
2425 $matches = array();
2426 switch (TRUE)
2427 {
2428 case (preg_match ('@^ switchport mode (.+)$@', $line, $matches)):
2429 $work['current']['mode'] = $matches[1];
2430 break;
2431 case (preg_match ('@^ switchport access vlan (.+)$@', $line, $matches)):
2432 $work['current']['access vlan'] = $matches[1];
2433 break;
2434 case (preg_match ('@^ switchport trunk native vlan (.+)$@', $line, $matches)):
2435 $work['current']['trunk native vlan'] = $matches[1];
2436 break;
2437 case (preg_match ('@^ switchport trunk allowed vlan add (.+)$@', $line, $matches)):
2438 $work['current']['trunk allowed vlan'] = array_merge
2439 (
2440 $work['current']['trunk allowed vlan'],
2441 iosParseVLANString ($matches[1])
2442 );
2443 break;
2444 case (preg_match ('@^ switchport trunk allowed vlan (.+)$@', $line, $matches)):
2445 $work['current']['trunk allowed vlan'] = iosParseVLANString ($matches[1]);
2446 break;
2447 default: // suppress warning on irrelevant config clause
2448 }
2449 return __FUNCTION__;
2450}
2451
ef6653b1
DO
2452function ios12PickVLANCommand (&$work, $line)
2453{
2454 $matches = array();
2455 switch (TRUE)
2456 {
2457 case ($line == '---- -------------------------------- --------- -------------------------------'):
2458 // ignore the rest of VLAN table header;
2459 break;
2460 case (preg_match ('@! END OF VLAN LIST$@', $line)):
2461 return 'ios12ScanTopLevel';
2462 case (preg_match ('@^([[:digit:]]+) {1,4}.{32} active @', $line, $matches)):
2463 if (!array_key_exists ($matches[1], $work['vlanlist']))
2464 $work['vlanlist'][] = $matches[1];
2465 break;
2466 default:
2467 }
2468 return __FUNCTION__;
2469}
2470
f10dd5cc
DO
2471function iosParseVLANString ($string)
2472{
2473 $ret = array();
2474 foreach (explode (',', $string) as $item)
2475 {
2476 $matches = array();
735e323f 2477 $item = trim ($item, ' ');
f10dd5cc
DO
2478 if (preg_match ('/^([[:digit:]]+)$/', $item, $matches))
2479 $ret[] = $matches[1];
2480 elseif (preg_match ('/^([[:digit:]]+)-([[:digit:]]+)$/', $item, $matches))
2481 $ret = array_merge ($ret, range ($matches[1], $matches[2]));
2482 }
2483 return $ret;
2484}
2485
dbc00990
DO
2486// Another finite automata to read a dialect of Foundry configuration.
2487function fdry5ReadVLANConfig ($input)
2488{
ef6653b1
DO
2489 $ret = array
2490 (
2491 'vlanlist' => array(),
2492 'portdata' => array(),
2493 );
dbc00990
DO
2494 $procfunc = 'fdry5ScanTopLevel';
2495 foreach (explode ("\n", $input) as $line)
2496 $procfunc = $procfunc ($ret, $line);
2497 return $ret;
2498}
2499
2500function fdry5ScanTopLevel (&$work, $line)
2501{
2502 $matches = array();
2503 switch (TRUE)
2504 {
2505 case (preg_match ('@^vlan ([[:digit:]]+)( name .+)? (by port)$@', $line, $matches)):
ef6653b1
DO
2506 if (!array_key_exists ($matches[1], $work['vlanlist']))
2507 $work['vlanlist'][] = $matches[1];
dbc00990
DO
2508 $work['current'] = array ('vlan_id' => $matches[1]);
2509 return 'fdry5PickVLANSubcommand';
2510 case (preg_match ('@^interface ethernet ([[:digit:]]+/[[:digit:]]+/[[:digit:]]+)$@', $line, $matches)):
2511 $work['current'] = array ('port_name' => 'e' . $matches[1]);
2512 return 'fdry5PickInterfaceSubcommand';
2513 default:
2514 return __FUNCTION__;
2515 }
2516}
2517
2518function fdry5PickVLANSubcommand (&$work, $line)
2519{
2520 if ($line[0] != ' ') // end of VLAN section
2521 {
2522 unset ($work['current']);
2523 return 'fdry5ScanTopLevel';
2524 }
2525 // not yet
2526 $matches = array();
2527 switch (TRUE)
2528 {
2529 case (preg_match ('@^ tagged (.+)$@', $line, $matches)):
2530 // add current VLAN to 'allowed' list of each mentioned port
2531 foreach (fdry5ParsePortString ($matches[1]) as $port_name)
ac210c9e
DO
2532 if (array_key_exists ($port_name, $work['portdata']))
2533 $work['portdata'][$port_name]['allowed'][] = $work['current']['vlan_id'];
dbc00990 2534 else
ac210c9e 2535 $work['portdata'][$port_name] = array
dbc00990 2536 (
3dcfd931 2537 'mode' => 'trunk',
dbc00990
DO
2538 'allowed' => array ($work['current']['vlan_id']),
2539 'native' => 0, // can be updated later
2540 );
7b7c07da 2541 $work['portdata'][$port_name]['mode'] = 'trunk';
dbc00990
DO
2542 break;
2543 case (preg_match ('@^ untagged (.+)$@', $line, $matches)):
2544 // replace 'native' column of each mentioned port with current VLAN ID
2545 foreach (fdry5ParsePortString ($matches[1]) as $port_name)
7b7c07da 2546 {
ac210c9e 2547 if (array_key_exists ($port_name, $work['portdata']))
dbc00990 2548 {
ac210c9e
DO
2549 $work['portdata'][$port_name]['native'] = $work['current']['vlan_id'];
2550 $work['portdata'][$port_name]['allowed'][] = $work['current']['vlan_id'];
dbc00990
DO
2551 }
2552 else
ac210c9e 2553 $work['portdata'][$port_name] = array
dbc00990 2554 (
3dcfd931 2555 'mode' => 'access',
dbc00990
DO
2556 'allowed' => array ($work['current']['vlan_id']),
2557 'native' => $work['current']['vlan_id'],
2558 );
7b7c07da
DO
2559 // Untagged ports are initially assumed to be access ports, and
2560 // when this assumption is right, this is the final port mode state.
2561 // When the port is dual-mode one, this is detected and justified
2562 // later in "interface" section of config text.
2563 $work['portdata'][$port_name]['mode'] = 'access';
2564 }
dbc00990
DO
2565 break;
2566 default: // nom-nom
2567 }
2568 return __FUNCTION__;
2569}
2570
2571function fdry5PickInterfaceSubcommand (&$work, $line)
2572{
2573 if ($line[0] != ' ') // end of interface section
2574 {
2575 if (array_key_exists ('dual-mode', $work['current']))
2576 {
ac210c9e 2577 if (array_key_exists ($work['current']['port_name'], $work['portdata']))
dbc00990 2578 // update existing record
ac210c9e 2579 $work['portdata'][$work['current']['port_name']]['native'] = $work['current']['dual-mode'];
dbc00990
DO
2580 else
2581 // add new
ac210c9e 2582 $work['portdata'][$work['current']['port_name']] = array
dbc00990 2583 (
dbc00990
DO
2584 'allowed' => array ($work['current']['dual-mode']),
2585 'native' => $work['current']['dual-mode'],
2586 );
7b7c07da
DO
2587 // a dual-mode port is always considered a trunk port
2588 // (but not in the IronWare's meaning of "trunk") regardless of
2589 // number of assigned tagged VLANs
2590 $work['portdata'][$work['current']['port_name']]['mode'] = 'trunk';
dbc00990
DO
2591 }
2592 unset ($work['current']);
2593 return 'fdry5ScanTopLevel';
2594 }
2595 $matches = array();
2596 switch (TRUE)
2597 {
2598 case (preg_match ('@^ dual-mode( +[[:digit:]]+ *)?$@', $line, $matches)):
2599 // default VLAN ID for dual-mode command is 1
2600 $work['current']['dual-mode'] = strlen (trim ($matches[1])) ? trim ($matches[1]) : 1;
2601 break;
2602 default: // nom-nom
2603 }
2604 return __FUNCTION__;
2605}
2606
2607function fdry5ParsePortString ($string)
2608{
2609 $ret = array();
2610 $tokens = explode (' ', trim ($string));
2611 while (count ($tokens))
2612 {
2613 $letters = array_shift ($tokens); // "ethe", "to"
2614 $numbers = array_shift ($tokens); // "x", "x/x", "x/x/x"
2615 switch ($letters)
2616 {
2617 case 'ethe':
2618 if ($prev_numbers != NULL)
2619 $ret[] = 'e' . $prev_numbers;
2620 $prev_numbers = $numbers;
2621 break;
2622 case 'to':
2623 $ret = array_merge ($ret, fdry5GenPortRange ($prev_numbers, $numbers));
2624 $prev_numbers = NULL; // no action on next token
2625 break;
2626 default: // ???
2627 return array();
2628 }
2629 }
2630 // flush delayed item
2631 if ($prev_numbers != NULL)
2632 $ret[] = 'e' . $prev_numbers;
2633 return $ret;
2634}
2635
2636// Take two indices in form "x", "x/x" or "x/x/x" and return the range of
2637// ports spanning from the first to the last. The switch software makes it
2638// easier to perform, because "ethe x/x/x to y/y/y" ranges never cross
2639// unit/slot boundary (every index except the last remains constant).
2640function fdry5GenPortRange ($from, $to)
2641{
2642 $matches = array();
2643 if (1 !== preg_match ('@^([[:digit:]]+/)?([[:digit:]]+/)?([[:digit:]]+)$@', $from, $matches))
2644 return array();
2645 $prefix = 'e' . $matches[1] . $matches[2];
2646 $from_idx = $matches[3];
2647 if (1 !== preg_match ('@^([[:digit:]]+/)?([[:digit:]]+/)?([[:digit:]]+)$@', $to, $matches))
2648 return array();
2649 $to_idx = $matches[3];
2650 for ($i = $from_idx; $i <= $to_idx; $i++)
2651 $ret[] = $prefix . $i;
2652 return $ret;
2653}
2654
eafdbb42
DO
2655// an implementation for Huawei syntax
2656function vrp53ReadVLANConfig ($input)
2657{
2658 $ret = array
2659 (
2660 'vlanlist' => array(),
2661 'portdata' => array(),
2662 );
2663 $procfunc = 'vrp53ScanTopLevel';
2664 foreach (explode ("\n", $input) as $line)
2665 $procfunc = $procfunc ($ret, $line);
2666 return $ret;
2667}
2668
2669function vrp53ScanTopLevel (&$work, $line)
2670{
2671 $matches = array();
2672 switch (TRUE)
2673 {
2674 case (preg_match ('@^ vlan batch (.+)$@', $line, $matches)):
2675 foreach (vrp53ParseVLANString ($matches[1]) as $vlan_id)
2676 $work['vlanlist'][] = $vlan_id;
2677 return __FUNCTION__;
2678 case (preg_match ('@^interface ((GigabitEthernet|XGigabitEthernet)([[:digit:]]+/[[:digit:]]+/[[:digit:]]+))$@', $line, $matches)):
2679 $matches[1] = preg_replace ('@^GigabitEthernet(.+)$@', 'gi\\1', $matches[1]);
2680 $matches[1] = preg_replace ('@^XGigabitEthernet(.+)$@', 'xg\\1', $matches[1]);
2681 $work['current'] = array ('port_name' => $matches[1]);
2682 return 'vrp53PickInterfaceSubcommand';
2683 default:
2684 return __FUNCTION__;
2685 }
2686}
2687
2688function vrp53ParseVLANString ($string)
2689{
2690 $string = preg_replace ('/ to /', '-', $string);
2691 $string = preg_replace ('/ /', ',', $string);
2692 return iosParseVLANString ($string);
2693}
2694
2695function vrp53PickInterfaceSubcommand (&$work, $line)
2696{
2697 if ($line[0] == '#') // end of interface section
2698 {
2699 // Configuration Guide - Ethernet 3.3.4:
2700 // "By default, the interface type is hybrid."
2701 if (!array_key_exists ('link-type', $work['current']))
2702 $work['current']['link-type'] = 'hybrid';
2703 if (!array_key_exists ('allowed', $work['current']))
2704 $work['current']['allowed'] = array();
2705 if (!array_key_exists ('native', $work['current']))
2706 $work['current']['native'] = 0;
2707 switch ($work['current']['link-type'])
2708 {
2709 case 'access':
2710 $work['portdata'][$work['current']['port_name']] = array
2711 (
1097ebea
DO
2712 'allowed' => $work['current']['allowed'],
2713 'native' => $work['current']['native'],
7b7c07da 2714 'mode' => 'access',
eafdbb42
DO
2715 );
2716 break;
2717 case 'trunk':
2718 $work['portdata'][$work['current']['port_name']] = array
2719 (
2720 'allowed' => $work['current']['allowed'],
2721 'native' => 0,
7b7c07da 2722 'mode' => 'trunk',
eafdbb42
DO
2723 );
2724 break;
2725 case 'hybrid':
2726 $work['portdata'][$work['current']['port_name']] = array
2727 (
2728 'allowed' => $work['current']['allowed'],
2729 'native' => $work['current']['native'],
7b7c07da 2730 'mode' => 'trunk',
eafdbb42
DO
2731 );
2732 break;
2733 default: // dot1q-tunnel ?
2734 }
2735 unset ($work['current']);
2736 return 'vrp53ScanTopLevel';
2737 }
2738 $matches = array();
2739 switch (TRUE)
2740 {
2741 case (preg_match ('@^ port default vlan ([[:digit:]]+)$@', $line, $matches)):
2742 $work['current']['native'] = $matches[1];
2743 if (!array_key_exists ('allowed', $work['current']))
2744 $work['current']['allowed'] = array();
2745 if (!in_array ($matches[1], $work['current']['allowed']))
2746 $work['current']['allowed'][] = $matches[1];
2747 break;
2748 case (preg_match ('@^ port link-type (.+)$@', $line, $matches)):
2749 $work['current']['link-type'] = $matches[1];
2750 break;
2751 case (preg_match ('@^ port trunk allow-pass vlan (.+)$@', $line, $matches)):
2752 if (!array_key_exists ('allowed', $work['current']))
2753 $work['current']['allowed'] = array();
2754 foreach (vrp53ParseVLANString ($matches[1]) as $vlan_id)
2755 if (!in_array ($vlan_id, $work['current']['allowed']))
2756 $work['current']['allowed'][] = $vlan_id;
2757 break;
2758 default: // nom-nom
2759 }
2760 return __FUNCTION__;
2761}
2762
18216a3b
DO
2763function nxos4Read8021QConfig ($input)
2764{
48400875
DO
2765 $ret = array
2766 (
2767 'vlanlist' => array(),
2768 'portdata' => array(),
2769 );
2770 $procfunc = 'nxos4ScanTopLevel';
2771 foreach (explode ("\n", $input) as $line)
2772 $procfunc = $procfunc ($ret, $line);
2773 return $ret;
2774}
2775
2776function nxos4ScanTopLevel (&$work, $line)
2777{
2778 $matches = array();
2779 switch (TRUE)
2780 {
2781 case (preg_match ('@^interface ((Ethernet)[[:digit:]]+(/[[:digit:]]+)*)$@', $line, $matches)):
2782 $matches[1] = preg_replace ('@^Ethernet(.+)$@', 'e\\1', $matches[1]);
2783 $work['current'] = array ('port_name' => $matches[1]);
2784 return 'nxos4PickSwitchportCommand';
2785 case (preg_match ('@^vlan ([[:digit:]]+)$@', $line, $matches)):
2786 $work['vlanlist'][] = $matches[1];
2787 return 'nxos4PickVLANs';
2788 default:
2789 return __FUNCTION__; // continue scan
2790 }
2791}
2792
2793function nxos4PickVLANs (&$work, $line)
2794{
2795 switch (TRUE)
2796 {
2797 case ($line == ''): // end of VLAN list
2798 return 'nxos4ScanTopLevel';
2799 case (preg_match ('@^vlan ([[:digit:]]+)$@', $line, $matches)):
2800 $work['vlanlist'][] = $matches[1];
2801 default: // VLAN name or any other text
2802 return __FUNCTION__;
2803 }
2804}
2805
2806function nxos4PickSwitchportCommand (&$work, $line)
2807{
2808 if ($line == '') // end of interface section
2809 {
2810 // fill in defaults
2811 // below assumes "system default switchport" mode set on the device
2812 if (!array_key_exists ('mode', $work['current']))
2813 $work['current']['mode'] = 'access';
2814 // save work, if it makes sense
2815 switch ($work['current']['mode'])
2816 {
2817 case 'access':
2818 if (!array_key_exists ('access vlan', $work['current']))
2819 $work['current']['access vlan'] = 1;
2820 $work['portdata'][$work['current']['port_name']] = array
2821 (
2822 'mode' => 'access',
2823 'allowed' => array ($work['current']['access vlan']),
2824 'native' => $work['current']['access vlan'],
2825 );
2826 break;
2827 case 'trunk':
2828 if (!array_key_exists ('trunk native vlan', $work['current']))
2829 $work['current']['trunk native vlan'] = 1;
2830 if (!array_key_exists ('trunk allowed vlan', $work['current']))
2831 $work['current']['trunk allowed vlan'] = range (VLAN_MIN_ID, VLAN_MAX_ID);
2832 // Having configured VLAN as "native" doesn't mean anything
2833 // as long as it's not listed on the "allowed" line.
2834 $effective_native = in_array
2835 (
2836 $work['current']['trunk native vlan'],
2837 $work['current']['trunk allowed vlan']
2838 ) ? $work['current']['trunk native vlan'] : 0;
2839 $work['portdata'][$work['current']['port_name']] = array
2840 (
2841 'mode' => 'trunk',
2842 'allowed' => $work['current']['trunk allowed vlan'],
2843 'native' => $effective_native,
2844 );
2845 break;
2846 default:
2847 // dot1q-tunnel, dynamic, private-vlan --- skip these
2848 }
2849 unset ($work['current']);
2850 return 'nxos4ScanTopLevel';
2851 }
2852 // not yet
2853 $matches = array();
2854 switch (TRUE)
2855 {
2856 case (preg_match ('@^ switchport mode (.+)$@', $line, $matches)):
2857 $work['current']['mode'] = $matches[1];
2858 break;
2859 case (preg_match ('@^ switchport access vlan (.+)$@', $line, $matches)):
2860 $work['current']['access vlan'] = $matches[1];
2861 break;
2862 case (preg_match ('@^ switchport trunk native vlan (.+)$@', $line, $matches)):
2863 $work['current']['trunk native vlan'] = $matches[1];
2864 break;
2865 case (preg_match ('@^ switchport trunk allowed vlan add (.+)$@', $line, $matches)):
2866 $work['current']['trunk allowed vlan'] = array_merge
2867 (
2868 $work['current']['trunk allowed vlan'],
2869 iosParseVLANString ($matches[1])
2870 );
2871 break;
2872 case (preg_match ('@^ switchport trunk allowed vlan (.+)$@', $line, $matches)):
2873 $work['current']['trunk allowed vlan'] = iosParseVLANString ($matches[1]);
2874 break;
2875 default: // suppress warning on irrelevant config clause
2876 }
2877 return __FUNCTION__;
18216a3b
DO
2878}
2879
bb35bb93
DO
2880// Scan given array and return the key, which addresses the first item
2881// with requested column set to given value (or NULL if there is none such).
19350222
DO
2882// Note that 0 and NULL mean completely different things and thus
2883// require strict checking (=== and !===).
dbc00990
DO
2884function scanArrayForItem ($table, $scan_column, $scan_value)
2885{
2886 foreach ($table as $key => $row)
2887 if ($row[$scan_column] == $scan_value)
2888 return $key;
2889 return NULL;
2890}
2891
f56f0f20
DO
2892// Get a list of VLAN management pseudo-commands and return a text
2893// of real vendor-specific commands, which implement the work.
3f61f175
DO
2894// This work is done in two rounds:
2895// 1. For "add allowed" and "rem allowed" commands detect continuous
2896// sequences of VLAN IDs and replace them with ranges of form "A-B",
2897// where B>A.
2898// 2. Iterate over the resulting list and produce real CLI commands.
f56f0f20
DO
2899function ios12TranslatePushQueue ($queue)
2900{
3dcfd931 2901 $ret = "configure terminal\n";
cc6a6c4e 2902 foreach ($queue as $cmd)
f56f0f20
DO
2903 switch ($cmd['opcode'])
2904 {
2905 case 'create VLAN':
2906 $ret .= "vlan ${cmd['arg1']}\nexit\n";
2907 break;
2908 case 'destroy VLAN':
2909 $ret .= "no vlan ${cmd['arg1']}\n";
2910 break;
2911 case 'add allowed':
f56f0f20 2912 case 'rem allowed':
cc6a6c4e
DO
2913 $clause = $cmd['opcode'] == 'add allowed' ? 'add' : 'remove';
2914 $ret .= "interface ${cmd['port']}\n";
2915 foreach (listToRanges ($cmd['vlans']) as $range)
2916 $ret .= "switchport trunk allowed vlan ${clause} " .
2917 ($range['from'] == $range['to'] ? $range['to'] : "${range['from']}-${range['to']}") .
2918 "\n";
2919 $ret .= "exit\n";
f56f0f20
DO
2920 break;
2921 case 'set native':
2922 $ret .= "interface ${cmd['arg1']}\nswitchport trunk native vlan ${cmd['arg2']}\nexit\n";
2923 break;
2924 case 'unset native':
2925 $ret .= "interface ${cmd['arg1']}\nno switchport trunk native vlan ${cmd['arg2']}\nexit\n";
2926 break;
3dcfd931
DO
2927 case 'set access':
2928 $ret .= "interface ${cmd['arg1']}\nswitchport access vlan ${cmd['arg2']}\nexit\n";
2929 break;
2930 case 'unset access':
2931 $ret .= "interface ${cmd['arg1']}\nno switchport access vlan\nexit\n";
2932 break;
2933 case 'set mode':
0e353a73
DO
2934 $ret .= "interface ${cmd['arg1']}\nswitchport mode ${cmd['arg2']}\n";
2935 if ($cmd['arg2'] == 'trunk')
2936 $ret .= "no switchport trunk native vlan\nswitchport trunk allowed vlan none\n";
2937 $ret .= "exit\n";
3dcfd931 2938 break;
f56f0f20
DO
2939 }
2940 $ret .= "end\n";
2941 return $ret;
2942}
2943
2944function fdry5TranslatePushQueue ($queue)
2945{
2946 $ret = "conf t\n";
2947 foreach ($queue as $cmd)
2948 switch ($cmd['opcode'])
2949 {
2950 case 'create VLAN':
2951 $ret .= "vlan ${cmd['arg1']}\nexit\n";
2952 break;
2953 case 'destroy VLAN':
2954 $ret .= "no vlan ${cmd['arg1']}\n";
2955 break;
2956 case 'add allowed':
cc6a6c4e
DO
2957 foreach ($cmd['vlans'] as $vlan_id)
2958 $ret .= "vlan ${vlan_id}\ntagged ${cmd['port']}\nexit\n";
f56f0f20
DO
2959 break;
2960 case 'rem allowed':
cc6a6c4e
DO
2961 foreach ($cmd['vlans'] as $vlan_id)
2962 $ret .= "vlan ${vlan_id}\nno tagged ${cmd['port']}\nexit\n";
f56f0f20
DO
2963 break;
2964 case 'set native':
2965 $ret .= "interface ${cmd['arg1']}\ndual-mode ${cmd['arg2']}\nexit\n";
2966 break;
2967 case 'unset native':
2968 $ret .= "interface ${cmd['arg1']}\nno dual-mode ${cmd['arg2']}\nexit\n";
2969 break;
3dcfd931
DO
2970 case 'set access':
2971 $ret .= "vlan ${cmd['arg2']}\nuntagged ${cmd['arg1']}\nexit\n";
2972 break;
2973 case 'unset access':
2974 $ret .= "vlan ${cmd['arg2']}\nno untagged ${cmd['arg1']}\nexit\n";
2975 break;
2976 case 'set mode': // NOP
2977 break;
f56f0f20
DO
2978 }
2979 $ret .= "end\n";
a18c2042 2980 return $ret;
5456f90f
DO
2981}
2982
d74013ee
DO
2983function vrp53TranslatePushQueue ($queue)
2984{
2985 $ret = "system-view\n";
2986 foreach ($queue as $cmd)
2987 switch ($cmd['opcode'])
2988 {
2989 case 'create VLAN':
2990 $ret .= "vlan ${cmd['arg1']}\nquit\n";
2991 break;
2992 case 'destroy VLAN':
2993 $ret .= "undo vlan ${cmd['arg1']}\n";
2994 break;
2995 case 'add allowed':
d74013ee 2996 case 'rem allowed':
cc6a6c4e
DO
2997 $clause = $cmd['opcode'] == 'add allowed' ? '' : 'undo ';
2998 $ret .= "interface ${cmd['port']}\n";
2999 foreach (listToRanges ($cmd['vlans']) as $range)
3000 $ret .= "${clause}port trunk allow-pass vlan " .
3001 ($range['from'] == $range['to'] ? $range['to'] : "${range['from']} to ${range['to']}") .
3002 "\n";
3003 $ret .= "quit\n";
d74013ee
DO
3004 break;
3005 case 'set native':
3dcfd931 3006 case 'set access':
d74013ee
DO
3007 $ret .= "interface ${cmd['arg1']}\nport default vlan ${cmd['arg2']}\nquit\n";
3008 break;
3009 case 'unset native':
3dcfd931 3010 case 'unset access':
d74013ee
DO
3011 $ret .= "interface ${cmd['arg1']}\nundo port default vlan\nquit\n";
3012 break;
3dcfd931
DO
3013 case 'set mode':
3014 $modemap = array ('access' => 'access', 'trunk' => 'hybrid');
0e353a73
DO
3015 $ret .= "interface ${cmd['arg1']}\nport link-type " . $modemap[$cmd['arg2']] . "\n";
3016 if ($cmd['arg2'] == 'hybrid')
3017 $ret .= "undo port default vlan\nundo port trunk allow-pass vlan all\n";
3018 $ret .= "quit\n";
3dcfd931 3019 break;
d74013ee
DO
3020 }
3021 $ret .= "return\n";
3022 return $ret;
3023}
3024
66658512
DO
3025// Return TRUE, if every value of A1 is present in A2 and vice versa,
3026// regardless of each array's sort order and indexing.
3027function array_values_same ($a1, $a2)
3028{
3029 return !count (array_diff ($a1, $a2)) and !count (array_diff ($a2, $a1));
3030}
3031
1ce258f7
DO
3032// Use the VLAN switch template to set VST role for each port of
3033// the provided list. Return resulting list.
bc254f49 3034function apply8021QOrder ($vst_id, $portlist)
25930440 3035{
bc254f49 3036 $vst = getVLANSwitchTemplate ($vst_id);
1ce258f7
DO
3037 foreach (array_keys ($portlist) as $port_name)
3038 {
3039 foreach ($vst['rules'] as $rule)
3040 if (preg_match ($rule['port_pcre'], $port_name))
25930440
DO
3041 {
3042 $portlist[$port_name]['vst_role'] = $rule['port_role'];
091768aa 3043 $portlist[$port_name]['wrt_vlans'] = buildVLANFilter ($rule['port_role'], $rule['wrt_vlans']);
1ce258f7 3044 continue 2;
25930440 3045 }
1ce258f7
DO
3046 $portlist[$port_name]['vst_role'] = 'none';
3047 }
25930440
DO
3048 return $portlist;
3049}
3050
091768aa
DO
3051// return a sequence of ranges for given string form and port role
3052function buildVLANFilter ($role, $string)
be28b696 3053{
091768aa 3054 // set base
1ce258f7 3055 switch ($role)
be28b696 3056 {
1ce258f7
DO
3057 case 'access': // 1-4094
3058 $min = VLAN_MIN_ID;
3059 $max = VLAN_MAX_ID;
3060 break;
3061 case 'trunk': // 2-4094
3062 case 'uplink':
65da0c15 3063 case 'downlink':
1ce258f7
DO
3064 $min = VLAN_MIN_ID + 1;
3065 $max = VLAN_MAX_ID;
3066 break;
65da0c15 3067 default: // none
1ce258f7 3068 return array();
be28b696 3069 }
091768aa
DO
3070 if ($string == '') // fast track
3071 return array (array ('from' => $min, 'to' => $max));
3072 // transform
3073 $vlanidlist = array();
1ce258f7
DO
3074 foreach (iosParseVLANString ($string) as $vlan_id)
3075 if ($min <= $vlan_id and $vlan_id <= $max)
091768aa 3076 $vlanidlist[] = $vlan_id;
cc6a6c4e
DO
3077 return listToRanges ($vlanidlist);
3078}
3079
3080// pack set of integers into list of integer ranges
3081// e.g. (1, 2, 3, 5, 6, 7, 9, 11) => ((1, 3), (5, 7), (9, 9), (11, 11))
3082function listToRanges ($vlanidlist)
3083{
091768aa
DO
3084 sort ($vlanidlist);
3085 $ret = array();
3086 $from = $to = NULL;
3087 foreach ($vlanidlist as $vlan_id)
3088 if ($from == NULL)
3089 $from = $to = $vlan_id;
3090 elseif ($to + 1 == $vlan_id)
3091 $to = $vlan_id;
3092 else
3093 {
3094 $ret[] = array ('from' => $from, 'to' => $to);
3095 $from = $to = $vlan_id;
3096 }
3097 if ($from != NULL)
3098 $ret[] = array ('from' => $from, 'to' => $to);
be28b696
DO
3099 return $ret;
3100}
3101
091768aa
DO
3102// return TRUE, if given VLAN ID belongs to one of filter's ranges
3103function matchVLANFilter ($vlan_id, $vfilter)
3104{
3105 foreach ($vfilter as $range)
3106 if ($range['from'] <= $vlan_id and $vlan_id <= $range['to'])
3107 return TRUE;
3108 return FALSE;
3109}
3110
bcd14540
DO
3111function exportSwitch8021QConfig
3112(
3113 $vswitch,
3114 $device_vlanlist,
3115 $before,
3116 $changes
3117)
3118{
3119 // only ignore VLANs, which exist and are explicitly shown as "alien"
3120 $old_managed_vlans = array();
3121 $domain_vlanlist = getDomainVLANs ($vswitch['domain_id']);
3122 foreach ($device_vlanlist as $vlan_id)
3123 if
3124 (
3125 !array_key_exists ($vlan_id, $domain_vlanlist) or
3126 $domain_vlanlist[$vlan_id]['vlan_type'] != 'alien'
3127 )
3128 $old_managed_vlans[] = $vlan_id;
3129 $ports_to_do = array();
3130 $after = $before;
3131 foreach ($changes as $port_name => $port)
3132 {
3133 $ports_to_do[$port_name] = array
3134 (
3135 'old_mode' => $before[$port_name]['mode'],
3136 'old_allowed' => $before[$port_name]['allowed'],
3137 'old_native' => $before[$port_name]['native'],
3138 'new_mode' => $port['mode'],
3139 'new_allowed' => $port['allowed'],
3140 'new_native' => $port['native'],
3141 );
3142 $after[$port_name] = $port;
3143 }
3144 // New VLAN table is a union of:
3145 // 1. all compulsory VLANs
3146 // 2. all "current" non-alien allowed VLANs of those ports, which are left
3147 // intact (regardless if a VLAN exists in VLAN domain, but looking,
3148 // if it is present in device's own VLAN table)
3149 // 3. all "new" allowed VLANs of those ports, which we do "push" now
3150 // Like for old_managed_vlans, a VLANs is never listed, only if it
3151 // exists and belongs to "alien" type.
3152 $new_managed_vlans = array();
3153 // 1
3154 foreach ($domain_vlanlist as $vlan_id => $vlan)
3155 if ($vlan['vlan_type'] == 'compulsory')
3156 $new_managed_vlans[] = $vlan_id;
3157 // 2
3158 foreach ($before as $port_name => $port)
3159 if (!array_key_exists ($port_name, $changes))
3160 foreach ($port['allowed'] as $vlan_id)
3161 {
3162 if (in_array ($vlan_id, $new_managed_vlans))
3163 continue;
3164 if
3165 (
3166 array_key_exists ($vlan_id, $domain_vlanlist) and
3167 $domain_vlanlist[$vlan_id]['vlan_type'] == 'alien'
3168 )
3169 continue;
3170 if (in_array ($vlan_id, $device_vlanlist))
3171 $new_managed_vlans[] = $vlan_id;
3172 }
3173 // 3
3174 foreach ($changes as $port)
10b6b476 3175 foreach ($port['allowed'] as $vlan_id)
bcd14540
DO
3176 if
3177 (
3178 $domain_vlanlist[$vlan_id]['vlan_type'] == 'ondemand' and
3179 !in_array ($vlan_id, $new_managed_vlans)
3180 )
3181 $new_managed_vlans[] = $vlan_id;
3182 $crq = array();
3183 // Before removing each old VLAN as such it is necessary to unassign
3184 // ports from it (to remove VLAN from each ports' list of "allowed"
3185 // VLANs). This change in turn requires, that a port's "native"
3186 // VLAN isn't set to the one being removed from its "allowed" list.
3187 foreach ($ports_to_do as $port_name => $port)
3188 switch ($port['old_mode'] . '->' . $port['new_mode'])
3189 {
3190 case 'trunk->trunk':
3191 // "old" native is set and differs from the "new" native
3192 if ($port['old_native'] and $port['old_native'] != $port['new_native'])
3193 $crq[] = array
3194 (
3195 'opcode' => 'unset native',
3196 'arg1' => $port_name,
3197 'arg2' => $port['old_native'],
3198 );
cc6a6c4e 3199 if (count ($tmp = array_diff ($port['old_allowed'], $port['new_allowed'])))
bcd14540
DO
3200 $crq[] = array
3201 (
3202 'opcode' => 'rem allowed',
cc6a6c4e
DO
3203 'port' => $port_name,
3204 'vlans' => $tmp,
bcd14540
DO
3205 );
3206 break;
3207 case 'access->access':
3208 if ($port['old_native'] and $port['old_native'] != $port['new_native'])
3209 $crq[] = array
3210 (
3211 'opcode' => 'unset access',
3212 'arg1' => $port_name,
3213 'arg2' => $port['old_native'],
3214 );
3215 break;
3216 case 'access->trunk':
3217 $crq[] = array
3218 (
3219 'opcode' => 'unset access',
3220 'arg1' => $port_name,
3221 'arg2' => $port['old_native'],
3222 );
3223 break;
3224 case 'trunk->access':
3225 $crq[] = array
3226 (
3227 'opcode' => 'unset native',
3228 'arg1' => $port_name,
3229 'arg2' => $port['old_native'],
3230 );
cc6a6c4e 3231 if (count ($port['old_allowed']))
bcd14540
DO
3232 $crq[] = array
3233 (
3234 'opcode' => 'rem allowed',
cc6a6c4e
DO
3235 'port' => $port_name,
3236 'vlans' => $port['old_allowed'],
bcd14540
DO
3237 );
3238 break;
3239 default:
3240 throw new RuntimeException ('error in ports_to_do structure');
3241 }
3242 // Now it is safe to unconfigure VLANs, which still exist on device,
3243 // but are not present on the "new" list.
3244 // FIXME: put all IDs into one pseudo-command to make it easier
3245 // for translators to create/destroy VLANs in batches, where
3246 // target platform allows them to do.
3247 foreach (array_diff ($old_managed_vlans, $new_managed_vlans) as $vlan_id)
3248 $crq[] = array
3249 (
3250 'opcode' => 'destroy VLAN',
3251 'arg1' => $vlan_id,
3252 );
3253 // Configure VLANs, which must be present on the device, but are not yet.
3254 foreach (array_diff ($new_managed_vlans, $old_managed_vlans) as $vlan_id)
3255 $crq[] = array
3256 (
3257 'opcode' => 'create VLAN',
3258 'arg1' => $vlan_id,
3259 );
3260 // Now, when all new VLANs are created (queued), it is safe to assign (queue)
3261 // ports to the new VLANs.
3262 foreach ($ports_to_do as $port_name => $port)
3263 switch ($port['old_mode'] . '->' . $port['new_mode'])
3264 {
3265 case 'trunk->trunk':
3266 // For each allowed VLAN, which is present on the "new" list and missing from
3267 // the "old" one, queue a command to assign current port to that VLAN.
cc6a6c4e 3268 if (count ($tmp = array_diff ($port['new_allowed'], $port['old_allowed'])))
bcd14540
DO
3269 $crq[] = array
3270 (
3271 'opcode' => 'add allowed',
cc6a6c4e
DO
3272 'port' => $port_name,
3273 'vlans' => $tmp,
bcd14540
DO
3274 );
3275 // One of the "allowed" VLANs for this port may probably be "native".
3276 // "new native" is set and differs from "old native"
3277 if ($port['new_native'] and $port['new_native'] != $port['old_native'])
3278 $crq[] = array
3279 (
3280 'opcode' => 'set native',
3281 'arg1' => $port_name,
3282 'arg2' => $port['new_native'],
3283 );
3284 break;
3285 case 'access->access':
3286 if ($port['new_native'] and $port['new_native'] != $port['old_native'])
3287 $crq[] = array
3288 (
3289 'opcode' => 'set access',
3290 'arg1' => $port_name,
3291 'arg2' => $port['new_native'],
3292 );
3293 break;
3294 case 'access->trunk':
3295 $crq[] = array
3296 (
3297 'opcode' => 'set mode',
3298 'arg1' => $port_name,
3299 'arg2' => $port['new_mode'],
3300 );
cc6a6c4e 3301 if (count ($port['new_allowed']))
bcd14540
DO
3302 $crq[] = array
3303 (
3304 'opcode' => 'add allowed',
cc6a6c4e
DO
3305 'port' => $port_name,
3306 'vlans' => $port['new_allowed'],
bcd14540
DO
3307 );
3308 $crq[] = array
3309 (
3310 'opcode' => 'set native',
3311 'arg1' => $port_name,
3312 'arg2' => $port['new_native'],
3313 );
3314 break;
3315 case 'trunk->access':
3316 $crq[] = array
3317 (
3318 'opcode' => 'set mode',
3319 'arg1' => $port_name,
3320 'arg2' => $port['new_mode'],
3321 );
3322 $crq[] = array
3323 (
3324 'opcode' => 'set access',
3325 'arg1' => $port_name,
3326 'arg2' => $port['new_native'],
3327 );
3328 break;
3329 default:
3330 throw new RuntimeException ('error in ports_to_do structure');
3331 }
3332 setDevice8021QConfig ($vswitch['object_id'], $crq);
3333 return count ($crq);
3334}
3335
af204724 3336// filter list of changed ports to cancel changes forbidden by VST and domain
af204724
DO
3337function filter8021QChangeRequests
3338(
3339 $domain_vlanlist,
3340 $before, // current saved configuration of all ports
3341 $changes // changed ports with VST markup
3342)
3343{
3344 $domain_immune_vlans = array();
3345 foreach ($domain_vlanlist as $vlan_id => $vlan)
3346 if ($vlan['vlan_type'] == 'alien')
3347 $domain_immune_vlans[] = $vlan_id;
3348 $ret = array();
3349 foreach ($changes as $port_name => $port)
3350 {
af204724 3351 // find and cancel any changes regarding immune VLANs
034a61c9
DO
3352 switch ($port['vst_role'])
3353 {
3354 case 'access':
3355 if ($port['mode'] != 'access') // VST violation
3356 continue 2; // ignore change request
3357 foreach ($domain_immune_vlans as $immune)
af204724
DO
3358 // Reverting an attempt to set an access port from
3359 // "normal" VLAN to immune one (or vice versa) requires
3360 // special handling, becase the calling function has
3361 // discarded the old contents of 'allowed' for current port.
af204724
DO
3362 if
3363 (
3364 $before[$port_name]['native'] == $immune or
3365 $port['native'] == $immune
3366 )
3367 {
3368 $port['native'] = $before[$port_name]['native'];
3369 $port['allowed'] = array ($port['native']);
034a61c9
DO
3370 // Such reversal happens either once or never for an
3371 // access port.
3372 break;
af204724 3373 }
034a61c9
DO
3374 break;
3375 case 'trunk':
3376 case 'uplink':
3377 case 'downlink':
3378 if ($port['mode'] != 'trunk')
3379 continue 2;
3380 foreach ($domain_immune_vlans as $immune)
af204724
DO
3381 if (in_array ($immune, $before[$port_name]['allowed'])) // was allowed before
3382 {
3383 if (!in_array ($immune, $port['allowed']))
3384 $port['allowed'][] = $immune; // restore
3385 if ($before[$port_name]['native'] == $immune) // and was native
3386 $port['native'] = $immune; // also restore
3387 }
3388 else // wasn't
3389 {
3390 if (in_array ($immune, $port['allowed']))
3391 unset ($port['allowed'][array_search ($immune, $port['allowed'])]); // cancel
3392 if ($port['native'] == $immune)
3393 $port['native'] = $before[$port_name]['native'];
3394 }
034a61c9
DO
3395 break;
3396 default:
3397 continue 2;
3398 }
3399 // save work
af204724
DO
3400 $ret[$port_name] = $port;
3401 }
3402 return $ret;
3403}
3404
4741e9c3 3405// take port list with order applied and return uplink ports in the same format
ca7f0af4 3406function produceUplinkPorts ($domain_vlanlist, $portlist)
4741e9c3
DO
3407{
3408 $ret = array();
ca7f0af4
DO
3409 $employed = array();
3410 foreach ($domain_vlanlist as $vlan_id => $vlan)
3411 if ($vlan['vlan_type'] == 'compulsory')
3412 $employed[] = $vlan_id;
3413 foreach ($portlist as $port_name => $port)
3414 if ($port['vst_role'] != 'uplink')
3415 foreach ($port['allowed'] as $vlan_id)
3416 if (!in_array ($vlan_id, $employed))
3417 $employed[] = $vlan_id;
3418 foreach ($portlist as $port_name => $port)
3419 if ($port['vst_role'] == 'uplink')
3420 {
1ce258f7
DO
3421 $employed_here = array();
3422 foreach ($employed as $vlan_id)
091768aa 3423 if (matchVLANFilter ($vlan_id, $port['wrt_vlans']))
1ce258f7 3424 $employed_here[] = $vlan_id;
ca7f0af4
DO
3425 $ret[$port_name] = array
3426 (
034a61c9 3427 'vst_role' => 'uplink',
ca7f0af4
DO
3428 'mode' => 'trunk',
3429 'allowed' => $employed_here,
3430 'native' => 0,
3431 );
3432 }
4741e9c3
DO
3433 return $ret;
3434}
3435
9c45ea37
DO
3436function same8021QConfigs ($a, $b)
3437{
3438 return $a['mode'] == $b['mode'] &&
3439 array_values_same ($a['allowed'], $b['allowed']) &&
3440 $a['native'] == $b['native'];
3441}
3442
26dec09b
DO
3443/*
3444
3445Relation between desired (D), cached (C) and running (R)
3446copies of switch ports (P) list.
3447
3448 D C R
3449+---+ +---+ +---+
3450| P |-----| P |-? +--| P |
3451+---+ +---+ / +---+
3452| P |-----| P |--+ ?-| P |
3453+---+ +---+ +---+
3454| P |-----| P |-------| P |
3455+---+ +---+ +---+
3456| P |-----| P |--+ ?-| P |
3457+---+ +---+ \ +---+
3458| P |-----| P |--+ +--| P |
3459+---+ +---+ \ +---+
3460 +--| P |
3461 +---+
3462 ?-| P |
3463 +---+
3464
3465A modified local version of a port in "conflict" state ignores remote
3466changes until remote change maintains its difference. Once both edits
3467match, the local copy "locks" on the remote and starts tracking it.
3468
3469v
3470a "o" -- remOte version
3471l "l" -- Local version
3472u "b" -- Both versions
3473e
3474
3475^
3476| o b
3477| o
3478| l l l l l l b b
3479| o o b
3480| o b
3481|
3482| o
3483|
3484|
34850----------------------------------------------> time
3486
3487*/
be28b696
DO
3488function get8021QSyncOptions
3489(
3490 $vswitch,
3491 $D, // desired config
3492 $C, // cached config
3493 $R // running-config
3494)
3495{
3496 $default_port = array
3497 (
3498 'mode' => 'access',
3499 'allowed' => array (VLAN_DFL_ID),
3500 'native' => VLAN_DFL_ID,
3501 );
ab25b0d0 3502 $ret = array();
24832534 3503 $allports = array();
ab25b0d0 3504 foreach (array_unique (array_merge (array_keys ($C), array_keys ($R))) as $pn)
d3082829
DO
3505 $allports[$pn] = array();
3506 foreach (apply8021QOrder ($vswitch['template_id'], $allports) as $pn => $port)
be28b696 3507 {
26dec09b
DO
3508 // (DC_): port missing from device
3509 if (!array_key_exists ($pn, $R))
be28b696 3510 {
ef016293
DO
3511 $ret[$pn] = array ('left' => $D[$pn]);
3512 if (same8021QConfigs ($D[$pn], $default_port))
3513 $ret[$pn]['status'] = 'ok_to_delete';
3514 else
3515 {
3516 $ret[$pn]['status'] = 'delete_conflict';
3517 $ret[$pn]['lastseen'] = $C[$pn];
3518 }
be28b696
DO
3519 continue;
3520 }
26dec09b
DO
3521 // (__R): port missing from DB
3522 if (!array_key_exists ($pn, $C))
be28b696 3523 {
ab25b0d0
DO
3524 $ret[$pn] = array
3525 (
3526 'status' => 'ok_to_add',
3527 'right' => $R[$pn],
3528 );
be28b696
DO
3529 continue;
3530 }
3531 $D_eq_C = same8021QConfigs ($D[$pn], $C[$pn]);
3532 $C_eq_R = same8021QConfigs ($C[$pn], $R[$pn]);
26dec09b 3533 // (DCR), D = C = R: data in sync
be28b696 3534 if ($D_eq_C and $C_eq_R) // implies D == R
ab25b0d0
DO
3535 {
3536 $ret[$pn] = array
3537 (
3538 'status' => 'in_sync',
3539 'both' => $R[$pn],
3540 );
be28b696 3541 continue;
ab25b0d0 3542 }
26dec09b 3543 // (DCR), D = C: no local edit in the way
be28b696 3544 if ($D_eq_C)
ab25b0d0
DO
3545 $ret[$pn] = array
3546 (
3547 'status' => 'ok_to_pull',
3548 'left' => $D[$pn],
3549 'right' => $R[$pn],
3550 );
26dec09b 3551 // (DCR), C = R: no remote edit in the way
be28b696 3552 elseif ($C_eq_R)
ab25b0d0
DO
3553 $ret[$pn] = array
3554 (
3555 'status' => 'ok_to_push',
3556 'left' => $D[$pn],
3557 'right' => $R[$pn],
3558 );
26dec09b 3559 // (DCR), D = R: end of version conflict, restore tracking
be28b696 3560 elseif (same8021QConfigs ($D[$pn], $R[$pn]))
ab25b0d0
DO
3561 $ret[$pn] = array
3562 (
d973196a 3563 'status' => 'ok_to_merge',
ab25b0d0
DO
3564 'both' => $R[$pn],
3565 );
26dec09b 3566 else // D != C, C != R, D != R: version conflict
ab25b0d0
DO
3567 $ret[$pn] = array
3568 (
d3082829
DO
3569 'status' => ($port['vst_role'] == 'access' or $port['vst_role'] == 'trunk') ?
3570 // In case the port is normally updated by user, let him
3571 // resolve the conflict. If the system manages this port,
3572 // arrange the data to let remote version go down.
3573 'merge_conflict' : 'ok_to_push_with_merge',
ab25b0d0
DO
3574 'left' => $D[$pn],
3575 'right' => $R[$pn],
3576 );
be28b696 3577 }
ab25b0d0 3578 return $ret;
be28b696
DO
3579}
3580
ca5d4cbc 3581// return number of records updated successfully of FALSE, if a conflict was in the way
d973196a 3582function exec8021QDeploy ($object_id, $do_push)
ca5d4cbc
DO
3583{
3584 global $dbxlink;
b3a27170 3585 $nsaved = $npushed = $nsaved_uplinks = 0;
ca5d4cbc
DO
3586 $dbxlink->beginTransaction();
3587 if (NULL === $vswitch = getVLANSwitchInfo ($object_id, 'FOR UPDATE'))
3588 throw new InvalidArgException ('object_id', $object_id, 'VLAN domain is not set for this object');
3589 $D = getStored8021QConfig ($vswitch['object_id'], 'desired');
3590 $C = getStored8021QConfig ($vswitch['object_id'], 'cached');
d973196a
DO
3591 try
3592 {
3593 $R = getRunning8021QConfig ($vswitch['object_id']);
3594 }
3595 catch (Exception $e)
3596 {
3597 $prepared = $dbxlink->prepare ("UPDATE VLANSwitch SET last_errno = ?, last_error_ts = NOW() WHERE object_id = ?");
3598 $prepared->execute (array (E_8021Q_PULL_REMOTE_ERROR, $vswitch['object_id']));
3599 $dbxlink->commit();
3600 return 0;
3601 }
ca5d4cbc 3602 $conflict = FALSE;
ca5d4cbc 3603 $ok_to_push = array();
d973196a 3604 foreach (get8021QSyncOptions ($vswitch, $D, $C, $R['portdata']) as $pn => $port)
ca5d4cbc
DO
3605 {
3606 // always update cache with new data from switch
3607 switch ($port['status'])
3608 {
d973196a
DO
3609 case 'ok_to_merge':
3610 upd8021QPort ('cached', $vswitch['object_id'], $pn, $port['both']);
ca5d4cbc
DO
3611 break;
3612 case 'ok_to_delete':
d973196a 3613 $nsaved += del8021QPort ($vswitch['object_id'], $pn);
ca5d4cbc
DO
3614 break;
3615 case 'ok_to_add':
d973196a 3616 $nsaved += add8021QPort ($vswitch['object_id'], $pn, $port['right']);
ca5d4cbc
DO
3617 break;
3618 case 'delete_conflict':
3619 case 'merge_conflict':
3620 $conflict = TRUE;
3621 break;
3622 case 'ok_to_pull':
d973196a
DO
3623 upd8021QPort ('desired', $vswitch['object_id'], $pn, $port['right']);
3624 upd8021QPort ('cached', $vswitch['object_id'], $pn, $port['right']);
3625 $nsaved++;
ca5d4cbc 3626 break;
d3082829
DO
3627 case 'ok_to_push_with_merge':
3628 upd8021QPort ('cached', $vswitch['object_id'], $pn, $port['right']);
3629 // fall through
ca5d4cbc
DO
3630 case 'ok_to_push':
3631 $ok_to_push[$pn] = $port['left'];
3632 break;
3633 }
3634 }
32c7fad1
DO
3635 // redo uplinks unconditionally
3636 $domain_vlanlist = getDomainVLANs ($vswitch['domain_id']);
3637 $Dnew = apply8021QOrder ($vswitch['template_id'], getStored8021QConfig ($vswitch['object_id'], 'desired'));
034a61c9
DO
3638 // Take new "desired" configuration and derive uplink port configuration
3639 // from it. Then cancel changes to immune VLANs and save resulting
3640 // changes (if any left).
3641 $new_uplinks = filter8021QChangeRequests ($domain_vlanlist, $Dnew, produceUplinkPorts ($domain_vlanlist, $Dnew));
b3a27170
DO
3642 $nsaved_uplinks += replace8021QPorts ('desired', $vswitch['object_id'], $Dnew, $new_uplinks);
3643 if ($nsaved + $nsaved_uplinks)
94080e1c 3644 {
32c7fad1
DO
3645 // saved configuration has changed (either "user" ports have changed,
3646 // or uplinks, or both), so bump revision number up)
d973196a 3647 $prepared = $dbxlink->prepare ('UPDATE VLANSwitch SET mutex_rev = mutex_rev + 1, last_change = NOW(), out_of_sync = "yes" WHERE object_id = ?');
94080e1c 3648 $prepared->execute (array ($vswitch['object_id']));
ca5d4cbc 3649 }
d973196a 3650 if ($conflict)
ca5d4cbc 3651 {
d973196a
DO
3652 $prepared = $dbxlink->prepare ("UPDATE VLANSwitch SET last_errno = ?, last_error_ts = NOW() WHERE object_id = ?");
3653 $prepared->execute (array (E_8021Q_VERSION_CONFLICT, $vswitch['object_id']));
3654 }
52ce8bd7 3655 else
d973196a 3656 {
52ce8bd7
DO
3657 $prepared = $dbxlink->prepare ("UPDATE VLANSwitch SET last_errno = ?, last_error_ts = NOW() WHERE object_id = ?");
3658 $prepared->execute (array (E_8021Q_NOERROR, $vswitch['object_id']));
4799a8df
DO
3659 // Modified uplinks are very likely to differ from those in R-copy,
3660 // so don't mark device as clean, if this happened. This can cost
3661 // us an additional, empty round of sync, but at least out_of_sync
3662 // won't be mistakenly set to 'no'.
3663 // FIXME: A cleaner way of coupling pull and push operations would
3664 // be to split this function into two.
3665 if (!count ($ok_to_push) and !$nsaved_uplinks)
ca5d4cbc 3666 {
52ce8bd7 3667 $prepared = $dbxlink->prepare ("UPDATE VLANSwitch SET out_of_sync = 'no' WHERE object_id = ?");
d973196a
DO
3668 $prepared->execute (array ($vswitch['object_id']));
3669 }
52ce8bd7 3670 elseif ($do_push)
d973196a 3671 {
52ce8bd7
DO
3672 $prepared = $dbxlink->prepare ("UPDATE VLANSwitch SET last_push_started = NOW() WHERE object_id = ?");
3673 $prepared->execute (array ($vswitch['object_id']));
3674 try
3675 {
3676 $npushed += exportSwitch8021QConfig ($vswitch, $R['vlanlist'], $R['portdata'], $ok_to_push);
3677 // update cache for ports deployed
3678 replace8021QPorts ('cached', $vswitch['object_id'], $R['portdata'], $ok_to_push);
3679 $prepared = $dbxlink->prepare ('UPDATE VLANSwitch SET last_push_finished = NOW(), out_of_sync = "no", last_errno = ? WHERE object_id = ?');
3680 $prepared->execute (array (E_8021Q_NOERROR, $vswitch['object_id']));
3681 }
3682 catch (RuntimeException $r)
3683 {
3684 $prepared = $dbxlink->prepare ("UPDATE VLANSwitch SET last_error_ts = NOW(), last_errno = ? WHERE object_id = ?");
3685 $prepared->execute (E_8021Q_PUSH_REMOTE_ERROR, array ($vswitch['object_id']));
3686 }
ca5d4cbc
DO
3687 }
3688 }
3689 $dbxlink->commit();
b3a27170
DO
3690 // start downlink work only after unlocking current object to make deadlocks less likely to happen
3691 // TODO: only process changed uplink ports
3692 if ($nsaved_uplinks)
3693 initiateUplinksReverb ($vswitch['object_id'], $new_uplinks);
3694 return $nsaved + $npushed + $nsaved_uplinks;
ca5d4cbc
DO
3695}
3696
be28b696
DO
3697// print part of HTML HEAD block
3698function printPageHeaders ()
3699{
3700 global $pageheaders;
3701 ksort ($pageheaders);
3702 foreach ($pageheaders as $s)
3703 echo $s . "\n";
3704 echo "<style type='text/css'>\n";
3705 foreach (array ('F', 'A', 'U', 'T', 'Th', 'Tw', 'Thw') as $statecode)
3706 {
3707 echo "td.state_${statecode} {\n";
3708 echo "\ttext-align: center;\n";
3709 echo "\tbackground-color: #" . (getConfigVar ('color_' . $statecode)) . ";\n";
3710 echo "\tfont: bold 10px Verdana, sans-serif;\n";
3711 echo "}\n\n";
3712 }
3713 echo '</style>';
3714}
3715
538d9cf8
DO
3716function strerror8021Q ($errno)
3717{
3718 switch ($errno)
3719 {
57acf3f5
DO
3720 case E_8021Q_VERSION_CONFLICT:
3721 return 'pull failed due to version conflict';
3722 case E_8021Q_PULL_REMOTE_ERROR:
3723 return 'pull failed due to remote error';
3724 case E_8021Q_PUSH_REMOTE_ERROR:
3725 return 'push failed due to remote error';
5701baec
DO
3726 case E_8021Q_SYNC_DISABLED:
3727 return 'sync disabled by operator';
57acf3f5
DO
3728 default:
3729 return "unknown error code ${errno}";
538d9cf8
DO
3730 }
3731}
3732
0c1674ae
DO
3733function saveDownlinksReverb ($object_id, $requested_changes)
3734{
3735 $nsaved = 0;
3736 global $dbxlink;
3737 $dbxlink->beginTransaction();
b3a27170
DO
3738 if (NULL === $vswitch = getVLANSwitchInfo ($object_id, 'FOR UPDATE')) // not configured, bail out
3739 {
3740 $dbxlink->rollBack();
3741 return;
3742 }
0c1674ae
DO
3743 $domain_vlanlist = getDomainVLANs ($vswitch['domain_id']);
3744 // aplly VST to the smallest set necessary
3745 $requested_changes = apply8021QOrder ($vswitch['template_id'], $requested_changes);
3746 $before = getStored8021QConfig ($object_id, 'desired');
3747 $changes_to_save = array();
3748 // first filter by wrt_vlans constraint
3749 foreach ($requested_changes as $pn => $requested)
3750 if (array_key_exists ($pn, $before) and $requested['vst_role'] == 'downlink')
3751 {
3752 $negotiated = array
3753 (
3754 'vst_role' => 'downlink',
3755 'mode' => 'trunk',
3756 'allowed' => array(),
3757 'native' => 0,
3758 );
3759 // wrt_vlans filter
3760 foreach ($requested['allowed'] as $vlan_id)
091768aa 3761 if (matchVLANFilter ($vlan_id, $requested['wrt_vlans']))
0c1674ae
DO
3762 $negotiated['allowed'][] = $vlan_id;
3763 $changes_to_save[$pn] = $negotiated;
3764 }
3765 // immune VLANs filter
3766 foreach (filter8021QChangeRequests ($domain_vlanlist, $before, $changes_to_save) as $pn => $finalconfig)
3767 if (!same8021QConfigs ($finalconfig, $before[$pn]))
3768 $nsaved += upd8021QPort ('desired', $vswitch['object_id'], $pn, $finalconfig);
3769 if ($nsaved)
3770 {
3771 $prepared = $dbxlink->prepare ('UPDATE VLANSwitch SET mutex_rev = mutex_rev + 1, last_change = NOW(), out_of_sync = "yes" WHERE object_id = ?');
3772 $prepared->execute (array ($vswitch['object_id']));
3773 }
3774 $dbxlink->commit();
3775}
3776
b3a27170
DO
3777// Use records from Port and Link tables to run a series of tasks on remote
3778// objects. These device-specific tasks will adjust downlink ports according to
3779// the current configuration of given uplink ports.
3780function initiateUplinksReverb ($object_id, $uplink_ports)