MDL-62497 javascript: add babel transpiling to Grunt for ES6 support
[moodle.git] / lib / jssourcemap.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 the javascript source map.
19  *
20  * @package    core
21  * @copyright  2019 Ryan Wyllie
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 // Some (huge) modules are better loaded lazily (when they are used). If we are requesting
61 // one of these modules, only return the one module, not the combo.
62 $lazysuffix = "-lazy.js";
63 $lazyload = (strpos($module, $lazysuffix) !== false);
65 if ($lazyload) {
66     $jsfiles = core_requirejs::find_one_amd_module($component, $module, false);
67 } else {
68     $jsfiles = core_requirejs::find_all_amd_modules(false);
69 }
71 // Create the empty source map.
72 $map = [
73     'version' => 3,
74     'file' => $CFG->wwwroot . '/lib/requirejs.php/' . $slashargument,
75     'sections' => []
76 ];
78 $line = 0;
79 // Sort the files to ensure consistent ordering for source map generation.
80 asort($jsfiles);
82 foreach ($jsfiles as $modulename => $jsfile) {
83     $shortfilename = str_replace($CFG->dirroot, '', $jsfile);
84     $srcfilename = str_replace('/amd/build/', '/amd/src/', $shortfilename);
85     $srcfilename = str_replace('.min.js', '.js', $srcfilename);
87     $mapfile = $jsfile . '.map';
88     if (file_exists($mapfile)) {
89         $mapdata = file_get_contents($mapfile);
90         $mapdata = json_decode($mapdata, true);
91         unset($mapdata['sourcesContent']);
92         $mapdata['sources'][0] = $CFG->wwwroot . $srcfilename;
94         $map['sections'][] = [
95             'offset' => [
96                 'line' => $line,
97                 'column' => 0
98             ],
99             'map' => $mapdata
100         ];
102         $js = file_get_contents($jsfile);
103         // Remove source map link.
104         $js = preg_replace('~//# sourceMappingURL.*$~s', '', $js);
105     } else {
106         // No sourcemap for this section which means we will have returned the original
107         // source file to the browser. We have to provide an empty source map to
108         // ensure that this section is not treated as part of the previous map.
109         $map['sections'][] = [
110             'offset' => [
111                 'line' => $line,
112                 'column' => 0,
113             ],
114             'map' => [
115                 'version' => 3,
116                 'file' => $shortfilename,
117                 'sources' => [$CFG->wwwroot . $srcfilename],
118                 'sourcesContent' => [null],
119                 'names' => [],
120                 'mappings' => ''
121             ]
122         ];
123         // Load the original source file to calculate the number of lines we'll need to
124         // skip forward for the next source map section.
125         $js = file_get_contents($CFG->dirroot . $srcfilename);
126     }
128     $js = rtrim($js);
130     $line += substr_count($js, "\n") + 1;
133 js_send_uncached(json_encode($map), 'jssourcemap.php');