- * $array = array('first', 'second', 'third');
- * moveElementUp('third', $array); // returns ['first', 'third', 'second']
- *
- *
- * @param string $key The key to bubble up one slot
- * @param array $array The array to work with
- *
- * @return array The modified array
- */
- protected static function moveElementUp($key, array $array)
- {
- for ($i = 0; $i < count($array) - 1; $i++) {
- if ($array[$i + 1] === $key) {
- $swap = $array[$i];
- $array[$i] = $array[$i + 1];
- $array[$i + 1] = $swap;
- return $array;
- }
- }
-
- return $array;
- }
-
- /**
- * Static helper for moving an element in an array one slot down, if possible
- *
- * Example:
- *
- *
- * $array = array('first', 'second', 'third');
- * moveElementDown('first', $array); // returns ['second', 'first', 'third']
- *
- *
- * @param string $key The key to bubble up one slot
- * @param array $array The array to work with
- *
- * @return array The modified array
- */
- protected static function moveElementDown($key, array $array)
- {
- for ($i = 0; $i < count($array) - 1; $i++) {
- if ($array[$i] === $key) {
- $swap = $array[$i + 1];
- $array[$i + 1] = $array[$i];
- $array[$i] = $swap;
- return $array;
- }
- }
-
- return $array;
- }
-}
diff --git a/application/forms/Config/AuthenticationBackendConfigForm.php b/application/forms/Config/AuthenticationBackendConfigForm.php
new file mode 100644
index 000000000..e81382cd4
--- /dev/null
+++ b/application/forms/Config/AuthenticationBackendConfigForm.php
@@ -0,0 +1,322 @@
+setName('form_config_authbackend');
+ $this->setSubmitLabel(t('Save Changes'));
+ }
+
+ /**
+ * Set the resource configuration to use
+ *
+ * @param Config $resources The resource configuration
+ *
+ * @return self
+ *
+ * @throws ConfigurationError In case no resources are available for authentication
+ */
+ public function setResourceConfig(Config $resourceConfig)
+ {
+ $resources = array();
+ foreach ($resourceConfig as $name => $resource) {
+ $resources[strtolower($resource->type)][] = $name;
+ }
+
+ if (empty($resources)) {
+ throw new ConfigurationError(t('Could not find any resources for authentication'));
+ }
+
+ $this->resources = $resources;
+ return $this;
+ }
+
+ /**
+ * Return a form object for the given backend type
+ *
+ * @param string $type The backend type for which to return a form
+ *
+ * @return Form
+ */
+ public function getBackendForm($type)
+ {
+ if ($type === 'db') {
+ $form = new DbBackendForm();
+ $form->setResources(isset($this->resources['db']) ? $this->resources['db'] : array());
+ } elseif ($type === 'ldap') {
+ $form = new LdapBackendForm();
+ $form->setResources(isset($this->resources['ldap']) ? $this->resources['ldap'] : array());
+ } elseif ($type === 'autologin') {
+ $form = new AutologinBackendForm();
+ } else {
+ throw new InvalidArgumentException(sprintf(t('Invalid backend type "%s" provided'), $type));
+ }
+
+ return $form;
+ }
+
+ /**
+ * Add a particular authentication backend
+ *
+ * The backend to add is identified by the array-key `name'.
+ *
+ * @param array $values The values to extend the configuration with
+ *
+ * @return self
+ *
+ * @throws InvalidArgumentException In case the backend does already exist
+ */
+ public function add(array $values)
+ {
+ $name = isset($values['name']) ? $values['name'] : '';
+ if (! $name) {
+ throw new InvalidArgumentException(t('Authentication backend name missing'));
+ } elseif ($this->config->get($name) !== null) {
+ throw new InvalidArgumentException(t('Authentication backend already exists'));
+ }
+
+ unset($values['name']);
+ $this->config->{$name} = $values;
+ return $this;
+ }
+
+ /**
+ * Edit a particular authentication backend
+ *
+ * @param string $name The name of the backend to edit
+ * @param array $values The values to edit the configuration with
+ *
+ * @return array The edited backend configuration
+ *
+ * @throws InvalidArgumentException In case the backend does not exist
+ */
+ public function edit($name, array $values)
+ {
+ if (! $name) {
+ throw new InvalidArgumentException(t('Old authentication backend name missing'));
+ } elseif (! ($newName = isset($values['name']) ? $values['name'] : '')) {
+ throw new InvalidArgumentException(t('New authentication backend name missing'));
+ } elseif (($backendConfig = $this->config->get($name)) === null) {
+ throw new InvalidArgumentException(t('Unknown authentication backend provided'));
+ }
+
+ if ($newName !== $name) {
+ // Only remove the old entry if it has changed as the order gets screwed when editing backend names
+ unset($this->config->{$name});
+ }
+
+ unset($values['name']);
+ $this->config->{$newName} = array_merge($backendConfig->toArray(), $values);
+ return $this->config->{$newName};
+ }
+
+ /**
+ * Remove the given authentication backend
+ *
+ * @param string $name The name of the backend to remove
+ *
+ * @return array The removed backend configuration
+ *
+ * @throws InvalidArgumentException In case the backend does not exist
+ */
+ public function remove($name)
+ {
+ if (! $name) {
+ throw new InvalidArgumentException(t('Authentication backend name missing'));
+ } elseif (($backendConfig = $this->config->get($name)) === null) {
+ throw new InvalidArgumentException(t('Unknown authentication backend provided'));
+ }
+
+ unset($this->config->{$name});
+ return $backendConfig;
+ }
+
+ /**
+ * Move the given authentication backend up or down in order
+ *
+ * @param string $name The name of the backend to be moved
+ * @param int $position The new (absolute) position of the backend
+ *
+ * @return self
+ *
+ * @throws InvalidArgumentException In case the backend does not exist
+ */
+ public function move($name, $position)
+ {
+ if (! $name) {
+ throw new InvalidArgumentException(t('Authentication backend name missing'));
+ } elseif ($this->config->get($name) === null) {
+ throw new InvalidArgumentException(t('Unknown authentication backend provided'));
+ }
+
+ $backendOrder = $this->config->keys();
+ array_splice($backendOrder, array_search($name, $backendOrder), 1);
+ array_splice($backendOrder, $position, 0, $name);
+
+ $newConfig = array();
+ foreach ($backendOrder as $backendName) {
+ $newConfig[$backendName] = $this->config->get($backendName);
+ }
+
+ $config = new Config($newConfig);
+ $this->config = $config->setConfigFile($this->config->getConfigFile());
+ return $this;
+ }
+
+ /**
+ * Add or edit an authentication backend and save the configuration
+ *
+ * Performs a connectivity validation using the submitted values. A checkbox is
+ * added to the form to skip the check if it fails and redirection is aborted.
+ *
+ * @see Form::onSuccess()
+ */
+ public function onSuccess(Request $request)
+ {
+ if (($el = $this->getElement('force_creation')) === null || false === $el->isChecked()) {
+ $backendForm = $this->getBackendForm($this->getElement('type')->getValue());
+ if (false === $backendForm->isValidAuthenticationBackend($this)) {
+ $this->addElement($this->getForceCreationCheckbox());
+ return false;
+ }
+ }
+
+ $authBackend = $request->getQuery('auth_backend');
+ try {
+ if ($authBackend === null) { // create new backend
+ $this->add($this->getValues());
+ $message = t('Authentication backend "%s" has been successfully created');
+ } else { // edit existing backend
+ $this->edit($authBackend, $this->getValues());
+ $message = t('Authentication backend "%s" has been successfully changed');
+ }
+ } catch (InvalidArgumentException $e) {
+ Notification::error($e->getMessage());
+ return;
+ }
+
+ if ($this->save()) {
+ Notification::success(sprintf($message, $this->getElement('name')->getValue()));
+ } else {
+ return false;
+ }
+ }
+
+ /**
+ * Populate the form in case an authentication backend is being edited
+ *
+ * @see Form::onRequest()
+ *
+ * @throws ConfigurationError In case the backend name is missing in the request or is invalid
+ */
+ public function onRequest(Request $request)
+ {
+ $authBackend = $request->getQuery('auth_backend');
+ if ($authBackend !== null) {
+ if ($authBackend === '') {
+ throw new ConfigurationError(t('Authentication backend name missing'));
+ } elseif (false === isset($this->config->{$authBackend})) {
+ throw new ConfigurationError(t('Unknown authentication backend provided'));
+ } elseif (false === isset($this->config->{$authBackend}->backend)) {
+ throw new ConfigurationError(sprintf(t('Backend "%s" has no `backend\' setting'), $authBackend));
+ }
+
+ $configValues = $this->config->{$authBackend}->toArray();
+ $configValues['type'] = $configValues['backend'];
+ $configValues['name'] = $authBackend;
+ $this->populate($configValues);
+ }
+ }
+
+ /**
+ * Return a checkbox to be displayed at the beginning of the form
+ * which allows the user to skip the connection validation
+ *
+ * @return Zend_Form_Element
+ */
+ protected function getForceCreationCheckbox()
+ {
+ return $this->createElement(
+ 'checkbox',
+ 'force_creation',
+ array(
+ 'order' => 0,
+ 'ignore' => true,
+ 'label' => t('Force Changes'),
+ 'description' => t('Check this box to enforce changes without connectivity validation')
+ )
+ );
+ }
+
+ /**
+ * @see Form::createElements()
+ */
+ public function createElements(array $formData)
+ {
+ $backendTypes = array();
+ $backendType = isset($formData['type']) ? $formData['type'] : 'db';
+
+ if (isset($this->resources['db'])) {
+ $backendTypes['db'] = t('Database');
+ }
+ if (isset($this->resources['ldap']) && ($backendType === 'ldap' || Platform::extensionLoaded('ldap'))) {
+ $backendTypes['ldap'] = 'LDAP';
+ }
+
+ $autologinBackends = array_filter(
+ $this->config->toArray(),
+ function ($authBackendCfg) {
+ return isset($authBackendCfg['backend']) && $authBackendCfg['backend'] === 'autologin';
+ }
+ );
+ if ($backendType === 'autologin' || empty($autologinBackends)) {
+ $backendTypes['autologin'] = t('Autologin');
+ }
+
+ $this->addElement(
+ 'select',
+ 'type',
+ array(
+ 'ignore' => true,
+ 'required' => true,
+ 'autosubmit' => true,
+ 'label' => t('Backend Type'),
+ 'description' => t('The type of the resource to use for this authenticaton backend'),
+ 'multiOptions' => $backendTypes
+ )
+ );
+
+ if (isset($formData['force_creation']) && $formData['force_creation']) {
+ // In case another error occured and the checkbox was displayed before
+ $this->addElement($this->getForceCreationCheckbox());
+ }
+
+ $this->addElements($this->getBackendForm($backendType)->createElements($formData)->getElements());
+ }
+}
diff --git a/application/forms/Config/AuthenticationBackendReorderForm.php b/application/forms/Config/AuthenticationBackendReorderForm.php
new file mode 100644
index 000000000..3b5e70866
--- /dev/null
+++ b/application/forms/Config/AuthenticationBackendReorderForm.php
@@ -0,0 +1,68 @@
+setName('form_reorder_authbackend');
+ $this->setViewScript('form/reorder-authbackend.phtml');
+ }
+
+ /**
+ * Return the ordered backend names
+ *
+ * @return array
+ */
+ public function getBackendOrder()
+ {
+ return $this->config->keys();
+ }
+
+ /**
+ * Update the authentication backend order and save the configuration
+ *
+ * @see Form::onSuccess()
+ */
+ public function onSuccess(Request $request)
+ {
+ $formData = $this->getRequestData($request);
+ if (isset($formData['backend_newpos'])) {
+ $configForm = $this->getConfigForm();
+ list($backendName, $position) = explode('|', $formData['backend_newpos'], 2);
+
+ try {
+ if ($configForm->move($backendName, $position)->save()) {
+ Notification::success(t('Authentication order updated!'));
+ } else {
+ return false;
+ }
+ } catch (InvalidArgumentException $e) {
+ Notification::error($e->getMessage());
+ }
+ }
+ }
+
+ /**
+ * Return the config form for authentication backends
+ *
+ * @return ConfigForm
+ */
+ protected function getConfigForm()
+ {
+ $form = new AuthenticationBackendConfigForm();
+ $form->setIniConfig($this->config);
+ return $form;
+ }
+}
diff --git a/application/forms/Config/ConfirmRemovalForm.php b/application/forms/Config/ConfirmRemovalForm.php
deleted file mode 100644
index 65624c7b5..000000000
--- a/application/forms/Config/ConfirmRemovalForm.php
+++ /dev/null
@@ -1,69 +0,0 @@
-targetName = $name;
- $this->removeTarget = $target;
- }
-
- /**
- * Create the confirmation form
- *
- * @see Form::create()
- */
- public function create()
- {
- $this->setName('form_confirm_removal');
- $this->addElement(
- 'hidden',
- $this->targetName,
- array(
- 'value' => $this->removeTarget,
- 'required' => true
- )
- );
-
- $this->addElement(
- 'button',
- 'btn_submit',
- array(
- 'type' => 'submit',
- 'escape' => false,
- 'value' => '1',
- 'class' => 'btn btn-cta btn-common',
- 'label' => ' Confirm Removal'
- )
- );
- }
-}
diff --git a/application/forms/Config/General/ApplicationConfigForm.php b/application/forms/Config/General/ApplicationConfigForm.php
new file mode 100644
index 000000000..fda695886
--- /dev/null
+++ b/application/forms/Config/General/ApplicationConfigForm.php
@@ -0,0 +1,118 @@
+setName('form_config_general_application');
+ }
+
+ /**
+ * @see Form::createElements()
+ */
+ public function createElements(array $formData)
+ {
+ $languages = array();
+ foreach (Translator::getAvailableLocaleCodes() as $language) {
+ $languages[$language] = $language;
+ }
+
+ $this->addElement(
+ 'select',
+ 'global_language',
+ array(
+ 'label' => t('Default Language'),
+ 'required' => true,
+ 'multiOptions' => $languages,
+ 'description' => t(
+ 'Select the language to use by default. Can be overwritten by a user in his preferences.'
+ )
+ )
+ );
+
+ $tzList = array();
+ foreach (DateTimeZone::listIdentifiers() as $tz) {
+ $tzList[$tz] = $tz;
+ }
+
+ $this->addElement(
+ 'select',
+ 'global_timezone',
+ array(
+ 'label' => t('Default Application Timezone'),
+ 'required' => true,
+ 'multiOptions' => $tzList,
+ 'description' => t(
+ 'Select the timezone to be used as the default. User\'s can set their own timezone if'
+ . ' they like to, but this is the timezone to be used as the default setting .'
+ ),
+ 'value' => date_default_timezone_get()
+ )
+ );
+
+ $this->addElement(
+ 'text',
+ 'global_modulePath',
+ array(
+ 'label' => t('Module Path'),
+ 'required' => true,
+ 'description' => t(
+ 'Contains the directories that will be searched for available modules, separated by '
+ . 'colons. Modules that don\'t exist in these directories can still be symlinked in '
+ . 'the module folder, but won\'t show up in the list of disabled modules.'
+ ),
+ 'value' => realpath(ICINGAWEB_APPDIR . '/../modules')
+ )
+ );
+
+ $this->addElement(
+ 'select',
+ 'preferences_type',
+ array(
+ 'required' => true,
+ 'autosubmit' => true,
+ 'label' => t('User Preference Storage Type'),
+ 'multiOptions' => array(
+ 'ini' => t('File System (INI Files)'),
+ 'db' => t('Database'),
+ 'null' => t('Don\'t Store Preferences')
+ )
+ )
+ );
+ if (isset($formData['preferences_type']) && $formData['preferences_type'] === 'db') {
+ $backends = array();
+ foreach (ResourceFactory::getResourceConfigs()->toArray() as $name => $resource) {
+ if ($resource['type'] === 'db') {
+ $backends[$name] = $name;
+ }
+ }
+
+ $this->addElement(
+ 'select',
+ 'preferences_resource',
+ array(
+ 'required' => true,
+ 'multiOptions' => $backends,
+ 'label' => t('Database Connection')
+ )
+ );
+ }
+
+ return $this;
+ }
+}
diff --git a/application/forms/Config/General/LoggingConfigForm.php b/application/forms/Config/General/LoggingConfigForm.php
new file mode 100644
index 000000000..733c306b9
--- /dev/null
+++ b/application/forms/Config/General/LoggingConfigForm.php
@@ -0,0 +1,127 @@
+setName('form_config_general_logging');
+ }
+
+ /**
+ * (non-PHPDoc)
+ * @see Form::createElements() For the method documentation.
+ */
+ public function createElements(array $formData)
+ {
+ $this->addElement(
+ 'select',
+ 'logging_log',
+ array(
+ 'required' => true,
+ 'class' => 'autosubmit',
+ 'label' => t('Logging Type'),
+ 'description' => t('The type of logging to utilize.'),
+ 'multiOptions' => array(
+ 'syslog' => 'Syslog',
+ 'file' => t('File'),
+ 'none' => t('None')
+ )
+ )
+ );
+
+ if (! isset($formData['logging_log']) || $formData['logging_log'] !== 'none') {
+ $this->addElement(
+ 'select',
+ 'logging_level',
+ array(
+ 'required' => true,
+ 'label' => t('Logging Level'),
+ 'description' => t('The maximum logging level to emit.'),
+ 'multiOptions' => array(
+ Logger::$levels[Logger::ERROR] => t('Error'),
+ Logger::$levels[Logger::WARNING] => t('Warning'),
+ Logger::$levels[Logger::INFO] => t('Information'),
+ Logger::$levels[Logger::DEBUG] => t('Debug')
+ )
+ )
+ );
+ }
+
+ if (isset($formData['logging_log']) && $formData['logging_log'] === 'syslog') {
+ $this->addElement(
+ 'text',
+ 'logging_application',
+ array(
+ 'required' => true,
+ 'label' => t('Application Prefix'),
+ 'description' => t('The name of the application by which to prefix syslog messages.'),
+ 'value' => 'icingaweb',
+ 'validators' => array(
+ array(
+ 'Regex',
+ false,
+ array(
+ 'pattern' => '/^[^\W]+$/',
+ 'messages' => array(
+ 'regexNotMatch' => 'The application prefix cannot contain any whitespaces.'
+ )
+ )
+ )
+ )
+ )
+ );
+ /*
+ * Note(el): Since we provide only one possible value for the syslog facility, I opt against exposing
+ * this configuration.
+ */
+// $this->addElement(
+// 'select',
+// 'logging_facility',
+// array(
+// 'required' => true,
+// 'label' => t('Facility'),
+// 'description' => t('The syslog facility to utilize.'),
+// 'multiOptions' => array(
+// 'user' => 'LOG_USER'
+// )
+// )
+// );
+ } elseif (isset($formData['logging_log']) && $formData['logging_log'] === 'file') {
+ $this->addElement(
+ 'text',
+ 'logging_file',
+ array(
+ 'required' => true,
+ 'label' => t('File path'),
+ 'description' => t('The full path to the log file to write messages to.'),
+ 'value' => $this->getDefaultLogDir(),
+ 'validators' => array(new WritablePathValidator())
+ )
+ );
+ }
+
+ return $this;
+ }
+
+ /**
+ * Return the default logging directory for type 'file'
+ *
+ * @return string
+ */
+ protected function getDefaultLogDir()
+ {
+ return realpath(Icinga::app()->getApplicationDir('../var/log/icingaweb.log'));
+ }
+}
diff --git a/application/forms/Config/GeneralConfigForm.php b/application/forms/Config/GeneralConfigForm.php
new file mode 100644
index 000000000..0b55704c2
--- /dev/null
+++ b/application/forms/Config/GeneralConfigForm.php
@@ -0,0 +1,76 @@
+setName('form_config_general');
+ $this->setSubmitLabel(t('Save Changes'));
+ }
+
+ /**
+ * @see Form::createElements()
+ */
+ public function createElements(array $formData)
+ {
+ $appConfigForm = new ApplicationConfigForm();
+ $loggingConfigForm = new LoggingConfigForm();
+ $this->addElements($appConfigForm->createElements($formData)->getElements());
+ $this->addElements($loggingConfigForm->createElements($formData)->getElements());
+ }
+
+ /**
+ * @see Form::onSuccess()
+ */
+ public function onSuccess(Request $request)
+ {
+ $sections = array();
+ foreach ($this->getValues() as $sectionAndPropertyName => $value) {
+ list($section, $property) = explode('_', $sectionAndPropertyName);
+ if (! isset($sections[$section])) {
+ $sections[$section] = array();
+ }
+ $sections[$section][$property] = $value;
+ }
+ foreach ($sections as $section => $config) {
+ $this->config->{$section} = $config;
+ }
+
+ if ($this->save()) {
+ Notification::success(t('New configuration has successfully been stored'));
+ } else {
+ return false;
+ }
+ }
+
+ /**
+ * @see Form::onRequest()
+ */
+ public function onRequest(Request $request)
+ {
+ $values = array();
+ foreach ($this->config as $section => $properties) {
+ foreach ($properties as $name => $value) {
+ $values[$section . '_' . $name] = $value;
+ }
+ }
+
+ $this->populate($values);
+ }
+}
diff --git a/application/forms/Config/GeneralForm.php b/application/forms/Config/GeneralForm.php
deleted file mode 100644
index debb27d44..000000000
--- a/application/forms/Config/GeneralForm.php
+++ /dev/null
@@ -1,270 +0,0 @@
-configDir = $dir;
- }
-
- /**
- * Return the config path set for this form or the application wide config path if none is set
- *
- * @return string
- *
- * @see IcingaConfig::configDir
- */
- public function getConfigDir()
- {
- return $this->configDir === null ? IcingaConfig::$configDir : $this->configDir;
- }
-
- /**
- * Set an alternative array of resources that should be used instead of the DBFactory resource set
- * (used for testing)
- *
- * @param array $resources The resources to use for populating the db selection field
- */
- public function setResources(array $resources)
- {
- $this->resources = $resources;
- }
-
- /**
- * Return content of the resources.ini or previously set resources for displaying in the database selection field
- *
- * @return array
- */
- public function getResources()
- {
- if ($this->resources === null) {
- return ResourceFactory::getResourceConfigs()->toArray();
- } else {
- return $this->resources;
- }
- }
-
- /**
- * Add a select field for setting the default language
- *
- * Possible values are determined by Translator::getAvailableLocaleCodes.
- *
- * @param Zend_Config $cfg The "global" section of the config.ini
- */
- private function addLanguageSelection(Zend_Config $cfg)
- {
- $languages = array();
- foreach (Translator::getAvailableLocaleCodes() as $language) {
- $languages[$language] = $language;
- }
-
- $this->addElement(
- 'select',
- 'language',
- array(
- 'label' => t('Default Language'),
- 'required' => true,
- 'multiOptions' => $languages,
- 'helptext' => t(
- 'Select the language to use by default. Can be overwritten by a user in his preferences.'
- ),
- 'value' => $cfg->get('language', Translator::DEFAULT_LOCALE)
- )
- );
- }
-
- /**
- * Add a select field for setting the default timezone.
- *
- * Possible values are determined by DateTimeZone::listIdentifiers
- *
- * @param Zend_Config $cfg The "global" section of the config.ini
- */
- private function addTimezoneSelection(Zend_Config $cfg)
- {
- $tzList = array();
- foreach (DateTimeZone::listIdentifiers() as $tz) {
- $tzList[$tz] = $tz;
- }
- $helptext = 'Select the timezone to be used as the default. User\'s can set their own timezone if'
- . ' they like to, but this is the timezone to be used as the default setting .';
-
- $this->addElement(
- 'select',
- 'timezone',
- array(
- 'label' => 'Default Application Timezone',
- 'required' => true,
- 'multiOptions' => $tzList,
- 'helptext' => $helptext,
- 'value' => $cfg->get('timezone', date_default_timezone_get())
- )
- );
- }
-
- /**
- * Add configuration settings for module paths
- *
- * @param Zend_Config $cfg The "global" section of the config.ini
- */
- private function addModuleSettings(Zend_Config $cfg)
- {
- $this->addElement(
- 'text',
- 'module_path',
- array(
- 'label' => 'Module Path',
- 'required' => true,
- 'helptext' => 'Contains the directories that will be searched for available modules, separated by ' .
- ' colons. Modules that don\'t exist in these directories can still be symlinked in the module ' .
- ' folder, but won\'t show up in the list of disabled modules.',
- 'value' => $cfg->get('modulePath', realpath(ICINGAWEB_APPDIR . '/../modules'))
- )
- );
- }
-
- /**
- * Add form elements for setting the user preference storage backend
- *
- * @param Zend_Config $cfg The Zend_config object of preference section
- */
- public function addUserPreferencesDialog(Zend_Config $cfg)
- {
- $backend = $cfg->get('type', 'ini');
- if ($this->getRequest()->get('preferences_type', null) !== null) {
- $backend = $this->getRequest()->get('preferences_type');
- }
- $this->addElement(
- 'select',
- 'preferences_type',
- array(
- 'label' => 'User Preference Storage Type',
- 'required' => true,
- 'value' => $backend,
- 'multiOptions' => array(
- 'ini' => 'File System (INI Files)',
- 'db' => 'Database',
- 'null' => 'Don\'t Store Preferences'
- )
- )
- );
-
- $backends = array();
- foreach ($this->getResources() as $name => $resource) {
- if ($resource['type'] !== 'db') {
- continue;
- }
- $backends[$name] = $name;
- }
-
- $txtPreferencesDbResource = new Zend_Form_Element_Select(
- array(
- 'name' => 'preferences_db_resource',
- 'label' => 'Database Connection',
- 'required' => $backend === 'db',
- 'condition' => $backend === 'db',
- 'value' => $cfg->get('resource'),
- 'multiOptions' => $backends
- )
- );
- $validator = new WritablePathValidator();
- $validator->setRequireExistence();
- $this->addElement($txtPreferencesDbResource);
-
- $txtPreferencesDbResource->addDecorator(new ConditionalHidden());
- $this->enableAutoSubmit(
- array(
- 'preferences_type'
- )
- );
- }
-
- /**
- * Create the general form, using the provided configuration
- *
- * @see Form::create()
- */
- public function create()
- {
- $config = $this->getConfiguration();
- $global = $config->global;
- if ($global === null) {
- $global = new Zend_Config(array());
- }
- $preferences = $config->preferences;
- if ($preferences === null) {
- $preferences = new Zend_Config(array());
- }
- $this->setName('form_config_general');
- $this->addLanguageSelection($global);
- $this->addTimezoneSelection($global);
- $this->addModuleSettings($global);
- $this->addUserPreferencesDialog($preferences);
-
- $this->setSubmitLabel('Save Changes');
- }
-
- /**
- * Return an Zend_Config object containing the configuration set in this form
- *
- * @return Zend_Config
- */
- public function getConfig()
- {
- $config = $this->getConfiguration();
- if ($config->global === null) {
- $config->global = new Zend_Config(array(), true);
- }
- if ($config->preferences === null) {
- $config->preferences = new Zend_Config(array(), true);
- }
-
- $values = $this->getValues();
- $cfg = clone $config;
- $cfg->global->language = $values['language'];
- $cfg->global->timezone = $values['timezone'];
- $cfg->global->modulePath = $values['module_path'];
- $cfg->preferences->type = $values['preferences_type'];
- if ($cfg->preferences->type === 'db') {
- $cfg->preferences->resource = $values['preferences_db_resource'];
- }
-
- return $cfg;
- }
-}
diff --git a/application/forms/Config/LoggingForm.php b/application/forms/Config/LoggingForm.php
deleted file mode 100644
index 1fcb30fa5..000000000
--- a/application/forms/Config/LoggingForm.php
+++ /dev/null
@@ -1,178 +0,0 @@
-getApplicationDir() . '/../var/log/icingaweb.log');
- }
-
- /**
- * Create this logging configuration form
- *
- * @see Form::create()
- */
- public function create()
- {
- $this->setName('form_config_logging');
-
- $config = $this->getConfiguration();
- if (($loggingConfig = $config->logging) === null) {
- $loggingConfig = new Zend_Config(array());
- }
-
- $this->addElement(
- 'checkbox',
- 'logging_enable',
- array(
- 'required' => true,
- 'label' => t('Logging Enabled'),
- 'helptext' => t('Check this to enable logging.'),
- 'value' => $loggingConfig->enable ? 1 : 0
- )
- );
- $this->addElement(
- 'select',
- 'logging_level',
- array(
- 'required' => true,
- 'label' => t('Logging Level'),
- 'helptext' => t('The maximum loglevel to emit.'),
- 'value' => intval($loggingConfig->get('level', 0)),
- 'multiOptions' => array(
- 0 => t('Error'),
- 1 => t('Warning'),
- 2 => t('Information'),
- 3 => t('Debug')
- )
- )
- );
- $this->addElement(
- 'select',
- 'logging_type',
- array(
- 'required' => true,
- 'label' => t('Logging Type'),
- 'helptext' => t('The type of logging to utilize.'),
- 'value' => $loggingConfig->get('type', 'file'),
- 'multiOptions' => array(
- 'file' => t('File'),
- 'syslog' => 'Syslog'
- )
- )
- );
- $this->enableAutoSubmit(array('logging_type'));
-
- switch ($this->getRequest()->getParam('logging_type', $loggingConfig->get('type', 'file')))
- {
- case 'syslog':
- $this->addElement(
- 'text',
- 'logging_application',
- array(
- 'required' => true,
- 'label' => t('Application Prefix'),
- 'helptext' => t('The name of the application by which to prefix syslog messages.'),
- 'value' => $loggingConfig->get('application', 'icingaweb'),
- 'validators' => array(
- array(
- 'Regex',
- false,
- array(
- 'pattern' => '/^[^\W]+$/',
- 'messages' => array(
- 'regexNotMatch' => 'The application prefix cannot contain any whitespaces.'
- )
- )
- )
- )
- )
- );
- $this->addElement(
- 'select',
- 'logging_facility',
- array(
- 'required' => true,
- 'label' => t('Facility'),
- 'helptext' => t('The Syslog facility to utilize.'),
- 'value' => $loggingConfig->get('facility', 'LOG_USER'),
- 'multiOptions' => array(
- 'LOG_USER' => 'LOG_USER'
- )
- )
- );
- break;
- case 'file':
- default:
- $this->addElement(
- 'text',
- 'logging_target',
- array(
- 'required' => true,
- 'label' => t('Filepath'),
- 'helptext' => t('The logfile to write messages to.'),
- 'value' => $loggingConfig->target ? $loggingConfig->target : $this->getDefaultLogDir(),
- 'validators' => array(new WritablePathValidator())
- )
- );
- }
-
- $this->setSubmitLabel('{{SAVE_ICON}} Save Changes');
- }
-
- public function isValid($data) {
- foreach ($this->getElements() as $key => $element) {
- // Initialize all empty elements with their default values.
- if (!isset($data[$key])) {
- $data[$key] = $element->getValue();
- }
- }
- return parent::isValid($data);
- }
-
- /**
- * Return a Zend_Config object containing the state defined in this form
- *
- * @return Zend_Config The config defined in this form
- */
- public function getConfig()
- {
- $values = $this->getValues();
- $cfg = $this->getConfiguration()->toArray();
-
- $cfg['logging']['enable'] = $values['logging_enable'] == 1;
- $cfg['logging']['level'] = $values['logging_level'];
-
- switch ($values['logging_type'])
- {
- case 'file':
- $cfg['logging']['type'] = 'file';
- $cfg['logging']['target'] = $values['logging_target'];
- break;
- case 'syslog':
- $cfg['logging']['type'] = 'syslog';
- $cfg['logging']['application'] = $values['logging_application'];
- $cfg['logging']['facility'] = $values['logging_facility'];
- break;
- }
-
- return new Zend_Config($cfg);
- }
-}
diff --git a/application/forms/Config/Resource/DbResourceForm.php b/application/forms/Config/Resource/DbResourceForm.php
new file mode 100644
index 000000000..4fd7297d9
--- /dev/null
+++ b/application/forms/Config/Resource/DbResourceForm.php
@@ -0,0 +1,130 @@
+setName('form_config_resource_db');
+ }
+
+ /**
+ * @see Form::createElements()
+ */
+ public function createElements(array $formData)
+ {
+ $this->addElement(
+ 'select',
+ 'db',
+ array(
+ 'required' => true,
+ 'label' => t('Database Type'),
+ 'description' => t('The type of SQL database'),
+ 'multiOptions' => array(
+ 'mysql' => 'MySQL',
+ 'pgsql' => 'PostgreSQL'
+ //'oracle' => 'Oracle'
+ )
+ )
+ );
+ $this->addElement(
+ 'text',
+ 'host',
+ array (
+ 'required' => true,
+ 'label' => t('Host'),
+ 'description' => t('The hostname of the database'),
+ 'value' => 'localhost'
+ )
+ );
+ $this->addElement(
+ new Number(
+ array(
+ 'required' => true,
+ 'name' => 'port',
+ 'label' => t('Port'),
+ 'description' => t('The port to use'),
+ 'value' => 3306
+ )
+ )
+ );
+ $this->addElement(
+ 'text',
+ 'dbname',
+ array(
+ 'required' => true,
+ 'label' => t('Database Name'),
+ 'description' => t('The name of the database to use')
+ )
+ );
+ $this->addElement(
+ 'text',
+ 'username',
+ array (
+ 'required' => true,
+ 'label' => t('Username'),
+ 'description' => t('The user name to use for authentication')
+ )
+ );
+ $this->addElement(
+ 'password',
+ 'password',
+ array(
+ 'required' => true,
+ 'renderPassword' => true,
+ 'label' => t('Password'),
+ 'description' => t('The password to use for authentication')
+ )
+ );
+
+ return $this;
+ }
+
+ /**
+ * Validate that the current configuration points to a valid resource
+ *
+ * @see Form::onSuccess()
+ */
+ public function onSuccess(Request $request)
+ {
+ if (false === $this->isValidResource($this)) {
+ return false;
+ }
+ }
+
+ /**
+ * Validate the resource configuration by trying to connect with it
+ *
+ * @param Form $form The form to fetch the configuration values from
+ *
+ * @return bool Whether validation succeeded or not
+ */
+ public function isValidResource(Form $form)
+ {
+ try {
+ $resource = ResourceFactory::createResource(new Zend_Config($form->getValues()));
+ $resource->getConnection()->getConnection();
+ } catch (Exception $e) {
+ $form->addError(t('Connectivity validation failed, connection to the given resource not possible.'));
+ return false;
+ }
+
+ return true;
+ }
+}
diff --git a/application/forms/Config/Resource/FileResourceForm.php b/application/forms/Config/Resource/FileResourceForm.php
new file mode 100644
index 000000000..d1d33a749
--- /dev/null
+++ b/application/forms/Config/Resource/FileResourceForm.php
@@ -0,0 +1,50 @@
+setName('form_config_resource_file');
+ }
+
+ /**
+ * @see Form::createElements()
+ */
+ public function createElements(array $formData)
+ {
+ $this->addElement(
+ 'text',
+ 'filename',
+ array(
+ 'required' => true,
+ 'label' => t('Filepath'),
+ 'description' => t('The filename to fetch information from'),
+ 'validators' => array(new ReadablePathValidator())
+ )
+ );
+ $this->addElement(
+ 'text',
+ 'fields',
+ array(
+ 'required' => true,
+ 'label' => t('Pattern'),
+ 'description' => t('The regular expression by which to identify columns')
+ )
+ );
+
+ return $this;
+ }
+}
diff --git a/application/forms/Config/Resource/LdapResourceForm.php b/application/forms/Config/Resource/LdapResourceForm.php
new file mode 100644
index 000000000..6196f3a17
--- /dev/null
+++ b/application/forms/Config/Resource/LdapResourceForm.php
@@ -0,0 +1,116 @@
+setName('form_config_resource_ldap');
+ }
+
+ /**
+ * @see Form::createElements()
+ */
+ public function createElements(array $formData)
+ {
+ $this->addElement(
+ 'text',
+ 'hostname',
+ array(
+ 'required' => true,
+ 'label' => t('Host'),
+ 'description' => t('The hostname or address of the LDAP server to use for authentication'),
+ 'value' => 'localhost'
+ )
+ );
+ $this->addElement(
+ new Number(
+ array(
+ 'required' => true,
+ 'name' => 'port',
+ 'label' => t('Port'),
+ 'description' => t('The port of the LDAP server to use for authentication'),
+ 'value' => 389
+ )
+ )
+ );
+ $this->addElement(
+ 'text',
+ 'root_dn',
+ array(
+ 'required' => true,
+ 'label' => t('Root DN'),
+ 'description' => t('The path where users can be found on the ldap server')
+ )
+ );
+ $this->addElement(
+ 'text',
+ 'bind_dn',
+ array(
+ 'required' => true,
+ 'label' => t('Bind DN'),
+ 'description' => t('The user dn to use for querying the ldap server')
+ )
+ );
+ $this->addElement(
+ 'password',
+ 'bind_pw',
+ array(
+ 'required' => true,
+ 'renderPassword' => true,
+ 'label' => t('Bind Password'),
+ 'description' => t('The password to use for querying the ldap server')
+ )
+ );
+
+ return $this;
+ }
+
+ /**
+ * Validate that the current configuration points to a valid resource
+ *
+ * @see Form::onSuccess()
+ */
+ public function onSuccess(Request $request)
+ {
+ if (false === $this->isValidResource($this)) {
+ return false;
+ }
+ }
+
+ /**
+ * Validate the resource configuration by trying to connect with it
+ *
+ * @param Form $form The form to fetch the configuration values from
+ *
+ * @return bool Whether validation succeeded or not
+ */
+ public function isValidResource(Form $form)
+ {
+ try {
+ $resource = ResourceFactory::createResource(new Zend_Config($form->getValues()));
+ $resource->connect();
+ } catch (Exception $e) {
+ $form->addError(t('Connectivity validation failed, connection to the given resource not possible.'));
+ return false;
+ }
+
+ return true;
+ }
+}
diff --git a/application/forms/Config/Resource/LivestatusResourceForm.php b/application/forms/Config/Resource/LivestatusResourceForm.php
new file mode 100644
index 000000000..92534f220
--- /dev/null
+++ b/application/forms/Config/Resource/LivestatusResourceForm.php
@@ -0,0 +1,77 @@
+setName('form_config_resource_livestatus');
+ }
+
+ /**
+ * @see Form::createElements()
+ */
+ public function createElements(array $formData)
+ {
+ $this->addElement(
+ 'text',
+ 'socket',
+ array(
+ 'required' => true,
+ 'label' => t('Socket'),
+ 'description' => t('The path to your livestatus socket used for querying monitoring data'),
+ 'value' => realpath(Icinga::app()->getApplicationDir() . '/../var/rw/livestatus')
+ )
+ );
+
+ return $this;
+ }
+
+ /**
+ * Validate that the current configuration points to a valid resource
+ *
+ * @see Form::onSuccess()
+ */
+ public function onSuccess(Request $request)
+ {
+ if (false === $this->isValidResource($this)) {
+ return false;
+ }
+ }
+
+ /**
+ * Validate the resource configuration by trying to connect with it
+ *
+ * @param Form $form The form to fetch the configuration values from
+ *
+ * @return bool Whether validation succeeded or not
+ */
+ public function isValidResource(Form $form)
+ {
+ try {
+ $resource = ResourceFactory::createResource(new Zend_Config($form->getValues()));
+ $resource->connect()->disconnect();
+ } catch (Exception $e) {
+ $form->addError(t('Connectivity validation failed, connection to the given resource not possible.'));
+ return false;
+ }
+
+ return true;
+ }
+}
diff --git a/application/forms/Config/ResourceConfigForm.php b/application/forms/Config/ResourceConfigForm.php
new file mode 100644
index 000000000..1aa7edc96
--- /dev/null
+++ b/application/forms/Config/ResourceConfigForm.php
@@ -0,0 +1,252 @@
+setName('form_config_resource');
+ $this->setSubmitLabel(t('Save Changes'));
+ }
+
+ /**
+ * Return a form object for the given resource type
+ *
+ * @param string $type The resource type for which to return a form
+ *
+ * @return Form
+ */
+ public function getResourceForm($type)
+ {
+ if ($type === 'db') {
+ return new DbResourceForm();
+ } elseif ($type === 'ldap') {
+ return new LdapResourceForm();
+ } elseif ($type === 'livestatus') {
+ return new LivestatusResourceForm();
+ } elseif ($type === 'file') {
+ return new FileResourceForm();
+ } else {
+ throw new InvalidArgumentException(sprintf(t('Invalid resource type "%s" provided'), $type));
+ }
+ }
+
+ /**
+ * Add a particular resource
+ *
+ * The backend to add is identified by the array-key `name'.
+ *
+ * @param array $values The values to extend the configuration with
+ *
+ * @return self
+ *
+ * @thrwos InvalidArgumentException In case the resource does already exist
+ */
+ public function add(array $values)
+ {
+ $name = isset($values['name']) ? $values['name'] : '';
+ if (! $name) {
+ throw new InvalidArgumentException(t('Resource name missing'));
+ } elseif ($this->config->{$name} !== null) {
+ throw new InvalidArgumentException(t('Resource already exists'));
+ }
+
+ unset($values['name']);
+ $this->config->{$name} = $values;
+ return $this;
+ }
+
+ /**
+ * Edit a particular resource
+ *
+ * @param string $name The name of the resource to edit
+ * @param array $values The values to edit the configuration with
+ *
+ * @return array The edited configuration
+ *
+ * @throws InvalidArgumentException In case the resource does not exist
+ */
+ public function edit($name, array $values)
+ {
+ if (! $name) {
+ throw new InvalidArgumentException(t('Old resource name missing'));
+ } elseif (! ($newName = isset($values['name']) ? $values['name'] : '')) {
+ throw new InvalidArgumentException(t('New resource name missing'));
+ } elseif (($resourceConfig = $this->config->get($name)) === null) {
+ throw new InvalidArgumentException(t('Unknown resource provided'));
+ }
+
+ unset($values['name']);
+ unset($this->config->{$name});
+ $this->config->{$newName} = array_merge($resourceConfig->toArray(), $values);
+ return $this->config->{$newName};
+ }
+
+ /**
+ * Remove a particular resource
+ *
+ * @param string $name The name of the resource to remove
+ *
+ * @return array The removed resource configuration
+ *
+ * @throws InvalidArgumentException In case the resource does not exist
+ */
+ public function remove($name)
+ {
+ if (! $name) {
+ throw new InvalidArgumentException(t('Resource name missing'));
+ } elseif (($resourceConfig = $this->config->get($name)) === null) {
+ throw new InvalidArgumentException(t('Unknown resource provided'));
+ }
+
+ unset($this->config->{$name});
+ return $resourceConfig;
+ }
+
+ /**
+ * Add or edit a resource and save the configuration
+ *
+ * Performs a connectivity validation using the submitted values. A checkbox is
+ * added to the form to skip the check if it fails and redirection is aborted.
+ *
+ * @see Form::onSuccess()
+ */
+ public function onSuccess(Request $request)
+ {
+ if (($el = $this->getElement('force_creation')) === null || false === $el->isChecked()) {
+ $resourceForm = $this->getResourceForm($this->getElement('type')->getValue());
+ if (method_exists($resourceForm, 'isValidResource') && false === $resourceForm->isValidResource($this)) {
+ $this->addElement($this->getForceCreationCheckbox());
+ return false;
+ }
+ }
+
+ $resource = $request->getQuery('resource');
+ try {
+ if ($resource === null) { // create new resource
+ $this->add($this->getValues());
+ $message = t('Resource "%s" has been successfully created');
+ } else { // edit existing resource
+ $this->edit($resource, $this->getValues());
+ $message = t('Resource "%s" has been successfully changed');
+ }
+ } catch (InvalidArgumentException $e) {
+ Notification::error($e->getMessage());
+ return;
+ }
+
+ if ($this->save()) {
+ Notification::success(sprintf($message, $this->getElement('name')->getValue()));
+ } else {
+ return false;
+ }
+ }
+
+ /**
+ * Populate the form in case a resource is being edited
+ *
+ * @see Form::onRequest()
+ *
+ * @throws ConfigurationError In case the backend name is missing in the request or is invalid
+ */
+ public function onRequest(Request $request)
+ {
+ $resource = $request->getQuery('resource');
+ if ($resource !== null) {
+ if ($resource === '') {
+ throw new ConfigurationError(t('Resource name missing'));
+ } elseif (false === isset($this->config->{$resource})) {
+ throw new ConfigurationError(t('Unknown resource provided'));
+ }
+
+ $configValues = $this->config->{$resource}->toArray();
+ $configValues['name'] = $resource;
+ $this->populate($configValues);
+ }
+ }
+
+ /**
+ * Return a checkbox to be displayed at the beginning of the form
+ * which allows the user to skip the connection validation
+ *
+ * @return Zend_Form_Element
+ */
+ protected function getForceCreationCheckbox()
+ {
+ return $this->createElement(
+ 'checkbox',
+ 'force_creation',
+ array(
+ 'order' => 0,
+ 'ignore' => true,
+ 'label' => t('Force Changes'),
+ 'description' => t('Check this box to enforce changes without connectivity validation')
+ )
+ );
+ }
+
+ /**
+ * @see Form::createElemeents()
+ */
+ public function createElements(array $formData)
+ {
+ $resourceType = isset($formData['type']) ? $formData['type'] : 'db';
+
+ $resourceTypes = array(
+ 'file' => t('File'),
+ 'livestatus' => 'Livestatus',
+ );
+ if ($resourceType === 'ldap' || Platform::extensionLoaded('ldap')) {
+ $resourceTypes['ldap'] = 'LDAP';
+ }
+ if ($resourceType === 'db' || Platform::extensionLoaded('mysql') || Platform::extensionLoaded('pgsql')) {
+ $resourceTypes['db'] = t('SQL Database');
+ }
+
+ $this->addElement(
+ 'text',
+ 'name',
+ array(
+ 'required' => true,
+ 'label' => t('Resource Name'),
+ 'description' => t('The unique name of this resource')
+ )
+ );
+ $this->addElement(
+ 'select',
+ 'type',
+ array(
+ 'required' => true,
+ 'autosubmit' => true,
+ 'label' => t('Resource Type'),
+ 'description' => t('The type of resource'),
+ 'multiOptions' => $resourceTypes,
+ 'value' => $resourceType
+ )
+ );
+
+ if (isset($formData['force_creation']) && $formData['force_creation']) {
+ // In case another error occured and the checkbox was displayed before
+ $this->addElement($this->getForceCreationCheckbox());
+ }
+
+ $this->addElements($this->getResourceForm($resourceType)->createElements($formData)->getElements());
+ }
+}
diff --git a/application/forms/Config/ResourceForm.php b/application/forms/Config/ResourceForm.php
deleted file mode 100644
index de6be7699..000000000
--- a/application/forms/Config/ResourceForm.php
+++ /dev/null
@@ -1,507 +0,0 @@
-name = $name;
- }
-
- /**
- * Get the current resource name
- *
- * @return null|string
- */
- public function getName()
- {
- $name = $this->getValue('resource_all_name');
- if (!$name) {
- return $this->name;
- }
-
- return $name;
- }
-
- /**
- * Set the original name of the resource
- *
- * @param string $name The name to set
- */
- public function setOldName($name)
- {
- $this->oldName = $name;
- }
-
- /**
- * Get the resource name that was initially set
- *
- * @return null|string
- */
- public function getOldName()
- {
- $oldName = $this->getValue('resource_all_name_old');
- if (!$oldName) {
- return $this->oldName;
- }
-
- return $oldName;
- }
-
- /**
- * Set the resource configuration to edit.
- *
- * @param Zend_Config $resource The config to set
- */
- public function setResource(Zend_Config $resource)
- {
- $this->resource = $resource;
- }
-
- /**
- * Get the current resource configuration.
- *
- * @return Zend_Config
- */
- public function getResource()
- {
- if (!isset($this->resource)) {
- $this->resource = new Zend_Config(array('type' => 'db'));
- }
-
- return $this->resource;
- }
-
- protected function addDbForm()
- {
- $this->addElement(
- 'select',
- 'resource_db_db',
- array(
- 'required' => true,
- 'label' => t('Database Type'),
- 'helptext' => t('The type of SQL database you want to create.'),
- 'value' => $this->getResource()->get('db', 'mysql'),
- 'multiOptions' => array(
- 'mysql' => 'MySQL',
- 'pgsql' => 'PostgreSQL'
- //'oracle' => 'Oracle'
- )
- )
- );
-
- $this->addElement(
- 'text',
- 'resource_db_host',
- array (
- 'required' => true,
- 'label' => t('Host'),
- 'helptext' => t('The hostname of the database.'),
- 'value' => $this->getResource()->get('host', 'localhost')
- )
- );
-
- $this->addElement(
- new Number(
- array(
- 'name' => 'resource_db_port',
- 'required' => true,
- 'label' => t('Port'),
- 'helptext' => t('The port to use.'),
- 'value' => $this->getResource()->get('port', 3306)
- )
- )
- );
-
- $this->addElement(
- 'text',
- 'resource_db_dbname',
- array(
- 'required' => true,
- 'label' => t('Database Name'),
- 'helptext' => t('The name of the database to use'),
- 'value' => $this->getResource()->get('dbname', '')
- )
- );
-
- $this->addElement(
- 'text',
- 'resource_db_username',
- array (
- 'required' => true,
- 'label' => t('Username'),
- 'helptext' => t('The user name to use for authentication.'),
- 'value' => $this->getResource()->get('username', '')
- )
- );
-
- $this->addElement(
- 'password',
- 'resource_db_password',
- array(
- 'required' => true,
- 'renderPassword' => true,
- 'label' => t('Password'),
- 'helptext' => t('The password to use for authentication'),
- 'value' => $this->getResource()->get('password', '')
- )
- );
- }
-
- protected function addStatusdatForm()
- {
- $this->addElement(
- 'text',
- 'resource_statusdat_status_file',
- array(
- 'required' => true,
- 'label' => t('Filepath'),
- 'helptext' => t('Location of your icinga status.dat file'),
- 'value' => $this->getResource()->get('status_file', '/usr/local/icinga/var/status.dat')
- )
- );
-
- $this->addElement(
- 'text',
- 'resource_statusdat_object_file',
- array(
- 'required' => true,
- 'label' => t('Filepath'),
- 'helptext' => t('Location of your icinga objects.cache file'),
- 'value' => $this->getResource()->get('status_file', '/usr/local/icinga/var/objects.cache')
- )
- );
- }
-
- protected function addLivestatusForm()
- {
- $this->addElement(
- 'text',
- 'resource_livestatus_socket',
- array(
- 'required' => true,
- 'label' => t('Socket'),
- 'helptext' => t('The path to your livestatus socket used for querying monitoring data'),
- 'value' => $this->getResource()->get('socket', '/usr/local/icinga/var/rw/livestatus')
- )
- );
- }
-
- protected function addLdapForm()
- {
- $this->addElement(
- 'text',
- 'resource_ldap_hostname',
- array(
- 'required' => true,
- 'allowEmpty' => false,
- 'label' => t('Host'),
- 'helptext' => t('The hostname or address of the LDAP server to use for authentication'),
- 'value' => $this->getResource()->get('hostname', 'localhost')
- )
- );
-
- $this->addElement(
- 'text',
- 'resource_ldap_root_dn',
- array(
- 'required' => true,
- 'label' => t('Root DN'),
- 'helptext' => t('The path where users can be found on the ldap server'),
- 'value' => $this->getResource()->get('root_dn', 'ou=people,dc=icinga,dc=org')
- )
- );
-
- $this->addElement(
- 'text',
- 'resource_ldap_bind_dn',
- array(
- 'required' => true,
- 'label' => t('Bind DN'),
- 'helptext' => t('The user dn to use for querying the ldap server'),
- 'value' => $this->getResource()->get('bind_dn', 'cn=admin,cn=config')
- )
- );
-
- $this->addElement(
- 'password',
- 'resource_ldap_bind_pw',
- array(
- 'required' => true,
- 'renderPassword' => true,
- 'label' => t('Bind Password'),
- 'helptext' => t('The password to use for querying the ldap server'),
- 'value' => $this->getResource()->get('bind_pw', '')
- )
- );
- }
-
- protected function addFileForm()
- {
- $this->addElement(
- 'text',
- 'resource_file_filename',
- array(
- 'required' => true,
- 'label' => t('Filepath'),
- 'helptext' => t('The filename to fetch information from'),
- 'value' => $this->getResource()->get('filename', '')
- )
- );
-
- $this->addElement(
- 'text',
- 'resource_file_fields',
- array(
- 'required' => true,
- 'label' => t('Pattern'),
- 'helptext' => t('The regular expression by which to identify columns'),
- 'value' => $this->getResource()->get('fields', '')
- )
- );
- }
-
- protected function addNameFields()
- {
- $this->addElement(
- 'text',
- 'resource_all_name',
- array(
- 'required' => true,
- 'label' => t('Resource Name'),
- 'helptext' => t('The unique name of this resource'),
- 'value' => $this->getName()
- )
- );
-
- $this->addElement(
- 'hidden',
- 'resource_all_name_old',
- array(
- 'value' => $this->getOldName()
- )
- );
- }
-
- /**
- * Add checkbox at the beginning of the form which allows to skip connection validation
- */
- protected function addForceCreationCheckbox()
- {
- $checkbox = new Zend_Form_Element_Checkbox(
- array(
- 'order' => 0,
- 'name' => 'resource_force_creation',
- 'label' => t('Force Changes'),
- 'helptext' => t('Check this box to enforce changes without connectivity validation')
- )
- );
- $checkbox->addDecorator(new HelpText());
- $this->addElement($checkbox);
- }
-
- /**
- * Add a select box for choosing the type to use for this backend
- */
- protected function addTypeSelectionBox()
- {
- $this->addElement(
- 'select',
- 'resource_type',
- array(
- 'required' => true,
- 'label' => t('Resource Type'),
- 'helptext' => t('The type of resource'),
- 'value' => $this->getResource()->type,
- 'multiOptions' => array(
- 'db' => t('SQL Database'),
- 'ldap' => 'LDAP',
- 'statusdat' => 'Status.dat',
- 'livestatus' => 'Livestatus',
- 'file' => t('File')
- )
- )
- );
- $this->enableAutoSubmit(array('resource_type'));
- }
-
- /**
- * Validate this form with the Zend validation mechanism and perform a validation of the connection
- *
- * If validation fails, the 'resource_force_creation' checkbox is prepended to the form to allow users to
- * skip the connection validation
- *
- * @param array $data The form input to validate
- *
- * @return bool True when validation succeeded, false if not
- */
- public function isValid($data)
- {
- if (!parent::isValid($data)) {
- return false;
- }
- if (isset($data['resource_force_creation']) && $data['resource_force_creation']) {
- return true;
- }
- if (!$this->isValidResource()) {
- $this->addForceCreationCheckbox();
- return false;
- }
- return true;
- }
-
- /**
- * Test if the changed resource is a valid resource, by instantiating it and
- * checking if a connection is possible
- *
- * @return bool True when a connection to the resource is possible
- */
- public function isValidResource()
- {
- $config = $this->getConfig();
-
- try {
- switch ($config->type) {
- case 'db':
- /*
- * It should be possible to run icingaweb without the pgsql or mysql extension or Zend-Pdo-Classes,
- * in case they aren't actually used. When the user tries to create a resource that depends on an
- * uninstalled extension, an error should be displayed.
- */
- if ($config->db === 'mysql' && ! Platform::extensionLoaded('mysql')) {
- $this->addErrorMessage(
- t('You need to install the php extension "mysql" and the ' .
- 'Zend_Pdo_Mysql classes to use MySQL database resources.')
- );
- return false;
- }
- if ($config->db === 'pgsql' && ! Platform::extensionLoaded('pgsql')) {
- $this->addErrorMessage(
- t('You need to install the php extension "pgsql" and the ' .
- 'Zend_Pdo_Pgsql classes to use PostgreSQL database resources.')
- );
- return false;
- }
-
- $resource = ResourceFactory::createResource($config);
- $resource->getConnection()->getConnection();
- break;
- case 'statusdat':
- if (!file_exists($config->object_file) || !file_exists($config->status_file)) {
- $this->addErrorMessage(
- t('Connectivity validation failed, the provided file does not exist.')
- );
- return false;
- }
- break;
- case 'livestatus':
- $resource = ResourceFactory::createResource($config);
- $resource->connect()->disconnect();
- break;
- case 'ldap':
- $resource = ResourceFactory::createResource($config);
- $resource->connect();
- break;
- case 'file':
- if (!file_exists($config->filename)) {
- $this->addErrorMessage(
- t('Connectivity validation failed, the provided file does not exist.')
- );
- return false;
- }
- break;
- }
- } catch (Exception $e) {
- $this->addErrorMessage(t('Connectivity validation failed, connection to the given resource not possible.'));
- return false;
- }
-
- return true;
- }
-
- public function create()
- {
- $this->addNameFields();
- $this->addTypeSelectionBox();
-
- switch ($this->getRequest()->getParam('resource_type', $this->getResource()->type)) {
- case 'db':
- $this->addDbForm();
- break;
- case 'statusdat':
- $this->addStatusdatForm();
- break;
- case 'livestatus':
- $this->addLivestatusForm();
- break;
- case 'ldap':
- $this->addLdapForm();
- break;
- case 'file':
- $this->addFileForm();
- break;
- }
-
- $this->setSubmitLabel('{{SAVE_ICON}} Save Changes');
- }
-
- /**
- * Return a configuration containing the backend settings entered in this form
- *
- * @return Zend_Config The updated configuration for this backend
- */
- public function getConfig()
- {
- $values = $this->getValues();
-
- $result = array('type' => $values['resource_type']);
- foreach ($values as $key => $value) {
- if ($key !== 'resource_type' && $key !== 'resource_all_name' && $key !== 'resource_all_name_old') {
- $configKey = explode('_', $key, 3);
- if (count($configKey) === 3) {
- $result[$configKey[2]] = $value;
- }
- }
- }
-
- return new Zend_Config($result);
- }
-}
diff --git a/application/forms/ConfigForm.php b/application/forms/ConfigForm.php
new file mode 100644
index 000000000..86790d618
--- /dev/null
+++ b/application/forms/ConfigForm.php
@@ -0,0 +1,68 @@
+config = $config;
+ return $this;
+ }
+
+ /**
+ * Persist the current configuration to disk
+ *
+ * If an error occurs the user is shown a view describing the issue and displaying the raw INI configuration.
+ *
+ * @return bool Whether the configuration could be persisted
+ */
+ public function save()
+ {
+ $writer = new PreservingIniWriter(
+ array(
+ 'config' => $this->config,
+ 'filename' => $this->config->getConfigFile()
+ )
+ );
+
+ try {
+ $writer->write();
+ } catch (Exception $e) {
+ $this->addDecorator('ViewScript', array(
+ 'viewModule' => 'default',
+ 'viewScript' => 'showConfiguration.phtml',
+ 'errorMessage' => $e->getMessage(),
+ 'configString' => $writer->render(),
+ 'filePath' => $this->config->getConfigFile()
+ ));
+ return false;
+ }
+
+ return true;
+ }
+}
diff --git a/application/forms/ConfirmRemovalForm.php b/application/forms/ConfirmRemovalForm.php
new file mode 100644
index 000000000..86a2eb02a
--- /dev/null
+++ b/application/forms/ConfirmRemovalForm.php
@@ -0,0 +1,22 @@
+setName('form_confirm_removal');
+ $this->setSubmitLabel(t('Confirm Removal'));
+ }
+}
diff --git a/application/forms/Dashboard/AddUrlForm.php b/application/forms/Dashboard/AddUrlForm.php
index 09759a265..88195654d 100644
--- a/application/forms/Dashboard/AddUrlForm.php
+++ b/application/forms/Dashboard/AddUrlForm.php
@@ -5,12 +5,8 @@
namespace Icinga\Form\Dashboard;
use Icinga\Application\Config as IcingaConfig;
-use Icinga\Web\Form;
use Icinga\Web\Widget\Dashboard;
-use Zend_Form_Element_Text;
-use Zend_Form_Element_Submit;
-use Zend_Form_Element_Hidden;
-use Zend_Form_Element_Select;
+use Icinga\Web\Form;
/**
* Form to add an url a dashboard pane
@@ -18,124 +14,103 @@ use Zend_Form_Element_Select;
class AddUrlForm extends Form
{
/**
- * Add a selection box for different panes to the form
- *
- * @param Dashboard $dashboard The dashboard to retrieve the panes from
+ * Initialize this form
*/
- private function addPaneSelectionBox(Dashboard $dashboard)
+ public function init()
{
- $selectPane = new Zend_Form_Element_Select(
- 'pane',
- array(
- 'label' => 'Dashboard',
- 'required' => true,
- 'style' => 'display:inline-block;',
-
- 'multiOptions' => $dashboard->getPaneKeyTitleArray()
- )
- );
-
- $newDashboardBtn = new Zend_Form_Element_Submit(
- 'create_new_pane',
- array(
- 'label' => 'Create A New Pane',
- 'required' => false,
- 'class' => 'btn btn-default',
- 'style' => 'display:inline-block'
- )
- );
-
- $newDashboardBtn->removeDecorator('DtDdWrapper');
- $selectPane->removeDecorator('DtDdWrapper');
- $selectPane->removeDecorator('htmlTag');
-
- $this->addElement($selectPane);
- $this->addElement($newDashboardBtn);
- $this->enableAutoSubmit(array('create_new_pane'));
+ $this->setName('form_dashboard_addurl');
+ $this->setSubmitLabel(t('Add To Dashboard'));
}
/**
- * Add a textfield for creating a new pane to this form
+ * @see Form::createElements()
*/
- private function addNewPaneTextField($showExistingButton = true)
+ public function createElements(array $formData)
{
- $txtCreatePane = new Zend_Form_Element_Text(
- 'pane',
- array(
- 'label' => 'New Dashboard Title',
- 'required' => true,
- 'style' => 'display:inline-block'
- )
- );
-
- // Marks this field as a new pane (and prevents the checkbox being displayed when validation errors occur)
- $markAsNewPane = new Zend_Form_Element_Hidden(
- 'create_new_pane',
- array(
- 'required' => true,
- 'value' => 1
- )
- );
-
- $cancelDashboardBtn = new Zend_Form_Element_Submit(
- 'use_existing_dashboard',
- array(
- 'class' => 'btn',
- 'escape' => false,
- 'label' => 'Use An Existing Dashboard',
- 'required' => false
- )
- );
-
-
- $cancelDashboardBtn->removeDecorator('DtDdWrapper');
- $txtCreatePane->removeDecorator('DtDdWrapper');
- $txtCreatePane->removeDecorator('htmlTag');
-
- $this->addElement($txtCreatePane);
- if ($showExistingButton) {
- $this->addElement($cancelDashboardBtn);
- }
- $this->addElement($markAsNewPane);
- }
-
- /**
- * Add elements to this form (used by extending classes)
- */
- protected function create()
- {
- $dashboard = new Dashboard();
- $this->setName('form_dashboard_add');
- $dashboard->readConfig(IcingaConfig::app('dashboard/dashboard'));
$this->addElement(
'text',
'url',
array(
- 'label' => 'Url',
- 'required' => true,
- 'value' => htmlspecialchars_decode($this->getRequest()->getParam('url', ''))
+ 'required' => true,
+ 'label' => t('Url'),
+ 'helptext' => t('The url being loaded in the dashlet')
)
);
- $elems = $dashboard->getPaneKeyTitleArray();
- if (empty($elems) || // show textfield instead of combobox when no pane is available
- ($this->getRequest()->getPost('create_new_pane', '0') && // or when a new pane should be created (+ button)
- !$this->getRequest()->getPost('use_existing_dashboard', '0')) // and the user didn't click the 'use
- // existing' button
+ $paneSelectionValues = $this->getDashboardPaneSelectionValues();
+ if (empty($paneSelectionValues) ||
+ ((isset($formData['create_new_pane']) && $formData['create_new_pane'] != false) &&
+ (false === isset($formData['use_existing_dashboard']) || $formData['use_existing_dashboard'] != true))
) {
- $this->addNewPaneTextField(!empty($elems));
+ $this->addElement(
+ 'text',
+ 'pane',
+ array(
+ 'required' => true,
+ 'label' => t("The New Pane's Title"),
+ 'style' => 'display: inline-block'
+ )
+ );
+ $this->addElement( // Prevent the button from being displayed again on validation errors
+ 'hidden',
+ 'create_new_pane',
+ array(
+ 'value' => 1
+ )
+ );
+ if (false === empty($paneSelectionValues)) {
+ $this->addElement(
+ 'submit',
+ 'use_existing_dashboard',
+ array(
+ 'ignore' => true,
+ 'label' => t('Use An Existing Pane'),
+ 'style' => 'display: inline-block'
+ )
+ );
+ }
} else {
- $this->addPaneSelectionBox($dashboard);
+ $this->addElement(
+ 'select',
+ 'pane',
+ array(
+ 'required' => true,
+ 'label' => t('Pane'),
+ 'style' => 'display: inline-block;',
+ 'multiOptions' => $paneSelectionValues
+ )
+ );
+ $this->addElement(
+ 'submit',
+ 'create_new_pane',
+ array(
+ 'ignore' => true,
+ 'label' => t('Create A New Pane'),
+ 'style' => 'display: inline-block'
+ )
+ );
}
$this->addElement(
'text',
'component',
array(
- 'label' => 'Title',
- 'required' => true,
+ 'required' => true,
+ 'label' => t('Title'),
+ 'helptext' => t('The title for the dashlet')
)
);
- $this->setSubmitLabel("Add To Dashboard");
+ }
+
+ /**
+ * Return the names and titles of the available dashboard panes as key-value array
+ *
+ * @return array
+ */
+ protected function getDashboardPaneSelectionValues()
+ {
+ $dashboard = new Dashboard();
+ $dashboard->readConfig(IcingaConfig::app('dashboard/dashboard'));
+ return $dashboard->getPaneKeyTitleArray();
}
}
diff --git a/application/forms/Install/LoggingPage.php b/application/forms/Install/LoggingPage.php
deleted file mode 100644
index e41faa43e..000000000
--- a/application/forms/Install/LoggingPage.php
+++ /dev/null
@@ -1,65 +0,0 @@
-setName('logging');
- }
-
- /**
- * Create and return the logging form
- *
- * @return LoggingForm
- */
- protected function createForm()
- {
- if ($this->loggingForm === null) {
- $this->loggingForm = new LoggingForm();
- $this->loggingForm->hideButtons();
- $this->loggingForm->setTokenDisabled();
- $this->loggingForm->setRequest($this->getRequest());
- $this->loggingForm->setConfiguration($this->getConfiguration());
- }
-
- return $this->loggingForm;
- }
-
- /**
- * Create this wizard page
- */
- protected function create()
- {
- $loggingForm = $this->createForm();
- $loggingForm->buildForm(); // Needs to get called manually as it's nothing that Zend knows about
- $this->addSubForm($loggingForm, $loggingForm->getName());
- }
-
- /**
- * Return a config containing all values provided by the user
- *
- * @return Zend_Config
- */
- public function getConfig()
- {
- return $this->createForm()->getConfig();
- }
-}
diff --git a/application/forms/Preference/GeneralForm.php b/application/forms/Preference/GeneralForm.php
deleted file mode 100644
index c78206c5a..000000000
--- a/application/forms/Preference/GeneralForm.php
+++ /dev/null
@@ -1,163 +0,0 @@
-getUserPreferences();
- $useDefaultLanguage = $this->getRequest()->getParam('default_language', !$prefs->has('app.language'));
-
- $this->addElement(
- 'checkbox',
- 'default_language',
- array(
- 'label' => t('Use Default Language'),
- 'value' => $useDefaultLanguage,
- 'required' => true
- )
- );
- $selectOptions = array(
- 'label' => t('Your Current Language'),
- 'required' => !$useDefaultLanguage,
- 'multiOptions' => $languages,
- 'helptext' => t('Use the following language to display texts and messages'),
- 'value' => $prefs->get('app.language', $cfg->get('language', Translator::DEFAULT_LOCALE))
- );
- if ($useDefaultLanguage) {
- $selectOptions['disabled'] = 'disabled';
- }
- $this->addElement('select', 'language', $selectOptions);
- $this->enableAutoSubmit(array('default_language'));
- }
-
- /**
- * Add a select field for setting the user's timezone.
- *
- * Possible values are determined by DateTimeZone::listIdentifiers
- * Also, a 'use default format' checkbox is added in order to allow a user to discard his overwritten setting
- *
- * @param Zend_Config $cfg The "global" section of the config.ini to be used as default value
- */
- private function addTimezoneSelection(Zend_Config $cfg)
- {
- $prefs = $this->getUserPreferences();
- $useGlobalTimezone = $this->getRequest()->getParam('default_timezone', !$prefs->has('app.timezone'));
- $detect = new TimezoneDetect();
-
- $tzList = array();
- foreach (DateTimeZone::listIdentifiers() as $tz) {
- $tzList[$tz] = $tz;
- }
-
- $helptext = 'Use the following timezone for dates and times';
-
- if ($useGlobalTimezone && $detect->success() === true) {
- $helptext .= '
- icon('create.png'); ?> Create A New LDAP Authentication Backend
-
- icon('create.png'); ?> Create A New DB Authentication Backend
-
| Resource | -Remove | -Order | - - - backends as $backend): ?> -
|---|---|---|
| - - icon('edit.png') ?> escape($backend->name); ?> - - | -- - icon('remove.png', 'Remove') ?> - - | -- reorderForm; ?> - | -
- Create a new backend for authenticating your users. This backend will be added at the end of your authentication order. + translate( + 'Create a new backend for authenticating your users. This backend will be added at the end of your authentication order.' + ); ?>
- -form ?> \ No newline at end of file + \ No newline at end of file diff --git a/application/views/scripts/config/authentication/modify.phtml b/application/views/scripts/config/authentication/modify.phtml index ca2cef6f9..b01d7095a 100644 --- a/application/views/scripts/config/authentication/modify.phtml +++ b/application/views/scripts/config/authentication/modify.phtml @@ -1,18 +1,5 @@ -icon('create.png'); ?> Create A New Resource
- -| Resource | -Remove | - - +
|---|
| translate('Resource'); ?> | +translate('Remove'); ?> | + + resources as $name => $resource): ?> -
|---|---|
| icon('edit.png') ?> escape($name); ?> | -icon('remove.png'); ?> | -
| + + icon('edit.png'); ?> escape($name); ?> + + | ++ + icon('remove.png'); ?> + + | +
- Resources are entities that provide data to Icingaweb. -
- -form ?> \ No newline at end of file +translate('Resources are entities that provide data to Icinga Web 2.'); ?>
+ \ No newline at end of file diff --git a/application/views/scripts/config/resource/modify.phtml b/application/views/scripts/config/resource/modify.phtml index 5a0871aed..d355aeb4c 100644 --- a/application/views/scripts/config/resource/modify.phtml +++ b/application/views/scripts/config/resource/modify.phtml @@ -1,18 +1,5 @@ -
- Your escape($this->file); ?> configuration couldn't be stored (error: "exceptionMessage; ?>").
- This could have one or more of the following reasons:
-
- Details can be seen in your application log (if you don't have access to this file, call your administrator in this case).
-
- In case you can access the configuration file (config/escape($this->file); ?>.ini) by yourself, you can open it and
- insert the config manually:
-
-
-
-escape($this->iniConfigurationString); ?>
-
-
-
\ No newline at end of file
diff --git a/application/views/scripts/error/error.phtml b/application/views/scripts/error/error.phtml
index e3a71f829..2a900651b 100644
--- a/application/views/scripts/error/error.phtml
+++ b/application/views/scripts/error/error.phtml
@@ -11,7 +11,4 @@
escape($stackTrace) ?>-messageBox)) : ?> - messageBox->render(); ?> -
+ translate('The file %s couldn\'t be stored. (Error: "%s")'),
+ $this->escape($filePath),
+ $this->escape($errorMessage)
+ ); ?>
+
+ translate('This could have one or more of the following reasons:'); ?>
+
+ translate('Details can be found in the application log. (If you don\'t have access to this log, call your administrator in this case)'); ?>
+
+ translate('In case you can access the file by yourself, you can open it and insert the config manually:'); ?>
+
+
+ escape($configString); ?>
+
+
\ No newline at end of file
diff --git a/config/authentication.ini.in b/config/authentication.ini.in
index 71d9e4402..2a2d2a969 100644
--- a/config/authentication.ini.in
+++ b/config/authentication.ini.in
@@ -18,6 +18,10 @@ backend = ldap
resource = internal_ldap
user_class = @ldap_user_objectclass@
user_name_attribute = @ldap_attribute_username@
+group_base_dn = @ldap_group_base_dn@
+group_attribute = @ldap_group_attribute@
+group_member_attribute = @ldap_group_member_attribute@
+group_class = @ldap_group_class@
[internal_db_authentication]
@internal_auth_disabled@
diff --git a/icingaweb2.spec b/icingaweb2.spec
index 5d5b9ec9c..db0929f7b 100644
--- a/icingaweb2.spec
+++ b/icingaweb2.spec
@@ -26,12 +26,12 @@
%define revision 1
-%define configdir %{_sysconfdir}/icingaweb
-%define sharedir %{_datadir}/icingaweb
-%define prefixdir %{_datadir}/icingaweb
-%define logdir %{sharedir}/log
+%define configdir %{_sysconfdir}/%{name}
+%define sharedir %{_datadir}/%{name}
+%define prefixdir %{_datadir}/%{name}
%define usermodparam -a -G
-%define logdir %{_localstatedir}/log/icingaweb
+%define logdir %{_localstatedir}/log/%{name}
+%define docdir %{sharedir}/log
%if "%{_vendor}" == "suse"
%define phpname php5
@@ -172,25 +172,26 @@ install -D -m0644 packages/rpm/etc/httpd/conf.d/icingaweb.conf %{buildroot}/%{ap
# install public, library, modules
%{__mkdir} -p %{buildroot}/%{sharedir}
%{__mkdir} -p %{buildroot}/%{logdir}
-%{__mkdir} -p %{buildroot}/%{_sysconfdir}/icingaweb
+%{__mkdir} -p %{buildroot}/%{docdir}
+%{__mkdir} -p %{buildroot}/%{_sysconfdir}/%{name}
%{__mkdir} -p %{buildroot}/%{_sysconfdir}/dashboard
-%{__mkdir} -p %{buildroot}/%{_sysconfdir}/icingaweb/modules
-%{__mkdir} -p %{buildroot}/%{_sysconfdir}/icingaweb/modules/monitoring
-%{__mkdir} -p %{buildroot}/%{_sysconfdir}/icingaweb/enabledModules
+%{__mkdir} -p %{buildroot}/%{_sysconfdir}/%{name}/modules
+%{__mkdir} -p %{buildroot}/%{_sysconfdir}/%{name}/modules/monitoring
+%{__mkdir} -p %{buildroot}/%{_sysconfdir}/%{name}/enabledModules
-%{__cp} -r application library modules public %{buildroot}/%{sharedir}/
+%{__cp} -r application doc library modules public %{buildroot}/%{sharedir}/
## config
# authentication is db only
-install -D -m0644 packages/rpm/etc/icingaweb/authentication.ini %{buildroot}/%{_sysconfdir}/icingaweb/authentication.ini
+install -D -m0644 packages/rpm/etc/%{name}/authentication.ini %{buildroot}/%{_sysconfdir}/%{name}/authentication.ini
# custom resource paths
-install -D -m0644 packages/rpm/etc/icingaweb/resources.ini %{buildroot}/%{_sysconfdir}/icingaweb/resources.ini
+install -D -m0644 packages/rpm/etc/%{name}/resources.ini %{buildroot}/%{_sysconfdir}/%{name}/resources.ini
# monitoring module (icinga2)
-install -D -m0644 packages/rpm/etc/icingaweb/modules/monitoring/backends.ini %{buildroot}/%{_sysconfdir}/icingaweb/modules/monitoring/backends.ini
-install -D -m0644 packages/rpm/etc/icingaweb/modules/monitoring/instances.ini %{buildroot}/%{_sysconfdir}/icingaweb/modules/monitoring/instances.ini
+install -D -m0644 packages/rpm/etc/%{name}/modules/monitoring/backends.ini %{buildroot}/%{_sysconfdir}/%{name}/modules/monitoring/backends.ini
+install -D -m0644 packages/rpm/etc/%{name}/modules/monitoring/instances.ini %{buildroot}/%{_sysconfdir}/%{name}/modules/monitoring/instances.ini
# enable the monitoring module by default
-ln -s %{sharedir}/modules/monitoring %{buildroot}/%{_sysconfdir}/icingaweb/enabledModules/monitoring
+ln -s %{sharedir}/modules/monitoring %{buildroot}/%{_sysconfdir}/%{name}/enabledModules/monitoring
## config
# install icingacli
@@ -228,6 +229,8 @@ fi
%config(noreplace) %attr(-,%{apacheuser},%{apachegroup}) %{configdir}
# logs
%attr(2775,%{apacheuser},%{apachegroup}) %dir %{logdir}
+# shipped docs
+%attr(755,%{apacheuser},%{apachegroup}) %{sharedir}/doc
%files -n php-Icinga
%attr(755,%{apacheuser},%{apachegroup}) %{sharedir}/application
diff --git a/library/Icinga/Application/ApplicationBootstrap.php b/library/Icinga/Application/ApplicationBootstrap.php
index 7736f8cf9..958642940 100644
--- a/library/Icinga/Application/ApplicationBootstrap.php
+++ b/library/Icinga/Application/ApplicationBootstrap.php
@@ -4,10 +4,10 @@
namespace Icinga\Application;
+use ErrorException;
use Exception;
use Zend_Config;
use Icinga\Application\Modules\Manager as ModuleManager;
-use Icinga\Application\Config;
use Icinga\Data\ResourceFactory;
use Icinga\Exception\ConfigurationError;
use Icinga\Exception\NotReadableError;
@@ -348,11 +348,7 @@ abstract class ApplicationBootstrap
Logger::create(
new Zend_Config(
array(
- 'enable' => true,
- 'level' => Logger::$ERROR,
- 'type' => 'syslog',
- 'facility' => 'LOG_USER',
- 'application' => 'icingaweb'
+ 'log' => 'syslog'
)
)
);
@@ -383,9 +379,20 @@ abstract class ApplicationBootstrap
*/
protected function setupErrorHandling()
{
- error_reporting(E_ALL | E_NOTICE);
+ error_reporting(E_ALL | E_STRICT);
ini_set('display_startup_errors', 1);
ini_set('display_errors', 1);
+ set_error_handler(function ($errno, $errstr, $errfile, $errline) {
+ if (error_reporting() === 0) {
+ // Error was suppressed with the @-operator
+ return false; // Continue with the normal error handler
+ }
+ switch($errno) {
+ case E_STRICT:
+ throw new ErrorException($errstr, 0, $errno, $errfile, $errline);
+ }
+ return false; // Continue with the normal error handler
+ });
return $this;
}
diff --git a/library/Icinga/Application/Cli.php b/library/Icinga/Application/Cli.php
index 58daf5f2f..d329ce439 100644
--- a/library/Icinga/Application/Cli.php
+++ b/library/Icinga/Application/Cli.php
@@ -51,10 +51,9 @@ class Cli extends ApplicationBootstrap
Logger::create(
new Zend_Config(
array(
- 'enable' => true,
- 'level' => Logger::$INFO,
- 'type' => 'file',
- 'target' => 'php://stderr'
+ 'level' => Logger::INFO,
+ 'log' => 'file',
+ 'file' => 'php://stderr'
)
)
);
diff --git a/library/Icinga/Application/Config.php b/library/Icinga/Application/Config.php
index f30684883..c7998a0bb 100644
--- a/library/Icinga/Application/Config.php
+++ b/library/Icinga/Application/Config.php
@@ -7,7 +7,6 @@ namespace Icinga\Application;
use Zend_Config;
use Zend_Config_Ini;
use Icinga\Exception\NotReadableError;
-use Icinga\Exception\ProgrammingError;
/**
* Global registry of application and module configuration.
@@ -22,11 +21,11 @@ class Config extends Zend_Config
public static $configDir;
/**
- * The INI file this configuration has been loaded from
+ * The INI file this configuration has been loaded from or should be written to
*
* @var string
*/
- private $configFile;
+ protected $configFile;
/**
* Application config instances per file
@@ -42,30 +41,28 @@ class Config extends Zend_Config
*/
protected static $modules = array();
- private $instance;
-
/**
- * Load configuration from the config file $filename
+ * Load configuration from the given INI file
+ *
+ * @param string $file The file to parse
*
- * @param string $filename The filename to parse
-
* @throws NotReadableError When the file does not exist or cannot be read
*/
- public function __construct($filename)
+ public static function fromIni($file)
{
- parent::__construct(array(), true);
- $filepath = realpath($filename);
+ $config = new static(array(), true);
+ $filepath = realpath($file);
+
if ($filepath === false) {
- $this->configFile = $filename;
+ $config->setConfigFile($file);
} elseif (is_readable($filepath)) {
- $this->configFile = $filepath;
- $this->merge(new Zend_Config_Ini($filepath));
+ $config->setConfigFile($filepath);
+ $config->merge(new Zend_Config_Ini($filepath));
} else {
- throw new NotReadableError(
- 'Cannot read config file "%s". Permission denied',
- $filename
- );
+ throw new NotReadableError('Cannot read config file "%s". Permission denied', $filepath);
}
+
+ return $config;
}
/**
@@ -80,7 +77,7 @@ class Config extends Zend_Config
public static function app($configname = 'config', $fromDisk = false)
{
if (!isset(self::$app[$configname]) || $fromDisk) {
- self::$app[$configname] = new Config(self::resolvePath($configname . '.ini'));
+ self::$app[$configname] = Config::fromIni(self::resolvePath($configname . '.ini'));
}
return self::$app[$configname];
}
@@ -113,7 +110,7 @@ class Config extends Zend_Config
}
$moduleConfigs = self::$modules[$modulename];
if (!isset($moduleConfigs[$configname]) || $fromDisk) {
- $moduleConfigs[$configname] = new Config(
+ $moduleConfigs[$configname] = Config::fromIni(
self::resolvePath('modules/' . $modulename . '/' . $configname . '.ini')
);
}
@@ -138,15 +135,28 @@ class Config extends Zend_Config
}
/**
- * Return the application wide config file
+ * Return this config's file path
*
- * @return string
+ * @return string
*/
public function getConfigFile()
{
return $this->configFile;
}
+ /**
+ * Set this config's file path
+ *
+ * @param string $filepath The path to the config file
+ *
+ * @return self
+ */
+ public function setConfigFile($filepath)
+ {
+ $this->configFile = $filepath;
+ return $this;
+ }
+
/**
* Prepend configuration base dir if input is relative
*
diff --git a/library/Icinga/Application/Modules/Module.php b/library/Icinga/Application/Modules/Module.php
index 6d66412e6..b1b051a6c 100644
--- a/library/Icinga/Application/Modules/Module.php
+++ b/library/Icinga/Application/Modules/Module.php
@@ -918,10 +918,21 @@ class Module
* Translate a string with the global mt()
*
* @param $string
+ * @param null $context
+ *
* @return mixed|string
*/
- protected function translate($string)
+ protected function translate($string, $context = null)
{
- return mt($this->name, $string);
+ return mt($this->name, $string, $context);
+ }
+
+ /**
+ * (non-PHPDoc)
+ * @see Translator::translatePlural() For the function documentation.
+ */
+ protected function translatePlural($textSingular, $textPlural, $number, $context = null)
+ {
+ return mtp($this->name, $textSingular, $textPlural, $number, $context);
}
}
diff --git a/library/Icinga/Application/Web.php b/library/Icinga/Application/Web.php
index 6a15d392a..89cad22ab 100644
--- a/library/Icinga/Application/Web.php
+++ b/library/Icinga/Application/Web.php
@@ -278,7 +278,8 @@ class Web extends ApplicationBootstrap
if ($this->user !== null && $this->user->getPreferences() !== null) {
$detect = new TimezoneDetect();
- $userTimezone = $this->user->getPreferences()->get('app.timezone', $detect->getTimezoneName());
+ $userTimezone = $this->user->getPreferences()
+ ->getValue('icingaweb', 'timezone', $detect->getTimezoneName());
}
try {
@@ -302,7 +303,7 @@ class Web extends ApplicationBootstrap
{
parent::setupInternationalization();
if ($this->user !== null && $this->user->getPreferences() !== null
- && (($locale = $this->user->getPreferences()->get('app.language')) !== null)
+ && (($locale = $this->user->getPreferences()->getValue('icingaweb', 'language')) !== null)
) {
try {
Translator::setupLocale($locale);
diff --git a/library/Icinga/Application/functions.php b/library/Icinga/Application/functions.php
index 422dfeab7..304c75093 100644
--- a/library/Icinga/Application/functions.php
+++ b/library/Icinga/Application/functions.php
@@ -5,23 +5,85 @@
use Icinga\Util\Translator;
if (extension_loaded('gettext')) {
- function t($messageId)
+
+ /**
+ * (non-PHPDoc)
+ * @see Translator::translate() For the function documentation.
+ */
+ function t($messageId, $context = null)
{
- return Translator::translate($messageId, Translator::DEFAULT_DOMAIN);
+ return Translator::translate($messageId, Translator::DEFAULT_DOMAIN, $context);
}
- function mt($domain, $messageId)
+ /**
+ * (non-PHPDoc)
+ * @see Translator::translate() For the function documentation.
+ */
+ function mt($domain, $messageId, $context = null)
{
- return Translator::translate($messageId, $domain);
+ return Translator::translate($messageId, $domain, $context);
}
+
+ /**
+ * (non-PHPDoc)
+ * @see Translator::translatePlural() For the function documentation.
+ */
+ function tp($messageId, $messageId2, $number, $context = null)
+ {
+ return Translator::translatePlural($messageId, $messageId2, $number, Translator::DEFAULT_DOMAIN, $context);
+ }
+
+ /**
+ * (non-PHPDoc)
+ * @see Translator::translatePlural() For the function documentation.
+ */
+ function mtp($domain, $messageId, $messageId2, $number, $context = null)
+ {
+ return Translator::translatePlural($messageId, $messageId2, $number, $domain, $context);
+ }
+
} else {
- function t($messageId)
+
+ /**
+ * (non-PHPDoc)
+ * @see Translator::translate() For the function documentation.
+ */
+ function t($messageId, $context = null)
{
return $messageId;
}
- function mt($domain, $messageId)
+ /**
+ * (non-PHPDoc)
+ * @see Translator::translate() For the function documentation.
+ */
+ function mt($domain, $messageId, $context = null)
{
return $messageId;
}
+
+ /**
+ * (non-PHPDoc)
+ * @see Translator::translatePlural() For the function documentation.
+ */
+ function tp($messageId, $messageId2, $number, $context = null)
+ {
+ if ((int) $number !== 1) {
+ return $messageId2;
+ }
+ return $messageId;
+ }
+
+ /**
+ * (non-PHPDoc)
+ * @see Translator::translatePlural() For the function documentation.
+ */
+ function mtp($domain, $messageId, $messageId2, $number, $context = null)
+ {
+ if ((int) $number !== 1) {
+ return $messageId2;
+ }
+ return $messageId;
+ }
+
}
diff --git a/library/Icinga/Authentication/AdmissionLoader.php b/library/Icinga/Authentication/AdmissionLoader.php
index f961fb87c..098afda81 100644
--- a/library/Icinga/Authentication/AdmissionLoader.php
+++ b/library/Icinga/Authentication/AdmissionLoader.php
@@ -52,12 +52,8 @@ class AdmissionLoader
return $permissions;
}
foreach ($config as $section) {
- if ($this->match($section, $username, $groups)) {
- foreach ($section as $key => $value) {
- if (strpos($key, 'permission') === 0) {
- $permissions = array_merge($permissions, String::trimSplit($value));
- }
- }
+ if ($this->match($section, $username, $groups) && isset($section->permissions)) {
+ $permissions += String::trimSplit($section->permissions);
}
}
return $permissions;
@@ -79,12 +75,12 @@ class AdmissionLoader
} catch (NotReadableError $e) {
return $restrictions;
}
- foreach ($config as $section) {
+ foreach ($config as $name => $section) {
if ($this->match($section, $username, $groups)) {
if (!array_key_exists($section->name, $restrictions)) {
$restrictions[$section->name] = array();
}
- $restrictions[$section->name][] = $section->restriction;
+ $restrictions[$section->name][$name] = $section->restriction;
}
}
return $restrictions;
diff --git a/library/Icinga/Authentication/Backend/LdapUserBackend.php b/library/Icinga/Authentication/Backend/LdapUserBackend.php
index 23a79781d..8ef6c89de 100644
--- a/library/Icinga/Authentication/Backend/LdapUserBackend.php
+++ b/library/Icinga/Authentication/Backend/LdapUserBackend.php
@@ -4,6 +4,7 @@
namespace Icinga\Authentication\Backend;
+use Icinga\Logger\Logger;
use Icinga\User;
use Icinga\Authentication\UserBackend;
use Icinga\Protocol\Ldap\Connection;
@@ -23,11 +24,14 @@ class LdapUserBackend extends UserBackend
protected $userNameAttribute;
- public function __construct(Connection $conn, $userClass, $userNameAttribute)
+ protected $groupOptions;
+
+ public function __construct(Connection $conn, $userClass, $userNameAttribute, $groupOptions = null)
{
$this->conn = $conn;
$this->userClass = $userClass;
$this->userNameAttribute = $userNameAttribute;
+ $this->groupOptions = $groupOptions;
}
/**
@@ -83,6 +87,43 @@ class LdapUserBackend extends UserBackend
}
}
+ /**
+ * Retrieve the user groups
+ *
+ * @TODO: Subject to change, see #7343
+ *
+ * @param string $dn
+ *
+ * @return array|null
+ */
+ public function getGroups($dn)
+ {
+ if (empty($this->groupOptions) || ! isset($this->groupOptions['group_base_dn'])) {
+ return null;
+ }
+
+ $q = $this->conn->select()
+ ->setBase($this->groupOptions['group_base_dn'])
+ ->from(
+ $this->groupOptions['group_class'],
+ array($this->groupOptions['group_attribute'])
+ )
+ ->where(
+ $this->groupOptions['group_member_attribute'],
+ $dn
+ );
+
+ $result = $this->conn->fetchAll($q);
+
+ $groups = array();
+
+ foreach ($result as $group) {
+ $groups[] = $group->{$this->groupOptions['group_attribute']};
+ }
+
+ return $groups;
+ }
+
/**
* Test whether the given user exists
*
@@ -127,10 +168,15 @@ class LdapUserBackend extends UserBackend
return false;
}
try {
- return $this->conn->testCredentials(
- $this->conn->fetchDN($this->createQuery($user->getUsername())),
+ $userDn = $this->conn->fetchDN($this->createQuery($user->getUsername()));
+ $authenticated = $this->conn->testCredentials(
+ $userDn,
$password
);
+ if ($authenticated) {
+ $user->setGroups($this->getGroups($userDn));
+ }
+ return $authenticated;
} catch (LdapException $e) {
// Error during authentication of this specific user
throw new AuthenticationException(
@@ -160,4 +206,3 @@ class LdapUserBackend extends UserBackend
);
}
}
-
diff --git a/library/Icinga/Authentication/Manager.php b/library/Icinga/Authentication/Manager.php
index 75cf81481..efe9b5815 100644
--- a/library/Icinga/Authentication/Manager.php
+++ b/library/Icinga/Authentication/Manager.php
@@ -113,30 +113,32 @@ class Manager
}
/**
- * Tries to authenticate the user with the current session
+ * Try to authenticate the user with the current session
+ *
+ * Authentication for externally-authenticated users will be revoked if the username changed or external
+ * authentication is no longer in effect
*/
public function authenticateFromSession()
{
$this->user = Session::getSession()->get('user');
-
if ($this->user !== null && $this->user->isRemoteUser() === true) {
list($originUsername, $field) = $this->user->getRemoteUserInformation();
- if (array_key_exists($field, $_SERVER) && $_SERVER[$field] !== $originUsername) {
+ if (! array_key_exists($field, $_SERVER) || $_SERVER[$field] !== $originUsername) {
$this->removeAuthorization();
}
}
}
/**
- * Returns true when the user is currently authenticated
+ * Whether the user is authenticated
*
- * @param Boolean $ignoreSession Set to true to prevent authentication by session
+ * @param bool $ignoreSession True to prevent session authentication
*
* @return bool
*/
public function isAuthenticated($ignoreSession = false)
{
- if ($this->user === null && !$ignoreSession) {
+ if ($this->user === null && ! $ignoreSession) {
$this->authenticateFromSession();
}
return is_object($this->user);
@@ -145,25 +147,16 @@ class Manager
/**
* Whether an authenticated user has a given permission
*
- * This is true if the user owns this permission, false if not.
- * Also false if there is no authenticated user
- *
- * TODO: I'd like to see wildcard support, e.g. module/*
- *
* @param string $permission Permission name
- * @return bool
+ *
+ * @return bool True if the user owns the given permission, false if not or if not authenticated
*/
public function hasPermission($permission)
{
if (! $this->isAuthenticated()) {
return false;
}
- foreach ($this->user->getPermissions() as $p) {
- if ($p === $permission) {
- return true;
- }
- }
- return false;
+ return $this->user->can($permission);
}
/**
diff --git a/library/Icinga/Authentication/UserBackend.php b/library/Icinga/Authentication/UserBackend.php
index 9e7abd62a..7829210fd 100644
--- a/library/Icinga/Authentication/UserBackend.php
+++ b/library/Icinga/Authentication/UserBackend.php
@@ -93,26 +93,44 @@ abstract class UserBackend implements Countable
$backend = new DbUserBackend($resource);
break;
case 'msldap':
+ $groupOptions = array(
+ 'group_base_dn' => $backendConfig->group_base_dn,
+ 'group_attribute' => $backendConfig->group_attribute,
+ 'group_member_attribute' => $backendConfig->group_member_attribute,
+ 'group_class' => $backendConfig->group_class
+ );
$backend = new LdapUserBackend(
$resource,
$backendConfig->get('user_class', 'user'),
- $backendConfig->get('user_name_attribute', 'sAMAccountName')
+ $backendConfig->get('user_name_attribute', 'sAMAccountName'),
+ $groupOptions
);
break;
case 'ldap':
- if (($userClass = $backendConfig->user_class) === null) {
+ if ($backendConfig->user_class === null) {
throw new ConfigurationError(
'Authentication configuration for backend "%s" is missing the user_class directive',
$name
);
}
- if (($userNameAttribute = $backendConfig->user_name_attribute) === null) {
+ if ($backendConfig->user_name_attribute === null) {
throw new ConfigurationError(
'Authentication configuration for backend "%s" is missing the user_name_attribute directive',
$name
);
}
- $backend = new LdapUserBackend($resource, $userClass, $userNameAttribute);
+ $groupOptions = array(
+ 'group_base_dn' => $backendConfig->group_base_dn,
+ 'group_attribute' => $backendConfig->group_attribute,
+ 'group_member_attribute' => $backendConfig->group_member_attribute,
+ 'group_class' => $backendConfig->group_class
+ );
+ $backend = new LdapUserBackend(
+ $resource,
+ $backendConfig->user_class,
+ $backendConfig->user_name_attribute,
+ $groupOptions
+ );
break;
default:
throw new ConfigurationError(
diff --git a/library/Icinga/Cli/Params.php b/library/Icinga/Cli/Params.php
index 7236dcca2..5c6cbfe8b 100644
--- a/library/Icinga/Cli/Params.php
+++ b/library/Icinga/Cli/Params.php
@@ -108,6 +108,18 @@ class Params
return $this->standalone;
}
+ /**
+ * Support isset() and empty() checks on options
+ *
+ * @param $name
+ *
+ * @return bool
+ */
+ public function __isset($name)
+ {
+ return isset($this->params[$name]);
+ }
+
/**
* @see Params::get()
*/
diff --git a/library/Icinga/Data/Db/DbQuery.php b/library/Icinga/Data/Db/DbQuery.php
index a89544be8..94765d98f 100644
--- a/library/Icinga/Data/Db/DbQuery.php
+++ b/library/Icinga/Data/Db/DbQuery.php
@@ -59,6 +59,13 @@ class DbQuery extends SimpleQuery
*/
protected $count;
+ /**
+ * GROUP BY clauses
+ *
+ * @var string|array
+ */
+ protected $group;
+
protected function init()
{
$this->db = $this->ds->getDbAdapter();
@@ -89,17 +96,21 @@ class DbQuery extends SimpleQuery
public function getSelectQuery()
{
$select = $this->dbSelect();
-
// Add order fields to select for postgres distinct queries (#6351)
if ($this->hasOrder()
&& $this->getDatasource()->getDbType() === 'pgsql'
&& $select->getPart(Zend_Db_Select::DISTINCT) === true) {
foreach ($this->getOrder() as $fieldAndDirection) {
- list($alias, $field) = explode('.', $fieldAndDirection[0]);
- $this->columns[$field] = $fieldAndDirection[0];
+ if (array_search($fieldAndDirection[0], $this->columns) === false) {
+ $this->columns[] = $fieldAndDirection[0];
+ }
}
}
+ if ($this->group) {
+ $select->group($this->group);
+ }
+
$select->columns($this->columns);
$this->applyFilterSql($select);
@@ -117,7 +128,7 @@ class DbQuery extends SimpleQuery
return $select;
}
- protected function applyFilterSql($query)
+ public function applyFilterSql($query)
{
$where = $this->renderFilter($this->filter);
if ($where !== '') {
@@ -223,7 +234,7 @@ class DbQuery extends SimpleQuery
*/
public function isTimestamp($field)
{
- return $this;
+ return false;
}
public function whereToSql($col, $sign, $expression)
@@ -253,6 +264,7 @@ class DbQuery extends SimpleQuery
$this->applyFilterSql($count);
if ($this->useSubqueryCount) {
+ $count->columns($this->columns);
$columns = array('cnt' => 'COUNT(*)');
return $this->db->select()->from($count, $columns);
}
@@ -300,4 +312,17 @@ class DbQuery extends SimpleQuery
{
return (string) $this->getSelectQuery();
}
+
+ /**
+ * Add a GROUP BY clause
+ *
+ * @param string|array $group
+ *
+ * @return $this
+ */
+ public function group($group)
+ {
+ $this->group = $group;
+ return $this;
+ }
}
diff --git a/library/Icinga/Data/Filter/FilterExpression.php b/library/Icinga/Data/Filter/FilterExpression.php
index c29414166..8378b5ae3 100644
--- a/library/Icinga/Data/Filter/FilterExpression.php
+++ b/library/Icinga/Data/Filter/FilterExpression.php
@@ -12,6 +12,8 @@ class FilterExpression extends Filter
public function __construct($column, $sign, $expression)
{
+ $column = trim($column);
+ $expression = is_array($expression) ? array_map('trim', $expression) : trim($expression);
$this->column = $column;
$this->sign = $sign;
$this->expression = $expression;
diff --git a/library/Icinga/Data/ResourceFactory.php b/library/Icinga/Data/ResourceFactory.php
index 30597ad2d..e85413615 100644
--- a/library/Icinga/Data/ResourceFactory.php
+++ b/library/Icinga/Data/ResourceFactory.php
@@ -10,7 +10,6 @@ use Icinga\Util\ConfigAwareFactory;
use Icinga\Exception\ConfigurationError;
use Icinga\Data\Db\DbConnection;
use Icinga\Protocol\Livestatus\Connection as LivestatusConnection;
-use Icinga\Protocol\Statusdat\Reader as StatusdatReader;
use Icinga\Protocol\Ldap\Connection as LdapConnection;
use Icinga\Protocol\File\FileReader;
@@ -102,7 +101,7 @@ class ResourceFactory implements ConfigAwareFactory
*
* @param Zend_Config $config The configuration for the created resource.
*
- * @return DbConnection|LdapConnection|LivestatusConnection|StatusdatReader An objects that can be used to access
+ * @return DbConnection|LdapConnection|LivestatusConnection An object that can be used to access
* the given resource. The returned class depends on the configuration property 'type'.
* @throws ConfigurationError When an unsupported type is given
*/
@@ -115,9 +114,6 @@ class ResourceFactory implements ConfigAwareFactory
case 'ldap':
$resource = new LdapConnection($config);
break;
- case 'statusdat':
- $resource = new StatusdatReader($config);
- break;
case 'livestatus':
$resource = new LivestatusConnection($config->socket);
break;
@@ -137,7 +133,7 @@ class ResourceFactory implements ConfigAwareFactory
* Create a resource from name
*
* @param string $resourceName
- * @return DbConnection|LdapConnection|LivestatusConnection|StatusdatReader
+ * @return DbConnection|LdapConnection|LivestatusConnection
*/
public static function create($resourceName)
{
diff --git a/library/Icinga/Exception/InvalidPropertyException.php b/library/Icinga/Exception/InvalidPropertyException.php
new file mode 100644
index 000000000..f79055f0b
--- /dev/null
+++ b/library/Icinga/Exception/InvalidPropertyException.php
@@ -0,0 +1,10 @@
+ 'DEBUG',
+ Logger::INFO => 'INFO',
+ Logger::WARNING => 'WARNING',
+ Logger::ERROR => 'ERROR'
+ );
+
/**
* This logger's instance
*
- * @var Logger
+ * @var static
*/
protected static $instance;
/**
- * The log writer to use
+ * Log writer
*
* @var \Icinga\Logger\LogWriter
*/
protected $writer;
/**
- * The configured type
- *
- * @string Type (syslog, file)
- */
- protected $type = 'none';
-
- /**
- * The maximum severity to emit
+ * Maximum level to emit
*
* @var int
*/
- protected $verbosity;
-
- /**
- * The supported severities
- */
- public static $ERROR = 0;
- public static $WARNING = 1;
- public static $INFO = 2;
- public static $DEBUG = 3;
+ protected $level;
/**
* Create a new logger object
*
- * @param Zend_Config $config
+ * @param Zend_Config $config
+ *
+ * @throws ConfigurationError If the logging configuration directive 'log' is missing or if the logging level is
+ * not defined
*/
public function __construct(Zend_Config $config)
{
- $this->verbosity = $config->level;
+ if ($config->log === null) {
+ throw new ConfigurationError('Required logging configuration directive \'log\' missing');
+ }
- if ($config->enable) {
+ if (($level = $config->level) !== null) {
+ if (is_numeric($level)) {
+ if (! isset(static::$levels[(int) $level])) {
+ throw new ConfigurationError(
+ 'Can\'t set logging level %d. Logging level is not defined. Use one of %s or one of the'
+ . ' Logger\'s constants.',
+ $level,
+ implode(', ', array_keys(static::$levels))
+ );
+ }
+ $this->level = static::$levels[(int) $level];
+ } else {
+ $level = strtoupper($level);
+ $levels = array_flip(static::$levels);
+ if (! isset($levels[$level])) {
+ throw new ConfigurationError(
+ 'Can\'t set logging level "%s". Logging level is not defined. Use one of %s.',
+ $level,
+ implode(', ', array_keys($levels))
+ );
+ }
+ $this->level = $levels[$level];
+ }
+ } else {
+ $this->level = static::ERROR;
+ }
+
+ if (strtolower($config->get('log', 'syslog')) !== 'none') {
$this->writer = $this->createWriter($config);
}
}
@@ -67,14 +118,17 @@ class Logger
* Create a new logger object
*
* @param Zend_Config $config
+ *
+ * @return static
*/
public static function create(Zend_Config $config)
{
static::$instance = new static($config);
+ return static::$instance;
}
/**
- * Return a log writer
+ * Create a log writer
*
* @param Zend_Config $config The configuration to initialize the writer with
*
@@ -83,28 +137,26 @@ class Logger
*/
protected function createWriter(Zend_Config $config)
{
- $class = 'Icinga\\Logger\\Writer\\' . ucfirst(strtolower($config->type)) . 'Writer';
- if (!class_exists($class)) {
+ $class = 'Icinga\\Logger\\Writer\\' . ucfirst(strtolower($config->log)) . 'Writer';
+ if (! class_exists($class)) {
throw new ConfigurationError(
'Cannot find log writer of type "%s"',
- $config->type
+ $config->log
);
}
- $this->type = $config->type;
-
return new $class($config);
}
/**
- * Write a message to the log
+ * Log a message
*
- * @param string $message The message to write
- * @param int $severity The severity to use
+ * @param int $level The logging level
+ * @param string $message The log message
*/
- public function log($message, $severity)
+ public function log($level, $message)
{
- if ($this->writer !== null && $this->verbosity >= $severity) {
- $this->writer->log($severity, $message);
+ if ($this->writer !== null && $this->level >= $level) {
+ $this->writer->log($level, $message);
}
}
@@ -162,7 +214,7 @@ class Logger
public static function error()
{
if (static::$instance !== null && func_num_args() > 0) {
- static::$instance->log(static::formatMessage(func_get_args()), static::$ERROR);
+ static::$instance->log(static::ERROR, static::formatMessage(func_get_args()));
}
}
@@ -174,7 +226,7 @@ class Logger
public static function warning()
{
if (static::$instance !== null && func_num_args() > 0) {
- static::$instance->log(static::formatMessage(func_get_args()), static::$WARNING);
+ static::$instance->log(static::WARNING, static::formatMessage(func_get_args()));
}
}
@@ -186,7 +238,7 @@ class Logger
public static function info()
{
if (static::$instance !== null && func_num_args() > 0) {
- static::$instance->log(static::formatMessage(func_get_args()), static::$INFO);
+ static::$instance->log(static::INFO, static::formatMessage(func_get_args()));
}
}
@@ -198,7 +250,7 @@ class Logger
public static function debug()
{
if (static::$instance !== null && func_num_args() > 0) {
- static::$instance->log(static::formatMessage(func_get_args()), static::$DEBUG);
+ static::$instance->log(static::DEBUG, static::formatMessage(func_get_args()));
}
}
@@ -212,20 +264,30 @@ class Logger
return $this->writer;
}
+ /**
+ * Is the logger writing to Syslog?
+ *
+ * @return bool
+ */
public static function writesToSyslog()
{
- return static::$instance && static::$instance->type === 'syslog';
+ return static::$instance && static::$instance instanceof SyslogWriter;
}
+ /**
+ * Is the logger writing to a file?
+ *
+ * @return bool
+ */
public static function writesToFile()
{
- return static::$instance && static::$instance->type === 'file';
+ return static::$instance && static::$instance instanceof FileWriter;
}
/**
* Get this' instance
*
- * @return Logger
+ * @return static
*/
public static function getInstance()
{
diff --git a/library/Icinga/Logger/Writer/FileWriter.php b/library/Icinga/Logger/Writer/FileWriter.php
index 4ab04d85b..527358e1c 100644
--- a/library/Icinga/Logger/Writer/FileWriter.php
+++ b/library/Icinga/Logger/Writer/FileWriter.php
@@ -5,38 +5,43 @@
namespace Icinga\Logger\Writer;
use Exception;
-use Icinga\Exception\IcingaException;
use Zend_Config;
-use Icinga\Util\File;
+use Icinga\Exception\ConfigurationError;
use Icinga\Logger\Logger;
use Icinga\Logger\LogWriter;
-use Icinga\Exception\ConfigurationError;
+use Icinga\Util\File;
/**
- * Class to write log messages to a file
+ * Log to a file
*/
class FileWriter extends LogWriter
{
/**
- * The path to the file
+ * Path to the file
*
* @var string
*/
- protected $path;
+ protected $file;
/**
- * Create a new log writer initialized with the given configuration
+ * Create a new file log writer
*
- * @throws ConfigurationError In case the log path does not exist
+ * @param Zend_Config $config
+ *
+ * @throws ConfigurationError If the configuration directive 'file' is missing or if the path to 'file' does
+ * not exist or if writing to 'file' is not possible
*/
public function __construct(Zend_Config $config)
{
- $this->path = $config->target;
+ if ($config->file === null) {
+ throw new ConfigurationError('Required logging configuration directive \'file\' missing');
+ }
+ $this->file = $config->file;
- if (substr($this->path, 0, 6) !== 'php://' && false === file_exists(dirname($this->path))) {
+ if (substr($this->file, 0, 6) !== 'php://' && ! file_exists(dirname($this->file))) {
throw new ConfigurationError(
'Log path "%s" does not exist',
- dirname($this->path)
+ dirname($this->file)
);
}
@@ -45,70 +50,32 @@ class FileWriter extends LogWriter
} catch (Exception $e) {
throw new ConfigurationError(
'Cannot write to log file "%s" (%s)',
- $this->path,
+ $this->file,
$e->getMessage()
);
}
}
/**
- * Log a message with the given severity
+ * Log a message
*
- * @param int $severity The severity to use
- * @param string $message The message to log
+ * @param int $level The logging level
+ * @param string $message The log message
*/
- public function log($severity, $message)
+ public function log($level, $message)
{
- $this->write(date('c') . ' ' . $this->getSeverityString($severity) . ' ' . $message . PHP_EOL);
+ $this->write(date('c') . ' - ' . Logger::$levels[$level] . ' - ' . $message . PHP_EOL);
}
/**
- * Return a string representation for the given severity
+ * Write a message to the log
*
- * @param string $severity The severity to use
- *
- * @return string The string representation of the severity
- *
- * @throws IcingaException In case the given severity is unknown
+ * @param string $message
*/
- protected function getSeverityString($severity)
+ protected function write($message)
{
- switch ($severity) {
- case Logger::$ERROR:
- return '- ERROR -';
- case Logger::$WARNING:
- return '- WARNING -';
- case Logger::$INFO:
- return '- INFO -';
- case Logger::$DEBUG:
- return '- DEBUG -';
- default:
- throw new IcingaException(
- 'Unknown severity "%s"',
- $severity
- );
- }
- }
-
- /**
- * Write a message to the path
- *
- * @param string $text The message to write
- *
- * @throws Exception In case write acess to the path failed
- */
- protected function write($text)
- {
- $file = new File($this->path, 'a');
- $file->fwrite($text);
+ $file = new File($this->file, 'a');
+ $file->fwrite($message);
$file->fflush();
}
-
- /**
- * @return string
- */
- public function getPath()
- {
- return $this->path;
- }
}
diff --git a/library/Icinga/Logger/Writer/SyslogWriter.php b/library/Icinga/Logger/Writer/SyslogWriter.php
index d176e1cbb..f67c618d2 100644
--- a/library/Icinga/Logger/Writer/SyslogWriter.php
+++ b/library/Icinga/Logger/Writer/SyslogWriter.php
@@ -4,27 +4,24 @@
namespace Icinga\Logger\Writer;
-use Exception;
use Zend_Config;
use Icinga\Logger\Logger;
use Icinga\Logger\LogWriter;
-use Icinga\Exception\ConfigurationError;
-use Icinga\Exception\IcingaException;
/**
- * Class to write messages to syslog
+ * Log to the syslog service
*/
class SyslogWriter extends LogWriter
{
/**
- * The facility where to write messages to
+ * Syslog facility
*
- * @var string
+ * @var int
*/
protected $facility;
/**
- * The prefix to prepend to each message
+ * Prefix to prepend to each message
*
* @var string
*/
@@ -35,79 +32,42 @@ class SyslogWriter extends LogWriter
*
* @var array
*/
- protected $facilities = array(
- 'LOG_USER' => LOG_USER
+ public static $facilities = array(
+ 'user' => LOG_USER
);
/**
- * Create a new log writer initialized with the given configuration
+ * Log level to syslog severity map
+ *
+ * @var array
+ */
+ public static $severityMap = array(
+ Logger::ERROR => LOG_ERR,
+ Logger::WARNING => LOG_WARNING,
+ Logger::INFO => LOG_INFO,
+ Logger::DEBUG => LOG_DEBUG
+ );
+
+ /**
+ * Create a new syslog log writer
+ *
+ * @param Zend_Config $config
*/
public function __construct(Zend_Config $config)
{
- if (!array_key_exists($config->facility, $this->facilities)) {
- throw new ConfigurationError(
- 'Cannot create syslog writer with unknown facility "%s"',
- $config->facility
- );
- }
-
- $this->ident = $config->application;
- $this->facility = $this->facilities[$config->facility];
+ $this->ident = $config->get('application', 'icingaweb');
+ $this->facility = static::$facilities['user'];
}
/**
- * Log a message with the given severity
+ * Log a message
*
- * @param int $severity The severity to use
- * @param string $message The message to log
- *
- * @throws Exception In case the given severity cannot be mapped to a valid syslog priority
+ * @param int $level The logging level
+ * @param string $message The log message
*/
- public function log($severity, $message)
+ public function log($level, $message)
{
- $priorities = array(
- Logger::$ERROR => LOG_ERR,
- Logger::$WARNING => LOG_WARNING,
- Logger::$INFO => LOG_INFO,
- Logger::$DEBUG => LOG_DEBUG
- );
-
- if (!array_key_exists($severity, $priorities)) {
- throw new IcingaException(
- 'Severity "%s" cannot be mapped to a valid syslog priority',
- $severity
- );
- }
-
- $this->open();
- $this->write($priorities[$severity], $message);
- $this->close();
- }
-
- /**
- * Open a new syslog connection
- */
- protected function open()
- {
- openlog($this->ident, 0, $this->facility);
- }
-
- /**
- * Write a message to the syslog connection
- *
- * @param int $priority The priority to use
- * @param string $message The message to write
- */
- protected function write($priority, $message)
- {
- syslog($priority, $message);
- }
-
- /**
- * Close the syslog connection
- */
- protected function close()
- {
- closelog();
+ openlog($this->ident, LOG_PID, $this->facility);
+ syslog(static::$severityMap[$level], $message);
}
}
diff --git a/library/Icinga/Protocol/Commandpipe/Command.php b/library/Icinga/Protocol/Commandpipe/Command.php
deleted file mode 100644
index e89169f35..000000000
--- a/library/Icinga/Protocol/Commandpipe/Command.php
+++ /dev/null
@@ -1,177 +0,0 @@
-withoutHosts = (bool) $state;
- return $this;
- }
-
- /**
- * Set whether this command should only affect the hosts of a host- or servicegroup
- *
- * @param bool $state
- * @return self
- */
- public function excludeServices($state = true)
- {
- $this->withoutServices = (bool) $state;
- return $this;
- }
-
- /**
- * Set whether this command should also affect all children hosts of a host
- *
- * @param bool $state
- * @return self
- */
- public function includeChildren($state = true)
- {
- $this->withChildren = (bool) $state;
- return $this;
- }
-
- /**
- * Set whether this command only affects the services associated with a particular host
- *
- * @param bool $state
- * @return self
- */
- public function excludeHost($state = true)
- {
- $this->onlyServices = (bool) $state;
- return $this;
- }
-
- /**
- * Getter for flag whether a command is global
- * @return bool
- */
- public function provideGlobalCommand()
- {
- return (bool) $this->globalCommand;
- }
-
- /**
- * Return this command's arguments in the order expected by the actual command definition
- *
- * @return array
- */
- abstract public function getArguments();
-
- /**
- * Return the command as a string with the given host being inserted
- *
- * @param string $hostname The name of the host to insert
- *
- * @return string The string representation of the command
- */
- abstract public function getHostCommand($hostname);
-
- /**
- * Return the command as a string with the given host and service being inserted
- *
- * @param string $hostname The name of the host to insert
- * @param string $servicename The name of the service to insert
- *
- * @return string The string representation of the command
- */
- abstract public function getServiceCommand($hostname, $servicename);
-
- /**
- * Return the command as a string with the given hostgroup being inserted
- *
- * @param string $hostgroup The name of the hostgroup to insert
- *
- * @return string The string representation of the command
- */
- public function getHostgroupCommand($hostgroup)
- {
- throw new ProgrammingError(
- '%s does not provide a hostgroup command',
- get_class($this)
- );
- }
-
- /**
- * Return the command as a string with the given servicegroup being inserted
- *
- * @param string $servicegroup The name of the servicegroup to insert
- *
- * @return string The string representation of the command
- */
- public function getServicegroupCommand($servicegroup)
- {
- throw new ProgrammingError(
- '%s does not provide a servicegroup command',
- get_class($this)
- );
- }
-
- /**
- * Return the command as a string for the whole instance
- *
- * @param string $instance
- *
- * @return string
- * @throws ProgrammingError
- */
- public function getGlobalCommand($instance = null)
- {
- throw new ProgrammingError(
- '%s does not provide a global command',
- getclass($this)
- );
- }
-}
diff --git a/library/Icinga/Protocol/Commandpipe/CommandPipe.php b/library/Icinga/Protocol/Commandpipe/CommandPipe.php
deleted file mode 100644
index 8d149dd20..000000000
--- a/library/Icinga/Protocol/Commandpipe/CommandPipe.php
+++ /dev/null
@@ -1,603 +0,0 @@
-getTransportForConfiguration($config);
- $this->name = $config->name;
- }
-
- /**
- * Setup the @see Icinga\Protocol\Commandpipe\Transport.php class that will be used for accessing the command pipe
- *
- * Currently this method uses SecureShell when a host is given, otherwise it assumes the pipe is accessible
- * via the machines filesystem
- *
- * @param \Zend_Config $config The configuration as defined in the instances.ini
- */
- private function getTransportForConfiguration(\Zend_Config $config)
- {
- if (isset($config->host)) {
- $this->transport = new SecureShell();
- $this->transport->setEndpoint($config);
- } else {
- $this->transport = new LocalPipe();
- $this->transport->setEndpoint($config);
- }
- }
-
- /**
- * Send the command string $command to the icinga pipe
- *
- * This method just delegates the send command to the underlying transport
- *
- * @param String $command The command string to send, without the timestamp
- */
- public function send($command)
- {
- $this->transport->send($this->escape($command));
- }
-
- /**
- * Return the given command string with escaped newlines
- *
- * @param string $command The command string to escape
- *
- * @return string The escaped command string
- */
- public function escape($command)
- {
- return str_replace(array("\r", "\n"), array('\r', '\n'), $command);
- }
-
- /**
- * Send a command to the icinga pipe
- *
- * @param Command $command
- * @param array $objects
- */
- public function sendCommand(Command $command, array $objects = array())
- {
- if ($command->provideGlobalCommand() === true) {
- $this->send($command->getGlobalCommand());
- } else {
- foreach ($objects as $object) {
- $objectType = $this->getObjectType($object);
- if ($objectType === self::TYPE_SERVICE) {
- $this->send($command->getServiceCommand($object->host_name, $object->service_description));
- } else {
- $this->send($command->getHostCommand($object->host_name));
- }
- }
- }
- }
-
- /**
- * Remove the acknowledgements of the provided objects
- *
- * @param array $objects An array of mixed service and host objects whose acknowledgments will be removed
- */
- public function removeAcknowledge($objects)
- {
- foreach ($objects as $object) {
- if (isset($object->service_description)) {
- $this->send("REMOVE_SVC_ACKNOWLEDGEMENT;$object->host_name;$object->service_description");
- } else {
- $this->send("REMOVE_HOST_ACKNOWLEDGEMENT;$object->host_name");
- }
- }
- }
-
- /**
- * Removes the submitted comments
- *
- * @param array $objectsOrComments An array of hosts and services (to remove all their comments)
- * or single comment objects to remove
- */
- public function removeComment($objectsOrComments)
- {
- foreach ($objectsOrComments as $object) {
- if (isset($object->comment_id)) {
- if (isset($object->service_description)) {
- $type = "SERVICE_COMMENT";
- } else {
- $type = "HOST_COMMENT";
- }
- $this->send("DEL_{$type};" . intval($object->comment_id));
- } else {
- if (isset($object->service_description)) {
- $type = "SERVICE_COMMENT";
- } else {
- $type = "HOST_COMMENT";
- }
- $cmd = "DEL_ALL_{$type}S;" . $object->host_name;
- if ($type == "SERVICE_COMMENT") {
- $cmd .= ";" . $object->service_description;
- }
- $this->send($cmd);
- }
- }
- }
-
- /**
- * Globally enable notifications for this instance
- *
- */
- public function enableGlobalNotifications()
- {
- $this->send("ENABLE_NOTIFICATIONS");
- }
-
- /**
- * Globally disable notifications for this instance
- *
- */
- public function disableGlobalNotifications()
- {
- $this->send("DISABLE_NOTIFICATIONS");
- }
-
- /**
- * Return the object type of the provided object (TYPE_SERVICE or TYPE_HOST)
- *
- * @param $object The object to identify
- * @return string TYPE_SERVICE or TYPE_HOST
- */
- private function getObjectType($object)
- {
- //@TODO: This must be refactored once more commands are supported
- if (isset($object->service_description)) {
- return self::TYPE_SERVICE;
- }
- return self::TYPE_HOST;
- }
-
- /**
- * Remove downtimes for objects
- *
- * @param array $objects An array containing hosts, service or downtime objects
- * @param int $starttime An optional starttime to use for the DEL_DOWNTIME_BY_HOST_NAME command
- */
- public function removeDowntime($objects, $starttime = 0)
- {
- foreach ($objects as $object) {
- $type = $this->getObjectType($object);
- if (isset($object->downtime_id)) {
- $this->send("DEL_" . $type . "_DOWNTIME;" . $object->downtime_id);
- continue;
- }
- $cmd = "DEL_DOWNTIME_BY_HOST_NAME;" . $object->host_name;
- if ($type == self::TYPE_SERVICE) {
- $cmd .= ";" . $object->service_description;
- }
- if ($starttime != 0) {
- $cmd .= ";" . $starttime;
- }
- $this->send($cmd);
- }
- }
-
- /**
- * Restart the icinga instance
- *
- */
- public function restartIcinga()
- {
- $this->send("RESTART_PROCESS");
- }
-
- /**
- * Modify monitoring flags for the provided objects
- *
- * @param array $objects An arry of service and/or host objects to modify
- * @param PropertyModifier $flags The Monitoring attributes to modify
- */
- public function setMonitoringProperties($objects, PropertyModifier $flags)
- {
- foreach ($objects as $object) {
- $type = $this->getObjectType($object);
- $formatArray = $flags->getFormatString($type);
- foreach ($formatArray as $format) {
- $format .= ";"
- . $object->host_name
- . ($type == self::TYPE_SERVICE ? ";" . $object->service_description : "");
- $this->send($format);
- }
- }
- }
-
- /**
- * Enable active checks for all provided objects
- *
- * @param array $objects An array containing services and hosts to enable active checks for
- */
- public function enableActiveChecks($objects)
- {
- $this->setMonitoringProperties(
- $objects,
- new PropertyModifier(
- array(
- PropertyModifier::ACTIVE => PropertyModifier::STATE_ENABLE
- )
- )
- );
- }
-
- /**
- * Disable active checks for all provided objects
- *
- * @param array $objects An array containing services and hosts to disable active checks
- */
- public function disableActiveChecks($objects)
- {
- $this->setMonitoringProperties(
- $objects,
- new PropertyModifier(
- array(
- PropertyModifier::ACTIVE => PropertyModifier::STATE_DISABLE
- )
- )
- );
- }
-
- /**
- * Enable passive checks for all provided objects
- *
- * @param array $objects An array containing services and hosts to enable passive checks for
- */
- public function enablePassiveChecks($objects)
- {
- $this->setMonitoringProperties(
- $objects,
- new PropertyModifier(
- array(
- PropertyModifier::PASSIVE => PropertyModifier::STATE_ENABLE
- )
- )
- );
- }
-
- /**
- * Enable passive checks for all provided objects
- *
- * @param array $objects An array containing services and hosts to enable passive checks for
- */
- public function disablePassiveChecks($objects)
- {
- $this->setMonitoringProperties(
- $objects,
- new PropertyModifier(
- array(
- PropertyModifier::PASSIVE => PropertyModifier::STATE_DISABLE
- )
- )
- );
- }
-
- /**
- * Enable flap detection for all provided objects
- *
- * @param array $objects An array containing services and hosts to enable flap detection
- *
- */
- public function enableFlappingDetection($objects)
- {
- $this->setMonitoringProperties(
- $objects,
- new PropertyModifier(
- array(
- PropertyModifier::FLAPPING => PropertyModifier::STATE_ENABLE
- )
- )
- );
- }
-
- /**
- * Disable flap detection for all provided objects
- *
- * @param array $objects An array containing services and hosts to disable flap detection
- *
- */
- public function disableFlappingDetection($objects)
- {
- $this->setMonitoringProperties(
- $objects,
- new PropertyModifier(
- array(
- PropertyModifier::FLAPPING => PropertyModifier::STATE_DISABLE
- )
- )
- );
- }
-
- /**
- * Enable notifications for all provided objects
- *
- * @param array $objects An array containing services and hosts to enable notification
- *
- */
- public function enableNotifications($objects)
- {
- $this->setMonitoringProperties(
- $objects,
- new PropertyModifier(
- array(
- PropertyModifier::NOTIFICATIONS => PropertyModifier::STATE_ENABLE
- )
- )
- );
- }
-
- /**
- * Disable flap detection for all provided objects
- *
- * @param array $objects An array containing services and hosts to disable notifications
- *
- */
- public function disableNotifications($objects)
- {
- $this->setMonitoringProperties(
- $objects,
- new PropertyModifier(
- array(
- PropertyModifier::NOTIFICATIONS => PropertyModifier::STATE_DISABLE
- )
- )
- );
- }
-
- /**
- * Enable freshness checks for all provided objects
- *
- * @param array $objects An array of hosts and/or services
- */
- public function enableFreshnessChecks($objects)
- {
- $this->setMonitoringProperties(
- $objects,
- new PropertyModifier(
- array(
- PropertyModifier::FRESHNESS => PropertyModifier::STATE_ENABLE
- )
- )
- );
- }
-
- /**
- * Disable freshness checks for all provided objects
- *
- * @param array $objects An array of hosts and/or services
- */
- public function disableFreshnessChecks($objects)
- {
- $this->setMonitoringProperties(
- $objects,
- new PropertyModifier(
- array(
- PropertyModifier::FRESHNESS => PropertyModifier::STATE_DISABLE
- )
- )
- );
- }
-
- /**
- * Enable event handler for all provided objects
- *
- * @param array $objects An array of hosts and/or services
- */
- public function enableEventHandler($objects)
- {
- $this->setMonitoringProperties(
- $objects,
- new PropertyModifier(
- array(
- PropertyModifier::EVENTHANDLER => PropertyModifier::STATE_ENABLE
- )
- )
- );
- }
-
- /**
- * Disable event handler for all provided objects
- *
- * @param array $objects An array of hosts and/or services
- */
- public function disableEventHandler($objects)
- {
- $this->setMonitoringProperties(
- $objects,
- new PropertyModifier(
- array(
- PropertyModifier::EVENTHANDLER => PropertyModifier::STATE_DISABLE
- )
- )
- );
- }
-
- /**
- * Enable performance data parsing for all provided objects
- *
- * @param array $objects An array of hosts and/or services
- */
- public function enablePerfdata($objects)
- {
- $this->setMonitoringProperties(
- $objects,
- new PropertyModifier(
- array(
- PropertyModifier::PERFDATA => PropertyModifier::STATE_ENABLE
- )
- )
- );
- }
-
- /**
- * Disable performance data parsing for all provided objects
- *
- * @param array $objects An array of hosts and/or services
- */
- public function disablePerfdata($objects)
- {
- $this->setMonitoringProperties(
- $objects,
- new PropertyModifier(
- array(
- PropertyModifier::PERFDATA => PropertyModifier::STATE_DISABLE
- )
- )
- );
- }
-
- /**
- * Disable notifications for all services of the provided hosts
- *
- * @param array $objects An array of hosts
- */
- public function disableNotificationsForServices($objects)
- {
- foreach ($objects as $host) {
- $msg = 'DISABLE_HOST_SVC_NOTIFICATIONS;'.$host->host_name;
- $this->send($msg);
- }
- }
-
- /**
- * Enable notifications for all services of the provided hosts
- *
- * @param array $objects An array of hosts
- */
- public function enableNotificationsForServices($objects)
- {
- foreach ($objects as $host) {
- $msg = 'ENABLE_HOST_SVC_NOTIFICATIONS;'.$host->host_name;
- $this->send($msg);
- }
- }
-
- /**
- * Disable active checks for all services of the provided hosts
- *
- * @param array $objects An array of hosts
- */
- public function disableActiveChecksWithChildren($objects)
- {
- foreach ($objects as $host) {
- $msg = 'DISABLE_HOST_SVC_CHECKS;'.$host->host_name;
- $this->send($msg);
- }
- }
-
- /**
- * Enable active checks for all services of the provided hosts
- *
- * @param array $objects An array of hosts
- */
- public function enableActiveChecksWithChildren($objects)
- {
- foreach ($objects as $host) {
- $msg = 'ENABLE_HOST_SVC_CHECKS;'.$host->host_name;
- $this->send($msg);
- }
- }
-
- /**
- * Reset modified attributes for all provided objects
- *
- * @param array $objects An array of hosts and services
- */
- public function resetAttributes($objects)
- {
- foreach ($objects as $object) {
- $type = $this->getObjectType($object);
- if ($type === self::TYPE_SERVICE) {
- $this->send('CHANGE_SVC_MODATTR;'.$object->host_name.';'.$object->service_description.';0');
- } else {
- $this->send('CHANGE_HOST_MODATTR;'.$object->host_name.';0');
- }
- }
- }
-
- /**
- * Return the transport handler that handles actual sending of commands
- *
- * @return Transport
- */
- public function getTransport()
- {
- return $this->transport;
- }
-}
diff --git a/library/Icinga/Protocol/Commandpipe/Comment.php b/library/Icinga/Protocol/Commandpipe/Comment.php
deleted file mode 100644
index 2b8caf52b..000000000
--- a/library/Icinga/Protocol/Commandpipe/Comment.php
+++ /dev/null
@@ -1,61 +0,0 @@
-author = $author;
- $this->content = $content;
- $this->persistent = $persistent;
- }
-
- /**
- * Return this comment's properties as list of command parameters
- *
- * @param bool $ignorePersistentFlag Whether the persistent flag should be included or not
- * @return array
- */
- public function getArguments($ignorePersistentFlag = false)
- {
- if ($ignorePersistentFlag) {
- return array($this->author, $this->content);
- } else {
- return array($this->persistent ? '1' : '0', $this->author, $this->content);
- }
- }
-}
diff --git a/library/Icinga/Protocol/Commandpipe/Exception/InvalidCommandException.php b/library/Icinga/Protocol/Commandpipe/Exception/InvalidCommandException.php
deleted file mode 100644
index 662a156e9..000000000
--- a/library/Icinga/Protocol/Commandpipe/Exception/InvalidCommandException.php
+++ /dev/null
@@ -1,12 +0,0 @@
- self::STATE_KEEP,
- self::ACTIVE => self::STATE_KEEP,
- self::PASSIVE => self::STATE_KEEP,
- self::NOTIFICATIONS => self::STATE_KEEP,
- self::FRESHNESS => self::STATE_KEEP,
- self::EVENTHANDLER => self::STATE_KEEP
- );
-
- /**
- * Create a new PropertyModified object using the given flags
- *
- * @param array $flags Flags to enable/disable/keep different monitoring attributes
- */
- public function __construct(array $flags)
- {
- foreach ($flags as $type => $value) {
- if (isset($this->flags[$type])) {
- $this->flags[$type] = $value;
- }
- }
- }
-
- /**
- * Return this object as a template for the given object type
- *
- * @param $type Either CommandPipe::TYPE_HOST or CommandPipe::TYPE_SERVICE
- * @return array An array of external command templates for the given type representing the containers state
- */
- public function getFormatString($type)
- {
- $cmd = array();
- foreach ($this->flags as $cmdTemplate => $setting) {
- if ($setting == self::STATE_KEEP) {
- continue;
- }
- $commandString = ($setting == self::STATE_ENABLE ? "ENABLE_" : "DISABLE_");
- $targetString = $type;
- if ($type == CommandPipe::TYPE_SERVICE && $cmdTemplate == self::FRESHNESS) {
- // the external command definition is inconsistent here..
- $targetString = "SERVICE";
- }
- $commandString .= sprintf($cmdTemplate, $targetString);
- $cmd[] = $commandString;
- }
- return $cmd;
- }
-}
diff --git a/library/Icinga/Protocol/Commandpipe/Transport/LocalPipe.php b/library/Icinga/Protocol/Commandpipe/Transport/LocalPipe.php
deleted file mode 100644
index 32f745565..000000000
--- a/library/Icinga/Protocol/Commandpipe/Transport/LocalPipe.php
+++ /dev/null
@@ -1,70 +0,0 @@
-path = isset($config->path) ? $config->path : '/usr/local/icinga/var/rw/icinga.cmd';
- }
-
- /**
- * @see Transport::send()
- */
- public function send($message)
- {
- Logger::debug('Attempting to send external icinga command %s to local command file ', $message, $this->path);
-
- try {
- $file = new File($this->path, $this->openMode);
- $file->fwrite('[' . time() . '] ' . $message . PHP_EOL);
- $file->fflush();
- } catch (Exception $e) {
- throw new ConfigurationError(
- 'Could not open icinga command pipe at "%s" (%s)',
- $this->path,
- $e->getMessage()
- );
- }
-
- Logger::debug('Command sent: [' . time() . '] ' . $message . PHP_EOL);
- }
-
- /**
- * Overwrite the open mode (useful for testing)
- *
- * @param string $mode The mode to use to access the pipe
- */
- public function setOpenMode($mode)
- {
- $this->openMode = $mode;
- }
-}
diff --git a/library/Icinga/Protocol/Commandpipe/Transport/SecureShell.php b/library/Icinga/Protocol/Commandpipe/Transport/SecureShell.php
deleted file mode 100644
index f1505c2ef..000000000
--- a/library/Icinga/Protocol/Commandpipe/Transport/SecureShell.php
+++ /dev/null
@@ -1,102 +0,0 @@
-host = isset($config->host) ? $config->host : 'localhost';
- $this->port = isset($config->port) ? $config->port : 22;
- $this->user = isset($config->user) ? $config->user : null;
- $this->path = isset($config->path) ? $config->path : '/usr/local/icinga/var/rw/icinga.cmd';
- }
-
- /**
- * Write the given external command to the command pipe
- *
- * @param string $command
- *
- * @throws RuntimeException When the command could not be sent to the remote Icinga host
- * @see Transport::send()
- */
- public function send($command)
- {
- $retCode = 0;
- $output = array();
- Logger::debug(
- 'Icinga instance is on different host, attempting to send command %s via ssh to %s:%s/%s',
- $command,
- $this->host,
- $this->port,
- $this->path
- );
- $hostConnector = $this->user ? $this->user . "@" . $this->host : $this->host;
- $command = escapeshellarg('['. time() .'] ' . $command);
- $sshCommand = sprintf(
- 'ssh -o BatchMode=yes -o KbdInteractiveAuthentication=no %s -p %d'
- . ' "echo %s > %s" 2>&1',
- $hostConnector,
- $this->port,
- $command,
- $this->path
- );
-
- exec($sshCommand, $output, $retCode);
- Logger::debug("Command '%s' exited with %d: %s", $sshCommand, $retCode, $output);
-
- if ($retCode != 0) {
- $msg = 'Could not send command to remote Icinga host: '
- . implode(PHP_EOL, $output)
- . " (returncode $retCode)";
- Logger::error($msg);
- throw new RuntimeException($msg);
- }
- }
-}
diff --git a/library/Icinga/Protocol/Commandpipe/Transport/Transport.php b/library/Icinga/Protocol/Commandpipe/Transport/Transport.php
deleted file mode 100644
index 59119cf13..000000000
--- a/library/Icinga/Protocol/Commandpipe/Transport/Transport.php
+++ /dev/null
@@ -1,27 +0,0 @@
-filename, $this->fields)
- );
+ return new FileIterator($this->filename, $this->fields);
}
/**
diff --git a/library/Icinga/Protocol/Statusdat/Exception/ParsingException.php b/library/Icinga/Protocol/Statusdat/Exception/ParsingException.php
deleted file mode 100644
index 0947e65bc..000000000
--- a/library/Icinga/Protocol/Statusdat/Exception/ParsingException.php
+++ /dev/null
@@ -1,13 +0,0 @@
-ref = & $obj;
- $this->reader = & $reader;
- }
-
- /**
- * @param $attribute
- * @return \stdClass
- */
- public function __get($attribute)
- {
- $exploded = explode(".", $attribute);
- $result = $this->ref;
-
- foreach ($exploded as $elem) {
- if (isset($result->$elem)) {
- $result = $result->$elem;
- } else {
- return null;
- }
- }
- return $result;
- }
-}
diff --git a/library/Icinga/Protocol/Statusdat/Parser.php b/library/Icinga/Protocol/Statusdat/Parser.php
deleted file mode 100644
index 5b3694518..000000000
--- a/library/Icinga/Protocol/Statusdat/Parser.php
+++ /dev/null
@@ -1,422 +0,0 @@
-file = $file;
- $this->icingaState = $baseState;
- }
-
- /**
- * Parse the given file handle as an objects file and read object information
- */
- public function parseObjectsFile()
- {
- $DEFINE = strlen('define ');
- $this->icingaState = array();
- foreach ($this->file as $line) {
- $line = trim($line);
- $this->lineCtr++;
- if ($line === '' || $line[0] === '#') {
- continue;
- }
- $this->currentObjectType = trim(substr($line, $DEFINE, -1));
- if (!isset($this->icingaState[$this->currentObjectType])) {
- $this->icingaState[$this->currentObjectType] = array();
- }
- $this->readCurrentObject();
- }
- $this->processDeferred();
- }
-
- /**
- * Parse the given file as an status.dat file and read runtime information
- *
- * @param File $file The file to parse or null to parse the one passed to the constructor
- */
- public function parseRuntimeState(File $file = null)
- {
- if ($file != null) {
- $this->file = $file;
- } else {
- $file = $this->file;
- }
-
- if (!$this->icingaState) {
- throw new ProgrammingError('Tried to read runtime state without existing objects data');
- }
- $this->overwrites = array();
- foreach ($file as $line) {
- $line = trim($line);
- $this->lineCtr++;
- if ($line === '' || $line[0] === '#') {
- continue;
- }
- $this->currentStateType = trim(substr($line, 0, -1));
- $this->readCurrentState();
- }
- }
-
- /**
- * Read the next object from the object.cache file handle
- *
- * @throws ParsingException
- */
- private function readCurrentObject()
- {
- $monitoringObject = new PrintableObject();
- foreach ($this->file as $line) {
- $line = explode("\t", trim($line), 2);
- $this->lineCtr++;
- if (!$line) {
- continue;
- }
-
- // End of object
- if ($line[0] === '}') {
- $this->registerObject($monitoringObject);
- return;
- }
- if (!isset($line[1])) {
- $line[1] = '';
- }
- $monitoringObject->{$line[0]} = trim($line[1]);
- }
- throw new ParsingException('Unexpected EOF in objects.cache, line ' . $this->lineCtr);
- }
-
- /**
- * Read the next state from the status.dat file handler
- *
- * @throws Exception\ParsingException
- */
- private function readCurrentState()
- {
- $statusdatObject = new RuntimeStateContainer();
-
- $objectType = $this->getObjectTypeForState();
-
- if ($objectType != 'host' && $objectType != 'service') {
- $this->skipObject(); // ignore unknown objects
- return;
- }
- if (!isset($this->icingaState[$this->currentObjectType])) {
- throw new ParsingException("No $this->currentObjectType objects registered in objects.cache");
- }
- $base = & $this->icingaState[$this->currentObjectType];
- $state = $this->skipObject(true);
- $statusdatObject->runtimeState = & $state;
- $name = $this->getObjectIdentifier($statusdatObject);
-
- if (!isset($base[$name])) {
- throw new ParsingException(
- "Unknown object $name " . $this->currentObjectType . ' - '
- . print_r(
- $statusdatObject,
- true
- )
- . "\n" . print_r($base, true)
- );
- }
- $type = substr($this->currentStateType, strlen($objectType));
-
- if ($type == 'status') {
- // directly set the status to the status field of the given object
- $base[$name]->status = & $statusdatObject;
- } else {
- if (!isset($base[$name]->$type) || !in_array($base[$name]->$type, $this->overwrites)) {
- $base[$name]->$type = array();
- $this->overwrites[] = & $base[$name]->$type;
- }
- array_push($base[$name]->$type, $statusdatObject);
- $this->currentObjectType = $type;
- if (!isset($this->icingaState[$type])) {
- $this->icingaState[$type] = array();
- }
- $this->icingaState[$type][] = &$statusdatObject;
- $id = $this->getObjectIdentifier($statusdatObject);
- if ($id !== false && isset($this->icingaState[$objectType][$id])) {
- $statusdatObject->$objectType = $this->icingaState[$objectType][$id];
- }
- }
-
- return;
-
- }
-
- /**
- * Get the corresponding object type name for the given state
- *
- * @return string
- */
- private function getObjectTypeForState()
- {
- $pos = strpos($this->currentStateType, 'service');
-
- if ($pos === false) {
- $pos = strpos($this->currentStateType, 'host');
- } else {
- $this->currentObjectType = 'service';
- return 'service';
- }
-
- if ($pos === false) {
- return $this->currentStateType;
- } else {
- $this->currentObjectType = 'host';
- return 'host';
- }
-
- return $this->currentObjectType;
- }
-
- /**
- * Skip the current object definition
- *
- * @param bool $returnString If true, the object string will be returned
- * @return string The skipped object if $returnString is true
- */
- protected function skipObject($returnString = false)
- {
- if (!$returnString) {
- while (trim($this->file->fgets()) !== '}') {
- }
- return null;
- } else {
- $str = '';
- while (($val = trim($this->file->fgets())) !== '}') {
- $str .= $val . "\n";
- }
- return $str;
- }
- }
-
- /**
- * Register the given object in the icinga state
- *
- * @param object $object The monitoring object to register
- */
- protected function registerObject(&$object)
- {
-
- $name = $this->getObjectIdentifier($object);
- if ($name !== false) {
- $this->icingaState[$this->currentObjectType][$name] = &$object;
- }
- $this->registerObjectAsProperty($object);
- }
-
- /**
- * Register the given object as a property in related objects
- *
- * This registers for example hosts underneath their hostgroup and vice cersa
- *
- * @param object $object The object to register as a property
- */
- protected function registerObjectAsProperty(&$object)
- {
- if ($this->currentObjectType == 'service'
- || $this->currentObjectType == 'host'
- || $this->currentObjectType == 'contact') {
- return null;
- }
- $isService = strpos($this->currentObjectType, 'service') !== false;
- $isHost = strpos($this->currentObjectType, 'host') !== false;
- $isContact = strpos($this->currentObjectType, 'contact') !== false;
- $name = $this->getObjectIdentifier($object);
-
- if ($isService === false && $isHost === false && $isContact === false) {
- // this would be error in the parser implementation
- return null;
- }
- $property = $this->currentObjectType;
- if ($isService) {
- $this->currentObjectType = 'service';
- $property = substr($property, strlen('service'));
- } elseif ($isHost) {
- $this->currentObjectType = 'host';
- $property = substr($property, strlen('host'));
- } elseif ($isContact) {
- $this->currentObjectType = 'contact';
- $property = substr($property, strlen('contact'));
- }
-
- if (!isset($this->icingaState[$this->currentObjectType])) {
- return $this->deferRegistration($object, $this->currentObjectType . $property);
- }
-
- // @TODO: Clean up, this differates between 1:n and 1:1 references
- if (strpos($property, 'group') !== false) {
- $sourceIdentifier = $this->getMembers($object);
- foreach ($sourceIdentifier as $id) {
- $source = $this->icingaState[$this->currentObjectType][$id];
- if (!isset($source->$property)) {
- $source->$property = array();
- }
- $type = $this->currentObjectType;
- if (!isset($object->$type)) {
- $object->$type = array();
- }
- // add the member to the group object
- array_push($object->$type, $source);
- // add the group to the member object
- array_push($source->$property, $name);
- }
- } else {
- $source = $this->icingaState[$this->currentObjectType][$this->getObjectIdentifier($object)];
- if (!isset($source->$property)) {
- $source->$property = array();
- }
-
- array_push($source->$property, $object);
- }
-
- return null;
- }
-
- /**
- * Defer registration of the given object
- *
- * @param object $object The object to defer
- * @param String $objType The name of the object type
- */
- protected function deferRegistration($object, $objType)
- {
- $this->deferred[] = array($object, $objType);
- }
-
- /**
- * Process deferred objects
- */
- protected function processDeferred()
- {
- foreach ($this->deferred as $obj) {
- $this->currentObjectType = $obj[1];
- $this->registerObjectAsProperty($obj[0]);
- }
- }
-
- /**
- * Return the resolved members directive of an object
- *
- * @param object $object The object to get the members from
- * @return array An array of member names
- */
- protected function getMembers(&$object)
- {
- if (!isset($object->members)) {
- return array();
- }
-
- $members = explode(',', $object->members);
-
- if ($this->currentObjectType == 'service') {
- $res = array();
- for ($i = 0; $i < count($members); $i += 2) {
- $res[] = $members[$i] . ';' . $members[$i + 1];
- }
- return $res;
- } else {
- return $members;
- }
-
- }
-
- /**
- * Return the unique name of the given object
- *
- * @param object $object The object to retrieve the name from
- * @return string The name of the object or null if no name can be retrieved
- */
- protected function getObjectIdentifier(&$object)
- {
- if ($this->currentObjectType == 'contact') {
- return $object->contact_name;
- }
-
- if ($this->currentObjectType == 'service') {
- return $object->host_name . ';' . $object->service_description;
- }
- $name = $this->currentObjectType . '_name';
- if (isset($object->{$name})) {
- return $object->{$name};
- }
- if (isset($object->service_description)) {
- return $object->host_name . ';' . $object->service_description;
- } elseif (isset($object->host_name)) {
- return $object->host_name;
- }
- return null;
-
- }
-
- /**
- * Return the internal state of the parser
- *
- * @return null
- */
- public function getRuntimeState()
- {
- return $this->icingaState;
- }
-}
diff --git a/library/Icinga/Protocol/Statusdat/PrintableObject.php b/library/Icinga/Protocol/Statusdat/PrintableObject.php
deleted file mode 100644
index 840a7aa2a..000000000
--- a/library/Icinga/Protocol/Statusdat/PrintableObject.php
+++ /dev/null
@@ -1,20 +0,0 @@
-contact_name)) {
- return $this->contact_name;
- } elseif (isset($this->service_description)) {
- return $this->service_description;
- } elseif (isset($this->host_name)) {
- return $this->host_name;
- }
- return '';
- }
-}
diff --git a/library/Icinga/Protocol/Statusdat/Query.php b/library/Icinga/Protocol/Statusdat/Query.php
deleted file mode 100644
index f3b5ea85e..000000000
--- a/library/Icinga/Protocol/Statusdat/Query.php
+++ /dev/null
@@ -1,460 +0,0 @@
- array('host'),
- 'services' => array('service'),
- 'downtimes' => array('downtime'),
- 'groups' => array('hostgroup', 'servicegroup'),
- 'hostgroups' => array('hostgroup'),
- 'servicegroups' => array('servicegroup'),
- 'comments' => array('comment'),
- 'contacts' => array('contact'),
- 'contactgroups' => array('contactgroup')
- );
-
- /**
- * The current StatusDat query that will be applied upon calling fetchAll
- *
- * @var IQueryPart
- */
- private $queryFilter = null;
-
- /**
- * The current query source being used
- *
- * @var string
- */
- private $source = '';
-
- /**
- * An array containing all columns used for sorting
- *
- * @var array
- */
- protected $orderColumns = array();
-
- /**
- * An array containig all columns used for (simple) grouping
- *
- * @var array
- */
- private $groupColumns = array();
-
- /**
- * An optional function callback to use for more specific grouping
- *
- * @var array
- */
- private $groupByFn = null;
-
- /**
- * The scope index for the callback function
- */
- const FN_SCOPE = 0;
-
- /**
- * The name index for the callback function
- */
- const FN_NAME = 1;
-
- /**
- * Return true if columns are set for this query
- *
- * @return bool
- */
- public function hasColumns()
- {
- $columns = $this->getColumns();
- return !empty($columns);
- }
-
- /**
- * Set the status.dat specific IQueryPart filter to use
- *
- * @param IQueryPart $filter
- */
- public function setQueryFilter($filter)
- {
- $this->queryFilter = $filter;
- }
-
- /**
- * Order the query result by the given columns
- *
- * @param String|array $columns An array of columns to order by
- * @param String $dir The direction (asc or desc) in string form
- *
- * @return $this Fluent interface
- */
- public function order($columns, $dir = null, $isFunction = false)
- {
- if ($dir && strtolower($dir) == 'desc') {
- $dir = self::SORT_DESC;
- } else {
- $dir = self::SORT_ASC;
- }
- if (!is_array($columns)) {
- $columns = array($columns);
- }
-
- foreach ($columns as $col) {
- if (($pos = strpos($col, ' ')) !== false) {
- $dir = strtoupper(substr($col, $pos + 1));
- if ($dir === 'DESC') {
- $dir = self::SORT_DESC;
- } else {
- $dir = self::SORT_ASC;
- }
- $col = substr($col, 0, $pos);
- } else {
- $col = $col;
- }
-
- $this->orderColumns[] = array($col, $dir);
- }
- return $this;
- }
-
- /**
- * Order the query result using the callback to retrieve values for items
- *
- * @param array $columns A scope, function array to use for retrieving the values when ordering
- * @param String $dir The direction (asc or desc) in string form
- *
- * @return $this Fluent interface
- */
- public function orderByFn(array $callBack, $dir = null)
- {
- if ($dir && strtolower($dir) == 'desc') {
- $dir = self::SORT_DESC;
- } else {
- $dir = self::SORT_ASC;
- }
- $this->orderColumns[] = array($callBack, $dir);
- }
-
-
-
- /**
- * Set the query target
- *
- * @param String $table The table/target to select the query from
- * @param array $columns An array of attributes to use (required for fetchPairs())
- *
- * @return $this Fluent interface
- * @throws IcingaException If the target is unknonw
- */
- public function from($table, array $attributes = null)
- {
- if (!$this->getColumns() && $attributes) {
- $this->setColumns($attributes);
- }
- if (isset(self::$VALID_TARGETS[$table])) {
- $this->source = $table;
- } else {
- throw new IcingaException(
- 'Unknown from target for status.dat :%s',
- $table
- );
- }
- return $this;
- }
-
- /**
- * Return an index of all objects matching the filter of this query
- *
- * This index will be used for ordering, grouping and limiting
- */
- private function getFilteredIndices($classType = '\Icinga\Protocol\Statusdat\Query\Group')
- {
- $baseGroup = $this->queryFilter;
- $state = $this->ds->getState();
- $result = array();
- $source = self::$VALID_TARGETS[$this->source];
-
- foreach ($source as $target) {
-
- if (! isset($state[$target])) {
- continue;
- }
-
- $indexes = array_keys($state[$target]);
- if ($baseGroup) {
- $baseGroup->setQuery($this);
- $idx = array_keys($state[$target]);
- $indexes = $baseGroup->filter($state[$target], $idx);
- }
- if (!isset($result[$target])) {
- $result[$target] = $indexes;
- } else {
- array_merge($result[$target], $indexes);
- }
- }
- return $result;
- }
-
- /**
- * Order the given result set
- *
- * @param array $indices The result set of the query that should be ordered
- */
- private function orderIndices(array &$indices)
- {
- if (!empty($this->orderColumns)) {
- foreach ($indices as $type => &$subindices) {
- $this->currentType = $type;
- usort($subindices, array($this, 'orderResult'));
- }
- }
- }
-
- /**
- * Start a query
- *
- * This is just a dummy function to allow a more convenient syntax
- *
- * @return self Fluent interface
- */
- public function select()
- {
- return $this;
- }
-
- /**
- * Order implementation called by usort
- *
- * @param String $a The left object index
- * @param Strinv $b The right object index
- * @return int 0, 1 or -1, see usort for detail
- */
- private function orderResult($a, $b)
- {
- $o1 = $this->ds->getObjectByName($this->currentType, $a);
- $o2 = $this->ds->getObjectByName($this->currentType, $b);
- $result = 0;
-
- foreach ($this->orderColumns as &$col) {
- if (is_array($col[0])) {
- // sort by function
- $result += $col[1] * strnatcasecmp(
- $col[0][0]->$col[0][1]($o1),
- $col[0][0]->$col[0][1]($o2)
- );
- } else {
- $result += $col[1] * strnatcasecmp($o1->{$col[0]}, $o2->{$col[0]});
- }
- }
- return $result;
- }
-
- /**
- * Limit the given resultset
- *
- * @param array $indices The filtered, ordered indices
- */
- private function limitIndices(array &$indices)
- {
- foreach ($indices as $type => $subindices) {
- $indices[$type] = array_slice($subindices, $this->getOffset(), $this->getLimit());
- }
- }
-
- /**
- * Register the given function for grouping the result
- *
- * @param String $fn The function to use for grouping
- * @param Object $scope An optional scope to use instead of $this
- *
- * @return self Fluent interface
- */
- public function groupByFunction($fn, $scope = null)
- {
- $this->groupByFn = array($scope ? $scope : $this, $fn);
- return $this;
- }
-
- /**
- * Group by the given column
- *
- * @param array|string $columns The columns to use for grouping
- * @return self Fluent interface
- * @see Query::columnGroupFn() The implementation used for grouping
- */
- public function groupByColumns($columns)
- {
- if (!is_array($columns)) {
- $columns = array($columns);
- }
- $this->groupColumns = $columns;
- $this->groupByFn = array($this, 'columnGroupFn');
- return $this;
- }
-
- /**
- * The internal handler function used by the group function
- *
- * @param array $indices The indices to group
- * @return array The grouped result set
- */
- private function columnGroupFn(array &$indices)
- {
- $cols = $this->groupColumns;
- $result = array();
- foreach ($indices as $type => $subindices) {
- foreach ($subindices as $objectIndex) {
- $r = $this->ds->getObjectByName($type, $objectIndex);
- $hash = '';
- $cols = array();
- foreach ($this->groupColumns as $col) {
- $hash = md5($hash . $r->$col);
- $cols[$col] = $r->$col;
- }
- if (!isset($result[$hash])) {
- $result[$hash] = (object)array(
- 'columns' => (object)$cols,
- 'count' => 0
- );
- }
- $result[$hash]->count++;
- }
- }
- return array_values($result);
- }
-
- /**
- * Query Filter, Order, Group, Limit and return the result set
- *
- * @return array The resultset matching this query
- */
- public function getResult()
- {
- $indices = $this->getFilteredIndices();
- $this->orderIndices($indices);
- if ($this->groupByFn) {
- $scope = $this->groupByFn[self::FN_SCOPE];
- $fn = $this->groupByFn[self::FN_NAME];
-
- return $scope->$fn($indices);
- }
-
- $this->limitIndices($indices);
-
- $result = array();
- $state = $this->ds->getState();
-
- foreach ($indices as $type => $subindices) {
- foreach ($subindices as $index) {
- $result[] = & $state[$type][$index];
- }
- }
- return $result;
- }
-
-
- /**
- * Apply all filters of this filterable on the datasource
- */
- public function applyFilter()
- {
- $parser = new TreeToStatusdatQueryParser();
- if ($this->getFilter()) {
- $query = $parser->treeToQuery($this->getFilter(), $this);
- $this->setQueryFilter($query);
- }
-
- }
-
- /**
- * Return only the first row fetched from the result set
- *
- * @return MonitoringObjectList The monitoring object matching this query
- */
- public function fetchRow()
- {
- $rs = $this->fetchAll();
- $rs->rewind();
- return $rs->current();
- }
-
- /**
- * Fetch the result as an associative array using the first column as the key and the second as the value
- *
- * @return array An associative array with the result
- * @throws IcingaException If no attributes are defined
- */
- public function fetchPairs()
- {
- $result = array();
- if (count($this->getColumns()) < 2) {
- throw new IcingaException(
- 'Status.dat "fetchPairs()" query expects at least columns to be set in the query expression'
- );
- }
- $attributes = $this->getColumns();
-
- $param1 = $attributes[0];
- $param2 = $attributes[1];
- foreach ($this->fetchAll() as $resultList) {
- $result[$resultList->$param1] = $resultList->$param2;
- }
-
- return $result;
- }
-
- /**
- * Fetch all results
- *
- * @return MonitoringObjectList An MonitoringObjectList wrapping the given resultset
- */
- public function fetchAll()
- {
- $this->applyFilter();
- if (!isset($this->cursor)) {
- $result = $this->getResult();
- $this->cursor = new MonitoringObjectList($result, $this);
- }
- return $this->cursor;
- }
-
- /**
- * Return the value of the first column for the first row fetched from the result set
- */
- public function fetchOne()
- {
- throw new ProgrammingError('Statusdat/Query::fetchOne() is not implemented yet');
- }
-
- /**
- * Count the number of results
- *
- * @return int
- */
- public function count()
- {
- $q = clone $this;
- $q->limit(null, null);
- return count($q->fetchAll());
- }
-}
diff --git a/library/Icinga/Protocol/Statusdat/Query/Expression.php b/library/Icinga/Protocol/Statusdat/Query/Expression.php
deleted file mode 100644
index 1db48df33..000000000
--- a/library/Icinga/Protocol/Statusdat/Query/Expression.php
+++ /dev/null
@@ -1,415 +0,0 @@
-":
- $this->CB = "isGreater";
- break;
- case "<":
- $this->CB = "isLess";
- break;
- case ">=":
- $this->CB = "isGreaterEq";
- break;
- case "<=":
- $this->CB = "isLessEq";
- break;
- case "=":
- $this->CB = "isEqual";
- break;
- case "LIKE":
- $this->CB = "isLike";
- break;
- case "NOT_LIKE":
- $this->CB = "isNotLike";
- break;
- case "!=":
- $this->CB = "isNotEqual";
- break;
- case "IN":
- $this->CB = "isIn";
- break;
- case "NOT_IN":
- $this->CB = "isNotIn";
- break;
- default:
- throw new IcingaException(
- 'Unknown operator %s in expression %s !',
- $token,
- $this->expression
- );
- }
- }
-
- /**
- * @param $tokens
- * @return mixed
- */
- private function extractAggregationFunction(&$tokens)
- {
- $token = $tokens[0];
- $value = array();
- if (preg_match("/COUNT\{(.*)\}/", $token, $value) == false) {
- return $token;
- }
- $this->function = "count";
- $tokens[0] = $value[1];
-
- return null;
- }
-
- /**
- * @param $values
- */
- private function parseExpression(&$values)
- {
- $tokenized = preg_split("/ +/", trim($this->expression), 3);
- $this->extractAggregationFunction($tokenized);
- if (count($tokenized) != 3) {
- echo(
- "Currently statusdat query expressions must be in "
- . "the format FIELD OPERATOR ? or FIELD OPERATOR :value_name"
- );
- }
-
- $this->fields = explode(".", trim($tokenized[0]));
- $this->field = $this->fields[count($this->fields) - 1];
-
- $this->getOperatorType(trim($tokenized[1]));
- $tokenized[2] = trim($tokenized[2]);
-
- if ($tokenized[2][0] === ":") {
- $this->name = substr($tokenized, 1);
- $this->value = $values[$this->name];
- } else {
- if ($tokenized[2] === "?") {
- $this->value = array_shift($values);
- } else {
- $this->value = trim($tokenized[2]);
- }
- }
-
- }
-
- /**
- * @param $expression
- * @param $values
- * @return $this
- */
- public function fromString($expression, &$values)
- {
- $this->expression = $expression;
- $this->parseExpression($values);
- return $this;
- }
-
- /**
- * @param null $expression
- * @param array $values
- */
- public function __construct($expression = null, &$values = array())
- {
- if ($expression) {
- if (!is_array($values)) {
- $values = array($values);
- }
- $this->fromString($expression, $values);
- }
-
- }
-
- /**
- * @param array $base
- * @param array $idx
- * @return array|mixed
- */
- public function filter(array &$base, &$idx = array())
- {
- if (!$idx) {
- $idx = array_keys($base);
- }
- $this->basedata = $base;
- return array_filter($idx, array($this, "filterFn"));
- }
-
- /**
- * @return string
- */
- public function getValue()
- {
- return $this->value;
- }
-
- /**
- * @return null
- */
- public function getField()
- {
- return $this->field;
- }
-
- /**
- * @param $idx
- * @return bool
- */
- protected function filterFn($idx)
- {
- $values = $this->getFieldValues($idx);
-
- if ($values === false) {
- return false;
- }
-
- if ($this->CB == "isIn" || $this->CB == "isNotIn") {
- $cmpValues = is_array($this->value) ? $this->value : array($this->value);
- foreach ($cmpValues as $cmpValue) {
- $this->value = $cmpValue;
- foreach ($values as $value) {
- if ($this->CB == "isIn" && $this->isLike($value)) {
- $this->value = $cmpValues;
- return true;
- } elseif ($this->CB == "isNotIn" && $this->isNotLike($value)) {
- $this->value = $cmpValues;
- return true;
- }
- }
- }
- $this->value = $cmpValues;
- return false;
- }
-
- if ($this->function) {
- $values = call_user_func($this->function, $values);
- if (!is_array($values)) {
- $values = array($values);
- }
- }
- foreach ($values as $val) {
-
- if (!is_string($val) && !is_numeric($val) && is_object($val)) {
- if (isset($val->service_description)) {
- $val = $val->service_description;
- } elseif (isset($val->host_name)) {
- $val = $val->host_name;
- } else {
- return false;
- }
- }
- if ($this->{$this->CB}($val)) {
- return true;
- }
- }
- return false;
- }
-
- /**
- * @param $idx
- * @return array
- */
- private function getFieldValues($idx)
- {
- $res = $this->basedata[$idx];
-
- foreach ($this->fields as $field) {
- if (!is_array($res)) {
- if ($this->query) {
- $res = $this->query->get($res, $field);
- continue;
- }
-
- if (!isset($res->$field)) {
- $res = array();
- break;
- }
- $res = $res->$field;
- continue;
- }
-
- // it can be that an element contains more than one value, like it
- // happens when using comments, in this case we have to create a new
- // array that contains the values/objects we're searching
- $swap = array();
- foreach ($res as $sub) {
- if ($this->query) {
- $swap[] = $this->query->get($sub, $field);
- continue;
- }
- if (!isset($sub->$field)) {
- continue;
- }
- if (!is_array($sub->$field)) {
- $swap[] = $sub->$field;
- } else {
- $swap = array_merge($swap, $sub->$field);
- }
- }
- $res = $swap;
- }
- if (!is_array($res)) {
- return array($res);
- }
-
- return $res;
- }
-
- /**
- * @param $value
- * @return bool
- */
- public function isGreater($value)
- {
- return $value > $this->value;
- }
-
- /**
- * @param $value
- * @return bool
- */
- public function isLess($value)
- {
- return $value < $this->value;
- }
-
- /**
- * @param $value
- * @return bool
- */
- public function isLike($value)
- {
- return preg_match("/^" . str_replace("%", ".*", $this->value) . "$/", $value) ? true : false;
- }
-
- /**
- * @param $value
- * @return bool
- */
- public function isNotLike($value)
- {
- return !preg_match("/^" . str_replace("%", ".*", $this->value) . "$/", $value) ? true : false;
- }
-
- /**
- * @param $value
- * @return bool
- */
- public function isEqual($value)
- {
- if (!is_numeric($value)) {
- return strtolower($value) == strtolower($this->value);
- }
- return $value == $this->value;
- }
-
- /**
- * @param $value
- * @return bool
- */
- public function isNotEqual($value)
- {
- return $value != $this->value;
- }
-
- /**
- * @param $value
- * @return bool
- */
- public function isGreaterEq($value)
- {
- return $value >= $this->value;
- }
-
- /**
- * @param $value
- * @return bool
- */
- public function isLessEq($value)
- {
- return $value <= $this->value;
- }
-
- /**
- * Add additional information about the query this filter belongs to
- *
- * @param $query
- * @return mixed
- */
- public function setQuery($query)
- {
- $this->query = $query;
- }
-}
diff --git a/library/Icinga/Protocol/Statusdat/Query/Group.php b/library/Icinga/Protocol/Statusdat/Query/Group.php
deleted file mode 100644
index 2e110843f..000000000
--- a/library/Icinga/Protocol/Statusdat/Query/Group.php
+++ /dev/null
@@ -1,397 +0,0 @@
-value = $value;
- }
-
- /**
- * @return array
- */
- public function getItems()
- {
- return $this->items;
- }
-
- /**
- * @return string
- */
- public function getType()
- {
- return $this->type ? $this->type : self::TYPE_AND;
- }
-
- /**
- * @param $type
- */
- public function setType($type)
- {
- $this->type = $type;
- }
-
- /**
- * @throws IcingaException
- */
- private function tokenize()
- {
- $token = 0;
- $subgroupCount = 0;
- while ($token != self::EOF) {
-
- $token = $this->getNextToken();
-
- if ($token === self::GROUP_BEGIN) {
-
- /**
- * check if this is a nested group, if so then it's
- * considered part of the subexpression
- */
- if ($subgroupCount == 0) {
- $this->startNewSubExpression();
- }
- $subgroupCount++;
- continue;
- }
- if ($token === self::GROUP_END) {
- if ($subgroupCount < 1) {
- throw new IcingaException(
- 'Invalid Query: unexpected \')\' at pos %s',
- $this->parsePos
- );
- }
- $subgroupCount--;
- /*
- * check if this is a nested group, if so then it's
- * considered part of the subexpression
- */
- if ($subgroupCount == 0) {
- $this->addSubgroupFromExpression();
- }
- continue;
- }
-
- if ($token === self::CONJUNCTION_AND && $subgroupCount == 0) {
- $this->startNewSubExpression();
- if ($this->type != self::TYPE_AND && $this->type != "") {
- $this->createImplicitGroup(self::TYPE_AND);
- break;
- } else {
- $this->type = self::TYPE_AND;
- }
- continue;
- }
- if ($token === self::CONJUNCTION_OR && $subgroupCount == 0) {
- $this->startNewSubExpression();
- if ($this->type != self::TYPE_OR && $this->type != "") {
- $this->createImplicitGroup(self::TYPE_OR);
- break;
- } else {
-
- $this->type = self::TYPE_OR;
- }
- continue;
- }
-
- $this->subExpressionLength = $this->parsePos - $this->subExpressionStart;
- }
- if ($subgroupCount > 0) {
- throw new IcingaException('Unexpected end of query, are you missing a parenthesis?');
- }
-
- $this->startNewSubExpression();
- }
-
- /**
- * @param $type
- */
- private function createImplicitGroup($type)
- {
- $group = new Group();
- $group->setType($type);
- $group->addItem(array_pop($this->items));
-
- $group->fromString(substr($this->expression, $this->parsePos), $this->value, $this->expressionClass);
- $this->items[] = $group;
- $this->parsePos = strlen($this->expression);
-
- }
-
- /**
- *
- */
- private function startNewSubExpression()
- {
- if ($this->getCurrentSubExpression() != "") {
- if (!$this->expressionClass) {
- $this->items[] = new Expression($this->getCurrentSubExpression(), $this->value);
- } else {
- $this->items[] = new $this->expressionClass($this->getCurrentSubExpression(), $this->value);
- }
- }
-
- $this->subExpressionStart = $this->parsePos;
- $this->subExpressionLength = 0;
- }
-
- /**
- * @return string
- */
- private function getCurrentSubExpression()
- {
-
- return substr($this->expression, $this->subExpressionStart, $this->subExpressionLength);
- }
-
- /**
- *
- */
- private function addSubgroupFromExpression()
- {
-
- if (!$this->expressionClass) {
- $this->items[] = new Group($this->getCurrentSubExpression(), $this->value);
- } else {
- $group = new Group();
- $group->fromString($this->getCurrentSubExpression(), $this->value, $this->expressionClass);
- $this->items[] = $group;
- }
- $this->subExpressionStart = $this->parsePos;
- $this->subExpressionLength = 0;
- }
-
- /**
- * @return bool
- */
- private function isEOF()
- {
- if ($this->parsePos >= strlen($this->expression)) {
- return true;
- }
- return false;
- }
-
- /**
- * @return int|string
- */
- private function getNextToken()
- {
- if ($this->isEOF()) {
- return self::EOF;
- }
-
- // skip whitespaces
- while ($this->expression[$this->parsePos] == " ") {
- $this->parsePos++;
- if ($this->isEOF()) {
- return self::EOF;
- }
- }
- if ($this->expression[$this->parsePos] == self::GROUP_BEGIN) {
- $this->parsePos++;
- return self::GROUP_BEGIN;
- }
- if ($this->expression[$this->parsePos] == self::GROUP_END) {
- $this->parsePos++;
- return self::GROUP_END;
- }
- if (substr_compare(
- $this->expression,
- self::CONJUNCTION_AND,
- $this->parsePos,
- strlen(self::CONJUNCTION_AND),
- true
- ) === 0) {
- $this->parsePos += strlen(self::CONJUNCTION_AND);
- return self::CONJUNCTION_AND;
- }
- if (substr_compare(
- $this->expression,
- self::CONJUNCTION_OR,
- $this->parsePos,
- strlen(self::CONJUNCTION_OR),
- true
- ) === 0) {
- $this->parsePos += strlen(self::CONJUNCTION_OR);
- return self::CONJUNCTION_OR;
- }
- $this->parsePos++;
- return self::EXPRESSION;
- }
-
- /**
- * @param $ex
- * @return $this
- */
- public function addItem($ex)
- {
- $this->items[] = $ex;
- return $this;
- }
-
- /**
- * @param $expression
- * @param array $value
- * @param null $expressionClass
- * @return $this
- */
- public function fromString($expression, &$value = array(), $expressionClass = null)
- {
- $this->expression = $expression;
- $this->value = & $value;
- $this->expressionClass = $expressionClass;
-
- $this->tokenize();
- return $this;
- }
-
- /**
- * @param null $expression
- * @param array $value
- */
- public function __construct($expression = null, &$value = array())
- {
- if ($expression) {
- $this->fromString($expression, $value);
- }
- }
-
- /**
- * @param array $base
- * @param null $idx
- * @return array|null
- */
- public function filter(array &$base, &$idx = null)
- {
- if ($this->type == self::TYPE_OR) {
- $idx = array();
- foreach ($this->items as &$subFilter) {
- $baseKeys = array_keys($base);
- $subFilter->setQuery($this->query);
- $idx += $subFilter->filter($base, $baseKeys);
- }
- } else {
- if (!$idx) {
- $idx = array_keys($base);
- }
- foreach ($this->items as $subFilter) {
- $subFilter->setQuery($this->query);
- $idx = array_intersect($idx, $subFilter->filter($base, $idx));
- }
- }
-
- return $idx;
- }
-
- /**
- * Add additional information about the query this filter belongs to
- *
- * @param $query
- * @return mixed
- */
- public function setQuery($query)
- {
- $this->query = $query;
- }
-}
diff --git a/library/Icinga/Protocol/Statusdat/Query/IQueryPart.php b/library/Icinga/Protocol/Statusdat/Query/IQueryPart.php
deleted file mode 100644
index 1dcd434df..000000000
--- a/library/Icinga/Protocol/Statusdat/Query/IQueryPart.php
+++ /dev/null
@@ -1,36 +0,0 @@
-noCache = $noCache;
- if (isset($config->no_cache)) {
- $this->noCache = $config->no_cache;
- }
- $this->config = $config;
- $this->parser = $parser;
-
- if (!$this->noCache) {
- $this->cache = $this->initializeCaches($config);
- if ($this->fromCache()) {
- $this->createHostServiceConnections();
- return;
- }
- }
-
- if (!$this->lastState) {
- $this->parseObjectsCacheFile();
- }
- if (!$this->hasRuntimeState) {
-
- }
- $this->parseStatusDatFile();
- if (!$noCache && $this->newState) {
- $this->statusCache->save($this->parser->getRuntimeState(), 'object' . md5($this->config->object_file));
- }
- $this->createHostServiceConnections();
-
- }
-
- /**
- * Initialize the internal caches if enabled
- *
- * @throws ConfigurationError
- */
- private function initializeCaches()
- {
- $defaultCachePath = self::STATUSDAT_DEFAULT_CACHE_PATH;
- $cachePath = $this->config->get('cache_path', $defaultCachePath);
- $maxCacheLifetime = intval($this->config->get('cache_path', self::DEFAULT_CACHE_LIFETIME));
- $cachingEnabled = true;
- if (!is_writeable($cachePath)) {
- Logger::warning(
- 'Can\'t cache Status.dat backend; make sure cachepath %s is writable by the web user. '
- . 'Caching is now disabled',
- $cachePath
- );
- $cachePath = null;
- }
- $backendOptions = array(
- 'cache_dir' => $cachePath
- );
- // the object cache might exist for months and is still valid
- $this->objectCache = $this->initCache($this->config->object_file, $backendOptions, null, $cachingEnabled);
- $this->statusCache = $this->initCache(
- $this->config->status_file,
- $backendOptions,
- $maxCacheLifetime,
- $cachingEnabled
- );
- }
-
- /**
- * Init the Cache backend in Zend
- *
- * @param String $file The file to use as the cache master file
- * @param Zend_Config $backend The backend configuration to use
- * @param integer $lifetime The lifetime of the cache
- *
- * @return \Zend_Cache_Core|\Zend_Cache_Frontend
- */
- private function initCache($file, $backendConfig, $lifetime)
- {
- $frontendOptions = array(
- 'lifetime' => $lifetime,
- 'automatic_serialization' => true,
- 'master_files' => array($file)
- );
- return \Zend_Cache::factory('Core', 'File', $frontendOptions, $backendConfig);
- }
-
- /**
- * Read the current cache state
- *
- * @return bool True if the state is the same as the icinga state
- */
- private function fromCache()
- {
- if (!$this->readObjectsCache()) {
- $this->newState = true;
- return false;
- }
- if (!$this->readStatusCache()) {
- $this->newState = true;
- return false;
- }
- return true;
- }
-
- /**
- * Read the object.cache file from the Zend_Cache backend
- *
- * @return bool True if the file could be loaded from cache
- */
- private function readObjectsCache()
- {
- $this->lastState = $this->objectCache->load('object' . md5($this->config->object_file));
- if ($this->lastState == false) {
- return false;
- }
-
- return true;
- }
-
- /**
- * Read the status.dat file from the Zend_Cache backend
- *
- * @return bool True if the file could be loaded from cache
- */
- private function readStatusCache()
- {
- if (!isset($this->stateCache)) {
- return true;
- }
- $statusInfo = $this->stateCache->load('state' . md5($this->config->status_file));
- if ($statusInfo == false) {
- return false;
- }
-
- $this->hasRuntimeState = true;
- return true;
- }
-
- /**
- * Take the status.dat and objects.cache and connect all services to hosts
- *
- */
- private function createHostServiceConnections()
- {
- if (!isset($this->lastState["service"])) {
- return;
- }
- foreach ($this->lastState["host"] as &$host) {
- $host->host = $host;
- }
- foreach ($this->lastState["service"] as &$service) {
- $service->service = &$service; // allow easier querying
- $host = &$this->lastState["host"][$service->host_name];
- if (!isset($host->services)) {
- $host->services = array();
- }
- $host->services[$service->service_description] = & $service;
- $service->host = & $host;
- }
- }
-
- /**
- * Parse the object.cache file and update the current state
- *
- * @throws ConfigurationError If the object.cache couldn't be read
- */
- private function parseObjectsCacheFile()
- {
- if (!is_readable($this->config->object_file)) {
- throw new ConfigurationError(
- 'Can\'t read object-file "%s", check your configuration',
- $this->config->object_file
- );
- }
- if (!$this->parser) {
- $this->parser = new Parser(new File($this->config->object_file, 'r'));
- }
- $this->parser->parseObjectsFile();
- $this->lastState = $this->parser->getRuntimeState();
- }
-
- /**
- * Parse the status.dat file and update the current state
- *
- * @throws ConfigurationError If the status.dat couldn't be read
- */
- private function parseStatusDatFile()
- {
- if (!is_readable($this->config->status_file)) {
- throw new ConfigurationError(
- 'Can\'t read status-file %s, check your configuration',
- $this->config->status_file
- );
- }
- if (!$this->parser) {
- $this->parser = new Parser(new File($this->config->status_file, 'r'), $this->lastState);
- }
- $this->parser->parseRuntimeState(new File($this->config->status_file, 'r'));
- $this->lastState = $this->parser->getRuntimeState();
- if (!$this->noCache) {
- $this->statusCache->save(array("true" => true), "state" . md5($this->config->object_file));
- }
- }
-
- /**
- * Create a new Query
- *
- * @return Query The query to operate on
- */
- public function select()
- {
- return new Query($this);
- }
-
- /**
- * Return the internal state of the status.dat
- *
- * @return mixed The internal status.dat representation
- */
- public function getState()
- {
- return $this->lastState;
- }
-
-
- /**
- * Return the object with the given name and type
- *
- * @param String $type The type of the object to return (service, host, servicegroup...)
- * @param String $name The name of the object
- *
- * @return ObjectContainer An object container wrapping the result or null if the object doesn't exist
- */
- public function getObjectByName($type, $name)
- {
- if (isset($this->lastState[$type]) && isset($this->lastState[$type][$name])) {
- return new ObjectContainer($this->lastState[$type][$name], $this);
- }
- return null;
- }
-
- /**
- * Get an array containing all names of monitoring objects with the given type
- *
- * @param String $type The type of object to get the names for
- * @return array An array of names or null if the type does not exist
- */
- public function getObjectNames($type)
- {
- return isset($this->lastState[$type]) ? array_keys($this->lastState[$type]) : null;
- }
-}
diff --git a/library/Icinga/Protocol/Statusdat/RuntimeStateContainer.php b/library/Icinga/Protocol/Statusdat/RuntimeStateContainer.php
deleted file mode 100644
index b15dfe4bb..000000000
--- a/library/Icinga/Protocol/Statusdat/RuntimeStateContainer.php
+++ /dev/null
@@ -1,72 +0,0 @@
-runtimeState = $str;
- }
-
- /**
- * Return true if the argument exists
- *
- * @param String $attr The argument to retrieve
- * @return bool True if it exists, otherwise false
- */
- public function __isset($attr)
- {
- try {
- $this->__get($attr);
- return true;
- } catch (\InvalidArgumentException $e) {
- return false;
- }
- }
-
- /**
- * Return the given attribute
- *
- * If the container string is not yet parsed, this will happen here
- *
- * @param String $attr The attribute to retrieve
- * @return mixed The value of the attribute
- * @throws \InvalidArgumentException When the attribute does not exist
- */
- public function __get($attr)
- {
- $start = strpos($this->runtimeState, $attr . "=");
- if ($start === false) {
- throw new \InvalidArgumentException("Unknown property $attr");
- }
-
- $start += strlen($attr . "=");
- $len = strpos($this->runtimeState, "\n", $start) - $start;
- $this->$attr = trim(substr($this->runtimeState, $start, $len));
-
- return $this->$attr;
- }
-}
diff --git a/library/Icinga/Protocol/Statusdat/View/AccessorStrategy.php b/library/Icinga/Protocol/Statusdat/View/AccessorStrategy.php
deleted file mode 100644
index 4e4bc76a1..000000000
--- a/library/Icinga/Protocol/Statusdat/View/AccessorStrategy.php
+++ /dev/null
@@ -1,42 +0,0 @@
-dataSet = $dataset;
- $this->position = 0;
- $this->dataView = $dataView;
- }
-
- public function count()
- {
- return count($this->dataSet);
- }
-
- public function setPosition($pos)
- {
- $this->position = $pos;
- }
-
- /**
- * (PHP 5 >= 5.0.0)' - . $attributes['helptext'] - . '
'; - } - return $content; - } -} diff --git a/library/Icinga/Web/Form/Decorator/NoScriptApply.php b/library/Icinga/Web/Form/Decorator/NoScriptApply.php new file mode 100644 index 000000000..509c3531e --- /dev/null +++ b/library/Icinga/Web/Form/Decorator/NoScriptApply.php @@ -0,0 +1,35 @@ +'; + } + + return $content; + } +} diff --git a/library/Icinga/Web/Form/Element/CsrfCounterMeasure.php b/library/Icinga/Web/Form/Element/CsrfCounterMeasure.php new file mode 100644 index 000000000..e9bc37edd --- /dev/null +++ b/library/Icinga/Web/Form/Element/CsrfCounterMeasure.php @@ -0,0 +1,100 @@ +addDecorator('ViewHelper'); + $this->setValue($this->generateCsrfToken()); + } + + /** + * Check whether $value is a valid CSRF token + * + * @param string $value The value to check + * @param mixed $context Context to use + * + * @return bool True, in case the CSRF token is valid + * + * @throws InvalidCSRFTokenException In case the CSRF token is not valid + */ + public function isValid($value, $context = null) + { + if (parent::isValid($value, $context) && $this->isValidCsrfToken($value)) { + return true; + } + + throw new InvalidCSRFTokenException(); + } + + /** + * Check whether the given value is a valid CSRF token for the current session + * + * @param string $token The CSRF token + * + * @return bool + */ + protected function isValidCsrfToken($token) + { + if (strpos($token, '|') === false) { + return false; + } + + list($seed, $hash) = explode('|', $token); + + if (false === is_numeric($seed)) { + return false; + } + + return $hash === hash('sha256', Session::getSession()->getId() . $seed); + } + + /** + * Generate a new (seed, token) pair + * + * @return string + */ + protected function generateCsrfToken() + { + $seed = mt_rand(); + $hash = hash('sha256', Session::getSession()->getId() . $seed); + return sprintf('%s|%s', $seed, $hash); + } +} diff --git a/library/Icinga/Web/Form/Element/DateTimePicker.php b/library/Icinga/Web/Form/Element/DateTimePicker.php index dd48bd7f2..728262827 100644 --- a/library/Icinga/Web/Form/Element/DateTimePicker.php +++ b/library/Icinga/Web/Form/Element/DateTimePicker.php @@ -4,100 +4,133 @@ namespace Icinga\Web\Form\Element; +use DateTime; +use Icinga\Web\Form; +use Icinga\Web\Form\FormElement; use Icinga\Web\Form\Validator\DateTimeValidator; -use Zend_Form_Element_Text; -use Zend_Form_Element; -use Icinga\Util\DateTimeFactory; /** - * Datetime form element which returns the input as Unix timestamp after the input has been proven valid. Utilizes - * DateTimeFactory to ensure time zone awareness - * - * @see isValid() + * A date-and-time input control */ -class DateTimePicker extends Zend_Form_Element_Text +class DateTimePicker extends FormElement { /** - * Default format used my js picker + * Form view helper to use for rendering * * @var string */ - public $defaultFormat = 'Y-m-d H:i:s'; - - /** - * JS picker support on or off - * @var bool - */ - public $jspicker = true; - - /** - * View helper to use - * @var string - */ public $helper = 'formDateTime'; /** - * The validator used for datetime validation - * @var DateTimeValidator + * @var bool */ - private $dateValidator; + protected $local = true; /** - * Valid formats to check user input against - * @var array - */ - public $patterns = array(); - - /** - * Create a new DateTimePicker + * The expected lower bound for the element’s value * - * @param array|string|\Zend_Config $spec - * @param null $options - * @see Zend_Form_Element::__construct() + * @var DateTime|null */ - public function __construct($spec, $options = null) + protected $min; + + /** + * The expected upper bound for the element’s + * + * @var DateTime|null + */ + protected $max; + + /** + * (non-PHPDoc) + * @see Zend_Form_Element::init() For the method documentation. + */ + public function init() { - parent::__construct($spec, $options); + $this->addValidator( + new DateTimeValidator($this->local), true // true for breaking the validator chain on failure + ); + if ($this->min !== null) { + $this->addValidator('GreaterThan', true, array('min' => $this->min)); + } + if ($this->max !== null) { + $this->addValidator('LessThan', true, array('max' => $this->max)); + } + } - $this->patterns[] = $this->defaultFormat; + public function setLocal($local) + { + $this->local = (bool) $local; + return $this; + } - $this->dateValidator = new DateTimeValidator($this->patterns); - $this->addValidator($this->dateValidator); + public function getLocal() + { + return $this->local; } /** - * Validate filtered date/time strings + * Set the expected lower bound for the element’s value * - * Expects one or more valid formats being set in $this->patterns. Sets element value as Unix timestamp - * if the input is considered valid. Utilizes DateTimeFactory to ensure time zone awareness. + * @param DateTime $min + * + * @return $this + */ + public function setMin(DateTime $min) + { + $this->min = $min; + return $this; + } + + /** + * Get the expected lower bound for the element’s value + * + * @return DateTime|null + */ + public function getMin() + { + return $this->min; + } + + /** + * Set the expected upper bound for the element’s value + * + * @param DateTime $max + * + * @return $this + */ + public function setMax(DateTime $max) + { + $this->max = $max; + return $this; + } + + /** + * Get the expected upper bound for the element’s value + * + * @return DateTime|null + */ + public function getMax() + { + return $this->max; + } + + /** + * Is the date and time valid? + * + * @param string|DateTime $value + * @param mixed $context * - * @param string $value - * @param mixed $context * @return bool */ public function isValid($value, $context = null) { - // Overwrite the internal validator to use - - if (!parent::isValid($value, $context)) { + if (! parent::isValid($value, $context)) { return false; } - $pattern = $this->dateValidator->getValidPattern(); - if (!$pattern) { - $this->setValue($value); - return true; + if (! $value instanceof DateTime) { + $format = $this->local === true ? 'Y-m-d\TH:i:s' : DateTime::RFC3339; + $this->setValue(DateTime::createFromFormat($format, $value)); } - $this->setValue(DateTimeFactory::parse($value, $pattern)->getTimestamp()); return true; } - - public function enableJsPicker() - { - $this->jspicker = true; - } - - public function disableJsPicker() - { - $this->jspicker = false; - } } diff --git a/library/Icinga/Web/Form/Element/Note.php b/library/Icinga/Web/Form/Element/Note.php index 5788c200d..78881ab44 100644 --- a/library/Icinga/Web/Form/Element/Note.php +++ b/library/Icinga/Web/Form/Element/Note.php @@ -4,25 +4,43 @@ namespace Icinga\Web\Form\Element; -use Zend_Form_Element_Xhtml; +use Zend_Form_Element; +use Icinga\Web\Form; /** - * Implements note element for Zend forms + * A note */ -class Note extends Zend_Form_Element_Xhtml +class Note extends Zend_Form_Element { /** - * Name of the view helper + * Form view helper to use for rendering * * @var string */ public $helper = 'formNote'; /** - * Return true to ensure redrawing + * Ignore element when retrieving values at form level * - * @param mixed $value The value of to validate (ignored) - * @return bool Always true + * @var bool + */ + protected $_ignore = true; + + /** + * (non-PHPDoc) + * @see Zend_Form_Element::init() For the method documentation. + */ + public function init() + { + $this->setDecorators(Form::$defaultElementDecorators); + } + + /** + * Validate element value (pseudo) + * + * @param mixed $value Ignored + * + * @return bool Always true */ public function isValid($value) { diff --git a/library/Icinga/Web/Form/Element/Number.php b/library/Icinga/Web/Form/Element/Number.php index d87a6d09f..836142514 100644 --- a/library/Icinga/Web/Form/Element/Number.php +++ b/library/Icinga/Web/Form/Element/Number.php @@ -4,38 +4,127 @@ namespace Icinga\Web\Form\Element; -use Zend_Form_Element_Xhtml; +use Icinga\Web\Form\FormElement; /** - * Number form element + * A number input control */ -class Number extends Zend_Form_Element_Xhtml +class Number extends FormElement { /** - * Default form view helper to use for rendering + * Form view helper to use for rendering * * @var string */ - public $helper = "formNumber"; + public $helper = 'formNumber'; /** - * Check whether $value is of type integer + * The expected lower bound for the element’s value * - * @param string $value The value to check - * @param mixed $context Context to use - * - * @return bool + * @var float|null */ - public function isValid($value, $context = null) + protected $min; + + /** + * The expected upper bound for the element’s + * + * @var float|null + */ + protected $max; + + /** + * The value granularity of the element’s value + * + * Normally, number input controls are limited to an accuracy of integer values. + * + * @var float|string|null + */ + protected $step; + + /** + * (non-PHPDoc) + * @see \Zend_Form_Element::init() For the method documentation. + */ + public function init() { - if (parent::isValid($value, $context)) { - if (is_numeric($value)) { - return true; - } - - $this->addError(t('Please enter a number.')); + $this->addValidator('Float', true); // true for breaking the validator chain on failure + if ($this->min !== null) { + $this->addValidator('GreaterThan', true, array('min' => $this->min)); } + if ($this->max !== null) { + $this->addValidator('LessThan', true, array('max' => $this->max)); + } + } - return false; + /** + * Set the expected lower bound for the element’s value + * + * @param float $min + * + * @return $this + */ + public function setMin($min) + { + $this->min = (float) $min; + return $this; + } + + /** + * Get the expected lower bound for the element’s value + * + * @return float|null + */ + public function getMin() + { + return $this->min; + } + + /** + * Set the expected upper bound for the element’s value + * + * @param float $max + * + * @return $this + */ + public function setMax($max) + { + $this->max = (int) $max; + return $this; + } + + /** + * Get the expected upper bound for the element’s value + * + * @return float|null + */ + public function getMax() + { + return $this->max; + } + + /** + * Set the value granularity of the element’s value + * + * @param float|string $step + * + * @return $this + */ + public function setStep($step) + { + if ($step !== 'any') { + $step = (float) $step; + } + $this->step = $step; + return $this; + } + + /** + * Get the value granularity of the element’s value + * + * @return float|string|null + */ + public function getStep() + { + return $this->step; } } diff --git a/library/Icinga/Web/Form/FormElement.php b/library/Icinga/Web/Form/FormElement.php new file mode 100644 index 000000000..690be1acf --- /dev/null +++ b/library/Icinga/Web/Form/FormElement.php @@ -0,0 +1,62 @@ +_disableLoadDefaultDecorators === true; + } + + /** + * Load default decorators + * + * Icinga Web 2 loads its own default element decorators. For loading Zend's default element decorators set + * FormElement::$_disableLoadDefaultDecorators to false. + * + * @return this + * @see Form::$defaultElementDecorators For Icinga Web 2's default element decorators. + */ + public function loadDefaultDecorators() + { + if ($this->loadDefaultDecoratorsIsDisabled()) { + return $this; + } + + if (! isset($this->_disableLoadDefaultDecorators)) { + $decorators = $this->getDecorators(); + if (empty($decorators)) { + // Load Icinga Web 2's default element decorators + $this->addDecorators(Form::$defaultElementDecorators); + } + } else { + // Load Zend's default decorators + parent::loadDefaultDecorators(); + } + return $this; + } +} diff --git a/library/Icinga/Web/Form/Validator/DateTimeValidator.php b/library/Icinga/Web/Form/Validator/DateTimeValidator.php index f1952f7d4..6b59d5263 100644 --- a/library/Icinga/Web/Form/Validator/DateTimeValidator.php +++ b/library/Icinga/Web/Form/Validator/DateTimeValidator.php @@ -4,127 +4,52 @@ namespace Icinga\Web\Form\Validator; -use Icinga\Util\DateTimeFactory; +use DateTime; use Zend_Validate_Abstract; -use Icinga\Exception\ProgrammingError; /** - * Validator that checks if a textfield contains a correct date format + * Validator for date-and-time input controls + * + * @see \Icinga\Web\Form\Element\DateTimePicker For the date-and-time input control. */ class DateTimeValidator extends Zend_Validate_Abstract { - /** - * Array of allowed patterns for datetime input - * - * @var array - */ - private $patterns = array(); + protected $local; /** - * If the input is not a timestamp this contains the pattern that - * matched the input + * Create a new date-and-time input control validator * - * @var string|bool + * @param bool $local */ - private $validPattern = false; - - /** - * Error templates - * - * @var array - * - * @see Zend_Validate_Abstract::$_messageTemplates - */ - protected $_messageTemplates = array(); - - /** - * Create this validator - * - * @param array $patterns Array containing all allowed patterns as strings - */ - public function __construct(array $patterns) + public function __construct($local) { - $this->patterns = $patterns; - $this->_messageTemplates = array( - 'INVALID_TYPE' => 'Invalid type given. Date/time string or Unix timestamp expected', - 'NO_MATCHING_PATTERN' => 'Invalid format given, valid formats are ' . $this->getAllowedPatternList() - ); + $this->local = (bool) $local; } /** - * Check whether a variable is a Unix timestamp + * Is the date and time valid? + * + * @param string|DateTime $value + * @param mixed $context * - * @param mixed $timestamp * @return bool - */ - public static function isUnixTimestamp($timestamp) - { - return (is_int($timestamp) || ctype_digit($timestamp)) - && ($timestamp <= PHP_INT_MAX) - && ($timestamp >= ~PHP_INT_MAX); - } - - /** - * Returns a printable string containing all configured patterns * - * @return string - */ - private function getAllowedPatternList() - { - return '"' . join('","', $this->patterns) . '"'; - } - - /** - * Validate the input value and set the value of @see validPattern if the input machtes a pattern - * - * @param string $value The format string to validate - * @param null $context The form context (ignored) - * - * @return bool True when the input is valid, otherwise false - * - * @see Zend_Validate_Abstract::isValid() + * @see \Zend_Validate_Interface::isValid() */ public function isValid($value, $context = null) { - $this->validPattern = false; - if (!is_string($value) && !is_int($value)) { - $this->error('INVALID_TYPE'); + if (! $value instanceof DateTime && ! is_string($value)) { + $this->_error(t('Invalid type given. Instance of DateTime or date/time string expected')); return false; } - - if ($this->isUnixTimestamp($value)) { - $dt = DateTimeFactory::create(); - $dt->setTimestamp($value); - } else { - if (!isset($this->patterns)) { - throw new ProgrammingError('There are no allowed timeformats configured'); - } - - $match_found = false; - foreach ($this->patterns as $pattern) { - $dt = DateTimeFactory::parse($value, $pattern); - if ($dt !== false && $dt->format($pattern) === $value) { - $match_found = true; - $this->validPattern = $pattern; - break; - } - } - if (!$match_found) { - $this->_error('NO_MATCHING_PATTERN'); + if (is_string($value)) { + $format = $this->local === true ? 'Y-m-d\TH:i:s' : DateTime::RFC3339; + $dateTime = DateTime::createFromFormat($format, $value); + if ($dateTime === false || $dateTime->format($format) !== $value) { + $this->_error(sprintf(t('Date/time string not in the expected format %s'), $format)); return false; } } - return true; } - - /** - * Return the matched pattern if any or false if input is a timestamp - * - * @return bool|string False if input was a timestamp otherwise string with the dateformat pattern - */ - public function getValidPattern() - { - return $this->validPattern; - } } diff --git a/library/Icinga/Web/Form/Validator/ReadablePathValidator.php b/library/Icinga/Web/Form/Validator/ReadablePathValidator.php new file mode 100644 index 000000000..4060f6ecd --- /dev/null +++ b/library/Icinga/Web/Form/Validator/ReadablePathValidator.php @@ -0,0 +1,58 @@ +_messageTemplates = array( + 'NOT_READABLE' => t('Path is not readable'), + 'DOES_NOT_EXIST' => t('Path does not exist') + ); + } + + /** + * Check whether the given value is a readable filepath + * + * @param string $value The value submitted in the form + * @param mixed $context The context of the form + * + * @return bool Whether the value was successfully validated + */ + public function isValid($value, $context = null) + { + if (false === file_exists($value)) { + $this->_error('DOES_NOT_EXIST'); + return false; + } + + if (false === is_readable($value)) { + $this->_error('NOT_READABLE'); + } + + return true; + } +} diff --git a/library/Icinga/Web/Hook.php b/library/Icinga/Web/Hook.php index 2e85f570e..36974fb5b 100644 --- a/library/Icinga/Web/Hook.php +++ b/library/Icinga/Web/Hook.php @@ -174,18 +174,6 @@ class Hook } } - /** - * Register your hook - * - * Alias for Hook::registerClass() - * - * @see Hook::registerClass() - */ - public static function register($name, $key, $class) - { - self::registerClass($name, $key, $class); - } - /** * Register a class * @@ -194,45 +182,12 @@ class Hook * @param string $class Your class name, must inherit one of the * classes in the Icinga/Web/Hook folder */ - public static function registerClass($name, $key, $class) + public static function register($name, $key, $class) { - if (!class_exists($class)) { - throw new ProgrammingError( - '"%s" is not an existing class', - $class - ); - } - if (!isset(self::$hooks[$name])) { self::$hooks[$name] = array(); } self::$hooks[$name][$key] = $class; } - - /** - * Register an object - * - * @param string $name One of the predefined hook names - * @param string $key The identifier of a specific subtype - * @param object $object The instantiated hook to register - * - * @throws ProgrammingError - */ - public static function registerObject($name, $key, $object) - { - if (!is_object($object)) { - throw new ProgrammingError( - '"%s" is not an instantiated class', - $object - ); - } - - if (!isset(self::$instances[$name])) { - self::$instances[$name] = array(); - } - - self::$instances[$name][$key] = $object; - self::registerClass($name, $key, get_class($object)); - } } diff --git a/library/Icinga/Web/JavaScript.php b/library/Icinga/Web/JavaScript.php index 01e6a55eb..6224b5b82 100644 --- a/library/Icinga/Web/JavaScript.php +++ b/library/Icinga/Web/JavaScript.php @@ -18,6 +18,7 @@ class JavaScript 'js/icinga/ui.js', 'js/icinga/timer.js', 'js/icinga/loader.js', + 'js/icinga/eventlistener.js', 'js/icinga/events.js', 'js/icinga/history.js', 'js/icinga/module.js', @@ -25,7 +26,8 @@ class JavaScript 'js/icinga/behavior/tooltip.js', 'js/icinga/behavior/sparkline.js', 'js/icinga/behavior/tristate.js', - 'js/icinga/behavior/navigation.js' + 'js/icinga/behavior/navigation.js', + 'js/icinga/behavior/form.js' ); protected static $vendorFiles = array( diff --git a/library/Icinga/Web/Response.php b/library/Icinga/Web/Response.php index 33e0ea2a3..6ad4f6f87 100644 --- a/library/Icinga/Web/Response.php +++ b/library/Icinga/Web/Response.php @@ -17,7 +17,7 @@ class Response extends Zend_Controller_Response_Http $url->getParams()->setSeparator('&'); if (Icinga::app()->getFrontController()->getRequest()->isXmlHttpRequest()) { - $this->setHeader('X-Icinga-Redirect', rawurlencode($url)); + $this->setHeader('X-Icinga-Redirect', rawurlencode($url->getAbsoluteUrl())); } else { $this->setRedirect($url->getAbsoluteUrl()); } diff --git a/library/Icinga/Web/View.php b/library/Icinga/Web/View.php index 22e8e6fbd..7a954934a 100644 --- a/library/Icinga/Web/View.php +++ b/library/Icinga/Web/View.php @@ -127,9 +127,19 @@ class View extends Zend_View_Abstract ); } - public function translate($text) + public function translate($text, $context = null) { - return Translator::translate($text, $this->translationDomain); + return Translator::translate($text, $this->translationDomain, $context); + } + + /** + * Translate a plural string + * + * @see Translator::translatePlural() + */ + public function translatePlural($textSingular, $textPlural, $number, $context = null) + { + return Translator::translatePlural($textSingular, $textPlural, $number, $this->translationDomain, $context); } /** diff --git a/library/Icinga/Web/View/DateTimeRenderer.php b/library/Icinga/Web/View/DateTimeRenderer.php new file mode 100644 index 000000000..639befb7f --- /dev/null +++ b/library/Icinga/Web/View/DateTimeRenderer.php @@ -0,0 +1,205 @@ +future = $future; + $this->now = new DateTime(); + $this->dateTime = $this->normalize($dateTime); + $this->detectType(); + } + + /** + * Creates a new DateTimeRenderer + * + * @param DateTime|int $dateTime + * @param bool $future + * + * @return DateTimeRenderer + */ + public static function create($dateTime, $future = false) + { + return new static($dateTime, $future); + } + + /** + * Detects the DateTime context + */ + protected function detectType() + { + if ($this->now->format('Y-m-d') !== $this->dateTime->format('Y-m-d')) { + $this->type = self::TYPE_DATETIME; + return; + } + + if ( + $this->now->format('Y-m-d') === $this->dateTime->format('Y-m-d') && + (abs($this->now->getTimestamp() - $this->dateTime->getTimestamp()) >= self::HOUR) + ) { + $this->type = self::TYPE_TIME; + return; + } + + if ( + $this->now->format('Y-m-d') === $this->dateTime->format('Y-m-d') && + (abs($this->now->getTimestamp() - $this->dateTime->getTimestamp()) < self::HOUR) + ) { + $this->type = self::TYPE_TIMESPAN; + return; + } + } + + /** + * Normalizes the given DateTime + * + * @param DateTime|int $dateTime + * + * @return DateTime + */ + public static function normalize($dateTime) + { + if (! ($dt = $dateTime) instanceof DateTime) { + $dt = new DateTime(); + $dt->setTimestamp($dateTime); + } + return $dt; + } + + /** + * Checks whether DateTime is a date with time + * + * @return bool + */ + public function isDateTime() + { + return $this->type === self::TYPE_DATETIME; + } + + /** + * Checks whether DateTime is a time of the current day + * + * @return bool + */ + public function isTime() + { + return $this->type === self::TYPE_TIME; + } + + /** + * Checks whether DateTime is in a defined interval + * + * @return bool + */ + public function isTimespan() + { + return $this->type === self::TYPE_TIMESPAN; + } + + /** + * Returns the type of the DateTime + * + * @return mixed + */ + public function getType() + { + return $this->type; + } + + /** + * Renders the DateTime on the basis of the type and returns suited text + * + * @param string $dateTimeText + * @param string $timeText + * @param string $timespanText + * + * @return string + */ + public function render($dateTimeText, $timeText, $timespanText) + { + if ($this->isDateTime()) { + return sprintf($dateTimeText, $this); + } elseif ($this->isTime()) { + return sprintf($timeText, $this); + } elseif ($this->isTimespan()) { + return sprintf($timespanText, $this); + } + + return $dateTimeText; + } + + /** + * Returns a rendered html wrapped text + * + * @return string + */ + public function __toString() + { + switch ($this->type) { + case self::TYPE_DATETIME: + $format = $this->dateTime->format('d.m.Y - H:i:s'); + break; + case self::TYPE_TIME: + $format = $this->dateTime->format('H:i:s'); + break; + case self::TYPE_TIMESPAN: + $format = $this->dateTime->diff($this->now)->format(t('%im %ss', 'timespan')); + break; + default: + $format = $this->dateTime->format('d.m.Y - H:i:s'); + break; + } + + $css = ''; + if ($this->type === self::TYPE_TIMESPAN) { + $css = $this->future === true ? 'timeuntil' : 'timesince'; + } + + return sprintf( + '%s', + $css, + $this->dateTime->format('d.m.Y - H:i:s'), + $format + ); + } +} diff --git a/library/Icinga/Web/View/helpers/format.php b/library/Icinga/Web/View/helpers/format.php index 0d902acfd..a203f2fb3 100644 --- a/library/Icinga/Web/View/helpers/format.php +++ b/library/Icinga/Web/View/helpers/format.php @@ -44,3 +44,7 @@ $this->addHelperFunction('prefixedTimeUntil', function ($timestamp, $ucfirst = f Format::prefixedTimeUntil($timestamp, $ucfirst) ); }); + +$this->addHelperFunction('dateTimeRenderer', function ($dateTimeOrTimestamp, $future = false) { + return DateTimeRenderer::create($dateTimeOrTimestamp, $future); +}); diff --git a/library/Icinga/Web/Widget/AlertMessageBox.php b/library/Icinga/Web/Widget/AlertMessageBox.php deleted file mode 100644 index 09016f490..000000000 --- a/library/Icinga/Web/Widget/AlertMessageBox.php +++ /dev/null @@ -1,132 +0,0 @@ -user->getMessages(); - $this->user->clearMessages(); - Session::getSession()->write(); - return $messages; - } - - /** - * The displayed alert messages - * - * @var array - */ - private $messages = array(); - - /** - * The user to fetch the messages from - * - * @var User - */ - private $user; - - /** - * The available states. - * - * @var array - */ - private $states = array( - Zend_Log::INFO => array( - 'state' => 'alert-success', - 'icon' => 'success.png' - ), - Zend_Log::NOTICE => array( - 'state' => 'alert-info', - 'icon' => 'info.png' - ), - Zend_Log::WARN => array( - 'state' => 'alert-warning', - 'icon' => 'warning.png' - ), - Zend_Log::ERR => array( - 'state' => 'alert-danger', - 'icon' => 'error.png' - ) - ); - - /** - * Create a new AlertBox - * - * @param boolean showUserMessages If the current user messages should be displayed - * in this AlertMessageBox. Defaults to false - */ - public function __construct($showUserMessages = false) - { - if ($showUserMessages) { - $this->user = AuthenticationManager::getInstance()->getUser(); - } - } - - /** - * Add a new error - * - * @param $error - */ - public function addError($error) - { - $this->messages[] = new Message($error, Zend_Log::ERR); - } - - /** - * Add the error messages of the given Zend_Form - */ - public function addForm(Zend_Form $form) - { - foreach ($form->getErrorMessages() as $error) { - $this->addError($error); - } - } - - /** - * Output the HTML of the AlertBox - * - * @return string - */ - public function render(Zend_View_Abstract $view = null) - { - $html = ''; - if (isset($this->user)) { - $this->messages = array_merge($this->messages, $this->getAndClearMessages()); - } - foreach ($this->messages as $message) { - $level = $message->getLevel(); - if (!array_key_exists($level, $this->states)) { - continue; - } - $alert = $this->states[$level]; - $html .= '; ?> <a href=){kind=link}
; ?> <a href=){kind=link}