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