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