Merge branch 'feature/install-wizard-6136'

refs #6136
This commit is contained in:
Johannes Meyer 2014-05-14 12:54:44 +02:00
commit 88d4262e7c
9 changed files with 802 additions and 18 deletions

View File

@ -0,0 +1,111 @@
<?php
// @codeCoverageIgnoreStart
// {{{ICINGA_LICENSE_HEADER}}}
// {{{ICINGA_LICENSE_HEADER}}}
use Icinga\Web\Session;
use Icinga\Web\Wizard\Wizard;
use Icinga\Web\Controller\ActionController;
class InstallController extends ActionController
{
/**
* Whether the controller requires the user to be authenticated
*
* The install wizard has its own authentication mechanism.
*
* @var bool
*/
protected $requiresAuthentication = false;
/**
* Whether the controller requires configuration
*
* The install wizard does not require any configuration.
*
* @var bool
*/
protected $requiresConfiguration = false;
/**
* Show the wizard and run the installation once its finished
*/
public function indexAction()
{
$wizard = $this->createWizard();
if ($wizard->isSubmittedAndValid()) {
$wizard->navigate();
if ($wizard->isFinished()) {
// TODO: Run the installer (Who creates an installer? How do we handle module installers?)
$this->dropConfiguration(); // TODO: Should only be done if the installation has been successfully completed
$this->view->installer = '';
} else {
$this->storeConfiguration($wizard->getConfig());
}
}
$this->view->wizard = $wizard;
}
/**
* Create the wizard and register all pages
*
* @return Wizard
*/
protected function createWizard()
{
$wizard = new Wizard();
$wizard->setTitle('Web');
$wizard->setRequest($this->getRequest());
$wizard->setConfiguration($this->loadConfiguration());
$wizard->addPages(
array(
// t('Welcome') => 'Icinga\Form\Install\WelcomePage',
// t('Requirements') => 'Icinga\Form\Install\RequirementsPage',
// t('Authentication') => 'Icinga\Form\Install\AuthenticationPage',
// t('Administration') => 'Icinga\Form\Install\AdministrationPage',
// t('Preferences') => 'Icinga\Form\Install\PreferencesPage',
t('Logging') => 'Icinga\Form\Install\LoggingPage',
// t('Database Setup') => 'Icinga\Form\Install\DatabasePage',
// t('Summary') => 'Icinga\Form\Install\SummaryPage'
)
);
return $wizard;
}
/**
* Store the given configuration values
*
* @param Zend_Config $config The configuration
*/
protected function storeConfiguration(Zend_Config $config)
{
$session = Session::getSession();
$session->getNamespace('WebWizard')->setAll($config->toArray(), true);
$session->write();
}
/**
* Load all configuration values
*
* @return Zend_Config
*/
protected function loadConfiguration()
{
return new Zend_Config(Session::getSession()->getNamespace('WebWizard')->getAll(), true);
}
/**
* Clear all stored configuration values
*/
protected function dropConfiguration()
{
$session = Session::getSession();
$session->removeNamespace('WebWizard');
$session->write();
}
}
// @codeCoverageIgnoreEnd

View File

@ -0,0 +1,40 @@
<div class="wizard">
<div class="header">
<img src="<?= $this->baseUrl('img/logo_icinga-inv.png'); ?>">
<h1><?= $wizard->getTitle(); ?></h1>
</div>
<div class="sidebar">
<ul>
<?php foreach ($wizard->getPages() as $page): ?>
<li class="<?= $wizard->isCompletedPage($page) ? 'complete' : (
$wizard->isCurrentPage($page) ? 'active' : 'pending'
); ?>">
<?= $page->getTitle(); ?>
<?php if ($wizard->isWizard($page) && $wizard->isCurrentPage($page) && !$wizard->isCompletedPage($page)): ?>
<ul>
<?php foreach ($page->getPages() as $subPage): ?>
<?php if ($page->isCurrentPage($subPage)): ?>
<li class="child active">
<?php else: ?>
<li class="child">
<?php endif ?>
<?= $subPage->getTitle(); ?>
</li>
<?php endforeach ?>
</ul>
<?php endif ?>
</li>
<?php endforeach ?>
<li class="install<?= $wizard->isFinished() ? ' active' : ''; ?>">
<?= $this->translate('Installation'); ?>
</li>
</ul>
</div>
<div class="panel">
<?php if ($wizard->isFinished()): ?>
<?= $this->partial('install/index/installog.phtml', array('installer' => $installer)); ?>
<?php else: ?>
<?= $wizard; ?>
<?php endif ?>
</div>
</div>

