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