Factorizes the content type / content cache headers, and improves caching of static...
[platal.git] / include / platal.inc.php
1 <?php
2 /***************************************************************************
3 * Copyright (C) 2003-2009 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 $GLOBALS['pl_errors'][] =
93 "<div class='phperror'>".
94 "<strong>{$type}</strong> <em>$errstr</em><br />".
95 "<tt>$errfile : $errline</tt>".
96 "</div>";
97 }
98
99 function pl_clear_errors()
100 {
101 unset($GLOBALS['pl_errors']);
102 }
103
104 function pl_dump_env()
105 {
106 echo "<div class='phperror'><pre>";
107 echo "\nSESSION: " . session_id(); var_dump($_SESSION);
108 echo "\nPOST: "; var_dump($_POST);
109 echo "\nGET: "; var_dump($_GET);
110 echo "\nCOOKIE: "; var_dump($_COOKIE);
111 echo "</pre></div>";
112 }
113
114 function pl_print_errors()
115 {
116 if (!empty($GLOBALS['pl_errors'])) {
117 print join("\n", $GLOBALS['pl_errors']);
118 }
119 }
120
121 set_error_handler('pl_error_handler', E_ALL | E_STRICT);
122 register_shutdown_function('pl_print_errors');
123 //register_shutdown_function('pl_dump_env');
124
125 /** Check if the string is utf8
126 */
127 function is_utf8($s)
128 {
129 return @iconv('utf-8', 'utf-8', $s) == $s;
130 }
131
132 /** 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 "\'"
133 * @param $email l'adresse email a verifier
134 * @return BOOL */
135 function isvalid_email($email)
136 {
137 // la rfc2822 authorise les caractères "a-z", "0-9", "!", "#", "$", "%", "&", "'", "*", "+", "-", "/", "=", "?", "^", `", "{", "|", "}", "~" aussi bien dans la partie locale que dans le domaine.
138 // Pour la partie locale, on réduit cet ensemble car il n'est pas utilisé.
139 // Pour le domaine, le système DNS limite à [a-z0-9.-], on y ajoute le "_" car il est parfois utilisé.
140 return preg_match("/^[a-z0-9_.'+-]+@[a-z0-9._-]+\.[a-z]{2,6}$/i", $email);
141 }
142
143 function pl_url($path, $query = null, $fragment = null)
144 {
145 global $platal;
146
147 $base = $platal->ns . $path . ($query ? '?'.$query : '');
148 return $fragment ? $base.'#'.$fragment : $base;
149 }
150
151 function pl_self($n = null) {
152 global $platal;
153 return $platal->pl_self($n);
154 }
155
156 function http_redirect($fullurl)
157 {
158 Platal::session()->close();
159 header('Location: '. $fullurl);
160 exit;
161 }
162
163 function pl_redirect($path, $query = null, $fragment = null)
164 {
165 global $globals;
166 http_redirect($globals->baseurl . '/' . pl_url($path, $query, $fragment));
167 }
168
169 function pl_entities($text, $mode = ENT_COMPAT)
170 {
171 return htmlentities($text, $mode, 'UTF-8');
172 }
173
174 function pl_entity_decode($text, $mode = ENT_COMPAT)
175 {
176 return html_entity_decode($text, $mode, 'UTF-8');
177 }
178
179 /**
180 * Adds content type headers; by default the encoding used is utf-8.
181 */
182 function pl_content_headers($content_type, $encoding = 'utf-8')
183 {
184 if (is_null($encoding)) {
185 header("Content-Type: $content_type");
186 } else {
187 header("Content-Type: $content_type; charset=$encoding");
188 }
189 }
190
191 /**
192 * Adds content type and caching headers for content generated by plat/al. The
193 * cache duration defaults to the global static_cache_duration. No encoding is
194 * applied by default.
195 */
196 function pl_cached_content_headers($content_type, $encoding = null, $cache_duration = -1)
197 {
198 global $globals;
199 $cache_duration = ($cache_duration < 0 ? $globals->static_cache_duration : $cache_duration);
200
201 header("Cache-Control: max-age=$cache_duration");
202 header("Expires: " . gmdate('D, d M Y H:i:s', time() + $cache_duration) . " GMT");
203 pl_content_headers($content_type, $encoding);
204 }
205
206 /**
207 * Same as above, but applying an expiration time suitable for cacheable dynamic
208 * content (eg. photos, logos, ...).
209 */
210 function pl_cached_dynamic_content_headers($content_type, $encoding = null)
211 {
212 global $globals;
213 pl_cached_content_headers($content_type, $encoding, $globals->dynamic_cache_duration);
214 }
215
216 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
217 ?>