View File

@ -0,0 +1 @@
<?= $installer; ?>

View File

@ -46,6 +46,7 @@ use Icinga\File\Pdf;
use Icinga\Exception\ProgrammingError;
use Icinga\Web\Session;
use Icinga\Session\SessionNamespace;
use Icinga\Exception\NotReadableError;
/**
* Base class for all core action controllers
@ -61,6 +62,13 @@ class ActionController extends Zend_Controller_Action
*/
protected $requiresAuthentication = true;
/**
* Whether the controller requires configuration
*
* @var bool
*/
protected $requiresConfiguration = true;
private $config;
private $configs = array();
@ -114,26 +122,24 @@ class ActionController extends Zend_Controller_Action
$this->_helper = new Zend_Controller_Action_HelperBroker($this);
$this->_helper->addPath('../application/controllers/helpers');
// when noInit is set (e.g. for testing), authentication and init is skipped
if (isset($invokeArgs['noInit'])) {
// TODO: Find out whether this still makes sense?
return;
}
if ($this->_request->isXmlHttpRequest()) {
$this->windowId = $this->_request->getHeader('X-Icinga-WindowId', null);
}
if ($this->requiresLogin() === false) {
$this->view->tabs = new Tabs();
$this->init();
} else {
$url = $this->getRequestUrl();
if ($url === 'default/index/index') {
// TODO: We need our own router :p
$url = 'dashboard';
if ($this->requiresConfig() === false) {
if ($this->requiresLogin() === false) {
$this->view->tabs = new Tabs();
$this->init();
} else {
$url = $this->getRequestUrl();
if ($url === 'default/index/index') {
// TODO: We need our own router :p
$url = 'dashboard';
}
$this->redirectToLogin($url);
}
$this->redirectToLogin($url);
} else {
$this->redirectNow(Url::fromPath('install'));
}
}
@ -224,11 +230,39 @@ class ActionController extends Zend_Controller_Action
}
}
/**
* Check whether the controller requires configuration. That is when no configuration
* is available and when it is possible to setup the configuration
*
* @return bool
*
* @see requiresConfiguration
*/
protected function requiresConfig()
{
if (!$this->requiresConfiguration) {
return false;
}
if (file_exists(Config::$configDir . '/setup.token')) {
try {
$config = Config::app()->toArray();
} catch (NotReadableError $e) {
return true;
}
return empty($config);
} else {
return false;
}
}
/**
* Check whether the controller requires a login. That is when the controller requires authentication and the
* user is currently not authenticated
*
* @return bool
*
* @see requiresAuthentication
*/
protected function requiresLogin()

View File

@ -127,6 +127,15 @@ class Form extends Zend_Form
*/
protected $last_note_id = 0;
/**
* Whether buttons are shown or not
*
* This is just a q&d solution and MUST NOT survive any refactoring!
*
* @var bool
*/
protected $buttonsHidden = false;
/**
* Getter for the session ID
*
@ -279,11 +288,11 @@ class Form extends Zend_Form
$this->initCsrfToken();
$this->create();
if ($this->submitLabel) {
if (!$this->buttonsHidden && $this->submitLabel) {
$this->addSubmitButton();
}
if ($this->cancelLabel) {
if (!$this->buttonsHidden && $this->cancelLabel) {
$this->addCancelButton();
}
@ -590,10 +599,24 @@ class Form extends Zend_Form
$decorators = $this->getDecorators();
if (empty($decorators)) {
$this->addDecorator('FormElements')
//->addDecorator('HtmlTag', array('tag' => 'dl', 'class' => 'zend_form'))
->addDecorator('HtmlTag', array('tag' => 'div')) // Quickfix to get subForms to work
->addDecorator('Form');
}
return $this;
}
public function hideButtons()
{
$this->buttonsHidden = true;
}
/**
* q&d solution to be able to recreate a form
*/
public function reset()
{
$this->created = false;
$this->clearElements();
}
}

