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