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