/**
* Update maintenances.
*
* @param array $maintenances
*
* @return boolean
*/
public function update(array $maintenances)
{
$maintenances = zbx_toArray($maintenances);
$maintenanceids = zbx_objectValues($maintenances, 'maintenanceid');
// validate maintenance permissions
if (self::$userData['type'] == USER_TYPE_ZABBIX_USER) {
self::exception(ZBX_API_ERROR_PERMISSIONS, _('No permissions to referred object or it does not exist!'));
}
$updMaintenances = $this->get(['maintenanceids' => zbx_objectValues($maintenances, 'maintenanceid'), 'editable' => true, 'output' => API_OUTPUT_EXTEND, 'selectGroups' => ['groupid'], 'selectHosts' => ['hostid'], 'selectTimeperiods' => API_OUTPUT_EXTEND, 'preservekeys' => true]);
$maintenanceNamesChanged = [];
foreach ($maintenances as $maintenance) {
if (!isset($updMaintenances[$maintenance['maintenanceid']])) {
self::exception(ZBX_API_ERROR_PERMISSIONS, _('No permissions to referred object or it does not exist!'));
}
if (isset($maintenance['name']) && !zbx_empty($maintenance['name']) && $updMaintenances[$maintenance['maintenanceid']]['name'] !== $maintenance['name']) {
if (isset($maintenanceNamesChanged[$maintenance['name']])) {
self::exception(ZBX_API_ERROR_PARAMETERS, _s('Maintenance "%1$s" already exists.', $maintenance['name']));
} else {
$maintenanceNamesChanged[$maintenance['name']] = $maintenance['name'];
}
}
}
// check if maintenance already exists
if ($maintenanceNamesChanged) {
$dbMaintenances = $this->get(['output' => ['name'], 'filter' => ['name' => $maintenanceNamesChanged], 'nopermissions' => true, 'limit' => 1]);
if ($dbMaintenances) {
$dbMaintenance = reset($dbMaintenances);
self::exception(ZBX_API_ERROR_PARAMETERS, _s('Maintenance "%1$s" already exists.', $dbMaintenance['name']));
}
}
$hostids = [];
$groupids = [];
foreach ($maintenances as $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.'));
}
}
$hostids = array_merge($hostids, $maintenance['hostids']);
$groupids = array_merge($groupids, $maintenance['groupids']);
}
// validate hosts & groups
if (empty($hostids) && empty($groupids)) {
self::exception(ZBX_API_ERROR_PARAMETERS, _('At least one host or group should be selected.'));
}
// validate 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, _('You do not have permission to perform this operation.'));
}
}
// validate 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);
$update = [];
foreach ($maintenances as $mnum => $maintenance) {
$dbFields = ['maintenanceid' => null];
// validate fields
if (!check_db_fields($dbFields, $maintenance)) {
self::exception(ZBX_API_ERROR_PARAMETERS, _('Incorrect parameters for maintenance.'));
}
$update[$mnum] = ['values' => $maintenance, 'where' => ['maintenanceid' => $maintenance['maintenanceid']]];
// update time periods
$this->replaceTimePeriods($updMaintenances[$maintenance['maintenanceid']], $maintenance);
}
DB::update('maintenances', $update);
// some of the hosts and groups bound to maintenance must be deleted, other inserted and others left alone
$insertHosts = [];
$insertGroups = [];
foreach ($maintenances as $maintenance) {
// putting apart those host<->maintenance connections that should be inserted, deleted and not changed
// $hostDiff['first'] - new hosts, that should be inserted
// $hostDiff['second'] - hosts, that should be deleted
// $hostDiff['both'] - hosts, that should not be touched
$hostDiff = zbx_array_diff(zbx_toObject($maintenance['hostids'], 'hostid'), $updMaintenances[$maintenance['maintenanceid']]['hosts'], 'hostid');
foreach ($hostDiff['first'] as $host) {
$insertHosts[] = ['hostid' => $host['hostid'], 'maintenanceid' => $maintenance['maintenanceid']];
}
foreach ($hostDiff['second'] as $host) {
$deleteHosts = ['hostid' => $host['hostid'], 'maintenanceid' => $maintenance['maintenanceid']];
DB::delete('maintenances_hosts', $deleteHosts);
}
// now the same with the groups
$groupDiff = zbx_array_diff(zbx_toObject($maintenance['groupids'], 'groupid'), $updMaintenances[$maintenance['maintenanceid']]['groups'], 'groupid');
foreach ($groupDiff['first'] as $group) {
$insertGroups[] = ['groupid' => $group['groupid'], 'maintenanceid' => $maintenance['maintenanceid']];
}
foreach ($groupDiff['second'] as $group) {
$deleteGroups = ['groupid' => $group['groupid'], 'maintenanceid' => $maintenance['maintenanceid']];
DB::delete('maintenances_groups', $deleteGroups);
}
add_audit_ext(AUDIT_ACTION_UPDATE, AUDIT_RESOURCE_MAINTENANCE, $maintenance['maintenanceid'], array_key_exists('name', $maintenance) ? $maintenance['name'] : $updMaintenances[$maintenance['maintenanceid']]['name'], 'maintenances', $updMaintenances[$maintenance['maintenanceid']], $maintenance);
}
DB::insert('maintenances_hosts', $insertHosts);
DB::insert('maintenances_groups', $insertGroups);
return ['maintenanceids' => $maintenanceids];
}
/**
* Validate the new service time. Validation is implemented as a separate function to be available directly from the
* frontend.
*
* @throws APIException if the given service time is invalid
*
* @param array $serviceTime
*
* @return void
*/
function checkServiceTime(array $serviceTime)
{
// type validation
$serviceTypes = array(SERVICE_TIME_TYPE_DOWNTIME, SERVICE_TIME_TYPE_ONETIME_DOWNTIME, SERVICE_TIME_TYPE_UPTIME);
if (!isset($serviceTime['type']) || !in_array($serviceTime['type'], $serviceTypes)) {
throw new APIException(ZBX_API_ERROR_PARAMETERS, _('Incorrect service time type.'));
}
// one-time downtime validation
if ($serviceTime['type'] == SERVICE_TIME_TYPE_ONETIME_DOWNTIME) {
if (!isset($serviceTime['ts_from']) || !validateUnixTime($serviceTime['ts_from'])) {
throw new APIException(ZBX_API_ERROR_PARAMETERS, _('Incorrect service start time.'));
}
if (!isset($serviceTime['ts_to']) || !validateUnixTime($serviceTime['ts_to'])) {
throw new APIException(ZBX_API_ERROR_PARAMETERS, _('Incorrect service end time.'));
}
} else {
if (!isset($serviceTime['ts_from']) || !zbx_is_int($serviceTime['ts_from']) || $serviceTime['ts_from'] < 0 || $serviceTime['ts_from'] > SEC_PER_WEEK) {
throw new APIException(ZBX_API_ERROR_PARAMETERS, _('Incorrect service start time.'));
}
if (!isset($serviceTime['ts_to']) || !zbx_is_int($serviceTime['ts_to']) || $serviceTime['ts_to'] < 0 || $serviceTime['ts_to'] > SEC_PER_WEEK) {
throw new APIException(ZBX_API_ERROR_PARAMETERS, _('Incorrect service end time.'));
}
}
if ($serviceTime['ts_from'] >= $serviceTime['ts_to']) {
throw new APIException(ZBX_API_ERROR_PARAMETERS, _('Service start time must be less than end time.'));
}
}
/**
* Update maintenances
*
* @param array $maintenances
* @return boolean
*/
public function update(array $maintenances)
{
$maintenances = zbx_toArray($maintenances);
$maintenanceids = zbx_objectValues($maintenances, 'maintenanceid');
// validate maintenance permissions
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 = array();
$groupids = array();
$updMaintenances = $this->get(array('maintenanceids' => zbx_objectValues($maintenances, 'maintenanceid'), 'editable' => true, 'output' => API_OUTPUT_EXTEND, 'selectGroups' => API_OUTPUT_REFER, 'selectHosts' => API_OUTPUT_REFER, 'selectTimeperiods' => API_OUTPUT_EXTEND, 'preservekeys' => true));
foreach ($maintenances as $maintenance) {
if (!isset($updMaintenances[$maintenance['maintenanceid']])) {
self::exception(ZBX_API_ERROR_PERMISSIONS, _('No permissions to referred object or it does not exist!'));
}
// Checking whether a maintenance with this name already exists. First, getting all maintenances with the same name as this
$receivedMaintenances = API::Maintenance()->get(array('filter' => array('name' => $maintenance['name'])));
// validate if maintenance name already exists
foreach ($receivedMaintenances as $rMaintenance) {
if (bccomp($rMaintenance['maintenanceid'], $maintenance['maintenanceid']) != 0) {
self::exception(ZBX_API_ERROR_PARAMETERS, _s('Maintenance "%s" already exists.', $maintenance['name']));
}
}
// 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 (empty($maintenance['timeperiods'])) {
self::exception(ZBX_API_ERROR_PARAMETERS, _('At least one maintenance period must be created.'));
}
$hostids = array_merge($hostids, $maintenance['hostids']);
$groupids = array_merge($groupids, $maintenance['groupids']);
}
// validate hosts & groups
if (empty($hostids) && empty($groupids)) {
self::exception(ZBX_API_ERROR_PARAMETERS, _('At least one host or group should be selected.'));
}
// validate hosts permissions
$options = array('hostids' => $hostids, 'editable' => true, 'output' => array('hostid'), 'preservekeys' => true);
$updHosts = API::Host()->get($options);
foreach ($hostids as $hostid) {
if (!isset($updHosts[$hostid])) {
self::exception(ZBX_API_ERROR_PERMISSIONS, _('You do not have permission to perform this operation.'));
}
}
// validate groups permissions
$options = array('groupids' => $groupids, 'editable' => true, 'output' => array('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);
$update = array();
foreach ($maintenances as $mnum => $maintenance) {
$dbFields = array('maintenanceid' => null);
// validate fields
if (!check_db_fields($dbFields, $maintenance)) {
self::exception(ZBX_API_ERROR_PARAMETERS, _('Incorrect parameters for maintenance.'));
}
$update[$mnum] = array('values' => $maintenance, 'where' => array('maintenanceid' => $maintenance['maintenanceid']));
// update time periods
$this->replaceTimePeriods($updMaintenances[$maintenance['maintenanceid']], $maintenance);
}
DB::update('maintenances', $update);
// some of the hosts and groups bound to maintenance must be deleted, other inserted and others left alone
$insertHosts = array();
$insertGroups = array();
foreach ($maintenances as $maintenance) {
// putting apart those host<->maintenance connections that should be inserted, deleted and not changed
// $hostDiff['first'] - new hosts, that should be inserted
// $hostDiff['second'] - hosts, that should be deleted
// $hostDiff['both'] - hosts, that should not be touched
$hostDiff = zbx_array_diff(zbx_toObject($maintenance['hostids'], 'hostid'), $updMaintenances[$maintenance['maintenanceid']]['hosts'], 'hostid');
foreach ($hostDiff['first'] as $host) {
$insertHosts[] = array('hostid' => $host['hostid'], 'maintenanceid' => $maintenance['maintenanceid']);
}
foreach ($hostDiff['second'] as $host) {
$deleteHosts = array('hostid' => $host['hostid'], 'maintenanceid' => $maintenance['maintenanceid']);
DB::delete('maintenances_hosts', $deleteHosts);
}
// now the same with the groups
$groupDiff = zbx_array_diff(zbx_toObject($maintenance['groupids'], 'groupid'), $updMaintenances[$maintenance['maintenanceid']]['groups'], 'groupid');
foreach ($groupDiff['first'] as $group) {
$insertGroups[] = array('groupid' => $group['groupid'], 'maintenanceid' => $maintenance['maintenanceid']);
}
foreach ($groupDiff['second'] as $group) {
$deleteGroups = array('groupid' => $group['groupid'], 'maintenanceid' => $maintenance['maintenanceid']);
DB::delete('maintenances_groups', $deleteGroups);
}
}
DB::insert('maintenances_hosts', $insertHosts);
DB::insert('maintenances_groups', $insertGroups);
return array('maintenanceids' => $maintenanceids);
}
/**
* Validate periods array for bar reports - time since, time till and color.
* Automatically set caption if none is set.
*
* @param array $periods
*
* @return mixed valid periods array on success or false on failure
*/
function validateBarReportPeriods($periods = array())
{
if (!isset($periods) || !$periods) {
return false;
}
$fields = array('report_timesince', 'report_timetill', 'color');
$colorValidator = new CColorValidator();
foreach ($periods as &$period) {
foreach ($fields as $field) {
if (!isset($period[$field]) || !$period[$field]) {
show_error_message(_s('Missing "%1$s" field for period.', $field));
return false;
}
}
if (!$colorValidator->validate($period['color'])) {
show_error_message($colorValidator->getError());
return false;
}
if (!validateUnixTime($period['report_timesince'])) {
show_error_message(_s('Invalid period for field "%1$s".', 'report_timesince'));
return false;
}
if (!validateUnixTime($period['report_timetill'])) {
show_error_message(_s('Invalid period for field "%1$s".', 'report_timetill'));
return false;
}
if (!isset($period['caption']) || zbx_empty($period['caption'])) {
$period['caption'] = zbx_date2str(REPORTS_BAR_REPORT_DATE_FORMAT, $period['report_timesince']) . ' - ' . zbx_date2str(REPORTS_BAR_REPORT_DATE_FORMAT, $period['report_timetill']);
}
}
unset($period);
return $periods;
}
