MDL-41985 JavaScript: Add option to filter YUI logging statements
[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_init_call('M.mod_forum.init_view');
39  * </pre>
40  *
41  * It also supports obsoleted coding style withouth YUI3 modules.
42  * <pre>
43  *     $PAGE->requires->css('/mod/mymod/userstyles.php?id='.$id); // not overridable via themes!
44  *     $PAGE->requires->js('/mod/mymod/script.js');
45  *     $PAGE->requires->js('/mod/mymod/small_but_urgent.js', true);
46  *     $PAGE->requires->js_function_call('init_mymod', array($data), true);
47  * </pre>
48  *
49  * There are some natural restrictions on some methods. For example, {@link css()}
50  * can only be called before the <head> tag is output. See the comments on the
51  * individual methods for details.
52  *
53  * @copyright 2009 Tim Hunt, 2010 Petr Skoda
54  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
55  * @since Moodle 2.0
56  * @package core
57  * @category output
58  */
59 class page_requirements_manager {
61     /**
62      * @var array List of string available from JS
63      */
64     protected $stringsforjs = array();
66     /**
67      * @var array List of get_string $a parameters - used for validation only.
68      */
69     protected $stringsforjs_as = array();
71     /**
72      * @var array List of JS variables to be initialised
73      */
74     protected $jsinitvariables = array('head'=>array(), 'footer'=>array());
76     /**
77      * @var array Included JS scripts
78      */
79     protected $jsincludes = array('head'=>array(), 'footer'=>array());
81     /**
82      * @var array List of needed function calls
83      */
84     protected $jscalls = array('normal'=>array(), 'ondomready'=>array());
86     /**
87      * @var array List of skip links, those are needed for accessibility reasons
88      */
89     protected $skiplinks = array();
91     /**
92      * @var array Javascript code used for initialisation of page, it should
93      * be relatively small
94      */
95     protected $jsinitcode = array();
97     /**
98      * @var array of moodle_url Theme sheets, initialised only from core_renderer
99      */
100     protected $cssthemeurls = array();
102     /**
103      * @var array of moodle_url List of custom theme sheets, these are strongly discouraged!
104      * Useful mostly only for CSS submitted by teachers that is not part of the theme.
105      */
106     protected $cssurls = array();
108     /**
109      * @var array List of requested event handlers
110      */
111     protected $eventhandlers = array();
113     /**
114      * @var array Extra modules
115      */
116     protected $extramodules = array();
118     /**
119      * @var bool Flag indicated head stuff already printed
120      */
121     protected $headdone = false;
123     /**
124      * @var bool Flag indicating top of body already printed
125      */
126     protected $topofbodydone = false;
128     /**
129      * @var stdClass YUI PHPLoader instance responsible for YUI3 loading from PHP only
130      */
131     protected $yui3loader;
133     /**
134      * @var YUI_config default YUI loader configuration
135      */
136     protected $YUI_config;
138     /**
139      * @var array Some config vars exposed in JS, please no secret stuff there
140      */
141     protected $M_cfg;
143     /**
144      * @var array Stores debug backtraces from when JS modules were included in the page
145      */
146     protected $debug_moduleloadstacktraces = array();
148     /**
149      * @var array list of requested jQuery plugins
150      */
151     protected $jqueryplugins = array();
153     /**
154      * @var array list of jQuery plugin overrides
155      */
156     protected $jquerypluginoverrides = array();
158     /**
159      * Page requirements constructor.
160      */
161     public function __construct() {
162         global $CFG;
164         // You may need to set up URL rewrite rule because oversized URLs might not be allowed by web server.
165         $sep = empty($CFG->yuislasharguments) ? '?' : '/';
167         $this->yui3loader = new stdClass();
168         $this->YUI_config = new YUI_config();
170         if (strpos($CFG->httpswwwroot, 'https:') === 0) {
171             // On HTTPS sites all JS must be loaded from https sites,
172             // YUI CDN does not support https yet, sorry.
173             $CFG->useexternalyui = 0;
174         }
176         // Set up some loader options.
177         $this->yui3loader->local_base = $CFG->httpswwwroot . '/lib/yuilib/'. $CFG->yui3version . '/';
178         $this->yui3loader->local_comboBase = $CFG->httpswwwroot . '/theme/yui_combo.php'.$sep;
180         if (!empty($CFG->useexternalyui)) {
181             $this->yui3loader->base = 'http://yui.yahooapis.com/' . $CFG->yui3version . '/';
182             $this->yui3loader->comboBase = 'http://yui.yahooapis.com/combo?';
183         } else {
184             $this->yui3loader->base = $this->yui3loader->local_base;
185             $this->yui3loader->comboBase = $this->yui3loader->local_comboBase;
186         }
188         // Enable combo loader? This significantly helps with caching and performance!
189         $this->yui3loader->combine = !empty($CFG->yuicomboloading);
191         if (empty($CFG->cachejs)) {
192             $jsrev = -1;
193         } else if (empty($CFG->jsrev)) {
194             $jsrev = 1;
195         } else {
196             $jsrev = $CFG->jsrev;
197         }
199         // Set up JS YUI loader helper object.
200         $this->YUI_config->base         = $this->yui3loader->base;
201         $this->YUI_config->comboBase    = $this->yui3loader->comboBase;
202         $this->YUI_config->combine      = $this->yui3loader->combine;
204         $configname = $this->YUI_config->set_config_source('lib/yui/config/yui2.js');
205         $this->YUI_config->add_group('yui2', array(
206             // Loader configuration for our 2in3, for now ignores $CFG->useexternalyui.
207             'base' => $CFG->httpswwwroot . '/lib/yuilib/2in3/' . $CFG->yui2version . '/build/',
208             'comboBase' => $CFG->httpswwwroot . '/theme/yui_combo.php'.$sep,
209             'combine' => $this->yui3loader->combine,
210             'ext' => false,
211             'root' => '2in3/' . $CFG->yui2version .'/build/',
212             'patterns' => array(
213                 'yui2-' => array(
214                     'group' => 'yui2',
215                     'configFn' => $configname,
216                 )
217             )
218         ));
219         $configname = $this->YUI_config->set_config_source('lib/yui/config/moodle.js');
220         $this->YUI_config->add_group('moodle', array(
221             'name' => 'moodle',
222             'base' => $CFG->httpswwwroot . '/theme/yui_combo.php'.$sep.'moodle/'.$jsrev.'/',
223             'combine' => $this->yui3loader->combine,
224             'comboBase' => $CFG->httpswwwroot . '/theme/yui_combo.php'.$sep,
225             'ext' => false,
226             'root' => 'moodle/'.$jsrev.'/', // Add the rev to the root path so that we can control caching.
227             'patterns' => array(
228                 'moodle-' => array(
229                     'group' => 'moodle',
230                     'configFn' => $configname,
231                 )
232             )
233         ));
235         // Set some more loader options applying to groups too.
236         if ($CFG->debugdeveloper) {
237             // When debugging is enabled, we want to load the non-minified (RAW) versions of YUI library modules rather
238             // than the DEBUG versions as these generally generate too much logging for our purposes.
239             // However we do want the DEBUG versions of our Moodle-specific modules.
240             // To debug a YUI-specific issue, change the yui3loader->filter value to DEBUG.
241             $this->YUI_config->filter = 'RAW';
242             $this->YUI_config->groups['moodle']['filter'] = 'DEBUG';
244             // We use the yui3loader->filter setting when writing the YUI3 seed scripts into the header.
245             $this->yui3loader->filter = $this->YUI_config->filter;
246             $this->YUI_config->debug = true;
247         } else {
248             $this->yui3loader->filter = null;
249             $this->YUI_config->debug = false;
250         }
252         // Include the YUI config log filters.
253         if (!empty($CFG->yuilogexclude) && is_array($CFG->yuilogexclude)) {
254             $this->YUI_config->logExclude = $CFG->yuilogexclude;
255         }
256         if (!empty($CFG->yuiloginclude) && is_array($CFG->yuiloginclude)) {
257             $this->YUI_config->logInclude = $CFG->yuiloginclude;
258         }
259         if (!empty($CFG->yuiloglevel)) {
260             $this->YUI_config->logLevel = $CFG->yuiloglevel;
261         }
263         // Add the moodle group's module data.
264         $this->YUI_config->add_moodle_metadata();
266         // Every page should include definition of following modules.
267         $this->js_module($this->find_module('core_filepicker'));
268     }
270     /**
271      * Initialise with the bits of JavaScript that every Moodle page should have.
272      *
273      * @param moodle_page $page
274      * @param core_renderer $renderer
275      */
276     protected function init_requirements_data(moodle_page $page, core_renderer $renderer) {
277         global $CFG;
279         // JavaScript should always work with $CFG->httpswwwroot rather than $CFG->wwwroot.
280         // Otherwise, in some situations, users will get warnings about insecure content
281         // on secure pages from their web browser.
283         $this->M_cfg = array(
284             'wwwroot'             => $CFG->httpswwwroot, // Yes, really. See above.
285             'sesskey'             => sesskey(),
286             'loadingicon'         => $renderer->pix_url('i/loading_small', 'moodle')->out(false),
287             'themerev'            => theme_get_revision(),
288             'slasharguments'      => (int)(!empty($CFG->slasharguments)),
289             'theme'               => $page->theme->name,
290             'jsrev'               => ((empty($CFG->cachejs) or empty($CFG->jsrev)) ? -1 : $CFG->jsrev),
291             'svgicons'            => $page->theme->use_svg_icons()
292         );
293         if ($CFG->debugdeveloper) {
294             $this->M_cfg['developerdebug'] = true;
295         }
297         // Accessibility stuff.
298         $this->skip_link_to('maincontent', get_string('tocontent', 'access'));
300         // Add strings used on many pages.
301         $this->string_for_js('confirmation', 'admin');
302         $this->string_for_js('cancel', 'moodle');
303         $this->string_for_js('yes', 'moodle');
305         // Alter links in top frame to break out of frames.
306         if ($page->pagelayout === 'frametop') {
307             $this->js_init_call('M.util.init_frametop');
308         }
310         // Include block drag/drop if editing is on
311         if ($page->user_is_editing()) {
312             $params = array(
313                 'courseid' => $page->course->id,
314                 'pagetype' => $page->pagetype,
315                 'pagelayout' => $page->pagelayout,
316                 'subpage' => $page->subpage,
317                 'regions' => $page->blocks->get_regions(),
318                 'contextid' => $page->context->id,
319             );
320             if (!empty($page->cm->id)) {
321                 $params['cmid'] = $page->cm->id;
322             }
323             // Strings for drag and drop.
324             $this->strings_for_js(array('movecontent',
325                                         'tocontent',
326                                         'emptydragdropregion'),
327                                   'moodle');
328             $page->requires->yui_module('moodle-core-blocks', 'M.core_blocks.init_dragdrop', array($params), null, true);
329         }
330     }
332     /**
333      * Ensure that the specified JavaScript file is linked to from this page.
334      *
335      * NOTE: This function is to be used in RARE CASES ONLY, please store your JS in module.js file
336      * and use $PAGE->requires->js_init_call() instead or use /yui/ subdirectories for YUI modules.
337      *
338      * By default the link is put at the end of the page, since this gives best page-load performance.
339      *
340      * Even if a particular script is requested more than once, it will only be linked
341      * to once.
342      *
343      * @param string|moodle_url $url The path to the .js file, relative to $CFG->dirroot / $CFG->wwwroot.
344      *      For example '/mod/mymod/customscripts.js'; use moodle_url for external scripts
345      * @param bool $inhead initialise in head
346      */
347     public function js($url, $inhead = false) {
348         $url = $this->js_fix_url($url);
349         $where = $inhead ? 'head' : 'footer';
350         $this->jsincludes[$where][$url->out()] = $url;
351     }
353     /**
354      * Request inclusion of jQuery library in the page.
355      *
356      * NOTE: this should not be used in official Moodle distribution!
357      *
358      * We are going to bundle jQuery 1.9.x until we drop support
359      * all support for IE 6-8. Use $PAGE->requires->jquery_plugin('migrate')
360      * for code written for earlier jQuery versions.
361      *
362      * {@see http://docs.moodle.org/dev/jQuery}
363      */
364     public function jquery() {
365         $this->jquery_plugin('jquery');
366     }
368     /**
369      * Request inclusion of jQuery plugin.
370      *
371      * NOTE: this should not be used in official Moodle distribution!
372      *
373      * jQuery plugins are located in plugin/jquery/* subdirectory,
374      * plugin/jquery/plugins.php lists all available plugins.
375      *
376      * Included core plugins:
377      *   - jQuery UI
378      *   - jQuery Migrate (useful for code written for previous UI version)
379      *
380      * Add-ons may include extra jQuery plugins in jquery/ directory,
381      * plugins.php file defines the mapping between plugin names and
382      * necessary page includes.
383      *
384      * Examples:
385      * <code>
386      *   // file: mod/xxx/view.php
387      *   $PAGE->requires->jquery();
388      *   $PAGE->requires->jquery_plugin('ui');
389      *   $PAGE->requires->jquery_plugin('ui-css');
390      * </code>
391      *
392      * <code>
393      *   // file: theme/yyy/lib.php
394      *   function theme_yyy_page_init(moodle_page $page) {
395      *       $page->requires->jquery();
396      *       $page->requires->jquery_plugin('ui');
397      *       $page->requires->jquery_plugin('ui-css');
398      *   }
399      * </code>
400      *
401      * <code>
402      *   // file: blocks/zzz/block_zzz.php
403      *   public function get_required_javascript() {
404      *       parent::get_required_javascript();
405      *       $this->page->requires->jquery();
406      *       $page->requires->jquery_plugin('ui');
407      *       $page->requires->jquery_plugin('ui-css');
408      *   }
409      * </code>
410      *
411      * {@see http://docs.moodle.org/dev/jQuery}
412      *
413      * @param string $plugin name of the jQuery plugin as defined in jquery/plugins.php
414      * @param string $component name of the component
415      * @return bool success
416      */
417     public function jquery_plugin($plugin, $component = 'core') {
418         global $CFG;
420         if ($this->headdone) {
421             debugging('Can not add jQuery plugins after starting page output!');
422             return false;
423         }
425         if ($component !== 'core' and in_array($plugin, array('jquery', 'ui', 'ui-css', 'migrate'))) {
426             debugging("jQuery plugin '$plugin' is included in Moodle core, other components can not use the same name.", DEBUG_DEVELOPER);
427             $component = 'core';
428         } else if ($component !== 'core' and strpos($component, '_') === false) {
429             // Let's normalise the legacy activity names, Frankenstyle rulez!
430             $component = 'mod_' . $component;
431         }
433         if (empty($this->jqueryplugins) and ($component !== 'core' or $plugin !== 'jquery')) {
434             // Make sure the jQuery itself is always loaded first,
435             // the order of all other plugins depends on order of $PAGE_>requires->.
436             $this->jquery_plugin('jquery', 'core');
437         }
439         if (isset($this->jqueryplugins[$plugin])) {
440             // No problem, we already have something, first Moodle plugin to register the jQuery plugin wins.
441             return true;
442         }
444         $componentdir = core_component::get_component_directory($component);
445         if (!file_exists($componentdir) or !file_exists("$componentdir/jquery/plugins.php")) {
446             debugging("Can not load jQuery plugin '$plugin', missing plugins.php in component '$component'.", DEBUG_DEVELOPER);
447             return false;
448         }
450         $plugins = array();
451         require("$componentdir/jquery/plugins.php");
453         if (!isset($plugins[$plugin])) {
454             debugging("jQuery plugin '$plugin' can not be found in component '$component'.", DEBUG_DEVELOPER);
455             return false;
456         }
458         $this->jqueryplugins[$plugin] = new stdClass();
459         $this->jqueryplugins[$plugin]->plugin    = $plugin;
460         $this->jqueryplugins[$plugin]->component = $component;
461         $this->jqueryplugins[$plugin]->urls      = array();
463         foreach ($plugins[$plugin]['files'] as $file) {
464             if ($CFG->debugdeveloper) {
465                 if (!file_exists("$componentdir/jquery/$file")) {
466                     debugging("Invalid file '$file' specified in jQuery plugin '$plugin' in component '$component'");
467                     continue;
468                 }
469                 $file = str_replace('.min.css', '.css', $file);
470                 $file = str_replace('.min.js', '.js', $file);
471             }
472             if (!file_exists("$componentdir/jquery/$file")) {
473                 debugging("Invalid file '$file' specified in jQuery plugin '$plugin' in component '$component'");
474                 continue;
475             }
476             if (!empty($CFG->slasharguments)) {
477                 $url = new moodle_url("$CFG->httpswwwroot/theme/jquery.php");
478                 $url->set_slashargument("/$component/$file");
480             } else {
481                 // This is not really good, we need slasharguments for relative links, this means no caching...
482                 $path = realpath("$componentdir/jquery/$file");
483                 if (strpos($path, $CFG->dirroot) === 0) {
484                     $url = $CFG->httpswwwroot.preg_replace('/^'.preg_quote($CFG->dirroot, '/').'/', '', $path);
485                     $url = new moodle_url($url);
486                 } else {
487                     // Bad luck, fix your server!
488                     debugging("Moodle jQuery integration requires 'slasharguments' setting to be enabled.");
489                     continue;
490                 }
491             }
492             $this->jqueryplugins[$plugin]->urls[] = $url;
493         }
495         return true;
496     }
498     /**
499      * Request replacement of one jQuery plugin by another.
500      *
501      * This is useful when themes want to replace the jQuery UI theme,
502      * the problem is that theme can not prevent others from including the core ui-css plugin.
503      *
504      * Example:
505      *  1/ generate new jQuery UI theme and place it into theme/yourtheme/jquery/
506      *  2/ write theme/yourtheme/jquery/plugins.php
507      *  3/ init jQuery from theme
508      *
509      * <code>
510      *   // file theme/yourtheme/lib.php
511      *   function theme_yourtheme_page_init($page) {
512      *       $page->requires->jquery_plugin('yourtheme-ui-css', 'theme_yourtheme');
513      *       $page->requires->jquery_override_plugin('ui-css', 'yourtheme-ui-css');
514      *   }
515      * </code>
516      *
517      * This code prevents loading of standard 'ui-css' which my be requested by other plugins,
518      * the 'yourtheme-ui-css' gets loaded only if some other code requires jquery.
519      *
520      * {@see http://docs.moodle.org/dev/jQuery}
521      *
522      * @param string $oldplugin original plugin
523      * @param string $newplugin the replacement
524      */
525     public function jquery_override_plugin($oldplugin, $newplugin) {
526         if ($this->headdone) {
527             debugging('Can not override jQuery plugins after starting page output!');
528             return;
529         }
530         $this->jquerypluginoverrides[$oldplugin] = $newplugin;
531     }
533     /**
534      * Return jQuery related markup for page start.
535      * @return string
536      */
537     protected function get_jquery_headcode() {
538         if (empty($this->jqueryplugins['jquery'])) {
539             // If nobody requested jQuery then do not bother to load anything.
540             // This may be useful for themes that want to override 'ui-css' only if requested by something else.
541             return '';
542         }
544         $included = array();
545         $urls = array();
547         foreach ($this->jqueryplugins as $name => $unused) {
548             if (isset($included[$name])) {
549                 continue;
550             }
551             if (array_key_exists($name, $this->jquerypluginoverrides)) {
552                 // The following loop tries to resolve the replacements,
553                 // use max 100 iterations to prevent infinite loop resulting
554                 // in blank page.
555                 $cyclic = true;
556                 $oldname = $name;
557                 for ($i=0; $i<100; $i++) {
558                     $name = $this->jquerypluginoverrides[$name];
559                     if (!array_key_exists($name, $this->jquerypluginoverrides)) {
560                         $cyclic = false;
561                         break;
562                     }
563                 }
564                 if ($cyclic) {
565                     // We can not do much with cyclic references here, let's use the old plugin.
566                     $name = $oldname;
567                     debugging("Cyclic overrides detected for jQuery plugin '$name'");
569                 } else if (empty($name)) {
570                     // Developer requested removal of the plugin.
571                     continue;
573                 } else if (!isset($this->jqueryplugins[$name])) {
574                     debugging("Unknown jQuery override plugin '$name' detected");
575                     $name = $oldname;
577                 } else if (isset($included[$name])) {
578                     // The plugin was already included, easy.
579                     continue;
580                 }
581             }
583             $plugin = $this->jqueryplugins[$name];
584             $urls = array_merge($urls, $plugin->urls);
585             $included[$name] = true;
586         }
588         $output = '';
589         $attributes = array('rel' => 'stylesheet', 'type' => 'text/css');
590         foreach ($urls as $url) {
591             if (preg_match('/\.js$/', $url)) {
592                 $output .= html_writer::script('', $url);
593             } else if (preg_match('/\.css$/', $url)) {
594                 $attributes['href'] = $url;
595                 $output .= html_writer::empty_tag('link', $attributes) . "\n";
596             }
597         }
599         return $output;
600     }
602     /**
603      * This method was used to load YUI2 libraries into global scope,
604      * use YUI 2in3 instead. Every YUI2 module is represented as a yui2-*
605      * sandboxed module in YUI3 code via Y.YUI2. property.
606      *
607      * {@see http://tracker.moodle.org/browse/MDL-34741}
608      *
609      * @param string|array $libname
610      * @deprecated since 2.4
611      */
612     public function yui2_lib($libname) {
613         throw new coding_exception('PAGE->yui2_lib() is not available any more, use YUI 2in3 instead, see MDL-34741 for more information.');
614     }
616     /**
617      * Returns the actual url through which a script is served.
618      *
619      * @param moodle_url|string $url full moodle url, or shortened path to script
620      * @return moodle_url
621      */
622     protected function js_fix_url($url) {
623         global $CFG;
625         if ($url instanceof moodle_url) {
626             return $url;
627         } else if (strpos($url, '/') === 0) {
628             // Fix the admin links if needed.
629             if ($CFG->admin !== 'admin') {
630                 if (strpos($url, "/admin/") === 0) {
631                     $url = preg_replace("|^/admin/|", "/$CFG->admin/", $url);
632                 }
633             }
634             if (debugging()) {
635                 // Check file existence only when in debug mode.
636                 if (!file_exists($CFG->dirroot . strtok($url, '?'))) {
637                     throw new coding_exception('Attempt to require a JavaScript file that does not exist.', $url);
638                 }
639             }
640             if (substr($url, -3) === '.js') {
641                 if (empty($CFG->cachejs) or !isset($CFG->jsrev)) {
642                     $jsrev = -1;
643                 } else {
644                     $jsrev = (int)$CFG->jsrev;
645                 }
646                 if (empty($CFG->slasharguments)) {
647                     return new moodle_url($CFG->httpswwwroot.'/lib/javascript.php', array('rev'=>$jsrev, 'jsfile'=>$url));
648                 } else {
649                     $returnurl = new moodle_url($CFG->httpswwwroot.'/lib/javascript.php');
650                     $returnurl->set_slashargument('/'.$jsrev.$url);
651                     return $returnurl;
652                 }
653             } else {
654                 return new moodle_url($CFG->httpswwwroot.$url);
655             }
656         } else {
657             throw new coding_exception('Invalid JS url, it has to be shortened url starting with / or moodle_url instance.', $url);
658         }
659     }
661     /**
662      * Find out if JS module present and return details.
663      *
664      * @param string $component name of component in frankenstyle, ex: core_group, mod_forum
665      * @return array description of module or null if not found
666      */
667     protected function find_module($component) {
668         global $CFG, $PAGE;
670         $module = null;
672         if (strpos($component, 'core_') === 0) {
673             // Must be some core stuff - list here is not complete, this is just the stuff used from multiple places
674             // so that we do nto have to repeat the definition of these modules over and over again.
675             switch($component) {
676                 case 'core_filepicker':
677                     $module = array('name'     => 'core_filepicker',
678                                     'fullpath' => '/repository/filepicker.js',
679                                     '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'),
680                                     'strings'  => array(array('lastmodified', 'moodle'), array('name', 'moodle'), array('type', 'repository'), array('size', 'repository'),
681                                                         array('invalidjson', 'repository'), array('error', 'moodle'), array('info', 'moodle'),
682                                                         array('nofilesattached', 'repository'), array('filepicker', 'repository'), array('logout', 'repository'),
683                                                         array('nofilesavailable', 'repository'), array('norepositoriesavailable', 'repository'),
684                                                         array('fileexistsdialogheader', 'repository'), array('fileexistsdialog_editor', 'repository'),
685                                                         array('fileexistsdialog_filemanager', 'repository'), array('renameto', 'repository'),
686                                                         array('referencesexist', 'repository'), array('select', 'repository')
687                                                     ));
688                     break;
689                 case 'core_comment':
690                     $module = array('name'     => 'core_comment',
691                                     'fullpath' => '/comment/comment.js',
692                                     'requires' => array('base', 'io-base', 'node', 'json', 'yui2-animation', 'overlay'),
693                                     'strings' => array(array('confirmdeletecomments', 'admin'), array('yes', 'moodle'), array('no', 'moodle'))
694                                 );
695                     break;
696                 case 'core_role':
697                     $module = array('name'     => 'core_role',
698                                     'fullpath' => '/admin/roles/module.js',
699                                     'requires' => array('node', 'cookie'));
700                     break;
701                 case 'core_completion':
702                     $module = array('name'     => 'core_completion',
703                                     'fullpath' => '/course/completion.js');
704                     break;
705                 case 'core_message':
706                     $module = array('name'     => 'core_message',
707                                     'requires' => array('base', 'node', 'event', 'node-event-simulate'),
708                                     'fullpath' => '/message/module.js');
709                     break;
710                 case 'core_group':
711                     $module = array('name'     => 'core_group',
712                                     'fullpath' => '/group/module.js',
713                                     'requires' => array('node', 'overlay', 'event-mouseenter'));
714                     break;
715                 case 'core_question_engine':
716                     $module = array('name'     => 'core_question_engine',
717                                     'fullpath' => '/question/qengine.js',
718                                     'requires' => array('node', 'event'));
719                     break;
720                 case 'core_rating':
721                     $module = array('name'     => 'core_rating',
722                                     'fullpath' => '/rating/module.js',
723                                     'requires' => array('node', 'event', 'overlay', 'io-base', 'json'));
724                     break;
725                 case 'core_dndupload':
726                     $module = array('name'     => 'core_dndupload',
727                                     'fullpath' => '/lib/form/dndupload.js',
728                                     'requires' => array('node', 'event', 'json', 'core_filepicker'),
729                                     'strings'  => array(array('uploadformlimit', 'moodle'), array('droptoupload', 'moodle'), array('maxfilesreached', 'moodle'),
730                                                         array('dndenabled_inbox', 'moodle'), array('fileexists', 'moodle'), array('maxbytesforfile', 'moodle'),
731                                                         array('maxareabytesreached', 'moodle')
732                                                     ));
733                     break;
734             }
736         } else {
737             if ($dir = core_component::get_component_directory($component)) {
738                 if (file_exists("$dir/module.js")) {
739                     if (strpos($dir, $CFG->dirroot.'/') === 0) {
740                         $dir = substr($dir, strlen($CFG->dirroot));
741                         $module = array('name'=>$component, 'fullpath'=>"$dir/module.js", 'requires' => array());
742                     }
743                 }
744             }
745         }
747         return $module;
748     }
750     /**
751      * Append YUI3 module to default YUI3 JS loader.
752      * The structure of module array is described at {@link http://developer.yahoo.com/yui/3/yui/}
753      *
754      * @param string|array $module name of module (details are autodetected), or full module specification as array
755      * @return void
756      */
757     public function js_module($module) {
758         global $CFG;
760         if (empty($module)) {
761             throw new coding_exception('Missing YUI3 module name or full description.');
762         }
764         if (is_string($module)) {
765             $module = $this->find_module($module);
766         }
768         if (empty($module) or empty($module['name']) or empty($module['fullpath'])) {
769             throw new coding_exception('Missing YUI3 module details.');
770         }
772         // Don't load this module if we already have, no need to!
773         if ($this->js_module_loaded($module['name'])) {
774             if ($CFG->debugdeveloper) {
775                 $this->debug_moduleloadstacktraces[$module['name']][] = format_backtrace(debug_backtrace());
776             }
777             return;
778         }
780         $module['fullpath'] = $this->js_fix_url($module['fullpath'])->out(false);
781         // Add all needed strings.
782         if (!empty($module['strings'])) {
783             foreach ($module['strings'] as $string) {
784                 $identifier = $string[0];
785                 $component = isset($string[1]) ? $string[1] : 'moodle';
786                 $a = isset($string[2]) ? $string[2] : null;
787                 $this->string_for_js($identifier, $component, $a);
788             }
789         }
790         unset($module['strings']);
792         // Process module requirements and attempt to load each. This allows
793         // moodle modules to require each other.
794         if (!empty($module['requires'])){
795             foreach ($module['requires'] as $requirement) {
796                 $rmodule = $this->find_module($requirement);
797                 if (is_array($rmodule)) {
798                     $this->js_module($rmodule);
799                 }
800             }
801         }
803         if ($this->headdone) {
804             $this->extramodules[$module['name']] = $module;
805         } else {
806             $this->YUI_config->add_module_config($module['name'], $module);
807         }
808         if ($CFG->debugdeveloper) {
809             if (!array_key_exists($module['name'], $this->debug_moduleloadstacktraces)) {
810                 $this->debug_moduleloadstacktraces[$module['name']] = array();
811             }
812             $this->debug_moduleloadstacktraces[$module['name']][] = format_backtrace(debug_backtrace());
813         }
814     }
816     /**
817      * Returns true if the module has already been loaded.
818      *
819      * @param string|array $module
820      * @return bool True if the module has already been loaded
821      */
822     protected function js_module_loaded($module) {
823         if (is_string($module)) {
824             $modulename = $module;
825         } else {
826             $modulename = $module['name'];
827         }
828         return array_key_exists($modulename, $this->YUI_config->modules) ||
829                array_key_exists($modulename, $this->extramodules);
830     }
832     /**
833      * Returns the stacktraces from loading js modules.
834      * @return array
835      */
836     public function get_loaded_modules() {
837         return $this->debug_moduleloadstacktraces;
838     }
840     /**
841      * Ensure that the specified CSS file is linked to from this page.
842      *
843      * Because stylesheet links must go in the <head> part of the HTML, you must call
844      * this function before {@link get_head_code()} is called. That normally means before
845      * the call to print_header. If you call it when it is too late, an exception
846      * will be thrown.
847      *
848      * Even if a particular style sheet is requested more than once, it will only
849      * be linked to once.
850      *
851      * Please note use of this feature is strongly discouraged,
852      * it is suitable only for places where CSS is submitted directly by teachers.
853      * (Students must not be allowed to submit any external CSS because it may
854      * contain embedded javascript!). Example of correct use is mod/data.
855      *
856      * @param string $stylesheet The path to the .css file, relative to $CFG->wwwroot.
857      *   For example:
858      *      $PAGE->requires->css('mod/data/css.php?d='.$data->id);
859      */
860     public function css($stylesheet) {
861         global $CFG;
863         if ($this->headdone) {
864             throw new coding_exception('Cannot require a CSS file after &lt;head> has been printed.', $stylesheet);
865         }
867         if ($stylesheet instanceof moodle_url) {
868             // ok
869         } else if (strpos($stylesheet, '/') === 0) {
870             $stylesheet = new moodle_url($CFG->httpswwwroot.$stylesheet);
871         } else {
872             throw new coding_exception('Invalid stylesheet parameter.', $stylesheet);
873         }
875         $this->cssurls[$stylesheet->out()] = $stylesheet;
876     }
878     /**
879      * Add theme stylesheet to page - do not use from plugin code,
880      * this should be called only from the core renderer!
881      *
882      * @param moodle_url $stylesheet
883      * @return void
884      */
885     public function css_theme(moodle_url $stylesheet) {
886         $this->cssthemeurls[] = $stylesheet;
887     }
889     /**
890      * Ensure that a skip link to a given target is printed at the top of the <body>.
891      *
892      * You must call this function before {@link get_top_of_body_code()}, (if not, an exception
893      * will be thrown). That normally means you must call this before the call to print_header.
894      *
895      * If you ask for a particular skip link to be printed, it is then your responsibility
896      * to ensure that the appropriate <a name="..."> tag is printed in the body of the
897      * page, so that the skip link goes somewhere.
898      *
899      * Even if a particular skip link is requested more than once, only one copy of it will be output.
900      *
901      * @param string $target the name of anchor this link should go to. For example 'maincontent'.
902      * @param string $linktext The text to use for the skip link. Normally get_string('skipto', 'access', ...);
903      */
904     public function skip_link_to($target, $linktext) {
905         if ($this->topofbodydone) {
906             debugging('Page header already printed, can not add skip links any more, code needs to be fixed.');
907             return;
908         }
909         $this->skiplinks[$target] = $linktext;
910     }
912     /**
913      * !!!DEPRECATED!!! please use js_init_call() if possible
914      * Ensure that the specified JavaScript function is called from an inline script
915      * somewhere on this page.
916      *
917      * By default the call will be put in a script tag at the
918      * end of the page after initialising Y instance, since this gives best page-load
919      * performance and allows you to use YUI3 library.
920      *
921      * If you request that a particular function is called several times, then
922      * that is what will happen (unlike linking to a CSS or JS file, where only
923      * one link will be output).
924      *
925      * The main benefit of the method is the automatic encoding of all function parameters.
926      *
927      * @deprecated
928      *
929      * @param string $function the name of the JavaScritp function to call. Can
930      *      be a compound name like 'Y.Event.purgeElement'. Can also be
931      *      used to create and object by using a 'function name' like 'new user_selector'.
932      * @param array $arguments and array of arguments to be passed to the function.
933      *      When generating the function call, this will be escaped using json_encode,
934      *      so passing objects and arrays should work.
935      * @param bool $ondomready If tru the function is only called when the dom is
936      *      ready for manipulation.
937      * @param int $delay The delay before the function is called.
938      */
939     public function js_function_call($function, array $arguments = null, $ondomready = false, $delay = 0) {
940         $where = $ondomready ? 'ondomready' : 'normal';
941         $this->jscalls[$where][] = array($function, $arguments, $delay);
942     }
944     /**
945      * Adds a call to make use of a YUI gallery module. DEPRECATED DO NOT USE!!!
946      *
947      * @deprecated DO NOT USE
948      *
949      * @param string|array $modules One or more gallery modules to require
950      * @param string $version
951      * @param string $function
952      * @param array $arguments
953      * @param bool $ondomready
954      */
955     public function js_gallery_module($modules, $version, $function, array $arguments = null, $ondomready = false) {
956         global $CFG;
957         debugging('This function will be removed before 2.0 is released please change it from js_gallery_module to yui_module', DEBUG_DEVELOPER);
958         $this->yui_module($modules, $function, $arguments, $version, $ondomready);
959     }
961     /**
962      * Creates a JavaScript function call that requires one or more modules to be loaded.
963      *
964      * This function can be used to include all of the standard YUI module types within JavaScript:
965      *     - YUI3 modules    [node, event, io]
966      *     - YUI2 modules    [yui2-*]
967      *     - Moodle modules  [moodle-*]
968      *     - Gallery modules [gallery-*]
969      *
970      * @param array|string $modules One or more modules
971      * @param string $function The function to call once modules have been loaded
972      * @param array $arguments An array of arguments to pass to the function
973      * @param string $galleryversion The gallery version to use
974      * @param bool $ondomready
975      */
976     public function yui_module($modules, $function, array $arguments = null, $galleryversion = null, $ondomready = false) {
977         global $CFG;
979         if (!$galleryversion) {
980             $galleryversion = '2010.04.08-12-35';
981         }
983         if (!is_array($modules)) {
984             $modules = array($modules);
985         }
986         if (empty($CFG->useexternalyui)) {
987             // We need to set the M.yui.galleryversion to the correct version
988             $jscode = 'M.yui.galleryversion='.json_encode($galleryversion).';';
989         } else {
990             // Set Y's config.gallery to the version
991             $jscode = 'Y.config.gallery='.json_encode($galleryversion).';';
992         }
993         $jscode .= 'Y.use('.join(',', array_map('json_encode', convert_to_array($modules))).',function() {'.js_writer::function_call($function, $arguments).'});';
994         if ($ondomready) {
995             $jscode = "Y.on('domready', function() { $jscode });";
996         }
997         $this->jsinitcode[] = $jscode;
998     }
1000     /**
1001      * Ensure that the specified JavaScript function is called from an inline script
1002      * from page footer.
1003      *
1004      * @param string $function the name of the JavaScritp function to with init code,
1005      *      usually something like 'M.mod_mymodule.init'
1006      * @param array $extraarguments and array of arguments to be passed to the function.
1007      *      The first argument is always the YUI3 Y instance with all required dependencies
1008      *      already loaded.
1009      * @param bool $ondomready wait for dom ready (helps with some IE problems when modifying DOM)
1010      * @param array $module JS module specification array
1011      */
1012     public function js_init_call($function, array $extraarguments = null, $ondomready = false, array $module = null) {
1013         $jscode = js_writer::function_call_with_Y($function, $extraarguments);
1014         if (!$module) {
1015             // Detect module automatically.
1016             if (preg_match('/M\.([a-z0-9]+_[^\.]+)/', $function, $matches)) {
1017                 $module = $this->find_module($matches[1]);
1018             }
1019         }
1021         $this->js_init_code($jscode, $ondomready, $module);
1022     }
1024     /**
1025      * Add short static javascript code fragment to page footer.
1026      * This is intended primarily for loading of js modules and initialising page layout.
1027      * Ideally the JS code fragment should be stored in plugin renderer so that themes
1028      * may override it.
1029      *
1030      * @param string $jscode
1031      * @param bool $ondomready wait for dom ready (helps with some IE problems when modifying DOM)
1032      * @param array $module JS module specification array
1033      */
1034     public function js_init_code($jscode, $ondomready = false, array $module = null) {
1035         $jscode = trim($jscode, " ;\n"). ';';
1037         if ($module) {
1038             $this->js_module($module);
1039             $modulename = $module['name'];
1040             $jscode = "Y.use('$modulename', function(Y) { $jscode });";
1041         }
1043         if ($ondomready) {
1044             $jscode = "Y.on('domready', function() { $jscode });";
1045         }
1047         $this->jsinitcode[] = $jscode;
1048     }
1050     /**
1051      * Make a language string available to JavaScript.
1052      *
1053      * All the strings will be available in a M.str object in the global namespace.
1054      * So, for example, after a call to $PAGE->requires->string_for_js('course', 'moodle');
1055      * then the JavaScript variable M.str.moodle.course will be 'Course', or the
1056      * equivalent in the current language.
1057      *
1058      * The arguments to this function are just like the arguments to get_string
1059      * except that $component is not optional, and there are some aspects to consider
1060      * when the string contains {$a} placeholder.
1061      *
1062      * If the string does not contain any {$a} placeholder, you can simply use
1063      * M.str.component.identifier to obtain it. If you prefer, you can call
1064      * M.util.get_string(identifier, component) to get the same result.
1065      *
1066      * If you need to use {$a} placeholders, there are two options. Either the
1067      * placeholder should be substituted in PHP on server side or it should
1068      * be substituted in Javascript at client side.
1069      *
1070      * To substitute the placeholder at server side, just provide the required
1071      * value for the placeholder when you require the string. Because each string
1072      * is only stored once in the JavaScript (based on $identifier and $module)
1073      * you cannot get the same string with two different values of $a. If you try,
1074      * an exception will be thrown. Once the placeholder is substituted, you can
1075      * use M.str or M.util.get_string() as shown above:
1076      *
1077      *     // Require the string in PHP and replace the placeholder.
1078      *     $PAGE->requires->string_for_js('fullnamedisplay', 'moodle', $USER);
1079      *     // Use the result of the substitution in Javascript.
1080      *     alert(M.str.moodle.fullnamedisplay);
1081      *
1082      * To substitute the placeholder at client side, use M.util.get_string()
1083      * function. It implements the same logic as {@link get_string()}:
1084      *
1085      *     // Require the string in PHP but keep {$a} as it is.
1086      *     $PAGE->requires->string_for_js('fullnamedisplay', 'moodle');
1087      *     // Provide the values on the fly in Javascript.
1088      *     user = { firstname : 'Harry', lastname : 'Potter' }
1089      *     alert(M.util.get_string('fullnamedisplay', 'moodle', user);
1090      *
1091      * If you do need the same string expanded with different $a values in PHP
1092      * on server side, then the solution is to put them in your own data structure
1093      * (e.g. and array) that you pass to JavaScript with {@link data_for_js()}.
1094      *
1095      * @param string $identifier the desired string.
1096      * @param string $component the language file to look in.
1097      * @param mixed $a any extra data to add into the string (optional).
1098      */
1099     public function string_for_js($identifier, $component, $a = null) {
1100         if (!$component) {
1101             throw new coding_exception('The $component parameter is required for page_requirements_manager::string_for_js().');
1102         }
1103         if (isset($this->stringsforjs_as[$component][$identifier]) and $this->stringsforjs_as[$component][$identifier] !== $a) {
1104             throw new coding_exception("Attempt to re-define already required string '$identifier' " .
1105                     "from lang file '$component' with different \$a parameter?");
1106         }
1107         if (!isset($this->stringsforjs[$component][$identifier])) {
1108             $this->stringsforjs[$component][$identifier] = new lang_string($identifier, $component, $a);
1109             $this->stringsforjs_as[$component][$identifier] = $a;
1110         }
1111     }
1113     /**
1114      * Make an array of language strings available for JS.
1115      *
1116      * This function calls the above function {@link string_for_js()} for each requested
1117      * string in the $identifiers array that is passed to the argument for a single module
1118      * passed in $module.
1119      *
1120      * <code>
1121      * $PAGE->requires->strings_for_js(array('one', 'two', 'three'), 'mymod', array('a', null, 3));
1122      *
1123      * // The above is identical to calling:
1124      *
1125      * $PAGE->requires->string_for_js('one', 'mymod', 'a');
1126      * $PAGE->requires->string_for_js('two', 'mymod');
1127      * $PAGE->requires->string_for_js('three', 'mymod', 3);
1128      * </code>
1129      *
1130      * @param array $identifiers An array of desired strings
1131      * @param string $component The module to load for
1132      * @param mixed $a This can either be a single variable that gets passed as extra
1133      *         information for every string or it can be an array of mixed data where the
1134      *         key for the data matches that of the identifier it is meant for.
1135      *
1136      */
1137     public function strings_for_js($identifiers, $component, $a = null) {
1138         foreach ($identifiers as $key => $identifier) {
1139             if (is_array($a) && array_key_exists($key, $a)) {
1140                 $extra = $a[$key];
1141             } else {
1142                 $extra = $a;
1143             }
1144             $this->string_for_js($identifier, $component, $extra);
1145         }
1146     }
1148     /**
1149      * !!!!!!DEPRECATED!!!!!! please use js_init_call() for everything now.
1150      *
1151      * Make some data from PHP available to JavaScript code.
1152      *
1153      * For example, if you call
1154      * <pre>
1155      *      $PAGE->requires->data_for_js('mydata', array('name' => 'Moodle'));
1156      * </pre>
1157      * then in JavsScript mydata.name will be 'Moodle'.
1158      *
1159      * @deprecated
1160      * @param string $variable the the name of the JavaScript variable to assign the data to.
1161      *      Will probably work if you use a compound name like 'mybuttons.button[1]', but this
1162      *      should be considered an experimental feature.
1163      * @param mixed $data The data to pass to JavaScript. This will be escaped using json_encode,
1164      *      so passing objects and arrays should work.
1165      * @param bool $inhead initialise in head
1166      * @return void
1167      */
1168     public function data_for_js($variable, $data, $inhead=false) {
1169         $where = $inhead ? 'head' : 'footer';
1170         $this->jsinitvariables[$where][] = array($variable, $data);
1171     }
1173     /**
1174      * Creates a YUI event handler.
1175      *
1176      * @param mixed $selector standard YUI selector for elements, may be array or string, element id is in the form "#idvalue"
1177      * @param string $event A valid DOM event (click, mousedown, change etc.)
1178      * @param string $function The name of the function to call
1179      * @param array  $arguments An optional array of argument parameters to pass to the function
1180      */
1181     public function event_handler($selector, $event, $function, array $arguments = null) {
1182         $this->eventhandlers[] = array('selector'=>$selector, 'event'=>$event, 'function'=>$function, 'arguments'=>$arguments);
1183     }
1185     /**
1186      * Returns code needed for registering of event handlers.
1187      * @return string JS code
1188      */
1189     protected function get_event_handler_code() {
1190         $output = '';
1191         foreach ($this->eventhandlers as $h) {
1192             $output .= js_writer::event_handler($h['selector'], $h['event'], $h['function'], $h['arguments']);
1193         }
1194         return $output;
1195     }
1197     /**
1198      * Get the inline JavaScript code that need to appear in a particular place.
1199      * @param bool $ondomready
1200      * @return string
1201      */
1202     protected function get_javascript_code($ondomready) {
1203         $where = $ondomready ? 'ondomready' : 'normal';
1204         $output = '';
1205         if ($this->jscalls[$where]) {
1206             foreach ($this->jscalls[$where] as $data) {
1207                 $output .= js_writer::function_call($data[0], $data[1], $data[2]);
1208             }
1209             if (!empty($ondomready)) {
1210                 $output = "    Y.on('domready', function() {\n$output\n    });";
1211             }
1212         }
1213         return $output;
1214     }
1216     /**
1217      * Returns js code to be executed when Y is available.
1218      * @return string
1219      */
1220     protected function get_javascript_init_code() {
1221         if (count($this->jsinitcode)) {
1222             return implode("\n", $this->jsinitcode) . "\n";
1223         }
1224         return '';
1225     }
1227     /**
1228      * Returns basic YUI3 JS loading code.
1229      * YUI3 is using autoloading of both CSS and JS code.
1230      *
1231      * Major benefit of this compared to standard js/csss loader is much improved
1232      * caching, better browser cache utilisation, much fewer http requests.
1233      *
1234      * @param moodle_page $page
1235      * @return string
1236      */
1237     protected function get_yui3lib_headcode($page) {
1238         global $CFG;
1240         $code = '';
1242         // Note: SimpleYUI is broken in 3.12 and will not be available in future YUI versions,
1243         //       that is why we can not load it from CDN.
1245         if ($this->yui3loader->combine) {
1246             if (!empty($page->theme->yuicssmodules)) {
1247                 $modules = array();
1248                 foreach ($page->theme->yuicssmodules as $module) {
1249                     $modules[] = "$CFG->yui3version/$module/$module-min.css";
1250                 }
1251                 $code .= '<link rel="stylesheet" type="text/css" href="'.$this->yui3loader->comboBase.implode('&amp;', $modules).'" />';
1252             }
1253             $code .= '<script type="text/javascript" src="'.$this->yui3loader->local_comboBase
1254                      .$CFG->yui3version.'/simpleyui/simpleyui-min.js&amp;'
1255                      .$CFG->yui3version.'/loader/loader-min.js"></script>';
1256         } else {
1257             if (!empty($page->theme->yuicssmodules)) {
1258                 foreach ($page->theme->yuicssmodules as $module) {
1259                     $code .= '<link rel="stylesheet" type="text/css" href="'.$this->yui3loader->base.$module.'/'.$module.'-min.css" />';
1260                 }
1261             }
1262             $code .= '<script type="text/javascript" src="'.$this->yui3loader->local_base.'simpleyui/simpleyui-min.js"></script>';
1263             $code .= '<script type="text/javascript" src="'.$this->yui3loader->local_base.'loader/loader-min.js"></script>';
1264         }
1267         if ($this->yui3loader->filter === 'RAW') {
1268             $code = str_replace('-min.css', '.css', $code);
1269             $code = str_replace('-min.js', '.js', $code);
1270         } else if ($this->yui3loader->filter === 'DEBUG') {
1271             $code = str_replace('-min.css', '.css', $code);
1272             $code = str_replace('-min.js', '-debug.js', $code);
1273         }
1275         return $code;
1276     }
1278     /**
1279      * Returns html tags needed for inclusion of theme CSS.
1280      *
1281      * @return string
1282      */
1283     protected function get_css_code() {
1284         // First of all the theme CSS, then any custom CSS
1285         // Please note custom CSS is strongly discouraged,
1286         // because it can not be overridden by themes!
1287         // It is suitable only for things like mod/data which accepts CSS from teachers.
1288         $attributes = array('rel'=>'stylesheet', 'type'=>'text/css');
1290         // This line of code may look funny but it is currently required in order
1291         // to avoid MASSIVE display issues in Internet Explorer.
1292         // As of IE8 + YUI3.1.1 the reference stylesheet (firstthemesheet) gets
1293         // ignored whenever another resource is added until such time as a redraw
1294         // is forced, usually by moving the mouse over the affected element.
1295         $code = html_writer::tag('script', '/** Required in order to fix style inclusion problems in IE with YUI **/', array('id'=>'firstthemesheet', 'type'=>'text/css'));
1297         $urls = $this->cssthemeurls + $this->cssurls;
1298         foreach ($urls as $url) {
1299             $attributes['href'] = $url;
1300             $code .= html_writer::empty_tag('link', $attributes) . "\n";
1301             // This id is needed in first sheet only so that theme may override YUI sheets loaded on the fly.
1302             unset($attributes['id']);
1303         }
1305         return $code;
1306     }
1308     /**
1309      * Adds extra modules specified after printing of page header.
1310      *
1311      * @return string
1312      */
1313     protected function get_extra_modules_code() {
1314         if (empty($this->extramodules)) {
1315             return '';
1316         }
1317         return html_writer::script(js_writer::function_call('M.yui.add_module', array($this->extramodules)));
1318     }
1320     /**
1321      * Generate any HTML that needs to go inside the <head> tag.
1322      *
1323      * Normally, this method is called automatically by the code that prints the
1324      * <head> tag. You should not normally need to call it in your own code.
1325      *
1326      * @param moodle_page $page
1327      * @param core_renderer $renderer
1328      * @return string the HTML code to to inside the <head> tag.
1329      */
1330     public function get_head_code(moodle_page $page, core_renderer $renderer) {
1331         global $CFG;
1333         // Note: the $page and $output are not stored here because it would
1334         // create circular references in memory which prevents garbage collection.
1335         $this->init_requirements_data($page, $renderer);
1337         $output = '';
1339         // Set up the M namespace.
1340         $js = "var M = {}; M.yui = {};\n";
1342         // Capture the time now ASAP during page load. This minimises the lag when
1343         // we try to relate times on the server to times in the browser.
1344         // An example of where this is used is the quiz countdown timer.
1345         $js .= "M.pageloadstarttime = new Date();\n";
1347         // Add a subset of Moodle configuration to the M namespace.
1348         $js .= js_writer::set_variable('M.cfg', $this->M_cfg, false);
1350         // Set up global YUI3 loader object - this should contain all code needed by plugins.
1351         // Note: in JavaScript just use "YUI().use('overlay', function(Y) { .... });",
1352         //       this needs to be done before including any other script.
1353         $js .= $this->YUI_config->get_config_functions();
1354         $js .= js_writer::set_variable('YUI_config', $this->YUI_config, false) . "\n";
1355         $js .= "M.yui.loader = {modules: {}};\n"; // Backwards compatibility only, not used any more.
1356         $js = $this->YUI_config->update_header_js($js);
1358         $output .= html_writer::script($js);
1360         // YUI3 JS and CSS need to be loaded in the header but after the YUI_config has been created.
1361         // They should be cached well by the browser.
1362         $output .= $this->get_yui3lib_headcode($page);
1364         // Add hacked jQuery support, it is not intended for standard Moodle distribution!
1365         $output .= $this->get_jquery_headcode();
1367         // Now theme CSS + custom CSS in this specific order.
1368         $output .= $this->get_css_code();
1370         // Link our main JS file, all core stuff should be there.
1371         $output .= html_writer::script('', $this->js_fix_url('/lib/javascript-static.js'));
1373         // Add variables.
1374         if ($this->jsinitvariables['head']) {
1375             $js = '';
1376             foreach ($this->jsinitvariables['head'] as $data) {
1377                 list($var, $value) = $data;
1378                 $js .= js_writer::set_variable($var, $value, true);
1379             }
1380             $output .= html_writer::script($js);
1381         }
1383         // All the other linked things from HEAD - there should be as few as possible.
1384         if ($this->jsincludes['head']) {
1385             foreach ($this->jsincludes['head'] as $url) {
1386                 $output .= html_writer::script('', $url);
1387             }
1388         }
1390         // Mark head sending done, it is not possible to anything there.
1391         $this->headdone = true;
1393         return $output;
1394     }
1396     /**
1397      * Generate any HTML that needs to go at the start of the <body> tag.
1398      *
1399      * Normally, this method is called automatically by the code that prints the
1400      * <head> tag. You should not normally need to call it in your own code.
1401      *
1402      * @return string the HTML code to go at the start of the <body> tag.
1403      */
1404     public function get_top_of_body_code() {
1405         // First the skip links.
1406         $links = '';
1407         $attributes = array('class'=>'skip');
1408         foreach ($this->skiplinks as $url => $text) {
1409             $attributes['href'] = '#' . $url;
1410             $links .= html_writer::tag('a', $text, $attributes);
1411         }
1412         $output = html_writer::tag('div', $links, array('class'=>'skiplinks')) . "\n";
1414         // Then the clever trick for hiding of things not needed when JS works.
1415         $output .= html_writer::script("document.body.className += ' jsenabled';") . "\n";
1416         $this->topofbodydone = true;
1417         return $output;
1418     }
1420     /**
1421      * Generate any HTML that needs to go at the end of the page.
1422      *
1423      * Normally, this method is called automatically by the code that prints the
1424      * page footer. You should not normally need to call it in your own code.
1425      *
1426      * @return string the HTML code to to at the end of the page.
1427      */
1428     public function get_end_code() {
1429         global $CFG;
1431         // Add other requested modules.
1432         $output = $this->get_extra_modules_code();
1434         // All the other linked scripts - there should be as few as possible.
1435         if ($this->jsincludes['footer']) {
1436             foreach ($this->jsincludes['footer'] as $url) {
1437                 $output .= html_writer::script('', $url);
1438             }
1439         }
1441         // Add all needed strings.
1442         if (!empty($this->stringsforjs)) {
1443             $strings = array();
1444             foreach ($this->stringsforjs as $component=>$v) {
1445                 foreach($v as $indentifier => $langstring) {
1446                     $strings[$component][$indentifier] = $langstring->out();
1447                 }
1448             }
1449             $output .= html_writer::script(js_writer::set_variable('M.str', $strings));
1450         }
1452         // Add variables.
1453         if ($this->jsinitvariables['footer']) {
1454             $js = '';
1455             foreach ($this->jsinitvariables['footer'] as $data) {
1456                 list($var, $value) = $data;
1457                 $js .= js_writer::set_variable($var, $value, true);
1458             }
1459             $output .= html_writer::script($js);
1460         }
1462         $inyuijs = $this->get_javascript_code(false);
1463         $ondomreadyjs = $this->get_javascript_code(true);
1464         $jsinit = $this->get_javascript_init_code();
1465         $handlersjs = $this->get_event_handler_code();
1467         // There is no global Y, make sure it is available in your scope.
1468         $js = "YUI().use('node', function(Y) {\n{$inyuijs}{$ondomreadyjs}{$jsinit}{$handlersjs}\n});";
1470         $output .= html_writer::script($js);
1472         return $output;
1473     }
1475     /**
1476      * Have we already output the code in the <head> tag?
1477      *
1478      * @return bool
1479      */
1480     public function is_head_done() {
1481         return $this->headdone;
1482     }
1484     /**
1485      * Have we already output the code at the start of the <body> tag?
1486      *
1487      * @return bool
1488      */
1489     public function is_top_of_body_done() {
1490         return $this->topofbodydone;
1491     }
1494 /**
1495  * This class represents the YUI configuration.
1496  *
1497  * @copyright 2013 Andrew Nicols
1498  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1499  * @since Moodle 2.5
1500  * @package core
1501  * @category output
1502  */
1503 class YUI_config {
1504     /**
1505      * These settings must be public so that when the object is converted to json they are exposed.
1506      * Note: Some of these are camelCase because YUI uses camelCase variable names.
1507      *
1508      * The settings are described and documented in the YUI API at:
1509      * - http://yuilibrary.com/yui/docs/api/classes/config.html
1510      * - http://yuilibrary.com/yui/docs/api/classes/Loader.html
1511      */
1512     public $debug = false;
1513     public $base;
1514     public $comboBase;
1515     public $combine;
1516     public $filter = null;
1517     public $insertBefore = 'firstthemesheet';
1518     public $groups = array();
1519     public $modules = array();
1521     /**
1522      * @var array List of functions used by the YUI Loader group pattern recognition.
1523      */
1524     protected $jsconfigfunctions = array();
1526     /**
1527      * Create a new group within the YUI_config system.
1528      *
1529      * @param String $name The name of the group. This must be unique and
1530      * not previously used.
1531      * @param Array $config The configuration for this group.
1532      * @return void
1533      */
1534     public function add_group($name, $config) {
1535         if (isset($this->groups[$name])) {
1536             throw new coding_exception("A YUI configuration group for '{$name}' already exists. To make changes to this group use YUI_config->update_group().");
1537         }
1538         $this->groups[$name] = $config;
1539     }
1541     /**
1542      * Update an existing group configuration
1543      *
1544      * Note, any existing configuration for that group will be wiped out.
1545      * This includes module configuration.
1546      *
1547      * @param String $name The name of the group. This must be unique and
1548      * not previously used.
1549      * @param Array $config The configuration for this group.
1550      * @return void
1551      */
1552     public function update_group($name, $config) {
1553         if (!isset($this->groups[$name])) {
1554             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.');
1555         }
1556         $this->groups[$name] = $config;
1557     }
1559     /**
1560      * Set the value of a configuration function used by the YUI Loader's pattern testing.
1561      *
1562      * Only the body of the function should be passed, and not the whole function wrapper.
1563      *
1564      * The JS function your write will be passed a single argument 'name' containing the
1565      * name of the module being loaded.
1566      *
1567      * @param $function String the body of the JavaScript function. This should be used i
1568      * @return String the name of the function to use in the group pattern configuration.
1569      */
1570     public function set_config_function($function) {
1571         $configname = 'yui' . (count($this->jsconfigfunctions) + 1) . 'ConfigFn';
1572         if (isset($this->jsconfigfunctions[$configname])) {
1573             throw new coding_exception("A YUI config function with this name already exists. Config function names must be unique.");
1574         }
1575         $this->jsconfigfunctions[$configname] = $function;
1576         return '@' . $configname . '@';
1577     }
1579     /**
1580      * Allow setting of the config function described in {@see set_config_function} from a file.
1581      * The contents of this file are then passed to set_config_function.
1582      *
1583      * When jsrev is positive, the function is minified and stored in a MUC cache for subsequent uses.
1584      *
1585      * @param $file The path to the JavaScript function used for YUI configuration.
1586      * @return String the name of the function to use in the group pattern configuration.
1587      */
1588     public function set_config_source($file) {
1589         global $CFG;
1590         $cache = cache::make('core', 'yuimodules');
1592         // Attempt to get the metadata from the cache.
1593         $keyname = 'configfn_' . $file;
1594         $fullpath = $CFG->dirroot . '/' . $file;
1595         if (!isset($CFG->jsrev) || $CFG->jsrev == -1) {
1596             $cache->delete($keyname);
1597             $configfn = file_get_contents($fullpath);
1598         } else {
1599             $configfn = $cache->get($keyname);
1600             if ($configfn === false) {
1601                 require_once($CFG->libdir . '/jslib.php');
1602                 $configfn = core_minify::js_files(array($fullpath));
1603                 $cache->set($keyname, $configfn);
1604             }
1605         }
1606         return $this->set_config_function($configfn);
1607     }
1609     /**
1610      * Retrieve the list of JavaScript functions for YUI_config groups.
1611      *
1612      * @return String The complete set of config functions
1613      */
1614     public function get_config_functions() {
1615         $configfunctions = '';
1616         foreach ($this->jsconfigfunctions as $functionname => $function) {
1617             $configfunctions .= "var {$functionname} = function(me) {";
1618             $configfunctions .= $function;
1619             $configfunctions .= "};\n";
1620         }
1621         return $configfunctions;
1622     }
1624     /**
1625      * Update the header JavaScript with any required modification for the YUI Loader.
1626      *
1627      * @param $js String The JavaScript to manipulate.
1628      * @return String the modified JS string.
1629      */
1630     public function update_header_js($js) {
1631         // Update the names of the the configFn variables.
1632         // The PHP json_encode function cannot handle literal names so we have to wrap
1633         // them in @ and then replace them with literals of the same function name.
1634         foreach ($this->jsconfigfunctions as $functionname => $function) {
1635             $js = str_replace('"@' . $functionname . '@"', $functionname, $js);
1636         }
1637         return $js;
1638     }
1640     /**
1641      * Add configuration for a specific module.
1642      *
1643      * @param String $name The name of the module to add configuration for.
1644      * @param Array $config The configuration for the specified module.
1645      * @param String $group The name of the group to add configuration for.
1646      * If not specified, then this module is added to the global
1647      * configuration.
1648      * @return void
1649      */
1650     public function add_module_config($name, $config, $group = null) {
1651         if ($group) {
1652             if (!isset($this->groups[$name])) {
1653                 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.');
1654             }
1655             if (!isset($this->groups[$group]['modules'])) {
1656                 $this->groups[$group]['modules'] = array();
1657             }
1658             $modules = &$this->groups[$group]['modules'];
1659         } else {
1660             $modules = &$this->modules;
1661         }
1662         $modules[$name] = $config;
1663     }
1665     /**
1666      * Add the moodle YUI module metadata for the moodle group to the YUI_config instance.
1667      *
1668      * If js caching is disabled, metadata will not be served causing YUI to calculate
1669      * module dependencies as each module is loaded.
1670      *
1671      * If metadata does not exist it will be created and stored in a MUC entry.
1672      *
1673      * @return void
1674      */
1675     public function add_moodle_metadata() {
1676         global $CFG;
1677         if (!isset($this->groups['moodle'])) {
1678             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.');
1679         }
1681         if (!isset($this->groups['moodle']['modules'])) {
1682             $this->groups['moodle']['modules'] = array();
1683         }
1685         $cache = cache::make('core', 'yuimodules');
1686         if (!isset($CFG->jsrev) || $CFG->jsrev == -1) {
1687             $metadata = array();
1688             $metadata = $this->get_moodle_metadata();
1689             $cache->delete('metadata');
1690         } else {
1691             // Attempt to get the metadata from the cache.
1692             if (!$metadata = $cache->get('metadata')) {
1693                 $metadata = $this->get_moodle_metadata();
1694                 $cache->set('metadata', $metadata);
1695             }
1696         }
1698         // Merge with any metadata added specific to this page which was added manually.
1699         $this->groups['moodle']['modules'] = array_merge($this->groups['moodle']['modules'],
1700                 $metadata);
1701     }
1703     /**
1704      * Determine the module metadata for all moodle YUI modules.
1705      *
1706      * This works through all modules capable of serving YUI modules, and attempts to get
1707      * metadata for each of those modules.
1708      *
1709      * @return Array of module metadata
1710      */
1711     private function get_moodle_metadata() {
1712         $moodlemodules = array();
1713         // Core isn't a plugin type or subsystem - handle it seperately.
1714         if ($module = $this->get_moodle_path_metadata(core_component::get_component_directory('core'))) {
1715             $moodlemodules = array_merge($moodlemodules, $module);
1716         }
1718         // Handle other core subsystems.
1719         $subsystems = core_component::get_core_subsystems();
1720         foreach ($subsystems as $subsystem => $path) {
1721             if (is_null($path)) {
1722                 continue;
1723             }
1724             if ($module = $this->get_moodle_path_metadata($path)) {
1725                 $moodlemodules = array_merge($moodlemodules, $module);
1726             }
1727         }
1729         // And finally the plugins.
1730         $plugintypes = core_component::get_plugin_types();
1731         foreach ($plugintypes as $plugintype => $pathroot) {
1732             $pluginlist = core_component::get_plugin_list($plugintype);
1733             foreach ($pluginlist as $plugin => $path) {
1734                 if ($module = $this->get_moodle_path_metadata($path)) {
1735                     $moodlemodules = array_merge($moodlemodules, $module);
1736                 }
1737             }
1738         }
1740         return $moodlemodules;
1741     }
1743     /**
1744      * Helper function process and return the YUI metadata for all of the modules under the specified path.
1745      *
1746      * @param String $path the UNC path to the YUI src directory.
1747      * @return Array the complete array for frankenstyle directory.
1748      */
1749     private function get_moodle_path_metadata($path) {
1750         // Add module metadata is stored in frankenstyle_modname/yui/src/yui_modname/meta/yui_modname.json.
1751         $baseyui = $path . '/yui/src';
1752         $modules = array();
1753         if (is_dir($baseyui)) {
1754             $items = new DirectoryIterator($baseyui);
1755             foreach ($items as $item) {
1756                 if ($item->isDot() or !$item->isDir()) {
1757                     continue;
1758                 }
1759                 $metafile = realpath($baseyui . '/' . $item . '/meta/' . $item . '.json');
1760                 if (!is_readable($metafile)) {
1761                     continue;
1762                 }
1763                 $metadata = file_get_contents($metafile);
1764                 $modules = array_merge($modules, (array) json_decode($metadata));
1765             }
1766         }
1767         return $modules;
1768     }
1771 /**
1772  * Invalidate all server and client side JS caches.
1773  */
1774 function js_reset_all_caches() {
1775     global $CFG;
1777     $next = time();
1778     if (isset($CFG->jsrev) and $next <= $CFG->jsrev and $CFG->jsrev - $next < 60*60) {
1779         // This resolves problems when reset is requested repeatedly within 1s,
1780         // the < 1h condition prevents accidental switching to future dates
1781         // because we might not recover from it.
1782         $next = $CFG->jsrev+1;
1783     }
1785     set_config('jsrev', $next);