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