tyler.durden/icingaweb2-module-director
1
0
Fork 0
mirror of https://github.com/Icinga/icingaweb2-module-director.git synced 2025-07-31 01:34:12 +02:00
Code Issues Packages Projects Releases Wiki Activity

Revert "Export: first bunch of exportable Director objects"

Browse Source 
Wrong branch, not yet for the master

This reverts commit 721700c62f305e23130d20926ee1b8bc55bc824c.
This commit is contained in:
Thomas Gelf 2018-05-29 12:40:14 +02:00
parent 721700c62f
commit 02dfac1b8b
15 changed files with 28 additions and 575 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

184
application/clicommands/ExportCommand.php
View File

@ -1,184 +0,0 @@
<?php
namespace Icinga\Module\Director\Clicommands;
use Icinga\Module\Director\Cli\Command;
use Icinga\Module\Director\DirectorObject\Automation\ImportExport;
/**
* Export Director Config Objects
*/
class ExportCommand extends Command
{
/**
* Export all ImportSource definitions
*
* Use this command to delete a single Icinga object
*
* USAGE
*
* icingacli director export importsource [options]
*
* OPTIONS
*
* --no-pretty JSON is pretty-printed per default
* Use this flag to enforce unformatted JSON
*/
public function importsourceAction()
{
$export = new ImportExport($this->db());
echo $this->renderJson(
$export->serializeAllImportSources(),
!$this->params->shift('no-pretty')
);
}
/**
* Export all SyncRule definitions
*
* Use this command to delete a single Icinga object
*
* USAGE
*
* icingacli director syncrule export [options]
*
* OPTIONS
*
* --no-pretty JSON is pretty-printed per default
* Use this flag to enforce unformatted JSON
*/
public function syncruleAction()
{
$export = new ImportExport($this->db());
echo $this->renderJson(
$export->serializeAllSyncRules(),
!$this->params->shift('no-pretty')
);
}
/**
* Export all Job definitions
*
* USAGE
*
* icingacli director export job [options]
*
* OPTIONS
*
* --no-pretty JSON is pretty-printed per default
* Use this flag to enforce unformatted JSON
*/
public function jobAction()
{
$export = new ImportExport($this->db());
echo $this->renderJson(
$export->serializeAllJobs(),
!$this->params->shift('no-pretty')
);
}
/**
* Export all DataField definitions
*
* USAGE
*
* icingacli director export datafield [options]
*
* OPTIONS
*
* --no-pretty JSON is pretty-printed per default
* Use this flag to enforce unformatted JSON
*/
public function datafieldAction()
{
$export = new ImportExport($this->db());
echo $this->renderJson(
$export->serializeAllDataFields(),
!$this->params->shift('no-pretty')
);
}
/**
* Export all DataList definitions
*
* USAGE
*
* icingacli director export datafield [options]
*
* OPTIONS
*
* --no-pretty JSON is pretty-printed per default
* Use this flag to enforce unformatted JSON
*/
public function datalistAction()
{
$export = new ImportExport($this->db());
echo $this->renderJson(
$export->serializeAllDataLists(),
!$this->params->shift('no-pretty')
);
}
/**
* Export all IcingaHostGroup definitions
*
* USAGE
*
* icingacli director export hostgroup [options]
*
* OPTIONS
*
* --no-pretty JSON is pretty-printed per default
* Use this flag to enforce unformatted JSON
*/
public function hostgroupAction()
{
$export = new ImportExport($this->db());
echo $this->renderJson(
$export->serializeAllHostGroups(),
!$this->params->shift('no-pretty')
);
}
/**
* Export all IcingaServiceGroup definitions
*
* USAGE
*
* icingacli director export servicegroup [options]
*
* OPTIONS
*
* --no-pretty JSON is pretty-printed per default
* Use this flag to enforce unformatted JSON
*/
public function servicegroupAction()
{
$export = new ImportExport($this->db());
echo $this->renderJson(
$export->serializeAllServiceGroups(),
!$this->params->shift('no-pretty')
);
}
/**
* Export all IcingaTemplateChoiceHost definitions
*
* USAGE
*
* icingacli director export hosttemplatechoice [options]
*
* OPTIONS
*
* --no-pretty JSON is pretty-printed per default
* Use this flag to enforce unformatted JSON
*/
public function hosttemplatechoiceAction()
{
$export = new ImportExport($this->db());
echo $this->renderJson(
$export->serializeAllHostTemplateChoices(),
!$this->params->shift('no-pretty')
);
}
}

