Switch to the new trigger pattern.
[platal.git] / classes / platalpage.php
1 <?php
2 /***************************************************************************
3 * Copyright (C) 2003-2008 Polytechnique.org *
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 require_once 'smarty/libs/Smarty.class.php';
23
24 abstract class PlatalPage extends Smarty
25 {
26 private $_page_type;
27 private $_tpl;
28 private $_errors;
29 private $_failure;
30 private $_jsonVars;
31
32 // {{{ function PlatalPage()
33
34 public function __construct($tpl, $type = SKINNED)
35 {
36 parent::Smarty();
37
38 global $globals;
39
40 $this->caching = false;
41 $this->config_overwrite = false;
42 $this->use_sub_dirs = false;
43 $this->template_dir = $globals->spoolroot."/templates/";
44 $this->compile_dir = $globals->spoolroot."/spool/templates_c/";
45 array_unshift($this->plugins_dir, $globals->spoolroot."/plugins/");
46 $this->config_dir = $globals->spoolroot."/configs/";
47
48 $this->compile_check = !empty($globals->debug);
49
50 $this->changeTpl($tpl, $type);
51 $this->_errors = array('errors' => array());
52 $this->_jsonVars = array();
53 $this->_failure = false;
54
55 if ($globals->mode != 'rw') {
56 $this->trigError("En raison d'une maintenance, une partie des fonctionnalités du site sont"
57 . " actuellement désactivée, en particuliers aucune donnée ne sera sauvegardée");
58 }
59 $this->register_prefilter('at_to_globals');
60 $this->addJsLink('xorg.js');
61 $this->addJsLink('jquery.js');
62 }
63
64 // }}}
65 // {{{ function changeTpl()
66
67 public function changeTpl($tpl, $type = SKINNED)
68 {
69 $this->_tpl = $tpl;
70 $this->_page_type = $type;
71 $this->assign('xorg_tpl', $tpl);
72 }
73
74 // }}}
75 // {{{ function raw()
76
77 public function raw()
78 {
79 global $globals;
80 $this->assign('globals', $globals);
81 return $this->fetch($this->_tpl);
82 }
83
84 // }}}
85 // {{{ function _run()
86
87 protected function _run($skin)
88 {
89 global $globals, $TIME_BEGIN;
90
91 session_write_close();
92
93 $this->register_prefilter('trimwhitespace');
94 $this->register_prefilter('form_force_encodings');
95 $this->register_prefilter('wiki_include');
96 $this->register_prefilter('if_has_perms');
97 $this->assign('xorg_triggers', $this->_errors);
98 $this->assign('xorg_errors', $this->nb_errs());
99 $this->assign('xorg_failure', $this->_failure);
100 $this->assign('globals', $globals);
101
102 if (Env::has('json') && count($this->_jsonVars)) {
103 return $this->jsonDisplay();
104 }
105
106 if (Env::v('display') == 'light') {
107 $this->_page_type = SIMPLE;
108 } elseif (Env::v('display') == 'raw') {
109 $this->_page_type = NO_SKIN;
110 } elseif (Env::v('display') == 'full') {
111 $this->_page_typ = SKINNED;
112 }
113
114 switch ($this->_page_type) {
115 case NO_SKIN:
116 if (!($globals->debug & DEBUG_SMARTY)) {
117 error_reporting(0);
118 }
119 $this->display($this->_tpl);
120 exit;
121
122 case SIMPLE:
123 $this->assign('simple', true);
124
125 case SKINNED:
126 $this->register_modifier('escape_html', 'escape_html');
127 $this->default_modifiers = Array('@escape_html');
128 }
129 if (S::i('auth') <= AUTH_PUBLIC) {
130 $this->register_outputfilter('hide_emails');
131 }
132 $this->addJsLink('wiki.js');
133 header("Accept-Charset: utf-8");
134 if (Env::v('forceXml')) {
135 header("Content-Type: text/xml; charset=utf-8");
136 }
137
138 if (!$globals->debug) {
139 error_reporting(0);
140 $this->display($skin);
141 exit;
142 }
143
144 $this->assign('validate', true);
145 if (!($globals->debug & DEBUG_SMARTY)) {
146 error_reporting(0);
147 }
148 $START_SMARTY = microtime(true);
149 $result = $this->fetch($skin);
150 $ttime = sprintf('Temps total: %.02fs (Smarty %.02fs) - Mémoire totale : %dKo<br />',
151 microtime(true) - $TIME_BEGIN, microtime(true) - $START_SMARTY,
152 memory_get_peak_usage(true) / 1024);
153 if ($globals->debug & DEBUG_BT) {
154 PlBacktrace::clean();
155 $this->assign_by_ref('backtraces', PlBacktrace::$bt);
156 $result = str_replace('@@BACKTRACE@@', $this->fetch('skin/common.backtrace.tpl'), $result);
157 } else {
158 $result = str_replace('@@BACKTRACE@@', '', $result);
159 }
160
161 $replc = "<span class='erreur'>VALIDATION HTML INACTIVE</span><br />";
162 if ($globals->debug & DEBUG_VALID) {
163 $fd = fopen($this->compile_dir."/valid.html","w");
164 fwrite($fd, $result);
165 fclose($fd);
166
167 exec($globals->spoolroot."/bin/devel/xhtml.validate.pl ".$this->compile_dir."/valid.html", $val);
168 foreach ($val as $h) {
169 if (preg_match("/^X-W3C-Validator-Errors: (\d+)$/", $h, $m)) {
170 $replc = '<span style="color: #080;">HTML OK</span><br />';
171 if ($m[1]) {
172 $replc = "<span class='erreur'><a href='http://validator.w3.org/check?uri={$globals->baseurl}"
173 ."/valid.html&amp;ss=1#result'>{$m[1]} ERREUR(S) !!!</a></span><br />";
174 }
175 break;
176 }
177 }
178 }
179
180 echo str_replace("@HOOK@", $ttime.$replc, $result);
181 exit;
182 }
183
184 abstract public function run();
185
186 // }}}
187 // {{{ function nb_errs()
188
189 public function nb_errs()
190 {
191 return count($this->_errors['errors']);
192 }
193
194 // }}}
195 // {{{ function trig()
196
197 private function trig($msg, $type = 'errors')
198 {
199 if (!isset($this->_errors[$type])) {
200 $this->_errors[$type] = array();
201 }
202 $this->_errors[$type][] = $msg;
203 }
204
205 public function trigError($msg)
206 {
207 $this->trig($msg, 'errors');
208 }
209
210 public function trigWarning($msg)
211 {
212 $this->trig($msg, 'warnings');
213 }
214
215 public function trigSuccess($msg)
216 {
217 $this->trig($msg, 'success');
218 }
219
220 // }}}
221 // {{{ function kill()
222
223 public function kill($msg)
224 {
225 global $platal;
226
227 $this->assign('platal', $platal);
228 $this->trigError($msg);
229 $this->_failure = true;
230 $this->run();
231 }
232
233 // }}}
234 // {{{ function addJsLink
235
236 public function addJsLink($path)
237 {
238 $this->append('xorg_js', $path);
239 }
240
241 // }}}
242 // {{{ function addCssLink
243
244 public function addCssLink($path)
245 {
246 $this->append('xorg_css', $path);
247 }
248
249 // }}}
250 // {{{ function addCssInline
251
252 public function addCssInline($css)
253 {
254 if (!empty($css)) {
255 $this->append('xorg_inline_css', $css);
256 }
257 }
258
259 // }}}
260 // {{{ function setRssLink
261
262 public function setRssLink($title, $path)
263 {
264 $this->assign('xorg_rss', array('title' => $title, 'href' => $path));
265 }
266
267 // }}}
268 // {{{ function jsonDisplay
269 protected function jsonDisplay()
270 {
271 header("Content-type: text/javascript; charset=utf-8");
272 array_walk_recursive($this->_jsonVars, "escape_xorgDB");
273 $jsonbegin = Env::v('jsonBegin');
274 $jsonend = Env::v('jsonEnd');
275 if (Env::has('jsonVar')) {
276 $jsonbegin = Env::v('jsonVar').' = ';
277 $jsonend = ';';
278 } elseif (Env::has('jsonFunc')) {
279 $jsonbegin = Env::v('jsonFunc').'(';
280 $jsonend = ');';
281 }
282 echo $jsonbegin, json_encode($this->_jsonVars), $jsonend;
283 exit;
284 }
285 // }}}
286 // {{{ function jsonAssign
287 public function jsonAssign($var, $value)
288 {
289 $this->_jsonVars[$var] = $value;
290 }
291
292 // }}}
293 }
294
295 function escape_xorgDB(&$item, $key)
296 {
297 if (is_a($item, 'XOrgDBIterator')) {
298 $expanded = array();
299 while ($a = $item->next()) {
300 $expanded[] = $a;
301 }
302 $item = $expanded;
303 }
304 }
305
306 // {{{ function escape_html ()
307
308 /**
309 * default smarty plugin, used to auto-escape dangerous html.
310 *
311 * < --> &lt;
312 * > --> &gt;
313 * " --> &quot;
314 * & not followed by some entity --> &amp;
315 */
316 function escape_html($string)
317 {
318 if (is_string($string)) {
319 return htmlspecialchars($string, ENT_QUOTES, 'UTF-8');
320 } else {
321 return $string;
322 }
323 }
324
325 // }}}
326 // {{{ function at_to_globals()
327
328 /**
329 * helper
330 */
331
332 function _to_globals($s) {
333 global $globals;
334 $t = explode('.',$s);
335 if (count($t) == 1) {
336 return var_export($globals->$t[0],true);
337 } else {
338 return var_export($globals->$t[0]->$t[1],true);
339 }
340 }
341
342 /**
343 * compilation plugin used to import $globals confing through #globals.foo.bar# directives
344 */
345
346 function at_to_globals($tpl_source, &$smarty)
347 {
348 return preg_replace('/#globals\.([a-zA-Z0-9_.]+?)#/e', '_to_globals(\'\\1\')', $tpl_source);
349 }
350
351 // }}}
352 // {{{ function trimwhitespace
353
354 function trimwhitespace($source, &$smarty)
355 {
356 $tags = '(script|pre|textarea)';
357 preg_match_all("!<$tags.*?>.*?</(\\1)>!ius", $source, $tagsmatches);
358 $source = preg_replace("!<$tags.*?>.*?</(\\1)>!ius", "&&&tags&&&", $source);
359
360 // remove all leading spaces, tabs and carriage returns NOT
361 // preceeded by a php close tag.
362 $source = preg_replace('/((?<!\?>)\n)[\s]+/m', '\1', $source);
363 $source = preg_replace("!&&&tags&&&!e", 'array_shift($tagsmatches[0])', $source);
364
365 return $source;
366 }
367
368 // }}}
369 // {{{ function wiki_include
370
371 function wiki_include($source, &$smarty)
372 {
373 return preg_replace('/\{include( [^}]*)? wiki=([^} ]+)(.*?)\}/ui',
374 '{include\1 file="../spool/wiki.d/cache_\2.tpl"\3 included=1}',
375 $source);
376 }
377
378 // }}}
379 //{{{ function hasPerm
380
381 function if_has_perms($source, &$smarty)
382 {
383 $source = preg_replace('/\{if([^}]*) (\!?)hasPerms\(([^)]+)\)([^}]*)\}/',
384 '{if\1 \2$smarty.session.perms->hasFlagCombination(\3)\4}',
385 $source);
386 return preg_replace('/\{if([^}]*) (\!?)hasPerm\(([^)]+)\)([^}]*)\}/',
387 '{if\1 \2($smarty.session.perms && $smarty.session.perms->hasFlag(\3))\4}',
388 $source);
389 }
390
391 // }}}
392 // {{{
393
394 function form_force_encodings($source, &$smarty)
395 {
396 return preg_replace('/<form[^\w]/',
397 '\0 accept-charset="utf-8" ',
398 $source);
399 }
400
401 // }}}
402 // {{{ function hide_emails
403
404 function _hide_email($source)
405 {
406 $source = str_replace("\n", '', $source);
407 return '<script type="text/javascript">//<![CDATA[' . "\n" .
408 'Nix.decode("' . addslashes(str_rot13($source)) . '");' . "\n" .
409 '//]]></script>';
410 }
411
412 function hide_emails($source, &$smarty)
413 {
414 if (!strpos($source, '@')) {
415 return $source;
416 }
417
418 //prevent email replacement in <script> and <textarea>
419 $tags = '(script|textarea|select)';
420 preg_match_all("!<$tags.*?>.*?</(\\1)>!ius", $source, $tagsmatches);
421 $source = preg_replace("!<$tags.*?>.*?</(\\1)>!ius", "&&&tags&&&", $source);
422
423 //catch all emails in <a href="mailto:...">
424 preg_match_all("!<a[^>]+href=[\"'][^\"']*[-a-z0-9+_.]+@[-a-z0-9_.]+[^\"']*[\"'].*?>.*?</a>!ius", $source, $ahref);
425 $source = preg_replace("!<a[^>]+href=[\"'][^\"']*[-a-z0-9+_.]+@[-a-z0-9_.]+[^\"']*[\"'].*?>.*?</a>!ius", '&&&ahref&&&', $source);
426
427 //prevant replacement in tag attributes
428 preg_match_all("!<[^>]+[-a-z0-9_+.]+@[-a-z0-9_.]+.+?>!ius", $source, $misc);
429 $source = preg_replace("!<[^>]+[-a-z0-9_+.]+@[-a-z0-9_.]+.+?>!ius", '&&&misc&&&', $source);
430
431 //catch !
432 $source = preg_replace('!([-a-z0-9_+.]+@[-a-z0-9_.]+)!iue', '_hide_email("\1")', $source);
433 $source = preg_replace('!&&&ahref&&&!e', '_hide_email(array_shift($ahref[0]))', $source);
434
435 // restore data
436 $source = preg_replace('!&&&misc&&&!e', 'array_shift($misc[0])', $source);
437 $source = preg_replace("!&&&tags&&&!e", 'array_shift($tagsmatches[0])', $source);
438
439 return $source;
440 }
441
442 // }}}
443
444 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
445 ?>