r1943 + further work on ticket:23
[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
27// Objects of some types should be explicitly shown as
28// anonymous (labelless). This function is a single place where the
29// decision about displayed name is made.
30function displayedName ($objectData)
31{
32 if ($objectData['name'] != '')
33 return $objectData['name'];
9c0b0016 34 elseif (in_array ($objectData['objtype_id'], explode (',', getConfigVar ('NAMEFUL_OBJTYPES'))))
a0ec6295 35 return "ANONYMOUS " . $objectData['objtype_name'];
e673ee24 36 else
a0ec6295 37 return "[${objectData['objtype_name']}]";
e673ee24
DO
38}
39
40// This function finds height of solid rectangle of atoms, which are all
41// assigned to the same object. Rectangle base is defined by specified
42// template.
43function rectHeight ($rackData, $startRow, $template_idx)
44{
45 $height = 0;
46 // The first met object_id is used to match all the folowing IDs.
47 $object_id = 0;
48 global $template;
49 do
50 {
51 for ($locidx = 0; $locidx < 3; $locidx++)
52 {
53 // At least one value in template is TRUE, but the following block
54 // can meet 'skipped' atoms. Let's ensure we have something after processing
55 // the first row.
56 if ($template[$template_idx][$locidx])
57 {
58 if (isset ($rackData[$startRow - $height][$locidx]['skipped']))
59 break 2;
93e02204
DO
60 if (isset ($rackData[$startRow - $height][$locidx]['rowspan']))
61 break 2;
62 if (isset ($rackData[$startRow - $height][$locidx]['colspan']))
63 break 2;
e673ee24
DO
64 if ($rackData[$startRow - $height][$locidx]['state'] != 'T')
65 break 2;
66 if ($object_id == 0)
67 $object_id = $rackData[$startRow - $height][$locidx]['object_id'];
68 if ($object_id != $rackData[$startRow - $height][$locidx]['object_id'])
69 break 2;
70 }
71 }
72 // If the first row can't offer anything, bail out.
73 if ($height == 0 and $object_id == 0)
74 break;
75 $height++;
76 }
77 while ($startRow - $height > 0);
93e02204
DO
78# echo "for startRow==${startRow} and template==(" . ($template[$template_idx][0] ? 'T' : 'F');
79# echo ', ' . ($template[$template_idx][1] ? 'T' : 'F') . ', ' . ($template[$template_idx][2] ? 'T' : 'F');
80# echo ") height==${height}<br>\n";
e673ee24
DO
81 return $height;
82}
83
84// This function marks atoms to be avoided by rectHeight() and assigns rowspan/colspan
85// attributes.
86function markSpan (&$rackData, $startRow, $maxheight, $template_idx)
87{
88 global $template, $templateWidth;
89 $colspan = 0;
90 for ($height = 0; $height < $maxheight; $height++)
91 {
92 for ($locidx = 0; $locidx < 3; $locidx++)
93 {
94 if ($template[$template_idx][$locidx])
95 {
96 // Add colspan/rowspan to the first row met and mark the following ones to skip.
93e02204
DO
97 // Explicitly show even single-cell spanned atoms, because rectHeight()
98 // is expeciting this data for correct calculation.
e673ee24
DO
99 if ($colspan != 0)
100 $rackData[$startRow - $height][$locidx]['skipped'] = TRUE;
101 else
102 {
103 $colspan = $templateWidth[$template_idx];
93e02204 104 if ($colspan >= 1)
e673ee24 105 $rackData[$startRow - $height][$locidx]['colspan'] = $colspan;
93e02204 106 if ($maxheight >= 1)
e673ee24
DO
107 $rackData[$startRow - $height][$locidx]['rowspan'] = $maxheight;
108 }
109 }
110 }
111 }
112 return;
113}
114
93e02204
DO
115// This function sets rowspan/solspan/skipped atom attributes for renderRack()
116// What we actually have to do is to find _all_ possible rectangles for each unit
117// and then select the widest of those with the maximal square.
e673ee24
DO
118function markAllSpans (&$rackData = NULL)
119{
120 if ($rackData == NULL)
121 {
61e269b5 122 showError ('Invalid rackData', __FUNCTION__);
e673ee24
DO
123 return;
124 }
125 for ($i = $rackData['height']; $i > 0; $i--)
93e02204
DO
126 while (markBestSpan ($rackData, $i));
127}
128
129// Calculate height of 6 possible span templates (array is presorted by width
130// descending) and mark the best (if any).
131function markBestSpan (&$rackData, $i)
132{
133 global $template, $templateWidth;
134 for ($j = 0; $j < 6; $j++)
e673ee24 135 {
93e02204
DO
136 $height[$j] = rectHeight ($rackData, $i, $j);
137 $square[$j] = $height[$j] * $templateWidth[$j];
138 }
139 // find the widest rectangle of those with maximal height
140 $maxsquare = max ($square);
141 if (!$maxsquare)
142 return FALSE;
143 $best_template_index = 0;
144 for ($j = 0; $j < 6; $j++)
145 if ($square[$j] == $maxsquare)
e673ee24 146 {
93e02204
DO
147 $best_template_index = $j;
148 $bestheight = $height[$j];
149 break;
e673ee24 150 }
93e02204
DO
151 // distribute span marks
152 markSpan ($rackData, $i, $bestheight, $best_template_index);
153 return TRUE;
e673ee24
DO
154}
155
156function delRow ($row_id = 0)
157{
158 if ($row_id == 0)
159 {
61e269b5 160 showError ('Not all required args are present.', __FUNCTION__);
e673ee24
DO
161 return;
162 }
163 if (!isset ($_REQUEST['confirmed']) || $_REQUEST['confirmed'] != 'true')
164 {
165 echo "Press <a href='?op=del_row&row_id=${row_id}&confirmed=true'>here</a> to confirm rack row deletion.";
166 return;
167 }
168 global $dbxlink;
169 echo 'Deleting rack row information: ';
170 $result = $dbxlink->query ("update RackRow set deleted = 'yes' where id=${row_id} limit 1");
171 if ($result->rowCount() != 1)
172 {
61e269b5 173 showError ('Marked ' . $result.rowCount() . ' rows as deleted, but expected 1', __FUNCTION__);
e673ee24
DO
174 return;
175 }
176 echo 'OK<br>';
177 recordHistory ('RackRow', "id = ${row_id}");
178 echo "Information was deleted. You may return to <a href='?op=list_rows&editmode=on'>rack row list</a>.";
179}
180
181function delRack ($rack_id = 0)
182{
183 if ($rack_id == 0)
184 {
61e269b5 185 showError ('Not all required args are present.', __FUNCTION__);
e673ee24
DO
186 return;
187 }
188 if (!isset ($_REQUEST['confirmed']) || $_REQUEST['confirmed'] != 'true')
189 {
190 echo "Press <a href='?op=del_rack&rack_id=${rack_id}&confirmed=true'>here</a> to confirm rack deletion.";
191 return;
192 }
193 global $dbxlink;
194 echo 'Deleting rack information: ';
195 $result = $dbxlink->query ("update Rack set deleted = 'yes' where id=${rack_id} limit 1");
196 if ($result->rowCount() != 1)
197 {
61e269b5 198 showError ('Marked ' . $result.rowCount() . ' rows as deleted, but expected 1', __FUNCTION__);
e673ee24
DO
199 return;
200 }
201 echo 'OK<br>';
202 recordHistory ('Rack', "id = ${rack_id}");
203 echo "Information was deleted. You may return to <a href='?op=list_racks&editmode=on'>rack list</a>.";
204}
205
206function delObject ($object_id = 0)
207{
208 if ($object_id == 0)
209 {
61e269b5 210 showError ('Not all required args are present.', __FUNCTION__);
e673ee24
DO
211 return;
212 }
213 if (!isset ($_REQUEST['confirmed']) || $_REQUEST['confirmed'] != 'true')
214 {
215 echo "Press <a href='?op=del_object&object_id=${object_id}&confirmed=true'>here</a> to confirm object deletion.";
216 return;
217 }
218 global $dbxlink;
219 echo 'Deleting object information: ';
220 $result = $dbxlink->query ("update RackObject set deleted = 'yes' where id=${object_id} limit 1");
221 if ($result->rowCount() != 1)
222 {
61e269b5 223 showError ('Marked ' . $result.rowCount() . ' rows as deleted, but expected 1', __FUNCTION__);
e673ee24
DO
224 return;
225 }
226 echo 'OK<br>';
227 recordHistory ('RackObject', "id = ${object_id}");
228 echo "Information was deleted. You may return to <a href='?op=list_objects&editmode=on'>object list</a>.";
229}
230
231// We can mount 'F' atoms and unmount our own 'T' atoms.
232function applyObjectMountMask (&$rackData, $object_id)
233{
234 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
235 for ($locidx = 0; $locidx < 3; $locidx++)
236 switch ($rackData[$unit_no][$locidx]['state'])
237 {
238 case 'F':
239 $rackData[$unit_no][$locidx]['enabled'] = TRUE;
240 break;
241 case 'T':
242 $rackData[$unit_no][$locidx]['enabled'] = ($rackData[$unit_no][$locidx]['object_id'] == $object_id);
243 break;
244 default:
245 $rackData[$unit_no][$locidx]['enabled'] = FALSE;
246 }
247}
248
249// Design change means transition between 'F' and 'A' and back.
250function applyRackDesignMask (&$rackData)
251{
252 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
253 for ($locidx = 0; $locidx < 3; $locidx++)
254 switch ($rackData[$unit_no][$locidx]['state'])
255 {
256 case 'F':
257 case 'A':
258 $rackData[$unit_no][$locidx]['enabled'] = TRUE;
259 break;
260 default:
261 $rackData[$unit_no][$locidx]['enabled'] = FALSE;
262 }
263}
264
265// The same for 'F' and 'U'.
266function applyRackProblemMask (&$rackData)
267{
268 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
269 for ($locidx = 0; $locidx < 3; $locidx++)
270 switch ($rackData[$unit_no][$locidx]['state'])
271 {
272 case 'F':
273 case 'U':
274 $rackData[$unit_no][$locidx]['enabled'] = TRUE;
275 break;
276 default:
277 $rackData[$unit_no][$locidx]['enabled'] = FALSE;
278 }
279}
280
281// This mask should allow toggling 'T' and 'W' on object's rackspace.
282function applyObjectProblemMask (&$rackData)
283{
284 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
285 for ($locidx = 0; $locidx < 3; $locidx++)
286 switch ($rackData[$unit_no][$locidx]['state'])
287 {
288 case 'T':
289 case 'W':
290 $rackData[$unit_no][$locidx]['enabled'] = ($rackData[$unit_no][$locidx]['object_id'] == $object_id);
291 break;
292 default:
293 $rackData[$unit_no][$locidx]['enabled'] = FALSE;
294 }
295}
296
297// This function highlights specified object (and removes previous highlight).
298function highlightObject (&$rackData, $object_id)
299{
300 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
301 for ($locidx = 0; $locidx < 3; $locidx++)
302 if
303 (
304 $rackData[$unit_no][$locidx]['state'] == 'T' and
305 $rackData[$unit_no][$locidx]['object_id'] == $object_id
306 )
307 $rackData[$unit_no][$locidx]['hl'] = 'h';
308 else
309 unset ($rackData[$unit_no][$locidx]['hl']);
310}
311
312// This function marks atoms to selected or not depending on their current state.
313function markupAtomGrid (&$data, $checked_state)
314{
315 for ($unit_no = $data['height']; $unit_no > 0; $unit_no--)
316 for ($locidx = 0; $locidx < 3; $locidx++)
317 {
318 if (!($data[$unit_no][$locidx]['enabled'] === TRUE))
319 continue;
320 if ($data[$unit_no][$locidx]['state'] == $checked_state)
321 $data[$unit_no][$locidx]['checked'] = ' checked';
322 else
323 $data[$unit_no][$locidx]['checked'] = '';
324 }
325}
326
327// This function is almost a clone of processGridForm(), but doesn't save anything to database
328// Return value is the changed rack data.
329// Here we assume that correct filter has already been applied, so we just
330// set or unset checkbox inputs w/o changing atom state.
331function mergeGridFormToRack (&$rackData)
332{
333 $rack_id = $rackData['id'];
334 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
335 for ($locidx = 0; $locidx < 3; $locidx++)
336 {
337 if ($rackData[$unit_no][$locidx]['enabled'] != TRUE)
338 continue;
339 $inputname = "atom_${rack_id}_${unit_no}_${locidx}";
340 if (isset ($_REQUEST[$inputname]) and $_REQUEST[$inputname] == 'on')
341 $rackData[$unit_no][$locidx]['checked'] = ' checked';
342 else
343 $rackData[$unit_no][$locidx]['checked'] = '';
344 }
345}
346
347function binMaskFromDec ($maskL)
348{
349 $binmask=0;
350 for ($i=0; $i<$maskL; $i++)
351 {
352 $binmask*=2;
353 $binmask+=1;
354 }
355 for ($i=$maskL; $i<32; $i++)
356 {
357 $binmask*=2;
358 }
359 return $binmask;
360}
361
362function binInvMaskFromDec ($maskL)
363{
364 $binmask=0;
365 for ($i=0; $i<$maskL; $i++)
366 {
367 $binmask*=2;
368 }
369 for ($i=$maskL; $i<32; $i++)
370 {
371 $binmask*=2;
372 $binmask+=1;
373 }
374 return $binmask;
375}
376
fa05e3de 377function addRange ($range='', $name='', $is_bcast = FALSE, $taglist = array())
e673ee24 378{
2a201216
DY
379 // $range is in x.x.x.x/x format, split into ip/mask vars
380 $rangeArray = explode('/', $range);
6e8868cc
DO
381 if (count ($rangeArray) != 2)
382 return "Invalid IP subnet '${range}'";
2a201216
DY
383 $ip = $rangeArray[0];
384 $mask = $rangeArray[1];
385
c87fd3fe
DO
386 if (empty ($ip) or empty ($mask))
387 return "Invalid IP subnet '${range}'";
e673ee24
DO
388 $ipL = ip2long($ip);
389 $maskL = ip2long($mask);
390 if ($ipL == -1 || $ipL === FALSE)
391 return 'Bad ip address';
392 if ($mask < 32 && $mask > 0)
393 $maskL = $mask;
394 else
395 {
396 $maskB = decbin($maskL);
397 if (strlen($maskB)!=32)
398 return 'Bad mask';
399 $ones=0;
400 $zeroes=FALSE;
401 foreach( str_split ($maskB) as $digit)
402 {
403 if ($digit == '0')
404 $zeroes = TRUE;
405 if ($digit == '1')
406 {
407 $ones++;
408 if ($zeroes == TRUE)
409 return 'Bad mask';
410 }
411 }
412 $maskL = $ones;
413 }
414 $binmask = binMaskFromDec($maskL);
415 $ipL = $ipL & $binmask;
416
417 $query =
418 "select ".
419 "id, ip, mask, name ".
420 "from IPRanges ";
421
422
fa05e3de 423 $result = useSelectBlade ($query);
e673ee24
DO
424
425 while ($row = $result->fetch (PDO::FETCH_ASSOC))
426 {
427 $otherip = $row['ip'];
428 $othermask = binMaskFromDec($row['mask']);
429// echo "checking $otherip & $othermask ".($otherip & $othermask)." == $ipL & $othermask ".($ipL & $othermask)." ".decbin($otherip)." ".decbin($othermask)." ".decbin($otherip & $othermask)." ".decbin($ipL)." ".decbin($othermask)." ".decbin($ipL & $othermask)."\n";
430// echo "checking $otherip & $binmask ".($otherip & $binmask)." == $ipL & $binmask ".($ipL & $binmask)." ".decbin($otherip)." ".decbin($binmask)." ".decbin($otherip & $binmask)." ".decbin($ipL)." ".decbin($binmask)." ".decbin($ipL & $binmask)."\n";
431// echo "\n";
432// flush();
433 if (($otherip & $othermask) == ($ipL & $othermask))
434 return "This subnet intersects with ".long2ip($row['ip'])."/${row['mask']}";
435 if (($otherip & $binmask) == ($ipL & $binmask))
436 return "This subnet intersects with ".long2ip($row['ip'])."/${row['mask']}";
437 }
438 $result->closeCursor();
fa05e3de
DO
439 unset ($result);
440 $result = useInsertBlade
441 (
442 'IPRanges',
443 array
444 (
445 'ip' => sprintf ('%u', $ipL),
446 'mask' => "'${maskL}'",
447 'name' => "'${name}'"
448 )
449 );
2dee289e
DO
450
451 if ($is_bcast and $maskL < 31)
452 {
453 $network_addr = long2ip ($ipL);
454 $broadcast_addr = long2ip ($ipL | binInvMaskFromDec ($maskL));
455 updateAddress ($network_addr, 'network', 'yes');
456 updateAddress ($broadcast_addr, 'broadcast', 'yes');
457 }
fa05e3de
DO
458 if (!count ($taglist))
459 return '';
460 if (($result = useSelectBlade ('select last_insert_id()')) == NULL)
461 return 'Query #3 failed in ' . __FUNCTION__;
462 $row = $result->fetch (PDO::FETCH_NUM);
463 $netid = $row[0];
850a12ea
DO
464 $result->closeCursor();
465 unset ($result);
fa05e3de
DO
466 $errcount = 0;
467 foreach ($taglist as $tag_id)
468 if (useInsertBlade
469 (
470 'TagStorage',
471 array
472 (
473 'target_realm' => "'ipv4net'",
474 'target_id' => $netid,
475 'tag_id' => $tag_id
476 )
477 ) == FALSE)
478 $errcount++;
479 if (!$errcount)
480 return '';
481 else
482 return "Experienced ${errcount} errors adding tags for the network";
e673ee24
DO
483}
484
485function getIPRange ($id = 0)
486{
487 global $dbxlink;
488 $query =
489 "select ".
490 "id as IPRanges_id, ".
491 "INET_NTOA(ip) as IPRanges_ip, ".
e673ee24
DO
492 "mask as IPRanges_mask, ".
493 "name as IPRanges_name ".
494 "from IPRanges ".
495 "where id = '$id'";
602663f4 496 $result = useSelectBlade ($query);
5c43a978 497 $ret = array();
55cc3e4e
DO
498 $row = $result->fetch (PDO::FETCH_ASSOC);
499 if ($row == NULL)
500 return $ret;
501 $ret['id'] = $row['IPRanges_id'];
502 $ret['ip'] = $row['IPRanges_ip'];
7e039e88 503 $ret['ip_bin'] = ip2long ($row['IPRanges_ip']);
55cc3e4e
DO
504 $ret['mask_bin'] = binMaskFromDec($row['IPRanges_mask']);
505 $ret['mask_bin_inv'] = binInvMaskFromDec($row['IPRanges_mask']);
506 $ret['name'] = $row['IPRanges_name'];
507 $ret['mask'] = $row['IPRanges_mask'];
508 $ret['addrlist'] = array();
55cc3e4e 509 $result->closeCursor();
602663f4 510 unset ($result);
7e039e88
DO
511 // We risk losing some significant bits in an unsigned 32bit integer,
512 // unless it is converted to a string.
513 $db_first = "'" . sprintf ('%u', 0x00000000 + $ret['ip_bin'] & $ret['mask_bin']) . "'";
514 $db_last = "'" . sprintf ('%u', 0x00000000 + $ret['ip_bin'] | ($ret['mask_bin_inv'])) . "'";
5c43a978
DO
515
516 // Don't try to build up the whole structure in a single pass. Request
517 // the list of user comments and reservations and merge allocations in
518 // at a latter point.
55cc3e4e 519 $query =
7e039e88
DO
520 "select INET_NTOA(ip) as ip, name, reserved from IPAddress " .
521 "where ip between ${db_first} and ${db_last} " .
5c43a978 522 "and (reserved = 'yes' or name != '')";
602663f4
DO
523 $result = $dbxlink->query ($query);
524 while ($row = $result->fetch (PDO::FETCH_ASSOC))
55cc3e4e 525 {
7e039e88
DO
526 $ip_bin = ip2long ($row['ip']);
527 $ret['addrlist'][$ip_bin] = $row;
5c43a978
DO
528 $tmp = array();
529 foreach (array ('ip', 'name', 'reserved') as $cname)
530 $tmp[$cname] = $row[$cname];
531 $tmp['references'] = array();
602663f4
DO
532 $tmp['lbrefs'] = array();
533 $tmp['rsrefs'] = array();
7e039e88 534 $ret['addrlist'][$ip_bin] = $tmp;
5c43a978 535 }
602663f4
DO
536 $result->closeCursor();
537 unset ($result);
e673ee24 538
5c43a978 539 $query =
dda31a62
DO
540 "select INET_NTOA(ipb.ip) as ip, ro.id as object_id, " .
541 "ro.name as object_name, ipb.name, ipb.type, objtype_id, " .
542 "dict_value as objtype_name from " .
5c43a978 543 "IPBonds as ipb inner join RackObject as ro on ipb.object_id = ro.id " .
dda31a62 544 "left join Dictionary on objtype_id=dict_key natural join Chapter " .
7e039e88 545 "where ip between ${db_first} and ${db_last} " .
dda31a62 546 "and chapter_name = 'RackObjectType'" .
5c43a978 547 "order by ipb.type, object_name";
602663f4
DO
548 $result = useSelectBlade ($query);
549 while ($row = $result->fetch (PDO::FETCH_ASSOC))
5c43a978 550 {
7e039e88
DO
551 $ip_bin = ip2long ($row['ip']);
552 if (!isset ($ret['addrlist'][$ip_bin]))
55cc3e4e 553 {
7e039e88
DO
554 $ret['addrlist'][$ip_bin] = array();
555 $ret['addrlist'][$ip_bin]['ip'] = $row['ip'];
556 $ret['addrlist'][$ip_bin]['name'] = '';
557 $ret['addrlist'][$ip_bin]['reserved'] = 'no';
558 $ret['addrlist'][$ip_bin]['references'] = array();
602663f4
DO
559 $ret['addrlist'][$ip_bin]['lbrefs'] = array();
560 $ret['addrlist'][$ip_bin]['rsrefs'] = array();
e673ee24 561 }
5c43a978 562 $tmp = array();
dda31a62 563 foreach (array ('object_id', 'type', 'name') as $cname)
5c43a978 564 $tmp[$cname] = $row[$cname];
dda31a62
DO
565 $quasiobject['name'] = $row['object_name'];
566 $quasiobject['objtype_id'] = $row['objtype_id'];
567 $quasiobject['objtype_name'] = $row['objtype_name'];
568 $tmp['object_name'] = displayedName ($quasiobject);
7e039e88 569 $ret['addrlist'][$ip_bin]['references'][] = $tmp;
e673ee24 570 }
602663f4
DO
571 $result->closeCursor();
572 unset ($result);
573
574 $query = "select vs_id, inet_ntoa(vip) as ip, vport, proto, " .
575 "object_id, objtype_id, ro.name, dict_value as objtype_name from " .
576 "IPVirtualService as vs inner join IPLoadBalancer as lb on vs.id = lb.vs_id " .
577 "inner join RackObject as ro on lb.object_id = ro.id " .
578 "left join Dictionary on objtype_id=dict_key " .
579 "natural join Chapter " .
580 "where vip between ${db_first} and ${db_last} " .
581 "and chapter_name = 'RackObjectType'" .
582 "order by vport, proto, ro.name, object_id";
583 $result = useSelectBlade ($query);
584 while ($row = $result->fetch (PDO::FETCH_ASSOC))
585 {
586 $ip_bin = ip2long ($row['ip']);
587 if (!isset ($ret['addrlist'][$ip_bin]))
588 {
589 $ret['addrlist'][$ip_bin] = array();
590 $ret['addrlist'][$ip_bin]['ip'] = $row['ip'];
591 $ret['addrlist'][$ip_bin]['name'] = '';
592 $ret['addrlist'][$ip_bin]['reserved'] = 'no';
593 $ret['addrlist'][$ip_bin]['references'] = array();
594 $ret['addrlist'][$ip_bin]['lbrefs'] = array();
595 $ret['addrlist'][$ip_bin]['rsrefs'] = array();
596 }
597 $tmp = $qbject = array();
598 foreach (array ('object_id', 'vport', 'proto', 'vs_id') as $cname)
599 $tmp[$cname] = $row[$cname];
600 foreach (array ('name', 'objtype_id', 'objtype_name') as $cname)
601 $qobject[$cname] = $row[$cname];
602 $tmp['object_name'] = displayedName ($qobject);
603 $ret['addrlist'][$ip_bin]['lbrefs'][] = $tmp;
604 }
605 $result->closeCursor();
606 unset ($result);
607
608 $query = "select inet_ntoa(rsip) as ip, rsport, rspool_id, rsp.name as rspool_name from " .
609 "IPRealServer as rs inner join IPRSPool as rsp on rs.rspool_id = rsp.id " .
610 "where rsip between ${db_first} and ${db_last} " .
611 "order by ip, rsport, rspool_id";
612 $result = useSelectBlade ($query);
613 while ($row = $result->fetch (PDO::FETCH_ASSOC))
614 {
615 $ip_bin = ip2long ($row['ip']);
616 if (!isset ($ret['addrlist'][$ip_bin]))
617 {
618 $ret['addrlist'][$ip_bin] = array();
619 $ret['addrlist'][$ip_bin]['ip'] = $row['ip'];
620 $ret['addrlist'][$ip_bin]['name'] = '';
621 $ret['addrlist'][$ip_bin]['reserved'] = 'no';
622 $ret['addrlist'][$ip_bin]['references'] = array();
623 $ret['addrlist'][$ip_bin]['lbrefs'] = array();
624 $ret['addrlist'][$ip_bin]['rsrefs'] = array();
625 }
626 $tmp = array();
627 foreach (array ('rspool_id', 'rsport', 'rspool_name') as $cname)
628 $tmp[$cname] = $row[$cname];
629 $ret['addrlist'][$ip_bin]['rsrefs'][] = $tmp;
630 }
5c43a978 631
e673ee24
DO
632 return $ret;
633}
634
dda31a62
DO
635// Don't require any records in IPAddress, but if there is one,
636// merge the data between getting allocation list. Collect enough data
637// to call displayedName() ourselves.
b4c1ef87 638function getIPAddress ($ip = 0)
e673ee24 639{
a25b988e
DO
640 $ret = array
641 (
642 'bonds' => array(),
643 'outpf' => array(),
644 'inpf' => array(),
645 'vslist' => array(),
646 'rslist' => array(),
647 'exists' => 0,
648 'name' => '',
649 'reserved' => 'no'
650 );
59bebe2b 651 $query =
e673ee24 652 "select ".
dda31a62 653 "name, reserved ".
e673ee24 654 "from IPAddress ".
dda31a62 655 "where ip = INET_ATON('$ip') and (reserved = 'yes' or name != '')";
b4c1ef87 656 $result = useSelectBlade ($query);
59bebe2b 657 if ($row = $result->fetch (PDO::FETCH_ASSOC))
e673ee24 658 {
959c4f4c 659 $ret['exists'] = 1;
959c4f4c
DO
660 $ret['name'] = $row['name'];
661 $ret['reserved'] = $row['reserved'];
e673ee24 662 }
59bebe2b
DO
663 $result->closeCursor();
664 unset ($result);
e673ee24 665
59bebe2b 666 $query =
dda31a62
DO
667 "select ".
668 "IPBonds.object_id as object_id, ".
669 "IPBonds.name as name, ".
670 "IPBonds.type as type, ".
671 "objtype_id, dict_value as objtype_name, " .
672 "RackObject.name as object_name ".
673 "from IPBonds join RackObject on IPBonds.object_id=RackObject.id ".
674 "left join Dictionary on objtype_id=dict_key natural join Chapter " .
675 "where IPBonds.ip=INET_ATON('$ip') ".
676 "and chapter_name = 'RackObjectType' " .
677 "order by RackObject.id, IPBonds.name";
b4c1ef87 678 $result = useSelectBlade ($query);
a25b988e 679 $count = 0;
59bebe2b 680 while ($row = $result->fetch (PDO::FETCH_ASSOC))
e673ee24 681 {
dda31a62
DO
682 $ret['bonds'][$count]['object_id'] = $row['object_id'];
683 $ret['bonds'][$count]['name'] = $row['name'];
684 $ret['bonds'][$count]['type'] = $row['type'];
685 $qo = array();
686 $qo['name'] = $row['object_name'];
687 $qo['objtype_id'] = $row['objtype_id'];
688 $qo['objtype_name'] = $row['objtype_name'];
689 $ret['bonds'][$count]['object_name'] = displayedName ($qo);
690 $count++;
691 $ret['exists'] = 1;
e673ee24 692 }
59bebe2b
DO
693 $result->closeCursor();
694 unset ($result);
695
5fe1ed76 696 $query = "select id, vport, proto, name from IPVirtualService where vip = inet_aton('${ip}')";
b4c1ef87 697 $result = useSelectBlade ($query);
59bebe2b 698 while ($row = $result->fetch (PDO::FETCH_ASSOC))
5fe1ed76
DO
699 {
700 $new = $row;
701 $new['vip'] = $ip;
702 $ret['vslist'][] = $new;
703 }
704 $result->closeCursor();
705 unset ($result);
706
707 $query = "select inservice, rsport, IPRSPool.id as pool_id, IPRSPool.name as poolname from " .
708 "IPRealServer inner join IPRSPool on rspool_id = IPRSPool.id " .
709 "where rsip = inet_aton('${ip}')";
b4c1ef87 710 $result = useSelectBlade ($query);
5fe1ed76
DO
711 while ($row = $result->fetch (PDO::FETCH_ASSOC))
712 {
713 $new = $row;
714 $new['rsip'] = $ip;
715 $ret['rslist'][] = $new;
716 }
59bebe2b
DO
717 $result->closeCursor();
718 unset ($result);
e673ee24 719
a25b988e
DO
720 $query =
721 "select ".
722 "proto, ".
723 "INET_NTOA(localip) as localip, ".
724 "localport, ".
725 "remoteport, ".
726 "PortForwarding.object_id as object_id, ".
727 "RackObject.name as object_name, ".
728 "description ".
729 "from ((PortForwarding join IPBonds on remoteip=IPBonds.ip) join RackObject on PortForwarding.object_id=RackObject.id) ".
730 "where remoteip = inet_aton ('${ip}') ".
731 "order by remoteip, remoteport, proto, localip, localport";
68225375 732 $result = useSelectBlade ($query);
a25b988e 733 $count = 0;
68225375
DO
734 while ($row = $result->fetch (PDO::FETCH_ASSOC))
735 {
a25b988e
DO
736 foreach (array ('proto', 'localport', 'localip', 'remoteip', 'object_id', 'object_name', 'description') as $cname)
737 $ret['inpf'][$count][$cname] = $row[$cname];
738 $count++;
68225375
DO
739 }
740 $result->closeCursor();
741 unset ($result);
742
e673ee24
DO
743 return $ret;
744}
745
b4c1ef87 746function bindIpToObject ($ip = '', $object_id = 0, $name = '', $type = '')
e673ee24
DO
747{
748 global $dbxlink;
749
b4c1ef87 750 $range = getRangeByIp ($ip);
e673ee24
DO
751 if (!$range)
752 return 'Non-existant ip address. Try adding IP range first';
753
20a92aa2
DO
754 $result = useInsertBlade
755 (
756 'IPBonds',
757 array
758 (
dda31a62 759 'ip' => "INET_ATON('$ip')",
20a92aa2
DO
760 'object_id' => "'${object_id}'",
761 'name' => "'${name}'",
762 'type' => "'${type}'"
763 )
764 );
b4c1ef87 765 return $result ? '' : (__FUNCTION__ . '(): useInsertBlade() failed');
e673ee24
DO
766}
767
768// This function looks up 'has_problems' flag for 'T' atoms
769// and modifies 'hl' key. May be, this should be better done
770// in getRackData(). We don't honour 'skipped' key, because
771// the function is also used for thumb creation.
772function markupObjectProblems (&$rackData)
773{
774 for ($i = $rackData['height']; $i > 0; $i--)
775 for ($locidx = 0; $locidx < 3; $locidx++)
776 if ($rackData[$i][$locidx]['state'] == 'T')
777 {
778 $object = getObjectInfo ($rackData[$i][$locidx]['object_id']);
779 if ($object['has_problems'] == 'yes')
780 {
781 // Object can be already highlighted.
782 if (isset ($rackData[$i][$locidx]['hl']))
783 $rackData[$i][$locidx]['hl'] = $rackData[$i][$locidx]['hl'] . 'w';
784 else
785 $rackData[$i][$locidx]['hl'] = 'w';
786 }
787 }
788}
789
790function search_cmpObj ($a, $b)
791{
792 return ($a['score'] > $b['score'] ? -1 : 1);
793}
794
795// This function performs search and then calculates score for each result.
796// Given previous search results in $objects argument, it adds new results
797// to the array and updates score for existing results, if it is greater than
798// existing score.
799function mergeSearchResults (&$objects, $terms, $fieldname)
800{
801 global $dbxlink;
802 $query =
803 "select name, label, asset_no, barcode, ro.id, dict_key as objtype_id, " .
804 "dict_value as objtype_name, asset_no from RackObject as ro inner join Dictionary " .
805 "on objtype_id = dict_key natural join Chapter where chapter_name = 'RackObjectType' and ";
806 $count = 0;
807 foreach (explode (' ', $terms) as $term)
808 {
809 if ($count) $query .= ' or ';
810 $query .= "${fieldname} like '%$term%'";
811 $count++;
812 }
ea5fc465 813 $result = useSelectBlade ($query);
e673ee24
DO
814// FIXME: this dead call was executed 4 times per 1 object search!
815// $typeList = getObjectTypeList();
816 $clist = array ('id', 'name', 'label', 'asset_no', 'barcode', 'objtype_id', 'objtype_name');
817 while ($row = $result->fetch(PDO::FETCH_ASSOC))
818 {
819 foreach ($clist as $cname)
820 $object[$cname] = $row[$cname];
821 $object['score'] = 0;
822 $object['dname'] = displayedName ($object);
823 unset ($object['objtype_id']);
824 foreach (explode (' ', $terms) as $term)
825 if (strstr ($object['name'], $term))
826 $object['score'] += 1;
827 unset ($object['name']);
828 if (!isset ($objects[$row['id']]))
829 $objects[$row['id']] = $object;
830 elseif ($objects[$row['id']]['score'] < $object['score'])
831 $objects[$row['id']]['score'] = $object['score'];
832 }
833 return $objects;
834}
835
ea5fc465 836function getObjectSearchResults ($terms)
e673ee24
DO
837{
838 $objects = array();
839 mergeSearchResults ($objects, $terms, 'name');
840 mergeSearchResults ($objects, $terms, 'label');
841 mergeSearchResults ($objects, $terms, 'asset_no');
842 mergeSearchResults ($objects, $terms, 'barcode');
843 if (count ($objects) == 1)
844 usort ($objects, 'search_cmpObj');
845 return $objects;
846}
847
848// This function removes all colons and dots from a string.
849function l2addressForDatabase ($string)
850{
851 if (empty ($string))
852 return 'NULL';
853 $pieces = explode (':', $string);
854 // This workaround is for SunOS ifconfig.
855 foreach ($pieces as &$byte)
856 if (strlen ($byte) == 1)
857 $byte = '0' . $byte;
858 // And this workaround is for PHP.
859 unset ($byte);
860 $string = implode ('', $pieces);
861 $pieces = explode ('.', $string);
862 $string = implode ('', $pieces);
863 $string = strtoupper ($string);
864 return "'$string'";
865}
866
867function l2addressFromDatabase ($string)
868{
869 switch (strlen ($string))
870 {
871 case 12: // Ethernet
872 case 16: // FireWire
873 $ret = implode (':', str_split ($string, 2));
874 break;
875 default:
876 $ret = $string;
877 break;
878 }
879 return $ret;
880}
881
882// The following 2 functions return previous and next rack IDs for
883// a given rack ID. The order of racks is the same as in renderRackspace()
884// or renderRow().
885function getPrevIDforRack ($row_id = 0, $rack_id = 0)
886{
887 if ($row_id <= 0 or $rack_id <= 0)
888 {
61e269b5 889 showError ('Invalid arguments passed', __FUNCTION__);
e673ee24
DO
890 return NULL;
891 }
892 $rackList = getRacksForRow ($row_id);
893 doubleLink ($rackList);
894 if (isset ($rackList[$rack_id]['prev_key']))
895 return $rackList[$rack_id]['prev_key'];
896 return NULL;
897}
898
899function getNextIDforRack ($row_id = 0, $rack_id = 0)
900{
901 if ($row_id <= 0 or $rack_id <= 0)
902 {
61e269b5 903 showError ('Invalid arguments passed', __FUNCTION__);
e673ee24
DO
904 return NULL;
905 }
906 $rackList = getRacksForRow ($row_id);
907 doubleLink ($rackList);
908 if (isset ($rackList[$rack_id]['next_key']))
909 return $rackList[$rack_id]['next_key'];
910 return NULL;
911}
912
913// This function finds previous and next array keys for each array key and
914// modifies its argument accordingly.
915function doubleLink (&$array)
916{
917 $prev_key = NULL;
918 foreach (array_keys ($array) as $key)
919 {
920 if ($prev_key)
921 {
922 $array[$key]['prev_key'] = $prev_key;
923 $array[$prev_key]['next_key'] = $key;
924 }
925 $prev_key = $key;
926 }
927}
928
929// After applying usort() to a rack list we will lose original array keys.
930// This function restores the keys so they are equal to rack IDs.
931function restoreRackIDs ($racks)
932{
933 $ret = array();
934 foreach ($racks as $rack)
935 $ret[$rack['id']] = $rack;
936 return $ret;
937}
938
939function sortTokenize ($a, $b)
940{
941 $aold='';
942 while ($a != $aold)
943 {
944 $aold=$a;
945 $a = ereg_replace('[^a-zA-Z0-9]',' ',$a);
946 $a = ereg_replace('([0-9])([a-zA-Z])','\\1 \\2',$a);
947 $a = ereg_replace('([a-zA-Z])([0-9])','\\1 \\2',$a);
948 }
949
950 $bold='';
951 while ($b != $bold)
952 {
953 $bold=$b;
954 $b = ereg_replace('[^a-zA-Z0-9]',' ',$b);
955 $b = ereg_replace('([0-9])([a-zA-Z])','\\1 \\2',$b);
956 $b = ereg_replace('([a-zA-Z])([0-9])','\\1 \\2',$b);
957 }
958
959
960
961 $ar = explode(' ', $a);
962 $br = explode(' ', $b);
963 for ($i=0; $i<count($ar) && $i<count($br); $i++)
964 {
965 $ret = 0;
966 if (is_numeric($ar[$i]) and is_numeric($br[$i]))
967 $ret = ($ar[$i]==$br[$i])?0:($ar[$i]<$br[$i]?-1:1);
968 else
969 $ret = strcasecmp($ar[$i], $br[$i]);
970 if ($ret != 0)
971 return $ret;
972 }
973 if ($i<count($ar))
974 return 1;
975 if ($i<count($br))
976 return -1;
977 return 0;
978}
979
980function sortByName ($a, $b)
981{
982 return sortTokenize($a['name'], $b['name']);
983}
984
6a3a37b2
DO
985function sortRacks ($a, $b)
986{
987 return sortTokenize($a['row_name'] . ': ' . $a['name'], $b['row_name'] . ': ' . $b['name']);
988}
989
e673ee24
DO
990function eq ($a, $b)
991{
992 return $a==$b;
993}
994
995function neq ($a, $b)
996{
997 return $a!=$b;
998}
999
1000function countRefsOfType ($refs, $type, $eq)
1001{
1002 $count=0;
1003 foreach ($refs as $ref)
1004 {
1005 if ($eq($ref['type'], $type))
1006 $count++;
1007 }
1008 return $count;
1009}
1010
1011function sortEmptyPorts ($a, $b)
1012{
1013 $objname_cmp = sortTokenize($a['Object_name'], $b['Object_name']);
1014 if ($objname_cmp == 0)
1015 {
1016 return sortTokenize($a['Port_name'], $b['Port_name']);
1017 }
1018 return $objname_cmp;
1019}
1020
1021function sortObjectAddressesAndNames ($a, $b)
1022{
1023 $objname_cmp = sortTokenize($a['object_name'], $b['object_name']);
1024 if ($objname_cmp == 0)
1025 {
79f22c3d
DO
1026 $name_a = (isset ($a['port_name'])) ? $a['port_name'] : '';
1027 $name_b = (isset ($b['port_name'])) ? $b['port_name'] : '';
1028 $objname_cmp = sortTokenize($name_a, $name_b);
e673ee24 1029 if ($objname_cmp == 0)
e673ee24 1030 sortTokenize($a['ip'], $b['ip']);
e673ee24
DO
1031 return $objname_cmp;
1032 }
1033 return $objname_cmp;
1034}
1035
1036
1037
1038function sortAddresses ($a, $b)
1039{
1040 $name_cmp = sortTokenize($a['name'], $b['name']);
1041 if ($name_cmp == 0)
1042 {
1043 return sortTokenize($a['ip'], $b['ip']);
1044 }
1045 return $name_cmp;
1046}
1047
1048// This function expands port compat list into a matrix.
1049function buildPortCompatMatrixFromList ($portTypeList, $portCompatList)
1050{
1051 $matrix = array();
1052 // Create type matrix and markup compatible types.
1053 foreach (array_keys ($portTypeList) as $type1)
1054 foreach (array_keys ($portTypeList) as $type2)
1055 $matrix[$type1][$type2] = FALSE;
1056 foreach ($portCompatList as $pair)
1057 $matrix[$pair['type1']][$pair['type2']] = TRUE;
1058 return $matrix;
1059}
1060
1061function newPortForwarding($object_id, $localip, $localport, $remoteip, $remoteport, $proto, $description)
1062{
1063 global $dbxlink;
1064
1065 $range = getRangeByIp($localip);
1066 if (!$range)
1067 return "$localip: Non existant ip";
1068
1069 $range = getRangeByIp($remoteip);
1070 if (!$range)
1071 return "$remoteip: Non existant ip";
1072
1073 if ( ($localport <= 0) or ($localport >= 65536) )
1074 return "$localport: invaild port";
1075
1076 if ( ($remoteport <= 0) or ($remoteport >= 65536) )
1077 return "$remoteport: invaild port";
1078
9bea3a8b
DO
1079 $result = useInsertBlade
1080 (
1081 'PortForwarding',
1082 array
1083 (
1084 'object_id' => $object_id,
1085 'localip' => "INET_ATON('${localip}')",
1086 'remoteip' => "INET_ATON('$remoteip')",
1087 'localport' => $localport,
1088 'remoteport' => $remoteport,
1089 'proto' => "'${proto}'",
1090 'description' => "'${description}'",
1091 )
1092 );
1093 if ($result)
1094 return '';
1095 else
1096 return __FUNCTION__ . ': Failed to insert the rule.';
e673ee24
DO
1097}
1098
1099function deletePortForwarding($object_id, $localip, $localport, $remoteip, $remoteport, $proto)
1100{
1101 global $dbxlink;
1102
1103 $query =
1104 "delete from PortForwarding where object_id='$object_id' and localip=INET_ATON('$localip') and remoteip=INET_ATON('$remoteip') and localport='$localport' and remoteport='$remoteport' and proto='$proto'";
1105 $result = $dbxlink->exec ($query);
1106 return '';
1107}
1108
1109function updatePortForwarding($object_id, $localip, $localport, $remoteip, $remoteport, $proto, $description)
1110{
1111 global $dbxlink;
1112
1113 $query =
1114 "update PortForwarding set description='$description' where object_id='$object_id' and localip=INET_ATON('$localip') and remoteip=INET_ATON('$remoteip') and localport='$localport' and remoteport='$remoteport' and proto='$proto'";
1115 $result = $dbxlink->exec ($query);
1116 return '';
1117}
1118
eeb4a5d8 1119function getNATv4ForObject ($object_id)
e673ee24 1120{
e673ee24
DO
1121 $ret = array();
1122 $ret['out'] = array();
1123 $ret['in'] = array();
1124 $query =
1125 "select ".
eeb4a5d8 1126 "proto, ".
e673ee24
DO
1127 "INET_NTOA(localip) as localip, ".
1128 "localport, ".
1129 "INET_NTOA(remoteip) as remoteip, ".
1130 "remoteport, ".
f28fbe8b
DO
1131 "ipa1.name as local_addr_name, " .
1132 "ipa2.name as remote_addr_name, " .
e673ee24 1133 "description ".
eeb4a5d8 1134 "from PortForwarding ".
f28fbe8b
DO
1135 "left join IPAddress as ipa1 on PortForwarding.localip = ipa1.ip " .
1136 "left join IPAddress as ipa2 on PortForwarding.remoteip = ipa2.ip " .
eeb4a5d8 1137 "where object_id='$object_id' ".
e673ee24 1138 "order by localip, localport, proto, remoteip, remoteport";
eeb4a5d8 1139 $result = useSelectBlade ($query);
e673ee24 1140 $count=0;
eeb4a5d8 1141 while ($row = $result->fetch (PDO::FETCH_ASSOC))
e673ee24 1142 {
eeb4a5d8 1143 foreach (array ('proto', 'localport', 'localip', 'remoteport', 'remoteip', 'description', 'local_addr_name', 'remote_addr_name') as $cname)
f28fbe8b 1144 $ret['out'][$count][$cname] = $row[$cname];
e673ee24
DO
1145 $count++;
1146 }
eeb4a5d8
DO
1147 $result->closeCursor();
1148 unset ($result);
e673ee24
DO
1149
1150 $query =
1151 "select ".
eeb4a5d8 1152 "proto, ".
e673ee24
DO
1153 "INET_NTOA(localip) as localip, ".
1154 "localport, ".
1155 "INET_NTOA(remoteip) as remoteip, ".
1156 "remoteport, ".
1157 "PortForwarding.object_id as object_id, ".
1158 "RackObject.name as object_name, ".
1159 "description ".
eeb4a5d8
DO
1160 "from ((PortForwarding join IPBonds on remoteip=IPBonds.ip) join RackObject on PortForwarding.object_id=RackObject.id) ".
1161 "where IPBonds.object_id='$object_id' ".
e673ee24 1162 "order by remoteip, remoteport, proto, localip, localport";
eeb4a5d8 1163 $result = useSelectBlade ($query);
e673ee24 1164 $count=0;
eeb4a5d8 1165 while ($row = $result->fetch (PDO::FETCH_ASSOC))
e673ee24 1166 {
eeb4a5d8 1167 foreach (array ('proto', 'localport', 'localip', 'remoteport', 'remoteip', 'object_id', 'object_name', 'description') as $cname)
f28fbe8b 1168 $ret['in'][$count][$cname] = $row[$cname];
e673ee24
DO
1169 $count++;
1170 }
eeb4a5d8 1171 $result->closeCursor();
e673ee24
DO
1172
1173 return $ret;
1174}
1175
c31cd72c 1176// This function returns an array of single element of object's FQDN attribute,
f321b50a
DO
1177// if FQDN is set. The next choice is object's common name, if it looks like a
1178// hostname. Otherwise an array of all 'regular' IP addresses of the
c31cd72c 1179// object is returned (which may appear 0 and more elements long).
f321b50a 1180function findAllEndpoints ($object_id, $fallback = '')
c31cd72c
DO
1181{
1182 $values = getAttrValues ($object_id);
1183 foreach ($values as $record)
f321b50a 1184 if ($record['name'] == 'FQDN' && !empty ($record['value']))
c31cd72c
DO
1185 return array ($record['value']);
1186 $addresses = getObjectAddresses ($object_id);
1187 $regular = array();
1188 foreach ($addresses as $idx => $address)
1189 if ($address['type'] == 'regular')
fa8112d1 1190 $regular[] = $address['ip'];
f321b50a
DO
1191 if (!count ($regular) && !empty ($fallback))
1192 return array ($fallback);
c31cd72c
DO
1193 return $regular;
1194}
1195
83ba6670
DO
1196// Some records in the dictionary may be written as plain text or as Wiki
1197// link in the following syntax:
1198// 1. word
1199// 2. [[word URL]] // FIXME: this isn't working
1200// 3. [[word word word | URL]]
1201// This function parses the line and returns text suitable for either A
1202// (rendering <A HREF>) or O (for <OPTION>).
24cbe8af 1203function parseWikiLink ($line, $which, $strip_optgroup = FALSE)
83ba6670 1204{
010231c2 1205 if (preg_match ('/^\[\[.+\]\]$/', $line) == 0)
24cbe8af
DO
1206 {
1207 if ($strip_optgroup)
f0b540a3 1208 return ereg_replace ('^.+%GSKIP%', '', ereg_replace ('^(.+)%GPASS%', '\\1 ', $line));
24cbe8af
DO
1209 else
1210 return $line;
1211 }
010231c2
DO
1212 $line = preg_replace ('/^\[\[(.+)\]\]$/', '$1', $line);
1213 $s = explode ('|', $line);
83ba6670 1214 $o_value = trim ($s[0]);
24cbe8af 1215 if ($strip_optgroup)
f0b540a3 1216 $o_value = ereg_replace ('^.+%GSKIP%', '', ereg_replace ('^(.+)%GPASS%', '\\1 ', $o_value));
83ba6670
DO
1217 $a_value = trim ($s[1]);
1218 if ($which == 'a')
010231c2 1219 return "<a href='${a_value}'>${o_value}</a>";
83ba6670
DO
1220 if ($which == 'o')
1221 return $o_value;
1222}
1223
2de490b7
DO
1224function buildVServiceName ($vsinfo = NULL)
1225{
1226 if ($vsinfo == NULL)
1227 {
1228 showError ('NULL argument', __FUNCTION__);
1229 return NULL;
1230 }
8d790216 1231 return $vsinfo['vip'] . ':' . $vsinfo['vport'] . '/' . $vsinfo['proto'];
2de490b7
DO
1232}
1233
05411ccd
DO
1234function buildRSPoolName ($rspool = NULL)
1235{
1236 if ($rspool == NULL)
1237 {
1238 showError ('NULL argument', __FUNCTION__);
1239 return NULL;
1240 }
1241 return strlen ($rspool['name']) ? $rspool['name'] : 'ANONYMOUS pool';
1242}
1243
177b1e9b
DO
1244// rackspace usage for a single rack
1245// (T + W + U) / (height * 3 - A)
11df133a 1246function getRSUforRack ($data = NULL)
177b1e9b 1247{
11df133a 1248 if ($data == NULL)
177b1e9b
DO
1249 {
1250 showError ('Invalid argument', __FUNCTION__);
1251 return NULL;
1252 }
6ffba290 1253 $counter = array ('A' => 0, 'U' => 0, 'T' => 0, 'W' => 0, 'F' => 0);
9e60f7df
DO
1254 for ($unit_no = $data['height']; $unit_no > 0; $unit_no--)
1255 for ($locidx = 0; $locidx < 3; $locidx++)
1256 $counter[$data[$unit_no][$locidx]['state']]++;
dfa3c075 1257 return ($counter['T'] + $counter['W'] + $counter['U']) / ($counter['T'] + $counter['W'] + $counter['U'] + $counter['F']);
177b1e9b
DO
1258}
1259
11df133a
DO
1260// Same for row.
1261function getRSUforRackRow ($rowData = NULL)
1262{
bb26a59e 1263 if ($rowData === NULL)
11df133a
DO
1264 {
1265 showError ('Invalid argument', __FUNCTION__);
1266 return NULL;
1267 }
bb26a59e
DO
1268 if (!count ($rowData))
1269 return 0;
11df133a 1270 $counter = array ('A' => 0, 'U' => 0, 'T' => 0, 'W' => 0, 'F' => 0);
f81a2012 1271 $total_height = 0;
dfa3c075
DO
1272 foreach (array_keys ($rowData) as $rack_id)
1273 {
1274 $data = getRackData ($rack_id);
1275 $total_height += $data['height'];
11df133a
DO
1276 for ($unit_no = $data['height']; $unit_no > 0; $unit_no--)
1277 for ($locidx = 0; $locidx < 3; $locidx++)
1278 $counter[$data[$unit_no][$locidx]['state']]++;
dfa3c075
DO
1279 }
1280 return ($counter['T'] + $counter['W'] + $counter['U']) / ($counter['T'] + $counter['W'] + $counter['U'] + $counter['F']);
11df133a
DO
1281}
1282
f1a0477d
DO
1283function getObjectCount ($rackData)
1284{
1285 $objects = array();
1286 for ($i = $rackData['height']; $i > 0; $i--)
1287 for ($locidx = 0; $locidx < 3; $locidx++)
1288 if
1289 (
1290 $rackData[$i][$locidx]['state'] == 'T' and
1291 !in_array ($rackData[$i][$locidx]['object_id'], $objects)
1292 )
1293 $objects[] = $rackData[$i][$locidx]['object_id'];
1294 return count ($objects);
1295}
1296
9af110b4
DO
1297// Perform substitutions and return resulting string
1298function apply_macros ($macros, $subject)
1299{
1300 $ret = $subject;
1301 foreach ($macros as $search => $replace)
1302 $ret = str_replace ($search, $replace, $ret);
1303 return $ret;
1304}
1305
1306// Make sure the string is always wrapped with LF characters
1307function lf_wrap ($str)
1308{
1309 $ret = trim ($str, "\r\n");
1310 if (!empty ($ret))
1311 $ret .= "\n";
1312 return $ret;
1313}
1314
e6e7d8b3
DO
1315// Adopted from Mantis BTS code.
1316function string_insert_hrefs ($s)
1317{
1318 if (getConfigVar ('DETECT_URLS') != 'yes')
1319 return $s;
1320 # Find any URL in a string and replace it by a clickable link
1321 $s = preg_replace( '/(([[:alpha:]][-+.[:alnum:]]*):\/\/(%[[:digit:]A-Fa-f]{2}|[-_.!~*\';\/?%^\\\\:@&={\|}+$#\(\),\[\][:alnum:]])+)/se',
1322 "'<a href=\"'.rtrim('\\1','.').'\">\\1</a> [<a href=\"'.rtrim('\\1','.').'\" target=\"_blank\">^</a>]'",
1323 $s);
1324 $s = preg_replace( '/\b' . email_regex_simple() . '\b/i',
1325 '<a href="mailto:\0">\0</a>',
1326 $s);
1327 return $s;
1328}
1329
1330// Idem.
1331function email_regex_simple ()
1332{
1333 return "(([a-z0-9!#*+\/=?^_{|}~-]+(?:\.[a-z0-9!#*+\/=?^_{|}~-]+)*)" . # recipient
1334 "\@((?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?))"; # @domain
1335}
1336
118e4c38
DO
1337// Parse AUTOPORTS_CONFIG and return a list of generated pairs (port_type, port_name)
1338// for the requested object_type_id.
1339function getAutoPorts ($type_id)
1340{
1341 $ret = array();
1342 $typemap = explode (';', str_replace (' ', '', getConfigVar ('AUTOPORTS_CONFIG')));
1343 foreach ($typemap as $equation)
1344 {
1345 $tmp = explode ('=', $equation);
1346 if (count ($tmp) != 2)
1347 continue;
1348 $objtype_id = $tmp[0];
1349 if ($objtype_id != $type_id)
1350 continue;
1351 $portlist = $tmp[1];
1352 foreach (explode ('+', $portlist) as $product)
1353 {
1354 $tmp = explode ('*', $product);
1355 if (count ($tmp) != 3)
1356 continue;
1357 $nports = $tmp[0];
1358 $port_type = $tmp[1];
1359 $format = $tmp[2];
1360 for ($i = 0; $i < $nports; $i++)
1361 $ret[] = array ('type' => $port_type, 'name' => @sprintf ($format, $i));
1362 }
1363 }
1364 return $ret;
1365}
1366
9dfd4cc9
DO
1367// Find if a particular tag id exists on the tree, then attach the
1368// given child tag to it. If the parent tag doesn't exist, return FALSE.
1369function attachChildTag (&$tree, $parent_id, $child_id, $child_info)
1370{
1371 foreach ($tree as $tagid => $taginfo)
1372 {
1373 if ($tagid == $parent_id)
1374 {
1375 $tree[$tagid]['kids'][$child_id] = $child_info;
1376 return TRUE;
1377 }
1378 elseif (attachChildTag ($tree[$tagid]['kids'], $parent_id, $child_id, $child_info))
1379 return TRUE;
1380 }
1381 return FALSE;
1382}
1383
1384// Build a tree from the tag list and return it.
1385function getTagTree ()
1386{
20c901a7
DO
1387 global $taglist;
1388 $mytaglist = $taglist;
1389 $ret = array();
1390 while (count ($mytaglist) > 0)
9dfd4cc9
DO
1391 {
1392 $picked = FALSE;
20c901a7 1393 foreach ($mytaglist as $tagid => $taginfo)
9dfd4cc9
DO
1394 {
1395 $taginfo['kids'] = array();
1396 if ($taginfo['parent_id'] == NULL)
1397 {
20c901a7 1398 $ret[$tagid] = $taginfo;
9dfd4cc9 1399 $picked = TRUE;
20c901a7 1400 unset ($mytaglist[$tagid]);
9dfd4cc9 1401 }
20c901a7 1402 elseif (attachChildTag ($ret, $taginfo['parent_id'], $tagid, $taginfo))
9dfd4cc9
DO
1403 {
1404 $picked = TRUE;
20c901a7 1405 unset ($mytaglist[$tagid]);
9dfd4cc9
DO
1406 }
1407 }
1408 if (!$picked) // Only orphaned items on the list.
1409 break;
1410 }
20c901a7 1411 return $ret;
9dfd4cc9
DO
1412}
1413
49fb1027
DO
1414// Build a tree from the tag list and return everything _except_ the tree.
1415function getOrphanedTags ()
1416{
1417 global $taglist;
1418 $mytaglist = $taglist;
1419 $dummy = array();
1420 while (count ($mytaglist) > 0)
1421 {
1422 $picked = FALSE;
1423 foreach ($mytaglist as $tagid => $taginfo)
1424 {
1425 $taginfo['kids'] = array();
1426 if ($taginfo['parent_id'] == NULL)
1427 {
1428 $dummy[$tagid] = $taginfo;
1429 $picked = TRUE;
1430 unset ($mytaglist[$tagid]);
1431 }
1432 elseif (attachChildTag ($dummy, $taginfo['parent_id'], $tagid, $taginfo))
1433 {
1434 $picked = TRUE;
1435 unset ($mytaglist[$tagid]);
1436 }
1437 }
1438 if (!$picked) // Only orphaned items on the list.
1439 return $mytaglist;
1440 }
1441 return array();
1442}
1443
e2ac59cf 1444function serializeTags ($trail, $baseurl = '')
ba93bd98
DO
1445{
1446 $comma = '';
1447 $ret = '';
1448 foreach ($trail as $taginfo)
1449 {
e2ac59cf
DO
1450 $ret .= $comma .
1451 ($baseurl == '' ? '' : "<a href='${baseurl}tagfilter[]=${taginfo['id']}'>") .
1452 $taginfo['tag'] .
1453 ($baseurl == '' ? '' : '</a>');
ba93bd98
DO
1454 $comma = ', ';
1455 }
1456 return $ret;
1457}
1458
ab379543 1459// a helper for getTrailExpansion()
ba93bd98
DO
1460function traceTrail ($tree, $trail)
1461{
1462 // For each tag find its path from the root, then combine items
1463 // of all paths and add them to the trail, if they aren't there yet.
1464 $ret = array();
1465 foreach ($tree as $taginfo1)
1466 {
1467 $hit = FALSE;
1468 foreach ($trail as $taginfo2)
1469 if ($taginfo1['id'] == $taginfo2['id'])
1470 {
1471 $hit = TRUE;
1472 break;
1473 }
1474 if (count ($taginfo1['kids']) > 0)
1475 {
1476 $subsearch = traceTrail ($taginfo1['kids'], $trail);
1477 if (count ($subsearch))
1478 {
1479 $hit = TRUE;
1480 $ret = array_merge ($ret, $subsearch);
1481 }
1482 }
1483 if ($hit)
1484 $ret[] = $taginfo1;
1485 }
1486 return $ret;
1487}
1488
1489// For each tag add all its parent tags onto the list. Don't expect anything
1490// except user's tags on the trail.
1491function getTrailExpansion ($trail)
1492{
20c901a7
DO
1493 global $tagtree;
1494 return traceTrail ($tagtree, $trail);
ba93bd98
DO
1495}
1496
1497// Return the list of missing implicit tags.
1498function getImplicitTags ($oldtags)
1499{
1500 $ret = array();
1501 $newtags = getTrailExpansion ($oldtags);
1502 foreach ($newtags as $newtag)
1503 {
1504 $already_exists = FALSE;
1505 foreach ($oldtags as $oldtag)
1506 if ($newtag['id'] == $oldtag['id'])
1507 {
1508 $already_exists = TRUE;
1509 break;
1510 }
1511 if ($already_exists)
1512 continue;
d6089951 1513 $ret[] = array ('id' => $newtag['id'], 'tag' => $newtag['tag'], 'parent_id' => $newtag['parent_id']);
ba93bd98
DO
1514 }
1515 return $ret;
1516}
1517
ab379543
DO
1518// Minimize the trail: exclude all implicit tags and return the resulting trail.
1519function getExplicitTagsOnly ($trail, $tree = NULL)
1520{
20c901a7 1521 global $tagtree;
ab379543 1522 if ($tree === NULL)
20c901a7 1523 $tree = $tagtree;
ab379543
DO
1524 $ret = array();
1525 foreach ($tree as $taginfo)
1526 {
1527 if (isset ($taginfo['kids']))
1528 {
1529 $harvest = getExplicitTagsOnly ($trail, $taginfo['kids']);
1530 if (count ($harvest) > 0)
1531 {
1532 $ret = array_merge ($ret, $harvest);
1533 continue;
1534 }
1535 }
1536 // This tag isn't implicit, test is for being explicit.
1537 foreach ($trail as $testtag)
1538 if ($taginfo['id'] == $testtag['id'])
1539 {
1540 $ret[] = $testtag;
1541 break;
1542 }
1543 }
1544 return $ret;
1545}
1546
74ccacff
DO
1547// Maximize the trail: for each tag add all tags, for which it is direct or indirect parent.
1548// Unlike other functions, this one accepts and returns a list of integer tag IDs, not
1549// a list of tag structures.
1550function complementByKids ($idlist, $tree = NULL, $getall = FALSE)
1551{
20c901a7 1552 global $tagtree;
74ccacff 1553 if ($tree === NULL)
20c901a7 1554 $tree = $tagtree;
74ccacff
DO
1555 $getallkids = $getall;
1556 $ret = array();
1557 foreach ($tree as $taginfo)
1558 {
1559 foreach ($idlist as $test_id)
1560 if ($getall or $taginfo['id'] == $test_id)
1561 {
1562 $ret[] = $taginfo['id'];
1563 // Once matched node makes all sub-nodes match, but don't make
1564 // a mistake of matching every other node at the current level.
1565 $getallkids = TRUE;
1566 break;
1567 }
1568 if (isset ($taginfo['kids']))
1569 $ret = array_merge ($ret, complementByKids ($idlist, $taginfo['kids'], $getallkids));
1570 $getallkids = FALSE;
1571 }
1572 return $ret;
1573}
1574
68225375 1575function loadRackObjectAutoTags ()
ba93bd98 1576{
2c6c7645 1577 assertUIntArg ('object_id', __FUNCTION__);
2fb24351
DO
1578 $object_id = $_REQUEST['object_id'];
1579 $oinfo = getObjectInfo ($object_id);
1580 $ret = array();
1581 $ret[] = array ('tag' => '$id_' . $_REQUEST['object_id']);
d817ba03 1582 $ret[] = array ('tag' => '$any_object');
2fb24351
DO
1583 return $ret;
1584}
1585
68225375
DO
1586// Common code for both prefix and address tag listers.
1587function getIPv4PrefixTags ($prefix)
f9bc186f 1588{
f9bc186f 1589 $ret = array();
68225375 1590 $ret[] = array ('tag' => '$ipv4net-' . str_replace ('.', '-', $prefix['ip']) . '-' . $prefix['mask']);
d817ba03
DO
1591 // FIXME: find and list tags for all parent networks
1592 $ret[] = array ('tag' => '$any_ipv4net');
1593 $ret[] = array ('tag' => '$any_net');
41bd8c87
DO
1594 return $ret;
1595}
1596
68225375 1597function loadIPv4PrefixAutoTags ()
41bd8c87 1598{
68225375
DO
1599 assertUIntArg ('id', __FUNCTION__);
1600 return array_merge
1601 (
1602 array (array ('tag' => '$id_' . $_REQUEST['id'])),
1603 getIPv4PrefixTags (getIPRange ($_REQUEST['id']))
1604 );
d817ba03
DO
1605}
1606
68225375 1607function loadIPv4AddressAutoTags ()
d817ba03 1608{
2c6c7645 1609 assertIPv4Arg ('ip', __FUNCTION__);
68225375
DO
1610 return array_merge
1611 (
1612 array (array ('tag' => '$ipv4net-' . str_replace ('.', '-', $_REQUEST['ip']) . '-32')),
1613 getIPv4PrefixTags (getRangeByIP ($_REQUEST['ip']))
1614 );
1615}
1616
1617function loadRackAutoTags ()
1618{
1619 assertUIntArg ('rack_id', __FUNCTION__);
d817ba03 1620 $ret = array();
68225375
DO
1621 $ret[] = array ('tag' => '$id_' . $_REQUEST['rack_id']);
1622 $ret[] = array ('tag' => '$any_rack');
d817ba03
DO
1623 return $ret;
1624}
1625
68225375 1626function loadIPv4VSAutoTags ()
d817ba03 1627{
2c6c7645 1628 assertUIntArg ('id', __FUNCTION__);
d817ba03
DO
1629 $ret = array();
1630 $ret[] = array ('tag' => '$id_' . $_REQUEST['id']);
1631 $ret[] = array ('tag' => '$any_ipv4vs');
1632 $ret[] = array ('tag' => '$any_vs');
1633 return $ret;
1634}
1635
68225375 1636function loadIPv4RSPoolAutoTags ()
d817ba03 1637{
2c6c7645 1638 assertUIntArg ('pool_id', __FUNCTION__);
d817ba03 1639 $ret = array();
6aff02cf 1640 $ret[] = array ('tag' => '$id_' . $_REQUEST['pool_id']);
d817ba03
DO
1641 $ret[] = array ('tag' => '$any_ipv4rspool');
1642 $ret[] = array ('tag' => '$any_rspool');
f9bc186f
DO
1643 return $ret;
1644}
1645
68225375 1646function getGlobalAutoTags ()
2fb24351
DO
1647{
1648 global $remote_username, $accounts;
1649 $ret = array();
1650 $user_id = 0;
1651 foreach ($accounts as $a)
1652 if ($a['user_name'] == $remote_username)
1653 {
1654 $user_id = $a['user_id'];
1655 break;
1656 }
1657 $ret[] = array ('tag' => '$username_' . $remote_username);
1658 $ret[] = array ('tag' => '$userid_' . $user_id);
1659 return $ret;
ba93bd98
DO
1660}
1661
ab379543
DO
1662// Build a tag trail from supplied tag id list and return it.
1663function buildTrailFromIds ($tagidlist)
1664{
20c901a7 1665 global $taglist;
ab379543
DO
1666 $ret = array();
1667 foreach ($tagidlist as $tag_id)
1668 if (isset ($taglist[$tag_id]))
1669 $ret[] = $taglist[$tag_id];
1670 return $ret;
1671}
1672
7cc02fc1
DO
1673// Process a given tag tree and return only meaningful branches. The resulting
1674// (sub)tree will have refcnt leaves on every last branch.
1675function getObjectiveTagTree ($tree, $realm)
1676{
1677 $ret = array();
1678 foreach ($tree as $taginfo)
1679 {
1680 $subsearch = array();
1681 $pick = FALSE;
1682 if (count ($taginfo['kids']))
1683 {
1684 $subsearch = getObjectiveTagTree ($taginfo['kids'], $realm);
1685 $pick = count ($subsearch) > 0;
1686 }
5bdc04ec 1687 if (isset ($taginfo['refcnt'][$realm]))
7cc02fc1
DO
1688 $pick = TRUE;
1689 if (!$pick)
1690 continue;
1691 $ret[] = array
1692 (
1693 'id' => $taginfo['id'],
1694 'tag' => $taginfo['tag'],
1695 'parent_id' => $taginfo['parent_id'],
1696 'refcnt' => $taginfo['refcnt'],
1697 'kids' => $subsearch
1698 );
1699 }
1700 return $ret;
1701}
1702
a0d54e7e 1703function getTagFilter ()
7cc02fc1 1704{
a0d54e7e 1705 return isset ($_REQUEST['tagfilter']) ? complementByKids ($_REQUEST['tagfilter']) : array();
7cc02fc1
DO
1706}
1707
a0d54e7e 1708function getTagFilterStr ($tagfilter = array())
932cf41f 1709{
a0d54e7e 1710 $ret = '';
a0d54e7e
DO
1711 foreach (getExplicitTagsOnly (buildTrailFromIds ($tagfilter)) as $taginfo)
1712 $ret .= "&tagfilter[]=" . $taginfo['id'];
1713 return $ret;
932cf41f 1714}
a0d54e7e 1715
e673ee24 1716?>