acf62ad94fb610028b7ba3fdf42f454fa41666a8
[racktables] / inc / database.php
1 <?php
2 /*
3 *
4 * This file is a library of database access functions for RackTables.
5 *
6 */
7
8 $SQLSchema = array
9 (
10 'object' => array
11 (
12 'table' => 'RackObject',
13 'columns' => array
14 (
15 'id' => 'id',
16 'name' => 'name',
17 'label' => 'label',
18 'barcode' => 'barcode',
19 'asset_no' => 'asset_no',
20 'objtype_id' => 'objtype_id',
21 'rack_id' => '(select rack_id from RackSpace where object_id = id order by rack_id asc limit 1)',
22 'Rack_name' => '(select name from Rack where id = rack_id)',
23 'row_id' => '(select row_id from Rack where id = rack_id)',
24 'Row_name' => '(select name from RackRow where id = row_id)',
25 'objtype_name' => '(select dict_value from Dictionary where dict_key = objtype_id)',
26 'has_problems' => 'has_problems',
27 ),
28 'keycolumn' => 'id',
29 'ordcolumns' => array ('name'),
30 ),
31 'user' => array
32 (
33 'table' => 'UserAccount',
34 'columns' => array
35 (
36 'user_id' => 'user_id',
37 'user_name' => 'user_name',
38 'user_password_hash' => 'user_password_hash',
39 'user_realname' => 'user_realname',
40 ),
41 'keycolumn' => 'user_id',
42 'ordcolumns' => array ('user_name'),
43 ),
44 'ipv4net' => array
45 (
46 'table' => 'IPv4Network',
47 'columns' => array
48 (
49 'id' => 'id',
50 'ip' => 'INET_NTOA(IPv4Network.ip)',
51 'mask' => 'mask',
52 'name' => 'name',
53 ),
54 'keycolumn' => 'id',
55 'ordcolumns' => array ('ip', 'mask'),
56 ),
57 'file' => array
58 (
59 'table' => 'File',
60 'columns' => array
61 (
62 'id' => 'id',
63 'name' => 'name',
64 'type' => 'type',
65 'size' => 'size',
66 'ctime' => 'ctime',
67 'mtime' => 'mtime',
68 'atime' => 'atime',
69 'comment' => 'comment',
70 ),
71 'keycolumn' => 'id',
72 'ordcolumns' => array ('name'),
73 ),
74 'ipv4vs' => array
75 (
76 'table' => 'IPv4VS',
77 'columns' => array
78 (
79 'id' => 'id',
80 'vip' => 'INET_NTOA(vip)',
81 'vport' => 'vport',
82 'proto' => 'proto',
83 'name' => 'name',
84 'vsconfig' => 'vsconfig',
85 'rsconfig' => 'rsconfig',
86 'poolcount' => '(select count(vs_id) from IPv4LB where vs_id = id)',
87 'dname' => 'CONCAT_WS("/", CONCAT_WS(":", INET_NTOA(vip), vport), proto)',
88 ),
89 'keycolumn' => 'id',
90 'ordcolumns' => array ('vip', 'proto', 'vport'),
91 ),
92 'ipv4rspool' => array
93 (
94 'table' => 'IPv4RSPool',
95 'columns' => array
96 (
97 'id' => 'id',
98 'name' => 'name',
99 'refcnt' => '(select count(rspool_id) from IPv4LB where rspool_id = id)',
100 'rscount' => '(select count(rspool_id) from IPv4RS where rspool_id = IPv4RSPool.id)',
101 'vsconfig' => 'vsconfig',
102 'rsconfig' => 'rsconfig',
103 ),
104 'keycolumn' => 'id',
105 'ordcolumns' => array ('name', 'id'),
106 ),
107 'rack' => array
108 (
109 'table' => 'Rack',
110 'columns' => array
111 (
112 'id' => 'id',
113 'name' => 'name',
114 'height' => 'height',
115 'comment' => 'comment',
116 'row_id' => 'row_id',
117 'row_name' => '(select name from RackRow where RackRow.id = row_id)',
118 ),
119 'keycolumn' => 'id',
120 'ordcolumns' => array ('row_id', 'name'),
121 'pidcolumn' => 'row_id',
122 ),
123 );
124
125 function isInnoDBSupported ($dbh = FALSE) {
126 global $dbxlink;
127
128 // sometimes db handle isn't available globally, must be passed
129 if (!$dbxlink)
130 $dbxlink = $dbh;
131
132 // create a temp table
133 $dbxlink->query("CREATE TABLE `innodb_test` (`id` int) ENGINE=InnoDB");
134 $row = $dbxlink->query("SHOW TABLE STATUS LIKE 'innodb_test'")->fetch(PDO::FETCH_ASSOC);
135 $dbxlink->query("DROP TABLE `innodb_test`");
136 if ($row['Engine'] == 'InnoDB')
137 return TRUE;
138
139 return FALSE;
140 }
141
142 function escapeString ($value, $do_db_escape = TRUE)
143 {
144 $ret = htmlspecialchars ($value, ENT_QUOTES, 'UTF-8');
145 if ($do_db_escape)
146 {
147 global $dbxlink;
148 $ret = substr ($dbxlink->quote ($ret), 1, -1);
149 }
150 return $ret;
151 }
152
153 // Return detailed information about one rack row.
154 function getRackRowInfo ($rackrow_id)
155 {
156 $query =
157 "select RackRow.id as id, RackRow.name as name, count(Rack.id) as count, " .
158 "if(isnull(sum(Rack.height)),0,sum(Rack.height)) as sum " .
159 "from RackRow left join Rack on Rack.row_id = RackRow.id " .
160 "where RackRow.id = ${rackrow_id} " .
161 "group by RackRow.id";
162 $result = useSelectBlade ($query, __FUNCTION__);
163 if ($row = $result->fetch (PDO::FETCH_ASSOC))
164 return $row;
165 else
166 return NULL;
167 }
168
169 function getRackRows ()
170 {
171 $query = "select id, name from RackRow ";
172 $result = useSelectBlade ($query, __FUNCTION__);
173 $rows = array();
174 while ($row = $result->fetch (PDO::FETCH_ASSOC))
175 $rows[$row['id']] = $row['name'];
176 $result->closeCursor();
177 asort ($rows);
178 return $rows;
179 }
180
181 function commitAddRow($rackrow_name)
182 {
183 return useInsertBlade('RackRow', array('name'=>"'$rackrow_name'"));
184 }
185
186 function commitUpdateRow($rackrow_id, $rackrow_name)
187 {
188 global $dbxlink;
189 $query = "update RackRow set name = '${rackrow_name}' where id=${rackrow_id}";
190 $result = $dbxlink->query ($query);
191 if ($result == NULL)
192 {
193 showError ("SQL query '${query}' failed", __FUNCTION__);
194 return FALSE;
195 }
196 $result->closeCursor();
197 return TRUE;
198 }
199
200 function commitDeleteRow($rackrow_id)
201 {
202 global $dbxlink;
203 $query = "select count(*) from Rack where row_id=${rackrow_id}";
204 $result = $dbxlink->query ($query);
205 if (($result!=NULL) && ($row = $result->fetch(PDO::FETCH_NUM)) )
206 {
207 if ($row[0] == 0)
208 {
209 $query = "delete from RackRow where id=${rackrow_id}";
210 $result = $dbxlink->query ($query);
211 if ($result == NULL)
212 {
213 showError ("SQL query '${query}' failed", __FUNCTION__);
214 return FALSE;
215 }
216 }
217 }
218 else
219 {
220 showError ("SQL query '${query}' failed", __FUNCTION__);
221 return FALSE;
222 }
223 $result->closeCursor();
224 return TRUE;
225 }
226
227 // This function returns id->name map for all object types. The map is used
228 // to build <select> input for objects.
229 function getObjectTypeList ()
230 {
231 return readChapter ('RackObjectType');
232 }
233
234 // Return a simple object list w/o related information, so that the returned value
235 // can be directly used by printSelect(). An optional argument is the name of config
236 // option with constraint in RackCode.
237 function getNarrowObjectList ($varname = '')
238 {
239 $wideList = listCells ('object');
240 if (strlen ($varname) and strlen (getConfigVar ($varname)))
241 {
242 global $parseCache;
243 if (!isset ($parseCache[$varname]))
244 $parseCache[$varname] = spotPayload (getConfigVar ($varname), 'SYNT_EXPR');
245 if ($parseCache[$varname]['result'] != 'ACK')
246 return array();
247 $wideList = filterCellList ($wideList, $parseCache[$varname]['load']);
248 }
249 $ret = array();
250 foreach ($wideList as $cell)
251 $ret[$cell['id']] = $cell['dname'];
252 return $ret;
253 }
254
255 // For a given realm return a list of entity records, each with
256 // enough information for judgeCell() to execute.
257 function listCells ($realm, $parent_id = 0)
258 {
259 if (!$parent_id)
260 {
261 global $entityCache;
262 if (isset ($entityCache['complete'][$realm]))
263 return $entityCache['complete'][$realm];
264 }
265 global $SQLSchema;
266 if (!isset ($SQLSchema[$realm]))
267 {
268 showError ('invalid arg', __FUNCTION__);
269 return NULL;
270 }
271 $SQLinfo = $SQLSchema[$realm];
272 $query = 'SELECT tag_id';
273 foreach ($SQLinfo['columns'] as $alias => $expression)
274 // Automatically prepend table name to each single column, but leave all others intact.
275 $query .= ', ' . ($alias == $expression ? "${SQLinfo['table']}.${alias}" : "${expression} as ${alias}");
276 $query .= " FROM ${SQLinfo['table']} LEFT JOIN TagStorage on entity_realm = '${realm}' and entity_id = ${SQLinfo['table']}.${SQLinfo['keycolumn']}";
277 if (isset ($SQLinfo['pidcolumn']) and $parent_id)
278 $query .= " WHERE ${SQLinfo['table']}.${SQLinfo['pidcolumn']} = ${parent_id}";
279 $query .= " ORDER BY ";
280 foreach ($SQLinfo['ordcolumns'] as $oc)
281 $query .= "${SQLinfo['table']}.${oc}, ";
282 $query .= " tag_id";
283 $result = useSelectBlade ($query, __FUNCTION__);
284 $ret = array();
285 global $taglist;
286 // Index returned result by the value of key column.
287 while ($row = $result->fetch (PDO::FETCH_ASSOC))
288 {
289 $entity_id = $row[$SQLinfo['keycolumn']];
290 // Init the first record anyway, but store tag only if there is one.
291 if (!isset ($ret[$entity_id]))
292 {
293 $ret[$entity_id] = array ('realm' => $realm);
294 foreach (array_keys ($SQLinfo['columns']) as $alias)
295 $ret[$entity_id][$alias] = $row[$alias];
296 $ret[$entity_id]['etags'] = array();
297 if ($row['tag_id'] != NULL && isset ($taglist[$row['tag_id']]))
298 $ret[$entity_id]['etags'][] = array
299 (
300 'id' => $row['tag_id'],
301 'tag' => $taglist[$row['tag_id']]['tag'],
302 'parent_id' => $taglist[$row['tag_id']]['parent_id'],
303 );
304 }
305 elseif (isset ($taglist[$row['tag_id']]))
306 // Meeting existing key later is always more tags on existing list.
307 $ret[$entity_id]['etags'][] = array
308 (
309 'id' => $row['tag_id'],
310 'tag' => $taglist[$row['tag_id']]['tag'],
311 'parent_id' => $taglist[$row['tag_id']]['parent_id'],
312 );
313 }
314 // Add necessary finish to the list before returning it. Maintain caches.
315 if (!$parent_id)
316 unset ($entityCache['partial'][$realm]);
317 foreach (array_keys ($ret) as $entity_id)
318 {
319 $ret[$entity_id]['etags'] = getExplicitTagsOnly ($ret[$entity_id]['etags']);
320 $ret[$entity_id]['itags'] = getImplicitTags ($ret[$entity_id]['etags']);
321 switch ($realm)
322 {
323 case 'ipv4net':
324 case 'object':
325 $ret[$entity_id]['atags'] = generateEntityAutoTags ($realm, $ret[$entity_id]);
326 break;
327 default:
328 $ret[$entity_id]['atags'] = generateEntityAutoTags ($realm, $entity_id);
329 }
330 switch ($realm)
331 {
332 case 'object':
333 $ret[$entity_id]['dname'] = displayedName ($ret[$entity_id]);
334 break;
335 case 'ipv4net':
336 $ret[$entity_id]['ip_bin'] = ip2long ($ret[$entity_id]['ip']);
337 $ret[$entity_id]['mask_bin'] = binMaskFromDec ($ret[$entity_id]['mask']);
338 $ret[$entity_id]['mask_bin_inv'] = binInvMaskFromDec ($ret[$entity_id]['mask']);
339 $ret[$entity_id]['db_first'] = sprintf ('%u', 0x00000000 + $ret[$entity_id]['ip_bin'] & $ret[$entity_id]['mask_bin']);
340 $ret[$entity_id]['db_last'] = sprintf ('%u', 0x00000000 + $ret[$entity_id]['ip_bin'] | ($ret[$entity_id]['mask_bin_inv']));
341 break;
342 default:
343 break;
344 }
345 if (!$parent_id)
346 $entityCache['complete'][$realm][$entity_id] = $ret[$entity_id];
347 else
348 $entityCache['partial'][$realm][$entity_id] = $ret[$entity_id];
349 }
350 return $ret;
351 }
352
353 // Very much like listCells(), but return only one record requested (or NULL,
354 // if it does not exist).
355 function spotEntity ($realm, $id)
356 {
357 global $entityCache;
358 if (isset ($entityCache['complete'][$realm]))
359 // Emphasize the absence of record, if listCells() has already been called.
360 return (isset ($entityCache['complete'][$realm][$id])) ? $entityCache['complete'][$realm][$id] : NULL;
361 elseif (isset ($entityCache['partial'][$realm][$id]))
362 return $entityCache['partial'][$realm][$id];
363 global $SQLSchema;
364 if (!isset ($SQLSchema[$realm]))
365 {
366 showError ('invalid arg', __FUNCTION__);
367 return NULL;
368 }
369 $SQLinfo = $SQLSchema[$realm];
370 $query = 'SELECT tag_id';
371 foreach ($SQLinfo['columns'] as $alias => $expression)
372 // Automatically prepend table name to each single column, but leave all others intact.
373 $query .= ', ' . ($alias == $expression ? "${SQLinfo['table']}.${alias}" : "${expression} as ${alias}");
374 $query .= " FROM ${SQLinfo['table']} LEFT JOIN TagStorage on entity_realm = '${realm}' and entity_id = ${SQLinfo['table']}.${SQLinfo['keycolumn']}";
375 $query .= " WHERE ${SQLinfo['table']}.${SQLinfo['keycolumn']} = ${id}";
376 $query .= " ORDER BY tag_id";
377 $result = useSelectBlade ($query, __FUNCTION__);
378 $ret = array();
379 global $taglist;
380 while ($row = $result->fetch (PDO::FETCH_ASSOC))
381 if (!isset ($ret['realm']))
382 {
383 $ret = array ('realm' => $realm);
384 foreach (array_keys ($SQLinfo['columns']) as $alias)
385 $ret[$alias] = $row[$alias];
386 $ret['etags'] = array();
387 if ($row['tag_id'] != NULL && isset ($taglist[$row['tag_id']]))
388 $ret['etags'][] = array
389 (
390 'id' => $row['tag_id'],
391 'tag' => $taglist[$row['tag_id']]['tag'],
392 'parent_id' => $taglist[$row['tag_id']]['parent_id'],
393 );
394 }
395 elseif (isset ($taglist[$row['tag_id']]))
396 $ret['etags'][] = array
397 (
398 'id' => $row['tag_id'],
399 'tag' => $taglist[$row['tag_id']]['tag'],
400 'parent_id' => $taglist[$row['tag_id']]['parent_id'],
401 );
402 unset ($result);
403 if (!isset ($ret['realm'])) // no rows were returned
404 return NULL;
405 $ret['etags'] = getExplicitTagsOnly ($ret['etags']);
406 $ret['itags'] = getImplicitTags ($ret['etags']);
407 switch ($realm)
408 {
409 case 'ipv4net':
410 case 'object':
411 $ret['atags'] = generateEntityAutoTags ($realm, $ret);
412 break;
413 default:
414 $ret['atags'] = generateEntityAutoTags ($realm, $id);
415 }
416 switch ($realm)
417 {
418 case 'object':
419 $ret['dname'] = displayedName ($ret);
420 break;
421 case 'ipv4net':
422 $ret['ip_bin'] = ip2long ($ret['ip']);
423 $ret['mask_bin'] = binMaskFromDec ($ret['mask']);
424 $ret['mask_bin_inv'] = binInvMaskFromDec ($ret['mask']);
425 $ret['db_first'] = sprintf ('%u', 0x00000000 + $ret['ip_bin'] & $ret['mask_bin']);
426 $ret['db_last'] = sprintf ('%u', 0x00000000 + $ret['ip_bin'] | ($ret['mask_bin_inv']));
427 break;
428 default:
429 break;
430 }
431 $entityCache['partial'][$realm][$id] = $ret;
432 return $ret;
433 }
434
435 // This function can be used with array_walk().
436 function amplifyCell (&$record, $dummy = NULL)
437 {
438 switch ($record['realm'])
439 {
440 case 'object':
441 $record['ports'] = getObjectPortsAndLinks ($record['id']);
442 $record['ipv4'] = getObjectIPv4Allocations ($record['id']);
443 $record['nat4'] = getNATv4ForObject ($record['id']);
444 $record['ipv4rspools'] = getRSPoolsForObject ($record['id']);
445 $record['files'] = getFilesOfEntity ($record['realm'], $record['id']);
446 break;
447 case 'ipv4net':
448 $record['ip_bin'] = ip2long ($record['ip']);
449 $record['parent_id'] = getIPv4AddressNetworkId ($record['ip'], $record['mask']);
450 break;
451 case 'file':
452 $record['links'] = getFileLinks ($record['id']);
453 break;
454 case 'ipv4rspool':
455 $record['lblist'] = array();
456 $query = "select object_id, vs_id, lb.vsconfig, lb.rsconfig from " .
457 "IPv4LB as lb inner join IPv4VS as vs on lb.vs_id = vs.id " .
458 "where rspool_id = ${record['id']} order by object_id, vip, vport";
459 $result = useSelectBlade ($query, __FUNCTION__);
460 while ($row = $result->fetch (PDO::FETCH_ASSOC))
461 $record['lblist'][$row['object_id']][$row['vs_id']] = array
462 (
463 'rsconfig' => $row['rsconfig'],
464 'vsconfig' => $row['vsconfig'],
465 );
466 unset ($result);
467 $record['rslist'] = array();
468 $query = "select id, inservice, inet_ntoa(rsip) as rsip, rsport, rsconfig from " .
469 "IPv4RS where rspool_id = ${record['id']} order by IPv4RS.rsip, rsport";
470 $result = useSelectBlade ($query, __FUNCTION__);
471 while ($row = $result->fetch (PDO::FETCH_ASSOC))
472 $record['rslist'][$row['id']] = array
473 (
474 'inservice' => $row['inservice'],
475 'rsip' => $row['rsip'],
476 'rsport' => $row['rsport'],
477 'rsconfig' => $row['rsconfig'],
478 );
479 unset ($result);
480 break;
481 case 'ipv4vs':
482 // Get the detailed composition of a particular virtual service, namely the list
483 // of all pools, each shown with the list of objects servicing it. VS/RS configs
484 // will be returned as well.
485 $record['rspool'] = array();
486 $query = "select pool.id, name, pool.vsconfig, pool.rsconfig, object_id, " .
487 "lb.vsconfig as lb_vsconfig, lb.rsconfig as lb_rsconfig from " .
488 "IPv4RSPool as pool left join IPv4LB as lb on pool.id = lb.rspool_id " .
489 "where vs_id = ${record['id']} order by pool.name, object_id";
490 $result = useSelectBlade ($query, __FUNCTION__);
491 while ($row = $result->fetch (PDO::FETCH_ASSOC))
492 {
493 if (!isset ($record['rspool'][$row['id']]))
494 $record['rspool'][$row['id']] = array
495 (
496 'name' => $row['name'],
497 'vsconfig' => $row['vsconfig'],
498 'rsconfig' => $row['rsconfig'],
499 'lblist' => array(),
500 );
501 if ($row['object_id'] == NULL)
502 continue;
503 $record['rspool'][$row['id']]['lblist'][$row['object_id']] = array
504 (
505 'vsconfig' => $row['lb_vsconfig'],
506 'rsconfig' => $row['lb_rsconfig'],
507 );
508 }
509 unset ($result);
510 break;
511 case 'rack':
512 $record['mountedObjects'] = array();
513 // start with default rackspace
514 for ($i = $record['height']; $i > 0; $i--)
515 for ($locidx = 0; $locidx < 3; $locidx++)
516 $record[$i][$locidx]['state'] = 'F';
517 // load difference
518 $query =
519 "select unit_no, atom, state, object_id " .
520 "from RackSpace where rack_id = ${record['id']} and " .
521 "unit_no between 1 and " . $record['height'] . " order by unit_no";
522 $result = useSelectBlade ($query, __FUNCTION__);
523 global $loclist;
524 $mounted_objects = array();
525 while ($row = $result->fetch (PDO::FETCH_ASSOC))
526 {
527 $record[$row['unit_no']][$loclist[$row['atom']]]['state'] = $row['state'];
528 $record[$row['unit_no']][$loclist[$row['atom']]]['object_id'] = $row['object_id'];
529 if ($row['state'] == 'T' and $row['object_id'] != NULL)
530 $mounted_objects[$row['object_id']] = TRUE;
531 }
532 $record['mountedObjects'] = array_keys ($mounted_objects);
533 unset ($result);
534 break;
535 default:
536 }
537 }
538
539 function getPortTypes ()
540 {
541 return readChapter ('PortType');
542 }
543
544 function getObjectPortsAndLinks ($object_id)
545 {
546 // prepare decoder
547 $ptd = readChapter ('PortType');
548 $query = "select id, name, label, l2address, type as type_id, reservation_comment from Port where object_id = ${object_id}";
549 // list and decode all ports of the current object
550 $result = useSelectBlade ($query, __FUNCTION__);
551 $ret=array();
552 while ($row = $result->fetch (PDO::FETCH_ASSOC))
553 {
554 $row['type'] = $ptd[$row['type_id']];
555 $row['l2address'] = l2addressFromDatabase ($row['l2address']);
556 $row['remote_id'] = NULL;
557 $row['remote_name'] = NULL;
558 $row['remote_object_id'] = NULL;
559 $row['remote_object_name'] = NULL;
560 $ret[] = $row;
561 }
562 unset ($result);
563 // now find and decode remote ends for all locally terminated connections
564 // FIXME: can't this data be extracted in one pass with sub-queries?
565 foreach (array_keys ($ret) as $tmpkey)
566 {
567 $portid = $ret[$tmpkey]['id'];
568 $remote_id = NULL;
569 $query = "select porta, portb from Link where porta = {$portid} or portb = ${portid}";
570 $result = useSelectBlade ($query, __FUNCTION__);
571 if ($row = $result->fetch (PDO::FETCH_ASSOC))
572 {
573 if ($portid != $row['porta'])
574 $remote_id = $row['porta'];
575 elseif ($portid != $row['portb'])
576 $remote_id = $row['portb'];
577 }
578 unset ($result);
579 if ($remote_id) // there's a remote end here
580 {
581 $query = "select Port.name as port_name, Port.type as port_type, object_id, RackObject.name as object_name " .
582 "from Port left join RackObject on Port.object_id = RackObject.id " .
583 "where Port.id = ${remote_id}";
584 $result = useSelectBlade ($query, __FUNCTION__);
585 if ($row = $result->fetch (PDO::FETCH_ASSOC))
586 {
587 $ret[$tmpkey]['remote_name'] = $row['port_name'];
588 $ret[$tmpkey]['remote_object_id'] = $row['object_id'];
589 $ret[$tmpkey]['remote_object_name'] = $row['object_name'];
590 }
591 $ret[$tmpkey]['remote_id'] = $remote_id;
592 unset ($result);
593 // only call displayedName() when necessary
594 if (empty ($ret[$tmpkey]['remote_object_name']) and !empty ($ret[$tmpkey]['remote_object_id']))
595 {
596 $oi = spotEntity ('object', $ret[$tmpkey]['remote_object_id']);
597 $ret[$tmpkey]['remote_object_name'] = $oi['dname'];
598 }
599 }
600 }
601 return $ret;
602 }
603
604 function commitAddRack ($name, $height = 0, $row_id = 0, $comment, $taglist)
605 {
606 if ($row_id <= 0 or $height <= 0 or empty ($name))
607 return FALSE;
608 $result = useInsertBlade
609 (
610 'Rack',
611 array
612 (
613 'row_id' => $row_id,
614 'name' => "'${name}'",
615 'height' => $height,
616 'comment' => "'${comment}'"
617 )
618 );
619 if ($result == NULL)
620 {
621 showError ('useInsertBlade() failed', __FUNCTION__);
622 return FALSE;
623 }
624 $last_insert_id = lastInsertID();
625 return (produceTagsForLastRecord ('rack', $taglist, $last_insert_id) == '') and recordHistory ('Rack', "id = ${last_insert_id}");
626 }
627
628 function commitAddObject ($new_name, $new_label, $new_barcode, $new_type_id, $new_asset_no, $taglist = array())
629 {
630 global $dbxlink;
631 // Maintain UNIQUE INDEX for common names and asset tags by
632 // filtering out empty strings (not NULLs).
633 $result1 = useInsertBlade
634 (
635 'RackObject',
636 array
637 (
638 'name' => empty ($new_name) ? 'NULL' : "'${new_name}'",
639 'label' => "'${new_label}'",
640 'barcode' => empty ($new_barcode) ? 'NULL' : "'${new_barcode}'",
641 'objtype_id' => $new_type_id,
642 'asset_no' => empty ($new_asset_no) ? 'NULL' : "'${new_asset_no}'"
643 )
644 );
645 if ($result1 == NULL)
646 {
647 showError ("SQL query #1 failed", __FUNCTION__);
648 return FALSE;
649 }
650 $last_insert_id = lastInsertID();
651 // Do AutoPorts magic
652 executeAutoPorts ($last_insert_id, $new_type_id);
653 // Now tags...
654 $error = produceTagsForLastRecord ('object', $taglist, $last_insert_id);
655 if ($error != '')
656 {
657 showError ("Error adding tags for the object: ${error}");
658 return FALSE;
659 }
660 return recordHistory ('RackObject', "id = ${last_insert_id}");
661 }
662
663 function commitUpdateObject ($object_id = 0, $new_name = '', $new_label = '', $new_barcode = '', $new_type_id = 0, $new_has_problems = 'no', $new_asset_no = '', $new_comment = '')
664 {
665 if ($object_id == 0 || $new_type_id == 0)
666 {
667 showError ('Not all required args are present.', __FUNCTION__);
668 return FALSE;
669 }
670 global $dbxlink;
671 $new_asset_no = empty ($new_asset_no) ? 'NULL' : "'${new_asset_no}'";
672 $new_barcode = empty ($new_barcode) ? 'NULL' : "'${new_barcode}'";
673 $new_name = empty ($new_name) ? 'NULL' : "'${new_name}'";
674 $query = "update RackObject set name=${new_name}, label='${new_label}', barcode=${new_barcode}, objtype_id='${new_type_id}', " .
675 "has_problems='${new_has_problems}', asset_no=${new_asset_no}, comment='${new_comment}' " .
676 "where id='${object_id}' limit 1";
677 $result = $dbxlink->query ($query);
678 if ($result == NULL)
679 {
680 showError ("SQL query '${query}' failed", __FUNCTION__);
681 return FALSE;
682 }
683 $result->closeCursor();
684 return recordHistory ('RackObject', "id = ${object_id}");
685 }
686
687 // There are times when you want to delete all traces of an object
688 function commitDeleteObject ($object_id = 0)
689 {
690 if ($object_id <= 0)
691 {
692 showError ('Invalid args', __FUNCTION__);
693 die;
694 }
695 global $dbxlink;
696 $dbxlink->query("DELETE FROM AttributeValue WHERE object_id = ${object_id}");
697 $dbxlink->query("DELETE FROM File WHERE id IN (SELECT file_id FROM FileLink WHERE entity_id = 'object' AND entity_id = ${object_id})");
698 $dbxlink->query("DELETE FROM IPv4LB WHERE object_id = ${object_id}");
699 $dbxlink->query("DELETE FROM IPv4Allocation WHERE object_id = ${object_id}");
700 $dbxlink->query("DELETE FROM Port WHERE object_id = ${object_id}");
701 $dbxlink->query("DELETE FROM IPv4NAT WHERE object_id = ${object_id}");
702 $dbxlink->query("DELETE FROM RackSpace WHERE object_id = ${object_id}");
703 $dbxlink->query("DELETE FROM TagStorage WHERE entity_realm = 'object' and entity_id = ${object_id}");
704 $dbxlink->query("DELETE FROM Atom WHERE molecule_id IN (SELECT new_molecule_id FROM MountOperation WHERE object_id = ${object_id})");
705 $dbxlink->query("DELETE FROM Molecule WHERE id IN (SELECT new_molecule_id FROM MountOperation WHERE object_id = ${object_id})");
706 $dbxlink->query("DELETE FROM MountOperation WHERE object_id = ${object_id}");
707 $dbxlink->query("DELETE FROM RackObjectHistory WHERE id = ${object_id}");
708 $dbxlink->query("DELETE FROM RackObject WHERE id = ${object_id}");
709
710 return '';
711 }
712
713 function commitDeleteRack($rack_id)
714 {
715 global $dbxlink;
716 $query = "delete from RackSpace where rack_id = '${rack_id}'";
717 $dbxlink->query ($query);
718 $query = "delete from TagStorage where entity_realm='rack' and entity_id='${rack_id}'";
719 $dbxlink->query ($query);
720 $query = "delete from RackHistory where id = '${rack_id}'";
721 $dbxlink->query ($query);
722 $query = "delete from Rack where id = '${rack_id}'";
723 $dbxlink->query ($query);
724 return TRUE;
725 }
726
727 function commitUpdateRack ($rack_id, $new_name, $new_height, $new_row_id, $new_comment)
728 {
729 if (empty ($rack_id) || empty ($new_name) || empty ($new_height))
730 {
731 showError ('Not all required args are present.', __FUNCTION__);
732 return FALSE;
733 }
734 global $dbxlink;
735
736 // Can't shrink a rack if rows being deleted contain mounted objects
737 $check_sql = "SELECT COUNT(*) AS count FROM RackSpace WHERE rack_id = '${rack_id}' AND unit_no > '{$new_height}'";
738 $check_result = $dbxlink->query($check_sql);
739 $check_row = $check_result->fetch (PDO::FETCH_ASSOC);
740 unset ($check_result);
741 if ($check_row['count'] > 0) {
742 showError ('Cannot shrink rack, objects are still mounted there', __FUNCTION__);
743 return FALSE;
744 }
745
746 $update_sql = "update Rack set name='${new_name}', height='${new_height}', comment='${new_comment}', row_id=${new_row_id} " .
747 "where id='${rack_id}' limit 1";
748 $update_result = $dbxlink->query ($update_sql);
749 if ($update_result->rowCount() != 1)
750 {
751 showError ('Error updating rack information', __FUNCTION__);
752 return FALSE;
753 }
754 return recordHistory ('Rack', "id = ${rack_id}");
755 }
756
757 // This function accepts rack data returned by amplifyCell(), validates and applies changes
758 // supplied in $_REQUEST and returns resulting array. Only those changes are examined, which
759 // correspond to current rack ID.
760 // 1st arg is rackdata, 2nd arg is unchecked state, 3rd arg is checked state.
761 // If 4th arg is present, object_id fields will be updated accordingly to the new state.
762 // The function returns the modified rack upon success.
763 function processGridForm (&$rackData, $unchecked_state, $checked_state, $object_id = 0)
764 {
765 global $loclist, $dbxlink;
766 $rack_id = $rackData['id'];
767 $rack_name = $rackData['name'];
768 $rackchanged = FALSE;
769 for ($unit_no = $rackData['height']; $unit_no > 0; $unit_no--)
770 {
771 for ($locidx = 0; $locidx < 3; $locidx++)
772 {
773 if ($rackData[$unit_no][$locidx]['enabled'] != TRUE)
774 continue;
775 // detect a change
776 $state = $rackData[$unit_no][$locidx]['state'];
777 if (isset ($_REQUEST["atom_${rack_id}_${unit_no}_${locidx}"]) and $_REQUEST["atom_${rack_id}_${unit_no}_${locidx}"] == 'on')
778 $newstate = $checked_state;
779 else
780 $newstate = $unchecked_state;
781 if ($state == $newstate)
782 continue;
783 $rackchanged = TRUE;
784 // and validate
785 $atom = $loclist[$locidx];
786 // The only changes allowed are those introduced by checkbox grid.
787 if
788 (
789 !($state == $checked_state && $newstate == $unchecked_state) &&
790 !($state == $unchecked_state && $newstate == $checked_state)
791 )
792 return array ('code' => 500, 'message' => "${rack_name}: Rack ID ${rack_id}, unit ${unit_no}, 'atom ${atom}', cannot change state from '${state}' to '${newstate}'");
793 // Here we avoid using ON DUPLICATE KEY UPDATE by first performing DELETE
794 // anyway and then looking for probable need of INSERT.
795 $query =
796 "delete from RackSpace where rack_id = ${rack_id} and " .
797 "unit_no = ${unit_no} and atom = '${atom}' limit 1";
798 $r = $dbxlink->query ($query);
799 if ($r == NULL)
800 return array ('code' => 500, 'message' => __FUNCTION__ . ": ${rack_name}: SQL DELETE query failed");
801 if ($newstate != 'F')
802 {
803 $query =
804 "insert into RackSpace(rack_id, unit_no, atom, state) " .
805 "values(${rack_id}, ${unit_no}, '${atom}', '${newstate}') ";
806 $r = $dbxlink->query ($query);
807 if ($r == NULL)
808 return array ('code' => 500, 'message' => __FUNCTION__ . ": ${rack_name}: SQL INSERT query failed");
809 }
810 if ($newstate == 'T' and $object_id != 0)
811 {
812 // At this point we already have a record in RackSpace.
813 $query =
814 "update RackSpace set object_id=${object_id} " .
815 "where rack_id=${rack_id} and unit_no=${unit_no} and atom='${atom}' limit 1";
816 $r = $dbxlink->query ($query);
817 if ($r->rowCount() == 1)
818 $rackData[$unit_no][$locidx]['object_id'] = $object_id;
819 else
820 return array ('code' => 500, 'message' => "${rack_name}: Rack ID ${rack_id}, unit ${unit_no}, atom '${atom}' failed to set object_id to '${object_id}'");
821 }
822 }
823 }
824 if ($rackchanged)
825 {
826 resetThumbCache ($rack_id);
827 return array ('code' => 200, 'message' => "${rack_name}: All changes were successfully saved.");
828 }
829 else
830 return array ('code' => 300, 'message' => "${rack_name}: No changes.");
831 }
832
833 // This function builds a list of rack-unit-atom records, which are assigned to
834 // the requested object.
835 function getMoleculeForObject ($object_id = 0)
836 {
837 if ($object_id == 0)
838 {
839 showError ("object_id == 0", __FUNCTION__);
840 return NULL;
841 }
842 $query =
843 "select rack_id, unit_no, atom from RackSpace " .
844 "where state = 'T' and object_id = ${object_id} order by rack_id, unit_no, atom";
845 $result = useSelectBlade ($query, __FUNCTION__);
846 $ret = $result->fetchAll (PDO::FETCH_ASSOC);
847 $result->closeCursor();
848 return $ret;
849 }
850
851 // This function builds a list of rack-unit-atom records for requested molecule.
852 function getMolecule ($mid = 0)
853 {
854 if ($mid == 0)
855 {
856 showError ("mid == 0", __FUNCTION__);
857 return NULL;
858 }
859 $query =
860 "select rack_id, unit_no, atom from Atom " .
861 "where molecule_id=${mid}";
862 $result = useSelectBlade ($query, __FUNCTION__);
863 $ret = $result->fetchAll (PDO::FETCH_ASSOC);
864 $result->closeCursor();
865 return $ret;
866 }
867
868 // returns exactly what is's named after
869 function lastInsertID ()
870 {
871 if (NULL == ($result = useSelectBlade ('select last_insert_id()', __FUNCTION__)))
872 {
873 showError ('SQL query failed!', __FUNCTION__);
874 die;
875 }
876 $row = $result->fetch (PDO::FETCH_NUM);
877 return $row[0];
878 }
879
880 // This function creates a new record in Molecule and number of linked
881 // R-U-A records in Atom.
882 function createMolecule ($molData)
883 {
884 global $dbxlink;
885 $query = "insert into Molecule values()";
886 $result1 = $dbxlink->query ($query);
887 if ($result1->rowCount() != 1)
888 {
889 showError ('Error inserting into Molecule', __FUNCTION__);
890 return NULL;
891 }
892 $molecule_id = lastInsertID();
893 foreach ($molData as $rua)
894 {
895 $rack_id = $rua['rack_id'];
896 $unit_no = $rua['unit_no'];
897 $atom = $rua['atom'];
898 $query =
899 "insert into Atom(molecule_id, rack_id, unit_no, atom) " .
900 "values (${molecule_id}, ${rack_id}, ${unit_no}, '${atom}')";
901 $result3 = $dbxlink->query ($query);
902 if ($result3 == NULL or $result3->rowCount() != 1)
903 {
904 showError ('Error inserting into Atom', __FUNCTION__);
905 return NULL;
906 }
907 }
908 return $molecule_id;
909 }
910
911 // History logger. This function assumes certain table naming convention and
912 // column design:
913 // 1. History table name equals to dictionary table name plus 'History'.
914 // 2. History table must have the same row set (w/o keys) plus one row named
915 // 'ctime' of type 'timestamp'.
916 function recordHistory ($tableName, $whereClause)
917 {
918 global $dbxlink, $remote_username;
919 $query = "insert into ${tableName}History select *, current_timestamp(), '${remote_username}' from ${tableName} where ${whereClause}";
920 $result = $dbxlink->query ($query);
921 if ($result == NULL or $result->rowCount() != 1)
922 {
923 showError ("SQL query '${query}' failed for table ${tableName}", __FUNCTION__);
924 return FALSE;
925 }
926 return TRUE;
927 }
928
929 function getRackspaceHistory ()
930 {
931 $query =
932 "select mo.id as mo_id, ro.id as ro_id, ro.name, mo.ctime, mo.comment, dict_value as objtype_name, user_name from " .
933 "MountOperation as mo inner join RackObject as ro on mo.object_id = ro.id " .
934 "inner join Dictionary on objtype_id = dict_key join Chapter on Chapter.id = Dictionary.chapter_id " .
935 "where Chapter.name = 'RackObjectType' order by ctime desc";
936 $result = useSelectBlade ($query, __FUNCTION__);
937 $ret = $result->fetchAll(PDO::FETCH_ASSOC);
938 $result->closeCursor();
939 return $ret;
940 }
941
942 // This function is used in renderRackspaceHistory()
943 function getOperationMolecules ($op_id = 0)
944 {
945 if ($op_id <= 0)
946 {
947 showError ("Missing argument", __FUNCTION__);
948 return;
949 }
950 $query = "select old_molecule_id, new_molecule_id from MountOperation where id = ${op_id}";
951 $result = useSelectBlade ($query, __FUNCTION__);
952 // We expect one row.
953 $row = $result->fetch (PDO::FETCH_ASSOC);
954 if ($row == NULL)
955 {
956 showError ("SQL query succeded, but returned no results.", __FUNCTION__);
957 return;
958 }
959 $omid = $row['old_molecule_id'];
960 $nmid = $row['new_molecule_id'];
961 $result->closeCursor();
962 return array ($omid, $nmid);
963 }
964
965 function getResidentRacksData ($object_id = 0, $fetch_rackdata = TRUE)
966 {
967 if ($object_id <= 0)
968 {
969 showError ('Invalid object_id', __FUNCTION__);
970 return;
971 }
972 $query = "select distinct rack_id from RackSpace where object_id = ${object_id} order by rack_id";
973 $result = useSelectBlade ($query, __FUNCTION__);
974 $rows = $result->fetchAll (PDO::FETCH_NUM);
975 unset ($result);
976 $ret = array();
977 foreach ($rows as $row)
978 {
979 if (!$fetch_rackdata)
980 {
981 $ret[$row[0]] = $row[0];
982 continue;
983 }
984 if (NULL == ($rackData = spotEntity ('rack', $row[0])))
985 {
986 showError ('Rack not found', __FUNCTION__);
987 return NULL;
988 }
989 amplifyCell ($rackData);
990 $ret[$row[0]] = $rackData;
991 }
992 return $ret;
993 }
994
995 function commitAddPort ($object_id = 0, $port_name, $port_type_id, $port_label, $port_l2address)
996 {
997 if ($object_id <= 0)
998 {
999 showError ('Invalid object_id', __FUNCTION__);
1000 return;
1001 }
1002 if (NULL === ($db_l2address = l2addressForDatabase ($port_l2address)))
1003 return "Invalid L2 address ${port_l2address}";
1004 $result = useInsertBlade
1005 (
1006 'Port',
1007 array
1008 (
1009 'name' => "'${port_name}'",
1010 'object_id' => "'${object_id}'",
1011 'label' => "'${port_label}'",
1012 'type' => "'${port_type_id}'",
1013 'l2address' => ($db_l2address === '') ? 'NULL' : "'${db_l2address}'"
1014 )
1015 );
1016 if ($result)
1017 return '';
1018 else
1019 return 'SQL query failed';
1020 }
1021
1022 // The fifth argument may be either explicit 'NULL' or some (already quoted by the upper layer)
1023 // string value. In case it is omitted, we just assign it its current value.
1024 // It would be nice to simplify this semantics later.
1025 function commitUpdatePort ($port_id, $port_name, $port_type_id, $port_label, $port_l2address, $port_reservation_comment = 'reservation_comment')
1026 {
1027 global $dbxlink;
1028 if (NULL === ($db_l2address = l2addressForDatabase ($port_l2address)))
1029 return "Invalid L2 address ${port_l2address}";
1030 $query =
1031 "update Port set name='$port_name', type=$port_type_id, label='$port_label', " .
1032 "reservation_comment = ${port_reservation_comment}, l2address=" .
1033 (($db_l2address === '') ? 'NULL' : "'${db_l2address}'") .
1034 " where id='$port_id'";
1035 $result = $dbxlink->exec ($query);
1036 if ($result == 1)
1037 return '';
1038 $errorInfo = $dbxlink->errorInfo();
1039 // We could update nothing.
1040 if ($errorInfo[0] == '00000')
1041 return '';
1042 return $errorInfo[2];
1043 }
1044
1045 function delObjectPort ($port_id)
1046 {
1047 if (unlinkPort ($port_id) != '')
1048 return __FUNCTION__ . ': unlinkPort() failed';
1049 if (useDeleteBlade ('Port', 'id', $port_id) != TRUE)
1050 return __FUNCTION__ . ': useDeleteBlade() failed';
1051 return '';
1052 }
1053
1054 function getAllIPv4Allocations ()
1055 {
1056 $query =
1057 "select object_id as object_id, ".
1058 "RackObject.name as object_name, ".
1059 "IPv4Allocation.name as name, ".
1060 "INET_NTOA(ip) as ip ".
1061 "from IPv4Allocation join RackObject on id=object_id ";
1062 $result = useSelectBlade ($query, __FUNCTION__);
1063 $ret = array();
1064 $count=0;
1065 while ($row = $result->fetch (PDO::FETCH_ASSOC))
1066 {
1067 $ret[$count]['object_id']=$row['object_id'];
1068 $ret[$count]['object_name']=$row['object_name'];
1069 $ret[$count]['name']=$row['name'];
1070 $ret[$count]['ip']=$row['ip'];
1071 $count++;
1072 }
1073 $result->closeCursor();
1074 return $ret;
1075 }
1076
1077 function getEmptyPortsOfType ($type_id)
1078 {
1079 $query =
1080 "select distinct Port.id as Port_id, ".
1081 "Port.object_id as Port_object_id, ".
1082 "RackObject.name as Object_name, ".
1083 "Port.name as Port_name, ".
1084 "Port.type as Port_type_id, ".
1085 "dict_value as Port_type_name ".
1086 "from ( ".
1087 " ( ".
1088 " Port inner join Dictionary on Port.type = dict_key join Chapter on Chapter.id = Dictionary.chapter_id ".
1089 " ) ".
1090 " join RackObject on Port.object_id = RackObject.id ".
1091 ") ".
1092 "left join Link on Port.id=Link.porta or Port.id=Link.portb ".
1093 "inner join PortCompat on Port.type = PortCompat.type2 ".
1094 "where Chapter.name = 'PortType' and PortCompat.type1 = '$type_id' and Link.porta is NULL ".
1095 "and Port.reservation_comment is null order by Object_name, Port_name";
1096 $result = useSelectBlade ($query, __FUNCTION__);
1097 $ret = array();
1098 $count=0;
1099 while ($row = $result->fetch (PDO::FETCH_ASSOC))
1100 {
1101 $ret[$count]['Port_id']=$row['Port_id'];
1102 $ret[$count]['Port_object_id']=$row['Port_object_id'];
1103 $ret[$count]['Object_name']=$row['Object_name'];
1104 $ret[$count]['Port_name']=$row['Port_name'];
1105 $ret[$count]['Port_type_id']=$row['Port_type_id'];
1106 $ret[$count]['Port_type_name']=$row['Port_type_name'];
1107 $count++;
1108 }
1109 $result->closeCursor();
1110 return $ret;
1111 }
1112
1113 function linkPorts ($porta, $portb)
1114 {
1115 if ($porta == $portb)
1116 return "Ports can't be the same";
1117 if ($porta > $portb)
1118 {
1119 $tmp = $porta;
1120 $porta = $portb;
1121 $portb = $tmp;
1122 }
1123 global $dbxlink;
1124 $query1 = "insert into Link set porta='${porta}', portb='{$portb}'";
1125 $query2 = "update Port set reservation_comment = NULL where id = ${porta} or id = ${portb} limit 2";
1126 // FIXME: who cares about the return value?
1127 $result = $dbxlink->exec ($query1);
1128 $result = $dbxlink->exec ($query2);
1129 return '';
1130 }
1131
1132 function unlinkPort ($port)
1133 {
1134 global $dbxlink;
1135 $query =
1136 "delete from Link where porta='$port' or portb='$port'";
1137 $result = $dbxlink->exec ($query);
1138 return '';
1139 }
1140
1141 // Return all IPv4 addresses allocated to the objects. Attach detailed
1142 // info about address to each alocation records. Index result by dotted-quad
1143 // address.
1144 function getObjectIPv4Allocations ($object_id = 0)
1145 {
1146 $ret = array();
1147 $query = 'select name as osif, type, inet_ntoa(ip) as dottedquad from IPv4Allocation ' .
1148 "where object_id = ${object_id} " .
1149 'order by ip';
1150 $result = useSelectBlade ($query, __FUNCTION__);
1151 // don't spawn a sub-query with unfetched buffer, it may fail
1152 while ($row = $result->fetch (PDO::FETCH_ASSOC))
1153 $ret[$row['dottedquad']] = array ('osif' => $row['osif'], 'type' => $row['type']);
1154 unset ($result);
1155 foreach (array_keys ($ret) as $dottedquad)
1156 $ret[$dottedquad]['addrinfo'] = getIPv4Address ($dottedquad);
1157 return $ret;
1158 }
1159
1160 // Return minimal IPv4 address, optionally with "ip" key set, if requested.
1161 function constructIPv4Address ($dottedquad = NULL)
1162 {
1163 $ret = array
1164 (
1165 'name' => '',
1166 'reserved' => 'no',
1167 'outpf' => array(),
1168 'inpf' => array(),
1169 'rslist' => array(),
1170 'allocs' => array(),
1171 'lblist' => array()
1172 );
1173 if ($dottedquad != NULL)
1174 $ret['ip'] = $dottedquad;
1175 return $ret;
1176 }
1177
1178 // Check the range requested for meaningful IPv4 records, build them
1179 // into a list and return. Return an empty list if nothing matched.
1180 // Both arguments are expected in signed int32 form. The resulting list
1181 // is keyed by uint32 form of each IP address, items aren't sorted.
1182 // LATER: accept a list of pairs and build WHERE sub-expression accordingly
1183 function scanIPv4Space ($pairlist)
1184 {
1185 $ret = array();
1186 if (!count ($pairlist)) // this is normal for a network completely divided into smaller parts
1187 return $ret;;
1188 $dnamechache = array();
1189 // FIXME: this is a copy-and-paste prototype
1190 $or = '';
1191 $whereexpr1 = '(';
1192 $whereexpr2 = '(';
1193 $whereexpr3 = '(';
1194 $whereexpr4 = '(';
1195 $whereexpr5a = '(';
1196 $whereexpr5b = '(';
1197 foreach ($pairlist as $tmp)
1198 {
1199 $db_first = sprintf ('%u', 0x00000000 + $tmp['i32_first']);
1200 $db_last = sprintf ('%u', 0x00000000 + $tmp['i32_last']);
1201 $whereexpr1 .= $or . "ip between ${db_first} and ${db_last}";
1202 $whereexpr2 .= $or . "ip between ${db_first} and ${db_last}";
1203 $whereexpr3 .= $or . "vip between ${db_first} and ${db_last}";
1204 $whereexpr4 .= $or . "rsip between ${db_first} and ${db_last}";
1205 $whereexpr5a .= $or . "remoteip between ${db_first} and ${db_last}";
1206 $whereexpr5b .= $or . "localip between ${db_first} and ${db_last}";
1207 $or = ' or ';
1208 }
1209 $whereexpr1 .= ')';
1210 $whereexpr2 .= ')';
1211 $whereexpr3 .= ')';
1212 $whereexpr4 .= ')';
1213 $whereexpr5a .= ')';
1214 $whereexpr5b .= ')';
1215
1216 // 1. collect labels and reservations
1217 $query = "select INET_NTOA(ip) as ip, name, reserved from IPv4Address ".
1218 "where ${whereexpr1} and (reserved = 'yes' or name != '')";
1219 $result = useSelectBlade ($query, __FUNCTION__);
1220 while ($row = $result->fetch (PDO::FETCH_ASSOC))
1221 {
1222 $ip_bin = ip2long ($row['ip']);
1223 if (!isset ($ret[$ip_bin]))
1224 $ret[$ip_bin] = constructIPv4Address ($row['ip']);
1225 $ret[$ip_bin]['name'] = $row['name'];
1226 $ret[$ip_bin]['reserved'] = $row['reserved'];
1227 }
1228 unset ($result);
1229
1230 // 2. check for allocations
1231 $query =
1232 "select INET_NTOA(ipb.ip) as ip, ro.id as object_id, " .
1233 "ro.name as object_name, ipb.name, ipb.type, objtype_id, " .
1234 "dict_value as objtype_name from " .
1235 "IPv4Allocation as ipb inner join RackObject as ro on ipb.object_id = ro.id " .
1236 "left join Dictionary on objtype_id=dict_key join Chapter on Chapter.id = Dictionary.chapter_id " .
1237 "where ${whereexpr2} " .
1238 "and Chapter.name = 'RackObjectType'" .
1239 "order by ipb.type, object_name";
1240 $result = useSelectBlade ($query, __FUNCTION__);
1241 while ($row = $result->fetch (PDO::FETCH_ASSOC))
1242 {
1243 $ip_bin = ip2long ($row['ip']);
1244 if (!isset ($ret[$ip_bin]))
1245 $ret[$ip_bin] = constructIPv4Address ($row['ip']);
1246 if (!isset ($dnamecache[$row['object_id']]))
1247 {
1248 $quasiobject['id'] = $row['object_id'];
1249 $quasiobject['name'] = $row['object_name'];
1250 $quasiobject['objtype_id'] = $row['objtype_id'];
1251 $quasiobject['objtype_name'] = $row['objtype_name'];
1252 $dnamecache[$row['object_id']] = displayedName ($quasiobject);
1253 }
1254 $tmp = array();
1255 foreach (array ('object_id', 'type', 'name') as $cname)
1256 $tmp[$cname] = $row[$cname];
1257 $tmp['object_name'] = $dnamecache[$row['object_id']];
1258 $ret[$ip_bin]['allocs'][] = $tmp;
1259 }
1260 unset ($result);
1261
1262 // 3. look for virtual services and related LB
1263 $query = "select vs_id, inet_ntoa(vip) as ip, vport, proto, vs.name, " .
1264 "object_id, objtype_id, ro.name as object_name, dict_value as objtype_name from " .
1265 "IPv4VS as vs inner join IPv4LB as lb on vs.id = lb.vs_id " .
1266 "inner join RackObject as ro on lb.object_id = ro.id " .
1267 "left join Dictionary on objtype_id=dict_key " .
1268 "join Chapter on Chapter.id = Dictionary.chapter_id " .
1269 "where ${whereexpr3} " .
1270 "and Chapter.name = 'RackObjectType'" .
1271 "order by vport, proto, ro.name, object_id";
1272 $result = useSelectBlade ($query, __FUNCTION__);
1273 while ($row = $result->fetch (PDO::FETCH_ASSOC))
1274 {
1275 $ip_bin = ip2long ($row['ip']);
1276 if (!isset ($ret[$ip_bin]))
1277 $ret[$ip_bin] = constructIPv4Address ($row['ip']);
1278 if (!isset ($dnamecache[$row['object_id']]))
1279 {
1280 $quasiobject['name'] = $row['object_name'];
1281 $quasiobject['objtype_id'] = $row['objtype_id'];
1282 $quasiobject['objtype_name'] = $row['objtype_name'];
1283 $dnamecache[$row['object_id']] = displayedName ($quasiobject);
1284 }
1285 $tmp = array();
1286 foreach (array ('object_id', 'vport', 'proto', 'vs_id', 'name') as $cname)
1287 $tmp[$cname] = $row[$cname];
1288 $tmp['object_name'] = $dnamecache[$row['object_id']];
1289 $tmp['vip'] = $row['ip'];
1290 $ret[$ip_bin]['lblist'][] = $tmp;
1291 }
1292 unset ($result);
1293
1294 // 4. don't forget about real servers along with pools
1295 $query = "select inet_ntoa(rsip) as ip, inservice, rsport, rspool_id, rsp.name as rspool_name from " .
1296 "IPv4RS as rs inner join IPv4RSPool as rsp on rs.rspool_id = rsp.id " .
1297 "where ${whereexpr4} " .
1298 "order by ip, rsport, rspool_id";
1299 $result = useSelectBlade ($query, __FUNCTION__);
1300 while ($row = $result->fetch (PDO::FETCH_ASSOC))
1301 {
1302 $ip_bin = ip2long ($row['ip']);
1303 if (!isset ($ret[$ip_bin]))
1304 $ret[$ip_bin] = constructIPv4Address ($row['ip']);
1305 $tmp = array();
1306 foreach (array ('rspool_id', 'rsport', 'rspool_name', 'inservice') as $cname)
1307 $tmp[$cname] = $row[$cname];
1308 $ret[$ip_bin]['rslist'][] = $tmp;
1309 }
1310 unset ($result);
1311
1312 // 5. add NAT rules, part 1
1313 $query =
1314 "select " .
1315 "proto, " .
1316 "INET_NTOA(localip) as localip, " .
1317 "localport, " .
1318 "INET_NTOA(remoteip) as remoteip, " .
1319 "remoteport, " .
1320 "description " .
1321 "from IPv4NAT " .
1322 "where ${whereexpr5a} " .
1323 "order by localip, localport, remoteip, remoteport, proto";
1324 $result = useSelectBlade ($query, __FUNCTION__);
1325 while ($row = $result->fetch (PDO::FETCH_ASSOC))
1326 {
1327 $remoteip_bin = ip2long ($row['remoteip']);
1328 if (!isset ($ret[$remoteip_bin]))
1329 $ret[$remoteip_bin] = constructIPv4Address ($row['remoteip']);
1330 $ret[$remoteip_bin]['inpf'][] = $row;
1331 }
1332 unset ($result);
1333 // 5. add NAT rules, part 2
1334 $query =
1335 "select " .
1336 "proto, " .
1337 "INET_NTOA(localip) as localip, " .
1338 "localport, " .
1339 "INET_NTOA(remoteip) as remoteip, " .
1340 "remoteport, " .
1341 "description " .
1342 "from IPv4NAT " .
1343 "where ${whereexpr5b} " .
1344 "order by localip, localport, remoteip, remoteport, proto";
1345 $result = useSelectBlade ($query, __FUNCTION__);
1346 while ($row = $result->fetch (PDO::FETCH_ASSOC))
1347 {
1348 $localip_bin = ip2long ($row['localip']);
1349 if (!isset ($ret[$localip_bin]))
1350 $ret[$localip_bin] = constructIPv4Address ($row['localip']);
1351 $ret[$localip_bin]['outpf'][] = $row;
1352 }
1353 unset ($result);
1354 return $ret;
1355 }
1356
1357 function getIPv4Address ($dottedquad = '')
1358 {
1359 if ($dottedquad == '')
1360 {
1361 showError ('Invalid arg', __FUNCTION__);
1362 return NULL;
1363 }
1364 $i32 = ip2long ($dottedquad); // signed 32 bit
1365 $scanres = scanIPv4Space (array (array ('i32_first' => $i32, 'i32_last' => $i32)));
1366 if (!isset ($scanres[$i32]))
1367 //$scanres[$i32] = constructIPv4Address ($dottedquad); // XXX: this should be verified to not break things
1368 return constructIPv4Address ($dottedquad);
1369 markupIPv4AddrList ($scanres);
1370 return $scanres[$i32];
1371 }
1372
1373 function bindIpToObject ($ip = '', $object_id = 0, $name = '', $type = '')
1374 {
1375 $result = useInsertBlade
1376 (
1377 'IPv4Allocation',
1378 array
1379 (
1380 'ip' => "INET_ATON('$ip')",
1381 'object_id' => "'${object_id}'",
1382 'name' => "'${name}'",
1383 'type' => "'${type}'"
1384 )
1385 );
1386 return $result ? '' : (__FUNCTION__ . '(): useInsertBlade() failed');
1387 }
1388
1389 // Return the id of the smallest IPv4 network containing the given IPv4 address
1390 // or NULL, if nothing was found. When finding the covering network for
1391 // another network, it is important to filter out matched records with longer
1392 // masks (they aren't going to be the right pick).
1393 function getIPv4AddressNetworkId ($dottedquad, $masklen = 32)
1394 {
1395 // N.B. To perform the same for IPv6 address and networks, some pre-requisites
1396 // are necessary and a different query. IPv6 addresses are 128 bit long, which
1397 // is too much for both PHP and MySQL data types. These values must be split
1398 // into 4 32-byte long parts (b_u32_0, b_u32_1, b_u32_2, b_u32_3).
1399 // Then each network must have its 128-bit netmask split same way and either
1400 // stored right in its record or JOINed from decoder and accessible as m_u32_0,
1401 // m_u32_1, m_u32_2, m_u32_3. After that the query to pick the smallest network
1402 // covering the given address would look as follows:
1403 // $query = 'select id from IPv6Network as n where ' .
1404 // "(${b_u32_0} & n.m_u32_0 = n.b_u32_0) and " .
1405 // "(${b_u32_1} & n.m_u32_1 = n.b_u32_1) and " .
1406 // "(${b_u32_2} & n.m_u32_2 = n.b_u32_2) and " .
1407 // "(${b_u32_3} & n.m_u32_3 = n.b_u32_3) and " .
1408 // "mask < ${masklen} " .
1409 // 'order by mask desc limit 1';
1410
1411 $query = 'select id from IPv4Network where ' .
1412 "inet_aton('${dottedquad}') & (4294967295 >> (32 - mask)) << (32 - mask) = ip " .
1413 "and mask < ${masklen} " .
1414 'order by mask desc limit 1';
1415 $result = useSelectBlade ($query, __FUNCTION__);
1416 if ($row = $result->fetch (PDO::FETCH_ASSOC))
1417 return $row['id'];
1418 return NULL;
1419 }
1420
1421 function updateRange ($id=0, $name='')
1422 {
1423 global $dbxlink;
1424 $query =
1425 "update IPv4Network set name='$name' where id='$id'";
1426 $result = $dbxlink->exec ($query);
1427 return '';
1428 }
1429
1430 // This function is actually used not only to update, but also to create records,
1431 // that's why ON DUPLICATE KEY UPDATE was replaced by DELETE-INSERT pair
1432 // (MySQL 4.0 workaround).
1433 function updateAddress ($ip = 0, $name = '', $reserved = 'no')
1434 {
1435 // DELETE may safely fail.
1436 $r = useDeleteBlade ('IPv4Address', 'ip', "INET_ATON('${ip}')");
1437 // INSERT may appear not necessary.
1438 if ($name == '' and $reserved == 'no')
1439 return '';
1440 if (useInsertBlade ('IPv4Address', array ('name' => "'${name}'", 'reserved' => "'${reserved}'", 'ip' => "INET_ATON('${ip}')")))
1441 return '';
1442 else
1443 return __FUNCTION__ . '(): useInsertBlade() failed';
1444 }
1445
1446 function updateBond ($ip='', $object_id=0, $name='', $type='')
1447 {
1448 global $dbxlink;
1449
1450 $query =
1451 "update IPv4Allocation set name='$name', type='$type' where ip=INET_ATON('$ip') and object_id='$object_id'";
1452 $result = $dbxlink->exec ($query);
1453 return '';
1454 }
1455
1456 function unbindIpFromObject ($ip='', $object_id=0)
1457 {
1458 global $dbxlink;
1459
1460 $query =
1461 "delete from IPv4Allocation where ip=INET_ATON('$ip') and object_id='$object_id'";
1462 $result = $dbxlink->exec ($query);
1463 return '';
1464 }
1465
1466 function searchByl2address ($port_l2address)
1467 {
1468 if (NULL === ($db_l2address = l2addressForDatabase ($port_l2address)))
1469 return NULL; // Don't complain, other searches may return own data.
1470 $query = "select object_id, Port.id as port_id from RackObject as ro inner join Port on ro.id = Port.object_id " .
1471 "where l2address = '${db_l2address}'";
1472 $result = useSelectBlade ($query, __FUNCTION__);
1473 $rows = $result->fetchAll (PDO::FETCH_ASSOC);
1474 $result->closeCursor();
1475 if (count ($rows) == 0) // No results.
1476 return NULL;
1477 if (count ($rows) == 1) // Target found.
1478 return $rows[0];
1479 showError ('More than one results was found. This is probably a broken unique key.', __FUNCTION__);
1480 return NULL;
1481 }
1482
1483 function getIPv4PrefixSearchResult ($terms)
1484 {
1485 $byname = getSearchResultByField
1486 (
1487 'IPv4Network',
1488 array ('id'),
1489 'name',
1490 $terms,
1491 'ip'
1492 );
1493 $ret = array();
1494 foreach ($byname as $row)
1495 $ret[] = spotEntity ('ipv4net', $row['id']);
1496 return $ret;
1497 }
1498
1499 function getIPv4AddressSearchResult ($terms)
1500 {
1501 $query = "select inet_ntoa(ip) as ip, name from IPv4Address where ";
1502 $or = '';
1503 foreach (explode (' ', $terms) as $term)
1504 {
1505 $query .= $or . "name like '%${term}%'";
1506 $or = ' or ';
1507 }
1508 $result = useSelectBlade ($query, __FUNCTION__);
1509 $ret = array();
1510 while ($row = $result->fetch (PDO::FETCH_ASSOC))
1511 $ret[] = $row;
1512 return $ret;
1513 }
1514
1515 function getIPv4RSPoolSearchResult ($terms)
1516 {
1517 $byname = getSearchResultByField
1518 (
1519 'IPv4RSPool',
1520 array ('id'),
1521 'name',
1522 $terms,
1523 'name'
1524 );
1525 $ret = array();
1526 foreach ($byname as $row)
1527 $ret[] = spotEntity ('ipv4rspool', $row['id']);
1528 return $ret;
1529 }
1530
1531 function getIPv4VServiceSearchResult ($terms)
1532 {
1533 $byname = getSearchResultByField
1534 (
1535 'IPv4VS',
1536 array ('id'),
1537 'name',
1538 $terms,
1539 'vip'
1540 );
1541 $ret = array();
1542 foreach ($byname as $row)
1543 $ret[] = spotEntity ('ipv4vs', $row['id']);
1544 return $ret;
1545 }
1546
1547 function getAccountSearchResult ($terms)
1548 {
1549 $byUsername = getSearchResultByField
1550 (
1551 'UserAccount',
1552 array ('user_id', 'user_name', 'user_realname'),
1553 'user_name',
1554 $terms,
1555 'user_name'
1556 );
1557 $byRealname = getSearchResultByField
1558 (
1559 'UserAccount',
1560 array ('user_id', 'user_name', 'user_realname'),
1561 'user_realname',
1562 $terms,
1563 'user_name'
1564 );
1565 // Filter out dupes.
1566 foreach ($byUsername as $res1)
1567 foreach (array_keys ($byRealname) as $key2)
1568 if ($res1['user_id'] == $byRealname[$key2]['user_id'])
1569 {
1570 unset ($byRealname[$key2]);
1571 continue 2;
1572 }
1573 $ret = array_merge ($byUsername, $byRealname);
1574 // Set realm, so it's renderable.
1575 foreach (array_keys ($ret) as $key)
1576 $ret[$key]['realm'] = 'user';
1577 return $ret;
1578 }
1579
1580 function getFileSearchResult ($terms)
1581 {
1582 $byName = getSearchResultByField
1583 (
1584 'File',
1585 array ('id'),
1586 'name',
1587 $terms,
1588 'name'
1589 );
1590 $byComment = getSearchResultByField
1591 (
1592 'File',
1593 array ('id'),
1594 'comment',
1595 $terms,
1596 'name'
1597 );
1598 // Filter out dupes.
1599 foreach ($byName as $res1)
1600 foreach (array_keys ($byComment) as $key2)
1601 if ($res1['id'] == $byComment[$key2]['id'])
1602 {
1603 unset ($byComment[$key2]);
1604 continue 2;
1605 }
1606 $ret = array();
1607 foreach (array_merge ($byName, $byComment) as $row)
1608 $ret[] = spotEntity ('file', $row['id']);
1609 return $ret;
1610 }
1611
1612 function getRackSearchResult ($terms)
1613 {
1614 $byName = getSearchResultByField
1615 (
1616 'Rack',
1617 array ('id'),
1618 'name',
1619 $terms,
1620 'name'
1621 );
1622 $byComment = getSearchResultByField
1623 (
1624 'Rack',
1625 array ('id'),
1626 'comment',
1627 $terms,
1628 'name'
1629 );
1630 // Filter out dupes.
1631 foreach ($byName as $res1)
1632 foreach (array_keys ($byComment) as $key2)
1633 if ($res1['id'] == $byComment[$key2]['id'])
1634 {
1635 unset ($byComment[$key2]);
1636 continue 2;
1637 }
1638 $ret = array();
1639 foreach (array_merge ($byName, $byComment) as $row)
1640 $ret[] = spotEntity ('rack', $row['id']);
1641 return $ret;
1642 }
1643
1644 function getSearchResultByField ($tname, $rcolumns, $scolumn, $terms, $ocolumn = '')
1645 {
1646 $pfx = '';
1647 $query = 'select ';
1648 foreach ($rcolumns as $col)
1649 {
1650 $query .= $pfx . $col;
1651 $pfx = ', ';
1652 }
1653 $pfx = '';
1654 $query .= " from ${tname} where ";
1655 foreach (explode (' ', $terms) as $term)
1656 {
1657 $query .= $pfx . "${scolumn} like '%${term}%'";
1658 $pfx = ' or ';
1659 }
1660 if ($ocolumn != '')
1661 $query .= " order by ${ocolumn}";
1662 $result = useSelectBlade ($query, __FUNCTION__);
1663 $ret = array();
1664 while ($row = $result->fetch (PDO::FETCH_ASSOC))
1665 $ret[] = $row;
1666 return $ret;
1667 }
1668
1669 // This function returns either port ID or NULL for specified arguments.
1670 function getPortID ($object_id, $port_name)
1671 {
1672 $query = "select id from Port where object_id=${object_id} and name='${port_name}' limit 2";
1673 $result = useSelectBlade ($query, __FUNCTION__);
1674 $rows = $result->fetchAll (PDO::FETCH_NUM);
1675 if (count ($rows) != 1)
1676 return NULL;
1677 $ret = $rows[0][0];
1678 $result->closeCursor();
1679 return $ret;
1680 }
1681
1682 function commitCreateUserAccount ($username, $realname, $password)
1683 {
1684 return useInsertBlade
1685 (
1686 'UserAccount',
1687 array
1688 (
1689 'user_name' => "'${username}'",
1690 'user_realname' => "'${realname}'",
1691 'user_password_hash' => "'${password}'"
1692 )
1693 );
1694 }
1695
1696 function commitUpdateUserAccount ($id, $new_username, $new_realname, $new_password)
1697 {
1698 global $dbxlink;
1699 $query =
1700 "update UserAccount set user_name = '${new_username}', user_realname = '${new_realname}', " .
1701 "user_password_hash = '${new_password}' where user_id = ${id} limit 1";
1702 $result = $dbxlink->query ($query);
1703 if ($result == NULL)
1704 {
1705 showError ('SQL query failed', __FUNCTION__);
1706 die;
1707 }
1708 return TRUE;
1709 }
1710
1711 // This function returns an array of all port type pairs from PortCompat table.
1712 function getPortCompat ()
1713 {
1714 $query =
1715 "select type1, type2, d1.dict_value as type1name, d2.dict_value as type2name from " .
1716 "PortCompat as pc inner join Dictionary as d1 on pc.type1 = d1.dict_key " .
1717 "inner join Dictionary as d2 on pc.type2 = d2.dict_key " .
1718 "inner join Chapter as c1 on d1.chapter_id = c1.id " .
1719 "inner join Chapter as c2 on d2.chapter_id = c2.id " .
1720 "where c1.name = 'PortType' and c2.name = 'PortType'";
1721 $result = useSelectBlade ($query, __FUNCTION__);
1722 $ret = $result->fetchAll (PDO::FETCH_ASSOC);
1723 $result->closeCursor();
1724 return $ret;
1725 }
1726
1727 function removePortCompat ($type1 = 0, $type2 = 0)
1728 {
1729 global $dbxlink;
1730 if ($type1 == 0 or $type2 == 0)
1731 {
1732 showError ('Invalid arguments', __FUNCTION__);
1733 die;
1734 }
1735 $query = "delete from PortCompat where type1 = ${type1} and type2 = ${type2} limit 1";
1736 $result = $dbxlink->query ($query);
1737 if ($result == NULL)
1738 {
1739 showError ('SQL query failed', __FUNCTION__);
1740 die;
1741 }
1742 return TRUE;
1743 }
1744
1745 function addPortCompat ($type1 = 0, $type2 = 0)
1746 {
1747 if ($type1 <= 0 or $type2 <= 0)
1748 {
1749 showError ('Invalid arguments', __FUNCTION__);
1750 die;
1751 }
1752 return useInsertBlade
1753 (
1754 'PortCompat',
1755 array ('type1' => $type1, 'type2' => $type2)
1756 );
1757 }
1758
1759 // This function returns the dictionary as an array of trees, each tree
1760 // representing a single chapter. Each element has 'id', 'name', 'sticky'
1761 // and 'word' keys with the latter holding all the words within the chapter.
1762 // FIXME: there's a lot of excess legacy code in this function, it's reasonable
1763 // to merge it with readChapter().
1764 function getDict ($parse_links = FALSE)
1765 {
1766 $query1 =
1767 "select Chapter.name as chapter_name, Chapter.id as chapter_no, dict_key, dict_value, sticky from " .
1768 "Chapter left join Dictionary on Chapter.id = Dictionary.chapter_id order by Chapter.name, dict_value";
1769 $result = useSelectBlade ($query1, __FUNCTION__);
1770 $dict = array();
1771 while ($row = $result->fetch (PDO::FETCH_ASSOC))
1772 {
1773 $chapter_no = $row['chapter_no'];
1774 if (!isset ($dict[$chapter_no]))
1775 {
1776 $dict[$chapter_no]['no'] = $chapter_no;
1777 $dict[$chapter_no]['name'] = $row['chapter_name'];
1778 $dict[$chapter_no]['sticky'] = $row['sticky'] == 'yes' ? TRUE : FALSE;
1779 $dict[$chapter_no]['word'] = array();
1780 }
1781 if ($row['dict_key'] != NULL)
1782 {
1783 $dict[$chapter_no]['word'][$row['dict_key']] = ($parse_links or $row['dict_key'] <= MAX_DICT_KEY) ?
1784 parseWikiLink ($row['dict_value'], 'a') : $row['dict_value'];
1785 $dict[$chapter_no]['refcnt'][$row['dict_key']] = 0;
1786 }
1787 }
1788 $result->closeCursor();
1789 unset ($result);
1790 // Find the list of all assigned values of dictionary-addressed attributes, each with
1791 // chapter/word keyed reference counters. Use the structure to adjust reference counters
1792 // of the returned disctionary words.
1793 $query2 = "select a.id as attr_id, am.chapter_id as chapter_no, uint_value, count(object_id) as refcnt " .
1794 "from Attribute as a inner join AttributeMap as am on a.id = am.attr_id " .
1795 "inner join AttributeValue as av on a.id = av.attr_id " .
1796 "inner join Dictionary as d on am.chapter_id = d.chapter_id and av.uint_value = d.dict_key " .
1797 "where a.type = 'dict' group by a.id, am.chapter_id, uint_value " .
1798 "order by a.id, am.chapter_id, uint_value";
1799 $result = useSelectBlade ($query2, __FUNCTION__);
1800 while ($row = $result->fetch (PDO::FETCH_ASSOC))
1801 $dict[$row['chapter_no']]['refcnt'][$row['uint_value']] = $row['refcnt'];
1802 $result->closeCursor();
1803 return $dict;
1804 }
1805
1806 function getDictStats ()
1807 {
1808 $stock_chapters = array (1, 2, 11, 12, 13, 14, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25);
1809 $query =
1810 "select Chapter.id as chapter_no, Chapter.name as chapter_name, count(dict_key) as wc from " .
1811 "Chapter left join Dictionary on Chapter.id = Dictionary.chapter_id group by Chapter.id";
1812 $result = useSelectBlade ($query, __FUNCTION__);
1813 $tc = $tw = $uc = $uw = 0;
1814 while ($row = $result->fetch (PDO::FETCH_ASSOC))
1815 {
1816 $tc++;
1817 $tw += $row['wc'];;
1818 if (in_array ($row['chapter_no'], $stock_chapters))
1819 continue;
1820 $uc++;
1821 $uw += $row['wc'];;
1822 }
1823 $result->closeCursor();
1824 unset ($result);
1825 $query = "select count(id) as attrc from RackObject as ro left join " .
1826 "AttributeValue as av on ro.id = av.object_id group by ro.id";
1827 $result = useSelectBlade ($query, __FUNCTION__);
1828 $to = $ta = $so = 0;
1829 while ($row = $result->fetch (PDO::FETCH_ASSOC))
1830 {
1831 $to++;
1832 if ($row['attrc'] != 0)
1833 {
1834 $so++;
1835 $ta += $row['attrc'];
1836 }
1837 }
1838 $result->closeCursor();
1839 $ret = array();
1840 $ret['Total chapters in dictionary'] = $tc;
1841 $ret['Total words in dictionary'] = $tw;
1842 $ret['User chapters'] = $uc;
1843 $ret['Words in user chapters'] = $uw;
1844 $ret['Total objects'] = $to;
1845 $ret['Objects with stickers'] = $so;
1846 $ret['Total stickers attached'] = $ta;
1847 return $ret;
1848 }
1849
1850 function getIPv4Stats ()
1851 {
1852 $ret = array();
1853 $subject = array();
1854 $subject[] = array ('q' => 'select count(id) from IPv4Network', 'txt' => 'Networks');
1855 $subject[] = array ('q' => 'select count(ip) from IPv4Address', 'txt' => 'Addresses commented/reserved');
1856 $subject[] = array ('q' => 'select count(ip) from IPv4Allocation', 'txt' => 'Addresses allocated');
1857 $subject[] = array ('q' => 'select count(*) from IPv4NAT', 'txt' => 'NAT rules');
1858 $subject[] = array ('q' => 'select count(id) from IPv4VS', 'txt' => 'Virtual services');
1859 $subject[] = array ('q' => 'select count(id) from IPv4RSPool', 'txt' => 'Real server pools');
1860 $subject[] = array ('q' => 'select count(id) from IPv4RS', 'txt' => 'Real servers');
1861 $subject[] = array ('q' => 'select count(distinct object_id) from IPv4LB', 'txt' => 'Load balancers');
1862
1863 foreach ($subject as $item)
1864 {
1865 $result = useSelectBlade ($item['q'], __FUNCTION__);
1866 $row = $result->fetch (PDO::FETCH_NUM);
1867 $ret[$item['txt']] = $row[0];
1868 $result->closeCursor();
1869 unset ($result);
1870 }
1871 return $ret;
1872 }
1873
1874 function getRackspaceStats ()
1875 {
1876 $ret = array();
1877 $subject = array();
1878 $subject[] = array ('q' => 'select count(*) from RackRow', 'txt' => 'Rack rows');
1879 $subject[] = array ('q' => 'select count(*) from Rack', 'txt' => 'Racks');
1880 $subject[] = array ('q' => 'select avg(height) from Rack', 'txt' => 'Average rack height');
1881 $subject[] = array ('q' => 'select sum(height) from Rack', 'txt' => 'Total rack units in field');
1882
1883 foreach ($subject as $item)
1884 {
1885 $result = useSelectBlade ($item['q'], __FUNCTION__);
1886 $row = $result->fetch (PDO::FETCH_NUM);
1887 $ret[$item['txt']] = empty ($row[0]) ? 0 : $row[0];
1888 $result->closeCursor();
1889 unset ($result);
1890 }
1891 return $ret;
1892 }
1893
1894 function renderTagStats ()
1895 {
1896 global $taglist, $root;
1897 $query = "select id, tag, count(tag_id) as refcnt from " .
1898 "TagTree inner join TagStorage on TagTree.id = TagStorage.tag_id " .
1899 "group by tag_id order by refcnt desc limit 50";
1900 // The same data is already present in pre-loaded tag list, but not in
1901 // the form we need. So let's ask the DB server for cooked top list and
1902 // use the cooked tag list to break it down.
1903 $result = useSelectBlade ($query, __FUNCTION__);
1904 $refc = $result->fetchAll (PDO::FETCH_ASSOC);
1905 echo '<table border=1><tr><th>tag</th><th>total</th><th>objects</th><th>IPv4 nets</th><th>racks</th>';
1906 echo '<th>IPv4 VS</th><th>IPv4 RS pools</th><th>users</th><th>files</th></tr>';
1907 $pagebyrealm = array
1908 (
1909 'file' => 'files&tab=default',
1910 'ipv4net' => 'ipv4space&tab=default',
1911 'ipv4vs' => 'ipv4vslist&tab=default',
1912 'ipv4rspool' => 'ipv4rsplist&tab=default',
1913 'object' => 'depot&tab=default',
1914 'rack' => 'rackspace&tab=default',
1915 'user' => 'userlist&tab=default'
1916 );
1917 foreach ($refc as $ref)
1918 {
1919 echo "<tr><td>${ref['tag']}</td><td>${ref['refcnt']}</td>";
1920 foreach (array ('object', 'ipv4net', 'rack', 'ipv4vs', 'ipv4rspool', 'user', 'file') as $realm)
1921 {
1922 echo '<td>';
1923 if (!isset ($taglist[$ref['id']]['refcnt'][$realm]))
1924 echo '&nbsp;';
1925 else
1926 {
1927 echo "<a href='${root}?page=" . $pagebyrealm[$realm] . "&cft[]=${ref['id']}'>";
1928 echo $taglist[$ref['id']]['refcnt'][$realm] . '</a>';
1929 }
1930 echo '</td>';
1931 }
1932 echo '</tr>';
1933 }
1934 echo '</table>';
1935 }
1936
1937 /*
1938
1939 The following allows figuring out records in TagStorage, which refer to non-existing entities:
1940
1941 mysql> select entity_id from TagStorage left join Files on entity_id = id where entity_realm = 'file' and id is null;
1942 mysql> select entity_id from TagStorage left join IPv4Network on entity_id = id where entity_realm = 'ipv4net' and id is null;
1943 mysql> select entity_id from TagStorage left join RackObject on entity_id = id where entity_realm = 'object' and id is null;
1944 mysql> select entity_id from TagStorage left join Rack on entity_id = id where entity_realm = 'rack' and id is null;
1945 mysql> select entity_id from TagStorage left join IPv4VS on entity_id = id where entity_realm = 'ipv4vs' and id is null;
1946 mysql> select entity_id from TagStorage left join IPv4RSPool on entity_id = id where entity_realm = 'ipv4rspool' and id is null;
1947 mysql> select entity_id from TagStorage left join UserAccount on entity_id = user_id where entity_realm = 'user' and user_id is null;
1948
1949 Accordingly, these are the records, which refer to non-existent tags:
1950
1951 mysql> select tag_id from TagStorage left join TagTree on tag_id = id where id is null;
1952
1953 */
1954
1955 function commitUpdateDictionary ($chapter_no = 0, $dict_key = 0, $dict_value = '')
1956 {
1957 if ($chapter_no <= 0 or $dict_key <= 0 or empty ($dict_value))
1958 {
1959 showError ('Invalid args', __FUNCTION__);
1960 die;
1961 }
1962 global $dbxlink;
1963 $query =
1964 "update Dictionary set dict_value = '${dict_value}' where chapter_id=${chapter_no} " .
1965 "and dict_key=${dict_key} limit 1";
1966 $result = $dbxlink->query ($query);
1967 if ($result == NULL)
1968 {
1969 showError ('SQL query failed', __FUNCTION__);
1970 die;
1971 }
1972 return TRUE;
1973 }
1974
1975 function commitSupplementDictionary ($chapter_no = 0, $dict_value = '')
1976 {
1977 if ($chapter_no <= 0 or empty ($dict_value))
1978 {
1979 showError ('Invalid args', __FUNCTION__);
1980 die;
1981 }
1982 return useInsertBlade
1983 (
1984 'Dictionary',
1985 array ('chapter_id' => $chapter_no, 'dict_value' => "'${dict_value}'")
1986 );
1987 }
1988
1989 function commitReduceDictionary ($chapter_no = 0, $dict_key = 0)
1990 {
1991 if ($chapter_no <= 0 or $dict_key <= 0)
1992 {
1993 showError ('Invalid args', __FUNCTION__);
1994 die;
1995 }
1996 global $dbxlink;
1997 $query =
1998 "delete from Dictionary where chapter_id=${chapter_no} " .
1999 "and dict_key=${dict_key} limit 1";
2000 $result = $dbxlink->query ($query);
2001 if ($result == NULL)
2002 {
2003 showError ('SQL query failed', __FUNCTION__);
2004 die;
2005 }
2006 return TRUE;
2007 }
2008
2009 function commitAddChapter ($chapter_name = '')
2010 {
2011 if (empty ($chapter_name))
2012 {
2013 showError ('Invalid args', __FUNCTION__);
2014 die;
2015 }
2016 return useInsertBlade
2017 (
2018 'Chapter',
2019 array ('name' => "'${chapter_name}'")
2020 );
2021 }
2022
2023 function commitUpdateChapter ($chapter_no = 0, $chapter_name = '')
2024 {
2025 if ($chapter_no <= 0 or empty ($chapter_name))
2026 {
2027 showError ('Invalid args', __FUNCTION__);
2028 die;
2029 }
2030 global $dbxlink;
2031 $query =
2032 "update Chapter set name = '${chapter_name}' where id = ${chapter_no} " .
2033 "and sticky = 'no' limit 1";
2034 $result = $dbxlink->query ($query);
2035 if ($result == NULL)
2036 {
2037 showError ('SQL query failed', __FUNCTION__);
2038 die;
2039 }
2040 return TRUE;
2041 }
2042
2043 function commitDeleteChapter ($chapter_no = 0)
2044 {
2045 if ($chapter_no <= 0)
2046 {
2047 showError ('Invalid args', __FUNCTION__);
2048 die;
2049 }
2050 global $dbxlink;
2051 $query =
2052 "delete from Chapter where id = ${chapter_no} and sticky = 'no' limit 1";
2053 $result = $dbxlink->query ($query);
2054 if ($result == NULL)
2055 {
2056 showError ('SQL query failed', __FUNCTION__);
2057 die;
2058 }
2059 return TRUE;
2060 }
2061
2062 // This is a dictionary accessor. We perform link rendering, so the user sees
2063 // nice <select> drop-downs.
2064 function readChapter ($chapter_name = '')
2065 {
2066 if (empty ($chapter_name))
2067 {
2068 showError ('invalid argument', __FUNCTION__);
2069 return NULL;
2070 }
2071 $query =
2072 "select dict_key, dict_value from Dictionary join Chapter on Chapter.id = Dictionary.chapter_id " .
2073 "where Chapter.name = '${chapter_name}'";
2074 $result = useSelectBlade ($query, __FUNCTION__);
2075 $chapter = array();
2076 while ($row = $result->fetch (PDO::FETCH_ASSOC))
2077 $chapter[$row['dict_key']] = parseWikiLink ($row['dict_value'], 'o');
2078 $result->closeCursor();
2079 // SQL ORDER BY had no sense, because we need to sort after link rendering, not before.
2080 asort ($chapter);
2081 return $chapter;
2082 }
2083
2084 function getAttrMap ()
2085 {
2086 $query =
2087 "select a.id as attr_id, a.type as attr_type, a.name as attr_name, am.objtype_id, " .
2088 "d.dict_value as objtype_name, am.chapter_id, c2.name as chapter_name from " .
2089 "Attribute as a left join AttributeMap as am on a.id = am.attr_id " .
2090 "left join Dictionary as d on am.objtype_id = d.dict_key " .
2091 "left join Chapter as c1 on d.chapter_id = c1.id " .
2092 "left join Chapter as c2 on am.chapter_id = c2.id " .
2093 "where c1.name = 'RackObjectType' or c1.name is null " .
2094 "order by a.name";
2095 $result = useSelectBlade ($query, __FUNCTION__);
2096 $ret = array();
2097 while ($row = $result->fetch (PDO::FETCH_ASSOC))
2098 {
2099 $attr_id = $row['attr_id'];
2100 if (!isset ($ret[$attr_id]))
2101 {
2102 $ret[$attr_id]['id'] = $attr_id;
2103 $ret[$attr_id]['type'] = $row['attr_type'];
2104 $ret[$attr_id]['name'] = $row['attr_name'];
2105 $ret[$attr_id]['application'] = array();
2106 }
2107 if ($row['objtype_id'] == '')
2108 continue;
2109 $application['objtype_id'] = $row['objtype_id'];
2110 $application['objtype_name'] = $row['objtype_name'];
2111 if ($row['attr_type'] == 'dict')
2112 {
2113 $application['chapter_no'] = $row['chapter_id'];
2114 $application['chapter_name'] = $row['chapter_name'];
2115 }
2116 $ret[$attr_id]['application'][] = $application;
2117 }
2118 $result->closeCursor();
2119 return $ret;
2120 }
2121
2122 function commitUpdateAttribute ($attr_id = 0, $attr_name = '')
2123 {
2124 if ($attr_id <= 0 or empty ($attr_name))
2125 {
2126 showError ('Invalid args', __FUNCTION__);
2127 die;
2128 }
2129 global $dbxlink;
2130 $query =
2131 "update Attribute set name = '${attr_name}' " .
2132 "where id = ${attr_id} limit 1";
2133 $result = $dbxlink->query ($query);
2134 if ($result == NULL)
2135 {
2136 showError ("SQL query '${query}' failed", __FUNCTION__);
2137 die;
2138 }
2139 return TRUE;
2140 }
2141
2142 function commitAddAttribute ($attr_name = '', $attr_type = '')
2143 {
2144 if (empty ($attr_name))
2145 {
2146 showError ('Invalid args', __FUNCTION__);
2147 die;
2148 }
2149 switch ($attr_type)
2150 {
2151 case 'uint':
2152 case 'float':
2153 case 'string':
2154 case 'dict':
2155 break;
2156 default:
2157 showError ('Invalid args', __FUNCTION__);
2158 die;
2159 }
2160 return useInsertBlade
2161 (
2162 'Attribute',
2163 array ('name' => "'${attr_name}'", 'type' => "'${attr_type}'")
2164 );
2165 }
2166
2167 function commitDeleteAttribute ($attr_id = 0)
2168 {
2169 if ($attr_id <= 0)
2170 {
2171 showError ('Invalid args', __FUNCTION__);
2172 die;
2173 }
2174 return useDeleteBlade ('Attribute', 'id', $attr_id);
2175 }
2176
2177 // FIXME: don't store garbage in chapter_no for non-dictionary types.
2178 function commitSupplementAttrMap ($attr_id = 0, $objtype_id = 0, $chapter_no = 0)
2179 {
2180 if ($attr_id <= 0 or $objtype_id <= 0 or $chapter_no <= 0)
2181 {
2182 showError ('Invalid args', __FUNCTION__);
2183 die;
2184 }
2185 return useInsertBlade
2186 (
2187 'AttributeMap',
2188 array
2189 (
2190 'attr_id' => $attr_id,
2191 'objtype_id' => $objtype_id,
2192 'chapter_id' => $chapter_no
2193 )
2194 );
2195 }
2196
2197 function commitReduceAttrMap ($attr_id = 0, $objtype_id)
2198 {
2199 if ($attr_id <= 0 or $objtype_id <= 0)
2200 {
2201 showError ('Invalid args', __FUNCTION__);
2202 die;
2203 }
2204 global $dbxlink;
2205 $query =
2206 "delete from AttributeMap where attr_id=${attr_id} " .
2207 "and objtype_id=${objtype_id} limit 1";
2208 $result = $dbxlink->query ($query);
2209 if ($result == NULL)
2210 {
2211 showError ('SQL query failed', __FUNCTION__);
2212 die;
2213 }
2214 return TRUE;
2215 }
2216
2217 // This function returns all optional attributes for requested object
2218 // as an array of records. NULL is returned on error and empty array
2219 // is returned, if there are no attributes found.
2220 function getAttrValues ($object_id, $strip_optgroup = FALSE)
2221 {
2222 if ($object_id <= 0)
2223 {
2224 showError ('Invalid argument', __FUNCTION__);
2225 return NULL;
2226 }
2227 $ret = array();
2228 $query =
2229 "select A.id as attr_id, A.name as attr_name, A.type as attr_type, C.name as chapter_name, " .
2230 "AV.uint_value, AV.float_value, AV.string_value, D.dict_value from " .
2231 "RackObject as RO inner join AttributeMap as AM on RO.objtype_id = AM.objtype_id " .
2232 "inner join Attribute as A on AM.attr_id = A.id " .
2233 "left join AttributeValue as AV on AV.attr_id = AM.attr_id and AV.object_id = RO.id " .
2234 "left join Dictionary as D on D.dict_key = AV.uint_value and AM.chapter_id = D.chapter_id " .
2235 "left join Chapter as C on AM.chapter_id = C.id " .
2236 "where RO.id = ${object_id} order by A.type, A.name";
2237 $result = useSelectBlade ($query, __FUNCTION__);
2238 while ($row = $result->fetch (PDO::FETCH_ASSOC))
2239 {
2240 $record = array();
2241 $record['id'] = $row['attr_id'];
2242 $record['name'] = $row['attr_name'];
2243 $record['type'] = $row['attr_type'];
2244 switch ($row['attr_type'])
2245 {
2246 case 'uint':
2247 case 'float':
2248 case 'string':
2249 $record['value'] = $row[$row['attr_type'] . '_value'];
2250 $record['a_value'] = parseWikiLink ($record['value'], 'a');
2251 break;
2252 case 'dict':
2253 $record['value'] = parseWikiLink ($row[$row['attr_type'] . '_value'], 'o', $strip_optgroup);
2254 $record['a_value'] = parseWikiLink ($row[$row['attr_type'] . '_value'], 'a', $strip_optgroup);
2255 $record['chapter_name'] = $row['chapter_name'];
2256 $record['key'] = $row['uint_value'];
2257 break;
2258 default:
2259 $record['value'] = NULL;
2260 break;
2261 }
2262 $ret[$row['attr_id']] = $record;
2263 }
2264 $result->closeCursor();
2265 return $ret;
2266 }
2267
2268 function commitResetAttrValue ($object_id = 0, $attr_id = 0)
2269 {
2270 if ($object_id <= 0 or $attr_id <= 0)
2271 {
2272 showError ('Invalid arguments', __FUNCTION__);
2273 die;
2274 }
2275 global $dbxlink;
2276 $query = "delete from AttributeValue where object_id = ${object_id} and attr_id = ${attr_id} limit 1";
2277 $result = $dbxlink->query ($query);
2278 if ($result == NULL)
2279 {
2280 showError ('SQL query failed', __FUNCTION__);
2281 die;
2282 }
2283 return TRUE;
2284 }
2285
2286 // FIXME: don't share common code with use commitResetAttrValue()
2287 function commitUpdateAttrValue ($object_id = 0, $attr_id = 0, $value = '')
2288 {
2289 if ($object_id <= 0 or $attr_id <= 0)
2290 {
2291 showError ('Invalid arguments', __FUNCTION__);
2292 die;
2293 }
2294 if (empty ($value))
2295 return commitResetAttrValue ($object_id, $attr_id);
2296 global $dbxlink;
2297 $query1 = "select type as attr_type from Attribute where id = ${attr_id}";
2298 $result = $dbxlink->query ($query1);
2299 if ($result == NULL)
2300 {
2301 showError ('SQL query #1 failed', __FUNCTION__);
2302 die;
2303 }
2304 $row = $result->fetch (PDO::FETCH_NUM);
2305 if ($row == NULL)
2306 {
2307 showError ('SQL query #1 returned no results', __FUNCTION__);
2308 die;
2309 }
2310 $attr_type = $row[0];
2311 $result->closeCursor();
2312 switch ($attr_type)
2313 {
2314 case 'uint':
2315 case 'float':
2316 case 'string':
2317 $column = $attr_type . '_value';
2318 break;
2319 case 'dict':
2320 $column = 'uint_value';
2321 break;
2322 default:
2323 showError ("Unknown attribute type '${attr_type}' met", __FUNCTION__);
2324 die;
2325 }
2326 $query2 =
2327 "delete from AttributeValue where " .
2328 "object_id = ${object_id} and attr_id = ${attr_id} limit 1";
2329 $result = $dbxlink->query ($query2);
2330 if ($result == NULL)
2331 {
2332 showError ('SQL query #2 failed', __FUNCTION__);
2333 die;
2334 }
2335 // We know $value isn't empty here.
2336 $query3 =
2337 "insert into AttributeValue set ${column} = '${value}', " .
2338 "object_id = ${object_id}, attr_id = ${attr_id} ";
2339 $result = $dbxlink->query ($query3);
2340 if ($result == NULL)
2341 {
2342 showError ('SQL query #3 failed', __FUNCTION__);
2343 die;
2344 }
2345 return TRUE;
2346 }
2347
2348 function commitUseupPort ($port_id = 0)
2349 {
2350 if ($port_id <= 0)
2351 {
2352 showError ("Invalid argument", __FUNCTION__);
2353 die;
2354 }
2355 global $dbxlink;
2356 $query = "update Port set reservation_comment = NULL where id = ${port_id} limit 1";
2357 $result = $dbxlink->exec ($query);
2358 if ($result == NULL)
2359 {
2360 showError ("SQL query failed", __FUNCTION__);
2361 die;
2362 }
2363 return TRUE;
2364
2365 }
2366
2367 // This is a swiss-knife blade to insert a record into a table.
2368 // The first argument is table name.
2369 // The second argument is an array of "name" => "value" pairs.
2370 // The function returns either TRUE or FALSE (we expect one row
2371 // to be inserted).
2372 function useInsertBlade ($tablename, $values)
2373 {
2374 global $dbxlink;
2375 $namelist = $valuelist = '';
2376 foreach ($values as $name => $value)
2377 {
2378 $namelist = $namelist . ($namelist == '' ? "(${name}" : ", ${name}");
2379 $valuelist = $valuelist . ($valuelist == '' ? "(${value}" : ", ${value}");
2380 }
2381 $query = "insert into ${tablename} ${namelist}) values ${valuelist})";
2382 $result = $dbxlink->exec ($query);
2383 if ($result != 1)
2384 return FALSE;
2385 return TRUE;
2386 }
2387
2388 // This swiss-knife blade deletes one record from the specified table
2389 // using the specified key name and value.
2390 function useDeleteBlade ($tablename, $keyname, $keyvalue)
2391 {
2392 global $dbxlink;
2393 return 1 === $dbxlink->exec ("delete from ${tablename} where ${keyname}=${keyvalue} limit 1");
2394 }
2395
2396 function useSelectBlade ($query, $caller = 'N/A')
2397 {
2398 global $dbxlink;
2399 $result = $dbxlink->query ($query);
2400 if ($result == NULL)
2401 {
2402 $ei = $dbxlink->errorInfo();
2403 showError ("SQL query '${query}'\n failed in useSelectBlade with error ${ei[1]} (${ei[2]})", $caller);
2404 return NULL;
2405 }
2406 return $result;
2407 }
2408
2409 function loadConfigCache ()
2410 {
2411 $query = 'SELECT varname, varvalue, vartype, is_hidden, emptyok, description FROM Config ORDER BY varname';
2412 $result = useSelectBlade ($query, __FUNCTION__);
2413 $cache = array();
2414 while ($row = $result->fetch (PDO::FETCH_ASSOC))
2415 $cache[$row['varname']] = $row;
2416 $result->closeCursor();
2417 return $cache;
2418 }
2419
2420 // setConfigVar() is expected to perform all necessary filtering
2421 function storeConfigVar ($varname = NULL, $varvalue = NULL)
2422 {
2423 global $dbxlink;
2424 if (empty ($varname) || $varvalue === NULL)
2425 {
2426 showError ('Invalid arguments', __FUNCTION__);
2427 return FALSE;
2428 }
2429 $query = "update Config set varvalue='${varvalue}' where varname='${varname}' limit 1";
2430 $result = $dbxlink->query ($query);
2431 if ($result == NULL)
2432 {
2433 showError ("SQL query '${query}' failed", __FUNCTION__);
2434 return FALSE;
2435 }
2436 $rc = $result->rowCount();
2437 $result->closeCursor();
2438 if ($rc == 0 or $rc == 1)
2439 return TRUE;
2440 showError ("Something went wrong for args '${varname}', '${varvalue}'", __FUNCTION__);
2441 return FALSE;
2442 }
2443
2444 // Database version detector. Should behave corretly on any
2445 // working dataset a user might have.
2446 function getDatabaseVersion ()
2447 {
2448 global $dbxlink;
2449 $query = "select varvalue from Config where varname = 'DB_VERSION' and vartype = 'string'";
2450 $result = $dbxlink->query ($query);
2451 if ($result == NULL)
2452 {
2453 $errorInfo = $dbxlink->errorInfo();
2454 if ($errorInfo[0] == '42S02') // ER_NO_SUCH_TABLE
2455 return '0.14.4';
2456 die (__FUNCTION__ . ': SQL query #1 failed with error ' . $errorInfo[2]);
2457 }
2458 $rows = $result->fetchAll (PDO::FETCH_NUM);
2459 if (count ($rows) != 1 || empty ($rows[0][0]))
2460 {
2461 $result->closeCursor();
2462 die (__FUNCTION__ . ': Cannot guess database version. Config table is present, but DB_VERSION is missing or invalid. Giving up.');
2463 }
2464 $ret = $rows[0][0];
2465 $result->closeCursor();
2466 return $ret;
2467 }
2468
2469 // Return an array of virtual services. For each of them list real server pools
2470 // with their load balancers and other stats.
2471 function getSLBSummary ()
2472 {
2473 $query = 'select vs.id as vsid, inet_ntoa(vip) as vip, vport, proto, vs.name, object_id, ' .
2474 'lb.rspool_id, pool.name as pool_name, count(rs.id) as rscount ' .
2475 'from IPv4VS as vs inner join IPv4LB as lb on vs.id = lb.vs_id ' .
2476 'inner join IPv4RSPool as pool on lb.rspool_id = pool.id ' .
2477 'left join IPv4RS as rs on rs.rspool_id = lb.rspool_id ' .
2478 'group by vs.id, object_id order by vs.vip, object_id';
2479 $result = useSelectBlade ($query, __FUNCTION__);
2480 $ret = array();
2481 while ($row = $result->fetch (PDO::FETCH_ASSOC))
2482 {
2483 $vsid = $row['vsid'];
2484 $object_id = $row['object_id'];
2485 if (!isset ($ret[$vsid]))
2486 {
2487 $ret[$vsid] = array();
2488 foreach (array ('vip', 'vport', 'proto', 'name') as $cname)
2489 $ret[$vsid][$cname] = $row[$cname];
2490 $ret[$vsid]['lblist'] = array();
2491 }
2492 // There's only one assigned RS pool possible for each LB-VS combination.
2493 $ret[$vsid]['lblist'][$row['object_id']] = array
2494 (
2495 'id' => $row['rspool_id'],
2496 'size' => $row['rscount'],
2497 'name' => $row['pool_name']
2498 );
2499 }
2500 $result->closeCursor();
2501 return $ret;
2502 }
2503
2504 function addRStoRSPool ($pool_id = 0, $rsip = '', $rsport = 0, $inservice = 'no', $rsconfig = '')
2505 {
2506 if ($pool_id <= 0)
2507 {
2508 showError ('Invalid arguments', __FUNCTION__);
2509 die;
2510 }
2511 if (empty ($rsport) or $rsport == 0)
2512 $rsport = 'NULL';
2513 return useInsertBlade
2514 (
2515 'IPv4RS',
2516 array
2517 (
2518 'rsip' => "inet_aton('${rsip}')",
2519 'rsport' => $rsport,
2520 'rspool_id' => $pool_id,
2521 'inservice' => ($inservice == 'yes' ? "'yes'" : "'no'"),
2522 'rsconfig' => (empty ($rsconfig) ? 'NULL' : "'${rsconfig}'")
2523 )
2524 );
2525 }
2526
2527 function commitCreateVS ($vip = '', $vport = 0, $proto = '', $name = '', $vsconfig, $rsconfig, $taglist = array())
2528 {
2529 if (empty ($vip) or $vport <= 0 or empty ($proto))
2530 return __FUNCTION__ . ': invalid arguments';
2531 if (!useInsertBlade
2532 (
2533 'IPv4VS',
2534 array
2535 (
2536 'vip' => "inet_aton('${vip}')",
2537 'vport' => $vport,
2538 'proto' => "'${proto}'",
2539 'name' => (empty ($name) ? 'NULL' : "'${name}'"),
2540 'vsconfig' => (empty ($vsconfig) ? 'NULL' : "'${vsconfig}'"),
2541 'rsconfig' => (empty ($rsconfig) ? 'NULL' : "'${rsconfig}'")
2542 )
2543 ))
2544 return __FUNCTION__ . ': SQL insertion failed';
2545 return produceTagsForLastRecord ('ipv4vs', $taglist);
2546 }
2547
2548 function addLBtoRSPool ($pool_id = 0, $object_id = 0, $vs_id = 0, $vsconfig = '', $rsconfig = '')
2549 {
2550 if ($pool_id <= 0 or $object_id <= 0 or $vs_id <= 0)
2551 {
2552 showError ('Invalid arguments', __FUNCTION__);
2553 die;
2554 }
2555 return useInsertBlade
2556 (
2557 'IPv4LB',
2558 array
2559 (
2560 'object_id' => $object_id,
2561 'rspool_id' => $pool_id,
2562 'vs_id' => $vs_id,
2563 'vsconfig' => (empty ($vsconfig) ? 'NULL' : "'${vsconfig}'"),
2564 'rsconfig' => (empty ($rsconfig) ? 'NULL' : "'${rsconfig}'")
2565 )
2566 );
2567 }
2568
2569 function commitDeleteRS ($id = 0)
2570 {
2571 if ($id <= 0)
2572 return FALSE;
2573 return useDeleteBlade ('IPv4RS', 'id', $id);
2574 }
2575
2576 function commitDeleteVS ($id = 0)
2577 {
2578 if ($id <= 0)
2579 return FALSE;
2580 return useDeleteBlade ('IPv4VS', 'id', $id) && destroyTagsForEntity ('ipv4vs', $id);
2581 }
2582
2583 function commitDeleteLB ($object_id = 0, $pool_id = 0, $vs_id = 0)
2584 {
2585 global $dbxlink;
2586 if ($object_id <= 0 or $pool_id <= 0 or $vs_id <= 0)
2587 return FALSE;
2588 $query = "delete from IPv4LB where object_id = ${object_id} and " .
2589 "rspool_id = ${pool_id} and vs_id = ${vs_id} limit 1";
2590 $result = $dbxlink->exec ($query);
2591 if ($result === NULL)
2592 return FALSE;
2593 elseif ($result != 1)
2594 return FALSE;
2595 else
2596 return TRUE;
2597 }
2598
2599 function commitUpdateRS ($rsid = 0, $rsip = '', $rsport = 0, $rsconfig = '')
2600 {
2601 if ($rsid <= 0)
2602 {
2603 showError ('Invalid args', __FUNCTION__);
2604 die;
2605 }
2606 if (long2ip (ip2long ($rsip)) !== $rsip)
2607 {
2608 showError ("Invalid IP address '${rsip}'", __FUNCTION__);
2609 die;
2610 }
2611 if (empty ($rsport) or $rsport == 0)
2612 $rsport = 'NULL';
2613 global $dbxlink;
2614 $query =
2615 "update IPv4RS set rsip = inet_aton('${rsip}'), rsport = ${rsport}, rsconfig = " .
2616 (empty ($rsconfig) ? 'NULL' : "'${rsconfig}'") .
2617 " where id = ${rsid} limit 1";
2618 $result = $dbxlink->query ($query);
2619 if ($result == NULL)
2620 {
2621 showError ("SQL query '${query}' failed", __FUNCTION__);
2622 die;
2623 }
2624 return TRUE;
2625 }
2626
2627 function commitUpdateLB ($object_id = 0, $pool_id = 0, $vs_id = 0, $vsconfig = '', $rsconfig = '')
2628 {
2629 if ($object_id <= 0 or $pool_id <= 0 or $vs_id <= 0)
2630 {
2631 showError ('Invalid args', __FUNCTION__);
2632 die;
2633 }
2634 global $dbxlink;
2635 $query =
2636 "update IPv4LB set vsconfig = " .
2637 (empty ($vsconfig) ? 'NULL' : "'${vsconfig}'") .
2638 ', rsconfig = ' .
2639 (empty ($rsconfig) ? 'NULL' : "'${rsconfig}'") .
2640 " where object_id = ${object_id} and rspool_id = ${pool_id} " .
2641 "and vs_id = ${vs_id} limit 1";
2642 $result = $dbxlink->exec ($query);
2643 if ($result === NULL)
2644 return FALSE;
2645 else
2646 return TRUE;
2647 }
2648
2649 function commitUpdateVS ($vsid = 0, $vip = '', $vport = 0, $proto = '', $name = '', $vsconfig = '', $rsconfig = '')
2650 {
2651 if ($vsid <= 0 or empty ($vip) or $vport <= 0 or empty ($proto))
2652 {
2653 showError ('Invalid args', __FUNCTION__);
2654 die;
2655 }
2656 global $dbxlink;
2657 $query = "update IPv4VS set " .
2658 "vip = inet_aton('${vip}'), " .
2659 "vport = ${vport}, " .
2660 "proto = '${proto}', " .
2661 'name = ' . (empty ($name) ? 'NULL,' : "'${name}', ") .
2662 'vsconfig = ' . (empty ($vsconfig) ? 'NULL,' : "'${vsconfig}', ") .
2663 'rsconfig = ' . (empty ($rsconfig) ? 'NULL' : "'${rsconfig}'") .
2664 " where id = ${vsid} limit 1";
2665 $result = $dbxlink->exec ($query);
2666 if ($result === NULL)
2667 return FALSE;
2668 else
2669 return TRUE;
2670 }
2671
2672 function loadThumbCache ($rack_id = 0)
2673 {
2674 $ret = NULL;
2675 $query = "select thumb_data from Rack where id = ${rack_id} and thumb_data is not null limit 1";
2676 $result = useSelectBlade ($query, __FUNCTION__);
2677 $row = $result->fetch (PDO::FETCH_ASSOC);
2678 if ($row)
2679 $ret = base64_decode ($row['thumb_data']);
2680 $result->closeCursor();
2681 return $ret;
2682 }
2683
2684 function saveThumbCache ($rack_id = 0, $cache = NULL)
2685 {
2686 global $dbxlink;
2687 if ($rack_id == 0 or $cache == NULL)
2688 {
2689 showError ('Invalid arguments', __FUNCTION__);
2690 return;
2691 }
2692 $data = base64_encode ($cache);
2693 $query = "update Rack set thumb_data = '${data}' where id = ${rack_id} limit 1";
2694 $result = $dbxlink->exec ($query);
2695 }
2696
2697 function resetThumbCache ($rack_id = 0)
2698 {
2699 global $dbxlink;
2700 if ($rack_id == 0)
2701 {
2702 showError ('Invalid argument', __FUNCTION__);
2703 return;
2704 }
2705 $query = "update Rack set thumb_data = NULL where id = ${rack_id} limit 1";
2706 $result = $dbxlink->exec ($query);
2707 }
2708
2709 // Return the list of attached RS pools for the given object. As long as we have
2710 // the LB-VS UNIQUE in IPv4LB table, it is Ok to key returned records
2711 // by vs_id, because there will be only one RS pool listed for each VS of the
2712 // current object.
2713 function getRSPoolsForObject ($object_id = 0)
2714 {
2715 if ($object_id <= 0)
2716 {
2717 showError ('Invalid object_id', __FUNCTION__);
2718 return NULL;
2719 }
2720 $query = 'select vs_id, inet_ntoa(vip) as vip, vport, proto, vs.name, pool.id as pool_id, ' .
2721 'pool.name as pool_name, count(rsip) as rscount, lb.vsconfig, lb.rsconfig from ' .
2722 'IPv4LB as lb inner join IPv4RSPool as pool on lb.rspool_id = pool.id ' .
2723 'inner join IPv4VS as vs on lb.vs_id = vs.id ' .
2724 'left join IPv4RS as rs on lb.rspool_id = rs.rspool_id ' .
2725 "where lb.object_id = ${object_id} " .
2726 'group by lb.rspool_id, lb.vs_id order by vs.vip, vport, proto, pool.name';
2727 $result = useSelectBlade ($query, __FUNCTION__);
2728 $ret = array ();
2729 while ($row = $result->fetch (PDO::FETCH_ASSOC))
2730 foreach (array ('vip', 'vport', 'proto', 'name', 'pool_id', 'pool_name', 'rscount', 'vsconfig', 'rsconfig') as $cname)
2731 $ret[$row['vs_id']][$cname] = $row[$cname];
2732 $result->closeCursor();
2733 return $ret;
2734 }
2735
2736 function commitCreateRSPool ($name = '', $vsconfig = '', $rsconfig = '', $taglist = array())
2737 {
2738 if (empty ($name))
2739 return __FUNCTION__ . ': invalid arguments';
2740 if (!useInsertBlade
2741 (
2742 'IPv4RSPool',
2743 array
2744 (
2745 'name' => (empty ($name) ? 'NULL' : "'${name}'"),
2746 'vsconfig' => (empty ($vsconfig) ? 'NULL' : "'${vsconfig}'"),
2747 'rsconfig' => (empty ($rsconfig) ? 'NULL' : "'${rsconfig}'")
2748 )
2749 ))
2750 return __FUNCTION__ . ': SQL insertion failed';
2751 return produceTagsForLastRecord ('ipv4rspool', $taglist);
2752 }
2753
2754 function commitDeleteRSPool ($pool_id = 0)
2755 {
2756 global $dbxlink;
2757 if ($pool_id <= 0)
2758 return FALSE;
2759 return useDeleteBlade ('IPv4RSPool', 'id', $pool_id) && destroyTagsForEntity ('ipv4rspool', $pool_id);
2760 }
2761
2762 function commitUpdateRSPool ($pool_id = 0, $name = '', $vsconfig = '', $rsconfig = '')
2763 {
2764 if ($pool_id <= 0)
2765 {
2766 showError ('Invalid arg', __FUNCTION__);
2767 die;
2768 }
2769 global $dbxlink;
2770 $query = "update IPv4RSPool set " .
2771 'name = ' . (empty ($name) ? 'NULL,' : "'${name}', ") .
2772 'vsconfig = ' . (empty ($vsconfig) ? 'NULL,' : "'${vsconfig}', ") .
2773 'rsconfig = ' . (empty ($rsconfig) ? 'NULL' : "'${rsconfig}'") .
2774 " where id = ${pool_id} limit 1";
2775 $result = $dbxlink->exec ($query);
2776 if ($result === NULL)
2777 return FALSE;
2778 elseif ($result != 1)
2779 return FALSE;
2780 else
2781 return TRUE;
2782 }
2783
2784 function getRSList ()
2785 {
2786 $query = "select id, inservice, inet_ntoa(rsip) as rsip, rsport, rspool_id, rsconfig " .
2787 "from IPv4RS order by rspool_id, IPv4RS.rsip, rsport";
2788 $result = useSelectBlade ($query, __FUNCTION__);
2789 $ret = array ();
2790 while ($row = $result->fetch (PDO::FETCH_ASSOC))
2791 foreach (array ('inservice', 'rsip', 'rsport', 'rspool_id', 'rsconfig') as $cname)
2792 $ret[$row['id']][$cname] = $row[$cname];
2793 $result->closeCursor();
2794 return $ret;
2795 }
2796
2797 // Return the list of all currently configured load balancers with their pool count.
2798 function getLBList ()
2799 {
2800 $query = "select object_id, count(rspool_id) as poolcount " .
2801 "from IPv4LB group by object_id order by object_id";
2802 $result = useSelectBlade ($query, __FUNCTION__);
2803 $ret = array ();
2804 while ($row = $result->fetch (PDO::FETCH_ASSOC))
2805 $ret[$row['object_id']] = $row['poolcount'];
2806 $result->closeCursor();
2807 return $ret;
2808 }
2809
2810 // For the given object return: it vsconfig/rsconfig; the list of RS pools
2811 // attached (each with vsconfig/rsconfig in turn), each with the list of
2812 // virtual services terminating the pool. Each pool also lists all real
2813 // servers with rsconfig.
2814 function getSLBConfig ($object_id)
2815 {
2816 if ($object_id <= 0)
2817 {
2818 showError ('Invalid arg', __FUNCTION__);
2819 return NULL;
2820 }
2821 $ret = array();
2822 $query = 'select vs_id, inet_ntoa(vip) as vip, vport, proto, vs.name as vs_name, ' .
2823 'vs.vsconfig as vs_vsconfig, vs.rsconfig as vs_rsconfig, ' .
2824 'lb.vsconfig as lb_vsconfig, lb.rsconfig as lb_rsconfig, pool.id as pool_id, pool.name as pool_name, ' .
2825 'pool.vsconfig as pool_vsconfig, pool.rsconfig as pool_rsconfig, ' .
2826 'rs.id as rs_id, inet_ntoa(rsip) as rsip, rsport, rs.rsconfig as rs_rsconfig from ' .
2827 'IPv4LB as lb inner join IPv4RSPool as pool on lb.rspool_id = pool.id ' .
2828 'inner join IPv4VS as vs on lb.vs_id = vs.id ' .
2829 'inner join IPv4RS as rs on lb.rspool_id = rs.rspool_id ' .
2830 "where lb.object_id = ${object_id} and rs.inservice = 'yes' " .
2831 "order by vs.vip, vport, proto, pool.name, rs.rsip, rs.rsport";
2832 $result = useSelectBlade ($query, __FUNCTION__);
2833 while ($row = $result->fetch (PDO::FETCH_ASSOC))
2834 {
2835 $vs_id = $row['vs_id'];
2836 if (!isset ($ret[$vs_id]))
2837 {
2838 foreach (array ('vip', 'vport', 'proto', 'vs_name', 'vs_vsconfig', 'vs_rsconfig', 'lb_vsconfig', 'lb_rsconfig', 'pool_vsconfig', 'pool_rsconfig', 'pool_id', 'pool_name') as $c)
2839 $ret[$vs_id][$c] = $row[$c];
2840 $ret[$vs_id]['rslist'] = array();
2841 }
2842 foreach (array ('rsip', 'rsport', 'rs_rsconfig') as $c)
2843 $ret[$vs_id]['rslist'][$row['rs_id']][$c] = $row[$c];
2844 }
2845 $result->closeCursor();
2846 return $ret;
2847 }
2848
2849 function commitSetInService ($rs_id = 0, $inservice = '')
2850 {
2851 if ($rs_id <= 0 or empty ($inservice))
2852 {
2853 showError ('Invalid args', __FUNCTION__);
2854 return NULL;
2855 }
2856 global $dbxlink;
2857 $query = "update IPv4RS set inservice = '${inservice}' where id = ${rs_id} limit 1";
2858 $result = $dbxlink->exec ($query);
2859 if ($result === NULL)
2860 return FALSE;
2861 elseif ($result != 1)
2862 return FALSE;
2863 else
2864 return TRUE;
2865 }
2866
2867 function executeAutoPorts ($object_id = 0, $type_id = 0)
2868 {
2869 if ($object_id == 0 or $type_id == 0)
2870 {
2871 showError ('Invalid arguments', __FUNCTION__);
2872 die;
2873 }
2874 $ret = TRUE;
2875 foreach (getAutoPorts ($type_id) as $autoport)
2876 $ret = $ret and '' == commitAddPort ($object_id, $autoport['name'], $autoport['type'], '', '');
2877 return $ret;
2878 }
2879
2880 // Return only implicitly listed tags, the rest of the chain will be
2881 // generated/deducted later at higher levels.
2882 // Result is a chain: randomly indexed taginfo list.
2883 function loadEntityTags ($entity_realm = '', $entity_id = 0)
2884 {
2885 $ret = array();
2886 if (!in_array ($entity_realm, array ('file', 'ipv4net', 'ipv4vs', 'ipv4rspool', 'object', 'rack', 'user')))
2887 return $ret;
2888 $query = "select tt.id, tag from " .
2889 "TagStorage as ts inner join TagTree as tt on ts.tag_id = tt.id " .
2890 "where entity_realm = '${entity_realm}' and entity_id = ${entity_id} " .
2891 "order by tt.tag";
2892 $result = useSelectBlade ($query, __FUNCTION__);
2893 while ($row = $result->fetch (PDO::FETCH_ASSOC))
2894 $ret[$row['id']] = $row;
2895 $result->closeCursor();
2896 return getExplicitTagsOnly ($ret);
2897 }
2898
2899 // Return a tag chain with all DB tags on it.
2900 function getTagList ()
2901 {
2902 $ret = array();
2903 $query = "select id, parent_id, tag, entity_realm as realm, count(entity_id) as refcnt " .
2904 "from TagTree left join TagStorage on id = tag_id " .
2905 "group by id, entity_realm order by tag";
2906 $result = useSelectBlade ($query, __FUNCTION__);
2907 $ci = 0; // Collation index. The resulting rows are ordered according to default collation,
2908 // which is utf8_general_ci for UTF-8.
2909 while ($row = $result->fetch (PDO::FETCH_ASSOC))
2910 {
2911 if (!isset ($ret[$row['id']]))
2912 $ret[$row['id']] = array
2913 (
2914 'id' => $row['id'],
2915 'tag' => $row['tag'],
2916 'ci' => $ci++,
2917 'parent_id' => $row['parent_id'],
2918 'refcnt' => array()
2919 );
2920 if ($row['realm'])
2921 $ret[$row['id']]['refcnt'][$row['realm']] = $row['refcnt'];
2922 }
2923 $result->closeCursor();
2924 return $ret;
2925 }
2926
2927 function commitCreateTag ($tagname = '', $parent_id = 0)
2928 {
2929 if ($tagname == '' or $parent_id === 0)
2930 return "Invalid args to " . __FUNCTION__;
2931 $result = useInsertBlade
2932 (
2933 'TagTree',
2934 array
2935 (
2936 'tag' => "'${tagname}'",
2937 'parent_id' => $parent_id
2938 )
2939 );
2940 global $dbxlink;
2941 if ($result)
2942 return '';
2943 elseif ($dbxlink->errorCode() == 23000)
2944 return "name '${tag_name}' is already used";
2945 else
2946 return "SQL query failed in " . __FUNCTION__;
2947 }
2948
2949 function commitDestroyTag ($tagid = 0)
2950 {
2951 if ($tagid == 0)
2952 return 'Invalid arg to ' . __FUNCTION__;
2953 if (useDeleteBlade ('TagTree', 'id', $tagid))
2954 return '';
2955 else
2956 return 'useDeleteBlade() failed in ' . __FUNCTION__;
2957 }
2958
2959 function commitUpdateTag ($tag_id, $tag_name, $parent_id)
2960 {
2961 if ($parent_id == 0)
2962 $parent_id = 'NULL';
2963 global $dbxlink;
2964 $query = "update TagTree set tag = '${tag_name}', parent_id = ${parent_id} " .
2965 "where id = ${tag_id} limit 1";
2966 $result = $dbxlink->exec ($query);
2967 if ($result !== FALSE)
2968 return '';
2969 elseif ($dbxlink->errorCode() == 23000)
2970 return "name '${tag_name}' is already used";
2971 else
2972 return 'SQL query failed in ' . __FUNCTION__;
2973 }
2974
2975 // Drop the whole chain stored.
2976 function destroyTagsForEntity ($entity_realm, $entity_id)
2977 {
2978 global $dbxlink;
2979 $query = "delete from TagStorage where entity_realm = '${entity_realm}' and entity_id = ${entity_id}";
2980 $result = $dbxlink->exec ($query);
2981 if ($result === NULL)
2982 return FALSE;
2983 else
2984 return TRUE;
2985 }
2986
2987 // Drop only one record. This operation doesn't involve retossing other tags, unlike when adding.
2988 function deleteTagForEntity ($entity_realm, $entity_id, $tag_id)
2989 {
2990 global $dbxlink;
2991 $query = "delete from TagStorage where entity_realm = '${entity_realm}' and entity_id = ${entity_id} and tag_id = ${tag_id}";
2992 $result = $dbxlink->exec ($query);
2993 if ($result === NULL)
2994 return FALSE;
2995 else
2996 return TRUE;
2997 }
2998
2999 // Push a record into TagStorage unconditionally.
3000 function addTagForEntity ($realm = '', $entity_id, $tag_id)
3001 {
3002 if (empty ($realm))
3003 return FALSE;
3004 return useInsertBlade
3005 (
3006 'TagStorage',
3007 array
3008 (
3009 'entity_realm' => "'${realm}'",
3010 'entity_id' => $entity_id,
3011 'tag_id' => $tag_id,
3012 )
3013 );
3014 }
3015
3016 // Add records into TagStorage, if this makes sense (IOW, they don't appear
3017 // on the implicit list already). Then remove any other records, which
3018 // appear on the "implicit" side of the chain. This will make sure,
3019 // that both the tag base is still minimal and all requested tags appear on
3020 // the resulting tag chain.
3021 // Return TRUE, if any changes were committed.
3022 function rebuildTagChainForEntity ($realm, $entity_id, $extrachain = array())
3023 {
3024 // Put the current explicit sub-chain into a buffer and merge all tags from
3025 // the extra chain, which aren't there yet.
3026 $newchain = $oldchain = loadEntityTags ($realm, $entity_id);
3027 foreach ($extrachain as $extratag)
3028 if (!tagOnChain ($extratag, $newchain))
3029 $newchain[] = $extratag;
3030 // Then minimize the working buffer and check if it differs from the original
3031 // chain we started with. If it is so, save the work and signal the upper layer.
3032 $newchain = getExplicitTagsOnly ($newchain);
3033 if (tagChainCmp ($oldchain, $newchain))
3034 {
3035 destroyTagsForEntity ($realm, $entity_id);
3036 foreach ($newchain as $taginfo)
3037 addTagForEntity ($realm, $entity_id, $taginfo['id']);
3038 return TRUE;
3039 }
3040 return FALSE;
3041 }
3042
3043 // Presume, that the target record has no tags attached.
3044 function produceTagsForLastRecord ($realm, $tagidlist, $last_insert_id = 0)
3045 {
3046 if (!count ($tagidlist))
3047 return '';
3048 if (!$last_insert_id)
3049 $last_insert_id = lastInsertID();
3050 $errcount = 0;
3051 foreach (getExplicitTagsOnly (buildTagChainFromIds ($tagidlist)) as $taginfo)
3052 if (addTagForEntity ($realm, $last_insert_id, $taginfo['id']) == FALSE)
3053 $errcount++;
3054 if (!$errcount)
3055 return '';
3056 else
3057 return "Experienced ${errcount} errors adding tags in realm '${realm}' for entity ID == ${last_insert_id}";
3058 }
3059
3060 function createIPv4Prefix ($range = '', $name = '', $is_bcast = FALSE, $taglist = array())
3061 {
3062 // $range is in x.x.x.x/x format, split into ip/mask vars
3063 $rangeArray = explode('/', $range);
3064 if (count ($rangeArray) != 2)
3065 return "Invalid IPv4 prefix '${range}'";
3066 $ip = $rangeArray[0];
3067 $mask = $rangeArray[1];
3068
3069 if (empty ($ip) or empty ($mask))
3070 return "Invalid IPv4 prefix '${range}'";
3071 $ipL = ip2long($ip);
3072 $maskL = ip2long($mask);
3073 if ($ipL == -1 || $ipL === FALSE)
3074 return 'Bad IPv4 address';
3075 if ($mask < 32 && $mask > 0)
3076 $maskL = $mask;
3077 else
3078 {
3079 $maskB = decbin($maskL);
3080 if (strlen($maskB)!=32)
3081 return 'Invalid netmask';
3082 $ones=0;
3083 $zeroes=FALSE;
3084 foreach( str_split ($maskB) as $digit)
3085 {
3086 if ($digit == '0')
3087 $zeroes = TRUE;
3088 if ($digit == '1')
3089 {
3090 $ones++;
3091 if ($zeroes == TRUE)
3092 return 'Invalid netmask';
3093 }
3094 }
3095 $maskL = $ones;
3096 }
3097 $binmask = binMaskFromDec($maskL);
3098 $ipL = $ipL & $binmask;
3099 $result = useInsertBlade
3100 (
3101 'IPv4Network',
3102 array
3103 (
3104 'ip' => sprintf ('%u', $ipL),
3105 'mask' => "'${maskL}'",
3106 'name' => "'${name}'"
3107 )
3108 );
3109 if ($result != TRUE)
3110 return "Could not add ${range} (already exists?).";
3111
3112 if ($is_bcast and $maskL < 31)
3113 {
3114 $network_addr = long2ip ($ipL);
3115 $broadcast_addr = long2ip ($ipL | binInvMaskFromDec ($maskL));
3116 updateAddress ($network_addr, 'network', 'yes');
3117 updateAddress ($broadcast_addr, 'broadcast', 'yes');
3118 }
3119 return produceTagsForLastRecord ('ipv4net', $taglist);
3120 }
3121
3122 // FIXME: This function doesn't wipe relevant records from IPv4Address table.
3123 function destroyIPv4Prefix ($id = 0)
3124 {
3125 if ($id <= 0)
3126 return __FUNCTION__ . ': Invalid IPv4 prefix ID';
3127 if (!useDeleteBlade ('IPv4Network', 'id', $id))
3128 return __FUNCTION__ . ': SQL query #1 failed';
3129 if (!destroyTagsForEntity ('ipv4net', $id))
3130 return __FUNCTION__ . ': SQL query #2 failed';
3131 return '';
3132 }
3133
3134 function loadScript ($name)
3135 {
3136 $result = useSelectBlade ("select script_text from Script where script_name = '${name}'");
3137 $row = $result->fetch (PDO::FETCH_NUM);
3138 if ($row !== FALSE)
3139 return $row[0];
3140 else
3141 return NULL;
3142 }
3143
3144 function saveScript ($name, $text)
3145 {
3146 if (empty ($name))
3147 {
3148 showError ('Invalid argument');
3149 return FALSE;
3150 }
3151 // delete regardless of existence
3152 useDeleteBlade ('Script', 'script_name', "'${name}'");
3153 return useInsertBlade
3154 (
3155 'Script',
3156 array
3157 (
3158 'script_name' => "'${name}'",
3159 'script_text' => "'${text}'"
3160 )
3161 );
3162 }
3163
3164 function newPortForwarding ($object_id, $localip, $localport, $remoteip, $remoteport, $proto, $description)
3165 {
3166 if (NULL === getIPv4AddressNetworkId ($localip))
3167 return "$localip: Non existant ip";
3168 if (NULL === getIPv4AddressNetworkId ($localip))
3169 return "$remoteip: Non existant ip";
3170 if ( ($localport <= 0) or ($localport >= 65536) )
3171 return "$localport: invaild port";
3172 if ( ($remoteport <= 0) or ($remoteport >= 65536) )
3173 return "$remoteport: invaild port";
3174
3175 $result = useInsertBlade
3176 (
3177 'IPv4NAT',
3178 array
3179 (
3180 'object_id' => $object_id,
3181 'localip' => "INET_ATON('${localip}')",
3182 'remoteip' => "INET_ATON('$remoteip')",
3183 'localport' => $localport,
3184 'remoteport' => $remoteport,
3185 'proto' => "'${proto}'",
3186 'description' => "'${description}'",
3187 )
3188 );
3189 if ($result)
3190 return '';
3191 else
3192 return __FUNCTION__ . ': Failed to insert the rule.';
3193 }
3194
3195 function deletePortForwarding ($object_id, $localip, $localport, $remoteip, $remoteport, $proto)
3196 {
3197 global $dbxlink;
3198
3199 $query =
3200 "delete from IPv4NAT where object_id='$object_id' and localip=INET_ATON('$localip') and remoteip=INET_ATON('$remoteip') and localport='$localport' and remoteport='$remoteport' and proto='$proto'";
3201 $result = $dbxlink->exec ($query);
3202 return '';
3203 }
3204
3205 function updatePortForwarding ($object_id, $localip, $localport, $remoteip, $remoteport, $proto, $description)
3206 {
3207 global $dbxlink;
3208
3209 $query =
3210 "update IPv4NAT 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'";
3211 $result = $dbxlink->exec ($query);
3212 return '';
3213 }
3214
3215 function getNATv4ForObject ($object_id)
3216 {
3217 $ret = array();
3218 $ret['out'] = array();
3219 $ret['in'] = array();
3220 $query =
3221 "select ".
3222 "proto, ".
3223 "INET_NTOA(localip) as localip, ".
3224 "localport, ".
3225 "INET_NTOA(remoteip) as remoteip, ".
3226 "remoteport, ".
3227 "ipa1.name as local_addr_name, " .
3228 "ipa2.name as remote_addr_name, " .
3229 "description ".
3230 "from IPv4NAT ".
3231 "left join IPv4Address as ipa1 on IPv4NAT.localip = ipa1.ip " .
3232 "left join IPv4Address as ipa2 on IPv4NAT.remoteip = ipa2.ip " .
3233 "where object_id='$object_id' ".
3234 "order by localip, localport, proto, remoteip, remoteport";
3235 $result = useSelectBlade ($query, __FUNCTION__);
3236 $count=0;
3237 while ($row = $result->fetch (PDO::FETCH_ASSOC))
3238 {
3239 foreach (array ('proto', 'localport', 'localip', 'remoteport', 'remoteip', 'description', 'local_addr_name', 'remote_addr_name') as $cname)
3240 $ret['out'][$count][$cname] = $row[$cname];
3241 $count++;
3242 }
3243 $result->closeCursor();
3244 unset ($result);
3245
3246 $query =
3247 "select ".
3248 "proto, ".
3249 "INET_NTOA(localip) as localip, ".
3250 "localport, ".
3251 "INET_NTOA(remoteip) as remoteip, ".
3252 "remoteport, ".
3253 "IPv4NAT.object_id as object_id, ".
3254 "RackObject.name as object_name, ".
3255 "description ".
3256 "from ((IPv4NAT join IPv4Allocation on remoteip=IPv4Allocation.ip) join RackObject on IPv4NAT.object_id=RackObject.id) ".
3257 "where IPv4Allocation.object_id='$object_id' ".
3258 "order by remoteip, remoteport, proto, localip, localport";
3259 $result = useSelectBlade ($query, __FUNCTION__);
3260 $count=0;
3261 while ($row = $result->fetch (PDO::FETCH_ASSOC))
3262 {
3263 foreach (array ('proto', 'localport', 'localip', 'remoteport', 'remoteip', 'object_id', 'object_name', 'description') as $cname)
3264 $ret['in'][$count][$cname] = $row[$cname];
3265 $count++;
3266 }
3267 $result->closeCursor();
3268
3269 return $ret;
3270 }
3271
3272 // This function performs search and then calculates score for each result.
3273 // Given previous search results in $objects argument, it adds new results
3274 // to the array and updates score for existing results, if it is greater than
3275 // existing score.
3276 function mergeSearchResults (&$objects, $terms, $fieldname)
3277 {
3278 global $dbxlink;
3279 $query =
3280 "select ro.name, label, asset_no, barcode, ro.id, dict_key as objtype_id, " .
3281 "dict_value as objtype_name, asset_no from RackObject as ro inner join Dictionary " .
3282 "on objtype_id = dict_key join Chapter on Chapter.id = Dictionary.chapter_id where Chapter.name = 'RackObjectType' and ";
3283 $count = 0;
3284 foreach (explode (' ', $terms) as $term)
3285 {
3286 if ($count) $query .= ' or ';
3287 $query .= "ro.${fieldname} like '%$term%'";
3288 $count++;
3289 }
3290 $query .= " order by ${fieldname}";
3291 $result = useSelectBlade ($query, __FUNCTION__);
3292 $clist = array ('id', 'name', 'label', 'asset_no', 'barcode', 'objtype_id', 'objtype_name');
3293 while ($row = $result->fetch (PDO::FETCH_ASSOC))
3294 {
3295 foreach ($clist as $cname)
3296 $object[$cname] = $row[$cname];
3297 $object['score'] = 0;
3298 $object['dname'] = displayedName ($object);
3299 unset ($object['objtype_id']);
3300 foreach (explode (' ', $terms) as $term)
3301 if (strstr ($object['name'], $term))
3302 $object['score'] += 1;
3303 unset ($object['name']);
3304 if (!isset ($objects[$row['id']]))
3305 $objects[$row['id']] = $object;
3306 elseif ($objects[$row['id']]['score'] < $object['score'])
3307 $objects[$row['id']]['score'] = $object['score'];
3308 }
3309 return $objects;
3310 }
3311
3312 function getLostIPv4Addresses ()
3313 {
3314 dragon();
3315 }
3316
3317 // Return a list of files which are not linked to the specified record. This list
3318 // will be used by printSelect().
3319 function getAllUnlinkedFiles ($entity_type = NULL, $entity_id = 0)
3320 {
3321 if ($entity_type == NULL || $entity_id == 0)
3322 {
3323 showError ('Invalid parameters', __FUNCTION__);
3324 return NULL;
3325 }
3326 global $dbxlink;
3327 $sql =
3328 'SELECT id, name FROM File ' .
3329 'WHERE id NOT IN (SELECT file_id FROM FileLink WHERE entity_type = ? AND entity_id = ?) ' .
3330 'ORDER BY name, id';
3331 $query = $dbxlink->prepare($sql);
3332 $query->bindParam(1, $entity_type);
3333 $query->bindParam(2, $entity_id);
3334 $query->execute();
3335 $ret=array();
3336 while ($row = $query->fetch (PDO::FETCH_ASSOC))
3337 $ret[$row['id']] = $row['name'];
3338 return $ret;
3339 }
3340
3341 // FIXME: return a standard cell list, so upper layer can iterate over
3342 // it conveniently.
3343 function getFilesOfEntity ($entity_type = NULL, $entity_id = 0)
3344 {
3345 if ($entity_type == NULL || $entity_id == 0)
3346 {
3347 showError ('Invalid parameters', __FUNCTION__);
3348 return NULL;
3349 }
3350 global $dbxlink;
3351 $sql =
3352 'SELECT FileLink.file_id, FileLink.id AS link_id, name, type, size, ctime, mtime, atime, comment ' .
3353 'FROM FileLink LEFT JOIN File ON FileLink.file_id = File.id ' .
3354 'WHERE FileLink.entity_type = ? AND FileLink.entity_id = ? ORDER BY name';
3355 $query = $dbxlink->prepare($sql);
3356 $query->bindParam(1, $entity_type);
3357 $query->bindParam(2, $entity_id);
3358 $query->execute();
3359 $ret = array();
3360 while ($row = $query->fetch (PDO::FETCH_ASSOC))
3361 $ret[$row['file_id']] = array (
3362 'id' => $row['file_id'],
3363 'link_id' => $row['link_id'],
3364 'name' => $row['name'],
3365 'type' => $row['type'],
3366 'size' => $row['size'],
3367 'ctime' => $row['ctime'],
3368 'mtime' => $row['mtime'],