* @license http://www.gnu.org/licenses/gpl-2.0.txt GPL, version 2 * @author Icinga Development Team */ // {{{ICINGA_LICENSE_HEADER}}} namespace Icinga\Application; use Icinga\Authentication\Manager as AuthenticationManager; use Icinga\Exception\ConfigurationError; use Icinga\User\Preferences; use Icinga\User; use Icinga\Web\Request; use Zend_Controller_Front; use Zend_Layout; use Zend_Paginator; use Zend_View_Helper_PaginationControl; use Zend_Controller_Action_HelperBroker; use Zend_Controller_Router_Route; use Zend_Controller_Action_Helper_ViewRenderer; use Icinga\Web\View; use Icinga\User\Preferences\StoreFactory; use Icinga\User\Preferences\SessionStore; /** * Use this if you want to make use of Icinga funtionality in other web projects * * Usage example: * * use Icinga\Application\EmbeddedWeb; * EmbeddedWeb::start(); * */ class Web extends ApplicationBootstrap { /** * View object * * @var View */ private $viewRenderer; /** * Zend front controller instance * * @var Zend_Controller_Front */ private $frontController; /** * Request object * * @var Request */ private $request; /** * Identify web bootstrap * * @var bool */ protected $isWeb = true; /** * Initialize all together * * @return self */ protected function bootstrap() { return $this->setupConfig() ->setupErrorHandling() ->setupTimezone() ->setupRequest() ->setupZendMvc() ->setupTranslation() ->setupModules() ->setupRoute() ->setupPagination(); } /** * Prepare routing * * @return self */ private function setupRoute() { // TODO: Find a better solution $this->frontController->getRouter()->addRoute( 'module_overview', new Zend_Controller_Router_Route( 'js/modules/list.js', array( 'controller' => 'static', 'action' => 'modulelist', ) ) ); $this->frontController->getRouter()->addRoute( 'module_javascript', new Zend_Controller_Router_Route( 'js/modules/:module_name/:file', array( 'controller' => 'static', 'action' => 'javascript' ) ) ); return $this; } /** * Getter for frontController * * @return Zend_Controller_Front */ public function getFrontController() { return $this->frontController; } /** * Getter for view * * @return View */ public function getViewRenderer() { return $this->viewRenderer; } /** * Load translations * * @return self */ private function setupTranslation() { // AuthManager::getInstance()->getSession()->language; $locale = null; if (!$locale) { $locale = 'en_US'; } putenv('LC_ALL=' . $locale . '.UTF-8'); setlocale(LC_ALL, $locale . '.UTF-8'); bindtextdomain('icinga', $this->getApplicationDir() . '/locale'); textdomain('icinga'); return $this; } /** * Dispatch public interface */ public function dispatch() { $this->frontController->dispatch(); } /** * Prepare Zend MVC Base * * @return self */ private function setupZendMvc() { // TODO: Replace Zend_Application: Zend_Layout::startMvc( array( 'layout' => 'layout', 'layoutPath' => $this->getApplicationDir('/layouts/scripts') ) ); $this->setupFrontController(); $this->setupViewRenderer(); return $this; } /** * Create user object and inject preference interface * * @throws ConfigurationError * @return User */ private function setupUser() { $authenticationManager = AuthenticationManager::getInstance( null, array( 'writeSession' => true ) ); if ($authenticationManager->isAuthenticated() === true) { if ($this->getConfig()->preferences === null) { throw new ConfigurationError('Preferences not configured in config.ini'); } $user = $authenticationManager->getUser(); $this->getConfig()->preferences->configPath = $this->getConfigDir('preferences'); $preferenceStore = StoreFactory::create( $this->getConfig()->preferences, $user ); // Needed to update values in user session $sessionStore = new SessionStore($authenticationManager->getSession()); // Performance: Do not ask provider if we've preferences // stored in session $initialPreferences = array(); if (count($sessionStore->load())) { $initialPreferences = $sessionStore->load(); } else { $initialPreferences = $preferenceStore->load(); $sessionStore->writeAll($initialPreferences); } $preferences = new Preferences($initialPreferences); $preferences->attach($sessionStore); $preferences->attach($preferenceStore); $user->setPreferences($preferences); return $user; } } /** * Inject dependencies into request * * @return self */ private function setupRequest() { $this->request = new Request(); $user = $this->setupUser(); if ($user instanceof User) { $this->request->setUser($user); } return $this; } /** * Instantiate front controller * * @return self */ private function setupFrontController() { $this->frontController = Zend_Controller_Front::getInstance(); $this->frontController->setRequest($this->request); $this->frontController->setControllerDirectory($this->getApplicationDir('/controllers')); $this->frontController->setParams( array( 'displayExceptions' => true ) ); return $this; } /** * Register helper paths and views for renderer * * @return self */ private function setupViewRenderer() { /** @var \Zend_Controller_Action_Helper_ViewRenderer $view */ $view = Zend_Controller_Action_HelperBroker::getStaticHelper('viewRenderer'); $view->setView(new View()); $view->view->addHelperPath($this->getApplicationDir('/views/helpers')); // TODO: find out how to avoid this additional helper path: $view->view->addHelperPath($this->getApplicationDir('/views/helpers/layout')); $view->view->setEncoding('UTF-8'); $view->view->headTitle()->prepend( $this->getConfig()->{'global'}->get('project', 'Icinga') ); $view->view->headTitle()->setSeparator(' :: '); $view->view->navigation = $this->getConfig()->app('menu'); $this->viewRenderer = $view; return $this; } /** * Configure pagination settings * @return self */ private function setupPagination() { Zend_Paginator::addScrollingStylePrefixPath( 'Icinga_Web_Paginator_ScrollingStyle', 'Icinga/Web/Paginator/ScrollingStyle' ); Zend_Paginator::setDefaultScrollingStyle('SlidingWithBorder'); Zend_View_Helper_PaginationControl::setDefaultViewPartial( array('mixedPagination.phtml', 'default') ); return $this; } }