Big cleanup of XDB.
[platal.git] / include / platal.inc.php
1 <?php
2 /***************************************************************************
3 * Copyright (C) 2003-2010 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 define('PERMS_EXT', 'ext');
28 define('PERMS_USER', 'user');
29 define('PERMS_ADMIN', 'admin');
30
31 define('SKINNED', 0);
32 define('SIMPLE', 1);
33 define('NO_SKIN', 2);
34
35 define('NO_AUTH', 0);
36 define('DO_AUTH', 1);
37 define('NO_HTTPS', 2);
38
39 function pl_autoload($cls, array $pathes = array())
40 {
41 $cls = strtolower($cls);
42 if (substr($cls, 0, 3) == 'xdb') {
43 $cls = 'xdb';
44 }
45 $basepath = dirname(dirname(dirname(__FILE__)));
46
47 array_unshift($pathes, 'core/classes', 'classes');
48 foreach ($pathes as $path) {
49 if (file_exists("$basepath/$path/$cls.php")) {
50 if (include_once "$basepath/$path/$cls.php") {
51 return true;
52 }
53 }
54 }
55 return false;
56 }
57 pl_autoload('Env');
58
59 function pl_core_include($file)
60 {
61 return dirname(__FILE__) . '/' . $file;
62 }
63
64 function pl_error_handler($errno, $errstr, $errfile, $errline)
65 {
66 static $errortype;
67 if (!error_reporting())
68 return;
69
70 if (!isset($errortype)) {
71 $errortype = array (
72 E_ERROR => "Error",
73 E_WARNING => "Warning",
74 E_PARSE => "Parsing Error",
75 E_NOTICE => "Notice",
76 E_CORE_ERROR => "Core Error",
77 E_CORE_WARNING => "Core Warning",
78 E_COMPILE_ERROR => "Compile Error",
79 E_COMPILE_WARNING => "Compile Warning",
80 E_USER_ERROR => "User Error",
81 E_USER_WARNING => "User Warning",
82 E_USER_NOTICE => "User Notice",
83 E_STRICT => "Runtime Notice",
84 E_RECOVERABLE_ERROR => "Recoverable Error"
85 );
86 }
87
88 global $globals;
89 if (isset($globals) && !$globals->debug) {
90 if ($errno == E_NOTICE || $errno == E_USER_NOTICE || $errno == E_STRICT) {
91 return;
92 }
93 }
94
95 $type = isset($errortype[$errno]) ? $errortype[$errno] : $errno;
96 $errstr = utf8_encode(htmlentities($errstr));
97 if (php_sapi_name() == 'cli') {
98 $GLOBALS['pl_errors'] = "$type: $errstr\n $errfile:$errline\n";
99 } else {
100 $GLOBALS['pl_errors'][] =
101 "<div class='phperror'>".
102 "<strong>{$type}</strong> <em>$errstr</em><br />".
103 "<tt>$errfile : $errline</tt>".
104 "</div>";
105 }
106 }
107
108 function pl_clear_errors()
109 {
110 unset($GLOBALS['pl_errors']);
111 }
112
113 function pl_dump_env()
114 {
115 echo "<div class='phperror'><pre>";
116 echo "\nSESSION: " . session_id(); var_dump($_SESSION);
117 echo "\nPOST: "; var_dump($_POST);
118 echo "\nGET: "; var_dump($_GET);
119 echo "\nCOOKIE: "; var_dump($_COOKIE);
120 echo "</pre></div>";
121 }
122
123 function pl_print_errors()
124 {
125 if (!empty($GLOBALS['pl_errors'])) {
126 print join("\n", $GLOBALS['pl_errors']);
127 }
128 }
129
130 set_error_handler('pl_error_handler', E_ALL | E_STRICT);
131 register_shutdown_function('pl_print_errors');
132 //register_shutdown_function('pl_dump_env');
133
134 /** Check if the string is utf8
135 */
136 function is_utf8($s)
137 {
138 return @iconv('utf-8', 'utf-8', $s) == $s;
139 }
140
141 /** 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 "\'"
142 * @param $email l'adresse email a verifier
143 * @return BOOL */
144 function isvalid_email($email)
145 {
146 // la rfc2822 authorise les caractères "a-z", "0-9", "!", "#", "$", "%", "&", "'", "*", "+", "-", "/", "=", "?", "^", `", "{", "|", "}", "~" aussi bien dans la partie locale que dans le domaine.
147 // Pour la partie locale, on réduit cet ensemble car il n'est pas utilisé.
148 // Pour le domaine, le système DNS limite à [a-z0-9.-], on y ajoute le "_" car il est parfois utilisé.
149 return preg_match("/^[a-z0-9_.'+-]+@[a-z0-9._-]+\.[a-z]{2,6}$/i", $email);
150 }
151
152 function pl_url($path, $query = null, $fragment = null)
153 {
154 global $platal;
155
156 $base = $platal->ns . $path . ($query ? '?'.$query : '');
157 return $fragment ? $base.'#'.$fragment : $base;
158 }
159
160 function pl_self($n = null) {
161 global $platal;
162 return $platal->pl_self($n);
163 }
164
165 function http_redirect($fullurl)
166 {
167 Platal::session()->close();
168 header('Location: '. $fullurl);
169 exit;
170 }
171
172 function pl_redirect($path, $query = null, $fragment = null)
173 {
174 global $globals;
175 http_redirect($globals->baseurl . '/' . pl_url($path, $query, $fragment));
176 }
177
178 function pl_entities($text, $mode = ENT_COMPAT)
179 {
180 return htmlentities($text, $mode, 'UTF-8');
181 }
182
183 function pl_entity_decode($text, $mode = ENT_COMPAT)
184 {
185 return html_entity_decode($text, $mode, 'UTF-8');
186 }
187
188 function pl_flatten_aux(array &$dest, array $src)
189 {
190 foreach ($src as $val) {
191 if (is_array($val)) {
192 pl_flatten_aux($dest, $val);
193 } else {
194 $dest[] = $val;
195 }
196 }
197 }
198
199 function pl_flatten(array $array)
200 {
201 $res = array();
202 pl_flatten_aux($res, $array);
203 return $res;
204 }
205
206 /**
207 * Returns the path of a static content, including, when appropriate, the
208 * version number. This is used to avoid cross-version cache issues, by ensuiring
209 * that all static resources are served on a unique path.
210 */
211 function pl_static_content_path($path, $filename)
212 {
213 global $globals;
214 if (isset($globals) && isset($globals->version)) {
215 return $path . $globals->version . '/' . $filename;
216 } else {
217 return $path . $filename;
218 }
219 }
220
221 /**
222 * Adds content type headers; by default the encoding used is utf-8.
223 */
224 function pl_content_headers($content_type, $encoding = 'utf-8')
225 {
226 if (is_null($encoding)) {
227 header("Content-Type: $content_type");
228 } else {
229 header("Content-Type: $content_type; charset=$encoding");
230 }
231 }
232
233 /**
234 * Adds content type and caching headers for content generated by plat/al. The
235 * cache duration defaults to the global static_cache_duration. No encoding is
236 * applied by default.
237 */
238 function pl_cached_content_headers($content_type, $encoding = null, $cache_duration = -1)
239 {
240 global $globals;
241 $cache_duration = ($cache_duration < 0 ? $globals->static_cache_duration : $cache_duration);
242
243 header("Cache-Control: max-age=$cache_duration");
244 header("Expires: " . gmdate('D, d M Y H:i:s', time() + $cache_duration) . " GMT");
245 header("Pragma: ");
246 pl_content_headers($content_type, $encoding);
247 }
248
249 /**
250 * Same as above, but applying an expiration time suitable for cacheable dynamic
251 * content (eg. photos, logos, ...).
252 */
253 function pl_cached_dynamic_content_headers($content_type, $encoding = null)
254 {
255 global $globals;
256 pl_cached_content_headers($content_type, $encoding, $globals->dynamic_cache_duration);
257 }
258
259 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
260 ?>