60dea4b86271697d11a711b8b7d5f8ac50e0cf22
[moodle.git] / lib / ajax / ajaxlib.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   moodlecore
23  * @copyright 2009 Tim Hunt
24  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
28 /**
29  * This class tracks all the things that are needed by the current page.
30  *
31  * Normally, the only instance of this  class you will need to work with is the
32  * one accessible via $PAGE->requires.
33  *
34  * Typical useage would be
35  * <pre>
36  *     $PAGE->requires->css('/mod/mymod/userstyles.php?id='.$id); // not overriddable via themes!
37  *     $PAGE->requires->js('/mod/mymod/script.js');
38  *     $PAGE->requires->js('/mod/mymod/small_but_urgent.js', true);
39  *     $PAGE->requires->js_function_call('init_mymod', array($data))->on_dom_ready();
40  * </pre>
41  *
42  * There are some natural restrictions on some methods. For example, {@link css()}
43  * can only be called before the <head> tag is output. See the comments on the
44  * individual methods for details.
45  *
46  * @copyright 2009 Tim Hunt
47  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
48  * @since Moodle 2.0
49  */
50 class page_requirements_manager {
51     const WHEN_IN_HEAD = 0;
52     const WHEN_AT_END = 10;
53     const WHEN_IN_YUI = 20;
54     const WHEN_ON_DOM_READY = 30;
56     protected $requiredjscode = array();
58     /** List of string available from JS */
59     protected $stringsforjs = array();
60     /** List of JS variables to be initialised */
61     protected $jsinitvariables = array('head'=>array(), 'footer'=>array());
62     /** Included JS scripts */
63     protected $jsincludes = array('head'=>array(), 'footer'=>array());
64     /**
65      * List of skip links, those are needed for accessibility reasons
66      * @var array
67      */
68     protected $skiplinks = array();
69     /**
70      * Javascript code used for initialisation of page, it shoudl be relatively small
71      * @var array
72      */
73     protected $jsinitcode = array();
74     /**
75      * Theme sheets, initialised only from core_renderer
76      * @var array of moodle_url
77      */
78     protected $cssthemeurls = array();
79     /**
80      * List of custom theme sheets, these are strongly discouraged!
81      * Useful mostly only for CSS submitted by teachers that is not part of the theme.
82      * @var array of moodle_url
83      */
84     protected $cssurls = array();
85     /**
86      * List of requested event handlers
87      * @var array
88      */
89     protected $eventhandlers = array();
90     /**
91      * Extra modules
92      * @var array
93      */
94     protected $extramodules = array();
96     protected $headdone = false;
97     protected $topofbodydone = false;
99     /** YUI PHPLoader instance responsible for YUI2 loading from PHP only */
100     protected $yui2loader;
101     /** YUI PHPLoader instance responsible for YUI3 loading from PHP only */
102     protected $yui3loader;
103     /** YUI PHPLoader instance responsible for YUI3 loading from javascript */
104     protected $M_yui_loader;
105     /** some config vars exposed in JS, please no secret stuff there */
106     protected $M_cfg;
108     /**
109      * Page requirements constructor.
110      */
111     public function __construct() {
112         global $CFG;
114         require_once("$CFG->libdir/yui/phploader/phploader/loader.php");
116         $this->yui3loader = new YAHOO_util_Loader($CFG->yui3version);
117         $this->yui2loader = new YAHOO_util_Loader($CFG->yui2version);
119         // set up some loader options
120         if (debugging('', DEBUG_DEVELOPER)) {
121             $this->yui3loader->filter = YUI_DEBUG; // alternatively we could use just YUI_RAW here
122             $this->yui2loader->filter = YUI_DEBUG; // alternatively we could use just YUI_RAW here
123         } else {
124             $this->yui3loader->filter = null;
125             $this->yui2loader->filter = null;
126         }
127         if (!empty($CFG->useexternalyui)) {
128             $this->yui3loader->base = 'http://yui.yahooapis.com/' . $CFG->yui3version . '/build/';
129             $this->yui2loader->base = 'http://yui.yahooapis.com/' . $CFG->yui2version . '/build/';
130             $this->yui3loader->comboBase = 'http://yui.yahooapis.com/combo?';
131             $this->yui2loader->comboBase = 'http://yui.yahooapis.com/combo?';
132         } else {
133             $this->yui3loader->base = $CFG->httpswwwroot . '/lib/yui/'. $CFG->yui3version . '/build/';
134             $this->yui2loader->base = $CFG->httpswwwroot . '/lib/yui/'. $CFG->yui2version . '/build/';
135             $this->yui3loader->comboBase = $CFG->httpswwwroot . '/theme/yui_combo.php?';
136             $this->yui2loader->comboBase = $CFG->httpswwwroot . '/theme/yui_combo.php?';
137         }
139         // enable combo loader? this significantly helps with caching and performance!
140         $this->yui3loader->combine = !empty($CFG->yuicomboloading);
141         $this->yui2loader->combine = !empty($CFG->yuicomboloading);
143         // set up JS YUI loader helper object
144         $this->M_yui_loader = new stdClass();
145         $this->M_yui_loader->base         = $this->yui3loader->base;
146         $this->M_yui_loader->comboBase    = $this->yui3loader->comboBase;
147         $this->M_yui_loader->combine      = $this->yui3loader->combine;
148         $this->M_yui_loader->filter       = ($this->yui3loader->filter == YUI_DEBUG) ? 'debug' : '';
149         $this->M_yui_loader->insertBefore = 'firstthemesheet';
150         $this->M_yui_loader->modules      = array();
151         $this->add_yui2_modules(); // adds loading info for YUI2
152         $this->js_module($this->find_module('core_filepicker'));
153         $this->js_module($this->find_module('core_dock'));
155         // YUI3 init code
156         $libs = array('cssreset', 'cssbase', 'cssfonts', 'cssgrids', 'node', 'loader'); // full CSS reset + basic libs
157         foreach ($libs as $lib) {
158             $this->yui3loader->load($lib);
159         }
160     }
162     /**
163      * This method adds yui2 modules into the yui3 JS loader-
164      * @return void
165      */
166     protected function add_yui2_modules() {
167         //note: this function is definitely not perfect, because
168         //      it adds tons of markup into each page, but it can be
169         //      abstracted into separate JS file with proper headers
170         global $CFG;
172         $GLOBALS['yui_current'] = array();
173         require($CFG->libdir.'/yui/phploader/lib/meta/config_'.$CFG->yui2version.'.php');
174         $info = $GLOBALS['yui_current'];
175         unset($GLOBALS['yui_current']);
177         if (empty($CFG->yuicomboloading)) {
178             $urlbase = $this->yui2loader->base;
179         } else {
180             $urlbase = $this->yui2loader->comboBase.$CFG->yui2version.'/build/';
181         }
183         $modules = array();
184         $ignored = array(); // list of CSS modules that are not needed
185         foreach ($info['moduleInfo'] as $name => $module) {
186             if ($module['type'] === 'css') {
187                 $ignored[$name] = true;
188             } else {
189                 $modules['yui2-'.$name] = $module;
190             }
191         }
192         foreach ($modules as $name=>$module) {
193             $module['fullpath'] = $urlbase.$module['path']; // fix path to point to correct location
194             unset($module['path']);
195             foreach(array('requires', 'optional', 'supersedes') as $fixme) {
196                 if (!empty($module[$fixme])) {
197                     $fixed = false;
198                     foreach ($module[$fixme] as $key=>$dep) {
199                         if (isset($ignored[$dep])) {
200                             unset($module[$fixme][$key]);
201                             $fixed = true;
202                         } else {
203                             $module[$fixme][$key] = 'yui2-'.$dep;
204                         }
205                     }
206                     if ($fixed) {
207                         $module[$fixme] = array_merge($module[$fixme]); // fix keys
208                     }
209                 }
210             }
211             $this->M_yui_loader->modules[$name] = $module;
212         }
213     }
215     /**
216      * Initialise with the bits of JavaScript that every Moodle page should have.
217      *
218      * @param moodle_page $page
219      * @param core_renderer $output
220      */
221     protected function init_requirements_data(moodle_page $page, core_renderer $renderer) {
222         global $CFG;
224         // JavaScript should always work with $CFG->httpswwwroot rather than $CFG->wwwroot.
225         // Otherwise, in some situations, users will get warnings about insecure content
226         // on sercure pages from their web browser.
228         $this->M_cfg = array(
229             'wwwroot'             => $CFG->httpswwwroot, // Yes, really. See above.
230             'sesskey'             => sesskey(),
231             'loadingicon'         => $renderer->pix_url('i/loading_small', 'moodle')->out(false),
232             'themerev'            => theme_get_revision(),
233             'theme'               => $page->theme->name,
234         );
235         if (debugging('', DEBUG_DEVELOPER)) {
236             $this->M_cfg['developerdebug'] = true;
237         }
239         if (debugging('', DEBUG_DEVELOPER)) {
240             $this->yui2_lib('logger');
241         }
243         // accessibility stuff
244         $this->skip_link_to('maincontent', get_string('tocontent', 'access'));
246         // For now include YUI2, this will be removed before beta.
247         $this->yui2_lib('dom');        // needs to be migrated to YUI3 before we release 2.0
248         $this->yui2_lib('container');  // needs to be migrated to YUI3 before we release 2.0
249         $this->yui2_lib('connection'); // needs to be migrated to YUI3 before we release 2.0
251         $this->string_for_js('confirmation', 'admin');
252         $this->string_for_js('cancel', 'moodle');
253         $this->string_for_js('yes', 'moodle');
254         $this->js_function_call('init_help_icons');
255     }
257     /**
258      * Ensure that the specified JavaScript file is linked to from this page.
259      *
260      * NOTE: This function is to be used in rare cases only, please store your JS in module.js file
261      * and use $PAGE->requires->js_init_call() instead.
262      *
263      * By default the link is put at the end of the page, since this gives best page-load performance.
264      *
265      * Even if a particular script is requested more than once, it will only be linked
266      * to once.
267      *
268      * @param string|moodle_url $url The path to the .js file, relative to $CFG->dirroot / $CFG->wwwroot.
269      *      For example '/mod/mymod/customscripts.js'; use moodle_url for external scripts
270      * @param bool $inhead initialise in head
271      * @return void
272      */
273     public function js($url, $inhead=false) {
274         $url = $this->js_fix_url($url);
275         $where = $inhead ? 'head' : 'footer';
276         $this->jsincludes[$where][$url->out()] = $url;
277     }
279     /**
280      * Ensure that the specified YUI2 library file, and all its required dependancies,
281      * are linked to from this page.
282      *
283      * By default the link is put at the end of the page, since this gives best page-load
284      * performance. Optional dependencies are not loaded automatically - if you want
285      * them you will need to load them first with other calls to this method.
286      *
287      * Even if a particular library is requested more than once (perhaps as a dependancy
288      * of other libraries) it will only be linked to once.
289      *
290      * The library is leaded as soon as possible, if $OUTPUT->header() not used yet it
291      * is put into the page header, otherwise it is loaded in the page footer.
292      *
293      * @param string|array $libname the name of the YUI2 library you require. For example 'autocomplete'.
294      * @return void
295      */
296     public function yui2_lib($libname) {
297         $libnames = (array)$libname;
298         foreach ($libnames as $lib) {
299             $this->yui2loader->load($lib);
300         }
301     }
303     /**
304      * Returns the actual url through which a script is served.
305      * @param moodle_url|string $url full moodle url, or shortened path to script
306      * @return moodle_url
307      */
308     protected function js_fix_url($url) {
309         global $CFG;
311         if ($url instanceof moodle_url) {
312             return $url;
313         } else if (strpos($url, '/') === 0) {
314             if (debugging()) {
315                 // check file existence only when in debug mode
316                 if (!file_exists($CFG->dirroot . strtok($url, '?'))) {
317                     throw new coding_exception('Attept to require a JavaScript file that does not exist.', $url);
318                 }
319             }
320             //return new moodle_url($CFG->httpswwwroot.'/lib/javascript.php', array('file'=>$url, 'rev'=>$CFG->jsrev));
321             return new moodle_url($CFG->httpswwwroot.$url);
322         } else {
323             throw new coding_exception('Invalid JS url, it has to be shortened url starting with / or moodle_url instance.', $url);
324         }
325     }
327     /**
328      * Find out if JS modulke present and return details.
329      * @param string $name name of module, ex: core_group, mod_forum
330      * @return array description of module or null if not found
331      */
332     protected function find_module($name) {
333         global $CFG;
335         $module = null;
337         if (strpos($name, 'core_') === 0) {
338             // must be some core stuff
339             if ($name === 'core_filepicker') {
340                 $module = array('name'=>$name, 'fullpath'=>'/repository/filepicker.js', 'requires' => array('base', 'node', 'json', 'async-queue', 'io', 'yui2-button', 'yui2-container', 'yui2-layout', 'yui2-menu', 'yui2-treeview'));
341             } else if($name === 'core_comment') {
342                 $module = array('name'=>$name, 'fullpath'=>'/comment/comment.js', 'requires' => array('base', 'io', 'node', 'json', 'yui2-animation'));
343             } else if($name === 'core_role') {
344                 $module = array('name'=>$name, 'fullpath'=>'/admin/roles/module.js');
345             } else if($name === 'core_completion') {
346                 $module = array('name'=>$name, 'fullpath'=>'/course/completion.js');
347             } else if ($name === 'core_dock') {
348                 $module = array('name'=>'core_dock', 'fullpath'=>'/blocks/dock.js', 'requires'=>array('base', 'cookie', 'dom', 'io', 'node', 'event-custom'));
349             } else if ($name === 'core_calendar') {
350                 $module = array('name'=>'core_calendar', 'fullpath'=>'/calendar/calendar.js', 'requires'=>array('dom', 'event', 'node', 'yui2-container','event-mouseenter'));
351             } else if ($name === 'core_message') {
352                 $module = array('name'=>'core_message', 'fullpath'=>'/message/module.js');
353             } else if ($name === 'core_flashdetect') {
354                 $module = array('name'=>'core_flashdetect', 'fullpath'=>'/lib/flashdetect/flashdetect.js', 'requires'=>array('io'));
355             } else if ($name === 'core_dock') {
356                 $module = array('name'=>'core_dock', 'fullpath'=>'/blocks/dock.js', 'requires'=>array('base', 'cookie', 'dom', 'io', 'node', 'event-custom'));
357             }
358         } else {
359             if ($dir = get_component_directory($name, false)) {
360                 if (file_exists("$CFG->dirroot/$dir/module.js")) {
361                     $module = array('name'=>$name, 'fullpath'=>"/$dir/module.js", 'requires' => array());
362                 }
363             }
364         }
365         return $module;
366     }
368     /**
369      * Append YUI3 module to default YUI3 JS loader.
370      * The structure of module array is described at http://developer.yahoo.com/yui/3/yui/:
371      * @param string|array $module name of module (details are autodetected), or full module specification as array
372      * @return void
373      */
374     public function js_module($module) {
375         global $CFG;
377         if (empty($module)) {
378             throw new coding_exception('Missing YUI3 module name or full description.');
379         }
381         if (is_string($module)) {
382             $module = $this->find_module($module);
383         }
385         if (empty($module) or empty($module['name']) or empty($module['fullpath'])) {
386             throw new coding_exception('Missing YUI3 module details.');
387         }
389         $module['fullpath'] = $this->js_fix_url($module['fullpath'])->out();
391         if ($this->headdone) {
392             $this->extramodules[$module['name']] = $module;
393         } else {
394             $this->M_yui_loader->modules[$module['name']] = $module;
395         }
396     }
398     /**
399      * Ensure that the specified CSS file is linked to from this page.
400      *
401      * Because stylesheet links must go in the <head> part of the HTML, you must call
402      * this function before {@link get_head_code()} is called. That normally means before
403      * the call to print_header. If you call it when it is too late, an exception
404      * will be thrown.
405      *
406      * Even if a particular style sheet is requested more than once, it will only
407      * be linked to once.
408      *
409      * Please note sue of this feature is strongly discouraged,
410      * it is suitable only for places where CSS is submitted directly by teachers.
411      * (Students must not be allowed to submit any external CSS because it may
412      * contain embedded javascript!). Example of correct use is mod/data.
413      *
414      * @param string $stylesheet The path to the .css file, relative to $CFG->wwwroot.
415      *   For example:
416      *      $PAGE->requires->css('mod/data/css.php?d='.$data->id);
417      */
418     public function css($stylesheet) {
419         global $CFG;
421         if ($this->headdone) {
422             throw new coding_exception('Cannot require a CSS file after &lt;head> has been printed.', $stylesheet);
423         }
425         if ($stylesheet instanceof moodle_url) {
426             // ok
427         } else if (strpos($stylesheet, '/') === 0) {
428             $stylesheet = new moodle_url($CFG->httpswwwroot.$stylesheet);
429         } else {
430             throw new coding_exception('Invalid stylesheet parameter.', $stylesheet);
431         }
433         $this->cssurls[$stylesheet->out()] = $stylesheet; // overrides
434     }
436     /**
437      * Add theme stylkesheet to page - do not use from plugin code,
438      * this should be called only from the core renderer!
439      * @param moodle_url $stylesheet
440      * @return void
441      */
442     public function css_theme(moodle_url $stylesheet) {
443         $this->cssthemeurls[] = $stylesheet;
444     }
446     /**
447      * Ensure that a skip link to a given target is printed at the top of the <body>.
448      *
449      * You must call this function before {@link get_top_of_body_code()}, (if not, an exception
450      * will be thrown). That normally means you must call this before the call to print_header.
451      *
452      * If you ask for a particular skip link to be printed, it is then your responsibility
453      * to ensure that the appropraite <a name="..."> tag is printed in the body of the
454      * page, so that the skip link goes somewhere.
455      *
456      * Even if a particular skip link is requested more than once, only one copy of it will be output.
457      *
458      * @param $target the name of anchor this link should go to. For example 'maincontent'.
459      * @param $linktext The text to use for the skip link. Normally get_string('skipto', 'access', ...);
460      */
461     public function skip_link_to($target, $linktext) {
462         if ($this->topofbodydone) {
463             debugging('Page header already printed, can not add skip links any more, code needs to be fixed.');
464             return;
465         }
466         $this->skiplinks[$target] = $linktext;
467     }
469     /**
470      * Ensure that the specified JavaScript function is called from an inline script
471      * somewhere on this page.
472      *
473      * By default the call will be put in a script tag at the
474      * end of the page after initialising Y instance, since this gives best page-load
475      * performance and allows you to use YUI3 library.
476      *
477      * If you request that a particular function is called several times, then
478      * that is what will happen (unlike linking to a CSS or JS file, where only
479      * one link will be output).
480      *
481      * The main benefit of the mehtod is the automatic encoding of all function parameters.
482      *
483      * @param string $function the name of the JavaScritp function to call. Can
484      *      be a compound name like 'Y.Event.purgeElement'. Can also be
485      *      used to create and object by using a 'function name' like 'new user_selector'.
486      * @param array $arguments and array of arguments to be passed to the function.
487      *      When generating the function call, this will be escaped using json_encode,
488      *      so passing objects and arrays should work.
489      * @return required_js_function_call The required_js_function_call object.
490      *      This allows you to control when the link to the script is output by
491      *      calling methods like {@link required_js_function_call::in_head()},
492      *      {@link required_js_function_call::on_dom_ready()} or
493      *      {@link required_js_function_call::after_delay()} methods.
494      */
495     public function js_function_call($function, array $arguments = null) {
496         $requirement = new required_js_function_call($this, $function, $arguments);
497         $this->requiredjscode[] = $requirement;
498         return $requirement;
499     }
501     /**
502      * Ensure that the specified JavaScript function is called from an inline script
503      * from page footer.
504      *
505      * @param string $function the name of the JavaScritp function to with init code,
506      *      usually something like 'M.mod_mymodule.init'
507      * @param array $extraarguments and array of arguments to be passed to the function.
508      *      The first argument is always the YUI3 Y instance with all required dependencies
509      *      already loaded.
510      * @param bool $ondomready wait for dom ready (helps with some IE problems when modifying DOM)
511      * @param array $module JS module specification array
512      * @return void
513      */
514     public function js_init_call($function, array $extraarguments = null, $ondomready = false, array $module = null) {
515         $jscode = js_writer::function_call_with_Y($function, $extraarguments);
516         if (!$module) {
517             // detect module automatically
518             if (preg_match('/M\.([a-z0-9]+_[^\.]+)/', $function, $matches)) {
519                 $module = $this->find_module($matches[1]);
520             }
521         }
523         $this->js_init_code($jscode, $ondomready, $module);
524     }
526     /**
527      * Add short static javascript code fragment to page footer.
528      * This is intended primarily for loading of js modules and initialising page layout.
529      * Ideally the JS code fragment should be stored in plugin renderer so that themes
530      * may override it.
531      * @param string $jscode
532      * @param bool $ondomready wait for dom ready (helps with some IE problems when modifying DOM)
533      * @param array $module JS module specification array
534      * @return void
535      */
536     public function js_init_code($jscode, $ondomready = false, array $module = null) {
537         $jscode = trim($jscode, " ;\n"). ';';
539         if ($module) {
540             $this->js_module($module);
541             $modulename = $module['name'];
542             $jscode = "Y.use('$modulename', function(Y) { $jscode });";
543         }
545         if ($ondomready) {
546             $jscode = "Y.on('domready', function() { $jscode });";
547         }
549         $this->jsinitcode[] = $jscode;
550     }
552     /**
553      * Make a language string available to JavaScript.
554      *
555      * All the strings will be available in a mstr object in the global namespace.
556      * So, for example, after a call to $PAGE->requires->string_for_js('course', 'moodle');
557      * then the JavaScript variable mstr.moodle.course will be 'Course', or the
558      * equivalent in the current language.
559      *
560      * The arguments to this function are just like the arguments to get_string
561      * except that $component is not optional, and there are limitations on how you
562      * use $a. Because each string is only stored once in the JavaScript (based
563      * on $identifier and $module) you cannot get the same string with two different
564      * values of $a. If you try, an exception will be thrown.
565      *
566      * If you do need the same string expanded with different $a values, then
567      * the solution is to put them in your own data structure (e.g. and array)
568      * that you pass to JavaScript with {@link data_for_js()}.
569      *
570      * @param string $identifier the desired string.
571      * @param string $module the language file to look in.
572      * @param mixed $a any extra data to add into the string (optional).
573      */
574     public function string_for_js($identifier, $component, $a = NULL) {
575         $string = get_string($identifier, $component, $a);
576         if (!$component) {
577             throw new coding_exception('The $module parameter is required for page_requirements_manager::string_for_js.');
578         }
579         if (isset($this->stringsforjs[$component][$identifier]) && $this->stringsforjs[$component][$identifier] != $string) {
580             throw new coding_exception("Attempt to re-define already required string '$identifier' " .
581                     "from lang file '$component'. Did you already ask for it with a different \$a?");
582         }
583         $this->stringsforjs[$component][$identifier] = $string;
584     }
586     /**
587      * Make an array of language strings available for JS
588      *
589      * This function calls the above function {@link string_for_js()} for each requested
590      * string in the $identifiers array that is passed to the argument for a single module
591      * passed in $module.
592      *
593      * <code>
594      * $PAGE->strings_for_js(Array('one', 'two', 'three'), 'mymod', Array('a', null, 3));
595      *
596      * // The above is identifical to calling
597      *
598      * $PAGE->string_for_js('one', 'mymod', 'a');
599      * $PAGE->string_for_js('two', 'mymod');
600      * $PAGE->string_for_js('three', 'mymod', 3);
601      * </code>
602      *
603      * @param array $identifiers An array of desired strings
604      * @param string $component The module to load for
605      * @param mixed $a This can either be a single variable that gets passed as extra
606      *         information for every string or it can be an array of mixed data where the
607      *         key for the data matches that of the identifier it is meant for.
608      *
609      */
610     public function strings_for_js($identifiers, $component, $a=NULL) {
611         foreach ($identifiers as $key => $identifier) {
612             if (is_array($a) && array_key_exists($key, $a)) {
613                 $extra = $a[$key];
614             } else {
615                 $extra = $a;
616             }
617             $this->string_for_js($identifier, $component, $extra);
618         }
619     }
621     /**
622      * !!!!!!DEPRECATED!!!!!! please use js_init_call() for everything now.
623      *
624      * Make some data from PHP available to JavaScript code.
625      *
626      * For example, if you call
627      * <pre>
628      *      $PAGE->requires->data_for_js('mydata', array('name' => 'Moodle'));
629      * </pre>
630      * then in JavsScript mydata.name will be 'Moodle'.
631      * @param string $variable the the name of the JavaScript variable to assign the data to.
632      *      Will probably work if you use a compound name like 'mybuttons.button[1]', but this
633      *      should be considered an experimental feature.
634      * @param mixed $data The data to pass to JavaScript. This will be escaped using json_encode,
635      *      so passing objects and arrays should work.
636      * @param bool $inhead initialise in head
637      * @return void
638      */
639     public function data_for_js($variable, $data, $inhead=false) {
640         $where = $inhead ? 'head' : 'footer';
641         $this->jsinitvariables[$where][] = array($variable, $data);
642     }
644     /**
645      * Creates a YUI event handler.
646      *
647      * @param mixed $selector standard YUI selector for elemnts, may be array or string, element id is in the form "#idvalue"
648      * @param string $event A valid DOM event (click, mousedown, change etc.)
649      * @param string $function The name of the function to call
650      * @param array  $arguments An optional array of argument parameters to pass to the function
651      * @return void
652      */
653     public function event_handler($selector, $event, $function, array $arguments = null) {
654         $this->eventhandlers[] = array('selector'=>$selector, 'event'=>$event, 'function'=>$function, 'arguments'=>$arguments);
655     }
657     /**
658      * Returns code needed for registering of event handlers.
659      * @return string JS code
660      */
661     protected function get_event_handler_code() {
662         $output = '';
663         foreach ($this->eventhandlers as $h) {
664             $output .= js_writer::event_handler($h['selector'], $h['event'], $h['function'], $h['arguments']);
665         }
666         return $output;
667     }
669     /**
670      * Get the inline JavaScript code that need to appear in a particular place.
671      * @param $when one of the WHEN_... constants.
672      * @return string the javascript that should be output in that place.
673      */
674     protected function get_javascript_code($when, $indent = '') {
675         $output = '';
676         foreach ($this->requiredjscode as $requirement) {
677             if (!$requirement->is_done() && $requirement->get_when() == $when) {
678                 $output .= $indent . $requirement->get_js_code();
679                 $requirement->mark_done();
680             }
681         }
682         return $output;
683     }
685     /**
686      * Returns js code to be executed when Y is available.
687      * @return unknown_type
688      */
689     protected function get_javascript_init_code() {
690         if (count($this->jsinitcode)) {
691             return implode("\n", $this->jsinitcode) . "\n";
692         }
693         return '';
694     }
696     /**
697      * Returns basic YUI3 JS loading code.
698      * YUI3 is using autoloading of both CSS and JS code.
699      *
700      * Major benefit of this compared to standard js/csss loader is much improved
701      * caching, better browser cache utilisation, much fewer http requests.
702      *
703      * @return string
704      */
705     protected function get_yui3lib_headcode() {
706         $code = $this->yui3loader->css() . $this->yui3loader->script();
707         // unfortunately yui loader does not produce xhtml strict code, so let's fix it for now
708         $code = str_replace('&amp;', '&', $code);
709         $code = str_replace('&', '&amp;', $code);
710         return $code;
711     }
713     /**
714      * Returns basic YUI2 JS loading code.
715      * It can be called manually at any time.
716      * If called manually the result needs to be output using echo().
717      *
718      * Major benefit of this compared to standard js loader is much improved
719      * caching, better browser cache utilisation, much fewer http requests.
720      *
721      * All YUI2 CSS is loaded automatically.
722      *
723      * @return string JS embedding code
724      */
725     public function get_yui2lib_code() {
726         global $CFG;
728         if ($this->headdone) {
729             $code = $this->yui2loader->script_embed();
730         } else {
731             $code = $this->yui2loader->script();
732             if ($this->yui2loader->combine) {
733                 $skinurl = $this->yui2loader->comboBase . $CFG->yui2version . '/build/assets/skins/sam/skin.css';
734             } else {
735                 $skinurl = $this->yui2loader->base . 'assets/skins/sam/skin.css';
736             }
737             // please note this is a temporary hack until we fully migrate to later YUI3 that has all the widgets
738             $attributes = array('rel'=>'stylesheet', 'type'=>'text/css', 'href'=>$skinurl);
739             $code .= "\n" . html_writer::empty_tag('link', $attributes) . "\n";
740         }
741         $code = str_replace('&amp;', '&', $code);
742         $code = str_replace('&', '&amp;', $code);
743         return $code;
744     }
746     /**
747      * Returns html tags needed for inclusion of theme CSS
748      * @return string
749      */
750     protected function get_css_code() {
751         // First of all the theme CSS, then any custom CSS
752         // Please note custom CSS is strongly discouraged,
753         // because it can not be overridden by themes!
754         // It is suitable only for things like mod/data which accepts CSS from teachers.
756         $code = '';
757         $attributes = array('id'=>'firstthemesheet', 'rel'=>'stylesheet', 'type'=>'text/css');
759         $urls = $this->cssthemeurls + $this->cssurls;
761         foreach ($urls as $url) {
762             $attributes['href'] = $url;
763             $code .= html_writer::empty_tag('link', $attributes) . "\n";
764             // this id is needed in first sheet only so that theme may override YUI sheets laoded on the fly
765             unset($attributes['id']);
766         }
768         return $code;
769     }
771     /**
772      * Adds extra modules specified after printing of page header
773      */
774     protected function get_extra_modules_code() {
775         if (empty($this->extramodules)) {
776             return '';
777         }
778         return html_writer::script(js_writer::function_call('M.yui.add_module', array($this->extramodules)));
779     }
781     /**
782      * Generate any HTML that needs to go inside the <head> tag.
783      *
784      * Normally, this method is called automatically by the code that prints the
785      * <head> tag. You should not normally need to call it in your own code.
786      *
787      * @return string the HTML code to to inside the <head> tag.
788      */
789     public function get_head_code(moodle_page $page, core_renderer $renderer) {
790         global $CFG;
792         // note: the $page and $output are not stored here because it would
793         // create circular references in memory which prevents garbage collection
794         $this->init_requirements_data($page, $renderer);
796         // yui3 JS and CSS is always loaded first - it is cached in browser
797         $output = $this->get_yui3lib_headcode();
799         // BC: load basic YUI2 for now, all yui2 things should be loaded via Y.use('yui2-oldmodulename')
800         $output .= $this->get_yui2lib_code();
802         // now theme CSS + custom CSS in this specific order
803         $output .= $this->get_css_code();
805         // set up global YUI3 loader object - this should contain all code needed by plugins
806         // note: in JavaScript just use "YUI(M.yui.loader).use('overlay', function(Y) { .... });"
807         // this needs to be done before including any other script
808         $js = "var M = {}; M.yui = {}; ";
809         $js .= js_writer::set_variable('M.yui.loader', $this->M_yui_loader, false) . "\n";
810         $js .= js_writer::set_variable('M.cfg', $this->M_cfg, false);
811         $output .= html_writer::script($js);
813         // link our main JS file, all core stuff should be there
814         $output .= html_writer::script('', $CFG->httpswwwroot.'/lib/javascript-static.js');
816         // add variables
817         if ($this->jsinitvariables['head']) {
818             $js = '';
819             foreach ($this->jsinitvariables['head'] as $data) {
820                 list($var, $value) = $data;
821                 $js .= js_writer::set_variable($var, $value, true);
822             }
823             $output .= html_writer::script($js);
824         }
826         // all the other linked things from HEAD - there should be as few as possible
827         if ($this->jsincludes['head']) {
828             foreach ($this->jsincludes['head'] as $url) {
829                 $output .= html_writer::script('', $url);
830             }
831         }
833         // finally all JS that should go directly into head tag
834         $output .= html_writer::script($this->get_javascript_code(self::WHEN_IN_HEAD));
836         // mark head sending done, it is not possible to anything there
837         $this->headdone = true;
839         return $output;
840     }
842     /**
843      * Generate any HTML that needs to go at the start of the <body> tag.
844      *
845      * Normally, this method is called automatically by the code that prints the
846      * <head> tag. You should not normally need to call it in your own code.
847      *
848      * @return string the HTML code to go at the start of the <body> tag.
849      */
850     public function get_top_of_body_code() {
851                 // first the skip links
852         $links = '';
853         $attributes = array('class'=>'skip');
854         foreach ($this->skiplinks as $url => $text) {
855             $attributes['href'] = '#' . $url;
856             $links .= html_writer::tag('a', $attributes, $text);
857         }
858         $output = html_writer::tag('div', array('class'=>'skiplinks'), $links) . "\n";
860         // then the clever trick for hiding of things not needed when JS works
861         $output .= html_writer::script("document.body.className += ' jsenabled';") . "\n";
862         $this->topofbodydone = true;
863         return $output;
864     }
866     /**
867      * Generate any HTML that needs to go at the end of the page.
868      *
869      * Normally, this method is called automatically by the code that prints the
870      * page footer. You should not normally need to call it in your own code.
871      *
872      * @return string the HTML code to to at the end of the page.
873      */
874     public function get_end_code() {
875         global $CFG;
876         // add other requested modules
877         $output = $this->get_extra_modules_code();
879         // add missing YUI2 YUI - to be removed once we convert everything to YUI3!
880         $output .= $this->get_yui2lib_code();
882         // all the other linked scripts - there should be as few as possible
883         if ($this->jsincludes['footer']) {
884             foreach ($this->jsincludes['footer'] as $url) {
885                 $output .= html_writer::script('', $url);
886             }
887         }
889         // add all needed strings
890         if (!empty($this->stringsforjs)) {
891             $output .= html_writer::script(js_writer::set_variable('mstr', $this->stringsforjs));
892         }
894         // add variables
895         if ($this->jsinitvariables['footer']) {
896             $js = '';
897             foreach ($this->jsinitvariables['footer'] as $data) {
898                 list($var, $value) = $data;
899                 $js .= js_writer::set_variable($var, $value, true);
900             }
901             $output .= html_writer::script($js);
902         }
904         $js = $this->get_javascript_code(self::WHEN_AT_END);
906         $inyuijs = $this->get_javascript_code(self::WHEN_IN_YUI, '    ');
907         $ondomreadyjs = $this->get_javascript_code(self::WHEN_ON_DOM_READY, '        ');
908         $jsinit = $this->get_javascript_init_code();
909         $handlersjs = $this->get_event_handler_code();
911         if (!empty($ondomreadyjs)) {
912              $ondomreadyjs = "    Y.on('domready', function() {\n$ondomreadyjs\n    });";
913         }
915         // the global Y can be used only after it is fully loaded, that means
916         // from code executed from the following block
917         $js .= "YUI(M.yui.loader).use('node', function(Y) {\n{$inyuijs}{$ondomreadyjs}{$jsinit}{$handlersjs}\n});";
919         $output .= html_writer::script($js);
921         return $output;
922     }
924     /**
925      * @return boolean Have we already output the code in the <head> tag?
926      */
927     public function is_head_done() {
928         return $this->headdone;
929     }
931     /**
932      * @return boolean Have we already output the code at the start of the <body> tag?
933      */
934     public function is_top_of_body_done() {
935         return $this->topofbodydone;
936     }
940 /**
941  * This is the base class for all sorts of requirements. just to factor out some
942  * common code.
943  *
944  * @copyright 2009 Tim Hunt
945  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
946  * @since Moodle 2.0
947  */
948 abstract class requirement_base {
949     protected $manager;
950     protected $when;
951     protected $done = false;
953     /**
954      * Constructor. Normally the class and its subclasses should not be created
955      * directly. Client code should create them via a page_requirements_manager
956      * method like ->js(...).
957      *
958      * @param page_requirements_manager $manager the page_requirements_manager we are associated with.
959      */
960     protected function __construct(page_requirements_manager $manager) {
961         $this->manager = $manager;
962     }
964     /**
965      * Mark that this requirement has been satisfied (that is, that the HTML
966      * returned by {@link get_html()} has been output.
967      * @return boolean has this requirement been satisfied yet? That is, has
968      *      that the HTML returned by {@link get_html()} has been output already.
969      */
970     public function is_done() {
971         return $this->done;
972     }
974     /**
975      * Mark that this requirement has been satisfied (that is, that the HTML
976      * returned by {@link get_html()} has been output.
977      */
978     public function mark_done() {
979         $this->done = true;
980     }
982     /**
983      * Where on the page the HTML this requirement is meant to go.
984      * @return integer One of the {@link page_requirements_manager}::WHEN_... constants.
985      */
986     public function get_when() {
987         return $this->when;
988     }
991 /**
992  * This class represents something that must be output somewhere in the HTML.
993  *
994  * Examples include links to JavaScript or CSS files. However, it should not
995  * necessarily be output immediately, we may have to wait for an appropriate time.
996  *
997  * @copyright 2009 Tim Hunt
998  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
999  * @since Moodle 2.0
1000  */
1001 abstract class linked_requirement extends requirement_base {
1002     protected $url;
1004     /**
1005      * Constructor. Normally the class and its subclasses should not be created
1006      * directly. Client code should create them via a page_requirements_manager
1007      * method like ->js(...).
1008      *
1009      * @param page_requirements_manager $manager the page_requirements_manager we are associated with.
1010      * @param string $url The URL of the thing we are linking to.
1011      */
1012     protected function __construct(page_requirements_manager $manager, $url) {
1013         parent::__construct($manager);
1014         $this->url = $url;
1015     }
1017     /**
1018      * @return string the HTML needed to satisfy this requirement.
1019      */
1020     abstract public function get_html();
1024 /**
1025  * This is the base class for requirements that are JavaScript code.
1026  *
1027  * @copyright 2009 Tim Hunt
1028  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1029  * @since Moodle 2.0
1030  */
1031 abstract class required_js_code extends requirement_base {
1033     /**
1034      * Constructor.
1035      * @param page_requirements_manager $manager the page_requirements_manager we are associated with.
1036      */
1037     protected function __construct(page_requirements_manager $manager) {
1038         parent::__construct($manager);
1039         $this->when = page_requirements_manager::WHEN_AT_END;
1040     }
1042     /**
1043      * @return string the JavaScript code needed to satisfy this requirement.
1044      */
1045     abstract public function get_js_code();
1047     /**
1048      * Indicate that the link to this JavaScript file should be output in the
1049      * <head> section of the HTML. If it too late for this request to be
1050      * satisfied, an exception is thrown.
1051      */
1052     public function in_head() {
1053         if ($this->is_done() || $this->when <= page_requirements_manager::WHEN_IN_HEAD) {
1054             return;
1055         }
1056         if ($this->manager->is_head_done()) {
1057             throw new coding_exception('Too late to ask for some JavaScript code to be output in &lt;head>.');
1058         }
1059         $this->when = page_requirements_manager::WHEN_IN_HEAD;
1060     }
1064 /**
1065  * This class represents a JavaScript function that must be called from the HTML
1066  * page. By default the call will be made at the end of the page when YUI initialised,
1067  * but you can chage that using the {@link in_head()}, etc. methods.
1068  *
1069  * @copyright 2009 Tim Hunt
1070  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1071  * @since Moodle 2.0
1072  */
1073 class required_js_function_call extends required_js_code {
1074     protected $function;
1075     protected $arguments;
1076     protected $delay = 0;
1078     /**
1079      * Constructor. Normally instances of this class should not be created directly.
1080      * Client code should create them via the page_requirements_manager
1081      * method {@link page_requirements_manager::js_function_call()}.
1082      *
1083      * @param page_requirements_manager $manager the page_requirements_manager we are associated with.
1084      * @param string $function the name of the JavaScritp function to call.
1085      *      Can be a compound name like 'Y.Event.purgeElement'. Do not use old YUI2 YAHOO. function names.
1086      * @param array $arguments and array of arguments to be passed to the function.
1087      *      When generating the function call, this will be escaped using json_encode,
1088      *      so passing objects and arrays should work.
1089      */
1090     public function __construct(page_requirements_manager $manager, $function, $arguments) {
1091         parent::__construct($manager);
1092         $this->when = page_requirements_manager::WHEN_IN_YUI;
1093         $this->function = $function;
1094         $this->arguments = $arguments;
1095     }
1097     public function get_js_code() {
1098         return js_writer::function_call($this->function, $this->arguments, $this->delay);
1099     }
1101     /**
1102      * Indicate that this function should be called in YUI's onDomReady event.
1103      *
1104      * Thisis needed mostly for buggy IE browsers because they have problems
1105      * when JS starts modifying DOM structure before the DOM is ready.
1106      */
1107     public function on_dom_ready() {
1108         if ($this->is_done() || $this->when < page_requirements_manager::WHEN_IN_YUI) {
1109             return;
1110         }
1111         $this->when = page_requirements_manager::WHEN_ON_DOM_READY;
1112     }
1114     /**
1115      * Indicate that this function should be called a certain number of seconds
1116      * after the page has finished loading. (More exactly, a number of seconds
1117      * after the onDomReady event fires.)
1118      *
1119      * @param integer $seconds the number of seconds delay.
1120      */
1121     public function after_delay($seconds) {
1122         if ($seconds) {
1123             $this->on_dom_ready();
1124         }
1125         $this->delay = $seconds;
1126     }
1130 /**
1131  * Returns whether ajax is enabled/allowed or not.
1132  */
1133 function ajaxenabled($browsers = array()) {
1135     global $CFG, $USER;
1137     if (!empty($browsers)) {
1138         $valid = false;
1139         foreach ($browsers as $brand => $version) {
1140             if (check_browser_version($brand, $version)) {
1141                 $valid = true;
1142             }
1143         }
1145         if (!$valid) {
1146             return false;
1147         }
1148     }
1150     $ie = check_browser_version('MSIE', 6.0);
1151     $ff = check_browser_version('Gecko', 20051106);
1152     $op = check_browser_version('Opera', 9.0);
1153     $sa = check_browser_version('Safari', 412);
1155     if (!$ie && !$ff && !$op && !$sa) {
1156         /** @see http://en.wikipedia.org/wiki/User_agent */
1157         // Gecko build 20051107 is what is in Firefox 1.5.
1158         // We still have issues with AJAX in other browsers.
1159         return false;
1160     }
1162     if (!empty($CFG->enableajax) && (!empty($USER->ajax) || !isloggedin())) {
1163         return true;
1164     } else {
1165         return false;
1166     }
1170 /**
1171  * Used to create view of document to be passed to JavaScript on pageload.
1172  * We use this class to pass data from PHP to JavaScript.
1173  */
1174 class jsportal {
1176     var $currentblocksection = null;
1177     var $blocks = array();
1180     /**
1181      * Takes id of block and adds it
1182      */
1183     function block_add($id, $hidden=false){
1184         $hidden_binary = 0;
1186         if ($hidden) {
1187             $hidden_binary = 1;
1188         }
1189         $this->blocks[count($this->blocks)] = array($this->currentblocksection, $id, $hidden_binary);
1190     }
1193     /**
1194      * Prints the JavaScript code needed to set up AJAX for the course.
1195      */
1196     function print_javascript($courseid, $return=false) {
1197         global $CFG, $USER, $OUTPUT, $COURSE;
1199         $blocksoutput = $output = '';
1200         for ($i=0; $i<count($this->blocks); $i++) {
1201             $blocksoutput .= "['".$this->blocks[$i][0]."',
1202                              '".$this->blocks[$i][1]."',
1203                              '".$this->blocks[$i][2]."']";
1205             if ($i != (count($this->blocks) - 1)) {
1206                 $blocksoutput .= ',';
1207             }
1208         }
1209         $output .= "<script type=\"text/javascript\">\n";
1210         $output .= "    main.portal.id = ".$courseid.";\n";
1211         $output .= "    main.portal.blocks = new Array(".$blocksoutput.");\n";
1212         $output .= "    main.portal.strings['courseformat']='".$COURSE->format."';\n";
1213         $output .= "    main.portal.strings['wwwroot']='".$CFG->wwwroot."';\n";
1214         $output .= "    main.portal.strings['marker']='".get_string('markthistopic', '', '_var_')."';\n";
1215         $output .= "    main.portal.strings['marked']='".get_string('markedthistopic', '', '_var_')."';\n";
1216         $output .= "    main.portal.numsections = ".$COURSE->numsections.";\n";
1217         $output .= "    main.portal.strings['hide']='".get_string('hide')."';\n";
1218         $output .= "    main.portal.strings['hidesection']='".get_string('hidesection', '', '_var_')."';\n";
1219         $output .= "    main.portal.strings['show']='".get_string('show')."';\n";
1220         $output .= "    main.portal.strings['delete']='".get_string('delete')."';\n";
1221         $output .= "    main.portal.strings['move']='".get_string('move')."';\n";
1222         $output .= "    main.portal.strings['movesection']='".get_string('movesection', '', '_var_')."';\n";
1223         $output .= "    main.portal.strings['moveleft']='".get_string('moveleft')."';\n";
1224         $output .= "    main.portal.strings['moveright']='".get_string('moveright')."';\n";
1225         $output .= "    main.portal.strings['update']='".get_string('update')."';\n";
1226         $output .= "    main.portal.strings['groupsnone']='".get_string('groupsnone')."';\n";
1227         $output .= "    main.portal.strings['groupsseparate']='".get_string('groupsseparate')."';\n";
1228         $output .= "    main.portal.strings['groupsvisible']='".get_string('groupsvisible')."';\n";
1229         $output .= "    main.portal.strings['clicktochange']='".get_string('clicktochange')."';\n";
1230         $output .= "    main.portal.strings['deletecheck']='".get_string('deletecheck','','_var_')."';\n";
1231         $output .= "    main.portal.strings['resource']='".get_string('resource')."';\n";
1232         $output .= "    main.portal.strings['activity']='".get_string('activity')."';\n";
1233         $output .= "    main.portal.strings['sesskey']='".sesskey()."';\n";
1234         $output .= "    main.portal.icons['spacerimg']='".$OUTPUT->pix_url('spaces')."';\n";
1235         $output .= "    main.portal.icons['marker']='".$OUTPUT->pix_url('i/marker')."';\n";
1236         $output .= "    main.portal.icons['ihide']='".$OUTPUT->pix_url('i/hide')."';\n";
1237         $output .= "    main.portal.icons['move_2d']='".$OUTPUT->pix_url('i/move_2d')."';\n";
1238         $output .= "    main.portal.icons['show']='".$OUTPUT->pix_url('t/show')."';\n";
1239         $output .= "    main.portal.icons['hide']='".$OUTPUT->pix_url('t/hide')."';\n";
1240         $output .= "    main.portal.icons['delete']='".$OUTPUT->pix_url('t/delete')."';\n";
1241         $output .= "    main.portal.icons['groupn']='".$OUTPUT->pix_url('t/groupn')."';\n";
1242         $output .= "    main.portal.icons['groups']='".$OUTPUT->pix_url('t/groups')."';\n";
1243         $output .= "    main.portal.icons['groupv']='".$OUTPUT->pix_url('t/groupv')."';\n";
1244         if (right_to_left()) {
1245             $output .= "    main.portal.icons['backwards']='".$OUTPUT->pix_url('t/right')."';\n";
1246             $output .= "    main.portal.icons['forwards']='".$OUTPUT->pix_url('t/left')."';\n";
1247         } else {
1248             $output .= "    main.portal.icons['backwards']='".$OUTPUT->pix_url('t/left')."';\n";
1249             $output .= "    main.portal.icons['forwards']='".$OUTPUT->pix_url('t/right')."';\n";
1250         }
1252         $output .= "    onloadobj.load();\n";
1253         $output .= "    main.process_blocks();\n";
1254         $output .= "</script>";
1255         if ($return) {
1256             return $output;
1257         } else {
1258             echo $output;
1259         }
1260     }