212910070871eb032c4a1e45264f64618a289f7f
[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 stdClass 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      * Page requirements constructor.
150      */
151     public function __construct() {
152         global $CFG;
154         // You may need to set up URL rewrite rule because oversized URLs might not be allowed by web server.
155         $sep = empty($CFG->yuislasharguments) ? '?' : '/';
157         $this->yui3loader = new stdClass();
158         $this->YUI_config = new YUI_config();
160         // Set up some loader options.
161         if (!empty($CFG->useexternalyui) and strpos($CFG->httpswwwroot, 'https:') !== 0) {
162             $this->yui3loader->base = 'http://yui.yahooapis.com/' . $CFG->yui3version . '/build/';
163             $this->yui3loader->comboBase = 'http://yui.yahooapis.com/combo?';
164         } else {
165             $this->yui3loader->base = $CFG->httpswwwroot . '/lib/yuilib/'. $CFG->yui3version . '/build/';
166             $this->yui3loader->comboBase = $CFG->httpswwwroot . '/theme/yui_combo.php'.$sep;
167         }
169         // Enable combo loader? This significantly helps with caching and performance!
170         $this->yui3loader->combine = !empty($CFG->yuicomboloading);
172         if (empty($CFG->cachejs)) {
173             $jsrev = -1;
174         } else if (empty($CFG->jsrev)) {
175             $jsrev = 1;
176         } else {
177             $jsrev = $CFG->jsrev;
178         }
180         // Set up JS YUI loader helper object.
181         $this->YUI_config->base         = $this->yui3loader->base;
182         $this->YUI_config->comboBase    = $this->yui3loader->comboBase;
183         $this->YUI_config->combine      = $this->yui3loader->combine;
185         $configname = $this->YUI_config->set_config_function("if(/-skin|reset|fonts|grids|base/.test(me.name)){me.type='css';me.path=me.path.replace(/\.js/,'.css');me.path=me.path.replace(/\/yui2-skin/,'/assets/skins/sam/yui2-skin');}");
186         $this->YUI_config->add_group('yui2', array(
187             // Loader configuration for our 2in3, for now ignores $CFG->useexternalyui.
188             'base' => $CFG->httpswwwroot . '/lib/yuilib/2in3/' . $CFG->yui2version . '/build/',
189             'comboBase' => $CFG->httpswwwroot . '/theme/yui_combo.php'.$sep,
190             'combine' => $this->yui3loader->combine,
191             'ext' => false,
192             'root' => '2in3/' . $CFG->yui2version .'/build/',
193             'patterns' => array(
194                 'yui2-' => array(
195                     'group' => 'yui2',
196                     'configFn' => $configname,
197                 )
198             )
199         ));
200         $configname = $this->YUI_config->set_config_function("var p = me.path, b = me.name.replace(/^moodle-/,'').split('-', 3), n = b.pop();if (/(skin|core)/.test(n)) {n = b.pop();me.type = 'css';};me.path = b.join('-')+'/'+n+'/'+n+'-min.'+me.type;");
201         $this->YUI_config->add_group('moodle', array(
202             'name' => 'moodle',
203             'base' => $CFG->httpswwwroot . '/theme/yui_combo.php'.$sep.'moodle/'.$jsrev.'/',
204             'combine' => $this->yui3loader->combine,
205             'comboBase' => $CFG->httpswwwroot . '/theme/yui_combo.php'.$sep,
206             'ext' => false,
207             'root' => 'moodle/'.$jsrev.'/', // Add the rev to the root path so that we can control caching.
208             'patterns' => array(
209                 'moodle-' => array(
210                     'group' => 'moodle',
211                     'configFn' => $configname,
212                 )
213             )
214         ));
216         // Set some more loader options applying to groups too.
217         if (debugging('', DEBUG_DEVELOPER)) {
218             // When debugging is enabled, we want to load the non-minified (RAW) versions of YUI library modules rather
219             // than the DEBUG versions as these generally generate too much logging for our purposes.
220             // However we do want the DEBUG versions of our Moodle-specific modules.
221             // To debug a YUI-specific issue, change the yui3loader->filter value to DEBUG.
222             $this->YUI_config->filter = 'RAW';
223             $this->YUI_config->groups['moodle']['filter'] = 'DEBUG';
225             // We use the yui3loader->filter setting when writing the YUI3 seed scripts into the header.
226             $this->yui3loader->filter = $this->YUI_config->filter;
227             $this->YUI_config->debug = true;
228         } else {
229             $this->yui3loader->filter = null;
230             $this->YUI_config->debug = false;
231         }
233         // Add the moodle group's module data.
234         $this->YUI_config->add_moodle_metadata();
236         // Every page should include definition of following modules.
237         $this->js_module($this->find_module('core_filepicker'));
238         $this->js_module($this->find_module('core_dock'));
239     }
241     /**
242      * Initialise with the bits of JavaScript that every Moodle page should have.
243      *
244      * @param moodle_page $page
245      * @param core_renderer $renderer
246      */
247     protected function init_requirements_data(moodle_page $page, core_renderer $renderer) {
248         global $CFG;
250         // JavaScript should always work with $CFG->httpswwwroot rather than $CFG->wwwroot.
251         // Otherwise, in some situations, users will get warnings about insecure content
252         // on secure pages from their web browser.
254         $this->M_cfg = array(
255             'wwwroot'             => $CFG->httpswwwroot, // Yes, really. See above.
256             'sesskey'             => sesskey(),
257             'loadingicon'         => $renderer->pix_url('i/loading_small', 'moodle')->out(false),
258             'themerev'            => theme_get_revision(),
259             'slasharguments'      => (int)(!empty($CFG->slasharguments)),
260             'theme'               => $page->theme->name,
261             'jsrev'               => ((empty($CFG->cachejs) or empty($CFG->jsrev)) ? -1 : $CFG->jsrev),
262             'svgicons'            => $page->theme->use_svg_icons()
263         );
264         if (debugging('', DEBUG_DEVELOPER)) {
265             $this->M_cfg['developerdebug'] = true;
266         }
268         // Accessibility stuff.
269         $this->skip_link_to('maincontent', get_string('tocontent', 'access'));
271         // Add strings used on many pages.
272         $this->string_for_js('confirmation', 'admin');
273         $this->string_for_js('cancel', 'moodle');
274         $this->string_for_js('yes', 'moodle');
276         // Alter links in top frame to break out of frames.
277         if ($page->pagelayout === 'frametop') {
278             $this->js_init_call('M.util.init_frametop');
279         }
281         // Include block drag/drop if editing is on
282         if ($page->user_is_editing()) {
283             $params = array(
284                 'courseid' => $page->course->id,
285                 'pagetype' => $page->pagetype,
286                 'pagelayout' => $page->pagelayout,
287                 'subpage' => $page->subpage,
288                 'regions' => $page->blocks->get_regions(),
289                 'contextid' => $page->context->id,
290             );
291             if (!empty($page->cm->id)) {
292                 $params['cmid'] = $page->cm->id;
293             }
294             $page->requires->yui_module('moodle-core-blocks', 'M.core_blocks.init_dragdrop', array($params), null, true);
295         }
296     }
298     /**
299      * Ensure that the specified JavaScript file is linked to from this page.
300      *
301      * NOTE: This function is to be used in RARE CASES ONLY, please store your JS in module.js file
302      * and use $PAGE->requires->js_init_call() instead or use /yui/ subdirectories for YUI modules.
303      *
304      * By default the link is put at the end of the page, since this gives best page-load performance.
305      *
306      * Even if a particular script is requested more than once, it will only be linked
307      * to once.
308      *
309      * @param string|moodle_url $url The path to the .js file, relative to $CFG->dirroot / $CFG->wwwroot.
310      *      For example '/mod/mymod/customscripts.js'; use moodle_url for external scripts
311      * @param bool $inhead initialise in head
312      */
313     public function js($url, $inhead = false) {
314         $url = $this->js_fix_url($url);
315         $where = $inhead ? 'head' : 'footer';
316         $this->jsincludes[$where][$url->out()] = $url;
317     }
319     /**
320      * This method was used to load YUI2 libraries into global scope,
321      * use YUI 2in3 instead. Every YUI2 module is represented as a yui2-*
322      * sandboxed module in YUI3 code via Y.YUI2. property.
323      *
324      * {@see http://tracker.moodle.org/browse/MDL-34741}
325      *
326      * @param string|array $libname
327      * @deprecated since 2.4
328      */
329     public function yui2_lib($libname) {
330         throw new coding_exception('PAGE->yui2_lib() is not available any more, use YUI 2in3 instead, see MDL-34741 for more information.');
331     }
333     /**
334      * Returns the actual url through which a script is served.
335      *
336      * @param moodle_url|string $url full moodle url, or shortened path to script
337      * @return moodle_url
338      */
339     protected function js_fix_url($url) {
340         global $CFG;
342         if ($url instanceof moodle_url) {
343             return $url;
344         } else if (strpos($url, '/') === 0) {
345             // Fix the admin links if needed.
346             if ($CFG->admin !== 'admin') {
347                 if (strpos($url, "/admin/") === 0) {
348                     $url = preg_replace("|^/admin/|", "/$CFG->admin/", $url);
349                 }
350             }
351             if (debugging()) {
352                 // Check file existence only when in debug mode.
353                 if (!file_exists($CFG->dirroot . strtok($url, '?'))) {
354                     throw new coding_exception('Attempt to require a JavaScript file that does not exist.', $url);
355                 }
356             }
357             if (!empty($CFG->cachejs) and !empty($CFG->jsrev) and $CFG->jsrev > 0 and substr($url, -3) === '.js') {
358                 if (empty($CFG->slasharguments)) {
359                     return new moodle_url($CFG->httpswwwroot.'/lib/javascript.php', array('rev'=>$CFG->jsrev, 'jsfile'=>$url));
360                 } else {
361                     $returnurl = new moodle_url($CFG->httpswwwroot.'/lib/javascript.php');
362                     $returnurl->set_slashargument('/'.$CFG->jsrev.$url);
363                     return $returnurl;
364                 }
365             } else {
366                 return new moodle_url($CFG->httpswwwroot.$url);
367             }
368         } else {
369             throw new coding_exception('Invalid JS url, it has to be shortened url starting with / or moodle_url instance.', $url);
370         }
371     }
373     /**
374      * Find out if JS module present and return details.
375      *
376      * @param string $component name of component in frankenstyle, ex: core_group, mod_forum
377      * @return array description of module or null if not found
378      */
379     protected function find_module($component) {
380         global $CFG, $PAGE;
382         $module = null;
384         if (strpos($component, 'core_') === 0) {
385             // Must be some core stuff - list here is not complete, this is just the stuff used from multiple places
386             // so that we do nto have to repeat the definition of these modules over and over again.
387             switch($component) {
388                 case 'core_filepicker':
389                     $module = array('name'     => 'core_filepicker',
390                                     'fullpath' => '/repository/filepicker.js',
391                                     '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'),
392                                     'strings'  => array(array('lastmodified', 'moodle'), array('name', 'moodle'), array('type', 'repository'), array('size', 'repository'),
393                                                         array('invalidjson', 'repository'), array('error', 'moodle'), array('info', 'moodle'),
394                                                         array('nofilesattached', 'repository'), array('filepicker', 'repository'), array('logout', 'repository'),
395                                                         array('nofilesavailable', 'repository'), array('norepositoriesavailable', 'repository'),
396                                                         array('fileexistsdialogheader', 'repository'), array('fileexistsdialog_editor', 'repository'),
397                                                         array('fileexistsdialog_filemanager', 'repository'), array('renameto', 'repository'),
398                                                         array('referencesexist', 'repository')
399                                                     ));
400                     break;
401                 case 'core_comment':
402                     $module = array('name'     => 'core_comment',
403                                     'fullpath' => '/comment/comment.js',
404                                     'requires' => array('base', 'io-base', 'node', 'json', 'yui2-animation', 'overlay'),
405                                     'strings' => array(array('confirmdeletecomments', 'admin'), array('yes', 'moodle'), array('no', 'moodle'))
406                                 );
407                     break;
408                 case 'core_role':
409                     $module = array('name'     => 'core_role',
410                                     'fullpath' => '/admin/roles/module.js',
411                                     'requires' => array('node', 'cookie'));
412                     break;
413                 case 'core_completion':
414                     $module = array('name'     => 'core_completion',
415                                     'fullpath' => '/course/completion.js');
416                     break;
417                 case 'core_dock':
418                     $module = array('name'     => 'core_dock',
419                                     'fullpath' => '/blocks/dock.js',
420                                     'requires' => array('base', 'node', 'event-custom', 'event-mouseenter', 'event-resize'),
421                                     'strings' => array(array('addtodock', 'block'),array('undockitem', 'block'),array('undockblock', 'block'),array('undockall', 'block'),array('thisdirectionvertical', 'langconfig'),array('hidedockpanel', 'block'),array('hidepanel', 'block')));
422                     break;
423                 case 'core_message':
424                     $module = array('name'     => 'core_message',
425                                     'requires' => array('base', 'node', 'event', 'node-event-simulate'),
426                                     'fullpath' => '/message/module.js');
427                     break;
428                 case 'core_group':
429                     $module = array('name'     => 'core_group',
430                                     'fullpath' => '/group/module.js',
431                                     'requires' => array('node', 'overlay', 'event-mouseenter'));
432                     break;
433                 case 'core_question_engine':
434                     $module = array('name'     => 'core_question_engine',
435                                     'fullpath' => '/question/qengine.js',
436                                     'requires' => array('node', 'event'));
437                     break;
438                 case 'core_rating':
439                     $module = array('name'     => 'core_rating',
440                                     'fullpath' => '/rating/module.js',
441                                     'requires' => array('node', 'event', 'overlay', 'io-base', 'json'));
442                     break;
443                 case 'core_dndupload':
444                     $module = array('name'     => 'core_dndupload',
445                                     'fullpath' => '/lib/form/dndupload.js',
446                                     'requires' => array('node', 'event', 'json', 'core_filepicker'),
447                                     'strings'  => array(array('uploadformlimit', 'moodle'), array('droptoupload', 'moodle'), array('maxfilesreached', 'moodle'),
448                                                         array('dndenabled_inbox', 'moodle'), array('fileexists', 'moodle'), array('maxbytesforfile', 'moodle'),
449                                                         array('maxareabytesreached', 'moodle')
450                                                     ));
451                     break;
452             }
454         } else {
455             if ($dir = get_component_directory($component)) {
456                 if (file_exists("$dir/module.js")) {
457                     if (strpos($dir, $CFG->dirroot.'/') === 0) {
458                         $dir = substr($dir, strlen($CFG->dirroot));
459                         $module = array('name'=>$component, 'fullpath'=>"$dir/module.js", 'requires' => array());
460                     }
461                 }
462             }
463         }
465         return $module;
466     }
468     /**
469      * Append YUI3 module to default YUI3 JS loader.
470      * The structure of module array is described at {@link http://developer.yahoo.com/yui/3/yui/}
471      *
472      * @param string|array $module name of module (details are autodetected), or full module specification as array
473      * @return void
474      */
475     public function js_module($module) {
476         global $CFG;
478         if (empty($module)) {
479             throw new coding_exception('Missing YUI3 module name or full description.');
480         }
482         if (is_string($module)) {
483             $module = $this->find_module($module);
484         }
486         if (empty($module) or empty($module['name']) or empty($module['fullpath'])) {
487             throw new coding_exception('Missing YUI3 module details.');
488         }
490         // Don't load this module if we already have, no need to!
491         if ($this->js_module_loaded($module['name'])) {
492             if (debugging('', DEBUG_DEVELOPER)) {
493                 $this->debug_moduleloadstacktraces[$module['name']][] = format_backtrace(debug_backtrace());
494             }
495             return;
496         }
498         $module['fullpath'] = $this->js_fix_url($module['fullpath'])->out(false);
499         // Add all needed strings.
500         if (!empty($module['strings'])) {
501             foreach ($module['strings'] as $string) {
502                 $identifier = $string[0];
503                 $component = isset($string[1]) ? $string[1] : 'moodle';
504                 $a = isset($string[2]) ? $string[2] : null;
505                 $this->string_for_js($identifier, $component, $a);
506             }
507         }
508         unset($module['strings']);
510         // Process module requirements and attempt to load each. This allows
511         // moodle modules to require each other.
512         if (!empty($module['requires'])){
513             foreach ($module['requires'] as $requirement) {
514                 $rmodule = $this->find_module($requirement);
515                 if (is_array($rmodule)) {
516                     $this->js_module($rmodule);
517                 }
518             }
519         }
521         if ($this->headdone) {
522             $this->extramodules[$module['name']] = $module;
523         } else {
524             $this->YUI_config->add_module_config($module['name'], $module);
525         }
526         if (debugging('', DEBUG_DEVELOPER)) {
527             if (!array_key_exists($module['name'], $this->debug_moduleloadstacktraces)) {
528                 $this->debug_moduleloadstacktraces[$module['name']] = array();
529             }
530             $this->debug_moduleloadstacktraces[$module['name']][] = format_backtrace(debug_backtrace());
531         }
532     }
534     /**
535      * Returns true if the module has already been loaded.
536      *
537      * @param string|array $module
538      * @return bool True if the module has already been loaded
539      */
540     protected function js_module_loaded($module) {
541         if (is_string($module)) {
542             $modulename = $module;
543         } else {
544             $modulename = $module['name'];
545         }
546         return array_key_exists($modulename, $this->YUI_config->modules) ||
547                array_key_exists($modulename, $this->extramodules);
548     }
550     /**
551      * Returns the stacktraces from loading js modules.
552      * @return array
553      */
554     public function get_loaded_modules() {
555         return $this->debug_moduleloadstacktraces;
556     }
558     /**
559      * Ensure that the specified CSS file is linked to from this page.
560      *
561      * Because stylesheet links must go in the <head> part of the HTML, you must call
562      * this function before {@link get_head_code()} is called. That normally means before
563      * the call to print_header. If you call it when it is too late, an exception
564      * will be thrown.
565      *
566      * Even if a particular style sheet is requested more than once, it will only
567      * be linked to once.
568      *
569      * Please note use of this feature is strongly discouraged,
570      * it is suitable only for places where CSS is submitted directly by teachers.
571      * (Students must not be allowed to submit any external CSS because it may
572      * contain embedded javascript!). Example of correct use is mod/data.
573      *
574      * @param string $stylesheet The path to the .css file, relative to $CFG->wwwroot.
575      *   For example:
576      *      $PAGE->requires->css('mod/data/css.php?d='.$data->id);
577      */
578     public function css($stylesheet) {
579         global $CFG;
581         if ($this->headdone) {
582             throw new coding_exception('Cannot require a CSS file after &lt;head> has been printed.', $stylesheet);
583         }
585         if ($stylesheet instanceof moodle_url) {
586             // ok
587         } else if (strpos($stylesheet, '/') === 0) {
588             $stylesheet = new moodle_url($CFG->httpswwwroot.$stylesheet);
589         } else {
590             throw new coding_exception('Invalid stylesheet parameter.', $stylesheet);
591         }
593         $this->cssurls[$stylesheet->out()] = $stylesheet;
594     }
596     /**
597      * Add theme stylesheet to page - do not use from plugin code,
598      * this should be called only from the core renderer!
599      *
600      * @param moodle_url $stylesheet
601      * @return void
602      */
603     public function css_theme(moodle_url $stylesheet) {
604         $this->cssthemeurls[] = $stylesheet;
605     }
607     /**
608      * Ensure that a skip link to a given target is printed at the top of the <body>.
609      *
610      * You must call this function before {@link get_top_of_body_code()}, (if not, an exception
611      * will be thrown). That normally means you must call this before the call to print_header.
612      *
613      * If you ask for a particular skip link to be printed, it is then your responsibility
614      * to ensure that the appropriate <a name="..."> tag is printed in the body of the
615      * page, so that the skip link goes somewhere.
616      *
617      * Even if a particular skip link is requested more than once, only one copy of it will be output.
618      *
619      * @param string $target the name of anchor this link should go to. For example 'maincontent'.
620      * @param string $linktext The text to use for the skip link. Normally get_string('skipto', 'access', ...);
621      */
622     public function skip_link_to($target, $linktext) {
623         if ($this->topofbodydone) {
624             debugging('Page header already printed, can not add skip links any more, code needs to be fixed.');
625             return;
626         }
627         $this->skiplinks[$target] = $linktext;
628     }
630     /**
631      * !!!DEPRECATED!!! please use js_init_call() if possible
632      * Ensure that the specified JavaScript function is called from an inline script
633      * somewhere on this page.
634      *
635      * By default the call will be put in a script tag at the
636      * end of the page after initialising Y instance, since this gives best page-load
637      * performance and allows you to use YUI3 library.
638      *
639      * If you request that a particular function is called several times, then
640      * that is what will happen (unlike linking to a CSS or JS file, where only
641      * one link will be output).
642      *
643      * The main benefit of the method is the automatic encoding of all function parameters.
644      *
645      * @deprecated
646      *
647      * @param string $function the name of the JavaScritp function to call. Can
648      *      be a compound name like 'Y.Event.purgeElement'. Can also be
649      *      used to create and object by using a 'function name' like 'new user_selector'.
650      * @param array $arguments and array of arguments to be passed to the function.
651      *      When generating the function call, this will be escaped using json_encode,
652      *      so passing objects and arrays should work.
653      * @param bool $ondomready If tru the function is only called when the dom is
654      *      ready for manipulation.
655      * @param int $delay The delay before the function is called.
656      */
657     public function js_function_call($function, array $arguments = null, $ondomready = false, $delay = 0) {
658         $where = $ondomready ? 'ondomready' : 'normal';
659         $this->jscalls[$where][] = array($function, $arguments, $delay);
660     }
662     /**
663      * Adds a call to make use of a YUI gallery module. DEPRECATED DO NOT USE!!!
664      *
665      * @deprecated DO NOT USE
666      *
667      * @param string|array $modules One or more gallery modules to require
668      * @param string $version
669      * @param string $function
670      * @param array $arguments
671      * @param bool $ondomready
672      */
673     public function js_gallery_module($modules, $version, $function, array $arguments = null, $ondomready = false) {
674         global $CFG;
675         debugging('This function will be removed before 2.0 is released please change it from js_gallery_module to yui_module', DEBUG_DEVELOPER);
676         $this->yui_module($modules, $function, $arguments, $version, $ondomready);
677     }
679     /**
680      * Creates a JavaScript function call that requires one or more modules to be loaded.
681      *
682      * This function can be used to include all of the standard YUI module types within JavaScript:
683      *     - YUI3 modules    [node, event, io]
684      *     - YUI2 modules    [yui2-*]
685      *     - Moodle modules  [moodle-*]
686      *     - Gallery modules [gallery-*]
687      *
688      * @param array|string $modules One or more modules
689      * @param string $function The function to call once modules have been loaded
690      * @param array $arguments An array of arguments to pass to the function
691      * @param string $galleryversion The gallery version to use
692      * @param bool $ondomready
693      */
694     public function yui_module($modules, $function, array $arguments = null, $galleryversion = null, $ondomready = false) {
695         global $CFG;
697         if (!$galleryversion) {
698             $galleryversion = '2010.04.08-12-35';
699         }
701         if (!is_array($modules)) {
702             $modules = array($modules);
703         }
704         if (empty($CFG->useexternalyui)) {
705             // We need to set the M.yui.galleryversion to the correct version
706             $jscode = 'M.yui.galleryversion='.json_encode($galleryversion).';';
707         } else {
708             // Set Y's config.gallery to the version
709             $jscode = 'Y.config.gallery='.json_encode($galleryversion).';';
710         }
711         $jscode .= 'Y.use('.join(',', array_map('json_encode', convert_to_array($modules))).',function() {'.js_writer::function_call($function, $arguments).'});';
712         if ($ondomready) {
713             $jscode = "Y.on('domready', function() { $jscode });";
714         }
715         $this->jsinitcode[] = $jscode;
716     }
718     /**
719      * Ensure that the specified JavaScript function is called from an inline script
720      * from page footer.
721      *
722      * @param string $function the name of the JavaScritp function to with init code,
723      *      usually something like 'M.mod_mymodule.init'
724      * @param array $extraarguments and array of arguments to be passed to the function.
725      *      The first argument is always the YUI3 Y instance with all required dependencies
726      *      already loaded.
727      * @param bool $ondomready wait for dom ready (helps with some IE problems when modifying DOM)
728      * @param array $module JS module specification array
729      */
730     public function js_init_call($function, array $extraarguments = null, $ondomready = false, array $module = null) {
731         $jscode = js_writer::function_call_with_Y($function, $extraarguments);
732         if (!$module) {
733             // Detect module automatically.
734             if (preg_match('/M\.([a-z0-9]+_[^\.]+)/', $function, $matches)) {
735                 $module = $this->find_module($matches[1]);
736             }
737         }
739         $this->js_init_code($jscode, $ondomready, $module);
740     }
742     /**
743      * Add short static javascript code fragment to page footer.
744      * This is intended primarily for loading of js modules and initialising page layout.
745      * Ideally the JS code fragment should be stored in plugin renderer so that themes
746      * may override it.
747      *
748      * @param string $jscode
749      * @param bool $ondomready wait for dom ready (helps with some IE problems when modifying DOM)
750      * @param array $module JS module specification array
751      */
752     public function js_init_code($jscode, $ondomready = false, array $module = null) {
753         $jscode = trim($jscode, " ;\n"). ';';
755         if ($module) {
756             $this->js_module($module);
757             $modulename = $module['name'];
758             $jscode = "Y.use('$modulename', function(Y) { $jscode });";
759         }
761         if ($ondomready) {
762             $jscode = "Y.on('domready', function() { $jscode });";
763         }
765         $this->jsinitcode[] = $jscode;
766     }
768     /**
769      * Make a language string available to JavaScript.
770      *
771      * All the strings will be available in a M.str object in the global namespace.
772      * So, for example, after a call to $PAGE->requires->string_for_js('course', 'moodle');
773      * then the JavaScript variable M.str.moodle.course will be 'Course', or the
774      * equivalent in the current language.
775      *
776      * The arguments to this function are just like the arguments to get_string
777      * except that $component is not optional, and there are some aspects to consider
778      * when the string contains {$a} placeholder.
779      *
780      * If the string does not contain any {$a} placeholder, you can simply use
781      * M.str.component.identifier to obtain it. If you prefer, you can call
782      * M.util.get_string(identifier, component) to get the same result.
783      *
784      * If you need to use {$a} placeholders, there are two options. Either the
785      * placeholder should be substituted in PHP on server side or it should
786      * be substituted in Javascript at client side.
787      *
788      * To substitute the placeholder at server side, just provide the required
789      * value for the placeholder when you require the string. Because each string
790      * is only stored once in the JavaScript (based on $identifier and $module)
791      * you cannot get the same string with two different values of $a. If you try,
792      * an exception will be thrown. Once the placeholder is substituted, you can
793      * use M.str or M.util.get_string() as shown above:
794      *
795      *     // Require the string in PHP and replace the placeholder.
796      *     $PAGE->requires->string_for_js('fullnamedisplay', 'moodle', $USER);
797      *     // Use the result of the substitution in Javascript.
798      *     alert(M.str.moodle.fullnamedisplay);
799      *
800      * To substitute the placeholder at client side, use M.util.get_string()
801      * function. It implements the same logic as {@link get_string()}:
802      *
803      *     // Require the string in PHP but keep {$a} as it is.
804      *     $PAGE->requires->string_for_js('fullnamedisplay', 'moodle');
805      *     // Provide the values on the fly in Javascript.
806      *     user = { firstname : 'Harry', lastname : 'Potter' }
807      *     alert(M.util.get_string('fullnamedisplay', 'moodle', user);
808      *
809      * If you do need the same string expanded with different $a values in PHP
810      * on server side, then the solution is to put them in your own data structure
811      * (e.g. and array) that you pass to JavaScript with {@link data_for_js()}.
812      *
813      * @param string $identifier the desired string.
814      * @param string $component the language file to look in.
815      * @param mixed $a any extra data to add into the string (optional).
816      */
817     public function string_for_js($identifier, $component, $a = null) {
818         if (!$component) {
819             throw new coding_exception('The $component parameter is required for page_requirements_manager::string_for_js().');
820         }
821         if (isset($this->stringsforjs_as[$component][$identifier]) and $this->stringsforjs_as[$component][$identifier] !== $a) {
822             throw new coding_exception("Attempt to re-define already required string '$identifier' " .
823                     "from lang file '$component' with different \$a parameter?");
824         }
825         if (!isset($this->stringsforjs[$component][$identifier])) {
826             $this->stringsforjs[$component][$identifier] = new lang_string($identifier, $component, $a);
827             $this->stringsforjs_as[$component][$identifier] = $a;
828         }
829     }
831     /**
832      * Make an array of language strings available for JS.
833      *
834      * This function calls the above function {@link string_for_js()} for each requested
835      * string in the $identifiers array that is passed to the argument for a single module
836      * passed in $module.
837      *
838      * <code>
839      * $PAGE->requires->strings_for_js(array('one', 'two', 'three'), 'mymod', array('a', null, 3));
840      *
841      * // The above is identical to calling:
842      *
843      * $PAGE->requires->string_for_js('one', 'mymod', 'a');
844      * $PAGE->requires->string_for_js('two', 'mymod');
845      * $PAGE->requires->string_for_js('three', 'mymod', 3);
846      * </code>
847      *
848      * @param array $identifiers An array of desired strings
849      * @param string $component The module to load for
850      * @param mixed $a This can either be a single variable that gets passed as extra
851      *         information for every string or it can be an array of mixed data where the
852      *         key for the data matches that of the identifier it is meant for.
853      *
854      */
855     public function strings_for_js($identifiers, $component, $a = null) {
856         foreach ($identifiers as $key => $identifier) {
857             if (is_array($a) && array_key_exists($key, $a)) {
858                 $extra = $a[$key];
859             } else {
860                 $extra = $a;
861             }
862             $this->string_for_js($identifier, $component, $extra);
863         }
864     }
866     /**
867      * !!!!!!DEPRECATED!!!!!! please use js_init_call() for everything now.
868      *
869      * Make some data from PHP available to JavaScript code.
870      *
871      * For example, if you call
872      * <pre>
873      *      $PAGE->requires->data_for_js('mydata', array('name' => 'Moodle'));
874      * </pre>
875      * then in JavsScript mydata.name will be 'Moodle'.
876      *
877      * @deprecated
878      * @param string $variable the the name of the JavaScript variable to assign the data to.
879      *      Will probably work if you use a compound name like 'mybuttons.button[1]', but this
880      *      should be considered an experimental feature.
881      * @param mixed $data The data to pass to JavaScript. This will be escaped using json_encode,
882      *      so passing objects and arrays should work.
883      * @param bool $inhead initialise in head
884      * @return void
885      */
886     public function data_for_js($variable, $data, $inhead=false) {
887         $where = $inhead ? 'head' : 'footer';
888         $this->jsinitvariables[$where][] = array($variable, $data);
889     }
891     /**
892      * Creates a YUI event handler.
893      *
894      * @param mixed $selector standard YUI selector for elements, may be array or string, element id is in the form "#idvalue"
895      * @param string $event A valid DOM event (click, mousedown, change etc.)
896      * @param string $function The name of the function to call
897      * @param array  $arguments An optional array of argument parameters to pass to the function
898      */
899     public function event_handler($selector, $event, $function, array $arguments = null) {
900         $this->eventhandlers[] = array('selector'=>$selector, 'event'=>$event, 'function'=>$function, 'arguments'=>$arguments);
901     }
903     /**
904      * Returns code needed for registering of event handlers.
905      * @return string JS code
906      */
907     protected function get_event_handler_code() {
908         $output = '';
909         foreach ($this->eventhandlers as $h) {
910             $output .= js_writer::event_handler($h['selector'], $h['event'], $h['function'], $h['arguments']);
911         }
912         return $output;
913     }
915     /**
916      * Get the inline JavaScript code that need to appear in a particular place.
917      * @param bool $ondomready
918      * @return string
919      */
920     protected function get_javascript_code($ondomready) {
921         $where = $ondomready ? 'ondomready' : 'normal';
922         $output = '';
923         if ($this->jscalls[$where]) {
924             foreach ($this->jscalls[$where] as $data) {
925                 $output .= js_writer::function_call($data[0], $data[1], $data[2]);
926             }
927             if (!empty($ondomready)) {
928                 $output = "    Y.on('domready', function() {\n$output\n    });";
929             }
930         }
931         return $output;
932     }
934     /**
935      * Returns js code to be executed when Y is available.
936      * @return string
937      */
938     protected function get_javascript_init_code() {
939         if (count($this->jsinitcode)) {
940             return implode("\n", $this->jsinitcode) . "\n";
941         }
942         return '';
943     }
945     /**
946      * Returns basic YUI3 JS loading code.
947      * YUI3 is using autoloading of both CSS and JS code.
948      *
949      * Major benefit of this compared to standard js/csss loader is much improved
950      * caching, better browser cache utilisation, much fewer http requests.
951      *
952      * @param moodle_page $page
953      * @return string
954      */
955     protected function get_yui3lib_headcode($page) {
956         global $CFG;
958         $code = '';
960         if ($this->yui3loader->combine) {
961             if (!empty($page->theme->yuicssmodules)) {
962                 $modules = array();
963                 foreach ($page->theme->yuicssmodules as $module) {
964                     $modules[] = "$CFG->yui3version/build/$module/$module-min.css";
965                 }
966                 $code .= '<link rel="stylesheet" type="text/css" href="'.$this->yui3loader->comboBase.implode('&amp;', $modules).'" />';
967             }
968             $code .= '<script type="text/javascript" src="'.$this->yui3loader->comboBase
969                      .$CFG->yui3version.'/build/simpleyui/simpleyui-min.js&amp;'
970                      .$CFG->yui3version.'/build/loader/loader-min.js"></script>';
971         } else {
972             if (!empty($page->theme->yuicssmodules)) {
973                 foreach ($page->theme->yuicssmodules as $module) {
974                     $code .= '<link rel="stylesheet" type="text/css" href="'.$this->yui3loader->base.$module.'/'.$module.'-min.css" />';
975                 }
976             }
977             $code .= '<script type="text/javascript" src="'.$this->yui3loader->base.'simpleyui/simpleyui-min.js"></script>';
978             $code .= '<script type="text/javascript" src="'.$this->yui3loader->base.'loader/loader-min.js"></script>';
979         }
982         if ($this->yui3loader->filter === 'RAW') {
983             $code = str_replace('-min.css', '.css', $code);
984             $code = str_replace('-min.js', '.js', $code);
985         } else if ($this->yui3loader->filter === 'DEBUG') {
986             $code = str_replace('-min.css', '.css', $code);
987             $code = str_replace('-min.js', '-debug.js', $code);
988         }
990         return $code;
991     }
993     /**
994      * Returns html tags needed for inclusion of theme CSS.
995      *
996      * @return string
997      */
998     protected function get_css_code() {
999         // First of all the theme CSS, then any custom CSS
1000         // Please note custom CSS is strongly discouraged,
1001         // because it can not be overridden by themes!
1002         // It is suitable only for things like mod/data which accepts CSS from teachers.
1003         $attributes = array('rel'=>'stylesheet', 'type'=>'text/css');
1005         // This line of code may look funny but it is currently required in order
1006         // to avoid MASSIVE display issues in Internet Explorer.
1007         // As of IE8 + YUI3.1.1 the reference stylesheet (firstthemesheet) gets
1008         // ignored whenever another resource is added until such time as a redraw
1009         // is forced, usually by moving the mouse over the affected element.
1010         $code = html_writer::tag('script', '/** Required in order to fix style inclusion problems in IE with YUI **/', array('id'=>'firstthemesheet', 'type'=>'text/css'));
1012         $urls = $this->cssthemeurls + $this->cssurls;
1013         foreach ($urls as $url) {
1014             $attributes['href'] = $url;
1015             $code .= html_writer::empty_tag('link', $attributes) . "\n";
1016             // This id is needed in first sheet only so that theme may override YUI sheets loaded on the fly.
1017             unset($attributes['id']);
1018         }
1020         return $code;
1021     }
1023     /**
1024      * Adds extra modules specified after printing of page header.
1025      *
1026      * @return string
1027      */
1028     protected function get_extra_modules_code() {
1029         if (empty($this->extramodules)) {
1030             return '';
1031         }
1032         return html_writer::script(js_writer::function_call('M.yui.add_module', array($this->extramodules)));
1033     }
1035     /**
1036      * Generate any HTML that needs to go inside the <head> tag.
1037      *
1038      * Normally, this method is called automatically by the code that prints the
1039      * <head> tag. You should not normally need to call it in your own code.
1040      *
1041      * @param moodle_page $page
1042      * @param core_renderer $renderer
1043      * @return string the HTML code to to inside the <head> tag.
1044      */
1045     public function get_head_code(moodle_page $page, core_renderer $renderer) {
1046         global $CFG;
1048         // Note: the $page and $output are not stored here because it would
1049         // create circular references in memory which prevents garbage collection.
1050         $this->init_requirements_data($page, $renderer);
1052         $output = '';
1054         // Set up global YUI3 loader object - this should contain all code needed by plugins.
1055         // Note: in JavaScript just use "YUI().use('overlay', function(Y) { .... });",
1056         //       this needs to be done before including any other script.
1057         $js = "var M = {}; M.yui = {};\n";
1058         $js .= $this->YUI_config->get_config_functions();
1059         $js .= js_writer::set_variable('YUI_config', $this->YUI_config, false) . "\n";
1060         $js .= "M.yui.loader = {modules: {}};\n"; // Backwards compatibility only, not used any more.
1061         $js .= js_writer::set_variable('M.cfg', $this->M_cfg, false);
1063         $js = $this->YUI_config->update_header_js($js);
1064         $output .= html_writer::script($js);
1066         // YUI3 JS and CSS need to be loaded in the header but after the YUI_config has been created.
1067         // They should be cached well by the browser.
1068         $output .= $this->get_yui3lib_headcode($page);
1070         // Now theme CSS + custom CSS in this specific order.
1071         $output .= $this->get_css_code();
1073         // Link our main JS file, all core stuff should be there.
1074         $output .= html_writer::script('', $this->js_fix_url('/lib/javascript-static.js'));
1076         // Add variables.
1077         if ($this->jsinitvariables['head']) {
1078             $js = '';
1079             foreach ($this->jsinitvariables['head'] as $data) {
1080                 list($var, $value) = $data;
1081                 $js .= js_writer::set_variable($var, $value, true);
1082             }
1083             $output .= html_writer::script($js);
1084         }
1086         // All the other linked things from HEAD - there should be as few as possible.
1087         if ($this->jsincludes['head']) {
1088             foreach ($this->jsincludes['head'] as $url) {
1089                 $output .= html_writer::script('', $url);
1090             }
1091         }
1093         // Mark head sending done, it is not possible to anything there.
1094         $this->headdone = true;
1096         return $output;
1097     }
1099     /**
1100      * Generate any HTML that needs to go at the start of the <body> tag.
1101      *
1102      * Normally, this method is called automatically by the code that prints the
1103      * <head> tag. You should not normally need to call it in your own code.
1104      *
1105      * @return string the HTML code to go at the start of the <body> tag.
1106      */
1107     public function get_top_of_body_code() {
1108         // First the skip links.
1109         $links = '';
1110         $attributes = array('class'=>'skip');
1111         foreach ($this->skiplinks as $url => $text) {
1112             $attributes['href'] = '#' . $url;
1113             $links .= html_writer::tag('a', $text, $attributes);
1114         }
1115         $output = html_writer::tag('div', $links, array('class'=>'skiplinks')) . "\n";
1117         // Then the clever trick for hiding of things not needed when JS works.
1118         $output .= html_writer::script("document.body.className += ' jsenabled';") . "\n";
1119         $this->topofbodydone = true;
1120         return $output;
1121     }
1123     /**
1124      * Generate any HTML that needs to go at the end of the page.
1125      *
1126      * Normally, this method is called automatically by the code that prints the
1127      * page footer. You should not normally need to call it in your own code.
1128      *
1129      * @return string the HTML code to to at the end of the page.
1130      */
1131     public function get_end_code() {
1132         global $CFG;
1134         // Add other requested modules.
1135         $output = $this->get_extra_modules_code();
1137         // All the other linked scripts - there should be as few as possible.
1138         if ($this->jsincludes['footer']) {
1139             foreach ($this->jsincludes['footer'] as $url) {
1140                 $output .= html_writer::script('', $url);
1141             }
1142         }
1144         // Add all needed strings.
1145         if (!empty($this->stringsforjs)) {
1146             $strings = array();
1147             foreach ($this->stringsforjs as $component=>$v) {
1148                 foreach($v as $indentifier => $langstring) {
1149                     $strings[$component][$indentifier] = $langstring->out();
1150                 }
1151             }
1152             $output .= html_writer::script(js_writer::set_variable('M.str', $strings));
1153         }
1155         // Add variables.
1156         if ($this->jsinitvariables['footer']) {
1157             $js = '';
1158             foreach ($this->jsinitvariables['footer'] as $data) {
1159                 list($var, $value) = $data;
1160                 $js .= js_writer::set_variable($var, $value, true);
1161             }
1162             $output .= html_writer::script($js);
1163         }
1165         $inyuijs = $this->get_javascript_code(false);
1166         $ondomreadyjs = $this->get_javascript_code(true);
1167         $jsinit = $this->get_javascript_init_code();
1168         $handlersjs = $this->get_event_handler_code();
1170         // There is no global Y, make sure it is available in your scope.
1171         $js = "YUI().use('node', function(Y) {\n{$inyuijs}{$ondomreadyjs}{$jsinit}{$handlersjs}\n});";
1173         $output .= html_writer::script($js);
1175         return $output;
1176     }
1178     /**
1179      * Have we already output the code in the <head> tag?
1180      *
1181      * @return bool
1182      */
1183     public function is_head_done() {
1184         return $this->headdone;
1185     }
1187     /**
1188      * Have we already output the code at the start of the <body> tag?
1189      *
1190      * @return bool
1191      */
1192     public function is_top_of_body_done() {
1193         return $this->topofbodydone;
1194     }
1197 /**
1198  * This class represents the YUI configuration.
1199  *
1200  * @copyright 2013 Andrew Nicols
1201  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1202  * @since Moodle 2.5
1203  * @package core
1204  * @category output
1205  */
1206 class YUI_config {
1207     /**
1208      * These settings must be public so that when the object is converted to json they are exposed.
1209      * Note: Some of these are camelCase because YUI uses camelCase variable names.
1210      *
1211      * The settings are described and documented in the YUI API at:
1212      * - http://yuilibrary.com/yui/docs/api/classes/config.html
1213      * - http://yuilibrary.com/yui/docs/api/classes/Loader.html
1214      */
1215     public $debug = false;
1216     public $base;
1217     public $comboBase;
1218     public $combine;
1219     public $filter = null;
1220     public $insertBefore = 'firstthemesheet';
1221     public $groups = array();
1222     public $modules = array();
1224     /**
1225      * @var array List of functions used by the YUI Loader group pattern recognition.
1226      */
1227     protected $jsconfigfunctions = array();
1229     /**
1230      * Create a new group within the YUI_config system.
1231      *
1232      * @param String $name The name of the group. This must be unique and
1233      * not previously used.
1234      * @param Array $config The configuration for this group.
1235      * @return void
1236      */
1237     public function add_group($name, $config) {
1238         if (isset($this->groups[$name])) {
1239             throw new coding_exception("A YUI configuration group for '{$name}' already exists. To make changes to this group use YUI_config->update_group().");
1240         }
1241         $this->groups[$name] = $config;
1242     }
1244     /**
1245      * Update an existing group configuration
1246      *
1247      * Note, any existing configuration for that group will be wiped out.
1248      * This includes module configuration.
1249      *
1250      * @param String $name The name of the group. This must be unique and
1251      * not previously used.
1252      * @param Array $config The configuration for this group.
1253      * @return void
1254      */
1255     public function update_group($name, $config) {
1256         if (!isset($this->groups[$name])) {
1257             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.');
1258         }
1259         $this->groups[$name] = $config;
1260     }
1262     /**
1263      * Set the value of a configuration function used by the YUI Loader's pattern testing.
1264      *
1265      * Only the body of the function should be passed, and not the whole function wrapper.
1266      *
1267      * The JS function your write will be passed a single argument 'name' containing the
1268      * name of the module being loaded.
1269      *
1270      * @param $function String the body of the JavaScript function. This should be used i
1271      * @return String the name of the function to use in the group pattern configuration.
1272      */
1273     public function set_config_function($function) {
1274         $configname = 'yui' . (count($this->jsconfigfunctions) + 1) . 'ConfigFn';
1275         if (isset($this->jsconfigfunctions[$configname])) {
1276             throw new coding_exception("A YUI config function with this name already exists. Config function names must be unique.");
1277         }
1278         $this->jsconfigfunctions[$configname] = $function;
1279         return '@' . $configname . '@';
1280     }
1282     /**
1283      * Retrieve the list of JavaScript functions for YUI_config groups.
1284      *
1285      * @return String The complete set of config functions
1286      */
1287     public function get_config_functions() {
1288         $configfunctions = '';
1289         foreach ($this->jsconfigfunctions as $functionname => $function) {
1290             $configfunctions .= "var {$functionname} = function(me) {";
1291             $configfunctions .= $function;
1292             $configfunctions .= "};\n";
1293         }
1294         return $configfunctions;
1295     }
1297     /**
1298      * Update the header JavaScript with any required modification for the YUI Loader.
1299      *
1300      * @param $js String The JavaScript to manipulate.
1301      * @return String the modified JS string.
1302      */
1303     public function update_header_js($js) {
1304         // Update the names of the the configFn variables.
1305         // The PHP json_encode function cannot handle literal names so we have to wrap
1306         // them in @ and then replace them with literals of the same function name.
1307         foreach ($this->jsconfigfunctions as $functionname => $function) {
1308             $js = str_replace('"@' . $functionname . '@"', $functionname, $js);
1309         }
1310         return $js;
1311     }
1313     /**
1314      * Add configuration for a specific module.
1315      *
1316      * @param String $name The name of the module to add configuration for.
1317      * @param Array $config The configuration for the specified module.
1318      * @param String $group The name of the group to add configuration for.
1319      * If not specified, then this module is added to the global
1320      * configuration.
1321      * @return void
1322      */
1323     public function add_module_config($name, $config, $group = null) {
1324         if ($group) {
1325             if (!isset($this->groups[$name])) {
1326                 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.');
1327             }
1328             if (!isset($this->groups[$group]['modules'])) {
1329                 $this->groups[$group]['modules'] = array();
1330             }
1331             $modules = &$this->groups[$group]['modules'];
1332         } else {
1333             $modules = &$this->modules;
1334         }
1335         $modules[$name] = $config;
1336     }
1338     /**
1339      * Add the moodle YUI module metadata for the moodle group to the YUI_config instance.
1340      *
1341      * If js caching is disabled, metadata will not be served causing YUI to calculate
1342      * module dependencies as each module is loaded.
1343      *
1344      * If metadata does not exist it will be created and stored in a MUC entry.
1345      *
1346      * @return void
1347      */
1348     public function add_moodle_metadata() {
1349         global $CFG;
1350         if (!isset($this->groups['moodle'])) {
1351             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.');
1352         }
1354         if (!isset($this->groups['moodle']['modules'])) {
1355             $this->groups['moodle']['modules'] = array();
1356         }
1358         $cache = cache::make('core', 'yuimodules');
1359         if ($CFG->jsrev == -1) {
1360             $metadata = array();
1361             $cache->delete('metadata');
1362         } else {
1363             // Attempt to get the metadata from the cache.
1364             if (!$metadata = $cache->get('metadata')) {
1365                 $metadata = $this->get_moodle_metadata();
1366                 $cache->set('metadata', $metadata);
1367             }
1368         }
1370         // Merge with any metadata added specific to this page which was added manually.
1371         $this->groups['moodle']['modules'] = array_merge($this->groups['moodle']['modules'],
1372                 $metadata);
1373     }
1375     /**
1376      * Determine the module metadata for all moodle YUI modules.
1377      *
1378      * This works through all modules capable of serving YUI modules, and attempts to get
1379      * metadata for each of those modules.
1380      *
1381      * @return Array of module metadata
1382      */
1383     private function get_moodle_metadata() {
1384         $moodlemodules = array();
1385         // Core isn't a plugin type or subsystem - handle it seperately.
1386         if ($module = $this->get_moodle_path_metadata(get_component_directory('core'))) {
1387             $moodlemodules = array_merge($moodlemodules, $module);
1388         }
1390         // Handle other core subsystems.
1391         $subsystems = get_core_subsystems();
1392         foreach ($subsystems as $subsystem => $path) {
1393             if (is_null($path)) {
1394                 continue;
1395             }
1396             $path = get_component_directory($subsystem);
1397             if ($module = $this->get_moodle_path_metadata($path)) {
1398                 $moodlemodules = array_merge($moodlemodules, $module);
1399             }
1400         }
1402         // And finally the plugins.
1403         $plugintypes = get_plugin_types();
1404         foreach ($plugintypes as $plugintype => $pathroot) {
1405             $pluginlist = get_plugin_list($plugintype);
1406             foreach ($pluginlist as $plugin => $path) {
1407                 if ($module = $this->get_moodle_path_metadata($path)) {
1408                     $moodlemodules = array_merge($moodlemodules, $module);
1409                 }
1410             }
1411         }
1413         return $moodlemodules;
1414     }
1416     /**
1417      * Helper function process and return the YUI metadata for all of the modules under the specified path.
1418      *
1419      * @param String $path the UNC path to the YUI src directory.
1420      * @return Array the complete array for frankenstyle directory.
1421      */
1422     private function get_moodle_path_metadata($path) {
1423         // Add module metadata is stored in frankenstyle_modname/yui/src/yui_modname/meta/yui_modname.json.
1424         $baseyui = $path . '/yui/src';
1425         $modules = array();
1426         if (is_dir($baseyui)) {
1427             $items = new DirectoryIterator($baseyui);
1428             foreach ($items as $item) {
1429                 if ($item->isDot() or !$item->isDir()) {
1430                     continue;
1431                 }
1432                 $metafile = realpath($baseyui . '/' . $item . '/meta/' . $item . '.json');
1433                 if (!is_readable($metafile)) {
1434                     continue;
1435                 }
1436                 $metadata = file_get_contents($metafile);
1437                 $modules = array_merge($modules, (array) json_decode($metadata));
1438             }
1439         }
1440         return $modules;
1441     }
1444 /**
1445  * Invalidate all server and client side JS caches.
1446  */
1447 function js_reset_all_caches() {
1448     global $CFG;
1449     require_once("$CFG->libdir/filelib.php");
1451     $next = time();
1452     if (isset($CFG->jsrev) and $next <= $CFG->jsrev and $CFG->jsrev - $next < 60*60) {
1453         // This resolves problems when reset is requested repeatedly within 1s,
1454         // the < 1h condition prevents accidental switching to future dates
1455         // because we might not recover from it.
1456         $next = $CFG->jsrev+1;
1457     }
1459     set_config('jsrev', $next);
1460     fulldelete("$CFG->cachedir/js");