include/platal.inc.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 $TIME_BEGIN = microtime(true);
  23
  24 require_once dirname(__FILE__) . '/version.inc.php';
  25 require_once dirname(__FILE__) . '/misc.inc.php';
  26
  27 // Common basic permission flags.
  28 define('PERMS_USER',  'user');
  29 define('PERMS_ADMIN', 'admin');
  30
  31 // Page style options, used when rendering pages. Options are exclusive.
  32 define('SKINNED', 0);  // Page is rendered with the normal skin.
  33 define('SIMPLE',  1);  // Page is rendered with a light skin (no leftnav).
  34 define('NO_SKIN', 2);  // Page content is passed as-is (use for csv, xml, ...).
  35
  36 // Hook options bitmasks. Authentication options are mutually exclusive, but
  37 // others (NO_HTTPS at the moment) are not.
  38 //
  39 // With PlStdHook, NO_AUTH indicates that no session will be started, and that
  40 // the actual handler is responsible for doing authentication; DO_AUTH forces
  41 // the engine to try to authenticate the user, including redirecting to the
  42 // login page. Note that DO_AUTH is ignored if AUTH_PUBLIC is requested.
  43 //
  44 // Options NO_AUTH and DO_AUTH are ignored with PlTokenHook.
  45 define('NO_AUTH', 0);
  46 define('DO_AUTH', 1);
  47 define('NO_HTTPS', 2);
  48
  49 function pl_autoload($cls, array $pathes = array())
  50 {
  51     $cls  = strtolower($cls);
  52     if (starts_with($cls, 'xdb')) {
  53         $cls = 'xdb';
  54     } else if (starts_with($cls, 'pldbtable')) {
  55         $cls = 'pldbtableentry';
  56     }
  57     $basepath = dirname(dirname(dirname(__FILE__)));
  58
  59     array_unshift($pathes, 'core/classes', 'classes');
  60     foreach ($pathes as $path) {
  61         if (file_exists("$basepath/$path/$cls.php")) {
  62             if (include_once "$basepath/$path/$cls.php") {
  63                 return true;
  64             }
  65         }
  66     }
  67     return false;
  68 }
  69 pl_autoload('Env');
  70
  71 function pl_core_include($file)
  72 {
  73     return dirname(__FILE__) . '/' . $file;
  74 }
  75
  76 function pl_error_handler($errno, $errstr, $errfile, $errline)
  77 {
  78
  79     static $errortype;
  80     if (!error_reporting())
  81         return;
  82
  83     if (!isset($errortype)) {
  84         $errortype = array (
  85             E_ERROR           => "Error",
  86             E_WARNING         => "Warning",
  87             E_PARSE           => "Parsing Error",
  88             E_NOTICE          => "Notice",
  89             E_CORE_ERROR      => "Core Error",
  90             E_CORE_WARNING    => "Core Warning",
  91             E_COMPILE_ERROR   => "Compile Error",
  92             E_COMPILE_WARNING => "Compile Warning",
  93             E_USER_ERROR      => "User Error",
  94             E_USER_WARNING    => "User Warning",
  95             E_USER_NOTICE     => "User Notice",
  96             E_STRICT          => "Runtime Notice",
  97             E_RECOVERABLE_ERROR => "Recoverable Error"
  98         );
  99     }
 100
 101     global $globals;
 102     if (isset($globals) && !$globals->debug) {
 103         if ($errno == E_NOTICE || $errno == E_USER_NOTICE || $errno == E_STRICT) {
 104             return;
 105         }
 106     }
 107     $type = isset($errortype[$errno]) ? $errortype[$errno] : $errno;
 108     $error = strpos($type, 'Warning') !== false || strpos($type, 'Error') !==false;
 109
 110     pl_autoload('PlBacktrace');
 111     if (!isset(PlBacktrace::$bt['PHP Errors'])) {
 112         new PlBacktrace('PHP Errors');
 113     }
 114     PlBacktrace::$bt['PHP Errors']->newEvent("$type: $errstr",
 115                                              0, $error ? $errstr : null,
 116                                              array(array('file' => $errfile,
 117                                                          'line' => $errline)));
 118 }
 119
 120 function pl_dump_env()
 121 {
 122     echo "<div class='phperror'><pre>";
 123     echo "\nSESSION: " . session_id(); var_dump($_SESSION);
 124     echo "\nPOST:    "; var_dump($_POST);
 125     echo "\nGET:     "; var_dump($_GET);
 126     echo "\nCOOKIE:  "; var_dump($_COOKIE);
 127     echo "</pre></div>";
 128 }
 129
 130 function pl_print_errors($html = false)
 131 {
 132     if (!isset(PlBacktrace::$bt['PHP Errors'])) {
 133         return;
 134     }
 135     foreach (PlBacktrace::$bt['PHP Errors']->traces as $trace) {
 136         if ($html) {
 137             echo "<pre>";
 138         }
 139         print "{$trace['action']}\n";
 140         print "  {$trace['data'][0]['file']}: {$trace['data'][0]['line']}\n";
 141         if ($html) {
 142             echo "</pre>";
 143         }
 144     }
 145 }
 146
 147 function pl_assert_cb($file, $line, $message)
 148 {
 149     Platal::assert(false, "Assertion failed at $file:$line with message: $message");
 150 }
 151
 152 set_error_handler('pl_error_handler', E_ALL | E_STRICT);
 153 assert_options(ASSERT_CALLBACK, 'pl_assert_cb');
 154 assert_options(ASSERT_WARNING, false);
 155 if (php_sapi_name() == 'cli') {
 156     register_shutdown_function('pl_print_errors');
 157 }
 158 //register_shutdown_function('pl_dump_env');
 159
 160 /** Check if the string is utf8
 161  */
 162 function is_utf8($s)
 163 {
 164     return @iconv('utf-8', 'utf-8', $s) == $s;
 165 }
 166
 167 /** vérifie si une adresse email est bien formatée  * ATTENTION, cette fonction ne doit pas être appelée sur une chaîne ayant subit un addslashes (car elle accepte le "'" qui it alors un "\'"
 168  * @param $email l'adresse email a verifier
 169  * @return BOOL  */
 170 function isvalid_email($email)
 171 {
 172     // la rfc2822 authorise les caractères "a-z", "0-9", "!", "#", "$", "%", "&", "'", "*", "+", "-", "/", "=", "?", "^",  `", "{", "|", "}", "~" aussi bien dans la partie locale que dans le domaine.
 173     // Pour la partie locale, on réduit cet ensemble car il n'est pas utilisé.
 174     // Pour le domaine, le système DNS limite à [a-z0-9.-], on y ajoute le "_" car il est parfois utilisé.
 175     return preg_match("/^[a-z0-9_.'+-]+@[a-z0-9._-]+\.[a-z]{2,6}$/i", $email);
 176 }
 177
 178 function pl_url($path, $query = null, $fragment = null)
 179 {
 180     global $platal;
 181
 182     $base = $platal->ns . $path . ($query ? '?'.$query : '');
 183     return $fragment ? $base.'#'.$fragment : $base;
 184 }
 185
 186 function pl_self($n = null) {
 187     global $platal;
 188     return $platal->pl_self($n);
 189 }
 190
 191 function http_redirect($fullurl)
 192 {
 193     Platal::session()->close();
 194     header('Location: '. $fullurl);
 195     exit;
 196 }
 197
 198 function pl_redirect($path, $query = null, $fragment = null)
 199 {
 200     global $globals;
 201     http_redirect($globals->baseurl . '/' . pl_url($path, $query, $fragment));
 202 }
 203
 204 function pl_entities($text, $mode = ENT_COMPAT)
 205 {
 206     return htmlentities($text, $mode, 'UTF-8');
 207 }
 208
 209 function pl_entity_decode($text, $mode = ENT_COMPAT)
 210 {
 211     return html_entity_decode($text, $mode, 'UTF-8');
 212 }
 213
 214 function pl_flatten_aux(array &$dest, array $src)
 215 {
 216     foreach ($src as $val) {
 217         if (is_array($val)) {
 218             pl_flatten_aux($dest, $val);
 219         } else {
 220             $dest[] = $val;
 221         }
 222     }
 223 }
 224
 225 function pl_flatten(array $array)
 226 {
 227     $res = array();
 228     pl_flatten_aux($res, $array);
 229     return $res;
 230 }
 231
 232 /**
 233  * Returns the path of a static content, including, when appropriate, the
 234  * version number. This is used to avoid cross-version cache issues, by ensuiring
 235  * that all static resources are served on a unique path.
 236  */
 237 function pl_static_content_path($path, $filename)
 238 {
 239     global $globals;
 240     if (isset($globals) && isset($globals->version)) {
 241         return $path . $globals->version . '/' . $filename;
 242     } else {
 243         return $path . $filename;
 244     }
 245 }
 246
 247 /**
 248  * Adds content type headers; by default the encoding used is utf-8.
 249  */
 250 function pl_content_headers($content_type, $encoding = 'utf-8')
 251 {
 252     if (is_null($encoding)) {
 253         header("Content-Type: $content_type");
 254     } else {
 255         header("Content-Type: $content_type; charset=$encoding");
 256     }
 257 }
 258
 259 /**
 260  * Adds content type and caching headers for content generated by plat/al. The
 261  * cache duration defaults to the global static_cache_duration. No encoding is
 262  * applied by default.
 263  */
 264 function pl_cached_content_headers($content_type, $encoding = null, $cache_duration = -1)
 265 {
 266     global $globals;
 267     $cache_duration = ($cache_duration < 0 ? $globals->static_cache_duration : $cache_duration);
 268
 269     header("Cache-Control: max-age=$cache_duration");
 270     header("Expires: " . gmdate('D, d M Y H:i:s', time() + $cache_duration) . " GMT");
 271     header("Pragma: ");
 272     pl_content_headers($content_type, $encoding);
 273 }
 274
 275 /**
 276  * Same as above, but applying an expiration time suitable for cacheable dynamic
 277  * content (eg. photos, logos, ...).
 278  */
 279 function pl_cached_dynamic_content_headers($content_type, $encoding = null)
 280 {
 281     global $globals;
 282     pl_cached_content_headers($content_type, $encoding, $globals->dynamic_cache_duration);
 283 }
 284
 285 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
 286 ?>