lib/javascript-static.js

   1 // Miscellaneous core Javascript functions for Moodle
   2 // Global M object is initilised in inline javascript
   3
   4 /**
   5  * Add module to list of available modules that can be loaded from YUI.
   6  * @param {Array} modules
   7  */
   8 M.yui.add_module = function(modules) {
   9     for (var modname in modules) {
  10         YUI_config.modules[modname] = modules[modname];
  11     }
  12     // Ensure thaat the YUI_config is applied to the main YUI instance.
  13     Y.applyConfig(YUI_config);
  14 };
  15 /**
  16  * The gallery version to use when loading YUI modules from the gallery.
  17  * Will be changed every time when using local galleries.
  18  */
  19 M.yui.galleryversion = '2010.04.21-21-51';
  20
  21 /**
  22  * Various utility functions
  23  */
  24 M.util = M.util || {};
  25
  26 /**
  27  * Language strings - initialised from page footer.
  28  */
  29 M.str = M.str || {};
  30
  31 /**
  32  * Returns url for images.
  33  * @param {String} imagename
  34  * @param {String} component
  35  * @return {String}
  36  */
  37 M.util.image_url = function(imagename, component) {
  38
  39     if (!component || component == '' || component == 'moodle' || component == 'core') {
  40         component = 'core';
  41     }
  42
  43     var url = M.cfg.wwwroot + '/theme/image.php';
  44     if (M.cfg.themerev > 0 && M.cfg.slasharguments == 1) {
  45         if (!M.cfg.svgicons) {
  46             url += '/_s';
  47         }
  48         url += '/' + M.cfg.theme + '/' + component + '/' + M.cfg.themerev + '/' + imagename;
  49     } else {
  50         url += '?theme=' + M.cfg.theme + '&component=' + component + '&rev=' + M.cfg.themerev + '&image=' + imagename;
  51         if (!M.cfg.svgicons) {
  52             url += '&svg=0';
  53         }
  54     }
  55
  56     return url;
  57 };
  58
  59 M.util.in_array = function(item, array){
  60     for( var i = 0; i<array.length; i++){
  61         if(item==array[i]){
  62             return true;
  63         }
  64     }
  65     return false;
  66 };
  67
  68 /**
  69  * Init a collapsible region, see print_collapsible_region in weblib.php
  70  * @param {YUI} Y YUI3 instance with all libraries loaded
  71  * @param {String} id the HTML id for the div.
  72  * @param {String} userpref the user preference that records the state of this box. false if none.
  73  * @param {String} strtooltip
  74  */
  75 M.util.init_collapsible_region = function(Y, id, userpref, strtooltip) {
  76     Y.use('anim', function(Y) {
  77         new M.util.CollapsibleRegion(Y, id, userpref, strtooltip);
  78     });
  79 };
  80
  81 /**
  82  * Object to handle a collapsible region : instantiate and forget styled object
  83  *
  84  * @class
  85  * @constructor
  86  * @param {YUI} Y YUI3 instance with all libraries loaded
  87  * @param {String} id The HTML id for the div.
  88  * @param {String} userpref The user preference that records the state of this box. false if none.
  89  * @param {String} strtooltip
  90  */
  91 M.util.CollapsibleRegion = function(Y, id, userpref, strtooltip) {
  92     // Record the pref name
  93     this.userpref = userpref;
  94
  95     // Find the divs in the document.
  96     this.div = Y.one('#'+id);
  97
  98     // Get the caption for the collapsible region
  99     var caption = this.div.one('#'+id + '_caption');
 100
 101     // Create a link
 102     var a = Y.Node.create('<a href="#"></a>');
 103     a.setAttribute('title', strtooltip);
 104
 105     // Get all the nodes from caption, remove them and append them to <a>
 106     while (caption.hasChildNodes()) {
 107         child = caption.get('firstChild');
 108         child.remove();
 109         a.append(child);
 110     }
 111     caption.append(a);
 112
 113     // Get the height of the div at this point before we shrink it if required
 114     var height = this.div.get('offsetHeight');
 115     var collapsedimage = 't/collapsed'; // ltr mode
 116     if (right_to_left()) {
 117         collapsedimage = 't/collapsed_rtl';
 118     } else {
 119         collapsedimage = 't/collapsed';
 120     }
 121     if (this.div.hasClass('collapsed')) {
 122         // Add the correct image and record the YUI node created in the process
 123         this.icon = Y.Node.create('<img src="'+M.util.image_url(collapsedimage, 'moodle')+'" alt="" />');
 124         // Shrink the div as it is collapsed by default
 125         this.div.setStyle('height', caption.get('offsetHeight')+'px');
 126     } else {
 127         // Add the correct image and record the YUI node created in the process
 128         this.icon = Y.Node.create('<img src="'+M.util.image_url('t/expanded', 'moodle')+'" alt="" />');
 129     }
 130     a.append(this.icon);
 131
 132     // Create the animation.
 133     var animation = new Y.Anim({
 134         node: this.div,
 135         duration: 0.3,
 136         easing: Y.Easing.easeBoth,
 137         to: {height:caption.get('offsetHeight')},
 138         from: {height:height}
 139     });
 140
 141     // Handler for the animation finishing.
 142     animation.on('end', function() {
 143         this.div.toggleClass('collapsed');
 144         var collapsedimage = 't/collapsed'; // ltr mode
 145         if (right_to_left()) {
 146             collapsedimage = 't/collapsed_rtl';
 147             } else {
 148             collapsedimage = 't/collapsed';
 149             }
 150         if (this.div.hasClass('collapsed')) {
 151             this.icon.set('src', M.util.image_url(collapsedimage, 'moodle'));
 152         } else {
 153             this.icon.set('src', M.util.image_url('t/expanded', 'moodle'));
 154         }
 155     }, this);
 156
 157     // Hook up the event handler.
 158     a.on('click', function(e, animation) {
 159         e.preventDefault();
 160         // Animate to the appropriate size.
 161         if (animation.get('running')) {
 162             animation.stop();
 163         }
 164         animation.set('reverse', this.div.hasClass('collapsed'));
 165         // Update the user preference.
 166         if (this.userpref) {
 167             M.util.set_user_preference(this.userpref, !this.div.hasClass('collapsed'));
 168         }
 169         animation.run();
 170     }, this, animation);
 171 };
 172
 173 /**
 174  * The user preference that stores the state of this box.
 175  * @property userpref
 176  * @type String
 177  */
 178 M.util.CollapsibleRegion.prototype.userpref = null;
 179
 180 /**
 181  * The key divs that make up this
 182  * @property div
 183  * @type Y.Node
 184  */
 185 M.util.CollapsibleRegion.prototype.div = null;
 186
 187 /**
 188  * The key divs that make up this
 189  * @property icon
 190  * @type Y.Node
 191  */
 192 M.util.CollapsibleRegion.prototype.icon = null;
 193
 194 /**
 195  * Makes a best effort to connect back to Moodle to update a user preference,
 196  * however, there is no mechanism for finding out if the update succeeded.
 197  *
 198  * Before you can use this function in your JavsScript, you must have called
 199  * user_preference_allow_ajax_update from moodlelib.php to tell Moodle that
 200  * the udpate is allowed, and how to safely clean and submitted values.
 201  *
 202  * @param String name the name of the setting to udpate.
 203  * @param String the value to set it to.
 204  */
 205 M.util.set_user_preference = function(name, value) {
 206     YUI().use('io', function(Y) {
 207         var url = M.cfg.wwwroot + '/lib/ajax/setuserpref.php?sesskey=' +
 208                 M.cfg.sesskey + '&pref=' + encodeURI(name) + '&value=' + encodeURI(value);
 209
 210         // If we are a developer, ensure that failures are reported.
 211         var cfg = {
 212                 method: 'get',
 213                 on: {}
 214             };
 215         if (M.cfg.developerdebug) {
 216             cfg.on.failure = function(id, o, args) {
 217                 alert("Error updating user preference '" + name + "' using ajax. Clicking this link will repeat the Ajax call that failed so you can see the error: ");
 218             }
 219         }
 220
 221         // Make the request.
 222         Y.io(url, cfg);
 223     });
 224 };
 225
 226 /**
 227  * Prints a confirmation dialog in the style of DOM.confirm().
 228  *
 229  * @method show_confirm_dialog
 230  * @param {EventFacade} e
 231  * @param {Object} args
 232  * @param {String} args.message The question to ask the user
 233  * @param {Function} [args.callback] A callback to apply on confirmation.
 234  * @param {Object} [args.scope] The scope to use when calling the callback.
 235  * @param {Object} [args.callbackargs] Any arguments to pass to the callback.
 236  * @param {String} [args.cancellabel] The label to use on the cancel button.
 237  * @param {String} [args.continuelabel] The label to use on the continue button.
 238  */
 239 M.util.show_confirm_dialog = function(e, args) {
 240     var target = e.target;
 241     if (e.preventDefault) {
 242         e.preventDefault();
 243     }
 244
 245     YUI().use('moodle-core-notification-confirm', function(Y) {
 246         var confirmationDialogue = new M.core.confirm({
 247             width: '300px',
 248             center: true,
 249             modal: true,
 250             visible: false,
 251             draggable: false,
 252             title: M.util.get_string('confirmation', 'admin'),
 253             noLabel: M.util.get_string('cancel', 'moodle'),
 254             question: args.message
 255         });
 256
 257         // The dialogue was submitted with a positive value indication.
 258         confirmationDialogue.on('complete-yes', function(e) {
 259             // Handle any callbacks.
 260             if (args.callback) {
 261                 if (!Y.Lang.isFunction(args.callback)) {
 262                     Y.log('Callbacks to show_confirm_dialog must now be functions. Please update your code to pass in a function instead.',
 263                             'warn', 'M.util.show_confirm_dialog');
 264                     return;
 265                 }
 266
 267                 var scope = e.target;
 268                 if (Y.Lang.isObject(args.scope)) {
 269                     scope = args.scope;
 270                 }
 271
 272                 var callbackargs = args.callbackargs || [];
 273                 args.callback.apply(scope, callbackargs);
 274                 return;
 275             }
 276
 277             var targetancestor = null,
 278                 targetform = null;
 279
 280             if (target.test('a')) {
 281                 window.location = target.get('href');
 282
 283             } else if ((targetancestor = target.ancestor('a')) !== null) {
 284                 window.location = targetancestor.get('href');
 285
 286             } else if (target.test('input') || target.test('button')) {
 287                 targetform = target.ancestor('form', true);
 288                 if (!targetform) {
 289                     return;
 290                 }
 291                 if (target.get('name') && target.get('value')) {
 292                     targetform.append('<input type="hidden" name="' + target.get('name') +
 293                                     '" value="' + target.get('value') + '">');
 294                     if (typeof M.core_formchangechecker !== 'undefined') {
 295                         M.core_formchangechecker.set_form_submitted();
 296                     }
 297                 }
 298                 targetform.submit();
 299
 300             } else if (target.test('form')) {
 301                 if (typeof M.core_formchangechecker !== 'undefined') {
 302                     M.core_formchangechecker.set_form_submitted();
 303                 }
 304                 target.submit();
 305
 306             } else {
 307                 Y.log("Element of type " + target.get('tagName') +
 308                         " is not supported by the M.util.show_confirm_dialog function. Use A, INPUT, BUTTON or FORM",
 309                         'warn', 'javascript-static');
 310             }
 311         }, this);
 312
 313         if (args.cancellabel) {
 314             confirmationDialogue.set('noLabel', args.cancellabel);
 315         }
 316
 317         if (args.continuelabel) {
 318             confirmationDialogue.set('yesLabel', args.continuelabel);
 319         }
 320
 321         confirmationDialogue.render()
 322                 .show();
 323     });
 324 };
 325
 326 /** Useful for full embedding of various stuff */
 327 M.util.init_maximised_embed = function(Y, id) {
 328     var obj = Y.one('#'+id);
 329     if (!obj) {
 330         return;
 331     }
 332
 333     var get_htmlelement_size = function(el, prop) {
 334         if (Y.Lang.isString(el)) {
 335             el = Y.one('#' + el);
 336         }
 337         // Ensure element exists.
 338         if (el) {
 339             var val = el.getStyle(prop);
 340             if (val == 'auto') {
 341                 val = el.getComputedStyle(prop);
 342             }
 343             val = parseInt(val);
 344             if (isNaN(val)) {
 345                 return 0;
 346             }
 347             return val;
 348         } else {
 349             return 0;
 350         }
 351     };
 352
 353     var resize_object = function() {
 354         obj.setStyle('display', 'none');
 355         var newwidth = get_htmlelement_size('maincontent', 'width') - 35;
 356
 357         if (newwidth > 500) {
 358             obj.setStyle('width', newwidth  + 'px');
 359         } else {
 360             obj.setStyle('width', '500px');
 361         }
 362
 363         var headerheight = get_htmlelement_size('page-header', 'height');
 364         var footerheight = get_htmlelement_size('page-footer', 'height');
 365         var newheight = parseInt(Y.one('body').get('docHeight')) - footerheight - headerheight - 100;
 366         if (newheight < 400) {
 367             newheight = 400;
 368         }
 369         obj.setStyle('height', newheight+'px');
 370         obj.setStyle('display', '');
 371     };
 372
 373     resize_object();
 374     // fix layout if window resized too
 375     Y.use('event-resize', function (Y) {
 376         Y.on("windowresize", function() {
 377             resize_object();
 378         });
 379     });
 380 };
 381
 382 /**
 383  * Breaks out all links to the top frame - used in frametop page layout.
 384  */
 385 M.util.init_frametop = function(Y) {
 386     Y.all('a').each(function(node) {
 387         node.set('target', '_top');
 388     });
 389     Y.all('form').each(function(node) {
 390         node.set('target', '_top');
 391     });
 392 };
 393
 394 /**
 395  * @deprecated since Moodle 3.3
 396  */
 397 M.util.init_toggle_class_on_click = function(Y, id, cssselector, toggleclassname, togglecssselector) {
 398     throw new Error('M.util.init_toggle_class_on_click can not be used any more. Please use jQuery instead.');
 399 };
 400
 401 /**
 402  * Initialises a colour picker
 403  *
 404  * Designed to be used with admin_setting_configcolourpicker although could be used
 405  * anywhere, just give a text input an id and insert a div with the class admin_colourpicker
 406  * above or below the input (must have the same parent) and then call this with the
 407  * id.
 408  *
 409  * This code was mostly taken from my [Sam Hemelryk] css theme tool available in
 410  * contrib/blocks. For better docs refer to that.
 411  *
 412  * @param {YUI} Y
 413  * @param {int} id
 414  * @param {object} previewconf
 415  */
 416 M.util.init_colour_picker = function(Y, id, previewconf) {
 417     /**
 418      * We need node and event-mouseenter
 419      */
 420     Y.use('node', 'event-mouseenter', function(){
 421         /**
 422          * The colour picker object
 423          */
 424         var colourpicker = {
 425             box : null,
 426             input : null,
 427             image : null,
 428             preview : null,
 429             current : null,
 430             eventClick : null,
 431             eventMouseEnter : null,
 432             eventMouseLeave : null,
 433             eventMouseMove : null,
 434             width : 300,
 435             height :  100,
 436             factor : 5,
 437             /**
 438              * Initalises the colour picker by putting everything together and wiring the events
 439              */
 440             init : function() {
 441                 this.input = Y.one('#'+id);
 442                 this.box = this.input.ancestor().one('.admin_colourpicker');
 443                 this.image = Y.Node.create('<img alt="" class="colourdialogue" />');
 444                 this.image.setAttribute('src', M.util.image_url('i/colourpicker', 'moodle'));
 445                 this.preview = Y.Node.create('<div class="previewcolour"></div>');
 446                 this.preview.setStyle('width', this.height/2).setStyle('height', this.height/2).setStyle('backgroundColor', this.input.get('value'));
 447                 this.current = Y.Node.create('<div class="currentcolour"></div>');
 448                 this.current.setStyle('width', this.height/2).setStyle('height', this.height/2 -1).setStyle('backgroundColor', this.input.get('value'));
 449                 this.box.setContent('').append(this.image).append(this.preview).append(this.current);
 450
 451                 if (typeof(previewconf) === 'object' && previewconf !== null) {
 452                     Y.one('#'+id+'_preview').on('click', function(e){
 453                         if (Y.Lang.isString(previewconf.selector)) {
 454                             Y.all(previewconf.selector).setStyle(previewconf.style, this.input.get('value'));
 455                         } else {
 456                             for (var i in previewconf.selector) {
 457                                 Y.all(previewconf.selector[i]).setStyle(previewconf.style, this.input.get('value'));
 458                             }
 459                         }
 460                     }, this);
 461                 }
 462
 463                 this.eventClick = this.image.on('click', this.pickColour, this);
 464                 this.eventMouseEnter = Y.on('mouseenter', this.startFollow, this.image, this);
 465             },
 466             /**
 467              * Starts to follow the mouse once it enter the image
 468              */
 469             startFollow : function(e) {
 470                 this.eventMouseEnter.detach();
 471                 this.eventMouseLeave = Y.on('mouseleave', this.endFollow, this.image, this);
 472                 this.eventMouseMove = this.image.on('mousemove', function(e){
 473                     this.preview.setStyle('backgroundColor', this.determineColour(e));
 474                 }, this);
 475             },
 476             /**
 477              * Stops following the mouse
 478              */
 479             endFollow : function(e) {
 480                 this.eventMouseMove.detach();
 481                 this.eventMouseLeave.detach();
 482                 this.eventMouseEnter = Y.on('mouseenter', this.startFollow, this.image, this);
 483             },
 484             /**
 485              * Picks the colour the was clicked on
 486              */
 487             pickColour : function(e) {
 488                 var colour = this.determineColour(e);
 489                 this.input.set('value', colour);
 490                 this.current.setStyle('backgroundColor', colour);
 491             },
 492             /**
 493              * Calculates the colour fromthe given co-ordinates
 494              */
 495             determineColour : function(e) {
 496                 var eventx = Math.floor(e.pageX-e.target.getX());
 497                 var eventy = Math.floor(e.pageY-e.target.getY());
 498
 499                 var imagewidth = this.width;
 500                 var imageheight = this.height;
 501                 var factor = this.factor;
 502                 var colour = [255,0,0];
 503
 504                 var matrices = [
 505                     [  0,  1,  0],
 506                     [ -1,  0,  0],
 507                     [  0,  0,  1],
 508                     [  0, -1,  0],
 509                     [  1,  0,  0],
 510                     [  0,  0, -1]
 511                 ];
 512
 513                 var matrixcount = matrices.length;
 514                 var limit = Math.round(imagewidth/matrixcount);
 515                 var heightbreak = Math.round(imageheight/2);
 516
 517                 for (var x = 0; x < imagewidth; x++) {
 518                     var divisor = Math.floor(x / limit);
 519                     var matrix = matrices[divisor];
 520
 521                     colour[0] += matrix[0]*factor;
 522                     colour[1] += matrix[1]*factor;
 523                     colour[2] += matrix[2]*factor;
 524
 525                     if (eventx==x) {
 526                         break;
 527                     }
 528                 }
 529
 530                 var pixel = [colour[0], colour[1], colour[2]];
 531                 if (eventy < heightbreak) {
 532                     pixel[0] += Math.floor(((255-pixel[0])/heightbreak) * (heightbreak - eventy));
 533                     pixel[1] += Math.floor(((255-pixel[1])/heightbreak) * (heightbreak - eventy));
 534                     pixel[2] += Math.floor(((255-pixel[2])/heightbreak) * (heightbreak - eventy));
 535                 } else if (eventy > heightbreak) {
 536                     pixel[0] = Math.floor((imageheight-eventy)*(pixel[0]/heightbreak));
 537                     pixel[1] = Math.floor((imageheight-eventy)*(pixel[1]/heightbreak));
 538                     pixel[2] = Math.floor((imageheight-eventy)*(pixel[2]/heightbreak));
 539                 }
 540
 541                 return this.convert_rgb_to_hex(pixel);
 542             },
 543             /**
 544              * Converts an RGB value to Hex
 545              */
 546             convert_rgb_to_hex : function(rgb) {
 547                 var hex = '#';
 548                 var hexchars = "0123456789ABCDEF";
 549                 for (var i=0; i<3; i++) {
 550                     var number = Math.abs(rgb[i]);
 551                     if (number == 0 || isNaN(number)) {
 552                         hex += '00';
 553                     } else {
 554                         hex += hexchars.charAt((number-number%16)/16)+hexchars.charAt(number%16);
 555                     }
 556                 }
 557                 return hex;
 558             }
 559         };
 560         /**
 561          * Initialise the colour picker :) Hoorah
 562          */
 563         colourpicker.init();
 564     });
 565 };
 566
 567 M.util.init_block_hider = function(Y, config) {
 568     Y.use('base', 'node', function(Y) {
 569         M.util.block_hider = M.util.block_hider || (function(){
 570             var blockhider = function() {
 571                 blockhider.superclass.constructor.apply(this, arguments);
 572             };
 573             blockhider.prototype = {
 574                 initializer : function(config) {
 575                     this.set('block', '#'+this.get('id'));
 576                     var b = this.get('block'),
 577                         t = b.one('.title'),
 578                         a = null,
 579                         hide,
 580                         show;
 581                     if (t && (a = t.one('.block_action'))) {
 582                         hide = Y.Node.create('<img />')
 583                             .addClass('block-hider-hide')
 584                             .setAttrs({
 585                                 alt:        config.tooltipVisible,
 586                                 src:        this.get('iconVisible'),
 587                                 tabIndex:   0,
 588                                 'title':    config.tooltipVisible
 589                             });
 590                         hide.on('keypress', this.updateStateKey, this, true);
 591                         hide.on('click', this.updateState, this, true);
 592
 593                         show = Y.Node.create('<img />')
 594                             .addClass('block-hider-show')
 595                             .setAttrs({
 596                                 alt:        config.tooltipHidden,
 597                                 src:        this.get('iconHidden'),
 598                                 tabIndex:   0,
 599                                 'title':    config.tooltipHidden
 600                             });
 601                         show.on('keypress', this.updateStateKey, this, false);
 602                         show.on('click', this.updateState, this, false);
 603
 604                         a.insert(show, 0).insert(hide, 0);
 605                     }
 606                 },
 607                 updateState : function(e, hide) {
 608                     M.util.set_user_preference(this.get('preference'), hide);
 609                     if (hide) {
 610                         this.get('block').addClass('hidden');
 611                         this.get('block').one('.block-hider-show').focus();
 612                     } else {
 613                         this.get('block').removeClass('hidden');
 614                         this.get('block').one('.block-hider-hide').focus();
 615                     }
 616                 },
 617                 updateStateKey : function(e, hide) {
 618                     if (e.keyCode == 13) { //allow hide/show via enter key
 619                         this.updateState(this, hide);
 620                     }
 621                 }
 622             };
 623             Y.extend(blockhider, Y.Base, blockhider.prototype, {
 624                 NAME : 'blockhider',
 625                 ATTRS : {
 626                     id : {},
 627                     preference : {},
 628                     iconVisible : {
 629                         value : M.util.image_url('t/switch_minus', 'moodle')
 630                     },
 631                     iconHidden : {
 632                         value : M.util.image_url('t/switch_plus', 'moodle')
 633                     },
 634                     block : {
 635                         setter : function(node) {
 636                             return Y.one(node);
 637                         }
 638                     }
 639                 }
 640             });
 641             return blockhider;
 642         })();
 643         new M.util.block_hider(config);
 644     });
 645 };
 646
 647 /**
 648  * @var pending_js - The keys are the list of all pending js actions.
 649  * @type Object
 650  */
 651 M.util.pending_js = [];
 652 M.util.complete_js = [];
 653
 654 /**
 655  * Register any long running javascript code with a unique identifier.
 656  * Should be followed with a call to js_complete with a matching
 657  * idenfitier when the code is complete. May also be called with no arguments
 658  * to test if there is any js calls pending. This is relied on by behat so that
 659  * it can wait for all pending updates before interacting with a page.
 660  * @param String uniqid - optional, if provided,
 661  *                        registers this identifier until js_complete is called.
 662  * @return boolean - True if there is any pending js.
 663  */
 664 M.util.js_pending = function(uniqid) {
 665     if (uniqid !== false) {
 666         M.util.pending_js.push(uniqid);
 667     }
 668
 669     return M.util.pending_js.length;
 670 };
 671
 672 // Start this asap.
 673 M.util.js_pending('init');
 674
 675 /**
 676  * Register listeners for Y.io start/end so we can wait for them in behat.
 677  */
 678 YUI.add('moodle-core-io', function(Y) {
 679     Y.on('io:start', function(id) {
 680         M.util.js_pending('io:' + id);
 681     });
 682     Y.on('io:end', function(id) {
 683         M.util.js_complete('io:' + id);
 684     });
 685 }, '@VERSION@', {
 686     condition: {
 687         trigger: 'io-base',
 688         when: 'after'
 689     }
 690 });
 691
 692 /**
 693  * Unregister any long running javascript code by unique identifier.
 694  * This function should form a matching pair with js_pending
 695  *
 696  * @param String uniqid - required, unregisters this identifier
 697  * @return boolean - True if there is any pending js.
 698  */
 699 M.util.js_complete = function(uniqid) {
 700     // Use the Y.Array.indexOf instead of the native because some older browsers do not support
 701     // the native function. Y.Array polyfills the native function if it does not exist.
 702     var index = Y.Array.indexOf(M.util.pending_js, uniqid);
 703     if (index >= 0) {
 704         M.util.complete_js.push(M.util.pending_js.splice(index, 1));
 705     }
 706
 707     return M.util.pending_js.length;
 708 };
 709
 710 /**
 711  * Returns a string registered in advance for usage in JavaScript
 712  *
 713  * If you do not pass the third parameter, the function will just return
 714  * the corresponding value from the M.str object. If the third parameter is
 715  * provided, the function performs {$a} placeholder substitution in the
 716  * same way as PHP get_string() in Moodle does.
 717  *
 718  * @param {String} identifier string identifier
 719  * @param {String} component the component providing the string
 720  * @param {Object|String} a optional variable to populate placeholder with
 721  */
 722 M.util.get_string = function(identifier, component, a) {
 723     var stringvalue;
 724
 725     if (M.cfg.developerdebug) {
 726         // creating new instance if YUI is not optimal but it seems to be better way then
 727         // require the instance via the function API - note that it is used in rare cases
 728         // for debugging only anyway
 729         // To ensure we don't kill browser performance if hundreds of get_string requests
 730         // are made we cache the instance we generate within the M.util namespace.
 731         // We don't publicly define the variable so that it doesn't get abused.
 732         if (typeof M.util.get_string_yui_instance === 'undefined') {
 733             M.util.get_string_yui_instance = new YUI({ debug : true });
 734         }
 735         var Y = M.util.get_string_yui_instance;
 736     }
 737
 738     if (!M.str.hasOwnProperty(component) || !M.str[component].hasOwnProperty(identifier)) {
 739         stringvalue = '[[' + identifier + ',' + component + ']]';
 740         if (M.cfg.developerdebug) {
 741             Y.log('undefined string ' + stringvalue, 'warn', 'M.util.get_string');
 742         }
 743         return stringvalue;
 744     }
 745
 746     stringvalue = M.str[component][identifier];
 747
 748     if (typeof a == 'undefined') {
 749         // no placeholder substitution requested
 750         return stringvalue;
 751     }
 752
 753     if (typeof a == 'number' || typeof a == 'string') {
 754         // replace all occurrences of {$a} with the placeholder value
 755         stringvalue = stringvalue.replace(/\{\$a\}/g, a);
 756         return stringvalue;
 757     }
 758
 759     if (typeof a == 'object') {
 760         // replace {$a->key} placeholders
 761         for (var key in a) {
 762             if (typeof a[key] != 'number' && typeof a[key] != 'string') {
 763                 if (M.cfg.developerdebug) {
 764                     Y.log('invalid value type for $a->' + key, 'warn', 'M.util.get_string');
 765                 }
 766                 continue;
 767             }
 768             var search = '{$a->' + key + '}';
 769             search = search.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, '\\$&');
 770             search = new RegExp(search, 'g');
 771             stringvalue = stringvalue.replace(search, a[key]);
 772         }
 773         return stringvalue;
 774     }
 775
 776     if (M.cfg.developerdebug) {
 777         Y.log('incorrect placeholder type', 'warn', 'M.util.get_string');
 778     }
 779     return stringvalue;
 780 };
 781
 782 /**
 783  * Set focus on username or password field of the login form.
 784  * @deprecated since Moodle 3.3.
 785  */
 786 M.util.focus_login_form = function(Y) {
 787     Y.log('M.util.focus_login_form no longer does anything. Please use jquery instead.', 'warn', 'javascript-static.js');
 788 };
 789
 790 /**
 791  * Set focus on login error message.
 792  * @deprecated since Moodle 3.3.
 793  */
 794 M.util.focus_login_error = function(Y) {
 795     Y.log('M.util.focus_login_error no longer does anything. Please use jquery instead.', 'warn', 'javascript-static.js');
 796 };
 797
 798 /**
 799  * Adds lightbox hidden element that covers the whole node.
 800  *
 801  * @param {YUI} Y
 802  * @param {Node} the node lightbox should be added to
 803  * @retun {Node} created lightbox node
 804  */
 805 M.util.add_lightbox = function(Y, node) {
 806     var WAITICON = {'pix':"i/loading_small",'component':'moodle'};
 807
 808     // Check if lightbox is already there
 809     if (node.one('.lightbox')) {
 810         return node.one('.lightbox');
 811     }
 812
 813     node.setStyle('position', 'relative');
 814     var waiticon = Y.Node.create('<img />')
 815     .setAttrs({
 816         'src' : M.util.image_url(WAITICON.pix, WAITICON.component)
 817     })
 818     .setStyles({
 819         'position' : 'relative',
 820         'top' : '50%'
 821     });
 822
 823     var lightbox = Y.Node.create('<div></div>')
 824     .setStyles({
 825         'opacity' : '.75',
 826         'position' : 'absolute',
 827         'width' : '100%',
 828         'height' : '100%',
 829         'top' : 0,
 830         'left' : 0,
 831         'backgroundColor' : 'white',
 832         'textAlign' : 'center'
 833     })
 834     .setAttribute('class', 'lightbox')
 835     .hide();
 836
 837     lightbox.appendChild(waiticon);
 838     node.append(lightbox);
 839     return lightbox;
 840 }
 841
 842 /**
 843  * Appends a hidden spinner element to the specified node.
 844  *
 845  * @param {YUI} Y
 846  * @param {Node} the node the spinner should be added to
 847  * @return {Node} created spinner node
 848  */
 849 M.util.add_spinner = function(Y, node) {
 850     var WAITICON = {'pix':"i/loading_small",'component':'moodle'};
 851
 852     // Check if spinner is already there
 853     if (node.one('.spinner')) {
 854         return node.one('.spinner');
 855     }
 856
 857     var spinner = Y.Node.create('<img />')
 858         .setAttribute('src', M.util.image_url(WAITICON.pix, WAITICON.component))
 859         .addClass('spinner')
 860         .addClass('iconsmall')
 861         .hide();
 862
 863     node.append(spinner);
 864     return spinner;
 865 }
 866
 867 /**
 868  * @deprecated since Moodle 3.3.
 869  */
 870 function checkall() {
 871     throw new Error('checkall can not be used any more. Please use jQuery instead.');
 872 }
 873
 874 /**
 875  * @deprecated since Moodle 3.3.
 876  */
 877 function checknone() {
 878     throw new Error('checknone can not be used any more. Please use jQuery instead.');
 879 }
 880
 881 /**
 882  * @deprecated since Moodle 3.3.
 883  */
 884 function select_all_in_element_with_id(id, checked) {
 885     throw new Error('select_all_in_element_with_id can not be used any more. Please use jQuery instead.');
 886 }
 887
 888 /**
 889  * @deprecated since Moodle 3.3.
 890  */
 891 function select_all_in(elTagName, elClass, elId) {
 892     throw new Error('select_all_in can not be used any more. Please use jQuery instead.');
 893 }
 894
 895 /**
 896  * @deprecated since Moodle 3.3.
 897  */
 898 function deselect_all_in(elTagName, elClass, elId) {
 899     throw new Error('deselect_all_in can not be used any more. Please use jQuery instead.');
 900 }
 901
 902 /**
 903  * @deprecated since Moodle 3.3.
 904  */
 905 function confirm_if(expr, message) {
 906     throw new Error('confirm_if can not be used any more.');
 907 }
 908
 909 /**
 910  * @deprecated since Moodle 3.3.
 911  */
 912 function findParentNode(el, elName, elClass, elId) {
 913     throw new Error('findParentNode can not be used any more. Please use jQuery instead.');
 914 }
 915
 916 function unmaskPassword(id) {
 917     var pw = document.getElementById(id);
 918     var chb = document.getElementById(id+'unmask');
 919
 920     // MDL-30438 - The capability to changing the value of input type is not supported by IE8 or lower.
 921     // Replacing existing child with a new one, removed all yui properties for the node.  Therefore, this
 922     // functionality won't work in IE8 or lower.
 923     // This is a temporary fixed to allow other browsers to function properly.
 924     if (Y.UA.ie == 0 || Y.UA.ie >= 9) {
 925         if (chb.checked) {
 926             pw.type = "text";
 927         } else {
 928             pw.type = "password";
 929         }
 930     } else {  //IE Browser version 8 or lower
 931         try {
 932             // first try IE way - it can not set name attribute later
 933             if (chb.checked) {
 934               var newpw = document.createElement('<input type="text" autocomplete="off" name="'+pw.name+'">');
 935             } else {
 936               var newpw = document.createElement('<input type="password" autocomplete="off" name="'+pw.name+'">');
 937             }
 938             newpw.attributes['class'].nodeValue = pw.attributes['class'].nodeValue;
 939         } catch (e) {
 940             var newpw = document.createElement('input');
 941             newpw.setAttribute('autocomplete', 'off');
 942             newpw.setAttribute('name', pw.name);
 943             if (chb.checked) {
 944               newpw.setAttribute('type', 'text');
 945             } else {
 946               newpw.setAttribute('type', 'password');
 947             }
 948             newpw.setAttribute('class', pw.getAttribute('class'));
 949         }
 950         newpw.id = pw.id;
 951         newpw.size = pw.size;
 952         newpw.onblur = pw.onblur;
 953         newpw.onchange = pw.onchange;
 954         newpw.value = pw.value;
 955         pw.parentNode.replaceChild(newpw, pw);
 956     }
 957 }
 958
 959 /**
 960  * @deprecated since Moodle 3.3.
 961  */
 962 function filterByParent(elCollection, parentFinder) {
 963     throw new Error('filterByParent can not be used any more. Please use jQuery instead.');
 964 }
 965
 966 /**
 967  * @deprecated since Moodle 3.3, but shouldn't be used in earlier versions either.
 968  */
 969 function fix_column_widths() {
 970     Y.log('fix_column_widths() no longer does anything. Please remove it from your code.', 'warn', 'javascript-static.js');
 971 }
 972
 973 /**
 974  * @deprecated since Moodle 3.3, but shouldn't be used in earlier versions either.
 975  */
 976 function fix_column_width(colName) {
 977     Y.log('fix_column_width() no longer does anything. Please remove it from your code.', 'warn', 'javascript-static.js');
 978 }
 979
 980
 981 /*
 982    Insert myValue at current cursor position
 983  */
 984 function insertAtCursor(myField, myValue) {
 985     // IE support
 986     if (document.selection) {
 987         myField.focus();
 988         sel = document.selection.createRange();
 989         sel.text = myValue;
 990     }
 991     // Mozilla/Netscape support
 992     else if (myField.selectionStart || myField.selectionStart == '0') {
 993         var startPos = myField.selectionStart;
 994         var endPos = myField.selectionEnd;
 995         myField.value = myField.value.substring(0, startPos)
 996             + myValue + myField.value.substring(endPos, myField.value.length);
 997     } else {
 998         myField.value += myValue;
 999     }
1000 }
1001
1002 /**
1003  * Increment a file name.
1004  *
1005  * @param string file name.
1006  * @param boolean ignoreextension do not extract the extension prior to appending the
1007  *                                suffix. Useful when incrementing folder names.
1008  * @return string the incremented file name.
1009  */
1010 function increment_filename(filename, ignoreextension) {
1011     var extension = '';
1012     var basename = filename;
1013
1014     // Split the file name into the basename + extension.
1015     if (!ignoreextension) {
1016         var dotpos = filename.lastIndexOf('.');
1017         if (dotpos !== -1) {
1018             basename = filename.substr(0, dotpos);
1019             extension = filename.substr(dotpos, filename.length);
1020         }
1021     }
1022
1023     // Look to see if the name already has (NN) at the end of it.
1024     var number = 0;
1025     var hasnumber = basename.match(/^(.*) \((\d+)\)$/);
1026     if (hasnumber !== null) {
1027         // Note the current number & remove it from the basename.
1028         number = parseInt(hasnumber[2], 10);
1029         basename = hasnumber[1];
1030     }
1031
1032     number++;
1033     var newname = basename + ' (' + number + ')' + extension;
1034     return newname;
1035 }
1036
1037 /**
1038  * Return whether we are in right to left mode or not.
1039  *
1040  * @return boolean
1041  */
1042 function right_to_left() {
1043     var body = Y.one('body');
1044     var rtl = false;
1045     if (body && body.hasClass('dir-rtl')) {
1046         rtl = true;
1047     }
1048     return rtl;
1049 }
1050
1051 function openpopup(event, args) {
1052
1053     if (event) {
1054         if (event.preventDefault) {
1055             event.preventDefault();
1056         } else {
1057             event.returnValue = false;
1058         }
1059     }
1060
1061     // Make sure the name argument is set and valid.
1062     var nameregex = /[^a-z0-9_]/i;
1063     if (typeof args.name !== 'string') {
1064         args.name = '_blank';
1065     } else if (args.name.match(nameregex)) {
1066         // Cleans window name because IE does not support funky ones.
1067         if (M.cfg.developerdebug) {
1068             alert('DEVELOPER NOTICE: Invalid \'name\' passed to openpopup(): ' + args.name);
1069         }
1070         args.name = args.name.replace(nameregex, '_');
1071     }
1072
1073     var fullurl = args.url;
1074     if (!args.url.match(/https?:\/\//)) {
1075         fullurl = M.cfg.wwwroot + args.url;
1076     }
1077     if (args.fullscreen) {
1078         args.options = args.options.
1079                 replace(/top=\d+/, 'top=0').
1080                 replace(/left=\d+/, 'left=0').
1081                 replace(/width=\d+/, 'width=' + screen.availWidth).
1082                 replace(/height=\d+/, 'height=' + screen.availHeight);
1083     }
1084     var windowobj = window.open(fullurl,args.name,args.options);
1085     if (!windowobj) {
1086         return true;
1087     }
1088
1089     if (args.fullscreen) {
1090         // In some browser / OS combinations (E.g. Chrome on Windows), the
1091         // window initially opens slighly too big. The width and heigh options
1092         // seem to control the area inside the browser window, so what with
1093         // scroll-bars, etc. the actual window is bigger than the screen.
1094         // Therefore, we need to fix things up after the window is open.
1095         var hackcount = 100;
1096         var get_size_exactly_right = function() {
1097             windowobj.moveTo(0, 0);
1098             windowobj.resizeTo(screen.availWidth, screen.availHeight);
1099
1100             // Unfortunately, it seems that in Chrome on Ubuntu, if you call
1101             // something like windowobj.resizeTo(1280, 1024) too soon (up to
1102             // about 50ms) after the window is open, then it actually behaves
1103             // as if you called windowobj.resizeTo(0, 0). Therefore, we need to
1104             // check that the resize actually worked, and if not, repeatedly try
1105             // again after a short delay until it works (but with a limit of
1106             // hackcount repeats.
1107             if (hackcount > 0 && (windowobj.innerHeight < 10 || windowobj.innerWidth < 10)) {
1108                 hackcount -= 1;
1109                 setTimeout(get_size_exactly_right, 10);
1110             }
1111         }
1112         setTimeout(get_size_exactly_right, 0);
1113     }
1114     windowobj.focus();
1115
1116     return false;
1117 }
1118
1119 /** Close the current browser window. */
1120 function close_window(e) {
1121     if (e.preventDefault) {
1122         e.preventDefault();
1123     } else {
1124         e.returnValue = false;
1125     }
1126     window.close();
1127 }
1128
1129 /**
1130  * Tranfer keyboard focus to the HTML element with the given id, if it exists.
1131  * @param controlid the control id.
1132  */
1133 function focuscontrol(controlid) {
1134     var control = document.getElementById(controlid);
1135     if (control) {
1136         control.focus();
1137     }
1138 }
1139
1140 /**
1141  * Transfers keyboard focus to an HTML element based on the old style style of focus
1142  * This function should be removed as soon as it is no longer used
1143  */
1144 function old_onload_focus(formid, controlname) {
1145     if (document.forms[formid] && document.forms[formid].elements && document.forms[formid].elements[controlname]) {
1146         document.forms[formid].elements[controlname].focus();
1147     }
1148 }
1149
1150 function build_querystring(obj) {
1151     return convert_object_to_string(obj, '&');
1152 }
1153
1154 function build_windowoptionsstring(obj) {
1155     return convert_object_to_string(obj, ',');
1156 }
1157
1158 function convert_object_to_string(obj, separator) {
1159     if (typeof obj !== 'object') {
1160         return null;
1161     }
1162     var list = [];
1163     for(var k in obj) {
1164         k = encodeURIComponent(k);
1165         var value = obj[k];
1166         if(obj[k] instanceof Array) {
1167             for(var i in value) {
1168                 list.push(k+'[]='+encodeURIComponent(value[i]));
1169             }
1170         } else {
1171             list.push(k+'='+encodeURIComponent(value));
1172         }
1173     }
1174     return list.join(separator);
1175 }
1176
1177 /**
1178  * @deprecated since Moodle 3.3.
1179  */
1180 function stripHTML(str) {
1181     throw new Error('stripHTML can not be used any more. Please use jQuery instead.');
1182 }
1183
1184 function updateProgressBar(id, percent, msg, estimate) {
1185     var event,
1186         el = document.getElementById(id),
1187         eventData = {};
1188
1189     if (!el) {
1190         return;
1191     }
1192
1193     eventData.message = msg;
1194     eventData.percent = percent;
1195     eventData.estimate = estimate;
1196
1197     try {
1198         event = new CustomEvent('update', {
1199             bubbles: false,
1200             cancelable: true,
1201             detail: eventData
1202         });
1203     } catch (exception) {
1204         if (!(exception instanceof TypeError)) {
1205             throw exception;
1206         }
1207         event = document.createEvent('CustomEvent');
1208         event.initCustomEvent('update', false, true, eventData);
1209         event.prototype = window.Event.prototype;
1210     }
1211
1212     el.dispatchEvent(event);
1213 }
1214
1215 M.util.help_popups = {
1216     setup : function(Y) {
1217         Y.one('body').delegate('click', this.open_popup, 'a.helplinkpopup', this);
1218     },
1219     open_popup : function(e) {
1220         // Prevent the default page action
1221         e.preventDefault();
1222
1223         // Grab the anchor that was clicked
1224         var anchor = e.target.ancestor('a', true);
1225         var args = {
1226             'name'          : 'popup',
1227             'url'           : anchor.getAttribute('href'),
1228             'options'       : ''
1229         };
1230         var options = [
1231             'height=600',
1232             'width=800',
1233             'top=0',
1234             'left=0',
1235             'menubar=0',
1236             'location=0',
1237             'scrollbars',
1238             'resizable',
1239             'toolbar',
1240             'status',
1241             'directories=0',
1242             'fullscreen=0',
1243             'dependent'
1244         ]
1245         args.options = options.join(',');
1246
1247         openpopup(e, args);
1248     }
1249 }
1250
1251 /**
1252  * Custom menu namespace
1253  */
1254 M.core_custom_menu = {
1255     /**
1256      * This method is used to initialise a custom menu given the id that belongs
1257      * to the custom menu's root node.
1258      *
1259      * @param {YUI} Y
1260      * @param {string} nodeid
1261      */
1262     init : function(Y, nodeid) {
1263         var node = Y.one('#'+nodeid);
1264         if (node) {
1265             Y.use('node-menunav', function(Y) {
1266                 // Get the node
1267                 // Remove the javascript-disabled class.... obviously javascript is enabled.
1268                 node.removeClass('javascript-disabled');
1269                 // Initialise the menunav plugin
1270                 node.plug(Y.Plugin.NodeMenuNav);
1271             });
1272         }
1273     }
1274 };
1275
1276 /**
1277  * Used to store form manipulation methods and enhancments
1278  */
1279 M.form = M.form || {};
1280
1281 /**
1282  * Converts a nbsp indented select box into a multi drop down custom control much
1283  * like the custom menu. Can no longer be used.
1284  * @deprecated since Moodle 3.3
1285  */
1286 M.form.init_smartselect = function() {
1287     throw new Error('M.form.init_smartselect can not be used any more.');
1288 };
1289
1290 /**
1291  * Initiates the listeners for skiplink interaction
1292  *
1293  * @param {YUI} Y
1294  */
1295 M.util.init_skiplink = function(Y) {
1296     Y.one(Y.config.doc.body).delegate('click', function(e) {
1297         e.preventDefault();
1298         e.stopPropagation();
1299         var node = Y.one(this.getAttribute('href'));
1300         node.setAttribute('tabindex', '-1');
1301         node.focus();
1302         return true;
1303     }, 'a.skip');
1304 };