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