Add interface PlIteraface and the corresponding abstract class
[platal.git] / classes / plpage.php
index 175fc05..63ece95 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /***************************************************************************
- *  Copyright (C) 2003-2008 Polytechnique.org                              *
+ *  Copyright (C) 2003-2010 Polytechnique.org                              *
  *  http://opensource.polytechnique.org/                                   *
  *                                                                         *
  *  This program is free software; you can redistribute it and/or modify   *
@@ -19,7 +19,9 @@
  *  59 Temple Place, Suite 330, Boston, MA  02111-1307  USA                *
  ***************************************************************************/
 
-require_once 'smarty/libs/Smarty.class.php';
+if (!@include_once 'smarty/libs/Smarty.class.php') {
+    require_once 'smarty/Smarty.class.php';
+}
 
 abstract class PlPage extends Smarty
 {
@@ -47,18 +49,17 @@ abstract class PlPage extends Smarty
                       $globals->spoolroot . '/plugins/');
         $this->config_dir    = $globals->spoolroot . '/configs/';
 
-        $this->compile_check = !empty($globals->debug);
+        $this->compile_check = !empty($globals->debug) || $globals->smarty_autocompile;
 
         $this->_errors    = array('errors' => array());
         $this->_jsonVars  = array();
         $this->_failure   = false;
 
         if ($globals->mode != 'rw') {
-            $this->trigError("En raison d'une maintenance, une partie des fonctionnalités du site sont"
-                             . " actuellement désactivée, en particuliers aucune donnée ne sera sauvegardée");
+            $this->trigError("En raison d'une maintenance, une partie des fonctionnalités du site est"
+                             . " actuellement désactivée, en particulier aucune donnée ne sera sauvegardée");
         }
         $this->register_prefilter('at_to_globals');
-        $this->addJsLink('jquery.js');
     }
 
     // }}}
@@ -72,6 +73,26 @@ abstract class PlPage extends Smarty
     }
 
     // }}}
+    // {{{ function getCoreTpl()
+
+    public static function getCoreTpl($tpl)
+    {
+        global $globals;
+        return $globals->spoolroot . '/core/templates/' . $tpl;
+    }
+
+    // }}}
+    // {{{ function coreTpl()
+
+    /** Use a template from the core.
+     */
+    public function coreTpl($tpl, $type = SKINNED)
+    {
+        global $globals;
+        $this->changeTpl(self::getCoreTpl($tpl), $type);
+    }
+
+    // }}}
     // {{{ function raw()
 
     public function raw()
