From c155a8330c25b583a12e4c574c5007277f1cf401 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Thu, 20 Jun 2013 13:47:51 +0200 Subject: [PATCH 01/46] Add SystemPermissionException This exception should be fired when the OS restricts the web user from executing certain actions. Also the template for errors has been modified so it displays the action and the target that was prevented. refs #4092 --- application/controllers/ErrorController.php | 3 +-- application/views/scripts/error/error.phtml | 11 ++++++++-- .../Exception/SystemPermissionException.php | 22 +++++++++++++++++++ 3 files changed, 32 insertions(+), 4 deletions(-) create mode 100644 library/Icinga/Exception/SystemPermissionException.php diff --git a/application/controllers/ErrorController.php b/application/controllers/ErrorController.php index efcc20e9b..c523bb77f 100755 --- a/application/controllers/ErrorController.php +++ b/application/controllers/ErrorController.php @@ -34,7 +34,6 @@ class ErrorController extends ActionController $this->view->message = 'Application error'; break; } - // conditionally display exceptions if ($this->getInvokeArg('displayExceptions') == true) { $this->view->exception = $errors->exception; @@ -44,4 +43,4 @@ class ErrorController extends ActionController } } -// @codingStandardsIgnoreEnd \ No newline at end of file +// @codingStandardsIgnoreEnd diff --git a/application/views/scripts/error/error.phtml b/application/views/scripts/error/error.phtml index 9ae6ecd1f..b5cfcddcb 100755 --- a/application/views/scripts/error/error.phtml +++ b/application/views/scripts/error/error.phtml @@ -9,8 +9,15 @@

Exception information:

-

- Message: exception->getMessage() ?> +

+ Message: exception->getMessage() ?> + exception->action)): ?> +
Action: exception->action; ?> + + exception->action)): ?> +
Target: exception->target; ?> + +

Stack trace:

