<?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()
            )
        );
    }
}