[banana.git] / banana / page.inc.php

<?php
/********************************************************************************
* banana/page.inc.php : class for group lists
* ------------------------
*
* This file is part of the banana distribution
* Copyright: See COPYING files that comes with this distribution
********************************************************************************/

require_once 'smarty/libs/Smarty.class.php';

class BananaPage extends Smarty
{
    private $error = array();
    private $page  = null;

    private $pages   = array();
    private $killed  = array();
    private $actions = array();

    public $css = '';

    public function __construct()
    {
        $this->Smarty();

        $this->compile_check = Banana::$debug_smarty;
        $this->template_dir  = dirname(__FILE__) . '/templates/';
        $this->compile_dir   = dirname(dirname(__FILE__)) . '/spool/templates_c/';
        $this->register_prefilter('banana_trimwhitespace');
    
    }

    /** Add an error message
     * @param message STRING html code of the error to display
     */
    public function trig($message)
    {
        $this->error[] = $message;
    }

    /** Kill the current page (generate an error message and skip page generation)
     * @param message STRING html code of the error message to display
     @ @return XHTML code of the page
     */
    public function kill($message)
    {
        $this->trig($message);
        $this->assign('killed', true);
        return $this->run();
    }

    /** Set the current page
     * @param page STRING page name
     */
    public function setPage($page)
    {
        $this->page = $page;
        return true;
    }

    /** Register an action to show on banana page
     * @param action_code HTML code of the action
     * @param pages ARRAY pages where to show the action (null == every pages)
     * @return true if success
     */ 
    public function registerAction($action_code, array $pages = null)
    {
        $this->actions[] = array('text' => $action_code, 'pages' => $pages);
        return true;
    }

    /** Register a new page
     * @param name Name of the page
     * @param text Text for the tab of the page
     * @param template Template path for the page if null, the page is not handled by banana
     * @return true if success
     */
    public function registerPage($name, $text, $template = null)
    {
        $this->pages[$name] = array('text' => $text, 'template' => $template);
        return true;
    }

    /** Remove a page
     * @param page STRING page name to kill
     */
    public function killPage($page)
    {
        $this->killed[] = $page;
    }

    /** Add Inline CSS to put in the page headers
     * @param css CSS code
     */
    public function addCssInline($css)
    {
        $this->css .= $css;
    }

    /** Preparte the page generation
     * @return template to use
     */
    protected function prepare()
    {
        $this->registerPage('subscribe', _b_('Abonnements'), null);
        $this->registerPage('forums', _b_('Les forums'), null);
        if (!is_null(Banana::$group)) {
            $this->registerPage('thread', Banana::$group, null);
            if (!is_null(Banana::$artid)) {
                $this->registerPage('message', _b_('Message'), null);
                if ($this->page == 'cancel') {
                    $this->registerPage('cancel', _b_('Annulation'), null);
                } elseif ($this->page == 'new') {
                    $this->registerPage('new', _b_('Répondre'), null);
                }
            } elseif ($this->page == 'new') {
                $this->registerPage('new', _b_('Nouveau'), null);
            }
        }
        foreach ($this->killed as $page) {
            unset($this->pages[$page]);
        }
        foreach ($this->actions as $key=>&$action) {
            if (!is_null($action['pages']) && !in_array($this->page, $action['pages'])) {
                unset($this->actions[$key]);
            }
        }

        return 'banana-base.tpl';
    }
    