View File

@ -22,6 +22,7 @@ class StyleSheet
'css/icinga/monitoring-colors.less',
'css/icinga/selection-toolbar.less',
'css/icinga/login.less',
'css/icinga/install.less',
);
public static function compileForPdf()

View File

@ -0,0 +1,93 @@
<?php
// {{{ICINGA_LICENSE_HEADER}}}
// {{{ICINGA_LICENSE_HEADER}}}
namespace Icinga\Web\Wizard;
use Icinga\Web\Form;
class Page extends Form
{
/**
* Whether a CSRF token should not be added to this wizard page
*
* @var bool
*/
protected $tokenDisabled = true;
/**
* The wizard this page is part of
*
* @var Wizard
*/
protected $wizard;
/**
* The title of this wizard page
*
* @var string
*/
protected $title = '';
/**
* Create a new wizard page
*
* @param Wizard $wizard The wizard this page is part of
* @param mixed $options Zend_Form options
*/
public function __construct(Wizard $wizard = null, $options = null)
{
parent::__construct($options);
$this->wizard = $wizard;
}
/**
* Overwrite this to initialize this wizard page
*/
public function init()
{
}
/**
* Return whether this page needs to be shown to the user
*
* Overwrite this to add page specific handling
*
* @return bool
*/
public function isRequired()
{
return true;
}
/**
* Set the title for this wizard page
*
* @param string $title The title to set
*/
public function setTitle($title)
{
$this->title = $title;
}
/**
* Return the title of this wizard page
*
* @return string
*/
public function getTitle()
{
return $this->title;
}
/**
* Return a config containing all values provided by the user
*
* @return Zend_Config
*/
public function getConfig()
{
return $this->getConfiguration();
}
}

View File

