2 // This file is part of Moodle - http://moodle.org/
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 // GNU General Public License for more details.
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
18 * This file is responsible for serving of yui Javascript and CSS
21 * @copyright 2009 Petr Skoda (skodak) {@link http://skodak.org}
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26 // disable moodle specific debug messages and any errors in output,
27 // comment out when debugging or better look into error log!
28 define('NO_DEBUG_DISPLAY', true);
30 // we need just the values from config.php and minlib.php
31 define('ABORT_AFTER_CONFIG', true);
32 require('../config.php'); // this stops immediately at the beginning of lib/setup.php
34 // get special url parameters
36 list($parts, $slasharguments) = combo_params();
41 $parts = trim($parts, '&');
43 // Remove any duplicate parts, since each file only needs to be loaded once (which also helps reduce total file size).
44 $parts = implode('&', array_unique(explode('&', $parts)));
46 // Limit length of parts to match the YUI loader limit of 1024, to prevent loading an arbitrary number of files.
47 if (strlen($parts) > 1024) {
48 $parts = substr($parts, 0, 1024);
50 // If the shortened $parts has been cut off mid-way through a filename, trim back to the end of the previous filename.
51 if (substr($parts, -3) !== '.js' && substr($parts, -4) !== '.css') {
52 $parts = substr($parts, 0, strrpos($parts, '&'));
56 // find out what we are serving - only one type per request
58 if (substr($parts, -3) === '.js') {
59 $mimetype = 'application/javascript';
60 } else if (substr($parts, -4) === '.css') {
61 $mimetype = 'text/css';
68 // if they are requesting a revision that's not -1, and they have supplied an
69 // If-Modified-Since header, we can send back a 304 Not Modified since the
70 // content never changes (the rev number is increased any time the content changes)
71 if (strpos($parts, '/-1/') === false and (!empty($_SERVER['HTTP_IF_NONE_MATCH']) ||
!empty($_SERVER['HTTP_IF_MODIFIED_SINCE']))) {
72 $lifetime = 60*60*24*360; // 1 year, we do not change YUI versions often, there are a few custom yui modules
73 header('HTTP/1.1 304 Not Modified');
74 header('Expires: '. gmdate('D, d M Y H:i:s', time() +
$lifetime) .' GMT');
75 header('Cache-Control: public, max-age='.$lifetime);
76 header('Content-Type: '.$mimetype);
77 header('Etag: "'.$etag.'"');
81 $parts = explode('&', $parts);
85 while (count($parts)) {
86 $part = array_shift($parts);
91 $part = min_clean_param($part, 'SAFEPATH');
92 $bits = explode('/', $part);
93 if (count($bits) < 2) {
94 $content .= "\n// Wrong combo resource $part!\n";
98 $version = array_shift($bits);
99 if ($version === 'rollup') {
100 $yuipatchedversion = explode('_', array_shift($bits));
101 $revision = $yuipatchedversion[0];
102 $rollupname = array_shift($bits);
104 if (strpos($rollupname, 'yui-moodlesimple') !== false) {
105 if (substr($rollupname, -3) === '.js') {
106 // Determine which version of this rollup should be used.
108 preg_match('/(-(debug|min))?\.js/', $rollupname, $matches);
109 if (isset($matches[1])) {
110 $filesuffix = $matches[0];
114 } else if (substr($rollupname, -4) === '.css') {
120 // Allow support for revisions on YUI between official releases.
121 // We can just discard the subrevision since it is only used to invalidate the browser cache.
122 $yuipatchedversion = explode('_', $revision);
123 $yuiversion = $yuipatchedversion[0];
142 'node-event-delegate',
147 'querystring-stringify-simple',
155 // Some extras we use everywhere.
159 'event-custom-complex',
163 'attribute-observable',
182 'widget-position-align',
184 'widget-position-constrain',
199 // We need to add these new parts to the beginning of the $parts list, not the end.
200 if ($type === 'js') {
202 foreach ($yuimodules as $module) {
203 $newparts[] = $yuiversion . '/' . $module . '/' . $module . $filesuffix;
205 $newparts[] = 'yuiuseall/yuiuseall';
206 $parts = array_merge($newparts, $parts);
209 foreach ($yuimodules as $module) {
210 $candidate = $yuiversion . '/' . $module . '/assets/skins/sam/' . $module . '.css';
211 if (!file_exists("$CFG->libdir/yuilib/$candidate")) {
214 $newparts[] = $candidate;
217 $parts = array_merge($newparts, $parts);
224 if ($version === 'm') {
227 if ($version === 'moodle') {
228 if (count($bits) <= 3) {
229 // This is an invalid module load attempt.
230 $content .= "\n// Incorrect moodle module inclusion. Not enough component information in {$part}.\n";
233 $revision = (int)array_shift($bits);
234 if ($revision === -1) {
235 // Revision -1 says please don't cache the JS
238 $frankenstyle = array_shift($bits);
239 $filename = array_pop($bits);
240 $modulename = $bits[0];
241 $dir = core_component
::get_component_directory($frankenstyle);
243 // For shifted YUI modules, we need the YUI module name in frankenstyle format.
244 $frankenstylemodulename = join('-', array($version, $frankenstyle, $modulename));
245 $frankenstylefilename = preg_replace('/' . $modulename . '/', $frankenstylemodulename, $filename);
247 // Submodules are stored in a directory with the full submodule name.
248 // We need to remove the -debug.js, -min.js, and .js from the file name to calculate that directory name.
249 $frankenstyledirectoryname = str_replace(array('-min.js', '-debug.js', '.js', '.css'), '', $frankenstylefilename);
251 // By default, try and use the /yui/build directory.
252 $contentfile = $dir . '/yui/build/' . $frankenstyledirectoryname;
253 if ($mimetype == 'text/css') {
254 // CSS assets are in a slightly different place to the JS.
255 $contentfile = $contentfile . '/assets/skins/sam/' . $frankenstylefilename;
257 // Add the path to the bits to handle fallback for non-shifted assets.
262 $contentfile = $contentfile . '/' . $frankenstylefilename;
265 // If the shifted versions don't exist, fall back to the non-shifted file.
266 if (!file_exists($contentfile) or !is_file($contentfile)) {
267 // We have to revert to the non-minified and non-debug versions.
268 $filename = preg_replace('/-(min|debug)\./', '.', $filename);
269 $contentfile = $dir . '/yui/' . join('/', $bits) . '/' . $filename;
271 } else if ($version === '2in3') {
272 $contentfile = "$CFG->libdir/yuilib/$part";
274 } else if ($version == 'gallery') {
275 if (count($bits) <= 2) {
276 // This is an invalid module load attempt.
277 $content .= "\n// Incorrect moodle module inclusion. Not enough component information in {$part}.\n";
280 $revision = (int)array_shift($bits);
281 if ($revision === -1) {
282 // Revision -1 says please don't cache the JS
285 $contentfile = "$CFG->libdir/yuilib/gallery/" . join('/', $bits);
287 } else if ($version == 'yuiuseall') {
288 // Create global Y that is available in global scope,
289 // this is the trick behind original SimpleYUI.
290 $filecontent = "var Y = YUI().use('*');";
293 // Allow support for revisions on YUI between official releases.
294 // We can just discard the subrevision since it is only used to invalidate the browser cache.
295 $yuipatchedversion = explode('_', $version);
296 $yuiversion = $yuipatchedversion[0];
297 if ($yuiversion != $CFG->yui3version
) {
298 $content .= "\n// Wrong yui version $part!\n";
301 $newpart = explode('/', $part);
302 $newpart[0] = $yuiversion;
303 $part = implode('/', $newpart);
304 $contentfile = "$CFG->libdir/yuilib/$part";
306 if (!file_exists($contentfile) or !is_file($contentfile)) {
307 $location = '$CFG->dirroot'.preg_replace('/^'.preg_quote($CFG->dirroot
, '/').'/', '', $contentfile);
308 $content .= "\n// Combo resource $part ($location) not found!\n";
312 if (empty($filecontent)) {
313 $filecontent = file_get_contents($contentfile);
315 $fmodified = filemtime($contentfile);
316 if ($fmodified > $lastmodified) {
317 $lastmodified = $fmodified;
320 $relroot = preg_replace('|^http.?://[^/]+|', '', $CFG->wwwroot
);
321 $sep = ($slasharguments ?
'/' : '?file=');
323 if ($mimetype === 'text/css') {
324 if ($version == 'moodle') {
325 // Search for all images in the file and replace with an appropriate link to the yui_image.php script
334 $filecontent = preg_replace('/([a-z0-9_-]+)\.(png|gif)/', $relroot . '/theme/yui_image.php' . implode('/', $imagebits), $filecontent);
335 } else if ($version == '2in3') {
336 // First we need to remove relative paths to images. These are used by YUI modules to make use of global assets.
337 // I've added this as a separate regex so it can be easily removed once
338 // YUI standardise there CSS methods
339 $filecontent = preg_replace('#(\.\./\.\./\.\./\.\./assets/skins/sam/)?([a-z0-9_-]+)\.(png|gif)#', '$2.$3', $filecontent);
341 // search for all images in yui2 CSS and serve them through the yui_image.php script
342 $filecontent = preg_replace('/([a-z0-9_-]+)\.(png|gif)/', $relroot.'/theme/yui_image.php'.$sep.$CFG->yui2version
.'/$1.$2', $filecontent);
344 } else if ($version == 'gallery') {
345 // Replace any references to the CDN with a relative link.
346 $filecontent = preg_replace('#(' . preg_quote('http://yui.yahooapis.com/') . '(gallery-[^/]*/))#', '../../../../', $filecontent);
348 // Replace all relative image links with the a link to yui_image.php.
349 $filecontent = preg_replace('#(' . preg_quote('../../../../') . ')(gallery-[^/]*/assets/skins/sam/[a-z0-9_-]+)\.(png|gif)#',
350 $relroot . '/theme/yui_image.php' . $sep . '/gallery/' . $revision . '/$2.$3', $filecontent);
353 // First we need to remove relative paths to images. These are used by YUI modules to make use of global assets.
354 // I've added this as a separate regex so it can be easily removed once
355 // YUI standardise there CSS methods
356 $filecontent = preg_replace('#(\.\./\.\./\.\./\.\./assets/skins/sam/)?([a-z0-9_-]+)\.(png|gif)#', '$2.$3', $filecontent);
358 // search for all images in yui2 CSS and serve them through the yui_image.php script
359 $filecontent = preg_replace('/([a-z0-9_-]+)\.(png|gif)/', $relroot.'/theme/yui_image.php'.$sep.$version.'/$1.$2', $filecontent);
363 $content .= $filecontent;
366 if ($lastmodified == 0) {
367 $lastmodified = time();
371 combo_send_cached($content, $mimetype, $etag, $lastmodified);
373 combo_send_uncached($content, $mimetype);
378 * Send the JavaScript cached
379 * @param string $content
380 * @param string $mimetype
381 * @param string $etag
382 * @param int $lastmodified
384 function combo_send_cached($content, $mimetype, $etag, $lastmodified) {
385 $lifetime = 60*60*24*360; // 1 year, we do not change YUI versions often, there are a few custom yui modules
387 header('Content-Disposition: inline; filename="combo"');
388 header('Last-Modified: '. gmdate('D, d M Y H:i:s', $lastmodified) .' GMT');
389 header('Expires: '. gmdate('D, d M Y H:i:s', time() +
$lifetime) .' GMT');
391 header('Cache-Control: public, max-age='.$lifetime.', immutable');
392 header('Accept-Ranges: none');
393 header('Content-Type: '.$mimetype);
394 header('Etag: "'.$etag.'"');
395 if (!min_enable_zlib_compression()) {
396 header('Content-Length: '.strlen($content));
404 * Send the JavaScript uncached
405 * @param string $content
406 * @param string $mimetype
408 function combo_send_uncached($content, $mimetype) {
409 header('Content-Disposition: inline; filename="combo"');
410 header('Last-Modified: '. gmdate('D, d M Y H:i:s', time()) .' GMT');
411 header('Expires: '. gmdate('D, d M Y H:i:s', time() +
2) .' GMT');
413 header('Accept-Ranges: none');
414 header('Content-Type: '.$mimetype);
415 if (!min_enable_zlib_compression()) {
416 header('Content-Length: '.strlen($content));
423 function combo_not_found($message = '') {
424 header('HTTP/1.0 404 not found');
428 echo 'Combo resource not found, sorry.';
433 function combo_params() {
434 if (isset($_SERVER['QUERY_STRING']) and strpos($_SERVER['QUERY_STRING'], 'file=/') === 0) {
436 $slashargument = substr($_SERVER['QUERY_STRING'], 6);
437 return array($slashargument, true);
439 } else if (isset($_SERVER['REQUEST_URI']) and strpos($_SERVER['REQUEST_URI'], '?') !== false) {
440 $parts = explode('?', $_SERVER['REQUEST_URI'], 2);
441 return array($parts[1], false);
443 } else if (isset($_SERVER['QUERY_STRING']) and strpos($_SERVER['QUERY_STRING'], '?') !== false) {
444 // note: buggy or misconfigured IIS does return the query string in REQUEST_URI
445 return array($_SERVER['QUERY_STRING'], false);
447 } else if ($slashargument = min_get_slash_argument(false)) {
448 $slashargument = ltrim($slashargument, '/');
449 return array($slashargument, true);
452 // unsupported server, sorry!
453 combo_not_found('Unsupported server - query string can not be determined, try disabling YUI combo loading in admin settings.');