RackTables git mirrors - racktables/blob - inc/functions.php

   1 <?php
   2 /*
   3 *
   4 *  This file is a library of computational functions for RackTables.
   5 *
   6 */
   7
   8 $loclist[0] = 'front';
   9 $loclist[1] = 'interior';
  10 $loclist[2] = 'rear';
  11 $loclist['front'] = 0;
  12 $loclist['interior'] = 1;
  13 $loclist['rear'] = 2;
  14 $template[0] = array (TRUE, TRUE, TRUE);
  15 $template[1] = array (TRUE, TRUE, FALSE);
  16 $template[2] = array (FALSE, TRUE, TRUE);
  17 $template[3] = array (TRUE, FALSE, FALSE);
  18 $template[4] = array (FALSE, TRUE, FALSE);
  19 $template[5] = array (FALSE, FALSE, TRUE);
  20 $templateWidth[0] = 3;
  21 $templateWidth[1] = 2;
  22 $templateWidth[2] = 2;
  23 $templateWidth[3] = 1;
  24 $templateWidth[4] = 1;
  25 $templateWidth[5] = 1;
  26
  27 // 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.
  30 function displayedName ($objectData)
  31 {
  32         if ($objectData['name'] != '')
  33                 return $objectData['name'];
  34         elseif (in_array ($objectData['objtype_id'], explode (',', getConfigVar ('NAMEFUL_OBJTYPES'))))
  35                 return "ANONYMOUS " . $objectData['objtype_name'];
  36         else
  37                 return "[${objectData['objtype_name']}]";
  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.
  43 function 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;
  60                                 if ($rackData[$startRow - $height][$locidx]['state'] != 'T')
  61                                         break 2;
  62                                 if ($object_id == 0)
  63                                         $object_id = $rackData[$startRow - $height][$locidx]['object_id'];
  64                                 if ($object_id != $rackData[$startRow - $height][$locidx]['object_id'])
  65                                         break 2;
  66                         }
  67                 }
  68                 // If the first row can't offer anything, bail out.
  69                 if ($height == 0 and $object_id == 0)
  70                         break;
  71                 $height++;
  72         }
  73         while ($startRow - $height > 0);
  74 //      echo "for startRow==${startRow} and template==(${template[0]}, ${template[1]}, ${template[2]}) height==${height}<br>\n";
  75         return $height;
  76 }
  77
  78 // This function marks atoms to be avoided by rectHeight() and assigns rowspan/colspan
  79 // attributes.
  80 function markSpan (&$rackData, $startRow, $maxheight, $template_idx)
  81 {
  82         global $template, $templateWidth;
  83         $colspan = 0;
  84         for ($height = 0; $height < $maxheight; $height++)
  85         {
  86                 for ($locidx = 0; $locidx < 3; $locidx++)
  87                 {
  88                         if ($template[$template_idx][$locidx])
  89                         {
  90                                 // Add colspan/rowspan to the first row met and mark the following ones to skip.
  91                                 if ($colspan != 0)
  92                                         $rackData[$startRow - $height][$locidx]['skipped'] = TRUE;
  93                                 else
  94                                 {
  95                                         $colspan = $templateWidth[$template_idx];
  96                                         if ($colspan > 1)
  97                                                 $rackData[$startRow - $height][$locidx]['colspan'] = $colspan;
  98                                         if ($maxheight > 1)
  99                                                 $rackData[$startRow - $height][$locidx]['rowspan'] = $maxheight;
 100                                 }
 101                         }
 102                 }
 103         }
 104         return;
 105 }
 106
 107 // This function finds rowspan/solspan/skipped atom attributes for renderRack()
 108 // What we actually have to do is to find all possible rectangles for each objects
 109 // and then find the widest of those with the maximal square.
 110 function markAllSpans (&$rackData = NULL)
 111 {
 112         if ($rackData == NULL)
 113         {
 114                 showError ('Invalid rackData in markAllSpans()');
 115                 return;
 116         }
 117         for ($i = $rackData['height']; $i > 0; $i--)
 118         {
 119                 // calculate height of 6 possible span templates (array is presorted by width descending)
 120                 global $template;
 121                 for ($j = 0; $j < 6; $j++)
 122                         $height[$j] = rectHeight ($rackData, $i, $j);
 123                 // find the widest rectangle of those with maximal height
 124                 $maxheight = max ($height);
 125                 if ($maxheight > 0)
 126                 {
 127                         $best_template_index = 0;
 128                         for ($j = 0; $j < 6; $j++)
 129                                 if ($height[$j] == $maxheight)
 130                                 {
 131                                         $best_template_index = $j;
 132                                         break;
 133                                 }
 134                         // distribute span marks
 135                         markSpan ($rackData, $i, $maxheight, $best_template_index);
 136                 }
 137         }
 138 }
 139
 140 function delRow ($row_id = 0)
 141 {
 142         if ($row_id == 0)
 143         {
 144                 showError ('Not all required args to delRow() are present.');
 145                 return;
 146         }
 147         if (!isset ($_REQUEST['confirmed']) || $_REQUEST['confirmed'] != 'true')
 148         {
 149                 echo "Press <a href='?op=del_row&row_id=${row_id}&confirmed=true'>here</a> to confirm rack row deletion.";
 150                 return;
 151         }
 152         global $dbxlink;
 153         echo 'Deleting rack row information: ';
 154         $result = $dbxlink->query ("update RackRow set deleted = 'yes' where id=${row_id} limit 1");
 155         if ($result->rowCount() != 1)
 156         {
 157                 showError ('Marked ' . $result.rowCount() . ' rows as deleted, but expected 1');
 158                 return;
 159         }
 160         echo 'OK<br>';
 161         recordHistory ('RackRow', "id = ${row_id}");
 162         echo "Information was deleted. You may return to <a href='?op=list_rows&editmode=on'>rack row list</a>.";
 163 }
 164
 165 function delRack ($rack_id = 0)
 166 {
 167         if ($rack_id == 0)
 168         {
 169                 showError ('Not all required args to delRack() are present.');
 170                 return;
 171         }
 172         if (!isset ($_REQUEST['confirmed']) || $_REQUEST['confirmed'] != 'true')
 173         {
 174                 echo "Press <a href='?op=del_rack&rack_id=${rack_id}&confirmed=true'>here</a> to confirm rack deletion.";
 175                 return;
 176         }
 177         global $dbxlink;
 178         echo 'Deleting rack information: ';
 179         $result = $dbxlink->query ("update Rack set deleted = 'yes' where id=${rack_id} limit 1");
 180         if ($result->rowCount() != 1)
 181         {
 182                 showError ('Marked ' . $result.rowCount() . ' rows as deleted, but expected 1');
 183                 return;
 184         }
 185         echo 'OK<br>';
 186         recordHistory ('Rack', "id = ${rack_id}");
 187         echo "Information was deleted. You may return to <a href='?op=list_racks&editmode=on'>rack list</a>.";
 188 }
 189
 190 function delObject ($object_id = 0)
 191 {
 192         if ($object_id == 0)
 193         {
 194                 showError ('Not all required args to delObject() are present.');
 195                 return;
 196         }
 197         if (!isset ($_REQUEST['confirmed']) || $_REQUEST['confirmed'] != 'true')
 198         {
 199                 echo "Press <a href='?op=del_object&object_id=${object_id}&confirmed=true'>here</a> to confirm object deletion.";
 200                 return;
 201         }
 202         global $dbxlink;
 203         echo 'Deleting object information: ';
 204         $result = $dbxlink->query ("update RackObject set deleted = 'yes' where id=${object_id} limit 1");
 205         if ($result->rowCount() != 1)
 206         {
 207                 showError ('Marked ' . $result.rowCount() . ' rows as deleted, but expected 1');
 208                 return;
 209         }
 210         echo 'OK<br>';
 211         recordHistory ('RackObject', "id = ${object_id}");
 212         echo "Information was deleted. You may return to <a href='?op=list_objects&editmode=on'>object list</a>.";
 213 }
 214
 215 // We can mount 'F' atoms and unmount our own 'T' atoms.
 216 function applyObjectMountMask (&$rackData, $object_id)
 217 {
 218         for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
 219                 for ($locidx = 0; $locidx < 3; $locidx++)
 220                         switch ($rackData[$unit_no][$locidx]['state'])
 221                         {
 222                                 case 'F':
 223                                         $rackData[$unit_no][$locidx]['enabled'] = TRUE;
 224                                         break;
 225                                 case 'T':
 226                                         $rackData[$unit_no][$locidx]['enabled'] = ($rackData[$unit_no][$locidx]['object_id'] == $object_id);
 227                                         break;
 228                                 default:
 229                                         $rackData[$unit_no][$locidx]['enabled'] = FALSE;
 230                         }
 231 }
 232
 233 // Design change means transition between 'F' and 'A' and back.
 234 function applyRackDesignMask (&$rackData)
 235 {
 236         for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
 237                 for ($locidx = 0; $locidx < 3; $locidx++)
 238                         switch ($rackData[$unit_no][$locidx]['state'])
 239                         {
 240                                 case 'F':
 241                                 case 'A':
 242                                         $rackData[$unit_no][$locidx]['enabled'] = TRUE;
 243                                         break;
 244                                 default:
 245                                         $rackData[$unit_no][$locidx]['enabled'] = FALSE;
 246                         }
 247 }
 248
 249 // The same for 'F' and 'U'.
 250 function applyRackProblemMask (&$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 'U':
 258                                         $rackData[$unit_no][$locidx]['enabled'] = TRUE;
 259                                         break;
 260                                 default:
 261                                         $rackData[$unit_no][$locidx]['enabled'] = FALSE;
 262                         }
 263 }
 264
 265 // This mask should allow toggling 'T' and 'W' on object's rackspace.
 266 function applyObjectProblemMask (&$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 'T':
 273                                 case 'W':
 274                                         $rackData[$unit_no][$locidx]['enabled'] = ($rackData[$unit_no][$locidx]['object_id'] == $object_id);
 275                                         break;
 276                                 default:
 277                                         $rackData[$unit_no][$locidx]['enabled'] = FALSE;
 278                         }
 279 }
 280
 281 // This function highlights specified object (and removes previous highlight).
 282 function highlightObject (&$rackData, $object_id)
 283 {
 284         for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
 285                 for ($locidx = 0; $locidx < 3; $locidx++)
 286                         if
 287                         (
 288                                 $rackData[$unit_no][$locidx]['state'] == 'T' and
 289                                 $rackData[$unit_no][$locidx]['object_id'] == $object_id
 290                         )
 291                                 $rackData[$unit_no][$locidx]['hl'] = 'h';
 292                         else
 293                                 unset ($rackData[$unit_no][$locidx]['hl']);
 294 }
 295
 296 // This function marks atoms to selected or not depending on their current state.
 297 function markupAtomGrid (&$data, $checked_state)
 298 {
 299         for ($unit_no = $data['height']; $unit_no > 0; $unit_no--)
 300                 for ($locidx = 0; $locidx < 3; $locidx++)
 301                 {
 302                         if (!($data[$unit_no][$locidx]['enabled'] === TRUE))
 303                                 continue;
 304                         if ($data[$unit_no][$locidx]['state'] == $checked_state)
 305                                 $data[$unit_no][$locidx]['checked'] = ' checked';
 306                         else
 307                                 $data[$unit_no][$locidx]['checked'] = '';
 308                 }
 309 }
 310
 311 // This function is almost a clone of processGridForm(), but doesn't save anything to database
 312 // Return value is the changed rack data.
 313 // Here we assume that correct filter has already been applied, so we just
 314 // set or unset checkbox inputs w/o changing atom state.
 315 function mergeGridFormToRack (&$rackData)
 316 {
 317         $rack_id = $rackData['id'];
 318         for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
 319                 for ($locidx = 0; $locidx < 3; $locidx++)
 320                 {
 321                         if ($rackData[$unit_no][$locidx]['enabled'] != TRUE)
 322                                 continue;
 323                         $inputname = "atom_${rack_id}_${unit_no}_${locidx}";
 324                         if (isset ($_REQUEST[$inputname]) and $_REQUEST[$inputname] == 'on')
 325                                 $rackData[$unit_no][$locidx]['checked'] = ' checked';
 326                         else
 327                                 $rackData[$unit_no][$locidx]['checked'] = '';
 328                 }
 329 }
 330
 331 function binMaskFromDec ($maskL)
 332 {
 333         $binmask=0;
 334         for ($i=0; $i<$maskL; $i++)
 335         {
 336                 $binmask*=2;
 337                 $binmask+=1;
 338         }
 339         for ($i=$maskL; $i<32; $i++)
 340         {
 341                 $binmask*=2;
 342         }
 343         return $binmask;
 344 }
 345
 346 function binInvMaskFromDec ($maskL)
 347 {
 348         $binmask=0;
 349         for ($i=0; $i<$maskL; $i++)
 350         {
 351                 $binmask*=2;
 352         }
 353         for ($i=$maskL; $i<32; $i++)
 354         {
 355                 $binmask*=2;
 356                 $binmask+=1;
 357         }
 358         return $binmask;
 359 }
 360
 361 function addRange ($range='', $name='', $is_bcast = FALSE)
 362 {
 363         // $range is in x.x.x.x/x format, split into ip/mask vars
 364         $rangeArray = explode('/', $range);
 365         $ip = $rangeArray[0];
 366         $mask = $rangeArray[1];
 367
 368         $ipL = ip2long($ip);
 369         $maskL = ip2long($mask);
 370         if ($ipL == -1 || $ipL === FALSE)
 371                 return 'Bad ip address';
 372         if ($mask < 32 && $mask > 0)
 373                 $maskL = $mask;
 374         else
 375         {
 376                 $maskB = decbin($maskL);
 377                 if (strlen($maskB)!=32)
 378                         return 'Bad mask';
 379                 $ones=0;
 380                 $zeroes=FALSE;
 381                 foreach( str_split ($maskB) as $digit)
 382                 {
 383                         if ($digit == '0')
 384                                 $zeroes = TRUE;
 385                         if ($digit == '1')
 386                         {
 387                                 $ones++;
 388                                 if ($zeroes == TRUE)
 389                                         return 'Bad mask';
 390                         }
 391                 }
 392                 $maskL = $ones;
 393         }
 394         $binmask = binMaskFromDec($maskL);
 395         $ipL = $ipL & $binmask;
 396
 397         $query =
 398                 "select ".
 399                 "id, ip, mask, name ".
 400                 "from IPRanges ";
 401
 402
 403         global $dbxlink;
 404
 405         $result = $dbxlink->query ($query);
 406
 407         while ($row = $result->fetch (PDO::FETCH_ASSOC))
 408         {
 409                 $otherip = $row['ip'];
 410                 $othermask = binMaskFromDec($row['mask']);
 411 //              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";
 412 //              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";
 413 //              echo "\n";
 414 //              flush();
 415                 if (($otherip & $othermask) == ($ipL & $othermask))
 416                         return "This subnet intersects with ".long2ip($row['ip'])."/${row['mask']}";
 417                 if (($otherip & $binmask) == ($ipL & $binmask))
 418                         return "This subnet intersects with ".long2ip($row['ip'])."/${row['mask']}";
 419         }
 420         $result->closeCursor();
 421         $query =
 422                 "insert into IPRanges set ip=".sprintf('%u', $ipL).", mask='$maskL', name='$name'";
 423         $result = $dbxlink->exec ($query);
 424
 425         if ($is_bcast and $maskL < 31)
 426         {
 427                 $network_addr = long2ip ($ipL);
 428                 $broadcast_addr = long2ip ($ipL | binInvMaskFromDec ($maskL));
 429                 updateAddress ($network_addr, 'network', 'yes');
 430                 updateAddress ($broadcast_addr, 'broadcast', 'yes');
 431         }
 432         return '';
 433 }
 434
 435 function getIPRange ($id = 0)
 436 {
 437         global $dbxlink;
 438         $query =
 439                 "select ".
 440                 "id as IPRanges_id, ".
 441                 "INET_NTOA(ip) as IPRanges_ip, ".
 442                 "mask as IPRanges_mask, ".
 443                 "name as IPRanges_name ".
 444                 "from IPRanges ".
 445                 "where id = '$id'";
 446         $result = $dbxlink->query ($query);
 447         if ($result == NULL)
 448                 return NULL;
 449         $ret = array();
 450         $row = $result->fetch (PDO::FETCH_ASSOC);
 451         if ($row == NULL)
 452                 return $ret;
 453         $ret['id'] = $row['IPRanges_id'];
 454         $ret['ip'] = $row['IPRanges_ip'];
 455         $ret['ip_bin'] = ip2long ($row['IPRanges_ip']);
 456         $ret['mask_bin'] = binMaskFromDec($row['IPRanges_mask']);
 457         $ret['mask_bin_inv'] = binInvMaskFromDec($row['IPRanges_mask']);
 458         $ret['name'] = $row['IPRanges_name'];
 459         $ret['mask'] = $row['IPRanges_mask'];
 460         $ret['addrlist'] = array();
 461         $result->closeCursor();
 462         // We risk losing some significant bits in an unsigned 32bit integer,
 463         // unless it is converted to a string.
 464         $db_first = "'" . sprintf ('%u', 0x00000000 + $ret['ip_bin'] & $ret['mask_bin']) . "'";
 465         $db_last  = "'" . sprintf ('%u', 0x00000000 + $ret['ip_bin'] | ($ret['mask_bin_inv'])) . "'";
 466
 467         // Don't try to build up the whole structure in a single pass. Request
 468         // the list of user comments and reservations and merge allocations in
 469         // at a latter point.
 470         $query =
 471                 "select INET_NTOA(ip) as ip, name, reserved from IPAddress " .
 472                 "where ip between ${db_first} and ${db_last} " .
 473                 "and (reserved = 'yes' or name != '')";
 474         $ipa_res = $dbxlink->query ($query);
 475         if ($ipa_res == NULL)
 476                 return $ret;
 477         while ($row = $ipa_res->fetch (PDO::FETCH_ASSOC))
 478         {
 479                 $ip_bin = ip2long ($row['ip']);
 480                 $ret['addrlist'][$ip_bin] = $row;
 481                 $tmp = array();
 482                 foreach (array ('ip', 'name', 'reserved') as $cname)
 483                         $tmp[$cname] = $row[$cname];
 484                 $tmp['references'] = array();
 485                 $ret['addrlist'][$ip_bin] = $tmp;
 486         }
 487         $ipa_res->closeCursor();
 488
 489         $query =
 490                 "select INET_NTOA(ipb.ip) as ip, ro.id as object_id, " .
 491                 "ro.name as object_name, ipb.name, ipb.type, objtype_id, " .
 492                 "dict_value as objtype_name from " .
 493                 "IPBonds as ipb inner join RackObject as ro on ipb.object_id = ro.id " .
 494                 "left join Dictionary on objtype_id=dict_key natural join Chapter " .
 495                 "where ip between ${db_first} and ${db_last} " .
 496                 "and chapter_name = 'RackObjectType'" .
 497                 "order by ipb.type, object_name";
 498         $ipb_res = $dbxlink->query ($query);
 499         while ($row = $ipb_res->fetch (PDO::FETCH_ASSOC))
 500         {
 501                 $ip_bin = ip2long ($row['ip']);
 502                 if (!isset ($ret['addrlist'][$ip_bin]))
 503                 {
 504                         $ret['addrlist'][$ip_bin] = array();
 505                         $ret['addrlist'][$ip_bin]['ip'] = $row['ip'];
 506                         $ret['addrlist'][$ip_bin]['name'] = '';
 507                         $ret['addrlist'][$ip_bin]['reserved'] = 'no';
 508                         $ret['addrlist'][$ip_bin]['references'] = array();
 509                 }
 510                 $tmp = array();
 511                 foreach (array ('object_id', 'type', 'name') as $cname)
 512                         $tmp[$cname] = $row[$cname];
 513                 $quasiobject['name'] = $row['object_name'];
 514                 $quasiobject['objtype_id'] = $row['objtype_id'];
 515                 $quasiobject['objtype_name'] = $row['objtype_name'];
 516                 $tmp['object_name'] = displayedName ($quasiobject);
 517                 $ret['addrlist'][$ip_bin]['references'][] = $tmp;
 518         }
 519         $ipb_res->closeCursor();
 520
 521         return $ret;
 522 }
 523
 524 // Don't require any records in IPAddress, but if there is one,
 525 // merge the data between getting allocation list. Collect enough data
 526 // to call displayedName() ourselves.
 527 function getIPAddress ($ip=0)
 528 {
 529         $ret = array();
 530         $ret['bonds'] = array();
 531         $ret['outpf'] = array();
 532         $ret['inpf'] = array();
 533         $ret['exists'] = 0;
 534         $ret['name'] = '';
 535         $ret['reserved'] = 'no';
 536         global $dbxlink;
 537         $query =
 538                 "select ".
 539                 "name, reserved ".
 540                 "from IPAddress ".
 541                 "where ip = INET_ATON('$ip') and (reserved = 'yes' or name != '')";
 542         $result = $dbxlink->query ($query);
 543         if ($result == NULL)
 544                 return NULL;
 545         if ($row = $result->fetch (PDO::FETCH_ASSOC))
 546         {
 547                 $ret['exists'] = 1;
 548                 $ret['name'] = $row['name'];
 549                 $ret['reserved'] = $row['reserved'];
 550         }
 551         $result->closeCursor();
 552
 553         $query =
 554                 "select ".
 555                 "IPBonds.object_id as object_id, ".
 556                 "IPBonds.name as name, ".
 557                 "IPBonds.type as type, ".
 558                 "objtype_id, dict_value as objtype_name, " .
 559                 "RackObject.name as object_name ".
 560                 "from IPBonds join RackObject on IPBonds.object_id=RackObject.id ".
 561                 "left join Dictionary on objtype_id=dict_key natural join Chapter " .
 562                 "where IPBonds.ip=INET_ATON('$ip') ".
 563                 "and chapter_name = 'RackObjectType' " .
 564                 "order by RackObject.id, IPBonds.name";
 565         $result = $dbxlink->query ($query);
 566         $count=0;
 567         while ($row = $result->fetch (PDO::FETCH_ASSOC))
 568         {
 569                 $ret['bonds'][$count]['object_id'] = $row['object_id'];
 570                 $ret['bonds'][$count]['name'] = $row['name'];
 571                 $ret['bonds'][$count]['type'] = $row['type'];
 572                 $qo = array();
 573                 $qo['name'] = $row['object_name'];
 574                 $qo['objtype_id'] = $row['objtype_id'];
 575                 $qo['objtype_name'] = $row['objtype_name'];
 576                 $ret['bonds'][$count]['object_name'] = displayedName ($qo);
 577                 $count++;
 578                 $ret['exists'] = 1;
 579         }
 580         $result->closeCursor();
 581
 582         return $ret;
 583 }
 584
 585 function bindIpToObject ($ip='', $object_id=0, $name='', $type='')
 586 {
 587         global $dbxlink;
 588
 589         $range = getRangeByIp($ip);
 590         if (!$range)
 591                 return 'Non-existant ip address. Try adding IP range first';
 592
 593         $result = useInsertBlade
 594         (
 595                 'IPBonds',
 596                 array
 597                 (
 598                         'ip' => "INET_ATON('$ip')",
 599                         'object_id' => "'${object_id}'",
 600                         'name' => "'${name}'",
 601                         'type' => "'${type}'"
 602                 )
 603         );
 604         return $result ? '' : 'useInsertBlade() failed in bindIpToObject()';
 605 }
 606
 607 // This function looks up 'has_problems' flag for 'T' atoms
 608 // and modifies 'hl' key. May be, this should be better done
 609 // in getRackData(). We don't honour 'skipped' key, because
 610 // the function is also used for thumb creation.
 611 function markupObjectProblems (&$rackData)
 612 {
 613         for ($i = $rackData['height']; $i > 0; $i--)
 614                 for ($locidx = 0; $locidx < 3; $locidx++)
 615                         if ($rackData[$i][$locidx]['state'] == 'T')
 616                         {
 617                                 $object = getObjectInfo ($rackData[$i][$locidx]['object_id']);
 618                                 if ($object['has_problems'] == 'yes')
 619                                 {
 620                                         // Object can be already highlighted.
 621                                         if (isset ($rackData[$i][$locidx]['hl']))
 622                                                 $rackData[$i][$locidx]['hl'] = $rackData[$i][$locidx]['hl'] . 'w';
 623                                         else
 624                                                 $rackData[$i][$locidx]['hl'] = 'w';
 625                                 }
 626                         }
 627 }
 628
 629 function search_cmpObj ($a, $b)
 630 {
 631         return ($a['score'] > $b['score'] ? -1 : 1);
 632 }
 633
 634 // This function performs search and then calculates score for each result.
 635 // Given previous search results in $objects argument, it adds new results
 636 // to the array and updates score for existing results, if it is greater than
 637 // existing score.
 638 function mergeSearchResults (&$objects, $terms, $fieldname)
 639 {
 640         global $dbxlink;
 641         $query =
 642                 "select name, label, asset_no, barcode, ro.id, dict_key as objtype_id, " .
 643                 "dict_value as objtype_name, asset_no from RackObject as ro inner join Dictionary " .
 644                 "on objtype_id = dict_key natural join Chapter where chapter_name = 'RackObjectType' and ";
 645         $count = 0;
 646         foreach (explode (' ', $terms) as $term)
 647         {
 648                 if ($count) $query .= ' or ';
 649                 $query .= "${fieldname} like '%$term%'";
 650                 $count++;
 651         }
 652         $query .= "";
 653         $result = $dbxlink->query($query);
 654         if ($result == NULL)
 655         {
 656                 showError ("SQL query failed in mergeSearchResults()");
 657                 return NULL;
 658         }
 659 // FIXME: this dead call was executed 4 times per 1 object search!
 660 //      $typeList = getObjectTypeList();
 661         $clist = array ('id', 'name', 'label', 'asset_no', 'barcode', 'objtype_id', 'objtype_name');
 662         while ($row = $result->fetch(PDO::FETCH_ASSOC))
 663         {
 664                 foreach ($clist as $cname)
 665                         $object[$cname] = $row[$cname];
 666                 $object['score'] = 0;
 667                 $object['dname'] = displayedName ($object);
 668                 unset ($object['objtype_id']);
 669                 foreach (explode (' ', $terms) as $term)
 670                         if (strstr ($object['name'], $term))
 671                                 $object['score'] += 1;
 672                 unset ($object['name']);
 673                 if (!isset ($objects[$row['id']]))
 674                         $objects[$row['id']] = $object;
 675                 elseif ($objects[$row['id']]['score'] < $object['score'])
 676                         $objects[$row['id']]['score'] = $object['score'];
 677         }
 678         return $objects;
 679 }
 680
 681 function getSearchResults ($terms)
 682 {
 683         $objects = array();
 684         mergeSearchResults ($objects, $terms, 'name');
 685         mergeSearchResults ($objects, $terms, 'label');
 686         mergeSearchResults ($objects, $terms, 'asset_no');
 687         mergeSearchResults ($objects, $terms, 'barcode');
 688         if (count ($objects) == 1)
 689                 usort ($objects, 'search_cmpObj');
 690         return $objects;
 691 }
 692
 693 // This function removes all colons and dots from a string.
 694 function l2addressForDatabase ($string)
 695 {
 696         if (empty ($string))
 697                 return 'NULL';
 698         $pieces = explode (':', $string);
 699         // This workaround is for SunOS ifconfig.
 700         foreach ($pieces as &$byte)
 701                 if (strlen ($byte) == 1)
 702                         $byte = '0' . $byte;
 703         // And this workaround is for PHP.
 704         unset ($byte);
 705         $string = implode ('', $pieces);
 706         $pieces = explode ('.', $string);
 707         $string = implode ('', $pieces);
 708         $string = strtoupper ($string);
 709         return "'$string'";
 710 }
 711
 712 function l2addressFromDatabase ($string)
 713 {
 714         switch (strlen ($string))
 715         {
 716                 case 12: // Ethernet
 717                 case 16: // FireWire
 718                         $ret = implode (':', str_split ($string, 2));
 719                         break;
 720                 default:
 721                         $ret = $string;
 722                         break;
 723         }
 724         return $ret;
 725 }
 726
 727 // The following 2 functions return previous and next rack IDs for
 728 // a given rack ID. The order of racks is the same as in renderRackspace()
 729 // or renderRow().
 730 function getPrevIDforRack ($row_id = 0, $rack_id = 0)
 731 {
 732         if ($row_id <= 0 or $rack_id <= 0)
 733         {
 734                 showError ('Invalid arguments passed to getPrevIDforRack()');
 735                 return NULL;
 736         }
 737         $rackList = getRacksForRow ($row_id);
 738         doubleLink ($rackList);
 739         if (isset ($rackList[$rack_id]['prev_key']))
 740                 return $rackList[$rack_id]['prev_key'];
 741         return NULL;
 742 }
 743
 744 function getNextIDforRack ($row_id = 0, $rack_id = 0)
 745 {
 746         if ($row_id <= 0 or $rack_id <= 0)
 747         {
 748                 showError ('Invalid arguments passed to getNextIDforRack()');
 749                 return NULL;
 750         }
 751         $rackList = getRacksForRow ($row_id);
 752         doubleLink ($rackList);
 753         if (isset ($rackList[$rack_id]['next_key']))
 754                 return $rackList[$rack_id]['next_key'];
 755         return NULL;
 756 }
 757
 758 // This function finds previous and next array keys for each array key and
 759 // modifies its argument accordingly.
 760 function doubleLink (&$array)
 761 {
 762         $prev_key = NULL;
 763         foreach (array_keys ($array) as $key)
 764         {
 765                 if ($prev_key)
 766                 {
 767                         $array[$key]['prev_key'] = $prev_key;
 768                         $array[$prev_key]['next_key'] = $key;
 769                 }
 770                 $prev_key = $key;
 771         }
 772 }
 773
 774 // After applying usort() to a rack list we will lose original array keys.
 775 // This function restores the keys so they are equal to rack IDs.
 776 function restoreRackIDs ($racks)
 777 {
 778         $ret = array();
 779         foreach ($racks as $rack)
 780                 $ret[$rack['id']] = $rack;
 781         return $ret;
 782 }
 783
 784 function sortTokenize ($a, $b)
 785 {
 786         $aold='';
 787         while ($a != $aold)
 788         {
 789                 $aold=$a;
 790                 $a = ereg_replace('[^a-zA-Z0-9]',' ',$a);
 791                 $a = ereg_replace('([0-9])([a-zA-Z])','\\1 \\2',$a);
 792                 $a = ereg_replace('([a-zA-Z])([0-9])','\\1 \\2',$a);
 793         }
 794
 795         $bold='';
 796         while ($b != $bold)
 797         {
 798                 $bold=$b;
 799                 $b = ereg_replace('[^a-zA-Z0-9]',' ',$b);
 800                 $b = ereg_replace('([0-9])([a-zA-Z])','\\1 \\2',$b);
 801                 $b = ereg_replace('([a-zA-Z])([0-9])','\\1 \\2',$b);
 802         }
 803
 804
 805
 806         $ar = explode(' ', $a);
 807         $br = explode(' ', $b);
 808         for ($i=0; $i<count($ar) && $i<count($br); $i++)
 809         {
 810                 $ret = 0;
 811                 if (is_numeric($ar[$i]) and is_numeric($br[$i]))
 812                         $ret = ($ar[$i]==$br[$i])?0:($ar[$i]<$br[$i]?-1:1);
 813                 else
 814                         $ret = strcasecmp($ar[$i], $br[$i]);
 815                 if ($ret != 0)
 816                         return $ret;
 817         }
 818         if ($i<count($ar))
 819                 return 1;
 820         if ($i<count($br))
 821                 return -1;
 822         return 0;
 823 }
 824
 825 function sortByName ($a, $b)
 826 {
 827         return sortTokenize($a['name'], $b['name']);
 828 }
 829
 830 function sortRacks ($a, $b)
 831 {
 832         return sortTokenize($a['row_name'] . ': ' . $a['name'], $b['row_name'] . ': ' . $b['name']);
 833 }
 834
 835 function eq ($a, $b)
 836 {
 837         return $a==$b;
 838 }
 839
 840 function neq ($a, $b)
 841 {
 842         return $a!=$b;
 843 }
 844
 845 function countRefsOfType ($refs, $type, $eq)
 846 {
 847         $count=0;
 848         foreach ($refs as $ref)
 849         {
 850                 if ($eq($ref['type'], $type))
 851                         $count++;
 852         }
 853         return $count;
 854 }
 855
 856 function sortEmptyPorts ($a, $b)
 857 {
 858         $objname_cmp = sortTokenize($a['Object_name'], $b['Object_name']);
 859         if ($objname_cmp == 0)
 860         {
 861                 return sortTokenize($a['Port_name'], $b['Port_name']);
 862         }
 863         return $objname_cmp;
 864 }
 865
 866 function sortObjectAddressesAndNames ($a, $b)
 867 {
 868         $objname_cmp = sortTokenize($a['object_name'], $b['object_name']);
 869         if ($objname_cmp == 0)
 870         {
 871                 $objname_cmp = sortTokenize($a['port_name'], $b['port_name']);
 872                 if ($objname_cmp == 0)
 873                 {
 874                         sortTokenize($a['ip'], $b['ip']);
 875                 }
 876                 return $objname_cmp;
 877         }
 878         return $objname_cmp;
 879 }
 880
 881
 882
 883 function sortAddresses ($a, $b)
 884 {
 885         $name_cmp = sortTokenize($a['name'], $b['name']);
 886         if ($name_cmp == 0)
 887         {
 888                 return sortTokenize($a['ip'], $b['ip']);
 889         }
 890         return $name_cmp;
 891 }
 892
 893 // This function expands port compat list into a matrix.
 894 function buildPortCompatMatrixFromList ($portTypeList, $portCompatList)
 895 {
 896         $matrix = array();
 897         // Create type matrix and markup compatible types.
 898         foreach (array_keys ($portTypeList) as $type1)
 899                 foreach (array_keys ($portTypeList) as $type2)
 900                         $matrix[$type1][$type2] = FALSE;
 901         foreach ($portCompatList as $pair)
 902                 $matrix[$pair['type1']][$pair['type2']] = TRUE;
 903         return $matrix;
 904 }
 905
 906 function newPortForwarding($object_id, $localip, $localport, $remoteip, $remoteport, $proto, $description)
 907 {
 908         global $dbxlink;
 909
 910         $range = getRangeByIp($localip);
 911         if (!$range)
 912                 return "$localip: Non existant ip";
 913
 914         $range = getRangeByIp($remoteip);
 915         if (!$range)
 916                 return "$remoteip: Non existant ip";
 917
 918         if ( ($localport <= 0) or ($localport >= 65536) )
 919                 return "$localport: invaild port";
 920
 921         if ( ($remoteport <= 0) or ($remoteport >= 65536) )
 922                 return "$remoteport: invaild port";
 923
 924         $query =
 925                 "insert into PortForwarding set object_id='$object_id', localip=INET_ATON('$localip'), remoteip=INET_ATON('$remoteip'), localport='$localport', remoteport='$remoteport', proto='$proto', description='$description'";
 926         $result = $dbxlink->exec ($query);
 927
 928         return '';
 929 }
 930
 931 function deletePortForwarding($object_id, $localip, $localport, $remoteip, $remoteport, $proto)
 932 {
 933         global $dbxlink;
 934
 935         $query =
 936                 "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'";
 937         $result = $dbxlink->exec ($query);
 938         return '';
 939 }
 940
 941 function updatePortForwarding($object_id, $localip, $localport, $remoteip, $remoteport, $proto, $description)
 942 {
 943         global $dbxlink;
 944
 945         $query =
 946                 "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'";
 947         $result = $dbxlink->exec ($query);
 948         return '';
 949 }
 950
 951 function getObjectForwards($object_id)
 952 {
 953         global $dbxlink;
 954
 955         $ret = array();
 956         $ret['out'] = array();
 957         $ret['in'] = array();
 958         $query =
 959                 "select ".
 960                 "dict_value as proto, ".
 961                 "proto as proto_bin, ".
 962                 "INET_NTOA(localip) as localip, ".
 963                 "localport, ".
 964                 "INET_NTOA(remoteip) as remoteip, ".
 965                 "remoteport, ".
 966                 "ipa1.name as local_addr_name, " .
 967                 "ipa2.name as remote_addr_name, " .
 968                 "description ".
 969                 "from PortForwarding inner join Dictionary on proto = dict_key natural join Chapter ".
 970                 "left join IPAddress as ipa1 on PortForwarding.localip = ipa1.ip " .
 971                 "left join IPAddress as ipa2 on PortForwarding.remoteip = ipa2.ip " .
 972                 "where object_id='$object_id' and chapter_name = 'Protocols' ".
 973                 "order by localip, localport, proto, remoteip, remoteport";
 974         $result2 = $dbxlink->query ($query);
 975         $count=0;
 976         while ($row = $result2->fetch (PDO::FETCH_ASSOC))
 977         {
 978                 foreach (array ('proto', 'proto_bin', 'localport', 'localip', 'remoteport', 'remoteip', 'description', 'local_addr_name', 'remote_addr_name') as $cname)
 979                         $ret['out'][$count][$cname] = $row[$cname];
 980                 $count++;
 981         }
 982         $result2->closeCursor();
 983
 984         $query =
 985                 "select ".
 986                 "dict_value as proto, ".
 987                 "proto as proto_bin, ".
 988                 "INET_NTOA(localip) as localip, ".
 989                 "localport, ".
 990                 "INET_NTOA(remoteip) as remoteip, ".
 991                 "remoteport, ".
 992                 "PortForwarding.object_id as object_id, ".
 993                 "RackObject.name as object_name, ".
 994                 "description ".
 995                 "from ((PortForwarding join IPBonds on remoteip=IPBonds.ip) join RackObject on PortForwarding.object_id=RackObject.id) inner join Dictionary on proto = dict_key natural join Chapter ".
 996                 "where IPBonds.object_id='$object_id' and chapter_name = 'Protocols' ".
 997                 "order by remoteip, remoteport, proto, localip, localport";
 998         $result3 = $dbxlink->query ($query);
 999         $count=0;
1000         while ($row = $result3->fetch (PDO::FETCH_ASSOC))
1001         {
1002                 foreach (array ('proto', 'proto_bin', 'localport', 'localip', 'remoteport', 'remoteip', 'object_id', 'object_name', 'description') as $cname)
1003                         $ret['in'][$count][$cname] = $row[$cname];
1004                 $count++;
1005         }
1006         $result3->closeCursor();
1007
1008         return $ret;
1009 }
1010
1011 // This function returns an array of single element of object's FQDN attribute,
1012 // if FQDN is set. The next choice is object's common name, if it looks like a
1013 // hostname. Otherwise an array of all 'regular' IP addresses of the
1014 // object is returned (which may appear 0 and more elements long).
1015 function findAllEndpoints ($object_id, $fallback = '')
1016 {
1017         $values = getAttrValues ($object_id);
1018         foreach ($values as $record)
1019                 if ($record['name'] == 'FQDN' && !empty ($record['value']))
1020                         return array ($record['value']);
1021         $addresses = getObjectAddresses ($object_id);
1022         $regular = array();
1023         foreach ($addresses as $idx => $address)
1024                 if ($address['type'] == 'regular')
1025                         $regular[] = $address['ip'];
1026         if (!count ($regular) && !empty ($fallback))
1027                 return array ($fallback);
1028         return $regular;
1029 }
1030
1031 // Some records in the dictionary may be written as plain text or as Wiki
1032 // link in the following syntax:
1033 // 1. word
1034 // 2. [[word URL]] // FIXME: this isn't working
1035 // 3. [[word word word | URL]]
1036 // This function parses the line and returns text suitable for either A
1037 // (rendering <A HREF>) or O (for <OPTION>).
1038 function parseWikiLink ($line, $which)
1039 {
1040         if (preg_match ('/^\[\[.+\]\]$/', $line) == 0)
1041                 return $line;
1042         $line = preg_replace ('/^\[\[(.+)\]\]$/', '$1', $line);
1043         $s = explode ('|', $line);
1044         $o_value = trim ($s[0]);
1045         $a_value = trim ($s[1]);
1046         if ($which == 'a')
1047                 return "<a href='${a_value}'>${o_value}</a>";
1048         if ($which == 'o')
1049                 return $o_value;
1050 }
1051
1052 function buildVServiceName ($vsinfo = NULL)
1053 {
1054         if ($vsinfo == NULL)
1055         {
1056                 showError ('NULL argument', __FUNCTION__);
1057                 return NULL;
1058         }
1059         return $vsinfo['vip'] . ':' . $vsinfo['vport'] . '/' . $vsinfo['proto'];
1060 }
1061
1062 ?>