[platal.git] / classes / plwizard.php

<?php
/***************************************************************************
 *  Copyright (C) 2003-2011 Polytechnique.org                              *
 *  http://opensource.polytechnique.org/                                   *
 *                                                                         *
 *  This program is free software; you can redistribute it and/or modify   *
 *  it under the terms of the GNU General Public License as published by   *
 *  the Free Software Foundation; either version 2 of the License, or      *
 *  (at your option) any later version.                                    *
 *                                                                         *
 *  This program is distributed in the hope that it will be useful,        *
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of         *
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
 *  GNU General Public License for more details.                           *
 *                                                                         *
 *  You should have received a copy of the GNU General Public License      *
 *  along with this program; if not, write to the Free Software            *
 *  Foundation, Inc.,                                                      *
 *  59 Temple Place, Suite 330, Boston, MA  02111-1307  USA                *
 **************************************************************************/

/** A Wizard Page is a page of a wizard. It is a self-contained step which
 * handles both the creation and initialisation of the step (by using the
 * Wizard global state, if needed) and the processing of the action the
 * user made on it.
 */
interface PlWizardPage
{
    /** Build a new instance of the class
     * associated with the given wizard master.
     */
    public function __construct(PlWizard $wiz);

    /** Return the name of the templace describing the page.
     */
    public function template();

    /** Prepare the page by assigning to it any useful value.
     */
    public function prepare(PlPage $page, $id);

    /** Process information resulting of the application of the page.
     * This function must return a clue indicating the next page to show.
     * This clue can be either a page id, a page number or a navigation
     * id (PlWizard::FIRST_PAGE, PlWizard::NEXT_PAGE, PlWizard::CURRENT_PAGE
     *  PlWizard::PREVIOUS_PAGE, PlWizard::LAST_PAGE).
     */
    public function process(&$success);

    /** Displays the success message.
     */
    public function success();
}

/** A PlWizard is a set of pages through which the user can navigate,
 * his action on a page determining which the next one will be.
 *
 * A Wizard can either a stateless wizard (which is only a set of
 * independent pages through which the user can easily navigate) or
 * stateful (a suite of steps where each step gives clue for the next
 * one).
 */
class PlWizard
{
    const FIRST_PAGE    = 'bt_first';
    const NEXT_PAGE     = 'bt_next';
    const CURRENT_PAGE  = 'bt_current';
    const PREVIOUS_PAGE = 'bt_previous';
    const LAST_PAGE     = 'bt_last';

    private $userdata = array();

    protected $name;
    protected $layout;
    protected $stateless;
    protected $ajax;
    protected $ajax_animated;

    protected $pages;
    protected $titles;
    protected $lookup;
    protected $inv_lookup;

    public function __construct($name, $layout, $stateless = false, $ajax = true, $ajax_animated = true)
    {
        $this->name      = 'wiz_' . $name;
        $this->layout    = $layout;
        $this->stateless = $stateless;
        $this->pages  = array();
        $this->lookup = array();
        $this->titles = array();
        $this->ajax   = $ajax;
        $this->ajax_animated = $ajax_animated;
        if (!isset($_SESSION[$this->name])) {
            $_SESSION[$this->name] = array();
            $_SESSION[$this->name . '_page']  = null;
            $_SESSION[$this->name . '_stack'] = array();
        }
    }

    public function addPage($class, $title, $id = null)
    {
        if ($id == null) {
            $id = count($this->pages);
        }
        $this->lookup[$id]  = count($this->pages);
        $this->inv_lookup[] = $id;
        $this->pages[]      = $class;
        $this->titles[]     = $title;
    }

    public function addUserData($name, $value)
    {
        $this->userdata[$name] = $value;
    }

    public function getUserData($name, $default = null)
    {
        return $this->userdata[$name];
    }

    public function set($varname, $value)
    {
        $_SESSION[$this->name][$varname] = $value;
    }

    public function get($varname, $default = null)
    {
        return isset($_SESSION[$this->name][$varname]) ?
                    $_SESSION[$this->name][$varname] : $default;
    }

    public function v($varname, $default = "")
    {
        return $this->get($varname, $default);
    }

    public function i($varname, $default = 0)
    {
        return (int)$this->get($varname, $default);
    }

    public function clear($varname = null)
    {
        if (is_null($varname)) {
            $_SESSION[$this->name] = array();
        } else {
            unset($_SESSION[$this->name][$varname]);
        }
        $_SESSION[$this->name . '_page'] = null;
    }

    private function getPage($id)
    {
        $page = $this->pages[$id];
        return new $page($this);
    }

