5bd654bdec90dd02efca5dd671b7c164b36d8b2a
[moodle.git] / lib / outputrequirementslib.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  * Library functions to facilitate the use of JavaScript in Moodle.
19  *
20  * Note: you can find history of this file in lib/ajax/ajaxlib.php
21  *
22  * @copyright 2009 Tim Hunt, 2010 Petr Skoda
23  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  * @package core
25  * @category output
26  */
28 defined('MOODLE_INTERNAL') || die();
30 /**
31  * This class tracks all the things that are needed by the current page.
32  *
33  * Normally, the only instance of this  class you will need to work with is the
34  * one accessible via $PAGE->requires.
35  *
36  * Typical usage would be
37  * <pre>
38  *     $PAGE->requires->js_call_amd('mod_forum/view', 'init');
39  * </pre>
40  *
41  * It also supports obsoleted coding style with/without YUI3 modules.
42  * <pre>
43  *     $PAGE->requires->js_init_call('M.mod_forum.init_view');
44  *     $PAGE->requires->css('/mod/mymod/userstyles.php?id='.$id); // not overridable via themes!
45  *     $PAGE->requires->js('/mod/mymod/script.js');
46  *     $PAGE->requires->js('/mod/mymod/small_but_urgent.js', true);
47  *     $PAGE->requires->js_function_call('init_mymod', array($data), true);
48  * </pre>
49  *
50  * There are some natural restrictions on some methods. For example, {@link css()}
51  * can only be called before the <head> tag is output. See the comments on the
52  * individual methods for details.
53  *
54  * @copyright 2009 Tim Hunt, 2010 Petr Skoda
55  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
56  * @since Moodle 2.0
57  * @package core
58  * @category output
59  */
60 class page_requirements_manager {
62     /**
63      * @var array List of string available from JS
64      */
65     protected $stringsforjs = array();
67     /**
68      * @var array List of get_string $a parameters - used for validation only.
69      */
70     protected $stringsforjs_as = array();
72     /**
73      * @var array List of JS variables to be initialised
74      */
75     protected $jsinitvariables = array('head'=>array(), 'footer'=>array());
77     /**
78      * @var array Included JS scripts
79      */
80     protected $jsincludes = array('head'=>array(), 'footer'=>array());
82     /**
83      * @var array Inline scripts using RequireJS module loading.
84      */
85     protected $amdjscode = array('');
87     /**
88      * @var array List of needed function calls
89      */
90     protected $jscalls = array('normal'=>array(), 'ondomready'=>array());
92     /**
93      * @var array List of skip links, those are needed for accessibility reasons
94      */
95     protected $skiplinks = array();
97     /**
98      * @var array Javascript code used for initialisation of page, it should
99      * be relatively small
100      */
101     protected $jsinitcode = array();
103     /**
104      * @var array of moodle_url Theme sheets, initialised only from core_renderer
105      */
106     protected $cssthemeurls = array();
108     /**
109      * @var array of moodle_url List of custom theme sheets, these are strongly discouraged!
110      * Useful mostly only for CSS submitted by teachers that is not part of the theme.
111      */
112     protected $cssurls = array();
114     /**
115      * @var array List of requested event handlers
116      */
117     protected $eventhandlers = array();
119     /**
120      * @var array Extra modules
121      */
122     protected $extramodules = array();
124     /**
125      * @var array trackes the names of bits of HTML that are only required once
126      * per page. See {@link has_one_time_item_been_created()},
127      * {@link set_one_time_item_created()} and {@link should_create_one_time_item_now()}.
128      */
129     protected $onetimeitemsoutput = array();
131     /**
132      * @var bool Flag indicated head stuff already printed
133      */
134     protected $headdone = false;
136     /**
137      * @var bool Flag indicating top of body already printed
138      */
139     protected $topofbodydone = false;
141     /**
142      * @var stdClass YUI PHPLoader instance responsible for YUI3 loading from PHP only
143      */
144     protected $yui3loader;
146     /**
147      * @var YUI_config default YUI loader configuration
148      */
149     protected $YUI_config;
151     /**
152      * @var array $yuicssmodules
153      */
154     protected $yuicssmodules = array();
156     /**
157      * @var array Some config vars exposed in JS, please no secret stuff there
158      */
159     protected $M_cfg;
161     /**
162      * @var array list of requested jQuery plugins
163      */
164     protected $jqueryplugins = array();
166     /**
167      * @var array list of jQuery plugin overrides
168      */
169     protected $jquerypluginoverrides = array();
171     /**
172      * Page requirements constructor.
173      */
174     public function __construct() {
175         global $CFG;
177         // You may need to set up URL rewrite rule because oversized URLs might not be allowed by web server.
178         $sep = empty($CFG->yuislasharguments) ? '?' : '/';
180         $this->yui3loader = new stdClass();
181         $this->YUI_config = new YUI_config();
183         if (is_https()) {
184             // On HTTPS sites all JS must be loaded from https sites,
185             // YUI CDN does not support https yet, sorry.
186             $CFG->useexternalyui = 0;
187         }
189         // Set up some loader options.
190         $this->yui3loader->local_base = $CFG->httpswwwroot . '/lib/yuilib/'. $CFG->yui3version . '/';
191         $this->yui3loader->local_comboBase = $CFG->httpswwwroot . '/theme/yui_combo.php'.$sep;
193         if (!empty($CFG->useexternalyui)) {
194             $this->yui3loader->base = 'http://yui.yahooapis.com/' . $CFG->yui3version . '/';
195             $this->yui3loader->comboBase = 'http://yui.yahooapis.com/combo?';
196         } else {
197             $this->yui3loader->base = $this->yui3loader->local_base;
198             $this->yui3loader->comboBase = $this->yui3loader->local_comboBase;
199         }
201         // Enable combo loader? This significantly helps with caching and performance!
202         $this->yui3loader->combine = !empty($CFG->yuicomboloading);
204         $jsrev = $this->get_jsrev();
206         // Set up JS YUI loader helper object.
207         $this->YUI_config->base         = $this->yui3loader->base;
208         $this->YUI_config->comboBase    = $this->yui3loader->comboBase;
209         $this->YUI_config->combine      = $this->yui3loader->combine;
211         // If we've had to patch any YUI modules between releases, we must override the YUI configuration to include them.
212         // For important information on patching YUI modules, please see http://docs.moodle.org/dev/YUI/Patching.
213         if (!empty($CFG->yuipatchedmodules) && !empty($CFG->yuipatchlevel)) {
214             $this->YUI_config->define_patched_core_modules($this->yui3loader->local_comboBase,
215                     $CFG->yui3version,
216                     $CFG->yuipatchlevel,
217                     $CFG->yuipatchedmodules);
218         }
220         $configname = $this->YUI_config->set_config_source('lib/yui/config/yui2.js');
221         $this->YUI_config->add_group('yui2', array(
222             // Loader configuration for our 2in3, for now ignores $CFG->useexternalyui.
223             'base' => $CFG->httpswwwroot . '/lib/yuilib/2in3/' . $CFG->yui2version . '/build/',
224             'comboBase' => $CFG->httpswwwroot . '/theme/yui_combo.php'.$sep,
225             'combine' => $this->yui3loader->combine,
226             'ext' => false,
227             'root' => '2in3/' . $CFG->yui2version .'/build/',
228             'patterns' => array(
229                 'yui2-' => array(
230                     'group' => 'yui2',
231                     'configFn' => $configname,
232                 )
233             )
234         ));
235         $configname = $this->YUI_config->set_config_source('lib/yui/config/moodle.js');
236         $this->YUI_config->add_group('moodle', array(
237             'name' => 'moodle',
238             'base' => $CFG->httpswwwroot . '/theme/yui_combo.php' . $sep . 'm/' . $jsrev . '/',
239             'combine' => $this->yui3loader->combine,
240             'comboBase' => $CFG->httpswwwroot . '/theme/yui_combo.php'.$sep,
241             'ext' => false,
242             'root' => 'm/'.$jsrev.'/', // Add the rev to the root path so that we can control caching.
243             'patterns' => array(
244                 'moodle-' => array(
245                     'group' => 'moodle',
246                     'configFn' => $configname,
247                 )
248             )
249         ));
251         $this->YUI_config->add_group('gallery', array(
252             'name' => 'gallery',
253             'base' => $CFG->httpswwwroot . '/lib/yuilib/gallery/',
254             'combine' => $this->yui3loader->combine,
255             'comboBase' => $CFG->httpswwwroot . '/theme/yui_combo.php' . $sep,
256             'ext' => false,
257             'root' => 'gallery/' . $jsrev . '/',
258             'patterns' => array(
259                 'gallery-' => array(
260                     'group' => 'gallery',
261                 )
262             )
263         ));
265         // Set some more loader options applying to groups too.
266         if ($CFG->debugdeveloper) {
267             // When debugging is enabled, we want to load the non-minified (RAW) versions of YUI library modules rather
268             // than the DEBUG versions as these generally generate too much logging for our purposes.
269             // However we do want the DEBUG versions of our Moodle-specific modules.
270             // To debug a YUI-specific issue, change the yui3loader->filter value to DEBUG.
271             $this->YUI_config->filter = 'RAW';
272             $this->YUI_config->groups['moodle']['filter'] = 'DEBUG';
274             // We use the yui3loader->filter setting when writing the YUI3 seed scripts into the header.
275             $this->yui3loader->filter = $this->YUI_config->filter;
276             $this->YUI_config->debug = true;
277         } else {
278             $this->yui3loader->filter = null;
279             $this->YUI_config->groups['moodle']['filter'] = null;
280             $this->YUI_config->debug = false;
281         }
283         // Include the YUI config log filters.
284         if (!empty($CFG->yuilogexclude) && is_array($CFG->yuilogexclude)) {
285             $this->YUI_config->logExclude = $CFG->yuilogexclude;
286         }
287         if (!empty($CFG->yuiloginclude) && is_array($CFG->yuiloginclude)) {
288             $this->YUI_config->logInclude = $CFG->yuiloginclude;
289         }
290         if (!empty($CFG->yuiloglevel)) {
291             $this->YUI_config->logLevel = $CFG->yuiloglevel;
292         }
294         // Add the moodle group's module data.
295         $this->YUI_config->add_moodle_metadata();
297         // Every page should include definition of following modules.
298         $this->js_module($this->find_module('core_filepicker'));
299         $this->js_module($this->find_module('core_comment'));
300     }
302     /**
303      * Return the safe config values that get set for javascript in "M.cfg".
304      *
305      * @since 2.9
306      * @return array List of safe config values that are available to javascript.
307      */
308     public function get_config_for_javascript(moodle_page $page, renderer_base $renderer) {
309         global $CFG;
311         if (empty($this->M_cfg)) {
312             // JavaScript should always work with $CFG->httpswwwroot rather than $CFG->wwwroot.
313             // Otherwise, in some situations, users will get warnings about insecure content
314             // on secure pages from their web browser.
316             $this->M_cfg = array(
317                 'wwwroot'             => $CFG->httpswwwroot, // Yes, really. See above.
318                 'sesskey'             => sesskey(),
319                 'loadingicon'         => $renderer->pix_url('i/loading_small', 'moodle')->out(false),
320                 'themerev'            => theme_get_revision(),
321                 'slasharguments'      => (int)(!empty($CFG->slasharguments)),
322                 'theme'               => $page->theme->name,
323                 'jsrev'               => $this->get_jsrev(),
324                 'admin'               => $CFG->admin,
325                 'svgicons'            => $page->theme->use_svg_icons()
326             );
327             if ($CFG->debugdeveloper) {
328                 $this->M_cfg['developerdebug'] = true;
329             }
330             if (defined('BEHAT_SITE_RUNNING')) {
331                 $this->M_cfg['behatsiterunning'] = true;
332             }
334         }
335         return $this->M_cfg;
336     }
338     /**
339      * Initialise with the bits of JavaScript that every Moodle page should have.
340      *
341      * @param moodle_page $page
342      * @param core_renderer $renderer
343      */
344     protected function init_requirements_data(moodle_page $page, core_renderer $renderer) {
345         global $CFG;
347         // Init the js config.
348         $this->get_config_for_javascript($page, $renderer);
350         // Accessibility stuff.
351         $this->skip_link_to('maincontent', get_string('tocontent', 'access'));
353         // Add strings used on many pages.
354         $this->string_for_js('confirmation', 'admin');
355         $this->string_for_js('cancel', 'moodle');
356         $this->string_for_js('yes', 'moodle');
358         // Alter links in top frame to break out of frames.
359         if ($page->pagelayout === 'frametop') {
360             $this->js_init_call('M.util.init_frametop');
361         }
363         // Include block drag/drop if editing is on
364         if ($page->user_is_editing()) {
365             $params = array(
366                 'courseid' => $page->course->id,
367                 'pagetype' => $page->pagetype,
368                 'pagelayout' => $page->pagelayout,
369                 'subpage' => $page->subpage,
370                 'regions' => $page->blocks->get_regions(),
371                 'contextid' => $page->context->id,
372             );
373             if (!empty($page->cm->id)) {
374                 $params['cmid'] = $page->cm->id;
375             }
376             // Strings for drag and drop.
377             $this->strings_for_js(array('movecontent',
378                                         'tocontent',
379                                         'emptydragdropregion'),
380                                   'moodle');
381             $page->requires->yui_module('moodle-core-blocks', 'M.core_blocks.init_dragdrop', array($params), null, true);
382         }
384         // Include the YUI CSS Modules.
385         $page->requires->set_yuicssmodules($page->theme->yuicssmodules);
386     }
388     /**
389      * Determine the correct JS Revision to use for this load.
390      *
391      * @return int the jsrev to use.
392      */
393     protected function get_jsrev() {
394         global $CFG;
396         if (empty($CFG->cachejs)) {
397             $jsrev = -1;
398         } else if (empty($CFG->jsrev)) {
399             $jsrev = 1;
400         } else {
401             $jsrev = $CFG->jsrev;
402         }
404         return $jsrev;
405     }
407     /**
408      * Ensure that the specified JavaScript file is linked to from this page.
409      *
410      * NOTE: This function is to be used in RARE CASES ONLY, please store your JS in module.js file
411      * and use $PAGE->requires->js_init_call() instead or use /yui/ subdirectories for YUI modules.
412      *
413      * By default the link is put at the end of the page, since this gives best page-load performance.
414      *
415      * Even if a particular script is requested more than once, it will only be linked
416      * to once.
417      *
418      * @param string|moodle_url $url The path to the .js file, relative to $CFG->dirroot / $CFG->wwwroot.
419      *      For example '/mod/mymod/customscripts.js'; use moodle_url for external scripts
420      * @param bool $inhead initialise in head
421      */
422     public function js($url, $inhead = false) {
423         $url = $this->js_fix_url($url);
424         $where = $inhead ? 'head' : 'footer';
425         $this->jsincludes[$where][$url->out()] = $url;
426     }
428     /**
429      * Request inclusion of jQuery library in the page.
430      *
431      * NOTE: this should not be used in official Moodle distribution!
432      *
433      * We are going to bundle jQuery 1.9.x until we drop support
434      * all support for IE 6-8. Use $PAGE->requires->jquery_plugin('migrate')
435      * for code written for earlier jQuery versions.
436      *
437      * {@see http://docs.moodle.org/dev/jQuery}
438      */
439     public function jquery() {
440         $this->jquery_plugin('jquery');
441     }
443     /**
444      * Request inclusion of jQuery plugin.
445      *
446      * NOTE: this should not be used in official Moodle distribution!
447      *
448      * jQuery plugins are located in plugin/jquery/* subdirectory,
449      * plugin/jquery/plugins.php lists all available plugins.
450      *
451      * Included core plugins:
452      *   - jQuery UI
453      *   - jQuery Migrate (useful for code written for previous UI version)
454      *
455      * Add-ons may include extra jQuery plugins in jquery/ directory,
456      * plugins.php file defines the mapping between plugin names and
457      * necessary page includes.
458      *
459      * Examples:
460      * <code>
461      *   // file: mod/xxx/view.php
462      *   $PAGE->requires->jquery();
463      *   $PAGE->requires->jquery_plugin('ui');
464      *   $PAGE->requires->jquery_plugin('ui-css');
465      * </code>
466      *
467      * <code>
468      *   // file: theme/yyy/lib.php
469      *   function theme_yyy_page_init(moodle_page $page) {
470      *       $page->requires->jquery();
471      *       $page->requires->jquery_plugin('ui');
472      *       $page->requires->jquery_plugin('ui-css');
473      *   }
474      * </code>
475      *
476      * <code>
477      *   // file: blocks/zzz/block_zzz.php
478      *   public function get_required_javascript() {
479      *       parent::get_required_javascript();
480      *       $this->page->requires->jquery();
481      *       $page->requires->jquery_plugin('ui');
482      *       $page->requires->jquery_plugin('ui-css');
483      *   }
484      * </code>
485      *
486      * {@see http://docs.moodle.org/dev/jQuery}
487      *
488      * @param string $plugin name of the jQuery plugin as defined in jquery/plugins.php
489      * @param string $component name of the component
490      * @return bool success
491      */
492     public function jquery_plugin($plugin, $component = 'core') {
493         global $CFG;
495         if ($this->headdone) {
496             debugging('Can not add jQuery plugins after starting page output!');
497             return false;
498         }
500         if ($component !== 'core' and in_array($plugin, array('jquery', 'ui', 'ui-css', 'migrate'))) {
501             debugging("jQuery plugin '$plugin' is included in Moodle core, other components can not use the same name.", DEBUG_DEVELOPER);
502             $component = 'core';
503         } else if ($component !== 'core' and strpos($component, '_') === false) {
504             // Let's normalise the legacy activity names, Frankenstyle rulez!
505             $component = 'mod_' . $component;
506         }
508         if (empty($this->jqueryplugins) and ($component !== 'core' or $plugin !== 'jquery')) {
509             // Make sure the jQuery itself is always loaded first,
510             // the order of all other plugins depends on order of $PAGE_>requires->.
511             $this->jquery_plugin('jquery', 'core');
512         }
514         if (isset($this->jqueryplugins[$plugin])) {
515             // No problem, we already have something, first Moodle plugin to register the jQuery plugin wins.
516             return true;
517         }
519         $componentdir = core_component::get_component_directory($component);
520         if (!file_exists($componentdir) or !file_exists("$componentdir/jquery/plugins.php")) {
521             debugging("Can not load jQuery plugin '$plugin', missing plugins.php in component '$component'.", DEBUG_DEVELOPER);
522             return false;
523         }
525         $plugins = array();
526         require("$componentdir/jquery/plugins.php");
528         if (!isset($plugins[$plugin])) {
529             debugging("jQuery plugin '$plugin' can not be found in component '$component'.", DEBUG_DEVELOPER);
530             return false;
531         }
533         $this->jqueryplugins[$plugin] = new stdClass();
534         $this->jqueryplugins[$plugin]->plugin    = $plugin;
535         $this->jqueryplugins[$plugin]->component = $component;
536         $this->jqueryplugins[$plugin]->urls      = array();
538         foreach ($plugins[$plugin]['files'] as $file) {
539             if ($CFG->debugdeveloper) {
540                 if (!file_exists("$componentdir/jquery/$file")) {
541                     debugging("Invalid file '$file' specified in jQuery plugin '$plugin' in component '$component'");
542                     continue;
543                 }
544                 $file = str_replace('.min.css', '.css', $file);
545                 $file = str_replace('.min.js', '.js', $file);
546             }
547             if (!file_exists("$componentdir/jquery/$file")) {
548                 debugging("Invalid file '$file' specified in jQuery plugin '$plugin' in component '$component'");
549                 continue;
550             }
551             if (!empty($CFG->slasharguments)) {
552                 $url = new moodle_url("$CFG->httpswwwroot/theme/jquery.php");
553                 $url->set_slashargument("/$component/$file");
555             } else {
556                 // This is not really good, we need slasharguments for relative links, this means no caching...
557                 $path = realpath("$componentdir/jquery/$file");
558                 if (strpos($path, $CFG->dirroot) === 0) {
559                     $url = $CFG->httpswwwroot.preg_replace('/^'.preg_quote($CFG->dirroot, '/').'/', '', $path);
560                     // Replace all occurences of backslashes characters in url to forward slashes.
561                     $url = str_replace('\\', '/', $url);
562                     $url = new moodle_url($url);
563                 } else {
564                     // Bad luck, fix your server!
565                     debugging("Moodle jQuery integration requires 'slasharguments' setting to be enabled.");
566                     continue;
567                 }
568             }
569             $this->jqueryplugins[$plugin]->urls[] = $url;
570         }
572         return true;
573     }
575     /**
576      * Request replacement of one jQuery plugin by another.
577      *
578      * This is useful when themes want to replace the jQuery UI theme,
579      * the problem is that theme can not prevent others from including the core ui-css plugin.
580      *
581      * Example:
582      *  1/ generate new jQuery UI theme and place it into theme/yourtheme/jquery/
583      *  2/ write theme/yourtheme/jquery/plugins.php
584      *  3/ init jQuery from theme
585      *
586      * <code>
587      *   // file theme/yourtheme/lib.php
588      *   function theme_yourtheme_page_init($page) {
589      *       $page->requires->jquery_plugin('yourtheme-ui-css', 'theme_yourtheme');
590      *       $page->requires->jquery_override_plugin('ui-css', 'yourtheme-ui-css');
591      *   }
592      * </code>
593      *
594      * This code prevents loading of standard 'ui-css' which my be requested by other plugins,
595      * the 'yourtheme-ui-css' gets loaded only if some other code requires jquery.
596      *
597      * {@see http://docs.moodle.org/dev/jQuery}
598      *
599      * @param string $oldplugin original plugin
600      * @param string $newplugin the replacement
601      */
602     public function jquery_override_plugin($oldplugin, $newplugin) {
603         if ($this->headdone) {
604             debugging('Can not override jQuery plugins after starting page output!');
605             return;
606         }
607         $this->jquerypluginoverrides[$oldplugin] = $newplugin;
608     }
610     /**
611      * Return jQuery related markup for page start.
612      * @return string
613      */
614     protected function get_jquery_headcode() {
615         if (empty($this->jqueryplugins['jquery'])) {
616             // If nobody requested jQuery then do not bother to load anything.
617             // This may be useful for themes that want to override 'ui-css' only if requested by something else.
618             return '';
619         }
621         $included = array();
622         $urls = array();
624         foreach ($this->jqueryplugins as $name => $unused) {
625             if (isset($included[$name])) {
626                 continue;
627             }
628             if (array_key_exists($name, $this->jquerypluginoverrides)) {
629                 // The following loop tries to resolve the replacements,
630                 // use max 100 iterations to prevent infinite loop resulting
631                 // in blank page.
632                 $cyclic = true;
633                 $oldname = $name;
634                 for ($i=0; $i<100; $i++) {
635                     $name = $this->jquerypluginoverrides[$name];
636                     if (!array_key_exists($name, $this->jquerypluginoverrides)) {
637                         $cyclic = false;
638                         break;
639                     }
640                 }
641                 if ($cyclic) {
642                     // We can not do much with cyclic references here, let's use the old plugin.
643                     $name = $oldname;
644                     debugging("Cyclic overrides detected for jQuery plugin '$name'");
646                 } else if (empty($name)) {
647                     // Developer requested removal of the plugin.
648                     continue;
650                 } else if (!isset($this->jqueryplugins[$name])) {
651                     debugging("Unknown jQuery override plugin '$name' detected");
652                     $name = $oldname;
654                 } else if (isset($included[$name])) {
655                     // The plugin was already included, easy.
656                     continue;
657                 }
658             }
660             $plugin = $this->jqueryplugins[$name];
661             $urls = array_merge($urls, $plugin->urls);
662             $included[$name] = true;
663         }
665         $output = '';
666         $attributes = array('rel' => 'stylesheet', 'type' => 'text/css');
667         foreach ($urls as $url) {
668             if (preg_match('/\.js$/', $url)) {
669                 $output .= html_writer::script('', $url);
670             } else if (preg_match('/\.css$/', $url)) {
671                 $attributes['href'] = $url;
672                 $output .= html_writer::empty_tag('link', $attributes) . "\n";
673             }
674         }
676         return $output;
677     }
679     /**
680      * Returns the actual url through which a script is served.
681      *
682      * @param moodle_url|string $url full moodle url, or shortened path to script
683      * @return moodle_url
684      */
685     protected function js_fix_url($url) {
686         global $CFG;
688         if ($url instanceof moodle_url) {
689             return $url;
690         } else if (strpos($url, '/') === 0) {
691             // Fix the admin links if needed.
692             if ($CFG->admin !== 'admin') {
693                 if (strpos($url, "/admin/") === 0) {
694                     $url = preg_replace("|^/admin/|", "/$CFG->admin/", $url);
695                 }
696             }
697             if (debugging()) {
698                 // Check file existence only when in debug mode.
699                 if (!file_exists($CFG->dirroot . strtok($url, '?'))) {
700                     throw new coding_exception('Attempt to require a JavaScript file that does not exist.', $url);
701                 }
702             }
703             if (substr($url, -3) === '.js') {
704                 $jsrev = $this->get_jsrev();
705                 if (empty($CFG->slasharguments)) {
706                     return new moodle_url($CFG->httpswwwroot.'/lib/javascript.php', array('rev'=>$jsrev, 'jsfile'=>$url));
707                 } else {
708                     $returnurl = new moodle_url($CFG->httpswwwroot.'/lib/javascript.php');
709                     $returnurl->set_slashargument('/'.$jsrev.$url);
710                     return $returnurl;
711                 }
712             } else {
713                 return new moodle_url($CFG->httpswwwroot.$url);
714             }
715         } else {
716             throw new coding_exception('Invalid JS url, it has to be shortened url starting with / or moodle_url instance.', $url);
717         }
718     }
720     /**
721      * Find out if JS module present and return details.
722      *
723      * @param string $component name of component in frankenstyle, ex: core_group, mod_forum
724      * @return array description of module or null if not found
725      */
726     protected function find_module($component) {
727         global $CFG, $PAGE;
729         $module = null;
731         if (strpos($component, 'core_') === 0) {
732             // Must be some core stuff - list here is not complete, this is just the stuff used from multiple places
733             // so that we do nto have to repeat the definition of these modules over and over again.
734             switch($component) {
735                 case 'core_filepicker':
736                     $module = array('name'     => 'core_filepicker',
737                                     'fullpath' => '/repository/filepicker.js',
738                                     'requires' => array('base', 'node', 'node-event-simulate', 'json', 'async-queue', 'io-base', 'io-upload-iframe', 'io-form', 'yui2-treeview', 'panel', 'cookie', 'datatable', 'datatable-sort', 'resize-plugin', 'dd-plugin', 'escape', 'moodle-core_filepicker'),
739                                     'strings'  => array(array('lastmodified', 'moodle'), array('name', 'moodle'), array('type', 'repository'), array('size', 'repository'),
740                                                         array('invalidjson', 'repository'), array('error', 'moodle'), array('info', 'moodle'),
741                                                         array('nofilesattached', 'repository'), array('filepicker', 'repository'), array('logout', 'repository'),
742                                                         array('nofilesavailable', 'repository'), array('norepositoriesavailable', 'repository'),
743                                                         array('fileexistsdialogheader', 'repository'), array('fileexistsdialog_editor', 'repository'),
744                                                         array('fileexistsdialog_filemanager', 'repository'), array('renameto', 'repository'),
745                                                         array('referencesexist', 'repository'), array('select', 'repository')
746                                                     ));
747                     break;
748                 case 'core_comment':
749                     $module = array('name'     => 'core_comment',
750                                     'fullpath' => '/comment/comment.js',
751                                     'requires' => array('base', 'io-base', 'node', 'json', 'yui2-animation', 'overlay'),
752                                     'strings' => array(array('confirmdeletecomments', 'admin'), array('yes', 'moodle'), array('no', 'moodle'))
753                                 );
754                     break;
755                 case 'core_role':
756                     $module = array('name'     => 'core_role',
757                                     'fullpath' => '/admin/roles/module.js',
758                                     'requires' => array('node', 'cookie'));
759                     break;
760                 case 'core_completion':
761                     $module = array('name'     => 'core_completion',
762                                     'fullpath' => '/course/completion.js');
763                     break;
764                 case 'core_message':
765                     $module = array('name'     => 'core_message',
766                                     'requires' => array('base', 'node', 'event', 'node-event-simulate'),
767                                     'fullpath' => '/message/module.js');
768                     break;
769                 case 'core_group':
770                     $module = array('name'     => 'core_group',
771                                     'fullpath' => '/group/module.js',
772                                     'requires' => array('node', 'overlay', 'event-mouseenter'));
773                     break;
774                 case 'core_question_engine':
775                     $module = array('name'     => 'core_question_engine',
776                                     'fullpath' => '/question/qengine.js',
777                                     'requires' => array('node', 'event'));
778                     break;
779                 case 'core_rating':
780                     $module = array('name'     => 'core_rating',
781                                     'fullpath' => '/rating/module.js',
782                                     'requires' => array('node', 'event', 'overlay', 'io-base', 'json'));
783                     break;
784                 case 'core_dndupload':
785                     $module = array('name'     => 'core_dndupload',
786                                     'fullpath' => '/lib/form/dndupload.js',
787                                     'requires' => array('node', 'event', 'json', 'core_filepicker'),
788                                     'strings'  => array(array('uploadformlimit', 'moodle'), array('droptoupload', 'moodle'), array('maxfilesreached', 'moodle'),
789                                                         array('dndenabled_inbox', 'moodle'), array('fileexists', 'moodle'), array('maxbytesfile', 'error'),
790                                                         array('sizegb', 'moodle'), array('sizemb', 'moodle'), array('sizekb', 'moodle'), array('sizeb', 'moodle'),
791                                                         array('maxareabytesreached', 'moodle'), array('serverconnection', 'error'),
792                                                     ));
793                     break;
794             }
796         } else {
797             if ($dir = core_component::get_component_directory($component)) {
798                 if (file_exists("$dir/module.js")) {
799                     if (strpos($dir, $CFG->dirroot.'/') === 0) {
800                         $dir = substr($dir, strlen($CFG->dirroot));
801                         $module = array('name'=>$component, 'fullpath'=>"$dir/module.js", 'requires' => array());
802                     }
803                 }
804             }
805         }
807         return $module;
808     }
810     /**
811      * Append YUI3 module to default YUI3 JS loader.
812      * The structure of module array is described at {@link http://developer.yahoo.com/yui/3/yui/}
813      *
814      * @param string|array $module name of module (details are autodetected), or full module specification as array
815      * @return void
816      */
817     public function js_module($module) {
818         global $CFG;
820         if (empty($module)) {
821             throw new coding_exception('Missing YUI3 module name or full description.');
822         }
824         if (is_string($module)) {
825             $module = $this->find_module($module);
826         }
828         if (empty($module) or empty($module['name']) or empty($module['fullpath'])) {
829             throw new coding_exception('Missing YUI3 module details.');
830         }
832         $module['fullpath'] = $this->js_fix_url($module['fullpath'])->out(false);
833         // Add all needed strings.
834         if (!empty($module['strings'])) {
835             foreach ($module['strings'] as $string) {
836                 $identifier = $string[0];
837                 $component = isset($string[1]) ? $string[1] : 'moodle';
838                 $a = isset($string[2]) ? $string[2] : null;
839                 $this->string_for_js($identifier, $component, $a);
840             }
841         }
842         unset($module['strings']);
844         // Process module requirements and attempt to load each. This allows
845         // moodle modules to require each other.
846         if (!empty($module['requires'])){
847             foreach ($module['requires'] as $requirement) {
848                 $rmodule = $this->find_module($requirement);
849                 if (is_array($rmodule)) {
850                     $this->js_module($rmodule);
851                 }
852             }
853         }
855         if ($this->headdone) {
856             $this->extramodules[$module['name']] = $module;
857         } else {
858             $this->YUI_config->add_module_config($module['name'], $module);
859         }
860     }
862     /**
863      * Returns true if the module has already been loaded.
864      *
865      * @param string|array $module
866      * @return bool True if the module has already been loaded
867      */
868     protected function js_module_loaded($module) {
869         if (is_string($module)) {
870             $modulename = $module;
871         } else {
872             $modulename = $module['name'];
873         }
874         return array_key_exists($modulename, $this->YUI_config->modules) ||
875                array_key_exists($modulename, $this->extramodules);
876     }
878     /**
879      * Ensure that the specified CSS file is linked to from this page.
880      *
881      * Because stylesheet links must go in the <head> part of the HTML, you must call
882      * this function before {@link get_head_code()} is called. That normally means before
883      * the call to print_header. If you call it when it is too late, an exception
884      * will be thrown.
885      *
886      * Even if a particular style sheet is requested more than once, it will only
887      * be linked to once.
888      *
889      * Please note use of this feature is strongly discouraged,
890      * it is suitable only for places where CSS is submitted directly by teachers.
891      * (Students must not be allowed to submit any external CSS because it may
892      * contain embedded javascript!). Example of correct use is mod/data.
893      *
894      * @param string $stylesheet The path to the .css file, relative to $CFG->wwwroot.
895      *   For example:
896      *      $PAGE->requires->css('mod/data/css.php?d='.$data->id);
897      */
898     public function css($stylesheet) {
899         global $CFG;
901         if ($this->headdone) {
902             throw new coding_exception('Cannot require a CSS file after &lt;head> has been printed.', $stylesheet);
903         }
905         if ($stylesheet instanceof moodle_url) {
906             // ok
907         } else if (strpos($stylesheet, '/') === 0) {
908             $stylesheet = new moodle_url($CFG->httpswwwroot.$stylesheet);
909         } else {
910             throw new coding_exception('Invalid stylesheet parameter.', $stylesheet);
911         }
913         $this->cssurls[$stylesheet->out()] = $stylesheet;
914     }
916     /**
917      * Add theme stylesheet to page - do not use from plugin code,
918      * this should be called only from the core renderer!
919      *
920      * @param moodle_url $stylesheet
921      * @return void
922      */
923     public function css_theme(moodle_url $stylesheet) {
924         $this->cssthemeurls[] = $stylesheet;
925     }
927     /**
928      * Ensure that a skip link to a given target is printed at the top of the <body>.
929      *
930      * You must call this function before {@link get_top_of_body_code()}, (if not, an exception
931      * will be thrown). That normally means you must call this before the call to print_header.
932      *
933      * If you ask for a particular skip link to be printed, it is then your responsibility
934      * to ensure that the appropriate <a name="..."> tag is printed in the body of the
935      * page, so that the skip link goes somewhere.
936      *
937      * Even if a particular skip link is requested more than once, only one copy of it will be output.
938      *
939      * @param string $target the name of anchor this link should go to. For example 'maincontent'.
940      * @param string $linktext The text to use for the skip link. Normally get_string('skipto', 'access', ...);
941      */
942     public function skip_link_to($target, $linktext) {
943         if ($this->topofbodydone) {
944             debugging('Page header already printed, can not add skip links any more, code needs to be fixed.');
945             return;
946         }
947         $this->skiplinks[$target] = $linktext;
948     }
950     /**
951      * !!!DEPRECATED!!! please use js_init_call() if possible
952      * Ensure that the specified JavaScript function is called from an inline script
953      * somewhere on this page.
954      *
955      * By default the call will be put in a script tag at the
956      * end of the page after initialising Y instance, since this gives best page-load
957      * performance and allows you to use YUI3 library.
958      *
959      * If you request that a particular function is called several times, then
960      * that is what will happen (unlike linking to a CSS or JS file, where only
961      * one link will be output).
962      *
963      * The main benefit of the method is the automatic encoding of all function parameters.
964      *
965      * @deprecated
966      *
967      * @param string $function the name of the JavaScritp function to call. Can
968      *      be a compound name like 'Y.Event.purgeElement'. Can also be
969      *      used to create and object by using a 'function name' like 'new user_selector'.
970      * @param array $arguments and array of arguments to be passed to the function.
971      *      When generating the function call, this will be escaped using json_encode,
972      *      so passing objects and arrays should work.
973      * @param bool $ondomready If tru the function is only called when the dom is
974      *      ready for manipulation.
975      * @param int $delay The delay before the function is called.
976      */
977     public function js_function_call($function, array $arguments = null, $ondomready = false, $delay = 0) {
978         $where = $ondomready ? 'ondomready' : 'normal';
979         $this->jscalls[$where][] = array($function, $arguments, $delay);
980     }
982     /**
983      * This function appends a block of code to the AMD specific javascript block executed
984      * in the page footer, just after loading the requirejs library.
985      *
986      * The code passed here can rely on AMD module loading, e.g. require('jquery', function($) {...});
987      *
988      * @param string $code The JS code to append.
989      */
990     public function js_amd_inline($code) {
991         $this->amdjscode[] = $code;
992     }
994     /**
995      * This function creates a minimal JS script that requires and calls a single function from an AMD module with arguments.
996      * If it is called multiple times, it will be executed multiple times.
997      *
998      * @param string $fullmodule The format for module names is <component name>/<module name>.
999      * @param string $func The function from the module to call
1000      * @param array $params The params to pass to the function. They will be json encoded, so no nasty classes/types please.
1001      */
1002     public function js_call_amd($fullmodule, $func, $params = array()) {
1003         global $CFG;
1005         list($component, $module) = explode('/', $fullmodule, 2);
1007         $component = clean_param($component, PARAM_COMPONENT);
1008         $module = clean_param($module, PARAM_ALPHANUMEXT);
1009         $func = clean_param($func, PARAM_ALPHANUMEXT);
1011         $jsonparams = array();
1012         foreach ($params as $param) {
1013             $jsonparams[] = json_encode($param);
1014         }
1015         $strparams = implode(', ', $jsonparams);
1016         if ($CFG->debugdeveloper) {
1017             $toomanyparamslimit = 1024;
1018             if (strlen($strparams) > $toomanyparamslimit) {
1019                 debugging('Too many params passed to js_call_amd("' . $fullmodule . '", "' . $func . '")', DEBUG_DEVELOPER);
1020             }
1021         }
1023         $js = 'require(["' . $component . '/' . $module . '"], function(amd) { amd.' . $func . '(' . $strparams . '); });';
1025         $this->js_amd_inline($js);
1026     }
1028     /**
1029      * Creates a JavaScript function call that requires one or more modules to be loaded.
1030      *
1031      * This function can be used to include all of the standard YUI module types within JavaScript:
1032      *     - YUI3 modules    [node, event, io]
1033      *     - YUI2 modules    [yui2-*]
1034      *     - Moodle modules  [moodle-*]
1035      *     - Gallery modules [gallery-*]
1036      *
1037      * Before writing new code that makes extensive use of YUI, you should consider it's replacement AMD/JQuery.
1038      * @see js_call_amd()
1039      *
1040      * @param array|string $modules One or more modules
1041      * @param string $function The function to call once modules have been loaded
1042      * @param array $arguments An array of arguments to pass to the function
1043      * @param string $galleryversion Deprecated: The gallery version to use
1044      * @param bool $ondomready
1045      */
1046     public function yui_module($modules, $function, array $arguments = null, $galleryversion = null, $ondomready = false) {
1047         if (!is_array($modules)) {
1048             $modules = array($modules);
1049         }
1051         if ($galleryversion != null) {
1052             debugging('The galleryversion parameter to yui_module has been deprecated since Moodle 2.3.');
1053         }
1055         $jscode = 'Y.use('.join(',', array_map('json_encode', convert_to_array($modules))).',function() {'.js_writer::function_call($function, $arguments).'});';
1056         if ($ondomready) {
1057             $jscode = "Y.on('domready', function() { $jscode });";
1058         }
1059         $this->jsinitcode[] = $jscode;
1060     }
1062     /**
1063      * Set the CSS Modules to be included from YUI.
1064      *
1065      * @param array $modules The list of YUI CSS Modules to include.
1066      */
1067     public function set_yuicssmodules(array $modules = array()) {
1068         $this->yuicssmodules = $modules;
1069     }
1071     /**
1072      * Ensure that the specified JavaScript function is called from an inline script
1073      * from page footer.
1074      *
1075      * @param string $function the name of the JavaScritp function to with init code,
1076      *      usually something like 'M.mod_mymodule.init'
1077      * @param array $extraarguments and array of arguments to be passed to the function.
1078      *      The first argument is always the YUI3 Y instance with all required dependencies
1079      *      already loaded.
1080      * @param bool $ondomready wait for dom ready (helps with some IE problems when modifying DOM)
1081      * @param array $module JS module specification array
1082      */
1083     public function js_init_call($function, array $extraarguments = null, $ondomready = false, array $module = null) {
1084         $jscode = js_writer::function_call_with_Y($function, $extraarguments);
1085         if (!$module) {
1086             // Detect module automatically.
1087             if (preg_match('/M\.([a-z0-9]+_[^\.]+)/', $function, $matches)) {
1088                 $module = $this->find_module($matches[1]);
1089             }
1090         }
1092         $this->js_init_code($jscode, $ondomready, $module);
1093     }
1095     /**
1096      * Add short static javascript code fragment to page footer.
1097      * This is intended primarily for loading of js modules and initialising page layout.
1098      * Ideally the JS code fragment should be stored in plugin renderer so that themes
1099      * may override it.
1100      *
1101      * @param string $jscode
1102      * @param bool $ondomready wait for dom ready (helps with some IE problems when modifying DOM)
1103      * @param array $module JS module specification array
1104      */
1105     public function js_init_code($jscode, $ondomready = false, array $module = null) {
1106         $jscode = trim($jscode, " ;\n"). ';';
1108         $uniqid = html_writer::random_id();
1109         $startjs = " M.util.js_pending('" . $uniqid . "');";
1110         $endjs = " M.util.js_complete('" . $uniqid . "');";
1112         if ($module) {
1113             $this->js_module($module);
1114             $modulename = $module['name'];
1115             $jscode = "$startjs Y.use('$modulename', function(Y) { $jscode $endjs });";
1116         }
1118         if ($ondomready) {
1119             $jscode = "$startjs Y.on('domready', function() { $jscode $endjs });";
1120         }
1122         $this->jsinitcode[] = $jscode;
1123     }
1125     /**
1126      * Make a language string available to JavaScript.
1127      *
1128      * All the strings will be available in a M.str object in the global namespace.
1129      * So, for example, after a call to $PAGE->requires->string_for_js('course', 'moodle');
1130      * then the JavaScript variable M.str.moodle.course will be 'Course', or the
1131      * equivalent in the current language.
1132      *
1133      * The arguments to this function are just like the arguments to get_string
1134      * except that $component is not optional, and there are some aspects to consider
1135      * when the string contains {$a} placeholder.
1136      *
1137      * If the string does not contain any {$a} placeholder, you can simply use
1138      * M.str.component.identifier to obtain it. If you prefer, you can call
1139      * M.util.get_string(identifier, component) to get the same result.
1140      *
1141      * If you need to use {$a} placeholders, there are two options. Either the
1142      * placeholder should be substituted in PHP on server side or it should
1143      * be substituted in Javascript at client side.
1144      *
1145      * To substitute the placeholder at server side, just provide the required
1146      * value for the placeholder when you require the string. Because each string
1147      * is only stored once in the JavaScript (based on $identifier and $module)
1148      * you cannot get the same string with two different values of $a. If you try,
1149      * an exception will be thrown. Once the placeholder is substituted, you can
1150      * use M.str or M.util.get_string() as shown above:
1151      *
1152      *     // Require the string in PHP and replace the placeholder.
1153      *     $PAGE->requires->string_for_js('fullnamedisplay', 'moodle', $USER);
1154      *     // Use the result of the substitution in Javascript.
1155      *     alert(M.str.moodle.fullnamedisplay);
1156      *
1157      * To substitute the placeholder at client side, use M.util.get_string()
1158      * function. It implements the same logic as {@link get_string()}:
1159      *
1160      *     // Require the string in PHP but keep {$a} as it is.
1161      *     $PAGE->requires->string_for_js('fullnamedisplay', 'moodle');
1162      *     // Provide the values on the fly in Javascript.
1163      *     user = { firstname : 'Harry', lastname : 'Potter' }
1164      *     alert(M.util.get_string('fullnamedisplay', 'moodle', user);
1165      *
1166      * If you do need the same string expanded with different $a values in PHP
1167      * on server side, then the solution is to put them in your own data structure
1168      * (e.g. and array) that you pass to JavaScript with {@link data_for_js()}.
1169      *
1170      * @param string $identifier the desired string.
1171      * @param string $component the language file to look in.
1172      * @param mixed $a any extra data to add into the string (optional).
1173      */
1174     public function string_for_js($identifier, $component, $a = null) {
1175         if (!$component) {
1176             throw new coding_exception('The $component parameter is required for page_requirements_manager::string_for_js().');
1177         }
1178         if (isset($this->stringsforjs_as[$component][$identifier]) and $this->stringsforjs_as[$component][$identifier] !== $a) {
1179             throw new coding_exception("Attempt to re-define already required string '$identifier' " .
1180                     "from lang file '$component' with different \$a parameter?");
1181         }
1182         if (!isset($this->stringsforjs[$component][$identifier])) {
1183             $this->stringsforjs[$component][$identifier] = new lang_string($identifier, $component, $a);
1184             $this->stringsforjs_as[$component][$identifier] = $a;
1185         }
1186     }
1188     /**
1189      * Make an array of language strings available for JS.
1190      *
1191      * This function calls the above function {@link string_for_js()} for each requested
1192      * string in the $identifiers array that is passed to the argument for a single module
1193      * passed in $module.
1194      *
1195      * <code>
1196      * $PAGE->requires->strings_for_js(array('one', 'two', 'three'), 'mymod', array('a', null, 3));
1197      *
1198      * // The above is identical to calling:
1199      *
1200      * $PAGE->requires->string_for_js('one', 'mymod', 'a');
1201      * $PAGE->requires->string_for_js('two', 'mymod');
1202      * $PAGE->requires->string_for_js('three', 'mymod', 3);
1203      * </code>
1204      *
1205      * @param array $identifiers An array of desired strings
1206      * @param string $component The module to load for
1207      * @param mixed $a This can either be a single variable that gets passed as extra
1208      *         information for every string or it can be an array of mixed data where the
1209      *         key for the data matches that of the identifier it is meant for.
1210      *
1211      */
1212     public function strings_for_js($identifiers, $component, $a = null) {
1213         foreach ($identifiers as $key => $identifier) {
1214             if (is_array($a) && array_key_exists($key, $a)) {
1215                 $extra = $a[$key];
1216             } else {
1217                 $extra = $a;
1218             }
1219             $this->string_for_js($identifier, $component, $extra);
1220         }
1221     }
1223     /**
1224      * !!!!!!DEPRECATED!!!!!! please use js_init_call() for everything now.
1225      *
1226      * Make some data from PHP available to JavaScript code.
1227      *
1228      * For example, if you call
1229      * <pre>
1230      *      $PAGE->requires->data_for_js('mydata', array('name' => 'Moodle'));
1231      * </pre>
1232      * then in JavsScript mydata.name will be 'Moodle'.
1233      *
1234      * @deprecated
1235      * @param string $variable the the name of the JavaScript variable to assign the data to.
1236      *      Will probably work if you use a compound name like 'mybuttons.button[1]', but this
1237      *      should be considered an experimental feature.
1238      * @param mixed $data The data to pass to JavaScript. This will be escaped using json_encode,
1239      *      so passing objects and arrays should work.
1240      * @param bool $inhead initialise in head
1241      * @return void
1242      */
1243     public function data_for_js($variable, $data, $inhead=false) {
1244         $where = $inhead ? 'head' : 'footer';
1245         $this->jsinitvariables[$where][] = array($variable, $data);
1246     }
1248     /**
1249      * Creates a YUI event handler.
1250      *
1251      * @param mixed $selector standard YUI selector for elements, may be array or string, element id is in the form "#idvalue"
1252      * @param string $event A valid DOM event (click, mousedown, change etc.)
1253      * @param string $function The name of the function to call
1254      * @param array  $arguments An optional array of argument parameters to pass to the function
1255      */
1256     public function event_handler($selector, $event, $function, array $arguments = null) {
1257         $this->eventhandlers[] = array('selector'=>$selector, 'event'=>$event, 'function'=>$function, 'arguments'=>$arguments);
1258     }
1260     /**
1261      * Returns code needed for registering of event handlers.
1262      * @return string JS code
1263      */
1264     protected function get_event_handler_code() {
1265         $output = '';
1266         foreach ($this->eventhandlers as $h) {
1267             $output .= js_writer::event_handler($h['selector'], $h['event'], $h['function'], $h['arguments']);
1268         }
1269         return $output;
1270     }
1272     /**
1273      * Get the inline JavaScript code that need to appear in a particular place.
1274      * @param bool $ondomready
1275      * @return string
1276      */
1277     protected function get_javascript_code($ondomready) {
1278         $where = $ondomready ? 'ondomready' : 'normal';
1279         $output = '';
1280         if ($this->jscalls[$where]) {
1281             foreach ($this->jscalls[$where] as $data) {
1282                 $output .= js_writer::function_call($data[0], $data[1], $data[2]);
1283             }
1284             if (!empty($ondomready)) {
1285                 $output = "    Y.on('domready', function() {\n$output\n});";
1286             }
1287         }
1288         return $output;
1289     }
1291     /**
1292      * Returns js code to be executed when Y is available.
1293      * @return string
1294      */
1295     protected function get_javascript_init_code() {
1296         if (count($this->jsinitcode)) {
1297             return implode("\n", $this->jsinitcode) . "\n";
1298         }
1299         return '';
1300     }
1302     /**
1303      * Returns js code to load amd module loader, then insert inline script tags
1304      * that contain require() calls using RequireJS.
1305      * @return string
1306      */
1307     protected function get_amd_footercode() {
1308         global $CFG;
1309         $output = '';
1310         $jsrev = $this->get_jsrev();
1312         $jsloader = new moodle_url($CFG->httpswwwroot . '/lib/javascript.php');
1313         $jsloader->set_slashargument('/' . $jsrev . '/');
1314         $requirejsloader = new moodle_url($CFG->httpswwwroot . '/lib/requirejs.php');
1315         $requirejsloader->set_slashargument('/' . $jsrev . '/');
1317         $requirejsconfig = file_get_contents($CFG->dirroot . '/lib/requirejs/moodle-config.js');
1319         // No extension required unless slash args is disabled.
1320         $jsextension = '.js';
1321         if (!empty($CFG->slasharguments)) {
1322             $jsextension = '';
1323         }
1325         $requirejsconfig = str_replace('[BASEURL]', $requirejsloader, $requirejsconfig);
1326         $requirejsconfig = str_replace('[JSURL]', $jsloader, $requirejsconfig);
1327         $requirejsconfig = str_replace('[JSEXT]', $jsextension, $requirejsconfig);
1329         $output .= html_writer::script($requirejsconfig);
1330         if ($CFG->debugdeveloper) {
1331             $output .= html_writer::script('', $this->js_fix_url('/lib/requirejs/require.js'));
1332         } else {
1333             $output .= html_writer::script('', $this->js_fix_url('/lib/requirejs/require.min.js'));
1334         }
1336         // First include must be to a module with no dependencies, this prevents multiple requests.
1337         $prefix = "require(['core/first'], function() {\n";
1338         $suffix = "\n});";
1339         $output .= html_writer::script($prefix . implode(";\n", $this->amdjscode) . $suffix);
1340         return $output;
1341     }
1343     /**
1344      * Returns basic YUI3 CSS code.
1345      *
1346      * @return string
1347      */
1348     protected function get_yui3lib_headcss() {
1349         global $CFG;
1351         $yuiformat = '-min';
1352         if ($this->yui3loader->filter === 'RAW') {
1353             $yuiformat = '';
1354         }
1356         $code = '';
1357         if ($this->yui3loader->combine) {
1358             if (!empty($this->yuicssmodules)) {
1359                 $modules = array();
1360                 foreach ($this->yuicssmodules as $module) {
1361                     $modules[] = "$CFG->yui3version/$module/$module-min.css";
1362                 }
1363                 $code .= '<link rel="stylesheet" type="text/css" href="'.$this->yui3loader->comboBase.implode('&amp;', $modules).'" />';
1364             }
1365             $code .= '<link rel="stylesheet" type="text/css" href="'.$this->yui3loader->local_comboBase.'rollup/'.$CFG->yui3version.'/yui-moodlesimple' . $yuiformat . '.css" />';
1367         } else {
1368             if (!empty($this->yuicssmodules)) {
1369                 foreach ($this->yuicssmodules as $module) {
1370                     $code .= '<link rel="stylesheet" type="text/css" href="'.$this->yui3loader->base.$module.'/'.$module.'-min.css" />';
1371                 }
1372             }
1373             $code .= '<link rel="stylesheet" type="text/css" href="'.$this->yui3loader->local_comboBase.'rollup/'.$CFG->yui3version.'/yui-moodlesimple' . $yuiformat . '.css" />';
1374         }
1376         if ($this->yui3loader->filter === 'RAW') {
1377             $code = str_replace('-min.css', '.css', $code);
1378         } else if ($this->yui3loader->filter === 'DEBUG') {
1379             $code = str_replace('-min.css', '.css', $code);
1380         }
1381         return $code;
1382     }
1384     /**
1385      * Returns basic YUI3 JS loading code.
1386      *
1387      * @return string
1388      */
1389     protected function get_yui3lib_headcode() {
1390         global $CFG;
1392         $jsrev = $this->get_jsrev();
1394         $yuiformat = '-min';
1395         if ($this->yui3loader->filter === 'RAW') {
1396             $yuiformat = '';
1397         }
1399         $format = '-min';
1400         if ($this->YUI_config->groups['moodle']['filter'] === 'DEBUG') {
1401             $format = '-debug';
1402         }
1404         $rollupversion = $CFG->yui3version;
1405         if (!empty($CFG->yuipatchlevel)) {
1406             $rollupversion .= '_' . $CFG->yuipatchlevel;
1407         }
1409         $baserollups = array(
1410             'rollup/' . $rollupversion . "/yui-moodlesimple{$yuiformat}.js",
1411             'rollup/' . $jsrev . "/mcore{$format}.js",
1412         );
1414         if ($this->yui3loader->combine) {
1415             return '<script type="text/javascript" src="' .
1416                     $this->yui3loader->local_comboBase .
1417                     implode('&amp;', $baserollups) .
1418                     '"></script>';
1419         } else {
1420             $code = '';
1421             foreach ($baserollups as $rollup) {
1422                 $code .= '<script type="text/javascript" src="'.$this->yui3loader->local_comboBase.$rollup.'"></script>';
1423             }
1424             return $code;
1425         }
1427     }
1429     /**
1430      * Returns html tags needed for inclusion of theme CSS.
1431      *
1432      * @return string
1433      */
1434     protected function get_css_code() {
1435         // First of all the theme CSS, then any custom CSS
1436         // Please note custom CSS is strongly discouraged,
1437         // because it can not be overridden by themes!
1438         // It is suitable only for things like mod/data which accepts CSS from teachers.
1439         $attributes = array('rel'=>'stylesheet', 'type'=>'text/css');
1441         // Add the YUI code first. We want this to be overridden by any Moodle CSS.
1442         $code = $this->get_yui3lib_headcss();
1444         // This line of code may look funny but it is currently required in order
1445         // to avoid MASSIVE display issues in Internet Explorer.
1446         // As of IE8 + YUI3.1.1 the reference stylesheet (firstthemesheet) gets
1447         // ignored whenever another resource is added until such time as a redraw
1448         // is forced, usually by moving the mouse over the affected element.
1449         $code .= html_writer::tag('script', '/** Required in order to fix style inclusion problems in IE with YUI **/', array('id'=>'firstthemesheet', 'type'=>'text/css'));
1451         $urls = $this->cssthemeurls + $this->cssurls;
1452         foreach ($urls as $url) {
1453             $attributes['href'] = $url;
1454             $code .= html_writer::empty_tag('link', $attributes) . "\n";
1455             // This id is needed in first sheet only so that theme may override YUI sheets loaded on the fly.
1456             unset($attributes['id']);
1457         }
1459         return $code;
1460     }
1462     /**
1463      * Adds extra modules specified after printing of page header.
1464      *
1465      * @return string
1466      */
1467     protected function get_extra_modules_code() {
1468         if (empty($this->extramodules)) {
1469             return '';
1470         }
1471         return html_writer::script(js_writer::function_call('M.yui.add_module', array($this->extramodules)));
1472     }
1474     /**
1475      * Generate any HTML that needs to go inside the <head> tag.
1476      *
1477      * Normally, this method is called automatically by the code that prints the
1478      * <head> tag. You should not normally need to call it in your own code.
1479      *
1480      * @param moodle_page $page
1481      * @param core_renderer $renderer
1482      * @return string the HTML code to to inside the <head> tag.
1483      */
1484     public function get_head_code(moodle_page $page, core_renderer $renderer) {
1485         global $CFG;
1487         // Note: the $page and $output are not stored here because it would
1488         // create circular references in memory which prevents garbage collection.
1489         $this->init_requirements_data($page, $renderer);
1491         $output = '';
1493         // Add all standard CSS for this page.
1494         $output .= $this->get_css_code();
1496         // Set up the M namespace.
1497         $js = "var M = {}; M.yui = {};\n";
1499         // Capture the time now ASAP during page load. This minimises the lag when
1500         // we try to relate times on the server to times in the browser.
1501         // An example of where this is used is the quiz countdown timer.
1502         $js .= "M.pageloadstarttime = new Date();\n";
1504         // Add a subset of Moodle configuration to the M namespace.
1505         $js .= js_writer::set_variable('M.cfg', $this->M_cfg, false);
1507         // Set up global YUI3 loader object - this should contain all code needed by plugins.
1508         // Note: in JavaScript just use "YUI().use('overlay', function(Y) { .... });",
1509         //       this needs to be done before including any other script.
1510         $js .= $this->YUI_config->get_config_functions();
1511         $js .= js_writer::set_variable('YUI_config', $this->YUI_config, false) . "\n";
1512         $js .= "M.yui.loader = {modules: {}};\n"; // Backwards compatibility only, not used any more.
1513         $js = $this->YUI_config->update_header_js($js);
1515         $output .= html_writer::script($js);
1517         // Add variables.
1518         if ($this->jsinitvariables['head']) {
1519             $js = '';
1520             foreach ($this->jsinitvariables['head'] as $data) {
1521                 list($var, $value) = $data;
1522                 $js .= js_writer::set_variable($var, $value, true);
1523             }
1524             $output .= html_writer::script($js);
1525         }
1527         // Mark head sending done, it is not possible to anything there.
1528         $this->headdone = true;
1530         return $output;
1531     }
1533     /**
1534      * Generate any HTML that needs to go at the start of the <body> tag.
1535      *
1536      * Normally, this method is called automatically by the code that prints the
1537      * <head> tag. You should not normally need to call it in your own code.
1538      *
1539      * @return string the HTML code to go at the start of the <body> tag.
1540      */
1541     public function get_top_of_body_code() {
1542         // First the skip links.
1543         $links = '';
1544         $attributes = array('class' => 'skip');
1545         foreach ($this->skiplinks as $url => $text) {
1546             $links .= html_writer::link('#'.$url, $text, $attributes);
1547         }
1548         $output = html_writer::tag('div', $links, array('class'=>'skiplinks')) . "\n";
1549         $this->js_init_call('M.util.init_skiplink');
1551         // YUI3 JS needs to be loaded early in the body. It should be cached well by the browser.
1552         $output .= $this->get_yui3lib_headcode();
1554         // Add hacked jQuery support, it is not intended for standard Moodle distribution!
1555         $output .= $this->get_jquery_headcode();
1557         // Link our main JS file, all core stuff should be there.
1558         $output .= html_writer::script('', $this->js_fix_url('/lib/javascript-static.js'));
1560         // All the other linked things from HEAD - there should be as few as possible.
1561         if ($this->jsincludes['head']) {
1562             foreach ($this->jsincludes['head'] as $url) {
1563                 $output .= html_writer::script('', $url);
1564             }
1565         }
1567         // Then the clever trick for hiding of things not needed when JS works.
1568         $output .= html_writer::script("document.body.className += ' jsenabled';") . "\n";
1569         $this->topofbodydone = true;
1570         return $output;
1571     }
1573     /**
1574      * Generate any HTML that needs to go at the end of the page.
1575      *
1576      * Normally, this method is called automatically by the code that prints the
1577      * page footer. You should not normally need to call it in your own code.
1578      *
1579      * @return string the HTML code to to at the end of the page.
1580      */
1581     public function get_end_code() {
1582         global $CFG;
1583         $output = '';
1585         // Set the log level for the JS logging.
1586         $logconfig = new stdClass();
1587         $logconfig->level = 'warn';
1588         if ($CFG->debugdeveloper) {
1589             $logconfig->level = 'trace';
1590         }
1591         $this->js_call_amd('core/log', 'setConfig', array($logconfig));
1593         // Call amd init functions.
1594         $output .= $this->get_amd_footercode();
1596         // Add other requested modules.
1597         $output .= $this->get_extra_modules_code();
1599         $this->js_init_code('M.util.js_complete("init");', true);
1601         // All the other linked scripts - there should be as few as possible.
1602         if ($this->jsincludes['footer']) {
1603             foreach ($this->jsincludes['footer'] as $url) {
1604                 $output .= html_writer::script('', $url);
1605             }
1606         }
1608         // Add all needed strings.
1609         // First add core strings required for some dialogues.
1610         $this->strings_for_js(array(
1611             'confirm',
1612             'yes',
1613             'no',
1614             'areyousure',
1615             'closebuttontitle',
1616             'unknownerror',
1617         ), 'moodle');
1618         if (!empty($this->stringsforjs)) {
1619             $strings = array();
1620             foreach ($this->stringsforjs as $component=>$v) {
1621                 foreach($v as $indentifier => $langstring) {
1622                     $strings[$component][$indentifier] = $langstring->out();
1623                 }
1624             }
1625             $output .= html_writer::script(js_writer::set_variable('M.str', $strings));
1626         }
1628         // Add variables.
1629         if ($this->jsinitvariables['footer']) {
1630             $js = '';
1631             foreach ($this->jsinitvariables['footer'] as $data) {
1632                 list($var, $value) = $data;
1633                 $js .= js_writer::set_variable($var, $value, true);
1634             }
1635             $output .= html_writer::script($js);
1636         }
1638         $inyuijs = $this->get_javascript_code(false);
1639         $ondomreadyjs = $this->get_javascript_code(true);
1640         $jsinit = $this->get_javascript_init_code();
1641         $handlersjs = $this->get_event_handler_code();
1643         // There is a global Y, make sure it is available in your scope.
1644         $js = "(function() {{$inyuijs}{$ondomreadyjs}{$jsinit}{$handlersjs}})();";
1646         $output .= html_writer::script($js);
1648         return $output;
1649     }
1651     /**
1652      * Have we already output the code in the <head> tag?
1653      *
1654      * @return bool
1655      */
1656     public function is_head_done() {
1657         return $this->headdone;
1658     }
1660     /**
1661      * Have we already output the code at the start of the <body> tag?
1662      *
1663      * @return bool
1664      */
1665     public function is_top_of_body_done() {
1666         return $this->topofbodydone;
1667     }
1669     /**
1670      * Should we generate a bit of content HTML that is only required once  on
1671      * this page (e.g. the contents of the modchooser), now? Basically, we call
1672      * {@link has_one_time_item_been_created()}, and if the thing has not already
1673      * been output, we return true to tell the caller to generate it, and also
1674      * call {@link set_one_time_item_created()} to record the fact that it is
1675      * about to be generated.
1676      *
1677      * That is, a typical usage pattern (in a renderer method) is:
1678      * <pre>
1679      * if (!$this->page->requires->should_create_one_time_item_now($thing)) {
1680      *     return '';
1681      * }
1682      * // Else generate it.
1683      * </pre>
1684      *
1685      * @param string $thing identifier for the bit of content. Should be of the form
1686      *      frankenstyle_things, e.g. core_course_modchooser.
1687      * @return bool if true, the caller should generate that bit of output now, otherwise don't.
1688      */
1689     public function should_create_one_time_item_now($thing) {
1690         if ($this->has_one_time_item_been_created($thing)) {
1691             return false;
1692         }
1694         $this->set_one_time_item_created($thing);
1695         return true;
1696     }
1698     /**
1699      * Has a particular bit of HTML that is only required once  on this page
1700      * (e.g. the contents of the modchooser) already been generated?
1701      *
1702      * Normally, you can use the {@link should_create_one_time_item_now()} helper
1703      * method rather than calling this method directly.
1704      *
1705      * @param string $thing identifier for the bit of content. Should be of the form
1706      *      frankenstyle_things, e.g. core_course_modchooser.
1707      * @return bool whether that bit of output has been created.
1708      */
1709     public function has_one_time_item_been_created($thing) {
1710         return isset($this->onetimeitemsoutput[$thing]);
1711     }
1713     /**
1714      * Indicate that a particular bit of HTML that is only required once on this
1715      * page (e.g. the contents of the modchooser) has been generated (or is about to be)?
1716      *
1717      * Normally, you can use the {@link should_create_one_time_item_now()} helper
1718      * method rather than calling this method directly.
1719      *
1720      * @param string $thing identifier for the bit of content. Should be of the form
1721      *      frankenstyle_things, e.g. core_course_modchooser.
1722      */
1723     public function set_one_time_item_created($thing) {
1724         if ($this->has_one_time_item_been_created($thing)) {
1725             throw new coding_exception($thing . ' is only supposed to be ouput ' .
1726                     'once per page, but it seems to be being output again.');
1727         }
1728         return $this->onetimeitemsoutput[$thing] = true;
1729     }
1732 /**
1733  * This class represents the YUI configuration.
1734  *
1735  * @copyright 2013 Andrew Nicols
1736  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1737  * @since Moodle 2.5
1738  * @package core
1739  * @category output
1740  */
1741 class YUI_config {
1742     /**
1743      * These settings must be public so that when the object is converted to json they are exposed.
1744      * Note: Some of these are camelCase because YUI uses camelCase variable names.
1745      *
1746      * The settings are described and documented in the YUI API at:
1747      * - http://yuilibrary.com/yui/docs/api/classes/config.html
1748      * - http://yuilibrary.com/yui/docs/api/classes/Loader.html
1749      */
1750     public $debug = false;
1751     public $base;
1752     public $comboBase;
1753     public $combine;
1754     public $filter = null;
1755     public $insertBefore = 'firstthemesheet';
1756     public $groups = array();
1757     public $modules = array();
1759     /**
1760      * @var array List of functions used by the YUI Loader group pattern recognition.
1761      */
1762     protected $jsconfigfunctions = array();
1764     /**
1765      * Create a new group within the YUI_config system.
1766      *
1767      * @param String $name The name of the group. This must be unique and
1768      * not previously used.
1769      * @param Array $config The configuration for this group.
1770      * @return void
1771      */
1772     public function add_group($name, $config) {
1773         if (isset($this->groups[$name])) {
1774             throw new coding_exception("A YUI configuration group for '{$name}' already exists. To make changes to this group use YUI_config->update_group().");
1775         }
1776         $this->groups[$name] = $config;
1777     }
1779     /**
1780      * Update an existing group configuration
1781      *
1782      * Note, any existing configuration for that group will be wiped out.
1783      * This includes module configuration.
1784      *
1785      * @param String $name The name of the group. This must be unique and
1786      * not previously used.
1787      * @param Array $config The configuration for this group.
1788      * @return void
1789      */
1790     public function update_group($name, $config) {
1791         if (!isset($this->groups[$name])) {
1792             throw new coding_exception('The Moodle YUI module does not exist. You must define the moodle module config using YUI_config->add_module_config first.');
1793         }
1794         $this->groups[$name] = $config;
1795     }
1797     /**
1798      * Set the value of a configuration function used by the YUI Loader's pattern testing.
1799      *
1800      * Only the body of the function should be passed, and not the whole function wrapper.
1801      *
1802      * The JS function your write will be passed a single argument 'name' containing the
1803      * name of the module being loaded.
1804      *
1805      * @param $function String the body of the JavaScript function. This should be used i
1806      * @return String the name of the function to use in the group pattern configuration.
1807      */
1808     public function set_config_function($function) {
1809         $configname = 'yui' . (count($this->jsconfigfunctions) + 1) . 'ConfigFn';
1810         if (isset($this->jsconfigfunctions[$configname])) {
1811             throw new coding_exception("A YUI config function with this name already exists. Config function names must be unique.");
1812         }
1813         $this->jsconfigfunctions[$configname] = $function;
1814         return '@' . $configname . '@';
1815     }
1817     /**
1818      * Allow setting of the config function described in {@see set_config_function} from a file.
1819      * The contents of this file are then passed to set_config_function.
1820      *
1821      * When jsrev is positive, the function is minified and stored in a MUC cache for subsequent uses.
1822      *
1823      * @param $file The path to the JavaScript function used for YUI configuration.
1824      * @return String the name of the function to use in the group pattern configuration.
1825      */
1826     public function set_config_source($file) {
1827         global $CFG;
1828         $cache = cache::make('core', 'yuimodules');
1830         // Attempt to get the metadata from the cache.
1831         $keyname = 'configfn_' . $file;
1832         $fullpath = $CFG->dirroot . '/' . $file;
1833         if (!isset($CFG->jsrev) || $CFG->jsrev == -1) {
1834             $cache->delete($keyname);
1835             $configfn = file_get_contents($fullpath);
1836         } else {
1837             $configfn = $cache->get($keyname);
1838             if ($configfn === false) {
1839                 require_once($CFG->libdir . '/jslib.php');
1840                 $configfn = core_minify::js_files(array($fullpath));
1841                 $cache->set($keyname, $configfn);
1842             }
1843         }
1844         return $this->set_config_function($configfn);
1845     }
1847     /**
1848      * Retrieve the list of JavaScript functions for YUI_config groups.
1849      *
1850      * @return String The complete set of config functions
1851      */
1852     public function get_config_functions() {
1853         $configfunctions = '';
1854         foreach ($this->jsconfigfunctions as $functionname => $function) {
1855             $configfunctions .= "var {$functionname} = function(me) {";
1856             $configfunctions .= $function;
1857             $configfunctions .= "};\n";
1858         }
1859         return $configfunctions;
1860     }
1862     /**
1863      * Update the header JavaScript with any required modification for the YUI Loader.
1864      *
1865      * @param $js String The JavaScript to manipulate.
1866      * @return String the modified JS string.
1867      */
1868     public function update_header_js($js) {
1869         // Update the names of the the configFn variables.
1870         // The PHP json_encode function cannot handle literal names so we have to wrap
1871         // them in @ and then replace them with literals of the same function name.
1872         foreach ($this->jsconfigfunctions as $functionname => $function) {
1873             $js = str_replace('"@' . $functionname . '@"', $functionname, $js);
1874         }
1875         return $js;
1876     }
1878     /**
1879      * Add configuration for a specific module.
1880      *
1881      * @param String $name The name of the module to add configuration for.
1882      * @param Array $config The configuration for the specified module.
1883      * @param String $group The name of the group to add configuration for.
1884      * If not specified, then this module is added to the global
1885      * configuration.
1886      * @return void
1887      */
1888     public function add_module_config($name, $config, $group = null) {
1889         if ($group) {
1890             if (!isset($this->groups[$name])) {
1891                 throw new coding_exception('The Moodle YUI module does not exist. You must define the moodle module config using YUI_config->add_module_config first.');
1892             }
1893             if (!isset($this->groups[$group]['modules'])) {
1894                 $this->groups[$group]['modules'] = array();
1895             }
1896             $modules = &$this->groups[$group]['modules'];
1897         } else {
1898             $modules = &$this->modules;
1899         }
1900         $modules[$name] = $config;
1901     }
1903     /**
1904      * Add the moodle YUI module metadata for the moodle group to the YUI_config instance.
1905      *
1906      * If js caching is disabled, metadata will not be served causing YUI to calculate
1907      * module dependencies as each module is loaded.
1908      *
1909      * If metadata does not exist it will be created and stored in a MUC entry.
1910      *
1911      * @return void
1912      */
1913     public function add_moodle_metadata() {
1914         global $CFG;
1915         if (!isset($this->groups['moodle'])) {
1916             throw new coding_exception('The Moodle YUI module does not exist. You must define the moodle module config using YUI_config->add_module_config first.');
1917         }
1919         if (!isset($this->groups['moodle']['modules'])) {
1920             $this->groups['moodle']['modules'] = array();
1921         }
1923         $cache = cache::make('core', 'yuimodules');
1924         if (!isset($CFG->jsrev) || $CFG->jsrev == -1) {
1925             $metadata = array();
1926             $metadata = $this->get_moodle_metadata();
1927             $cache->delete('metadata');
1928         } else {
1929             // Attempt to get the metadata from the cache.
1930             if (!$metadata = $cache->get('metadata')) {
1931                 $metadata = $this->get_moodle_metadata();
1932                 $cache->set('metadata', $metadata);
1933             }
1934         }
1936         // Merge with any metadata added specific to this page which was added manually.
1937         $this->groups['moodle']['modules'] = array_merge($this->groups['moodle']['modules'],
1938                 $metadata);
1939     }
1941     /**
1942      * Determine the module metadata for all moodle YUI modules.
1943      *
1944      * This works through all modules capable of serving YUI modules, and attempts to get
1945      * metadata for each of those modules.
1946      *
1947      * @return Array of module metadata
1948      */
1949     private function get_moodle_metadata() {
1950         $moodlemodules = array();
1951         // Core isn't a plugin type or subsystem - handle it seperately.
1952         if ($module = $this->get_moodle_path_metadata(core_component::get_component_directory('core'))) {
1953             $moodlemodules = array_merge($moodlemodules, $module);
1954         }
1956         // Handle other core subsystems.
1957         $subsystems = core_component::get_core_subsystems();
1958         foreach ($subsystems as $subsystem => $path) {
1959             if (is_null($path)) {
1960                 continue;
1961             }
1962             if ($module = $this->get_moodle_path_metadata($path)) {
1963                 $moodlemodules = array_merge($moodlemodules, $module);
1964             }
1965         }
1967         // And finally the plugins.
1968         $plugintypes = core_component::get_plugin_types();
1969         foreach ($plugintypes as $plugintype => $pathroot) {
1970             $pluginlist = core_component::get_plugin_list($plugintype);
1971             foreach ($pluginlist as $plugin => $path) {
1972                 if ($module = $this->get_moodle_path_metadata($path)) {
1973                     $moodlemodules = array_merge($moodlemodules, $module);
1974                 }
1975             }
1976         }
1978         return $moodlemodules;
1979     }
1981     /**
1982      * Helper function process and return the YUI metadata for all of the modules under the specified path.
1983      *
1984      * @param String $path the UNC path to the YUI src directory.
1985      * @return Array the complete array for frankenstyle directory.
1986      */
1987     private function get_moodle_path_metadata($path) {
1988         // Add module metadata is stored in frankenstyle_modname/yui/src/yui_modname/meta/yui_modname.json.
1989         $baseyui = $path . '/yui/src';
1990         $modules = array();
1991         if (is_dir($baseyui)) {
1992             $items = new DirectoryIterator($baseyui);
1993             foreach ($items as $item) {
1994                 if ($item->isDot() or !$item->isDir()) {
1995                     continue;
1996                 }
1997                 $metafile = realpath($baseyui . '/' . $item . '/meta/' . $item . '.json');
1998                 if (!is_readable($metafile)) {
1999                     continue;
2000                 }
2001                 $metadata = file_get_contents($metafile);
2002                 $modules = array_merge($modules, (array) json_decode($metadata));
2003             }
2004         }
2005         return $modules;
2006     }
2008     /**
2009      * Define YUI modules which we have been required to patch between releases.
2010      *
2011      * We must do this because we aggressively cache content on the browser, and we must also override use of the
2012      * external CDN which will serve the true authoritative copy of the code without our patches.
2013      *
2014      * @param String combobase The local combobase
2015      * @param String yuiversion The current YUI version
2016      * @param Int patchlevel The patch level we're working to for YUI
2017      * @param Array patchedmodules An array containing the names of the patched modules
2018      * @return void
2019      */
2020     public function define_patched_core_modules($combobase, $yuiversion, $patchlevel, $patchedmodules) {
2021         // The version we use is suffixed with a patchlevel so that we can get additional revisions between YUI releases.
2022         $subversion = $yuiversion . '_' . $patchlevel;
2024         if ($this->comboBase == $combobase) {
2025             // If we are using the local combobase in the loader, we can add a group and still make use of the combo
2026             // loader. We just need to specify a different root which includes a slightly different YUI version number
2027             // to include our patchlevel.
2028             $patterns = array();
2029             $modules = array();
2030             foreach ($patchedmodules as $modulename) {
2031                 // We must define the pattern and module here so that the loader uses our group configuration instead of
2032                 // the standard module definition. We may lose some metadata provided by upstream but this will be
2033                 // loaded when the module is loaded anyway.
2034                 $patterns[$modulename] = array(
2035                     'group' => 'yui-patched',
2036                 );
2037                 $modules[$modulename] = array();
2038             }
2040             // Actually add the patch group here.
2041             $this->add_group('yui-patched', array(
2042                 'combine' => true,
2043                 'root' => $subversion . '/',
2044                 'patterns' => $patterns,
2045                 'modules' => $modules,
2046             ));
2048         } else {
2049             // The CDN is in use - we need to instead use the local combobase for this module and override the modules
2050             // definition. We cannot use the local base - we must use the combobase because we cannot invalidate the
2051             // local base in browser caches.
2052             $fullpathbase = $combobase . $subversion . '/';
2053             foreach ($patchedmodules as $modulename) {
2054                 $this->modules[$modulename] = array(
2055                     'fullpath' => $fullpathbase . $modulename . '/' . $modulename . '-min.js'
2056                 );
2057             }
2058         }
2059     }
2062 /**
2063  * Invalidate all server and client side JS caches.
2064  */
2065 function js_reset_all_caches() {
2066     global $CFG;
2068     $next = time();
2069     if (isset($CFG->jsrev) and $next <= $CFG->jsrev and $CFG->jsrev - $next < 60*60) {
2070         // This resolves problems when reset is requested repeatedly within 1s,
2071         // the < 1h condition prevents accidental switching to future dates
2072         // because we might not recover from it.
2073         $next = $CFG->jsrev+1;
2074     }
2076     set_config('jsrev', $next);