    /** Generate XHTML code
     */
    public function run()
    {
        $tpl = $this->prepare();
        if (!isset($this->pages[$this->page])) {
            $this->trig(_b_('La page demandée n\'existe pas'));
            $this->actions = array();
            $this->page = null;
        }

        $this->assign('group',     Banana::$group);
        $this->assign('artid',     Banana::$artid);
        $this->assign('part',      Banana::$part);
        $this->assign('first',     Banana::$first);
        $this->assign('action',    Banana::$action);
        $this->assign('profile',   Banana::$profile);
        $this->assign('spool',     Banana::$spool);
        $this->assign('protocole', Banana::$protocole);
        $this->assign('showboxlist', Banana::$spool_boxlist);
        $this->assign('showthread',  Banana::$msgshow_withthread);
        $this->assign('withtabs'   , Banana::$withtabs);

        $this->register_function('url',     array($this, 'makeUrl'));
        $this->register_function('link',    array($this, 'makeLink'));
        $this->register_function('imglink', array($this, 'makeImgLink'));
        $this->register_function('img',     array($this, 'makeImg'));
        $this->register_modifier('b',       '_b_');

        $this->assign('errors',    $this->error);
        $this->assign('page',      $this->page);
        $this->assign('pages',     $this->pages);
        $this->assign('actions',   $this->actions);

        if (!Banana::$debug_smarty) {
            $error_level = error_reporting(0);
        }
        $text = $this->fetch($tpl);
        $text = banana_utf8entities($text);
        if (!Banana::$debug_smarty) {
            error_reporting($error_level);
        }
        return $text;
    }

    /** Build a URL in Banana
     * @param params ARRAY location datas
     * @param smarty OBJECT Smarty instance associated (null if none)
     * @return URL of the page associated with the given parameters
     * 
     * Usual parameters are :
     * - group : the box name
     * - artid : the current message id (index of message-id)
     * - part  : part id to show (may be a content-id, xface or a mime-type for text)
     * - first : first linear-index to show in spool view
     * - action: like subscribe, cancel, new
     * - all others params are allowed, but not parsed by the base implementation of banana
     *
     * smarty funciton : {url param1=... param2=...}
     */
    public function makeUrl(array $params, &$smarty = null)
    {
        if (function_exists('hook_makeLink')
                && $res = hook_makeLink($params)) {
            return $res;
        }   
        $proto = empty($_SERVER['HTTPS']) ? 'http://' : 'https://';
        $host  = $_SERVER['HTTP_HOST'];
        $file  = $_SERVER['PHP_SELF'];
    
        if (count($params) != 0) {
            $get = '?';
            foreach ($params as $key=>$value) {
                if (strlen($get) != 1) {
                    $get .= '&';
                }
                $get .= $key . '=' . $value;
            }
        } else {
            $get = '';
        }     
        return $proto . $host . $file . $get;
    }

    /** Build a link to a Banana page
     * @param params ARRAY location datas
     * @param smarty OBJECT Smarty instance associated (null if none)
     * @return Link to the page associated with the given parameters
     *
     * Support all @ref makeURL parameters, but catch the following:
     * - text     : if set, defined the text of the link (if not set, the URL is used
     * - popup    : title of the link (showed as a tooltip on most browsers)
     * - class    : specific style class for the markup
     * - accesskey: keyboard key to trigger the link
     * None of this parameters is needed
     *
     * Smarty function : {link param1=... param2=...}
     */
    public function makeLink(array $params, &$smarty = null)
    {
        $catch = array('text', 'popup', 'class', 'accesskey');
        foreach ($catch as $key) {
            ${$key} = isset($params[$key]) ? $params[$key] : null;
            unset($params[$key]);
        }
        $link = $this->makeUrl($params, &$smarty);
        if (is_null($text)) {
            $text = $link;
        }
        if (!is_null($accesskey)) {
            $popup .= ' (raccourci : ' . $accesskey . ')';
        }
        if (!is_null($popup)) {
            $popup = ' title="' . banana_htmlentities($popup) . '"';
        }
        if (!is_null($class)) {
            $class = ' class="' . $class . '"';
        }
        if (!is_null($accesskey)) {
            $accesskey = ' accesskey="' . $accesskey . '"';
        }
        return '<a href="' . banana_htmlentities($link) . '"'
              . $popup . $class . $accesskey
              . '>' . $text . '</a>';
    }

