r3734 upgrade.php: reflect the changes introduced to default schema
[racktables] / inc / functions.php
CommitLineData
b325120a 1<?php
e673ee24
DO
2/*
3*
4* This file is a library of computational functions for RackTables.
5*
6*/
7
8$loclist[0] = 'front';
9$loclist[1] = 'interior';
10$loclist[2] = 'rear';
11$loclist['front'] = 0;
12$loclist['interior'] = 1;
13$loclist['rear'] = 2;
14$template[0] = array (TRUE, TRUE, TRUE);
15$template[1] = array (TRUE, TRUE, FALSE);
16$template[2] = array (FALSE, TRUE, TRUE);
17$template[3] = array (TRUE, FALSE, FALSE);
18$template[4] = array (FALSE, TRUE, FALSE);
19$template[5] = array (FALSE, FALSE, TRUE);
20$templateWidth[0] = 3;
21$templateWidth[1] = 2;
22$templateWidth[2] = 2;
23$templateWidth[3] = 1;
24$templateWidth[4] = 1;
25$templateWidth[5] = 1;
26
482c7f35
DO
27// Entity type by page number mapping is 1:1 atm, but may change later.
28$etype_by_pageno = array
29(
30 'ipv4net' => 'ipv4net',
31 'ipv4rspool' => 'ipv4rspool',
32 'ipv4vs' => 'ipv4vs',
33 'object' => 'object',
34 'rack' => 'rack',
35 'user' => 'user',
36 'file' => 'file',
37);
38
ef4b16fb
DO
39// Rack thumbnail image width summands: "front", "interior" and "rear" elements w/o surrounding border.
40$rtwidth = array
41(
42 0 => 9,
43 1 => 21,
44 2 => 9
45);
46
c8824ff4
DO
47$netmaskbylen = array
48(
49 32 => '255.255.255.255',
50 31 => '255.255.255.254',
51 30 => '255.255.255.252',
52 29 => '255.255.255.248',
53 28 => '255.255.255.240',
54 27 => '255.255.255.224',
55 26 => '255.255.255.192',
56 25 => '255.255.255.128',
57 24 => '255.255.255.0',
58 23 => '255.255.254.0',
59 22 => '255.255.252.0',
60 21 => '255.255.248.0',
61 20 => '255.255.240.0',
62 19 => '255.255.224.0',
63 18 => '255.255.192.0',
64 17 => '255.255.128.0',
65 16 => '255.255.0.0',
66 15 => '255.254.0.0',
67 14 => '255.252.0.0',
68 13 => '255.248.0.0',
69 12 => '255.240.0.0',
70 11 => '255.224.0.0',
71 10 => '255.192.0.0',
72 9 => '255.128.0.0',
73 8 => '255.0.0.0',
74 7 => '254.0.0.0',
75 6 => '252.0.0.0',
76 5 => '248.0.0.0',
77 4 => '240.0.0.0',
78 3 => '224.0.0.0',
79 2 => '192.0.0.0',
80 1 => '128.0.0.0'
81);
82
83$wildcardbylen = array
84(
85 32 => '0.0.0.0',
86 31 => '0.0.0.1',
87 30 => '0.0.0.3',
88 29 => '0.0.0.7',
89 28 => '0.0.0.15',
90 27 => '0.0.0.31',
91 26 => '0.0.0.63',
92 25 => '0.0.0.127',
93 24 => '0.0.0.255',
94 23 => '0.0.1.255',
95 22 => '0.0.3.255',
96 21 => '0.0.7.255',
97 20 => '0.0.15.255',
98 19 => '0.0.31.255',
99 18 => '0.0.63.255',
100 17 => '0.0.127.255',
101 16 => '0.0.255.25',
102 15 => '0.1.255.255',
103 14 => '0.3.255.255',
104 13 => '0.7.255.255',
105 12 => '0.15.255.255',
106 11 => '0.31.255.255',
107 10 => '0.63.255.255',
108 9 => '0.127.255.255',
109 8 => '0.255.255.255',
110 7 => '1.255.255.255',
111 6 => '3.255.255.255',
112 5 => '7.255.255.255',
113 4 => '15.255.255.255',
114 3 => '31.255.255.255',
115 2 => '63.255.255.255',
116 1 => '127.255.255.255'
117);
118
f77323f1
DO
119// This function assures that specified argument was passed
120// and is a number greater than zero.
0cc24e9a 121function assertUIntArg ($argname, $allow_zero = FALSE)
f77323f1
DO
122{
123 if (!isset ($_REQUEST[$argname]))
5847d944 124 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'parameter is missing');
f77323f1 125 if (!is_numeric ($_REQUEST[$argname]))
5847d944 126 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'parameter is not a number');
f77323f1 127 if ($_REQUEST[$argname] < 0)
5847d944 128 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'parameter is less than zero');
ca92dc40 129 if (!$allow_zero and $_REQUEST[$argname] == 0)
5847d944 130 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'parameter is zero');
f77323f1
DO
131}
132
133// This function assures that specified argument was passed
134// and is a non-empty string.
0cc24e9a 135function assertStringArg ($argname, $ok_if_empty = FALSE)
f77323f1
DO
136{
137 if (!isset ($_REQUEST[$argname]))
5847d944 138 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'parameter is missing');
f77323f1 139 if (!is_string ($_REQUEST[$argname]))
5847d944 140 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'parameter is not a string');
f77323f1 141 if (!$ok_if_empty and !strlen ($_REQUEST[$argname]))
5847d944 142 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'parameter is an empty string');
f77323f1
DO
143}
144
0cc24e9a 145function assertBoolArg ($argname, $ok_if_empty = FALSE)
f77323f1
DO
146{
147 if (!isset ($_REQUEST[$argname]))
5847d944 148 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'parameter is missing');
f77323f1 149 if (!is_string ($_REQUEST[$argname]) or $_REQUEST[$argname] != 'on')
5847d944 150 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'parameter is not a string');
f77323f1 151 if (!$ok_if_empty and !strlen ($_REQUEST[$argname]))
5847d944 152 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'parameter is an empty string');
f77323f1
DO
153}
154
0cc24e9a 155function assertIPv4Arg ($argname, $ok_if_empty = FALSE)
f77323f1 156{
0cc24e9a 157 assertStringArg ($argname, $ok_if_empty);
f77323f1 158 if (strlen ($_REQUEST[$argname]) and long2ip (ip2long ($_REQUEST[$argname])) !== $_REQUEST[$argname])
5847d944 159 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'parameter is not a valid ipv4 address');
f77323f1
DO
160}
161
e0d188ef
DO
162function assertPCREArg ($argname)
163{
164 assertStringArg ($argname, TRUE); // empty pattern is Ok
664ec705 165 if (FALSE === preg_match ($_REQUEST[$argname], 'test'))
e0d188ef
DO
166 throw new InvalidRequestArgException($argname, $_REQUEST[$argname], 'PCRE validation failed');
167}
168
e673ee24
DO
169// Objects of some types should be explicitly shown as
170// anonymous (labelless). This function is a single place where the
171// decision about displayed name is made.
cfa8f3cf 172function setDisplayedName (&$cell)
e673ee24 173{
cfa8f3cf
DO
174 if ($cell['name'] != '')
175 $cell['dname'] = $cell['name'];
e673ee24 176 else
212c9d8a 177 {
cfa8f3cf
DO
178 $cell['atags'][] = array ('tag' => '$nameless');
179 if (considerConfiguredConstraint ($cell, 'NAMEWARN_LISTSRC'))
7fa7047a 180 $cell['dname'] = 'ANONYMOUS ' . decodeObjectType ($cell['objtype_id'], 'o');
212c9d8a 181 else
7fa7047a 182 $cell['dname'] = '[' . decodeObjectType ($cell['objtype_id'], 'o') . ']';
212c9d8a 183 }
e673ee24
DO
184}
185
186// This function finds height of solid rectangle of atoms, which are all
187// assigned to the same object. Rectangle base is defined by specified
188// template.
189function rectHeight ($rackData, $startRow, $template_idx)
190{
191 $height = 0;
192 // The first met object_id is used to match all the folowing IDs.
193 $object_id = 0;
194 global $template;
195 do
196 {
197 for ($locidx = 0; $locidx < 3; $locidx++)
198 {
199 // At least one value in template is TRUE, but the following block
200 // can meet 'skipped' atoms. Let's ensure we have something after processing
201 // the first row.
202 if ($template[$template_idx][$locidx])
203 {
204 if (isset ($rackData[$startRow - $height][$locidx]['skipped']))
205 break 2;
93e02204
DO
206 if (isset ($rackData[$startRow - $height][$locidx]['rowspan']))
207 break 2;
208 if (isset ($rackData[$startRow - $height][$locidx]['colspan']))
209 break 2;
e673ee24
DO
210 if ($rackData[$startRow - $height][$locidx]['state'] != 'T')
211 break 2;
212 if ($object_id == 0)
213 $object_id = $rackData[$startRow - $height][$locidx]['object_id'];
214 if ($object_id != $rackData[$startRow - $height][$locidx]['object_id'])
215 break 2;
216 }
217 }
218 // If the first row can't offer anything, bail out.
219 if ($height == 0 and $object_id == 0)
220 break;
221 $height++;
222 }
223 while ($startRow - $height > 0);
93e02204
DO
224# echo "for startRow==${startRow} and template==(" . ($template[$template_idx][0] ? 'T' : 'F');
225# echo ', ' . ($template[$template_idx][1] ? 'T' : 'F') . ', ' . ($template[$template_idx][2] ? 'T' : 'F');
226# echo ") height==${height}<br>\n";
e673ee24
DO
227 return $height;
228}
229
230// This function marks atoms to be avoided by rectHeight() and assigns rowspan/colspan
231// attributes.
232function markSpan (&$rackData, $startRow, $maxheight, $template_idx)
233{
234 global $template, $templateWidth;
235 $colspan = 0;
236 for ($height = 0; $height < $maxheight; $height++)
237 {
238 for ($locidx = 0; $locidx < 3; $locidx++)
239 {
240 if ($template[$template_idx][$locidx])
241 {
242 // Add colspan/rowspan to the first row met and mark the following ones to skip.
93e02204
DO
243 // Explicitly show even single-cell spanned atoms, because rectHeight()
244 // is expeciting this data for correct calculation.
e673ee24
DO
245 if ($colspan != 0)
246 $rackData[$startRow - $height][$locidx]['skipped'] = TRUE;
247 else
248 {
249 $colspan = $templateWidth[$template_idx];
93e02204 250 if ($colspan >= 1)
e673ee24 251 $rackData[$startRow - $height][$locidx]['colspan'] = $colspan;
93e02204 252 if ($maxheight >= 1)
e673ee24
DO
253 $rackData[$startRow - $height][$locidx]['rowspan'] = $maxheight;
254 }
255 }
256 }
257 }
258 return;
259}
260
93e02204
DO
261// This function sets rowspan/solspan/skipped atom attributes for renderRack()
262// What we actually have to do is to find _all_ possible rectangles for each unit
263// and then select the widest of those with the maximal square.
e673ee24
DO
264function markAllSpans (&$rackData = NULL)
265{
266 if ($rackData == NULL)
267 {
0cc24e9a 268 showWarning ('Invalid rackData', __FUNCTION__);
e673ee24
DO
269 return;
270 }
271 for ($i = $rackData['height']; $i > 0; $i--)
93e02204
DO
272 while (markBestSpan ($rackData, $i));
273}
274
275// Calculate height of 6 possible span templates (array is presorted by width
276// descending) and mark the best (if any).
277function markBestSpan (&$rackData, $i)
278{
279 global $template, $templateWidth;
280 for ($j = 0; $j < 6; $j++)
e673ee24 281 {
93e02204
DO
282 $height[$j] = rectHeight ($rackData, $i, $j);
283 $square[$j] = $height[$j] * $templateWidth[$j];
284 }
285 // find the widest rectangle of those with maximal height
286 $maxsquare = max ($square);
287 if (!$maxsquare)
288 return FALSE;
289 $best_template_index = 0;
290 for ($j = 0; $j < 6; $j++)
291 if ($square[$j] == $maxsquare)
e673ee24 292 {
93e02204
DO
293 $best_template_index = $j;
294 $bestheight = $height[$j];
295 break;
e673ee24 296 }
93e02204
DO
297 // distribute span marks
298 markSpan ($rackData, $i, $bestheight, $best_template_index);
299 return TRUE;
e673ee24
DO
300}
301
e673ee24
DO
302// We can mount 'F' atoms and unmount our own 'T' atoms.
303function applyObjectMountMask (&$rackData, $object_id)
304{
305 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
306 for ($locidx = 0; $locidx < 3; $locidx++)
307 switch ($rackData[$unit_no][$locidx]['state'])
308 {
309 case 'F':
310 $rackData[$unit_no][$locidx]['enabled'] = TRUE;
311 break;
312 case 'T':
313 $rackData[$unit_no][$locidx]['enabled'] = ($rackData[$unit_no][$locidx]['object_id'] == $object_id);
314 break;
315 default:
316 $rackData[$unit_no][$locidx]['enabled'] = FALSE;
317 }
318}
319
320// Design change means transition between 'F' and 'A' and back.
321function applyRackDesignMask (&$rackData)
322{
323 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
324 for ($locidx = 0; $locidx < 3; $locidx++)
325 switch ($rackData[$unit_no][$locidx]['state'])
326 {
327 case 'F':
328 case 'A':
329 $rackData[$unit_no][$locidx]['enabled'] = TRUE;
330 break;
331 default:
332 $rackData[$unit_no][$locidx]['enabled'] = FALSE;
333 }
334}
335
336// The same for 'F' and 'U'.
337function applyRackProblemMask (&$rackData)
338{
339 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
340 for ($locidx = 0; $locidx < 3; $locidx++)
341 switch ($rackData[$unit_no][$locidx]['state'])
342 {
343 case 'F':
344 case 'U':
345 $rackData[$unit_no][$locidx]['enabled'] = TRUE;
346 break;
347 default:
348 $rackData[$unit_no][$locidx]['enabled'] = FALSE;
349 }
350}
351
e673ee24
DO
352// This function highlights specified object (and removes previous highlight).
353function highlightObject (&$rackData, $object_id)
354{
355 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
356 for ($locidx = 0; $locidx < 3; $locidx++)
357 if
358 (
359 $rackData[$unit_no][$locidx]['state'] == 'T' and
360 $rackData[$unit_no][$locidx]['object_id'] == $object_id
361 )
362 $rackData[$unit_no][$locidx]['hl'] = 'h';
363 else
364 unset ($rackData[$unit_no][$locidx]['hl']);
365}
366
367// This function marks atoms to selected or not depending on their current state.
368function markupAtomGrid (&$data, $checked_state)
369{
370 for ($unit_no = $data['height']; $unit_no > 0; $unit_no--)
371 for ($locidx = 0; $locidx < 3; $locidx++)
372 {
373 if (!($data[$unit_no][$locidx]['enabled'] === TRUE))
374 continue;
375 if ($data[$unit_no][$locidx]['state'] == $checked_state)
376 $data[$unit_no][$locidx]['checked'] = ' checked';
377 else
378 $data[$unit_no][$locidx]['checked'] = '';
379 }
380}
381
382// This function is almost a clone of processGridForm(), but doesn't save anything to database
383// Return value is the changed rack data.
384// Here we assume that correct filter has already been applied, so we just
385// set or unset checkbox inputs w/o changing atom state.
386function mergeGridFormToRack (&$rackData)
387{
388 $rack_id = $rackData['id'];
389 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
390 for ($locidx = 0; $locidx < 3; $locidx++)
391 {
392 if ($rackData[$unit_no][$locidx]['enabled'] != TRUE)
393 continue;
394 $inputname = "atom_${rack_id}_${unit_no}_${locidx}";
395 if (isset ($_REQUEST[$inputname]) and $_REQUEST[$inputname] == 'on')
396 $rackData[$unit_no][$locidx]['checked'] = ' checked';
397 else
398 $rackData[$unit_no][$locidx]['checked'] = '';
399 }
400}
401
bb0a44e9 402// netmask conversion from length to number
e673ee24
DO
403function binMaskFromDec ($maskL)
404{
bb0a44e9
DO
405 $map_straight = array (
406 0 => 0x00000000,
407 1 => 0x80000000,
408 2 => 0xc0000000,
409 3 => 0xe0000000,
410 4 => 0xf0000000,
411 5 => 0xf8000000,
412 6 => 0xfc000000,
413 7 => 0xfe000000,
414 8 => 0xff000000,
415 9 => 0xff800000,
416 10 => 0xffc00000,
417 11 => 0xffe00000,
418 12 => 0xfff00000,
419 13 => 0xfff80000,
420 14 => 0xfffc0000,
421 15 => 0xfffe0000,
422 16 => 0xffff0000,
423 17 => 0xffff8000,
424 18 => 0xffffc000,
425 19 => 0xffffe000,
426 20 => 0xfffff000,
427 21 => 0xfffff800,
428 22 => 0xfffffc00,
429 23 => 0xfffffe00,
430 24 => 0xffffff00,
431 25 => 0xffffff80,
432 26 => 0xffffffc0,
433 27 => 0xffffffe0,
434 28 => 0xfffffff0,
435 29 => 0xfffffff8,
436 30 => 0xfffffffc,
437 31 => 0xfffffffe,
438 32 => 0xffffffff,
439 );
440 return $map_straight[$maskL];
e673ee24
DO
441}
442
bb0a44e9 443// complementary value
e673ee24
DO
444function binInvMaskFromDec ($maskL)
445{
bb0a44e9
DO
446 $map_compl = array (
447 0 => 0xffffffff,
448 1 => 0x7fffffff,
449 2 => 0x3fffffff,
450 3 => 0x1fffffff,
451 4 => 0x0fffffff,
452 5 => 0x07ffffff,
453 6 => 0x03ffffff,
454 7 => 0x01ffffff,
455 8 => 0x00ffffff,
456 9 => 0x007fffff,
457 10 => 0x003fffff,
458 11 => 0x001fffff,
459 12 => 0x000fffff,
460 13 => 0x0007ffff,
461 14 => 0x0003ffff,
462 15 => 0x0001ffff,
463 16 => 0x0000ffff,
464 17 => 0x00007fff,
465 18 => 0x00003fff,
466 19 => 0x00001fff,
467 20 => 0x00000fff,
468 21 => 0x000007ff,
469 22 => 0x000003ff,
470 23 => 0x000001ff,
471 24 => 0x000000ff,
472 25 => 0x0000007f,
473 26 => 0x0000003f,
474 27 => 0x0000001f,
475 28 => 0x0000000f,
476 29 => 0x00000007,
477 30 => 0x00000003,
478 31 => 0x00000001,
479 32 => 0x00000000,
480 );
481 return $map_compl[$maskL];
e673ee24
DO
482}
483
e673ee24
DO
484// This function looks up 'has_problems' flag for 'T' atoms
485// and modifies 'hl' key. May be, this should be better done
61a1d996 486// in amplifyCell(). We don't honour 'skipped' key, because
e673ee24
DO
487// the function is also used for thumb creation.
488function markupObjectProblems (&$rackData)
489{
490 for ($i = $rackData['height']; $i > 0; $i--)
491 for ($locidx = 0; $locidx < 3; $locidx++)
492 if ($rackData[$i][$locidx]['state'] == 'T')
493 {
6297d584 494 $object = spotEntity ('object', $rackData[$i][$locidx]['object_id']);
e673ee24
DO
495 if ($object['has_problems'] == 'yes')
496 {
497 // Object can be already highlighted.
498 if (isset ($rackData[$i][$locidx]['hl']))
499 $rackData[$i][$locidx]['hl'] = $rackData[$i][$locidx]['hl'] . 'w';
500 else
501 $rackData[$i][$locidx]['hl'] = 'w';
502 }
503 }
504}
505
d516d719
DO
506// Return a uniformly (010203040506 or 0102030405060708) formatted address, if it is present
507// in the provided string, an empty string for an empty string or NULL for error.
e673ee24
DO
508function l2addressForDatabase ($string)
509{
e673ee24 510 $string = strtoupper ($string);
05771508
DO
511 switch (TRUE)
512 {
d516d719 513 case ($string == '' or preg_match (RE_L2_SOLID, $string) or preg_match (RE_L2_WWN_SOLID, $string)):
05771508 514 return $string;
d516d719
DO
515 case (preg_match (RE_L2_IFCFG, $string) or preg_match (RE_L2_WWN_COLON, $string)):
516 // reformat output of SunOS ifconfig
517 $ret = '';
518 foreach (explode (':', $string) as $byte)
519 $ret .= (strlen ($byte) == 1 ? '0' : '') . $byte;
520 return $ret;
05771508 521 case (preg_match (RE_L2_CISCO, $string)):
d516d719
DO
522 return str_replace ('.', '', $string);
523 case (preg_match (RE_L2_IPCFG, $string) or preg_match (RE_L2_WWN_HYPHEN, $string)):
524 return str_replace ('-', '', $string);
05771508
DO
525 default:
526 return NULL;
527 }
e673ee24
DO
528}
529
530function l2addressFromDatabase ($string)
531{
532 switch (strlen ($string))
533 {
534 case 12: // Ethernet
d516d719 535 case 16: // FireWire/Fibre Channel
e673ee24
DO
536 $ret = implode (':', str_split ($string, 2));
537 break;
538 default:
539 $ret = $string;
540 break;
541 }
542 return $ret;
543}
544
545// The following 2 functions return previous and next rack IDs for
546// a given rack ID. The order of racks is the same as in renderRackspace()
547// or renderRow().
548function getPrevIDforRack ($row_id = 0, $rack_id = 0)
549{
550 if ($row_id <= 0 or $rack_id <= 0)
551 {
0cc24e9a 552 showWarning ('Invalid arguments passed', __FUNCTION__);
e673ee24
DO
553 return NULL;
554 }
a8efc03e 555 $rackList = listCells ('rack', $row_id);
e673ee24
DO
556 doubleLink ($rackList);
557 if (isset ($rackList[$rack_id]['prev_key']))
558 return $rackList[$rack_id]['prev_key'];
559 return NULL;
560}
561
562function getNextIDforRack ($row_id = 0, $rack_id = 0)
563{
564 if ($row_id <= 0 or $rack_id <= 0)
565 {
0cc24e9a 566 showWarning ('Invalid arguments passed', __FUNCTION__);
e673ee24
DO
567 return NULL;
568 }
a8efc03e 569 $rackList = listCells ('rack', $row_id);
e673ee24
DO
570 doubleLink ($rackList);
571 if (isset ($rackList[$rack_id]['next_key']))
572 return $rackList[$rack_id]['next_key'];
573 return NULL;
574}
575
576// This function finds previous and next array keys for each array key and
577// modifies its argument accordingly.
578function doubleLink (&$array)
579{
580 $prev_key = NULL;
581 foreach (array_keys ($array) as $key)
582 {
583 if ($prev_key)
584 {
585 $array[$key]['prev_key'] = $prev_key;
586 $array[$prev_key]['next_key'] = $key;
587 }
588 $prev_key = $key;
589 }
590}
591
e673ee24
DO
592function sortTokenize ($a, $b)
593{
594 $aold='';
595 while ($a != $aold)
596 {
597 $aold=$a;
84986395
DO
598 $a = preg_replace('/[^a-zA-Z0-9]/',' ',$a);
599 $a = preg_replace('/([0-9])([a-zA-Z])/','\\1 \\2',$a);
600 $a = preg_replace('/([a-zA-Z])([0-9])/','\\1 \\2',$a);
e673ee24
DO
601 }
602
603 $bold='';
604 while ($b != $bold)
605 {
606 $bold=$b;
84986395
DO
607 $b = preg_replace('/[^a-zA-Z0-9]/',' ',$b);
608 $b = preg_replace('/([0-9])([a-zA-Z])/','\\1 \\2',$b);
609 $b = preg_replace('/([a-zA-Z])([0-9])/','\\1 \\2',$b);
e673ee24
DO
610 }
611
612
613
614 $ar = explode(' ', $a);
615 $br = explode(' ', $b);
616 for ($i=0; $i<count($ar) && $i<count($br); $i++)
617 {
618 $ret = 0;
619 if (is_numeric($ar[$i]) and is_numeric($br[$i]))
620 $ret = ($ar[$i]==$br[$i])?0:($ar[$i]<$br[$i]?-1:1);
621 else
622 $ret = strcasecmp($ar[$i], $br[$i]);
623 if ($ret != 0)
624 return $ret;
625 }
626 if ($i<count($ar))
627 return 1;
628 if ($i<count($br))
629 return -1;
630 return 0;
631}
632
633function sortByName ($a, $b)
634{
bbeb64fd
DO
635 $result = sortTokenize ($a['name'], $b['name']);
636 if ($result != 0)
637 return $result;
638 if ($a['iif_id'] != $b['iif_id'])
639 return $a['iif_id'] - $b['iif_id'];
640 $result = strcmp ($a['label'], $b['label']);
641 if ($result != 0)
642 return $result;
643 $result = strcmp ($a['l2address'], $b['l2address']);
644 if ($result != 0)
645 return $result;
646 return $a['id'] - $b['id'];
e673ee24
DO
647}
648
e673ee24
DO
649function sortObjectAddressesAndNames ($a, $b)
650{
651 $objname_cmp = sortTokenize($a['object_name'], $b['object_name']);
652 if ($objname_cmp == 0)
653 {
79f22c3d
DO
654 $name_a = (isset ($a['port_name'])) ? $a['port_name'] : '';
655 $name_b = (isset ($b['port_name'])) ? $b['port_name'] : '';
656 $objname_cmp = sortTokenize($name_a, $name_b);
e673ee24 657 if ($objname_cmp == 0)
e673ee24 658 sortTokenize($a['ip'], $b['ip']);
e673ee24
DO
659 return $objname_cmp;
660 }
661 return $objname_cmp;
662}
663
c31cd72c 664// This function returns an array of single element of object's FQDN attribute,
f321b50a
DO
665// if FQDN is set. The next choice is object's common name, if it looks like a
666// hostname. Otherwise an array of all 'regular' IP addresses of the
c31cd72c 667// object is returned (which may appear 0 and more elements long).
f321b50a 668function findAllEndpoints ($object_id, $fallback = '')
c31cd72c 669{
7fa7047a
DO
670 foreach (getAttrValues ($object_id) as $record)
671 if ($record['id'] == 3 && strlen ($record['value'])) // FQDN
c31cd72c 672 return array ($record['value']);
c31cd72c 673 $regular = array();
85970da2
DO
674 foreach (getObjectIPv4Allocations ($object_id) as $dottedquad => $alloc)
675 if ($alloc['type'] == 'regular')
676 $regular[] = $dottedquad;
59a83bd8 677 if (!count ($regular) && strlen ($fallback))
f321b50a 678 return array ($fallback);
c31cd72c
DO
679 return $regular;
680}
681
83ba6670
DO
682// Some records in the dictionary may be written as plain text or as Wiki
683// link in the following syntax:
684// 1. word
685// 2. [[word URL]] // FIXME: this isn't working
686// 3. [[word word word | URL]]
687// This function parses the line and returns text suitable for either A
688// (rendering <A HREF>) or O (for <OPTION>).
7fa7047a 689function parseWikiLink ($line, $which)
83ba6670 690{
010231c2 691 if (preg_match ('/^\[\[.+\]\]$/', $line) == 0)
24cbe8af 692 {
7fa7047a
DO
693 // always strip the marker for A-data, but let cookOptgroup()
694 // do this later (otherwise it can't sort groups out)
695 if ($which == 'a')
84986395 696 return preg_replace ('/^.+%GSKIP%/', '', preg_replace ('/^(.+)%GPASS%/', '\\1 ', $line));
24cbe8af
DO
697 else
698 return $line;
699 }
010231c2
DO
700 $line = preg_replace ('/^\[\[(.+)\]\]$/', '$1', $line);
701 $s = explode ('|', $line);
83ba6670 702 $o_value = trim ($s[0]);
83ba6670
DO
703 if ($which == 'o')
704 return $o_value;
84986395 705 $o_value = preg_replace ('/^.+%GSKIP%/', '', preg_replace ('/^(.+)%GPASS%/', '\\1 ', $o_value));
7fa7047a
DO
706 $a_value = trim ($s[1]);
707 return "<a href='${a_value}'>${o_value}</a>";
83ba6670
DO
708}
709
c9edf725
DO
710// FIXME: should this be saved as "P-data"?
711function execGMarker ($line)
712{
84986395 713 return preg_replace ('/^.+%GSKIP%/', '', preg_replace ('/^(.+)%GPASS%/', '\\1 ', $line));
c9edf725
DO
714}
715
177b1e9b
DO
716// rackspace usage for a single rack
717// (T + W + U) / (height * 3 - A)
11df133a 718function getRSUforRack ($data = NULL)
177b1e9b 719{
11df133a 720 if ($data == NULL)
177b1e9b 721 {
0cc24e9a 722 showWarning ('Invalid argument', __FUNCTION__);
177b1e9b
DO
723 return NULL;
724 }
6ffba290 725 $counter = array ('A' => 0, 'U' => 0, 'T' => 0, 'W' => 0, 'F' => 0);
9e60f7df
DO
726 for ($unit_no = $data['height']; $unit_no > 0; $unit_no--)
727 for ($locidx = 0; $locidx < 3; $locidx++)
728 $counter[$data[$unit_no][$locidx]['state']]++;
dfa3c075 729 return ($counter['T'] + $counter['W'] + $counter['U']) / ($counter['T'] + $counter['W'] + $counter['U'] + $counter['F']);
177b1e9b
DO
730}
731
11df133a
DO
732// Same for row.
733function getRSUforRackRow ($rowData = NULL)
734{
bb26a59e 735 if ($rowData === NULL)
11df133a 736 {
0cc24e9a 737 showWarning ('Invalid argument', __FUNCTION__);
11df133a
DO
738 return NULL;
739 }
bb26a59e
DO
740 if (!count ($rowData))
741 return 0;
11df133a 742 $counter = array ('A' => 0, 'U' => 0, 'T' => 0, 'W' => 0, 'F' => 0);
f81a2012 743 $total_height = 0;
dfa3c075
DO
744 foreach (array_keys ($rowData) as $rack_id)
745 {
61a1d996
DO
746 $data = spotEntity ('rack', $rack_id);
747 amplifyCell ($data);
dfa3c075 748 $total_height += $data['height'];
11df133a
DO
749 for ($unit_no = $data['height']; $unit_no > 0; $unit_no--)
750 for ($locidx = 0; $locidx < 3; $locidx++)
751 $counter[$data[$unit_no][$locidx]['state']]++;
dfa3c075
DO
752 }
753 return ($counter['T'] + $counter['W'] + $counter['U']) / ($counter['T'] + $counter['W'] + $counter['U'] + $counter['F']);
11df133a
DO
754}
755
9af110b4
DO
756// Make sure the string is always wrapped with LF characters
757function lf_wrap ($str)
758{
759 $ret = trim ($str, "\r\n");
59a83bd8 760 if (strlen ($ret))
9af110b4
DO
761 $ret .= "\n";
762 return $ret;
763}
764
e6e7d8b3
DO
765// Adopted from Mantis BTS code.
766function string_insert_hrefs ($s)
767{
768 if (getConfigVar ('DETECT_URLS') != 'yes')
769 return $s;
770 # Find any URL in a string and replace it by a clickable link
771 $s = preg_replace( '/(([[:alpha:]][-+.[:alnum:]]*):\/\/(%[[:digit:]A-Fa-f]{2}|[-_.!~*\';\/?%^\\\\:@&={\|}+$#\(\),\[\][:alnum:]])+)/se',
772 "'<a href=\"'.rtrim('\\1','.').'\">\\1</a> [<a href=\"'.rtrim('\\1','.').'\" target=\"_blank\">^</a>]'",
773 $s);
774 $s = preg_replace( '/\b' . email_regex_simple() . '\b/i',
775 '<a href="mailto:\0">\0</a>',
776 $s);
777 return $s;
778}
779
780// Idem.
781function email_regex_simple ()
782{
783 return "(([a-z0-9!#*+\/=?^_{|}~-]+(?:\.[a-z0-9!#*+\/=?^_{|}~-]+)*)" . # recipient
784 "\@((?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?))"; # @domain
785}
786
118e4c38
DO
787// Parse AUTOPORTS_CONFIG and return a list of generated pairs (port_type, port_name)
788// for the requested object_type_id.
789function getAutoPorts ($type_id)
790{
791 $ret = array();
792 $typemap = explode (';', str_replace (' ', '', getConfigVar ('AUTOPORTS_CONFIG')));
793 foreach ($typemap as $equation)
794 {
795 $tmp = explode ('=', $equation);
796 if (count ($tmp) != 2)
797 continue;
798 $objtype_id = $tmp[0];
799 if ($objtype_id != $type_id)
800 continue;
801 $portlist = $tmp[1];
802 foreach (explode ('+', $portlist) as $product)
803 {
804 $tmp = explode ('*', $product);
805 if (count ($tmp) != 3)
806 continue;
807 $nports = $tmp[0];
808 $port_type = $tmp[1];
809 $format = $tmp[2];
810 for ($i = 0; $i < $nports; $i++)
811 $ret[] = array ('type' => $port_type, 'name' => @sprintf ($format, $i));
812 }
813 }
814 return $ret;
815}
816
86256b96
DO
817// Use pre-served trace to traverse the tree, then place given node where it belongs.
818function pokeNode (&$tree, $trace, $key, $value, $threshold = 0)
819{
820 // This function needs the trace to be followed FIFO-way. The fastest
821 // way to do so is to use array_push() for putting values into the
822 // list and array_shift() for getting them out. This exposed up to 11%
823 // performance gain compared to other patterns of array_push/array_unshift/
824 // array_reverse/array_pop/array_shift conjunction.
825 $myid = array_shift ($trace);
826 if (!count ($trace)) // reached the target
9dfd4cc9 827 {
86256b96
DO
828 if (!$threshold or ($threshold and $tree[$myid]['kidc'] + 1 < $threshold))
829 $tree[$myid]['kids'][$key] = $value;
830 // Reset accumulated records once, when the limit is reached, not each time
831 // after that.
832 if (++$tree[$myid]['kidc'] == $threshold)
833 $tree[$myid]['kids'] = array();
834 }
835 else // not yet
836 {
837 $self = __FUNCTION__;
838 $self ($tree[$myid]['kids'], $trace, $key, $value, $threshold);
9dfd4cc9 839 }
9dfd4cc9
DO
840}
841
0ba76ca2
DO
842// Likewise traverse the tree with the trace and return the final node.
843function peekNode ($tree, $trace, $target_id)
844{
845 $self = __FUNCTION__;
846 if (NULL === ($next = array_shift ($trace))) // warm
847 {
848 foreach ($tree as $node)
f1e27fe5 849 if (array_key_exists ('id', $node) and $node['id'] == $target_id) // hot
0ba76ca2
DO
850 return $node;
851 }
852 else // cold
853 {
854 foreach ($tree as $node)
3e576410 855 if (array_key_exists ('id', $node) and $node['id'] == $next) // warmer
0ba76ca2
DO
856 return $self ($node['kids'], $trace, $target_id);
857 }
858 // HCF
859 return NULL;
860}
861
d65353ad
DO
862// Build a tree from the item list and return it. Input and output data is
863// indexed by item id (nested items in output are recursively stored in 'kids'
51b6651a
DO
864// key, which is in turn indexed by id. Functions, which are ready to handle
865// tree collapsion/expansion themselves, may request non-zero threshold value
866// for smaller resulting tree.
3fb336f6 867function treeFromList (&$orig_nodelist, $threshold = 0, $return_main_payload = TRUE)
d65353ad 868{
86256b96 869 $tree = array();
3fb336f6 870 $nodelist = $orig_nodelist;
86256b96
DO
871 // Array equivalent of traceEntity() function.
872 $trace = array();
873 // set kidc and kids only once
874 foreach (array_keys ($nodelist) as $nodeid)
875 {
876 $nodelist[$nodeid]['kidc'] = 0;
877 $nodelist[$nodeid]['kids'] = array();
878 }
879 do
9dfd4cc9 880 {
86256b96
DO
881 $nextpass = FALSE;
882 foreach (array_keys ($nodelist) as $nodeid)
9dfd4cc9 883 {
86256b96
DO
884 // When adding a node to the working tree, book another
885 // iteration, because the new item could make a way for
886 // others onto the tree. Also remove any item added from
887 // the input list, so iteration base shrinks.
888 // First check if we can assign directly.
889 if ($nodelist[$nodeid]['parent_id'] == NULL)
9dfd4cc9 890 {
86256b96
DO
891 $tree[$nodeid] = $nodelist[$nodeid];
892 $trace[$nodeid] = array(); // Trace to root node is empty
893 unset ($nodelist[$nodeid]);
894 $nextpass = TRUE;
9dfd4cc9 895 }
86256b96
DO
896 // Now look if it fits somewhere on already built tree.
897 elseif (isset ($trace[$nodelist[$nodeid]['parent_id']]))
9dfd4cc9 898 {
86256b96
DO
899 // Trace to a node is a trace to its parent plus parent id.
900 $trace[$nodeid] = $trace[$nodelist[$nodeid]['parent_id']];
901 $trace[$nodeid][] = $nodelist[$nodeid]['parent_id'];
902 pokeNode ($tree, $trace[$nodeid], $nodeid, $nodelist[$nodeid], $threshold);
903 // path to any other node is made of all parent nodes plus the added node itself
904 unset ($nodelist[$nodeid]);
905 $nextpass = TRUE;
9dfd4cc9
DO
906 }
907 }
9dfd4cc9 908 }
86256b96 909 while ($nextpass);
3fb336f6 910 if (!$return_main_payload)
86256b96 911 return $nodelist;
3fb336f6
DO
912 // update each input node with its backtrace route
913 foreach ($trace as $nodeid => $route)
914 $orig_nodelist[$nodeid]['trace'] = $route;
915 return $tree;
9dfd4cc9
DO
916}
917
49fb1027 918// Build a tree from the tag list and return everything _except_ the tree.
573214e0
DO
919// IOW, return taginfo items, which have parent_id set and pointing outside
920// of the "normal" tree, which originates from the root.
49fb1027
DO
921function getOrphanedTags ()
922{
923 global $taglist;
86256b96 924 return treeFromList ($taglist, 0, FALSE);
49fb1027
DO
925}
926
6e49bd1f 927function serializeTags ($chain, $baseurl = '')
ba93bd98
DO
928{
929 $comma = '';
930 $ret = '';
6e49bd1f 931 foreach ($chain as $taginfo)
ba93bd98 932 {
e2ac59cf 933 $ret .= $comma .
a8efc03e 934 ($baseurl == '' ? '' : "<a href='${baseurl}cft[]=${taginfo['id']}'>") .
e2ac59cf
DO
935 $taginfo['tag'] .
936 ($baseurl == '' ? '' : '</a>');
ba93bd98
DO
937 $comma = ', ';
938 }
939 return $ret;
940}
941
ba93bd98
DO
942// Return the list of missing implicit tags.
943function getImplicitTags ($oldtags)
944{
3fb336f6
DO
945 global $taglist;
946 $tmp = array();
947 foreach ($oldtags as $taginfo)
948 $tmp = array_merge ($tmp, $taglist[$taginfo['id']]['trace']);
949 // don't call array_unique here, it is in the function we will call now
950 return buildTagChainFromIds ($tmp);
ba93bd98
DO
951}
952
6e49bd1f 953// Minimize the chain: exclude all implicit tags and return the result.
5fd2a004
DO
954// This function makes use of an external cache with a miss/hit ratio
955// about 3/7 (ticket:255).
3fb336f6 956function getExplicitTagsOnly ($chain)
ab379543 957{
5fd2a004 958 global $taglist, $tagRelCache;
ab379543 959 $ret = array();
5fd2a004
DO
960 foreach (array_keys ($chain) as $keyA) // check each A
961 {
962 $tagidA = $chain[$keyA]['id'];
963 // do not include A in result, if A is seen on the trace of any B!=A
964 foreach (array_keys ($chain) as $keyB)
965 {
966 $tagidB = $chain[$keyB]['id'];
967 if ($tagidA == $tagidB)
968 continue;
969 if (!isset ($tagRelCache[$tagidA][$tagidB]))
0745db4d 970 $tagRelCache[$tagidA][$tagidB] = in_array ($tagidA, $taglist[$tagidB]['trace']);
5fd2a004
DO
971 if ($tagRelCache[$tagidA][$tagidB] === TRUE) // A is ancestor of B
972 continue 2; // skip this A
973 }
974 $ret[] = $chain[$keyA];
975 }
74ccacff
DO
976 return $ret;
977}
978
2c21a10c 979// Universal autotags generator, a complementing function for loadEntityTags().
2c21a10c 980// Bypass key isn't strictly typed, but interpreted depending on the realm.
d16af52f 981function generateEntityAutoTags ($cell)
cce6b057 982{
cce6b057 983 $ret = array();
d16af52f 984 switch ($cell['realm'])
2c21a10c
DO
985 {
986 case 'rack':
d16af52f 987 $ret[] = array ('tag' => '$rackid_' . $cell['id']);
2c21a10c
DO
988 $ret[] = array ('tag' => '$any_rack');
989 break;
4c9d35ec 990 case 'object':
d16af52f
DO
991 $ret[] = array ('tag' => '$id_' . $cell['id']);
992 $ret[] = array ('tag' => '$typeid_' . $cell['objtype_id']);
2c21a10c 993 $ret[] = array ('tag' => '$any_object');
588b2b79 994 if (validTagName ('$cn_' . $cell['name'], TRUE))
d16af52f
DO
995 $ret[] = array ('tag' => '$cn_' . $cell['name']);
996 if (!strlen ($cell['rack_id']))
914b439b 997 $ret[] = array ('tag' => '$unmounted');
6d472f26
DO
998 if (!$cell['nports'])
999 $ret[] = array ('tag' => '$portless');
5d6de575
DO
1000 if ($cell['asset_no'] == '')
1001 $ret[] = array ('tag' => '$no_asset_tag');
b48d8d61
DO
1002 if ($cell['runs8021Q'])
1003 $ret[] = array ('tag' => '$runs_8021Q');
2c21a10c 1004 break;
4c9d35ec 1005 case 'ipv4net':
d16af52f
DO
1006 $ret[] = array ('tag' => '$ip4netid_' . $cell['id']);
1007 $ret[] = array ('tag' => '$ip4net-' . str_replace ('.', '-', $cell['ip']) . '-' . $cell['mask']);
b9b915d5
DO
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 }
2c21a10c
DO
1018 $ret[] = array ('tag' => '$any_ip4net');
1019 $ret[] = array ('tag' => '$any_net');
1020 break;
1021 case 'ipv4vs':
d16af52f 1022 $ret[] = array ('tag' => '$ipv4vsid_' . $cell['id']);
2c21a10c
DO
1023 $ret[] = array ('tag' => '$any_ipv4vs');
1024 $ret[] = array ('tag' => '$any_vs');
1025 break;
1026 case 'ipv4rspool':
d16af52f 1027 $ret[] = array ('tag' => '$ipv4rspid_' . $cell['id']);
2c21a10c
DO
1028 $ret[] = array ('tag' => '$any_ipv4rsp');
1029 $ret[] = array ('tag' => '$any_rsp');
1030 break;
1031 case 'user':
b82cce3f
DO
1032 // {$username_XXX} autotag is generated always, but {$userid_XXX}
1033 // appears only for accounts, which exist in local database.
d16af52f
DO
1034 $ret[] = array ('tag' => '$username_' . $cell['user_name']);
1035 if (isset ($cell['user_id']))
1036 $ret[] = array ('tag' => '$userid_' . $cell['user_id']);
2c21a10c
DO
1037 break;
1038 case 'file':
d16af52f 1039 $ret[] = array ('tag' => '$fileid_' . $cell['id']);
2c21a10c
DO
1040 $ret[] = array ('tag' => '$any_file');
1041 break;
d16af52f 1042 default: // HCF!
2c21a10c
DO
1043 break;
1044 }
4c9d35ec
DO
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 }
f9bc186f
DO
1060 return $ret;
1061}
1062
abef7149
DO
1063// Check, if the given tag is present on the chain (will only work
1064// for regular tags with tag ID set.
1065function 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
f8821b96
DO
1075function tagNameOnChain ($tagname, $tagchain)
1076{
1077 foreach ($tagchain as $test)
1078 if ($test['tag'] == $tagname)
1079 return TRUE;
1080 return FALSE;
1081}
1082
abef7149
DO
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.
1086function 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
0df8c52b 1096function redirectIfNecessary ()
da958e52 1097{
750d26d2
DO
1098 global
1099 $trigger,
1100 $pageno,
1101 $tabno;
53bae67b
DO
1102 $pmap = array
1103 (
1104 'accounts' => 'userlist',
1105 'rspools' => 'ipv4rsplist',
1106 'rspool' => 'ipv4rsp',
1107 'vservices' => 'ipv4vslist',
1108 'vservice' => 'ipv4vs',
c78a40ec
DO
1109 'objects' => 'depot',
1110 'objgroup' => 'depot',
53bae67b
DO
1111 );
1112 $tmap = array();
1113 $tmap['objects']['newmulti'] = 'addmore';
1114 $tmap['objects']['newobj'] = 'addmore';
1115 $tmap['object']['switchvlans'] = 'livevlans';
1116 $tmap['object']['slb'] = 'editrspvs';
72d8ced3
DO
1117 $tmap['object']['portfwrd'] = 'nat4';
1118 $tmap['object']['network'] = 'ipv4';
53bae67b
DO
1119 if (isset ($pmap[$pageno]))
1120 redirectUser ($pmap[$pageno], $tabno);
1121 if (isset ($tmap[$pageno][$tabno]))
1122 redirectUser ($pageno, $tmap[$pageno][$tabno]);
750d26d2 1123 // check if we accidentaly got on a dynamic tab that shouldn't be shown for this object
3a7bdcc6
DO
1124 if
1125 (
1126 isset ($trigger[$pageno][$tabno]) and
1127 !strlen (call_user_func ($trigger[$pageno][$tabno]))
1128 )
750d26d2 1129 redirectUser ($pageno, 'default');
0df8c52b
DO
1130}
1131
329ec966
DY
1132function 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'];
329ec966 1145 } elseif (basename($_SERVER['PHP_SELF']) == 'index.php' and getConfigVar ('SHOW_LAST_TAB') == 'yes' and isset ($_SESSION['RTLT'][$pageno])) {
750d26d2 1146 redirectUser ($pageno, $_SESSION['RTLT'][$pageno]);
329ec966
DY
1147 } else {
1148 $tabno = 'default';
1149 }
1150}
1151
0df8c52b
DO
1152function 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;
53bae67b 1163
0df8c52b
DO
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))
53da7dca
DO
1174 {
1175 // Each page listed in the map above requires one uint argument.
0a50efb4 1176 $target_realm = $etype_by_pageno[$pageno];
0cc24e9a 1177 assertUIntArg ($page[$pageno]['bypass']);
0a50efb4 1178 $target_id = $_REQUEST[$page[$pageno]['bypass']];
b135a49d 1179 $target = spotEntity ($target_realm, $target_id);
53da7dca 1180 $target_given_tags = $target['etags'];
0df8c52b 1181 if ($target['realm'] != 'user')
53da7dca
DO
1182 $auto_tags = array_merge ($auto_tags, $target['atags']);
1183 }
4c9b513a
DO
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);
da958e52
DO
1188}
1189
abef7149
DO
1190// Take a list of user-supplied tag IDs to build a list of valid taginfo
1191// records indexed by tag IDs (tag chain).
6e49bd1f 1192function buildTagChainFromIds ($tagidlist)
ab379543 1193{
20c901a7 1194 global $taglist;
ab379543 1195 $ret = array();
abef7149 1196 foreach (array_unique ($tagidlist) as $tag_id)
ab379543
DO
1197 if (isset ($taglist[$tag_id]))
1198 $ret[] = $taglist[$tag_id];
1199 return $ret;
1200}
1201
7cc02fc1
DO
1202// Process a given tag tree and return only meaningful branches. The resulting
1203// (sub)tree will have refcnt leaves on every last branch.
a26a6ccc 1204function getObjectiveTagTree ($tree, $realm, $preselect)
7cc02fc1 1205{
51b6651a 1206 $self = __FUNCTION__;
7cc02fc1
DO
1207 $ret = array();
1208 foreach ($tree as $taginfo)
1209 {
a26a6ccc
DO
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
7cc02fc1 1214 (
a26a6ccc
DO
1215 isset ($taginfo['refcnt'][$realm]) or
1216 count ($subsearch) > 1 or
3fb336f6 1217 in_array ($taginfo['id'], $preselect)
a26a6ccc
DO
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);
7cc02fc1
DO
1229 }
1230 return $ret;
1231}
1232
7ddb2c05
DO
1233// Get taginfo record by tag name, return NULL, if record doesn't exist.
1234function 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
fc73c734
DO
1243// Merge two chains, filtering dupes out. Return the resulting superset.
1244function 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
31c941ec
DO
1257function getCellFilter ()
1258{
7da7450c 1259 global $sic;
eca0114c 1260 global $pageno;
01b9a31a 1261 $staticFilter = getConfigVar ('STATIC_FILTER');
3d670bba 1262 if (isset ($_REQUEST['tagfilter']) and is_array ($_REQUEST['tagfilter']))
23cdc7e9
DO
1263 {
1264 $_REQUEST['cft'] = $_REQUEST['tagfilter'];
1265 unset ($_REQUEST['tagfilter']);
1266 }
01b9a31a 1267 if (isset ($_SESSION[$pageno]['tagfilter']) and is_array ($_SESSION[$pageno]['tagfilter']) and !(isset($_REQUEST['cft'])) and $staticFilter == 'yes')
b8970c7e 1268 {
eca0114c 1269 $_REQUEST['cft'] = $_SESSION[$pageno]['tagfilter'];
b8970c7e 1270 }
01b9a31a 1271 if (isset ($_SESSION[$pageno]['cfe']) and !(isset($sic['cfe'])) and $staticFilter == 'yes')
b8970c7e 1272 {
eca0114c 1273 $sic['cfe'] = $_SESSION[$pageno]['cfe'];
b8970c7e 1274 }
01b9a31a 1275 if (isset ($_SESSION[$pageno]['andor']) and !(isset($_REQUEST['andor'])) and $staticFilter == 'yes')
b8970c7e 1276 {
eca0114c 1277 $_REQUEST['andor'] = $_SESSION[$pageno]['andor'];
b8970c7e
RF
1278 }
1279
eca0114c 1280
3d670bba
DO
1281 $ret = array
1282 (
23cdc7e9
DO
1283 'tagidlist' => array(),
1284 'tnamelist' => array(),
1285 'pnamelist' => array(),
1286 'andor' => '',
3d670bba 1287 'text' => '',
23cdc7e9
DO
1288 'extratext' => '',
1289 'expression' => array(),
a8efc03e 1290 'urlextra' => '', // Just put text here and let makeHref call urlencode().
3d670bba 1291 );
23cdc7e9 1292 switch (TRUE)
31c941ec 1293 {
23cdc7e9
DO
1294 case (!isset ($_REQUEST['andor'])):
1295 $andor2 = getConfigVar ('FILTER_DEFAULT_ANDOR');
3d670bba 1296 break;
23cdc7e9
DO
1297 case ($_REQUEST['andor'] == 'and'):
1298 case ($_REQUEST['andor'] == 'or'):
eca0114c 1299 $_SESSION[$pageno]['andor'] = $_REQUEST['andor'];
23cdc7e9 1300 $ret['andor'] = $andor2 = $_REQUEST['andor'];
a8efc03e 1301 $ret['urlextra'] .= '&andor=' . $ret['andor'];
3d670bba
DO
1302 break;
1303 default:
0cc24e9a 1304 showWarning ('Invalid and/or switch value in submitted form', __FUNCTION__);
3d670bba 1305 return NULL;
31c941ec 1306 }
23cdc7e9
DO
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']))
31c941ec 1311 {
eca0114c 1312 $_SESSION[$pageno]['tagfilter'] = $_REQUEST['cft'];
23cdc7e9
DO
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 . ' ';
a8efc03e 1321 $ret['urlextra'] .= '&cft[]=' . $req_id;
23cdc7e9
DO
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 . ' ';
a8efc03e 1333 $ret['urlextra'] .= '&cfp[]=' . $req_name;
23cdc7e9
DO
1334 }
1335 }
7da7450c
DO
1336 // Extra text comes from TEXTAREA and is easily screwed by standard escaping function.
1337 if (isset ($sic['cfe']))
a8efc03e 1338 {
eca0114c 1339 $_SESSION[$pageno]['cfe'] = $sic['cfe'];
7da7450c
DO
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 }
a8efc03e 1347 }
23cdc7e9
DO
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;
8c699525
DO
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';
31c941ec 1363 }
3d670bba 1364 return $ret;
31c941ec
DO
1365}
1366
db55cf54
DO
1367// Return an empty message log.
1368function emptyLog ()
1369{
1370 return array
1371 (
1372 'v' => 2,
1373 'm' => array()
1374 );
1375}
1376
2987fc1f
DO
1377// Return a message log consisting of only one message.
1378function oneLiner ($code, $args = array())
1379{
db55cf54 1380 $ret = emptyLog();
2987fc1f
DO
1381 $ret['m'][] = count ($args) ? array ('c' => $code, 'a' => $args) : array ('c' => $code);
1382 return $ret;
46f92ff7
DO
1383}
1384
e53b1246
DO
1385// Merge message payload from two message logs given and return the result.
1386function mergeLogs ($log1, $log2)
1387{
1388 $ret = emptyLog();
1389 $ret['m'] = array_merge ($log1['m'], $log2['m']);
1390 return $ret;
1391}
1392
9f54e6e9 1393function validTagName ($s, $allow_autotag = FALSE)
2eeeca80 1394{
84986395 1395 if (1 == preg_match (TAGNAME_REGEXP, $s))
9f54e6e9 1396 return TRUE;
84986395 1397 if ($allow_autotag and 1 == preg_match (AUTOTAGNAME_REGEXP, $s))
9f54e6e9
DO
1398 return TRUE;
1399 return FALSE;
2eeeca80
DO
1400}
1401
53bae67b
DO
1402function redirectUser ($p, $t)
1403{
790a60e8
DO
1404 global $page;
1405 $l = "index.php?page=${p}&tab=${t}";
53bae67b
DO
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
9f3e5caa
DO
1412function getRackCodeStats ()
1413{
1414 global $rackCode;
914b439b 1415 $defc = $grantc = $modc = 0;
9f3e5caa
DO
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;
914b439b
DO
1425 case 'SYNT_CTXMOD':
1426 $modc++;
1427 break;
9f3e5caa
DO
1428 default:
1429 break;
1430 }
914b439b
DO
1431 $ret = array
1432 (
1433 'Definition sentences' => $defc,
1434 'Grant sentences' => $grantc,
1435 'Context mod sentences' => $modc
1436 );
9f3e5caa
DO
1437 return $ret;
1438}
1439
d5157018
DO
1440function getRackImageWidth ()
1441{
529eac25
DO
1442 global $rtwidth;
1443 return 3 + $rtwidth[0] + $rtwidth[1] + $rtwidth[2] + 3;
d5157018
DO
1444}
1445
1446function getRackImageHeight ($units)
1447{
1448 return 3 + 3 + $units * 2;
1449}
1450
2987fc1f
DO
1451// Perform substitutions and return resulting string
1452// used solely by buildLVSConfig()
1453function 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
1461function buildLVSConfig ($object_id = 0)
1462{
1463 if ($object_id <= 0)
1464 {
0cc24e9a 1465 showWarning ('Invalid argument', __FUNCTION__);
2987fc1f
DO
1466 return;
1467 }
6297d584 1468 $oInfo = spotEntity ('object', $object_id);
2987fc1f
DO
1469 $lbconfig = getSLBConfig ($object_id);
1470 if ($lbconfig === NULL)
1471 {
0cc24e9a 1472 showWarning ('getSLBConfig() failed', __FUNCTION__);
2987fc1f
DO
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" .
59a83bd8
DO
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" .
2987fc1f
DO
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 {
59a83bd8 1503 if (!strlen ($rs['rsport']))
79a9edb4 1504 $rs['rsport'] = $vsinfo['vport'];
2987fc1f
DO
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 }
3dd72e34
DO
1520 // FIXME: deal somehow with Mac-styled text, the below replacement will screw it up
1521 return str_replace ("\r", '', $newconfig);
2987fc1f
DO
1522}
1523
2d318652
DO
1524// Indicate occupation state of each IP address: none, ordinary or problematic.
1525function markupIPv4AddrList (&$addrlist)
1526{
1527 foreach (array_keys ($addrlist) as $ip_bin)
1528 {
d983f70a
DO
1529 $refc = array
1530 (
00c5d8cb
DO
1531 'shared' => 0, // virtual
1532 'virtual' => 0, // loopback
1533 'regular' => 0, // connected host
1534 'router' => 0 // connected gateway
d983f70a
DO
1535 );
1536 foreach ($addrlist[$ip_bin]['allocs'] as $a)
1537 $refc[$a['type']]++;
00c5d8cb 1538 $nvirtloopback = ($refc['shared'] + $refc['virtual'] > 0) ? 1 : 0; // modulus of virtual + shared
d983f70a
DO
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
2d318652
DO
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
04d619d0
DO
1551// Scan the given address list (returned by scanIPv4Space) and return a list of all routers found.
1552function 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
fb7a4967
DO
1568// Assist in tag chain sorting.
1569function taginfoCmp ($tagA, $tagB)
1570{
1571 return $tagA['ci'] - $tagB['ci'];
1572}
1573
1327d9dd
DO
1574// Compare networks. When sorting a tree, the records on the list will have
1575// distinct base IP addresses.
3444ecf2
DO
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
1327d9dd
DO
1579function IPv4NetworkCmp ($netA, $netB)
1580{
2d75c30b
DO
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)
3444ecf2
DO
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'])
2d75c30b 1588 return 0;
3444ecf2
DO
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 }
1327d9dd
DO
1609}
1610
fb7a4967 1611// Modify the given tag tree so, that each level's items are sorted alphabetically.
1327d9dd 1612function sortTree (&$tree, $sortfunc = '')
fb7a4967 1613{
59a83bd8 1614 if (!strlen ($sortfunc))
1327d9dd 1615 return;
51b6651a 1616 $self = __FUNCTION__;
1327d9dd 1617 usort ($tree, $sortfunc);
fb7a4967
DO
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)
51b6651a 1621 $self ($tree[$tagid]['kids'], $sortfunc);
fb7a4967
DO
1622}
1623
0137d53c
DO
1624function iptree_fill (&$netdata)
1625{
59a83bd8 1626 if (!isset ($netdata['kids']) or !count ($netdata['kids']))
0137d53c 1627 return;
a987ff52 1628 // If we really have nested prefixes, they must fit into the tree.
0137d53c
DO
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
1640function 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();
fec0c8da 1650 $node['kidc'] = 0;
0137d53c
DO
1651 $node['name'] = '';
1652 }
1653 return array ($node);
1654 }
1655 else
1656 return array_merge ($self ($node['left']), $self ($node['right']));
1657}
1658
1659function 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'])
164ba494 1670 throw new Exception ('the recurring loop lost control', E_INTERNAL);
0137d53c
DO
1671
1672 // split?
1673 if (!isset ($node['right']))
1674 {
a987ff52
DO
1675 // Fill in db_first/db_last to make it possible to run scanIPv4Space() on the node.
1676 $node['left']['mask'] = $node['mask'] + 1;
0137d53c 1677 $node['left']['ip_bin'] = $node['ip_bin'];
a987ff52
DO
1678 $node['left']['db_first'] = sprintf ('%u', $node['left']['ip_bin']);
1679 $node['left']['db_last'] = sprintf ('%u', $node['left']['ip_bin'] | binInvMaskFromDec ($node['left']['mask']));
1680
1681 $node['right']['mask'] = $node['mask'] + 1;
0137d53c 1682 $node['right']['ip_bin'] = $node['ip_bin'] + binInvMaskFromDec ($node['mask'] + 1) + 1;
a987ff52
DO
1683 $node['right']['db_first'] = sprintf ('%u', $node['right']['ip_bin']);
1684 $node['right']['db_last'] = sprintf ('%u', $node['right']['ip_bin'] | binInvMaskFromDec ($node['right']['mask']));
0137d53c
DO
1685 }
1686
1687 // repeat!
1688 if (($node['left']['ip_bin'] & binMaskFromDec ($node['left']['mask'])) == ($pfx['ip_bin'] & binMaskFromDec ($node['left']['mask'])))
1689 $self ($node['left'], $pfx);
1690 elseif (($node['right']['ip_bin'] & binMaskFromDec ($node['right']['mask'])) == ($pfx['ip_bin'] & binMaskFromDec ($node['left']['mask'])))
1691 $self ($node['right'], $pfx);
1692 else
164ba494 1693 throw new Exception ('cannot decide between left and right', E_INTERNAL);
0137d53c
DO
1694}
1695
3b81cb98 1696function treeApplyFunc (&$tree, $func = '', $stopfunc = '')
0137d53c 1697{
59a83bd8 1698 if (!strlen ($func))
0137d53c
DO
1699 return;
1700 $self = __FUNCTION__;
1701 foreach (array_keys ($tree) as $key)
1702 {
1703 $func ($tree[$key]);
59a83bd8 1704 if (strlen ($stopfunc) and $stopfunc ($tree[$key]))
c3315231 1705 continue;
0137d53c
DO
1706 $self ($tree[$key]['kids'], $func);
1707 }
1708}
1709
a987ff52
DO
1710function loadIPv4AddrList (&$netinfo)
1711{
1712 loadOwnIPv4Addresses ($netinfo);
1713 markupIPv4AddrList ($netinfo['addrlist']);
1714}
b18d26dc 1715
b6b87070 1716function countOwnIPv4Addresses (&$node)
b18d26dc 1717{
b6b87070 1718 $toscan = array();
737a3f72 1719 $node['addrt'] = 0;
4d0dbd87
DO
1720 $node['mask_bin'] = binMaskFromDec ($node['mask']);
1721 $node['mask_bin_inv'] = binInvMaskFromDec ($node['mask']);
1722 $node['db_first'] = sprintf ('%u', 0x00000000 + $node['ip_bin'] & $node['mask_bin']);
1723 $node['db_last'] = sprintf ('%u', 0x00000000 + $node['ip_bin'] | ($node['mask_bin_inv']));
59a83bd8 1724 if (!count ($node['kids']))
737a3f72 1725 {
f7414fa5 1726 $toscan[] = array ('i32_first' => $node['db_first'], 'i32_last' => $node['db_last']);
737a3f72
DO
1727 $node['addrt'] = binInvMaskFromDec ($node['mask']) + 1;
1728 }
b18d26dc 1729 else
b6b87070 1730 foreach ($node['kids'] as $nested)
b18d26dc 1731 if (!isset ($nested['id'])) // spare
737a3f72 1732 {
f7414fa5 1733 $toscan[] = array ('i32_first' => $nested['db_first'], 'i32_last' => $nested['db_last']);
737a3f72
DO
1734 $node['addrt'] += binInvMaskFromDec ($nested['mask']) + 1;
1735 }
4d0dbd87
DO
1736 // Don't do anything more, because the displaying function will load the addresses anyway.
1737 return;
f7414fa5 1738 $node['addrc'] = count (scanIPv4Space ($toscan));
b6b87070
DO
1739}
1740
c3315231
DO
1741function nodeIsCollapsed ($node)
1742{
1743 return $node['symbol'] == 'node-collapsed';
1744}
1745
b6b87070
DO
1746function loadOwnIPv4Addresses (&$node)
1747{
1748 $toscan = array();
43eb71f1 1749 if (!isset ($node['kids']) or !count ($node['kids']))
f7414fa5 1750 $toscan[] = array ('i32_first' => $node['db_first'], 'i32_last' => $node['db_last']);
b6b87070
DO
1751 else
1752 foreach ($node['kids'] as $nested)
1753 if (!isset ($nested['id'])) // spare
f7414fa5
DO
1754 $toscan[] = array ('i32_first' => $nested['db_first'], 'i32_last' => $nested['db_last']);
1755 $node['addrlist'] = scanIPv4Space ($toscan);
b6b87070 1756 $node['addrc'] = count ($node['addrlist']);
b18d26dc
DO
1757}
1758
fec0c8da
DO
1759function prepareIPv4Tree ($netlist, $expanded_id = 0)
1760{
573214e0
DO
1761 // treeFromList() requires parent_id to be correct for an item to get onto the tree,
1762 // so perform necessary pre-processing to make orphans belong to root. This trick
1763 // was earlier performed by getIPv4NetworkList().
1764 $netids = array_keys ($netlist);
1765 foreach ($netids as $cid)
1766 if (!in_array ($netlist[$cid]['parent_id'], $netids))
1767 $netlist[$cid]['parent_id'] = NULL;
fec0c8da
DO
1768 $tree = treeFromList ($netlist); // medium call
1769 sortTree ($tree, 'IPv4NetworkCmp');
fec0c8da 1770 // complement the tree before markup to make the spare networks have "symbol" set
c3315231
DO
1771 treeApplyFunc ($tree, 'iptree_fill');
1772 iptree_markup_collapsion ($tree, getConfigVar ('TREE_THRESHOLD'), $expanded_id);
1773 // count addresses after the markup to skip computation for hidden tree nodes
1774 treeApplyFunc ($tree, 'countOwnIPv4Addresses', 'nodeIsCollapsed');
fec0c8da
DO
1775 return $tree;
1776}
1777
1778// Check all items of the tree recursively, until the requested target id is
1779// found. Mark all items leading to this item as "expanded", collapsing all
1780// the rest, which exceed the given threshold (if the threshold is given).
1781function iptree_markup_collapsion (&$tree, $threshold = 1024, $target = 0)
1782{
1783 $self = __FUNCTION__;
1784 $ret = FALSE;
1785 foreach (array_keys ($tree) as $key)
1786 {
5388794d 1787 $here = ($target === 'ALL' or ($target > 0 and isset ($tree[$key]['id']) and $tree[$key]['id'] == $target));
fec0c8da
DO
1788 $below = $self ($tree[$key]['kids'], $threshold, $target);
1789 if (!$tree[$key]['kidc']) // terminal node
1790 $tree[$key]['symbol'] = 'spacer';
1791 elseif ($tree[$key]['kidc'] < $threshold)
1792 $tree[$key]['symbol'] = 'node-expanded-static';
1793 elseif ($here or $below)
1794 $tree[$key]['symbol'] = 'node-expanded';
1795 else
1796 $tree[$key]['symbol'] = 'node-collapsed';
1797 $ret = ($ret or $here or $below); // parentheses are necessary for this to be computed correctly
1798 }
1799 return $ret;
1800}
1801
e1ae3fb4
AD
1802// Convert entity name to human-readable value
1803function formatEntityName ($name) {
1804 switch ($name)
1805 {
1806 case 'ipv4net':
1807 return 'IPv4 Network';
1808 case 'ipv4rspool':
1809 return 'IPv4 RS Pool';
1810 case 'ipv4vs':
1811 return 'IPv4 Virtual Service';
1812 case 'object':
1813 return 'Object';
1814 case 'rack':
1815 return 'Rack';
1816 case 'user':
1817 return 'User';
1818 }
1819 return 'invalid';
1820}
1821
1822// Take a MySQL or other generic timestamp and make it prettier
1823function formatTimestamp ($timestamp) {
1824 return date('n/j/y g:iA', strtotime($timestamp));
1825}
1826
8bc5d1e4
DO
1827// Display hrefs for all of a file's parents. If scissors are requested,
1828// prepend cutting button to each of them.
1829function serializeFileLinks ($links, $scissors = FALSE)
e1ae3fb4 1830{
e1ae3fb4
AD
1831 $comma = '';
1832 $ret = '';
1833 foreach ($links as $link_id => $li)
1834 {
1835 switch ($li['entity_type'])
1836 {
1837 case 'ipv4net':
1838 $params = "page=ipv4net&id=";
1839 break;
1840 case 'ipv4rspool':
1841 $params = "page=ipv4rspool&pool_id=";
1842 break;
1843 case 'ipv4vs':
1844 $params = "page=ipv4vs&vs_id=";
1845 break;
1846 case 'object':
1847 $params = "page=object&object_id=";
1848 break;
1849 case 'rack':
1850 $params = "page=rack&rack_id=";
1851 break;
1852 case 'user':
1853 $params = "page=user&user_id=";
1854 break;
1855 }
8bc5d1e4
DO
1856 $ret .= $comma;
1857 if ($scissors)
1858 {
1859 $ret .= "<a href='" . makeHrefProcess(array('op'=>'unlinkFile', 'link_id'=>$link_id)) . "'";
1860 $ret .= getImageHREF ('cut') . '</a> ';
1861 }
790a60e8 1862 $ret .= sprintf("<a href='index.php?%s%s'>%s</a>", $params, $li['entity_id'], $li['name']);
8bc5d1e4 1863 $comma = '<br>';
e1ae3fb4 1864 }
e1ae3fb4
AD
1865 return $ret;
1866}
1867
1868// Convert filesize to appropriate unit and make it human-readable
1869function formatFileSize ($bytes) {
1870 // bytes
1871 if($bytes < 1024) // bytes
1872 return "${bytes} bytes";
1873
1874 // kilobytes
1875 if ($bytes < 1024000)
1876 return sprintf ("%.1fk", round (($bytes / 1024), 1));
1877
1878 // megabytes
1879 return sprintf ("%.1f MB", round (($bytes / 1024000), 1));
1880}
1881
1882// Reverse of formatFileSize, it converts human-readable value to bytes
1883function convertToBytes ($value) {
1884 $value = trim($value);
1885 $last = strtolower($value[strlen($value)-1]);
1886 switch ($last)
1887 {
1888 case 'g':
1889 $value *= 1024;
1890 case 'm':
1891 $value *= 1024;
1892 case 'k':
1893 $value *= 1024;
1894 }
1895
1896 return $value;
1897}
1898
4fbb5a00
DY
1899function ip_quad2long ($ip)
1900{
1901 return sprintf("%u", ip2long($ip));
1902}
1903
1904function ip_long2quad ($quad)
1905{
1906 return long2ip($quad);
1907}
1908
1909function makeHref($params = array())
1910{
790a60e8 1911 $ret = 'index.php?';
4fbb5a00 1912 $first = true;
4fbb5a00
DY
1913 foreach($params as $key=>$value)
1914 {
1915 if (!$first)
1916 $ret.='&';
1917 $ret .= urlencode($key).'='.urlencode($value);
1918 $first = false;
1919 }
1920 return $ret;
1921}
1922
1923function makeHrefProcess($params = array())
1924{
790a60e8
DO
1925 global $pageno, $tabno;
1926 $ret = 'process.php?';
4fbb5a00 1927 $first = true;
9f14a7ef
DY
1928 if (!isset($params['page']))
1929 $params['page'] = $pageno;
1930 if (!isset($params['tab']))
1931 $params['tab'] = $tabno;
4fbb5a00
DY
1932 foreach($params as $key=>$value)
1933 {
1934 if (!$first)
1935 $ret.='&';
1936 $ret .= urlencode($key).'='.urlencode($value);
1937 $first = false;
1938 }
1939 return $ret;
1940}
1941
39106006 1942function makeHrefForHelper ($helper_name, $params = array())
4fbb5a00 1943{
790a60e8 1944 $ret = 'popup.php?helper=' . $helper_name;
4fbb5a00 1945 foreach($params as $key=>$value)
39106006 1946 $ret .= '&'.urlencode($key).'='.urlencode($value);
4fbb5a00
DY
1947 return $ret;
1948}
1949
f3d274bf
DO
1950// Process the given list of records to build data suitable for printNiftySelect()
1951// (like it was formerly executed by printSelect()). Screen out vendors according
1952// to VENDOR_SIEVE, if object type ID is provided. However, the OPTGROUP with already
1953// selected OPTION is protected from being screened.
1954function cookOptgroups ($recordList, $object_type_id = 0, $existing_value = 0)
1955{
1956 $ret = array();
1957 // Always keep "other" OPTGROUP at the SELECT bottom.
1958 $therest = array();
1959 foreach ($recordList as $dict_key => $dict_value)
1960 if (strpos ($dict_value, '%GSKIP%') !== FALSE)
1961 {
1962 $tmp = explode ('%GSKIP%', $dict_value, 2);
1963 $ret[$tmp[0]][$dict_key] = $tmp[1];
1964 }
1965 elseif (strpos ($dict_value, '%GPASS%') !== FALSE)
1966 {
1967 $tmp = explode ('%GPASS%', $dict_value, 2);
1968 $ret[$tmp[0]][$dict_key] = $tmp[1];
1969 }
1970 else
1971 $therest[$dict_key] = $dict_value;
1972 if ($object_type_id != 0)
1973 {
1974 $screenlist = array();
1975 foreach (explode (';', getConfigVar ('VENDOR_SIEVE')) as $sieve)
eea3ca5e 1976 if (preg_match ("/^([^@]+)(@${object_type_id})?\$/", trim ($sieve), $regs)){
f3d274bf 1977 $screenlist[] = $regs[1];
eea3ca5e 1978 }
f3d274bf
DO
1979 foreach (array_keys ($ret) as $vendor)
1980 if (in_array ($vendor, $screenlist))
1981 {
1982 $ok_to_screen = TRUE;
1983 if ($existing_value)
1984 foreach (array_keys ($ret[$vendor]) as $recordkey)
1985 if ($recordkey == $existing_value)
1986 {
1987 $ok_to_screen = FALSE;
1988 break;
1989 }
1990 if ($ok_to_screen)
1991 unset ($ret[$vendor]);
1992 }
1993 }
1994 $ret['other'] = $therest;
1995 return $ret;
1996}
1997
f8874cdb
DO
1998function dos2unix ($text)
1999{
2000 return str_replace ("\r\n", "\n", $text);
2001}
2002
9dd73255
DO
2003function unix2dos ($text)
2004{
2005 return str_replace ("\n", "\r\n", $text);
2006}
2007
a0527aef 2008function buildPredicateTable ($parsetree)
2c21a10c 2009{
a0527aef
DO
2010 $ret = array();
2011 foreach ($parsetree as $sentence)
72e8baf6 2012 if ($sentence['type'] == 'SYNT_DEFINITION')
a0527aef 2013 $ret[$sentence['term']] = $sentence['definition'];
72e8baf6
DO
2014 // Now we have predicate table filled in with the latest definitions of each
2015 // particular predicate met. This isn't as chik, as on-the-fly predicate
2016 // overloading during allow/deny scan, but quite sufficient for this task.
a0527aef
DO
2017 return $ret;
2018}
2019
2020// Take a list of records and filter against given RackCode expression. Return
2021// the original list intact, if there was no filter requested, but return an
2022// empty list, if there was an error.
573214e0 2023function filterCellList ($list_in, $expression = array())
d08d766d
DO
2024{
2025 if ($expression === NULL)
2026 return array();
2027 if (!count ($expression))
2028 return $list_in;
d08d766d
DO
2029 $list_out = array();
2030 foreach ($list_in as $item_key => $item_value)
573214e0 2031 if (TRUE === judgeCell ($item_value, $expression))
d08d766d
DO
2032 $list_out[$item_key] = $item_value;
2033 return $list_out;
2034}
2035
212c9d8a 2036// Tell, if the given expression is true for the given entity. Take complete record on input.
573214e0 2037function judgeCell ($cell, $expression)
d08d766d
DO
2038{
2039 global $pTable;
2040 return eval_expression
2041 (
2042 $expression,
2043 array_merge
2044 (
573214e0
DO
2045 $cell['etags'],
2046 $cell['itags'],
2047 $cell['atags']
d08d766d
DO
2048 ),
2049 $pTable,
2050 TRUE
2051 );
2052}
2053
7ddbcf59 2054// Tell, if a constraint from config option permits given record.
212c9d8a 2055function considerConfiguredConstraint ($cell, $varname)
c6bc0ac5 2056{
7ddbcf59 2057 if (!strlen (getConfigVar ($varname)))
c6bc0ac5 2058 return TRUE; // no restriction
7ddbcf59
DO
2059 global $parseCache;
2060 if (!isset ($parseCache[$varname]))
2061 // getConfigVar() doesn't re-read the value from DB because of its
2062 // own cache, so there is no race condition here between two calls.
2063 $parseCache[$varname] = spotPayload (getConfigVar ($varname), 'SYNT_EXPR');
2064 if ($parseCache[$varname]['result'] != 'ACK')
2065 return FALSE; // constraint set, but cannot be used due to compilation error
212c9d8a 2066 return judgeCell ($cell, $parseCache[$varname]['load']);
c6bc0ac5
DO
2067}
2068
17112e81
DO
2069// Return list of records in the given realm, which conform to
2070// the given RackCode expression. If the realm is unknown or text
2071// doesn't validate as a RackCode expression, return NULL.
2072// Otherwise (successful scan) return a list of all matched
2073// records, even if the list is empty (array() !== NULL). If the
2074// text is an empty string, return all found records in the given
2075// realm.
2076function scanRealmByText ($realm = NULL, $ftext = '')
2077{
2078 switch ($realm)
2079 {
2080 case 'object':
2081 case 'user':
2082 case 'ipv4net':
2083 case 'file':
39776127 2084 case 'ipv4vs':
41780975 2085 case 'ipv4rspool':
17112e81
DO
2086 if (!strlen ($ftext = trim ($ftext)))
2087 $fexpr = array();
2088 else
2089 {
2090 $fparse = spotPayload ($ftext, 'SYNT_EXPR');
2091 if ($fparse['result'] != 'ACK')
2092 return NULL;
2093 $fexpr = $fparse['load'];
2094 }
2095 return filterCellList (listCells ($realm), $fexpr);
2096 default:
c5f84f48 2097 throw new InvalidArgException ('$realm', $realm);
17112e81
DO
2098 }
2099
2100}
39776127
DO
2101
2102function getIPv4VSOptions ()
2103{
2104 $ret = array();
2105 foreach (listCells ('ipv4vs') as $vsid => $vsinfo)
59a83bd8 2106 $ret[$vsid] = $vsinfo['dname'] . (!strlen ($vsinfo['name']) ? '' : " (${vsinfo['name']})");
39776127
DO
2107 return $ret;
2108}
2109
41780975
DO
2110function getIPv4RSPoolOptions ()
2111{
2112 $ret = array();
2113 foreach (listCells ('ipv4rspool') as $pool_id => $poolInfo)
2114 $ret[$pool_id] = $poolInfo['name'];
2115 return $ret;
2116}
2117
d16af52f
DO
2118// Derive a complete cell structure from the given username regardless
2119// if it is a local account or not.
2120function constructUserCell ($username)
2121{
2122 if (NULL !== ($userid = getUserIDByUsername ($username)))
2123 return spotEntity ('user', $userid);
2124 $ret = array
2125 (
2126 'realm' => 'user',
2127 'user_name' => $username,
2128 'user_realname' => '',
2129 'etags' => array(),
2130 'itags' => array(),
d16af52f 2131 );
5689cefd 2132 $ret['atags'] = generateEntityAutoTags ($ret);
d16af52f
DO
2133 return $ret;
2134}
2135
56a797ef
DO
2136// Let's have this debug helper here to enable debugging of process.php w/o interface.php.
2137function dump ($var)
2138{
2139 echo '<div align=left><pre>';
2140 print_r ($var);
2141 echo '</pre></div>';
2142}
2143
9e51318b
DO
2144function getTagChart ($limit = 0, $realm = 'total', $special_tags = array())
2145{
2146 global $taglist;
2147 // first build top-N chart...
2148 $toplist = array();
2149 foreach ($taglist as $taginfo)
2150 if (isset ($taginfo['refcnt'][$realm]))
2151 $toplist[$taginfo['id']] = $taginfo['refcnt'][$realm];
2152 arsort ($toplist, SORT_NUMERIC);
2153 $ret = array();
2154 $done = 0;
2155 foreach (array_keys ($toplist) as $tag_id)
2156 {
2157 $ret[$tag_id] = $taglist[$tag_id];
2158 if (++$done == $limit)
2159 break;
2160 }
2161 // ...then make sure, that every item of the special list is shown
2162 // (using the same sort order)
2163 $extra = array();
2164 foreach ($special_tags as $taginfo)
2165 if (!array_key_exists ($taginfo['id'], $ret))
2166 $extra[$taginfo['id']] = $taglist[$taginfo['id']]['refcnt'][$realm];
2167 arsort ($extra, SORT_NUMERIC);
2168 foreach (array_keys ($extra) as $tag_id)
2169 $ret[] = $taglist[$tag_id];
2170 return $ret;
2171}
2172
7fa7047a
DO
2173function decodeObjectType ($objtype_id, $style = 'r')
2174{
2175 static $types = array();
2176 if (!count ($types))
2177 $types = array
2178 (
2179 'r' => readChapter (CHAP_OBJTYPE),
2180 'a' => readChapter (CHAP_OBJTYPE, 'a'),
2181 'o' => readChapter (CHAP_OBJTYPE, 'o')
2182 );
2183 return $types[$style][$objtype_id];
2184}
2185
0df8c52b
DO
2186function isolatedPermission ($p, $t, $cell)
2187{
2188 // This function is called from both "file" page and a number of other pages,
2189 // which have already fixed security context and authorized the user for it.
2190 // OTOH, it is necessary here to authorize against the current file, which
2191 // means saving the current context and building a new one.
2192 global
2193 $expl_tags,
2194 $impl_tags,
2195 $target_given_tags,
2196 $auto_tags;
2197 // push current context
2198 $orig_expl_tags = $expl_tags;
2199 $orig_impl_tags = $impl_tags;
2200 $orig_target_given_tags = $target_given_tags;
2201 $orig_auto_tags = $auto_tags;
2202 // retarget
2203 fixContext ($cell);
2204 // remember decision
2205 $ret = permitted ($p, $t);
2206 // pop context
2207 $expl_tags = $orig_expl_tags;
2208 $impl_tags = $orig_impl_tags;
2209 $target_given_tags = $orig_target_given_tags;
2210 $auto_tags = $orig_auto_tags;
2211 return $ret;
2212}
2213
3153a326
DO
2214function getPortListPrefs()
2215{
2216 $ret = array();
2217 if (0 >= ($ret['iif_pick'] = getConfigVar ('DEFAULT_PORT_IIF_ID')))
2218 $ret['iif_pick'] = 1;
2219 $ret['oif_picks'] = array();
2220 foreach (explode (';', getConfigVar ('DEFAULT_PORT_OIF_IDS')) as $tmp)
2221 {
2222 $tmp = explode ('=', trim ($tmp));
2223 if (count ($tmp) == 2 and $tmp[0] > 0 and $tmp[1] > 0)
2224 $ret['oif_picks'][$tmp[0]] = $tmp[1];
2225 }
2226 // enforce default value
2227 if (!array_key_exists (1, $ret['oif_picks']))
2228 $ret['oif_picks'][1] = 24;
2229 $ret['selected'] = $ret['iif_pick'] . '-' . $ret['oif_picks'][$ret['iif_pick']];
2230 return $ret;
2231}
2232
2dfa1b73
DO
2233// Return data for printNiftySelect() with port type options. All OIF options
2234// for the default IIF will be shown, but only the default OIFs will be present
2235// for each other IIFs. IIFs, for which there is no default OIF, will not
2236// be listed.
2237// This SELECT will be used for the "add new port" form.
2238function getNewPortTypeOptions()
2239{
2240 $ret = array();
2241 $prefs = getPortListPrefs();
2242 foreach (getPortInterfaceCompat() as $row)
2243 {
2244 if ($row['iif_id'] == $prefs['iif_pick'])
2245 $optgroup = $row['iif_name'];
2246 elseif (array_key_exists ($row['iif_id'], $prefs['oif_picks']) and $prefs['oif_picks'][$row['iif_id']] == $row['oif_id'])
2247 $optgroup = 'other';
2248 else
2249 continue;
2250 if (!array_key_exists ($optgroup, $ret))
2251 $ret[$optgroup] = array();
2252 $ret[$optgroup][$row['iif_id'] . '-' . $row['oif_id']] = $row['oif_name'];
2253 }
2254 return $ret;
2255}
2256
8198f2c6
DO
2257// Return a serialized version of VLAN configuration for a port.
2258// If a native VLAN is defined, print it first. All other VLANs
d0dadd80
DO
2259// are tagged and are listed after a plus sign. When no configuration
2260// is set for a port, return "default" string.
4f860864 2261function serializeVLANPack ($vlanport)
8198f2c6 2262{
4f860864
DO
2263 if (!array_key_exists ('mode', $vlanport))
2264 return 'error';
2265 switch ($vlanport['mode'])
2266 {
2267 case 'none':
2268 return 'none';
2269 case 'access':
2270 $ret = 'A';
2271 break;
2272 case 'trunk':
2273 $ret = 'T';
2274 break;
36a70b71
DO
2275 case 'uplink':
2276 $ret = 'U';
2277 break;
2278 case 'downlink':
2279 $ret = 'D';
2280 break;
4f860864
DO
2281 default:
2282 return 'error';
2283 }
8198f2c6 2284 $tagged = array();
4f860864
DO
2285 foreach ($vlanport['allowed'] as $vlan_id)
2286 if ($vlan_id != $vlanport['native'])
8198f2c6
DO
2287 $tagged[] = $vlan_id;
2288 sort ($tagged);
4f860864 2289 $ret .= $vlanport['native'] ? $vlanport['native'] : '';
e9be55de
DO
2290 $tagged_bits = array();
2291 $id_from = $id_to = 0;
2292 foreach ($tagged as $next_id)
2293 {
2294 if ($id_to)
2295 {
2296 if ($next_id == $id_to + 1) // merge
2297 {
2298 $id_to = $next_id;
2299 continue;
2300 }
2301 // flush
2302 $tagged_bits[] = $id_from == $id_to ? $id_from : "${id_from}-${id_to}";
2303 }
2304 $id_from = $id_to = $next_id; // start next pair
2305 }
2306 // pull last pair
2307 if ($id_to)
2308 $tagged_bits[] = $id_from == $id_to ? $id_from : "${id_from}-${id_to}";
8198f2c6 2309 if (count ($tagged))
a9953bf1 2310 $ret .= '+' . implode (', ', $tagged_bits);
d0dadd80 2311 return strlen ($ret) ? $ret : 'default';
8198f2c6
DO
2312}
2313
8846b060
DO
2314// Decode VLAN compound key (which is a string formatted DOMAINID-VLANID) and
2315// return the numbers as an array of two.
2316function decodeVLANCK ($string)
2317{
2318 $matches = array();
2319 if (1 != preg_match ('/^([[:digit:]]+)-([[:digit:]]+)$/', $string, $matches))
2320 throw new InvalidArgException ('VLAN compound key', $string);
2321 return array ($matches[1], $matches[2]);
2322}
2323
ce85f5c8
DO
2324// Return VLAN name formatted for HTML output (note, that input
2325// argument comes from database unescaped).
a72aa89f
DO
2326function formatVLANName ($vlaninfo, $context = 'markup long')
2327{
2328 switch ($context)
2329 {
2330 case 'option':
2331 $ret = $vlaninfo['vlan_id'];
2332 if ($vlaninfo['vlan_descr'] != '')
2333 $ret .= ' ' . niftyString ($vlaninfo['vlan_descr']);
2334 return $ret;
2335 case 'label':
2336 $ret = $vlaninfo['vlan_id'];
2337 if ($vlaninfo['vlan_descr'] != '')
2338 $ret .= ' <i>(' . niftyString ($vlaninfo['vlan_descr']) . ')</i>';
2339 return $ret;
0812b506
DO
2340 case 'plain long':
2341 $ret = 'VLAN' . $vlaninfo['vlan_id'];
2342 if ($vlaninfo['vlan_descr'] != '')
2343 $ret .= ' (' . niftyString ($vlaninfo['vlan_descr']) . ')';
2344 return $ret;
a72aa89f
DO
2345 case 'markup long':
2346 default:
2347 $ret = 'VLAN' . $vlaninfo['vlan_id'];
2348 $ret .= ' @' . niftyString ($vlaninfo['domain_descr']);
2349 if ($vlaninfo['vlan_descr'] != '')
2350 $ret .= ' <i>(' . niftyString ($vlaninfo['vlan_descr']) . ')</i>';
2351 return $ret;
2352 }
ce85f5c8
DO
2353}
2354
e9d357e1
DO
2355// map interface name
2356function ios12ShortenIfName ($ifname)
2357{
2358 $ifname = preg_replace ('@^Ethernet(.+)$@', 'et\\1', $ifname);
2359 $ifname = preg_replace ('@^FastEthernet(.+)$@', 'fa\\1', $ifname);
2360 $ifname = preg_replace ('@^GigabitEthernet(.+)$@', 'gi\\1', $ifname);
2361 $ifname = preg_replace ('@^TenGigabitEthernet(.+)$@', 'te\\1', $ifname);
2362 $ifname = preg_replace ('@^Port-channel(.+)$@', 'po\\1', $ifname);
2363 return $ifname;
2364}
2365
f10dd5cc
DO
2366function iosParseVLANString ($string)
2367{
2368 $ret = array();
2369 foreach (explode (',', $string) as $item)
2370 {
2371 $matches = array();
735e323f 2372 $item = trim ($item, ' ');
f10dd5cc
DO
2373 if (preg_match ('/^([[:digit:]]+)$/', $item, $matches))
2374 $ret[] = $matches[1];
2375 elseif (preg_match ('/^([[:digit:]]+)-([[:digit:]]+)$/', $item, $matches))
2376 $ret = array_merge ($ret, range ($matches[1], $matches[2]));
2377 }
2378 return $ret;
2379}
2380
bb35bb93
DO
2381// Scan given array and return the key, which addresses the first item
2382// with requested column set to given value (or NULL if there is none such).
19350222
DO
2383// Note that 0 and NULL mean completely different things and thus
2384// require strict checking (=== and !===).
dbc00990
DO
2385function scanArrayForItem ($table, $scan_column, $scan_value)
2386{
2387 foreach ($table as $key => $row)
2388 if ($row[$scan_column] == $scan_value)
2389 return $key;
2390 return NULL;
2391}
2392
66658512
DO
2393// Return TRUE, if every value of A1 is present in A2 and vice versa,
2394// regardless of each array's sort order and indexing.
2395function array_values_same ($a1, $a2)
2396{
2397 return !count (array_diff ($a1, $a2)) and !count (array_diff ($a2, $a1));
2398}
2399
1ce258f7
DO
2400// Use the VLAN switch template to set VST role for each port of
2401// the provided list. Return resulting list.
bc254f49 2402function apply8021QOrder ($vst_id, $portlist)
25930440 2403{
bc254f49 2404 $vst = getVLANSwitchTemplate ($vst_id);
1ce258f7
DO
2405 foreach (array_keys ($portlist) as $port_name)
2406 {
2407 foreach ($vst['rules'] as $rule)
2408 if (preg_match ($rule['port_pcre'], $port_name))
25930440
DO
2409 {
2410 $portlist[$port_name]['vst_role'] = $rule['port_role'];
091768aa 2411 $portlist[$port_name]['wrt_vlans'] = buildVLANFilter ($rule['port_role'], $rule['wrt_vlans']);
1ce258f7 2412 continue 2;
25930440 2413 }
1ce258f7
DO
2414 $portlist[$port_name]['vst_role'] = 'none';
2415 }
25930440
DO
2416 return $portlist;
2417}
2418
091768aa
DO
2419// return a sequence of ranges for given string form and port role
2420function buildVLANFilter ($role, $string)
be28b696 2421{
091768aa 2422 // set base
1ce258f7 2423 switch ($role)
be28b696 2424 {
1ce258f7
DO
2425 case 'access': // 1-4094
2426 $min = VLAN_MIN_ID;
2427 $max = VLAN_MAX_ID;
2428 break;
2429 case 'trunk': // 2-4094
2430 case 'uplink':
65da0c15 2431 case 'downlink':
1ce258f7
DO
2432 $min = VLAN_MIN_ID + 1;
2433 $max = VLAN_MAX_ID;
2434 break;
65da0c15 2435 default: // none
1ce258f7 2436 return array();
be28b696 2437 }
091768aa
DO
2438 if ($string == '') // fast track
2439 return array (array ('from' => $min, 'to' => $max));
2440 // transform
2441 $vlanidlist = array();
1ce258f7
DO
2442 foreach (iosParseVLANString ($string) as $vlan_id)
2443 if ($min <= $vlan_id and $vlan_id <= $max)
091768aa 2444 $vlanidlist[] = $vlan_id;
cc6a6c4e
DO
2445 return listToRanges ($vlanidlist);
2446}
2447
2448// pack set of integers into list of integer ranges
2449// e.g. (1, 2, 3, 5, 6, 7, 9, 11) => ((1, 3), (5, 7), (9, 9), (11, 11))
2450function listToRanges ($vlanidlist)
2451{
091768aa
DO
2452 sort ($vlanidlist);
2453 $ret = array();
2454 $from = $to = NULL;
2455 foreach ($vlanidlist as $vlan_id)
2456 if ($from == NULL)
2457 $from = $to = $vlan_id;
2458 elseif ($to + 1 == $vlan_id)
2459 $to = $vlan_id;
2460 else
2461 {
2462 $ret[] = array ('from' => $from, 'to' => $to);
2463 $from = $to = $vlan_id;
2464 }
2465 if ($from != NULL)
2466 $ret[] = array ('from' => $from, 'to' => $to);
be28b696
DO
2467 return $ret;
2468}
2469
091768aa
DO
2470// return TRUE, if given VLAN ID belongs to one of filter's ranges
2471function matchVLANFilter ($vlan_id, $vfilter)
2472{
2473 foreach ($vfilter as $range)
2474 if ($range['from'] <= $vlan_id and $vlan_id <= $range['to'])
2475 return TRUE;
2476 return FALSE;
2477}
2478
bcd14540
DO
2479function exportSwitch8021QConfig
2480(
2481 $vswitch,
2482 $device_vlanlist,
2483 $before,
2484 $changes
2485)
2486{
2487 // only ignore VLANs, which exist and are explicitly shown as "alien"
2488 $old_managed_vlans = array();
2489 $domain_vlanlist = getDomainVLANs ($vswitch['domain_id']);
2490 foreach ($device_vlanlist as $vlan_id)
2491 if
2492 (
2493 !array_key_exists ($vlan_id, $domain_vlanlist) or
2494 $domain_vlanlist[$vlan_id]['vlan_type'] != 'alien'
2495 )
2496 $old_managed_vlans[] = $vlan_id;
2497 $ports_to_do = array();
2498 $after = $before;
2499 foreach ($changes as $port_name => $port)
2500 {
2501 $ports_to_do[$port_name] = array
2502 (
2503 'old_mode' => $before[$port_name]['mode'],
2504 'old_allowed' => $before[$port_name]['allowed'],
2505 'old_native' => $before[$port_name]['native'],
2506 'new_mode' => $port['mode'],
2507 'new_allowed' => $port['allowed'],
2508 'new_native' => $port['native'],
2509 );
2510 $after[$port_name] = $port;
2511 }
2512 // New VLAN table is a union of:
2513 // 1. all compulsory VLANs
2514 // 2. all "current" non-alien allowed VLANs of those ports, which are left
2515 // intact (regardless if a VLAN exists in VLAN domain, but looking,
2516 // if it is present in device's own VLAN table)
2517 // 3. all "new" allowed VLANs of those ports, which we do "push" now
2518 // Like for old_managed_vlans, a VLANs is never listed, only if it
2519 // exists and belongs to "alien" type.
2520 $new_managed_vlans = array();
2521 // 1
2522 foreach ($domain_vlanlist as $vlan_id => $vlan)
2523 if ($vlan['vlan_type'] == 'compulsory')
2524 $new_managed_vlans[] = $vlan_id;
2525 // 2
2526 foreach ($before as $port_name => $port)
2527 if (!array_key_exists ($port_name, $changes))
2528 foreach ($port['allowed'] as $vlan_id)
2529 {
2530 if (in_array ($vlan_id, $new_managed_vlans))
2531 continue;
2532 if
2533 (
2534 array_key_exists ($vlan_id, $domain_vlanlist) and
2535 $domain_vlanlist[$vlan_id]['vlan_type'] == 'alien'
2536 )
2537 continue;
2538 if (in_array ($vlan_id, $device_vlanlist))
2539 $new_managed_vlans[] = $vlan_id;
2540 }
2541 // 3
2542 foreach ($changes as $port)
10b6b476 2543 foreach ($port['allowed'] as $vlan_id)
bcd14540
DO
2544 if
2545 (
2546 $domain_vlanlist[$vlan_id]['vlan_type'] == 'ondemand' and
2547 !in_array ($vlan_id, $new_managed_vlans)
2548 )
2549 $new_managed_vlans[] = $vlan_id;
2550 $crq = array();
2551 // Before removing each old VLAN as such it is necessary to unassign
2552 // ports from it (to remove VLAN from each ports' list of "allowed"
2553 // VLANs). This change in turn requires, that a port's "native"
2554 // VLAN isn't set to the one being removed from its "allowed" list.
2555 foreach ($ports_to_do as $port_name => $port)
2556 switch ($port['old_mode'] . '->' . $port['new_mode'])
2557 {
2558 case 'trunk->trunk':
2559 // "old" native is set and differs from the "new" native
2560 if ($port['old_native'] and $port['old_native'] != $port['new_native'])
2561 $crq[] = array
2562 (
2563 'opcode' => 'unset native',
2564 'arg1' => $port_name,
2565 'arg2' => $port['old_native'],
2566 );
cc6a6c4e 2567 if (count ($tmp = array_diff ($port['old_allowed'], $port['new_allowed'])))
bcd14540
DO
2568 $crq[] = array
2569 (
2570 'opcode' => 'rem allowed',
cc6a6c4e
DO
2571 'port' => $port_name,
2572 'vlans' => $tmp,
bcd14540
DO
2573 );
2574 break;
2575 case 'access->access':
2576 if ($port['old_native'] and $port['old_native'] != $port['new_native'])
2577 $crq[] = array
2578 (
2579 'opcode' => 'unset access',
2580 'arg1' => $port_name,
2581 'arg2' => $port['old_native'],
2582 );
2583 break;
2584 case 'access->trunk':
2585 $crq[] = array
2586 (
2587 'opcode' => 'unset access',
2588 'arg1' => $port_name,
2589 'arg2' => $port['old_native'],
2590 );
2591 break;
2592 case 'trunk->access':
2593 $crq[] = array
2594 (
2595 'opcode' => 'unset native',
2596 'arg1' => $port_name,
2597 'arg2' => $port['old_native'],
2598 );
cc6a6c4e 2599 if (count ($port['old_allowed']))
bcd14540
DO
2600 $crq[] = array
2601 (
2602 'opcode' => 'rem allowed',
cc6a6c4e
DO
2603 'port' => $port_name,
2604 'vlans' => $port['old_allowed'],
bcd14540
DO
2605 );
2606 break;
2607 default:
164ba494 2608 throw new InvalidArgException ('ports_to_do', '(hidden)', 'error in structure');
bcd14540
DO
2609 }
2610 // Now it is safe to unconfigure VLANs, which still exist on device,
2611 // but are not present on the "new" list.
2612 // FIXME: put all IDs into one pseudo-command to make it easier
2613 // for translators to create/destroy VLANs in batches, where
2614 // target platform allows them to do.
2615 foreach (array_diff ($old_managed_vlans, $new_managed_vlans) as $vlan_id)
2616 $crq[] = array
2617 (
2618 'opcode' => 'destroy VLAN',
2619 'arg1' => $vlan_id,
2620 );
2621 // Configure VLANs, which must be present on the device, but are not yet.
2622 foreach (array_diff ($new_managed_vlans, $old_managed_vlans) as $vlan_id)
2623 $crq[] = array
2624 (
2625 'opcode' => 'create VLAN',
2626 'arg1' => $vlan_id,
2627 );
2628 // Now, when all new VLANs are created (queued), it is safe to assign (queue)
2629 // ports to the new VLANs.
2630 foreach ($ports_to_do as $port_name => $port)
2631 switch ($port['old_mode'] . '->' . $port['new_mode'])
2632 {
2633 case 'trunk->trunk':
2634 // For each allowed VLAN, which is present on the "new" list and missing from
2635 // the "old" one, queue a command to assign current port to that VLAN.
cc6a6c4e 2636 if (count ($tmp = array_diff ($port['new_allowed'], $port['old_allowed'])))
bcd14540
DO
2637 $crq[] = array
2638 (
2639 'opcode' => 'add allowed',
cc6a6c4e
DO
2640 'port' => $port_name,
2641 'vlans' => $tmp,
bcd14540
DO
2642 );
2643 // One of the "allowed" VLANs for this port may probably be "native".
2644 // "new native" is set and differs from "old native"
2645 if ($port['new_native'] and $port['new_native'] != $port['old_native'])
2646 $crq[] = array
2647 (
2648 'opcode' => 'set native',
2649 'arg1' => $port_name,
2650 'arg2' => $port['new_native'],
2651 );
2652 break;
2653 case 'access->access':
2654 if ($port['new_native'] and $port['new_native'] != $port['old_native'])
2655 $crq[] = array
2656 (
2657 'opcode' => 'set access',
2658 'arg1' => $port_name,
2659 'arg2' => $port['new_native'],
2660 );
2661 break;
2662 case 'access->trunk':
2663 $crq[] = array
2664 (
2665 'opcode' => 'set mode',
2666 'arg1' => $port_name,
2667 'arg2' => $port['new_mode'],
2668 );
cc6a6c4e 2669 if (count ($port['new_allowed']))
bcd14540
DO
2670 $crq[] = array
2671 (
2672 'opcode' => 'add allowed',
cc6a6c4e
DO
2673 'port' => $port_name,
2674 'vlans' => $port['new_allowed'],
bcd14540
DO
2675 );
2676 $crq[] = array
2677 (
2678 'opcode' => 'set native',
2679 'arg1' => $port_name,
2680 'arg2' => $port['new_native'],
2681 );
2682 break;
2683 case 'trunk->access':
2684 $crq[] = array
2685 (
2686 'opcode' => 'set mode',
2687 'arg1' => $port_name,
2688 'arg2' => $port['new_mode'],
2689 );
2690 $crq[] = array
2691 (
2692 'opcode' => 'set access',
2693 'arg1' => $port_name,
2694 'arg2' => $port['new_native'],
2695 );
2696 break;
2697 default:
164ba494 2698 throw new InvalidArgException ('ports_to_do', '(hidden)', 'error in structure');
bcd14540
DO
2699 }
2700 setDevice8021QConfig ($vswitch['object_id'], $crq);
2701 return count ($crq);
2702}
2703
af204724 2704// filter list of changed ports to cancel changes forbidden by VST and domain
af204724
DO
2705function filter8021QChangeRequests
2706(
2707 $domain_vlanlist,
2708 $before, // current saved configuration of all ports
2709 $changes // changed ports with VST markup
2710)
2711{
2712 $domain_immune_vlans = array();
2713 foreach ($domain_vlanlist as $vlan_id => $vlan)
2714 if ($vlan['vlan_type'] == 'alien')
2715 $domain_immune_vlans[] = $vlan_id;
2716 $ret = array();
2717 foreach ($changes as $port_name => $port)
2718 {
af204724 2719 // find and cancel any changes regarding immune VLANs
034a61c9
DO
2720 switch ($port['vst_role'])
2721 {
2722 case 'access':
2723 if ($port['mode'] != 'access') // VST violation
2724 continue 2; // ignore change request
2725 foreach ($domain_immune_vlans as $immune)
af204724
DO
2726 // Reverting an attempt to set an access port from
2727 // "normal" VLAN to immune one (or vice versa) requires
2728 // special handling, becase the calling function has
2729 // discarded the old contents of 'allowed' for current port.
af204724
DO
2730 if
2731 (
2732 $before[$port_name]['native'] == $immune or
2733 $port['native'] == $immune
2734 )
2735 {
2736 $port['native'] = $before[$port_name]['native'];
2737 $port['allowed'] = array ($port['native']);
034a61c9
DO
2738 // Such reversal happens either once or never for an
2739 // access port.
2740 break;
af204724 2741 }
034a61c9
DO
2742 break;
2743 case 'trunk':
2744 case 'uplink':
2745 case 'downlink':
2746 if ($port['mode'] != 'trunk')
2747 continue 2;
2748 foreach ($domain_immune_vlans as $immune)
af204724
DO
2749 if (in_array ($immune, $before[$port_name]['allowed'])) // was allowed before
2750 {
2751 if (!in_array ($immune, $port['allowed']))
2752 $port['allowed'][] = $immune; // restore
2753 if ($before[$port_name]['native'] == $immune) // and was native
2754 $port['native'] = $immune; // also restore
2755 }
2756 else // wasn't
2757 {
2758 if (in_array ($immune, $port['allowed']))
2759 unset ($port['allowed'][array_search ($immune, $port['allowed'])]); // cancel
2760 if ($port['native'] == $immune)
2761 $port['native'] = $before[$port_name]['native'];
2762 }
034a61c9
DO
2763 break;
2764 default:
2765 continue 2;
2766 }
2767 // save work
af204724
DO
2768 $ret[$port_name] = $port;
2769 }
2770 return $ret;
2771}
2772
4741e9c3 2773// take port list with order applied and return uplink ports in the same format
ca7f0af4 2774function produceUplinkPorts ($domain_vlanlist, $portlist)
4741e9c3
DO
2775{
2776 $ret = array();
ca7f0af4
DO
2777 $employed = array();
2778 foreach ($domain_vlanlist as $vlan_id => $vlan)
2779 if ($vlan['vlan_type'] == 'compulsory')
2780 $employed[] = $vlan_id;
2781 foreach ($portlist as $port_name => $port)
2782 if ($port['vst_role'] != 'uplink')
2783 foreach ($port['allowed'] as $vlan_id)
2784 if (!in_array ($vlan_id, $employed))
2785 $employed[] = $vlan_id;
2786 foreach ($portlist as $port_name => $port)
2787 if ($port['vst_role'] == 'uplink')
2788 {
1ce258f7
DO
2789 $employed_here = array();
2790 foreach ($employed as $vlan_id)
091768aa 2791 if (matchVLANFilter ($vlan_id, $port['wrt_vlans']))
1ce258f7 2792 $employed_here[] = $vlan_id;
ca7f0af4
DO
2793 $ret[$port_name] = array
2794 (
034a61c9 2795 'vst_role' => 'uplink',
ca7f0af4
DO
2796 'mode' => 'trunk',
2797 'allowed' => $employed_here,
2798 'native' => 0,
2799 );
2800 }
4741e9c3
DO
2801 return $ret;
2802}
2803
9c45ea37
DO
2804function same8021QConfigs ($a, $b)
2805{
2806 return $a['mode'] == $b['mode'] &&
2807 array_values_same ($a['allowed'], $b['allowed']) &&
2808 $a['native'] == $b['native'];
2809}
2810
26dec09b
DO
2811/*
2812
2813Relation between desired (D), cached (C) and running (R)
2814copies of switch ports (P) list.
2815
2816 D C R
2817+---+ +---+ +---+
2818| P |-----| P |-? +--| P |
2819+---+ +---+ / +---+
2820| P |-----| P |--+ ?-| P |
2821+---+ +---+ +---+
2822| P |-----| P |-------| P |
2823+---+ +---+ +---+
2824| P |-----| P |--+ ?-| P |
2825+---+ +---+ \ +---+
2826| P |-----| P |--+ +--| P |
2827+---+ +---+ \ +---+
2828 +--| P |
2829 +---+
2830 ?-| P |
2831 +---+
2832
2833A modified local version of a port in "conflict" state ignores remote
2834changes until remote change maintains its difference. Once both edits
2835match, the local copy "locks" on the remote and starts tracking it.
2836
2837v
2838a "o" -- remOte version
2839l "l" -- Local version
2840u "b" -- Both versions
2841e
2842
2843^
2844| o b
2845| o
2846| l l l l l l b b
2847| o o b
2848| o b
2849|
2850| o
2851|
2852|
28530----------------------------------------------> time
2854
2855*/
be28b696
DO
2856function get8021QSyncOptions
2857(
2858 $vswitch,
2859 $D, // desired config
2860 $C, // cached config
2861 $R // running-config
2862)
2863{
2864 $default_port = array
2865 (
2866 'mode' => 'access',
2867 'allowed' => array (VLAN_DFL_ID),
2868 'native' => VLAN_DFL_ID,
2869 );
ab25b0d0 2870 $ret = array();
24832534 2871 $allports = array();
ab25b0d0 2872 foreach (array_unique (array_merge (array_keys ($C), array_keys ($R))) as $pn)
d3082829
DO
2873 $allports[$pn] = array();
2874 foreach (apply8021QOrder ($vswitch['template_id'], $allports) as $pn => $port)
be28b696 2875 {
7a375475
DO
2876 // catch anomalies early
2877 if ($port['vst_role'] == 'none')
2878 {
2879 if ((!array_key_exists ($pn, $R) or $R[$pn]['mode'] == 'none') and !array_key_exists ($pn, $C))
2880 $ret[$pn] = array ('status' => 'none');
2881 else
2882 $ret[$pn] = array
2883 (
2884 'status' => 'martian_conflict',
2885 'left' => array_key_exists ($pn, $C) ? $C[$pn] : array ('mode' => 'none'),
2886 'right' => array_key_exists ($pn, $R) ? $R[$pn] : array ('mode' => 'none'),
2887 );
2888 continue;
2889 }
2890 elseif ((!array_key_exists ($pn, $R) or $R[$pn]['mode'] == 'none') and array_key_exists ($pn, $C))
2891 {
2892 $ret[$pn] = array
2893 (
2894 'status' => 'martian_conflict',
2895 'left' => array_key_exists ($pn, $C) ? $C[$pn] : array ('mode' => 'none'),
2896 'right' => array_key_exists ($pn, $R) ? $R[$pn] : array ('mode' => 'none'),
2897 );
2898 continue;
2899 }
26dec09b
DO
2900 // (DC_): port missing from device
2901 if (!array_key_exists ($pn, $R))
be28b696 2902 {
ef016293
DO
2903 $ret[$pn] = array ('left' => $D[$pn]);
2904 if (same8021QConfigs ($D[$pn], $default_port))
2905 $ret[$pn]['status'] = 'ok_to_delete';
2906 else
2907 {
2908 $ret[$pn]['status'] = 'delete_conflict';
2909 $ret[$pn]['lastseen'] = $C[$pn];
2910 }
be28b696
DO
2911 continue;
2912 }
26dec09b
DO
2913 // (__R): port missing from DB
2914 if (!array_key_exists ($pn, $C))
be28b696 2915 {
7a375475
DO
2916 // Allow importing any configuration, which passes basic
2917 // validation. If port mode doesn't match its VST role,
2918 // this will be handled later WRT each port.
ab25b0d0
DO
2919 $ret[$pn] = array
2920 (
7a375475 2921 'status' => acceptable8021QConfig ($R[$pn]) ? 'ok_to_add' : 'add_conflict',
ab25b0d0
DO
2922 'right' => $R[$pn],
2923 );
be28b696
DO
2924 continue;
2925 }
2926 $D_eq_C = same8021QConfigs ($D[$pn], $C[$pn]);
2927 $C_eq_R = same8021QConfigs ($C[$pn], $R[$pn]);
26dec09b 2928 // (DCR), D = C = R: data in sync
be28b696 2929 if ($D_eq_C and $C_eq_R) // implies D == R
ab25b0d0
DO
2930 {
2931 $ret[$pn] = array
2932 (
2933 'status' => 'in_sync',
2934 'both' => $R[$pn],
2935 );
be28b696 2936 continue;
ab25b0d0 2937 }
26dec09b 2938 // (DCR), D = C: no local edit in the way
be28b696 2939 if ($D_eq_C)
ab25b0d0
DO
2940 $ret[$pn] = array
2941 (
2942 'status' => 'ok_to_pull',
2943 'left' => $D[$pn],
2944 'right' => $R[$pn],
2945 );
26dec09b 2946 // (DCR), C = R: no remote edit in the way
be28b696 2947 elseif ($C_eq_R)
ab25b0d0
DO
2948 $ret[$pn] = array
2949 (
2950 'status' => 'ok_to_push',
2951 'left' => $D[$pn],
2952 'right' => $R[$pn],
2953 );
26dec09b 2954 // (DCR), D = R: end of version conflict, restore tracking
be28b696 2955 elseif (same8021QConfigs ($D[$pn], $R[$pn]))
ab25b0d0
DO
2956 $ret[$pn] = array
2957 (
d973196a 2958 'status' => 'ok_to_merge',
ab25b0d0
DO
2959 'both' => $R[$pn],
2960 );
26dec09b 2961 else // D != C, C != R, D != R: version conflict
ab25b0d0
DO
2962 $ret[$pn] = array
2963 (
d3082829
DO
2964 'status' => ($port['vst_role'] == 'access' or $port['vst_role'] == 'trunk') ?
2965 // In case the port is normally updated by user, let him
2966 // resolve the conflict. If the system manages this port,
2967 // arrange the data to let remote version go down.
2968 'merge_conflict' : 'ok_to_push_with_merge',
ab25b0d0
DO
2969 'left' => $D[$pn],
2970 'right' => $R[$pn],
2971 );
be28b696 2972 }
ab25b0d0 2973 return $ret;
be28b696
DO
2974}
2975
ca5d4cbc 2976// return number of records updated successfully of FALSE, if a conflict was in the way
d973196a 2977function exec8021QDeploy ($object_id, $do_push)
ca5d4cbc
DO
2978{
2979 global $dbxlink;
b3a27170 2980 $nsaved = $npushed = $nsaved_uplinks = 0;
ca5d4cbc
DO
2981 $dbxlink->beginTransaction();
2982 if (NULL === $vswitch = getVLANSwitchInfo ($object_id, 'FOR UPDATE'))
2983 throw new InvalidArgException ('object_id', $object_id, 'VLAN domain is not set for this object');
2984 $D = getStored8021QConfig ($vswitch['object_id'], 'desired');
2985 $C = getStored8021QConfig ($vswitch['object_id'], 'cached');
d973196a
DO
2986 try
2987 {
2988 $R = getRunning8021QConfig ($vswitch['object_id']);
2989 }
2990 catch (Exception $e)
2991 {
2992 $prepared = $dbxlink->prepare ("UPDATE VLANSwitch SET last_errno = ?, last_error_ts = NOW() WHERE object_id = ?");
2993 $prepared->execute (array (E_8021Q_PULL_REMOTE_ERROR, $vswitch['object_id']));
2994 $dbxlink->commit();
2995 return 0;
2996 }
ca5d4cbc 2997 $conflict = FALSE;
ca5d4cbc 2998 $ok_to_push = array();
d973196a 2999 foreach (get8021QSyncOptions ($vswitch, $D, $C, $R['portdata']) as $pn => $port)
ca5d4cbc
DO
3000 {
3001 // always update cache with new data from switch
3002 switch ($port['status'])
3003 {
d973196a
DO
3004 case 'ok_to_merge':
3005 upd8021QPort ('cached', $vswitch['object_id'], $pn, $port['both']);
ca5d4cbc
DO
3006 break;
3007 case 'ok_to_delete':
d973196a 3008 $nsaved += del8021QPort ($vswitch['object_id'], $pn);
ca5d4cbc
DO
3009 break;
3010 case 'ok_to_add':
d973196a 3011 $nsaved += add8021QPort ($vswitch['object_id'], $pn, $port['right']);
ca5d4cbc
DO
3012 break;
3013 case 'delete_conflict':
3014 case 'merge_conflict':
7a375475
DO
3015 case 'add_conflict':
3016 case 'martian_conflict':
ca5d4cbc
DO
3017 $conflict = TRUE;
3018 break;
3019 case 'ok_to_pull':
d973196a
DO
3020 upd8021QPort ('desired', $vswitch['object_id'], $pn, $port['right']);
3021 upd8021QPort ('cached', $vswitch['object_id'], $pn, $port['right']);
3022 $nsaved++;
ca5d4cbc 3023 break;
d3082829
DO
3024 case 'ok_to_push_with_merge':
3025 upd8021QPort ('cached', $vswitch['object_id'], $pn, $port['right']);
3026 // fall through
ca5d4cbc
DO
3027 case 'ok_to_push':
3028 $ok_to_push[$pn] = $port['left'];
3029 break;
3030 }
3031 }
32c7fad1
DO
3032 // redo uplinks unconditionally
3033 $domain_vlanlist = getDomainVLANs ($vswitch['domain_id']);
3034 $Dnew = apply8021QOrder ($vswitch['template_id'], getStored8021QConfig ($vswitch['object_id'], 'desired'));
034a61c9
DO
3035 // Take new "desired" configuration and derive uplink port configuration
3036 // from it. Then cancel changes to immune VLANs and save resulting
3037 // changes (if any left).
3038 $new_uplinks = filter8021QChangeRequests ($domain_vlanlist, $Dnew, produceUplinkPorts ($domain_vlanlist, $Dnew));
b3a27170
DO
3039 $nsaved_uplinks += replace8021QPorts ('desired', $vswitch['object_id'], $Dnew, $new_uplinks);
3040 if ($nsaved + $nsaved_uplinks)
94080e1c 3041 {
32c7fad1
DO
3042 // saved configuration has changed (either "user" ports have changed,
3043 // or uplinks, or both), so bump revision number up)
d973196a 3044 $prepared = $dbxlink->prepare ('UPDATE VLANSwitch SET mutex_rev = mutex_rev + 1, last_change = NOW(), out_of_sync = "yes" WHERE object_id = ?');
94080e1c 3045 $prepared->execute (array ($vswitch['object_id']));
ca5d4cbc 3046 }
d973196a 3047 if ($conflict)
ca5d4cbc 3048 {
e6579841 3049 $prepared = $dbxlink->prepare ('UPDATE VLANSwitch SET out_of_sync = "yes", last_errno = ?, last_error_ts = NOW() WHERE object_id = ?');
d973196a
DO
3050 $prepared->execute (array (E_8021Q_VERSION_CONFLICT, $vswitch['object_id']));
3051 }
52ce8bd7 3052 else
d973196a 3053 {
52ce8bd7
DO
3054 $prepared = $dbxlink->prepare ("UPDATE VLANSwitch SET last_errno = ?, last_error_ts = NOW() WHERE object_id = ?");
3055 $prepared->execute (array (E_8021Q_NOERROR, $vswitch['object_id']));
4799a8df
DO
3056 // Modified uplinks are very likely to differ from those in R-copy,
3057 // so don't mark device as clean, if this happened. This can cost
3058 // us an additional, empty round of sync, but at least out_of_sync
3059 // won't be mistakenly set to 'no'.
3060 // FIXME: A cleaner way of coupling pull and push operations would
3061 // be to split this function into two.
3062 if (!count ($ok_to_push) and !$nsaved_uplinks)
ca5d4cbc 3063 {
52ce8bd7 3064 $prepared = $dbxlink->prepare ("UPDATE VLANSwitch SET out_of_sync = 'no' WHERE object_id = ?");
d973196a
DO
3065 $prepared->execute (array ($vswitch['object_id']));
3066 }
52ce8bd7 3067 elseif ($do_push)
d973196a 3068 {
52ce8bd7
DO
3069 $prepared = $dbxlink->prepare ("UPDATE VLANSwitch SET last_push_started = NOW() WHERE object_id = ?");
3070 $prepared->execute (array ($vswitch['object_id']));
3071 try
3072 {
3073 $npushed += exportSwitch8021QConfig ($vswitch, $R['vlanlist'], $R['portdata'], $ok_to_push);
3074 // update cache for ports deployed
3075 replace8021QPorts ('cached', $vswitch['object_id'], $R['portdata'], $ok_to_push);
3076 $prepared = $dbxlink->prepare ('UPDATE VLANSwitch SET last_push_finished = NOW(), out_of_sync = "no", last_errno = ? WHERE object_id = ?');
3077 $prepared->execute (array (E_8021Q_NOERROR, $vswitch['object_id']));
3078 }
164ba494 3079 catch (Exception $r)
52ce8bd7 3080 {
e6579841 3081 $prepared = $dbxlink->prepare ('UPDATE VLANSwitch SET out_of_sync = "yes", last_error_ts = NOW(), last_errno = ? WHERE object_id = ?');
52ce8bd7
DO
3082 $prepared->execute (E_8021Q_PUSH_REMOTE_ERROR, array ($vswitch['object_id']));
3083 }
ca5d4cbc
DO
3084 }
3085 }
3086 $dbxlink->commit();
b3a27170
DO
3087 // start downlink work only after unlocking current object to make deadlocks less likely to happen
3088 // TODO: only process changed uplink ports
3089 if ($nsaved_uplinks)
3090 initiateUplinksReverb ($vswitch['object_id'], $new_uplinks);
3091 return $nsaved + $npushed + $nsaved_uplinks;
ca5d4cbc
DO
3092}
3093
be28b696
DO
3094// print part of HTML HEAD block
3095function printPageHeaders ()
3096{
3097 global $pageheaders;
3098 ksort ($pageheaders);
3099 foreach ($pageheaders as $s)
3100 echo $s . "\n";
3101 echo "<style type='text/css'>\n";
3102 foreach (array ('F', 'A', 'U', 'T', 'Th', 'Tw', 'Thw') as $statecode)
3103 {
3104 echo "td.state_${statecode} {\n";
3105 echo "\ttext-align: center;\n";
3106 echo "\tbackground-color: #" . (getConfigVar ('color_' . $statecode)) . ";\n";
3107 echo "\tfont: bold 10px Verdana, sans-serif;\n";
3108 echo "}\n\n";
3109 }
3110 echo '</style>';
3111}
3112
538d9cf8
DO
3113function strerror8021Q ($errno)
3114{
3115 switch ($errno)
3116 {
57acf3f5
DO
3117 case E_8021Q_VERSION_CONFLICT:
3118 return 'pull failed due to version conflict';
3119 case E_8021Q_PULL_REMOTE_ERROR:
3120 return 'pull failed due to remote error';
3121 case E_8021Q_PUSH_REMOTE_ERROR:
3122 return 'push failed due to remote error';
5701baec
DO
3123 case E_8021Q_SYNC_DISABLED:
3124 return 'sync disabled by operator';
57acf3f5
DO
3125 default:
3126 return "unknown error code ${errno}";
538d9cf8
DO
3127 }
3128}
3129
0c1674ae
DO
3130function saveDownlinksReverb ($object_id, $requested_changes)
3131{
3132 $nsaved = 0;
3133 global $dbxlink;
3134 $dbxlink->beginTransaction();
b3a27170
DO
3135 if (NULL === $vswitch = getVLANSwitchInfo ($object_id, 'FOR UPDATE')) // not configured, bail out
3136 {
3137 $dbxlink->rollBack();
3138 return;
3139 }
0c1674ae
DO
3140 $domain_vlanlist = getDomainVLANs ($vswitch['domain_id']);
3141 // aplly VST to the smallest set necessary
3142 $requested_changes = apply8021QOrder ($vswitch['template_id'], $requested_changes);
3143 $before = getStored8021QConfig ($object_id, 'desired');
3144 $changes_to_save = array();
3145 // first filter by wrt_vlans constraint
3146 foreach ($requested_changes as $pn => $requested)
3147 if (array_key_exists ($pn, $before) and $requested['vst_role'] == 'downlink')
3148 {
3149 $negotiated = array
3150 (
3151 'vst_role' => 'downlink',
3152 'mode' => 'trunk',
3153 'allowed' => array(),
3154 'native' => 0,
3155 );
3156 // wrt_vlans filter
3157 foreach ($requested['allowed'] as $vlan_id)
091768aa 3158 if (matchVLANFilter ($vlan_id, $requested['wrt_vlans']))
0c1674ae
DO
3159 $negotiated['allowed'][] = $vlan_id;
3160 $changes_to_save[$pn] = $negotiated;
3161 }
3162 // immune VLANs filter
3163 foreach (filter8021QChangeRequests ($domain_vlanlist, $before, $changes_to_save) as $pn => $finalconfig)
3164 if (!same8021QConfigs ($finalconfig, $before[$pn]))
3165 $nsaved += upd8021QPort ('desired', $vswitch['object_id'], $pn, $finalconfig);
3166 if ($nsaved)
3167 {
3168 $prepared = $dbxlink->prepare ('UPDATE VLANSwitch SET mutex_rev = mutex_rev + 1, last_change = NOW(), out_of_sync = "yes" WHERE object_id = ?');
3169 $prepared->execute (array ($vswitch['object_id']));
3170 }
3171 $dbxlink->commit();
3172}
3173
b3a27170
DO
3174// Use records from Port and Link tables to run a series of tasks on remote
3175// objects. These device-specific tasks will adjust downlink ports according to
3176// the current configuration of given uplink ports.
3177function initiateUplinksReverb ($object_id, $uplink_ports)
3178{
3179 $object = spotEntity ('object', $object_id);
3180 amplifyCell ($object);
3181 // Filter and regroup all requests (regardless of how many will succeed)
3182 // to end up with no more, than one execution per remote object.
3183 $upstream_config = array();
3184 foreach ($object['ports'] as $portinfo)
3185 if
3186 (
3187 array_key_exists ($portinfo['name'], $uplink_ports) and
3188 $portinfo['remote_object_id'] != '' and
3189 $portinfo['remote_name'] != ''
3190 )
3191 $upstream_config[$portinfo['remote_object_id']][$portinfo['remote_name']] = $uplink_ports[$portinfo['name']];
3192 // Note that when current object has several Port records inder same name
3193 // (but with unique IIF-OIF pair), these ports can be Link'ed to different
3194 // remote objects (using different media types, perhaps). Such a case can
3195 // be considered as normal, and each remote object will show up on the
3196 // task list (with its actual remote port name, of course).
3197 foreach ($upstream_config as $remote_object_id => $remote_ports)
3198 saveDownlinksReverb ($remote_object_id, $remote_ports);
3199}
3200
76452d15
DO
3201function detectVLANSwitchQueue ($vswitch)
3202{
3203 if ($vswitch['out_of_sync'] == 'no')
3204 return 'done';
3205 switch ($vswitch['last_errno'])
3206 {
3207 case E_8021Q_NOERROR:
37cb9e18 3208 if ($vswitch['last_change_age_seconds'] > getConfigVar ('8021Q_DEPLOY_MAXAGE'))
611b5e46 3209 return 'sync_ready';
37cb9e18 3210 elseif ($vswitch['last_change_age_seconds'] < getConfigVar ('8021Q_DEPLOY_MINAGE'))
611b5e46 3211 return 'sync_aging';
37cb9e18 3212 else
611b5e46 3213 return 'sync_ready';
76452d15 3214 case E_8021Q_VERSION_CONFLICT:
37cb9e18 3215 if ($vswitch['last_error_age_seconds'] < getConfigVar ('8021Q_DEPLOY_RETRY'))
611b5e46 3216 return 'resync_aging';
37cb9e18 3217 else
611b5e46 3218 return 'resync_ready';
76452d15
DO
3219 case E_8021Q_PULL_REMOTE_ERROR:
3220 case E_8021Q_PUSH_REMOTE_ERROR:
3221 return 'failed';
3222 case E_8021Q_SYNC_DISABLED:
3223 return 'disabled';
3224 }
3225 return '';
3226}
3227
37cb9e18
DO
3228function get8021QDeployQueues()
3229{
611b5e46
DO
3230 global $dqtitle;
3231 $ret = array();
3232 foreach (array_keys ($dqtitle) as $qcode)
3233 $ret[$qcode] = array();
37cb9e18
DO
3234 foreach (getVLANSwitches() as $object_id)
3235 {
3236 $vswitch = getVLANSwitchInfo ($object_id);
3237 if ('' != $qcode = detectVLANSwitchQueue ($vswitch))
3238 $ret[$qcode][] = $vswitch;
3239 }
3240 return $ret;
3241}
3242
f29d93e1
DO
3243function acceptable8021QConfig ($port)
3244{
3245 switch ($port['mode'])
3246 {
3247 case 'trunk':
3248 return TRUE;
3249 case 'access':
3250 if
3251 (
3252 count ($port['allowed']) == 1 and
3253 in_array ($port['native'], $port['allowed'])
3254 )
3255 return TRUE;
3256 // fall through
3257 default:
3258 return FALSE;
3259 }
3260}
3261
bb2024b9
DO
3262function authorize8021QChangeRequests ($before, $changes)
3263{
3264 $ret = array();
3265 foreach ($changes as $pn => $change)
3266 {
3267 $annex = array();
3268 foreach (array_diff ($change['allowed'], $before[$pn]['allowed']) as $added_id)
3269 $annex[] = array ('tag' => '$tovlan_' . $added_id);
3270 foreach (array_diff ($before[$pn]['allowed'], $change['allowed']) as $removed_id)
3271 $annex[] = array ('tag' => '$fromvlan_' . $removed_id);
0118be79 3272 if (!count ($annex) or permitted (NULL, NULL, NULL, $annex))
bb2024b9
DO
3273 $ret[$pn] = $change;
3274 }
3275 return $ret;
3276}
3277
e9d357e1
DO
3278function formatPortIIFOIF ($port)
3279{
3280 $ret = '';
3281 if ($port['iif_id'] != 1)
3282 $ret .= $port['iif_name'] . '/';
3283 $ret .= $port['oif_name'];
3284 return $ret;
3285}
3286
7d0438a5
DO
3287function compareDecomposedPortNames ($porta, $portb)
3288{
3289 if (0 != $cmp = strcmp ($porta['prefix'], $portb['prefix']))
3290 return $cmp;
3291 if ($porta['numidx'] != $portb['numidx'])
3292 return $porta['numidx'] - $portb['numidx'];
3293 // Below assumes both arrays be indexed from 0 onwards.
3294 for ($i = 0; $i < $porta['numidx']; $i++)
3295 if ($porta['index'][$i] != $portb['index'][$i])
3296 return $porta['index'][$i] - $portb['index'][$i];
3297 return 0;
3298}
3299
3300// Sort provided port list in a way based on natural. For example,
3301// switches can have ports:
3302// * fa0/1~48, gi0/1~4 (in this case 'gi' should come after 'fa'
3303// * fa1, gi0/1~48, te1/49~50 (type matters, then index)
3304// * gi5/1~3, te5/4~5 (here index matters more, than type)
3305// This implementation makes port type (prefix) matter for all
3306// interfaces, which have less, than 2 indices, but for other ports
3307// their indices matter more, than type (unless there is a clash
3308// of indices).
3309function sortPortList ($plist)
3310{
3311 $ret = array();
3312 $seen = array();
3313 $intersects = FALSE;
3314 $prefix_re = '/^([^0-9]+)[0-9].*$/';
3315 foreach (array_keys ($plist) as $pn)
3316 {
3317 $numbers = preg_split ('/[^0-9]+/', $pn, -1, PREG_SPLIT_NO_EMPTY);
3318 $ret[$pn] = array
3319 (
3320 'prefix' => '',
3321 'numidx' => count ($numbers),
3322 'index' => $numbers,
3323 );
3324 if ($ret[$pn]['numidx'] <= 1)
3325 $ret[$pn]['prefix'] = preg_replace ($prefix_re, '\\1', $pn);
3326 elseif (!$intersects)
3327 {
3328 $coord = implode ('-', $numbers);
3329 if (array_key_exists ($coord, $seen))
3330 $intersects = TRUE;
3331 $seen[$coord] = TRUE;
3332 }
3333 }
3334 unset ($seen);
3335 if ($intersects)
3336 foreach (array_keys ($ret) as $pn)
3337 if ($ret[$pn]['numidx'] > 1)
3338 $ret[$pn]['prefix'] = preg_replace ($prefix_re, '\\1', $pn);
3339 uasort ($ret, 'compareDecomposedPortNames');
3340 foreach (array_keys ($ret) as $pn)
3341 $ret[$pn] = $plist[$pn];
3342 return $ret;
3343}
3344
e673ee24 3345?>