banana/page.inc.php

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