7126f1b83c49c485a8e9d1bb3d6113efe210c09b
[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();
159         // Set up some loader options.
160         if (debugging('', DEBUG_DEVELOPER)) {
161             $this->yui3loader->filter = 'RAW'; // For more detailed logging info use 'DEBUG' here.
162         } else {
163             $this->yui3loader->filter = null;
164         }
165         if (!empty($CFG->useexternalyui) and strpos($CFG->httpswwwroot, 'https:') !== 0) {
166             $this->yui3loader->base = 'http://yui.yahooapis.com/' . $CFG->yui3version . '/build/';
167             $this->yui3loader->comboBase = 'http://yui.yahooapis.com/combo?';
168         } else {
169             $this->yui3loader->base = $CFG->httpswwwroot . '/lib/yuilib/'. $CFG->yui3version . '/build/';
170             $this->yui3loader->comboBase = $CFG->httpswwwroot . '/theme/yui_combo.php'.$sep;
171         }
173         // Enable combo loader? This significantly helps with caching and performance!
174         $this->yui3loader->combine = !empty($CFG->yuicomboloading);
176         if (empty($CFG->cachejs)) {
177             $jsrev = -1;
178         } else if (empty($CFG->jsrev)) {
179             $jsrev = 1;
180         } else {
181             $jsrev = $CFG->jsrev;
182         }
184         // Set up JS YUI loader helper object.
185         $this->YUI_config = new stdClass();
186         $this->YUI_config->base         = $this->yui3loader->base;
187         $this->YUI_config->comboBase    = $this->yui3loader->comboBase;
188         $this->YUI_config->combine      = $this->yui3loader->combine;
189         $this->YUI_config->filter       = (string)$this->yui3loader->filter;
190         $this->YUI_config->insertBefore = 'firstthemesheet';
191         $this->YUI_config->modules      = array();
192         $this->YUI_config->groups       = array(
193             // Loader for our YUI modules stored in /yui/ subdirectories of our plugins and subsystems.
194             'moodle' => array(
195                 'name' => 'moodle',
196                 'base' => $CFG->httpswwwroot . '/theme/yui_combo.php'.$sep.'moodle/'.$jsrev.'/',
197                 'comboBase' => $CFG->httpswwwroot . '/theme/yui_combo.php'.$sep,
198                 'combine' => $this->yui3loader->combine,
199                 'filter' => '',
200                 'ext' => false,
201                 'root' => 'moodle/'.$jsrev.'/', // Add the rev to the root path so that we can control caching.
202                 'patterns' => array(
203                     'moodle-' => array(
204                         'group' => 'moodle',
205                         'configFn' => '@MOODLECONFIGFN@'
206                     )
207                 )
208             ),
209             // Gallery modules are not supported much, sorry.
210             'local' => array(
211                 'name' => 'gallery',
212                 'base' => $CFG->httpswwwroot . '/lib/yui/gallery/',
213                 'comboBase' => $CFG->httpswwwroot . '/theme/yui_combo.php'.$sep,
214                 'combine' => $this->yui3loader->combine,
215                 'filter' => $this->YUI_config->filter,
216                 'ext' => false,
217                 'root' => 'gallery/',
218                 'patterns' => array(
219                     'gallery-' => array(
220                         'group' => 'gallery',
221                         'configFn' => '@GALLERYCONFIGFN@',
222                     )
223                 )
224             ),
225             // Loader configuration for our 2in3, for now ignores $CFG->useexternalyui.
226             'yui2' => array(
227                 'base' => $CFG->httpswwwroot . '/lib/yuilib/2in3/' . $CFG->yui2version . '/build/',
228                 'comboBase' => $CFG->httpswwwroot . '/theme/yui_combo.php'.$sep,
229                 'combine' => $this->yui3loader->combine,
230                 'ext' => false,
231                 'root' => '2in3/' . $CFG->yui2version .'/build/',
232                 'patterns' => array(
233                     'yui2-' => array(
234                         'group' => 'yui2',
235                         'configFn' => '@2IN3CONFIGFN@'
236                     )
237                 )
238             )
239         );
241         // Every page should include definition of following modules.
242         $this->js_module($this->find_module('core_filepicker'));
243         $this->js_module($this->find_module('core_dock'));
244     }
246     /**
247      * Initialise with the bits of JavaScript that every Moodle page should have.
248      *
249      * @param moodle_page $page
250      * @param core_renderer $renderer
251      */
252     protected function init_requirements_data(moodle_page $page, core_renderer $renderer) {
253         global $CFG;
255         // JavaScript should always work with $CFG->httpswwwroot rather than $CFG->wwwroot.
256         // Otherwise, in some situations, users will get warnings about insecure content
257         // on secure pages from their web browser.
259         $this->M_cfg = array(
260             'wwwroot'             => $CFG->httpswwwroot, // Yes, really. See above.
261             'sesskey'             => sesskey(),
262             'loadingicon'         => $renderer->pix_url('i/loading_small', 'moodle')->out(false),
263             'themerev'            => theme_get_revision(),
264             'slasharguments'      => (int)(!empty($CFG->slasharguments)),
265             'theme'               => $page->theme->name,
266             'jsrev'               => ((empty($CFG->cachejs) or empty($CFG->jsrev)) ? -1 : $CFG->jsrev),
267             'svgicons'            => $page->theme->use_svg_icons()
268         );
269         if (debugging('', DEBUG_DEVELOPER)) {
270             $this->M_cfg['developerdebug'] = true;
271         }
273         // Accessibility stuff.
274         $this->skip_link_to('maincontent', get_string('tocontent', 'access'));
276         // Add strings used on many pages.
277         $this->string_for_js('confirmation', 'admin');
278         $this->string_for_js('cancel', 'moodle');
279         $this->string_for_js('yes', 'moodle');
281         // Alter links in top frame to break out of frames.
282         if ($page->pagelayout === 'frametop') {
283             $this->js_init_call('M.util.init_frametop');
284         }
285     }
287     /**
288      * Ensure that the specified JavaScript file is linked to from this page.
289      *
290      * NOTE: This function is to be used in RARE CASES ONLY, please store your JS in module.js file
291      * and use $PAGE->requires->js_init_call() instead or use /yui/ subdirectories for YUI modules.
292      *
293      * By default the link is put at the end of the page, since this gives best page-load performance.
294      *
295      * Even if a particular script is requested more than once, it will only be linked
296      * to once.
297      *
298      * @param string|moodle_url $url The path to the .js file, relative to $CFG->dirroot / $CFG->wwwroot.
299      *      For example '/mod/mymod/customscripts.js'; use moodle_url for external scripts
300      * @param bool $inhead initialise in head
301      */
302     public function js($url, $inhead = false) {
303         $url = $this->js_fix_url($url);
304         $where = $inhead ? 'head' : 'footer';
305         $this->jsincludes[$where][$url->out()] = $url;
306     }
308     /**
309      * This method was used to load YUI2 libraries into global scope,
310      * use YUI 2in3 instead. Every YUI2 module is represented as a yui2-*
311      * sandboxed module in YUI3 code via Y.YUI2. property.
312      *
313      * {@see http://tracker.moodle.org/browse/MDL-34741}
314      *
315      * @param string|array $libname
316      * @deprecated since 2.4
317      */
318     public function yui2_lib($libname) {
319         throw new coding_exception('PAGE->yui2_lib() is not available any more, use YUI 2in3 instead, see MDL-34741 for more information.');
320     }
322     /**
323      * Returns the actual url through which a script is served.
324      *
325      * @param moodle_url|string $url full moodle url, or shortened path to script
326      * @return moodle_url
327      */
328     protected function js_fix_url($url) {
329         global $CFG;
331         if ($url instanceof moodle_url) {
332             return $url;
333         } else if (strpos($url, '/') === 0) {
334             // Fix the admin links if needed.
335             if ($CFG->admin !== 'admin') {
336                 if (strpos($url, "/admin/") === 0) {
337                     $url = preg_replace("|^/admin/|", "/$CFG->admin/", $url);
338                 }
339             }
340             if (debugging()) {
341                 // Check file existence only when in debug mode.
342                 if (!file_exists($CFG->dirroot . strtok($url, '?'))) {
343                     throw new coding_exception('Attempt to require a JavaScript file that does not exist.', $url);
344                 }
345             }
346             if (!empty($CFG->cachejs) and !empty($CFG->jsrev) and $CFG->jsrev > 0 and substr($url, -3) === '.js') {
347                 if (empty($CFG->slasharguments)) {
348                     return new moodle_url($CFG->httpswwwroot.'/lib/javascript.php', array('rev'=>$CFG->jsrev, 'jsfile'=>$url));
349                 } else {
350                     $returnurl = new moodle_url($CFG->httpswwwroot.'/lib/javascript.php');
351                     $returnurl->set_slashargument('/'.$CFG->jsrev.$url);
352                     return $returnurl;
353                 }
354             } else {
355                 return new moodle_url($CFG->httpswwwroot.$url);
356             }
357         } else {
358             throw new coding_exception('Invalid JS url, it has to be shortened url starting with / or moodle_url instance.', $url);
359         }
360     }
362     /**
363      * Find out if JS module present and return details.
364      *
365      * @param string $component name of component in frankenstyle, ex: core_group, mod_forum
366      * @return array description of module or null if not found
367      */
368     protected function find_module($component) {
369         global $CFG, $PAGE;
371         $module = null;
373         if (strpos($component, 'core_') === 0) {
374             // Must be some core stuff - list here is not complete, this is just the stuff used from multiple places
375             // so that we do nto have to repeat the definition of these modules over and over again.
376             switch($component) {
377                 case 'core_filepicker':
378                     $module = array('name'     => 'core_filepicker',
379                                     'fullpath' => '/repository/filepicker.js',
380                                     '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', 'moodle-core_filepicker'),
381                                     'strings'  => array(array('lastmodified', 'moodle'), array('name', 'moodle'), array('type', 'repository'), array('size', 'repository'),
382                                                         array('invalidjson', 'repository'), array('error', 'moodle'), array('info', 'moodle'),
383                                                         array('nofilesattached', 'repository'), array('filepicker', 'repository'), array('logout', 'repository'),
384                                                         array('nofilesavailable', 'repository'), array('norepositoriesavailable', 'repository'),
385                                                         array('fileexistsdialogheader', 'repository'), array('fileexistsdialog_editor', 'repository'),
386                                                         array('fileexistsdialog_filemanager', 'repository'), array('renameto', 'repository'),
387                                                         array('referencesexist', 'repository')
388                                                     ));
389                     break;
390                 case 'core_comment':
391                     $module = array('name'     => 'core_comment',
392                                     'fullpath' => '/comment/comment.js',
393                                     'requires' => array('base', 'io-base', 'node', 'json', 'yui2-animation', 'overlay'),
394                                     'strings' => array(array('confirmdeletecomments', 'admin'), array('yes', 'moodle'), array('no', 'moodle'))
395                                 );
396                     break;
397                 case 'core_role':
398                     $module = array('name'     => 'core_role',
399                                     'fullpath' => '/admin/roles/module.js',
400                                     'requires' => array('node', 'cookie'));
401                     break;
402                 case 'core_completion':
403                     $module = array('name'     => 'core_completion',
404                                     'fullpath' => '/course/completion.js');
405                     break;
406                 case 'core_dock':
407                     $module = array('name'     => 'core_dock',
408                                     'fullpath' => '/blocks/dock.js',
409                                     'requires' => array('base', 'node', 'event-custom', 'event-mouseenter', 'event-resize'),
410                                     'strings' => array(array('addtodock', 'block'),array('undockitem', 'block'),array('undockall', 'block'),array('thisdirectionvertical', 'langconfig'),array('hidedockpanel', 'block'),array('hidepanel', 'block')));
411                     break;
412                 case 'core_message':
413                     $module = array('name'     => 'core_message',
414                                     'requires' => array('base', 'node', 'event', 'node-event-simulate'),
415                                     'fullpath' => '/message/module.js');
416                     break;
417                 case 'core_group':
418                     $module = array('name'     => 'core_group',
419                                     'fullpath' => '/group/module.js',
420                                     'requires' => array('node', 'overlay', 'event-mouseenter'));
421                     break;
422                 case 'core_question_engine':
423                     $module = array('name'     => 'core_question_engine',
424                                     'fullpath' => '/question/qengine.js',
425                                     'requires' => array('node', 'event'));
426                     break;
427                 case 'core_rating':
428                     $module = array('name'     => 'core_rating',
429                                     'fullpath' => '/rating/module.js',
430                                     'requires' => array('node', 'event', 'overlay', 'io-base', 'json'));
431                     break;
432                 case 'core_dndupload':
433                     $module = array('name'     => 'core_dndupload',
434                                     'fullpath' => '/lib/form/dndupload.js',
435                                     'requires' => array('node', 'event', 'json', 'core_filepicker'),
436                                     'strings'  => array(array('uploadformlimit', 'moodle'), array('droptoupload', 'moodle'), array('maxfilesreached', 'moodle'),
437                                                         array('dndenabled_inbox', 'moodle'), array('fileexists', 'moodle'), array('maxbytesforfile', 'moodle'),
438                                                         array('maxareabytesreached', 'moodle')
439                                                     ));
440                     break;
441             }
443         } else {
444             if ($dir = get_component_directory($component)) {
445                 if (file_exists("$dir/module.js")) {
446                     if (strpos($dir, $CFG->dirroot.'/') === 0) {
447                         $dir = substr($dir, strlen($CFG->dirroot));
448                         $module = array('name'=>$component, 'fullpath'=>"$dir/module.js", 'requires' => array());
449                     }
450                 }
451             }
452         }
454         return $module;
455     }
457     /**
458      * Append YUI3 module to default YUI3 JS loader.
459      * The structure of module array is described at {@link http://developer.yahoo.com/yui/3/yui/}
460      *
461      * @param string|array $module name of module (details are autodetected), or full module specification as array
462      * @return void
463      */
464     public function js_module($module) {
465         global $CFG;
467         if (empty($module)) {
468             throw new coding_exception('Missing YUI3 module name or full description.');
469         }
471         if (is_string($module)) {
472             $module = $this->find_module($module);
473         }
475         if (empty($module) or empty($module['name']) or empty($module['fullpath'])) {
476             throw new coding_exception('Missing YUI3 module details.');
477         }
479         // Don't load this module if we already have, no need to!
480         if ($this->js_module_loaded($module['name'])) {
481             if (debugging('', DEBUG_DEVELOPER)) {
482                 $this->debug_moduleloadstacktraces[$module['name']][] = format_backtrace(debug_backtrace());
483             }
484             return;
485         }
487         $module['fullpath'] = $this->js_fix_url($module['fullpath'])->out(false);
488         // Add all needed strings.
489         if (!empty($module['strings'])) {
490             foreach ($module['strings'] as $string) {
491                 $identifier = $string[0];
492                 $component = isset($string[1]) ? $string[1] : 'moodle';
493                 $a = isset($string[2]) ? $string[2] : null;
494                 $this->string_for_js($identifier, $component, $a);
495             }
496         }
497         unset($module['strings']);
499         // Process module requirements and attempt to load each. This allows
500         // moodle modules to require each other.
501         if (!empty($module['requires'])){
502             foreach ($module['requires'] as $requirement) {
503                 $rmodule = $this->find_module($requirement);
504                 if (is_array($rmodule)) {
505                     $this->js_module($rmodule);
506                 }
507             }
508         }
510         if ($this->headdone) {
511             $this->extramodules[$module['name']] = $module;
512         } else {
513             $this->YUI_config->modules[$module['name']] = $module;
514         }
515         if (debugging('', DEBUG_DEVELOPER)) {
516             if (!array_key_exists($module['name'], $this->debug_moduleloadstacktraces)) {
517                 $this->debug_moduleloadstacktraces[$module['name']] = array();
518             }
519             $this->debug_moduleloadstacktraces[$module['name']][] = format_backtrace(debug_backtrace());
520         }
521     }
523     /**
524      * Returns true if the module has already been loaded.
525      *
526      * @param string|array $module
527      * @return bool True if the module has already been loaded
528      */
529     protected function js_module_loaded($module) {
530         if (is_string($module)) {
531             $modulename = $module;
532         } else {
533             $modulename = $module['name'];
534         }
535         return array_key_exists($modulename, $this->YUI_config->modules) ||
536                array_key_exists($modulename, $this->extramodules);
537     }
539     /**
540      * Returns the stacktraces from loading js modules.
541      * @return array
542      */
543     public function get_loaded_modules() {
544         return $this->debug_moduleloadstacktraces;
545     }
547     /**
548      * Ensure that the specified CSS file is linked to from this page.
549      *
550      * Because stylesheet links must go in the <head> part of the HTML, you must call
551      * this function before {@link get_head_code()} is called. That normally means before
552      * the call to print_header. If you call it when it is too late, an exception
553      * will be thrown.
554      *
555      * Even if a particular style sheet is requested more than once, it will only
556      * be linked to once.
557      *
558      * Please note use of this feature is strongly discouraged,
559      * it is suitable only for places where CSS is submitted directly by teachers.
560      * (Students must not be allowed to submit any external CSS because it may
561      * contain embedded javascript!). Example of correct use is mod/data.
562      *
563      * @param string $stylesheet The path to the .css file, relative to $CFG->wwwroot.
564      *   For example:
565      *      $PAGE->requires->css('mod/data/css.php?d='.$data->id);
566      */
567     public function css($stylesheet) {
568         global $CFG;
570         if ($this->headdone) {
571             throw new coding_exception('Cannot require a CSS file after &lt;head> has been printed.', $stylesheet);
572         }
574         if ($stylesheet instanceof moodle_url) {
575             // ok
576         } else if (strpos($stylesheet, '/') === 0) {
577             $stylesheet = new moodle_url($CFG->httpswwwroot.$stylesheet);
578         } else {
579             throw new coding_exception('Invalid stylesheet parameter.', $stylesheet);
580         }
582         $this->cssurls[$stylesheet->out()] = $stylesheet;
583     }
585     /**
586      * Add theme stylesheet to page - do not use from plugin code,
587      * this should be called only from the core renderer!
588      *
589      * @param moodle_url $stylesheet
590      * @return void
591      */
592     public function css_theme(moodle_url $stylesheet) {
593         $this->cssthemeurls[] = $stylesheet;
594     }
596     /**
597      * Ensure that a skip link to a given target is printed at the top of the <body>.
598      *
599      * You must call this function before {@link get_top_of_body_code()}, (if not, an exception
600      * will be thrown). That normally means you must call this before the call to print_header.
601      *
602      * If you ask for a particular skip link to be printed, it is then your responsibility
603      * to ensure that the appropriate <a name="..."> tag is printed in the body of the
604      * page, so that the skip link goes somewhere.
605      *
606      * Even if a particular skip link is requested more than once, only one copy of it will be output.
607      *
608      * @param string $target the name of anchor this link should go to. For example 'maincontent'.
609      * @param string $linktext The text to use for the skip link. Normally get_string('skipto', 'access', ...);
610      */
611     public function skip_link_to($target, $linktext) {
612         if ($this->topofbodydone) {
613             debugging('Page header already printed, can not add skip links any more, code needs to be fixed.');
614             return;
615         }
616         $this->skiplinks[$target] = $linktext;
617     }
619     /**
620      * !!!DEPRECATED!!! please use js_init_call() if possible
621      * Ensure that the specified JavaScript function is called from an inline script
622      * somewhere on this page.
623      *
624      * By default the call will be put in a script tag at the
625      * end of the page after initialising Y instance, since this gives best page-load
626      * performance and allows you to use YUI3 library.
627      *
628      * If you request that a particular function is called several times, then
629      * that is what will happen (unlike linking to a CSS or JS file, where only
630      * one link will be output).
631      *
632      * The main benefit of the method is the automatic encoding of all function parameters.
633      *
634      * @deprecated
635      *
636      * @param string $function the name of the JavaScritp function to call. Can
637      *      be a compound name like 'Y.Event.purgeElement'. Can also be
638      *      used to create and object by using a 'function name' like 'new user_selector'.
639      * @param array $arguments and array of arguments to be passed to the function.
640      *      When generating the function call, this will be escaped using json_encode,
641      *      so passing objects and arrays should work.
642      * @param bool $ondomready If tru the function is only called when the dom is
643      *      ready for manipulation.
644      * @param int $delay The delay before the function is called.
645      */
646     public function js_function_call($function, array $arguments = null, $ondomready = false, $delay = 0) {
647         $where = $ondomready ? 'ondomready' : 'normal';
648         $this->jscalls[$where][] = array($function, $arguments, $delay);
649     }
651     /**
652      * Adds a call to make use of a YUI gallery module. DEPRECATED DO NOT USE!!!
653      *
654      * @deprecated DO NOT USE
655      *
656      * @param string|array $modules One or more gallery modules to require
657      * @param string $version
658      * @param string $function
659      * @param array $arguments
660      * @param bool $ondomready
661      */
662     public function js_gallery_module($modules, $version, $function, array $arguments = null, $ondomready = false) {
663         global $CFG;
664         debugging('This function will be removed before 2.0 is released please change it from js_gallery_module to yui_module', DEBUG_DEVELOPER);
665         $this->yui_module($modules, $function, $arguments, $version, $ondomready);
666     }
668     /**
669      * Creates a JavaScript function call that requires one or more modules to be loaded.
670      *
671      * This function can be used to include all of the standard YUI module types within JavaScript:
672      *     - YUI3 modules    [node, event, io]
673      *     - YUI2 modules    [yui2-*]
674      *     - Moodle modules  [moodle-*]
675      *     - Gallery modules [gallery-*]
676      *
677      * @param array|string $modules One or more modules
678      * @param string $function The function to call once modules have been loaded
679      * @param array $arguments An array of arguments to pass to the function
680      * @param string $galleryversion The gallery version to use
681      * @param bool $ondomready
682      */
683     public function yui_module($modules, $function, array $arguments = null, $galleryversion = null, $ondomready = false) {
684         global $CFG;
686         if (!$galleryversion) {
687             $galleryversion = '2010.04.08-12-35';
688         }
690         if (!is_array($modules)) {
691             $modules = array($modules);
692         }
693         if (empty($CFG->useexternalyui)) {
694             // We need to set the M.yui.galleryversion to the correct version
695             $jscode = 'M.yui.galleryversion='.json_encode($galleryversion).';';
696         } else {
697             // Set Y's config.gallery to the version
698             $jscode = 'Y.config.gallery='.json_encode($galleryversion).';';
699         }
700         $jscode .= 'Y.use('.join(',', array_map('json_encode', convert_to_array($modules))).',function() {'.js_writer::function_call($function, $arguments).'});';
701         if ($ondomready) {
702             $jscode = "Y.on('domready', function() { $jscode });";
703         }
704         $this->jsinitcode[] = $jscode;
705     }
707     /**
708      * Ensure that the specified JavaScript function is called from an inline script
709      * from page footer.
710      *
711      * @param string $function the name of the JavaScritp function to with init code,
712      *      usually something like 'M.mod_mymodule.init'
713      * @param array $extraarguments and array of arguments to be passed to the function.
714      *      The first argument is always the YUI3 Y instance with all required dependencies
715      *      already loaded.
716      * @param bool $ondomready wait for dom ready (helps with some IE problems when modifying DOM)
717      * @param array $module JS module specification array
718      */
719     public function js_init_call($function, array $extraarguments = null, $ondomready = false, array $module = null) {
720         $jscode = js_writer::function_call_with_Y($function, $extraarguments);
721         if (!$module) {
722             // Detect module automatically.
723             if (preg_match('/M\.([a-z0-9]+_[^\.]+)/', $function, $matches)) {
724                 $module = $this->find_module($matches[1]);
725             }
726         }
728         $this->js_init_code($jscode, $ondomready, $module);
729     }
731     /**
732      * Add short static javascript code fragment to page footer.
733      * This is intended primarily for loading of js modules and initialising page layout.
734      * Ideally the JS code fragment should be stored in plugin renderer so that themes
735      * may override it.
736      *
737      * @param string $jscode
738      * @param bool $ondomready wait for dom ready (helps with some IE problems when modifying DOM)
739      * @param array $module JS module specification array
740      */
741     public function js_init_code($jscode, $ondomready = false, array $module = null) {
742         $jscode = trim($jscode, " ;\n"). ';';
744         if ($module) {
745             $this->js_module($module);
746             $modulename = $module['name'];
747             $jscode = "Y.use('$modulename', function(Y) { $jscode });";
748         }
750         if ($ondomready) {
751             $jscode = "Y.on('domready', function() { $jscode });";
752         }
754         $this->jsinitcode[] = $jscode;
755     }
757     /**
758      * Make a language string available to JavaScript.
759      *
760      * All the strings will be available in a M.str object in the global namespace.
761      * So, for example, after a call to $PAGE->requires->string_for_js('course', 'moodle');
762      * then the JavaScript variable M.str.moodle.course will be 'Course', or the
763      * equivalent in the current language.
764      *
765      * The arguments to this function are just like the arguments to get_string
766      * except that $component is not optional, and there are some aspects to consider
767      * when the string contains {$a} placeholder.
768      *
769      * If the string does not contain any {$a} placeholder, you can simply use
770      * M.str.component.identifier to obtain it. If you prefer, you can call
771      * M.util.get_string(identifier, component) to get the same result.
772      *
773      * If you need to use {$a} placeholders, there are two options. Either the
774      * placeholder should be substituted in PHP on server side or it should
775      * be substituted in Javascript at client side.
776      *
777      * To substitute the placeholder at server side, just provide the required
778      * value for the placeholder when you require the string. Because each string
779      * is only stored once in the JavaScript (based on $identifier and $module)
780      * you cannot get the same string with two different values of $a. If you try,
781      * an exception will be thrown. Once the placeholder is substituted, you can
782      * use M.str or M.util.get_string() as shown above:
783      *
784      *     // Require the string in PHP and replace the placeholder.
785      *     $PAGE->requires->string_for_js('fullnamedisplay', 'moodle', $USER);
786      *     // Use the result of the substitution in Javascript.
787      *     alert(M.str.moodle.fullnamedisplay);
788      *
789      * To substitute the placeholder at client side, use M.util.get_string()
790      * function. It implements the same logic as {@link get_string()}:
791      *
792      *     // Require the string in PHP but keep {$a} as it is.
793      *     $PAGE->requires->string_for_js('fullnamedisplay', 'moodle');
794      *     // Provide the values on the fly in Javascript.
795      *     user = { firstname : 'Harry', lastname : 'Potter' }
796      *     alert(M.util.get_string('fullnamedisplay', 'moodle', user);
797      *
798      * If you do need the same string expanded with different $a values in PHP
799      * on server side, then the solution is to put them in your own data structure
800      * (e.g. and array) that you pass to JavaScript with {@link data_for_js()}.
801      *
802      * @param string $identifier the desired string.
803      * @param string $component the language file to look in.
804      * @param mixed $a any extra data to add into the string (optional).
805      */
806     public function string_for_js($identifier, $component, $a = null) {
807         if (!$component) {
808             throw new coding_exception('The $component parameter is required for page_requirements_manager::string_for_js().');
809         }
810         if (isset($this->stringsforjs_as[$component][$identifier]) and $this->stringsforjs_as[$component][$identifier] !== $a) {
811             throw new coding_exception("Attempt to re-define already required string '$identifier' " .
812                     "from lang file '$component' with different \$a parameter?");
813         }
814         if (!isset($this->stringsforjs[$component][$identifier])) {
815             $this->stringsforjs[$component][$identifier] = new lang_string($identifier, $component, $a);
816             $this->stringsforjs_as[$component][$identifier] = $a;
817         }
818     }
820     /**
821      * Make an array of language strings available for JS.
822      *
823      * This function calls the above function {@link string_for_js()} for each requested
824      * string in the $identifiers array that is passed to the argument for a single module
825      * passed in $module.
826      *
827      * <code>
828      * $PAGE->requires->strings_for_js(array('one', 'two', 'three'), 'mymod', array('a', null, 3));
829      *
830      * // The above is identical to calling:
831      *
832      * $PAGE->requires->string_for_js('one', 'mymod', 'a');
833      * $PAGE->requires->string_for_js('two', 'mymod');
834      * $PAGE->requires->string_for_js('three', 'mymod', 3);
835      * </code>
836      *
837      * @param array $identifiers An array of desired strings
838      * @param string $component The module to load for
839      * @param mixed $a This can either be a single variable that gets passed as extra
840      *         information for every string or it can be an array of mixed data where the
841      *         key for the data matches that of the identifier it is meant for.
842      *
843      */
844     public function strings_for_js($identifiers, $component, $a = null) {
845         foreach ($identifiers as $key => $identifier) {
846             if (is_array($a) && array_key_exists($key, $a)) {
847                 $extra = $a[$key];
848             } else {
849                 $extra = $a;
850             }
851             $this->string_for_js($identifier, $component, $extra);
852         }
853     }
855     /**
856      * !!!!!!DEPRECATED!!!!!! please use js_init_call() for everything now.
857      *
858      * Make some data from PHP available to JavaScript code.
859      *
860      * For example, if you call
861      * <pre>
862      *      $PAGE->requires->data_for_js('mydata', array('name' => 'Moodle'));
863      * </pre>
864      * then in JavsScript mydata.name will be 'Moodle'.
865      *
866      * @deprecated
867      * @param string $variable the the name of the JavaScript variable to assign the data to.
868      *      Will probably work if you use a compound name like 'mybuttons.button[1]', but this
869      *      should be considered an experimental feature.
870      * @param mixed $data The data to pass to JavaScript. This will be escaped using json_encode,
871      *      so passing objects and arrays should work.
872      * @param bool $inhead initialise in head
873      * @return void
874      */
875     public function data_for_js($variable, $data, $inhead=false) {
876         $where = $inhead ? 'head' : 'footer';
877         $this->jsinitvariables[$where][] = array($variable, $data);
878     }
880     /**
881      * Creates a YUI event handler.
882      *
883      * @param mixed $selector standard YUI selector for elements, may be array or string, element id is in the form "#idvalue"
884      * @param string $event A valid DOM event (click, mousedown, change etc.)
885      * @param string $function The name of the function to call
886      * @param array  $arguments An optional array of argument parameters to pass to the function
887      */
888     public function event_handler($selector, $event, $function, array $arguments = null) {
889         $this->eventhandlers[] = array('selector'=>$selector, 'event'=>$event, 'function'=>$function, 'arguments'=>$arguments);
890     }
892     /**
893      * Returns code needed for registering of event handlers.
894      * @return string JS code
895      */
896     protected function get_event_handler_code() {
897         $output = '';
898         foreach ($this->eventhandlers as $h) {
899             $output .= js_writer::event_handler($h['selector'], $h['event'], $h['function'], $h['arguments']);
900         }
901         return $output;
902     }
904     /**
905      * Get the inline JavaScript code that need to appear in a particular place.
906      * @param bool $ondomready
907      * @return string
908      */
909     protected function get_javascript_code($ondomready) {
910         $where = $ondomready ? 'ondomready' : 'normal';
911         $output = '';
912         if ($this->jscalls[$where]) {
913             foreach ($this->jscalls[$where] as $data) {
914                 $output .= js_writer::function_call($data[0], $data[1], $data[2]);
915             }
916             if (!empty($ondomready)) {
917                 $output = "    Y.on('domready', function() {\n$output\n    });";
918             }
919         }
920         return $output;
921     }
923     /**
924      * Returns js code to be executed when Y is available.
925      * @return string
926      */
927     protected function get_javascript_init_code() {
928         if (count($this->jsinitcode)) {
929             return implode("\n", $this->jsinitcode) . "\n";
930         }
931         return '';
932     }
934     /**
935      * Returns basic YUI3 JS loading code.
936      * YUI3 is using autoloading of both CSS and JS code.
937      *
938      * Major benefit of this compared to standard js/csss loader is much improved
939      * caching, better browser cache utilisation, much fewer http requests.
940      *
941      * @return string
942      */
943     protected function get_yui3lib_headcode() {
944         global $CFG;
946         $code = '';
948         if ($this->yui3loader->combine) {
949             $code .= '<link rel="stylesheet" type="text/css" href="'.$this->yui3loader->comboBase
950                      .$CFG->yui3version.'/build/cssreset/reset-min.css&amp;'
951                      .$CFG->yui3version.'/build/cssfonts/fonts-min.css&amp;'
952                      .$CFG->yui3version.'/build/cssgrids/grids-min.css&amp;'
953                      .$CFG->yui3version.'/build/cssbase/base-min.css" />';
954             $code .= '<script type="text/javascript" src="'.$this->yui3loader->comboBase
955                      .$CFG->yui3version.'/build/simpleyui/simpleyui-min.js&amp;'
956                      .$CFG->yui3version.'/build/loader/loader-min.js"></script>';
957         } else {
958             $code .= '<link rel="stylesheet" type="text/css" href="'.$this->yui3loader->base.'cssreset/reset-min.css" />';
959             $code .= '<link rel="stylesheet" type="text/css" href="'.$this->yui3loader->base.'cssfonts/fonts-min.css" />';
960             $code .= '<link rel="stylesheet" type="text/css" href="'.$this->yui3loader->base.'cssgrids/grids-min.css" />';
961             $code .= '<link rel="stylesheet" type="text/css" href="'.$this->yui3loader->base.'cssbase/base-min.css" />';
962             $code .= '<script type="text/javascript" src="'.$this->yui3loader->base.'simpleyui/simpleyui-min.js"></script>';
963             $code .= '<script type="text/javascript" src="'.$this->yui3loader->base.'loader/loader-min.js"></script>';
964         }
967         if ($this->yui3loader->filter === 'RAW') {
968             $code = str_replace('-min.css', '.css', $code);
969             $code = str_replace('-min.js', '.js', $code);
970         } else if ($this->yui3loader->filter === 'DEBUG') {
971             $code = str_replace('-min.css', '.css', $code);
972             $code = str_replace('-min.js', '-debug.js', $code);
973         }
975         return $code;
976     }
978     /**
979      * Returns html tags needed for inclusion of theme CSS.
980      *
981      * @return string
982      */
983     protected function get_css_code() {
984         // First of all the theme CSS, then any custom CSS
985         // Please note custom CSS is strongly discouraged,
986         // because it can not be overridden by themes!
987         // It is suitable only for things like mod/data which accepts CSS from teachers.
988         $attributes = array('rel'=>'stylesheet', 'type'=>'text/css');
990         // This line of code may look funny but it is currently required in order
991         // to avoid MASSIVE display issues in Internet Explorer.
992         // As of IE8 + YUI3.1.1 the reference stylesheet (firstthemesheet) gets
993         // ignored whenever another resource is added until such time as a redraw
994         // is forced, usually by moving the mouse over the affected element.
995         $code = html_writer::tag('script', '/** Required in order to fix style inclusion problems in IE with YUI **/', array('id'=>'firstthemesheet', 'type'=>'text/css'));
997         $urls = $this->cssthemeurls + $this->cssurls;
998         foreach ($urls as $url) {
999             $attributes['href'] = $url;
1000             $code .= html_writer::empty_tag('link', $attributes) . "\n";
1001             // This id is needed in first sheet only so that theme may override YUI sheets loaded on the fly.
1002             unset($attributes['id']);
1003         }
1005         return $code;
1006     }
1008     /**
1009      * Adds extra modules specified after printing of page header.
1010      *
1011      * @return string
1012      */
1013     protected function get_extra_modules_code() {
1014         if (empty($this->extramodules)) {
1015             return '';
1016         }
1017         return html_writer::script(js_writer::function_call('M.yui.add_module', array($this->extramodules)));
1018     }
1020     /**
1021      * Generate any HTML that needs to go inside the <head> tag.
1022      *
1023      * Normally, this method is called automatically by the code that prints the
1024      * <head> tag. You should not normally need to call it in your own code.
1025      *
1026      * @param moodle_page $page
1027      * @param core_renderer $renderer
1028      * @return string the HTML code to to inside the <head> tag.
1029      */
1030     public function get_head_code(moodle_page $page, core_renderer $renderer) {
1031         global $CFG;
1033         // Note: the $page and $output are not stored here because it would
1034         // create circular references in memory which prevents garbage collection.
1035         $this->init_requirements_data($page, $renderer);
1037         // YUI3 JS and CSS is always loaded first - it is cached in browser.
1038         $output = $this->get_yui3lib_headcode();
1040         // Now theme CSS + custom CSS in this specific order.
1041         $output .= $this->get_css_code();
1043         // Set up global YUI3 loader object - this should contain all code needed by plugins.
1044         // Note: in JavaScript just use "YUI().use('overlay', function(Y) { .... });",
1045         //       this needs to be done before including any other script.
1046         $js = "var M = {}; M.yui = {};
1047 var moodleConfigFn = function(me) {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+'.'+me.type;};
1048 var galleryConfigFn = function(me) {var p = me.path,v=M.yui.galleryversion,f;if(/-(skin|core)/.test(me.name)) {me.type = 'css';p = p.replace(/-(skin|core)/, '').replace(/\.js/, '.css').split('/'), f = p.pop().replace(/(\-(min|debug))/, '');if (/-skin/.test(me.name)) {p.splice(p.length,0,v,'assets','skins','sam', f);} else {p.splice(p.length,0,v,'assets', f);};} else {p = p.split('/'), f = p.pop();p.splice(p.length,0,v, f);};me.path = p.join('/');};
1049 var yui2in3ConfigFn = function(me) {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');}};\n";
1050         $js .= js_writer::set_variable('YUI_config', $this->YUI_config, false) . "\n";
1051         $js .= "M.yui.loader = {modules: {}};\n"; // Backwards compatibility only, not used any more.
1052         $js .= js_writer::set_variable('M.cfg', $this->M_cfg, false);
1053         $js = str_replace('"@GALLERYCONFIGFN@"', 'galleryConfigFn', $js);
1054         $js = str_replace('"@MOODLECONFIGFN@"', 'moodleConfigFn', $js);
1055         $js = str_replace('"@2IN3CONFIGFN@"', 'yui2in3ConfigFn', $js);
1057         $output .= html_writer::script($js);
1059         // Link our main JS file, all core stuff should be there.
1060         $output .= html_writer::script('', $this->js_fix_url('/lib/javascript-static.js'));
1062         // Add variables.
1063         if ($this->jsinitvariables['head']) {
1064             $js = '';
1065             foreach ($this->jsinitvariables['head'] as $data) {
1066                 list($var, $value) = $data;
1067                 $js .= js_writer::set_variable($var, $value, true);
1068             }
1069             $output .= html_writer::script($js);
1070         }
1072         // All the other linked things from HEAD - there should be as few as possible.
1073         if ($this->jsincludes['head']) {
1074             foreach ($this->jsincludes['head'] as $url) {
1075                 $output .= html_writer::script('', $url);
1076             }
1077         }
1079         // Mark head sending done, it is not possible to anything there.
1080         $this->headdone = true;
1082         return $output;
1083     }
1085     /**
1086      * Generate any HTML that needs to go at the start of the <body> tag.
1087      *
1088      * Normally, this method is called automatically by the code that prints the
1089      * <head> tag. You should not normally need to call it in your own code.
1090      *
1091      * @return string the HTML code to go at the start of the <body> tag.
1092      */
1093     public function get_top_of_body_code() {
1094         // First the skip links.
1095         $links = '';
1096         $attributes = array('class'=>'skip');
1097         foreach ($this->skiplinks as $url => $text) {
1098             $attributes['href'] = '#' . $url;
1099             $links .= html_writer::tag('a', $text, $attributes);
1100         }
1101         $output = html_writer::tag('div', $links, array('class'=>'skiplinks')) . "\n";
1103         // Then the clever trick for hiding of things not needed when JS works.
1104         $output .= html_writer::script("document.body.className += ' jsenabled';") . "\n";
1105         $this->topofbodydone = true;
1106         return $output;
1107     }
1109     /**
1110      * Generate any HTML that needs to go at the end of the page.
1111      *
1112      * Normally, this method is called automatically by the code that prints the
1113      * page footer. You should not normally need to call it in your own code.
1114      *
1115      * @return string the HTML code to to at the end of the page.
1116      */
1117     public function get_end_code() {
1118         global $CFG;
1120         // Add other requested modules.
1121         $output = $this->get_extra_modules_code();
1123         // All the other linked scripts - there should be as few as possible.
1124         if ($this->jsincludes['footer']) {
1125             foreach ($this->jsincludes['footer'] as $url) {
1126                 $output .= html_writer::script('', $url);
1127             }
1128         }
1130         // Add all needed strings.
1131         if (!empty($this->stringsforjs)) {
1132             $strings = array();
1133             foreach ($this->stringsforjs as $component=>$v) {
1134                 foreach($v as $indentifier => $langstring) {
1135                     $strings[$component][$indentifier] = $langstring->out();
1136                 }
1137             }
1138             $output .= html_writer::script(js_writer::set_variable('M.str', $strings));
1139         }
1141         // Add variables.
1142         if ($this->jsinitvariables['footer']) {
1143             $js = '';
1144             foreach ($this->jsinitvariables['footer'] as $data) {
1145                 list($var, $value) = $data;
1146                 $js .= js_writer::set_variable($var, $value, true);
1147             }
1148             $output .= html_writer::script($js);
1149         }
1151         $inyuijs = $this->get_javascript_code(false);
1152         $ondomreadyjs = $this->get_javascript_code(true);
1153         $jsinit = $this->get_javascript_init_code();
1154         $handlersjs = $this->get_event_handler_code();
1156         // There is no global Y, make sure it is available in your scope.
1157         $js = "YUI().use('node', function(Y) {\n{$inyuijs}{$ondomreadyjs}{$jsinit}{$handlersjs}\n});";
1159         $output .= html_writer::script($js);
1161         return $output;
1162     }
1164     /**
1165      * Have we already output the code in the <head> tag?
1166      *
1167      * @return bool
1168      */
1169     public function is_head_done() {
1170         return $this->headdone;
1171     }
1173     /**
1174      * Have we already output the code at the start of the <body> tag?
1175      *
1176      * @return bool
1177      */
1178     public function is_top_of_body_done() {
1179         return $this->topofbodydone;
1180     }
1183 /**
1184  * Invalidate all server and client side JS caches.
1185  */
1186 function js_reset_all_caches() {
1187     global $CFG;
1188     require_once("$CFG->libdir/filelib.php");
1190     $next = time();
1191     if (isset($CFG->jsrev) and $next <= $CFG->jsrev and $CFG->jsrev - $next < 60*60) {
1192         // This resolves problems when reset is requested repeatedly within 1s,
1193         // the < 1h condition prevents accidental switching to future dates
1194         // because we might not recover from it.
1195         $next = $CFG->jsrev+1;
1196     }
1198     set_config('jsrev', $next);
1199     fulldelete("$CFG->cachedir/js");