4
application/controllers/ImportsourceController.php
View File

@ -30,10 +30,6 @@ class ImportsourceController extends ActionController
public function indexAction()
{
$source = ImportSource::load($this->params->getRequired('id'), $this->db());
if ($this->params->get('format') === 'json') {
$this->sendJson($this->getResponse());
return;
}
$this->addTitle(
$this->translate('Import source: %s'),
$source->get('source_name')

7
library/Director/Data/Db/DbObjectWithSettings.php
View File

@ -42,13 +42,6 @@ abstract class DbObjectWithSettings extends DbObject
return parent::get($key);
}
public function setSettings(array $settings)
{
$this->settings = $settings;
return $this;
}
public function getSettings()
{
return $this->settings;

6
library/Director/Hook/JobHook.php
View File

@ -2,6 +2,7 @@
namespace Icinga\Module\Director\Hook;
use Icinga\Application\Logger;
use Icinga\Module\Director\Db;
use Icinga\Module\Director\Objects\DirectorJob;
use Icinga\Module\Director\Web\Form\QuickForm;
@ -52,11 +53,6 @@ abstract class JobHook
return $class;
}
public function exportSettings()
{
return $this->jobDefinition->getSettings();
}
public static function getSuggestedRunInterval(QuickForm $form)
{
return 900;

18
library/Director/Job/ImportJob.php
View File

@ -22,24 +22,6 @@ class ImportJob extends JobHook
}
}
public function exportSettings()
{
$settings = parent::exportSettings();
if (array_key_exists('source_id', $settings)) {
$id = $settings['source_id'];
if ($id !== '__ALL__') {
$settings['source'] = ImportSource::loadWithAutoIncId(
$id,
$this->db()
)->get('source_name');
}
unset($settings['source_id']);
}
return $settings;
}
protected function runForSource(ImportSource $source)
{
if ($this->getSetting('run_import') === 'y') {

14
library/Director/Job/SyncJob.php
View File

@ -24,20 +24,6 @@ class SyncJob extends JobHook
}
}
public function exportSettings()
{
$settings = [
'apply_changes' => $this->getSetting('apply_changes') === 'y'
];
$id = $this->getSetting('rule_id');
if ($id !== '__ALL__') {
$settings['rule'] = SyncRule::load((int) $id, $this->db())
->get('rule_name');
}
return $settings;
}
protected function runForRule(SyncRule $rule)
{
if ($this->getSetting('apply_changes') === 'y') {

18
library/Director/Objects/DirectorDatafield.php
View File

@ -50,24 +50,6 @@ class DirectorDatafield extends DbObjectWithSettings
return $obj;
}
public function export()
{
$plain = (object) $this->getProperties();
$plain->originalId = $plain->id;
unset($plain->id);
$plain->settings = (object) $this->getSettings();
if (property_exists($plain->settings, 'datalist_id')) {
$plain->settings->datalist = DirectorDatalist::loadWithAutoIncId(
$plain->settings->datalist_id,
$this->getConnection()
)->get('list_name');
unset($plain->settings->datalist_id);
}
return $plain;
}
protected function setObject(IcingaObject $object)
{
$this->object = $object;

19
library/Director/Objects/DirectorDatalist.php
View File

@ -17,23 +17,4 @@ class DirectorDatalist extends DbObject
'list_name' => null,
'owner' => null
);
public function export()
{
$plain = (object) $this->getProperties();
$plain->originalId = $plain->id;
unset($plain->id);
$plain->entries = [];
$entries = DirectorDatalistEntry::loadAllForList($this);
foreach ($entries as $key => $entry) {
$plainEntry = (object) $entry->getProperties();
unset($plainEntry->id);
unset($plainEntry->list_id);
$plain->entries[] = $plainEntry;
}
return $plain;
}
}

