classes/plpage.php

   1 <?php
   2 /***************************************************************************
   3  *  Copyright (C) 2003-2011 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 if (!@include_once 'smarty/libs/Smarty.class.php') {
  23     require_once 'smarty/Smarty.class.php';
  24 }
  25
  26 abstract class PlPage extends Smarty
  27 {
  28     private $_page_type;
  29     private $_tpl;
  30     private $_errors;
  31     private $_failure;
  32     private $_jsonVars;
  33
  34     // {{{ function PlPage()
  35
  36     public function __construct()
  37     {
  38         parent::Smarty();
  39
  40         global $globals;
  41
  42         $this->caching       = false;
  43         $this->config_overwrite = false;
  44         $this->use_sub_dirs  = false;
  45         $this->template_dir  = $globals->spoolroot . '/templates/';
  46         $this->compile_dir   = $globals->spoolroot . '/spool/templates_c/';
  47         array_unshift($this->plugins_dir,
  48                       $globals->spoolroot . '/core/plugins/',
  49                       $globals->spoolroot . '/plugins/');
  50         $this->config_dir    = $globals->spoolroot . '/configs/';
  51
  52         $this->compile_check = !empty($globals->debug) || $globals->smarty_autocompile;
  53
  54         $this->_errors    = array('errors' => array());
  55         $this->_jsonVars  = array();
  56         $this->_failure   = false;
  57
  58         if ($globals->mode != 'rw') {
  59             $this->trigError("En raison d'une maintenance, une partie des fonctionnalités du site est"
  60                              . " actuellement désactivée, en particulier aucune donnée ne sera sauvegardée");
  61         }
  62         $this->register_prefilter('at_to_globals');
  63         $this->register_prefilter('get_class_constants');
  64     }
  65
  66     // }}}
  67     // {{{ function changeTpl()
  68
  69     public function changeTpl($tpl, $type = SKINNED)
  70     {
  71         $this->_tpl       = $tpl;
  72         $this->_page_type = $type;
  73         $this->assign('pl_tpl', $tpl);
  74     }
  75
  76     // }}}
  77     // {{{ function getCoreTpl()
  78
  79     public static function getCoreTpl($tpl)
  80     {
  81         global $globals;
  82         return $globals->spoolroot . '/core/templates/' . $tpl;
  83     }
  84
  85     // }}}
  86     // {{{ function coreTpl()
  87
  88     /** Use a template from the core.
  89      */
  90     public function coreTpl($tpl, $type = SKINNED)
  91     {
  92         global $globals;
  93         $this->changeTpl(self::getCoreTpl($tpl), $type);
  94     }
  95
  96     // }}}
  97     // {{{ function raw()
  98
  99     public function raw()
 100     {
 101         global $globals;
 102         $this->assign('globals', $globals);
 103         return $this->fetch($this->_tpl);
 104     }
 105
 106     // }}}
 107     // {{{ function _run()
 108
 109     protected function _run($skin)
 110     {
 111         global $globals, $platal, $TIME_BEGIN;
 112
 113         Platal::session()->close();
 114
 115         $this->register_prefilter('trimwhitespace');
 116         $this->register_prefilter('form_force_encodings');
 117         $this->register_prefilter('wiki_include');
 118         $this->register_prefilter('core_include');
 119         $this->register_prefilter('if_rewrites');
 120         $this->assign('pl_triggers', $this->_errors);
 121         $this->assign('pl_errors', $this->nb_errs());
 122         $this->assign('pl_failure', $this->_failure);
 123         $this->assign_by_ref('platal', $platal);
 124         $this->assign_by_ref('globals', $globals);
 125
 126         if (Env::has('json') && count($this->_jsonVars)) {
 127             return $this->jsonDisplay();
 128         }
 129
 130         $display = Env::s('display');
 131         if ($display == 'light' && $this->_page_type == SKINNED) {
 132             $this->_page_type = SIMPLE;
 133         } elseif ($display == 'raw') {
 134             $this->_page_type = NO_SKIN;
 135         } elseif ($display == 'full') {
 136             $this->_page_type = SKINNED;
 137         }
 138
 139         if ($this->_page_type == SIMPLE) {
 140             $this->assign('simple', true);
 141         } else {
 142             $this->assign('simple', false);
 143         }
 144
 145         switch ($this->_page_type) {
 146           case NO_SKIN:
 147             if (!($globals->debug & DEBUG_SMARTY)) {
 148                 error_reporting(0);
 149             }
 150             $this->display($this->_tpl);
 151             exit;
 152
 153           case SIMPLE:
 154           case SKINNED:
 155             $this->register_modifier('escape_html', 'escape_html');
 156             $this->default_modifiers = Array('@escape_html');
 157         }
 158         if (S::i('auth') <= AUTH_PUBLIC) {
 159             $this->register_outputfilter('hide_emails');
 160         }
 161         header("Accept-Charset: utf-8");
 162         if (Env::v('forceXml')) {
 163             pl_content_headers("text/xml");
 164         }
 165
 166         if (!$globals->debug) {
 167             error_reporting(0);
 168             $this->display($skin);
 169             pl_print_errors(true);
 170             exit;
 171         }
 172
 173         $this->assign('validate', true);
 174         if (!($globals->debug & DEBUG_SMARTY)) {
 175             error_reporting(0);
 176         }
 177         $START_SMARTY = microtime(true);
 178         $result = $this->fetch($skin);
 179         $ttime  = sprintf('Temps total: %.02fs (Smarty %.02fs) - Mémoire totale : %dKo<br />',
 180                           microtime(true) - $TIME_BEGIN, microtime(true) - $START_SMARTY,
 181                           memory_get_peak_usage(true) / 1024);
 182         if ($globals->debug & DEBUG_BT) {
 183             PlBacktrace::clean();
 184             $this->assign_by_ref('backtraces', PlBacktrace::$bt);
 185             $result = str_replace('@@BACKTRACE@@',
 186                                   $this->fetch(self::getCoreTpl('backtrace.tpl')),
 187                                   $result);
 188         } else {
 189             $result = str_replace('@@BACKTRACE@@', '', $result);
 190         }
 191
 192         $replc  = "<span class='erreur'>VALIDATION HTML INACTIVE</span><br />";
 193         if ($globals->debug & DEBUG_VALID) {
 194             global $platal;
 195             $fd = fopen($this->compile_dir."/valid.html","w");
 196             fwrite($fd, $result);
 197             fclose($fd);
 198
 199             $replc = '<span id="html_valid"><span style="color: #860">VALIDATION HTML EN COURS</span></span>'
 200                    . '<script type="text/javascript">$("#html_valid").updateHtml("validator");</script>'
 201                    . '<br />';
 202         }
 203
 204         echo str_replace("@HOOK@", $ttime.$replc, $result);
 205         exit;
 206     }
 207
 208     abstract public function run();
 209
 210     // }}}
 211     // {{{ function nb_errs()
 212
 213     public function nb_errs()
 214     {
 215         return count($this->_errors['errors']);
 216     }
 217
 218     // }}}
 219     // {{{ function trig()
 220
 221     private function trig($msg, $type = 'errors')
 222     {
 223         if (!isset($this->_errors[$type])) {
 224             $this->_errors[$type] = array();
 225         }
 226         $this->_errors[$type][] = $msg;
 227     }
 228
 229     public function trigError($msg)
 230     {
 231         $this->trig($msg, 'errors');
 232     }
 233
 234     public function trigWarning($msg)
 235     {
 236         $this->trig($msg, 'warnings');
 237     }
 238
 239     public function trigSuccess($msg)
 240     {
 241         $this->trig($msg, 'success');
 242     }
 243
 244     // }}}
 245     // {{{ function trigRedirect
 246
 247     // Acts as trig(), but replaces the template with a simple one displaying
 248     // the error messages and a "continue" link.
 249     private function trigRedirect($msg, $continue, $type = 'errors')
 250     {
 251         $this->trig($msg, $type);
 252         $this->coreTpl('msgredirect.tpl');
 253         $this->assign('continue', $continue);
 254         $this->run();
 255     }
 256
 257     public function trigErrorRedirect($msg, $continue)
 258     {
 259         $this->trigRedirect($msg, $continue, 'errors');
 260     }
 261
 262     public function trigWarningRedirect($msg, $continue)
 263     {
 264         $this->trigRedirect($msg, $continue, 'warnings');
 265     }
 266
 267     public function trigSuccessRedirect($msg, $continue)
 268     {
 269         $this->trigRedirect($msg, $continue, 'success');
 270     }
 271
 272     // }}}
 273     // {{{ function kill()
 274
 275     public function kill($msg, $type = 'errors')
 276     {
 277         // PHP is used on command line... do not run the whole page stuff.
 278         if (php_sapi_name() == 'cli') {
 279             echo $msg . "\n";
 280             exit(-1);
 281         }
 282
 283         global $platal;
 284
 285         $this->trig($msg, $type);
 286         $this->_failure = true;
 287         $this->run();
 288     }
 289
 290     public function killError($msg)
 291     {
 292         $this->kill($msg, 'errors');
 293     }
 294
 295     public function killWarning($msg)
 296     {
 297         $this->kill($msg, 'warnings');
 298     }
 299
 300     public function killSuccess($msg)
 301     {
 302         $this->kill($msg, 'success');
 303     }
 304
 305     // }}}
 306     // {{{ function setTitle
 307
 308     public function setTitle($title)
 309     {
 310         global $globals;
 311         if (isset($globals->core->sitename)) {
 312             $title = $globals->core->sitename . ' :: ' . $title;
 313         }
 314         $this->assign('pl_title', $title);
 315     }
 316
 317     // }}}
 318     // {{{ function addJsLink
 319
 320     public function addJsLink($filename, $internal = true, $static_content = true)
 321     {
 322         if ($internal) {
 323             if ($static_content) {
 324                 $this->append('pl_js', pl_static_content_path("javascript/", $filename));
 325             } else {
 326                 $this->append('pl_js', "javascript/$filename");
 327             }
 328         } else {
 329             $this->append('pl_js', $filename);
 330         }
 331     }
 332
 333     // }}}
 334     // {{{ function addCssLink
 335
 336     public function addCssLink($path)
 337     {
 338         $this->append('pl_css', $path);
 339     }
 340
 341     // }}}
 342     // {{{ function addLink
 343
 344     public function addLink($rel, $path)
 345     {
 346         $this->append('pl_link', array('rel' => $rel, 'href' => $path));
 347     }
 348
 349
 350     // }}}
 351     // {{{ function addCssInline
 352
 353     public function addCssInline($css)
 354     {
 355         if (!empty($css)) {
 356             $this->append('pl_inline_css', $css);
 357         }
 358     }
 359
 360     // }}}
 361     // {{{ function setRssLink
 362
 363     public function setRssLink($title, $path)
 364     {
 365         $this->assign('pl_rss', array('title' => $title, 'href' => $path));
 366     }
 367
 368     // }}}
 369     // {{{ function jsonDisplay
 370     protected function jsonDisplay()
 371     {
 372         pl_content_headers("text/javascript");
 373         if (!empty(PlBacktrace::$bt)) {
 374             $this->jsonAssign('pl_backtraces', PlBacktrace::$bt);
 375         }
 376         array_walk_recursive($this->_jsonVars, "escape_XDB");
 377         $jsonbegin = Env::v('jsonBegin');
 378         $jsonend = Env::v('jsonEnd');
 379         if (Env::has('jsonVar')) {
 380             $jsonbegin = Env::v('jsonVar').' = ';
 381             $jsonend = ';';
 382         } elseif (Env::has('jsonFunc')) {
 383             $jsonbegin = Env::v('jsonFunc').'(';
 384             $jsonend = ');';
 385         }
 386         echo $jsonbegin, json_encode($this->_jsonVars), $jsonend;
 387         exit;
 388     }
 389     // }}}
 390
 391     public function runJSon()
 392     {
 393         pl_content_headers("text/javascript");
 394         if (!empty(PlBacktrace::$bt)) {
 395             $this->jsonAssign('pl_backtraces', PlBacktrace::$bt);
 396         }
 397         echo json_encode($this->_jsonVars);
 398         exit;
 399     }
 400
 401     // {{{ function jsonAssign
 402     public function jsonAssign($var, $value)
 403     {
 404         $this->_jsonVars[$var] = $value;
 405     }
 406
 407     // }}}
 408 }
 409
 410 function escape_XDB(&$item, $key)
 411 {
 412     if ($item instanceof XDBIterator) {
 413         $expanded = array();
 414         while ($a = $item->next()) {
 415             $expanded[] = $a;
 416         }
 417         $item = $expanded;
 418     }
 419 }
 420
 421 // {{{ function escape_html ()
 422
 423 /**
 424  * default smarty plugin, used to auto-escape dangerous html.
 425  *
 426  * < --> &lt;
 427  * > --> &gt;
 428  * " --> &quot;
 429  * & not followed by some entity --> &amp;
 430  */
 431 function escape_html($string)
 432 {
 433     if (is_string($string)) {
 434         return htmlspecialchars($string, ENT_QUOTES, 'UTF-8');
 435     } else {
 436         return $string;
 437     }
 438 }
 439
 440 // }}}
 441 // {{{ function at_to_globals()
 442
 443 /**
 444  * helper
 445  */
 446
 447 function _to_globals($s) {
 448     global $globals;
 449     $t = explode('.',$s);
 450     if (count($t) == 1) {
 451         return var_export($globals->$t[0],true);
 452     } else {
 453         return var_export($globals->$t[0]->$t[1],true);
 454     }
 455 }
 456
 457 /**
 458  * compilation plugin used to import $globals confing through #globals.foo.bar# directives
 459  */
 460
 461 function at_to_globals($tpl_source, $smarty)
 462 {
 463     return preg_replace('/#globals\.([a-zA-Z0-9_.]+?)#/e', '_to_globals(\'\\1\')', $tpl_source);
 464 }
 465
 466 // }}}
 467 // {{{ function get_class_constants()
 468
 469 /**
 470  * helper
 471  */
 472
 473 function _get_class_const($class, $const)
 474 {
 475     return var_export(constant($class . '::' . $const), true);
 476 }
 477
 478 /**
 479  * Compilation plugin used to import class constants through calls to #Class::CONSTANT#
 480  */
 481
 482 function get_class_constants($tpl_source, $smarty)
 483 {
 484     return preg_replace('/#([a-zA-Z0-9_]+)::([A-Z0-9_]+)#/e', '_get_class_const(\'\\1\',\'\\2\')', $tpl_source);
 485 }
 486
 487 // }}}
 488 // {{{  function trimwhitespace
 489
 490 function trimwhitespace($source, $smarty)
 491 {
 492     $tags = '(script|pre|textarea)';
 493     preg_match_all("!<$tags.*?>.*?</(\\1)>!ius", $source, $tagsmatches);
 494     $source = preg_replace("!<$tags.*?>.*?</(\\1)>!ius", "&&&tags&&&", $source);
 495
 496     // remove all leading spaces, tabs and carriage returns NOT
 497     // preceeded by a php close tag.
 498     $source = preg_replace('/((?<!\?>)\n)[\s]+/m', '\1', $source);
 499     $source = preg_replace("!&&&tags&&&!e",  'array_shift($tagsmatches[0])', $source);
 500
 501     return $source;
 502 }
 503
 504 // }}}
 505 // {{{ function wiki_include
 506
 507 function wiki_include($source, $smarty)
 508 {
 509     global $globals;
 510     return preg_replace('/\{include( [^}]*)? wiki=([^} ]+)(.*?)\}/ui',
 511                         '{include\1 file="' . $globals->spoolroot . '/spool/wiki.d/cache_\2.tpl"\3 included=1}',
 512                         $source);
 513 }
 514
 515 function core_include($source, $smarty)
 516 {
 517     global $globals;
 518     return preg_replace('/\{include( [^}]*)? core=([^} ]+)(.*?)\}/ui',
 519                         '{include\1 file="' . $globals->spoolroot . '/core/templates/\2"\3}',
 520                         $source);
 521 }
 522
 523 // }}}
 524 //{{{ function hasPerm
 525
 526 function if_rewrites($source, $smarty)
 527 {
 528     $perms = 'isset($smarty.session.user|smarty:nodefaults) && $smarty.session.user';
 529     return preg_replace(array('/\{(else)?if([^}]*) (\!?)hasPerms?\(([^)]+)\)([^}]*)\}/',
 530                               '/\{(else)?if([^}]*) (\!?)t\(([^)]+)\)([^}]*)\}/'),
 531                         array('{\1if\2 \3(' . $perms . '->checkPerms(\4))\5}',
 532                               '{\1if\2 \3(isset(\4|smarty:nodefaults) && (\4|smarty:nodefaults))\5}'),
 533                         $source);
 534 }
 535
 536 // }}}
 537 // {{{
 538
 539 function form_force_encodings($source, $smarty)
 540 {
 541     return preg_replace('/<form[^\w]/',
 542                         '\0 accept-charset="utf-8" ',
 543                         $source);
 544 }
 545
 546 // }}}
 547 // {{{ function hide_emails
 548
 549 function _hide_email($source)
 550 {
 551     $source = str_replace("\n", '', $source);
 552     return '<script type="text/javascript">//<![CDATA[' . "\n" .
 553         'Nix.decode("' . addslashes(str_rot13($source)) . '");' . "\n" .
 554         '//]]></script>';
 555 }
 556
 557 function hide_emails($source, $smarty)
 558 {
 559     if (!strpos($source, '@')) {
 560         return $source;
 561     }
 562
 563     //prevent email replacement in <script> and <textarea>
 564     $tags = '(script|textarea|select)';
 565     preg_match_all("!<$tags.*?>.*?</(\\1)>!ius", $source, $tagsmatches);
 566     $source = preg_replace("!<$tags.*?>.*?</(\\1)>!ius", "&&&tags&&&", $source);
 567
 568     //catch all emails in <a href="mailto:...">
 569     preg_match_all("!<a[^>]+href=[\"'][^\"']*[-a-z0-9+_.]+@[-a-z0-9_.]+[^\"']*[\"'].*?>.*?</a>!ius", $source, $ahref);
 570     $source = preg_replace("!<a[^>]+href=[\"'][^\"']*[-a-z0-9+_.]+@[-a-z0-9_.]+[^\"']*[\"'].*?>.*?</a>!ius", '&&&ahref&&&', $source);
 571
 572     //prevant replacement in tag attributes
 573     preg_match_all("!<[^>]+[-a-z0-9_+.]+@[-a-z0-9_.]+.+?>!ius", $source, $misc);
 574     $source = preg_replace("!<[^>]+[-a-z0-9_+.]+@[-a-z0-9_.]+.+?>!ius", '&&&misc&&&', $source);
 575
 576     //catch !
 577     $source = preg_replace('!([-a-z0-9_+.]+@[-a-z0-9_.]+)!iue', '_hide_email("\1")', $source);
 578     $source = preg_replace('!&&&ahref&&&!e', '_hide_email(array_shift($ahref[0]))', $source);
 579
 580     // restore data
 581     $source = preg_replace('!&&&misc&&&!e', 'array_shift($misc[0])', $source);
 582     $source = preg_replace("!&&&tags&&&!e",  'array_shift($tagsmatches[0])', $source);
 583
 584     return $source;
 585 }
 586
 587 // }}}
 588
 589 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
 590 ?>