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 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         Platal::session()->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('pl_triggers', $this->_errors);
  98         $this->assign('pl_errors', $this->nb_errs());
  99         $this->assign('pl_failure', $this->_failure);
 100         $this->assign_by_ref('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         // PHP is used on command line... do not run the whole page stuff.
 226         if (php_sapi_name() == 'cli') {
 227             echo $msg . "\n";
 228             exit;
 229         }
 230
 231         global $platal;
 232
 233         $this->assign('platal', $platal);
 234         $this->trigError($msg);
 235         $this->_failure = true;
 236         $this->run();
 237     }
 238
 239     // }}}
 240     // {{{ function setTitle
 241
 242     public function setTitle($title)
 243     {
 244         global $globals;
 245         if (isset($globals->core->sitename)) {
 246             $title = $globals->core->sitename . ' :: ' . $title;
 247         }
 248         $this->assign('pl_title', $title);
 249     }
 250
 251     // }}}
 252     // {{{ function addJsLink
 253
 254     public function addJsLink($path)
 255     {
 256         $this->append('pl_js', $path);
 257     }
 258
 259     // }}}
 260     // {{{ function addCssLink
 261
 262     public function addCssLink($path)
 263     {
 264         $this->append('pl_css', $path);
 265     }
 266
 267     // }}}
 268     // {{{ function addCssInline
 269
 270     public function addCssInline($css)
 271     {
 272         if (!empty($css)) {
 273             $this->append('pl_inline_css', $css);
 274         }
 275     }
 276
 277     // }}}
 278     // {{{ function setRssLink
 279
 280     public function setRssLink($title, $path)
 281     {
 282         $this->assign('pl_rss', array('title' => $title, 'href' => $path));
 283     }
 284
 285     // }}}
 286     // {{{ function jsonDisplay
 287     protected function jsonDisplay()
 288     {
 289         header("Content-type: text/javascript; charset=utf-8");
 290         array_walk_recursive($this->_jsonVars, "escape_xorgDB");
 291         $jsonbegin = Env::v('jsonBegin');
 292         $jsonend = Env::v('jsonEnd');
 293         if (Env::has('jsonVar')) {
 294             $jsonbegin = Env::v('jsonVar').' = ';
 295             $jsonend = ';';
 296         } elseif (Env::has('jsonFunc')) {
 297             $jsonbegin = Env::v('jsonFunc').'(';
 298             $jsonend = ');';
 299         }
 300         echo $jsonbegin, json_encode($this->_jsonVars), $jsonend;
 301         exit;
 302     }
 303     // }}}
 304     // {{{ function jsonAssign
 305     public function jsonAssign($var, $value)
 306     {
 307         $this->_jsonVars[$var] = $value;
 308     }
 309
 310     // }}}
 311 }
 312
 313 function escape_xorgDB(&$item, $key)
 314 {
 315     if (is_a($item, 'XOrgDBIterator')) {
 316         $expanded = array();
 317         while ($a = $item->next()) {
 318             $expanded[] = $a;
 319         }
 320         $item = $expanded;
 321     }
 322 }
 323
 324 // {{{ function escape_html ()
 325
 326 /**
 327  * default smarty plugin, used to auto-escape dangerous html.
 328  *
 329  * < --> &lt;
 330  * > --> &gt;
 331  * " --> &quot;
 332  * & not followed by some entity --> &amp;
 333  */
 334 function escape_html($string)
 335 {
 336     if (is_string($string)) {
 337         return htmlspecialchars($string, ENT_QUOTES, 'UTF-8');
 338     } else {
 339         return $string;
 340     }
 341 }
 342
 343 // }}}
 344 // {{{ function at_to_globals()
 345
 346 /**
 347  * helper
 348  */
 349
 350 function _to_globals($s) {
 351     global $globals;
 352     $t = explode('.',$s);
 353     if (count($t) == 1) {
 354         return var_export($globals->$t[0],true);
 355     } else {
 356         return var_export($globals->$t[0]->$t[1],true);
 357     }
 358 }
 359
 360 /**
 361  * compilation plugin used to import $globals confing through #globals.foo.bar# directives
 362  */
 363
 364 function at_to_globals($tpl_source, &$smarty)
 365 {
 366     return preg_replace('/#globals\.([a-zA-Z0-9_.]+?)#/e', '_to_globals(\'\\1\')', $tpl_source);
 367                         }
 368
 369                         // }}}
 370                         // {{{  function trimwhitespace
 371
 372                         function trimwhitespace($source, &$smarty)
 373                         {
 374                         $tags = '(script|pre|textarea)';
 375                         preg_match_all("!<$tags.*?>.*?</(\\1)>!ius", $source, $tagsmatches);
 376                         $source = preg_replace("!<$tags.*?>.*?</(\\1)>!ius", "&&&tags&&&", $source);
 377
 378                         // remove all leading spaces, tabs and carriage returns NOT
 379                         // preceeded by a php close tag.
 380                         $source = preg_replace('/((?<!\?>)\n)[\s]+/m', '\1', $source);
 381                         $source = preg_replace("!&&&tags&&&!e",  'array_shift($tagsmatches[0])', $source);
 382
 383                         return $source;
 384                         }
 385
 386                         // }}}
 387                         // {{{ function wiki_include
 388
 389 function wiki_include($source, &$smarty)
 390 {
 391     return preg_replace('/\{include( [^}]*)? wiki=([^} ]+)(.*?)\}/ui',
 392                         '{include\1 file="../spool/wiki.d/cache_\2.tpl"\3 included=1}',
 393                         $source);
 394 }
 395
 396 // }}}
 397 //{{{ function hasPerm
 398
 399 function if_has_perms($source, &$smarty)
 400 {
 401     $source = preg_replace('/\{if([^}]*) (\!?)hasPerms\(([^)]+)\)([^}]*)\}/',
 402     '{if\1 \2$smarty.session.perms->hasFlagCombination(\3)\4}',
 403     $source);
 404 return preg_replace('/\{if([^}]*) (\!?)hasPerm\(([^)]+)\)([^}]*)\}/',
 405        '{if\1 \2($smarty.session.perms && $smarty.session.perms->hasFlag(\3))\4}',
 406        $source);
 407 }
 408
 409 // }}}
 410 // {{{
 411
 412 function form_force_encodings($source, &$smarty)
 413 {
 414     return preg_replace('/<form[^\w]/',
 415                         '\0 accept-charset="utf-8" ',
 416                         $source);
 417 }
 418
 419 // }}}
 420 // {{{ function hide_emails
 421
 422 function _hide_email($source)
 423 {
 424     $source = str_replace("\n", '', $source);
 425     return '<script type="text/javascript">//<![CDATA[' . "\n" .
 426         'Nix.decode("' . addslashes(str_rot13($source)) . '");' . "\n" .
 427         '//]]></script>';
 428 }
 429
 430 function hide_emails($source, &$smarty)
 431 {
 432     if (!strpos($source, '@')) {
 433         return $source;
 434     }
 435
 436     //prevent email replacement in <script> and <textarea>
 437     $tags = '(script|textarea|select)';
 438     preg_match_all("!<$tags.*?>.*?</(\\1)>!ius", $source, $tagsmatches);
 439     $source = preg_replace("!<$tags.*?>.*?</(\\1)>!ius", "&&&tags&&&", $source);
 440
 441     //catch all emails in <a href="mailto:...">
 442     preg_match_all("!<a[^>]+href=[\"'][^\"']*[-a-z0-9+_.]+@[-a-z0-9_.]+[^\"']*[\"'].*?>.*?</a>!ius", $source, $ahref);
 443     $source = preg_replace("!<a[^>]+href=[\"'][^\"']*[-a-z0-9+_.]+@[-a-z0-9_.]+[^\"']*[\"'].*?>.*?</a>!ius", '&&&ahref&&&', $source);
 444
 445     //prevant replacement in tag attributes
 446     preg_match_all("!<[^>]+[-a-z0-9_+.]+@[-a-z0-9_.]+.+?>!ius", $source, $misc);
 447     $source = preg_replace("!<[^>]+[-a-z0-9_+.]+@[-a-z0-9_.]+.+?>!ius", '&&&misc&&&', $source);
 448
 449     //catch !
 450     $source = preg_replace('!([-a-z0-9_+.]+@[-a-z0-9_.]+)!iue', '_hide_email("\1")', $source);
 451     $source = preg_replace('!&&&ahref&&&!e', '_hide_email(array_shift($ahref[0]))', $source);
 452
 453     // restore data
 454     $source = preg_replace('!&&&misc&&&!e', 'array_shift($misc[0])', $source);
 455     $source = preg_replace("!&&&tags&&&!e",  'array_shift($tagsmatches[0])', $source);
 456
 457     return $source;
 458 }
 459
 460 // }}}
 461
 462 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
 463 ?>