@ -0,0 +1,385 @@
<?php
// {{{ICINGA_LICENSE_HEADER}}}
// {{{ICINGA_LICENSE_HEADER}}}
namespace Icinga\Web\Wizard;
use Zend_Config;
use Icinga\Web\Form;
use Icinga\Exception\ProgrammingError;
/**
* Multistep form with support for nesting and dynamic behaviour
*
* @todo Pages that were displayed initially and filled out by the user remain
* currently in the configuration returned by Wizard::getConfig()
*/
class Wizard extends Page
{
/**
* Whether this wizard has been completed
*
* @var bool
*/
protected $finished = false;
/**
* The wizard pages
*
* @var array
*/
protected $pages = array();
/**
* Return the wizard pages
*
* @return array
*/
public function getPages()
{
return array_filter($this->pages, function ($page) { return $page->isRequired(); });
}
/**
* Return a page by its name or null if it's not found
*
* @param string $pageName The name of the page
*
* @return Page|null
*/
public function getPage($pageName)
{
$candidates = array_filter(
$this->pages, // Cannot use getPages() here because I might get called as part of Page::isRequired()
function ($page) use ($pageName) { return $page->getName() === $pageName; }
);
if (!empty($candidates)) {
return array_shift($candidates);
} elseif ($this->wizard !== null) {
return $this->wizard->getPage($pageName);
}
}
/**
* Add a new page to this wizard
*
* @param Page $page The page to add
*/
public function addPage(Page $page)
{
if (!($pageName = $page->getName())) {
throw new ProgrammingError('Wizard page "' . get_class($page) . '" has no unique name');
}
$wizardConfig = $this->getConfig();
if ($wizardConfig->get($pageName) === null) {
$wizardConfig->{$pageName} = new Zend_Config(array(), true);
}
$page->setConfiguration($wizardConfig->{$pageName});
$page->setRequest($this->getRequest());
$page->setTokenDisabled(); // Usually default for pages, but not for wizards
$this->pages[] = $page;
}
/**
* Add multiple pages to this wizard
*
* The given array's keys are titles and its values are class names to add
* as wizard pages. An array as value causes a sub-wizard being added.
*
* @param array $pages The pages to add to the wizard
*/
public function addPages(array $pages)
{
foreach ($pages as $title => $pageClassOrArray) {
if (is_array($pageClassOrArray)) {
$wizard = new static($this);
$wizard->setTitle($title);
$this->addPage($wizard);
$wizard->addPages($pageClassOrArray);
} else {
$page = new $pageClassOrArray($this);
$page->setTitle($title);
$this->addPage($page);
}
}
}
/**
* Return this wizard's progress
*
* @param int $default The step to return in case this wizard has no progress information yet
*
* @return int The current step
*/
public function getProgress($default = 0)
{
return $this->getConfig()->get('progress', $default);
}
/**
* Set this wizard's progress
*
* @param int $step The current step
*/
public function setProgress($step)
{
$config = $this->getConfig();
$config->progress = $step;
}
/**
* Return the current page
*
* @return Page
*
* @throws ProgrammingError In case there are not any pages registered
*/
public function getCurrentPage()
{
$pages = $this->getPages();
if (empty($pages)) {
throw new ProgrammingError('This wizard has no pages');
}
return $pages[$this->getProgress()];
}
/**
* Return whether the given page is the current page
*
* @param Page $page The page to check
*
* @return bool
*/
public function isCurrentPage(Page $page)
{
return $this->getCurrentPage() === $page;
}
/**
* Return whether the given page is the first page in the wizard
*
* @param Page $page The page to check
*
* @return bool
*
* @throws ProgrammingError In case there are not any pages registered
*/
public function isFirstPage(Page $page)
{
$pages = $this->getPages();
if (empty($pages)) {
throw new ProgrammingError('This wizard has no pages');
}
return $pages[0] === $page;
}
/**
* Return whether the given page has been completed
*
* @param Page $page The page to check
*
* @return bool
*
* @throws ProgrammingError In case there are not any pages registered
*/
public function isCompletedPage(Page $page)
{
$pages = $this->getPages();
if (empty($pages)) {
throw new ProgrammingError('This wizard has no pages');
}
return $this->isFinished() || array_search($page, $pages, true) < $this->getProgress();
}
/**
* Return whether the given page is the last page in the wizard
*
* @param Page $page The page to check
*
* @return bool
*
* @throws ProgrammingError In case there are not any pages registered
*/
public function isLastPage(Page $page)
{
$pages = $this->getPages();
if (empty($pages)) {
throw new ProgrammingError('This wizard has no pages');
}
return $pages[count($pages) - 1] === $page;
}
/**
* Return whether this wizard has been completed
*
* @return bool
*/
public function isFinished()
{
return $this->finished && $this->isLastPage($this->getCurrentPage());
}
/**
* Return whether the given page is a wizard
*
* @param Page $page The page to check
*
* @return bool
*/
public function isWizard(Page $page)
{
return $page instanceof self;
}
/**
* Return whether either the back- or next-button was clicked
*
* @see Form::isSubmitted()
*/
public function isSubmitted()
{
$checkData = $this->getRequest()->getParams();
return isset($checkData['btn_return']) || isset($checkData['btn_advance']);
}
/**
* Update the wizard's progress
*
* @param bool $lastStepIsLast Whether the last step of this wizard is actually the very last one
*/
public function navigate($lastStepIsLast = true)
{
$currentPage = $this->getCurrentPage();
if (($pageName = $this->getRequest()->getParam('btn_advance'))) {
if (!$this->isWizard($currentPage) || $currentPage->navigate(false) || $currentPage->isFinished()) {
if ($this->isLastPage($currentPage) && (!$lastStepIsLast || $pageName === 'install')) {
$this->finished = true;
} else {
$pages = $this->getPages();
$newStep = $this->getProgress() + 1;
if (isset($pages[$newStep]) && $pages[$newStep]->getName() === $pageName) {
$this->setProgress($newStep);
$this->reset();
}
}
}
} elseif (($pageName = $this->getRequest()->getParam('btn_return'))) {
if ($this->isWizard($currentPage) && $currentPage->getProgress() > 0) {
$currentPage->navigate(false);
} elseif (!$this->isFirstPage($currentPage)) {
$pages = $this->getPages();
$newStep = $this->getProgress() - 1;
if ($pages[$newStep]->getName() === $pageName) {
$this->setProgress($newStep);
$this->reset();
}
}
}
$config = $this->getConfig();
$config->{$currentPage->getName()} = $currentPage->getConfig();
}
/**
* Setup the current wizard page
*/
protected function create()
{
$currentPage = $this->getCurrentPage();
if ($this->isWizard($currentPage)) {
$this->createWizard($currentPage);
} else {
$this->createPage($currentPage);
}
}
/**
* Display the given page as this wizard's current page
*
* @param Page $page The page
*/
protected function createPage(Page $page)
{
$pages = $this->getPages();
$currentStep = $this->getProgress();
$page->buildForm(); // Needs to get called manually as it's nothing that Zend knows about
$this->addSubForm($page, $page->getName());
if (!$this->isFirstPage($page)) {
$this->addElement(
'button',
'btn_return',
array(
'type' => 'submit',
'label' => t('Previous'),
'value' => $pages[$currentStep - 1]->getName()
)
);
}
$this->addElement(
'button',
'btn_advance',
array(
'type' => 'submit',
'label' => $this->isLastPage($page) ? t('Install') : t('Next'),
'value' => $this->isLastPage($page) ? 'install' : $pages[$currentStep + 1]->getName()
)
);
}
/**
* Display the current page of the given wizard as this wizard's current page
*
* @param Wizard $wizard The wizard
*/
protected function createWizard(Wizard $wizard)
{
$isFirstPage = $this->isFirstPage($wizard);
$isLastPage = $this->isLastPage($wizard);
$currentSubPage = $wizard->getCurrentPage();
$isFirstSubPage = $wizard->isFirstPage($currentSubPage);
$isLastSubPage = $wizard->isLastPage($currentSubPage);
$currentSubPage->buildForm(); // Needs to get called manually as it's nothing that Zend knows about
$this->addSubForm($currentSubPage, $currentSubPage->getName());
if (!$isFirstPage || !$isFirstSubPage) {
$pages = $isFirstSubPage ? $this->getPages() : $wizard->getPages();
$currentStep = $isFirstSubPage ? $this->getProgress() : $wizard->getProgress();
$this->addElement(
'button',
'btn_return',
array(
'type' => 'submit',
'label' => t('Previous'),
'value' => $pages[$currentStep - 1]->getName()
)
);
}
$pages = $isLastSubPage ? $this->getPages() : $wizard->getPages();
$currentStep = $isLastSubPage ? $this->getProgress() : $wizard->getProgress();
$this->addElement(
'button',
'btn_advance',
array(
'type' => 'submit',
'label' => $isLastPage && $isLastSubPage ? t('Install') : t('Next'),
'value' => $isLastPage && $isLastSubPage ? 'install' : $pages[$currentStep + 1]->getName()
)
);
}
}