diff --git a/library/Icinga/Exception/SystemPermissionException.php b/library/Icinga/Exception/SystemPermissionException.php new file mode 100644 index 000000000..02849ec34 --- /dev/null +++ b/library/Icinga/Exception/SystemPermissionException.php @@ -0,0 +1,22 @@ +action = $action; + $this->target = $target; + } +} From 076b8a9af934e4a33db2dd42864f8746970cb426 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Thu, 20 Jun 2013 14:02:58 +0200 Subject: [PATCH 02/46] Add rule for 'body' container and QLink property 'target' QLinks can now define the target for their link. Additionally, the targte 'body' is now always the tag. This allows the modulemanager to reload the whole page (with the navigation bar). refs #4092 --- .../layouts/scripts/just-the-body.phtml | 8 --- application/layouts/scripts/layout.phtml | 4 +- .../layouts/scripts/parts/navigation.phtml | 3 +- application/views/helpers/Qlink.php | 5 +- public/js/icinga/modules/mainDetail.js | 71 ++++++++++--------- public/js/icinga/util/async.js | 8 +-- 6 files changed, 49 insertions(+), 50 deletions(-) diff --git a/application/layouts/scripts/just-the-body.phtml b/application/layouts/scripts/just-the-body.phtml index e243e63ed..ee29c44e6 100755 --- a/application/layouts/scripts/just-the-body.phtml +++ b/application/layouts/scripts/just-the-body.phtml @@ -12,14 +12,6 @@
-
- - - - - - -
diff --git a/application/layouts/scripts/layout.phtml b/application/layouts/scripts/layout.phtml index cfe89626c..d70627d1b 100755 --- a/application/layouts/scripts/layout.phtml +++ b/application/layouts/scripts/layout.phtml @@ -21,12 +21,12 @@ ICINGA_DEBUG = true; - + - + render('parts/topbar.phtml') ?>
diff --git a/application/layouts/scripts/parts/navigation.phtml b/application/layouts/scripts/parts/navigation.phtml index 1184d1830..e7de8f369 100755 --- a/application/layouts/scripts/parts/navigation.phtml +++ b/application/layouts/scripts/parts/navigation.phtml @@ -5,7 +5,8 @@ $item = $this->navigation->listAll("menu"); ?> -auth()->isAuthenticated()): ?> +auth()->isAuthenticated()): ?> +
    view->baseUrl($url) : $baseUrl . $url; } } -// @codingStandardsIgnoreEnd \ No newline at end of file +// @codingStandardsIgnoreEnd diff --git a/public/js/icinga/modules/mainDetail.js b/public/js/icinga/modules/mainDetail.js index 9a207c933..368c5c5f7 100755 --- a/public/js/icinga/modules/mainDetail.js +++ b/public/js/icinga/modules/mainDetail.js @@ -16,45 +16,52 @@ define(['jquery','logging','icinga/util/async'],function($,log,async) { href = a.attr("href"); ev.stopImmediatePropagation(); collapseDetailView(); + async.loadToTarget("icinga-main",href); + return false; +}; + +var onLinkTagClick = function(ev) { + + var a = $(ev.currentTarget), + target = a.attr("target"), + href = a.attr("href"); + + // check for protocol:// + if(/^[A-Z]{2,10}\:\/\//i.test(href)) { + window.open(href); + ev.stopImmediatePropagation(); + return false; + } + + // check for link in table header + if(a.parents('th').length > 0) { + ev.stopImmediatePropagation(); + return false; + } + + if(typeof target === "undefined") { + if(a.parents("#icinga-detail").length) { + log.debug("Parent is detail, loading into detail"); + async.loadToTarget("icinga-detail",href); + } else { + log.debug("Parent is not detail, loading into main"); async.loadToTarget("icinga-main",href); - return false; - }; - - var onLinkTagClick = function(ev) { - - var a = $(ev.currentTarget), - target = a.attr("target"), - href = a.attr("href"); - - // check for protocol:// - if(/^[A-Z]{2,10}\:\/\//i.test(href)) { - window.open(href); - ev.stopImmediatePropagation(); - return false; - } - - // check for link in table header - if(a.parents('th').length > 0) { - ev.stopImmediatePropagation(); - return false; - } - - if(typeof target === "undefined") { - if(a.parents("#icinga-detail").length) { - async.loadToTarget("icinga-detail",href); - } else { - async.loadToTarget("icinga-main",href); - } - } else { - switch(target) { + } + } else { + switch(target) { + case "body": + async.loadToTarget("body", href); + break; case "main": async.loadToTarget("icinga-main",href); collapseDetailView(); break; case "detail": + log.debug("Target: detail"); async.loadToTarget("icinga-detail",href); break; case "popup": + log.debug("No target"); async.loadToTarget(null,href); break; default: @@ -67,7 +74,7 @@ define(['jquery','logging','icinga/util/async'],function($,log,async) { var expandDetailView = function() { $("#icinga-detail").parents(".collapsed").removeClass('collapsed'); - }; + }; var collapseDetailView = function(elementInDetailView) { $("#icinga-detail").parents(".layout-main-detail").addClass('collapsed'); @@ -88,7 +95,5 @@ define(['jquery','logging','icinga/util/async'],function($,log,async) { } }; }; - return new MainDetailBehaviour(); }); - diff --git a/public/js/icinga/util/async.js b/public/js/icinga/util/async.js index efab52ed7..8e015b45a 100644 --- a/public/js/icinga/util/async.js +++ b/public/js/icinga/util/async.js @@ -5,11 +5,9 @@ define(['icinga/container','logging','icinga/behaviour','jquery'],function(containerMgr,log,behaviour,$) { - var pending = { }; - var getDOMForDestination = function(destination) { var target = destination; if(typeof destination === "string") { @@ -84,13 +82,14 @@ this.loadToTarget = function(destination,url,data) { if(destination) { + log.debug("Laoding to container", destination, url); this.clearPendingRequestsFor(destination); } var req = this.createRequest(url,data); if(destination) { pending.push({ request: req, - DOM: getDOMForDestination(destination) + DOM: getDOMForDestination(destination) }); req.destination = destination; } @@ -105,5 +104,4 @@ }; return new CallInterface(); }); - -})(); \ No newline at end of file +})(); From fd489484e13261425d972522668b6c6774af8697 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Thu, 20 Jun 2013 14:06:02 +0200 Subject: [PATCH 03/46] Move ModuleController from incubator The Notification dependency is removed and uses exceptions now, otherwise it's mostly the same like in the incubator refs #4092 --- application/controllers/ModulesController.php | 47 ++++++++++++++ application/views/scripts/inline.phtml | 3 + .../views/scripts/mixedPagination.phtml | 61 +++++++++++++++++++ .../views/scripts/modules/overview.phtml | 38 ++++++++++++ application/views/scripts/modules/show.phtml | 24 ++++++++ .../Application/ApplicationBootstrap.php | 3 +- .../Icinga/Application/Modules/Manager.php | 54 +++++++++++----- public/js/icinga/container.js | 7 ++- public/js/icinga/util/async.js | 4 +- 9 files changed, 221 insertions(+), 20 deletions(-) create mode 100755 application/controllers/ModulesController.php create mode 100644 application/views/scripts/inline.phtml create mode 100755 application/views/scripts/mixedPagination.phtml create mode 100644 application/views/scripts/modules/overview.phtml create mode 100644 application/views/scripts/modules/show.phtml diff --git a/application/controllers/ModulesController.php b/application/controllers/ModulesController.php new file mode 100755 index 000000000..f8f40a3b3 --- /dev/null +++ b/application/controllers/ModulesController.php @@ -0,0 +1,47 @@ +manager = Icinga::app()->moduleManager(); + } + + public function indexAction() + { + $this->view->modules = $this->manager->select() + ->from('modules') + ->order('name'); + $this->render('overview'); + } + + public function overviewAction() + { + $this->indexAction(); + + } + + public function enableAction() + { + $this->manager->enableModule($this->_getParam('name')); + $this->redirectNow('modules/overview?_render=body'); + } + + public function disableAction() + { + $this->manager->disableModule($this->_getParam('name')); + $this->redirectNow('modules/overview?_render=body'); + } + +} diff --git a/application/views/scripts/inline.phtml b/application/views/scripts/inline.phtml new file mode 100644 index 000000000..24e5f00ce --- /dev/null +++ b/application/views/scripts/inline.phtml @@ -0,0 +1,3 @@ +layout()->moduleStart ?> +layout()->content ?> +layout()->moduleEnd ?> diff --git a/application/views/scripts/mixedPagination.phtml b/application/views/scripts/mixedPagination.phtml new file mode 100755 index 000000000..7b2b23570 --- /dev/null +++ b/application/views/scripts/mixedPagination.phtml @@ -0,0 +1,61 @@ +pageCount > 1): ?> +preserve)) { + $preserve = $this->preserve; +} else { + $preserve = array(); +} + +$fromto = t('%d to %d of %d'); +$total = $this->totalItemCount; +?> + + diff --git a/application/views/scripts/modules/overview.phtml b/application/views/scripts/modules/overview.phtml new file mode 100644 index 000000000..cc651c78f --- /dev/null +++ b/application/views/scripts/modules/overview.phtml @@ -0,0 +1,38 @@ +modules->limit(10); +$modules = $this->modules->paginate(); + +?> +

    Installed Modules

    +paginationControl($modules, null, null, array( + 'preserve' => $this->preserve +)); ?> + + + + + + + + +
    +enabled): ?> + qlink( + $module->name, + 'modules/disable', + array('name' => $module->name), + array('target'=>'body') + ) ?> + + qlink( + $module->name, + 'modules/enable', + array('name' => $module->name), + array('target'=>'body') + ) ?> + + (enabled + ? ($module->loaded ? 'enabled' : 'failed') + : 'disabled' + ?>)
    diff --git a/application/views/scripts/modules/show.phtml b/application/views/scripts/modules/show.phtml new file mode 100644 index 000000000..38d5cf050 --- /dev/null +++ b/application/views/scripts/modules/show.phtml @@ -0,0 +1,24 @@ +container('modules-container',array( + "class" => "expanded_absolute" +))->beginContent() ?> + + + + + + + + + + modules as $module): ?> + + + + + + + + +
    ModuleTypeActive
    + + \ No newline at end of file diff --git a/library/Icinga/Application/ApplicationBootstrap.php b/library/Icinga/Application/ApplicationBootstrap.php index dc40cb646..715850ee5 100755 --- a/library/Icinga/Application/ApplicationBootstrap.php +++ b/library/Icinga/Application/ApplicationBootstrap.php @@ -18,6 +18,7 @@ use Icinga\Exception\ConfigurationError; * Usage example for CLI: * * use Icinga\Application\Cli; + * Cli::start(); * * @@ -99,7 +100,7 @@ abstract class ApplicationBootstrap public function moduleManager() { if ($this->moduleManager === null) { - $this->moduleManager = new ModuleManager($this); + $this->moduleManager = new ModuleManager($this, "/etc/icinga2/modules_enabled"); } return $this->moduleManager; } diff --git a/library/Icinga/Application/Modules/Manager.php b/library/Icinga/Application/Modules/Manager.php index 45f4c89aa..4061a2421 100644 --- a/library/Icinga/Application/Modules/Manager.php +++ b/library/Icinga/Application/Modules/Manager.php @@ -6,6 +6,7 @@ use Icinga\Application\ApplicationBootstrap; use Icinga\Data\ArrayDatasource; use Icinga\Web\Notification; use Icinga\Exception\ConfigurationError; +use Icinga\Exception\SystemPermissionException; // TODO: show whether enabling/disabling modules is allowed by checking enableDir // perms @@ -20,17 +21,20 @@ class Manager protected $enableDir; - public function __construct(ApplicationBootstrap $app) + public function __construct(ApplicationBootstrap $app, $dir = null) { $this->app = $app; - $this->prepareEssentials(); + if ($dir === null) { + $dir = $this->app->getConfig()->getConfigDir() + . '/enabledModules'; + } + $this->prepareEssentials($dir); $this->detectEnabledModules(); } - protected function prepareEssentials() + protected function prepareEssentials($moduleDir) { - $this->enableDir = $this->app->getConfig()->getConfigDir() - . '/enabledModules'; + $this->enableDir = $moduleDir; if (! file_exists($this->enableDir) || ! is_dir($this->enableDir)) { throw new ProgrammingError( @@ -99,13 +103,20 @@ class Manager $target = $this->installedBaseDirs[$name]; $link = $this->enableDir . '/' . $name; if (! is_writable($this->enableDir)) { - Notification::error("I do not have permissions to enable modules"); + throw new SystemPermissionException( + "Insufficient system permissions for enabling modules", + "write", + $this->enableDir + ); + } + if (file_exists($link) && is_link($link)) { return $this; } - if (@symlink($target, $link)) { - Notification::success("The module $name has been enabled"); - } else { - Notification::error("Enabling module $name failed"); + if (!@symlink($target, $link)) { + $error = error_get_last(); + if (strstr($error["message"], "File exists") === false) { + throw new SystemPermissionException($error["message"], "symlink", $link); + } } return $this; } @@ -116,16 +127,29 @@ class Manager return $this; } if (! is_writable($this->enableDir)) { - Notification::error("I do not have permissions to disable modules"); + throw new SystemPermissionException("Can't write the module directory", "write", $this->enableDir); return $this; } $link = $this->enableDir . '/' . $name; + if (!file_exists($link)) { + throw new ConfigurationError("The module $name could not be found, can't disable it"); + } + if (!is_link($link)) { + throw new ConfigurationError( + "The module $name can't be disabled as this would delete the whole module. ". + "It looks like you have installed this module manually and moved it to your module folder.". + "In order to dynamically enable and disable modules, you have to create a symlink to ". + "the enabled_modules folder" + ); + } + if (file_exists($link) && is_link($link)) { - if (@unlink($link)) { - Notification::success("The module $name has been disabled"); - } else { - Notification::error("Disabling module $name failed"); + if (!@unlink($link)) { + $error = error_get_last(); + throw new SystemPermissionException($error["message"], "unlink", $link); } + } else { + } return $this; } diff --git a/public/js/icinga/container.js b/public/js/icinga/container.js index a64075b94..08d60f047 100755 --- a/public/js/icinga/container.js +++ b/public/js/icinga/container.js @@ -24,7 +24,7 @@ this.updateContainer = function(id,content,req) { var target = id; if (typeof id === "string") { - target = $('div[container-id='+id+']'); + target = this.getContainer(id); } var ctrl = $('.container-controls',target); target.html(content); @@ -100,6 +100,9 @@ }; this.getContainer = function(id) { + if(id == 'body') { + return $(document.body); + } return $('div[container-id='+id+']'); }; @@ -111,4 +114,4 @@ return containerMgrInstance; }); -})(); \ No newline at end of file +})(); diff --git a/public/js/icinga/util/async.js b/public/js/icinga/util/async.js index 8e015b45a..15a6be7df 100644 --- a/public/js/icinga/util/async.js +++ b/public/js/icinga/util/async.js @@ -10,7 +10,7 @@ }; var getDOMForDestination = function(destination) { var target = destination; - if(typeof destination === "string") { + if (typeof destination === "string") { target = containerMgr.getContainer(destination)[0]; } else if(typeof destination.context !== "undefined") { target = destination[0]; @@ -89,7 +89,7 @@ if(destination) { pending.push({ request: req, - DOM: getDOMForDestination(destination) + DOM: getDOMForDestination(destination) }); req.destination = destination; } From c72fa101ed2fefe73952a8dc13617ed1bcd038be Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Thu, 20 Jun 2013 17:01:13 +0200 Subject: [PATCH 04/46] Add clearstatcache and tests for ModuleManager Added the clearstatcache call before enabling or disabling modules, as this prevents a 'File exists' error that occurs sometimes on symlink creation (even when the folder is empty). Also added tests for teh moduleManager refs #4092 --- .../Icinga/Application/Modules/Manager.php | 76 +++++++----- .../Icinga/Application/Modules/Manager.php | 111 ++++++++++++++++++ 2 files changed, 157 insertions(+), 30 deletions(-) create mode 100644 test/php/library/Icinga/Application/Modules/Manager.php diff --git a/library/Icinga/Application/Modules/Manager.php b/library/Icinga/Application/Modules/Manager.php index 4061a2421..f4612de7f 100644 --- a/library/Icinga/Application/Modules/Manager.php +++ b/library/Icinga/Application/Modules/Manager.php @@ -2,33 +2,39 @@ namespace Icinga\Application\Modules; -use Icinga\Application\ApplicationBootstrap; -use Icinga\Data\ArrayDatasource; -use Icinga\Web\Notification; use Icinga\Exception\ConfigurationError; use Icinga\Exception\SystemPermissionException; +use Icinga\Exception\ProgrammingError; // TODO: show whether enabling/disabling modules is allowed by checking enableDir // perms class Manager { - protected $installedBaseDirs; + protected $installedBaseDirs = null; protected $enabledDirs = array(); protected $loadedModules = array(); protected $index; protected $app; - protected $enableDir; - - public function __construct(ApplicationBootstrap $app, $dir = null) + protected $modulePaths = array(); + /** + * @param $app : The applicaiton bootstrap. This one needs a properly defined interface + * In order to test it correctly, the application now only requires a stdClass + * @param $dir : + **/ + public function __construct($app, $enabledDir = null, array $availableDirs = array()) { $this->app = $app; - if ($dir === null) { - $dir = $this->app->getConfig()->getConfigDir() + if (empty($availableDirs)) { + $availableDirs = array(ICINGA_APPDIR."/../modules"); + } + $this->modulePaths = $availableDirs; + if ($enabledDir === null) { + $enabledDir = $this->app->getConfig()->getConfigDir() . '/enabledModules'; } - $this->prepareEssentials($dir); + $this->prepareEssentials($enabledDir); $this->detectEnabledModules(); } @@ -46,10 +52,17 @@ class Manager } } + public function select() + { + $source = new \Icinga\Data\ArrayDataSource($this->getModuleInfo()); + return $source->select(); + } + protected function detectEnabledModules() { $fh = opendir($this->enableDir); + $this->enabledDirs = array(); while (false !== ($file = readdir($fh))) { if ($file[0] === '.') { @@ -78,12 +91,18 @@ class Manager return $this; } - public function loadModule($name) + public function loadModule($name, $moduleBase = null) { if ($this->hasLoaded($name)) { return $this; } - $module = new Module($this->app, $name, $this->getModuleDir($name)); + + $module = null; + if ($moduleBase === null) { + $module = new Module($this->app, $name, $this->getModuleDir($name)); + } else { + $module = new $moduleBase($this->app, $name, $this->getModuleDir($name)); + } $module->register(); $this->loadedModules[$name] = $module; return $this; @@ -100,6 +119,7 @@ class Manager ); return $this; } + clearstatcache(true); $target = $this->installedBaseDirs[$name]; $link = $this->enableDir . '/' . $name; if (! is_writable($this->enableDir)) { @@ -118,6 +138,7 @@ class Manager throw new SystemPermissionException($error["message"], "symlink", $link); } } + $this->enabledDirs[$name] = $link; return $this; } @@ -151,6 +172,7 @@ class Manager } else { } + unset($this->enabledDirs[$name]); return $this; } @@ -228,12 +250,6 @@ class Manager return $info; } - public function select() - { - $ds = new ArrayDatasource($this->getModuleInfo()); - return $ds->select(); - } - public function listEnabledModules() { return array_keys($this->enabledDirs); @@ -254,19 +270,19 @@ class Manager public function detectInstalledModules() { - // TODO: Allow multiple paths for installed modules (e.g. web vs pkg) - $basedir = realpath(ICINGA_APPDIR . '/../modules'); - $fh = @opendir($basedir); - if ($fh === false) { - return $this; - } - - while ($name = readdir($fh)) { - if ($name[0] === '.') { - continue; + foreach ($this->modulePaths as $basedir) { + $fh = opendir($basedir); + if ($fh === false) { + return $this; } - if (is_dir($basedir . '/' . $name)) { - $this->installedBaseDirs[$name] = $basedir . '/' . $name; + + while ($name = readdir($fh)) { + if ($name[0] === '.') { + continue; + } + if (is_dir($basedir . '/' . $name)) { + $this->installedBaseDirs[$name] = $basedir . '/' . $name; + } } } } diff --git a/test/php/library/Icinga/Application/Modules/Manager.php b/test/php/library/Icinga/Application/Modules/Manager.php new file mode 100644 index 000000000..24d2a8c25 --- /dev/null +++ b/test/php/library/Icinga/Application/Modules/Manager.php @@ -0,0 +1,111 @@ +name = $name; + $this->dir = $dir; + } + + public function register() + { + } +} + + +class ManagerTest extends \PHPUnit_Framework_TestCase +{ + const MODULE_TARGET = "/tmp"; + + protected function setUp() + { + $moduleDir = self::MODULE_TARGET; + if (!is_writable($moduleDir)) { + $this->markTestSkipped("Temporary folder not writable for this user"); + return; + } + if (is_dir($moduleDir."/enabledModules")) { + exec("rm -r $moduleDir/enabledModules"); + } + + mkdir($moduleDir."/enabledModules"); + } + + public function testDetectEnabledModules() + { + $manager = new ModuleManager(null, "/tmp/enabledModules", array("none")); + $this->assertEmpty($manager->listEnabledModules()); + + symlink(getcwd()."/res/testModules/module1", "/tmp/enabledModules/module1"); + $manager = new ModuleManager(null, "/tmp/enabledModules", array("none")); + $this->assertEquals(array("module1"), $manager->listEnabledModules()); + symlink(getcwd()."/res/testModules/module2", "/tmp/enabledModules/module2"); + symlink(getcwd()."/res/???", "/tmp/enabledModules/module3"); + $manager = new ModuleManager(null, "/tmp/enabledModules", array("none")); + $this->assertEquals(array("module1", "module2"), $manager->listEnabledModules()); + } + + public function testLoadModule() + { + $manager = new ModuleManager(null, "/tmp/enabledModules", array("./res/testModules")); + $this->assertEmpty($manager->getLoadedModules()); + $manager->loadModule("module1", "Tests\Icinga\Application\Module\Manager\ModuleMock"); + $elems = $manager->getLoadedModules(); + $this->assertNotEmpty($elems); + $this->assertTrue(isset($elems["module1"])); + // assert the changes not to be permanent: + $manager = new ModuleManager(null, "/tmp/enabledModules", array("./res/testModules")); + $this->assertEmpty($manager->getLoadedModules()); + } + + public function testEnableModule() + { + $manager = new ModuleManager(null, "/tmp/enabledModules", array(getcwd()."/res/testModules")); + $this->assertEmpty($manager->listEnabledModules()); + $manager->enableModule("module1"); + $elems = $manager->listEnabledModules(); + $this->assertNotEmpty($elems); + $this->assertEquals($elems[0], "module1"); + $this->assertTrue(is_link("/tmp/enabledModules/module1")); + // assert the changes to be permanent: + $manager = new ModuleManager(null, "/tmp/enabledModules", array("./res/testModules")); + $this->assertNotEmpty($manager->listEnabledModules()); + } + + public function testDisableModule() + { + clearstatcache(true); + symlink(getcwd()."/res/testModules/module1", "/tmp/enabledModules/module1"); + $manager = new ModuleManager(null, "/tmp/enabledModules", array(getcwd()."/res/testModules")); + $elems = $manager->listEnabledModules(); + $this->assertNotEmpty($elems); + $this->assertEquals($elems[0], "module1"); + $manager->disableModule("module1"); + $this->assertFalse(file_exists("/tmp/enabledModules/module1")); + $this->assertEmpty($manager->listEnabledModules()); + // assert the changes to be permanent: + $manager = new ModuleManager(null, "/tmp/enabledModules", array("./res/testModules")); + $this->assertEmpty($manager->listEnabledModules()); + } + + protected function tearDown() + { + $moduleDir = self::MODULE_TARGET; + exec("rm -r $moduleDir/enabledModules"); + + } +} From c40c1dabc77e07087b276e195a84f561048dbe30 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Fri, 21 Jun 2013 09:53:37 +0200 Subject: [PATCH 05/46] Remove moved files the 'behaviour' namespace in javascript has been renamed to module refs #4092 --- public/js/icinga/behaviour/actionTable.js | 118 ---------------------- public/js/icinga/behaviour/mainDetail.js | 94 ----------------- 2 files changed, 212 deletions(-) delete mode 100644 public/js/icinga/behaviour/actionTable.js delete mode 100755 public/js/icinga/behaviour/mainDetail.js diff --git a/public/js/icinga/behaviour/actionTable.js b/public/js/icinga/behaviour/actionTable.js deleted file mode 100644 index e8e61952b..000000000 --- a/public/js/icinga/behaviour/actionTable.js +++ /dev/null @@ -1,118 +0,0 @@ -/*global Icinga:false, document: false, define:false require:false base_url:false console:false */ - -/** - * ActionTable behaviour as described in - * https://wiki.icinga.org/display/cranberry/Frontend+Components#FrontendComponents-ActionTable - * - * @TODO: Row selection - */ -define(['jquery','logging','icinga/util/async'],function($,log,async) { - "use strict"; - - var ActionTableBehaviour = function() { - var onTableHeaderClick; - - var TABLE_BASE_MATCHER = '.icinga-container table.action'; - var linksInActionTable = TABLE_BASE_MATCHER+" tbody tr > a"; - var actionTableRow = TABLE_BASE_MATCHER+" tbody tr"; - var headerRow = TABLE_BASE_MATCHER+" > th a"; - var searchField = ".icinga-container .actiontable.controls input[type=search]"; - - - onTableHeaderClick = function (ev) { - var target = ev.currentTarget, - href = $(target).attr('href'), - destination; - if ($(target).parents('.layout-main-detail').length) { - if ($(target).parents("#icinga-main").length) { - destination = 'icinga-main'; - } - else { - destination = 'icinga-detail'; - } - - } else { - destination = 'icinga-main'; - } - async.loadToTarget(destination, href); - ev.preventDefault(); - ev.stopImmediatePropagation(); - return false; - }; - - var onLinkTagClick = function(ev) { - - var target = ev.currentTarget, - href = $(target).attr('href'), - destination; - if ($(target).parents('.layout-main-detail').length) { - destination = 'icinga-detail'; - } else { - destination = 'icinga-main'; - } - async.loadToTarget(destination,href); - ev.preventDefault(); - ev.stopImmediatePropagation(); - return false; - - }; - - var onTableRowClick = function(ev) { - ev.stopImmediatePropagation(); - - var target = $(ev.currentTarget), - href = target.attr('href'), - destination; - $('tr.active',target.parent('tbody').first()).removeClass("active"); - target.addClass('active'); - - // When the tr has a href, act like it is a link - if(href) { - ev.currentTarget = target.first(); - return onLinkTagClick(ev); - } - // Try to find a designated row action - var links = $("a.row-action",target); - if(links.length) { - ev.currentTarget = links.first(); - return onLinkTagClick(ev); - } - - // otherwise use the first anchor tag - links = $("a",target); - if(links.length) { - ev.currentTarget = links.first(); - return onLinkTagClick(ev); - } - - log.debug("No target for this table row found"); - return false; - }; - - var onSearchInput = function(ev) { - ev.stopImmediatePropagation(); - var txt = $(this).val(); - }; - - this.eventHandler = {}; - this.eventHandler[linksInActionTable] = { - 'click' : onLinkTagClick - }; - this.eventHandler[actionTableRow] = { - 'click' : onTableRowClick - }; - this.eventHandler[headerRow] = { - 'click' : onTableHeaderClick - }; - this.eventHandler[searchField] = { - 'keyup' : onSearchInput - }; - - this.enable = function() { - - }; - }; - - return new ActionTableBehaviour(); - -}); \ No newline at end of file diff --git a/public/js/icinga/behaviour/mainDetail.js b/public/js/icinga/behaviour/mainDetail.js deleted file mode 100755 index 9a207c933..000000000 --- a/public/js/icinga/behaviour/mainDetail.js +++ /dev/null @@ -1,94 +0,0 @@ -/*global Icinga:false, document: false, define:false require:false base_url:false console:false */ - -/** - * Main-Detail layout behaviour as described in - * https://wiki.icinga.org/display/cranberry/Frontend+Components#FrontendComponents-Behaviour - * - */ -define(['jquery','logging','icinga/util/async'],function($,log,async) { - "use strict"; - - var MainDetailBehaviour = function() { - - var onOuterLinkClick = function(ev) { - var a = $(ev.currentTarget), - target = a.attr("target"), - href = a.attr("href"); - ev.stopImmediatePropagation(); - collapseDetailView(); - async.loadToTarget("icinga-main",href); - return false; - }; - - var onLinkTagClick = function(ev) { - - var a = $(ev.currentTarget), - target = a.attr("target"), - href = a.attr("href"); - - // check for protocol:// - if(/^[A-Z]{2,10}\:\/\//i.test(href)) { - window.open(href); - ev.stopImmediatePropagation(); - return false; - } - - // check for link in table header - if(a.parents('th').length > 0) { - ev.stopImmediatePropagation(); - return false; - } - - if(typeof target === "undefined") { - if(a.parents("#icinga-detail").length) { - async.loadToTarget("icinga-detail",href); - } else { - async.loadToTarget("icinga-main",href); - } - } else { - switch(target) { - case "main": - async.loadToTarget("icinga-main",href); - collapseDetailView(); - break; - case "detail": - async.loadToTarget("icinga-detail",href); - break; - case "popup": - async.loadToTarget(null,href); - break; - default: - return true; - } - } - ev.stopImmediatePropagation(); - return false; - }; - - var expandDetailView = function() { - $("#icinga-detail").parents(".collapsed").removeClass('collapsed'); - }; - - var collapseDetailView = function(elementInDetailView) { - $("#icinga-detail").parents(".layout-main-detail").addClass('collapsed'); - }; - - this.expandDetailView = expandDetailView; - this.collapseDetailView = collapseDetailView; - - this.eventHandler = { - '.layout-main-detail * a' : { - 'click' : onLinkTagClick - }, - 'a' : { - 'click' : onOuterLinkClick - }, - '.layout-main-detail .icinga-container#icinga-detail' : { - 'focus' : expandDetailView - } - }; - }; - - return new MainDetailBehaviour(); -}); - From e759911b09dfb5731023a993943bf2318a6f9ee4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Fri, 21 Jun 2013 11:36:12 +0200 Subject: [PATCH 06/46] Add javascript autoloading the js/modules/%modulename%/%file% is now mapped to the module path (if existing). To prevent name clashing, the modules folder has been renamed to components. --- application/controllers/StaticController.php | 10 ++++++---- library/Icinga/Application/Web.php | 12 ++++++++++++ .../js/icinga/{modules => components}/actionTable.js | 0 .../js/icinga/{modules => components}/mainDetail.js | 0 public/js/icinga/container.js | 10 +++------- public/js/icinga/icinga.js | 4 ++-- 6 files changed, 23 insertions(+), 13 deletions(-) rename public/js/icinga/{modules => components}/actionTable.js (100%) rename public/js/icinga/{modules => components}/mainDetail.js (100%) diff --git a/application/controllers/StaticController.php b/application/controllers/StaticController.php index bb5723a84..5704dbf4a 100644 --- a/application/controllers/StaticController.php +++ b/application/controllers/StaticController.php @@ -9,6 +9,7 @@ use Icinga\Web\ActionController; use Icinga\Application\Icinga; use Zend_Controller_Action_Exception as ActionException; +use Icinga\Application\Benchmark; /** * Class StaticController * @package Icinga\Web\Form @@ -69,7 +70,7 @@ class StaticController extends ActionController */ public function javascriptAction() { - $module = $this->_getParam('moduleName'); + $module = $this->_getParam('module_name'); $file = $this->_getParam('file'); $basedir = Icinga::app()->getModule($module)->getBaseDir(); @@ -96,15 +97,16 @@ class StaticController extends ActionController ) . ' GMT' ); + $hash = md5_file($filePath); + if ($hash === $this->getRequest()->getHeader('If-None-Match')) { $response->setHttpResponseCode(304); return; } else { readfile($filePath); } - // TODO: get rid of exit: - exit; + return; } } -// @codingStandardsIgnoreEnd \ No newline at end of file +// @codingStandardsIgnoreEnd diff --git a/library/Icinga/Application/Web.php b/library/Icinga/Application/Web.php index d034d344f..123c25acf 100644 --- a/library/Icinga/Application/Web.php +++ b/library/Icinga/Application/Web.php @@ -60,6 +60,17 @@ class Web extends ApplicationBootstrap ) ) ); + + $this->frontController->getRouter()->addRoute( + 'module_javascript', + new Route( + 'js/modules/:module_name/:file', + array( + 'controller' => 'static', + 'action' => 'javascript' + ) + ) + ); return $this; } @@ -173,6 +184,7 @@ class Web extends ApplicationBootstrap */ protected function configurePagination() { + Paginator::addScrollingStylePrefixPath( 'Icinga_Web_Paginator_ScrollingStyle', 'Icinga/Web/Paginator/ScrollingStyle' diff --git a/public/js/icinga/modules/actionTable.js b/public/js/icinga/components/actionTable.js similarity index 100% rename from public/js/icinga/modules/actionTable.js rename to public/js/icinga/components/actionTable.js diff --git a/public/js/icinga/modules/mainDetail.js b/public/js/icinga/components/mainDetail.js similarity index 100% rename from public/js/icinga/modules/mainDetail.js rename to public/js/icinga/components/mainDetail.js diff --git a/public/js/icinga/container.js b/public/js/icinga/container.js index 08d60f047..8e0891802 100755 --- a/public/js/icinga/container.js +++ b/public/js/icinga/container.js @@ -5,7 +5,7 @@ var containerMgrInstance = null; var async; - var ContainerMgr = function($,log,Widgets,SubTable,holder) { + var ContainerMgr = function($,log,Widgets,SubTable) { var enhanceDetachLinks = function() { @@ -34,14 +34,12 @@ } target.focus(); this.initializeContainers(target); - holder.run(); }; this.updateControlTargets = function(ctrl, req) { $('a',ctrl).each(function() { $(this).attr("href",req.url); }); - holder.run(); }; this.initControlBehaviour = function(root) { @@ -86,7 +84,6 @@ this.initExpandables(root); this.drawImplicitWidgets(root); this.loadAsyncContainers(root); - holder.run(); }; this.createPopupContainer = function(content,req) { @@ -96,7 +93,6 @@ .append($("
    ").addClass('modal-body').html(content)).appendTo(document.body); closeButton.on("click",function() {container.remove();}); - holder.run(); }; this.getContainer = function(id) { @@ -107,9 +103,9 @@ }; }; - define(['jquery','logging','icinga/widgets/checkIcons','icinga/widgets/subTable','Holder'],function($,log,widgets,subTable,holder) { + define(['jquery','logging','icinga/widgets/checkIcons','icinga/widgets/subTable'],function($,log,widgets,subTable) { if (containerMgrInstance === null) { - containerMgrInstance = new ContainerMgr($,log,widgets,subTable,holder); + containerMgrInstance = new ContainerMgr($,log,widgets,subTable); } return containerMgrInstance; diff --git a/public/js/icinga/icinga.js b/public/js/icinga/icinga.js index 9be6b9013..ff59321f6 100755 --- a/public/js/icinga/icinga.js +++ b/public/js/icinga/icinga.js @@ -13,7 +13,7 @@ define([ * Icinga prototype */ var Icinga = function() { - var internalModules = ['icinga/modules/actionTable','icinga/modules/mainDetail']; + var internalModules = ['icinga/components/actionTable','icinga/components/mainDetail']; this.modules = {}; var failedModules = []; @@ -37,7 +37,7 @@ define([ }; var loadModuleScript = function(name) { - moduleMgr.enableModule("modules/"+name, function(error) { + moduleMgr.enableModule("modules/"+name+"/"+name, function(error) { failedModules.push({ name: name, errorMessage: error From 36c8e0df4a7aa0836405e0118057e1c9237c13e1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Fri, 21 Jun 2013 11:40:25 +0200 Subject: [PATCH 07/46] Fix test for new module route The js base route is now js/modules/%modulename%/%file%. This commit reflects these changes in the testcases refs #4092 refs #3735 --- test/js/test/icinga/moduleTest.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/js/test/icinga/moduleTest.js b/test/js/test/icinga/moduleTest.js index 6a446b5f4..494d0264a 100644 --- a/test/js/test/icinga/moduleTest.js +++ b/test/js/test/icinga/moduleTest.js @@ -195,7 +195,7 @@ describe('The icinga module bootstrap', function() { var testClick = false; rjsmock.registerDependencies({ "icinga/module": module, - "modules/test" : { + "modules/test/test" : { eventHandler: { "a.test" : { click : function() { From 35c43446d88f2bce0cd841b9dade850f3fa8f490 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Fri, 21 Jun 2013 15:33:06 +0200 Subject: [PATCH 08/46] Add support for lazy module loading When the X-Icinga-Module-Enable header is send, the modulemanager automatically tries to load javascript files for that module. This is realized by adding the 'registerHeaderListener' method to the async manager, which allows to listen to specific headers and firing callbacks if a response with the specified header is retrieved. Also the tests have changed a bit, requireNow should be used when using the requiremock, so a require always loads files new. refs #4092 refs #3753 --- application/controllers/ModulesController.php | 6 +- public/js/icinga/icinga.js | 8 ++- public/js/icinga/util/async.js | 34 ++++++++-- test/js/test/icinga/asyncTest.js | 35 +++++++++++ test/js/test/icinga/moduleTest.js | 62 +++++++++++++++++-- test/js/testlib/asyncmock.js | 33 ++++++++++ test/js/testlib/requiremock.js | 15 ++++- 7 files changed, 179 insertions(+), 14 deletions(-) create mode 100644 test/js/test/icinga/asyncTest.js create mode 100644 test/js/testlib/asyncmock.js diff --git a/application/controllers/ModulesController.php b/application/controllers/ModulesController.php index f8f40a3b3..afd3b9178 100755 --- a/application/controllers/ModulesController.php +++ b/application/controllers/ModulesController.php @@ -35,7 +35,11 @@ class ModulesController extends ActionController public function enableAction() { $this->manager->enableModule($this->_getParam('name')); - $this->redirectNow('modules/overview?_render=body'); + $this->manager->loadModule($this->_getParam('name')); + $this->getResponse()->setHeader('X-Icinga-Enable-Module', $this->_getParam('name')); + $this->replaceLayout = true; + $this->indexAction(); + } public function disableAction() diff --git a/public/js/icinga/icinga.js b/public/js/icinga/icinga.js index ff59321f6..d538ab552 100755 --- a/public/js/icinga/icinga.js +++ b/public/js/icinga/icinga.js @@ -19,16 +19,19 @@ define([ var failedModules = []; var initialize = function () { + registerLazyModuleLoading(); enableInternalModules(); - + containerMgr.registerAsyncMgr(async); containerMgr.initializeContainers(document); log.debug("Initialization finished"); enableModules(); }; - + var registerLazyModuleLoading = function() { + async.registerHeaderListener("X-Icinga-Enable-Module", loadModuleScript, this); + }; var enableInternalModules = function() { $.each(internalModules,function(idx,module) { @@ -37,6 +40,7 @@ define([ }; var loadModuleScript = function(name) { + console.log("Loading ", name); moduleMgr.enableModule("modules/"+name+"/"+name, function(error) { failedModules.push({ name: name, diff --git a/public/js/icinga/util/async.js b/public/js/icinga/util/async.js index 15a6be7df..1b564b176 100644 --- a/public/js/icinga/util/async.js +++ b/public/js/icinga/util/async.js @@ -3,7 +3,8 @@ "use strict"; var asyncMgrInstance = null; - define(['icinga/container','logging','icinga/behaviour','jquery'],function(containerMgr,log,behaviour,$) { + define(['icinga/container','logging','jquery'],function(containerMgr,log,$) { + var headerListeners = {}; var pending = { @@ -18,12 +19,30 @@ return target; }; - var handleResponse = function(html) { + var applyHeaderListeners = function(headers) { + for (var header in headerListeners) { + if (headers.getResponseHeader(header) === null) { + // see if the browser/server converts headers to lowercase + if (headers.getResponseHeader(header.toLowerCase()) === null) { + continue; + } + header = header.toLowerCase(); + } + var value = headers.getResponseHeader(header); + var listeners = headerListeners[header]; + for (var i=0;i")); $('a.test').click(); @@ -223,4 +226,55 @@ describe('The icinga module bootstrap', function() { should.equal(icinga.getFailedModules()[0].name, "test2"); tearDownTestDOM(); }); + + it("Should load modules lazily when discovering a X-Icinga-Enable-Module header", function() { + rjsmock.purgeDependencies(); + + requireNew("icinga/util/async.js"); + var async = rjsmock.getDefine(); + + rjsmock.registerDependencies({ + "icinga/module": module, + "icinga/util/async": async, + "modules/test/test" : { + eventHandler: { + "a.test" : { + click : function() { + testClick = true; + } + } + } + }, + "icinga/container" : { + registerAsyncMgr: function() {}, + initializeContainers: function() {} + }, + "modules/list" : [ + ] + }); + + tearDownTestDOM(); + + requireNew("icinga/icinga.js"); + var icinga = rjsmock.getDefine(); + + var testClick = false; + // The module shouldn't be loaded + $('body').append($("")); + $('a.test').click(); + should.equal(testClick, false, "Unregistered module was loaded"); + + asyncMock.setNextAsyncResult(async,"result", false, { + "X-Icinga-Enable-Module" : "test" + }); + async.createRequest(); + // The module shouldn't be loaded + $('body').append($("")); + $('a.test').click(); + should.equal(testClick, true, "Module wasn't automatically loaded on header!"); + + + tearDownTestDOM(); + + }); }); diff --git a/test/js/testlib/asyncmock.js b/test/js/testlib/asyncmock.js new file mode 100644 index 000000000..aad6d5eea --- /dev/null +++ b/test/js/testlib/asyncmock.js @@ -0,0 +1,33 @@ +/** + * Helper for mocking $.async's XHR requests + * + */ + + +var getCallback = function(empty, response, succeed, headers) { + if (empty) + return function() {}; + return function(callback) { + callback(response, succeed, { + getAllResponseHeaders: function() { + return headers; + }, + getResponseHeader: function(header) { + return headers[header] || null; + } + }); + }; +}; + +module.exports = { + setNextAsyncResult: function(async, response, fails, headers) { + headers = headers || {}; + var succeed = fails ? "fail" : "success"; + async.__internalXHRImplementation = function(config) { + return { + done: getCallback(fails, response, succeed, headers), + fail: getCallback(!fails, response, succeed, headers) + }; + }; + } +}; diff --git a/test/js/testlib/requiremock.js b/test/js/testlib/requiremock.js index 8181092da..e61b08694 100644 --- a/test/js/testlib/requiremock.js +++ b/test/js/testlib/requiremock.js @@ -13,6 +13,7 @@ * to console. * **/ +var path = require('path'); var registeredDependencies = {}; /** @@ -21,11 +22,13 @@ var registeredDependencies = {}; * in dependencies and calls fn with them as the parameter * **/ +var debug = false; var requireJsMock = function(dependencies, fn) { var fnArgs = []; for (var i=0;i Date: Mon, 24 Jun 2013 18:40:37 +0200 Subject: [PATCH 09/46] Add Form\Builder The builder class allows to create forms and bind them to models. The tests are currently failing because of the zend pluginloader, this must be evaluated refs #4302 --- library/Icinga/Form/Builder.php | 280 +++++++++++++++++++ test/php/library/Icinga/Form/BuilderTest.php | 183 ++++++++++++ 2 files changed, 463 insertions(+) create mode 100644 library/Icinga/Form/Builder.php create mode 100644 test/php/library/Icinga/Form/BuilderTest.php diff --git a/library/Icinga/Form/Builder.php b/library/Icinga/Form/Builder.php new file mode 100644 index 000000000..4526f7624 --- /dev/null +++ b/library/Icinga/Form/Builder.php @@ -0,0 +1,280 @@ +getForm() or +* by directly calling the forms method (which is, in case of populate() the preferred way) +* like: $builder->getElements() +* +**/ +class Builder +{ + const CSRF_ID = "icinga_csrf_id"; + + private $form; + private $boundModel = null; + private $disableCSRF = false; + + /** + * Constructrs a new Formbuilder, containing an empty form if no + * $form parameter is given or the Zend form from the $form parameter. + * + * @param \Zend_Form The form to use with this Builder + * @param Array an optional array of Options: + * - CSRFProtection true to add a crsf token to the + * form (default), false to remove it + * - model An referenced array or object to use + * for value binding + **/ + public function __construct(\Zend_Form $form = null, array $options = array()) + { + if ($form === null) { + $form = new \Zend_Form(); + } + + $this->form = $form; + if (isset($options["CSRFProtection"])) { + $this->disableCSRF = !$options["CSRFProtection"]; + } + if (isset($options["model"])) { + $this->boundModel = &$options["model"]; + } + } + + public function setZendForm(\Zend_Form $form) + { + $this->form = $form; + } + + public function getForm() + { + if (!$this->disableCSRF) { + $this->addCSRFFieldToForm(); + } + if (!$this->form) { + return new \Zend_Form(); + } + return $this->form; + } + + public function addElementsFromConfig(array $elements) + { + foreach ($elements as $key => $values) { + $this->addElement($values[0], $key, $values[1]); + } + } + + public static function fromArray(array $elements, $options = array()) + { + $builder = new Builder(null, $options); + $builder->addElementsFromConfig($elements); + return $builder; + } + + public function isValid(array $data = null) + { + if ($data === null) { + $data = $_POST; + } + return $this->hasValidToken() && $this->form->isValid($data); + } + + public function isSubmitted($btnName = 'submit') + { + $btn = $this->getElement($btnName); + if (!$btn || !isset($_POST[$btnName])) { + return false; + } + return $_POST[$btnName] === $btn->getLabel(); + } + + public function render() + { + return $this->getForm()->render(); + } + + public function __toString() + { + return $this->getForm()->__toString(); + } + + public function enableCSRF() + { + $this->disableCSRF = false; + } + + public function disableCSRF() + { + $this->disableCSRF = true; + $this->form->removeElement(self::CSRF_ID); + $this->form->removeElement(self::CSRF_ID."_seed"); + } + + private function addCSRFFieldToForm() + { + if (!$this->form || $this->disableCSRF || $this->form->getElement(self::CSRF_ID)) { + return; + } + list($seed, $token) = $this->getSeedTokenPair(); + + $this->form->addElement("hidden", self::CSRF_ID); + $this->form->getElement(self::CSRF_ID) + ->setValue($token) + ->setDecorators(array('ViewHelper')); + + $this->form->addElement("hidden", self::CSRF_ID."_seed"); + $this->form->getElement(self::CSRF_ID."_seed") + ->setValue($seed) + ->setDecorators(array('ViewHelper')); + + } + + public function bindToModel(&$model) + { + $this->boundModel = &$model; + } + + public function repopulate() + { + if (!empty($_POST)) { + $this->populate($_POST); + } + } + + public function populate($data, $ignoreModel = false) + { + if (is_array($data)) { + $this->form->populate($data); + } elseif (is_object($data)) { + $this->populateFromObject($data); + } else { + throw new InvalidArgumentException("Builder::populate() expects and object or array, $data given"); + } + if ($this->boundModel === null || $ignoreModel) { + return; + } + $this->updateModel(); + + } + + private function populateFromObject($data) + { + foreach ($this->form->getElements() as $name => $element) { + if (isset($data->$name)) { + $element->setValue($data->$name); + + } else { + $getter = "get".ucfirst($name); + if (method_exists($data, $getter)) { + $element->setValue($data->$getter()); + } + } + } + } + + public function updateModel() + { + if (is_array($this->boundModel)) { + $this->updateArrayModel(); + } elseif (is_object($this->boundModel)) { + $this->updateObjectModel(); + } + } + + private function updateObjectModel() + { + foreach ($this->form->getElements() as $name => $element) { + if (isset($this->boundModel->$name)) { + $this->boundModel->$name = $element->getValue(); + } else { + $setter = "set".ucfirst($name); + if (method_exists($this->boundModel, $setter)) { + $this->boundModel->$setter($element->getValue()); + } + + } + } + } + + private function updateArrayModel() + { + foreach ($this->form->getElements() as $name => $element) { + if (isset($this->boundModel[$name])) { + $this->boundModel[$name] = $element->getValue(); + } + } + } + + public function syncWithModel() + { + $this->populate($this->boundModel, true); + } + + public function __call($fn, array $args) + { + if (method_exists($this->form, $fn)) { + return call_user_func_array(array($this->form, $fn), $args); + } else { + throw new \BadMethodCallException( + "Method $fn does not exist either ". + "in \Icinga\Form\Builder nor in Zend_Form" + ); + } + } + + + /** + * Whether the token parameter is valid + * + * @param int $maxAge Max allowed token age + * @param string $sessionId A specific session id (useful for tests?) + * + * return bool + */ + public function hasValidToken($maxAge = 600, $sessionId = null) + { + if ($this->disableCSRF) { + return true; + } + + if ($this->form->getElement(self::CSRF_ID) == null) { + return false; + } + + $sessionId = $sessionId ? $sessionId : session_id(); + $seed = $this->form->getElement(self::CSRF_ID.'_seed')->getValue(); + if (! is_numeric($seed)) { + return false; + } + + // Remove quantitized timestamp portion so maxAge applies + $seed -= (intval(time() / $maxAge) * $maxAge); + $token = $this->getElement(self::CSRF_ID)->getValue(); + return $token === hash('sha256', $sessionId . $seed); + } + + /** + * Get a new seed/token pair + * + * @param int $maxAge Max allowed token age + * @param string $sessionId A specific session id (useful for tests?) + * + * return array + */ + public function getSeedTokenPair($maxAge = 600, $sessionId = null) + { + $sessionId = $sessionId ? $sessionId : session_id(); + $seed = mt_rand(); + $hash = hash('sha256', $sessionId . $seed); + + // Add quantitized timestamp portion to apply maxAge + $seed += (intval(time() / $maxAge) * $maxAge); + return array($seed, $hash); + } +} diff --git a/test/php/library/Icinga/Form/BuilderTest.php b/test/php/library/Icinga/Form/BuilderTest.php new file mode 100644 index 000000000..8cae3062b --- /dev/null +++ b/test/php/library/Icinga/Form/BuilderTest.php @@ -0,0 +1,183 @@ + false)); + $this->assertInstanceOf("Zend_Form", $builder->getForm()); + } + + /** + * + **/ + public function testCSRFProtectionTokenCreation() + { + $view = new \Zend_View(); + $builder = new Builder(); // when no token is given, a CRSF field should be added + $builder->setView($view); + + $DOM = new \DOMDocument; + $DOM->loadHTML($builder); + $this->assertNotNull($DOM->getElementById(Builder::CSRF_ID)); + + $builder->disableCSRF(); + $DOM->loadHTML($builder); + $this->assertNull($DOM->getElementById(Builder::CSRF_ID)); + + } + /** + * Test whether form methods are passed to the Zend_Form object + * When called in the Builder instance + * + **/ + public function testMethodPassing() + { + $DOM = new \DOMDocument; + $view = new \Zend_View(); + $builder = new Builder(null, array("CSRFProtection" => false)); + $builder->setView($view); + + $DOM->loadHTML($builder); + $this->assertEquals(0, $DOM->getElementsByTagName("input")->length); + + $builder->addElement("text", "username"); + $DOM->loadHTML($builder); + $inputEls = $DOM->getElementsByTagName("input"); + $this->assertEquals(1, $inputEls->length); + $this->assertEquals("username", $inputEls->item(0)->attributes->getNamedItem("name")->value); + } + /** + * + * + **/ + public function testCreateByArray() + { + $DOM = new \DOMDocument; + $view = new \Zend_View(); + $builder = Builder::fromArray( + array( + 'username' => array( + 'text', + array( + 'label' => 'Username', + 'required' => true, + ) + ), + 'password' => array( + 'password', + array( + 'label' => 'Password', + 'required' => true, + ) + ), + 'submit' => array( + 'submit', + array( + 'label' => 'Login' + ) + ) + ), + array( + "CSRFProtection" => false + ) + ); + $builder->setView($view); + + $DOM->loadHTML($builder); + $inputEls = $DOM->getElementsByTagName("input"); + $this->assertEquals(3, $inputEls->length); + + $username = $inputEls->item(0); + $this->assertEquals("username", $username->attributes->getNamedItem("name")->value); + + $password= $inputEls->item(1); + $this->assertEquals("password", $password->attributes->getNamedItem("name")->value); + $this->assertEquals("password", $password->attributes->getNamedItem("type")->value); + + $submitBtn= $inputEls->item(2); + $this->assertEquals("submit", $submitBtn->attributes->getNamedItem("name")->value); + $this->assertEquals("submit", $submitBtn->attributes->getNamedItem("type")->value); + } + + /** + * + * + */ + public function testModelBindingWithArray() + { + $view = new \Zend_View(); + $builder = new Builder(null, array("CSRFProtection" => false)); + $builder->setView($view); + $myModel = array( + "username" => "", + "password" => "" + ); + $builder->bindToModel($myModel); + $builder->addElement("text", "username"); + $builder->addElement("password", "password"); + // test sync from form to model + $builder->populate( + array( + "username" => "User input", + "password" => "Secret$123" + ) + ); + $this->assertEquals("User input", $myModel["username"]); + $this->assertEquals("Secret$123", $myModel["password"]); + + // test sync from model to form + $myModel["username"] = "Another user"; + $myModel["password"] = "Another pass"; + + $builder->syncWithModel(); + $this->assertEquals("Another user", $builder->getElement("username")->getValue()); + $this->assertEquals("Another pass", $builder->getElement("password")->getValue()); + } + + /** + * + * + */ + public function testModelBindingWithObject() + { + $view = new \Zend_View(); + $builder = new Builder(null, array("CSRFProtection" => false)); + $builder->setView($view); + $myModel = (object) array( + "username" => "", + "password" => "" + ); + $builder->bindToModel($myModel); + $builder->addElement("text", "username"); + $builder->addElement("password", "password"); + // test sync from form to model + $builder->populate( + (object) array( + "username" => "User input", + "password" => "Secret$123" + ) + ); + $this->assertEquals("User input", $myModel->username); + $this->assertEquals("Secret$123", $myModel->password); + + // test sync from model to form + $myModel->username = "Another user"; + $myModel->password = "Another pass"; + + $builder->syncWithModel(); + $this->assertEquals("Another user", $builder->getElement("username")->getValue()); + $this->assertEquals("Another pass", $builder->getElement("password")->getValue()); + } +} From 8d1038e6221ab36ff9f06a1582e5cc3f9bf20534 Mon Sep 17 00:00:00 2001 From: Marius Hein Date: Tue, 25 Jun 2013 09:43:55 +0200 Subject: [PATCH 10/46] Refactor and test \Icinga\Web\Form Fix inspection issues, added some other code for testing to have more coverage, fix test for QLink view helper. refs #4302 refs #4341 --- library/Icinga/Form/Builder.php | 145 +++++++++++++++--- .../application/views/helpers/QlinkTest.php | 30 ++-- test/php/library/Icinga/Form/BuilderTest.php | 57 ++++++- 3 files changed, 187 insertions(+), 45 deletions(-) diff --git a/library/Icinga/Form/Builder.php b/library/Icinga/Form/Builder.php index 4526f7624..cc2b08591 100644 --- a/library/Icinga/Form/Builder.php +++ b/library/Icinga/Form/Builder.php @@ -5,28 +5,43 @@ namespace Icinga\Form; /** -* Class that helps building and validating forms and offers a rudimentary -* data-binding mechanismn. -* -* The underlying form can be accessed by expicitly calling $builder->getForm() or -* by directly calling the forms method (which is, in case of populate() the preferred way) -* like: $builder->getElements() -* -**/ + * Class that helps building and validating forms and offers a rudimentary + * data-binding mechanismn. + * + * The underlying form can be accessed by expicitly calling $builder->getForm() or + * by directly calling the forms method (which is, in case of populate() the preferred way) + * like: $builder->getElements() + * + * @method \Zend_Form_Element getElement(string $name) + * @method \Zend_Form addElement(\string $element, string $name = null, array $options = null) + * @method \Zend_Form setView(\Zend_View $view) + * @package Icinga\Form + */ class Builder { const CSRF_ID = "icinga_csrf_id"; - + + /** + * @var \Zend_Form + */ private $form; + + /** + * @var null + */ private $boundModel = null; + + /** + * @var bool + */ private $disableCSRF = false; /** * Constructrs a new Formbuilder, containing an empty form if no * $form parameter is given or the Zend form from the $form parameter. * - * @param \Zend_Form The form to use with this Builder - * @param Array an optional array of Options: + * @param \Zend_Form $form The form to use with this Builder + * @param Array $options an optional array of Options: * - CSRFProtection true to add a crsf token to the * form (default), false to remove it * - model An referenced array or object to use @@ -35,23 +50,37 @@ class Builder public function __construct(\Zend_Form $form = null, array $options = array()) { if ($form === null) { + $myModel = array( + "username" => "", + "password" => "" + ); + $form = new \Zend_Form(); } - $this->form = $form; + $this->setZendForm($form); + if (isset($options["CSRFProtection"])) { $this->disableCSRF = !$options["CSRFProtection"]; } if (isset($options["model"])) { - $this->boundModel = &$options["model"]; + $this->bindToModel($options["model"]); } } - + + /** + * Setter for Zend_Form + * @param \Zend_Form $form + */ public function setZendForm(\Zend_Form $form) { $this->form = $form; } + /** + * Getter for Zent_Form + * @return \Zend_Form + */ public function getForm() { if (!$this->disableCSRF) { @@ -62,7 +91,11 @@ class Builder } return $this->form; } - + + /** + * Add elements to form + * @param array $elements + */ public function addElementsFromConfig(array $elements) { foreach ($elements as $key => $values) { @@ -70,6 +103,12 @@ class Builder } } + /** + * Quick add elements to a new builder instance + * @param array $elements + * @param array $options + * @return Builder + */ public static function fromArray(array $elements, $options = array()) { $builder = new Builder(null, $options); @@ -77,6 +116,12 @@ class Builder return $builder; } + /** + * Test that the form is valid + * + * @param array $data + * @return bool + */ public function isValid(array $data = null) { if ($data === null) { @@ -85,6 +130,11 @@ class Builder return $this->hasValidToken() && $this->form->isValid($data); } + /** + * Test if the form was submitted + * @param string $btnName + * @return bool + */ public function isSubmitted($btnName = 'submit') { $btn = $this->getElement($btnName); @@ -94,6 +144,10 @@ class Builder return $_POST[$btnName] === $btn->getLabel(); } + /** + * Render the form + * @return string + */ public function render() { return $this->getForm()->render(); @@ -103,12 +157,18 @@ class Builder { return $this->getForm()->__toString(); } - + + /** + * Enable CSRF token field + */ public function enableCSRF() { $this->disableCSRF = false; } + /** + * Disable CSRF token field + */ public function disableCSRF() { $this->disableCSRF = true; @@ -116,6 +176,9 @@ class Builder $this->form->removeElement(self::CSRF_ID."_seed"); } + /** + * Add CSRF field to form + */ private function addCSRFFieldToForm() { if (!$this->form || $this->disableCSRF || $this->form->getElement(self::CSRF_ID)) { @@ -135,11 +198,18 @@ class Builder } + /** + * Bind model to a form + * @param $model + */ public function bindToModel(&$model) { $this->boundModel = &$model; } + /** + * Repopulate + */ public function repopulate() { if (!empty($_POST)) { @@ -147,6 +217,12 @@ class Builder } } + /** + * Populate form + * @param $data + * @param bool $ignoreModel + * @throws \InvalidArgumentException + */ public function populate($data, $ignoreModel = false) { if (is_array($data)) { @@ -154,7 +230,7 @@ class Builder } elseif (is_object($data)) { $this->populateFromObject($data); } else { - throw new InvalidArgumentException("Builder::populate() expects and object or array, $data given"); + throw new \InvalidArgumentException("Builder::populate() expects and object or array, $data given"); } if ($this->boundModel === null || $ignoreModel) { return; @@ -163,8 +239,14 @@ class Builder } + /** + * Populate form object + * @param $data + */ private function populateFromObject($data) { + /** @var \Zend_Form_Element $element */ + foreach ($this->form->getElements() as $name => $element) { if (isset($data->$name)) { $element->setValue($data->$name); @@ -178,6 +260,9 @@ class Builder } } + /** + * Update model instance + */ public function updateModel() { if (is_array($this->boundModel)) { @@ -187,8 +272,13 @@ class Builder } } + /** + * Updater for objects + */ private function updateObjectModel() { + /** @var \Zend_Form_Element $element */ + foreach ($this->form->getElements() as $name => $element) { if (isset($this->boundModel->$name)) { $this->boundModel->$name = $element->getValue(); @@ -202,8 +292,13 @@ class Builder } } + /** + * Updater for arrays + */ private function updateArrayModel() { + /** @var \Zend_Form_Element $element */ + foreach ($this->form->getElements() as $name => $element) { if (isset($this->boundModel[$name])) { $this->boundModel[$name] = $element->getValue(); @@ -211,11 +306,21 @@ class Builder } } + /** + * Synchronize model with form + */ public function syncWithModel() { $this->populate($this->boundModel, true); } - + + /** + * Magic caller, pass through method calls to form + * @param $fn + * @param array $args + * @return mixed + * @throws \BadMethodCallException + */ public function __call($fn, array $args) { if (method_exists($this->form, $fn)) { @@ -235,7 +340,7 @@ class Builder * @param int $maxAge Max allowed token age * @param string $sessionId A specific session id (useful for tests?) * - * return bool + * @return bool */ public function hasValidToken($maxAge = 600, $sessionId = null) { @@ -265,7 +370,7 @@ class Builder * @param int $maxAge Max allowed token age * @param string $sessionId A specific session id (useful for tests?) * - * return array + * @return array */ public function getSeedTokenPair($maxAge = 600, $sessionId = null) { diff --git a/test/php/application/views/helpers/QlinkTest.php b/test/php/application/views/helpers/QlinkTest.php index ad4c5e3be..7e8030ee8 100755 --- a/test/php/application/views/helpers/QlinkTest.php +++ b/test/php/application/views/helpers/QlinkTest.php @@ -1,19 +1,8 @@ view = $this; - $this->basename = $basename; - } - - public function baseUrl($url) { - return $this->basename.$url; - } - }; -} +require_once('Zend/View/Helper/Abstract.php'); +require_once('Zend/View.php'); require('../../application/views/helpers/Qlink.php'); @@ -30,30 +19,37 @@ class Zend_View_Helper_QlinkTest extends \PHPUnit_Framework_TestCase public function testURLPathParameter() { + $view = new Zend_View(); + $helper = new Zend_View_Helper_Qlink(); - $pathTpl = "path/%s/to/%s"; + $helper->setView($view); + $pathTpl = "/path/%s/to/%s"; $this->assertEquals( - "path/param1/to/param2", + "/path/param1/to/param2", $helper->getFormattedURL($pathTpl,array('param1','param2')) ); } public function testUrlGETParameter() { + $view = new Zend_View(); $helper = new Zend_View_Helper_Qlink(); + $helper->setView($view); $pathTpl = 'path'; $this->assertEquals( - 'path?param1=value1&param2=value2', + '/path?param1=value1&param2=value2', $helper->getFormattedURL($pathTpl,array('param1'=>'value1','param2'=>'value2')) ); } public function testMixedParameters() { + $view = new Zend_View(); $helper = new Zend_View_Helper_Qlink(); + $helper->setView($view); $pathTpl = 'path/%s/to/%s'; $this->assertEquals( - 'path/path1/to/path2?param1=value1&param2=value2', + '/path/path1/to/path2?param1=value1&param2=value2', $helper->getFormattedURL($pathTpl,array( 'path1','path2', 'param1'=>'value1', diff --git a/test/php/library/Icinga/Form/BuilderTest.php b/test/php/library/Icinga/Form/BuilderTest.php index 8cae3062b..ede5919fc 100644 --- a/test/php/library/Icinga/Form/BuilderTest.php +++ b/test/php/library/Icinga/Form/BuilderTest.php @@ -8,6 +8,23 @@ require_once("../../library/Icinga/Form/Builder.php"); use Icinga\Form\Builder as Builder; +class BuilderTestModel +{ + public $username = ''; + public $password = ''; + private $test; + + public function getTest() + { + return $this->test; + } + + public function setTest($test) + { + $this->test = $test; + } +} + class BuilderTest extends \PHPUnit_Framework_TestCase { /** @@ -118,13 +135,23 @@ class BuilderTest extends \PHPUnit_Framework_TestCase public function testModelBindingWithArray() { $view = new \Zend_View(); - $builder = new Builder(null, array("CSRFProtection" => false)); - $builder->setView($view); + $myModel = array( "username" => "", "password" => "" ); - $builder->bindToModel($myModel); + + $builder = new Builder( + null, + array( + "CSRFProtection" => false, + "model" => &$myModel + ) + ); + + $builder->setView($view); + + // $builder->bindToModel($myModel); $builder->addElement("text", "username"); $builder->addElement("password", "password"); // test sync from form to model @@ -155,22 +182,26 @@ class BuilderTest extends \PHPUnit_Framework_TestCase $view = new \Zend_View(); $builder = new Builder(null, array("CSRFProtection" => false)); $builder->setView($view); - $myModel = (object) array( - "username" => "", - "password" => "" - ); + + + + $myModel = new BuilderTestModel(); + $builder->bindToModel($myModel); $builder->addElement("text", "username"); $builder->addElement("password", "password"); + $builder->addElement("text", "test"); // test sync from form to model $builder->populate( (object) array( "username" => "User input", - "password" => "Secret$123" + "password" => "Secret$123", + "test" => 'test334' ) ); $this->assertEquals("User input", $myModel->username); $this->assertEquals("Secret$123", $myModel->password); + $this->assertEquals("test334", $myModel->getTest()); // test sync from model to form $myModel->username = "Another user"; @@ -180,4 +211,14 @@ class BuilderTest extends \PHPUnit_Framework_TestCase $this->assertEquals("Another user", $builder->getElement("username")->getValue()); $this->assertEquals("Another pass", $builder->getElement("password")->getValue()); } + + /** + * @expectedException \BadMethodCallException + * @expectedExceptionMessage Method doesNotExist123 does not exist either in \Icinga\Form\Builder nor in Zend_Form + */ + public function testBadCall1() + { + $builder = new Builder(null, array("CSRFProtection" => false)); + $builder->doesNotExist123(); + } } From 0f8648dcb1a3cc27f7fcc6a060b4cc285dc53e68 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Thu, 20 Jun 2013 13:47:51 +0200 Subject: [PATCH 11/46] Add SystemPermissionException This exception should be fired when the OS restricts the web user from executing certain actions. Also the template for errors has been modified so it displays the action and the target that was prevented. refs #4092 --- application/controllers/ErrorController.php | 3 +-- application/views/scripts/error/error.phtml | 11 ++++++++-- .../Exception/SystemPermissionException.php | 22 +++++++++++++++++++ 3 files changed, 32 insertions(+), 4 deletions(-) create mode 100644 library/Icinga/Exception/SystemPermissionException.php diff --git a/application/controllers/ErrorController.php b/application/controllers/ErrorController.php index efcc20e9b..c523bb77f 100755 --- a/application/controllers/ErrorController.php +++ b/application/controllers/ErrorController.php @@ -34,7 +34,6 @@ class ErrorController extends ActionController $this->view->message = 'Application error'; break; } - // conditionally display exceptions if ($this->getInvokeArg('displayExceptions') == true) { $this->view->exception = $errors->exception; @@ -44,4 +43,4 @@ class ErrorController extends ActionController } } -// @codingStandardsIgnoreEnd \ No newline at end of file +// @codingStandardsIgnoreEnd diff --git a/application/views/scripts/error/error.phtml b/application/views/scripts/error/error.phtml index 9ae6ecd1f..b5cfcddcb 100755 --- a/application/views/scripts/error/error.phtml +++ b/application/views/scripts/error/error.phtml @@ -9,8 +9,15 @@

    Exception information:

    -

    - Message: exception->getMessage() ?> +

    + Message: exception->getMessage() ?> + exception->action)): ?> +
    Action: exception->action; ?> + + exception->action)): ?> +
    Target: exception->target; ?> + +

    Stack trace:

    diff --git a/library/Icinga/Exception/SystemPermissionException.php b/library/Icinga/Exception/SystemPermissionException.php new file mode 100644 index 000000000..02849ec34 --- /dev/null +++ b/library/Icinga/Exception/SystemPermissionException.php @@ -0,0 +1,22 @@ +action = $action; + $this->target = $target; + } +} From 81e27689bb79c0901975bb24bdfab9eb6605c6cb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Thu, 20 Jun 2013 14:02:58 +0200 Subject: [PATCH 12/46] Add rule for 'body' container and QLink property 'target' QLinks can now define the target for their link. Additionally, the targte 'body' is now always the tag. This allows the modulemanager to reload the whole page (with the navigation bar). refs #4092 --- .../layouts/scripts/just-the-body.phtml | 8 --- application/layouts/scripts/layout.phtml | 4 +- .../layouts/scripts/parts/navigation.phtml | 3 +- application/views/helpers/Qlink.php | 5 +- public/js/icinga/modules/mainDetail.js | 71 ++++++++++--------- public/js/icinga/util/async.js | 8 +-- 6 files changed, 49 insertions(+), 50 deletions(-) diff --git a/application/layouts/scripts/just-the-body.phtml b/application/layouts/scripts/just-the-body.phtml index e243e63ed..ee29c44e6 100755 --- a/application/layouts/scripts/just-the-body.phtml +++ b/application/layouts/scripts/just-the-body.phtml @@ -12,14 +12,6 @@
    -
    - - - - - - -
    diff --git a/application/layouts/scripts/layout.phtml b/application/layouts/scripts/layout.phtml index cfe89626c..d70627d1b 100755 --- a/application/layouts/scripts/layout.phtml +++ b/application/layouts/scripts/layout.phtml @@ -21,12 +21,12 @@ ICINGA_DEBUG = true; - + - + render('parts/topbar.phtml') ?>
    diff --git a/application/layouts/scripts/parts/navigation.phtml b/application/layouts/scripts/parts/navigation.phtml index 1184d1830..e7de8f369 100755 --- a/application/layouts/scripts/parts/navigation.phtml +++ b/application/layouts/scripts/parts/navigation.phtml @@ -5,7 +5,8 @@ $item = $this->navigation->listAll("menu"); ?> -auth()->isAuthenticated()): ?> +auth()->isAuthenticated()): ?> +
      view->baseUrl($url) : $baseUrl . $url; } } -// @codingStandardsIgnoreEnd \ No newline at end of file +// @codingStandardsIgnoreEnd diff --git a/public/js/icinga/modules/mainDetail.js b/public/js/icinga/modules/mainDetail.js index 9a207c933..368c5c5f7 100755 --- a/public/js/icinga/modules/mainDetail.js +++ b/public/js/icinga/modules/mainDetail.js @@ -16,45 +16,52 @@ define(['jquery','logging','icinga/util/async'],function($,log,async) { href = a.attr("href"); ev.stopImmediatePropagation(); collapseDetailView(); + async.loadToTarget("icinga-main",href); + return false; +}; + +var onLinkTagClick = function(ev) { + + var a = $(ev.currentTarget), + target = a.attr("target"), + href = a.attr("href"); + + // check for protocol:// + if(/^[A-Z]{2,10}\:\/\//i.test(href)) { + window.open(href); + ev.stopImmediatePropagation(); + return false; + } + + // check for link in table header + if(a.parents('th').length > 0) { + ev.stopImmediatePropagation(); + return false; + } + + if(typeof target === "undefined") { + if(a.parents("#icinga-detail").length) { + log.debug("Parent is detail, loading into detail"); + async.loadToTarget("icinga-detail",href); + } else { + log.debug("Parent is not detail, loading into main"); async.loadToTarget("icinga-main",href); - return false; - }; - - var onLinkTagClick = function(ev) { - - var a = $(ev.currentTarget), - target = a.attr("target"), - href = a.attr("href"); - - // check for protocol:// - if(/^[A-Z]{2,10}\:\/\//i.test(href)) { - window.open(href); - ev.stopImmediatePropagation(); - return false; - } - - // check for link in table header - if(a.parents('th').length > 0) { - ev.stopImmediatePropagation(); - return false; - } - - if(typeof target === "undefined") { - if(a.parents("#icinga-detail").length) { - async.loadToTarget("icinga-detail",href); - } else { - async.loadToTarget("icinga-main",href); - } - } else { - switch(target) { + } + } else { + switch(target) { + case "body": + async.loadToTarget("body", href); + break; case "main": async.loadToTarget("icinga-main",href); collapseDetailView(); break; case "detail": + log.debug("Target: detail"); async.loadToTarget("icinga-detail",href); break; case "popup": + log.debug("No target"); async.loadToTarget(null,href); break; default: @@ -67,7 +74,7 @@ define(['jquery','logging','icinga/util/async'],function($,log,async) { var expandDetailView = function() { $("#icinga-detail").parents(".collapsed").removeClass('collapsed'); - }; + }; var collapseDetailView = function(elementInDetailView) { $("#icinga-detail").parents(".layout-main-detail").addClass('collapsed'); @@ -88,7 +95,5 @@ define(['jquery','logging','icinga/util/async'],function($,log,async) { } }; }; - return new MainDetailBehaviour(); }); - diff --git a/public/js/icinga/util/async.js b/public/js/icinga/util/async.js index efab52ed7..8e015b45a 100644 --- a/public/js/icinga/util/async.js +++ b/public/js/icinga/util/async.js @@ -5,11 +5,9 @@ define(['icinga/container','logging','icinga/behaviour','jquery'],function(containerMgr,log,behaviour,$) { - var pending = { }; - var getDOMForDestination = function(destination) { var target = destination; if(typeof destination === "string") { @@ -84,13 +82,14 @@ this.loadToTarget = function(destination,url,data) { if(destination) { + log.debug("Laoding to container", destination, url); this.clearPendingRequestsFor(destination); } var req = this.createRequest(url,data); if(destination) { pending.push({ request: req, - DOM: getDOMForDestination(destination) + DOM: getDOMForDestination(destination) }); req.destination = destination; } @@ -105,5 +104,4 @@ }; return new CallInterface(); }); - -})(); \ No newline at end of file +})(); From 04a23f0096d69178487ec885d818501cbfd5413e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Thu, 20 Jun 2013 14:06:02 +0200 Subject: [PATCH 13/46] Move ModuleController from incubator The Notification dependency is removed and uses exceptions now, otherwise it's mostly the same like in the incubator refs #4092 --- application/controllers/ModulesController.php | 47 ++++++++++++++ application/views/scripts/inline.phtml | 3 + .../views/scripts/mixedPagination.phtml | 61 +++++++++++++++++++ .../views/scripts/modules/overview.phtml | 38 ++++++++++++ application/views/scripts/modules/show.phtml | 24 ++++++++ .../Application/ApplicationBootstrap.php | 3 +- .../Icinga/Application/Modules/Manager.php | 54 +++++++++++----- public/js/icinga/container.js | 7 ++- public/js/icinga/util/async.js | 4 +- 9 files changed, 221 insertions(+), 20 deletions(-) create mode 100755 application/controllers/ModulesController.php create mode 100644 application/views/scripts/inline.phtml create mode 100755 application/views/scripts/mixedPagination.phtml create mode 100644 application/views/scripts/modules/overview.phtml create mode 100644 application/views/scripts/modules/show.phtml diff --git a/application/controllers/ModulesController.php b/application/controllers/ModulesController.php new file mode 100755 index 000000000..f8f40a3b3 --- /dev/null +++ b/application/controllers/ModulesController.php @@ -0,0 +1,47 @@ +manager = Icinga::app()->moduleManager(); + } + + public function indexAction() + { + $this->view->modules = $this->manager->select() + ->from('modules') + ->order('name'); + $this->render('overview'); + } + + public function overviewAction() + { + $this->indexAction(); + + } + + public function enableAction() + { + $this->manager->enableModule($this->_getParam('name')); + $this->redirectNow('modules/overview?_render=body'); + } + + public function disableAction() + { + $this->manager->disableModule($this->_getParam('name')); + $this->redirectNow('modules/overview?_render=body'); + } + +} diff --git a/application/views/scripts/inline.phtml b/application/views/scripts/inline.phtml new file mode 100644 index 000000000..24e5f00ce --- /dev/null +++ b/application/views/scripts/inline.phtml @@ -0,0 +1,3 @@ +layout()->moduleStart ?> +layout()->content ?> +layout()->moduleEnd ?> diff --git a/application/views/scripts/mixedPagination.phtml b/application/views/scripts/mixedPagination.phtml new file mode 100755 index 000000000..7b2b23570 --- /dev/null +++ b/application/views/scripts/mixedPagination.phtml @@ -0,0 +1,61 @@ +pageCount > 1): ?> +preserve)) { + $preserve = $this->preserve; +} else { + $preserve = array(); +} + +$fromto = t('%d to %d of %d'); +$total = $this->totalItemCount; +?> + + diff --git a/application/views/scripts/modules/overview.phtml b/application/views/scripts/modules/overview.phtml new file mode 100644 index 000000000..cc651c78f --- /dev/null +++ b/application/views/scripts/modules/overview.phtml @@ -0,0 +1,38 @@ +modules->limit(10); +$modules = $this->modules->paginate(); + +?> +

      Installed Modules

      +paginationControl($modules, null, null, array( + 'preserve' => $this->preserve +)); ?> + + + + + + + + +
      +enabled): ?> + qlink( + $module->name, + 'modules/disable', + array('name' => $module->name), + array('target'=>'body') + ) ?> + + qlink( + $module->name, + 'modules/enable', + array('name' => $module->name), + array('target'=>'body') + ) ?> + + (enabled + ? ($module->loaded ? 'enabled' : 'failed') + : 'disabled' + ?>)
      diff --git a/application/views/scripts/modules/show.phtml b/application/views/scripts/modules/show.phtml new file mode 100644 index 000000000..38d5cf050 --- /dev/null +++ b/application/views/scripts/modules/show.phtml @@ -0,0 +1,24 @@ +container('modules-container',array( + "class" => "expanded_absolute" +))->beginContent() ?> + + + + + + + + + + modules as $module): ?> + + + + + + + + +
      ModuleTypeActive
      + + \ No newline at end of file diff --git a/library/Icinga/Application/ApplicationBootstrap.php b/library/Icinga/Application/ApplicationBootstrap.php index dc40cb646..715850ee5 100755 --- a/library/Icinga/Application/ApplicationBootstrap.php +++ b/library/Icinga/Application/ApplicationBootstrap.php @@ -18,6 +18,7 @@ use Icinga\Exception\ConfigurationError; * Usage example for CLI: * * use Icinga\Application\Cli; + * Cli::start(); * * @@ -99,7 +100,7 @@ abstract class ApplicationBootstrap public function moduleManager() { if ($this->moduleManager === null) { - $this->moduleManager = new ModuleManager($this); + $this->moduleManager = new ModuleManager($this, "/etc/icinga2/modules_enabled"); } return $this->moduleManager; } diff --git a/library/Icinga/Application/Modules/Manager.php b/library/Icinga/Application/Modules/Manager.php index 45f4c89aa..4061a2421 100644 --- a/library/Icinga/Application/Modules/Manager.php +++ b/library/Icinga/Application/Modules/Manager.php @@ -6,6 +6,7 @@ use Icinga\Application\ApplicationBootstrap; use Icinga\Data\ArrayDatasource; use Icinga\Web\Notification; use Icinga\Exception\ConfigurationError; +use Icinga\Exception\SystemPermissionException; // TODO: show whether enabling/disabling modules is allowed by checking enableDir // perms @@ -20,17 +21,20 @@ class Manager protected $enableDir; - public function __construct(ApplicationBootstrap $app) + public function __construct(ApplicationBootstrap $app, $dir = null) { $this->app = $app; - $this->prepareEssentials(); + if ($dir === null) { + $dir = $this->app->getConfig()->getConfigDir() + . '/enabledModules'; + } + $this->prepareEssentials($dir); $this->detectEnabledModules(); } - protected function prepareEssentials() + protected function prepareEssentials($moduleDir) { - $this->enableDir = $this->app->getConfig()->getConfigDir() - . '/enabledModules'; + $this->enableDir = $moduleDir; if (! file_exists($this->enableDir) || ! is_dir($this->enableDir)) { throw new ProgrammingError( @@ -99,13 +103,20 @@ class Manager $target = $this->installedBaseDirs[$name]; $link = $this->enableDir . '/' . $name; if (! is_writable($this->enableDir)) { - Notification::error("I do not have permissions to enable modules"); + throw new SystemPermissionException( + "Insufficient system permissions for enabling modules", + "write", + $this->enableDir + ); + } + if (file_exists($link) && is_link($link)) { return $this; } - if (@symlink($target, $link)) { - Notification::success("The module $name has been enabled"); - } else { - Notification::error("Enabling module $name failed"); + if (!@symlink($target, $link)) { + $error = error_get_last(); + if (strstr($error["message"], "File exists") === false) { + throw new SystemPermissionException($error["message"], "symlink", $link); + } } return $this; } @@ -116,16 +127,29 @@ class Manager return $this; } if (! is_writable($this->enableDir)) { - Notification::error("I do not have permissions to disable modules"); + throw new SystemPermissionException("Can't write the module directory", "write", $this->enableDir); return $this; } $link = $this->enableDir . '/' . $name; + if (!file_exists($link)) { + throw new ConfigurationError("The module $name could not be found, can't disable it"); + } + if (!is_link($link)) { + throw new ConfigurationError( + "The module $name can't be disabled as this would delete the whole module. ". + "It looks like you have installed this module manually and moved it to your module folder.". + "In order to dynamically enable and disable modules, you have to create a symlink to ". + "the enabled_modules folder" + ); + } + if (file_exists($link) && is_link($link)) { - if (@unlink($link)) { - Notification::success("The module $name has been disabled"); - } else { - Notification::error("Disabling module $name failed"); + if (!@unlink($link)) { + $error = error_get_last(); + throw new SystemPermissionException($error["message"], "unlink", $link); } + } else { + } return $this; } diff --git a/public/js/icinga/container.js b/public/js/icinga/container.js index a64075b94..08d60f047 100755 --- a/public/js/icinga/container.js +++ b/public/js/icinga/container.js @@ -24,7 +24,7 @@ this.updateContainer = function(id,content,req) { var target = id; if (typeof id === "string") { - target = $('div[container-id='+id+']'); + target = this.getContainer(id); } var ctrl = $('.container-controls',target); target.html(content); @@ -100,6 +100,9 @@ }; this.getContainer = function(id) { + if(id == 'body') { + return $(document.body); + } return $('div[container-id='+id+']'); }; @@ -111,4 +114,4 @@ return containerMgrInstance; }); -})(); \ No newline at end of file +})(); diff --git a/public/js/icinga/util/async.js b/public/js/icinga/util/async.js index 8e015b45a..15a6be7df 100644 --- a/public/js/icinga/util/async.js +++ b/public/js/icinga/util/async.js @@ -10,7 +10,7 @@ }; var getDOMForDestination = function(destination) { var target = destination; - if(typeof destination === "string") { + if (typeof destination === "string") { target = containerMgr.getContainer(destination)[0]; } else if(typeof destination.context !== "undefined") { target = destination[0]; @@ -89,7 +89,7 @@ if(destination) { pending.push({ request: req, - DOM: getDOMForDestination(destination) + DOM: getDOMForDestination(destination) }); req.destination = destination; } From de34c2729f53d6bb519ed123142e53054cc72bc5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Thu, 20 Jun 2013 17:01:13 +0200 Subject: [PATCH 14/46] Add clearstatcache and tests for ModuleManager Added the clearstatcache call before enabling or disabling modules, as this prevents a 'File exists' error that occurs sometimes on symlink creation (even when the folder is empty). Also added tests for teh moduleManager refs #4092 --- .../Icinga/Application/Modules/Manager.php | 76 +++++++----- .../Icinga/Application/Modules/Manager.php | 111 ++++++++++++++++++ 2 files changed, 157 insertions(+), 30 deletions(-) create mode 100644 test/php/library/Icinga/Application/Modules/Manager.php diff --git a/library/Icinga/Application/Modules/Manager.php b/library/Icinga/Application/Modules/Manager.php index 4061a2421..f4612de7f 100644 --- a/library/Icinga/Application/Modules/Manager.php +++ b/library/Icinga/Application/Modules/Manager.php @@ -2,33 +2,39 @@ namespace Icinga\Application\Modules; -use Icinga\Application\ApplicationBootstrap; -use Icinga\Data\ArrayDatasource; -use Icinga\Web\Notification; use Icinga\Exception\ConfigurationError; use Icinga\Exception\SystemPermissionException; +use Icinga\Exception\ProgrammingError; // TODO: show whether enabling/disabling modules is allowed by checking enableDir // perms class Manager { - protected $installedBaseDirs; + protected $installedBaseDirs = null; protected $enabledDirs = array(); protected $loadedModules = array(); protected $index; protected $app; - protected $enableDir; - - public function __construct(ApplicationBootstrap $app, $dir = null) + protected $modulePaths = array(); + /** + * @param $app : The applicaiton bootstrap. This one needs a properly defined interface + * In order to test it correctly, the application now only requires a stdClass + * @param $dir : + **/ + public function __construct($app, $enabledDir = null, array $availableDirs = array()) { $this->app = $app; - if ($dir === null) { - $dir = $this->app->getConfig()->getConfigDir() + if (empty($availableDirs)) { + $availableDirs = array(ICINGA_APPDIR."/../modules"); + } + $this->modulePaths = $availableDirs; + if ($enabledDir === null) { + $enabledDir = $this->app->getConfig()->getConfigDir() . '/enabledModules'; } - $this->prepareEssentials($dir); + $this->prepareEssentials($enabledDir); $this->detectEnabledModules(); } @@ -46,10 +52,17 @@ class Manager } } + public function select() + { + $source = new \Icinga\Data\ArrayDataSource($this->getModuleInfo()); + return $source->select(); + } + protected function detectEnabledModules() { $fh = opendir($this->enableDir); + $this->enabledDirs = array(); while (false !== ($file = readdir($fh))) { if ($file[0] === '.') { @@ -78,12 +91,18 @@ class Manager return $this; } - public function loadModule($name) + public function loadModule($name, $moduleBase = null) { if ($this->hasLoaded($name)) { return $this; } - $module = new Module($this->app, $name, $this->getModuleDir($name)); + + $module = null; + if ($moduleBase === null) { + $module = new Module($this->app, $name, $this->getModuleDir($name)); + } else { + $module = new $moduleBase($this->app, $name, $this->getModuleDir($name)); + } $module->register(); $this->loadedModules[$name] = $module; return $this; @@ -100,6 +119,7 @@ class Manager ); return $this; } + clearstatcache(true); $target = $this->installedBaseDirs[$name]; $link = $this->enableDir . '/' . $name; if (! is_writable($this->enableDir)) { @@ -118,6 +138,7 @@ class Manager throw new SystemPermissionException($error["message"], "symlink", $link); } } + $this->enabledDirs[$name] = $link; return $this; } @@ -151,6 +172,7 @@ class Manager } else { } + unset($this->enabledDirs[$name]); return $this; } @@ -228,12 +250,6 @@ class Manager return $info; } - public function select() - { - $ds = new ArrayDatasource($this->getModuleInfo()); - return $ds->select(); - } - public function listEnabledModules() { return array_keys($this->enabledDirs); @@ -254,19 +270,19 @@ class Manager public function detectInstalledModules() { - // TODO: Allow multiple paths for installed modules (e.g. web vs pkg) - $basedir = realpath(ICINGA_APPDIR . '/../modules'); - $fh = @opendir($basedir); - if ($fh === false) { - return $this; - } - - while ($name = readdir($fh)) { - if ($name[0] === '.') { - continue; + foreach ($this->modulePaths as $basedir) { + $fh = opendir($basedir); + if ($fh === false) { + return $this; } - if (is_dir($basedir . '/' . $name)) { - $this->installedBaseDirs[$name] = $basedir . '/' . $name; + + while ($name = readdir($fh)) { + if ($name[0] === '.') { + continue; + } + if (is_dir($basedir . '/' . $name)) { + $this->installedBaseDirs[$name] = $basedir . '/' . $name; + } } } } diff --git a/test/php/library/Icinga/Application/Modules/Manager.php b/test/php/library/Icinga/Application/Modules/Manager.php new file mode 100644 index 000000000..24d2a8c25 --- /dev/null +++ b/test/php/library/Icinga/Application/Modules/Manager.php @@ -0,0 +1,111 @@ +name = $name; + $this->dir = $dir; + } + + public function register() + { + } +} + + +class ManagerTest extends \PHPUnit_Framework_TestCase +{ + const MODULE_TARGET = "/tmp"; + + protected function setUp() + { + $moduleDir = self::MODULE_TARGET; + if (!is_writable($moduleDir)) { + $this->markTestSkipped("Temporary folder not writable for this user"); + return; + } + if (is_dir($moduleDir."/enabledModules")) { + exec("rm -r $moduleDir/enabledModules"); + } + + mkdir($moduleDir."/enabledModules"); + } + + public function testDetectEnabledModules() + { + $manager = new ModuleManager(null, "/tmp/enabledModules", array("none")); + $this->assertEmpty($manager->listEnabledModules()); + + symlink(getcwd()."/res/testModules/module1", "/tmp/enabledModules/module1"); + $manager = new ModuleManager(null, "/tmp/enabledModules", array("none")); + $this->assertEquals(array("module1"), $manager->listEnabledModules()); + symlink(getcwd()."/res/testModules/module2", "/tmp/enabledModules/module2"); + symlink(getcwd()."/res/???", "/tmp/enabledModules/module3"); + $manager = new ModuleManager(null, "/tmp/enabledModules", array("none")); + $this->assertEquals(array("module1", "module2"), $manager->listEnabledModules()); + } + + public function testLoadModule() + { + $manager = new ModuleManager(null, "/tmp/enabledModules", array("./res/testModules")); + $this->assertEmpty($manager->getLoadedModules()); + $manager->loadModule("module1", "Tests\Icinga\Application\Module\Manager\ModuleMock"); + $elems = $manager->getLoadedModules(); + $this->assertNotEmpty($elems); + $this->assertTrue(isset($elems["module1"])); + // assert the changes not to be permanent: + $manager = new ModuleManager(null, "/tmp/enabledModules", array("./res/testModules")); + $this->assertEmpty($manager->getLoadedModules()); + } + + public function testEnableModule() + { + $manager = new ModuleManager(null, "/tmp/enabledModules", array(getcwd()."/res/testModules")); + $this->assertEmpty($manager->listEnabledModules()); + $manager->enableModule("module1"); + $elems = $manager->listEnabledModules(); + $this->assertNotEmpty($elems); + $this->assertEquals($elems[0], "module1"); + $this->assertTrue(is_link("/tmp/enabledModules/module1")); + // assert the changes to be permanent: + $manager = new ModuleManager(null, "/tmp/enabledModules", array("./res/testModules")); + $this->assertNotEmpty($manager->listEnabledModules()); + } + + public function testDisableModule() + { + clearstatcache(true); + symlink(getcwd()."/res/testModules/module1", "/tmp/enabledModules/module1"); + $manager = new ModuleManager(null, "/tmp/enabledModules", array(getcwd()."/res/testModules")); + $elems = $manager->listEnabledModules(); + $this->assertNotEmpty($elems); + $this->assertEquals($elems[0], "module1"); + $manager->disableModule("module1"); + $this->assertFalse(file_exists("/tmp/enabledModules/module1")); + $this->assertEmpty($manager->listEnabledModules()); + // assert the changes to be permanent: + $manager = new ModuleManager(null, "/tmp/enabledModules", array("./res/testModules")); + $this->assertEmpty($manager->listEnabledModules()); + } + + protected function tearDown() + { + $moduleDir = self::MODULE_TARGET; + exec("rm -r $moduleDir/enabledModules"); + + } +} From 04511121b1ee2c53fed2ed6fc477307529b78dba Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Fri, 21 Jun 2013 09:53:37 +0200 Subject: [PATCH 15/46] Remove moved files the 'behaviour' namespace in javascript has been renamed to module refs #4092 --- public/js/icinga/behaviour/actionTable.js | 118 ---------------------- public/js/icinga/behaviour/mainDetail.js | 94 ----------------- 2 files changed, 212 deletions(-) delete mode 100644 public/js/icinga/behaviour/actionTable.js delete mode 100755 public/js/icinga/behaviour/mainDetail.js diff --git a/public/js/icinga/behaviour/actionTable.js b/public/js/icinga/behaviour/actionTable.js deleted file mode 100644 index e8e61952b..000000000 --- a/public/js/icinga/behaviour/actionTable.js +++ /dev/null @@ -1,118 +0,0 @@ -/*global Icinga:false, document: false, define:false require:false base_url:false console:false */ - -/** - * ActionTable behaviour as described in - * https://wiki.icinga.org/display/cranberry/Frontend+Components#FrontendComponents-ActionTable - * - * @TODO: Row selection - */ -define(['jquery','logging','icinga/util/async'],function($,log,async) { - "use strict"; - - var ActionTableBehaviour = function() { - var onTableHeaderClick; - - var TABLE_BASE_MATCHER = '.icinga-container table.action'; - var linksInActionTable = TABLE_BASE_MATCHER+" tbody tr > a"; - var actionTableRow = TABLE_BASE_MATCHER+" tbody tr"; - var headerRow = TABLE_BASE_MATCHER+" > th a"; - var searchField = ".icinga-container .actiontable.controls input[type=search]"; - - - onTableHeaderClick = function (ev) { - var target = ev.currentTarget, - href = $(target).attr('href'), - destination; - if ($(target).parents('.layout-main-detail').length) { - if ($(target).parents("#icinga-main").length) { - destination = 'icinga-main'; - } - else { - destination = 'icinga-detail'; - } - - } else { - destination = 'icinga-main'; - } - async.loadToTarget(destination, href); - ev.preventDefault(); - ev.stopImmediatePropagation(); - return false; - }; - - var onLinkTagClick = function(ev) { - - var target = ev.currentTarget, - href = $(target).attr('href'), - destination; - if ($(target).parents('.layout-main-detail').length) { - destination = 'icinga-detail'; - } else { - destination = 'icinga-main'; - } - async.loadToTarget(destination,href); - ev.preventDefault(); - ev.stopImmediatePropagation(); - return false; - - }; - - var onTableRowClick = function(ev) { - ev.stopImmediatePropagation(); - - var target = $(ev.currentTarget), - href = target.attr('href'), - destination; - $('tr.active',target.parent('tbody').first()).removeClass("active"); - target.addClass('active'); - - // When the tr has a href, act like it is a link - if(href) { - ev.currentTarget = target.first(); - return onLinkTagClick(ev); - } - // Try to find a designated row action - var links = $("a.row-action",target); - if(links.length) { - ev.currentTarget = links.first(); - return onLinkTagClick(ev); - } - - // otherwise use the first anchor tag - links = $("a",target); - if(links.length) { - ev.currentTarget = links.first(); - return onLinkTagClick(ev); - } - - log.debug("No target for this table row found"); - return false; - }; - - var onSearchInput = function(ev) { - ev.stopImmediatePropagation(); - var txt = $(this).val(); - }; - - this.eventHandler = {}; - this.eventHandler[linksInActionTable] = { - 'click' : onLinkTagClick - }; - this.eventHandler[actionTableRow] = { - 'click' : onTableRowClick - }; - this.eventHandler[headerRow] = { - 'click' : onTableHeaderClick - }; - this.eventHandler[searchField] = { - 'keyup' : onSearchInput - }; - - this.enable = function() { - - }; - }; - - return new ActionTableBehaviour(); - -}); \ No newline at end of file diff --git a/public/js/icinga/behaviour/mainDetail.js b/public/js/icinga/behaviour/mainDetail.js deleted file mode 100755 index 9a207c933..000000000 --- a/public/js/icinga/behaviour/mainDetail.js +++ /dev/null @@ -1,94 +0,0 @@ -/*global Icinga:false, document: false, define:false require:false base_url:false console:false */ - -/** - * Main-Detail layout behaviour as described in - * https://wiki.icinga.org/display/cranberry/Frontend+Components#FrontendComponents-Behaviour - * - */ -define(['jquery','logging','icinga/util/async'],function($,log,async) { - "use strict"; - - var MainDetailBehaviour = function() { - - var onOuterLinkClick = function(ev) { - var a = $(ev.currentTarget), - target = a.attr("target"), - href = a.attr("href"); - ev.stopImmediatePropagation(); - collapseDetailView(); - async.loadToTarget("icinga-main",href); - return false; - }; - - var onLinkTagClick = function(ev) { - - var a = $(ev.currentTarget), - target = a.attr("target"), - href = a.attr("href"); - - // check for protocol:// - if(/^[A-Z]{2,10}\:\/\//i.test(href)) { - window.open(href); - ev.stopImmediatePropagation(); - return false; - } - - // check for link in table header - if(a.parents('th').length > 0) { - ev.stopImmediatePropagation(); - return false; - } - - if(typeof target === "undefined") { - if(a.parents("#icinga-detail").length) { - async.loadToTarget("icinga-detail",href); - } else { - async.loadToTarget("icinga-main",href); - } - } else { - switch(target) { - case "main": - async.loadToTarget("icinga-main",href); - collapseDetailView(); - break; - case "detail": - async.loadToTarget("icinga-detail",href); - break; - case "popup": - async.loadToTarget(null,href); - break; - default: - return true; - } - } - ev.stopImmediatePropagation(); - return false; - }; - - var expandDetailView = function() { - $("#icinga-detail").parents(".collapsed").removeClass('collapsed'); - }; - - var collapseDetailView = function(elementInDetailView) { - $("#icinga-detail").parents(".layout-main-detail").addClass('collapsed'); - }; - - this.expandDetailView = expandDetailView; - this.collapseDetailView = collapseDetailView; - - this.eventHandler = { - '.layout-main-detail * a' : { - 'click' : onLinkTagClick - }, - 'a' : { - 'click' : onOuterLinkClick - }, - '.layout-main-detail .icinga-container#icinga-detail' : { - 'focus' : expandDetailView - } - }; - }; - - return new MainDetailBehaviour(); -}); - From 6881c8d0743bf229eee130f13dc0a8bb8db584e8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Fri, 21 Jun 2013 11:36:12 +0200 Subject: [PATCH 16/46] Add javascript autoloading the js/modules/%modulename%/%file% is now mapped to the module path (if existing). To prevent name clashing, the modules folder has been renamed to components. --- application/controllers/StaticController.php | 10 ++++++---- library/Icinga/Application/Web.php | 12 ++++++++++++ .../js/icinga/{modules => components}/actionTable.js | 0 .../js/icinga/{modules => components}/mainDetail.js | 0 public/js/icinga/container.js | 10 +++------- public/js/icinga/icinga.js | 4 ++-- 6 files changed, 23 insertions(+), 13 deletions(-) rename public/js/icinga/{modules => components}/actionTable.js (100%) rename public/js/icinga/{modules => components}/mainDetail.js (100%) diff --git a/application/controllers/StaticController.php b/application/controllers/StaticController.php index bb5723a84..5704dbf4a 100644 --- a/application/controllers/StaticController.php +++ b/application/controllers/StaticController.php @@ -9,6 +9,7 @@ use Icinga\Web\ActionController; use Icinga\Application\Icinga; use Zend_Controller_Action_Exception as ActionException; +use Icinga\Application\Benchmark; /** * Class StaticController * @package Icinga\Web\Form @@ -69,7 +70,7 @@ class StaticController extends ActionController */ public function javascriptAction() { - $module = $this->_getParam('moduleName'); + $module = $this->_getParam('module_name'); $file = $this->_getParam('file'); $basedir = Icinga::app()->getModule($module)->getBaseDir(); @@ -96,15 +97,16 @@ class StaticController extends ActionController ) . ' GMT' ); + $hash = md5_file($filePath); + if ($hash === $this->getRequest()->getHeader('If-None-Match')) { $response->setHttpResponseCode(304); return; } else { readfile($filePath); } - // TODO: get rid of exit: - exit; + return; } } -// @codingStandardsIgnoreEnd \ No newline at end of file +// @codingStandardsIgnoreEnd diff --git a/library/Icinga/Application/Web.php b/library/Icinga/Application/Web.php index d034d344f..123c25acf 100644 --- a/library/Icinga/Application/Web.php +++ b/library/Icinga/Application/Web.php @@ -60,6 +60,17 @@ class Web extends ApplicationBootstrap ) ) ); + + $this->frontController->getRouter()->addRoute( + 'module_javascript', + new Route( + 'js/modules/:module_name/:file', + array( + 'controller' => 'static', + 'action' => 'javascript' + ) + ) + ); return $this; } @@ -173,6 +184,7 @@ class Web extends ApplicationBootstrap */ protected function configurePagination() { + Paginator::addScrollingStylePrefixPath( 'Icinga_Web_Paginator_ScrollingStyle', 'Icinga/Web/Paginator/ScrollingStyle' diff --git a/public/js/icinga/modules/actionTable.js b/public/js/icinga/components/actionTable.js similarity index 100% rename from public/js/icinga/modules/actionTable.js rename to public/js/icinga/components/actionTable.js diff --git a/public/js/icinga/modules/mainDetail.js b/public/js/icinga/components/mainDetail.js similarity index 100% rename from public/js/icinga/modules/mainDetail.js rename to public/js/icinga/components/mainDetail.js diff --git a/public/js/icinga/container.js b/public/js/icinga/container.js index 08d60f047..8e0891802 100755 --- a/public/js/icinga/container.js +++ b/public/js/icinga/container.js @@ -5,7 +5,7 @@ var containerMgrInstance = null; var async; - var ContainerMgr = function($,log,Widgets,SubTable,holder) { + var ContainerMgr = function($,log,Widgets,SubTable) { var enhanceDetachLinks = function() { @@ -34,14 +34,12 @@ } target.focus(); this.initializeContainers(target); - holder.run(); }; this.updateControlTargets = function(ctrl, req) { $('a',ctrl).each(function() { $(this).attr("href",req.url); }); - holder.run(); }; this.initControlBehaviour = function(root) { @@ -86,7 +84,6 @@ this.initExpandables(root); this.drawImplicitWidgets(root); this.loadAsyncContainers(root); - holder.run(); }; this.createPopupContainer = function(content,req) { @@ -96,7 +93,6 @@ .append($("
      ").addClass('modal-body').html(content)).appendTo(document.body); closeButton.on("click",function() {container.remove();}); - holder.run(); }; this.getContainer = function(id) { @@ -107,9 +103,9 @@ }; }; - define(['jquery','logging','icinga/widgets/checkIcons','icinga/widgets/subTable','Holder'],function($,log,widgets,subTable,holder) { + define(['jquery','logging','icinga/widgets/checkIcons','icinga/widgets/subTable'],function($,log,widgets,subTable) { if (containerMgrInstance === null) { - containerMgrInstance = new ContainerMgr($,log,widgets,subTable,holder); + containerMgrInstance = new ContainerMgr($,log,widgets,subTable); } return containerMgrInstance; diff --git a/public/js/icinga/icinga.js b/public/js/icinga/icinga.js index 9be6b9013..ff59321f6 100755 --- a/public/js/icinga/icinga.js +++ b/public/js/icinga/icinga.js @@ -13,7 +13,7 @@ define([ * Icinga prototype */ var Icinga = function() { - var internalModules = ['icinga/modules/actionTable','icinga/modules/mainDetail']; + var internalModules = ['icinga/components/actionTable','icinga/components/mainDetail']; this.modules = {}; var failedModules = []; @@ -37,7 +37,7 @@ define([ }; var loadModuleScript = function(name) { - moduleMgr.enableModule("modules/"+name, function(error) { + moduleMgr.enableModule("modules/"+name+"/"+name, function(error) { failedModules.push({ name: name, errorMessage: error From 01611d8a8b330f150906484337a4cdd3d8a7e072 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Fri, 21 Jun 2013 11:40:25 +0200 Subject: [PATCH 17/46] Fix test for new module route The js base route is now js/modules/%modulename%/%file%. This commit reflects these changes in the testcases refs #4092 refs #3735 --- test/js/test/icinga/moduleTest.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/js/test/icinga/moduleTest.js b/test/js/test/icinga/moduleTest.js index 6a446b5f4..494d0264a 100644 --- a/test/js/test/icinga/moduleTest.js +++ b/test/js/test/icinga/moduleTest.js @@ -195,7 +195,7 @@ describe('The icinga module bootstrap', function() { var testClick = false; rjsmock.registerDependencies({ "icinga/module": module, - "modules/test" : { + "modules/test/test" : { eventHandler: { "a.test" : { click : function() { From c239117c559e3d9ce5f257bdaf17d8262976cb54 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Fri, 21 Jun 2013 15:33:06 +0200 Subject: [PATCH 18/46] Add support for lazy module loading When the X-Icinga-Module-Enable header is send, the modulemanager automatically tries to load javascript files for that module. This is realized by adding the 'registerHeaderListener' method to the async manager, which allows to listen to specific headers and firing callbacks if a response with the specified header is retrieved. Also the tests have changed a bit, requireNow should be used when using the requiremock, so a require always loads files new. refs #4092 refs #3753 --- application/controllers/ModulesController.php | 6 +- public/js/icinga/icinga.js | 8 ++- public/js/icinga/util/async.js | 34 ++++++++-- test/js/test/icinga/asyncTest.js | 35 +++++++++++ test/js/test/icinga/moduleTest.js | 62 +++++++++++++++++-- test/js/testlib/asyncmock.js | 33 ++++++++++ test/js/testlib/requiremock.js | 15 ++++- 7 files changed, 179 insertions(+), 14 deletions(-) create mode 100644 test/js/test/icinga/asyncTest.js create mode 100644 test/js/testlib/asyncmock.js diff --git a/application/controllers/ModulesController.php b/application/controllers/ModulesController.php index f8f40a3b3..afd3b9178 100755 --- a/application/controllers/ModulesController.php +++ b/application/controllers/ModulesController.php @@ -35,7 +35,11 @@ class ModulesController extends ActionController public function enableAction() { $this->manager->enableModule($this->_getParam('name')); - $this->redirectNow('modules/overview?_render=body'); + $this->manager->loadModule($this->_getParam('name')); + $this->getResponse()->setHeader('X-Icinga-Enable-Module', $this->_getParam('name')); + $this->replaceLayout = true; + $this->indexAction(); + } public function disableAction() diff --git a/public/js/icinga/icinga.js b/public/js/icinga/icinga.js index ff59321f6..d538ab552 100755 --- a/public/js/icinga/icinga.js +++ b/public/js/icinga/icinga.js @@ -19,16 +19,19 @@ define([ var failedModules = []; var initialize = function () { + registerLazyModuleLoading(); enableInternalModules(); - + containerMgr.registerAsyncMgr(async); containerMgr.initializeContainers(document); log.debug("Initialization finished"); enableModules(); }; - + var registerLazyModuleLoading = function() { + async.registerHeaderListener("X-Icinga-Enable-Module", loadModuleScript, this); + }; var enableInternalModules = function() { $.each(internalModules,function(idx,module) { @@ -37,6 +40,7 @@ define([ }; var loadModuleScript = function(name) { + console.log("Loading ", name); moduleMgr.enableModule("modules/"+name+"/"+name, function(error) { failedModules.push({ name: name, diff --git a/public/js/icinga/util/async.js b/public/js/icinga/util/async.js index 15a6be7df..1b564b176 100644 --- a/public/js/icinga/util/async.js +++ b/public/js/icinga/util/async.js @@ -3,7 +3,8 @@ "use strict"; var asyncMgrInstance = null; - define(['icinga/container','logging','icinga/behaviour','jquery'],function(containerMgr,log,behaviour,$) { + define(['icinga/container','logging','jquery'],function(containerMgr,log,$) { + var headerListeners = {}; var pending = { @@ -18,12 +19,30 @@ return target; }; - var handleResponse = function(html) { + var applyHeaderListeners = function(headers) { + for (var header in headerListeners) { + if (headers.getResponseHeader(header) === null) { + // see if the browser/server converts headers to lowercase + if (headers.getResponseHeader(header.toLowerCase()) === null) { + continue; + } + header = header.toLowerCase(); + } + var value = headers.getResponseHeader(header); + var listeners = headerListeners[header]; + for (var i=0;i")); $('a.test').click(); @@ -223,4 +226,55 @@ describe('The icinga module bootstrap', function() { should.equal(icinga.getFailedModules()[0].name, "test2"); tearDownTestDOM(); }); + + it("Should load modules lazily when discovering a X-Icinga-Enable-Module header", function() { + rjsmock.purgeDependencies(); + + requireNew("icinga/util/async.js"); + var async = rjsmock.getDefine(); + + rjsmock.registerDependencies({ + "icinga/module": module, + "icinga/util/async": async, + "modules/test/test" : { + eventHandler: { + "a.test" : { + click : function() { + testClick = true; + } + } + } + }, + "icinga/container" : { + registerAsyncMgr: function() {}, + initializeContainers: function() {} + }, + "modules/list" : [ + ] + }); + + tearDownTestDOM(); + + requireNew("icinga/icinga.js"); + var icinga = rjsmock.getDefine(); + + var testClick = false; + // The module shouldn't be loaded + $('body').append($("")); + $('a.test').click(); + should.equal(testClick, false, "Unregistered module was loaded"); + + asyncMock.setNextAsyncResult(async,"result", false, { + "X-Icinga-Enable-Module" : "test" + }); + async.createRequest(); + // The module shouldn't be loaded + $('body').append($("")); + $('a.test').click(); + should.equal(testClick, true, "Module wasn't automatically loaded on header!"); + + + tearDownTestDOM(); + + }); }); diff --git a/test/js/testlib/asyncmock.js b/test/js/testlib/asyncmock.js new file mode 100644 index 000000000..aad6d5eea --- /dev/null +++ b/test/js/testlib/asyncmock.js @@ -0,0 +1,33 @@ +/** + * Helper for mocking $.async's XHR requests + * + */ + + +var getCallback = function(empty, response, succeed, headers) { + if (empty) + return function() {}; + return function(callback) { + callback(response, succeed, { + getAllResponseHeaders: function() { + return headers; + }, + getResponseHeader: function(header) { + return headers[header] || null; + } + }); + }; +}; + +module.exports = { + setNextAsyncResult: function(async, response, fails, headers) { + headers = headers || {}; + var succeed = fails ? "fail" : "success"; + async.__internalXHRImplementation = function(config) { + return { + done: getCallback(fails, response, succeed, headers), + fail: getCallback(!fails, response, succeed, headers) + }; + }; + } +}; diff --git a/test/js/testlib/requiremock.js b/test/js/testlib/requiremock.js index 8181092da..e61b08694 100644 --- a/test/js/testlib/requiremock.js +++ b/test/js/testlib/requiremock.js @@ -13,6 +13,7 @@ * to console. * **/ +var path = require('path'); var registeredDependencies = {}; /** @@ -21,11 +22,13 @@ var registeredDependencies = {}; * in dependencies and calls fn with them as the parameter * **/ +var debug = false; var requireJsMock = function(dependencies, fn) { var fnArgs = []; for (var i=0;i Date: Fri, 14 Jun 2013 15:49:21 +0200 Subject: [PATCH 19/46] Add temporary http server for casperjs tests Added a static folder and spawn a small HTTP server on runtests. This is not really the best solution, as it uses pythons simpleHTTPServer, but it works for now refs #4315 --- test/frontend/cases/static-page-test.js | 7 +++++-- test/frontend/runtests | 7 +++++-- test/frontend/static/empty.html | 7 +++++++ 3 files changed, 17 insertions(+), 4 deletions(-) create mode 100644 test/frontend/static/empty.html diff --git a/test/frontend/cases/static-page-test.js b/test/frontend/cases/static-page-test.js index b77496f86..f37a2a214 100644 --- a/test/frontend/cases/static-page-test.js +++ b/test/frontend/cases/static-page-test.js @@ -7,11 +7,14 @@ i2w = require('./i2w-config'); var casper = i2w.getTestEnv(); -casper.start("http://build.icinga.org/jenkins"); +casper.start("http://localhost:12999/empty.html"); + casper.then(function() { - this.test.assertTitle("icinga-web test [Jenkins]", "The jenkins page"); + casper.log(this.test); + this.test.assertTitle("Just an empty page"); }); + casper.run(function() { this.test.done(); diff --git a/test/frontend/runtests b/test/frontend/runtests index 4e913ea72..cb24dd57b 100755 --- a/test/frontend/runtests +++ b/test/frontend/runtests @@ -108,8 +108,11 @@ if [ "$EXCLUDE" != "" ];then fi FILELIST=`echo $FILELIST | grep -v "$NAME"` fi; - +cd $DIR/static +python -m SimpleHTTPServer 12999& +PID=$! +cd $DIR echo $EXEC $FILELIST $EXEC $FILELIST - +kill $PID exit 0 diff --git a/test/frontend/static/empty.html b/test/frontend/static/empty.html new file mode 100644 index 000000000..965daf8c7 --- /dev/null +++ b/test/frontend/static/empty.html @@ -0,0 +1,7 @@ + + + Just an empty page + + + + From b46dd9bae4e61a6e2b3f3d7cb7edef661e5994af Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Mon, 17 Jun 2013 12:40:10 +0200 Subject: [PATCH 20/46] Remove behaviour files These files are not required anymore as they are now renamed to 'modules' and may affect testting refs #3753 refs #4303 --- public/js/icinga/behaviour.js | 86 ---------------- public/js/icinga/behaviour/actionTable.js | 118 ---------------------- public/js/icinga/behaviour/mainDetail.js | 94 ----------------- 3 files changed, 298 deletions(-) delete mode 100644 public/js/icinga/behaviour.js delete mode 100644 public/js/icinga/behaviour/actionTable.js delete mode 100755 public/js/icinga/behaviour/mainDetail.js diff --git a/public/js/icinga/behaviour.js b/public/js/icinga/behaviour.js deleted file mode 100644 index 6a432d00f..000000000 --- a/public/js/icinga/behaviour.js +++ /dev/null @@ -1,86 +0,0 @@ -/*global Icinga:false, $: false, document: false, define:false require:false base_url:false console:false */ - - -/** - This prototype encapsulates the behaviours registered in the behaviour folder - **/ -(function() { - "use strict"; - - var loaded = {}; - - define(['logging'],function(log) { - - var registerBehaviourFunctions = function(behaviour) { - var enableFn = behaviour.enable, disableFn = behaviour.disable; - - behaviour.enable = (function(root) { - root = root || document; - for (var jqMatcher in this.eventHandler) { - for (var event in this.eventHandler[jqMatcher]) { - log.debug("Registered behaviour: ","'"+event+"'", jqMatcher); - $(root).on(event,jqMatcher,this.eventHandler[jqMatcher][event]); - } - } - if(enableFn) { - enableFn.apply(this,arguments); - } - }).bind(behaviour); - - behaviour.disable = (function(root) { - for (var jqMatcher in this.eventHandler) { - for (var event in this.eventHandler[jqMatcher]) { - log.debug("Unregistered behaviour: ","'"+event+"'", jqMatcher); - $(root).off(event,jqMatcher,this.eventHandler[jqMatcher][event]); - } - } - if (disableFn) { - disableFn.apply(this,arguments); - } - }).bind(behaviour); - - - }; - - var CallInterface = function() { - - /** - * Loads a behaviour and calls successCallback with the behaviour as the parameter on success, otherwise - * the errorCallback with the errorstring as the first parameter - * - * @param name - * @param errorCallback - * @param successCallback - */ - this.enableBehaviour = function(name,errorCallback,successCallback) { - require([name],function(behaviour) { - if (typeof behaviour.eventHandler === "object") { - registerBehaviourFunctions(behaviour); - } - if (typeof behaviour.enable === "function") { - behaviour.enable(); - } - loaded[name] = { - behaviour: behaviour, - active: true - }; - if (typeof successCallback === "function") { - successCallback(behaviour); - } - },function(err) { - errorCallback("Could not load behaviour "+name+" "+err,err); - }); - }; - - this.disableBehaviour = function(name) { - if(loaded[name] && loaded[name].active) { - loaded[name].disable(); - } - }; - - }; - - return new CallInterface(); - }); - -})(); \ No newline at end of file diff --git a/public/js/icinga/behaviour/actionTable.js b/public/js/icinga/behaviour/actionTable.js deleted file mode 100644 index e8e61952b..000000000 --- a/public/js/icinga/behaviour/actionTable.js +++ /dev/null @@ -1,118 +0,0 @@ -/*global Icinga:false, document: false, define:false require:false base_url:false console:false */ - -/** - * ActionTable behaviour as described in - * https://wiki.icinga.org/display/cranberry/Frontend+Components#FrontendComponents-ActionTable - * - * @TODO: Row selection - */ -define(['jquery','logging','icinga/util/async'],function($,log,async) { - "use strict"; - - var ActionTableBehaviour = function() { - var onTableHeaderClick; - - var TABLE_BASE_MATCHER = '.icinga-container table.action'; - var linksInActionTable = TABLE_BASE_MATCHER+" tbody tr > a"; - var actionTableRow = TABLE_BASE_MATCHER+" tbody tr"; - var headerRow = TABLE_BASE_MATCHER+" > th a"; - var searchField = ".icinga-container .actiontable.controls input[type=search]"; - - - onTableHeaderClick = function (ev) { - var target = ev.currentTarget, - href = $(target).attr('href'), - destination; - if ($(target).parents('.layout-main-detail').length) { - if ($(target).parents("#icinga-main").length) { - destination = 'icinga-main'; - } - else { - destination = 'icinga-detail'; - } - - } else { - destination = 'icinga-main'; - } - async.loadToTarget(destination, href); - ev.preventDefault(); - ev.stopImmediatePropagation(); - return false; - }; - - var onLinkTagClick = function(ev) { - - var target = ev.currentTarget, - href = $(target).attr('href'), - destination; - if ($(target).parents('.layout-main-detail').length) { - destination = 'icinga-detail'; - } else { - destination = 'icinga-main'; - } - async.loadToTarget(destination,href); - ev.preventDefault(); - ev.stopImmediatePropagation(); - return false; - - }; - - var onTableRowClick = function(ev) { - ev.stopImmediatePropagation(); - - var target = $(ev.currentTarget), - href = target.attr('href'), - destination; - $('tr.active',target.parent('tbody').first()).removeClass("active"); - target.addClass('active'); - - // When the tr has a href, act like it is a link - if(href) { - ev.currentTarget = target.first(); - return onLinkTagClick(ev); - } - // Try to find a designated row action - var links = $("a.row-action",target); - if(links.length) { - ev.currentTarget = links.first(); - return onLinkTagClick(ev); - } - - // otherwise use the first anchor tag - links = $("a",target); - if(links.length) { - ev.currentTarget = links.first(); - return onLinkTagClick(ev); - } - - log.debug("No target for this table row found"); - return false; - }; - - var onSearchInput = function(ev) { - ev.stopImmediatePropagation(); - var txt = $(this).val(); - }; - - this.eventHandler = {}; - this.eventHandler[linksInActionTable] = { - 'click' : onLinkTagClick - }; - this.eventHandler[actionTableRow] = { - 'click' : onTableRowClick - }; - this.eventHandler[headerRow] = { - 'click' : onTableHeaderClick - }; - this.eventHandler[searchField] = { - 'keyup' : onSearchInput - }; - - this.enable = function() { - - }; - }; - - return new ActionTableBehaviour(); - -}); \ No newline at end of file diff --git a/public/js/icinga/behaviour/mainDetail.js b/public/js/icinga/behaviour/mainDetail.js deleted file mode 100755 index 9a207c933..000000000 --- a/public/js/icinga/behaviour/mainDetail.js +++ /dev/null @@ -1,94 +0,0 @@ -/*global Icinga:false, document: false, define:false require:false base_url:false console:false */ - -/** - * Main-Detail layout behaviour as described in - * https://wiki.icinga.org/display/cranberry/Frontend+Components#FrontendComponents-Behaviour - * - */ -define(['jquery','logging','icinga/util/async'],function($,log,async) { - "use strict"; - - var MainDetailBehaviour = function() { - - var onOuterLinkClick = function(ev) { - var a = $(ev.currentTarget), - target = a.attr("target"), - href = a.attr("href"); - ev.stopImmediatePropagation(); - collapseDetailView(); - async.loadToTarget("icinga-main",href); - return false; - }; - - var onLinkTagClick = function(ev) { - - var a = $(ev.currentTarget), - target = a.attr("target"), - href = a.attr("href"); - - // check for protocol:// - if(/^[A-Z]{2,10}\:\/\//i.test(href)) { - window.open(href); - ev.stopImmediatePropagation(); - return false; - } - - // check for link in table header - if(a.parents('th').length > 0) { - ev.stopImmediatePropagation(); - return false; - } - - if(typeof target === "undefined") { - if(a.parents("#icinga-detail").length) { - async.loadToTarget("icinga-detail",href); - } else { - async.loadToTarget("icinga-main",href); - } - } else { - switch(target) { - case "main": - async.loadToTarget("icinga-main",href); - collapseDetailView(); - break; - case "detail": - async.loadToTarget("icinga-detail",href); - break; - case "popup": - async.loadToTarget(null,href); - break; - default: - return true; - } - } - ev.stopImmediatePropagation(); - return false; - }; - - var expandDetailView = function() { - $("#icinga-detail").parents(".collapsed").removeClass('collapsed'); - }; - - var collapseDetailView = function(elementInDetailView) { - $("#icinga-detail").parents(".layout-main-detail").addClass('collapsed'); - }; - - this.expandDetailView = expandDetailView; - this.collapseDetailView = collapseDetailView; - - this.eventHandler = { - '.layout-main-detail * a' : { - 'click' : onLinkTagClick - }, - 'a' : { - 'click' : onOuterLinkClick - }, - '.layout-main-detail .icinga-container#icinga-detail' : { - 'focus' : expandDetailView - } - }; - }; - - return new MainDetailBehaviour(); -}); - From 0694973c8865616641c7c27b016159621f0cee82 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Mon, 17 Jun 2013 17:13:30 +0200 Subject: [PATCH 21/46] Add history api and modify js for tests All JS Files now call 'requirejs' instead of 'require', also the holder.js reference is removed and the history api added. Tests are following in the next commit refs #4303 refs #4315 --- public/js/icinga/container.js | 14 +++++++------- public/js/icinga/icinga.js | 8 +++++++- public/js/icinga/util/async.js | 13 +++++++++---- public/js/vendor/history.js | 1 + 4 files changed, 24 insertions(+), 12 deletions(-) create mode 100644 public/js/vendor/history.js diff --git a/public/js/icinga/container.js b/public/js/icinga/container.js index a64075b94..13c17b090 100755 --- a/public/js/icinga/container.js +++ b/public/js/icinga/container.js @@ -34,14 +34,14 @@ } target.focus(); this.initializeContainers(target); - holder.run(); + }; this.updateControlTargets = function(ctrl, req) { $('a',ctrl).each(function() { $(this).attr("href",req.url); }); - holder.run(); + }; this.initControlBehaviour = function(root) { @@ -86,7 +86,7 @@ this.initExpandables(root); this.drawImplicitWidgets(root); this.loadAsyncContainers(root); - holder.run(); + }; this.createPopupContainer = function(content,req) { @@ -96,7 +96,7 @@ .append($("
      ").addClass('modal-body').html(content)).appendTo(document.body); closeButton.on("click",function() {container.remove();}); - holder.run(); + }; this.getContainer = function(id) { @@ -104,11 +104,11 @@ }; }; - define(['jquery','logging','icinga/widgets/checkIcons','icinga/widgets/subTable','Holder'],function($,log,widgets,subTable,holder) { + define(['jquery','logging','icinga/widgets/checkIcons','icinga/widgets/subTable'], function($,log,widgets,subTable) { if (containerMgrInstance === null) { - containerMgrInstance = new ContainerMgr($,log,widgets,subTable,holder); + containerMgrInstance = new ContainerMgr($,log,widgets,subTable); } return containerMgrInstance; }); -})(); \ No newline at end of file +})(); diff --git a/public/js/icinga/icinga.js b/public/js/icinga/icinga.js index 9be6b9013..31f78dcae 100755 --- a/public/js/icinga/icinga.js +++ b/public/js/icinga/icinga.js @@ -67,7 +67,13 @@ define([ loadIntoContainer: function(ctr) { }, - + + loadUrl: function(url, target, params) { + target = target || "icinga-main"; + async.loadToTarget(target, url, params); + History.pushState(params, document.title, url); + }, + getFailedModules: function() { return failedModules; } diff --git a/public/js/icinga/util/async.js b/public/js/icinga/util/async.js index efab52ed7..27e56cb7d 100644 --- a/public/js/icinga/util/async.js +++ b/public/js/icinga/util/async.js @@ -3,7 +3,7 @@ "use strict"; var asyncMgrInstance = null; - define(['icinga/container','logging','icinga/behaviour','jquery'],function(containerMgr,log,behaviour,$) { + define(['icinga/container','logging','jquery'],function(containerMgr,log,$) { var pending = { @@ -21,7 +21,6 @@ }; var handleResponse = function(html) { - if(this.destination) { containerMgr.updateContainer(this.destination,html,this); } else { @@ -94,7 +93,13 @@ }); req.destination = destination; } - + if (destination == "icinga-main") { + History.pushState(data, document.title, url); + } else { + data = data || {}; + data[destination] = url; + History.pushState(data, document.title, document.location.href); + } return req; }; @@ -106,4 +111,4 @@ return new CallInterface(); }); -})(); \ No newline at end of file +})(); diff --git a/public/js/vendor/history.js b/public/js/vendor/history.js new file mode 100644 index 000000000..e9998d96a --- /dev/null +++ b/public/js/vendor/history.js @@ -0,0 +1 @@ +typeof JSON!="object"&&(JSON={}),function(){"use strict";function f(e){return e<10?"0"+e:e}function quote(e){return escapable.lastIndex=0,escapable.test(e)?'"'+e.replace(escapable,function(e){var t=meta[e];return typeof t=="string"?t:"\\u"+("0000"+e.charCodeAt(0).toString(16)).slice(-4)})+'"':'"'+e+'"'}function str(e,t){var n,r,i,s,o=gap,u,a=t[e];a&&typeof a=="object"&&typeof a.toJSON=="function"&&(a=a.toJSON(e)),typeof rep=="function"&&(a=rep.call(t,e,a));switch(typeof a){case"string":return quote(a);case"number":return isFinite(a)?String(a):"null";case"boolean":case"null":return String(a);case"object":if(!a)return"null";gap+=indent,u=[];if(Object.prototype.toString.apply(a)==="[object Array]"){s=a.length;for(n=0;n")&&n[0]);return e>4?e:!1}();return e},h.isInternetExplorer=function(){var e=h.isInternetExplorer.cached=typeof h.isInternetExplorer.cached!="undefined"?h.isInternetExplorer.cached:Boolean(h.getInternetExplorerMajorVersion());return e},h.options.html4Mode?h.emulated={pushState:!0,hashChange:!0}:h.emulated={pushState:!Boolean(e.history&&e.history.pushState&&e.history.replaceState&&!/ Mobile\/([1-7][a-z]|(8([abcde]|f(1[0-8]))))/i.test(i.userAgent)&&!/AppleWebKit\/5([0-2]|3[0-2])/i.test(i.userAgent)),hashChange:Boolean(!("onhashchange"in e||"onhashchange"in r)||h.isInternetExplorer()&&h.getInternetExplorerMajorVersion()<8)},h.enabled=!h.emulated.pushState,h.bugs={setHash:Boolean(!h.emulated.pushState&&i.vendor==="Apple Computer, Inc."&&/AppleWebKit\/5([0-2]|3[0-3])/.test(i.userAgent)),safariPoll:Boolean(!h.emulated.pushState&&i.vendor==="Apple Computer, Inc."&&/AppleWebKit\/5([0-2]|3[0-3])/.test(i.userAgent)),ieDoubleCheck:Boolean(h.isInternetExplorer()&&h.getInternetExplorerMajorVersion()<8),hashEscape:Boolean(h.isInternetExplorer()&&h.getInternetExplorerMajorVersion()<7)},h.isEmptyObject=function(e){for(var t in e)if(e.hasOwnProperty(t))return!1;return!0},h.cloneObject=function(e){var t,n;return e?(t=l.stringify(e),n=l.parse(t)):n={},n},h.getRootUrl=function(){var e=r.location.protocol+"//"+(r.location.hostname||r.location.host);if(r.location.port||!1)e+=":"+r.location.port;return e+="/",e},h.getBaseHref=function(){var e=r.getElementsByTagName("base"),t=null,n="";return e.length===1&&(t=e[0],n=t.href.replace(/[^\/]+$/,"")),n=n.replace(/\/+$/,""),n&&(n+="/"),n},h.getBaseUrl=function(){var e=h.getBaseHref()||h.getBasePageUrl()||h.getRootUrl();return e},h.getPageUrl=function(){var e=h.getState(!1,!1),t=(e||{}).url||h.getLocationHref(),n;return n=t.replace(/\/+$/,"").replace(/[^\/]+$/,function(e,t,n){return/\./.test(e)?e:e+"/"}),n},h.getBasePageUrl=function(){var e=h.getLocationHref().replace(/[#\?].*/,"").replace(/[^\/]+$/,function(e,t,n){return/[^\/]$/.test(e)?"":e}).replace(/\/+$/,"")+"/";return e},h.getFullUrl=function(e,t){var n=e,r=e.substring(0,1);return t=typeof t=="undefined"?!0:t,/[a-z]+\:\/\//.test(e)||(r==="/"?n=h.getRootUrl()+e.replace(/^\/+/,""):r==="#"?n=h.getPageUrl().replace(/#.*/,"")+e:r==="?"?n=h.getPageUrl().replace(/[\?#].*/,"")+e:t?n=h.getBaseUrl()+e.replace(/^(\.\/)+/,""):n=h.getBasePageUrl()+e.replace(/^(\.\/)+/,"")),n.replace(/\#$/,"")},h.getShortUrl=function(e){var t=e,n=h.getBaseUrl(),r=h.getRootUrl();return h.emulated.pushState&&(t=t.replace(n,"")),t=t.replace(r,"/"),h.isTraditionalAnchor(t)&&(t="./"+t),t=t.replace(/^(\.\/)+/g,"./").replace(/\#$/,""),t},h.getLocationHref=function(e){return e=e||r,e.URL===e.location.href?e.location.href:e.location.href===decodeURIComponent(e.URL)?e.URL:e.location.hash&&decodeURIComponent(e.location.href.replace(/^[^#]+/,""))===e.location.hash?e.location.href:e.URL.indexOf("#")==-1&&e.location.href.indexOf("#")!=-1?e.location.href:e.URL||e.location.href},h.store={},h.idToState=h.idToState||{},h.stateToId=h.stateToId||{},h.urlToId=h.urlToId||{},h.storedStates=h.storedStates||[],h.savedStates=h.savedStates||[],h.normalizeStore=function(){h.store.idToState=h.store.idToState||{},h.store.urlToId=h.store.urlToId||{},h.store.stateToId=h.store.stateToId||{}},h.getState=function(e,t){typeof e=="undefined"&&(e=!0),typeof t=="undefined"&&(t=!0);var n=h.getLastSavedState();return!n&&t&&(n=h.createStateObject()),e&&(n=h.cloneObject(n),n.url=n.cleanUrl||n.url),n},h.getIdByState=function(e){var t=h.extractId(e.url),n;if(!t){n=h.getStateString(e);if(typeof h.stateToId[n]!="undefined")t=h.stateToId[n];else if(typeof h.store.stateToId[n]!="undefined")t=h.store.stateToId[n];else{for(;;){t=(new Date).getTime()+String(Math.random()).replace(/\D/g,"");if(typeof h.idToState[t]=="undefined"&&typeof h.store.idToState[t]=="undefined")break}h.stateToId[n]=t,h.idToState[t]=e}}return t},h.normalizeState=function(e){var t,n;if(!e||typeof e!="object")e={};if(typeof e.normalized!="undefined")return e;if(!e.data||typeof e.data!="object")e.data={};return t={},t.normalized=!0,t.title=e.title||"",t.url=h.getFullUrl(e.url?e.url:h.getLocationHref()),t.hash=h.getShortUrl(t.url),t.data=h.cloneObject(e.data),t.id=h.getIdByState(t),t.cleanUrl=t.url.replace(/\??\&_suid.*/,""),t.url=t.cleanUrl,n=!h.isEmptyObject(t.data),(t.title||n)&&h.options.disableSuid!==!0&&(t.hash=h.getShortUrl(t.url).replace(/\??\&_suid.*/,""),/\?/.test(t.hash)||(t.hash+="?"),t.hash+="&_suid="+t.id),t.hashedUrl=h.getFullUrl(t.hash),(h.emulated.pushState||h.bugs.safariPoll)&&h.hasUrlDuplicate(t)&&(t.url=t.hashedUrl),t},h.createStateObject=function(e,t,n){var r={data:e,title:t,url:n};return r=h.normalizeState(r),r},h.getStateById=function(e){e=String(e);var n=h.idToState[e]||h.store.idToState[e]||t;return n},h.getStateString=function(e){var t,n,r;return t=h.normalizeState(e),n={data:t.data,title:e.title,url:e.url},r=l.stringify(n),r},h.getStateId=function(e){var t,n;return t=h.normalizeState(e),n=t.id,n},h.getHashByState=function(e){var t,n;return t=h.normalizeState(e),n=t.hash,n},h.extractId=function(e){var t,n,r,i;return e.indexOf("#")!=-1?i=e.split("#")[0]:i=e,n=/(.*)\&_suid=([0-9]+)$/.exec(i),r=n?n[1]||e:e,t=n?String(n[2]||""):"",t||!1},h.isTraditionalAnchor=function(e){var t=!/[\/\?\.]/.test(e);return t},h.extractState=function(e,t){var n=null,r,i;return t=t||!1,r=h.extractId(e),r&&(n=h.getStateById(r)),n||(i=h.getFullUrl(e),r=h.getIdByUrl(i)||!1,r&&(n=h.getStateById(r)),!n&&t&&!h.isTraditionalAnchor(e)&&(n=h.createStateObject(null,null,i))),n},h.getIdByUrl=function(e){var n=h.urlToId[e]||h.store.urlToId[e]||t;return n},h.getLastSavedState=function(){return h.savedStates[h.savedStates.length-1]||t},h.getLastStoredState=function(){return h.storedStates[h.storedStates.length-1]||t},h.hasUrlDuplicate=function(e){var t=!1,n;return n=h.extractState(e.url),t=n&&n.id!==e.id,t},h.storeState=function(e){return h.urlToId[e.url]=e.id,h.storedStates.push(h.cloneObject(e)),e},h.isLastSavedState=function(e){var t=!1,n,r,i;return h.savedStates.length&&(n=e.id,r=h.getLastSavedState(),i=r.id,t=n===i),t},h.saveState=function(e){return h.isLastSavedState(e)?!1:(h.savedStates.push(h.cloneObject(e)),!0)},h.getStateByIndex=function(e){var t=null;return typeof e=="undefined"?t=h.savedStates[h.savedStates.length-1]:e<0?t=h.savedStates[h.savedStates.length+e]:t=h.savedStates[e],t},h.getCurrentIndex=function(){var e=null;return h.savedStates.length<1?e=0:e=h.savedStates.length-1,e},h.getHash=function(e){var t=h.getLocationHref(e),n;return n=h.getHashByUrl(t),n},h.unescapeHash=function(e){var t=h.normalizeHash(e);return t=decodeURIComponent(t),t},h.normalizeHash=function(e){var t=e.replace(/[^#]*#/,"").replace(/#.*/,"");return t},h.setHash=function(e,t){var n,i;return t!==!1&&h.busy()?(h.pushQueue({scope:h,callback:h.setHash,args:arguments,queue:t}),!1):(h.busy(!0),n=h.extractState(e,!0),n&&!h.emulated.pushState?h.pushState(n.data,n.title,n.url,!1):h.getHash()!==e&&(h.bugs.setHash?(i=h.getPageUrl(),h.pushState(null,null,i+"#"+e,!1)):r.location.hash=e),h)},h.escapeHash=function(t){var n=h.normalizeHash(t);return n=e.encodeURIComponent(n),h.bugs.hashEscape||(n=n.replace(/\%21/g,"!").replace(/\%26/g,"&").replace(/\%3D/g,"=").replace(/\%3F/g,"?")),n},h.getHashByUrl=function(e){var t=String(e).replace(/([^#]*)#?([^#]*)#?(.*)/,"$2");return t=h.unescapeHash(t),t},h.setTitle=function(e){var t=e.title,n;t||(n=h.getStateByIndex(0),n&&n.url===e.url&&(t=n.title||h.options.initialTitle));try{r.getElementsByTagName("title")[0].innerHTML=t.replace("<","<").replace(">",">").replace(" & "," & ")}catch(i){}return r.title=t,h},h.queues=[],h.busy=function(e){typeof e!="undefined"?h.busy.flag=e:typeof h.busy.flag=="undefined"&&(h.busy.flag=!1);if(!h.busy.flag){u(h.busy.timeout);var t=function(){var e,n,r;if(h.busy.flag)return;for(e=h.queues.length-1;e>=0;--e){n=h.queues[e];if(n.length===0)continue;r=n.shift(),h.fireQueueItem(r),h.busy.timeout=o(t,h.options.busyDelay)}};h.busy.timeout=o(t,h.options.busyDelay)}return h.busy.flag},h.busy.flag=!1,h.fireQueueItem=function(e){return e.callback.apply(e.scope||h,e.args||[])},h.pushQueue=function(e){return h.queues[e.queue||0]=h.queues[e.queue||0]||[],h.queues[e.queue||0].push(e),h},h.queue=function(e,t){return typeof e=="function"&&(e={callback:e}),typeof t!="undefined"&&(e.queue=t),h.busy()?h.pushQueue(e):h.fireQueueItem(e),h},h.clearQueue=function(){return h.busy.flag=!1,h.queues=[],h},h.stateChanged=!1,h.doubleChecker=!1,h.doubleCheckComplete=function(){return h.stateChanged=!0,h.doubleCheckClear(),h},h.doubleCheckClear=function(){return h.doubleChecker&&(u(h.doubleChecker),h.doubleChecker=!1),h},h.doubleCheck=function(e){return h.stateChanged=!1,h.doubleCheckClear(),h.bugs.ieDoubleCheck&&(h.doubleChecker=o(function(){return h.doubleCheckClear(),h.stateChanged||e(),!0},h.options.doubleCheckInterval)),h},h.safariStatePoll=function(){var t=h.extractState(h.getLocationHref()),n;if(!h.isLastSavedState(t))return n=t,n||(n=h.createStateObject()),h.Adapter.trigger(e,"popstate"),h;return},h.back=function(e){return e!==!1&&h.busy()?(h.pushQueue({scope:h,callback:h.back,args:arguments,queue:e}),!1):(h.busy(!0),h.doubleCheck(function(){h.back(!1)}),p.go(-1),!0)},h.forward=function(e){return e!==!1&&h.busy()?(h.pushQueue({scope:h,callback:h.forward,args:arguments,queue:e}),!1):(h.busy(!0),h.doubleCheck(function(){h.forward(!1)}),p.go(1),!0)},h.go=function(e,t){var n;if(e>0)for(n=1;n<=e;++n)h.forward(t);else{if(!(e<0))throw new Error("History.go: History.go requires a positive or negative integer passed.");for(n=-1;n>=e;--n)h.back(t)}return h};if(h.emulated.pushState){var v=function(){};h.pushState=h.pushState||v,h.replaceState=h.replaceState||v}else h.onPopState=function(t,n){var r=!1,i=!1,s,o;return h.doubleCheckComplete(),s=h.getHash(),s?(o=h.extractState(s||h.getLocationHref(),!0),o?h.replaceState(o.data,o.title,o.url,!1):(h.Adapter.trigger(e,"anchorchange"),h.busy(!1)),h.expectedStateId=!1,!1):(r=h.Adapter.extractEventData("state",t,n)||!1,r?i=h.getStateById(r):h.expectedStateId?i=h.getStateById(h.expectedStateId):i=h.extractState(h.getLocationHref()),i||(i=h.createStateObject(null,null,h.getLocationHref())),h.expectedStateId=!1,h.isLastSavedState(i)?(h.busy(!1),!1):(h.storeState(i),h.saveState(i),h.setTitle(i),h.Adapter.trigger(e,"statechange"),h.busy(!1),!0))},h.Adapter.bind(e,"popstate",h.onPopState),h.pushState=function(t,n,r,i){if(h.getHashByUrl(r)&&h.emulated.pushState)throw new Error("History.js does not support states with fragement-identifiers (hashes/anchors).");if(i!==!1&&h.busy())return h.pushQueue({scope:h,callback:h.pushState,args:arguments,queue:i}),!1;h.busy(!0);var s=h.createStateObject(t,n,r);return h.isLastSavedState(s)?h.busy(!1):(h.storeState(s),h.expectedStateId=s.id,p.pushState(s.id,s.title,s.url),h.Adapter.trigger(e,"popstate")),!0},h.replaceState=function(t,n,r,i){if(h.getHashByUrl(r)&&h.emulated.pushState)throw new Error("History.js does not support states with fragement-identifiers (hashes/anchors).");if(i!==!1&&h.busy())return h.pushQueue({scope:h,callback:h.replaceState,args:arguments,queue:i}),!1;h.busy(!0);var s=h.createStateObject(t,n,r);return h.isLastSavedState(s)?h.busy(!1):(h.storeState(s),h.expectedStateId=s.id,p.replaceState(s.id,s.title,s.url),h.Adapter.trigger(e,"popstate")),!0};if(s){try{h.store=l.parse(s.getItem("History.store"))||{}}catch(m){h.store={}}h.normalizeStore()}else h.store={},h.normalizeStore();h.Adapter.bind(e,"unload",h.clearAllIntervals),h.saveState(h.storeState(h.extractState(h.getLocationHref(),!0))),s&&(h.onUnload=function(){var e,t,n;try{e=l.parse(s.getItem("History.store"))||{}}catch(r){e={}}e.idToState=e.idToState||{},e.urlToId=e.urlToId||{},e.stateToId=e.stateToId||{};for(t in h.idToState){if(!h.idToState.hasOwnProperty(t))continue;e.idToState[t]=h.idToState[t]}for(t in h.urlToId){if(!h.urlToId.hasOwnProperty(t))continue;e.urlToId[t]=h.urlToId[t]}for(t in h.stateToId){if(!h.stateToId.hasOwnProperty(t))continue;e.stateToId[t]=h.stateToId[t]}h.store=e,h.normalizeStore(),n=l.stringify(e);try{s.setItem("History.store",n)}catch(i){if(i.code!==DOMException.QUOTA_EXCEEDED_ERR)throw i;s.length&&(s.removeItem("History.store"),s.setItem("History.store",n))}},h.intervalList.push(a(h.onUnload,h.options.storeInterval)),h.Adapter.bind(e,"beforeunload",h.onUnload),h.Adapter.bind(e,"unload",h.onUnload));if(!h.emulated.pushState){h.bugs.safariPoll&&h.intervalList.push(a(h.safariStatePoll,h.options.safariPollInterval));if(i.vendor==="Apple Computer, Inc."||(i.appCodeName||"")==="Mozilla")h.Adapter.bind(e,"hashchange",function(){h.Adapter.trigger(e,"popstate")}),h.getHash()&&h.Adapter.onDomLoad(function(){h.Adapter.trigger(e,"hashchange")})}},(!h.options||!h.options.delayInit)&&h.init()}(window) \ No newline at end of file From 4ed11dba4c5469fd7e73f38a4071d824918837e1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Mon, 17 Jun 2013 17:17:15 +0200 Subject: [PATCH 22/46] Add 'public' symlink creation to runtests Runtest now creates a symlink to the public folder when it doesn't exist, allowing the built-in server to access the js files without too much hassle refs #4303 refs #4315 --- test/frontend/i2w-config.js | 51 +++++++++++++++++++++++++++++++++++++ test/frontend/runtests | 11 ++++++++ 2 files changed, 62 insertions(+) diff --git a/test/frontend/i2w-config.js b/test/frontend/i2w-config.js index 7d54a1a00..4d72b6d7e 100644 --- a/test/frontend/i2w-config.js +++ b/test/frontend/i2w-config.js @@ -93,6 +93,14 @@ if (path === null) var openFromBase = function(url, options) { return copenFrom.apply(casper,[this.getBaseURL(url), options]); }; + casper.on('remote.message', function(message) { + console.log(message); + }); + + casper.on('page.error', function(message, trace) { + console.error(message, JSON.stringify(trace)); + }); + exports.getTestEnv = function() { casper.getBaseURL = getBaseURL; @@ -102,6 +110,49 @@ if (path === null) return casper; }; + exports.setupRequireJs = function(libraries) { + if (typeof libraries === "undefined") { + libraries = { + jquery: 'vendor/jquery-1.8.3', + bootstrap: 'vendor/bootstrap.min', + eve: 'vendor/raphael/eve' + }; + } else { + libraries = libraries || {}; + libraries.logging = 'icinga/util/logging'; + libraries.jquery = 'vendor/jquery-1.8.3'; + libraries["modules/list"] = "/moduleMock"; + if (libraries.bootstrap || libraries.icinga) { + libraries.bootstrap = 'vendor/bootstrap.min'; + libraries.history = 'vendor/history'; + libraries.eve = 'vendor/raphael/eve'; + libraries.raphael = 'vendor/raphael/raphael.amd'; + libraries["raphael.core"] = 'vendor/raphael/raphael.core'; + libraries["raphael.svg"] = 'vendor/raphael/raphael.svg'; + libraries["raphael.vml"] = 'vendor/raphael/raphael.vml'; + } + if (libraries.ace) { + libraries.ace = 'vendor/ace/ace'; + } + } + var bootstrap = libraries.icinga; + delete(libraries.icinga); + requirejs.config({ + baseUrl: window.base_url + '/js', + paths: libraries + }); + if (bootstrap) { + + requirejs(['jquery', 'history']); + requirejs(['bootstrap']); + requirejs(['icinga/icinga'], function (Icinga) { + window.$ = $; + window.jQuery = $; + window.Icinga = Icinga; + window.History = History; + }); + } + }; })(); diff --git a/test/frontend/runtests b/test/frontend/runtests index cb24dd57b..df29ce6e7 100755 --- a/test/frontend/runtests +++ b/test/frontend/runtests @@ -16,6 +16,11 @@ if [ ! -x $CASPER ]; then "Take a look at http://casperjs.org/installation.html to see how the installation works for your system" exit 1 fi; +if [ ! -e "${DIR}/static/public" ]; then + echo "!" + ln -s "${DIR}/../../public" "${DIR}/static/public" +fi; + PARAM="0" for arg in $@;do @@ -108,10 +113,16 @@ if [ "$EXCLUDE" != "" ];then fi FILELIST=`echo $FILELIST | grep -v "$NAME"` fi; + cd $DIR/static +PROC=`ps ax|grep "SimpleHTTPServer 12999"|awk '{ print $1 }'` +if [ "$PROC" != "" ]; then + kill $PROC +fi; python -m SimpleHTTPServer 12999& PID=$! cd $DIR + echo $EXEC $FILELIST $EXEC $FILELIST kill $PID From a8019222f5e59475c5a6cec7f8e39ad499b159e8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Mon, 17 Jun 2013 17:18:35 +0200 Subject: [PATCH 23/46] Add History Api test Add CasperJS Tests for History API (~80%). Also provides a few resources like the generic.html site that can be used for more setups refs #4303 refs #4315 --- test/frontend/cases/historyApiTest.js | 57 +++++++++++++++++++ test/frontend/cases/static-page-test.js | 1 - .../static/fragments/testFragment1.html | 6 ++ .../static/fragments/testFragment2.html | 6 ++ .../static/fragments/testFragment3.html | 6 ++ test/frontend/static/generic.html | 39 +++++++++++++ test/frontend/static/moduleMock.js | 4 ++ test/frontend/test.xml | 1 + 8 files changed, 119 insertions(+), 1 deletion(-) create mode 100644 test/frontend/cases/historyApiTest.js create mode 100644 test/frontend/static/fragments/testFragment1.html create mode 100644 test/frontend/static/fragments/testFragment2.html create mode 100644 test/frontend/static/fragments/testFragment3.html create mode 100644 test/frontend/static/generic.html create mode 100644 test/frontend/static/moduleMock.js create mode 100644 test/frontend/test.xml diff --git a/test/frontend/cases/historyApiTest.js b/test/frontend/cases/historyApiTest.js new file mode 100644 index 000000000..bb99a1c4c --- /dev/null +++ b/test/frontend/cases/historyApiTest.js @@ -0,0 +1,57 @@ + +var i2w = require('./i2w-config'); +var casper = i2w.getTestEnv(); + +casper.start("http://localhost:12999/generic.html"); + +casper.then(function() { + casper.page.evaluate(i2w.setupRequireJs, {icinga: true}); +}); + + +casper.then(function() { + this.test.assertTitle("Icinga test page"); + casper.page.evaluate(function() { + requirejs(["icinga/icinga"], function(icinga) { + icinga.loadUrl("/fragments/testFragment1.html"); + }); + }); + /*this.waitFor(function() { + return document.querySelectorAll("#icinga-main a") ; + }, */ + casper.waitForSelector("div#icinga-main a", onFirstLink); +}); + +var onFirstLink = function() { + var links = casper.page.evaluate(function() { + return document.querySelectorAll("div#icinga-main a"); + }); + // assert no reload + this.test.assertTitle("Icinga test page"); + this.test.assertUrlMatch(/.*testFragment1.html/); + this.test.assertEquals(links.length, 2); + casper.clickLabel('Fragment 2'); + casper.waitForText('Fragment 1', onSecondLink); +}; + +var onSecondLink = function() { + var links = casper.page.evaluate(function() { + return document.querySelectorAll("div#icinga-main a"); + }); + this.test.assertTitle("Icinga test page"); + this.test.assertUrlMatch(/.*testFragment2.html/); + this.test.assertEquals(links.length, 2); + casper.page.evaluate(function() { + requirejs(["icinga/icinga"], function(icinga) { + icinga.loadUrl("/fragments/testFragment3.html?this=is_a_param", "icinga-detail"); + console.log(document.location.href); + }); + }); + console.log(casper.page.evaluate(function() { + return document.location.href; + })); +}; + +casper.run(function() { + this.test.done(); +}); diff --git a/test/frontend/cases/static-page-test.js b/test/frontend/cases/static-page-test.js index f37a2a214..39f94081f 100644 --- a/test/frontend/cases/static-page-test.js +++ b/test/frontend/cases/static-page-test.js @@ -11,7 +11,6 @@ casper.start("http://localhost:12999/empty.html"); casper.then(function() { - casper.log(this.test); this.test.assertTitle("Just an empty page"); }); diff --git a/test/frontend/static/fragments/testFragment1.html b/test/frontend/static/fragments/testFragment1.html new file mode 100644 index 000000000..926a2c392 --- /dev/null +++ b/test/frontend/static/fragments/testFragment1.html @@ -0,0 +1,6 @@ +
      +

      Test fragment

      + Fragment 2 + Fragment 3 + +
      diff --git a/test/frontend/static/fragments/testFragment2.html b/test/frontend/static/fragments/testFragment2.html new file mode 100644 index 000000000..4db44e053 --- /dev/null +++ b/test/frontend/static/fragments/testFragment2.html @@ -0,0 +1,6 @@ +
      +

      Test fragment 2

      + Fragment 1 + Fragment 3 + +
      diff --git a/test/frontend/static/fragments/testFragment3.html b/test/frontend/static/fragments/testFragment3.html new file mode 100644 index 000000000..e773f5eff --- /dev/null +++ b/test/frontend/static/fragments/testFragment3.html @@ -0,0 +1,6 @@ +
      +

      Test fragment 3

      + Fragment 1 + Fragment 2 + +
      diff --git a/test/frontend/static/generic.html b/test/frontend/static/generic.html new file mode 100644 index 000000000..d1e8c301a --- /dev/null +++ b/test/frontend/static/generic.html @@ -0,0 +1,39 @@ + + + + + + + + + + + Icinga test page + + + + + + + + + + + + + +
      +
      +
      + +
      + + + diff --git a/test/frontend/static/moduleMock.js b/test/frontend/static/moduleMock.js new file mode 100644 index 000000000..aa9c4079f --- /dev/null +++ b/test/frontend/static/moduleMock.js @@ -0,0 +1,4 @@ +define([], function() { + "use strict"; + return {}; +}); diff --git a/test/frontend/test.xml b/test/frontend/test.xml new file mode 100644 index 000000000..68ba1bc3a --- /dev/null +++ b/test/frontend/test.xml @@ -0,0 +1 @@ +Page title is: "i4cinga-web test [Jenkins]" \ No newline at end of file From 04f7149cfe16f29366388b318b01f10d28a4e9d0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Wed, 19 Jun 2013 13:17:43 +0200 Subject: [PATCH 24/46] Allow container-based url in history api When a url is now loaded for an non-main container, the url for the container is appended to the GET part of the URL refs #4303 --- public/js/icinga/icinga.js | 1 - public/js/icinga/util/async.js | 37 ++++++++++++++++--- test/frontend/cases/historyApiTest.js | 12 ++++-- .../static/fragments/testFragment1.html | 2 +- test/frontend/static/public | 1 + 5 files changed, 41 insertions(+), 12 deletions(-) create mode 120000 test/frontend/static/public diff --git a/public/js/icinga/icinga.js b/public/js/icinga/icinga.js index 31f78dcae..143593942 100755 --- a/public/js/icinga/icinga.js +++ b/public/js/icinga/icinga.js @@ -71,7 +71,6 @@ define([ loadUrl: function(url, target, params) { target = target || "icinga-main"; async.loadToTarget(target, url, params); - History.pushState(params, document.title, url); }, getFailedModules: function() { diff --git a/public/js/icinga/util/async.js b/public/js/icinga/util/async.js index 27e56cb7d..80322964a 100644 --- a/public/js/icinga/util/async.js +++ b/public/js/icinga/util/async.js @@ -9,7 +9,33 @@ var pending = { }; - + + var getCurrentGETParameters = function() { + var currentGET = window.location.search.substring(1).split("&"); + var params = {}; + if(currentGET.length > 0) { + $.each(currentGET, function(idx, elem) { + var keyVal = elem.split("="); + params[encodeURIComponent(keyVal[0])] = encodeURIComponent(keyVal[1]); + }); + } + return params; + } +; + var pushGet = function(param, value, url) { + url = url || (window.location.origin+window.location.pathname); + var params = getCurrentGETParameters(); + params[encodeURIComponent(param)] = encodeURIComponent(value); + var search = "?"; + for (var name in params) { + if(search != "?") + search += "&"; + search += name+"="+params[name]; + } + + return url+search+"#"+window.location.hash; + }; + var getDOMForDestination = function(destination) { var target = destination; if(typeof destination === "string") { @@ -96,14 +122,13 @@ if (destination == "icinga-main") { History.pushState(data, document.title, url); } else { - data = data || {}; - data[destination] = url; - History.pushState(data, document.title, document.location.href); + url = pushGet("c["+destination+"]", url); + History.pushState(data, document.title, url); } + console.log("New url: ", url); return req; - }; - + this.loadCSS = function(name) { }; diff --git a/test/frontend/cases/historyApiTest.js b/test/frontend/cases/historyApiTest.js index bb99a1c4c..a346447a9 100644 --- a/test/frontend/cases/historyApiTest.js +++ b/test/frontend/cases/historyApiTest.js @@ -44,12 +44,16 @@ var onSecondLink = function() { casper.page.evaluate(function() { requirejs(["icinga/icinga"], function(icinga) { icinga.loadUrl("/fragments/testFragment3.html?this=is_a_param", "icinga-detail"); - console.log(document.location.href); + }); }); - console.log(casper.page.evaluate(function() { - return document.location.href; - })); + this.wait(400, function() { + console.log(casper.page.evaluate(function() { + return window.location.href; + })); + + this.test.assertUrlMatch(/testFragment2.html.*testFragment3.html/); + }); }; casper.run(function() { diff --git a/test/frontend/static/fragments/testFragment1.html b/test/frontend/static/fragments/testFragment1.html index 926a2c392..2d6ef70db 100644 --- a/test/frontend/static/fragments/testFragment1.html +++ b/test/frontend/static/fragments/testFragment1.html @@ -1,6 +1,6 @@

      Test fragment

      - Fragment 2 + Fragment 2 Fragment 3
      diff --git a/test/frontend/static/public b/test/frontend/static/public new file mode 120000 index 000000000..07a4824dc --- /dev/null +++ b/test/frontend/static/public @@ -0,0 +1 @@ +/Users/moja/git/icinga2-web/test/frontend/../../public \ No newline at end of file From f93344330e604b201c6c4a4b9823303ca1cce1b4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Wed, 19 Jun 2013 13:21:25 +0200 Subject: [PATCH 25/46] Rename require reference to requirejs Require is a reserverd word for phantomjs refs #4315 refs #4303 --- public/js/main.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/public/js/main.js b/public/js/main.js index 5e5005ae0..f0fa6ceb9 100755 --- a/public/js/main.js +++ b/public/js/main.js @@ -17,8 +17,8 @@ requirejs.config({ }); define(['jquery','Holder'], function ($) { - require(['bootstrap']); - require(['icinga/icinga'], function (Icinga) { + requirejs(['bootstrap']); + requirejs(['icinga/icinga'], function (Icinga) { window.$ = $; window.jQuery = $; window.Icinga = Icinga; From 27c5f459b1f431a586216b4ad430eff0db05ec87 Mon Sep 17 00:00:00 2001 From: Marius Hein Date: Tue, 25 Jun 2013 11:45:03 +0200 Subject: [PATCH 26/46] History API Remove dangling symlink and add symlink to .gitignore refs #4303 --- .gitignore | 3 +++ test/frontend/static/public | 1 - 2 files changed, 3 insertions(+), 1 deletion(-) delete mode 120000 test/frontend/static/public diff --git a/.gitignore b/.gitignore index 91e6a17ff..ac45c2a9f 100644 --- a/.gitignore +++ b/.gitignore @@ -12,3 +12,6 @@ config.log # cmd tester test/php/bin/extcmd_test + +# misc test output +test/frontend/static/public diff --git a/test/frontend/static/public b/test/frontend/static/public deleted file mode 120000 index 07a4824dc..000000000 --- a/test/frontend/static/public +++ /dev/null @@ -1 +0,0 @@ -/Users/moja/git/icinga2-web/test/frontend/../../public \ No newline at end of file From 8192c1942436ff467e87420adb23c64869887f7c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Mon, 24 Jun 2013 18:46:45 +0200 Subject: [PATCH 27/46] Fix Authentication workflow - The authentication controller now uses the Authentication/Manager class, also there were some issues in the Session creation, this has been removed from the Bootstrap now, as the Controller must decide how to open a session (read-only or read/write). - The tests reflect a few chagnes, as the move from the CSRF token generation to the Formbuilder. - Notificaiton now doesn't use Zend Session refs #4340 --- .../controllers/AuthenticationController.php | 69 +++++++++++++++-- .../layouts/scripts/parts/topbar.phtml | 2 +- .../views/scripts/authentication/login.phtml | 11 ++- config/authentication.ini | 9 ++- library/Icinga/Application/Web.php | 11 --- library/Icinga/Authentication/Manager.php | 13 +++- library/Icinga/Authentication/PhpSession.php | 15 ++-- library/Icinga/Authentication/User.php | 16 ++-- library/Icinga/Protocol/Ldap/Connection.php | 40 +++++----- library/Icinga/Web/ActionController.php | 48 ------------ library/Icinga/Web/Notification.php | 7 +- .../application/views/helpers/QlinkTest.php | 2 +- .../Icinga/Web/ActionControllerTest.php | 74 ------------------- 13 files changed, 134 insertions(+), 183 deletions(-) diff --git a/application/controllers/AuthenticationController.php b/application/controllers/AuthenticationController.php index 593a15f22..315e74eaa 100644 --- a/application/controllers/AuthenticationController.php +++ b/application/controllers/AuthenticationController.php @@ -6,8 +6,9 @@ # namespace Icinga\Application\Controllers; use Icinga\Web\ActionController; -use Icinga\Authentication\Auth; -use Icinga\Web\Notification; +use Icinga\Authentication\Credentials as Credentials; +use Icinga\Authentication\Manager as AuthManager; +use Icinga\Form\Builder as FormBuilder; /** * Class AuthenticationController @@ -25,13 +26,67 @@ class AuthenticationController extends ActionController */ protected $modifiesSession = true; + private function getAuthForm() + { + return array( + 'username' => array( + 'text', + array( + 'label' => t('Username'), + 'required' => true, + ) + ), + 'password' => array( + 'password', + array( + 'label' => t('Password'), + 'required' => true + ) + ), + 'submit' => array( + 'submit', + array( + 'label' => t('Login'), + 'class' => 'pull-right' + ) + ) + ); + } + /** * */ public function loginAction() { $this->replaceLayout = true; - $this->view->form = $this->widget('form', array('name' => 'login')); + $credentials = new Credentials(); + $this->view->form = FormBuilder::fromArray( + $this->getAuthForm(), + array( + "CSRFProtection" => false, // makes no sense here + "model" => &$credentials + ) + ); + try { + $auth = AuthManager::getInstance(null, array( + "writeSession" => true + )); + if ($auth->isAuthenticated()) { + $this->redirectNow('index?_render=body'); + } + if ($this->getRequest()->isPost() && $this->view->form->isSubmitted()) { + $this->view->form->repopulate(); + if ($this->view->form->isValid()) { + if (!$auth->authenticate($credentials)) { + $this->view->form->getElement('password')->addError(t('Please provide a valid username and password')); + } else { + $this->redirectNow('index?_render=body'); + } + } + } + } catch (\Icinga\Exception\ConfigurationError $configError) { + $this->view->errorInfo = $configError->getMessage(); + } } /** @@ -39,11 +94,13 @@ class AuthenticationController extends ActionController */ public function logoutAction() { + $auth = AuthManager::getInstance(null, array( + "writeSession" => true + )); $this->replaceLayout = true; - Auth::getInstance()->forgetAuthentication(); - Notification::success('You have been logged out'); + $auth->removeAuthorization(); $this->_forward('login'); } } -// @codingStandardsIgnoreEnd \ No newline at end of file +// @codingStandardsIgnoreEnd diff --git a/application/layouts/scripts/parts/topbar.phtml b/application/layouts/scripts/parts/topbar.phtml index 961fa1da7..39e25a13a 100755 --- a/application/layouts/scripts/parts/topbar.phtml +++ b/application/layouts/scripts/parts/topbar.phtml @@ -12,7 +12,7 @@
    • escape($this->auth()->getUsername()) + $this->escape($this->auth()->getUser()->getUsername()) ?> diff --git a/application/views/scripts/authentication/login.phtml b/application/views/scripts/authentication/login.phtml index 13b248d7e..01dc6d56f 100644 --- a/application/views/scripts/authentication/login.phtml +++ b/application/views/scripts/authentication/login.phtml @@ -1 +1,10 @@ -form ?> +
      +

      Login

      +form->render() ?> +errorInfo)): ?> +
      + errorInfo ?> +
      + + +
      diff --git a/config/authentication.ini b/config/authentication.ini index 6b56f172e..c01e78b17 100644 --- a/config/authentication.ini +++ b/config/authentication.ini @@ -1,2 +1,9 @@ [users] - +backend=ldap +hostname=localhost +root_dn="ou=people,dc=icinga,dc=org" +bind_dn="cn=admin,cn=config" +bind_pw=admin +user_class=inetOrgPerson +user_name_attribute=uid + diff --git a/library/Icinga/Application/Web.php b/library/Icinga/Application/Web.php index d034d344f..32f611594 100644 --- a/library/Icinga/Application/Web.php +++ b/library/Icinga/Application/Web.php @@ -38,7 +38,6 @@ class Web extends ApplicationBootstrap return $this->loadConfig() ->configureErrorHandling() ->setTimezone() - ->configureSession() ->configureCache() ->prepareZendMvc() ->loadTranslations() @@ -80,16 +79,6 @@ class Web extends ApplicationBootstrap $this->dispatchFrontController(); } - /** - * Configure web session settings - * - * @return self - */ - protected function configureSession() - { - Manager::getInstance(); - return $this; - } protected function loadTranslations() { diff --git a/library/Icinga/Authentication/Manager.php b/library/Icinga/Authentication/Manager.php index 339ff718b..68d20f264 100644 --- a/library/Icinga/Authentication/Manager.php +++ b/library/Icinga/Authentication/Manager.php @@ -6,6 +6,7 @@ namespace Icinga\Authentication; use Icinga\Application\Logger as Logger; use Icinga\Application\Config as Config; +use Icinga\Exception\ConfigurationError as ConfigError; class Manager { @@ -25,7 +26,6 @@ class Manager if ($config === null) { $config = Config::getInstance()->authentication; } - if (isset($options["userBackendClass"])) { $this->userBackend = $options["userBackendClass"]; } elseif ($config->users !== null) { @@ -77,6 +77,15 @@ class Manager public function authenticate(Credentials $credentials, $persist = true) { + if (!$this->userBackend) { + Logger::error("No authentication backend provided, your users will never be able to login."); + throw new ConfigError( + "No authentication backend set - login will never succeed as icinga-web ". + "doesn't know how to determine your user. \n". + "To fix this error, setup your authentication.ini with a valid authentication backend." + ); + return false; + } if (!$this->userBackend->hasUsername($credentials)) { Logger::info("Unknown user %s tried to log in", $credentials->getUsername()); return false; @@ -115,7 +124,7 @@ class Manager public function removeAuthorization() { $this->user = null; - $this->session->delete(); + $this->session->purge(); } public function getUser() diff --git a/library/Icinga/Authentication/PhpSession.php b/library/Icinga/Authentication/PhpSession.php index 8dbc682dc..5da310d73 100644 --- a/library/Icinga/Authentication/PhpSession.php +++ b/library/Icinga/Authentication/PhpSession.php @@ -28,7 +28,6 @@ class PhpSession extends Session private static $DEFAULT_COOKIEOPTIONS = array( 'use_trans_sid' => false, 'use_cookies' => true, - 'use_only_cooies' => true, 'cookie_httponly' => true, 'use_only_cookies' => true, 'hash_function' => true, @@ -51,6 +50,9 @@ class PhpSession extends Session ); } } + if (!is_writable(session_save_path())) { + throw new \Icinga\Exception\ConfigurationError("Can't save session"); + } } private function sessionCanBeChanged() @@ -78,12 +80,7 @@ class PhpSession extends Session } session_name(PhpSession::SESSION_NAME); - - /* - * @todo This is not right - */ - \Zend_Session::start(); - // session_start(); + session_start(); $this->isOpen = true; $this->setAll($_SESSION); return true; @@ -138,16 +135,18 @@ class PhpSession extends Session public function purge() { - if ($this->ensureOpen() && !$this->isFlushed) { + if ($this->ensureOpen()) { $_SESSION = array(); session_destroy(); $this->clearCookies(); + $this->close(); } } private function clearCookies() { if (ini_get("session.use_cookies")) { + Logger::debug("Clearing cookies"); $params = session_get_cookie_params(); setcookie( session_name(), diff --git a/library/Icinga/Authentication/User.php b/library/Icinga/Authentication/User.php index 37c303dfa..e4de7c241 100644 --- a/library/Icinga/Authentication/User.php +++ b/library/Icinga/Authentication/User.php @@ -20,15 +20,15 @@ namespace Icinga\Authentication; */ class User { - private $username = ""; - private $firstname = ""; - private $lastname = ""; - private $email = ""; - private $domain = ""; - private $additionalInformation = array(); + public $username = ""; + public $firstname = ""; + public $lastname = ""; + public $email = ""; + public $domain = ""; + public $additionalInformation = array(); - private $permissions = array(); - private $groups = array(); + public $permissions = array(); + public $groups = array(); public function __construct($username, $firstname = null, $lastname = null, $email = null) { diff --git a/library/Icinga/Protocol/Ldap/Connection.php b/library/Icinga/Protocol/Ldap/Connection.php index 19f466370..403bfd665 100644 --- a/library/Icinga/Protocol/Ldap/Connection.php +++ b/library/Icinga/Protocol/Ldap/Connection.php @@ -4,6 +4,7 @@ namespace Icinga\Protocol\Ldap; +use Icinga\Exception\ConfigurationError as ConfigError; use Icinga\Application\Platform; use Icinga\Application\Config; use Icinga\Application\Logger as Log; @@ -69,6 +70,10 @@ class Connection // '1.3.6.1.1.8' => '8', // Cancel Extended Request ); + protected $use_tls = false; + protected $force_tls = false; + + /** * @var array */ @@ -116,7 +121,8 @@ class Connection $this->bind_dn = $config->bind_dn; $this->bind_pw = $config->bind_pw; $this->root_dn = $config->root_dn; - + $this->use_tls = isset($config->tls) ? $config->tls : false; + $this->force_tls = $this->use_tls; } /** @@ -266,6 +272,7 @@ class Connection // We do not support pagination right now, and there is no chance to // do so for PHP < 5.4. Warnings about "Sizelimit exceeded" will // therefore not be hidden right now. + Log::debug("Query: %s", $query->__toString()); $results = ldap_search( $this->ds, $this->root_dn, @@ -405,7 +412,6 @@ class Connection if (isset($result->supportedExtension)) { foreach ($result->supportedExtension as $oid) { if (array_key_exists($oid, $this->ldap_extension)) { - echo $this->ldap_extension[$oid] . "\n"; // STARTTLS -> läuft mit OpenLDAP } } @@ -429,23 +435,23 @@ class Connection if ($this->ds !== null) { return; } - $use_tls = true; - $force_tls = true; - if ($use_tls) { + if ($this->use_tls) { $this->prepareTlsEnvironment(); } Log::debug("Trying to connect to %s", $this->hostname); $this->ds = ldap_connect($this->hostname, 389); $this->discoverCapabilities(); - Log::debug("Trying ldap_start_tls()"); - if (ldap_start_tls($this->ds)) { - Log::debug("Trying ldap_start_tls() succeeded"); - } else { - Log::warn( - "ldap_start_tls() failed: %s. Does your ldap_ca.conf point to the certificate? ", - ldap_error($this->ds) - ); + if ($this->use_tls) { + Log::debug("Trying ldap_start_tls()"); + if (@ldap_start_tls($this->ds)) { + Log::debug("Trying ldap_start_tls() succeeded"); + } else { + Log::warn( + "ldap_start_tls() failed: %s. Does your ldap_ca.conf point to the certificate? ", + ldap_error($this->ds) + ); + } } @@ -470,12 +476,10 @@ class Connection '***', ldap_error($this->ds) ); - throw new Exception( + throw new ConfigError( sprintf( - 'LDAP connection (%s / %s) failed: %s', - $this->bind_dn, - '***' /* $this->bind_pw */, - ldap_error($this->ds) + 'Could not connect to the authentication server, please '. + 'review your LDAP connection settings.' ) ); } diff --git a/library/Icinga/Web/ActionController.php b/library/Icinga/Web/ActionController.php index 58555bfaf..4d8c02fbe 100755 --- a/library/Icinga/Web/ActionController.php +++ b/library/Icinga/Web/ActionController.php @@ -110,10 +110,6 @@ class ActionController extends ZfController * @todo remove this! */ - $this->allowAccess = true; - $this->init(); - - return null; if ($this->handlesAuthentication() || Manager::getInstance( @@ -338,48 +334,4 @@ class ActionController extends ZfController }*/ } - - /** - * Whether the token parameter is valid - * - * TODO: Could this make use of Icinga\Web\Session once done? - * - * @param int $maxAge Max allowed token age - * @param string $sessionId A specific session id (useful for tests?) - * @return bool - */ - public function hasValidToken($maxAge = 600, $sessionId = null) - { - $sessionId = $sessionId ? $sessionId : session_id(); - $seed = $this->_getParam('seed'); - if (!is_numeric($seed)) { - return false; - } - - // Remove quantitized timestamp portion so maxAge applies - $seed -= (intval(time() / $maxAge) * $maxAge); - $token = $this->_getParam('token'); - return $token === hash('sha256', $sessionId . $seed); - } - - /** - * Get a new seed/token pair - * - * TODO: Could this make use of Icinga\Web\Session once done? - * - * @param int $maxAge Max allowed token age - * @param string $sessionId A specific session id (useful for tests?) - * - * @return array - */ - public function getSeedTokenPair($maxAge = 600, $sessionId = null) - { - $sessionId = $sessionId ? $sessionId : session_id(); - $seed = mt_rand(); - $hash = hash('sha256', $sessionId . $seed); - - // Add quantitized timestamp portion to apply maxAge - $seed += (intval(time() / $maxAge) * $maxAge); - return array($seed, $hash); - } } diff --git a/library/Icinga/Web/Notification.php b/library/Icinga/Web/Notification.php index c858f6011..c99713c7a 100644 --- a/library/Icinga/Web/Notification.php +++ b/library/Icinga/Web/Notification.php @@ -7,7 +7,6 @@ namespace Icinga\Web; use Icinga\Exception\ProgrammingError; use Icinga\Application\Platform; use Icinga\Application\Logger as Log; -use Zend_Session_Namespace as SessionNamespace; /** * Class Notification @@ -149,10 +148,10 @@ class Notification */ final private function __construct() { - $this->session = new SessionNamespace('IcingaNotification'); - if (!is_array($this->session->messages)) { + //$this->session = new SessionNamespace('IcingaNotification'); + //if (!is_array($this->session->messages)) { $this->session->messages = array(); - } + //} if (Platform::isCli()) { $this->cliFlag = true; diff --git a/test/php/application/views/helpers/QlinkTest.php b/test/php/application/views/helpers/QlinkTest.php index 7e8030ee8..881669370 100755 --- a/test/php/application/views/helpers/QlinkTest.php +++ b/test/php/application/views/helpers/QlinkTest.php @@ -4,7 +4,7 @@ require_once('Zend/View/Helper/Abstract.php'); require_once('Zend/View.php'); -require('../../application/views/helpers/Qlink.php'); +require_once('../../application/views/helpers/Qlink.php'); /** diff --git a/test/php/library/Icinga/Web/ActionControllerTest.php b/test/php/library/Icinga/Web/ActionControllerTest.php index 44686595e..642b8939c 100755 --- a/test/php/library/Icinga/Web/ActionControllerTest.php +++ b/test/php/library/Icinga/Web/ActionControllerTest.php @@ -1,80 +1,6 @@ args = $args; - } - - protected function _getParam($paramName, $default = null) { - if(isset($this->args[$paramName])) - return $this->args[$paramName]; - return $default; - } -} - -class ActionTest extends \PHPUnit_Framework_TestCase -{ - public function testSeedGeneration() - { - $action = new ActionTestWrap(); - list($seed1,$token1) = $action->getSeedTokenPair(600,"test"); - list($seed2,$token2) = $action->getSeedTokenPair(600,"test"); - list($seed3,$token3) = $action->getSeedTokenPair(600,"test"); - $this->assertTrue($seed1 != $seed2 && $seed2 != $seed3 && $seed1 != $seed3); - $this->assertTrue($token1 != $token2 && $token2 != $token3 && $token1 != $token3); - } - - public function testSeedValidation() - { - $action = new ActionTestWrap(); - list($seed,$token) = $action->getSeedTokenPair(600,"test"); - $action->setArguments(array( - "seed" => $seed, - "token" => $token - )); - $this->assertTrue($action->hasValidToken(600,"test")); - $this->assertFalse($action->hasValidToken(600,"test2")); - $action->setArguments(array( - "seed" => $seed."ds", - "token" => $token - )); - $this->assertFalse($action->hasValidToken(600,"test")); - $action->setArguments(array( - "seed" => $seed, - "token" => $token."afs" - )); - $this->assertFalse($action->hasValidToken(600,"test")); - } - - public function testMaxAge() - { - $action = new ActionTestWrap(); - list($seed,$token) = $action->getSeedTokenPair(1,"test"); - $action->setArguments(array( - "seed" => $seed, - "token" => $token - )); - $this->assertTrue($action->hasValidToken(1,"test")); - sleep(1); - $this->assertFalse($action->hasValidToken(1,"test")); - } -} From a1327a384cc8b7630f557ac8e8398812b7aadd20 Mon Sep 17 00:00:00 2001 From: Marius Hein Date: Tue, 25 Jun 2013 12:24:52 +0200 Subject: [PATCH 28/46] Fix Authentication workflow Fix ldap backends to use Credentials to work with. Fix some tests to use include right files. refs #4340 --- library/Icinga/Authentication/Backend.php | 3 +++ .../Backend/LdapUserBackend.php | 23 ++++++++----------- library/Icinga/Authentication/UserBackend.php | 15 +++++++++++- .../Icinga/Authentication/PhpSessionTest.php | 1 + 4 files changed, 27 insertions(+), 15 deletions(-) diff --git a/library/Icinga/Authentication/Backend.php b/library/Icinga/Authentication/Backend.php index 24fcb6433..2678e396b 100644 --- a/library/Icinga/Authentication/Backend.php +++ b/library/Icinga/Authentication/Backend.php @@ -6,6 +6,9 @@ namespace Icinga\Authentication; class Backend { + /** + * @var UserBackend + */ protected $userBackend; public function __construct($config) diff --git a/library/Icinga/Authentication/Backend/LdapUserBackend.php b/library/Icinga/Authentication/Backend/LdapUserBackend.php index 92484a615..d51a784b6 100644 --- a/library/Icinga/Authentication/Backend/LdapUserBackend.php +++ b/library/Icinga/Authentication/Backend/LdapUserBackend.php @@ -5,6 +5,8 @@ namespace Icinga\Authentication\Backend; use Icinga\Authentication\User as User; +use Icinga\Authentication\UserBackend; +use Icinga\Authentication\Credentials; use Icinga\Protocol\Ldap; class LdapUserBackend implements UserBackend @@ -16,14 +18,11 @@ class LdapUserBackend implements UserBackend $this->connection = new Ldap\Connection($config); } - public function hasUsername($username) + public function hasUsername(Credentials $credential) { - if (!$username) { - return false; - } return $this->connection->fetchOne( - $this->selectUsername($username) - ) === $username; + $this->selectUsername($credential->getUsername()) + ) === $credential->getUsername(); } protected function stripAsterisks($string) @@ -38,19 +37,15 @@ class LdapUserBackend implements UserBackend ->where('sAMAccountName', $this->stripAsterisks($username)); } - public function authenticate($username, $password = null) + public function authenticate(Credentials $credentials) { - if (empty($username) || empty($password)) { - return false; - } - if (!$this->connection->testCredentials( - $this->connection->fetchDN($this->selectUsername($username)), - $password + $this->connection->fetchDN($this->selectUsername($credentials->getUsername())), + $credentials->getPassword() ) ) { return false; } - $user = new User($username); + $user = new User($credentials->getUsername()); return $user; } diff --git a/library/Icinga/Authentication/UserBackend.php b/library/Icinga/Authentication/UserBackend.php index a62b99aa3..104ecafb4 100644 --- a/library/Icinga/Authentication/UserBackend.php +++ b/library/Icinga/Authentication/UserBackend.php @@ -1,15 +1,28 @@ Date: Wed, 26 Jun 2013 16:05:01 +0200 Subject: [PATCH 29/46] Fix empty module folder causing errors, fix var naming Fix a wrongly named class causing ClassNotFound issues, also added additional checks for empty module folder and added en moduleFolder directive to configure module location refs #4092 --- config/icinga.ini | 1 + library/Icinga/Application/ApplicationBootstrap.php | 2 +- library/Icinga/Application/Modules/Manager.php | 12 ++++++++++-- public/js/icinga/container.js | 1 - public/js/icinga/icinga.js | 2 -- public/js/main.js | 1 - 6 files changed, 12 insertions(+), 7 deletions(-) diff --git a/config/icinga.ini b/config/icinga.ini index c685d24d6..871e759f8 100755 --- a/config/icinga.ini +++ b/config/icinga.ini @@ -3,6 +3,7 @@ environment = development timezone = "Europe/Berlin" indexModule = monitoring indexController = dashboard +moduleFolder = "/usr/etc/icinga-modules" [logging] ; General log diff --git a/library/Icinga/Application/ApplicationBootstrap.php b/library/Icinga/Application/ApplicationBootstrap.php index 715850ee5..4675a1e4c 100755 --- a/library/Icinga/Application/ApplicationBootstrap.php +++ b/library/Icinga/Application/ApplicationBootstrap.php @@ -100,7 +100,7 @@ abstract class ApplicationBootstrap public function moduleManager() { if ($this->moduleManager === null) { - $this->moduleManager = new ModuleManager($this, "/etc/icinga2/modules_enabled"); + $this->moduleManager = new ModuleManager($this, $this->config->global->moduleFolder); } return $this->moduleManager; } diff --git a/library/Icinga/Application/Modules/Manager.php b/library/Icinga/Application/Modules/Manager.php index f4612de7f..96a6234c8 100644 --- a/library/Icinga/Application/Modules/Manager.php +++ b/library/Icinga/Application/Modules/Manager.php @@ -54,7 +54,7 @@ class Manager public function select() { - $source = new \Icinga\Data\ArrayDataSource($this->getModuleInfo()); + $source = new \Icinga\Data\ArrayDatasource($this->getModuleInfo()); return $source->select(); } @@ -238,7 +238,12 @@ class Manager public function getModuleInfo() { $installed = $this->listInstalledModules(); + $info = array(); + if ($installed === null) { + return $info; + } + foreach ($installed as $name) { $info[] = (object) array( 'name' => $name, @@ -265,7 +270,10 @@ class Manager if ($this->installedBaseDirs === null) { $this->detectInstalledModules(); } - return array_keys($this->installedBaseDirs); + + if ($this->installedBaseDirs !== null) { + return array_keys($this->installedBaseDirs); + } } public function detectInstalledModules() diff --git a/public/js/icinga/container.js b/public/js/icinga/container.js index 8e0891802..4f99ff53e 100755 --- a/public/js/icinga/container.js +++ b/public/js/icinga/container.js @@ -108,6 +108,5 @@ containerMgrInstance = new ContainerMgr($,log,widgets,subTable); } return containerMgrInstance; - }); })(); diff --git a/public/js/icinga/icinga.js b/public/js/icinga/icinga.js index d538ab552..1c28a35f4 100755 --- a/public/js/icinga/icinga.js +++ b/public/js/icinga/icinga.js @@ -80,5 +80,3 @@ define([ }; return new Icinga(); }); - - diff --git a/public/js/main.js b/public/js/main.js index 5e5005ae0..0a6badfa9 100755 --- a/public/js/main.js +++ b/public/js/main.js @@ -24,4 +24,3 @@ define(['jquery','Holder'], function ($) { window.Icinga = Icinga; }); }); - From 5c167563fa8d8f3d1b422f753b8b72cadd9cfe24 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Thu, 20 Jun 2013 13:47:51 +0200 Subject: [PATCH 30/46] Add SystemPermissionException This exception should be fired when the OS restricts the web user from executing certain actions. Also the template for errors has been modified so it displays the action and the target that was prevented. refs #4092 --- application/controllers/ErrorController.php | 3 +-- application/views/scripts/error/error.phtml | 11 ++++++++-- .../Exception/SystemPermissionException.php | 22 +++++++++++++++++++ 3 files changed, 32 insertions(+), 4 deletions(-) create mode 100644 library/Icinga/Exception/SystemPermissionException.php diff --git a/application/controllers/ErrorController.php b/application/controllers/ErrorController.php index efcc20e9b..c523bb77f 100755 --- a/application/controllers/ErrorController.php +++ b/application/controllers/ErrorController.php @@ -34,7 +34,6 @@ class ErrorController extends ActionController $this->view->message = 'Application error'; break; } - // conditionally display exceptions if ($this->getInvokeArg('displayExceptions') == true) { $this->view->exception = $errors->exception; @@ -44,4 +43,4 @@ class ErrorController extends ActionController } } -// @codingStandardsIgnoreEnd \ No newline at end of file +// @codingStandardsIgnoreEnd diff --git a/application/views/scripts/error/error.phtml b/application/views/scripts/error/error.phtml index 9ae6ecd1f..b5cfcddcb 100755 --- a/application/views/scripts/error/error.phtml +++ b/application/views/scripts/error/error.phtml @@ -9,8 +9,15 @@

      Exception information:

      -

      - Message: exception->getMessage() ?> +

      + Message: exception->getMessage() ?> + exception->action)): ?> +
      Action: exception->action; ?> + + exception->action)): ?> +
      Target: exception->target; ?> + +

      Stack trace:

      diff --git a/library/Icinga/Exception/SystemPermissionException.php b/library/Icinga/Exception/SystemPermissionException.php new file mode 100644 index 000000000..02849ec34 --- /dev/null +++ b/library/Icinga/Exception/SystemPermissionException.php @@ -0,0 +1,22 @@ +action = $action; + $this->target = $target; + } +} From 34f68856ee8d13973611fe7602973ac6f95c21f0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Thu, 20 Jun 2013 14:02:58 +0200 Subject: [PATCH 31/46] Add rule for 'body' container and QLink property 'target' QLinks can now define the target for their link. Additionally, the targte 'body' is now always the tag. This allows the modulemanager to reload the whole page (with the navigation bar). refs #4092 --- .../layouts/scripts/just-the-body.phtml | 8 --- application/layouts/scripts/layout.phtml | 4 +- .../layouts/scripts/parts/navigation.phtml | 3 +- application/views/helpers/Qlink.php | 5 +- public/js/icinga/modules/mainDetail.js | 71 ++++++++++--------- public/js/icinga/util/async.js | 46 ++---------- 6 files changed, 53 insertions(+), 84 deletions(-) diff --git a/application/layouts/scripts/just-the-body.phtml b/application/layouts/scripts/just-the-body.phtml index e243e63ed..ee29c44e6 100755 --- a/application/layouts/scripts/just-the-body.phtml +++ b/application/layouts/scripts/just-the-body.phtml @@ -12,14 +12,6 @@
      -
      - - - - - - -
      • diff --git a/application/layouts/scripts/layout.phtml b/application/layouts/scripts/layout.phtml index cfe89626c..d70627d1b 100755 --- a/application/layouts/scripts/layout.phtml +++ b/application/layouts/scripts/layout.phtml @@ -21,12 +21,12 @@ ICINGA_DEBUG = true; - + - + render('parts/topbar.phtml') ?>
      diff --git a/application/layouts/scripts/parts/navigation.phtml b/application/layouts/scripts/parts/navigation.phtml index 1184d1830..e7de8f369 100755 --- a/application/layouts/scripts/parts/navigation.phtml +++ b/application/layouts/scripts/parts/navigation.phtml @@ -5,7 +5,8 @@ $item = $this->navigation->listAll("menu"); ?> -auth()->isAuthenticated()): ?> +auth()->isAuthenticated()): ?> +
        view->baseUrl($url) : $baseUrl . $url; } } -// @codingStandardsIgnoreEnd \ No newline at end of file +// @codingStandardsIgnoreEnd diff --git a/public/js/icinga/modules/mainDetail.js b/public/js/icinga/modules/mainDetail.js index 9a207c933..368c5c5f7 100755 --- a/public/js/icinga/modules/mainDetail.js +++ b/public/js/icinga/modules/mainDetail.js @@ -16,45 +16,52 @@ define(['jquery','logging','icinga/util/async'],function($,log,async) { href = a.attr("href"); ev.stopImmediatePropagation(); collapseDetailView(); + async.loadToTarget("icinga-main",href); + return false; +}; + +var onLinkTagClick = function(ev) { + + var a = $(ev.currentTarget), + target = a.attr("target"), + href = a.attr("href"); + + // check for protocol:// + if(/^[A-Z]{2,10}\:\/\//i.test(href)) { + window.open(href); + ev.stopImmediatePropagation(); + return false; + } + + // check for link in table header + if(a.parents('th').length > 0) { + ev.stopImmediatePropagation(); + return false; + } + + if(typeof target === "undefined") { + if(a.parents("#icinga-detail").length) { + log.debug("Parent is detail, loading into detail"); + async.loadToTarget("icinga-detail",href); + } else { + log.debug("Parent is not detail, loading into main"); async.loadToTarget("icinga-main",href); - return false; - }; - - var onLinkTagClick = function(ev) { - - var a = $(ev.currentTarget), - target = a.attr("target"), - href = a.attr("href"); - - // check for protocol:// - if(/^[A-Z]{2,10}\:\/\//i.test(href)) { - window.open(href); - ev.stopImmediatePropagation(); - return false; - } - - // check for link in table header - if(a.parents('th').length > 0) { - ev.stopImmediatePropagation(); - return false; - } - - if(typeof target === "undefined") { - if(a.parents("#icinga-detail").length) { - async.loadToTarget("icinga-detail",href); - } else { - async.loadToTarget("icinga-main",href); - } - } else { - switch(target) { + } + } else { + switch(target) { + case "body": + async.loadToTarget("body", href); + break; case "main": async.loadToTarget("icinga-main",href); collapseDetailView(); break; case "detail": + log.debug("Target: detail"); async.loadToTarget("icinga-detail",href); break; case "popup": + log.debug("No target"); async.loadToTarget(null,href); break; default: @@ -67,7 +74,7 @@ define(['jquery','logging','icinga/util/async'],function($,log,async) { var expandDetailView = function() { $("#icinga-detail").parents(".collapsed").removeClass('collapsed'); - }; + }; var collapseDetailView = function(elementInDetailView) { $("#icinga-detail").parents(".layout-main-detail").addClass('collapsed'); @@ -88,7 +95,5 @@ define(['jquery','logging','icinga/util/async'],function($,log,async) { } }; }; - return new MainDetailBehaviour(); }); - diff --git a/public/js/icinga/util/async.js b/public/js/icinga/util/async.js index 80322964a..8e015b45a 100644 --- a/public/js/icinga/util/async.js +++ b/public/js/icinga/util/async.js @@ -3,39 +3,11 @@ "use strict"; var asyncMgrInstance = null; - define(['icinga/container','logging','jquery'],function(containerMgr,log,$) { - + define(['icinga/container','logging','icinga/behaviour','jquery'],function(containerMgr,log,behaviour,$) { var pending = { }; - - var getCurrentGETParameters = function() { - var currentGET = window.location.search.substring(1).split("&"); - var params = {}; - if(currentGET.length > 0) { - $.each(currentGET, function(idx, elem) { - var keyVal = elem.split("="); - params[encodeURIComponent(keyVal[0])] = encodeURIComponent(keyVal[1]); - }); - } - return params; - } -; - var pushGet = function(param, value, url) { - url = url || (window.location.origin+window.location.pathname); - var params = getCurrentGETParameters(); - params[encodeURIComponent(param)] = encodeURIComponent(value); - var search = "?"; - for (var name in params) { - if(search != "?") - search += "&"; - search += name+"="+params[name]; - } - - return url+search+"#"+window.location.hash; - }; - var getDOMForDestination = function(destination) { var target = destination; if(typeof destination === "string") { @@ -47,6 +19,7 @@ }; var handleResponse = function(html) { + if(this.destination) { containerMgr.updateContainer(this.destination,html,this); } else { @@ -109,31 +82,26 @@ this.loadToTarget = function(destination,url,data) { if(destination) { + log.debug("Laoding to container", destination, url); this.clearPendingRequestsFor(destination); } var req = this.createRequest(url,data); if(destination) { pending.push({ request: req, - DOM: getDOMForDestination(destination) + DOM: getDOMForDestination(destination) }); req.destination = destination; } - if (destination == "icinga-main") { - History.pushState(data, document.title, url); - } else { - url = pushGet("c["+destination+"]", url); - History.pushState(data, document.title, url); - } - console.log("New url: ", url); + return req; + }; - + this.loadCSS = function(name) { }; }; return new CallInterface(); }); - })(); From 4f2fb49555d96c9a9b99ac3816d6104a6e77b3a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Thu, 20 Jun 2013 14:06:02 +0200 Subject: [PATCH 32/46] Move ModuleController from incubator The Notification dependency is removed and uses exceptions now, otherwise it's mostly the same like in the incubator refs #4092 --- application/controllers/ModulesController.php | 47 ++++++++++++++ application/views/scripts/inline.phtml | 3 + .../views/scripts/mixedPagination.phtml | 61 +++++++++++++++++++ .../views/scripts/modules/overview.phtml | 38 ++++++++++++ application/views/scripts/modules/show.phtml | 24 ++++++++ .../Application/ApplicationBootstrap.php | 3 +- .../Icinga/Application/Modules/Manager.php | 54 +++++++++++----- public/js/icinga/container.js | 5 +- public/js/icinga/util/async.js | 4 +- 9 files changed, 220 insertions(+), 19 deletions(-) create mode 100755 application/controllers/ModulesController.php create mode 100644 application/views/scripts/inline.phtml create mode 100755 application/views/scripts/mixedPagination.phtml create mode 100644 application/views/scripts/modules/overview.phtml create mode 100644 application/views/scripts/modules/show.phtml diff --git a/application/controllers/ModulesController.php b/application/controllers/ModulesController.php new file mode 100755 index 000000000..f8f40a3b3 --- /dev/null +++ b/application/controllers/ModulesController.php @@ -0,0 +1,47 @@ +manager = Icinga::app()->moduleManager(); + } + + public function indexAction() + { + $this->view->modules = $this->manager->select() + ->from('modules') + ->order('name'); + $this->render('overview'); + } + + public function overviewAction() + { + $this->indexAction(); + + } + + public function enableAction() + { + $this->manager->enableModule($this->_getParam('name')); + $this->redirectNow('modules/overview?_render=body'); + } + + public function disableAction() + { + $this->manager->disableModule($this->_getParam('name')); + $this->redirectNow('modules/overview?_render=body'); + } + +} diff --git a/application/views/scripts/inline.phtml b/application/views/scripts/inline.phtml new file mode 100644 index 000000000..24e5f00ce --- /dev/null +++ b/application/views/scripts/inline.phtml @@ -0,0 +1,3 @@ +layout()->moduleStart ?> +layout()->content ?> +layout()->moduleEnd ?> diff --git a/application/views/scripts/mixedPagination.phtml b/application/views/scripts/mixedPagination.phtml new file mode 100755 index 000000000..7b2b23570 --- /dev/null +++ b/application/views/scripts/mixedPagination.phtml @@ -0,0 +1,61 @@ +pageCount > 1): ?> +preserve)) { + $preserve = $this->preserve; +} else { + $preserve = array(); +} + +$fromto = t('%d to %d of %d'); +$total = $this->totalItemCount; +?> + + diff --git a/application/views/scripts/modules/overview.phtml b/application/views/scripts/modules/overview.phtml new file mode 100644 index 000000000..cc651c78f --- /dev/null +++ b/application/views/scripts/modules/overview.phtml @@ -0,0 +1,38 @@ +modules->limit(10); +$modules = $this->modules->paginate(); + +?> +

        Installed Modules

        +paginationControl($modules, null, null, array( + 'preserve' => $this->preserve +)); ?> + + + + + + + + +
        +enabled): ?> + qlink( + $module->name, + 'modules/disable', + array('name' => $module->name), + array('target'=>'body') + ) ?> + + qlink( + $module->name, + 'modules/enable', + array('name' => $module->name), + array('target'=>'body') + ) ?> + + (enabled + ? ($module->loaded ? 'enabled' : 'failed') + : 'disabled' + ?>)
        diff --git a/application/views/scripts/modules/show.phtml b/application/views/scripts/modules/show.phtml new file mode 100644 index 000000000..38d5cf050 --- /dev/null +++ b/application/views/scripts/modules/show.phtml @@ -0,0 +1,24 @@ +container('modules-container',array( + "class" => "expanded_absolute" +))->beginContent() ?> + + + + + + + + + + modules as $module): ?> + + + + + + + + +
        ModuleTypeActive
        + + \ No newline at end of file diff --git a/library/Icinga/Application/ApplicationBootstrap.php b/library/Icinga/Application/ApplicationBootstrap.php index dc40cb646..715850ee5 100755 --- a/library/Icinga/Application/ApplicationBootstrap.php +++ b/library/Icinga/Application/ApplicationBootstrap.php @@ -18,6 +18,7 @@ use Icinga\Exception\ConfigurationError; * Usage example for CLI: * * use Icinga\Application\Cli; + * Cli::start(); * * @@ -99,7 +100,7 @@ abstract class ApplicationBootstrap public function moduleManager() { if ($this->moduleManager === null) { - $this->moduleManager = new ModuleManager($this); + $this->moduleManager = new ModuleManager($this, "/etc/icinga2/modules_enabled"); } return $this->moduleManager; } diff --git a/library/Icinga/Application/Modules/Manager.php b/library/Icinga/Application/Modules/Manager.php index 45f4c89aa..4061a2421 100644 --- a/library/Icinga/Application/Modules/Manager.php +++ b/library/Icinga/Application/Modules/Manager.php @@ -6,6 +6,7 @@ use Icinga\Application\ApplicationBootstrap; use Icinga\Data\ArrayDatasource; use Icinga\Web\Notification; use Icinga\Exception\ConfigurationError; +use Icinga\Exception\SystemPermissionException; // TODO: show whether enabling/disabling modules is allowed by checking enableDir // perms @@ -20,17 +21,20 @@ class Manager protected $enableDir; - public function __construct(ApplicationBootstrap $app) + public function __construct(ApplicationBootstrap $app, $dir = null) { $this->app = $app; - $this->prepareEssentials(); + if ($dir === null) { + $dir = $this->app->getConfig()->getConfigDir() + . '/enabledModules'; + } + $this->prepareEssentials($dir); $this->detectEnabledModules(); } - protected function prepareEssentials() + protected function prepareEssentials($moduleDir) { - $this->enableDir = $this->app->getConfig()->getConfigDir() - . '/enabledModules'; + $this->enableDir = $moduleDir; if (! file_exists($this->enableDir) || ! is_dir($this->enableDir)) { throw new ProgrammingError( @@ -99,13 +103,20 @@ class Manager $target = $this->installedBaseDirs[$name]; $link = $this->enableDir . '/' . $name; if (! is_writable($this->enableDir)) { - Notification::error("I do not have permissions to enable modules"); + throw new SystemPermissionException( + "Insufficient system permissions for enabling modules", + "write", + $this->enableDir + ); + } + if (file_exists($link) && is_link($link)) { return $this; } - if (@symlink($target, $link)) { - Notification::success("The module $name has been enabled"); - } else { - Notification::error("Enabling module $name failed"); + if (!@symlink($target, $link)) { + $error = error_get_last(); + if (strstr($error["message"], "File exists") === false) { + throw new SystemPermissionException($error["message"], "symlink", $link); + } } return $this; } @@ -116,16 +127,29 @@ class Manager return $this; } if (! is_writable($this->enableDir)) { - Notification::error("I do not have permissions to disable modules"); + throw new SystemPermissionException("Can't write the module directory", "write", $this->enableDir); return $this; } $link = $this->enableDir . '/' . $name; + if (!file_exists($link)) { + throw new ConfigurationError("The module $name could not be found, can't disable it"); + } + if (!is_link($link)) { + throw new ConfigurationError( + "The module $name can't be disabled as this would delete the whole module. ". + "It looks like you have installed this module manually and moved it to your module folder.". + "In order to dynamically enable and disable modules, you have to create a symlink to ". + "the enabled_modules folder" + ); + } + if (file_exists($link) && is_link($link)) { - if (@unlink($link)) { - Notification::success("The module $name has been disabled"); - } else { - Notification::error("Disabling module $name failed"); + if (!@unlink($link)) { + $error = error_get_last(); + throw new SystemPermissionException($error["message"], "unlink", $link); } + } else { + } return $this; } diff --git a/public/js/icinga/container.js b/public/js/icinga/container.js index 13c17b090..5bcb28382 100755 --- a/public/js/icinga/container.js +++ b/public/js/icinga/container.js @@ -24,7 +24,7 @@ this.updateContainer = function(id,content,req) { var target = id; if (typeof id === "string") { - target = $('div[container-id='+id+']'); + target = this.getContainer(id); } var ctrl = $('.container-controls',target); target.html(content); @@ -100,6 +100,9 @@ }; this.getContainer = function(id) { + if(id == 'body') { + return $(document.body); + } return $('div[container-id='+id+']'); }; diff --git a/public/js/icinga/util/async.js b/public/js/icinga/util/async.js index 8e015b45a..15a6be7df 100644 --- a/public/js/icinga/util/async.js +++ b/public/js/icinga/util/async.js @@ -10,7 +10,7 @@ }; var getDOMForDestination = function(destination) { var target = destination; - if(typeof destination === "string") { + if (typeof destination === "string") { target = containerMgr.getContainer(destination)[0]; } else if(typeof destination.context !== "undefined") { target = destination[0]; @@ -89,7 +89,7 @@ if(destination) { pending.push({ request: req, - DOM: getDOMForDestination(destination) + DOM: getDOMForDestination(destination) }); req.destination = destination; } From 349046972779607351d9e423990bff5eabf995ca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Thu, 20 Jun 2013 17:01:13 +0200 Subject: [PATCH 33/46] Add clearstatcache and tests for ModuleManager Added the clearstatcache call before enabling or disabling modules, as this prevents a 'File exists' error that occurs sometimes on symlink creation (even when the folder is empty). Also added tests for teh moduleManager refs #4092 --- .../Icinga/Application/Modules/Manager.php | 76 +++++++----- .../Icinga/Application/Modules/Manager.php | 111 ++++++++++++++++++ 2 files changed, 157 insertions(+), 30 deletions(-) create mode 100644 test/php/library/Icinga/Application/Modules/Manager.php diff --git a/library/Icinga/Application/Modules/Manager.php b/library/Icinga/Application/Modules/Manager.php index 4061a2421..f4612de7f 100644 --- a/library/Icinga/Application/Modules/Manager.php +++ b/library/Icinga/Application/Modules/Manager.php @@ -2,33 +2,39 @@ namespace Icinga\Application\Modules; -use Icinga\Application\ApplicationBootstrap; -use Icinga\Data\ArrayDatasource; -use Icinga\Web\Notification; use Icinga\Exception\ConfigurationError; use Icinga\Exception\SystemPermissionException; +use Icinga\Exception\ProgrammingError; // TODO: show whether enabling/disabling modules is allowed by checking enableDir // perms class Manager { - protected $installedBaseDirs; + protected $installedBaseDirs = null; protected $enabledDirs = array(); protected $loadedModules = array(); protected $index; protected $app; - protected $enableDir; - - public function __construct(ApplicationBootstrap $app, $dir = null) + protected $modulePaths = array(); + /** + * @param $app : The applicaiton bootstrap. This one needs a properly defined interface + * In order to test it correctly, the application now only requires a stdClass + * @param $dir : + **/ + public function __construct($app, $enabledDir = null, array $availableDirs = array()) { $this->app = $app; - if ($dir === null) { - $dir = $this->app->getConfig()->getConfigDir() + if (empty($availableDirs)) { + $availableDirs = array(ICINGA_APPDIR."/../modules"); + } + $this->modulePaths = $availableDirs; + if ($enabledDir === null) { + $enabledDir = $this->app->getConfig()->getConfigDir() . '/enabledModules'; } - $this->prepareEssentials($dir); + $this->prepareEssentials($enabledDir); $this->detectEnabledModules(); } @@ -46,10 +52,17 @@ class Manager } } + public function select() + { + $source = new \Icinga\Data\ArrayDataSource($this->getModuleInfo()); + return $source->select(); + } + protected function detectEnabledModules() { $fh = opendir($this->enableDir); + $this->enabledDirs = array(); while (false !== ($file = readdir($fh))) { if ($file[0] === '.') { @@ -78,12 +91,18 @@ class Manager return $this; } - public function loadModule($name) + public function loadModule($name, $moduleBase = null) { if ($this->hasLoaded($name)) { return $this; } - $module = new Module($this->app, $name, $this->getModuleDir($name)); + + $module = null; + if ($moduleBase === null) { + $module = new Module($this->app, $name, $this->getModuleDir($name)); + } else { + $module = new $moduleBase($this->app, $name, $this->getModuleDir($name)); + } $module->register(); $this->loadedModules[$name] = $module; return $this; @@ -100,6 +119,7 @@ class Manager ); return $this; } + clearstatcache(true); $target = $this->installedBaseDirs[$name]; $link = $this->enableDir . '/' . $name; if (! is_writable($this->enableDir)) { @@ -118,6 +138,7 @@ class Manager throw new SystemPermissionException($error["message"], "symlink", $link); } } + $this->enabledDirs[$name] = $link; return $this; } @@ -151,6 +172,7 @@ class Manager } else { } + unset($this->enabledDirs[$name]); return $this; } @@ -228,12 +250,6 @@ class Manager return $info; } - public function select() - { - $ds = new ArrayDatasource($this->getModuleInfo()); - return $ds->select(); - } - public function listEnabledModules() { return array_keys($this->enabledDirs); @@ -254,19 +270,19 @@ class Manager public function detectInstalledModules() { - // TODO: Allow multiple paths for installed modules (e.g. web vs pkg) - $basedir = realpath(ICINGA_APPDIR . '/../modules'); - $fh = @opendir($basedir); - if ($fh === false) { - return $this; - } - - while ($name = readdir($fh)) { - if ($name[0] === '.') { - continue; + foreach ($this->modulePaths as $basedir) { + $fh = opendir($basedir); + if ($fh === false) { + return $this; } - if (is_dir($basedir . '/' . $name)) { - $this->installedBaseDirs[$name] = $basedir . '/' . $name; + + while ($name = readdir($fh)) { + if ($name[0] === '.') { + continue; + } + if (is_dir($basedir . '/' . $name)) { + $this->installedBaseDirs[$name] = $basedir . '/' . $name; + } } } } diff --git a/test/php/library/Icinga/Application/Modules/Manager.php b/test/php/library/Icinga/Application/Modules/Manager.php new file mode 100644 index 000000000..24d2a8c25 --- /dev/null +++ b/test/php/library/Icinga/Application/Modules/Manager.php @@ -0,0 +1,111 @@ +name = $name; + $this->dir = $dir; + } + + public function register() + { + } +} + + +class ManagerTest extends \PHPUnit_Framework_TestCase +{ + const MODULE_TARGET = "/tmp"; + + protected function setUp() + { + $moduleDir = self::MODULE_TARGET; + if (!is_writable($moduleDir)) { + $this->markTestSkipped("Temporary folder not writable for this user"); + return; + } + if (is_dir($moduleDir."/enabledModules")) { + exec("rm -r $moduleDir/enabledModules"); + } + + mkdir($moduleDir."/enabledModules"); + } + + public function testDetectEnabledModules() + { + $manager = new ModuleManager(null, "/tmp/enabledModules", array("none")); + $this->assertEmpty($manager->listEnabledModules()); + + symlink(getcwd()."/res/testModules/module1", "/tmp/enabledModules/module1"); + $manager = new ModuleManager(null, "/tmp/enabledModules", array("none")); + $this->assertEquals(array("module1"), $manager->listEnabledModules()); + symlink(getcwd()."/res/testModules/module2", "/tmp/enabledModules/module2"); + symlink(getcwd()."/res/???", "/tmp/enabledModules/module3"); + $manager = new ModuleManager(null, "/tmp/enabledModules", array("none")); + $this->assertEquals(array("module1", "module2"), $manager->listEnabledModules()); + } + + public function testLoadModule() + { + $manager = new ModuleManager(null, "/tmp/enabledModules", array("./res/testModules")); + $this->assertEmpty($manager->getLoadedModules()); + $manager->loadModule("module1", "Tests\Icinga\Application\Module\Manager\ModuleMock"); + $elems = $manager->getLoadedModules(); + $this->assertNotEmpty($elems); + $this->assertTrue(isset($elems["module1"])); + // assert the changes not to be permanent: + $manager = new ModuleManager(null, "/tmp/enabledModules", array("./res/testModules")); + $this->assertEmpty($manager->getLoadedModules()); + } + + public function testEnableModule() + { + $manager = new ModuleManager(null, "/tmp/enabledModules", array(getcwd()."/res/testModules")); + $this->assertEmpty($manager->listEnabledModules()); + $manager->enableModule("module1"); + $elems = $manager->listEnabledModules(); + $this->assertNotEmpty($elems); + $this->assertEquals($elems[0], "module1"); + $this->assertTrue(is_link("/tmp/enabledModules/module1")); + // assert the changes to be permanent: + $manager = new ModuleManager(null, "/tmp/enabledModules", array("./res/testModules")); + $this->assertNotEmpty($manager->listEnabledModules()); + } + + public function testDisableModule() + { + clearstatcache(true); + symlink(getcwd()."/res/testModules/module1", "/tmp/enabledModules/module1"); + $manager = new ModuleManager(null, "/tmp/enabledModules", array(getcwd()."/res/testModules")); + $elems = $manager->listEnabledModules(); + $this->assertNotEmpty($elems); + $this->assertEquals($elems[0], "module1"); + $manager->disableModule("module1"); + $this->assertFalse(file_exists("/tmp/enabledModules/module1")); + $this->assertEmpty($manager->listEnabledModules()); + // assert the changes to be permanent: + $manager = new ModuleManager(null, "/tmp/enabledModules", array("./res/testModules")); + $this->assertEmpty($manager->listEnabledModules()); + } + + protected function tearDown() + { + $moduleDir = self::MODULE_TARGET; + exec("rm -r $moduleDir/enabledModules"); + + } +} From 3a5a4bf2730f8a98ae8a456185a46eb7719742c9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Fri, 21 Jun 2013 09:53:37 +0200 Subject: [PATCH 34/46] Remove moved files the 'behaviour' namespace in javascript has been renamed to module refs #4092 --- public/js/icinga/modules/actionTable.js | 118 ------------------------ public/js/icinga/modules/mainDetail.js | 99 -------------------- 2 files changed, 217 deletions(-) delete mode 100644 public/js/icinga/modules/actionTable.js delete mode 100755 public/js/icinga/modules/mainDetail.js diff --git a/public/js/icinga/modules/actionTable.js b/public/js/icinga/modules/actionTable.js deleted file mode 100644 index e8e61952b..000000000 --- a/public/js/icinga/modules/actionTable.js +++ /dev/null @@ -1,118 +0,0 @@ -/*global Icinga:false, document: false, define:false require:false base_url:false console:false */ - -/** - * ActionTable behaviour as described in - * https://wiki.icinga.org/display/cranberry/Frontend+Components#FrontendComponents-ActionTable - * - * @TODO: Row selection - */ -define(['jquery','logging','icinga/util/async'],function($,log,async) { - "use strict"; - - var ActionTableBehaviour = function() { - var onTableHeaderClick; - - var TABLE_BASE_MATCHER = '.icinga-container table.action'; - var linksInActionTable = TABLE_BASE_MATCHER+" tbody tr > a"; - var actionTableRow = TABLE_BASE_MATCHER+" tbody tr"; - var headerRow = TABLE_BASE_MATCHER+" > th a"; - var searchField = ".icinga-container .actiontable.controls input[type=search]"; - - - onTableHeaderClick = function (ev) { - var target = ev.currentTarget, - href = $(target).attr('href'), - destination; - if ($(target).parents('.layout-main-detail').length) { - if ($(target).parents("#icinga-main").length) { - destination = 'icinga-main'; - } - else { - destination = 'icinga-detail'; - } - - } else { - destination = 'icinga-main'; - } - async.loadToTarget(destination, href); - ev.preventDefault(); - ev.stopImmediatePropagation(); - return false; - }; - - var onLinkTagClick = function(ev) { - - var target = ev.currentTarget, - href = $(target).attr('href'), - destination; - if ($(target).parents('.layout-main-detail').length) { - destination = 'icinga-detail'; - } else { - destination = 'icinga-main'; - } - async.loadToTarget(destination,href); - ev.preventDefault(); - ev.stopImmediatePropagation(); - return false; - - }; - - var onTableRowClick = function(ev) { - ev.stopImmediatePropagation(); - - var target = $(ev.currentTarget), - href = target.attr('href'), - destination; - $('tr.active',target.parent('tbody').first()).removeClass("active"); - target.addClass('active'); - - // When the tr has a href, act like it is a link - if(href) { - ev.currentTarget = target.first(); - return onLinkTagClick(ev); - } - // Try to find a designated row action - var links = $("a.row-action",target); - if(links.length) { - ev.currentTarget = links.first(); - return onLinkTagClick(ev); - } - - // otherwise use the first anchor tag - links = $("a",target); - if(links.length) { - ev.currentTarget = links.first(); - return onLinkTagClick(ev); - } - - log.debug("No target for this table row found"); - return false; - }; - - var onSearchInput = function(ev) { - ev.stopImmediatePropagation(); - var txt = $(this).val(); - }; - - this.eventHandler = {}; - this.eventHandler[linksInActionTable] = { - 'click' : onLinkTagClick - }; - this.eventHandler[actionTableRow] = { - 'click' : onTableRowClick - }; - this.eventHandler[headerRow] = { - 'click' : onTableHeaderClick - }; - this.eventHandler[searchField] = { - 'keyup' : onSearchInput - }; - - this.enable = function() { - - }; - }; - - return new ActionTableBehaviour(); - -}); \ No newline at end of file diff --git a/public/js/icinga/modules/mainDetail.js b/public/js/icinga/modules/mainDetail.js deleted file mode 100755 index 368c5c5f7..000000000 --- a/public/js/icinga/modules/mainDetail.js +++ /dev/null @@ -1,99 +0,0 @@ -/*global Icinga:false, document: false, define:false require:false base_url:false console:false */ - -/** - * Main-Detail layout behaviour as described in - * https://wiki.icinga.org/display/cranberry/Frontend+Components#FrontendComponents-Behaviour - * - */ -define(['jquery','logging','icinga/util/async'],function($,log,async) { - "use strict"; - - var MainDetailBehaviour = function() { - - var onOuterLinkClick = function(ev) { - var a = $(ev.currentTarget), - target = a.attr("target"), - href = a.attr("href"); - ev.stopImmediatePropagation(); - collapseDetailView(); - async.loadToTarget("icinga-main",href); - return false; -}; - -var onLinkTagClick = function(ev) { - - var a = $(ev.currentTarget), - target = a.attr("target"), - href = a.attr("href"); - - // check for protocol:// - if(/^[A-Z]{2,10}\:\/\//i.test(href)) { - window.open(href); - ev.stopImmediatePropagation(); - return false; - } - - // check for link in table header - if(a.parents('th').length > 0) { - ev.stopImmediatePropagation(); - return false; - } - - if(typeof target === "undefined") { - if(a.parents("#icinga-detail").length) { - log.debug("Parent is detail, loading into detail"); - async.loadToTarget("icinga-detail",href); - } else { - log.debug("Parent is not detail, loading into main"); - async.loadToTarget("icinga-main",href); - } - } else { - switch(target) { - case "body": - async.loadToTarget("body", href); - break; - case "main": - async.loadToTarget("icinga-main",href); - collapseDetailView(); - break; - case "detail": - log.debug("Target: detail"); - async.loadToTarget("icinga-detail",href); - break; - case "popup": - log.debug("No target"); - async.loadToTarget(null,href); - break; - default: - return true; - } - } - ev.stopImmediatePropagation(); - return false; - }; - - var expandDetailView = function() { - $("#icinga-detail").parents(".collapsed").removeClass('collapsed'); - }; - - var collapseDetailView = function(elementInDetailView) { - $("#icinga-detail").parents(".layout-main-detail").addClass('collapsed'); - }; - - this.expandDetailView = expandDetailView; - this.collapseDetailView = collapseDetailView; - - this.eventHandler = { - '.layout-main-detail * a' : { - 'click' : onLinkTagClick - }, - 'a' : { - 'click' : onOuterLinkClick - }, - '.layout-main-detail .icinga-container#icinga-detail' : { - 'focus' : expandDetailView - } - }; - }; - return new MainDetailBehaviour(); -}); From d94d89e1cfc812dd9dffa13785fa44c01e23757a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Fri, 21 Jun 2013 11:36:12 +0200 Subject: [PATCH 35/46] Add javascript autoloading the js/modules/%modulename%/%file% is now mapped to the module path (if existing). To prevent name clashing, the modules folder has been renamed to components. --- application/controllers/StaticController.php | 10 +- library/Icinga/Application/Web.php | 12 ++ public/js/icinga/components/actionTable.js | 118 +++++++++++++++++++ public/js/icinga/components/mainDetail.js | 99 ++++++++++++++++ public/js/icinga/container.js | 8 +- public/js/icinga/icinga.js | 4 +- 6 files changed, 239 insertions(+), 12 deletions(-) create mode 100644 public/js/icinga/components/actionTable.js create mode 100755 public/js/icinga/components/mainDetail.js diff --git a/application/controllers/StaticController.php b/application/controllers/StaticController.php index bb5723a84..5704dbf4a 100644 --- a/application/controllers/StaticController.php +++ b/application/controllers/StaticController.php @@ -9,6 +9,7 @@ use Icinga\Web\ActionController; use Icinga\Application\Icinga; use Zend_Controller_Action_Exception as ActionException; +use Icinga\Application\Benchmark; /** * Class StaticController * @package Icinga\Web\Form @@ -69,7 +70,7 @@ class StaticController extends ActionController */ public function javascriptAction() { - $module = $this->_getParam('moduleName'); + $module = $this->_getParam('module_name'); $file = $this->_getParam('file'); $basedir = Icinga::app()->getModule($module)->getBaseDir(); @@ -96,15 +97,16 @@ class StaticController extends ActionController ) . ' GMT' ); + $hash = md5_file($filePath); + if ($hash === $this->getRequest()->getHeader('If-None-Match')) { $response->setHttpResponseCode(304); return; } else { readfile($filePath); } - // TODO: get rid of exit: - exit; + return; } } -// @codingStandardsIgnoreEnd \ No newline at end of file +// @codingStandardsIgnoreEnd diff --git a/library/Icinga/Application/Web.php b/library/Icinga/Application/Web.php index 32f611594..1fa538e88 100644 --- a/library/Icinga/Application/Web.php +++ b/library/Icinga/Application/Web.php @@ -59,6 +59,17 @@ class Web extends ApplicationBootstrap ) ) ); + + $this->frontController->getRouter()->addRoute( + 'module_javascript', + new Route( + 'js/modules/:module_name/:file', + array( + 'controller' => 'static', + 'action' => 'javascript' + ) + ) + ); return $this; } @@ -162,6 +173,7 @@ class Web extends ApplicationBootstrap */ protected function configurePagination() { + Paginator::addScrollingStylePrefixPath( 'Icinga_Web_Paginator_ScrollingStyle', 'Icinga/Web/Paginator/ScrollingStyle' diff --git a/public/js/icinga/components/actionTable.js b/public/js/icinga/components/actionTable.js new file mode 100644 index 000000000..e8e61952b --- /dev/null +++ b/public/js/icinga/components/actionTable.js @@ -0,0 +1,118 @@ +/*global Icinga:false, document: false, define:false require:false base_url:false console:false */ + +/** + * ActionTable behaviour as described in + * https://wiki.icinga.org/display/cranberry/Frontend+Components#FrontendComponents-ActionTable + * + * @TODO: Row selection + */ +define(['jquery','logging','icinga/util/async'],function($,log,async) { + "use strict"; + + var ActionTableBehaviour = function() { + var onTableHeaderClick; + + var TABLE_BASE_MATCHER = '.icinga-container table.action'; + var linksInActionTable = TABLE_BASE_MATCHER+" tbody tr > a"; + var actionTableRow = TABLE_BASE_MATCHER+" tbody tr"; + var headerRow = TABLE_BASE_MATCHER+" > th a"; + var searchField = ".icinga-container .actiontable.controls input[type=search]"; + + + onTableHeaderClick = function (ev) { + var target = ev.currentTarget, + href = $(target).attr('href'), + destination; + if ($(target).parents('.layout-main-detail').length) { + if ($(target).parents("#icinga-main").length) { + destination = 'icinga-main'; + } + else { + destination = 'icinga-detail'; + } + + } else { + destination = 'icinga-main'; + } + async.loadToTarget(destination, href); + ev.preventDefault(); + ev.stopImmediatePropagation(); + return false; + }; + + var onLinkTagClick = function(ev) { + + var target = ev.currentTarget, + href = $(target).attr('href'), + destination; + if ($(target).parents('.layout-main-detail').length) { + destination = 'icinga-detail'; + } else { + destination = 'icinga-main'; + } + async.loadToTarget(destination,href); + ev.preventDefault(); + ev.stopImmediatePropagation(); + return false; + + }; + + var onTableRowClick = function(ev) { + ev.stopImmediatePropagation(); + + var target = $(ev.currentTarget), + href = target.attr('href'), + destination; + $('tr.active',target.parent('tbody').first()).removeClass("active"); + target.addClass('active'); + + // When the tr has a href, act like it is a link + if(href) { + ev.currentTarget = target.first(); + return onLinkTagClick(ev); + } + // Try to find a designated row action + var links = $("a.row-action",target); + if(links.length) { + ev.currentTarget = links.first(); + return onLinkTagClick(ev); + } + + // otherwise use the first anchor tag + links = $("a",target); + if(links.length) { + ev.currentTarget = links.first(); + return onLinkTagClick(ev); + } + + log.debug("No target for this table row found"); + return false; + }; + + var onSearchInput = function(ev) { + ev.stopImmediatePropagation(); + var txt = $(this).val(); + }; + + this.eventHandler = {}; + this.eventHandler[linksInActionTable] = { + 'click' : onLinkTagClick + }; + this.eventHandler[actionTableRow] = { + 'click' : onTableRowClick + }; + this.eventHandler[headerRow] = { + 'click' : onTableHeaderClick + }; + this.eventHandler[searchField] = { + 'keyup' : onSearchInput + }; + + this.enable = function() { + + }; + }; + + return new ActionTableBehaviour(); + +}); \ No newline at end of file diff --git a/public/js/icinga/components/mainDetail.js b/public/js/icinga/components/mainDetail.js new file mode 100755 index 000000000..368c5c5f7 --- /dev/null +++ b/public/js/icinga/components/mainDetail.js @@ -0,0 +1,99 @@ +/*global Icinga:false, document: false, define:false require:false base_url:false console:false */ + +/** + * Main-Detail layout behaviour as described in + * https://wiki.icinga.org/display/cranberry/Frontend+Components#FrontendComponents-Behaviour + * + */ +define(['jquery','logging','icinga/util/async'],function($,log,async) { + "use strict"; + + var MainDetailBehaviour = function() { + + var onOuterLinkClick = function(ev) { + var a = $(ev.currentTarget), + target = a.attr("target"), + href = a.attr("href"); + ev.stopImmediatePropagation(); + collapseDetailView(); + async.loadToTarget("icinga-main",href); + return false; +}; + +var onLinkTagClick = function(ev) { + + var a = $(ev.currentTarget), + target = a.attr("target"), + href = a.attr("href"); + + // check for protocol:// + if(/^[A-Z]{2,10}\:\/\//i.test(href)) { + window.open(href); + ev.stopImmediatePropagation(); + return false; + } + + // check for link in table header + if(a.parents('th').length > 0) { + ev.stopImmediatePropagation(); + return false; + } + + if(typeof target === "undefined") { + if(a.parents("#icinga-detail").length) { + log.debug("Parent is detail, loading into detail"); + async.loadToTarget("icinga-detail",href); + } else { + log.debug("Parent is not detail, loading into main"); + async.loadToTarget("icinga-main",href); + } + } else { + switch(target) { + case "body": + async.loadToTarget("body", href); + break; + case "main": + async.loadToTarget("icinga-main",href); + collapseDetailView(); + break; + case "detail": + log.debug("Target: detail"); + async.loadToTarget("icinga-detail",href); + break; + case "popup": + log.debug("No target"); + async.loadToTarget(null,href); + break; + default: + return true; + } + } + ev.stopImmediatePropagation(); + return false; + }; + + var expandDetailView = function() { + $("#icinga-detail").parents(".collapsed").removeClass('collapsed'); + }; + + var collapseDetailView = function(elementInDetailView) { + $("#icinga-detail").parents(".layout-main-detail").addClass('collapsed'); + }; + + this.expandDetailView = expandDetailView; + this.collapseDetailView = collapseDetailView; + + this.eventHandler = { + '.layout-main-detail * a' : { + 'click' : onLinkTagClick + }, + 'a' : { + 'click' : onOuterLinkClick + }, + '.layout-main-detail .icinga-container#icinga-detail' : { + 'focus' : expandDetailView + } + }; + }; + return new MainDetailBehaviour(); +}); diff --git a/public/js/icinga/container.js b/public/js/icinga/container.js index 5bcb28382..8e0891802 100755 --- a/public/js/icinga/container.js +++ b/public/js/icinga/container.js @@ -5,7 +5,7 @@ var containerMgrInstance = null; var async; - var ContainerMgr = function($,log,Widgets,SubTable,holder) { + var ContainerMgr = function($,log,Widgets,SubTable) { var enhanceDetachLinks = function() { @@ -34,14 +34,12 @@ } target.focus(); this.initializeContainers(target); - }; this.updateControlTargets = function(ctrl, req) { $('a',ctrl).each(function() { $(this).attr("href",req.url); }); - }; this.initControlBehaviour = function(root) { @@ -86,7 +84,6 @@ this.initExpandables(root); this.drawImplicitWidgets(root); this.loadAsyncContainers(root); - }; this.createPopupContainer = function(content,req) { @@ -96,7 +93,6 @@ .append($("
        ").addClass('modal-body').html(content)).appendTo(document.body); closeButton.on("click",function() {container.remove();}); - }; this.getContainer = function(id) { @@ -107,7 +103,7 @@ }; }; - define(['jquery','logging','icinga/widgets/checkIcons','icinga/widgets/subTable'], function($,log,widgets,subTable) { + define(['jquery','logging','icinga/widgets/checkIcons','icinga/widgets/subTable'],function($,log,widgets,subTable) { if (containerMgrInstance === null) { containerMgrInstance = new ContainerMgr($,log,widgets,subTable); } diff --git a/public/js/icinga/icinga.js b/public/js/icinga/icinga.js index 143593942..822a9d7a3 100755 --- a/public/js/icinga/icinga.js +++ b/public/js/icinga/icinga.js @@ -13,7 +13,7 @@ define([ * Icinga prototype */ var Icinga = function() { - var internalModules = ['icinga/modules/actionTable','icinga/modules/mainDetail']; + var internalModules = ['icinga/components/actionTable','icinga/components/mainDetail']; this.modules = {}; var failedModules = []; @@ -37,7 +37,7 @@ define([ }; var loadModuleScript = function(name) { - moduleMgr.enableModule("modules/"+name, function(error) { + moduleMgr.enableModule("modules/"+name+"/"+name, function(error) { failedModules.push({ name: name, errorMessage: error From c25ea37fd89bfb49c897bcd795bb03d652f4fdb0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Fri, 21 Jun 2013 11:40:25 +0200 Subject: [PATCH 36/46] Fix test for new module route The js base route is now js/modules/%modulename%/%file%. This commit reflects these changes in the testcases refs #4092 refs #3735 --- test/js/test/icinga/moduleTest.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/js/test/icinga/moduleTest.js b/test/js/test/icinga/moduleTest.js index 6a446b5f4..494d0264a 100644 --- a/test/js/test/icinga/moduleTest.js +++ b/test/js/test/icinga/moduleTest.js @@ -195,7 +195,7 @@ describe('The icinga module bootstrap', function() { var testClick = false; rjsmock.registerDependencies({ "icinga/module": module, - "modules/test" : { + "modules/test/test" : { eventHandler: { "a.test" : { click : function() { From e9ade7a33989d833aebd6d4da32893cdb2067d0a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Fri, 21 Jun 2013 15:33:06 +0200 Subject: [PATCH 37/46] Add support for lazy module loading When the X-Icinga-Module-Enable header is send, the modulemanager automatically tries to load javascript files for that module. This is realized by adding the 'registerHeaderListener' method to the async manager, which allows to listen to specific headers and firing callbacks if a response with the specified header is retrieved. Also the tests have changed a bit, requireNow should be used when using the requiremock, so a require always loads files new. refs #4092 refs #3753 --- application/controllers/ModulesController.php | 6 +- public/js/icinga/icinga.js | 8 ++- public/js/icinga/util/async.js | 34 ++++++++-- test/js/test/icinga/asyncTest.js | 35 +++++++++++ test/js/test/icinga/moduleTest.js | 62 +++++++++++++++++-- test/js/testlib/asyncmock.js | 33 ++++++++++ test/js/testlib/requiremock.js | 15 ++++- 7 files changed, 179 insertions(+), 14 deletions(-) create mode 100644 test/js/test/icinga/asyncTest.js create mode 100644 test/js/testlib/asyncmock.js diff --git a/application/controllers/ModulesController.php b/application/controllers/ModulesController.php index f8f40a3b3..afd3b9178 100755 --- a/application/controllers/ModulesController.php +++ b/application/controllers/ModulesController.php @@ -35,7 +35,11 @@ class ModulesController extends ActionController public function enableAction() { $this->manager->enableModule($this->_getParam('name')); - $this->redirectNow('modules/overview?_render=body'); + $this->manager->loadModule($this->_getParam('name')); + $this->getResponse()->setHeader('X-Icinga-Enable-Module', $this->_getParam('name')); + $this->replaceLayout = true; + $this->indexAction(); + } public function disableAction() diff --git a/public/js/icinga/icinga.js b/public/js/icinga/icinga.js index 822a9d7a3..40fc20dc6 100755 --- a/public/js/icinga/icinga.js +++ b/public/js/icinga/icinga.js @@ -19,16 +19,19 @@ define([ var failedModules = []; var initialize = function () { + registerLazyModuleLoading(); enableInternalModules(); - + containerMgr.registerAsyncMgr(async); containerMgr.initializeContainers(document); log.debug("Initialization finished"); enableModules(); }; - + var registerLazyModuleLoading = function() { + async.registerHeaderListener("X-Icinga-Enable-Module", loadModuleScript, this); + }; var enableInternalModules = function() { $.each(internalModules,function(idx,module) { @@ -37,6 +40,7 @@ define([ }; var loadModuleScript = function(name) { + console.log("Loading ", name); moduleMgr.enableModule("modules/"+name+"/"+name, function(error) { failedModules.push({ name: name, diff --git a/public/js/icinga/util/async.js b/public/js/icinga/util/async.js index 15a6be7df..1b564b176 100644 --- a/public/js/icinga/util/async.js +++ b/public/js/icinga/util/async.js @@ -3,7 +3,8 @@ "use strict"; var asyncMgrInstance = null; - define(['icinga/container','logging','icinga/behaviour','jquery'],function(containerMgr,log,behaviour,$) { + define(['icinga/container','logging','jquery'],function(containerMgr,log,$) { + var headerListeners = {}; var pending = { @@ -18,12 +19,30 @@ return target; }; - var handleResponse = function(html) { + var applyHeaderListeners = function(headers) { + for (var header in headerListeners) { + if (headers.getResponseHeader(header) === null) { + // see if the browser/server converts headers to lowercase + if (headers.getResponseHeader(header.toLowerCase()) === null) { + continue; + } + header = header.toLowerCase(); + } + var value = headers.getResponseHeader(header); + var listeners = headerListeners[header]; + for (var i=0;i")); $('a.test').click(); @@ -223,4 +226,55 @@ describe('The icinga module bootstrap', function() { should.equal(icinga.getFailedModules()[0].name, "test2"); tearDownTestDOM(); }); + + it("Should load modules lazily when discovering a X-Icinga-Enable-Module header", function() { + rjsmock.purgeDependencies(); + + requireNew("icinga/util/async.js"); + var async = rjsmock.getDefine(); + + rjsmock.registerDependencies({ + "icinga/module": module, + "icinga/util/async": async, + "modules/test/test" : { + eventHandler: { + "a.test" : { + click : function() { + testClick = true; + } + } + } + }, + "icinga/container" : { + registerAsyncMgr: function() {}, + initializeContainers: function() {} + }, + "modules/list" : [ + ] + }); + + tearDownTestDOM(); + + requireNew("icinga/icinga.js"); + var icinga = rjsmock.getDefine(); + + var testClick = false; + // The module shouldn't be loaded + $('body').append($("")); + $('a.test').click(); + should.equal(testClick, false, "Unregistered module was loaded"); + + asyncMock.setNextAsyncResult(async,"result", false, { + "X-Icinga-Enable-Module" : "test" + }); + async.createRequest(); + // The module shouldn't be loaded + $('body').append($("")); + $('a.test').click(); + should.equal(testClick, true, "Module wasn't automatically loaded on header!"); + + + tearDownTestDOM(); + + }); }); diff --git a/test/js/testlib/asyncmock.js b/test/js/testlib/asyncmock.js new file mode 100644 index 000000000..aad6d5eea --- /dev/null +++ b/test/js/testlib/asyncmock.js @@ -0,0 +1,33 @@ +/** + * Helper for mocking $.async's XHR requests + * + */ + + +var getCallback = function(empty, response, succeed, headers) { + if (empty) + return function() {}; + return function(callback) { + callback(response, succeed, { + getAllResponseHeaders: function() { + return headers; + }, + getResponseHeader: function(header) { + return headers[header] || null; + } + }); + }; +}; + +module.exports = { + setNextAsyncResult: function(async, response, fails, headers) { + headers = headers || {}; + var succeed = fails ? "fail" : "success"; + async.__internalXHRImplementation = function(config) { + return { + done: getCallback(fails, response, succeed, headers), + fail: getCallback(!fails, response, succeed, headers) + }; + }; + } +}; diff --git a/test/js/testlib/requiremock.js b/test/js/testlib/requiremock.js index 8181092da..e61b08694 100644 --- a/test/js/testlib/requiremock.js +++ b/test/js/testlib/requiremock.js @@ -13,6 +13,7 @@ * to console. * **/ +var path = require('path'); var registeredDependencies = {}; /** @@ -21,11 +22,13 @@ var registeredDependencies = {}; * in dependencies and calls fn with them as the parameter * **/ +var debug = false; var requireJsMock = function(dependencies, fn) { var fnArgs = []; for (var i=0;i Date: Thu, 20 Jun 2013 14:02:58 +0200 Subject: [PATCH 38/46] Add rule for 'body' container and QLink property 'target' QLinks can now define the target for their link. Additionally, the targte 'body' is now always the tag. This allows the modulemanager to reload the whole page (with the navigation bar). refs #4092 --- public/js/icinga/util/async.js | 38 ++++++---------------------------- 1 file changed, 6 insertions(+), 32 deletions(-) diff --git a/public/js/icinga/util/async.js b/public/js/icinga/util/async.js index 1b564b176..8e015b45a 100644 --- a/public/js/icinga/util/async.js +++ b/public/js/icinga/util/async.js @@ -3,15 +3,14 @@ "use strict"; var asyncMgrInstance = null; - define(['icinga/container','logging','jquery'],function(containerMgr,log,$) { - var headerListeners = {}; + define(['icinga/container','logging','icinga/behaviour','jquery'],function(containerMgr,log,behaviour,$) { var pending = { }; var getDOMForDestination = function(destination) { var target = destination; - if (typeof destination === "string") { + if(typeof destination === "string") { target = containerMgr.getContainer(destination)[0]; } else if(typeof destination.context !== "undefined") { target = destination[0]; @@ -19,30 +18,12 @@ return target; }; - var applyHeaderListeners = function(headers) { - for (var header in headerListeners) { - if (headers.getResponseHeader(header) === null) { - // see if the browser/server converts headers to lowercase - if (headers.getResponseHeader(header.toLowerCase()) === null) { - continue; - } - header = header.toLowerCase(); - } - var value = headers.getResponseHeader(header); - var listeners = headerListeners[header]; - for (var i=0;i Date: Thu, 20 Jun 2013 14:06:02 +0200 Subject: [PATCH 39/46] Move ModuleController from incubator The Notification dependency is removed and uses exceptions now, otherwise it's mostly the same like in the incubator refs #4092 --- application/controllers/ModulesController.php | 6 +- .../Icinga/Application/Modules/Manager.php | 76 ++++++++----------- public/js/icinga/util/async.js | 4 +- 3 files changed, 33 insertions(+), 53 deletions(-) diff --git a/application/controllers/ModulesController.php b/application/controllers/ModulesController.php index afd3b9178..f8f40a3b3 100755 --- a/application/controllers/ModulesController.php +++ b/application/controllers/ModulesController.php @@ -35,11 +35,7 @@ class ModulesController extends ActionController public function enableAction() { $this->manager->enableModule($this->_getParam('name')); - $this->manager->loadModule($this->_getParam('name')); - $this->getResponse()->setHeader('X-Icinga-Enable-Module', $this->_getParam('name')); - $this->replaceLayout = true; - $this->indexAction(); - + $this->redirectNow('modules/overview?_render=body'); } public function disableAction() diff --git a/library/Icinga/Application/Modules/Manager.php b/library/Icinga/Application/Modules/Manager.php index f4612de7f..4061a2421 100644 --- a/library/Icinga/Application/Modules/Manager.php +++ b/library/Icinga/Application/Modules/Manager.php @@ -2,39 +2,33 @@ namespace Icinga\Application\Modules; +use Icinga\Application\ApplicationBootstrap; +use Icinga\Data\ArrayDatasource; +use Icinga\Web\Notification; use Icinga\Exception\ConfigurationError; use Icinga\Exception\SystemPermissionException; -use Icinga\Exception\ProgrammingError; // TODO: show whether enabling/disabling modules is allowed by checking enableDir // perms class Manager { - protected $installedBaseDirs = null; + protected $installedBaseDirs; protected $enabledDirs = array(); protected $loadedModules = array(); protected $index; protected $app; + protected $enableDir; - protected $modulePaths = array(); - /** - * @param $app : The applicaiton bootstrap. This one needs a properly defined interface - * In order to test it correctly, the application now only requires a stdClass - * @param $dir : - **/ - public function __construct($app, $enabledDir = null, array $availableDirs = array()) + + public function __construct(ApplicationBootstrap $app, $dir = null) { $this->app = $app; - if (empty($availableDirs)) { - $availableDirs = array(ICINGA_APPDIR."/../modules"); - } - $this->modulePaths = $availableDirs; - if ($enabledDir === null) { - $enabledDir = $this->app->getConfig()->getConfigDir() + if ($dir === null) { + $dir = $this->app->getConfig()->getConfigDir() . '/enabledModules'; } - $this->prepareEssentials($enabledDir); + $this->prepareEssentials($dir); $this->detectEnabledModules(); } @@ -52,17 +46,10 @@ class Manager } } - public function select() - { - $source = new \Icinga\Data\ArrayDataSource($this->getModuleInfo()); - return $source->select(); - } - protected function detectEnabledModules() { $fh = opendir($this->enableDir); - $this->enabledDirs = array(); while (false !== ($file = readdir($fh))) { if ($file[0] === '.') { @@ -91,18 +78,12 @@ class Manager return $this; } - public function loadModule($name, $moduleBase = null) + public function loadModule($name) { if ($this->hasLoaded($name)) { return $this; } - - $module = null; - if ($moduleBase === null) { - $module = new Module($this->app, $name, $this->getModuleDir($name)); - } else { - $module = new $moduleBase($this->app, $name, $this->getModuleDir($name)); - } + $module = new Module($this->app, $name, $this->getModuleDir($name)); $module->register(); $this->loadedModules[$name] = $module; return $this; @@ -119,7 +100,6 @@ class Manager ); return $this; } - clearstatcache(true); $target = $this->installedBaseDirs[$name]; $link = $this->enableDir . '/' . $name; if (! is_writable($this->enableDir)) { @@ -138,7 +118,6 @@ class Manager throw new SystemPermissionException($error["message"], "symlink", $link); } } - $this->enabledDirs[$name] = $link; return $this; } @@ -172,7 +151,6 @@ class Manager } else { } - unset($this->enabledDirs[$name]); return $this; } @@ -250,6 +228,12 @@ class Manager return $info; } + public function select() + { + $ds = new ArrayDatasource($this->getModuleInfo()); + return $ds->select(); + } + public function listEnabledModules() { return array_keys($this->enabledDirs); @@ -270,19 +254,19 @@ class Manager public function detectInstalledModules() { - foreach ($this->modulePaths as $basedir) { - $fh = opendir($basedir); - if ($fh === false) { - return $this; + // TODO: Allow multiple paths for installed modules (e.g. web vs pkg) + $basedir = realpath(ICINGA_APPDIR . '/../modules'); + $fh = @opendir($basedir); + if ($fh === false) { + return $this; + } + + while ($name = readdir($fh)) { + if ($name[0] === '.') { + continue; } - - while ($name = readdir($fh)) { - if ($name[0] === '.') { - continue; - } - if (is_dir($basedir . '/' . $name)) { - $this->installedBaseDirs[$name] = $basedir . '/' . $name; - } + if (is_dir($basedir . '/' . $name)) { + $this->installedBaseDirs[$name] = $basedir . '/' . $name; } } } diff --git a/public/js/icinga/util/async.js b/public/js/icinga/util/async.js index 8e015b45a..15a6be7df 100644 --- a/public/js/icinga/util/async.js +++ b/public/js/icinga/util/async.js @@ -10,7 +10,7 @@ }; var getDOMForDestination = function(destination) { var target = destination; - if(typeof destination === "string") { + if (typeof destination === "string") { target = containerMgr.getContainer(destination)[0]; } else if(typeof destination.context !== "undefined") { target = destination[0]; @@ -89,7 +89,7 @@ if(destination) { pending.push({ request: req, - DOM: getDOMForDestination(destination) + DOM: getDOMForDestination(destination) }); req.destination = destination; } From 81bbee7e2487c712fc0fa9643f5bc651a4ed4582 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Thu, 20 Jun 2013 17:01:13 +0200 Subject: [PATCH 40/46] Add clearstatcache and tests for ModuleManager Added the clearstatcache call before enabling or disabling modules, as this prevents a 'File exists' error that occurs sometimes on symlink creation (even when the folder is empty). Also added tests for teh moduleManager refs #4092 --- .../Icinga/Application/Modules/Manager.php | 76 +++++++++++-------- 1 file changed, 46 insertions(+), 30 deletions(-) diff --git a/library/Icinga/Application/Modules/Manager.php b/library/Icinga/Application/Modules/Manager.php index 4061a2421..f4612de7f 100644 --- a/library/Icinga/Application/Modules/Manager.php +++ b/library/Icinga/Application/Modules/Manager.php @@ -2,33 +2,39 @@ namespace Icinga\Application\Modules; -use Icinga\Application\ApplicationBootstrap; -use Icinga\Data\ArrayDatasource; -use Icinga\Web\Notification; use Icinga\Exception\ConfigurationError; use Icinga\Exception\SystemPermissionException; +use Icinga\Exception\ProgrammingError; // TODO: show whether enabling/disabling modules is allowed by checking enableDir // perms class Manager { - protected $installedBaseDirs; + protected $installedBaseDirs = null; protected $enabledDirs = array(); protected $loadedModules = array(); protected $index; protected $app; - protected $enableDir; - - public function __construct(ApplicationBootstrap $app, $dir = null) + protected $modulePaths = array(); + /** + * @param $app : The applicaiton bootstrap. This one needs a properly defined interface + * In order to test it correctly, the application now only requires a stdClass + * @param $dir : + **/ + public function __construct($app, $enabledDir = null, array $availableDirs = array()) { $this->app = $app; - if ($dir === null) { - $dir = $this->app->getConfig()->getConfigDir() + if (empty($availableDirs)) { + $availableDirs = array(ICINGA_APPDIR."/../modules"); + } + $this->modulePaths = $availableDirs; + if ($enabledDir === null) { + $enabledDir = $this->app->getConfig()->getConfigDir() . '/enabledModules'; } - $this->prepareEssentials($dir); + $this->prepareEssentials($enabledDir); $this->detectEnabledModules(); } @@ -46,10 +52,17 @@ class Manager } } + public function select() + { + $source = new \Icinga\Data\ArrayDataSource($this->getModuleInfo()); + return $source->select(); + } + protected function detectEnabledModules() { $fh = opendir($this->enableDir); + $this->enabledDirs = array(); while (false !== ($file = readdir($fh))) { if ($file[0] === '.') { @@ -78,12 +91,18 @@ class Manager return $this; } - public function loadModule($name) + public function loadModule($name, $moduleBase = null) { if ($this->hasLoaded($name)) { return $this; } - $module = new Module($this->app, $name, $this->getModuleDir($name)); + + $module = null; + if ($moduleBase === null) { + $module = new Module($this->app, $name, $this->getModuleDir($name)); + } else { + $module = new $moduleBase($this->app, $name, $this->getModuleDir($name)); + } $module->register(); $this->loadedModules[$name] = $module; return $this; @@ -100,6 +119,7 @@ class Manager ); return $this; } + clearstatcache(true); $target = $this->installedBaseDirs[$name]; $link = $this->enableDir . '/' . $name; if (! is_writable($this->enableDir)) { @@ -118,6 +138,7 @@ class Manager throw new SystemPermissionException($error["message"], "symlink", $link); } } + $this->enabledDirs[$name] = $link; return $this; } @@ -151,6 +172,7 @@ class Manager } else { } + unset($this->enabledDirs[$name]); return $this; } @@ -228,12 +250,6 @@ class Manager return $info; } - public function select() - { - $ds = new ArrayDatasource($this->getModuleInfo()); - return $ds->select(); - } - public function listEnabledModules() { return array_keys($this->enabledDirs); @@ -254,19 +270,19 @@ class Manager public function detectInstalledModules() { - // TODO: Allow multiple paths for installed modules (e.g. web vs pkg) - $basedir = realpath(ICINGA_APPDIR . '/../modules'); - $fh = @opendir($basedir); - if ($fh === false) { - return $this; - } - - while ($name = readdir($fh)) { - if ($name[0] === '.') { - continue; + foreach ($this->modulePaths as $basedir) { + $fh = opendir($basedir); + if ($fh === false) { + return $this; } - if (is_dir($basedir . '/' . $name)) { - $this->installedBaseDirs[$name] = $basedir . '/' . $name; + + while ($name = readdir($fh)) { + if ($name[0] === '.') { + continue; + } + if (is_dir($basedir . '/' . $name)) { + $this->installedBaseDirs[$name] = $basedir . '/' . $name; + } } } } From c1e460de17e78086ee6fcc28df307d7812728ac2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Fri, 21 Jun 2013 09:53:37 +0200 Subject: [PATCH 41/46] Remove moved files the 'behaviour' namespace in javascript has been renamed to module refs #4092 --- public/js/icinga/components/actionTable.js | 118 --------------------- public/js/icinga/components/mainDetail.js | 99 ----------------- 2 files changed, 217 deletions(-) delete mode 100644 public/js/icinga/components/actionTable.js delete mode 100755 public/js/icinga/components/mainDetail.js diff --git a/public/js/icinga/components/actionTable.js b/public/js/icinga/components/actionTable.js deleted file mode 100644 index e8e61952b..000000000 --- a/public/js/icinga/components/actionTable.js +++ /dev/null @@ -1,118 +0,0 @@ -/*global Icinga:false, document: false, define:false require:false base_url:false console:false */ - -/** - * ActionTable behaviour as described in - * https://wiki.icinga.org/display/cranberry/Frontend+Components#FrontendComponents-ActionTable - * - * @TODO: Row selection - */ -define(['jquery','logging','icinga/util/async'],function($,log,async) { - "use strict"; - - var ActionTableBehaviour = function() { - var onTableHeaderClick; - - var TABLE_BASE_MATCHER = '.icinga-container table.action'; - var linksInActionTable = TABLE_BASE_MATCHER+" tbody tr > a"; - var actionTableRow = TABLE_BASE_MATCHER+" tbody tr"; - var headerRow = TABLE_BASE_MATCHER+" > th a"; - var searchField = ".icinga-container .actiontable.controls input[type=search]"; - - - onTableHeaderClick = function (ev) { - var target = ev.currentTarget, - href = $(target).attr('href'), - destination; - if ($(target).parents('.layout-main-detail').length) { - if ($(target).parents("#icinga-main").length) { - destination = 'icinga-main'; - } - else { - destination = 'icinga-detail'; - } - - } else { - destination = 'icinga-main'; - } - async.loadToTarget(destination, href); - ev.preventDefault(); - ev.stopImmediatePropagation(); - return false; - }; - - var onLinkTagClick = function(ev) { - - var target = ev.currentTarget, - href = $(target).attr('href'), - destination; - if ($(target).parents('.layout-main-detail').length) { - destination = 'icinga-detail'; - } else { - destination = 'icinga-main'; - } - async.loadToTarget(destination,href); - ev.preventDefault(); - ev.stopImmediatePropagation(); - return false; - - }; - - var onTableRowClick = function(ev) { - ev.stopImmediatePropagation(); - - var target = $(ev.currentTarget), - href = target.attr('href'), - destination; - $('tr.active',target.parent('tbody').first()).removeClass("active"); - target.addClass('active'); - - // When the tr has a href, act like it is a link - if(href) { - ev.currentTarget = target.first(); - return onLinkTagClick(ev); - } - // Try to find a designated row action - var links = $("a.row-action",target); - if(links.length) { - ev.currentTarget = links.first(); - return onLinkTagClick(ev); - } - - // otherwise use the first anchor tag - links = $("a",target); - if(links.length) { - ev.currentTarget = links.first(); - return onLinkTagClick(ev); - } - - log.debug("No target for this table row found"); - return false; - }; - - var onSearchInput = function(ev) { - ev.stopImmediatePropagation(); - var txt = $(this).val(); - }; - - this.eventHandler = {}; - this.eventHandler[linksInActionTable] = { - 'click' : onLinkTagClick - }; - this.eventHandler[actionTableRow] = { - 'click' : onTableRowClick - }; - this.eventHandler[headerRow] = { - 'click' : onTableHeaderClick - }; - this.eventHandler[searchField] = { - 'keyup' : onSearchInput - }; - - this.enable = function() { - - }; - }; - - return new ActionTableBehaviour(); - -}); \ No newline at end of file diff --git a/public/js/icinga/components/mainDetail.js b/public/js/icinga/components/mainDetail.js deleted file mode 100755 index 368c5c5f7..000000000 --- a/public/js/icinga/components/mainDetail.js +++ /dev/null @@ -1,99 +0,0 @@ -/*global Icinga:false, document: false, define:false require:false base_url:false console:false */ - -/** - * Main-Detail layout behaviour as described in - * https://wiki.icinga.org/display/cranberry/Frontend+Components#FrontendComponents-Behaviour - * - */ -define(['jquery','logging','icinga/util/async'],function($,log,async) { - "use strict"; - - var MainDetailBehaviour = function() { - - var onOuterLinkClick = function(ev) { - var a = $(ev.currentTarget), - target = a.attr("target"), - href = a.attr("href"); - ev.stopImmediatePropagation(); - collapseDetailView(); - async.loadToTarget("icinga-main",href); - return false; -}; - -var onLinkTagClick = function(ev) { - - var a = $(ev.currentTarget), - target = a.attr("target"), - href = a.attr("href"); - - // check for protocol:// - if(/^[A-Z]{2,10}\:\/\//i.test(href)) { - window.open(href); - ev.stopImmediatePropagation(); - return false; - } - - // check for link in table header - if(a.parents('th').length > 0) { - ev.stopImmediatePropagation(); - return false; - } - - if(typeof target === "undefined") { - if(a.parents("#icinga-detail").length) { - log.debug("Parent is detail, loading into detail"); - async.loadToTarget("icinga-detail",href); - } else { - log.debug("Parent is not detail, loading into main"); - async.loadToTarget("icinga-main",href); - } - } else { - switch(target) { - case "body": - async.loadToTarget("body", href); - break; - case "main": - async.loadToTarget("icinga-main",href); - collapseDetailView(); - break; - case "detail": - log.debug("Target: detail"); - async.loadToTarget("icinga-detail",href); - break; - case "popup": - log.debug("No target"); - async.loadToTarget(null,href); - break; - default: - return true; - } - } - ev.stopImmediatePropagation(); - return false; - }; - - var expandDetailView = function() { - $("#icinga-detail").parents(".collapsed").removeClass('collapsed'); - }; - - var collapseDetailView = function(elementInDetailView) { - $("#icinga-detail").parents(".layout-main-detail").addClass('collapsed'); - }; - - this.expandDetailView = expandDetailView; - this.collapseDetailView = collapseDetailView; - - this.eventHandler = { - '.layout-main-detail * a' : { - 'click' : onLinkTagClick - }, - 'a' : { - 'click' : onOuterLinkClick - }, - '.layout-main-detail .icinga-container#icinga-detail' : { - 'focus' : expandDetailView - } - }; - }; - return new MainDetailBehaviour(); -}); From fc83dfb4efba99e2e97ae43ba52210f877ceb145 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Fri, 21 Jun 2013 11:36:12 +0200 Subject: [PATCH 42/46] Add javascript autoloading the js/modules/%modulename%/%file% is now mapped to the module path (if existing). To prevent name clashing, the modules folder has been renamed to components. --- public/js/icinga/components/actionTable.js | 118 +++++++++++++++++++++ public/js/icinga/components/mainDetail.js | 99 +++++++++++++++++ public/js/icinga/icinga.js | 15 +-- 3 files changed, 220 insertions(+), 12 deletions(-) create mode 100644 public/js/icinga/components/actionTable.js create mode 100755 public/js/icinga/components/mainDetail.js diff --git a/public/js/icinga/components/actionTable.js b/public/js/icinga/components/actionTable.js new file mode 100644 index 000000000..e8e61952b --- /dev/null +++ b/public/js/icinga/components/actionTable.js @@ -0,0 +1,118 @@ +/*global Icinga:false, document: false, define:false require:false base_url:false console:false */ + +/** + * ActionTable behaviour as described in + * https://wiki.icinga.org/display/cranberry/Frontend+Components#FrontendComponents-ActionTable + * + * @TODO: Row selection + */ +define(['jquery','logging','icinga/util/async'],function($,log,async) { + "use strict"; + + var ActionTableBehaviour = function() { + var onTableHeaderClick; + + var TABLE_BASE_MATCHER = '.icinga-container table.action'; + var linksInActionTable = TABLE_BASE_MATCHER+" tbody tr > a"; + var actionTableRow = TABLE_BASE_MATCHER+" tbody tr"; + var headerRow = TABLE_BASE_MATCHER+" > th a"; + var searchField = ".icinga-container .actiontable.controls input[type=search]"; + + + onTableHeaderClick = function (ev) { + var target = ev.currentTarget, + href = $(target).attr('href'), + destination; + if ($(target).parents('.layout-main-detail').length) { + if ($(target).parents("#icinga-main").length) { + destination = 'icinga-main'; + } + else { + destination = 'icinga-detail'; + } + + } else { + destination = 'icinga-main'; + } + async.loadToTarget(destination, href); + ev.preventDefault(); + ev.stopImmediatePropagation(); + return false; + }; + + var onLinkTagClick = function(ev) { + + var target = ev.currentTarget, + href = $(target).attr('href'), + destination; + if ($(target).parents('.layout-main-detail').length) { + destination = 'icinga-detail'; + } else { + destination = 'icinga-main'; + } + async.loadToTarget(destination,href); + ev.preventDefault(); + ev.stopImmediatePropagation(); + return false; + + }; + + var onTableRowClick = function(ev) { + ev.stopImmediatePropagation(); + + var target = $(ev.currentTarget), + href = target.attr('href'), + destination; + $('tr.active',target.parent('tbody').first()).removeClass("active"); + target.addClass('active'); + + // When the tr has a href, act like it is a link + if(href) { + ev.currentTarget = target.first(); + return onLinkTagClick(ev); + } + // Try to find a designated row action + var links = $("a.row-action",target); + if(links.length) { + ev.currentTarget = links.first(); + return onLinkTagClick(ev); + } + + // otherwise use the first anchor tag + links = $("a",target); + if(links.length) { + ev.currentTarget = links.first(); + return onLinkTagClick(ev); + } + + log.debug("No target for this table row found"); + return false; + }; + + var onSearchInput = function(ev) { + ev.stopImmediatePropagation(); + var txt = $(this).val(); + }; + + this.eventHandler = {}; + this.eventHandler[linksInActionTable] = { + 'click' : onLinkTagClick + }; + this.eventHandler[actionTableRow] = { + 'click' : onTableRowClick + }; + this.eventHandler[headerRow] = { + 'click' : onTableHeaderClick + }; + this.eventHandler[searchField] = { + 'keyup' : onSearchInput + }; + + this.enable = function() { + + }; + }; + + return new ActionTableBehaviour(); + +}); \ No newline at end of file diff --git a/public/js/icinga/components/mainDetail.js b/public/js/icinga/components/mainDetail.js new file mode 100755 index 000000000..368c5c5f7 --- /dev/null +++ b/public/js/icinga/components/mainDetail.js @@ -0,0 +1,99 @@ +/*global Icinga:false, document: false, define:false require:false base_url:false console:false */ + +/** + * Main-Detail layout behaviour as described in + * https://wiki.icinga.org/display/cranberry/Frontend+Components#FrontendComponents-Behaviour + * + */ +define(['jquery','logging','icinga/util/async'],function($,log,async) { + "use strict"; + + var MainDetailBehaviour = function() { + + var onOuterLinkClick = function(ev) { + var a = $(ev.currentTarget), + target = a.attr("target"), + href = a.attr("href"); + ev.stopImmediatePropagation(); + collapseDetailView(); + async.loadToTarget("icinga-main",href); + return false; +}; + +var onLinkTagClick = function(ev) { + + var a = $(ev.currentTarget), + target = a.attr("target"), + href = a.attr("href"); + + // check for protocol:// + if(/^[A-Z]{2,10}\:\/\//i.test(href)) { + window.open(href); + ev.stopImmediatePropagation(); + return false; + } + + // check for link in table header + if(a.parents('th').length > 0) { + ev.stopImmediatePropagation(); + return false; + } + + if(typeof target === "undefined") { + if(a.parents("#icinga-detail").length) { + log.debug("Parent is detail, loading into detail"); + async.loadToTarget("icinga-detail",href); + } else { + log.debug("Parent is not detail, loading into main"); + async.loadToTarget("icinga-main",href); + } + } else { + switch(target) { + case "body": + async.loadToTarget("body", href); + break; + case "main": + async.loadToTarget("icinga-main",href); + collapseDetailView(); + break; + case "detail": + log.debug("Target: detail"); + async.loadToTarget("icinga-detail",href); + break; + case "popup": + log.debug("No target"); + async.loadToTarget(null,href); + break; + default: + return true; + } + } + ev.stopImmediatePropagation(); + return false; + }; + + var expandDetailView = function() { + $("#icinga-detail").parents(".collapsed").removeClass('collapsed'); + }; + + var collapseDetailView = function(elementInDetailView) { + $("#icinga-detail").parents(".layout-main-detail").addClass('collapsed'); + }; + + this.expandDetailView = expandDetailView; + this.collapseDetailView = collapseDetailView; + + this.eventHandler = { + '.layout-main-detail * a' : { + 'click' : onLinkTagClick + }, + 'a' : { + 'click' : onOuterLinkClick + }, + '.layout-main-detail .icinga-container#icinga-detail' : { + 'focus' : expandDetailView + } + }; + }; + return new MainDetailBehaviour(); +}); diff --git a/public/js/icinga/icinga.js b/public/js/icinga/icinga.js index 40fc20dc6..ff59321f6 100755 --- a/public/js/icinga/icinga.js +++ b/public/js/icinga/icinga.js @@ -19,19 +19,16 @@ define([ var failedModules = []; var initialize = function () { - registerLazyModuleLoading(); enableInternalModules(); - + containerMgr.registerAsyncMgr(async); containerMgr.initializeContainers(document); log.debug("Initialization finished"); enableModules(); }; + - var registerLazyModuleLoading = function() { - async.registerHeaderListener("X-Icinga-Enable-Module", loadModuleScript, this); - }; var enableInternalModules = function() { $.each(internalModules,function(idx,module) { @@ -40,7 +37,6 @@ define([ }; var loadModuleScript = function(name) { - console.log("Loading ", name); moduleMgr.enableModule("modules/"+name+"/"+name, function(error) { failedModules.push({ name: name, @@ -71,12 +67,7 @@ define([ loadIntoContainer: function(ctr) { }, - - loadUrl: function(url, target, params) { - target = target || "icinga-main"; - async.loadToTarget(target, url, params); - }, - + getFailedModules: function() { return failedModules; } From 33b4a2ced0b9bd07fe919e87c75866af25e9277f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Fri, 21 Jun 2013 11:40:25 +0200 Subject: [PATCH 43/46] Fix test for new module route The js base route is now js/modules/%modulename%/%file%. This commit reflects these changes in the testcases refs #4092 refs #3735 --- test/js/test/icinga/moduleTest.js | 62 ++----------------------------- 1 file changed, 4 insertions(+), 58 deletions(-) diff --git a/test/js/test/icinga/moduleTest.js b/test/js/test/icinga/moduleTest.js index d525a4d56..494d0264a 100644 --- a/test/js/test/icinga/moduleTest.js +++ b/test/js/test/icinga/moduleTest.js @@ -9,12 +9,12 @@ // {{LICENSE_HEADER}} var should = require("should"); var rjsmock = require("requiremock.js"); -var asyncMock = require("asyncmock.js"); -requireNew("icinga/module.js"); +var BASE = "../../../../public/js/"; +require(BASE+"icinga/module.js"); + var module = rjsmock.getDefine(); GLOBAL.document = $('body'); - /** * Test module that only uses eventhandlers and * no custom logic @@ -195,9 +195,6 @@ describe('The icinga module bootstrap', function() { var testClick = false; rjsmock.registerDependencies({ "icinga/module": module, - "icinga/util/async" : { - registerHeaderListener: function() {} - }, "modules/test/test" : { eventHandler: { "a.test" : { @@ -217,7 +214,7 @@ describe('The icinga module bootstrap', function() { ] }); tearDownTestDOM(); - requireNew("icinga/icinga.js"); + require(BASE+"icinga/icinga.js"); var icinga = rjsmock.getDefine(); $('body').append($("")); $('a.test').click(); @@ -226,55 +223,4 @@ describe('The icinga module bootstrap', function() { should.equal(icinga.getFailedModules()[0].name, "test2"); tearDownTestDOM(); }); - - it("Should load modules lazily when discovering a X-Icinga-Enable-Module header", function() { - rjsmock.purgeDependencies(); - - requireNew("icinga/util/async.js"); - var async = rjsmock.getDefine(); - - rjsmock.registerDependencies({ - "icinga/module": module, - "icinga/util/async": async, - "modules/test/test" : { - eventHandler: { - "a.test" : { - click : function() { - testClick = true; - } - } - } - }, - "icinga/container" : { - registerAsyncMgr: function() {}, - initializeContainers: function() {} - }, - "modules/list" : [ - ] - }); - - tearDownTestDOM(); - - requireNew("icinga/icinga.js"); - var icinga = rjsmock.getDefine(); - - var testClick = false; - // The module shouldn't be loaded - $('body').append($("")); - $('a.test').click(); - should.equal(testClick, false, "Unregistered module was loaded"); - - asyncMock.setNextAsyncResult(async,"result", false, { - "X-Icinga-Enable-Module" : "test" - }); - async.createRequest(); - // The module shouldn't be loaded - $('body').append($("")); - $('a.test').click(); - should.equal(testClick, true, "Module wasn't automatically loaded on header!"); - - - tearDownTestDOM(); - - }); }); From 5e5b301d0d2f8df453328ccbcf8f48432e3ff6b2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Fri, 21 Jun 2013 15:33:06 +0200 Subject: [PATCH 44/46] Add support for lazy module loading When the X-Icinga-Module-Enable header is send, the modulemanager automatically tries to load javascript files for that module. This is realized by adding the 'registerHeaderListener' method to the async manager, which allows to listen to specific headers and firing callbacks if a response with the specified header is retrieved. Also the tests have changed a bit, requireNow should be used when using the requiremock, so a require always loads files new. refs #4092 refs #3753 --- application/controllers/ModulesController.php | 6 +- public/js/icinga/icinga.js | 8 ++- public/js/icinga/util/async.js | 34 ++++++++-- test/js/test/icinga/moduleTest.js | 62 +++++++++++++++++-- 4 files changed, 99 insertions(+), 11 deletions(-) diff --git a/application/controllers/ModulesController.php b/application/controllers/ModulesController.php index f8f40a3b3..afd3b9178 100755 --- a/application/controllers/ModulesController.php +++ b/application/controllers/ModulesController.php @@ -35,7 +35,11 @@ class ModulesController extends ActionController public function enableAction() { $this->manager->enableModule($this->_getParam('name')); - $this->redirectNow('modules/overview?_render=body'); + $this->manager->loadModule($this->_getParam('name')); + $this->getResponse()->setHeader('X-Icinga-Enable-Module', $this->_getParam('name')); + $this->replaceLayout = true; + $this->indexAction(); + } public function disableAction() diff --git a/public/js/icinga/icinga.js b/public/js/icinga/icinga.js index ff59321f6..d538ab552 100755 --- a/public/js/icinga/icinga.js +++ b/public/js/icinga/icinga.js @@ -19,16 +19,19 @@ define([ var failedModules = []; var initialize = function () { + registerLazyModuleLoading(); enableInternalModules(); - + containerMgr.registerAsyncMgr(async); containerMgr.initializeContainers(document); log.debug("Initialization finished"); enableModules(); }; - + var registerLazyModuleLoading = function() { + async.registerHeaderListener("X-Icinga-Enable-Module", loadModuleScript, this); + }; var enableInternalModules = function() { $.each(internalModules,function(idx,module) { @@ -37,6 +40,7 @@ define([ }; var loadModuleScript = function(name) { + console.log("Loading ", name); moduleMgr.enableModule("modules/"+name+"/"+name, function(error) { failedModules.push({ name: name, diff --git a/public/js/icinga/util/async.js b/public/js/icinga/util/async.js index 15a6be7df..1b564b176 100644 --- a/public/js/icinga/util/async.js +++ b/public/js/icinga/util/async.js @@ -3,7 +3,8 @@ "use strict"; var asyncMgrInstance = null; - define(['icinga/container','logging','icinga/behaviour','jquery'],function(containerMgr,log,behaviour,$) { + define(['icinga/container','logging','jquery'],function(containerMgr,log,$) { + var headerListeners = {}; var pending = { @@ -18,12 +19,30 @@ return target; }; - var handleResponse = function(html) { + var applyHeaderListeners = function(headers) { + for (var header in headerListeners) { + if (headers.getResponseHeader(header) === null) { + // see if the browser/server converts headers to lowercase + if (headers.getResponseHeader(header.toLowerCase()) === null) { + continue; + } + header = header.toLowerCase(); + } + var value = headers.getResponseHeader(header); + var listeners = headerListeners[header]; + for (var i=0;i")); $('a.test').click(); @@ -223,4 +226,55 @@ describe('The icinga module bootstrap', function() { should.equal(icinga.getFailedModules()[0].name, "test2"); tearDownTestDOM(); }); + + it("Should load modules lazily when discovering a X-Icinga-Enable-Module header", function() { + rjsmock.purgeDependencies(); + + requireNew("icinga/util/async.js"); + var async = rjsmock.getDefine(); + + rjsmock.registerDependencies({ + "icinga/module": module, + "icinga/util/async": async, + "modules/test/test" : { + eventHandler: { + "a.test" : { + click : function() { + testClick = true; + } + } + } + }, + "icinga/container" : { + registerAsyncMgr: function() {}, + initializeContainers: function() {} + }, + "modules/list" : [ + ] + }); + + tearDownTestDOM(); + + requireNew("icinga/icinga.js"); + var icinga = rjsmock.getDefine(); + + var testClick = false; + // The module shouldn't be loaded + $('body').append($("")); + $('a.test').click(); + should.equal(testClick, false, "Unregistered module was loaded"); + + asyncMock.setNextAsyncResult(async,"result", false, { + "X-Icinga-Enable-Module" : "test" + }); + async.createRequest(); + // The module shouldn't be loaded + $('body').append($("")); + $('a.test').click(); + should.equal(testClick, true, "Module wasn't automatically loaded on header!"); + + + tearDownTestDOM(); + + }); }); From d1f4e9831ab5e6f10ca6982ae5f1ec5530bcab06 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jannis=20Mo=C3=9Fhammer?= Date: Wed, 26 Jun 2013 16:05:01 +0200 Subject: [PATCH 45/46] Fix empty module folder causing errors, fix var naming Fix a wrongly named class causing ClassNotFound issues, also added additional checks for empty module folder and added en moduleFolder directive to configure module location refs #4092 --- config/icinga.ini | 1 + library/Icinga/Application/ApplicationBootstrap.php | 2 +- library/Icinga/Application/Modules/Manager.php | 12 ++++++++++-- public/js/icinga/container.js | 1 - public/js/icinga/icinga.js | 2 -- public/js/main.js | 1 - 6 files changed, 12 insertions(+), 7 deletions(-) diff --git a/config/icinga.ini b/config/icinga.ini index c685d24d6..871e759f8 100755 --- a/config/icinga.ini +++ b/config/icinga.ini @@ -3,6 +3,7 @@ environment = development timezone = "Europe/Berlin" indexModule = monitoring indexController = dashboard +moduleFolder = "/usr/etc/icinga-modules" [logging] ; General log diff --git a/library/Icinga/Application/ApplicationBootstrap.php b/library/Icinga/Application/ApplicationBootstrap.php index 715850ee5..4675a1e4c 100755 --- a/library/Icinga/Application/ApplicationBootstrap.php +++ b/library/Icinga/Application/ApplicationBootstrap.php @@ -100,7 +100,7 @@ abstract class ApplicationBootstrap public function moduleManager() { if ($this->moduleManager === null) { - $this->moduleManager = new ModuleManager($this, "/etc/icinga2/modules_enabled"); + $this->moduleManager = new ModuleManager($this, $this->config->global->moduleFolder); } return $this->moduleManager; } diff --git a/library/Icinga/Application/Modules/Manager.php b/library/Icinga/Application/Modules/Manager.php index f4612de7f..96a6234c8 100644 --- a/library/Icinga/Application/Modules/Manager.php +++ b/library/Icinga/Application/Modules/Manager.php @@ -54,7 +54,7 @@ class Manager public function select() { - $source = new \Icinga\Data\ArrayDataSource($this->getModuleInfo()); + $source = new \Icinga\Data\ArrayDatasource($this->getModuleInfo()); return $source->select(); } @@ -238,7 +238,12 @@ class Manager public function getModuleInfo() { $installed = $this->listInstalledModules(); + $info = array(); + if ($installed === null) { + return $info; + } + foreach ($installed as $name) { $info[] = (object) array( 'name' => $name, @@ -265,7 +270,10 @@ class Manager if ($this->installedBaseDirs === null) { $this->detectInstalledModules(); } - return array_keys($this->installedBaseDirs); + + if ($this->installedBaseDirs !== null) { + return array_keys($this->installedBaseDirs); + } } public function detectInstalledModules() diff --git a/public/js/icinga/container.js b/public/js/icinga/container.js index 8e0891802..4f99ff53e 100755 --- a/public/js/icinga/container.js +++ b/public/js/icinga/container.js @@ -108,6 +108,5 @@ containerMgrInstance = new ContainerMgr($,log,widgets,subTable); } return containerMgrInstance; - }); })(); diff --git a/public/js/icinga/icinga.js b/public/js/icinga/icinga.js index d538ab552..1c28a35f4 100755 --- a/public/js/icinga/icinga.js +++ b/public/js/icinga/icinga.js @@ -80,5 +80,3 @@ define([ }; return new Icinga(); }); - - diff --git a/public/js/main.js b/public/js/main.js index f0fa6ceb9..0836be32c 100755 --- a/public/js/main.js +++ b/public/js/main.js @@ -24,4 +24,3 @@ define(['jquery','Holder'], function ($) { window.Icinga = Icinga; }); }); - From 72bb02d39004299364a57fc0cd9cf36dacea8a3e Mon Sep 17 00:00:00 2001 From: Marius Hein Date: Wed, 26 Jun 2013 16:48:07 +0200 Subject: [PATCH 46/46] Module administration Rebase fix ldap auth for testing issue. refs #4092 --- .../Authentication/Backend/LdapUserBackend.php | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/library/Icinga/Authentication/Backend/LdapUserBackend.php b/library/Icinga/Authentication/Backend/LdapUserBackend.php index d51a784b6..afaf13ec5 100644 --- a/library/Icinga/Authentication/Backend/LdapUserBackend.php +++ b/library/Icinga/Authentication/Backend/LdapUserBackend.php @@ -8,6 +8,7 @@ use Icinga\Authentication\User as User; use Icinga\Authentication\UserBackend; use Icinga\Authentication\Credentials; use Icinga\Protocol\Ldap; +use Icinga\Application\Config; class LdapUserBackend implements UserBackend { @@ -33,8 +34,16 @@ class LdapUserBackend implements UserBackend protected function selectUsername($username) { return $this->connection->select() - ->from('user', array('sAMAccountName')) - ->where('sAMAccountName', $this->stripAsterisks($username)); + ->from( + Config::getInstance()->authentication->users->user_class, + array( + Config::getInstance()->authentication->users->user_name_attribute + ) + ) + ->where( + Config::getInstance()->authentication->users->user_name_attribute, + $this->stripAsterisks($username) + ); } public function authenticate(Credentials $credentials) @@ -42,7 +51,8 @@ class LdapUserBackend implements UserBackend if (!$this->connection->testCredentials( $this->connection->fetchDN($this->selectUsername($credentials->getUsername())), $credentials->getPassword() - ) ) { + ) + ) { return false; } $user = new User($credentials->getUsername());