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
|
<?php
/*
** Zabbix
** Copyright (C) 2001-2019 Zabbix SIA
**
** This program is free software; you can redistribute it and/or modify
** it under the terms of the GNU General Public License as published by
** the Free Software Foundation; either version 2 of the License, or
** (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with this program; if not, write to the Free Software
** Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
**/
/**
* Class containing methods for operations with maintenances.
*/
class CMaintenance extends CApiService {
protected $tableName = 'maintenances';
protected $tableAlias = 'm';
protected $sortColumns = ['maintenanceid', 'name', 'maintenance_type', 'active_till', 'active_since'];
/**
* Get maintenances data.
*
* @param array $options
* @param array $options['itemids']
* @param array $options['hostids']
* @param array $options['groupids']
* @param array $options['triggerids']
* @param array $options['maintenanceids']
* @param bool $options['status']
* @param bool $options['editable']
* @param bool $options['count']
* @param string $options['pattern']
* @param int $options['limit']
* @param string $options['order']
*
* @return array
*/
public function get(array $options = []) {
$result = [];
$sqlParts = [
'select' => ['maintenance' => 'm.maintenanceid'],
'from' => ['maintenances' => 'maintenances m'],
'where' => [],
'group' => [],
'order' => [],
'limit' => null
];
$defOptions = [
'groupids' => null,
'hostids' => null,
'maintenanceids' => null,
'editable' => false,
'nopermissions' => null,
// filter
'filter' => null,
'search' => null,
'searchByAny' => null,
'startSearch' => false,
'excludeSearch' => false,
'searchWildcardsEnabled' => null,
// output
'output' => API_OUTPUT_EXTEND,
'selectGroups' => null,
'selectHosts' => null,
'selectTags' => null,
'selectTimeperiods' => null,
'countOutput' => false,
'groupCount' => false,
'preservekeys' => false,
'sortfield' => '',
'sortorder' => '',
'limit' => null
];
$options = zbx_array_merge($defOptions, $options);
// editable + PERMISSION CHECK
$maintenanceids = [];
if (self::$userData['type'] == USER_TYPE_SUPER_ADMIN || $options['nopermissions']) {
if (!is_null($options['groupids']) || !is_null($options['hostids'])) {
if (!is_null($options['groupids'])) {
zbx_value2array($options['groupids']);
$res = DBselect(
'SELECT mmg.maintenanceid'.
' FROM maintenances_groups mmg'.
' WHERE '.dbConditionInt('mmg.groupid', $options['groupids'])
);
while ($maintenance = DBfetch($res)) {
$maintenanceids[] = $maintenance['maintenanceid'];
}
}
$sql = 'SELECT mmh.maintenanceid'.
' FROM maintenances_hosts mmh,hosts_groups hg'.
' WHERE hg.hostid=mmh.hostid';
if (!is_null($options['groupids'])) {
zbx_value2array($options['groupids']);
$sql .= ' AND '.dbConditionInt('hg.groupid', $options['groupids']);
}
if (!is_null($options['hostids'])) {
zbx_value2array($options['hostids']);
$sql .= ' AND '.dbConditionInt('hg.hostid', $options['hostids']);
}
$res = DBselect($sql);
while ($maintenance = DBfetch($res)) {
$maintenanceids[] = $maintenance['maintenanceid'];
}
$sqlParts['where'][] = dbConditionInt('m.maintenanceid', $maintenanceids);
}
}
else {
$permission = $options['editable'] ? PERM_READ_WRITE : PERM_READ;
$userGroups = getUserGroupsByUserId(self::$userData['userid']);
$sql = 'SELECT m.maintenanceid'.
' FROM maintenances m'.
' WHERE NOT EXISTS ('.
'SELECT NULL'.
' FROM maintenances_hosts mh,hosts_groups hg'.
' LEFT JOIN rights r'.
' ON r.id=hg.groupid'.
' AND '.dbConditionInt('r.groupid', $userGroups).
' WHERE m.maintenanceid=mh.maintenanceid'.
' AND mh.hostid=hg.hostid'.
' GROUP by mh.hostid'.
' HAVING MIN(r.permission) IS NULL'.
' OR MIN(r.permission)='.PERM_DENY.
' OR MAX(r.permission)<'.zbx_dbstr($permission).
')'.
' AND NOT EXISTS ('.
'SELECT NULL'.
' FROM maintenances_groups mg'.
' LEFT JOIN rights r'.
' ON r.id=mg.groupid'.
' AND '.dbConditionInt('r.groupid', $userGroups).
' WHERE m.maintenanceid=mg.maintenanceid'.
' GROUP by mg.groupid'.
' HAVING MIN(r.permission) IS NULL'.
' OR MIN(r.permission)='.PERM_DENY.
' OR MAX(r.permission)<'.zbx_dbstr($permission).
')';
if (!is_null($options['groupids'])) {
zbx_value2array($options['groupids']);
$sql .= ' AND ('.
'EXISTS ('.
'SELECT NULL'.
' FROM maintenances_groups mg'.
' WHERE m.maintenanceid=mg.maintenanceid'.
' AND '.dbConditionInt('mg.groupid', $options['groupids']).
')'.
' OR EXISTS ('.
'SELECT NULL'.
' FROM maintenances_hosts mh,hosts_groups hg'.
' WHERE m.maintenanceid=mh.maintenanceid'.
' AND mh.hostid=hg.hostid'.
' AND '.dbConditionInt('hg.groupid', $options['groupids']).
')'.
')';
}
if (!is_null($options['hostids'])) {
zbx_value2array($options['hostids']);
$sql .= ' AND EXISTS ('.
'SELECT NULL'.
' FROM maintenances_hosts mh'.
' WHERE m.maintenanceid=mh.maintenanceid'.
' AND '.dbConditionInt('mh.hostid', $options['hostids']).
')';
}
if (!is_null($options['maintenanceids'])) {
zbx_value2array($options['maintenanceids']);
$sql .= ' AND '.dbConditionInt('m.maintenanceid', $options['maintenanceids']);
}
$res = DBselect($sql);
while ($maintenance = DBfetch($res)) {
$maintenanceids[] = $maintenance['maintenanceid'];
}
$sqlParts['where'][] = dbConditionInt('m.maintenanceid', $maintenanceids);
}
// maintenanceids
if (!is_null($options['maintenanceids'])) {
zbx_value2array($options['maintenanceids']);
$sqlParts['where'][] = dbConditionInt('m.maintenanceid', $options['maintenanceids']);
}
// filter
if (is_array($options['filter'])) {
$this->dbFilter('maintenances m', $options, $sqlParts);
}
// search
if (is_array($options['search'])) {
zbx_db_search('maintenances m', $options, $sqlParts);
}
// limit
if (zbx_ctype_digit($options['limit']) && $options['limit']) {
$sqlParts['limit'] = $options['limit'];
}
$sqlParts = $this->applyQueryOutputOptions($this->tableName(), $this->tableAlias(), $options, $sqlParts);
$sqlParts = $this->applyQuerySortOptions($this->tableName(), $this->tableAlias(), $options, $sqlParts);
$res = DBselect($this->createSelectQueryFromParts($sqlParts), $sqlParts['limit']);
while ($maintenance = DBfetch($res)) {
if ($options['countOutput']) {
if ($options['groupCount']) {
$result[] = $maintenance;
}
else {
$result = $maintenance['rowscount'];
}
}
else {
$result[$maintenance['maintenanceid']] = $maintenance;
}
}
if ($options['countOutput']) {
return $result;
}
if ($result) {
$result = $this->addRelatedObjects($options, $result);
}
if (!$options['preservekeys']) {
$result = zbx_cleanHashes($result);
}
return $result;
}
/**
* Add maintenances.
*
* @param array $maintenances
*
* @throws APIException if no permissions to object, it does no exists or validation errors.
*
* @return array
*/
public function create(array $maintenances) {
$maintenances = zbx_toArray($maintenances);
if (self::$userData['type'] == USER_TYPE_ZABBIX_USER) {
self::exception(ZBX_API_ERROR_PERMISSIONS, _('No permissions to referred object or it does not exist!'));
}
$hostids = [];
$groupids = [];
foreach ($maintenances as $maintenance) {
if (array_key_exists('hostids', $maintenance)) {
$hostids = array_merge($hostids, $maintenance['hostids']);
}
if (array_key_exists('groupids', $maintenance)) {
$groupids = array_merge($groupids, $maintenance['groupids']);
}
}
// validate hosts & groups
if (empty($hostids) && empty($groupids)) {
self::exception(ZBX_API_ERROR_PARAMETERS, _('At least one host group or host must be selected.'));
}
// hosts permissions
$options = [
'hostids' => $hostids,
'editable' => true,
'output' => ['hostid'],
'preservekeys' => true
];
$updHosts = API::Host()->get($options);
foreach ($hostids as $hostid) {
if (!isset($updHosts[$hostid])) {
self::exception(ZBX_API_ERROR_PERMISSIONS, _('No permissions to referred object or it does not exist!'));
}
}
// groups permissions
$options = [
'groupids' => $groupids,
'editable' => true,
'output' => ['groupid'],
'preservekeys' => true
];
$updGroups = API::HostGroup()->get($options);
foreach ($groupids as $groupid) {
if (!isset($updGroups[$groupid])) {
self::exception(ZBX_API_ERROR_PERMISSIONS, _('No permissions to referred object or it does not exist!'));
}
}
$this->removeSecondsFromTimes($maintenances);
$tid = 0;
$insert = [];
$timeperiods = [];
$insertTimeperiods = [];
$now = time();
$now -= $now % SEC_PER_MIN;
// check fields
foreach ($maintenances as $maintenance) {
$dbFields = [
'name' => null,
'active_since' => null,
'active_till' => null
];
if (!check_db_fields($dbFields, $maintenance)) {
self::exception(ZBX_API_ERROR_PARAMETERS, _('Incorrect parameters for maintenance.'));
}
}
$collectionValidator = new CCollectionValidator([
'uniqueField' => 'name',
'messageDuplicate' => _('Maintenance "%1$s" already exists.')
]);
$this->checkValidator($maintenances, $collectionValidator);
// validate if maintenance name already exists
$dbMaintenances = $this->get([
'output' => ['name'],
'filter' => ['name' => zbx_objectValues($maintenances, 'name')],
'nopermissions' => true,
'limit' => 1
]);
if ($dbMaintenances) {
$dbMaintenance = reset($dbMaintenances);
self::exception(ZBX_API_ERROR_PARAMETERS, _s('Maintenance "%1$s" already exists.', $dbMaintenance['name']));
}
foreach ($maintenances as $mnum => $maintenance) {
// validate maintenance active since
if (!validateUnixTime($maintenance['active_since'])) {
self::exception(ZBX_API_ERROR_PARAMETERS, _s('"%s" must be between 1970.01.01 and 2038.01.18.', _('Active since')));
}
// validate maintenance active till
if (!validateUnixTime($maintenance['active_till'])) {
self::exception(ZBX_API_ERROR_PARAMETERS, _s('"%s" must be between 1970.01.01 and 2038.01.18.', _('Active till')));
}
// validate maintenance active interval
if ($maintenance['active_since'] > $maintenance['active_till']) {
self::exception(ZBX_API_ERROR_PARAMETERS, _('Maintenance "Active since" value cannot be bigger than "Active till".'));
}
// validate timeperiods
if (!array_key_exists('timeperiods', $maintenance) || !is_array($maintenance['timeperiods'])
|| !$maintenance['timeperiods']) {
self::exception(ZBX_API_ERROR_PARAMETERS, _('At least one maintenance period must be created.'));
}
foreach ($maintenance['timeperiods'] as $timeperiod) {
if (!is_array($timeperiod)) {
self::exception(ZBX_API_ERROR_PARAMETERS, _('At least one maintenance period must be created.'));
}
$dbFields = [
'timeperiod_type' => TIMEPERIOD_TYPE_ONETIME,
'period' => SEC_PER_HOUR,
'start_date' => $now
];
check_db_fields($dbFields, $timeperiod);
$tid++;
$insertTimeperiods[$tid] = $timeperiod;
$timeperiods[$tid] = $mnum;
}
$insert[$mnum] = $maintenance;
$this->validateTags($maintenance);
}
$maintenanceids = DB::insert('maintenances', $insert);
$timeperiodids = DB::insert('timeperiods', $insertTimeperiods);
$insertWindows = [];
foreach ($timeperiods as $tid => $mnum) {
$insertWindows[] = [
'timeperiodid' => $timeperiodids[$tid],
'maintenanceid' => $maintenanceids[$mnum]
];
}
DB::insert('maintenances_windows', $insertWindows);
$insertHosts = [];
$insertGroups = [];
$ins_tags = [];
foreach ($maintenances as $mnum => $maintenance) {
if (array_key_exists('hostids', $maintenance)) {
foreach ($maintenance['hostids'] as $hostid) {
$insertHosts[] = [
'hostid' => $hostid,
'maintenanceid' => $maintenanceids[$mnum]
];
}
}
if (array_key_exists('groupids', $maintenance)) {
foreach ($maintenance['groupids'] as $groupid) {
$insertGroups[] = [
'groupid' => $groupid,
'maintenanceid' => $maintenanceids[$mnum]
];
}
}
if (array_key_exists('tags', $maintenance)) {
foreach ($maintenance['tags'] as $tag) {
$ins_tags[] = [
'maintenanceid' => $maintenanceids[$mnum]
] + $tag;
}
}
add_audit_details(AUDIT_ACTION_ADD, AUDIT_RESOURCE_MAINTENANCE, $maintenanceids[$mnum],
$maintenance['name'], null, self::$userData['userid']
);
}
DB::insert('maintenances_hosts', $insertHosts);
DB::insert('maintenances_groups', $insertGroups);
if ($ins_tags) {
DB::insert('maintenance_tag', $ins_tags);
}
return ['maintenanceids' => $maintenanceids];
}
/**
* Validates maintenance problem tags.
*
* @param array $maintenance
* @param int $maintenance['maintenance_type']
* @param int $maintenance['tags_evaltype']
* @param array $maintenance['tags']
* @param string $maintenance['tags'][]['tag']
* @param int $maintenance['tags'][]['operator']
* @param string $maintenance['tags'][]['value']
*
* @throws APIException if the input is invalid.
*/
private function validateTags(array $maintenance) {
if (array_key_exists('maintenance_type', $maintenance)
&& $maintenance['maintenance_type'] == MAINTENANCE_TYPE_NODATA
&& array_key_exists('tags', $maintenance) && $maintenance['tags']) {
self::exception(ZBX_API_ERROR_PARAMETERS,
_s('Incorrect value for field "%1$s": %2$s.', 'tags', _('should be empty'))
);
}
$api_input_rules = ['type' => API_OBJECT, 'fields' => [
'maintenance_type' => ['type' => API_INT32, 'in' => implode(',', [MAINTENANCE_TYPE_NORMAL, MAINTENANCE_TYPE_NODATA])],
'tags_evaltype' => ['type' => API_INT32, 'in' => implode(',', [MAINTENANCE_TAG_EVAL_TYPE_AND_OR, MAINTENANCE_TAG_EVAL_TYPE_OR])],
'tags' => ['type' => API_OBJECTS, 'uniq' => [['tag', 'operator', 'value']], 'fields' => [
'tag' => ['type' => API_STRING_UTF8, 'flags' => API_REQUIRED | API_NOT_EMPTY, 'length' => DB::getFieldLength('maintenance_tag', 'tag')],
'operator' => ['type' => API_INT32, 'in' => implode(',', [MAINTENANCE_TAG_OPERATOR_EQUAL, MAINTENANCE_TAG_OPERATOR_LIKE]), 'default' => DB::getDefault('maintenance_tag', 'operator')],
'value' => ['type' => API_STRING_UTF8, 'length' => DB::getFieldLength('maintenance_tag', 'value'), 'default' => DB::getDefault('maintenance_tag', 'value')]
]]
]];
// Keep values only for fields with defined validation rules.
$maintenance = array_intersect_key($maintenance, $api_input_rules['fields']);
if (!CApiInputValidator::validate($api_input_rules, $maintenance, '/', $error)) {
self::exception(ZBX_API_ERROR_PARAMETERS, $error);
}
}
/**
* Update maintenances.
*
* @param array $maintenances
*
* @throws APIException if no permissions to object, it does no exists or validation errors
*
* @return array
*/
public function update(array $maintenances) {
if (self::$userData['type'] == USER_TYPE_ZABBIX_USER) {
self::exception(ZBX_API_ERROR_PERMISSIONS, _('You do not have permission to perform this operation.'));
}
$maintenances = zbx_toArray($maintenances);
$maintenanceids = zbx_objectValues($maintenances, 'maintenanceid');
if (!$maintenances) {
self::exception(ZBX_API_ERROR_PARAMETERS, _('Empty input parameter.'));
}
$db_fields = [
'maintenanceid' => null
];
foreach ($maintenances as $maintenance) {
// Validate fields.
if (!check_db_fields($db_fields, $maintenance)) {
self::exception(ZBX_API_ERROR_PARAMETERS, _('Incorrect parameters for maintenance.'));
}
$this->validateTags($maintenance);
}
$db_maintenances = $this->get([
'output' => API_OUTPUT_EXTEND,
'maintenanceids' => $maintenanceids,
'selectGroups' => ['groupid'],
'selectHosts' => ['hostid'],
'selectTimeperiods' => API_OUTPUT_EXTEND,
'editable' => true,
'preservekeys' => true
]);
$changed_names = [];
$hostids = [];
$groupids = [];
foreach ($maintenances as $maintenance) {
if (!array_key_exists($maintenance['maintenanceid'], $db_maintenances)) {
self::exception(ZBX_API_ERROR_PERMISSIONS,
_('No permissions to referred object or it does not exist!')
);
}
// Check maintenances names and collect for unique checking.
if (array_key_exists('name', $maintenance) && $maintenance['name'] !== ''
&& $db_maintenances[$maintenance['maintenanceid']]['name'] !== $maintenance['name']) {
if (array_key_exists($maintenance['name'], $changed_names)) {
self::exception(ZBX_API_ERROR_PARAMETERS,
_s('Maintenance "%1$s" already exists.', $maintenance['name'])
);
}
$changed_names[$maintenance['name']] = $maintenance['name'];
}
// Validate maintenance active since.
if (array_key_exists('active_since', $maintenance)) {
$active_since = $maintenance['active_since'];
if (!validateUnixTime($active_since)) {
self::exception(ZBX_API_ERROR_PARAMETERS,
_s('"%s" must be between 1970.01.01 and 2038.01.18.', _('Active since'))
);
}
}
else {
$active_since = $db_maintenances[$maintenance['maintenanceid']]['active_since'];
}
// Validate maintenance active till.
if (array_key_exists('active_till', $maintenance)) {
$active_till = $maintenance['active_till'];
if (!validateUnixTime($active_till)) {
self::exception(ZBX_API_ERROR_PARAMETERS,
_s('"%s" must be between 1970.01.01 and 2038.01.18.', _('Active till'))
);
}
}
else {
$active_till = $db_maintenances[$maintenance['maintenanceid']]['active_till'];
}
// Validate maintenance active interval.
if ($active_since > $active_till) {
self::exception(ZBX_API_ERROR_PARAMETERS,
_('Maintenance "Active since" value cannot be bigger than "Active till".')
);
}
// Validate timeperiods.
if (array_key_exists('timeperiods', $maintenance)) {
if (!is_array($maintenance['timeperiods']) || !$maintenance['timeperiods']) {
self::exception(ZBX_API_ERROR_PARAMETERS, _('At least one maintenance period must be created.'));
}
foreach ($maintenance['timeperiods'] as $timeperiod) {
if (!is_array($timeperiod)) {
self::exception(ZBX_API_ERROR_PARAMETERS,
_('At least one maintenance period must be created.')
);
}
}
}
// Collect hostids for permission checking.
if (array_key_exists('hostids', $maintenance) && is_array($maintenance['hostids'])) {
$hostids = array_merge($hostids, $maintenance['hostids']);
$has_hosts = (bool) $maintenance['hostids'];
}
else {
$has_hosts = (bool) $db_maintenances[$maintenance['maintenanceid']]['hosts'];
}
// Collect groupids for permission checking.
if (array_key_exists('groupids', $maintenance) && is_array($maintenance['groupids'])) {
$groupids = array_merge($groupids, $maintenance['groupids']);
$has_groups = (bool) $maintenance['groupids'];
}
else {
$has_groups = (bool) $db_maintenances[$maintenance['maintenanceid']]['groups'];
}
if (!$has_hosts && !$has_groups) {
self::exception(ZBX_API_ERROR_PARAMETERS, _('At least one host group or host must be selected.'));
}
// Check if maintenance without data collection has no tags.
$db_maintenance_type = $db_maintenances[$maintenance['maintenanceid']]['maintenance_type'];
$maintenance_type = array_key_exists('maintenance_type', $maintenance)
? $maintenance['maintenance_type']
: $db_maintenance_type;
if ($db_maintenance_type == MAINTENANCE_TYPE_NODATA && $maintenance_type == $db_maintenance_type
&& array_key_exists('tags', $maintenance) && $maintenance['tags']) {
self::exception(ZBX_API_ERROR_PARAMETERS,
_s('Incorrect value for field "%1$s": %2$s.', 'tags', _('should be empty'))
);
}
}
// Check if maintenance already exists.
if ($changed_names) {
$db_maintenances_names = $this->get([
'output' => ['name'],
'filter' => ['name' => $changed_names],
'nopermissions' => true,
'limit' => 1
]);
if ($db_maintenances_names) {
$maintenance = reset($db_maintenances_names);
self::exception(ZBX_API_ERROR_PARAMETERS,
_s('Maintenance "%1$s" already exists.', $maintenance['name'])
);
}
}
// Check hosts permission and availability.
if ($hostids) {
$db_hosts = API::Host()->get([
'output' => [],
'hostids' => $hostids,
'editable' => true,
'preservekeys' => true
]);
foreach ($hostids as $hostid) {
if (!array_key_exists($hostid, $db_hosts)) {
self::exception(ZBX_API_ERROR_PERMISSIONS,
_('No permissions to referred object or it does not exist!')
);
}
}
}
// Check host groups permission and availability.
if ($groupids) {
$db_groups = API::HostGroup()->get([
'output' => [],
'groupids' => $groupids,
'editable' => true,
'preservekeys' => true
]);
foreach ($groupids as $groupid) {
if (!array_key_exists($groupid, $db_groups)) {
self::exception(ZBX_API_ERROR_PERMISSIONS,
_('No permissions to referred object or it does not exist!')
);
}
}
}
$this->removeSecondsFromTimes($maintenances);
$update_maintenances = [];
foreach ($maintenances as $mnum => $maintenance) {
$update_maintenances[$mnum] = [
'values' => $maintenance,
'where' => ['maintenanceid' => $maintenance['maintenanceid']]
];
// Update time periods.
if (array_key_exists('timeperiods', $maintenance)) {
$this->replaceTimePeriods($db_maintenances[$maintenance['maintenanceid']], $maintenance);
}
add_audit_ext(
AUDIT_ACTION_UPDATE,
AUDIT_RESOURCE_MAINTENANCE,
$maintenance['maintenanceid'],
array_key_exists('name', $maintenance)
? $maintenance['name']
: $db_maintenances[$maintenance['maintenanceid']]['name'],
'maintenances',
$db_maintenances[$maintenance['maintenanceid']],
$maintenance
);
}
DB::update('maintenances', $update_maintenances);
// Some of the hosts and groups bound to maintenance must be deleted, other inserted and others left alone.
$insert_hosts = [];
$insert_groups = [];
foreach ($maintenances as $maintenance) {
if (array_key_exists('hostids', $maintenance)) {
// Putting apart those host<->maintenance connections that should be inserted, deleted and not changed:
// $hosts_diff['first'] - new hosts, that should be inserted;
// $hosts_diff['second'] - hosts, that should be deleted;
// $hosts_diff['both'] - hosts, that should not be touched;
$hosts_diff = zbx_array_diff(
zbx_toObject($maintenance['hostids'], 'hostid'),
$db_maintenances[$maintenance['maintenanceid']]['hosts'],
'hostid'
);
foreach ($hosts_diff['first'] as $host) {
$insert_hosts[] = [
'hostid' => $host['hostid'],
'maintenanceid' => $maintenance['maintenanceid']
];
}
foreach ($hosts_diff['second'] as $host) {
DB::delete('maintenances_hosts', [
'hostid' => $host['hostid'],
'maintenanceid' => $maintenance['maintenanceid']
]);
}
}
if (array_key_exists('groupids', $maintenance)) {
// Now the same with the groups.
$groups_diff = zbx_array_diff(
zbx_toObject($maintenance['groupids'], 'groupid'),
$db_maintenances[$maintenance['maintenanceid']]['groups'],
'groupid'
);
foreach ($groups_diff['first'] as $group) {
$insert_groups[] = [
'groupid' => $group['groupid'],
'maintenanceid' => $maintenance['maintenanceid']
];
}
foreach ($groups_diff['second'] as $group) {
DB::delete('maintenances_groups', [
'groupid' => $group['groupid'],
'maintenanceid' => $maintenance['maintenanceid']
]);
}
}
}
if ($insert_hosts) {
DB::insert('maintenances_hosts', $insert_hosts);
}
if ($insert_groups) {
DB::insert('maintenances_groups', $insert_groups);
}
$this->updateTags($maintenances, $db_maintenances);
return ['maintenanceids' => $maintenanceids];
}
/**
* Compares input tags with tags stored in the database and performs tag deleting and inserting.
*
* @param array $maintenances
* @param int $maintenances[]['maintenanceid']
* @param int $maintenances[]['maintenance_type']
* @param array $maintenances[]['tags']
* @param string $maintenances[]['tags'][]['tag']
* @param int $maintenances[]['tags'][]['operator']
* @param string $maintenances[]['tags'][]['value']
* @param array $db_maintenances
* @param int $db_maintenances[<maintenanceid>]
* @param int $db_maintenances[<maintenanceid>]['maintenance_type']
*/
private function updateTags(array $maintenances, array $db_maintenances) {
$db_tags = API::getApiService()->select('maintenance_tag', [
'output' => ['maintenancetagid', 'maintenanceid', 'tag', 'operator', 'value'],
'filter' => ['maintenanceid' => array_keys($db_maintenances)],
'preservekeys' => true
]);
$relation_map = $this->createRelationMap($db_tags, 'maintenanceid', 'maintenancetagid');
$db_maintenances = $relation_map->mapMany($db_maintenances, $db_tags, 'tags');
$ins_tags = [];
$del_maintenancetagids = [];
foreach ($maintenances as $mnum => $maintenance) {
$maintenanceid = $maintenance['maintenanceid'];
if (array_key_exists('maintenance_type', $maintenance)
&& $maintenance['maintenance_type'] == MAINTENANCE_TYPE_NODATA
&& $db_maintenances[$maintenanceid]['tags']) {
foreach ($db_maintenances[$maintenanceid]['tags'] as $db_tag) {
$del_maintenancetagids[] = $db_tag['maintenancetagid'];
}
unset($maintenances[$mnum], $db_maintenances[$maintenanceid]);
continue;
}
if (!array_key_exists('tags', $maintenance)) {
unset($maintenances[$mnum], $db_maintenances[$maintenanceid]);
continue;
}
foreach ($maintenance['tags'] as $tag_num => $tag) {
$tag += [
'operator' => MAINTENANCE_TAG_OPERATOR_LIKE,
'value' => ''
];
foreach ($db_maintenances[$maintenanceid]['tags'] as $db_tag_num => $db_tag) {
if ($tag['tag'] === $db_tag['tag'] && $tag['operator'] == $db_tag['operator']
&& $tag['value'] === $db_tag['value']) {
unset($maintenances[$mnum]['tags'][$tag_num],
$db_maintenances[$maintenanceid]['tags'][$db_tag_num]
);
}
}
}
}
foreach ($maintenances as $maintenance) {
$maintenanceid = $maintenance['maintenanceid'];
foreach ($maintenance['tags'] as $tag) {
$ins_tags[] = ['maintenanceid' => $maintenanceid] + $tag;
}
foreach ($db_maintenances[$maintenanceid]['tags'] as $db_tag) {
$del_maintenancetagids[] = $db_tag['maintenancetagid'];
}
}
if ($del_maintenancetagids) {
DB::delete('maintenance_tag', ['maintenancetagid' => $del_maintenancetagids]);
}
if ($ins_tags) {
DB::insert('maintenance_tag', $ins_tags);
}
}
/**
* Delete Maintenances.
*
* @param array $maintenanceids
*
* @return array
*/
public function delete(array $maintenanceids) {
if (self::$userData['type'] == USER_TYPE_ZABBIX_USER) {
self::exception(ZBX_API_ERROR_PERMISSIONS, _('You do not have permission to perform this operation.'));
}
$maintenances = $this->get([
'output' => ['maintenanceid', 'name'],
'maintenanceids' => $maintenanceids,
'editable' => true,
'preservekeys' => true
]);
foreach ($maintenanceids as $maintenanceid) {
if (!array_key_exists($maintenanceid, $maintenances)) {
self::exception(ZBX_API_ERROR_PERMISSIONS, _('You do not have permission to perform this operation.'));
}
}
$timeperiodids = [];
$dbTimeperiods = DBselect(
'SELECT DISTINCT tp.timeperiodid'.
' FROM timeperiods tp,maintenances_windows mw'.
' WHERE '.dbConditionInt('mw.maintenanceid', $maintenanceids).
' AND tp.timeperiodid=mw.timeperiodid'
);
while ($timeperiod = DBfetch($dbTimeperiods)) {
$timeperiodids[] = $timeperiod['timeperiodid'];
}
$midCond = ['maintenanceid' => $maintenanceids];
// Lock maintenances table before maintenance delete to prevent server from adding host to maintenance.
DBselect(
'SELECT NULL'.
' FROM maintenances'.
' WHERE '.dbConditionId('maintenanceid', $maintenanceids).
' FOR UPDATE'
);
// Remove maintenanceid from hosts table.
DB::update('hosts', [
'values' => ['maintenanceid' => 0],
'where' => ['maintenanceid' => $maintenanceids]
]);
DB::delete('timeperiods', ['timeperiodid' => $timeperiodids]);
DB::delete('maintenances_windows', $midCond);
DB::delete('maintenances_hosts', $midCond);
DB::delete('maintenances_groups', $midCond);
DB::delete('maintenances', $midCond);
foreach ($maintenances as $maintenanceid => $maintenance) {
add_audit_details(AUDIT_ACTION_DELETE, AUDIT_RESOURCE_MAINTENANCE, $maintenanceid, $maintenance['name'],
null, self::$userData['userid']
);
}
return ['maintenanceids' => $maintenanceids];
}
/**
* Reset seconds to zero in maintenace time values.
*
* @param array $maintenances passed by reference
*/
protected function removeSecondsFromTimes(array &$maintenances) {
foreach ($maintenances as &$maintenance) {
if (isset($maintenance['active_since'])) {
$maintenance['active_since'] -= $maintenance['active_since'] % SEC_PER_MIN;
}
if (isset($maintenance['active_till'])) {
$maintenance['active_till'] -= $maintenance['active_till'] % SEC_PER_MIN;
}
if (isset($maintenance['timeperiods'])) {
foreach ($maintenance['timeperiods'] as &$timeperiod) {
if (isset($timeperiod['start_date'])) {
$timeperiod['start_date'] -= $timeperiod['start_date'] % SEC_PER_MIN;
}
}
unset($timeperiod);
}
}
unset($maintenance);
}
/**
* Updates maintenance time periods.
*
* @param array $maintenance
* @param array $oldMaintenance
*/
protected function replaceTimePeriods(array $oldMaintenance, array $maintenance) {
// replace time periods
$timePeriods = DB::replace('timeperiods', $oldMaintenance['timeperiods'], $maintenance['timeperiods']);
// link new time periods to maintenance
$oldTimePeriods = zbx_toHash($oldMaintenance['timeperiods'], 'timeperiodid');
$newMaintenanceWindows = [];
foreach ($timePeriods as $tp) {
if (!isset($oldTimePeriods[$tp['timeperiodid']])) {
$newMaintenanceWindows[] = [
'maintenanceid' => $maintenance['maintenanceid'],
'timeperiodid' => $tp['timeperiodid']
];
}
}
DB::insert('maintenances_windows', $newMaintenanceWindows);
}
protected function addRelatedObjects(array $options, array $result) {
$result = parent::addRelatedObjects($options, $result);
// selectGroups
if ($options['selectGroups'] !== null && $options['selectGroups'] != API_OUTPUT_COUNT) {
$relationMap = $this->createRelationMap($result, 'maintenanceid', 'groupid', 'maintenances_groups');
$groups = API::HostGroup()->get([
'output' => $options['selectGroups'],
'hostgroupids' => $relationMap->getRelatedIds(),
'preservekeys' => true
]);
$result = $relationMap->mapMany($result, $groups, 'groups');
}
// selectHosts
if ($options['selectHosts'] !== null && $options['selectHosts'] != API_OUTPUT_COUNT) {
$relationMap = $this->createRelationMap($result, 'maintenanceid', 'hostid', 'maintenances_hosts');
$groups = API::Host()->get([
'output' => $options['selectHosts'],
'hostids' => $relationMap->getRelatedIds(),
'preservekeys' => true
]);
$result = $relationMap->mapMany($result, $groups, 'hosts');
}
// Adding problem tags.
if ($options['selectTags'] !== null && $options['selectTags'] != API_OUTPUT_COUNT) {
$tags = API::getApiService()->select('maintenance_tag', [
'output' => $this->outputExtend($options['selectTags'], ['maintenanceid']),
'filter' => ['maintenanceids' => array_keys($result)],
'preservekeys' => true
]);
$relation_map = $this->createRelationMap($tags, 'maintenanceid', 'maintenancetagid');
$tags = $this->unsetExtraFields($tags, ['maintenancetagid', 'maintenanceid'], []);
$result = $relation_map->mapMany($result, $tags, 'tags');
}
// selectTimeperiods
if ($options['selectTimeperiods'] !== null && $options['selectTimeperiods'] != API_OUTPUT_COUNT) {
$relationMap = $this->createRelationMap($result, 'maintenanceid', 'timeperiodid', 'maintenances_windows');
$timeperiods = API::getApiService()->select('timeperiods', [
'output' => $options['selectTimeperiods'],
'filter' => ['timeperiodid' => $relationMap->getRelatedIds()],
'preservekeys' => true
]);
$result = $relationMap->mapMany($result, $timeperiods, 'timeperiods');
}
return $result;
}
}
|