047fa3f8824928ac60b0b7250432f49099499efa
[moodle.git] / lib / requirejs.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 serving optimised JS for RequireJS.
19  *
20  * @package    core
21  * @copyright  2015 Damyon Wiese
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 // Disable moodle specific debug messages and any errors in output,
26 // comment out when debugging or better look into error log!
27 define('NO_DEBUG_DISPLAY', true);
29 // We need just the values from config.php and minlib.php.
30 define('ABORT_AFTER_CONFIG', true);
31 require('../config.php'); // This stops immediately at the beginning of lib/setup.php.
32 require_once("$CFG->dirroot/lib/jslib.php");
33 require_once("$CFG->dirroot/lib/classes/requirejs.php");
35 $slashargument = min_get_slash_argument();
36 if (!$slashargument) {
37     // The above call to min_get_slash_argument should always work.
38     die('Invalid request');
39 }
41 $slashargument = ltrim($slashargument, '/');
42 if (substr_count($slashargument, '/') < 1) {
43     header('HTTP/1.0 404 not found');
44     die('Slash argument must contain both a revision and a file path');
45 }
46 // Split into revision and module name.
47 list($rev, $file) = explode('/', $slashargument, 2);
48 $rev  = min_clean_param($rev, 'INT');
49 $file = '/' . min_clean_param($file, 'SAFEPATH');
51 // Only load js files from the js modules folder from the components.
52 $jsfiles = array();
53 list($unused, $component, $module) = explode('/', $file, 3);
55 // No subdirs allowed - only flat module structure please.
56 if (strpos('/', $module) !== false) {
57     die('Invalid module');
58 }
60 // Use the caching only for meaningful revision numbers which prevents future cache poisoning.
61 if ($rev > 0 and $rev < (time() + 60 * 60)) {
62     // This is "production mode".
63     // Some (huge) modules are better loaded lazily (when they are used). If we are requesting
64     // one of these modules, only return the one module, not the combo.
65     $lazysuffix = "-lazy.js";
66     $lazyload = (strpos($module, $lazysuffix) !== false);
68     if ($lazyload) {
69         // We are lazy loading a single file - so include the component/filename pair in the etag.
70         $etag = sha1($rev . '/' . $component . '/' . $module);
71     } else {
72         // We loading all (non-lazy) files - so only the rev makes this request unique.
73         $etag = sha1($rev);
74     }
76     $candidate = $CFG->localcachedir . '/requirejs/' . $etag;
78     if (file_exists($candidate)) {
79         if (!empty($_SERVER['HTTP_IF_NONE_MATCH']) || !empty($_SERVER['HTTP_IF_MODIFIED_SINCE'])) {
80             // We do not actually need to verify the etag value because our files
81             // never change in cache because we increment the rev parameter.
82             js_send_unmodified(filemtime($candidate), $etag);
83         }
84         js_send_cached($candidate, $etag, 'requirejs.php');
85         exit(0);
87     } else {
88         $jsfiles = array();
89         if ($lazyload) {
90             $jsfiles = core_requirejs::find_one_amd_module($component, $module);
91         } else {
92             // Here we respond to the request by returning ALL amd modules. This saves
93             // round trips in production.
95             $jsfiles = core_requirejs::find_all_amd_modules();
96         }
98         $content = '';
99         foreach ($jsfiles as $modulename => $jsfile) {
100             $js = file_get_contents($jsfile);
101             if ($js === false) {
102                 error_log('Failed to load JavaScript file ' . $jsfile);
103                 $js = "/* Failed to load JavaScript file {$jsfile}. */\n";
104                 $content = $js . $content;
105                 continue;
106             }
107             // Remove source map link.
108             $js = preg_replace('~//# sourceMappingURL.*$~s', '', $js);
109             $js = rtrim($js);
110             $js .= "\n";
112             if (preg_match('/define\(\s*\[/', $js)) {
113                 // If the JavaScript module has been defined without specifying a name then we'll
114                 // add the Moodle module name now.
115                 $replace = 'define(\'' . $modulename . '\', ';
116                 $search = 'define(';
117                 // Replace only the first occurrence.
118                 $js = implode($replace, explode($search, $js, 2));
119             }
121             $content .= $js;
122         }
124         js_write_cache_file_content($candidate, $content);
125         // Verify nothing failed in cache file creation.
126         clearstatcache();
127         if (file_exists($candidate)) {
128             js_send_cached($candidate, $etag, 'requirejs.php');
129             exit(0);
130         }
131     }
134 // If we've made it here then we're in "dev mode" where everything is lazy loaded.
135 // So all files will be served one at a time.
136 $jsfiles = core_requirejs::find_one_amd_module($component, $module, false);
138 if (!empty($jsfiles)) {
139     $modulename = array_keys($jsfiles)[0];
140     $jsfile = $jsfiles[$modulename];
141     $shortfilename = str_replace($CFG->dirroot, '', $jsfile);
142     $mapfile = $jsfile . '.map';
144     if (file_exists($mapfile)) {
145         // We've got a a source map file so we can return the minified file here and
146         // the source map will be used by the browser to debug.
147         $js = file_get_contents($jsfile);
148         // Fix the source map link for the file.
149         $js = preg_replace(
150             '~//# sourceMappingURL.*$~s',
151             "//# sourceMappingURL={$CFG->wwwroot}/lib/jssourcemap.php{$file}",
152             $js
153         );
154         $js = rtrim($js);
155     } else {
156         // This file doesn't have a map file. We might be dealing with an older source file from
157         // a plugin or previous version of Moodle so we should just return the full original source
158         // like we used to.
159         $originalsource = str_replace('/amd/build/', '/amd/src/', $jsfile);
160         $originalsource = str_replace('.min.js', '.js', $originalsource);
161         $js = file_get_contents($originalsource);
162         $js = rtrim($js);
163     }
165     if (preg_match('/define\(\s*\[/', $js)) {
166         // If the JavaScript module has been defined without specifying a name then we'll
167         // add the Moodle module name now.
168         $replace = 'define(\'' . $modulename . '\', ';
170         // Replace only the first occurrence.
171         $js = implode($replace, explode('define(', $js, 2));
172     } else if (!preg_match('/define\s*\(/', $js)) {
173         debugging('JS file: ' . $shortfilename . ' cannot be loaded, or does not contain a javascript' .
174                   ' module in AMD format. "define()" not found.', DEBUG_DEVELOPER);
175     }
177     js_send_uncached($js, 'requirejs.php');
178 } else {
179     // We can't find the requested file.
180     header('HTTP/1.0 404 not found');