    /** Build a link to one of the banana built-in images
     * @param params ARRAY image datas
     * @param smarty OBJECT Smarty instance associated (null if none)
     * @return Img tag
     *
     * Supported parameters are
     * - img : name of the image (without its extension)
     * - alt : alternative text
     * - height and width : dimensions of the images
     * img and alt are needed
     *
     * Smarty function: {img img=... alt=... [height=...] [width=...]}
     */
    public function makeImg(array $params, &$smarty = null)
    {
        $catch = array('img', 'alt', 'height', 'width');
        foreach ($catch as $key) {
            ${$key} = isset($params[$key]) ? $params[$key] : null;
        }
        $img .= ".gif";
        if (function_exists('hook_makeImg')
                && $res = hook_makeImg($img, $alt, $height, $width)) {
            return $res;
        }

        if (!is_null($width)) {
            $width = ' width="' . $width . '"';
        }
        if (!is_null($height)) {
            $height = ' height="' . $height . '"';
        }

        $proto = empty($_SERVER['HTTPS']) ? 'http://' : 'https://';
        $host  = $_SERVER['HTTP_HOST'];
        $file  = dirname($_SERVER['PHP_SELF']) . '/img/' . $img;
        $url   = $proto . $host . $file;

        return '<img src="' . $url . '"' . $height . $width . ' alt="' . _b_($alt) . '" />';
    }
    
    /** Build a link with an image as text
     * @param params ARRAY image and location data
     * @param smarty OBJECT Smarty instance associated (null if none)
     * @return an image within an link
     *
     * All @ref makeImg and @ref makeLink parameters are supported
     * if text is set, the text will be appended after the image in the link
     *
     * Smarty function : {imglink img=... alt=... [param1=...]}
     */
    public function makeImgLink(array $params, &$smarty = null)
    {
        $params['alt'] = _b_($params['alt']);
        if (!isset($params['popup'])) {
            $params['popup'] = $params['alt'];
        }    
        $img = $this->makeImg($params, $smarty);
        if (isset($params['text'])) {
            $img .= ' ' . $params['text'];
        }
        $params['text'] = $img;
        return $this->makeLink($params, $smarty);
    }

    /** Redirect to the page with the given parameter
     * @ref makeURL
     */
    public function redirect(array $params = array())
    {
        header('Location: ' . $this->makeUrl($params));
    }
}

// {{{  function banana_trimwhitespace

function banana_trimwhitespace($source, &$smarty)
{
    $tags = array('script', 'pre', 'textarea');

    foreach ($tags as $tag) {
        preg_match_all("!<{$tag}[^>]+>.*?</{$tag}>!is", $source, ${$tag});
        $source = preg_replace("!<{$tag}[^>]+>.*?</{$tag}>!is", "&&&{$tag}&&&", $source);
    }

    // remove all leading spaces, tabs and carriage returns NOT
    // preceeded by a php close tag.
    $source = preg_replace('/((?<!\?>)\n)[\s]+/m', '\1', $source);

    foreach ($tags as $tag) {
        $source = preg_replace("!&&&{$tag}&&&!e",  'array_shift(${$tag}[0])', $source);
    }

    return $source;
}

// }}}


