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