Makes compilation error debugging easier.

[platal.git] / include / platal.inc.php

diff --git a/include/platal.inc.php b/include/platal.inc.php
index ad6bbe9..d8155f5 100644 (file)
--- a/include/platal.inc.php
+++ b/include/platal.inc.php
@@ -1,6 +1,6 @@
 <?php
 /***************************************************************************
- *  Copyright (C) 2003-2007 Polytechnique.org                              *
+ *  Copyright (C) 2003-2010 Polytechnique.org                              *
  *  http://opensource.polytechnique.org/                                   *
  *                                                                         *
  *  This program is free software; you can redistribute it and/or modify   *
@@ -21,9 +21,8 @@
 
 $TIME_BEGIN = microtime(true);
 
-define('AUTH_PUBLIC', 0);
-define('AUTH_COOKIE', 1);
-define('AUTH_MDP',    2);
+require_once dirname(__FILE__) . '/version.inc.php';
+require_once dirname(__FILE__) . '/misc.inc.php';
 
 define('PERMS_EXT',   'ext');
 define('PERMS_USER',  'user');
@@ -37,23 +36,27 @@ define('NO_AUTH', 0);
 define('DO_AUTH', 1);
 define('NO_HTTPS', 2);
 
-define('DEBUG_BT', 1);
-define('DEBUG_VALID', 2);
-define('DEBUG_SMARTY', 4);
-
-function __autoload($cls)
+function pl_autoload($cls, array $pathes = array())
 {
     $cls  = strtolower($cls);
-    $path = dirname(dirname(__FILE__));
-    if (!@include "$path/classes/$cls.php") {
-        if (substr($cls, -3, 3) == 'req') {
-            @include 'validations.inc.php';
-            return;
+    $basepath = dirname(dirname(dirname(__FILE__)));
+
+    array_unshift($pathes, 'core/classes', 'classes');
+    foreach ($pathes as $path) {
+        if (file_exists("$basepath/$path/$cls.php")) {
+            if (include_once "$basepath/$path/$cls.php") {
+                return true;
+            }
         }
-        @include "$cls.inc.php";
     }
+    return false;
+}
+pl_autoload('Env');
+
+function pl_core_include($file)
+{
+    return dirname(__FILE__) . '/' . $file;
 }
-__autoload('Env');
 
 function pl_error_handler($errno, $errstr, $errfile, $errline)
 {
@@ -74,7 +77,8 @@ function pl_error_handler($errno, $errstr, $errfile, $errline)
             E_USER_ERROR      => "User Error",
             E_USER_WARNING    => "User Warning",
             E_USER_NOTICE     => "User Notice",
-            E_STRICT          => "Runtime Notice"
+            E_STRICT          => "Runtime Notice",
+            E_RECOVERABLE_ERROR => "Recoverable Error"
         );
     }
 
@@ -85,12 +89,17 @@ function pl_error_handler($errno, $errstr, $errfile, $errline)
         }
     }
 
+    $type = isset($errortype[$errno]) ? $errortype[$errno] : $errno;
     $errstr = utf8_encode(htmlentities($errstr));
-    $GLOBALS['pl_errors'][] =
-        "<div class='phperror'>".
-        "<strong>{$errortype[$errno]}</strong> <em>$errstr</em><br />".
-        "<tt>$errfile : $errline</tt>".
-        "</div>";
+    if (php_sapi_name() == 'cli') {
+        $GLOBALS['pl_errors'] = "$type: $errstr\n  $errfile:$errline\n";
+    } else {
+        $GLOBALS['pl_errors'][] =
+            "<div class='phperror'>".
+            "<strong>{$type}</strong> <em>$errstr</em><br />".
+            "<tt>$errfile : $errline</tt>".
+            "</div>";
+    }
 }
 
 function pl_clear_errors()
@@ -101,10 +110,10 @@ function pl_clear_errors()
 function pl_dump_env()
 {
     echo "<div class='phperror'><pre>";
-    echo "\nSESSION: "; var_export($_SESSION);
-    echo "\nPOST:    "; var_export($_POST);
-    echo "\nGET:     "; var_export($_GET);
-    echo "\nCOOKIE:  "; var_export($_COOKIE);
+    echo "\nSESSION: " . session_id(); var_dump($_SESSION);
+    echo "\nPOST:    "; var_dump($_POST);
+    echo "\nGET:     "; var_dump($_GET);
+    echo "\nCOOKIE:  "; var_dump($_COOKIE);
     echo "</pre></div>";
 }
 
@@ -117,7 +126,7 @@ function pl_print_errors()
 
 set_error_handler('pl_error_handler', E_ALL | E_STRICT);
 register_shutdown_function('pl_print_errors');
-// register_shutdown_function('pl_dump_env');
+//register_shutdown_function('pl_dump_env');
 
 /** Check if the string is utf8
  */
@@ -152,10 +161,8 @@ function pl_self($n = null) {
 
 function http_redirect($fullurl)
 {
-    if (count($_SESSION)) {
-        session_write_close();
-    }
-    header('Location: '.$fullurl);
+    Platal::session()->close();
+    header('Location: '. $fullurl);
     exit;
 }
 
@@ -175,5 +182,58 @@ function pl_entity_decode($text, $mode = ENT_COMPAT)
     return html_entity_decode($text, $mode, 'UTF-8');
 }
 
+/**
+ * Returns the path of a static content, including, when appropriate, the
+ * version number. This is used to avoid cross-version cache issues, by ensuiring
+ * that all static resources are served on a unique path.
+ */
+function pl_static_content_path($path, $filename)
+{
+    global $globals;
+    if (isset($globals) && isset($globals->version)) {
+        return $path . $globals->version . '/' . $filename;
+    } else {
+        return $path . $filename;
+    }
+}
+
+/**
+ * Adds content type headers; by default the encoding used is utf-8.
+ */
+function pl_content_headers($content_type, $encoding = 'utf-8')
+{
+    if (is_null($encoding)) {
+        header("Content-Type: $content_type");
+    } else {
+        header("Content-Type: $content_type; charset=$encoding");
+    }
+}
+
+/**
+ * Adds content type and caching headers for content generated by plat/al. The
+ * cache duration defaults to the global static_cache_duration. No encoding is
+ * applied by default.
+ */
+function pl_cached_content_headers($content_type, $encoding = null, $cache_duration = -1)
+{
+    global $globals;
+    $cache_duration = ($cache_duration < 0 ? $globals->static_cache_duration : $cache_duration);
+
+    header("Cache-Control: max-age=$cache_duration");
+    header("Expires: " . gmdate('D, d M Y H:i:s', time() + $cache_duration) . " GMT");
+    header("Pragma: ");
+    pl_content_headers($content_type, $encoding);
+}
+
+/**
+ * Same as above, but applying an expiration time suitable for cacheable dynamic
+ * content (eg. photos, logos, ...).
+ */
+function pl_cached_dynamic_content_headers($content_type, $encoding = null)
+{
+    global $globals;
+    pl_cached_content_headers($content_type, $encoding, $globals->dynamic_cache_duration);
+}
+
 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
 ?>