// vim:set et sw=4 sts=4 ts=4 enc=utf-8:
?>
Commit	Line	Data
7027794f	1	<?php
	2	/********************************************************************************
	3	* banana/page.inc.php : class for group lists
	4	* ------------------------
	5	*
	6	* This file is part of the banana distribution
	7	* Copyright: See COPYING files that comes with this distribution
	8	********************************************************************************/
	9
	10	require_once 'smarty/libs/Smarty.class.php';
	11
	12	class BananaPage extends Smarty
	13	{
	14	private $error = array();
	15	private $page = null;
	16
	17	private $pages = array();
4eeddd59	18	private $killed = array();
7027794f	19	private $actions = array();
7027794f	20
9c118ac9	21	public $css = '';
9c118ac9	22
7027794f	23	public function __construct()
	24	{
	25	$this->Smarty();
	26
	27	$this->compile_check = Banana::$debug_smarty;
	28	$this->template_dir = dirname(__FILE__) . '/templates/';
	29	$this->compile_dir = dirname(dirname(__FILE__)) . '/spool/templates_c/';
	30	$this->register_prefilter('banana_trimwhitespace');
	31
	32	}
	33
2f0aa8ce	34	/** Add an error message
	35	* @param message STRING html code of the error to display
	36	*/
7027794f	37	public function trig($message)
	38	{
	39	$this->error[] = $message;
	40	}
	41
2f0aa8ce	42	/** Kill the current page (generate an error message and skip page generation)
	43	* @param message STRING html code of the error message to display
	44	@ @return XHTML code of the page
	45	*/
7027794f	46	public function kill($message)
	47	{
	48	$this->trig($message);
2f0aa8ce	49	$this->assign('killed', true);
7027794f	50	return $this->run();
	51	}
	52
2f0aa8ce	53	/** Set the current page
	54	* @param page STRING page name
	55	*/
7027794f	56	public function setPage($page)
	57	{
	58	$this->page = $page;
4eeddd59	59	return true;
7027794f	60	}
7027794f	61
2f0aa8ce	62	/** Register an action to show on banana page
	63	* @param action_code HTML code of the action
	64	* @param pages ARRAY pages where to show the action (null == every pages)
	65	* @return true if success
	66	*/
7027794f	67	public function registerAction($action_code, array $pages = null)
	68	{
	69	$this->actions[] = array('text' => $action_code, 'pages' => $pages);
	70	return true;
	71	}
	72
2f0aa8ce	73	/** Register a new page
	74	* @param name Name of the page
	75	* @param text Text for the tab of the page
	76	* @param template Template path for the page if null, the page is not handled by banana
	77	* @return true if success
	78	*/
7027794f	79	public function registerPage($name, $text, $template = null)
	80	{
	81	$this->pages[$name] = array('text' => $text, 'template' => $template);
	82	return true;
	83	}
b18124be	84
4eeddd59	85	/** Remove a page
	86	* @param page STRING page name to kill
	87	*/
	88	public function killPage($page)
	89	{
	90	$this->killed[] = $page;
	91	}
	92
9c118ac9	93	/** Add Inline CSS to put in the page headers
	94	* @param css CSS code
	95	*/
	96	public function addCssInline($css)
	97	{
	98	$this->css .= $css;
	99	}
	100
b18124be	101	/** Preparte the page generation
b18124be	102	* @return template to use
2f0aa8ce	103	*/
b18124be	104	protected function prepare()
7027794f	105	{
	106	$this->registerPage('subscribe', _b_('Abonnements'), null);
	107	$this->registerPage('forums', _b_('Les forums'), null);
	108	if (!is_null(Banana::$group)) {
	109	$this->registerPage('thread', Banana::$group, null);
	110	if (!is_null(Banana::$artid)) {
	111	$this->registerPage('message', _b_('Message'), null);
	112	if ($this->page == 'cancel') {
	113	$this->registerPage('cancel', _b_('Annulation'), null);
	114	} elseif ($this->page == 'new') {
598a1c53	115	$this->registerPage('new', _b_('Répondre'), null);
7027794f	116	}
	117	} elseif ($this->page == 'new') {
	118	$this->registerPage('new', _b_('Nouveau'), null);
	119	}
	120	}
4eeddd59	121	foreach ($this->killed as $page) {
	122	unset($this->pages[$page]);
	123	}
7027794f	124	foreach ($this->actions as $key=>&$action) {
	125	if (!is_null($action['pages']) && !in_array($this->page, $action['pages'])) {
	126	unset($this->actions[$key]);
	127	}
	128	}
b18124be	129
	130	return 'banana-base.tpl';
	131	}
	132
	133	/** Generate XHTML code
	134	*/
	135	public function run()
	136	{
	137	$tpl = $this->prepare();
4eeddd59	138	if (!isset($this->pages[$this->page])) {
598a1c53	139	$this->trig(_b_('La page demandée n\'existe pas'));
4eeddd59	140	$this->actions = array();
	141	$this->page = null;
	142	}
b18124be	143
7027794f	144	$this->assign('group', Banana::$group);
	145	$this->assign('artid', Banana::$artid);
	146	$this->assign('part', Banana::$part);
	147	$this->assign('first', Banana::$first);
	148	$this->assign('action', Banana::$action);
	149	$this->assign('profile', Banana::$profile);
	150	$this->assign('spool', Banana::$spool);
	151	$this->assign('protocole', Banana::$protocole);
8bfa4595	152	$this->assign('showboxlist', Banana::$spool_boxlist);
e95f5b5e	153	$this->assign('showthread', Banana::$msgshow_withthread);
e95f5b5e	154	$this->assign('withtabs' , Banana::$withtabs);
7027794f	155
b18124be	156	$this->register_function('url', array($this, 'makeUrl'));
	157	$this->register_function('link', array($this, 'makeLink'));
	158	$this->register_function('imglink', array($this, 'makeImgLink'));
	159	$this->register_function('img', array($this, 'makeImg'));
a0b2e16c	160	$this->register_modifier('b', '_b_');
4eeddd59	161
7027794f	162	$this->assign('errors', $this->error);
	163	$this->assign('page', $this->page);
	164	$this->assign('pages', $this->pages);
	165	$this->assign('actions', $this->actions);
	166
7027794f	167	if (!Banana::$debug_smarty) {
	168	$error_level = error_reporting(0);
	169	}
b18124be	170	$text = $this->fetch($tpl);
7027794f	171	$text = banana_utf8entities($text);
	172	if (!Banana::$debug_smarty) {
	173	error_reporting($error_level);
	174	}
	175	return $text;
	176	}
	177
2f0aa8ce	178	/** Build a URL in Banana
	179	* @param params ARRAY location datas
	180	* @param smarty OBJECT Smarty instance associated (null if none)
	181	* @return URL of the page associated with the given parameters
	182	*
	183	* Usual parameters are :
	184	* - group : the box name
	185	* - artid : the current message id (index of message-id)
	186	* - part : part id to show (may be a content-id, xface or a mime-type for text)
	187	* - first : first linear-index to show in spool view
	188	* - action: like subscribe, cancel, new
	189	* - all others params are allowed, but not parsed by the base implementation of banana
	190	*
	191	* smarty funciton : {url param1=... param2=...}
	192	*/
	193	public function makeUrl(array $params, &$smarty = null)
7027794f	194	{
	195	if (function_exists('hook_makeLink')
	196	&& $res = hook_makeLink($params)) {
	197	return $res;
	198	}
	199	$proto = empty($_SERVER['HTTPS']) ? 'http://' : 'https://';
	200	$host = $_SERVER['HTTP_HOST'];
	201	$file = $_SERVER['PHP_SELF'];
	202
	203	if (count($params) != 0) {
	204	$get = '?';
	205	foreach ($params as $key=>$value) {
	206	if (strlen($get) != 1) {
	207	$get .= '&';
	208	}
	209	$get .= $key . '=' . $value;
	210	}
	211	} else {
	212	$get = '';
	213	}
	214	return $proto . $host . $file . $get;
	215	}
	216
2f0aa8ce	217	/** Build a link to a Banana page
	218	* @param params ARRAY location datas
	219	* @param smarty OBJECT Smarty instance associated (null if none)
	220	* @return Link to the page associated with the given parameters
	221	*
	222	* Support all @ref makeURL parameters, but catch the following:
	223	* - text : if set, defined the text of the link (if not set, the URL is used
	224	* - popup : title of the link (showed as a tooltip on most browsers)
	225	* - class : specific style class for the markup
	226	* - accesskey: keyboard key to trigger the link
	227	* None of this parameters is needed
	228	*
	229	* Smarty function : {link param1=... param2=...}
	230	*/
	231	public function makeLink(array $params, &$smarty = null)
7027794f	232	{
	233	$catch = array('text', 'popup', 'class', 'accesskey');
	234	foreach ($catch as $key) {
	235	${$key} = isset($params[$key]) ? $params[$key] : null;
	236	unset($params[$key]);
	237	}
	238	$link = $this->makeUrl($params, &$smarty);
	239	if (is_null($text)) {
	240	$text = $link;
	241	}
	242	if (!is_null($accesskey)) {
	243	$popup .= ' (raccourci : ' . $accesskey . ')';
	244	}
	245	if (!is_null($popup)) {
2f0aa8ce	246	$popup = ' title="' . banana_htmlentities($popup) . '"';
7027794f	247	}
	248	if (!is_null($class)) {
	249	$class = ' class="' . $class . '"';
	250	}
7027794f	251	if (!is_null($accesskey)) {
	252	$accesskey = ' accesskey="' . $accesskey . '"';
	253	}
2f0aa8ce	254	return '<a href="' . banana_htmlentities($link) . '"'
2f0aa8ce	255	. $popup . $class . $accesskey
7027794f	256	. '>' . $text . '</a>';
	257	}
	258
2f0aa8ce	259	/** Build a link to one of the banana built-in images
	260	* @param params ARRAY image datas
	261	* @param smarty OBJECT Smarty instance associated (null if none)
	262	* @return Img tag
	263	*
	264	* Supported parameters are
	265	* - img : name of the image (without its extension)
	266	* - alt : alternative text
	267	* - height and width : dimensions of the images
	268	* img and alt are needed
	269	*
	270	* Smarty function: {img img=... alt=... [height=...] [width=...]}
	271	*/
	272	public function makeImg(array $params, &$smarty = null)
7027794f	273	{
	274	$catch = array('img', 'alt', 'height', 'width');
	275	foreach ($catch as $key) {
	276	${$key} = isset($params[$key]) ? $params[$key] : null;
	277	}
	278	$img .= ".gif";
	279	if (function_exists('hook_makeImg')
	280	&& $res = hook_makeImg($img, $alt, $height, $width)) {
	281	return $res;
	282	}
	283
	284	if (!is_null($width)) {
	285	$width = ' width="' . $width . '"';
	286	}
	287	if (!is_null($height)) {
	288	$height = ' height="' . $height . '"';
	289	}
	290
	291	$proto = empty($_SERVER['HTTPS']) ? 'http://' : 'https://';
	292	$host = $_SERVER['HTTP_HOST'];
	293	$file = dirname($_SERVER['PHP_SELF']) . '/img/' . $img;
	294	$url = $proto . $host . $file;
	295
	296	return '<img src="' . $url . '"' . $height . $width . ' alt="' . _b_($alt) . '" />';
	297	}
2f0aa8ce	298
	299	/** Build a link with an image as text
	300	* @param params ARRAY image and location data
	301	* @param smarty OBJECT Smarty instance associated (null if none)
	302	* @return an image within an link
	303	*
	304	* All @ref makeImg and @ref makeLink parameters are supported
	305	* if text is set, the text will be appended after the image in the link
	306	*
	307	* Smarty function : {imglink img=... alt=... [param1=...]}
	308	*/
	309	public function makeImgLink(array $params, &$smarty = null)
7027794f	310	{
7027794f	311	$params['alt'] = _b_($params['alt']);
2f0aa8ce	312	if (!isset($params['popup'])) {
	313	$params['popup'] = $params['alt'];
	314	}
	315	$img = $this->makeImg($params, $smarty);
	316	if (isset($params['text'])) {
	317	$img .= ' ' . $params['text'];
	318	}
	319	$params['text'] = $img;
7027794f	320	return $this->makeLink($params, $smarty);
	321	}
	322
	323	/** Redirect to the page with the given parameter
2f0aa8ce	324	* @ref makeURL
7027794f	325	*/
2f0aa8ce	326	public function redirect(array $params = array())
7027794f	327	{
	328	header('Location: ' . $this->makeUrl($params));
	329	}
	330	}
	331
	332	// {{{ function banana_trimwhitespace
	333
	334	function banana_trimwhitespace($source, &$smarty)
	335	{
	336	$tags = array('script', 'pre', 'textarea');
	337
	338	foreach ($tags as $tag) {
	339	preg_match_all("!<{$tag}[^>]+>.*?</{$tag}>!is", $source, ${$tag});
	340	$source = preg_replace("!<{$tag}[^>]+>.*?</{$tag}>!is", "&&&{$tag}&&&", $source);
	341	}
	342
	343	// remove all leading spaces, tabs and carriage returns NOT
	344	// preceeded by a php close tag.
	345	$source = preg_replace('/((?<!\?>)\n)[\s]+/m', '\1', $source);
	346
	347	foreach ($tags as $tag) {
	348	$source = preg_replace("!&&&{$tag}&&&!e", 'array_shift(${$tag}[0])', $source);
	349	}
	350
	351	return $source;
	352	}
	353
	354	// }}}
	355
	356
598a1c53	357	// vim:set et sw=4 sts=4 ts=4 enc=utf-8:
7027794f	358	?>