@@ -86,17 +107,19 @@ abstract class PlPage extends Smarty
 
     protected function _run($skin)
     {
-        global $globals, $TIME_BEGIN;
+        global $globals, $platal, $TIME_BEGIN;
 
         Platal::session()->close();
 
         $this->register_prefilter('trimwhitespace');
         $this->register_prefilter('form_force_encodings');
         $this->register_prefilter('wiki_include');
-        $this->register_prefilter('if_has_perms');
+        $this->register_prefilter('core_include');
+        $this->register_prefilter('if_rewrites');
         $this->assign('pl_triggers', $this->_errors);
         $this->assign('pl_errors', $this->nb_errs());
         $this->assign('pl_failure', $this->_failure);
+        $this->assign_by_ref('platal', $platal);
         $this->assign_by_ref('globals', $globals);
 
         if (Env::has('json') && count($this->_jsonVars)) {
@@ -111,6 +134,12 @@ abstract class PlPage extends Smarty
             $this->_page_typ = SKINNED;
         }
 
+        if ($this->_page_type == SIMPLE) {
+            $this->assign('simple', true);
+        } else {
+            $this->assign('simple', false);
+        }
+
         switch ($this->_page_type) {
           case NO_SKIN:
             if (!($globals->debug & DEBUG_SMARTY)) {
@@ -120,8 +149,6 @@ abstract class PlPage extends Smarty
             exit;
 
           case SIMPLE:
-            $this->assign('simple', true);
-
           case SKINNED:
             $this->register_modifier('escape_html', 'escape_html');
             $this->default_modifiers = Array('@escape_html');
@@ -129,10 +156,9 @@ abstract class PlPage extends Smarty
         if (S::i('auth') <= AUTH_PUBLIC) {
             $this->register_outputfilter('hide_emails');
         }
-        $this->addJsLink('wiki.js');
         header("Accept-Charset: utf-8");
         if (Env::v('forceXml')) {
-            header("Content-Type: text/xml; charset=utf-8");
+            pl_content_headers("text/xml");
         }
 
         if (!$globals->debug) {
@@ -153,7 +179,9 @@ abstract class PlPage extends Smarty
         if ($globals->debug & DEBUG_BT) {
             PlBacktrace::clean();
             $this->assign_by_ref('backtraces', PlBacktrace::$bt);
-            $result = str_replace('@@BACKTRACE@@', $this->fetch('skin/common.backtrace.tpl'), $result);
+            $result = str_replace('@@BACKTRACE@@',
+                                  $this->fetch(self::getCoreTpl('backtrace.tpl')),
+                                  $result);
         } else {
             $result = str_replace('@@BACKTRACE@@', '', $result);
         }
@@ -218,24 +246,66 @@ abstract class PlPage extends Smarty
     }
 
     // }}}
+    // {{{ function trigRedirect
+
+    // Acts as trig(), but replaces the template with a simple one displaying
+    // the error messages and a "continue" link.
+    private function trigRedirect($msg, $continue, $type = 'errors')
+    {
+        $this->trig($msg, $type);
+        $this->coreTpl('msgredirect.tpl');
+        $this->assign('continue', $continue);
+        $this->run();
+    }
+
+    public function trigErrorRedirect($msg, $continue)
+    {
+        $this->trigRedirect($msg, $continue, 'errors');
+    }
+
+    public function trigWarningRedirect($msg, $continue)
+    {
+        $this->trigRedirect($msg, $continue, 'warnings');
+    }
+
+    public function trigSuccessRedirect($msg, $continue)
+    {
+        $this->trigRedirect($msg, $continue, 'success');
+    }
+
+    // }}}
     // {{{ function kill()
 
-    public function kill($msg)
+    public function kill($msg, $type = 'errors')
     {
         // PHP is used on command line... do not run the whole page stuff.
         if (php_sapi_name() == 'cli') {
             echo $msg . "\n";
-            exit;
+            exit(-1);
         }
 
         global $platal;
 
-        $this->assign('platal', $platal);
-        $this->trigError($msg);
+        $this->trig($msg, $type);
         $this->_failure = true;
         $this->run();
     }
 
+    public function killError($msg)
+    {
+        $this->kill($msg, 'errors');
+    }
+
+    public function killWarning($msg)
+    {
+        $this->kill($msg, 'warnings');
+    }
+
+    public function killSuccess($msg)
+    {
+        $this->kill($msg, 'success');
+    }
+
     // }}}
     // {{{ function setTitle
 
@@ -251,9 +321,13 @@ abstract class PlPage extends Smarty
     // }}}
     // {{{ function addJsLink
 
-    public function addJsLink($path)
+    public function addJsLink($filename, $static_content = true)
     {
-        $this->append('pl_js', $path);
+        if ($static_content) {
+            $this->append('pl_js', pl_static_content_path("javascript/", $filename));
+        } else {
+            $this->append('pl_js', "javascript/$filename");
+        }
     }
 
     // }}}
@@ -265,6 +339,15 @@ abstract class PlPage extends Smarty
     }
 
     // }}}
+    // {{{ function addLink
+
+    public function addLink($rel, $path)
+    {
+        $this->append('pl_link', array('rel' => $rel, 'href' => $path));
+    }
+
+
+    // }}}
     // {{{ function addCssInline
 
     public function addCssInline($css)
@@ -286,7 +369,11 @@ abstract class PlPage extends Smarty
     // {{{ function jsonDisplay
     protected function jsonDisplay()
     {
-        header("Content-type: text/javascript; charset=utf-8");
+        pl_content_headers("text/javascript");
+        if (!empty($GLOBALS['pl_errors'])) {
+            $this->jsonAssign('pl_errors', join("\n", $GLOBALS['pl_errors']));
+            $GLOBALS['pl_errors'] = array();
+        }
         array_walk_recursive($this->_jsonVars, "escape_xorgDB");
         $jsonbegin = Env::v('jsonBegin');
         $jsonend = Env::v('jsonEnd');
@@ -312,7 +399,7 @@ abstract class PlPage extends Smarty
 
 function escape_xorgDB(&$item, $key)
 {
-    if (is_a($item, 'XOrgDBIterator')) {
+    if ($item instanceof XOrgDBIterator) {
         $expanded = array();
         while ($a = $item->next()) {
             $expanded[] = $a;
@@ -364,46 +451,57 @@ function _to_globals($s) {
 function at_to_globals($tpl_source, &$smarty)
 {
     return preg_replace('/#globals\.([a-zA-Z0-9_.]+?)#/e', '_to_globals(\'\\1\')', $tpl_source);
-                        }
+}
 
-                        // }}}
-                        // {{{  function trimwhitespace
+// }}}
+// {{{  function trimwhitespace
 
-                        function trimwhitespace($source, &$smarty)
-                        {
-                        $tags = '(script|pre|textarea)';
-                        preg_match_all("!<$tags.*?>.*?</(\\1)>!ius", $source, $tagsmatches);
-                        $source = preg_replace("!<$tags.*?>.*?</(\\1)>!ius", "&&&tags&&&", $source);
+function trimwhitespace($source, &$smarty)
+{
+    $tags = '(script|pre|textarea)';
+    preg_match_all("!<$tags.*?>.*?</(\\1)>!ius", $source, $tagsmatches);
+    $source = preg_replace("!<$tags.*?>.*?</(\\1)>!ius", "&&&tags&&&", $source);
 
-                        // remove all leading spaces, tabs and carriage returns NOT
-                        // preceeded by a php close tag.
-                        $source = preg_replace('/((?<!\?>)\n)[\s]+/m', '\1', $source);
-                        $source = preg_replace("!&&&tags&&&!e",  'array_shift($tagsmatches[0])', $source);
+    // remove all leading spaces, tabs and carriage returns NOT
+    // preceeded by a php close tag.
+    $source = preg_replace('/((?<!\?>)\n)[\s]+/m', '\1', $source);
+    $source = preg_replace("!&&&tags&&&!e",  'array_shift($tagsmatches[0])', $source);
 
-                        return $source;
-                        }
+    return $source;
+}
 
-                        // }}}
-                        // {{{ function wiki_include
+// }}}
+// {{{ function wiki_include
 
 function wiki_include($source, &$smarty)
 {
+    global $globals;
     return preg_replace('/\{include( [^}]*)? wiki=([^} ]+)(.*?)\}/ui',
-                        '{include\1 file="../spool/wiki.d/cache_\2.tpl"\3 included=1}',
+                        '{include\1 file="' . $globals->spoolroot . '/spool/wiki.d/cache_\2.tpl"\3 included=1}',
+                        $source);
+}
+
+function core_include($source, &$smarty)
+{
+    global $globals;
+    return preg_replace('/\{include( [^}]*)? core=([^} ]+)(.*?)\}/ui',
+                        '{include\1 file="' . $globals->spoolroot . '/core/templates/\2"\3}',
                         $source);
 }
 
 // }}}
 //{{{ function hasPerm
 
-function if_has_perms($source, &$smarty)
+function if_rewrites($source, &$smarty)
 {
-    $source = preg_replace('/\{if([^}]*) (\!?)hasPerms\(([^)]+)\)([^}]*)\}/',
-    '{if\1 \2$smarty.session.perms->hasFlagCombination(\3)\4}',
-    $source);
-return preg_replace('/\{if([^}]*) (\!?)hasPerm\(([^)]+)\)([^}]*)\}/',
-       '{if\1 \2($smarty.session.perms && $smarty.session.perms->hasFlag(\3))\4}',
-       $source);
+    $perms = 'isset($smarty.session.perms|smarty:nodefaults) && $smarty.session.perms|smarty:nodefaults && $smarty.session.perms';
+    return preg_replace(array('/\{if([^}]*) (\!?)hasPerms\(([^)]+)\)([^}]*)\}/',
+                              '/\{if([^}]*) (\!?)hasPerm\(([^)]+)\)([^}]*)\}/',
+                              '/\{if([^}]*) (\!?)t\(([^)]+)\)([^}]*)\}/'),
+                        array('{if\1 \2(' . $perms . '->hasFlagCombination(\3))\4}',
+                              '{if\1 \2(' . $perms . '->hasFlag(\3))\4}',
+                              '{if\1 \2(isset(\3|smarty:nodefaults) && (\3|smarty:nodefaults))\4}'),
+                        $source);
 }
 
 // }}}