Merge branch 's11_MDL-28284_filepicker_module_master' of git://github.com/dongsheng...
[moodle.git] / lib / outputrequirementslib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
19 /**
20  * Library functions to facilitate the use of JavaScript in Moodle.
21  *
22  * @package    core
23  * @subpackage lib
24  * @copyright  2009 Tim Hunt, 2010 Petr Skoda
25  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26  */
28 defined('MOODLE_INTERNAL') || die();
30 // note: you can find history of this file in lib/ajax/ajaxlib.php
32 /**
33  * This class tracks all the things that are needed by the current page.
34  *
35  * Normally, the only instance of this  class you will need to work with is the
36  * one accessible via $PAGE->requires.
37  *
38  * Typical usage would be
39  * <pre>
40  *     $PAGE->requires->js_init_call('M.mod_forum.init_view');
41  * </pre>
42  *
43  * It also supports obsoleted coding style withouth YUI3 modules.
44  * <pre>
45  *     $PAGE->requires->css('/mod/mymod/userstyles.php?id='.$id); // not overridable via themes!
46  *     $PAGE->requires->js('/mod/mymod/script.js');
47  *     $PAGE->requires->js('/mod/mymod/small_but_urgent.js', true);
48  *     $PAGE->requires->js_function_call('init_mymod', array($data), true);
49  * </pre>
50  *
51  * There are some natural restrictions on some methods. For example, {@link css()}
52  * can only be called before the <head> tag is output. See the comments on the
53  * individual methods for details.
54  *
55  * @copyright 2009 Tim Hunt, 2010 Petr Skoda
56  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
57  * @since Moodle 2.0
58  */
59 class page_requirements_manager {
60     /** List of string available from JS */
61     protected $stringsforjs = array();
62     /** List of JS variables to be initialised */
63     protected $jsinitvariables = array('head'=>array(), 'footer'=>array());
64     /** Included JS scripts */
65     protected $jsincludes = array('head'=>array(), 'footer'=>array());
66     /** List of needed function calls */
67     protected $jscalls = array('normal'=>array(), 'ondomready'=>array());
68     /**
69      * List of skip links, those are needed for accessibility reasons
70      * @var array
71      */
72     protected $skiplinks = array();
73     /**
74      * Javascript code used for initialisation of page, it should be relatively small
75      * @var array
76      */
77     protected $jsinitcode = array();
78     /**
79      * Theme sheets, initialised only from core_renderer
80      * @var array of moodle_url
81      */
82     protected $cssthemeurls = array();
83     /**
84      * List of custom theme sheets, these are strongly discouraged!
85      * Useful mostly only for CSS submitted by teachers that is not part of the theme.
86      * @var array of moodle_url
87      */
88     protected $cssurls = array();
89     /**
90      * List of requested event handlers
91      * @var array
92      */
93     protected $eventhandlers = array();
94     /**
95      * Extra modules
96      * @var array
97      */
98     protected $extramodules = array();
99     /** Flag indicated head stuff already printed */
100     protected $headdone = false;
101     /** Flag indicating top of body already printed */
102     protected $topofbodydone = false;
104     /** YUI PHPLoader instance responsible for YUI2 loading from PHP only */
105     protected $yui2loader;
106     /** YUI PHPLoader instance responsible for YUI3 loading from PHP only */
107     protected $yui3loader;
108     /** YUI PHPLoader instance responsible for YUI3 loading from javascript */
109     protected $M_yui_loader;
110     /** some config vars exposed in JS, please no secret stuff there */
111     protected $M_cfg;
112     /** stores debug backtraces from when JS modules were included in the page */
113     protected $debug_moduleloadstacktraces = array();
115     /**
116      * Page requirements constructor.
117      */
118     public function __construct() {
119         global $CFG;
121         require_once("$CFG->libdir/yui/phploader/phploader/loader.php");
123         $this->yui3loader = new YAHOO_util_Loader($CFG->yui3version);
124         $this->yui2loader = new YAHOO_util_Loader($CFG->yui2version);
126         // set up some loader options
127         if (debugging('', DEBUG_DEVELOPER)) {
128             $this->yui3loader->filter = YUI_DEBUG; // alternatively we could use just YUI_RAW here
129             $this->yui2loader->filter = YUI_DEBUG; // alternatively we could use just YUI_RAW here
130         } else {
131             $this->yui3loader->filter = null;
132             $this->yui2loader->filter = null;
133         }
134         if (!empty($CFG->useexternalyui)) {
135             $this->yui3loader->base = 'http://yui.yahooapis.com/' . $CFG->yui3version . '/build/';
136             $this->yui2loader->base = 'http://yui.yahooapis.com/' . $CFG->yui2version . '/build/';
137             $this->yui3loader->comboBase = 'http://yui.yahooapis.com/combo?';
138             $this->yui2loader->comboBase = 'http://yui.yahooapis.com/combo?';
139         } else {
140             $this->yui3loader->base = $CFG->httpswwwroot . '/lib/yui/'. $CFG->yui3version . '/build/';
141             $this->yui2loader->base = $CFG->httpswwwroot . '/lib/yui/'. $CFG->yui2version . '/build/';
142             $this->yui3loader->comboBase = $CFG->httpswwwroot . '/theme/yui_combo.php?';
143             $this->yui2loader->comboBase = $CFG->httpswwwroot . '/theme/yui_combo.php?';
144         }
146         // enable combo loader? this significantly helps with caching and performance!
147         $this->yui3loader->combine = !empty($CFG->yuicomboloading);
148         $this->yui2loader->combine = !empty($CFG->yuicomboloading);
150         if (empty($CFG->cachejs)) {
151             $jsrev = -1;
152         } else if (empty($CFG->jsrev)) {
153             $jsrev = 1;
154         } else {
155             $jsrev = $CFG->jsrev;
156         }
158         // set up JS YUI loader helper object
159         $this->M_yui_loader = new stdClass();
160         $this->M_yui_loader->base         = $this->yui3loader->base;
161         $this->M_yui_loader->comboBase    = $this->yui3loader->comboBase;
162         $this->M_yui_loader->combine      = $this->yui3loader->combine;
163         $this->M_yui_loader->filter       = ($this->yui3loader->filter == YUI_DEBUG) ? 'debug' : '';
164         $this->M_yui_loader->insertBefore = 'firstthemesheet';
165         $this->M_yui_loader->modules      = array();
166         $this->M_yui_loader->groups       = array(
167             'moodle' => array(
168                 'name' => 'moodle',
169                 'base' => $CFG->httpswwwroot . '/theme/yui_combo.php?moodle/'.$jsrev.'/',
170                 'comboBase' => $CFG->httpswwwroot . '/theme/yui_combo.php?',
171                 'combine' => $this->yui3loader->combine,
172                 'filter' => '',
173                 'ext' => false,
174                 'root' => 'moodle/'.$jsrev.'/', // Add the rev to the root path so that we can control caching
175                 'patterns' => array(
176                     'moodle-' => array(
177                         'group' => 'moodle',
178                         'configFn' => '@MOODLECONFIGFN@'
179                     ),
180                     'root' => 'moodle'
181                 )
182             ),
183             'local' => array(
184                 'name' => 'gallery',
185                 'base' => $CFG->wwwroot.'/lib/yui/gallery/',
186                 'comboBase' => $CFG->httpswwwroot . '/theme/yui_combo.php?',
187                 'combine' => $this->yui3loader->combine,
188                 'filter' => $this->M_yui_loader->filter,
189                 'ext' => false,
190                 'root' => 'gallery/',
191                 'patterns' => array(
192                     'gallery-' => array(
193                         'group' => 'gallery',
194                         'configFn' => '@GALLERYCONFIGFN@',
195                     ),
196                     'root' => 'gallery'
197                 )
198             )
199         );
200         $this->add_yui2_modules(); // adds loading info for all YUI2 modules
201         $this->js_module($this->find_module('core_dock'));
203         // YUI3 init code
204         $libs = array('cssreset', 'cssbase', 'cssfonts', 'cssgrids', 'node', 'loader'); // full CSS reset + basic libs
205         foreach ($libs as $lib) {
206             $this->yui3loader->load($lib);
207         }
208     }
210     /**
211      * This method adds yui2 modules into the yui3 JS loader-
212      * @return void
213      */
214     protected function add_yui2_modules() {
215         //note: this function is definitely not perfect, because
216         //      it adds tons of markup into each page, but it can be
217         //      abstracted into separate JS file with proper headers
218         global $CFG;
220         $GLOBALS['yui_current'] = array();
221         require($CFG->libdir.'/yui/phploader/lib/meta/config_'.$CFG->yui2version.'.php');
222         $info = $GLOBALS['yui_current'];
223         unset($GLOBALS['yui_current']);
225         if (empty($CFG->yuicomboloading)) {
226             $urlbase = $this->yui2loader->base;
227         } else {
228             $urlbase = $this->yui2loader->comboBase.$CFG->yui2version.'/build/';
229         }
231         $modules = array();
232         $ignored = array(); // list of CSS modules that are not needed
233         foreach ($info['moduleInfo'] as $name => $module) {
234             if ($module['type'] === 'css') {
235                 $ignored[$name] = true;
236             } else {
237                 $modules['yui2-'.$name] = $module;
238             }
239         }
240         foreach ($modules as $name=>$module) {
241             $module['fullpath'] = $urlbase.$module['path']; // fix path to point to correct location
242             unset($module['path']);
243             unset($module['skinnable']); // we load all YUI2 css automatically, this prevents weird missing css loader problems
244             foreach(array('requires', 'optional', 'supersedes') as $fixme) {
245                 if (!empty($module[$fixme])) {
246                     $fixed = false;
247                     foreach ($module[$fixme] as $key=>$dep) {
248                         if (isset($ignored[$dep])) {
249                             unset($module[$fixme][$key]);
250                             $fixed = true;
251                         } else {
252                             $module[$fixme][$key] = 'yui2-'.$dep;
253                         }
254                     }
255                     if ($fixed) {
256                         $module[$fixme] = array_merge($module[$fixme]); // fix keys
257                     }
258                 }
259             }
260             $this->M_yui_loader->modules[$name] = $module;
261             if (debugging('', DEBUG_DEVELOPER)) {
262                 if (!array_key_exists($name, $this->debug_moduleloadstacktraces)) {
263                     $this->debug_moduleloadstacktraces[$name] = array();
264                 }
265                 $this->debug_moduleloadstacktraces[$name][] = format_backtrace(debug_backtrace());
266             }
267         }
268     }
270     /**
271      * Initialise with the bits of JavaScript that every Moodle page should have.
272      *
273      * @param moodle_page $page
274      * @param core_renderer $output
275      */
276     protected function init_requirements_data(moodle_page $page, core_renderer $renderer) {
277         global $CFG;
279         // JavaScript should always work with $CFG->httpswwwroot rather than $CFG->wwwroot.
280         // Otherwise, in some situations, users will get warnings about insecure content
281         // on secure pages from their web browser.
283         $this->M_cfg = array(
284             'wwwroot'             => $CFG->httpswwwroot, // Yes, really. See above.
285             'sesskey'             => sesskey(),
286             'loadingicon'         => $renderer->pix_url('i/loading_small', 'moodle')->out(false),
287             'themerev'            => theme_get_revision(),
288             'theme'               => $page->theme->name,
289             'jsrev'               => ((empty($CFG->cachejs) or empty($CFG->jsrev)) ? -1 : $CFG->jsrev),
290         );
291         if (debugging('', DEBUG_DEVELOPER)) {
292             $this->M_cfg['developerdebug'] = true;
293             $this->yui2_lib('logger');
294         }
296         // accessibility stuff
297         $this->skip_link_to('maincontent', get_string('tocontent', 'access'));
299         // to be removed soon
300         $this->yui2_lib('dom');        // at least javascript-static.js needs to be migrated to YUI3
302         $this->string_for_js('confirmation', 'admin');
303         $this->string_for_js('cancel', 'moodle');
304         $this->string_for_js('yes', 'moodle');
306         if ($page->pagelayout === 'frametop') {
307             $this->js_init_call('M.util.init_frametop');
308         }
309     }
311     /**
312      * Ensure that the specified JavaScript file is linked to from this page.
313      *
314      * NOTE: This function is to be used in rare cases only, please store your JS in module.js file
315      * and use $PAGE->requires->js_init_call() instead.
316      *
317      * By default the link is put at the end of the page, since this gives best page-load performance.
318      *
319      * Even if a particular script is requested more than once, it will only be linked
320      * to once.
321      *
322      * @param string|moodle_url $url The path to the .js file, relative to $CFG->dirroot / $CFG->wwwroot.
323      *      For example '/mod/mymod/customscripts.js'; use moodle_url for external scripts
324      * @param bool $inhead initialise in head
325      * @return void
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      * Ensure that the specified YUI2 library file, and all its required dependencies,
335      * are linked to from this page.
336      *
337      * By default the link is put at the end of the page, since this gives best page-load
338      * performance. Optional dependencies are not loaded automatically - if you want
339      * them you will need to load them first with other calls to this method.
340      *
341      * Even if a particular library is requested more than once (perhaps as a dependency
342      * of other libraries) it will only be linked to once.
343      *
344      * The library is leaded as soon as possible, if $OUTPUT->header() not used yet it
345      * is put into the page header, otherwise it is loaded in the page footer.
346      *
347      * @param string|array $libname the name of the YUI2 library you require. For example 'autocomplete'.
348      * @return void
349      */
350     public function yui2_lib($libname) {
351         $libnames = (array)$libname;
352         foreach ($libnames as $lib) {
353             $this->yui2loader->load($lib);
354         }
355     }
357     /**
358      * Returns the actual url through which a script is served.
359      * @param moodle_url|string $url full moodle url, or shortened path to script
360      * @return moodle_url
361      */
362     protected function js_fix_url($url) {
363         global $CFG;
365         if ($url instanceof moodle_url) {
366             return $url;
367         } else if (strpos($url, '/') === 0) {
368             if (debugging()) {
369                 // check file existence only when in debug mode
370                 if (!file_exists($CFG->dirroot . strtok($url, '?'))) {
371                     throw new coding_exception('Attempt to require a JavaScript file that does not exist.', $url);
372                 }
373             }
374             if (!empty($CFG->cachejs) and !empty($CFG->jsrev) and strpos($url, '/lib/editor/') !== 0 and substr($url, -3) === '.js') {
375                 return new moodle_url($CFG->httpswwwroot.'/lib/javascript.php', array('file'=>$url, 'rev'=>$CFG->jsrev));
376             } else {
377                 return new moodle_url($CFG->httpswwwroot.$url);
378             }
379         } else {
380             throw new coding_exception('Invalid JS url, it has to be shortened url starting with / or moodle_url instance.', $url);
381         }
382     }
384     /**
385      * Find out if JS module present and return details.
386      * @param string $component name of component in frankenstyle, ex: core_group, mod_forum
387      * @return array description of module or null if not found
388      */
389     protected function find_module($component) {
390         global $CFG;
392         $module = null;
395         if (strpos($component, 'core_') === 0) {
396             // must be some core stuff - list here is not complete, this is just the stuff used from multiple places
397             // so that we do nto have to repeat the definition of these modules over and over again
398             switch($component) {
399                 case 'core_filepicker':
400                     $module = array('name'     => 'core_filepicker',
401                                     'fullpath' => '/repository/filepicker.js',
402                                     'requires' => array('base', 'node', 'node-event-simulate', 'json', 'async-queue', 'io', 'yui2-button', 'yui2-container', 'yui2-layout', 'yui2-menu', 'yui2-treeview', 'yui2-dragdrop', 'yui2-cookie'),
403                                     'strings'  => array(array('add', 'repository'), array('back', 'repository'), array('cancel', 'moodle'), array('close', 'repository'),
404                                                         array('cleancache', 'repository'), array('copying', 'repository'), array('date', 'repository'), array('downloadsucc', 'repository'),
405                                                         array('emptylist', 'repository'), array('error', 'repository'), array('federatedsearch', 'repository'),
406                                                         array('filenotnull', 'repository'), array('getfile', 'repository'), array('help', 'moodle'), array('iconview', 'repository'),
407                                                         array('invalidjson', 'repository'), array('linkexternal', 'repository'), array('listview', 'repository'),
408                                                         array('loading', 'repository'), array('login', 'repository'), array('logout', 'repository'), array('noenter', 'repository'),
409                                                         array('noresult', 'repository'), array('manageurl', 'repository'), array('popup', 'repository'), array('preview', 'repository'),
410                                                         array('refresh', 'repository'), array('save', 'repository'), array('saveas', 'repository'), array('saved', 'repository'),
411                                                         array('saving', 'repository'), array('search', 'repository'), array('searching', 'repository'), array('size', 'repository'),
412                                                         array('submit', 'repository'), array('sync', 'repository'), array('title', 'repository'), array('upload', 'repository'),
413                                                         array('uploading', 'repository'), array('xhtmlerror', 'repository'),
414                                                         array('cancel'), array('chooselicense', 'repository'), array('author', 'repository'),
415                                                         array('ok', 'moodle'), array('error', 'moodle'), array('info', 'moodle'), array('norepositoriesavailable', 'repository'), array('norepositoriesexternalavailable', 'repository'),
416                                                         array('nofilesattached', 'repository'), array('filepicker', 'repository'),
417                                                         array('nofilesavailable', 'repository'), array('overwrite', 'repository'),
418                                                         array('renameto', 'repository'), array('fileexists', 'repository'),
419                                                         array('fileexistsdialogheader', 'repository'), array('fileexistsdialog_editor', 'repository'),
420                                                         array('fileexistsdialog_filemanager', 'repository')
421                                                     ));
422                     break;
423                 case 'core_comment':
424                     $module = array('name'     => 'core_comment',
425                                     'fullpath' => '/comment/comment.js',
426                                     'requires' => array('base', 'io', 'node', 'json', 'yui2-animation', 'overlay'),
427                                     'strings' => array(array('confirmdeletecomments', 'admin'), array('yes', 'moodle'), array('no', 'moodle'))
428                                 );
429                     break;
430                 case 'core_role':
431                     $module = array('name'     => 'core_role',
432                                     'fullpath' => '/admin/roles/module.js',
433                                     'requires' => array('node', 'cookie'));
434                     break;
435                 case 'core_completion':
436                     $module = array('name'     => 'core_completion',
437                                     'fullpath' => '/course/completion.js');
438                     break;
439                 case 'core_dock':
440                     $module = array('name'     => 'core_dock',
441                                     'fullpath' => '/blocks/dock.js',
442                                     'requires' => array('base', 'node', 'event-custom', 'event-mouseenter', 'event-resize'),
443                                     'strings' => array(array('addtodock', 'block'),array('undockitem', 'block'),array('undockall', 'block'),array('thisdirectionvertical', 'langconfig')));
444                     break;
445                 case 'core_message':
446                     $module = array('name'     => 'core_message',
447                                     'requires' => array('base', 'node', 'event', 'node-event-simulate'),
448                                     'fullpath' => '/message/module.js');
449                     break;
450                 case 'core_group':
451                     $module = array('name'     => 'core_group',
452                                     'fullpath' => '/group/module.js',
453                                     'requires' => array('node', 'overlay', 'event-mouseenter'));
454                     break;
455                 case 'core_question_engine':
456                     $module = array('name'     => 'core_question_engine',
457                                     'fullpath' => '/question/qengine.js',
458                                     'requires' => array('node', 'event'));
459                     break;
460                 case 'core_rating':
461                     $module = array('name'     => 'core_rating',
462                                     'fullpath' => '/rating/module.js',
463                                     'requires' => array('node', 'event', 'overlay', 'io', 'json'));
464                     break;
465                 case 'core_filetree':
466                     $module = array('name'     => 'core_filetree',
467                                     'fullpath' => '/files/module.js',
468                                     'requires' => array('node', 'event', 'overlay', 'io', 'json', 'yui2-treeview'));
469                     break;
470             }
472         } else {
473             if ($dir = get_component_directory($component)) {
474                 if (file_exists("$dir/module.js")) {
475                     if (strpos($dir, $CFG->dirroot.'/') === 0) {
476                         $dir = substr($dir, strlen($CFG->dirroot));
477                         $module = array('name'=>$component, 'fullpath'=>"$dir/module.js", 'requires' => array());
478                     }
479                 }
480             }
481         }
483         return $module;
484     }
486     /**
487      * Append YUI3 module to default YUI3 JS loader.
488      * The structure of module array is described at http://developer.yahoo.com/yui/3/yui/:
489      * @param string|array $module name of module (details are autodetected), or full module specification as array
490      * @return void
491      */
492     public function js_module($module) {
493         global $CFG;
495         if (empty($module)) {
496             throw new coding_exception('Missing YUI3 module name or full description.');
497         }
499         if (is_string($module)) {
500             $module = $this->find_module($module);
501         }
503         if (empty($module) or empty($module['name']) or empty($module['fullpath'])) {
504             throw new coding_exception('Missing YUI3 module details.');
505         }
507         // Don't load this module if we already have, no need to!
508         if ($this->js_module_loaded($module['name'])) {
509             if (debugging('', DEBUG_DEVELOPER)) {
510                 $this->debug_moduleloadstacktraces[$module['name']][] = format_backtrace(debug_backtrace());
511             }
512             return;
513         }
515         $module['fullpath'] = $this->js_fix_url($module['fullpath'])->out(false);
516         // add all needed strings
517         if (!empty($module['strings'])) {
518             foreach ($module['strings'] as $string) {
519                 $identifier = $string[0];
520                 $component = isset($string[1]) ? $string[1] : 'moodle';
521                 $a = isset($string[2]) ? $string[2] : null;
522                 $this->string_for_js($identifier, $component, $a);
523             }
524         }
525         unset($module['strings']);
527         // Process module requirements and attempt to load each. This allows
528         // moodle modules to require each other.
529         if (!empty($module['requires'])){
530             foreach ($module['requires'] as $requirement) {
531                 $rmodule = $this->find_module($requirement);
532                 if (is_array($rmodule)) {
533                     $this->js_module($rmodule);
534                 }
535             }
536         }
538         if ($this->headdone) {
539             $this->extramodules[$module['name']] = $module;
540         } else {
541             $this->M_yui_loader->modules[$module['name']] = $module;
542         }
543         if (debugging('', DEBUG_DEVELOPER)) {
544             if (!array_key_exists($module['name'], $this->debug_moduleloadstacktraces)) {
545                 $this->debug_moduleloadstacktraces[$module['name']] = array();
546             }
547             $this->debug_moduleloadstacktraces[$module['name']][] = format_backtrace(debug_backtrace());
548         }
549     }
551     /**
552      * Returns true if the module has already been loaded.
553      *
554      * @param string|array $modulename
555      * @return bool True if the module has already been loaded
556      */
557     protected function js_module_loaded($module) {
558         if (is_string($module)) {
559             $modulename = $module;
560         } else {
561             $modulename = $module['name'];
562         }
563         return array_key_exists($modulename, $this->M_yui_loader->modules) ||
564                array_key_exists($modulename, $this->extramodules);
565     }
567     /**
568      * Returns the stacktraces from loading js modules.
569      * @return array
570      */
571     public function get_loaded_modules() {
572         return $this->debug_moduleloadstacktraces;
573     }
575     /**
576      * Ensure that the specified CSS file is linked to from this page.
577      *
578      * Because stylesheet links must go in the <head> part of the HTML, you must call
579      * this function before {@link get_head_code()} is called. That normally means before
580      * the call to print_header. If you call it when it is too late, an exception
581      * will be thrown.
582      *
583      * Even if a particular style sheet is requested more than once, it will only
584      * be linked to once.
585      *
586      * Please note use of this feature is strongly discouraged,
587      * it is suitable only for places where CSS is submitted directly by teachers.
588      * (Students must not be allowed to submit any external CSS because it may
589      * contain embedded javascript!). Example of correct use is mod/data.
590      *
591      * @param string $stylesheet The path to the .css file, relative to $CFG->wwwroot.
592      *   For example:
593      *      $PAGE->requires->css('mod/data/css.php?d='.$data->id);
594      */
595     public function css($stylesheet) {
596         global $CFG;
598         if ($this->headdone) {
599             throw new coding_exception('Cannot require a CSS file after &lt;head> has been printed.', $stylesheet);
600         }
602         if ($stylesheet instanceof moodle_url) {
603             // ok
604         } else if (strpos($stylesheet, '/') === 0) {
605             $stylesheet = new moodle_url($CFG->httpswwwroot.$stylesheet);
606         } else {
607             throw new coding_exception('Invalid stylesheet parameter.', $stylesheet);
608         }
610         $this->cssurls[$stylesheet->out()] = $stylesheet; // overrides
611     }
613     /**
614      * Add theme stylkesheet to page - do not use from plugin code,
615      * this should be called only from the core renderer!
616      * @param moodle_url $stylesheet
617      * @return void
618      */
619     public function css_theme(moodle_url $stylesheet) {
620         $this->cssthemeurls[] = $stylesheet;
621     }
623     /**
624      * Ensure that a skip link to a given target is printed at the top of the <body>.
625      *
626      * You must call this function before {@link get_top_of_body_code()}, (if not, an exception
627      * will be thrown). That normally means you must call this before the call to print_header.
628      *
629      * If you ask for a particular skip link to be printed, it is then your responsibility
630      * to ensure that the appropriate <a name="..."> tag is printed in the body of the
631      * page, so that the skip link goes somewhere.
632      *
633      * Even if a particular skip link is requested more than once, only one copy of it will be output.
634      *
635      * @param $target the name of anchor this link should go to. For example 'maincontent'.
636      * @param $linktext The text to use for the skip link. Normally get_string('skipto', 'access', ...);
637      */
638     public function skip_link_to($target, $linktext) {
639         if ($this->topofbodydone) {
640             debugging('Page header already printed, can not add skip links any more, code needs to be fixed.');
641             return;
642         }
643         $this->skiplinks[$target] = $linktext;
644     }
646     /**
647      * !!!DEPRECATED!!! please use js_init_call() if possible
648      * Ensure that the specified JavaScript function is called from an inline script
649      * somewhere on this page.
650      *
651      * By default the call will be put in a script tag at the
652      * end of the page after initialising Y instance, since this gives best page-load
653      * performance and allows you to use YUI3 library.
654      *
655      * If you request that a particular function is called several times, then
656      * that is what will happen (unlike linking to a CSS or JS file, where only
657      * one link will be output).
658      *
659      * The main benefit of the method is the automatic encoding of all function parameters.
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
668      * @param int $delay
669      * @return void
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 = '2010.04.08-12-35', $ondomready = false) {
709         global $CFG;
711         if (!is_array($modules)) {
712             $modules = array($modules);
713         }
714         if (empty($CFG->useexternalyui) || true) {
715             // We need to set the M.yui.galleryversion to the correct version
716             $jscode = 'M.yui.galleryversion='.json_encode($galleryversion).';';
717         } else {
718             // Set Y's config.gallery to the version
719             $jscode = 'Y.config.gallery='.json_encode($galleryversion).';';
720         }
721         $jscode .= 'Y.use('.join(',', array_map('json_encode', $modules)).',function() {'.js_writer::function_call($function, $arguments).'});';
722         if ($ondomready) {
723             $jscode = "Y.on('domready', function() { $jscode });";
724         }
725         $this->jsinitcode[] = $jscode;
726     }
728     /**
729      * Ensure that the specified JavaScript function is called from an inline script
730      * from page footer.
731      *
732      * @param string $function the name of the JavaScritp function to with init code,
733      *      usually something like 'M.mod_mymodule.init'
734      * @param array $extraarguments and array of arguments to be passed to the function.
735      *      The first argument is always the YUI3 Y instance with all required dependencies
736      *      already loaded.
737      * @param bool $ondomready wait for dom ready (helps with some IE problems when modifying DOM)
738      * @param array $module JS module specification array
739      * @return void
740      */
741     public function js_init_call($function, array $extraarguments = null, $ondomready = false, array $module = null) {
742         $jscode = js_writer::function_call_with_Y($function, $extraarguments);
743         if (!$module) {
744             // detect module automatically
745             if (preg_match('/M\.([a-z0-9]+_[^\.]+)/', $function, $matches)) {
746                 $module = $this->find_module($matches[1]);
747             }
748         }
750         $this->js_init_code($jscode, $ondomready, $module);
751     }
753     /**
754      * Add short static javascript code fragment to page footer.
755      * This is intended primarily for loading of js modules and initialising page layout.
756      * Ideally the JS code fragment should be stored in plugin renderer so that themes
757      * may override it.
758      * @param string $jscode
759      * @param bool $ondomready wait for dom ready (helps with some IE problems when modifying DOM)
760      * @param array $module JS module specification array
761      * @return void
762      */
763     public function js_init_code($jscode, $ondomready = false, array $module = null) {
764         $jscode = trim($jscode, " ;\n"). ';';
766         if ($module) {
767             $this->js_module($module);
768             $modulename = $module['name'];
769             $jscode = "Y.use('$modulename', function(Y) { $jscode });";
770         }
772         if ($ondomready) {
773             $jscode = "Y.on('domready', function() { $jscode });";
774         }
776         $this->jsinitcode[] = $jscode;
777     }
779     /**
780      * Make a language string available to JavaScript.
781      *
782      * All the strings will be available in a M.str object in the global namespace.
783      * So, for example, after a call to $PAGE->requires->string_for_js('course', 'moodle');
784      * then the JavaScript variable M.str.moodle.course will be 'Course', or the
785      * equivalent in the current language.
786      *
787      * The arguments to this function are just like the arguments to get_string
788      * except that $component is not optional, and there are some aspects to consider
789      * when the string contains {$a} placeholder.
790      *
791      * If the string does not contain any {$a} placeholder, you can simply use
792      * M.str.component.identifier to obtain it. If you prefer, you can call
793      * M.util.get_string(identifier, component) to get the same result.
794      *
795      * If you need to use {$a} placeholders, there are two options. Either the
796      * placeholder should be substituted in PHP on server side or it should
797      * be substituted in Javascript at client side.
798      *
799      * To substitute the placeholder at server side, just provide the required
800      * value for the placeholder when you require the string. Because each string
801      * is only stored once in the JavaScript (based on $identifier and $module)
802      * you cannot get the same string with two different values of $a. If you try,
803      * an exception will be thrown. Once the placeholder is substituted, you can
804      * use M.str or M.util.get_string() as shown above:
805      *
806      *     // require the string in PHP and replace the placeholder
807      *     $PAGE->requires->string_for_js('fullnamedisplay', 'moodle', $USER);
808      *     // use the result of the substitution in Javascript
809      *     alert(M.str.moodle.fullnamedisplay);
810      *
811      * To substitute the placeholder at client side, use M.util.get_string()
812      * function. It implements the same logic as {@see get_string()}:
813      *
814      *     // require the string in PHP but keep {$a} as it is
815      *     $PAGE->requires->string_for_js('fullnamedisplay', 'moodle');
816      *     // provide the values on the fly in Javascript
817      *     user = { firstname : 'Harry', lastname : 'Potter' }
818      *     alert(M.util.get_string('fullnamedisplay', 'moodle', user);
819      *
820      * If you do need the same string expanded with different $a values in PHP
821      * on server side, then the solution is to put them in your own data structure
822      * (e.g. and array) that you pass to JavaScript with {@link data_for_js()}.
823      *
824      * @param string $identifier the desired string.
825      * @param string $module the language file to look in.
826      * @param mixed $a any extra data to add into the string (optional).
827      */
828     public function string_for_js($identifier, $component, $a = NULL) {
829         $string = get_string($identifier, $component, $a);
830         if (!$component) {
831             throw new coding_exception('The $module parameter is required for page_requirements_manager::string_for_js.');
832         }
833         if (isset($this->stringsforjs[$component][$identifier]) && $this->stringsforjs[$component][$identifier] !== $string) {
834             throw new coding_exception("Attempt to re-define already required string '$identifier' " .
835                     "from lang file '$component'. Did you already ask for it with a different \$a? {$this->stringsforjs[$component][$identifier]} !== $string");
836         }
837         $this->stringsforjs[$component][$identifier] = $string;
838     }
840     /**
841      * Make an array of language strings available for JS
842      *
843      * This function calls the above function {@link string_for_js()} for each requested
844      * string in the $identifiers array that is passed to the argument for a single module
845      * passed in $module.
846      *
847      * <code>
848      * $PAGE->requires->strings_for_js(array('one', 'two', 'three'), 'mymod', array('a', null, 3));
849      *
850      * // The above is identitical to calling
851      *
852      * $PAGE->requires->string_for_js('one', 'mymod', 'a');
853      * $PAGE->requires->string_for_js('two', 'mymod');
854      * $PAGE->requires->string_for_js('three', 'mymod', 3);
855      * </code>
856      *
857      * @param array $identifiers An array of desired strings
858      * @param string $component The module to load for
859      * @param mixed $a This can either be a single variable that gets passed as extra
860      *         information for every string or it can be an array of mixed data where the
861      *         key for the data matches that of the identifier it is meant for.
862      *
863      */
864     public function strings_for_js($identifiers, $component, $a=NULL) {
865         foreach ($identifiers as $key => $identifier) {
866             if (is_array($a) && array_key_exists($key, $a)) {
867                 $extra = $a[$key];
868             } else {
869                 $extra = $a;
870             }
871             $this->string_for_js($identifier, $component, $extra);
872         }
873     }
875     /**
876      * !!!!!!DEPRECATED!!!!!! please use js_init_call() for everything now.
877      *
878      * Make some data from PHP available to JavaScript code.
879      *
880      * For example, if you call
881      * <pre>
882      *      $PAGE->requires->data_for_js('mydata', array('name' => 'Moodle'));
883      * </pre>
884      * then in JavsScript mydata.name will be 'Moodle'.
885      * @param string $variable the the name of the JavaScript variable to assign the data to.
886      *      Will probably work if you use a compound name like 'mybuttons.button[1]', but this
887      *      should be considered an experimental feature.
888      * @param mixed $data The data to pass to JavaScript. This will be escaped using json_encode,
889      *      so passing objects and arrays should work.
890      * @param bool $inhead initialise in head
891      * @return void
892      */
893     public function data_for_js($variable, $data, $inhead=false) {
894         $where = $inhead ? 'head' : 'footer';
895         $this->jsinitvariables[$where][] = array($variable, $data);
896     }
898     /**
899      * Creates a YUI event handler.
900      *
901      * @param mixed $selector standard YUI selector for elemnts, may be array or string, element id is in the form "#idvalue"
902      * @param string $event A valid DOM event (click, mousedown, change etc.)
903      * @param string $function The name of the function to call
904      * @param array  $arguments An optional array of argument parameters to pass to the function
905      * @return void
906      */
907     public function event_handler($selector, $event, $function, array $arguments = null) {
908         $this->eventhandlers[] = array('selector'=>$selector, 'event'=>$event, 'function'=>$function, 'arguments'=>$arguments);
909     }
911     /**
912      * Returns code needed for registering of event handlers.
913      * @return string JS code
914      */
915     protected function get_event_handler_code() {
916         $output = '';
917         foreach ($this->eventhandlers as $h) {
918             $output .= js_writer::event_handler($h['selector'], $h['event'], $h['function'], $h['arguments']);
919         }
920         return $output;
921     }
923     /**
924      * Get the inline JavaScript code that need to appear in a particular place.
925      * @return bool $ondomready
926      */
927     protected function get_javascript_code($ondomready) {
928         $where = $ondomready ? 'ondomready' : 'normal';
929         $output = '';
930         if ($this->jscalls[$where]) {
931             foreach ($this->jscalls[$where] as $data) {
932                 $output .= js_writer::function_call($data[0], $data[1], $data[2]);
933             }
934             if (!empty($ondomready)) {
935                 $output = "    Y.on('domready', function() {\n$output\n    });";
936             }
937         }
938         return $output;
939     }
941     /**
942      * Returns js code to be executed when Y is available.
943      * @return unknown_type
944      */
945     protected function get_javascript_init_code() {
946         if (count($this->jsinitcode)) {
947             return implode("\n", $this->jsinitcode) . "\n";
948         }
949         return '';
950     }
952     /**
953      * Returns basic YUI3 JS loading code.
954      * YUI3 is using autoloading of both CSS and JS code.
955      *
956      * Major benefit of this compared to standard js/csss loader is much improved
957      * caching, better browser cache utilisation, much fewer http requests.
958      *
959      * @return string
960      */
961     protected function get_yui3lib_headcode() {
962         $code = $this->yui3loader->tags();
963         // unfortunately yui loader does not produce xhtml strict code, so let's fix it for now
964         $code = str_replace('&amp;', '&', $code);
965         $code = str_replace('&', '&amp;', $code);
966         return $code;
967     }
969     /**
970      * Returns basic YUI2 JS loading code.
971      * It can be called manually at any time.
972      * If called manually the result needs to be output using echo().
973      *
974      * Major benefit of this compared to standard js loader is much improved
975      * caching, better browser cache utilisation, much fewer http requests.
976      *
977      * All YUI2 CSS is loaded automatically.
978      *
979      * @return string JS embedding code
980      */
981     public function get_yui2lib_code() {
982         global $CFG;
984         if ($this->headdone) {
985             $code = $this->yui2loader->script();
986         } else {
987             $code = $this->yui2loader->script();
988             if ($this->yui2loader->combine) {
989                 $skinurl = $this->yui2loader->comboBase . $CFG->yui2version . '/build/assets/skins/sam/skin.css';
990             } else {
991                 $skinurl = $this->yui2loader->base . 'assets/skins/sam/skin.css';
992             }
993             // please note this is a temporary hack until we fully migrate to later YUI3 that has all the widgets
994             $attributes = array('rel'=>'stylesheet', 'type'=>'text/css', 'href'=>$skinurl);
995             $code .= "\n" . html_writer::empty_tag('link', $attributes) . "\n";
996         }
997         $code = str_replace('&amp;', '&', $code);
998         $code = str_replace('&', '&amp;', $code);
999         return $code;
1000     }
1002     /**
1003      * Returns html tags needed for inclusion of theme CSS
1004      * @return string
1005      */
1006     protected function get_css_code() {
1007         // First of all the theme CSS, then any custom CSS
1008         // Please note custom CSS is strongly discouraged,
1009         // because it can not be overridden by themes!
1010         // It is suitable only for things like mod/data which accepts CSS from teachers.
1011         $attributes = array('rel'=>'stylesheet', 'type'=>'text/css');
1013         // This line of code may look funny but it is currently required in order
1014         // to avoid MASSIVE display issues in Internet Explorer.
1015         // As of IE8 + YUI3.1.1 the reference stylesheet (firstthemesheet) gets
1016         // ignored whenever another resource is added until such time as a redraw
1017         // is forced, usually by moving the mouse over the affected element.
1018         $code = html_writer::tag('script', '/** Required in order to fix style inclusion problems in IE with YUI **/', array('id'=>'firstthemesheet', 'type'=>'text/css'));
1020         $urls = $this->cssthemeurls + $this->cssurls;
1021         foreach ($urls as $url) {
1022             $attributes['href'] = $url;
1023             $code .= html_writer::empty_tag('link', $attributes) . "\n";
1024             // this id is needed in first sheet only so that theme may override YUI sheets laoded on the fly
1025             unset($attributes['id']);
1026         }
1028         return $code;
1029     }
1031     /**
1032      * Adds extra modules specified after printing of page header
1033      */
1034     protected function get_extra_modules_code() {
1035         if (empty($this->extramodules)) {
1036             return '';
1037         }
1038         return html_writer::script(js_writer::function_call('M.yui.add_module', array($this->extramodules)));
1039     }
1041     /**
1042      * Generate any HTML that needs to go inside the <head> tag.
1043      *
1044      * Normally, this method is called automatically by the code that prints the
1045      * <head> tag. You should not normally need to call it in your own code.
1046      *
1047      * @return string the HTML code to to inside the <head> tag.
1048      */
1049     public function get_head_code(moodle_page $page, core_renderer $renderer) {
1050         global $CFG;
1052         // note: the $page and $output are not stored here because it would
1053         // create circular references in memory which prevents garbage collection
1054         $this->init_requirements_data($page, $renderer);
1056         // yui3 JS and CSS is always loaded first - it is cached in browser
1057         $output = $this->get_yui3lib_headcode();
1059         // BC: load basic YUI2 for now, all yui2 things should be loaded via Y.use('yui2-oldmodulename')
1060         $output .= $this->get_yui2lib_code();
1062         // now theme CSS + custom CSS in this specific order
1063         $output .= $this->get_css_code();
1065         // set up global YUI3 loader object - this should contain all code needed by plugins
1066         // note: in JavaScript just use "YUI(M.yui.loader).use('overlay', function(Y) { .... });"
1067         // this needs to be done before including any other script
1068         $js = "var M = {}; M.yui = {}; 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;}; 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('/');};\n";
1069         $js .= js_writer::set_variable('M.yui.loader', $this->M_yui_loader, false) . "\n";
1070         $js .= js_writer::set_variable('M.cfg', $this->M_cfg, false);
1071         $js = str_replace('"@GALLERYCONFIGFN@"', 'galleryConfigFn', $js);
1072         $js = str_replace('"@MOODLECONFIGFN@"', 'moodleConfigFn', $js);
1074         $output .= html_writer::script($js);
1076         // link our main JS file, all core stuff should be there
1077         $output .= html_writer::script('', $this->js_fix_url('/lib/javascript-static.js'));
1079         // add variables
1080         if ($this->jsinitvariables['head']) {
1081             $js = '';
1082             foreach ($this->jsinitvariables['head'] as $data) {
1083                 list($var, $value) = $data;
1084                 $js .= js_writer::set_variable($var, $value, true);
1085             }
1086             $output .= html_writer::script($js);
1087         }
1089         // all the other linked things from HEAD - there should be as few as possible
1090         if ($this->jsincludes['head']) {
1091             foreach ($this->jsincludes['head'] as $url) {
1092                 $output .= html_writer::script('', $url);
1093             }
1094         }
1096         // mark head sending done, it is not possible to anything there
1097         $this->headdone = true;
1099         return $output;
1100     }
1102     /**
1103      * Generate any HTML that needs to go at the start of the <body> tag.
1104      *
1105      * Normally, this method is called automatically by the code that prints the
1106      * <head> tag. You should not normally need to call it in your own code.
1107      *
1108      * @return string the HTML code to go at the start of the <body> tag.
1109      */
1110     public function get_top_of_body_code() {
1111         // first the skip links
1112         $links = '';
1113         $attributes = array('class'=>'skip');
1114         foreach ($this->skiplinks as $url => $text) {
1115             $attributes['href'] = '#' . $url;
1116             $links .= html_writer::tag('a', $text, $attributes);
1117         }
1118         $output = html_writer::tag('div', $links, array('class'=>'skiplinks')) . "\n";
1120         // then the clever trick for hiding of things not needed when JS works
1121         $output .= html_writer::script("document.body.className += ' jsenabled';") . "\n";
1122         $this->topofbodydone = true;
1123         return $output;
1124     }
1126     /**
1127      * Generate any HTML that needs to go at the end of the page.
1128      *
1129      * Normally, this method is called automatically by the code that prints the
1130      * page footer. You should not normally need to call it in your own code.
1131      *
1132      * @return string the HTML code to to at the end of the page.
1133      */
1134     public function get_end_code() {
1135         global $CFG;
1136         // add other requested modules
1137         $output = $this->get_extra_modules_code();
1139         // add missing YUI2 YUI - to be removed once we convert everything to YUI3!
1140         $output .= $this->get_yui2lib_code();
1142         // all the other linked scripts - there should be as few as possible
1143         if ($this->jsincludes['footer']) {
1144             foreach ($this->jsincludes['footer'] as $url) {
1145                 $output .= html_writer::script('', $url);
1146             }
1147         }
1149         // add all needed strings
1150         if (!empty($this->stringsforjs)) {
1151             $output .= html_writer::script(js_writer::set_variable('M.str', $this->stringsforjs));
1152         }
1154         // add variables
1155         if ($this->jsinitvariables['footer']) {
1156             $js = '';
1157             foreach ($this->jsinitvariables['footer'] as $data) {
1158                 list($var, $value) = $data;
1159                 $js .= js_writer::set_variable($var, $value, true);
1160             }
1161             $output .= html_writer::script($js);
1162         }
1164         $inyuijs = $this->get_javascript_code(false);
1165         $ondomreadyjs = $this->get_javascript_code(true);
1166         $jsinit = $this->get_javascript_init_code();
1167         $handlersjs = $this->get_event_handler_code();
1169         // there is no global Y, make sure it is available in your scope
1170         $js = "YUI(M.yui.loader).use('node', function(Y) {\n{$inyuijs}{$ondomreadyjs}{$jsinit}{$handlersjs}\n});";
1172         $output .= html_writer::script($js);
1174         return $output;
1175     }
1177     /**
1178      * @return boolean Have we already output the code in the <head> tag?
1179      */
1180     public function is_head_done() {
1181         return $this->headdone;
1182     }
1184     /**
1185      * @return boolean Have we already output the code at the start of the <body> tag?
1186      */
1187     public function is_top_of_body_done() {
1188         return $this->topofbodydone;
1189     }
1192 /**
1193  * Invalidate all server and client side JS caches.
1194  * @return void
1195  */
1196 function js_reset_all_caches() {
1197     global $CFG;
1198     require_once("$CFG->libdir/filelib.php");
1200     set_config('jsrev', empty($CFG->jsrev) ? 1 : $CFG->jsrev+1);
1201     fulldelete("$CFG->dataroot/cache/js");