2 /********************************************************************************
3 * banana/page.inc.php : class for group lists
4 * ------------------------
6 * This file is part of the banana distribution
7 * Copyright: See COPYING files that comes with this distribution
8 ********************************************************************************/
10 require_once 'smarty/libs/Smarty.class.php';
12 class BananaPage
extends Smarty
14 private $error = array();
17 private $pages = array();
18 private $killed = array();
19 private $actions = array();
21 public function __construct()
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');
32 /** Add an error message
33 * @param message STRING html code of the error to display
35 public function trig($message)
37 $this->error
[] = $message;
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
44 public function kill($message)
46 $this->trig($message);
47 $this->assign('killed', true
);
51 /** Set the current page
52 * @param page STRING page name
54 public function setPage($page)
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
65 public function registerAction($action_code, array $pages = null
)
67 $this->actions
[] = array('text' => $action_code, 'pages' => $pages);
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
77 public function registerPage($name, $text, $template = null
)
79 $this->pages
[$name] = array('text' => $text, 'template' => $template);
84 * @param page STRING page name to kill
86 public function killPage($page)
88 $this->killed
[] = $page;
91 /** Preparte the page generation
92 * @return template to use
94 protected function prepare()
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
);
107 } elseif ($this->page
== 'new') {
108 $this->registerPage('new', _b_('Nouveau'), null
);
111 foreach ($this->killed
as $page) {
112 unset($this->pages
[$page]);
114 foreach ($this->actions
as $key=>&$action) {
115 if (!is_null($action['pages']) && !in_array($this->page
, $action['pages'])) {
116 unset($this->actions
[$key]);
120 return 'banana-base.tpl';
123 /** Generate XHTML code
125 public function run()
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();
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 $this->assign('showboxlist', Banana
::$spool_boxlist);
143 $this->assign('showthread', Banana
::$msgshow_withthread);
144 $this->assign('withtabs' , Banana
::$withtabs);
146 $this->register_function('url', array($this, 'makeUrl'));
147 $this->register_function('link', array($this, 'makeLink'));
148 $this->register_function('imglink', array($this, 'makeImgLink'));
149 $this->register_function('img', array($this, 'makeImg'));
150 $this->register_modifier('b', '_b_');
152 $this->assign('errors', $this->error
);
153 $this->assign('page', $this->page
);
154 $this->assign('pages', $this->pages
);
155 $this->assign('actions', $this->actions
);
157 if (!Banana
::$debug_smarty) {
158 $error_level = error_reporting(0);
160 $text = $this->fetch($tpl);
161 $text = banana_utf8entities($text);
162 if (!Banana
::$debug_smarty) {
163 error_reporting($error_level);
168 /** Build a URL in Banana
169 * @param params ARRAY location datas
170 * @param smarty OBJECT Smarty instance associated (null if none)
171 * @return URL of the page associated with the given parameters
173 * Usual parameters are :
174 * - group : the box name
175 * - artid : the current message id (index of message-id)
176 * - part : part id to show (may be a content-id, xface or a mime-type for text)
177 * - first : first linear-index to show in spool view
178 * - action: like subscribe, cancel, new
179 * - all others params are allowed, but not parsed by the base implementation of banana
181 * smarty funciton : {url param1=... param2=...}
183 public function makeUrl(array $params, &$smarty = null
)
185 if (function_exists('hook_makeLink')
186 && $res = hook_makeLink($params)) {
189 $proto = empty($_SERVER['HTTPS']) ?
'http://' : 'https://';
190 $host = $_SERVER['HTTP_HOST'];
191 $file = $_SERVER['PHP_SELF'];
193 if (count($params) != 0) {
195 foreach ($params as $key=>$value) {
196 if (strlen($get) != 1) {
199 $get .= $key . '=' . $value;
204 return $proto . $host . $file . $get;
207 /** Build a link to a Banana page
208 * @param params ARRAY location datas
209 * @param smarty OBJECT Smarty instance associated (null if none)
210 * @return Link to the page associated with the given parameters
212 * Support all @ref makeURL parameters, but catch the following:
213 * - text : if set, defined the text of the link (if not set, the URL is used
214 * - popup : title of the link (showed as a tooltip on most browsers)
215 * - class : specific style class for the markup
216 * - accesskey: keyboard key to trigger the link
217 * None of this parameters is needed
219 * Smarty function : {link param1=... param2=...}
221 public function makeLink(array $params, &$smarty = null
)
223 $catch = array('text', 'popup', 'class', 'accesskey');
224 foreach ($catch as $key) {
225 $
{$key} = isset($params[$key]) ?
$params[$key] : null
;
226 unset($params[$key]);
228 $link = $this->makeUrl($params, &$smarty);
229 if (is_null($text)) {
232 if (!is_null($accesskey)) {
233 $popup .= ' (raccourci : ' . $accesskey . ')';
235 if (!is_null($popup)) {
236 $popup = ' title="' . banana_htmlentities($popup) . '"';
238 if (!is_null($class)) {
239 $class = ' class="' . $class . '"';
241 if (!is_null($accesskey)) {
242 $accesskey = ' accesskey="' . $accesskey . '"';
244 return '<a href="' . banana_htmlentities($link) . '"'
245 . $popup . $class . $accesskey
246 . '>' . $text . '</a>';
249 /** Build a link to one of the banana built-in images
250 * @param params ARRAY image datas
251 * @param smarty OBJECT Smarty instance associated (null if none)
254 * Supported parameters are
255 * - img : name of the image (without its extension)
256 * - alt : alternative text
257 * - height and width : dimensions of the images
258 * img and alt are needed
260 * Smarty function: {img img=... alt=... [height=...] [width=...]}
262 public function makeImg(array $params, &$smarty = null
)
264 $catch = array('img', 'alt', 'height', 'width');
265 foreach ($catch as $key) {
266 $
{$key} = isset($params[$key]) ?
$params[$key] : null
;
269 if (function_exists('hook_makeImg')
270 && $res = hook_makeImg($img, $alt, $height, $width)) {
274 if (!is_null($width)) {
275 $width = ' width="' . $width . '"';
277 if (!is_null($height)) {
278 $height = ' height="' . $height . '"';
281 $proto = empty($_SERVER['HTTPS']) ?
'http://' : 'https://';
282 $host = $_SERVER['HTTP_HOST'];
283 $file = dirname($_SERVER['PHP_SELF']) . '/img/' . $img;
284 $url = $proto . $host . $file;
286 return '<img src="' . $url . '"' . $height . $width . ' alt="' . _b_($alt) . '" />';
289 /** Build a link with an image as text
290 * @param params ARRAY image and location data
291 * @param smarty OBJECT Smarty instance associated (null if none)
292 * @return an image within an link
294 * All @ref makeImg and @ref makeLink parameters are supported
295 * if text is set, the text will be appended after the image in the link
297 * Smarty function : {imglink img=... alt=... [param1=...]}
299 public function makeImgLink(array $params, &$smarty = null
)
301 $params['alt'] = _b_($params['alt']);
302 if (!isset($params['popup'])) {
303 $params['popup'] = $params['alt'];
305 $img = $this->makeImg($params, $smarty);
306 if (isset($params['text'])) {
307 $img .= ' ' . $params['text'];
309 $params['text'] = $img;
310 return $this->makeLink($params, $smarty);
313 /** Redirect to the page with the given parameter
316 public function redirect(array $params = array())
318 header('Location: ' . $this->makeUrl($params));
322 // {{{ function banana_trimwhitespace
324 function banana_trimwhitespace($source, &$smarty)
326 $tags = array('script', 'pre', 'textarea');
328 foreach ($tags as $tag) {
329 preg_match_all("!<{$tag}[^>]+>.*?</{$tag}>!is", $source, $
{$tag});
330 $source = preg_replace("!<{$tag}[^>]+>.*?</{$tag}>!is", "&&&{$tag}&&&", $source);
333 // remove all leading spaces, tabs and carriage returns NOT
334 // preceeded by a php close tag.
335 $source = preg_replace('/((?<!\?>)\n)[\s]+/m', '\1', $source);
337 foreach ($tags as $tag) {
338 $source = preg_replace("!&&&{$tag}&&&!e", 'array_shift(${$tag}[0])', $source);
347 // vim:set et sw=4 sts=4 ts=4 enc=utf-8: