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