/usr/share/icingaweb2/modules/monitoring/library/Monitoring/Backend/Ido/Query/IdoQuery.php is in icingaweb2-module-monitoring 2.1.0-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 | <?php
/* Icinga Web 2 | (c) 2013-2015 Icinga Development Team | GPLv2+ */
namespace Icinga\Module\Monitoring\Backend\Ido\Query;
use Zend_Db_Expr;
use Icinga\Application\Icinga;
use Icinga\Application\Hook;
use Icinga\Application\Logger;
use Icinga\Data\Db\DbQuery;
use Icinga\Data\Filter\Filter;
use Icinga\Data\Filter\FilterExpression;
use Icinga\Exception\IcingaException;
use Icinga\Exception\ProgrammingError;
use Icinga\Exception\QueryException;
use Icinga\Web\Session;
use Icinga\Module\Monitoring\Data\ColumnFilterIterator;
/**
* Base class for Ido Queries
*
* This is the base class for all Ido queries and should be extended for new queries
* The starting point for implementations is the columnMap attribute. This is an asscociative array in the
* following form:
*
* <pre>
* <code>
* array(
* 'virtualTable' => array(
* 'fieldalias1' => 'queryColumn1',
* 'fieldalias2' => 'queryColumn2',
* ....
* ),
* 'virtualTable2' => array(
* 'host' => 'host_name1'
* )
* )
* </code>
* </pre>
*
* This allows you to select e.g. fieldalias1, which automatically calls the query code for joining 'virtualTable'. If
* you afterwards select 'host', 'virtualTable2' will be joined. The joining logic is up to you, in order to make the
* above example work you need to implement the joinVirtualTable() method which contain your
* custom (Zend_Db) logic for joining, filtering and querying the data you want.
*
*/
abstract class IdoQuery extends DbQuery
{
/**
* The prefix to use
*
* @var string
*/
protected $prefix;
/**
* An array to map aliases to column names
*
* @var array
*/
protected $idxAliasColumn;
/**
* An array to map aliases to table names
*
* @var array
*/
protected $idxAliasTable;
/**
* An array to map custom aliases to aliases
*
* @var array
*/
protected $idxCustomAliases;
/**
* The column map containing all filterable columns
*
* This must be overwritten by child classes, in the format
* array(
* 'virtualTable' => array(
* 'fieldalias1' => 'queryColumn1',
* 'fieldalias2' => 'queryColumn2',
* ....
* )
* )
*
* @var array
*/
protected $columnMap = array();
/**
* Custom vars available for this query
*
* @var array
*/
protected $customVars = array();
/**
* Printf compatible string to joins custom vars
*
* - %1$s Source field, contain the object_id
* - %2$s Alias used for the relation
* - %3$s Name of the CustomVariable
*
* @var string
*/
private $customVarsJoinTemplate =
'%1$s = %2$s.object_id AND %2$s.varname = %3$s COLLATE latin1_general_ci';
/**
* An array with all 'virtual' tables that are already joined
*
* Virtual tables are the keys of the columnMap array and require a
* join%VirtualTableName%() method to be defined in the concrete
* query
*
* @var array
*/
protected $joinedVirtualTables = array();
/**
* A map of virtual table names and corresponding hook instances
*
* Joins for those tables will be delegated to them
*
* @var array
*/
protected $hookedVirtualTables = array();
/**
* List of column aliases used for sorting the result
*
* @var array
*/
protected $orderColumns = array();
/**
* Table to columns map which have to be added to the GROUP BY list if the query is grouped
*
* @var array
*/
protected $groupBase = array();
/**
* List of table names which initiate grouping if one of them is joined
*
* @var array
*/
protected $groupOrigin = array();
/**
* The primary key column for the instances table
*
* @var string
*/
protected $instance_id = 'instance_id';
/**
* The primary key column for the objects table
*
* @var string
*/
protected $object_id = 'object_id';
/**
* The primary key column for the acknowledgements table
*
* @var string
*/
protected $acknowledgement_id = 'acknowledgement_id';
/**
* The primary key column for the commenthistory table
*
* @var string
*/
protected $commenthistory_id = 'commenthistory_id';
/**
* The primary key column for the contactnotifications table
*
* @var string
*/
protected $contactnotification_id = 'contactnotification_id';
/**
* The primary key column for the downtimehistory table
*
* @var string
*/
protected $downtimehistory_id = 'downtimehistory_id';
/**
* The primary key column for the flappinghistory table
*
* @var string
*/
protected $flappinghistory_id = 'flappinghistory_id';
/**
* The primary key column for the notifications table
*
* @var string
*/
protected $notification_id = 'notification_id';
/**
* The primary key column for the statehistory table
*
* @var string
*/
protected $statehistory_id = 'statehistory_id';
/**
* The primary key column for the comments table
*
* @var string
*/
protected $comment_id = 'comment_id';
/**
* The primary key column for the customvariablestatus table
*
* @var string
*/
protected $customvariablestatus_id = 'customvariablestatus_id';
/**
* The primary key column for the hoststatus table
*
* @var string
*/
protected $hoststatus_id = 'hoststatus_id';
/**
* The primary key column for the programstatus table
*
* @var string
*/
protected $programstatus_id = 'programstatus_id';
/**
* The primary key column for the runtimevariables table
*
* @var string
*/
protected $runtimevariable_id = 'runtimevariable_id';
/**
* The primary key column for the scheduleddowntime table
*
* @var string
*/
protected $scheduleddowntime_id = 'scheduleddowntime_id';
/**
* The primary key column for the servicestatus table
*
* @var string
*/
protected $servicestatus_id = 'servicestatus_id';
/**
* The primary key column for the contactstatus table
*
* @var string
*/
protected $contactstatus_id = 'contactstatus_id';
/**
* The primary key column for the commands table
*
* @var string
*/
protected $command_id = 'command_id';
/**
* The primary key column for the contactgroup_members table
*
* @var string
*/
protected $contactgroup_member_id = 'contactgroup_member_id';
/**
* The primary key column for the contactgroups table
*
* @var string
*/
protected $contactgroup_id = 'contactgroup_id';
/**
* The primary key column for the contacts table
*
* @var string
*/
protected $contact_id = 'contact_id';
/**
* The primary key column for the customvariables table
*
* @var string
*/
protected $customvariable_id = 'customvariable_id';
/**
* The primary key column for the host_contactgroups table
*
* @var string
*/
protected $host_contactgroup_id = 'host_contactgroup_id';
/**
* The primary key column for the host_contacts table
*
* @var string
*/
protected $host_contact_id = 'host_contact_id';
/**
* The primary key column for the hostgroup_members table
*
* @var string
*/
protected $hostgroup_member_id = 'hostgroup_member_id';
/**
* The primary key column for the hostgroups table
*
* @var string
*/
protected $hostgroup_id = 'hostgroup_id';
/**
* The primary key column for the hosts table
*
* @var string
*/
protected $host_id = 'host_id';
/**
* The primary key column for the service_contactgroup table
*
* @var string
*/
protected $service_contactgroup_id = 'service_contactgroup_id';
/**
* The primary key column for the service_contact table
*
* @var string
*/
protected $service_contact_id = 'service_contact_id';
/**
* The primary key column for the servicegroup_members table
*
* @var string
*/
protected $servicegroup_member_id = 'servicegroup_member_id';
/**
* The primary key column for the servicegroups table
*
* @var string
*/
protected $servicegroup_id = 'servicegroup_id';
/**
* The primary key column for the services table
*
* @var string
*/
protected $service_id = 'service_id';
/**
* The primary key column for the timeperiods table
*
* @var string
*/
protected $timeperiod_id = 'timeperiod_id';
/**
* An array containing Column names that cause an aggregation of the query
*
* @var array
*/
protected $aggregateColumnIdx = array();
/**
* True to allow customvar filters and queries
*
* @var bool
*/
protected $allowCustomVars = false;
/**
* Current IDO version. This is bullshit and needs to be moved somewhere
* else. As someone decided that we need no Backend-specific connection
* class unfortunately there is no better place right now. And as of the
* 'check_source' patch we need a quick fix immediately. So here you go.
*
* TODO: Fix this.
*
* @var string
*/
protected static $idoVersion;
/**
* List of column aliases mapped to their table where the COLLATE SQL-instruction has been removed
*
* This list is being populated in case of a PostgreSQL backend only,
* to ensure case-insensitive string comparison in WHERE clauses.
*
* @var array
*/
protected $caseInsensitiveColumns;
/**
* Return true when the column is an aggregate column
*
* @param String $column The column to test
* @return bool True when the column is an aggregate column
*/
public function isAggregateColumn($column)
{
return array_key_exists($column, $this->aggregateColumnIdx);
}
/**
* Order the result by the given alias
*
* @param string $alias The column alias to order by
* @param int $dir The sort direction or null to use the default direction
*
* @return $this
*/
public function order($alias, $dir = null)
{
$this->requireColumn($alias);
if ($this->isCustomvar($alias)) {
$column = $this->getCustomvarColumnName($alias);
} elseif ($this->hasAliasName($alias)) {
$column = $this->aliasToColumnName($alias);
$table = $this->aliasToTableName($alias);
if (isset($this->caseInsensitiveColumns[$table][$alias])) {
$column = 'LOWER(' . $column . ')';
}
} else {
Logger::info('Can\'t order by column ' . $alias);
return $this;
}
$this->orderColumns[] = $alias;
return parent::order($column, $dir);
}
/**
* Return true when the given field can be used for filtering
*
* @param String $field The field to test
* @return bool True when the field can be used for querying, otherwise false
*/
public function isValidFilterTarget($field)
{
return $this->getMappedField($field) !== null;
}
/**
* Return the resolved field for an alias
*
* @param String $field The alias to resolve
* @return String The resolved alias or null if unknown
*/
public function getMappedField($field)
{
foreach ($this->columnMap as $columnSource => $columnSet) {
if (isset($columnSet[$field])) {
return $columnSet[$field];
}
}
if ($this->isCustomVar($field)) {
return $this->getCustomvarColumnName($field);
}
return null;
}
public function distinct()
{
$this->select->distinct();
return $this;
}
protected function requireFilterColumns(Filter $filter)
{
if ($filter instanceof FilterExpression) {
if ($filter->getExpression() === '*') {
return; // Wildcard only filters are ignored so stop early here to avoid joining a table for nothing
}
$alias = $filter->getColumn();
$this->requireColumn($alias);
if ($this->isCustomvar($alias)) {
$column = $this->getCustomvarColumnName($alias);
} else {
$column = $this->aliasToColumnName($alias);
if (isset($this->caseInsensitiveColumns[$this->aliasToTableName($alias)][$alias])) {
$column = 'LOWER(' . $column . ')';
$expression = $filter->getExpression();
if (is_array($expression)) {
$filter->setExpression(array_map('strtolower', $expression));
} else {
$filter->setExpression(strtolower($expression));
}
}
}
$filter->setColumn($column);
} else {
foreach ($filter->filters() as $filter) {
$this->requireFilterColumns($filter);
}
}
}
/**
* {@inheritdoc}
*/
public function addFilter(Filter $filter)
{
$filter = clone $filter;
$this->requireFilterColumns($filter);
return parent::addFilter($filter);
}
public function where($condition, $value = null)
{
if ($value === '*') {
return $this; // Wildcard only filters are ignored so stop early here to avoid joining a table for nothing
}
$this->requireColumn($condition);
$col = $this->getMappedField($condition);
if ($col === null) {
throw new IcingaException(
'No such field: %s',
$condition
);
}
return parent::where($col, $value);
}
/**
* Return true if an field contains an explicit timestamp
*
* @param string $field The field to test for containing an timestamp
*
* @return bool True when the field represents an timestamp
*/
public function isTimestamp($field)
{
if ($this->isCustomVar($field)) {
return false;
}
return stripos($this->getMappedField($field) ?: $field, 'UNIX_TIMESTAMP') !== false;
}
/**
* Return whether the given alias provides case insensitive value comparison
*
* @param string $alias
*
* @return bool
*/
public function isCaseInsensitive($alias)
{
if ($this->isCustomVar($alias)) {
return false;
}
$column = $this->getMappedField($alias);
if (! $column) {
return false;
}
if (empty($this->caseInsensitiveColumns)) {
return preg_match('/ COLLATE .+$/', $column) === 1;
}
if (strpos($column, 'LOWER') === 0) {
return true;
}
$table = $this->aliasToTableName($alias);
if (! $table) {
return false;
}
return isset($this->caseInsensitiveColumns[$table][$alias]);
}
/**
* Return our column map
*
* Might be useful for hooks
*
* @return array
*/
public function getColumnMap()
{
return $this->columnMap;
}
/**
* Apply oracle specific query initialization
*/
private function initializeForOracle()
{
// Oracle uses the reserved field 'id' for primary keys, so
// these must be used instead of the normally defined ids
$this->object_id = $this->host_id = $this->service_id
= $this->hostgroup_id = $this->servicegroup_id
= $this->contact_id = $this->contactgroup_id = 'id';
$this->customVarsJoinTemplate =
'%1$s = %2$s.object_id AND LOWER(%2$s.varname) = %3$s';
foreach ($this->columnMap as &$columns) {
foreach ($columns as &$value) {
$value = preg_replace('/UNIX_TIMESTAMP/', 'localts2unixts', $value);
$value = preg_replace('/ COLLATE .+$/', '', $value);
}
}
}
/**
* Apply PostgreSQL specific query initialization
*/
private function initializeForPostgres()
{
$this->customVarsJoinTemplate =
'%1$s = %2$s.object_id AND LOWER(%2$s.varname) = %3$s';
foreach ($this->columnMap as $table => & $columns) {
foreach ($columns as $alias => & $column) {
// Using a regex here because COLLATE may occur anywhere in the string
$column = preg_replace('/ COLLATE .+$/', '', $column, -1, $count);
if ($count > 0) {
$this->caseInsensitiveColumns[$table][$alias] = true;
}
$column = preg_replace(
'/inet_aton\(([[:word:].]+)\)/i',
'(CASE WHEN $1 ~ \'(?:[0-9]{1,3}\\\\.){3}[0-9]{1,3}\' THEN $1::inet - \'0.0.0.0\' ELSE NULL END)',
$column
);
$column = preg_replace(
'/UNIX_TIMESTAMP(\((?>[^()]|(?-1))*\))/i',
'CASE WHEN ($1 < \'1970-01-03 00:00:00+00\'::timestamp with time zone) THEN 0 ELSE UNIX_TIMESTAMP($1) END',
$column
);
}
}
}
/**
* Set up this query and join the initial tables
*
* @see IdoQuery::initializeForPostgres For postgresql specific setup
*/
protected function init()
{
parent::init();
$this->prefix = $this->ds->getTablePrefix();
foreach (Hook::all('monitoring/idoQueryExtension') as $hook) {
$extensions = $hook->extendColumnMap($this);
if (! is_array($extensions)) continue;
foreach ($extensions as $vTable => $cols) {
if (! array_key_exists($vTable, $this->columnMap)) {
$this->hookedVirtualTables[$vTable] = $hook;
$this->columMap[$vTable] = array();
}
foreach ($cols as $k => $v) {
$this->columnMap[$vTable][$k] = $v;
}
}
}
$dbType = $this->ds->getDbType();
if ($dbType === 'oracle') {
$this->initializeForOracle();
} elseif ($dbType === 'pgsql') {
$this->initializeForPostgres();
}
$this->joinBaseTables();
$this->select->columns($this->columns);
$this->prepareAliasIndexes();
}
/**
* Join the base tables for this query
*/
protected function joinBaseTables()
{
reset($this->columnMap);
$table = key($this->columnMap);
$this->select->from(
array($table => $this->prefix . $table),
array()
);
$this->joinedVirtualTables = array($table => true);
}
/**
* Populates the idxAliasTAble and idxAliasColumn properties
*/
protected function prepareAliasIndexes()
{
foreach ($this->columnMap as $tbl => & $cols) {
foreach ($cols as $alias => $col) {
$this->idxAliasTable[$alias] = $tbl;
$this->idxAliasColumn[$alias] = preg_replace('~\n\s*~', ' ', $col);
}
}
}
/**
* Resolve columns aliases to their database field using the columnMap
*
* @param array $columns
*
* @return array
*/
public function resolveColumns($columns)
{
$resolvedColumns = array();
foreach ($columns as $alias => $col) {
if ($col instanceof Zend_Db_Expr) {
// Support selecting NULL as column for example
$resolvedColumns[$alias] = $col;
continue;
}
$this->requireColumn($col);
if ($this->isCustomvar($col)) {
$name = $this->getCustomvarColumnName($col);
} else {
$name = $this->aliasToColumnName($col);
}
if (is_int($alias)) {
$alias = $col;
} else {
$this->idxCustomAliases[$alias] = $col;
}
$resolvedColumns[$alias] = preg_replace('|\n|', ' ', $name);
}
return $resolvedColumns;
}
/**
* Return all columns that will be selected when no columns are given in the constructor or from
*
* @return array An array of column aliases
*/
public function getDefaultColumns()
{
reset($this->columnMap);
$table = key($this->columnMap);
return array_keys($this->columnMap[$table]);
}
/**
* Modify the query to the given alias can be used in the result set or queries
*
* This calls requireVirtualTable if needed
*
* @param $alias The alias of the column to require
*
* @return $this Fluent interface
* @see IdoQuery::requireVirtualTable The method initializing required joins
* @throws \Icinga\Exception\ProgrammingError When an unknown column is requested
*/
public function requireColumn($alias)
{
if ($this->hasAliasName($alias)) {
$this->requireVirtualTable($this->aliasToTableName($alias));
} elseif ($this->isCustomVar($alias)) {
$this->requireCustomvar($alias);
} else {
throw new ProgrammingError(
'%s : Got invalid column: %s',
get_called_class(),
$alias
);
}
return $this;
}
/**
* Return true if the given alias exists
*
* @param String $alias The alias to test for
* @return bool True when the alias exists, otherwise false
*/
protected function hasAliasName($alias)
{
return array_key_exists($alias, $this->idxAliasColumn);
}
/**
* Require a virtual table for the given table name if not already required
*
* @param String $name The table name to require
* @return $this Fluent interface
*/
protected function requireVirtualTable($name)
{
if ($this->hasJoinedVirtualTable($name)) {
return $this;
}
if ($this->virtualTableIsHooked($name)) {
return $this->joinHookedVirtualTable($name);
} else {
return $this->joinVirtualTable($name);
}
}
/**
* Whether a given virtual table name has been provided by a hook
*
* @param string $name Virtual table name
*
* @return boolean
*/
protected function virtualTableIsHooked($name)
{
return array_key_exists($name, $this->hookedVirtualTables);
}
protected function conflictsWithVirtualTable($name)
{
if ($this->hasJoinedVirtualTable($name)) {
throw new ProgrammingError(
'IDO query virtual table conflict with "%s"',
$name
);
}
return $this;
}
/**
* Call the method for joining a virtual table
*
* This requires a join$Table() method to exist
*
* @param String $table The table to join by calling join$Table() in the concrete implementation
* @return $this Fluent interface
*
* @throws \Icinga\Exception\ProgrammingError If the join method for this table does not exist
*/
protected function joinVirtualTable($table)
{
$func = 'join' . ucfirst($table);
if (method_exists($this, $func)) {
$this->$func();
} else {
throw new ProgrammingError(
'Cannot join "%s", no such table found',
$table
);
}
$this->joinedVirtualTables[$table] = true;
return $this;
}
/**
* Tell a hook to join a virtual table
*
* @param String $table
* @return $this
*/
protected function joinHookedVirtualTable($table)
{
$this->hookedVirtualTables[$table]->joinVirtualTable($this, $table);
$this->joinedVirtualTables[$table] = true;
return $this;
}
/**
* Get the table for a specific alias
*
* @param String $alias The alias to request the table for
* @return String The table for the alias or null if it doesn't exist
*/
protected function aliasToTableName($alias)
{
return isset($this->idxAliasTable[$alias]) ? $this->idxAliasTable[$alias] : null;
}
/**
* Return whether this query allows to join custom variables
*
* @return bool
*/
public function allowsCustomVars()
{
return $this->allowCustomVars;
}
/**
* Return true if the given alias denotes a custom variable
*
* @param String $alias The alias to test for being a customvariable
* @return bool True if the alias is a customvariable, otherwise false
*/
protected function isCustomVar($alias)
{
return $this->allowCustomVars && $alias[0] === '_';
}
protected function requireCustomvar($customvar)
{
if (! $this->hasCustomvar($customvar)) {
$this->joinCustomvar($customvar);
}
return $this;
}
protected function hasCustomvar($customvar)
{
return array_key_exists(strtolower($customvar), $this->customVars);
}
protected function joinCustomvar($customvar)
{
// TODO: This is not generic enough yet
list($type, $name) = $this->customvarNameToTypeName($customvar);
$alias = ($type === 'host' ? 'hcv_' : 'scv_') . $name;
$this->customVars[strtolower($customvar)] = $alias;
if ($this->hasJoinedVirtualTable('services')) {
$leftcol = 's.' . $type . '_object_id';
} elseif ($type === 'service') {
$this->requireVirtualTable('services');
$leftcol = 's.service_object_id';
} else {
$this->requireVirtualTable('hosts');
$leftcol = 'h.host_object_id';
}
$joinOn = sprintf(
$this->customVarsJoinTemplate,
$leftcol,
$alias,
$this->db->quote($name)
);
$this->select->joinLeft(
array($alias => $this->prefix . 'customvariablestatus'),
$joinOn,
array()
);
return $this;
}
protected function customvarNameToTypeName($customvar)
{
$customvar = strtolower($customvar);
if (! preg_match('~^_(host|service)_([a-zA-Z0-9_]+)$~', $customvar, $m)) {
throw new ProgrammingError(
'Got invalid custom var: "%s"',
$customvar
);
}
return array($m[1], $m[2]);
}
protected function hasJoinedVirtualTable($name)
{
return array_key_exists($name, $this->joinedVirtualTables);
}
/**
* Get the query column of a already joined custom variable
*
* @param string $customvar
*
* @return string
* @throws QueryException If the custom variable has not been joined
*/
protected function getCustomvarColumnName($customvar)
{
if (! isset($this->customVars[($customvar = strtolower($customvar))])) {
throw new QueryException('Custom variable %s has not been joined', $customvar);
}
return $this->customVars[$customvar] . '.varvalue';
}
public function aliasToColumnName($alias)
{
return $this->idxAliasColumn[$alias];
}
/**
* Get the alias of a column expression as defined in the {@link $columnMap} property.
*
* @param string $alias Potential custom alias
*
* @return string
*/
public function customAliasToAlias($alias)
{
if (isset($this->idxCustomAliases[$alias])) {
return $this->idxCustomAliases[$alias];
}
return $alias;
}
/**
* Create a sub query
*
* @param string $queryName
* @param array $columns
*
* @return static
*/
protected function createSubQuery($queryName, $columns = array())
{
$class = '\\'
. substr(__CLASS__, 0, strrpos(__CLASS__, '\\') + 1)
. ucfirst($queryName) . 'Query';
$query = new $class($this->ds, $columns);
return $query;
}
/**
* Set columns to select
*
* @param array $columns
*
* @return $this
*/
public function columns(array $columns)
{
$this->idxCustomAliases = array();
$this->columns = $this->resolveColumns($columns);
// TODO: we need to refresh our select!
// $this->select->columns($columns);
return $this;
}
public function clearGroupingRules()
{
$this->groupBase = array();
$this->groupOrigin = array();
return $this;
}
/**
* Register the GROUP BY columns required for the given alias
*
* @param string $alias The alias to register columns for
* @param string $table The table the given alias is associated with
* @param array $groupedColumns The grouping columns registered so far
* @param array $groupedTables The tables for which columns were registered so far
*/
protected function registerGroupColumns($alias, $table, array &$groupedColumns, array &$groupedTables)
{
switch ($table) {
case 'checktimeperiods':
$groupedColumns[] = 'ctp.timeperiod_id';
break;
case 'contacts':
$groupedColumns[] = 'co.object_id';
$groupedColumns[] = 'c.contact_id';
break;
case 'hostobjects':
$groupedColumns[] = 'ho.object_id';
break;
case 'hosts':
$groupedColumns[] = 'h.host_id';
break;
case 'hostgroups':
$groupedColumns[] = 'hgo.object_id';
$groupedColumns[] = 'hg.hostgroup_id';
break;
case 'hoststatus':
$groupedColumns[] = 'hs.hoststatus_id';
break;
case 'instances':
$groupedColumns[] = 'i.instance_id';
break;
case 'servicegroups':
$groupedColumns[] = 'sgo.object_id';
$groupedColumns[] = 'sg.servicegroup_id';
break;
case 'serviceobjects':
$groupedColumns[] = 'so.object_id';
break;
case 'serviceproblemsummary':
$groupedColumns[] = 'sps.unhandled_services_count';
break;
case 'services':
$groupedColumns[] = 'so.object_id';
$groupedColumns[] = 's.service_id';
break;
case 'servicestatus':
$groupedColumns[] = 'ss.servicestatus_id';
break;
case 'timeperiods':
$groupedColumns[] = 'ht.timeperiod_id';
$groupedColumns[] = 'st.timeperiod_id';
break;
default:
return;
}
$groupedTables[$table] = true;
}
/**
* {@inheritdoc}
*/
public function getGroup()
{
$group = parent::getGroup() ?: array();
if (! is_array($group)) {
$group = array($group);
}
$joinedOrigins = array_filter($this->groupOrigin, array($this, 'hasJoinedVirtualTable'));
if (empty($joinedOrigins)) {
return $group;
}
$groupedTables = array();
foreach ($this->groupBase as $baseTable => $aliasedPks) {
$groupedTables[$baseTable] = true;
foreach ($aliasedPks as $aliasedPk) {
$group[] = $aliasedPk;
}
}
foreach (new ColumnFilterIterator($this->columns) as $desiredAlias => $desiredColumn) {
$alias = is_string($desiredAlias) ? $this->customAliasToAlias($desiredAlias) : $desiredColumn;
$table = $this->aliasToTableName($alias);
if ($table && !isset($groupedTables[$table]) && (
in_array($table, $joinedOrigins, true) || $this->getDatasource()->getDbType() === 'pgsql')
) {
$this->registerGroupColumns($alias, $table, $group, $groupedTables);
}
}
if (! empty($group) && $this->getDatasource()->getDbType() === 'pgsql') {
foreach (new ColumnFilterIterator($this->orderColumns) as $alias) {
$table = $this->aliasToTableName($alias);
if ($table && !isset($groupedTables[$table])
&& !in_array($this->getMappedField($alias), $this->columns, true)
) {
$this->registerGroupColumns($alias, $table, $group, $groupedTables);
}
}
}
return array_unique($group);
}
// TODO: Move this away, see note related to $idoVersion var
protected function getIdoVersion()
{
if (self::$idoVersion === null) {
$dbconf = $this->db->getConfig();
$id = $dbconf['host'] . '/' . $dbconf['dbname'];
$session = null;
if (Icinga::app()->isWeb()) {
// TODO: Once we have version per connection we should choose a
// namespace based on resource name
$session = Session::getSession()->getNamespace('monitoring/ido/' . $id);
if (isset($session->version)) {
self::$idoVersion = $session->version;
return self::$idoVersion;
}
}
self::$idoVersion = $this->db->fetchOne(
$this->db->select()->from($this->prefix . 'dbversion', 'version')
);
if ($session !== null) {
$session->version = self::$idoVersion;
}
}
return self::$idoVersion;
}
/**
* Return the name of the primary key column for the given table name
*
* @param string $table
*
* @return string
*
* @throws ProgrammingError In case $table is unknown
*/
protected function getPrimaryKeyColumn($table)
{
// TODO: For god's sake, make this being a mapping
// (instead of matching a ton of properties using a ridiculous long switch case)
switch ($table)
{
case 'instances':
return $this->instance_id;
case 'objects':
return $this->object_id;
case 'acknowledgements':
return $this->acknowledgement_id;
case 'commenthistory':
return $this->commenthistory_id;
case 'contactnotifiations':
return $this->contactnotification_id;
case 'downtimehistory':
return $this->downtimehistory_id;
case 'flappinghistory':
return $this->flappinghistory_id;
case 'notifications':
return $this->notification_id;
case 'statehistory':
return $this->statehistory_id;
case 'comments':
return $this->comment_id;
case 'customvariablestatus':
return $this->customvariablestatus_id;
case 'hoststatus':
return $this->hoststatus_id;
case 'programstatus':
return $this->programstatus_id;
case 'runtimevariables':
return $this->runtimevariable_id;
case 'scheduleddowntime':
return $this->scheduleddowntime_id;
case 'servicestatus':
return $this->servicestatus_id;
case 'contactstatus':
return $this->contactstatus_id;
case 'commands':
return $this->command_id;
case 'contactgroup_members':
return $this->contactgroup_member_id;
case 'contactgroups':
return $this->contactgroup_id;
case 'contacts':
return $this->contact_id;
case 'customvariables':
return $this->customvariable_id;
case 'host_contactgroups':
return $this->host_contactgroup_id;
case 'host_contacts':
return $this->host_contact_id;
case 'hostgroup_members':
return $this->hostgroup_member_id;
case 'hostgroups':
return $this->hostgroup_id;
case 'hosts':
return $this->host_id;
case 'service_contactgroups':
return $this->service_contactgroup_id;
case 'service_contacts':
return $this->service_contact_id;
case 'servicegroup_members':
return $this->servicegroup_member_id;
case 'servicegroups':
return $this->servicegroup_id;
case 'services':
return $this->service_id;
case 'timeperiods':
return $this->timeperiod_id;
default:
throw new ProgrammingError('Cannot provide a primary key column. Table "%s" is unknown', $table);
}
}
}
|