Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
- Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
- PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.
/lib/ -> outputrequirementslib.php (source)
Differences Between: [Versions 310 and 311] [Versions 311 and 400] [Versions 311 and 401] [Versions 311 and 402] [Versions 311 and 403] [Versions 39 and 311]
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/>. 16 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 */ 27 28 defined('MOODLE_INTERNAL') || die(); 29 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_call_amd('mod_forum/view', 'init'); 39 * </pre> 40 * 41 * It also supports obsoleted coding style with/without YUI3 modules. 42 * <pre> 43 * $PAGE->requires->js_init_call('M.mod_forum.init_view'); 44 * $PAGE->requires->css('/mod/mymod/userstyles.php?id='.$id); // not overridable via themes! 45 * $PAGE->requires->js('/mod/mymod/script.js'); 46 * $PAGE->requires->js('/mod/mymod/small_but_urgent.js', true); 47 * $PAGE->requires->js_function_call('init_mymod', array($data), true); 48 * </pre> 49 * 50 * There are some natural restrictions on some methods. For example, {@link css()} 51 * can only be called before the <head> tag is output. See the comments on the 52 * individual methods for details. 53 * 54 * @copyright 2009 Tim Hunt, 2010 Petr Skoda 55 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 56 * @since Moodle 2.0 57 * @package core 58 * @category output 59 */ 60 class page_requirements_manager { 61 62 /** 63 * @var array List of string available from JS 64 */ 65 protected $stringsforjs = array(); 66 67 /** 68 * @var array List of get_string $a parameters - used for validation only. 69 */ 70 protected $stringsforjs_as = array(); 71 72 /** 73 * @var array List of JS variables to be initialised 74 */ 75 protected $jsinitvariables = array('head'=>array(), 'footer'=>array()); 76 77 /** 78 * @var array Included JS scripts 79 */ 80 protected $jsincludes = array('head'=>array(), 'footer'=>array()); 81 82 /** 83 * @var array Inline scripts using RequireJS module loading. 84 */ 85 protected $amdjscode = array(''); 86 87 /** 88 * @var array List of needed function calls 89 */ 90 protected $jscalls = array('normal'=>array(), 'ondomready'=>array()); 91 92 /** 93 * @var array List of skip links, those are needed for accessibility reasons 94 */ 95 protected $skiplinks = array(); 96 97 /** 98 * @var array Javascript code used for initialisation of page, it should 99 * be relatively small 100 */ 101 protected $jsinitcode = array(); 102 103 /** 104 * @var array of moodle_url Theme sheets, initialised only from core_renderer 105 */ 106 protected $cssthemeurls = array(); 107 108 /** 109 * @var array of moodle_url List of custom theme sheets, these are strongly discouraged! 110 * Useful mostly only for CSS submitted by teachers that is not part of the theme. 111 */ 112 protected $cssurls = array(); 113 114 /** 115 * @var array List of requested event handlers 116 */ 117 protected $eventhandlers = array(); 118 119 /** 120 * @var array Extra modules 121 */ 122 protected $extramodules = array(); 123 124 /** 125 * @var array trackes the names of bits of HTML that are only required once 126 * per page. See {@link has_one_time_item_been_created()}, 127 * {@link set_one_time_item_created()} and {@link should_create_one_time_item_now()}. 128 */ 129 protected $onetimeitemsoutput = array(); 130 131 /** 132 * @var bool Flag indicated head stuff already printed 133 */ 134 protected $headdone = false; 135 136 /** 137 * @var bool Flag indicating top of body already printed 138 */ 139 protected $topofbodydone = false; 140 141 /** 142 * @var stdClass YUI PHPLoader instance responsible for YUI3 loading from PHP only 143 */ 144 protected $yui3loader; 145 146 /** 147 * @var YUI_config default YUI loader configuration 148 */ 149 protected $YUI_config; 150 151 /** 152 * @var array $yuicssmodules 153 */ 154 protected $yuicssmodules = array(); 155 156 /** 157 * @var array Some config vars exposed in JS, please no secret stuff there 158 */ 159 protected $M_cfg; 160 161 /** 162 * @var array list of requested jQuery plugins 163 */ 164 protected $jqueryplugins = array(); 165 166 /** 167 * @var array list of jQuery plugin overrides 168 */ 169 protected $jquerypluginoverrides = array(); 170 171 /** 172 * Page requirements constructor. 173 */ 174 public function __construct() { 175 global $CFG; 176 177 // You may need to set up URL rewrite rule because oversized URLs might not be allowed by web server. 178 $sep = empty($CFG->yuislasharguments) ? '?' : '/'; 179 180 $this->yui3loader = new stdClass(); 181 $this->YUI_config = new YUI_config(); 182 183 if (is_https() && !empty($CFG->useexternalyui)) { 184 // On HTTPS sites all JS must be loaded from https sites, 185 // YUI CDN does not support https yet, sorry. 186 $CFG->useexternalyui = 0; 187 } 188 189 // Set up some loader options. 190 $this->yui3loader->local_base = $CFG->wwwroot . '/lib/yuilib/'. $CFG->yui3version . '/'; 191 $this->yui3loader->local_comboBase = $CFG->wwwroot . '/theme/yui_combo.php'.$sep; 192 193 if (!empty($CFG->useexternalyui)) { 194 $this->yui3loader->base = 'http://yui.yahooapis.com/' . $CFG->yui3version . '/'; 195 $this->yui3loader->comboBase = 'http://yui.yahooapis.com/combo?'; 196 } else { 197 $this->yui3loader->base = $this->yui3loader->local_base; 198 $this->yui3loader->comboBase = $this->yui3loader->local_comboBase; 199 } 200 201 // Enable combo loader? This significantly helps with caching and performance! 202 $this->yui3loader->combine = !empty($CFG->yuicomboloading); 203 204 $jsrev = $this->get_jsrev(); 205 206 // Set up JS YUI loader helper object. 207 $this->YUI_config->base = $this->yui3loader->base; 208 $this->YUI_config->comboBase = $this->yui3loader->comboBase; 209 $this->YUI_config->combine = $this->yui3loader->combine; 210 211 // If we've had to patch any YUI modules between releases, we must override the YUI configuration to include them. 212 // For important information on patching YUI modules, please see http://docs.moodle.org/dev/YUI/Patching. 213 if (!empty($CFG->yuipatchedmodules) && !empty($CFG->yuipatchlevel)) { 214 $this->YUI_config->define_patched_core_modules($this->yui3loader->local_comboBase, 215 $CFG->yui3version, 216 $CFG->yuipatchlevel, 217 $CFG->yuipatchedmodules); 218 } 219 220 $configname = $this->YUI_config->set_config_source('lib/yui/config/yui2.js'); 221 $this->YUI_config->add_group('yui2', array( 222 // Loader configuration for our 2in3, for now ignores $CFG->useexternalyui. 223 'base' => $CFG->wwwroot . '/lib/yuilib/2in3/' . $CFG->yui2version . '/build/', 224 'comboBase' => $CFG->wwwroot . '/theme/yui_combo.php'.$sep, 225 'combine' => $this->yui3loader->combine, 226 'ext' => false, 227 'root' => '2in3/' . $CFG->yui2version .'/build/', 228 'patterns' => array( 229 'yui2-' => array( 230 'group' => 'yui2', 231 'configFn' => $configname, 232 ) 233 ) 234 )); 235 $configname = $this->YUI_config->set_config_source('lib/yui/config/moodle.js'); 236 $this->YUI_config->add_group('moodle', array( 237 'name' => 'moodle', 238 'base' => $CFG->wwwroot . '/theme/yui_combo.php' . $sep . 'm/' . $jsrev . '/', 239 'combine' => $this->yui3loader->combine, 240 'comboBase' => $CFG->wwwroot . '/theme/yui_combo.php'.$sep, 241 'ext' => false, 242 'root' => 'm/'.$jsrev.'/', // Add the rev to the root path so that we can control caching. 243 'patterns' => array( 244 'moodle-' => array( 245 'group' => 'moodle', 246 'configFn' => $configname, 247 ) 248 ) 249 )); 250 251 $this->YUI_config->add_group('gallery', array( 252 'name' => 'gallery', 253 'base' => $CFG->wwwroot . '/lib/yuilib/gallery/', 254 'combine' => $this->yui3loader->combine, 255 'comboBase' => $CFG->wwwroot . '/theme/yui_combo.php' . $sep, 256 'ext' => false, 257 'root' => 'gallery/' . $jsrev . '/', 258 'patterns' => array( 259 'gallery-' => array( 260 'group' => 'gallery', 261 ) 262 ) 263 )); 264 265 // Set some more loader options applying to groups too. 266 if ($CFG->debugdeveloper) { 267 // When debugging is enabled, we want to load the non-minified (RAW) versions of YUI library modules rather 268 // than the DEBUG versions as these generally generate too much logging for our purposes. 269 // However we do want the DEBUG versions of our Moodle-specific modules. 270 // To debug a YUI-specific issue, change the yui3loader->filter value to DEBUG. 271 $this->YUI_config->filter = 'RAW'; 272 $this->YUI_config->groups['moodle']['filter'] = 'DEBUG'; 273 274 // We use the yui3loader->filter setting when writing the YUI3 seed scripts into the header. 275 $this->yui3loader->filter = $this->YUI_config->filter; 276 $this->YUI_config->debug = true; 277 } else { 278 $this->yui3loader->filter = null; 279 $this->YUI_config->groups['moodle']['filter'] = null; 280 $this->YUI_config->debug = false; 281 } 282 283 // Include the YUI config log filters. 284 if (!empty($CFG->yuilogexclude) && is_array($CFG->yuilogexclude)) { 285 $this->YUI_config->logExclude = $CFG->yuilogexclude; 286 } 287 if (!empty($CFG->yuiloginclude) && is_array($CFG->yuiloginclude)) { 288 $this->YUI_config->logInclude = $CFG->yuiloginclude; 289 } 290 if (!empty($CFG->yuiloglevel)) { 291 $this->YUI_config->logLevel = $CFG->yuiloglevel; 292 } 293 294 // Add the moodle group's module data. 295 $this->YUI_config->add_moodle_metadata(); 296 297 // Every page should include definition of following modules. 298 $this->js_module($this->find_module('core_filepicker')); 299 $this->js_module($this->find_module('core_comment')); 300 } 301 302 /** 303 * Return the safe config values that get set for javascript in "M.cfg". 304 * 305 * @since 2.9 306 * @return array List of safe config values that are available to javascript. 307 */ 308 public function get_config_for_javascript(moodle_page $page, renderer_base $renderer) { 309 global $CFG; 310 311 if (empty($this->M_cfg)) { 312 313 $iconsystem = \core\output\icon_system::instance(); 314 315 // It is possible that the $page->context is null, so we can't use $page->context->id. 316 $contextid = null; 317 if (!is_null($page->context)) { 318 $contextid = $page->context->id; 319 } 320 321 $this->M_cfg = array( 322 'wwwroot' => $CFG->wwwroot, 323 'sesskey' => sesskey(), 324 'sessiontimeout' => $CFG->sessiontimeout, 325 'sessiontimeoutwarning' => $CFG->sessiontimeoutwarning, 326 'themerev' => theme_get_revision(), 327 'slasharguments' => (int)(!empty($CFG->slasharguments)), 328 'theme' => $page->theme->name, 329 'iconsystemmodule' => $iconsystem->get_amd_name(), 330 'jsrev' => $this->get_jsrev(), 331 'admin' => $CFG->admin, 332 'svgicons' => $page->theme->use_svg_icons(), 333 'usertimezone' => usertimezone(), 334 'contextid' => $contextid, 335 'langrev' => get_string_manager()->get_revision(), 336 'templaterev' => $this->get_templaterev() 337 ); 338 if ($CFG->debugdeveloper) { 339 $this->M_cfg['developerdebug'] = true; 340 } 341 if (defined('BEHAT_SITE_RUNNING')) { 342 $this->M_cfg['behatsiterunning'] = true; 343 } 344 345 } 346 return $this->M_cfg; 347 } 348 349 /** 350 * Initialise with the bits of JavaScript that every Moodle page should have. 351 * 352 * @param moodle_page $page 353 * @param core_renderer $renderer 354 */ 355 protected function init_requirements_data(moodle_page $page, core_renderer $renderer) { 356 global $CFG; 357 358 // Init the js config. 359 $this->get_config_for_javascript($page, $renderer); 360 361 // Accessibility stuff. 362 $this->skip_link_to('maincontent', get_string('tocontent', 'access')); 363 364 // Add strings used on many pages. 365 $this->string_for_js('confirmation', 'admin'); 366 $this->string_for_js('cancel', 'moodle'); 367 $this->string_for_js('yes', 'moodle'); 368 369 // Alter links in top frame to break out of frames. 370 if ($page->pagelayout === 'frametop') { 371 $this->js_init_call('M.util.init_frametop'); 372 } 373 374 // Include block drag/drop if editing is on 375 if ($page->user_is_editing()) { 376 $params = array( 377 'courseid' => $page->course->id, 378 'pagetype' => $page->pagetype, 379 'pagelayout' => $page->pagelayout, 380 'subpage' => $page->subpage, 381 'regions' => $page->blocks->get_regions(), 382 'contextid' => $page->context->id, 383 ); 384 if (!empty($page->cm->id)) { 385 $params['cmid'] = $page->cm->id; 386 } 387 // Strings for drag and drop. 388 $this->strings_for_js(array('movecontent', 389 'tocontent', 390 'emptydragdropregion'), 391 'moodle'); 392 $page->requires->yui_module('moodle-core-blocks', 'M.core_blocks.init_dragdrop', array($params), null, true); 393 } 394 395 // Include the YUI CSS Modules. 396 $page->requires->set_yuicssmodules($page->theme->yuicssmodules); 397 } 398 399 /** 400 * Determine the correct JS Revision to use for this load. 401 * 402 * @return int the jsrev to use. 403 */ 404 public function get_jsrev() { 405 global $CFG; 406 407 if (empty($CFG->cachejs)) { 408 $jsrev = -1; 409 } else if (empty($CFG->jsrev)) { 410 $jsrev = 1; 411 } else { 412 $jsrev = $CFG->jsrev; 413 } 414 415 return $jsrev; 416 } 417 418 /** 419 * Determine the correct Template revision to use for this load. 420 * 421 * @return int the templaterev to use. 422 */ 423 protected function get_templaterev() { 424 global $CFG; 425 426 if (empty($CFG->cachetemplates)) { 427 $templaterev = -1; 428 } else if (empty($CFG->templaterev)) { 429 $templaterev = 1; 430 } else { 431 $templaterev = $CFG->templaterev; 432 } 433 434 return $templaterev; 435 } 436 437 /** 438 * Ensure that the specified JavaScript file is linked to from this page. 439 * 440 * NOTE: This function is to be used in RARE CASES ONLY, please store your JS in module.js file 441 * and use $PAGE->requires->js_init_call() instead or use /yui/ subdirectories for YUI modules. 442 * 443 * By default the link is put at the end of the page, since this gives best page-load performance. 444 * 445 * Even if a particular script is requested more than once, it will only be linked 446 * to once. 447 * 448 * @param string|moodle_url $url The path to the .js file, relative to $CFG->dirroot / $CFG->wwwroot. 449 * For example '/mod/mymod/customscripts.js'; use moodle_url for external scripts 450 * @param bool $inhead initialise in head 451 */ 452 public function js($url, $inhead = false) { 453 $url = $this->js_fix_url($url); 454 $where = $inhead ? 'head' : 'footer'; 455 $this->jsincludes[$where][$url->out()] = $url; 456 } 457 458 /** 459 * Request inclusion of jQuery library in the page. 460 * 461 * NOTE: this should not be used in official Moodle distribution! 462 * 463 * {@see http://docs.moodle.org/dev/jQuery} 464 */ 465 public function jquery() { 466 $this->jquery_plugin('jquery'); 467 } 468 469 /** 470 * Request inclusion of jQuery plugin. 471 * 472 * NOTE: this should not be used in official Moodle distribution! 473 * 474 * jQuery plugins are located in plugin/jquery/* subdirectory, 475 * plugin/jquery/plugins.php lists all available plugins. 476 * 477 * Included core plugins: 478 * - jQuery UI 479 * 480 * Add-ons may include extra jQuery plugins in jquery/ directory, 481 * plugins.php file defines the mapping between plugin names and 482 * necessary page includes. 483 * 484 * Examples: 485 * <code> 486 * // file: mod/xxx/view.php 487 * $PAGE->requires->jquery(); 488 * $PAGE->requires->jquery_plugin('ui'); 489 * $PAGE->requires->jquery_plugin('ui-css'); 490 * </code> 491 * 492 * <code> 493 * // file: theme/yyy/lib.php 494 * function theme_yyy_page_init(moodle_page $page) { 495 * $page->requires->jquery(); 496 * $page->requires->jquery_plugin('ui'); 497 * $page->requires->jquery_plugin('ui-css'); 498 * } 499 * </code> 500 * 501 * <code> 502 * // file: blocks/zzz/block_zzz.php 503 * public function get_required_javascript() { 504 * parent::get_required_javascript(); 505 * $this->page->requires->jquery(); 506 * $page->requires->jquery_plugin('ui'); 507 * $page->requires->jquery_plugin('ui-css'); 508 * } 509 * </code> 510 * 511 * {@see http://docs.moodle.org/dev/jQuery} 512 * 513 * @param string $plugin name of the jQuery plugin as defined in jquery/plugins.php 514 * @param string $component name of the component 515 * @return bool success 516 */ 517 public function jquery_plugin($plugin, $component = 'core') { 518 global $CFG; 519 520 if ($this->headdone) { 521 debugging('Can not add jQuery plugins after starting page output!'); 522 return false; 523 } 524 525 if ($component !== 'core' and in_array($plugin, array('jquery', 'ui', 'ui-css'))) { 526 debugging("jQuery plugin '$plugin' is included in Moodle core, other components can not use the same name.", DEBUG_DEVELOPER); 527 $component = 'core'; 528 } else if ($component !== 'core' and strpos($component, '_') === false) { 529 // Let's normalise the legacy activity names, Frankenstyle rulez! 530 $component = 'mod_' . $component; 531 } 532 533 if (empty($this->jqueryplugins) and ($component !== 'core' or $plugin !== 'jquery')) { 534 // Make sure the jQuery itself is always loaded first, 535 // the order of all other plugins depends on order of $PAGE_>requires->. 536 $this->jquery_plugin('jquery', 'core'); 537 } 538 539 if (isset($this->jqueryplugins[$plugin])) { 540 // No problem, we already have something, first Moodle plugin to register the jQuery plugin wins. 541 return true; 542 } 543 544 $componentdir = core_component::get_component_directory($component); 545 if (!file_exists($componentdir) or !file_exists("$componentdir/jquery/plugins.php")) { 546 debugging("Can not load jQuery plugin '$plugin', missing plugins.php in component '$component'.", DEBUG_DEVELOPER); 547 return false; 548 } 549 550 $plugins = array(); 551 require("$componentdir/jquery/plugins.php"); 552 553 if (!isset($plugins[$plugin])) { 554 debugging("jQuery plugin '$plugin' can not be found in component '$component'.", DEBUG_DEVELOPER); 555 return false; 556 } 557 558 $this->jqueryplugins[$plugin] = new stdClass(); 559 $this->jqueryplugins[$plugin]->plugin = $plugin; 560 $this->jqueryplugins[$plugin]->component = $component; 561 $this->jqueryplugins[$plugin]->urls = array(); 562 563 foreach ($plugins[$plugin]['files'] as $file) { 564 if ($CFG->debugdeveloper) { 565 if (!file_exists("$componentdir/jquery/$file")) { 566 debugging("Invalid file '$file' specified in jQuery plugin '$plugin' in component '$component'"); 567 continue; 568 } 569 $file = str_replace('.min.css', '.css', $file); 570 $file = str_replace('.min.js', '.js', $file); 571 } 572 if (!file_exists("$componentdir/jquery/$file")) { 573 debugging("Invalid file '$file' specified in jQuery plugin '$plugin' in component '$component'"); 574 continue; 575 } 576 if (!empty($CFG->slasharguments)) { 577 $url = new moodle_url("/theme/jquery.php"); 578 $url->set_slashargument("/$component/$file"); 579 580 } else { 581 // This is not really good, we need slasharguments for relative links, this means no caching... 582 $path = realpath("$componentdir/jquery/$file"); 583 if (strpos($path, $CFG->dirroot) === 0) { 584 $url = $CFG->wwwroot.preg_replace('/^'.preg_quote($CFG->dirroot, '/').'/', '', $path); 585 // Replace all occurences of backslashes characters in url to forward slashes. 586 $url = str_replace('\\', '/', $url); 587 $url = new moodle_url($url); 588 } else { 589 // Bad luck, fix your server! 590 debugging("Moodle jQuery integration requires 'slasharguments' setting to be enabled."); 591 continue; 592 } 593 } 594 $this->jqueryplugins[$plugin]->urls[] = $url; 595 } 596 597 return true; 598 } 599 600 /** 601 * Request replacement of one jQuery plugin by another. 602 * 603 * This is useful when themes want to replace the jQuery UI theme, 604 * the problem is that theme can not prevent others from including the core ui-css plugin. 605 * 606 * Example: 607 * 1/ generate new jQuery UI theme and place it into theme/yourtheme/jquery/ 608 * 2/ write theme/yourtheme/jquery/plugins.php 609 * 3/ init jQuery from theme 610 * 611 * <code> 612 * // file theme/yourtheme/lib.php 613 * function theme_yourtheme_page_init($page) { 614 * $page->requires->jquery_plugin('yourtheme-ui-css', 'theme_yourtheme'); 615 * $page->requires->jquery_override_plugin('ui-css', 'yourtheme-ui-css'); 616 * } 617 * </code> 618 * 619 * This code prevents loading of standard 'ui-css' which my be requested by other plugins, 620 * the 'yourtheme-ui-css' gets loaded only if some other code requires jquery. 621 * 622 * {@see http://docs.moodle.org/dev/jQuery} 623 * 624 * @param string $oldplugin original plugin 625 * @param string $newplugin the replacement 626 */ 627 public function jquery_override_plugin($oldplugin, $newplugin) { 628 if ($this->headdone) { 629 debugging('Can not override jQuery plugins after starting page output!'); 630 return; 631 } 632 $this->jquerypluginoverrides[$oldplugin] = $newplugin; 633 } 634 635 /** 636 * Return jQuery related markup for page start. 637 * @return string 638 */ 639 protected function get_jquery_headcode() { 640 if (empty($this->jqueryplugins['jquery'])) { 641 // If nobody requested jQuery then do not bother to load anything. 642 // This may be useful for themes that want to override 'ui-css' only if requested by something else. 643 return ''; 644 } 645 646 $included = array(); 647 $urls = array(); 648 649 foreach ($this->jqueryplugins as $name => $unused) { 650 if (isset($included[$name])) { 651 continue; 652 } 653 if (array_key_exists($name, $this->jquerypluginoverrides)) { 654 // The following loop tries to resolve the replacements, 655 // use max 100 iterations to prevent infinite loop resulting 656 // in blank page. 657 $cyclic = true; 658 $oldname = $name; 659 for ($i=0; $i<100; $i++) { 660 $name = $this->jquerypluginoverrides[$name]; 661 if (!array_key_exists($name, $this->jquerypluginoverrides)) { 662 $cyclic = false; 663 break; 664 } 665 } 666 if ($cyclic) { 667 // We can not do much with cyclic references here, let's use the old plugin. 668 $name = $oldname; 669 debugging("Cyclic overrides detected for jQuery plugin '$name'"); 670 671 } else if (empty($name)) { 672 // Developer requested removal of the plugin. 673 continue; 674 675 } else if (!isset($this->jqueryplugins[$name])) { 676 debugging("Unknown jQuery override plugin '$name' detected"); 677 $name = $oldname; 678 679 } else if (isset($included[$name])) { 680 // The plugin was already included, easy. 681 continue; 682 } 683 } 684 685 $plugin = $this->jqueryplugins[$name]; 686 $urls = array_merge($urls, $plugin->urls); 687 $included[$name] = true; 688 } 689 690 $output = ''; 691 $attributes = array('rel' => 'stylesheet', 'type' => 'text/css'); 692 foreach ($urls as $url) { 693 if (preg_match('/\.js$/', $url)) { 694 $output .= html_writer::script('', $url); 695 } else if (preg_match('/\.css$/', $url)) { 696 $attributes['href'] = $url; 697 $output .= html_writer::empty_tag('link', $attributes) . "\n"; 698 } 699 } 700 701 return $output; 702 } 703 704 /** 705 * Returns the actual url through which a script is served. 706 * 707 * @param moodle_url|string $url full moodle url, or shortened path to script 708 * @return moodle_url 709 */ 710 protected function js_fix_url($url) { 711 global $CFG; 712 713 if ($url instanceof moodle_url) { 714 return $url; 715 } else if (strpos($url, '/') === 0) { 716 // Fix the admin links if needed. 717 if ($CFG->admin !== 'admin') { 718 if (strpos($url, "/admin/") === 0) { 719 $url = preg_replace("|^/admin/|", "/$CFG->admin/", $url); 720 } 721 } 722 if (debugging()) { 723 // Check file existence only when in debug mode. 724 if (!file_exists($CFG->dirroot . strtok($url, '?'))) { 725 throw new coding_exception('Attempt to require a JavaScript file that does not exist.', $url); 726 } 727 } 728 if (substr($url, -3) === '.js') { 729 $jsrev = $this->get_jsrev(); 730 if (empty($CFG->slasharguments)) { 731 return new moodle_url('/lib/javascript.php', array('rev'=>$jsrev, 'jsfile'=>$url)); 732 } else { 733 $returnurl = new moodle_url('/lib/javascript.php'); 734 $returnurl->set_slashargument('/'.$jsrev.$url); 735 return $returnurl; 736 } 737 } else { 738 return new moodle_url($url); 739 } 740 } else { 741 throw new coding_exception('Invalid JS url, it has to be shortened url starting with / or moodle_url instance.', $url); 742 } 743 } 744 745 /** 746 * Find out if JS module present and return details. 747 * 748 * @param string $component name of component in frankenstyle, ex: core_group, mod_forum 749 * @return array description of module or null if not found 750 */ 751 protected function find_module($component) { 752 global $CFG, $PAGE; 753 754 $module = null; 755 756 if (strpos($component, 'core_') === 0) { 757 // Must be some core stuff - list here is not complete, this is just the stuff used from multiple places 758 // so that we do nto have to repeat the definition of these modules over and over again. 759 switch($component) { 760 case 'core_filepicker': 761 $module = array('name' => 'core_filepicker', 762 'fullpath' => '/repository/filepicker.js', 763 'requires' => array( 764 'base', 'node', 'node-event-simulate', 'json', 'async-queue', 'io-base', 'io-upload-iframe', 'io-form', 765 'yui2-treeview', 'panel', 'cookie', 'datatable', 'datatable-sort', 'resize-plugin', 'dd-plugin', 766 'escape', 'moodle-core_filepicker', 'moodle-core-notification-dialogue' 767 ), 768 'strings' => array(array('lastmodified', 'moodle'), array('name', 'moodle'), array('type', 'repository'), array('size', 'repository'), 769 array('invalidjson', 'repository'), array('error', 'moodle'), array('info', 'moodle'), 770 array('nofilesattached', 'repository'), array('filepicker', 'repository'), array('logout', 'repository'), 771 array('nofilesavailable', 'repository'), array('norepositoriesavailable', 'repository'), 772 array('fileexistsdialogheader', 'repository'), array('fileexistsdialog_editor', 'repository'), 773 array('fileexistsdialog_filemanager', 'repository'), array('renameto', 'repository'), 774 array('referencesexist', 'repository'), array('select', 'repository') 775 )); 776 break; 777 case 'core_comment': 778 $module = array('name' => 'core_comment', 779 'fullpath' => '/comment/comment.js', 780 'requires' => array('base', 'io-base', 'node', 'json', 'yui2-animation', 'overlay', 'escape'), 781 'strings' => array(array('confirmdeletecomments', 'admin'), array('yes', 'moodle'), array('no', 'moodle')) 782 ); 783 break; 784 case 'core_role': 785 $module = array('name' => 'core_role', 786 'fullpath' => '/admin/roles/module.js', 787 'requires' => array('node', 'cookie')); 788 break; 789 case 'core_completion': 790 break; 791 case 'core_message': 792 $module = array('name' => 'core_message', 793 'requires' => array('base', 'node', 'event', 'node-event-simulate'), 794 'fullpath' => '/message/module.js'); 795 break; 796 case 'core_group': 797 $module = array('name' => 'core_group', 798 'fullpath' => '/group/module.js', 799 'requires' => array('node', 'overlay', 'event-mouseenter')); 800 break; 801 case 'core_question_engine': 802 $module = array('name' => 'core_question_engine', 803 'fullpath' => '/question/qengine.js', 804 'requires' => array('node', 'event')); 805 break; 806 case 'core_rating': 807 $module = array('name' => 'core_rating', 808 'fullpath' => '/rating/module.js', 809 'requires' => array('node', 'event', 'overlay', 'io-base', 'json')); 810 break; 811 case 'core_dndupload': 812 $module = array('name' => 'core_dndupload', 813 'fullpath' => '/lib/form/dndupload.js', 814 'requires' => array('node', 'event', 'json', 'core_filepicker'), 815 'strings' => array(array('uploadformlimit', 'moodle'), array('droptoupload', 'moodle'), array('maxfilesreached', 'moodle'), 816 array('dndenabled_inbox', 'moodle'), array('fileexists', 'moodle'), array('maxbytesfile', 'error'), 817 array('sizegb', 'moodle'), array('sizemb', 'moodle'), array('sizekb', 'moodle'), array('sizeb', 'moodle'), 818 array('maxareabytesreached', 'moodle'), array('serverconnection', 'error'), 819 array('changesmadereallygoaway', 'moodle'), array('complete', 'moodle') 820 )); 821 break; 822 } 823 824 } else { 825 if ($dir = core_component::get_component_directory($component)) { 826 if (file_exists("$dir/module.js")) { 827 if (strpos($dir, $CFG->dirroot.'/') === 0) { 828 $dir = substr($dir, strlen($CFG->dirroot)); 829 $module = array('name'=>$component, 'fullpath'=>"$dir/module.js", 'requires' => array()); 830 } 831 } 832 } 833 } 834 835 return $module; 836 } 837 838 /** 839 * Append YUI3 module to default YUI3 JS loader. 840 * The structure of module array is described at {@link http://developer.yahoo.com/yui/3/yui/} 841 * 842 * @param string|array $module name of module (details are autodetected), or full module specification as array 843 * @return void 844 */ 845 public function js_module($module) { 846 global $CFG; 847 848 if (empty($module)) { 849 throw new coding_exception('Missing YUI3 module name or full description.'); 850 } 851 852 if (is_string($module)) { 853 $module = $this->find_module($module); 854 } 855 856 if (empty($module) or empty($module['name']) or empty($module['fullpath'])) { 857 throw new coding_exception('Missing YUI3 module details.'); 858 } 859 860 $module['fullpath'] = $this->js_fix_url($module['fullpath'])->out(false); 861 // Add all needed strings. 862 if (!empty($module['strings'])) { 863 foreach ($module['strings'] as $string) { 864 $identifier = $string[0]; 865 $component = isset($string[1]) ? $string[1] : 'moodle'; 866 $a = isset($string[2]) ? $string[2] : null; 867 $this->string_for_js($identifier, $component, $a); 868 } 869 } 870 unset($module['strings']); 871 872 // Process module requirements and attempt to load each. This allows 873 // moodle modules to require each other. 874 if (!empty($module['requires'])){ 875 foreach ($module['requires'] as $requirement) { 876 $rmodule = $this->find_module($requirement); 877 if (is_array($rmodule)) { 878 $this->js_module($rmodule); 879 } 880 } 881 } 882 883 if ($this->headdone) { 884 $this->extramodules[$module['name']] = $module; 885 } else { 886 $this->YUI_config->add_module_config($module['name'], $module); 887 } 888 } 889 890 /** 891 * Returns true if the module has already been loaded. 892 * 893 * @param string|array $module 894 * @return bool True if the module has already been loaded 895 */ 896 protected function js_module_loaded($module) { 897 if (is_string($module)) { 898 $modulename = $module; 899 } else { 900 $modulename = $module['name']; 901 } 902 return array_key_exists($modulename, $this->YUI_config->modules) || 903 array_key_exists($modulename, $this->extramodules); 904 } 905 906 /** 907 * Ensure that the specified CSS file is linked to from this page. 908 * 909 * Because stylesheet links must go in the <head> part of the HTML, you must call 910 * this function before {@link get_head_code()} is called. That normally means before 911 * the call to print_header. If you call it when it is too late, an exception 912 * will be thrown. 913 * 914 * Even if a particular style sheet is requested more than once, it will only 915 * be linked to once. 916 * 917 * Please note use of this feature is strongly discouraged, 918 * it is suitable only for places where CSS is submitted directly by teachers. 919 * (Students must not be allowed to submit any external CSS because it may 920 * contain embedded javascript!). Example of correct use is mod/data. 921 * 922 * @param string $stylesheet The path to the .css file, relative to $CFG->wwwroot. 923 * For example: 924 * $PAGE->requires->css('mod/data/css.php?d='.$data->id); 925 */ 926 public function css($stylesheet) { 927 global $CFG; 928 929 if ($this->headdone) { 930 throw new coding_exception('Cannot require a CSS file after <head> has been printed.', $stylesheet); 931 } 932 933 if ($stylesheet instanceof moodle_url) { 934 // ok 935 } else if (strpos($stylesheet, '/') === 0) { 936 $stylesheet = new moodle_url($stylesheet); 937 } else { 938 throw new coding_exception('Invalid stylesheet parameter.', $stylesheet); 939 } 940 941 $this->cssurls[$stylesheet->out()] = $stylesheet; 942 } 943 944 /** 945 * Add theme stylesheet to page - do not use from plugin code, 946 * this should be called only from the core renderer! 947 * 948 * @param moodle_url $stylesheet 949 * @return void 950 */ 951 public function css_theme(moodle_url $stylesheet) { 952 $this->cssthemeurls[] = $stylesheet; 953 } 954 955 /** 956 * Ensure that a skip link to a given target is printed at the top of the <body>. 957 * 958 * You must call this function before {@link get_top_of_body_code()}, (if not, an exception 959 * will be thrown). That normally means you must call this before the call to print_header. 960 * 961 * If you ask for a particular skip link to be printed, it is then your responsibility 962 * to ensure that the appropriate <a name="..."> tag is printed in the body of the 963 * page, so that the skip link goes somewhere. 964 * 965 * Even if a particular skip link is requested more than once, only one copy of it will be output. 966 * 967 * @param string $target the name of anchor this link should go to. For example 'maincontent'. 968 * @param string $linktext The text to use for the skip link. Normally get_string('skipto', 'access', ...); 969 */ 970 public function skip_link_to($target, $linktext) { 971 if ($this->topofbodydone) { 972 debugging('Page header already printed, can not add skip links any more, code needs to be fixed.'); 973 return; 974 } 975 $this->skiplinks[$target] = $linktext; 976 } 977 978 /** 979 * !!!DEPRECATED!!! please use js_init_call() if possible 980 * Ensure that the specified JavaScript function is called from an inline script 981 * somewhere on this page. 982 * 983 * By default the call will be put in a script tag at the 984 * end of the page after initialising Y instance, since this gives best page-load 985 * performance and allows you to use YUI3 library. 986 * 987 * If you request that a particular function is called several times, then 988 * that is what will happen (unlike linking to a CSS or JS file, where only 989 * one link will be output). 990 * 991 * The main benefit of the method is the automatic encoding of all function parameters. 992 * 993 * @deprecated 994 * 995 * @param string $function the name of the JavaScritp function to call. Can 996 * be a compound name like 'Y.Event.purgeElement'. Can also be 997 * used to create and object by using a 'function name' like 'new user_selector'. 998 * @param array $arguments and array of arguments to be passed to the function. 999 * When generating the function call, this will be escaped using json_encode, 1000 * so passing objects and arrays should work. 1001 * @param bool $ondomready If tru the function is only called when the dom is 1002 * ready for manipulation. 1003 * @param int $delay The delay before the function is called. 1004 */ 1005 public function js_function_call($function, array $arguments = null, $ondomready = false, $delay = 0) { 1006 $where = $ondomready ? 'ondomready' : 'normal'; 1007 $this->jscalls[$where][] = array($function, $arguments, $delay); 1008 } 1009 1010 /** 1011 * This function appends a block of code to the AMD specific javascript block executed 1012 * in the page footer, just after loading the requirejs library. 1013 * 1014 * The code passed here can rely on AMD module loading, e.g. require('jquery', function($) {...}); 1015 * 1016 * @param string $code The JS code to append. 1017 */ 1018 public function js_amd_inline($code) { 1019 $this->amdjscode[] = $code; 1020 } 1021 1022 /** 1023 * Load an AMD module and eventually call its method. 1024 * 1025 * This function creates a minimal inline JS snippet that requires an AMD module and eventually calls a single 1026 * function from the module with given arguments. If it is called multiple times, it will be create multiple 1027 * snippets. 1028 * 1029 * @param string $fullmodule The name of the AMD module to load, formatted as <component name>/<module name>. 1030 * @param string $func Optional function from the module to call, defaults to just loading the AMD module. 1031 * @param array $params The params to pass to the function (will be serialized into JSON). 1032 */ 1033 public function js_call_amd($fullmodule, $func = null, $params = array()) { 1034 global $CFG; 1035 1036 list($component, $module) = explode('/', $fullmodule, 2); 1037 1038 $component = clean_param($component, PARAM_COMPONENT); 1039 $module = clean_param($module, PARAM_ALPHANUMEXT); 1040 $modname = "{$component}/{$module}"; 1041 1042 $functioncode = []; 1043 if ($func !== null) { 1044 $func = clean_param($func, PARAM_ALPHANUMEXT); 1045 1046 $jsonparams = array(); 1047 foreach ($params as $param) { 1048 $jsonparams[] = json_encode($param); 1049 } 1050 $strparams = implode(', ', $jsonparams); 1051 if ($CFG->debugdeveloper) { 1052 $toomanyparamslimit = 1024; 1053 if (strlen($strparams) > $toomanyparamslimit) { 1054 debugging('Too much data passed as arguments to js_call_amd("' . $fullmodule . '", "' . $func . 1055 '"). Generally there are better ways to pass lots of data from PHP to JavaScript, for example via Ajax, ' . 1056 'data attributes, ... . This warning is triggered if the argument string becomes longer than ' . 1057 $toomanyparamslimit . ' characters.', DEBUG_DEVELOPER); 1058 } 1059 } 1060 1061 $functioncode[] = "amd.{$func}({$strparams});"; 1062 } 1063 1064 $functioncode[] = "M.util.js_complete('{$modname}');"; 1065 1066 $initcode = implode(' ', $functioncode); 1067 $js = "M.util.js_pending('{$modname}'); require(['{$modname}'], function(amd) {{$initcode}});"; 1068 1069 $this->js_amd_inline($js); 1070 } 1071 1072 /** 1073 * Creates a JavaScript function call that requires one or more modules to be loaded. 1074 * 1075 * This function can be used to include all of the standard YUI module types within JavaScript: 1076 * - YUI3 modules [node, event, io] 1077 * - YUI2 modules [yui2-*] 1078 * - Moodle modules [moodle-*] 1079 * - Gallery modules [gallery-*] 1080 * 1081 * Before writing new code that makes extensive use of YUI, you should consider it's replacement AMD/JQuery. 1082 * @see js_call_amd() 1083 * 1084 * @param array|string $modules One or more modules 1085 * @param string $function The function to call once modules have been loaded 1086 * @param array $arguments An array of arguments to pass to the function 1087 * @param string $galleryversion Deprecated: The gallery version to use 1088 * @param bool $ondomready 1089 */ 1090 public function yui_module($modules, $function, array $arguments = null, $galleryversion = null, $ondomready = false) { 1091 if (!is_array($modules)) { 1092 $modules = array($modules); 1093 } 1094 1095 if ($galleryversion != null) { 1096 debugging('The galleryversion parameter to yui_module has been deprecated since Moodle 2.3.'); 1097 } 1098 1099 $jscode = 'Y.use('.join(',', array_map('json_encode', convert_to_array($modules))).',function() {'.js_writer::function_call($function, $arguments).'});'; 1100 if ($ondomready) { 1101 $jscode = "Y.on('domready', function() { $jscode });"; 1102 } 1103 $this->jsinitcode[] = $jscode; 1104 } 1105 1106 /** 1107 * Set the CSS Modules to be included from YUI. 1108 * 1109 * @param array $modules The list of YUI CSS Modules to include. 1110 */ 1111 public function set_yuicssmodules(array $modules = array()) { 1112 $this->yuicssmodules = $modules; 1113 } 1114 1115 /** 1116 * Ensure that the specified JavaScript function is called from an inline script 1117 * from page footer. 1118 * 1119 * @param string $function the name of the JavaScritp function to with init code, 1120 * usually something like 'M.mod_mymodule.init' 1121 * @param array $extraarguments and array of arguments to be passed to the function. 1122 * The first argument is always the YUI3 Y instance with all required dependencies 1123 * already loaded. 1124 * @param bool $ondomready wait for dom ready (helps with some IE problems when modifying DOM) 1125 * @param array $module JS module specification array 1126 */ 1127 public function js_init_call($function, array $extraarguments = null, $ondomready = false, array $module = null) { 1128 $jscode = js_writer::function_call_with_Y($function, $extraarguments); 1129 if (!$module) { 1130 // Detect module automatically. 1131 if (preg_match('/M\.([a-z0-9]+_[^\.]+)/', $function, $matches)) { 1132 $module = $this->find_module($matches[1]); 1133 } 1134 } 1135 1136 $this->js_init_code($jscode, $ondomready, $module); 1137 } 1138 1139 /** 1140 * Add short static javascript code fragment to page footer. 1141 * This is intended primarily for loading of js modules and initialising page layout. 1142 * Ideally the JS code fragment should be stored in plugin renderer so that themes 1143 * may override it. 1144 * 1145 * @param string $jscode 1146 * @param bool $ondomready wait for dom ready (helps with some IE problems when modifying DOM) 1147 * @param array $module JS module specification array 1148 */ 1149 public function js_init_code($jscode, $ondomready = false, array $module = null) { 1150 $jscode = trim($jscode, " ;\n"). ';'; 1151 1152 $uniqid = html_writer::random_id(); 1153 $startjs = " M.util.js_pending('" . $uniqid . "');"; 1154 $endjs = " M.util.js_complete('" . $uniqid . "');"; 1155 1156 if ($module) { 1157 $this->js_module($module); 1158 $modulename = $module['name']; 1159 $jscode = "$startjs Y.use('$modulename', function(Y) { $jscode $endjs });"; 1160 } 1161 1162 if ($ondomready) { 1163 $jscode = "$startjs Y.on('domready', function() { $jscode $endjs });"; 1164 } 1165 1166 $this->jsinitcode[] = $jscode; 1167 } 1168 1169 /** 1170 * Make a language string available to JavaScript. 1171 * 1172 * All the strings will be available in a M.str object in the global namespace. 1173 * So, for example, after a call to $PAGE->requires->string_for_js('course', 'moodle'); 1174 * then the JavaScript variable M.str.moodle.course will be 'Course', or the 1175 * equivalent in the current language. 1176 * 1177 * The arguments to this function are just like the arguments to get_string 1178 * except that $component is not optional, and there are some aspects to consider 1179 * when the string contains {$a} placeholder. 1180 * 1181 * If the string does not contain any {$a} placeholder, you can simply use 1182 * M.str.component.identifier to obtain it. If you prefer, you can call 1183 * M.util.get_string(identifier, component) to get the same result. 1184 * 1185 * If you need to use {$a} placeholders, there are two options. Either the 1186 * placeholder should be substituted in PHP on server side or it should 1187 * be substituted in Javascript at client side. 1188 * 1189 * To substitute the placeholder at server side, just provide the required 1190 * value for the placeholder when you require the string. Because each string 1191 * is only stored once in the JavaScript (based on $identifier and $module) 1192 * you cannot get the same string with two different values of $a. If you try, 1193 * an exception will be thrown. Once the placeholder is substituted, you can 1194 * use M.str or M.util.get_string() as shown above: 1195 * 1196 * // Require the string in PHP and replace the placeholder. 1197 * $PAGE->requires->string_for_js('fullnamedisplay', 'moodle', $USER); 1198 * // Use the result of the substitution in Javascript. 1199 * alert(M.str.moodle.fullnamedisplay); 1200 * 1201 * To substitute the placeholder at client side, use M.util.get_string() 1202 * function. It implements the same logic as {@link get_string()}: 1203 * 1204 * // Require the string in PHP but keep {$a} as it is. 1205 * $PAGE->requires->string_for_js('fullnamedisplay', 'moodle'); 1206 * // Provide the values on the fly in Javascript. 1207 * user = { firstname : 'Harry', lastname : 'Potter' } 1208 * alert(M.util.get_string('fullnamedisplay', 'moodle', user); 1209 * 1210 * If you do need the same string expanded with different $a values in PHP 1211 * on server side, then the solution is to put them in your own data structure 1212 * (e.g. and array) that you pass to JavaScript with {@link data_for_js()}. 1213 * 1214 * @param string $identifier the desired string. 1215 * @param string $component the language file to look in. 1216 * @param mixed $a any extra data to add into the string (optional). 1217 */ 1218 public function string_for_js($identifier, $component, $a = null) { 1219 if (!$component) { 1220 throw new coding_exception('The $component parameter is required for page_requirements_manager::string_for_js().'); 1221 } 1222 if (isset($this->stringsforjs_as[$component][$identifier]) and $this->stringsforjs_as[$component][$identifier] !== $a) { 1223 throw new coding_exception("Attempt to re-define already required string '$identifier' " . 1224 "from lang file '$component' with different \$a parameter?"); 1225 } 1226 if (!isset($this->stringsforjs[$component][$identifier])) { 1227 $this->stringsforjs[$component][$identifier] = new lang_string($identifier, $component, $a); 1228 $this->stringsforjs_as[$component][$identifier] = $a; 1229 } 1230 } 1231 1232 /** 1233 * Make an array of language strings available for JS. 1234 * 1235 * This function calls the above function {@link string_for_js()} for each requested 1236 * string in the $identifiers array that is passed to the argument for a single module 1237 * passed in $module. 1238 * 1239 * <code> 1240 * $PAGE->requires->strings_for_js(array('one', 'two', 'three'), 'mymod', array('a', null, 3)); 1241 * 1242 * // The above is identical to calling: 1243 * 1244 * $PAGE->requires->string_for_js('one', 'mymod', 'a'); 1245 * $PAGE->requires->string_for_js('two', 'mymod'); 1246 * $PAGE->requires->string_for_js('three', 'mymod', 3); 1247 * </code> 1248 * 1249 * @param array $identifiers An array of desired strings 1250 * @param string $component The module to load for 1251 * @param mixed $a This can either be a single variable that gets passed as extra 1252 * information for every string or it can be an array of mixed data where the 1253 * key for the data matches that of the identifier it is meant for. 1254 * 1255 */ 1256 public function strings_for_js($identifiers, $component, $a = null) { 1257 foreach ($identifiers as $key => $identifier) { 1258 if (is_array($a) && array_key_exists($key, $a)) { 1259 $extra = $a[$key]; 1260 } else { 1261 $extra = $a; 1262 } 1263 $this->string_for_js($identifier, $component, $extra); 1264 } 1265 } 1266 1267 /** 1268 * !!!!!!DEPRECATED!!!!!! please use js_init_call() for everything now. 1269 * 1270 * Make some data from PHP available to JavaScript code. 1271 * 1272 * For example, if you call 1273 * <pre> 1274 * $PAGE->requires->data_for_js('mydata', array('name' => 'Moodle')); 1275 * </pre> 1276 * then in JavsScript mydata.name will be 'Moodle'. 1277 * 1278 * @deprecated 1279 * @param string $variable the the name of the JavaScript variable to assign the data to. 1280 * Will probably work if you use a compound name like 'mybuttons.button[1]', but this 1281 * should be considered an experimental feature. 1282 * @param mixed $data The data to pass to JavaScript. This will be escaped using json_encode, 1283 * so passing objects and arrays should work. 1284 * @param bool $inhead initialise in head 1285 * @return void 1286 */ 1287 public function data_for_js($variable, $data, $inhead=false) { 1288 $where = $inhead ? 'head' : 'footer'; 1289 $this->jsinitvariables[$where][] = array($variable, $data); 1290 } 1291 1292 /** 1293 * Creates a YUI event handler. 1294 * 1295 * @param mixed $selector standard YUI selector for elements, may be array or string, element id is in the form "#idvalue" 1296 * @param string $event A valid DOM event (click, mousedown, change etc.) 1297 * @param string $function The name of the function to call 1298 * @param array $arguments An optional array of argument parameters to pass to the function 1299 */ 1300 public function event_handler($selector, $event, $function, array $arguments = null) { 1301 $this->eventhandlers[] = array('selector'=>$selector, 'event'=>$event, 'function'=>$function, 'arguments'=>$arguments); 1302 } 1303 1304 /** 1305 * Returns code needed for registering of event handlers. 1306 * @return string JS code 1307 */ 1308 protected function get_event_handler_code() { 1309 $output = ''; 1310 foreach ($this->eventhandlers as $h) { 1311 $output .= js_writer::event_handler($h['selector'], $h['event'], $h['function'], $h['arguments']); 1312 } 1313 return $output; 1314 } 1315 1316 /** 1317 * Get the inline JavaScript code that need to appear in a particular place. 1318 * @param bool $ondomready 1319 * @return string 1320 */ 1321 protected function get_javascript_code($ondomready) { 1322 $where = $ondomready ? 'ondomready' : 'normal'; 1323 $output = ''; 1324 if ($this->jscalls[$where]) { 1325 foreach ($this->jscalls[$where] as $data) { 1326 $output .= js_writer::function_call($data[0], $data[1], $data[2]); 1327 } 1328 if (!empty($ondomready)) { 1329 $output = " Y.on('domready', function() {\n$output\n});"; 1330 } 1331 } 1332 return $output; 1333 } 1334 1335 /** 1336 * Returns js code to be executed when Y is available. 1337 * @return string 1338 */ 1339 protected function get_javascript_init_code() { 1340 if (count($this->jsinitcode)) { 1341 return implode("\n", $this->jsinitcode) . "\n"; 1342 } 1343 return ''; 1344 } 1345 1346 /** 1347 * Returns js code to load amd module loader, then insert inline script tags 1348 * that contain require() calls using RequireJS. 1349 * @return string 1350 */ 1351 protected function get_amd_footercode() { 1352 global $CFG; 1353 $output = ''; 1354 1355 // We will cache JS if cachejs is not set, or it is true. 1356 $cachejs = !isset($CFG->cachejs) || $CFG->cachejs; 1357 $jsrev = $this->get_jsrev(); 1358 1359 $jsloader = new moodle_url('/lib/javascript.php'); 1360 $jsloader->set_slashargument('/' . $jsrev . '/'); 1361 $requirejsloader = new moodle_url('/lib/requirejs.php'); 1362 $requirejsloader->set_slashargument('/' . $jsrev . '/'); 1363 1364 $requirejsconfig = file_get_contents($CFG->dirroot . '/lib/requirejs/moodle-config.js'); 1365 1366 // No extension required unless slash args is disabled. 1367 $jsextension = '.js'; 1368 if (!empty($CFG->slasharguments)) { 1369 $jsextension = ''; 1370 } 1371 1372 $minextension = '.min'; 1373 if (!$cachejs) { 1374 $minextension = ''; 1375 } 1376 1377 $requirejsconfig = str_replace('[BASEURL]', $requirejsloader, $requirejsconfig); 1378 $requirejsconfig = str_replace('[JSURL]', $jsloader, $requirejsconfig); 1379 $requirejsconfig = str_replace('[JSMIN]', $minextension, $requirejsconfig); 1380 $requirejsconfig = str_replace('[JSEXT]', $jsextension, $requirejsconfig); 1381 1382 $output .= html_writer::script($requirejsconfig); 1383 if ($cachejs) { 1384 $output .= html_writer::script('', $this->js_fix_url('/lib/requirejs/require.min.js')); 1385 } else { 1386 $output .= html_writer::script('', $this->js_fix_url('/lib/requirejs/require.js')); 1387 } 1388 1389 // First include must be to a module with no dependencies, this prevents multiple requests. 1390 $prefix = <<<EOF 1391 M.util.js_pending("core/first"); 1392 require(['core/first'], function() { 1393 1394 EOF; 1395 1396 if (during_initial_install()) { 1397 // Do not run a prefetch during initial install as the DB is not available to service WS calls. 1398 $prefetch = ''; 1399 } else { 1400 $prefetch = "require(['core/prefetch'])\n"; 1401 } 1402 1403 $suffix = <<<EOF 1404 1405 M.util.js_complete("core/first"); 1406 }); 1407 EOF; 1408 1409 $output .= html_writer::script($prefix . $prefetch . implode(";\n", $this->amdjscode) . $suffix); 1410 return $output; 1411 } 1412 1413 /** 1414 * Returns basic YUI3 CSS code. 1415 * 1416 * @return string 1417 */ 1418 protected function get_yui3lib_headcss() { 1419 global $CFG; 1420 1421 $yuiformat = '-min'; 1422 if ($this->yui3loader->filter === 'RAW') { 1423 $yuiformat = ''; 1424 } 1425 1426 $code = ''; 1427 if ($this->yui3loader->combine) { 1428 if (!empty($this->yuicssmodules)) { 1429 $modules = array(); 1430 foreach ($this->yuicssmodules as $module) { 1431 $modules[] = "$CFG->yui3version/$module/$module-min.css"; 1432 } 1433 $code .= '<link rel="stylesheet" type="text/css" href="'.$this->yui3loader->comboBase.implode('&', $modules).'" />'; 1434 } 1435 $code .= '<link rel="stylesheet" type="text/css" href="'.$this->yui3loader->local_comboBase.'rollup/'.$CFG->yui3version.'/yui-moodlesimple' . $yuiformat . '.css" />'; 1436 1437 } else { 1438 if (!empty($this->yuicssmodules)) { 1439 foreach ($this->yuicssmodules as $module) { 1440 $code .= '<link rel="stylesheet" type="text/css" href="'.$this->yui3loader->base.$module.'/'.$module.'-min.css" />'; 1441 } 1442 } 1443 $code .= '<link rel="stylesheet" type="text/css" href="'.$this->yui3loader->local_comboBase.'rollup/'.$CFG->yui3version.'/yui-moodlesimple' . $yuiformat . '.css" />'; 1444 } 1445 1446 if ($this->yui3loader->filter === 'RAW') { 1447 $code = str_replace('-min.css', '.css', $code); 1448 } else if ($this->yui3loader->filter === 'DEBUG') { 1449 $code = str_replace('-min.css', '.css', $code); 1450 } 1451 return $code; 1452 } 1453 1454 /** 1455 * Returns basic YUI3 JS loading code. 1456 * 1457 * @return string 1458 */ 1459 protected function get_yui3lib_headcode() { 1460 global $CFG; 1461 1462 $jsrev = $this->get_jsrev(); 1463 1464 $yuiformat = '-min'; 1465 if ($this->yui3loader->filter === 'RAW') { 1466 $yuiformat = ''; 1467 } 1468 1469 $format = '-min'; 1470 if ($this->YUI_config->groups['moodle']['filter'] === 'DEBUG') { 1471 $format = '-debug'; 1472 } 1473 1474 $rollupversion = $CFG->yui3version; 1475 if (!empty($CFG->yuipatchlevel)) { 1476 $rollupversion .= '_' . $CFG->yuipatchlevel; 1477 } 1478 1479 $baserollups = array( 1480 'rollup/' . $rollupversion . "/yui-moodlesimple{$yuiformat}.js", 1481 ); 1482 1483 if ($this->yui3loader->combine) { 1484 return '<script src="' . 1485 $this->yui3loader->local_comboBase . 1486 implode('&', $baserollups) . 1487 '"></script>'; 1488 } else { 1489 $code = ''; 1490 foreach ($baserollups as $rollup) { 1491 $code .= '<script src="'.$this->yui3loader->local_comboBase.$rollup.'"></script>'; 1492 } 1493 return $code; 1494 } 1495 1496 } 1497 1498 /** 1499 * Returns html tags needed for inclusion of theme CSS. 1500 * 1501 * @return string 1502 */ 1503 protected function get_css_code() { 1504 // First of all the theme CSS, then any custom CSS 1505 // Please note custom CSS is strongly discouraged, 1506 // because it can not be overridden by themes! 1507 // It is suitable only for things like mod/data which accepts CSS from teachers. 1508 $attributes = array('rel'=>'stylesheet', 'type'=>'text/css'); 1509 1510 // Add the YUI code first. We want this to be overridden by any Moodle CSS. 1511 $code = $this->get_yui3lib_headcss(); 1512 1513 // This line of code may look funny but it is currently required in order 1514 // to avoid MASSIVE display issues in Internet Explorer. 1515 // As of IE8 + YUI3.1.1 the reference stylesheet (firstthemesheet) gets 1516 // ignored whenever another resource is added until such time as a redraw 1517 // is forced, usually by moving the mouse over the affected element. 1518 $code .= html_writer::tag('script', '/** Required in order to fix style inclusion problems in IE with YUI **/', array('id'=>'firstthemesheet', 'type'=>'text/css')); 1519 1520 $urls = $this->cssthemeurls + $this->cssurls; 1521 foreach ($urls as $url) { 1522 $attributes['href'] = $url; 1523 $code .= html_writer::empty_tag('link', $attributes) . "\n"; 1524 // This id is needed in first sheet only so that theme may override YUI sheets loaded on the fly. 1525 unset($attributes['id']); 1526 } 1527 1528 return $code; 1529 } 1530 1531 /** 1532 * Adds extra modules specified after printing of page header. 1533 * 1534 * @return string 1535 */ 1536 protected function get_extra_modules_code() { 1537 if (empty($this->extramodules)) { 1538 return ''; 1539 } 1540 return html_writer::script(js_writer::function_call('M.yui.add_module', array($this->extramodules))); 1541 } 1542 1543 /** 1544 * Generate any HTML that needs to go inside the <head> tag. 1545 * 1546 * Normally, this method is called automatically by the code that prints the 1547 * <head> tag. You should not normally need to call it in your own code. 1548 * 1549 * @param moodle_page $page 1550 * @param core_renderer $renderer 1551 * @return string the HTML code to to inside the <head> tag. 1552 */ 1553 public function get_head_code(moodle_page $page, core_renderer $renderer) { 1554 global $CFG; 1555 1556 // Note: the $page and $output are not stored here because it would 1557 // create circular references in memory which prevents garbage collection. 1558 $this->init_requirements_data($page, $renderer); 1559 1560 $output = ''; 1561 1562 // Add all standard CSS for this page. 1563 $output .= $this->get_css_code(); 1564 1565 // Set up the M namespace. 1566 $js = "var M = {}; M.yui = {};\n"; 1567 1568 // Capture the time now ASAP during page load. This minimises the lag when 1569 // we try to relate times on the server to times in the browser. 1570 // An example of where this is used is the quiz countdown timer. 1571 $js .= "M.pageloadstarttime = new Date();\n"; 1572 1573 // Add a subset of Moodle configuration to the M namespace. 1574 $js .= js_writer::set_variable('M.cfg', $this->M_cfg, false); 1575 1576 // Set up global YUI3 loader object - this should contain all code needed by plugins. 1577 // Note: in JavaScript just use "YUI().use('overlay', function(Y) { .... });", 1578 // this needs to be done before including any other script. 1579 $js .= $this->YUI_config->get_config_functions(); 1580 $js .= js_writer::set_variable('YUI_config', $this->YUI_config, false) . "\n"; 1581 $js .= "M.yui.loader = {modules: {}};\n"; // Backwards compatibility only, not used any more. 1582 $js = $this->YUI_config->update_header_js($js); 1583 1584 $output .= html_writer::script($js); 1585 1586 // Add variables. 1587 if ($this->jsinitvariables['head']) { 1588 $js = ''; 1589 foreach ($this->jsinitvariables['head'] as $data) { 1590 list($var, $value) = $data; 1591 $js .= js_writer::set_variable($var, $value, true); 1592 } 1593 $output .= html_writer::script($js); 1594 } 1595 1596 // Mark head sending done, it is not possible to anything there. 1597 $this->headdone = true; 1598 1599 return $output; 1600 } 1601 1602 /** 1603 * Generate any HTML that needs to go at the start of the <body> tag. 1604 * 1605 * Normally, this method is called automatically by the code that prints the 1606 * <head> tag. You should not normally need to call it in your own code. 1607 * 1608 * @param renderer_base $renderer 1609 * @return string the HTML code to go at the start of the <body> tag. 1610 */ 1611 public function get_top_of_body_code(renderer_base $renderer) { 1612 global $CFG; 1613 1614 // First the skip links. 1615 $output = $renderer->render_skip_links($this->skiplinks); 1616 1617 // The polyfill needs to load before the other JavaScript in order to make sure 1618 // that we have access to the functions it provides. 1619 if (empty($CFG->cachejs)) { 1620 $output .= html_writer::script('', $this->js_fix_url('/lib/babel-polyfill/polyfill.js')); 1621 } else { 1622 $output .= html_writer::script('', $this->js_fix_url('/lib/babel-polyfill/polyfill.min.js')); 1623 } 1624 1625 // Include the Polyfills. 1626 $output .= html_writer::script('', $this->js_fix_url('/lib/polyfills/polyfill.js')); 1627 1628 // YUI3 JS needs to be loaded early in the body. It should be cached well by the browser. 1629 $output .= $this->get_yui3lib_headcode(); 1630 1631 // Add hacked jQuery support, it is not intended for standard Moodle distribution! 1632 $output .= $this->get_jquery_headcode(); 1633 1634 // Link our main JS file, all core stuff should be there. 1635 $output .= html_writer::script('', $this->js_fix_url('/lib/javascript-static.js')); 1636 1637 // All the other linked things from HEAD - there should be as few as possible. 1638 if ($this->jsincludes['head']) { 1639 foreach ($this->jsincludes['head'] as $url) { 1640 $output .= html_writer::script('', $url); 1641 } 1642 } 1643 1644 // Then the clever trick for hiding of things not needed when JS works. 1645 $output .= html_writer::script("document.body.className += ' jsenabled';") . "\n"; 1646 $this->topofbodydone = true; 1647 return $output; 1648 } 1649 1650 /** 1651 * Generate any HTML that needs to go at the end of the page. 1652 * 1653 * Normally, this method is called automatically by the code that prints the 1654 * page footer. You should not normally need to call it in your own code. 1655 * 1656 * @return string the HTML code to to at the end of the page. 1657 */ 1658 public function get_end_code() { 1659 global $CFG; 1660 $output = ''; 1661 1662 // Set the log level for the JS logging. 1663 $logconfig = new stdClass(); 1664 $logconfig->level = 'warn'; 1665 if ($CFG->debugdeveloper) { 1666 $logconfig->level = 'trace'; 1667 } 1668 $this->js_call_amd('core/log', 'setConfig', array($logconfig)); 1669 // Add any global JS that needs to run on all pages. 1670 $this->js_call_amd('core/page_global', 'init'); 1671 1672 // Call amd init functions. 1673 $output .= $this->get_amd_footercode(); 1674 1675 // Add other requested modules. 1676 $output .= $this->get_extra_modules_code(); 1677 1678 $this->js_init_code('M.util.js_complete("init");', true); 1679 1680 // All the other linked scripts - there should be as few as possible. 1681 if ($this->jsincludes['footer']) { 1682 foreach ($this->jsincludes['footer'] as $url) { 1683 $output .= html_writer::script('', $url); 1684 } 1685 } 1686 1687 // Add all needed strings. 1688 // First add core strings required for some dialogues. 1689 $this->strings_for_js(array( 1690 'confirm', 1691 'yes', 1692 'no', 1693 'areyousure', 1694 'closebuttontitle', 1695 'unknownerror', 1696 'error', 1697 'file', 1698 'url', 1699 // TODO MDL-70830 shortforms should preload the collapseall/expandall strings properly. 1700 'collapseall', 1701 'expandall', 1702 ), 'moodle'); 1703 $this->strings_for_js(array( 1704 'debuginfo', 1705 'line', 1706 'stacktrace', 1707 ), 'debug'); 1708 $this->string_for_js('labelsep', 'langconfig'); 1709 if (!empty($this->stringsforjs)) { 1710 $strings = array(); 1711 foreach ($this->stringsforjs as $component=>$v) { 1712 foreach($v as $indentifier => $langstring) { 1713 $strings[$component][$indentifier] = $langstring->out(); 1714 } 1715 } 1716 $output .= html_writer::script(js_writer::set_variable('M.str', $strings)); 1717 } 1718 1719 // Add variables. 1720 if ($this->jsinitvariables['footer']) { 1721 $js = ''; 1722 foreach ($this->jsinitvariables['footer'] as $data) { 1723 list($var, $value) = $data; 1724 $js .= js_writer::set_variable($var, $value, true); 1725 } 1726 $output .= html_writer::script($js); 1727 } 1728 1729 $inyuijs = $this->get_javascript_code(false); 1730 $ondomreadyjs = $this->get_javascript_code(true); 1731 $jsinit = $this->get_javascript_init_code(); 1732 $handlersjs = $this->get_event_handler_code(); 1733 1734 // There is a global Y, make sure it is available in your scope. 1735 $js = "(function() {{$inyuijs}{$ondomreadyjs}{$jsinit}{$handlersjs}})();"; 1736 1737 $output .= html_writer::script($js); 1738 1739 return $output; 1740 } 1741 1742 /** 1743 * Have we already output the code in the <head> tag? 1744 * 1745 * @return bool 1746 */ 1747 public function is_head_done() { 1748 return $this->headdone; 1749 } 1750 1751 /** 1752 * Have we already output the code at the start of the <body> tag? 1753 * 1754 * @return bool 1755 */ 1756 public function is_top_of_body_done() { 1757 return $this->topofbodydone; 1758 } 1759 1760 /** 1761 * Should we generate a bit of content HTML that is only required once on 1762 * this page (e.g. the contents of the modchooser), now? Basically, we call 1763 * {@link has_one_time_item_been_created()}, and if the thing has not already 1764 * been output, we return true to tell the caller to generate it, and also 1765 * call {@link set_one_time_item_created()} to record the fact that it is 1766 * about to be generated. 1767 * 1768 * That is, a typical usage pattern (in a renderer method) is: 1769 * <pre> 1770 * if (!$this->page->requires->should_create_one_time_item_now($thing)) { 1771 * return ''; 1772 * } 1773 * // Else generate it. 1774 * </pre> 1775 * 1776 * @param string $thing identifier for the bit of content. Should be of the form 1777 * frankenstyle_things, e.g. core_course_modchooser. 1778 * @return bool if true, the caller should generate that bit of output now, otherwise don't. 1779 */ 1780 public function should_create_one_time_item_now($thing) { 1781 if ($this->has_one_time_item_been_created($thing)) { 1782 return false; 1783 } 1784 1785 $this->set_one_time_item_created($thing); 1786 return true; 1787 } 1788 1789 /** 1790 * Has a particular bit of HTML that is only required once on this page 1791 * (e.g. the contents of the modchooser) already been generated? 1792 * 1793 * Normally, you can use the {@link should_create_one_time_item_now()} helper 1794 * method rather than calling this method directly. 1795 * 1796 * @param string $thing identifier for the bit of content. Should be of the form 1797 * frankenstyle_things, e.g. core_course_modchooser. 1798 * @return bool whether that bit of output has been created. 1799 */ 1800 public function has_one_time_item_been_created($thing) { 1801 return isset($this->onetimeitemsoutput[$thing]); 1802 } 1803 1804 /** 1805 * Indicate that a particular bit of HTML that is only required once on this 1806 * page (e.g. the contents of the modchooser) has been generated (or is about to be)? 1807 * 1808 * Normally, you can use the {@link should_create_one_time_item_now()} helper 1809 * method rather than calling this method directly. 1810 * 1811 * @param string $thing identifier for the bit of content. Should be of the form 1812 * frankenstyle_things, e.g. core_course_modchooser. 1813 */ 1814 public function set_one_time_item_created($thing) { 1815 if ($this->has_one_time_item_been_created($thing)) { 1816 throw new coding_exception($thing . ' is only supposed to be ouput ' . 1817 'once per page, but it seems to be being output again.'); 1818 } 1819 return $this->onetimeitemsoutput[$thing] = true; 1820 } 1821 } 1822 1823 /** 1824 * This class represents the YUI configuration. 1825 * 1826 * @copyright 2013 Andrew Nicols 1827 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 1828 * @since Moodle 2.5 1829 * @package core 1830 * @category output 1831 */ 1832 class YUI_config { 1833 /** 1834 * These settings must be public so that when the object is converted to json they are exposed. 1835 * Note: Some of these are camelCase because YUI uses camelCase variable names. 1836 * 1837 * The settings are described and documented in the YUI API at: 1838 * - http://yuilibrary.com/yui/docs/api/classes/config.html 1839 * - http://yuilibrary.com/yui/docs/api/classes/Loader.html 1840 */ 1841 public $debug = false; 1842 public $base; 1843 public $comboBase; 1844 public $combine; 1845 public $filter = null; 1846 public $insertBefore = 'firstthemesheet'; 1847 public $groups = array(); 1848 public $modules = array(); 1849 1850 /** 1851 * @var array List of functions used by the YUI Loader group pattern recognition. 1852 */ 1853 protected $jsconfigfunctions = array(); 1854 1855 /** 1856 * Create a new group within the YUI_config system. 1857 * 1858 * @param String $name The name of the group. This must be unique and 1859 * not previously used. 1860 * @param Array $config The configuration for this group. 1861 * @return void 1862 */ 1863 public function add_group($name, $config) { 1864 if (isset($this->groups[$name])) { 1865 throw new coding_exception("A YUI configuration group for '{$name}' already exists. To make changes to this group use YUI_config->update_group()."); 1866 } 1867 $this->groups[$name] = $config; 1868 } 1869 1870 /** 1871 * Update an existing group configuration 1872 * 1873 * Note, any existing configuration for that group will be wiped out. 1874 * This includes module configuration. 1875 * 1876 * @param String $name The name of the group. This must be unique and 1877 * not previously used. 1878 * @param Array $config The configuration for this group. 1879 * @return void 1880 */ 1881 public function update_group($name, $config) { 1882 if (!isset($this->groups[$name])) { 1883 throw new coding_exception('The Moodle YUI module does not exist. You must define the moodle module config using YUI_config->add_module_config first.'); 1884 } 1885 $this->groups[$name] = $config; 1886 } 1887 1888 /** 1889 * Set the value of a configuration function used by the YUI Loader's pattern testing. 1890 * 1891 * Only the body of the function should be passed, and not the whole function wrapper. 1892 * 1893 * The JS function your write will be passed a single argument 'name' containing the 1894 * name of the module being loaded. 1895 * 1896 * @param $function String the body of the JavaScript function. This should be used i 1897 * @return String the name of the function to use in the group pattern configuration. 1898 */ 1899 public function set_config_function($function) { 1900 $configname = 'yui' . (count($this->jsconfigfunctions) + 1) . 'ConfigFn'; 1901 if (isset($this->jsconfigfunctions[$configname])) { 1902 throw new coding_exception("A YUI config function with this name already exists. Config function names must be unique."); 1903 } 1904 $this->jsconfigfunctions[$configname] = $function; 1905 return '@' . $configname . '@'; 1906 } 1907 1908 /** 1909 * Allow setting of the config function described in {@see set_config_function} from a file. 1910 * The contents of this file are then passed to set_config_function. 1911 * 1912 * When jsrev is positive, the function is minified and stored in a MUC cache for subsequent uses. 1913 * 1914 * @param $file The path to the JavaScript function used for YUI configuration. 1915 * @return String the name of the function to use in the group pattern configuration. 1916 */ 1917 public function set_config_source($file) { 1918 global $CFG; 1919 $cache = cache::make('core', 'yuimodules'); 1920 1921 // Attempt to get the metadata from the cache. 1922 $keyname = 'configfn_' . $file; 1923 $fullpath = $CFG->dirroot . '/' . $file; 1924 if (!isset($CFG->jsrev) || $CFG->jsrev == -1) { 1925 $cache->delete($keyname); 1926 $configfn = file_get_contents($fullpath); 1927 } else { 1928 $configfn = $cache->get($keyname); 1929 if ($configfn === false) { 1930 require_once($CFG->libdir . '/jslib.php'); 1931 $configfn = core_minify::js_files(array($fullpath)); 1932 $cache->set($keyname, $configfn); 1933 } 1934 } 1935 return $this->set_config_function($configfn); 1936 } 1937 1938 /** 1939 * Retrieve the list of JavaScript functions for YUI_config groups. 1940 * 1941 * @return String The complete set of config functions 1942 */ 1943 public function get_config_functions() { 1944 $configfunctions = ''; 1945 foreach ($this->jsconfigfunctions as $functionname => $function) { 1946 $configfunctions .= "var {$functionname} = function(me) {"; 1947 $configfunctions .= $function; 1948 $configfunctions .= "};\n"; 1949 } 1950 return $configfunctions; 1951 } 1952 1953 /** 1954 * Update the header JavaScript with any required modification for the YUI Loader. 1955 * 1956 * @param $js String The JavaScript to manipulate. 1957 * @return String the modified JS string. 1958 */ 1959 public function update_header_js($js) { 1960 // Update the names of the the configFn variables. 1961 // The PHP json_encode function cannot handle literal names so we have to wrap 1962 // them in @ and then replace them with literals of the same function name. 1963 foreach ($this->jsconfigfunctions as $functionname => $function) { 1964 $js = str_replace('"@' . $functionname . '@"', $functionname, $js); 1965 } 1966 return $js; 1967 } 1968 1969 /** 1970 * Add configuration for a specific module. 1971 * 1972 * @param String $name The name of the module to add configuration for. 1973 * @param Array $config The configuration for the specified module. 1974 * @param String $group The name of the group to add configuration for. 1975 * If not specified, then this module is added to the global 1976 * configuration. 1977 * @return void 1978 */ 1979 public function add_module_config($name, $config, $group = null) { 1980 if ($group) { 1981 if (!isset($this->groups[$name])) { 1982 throw new coding_exception('The Moodle YUI module does not exist. You must define the moodle module config using YUI_config->add_module_config first.'); 1983 } 1984 if (!isset($this->groups[$group]['modules'])) { 1985 $this->groups[$group]['modules'] = array(); 1986 } 1987 $modules = &$this->groups[$group]['modules']; 1988 } else { 1989 $modules = &$this->modules; 1990 } 1991 $modules[$name] = $config; 1992 } 1993 1994 /** 1995 * Add the moodle YUI module metadata for the moodle group to the YUI_config instance. 1996 * 1997 * If js caching is disabled, metadata will not be served causing YUI to calculate 1998 * module dependencies as each module is loaded. 1999 * 2000 * If metadata does not exist it will be created and stored in a MUC entry. 2001 * 2002 * @return void 2003 */ 2004 public function add_moodle_metadata() { 2005 global $CFG; 2006 if (!isset($this->groups['moodle'])) { 2007 throw new coding_exception('The Moodle YUI module does not exist. You must define the moodle module config using YUI_config->add_module_config first.'); 2008 } 2009 2010 if (!isset($this->groups['moodle']['modules'])) { 2011 $this->groups['moodle']['modules'] = array(); 2012 } 2013 2014 $cache = cache::make('core', 'yuimodules'); 2015 if (!isset($CFG->jsrev) || $CFG->jsrev == -1) { 2016 $metadata = array(); 2017 $metadata = $this->get_moodle_metadata(); 2018 $cache->delete('metadata'); 2019 } else { 2020 // Attempt to get the metadata from the cache. 2021 if (!$metadata = $cache->get('metadata')) { 2022 $metadata = $this->get_moodle_metadata(); 2023 $cache->set('metadata', $metadata); 2024 } 2025 } 2026 2027 // Merge with any metadata added specific to this page which was added manually. 2028 $this->groups['moodle']['modules'] = array_merge($this->groups['moodle']['modules'], 2029 $metadata); 2030 } 2031 2032 /** 2033 * Determine the module metadata for all moodle YUI modules. 2034 * 2035 * This works through all modules capable of serving YUI modules, and attempts to get 2036 * metadata for each of those modules. 2037 * 2038 * @return Array of module metadata 2039 */ 2040 private function get_moodle_metadata() { 2041 $moodlemodules = array(); 2042 // Core isn't a plugin type or subsystem - handle it seperately. 2043 if ($module = $this->get_moodle_path_metadata(core_component::get_component_directory('core'))) { 2044 $moodlemodules = array_merge($moodlemodules, $module); 2045 } 2046 2047 // Handle other core subsystems. 2048 $subsystems = core_component::get_core_subsystems(); 2049 foreach ($subsystems as $subsystem => $path) { 2050 if (is_null($path)) { 2051 continue; 2052 } 2053 if ($module = $this->get_moodle_path_metadata($path)) { 2054 $moodlemodules = array_merge($moodlemodules, $module); 2055 } 2056 } 2057 2058 // And finally the plugins. 2059 $plugintypes = core_component::get_plugin_types(); 2060 foreach ($plugintypes as $plugintype => $pathroot) { 2061 $pluginlist = core_component::get_plugin_list($plugintype); 2062 foreach ($pluginlist as $plugin => $path) { 2063 if ($module = $this->get_moodle_path_metadata($path)) { 2064 $moodlemodules = array_merge($moodlemodules, $module); 2065 } 2066 } 2067 } 2068 2069 return $moodlemodules; 2070 } 2071 2072 /** 2073 * Helper function process and return the YUI metadata for all of the modules under the specified path. 2074 * 2075 * @param String $path the UNC path to the YUI src directory. 2076 * @return Array the complete array for frankenstyle directory. 2077 */ 2078 private function get_moodle_path_metadata($path) { 2079 // Add module metadata is stored in frankenstyle_modname/yui/src/yui_modname/meta/yui_modname.json. 2080 $baseyui = $path . '/yui/src'; 2081 $modules = array(); 2082 if (is_dir($baseyui)) { 2083 $items = new DirectoryIterator($baseyui); 2084 foreach ($items as $item) { 2085 if ($item->isDot() or !$item->isDir()) { 2086 continue; 2087 } 2088 $metafile = realpath($baseyui . '/' . $item . '/meta/' . $item . '.json'); 2089 if (!is_readable($metafile)) { 2090 continue; 2091 } 2092 $metadata = file_get_contents($metafile); 2093 $modules = array_merge($modules, (array) json_decode($metadata)); 2094 } 2095 } 2096 return $modules; 2097 } 2098 2099 /** 2100 * Define YUI modules which we have been required to patch between releases. 2101 * 2102 * We must do this because we aggressively cache content on the browser, and we must also override use of the 2103 * external CDN which will serve the true authoritative copy of the code without our patches. 2104 * 2105 * @param String combobase The local combobase 2106 * @param String yuiversion The current YUI version 2107 * @param Int patchlevel The patch level we're working to for YUI 2108 * @param Array patchedmodules An array containing the names of the patched modules 2109 * @return void 2110 */ 2111 public function define_patched_core_modules($combobase, $yuiversion, $patchlevel, $patchedmodules) { 2112 // The version we use is suffixed with a patchlevel so that we can get additional revisions between YUI releases. 2113 $subversion = $yuiversion . '_' . $patchlevel; 2114 2115 if ($this->comboBase == $combobase) { 2116 // If we are using the local combobase in the loader, we can add a group and still make use of the combo 2117 // loader. We just need to specify a different root which includes a slightly different YUI version number 2118 // to include our patchlevel. 2119 $patterns = array(); 2120 $modules = array(); 2121 foreach ($patchedmodules as $modulename) { 2122 // We must define the pattern and module here so that the loader uses our group configuration instead of 2123 // the standard module definition. We may lose some metadata provided by upstream but this will be 2124 // loaded when the module is loaded anyway. 2125 $patterns[$modulename] = array( 2126 'group' => 'yui-patched', 2127 ); 2128 $modules[$modulename] = array(); 2129 } 2130 2131 // Actually add the patch group here. 2132 $this->add_group('yui-patched', array( 2133 'combine' => true, 2134 'root' => $subversion . '/', 2135 'patterns' => $patterns, 2136 'modules' => $modules, 2137 )); 2138 2139 } else { 2140 // The CDN is in use - we need to instead use the local combobase for this module and override the modules 2141 // definition. We cannot use the local base - we must use the combobase because we cannot invalidate the 2142 // local base in browser caches. 2143 $fullpathbase = $combobase . $subversion . '/'; 2144 foreach ($patchedmodules as $modulename) { 2145 $this->modules[$modulename] = array( 2146 'fullpath' => $fullpathbase . $modulename . '/' . $modulename . '-min.js' 2147 ); 2148 } 2149 } 2150 } 2151 } 2152 2153 /** 2154 * Invalidate all server and client side template caches. 2155 */ 2156 function template_reset_all_caches() { 2157 global $CFG; 2158 2159 $next = time(); 2160 if (isset($CFG->templaterev) and $next <= $CFG->templaterev and $CFG->templaterev - $next < 60 * 60) { 2161 // This resolves problems when reset is requested repeatedly within 1s, 2162 // the < 1h condition prevents accidental switching to future dates 2163 // because we might not recover from it. 2164 $next = $CFG->templaterev + 1; 2165 } 2166 2167 set_config('templaterev', $next); 2168 } 2169 2170 /** 2171 * Invalidate all server and client side JS caches. 2172 */ 2173 function js_reset_all_caches() { 2174 global $CFG; 2175 2176 $next = time(); 2177 if (isset($CFG->jsrev) and $next <= $CFG->jsrev and $CFG->jsrev - $next < 60*60) { 2178 // This resolves problems when reset is requested repeatedly within 1s, 2179 // the < 1h condition prevents accidental switching to future dates 2180 // because we might not recover from it. 2181 $next = $CFG->jsrev+1; 2182 } 2183 2184 set_config('jsrev', $next); 2185 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
