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
|
<?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 screen items.
*/
class CScreenItem extends CApiService {
protected $tableName = 'screens_items';
protected $tableAlias = 'si';
/**
* Supported values for the resourcetype column.
*
* @var array
*/
protected static $resourceTypes = [
SCREEN_RESOURCE_GRAPH,
SCREEN_RESOURCE_SIMPLE_GRAPH,
SCREEN_RESOURCE_MAP,
SCREEN_RESOURCE_PLAIN_TEXT,
SCREEN_RESOURCE_HOST_INFO,
SCREEN_RESOURCE_TRIGGER_INFO,
SCREEN_RESOURCE_SERVER_INFO,
SCREEN_RESOURCE_CLOCK,
SCREEN_RESOURCE_SCREEN,
SCREEN_RESOURCE_TRIGGER_OVERVIEW,
SCREEN_RESOURCE_DATA_OVERVIEW,
SCREEN_RESOURCE_URL,
SCREEN_RESOURCE_ACTIONS,
SCREEN_RESOURCE_EVENTS,
SCREEN_RESOURCE_HOSTGROUP_TRIGGERS,
SCREEN_RESOURCE_SYSTEM_STATUS,
SCREEN_RESOURCE_HOST_TRIGGERS,
SCREEN_RESOURCE_LLD_GRAPH,
SCREEN_RESOURCE_LLD_SIMPLE_GRAPH
];
protected $sortColumns = [
'screenitemid',
'screenid'
];
public function __construct() {
parent::__construct();
$this->getOptions = zbx_array_merge($this->getOptions, [
'screenitemids' => null,
'screenids' => null,
'editable' => false,
'sortfield' => '',
'sortorder' => '',
'preservekeys' => false,
'countOutput' => false
]);
}
/**
* Get screem item data.
*
* @param array $options
* @param array $options['screenitemids'] Search by screen item IDs
* @param array $options['screenids'] Search by screen IDs
* @param array $options['filter'] Result filter
* @param array $options['limit'] The size of the result set
*
* @return array
*/
public function get(array $options = []) {
$options = zbx_array_merge($this->getOptions, $options);
// build and execute query
$sql = $this->createSelectQuery($this->tableName(), $options);
$res = DBselect($sql, $options['limit']);
// fetch results
$result = [];
while ($row = DBfetch($res)) {
// count query, return a single result
if ($options['countOutput']) {
$result = $row['rowscount'];
}
// normal select query
else {
if ($options['preservekeys']) {
$result[$row['screenitemid']] = $row;
}
else {
$result[] = $row;
}
}
}
return $result;
}
/**
* Create screen items.
*
* @param array $screenItems An array of screen items
*
* @return array
*/
public function create(array $screenItems) {
$screenItems = zbx_toArray($screenItems);
$this->validateCreate($screenItems);
$screenItemIds = DB::insert($this->tableName(), $screenItems);
return ['screenitemids' => $screenItemIds];
}
/**
* Validates the input parameters for the create() method.
*
* @throws APIException if the input is invalid
*
* @param array $screenItems
*/
protected function validateCreate(array $screenItems) {
$screenItemDBfields = [
'screenid' => null,
'resourcetype' => null
];
$defaults = [
'x' => 0,
'y' => 0,
'colspan' => 1,
'rowspan' => 1
];
foreach ($screenItems as &$screenItem) {
if (!check_db_fields($screenItemDBfields, $screenItem)) {
self::exception(ZBX_API_ERROR_PARAMETERS, _('Invalid method parameters.'));
}
unset($screenItem['screenitemid']);
$screenItem += $defaults;
}
unset($screenItem);
$this->validateItemsURL($screenItems);
$screenIds = array_keys(array_flip(zbx_objectValues($screenItems, 'screenid')));
$dbScreens = API::Screen()->get([
'output' => ['screenid', 'hsize', 'vsize', 'name'],
'screenids' => $screenIds,
'editable' => true,
'preservekeys' => true
]);
if (count($dbScreens) < count($screenIds)) {
$dbTemplateScreens = API::TemplateScreen()->get([
'output' => ['screenid', 'hsize', 'vsize', 'name'],
'screenids' => $screenIds,
'editable' => true,
'preservekeys' => true
]);
if ($dbTemplateScreens) {
$dbScreens = zbx_array_merge($dbScreens, $dbTemplateScreens);
}
}
$dbScreenItems = API::getApiService()->select($this->tableName(), [
'output' => ['screenitemid', 'screenid', 'x', 'y', 'rowspan', 'colspan'],
'filter' => ['screenid' => array_keys($dbScreens)],
'preservekeys' => true
]);
$this->checkInput($screenItems, $dbScreenItems);
$this->checkDuplicateResourceInCell(array_merge($screenItems, $dbScreenItems), $dbScreens);
foreach ($screenItems as $screenItem) {
$this->checkSpans($screenItem, $dbScreens[$screenItem['screenid']]);
$this->checkSpansInBounds($screenItem, $dbScreenItems, $dbScreens[$screenItem['screenid']]);
$this->checkGridCoordinates($screenItem, $dbScreens[$screenItem['screenid']]);
}
}
/**
* Updates screen items.
*
* @param array $screenItems An array of screen items
*
* @return array
*/
public function update(array $screenItems) {
$screenItems = zbx_toArray($screenItems);
$this->validateUpdate($screenItems);
$screenItems = zbx_toHash($screenItems, 'screenitemid');
$update = [];
$screenItemIds = [];
foreach ($screenItems as $screenItem) {
$screenItemId = $screenItem['screenitemid'];
unset($screenItem['screenitemid']);
// If screen item type (field "resourcetype") is set to one that does not use "resourceid" field,
// value of field "resourceid" is set to 0 for those resource types. Clock screen item type has
// more refined check.
if (isset($screenItem['resourcetype'])) {
switch ($screenItem['resourcetype']) {
case SCREEN_RESOURCE_CLOCK:
if (isset($screenItem['style']) && $screenItem['style'] != TIME_TYPE_HOST) {
$screenItem['resourceid'] = 0;
}
break;
case SCREEN_RESOURCE_ACTIONS:
case SCREEN_RESOURCE_HISTORY:
case SCREEN_RESOURCE_SERVER_INFO:
case SCREEN_RESOURCE_SYSTEM_STATUS:
case SCREEN_RESOURCE_URL:
$screenItem['resourceid'] = 0;
break;
}
}
$update[] = [
'values' => $screenItem,
'where' => ['screenitemid' => $screenItemId]
];
$screenItemIds[] = $screenItemId;
}
DB::update($this->tableName(), $update);
return ['screenitemids' => $screenItemIds];
}
/**
* Validates the input parameters for the update() method.
*
* @throws APIException
*
* @param array $screenItems
*/
protected function validateUpdate(array $screenItems) {
$screenItemDBfields = [
'screenitemid' => null
];
foreach ($screenItems as $screenItem) {
if (!check_db_fields($screenItemDBfields, $screenItem)) {
self::exception(ZBX_API_ERROR_PARAMETERS, _('Invalid method parameters.'));
}
}
$this->validateItemsURL($screenItems);
$screenItems = zbx_toHash($screenItems, 'screenitemid');
$screenItemIds = array_keys($screenItems);
$dbScreens = API::Screen()->get([
'output' => ['screenid', 'hsize', 'vsize', 'name'],
'screenitemids' => $screenItemIds,
'editable' => true,
'preservekeys' => true
]);
$dbTemplateScreens = API::TemplateScreen()->get([
'output' => ['screenid', 'hsize', 'vsize', 'name'],
'screenitemids' => $screenItemIds,
'editable' => true,
'preservekeys' => true
]);
if ($dbTemplateScreens) {
$dbScreens = zbx_array_merge($dbScreens, $dbTemplateScreens);
}
$dbScreenItems = API::getApiService()->select($this->tableName(), [
'output' => ['screenitemid', 'screenid', 'x', 'y', 'rowspan', 'colspan', 'resourcetype', 'resourceid',
'style'
],
'filter' => ['screenid' => array_keys($dbScreens)],
'preservekeys' => true
]);
$screenItems = $this->extendObjects($this->tableName(), $screenItems,
['screenid', 'x', 'y', 'rowspan', 'colspan', 'style']
);
$this->checkInput($screenItems, $dbScreenItems);
$this->checkDuplicateResourceInCell($screenItems + $dbScreenItems, $dbScreens);
foreach ($screenItems as $screenItem) {
$this->checkSpans($screenItem, $dbScreens[$screenItem['screenid']]);
$this->checkSpansInBounds($screenItem, $dbScreenItems, $dbScreens[$screenItem['screenid']]);
$this->checkGridCoordinates($screenItem, $dbScreens[$screenItem['screenid']]);
}
}
/**
* Update screen items using the given 'x' and 'y' parameters.
* If the given cell is free, a new screen item will be created.
*
* @param array $screenItems An array of screen items with the given X and Y coordinates
*
* @return array
*/
public function updateByPosition(array $screenItems) {
$screenItemDBfields = [
'screenid' => null,
'x' => null,
'y' => null
];
foreach ($screenItems as $screenItem) {
if (!check_db_fields($screenItemDBfields, $screenItem)) {
self::exception(ZBX_API_ERROR_PARAMETERS, _('Invalid method parameters.'));
}
}
$dbScreenItems = $this->get([
'output' => ['screenitemid', 'screenid', 'x', 'y'],
'screenids' => zbx_objectValues($screenItems, 'screenid'),
'editable' => true,
'preservekeys' => true
]);
$create = $update = $affectedIds = [];
foreach ($screenItems as $screenItem) {
foreach ($dbScreenItems as $dbScreenItem) {
if ($screenItem['screenid'] == $dbScreenItem['screenid']
&& $screenItem['x'] == $dbScreenItem['x'] && $screenItem['y'] == $dbScreenItem['y']) {
$screenItem['screenitemid'] = $dbScreenItem['screenitemid'];
$update[$dbScreenItem['screenitemid']] = $screenItem;
continue 2;
}
}
$create[] = $screenItem;
}
if ($update) {
$screenItems = API::ScreenItem()->update($update);
$affectedIds = $screenItems['screenitemids'];
}
if ($create) {
$screenItems = API::ScreenItem()->create($create);
$affectedIds = array_merge($affectedIds, $screenItems['screenitemids']);
}
return ['screenitemids' => $affectedIds];
}
/**
* Deletes screen items.
*
* @param array $screenItemIds
*
* @return array
*/
public function delete(array $screenItemIds) {
// check permissions
$dbScreenItems = $this->get([
'output' => ['screenitemid'],
'screenitemids' => $screenItemIds,
'preservekeys' => true
]);
foreach ($screenItemIds as $screenItemId) {
if (!isset($dbScreenItems[$screenItemId])) {
self::exception(ZBX_API_ERROR_PERMISSIONS, _('No permissions to referred object or it does not exist!'));
}
}
// delete screen items
DB::delete($this->tableName(), [
'screenitemid' => $screenItemIds
]);
return ['screenitemids' => $screenItemIds];
}
/**
* Validates screen items.
*
* If the $dbScreenItems parameter is given, the screen items will be matched
* against the ones given in $dbScreenItems. If a screen item is not present in
* $dbScreenItems, a ZBX_API_ERROR_PERMISSIONS exception will be thrown.
*
* @throws APIException if a validation error occurred.
*
* @param array $screenItems
* @param array $dbScreenItems
*/
protected function checkInput(array $screenItems, array $dbScreenItems = []) {
$hostGroupsIds = [];
$hostIds = [];
$graphIds = [];
$itemIds = [];
$mapIds = [];
$screenIds = [];
$itemPrototypeIds = [];
$graphPrototypeIds = [];
$screenItems = $this->extendFromObjects($screenItems, $dbScreenItems, ['resourcetype']);
$validStyles = [
SCREEN_RESOURCE_CLOCK => [TIME_TYPE_LOCAL, TIME_TYPE_SERVER, TIME_TYPE_HOST],
SCREEN_RESOURCE_DATA_OVERVIEW => [STYLE_TOP, STYLE_LEFT],
SCREEN_RESOURCE_TRIGGER_OVERVIEW => [STYLE_TOP, STYLE_LEFT],
SCREEN_RESOURCE_HOST_INFO => [STYLE_VERTICAL, STYLE_HORIZONTAL],
SCREEN_RESOURCE_TRIGGER_INFO => [STYLE_VERTICAL, STYLE_HORIZONTAL]
];
foreach ($screenItems as $screenItem) {
// check permissions
if (isset($screenItem['screenitemid']) && !isset($dbScreenItems[$screenItem['screenitemid']])) {
self::exception(ZBX_API_ERROR_PERMISSIONS, _('No permissions to referred object or it does not exist!'));
}
if (!$this->isValidResourceType($screenItem['resourcetype'])) {
self::exception(ZBX_API_ERROR_PARAMETERS, _('Incorrect resource type provided for screen item.'));
}
if (!isset($screenItem['resourceid'])) {
$screenItem['resourceid'] = null;
}
// check resource id
switch ($screenItem['resourcetype']) {
case SCREEN_RESOURCE_HOST_INFO:
case SCREEN_RESOURCE_TRIGGER_INFO:
case SCREEN_RESOURCE_TRIGGER_OVERVIEW:
case SCREEN_RESOURCE_HOSTGROUP_TRIGGERS:
case SCREEN_RESOURCE_DATA_OVERVIEW:
$overviewResources = [SCREEN_RESOURCE_TRIGGER_OVERVIEW, SCREEN_RESOURCE_DATA_OVERVIEW];
if (in_array($screenItem['resourcetype'], $overviewResources)) {
if (!$screenItem['resourceid']) {
self::exception(ZBX_API_ERROR_PARAMETERS, _(
'No host group ID provided for screen element.'
));
}
}
if ($screenItem['resourceid']) {
$hostGroupsIds[$screenItem['resourceid']] = $screenItem['resourceid'];
}
break;
case SCREEN_RESOURCE_HOST_TRIGGERS:
if ($screenItem['resourceid']) {
$hostIds[$screenItem['resourceid']] = $screenItem['resourceid'];
}
break;
case SCREEN_RESOURCE_GRAPH:
if (!$screenItem['resourceid']) {
self::exception(ZBX_API_ERROR_PARAMETERS, _('No graph ID provided for screen element.'));
}
$graphIds[$screenItem['resourceid']] = $screenItem['resourceid'];
break;
case SCREEN_RESOURCE_LLD_GRAPH:
if (!$screenItem['resourceid']) {
self::exception(ZBX_API_ERROR_PARAMETERS, _(
'No graph prototype ID provided for screen element.'
));
}
$graphPrototypeIds[$screenItem['resourceid']] = $screenItem['resourceid'];
break;
case SCREEN_RESOURCE_LLD_SIMPLE_GRAPH:
if (!$screenItem['resourceid']) {
self::exception(ZBX_API_ERROR_PARAMETERS, _(
'No item prototype ID provided for screen element.'
));
}
$itemPrototypeIds[$screenItem['resourceid']] = $screenItem['resourceid'];
break;
case SCREEN_RESOURCE_SIMPLE_GRAPH:
case SCREEN_RESOURCE_PLAIN_TEXT:
if (!$screenItem['resourceid']) {
self::exception(ZBX_API_ERROR_PARAMETERS, _('No item ID provided for screen element.'));
}
$itemIds[$screenItem['resourceid']] = $screenItem['resourceid'];
break;
case SCREEN_RESOURCE_CLOCK:
if (isset($screenItem['style'])) {
if ($screenItem['style'] == TIME_TYPE_HOST) {
if (!$screenItem['resourceid']) {
self::exception(ZBX_API_ERROR_PARAMETERS, _('No item ID provided for screen element.'));
}
$itemIds[$screenItem['resourceid']] = $screenItem['resourceid'];
}
elseif ($screenItem['resourceid']) {
self::exception(ZBX_API_ERROR_PARAMETERS, _('Cannot set resource ID for screen element.'));
}
}
break;
case SCREEN_RESOURCE_MAP:
if (!$screenItem['resourceid']) {
self::exception(ZBX_API_ERROR_PARAMETERS, _('No map ID provided for screen element.'));
}
$mapIds[$screenItem['resourceid']] = $screenItem['resourceid'];
break;
case SCREEN_RESOURCE_SCREEN:
if (!$screenItem['resourceid']) {
self::exception(ZBX_API_ERROR_PARAMETERS, _('No screen ID provided for screen element.'));
}
$screenIds[$screenItem['resourceid']] = $screenItem['resourceid'];
break;
case SCREEN_RESOURCE_ACTIONS:
case SCREEN_RESOURCE_SERVER_INFO:
case SCREEN_RESOURCE_SYSTEM_STATUS:
case SCREEN_RESOURCE_URL:
if ($screenItem['resourceid']) {
self::exception(ZBX_API_ERROR_PARAMETERS, _('Cannot set resource ID for screen element.'));
}
break;
}
// check url
if ($screenItem['resourcetype'] == SCREEN_RESOURCE_URL) {
if (!isset($screenItem['url']) || zbx_empty($screenItem['url'])) {
self::exception(ZBX_API_ERROR_PARAMETERS, _('No URL provided for screen element.'));
}
}
// check "Show lines"
if (isset($screenItem['elements'])) {
switch ($screenItem['resourcetype']) {
case SCREEN_RESOURCE_ACTIONS:
case SCREEN_RESOURCE_EVENTS:
case SCREEN_RESOURCE_HOSTGROUP_TRIGGERS:
case SCREEN_RESOURCE_HOST_TRIGGERS:
case SCREEN_RESOURCE_PLAIN_TEXT:
if ($screenItem['elements'] < 1 || $screenItem['elements'] > 100) {
self::exception(ZBX_API_ERROR_PARAMETERS, _s(
'Incorrect value "%1$s" for "%2$s" field: must be between %3$s and %4$s.',
$screenItem['elements'], 'elements', 1, 100
));
}
break;
}
}
// check 'max_columns' parameter for LLD screen resources:
// is set and valid for create method, and is valid for update method, if set
$dbScreenItem = isset($screenItem['screenitemid']) ? $dbScreenItems[$screenItem['screenitemid']] : null;
$lldResources = [SCREEN_RESOURCE_LLD_GRAPH, SCREEN_RESOURCE_LLD_SIMPLE_GRAPH];
if (in_array($screenItem['resourcetype'], $lldResources)) {
$set = isset($screenItem['max_columns']);
$valid = ($set && $this->isValidMaxColumns($screenItem['max_columns']));
$error = ($dbScreenItem ? ($set && !$valid) : (!$set || !$valid));
if ($error) {
self::exception(ZBX_API_ERROR_PARAMETERS, _('Incorrect max columns provided for screen element.'));
}
}
if (isset($validStyles[$screenItem['resourcetype']])
&& !in_array($screenItem['style'], $validStyles[$screenItem['resourcetype']])) {
self::exception(ZBX_API_ERROR_PARAMETERS, _('Incorrect style provided for screen element.'));
}
}
// check host groups
if ($hostGroupsIds) {
$dbHostGroups = API::HostGroup()->get([
'output' => ['groupid'],
'groupids' => $hostGroupsIds,
'preservekeys' => true
]);
foreach ($hostGroupsIds as $hostGroupsId) {
if (!isset($dbHostGroups[$hostGroupsId])) {
self::exception(ZBX_API_ERROR_PERMISSIONS, _s(
'Incorrect host group ID "%1$s" provided for screen element.', $hostGroupsId
));
}
}
}
// check hosts
if ($hostIds) {
$dbHosts = API::Host()->get([
'output' => ['hostid'],
'hostids' => $hostIds,
'preservekeys' => true
]);
foreach ($hostIds as $hostId) {
if (!isset($dbHosts[$hostId])) {
self::exception(ZBX_API_ERROR_PERMISSIONS, _s(
'Incorrect host ID "%1$s" provided for screen element.', $hostId
));
}
}
}
// check graphs
if ($graphIds) {
$dbGraphs = API::Graph()->get([
'output' => ['graphid'],
'graphids' => $graphIds,
'preservekeys' => true
]);
foreach ($graphIds as $graphId) {
if (!isset($dbGraphs[$graphId])) {
self::exception(ZBX_API_ERROR_PERMISSIONS, _s(
'Incorrect graph ID "%1$s" provided for screen element.', $graphId
));
}
}
}
// check graph prototypes
if ($graphPrototypeIds) {
$dbGraphPrototypes = API::GraphPrototype()->get([
'output' => ['graphid'],
'graphids' => $graphPrototypeIds,
'preservekeys' => true
]);
foreach ($graphPrototypeIds as $graphPrototypeId) {
if (!isset($dbGraphPrototypes[$graphPrototypeId])) {
self::exception(ZBX_API_ERROR_PERMISSIONS, _s(
'Incorrect graph prototype ID "%1$s" provided for screen element.', $graphPrototypeId
));
}
}
}
// check items
if ($itemIds) {
$dbItems = API::Item()->get([
'output' => ['itemid'],
'itemids' => $itemIds,
'preservekeys' => true,
'webitems' => true
]);
foreach ($itemIds as $itemId) {
if (!isset($dbItems[$itemId])) {
self::exception(ZBX_API_ERROR_PERMISSIONS, _s(
'Incorrect item ID "%1$s" provided for screen element.', $itemId
));
}
}
}
// check item prototypes
if ($itemPrototypeIds) {
$dbItemPrototypes = API::ItemPrototype()->get([
'output' => ['itemid'],
'itemids' => $itemPrototypeIds,
'preservekeys' => true
]);
foreach ($itemPrototypeIds as $itemPrototypeId) {
if (!isset($dbItemPrototypes[$itemPrototypeId])) {
self::exception(ZBX_API_ERROR_PERMISSIONS, _s(
'Incorrect item prototype ID "%1$s" provided for screen element.', $itemPrototypeId
));
}
}
}
// check maps
if ($mapIds) {
$dbMaps = API::Map()->get([
'output' => ['sysmapid'],
'sysmapids' => $mapIds,
'preservekeys' => true
]);
foreach ($mapIds as $mapId) {
if (!isset($dbMaps[$mapId])) {
self::exception(ZBX_API_ERROR_PERMISSIONS, _s(
'Incorrect map ID "%1$s" provided for screen element.', $mapId
));
}
}
}
// check screens
if ($screenIds) {
$dbScreens = API::Screen()->get([
'output' => ['screenid'],
'screenids' => $screenIds,
'preservekeys' => true
]);
if (count($dbScreens) < count($screenIds)) {
$dbTemplateScreens = API::TemplateScreen()->get([
'output' => ['screenid'],
'screenids' => $screenIds,
'preservekeys' => true
]);
if ($dbTemplateScreens) {
$dbScreens = zbx_array_merge($dbScreens, $dbTemplateScreens);
}
}
foreach ($screenIds as $screenId) {
if (!isset($dbScreens[$screenId])) {
self::exception(ZBX_API_ERROR_PERMISSIONS, _s(
'Incorrect screen ID "%1$s" provided for screen element.', $screenId
));
}
}
}
}
/**
* Returns true if the given resource type is supported.
*
* @param int $resourceType
*
* @return bool
*/
protected function isValidResourceType($resourceType) {
return in_array($resourceType, self::$resourceTypes);
}
/**
* Checks that the row and column spans are valid.
*
* @throws APIException if the any of the spans is not an integer or missing
*
* @param array $screenItem
* @param array $screen
*/
protected function checkSpans(array $screenItem, array $screen) {
if (isset($screenItem['rowspan'])) {
if (!zbx_is_int($screenItem['rowspan']) || $screenItem['rowspan'] < 1) {
self::exception(
ZBX_API_ERROR_PARAMETERS,
_s(
'Screen "%1$s" row span in cell X - %2$s Y - %3$s is incorrect.',
$screen['name'],
$screenItem['x'],
$screenItem['y']
)
);
}
}
if (isset($screenItem['colspan'])) {
if (!zbx_is_int($screenItem['colspan']) || $screenItem['colspan'] < 1) {
self::exception(
ZBX_API_ERROR_PARAMETERS,
_s(
'Screen "%1$s" column span in cell X - %2$s Y - %3$s is incorrect.',
$screen['name'],
$screenItem['x'],
$screenItem['y']
)
);
}
}
}
/**
* Checks that the row and column spans fit into the size of the screen.
*
* @throws APIException if the any of the spans is bigger then the free space on the screen
*
* @param array $screenItem
* @param array $dbScreenItems
* @param array $screen
*/
protected function checkSpansInBounds(array $screenItem, array $dbScreenItems, array $screen) {
if (!isset($screenItem['x'])) {
$screenItem['x'] = isset($screenItem['screenitemid'])
? $dbScreenItems[$screenItem['screenitemid']]['x']
: 0;
}
if (!isset($screenItem['y'])) {
$screenItem['y'] = isset($screenItem['screenitemid'])
? $dbScreenItems[$screenItem['screenitemid']]['y']
: 0;
}
if (isset($screenItem['rowspan']) && isset($screen['vsize'])
&& $screenItem['rowspan'] > $screen['vsize'] - $screenItem['y']) {
self::exception(
ZBX_API_ERROR_PARAMETERS,
_s(
'Screen "%1$s" row span in cell X - %2$s Y - %3$s is too big.',
$screen['name'],
$screenItem['x'],
$screenItem['y']
)
);
}
if (isset($screenItem['colspan']) && isset($screen['hsize'])
&& $screenItem['colspan'] > $screen['hsize'] - $screenItem['x']) {
self::exception(
ZBX_API_ERROR_PARAMETERS,
_s(
'Screen "%1$s" column span in cell X - %2$s Y - %3$s is too big.',
$screen['name'],
$screenItem['x'],
$screenItem['y']
)
);
}
}
/**
* Check duplicates screen items in one cell.
*
* @param array $screen_items
* @param string $screen_items['screenid']
* @param int $screen_items['x']
* @param int $screen_items['y']
* @param int $screen_items['colspan']
* @param int $screen_items['rowspan']
* @param array $screens
* @param string $screens['screenid']
* @param string $screens['name']
*
* @throws APIException if input is invalid.
*/
protected function checkDuplicateResourceInCell(array $screen_items, array $screens) {
$calculated = [];
foreach ($screen_items as $screen_item) {
$screenid = $screen_item['screenid'];
$checked = [
'left' => $screen_item['x'],
'top' => $screen_item['y'],
'right' => $screen_item['x'] + $screen_item['colspan'] - 1,
'bottom' => $screen_item['y'] + $screen_item['rowspan'] - 1
];
if (!array_key_exists($screenid, $calculated)) {
$calculated[$screenid] = [];
}
foreach ($calculated[$screenid] as $entry) {
$overlaps_x = ($checked['left'] <= $entry['right'] && $checked['right'] >= $entry['left']);
$overlaps_y = ($checked['top'] <= $entry['bottom'] && $checked['bottom'] >= $entry['top']);
if ($overlaps_x && $overlaps_y) {
self::exception(ZBX_API_ERROR_PARAMETERS,
_s('Screen "%1$s" cell X - %2$s Y - %3$s is already taken.', $screens[$screenid]['name'],
$checked['left'], $checked['top']
)
);
}
}
$calculated[$screenid][] = $checked;
}
}
/**
* Checks that the row and column fit into the size of the screen.
*
* @throws APIException if the any of the coordinates is bigger then the free space on the screen
*
* @param array $screenItem
* @param array $screen
*/
protected function checkGridCoordinates(array $screenItem, array $screen) {
if (isset($screenItem['x']) && $screenItem['x'] > $screen['hsize'] - 1) {
self::exception(
ZBX_API_ERROR_PARAMETERS,
_s(
'The X coordinate of screen element located at X - %1$s and Y - %2$s of screen "%3$s" is too big.',
$screenItem['x'],
$screenItem['y'],
$screen['name']
)
);
}
if (isset($screenItem['y']) && $screenItem['y'] > $screen['vsize'] - 1) {
self::exception(
ZBX_API_ERROR_PARAMETERS,
_s(
'The Y coordinate of screen element located at X - %1$s and Y - %2$s of screen "%3$s" is too big.',
$screenItem['x'],
$screenItem['y'],
$screen['name']
)
);
}
}
protected function applyQueryFilterOptions($tableName, $tableAlias, array $options, array $sqlParts) {
$sqlParts = parent::applyQueryFilterOptions($tableName, $tableAlias, $options, $sqlParts);
// screens
if ($options['screenids'] !== null) {
zbx_value2array($options['screenids']);
$sqlParts['where'][] = dbConditionInt($this->fieldId('screenid'), $options['screenids']);
}
return $sqlParts;
}
/**
* Checks if value of $maxColumns valid in respect to SCREEN_SURROGATE_MAX_COLUMNS_MIN and
* SCREEN_SURROGATE_MAX_COLUMNS_MIN constants. Returns true if valid, false otherwise.
*
* @param integer $maxColumns
*
* @return bool
*/
protected function isValidMaxColumns($maxColumns) {
return ($maxColumns >= SCREEN_SURROGATE_MAX_COLUMNS_MIN && $maxColumns <= SCREEN_SURROGATE_MAX_COLUMNS_MAX);
}
/**
* Validates URL fields for submitted screen items.
*
* @throws APIException for invalid URL
*
* @param array $screen_items Array of screen items.
*/
protected function validateItemsURL($screen_items) {
foreach ($screen_items as $screen_item) {
if ($screen_item['resourcetype'] == SCREEN_RESOURCE_URL && array_key_exists('url', $screen_item)
&& !CHtmlUrlValidator::validate($screen_item['url'])) {
self::exception(ZBX_API_ERROR_PARAMETERS, _('Wrong value for url field.'));
}
}
}
}
|