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