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