forked from Phorum/Core
/
javascript.php
370 lines (326 loc) · 13.7 KB
/
javascript.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
<?php
////////////////////////////////////////////////////////////////////////////////
// //
// Copyright (C) 2011 Phorum Development Team //
// http://www.phorum.org //
// //
// This program is free software. You can redistribute it and/or modify //
// it under the terms of either the current Phorum License (viewable at //
// phorum.org) or the Phorum License that was distributed with this file //
// //
// This program is distributed in the hope that it will be useful, //
// but WITHOUT ANY WARRANTY, without even the implied warranty of //
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. //
// //
// You should have received a copy of the Phorum License //
// along with this program. //
// //
////////////////////////////////////////////////////////////////////////////////
define('phorum_page', 'javascript');
require_once './common.php';
// ----------------------------------------------------------------------
// Flags, added by Phorum internally
// ----------------------------------------------------------------------
// When loaded from the admin interface, the admin parameter will be set
// in the URL. We use that parameter to not load template and module
// related javascript code.
$only_core = !empty($PHORUM['args']['admin']);
// ----------------------------------------------------------------------
// Flags that external sites can add to the javascript URL:
// ----------------------------------------------------------------------
// "core" can be added to the URL, to flag that only the core scripts
// need to be included, e.g. http://example.com/phorum/javascript?core
$only_core = in_array('core', $PHORUM['args']);
// "nojquery" can be added to the URL, to flag that the jquery library
// needs to be omitted. This can be useful if the site loads a jquery
// library already. E.g. http://example.com/phorum/javascript?core,nojquery
$no_jquery = in_array('nojquery', $PHORUM['args']);
// ----------------------------------------------------------------------
// Start of main code
// ----------------------------------------------------------------------
// So we can use {URL->HTTP_PATH} in the templates.
phorum_build_common_urls();
// An array that is used for gathering the parts that
// have to be added to the javascript code.
$module_registrations = array();
// Add the jQuery JavaScript library code, unless "nojquery" was flagged.
if (!$no_jquery) {
$module_registrations[] = array(
'module' => 'core',
'source' => 'file(include/javascript/jquery-1.6.2.min.js)',
'cache_key' => '1.4.4.min'
);
}
// Add the jQuery bgiframe plugin.
$module_registrations[] = array(
'module' => 'core',
'source' => 'file(include/javascript/jquery.bgiframe-2.1.2.min.js)',
'cache_key' => '2.1.2.min'
);
// Add Douglas Crockford's json2 library for supporting JSON.encode and
// JSON.stringify in browsers that do not support these.
$module_registrations[] = array(
'module' => 'core',
'source' => 'file(include/javascript/json2.js)',
'cache_key' => '2011-02-23'
);
// Add the Phorum JavaScript library.
$module_registrations[] = array(
'module' => 'core',
'source' => 'file(include/javascript/phorum-javascript-library.php)'
);
// Add template specific javascript code, if available. The template writer
// can put the javascript code to include in the file
// "templates/<name>/javascript.tpl" or "templates/<name>/javascript.php".
if (!$only_core) {
if (file_exists("./templates/{$PHORUM['template']}/javascript.tpl") ||
file_exists("./templates/{$PHORUM['template']}/javascript.php")) {
$module_registrations[] = array(
'module' => $PHORUM['template'] . ' template',
'source' => 'template(javascript)'
);
}
}
/**
* [hook]
* javascript_register
*
* [description]
* Modules can provide JavaScript code that has to be added to the
* Phorum pages. Modules that make use of this facility should
* register the JavaScript code using this hook.
*
* [category]
* Templating
*
* [when]
* At the start of the javascript.php script.
*
* [input]
* An array of registrations. Modules can register their JavaScript
* code for inclusion by adding a registration to this array.
* A registration is an array, containing the following fields:
* <ul>
* <li><b>module</b><br>
* The name of the module that adds the registration.
* </li>
* <li><b>source</b><br>
* Specifies the source of the JavaScript data. This can be one of:
* <ul>
* <li><b>file(<path to filename>)</b><br>
* For including a static JavaScript file. The path should be
* absolute or relative to the Phorum install directory,
* e.g. "<literal>file(mods/foobar/baz.js</literal>)".
* Because this file is loaded using a PHP include call,
* it is possible to include PHP code in this file. Mind that
* this code is stored interpreted in the cache.</li>
* <li><b>template(<template name>)</b><br>
* For including a Phorum template,
* e.g. "<literal>template(foobar::baz)</literal>"</li>
* <li><b>function(<function name>)</b><br>
* For calling a function to retrieve the JavaScript code,
* e.g. "<literal>function(mod_foobar_get_js)</literal>"</li>
* </ul>
* </li>
* <li><b>cache_key</b><br>
* To make caching of the generated JavaScript code
* possible, the module should provide a cache key using this
* field. This cache key needs to change if the module will
* provide different JavaScript code.<br>
* <br>
* Note: in case "file" or "template" is used as the source,
* you are allowed to omit the cache_key. In that case, the
* modification time of the involved file(s) will be used as
* the cache key.<br>
* <br>
* It is okay for the module to provide multiple cache keys
* for different situations (e.g. if the JavaScript code depends on
* a group). Keep in mind though that for each different
* cache key, a separate cache file is generated. If you are
* generating different JavaScript code per user or so, then it might
* be better to add the JavaScript code differently (e.g. through a
* custom JavaScript generating script or by adding the code to
* the <literal>$PHORUM['DATA']['HEAD_DATA']</literal> variable).
* Also, do not use this to only add JavaScript code to certain
* phorum pages. Since the resulting JavaScript data is cached,
* it is no problem if you add the JavaScript code for your module
* to the code for every page.
* </li>
* </ul>
*
* [output]
* The same array as the one that was used as the hook call
* argument, possibly extended with one or more registrations.
*/
if (!$only_core && isset($PHORUM['hooks']['javascript_register'])) {
$module_registrations = phorum_api_hook(
'javascript_register', $module_registrations
);
}
// Generate the cache key. Include some variables that could influence
// the final script code.
$cache_key =
$PHORUM['template'] . ':' .
$PHORUM['language'] . ':' .
$PHORUM['http_path'];
// Add cache key data for the registrations.
foreach ($module_registrations as $id => $r)
{
// Here we check the validity of the registration data.
if (!isset($r['module'])) {
trigger_error(
"javascript_register hook: module registration error: " .
"the \"module\" field was not set."
);
exit(1);
}
if (!isset($r['source'])) {
trigger_error(
"javascript_register hook: module registration error: " .
"the \"source\" field was not set."
);
exit(1);
}
if (preg_match('/^(file|template|function)\((.+)\)$/', $r['source'], $m))
{
$module_registrations[$id]['type'] = $m[1];
$module_registrations[$id]['source'] = $m[2];
switch ($m[1])
{
case "file":
if (!isset($r['cache_key'])) {
$mtime = @filemtime($m[2]);
$r['cache_key'] = $mtime;
$module_registrations[$id]['cache_key'] = $mtime;
}
break;
case "template":
// We load the parsed template into memory. This will refresh
// the cached template file if required. This is the easiest
// way to make this work correctly for nested template files.
ob_start();
include phorum_api_template($m[2]);
$module_registrations[$id]['content'] = ob_get_contents();
ob_end_clean();
// We use the mtime of the compiled template as the cache
// key if no specific cache key was set.
if (!isset($r['cache_key'])) {
list ($m[2], $php, $tpl) = phorum_api_template_resolve($m[2]);
$mtime = @filemtime($php);
$r['cache_key'] = $mtime;
$module_registrations[$id]['cache_key'] = $mtime;
}
break;
case "function":
if (!isset($r['cache_key'])) {
trigger_error(
"javascript_register hook: module registration " .
"error: \"cache_key\" field missing for source " .
"\"{$r['source']}\" in module \"{$r['module']}\"."
);
exit(1);
}
break;
}
} else {
trigger_error(
"javascript_register hook: module registration error: " .
"illegal format for source definition \"{$r['source']}\" " .
"in module \"{$r['module']}\"."
);
exit(1);
}
$cache_key .= '|' . $r['module'] . ':' . $r['cache_key'];
}
$cache_key = md5($cache_key);
$content = NULL;
$cache_time = 0;
if (!empty($PHORUM['cache_javascript'])) {
$cache_data = phorum_cache_get('js', $cache_key);
if ($cache_data !== null) {
list ($cache_time, $content) = $cache_data;
}
}
// Create the cache file if it does not exist or if caching is disabled.
if (isset($PHORUM['args']['refresh']) || $content === null)
{
$content = '';
foreach ($module_registrations as $id => $r)
{
$content .= "/* Added by module \"{$r['module']}\", " .
"{$r['type']} \"{$r['source']}\" */\n";
switch ($r['type'])
{
case "file":
ob_start();
// Make sure that relative paths start with "./",
// just in case "." is not in the PHP include path.
$path = $r['source'][0] == '/'
? $r['source'] : './'.$r['source'];
include $path;
$content .= ob_get_contents();
ob_end_clean();
break;
case "template":
$content .= $r['content'];
break;
case "function":
$content .= call_user_func($r['source']);
break;
}
$content .= "\n\n";
}
/**
* [hook]
* javascript_filter
*
* [description]
* This hook can be used to apply a filter to the Phorum JavaScript
* code. This can for example be used for compressing or cleaning
* up the JavaScript.
*
* [category]
* Templating
*
* [when]
* Right after the javascript.php script has generated a new
* JavaScript file and right before storing that file in the cache.
* The filter hook will not be run for every request to
* javascript.php, but only in case the JavaScript code has
* to be refreshed.
*
* [input]
* The generated JavaScript code.
*
* [output]
* The filtered JavaScript code.
*/
if (isset($PHORUM['hooks']['javascript_filter'])) {
$content = phorum_api_hook('javascript_filter', $content);
}
if (!empty($PHORUM['cache_javascript'])) {
$cache_time = time();
phorum_cache_put('js',$cache_key,array($cache_time,$content),86400);
}
// Send the JavaScript to the browser.
header("Content-Type: text/javascript");
print "/* FRESH */";
print $content;
// Exit here explicitly for not giving back control to portable and
// embedded Phorum setups.
exit(0);
}
// Find the modification time for the cache file.
$last_modified = $cache_time;
// Check if a If-Modified-Since header is in the request. If yes, then
// check if the JavaScript code has changed, based on the filemtime() data from
// above. If nothing changed, then we return a 304 header, to tell the
// browser to use the cached data.
phorum_api_output_last_modify_time($last_modified);
// Send the JavaScript to the browser.
header("Content-Type: text/javascript");
echo $content;
// Exit here explicitly for not giving back control to portable and
// embedded Phorum setups.
exit(0);
?>