MDL-36900 files: D&D upload uses new file name increment function
[moodle.git] / lib / outputrequirementslib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Library functions to facilitate the use of JavaScript in Moodle.
19  *
20  * Note: you can find history of this file in lib/ajax/ajaxlib.php
21  *
22  * @copyright 2009 Tim Hunt, 2010 Petr Skoda
23  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  * @package core
25  * @category output
26  */
28 defined('MOODLE_INTERNAL') || die();
30 /**
31  * This class tracks all the things that are needed by the current page.
32  *
33  * Normally, the only instance of this  class you will need to work with is the
34  * one accessible via $PAGE->requires.
35  *
36  * Typical usage would be
37  * <pre>
38  *     $PAGE->requires->js_init_call('M.mod_forum.init_view');
39  * </pre>
40  *
41  * It also supports obsoleted coding style withouth YUI3 modules.
42  * <pre>
43  *     $PAGE->requires->css('/mod/mymod/userstyles.php?id='.$id); // not overridable via themes!
44  *     $PAGE->requires->js('/mod/mymod/script.js');
45  *     $PAGE->requires->js('/mod/mymod/small_but_urgent.js', true);
46  *     $PAGE->requires->js_function_call('init_mymod', array($data), true);
47  * </pre>
48  *
49  * There are some natural restrictions on some methods. For example, {@link css()}
50  * can only be called before the <head> tag is output. See the comments on the
51  * individual methods for details.
52  *
53  * @copyright 2009 Tim Hunt, 2010 Petr Skoda
54  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
55  * @since Moodle 2.0
56  * @package core
57  * @category output
58  */
59 class page_requirements_manager {
61     /**
62      * @var array List of string available from JS
63      */
64     protected $stringsforjs = array();
66     /**
67      * @var array List of get_string $a parameters - used for validation only.
68      */
69     protected $stringsforjs_as = array();
71     /**
72      * @var array List of JS variables to be initialised
73      */
74     protected $jsinitvariables = array('head'=>array(), 'footer'=>array());
76     /**
77      * @var array Included JS scripts
78      */
79     protected $jsincludes = array('head'=>array(), 'footer'=>array());
81     /**
82      * @var array List of needed function calls
83      */
84     protected $jscalls = array('normal'=>array(), 'ondomready'=>array());
86     /**
87      * @var array List of skip links, those are needed for accessibility reasons
88      */
89     protected $skiplinks = array();
91     /**
92      * @var array Javascript code used for initialisation of page, it should
93      * be relatively small
94      */
95     protected $jsinitcode = array();
97     /**
98      * @var array of moodle_url Theme sheets, initialised only from core_renderer
99      */
100     protected $cssthemeurls = array();
102     /**
103      * @var array of moodle_url List of custom theme sheets, these are strongly discouraged!
104      * Useful mostly only for CSS submitted by teachers that is not part of the theme.
105      */
106     protected $cssurls = array();
108     /**
109      * @var array List of requested event handlers
110      */
111     protected $eventhandlers = array();
113     /**
114      * @var array Extra modules
115      */
116     protected $extramodules = array();
118     /**
119      * @var bool Flag indicated head stuff already printed
120      */
121     protected $headdone = false;
123     /**
124      * @var bool Flag indicating top of body already printed
125      */
126     protected $topofbodydone = false;
128     /**
129      * @var stdClass YUI PHPLoader instance responsible for YUI3 loading from PHP only
130      */
131     protected $yui3loader;
133     /**
134      * @var stdClass default YUI loader configuration
135      */
136     protected $YUI_config;
138     /**
139      * @var array Some config vars exposed in JS, please no secret stuff there
140      */
141     protected $M_cfg;
143     /**
144      * @var array Stores debug backtraces from when JS modules were included in the page
145      */
146     protected $debug_moduleloadstacktraces = array();
148     /**
149      * Page requirements constructor.
150      */
151     public function __construct() {
152         global $CFG;
154         // You may need to set up URL rewrite rule because oversized URLs might not be allowed by web server.
155         $sep = empty($CFG->yuislasharguments) ? '?' : '/';
157         $this->yui3loader = new stdClass();
158         $this->YUI_config = new stdClass();
160         // Set up some loader options.
161         if (debugging('', DEBUG_DEVELOPER)) {
162             $this->yui3loader->filter = 'RAW'; // For more detailed logging info use 'DEBUG' here.
163             $this->YUI_config->debug = true;
164         } else {
165             $this->yui3loader->filter = null;
166             $this->YUI_config->debug = false;
167         }
168         if (!empty($CFG->useexternalyui) and strpos($CFG->httpswwwroot, 'https:') !== 0) {
169             $this->yui3loader->base = 'http://yui.yahooapis.com/' . $CFG->yui3version . '/build/';
170             $this->yui3loader->comboBase = 'http://yui.yahooapis.com/combo?';
171         } else {
172             $this->yui3loader->base = $CFG->httpswwwroot . '/lib/yuilib/'. $CFG->yui3version . '/build/';
173             $this->yui3loader->comboBase = $CFG->httpswwwroot . '/theme/yui_combo.php'.$sep;
174         }
176         // Enable combo loader? This significantly helps with caching and performance!
177         $this->yui3loader->combine = !empty($CFG->yuicomboloading);
179         if (empty($CFG->cachejs)) {
180             $jsrev = -1;
181         } else if (empty($CFG->jsrev)) {
182             $jsrev = 1;
183         } else {
184             $jsrev = $CFG->jsrev;
185         }
187         // Set up JS YUI loader helper object.
188         $this->YUI_config->base         = $this->yui3loader->base;
189         $this->YUI_config->comboBase    = $this->yui3loader->comboBase;
190         $this->YUI_config->combine      = $this->yui3loader->combine;
191         $this->YUI_config->filter       = (string)$this->yui3loader->filter;
192         $this->YUI_config->insertBefore = 'firstthemesheet';
193         $this->YUI_config->modules      = array();
194         $this->YUI_config->groups       = array(
195             // Loader for our YUI modules stored in /yui/ subdirectories of our plugins and subsystems.
196             'moodle' => array(
197                 'name' => 'moodle',
198                 'base' => $CFG->httpswwwroot . '/theme/yui_combo.php'.$sep.'moodle/'.$jsrev.'/',
199                 'comboBase' => $CFG->httpswwwroot . '/theme/yui_combo.php'.$sep,
200                 'combine' => $this->yui3loader->combine,
201                 'ext' => false,
202                 'root' => 'moodle/'.$jsrev.'/', // Add the rev to the root path so that we can control caching.
203                 'patterns' => array(
204                     'moodle-' => array(
205                         'group' => 'moodle',
206                         'configFn' => '@MOODLECONFIGFN@'
207                     )
208                 )
209             ),
210             // Gallery modules are not supported much, sorry.
211             'local' => array(
212                 'name' => 'gallery',
213                 'base' => $CFG->httpswwwroot . '/lib/yui/gallery/',
214                 'comboBase' => $CFG->httpswwwroot . '/theme/yui_combo.php'.$sep,
215                 'combine' => $this->yui3loader->combine,
216                 'filter' => $this->YUI_config->filter,
217                 'ext' => false,
218                 'root' => 'gallery/',
219                 'patterns' => array(
220                     'gallery-' => array(
221                         'group' => 'gallery',
222                         'configFn' => '@GALLERYCONFIGFN@',
223                     )
224                 )
225             ),
226             // Loader configuration for our 2in3, for now ignores $CFG->useexternalyui.
227             'yui2' => array(
228                 'base' => $CFG->httpswwwroot . '/lib/yuilib/2in3/' . $CFG->yui2version . '/build/',
229                 'comboBase' => $CFG->httpswwwroot . '/theme/yui_combo.php'.$sep,
230                 'combine' => $this->yui3loader->combine,
231                 'ext' => false,
232                 'root' => '2in3/' . $CFG->yui2version .'/build/',
233                 'patterns' => array(
234                     'yui2-' => array(
235                         'group' => 'yui2',
236                         'configFn' => '@2IN3CONFIGFN@'
237                     )
238                 )
239             )
240         );
242         // Every page should include definition of following modules.
243         $this->js_module($this->find_module('core_filepicker'));
244         $this->js_module($this->find_module('core_dock'));
245     }
247     /**
248      * Initialise with the bits of JavaScript that every Moodle page should have.
249      *
250      * @param moodle_page $page
251      * @param core_renderer $renderer
252      */
253     protected function init_requirements_data(moodle_page $page, core_renderer $renderer) {
254         global $CFG;
256         // JavaScript should always work with $CFG->httpswwwroot rather than $CFG->wwwroot.
257         // Otherwise, in some situations, users will get warnings about insecure content
258         // on secure pages from their web browser.
260         $this->M_cfg = array(
261             'wwwroot'             => $CFG->httpswwwroot, // Yes, really. See above.
262             'sesskey'             => sesskey(),
263             'loadingicon'         => $renderer->pix_url('i/loading_small', 'moodle')->out(false),
264             'themerev'            => theme_get_revision(),
265             'slasharguments'      => (int)(!empty($CFG->slasharguments)),
266             'theme'               => $page->theme->name,
267             'jsrev'               => ((empty($CFG->cachejs) or empty($CFG->jsrev)) ? -1 : $CFG->jsrev),
268             'svgicons'            => $page->theme->use_svg_icons()
269         );
270         if (debugging('', DEBUG_DEVELOPER)) {
271             $this->M_cfg['developerdebug'] = true;
272         }
274         // Accessibility stuff.
275         $this->skip_link_to('maincontent', get_string('tocontent', 'access'));
277         // Add strings used on many pages.
278         $this->string_for_js('confirmation', 'admin');
279         $this->string_for_js('cancel', 'moodle');
280         $this->string_for_js('yes', 'moodle');
282         // Alter links in top frame to break out of frames.
283         if ($page->pagelayout === 'frametop') {
284             $this->js_init_call('M.util.init_frametop');
285         }
287         // Include block drag/drop if editing is on
288         if ($page->user_is_editing()) {
289             $params = array(
290                 'courseid' => $page->course->id,
291                 'pagetype' => $page->pagetype,
292                 'pagelayout' => $page->pagelayout,
293                 'subpage' => $page->subpage,
294                 'regions' => $page->blocks->get_regions(),
295                 'contextid' => $page->context->id,
296             );
297             if (!empty($page->cm->id)) {
298                 $params['cmid'] = $page->cm->id;
299             }
300             $page->requires->yui_module('moodle-core-blocks', 'M.core_blocks.init_dragdrop', array($params), null, true);
301         }
302     }
304     /**
305      * Ensure that the specified JavaScript file is linked to from this page.
306      *
307      * NOTE: This function is to be used in RARE CASES ONLY, please store your JS in module.js file
308      * and use $PAGE->requires->js_init_call() instead or use /yui/ subdirectories for YUI modules.
309      *
310      * By default the link is put at the end of the page, since this gives best page-load performance.
311      *
312      * Even if a particular script is requested more than once, it will only be linked
313      * to once.
314      *
315      * @param string|moodle_url $url The path to the .js file, relative to $CFG->dirroot / $CFG->wwwroot.
316      *      For example '/mod/mymod/customscripts.js'; use moodle_url for external scripts
317      * @param bool $inhead initialise in head
318      */
319     public function js($url, $inhead = false) {
320         $url = $this->js_fix_url($url);
321         $where = $inhead ? 'head' : 'footer';
322         $this->jsincludes[$where][$url->out()] = $url;
323     }
325     /**
326      * This method was used to load YUI2 libraries into global scope,
327      * use YUI 2in3 instead. Every YUI2 module is represented as a yui2-*
328      * sandboxed module in YUI3 code via Y.YUI2. property.
329      *
330      * {@see http://tracker.moodle.org/browse/MDL-34741}
331      *
332      * @param string|array $libname
333      * @deprecated since 2.4
334      */
335     public function yui2_lib($libname) {
336         throw new coding_exception('PAGE->yui2_lib() is not available any more, use YUI 2in3 instead, see MDL-34741 for more information.');
337     }
339     /**
340      * Returns the actual url through which a script is served.
341      *
342      * @param moodle_url|string $url full moodle url, or shortened path to script
343      * @return moodle_url
344      */
345     protected function js_fix_url($url) {
346         global $CFG;
348         if ($url instanceof moodle_url) {
349             return $url;
350         } else if (strpos($url, '/') === 0) {
351             // Fix the admin links if needed.
352             if ($CFG->admin !== 'admin') {
353                 if (strpos($url, "/admin/") === 0) {
354                     $url = preg_replace("|^/admin/|", "/$CFG->admin/", $url);
355                 }
356             }
357             if (debugging()) {
358                 // Check file existence only when in debug mode.
359                 if (!file_exists($CFG->dirroot . strtok($url, '?'))) {
360                     throw new coding_exception('Attempt to require a JavaScript file that does not exist.', $url);
361                 }
362             }
363             if (!empty($CFG->cachejs) and !empty($CFG->jsrev) and $CFG->jsrev > 0 and substr($url, -3) === '.js') {
364                 if (empty($CFG->slasharguments)) {
365                     return new moodle_url($CFG->httpswwwroot.'/lib/javascript.php', array('rev'=>$CFG->jsrev, 'jsfile'=>$url));
366                 } else {
367                     $returnurl = new moodle_url($CFG->httpswwwroot.'/lib/javascript.php');
368                     $returnurl->set_slashargument('/'.$CFG->jsrev.$url);
369                     return $returnurl;
370                 }
371             } else {
372                 return new moodle_url($CFG->httpswwwroot.$url);
373             }
374         } else {
375             throw new coding_exception('Invalid JS url, it has to be shortened url starting with / or moodle_url instance.', $url);
376         }
377     }
379     /**
380      * Find out if JS module present and return details.
381      *
382      * @param string $component name of component in frankenstyle, ex: core_group, mod_forum
383      * @return array description of module or null if not found
384      */
385     protected function find_module($component) {
386         global $CFG, $PAGE;
388         $module = null;
390         if (strpos($component, 'core_') === 0) {
391             // Must be some core stuff - list here is not complete, this is just the stuff used from multiple places
392             // so that we do nto have to repeat the definition of these modules over and over again.
393             switch($component) {
394                 case 'core_filepicker':
395                     $module = array('name'     => 'core_filepicker',
396                                     'fullpath' => '/repository/filepicker.js',
397                                     'requires' => array('base', 'node', 'node-event-simulate', 'json', 'async-queue', 'io-base', 'io-upload-iframe', 'io-form', 'yui2-treeview', 'panel', 'cookie', 'datatable', 'datatable-sort', 'resize-plugin', 'dd-plugin', 'escape', 'moodle-core_filepicker'),
398                                     'strings'  => array(array('lastmodified', 'moodle'), array('name', 'moodle'), array('type', 'repository'), array('size', 'repository'),
399                                                         array('invalidjson', 'repository'), array('error', 'moodle'), array('info', 'moodle'),
400                                                         array('nofilesattached', 'repository'), array('filepicker', 'repository'), array('logout', 'repository'),
401                                                         array('nofilesavailable', 'repository'), array('norepositoriesavailable', 'repository'),
402                                                         array('fileexistsdialogheader', 'repository'), array('fileexistsdialog_editor', 'repository'),
403                                                         array('fileexistsdialog_filemanager', 'repository'), array('renameto', 'repository'),
404                                                         array('referencesexist', 'repository')
405                                                     ));
406                     break;
407                 case 'core_comment':
408                     $module = array('name'     => 'core_comment',
409                                     'fullpath' => '/comment/comment.js',
410                                     'requires' => array('base', 'io-base', 'node', 'json', 'yui2-animation', 'overlay'),
411                                     'strings' => array(array('confirmdeletecomments', 'admin'), array('yes', 'moodle'), array('no', 'moodle'))
412                                 );
413                     break;
414                 case 'core_role':
415                     $module = array('name'     => 'core_role',
416                                     'fullpath' => '/admin/roles/module.js',
417                                     'requires' => array('node', 'cookie'));
418                     break;
419                 case 'core_completion':
420                     $module = array('name'     => 'core_completion',
421                                     'fullpath' => '/course/completion.js');
422                     break;
423                 case 'core_dock':
424                     $module = array('name'     => 'core_dock',
425                                     'fullpath' => '/blocks/dock.js',
426                                     'requires' => array('base', 'node', 'event-custom', 'event-mouseenter', 'event-resize'),
427                                     'strings' => array(array('addtodock', 'block'),array('undockitem', 'block'),array('undockblock', 'block'),array('undockall', 'block'),array('thisdirectionvertical', 'langconfig'),array('hidedockpanel', 'block'),array('hidepanel', 'block')));
428                     break;
429                 case 'core_message':
430                     $module = array('name'     => 'core_message',
431                                     'requires' => array('base', 'node', 'event', 'node-event-simulate'),
432                                     'fullpath' => '/message/module.js');
433                     break;
434                 case 'core_group':
435                     $module = array('name'     => 'core_group',
436                                     'fullpath' => '/group/module.js',
437                                     'requires' => array('node', 'overlay', 'event-mouseenter'));
438                     break;
439                 case 'core_question_engine':
440                     $module = array('name'     => 'core_question_engine',
441                                     'fullpath' => '/question/qengine.js',
442                                     'requires' => array('node', 'event'));
443                     break;
444                 case 'core_rating':
445                     $module = array('name'     => 'core_rating',
446                                     'fullpath' => '/rating/module.js',
447                                     'requires' => array('node', 'event', 'overlay', 'io-base', 'json'));
448                     break;
449                 case 'core_dndupload':
450                     $module = array('name'     => 'core_dndupload',
451                                     'fullpath' => '/lib/form/dndupload.js',
452                                     'requires' => array('node', 'event', 'json', 'core_filepicker'),
453                                     'strings'  => array(array('uploadformlimit', 'moodle'), array('droptoupload', 'moodle'), array('maxfilesreached', 'moodle'),
454                                                         array('dndenabled_inbox', 'moodle'), array('fileexists', 'moodle'), array('maxbytesforfile', 'moodle'),
455                                                         array('maxareabytesreached', 'moodle')
456                                                     ));
457                     break;
458             }
460         } else {
461             if ($dir = get_component_directory($component)) {
462                 if (file_exists("$dir/module.js")) {
463                     if (strpos($dir, $CFG->dirroot.'/') === 0) {
464                         $dir = substr($dir, strlen($CFG->dirroot));
465                         $module = array('name'=>$component, 'fullpath'=>"$dir/module.js", 'requires' => array());
466                     }
467                 }
468             }
469         }
471         return $module;
472     }
474     /**
475      * Append YUI3 module to default YUI3 JS loader.
476      * The structure of module array is described at {@link http://developer.yahoo.com/yui/3/yui/}
477      *
478      * @param string|array $module name of module (details are autodetected), or full module specification as array
479      * @return void
480      */
481     public function js_module($module) {
482         global $CFG;
484         if (empty($module)) {
485             throw new coding_exception('Missing YUI3 module name or full description.');
486         }
488         if (is_string($module)) {
489             $module = $this->find_module($module);
490         }
492         if (empty($module) or empty($module['name']) or empty($module['fullpath'])) {
493             throw new coding_exception('Missing YUI3 module details.');
494         }
496         // Don't load this module if we already have, no need to!
497         if ($this->js_module_loaded($module['name'])) {
498             if (debugging('', DEBUG_DEVELOPER)) {
499                 $this->debug_moduleloadstacktraces[$module['name']][] = format_backtrace(debug_backtrace());
500             }
501             return;
502         }
504         $module['fullpath'] = $this->js_fix_url($module['fullpath'])->out(false);
505         // Add all needed strings.
506         if (!empty($module['strings'])) {
507             foreach ($module['strings'] as $string) {
508                 $identifier = $string[0];
509                 $component = isset($string[1]) ? $string[1] : 'moodle';
510                 $a = isset($string[2]) ? $string[2] : null;
511                 $this->string_for_js($identifier, $component, $a);
512             }
513         }
514         unset($module['strings']);
516         // Process module requirements and attempt to load each. This allows
517         // moodle modules to require each other.
518         if (!empty($module['requires'])){
519             foreach ($module['requires'] as $requirement) {
520                 $rmodule = $this->find_module($requirement);
521                 if (is_array($rmodule)) {
522                     $this->js_module($rmodule);
523                 }
524             }
525         }
527         if ($this->headdone) {
528             $this->extramodules[$module['name']] = $module;
529         } else {
530             $this->YUI_config->modules[$module['name']] = $module;
531         }
532         if (debugging('', DEBUG_DEVELOPER)) {
533             if (!array_key_exists($module['name'], $this->debug_moduleloadstacktraces)) {
534                 $this->debug_moduleloadstacktraces[$module['name']] = array();
535             }
536             $this->debug_moduleloadstacktraces[$module['name']][] = format_backtrace(debug_backtrace());
537         }
538     }
540     /**
541      * Returns true if the module has already been loaded.
542      *
543      * @param string|array $module
544      * @return bool True if the module has already been loaded
545      */
546     protected function js_module_loaded($module) {
547         if (is_string($module)) {
548             $modulename = $module;
549         } else {
550             $modulename = $module['name'];
551         }
552         return array_key_exists($modulename, $this->YUI_config->modules) ||
553                array_key_exists($modulename, $this->extramodules);
554     }
556     /**
557      * Returns the stacktraces from loading js modules.
558      * @return array
559      */
560     public function get_loaded_modules() {
561         return $this->debug_moduleloadstacktraces;
562     }
564     /**
565      * Ensure that the specified CSS file is linked to from this page.
566      *
567      * Because stylesheet links must go in the <head> part of the HTML, you must call
568      * this function before {@link get_head_code()} is called. That normally means before
569      * the call to print_header. If you call it when it is too late, an exception
570      * will be thrown.
571      *
572      * Even if a particular style sheet is requested more than once, it will only
573      * be linked to once.
574      *
575      * Please note use of this feature is strongly discouraged,
576      * it is suitable only for places where CSS is submitted directly by teachers.
577      * (Students must not be allowed to submit any external CSS because it may
578      * contain embedded javascript!). Example of correct use is mod/data.
579      *
580      * @param string $stylesheet The path to the .css file, relative to $CFG->wwwroot.
581      *   For example:
582      *      $PAGE->requires->css('mod/data/css.php?d='.$data->id);
583      */
584     public function css($stylesheet) {
585         global $CFG;
587         if ($this->headdone) {
588             throw new coding_exception('Cannot require a CSS file after &lt;head> has been printed.', $stylesheet);
589         }
591         if ($stylesheet instanceof moodle_url) {
592             // ok
593         } else if (strpos($stylesheet, '/') === 0) {
594             $stylesheet = new moodle_url($CFG->httpswwwroot.$stylesheet);
595         } else {
596             throw new coding_exception('Invalid stylesheet parameter.', $stylesheet);
597         }
599         $this->cssurls[$stylesheet->out()] = $stylesheet;
600     }
602     /**
603      * Add theme stylesheet to page - do not use from plugin code,
604      * this should be called only from the core renderer!
605      *
606      * @param moodle_url $stylesheet
607      * @return void
608      */
609     public function css_theme(moodle_url $stylesheet) {
610         $this->cssthemeurls[] = $stylesheet;
611     }
613     /**
614      * Ensure that a skip link to a given target is printed at the top of the <body>.
615      *
616      * You must call this function before {@link get_top_of_body_code()}, (if not, an exception
617      * will be thrown). That normally means you must call this before the call to print_header.
618      *
619      * If you ask for a particular skip link to be printed, it is then your responsibility
620      * to ensure that the appropriate <a name="..."> tag is printed in the body of the
621      * page, so that the skip link goes somewhere.
622      *
623      * Even if a particular skip link is requested more than once, only one copy of it will be output.
624      *
625      * @param string $target the name of anchor this link should go to. For example 'maincontent'.
626      * @param string $linktext The text to use for the skip link. Normally get_string('skipto', 'access', ...);
627      */
628     public function skip_link_to($target, $linktext) {
629         if ($this->topofbodydone) {
630             debugging('Page header already printed, can not add skip links any more, code needs to be fixed.');
631             return;
632         }
633         $this->skiplinks[$target] = $linktext;
634     }
636     /**
637      * !!!DEPRECATED!!! please use js_init_call() if possible
638      * Ensure that the specified JavaScript function is called from an inline script
639      * somewhere on this page.
640      *
641      * By default the call will be put in a script tag at the
642      * end of the page after initialising Y instance, since this gives best page-load
643      * performance and allows you to use YUI3 library.
644      *
645      * If you request that a particular function is called several times, then
646      * that is what will happen (unlike linking to a CSS or JS file, where only
647      * one link will be output).
648      *
649      * The main benefit of the method is the automatic encoding of all function parameters.
650      *
651      * @deprecated
652      *
653      * @param string $function the name of the JavaScritp function to call. Can
654      *      be a compound name like 'Y.Event.purgeElement'. Can also be
655      *      used to create and object by using a 'function name' like 'new user_selector'.
656      * @param array $arguments and array of arguments to be passed to the function.
657      *      When generating the function call, this will be escaped using json_encode,
658      *      so passing objects and arrays should work.
659      * @param bool $ondomready If tru the function is only called when the dom is
660      *      ready for manipulation.
661      * @param int $delay The delay before the function is called.
662      */
663     public function js_function_call($function, array $arguments = null, $ondomready = false, $delay = 0) {
664         $where = $ondomready ? 'ondomready' : 'normal';
665         $this->jscalls[$where][] = array($function, $arguments, $delay);
666     }
668     /**
669      * Adds a call to make use of a YUI gallery module. DEPRECATED DO NOT USE!!!
670      *
671      * @deprecated DO NOT USE
672      *
673      * @param string|array $modules One or more gallery modules to require
674      * @param string $version
675      * @param string $function
676      * @param array $arguments
677      * @param bool $ondomready
678      */
679     public function js_gallery_module($modules, $version, $function, array $arguments = null, $ondomready = false) {
680         global $CFG;
681         debugging('This function will be removed before 2.0 is released please change it from js_gallery_module to yui_module', DEBUG_DEVELOPER);
682         $this->yui_module($modules, $function, $arguments, $version, $ondomready);
683     }
685     /**
686      * Creates a JavaScript function call that requires one or more modules to be loaded.
687      *
688      * This function can be used to include all of the standard YUI module types within JavaScript:
689      *     - YUI3 modules    [node, event, io]
690      *     - YUI2 modules    [yui2-*]
691      *     - Moodle modules  [moodle-*]
692      *     - Gallery modules [gallery-*]
693      *
694      * @param array|string $modules One or more modules
695      * @param string $function The function to call once modules have been loaded
696      * @param array $arguments An array of arguments to pass to the function
697      * @param string $galleryversion The gallery version to use
698      * @param bool $ondomready
699      */
700     public function yui_module($modules, $function, array $arguments = null, $galleryversion = null, $ondomready = false) {
701         global $CFG;
703         if (!$galleryversion) {
704             $galleryversion = '2010.04.08-12-35';
705         }
707         if (!is_array($modules)) {
708             $modules = array($modules);
709         }
710         if (empty($CFG->useexternalyui)) {
711             // We need to set the M.yui.galleryversion to the correct version
712             $jscode = 'M.yui.galleryversion='.json_encode($galleryversion).';';
713         } else {
714             // Set Y's config.gallery to the version
715             $jscode = 'Y.config.gallery='.json_encode($galleryversion).';';
716         }
717         $jscode .= 'Y.use('.join(',', array_map('json_encode', convert_to_array($modules))).',function() {'.js_writer::function_call($function, $arguments).'});';
718         if ($ondomready) {
719             $jscode = "Y.on('domready', function() { $jscode });";
720         }
721         $this->jsinitcode[] = $jscode;
722     }
724     /**
725      * Ensure that the specified JavaScript function is called from an inline script
726      * from page footer.
727      *
728      * @param string $function the name of the JavaScritp function to with init code,
729      *      usually something like 'M.mod_mymodule.init'
730      * @param array $extraarguments and array of arguments to be passed to the function.
731      *      The first argument is always the YUI3 Y instance with all required dependencies
732      *      already loaded.
733      * @param bool $ondomready wait for dom ready (helps with some IE problems when modifying DOM)
734      * @param array $module JS module specification array
735      */
736     public function js_init_call($function, array $extraarguments = null, $ondomready = false, array $module = null) {
737         $jscode = js_writer::function_call_with_Y($function, $extraarguments);
738         if (!$module) {
739             // Detect module automatically.
740             if (preg_match('/M\.([a-z0-9]+_[^\.]+)/', $function, $matches)) {
741                 $module = $this->find_module($matches[1]);
742             }
743         }
745         $this->js_init_code($jscode, $ondomready, $module);
746     }
748     /**
749      * Add short static javascript code fragment to page footer.
750      * This is intended primarily for loading of js modules and initialising page layout.
751      * Ideally the JS code fragment should be stored in plugin renderer so that themes
752      * may override it.
753      *
754      * @param string $jscode
755      * @param bool $ondomready wait for dom ready (helps with some IE problems when modifying DOM)
756      * @param array $module JS module specification array
757      */
758     public function js_init_code($jscode, $ondomready = false, array $module = null) {
759         $jscode = trim($jscode, " ;\n"). ';';
761         if ($module) {
762             $this->js_module($module);
763             $modulename = $module['name'];
764             $jscode = "Y.use('$modulename', function(Y) { $jscode });";
765         }
767         if ($ondomready) {
768             $jscode = "Y.on('domready', function() { $jscode });";
769         }
771         $this->jsinitcode[] = $jscode;
772     }
774     /**
775      * Make a language string available to JavaScript.
776      *
777      * All the strings will be available in a M.str object in the global namespace.
778      * So, for example, after a call to $PAGE->requires->string_for_js('course', 'moodle');
779      * then the JavaScript variable M.str.moodle.course will be 'Course', or the
780      * equivalent in the current language.
781      *
782      * The arguments to this function are just like the arguments to get_string
783      * except that $component is not optional, and there are some aspects to consider
784      * when the string contains {$a} placeholder.
785      *
786      * If the string does not contain any {$a} placeholder, you can simply use
787      * M.str.component.identifier to obtain it. If you prefer, you can call
788      * M.util.get_string(identifier, component) to get the same result.
789      *
790      * If you need to use {$a} placeholders, there are two options. Either the
791      * placeholder should be substituted in PHP on server side or it should
792      * be substituted in Javascript at client side.
793      *
794      * To substitute the placeholder at server side, just provide the required
795      * value for the placeholder when you require the string. Because each string
796      * is only stored once in the JavaScript (based on $identifier and $module)
797      * you cannot get the same string with two different values of $a. If you try,
798      * an exception will be thrown. Once the placeholder is substituted, you can
799      * use M.str or M.util.get_string() as shown above:
800      *
801      *     // Require the string in PHP and replace the placeholder.
802      *     $PAGE->requires->string_for_js('fullnamedisplay', 'moodle', $USER);
803      *     // Use the result of the substitution in Javascript.
804      *     alert(M.str.moodle.fullnamedisplay);
805      *
806      * To substitute the placeholder at client side, use M.util.get_string()
807      * function. It implements the same logic as {@link get_string()}:
808      *
809      *     // Require the string in PHP but keep {$a} as it is.
810      *     $PAGE->requires->string_for_js('fullnamedisplay', 'moodle');
811      *     // Provide the values on the fly in Javascript.
812      *     user = { firstname : 'Harry', lastname : 'Potter' }
813      *     alert(M.util.get_string('fullnamedisplay', 'moodle', user);
814      *
815      * If you do need the same string expanded with different $a values in PHP
816      * on server side, then the solution is to put them in your own data structure
817      * (e.g. and array) that you pass to JavaScript with {@link data_for_js()}.
818      *
819      * @param string $identifier the desired string.
820      * @param string $component the language file to look in.
821      * @param mixed $a any extra data to add into the string (optional).
822      */
823     public function string_for_js($identifier, $component, $a = null) {
824         if (!$component) {
825             throw new coding_exception('The $component parameter is required for page_requirements_manager::string_for_js().');
826         }
827         if (isset($this->stringsforjs_as[$component][$identifier]) and $this->stringsforjs_as[$component][$identifier] !== $a) {
828             throw new coding_exception("Attempt to re-define already required string '$identifier' " .
829                     "from lang file '$component' with different \$a parameter?");
830         }
831         if (!isset($this->stringsforjs[$component][$identifier])) {
832             $this->stringsforjs[$component][$identifier] = new lang_string($identifier, $component, $a);
833             $this->stringsforjs_as[$component][$identifier] = $a;
834         }
835     }
837     /**
838      * Make an array of language strings available for JS.
839      *
840      * This function calls the above function {@link string_for_js()} for each requested
841      * string in the $identifiers array that is passed to the argument for a single module
842      * passed in $module.
843      *
844      * <code>
845      * $PAGE->requires->strings_for_js(array('one', 'two', 'three'), 'mymod', array('a', null, 3));
846      *
847      * // The above is identical to calling:
848      *
849      * $PAGE->requires->string_for_js('one', 'mymod', 'a');
850      * $PAGE->requires->string_for_js('two', 'mymod');
851      * $PAGE->requires->string_for_js('three', 'mymod', 3);
852      * </code>
853      *
854      * @param array $identifiers An array of desired strings
855      * @param string $component The module to load for
856      * @param mixed $a This can either be a single variable that gets passed as extra
857      *         information for every string or it can be an array of mixed data where the
858      *         key for the data matches that of the identifier it is meant for.
859      *
860      */
861     public function strings_for_js($identifiers, $component, $a = null) {
862         foreach ($identifiers as $key => $identifier) {
863             if (is_array($a) && array_key_exists($key, $a)) {
864                 $extra = $a[$key];
865             } else {
866                 $extra = $a;
867             }
868             $this->string_for_js($identifier, $component, $extra);
869         }
870     }
872     /**
873      * !!!!!!DEPRECATED!!!!!! please use js_init_call() for everything now.
874      *
875      * Make some data from PHP available to JavaScript code.
876      *
877      * For example, if you call
878      * <pre>
879      *      $PAGE->requires->data_for_js('mydata', array('name' => 'Moodle'));
880      * </pre>
881      * then in JavsScript mydata.name will be 'Moodle'.
882      *
883      * @deprecated
884      * @param string $variable the the name of the JavaScript variable to assign the data to.
885      *      Will probably work if you use a compound name like 'mybuttons.button[1]', but this
886      *      should be considered an experimental feature.
887      * @param mixed $data The data to pass to JavaScript. This will be escaped using json_encode,
888      *      so passing objects and arrays should work.
889      * @param bool $inhead initialise in head
890      * @return void
891      */
892     public function data_for_js($variable, $data, $inhead=false) {
893         $where = $inhead ? 'head' : 'footer';
894         $this->jsinitvariables[$where][] = array($variable, $data);
895     }
897     /**
898      * Creates a YUI event handler.
899      *
900      * @param mixed $selector standard YUI selector for elements, may be array or string, element id is in the form "#idvalue"
901      * @param string $event A valid DOM event (click, mousedown, change etc.)
902      * @param string $function The name of the function to call
903      * @param array  $arguments An optional array of argument parameters to pass to the function
904      */
905     public function event_handler($selector, $event, $function, array $arguments = null) {
906         $this->eventhandlers[] = array('selector'=>$selector, 'event'=>$event, 'function'=>$function, 'arguments'=>$arguments);
907     }
909     /**
910      * Returns code needed for registering of event handlers.
911      * @return string JS code
912      */
913     protected function get_event_handler_code() {
914         $output = '';
915         foreach ($this->eventhandlers as $h) {
916             $output .= js_writer::event_handler($h['selector'], $h['event'], $h['function'], $h['arguments']);
917         }
918         return $output;
919     }
921     /**
922      * Get the inline JavaScript code that need to appear in a particular place.
923      * @param bool $ondomready
924      * @return string
925      */
926     protected function get_javascript_code($ondomready) {
927         $where = $ondomready ? 'ondomready' : 'normal';
928         $output = '';
929         if ($this->jscalls[$where]) {
930             foreach ($this->jscalls[$where] as $data) {
931                 $output .= js_writer::function_call($data[0], $data[1], $data[2]);
932             }
933             if (!empty($ondomready)) {
934                 $output = "    Y.on('domready', function() {\n$output\n    });";
935             }
936         }
937         return $output;
938     }
940     /**
941      * Returns js code to be executed when Y is available.
942      * @return string
943      */
944     protected function get_javascript_init_code() {
945         if (count($this->jsinitcode)) {
946             return implode("\n", $this->jsinitcode) . "\n";
947         }
948         return '';
949     }
951     /**
952      * Returns basic YUI3 JS loading code.
953      * YUI3 is using autoloading of both CSS and JS code.
954      *
955      * Major benefit of this compared to standard js/csss loader is much improved
956      * caching, better browser cache utilisation, much fewer http requests.
957      *
958      * @return string
959      */
960     protected function get_yui3lib_headcode() {
961         global $CFG;
963         $code = '';
965         if ($this->yui3loader->combine) {
966             $code .= '<link rel="stylesheet" type="text/css" href="'.$this->yui3loader->comboBase
967                      .$CFG->yui3version.'/build/cssreset/reset-min.css&amp;'
968                      .$CFG->yui3version.'/build/cssfonts/fonts-min.css&amp;'
969                      .$CFG->yui3version.'/build/cssgrids/grids-min.css&amp;'
970                      .$CFG->yui3version.'/build/cssbase/base-min.css" />';
971             $code .= '<script type="text/javascript" src="'.$this->yui3loader->comboBase
972                      .$CFG->yui3version.'/build/simpleyui/simpleyui-min.js&amp;'
973                      .$CFG->yui3version.'/build/loader/loader-min.js"></script>';
974         } else {
975             $code .= '<link rel="stylesheet" type="text/css" href="'.$this->yui3loader->base.'cssreset/reset-min.css" />';
976             $code .= '<link rel="stylesheet" type="text/css" href="'.$this->yui3loader->base.'cssfonts/fonts-min.css" />';
977             $code .= '<link rel="stylesheet" type="text/css" href="'.$this->yui3loader->base.'cssgrids/grids-min.css" />';
978             $code .= '<link rel="stylesheet" type="text/css" href="'.$this->yui3loader->base.'cssbase/base-min.css" />';
979             $code .= '<script type="text/javascript" src="'.$this->yui3loader->base.'simpleyui/simpleyui-min.js"></script>';
980             $code .= '<script type="text/javascript" src="'.$this->yui3loader->base.'loader/loader-min.js"></script>';
981         }
984         if ($this->yui3loader->filter === 'RAW') {
985             $code = str_replace('-min.css', '.css', $code);
986             $code = str_replace('-min.js', '.js', $code);
987         } else if ($this->yui3loader->filter === 'DEBUG') {
988             $code = str_replace('-min.css', '.css', $code);
989             $code = str_replace('-min.js', '-debug.js', $code);
990         }
992         return $code;
993     }
995     /**
996      * Returns html tags needed for inclusion of theme CSS.
997      *
998      * @return string
999      */
1000     protected function get_css_code() {
1001         // First of all the theme CSS, then any custom CSS
1002         // Please note custom CSS is strongly discouraged,
1003         // because it can not be overridden by themes!
1004         // It is suitable only for things like mod/data which accepts CSS from teachers.
1005         $attributes = array('rel'=>'stylesheet', 'type'=>'text/css');
1007         // This line of code may look funny but it is currently required in order
1008         // to avoid MASSIVE display issues in Internet Explorer.
1009         // As of IE8 + YUI3.1.1 the reference stylesheet (firstthemesheet) gets
1010         // ignored whenever another resource is added until such time as a redraw
1011         // is forced, usually by moving the mouse over the affected element.
1012         $code = html_writer::tag('script', '/** Required in order to fix style inclusion problems in IE with YUI **/', array('id'=>'firstthemesheet', 'type'=>'text/css'));
1014         $urls = $this->cssthemeurls + $this->cssurls;
1015         foreach ($urls as $url) {
1016             $attributes['href'] = $url;
1017             $code .= html_writer::empty_tag('link', $attributes) . "\n";
1018             // This id is needed in first sheet only so that theme may override YUI sheets loaded on the fly.
1019             unset($attributes['id']);
1020         }
1022         return $code;
1023     }
1025     /**
1026      * Adds extra modules specified after printing of page header.
1027      *
1028      * @return string
1029      */
1030     protected function get_extra_modules_code() {
1031         if (empty($this->extramodules)) {
1032             return '';
1033         }
1034         return html_writer::script(js_writer::function_call('M.yui.add_module', array($this->extramodules)));
1035     }
1037     /**
1038      * Generate any HTML that needs to go inside the <head> tag.
1039      *
1040      * Normally, this method is called automatically by the code that prints the
1041      * <head> tag. You should not normally need to call it in your own code.
1042      *
1043      * @param moodle_page $page
1044      * @param core_renderer $renderer
1045      * @return string the HTML code to to inside the <head> tag.
1046      */
1047     public function get_head_code(moodle_page $page, core_renderer $renderer) {
1048         global $CFG;
1050         // Note: the $page and $output are not stored here because it would
1051         // create circular references in memory which prevents garbage collection.
1052         $this->init_requirements_data($page, $renderer);
1054         // YUI3 JS and CSS is always loaded first - it is cached in browser.
1055         $output = $this->get_yui3lib_headcode();
1057         // Now theme CSS + custom CSS in this specific order.
1058         $output .= $this->get_css_code();
1060         // Set up global YUI3 loader object - this should contain all code needed by plugins.
1061         // Note: in JavaScript just use "YUI().use('overlay', function(Y) { .... });",
1062         //       this needs to be done before including any other script.
1063         $js = "var M = {}; M.yui = {};
1064 var moodleConfigFn = function(me) {var p = me.path, b = me.name.replace(/^moodle-/,'').split('-', 3), n = b.pop();if (/(skin|core)/.test(n)) {n = b.pop();me.type = 'css';};me.path = b.join('-')+'/'+n+'/'+n+'-min.'+me.type;};
1065 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('/');};
1066 var yui2in3ConfigFn = function(me) {if(/-skin|reset|fonts|grids|base/.test(me.name)){me.type='css';me.path=me.path.replace(/\.js/,'.css');me.path=me.path.replace(/\/yui2-skin/,'/assets/skins/sam/yui2-skin');}};\n";
1067         $js .= js_writer::set_variable('YUI_config', $this->YUI_config, false) . "\n";
1068         $js .= "M.yui.loader = {modules: {}};\n"; // Backwards compatibility only, not used any more.
1069         $js .= js_writer::set_variable('M.cfg', $this->M_cfg, false);
1070         $js = str_replace('"@GALLERYCONFIGFN@"', 'galleryConfigFn', $js);
1071         $js = str_replace('"@MOODLECONFIGFN@"', 'moodleConfigFn', $js);
1072         $js = str_replace('"@2IN3CONFIGFN@"', 'yui2in3ConfigFn', $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;
1137         // Add other requested modules.
1138         $output = $this->get_extra_modules_code();
1140         // All the other linked scripts - there should be as few as possible.
1141         if ($this->jsincludes['footer']) {
1142             foreach ($this->jsincludes['footer'] as $url) {
1143                 $output .= html_writer::script('', $url);
1144             }
1145         }
1147         // Add all needed strings.
1148         if (!empty($this->stringsforjs)) {
1149             $strings = array();
1150             foreach ($this->stringsforjs as $component=>$v) {
1151                 foreach($v as $indentifier => $langstring) {
1152                     $strings[$component][$indentifier] = $langstring->out();
1153                 }
1154             }
1155             $output .= html_writer::script(js_writer::set_variable('M.str', $strings));
1156         }
1158         // Add variables.
1159         if ($this->jsinitvariables['footer']) {
1160             $js = '';
1161             foreach ($this->jsinitvariables['footer'] as $data) {
1162                 list($var, $value) = $data;
1163                 $js .= js_writer::set_variable($var, $value, true);
1164             }
1165             $output .= html_writer::script($js);
1166         }
1168         $inyuijs = $this->get_javascript_code(false);
1169         $ondomreadyjs = $this->get_javascript_code(true);
1170         $jsinit = $this->get_javascript_init_code();
1171         $handlersjs = $this->get_event_handler_code();
1173         // There is no global Y, make sure it is available in your scope.
1174         $js = "YUI().use('node', function(Y) {\n{$inyuijs}{$ondomreadyjs}{$jsinit}{$handlersjs}\n});";
1176         $output .= html_writer::script($js);
1178         return $output;
1179     }
1181     /**
1182      * Have we already output the code in the <head> tag?
1183      *
1184      * @return bool
1185      */
1186     public function is_head_done() {
1187         return $this->headdone;
1188     }
1190     /**
1191      * Have we already output the code at the start of the <body> tag?
1192      *
1193      * @return bool
1194      */
1195     public function is_top_of_body_done() {
1196         return $this->topofbodydone;
1197     }
1200 /**
1201  * Invalidate all server and client side JS caches.
1202  */
1203 function js_reset_all_caches() {
1204     global $CFG;
1205     require_once("$CFG->libdir/filelib.php");
1207     $next = time();
1208     if (isset($CFG->jsrev) and $next <= $CFG->jsrev and $CFG->jsrev - $next < 60*60) {
1209         // This resolves problems when reset is requested repeatedly within 1s,
1210         // the < 1h condition prevents accidental switching to future dates
1211         // because we might not recover from it.
1212         $next = $CFG->jsrev+1;
1213     }
1215     set_config('jsrev', $next);
1216     fulldelete("$CFG->cachedir/js");