r3620 add 8021Q_WRI_AFTER_CONFT option, justify other 802.1Q options
[racktables] / inc / functions.php
1 <?php
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
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
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
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
119 // This function assures that specified argument was passed
120 // and is a number greater than zero.
121 function assertUIntArg ($argname, $allow_zero = FALSE)
122 {
123 if (!isset ($_REQUEST[$argname]))
124 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'parameter is missing');
125 if (!is_numeric ($_REQUEST[$argname]))
126 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'parameter is not a number');
127 if ($_REQUEST[$argname] < 0)
128 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'parameter is less than zero');
129 if (!$allow_zero and $_REQUEST[$argname] == 0)
130 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'parameter is zero');
131 }
132
133 // This function assures that specified argument was passed
134 // and is a non-empty string.
135 function assertStringArg ($argname, $ok_if_empty = FALSE)
136 {
137 if (!isset ($_REQUEST[$argname]))
138 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'parameter is missing');
139 if (!is_string ($_REQUEST[$argname]))
140 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'parameter is not a string');
141 if (!$ok_if_empty and !strlen ($_REQUEST[$argname]))
142 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'parameter is an empty string');
143 }
144
145 function assertBoolArg ($argname, $ok_if_empty = FALSE)
146 {
147 if (!isset ($_REQUEST[$argname]))
148 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'parameter is missing');
149 if (!is_string ($_REQUEST[$argname]) or $_REQUEST[$argname] != 'on')
150 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'parameter is not a string');
151 if (!$ok_if_empty and !strlen ($_REQUEST[$argname]))
152 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'parameter is an empty string');
153 }
154
155 function assertIPv4Arg ($argname, $ok_if_empty = FALSE)
156 {
157 assertStringArg ($argname, $ok_if_empty);
158 if (strlen ($_REQUEST[$argname]) and long2ip (ip2long ($_REQUEST[$argname])) !== $_REQUEST[$argname])
159 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'parameter is not a valid ipv4 address');
160 }
161
162 function assertPCREArg ($argname)
163 {
164 assertStringArg ($argname, TRUE); // empty pattern is Ok
165 if (FALSE === preg_match ($_REQUEST[$argname], 'test'))
166 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'PCRE validation failed');
167 }
168
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.
172 function setDisplayedName (&$cell)
173 {
174 if ($cell['name'] != '')
175 $cell['dname'] = $cell['name'];
176 else
177 {
178 $cell['atags'][] = array ('tag' => '$nameless');
179 if (considerConfiguredConstraint ($cell, 'NAMEWARN_LISTSRC'))
180 $cell['dname'] = 'ANONYMOUS ' . decodeObjectType ($cell['objtype_id'], 'o');
181 else
182 $cell['dname'] = '[' . decodeObjectType ($cell['objtype_id'], 'o') . ']';
183 }
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.
189 function 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;
206 if (isset ($rackData[$startRow - $height][$locidx]['rowspan']))
207 break 2;
208 if (isset ($rackData[$startRow - $height][$locidx]['colspan']))
209 break 2;
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);
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";
227 return $height;
228 }
229
230 // This function marks atoms to be avoided by rectHeight() and assigns rowspan/colspan
231 // attributes.
232 function 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.
243 // Explicitly show even single-cell spanned atoms, because rectHeight()
244 // is expeciting this data for correct calculation.
245 if ($colspan != 0)
246 $rackData[$startRow - $height][$locidx]['skipped'] = TRUE;
247 else
248 {
249 $colspan = $templateWidth[$template_idx];
250 if ($colspan >= 1)
251 $rackData[$startRow - $height][$locidx]['colspan'] = $colspan;
252 if ($maxheight >= 1)
253 $rackData[$startRow - $height][$locidx]['rowspan'] = $maxheight;
254 }
255 }
256 }
257 }
258 return;
259 }
260
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.
264 function markAllSpans (&$rackData = NULL)
265 {
266 if ($rackData == NULL)
267 {
268 showWarning ('Invalid rackData', __FUNCTION__);
269 return;
270 }
271 for ($i = $rackData['height']; $i > 0; $i--)
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).
277 function markBestSpan (&$rackData, $i)
278 {
279 global $template, $templateWidth;
280 for ($j = 0; $j < 6; $j++)
281 {
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)
292 {
293 $best_template_index = $j;
294 $bestheight = $height[$j];
295 break;
296 }
297 // distribute span marks
298 markSpan ($rackData, $i, $bestheight, $best_template_index);
299 return TRUE;
300 }
301
302 // We can mount 'F' atoms and unmount our own 'T' atoms.
303 function 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.
321 function 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'.
337 function 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
352 // This function highlights specified object (and removes previous highlight).
353 function 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.
368 function 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.
386 function 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
402 // netmask conversion from length to number
403 function binMaskFromDec ($maskL)
404 {
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];
441 }
442
443 // complementary value
444 function binInvMaskFromDec ($maskL)
445 {
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];
482 }
483
484 // This function looks up 'has_problems' flag for 'T' atoms
485 // and modifies 'hl' key. May be, this should be better done
486 // in amplifyCell(). We don't honour 'skipped' key, because
487 // the function is also used for thumb creation.
488 function 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 {
494 $object = spotEntity ('object', $rackData[$i][$locidx]['object_id']);
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
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.
508 function l2addressForDatabase ($string)
509 {
510 $string = strtoupper ($string);
511 switch (TRUE)
512 {
513 case ($string == '' or preg_match (RE_L2_SOLID, $string) or preg_match (RE_L2_WWN_SOLID, $string)):
514 return $string;
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;
521 case (preg_match (RE_L2_CISCO, $string)):
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);
525 default:
526 return NULL;
527 }
528 }
529
530 function l2addressFromDatabase ($string)
531 {
532 switch (strlen ($string))
533 {
534 case 12: // Ethernet
535 case 16: // FireWire/Fibre Channel
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().
548 function getPrevIDforRack ($row_id = 0, $rack_id = 0)
549 {
550 if ($row_id <= 0 or $rack_id <= 0)
551 {
552 showWarning ('Invalid arguments passed', __FUNCTION__);
553 return NULL;
554 }
555 $rackList = listCells ('rack', $row_id);
556 doubleLink ($rackList);
557 if (isset ($rackList[$rack_id]['prev_key']))
558 return $rackList[$rack_id]['prev_key'];
559 return NULL;
560 }
561
562 function getNextIDforRack ($row_id = 0, $rack_id = 0)
563 {
564 if ($row_id <= 0 or $rack_id <= 0)
565 {
566 showWarning ('Invalid arguments passed', __FUNCTION__);
567 return NULL;
568 }
569 $rackList = listCells ('rack', $row_id);
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.
578 function 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
592 function sortTokenize ($a, $b)
593 {
594 $aold='';
595 while ($a != $aold)
596 {
597 $aold=$a;
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);
601 }
602
603 $bold='';
604 while ($b != $bold)
605 {
606 $bold=$b;
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);
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
633 function sortByName ($a, $b)
634 {
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'];
647 }
648
649 function sortObjectAddressesAndNames ($a, $b)
650 {
651 $objname_cmp = sortTokenize($a['object_name'], $b['object_name']);
652 if ($objname_cmp == 0)
653 {
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);
657 if ($objname_cmp == 0)
658 sortTokenize($a['ip'], $b['ip']);
659 return $objname_cmp;
660 }
661 return $objname_cmp;
662 }
663
664 // This function returns an array of single element of object's FQDN attribute,
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
667 // object is returned (which may appear 0 and more elements long).
668 function findAllEndpoints ($object_id, $fallback = '')
669 {
670 foreach (getAttrValues ($object_id) as $record)
671 if ($record['id'] == 3 && strlen ($record['value'])) // FQDN
672 return array ($record['value']);
673 $regular = array();
674 foreach (getObjectIPv4Allocations ($object_id) as $dottedquad => $alloc)
675 if ($alloc['type'] == 'regular')
676 $regular[] = $dottedquad;
677 if (!count ($regular) && strlen ($fallback))
678 return array ($fallback);
679 return $regular;
680 }
681
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>).
689 function parseWikiLink ($line, $which)
690 {
691 if (preg_match ('/^\[\[.+\]\]$/', $line) == 0)
692 {
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')
696 return preg_replace ('/^.+%GSKIP%/', '', preg_replace ('/^(.+)%GPASS%/', '\\1 ', $line));
697 else
698 return $line;
699 }
700 $line = preg_replace ('/^\[\[(.+)\]\]$/', '$1', $line);
701 $s = explode ('|', $line);
702 $o_value = trim ($s[0]);
703 if ($which == 'o')
704 return $o_value;
705 $o_value = preg_replace ('/^.+%GSKIP%/', '', preg_replace ('/^(.+)%GPASS%/', '\\1 ', $o_value));
706 $a_value = trim ($s[1]);
707 return "<a href='${a_value}'>${o_value}</a>";
708 }
709
710 // FIXME: should this be saved as "P-data"?
711 function execGMarker ($line)
712 {
713 return preg_replace ('/^.+%GSKIP%/', '', preg_replace ('/^(.+)%GPASS%/', '\\1 ', $line));
714 }
715
716 // rackspace usage for a single rack
717 // (T + W + U) / (height * 3 - A)
718 function getRSUforRack ($data = NULL)
719 {
720 if ($data == NULL)
721 {
722 showWarning ('Invalid argument', __FUNCTION__);
723 return NULL;
724 }
725 $counter = array ('A' => 0, 'U' => 0, 'T' => 0, 'W' => 0, 'F' => 0);
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']]++;
729 return ($counter['T'] + $counter['W'] + $counter['U']) / ($counter['T'] + $counter['W'] + $counter['U'] + $counter['F']);
730 }
731
732 // Same for row.
733 function getRSUforRackRow ($rowData = NULL)
734 {
735 if ($rowData === NULL)
736 {
737 showWarning ('Invalid argument', __FUNCTION__);
738 return NULL;
739 }
740 if (!count ($rowData))
741 return 0;
742 $counter = array ('A' => 0, 'U' => 0, 'T' => 0, 'W' => 0, 'F' => 0);
743 $total_height = 0;
744 foreach (array_keys ($rowData) as $rack_id)
745 {
746 $data = spotEntity ('rack', $rack_id);
747 amplifyCell ($data);
748 $total_height += $data['height'];
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']]++;
752 }
753 return ($counter['T'] + $counter['W'] + $counter['U']) / ($counter['T'] + $counter['W'] + $counter['U'] + $counter['F']);
754 }
755
756 // Make sure the string is always wrapped with LF characters
757 function lf_wrap ($str)
758 {
759 $ret = trim ($str, "\r\n");
760 if (strlen ($ret))
761 $ret .= "\n";
762 return $ret;
763 }
764
765 // Adopted from Mantis BTS code.
766 function 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.
781 function 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
787 // Parse AUTOPORTS_CONFIG and return a list of generated pairs (port_type, port_name)
788 // for the requested object_type_id.
789 function 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
817 // Use pre-served trace to traverse the tree, then place given node where it belongs.
818 function 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
827 {
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);
839 }
840 }
841
842 // Likewise traverse the tree with the trace and return the final node.
843 function peekNode ($tree, $trace, $target_id)
844 {
845 $self = __FUNCTION__;
846 if (NULL === ($next = array_shift ($trace))) // warm
847 {
848 foreach ($tree as $node)
849 if (array_key_exists ('id', $node) and $node['id'] == $target_id) // hot
850 return $node;
851 }
852 else // cold
853 {
854 foreach ($tree as $node)
855 if (array_key_exists ('id', $node) and $node['id'] == $next) // warmer
856 return $self ($node['kids'], $trace, $target_id);
857 }
858 // HCF
859 return NULL;
860 }
861
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'
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.
867 function treeFromList (&$orig_nodelist, $threshold = 0, $return_main_payload = TRUE)
868 {
869 $tree = array();
870 $nodelist = $orig_nodelist;
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
880 {
881 $nextpass = FALSE;
882 foreach (array_keys ($nodelist) as $nodeid)
883 {
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)
890 {
891 $tree[$nodeid] = $nodelist[$nodeid];
892 $trace[$nodeid] = array(); // Trace to root node is empty
893 unset ($nodelist[$nodeid]);
894 $nextpass = TRUE;
895 }
896 // Now look if it fits somewhere on already built tree.
897 elseif (isset ($trace[$nodelist[$nodeid]['parent_id']]))
898 {
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;
906 }
907 }
908 }
909 while ($nextpass);
910 if (!$return_main_payload)
911 return $nodelist;
912 // update each input node with its backtrace route
913 foreach ($trace as $nodeid => $route)
914 $orig_nodelist[$nodeid]['trace'] = $route;
915 return $tree;
916 }
917
918 // Build a tree from the tag list and return everything _except_ the tree.
919 // IOW, return taginfo items, which have parent_id set and pointing outside
920 // of the "normal" tree, which originates from the root.
921 function getOrphanedTags ()
922 {
923 global $taglist;
924 return treeFromList ($taglist, 0, FALSE);
925 }
926
927 function serializeTags ($chain, $baseurl = '')
928 {
929 $comma = '';
930 $ret = '';
931 foreach ($chain as $taginfo)
932 {
933 $ret .= $comma .
934 ($baseurl == '' ? '' : "<a href='${baseurl}cft[]=${taginfo['id']}'>") .
935 $taginfo['tag'] .
936 ($baseurl == '' ? '' : '</a>');
937 $comma = ', ';
938 }
939 return $ret;
940 }
941
942 // Return the list of missing implicit tags.
943 function getImplicitTags ($oldtags)
944 {
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);
951 }
952
953 // Minimize the chain: exclude all implicit tags and return the result.
954 // This function makes use of an external cache with a miss/hit ratio
955 // about 3/7 (ticket:255).
956 function getExplicitTagsOnly ($chain)
957 {
958 global $taglist, $tagRelCache;
959 $ret = array();
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]))
970 $tagRelCache[$tagidA][$tagidB] = in_array ($tagidA, $taglist[$tagidB]['trace']);
971 if ($tagRelCache[$tagidA][$tagidB] === TRUE) // A is ancestor of B
972 continue 2; // skip this A
973 }
974 $ret[] = $chain[$keyA];
975 }
976 return $ret;
977 }
978
979 // Universal autotags generator, a complementing function for loadEntityTags().
980 // Bypass key isn't strictly typed, but interpreted depending on the realm.
981 function generateEntityAutoTags ($cell)
982 {
983 $ret = array();
984 switch ($cell['realm'])
985 {
986 case 'rack':
987 $ret[] = array ('tag' => '$rackid_' . $cell['id']);
988 $ret[] = array ('tag' => '$any_rack');
989 break;
990 case 'object':
991 $ret[] = array ('tag' => '$id_' . $cell['id']);
992 $ret[] = array ('tag' => '$typeid_' . $cell['objtype_id']);
993 $ret[] = array ('tag' => '$any_object');
994 if (validTagName ('$cn_' . $cell['name'], TRUE))
995 $ret[] = array ('tag' => '$cn_' . $cell['name']);
996 if (!strlen ($cell['rack_id']))
997 $ret[] = array ('tag' => '$unmounted');
998 if (!$cell['nports'])
999 $ret[] = array ('tag' => '$portless');
1000 if ($cell['asset_no'] == '')
1001 $ret[] = array ('tag' => '$no_asset_tag');
1002 if ($cell['runs8021Q'])
1003 $ret[] = array ('tag' => '$runs_8021Q');
1004 break;
1005 case 'ipv4net':
1006 $ret[] = array ('tag' => '$ip4netid_' . $cell['id']);
1007 $ret[] = array ('tag' => '$ip4net-' . str_replace ('.', '-', $cell['ip']) . '-' . $cell['mask']);
1008 for ($i = 8; $i < 32; $i++)
1009 {
1010 // these conditions hit 1 to 3 times per each i
1011 if ($cell['mask'] >= $i)
1012 $ret[] = array ('tag' => '$masklen_ge_' . $i);
1013 if ($cell['mask'] <= $i)
1014 $ret[] = array ('tag' => '$masklen_le_' . $i);
1015 if ($cell['mask'] == $i)
1016 $ret[] = array ('tag' => '$masklen_eq_' . $i);
1017 }
1018 $ret[] = array ('tag' => '$any_ip4net');
1019 $ret[] = array ('tag' => '$any_net');
1020 break;
1021 case 'ipv4vs':
1022 $ret[] = array ('tag' => '$ipv4vsid_' . $cell['id']);
1023 $ret[] = array ('tag' => '$any_ipv4vs');
1024 $ret[] = array ('tag' => '$any_vs');
1025 break;
1026 case 'ipv4rspool':
1027 $ret[] = array ('tag' => '$ipv4rspid_' . $cell['id']);
1028 $ret[] = array ('tag' => '$any_ipv4rsp');
1029 $ret[] = array ('tag' => '$any_rsp');
1030 break;
1031 case 'user':
1032 // {$username_XXX} autotag is generated always, but {$userid_XXX}
1033 // appears only for accounts, which exist in local database.
1034 $ret[] = array ('tag' => '$username_' . $cell['user_name']);
1035 if (isset ($cell['user_id']))
1036 $ret[] = array ('tag' => '$userid_' . $cell['user_id']);
1037 break;
1038 case 'file':
1039 $ret[] = array ('tag' => '$fileid_' . $cell['id']);
1040 $ret[] = array ('tag' => '$any_file');
1041 break;
1042 default: // HCF!
1043 break;
1044 }
1045 // {$tagless} doesn't apply to users
1046 switch ($cell['realm'])
1047 {
1048 case 'rack':
1049 case 'object':
1050 case 'ipv4net':
1051 case 'ipv4vs':
1052 case 'ipv4rspool':
1053 case 'file':
1054 if (!count ($cell['etags']))
1055 $ret[] = array ('tag' => '$untagged');
1056 break;
1057 default:
1058 break;
1059 }
1060 return $ret;
1061 }
1062
1063 // Check, if the given tag is present on the chain (will only work
1064 // for regular tags with tag ID set.
1065 function tagOnChain ($taginfo, $tagchain)
1066 {
1067 if (!isset ($taginfo['id']))
1068 return FALSE;
1069 foreach ($tagchain as $test)
1070 if ($test['id'] == $taginfo['id'])
1071 return TRUE;
1072 return FALSE;
1073 }
1074
1075 function tagNameOnChain ($tagname, $tagchain)
1076 {
1077 foreach ($tagchain as $test)
1078 if ($test['tag'] == $tagname)
1079 return TRUE;
1080 return FALSE;
1081 }
1082
1083 // Return TRUE, if two tags chains differ (order of tags doesn't matter).
1084 // Assume, that neither of the lists contains duplicates.
1085 // FIXME: a faster, than O(x^2) method is possible for this calculation.
1086 function tagChainCmp ($chain1, $chain2)
1087 {
1088 if (count ($chain1) != count ($chain2))
1089 return TRUE;
1090 foreach ($chain1 as $taginfo1)
1091 if (!tagOnChain ($taginfo1, $chain2))
1092 return TRUE;
1093 return FALSE;
1094 }
1095
1096 function redirectIfNecessary ()
1097 {
1098 global
1099 $trigger,
1100 $pageno,
1101 $tabno;
1102 $pmap = array
1103 (
1104 'accounts' => 'userlist',
1105 'rspools' => 'ipv4rsplist',
1106 'rspool' => 'ipv4rsp',
1107 'vservices' => 'ipv4vslist',
1108 'vservice' => 'ipv4vs',
1109 'objects' => 'depot',
1110 'objgroup' => 'depot',
1111 );
1112 $tmap = array();
1113 $tmap['objects']['newmulti'] = 'addmore';
1114 $tmap['objects']['newobj'] = 'addmore';
1115 $tmap['object']['switchvlans'] = 'livevlans';
1116 $tmap['object']['slb'] = 'editrspvs';
1117 $tmap['object']['portfwrd'] = 'nat4';
1118 $tmap['object']['network'] = 'ipv4';
1119 if (isset ($pmap[$pageno]))
1120 redirectUser ($pmap[$pageno], $tabno);
1121 if (isset ($tmap[$pageno][$tabno]))
1122 redirectUser ($pageno, $tmap[$pageno][$tabno]);
1123 // check if we accidentaly got on a dynamic tab that shouldn't be shown for this object
1124 if
1125 (
1126 isset ($trigger[$pageno][$tabno]) and
1127 !strlen (call_user_func ($trigger[$pageno][$tabno]))
1128 )
1129 redirectUser ($pageno, 'default');
1130 }
1131
1132 function prepareNavigation() {
1133 global
1134 $pageno,
1135 $tabno;
1136
1137 $pageno = (isset ($_REQUEST['page'])) ? $_REQUEST['page'] : 'index';
1138
1139 // Special handling of tab number to substitute the "last" index where applicable.
1140 // Always show explicitly requested tab, substitute the last used name in case
1141 // it is awailable, fall back to the default one.
1142
1143 if (isset ($_REQUEST['tab'])) {
1144 $tabno = $_REQUEST['tab'];
1145 } elseif (basename($_SERVER['PHP_SELF']) == 'index.php' and getConfigVar ('SHOW_LAST_TAB') == 'yes' and isset ($_SESSION['RTLT'][$pageno])) {
1146 redirectUser ($pageno, $_SESSION['RTLT'][$pageno]);
1147 } else {
1148 $tabno = 'default';
1149 }
1150 }
1151
1152 function fixContext ($target = NULL)
1153 {
1154 global
1155 $pageno,
1156 $auto_tags,
1157 $expl_tags,
1158 $impl_tags,
1159 $target_given_tags,
1160 $user_given_tags,
1161 $etype_by_pageno,
1162 $page;
1163
1164 if ($target !== NULL)
1165 {
1166 $target_given_tags = $target['etags'];
1167 // Don't reset autochain, because auth procedures could push stuff there in.
1168 // Another important point is to ignore 'user' realm, so we don't infuse effective
1169 // context with autotags of the displayed account.
1170 if ($target['realm'] != 'user')
1171 $auto_tags = array_merge ($auto_tags, $target['atags']);
1172 }
1173 elseif (array_key_exists ($pageno, $etype_by_pageno))
1174 {
1175 // Each page listed in the map above requires one uint argument.
1176 $target_realm = $etype_by_pageno[$pageno];
1177 assertUIntArg ($page[$pageno]['bypass']);
1178 $target_id = $_REQUEST[$page[$pageno]['bypass']];
1179 $target = spotEntity ($target_realm, $target_id);
1180 $target_given_tags = $target['etags'];
1181 if ($target['realm'] != 'user')
1182 $auto_tags = array_merge ($auto_tags, $target['atags']);
1183 }
1184 // Explicit and implicit chains should be normally empty at this point, so
1185 // overwrite the contents anyway.
1186 $expl_tags = mergeTagChains ($user_given_tags, $target_given_tags);
1187 $impl_tags = getImplicitTags ($expl_tags);
1188 }
1189
1190 // Take a list of user-supplied tag IDs to build a list of valid taginfo
1191 // records indexed by tag IDs (tag chain).
1192 function buildTagChainFromIds ($tagidlist)
1193 {
1194 global $taglist;
1195 $ret = array();
1196 foreach (array_unique ($tagidlist) as $tag_id)
1197 if (isset ($taglist[$tag_id]))
1198 $ret[] = $taglist[$tag_id];
1199 return $ret;
1200 }
1201
1202 // Process a given tag tree and return only meaningful branches. The resulting
1203 // (sub)tree will have refcnt leaves on every last branch.
1204 function getObjectiveTagTree ($tree, $realm, $preselect)
1205 {
1206 $self = __FUNCTION__;
1207 $ret = array();
1208 foreach ($tree as $taginfo)
1209 {
1210 $subsearch = $self ($taginfo['kids'], $realm, $preselect);
1211 // If the current node addresses something, add it to the result
1212 // regardless of how many sub-nodes it features.
1213 if
1214 (
1215 isset ($taginfo['refcnt'][$realm]) or
1216 count ($subsearch) > 1 or
1217 in_array ($taginfo['id'], $preselect)
1218 )
1219 $ret[] = array
1220 (
1221 'id' => $taginfo['id'],
1222 'tag' => $taginfo['tag'],
1223 'parent_id' => $taginfo['parent_id'],
1224 'refcnt' => $taginfo['refcnt'],
1225 'kids' => $subsearch
1226 );
1227 else
1228 $ret = array_merge ($ret, $subsearch);
1229 }
1230 return $ret;
1231 }
1232
1233 // Get taginfo record by tag name, return NULL, if record doesn't exist.
1234 function getTagByName ($target_name)
1235 {
1236 global $taglist;
1237 foreach ($taglist as $taginfo)
1238 if ($taginfo['tag'] == $target_name)
1239 return $taginfo;
1240 return NULL;
1241 }
1242
1243 // Merge two chains, filtering dupes out. Return the resulting superset.
1244 function mergeTagChains ($chainA, $chainB)
1245 {
1246 // $ret = $chainA;
1247 // Reindex by tag id in any case.
1248 $ret = array();
1249 foreach ($chainA as $tag)
1250 $ret[$tag['id']] = $tag;
1251 foreach ($chainB as $tag)
1252 if (!isset ($ret[$tag['id']]))
1253 $ret[$tag['id']] = $tag;
1254 return $ret;
1255 }
1256
1257 function getCellFilter ()
1258 {
1259 global $sic;
1260 global $pageno;
1261 $staticFilter = getConfigVar ('STATIC_FILTER');
1262 if (isset ($_REQUEST['tagfilter']) and is_array ($_REQUEST['tagfilter']))
1263 {
1264 $_REQUEST['cft'] = $_REQUEST['tagfilter'];
1265 unset ($_REQUEST['tagfilter']);
1266 }
1267 if (isset ($_SESSION[$pageno]['tagfilter']) and is_array ($_SESSION[$pageno]['tagfilter']) and !(isset($_REQUEST['cft'])) and $staticFilter == 'yes')
1268 {
1269 $_REQUEST['cft'] = $_SESSION[$pageno]['tagfilter'];
1270 }
1271 if (isset ($_SESSION[$pageno]['cfe']) and !(isset($sic['cfe'])) and $staticFilter == 'yes')
1272 {
1273 $sic['cfe'] = $_SESSION[$pageno]['cfe'];
1274 }
1275 if (isset ($_SESSION[$pageno]['andor']) and !(isset($_REQUEST['andor'])) and $staticFilter == 'yes')
1276 {
1277 $_REQUEST['andor'] = $_SESSION[$pageno]['andor'];
1278 }
1279
1280
1281 $ret = array
1282 (
1283 'tagidlist' => array(),
1284 'tnamelist' => array(),
1285 'pnamelist' => array(),
1286 'andor' => '',
1287 'text' => '',
1288 'extratext' => '',
1289 'expression' => array(),
1290 'urlextra' => '', // Just put text here and let makeHref call urlencode().
1291 );
1292 switch (TRUE)
1293 {
1294 case (!isset ($_REQUEST['andor'])):
1295 $andor2 = getConfigVar ('FILTER_DEFAULT_ANDOR');
1296 break;
1297 case ($_REQUEST['andor'] == 'and'):
1298 case ($_REQUEST['andor'] == 'or'):
1299 $_SESSION[$pageno]['andor'] = $_REQUEST['andor'];
1300 $ret['andor'] = $andor2 = $_REQUEST['andor'];
1301 $ret['urlextra'] .= '&andor=' . $ret['andor'];
1302 break;
1303 default:
1304 showWarning ('Invalid and/or switch value in submitted form', __FUNCTION__);
1305 return NULL;
1306 }
1307 $andor1 = '';
1308 // Both tags and predicates, which don't exist, should be
1309 // handled somehow. Discard them silently for now.
1310 if (isset ($_REQUEST['cft']) and is_array ($_REQUEST['cft']))
1311 {
1312 $_SESSION[$pageno]['tagfilter'] = $_REQUEST['cft'];
1313 global $taglist;
1314 foreach ($_REQUEST['cft'] as $req_id)
1315 if (isset ($taglist[$req_id]))
1316 {
1317 $ret['tagidlist'][] = $req_id;
1318 $ret['tnamelist'][] = $taglist[$req_id]['tag'];
1319 $ret['text'] .= $andor1 . '{' . $taglist[$req_id]['tag'] . '}';
1320 $andor1 = ' ' . $andor2 . ' ';
1321 $ret['urlextra'] .= '&cft[]=' . $req_id;
1322 }
1323 }
1324 if (isset ($_REQUEST['cfp']) and is_array ($_REQUEST['cfp']))
1325 {
1326 global $pTable;
1327 foreach ($_REQUEST['cfp'] as $req_name)
1328 if (isset ($pTable[$req_name]))
1329 {
1330 $ret['pnamelist'][] = $req_name;
1331 $ret['text'] .= $andor1 . '[' . $req_name . ']';
1332 $andor1 = ' ' . $andor2 . ' ';
1333 $ret['urlextra'] .= '&cfp[]=' . $req_name;
1334 }
1335 }
1336 // Extra text comes from TEXTAREA and is easily screwed by standard escaping function.
1337 if (isset ($sic['cfe']))
1338 {
1339 $_SESSION[$pageno]['cfe'] = $sic['cfe'];
1340 // Only consider extra text, when it is a correct RackCode expression.
1341 $parse = spotPayload ($sic['cfe'], 'SYNT_EXPR');
1342 if ($parse['result'] == 'ACK')
1343 {
1344 $ret['extratext'] = trim ($sic['cfe']);
1345 $ret['urlextra'] .= '&cfe=' . $ret['extratext'];
1346 }
1347 }
1348 $finaltext = array();
1349 if (strlen ($ret['text']))
1350 $finaltext[] = '(' . $ret['text'] . ')';
1351 if (strlen ($ret['extratext']))
1352 $finaltext[] = '(' . $ret['extratext'] . ')';
1353 $finaltext = implode (' ' . $andor2 . ' ', $finaltext);
1354 if (strlen ($finaltext))
1355 {
1356 $parse = spotPayload ($finaltext, 'SYNT_EXPR');
1357 $ret['expression'] = $parse['result'] == 'ACK' ? $parse['load'] : NULL;
1358 // It's not quite fair enough to put the blame of the whole text onto
1359 // non-empty "extra" portion of it, but it's the only user-generated portion
1360 // of it, thus the most probable cause of parse error.
1361 if (strlen ($ret['extratext']))
1362 $ret['extraclass'] = $parse['result'] == 'ACK' ? 'validation-success' : 'validation-error';
1363 }
1364 return $ret;
1365 }
1366
1367 // Return an empty message log.
1368 function emptyLog ()
1369 {
1370 return array
1371 (
1372 'v' => 2,
1373 'm' => array()
1374 );
1375 }
1376
1377 // Return a message log consisting of only one message.
1378 function oneLiner ($code, $args = array())
1379 {
1380 $ret = emptyLog();
1381 $ret['m'][] = count ($args) ? array ('c' => $code, 'a' => $args) : array ('c' => $code);
1382 return $ret;
1383 }
1384
1385 // Merge message payload from two message logs given and return the result.
1386 function mergeLogs ($log1, $log2)
1387 {
1388 $ret = emptyLog();
1389 $ret['m'] = array_merge ($log1['m'], $log2['m']);
1390 return $ret;
1391 }
1392
1393 function validTagName ($s, $allow_autotag = FALSE)
1394 {
1395 if (1 == preg_match (TAGNAME_REGEXP, $s))
1396 return TRUE;
1397 if ($allow_autotag and 1 == preg_match (AUTOTAGNAME_REGEXP, $s))
1398 return TRUE;
1399 return FALSE;
1400 }
1401
1402 function redirectUser ($p, $t)
1403 {
1404 global $page;
1405 $l = "index.php?page=${p}&tab=${t}";
1406 if (isset ($page[$p]['bypass']) and isset ($_REQUEST[$page[$p]['bypass']]))
1407 $l .= '&' . $page[$p]['bypass'] . '=' . $_REQUEST[$page[$p]['bypass']];
1408 header ("Location: " . $l);
1409 die;
1410 }
1411
1412 function getRackCodeStats ()
1413 {
1414 global $rackCode;
1415 $defc = $grantc = $modc = 0;
1416 foreach ($rackCode as $s)
1417 switch ($s['type'])
1418 {
1419 case 'SYNT_DEFINITION':
1420 $defc++;
1421 break;
1422 case 'SYNT_GRANT':
1423 $grantc++;
1424 break;
1425 case 'SYNT_CTXMOD':
1426 $modc++;
1427 break;
1428 default:
1429 break;
1430 }
1431 $ret = array
1432 (
1433 'Definition sentences' => $defc,
1434 'Grant sentences' => $grantc,
1435 'Context mod sentences' => $modc
1436 );
1437 return $ret;
1438 }
1439
1440 function getRackImageWidth ()
1441 {
1442 global $rtwidth;
1443 return 3 + $rtwidth[0] + $rtwidth[1] + $rtwidth[2] + 3;
1444 }
1445
1446 function getRackImageHeight ($units)
1447 {
1448 return 3 + 3 + $units * 2;
1449 }
1450
1451 // Perform substitutions and return resulting string
1452 // used solely by buildLVSConfig()
1453 function apply_macros ($macros, $subject)
1454 {
1455 $ret = $subject;
1456 foreach ($macros as $search => $replace)
1457 $ret = str_replace ($search, $replace, $ret);
1458 return $ret;
1459 }
1460
1461 function buildLVSConfig ($object_id = 0)
1462 {
1463 if ($object_id <= 0)
1464 {
1465 showWarning ('Invalid argument', __FUNCTION__);
1466 return;
1467 }
1468 $oInfo = spotEntity ('object', $object_id);
1469 $lbconfig = getSLBConfig ($object_id);
1470 if ($lbconfig === NULL)
1471 {
1472 showWarning ('getSLBConfig() failed', __FUNCTION__);
1473 return;
1474 }
1475 $newconfig = "#\n#\n# This configuration has been generated automatically by RackTables\n";
1476 $newconfig .= "# for object_id == ${object_id}\n# object name: ${oInfo['name']}\n#\n#\n\n\n";
1477 foreach ($lbconfig as $vs_id => $vsinfo)
1478 {
1479 $newconfig .= "########################################################\n" .
1480 "# VS (id == ${vs_id}): " . (!strlen ($vsinfo['vs_name']) ? 'NO NAME' : $vsinfo['vs_name']) . "\n" .
1481 "# RS pool (id == ${vsinfo['pool_id']}): " . (!strlen ($vsinfo['pool_name']) ? 'ANONYMOUS' : $vsinfo['pool_name']) . "\n" .
1482 "########################################################\n";
1483 # The order of inheritance is: VS -> LB -> pool [ -> RS ]
1484 $macros = array
1485 (
1486 '%VIP%' => $vsinfo['vip'],
1487 '%VPORT%' => $vsinfo['vport'],
1488 '%PROTO%' => $vsinfo['proto'],
1489 '%VNAME%' => $vsinfo['vs_name'],
1490 '%RSPOOLNAME%' => $vsinfo['pool_name']
1491 );
1492 $newconfig .= "virtual_server ${vsinfo['vip']} ${vsinfo['vport']} {\n";
1493 $newconfig .= "\tprotocol ${vsinfo['proto']}\n";
1494 $newconfig .= apply_macros
1495 (
1496 $macros,
1497 lf_wrap ($vsinfo['vs_vsconfig']) .
1498 lf_wrap ($vsinfo['lb_vsconfig']) .
1499 lf_wrap ($vsinfo['pool_vsconfig'])
1500 );
1501 foreach ($vsinfo['rslist'] as $rs)
1502 {
1503 if (!strlen ($rs['rsport']))
1504 $rs['rsport'] = $vsinfo['vport'];
1505 $macros['%RSIP%'] = $rs['rsip'];
1506 $macros['%RSPORT%'] = $rs['rsport'];
1507 $newconfig .= "\treal_server ${rs['rsip']} ${rs['rsport']} {\n";
1508 $newconfig .= apply_macros
1509 (
1510 $macros,
1511 lf_wrap ($vsinfo['vs_rsconfig']) .
1512 lf_wrap ($vsinfo['lb_rsconfig']) .
1513 lf_wrap ($vsinfo['pool_rsconfig']) .
1514 lf_wrap ($rs['rs_rsconfig'])
1515 );
1516 $newconfig .= "\t}\n";
1517 }
1518 $newconfig .= "}\n\n\n";
1519 }
1520 // FIXME: deal somehow with Mac-styled text, the below replacement will screw it up
1521 return str_replace ("\r", '', $newconfig);
1522 }
1523
1524 // Indicate occupation state of each IP address: none, ordinary or problematic.
1525 function markupIPv4AddrList (&$addrlist)
1526 {
1527 foreach (array_keys ($addrlist) as $ip_bin)
1528 {
1529 $refc = array
1530 (
1531 'shared' => 0, // virtual
1532 'virtual' => 0, // loopback
1533 'regular' => 0, // connected host
1534 'router' => 0 // connected gateway
1535 );
1536 foreach ($addrlist[$ip_bin]['allocs'] as $a)
1537 $refc[$a['type']]++;
1538 $nvirtloopback = ($refc['shared'] + $refc['virtual'] > 0) ? 1 : 0; // modulus of virtual + shared
1539 $nreserved = ($addrlist[$ip_bin]['reserved'] == 'yes') ? 1 : 0; // only one reservation is possible ever
1540 $nrealms = $nreserved + $nvirtloopback + $refc['regular'] + $refc['router']; // latter two are connected and router allocations
1541
1542 if ($nrealms == 1)
1543 $addrlist[$ip_bin]['class'] = 'trbusy';
1544 elseif ($nrealms > 1)
1545 $addrlist[$ip_bin]['class'] = 'trerror';
1546 else
1547 $addrlist[$ip_bin]['class'] = '';
1548 }
1549 }
1550
1551 // Scan the given address list (returned by scanIPv4Space) and return a list of all routers found.
1552 function findRouters ($addrlist)
1553 {
1554 $ret = array();
1555 foreach ($addrlist as $addr)
1556 foreach ($addr['allocs'] as $alloc)
1557 if ($alloc['type'] == 'router')
1558 $ret[] = array
1559 (
1560 'id' => $alloc['object_id'],
1561 'iface' => $alloc['name'],
1562 'dname' => $alloc['object_name'],
1563 'addr' => $addr['ip']
1564 );
1565 return $ret;
1566 }
1567
1568 // Assist in tag chain sorting.
1569 function taginfoCmp ($tagA, $tagB)
1570 {
1571 return $tagA['ci'] - $tagB['ci'];
1572 }
1573
1574 // Compare networks. When sorting a tree, the records on the list will have
1575 // distinct base IP addresses.
1576 // "The comparison function must return an integer less than, equal to, or greater
1577 // than zero if the first argument is considered to be respectively less than,
1578 // equal to, or greater than the second." (c) PHP manual
1579 function IPv4NetworkCmp ($netA, $netB)
1580 {
1581 // There's a problem just substracting one u32 integer from another,
1582 // because the result may happen big enough to become a negative i32
1583 // integer itself (PHP tries to cast everything it sees to signed int)
1584 // The comparison below must treat positive and negative values of both
1585 // arguments.
1586 // Equal values give instant decision regardless of their [equal] sign.
1587 if ($netA['ip_bin'] == $netB['ip_bin'])
1588 return 0;
1589 // Same-signed values compete arithmetically within one of i32 contiguous ranges:
1590 // 0x00000001~0x7fffffff 1~2147483647
1591 // 0 doesn't have any sign, and network 0.0.0.0 isn't allowed
1592 // 0x80000000~0xffffffff -2147483648~-1
1593 $signA = $netA['ip_bin'] / abs ($netA['ip_bin']);
1594 $signB = $netB['ip_bin'] / abs ($netB['ip_bin']);
1595 if ($signA == $signB)
1596 {
1597 if ($netA['ip_bin'] > $netB['ip_bin'])
1598 return 1;
1599 else
1600 return -1;
1601 }
1602 else // With only one of two values being negative, it... wins!
1603 {
1604 if ($netA['ip_bin'] < $netB['ip_bin'])
1605 return 1;
1606 else
1607 return -1;
1608 }
1609 }
1610
1611 // Modify the given tag tree so, that each level's items are sorted alphabetically.
1612 function sortTree (&$tree, $sortfunc = '')
1613 {
1614 if (!strlen ($sortfunc))
1615 return;
1616 $self = __FUNCTION__;
1617 usort ($tree, $sortfunc);
1618 // Don't make a mistake of directly iterating over the items of current level, because this way
1619 // the sorting will be performed on a _copy_ if each item, not the item itself.
1620 foreach (array_keys ($tree) as $tagid)
1621 $self ($tree[$tagid]['kids'], $sortfunc);
1622 }
1623
1624 function iptree_fill (&$netdata)
1625 {
1626 if (!isset ($netdata['kids']) or !count ($netdata['kids']))
1627 return;
1628 // If we really have nested prefixes, they must fit into the tree.
1629 $worktree = array
1630 (
1631 'ip_bin' => $netdata['ip_bin'],
1632 'mask' => $netdata['mask']
1633 );
1634 foreach ($netdata['kids'] as $pfx)
1635 iptree_embed ($worktree, $pfx);
1636 $netdata['kids'] = iptree_construct ($worktree);
1637 $netdata['kidc'] = count ($netdata['kids']);
1638 }
1639
1640 function iptree_construct ($node)
1641 {
1642 $self = __FUNCTION__;
1643
1644 if (!isset ($node['right']))
1645 {
1646 if (!isset ($node['ip']))
1647 {
1648 $node['ip'] = long2ip ($node['ip_bin']);
1649 $node['kids'] = array();
1650 $node['kidc'] = 0;
1651 $node['name'] = '';
1652 }
1653 return array ($node);
1654 }
1655 else
1656 return array_merge ($self ($node['left']), $self ($node['right']));
1657 }
1658
1659 function iptree_embed (&$node, $pfx)
1660 {
1661 $self = __FUNCTION__;
1662
1663 // hit?
1664 if ($node['ip_bin'] == $pfx['ip_bin'] and $node['mask'] == $pfx['mask'])
1665 {
1666 $node = $pfx;
1667 return;
1668 }
1669 if ($node['mask'] == $pfx['mask'])
1670 {
1671 throw new RuntimeException('Internal error, the recurring loop lost control');
1672 }
1673
1674 // split?
1675 if (!isset ($node['right']))
1676 {
1677 // Fill in db_first/db_last to make it possible to run scanIPv4Space() on the node.
1678 $node['left']['mask'] = $node['mask'] + 1;
1679 $node['left']['ip_bin'] = $node['ip_bin'];
1680 $node['left']['db_first'] = sprintf ('%u', $node['left']['ip_bin']);
1681 $node['left']['db_last'] = sprintf ('%u', $node['left']['ip_bin'] | binInvMaskFromDec ($node['left']['mask']));
1682
1683 $node['right']['mask'] = $node['mask'] + 1;
1684 $node['right']['ip_bin'] = $node['ip_bin'] + binInvMaskFromDec ($node['mask'] + 1) + 1;
1685 $node['right']['db_first'] = sprintf ('%u', $node['right']['ip_bin']);
1686 $node['right']['db_last'] = sprintf ('%u', $node['right']['ip_bin'] | binInvMaskFromDec ($node['right']['mask']));
1687 }
1688
1689 // repeat!
1690 if (($node['left']['ip_bin'] & binMaskFromDec ($node['left']['mask'])) == ($pfx['ip_bin'] & binMaskFromDec ($node['left']['mask'])))
1691 $self ($node['left'], $pfx);
1692 elseif (($node['right']['ip_bin'] & binMaskFromDec ($node['right']['mask'])) == ($pfx['ip_bin'] & binMaskFromDec ($node['left']['mask'])))
1693 $self ($node['right'], $pfx);
1694 else
1695 {
1696 throw new RuntimeException ('Internal error, cannot decide between left and right');
1697 }
1698 }
1699
1700 function treeApplyFunc (&$tree, $func = '', $stopfunc = '')
1701 {
1702 if (!strlen ($func))
1703 return;
1704 $self = __FUNCTION__;
1705 foreach (array_keys ($tree) as $key)
1706 {
1707 $func ($tree[$key]);
1708 if (strlen ($stopfunc) and $stopfunc ($tree[$key]))
1709 continue;
1710 $self ($tree[$key]['kids'], $func);
1711 }
1712 }
1713
1714 function loadIPv4AddrList (&$netinfo)
1715 {
1716 loadOwnIPv4Addresses ($netinfo);
1717 markupIPv4AddrList ($netinfo['addrlist']);
1718 }
1719
1720 function countOwnIPv4Addresses (&$node)
1721 {
1722 $toscan = array();
1723 $node['addrt'] = 0;
1724 $node['mask_bin'] = binMaskFromDec ($node['mask']);
1725 $node['mask_bin_inv'] = binInvMaskFromDec ($node['mask']);
1726 $node['db_first'] = sprintf ('%u', 0x00000000 + $node['ip_bin'] & $node['mask_bin']);
1727 $node['db_last'] = sprintf ('%u', 0x00000000 + $node['ip_bin'] | ($node['mask_bin_inv']));
1728 if (!count ($node['kids']))
1729 {
1730 $toscan[] = array ('i32_first' => $node['db_first'], 'i32_last' => $node['db_last']);
1731 $node['addrt'] = binInvMaskFromDec ($node['mask']) + 1;
1732 }
1733 else
1734 foreach ($node['kids'] as $nested)
1735 if (!isset ($nested['id'])) // spare
1736 {
1737 $toscan[] = array ('i32_first' => $nested['db_first'], 'i32_last' => $nested['db_last']);
1738 $node['addrt'] += binInvMaskFromDec ($nested['mask']) + 1;
1739 }
1740 // Don't do anything more, because the displaying function will load the addresses anyway.
1741 return;
1742 $node['addrc'] = count (scanIPv4Space ($toscan));
1743 }
1744
1745 function nodeIsCollapsed ($node)
1746 {
1747 return $node['symbol'] == 'node-collapsed';
1748 }
1749
1750 function loadOwnIPv4Addresses (&$node)
1751 {
1752 $toscan = array();
1753 if (!isset ($node['kids']) or !count ($node['kids']))
1754 $toscan[] = array ('i32_first' => $node['db_first'], 'i32_last' => $node['db_last']);
1755 else
1756 foreach ($node['kids'] as $nested)
1757 if (!isset ($nested['id'])) // spare
1758 $toscan[] = array ('i32_first' => $nested['db_first'], 'i32_last' => $nested['db_last']);
1759 $node['addrlist'] = scanIPv4Space ($toscan);
1760 $node['addrc'] = count ($node['addrlist']);
1761 }
1762
1763 function prepareIPv4Tree ($netlist, $expanded_id = 0)
1764 {
1765 // treeFromList() requires parent_id to be correct for an item to get onto the tree,
1766 // so perform necessary pre-processing to make orphans belong to root. This trick
1767 // was earlier performed by getIPv4NetworkList().
1768 $netids = array_keys ($netlist);
1769 foreach ($netids as $cid)
1770 if (!in_array ($netlist[$cid]['parent_id'], $netids))
1771 $netlist[$cid]['parent_id'] = NULL;
1772 $tree = treeFromList ($netlist); // medium call
1773 sortTree ($tree, 'IPv4NetworkCmp');
1774 // complement the tree before markup to make the spare networks have "symbol" set
1775 treeApplyFunc ($tree, 'iptree_fill');
1776 iptree_markup_collapsion ($tree, getConfigVar ('TREE_THRESHOLD'), $expanded_id);
1777 // count addresses after the markup to skip computation for hidden tree nodes
1778 treeApplyFunc ($tree, 'countOwnIPv4Addresses', 'nodeIsCollapsed');
1779 return $tree;
1780 }
1781
1782 // Check all items of the tree recursively, until the requested target id is
1783 // found. Mark all items leading to this item as "expanded", collapsing all
1784 // the rest, which exceed the given threshold (if the threshold is given).
1785 function iptree_markup_collapsion (&$tree, $threshold = 1024, $target = 0)
1786 {
1787 $self = __FUNCTION__;
1788 $ret = FALSE;
1789 foreach (array_keys ($tree) as $key)
1790 {
1791 $here = ($target === 'ALL' or ($target > 0 and isset ($tree[$key]['id']) and $tree[$key]['id'] == $target));
1792 $below = $self ($tree[$key]['kids'], $threshold, $target);
1793 if (!$tree[$key]['kidc']) // terminal node
1794 $tree[$key]['symbol'] = 'spacer';
1795 elseif ($tree[$key]['kidc'] < $threshold)
1796 $tree[$key]['symbol'] = 'node-expanded-static';
1797 elseif ($here or $below)
1798 $tree[$key]['symbol'] = 'node-expanded';
1799 else
1800 $tree[$key]['symbol'] = 'node-collapsed';
1801 $ret = ($ret or $here or $below); // parentheses are necessary for this to be computed correctly
1802 }
1803 return $ret;
1804 }
1805
1806 // Convert entity name to human-readable value
1807 function formatEntityName ($name) {
1808 switch ($name)
1809 {
1810 case 'ipv4net':
1811 return 'IPv4 Network';
1812 case 'ipv4rspool':
1813 return 'IPv4 RS Pool';
1814 case 'ipv4vs':
1815 return 'IPv4 Virtual Service';
1816 case 'object':
1817 return 'Object';
1818 case 'rack':
1819 return 'Rack';
1820 case 'user':
1821 return 'User';
1822 }
1823 return 'invalid';
1824 }
1825
1826 // Take a MySQL or other generic timestamp and make it prettier
1827 function formatTimestamp ($timestamp) {
1828 return date('n/j/y g:iA', strtotime($timestamp));
1829 }
1830
1831 // Display hrefs for all of a file's parents. If scissors are requested,
1832 // prepend cutting button to each of them.
1833 function serializeFileLinks ($links, $scissors = FALSE)
1834 {
1835 $comma = '';
1836 $ret = '';
1837 foreach ($links as $link_id => $li)
1838 {
1839 switch ($li['entity_type'])
1840 {
1841 case 'ipv4net':
1842 $params = "page=ipv4net&id=";
1843 break;
1844 case 'ipv4rspool':
1845 $params = "page=ipv4rspool&pool_id=";
1846 break;
1847 case 'ipv4vs':
1848 $params = "page=ipv4vs&vs_id=";
1849 break;
1850 case 'object':
1851 $params = "page=object&object_id=";
1852 break;
1853 case 'rack':
1854 $params = "page=rack&rack_id=";
1855 break;
1856 case 'user':
1857 $params = "page=user&user_id=";
1858 break;
1859 }
1860 $ret .= $comma;
1861 if ($scissors)
1862 {
1863 $ret .= "<a href='" . makeHrefProcess(array('op'=>'unlinkFile', 'link_id'=>$link_id)) . "'";
1864 $ret .= getImageHREF ('cut') . '</a> ';
1865 }
1866 $ret .= sprintf("<a href='index.php?%s%s'>%s</a>", $params, $li['entity_id'], $li['name']);
1867 $comma = '<br>';
1868 }
1869 return $ret;
1870 }
1871
1872 // Convert filesize to appropriate unit and make it human-readable
1873 function formatFileSize ($bytes) {
1874 // bytes
1875 if($bytes < 1024) // bytes
1876 return "${bytes} bytes";
1877
1878 // kilobytes
1879 if ($bytes < 1024000)
1880 return sprintf ("%.1fk", round (($bytes / 1024), 1));
1881
1882 // megabytes
1883 return sprintf ("%.1f MB", round (($bytes / 1024000), 1));
1884 }
1885
1886 // Reverse of formatFileSize, it converts human-readable value to bytes
1887 function convertToBytes ($value) {
1888 $value = trim($value);
1889 $last = strtolower($value[strlen($value)-1]);
1890 switch ($last)
1891 {
1892 case 'g':
1893 $value *= 1024;
1894 case 'm':
1895 $value *= 1024;
1896 case 'k':
1897 $value *= 1024;
1898 }
1899
1900 return $value;
1901 }
1902
1903 function ip_quad2long ($ip)
1904 {
1905 return sprintf("%u", ip2long($ip));
1906 }
1907
1908 function ip_long2quad ($quad)
1909 {
1910 return long2ip($quad);
1911 }
1912
1913 function makeHref($params = array())
1914 {
1915 $ret = 'index.php?';
1916 $first = true;
1917 foreach($params as $key=>$value)
1918 {
1919 if (!$first)
1920 $ret.='&';
1921 $ret .= urlencode($key).'='.urlencode($value);
1922 $first = false;
1923 }
1924 return $ret;
1925 }
1926
1927 function makeHrefProcess($params = array())
1928 {
1929 global $pageno, $tabno;
1930 $ret = 'process.php?';
1931 $first = true;
1932 if (!isset($params['page']))
1933 $params['page'] = $pageno;
1934 if (!isset($params['tab']))
1935 $params['tab'] = $tabno;
1936 foreach($params as $key=>$value)
1937 {
1938 if (!$first)
1939 $ret.='&';
1940 $ret .= urlencode($key).'='.urlencode($value);
1941 $first = false;
1942 }
1943 return $ret;
1944 }
1945
1946 function makeHrefForHelper ($helper_name, $params = array())
1947 {
1948 $ret = 'popup.php?helper=' . $helper_name;
1949 foreach($params as $key=>$value)
1950 $ret .= '&'.urlencode($key).'='.urlencode($value);
1951 return $ret;
1952 }
1953
1954 // Process the given list of records to build data suitable for printNiftySelect()
1955 // (like it was formerly executed by printSelect()). Screen out vendors according
1956 // to VENDOR_SIEVE, if object type ID is provided. However, the OPTGROUP with already
1957 // selected OPTION is protected from being screened.
1958 function cookOptgroups ($recordList, $object_type_id = 0, $existing_value = 0)
1959 {
1960 $ret = array();
1961 // Always keep "other" OPTGROUP at the SELECT bottom.
1962 $therest = array();
1963 foreach ($recordList as $dict_key => $dict_value)
1964 if (strpos ($dict_value, '%GSKIP%') !== FALSE)
1965 {
1966 $tmp = explode ('%GSKIP%', $dict_value, 2);
1967 $ret[$tmp[0]][$dict_key] = $tmp[1];
1968 }
1969 elseif (strpos ($dict_value, '%GPASS%') !== FALSE)
1970 {
1971 $tmp = explode ('%GPASS%', $dict_value, 2);
1972 $ret[$tmp[0]][$dict_key] = $tmp[1];
1973 }
1974 else
1975 $therest[$dict_key] = $dict_value;
1976 if ($object_type_id != 0)
1977 {
1978 $screenlist = array();
1979 foreach (explode (';', getConfigVar ('VENDOR_SIEVE')) as $sieve)
1980 if (preg_match ("/^([^@]+)(@${object_type_id})?\$/", trim ($sieve), $regs)){
1981 $screenlist[] = $regs[1];
1982 }
1983 foreach (array_keys ($ret) as $vendor)
1984 if (in_array ($vendor, $screenlist))
1985 {
1986 $ok_to_screen = TRUE;
1987 if ($existing_value)
1988 foreach (array_keys ($ret[$vendor]) as $recordkey)
1989 if ($recordkey == $existing_value)
1990 {
1991 $ok_to_screen = FALSE;
1992 break;
1993 }
1994 if ($ok_to_screen)
1995 unset ($ret[$vendor]);
1996 }
1997 }
1998 $ret['other'] = $therest;
1999 return $ret;
2000 }
2001
2002 function dos2unix ($text)
2003 {
2004 return str_replace ("\r\n", "\n", $text);
2005 }
2006
2007 function unix2dos ($text)
2008 {
2009 return str_replace ("\n", "\r\n", $text);
2010 }
2011
2012 function buildPredicateTable ($parsetree)
2013 {
2014 $ret = array();
2015 foreach ($parsetree as $sentence)
2016 if ($sentence['type'] == 'SYNT_DEFINITION')
2017 $ret[$sentence['term']] = $sentence['definition'];
2018 // Now we have predicate table filled in with the latest definitions of each
2019 // particular predicate met. This isn't as chik, as on-the-fly predicate
2020 // overloading during allow/deny scan, but quite sufficient for this task.
2021 return $ret;
2022 }
2023
2024 // Take a list of records and filter against given RackCode expression. Return
2025 // the original list intact, if there was no filter requested, but return an
2026 // empty list, if there was an error.
2027 function filterCellList ($list_in, $expression = array())
2028 {
2029 if ($expression === NULL)
2030 return array();
2031 if (!count ($expression))
2032 return $list_in;
2033 $list_out = array();
2034 foreach ($list_in as $item_key => $item_value)
2035 if (TRUE === judgeCell ($item_value, $expression))
2036 $list_out[$item_key] = $item_value;
2037 return $list_out;
2038 }
2039
2040 // Tell, if the given expression is true for the given entity. Take complete record on input.
2041 function judgeCell ($cell, $expression)
2042 {
2043 global $pTable;
2044 return eval_expression
2045 (
2046 $expression,
2047 array_merge
2048 (
2049 $cell['etags'],
2050 $cell['itags'],
2051 $cell['atags']
2052 ),
2053 $pTable,
2054 TRUE
2055 );
2056 }
2057
2058 // Tell, if a constraint from config option permits given record.
2059 function considerConfiguredConstraint ($cell, $varname)
2060 {
2061 if (!strlen (getConfigVar ($varname)))
2062 return TRUE; // no restriction
2063 global $parseCache;
2064 if (!isset ($parseCache[$varname]))
2065 // getConfigVar() doesn't re-read the value from DB because of its
2066 // own cache, so there is no race condition here between two calls.
2067 $parseCache[$varname] = spotPayload (getConfigVar ($varname), 'SYNT_EXPR');
2068 if ($parseCache[$varname]['result'] != 'ACK')
2069 return FALSE; // constraint set, but cannot be used due to compilation error
2070 return judgeCell ($cell, $parseCache[$varname]['load']);
2071 }
2072
2073 // Return list of records in the given realm, which conform to
2074 // the given RackCode expression. If the realm is unknown or text
2075 // doesn't validate as a RackCode expression, return NULL.
2076 // Otherwise (successful scan) return a list of all matched
2077 // records, even if the list is empty (array() !== NULL). If the
2078 // text is an empty string, return all found records in the given
2079 // realm.
2080 function scanRealmByText ($realm = NULL, $ftext = '')
2081 {
2082 switch ($realm)
2083 {
2084 case 'object':
2085 case 'user':
2086 case 'ipv4net':
2087 case 'file':
2088 case 'ipv4vs':
2089 case 'ipv4rspool':
2090 if (!strlen ($ftext = trim ($ftext)))
2091 $fexpr = array();
2092 else
2093 {
2094 $fparse = spotPayload ($ftext, 'SYNT_EXPR');
2095 if ($fparse['result'] != 'ACK')
2096 return NULL;
2097 $fexpr = $fparse['load'];
2098 }
2099 return filterCellList (listCells ($realm), $fexpr);
2100 default:
2101 throw new InvalidArgException ('$realm', $realm);
2102 }
2103
2104 }
2105
2106 function getIPv4VSOptions ()
2107 {
2108 $ret = array();
2109 foreach (listCells ('ipv4vs') as $vsid => $vsinfo)
2110 $ret[$vsid] = $vsinfo['dname'] . (!strlen ($vsinfo['name']) ? '' : " (${vsinfo['name']})");
2111 return $ret;
2112 }
2113
2114 function getIPv4RSPoolOptions ()
2115 {
2116 $ret = array();
2117 foreach (listCells ('ipv4rspool') as $pool_id => $poolInfo)
2118 $ret[$pool_id] = $poolInfo['name'];
2119 return $ret;
2120 }
2121
2122 // Derive a complete cell structure from the given username regardless
2123 // if it is a local account or not.
2124 function constructUserCell ($username)
2125 {
2126 if (NULL !== ($userid = getUserIDByUsername ($username)))
2127 return spotEntity ('user', $userid);
2128 $ret = array
2129 (
2130 'realm' => 'user',
2131 'user_name' => $username,
2132 'user_realname' => '',
2133 'etags' => array(),
2134 'itags' => array(),
2135 );
2136 $ret['atags'] = generateEntityAutoTags ($ret);
2137 return $ret;
2138 }
2139
2140 // Let's have this debug helper here to enable debugging of process.php w/o interface.php.
2141 function dump ($var)
2142 {
2143 echo '<div align=left><pre>';
2144 print_r ($var);
2145 echo '</pre></div>';
2146 }
2147
2148 function getTagChart ($limit = 0, $realm = 'total', $special_tags = array())
2149 {
2150 global $taglist;
2151 // first build top-N chart...
2152 $toplist = array();
2153 foreach ($taglist as $taginfo)
2154 if (isset ($taginfo['refcnt'][$realm]))
2155 $toplist[$taginfo['id']] = $taginfo['refcnt'][$realm];
2156 arsort ($toplist, SORT_NUMERIC);
2157 $ret = array();
2158 $done = 0;
2159 foreach (array_keys ($toplist) as $tag_id)
2160 {
2161 $ret[$tag_id] = $taglist[$tag_id];
2162 if (++$done == $limit)
2163 break;
2164 }
2165 // ...then make sure, that every item of the special list is shown
2166 // (using the same sort order)
2167 $extra = array();
2168 foreach ($special_tags as $taginfo)
2169 if (!array_key_exists ($taginfo['id'], $ret))
2170 $extra[$taginfo['id']] = $taglist[$taginfo['id']]['refcnt'][$realm];
2171 arsort ($extra, SORT_NUMERIC);
2172 foreach (array_keys ($extra) as $tag_id)
2173 $ret[] = $taglist[$tag_id];
2174 return $ret;
2175 }
2176
2177 function decodeObjectType ($objtype_id, $style = 'r')
2178 {
2179 static $types = array();
2180 if (!count ($types))
2181 $types = array
2182 (
2183 'r' => readChapter (CHAP_OBJTYPE),
2184 'a' => readChapter (CHAP_OBJTYPE, 'a'),
2185 'o' => readChapter (CHAP_OBJTYPE, 'o')
2186 );
2187 return $types[$style][$objtype_id];
2188 }
2189
2190 function isolatedPermission ($p, $t, $cell)
2191 {
2192 // This function is called from both "file" page and a number of other pages,
2193 // which have already fixed security context and authorized the user for it.
2194 // OTOH, it is necessary here to authorize against the current file, which
2195 // means saving the current context and building a new one.
2196 global
2197 $expl_tags,
2198 $impl_tags,
2199 $target_given_tags,
2200 $auto_tags;
2201 // push current context
2202 $orig_expl_tags = $expl_tags;
2203 $orig_impl_tags = $impl_tags;
2204 $orig_target_given_tags = $target_given_tags;
2205 $orig_auto_tags = $auto_tags;
2206 // retarget
2207 fixContext ($cell);
2208 // remember decision
2209 $ret = permitted ($p, $t);
2210 // pop context
2211 $expl_tags = $orig_expl_tags;
2212 $impl_tags = $orig_impl_tags;
2213 $target_given_tags = $orig_target_given_tags;
2214 $auto_tags = $orig_auto_tags;
2215 return $ret;
2216 }
2217
2218 function getPortListPrefs()
2219 {
2220 $ret = array();
2221 if (0 >= ($ret['iif_pick'] = getConfigVar ('DEFAULT_PORT_IIF_ID')))
2222 $ret['iif_pick'] = 1;
2223 $ret['oif_picks'] = array();
2224 foreach (explode (';', getConfigVar ('DEFAULT_PORT_OIF_IDS')) as $tmp)
2225 {
2226 $tmp = explode ('=', trim ($tmp));
2227 if (count ($tmp) == 2 and $tmp[0] > 0 and $tmp[1] > 0)
2228 $ret['oif_picks'][$tmp[0]] = $tmp[1];
2229 }
2230 // enforce default value
2231 if (!array_key_exists (1, $ret['oif_picks']))
2232 $ret['oif_picks'][1] = 24;
2233 $ret['selected'] = $ret['iif_pick'] . '-' . $ret['oif_picks'][$ret['iif_pick']];
2234 return $ret;
2235 }
2236
2237 // Return data for printNiftySelect() with port type options. All OIF options
2238 // for the default IIF will be shown, but only the default OIFs will be present
2239 // for each other IIFs. IIFs, for which there is no default OIF, will not
2240 // be listed.
2241 // This SELECT will be used for the "add new port" form.
2242 function getNewPortTypeOptions()
2243 {
2244 $ret = array();
2245 $prefs = getPortListPrefs();
2246 foreach (getPortInterfaceCompat() as $row)
2247 {
2248 if ($row['iif_id'] == $prefs['iif_pick'])
2249 $optgroup = $row['iif_name'];
2250 elseif (array_key_exists ($row['iif_id'], $prefs['oif_picks']) and $prefs['oif_picks'][$row['iif_id']] == $row['oif_id'])
2251 $optgroup = 'other';
2252 else
2253 continue;
2254 if (!array_key_exists ($optgroup, $ret))
2255 $ret[$optgroup] = array();
2256 $ret[$optgroup][$row['iif_id'] . '-' . $row['oif_id']] = $row['oif_name'];
2257 }
2258 return $ret;
2259 }
2260
2261 function getVLANDomain ($vdid)
2262 {
2263 $ret = getVLANDomainInfo ($vdid);
2264 $ret['vlanlist'] = array();
2265 foreach (getDomainVLANs ($vdid) as $vlan_id => $vlan_descr)
2266 $ret['vlanlist'][$vlan_id] = $vlan_descr;
2267 $ret['switchlist'] = getVLANDomainSwitches ($vdid);
2268 return $ret;
2269 }
2270
2271 // Return a serialized version of VLAN configuration for a port.
2272 // If a native VLAN is defined, print it first. All other VLANs
2273 // are tagged and are listed after a plus sign. When no configuration
2274 // is set for a port, return "default" string.
2275 function serializeVLANPack ($vlanport)
2276 {
2277 if (!array_key_exists ('mode', $vlanport))
2278 return 'error';
2279 switch ($vlanport['mode'])
2280 {
2281 case 'none':
2282 return 'none';
2283 case 'access':
2284 $ret = 'A';
2285 break;
2286 case 'trunk':
2287 $ret = 'T';
2288 break;
2289 case 'uplink':
2290 $ret = 'U';
2291 break;
2292 case 'downlink':
2293 $ret = 'D';
2294 break;
2295 default:
2296 return 'error';
2297 }
2298 $tagged = array();
2299 foreach ($vlanport['allowed'] as $vlan_id)
2300 if ($vlan_id != $vlanport['native'])
2301 $tagged[] = $vlan_id;
2302 sort ($tagged);
2303 $ret .= $vlanport['native'] ? $vlanport['native'] : '';
2304 $tagged_bits = array();
2305 $id_from = $id_to = 0;
2306 foreach ($tagged as $next_id)
2307 {
2308 if ($id_to)
2309 {
2310 if ($next_id == $id_to + 1) // merge
2311 {
2312 $id_to = $next_id;
2313 continue;
2314 }
2315 // flush
2316 $tagged_bits[] = $id_from == $id_to ? $id_from : "${id_from}-${id_to}";
2317 }
2318 $id_from = $id_to = $next_id; // start next pair
2319 }
2320 // pull last pair
2321 if ($id_to)
2322 $tagged_bits[] = $id_from == $id_to ? $id_from : "${id_from}-${id_to}";
2323 if (count ($tagged))
2324 $ret .= '+' . implode (', ', $tagged_bits);
2325 return strlen ($ret) ? $ret : 'default';
2326 }
2327
2328 // Decode VLAN compound key (which is a string formatted DOMAINID-VLANID) and
2329 // return the numbers as an array of two.
2330 function decodeVLANCK ($string)
2331 {
2332 $matches = array();
2333 if (1 != preg_match ('/^([[:digit:]]+)-([[:digit:]]+)$/', $string, $matches))
2334 throw new InvalidArgException ('VLAN compound key', $string);
2335 return array ($matches[1], $matches[2]);
2336 }
2337
2338 // Return VLAN name formatted for HTML output (note, that input
2339 // argument comes from database unescaped).
2340 function formatVLANName ($vlaninfo, $context = 'markup long')
2341 {
2342 switch ($context)
2343 {
2344 case 'option':
2345 $ret = $vlaninfo['vlan_id'];
2346 if ($vlaninfo['vlan_descr'] != '')
2347 $ret .= ' ' . niftyString ($vlaninfo['vlan_descr']);
2348 return $ret;
2349 case 'label':
2350 $ret = $vlaninfo['vlan_id'];
2351 if ($vlaninfo['vlan_descr'] != '')
2352 $ret .= ' <i>(' . niftyString ($vlaninfo['vlan_descr']) . ')</i>';
2353 return $ret;
2354 case 'plain long':
2355 $ret = 'VLAN' . $vlaninfo['vlan_id'];
2356 if ($vlaninfo['vlan_descr'] != '')
2357 $ret .= ' (' . niftyString ($vlaninfo['vlan_descr']) . ')';
2358 return $ret;
2359 case 'markup long':
2360 default:
2361 $ret = 'VLAN' . $vlaninfo['vlan_id'];
2362 $ret .= ' @' . niftyString ($vlaninfo['domain_descr']);
2363 if ($vlaninfo['vlan_descr'] != '')
2364 $ret .= ' <i>(' . niftyString ($vlaninfo['vlan_descr']) . ')</i>';
2365 return $ret;
2366 }
2367 }
2368
2369 function ios12ReadVLANConfig ($input)
2370 {
2371 $ret = array
2372 (
2373 'vlanlist' => array(),
2374 'portdata' => array(),
2375 );
2376 $procfunc = 'ios12ScanTopLevel';
2377 foreach (explode ("\n", $input) as $line)
2378 $procfunc = $procfunc ($ret, $line);
2379 return $ret;
2380 }
2381
2382 function ios12ScanTopLevel (&$work, $line)
2383 {
2384 $matches = array();
2385 switch (TRUE)
2386 {
2387 case (preg_match ('@^interface ((Ethernet|FastEthernet|GigabitEthernet|TenGigabitEthernet|Port-channel)[[:digit:]]+(/[[:digit:]]+)*)$@', $line, $matches)):
2388 // map interface name
2389 $matches[1] = preg_replace ('@^Ethernet(.+)$@', 'et\\1', $matches[1]);
2390 $matches[1] = preg_replace ('@^FastEthernet(.+)$@', 'fa\\1', $matches[1]);
2391 $matches[1] = preg_replace ('@^GigabitEthernet(.+)$@', 'gi\\1', $matches[1]);
2392 $matches[1] = preg_replace ('@^TenGigabitEthernet(.+)$@', 'te\\1', $matches[1]);
2393 $matches[1] = preg_replace ('@^Port-channel(.+)$@', 'po\\1', $matches[1]);
2394 $work['current'] = array ('port_name' => $matches[1]);
2395 return 'ios12PickSwitchportCommand'; // switch to interface block reading
2396 case (preg_match ('/^VLAN Name Status Ports$/', $line, $matches)):
2397 return 'ios12PickVLANCommand';
2398 default:
2399 return __FUNCTION__; // continue scan
2400 }
2401 }
2402
2403 function ios12PickSwitchportCommand (&$work, $line)
2404 {
2405 if ($line[0] != ' ') // end of interface section
2406 {
2407 // save work, if it makes sense
2408 switch (TRUE)
2409 {
2410 case $work['current']['ignore']:
2411 $work['portdata'][$work['current']['port_name']] = array
2412 (
2413 'mode' => 'none',
2414 'allowed' => array(),
2415 'native' => 0,
2416 );
2417 break;
2418 case 'access' == $work['current']['mode']:
2419 if (!array_key_exists ('access vlan', $work['current']))
2420 $work['current']['access vlan'] = 1;
2421 $work['portdata'][$work['current']['port_name']] = array
2422 (
2423 'mode' => 'access',
2424 'allowed' => array ($work['current']['access vlan']),
2425 'native' => $work['current']['access vlan'],
2426 );
2427 break;
2428 case 'trunk' == $work['current']['mode']:
2429 if (!array_key_exists ('trunk native vlan', $work['current']))
2430 $work['current']['trunk native vlan'] = 1;
2431 if (!array_key_exists ('trunk allowed vlan', $work['current']))
2432 $work['current']['trunk allowed vlan'] = range (VLAN_MIN_ID, VLAN_MAX_ID);
2433 // Having configured VLAN as "native" doesn't mean anything
2434 // as long as it's not listed on the "allowed" line.
2435 $effective_native = in_array
2436 (
2437 $work['current']['trunk native vlan'],
2438 $work['current']['trunk allowed vlan']
2439 ) ? $work['current']['trunk native vlan'] : 0;
2440 $work['portdata'][$work['current']['port_name']] = array
2441 (
2442 'mode' => 'trunk',
2443 'allowed' => $work['current']['trunk allowed vlan'],
2444 'native' => $effective_native,
2445 );
2446 break;
2447 default:
2448 // dot1q-tunnel, dynamic, private-vlan or even none --
2449 // show in returned config and let user decide, if they
2450 // want to fix device config or work around these ports
2451 // by means of VST.
2452 $work['portdata'][$work['current']['port_name']] = array
2453 (
2454 'mode' => 'none',
2455 'allowed' => array(),
2456 'native' => 0,
2457 );
2458 break;
2459 }
2460 unset ($work['current']);
2461 return 'ios12ScanTopLevel';
2462 }
2463 // not yet
2464 $matches = array();
2465 switch (TRUE)
2466 {
2467 case (preg_match ('@^ switchport mode (.+)$@', $line, $matches)):
2468 $work['current']['mode'] = $matches[1];
2469 break;
2470 case (preg_match ('@^ switchport access vlan (.+)$@', $line, $matches)):
2471 $work['current']['access vlan'] = $matches[1];
2472 break;
2473 case (preg_match ('@^ switchport trunk native vlan (.+)$@', $line, $matches)):
2474 $work['current']['trunk native vlan'] = $matches[1];
2475 break;
2476 case (preg_match ('@^ switchport trunk allowed vlan add (.+)$@', $line, $matches)):
2477 $work['current']['trunk allowed vlan'] = array_merge
2478 (
2479 $work['current']['trunk allowed vlan'],
2480 iosParseVLANString ($matches[1])
2481 );
2482 break;
2483 case (preg_match ('@^ switchport trunk allowed vlan (.+)$@', $line, $matches)):
2484 $work['current']['trunk allowed vlan'] = iosParseVLANString ($matches[1]);
2485 break;
2486 case preg_match ('@^ channel-group @', $line):
2487 // port-channel subinterface config follows that of the master interface
2488 case preg_match ('@^ ip address @', $line):
2489 // L3 interface does no switchport functions
2490 $work['current']['ignore'] = TRUE;
2491 break;
2492 default: // suppress warning on irrelevant config clause
2493 }
2494 return __FUNCTION__;
2495 }
2496
2497 function ios12PickVLANCommand (&$work, $line)
2498 {
2499 $matches = array();
2500 switch (TRUE)
2501 {
2502 case ($line == '---- -------------------------------- --------- -------------------------------'):
2503 // ignore the rest of VLAN table header;
2504 break;
2505 case (preg_match ('@! END OF VLAN LIST$@', $line)):
2506 return 'ios12ScanTopLevel';
2507 case (preg_match ('@^([[:digit:]]+) {1,4}.{32} active @', $line, $matches)):
2508 if (!array_key_exists ($matches[1], $work['vlanlist']))
2509 $work['vlanlist'][] = $matches[1];
2510 break;
2511 default:
2512 }
2513 return __FUNCTION__;
2514 }
2515
2516 function iosParseVLANString ($string)
2517 {
2518 $ret = array();
2519 foreach (explode (',', $string) as $item)
2520 {
2521 $matches = array();
2522 $item = trim ($item, ' ');
2523 if (preg_match ('/^([[:digit:]]+)$/', $item, $matches))
2524 $ret[] = $matches[1];
2525 elseif (preg_match ('/^([[:digit:]]+)-([[:digit:]]+)$/', $item, $matches))
2526 $ret = array_merge ($ret, range ($matches[1], $matches[2]));
2527 }
2528 return $ret;
2529 }
2530
2531 // Another finite automata to read a dialect of Foundry configuration.
2532 function fdry5ReadVLANConfig ($input)
2533 {
2534 $ret = array
2535 (
2536 'vlanlist' => array(),
2537 'portdata' => array(),
2538 );
2539 $procfunc = 'fdry5ScanTopLevel';
2540 foreach (explode ("\n", $input) as $line)
2541 $procfunc = $procfunc ($ret, $line);
2542 return $ret;
2543 }
2544
2545 function fdry5ScanTopLevel (&$work, $line)
2546 {
2547 $matches = array();
2548 switch (TRUE)
2549 {
2550 case (preg_match ('@^vlan ([[:digit:]]+)( name .+)? (by port)$@', $line, $matches)):
2551 if (!array_key_exists ($matches[1], $work['vlanlist']))
2552 $work['vlanlist'][] = $matches[1];
2553 $work['current'] = array ('vlan_id' => $matches[1]);
2554 return 'fdry5PickVLANSubcommand';
2555 case (preg_match ('@^interface ethernet ([[:digit:]]+/[[:digit:]]+/[[:digit:]]+)$@', $line, $matches)):
2556 $work['current'] = array ('port_name' => 'e' . $matches[1]);
2557 return 'fdry5PickInterfaceSubcommand';
2558 default:
2559 return __FUNCTION__;
2560 }
2561 }
2562
2563 function fdry5PickVLANSubcommand (&$work, $line)
2564 {
2565 if ($line[0] != ' ') // end of VLAN section
2566 {
2567 unset ($work['current']);
2568 return 'fdry5ScanTopLevel';
2569 }
2570 // not yet
2571 $matches = array();
2572 switch (TRUE)
2573 {
2574 case (preg_match ('@^ tagged (.+)$@', $line, $matches)):
2575 // add current VLAN to 'allowed' list of each mentioned port
2576 foreach (fdry5ParsePortString ($matches[1]) as $port_name)
2577 if (array_key_exists ($port_name, $work['portdata']))
2578 $work['portdata'][$port_name]['allowed'][] = $work['current']['vlan_id'];
2579 else
2580 $work['portdata'][$port_name] = array
2581 (
2582 'mode' => 'trunk',
2583 'allowed' => array ($work['current']['vlan_id']),
2584 'native' => 0, // can be updated later
2585 );
2586 $work['portdata'][$port_name]['mode'] = 'trunk';
2587 break;
2588 case (preg_match ('@^ untagged (.+)$@', $line, $matches)):
2589 // replace 'native' column of each mentioned port with current VLAN ID
2590 foreach (fdry5ParsePortString ($matches[1]) as $port_name)
2591 {
2592 if (array_key_exists ($port_name, $work['portdata']))
2593 {
2594 $work['portdata'][$port_name]['native'] = $work['current']['vlan_id'];
2595 $work['portdata'][$port_name]['allowed'][] = $work['current']['vlan_id'];
2596 }
2597 else
2598 $work['portdata'][$port_name] = array
2599 (
2600 'mode' => 'access',
2601 'allowed' => array ($work['current']['vlan_id']),
2602 'native' => $work['current']['vlan_id'],
2603 );
2604 // Untagged ports are initially assumed to be access ports, and
2605 // when this assumption is right, this is the final port mode state.
2606 // When the port is dual-mode one, this is detected and justified
2607 // later in "interface" section of config text.
2608 $work['portdata'][$port_name]['mode'] = 'access';
2609 }
2610 break;
2611 default: // nom-nom
2612 }
2613 return __FUNCTION__;
2614 }
2615
2616 function fdry5PickInterfaceSubcommand (&$work, $line)
2617 {
2618 if ($line[0] != ' ') // end of interface section
2619 {
2620 if (array_key_exists ('dual-mode', $work['current']))
2621 {
2622 if (array_key_exists ($work['current']['port_name'], $work['portdata']))
2623 // update existing record
2624 $work['portdata'][$work['current']['port_name']]['native'] = $work['current']['dual-mode'];
2625 else
2626 // add new
2627 $work['portdata'][$work['current']['port_name']] = array
2628 (
2629 'allowed' => array ($work['current']['dual-mode']),
2630 'native' => $work['current']['dual-mode'],
2631 );
2632 // a dual-mode port is always considered a trunk port
2633 // (but not in the IronWare's meaning of "trunk") regardless of
2634 // number of assigned tagged VLANs
2635 $work['portdata'][$work['current']['port_name']]['mode'] = 'trunk';
2636 }
2637 unset ($work['current']);
2638 return 'fdry5ScanTopLevel';
2639 }
2640 $matches = array();
2641 switch (TRUE)
2642 {
2643 case (preg_match ('@^ dual-mode( +[[:digit:]]+ *)?$@', $line, $matches)):
2644 // default VLAN ID for dual-mode command is 1
2645 $work['current']['dual-mode'] = strlen (trim ($matches[1])) ? trim ($matches[1]) : 1;
2646 break;
2647 // FIXME: trunk/link-aggregate/ip address pulls port from 802.1Q field
2648 default: // nom-nom
2649 }
2650 return __FUNCTION__;
2651 }
2652
2653 function fdry5ParsePortString ($string)
2654 {
2655 $ret = array();
2656 $tokens = explode (' ', trim ($string));
2657 while (count ($tokens))
2658 {
2659 $letters = array_shift ($tokens); // "ethe", "to"
2660 $numbers = array_shift ($tokens); // "x", "x/x", "x/x/x"
2661 switch ($letters)
2662 {
2663 case 'ethe':
2664 if ($prev_numbers != NULL)
2665 $ret[] = 'e' . $prev_numbers;
2666 $prev_numbers = $numbers;
2667 break;
2668 case 'to':
2669 $ret = array_merge ($ret, fdry5GenPortRange ($prev_numbers, $numbers));
2670 $prev_numbers = NULL; // no action on next token
2671 break;
2672 default: // ???
2673 return array();
2674 }
2675 }
2676 // flush delayed item
2677 if ($prev_numbers != NULL)
2678 $ret[] = 'e' . $prev_numbers;
2679 return $ret;
2680 }
2681
2682 // Take two indices in form "x", "x/x" or "x/x/x" and return the range of
2683 // ports spanning from the first to the last. The switch software makes it
2684 // easier to perform, because "ethe x/x/x to y/y/y" ranges never cross
2685 // unit/slot boundary (every index except the last remains constant).
2686 function fdry5GenPortRange ($from, $to)
2687 {
2688 $matches = array();
2689 if (1 !== preg_match ('@^([[:digit:]]+/)?([[:digit:]]+/)?([[:digit:]]+)$@', $from, $matches))
2690 return array();
2691 $prefix = 'e' . $matches[1] . $matches[2];
2692 $from_idx = $matches[3];
2693 if (1 !== preg_match ('@^([[:digit:]]+/)?([[:digit:]]+/)?([[:digit:]]+)$@', $to, $matches))
2694 return array();
2695 $to_idx = $matches[3];
2696 for ($i = $from_idx; $i <= $to_idx; $i++)
2697 $ret[] = $prefix . $i;
2698 return $ret;
2699 }
2700
2701 // an implementation for Huawei syntax
2702 function vrp53ReadVLANConfig ($input)
2703 {
2704 $ret = array
2705 (
2706 'vlanlist' => array(),
2707 'portdata' => array(),
2708 );
2709 $procfunc = 'vrp53ScanTopLevel';
2710 foreach (explode ("\n", $input) as $line)
2711 $procfunc = $procfunc ($ret, $line);
2712 return $ret;
2713 }
2714
2715 function vrp53ScanTopLevel (&$work, $line)
2716 {
2717 $matches = array();
2718 switch (TRUE)
2719 {
2720 case (preg_match ('@^ vlan batch (.+)$@', $line, $matches)):
2721 foreach (vrp53ParseVLANString ($matches[1]) as $vlan_id)
2722 $work['vlanlist'][] = $vlan_id;
2723 return __FUNCTION__;
2724 case (preg_match ('@^interface ((GigabitEthernet|XGigabitEthernet|Eth-Trunk)([[:digit:]]+(/[[:digit:]]+)*))$@', $line, $matches)):
2725 $matches[1] = preg_replace ('@^GigabitEthernet(.+)$@', 'gi\\1', $matches[1]);
2726 $matches[1] = preg_replace ('@^XGigabitEthernet(.+)$@', 'xg\\1', $matches[1]);
2727 $matches[1] = preg_replace ('@^Eth-Trunk(.+)$@', 'et\\1', $matches[1]);
2728 $work['current'] = array ('port_name' => $matches[1]);
2729 return 'vrp53PickInterfaceSubcommand';
2730 default:
2731 return __FUNCTION__;
2732 }
2733 }
2734
2735 function vrp53ParseVLANString ($string)
2736 {
2737 $string = preg_replace ('/ to /', '-', $string);
2738 $string = preg_replace ('/ /', ',', $string);
2739 return iosParseVLANString ($string);
2740 }
2741
2742 function vrp53PickInterfaceSubcommand (&$work, $line)
2743 {
2744 if ($line[0] == '#') // end of interface section
2745 {
2746 // Configuration Guide - Ethernet 3.3.4:
2747 // "By default, the interface type is hybrid."
2748 if (!array_key_exists ('link-type', $work['current']))
2749 $work['current']['link-type'] = 'hybrid';
2750 if (!array_key_exists ('allowed', $work['current']))
2751 $work['current']['allowed'] = array();
2752 if (!array_key_exists ('native', $work['current']))
2753 $work['current']['native'] = 0;
2754 switch ($work['current']['link-type'])
2755 {
2756 case 'access':
2757 // VRP does not assign access ports to VLAN1 by default,
2758 // leaving them blocked.
2759 $work['portdata'][$work['current']['port_name']] =
2760 $work['current']['native'] ? array
2761 (
2762 'allowed' => $work['current']['allowed'],
2763 'native' => $work['current']['native'],
2764 'mode' => 'access',
2765 ) : array
2766 (
2767 'mode' => 'none',
2768 'allowed' => array(),
2769 'native' => 0,
2770 );
2771 break;
2772 case 'trunk':
2773 $work['portdata'][$work['current']['port_name']] = array
2774 (
2775 'allowed' => $work['current']['allowed'],
2776 'native' => 0,
2777 'mode' => 'trunk',
2778 );
2779 break;
2780 case 'hybrid':
2781 $work['portdata'][$work['current']['port_name']] = array
2782 (
2783 'allowed' => $work['current']['allowed'],
2784 'native' => $work['current']['native'],
2785 'mode' => 'trunk',
2786 );
2787 break;
2788 default: // dot1q-tunnel ?
2789 }
2790 unset ($work['current']);
2791 return 'vrp53ScanTopLevel';
2792 }
2793 $matches = array();
2794 switch (TRUE)
2795 {
2796 case (preg_match ('@^ port default vlan ([[:digit:]]+)$@', $line, $matches)):
2797 $work['current']['native'] = $matches[1];
2798 if (!array_key_exists ('allowed', $work['current']))
2799 $work['current']['allowed'] = array();
2800 if (!in_array ($matches[1], $work['current']['allowed']))
2801 $work['current']['allowed'][] = $matches[1];
2802 break;
2803 case (preg_match ('@^ port link-type (.+)$@', $line, $matches)):
2804 $work['current']['link-type'] = $matches[1];
2805 break;
2806 case (preg_match ('@^ port trunk allow-pass vlan (.+)$@', $line, $matches)):
2807 if (!array_key_exists ('allowed', $work['current']))
2808 $work['current']['allowed'] = array();
2809 foreach (vrp53ParseVLANString ($matches[1]) as $vlan_id)
2810 if (!in_array ($vlan_id, $work['current']['allowed']))
2811 $work['current']['allowed'][] = $vlan_id;
2812 break;
2813 // TODO: make sure, that a port with "eth-trunk" clause always ends up in "none" mode
2814 default: // nom-nom
2815 }
2816 return __FUNCTION__;
2817 }
2818
2819 function nxos4Read8021QConfig ($input)
2820 {
2821 $ret = array
2822 (
2823 'vlanlist' => array(),
2824 'portdata' => array(),
2825 );
2826 $procfunc = 'nxos4ScanTopLevel';
2827 foreach (explode ("\n", $input) as $line)
2828 $procfunc = $procfunc ($ret, $line);
2829 return $ret;
2830 }
2831
2832 function nxos4ScanTopLevel (&$work, $line)
2833 {
2834 $matches = array();
2835 switch (TRUE)
2836 {
2837 case (preg_match ('@^interface ((Ethernet)[[:digit:]]+(/[[:digit:]]+)*)$@', $line, $matches)):
2838 $matches[1] = preg_replace ('@^Ethernet(.+)$@', 'e\\1', $matches[1]);
2839 $work['current'] = array ('port_name' => $matches[1]);
2840 return 'nxos4PickSwitchportCommand';
2841 case (preg_match ('@^vlan ([[:digit:]]+)$@', $line, $matches)):
2842 $work['vlanlist'][] = $matches[1];
2843 return 'nxos4PickVLANs';
2844 default:
2845 return __FUNCTION__; // continue scan
2846 }
2847 }
2848
2849 function nxos4PickVLANs (&$work, $line)
2850 {
2851 switch (TRUE)
2852 {
2853 case ($line == ''): // end of VLAN list
2854 return 'nxos4ScanTopLevel';
2855 case (preg_match ('@^vlan ([[:digit:]]+)$@', $line, $matches)):
2856 $work['vlanlist'][] = $matches[1];
2857 default: // VLAN name or any other text
2858 return __FUNCTION__;
2859 }
2860 }
2861
2862 function nxos4PickSwitchportCommand (&$work, $line)
2863 {
2864 if ($line == '') // end of interface section
2865 {
2866 // fill in defaults
2867 // below assumes "system default switchport" mode set on the device
2868 if (!array_key_exists ('mode', $work['current']))
2869 $work['current']['mode'] = 'access';
2870 // save work, if it makes sense
2871 switch ($work['current']['mode'])
2872 {
2873 case 'access':
2874 if (!array_key_exists ('access vlan', $work['current']))
2875 $work['current']['access vlan'] = 1;
2876 $work['portdata'][$work['current']['port_name']] = array
2877 (
2878 'mode' => 'access',
2879 'allowed' => array ($work['current']['access vlan']),
2880 'native' => $work['current']['access vlan'],
2881 );
2882 break;
2883 case 'trunk':
2884 if (!array_key_exists ('trunk native vlan', $work['current']))
2885 $work['current']['trunk native vlan'] = 1;
2886 if (!array_key_exists ('trunk allowed vlan', $work['current']))
2887 $work['current']['trunk allowed vlan'] = range (VLAN_MIN_ID, VLAN_MAX_ID);
2888 // Having configured VLAN as "native" doesn't mean anything
2889 // as long as it's not listed on the "allowed" line.
2890 $effective_native = in_array
2891 (
2892 $work['current']['trunk native vlan'],
2893 $work['current']['trunk allowed vlan']
2894 ) ? $work['current']['trunk native vlan'] : 0;
2895 $work['portdata'][$work['current']['port_name']] = array
2896 (
2897 'mode' => 'trunk',
2898 'allowed' => $work['current']['trunk allowed vlan'],
2899 'native' => $effective_native,
2900 );
2901 break;
2902 default:
2903 // dot1q-tunnel, dynamic, private-vlan --- skip these
2904 }
2905 unset ($work['current']);
2906 return 'nxos4ScanTopLevel';
2907 }
2908 // not yet
2909 $matches = array();
2910 switch (TRUE)
2911 {
2912 case (preg_match ('@^ switchport mode (.+)$@', $line, $matches)):
2913 $work['current']['mode'] = $matches[1];
2914 break;
2915 case (preg_match ('@^ switchport access vlan (.+)$@', $line, $matches)):
2916 $work['current']['access vlan'] = $matches[1];
2917 break;
2918 case (preg_match ('@^ switchport trunk native vlan (.+)$@', $line, $matches)):
2919 $work['current']['trunk native vlan'] = $matches[1];
2920 break;
2921 case (preg_match ('@^ switchport trunk allowed vlan add (.+)$@', $line, $matches)):
2922 $work['current']['trunk allowed vlan'] = array_merge
2923 (
2924 $work['current']['trunk allowed vlan'],
2925 iosParseVLANString ($matches[1])
2926 );
2927 break;
2928 case (preg_match ('@^ switchport trunk allowed vlan (.+)$@', $line, $matches)):
2929 $work['current']['trunk allowed vlan'] = iosParseVLANString ($matches[1]);
2930 break;
2931 default: // suppress warning on irrelevant config clause
2932 }
2933 return __FUNCTION__;
2934 }
2935
2936 // Scan given array and return the key, which addresses the first item
2937 // with requested column set to given value (or NULL if there is none such).
2938 // Note that 0 and NULL mean completely different things and thus
2939 // require strict checking (=== and !===).
2940 function scanArrayForItem ($table, $scan_column, $scan_value)
2941 {
2942 foreach ($table as $key => $row)
2943 if ($row[$scan_column] == $scan_value)
2944 return $key;
2945 return NULL;
2946 }
2947
2948 // Get a list of VLAN management pseudo-commands and return a text
2949 // of real vendor-specific commands, which implement the work.
2950 // This work is done in two rounds:
2951 // 1. For "add allowed" and "rem allowed" commands detect continuous
2952 // sequences of VLAN IDs and replace them with ranges of form "A-B",
2953 // where B>A.
2954 // 2. Iterate over the resulting list and produce real CLI commands.
2955 function ios12TranslatePushQueue ($queue)
2956 {
2957 $ret = "configure terminal\n";
2958 foreach ($queue as $cmd)
2959 switch ($cmd['opcode'])
2960 {
2961 case 'create VLAN':
2962 $ret .= "vlan ${cmd['arg1']}\nexit\n";
2963 break;
2964 case 'destroy VLAN':
2965 $ret .= "no vlan ${cmd['arg1']}\n";
2966 break;
2967 case 'add allowed':
2968 case 'rem allowed':
2969 $clause = $cmd['opcode'] == 'add allowed' ? 'add' : 'remove';
2970 $ret .= "interface ${cmd['port']}\n";
2971 foreach (listToRanges ($cmd['vlans']) as $range)
2972 $ret .= "switchport trunk allowed vlan ${clause} " .
2973 ($range['from'] == $range['to'] ? $range['to'] : "${range['from']}-${range['to']}") .
2974 "\n";
2975 $ret .= "exit\n";
2976 break;
2977 case 'set native':
2978 $ret .= "interface ${cmd['arg1']}\nswitchport trunk native vlan ${cmd['arg2']}\nexit\n";
2979 break;
2980 case 'unset native':
2981 $ret .= "interface ${cmd['arg1']}\nno switchport trunk native vlan ${cmd['arg2']}\nexit\n";
2982 break;
2983 case 'set access':
2984 $ret .= "interface ${cmd['arg1']}\nswitchport access vlan ${cmd['arg2']}\nexit\n";
2985 break;
2986 case 'unset access':
2987 $ret .= "interface ${cmd['arg1']}\nno switchport access vlan\nexit\n";
2988 break;
2989 case 'set mode':
2990 $ret .= "interface ${cmd['arg1']}\nswitchport mode ${cmd['arg2']}\n";
2991 if ($cmd['arg2'] == 'trunk')
2992 $ret .= "no switchport trunk native vlan\nswitchport trunk allowed vlan none\n";
2993 $ret .= "exit\n";
2994 break;
2995 }
2996 $ret .= "end\n";
2997 if (getConfigVar ('8021Q_WRI_AFTER_CONFT') == 'yes')
2998 $ret .= "copy running-config startup-config\n";
2999 return $ret;
3000 }
3001
3002 function fdry5TranslatePushQueue ($queue)
3003 {
3004 $ret = "conf t\n";
3005 foreach ($queue as $cmd)
3006 switch ($cmd['opcode'])
3007 {
3008 case 'create VLAN':
3009 $ret .= "vlan ${cmd['arg1']}\nexit\n";
3010 break;
3011 case 'destroy VLAN':
3012 $ret .= "no vlan ${cmd['arg1']}\n";
3013 break;
3014 case 'add allowed':
3015 foreach ($cmd['vlans'] as $vlan_id)
3016 $ret .= "vlan ${vlan_id}\ntagged ${cmd['port']}\nexit\n";
3017 break;
3018 case 'rem allowed':
3019 foreach ($cmd['vlans'] as $vlan_id)
3020 $ret .= "vlan ${vlan_id}\nno tagged ${cmd['port']}\nexit\n";
3021 break;
3022 case 'set native':
3023 $ret .= "interface ${cmd['arg1']}\ndual-mode ${cmd['arg2']}\nexit\n";
3024 break;
3025 case 'unset native':
3026 $ret .= "interface ${cmd['arg1']}\nno dual-mode ${cmd['arg2']}\nexit\n";
3027 break;
3028 case 'set access':
3029 $ret .= "vlan ${cmd['arg2']}\nuntagged ${cmd['arg1']}\nexit\n";
3030 break;
3031 case 'unset access':
3032 $ret .= "vlan ${cmd['arg2']}\nno untagged ${cmd['arg1']}\nexit\n";
3033 break;
3034 case 'set mode': // NOP
3035 break;
3036 }
3037 $ret .= "end\n";
3038 if (getConfigVar ('8021Q_WRI_AFTER_CONFT') == 'yes')
3039 $ret .= "write memory\n";
3040 return $ret;
3041 }
3042
3043 function vrp53TranslatePushQueue ($queue)
3044 {
3045 $ret = "system-view\n";
3046 foreach ($queue as $cmd)
3047 switch ($cmd['opcode'])
3048 {
3049 case 'create VLAN':
3050 $ret .= "vlan ${cmd['arg1']}\nquit\n";
3051 break;
3052 case 'destroy VLAN':
3053 $ret .= "undo vlan ${cmd['arg1']}\n";
3054 break;
3055 case 'add allowed':
3056 case 'rem allowed':
3057 $clause = $cmd['opcode'] == 'add allowed' ? '' : 'undo ';
3058 $ret .= "interface ${cmd['port']}\n";
3059 foreach (listToRanges ($cmd['vlans']) as $range)
3060 $ret .= "${clause}port trunk allow-pass vlan " .
3061 ($range['from'] == $range['to'] ? $range['to'] : "${range['from']} to ${range['to']}") .
3062 "\n";
3063 $ret .= "quit\n";
3064 break;
3065 case 'set native':
3066 case 'set access':
3067 $ret .= "interface ${cmd['arg1']}\nport default vlan ${cmd['arg2']}\nquit\n";
3068 break;
3069 case 'unset native':
3070 case 'unset access':
3071 $ret .= "interface ${cmd['arg1']}\nundo port default vlan\nquit\n";
3072 break;
3073 case 'set mode':
3074 $modemap = array ('access' => 'access', 'trunk' => 'hybrid');
3075 $ret .= "interface ${cmd['arg1']}\nport link-type " . $modemap[$cmd['arg2']] . "\n";
3076 if ($cmd['arg2'] == 'hybrid')
3077 $ret .= "undo port default vlan\nundo port trunk allow-pass vlan all\n";
3078 $ret .= "quit\n";
3079 break;
3080 }
3081 $ret .= "return\n";
3082 if (getConfigVar ('8021Q_WRI_AFTER_CONFT') == 'yes')
3083 $ret .= "save\n";
3084 return $ret;
3085 }
3086
3087 // Return TRUE, if every value of A1 is present in A2 and vice versa,
3088 // regardless of each array's sort order and indexing.
3089 function array_values_same ($a1, $a2)
3090 {
3091 return !count (array_diff ($a1, $a2)) and !count (array_diff ($a2, $a1));
3092 }
3093
3094 // Use the VLAN switch template to set VST role for each port of
3095 // the provided list. Return resulting list.
3096 function apply8021QOrder ($vst_id, $portlist)
3097 {
3098 $vst = getVLANSwitchTemplate ($vst_id);
3099 foreach (array_keys ($portlist) as $port_name)
3100 {
3101 foreach ($vst['rules'] as $rule)
3102 if (preg_match ($rule['port_pcre'], $port_name))
3103 {
3104 $portlist[$port_name]['vst_role'] = $rule['port_role'];
3105 $portlist[$port_name]['wrt_vlans'] = buildVLANFilter ($rule['port_role'], $rule['wrt_vlans']);
3106 continue 2;
3107 }
3108 $portlist[$port_name]['vst_role'] = 'none';
3109 }
3110 return $portlist;
3111 }
3112
3113 // return a sequence of ranges for given string form and port role
3114 function buildVLANFilter ($role, $string)
3115 {
3116 // set base
3117 switch ($role)
3118 {
3119 case 'access': // 1-4094
3120 $min = VLAN_MIN_ID;
3121 $max = VLAN_MAX_ID;
3122 break;
3123 case 'trunk': // 2-4094
3124 case 'uplink':
3125 case 'downlink':
3126 $min = VLAN_MIN_ID + 1;
3127 $max = VLAN_MAX_ID;
3128 break;
3129 default: // none
3130 return array();
3131 }
3132 if ($string == '') // fast track
3133 return array (array ('from' => $min, 'to' => $max));
3134 // transform
3135 $vlanidlist = array();
3136 foreach (iosParseVLANString ($string) as $vlan_id)
3137 if ($min <= $vlan_id and $vlan_id <= $max)
3138 $vlanidlist[] = $vlan_id;
3139 return listToRanges ($vlanidlist);
3140 }
3141
3142 // pack set of integers into list of integer ranges
3143 // e.g. (1, 2, 3, 5, 6, 7, 9, 11) => ((1, 3), (5, 7), (9, 9), (11, 11))
3144 function listToRanges ($vlanidlist)
3145 {
3146 sort ($vlanidlist);
3147 $ret = array();
3148 $from = $to = NULL;
3149 foreach ($vlanidlist as $vlan_id)
3150 if ($from == NULL)
3151 $from = $to = $vlan_id;
3152 elseif ($to + 1 == $vlan_id)
3153 $to = $vlan_id;
3154 else
3155 {
3156 $ret[] = array ('from' => $from, 'to' => $to);
3157 $from = $to = $vlan_id;
3158 }
3159 if ($from != NULL)
3160 $ret[] = array ('from' => $from, 'to' => $to);
3161 return $ret;
3162 }
3163
3164 // return TRUE, if given VLAN ID belongs to one of filter's ranges
3165 function matchVLANFilter ($vlan_id, $vfilter)
3166 {
3167 foreach ($vfilter as $range)
3168 if ($range['from'] <= $vlan_id and $vlan_id <= $range['to'])
3169 return TRUE;
3170 return FALSE;
3171 }
3172
3173 function exportSwitch8021QConfig
3174 (
3175 $vswitch,
3176 $device_vlanlist,
3177 $before,
3178 $changes
3179 )
3180 {
3181 // only ignore VLANs, which exist and are explicitly shown as "alien"
3182 $old_managed_vlans = array();
3183 $domain_vlanlist = getDomainVLANs ($vswitch['domain_id']);
3184 foreach ($device_vlanlist as $vlan_id)
3185 if
3186 (
3187 !array_key_exists ($vlan_id, $domain_vlanlist) or
3188 $domain_vlanlist[$vlan_id]['vlan_type'] != 'alien'
3189 )
3190 $old_managed_vlans[] = $vlan_id;
3191 $ports_to_do = array();
3192 $after = $before;
3193 foreach ($changes as $port_name => $port)
3194 {
3195 $ports_to_do[$port_name] = array
3196 (
3197 'old_mode' => $before[$port_name]['mode'],
3198 'old_allowed' => $before[$port_name]['allowed'],
3199 'old_native' => $before[$port_name]['native'],
3200 'new_mode' => $port['mode'],
3201 'new_allowed' => $port['allowed'],
3202 'new_native' => $port['native'],
3203 );
3204 $after[$port_name] = $port;
3205 }
3206 // New VLAN table is a union of:
3207 // 1. all compulsory VLANs
3208 // 2. all "current" non-alien allowed VLANs of those ports, which are left
3209 // intact (regardless if a VLAN exists in VLAN domain, but looking,
3210 // if it is present in device's own VLAN table)
3211 // 3. all "new" allowed VLANs of those ports, which we do "push" now
3212 // Like for old_managed_vlans, a VLANs is never listed, only if it
3213 // exists and belongs to "alien" type.
3214 $new_managed_vlans = array();
3215 // 1
3216 foreach ($domain_vlanlist as $vlan_id => $vlan)
3217 if ($vlan['vlan_type'] == 'compulsory')
3218 $new_managed_vlans[] = $vlan_id;