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     $corebasepath = dirname(dirname(__FILE__));
  58     $basepath = dirname($corebasepath);
  59     $corebasename = basename($corebasepath);
  60
  61     array_unshift($pathes, $corebasename . '/classes', 'classes');
  62     foreach ($pathes as $path) {
  63         if (file_exists("$basepath/$path/$cls.php")) {
  64             if (include_once "$basepath/$path/$cls.php") {
  65                 return true;
  66             }
  67         }
  68     }
  69     return false;
  70 }
  71 pl_autoload('Env');
  72 pl_autoload('PlBacktrace');
  73
  74 function pl_core_include($file)
  75 {
  76     return dirname(__FILE__) . '/' . $file;
  77 }
  78
  79 function pl_error_handler($errno, $errstr, $errfile, $errline)
  80 {
  81
  82     static $errortype;
  83     if (!error_reporting())
  84         return;
  85
  86     if (!isset($errortype)) {
  87         $errortype = array (
  88             E_ERROR           => "Error",
  89             E_WARNING         => "Warning",
  90             E_PARSE           => "Parsing Error",
  91             E_NOTICE          => "Notice",
  92             E_CORE_ERROR      => "Core Error",
  93             E_CORE_WARNING    => "Core Warning",
  94             E_COMPILE_ERROR   => "Compile Error",
  95             E_COMPILE_WARNING => "Compile Warning",
  96             E_USER_ERROR      => "User Error",
  97             E_USER_WARNING    => "User Warning",
  98             E_USER_NOTICE     => "User Notice",
  99             E_STRICT          => "Runtime Notice",
 100             E_RECOVERABLE_ERROR => "Recoverable Error"
 101         );
 102     }
 103
 104     global $globals;
 105     if (isset($globals) && !$globals->debug) {
 106         if ($errno == E_NOTICE || $errno == E_USER_NOTICE || $errno == E_STRICT) {
 107             return;
 108         }
 109     }
 110     $type = isset($errortype[$errno]) ? $errortype[$errno] : $errno;
 111     $error = strpos($type, 'Warning') !== false || strpos($type, 'Error') !==false;
 112
 113     if (!isset(PlBacktrace::$bt['PHP Errors'])) {
 114         new PlBacktrace('PHP Errors');
 115     }
 116     PlBacktrace::$bt['PHP Errors']->newEvent("$type: $errstr",
 117                                              0, $error ? $errstr : null,
 118                                              array(array('file' => $errfile,
 119                                                          'line' => $errline)));
 120 }
 121
 122 function pl_dump_env()
 123 {
 124     echo "<div class='phperror'><pre>";
 125     echo "\nSESSION: " . session_id(); var_dump($_SESSION);
 126     echo "\nPOST:    "; var_dump($_POST);
 127     echo "\nGET:     "; var_dump($_GET);
 128     echo "\nCOOKIE:  "; var_dump($_COOKIE);
 129     echo "</pre></div>";
 130 }
 131
 132 function pl_print_errors($html = false)
 133 {
 134     if (!isset(PlBacktrace::$bt['PHP Errors'])) {
 135         return;
 136     }
 137     foreach (PlBacktrace::$bt['PHP Errors']->traces as $trace) {
 138         if ($html) {
 139             echo "<pre>";
 140         }
 141         print "{$trace['action']}\n";
 142         print "  {$trace['data'][0]['file']}: {$trace['data'][0]['line']}\n";
 143         if ($html) {
 144             echo "</pre>";
 145         }
 146     }
 147 }
 148
 149 function pl_assert_cb($file, $line, $message)
 150 {
 151     Platal::assert(false, "Assertion failed at $file:$line with message: $message");
 152 }
 153
 154 set_error_handler('pl_error_handler', E_ALL | E_STRICT);
 155 assert_options(ASSERT_CALLBACK, 'pl_assert_cb');
 156 assert_options(ASSERT_WARNING, false);
 157 if (php_sapi_name() == 'cli') {
 158     register_shutdown_function('pl_print_errors');
 159 }
 160 //register_shutdown_function('pl_dump_env');
 161
 162 /** Check if the string is utf8
 163  */
 164 function is_utf8($s)
 165 {
 166     return @iconv('utf-8', 'utf-8', $s) == $s;
 167 }
 168
 169 /** 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 "\'"
 170  * @param $email l'adresse email a verifier
 171  * @return BOOL  */
 172 function isvalid_email($email)
 173 {
 174     // la rfc2822 authorise les caractères "a-z", "0-9", "!", "#", "$", "%", "&", "'", "*", "+", "-", "/", "=", "?", "^",  `", "{", "|", "}", "~" aussi bien dans la partie locale que dans le domaine.
 175     // Pour la partie locale, on réduit cet ensemble car il n'est pas utilisé.
 176     // Pour le domaine, le système DNS limite à [a-z0-9.-], on y ajoute le "_" car il est parfois utilisé.
 177     return preg_match("/^[a-z0-9_.'+-]+@[a-z0-9._-]+\.[a-z]{2,6}$/i", $email);
 178 }
 179
 180 function pl_url($path, $query = null, $fragment = null)
 181 {
 182     global $platal;
 183
 184     $base = $platal->ns . $path . ($query ? '?'.$query : '');
 185     return $fragment ? $base.'#'.$fragment : $base;
 186 }
 187
 188 function pl_self($n = null) {
 189     global $platal;
 190     return $platal->pl_self($n);
 191 }
 192
 193 function http_redirect($fullurl)
 194 {
 195     Platal::session()->close();
 196     header('Location: '. $fullurl);
 197     exit;
 198 }
 199
 200 function pl_redirect($path, $query = null, $fragment = null)
 201 {
 202     global $globals;
 203     http_redirect($globals->baseurl . '/' . pl_url($path, $query, $fragment));
 204 }
 205
 206 function pl_entities($text, $mode = ENT_COMPAT)
 207 {
 208     return htmlentities($text, $mode, 'UTF-8');
 209 }
 210
 211 function pl_entity_decode($text, $mode = ENT_COMPAT)
 212 {
 213     return html_entity_decode($text, $mode, 'UTF-8');
 214 }
 215
 216 function pl_flatten_aux(array &$dest, array $src)
 217 {
 218     foreach ($src as $val) {
 219         if (is_array($val)) {
 220             pl_flatten_aux($dest, $val);
 221         } else {
 222             $dest[] = $val;
 223         }
 224     }
 225 }
 226
 227 function pl_flatten(array $array)
 228 {
 229     $res = array();
 230     pl_flatten_aux($res, $array);
 231     return $res;
 232 }
 233
 234 /**
 235  * Returns the path of a static content, including, when appropriate, the
 236  * version number. This is used to avoid cross-version cache issues, by ensuiring
 237  * that all static resources are served on a unique path.
 238  */
 239 function pl_static_content_path($path, $filename)
 240 {
 241     global $globals;
 242     if (isset($globals) && isset($globals->version)) {
 243         return $path . $globals->version . '/' . $filename;
 244     } else {
 245         return $path . $filename;
 246     }
 247 }
 248
 249 /**
 250  * Adds content type headers; by default the encoding used is utf-8.
 251  */
 252 function pl_content_headers($content_type, $encoding = 'utf-8')
 253 {
 254     if (is_null($encoding)) {
 255         header("Content-Type: $content_type");
 256     } else {
 257         header("Content-Type: $content_type; charset=$encoding");
 258     }
 259 }
 260
 261 /**
 262  * Adds content type and caching headers for content generated by plat/al. The
 263  * cache duration defaults to the global static_cache_duration. No encoding is
 264  * applied by default.
 265  */
 266 function pl_cached_content_headers($content_type, $encoding = null, $cache_duration = -1, $filename = null)
 267 {
 268     global $globals;
 269     $cache_duration = ($cache_duration < 0 ? $globals->static_cache_duration : $cache_duration);
 270
 271     header("Cache-Control: max-age=$cache_duration");
 272     header("Expires: " . gmdate('D, d M Y H:i:s', time() + $cache_duration) . " GMT");
 273     header("Pragma: ");
 274     pl_content_headers($content_type, $encoding);
 275     if (!is_null($filename)) {
 276          header('Content-Disposition: attachment; filename=' . $filename);
 277     }
 278 }
 279
 280 /**
 281  * Same as above, but applying an expiration time suitable for cacheable dynamic
 282  * content (eg. photos, logos, ...).
 283  */
 284 function pl_cached_dynamic_content_headers($content_type, $encoding = null)
 285 {
 286     global $globals;
 287     pl_cached_content_headers($content_type, $encoding, $globals->dynamic_cache_duration);
 288 }
 289
 290 function pl_var_dump()
 291 {
 292     echo '<pre>';
 293     $array = func_get_args();
 294     call_user_func_array('var_dump', $array);
 295     echo '</pre>';
 296 }
 297
 298 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker fenc=utf-8:
 299 ?>