    public function apply(PlPage $smarty, $baseurl, $pgid = null, $mode = 'normal')
    {
        if ($this->stateless && (isset($this->lookup[$pgid]) || isset($this->pages[$pgid]))) {
            $curpage = is_numeric($pgid) ? $pgid : $this->lookup[$pgid];
        } else if ($this->stateless && is_null($pgid)) {
            $curpage = 0;
        } else {
            $curpage = $_SESSION[$this->name . '_page'];
        }
        $oldpage = $curpage;

        // Process the previous page
        if (Post::has('valid_page')) {
            S::assert_xsrf_token();

            $page = $this->getPage(Post::i('valid_page'));
            $curpage = Post::i('valid_page');
            $success = false;
            $next = $page->process($success);
            $last = $curpage;
            switch ($next) {
              case PlWizard::FIRST_PAGE:
                $curpage = 0;
                break;
              case PlWizard::PREVIOUS_PAGE:
                if (!$this->stateless && count($_SESSION[$this->name . '_stack'])) {
                    $curpage = array_pop($_SESSION[$this->name . '_stack']);
                } elseif ($curpage && $this->stateless) {
                    $curpage--;
                } else {
                    $curpage = 0;
                }
                break;
              case PlWizard::NEXT_PAGE:
                if ($curpage < count($this->pages) - 1) {
                    $curpage++;
                }
                break;
              case PlWizard::LAST_PAGE:
                $curpage = count($this->pages) - 1;
                break;
              case PlWizard::CURRENT_PAGE: break; // don't change the page
              default:
                $curpage = is_numeric($next) ? $next : $this->lookup[$next];
                break;
            }
            if (!$this->stateless) {
                array_push($_SESSION[$this->name . '_stack'], $last);
            }
        }
        if (is_null($curpage)) {
            $curpage = 0;
        }

        // Prepare the page
        $_SESSION[$this->name . '_page'] = $curpage;
        if ($curpage != $oldpage) {
            if (isset($success) && $success) {
                pl_redirect($baseurl . '/' . $this->inv_lookup[$curpage] . '/null/' . $success);
            } else {
                pl_redirect($baseurl . '/' . $this->inv_lookup[$curpage]);
            }
        } else if (!isset($page)) {
            $page = $this->getPage($curpage);
        }
        if ($mode == 'ajax') {
            pl_content_headers("text/html");
            $smarty->changeTpl($this->layout, NO_SKIN);
            $smarty->assign('wiz_run_ajax', true);
        } else {
            $smarty->changeTpl($this->layout);
        }
        $smarty->assign('pages', $this->titles);
        $smarty->assign('current', $curpage);
        $smarty->assign('lookup', $this->inv_lookup);
        $smarty->assign('stateless', $this->stateless);
        $smarty->assign('wiz_baseurl', $baseurl);
        $smarty->assign('wiz_ajax', $this->ajax);
        $smarty->assign('wiz_animated', $this->ajax_animated);
        $smarty->assign('tab_width', (int)(99 / count($this->pages)));
        $smarty->assign('wiz_page', $page->template());
        $smarty->assign('pl_no_errors', true);
        $page->prepare($smarty, isset($this->inv_lookup[$curpage]) ? $this->inv_lookup[$curpage] : $curpage);
        if (isset($success) && $success) {
            $smarty->trigSuccess($page->success());
        }
    }
}

