505 lines
15 KiB
PHP
505 lines
15 KiB
PHP
<?php
|
|
|
|
namespace Icinga\Module\Director\Objects;
|
|
|
|
use Icinga\Data\Filter\Filter;
|
|
use Icinga\Exception\ProgrammingError;
|
|
use Icinga\Module\Director\Db;
|
|
use Icinga\Module\Director\Data\PropertiesFilter;
|
|
use Icinga\Module\Director\IcingaConfig\IcingaConfig;
|
|
use Icinga\Module\Director\IcingaConfig\IcingaConfigHelper as c;
|
|
use Icinga\Module\Director\IcingaConfig\IcingaLegacyConfigHelper as c1;
|
|
|
|
class IcingaService extends IcingaObject
|
|
{
|
|
protected $table = 'icinga_service';
|
|
|
|
protected $defaultProperties = array(
|
|
'id' => null,
|
|
'object_name' => null,
|
|
'object_type' => null,
|
|
'disabled' => 'n',
|
|
'display_name' => null,
|
|
'host_id' => null,
|
|
'service_set_id' => null,
|
|
'check_command_id' => null,
|
|
'max_check_attempts' => null,
|
|
'check_period_id' => null,
|
|
'check_interval' => null,
|
|
'retry_interval' => null,
|
|
'check_timeout' => null,
|
|
'enable_notifications' => null,
|
|
'enable_active_checks' => null,
|
|
'enable_passive_checks' => null,
|
|
'enable_event_handler' => null,
|
|
'enable_flapping' => null,
|
|
'enable_perfdata' => null,
|
|
'event_command_id' => null,
|
|
'flapping_threshold' => null,
|
|
'volatile' => null,
|
|
'zone_id' => null,
|
|
'command_endpoint_id' => null,
|
|
'notes' => null,
|
|
'notes_url' => null,
|
|
'action_url' => null,
|
|
'icon_image' => null,
|
|
'icon_image_alt' => null,
|
|
'use_agent' => null,
|
|
'apply_for' => null,
|
|
'use_var_overrides' => null,
|
|
'assign_filter' => null,
|
|
'template_choice_id' => null,
|
|
);
|
|
|
|
protected $relations = array(
|
|
'host' => 'IcingaHost',
|
|
'service_set' => 'IcingaServiceSet',
|
|
'check_command' => 'IcingaCommand',
|
|
'event_command' => 'IcingaCommand',
|
|
'check_period' => 'IcingaTimePeriod',
|
|
'command_endpoint' => 'IcingaEndpoint',
|
|
'zone' => 'IcingaZone',
|
|
'template_choice' => 'IcingaTemplateChoiceService',
|
|
);
|
|
|
|
protected $booleans = array(
|
|
'enable_notifications' => 'enable_notifications',
|
|
'enable_active_checks' => 'enable_active_checks',
|
|
'enable_passive_checks' => 'enable_passive_checks',
|
|
'enable_event_handler' => 'enable_event_handler',
|
|
'enable_flapping' => 'enable_flapping',
|
|
'enable_perfdata' => 'enable_perfdata',
|
|
'volatile' => 'volatile',
|
|
'use_agent' => 'use_agent',
|
|
'use_var_overrides' => 'use_var_overrides',
|
|
);
|
|
|
|
protected $intervalProperties = array(
|
|
'check_interval' => 'check_interval',
|
|
'check_timeout' => 'check_timeout',
|
|
'retry_interval' => 'retry_interval',
|
|
);
|
|
|
|
protected $supportsGroups = true;
|
|
|
|
protected $supportsCustomVars = true;
|
|
|
|
protected $supportsFields = true;
|
|
|
|
protected $supportsImports = true;
|
|
|
|
protected $supportsApplyRules = true;
|
|
|
|
protected $supportsSets = true;
|
|
|
|
protected $supportsChoices = true;
|
|
|
|
protected $supportedInLegacy = true;
|
|
|
|
protected $keyName = array('host_id', 'service_set_id', 'object_name');
|
|
|
|
protected $prioritizedProperties = array('host_id');
|
|
|
|
protected $propertiesNotForRendering = array(
|
|
'id',
|
|
'object_name',
|
|
'object_type',
|
|
'apply_for'
|
|
);
|
|
|
|
public function getCheckCommand()
|
|
{
|
|
$id = $this->getSingleResolvedProperty('check_command_id');
|
|
return IcingaCommand::loadWithAutoIncId(
|
|
$id,
|
|
$this->getConnection()
|
|
);
|
|
}
|
|
|
|
public function isApplyRule()
|
|
{
|
|
if ($this->hasBeenAssignedToHostTemplate()) {
|
|
return true;
|
|
}
|
|
|
|
return $this->hasProperty('object_type')
|
|
&& $this->object_type === 'apply';
|
|
}
|
|
|
|
public function usesVarOverrides()
|
|
{
|
|
return $this->use_var_overrides === 'y';
|
|
}
|
|
|
|
protected function setKey($key)
|
|
{
|
|
if (is_int($key)) {
|
|
$this->id = $key;
|
|
} elseif (is_array($key)) {
|
|
foreach (array('id', 'host_id', 'service_set_id', 'object_name') as $k) {
|
|
if (array_key_exists($k, $key)) {
|
|
$this->set($k, $key[$k]);
|
|
}
|
|
}
|
|
} else {
|
|
return parent::setKey($key);
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @codingStandardsIgnoreStart
|
|
*/
|
|
protected function setObject_Name($name)
|
|
{
|
|
// @codingStandardsIgnoreEnd
|
|
|
|
if ($name === null && $this->isApplyRule()) {
|
|
$name = '';
|
|
}
|
|
|
|
return $this->reallySet('object_name', $name);
|
|
}
|
|
|
|
/**
|
|
* Render host_id as host_name
|
|
*
|
|
* Avoid complaints for method names with underscore:
|
|
* @codingStandardsIgnoreStart
|
|
*
|
|
* @return string
|
|
*/
|
|
public function renderHost_id()
|
|
{
|
|
// @codingStandardsIgnoreEnd
|
|
|
|
if ($this->hasBeenAssignedToHostTemplate()) {
|
|
return '';
|
|
}
|
|
|
|
return $this->renderRelationProperty('host', $this->host_id, 'host_name');
|
|
}
|
|
|
|
public function renderToLegacyConfig(IcingaConfig $config)
|
|
{
|
|
if ($this->get('service_set_id') !== null) {
|
|
return;
|
|
} elseif ($this->isApplyRule()) {
|
|
$this->renderLegacyApplyToConfig($config);
|
|
} else {
|
|
parent::renderToLegacyConfig($config);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param IcingaConfig $config
|
|
*/
|
|
protected function renderLegacyApplyToConfig(IcingaConfig $config)
|
|
{
|
|
$conn = $this->getConnection();
|
|
|
|
$assign_filter = $this->get('assign_filter');
|
|
$filter = Filter::fromQueryString($assign_filter);
|
|
$hosts = HostApplyMatches::forFilter($filter, $conn);
|
|
$this->set('object_type', 'object');
|
|
$this->set('assign_filter', null);
|
|
|
|
foreach ($hosts as $hostname) {
|
|
$file = $this->legacyHostnameServicesFile($hostname, $config);
|
|
$this->set('host', $hostname);
|
|
$file->addLegacyObject($this);
|
|
}
|
|
|
|
$this->set('host', null);
|
|
$this->set('object_type', 'apply');
|
|
$this->set('assign_filter', $assign_filter);
|
|
}
|
|
|
|
protected function legacyHostnameServicesFile($hostname, IcingaConfig $config)
|
|
{
|
|
$host = IcingaHost::load($hostname, $this->getConnection());
|
|
return $config->configFile(
|
|
'director/' . $host->getRenderingZone($config) . '/service_apply',
|
|
'.cfg'
|
|
);
|
|
}
|
|
|
|
public function toLegacyConfigString()
|
|
{
|
|
if ($this->get('service_set_id') !== null) {
|
|
return '';
|
|
}
|
|
|
|
if ($this->isApplyRule()) {
|
|
throw new ProgrammingError('Apply Services can not be rendered directly.');
|
|
}
|
|
|
|
$str = parent::toLegacyConfigString();
|
|
|
|
if (! $this->isDisabled() && $this->host_id && $this->getRelated('host')->isDisabled()) {
|
|
return
|
|
"# --- This services host has been disabled ---\n"
|
|
. preg_replace('~^~m', '# ', trim($str))
|
|
. "\n\n";
|
|
} else {
|
|
return $str;
|
|
}
|
|
}
|
|
|
|
public function toConfigString()
|
|
{
|
|
if ($this->get('service_set_id')) {
|
|
return '';
|
|
}
|
|
$str = parent::toConfigString();
|
|
|
|
if (! $this->isDisabled() && $this->host_id && $this->getRelated('host')->isDisabled()) {
|
|
return "/* --- This services host has been disabled ---\n"
|
|
. $str . "*/\n";
|
|
} else {
|
|
return $str;
|
|
}
|
|
}
|
|
|
|
protected function renderObjectHeader()
|
|
{
|
|
if ($this->isApplyRule()
|
|
&& !$this->hasBeenAssignedToHostTemplate()
|
|
&& $this->get('apply_for') !== null
|
|
) {
|
|
$name = $this->getObjectName();
|
|
$extraName = '';
|
|
|
|
if (c::stringHasMacro($name)) {
|
|
$extraName = c::renderKeyValue('name', c::renderStringWithVariables($name));
|
|
$name = '';
|
|
} elseif ($name !== '') {
|
|
$name = ' ' . c::renderString($name);
|
|
}
|
|
|
|
return sprintf(
|
|
"%s %s%s for (config in %s) {\n",
|
|
$this->getObjectTypeName(),
|
|
$this->getType(),
|
|
$name,
|
|
$this->get('apply_for')
|
|
) . $extraName;
|
|
}
|
|
|
|
return parent::renderObjectHeader();
|
|
}
|
|
|
|
protected function getLegacyObjectKeyName()
|
|
{
|
|
if ($this->isTemplate()) {
|
|
return 'name';
|
|
} else {
|
|
return 'service_description';
|
|
}
|
|
}
|
|
|
|
protected function hasBeenAssignedToHostTemplate()
|
|
{
|
|
return $this->host_id && $this->getRelatedObject(
|
|
'host',
|
|
$this->host_id
|
|
)->object_type === 'template';
|
|
}
|
|
|
|
protected function renderSuffix()
|
|
{
|
|
if ($this->isApplyRule() || $this->usesVarOverrides()) {
|
|
return $this->renderImportHostVarOverrides() . parent::renderSuffix();
|
|
} else {
|
|
return parent::renderSuffix();
|
|
}
|
|
}
|
|
|
|
protected function renderImportHostVarOverrides()
|
|
{
|
|
if (! $this->connection) {
|
|
throw new ProgrammingError(
|
|
'Cannot render services without an assigned DB connection'
|
|
);
|
|
}
|
|
|
|
return "\n import DirectorOverrideTemplate\n";
|
|
}
|
|
|
|
protected function renderCustomExtensions()
|
|
{
|
|
$output = '';
|
|
|
|
if ($this->hasBeenAssignedToHostTemplate()) {
|
|
// TODO: use assignment renderer?
|
|
$filter = sprintf(
|
|
'assign where %s in host.templates',
|
|
c::renderString($this->host)
|
|
);
|
|
|
|
$output .= "\n " . $filter . "\n";
|
|
}
|
|
|
|
// A hand-crafted command endpoint overrides use_agent
|
|
if ($this->command_endpoint_id !== null) {
|
|
return $output;
|
|
}
|
|
|
|
// In case use_agent isn't defined, do nothing
|
|
// TODO: what if we inherit use_agent and override it with 'n'?
|
|
if ($this->use_agent !== 'y') {
|
|
return $output;
|
|
}
|
|
|
|
return $output . c::renderKeyValue('command_endpoint', 'host_name');
|
|
}
|
|
|
|
/**
|
|
* Do not render internal property
|
|
*
|
|
* Avoid complaints for method names with underscore:
|
|
* @codingStandardsIgnoreStart
|
|
*
|
|
* @return string
|
|
*/
|
|
public function renderUse_agent()
|
|
{
|
|
return '';
|
|
}
|
|
|
|
public function renderUse_var_overrides()
|
|
{
|
|
return '';
|
|
}
|
|
|
|
protected function renderTemplate_choice_id()
|
|
{
|
|
return '';
|
|
}
|
|
|
|
protected function renderLegacyDisplay_Name()
|
|
{
|
|
// @codingStandardsIgnoreEnd
|
|
return c1::renderKeyValue('display_name', $this->display_name);
|
|
}
|
|
|
|
public function hasCheckCommand()
|
|
{
|
|
return $this->getSingleResolvedProperty('check_command_id') !== null;
|
|
}
|
|
|
|
public function getOnDeleteUrl()
|
|
{
|
|
if ($this->host_id) {
|
|
return 'director/host/services?name=' . rawurlencode($this->host);
|
|
} else {
|
|
return parent::getOnDeleteUrl();
|
|
}
|
|
}
|
|
|
|
public function getRenderingZone(IcingaConfig $config = null)
|
|
{
|
|
if ($this->prefersGlobalZone()) {
|
|
return $this->connection->getDefaultGlobalZoneName();
|
|
}
|
|
|
|
$zone = parent::getRenderingZone($config);
|
|
|
|
// if bound to a host, and zone is fallback to master
|
|
if ($this->host_id !== null && $zone === $this->connection->getMasterZoneName()) {
|
|
/** @var IcingaHost $host */
|
|
$host = $this->getRelatedObject('host', $this->host_id);
|
|
return $host->getRenderingZone($config);
|
|
}
|
|
return $zone;
|
|
}
|
|
|
|
// TODO: Duplicate code, clean this up, split it into multiple methods
|
|
public static function enumProperties(
|
|
Db $connection = null,
|
|
$prefix = '',
|
|
$filter = null
|
|
) {
|
|
$serviceProperties = array();
|
|
if ($filter === null) {
|
|
$filter = new PropertiesFilter();
|
|
}
|
|
$realProperties = static::create()->listProperties();
|
|
sort($realProperties);
|
|
|
|
if ($filter->match(PropertiesFilter::$SERVICE_PROPERTY, 'name')) {
|
|
$serviceProperties[$prefix . 'name'] = 'name';
|
|
}
|
|
foreach ($realProperties as $prop) {
|
|
if (!$filter->match(PropertiesFilter::$SERVICE_PROPERTY, $prop)) {
|
|
continue;
|
|
}
|
|
|
|
if (substr($prop, -3) === '_id') {
|
|
if ($prop === 'template_choice_id') {
|
|
continue;
|
|
}
|
|
$prop = substr($prop, 0, -3);
|
|
}
|
|
|
|
$serviceProperties[$prefix . $prop] = $prop;
|
|
}
|
|
|
|
$serviceVars = array();
|
|
|
|
if ($connection !== null) {
|
|
foreach ($connection->fetchDistinctServiceVars() as $var) {
|
|
if ($filter->match(PropertiesFilter::$CUSTOM_PROPERTY, $var->varname, $var)) {
|
|
if ($var->datatype) {
|
|
$serviceVars[$prefix . 'vars.' . $var->varname] = sprintf(
|
|
'%s (%s)',
|
|
$var->varname,
|
|
$var->caption
|
|
);
|
|
} else {
|
|
$serviceVars[$prefix . 'vars.' . $var->varname] = $var->varname;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
//$properties['vars.*'] = 'Other custom variable';
|
|
ksort($serviceVars);
|
|
|
|
$props = mt('director', 'Service properties');
|
|
$vars = mt('director', 'Custom variables');
|
|
|
|
$properties = array();
|
|
if (!empty($serviceProperties)) {
|
|
$properties[$props] = $serviceProperties;
|
|
$properties[$props][$prefix . 'groups'] = 'Groups';
|
|
}
|
|
|
|
if (!empty($serviceVars)) {
|
|
$properties[$vars] = $serviceVars;
|
|
}
|
|
|
|
$hostProps = mt('director', 'Host properties');
|
|
$hostVars = mt('director', 'Host Custom variables');
|
|
|
|
$hostProperties = IcingaHost::enumProperties($connection, 'host.');
|
|
|
|
if (array_key_exists($hostProps, $hostProperties)) {
|
|
$p = $hostProperties[$hostProps];
|
|
if (!empty($p)) {
|
|
$properties[$hostProps] = $p;
|
|
}
|
|
}
|
|
|
|
if (array_key_exists($vars, $hostProperties)) {
|
|
$p = $hostProperties[$vars];
|
|
if (!empty($p)) {
|
|
$properties[$hostVars] = $p;
|
|
}
|
|
}
|
|
|
|
return $properties;
|
|
}
|
|
}
|