weekly release 3.7dev
[moodle.git] / theme / yui_combo.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
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.
8 //
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.
13 //
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/>.
17 /**
18  * This file is responsible for serving of yui Javascript and CSS
19  *
20  * @package   core
21  * @copyright 2009 Petr Skoda (skodak)  {@link http://skodak.org}
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
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();
37 if (!$parts) {
38     combo_not_found();
39 }
41 $etag = sha1($parts);
42 $parts = trim($parts, '&');
44 // find out what we are serving - only one type per request
45 $content = '';
46 if (substr($parts, -3) === '.js') {
47     $mimetype = 'application/javascript';
48 } else if (substr($parts, -4) === '.css') {
49     $mimetype = 'text/css';
50 } else {
51     combo_not_found();
52 }
54 // if they are requesting a revision that's not -1, and they have supplied an
55 // If-Modified-Since header, we can send back a 304 Not Modified since the
56 // content never changes (the rev number is increased any time the content changes)
57 if (strpos($parts, '/-1/') === false and (!empty($_SERVER['HTTP_IF_NONE_MATCH']) || !empty($_SERVER['HTTP_IF_MODIFIED_SINCE']))) {
58     $lifetime = 60*60*24*360; // 1 year, we do not change YUI versions often, there are a few custom yui modules
59     header('HTTP/1.1 304 Not Modified');
60     header('Expires: '. gmdate('D, d M Y H:i:s', time() + $lifetime) .' GMT');
61     header('Cache-Control: public, max-age='.$lifetime);
62     header('Content-Type: '.$mimetype);
63     header('Etag: "'.$etag.'"');
64     die;
65 }
67 $parts = explode('&', $parts);
68 $cache = true;
69 $lastmodified = 0;
71 while (count($parts)) {
72     $part = array_shift($parts);
73     if (empty($part)) {
74         continue;
75     }
76     $filecontent = '';
77     $part = min_clean_param($part, 'SAFEPATH');
78     $bits = explode('/', $part);
79     if (count($bits) < 2) {
80         $content .= "\n// Wrong combo resource $part!\n";
81         continue;
82     }
84     $version = array_shift($bits);
85     if ($version === 'rollup') {
86         $yuipatchedversion = explode('_', array_shift($bits));
87         $revision = $yuipatchedversion[0];
88         $rollupname = array_shift($bits);
90         if (strpos($rollupname, 'yui-moodlesimple') !== false) {
91             if (substr($rollupname, -3) === '.js') {
92                 // Determine which version of this rollup should be used.
93                 $filesuffix = '.js';
94                 preg_match('/(-(debug|min))?\.js/', $rollupname, $matches);
95                 if (isset($matches[1])) {
96                     $filesuffix = $matches[0];
97                 }
99                 $type = 'js';
100             } else if (substr($rollupname, -4) === '.css') {
101                 $type = 'css';
102             } else {
103                 continue;
104             }
106             // Allow support for revisions on YUI between official releases.
107             // We can just discard the subrevision since it is only used to invalidate the browser cache.
108             $yuipatchedversion = explode('_', $revision);
109             $yuiversion = $yuipatchedversion[0];
111             $yuimodules = array(
112                 'yui',
113                 'oop',
114                 'event-custom-base',
115                 'dom-core',
116                 'dom-base',
117                 'color-base',
118                 'dom-style',
119                 'selector-native',
120                 'selector',
121                 'node-core',
122                 'node-base',
123                 'event-base',
124                 'event-base-ie',
125                 'pluginhost-base',
126                 'pluginhost-config',
127                 'event-delegate',
128                 'node-event-delegate',
129                 'node-pluginhost',
130                 'dom-screen',
131                 'node-screen',
132                 'node-style',
133                 'querystring-stringify-simple',
134                 'io-base',
135                 'json-parse',
136                 'transition',
137                 'selector-css2',
138                 'selector-css3',
139                 'dom-style-ie',
141                 // Some extras we use everywhere.
142                 'escape',
144                 'attribute-core',
145                 'event-custom-complex',
146                 'base-core',
147                 'attribute-base',
148                 'attribute-extras',
149                 'attribute-observable',
150                 'base-observable',
151                 'base-base',
152                 'base-pluginhost',
153                 'base-build',
154                 'event-synthetic',
156                 'attribute-complex',
157                 'event-mouseenter',
158                 'event-key',
159                 'event-outside',
160                 'event-focus',
161                 'classnamemanager',
162                 'widget-base',
163                 'widget-htmlparser',
164                 'widget-skin',
165                 'widget-uievents',
166                 'widget-stdmod',
167                 'widget-position',
168                 'widget-position-align',
169                 'widget-stack',
170                 'widget-position-constrain',
171                 'overlay',
173                 'widget-autohide',
174                 'button-core',
175                 'button-plugin',
176                 'widget-buttons',
177                 'widget-modality',
178                 'panel',
179                 'yui-throttle',
180                 'dd-ddm-base',
181                 'dd-drag',
182                 'dd-plugin',
184                 // Cache is used by moodle-core-tooltip which we include everywhere.
185                 'cache-base',
186             );
188             // We need to add these new parts to the beginning of the $parts list, not the end.
189             if ($type === 'js') {
190                 $newparts = array();
191                 foreach ($yuimodules as $module) {
192                     $newparts[] = $yuiversion . '/' . $module . '/' . $module . $filesuffix;
193                 }
194                 $newparts[] = 'yuiuseall/yuiuseall';
195                 $parts = array_merge($newparts, $parts);
196             } else {
197                 $newparts = array();
198                 foreach ($yuimodules as $module) {
199                     $candidate =  $yuiversion . '/' . $module . '/assets/skins/sam/' . $module . '.css';
200                     if (!file_exists("$CFG->libdir/yuilib/$candidate")) {
201                         continue;
202                     }
203                     $newparts[] = $candidate;
204                 }
205                 if ($newparts) {
206                     $parts = array_merge($newparts, $parts);
207                 }
208             }
209         }
211         continue;
212     }
213     if ($version === 'm') {
214         $version = 'moodle';
215     }
216     if ($version === 'moodle') {
217         if (count($bits) <= 3) {
218             // This is an invalid module load attempt.
219             $content .= "\n// Incorrect moodle module inclusion. Not enough component information in {$part}.\n";
220             continue;
221         }
222         $revision = (int)array_shift($bits);
223         if ($revision === -1) {
224             // Revision -1 says please don't cache the JS
225             $cache = false;
226         }
227         $frankenstyle = array_shift($bits);
228         $filename = array_pop($bits);
229         $modulename = $bits[0];
230         $dir = core_component::get_component_directory($frankenstyle);
232         // For shifted YUI modules, we need the YUI module name in frankenstyle format.
233         $frankenstylemodulename = join('-', array($version, $frankenstyle, $modulename));
234         $frankenstylefilename = preg_replace('/' . $modulename . '/', $frankenstylemodulename, $filename);
236         // Submodules are stored in a directory with the full submodule name.
237         // We need to remove the -debug.js, -min.js, and .js from the file name to calculate that directory name.
238         $frankenstyledirectoryname = str_replace(array('-min.js', '-debug.js', '.js', '.css'), '', $frankenstylefilename);
240         // By default, try and use the /yui/build directory.
241         $contentfile = $dir . '/yui/build/' . $frankenstyledirectoryname;
242         if ($mimetype == 'text/css') {
243             // CSS assets are in a slightly different place to the JS.
244             $contentfile = $contentfile . '/assets/skins/sam/' . $frankenstylefilename;
246             // Add the path to the bits to handle fallback for non-shifted assets.
247             $bits[] = 'assets';
248             $bits[] = 'skins';
249             $bits[] = 'sam';
250         } else {
251             $contentfile = $contentfile . '/' . $frankenstylefilename;
252         }
254         // If the shifted versions don't exist, fall back to the non-shifted file.
255         if (!file_exists($contentfile) or !is_file($contentfile)) {
256             // We have to revert to the non-minified and non-debug versions.
257             $filename = preg_replace('/-(min|debug)\./', '.', $filename);
258             $contentfile = $dir . '/yui/' . join('/', $bits) . '/' . $filename;
259         }
260     } else if ($version === '2in3') {
261         $contentfile = "$CFG->libdir/yuilib/$part";
263     } else if ($version == 'gallery') {
264         if (count($bits) <= 2) {
265             // This is an invalid module load attempt.
266             $content .= "\n// Incorrect moodle module inclusion. Not enough component information in {$part}.\n";
267             continue;
268         }
269         $revision = (int)array_shift($bits);
270         if ($revision === -1) {
271             // Revision -1 says please don't cache the JS
272             $cache = false;
273         }
274         $contentfile = "$CFG->libdir/yuilib/gallery/" . join('/', $bits);
276     } else if ($version == 'yuiuseall') {
277         // Create global Y that is available in global scope,
278         // this is the trick behind original SimpleYUI.
279         $filecontent = "var Y = YUI().use('*');";
281     } else {
282         // Allow support for revisions on YUI between official releases.
283         // We can just discard the subrevision since it is only used to invalidate the browser cache.
284         $yuipatchedversion = explode('_', $version);
285         $yuiversion = $yuipatchedversion[0];
286         if ($yuiversion != $CFG->yui3version) {
287             $content .= "\n// Wrong yui version $part!\n";
288             continue;
289         }
290         $newpart = explode('/', $part);
291         $newpart[0] = $yuiversion;
292         $part = implode('/', $newpart);
293         $contentfile = "$CFG->libdir/yuilib/$part";
294     }
295     if (!file_exists($contentfile) or !is_file($contentfile)) {
296         $location = '$CFG->dirroot'.preg_replace('/^'.preg_quote($CFG->dirroot, '/').'/', '', $contentfile);
297         $content .= "\n// Combo resource $part ($location) not found!\n";
298         continue;
299     }
301     if (empty($filecontent)) {
302         $filecontent = file_get_contents($contentfile);
303     }
304     $fmodified = filemtime($contentfile);
305     if ($fmodified > $lastmodified) {
306         $lastmodified = $fmodified;
307     }
309     $relroot = preg_replace('|^http.?://[^/]+|', '', $CFG->wwwroot);
310     $sep = ($slasharguments ? '/' : '?file=');
312     if ($mimetype === 'text/css') {
313         if ($version == 'moodle') {
314             // Search for all images in the file and replace with an appropriate link to the yui_image.php script
315             $imagebits = array(
316                 $sep . $version,
317                 $frankenstyle,
318                 $modulename,
319                 array_shift($bits),
320                 '$1.$2'
321             );
323             $filecontent = preg_replace('/([a-z0-9_-]+)\.(png|gif)/', $relroot . '/theme/yui_image.php' . implode('/', $imagebits), $filecontent);
324         } else if ($version == '2in3') {
325             // First we need to remove relative paths to images. These are used by YUI modules to make use of global assets.
326             // I've added this as a separate regex so it can be easily removed once
327             // YUI standardise there CSS methods
328             $filecontent = preg_replace('#(\.\./\.\./\.\./\.\./assets/skins/sam/)?([a-z0-9_-]+)\.(png|gif)#', '$2.$3', $filecontent);
330             // search for all images in yui2 CSS and serve them through the yui_image.php script
331             $filecontent = preg_replace('/([a-z0-9_-]+)\.(png|gif)/', $relroot.'/theme/yui_image.php'.$sep.$CFG->yui2version.'/$1.$2', $filecontent);
333         } else if ($version == 'gallery') {
334             // Replace any references to the CDN with a relative link.
335             $filecontent = preg_replace('#(' . preg_quote('http://yui.yahooapis.com/') . '(gallery-[^/]*/))#', '../../../../', $filecontent);
337             // Replace all relative image links with the a link to yui_image.php.
338             $filecontent = preg_replace('#(' . preg_quote('../../../../') . ')(gallery-[^/]*/assets/skins/sam/[a-z0-9_-]+)\.(png|gif)#',
339                     $relroot . '/theme/yui_image.php' . $sep . '/gallery/' . $revision . '/$2.$3', $filecontent);
341         } else {
342             // First we need to remove relative paths to images. These are used by YUI modules to make use of global assets.
343             // I've added this as a separate regex so it can be easily removed once
344             // YUI standardise there CSS methods
345             $filecontent = preg_replace('#(\.\./\.\./\.\./\.\./assets/skins/sam/)?([a-z0-9_-]+)\.(png|gif)#', '$2.$3', $filecontent);
347             // search for all images in yui2 CSS and serve them through the yui_image.php script
348             $filecontent = preg_replace('/([a-z0-9_-]+)\.(png|gif)/', $relroot.'/theme/yui_image.php'.$sep.$version.'/$1.$2', $filecontent);
349         }
350     }
352     $content .= $filecontent;
355 if ($lastmodified == 0) {
356     $lastmodified = time();
359 if ($cache) {
360     combo_send_cached($content, $mimetype, $etag, $lastmodified);
361 } else {
362     combo_send_uncached($content, $mimetype);
366 /**
367  * Send the JavaScript cached
368  * @param string $content
369  * @param string $mimetype
370  * @param string $etag
371  * @param int $lastmodified
372  */
373 function combo_send_cached($content, $mimetype, $etag, $lastmodified) {
374     $lifetime = 60*60*24*360; // 1 year, we do not change YUI versions often, there are a few custom yui modules
376     header('Content-Disposition: inline; filename="combo"');
377     header('Last-Modified: '. gmdate('D, d M Y H:i:s', $lastmodified) .' GMT');
378     header('Expires: '. gmdate('D, d M Y H:i:s', time() + $lifetime) .' GMT');
379     header('Pragma: ');
380     header('Cache-Control: public, max-age='.$lifetime.', immutable');
381     header('Accept-Ranges: none');
382     header('Content-Type: '.$mimetype);
383     header('Etag: "'.$etag.'"');
384     if (!min_enable_zlib_compression()) {
385         header('Content-Length: '.strlen($content));
386     }
388     echo $content;
389     die;
392 /**
393  * Send the JavaScript uncached
394  * @param string $content
395  * @param string $mimetype
396  */
397 function combo_send_uncached($content, $mimetype) {
398     header('Content-Disposition: inline; filename="combo"');
399     header('Last-Modified: '. gmdate('D, d M Y H:i:s', time()) .' GMT');
400     header('Expires: '. gmdate('D, d M Y H:i:s', time() + 2) .' GMT');
401     header('Pragma: ');
402     header('Accept-Ranges: none');
403     header('Content-Type: '.$mimetype);
404     if (!min_enable_zlib_compression()) {
405         header('Content-Length: '.strlen($content));
406     }
408     echo $content;
409     die;
412 function combo_not_found($message = '') {
413     header('HTTP/1.0 404 not found');
414     if ($message) {
415         echo $message;
416     } else {
417         echo 'Combo resource not found, sorry.';
418     }
419     die;
422 function combo_params() {
423     if (isset($_SERVER['QUERY_STRING']) and strpos($_SERVER['QUERY_STRING'], 'file=/') === 0) {
424         // url rewriting
425         $slashargument = substr($_SERVER['QUERY_STRING'], 6);
426         return array($slashargument, true);
428     } else if (isset($_SERVER['REQUEST_URI']) and strpos($_SERVER['REQUEST_URI'], '?') !== false) {
429         $parts = explode('?', $_SERVER['REQUEST_URI'], 2);
430         return array($parts[1], false);
432     } else if (isset($_SERVER['QUERY_STRING']) and strpos($_SERVER['QUERY_STRING'], '?') !== false) {
433         // note: buggy or misconfigured IIS does return the query string in REQUEST_URI
434         return array($_SERVER['QUERY_STRING'], false);
436     } else if ($slashargument = min_get_slash_argument(false)) {
437         $slashargument = ltrim($slashargument, '/');
438         return array($slashargument, true);
440     } else {
441         // unsupported server, sorry!
442         combo_not_found('Unsupported server - query string can not be determined, try disabling YUI combo loading in admin settings.');
443     }