r1939 + introduce IPV4_AUTO_RELEASE option
[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.
e673ee24
DO
638function getIPAddress ($ip=0)
639{
640 $ret = array();
e673ee24 641 $ret['bonds'] = array();
59bebe2b 642 // FIXME: below two aren't neither filled in with data nor rendered (ticket:23)
e673ee24
DO
643 $ret['outpf'] = array();
644 $ret['inpf'] = array();
59bebe2b
DO
645 $ret['vslist'] = array();
646 $ret['rslist'] = array();
e673ee24 647 $ret['exists'] = 0;
dda31a62 648 $ret['name'] = '';
e673ee24
DO
649 $ret['reserved'] = 'no';
650 global $dbxlink;
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 != '')";
59bebe2b
DO
656 $result = $dbxlink->query ($query);
657 if ($result == NULL)
658 {
659 showError ('Query #1 failed', __FUNCTION__);
e673ee24 660 return NULL;
59bebe2b
DO
661 }
662 if ($row = $result->fetch (PDO::FETCH_ASSOC))
e673ee24 663 {
959c4f4c 664 $ret['exists'] = 1;
959c4f4c
DO
665 $ret['name'] = $row['name'];
666 $ret['reserved'] = $row['reserved'];
e673ee24 667 }
59bebe2b
DO
668 $result->closeCursor();
669 unset ($result);
e673ee24 670
59bebe2b 671 $query =
dda31a62
DO
672 "select ".
673 "IPBonds.object_id as object_id, ".
674 "IPBonds.name as name, ".
675 "IPBonds.type as type, ".
676 "objtype_id, dict_value as objtype_name, " .
677 "RackObject.name as object_name ".
678 "from IPBonds join RackObject on IPBonds.object_id=RackObject.id ".
679 "left join Dictionary on objtype_id=dict_key natural join Chapter " .
680 "where IPBonds.ip=INET_ATON('$ip') ".
681 "and chapter_name = 'RackObjectType' " .
682 "order by RackObject.id, IPBonds.name";
59bebe2b 683 $result = $dbxlink->query ($query);
dda31a62 684 $count=0;
59bebe2b 685 while ($row = $result->fetch (PDO::FETCH_ASSOC))
e673ee24 686 {
dda31a62
DO
687 $ret['bonds'][$count]['object_id'] = $row['object_id'];
688 $ret['bonds'][$count]['name'] = $row['name'];
689 $ret['bonds'][$count]['type'] = $row['type'];
690 $qo = array();
691 $qo['name'] = $row['object_name'];
692 $qo['objtype_id'] = $row['objtype_id'];
693 $qo['objtype_name'] = $row['objtype_name'];
694 $ret['bonds'][$count]['object_name'] = displayedName ($qo);
695 $count++;
696 $ret['exists'] = 1;
e673ee24 697 }
59bebe2b
DO
698 $result->closeCursor();
699 unset ($result);
700
5fe1ed76 701 $query = "select id, vport, proto, name from IPVirtualService where vip = inet_aton('${ip}')";
59bebe2b
DO
702 $result = $dbxlink->query ($query);
703 while ($row = $result->fetch (PDO::FETCH_ASSOC))
5fe1ed76
DO
704 {
705 $new = $row;
706 $new['vip'] = $ip;
707 $ret['vslist'][] = $new;
708 }
709 $result->closeCursor();
710 unset ($result);
711
712 $query = "select inservice, rsport, IPRSPool.id as pool_id, IPRSPool.name as poolname from " .
713 "IPRealServer inner join IPRSPool on rspool_id = IPRSPool.id " .
714 "where rsip = inet_aton('${ip}')";
715 $result = $dbxlink->query ($query);
716 while ($row = $result->fetch (PDO::FETCH_ASSOC))
717 {
718 $new = $row;
719 $new['rsip'] = $ip;
720 $ret['rslist'][] = $new;
721 }
59bebe2b
DO
722 $result->closeCursor();
723 unset ($result);
e673ee24
DO
724
725 return $ret;
726}
727
728function bindIpToObject ($ip='', $object_id=0, $name='', $type='')
729{
730 global $dbxlink;
731
732 $range = getRangeByIp($ip);
e673ee24
DO
733 if (!$range)
734 return 'Non-existant ip address. Try adding IP range first';
735
20a92aa2
DO
736 $result = useInsertBlade
737 (
738 'IPBonds',
739 array
740 (
dda31a62 741 'ip' => "INET_ATON('$ip')",
20a92aa2
DO
742 'object_id' => "'${object_id}'",
743 'name' => "'${name}'",
744 'type' => "'${type}'"
745 )
746 );
747 return $result ? '' : 'useInsertBlade() failed in bindIpToObject()';
e673ee24
DO
748}
749
750// This function looks up 'has_problems' flag for 'T' atoms
751// and modifies 'hl' key. May be, this should be better done
752// in getRackData(). We don't honour 'skipped' key, because
753// the function is also used for thumb creation.
754function markupObjectProblems (&$rackData)
755{
756 for ($i = $rackData['height']; $i > 0; $i--)
757 for ($locidx = 0; $locidx < 3; $locidx++)
758 if ($rackData[$i][$locidx]['state'] == 'T')
759 {
760 $object = getObjectInfo ($rackData[$i][$locidx]['object_id']);
761 if ($object['has_problems'] == 'yes')
762 {
763 // Object can be already highlighted.
764 if (isset ($rackData[$i][$locidx]['hl']))
765 $rackData[$i][$locidx]['hl'] = $rackData[$i][$locidx]['hl'] . 'w';
766 else
767 $rackData[$i][$locidx]['hl'] = 'w';
768 }
769 }
770}
771
772function search_cmpObj ($a, $b)
773{
774 return ($a['score'] > $b['score'] ? -1 : 1);
775}
776
777// This function performs search and then calculates score for each result.
778// Given previous search results in $objects argument, it adds new results
779// to the array and updates score for existing results, if it is greater than
780// existing score.
781function mergeSearchResults (&$objects, $terms, $fieldname)
782{
783 global $dbxlink;
784 $query =
785 "select name, label, asset_no, barcode, ro.id, dict_key as objtype_id, " .
786 "dict_value as objtype_name, asset_no from RackObject as ro inner join Dictionary " .
787 "on objtype_id = dict_key natural join Chapter where chapter_name = 'RackObjectType' and ";
788 $count = 0;
789 foreach (explode (' ', $terms) as $term)
790 {
791 if ($count) $query .= ' or ';
792 $query .= "${fieldname} like '%$term%'";
793 $count++;
794 }
ea5fc465 795 $result = useSelectBlade ($query);
e673ee24
DO
796// FIXME: this dead call was executed 4 times per 1 object search!
797// $typeList = getObjectTypeList();
798 $clist = array ('id', 'name', 'label', 'asset_no', 'barcode', 'objtype_id', 'objtype_name');
799 while ($row = $result->fetch(PDO::FETCH_ASSOC))
800 {
801 foreach ($clist as $cname)
802 $object[$cname] = $row[$cname];
803 $object['score'] = 0;
804 $object['dname'] = displayedName ($object);
805 unset ($object['objtype_id']);
806 foreach (explode (' ', $terms) as $term)
807 if (strstr ($object['name'], $term))
808 $object['score'] += 1;
809 unset ($object['name']);
810 if (!isset ($objects[$row['id']]))
811 $objects[$row['id']] = $object;
812 elseif ($objects[$row['id']]['score'] < $object['score'])
813 $objects[$row['id']]['score'] = $object['score'];
814 }
815 return $objects;
816}
817
ea5fc465 818function getObjectSearchResults ($terms)
e673ee24
DO
819{
820 $objects = array();
821 mergeSearchResults ($objects, $terms, 'name');
822 mergeSearchResults ($objects, $terms, 'label');
823 mergeSearchResults ($objects, $terms, 'asset_no');
824 mergeSearchResults ($objects, $terms, 'barcode');
825 if (count ($objects) == 1)
826 usort ($objects, 'search_cmpObj');
827 return $objects;
828}
829
830// This function removes all colons and dots from a string.
831function l2addressForDatabase ($string)
832{
833 if (empty ($string))
834 return 'NULL';
835 $pieces = explode (':', $string);
836 // This workaround is for SunOS ifconfig.
837 foreach ($pieces as &$byte)
838 if (strlen ($byte) == 1)
839 $byte = '0' . $byte;
840 // And this workaround is for PHP.
841 unset ($byte);
842 $string = implode ('', $pieces);
843 $pieces = explode ('.', $string);
844 $string = implode ('', $pieces);
845 $string = strtoupper ($string);
846 return "'$string'";
847}
848
849function l2addressFromDatabase ($string)
850{
851 switch (strlen ($string))
852 {
853 case 12: // Ethernet
854 case 16: // FireWire
855 $ret = implode (':', str_split ($string, 2));
856 break;
857 default:
858 $ret = $string;
859 break;
860 }
861 return $ret;
862}
863
864// The following 2 functions return previous and next rack IDs for
865// a given rack ID. The order of racks is the same as in renderRackspace()
866// or renderRow().
867function getPrevIDforRack ($row_id = 0, $rack_id = 0)
868{
869 if ($row_id <= 0 or $rack_id <= 0)
870 {
61e269b5 871 showError ('Invalid arguments passed', __FUNCTION__);
e673ee24
DO
872 return NULL;
873 }
874 $rackList = getRacksForRow ($row_id);
875 doubleLink ($rackList);
876 if (isset ($rackList[$rack_id]['prev_key']))
877 return $rackList[$rack_id]['prev_key'];
878 return NULL;
879}
880
881function getNextIDforRack ($row_id = 0, $rack_id = 0)
882{
883 if ($row_id <= 0 or $rack_id <= 0)
884 {
61e269b5 885 showError ('Invalid arguments passed', __FUNCTION__);
e673ee24
DO
886 return NULL;
887 }
888 $rackList = getRacksForRow ($row_id);
889 doubleLink ($rackList);
890 if (isset ($rackList[$rack_id]['next_key']))
891 return $rackList[$rack_id]['next_key'];
892 return NULL;
893}
894
895// This function finds previous and next array keys for each array key and
896// modifies its argument accordingly.
897function doubleLink (&$array)
898{
899 $prev_key = NULL;
900 foreach (array_keys ($array) as $key)
901 {
902 if ($prev_key)
903 {
904 $array[$key]['prev_key'] = $prev_key;
905 $array[$prev_key]['next_key'] = $key;
906 }
907 $prev_key = $key;
908 }
909}
910
911// After applying usort() to a rack list we will lose original array keys.
912// This function restores the keys so they are equal to rack IDs.
913function restoreRackIDs ($racks)
914{
915 $ret = array();
916 foreach ($racks as $rack)
917 $ret[$rack['id']] = $rack;
918 return $ret;
919}
920
921function sortTokenize ($a, $b)
922{
923 $aold='';
924 while ($a != $aold)
925 {
926 $aold=$a;
927 $a = ereg_replace('[^a-zA-Z0-9]',' ',$a);
928 $a = ereg_replace('([0-9])([a-zA-Z])','\\1 \\2',$a);
929 $a = ereg_replace('([a-zA-Z])([0-9])','\\1 \\2',$a);
930 }
931
932 $bold='';
933 while ($b != $bold)
934 {
935 $bold=$b;
936 $b = ereg_replace('[^a-zA-Z0-9]',' ',$b);
937 $b = ereg_replace('([0-9])([a-zA-Z])','\\1 \\2',$b);
938 $b = ereg_replace('([a-zA-Z])([0-9])','\\1 \\2',$b);
939 }
940
941
942
943 $ar = explode(' ', $a);
944 $br = explode(' ', $b);
945 for ($i=0; $i<count($ar) && $i<count($br); $i++)
946 {
947 $ret = 0;
948 if (is_numeric($ar[$i]) and is_numeric($br[$i]))
949 $ret = ($ar[$i]==$br[$i])?0:($ar[$i]<$br[$i]?-1:1);
950 else
951 $ret = strcasecmp($ar[$i], $br[$i]);
952 if ($ret != 0)
953 return $ret;
954 }
955 if ($i<count($ar))
956 return 1;
957 if ($i<count($br))
958 return -1;
959 return 0;
960}
961
962function sortByName ($a, $b)
963{
964 return sortTokenize($a['name'], $b['name']);
965}
966
6a3a37b2
DO
967function sortRacks ($a, $b)
968{
969 return sortTokenize($a['row_name'] . ': ' . $a['name'], $b['row_name'] . ': ' . $b['name']);
970}
971
e673ee24
DO
972function eq ($a, $b)
973{
974 return $a==$b;
975}
976
977function neq ($a, $b)
978{
979 return $a!=$b;
980}
981
982function countRefsOfType ($refs, $type, $eq)
983{
984 $count=0;
985 foreach ($refs as $ref)
986 {
987 if ($eq($ref['type'], $type))
988 $count++;
989 }
990 return $count;
991}
992
993function sortEmptyPorts ($a, $b)
994{
995 $objname_cmp = sortTokenize($a['Object_name'], $b['Object_name']);
996 if ($objname_cmp == 0)
997 {
998 return sortTokenize($a['Port_name'], $b['Port_name']);
999 }
1000 return $objname_cmp;
1001}
1002
1003function sortObjectAddressesAndNames ($a, $b)
1004{
1005 $objname_cmp = sortTokenize($a['object_name'], $b['object_name']);
1006 if ($objname_cmp == 0)
1007 {
79f22c3d
DO
1008 $name_a = (isset ($a['port_name'])) ? $a['port_name'] : '';
1009 $name_b = (isset ($b['port_name'])) ? $b['port_name'] : '';
1010 $objname_cmp = sortTokenize($name_a, $name_b);
e673ee24 1011 if ($objname_cmp == 0)
e673ee24 1012 sortTokenize($a['ip'], $b['ip']);
e673ee24
DO
1013 return $objname_cmp;
1014 }
1015 return $objname_cmp;
1016}
1017
1018
1019
1020function sortAddresses ($a, $b)
1021{
1022 $name_cmp = sortTokenize($a['name'], $b['name']);
1023 if ($name_cmp == 0)
1024 {
1025 return sortTokenize($a['ip'], $b['ip']);
1026 }
1027 return $name_cmp;
1028}
1029
1030// This function expands port compat list into a matrix.
1031function buildPortCompatMatrixFromList ($portTypeList, $portCompatList)
1032{
1033 $matrix = array();
1034 // Create type matrix and markup compatible types.
1035 foreach (array_keys ($portTypeList) as $type1)
1036 foreach (array_keys ($portTypeList) as $type2)
1037 $matrix[$type1][$type2] = FALSE;
1038 foreach ($portCompatList as $pair)
1039 $matrix[$pair['type1']][$pair['type2']] = TRUE;
1040 return $matrix;
1041}
1042
1043function newPortForwarding($object_id, $localip, $localport, $remoteip, $remoteport, $proto, $description)
1044{
1045 global $dbxlink;
1046
1047 $range = getRangeByIp($localip);
1048 if (!$range)
1049 return "$localip: Non existant ip";
1050
1051 $range = getRangeByIp($remoteip);
1052 if (!$range)
1053 return "$remoteip: Non existant ip";
1054
1055 if ( ($localport <= 0) or ($localport >= 65536) )
1056 return "$localport: invaild port";
1057
1058 if ( ($remoteport <= 0) or ($remoteport >= 65536) )
1059 return "$remoteport: invaild port";
1060
9bea3a8b
DO
1061 $result = useInsertBlade
1062 (
1063 'PortForwarding',
1064 array
1065 (
1066 'object_id' => $object_id,
1067 'localip' => "INET_ATON('${localip}')",
1068 'remoteip' => "INET_ATON('$remoteip')",
1069 'localport' => $localport,
1070 'remoteport' => $remoteport,
1071 'proto' => "'${proto}'",
1072 'description' => "'${description}'",
1073 )
1074 );
1075 if ($result)
1076 return '';
1077 else
1078 return __FUNCTION__ . ': Failed to insert the rule.';
e673ee24
DO
1079}
1080
1081function deletePortForwarding($object_id, $localip, $localport, $remoteip, $remoteport, $proto)
1082{
1083 global $dbxlink;
1084
1085 $query =
1086 "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'";
1087 $result = $dbxlink->exec ($query);
1088 return '';
1089}
1090
1091function updatePortForwarding($object_id, $localip, $localport, $remoteip, $remoteport, $proto, $description)
1092{
1093 global $dbxlink;
1094
1095 $query =
1096 "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'";
1097 $result = $dbxlink->exec ($query);
1098 return '';
1099}
1100
eeb4a5d8 1101function getNATv4ForObject ($object_id)
e673ee24 1102{
e673ee24
DO
1103 $ret = array();
1104 $ret['out'] = array();
1105 $ret['in'] = array();
1106 $query =
1107 "select ".
eeb4a5d8 1108 "proto, ".
e673ee24
DO
1109 "INET_NTOA(localip) as localip, ".
1110 "localport, ".
1111 "INET_NTOA(remoteip) as remoteip, ".
1112 "remoteport, ".
f28fbe8b
DO
1113 "ipa1.name as local_addr_name, " .
1114 "ipa2.name as remote_addr_name, " .
e673ee24 1115 "description ".
eeb4a5d8 1116 "from PortForwarding ".
f28fbe8b
DO
1117 "left join IPAddress as ipa1 on PortForwarding.localip = ipa1.ip " .
1118 "left join IPAddress as ipa2 on PortForwarding.remoteip = ipa2.ip " .
eeb4a5d8 1119 "where object_id='$object_id' ".
e673ee24 1120 "order by localip, localport, proto, remoteip, remoteport";
eeb4a5d8 1121 $result = useSelectBlade ($query);
e673ee24 1122 $count=0;
eeb4a5d8 1123 while ($row = $result->fetch (PDO::FETCH_ASSOC))
e673ee24 1124 {
eeb4a5d8 1125 foreach (array ('proto', 'localport', 'localip', 'remoteport', 'remoteip', 'description', 'local_addr_name', 'remote_addr_name') as $cname)
f28fbe8b 1126 $ret['out'][$count][$cname] = $row[$cname];
e673ee24
DO
1127 $count++;
1128 }
eeb4a5d8
DO
1129 $result->closeCursor();
1130 unset ($result);
e673ee24
DO
1131
1132 $query =
1133 "select ".
eeb4a5d8 1134 "proto, ".
e673ee24
DO
1135 "INET_NTOA(localip) as localip, ".
1136 "localport, ".
1137 "INET_NTOA(remoteip) as remoteip, ".
1138 "remoteport, ".
1139 "PortForwarding.object_id as object_id, ".
1140 "RackObject.name as object_name, ".
1141 "description ".
eeb4a5d8
DO
1142 "from ((PortForwarding join IPBonds on remoteip=IPBonds.ip) join RackObject on PortForwarding.object_id=RackObject.id) ".
1143 "where IPBonds.object_id='$object_id' ".
e673ee24 1144 "order by remoteip, remoteport, proto, localip, localport";
eeb4a5d8 1145 $result = useSelectBlade ($query);
e673ee24 1146 $count=0;
eeb4a5d8 1147 while ($row = $result->fetch (PDO::FETCH_ASSOC))
e673ee24 1148 {
eeb4a5d8 1149 foreach (array ('proto', 'localport', 'localip', 'remoteport', 'remoteip', 'object_id', 'object_name', 'description') as $cname)
f28fbe8b 1150 $ret['in'][$count][$cname] = $row[$cname];
e673ee24
DO
1151 $count++;
1152 }
eeb4a5d8 1153 $result->closeCursor();
e673ee24
DO
1154
1155 return $ret;
1156}
1157
c31cd72c 1158// This function returns an array of single element of object's FQDN attribute,
f321b50a
DO
1159// if FQDN is set. The next choice is object's common name, if it looks like a
1160// hostname. Otherwise an array of all 'regular' IP addresses of the
c31cd72c 1161// object is returned (which may appear 0 and more elements long).
f321b50a 1162function findAllEndpoints ($object_id, $fallback = '')
c31cd72c
DO
1163{
1164 $values = getAttrValues ($object_id);
1165 foreach ($values as $record)
f321b50a 1166 if ($record['name'] == 'FQDN' && !empty ($record['value']))
c31cd72c
DO
1167 return array ($record['value']);
1168 $addresses = getObjectAddresses ($object_id);
1169 $regular = array();
1170 foreach ($addresses as $idx => $address)
1171 if ($address['type'] == 'regular')
fa8112d1 1172 $regular[] = $address['ip'];
f321b50a
DO
1173 if (!count ($regular) && !empty ($fallback))
1174 return array ($fallback);
c31cd72c
DO
1175 return $regular;
1176}
1177
83ba6670
DO
1178// Some records in the dictionary may be written as plain text or as Wiki
1179// link in the following syntax:
1180// 1. word
1181// 2. [[word URL]] // FIXME: this isn't working
1182// 3. [[word word word | URL]]
1183// This function parses the line and returns text suitable for either A
1184// (rendering <A HREF>) or O (for <OPTION>).
24cbe8af 1185function parseWikiLink ($line, $which, $strip_optgroup = FALSE)
83ba6670 1186{
010231c2 1187 if (preg_match ('/^\[\[.+\]\]$/', $line) == 0)
24cbe8af
DO
1188 {
1189 if ($strip_optgroup)
f0b540a3 1190 return ereg_replace ('^.+%GSKIP%', '', ereg_replace ('^(.+)%GPASS%', '\\1 ', $line));
24cbe8af
DO
1191 else
1192 return $line;
1193 }
010231c2
DO
1194 $line = preg_replace ('/^\[\[(.+)\]\]$/', '$1', $line);
1195 $s = explode ('|', $line);
83ba6670 1196 $o_value = trim ($s[0]);
24cbe8af 1197 if ($strip_optgroup)
f0b540a3 1198 $o_value = ereg_replace ('^.+%GSKIP%', '', ereg_replace ('^(.+)%GPASS%', '\\1 ', $o_value));
83ba6670
DO
1199 $a_value = trim ($s[1]);
1200 if ($which == 'a')
010231c2 1201 return "<a href='${a_value}'>${o_value}</a>";
83ba6670
DO
1202 if ($which == 'o')
1203 return $o_value;
1204}
1205
2de490b7
DO
1206function buildVServiceName ($vsinfo = NULL)
1207{
1208 if ($vsinfo == NULL)
1209 {
1210 showError ('NULL argument', __FUNCTION__);
1211 return NULL;
1212 }
8d790216 1213 return $vsinfo['vip'] . ':' . $vsinfo['vport'] . '/' . $vsinfo['proto'];
2de490b7
DO
1214}
1215
05411ccd
DO
1216function buildRSPoolName ($rspool = NULL)
1217{
1218 if ($rspool == NULL)
1219 {
1220 showError ('NULL argument', __FUNCTION__);
1221 return NULL;
1222 }
1223 return strlen ($rspool['name']) ? $rspool['name'] : 'ANONYMOUS pool';
1224}
1225
177b1e9b
DO
1226// rackspace usage for a single rack
1227// (T + W + U) / (height * 3 - A)
11df133a 1228function getRSUforRack ($data = NULL)
177b1e9b 1229{
11df133a 1230 if ($data == NULL)
177b1e9b
DO
1231 {
1232 showError ('Invalid argument', __FUNCTION__);
1233 return NULL;
1234 }
6ffba290 1235 $counter = array ('A' => 0, 'U' => 0, 'T' => 0, 'W' => 0, 'F' => 0);
9e60f7df
DO
1236 for ($unit_no = $data['height']; $unit_no > 0; $unit_no--)
1237 for ($locidx = 0; $locidx < 3; $locidx++)
1238 $counter[$data[$unit_no][$locidx]['state']]++;
dfa3c075 1239 return ($counter['T'] + $counter['W'] + $counter['U']) / ($counter['T'] + $counter['W'] + $counter['U'] + $counter['F']);
177b1e9b
DO
1240}
1241
11df133a
DO
1242// Same for row.
1243function getRSUforRackRow ($rowData = NULL)
1244{
bb26a59e 1245 if ($rowData === NULL)
11df133a
DO
1246 {
1247 showError ('Invalid argument', __FUNCTION__);
1248 return NULL;
1249 }
bb26a59e
DO
1250 if (!count ($rowData))
1251 return 0;
11df133a 1252 $counter = array ('A' => 0, 'U' => 0, 'T' => 0, 'W' => 0, 'F' => 0);
f81a2012 1253 $total_height = 0;
dfa3c075
DO
1254 foreach (array_keys ($rowData) as $rack_id)
1255 {
1256 $data = getRackData ($rack_id);
1257 $total_height += $data['height'];
11df133a
DO
1258 for ($unit_no = $data['height']; $unit_no > 0; $unit_no--)
1259 for ($locidx = 0; $locidx < 3; $locidx++)
1260 $counter[$data[$unit_no][$locidx]['state']]++;
dfa3c075
DO
1261 }
1262 return ($counter['T'] + $counter['W'] + $counter['U']) / ($counter['T'] + $counter['W'] + $counter['U'] + $counter['F']);
11df133a
DO
1263}
1264
f1a0477d
DO
1265function getObjectCount ($rackData)
1266{
1267 $objects = array();
1268 for ($i = $rackData['height']; $i > 0; $i--)
1269 for ($locidx = 0; $locidx < 3; $locidx++)
1270 if
1271 (
1272 $rackData[$i][$locidx]['state'] == 'T' and
1273 !in_array ($rackData[$i][$locidx]['object_id'], $objects)
1274 )
1275 $objects[] = $rackData[$i][$locidx]['object_id'];
1276 return count ($objects);
1277}
1278
9af110b4
DO
1279// Perform substitutions and return resulting string
1280function apply_macros ($macros, $subject)
1281{
1282 $ret = $subject;
1283 foreach ($macros as $search => $replace)
1284 $ret = str_replace ($search, $replace, $ret);
1285 return $ret;
1286}
1287
1288// Make sure the string is always wrapped with LF characters
1289function lf_wrap ($str)
1290{
1291 $ret = trim ($str, "\r\n");
1292 if (!empty ($ret))
1293 $ret .= "\n";
1294 return $ret;
1295}
1296
e6e7d8b3
DO
1297// Adopted from Mantis BTS code.
1298function string_insert_hrefs ($s)
1299{
1300 if (getConfigVar ('DETECT_URLS') != 'yes')
1301 return $s;
1302 # Find any URL in a string and replace it by a clickable link
1303 $s = preg_replace( '/(([[:alpha:]][-+.[:alnum:]]*):\/\/(%[[:digit:]A-Fa-f]{2}|[-_.!~*\';\/?%^\\\\:@&={\|}+$#\(\),\[\][:alnum:]])+)/se',
1304 "'<a href=\"'.rtrim('\\1','.').'\">\\1</a> [<a href=\"'.rtrim('\\1','.').'\" target=\"_blank\">^</a>]'",
1305 $s);
1306 $s = preg_replace( '/\b' . email_regex_simple() . '\b/i',
1307 '<a href="mailto:\0">\0</a>',
1308 $s);
1309 return $s;
1310}
1311
1312// Idem.
1313function email_regex_simple ()
1314{
1315 return "(([a-z0-9!#*+\/=?^_{|}~-]+(?:\.[a-z0-9!#*+\/=?^_{|}~-]+)*)" . # recipient
1316 "\@((?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?))"; # @domain
1317}
1318
118e4c38
DO
1319// Parse AUTOPORTS_CONFIG and return a list of generated pairs (port_type, port_name)
1320// for the requested object_type_id.
1321function getAutoPorts ($type_id)
1322{
1323 $ret = array();
1324 $typemap = explode (';', str_replace (' ', '', getConfigVar ('AUTOPORTS_CONFIG')));
1325 foreach ($typemap as $equation)
1326 {
1327 $tmp = explode ('=', $equation);
1328 if (count ($tmp) != 2)
1329 continue;
1330 $objtype_id = $tmp[0];
1331 if ($objtype_id != $type_id)
1332 continue;
1333 $portlist = $tmp[1];
1334 foreach (explode ('+', $portlist) as $product)
1335 {
1336 $tmp = explode ('*', $product);
1337 if (count ($tmp) != 3)
1338 continue;
1339 $nports = $tmp[0];
1340 $port_type = $tmp[1];
1341 $format = $tmp[2];
1342 for ($i = 0; $i < $nports; $i++)
1343 $ret[] = array ('type' => $port_type, 'name' => @sprintf ($format, $i));
1344 }
1345 }
1346 return $ret;
1347}
1348
9dfd4cc9
DO
1349// Find if a particular tag id exists on the tree, then attach the
1350// given child tag to it. If the parent tag doesn't exist, return FALSE.
1351function attachChildTag (&$tree, $parent_id, $child_id, $child_info)
1352{
1353 foreach ($tree as $tagid => $taginfo)
1354 {
1355 if ($tagid == $parent_id)
1356 {
1357 $tree[$tagid]['kids'][$child_id] = $child_info;
1358 return TRUE;
1359 }
1360 elseif (attachChildTag ($tree[$tagid]['kids'], $parent_id, $child_id, $child_info))
1361 return TRUE;
1362 }
1363 return FALSE;
1364}
1365
1366// Build a tree from the tag list and return it.
1367function getTagTree ()
1368{
20c901a7
DO
1369 global $taglist;
1370 $mytaglist = $taglist;
1371 $ret = array();
1372 while (count ($mytaglist) > 0)
9dfd4cc9
DO
1373 {
1374 $picked = FALSE;
20c901a7 1375 foreach ($mytaglist as $tagid => $taginfo)
9dfd4cc9
DO
1376 {
1377 $taginfo['kids'] = array();
1378 if ($taginfo['parent_id'] == NULL)
1379 {
20c901a7 1380 $ret[$tagid] = $taginfo;
9dfd4cc9 1381 $picked = TRUE;
20c901a7 1382 unset ($mytaglist[$tagid]);
9dfd4cc9 1383 }
20c901a7 1384 elseif (attachChildTag ($ret, $taginfo['parent_id'], $tagid, $taginfo))
9dfd4cc9
DO
1385 {
1386 $picked = TRUE;
20c901a7 1387 unset ($mytaglist[$tagid]);
9dfd4cc9
DO
1388 }
1389 }
1390 if (!$picked) // Only orphaned items on the list.
1391 break;
1392 }
20c901a7 1393 return $ret;
9dfd4cc9
DO
1394}
1395
49fb1027
DO
1396// Build a tree from the tag list and return everything _except_ the tree.
1397function getOrphanedTags ()
1398{
1399 global $taglist;
1400 $mytaglist = $taglist;
1401 $dummy = array();
1402 while (count ($mytaglist) > 0)
1403 {
1404 $picked = FALSE;
1405 foreach ($mytaglist as $tagid => $taginfo)
1406 {
1407 $taginfo['kids'] = array();
1408 if ($taginfo['parent_id'] == NULL)
1409 {
1410 $dummy[$tagid] = $taginfo;
1411 $picked = TRUE;
1412 unset ($mytaglist[$tagid]);
1413 }
1414 elseif (attachChildTag ($dummy, $taginfo['parent_id'], $tagid, $taginfo))
1415 {
1416 $picked = TRUE;
1417 unset ($mytaglist[$tagid]);
1418 }
1419 }
1420 if (!$picked) // Only orphaned items on the list.
1421 return $mytaglist;
1422 }
1423 return array();
1424}
1425
e2ac59cf 1426function serializeTags ($trail, $baseurl = '')
ba93bd98
DO
1427{
1428 $comma = '';
1429 $ret = '';
1430 foreach ($trail as $taginfo)
1431 {
e2ac59cf
DO
1432 $ret .= $comma .
1433 ($baseurl == '' ? '' : "<a href='${baseurl}tagfilter[]=${taginfo['id']}'>") .
1434 $taginfo['tag'] .
1435 ($baseurl == '' ? '' : '</a>');
ba93bd98
DO
1436 $comma = ', ';
1437 }
1438 return $ret;
1439}
1440
ab379543 1441// a helper for getTrailExpansion()
ba93bd98
DO
1442function traceTrail ($tree, $trail)
1443{
1444 // For each tag find its path from the root, then combine items
1445 // of all paths and add them to the trail, if they aren't there yet.
1446 $ret = array();
1447 foreach ($tree as $taginfo1)
1448 {
1449 $hit = FALSE;
1450 foreach ($trail as $taginfo2)
1451 if ($taginfo1['id'] == $taginfo2['id'])
1452 {
1453 $hit = TRUE;
1454 break;
1455 }
1456 if (count ($taginfo1['kids']) > 0)
1457 {
1458 $subsearch = traceTrail ($taginfo1['kids'], $trail);
1459 if (count ($subsearch))
1460 {
1461 $hit = TRUE;
1462 $ret = array_merge ($ret, $subsearch);
1463 }
1464 }
1465 if ($hit)
1466 $ret[] = $taginfo1;
1467 }
1468 return $ret;
1469}
1470
1471// For each tag add all its parent tags onto the list. Don't expect anything
1472// except user's tags on the trail.
1473function getTrailExpansion ($trail)
1474{
20c901a7
DO
1475 global $tagtree;
1476 return traceTrail ($tagtree, $trail);
ba93bd98
DO
1477}
1478
1479// Return the list of missing implicit tags.
1480function getImplicitTags ($oldtags)
1481{
1482 $ret = array();
1483 $newtags = getTrailExpansion ($oldtags);
1484 foreach ($newtags as $newtag)
1485 {
1486 $already_exists = FALSE;
1487 foreach ($oldtags as $oldtag)
1488 if ($newtag['id'] == $oldtag['id'])
1489 {
1490 $already_exists = TRUE;
1491 break;
1492 }
1493 if ($already_exists)
1494 continue;
d6089951 1495 $ret[] = array ('id' => $newtag['id'], 'tag' => $newtag['tag'], 'parent_id' => $newtag['parent_id']);
ba93bd98
DO
1496 }
1497 return $ret;
1498}
1499
ab379543
DO
1500// Minimize the trail: exclude all implicit tags and return the resulting trail.
1501function getExplicitTagsOnly ($trail, $tree = NULL)
1502{
20c901a7 1503 global $tagtree;
ab379543 1504 if ($tree === NULL)
20c901a7 1505 $tree = $tagtree;
ab379543
DO
1506 $ret = array();
1507 foreach ($tree as $taginfo)
1508 {
1509 if (isset ($taginfo['kids']))
1510 {
1511 $harvest = getExplicitTagsOnly ($trail, $taginfo['kids']);
1512 if (count ($harvest) > 0)
1513 {
1514 $ret = array_merge ($ret, $harvest);
1515 continue;
1516 }
1517 }
1518 // This tag isn't implicit, test is for being explicit.
1519 foreach ($trail as $testtag)
1520 if ($taginfo['id'] == $testtag['id'])
1521 {
1522 $ret[] = $testtag;
1523 break;
1524 }
1525 }
1526 return $ret;
1527}
1528
74ccacff
DO
1529// Maximize the trail: for each tag add all tags, for which it is direct or indirect parent.
1530// Unlike other functions, this one accepts and returns a list of integer tag IDs, not
1531// a list of tag structures.
1532function complementByKids ($idlist, $tree = NULL, $getall = FALSE)
1533{
20c901a7 1534 global $tagtree;
74ccacff 1535 if ($tree === NULL)
20c901a7 1536 $tree = $tagtree;
74ccacff
DO
1537 $getallkids = $getall;
1538 $ret = array();
1539 foreach ($tree as $taginfo)
1540 {
1541 foreach ($idlist as $test_id)
1542 if ($getall or $taginfo['id'] == $test_id)
1543 {
1544 $ret[] = $taginfo['id'];
1545 // Once matched node makes all sub-nodes match, but don't make
1546 // a mistake of matching every other node at the current level.
1547 $getallkids = TRUE;
1548 break;
1549 }
1550 if (isset ($taginfo['kids']))
1551 $ret = array_merge ($ret, complementByKids ($idlist, $taginfo['kids'], $getallkids));
1552 $getallkids = FALSE;
1553 }
1554 return $ret;
1555}
1556
2fb24351 1557function loadRackObjectAutoTags()
ba93bd98 1558{
2c6c7645 1559 assertUIntArg ('object_id', __FUNCTION__);
2fb24351
DO
1560 $object_id = $_REQUEST['object_id'];
1561 $oinfo = getObjectInfo ($object_id);
1562 $ret = array();
1563 $ret[] = array ('tag' => '$id_' . $_REQUEST['object_id']);
d817ba03 1564 $ret[] = array ('tag' => '$any_object');
2fb24351
DO
1565 return $ret;
1566}
1567
f9bc186f
DO
1568function loadIPv4PrefixAutoTags()
1569{
2c6c7645 1570 assertUIntArg ('id', __FUNCTION__);
41bd8c87 1571 $subnet = getIPRange ($_REQUEST['id']);
f9bc186f
DO
1572 $ret = array();
1573 $ret[] = array ('tag' => '$id_' . $_REQUEST['id']);
41bd8c87 1574 $ret[] = array ('tag' => '$ipv4net-' . str_replace ('.', '-', $subnet['ip']) . '-' . $subnet['mask']);
d817ba03
DO
1575 // FIXME: find and list tags for all parent networks
1576 $ret[] = array ('tag' => '$any_ipv4net');
1577 $ret[] = array ('tag' => '$any_net');
41bd8c87
DO
1578 return $ret;
1579}
1580
1581function loadRackAutoTags()
1582{
2c6c7645 1583 assertUIntArg ('rack_id', __FUNCTION__);
41bd8c87
DO
1584 $ret = array();
1585 $ret[] = array ('tag' => '$id_' . $_REQUEST['rack_id']);
d817ba03
DO
1586 $ret[] = array ('tag' => '$any_rack');
1587 return $ret;
1588}
1589
1590function loadIPv4AddressAutoTags()
1591{
2c6c7645 1592 assertIPv4Arg ('ip', __FUNCTION__);
d817ba03
DO
1593 $ret = array();
1594 $ret[] = array ('tag' => '$ipv4net-' . str_replace ('.', '-', $subnet['ip']) . '-32');
1595 // FIXME: find and list tags for all parent networks
1596 $ret[] = array ('tag' => '$any_ipv4net');
1597 $ret[] = array ('tag' => '$any_net');
1598 return $ret;
1599}
1600
1601function loadIPv4VSAutoTags()
1602{
2c6c7645 1603 assertUIntArg ('id', __FUNCTION__);
d817ba03
DO
1604 $ret = array();
1605 $ret[] = array ('tag' => '$id_' . $_REQUEST['id']);
1606 $ret[] = array ('tag' => '$any_ipv4vs');
1607 $ret[] = array ('tag' => '$any_vs');
1608 return $ret;
1609}
1610
1611function loadIPv4RSPoolAutoTags()
1612{
2c6c7645 1613 assertUIntArg ('pool_id', __FUNCTION__);
d817ba03 1614 $ret = array();
6aff02cf 1615 $ret[] = array ('tag' => '$id_' . $_REQUEST['pool_id']);
d817ba03
DO
1616 $ret[] = array ('tag' => '$any_ipv4rspool');
1617 $ret[] = array ('tag' => '$any_rspool');
f9bc186f
DO
1618 return $ret;
1619}
1620
2fb24351
DO
1621function getGlobalAutoTags()
1622{
1623 global $remote_username, $accounts;
1624 $ret = array();
1625 $user_id = 0;
1626 foreach ($accounts as $a)
1627 if ($a['user_name'] == $remote_username)
1628 {
1629 $user_id = $a['user_id'];
1630 break;
1631 }
1632 $ret[] = array ('tag' => '$username_' . $remote_username);
1633 $ret[] = array ('tag' => '$userid_' . $user_id);
1634 return $ret;
ba93bd98
DO
1635}
1636
ab379543
DO
1637// Build a tag trail from supplied tag id list and return it.
1638function buildTrailFromIds ($tagidlist)
1639{
20c901a7 1640 global $taglist;
ab379543
DO
1641 $ret = array();
1642 foreach ($tagidlist as $tag_id)
1643 if (isset ($taglist[$tag_id]))
1644 $ret[] = $taglist[$tag_id];
1645 return $ret;
1646}
1647
7cc02fc1
DO
1648// Process a given tag tree and return only meaningful branches. The resulting
1649// (sub)tree will have refcnt leaves on every last branch.
1650function getObjectiveTagTree ($tree, $realm)
1651{
1652 $ret = array();
1653 foreach ($tree as $taginfo)
1654 {
1655 $subsearch = array();
1656 $pick = FALSE;
1657 if (count ($taginfo['kids']))
1658 {
1659 $subsearch = getObjectiveTagTree ($taginfo['kids'], $realm);
1660 $pick = count ($subsearch) > 0;
1661 }
5bdc04ec 1662 if (isset ($taginfo['refcnt'][$realm]))
7cc02fc1
DO
1663 $pick = TRUE;
1664 if (!$pick)
1665 continue;
1666 $ret[] = array
1667 (
1668 'id' => $taginfo['id'],
1669 'tag' => $taginfo['tag'],
1670 'parent_id' => $taginfo['parent_id'],
1671 'refcnt' => $taginfo['refcnt'],
1672 'kids' => $subsearch
1673 );
1674 }
1675 return $ret;
1676}
1677
a0d54e7e 1678function getTagFilter ()
7cc02fc1 1679{
a0d54e7e 1680 return isset ($_REQUEST['tagfilter']) ? complementByKids ($_REQUEST['tagfilter']) : array();
7cc02fc1
DO
1681}
1682
a0d54e7e 1683function getTagFilterStr ($tagfilter = array())
932cf41f 1684{
a0d54e7e 1685 $ret = '';
a0d54e7e
DO
1686 foreach (getExplicitTagsOnly (buildTrailFromIds ($tagfilter)) as $taginfo)
1687 $ret .= "&tagfilter[]=" . $taginfo['id'];
1688 return $ret;
932cf41f 1689}
a0d54e7e 1690
e673ee24 1691?>