16
library/Director/Objects/DirectorDatalistEntry.php
View File

@ -22,22 +22,6 @@ class DirectorDatalistEntry extends DbObject
'allowed_roles' => null,
);
/**
* @param DirectorDatalist $list
* @return static[]
* @throws IcingaException
*/
public static function loadAllForList(DirectorDatalist $list)
{
$query = $list->getDb()
->select()
->from('director_datalist_entry')
->where('list_id = ?', $list->get('id'))
->order('entry_name ASC');
return static::loadAll($list->getConnection(), $query, 'entry_name');
}
/**
* @param $roles
* @throws IcingaException

88
library/Director/Objects/DirectorJob.php
View File

@ -2,7 +2,6 @@
namespace Icinga\Module\Director\Objects;
use Icinga\Exception\IcingaException;
use Icinga\Module\Director\Data\Db\DbObjectWithSettings;
use Icinga\Module\Director\Hook\JobHook;
use Exception;
@ -18,7 +17,7 @@ class DirectorJob extends DbObjectWithSettings
protected $autoincKeyName = 'id';
protected $defaultProperties = [
protected $defaultProperties = array(
'id' => null,
'job_name' => null,
'job_class' => null,
@ -29,40 +28,26 @@ class DirectorJob extends DbObjectWithSettings
'ts_last_error' => null,
'last_error_message' => null,
'timeperiod_id' => null,
];
protected $stateProperties = [
'last_attempt_succeeded',
'last_error_message',
'ts_last_attempt',
'ts_last_error',
];
);
protected $settingsTable = 'director_job_setting';
protected $settingsRemoteId = 'job_id';
/**
* @return JobHook
*/
public function job()
{
if ($this->job === null) {
$class = $this->job_class;
$this->job = new $class;
$this->job->setDb($this->connection);
$this->job->setDefinition($this);
}
return $this->job;
}
/**
* @throws IcingaException
*/
public function run()
{
$job = $this->job();
$job = $this->job()->setDefinition($this);
$this->ts_last_attempt = date('Y-m-d H:i:s');
try {
@ -79,21 +64,11 @@ class DirectorJob extends DbObjectWithSettings
}
}
/**
* @return bool
* @throws IcingaException
* @throws \Icinga\Exception\NotFoundError
*/
public function shouldRun()
{
return (! $this->hasBeenDisabled()) && $this->isPending();
}
/**
* @return bool
* @throws IcingaException
* @throws \Icinga\Exception\NotFoundError
*/
public function isOverdue()
{
if (! $this->shouldRun()) {
@ -110,11 +85,6 @@ class DirectorJob extends DbObjectWithSettings
return $this->disabled === 'y';
}
/**
* @return bool
* @throws IcingaException
* @throws \Icinga\Exception\NotFoundError
*/
public function isPending()
{
if ($this->ts_last_attempt === null) {
@ -128,11 +98,6 @@ class DirectorJob extends DbObjectWithSettings
return false;
}
/**
* @return bool
* @throws IcingaException
* @throws \Icinga\Exception\NotFoundError
*/
public function isWithinTimeperiod()
{
if ($this->hasTimeperiod()) {
@ -152,53 +117,6 @@ class DirectorJob extends DbObjectWithSettings
return $this->timeperiod_id !== null;
}
/**
* @param $timeperiod
* @return $this
* @throws IcingaException
*/
public function setTimeperiod($timeperiod)
{
if (is_string($timeperiod)) {
$timeperiod = IcingaTimePeriod::load($timeperiod, $this->connection);
} elseif (! $timeperiod instanceof IcingaTimePeriod) {
throw new IcingaException('TimePeriod expected');
}
$this->set('timeperiod_id', $timeperiod->get('id'));
return $this;
}
/**
* @return object
* @throws IcingaException
* @throws \Icinga\Exception\NotFoundError
* @throws \Icinga\Exception\ProgrammingError
*/
public function export()
{
$plain = (object) $this->getProperties();
$plain->originalId = $plain->id;
unset($plain->id);
unset($plain->timeperiod_id);
if ($this->hasTimeperiod()) {
$plain->timeperiod = $this->timeperiod()->getObjectName();
}
foreach ($this->stateProperties as $key) {
unset($plain->$key);
}
$plain->settings = $this->job()->exportSettings();
return $plain;
}
/**
* @return IcingaTimePeriod
* @throws IcingaException
* @throws \Icinga\Exception\NotFoundError
*/
protected function timeperiod()
{
return IcingaTimePeriod::loadWithAutoIncId($this->timeperiod_id, $this->connection);

34
library/Director/Objects/IcingaObject.php
View File

@ -2332,13 +2332,12 @@ abstract class IcingaObject extends DbObject implements IcingaConfigRenderer
public function getObjectName()
{
$property = static::getKeyColumnName();
if ($this->hasProperty($property)) {
return $this->get($property);
if ($this->hasProperty('object_name')) {
return $this->get('object_name');
} else {
// TODO: replace with an exception once finished
throw new ProgrammingError(
'Trying to access "%s" for an instance of "%s"',
$property,
'Trying to access "object_name" for an instance of "%s"',
get_class($this)
);
}
@ -2349,10 +2348,7 @@ abstract class IcingaObject extends DbObject implements IcingaConfigRenderer
// allow for icinga_host and host
$type = lcfirst(preg_replace('/^icinga_/', '', $type));
// Hint: Sync/Import are not IcingaObjects, this should be reconsidered:
if (strpos($type, 'import') === 0 || strpos($type, 'sync') === 0) {
$prefix = '';
} elseif (strpos($type, 'data') === false) {
if (strpos($type, 'data') === false) {
$prefix = 'Icinga';
} else {
$prefix = 'Director';
@ -2422,32 +2418,18 @@ abstract class IcingaObject extends DbObject implements IcingaConfigRenderer
return $class::exists($id, $db);
}
public static function getKeyColumnName()
{
return 'object_name';
}
public static function loadAllByType($type, Db $db, $query = null, $keyColumn = null)
public static function loadAllByType($type, Db $db, $query = null, $keyColumn = 'object_name')
{
/** @var DbObject $class */
$class = self::classByType($type);
if ($keyColumn === null) {
if (method_exists($class, 'getKeyColumnName')) {
$keyColumn = $class::getKeyColumnName();
}
}
if (is_array($class::create()->getKeyName())) {
return $class::loadAll($db, $query);
} else {
if (PrefetchCache::shouldBeUsed()
&& $query === null
&& $keyColumn === static::getKeyColumnName()
) {
if (PrefetchCache::shouldBeUsed() && $query === null && $keyColumn === 'object_name') {
$result = array();
foreach ($class::prefetchAll($db) as $row) {
$result[$row->$keyColumn] = $row;
$result[$row->object_name] = $row;
}
return $result;

28
library/Director/Objects/IcingaTemplateChoice.php
View File

@ -28,30 +28,6 @@ class IcingaTemplateChoice extends IcingaObject
return substr(substr($this->table, 0, -16), 7);
}
public function export()
{
$plain = (object) $this->getProperties();
$plain->originalId = $plain->id;
unset($plain->id);
$requiredId = $plain->required_template_id;
unset($plain->required_template_id);
if ($requiredId) {
$db = $this->getDb();
$query = $db->select()->from(
['o' => $this->getObjectTableName()],
['o.id', 'o.object_name']
)->where("o.object_type = 'template'")
->where('o.template_choice_id = ?', $this->get('id'))
->order('o.object_name');
return $db->fetchPairs($query);
}
$plain->members = array_values($this->getMembers());
return $plain;
}
public function isMainChoice()
{
return $this->hasBeenLoadedFromDb()
@ -158,9 +134,7 @@ class IcingaTemplateChoice extends IcingaObject
['o' => $this->getObjectTableName()],
['o.id', 'o.object_name']
)->where("o.object_type = 'template'")
->where('o.template_choice_id = ?', $this->get('id'))
->order('o.object_name');
->where('o.template_choice_id = ?', $this->get('id'));
return $db->fetchPairs($query);
} else {
return [];

13
library/Director/Objects/ImportRowModifier.php
View File

@ -51,19 +51,6 @@ class ImportRowModifier extends DbObjectWithSettings
return $this->hookInstance;
}
/**
* @return \stdClass
*/
public function export()
{
$properties = $this->getProperties();
unset($properties['id']);
unset($properties['source_id']);
$properties['settings'] = (object) $this->getSettings();
return (object) $properties;
}
protected function beforeStore()
{
if (! $this->hasBeenLoadedFromDb()) {

96
library/Director/Objects/ImportSource.php
View File

@ -6,7 +6,6 @@ use Icinga\Application\Benchmark;
use Icinga\Exception\ConfigurationError;
use Icinga\Exception\NotFoundError;
use Icinga\Module\Director\Data\Db\DbObjectWithSettings;
use Icinga\Module\Director\Db;
use Icinga\Module\Director\Hook\PropertyModifierHook;
use Icinga\Module\Director\Import\Import;
use Icinga\Module\Director\Import\SyncUtils;
@ -20,7 +19,7 @@ class ImportSource extends DbObjectWithSettings
protected $autoincKeyName = 'id';
protected $defaultProperties = [
protected $defaultProperties = array(
'id' => null,
'source_name' => null,
'provider_class' => null,
@ -29,13 +28,7 @@ class ImportSource extends DbObjectWithSettings
'last_error_message' => null,
'last_attempt' => null,
'description' => null,
];
protected $stateProperties = [
'import_state',
'last_error_message',
'last_attempt',
];
);
protected $settingsTable = 'import_source_setting';
@ -43,70 +36,6 @@ class ImportSource extends DbObjectWithSettings
private $rowModifiers;
/**
* @return \stdClass
*/
public function export()
{
$plain = (object) $this->getProperties();
$plain->originalId = $plain->id;
unset($plain->id);
foreach ($this->stateProperties as $key) {
unset($plain->$key);
}
$plain->settings = (object) $this->getSettings();
$plain->modifiers = $this->exportRowModifiers();
return $plain;
}
public static function import($plain, Db $db, $replace = false)
{
$properties = (array) $plain;
$id = $properties['originalId'];
unset($properties['originalId']);
if (static::existsWithNameAndId($properties['source_name'], $id, $db)) {
$object = static::loadWithAutoIncId($id, $db);
} else {
$object = static::create([], $db);
}
$object->importPropertyModifiers($properties['modifiers']);
unset($properties['modifiers']);
$object->setProperties($properties);
return $object;
}
protected function importPropertyModifiers($modifiers)
{
}
protected static function existsWithNameAndId($name, $id, Db $connection)
{
$db = $connection->getDbAdapter();
return (string) $id === (string) $db->fetchOne(
$db->select()
->from('import_source', 'id')
->where('id = ?', $id)
->where('name = ?', $name)
);
}
protected function exportRowModifiers()
{
$modifiers = [];
foreach ($this->fetchRowModifiers() as $modifier) {
$modifiers[] = $modifier->export();
}
return $modifiers;
}
/**
* @param bool $required
* @return ImportRun|null
@ -133,7 +62,7 @@ class ImportSource extends DbObjectWithSettings
$db = $this->getDb();
$query = $db->select()->from(
['ir' => 'import_run'],
array('ir' => 'import_run'),
'ir.id'
)->where('ir.source_id = ?', $this->id)
->where('ir.start_time < ?', date('Y-m-d H:i:s', $timestamp))
@ -190,16 +119,6 @@ class ImportSource extends DbObjectWithSettings
return $this;
}
public function getObjectName()
{
return $this->get('source_name');
}
public static function getKeyColumnName()
{
return 'source_name';
}
protected function applyPropertyModifierToRow(PropertyModifierHook $modifier, $key, $row)
{
if ($modifier->requiresRow()) {
@ -247,9 +166,6 @@ class ImportSource extends DbObjectWithSettings
return count($this->getRowModifiers()) > 0;
}
/**
* @return ImportRowModifier[]
*/
public function fetchRowModifiers()
{
$db = $this->getDb();
@ -277,11 +193,11 @@ class ImportSource extends DbObjectWithSettings
protected function prepareRowModifiers()
{
$modifiers = [];
$modifiers = array();
foreach ($this->fetchRowModifiers() as $mod) {
if (! array_key_exists($mod->property_name, $modifiers)) {
$modifiers[$mod->property_name] = [];
$modifiers[$mod->property_name] = array();
}
$modifiers[$mod->property_name][] = $mod->getInstance();
@ -292,7 +208,7 @@ class ImportSource extends DbObjectWithSettings
public function listModifierTargetProperties()
{
$list = [];
$list = array();
foreach ($this->getRowModifiers() as $rowMods) {
/** @var PropertyModifierHook $mod */
foreach ($rowMods as $mod) {

58
library/Director/Objects/SyncRule.php
View File

@ -17,7 +17,7 @@ class SyncRule extends DbObject
protected $autoincKeyName = 'id';
protected $defaultProperties = [
protected $defaultProperties = array(
'id' => null,
'rule_name' => null,
'object_type' => null,
@ -28,13 +28,7 @@ class SyncRule extends DbObject
'last_error_message' => null,
'last_attempt' => null,
'description' => null,
];
protected $stateProperties = [
'import_state',
'last_error_message',
'last_attempt',
];
);
private $sync;
@ -57,15 +51,15 @@ class SyncRule extends DbObject
public function listInvolvedSourceIds()
{
if (! $this->hasBeenLoadedFromDb()) {
return [];
return array();
}
$db = $this->getDb();
return array_map('intval', array_unique(
$db->fetchCol(
$db->select()
->from(['p' => 'sync_property'], 'p.source_id')
->join(['s' => 'import_source'], 's.id = p.source_id', array())
->from(array('p' => 'sync_property'), 'p.source_id')
->join(array('s' => 'import_source'), 's.id = p.source_id', array())
->where('rule_id = ?', $this->get('id'))
->order('s.source_name')
)
@ -74,7 +68,7 @@ class SyncRule extends DbObject
public function fetchInvolvedImportSources()
{
$sources = [];
$sources = array();
foreach ($this->listInvolvedSourceIds() as $sourceId) {
$sources[$sourceId] = ImportSource::load($sourceId, $this->getConnection());
@ -91,7 +85,7 @@ class SyncRule extends DbObject
$db = $this->getDb();
$query = $db->select()->from(
['sr' => 'sync_run'],
array('sr' => 'sync_run'),
'sr.start_time'
)->where('sr.rule_id = ?', $this->get('id'))
->order('sr.start_time DESC')
@ -108,7 +102,7 @@ class SyncRule extends DbObject
$db = $this->getDb();
$query = $db->select()->from(
['sr' => 'sync_run'],
array('sr' => 'sync_run'),
'sr.id'
)->where('sr.rule_id = ?', $this->get('id'))
->order('sr.start_time DESC')
@ -240,40 +234,6 @@ class SyncRule extends DbObject
}
}
public function export()
{
$plain = (object) $this->getProperties();
$plain->originalId = $plain->id;
unset($plain->id);
foreach ($this->stateProperties as $key) {
unset($plain->$key);
}
$plain->properties = $this->exportSyncProperties();
return $plain;
}
public function exportSyncProperties()
{
$all = [];
$db = $this->getDb();
$sourceNames = $db->fetchPairs(
$db->select()->from('import_source', ['id', 'source_name'])
);
foreach ($this->getSyncProperties() as $property) {
$properties = $property->getProperties();
$properties['source'] = $sourceNames[$properties['source_id']];
unset($properties['id']);
unset($properties['rule_id']);
unset($properties['source_id']);
$all[] = (object) $properties;
}
return $all;
}
/**
* Whether we have a combined key (e.g. services on hosts)
*
@ -385,7 +345,7 @@ class SyncRule extends DbObject
public function getSyncProperties()
{
if (! $this->hasBeenLoadedFromDb()) {
return [];
return array();
}
if ($this->syncProperties === null) {