// vim:set et sw=4 sts=4 sws=4 foldmethod=marker fenc=utf-8:
?>
Commit	Line	Data
2a54eb4d	1	<?php
2a54eb4d	2	/***************************************************************************
e92ecb8c	3	* Copyright (C) 2003-2011 Polytechnique.org *
2a54eb4d	4	* http://opensource.polytechnique.org/ *
	5	* *
	6	* This program is free software; you can redistribute it and/or modify *
	7	* it under the terms of the GNU General Public License as published by *
	8	* the Free Software Foundation; either version 2 of the License, or *
	9	* (at your option) any later version. *
	10	* *
	11	* This program is distributed in the hope that it will be useful, *
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of *
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
	14	* GNU General Public License for more details. *
	15	* *
	16	* You should have received a copy of the GNU General Public License *
	17	* along with this program; if not, write to the Free Software *
	18	* Foundation, Inc., *
	19	* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA *
	20	**************************************************************************/
	21
	22	/** A Wizard Page is a page of a wizard. It is a self-contained step which
	23	* handles both the creation and initialisation of the step (by using the
	24	* Wizard global state, if needed) and the processing of the action the
	25	* user made on it.
	26	*/
	27	interface PlWizardPage
	28	{
	29	/** Build a new instance of the class
	30	* associated with the given wizard master.
	31	*/
ed4f7de0	32	public function __construct(PlWizard $wiz);
2a54eb4d	33
	34	/** Return the name of the templace describing the page.
	35	*/
	36	public function template();
	37
	38	/** Prepare the page by assigning to it any useful value.
	39	*/
ed4f7de0	40	public function prepare(PlPage $page, $id);
2a54eb4d	41
	42	/** Process information resulting of the application of the page.
	43	* This function must return a clue indicating the next page to show.
	44	* This clue can be either a page id, a page number or a navigation
	45	* id (PlWizard::FIRST_PAGE, PlWizard::NEXT_PAGE, PlWizard::CURRENT_PAGE
	46	* PlWizard::PREVIOUS_PAGE, PlWizard::LAST_PAGE).
	47	*/
5e68c681 SJ	48	public function process(&$success);
	49
	50	/** Displays the success message.
	51	*/
	52	public function success();
2a54eb4d	53	}
	54
	55	/** A PlWizard is a set of pages through which the user can navigate,
	56	* his action on a page determining which the next one will be.
	57	*
	58	* A Wizard can either a stateless wizard (which is only a set of
	59	* independent pages through which the user can easily navigate) or
	60	* stateful (a suite of steps where each step gives clue for the next
	61	* one).
	62	*/
	63	class PlWizard
	64	{
8fc4efa3	65	const FIRST_PAGE = 'bt_first';
	66	const NEXT_PAGE = 'bt_next';
	67	const CURRENT_PAGE = 'bt_current';
	68	const PREVIOUS_PAGE = 'bt_previous';
	69	const LAST_PAGE = 'bt_last';
2a54eb4d	70
1ec4547f FB	71	private $userdata = array();
1ec4547f FB	72
2a54eb4d	73	protected $name;
	74	protected $layout;
	75	protected $stateless;
ddb64990	76	protected $ajax;
66297a8c	77	protected $ajax_animated;
2a54eb4d	78
2a54eb4d	79	protected $pages;
e1635d16	80	protected $titles;
2a54eb4d	81	protected $lookup;
fd38b30e	82	protected $inv_lookup;
2a54eb4d	83
66297a8c	84	public function __construct($name, $layout, $stateless = false, $ajax = true, $ajax_animated = true)
2a54eb4d	85	{
e1635d16 FB	86	$this->name = 'wiz_' . $name;
e1635d16 FB	87	$this->layout = $layout;
2a54eb4d	88	$this->stateless = $stateless;
	89	$this->pages = array();
	90	$this->lookup = array();
e1635d16	91	$this->titles = array();
ddb64990	92	$this->ajax = $ajax;
66297a8c	93	$this->ajax_animated = $ajax_animated;
2a54eb4d	94	if (!isset($_SESSION[$this->name])) {
2a54eb4d	95	$_SESSION[$this->name] = array();
fd38b30e FB	96	$_SESSION[$this->name . '_page'] = null;
fd38b30e FB	97	$_SESSION[$this->name . '_stack'] = array();
2a54eb4d	98	}
2a54eb4d	99	}
2a54eb4d	100
fd38b30e	101	public function addPage($class, $title, $id = null)
2a54eb4d	102	{
fd38b30e FB	103	if ($id == null) {
fd38b30e FB	104	$id = count($this->pages);
2a54eb4d	105	}
fd38b30e FB	106	$this->lookup[$id] = count($this->pages);
	107	$this->inv_lookup[] = $id;
	108	$this->pages[] = $class;
	109	$this->titles[] = $title;
2a54eb4d	110	}
2a54eb4d	111
1ec4547f FB	112	public function addUserData($name, $value)
	113	{
	114	$this->userdata[$name] = $value;
	115	}
	116
	117	public function getUserData($name, $default = null)
	118	{
	119	return $this->userdata[$name];
	120	}
	121
2a54eb4d	122	public function set($varname, $value)
	123	{
	124	$_SESSION[$this->name][$varname] = $value;
	125	}
	126
	127	public function get($varname, $default = null)
	128	{
	129	return isset($_SESSION[$this->name][$varname]) ?
	130	$_SESSION[$this->name][$varname] : $default;
	131	}
	132
	133	public function v($varname, $default = "")
	134	{
	135	return $this->get($varname, $default);
	136	}
	137
	138	public function i($varname, $default = 0)
	139	{
	140	return (int)$this->get($varname, $default);
	141	}
	142
	143	public function clear($varname = null)
	144	{
	145	if (is_null($varname)) {
	146	$_SESSION[$this->name] = array();
	147	} else {
	148	unset($_SESSION[$this->name][$varname]);
	149	}
	150	$_SESSION[$this->name . '_page'] = null;
	151	}
	152
e1635d16	153	private function getPage($id)
2a54eb4d	154	{
	155	$page = $this->pages[$id];
	156	return new $page($this);
	157	}
	158
ed4f7de0	159	public function apply(PlPage $smarty, $baseurl, $pgid = null, $mode = 'normal')
2a54eb4d	160	{
ef138fdc SJ	161	if ($this->stateless && (isset($this->lookup[$pgid]) \|\| isset($this->pages[$pgid]))) {
ef138fdc SJ	162	$curpage = is_numeric($pgid) ? $pgid : $this->lookup[$pgid];
fd38b30e FB	163	} else if ($this->stateless && is_null($pgid)) {
	164	$curpage = 0;
	165	} else {
	166	$curpage = $_SESSION[$this->name . '_page'];
	167	}
	168	$oldpage = $curpage;
2a54eb4d	169
2a54eb4d	170	// Process the previous page
93553cea	171	if (Post::has('valid_page')) {
37c45da5 VZ	172	S::assert_xsrf_token();
37c45da5 VZ	173
93553cea FB	174	$page = $this->getPage(Post::i('valid_page'));
93553cea FB	175	$curpage = Post::i('valid_page');
5e68c681	176	$success = false;
ed4f7de0	177	$next = $page->process($success);
e1635d16	178	$last = $curpage;
2a54eb4d	179	switch ($next) {
	180	case PlWizard::FIRST_PAGE:
	181	$curpage = 0;
	182	break;
	183	case PlWizard::PREVIOUS_PAGE:
e1635d16 FB	184	if (!$this->stateless && count($_SESSION[$this->name . '_stack'])) {
	185	$curpage = array_pop($_SESSION[$this->name . '_stack']);
	186	} elseif ($curpage && $this->stateless) {
	187	$curpage--;
	188	} else {
	189	$curpage = 0;
	190	}
2a54eb4d	191	break;
2a54eb4d	192	case PlWizard::NEXT_PAGE:
e1635d16 FB	193	if ($curpage < count($this->pages) - 1) {
	194	$curpage++;
	195	}
2a54eb4d	196	break;
	197	case PlWizard::LAST_PAGE:
	198	$curpage = count($this->pages) - 1;
	199	break;
	200	case PlWizard::CURRENT_PAGE: break; // don't change the page
	201	default:
fd38b30e	202	$curpage = is_numeric($next) ? $next : $this->lookup[$next];
2a54eb4d	203	break;
2a54eb4d	204	}
e1635d16 FB	205	if (!$this->stateless) {
	206	array_push($_SESSION[$this->name . '_stack'], $last);
	207	}
2a54eb4d	208	}
e1635d16 FB	209	if (is_null($curpage)) {
	210	$curpage = 0;
	211	}
2a54eb4d	212
2a54eb4d	213	// Prepare the page
fd38b30e FB	214	$_SESSION[$this->name . '_page'] = $curpage;
fd38b30e FB	215	if ($curpage != $oldpage) {
5e68c681 SJ	216	if (isset($success) && $success) {
	217	pl_redirect($baseurl . '/' . $this->inv_lookup[$curpage] . '/null/' . $success);
	218	} else {
	219	pl_redirect($baseurl . '/' . $this->inv_lookup[$curpage]);
	220	}
fd38b30e FB	221	} else if (!isset($page)) {
	222	$page = $this->getPage($curpage);
	223	}
ddb64990	224	if ($mode == 'ajax') {
a286fc7a	225	pl_content_headers("text/html");
66297a8c FB	226	$smarty->changeTpl($this->layout, NO_SKIN);
66297a8c FB	227	$smarty->assign('wiz_run_ajax', true);
ddb64990 FB	228	} else {
	229	$smarty->changeTpl($this->layout);
	230	}
e1635d16 FB	231	$smarty->assign('pages', $this->titles);
e1635d16 FB	232	$smarty->assign('current', $curpage);
fd38b30e	233	$smarty->assign('lookup', $this->inv_lookup);
e1635d16 FB	234	$smarty->assign('stateless', $this->stateless);
e1635d16 FB	235	$smarty->assign('wiz_baseurl', $baseurl);
ddb64990	236	$smarty->assign('wiz_ajax', $this->ajax);
66297a8c	237	$smarty->assign('wiz_animated', $this->ajax_animated);
e1635d16	238	$smarty->assign('tab_width', (int)(99 / count($this->pages)));
2a54eb4d	239	$smarty->assign('wiz_page', $page->template());
91ebb7ff	240	$smarty->assign('pl_no_errors', true);
ddb64990	241	$page->prepare($smarty, isset($this->inv_lookup[$curpage]) ? $this->inv_lookup[$curpage] : $curpage);
5e68c681 SJ	242	if (isset($success) && $success) {
	243	$smarty->trigSuccess($page->success());
	244	}
2a54eb4d	245	}
	246	}
	247
fa7ffd66	248	// vim:set et sw=4 sts=4 sws=4 foldmethod=marker fenc=utf-8:
2a54eb4d	249	?>