View File

@ -0,0 +1,96 @@
div.wizard {
div.header {
padding: 0.6em 0 0 1em;
height: 3em;
position: fixed;
top: 0;
left: 0;
right: 0;
color: #eee;
background-color: #555;
background-image: linear-gradient(top, #777, #555);
background-image: -o-linear-gradient(top, #777, #555);
background-image: -ms-linear-gradient(top, #777, #555);
background-image: -webkit-linear-gradient(top, #777, #555);
h1 {
margin: 0 3.5em;
display: inline-block;
font-size: 2em;
}
}
div.sidebar {
width: 13em;
position: fixed;
top: 3.6em;
left: 0;
bottom: 0;
background-color: #999;
box-shadow: inset -0.5em 0 0.5em -0.5em #555;
-moz-box-shadow: inset -0.5em 0 0.5em -0.5em #555;
-webkit-box-shadow: inset -0.5em 0 0.5em -0.5em #555;
& > ul {
margin: 0;
padding: 0;
list-style: none;
& > li {
color: #f5f5f5;
font-size: 1.1em;
padding: 0.5em;
margin-left: 0.5em;
text-shadow: #555 -1px 1px 0px;
border-bottom: 1px solid #888;
&.active {
color: black;
margin-left: 0;
padding-left: 1em;
text-shadow: none;
background-color: white;
}
&.complete {
color: green;
}
&.pending {
color: red;
}
&.install {
border-bottom: 0;
}
ul {
margin: 0;
padding: 0;
list-style: none;
li.child {
font-size: 0.9em;
padding: 0.4em 0.8em 0;
&.active {
font-weight: bold;
}
}
}
}
}
}
div.panel {
padding: 1em;
position: fixed;
top: 3.6em;
left: 13em;
right: 0;
bottom: 0;
}
}