13 * (don't call before document ready)
16 var profile, $tocTitle, $tocToggleLink, hideTocCookie;
18 /* Set tooltipAccessKeyPrefix */
19 profile = $.client.profile();
21 // Opera on any platform
22 if ( profile.name === 'opera' ) {
23 util.tooltipAccessKeyPrefix = 'shift-esc-';
25 // Chrome on any platform
26 } else if ( profile.name === 'chrome' ) {
28 util.tooltipAccessKeyPrefix = (
29 profile.platform === 'mac'
32 // Chrome on Windows or Linux
33 // (both alt- and alt-shift work, but alt with E, D, F etc does not
34 // work since they are browser shortcuts)
38 // Non-Windows Safari with webkit_version > 526
39 } else if ( profile.platform !== 'win'
40 && profile.name === 'safari'
41 && profile.layoutVersion > 526 ) {
42 util.tooltipAccessKeyPrefix = 'ctrl-alt-';
44 } else if ( profile.platform === 'mac'
45 && profile.name === 'firefox'
46 && profile.versionNumber >= 14 ) {
47 util.tooltipAccessKeyPrefix = 'ctrl-option-';
48 // Safari/Konqueror on any platform, or any browser on Mac
49 // (but not Safari on Windows)
50 } else if ( !( profile.platform === 'win' && profile.name === 'safari' )
51 && ( profile.name === 'safari'
52 || profile.platform === 'mac'
53 || profile.name === 'konqueror' ) ) {
54 util.tooltipAccessKeyPrefix = 'ctrl-';
56 // Firefox 2.x and later
57 } else if ( profile.name === 'firefox' && profile.versionBase > '1' ) {
58 util.tooltipAccessKeyPrefix = 'alt-shift-';
61 /* Fill $content var */
62 util.$content = ( function () {
63 var i, l, $content, selectors;
65 // The preferred standard for setting $content (class="mw-body")
66 // You may also use (class="mw-body mw-body-primary") if you use
67 // mw-body in multiple locations.
68 // Or class="mw-body-primary" if you want $content to be deeper
69 // in the dom than mw-body
73 /* Legacy fallbacks for setting the content */
74 // Vector, Monobook, Chick, etc... based skins
80 // Standard, CologneBlue
83 // #content is present on almost all if not all skins. Most skins (the above cases)
84 // have #content too, but as an outer wrapper instead of the article text container.
85 // The skins that don't have an outer wrapper do have #content for everything
86 // so it's a good fallback
89 // If nothing better is found fall back to our bodytext div that is guaranteed to be here
92 // Should never happen... well, it could if someone is not finished writing a skin and has
93 // not inserted bodytext yet. But in any case <body> should always exist
96 for ( i = 0, l = selectors.length; i < l; i++ ) {
97 $content = $( selectors[i] ).first();
98 if ( $content.length ) {
103 // Make sure we don't unset util.$content if it was preset and we don't find anything
104 return util.$content;
107 // Table of contents toggle
108 $tocTitle = $( '#toctitle' );
109 $tocToggleLink = $( '#togglelink' );
110 // Only add it if there is a TOC and there is no toggle added already
111 if ( $( '#toc' ).length && $tocTitle.length && !$tocToggleLink.length ) {
112 hideTocCookie = $.cookie( 'mw_hidetoc' );
113 $tocToggleLink = $( '<a href="#" class="internal" id="togglelink"></a>' )
114 .text( mw.msg( 'hidetoc' ) )
115 .click( function ( e ) {
117 util.toggleToc( $(this) );
121 .wrap( '<span class="toctoggle"></span>' )
123 .prepend( ' [' )
127 if ( hideTocCookie === '1' ) {
128 util.toggleToc( $tocToggleLink );
136 * Encode the string like PHP's rawurlencode
138 * @param {string} str String to be encoded.
140 rawurlencode: function ( str ) {
142 return encodeURIComponent( str )
143 .replace( /!/g, '%21' ).replace( /'/g, '%27' ).replace( /\(/g, '%28' )
144 .replace( /\)/g, '%29' ).replace( /\*/g, '%2A' ).replace( /~/g, '%7E' );
148 * Encode page titles for use in a URL
149 * We want / and : to be included as literal characters in our title URLs
150 * as they otherwise fatally break the title
152 * @param {string} str String to be encoded.
154 wikiUrlencode: function ( str ) {
155 return util.rawurlencode( str )
156 .replace( /%20/g, '_' ).replace( /%3A/g, ':' ).replace( /%2F/g, '/' );
160 * Get the link to a page name (relative to `wgServer`),
162 * @param {string} str Page name to get the link for.
163 * @return {string} Location for a page with name of `str` or boolean false on error.
165 wikiGetlink: function ( str ) {
166 return mw.config.get( 'wgArticlePath' ).replace( '$1',
167 util.wikiUrlencode( typeof str === 'string' ? str : mw.config.get( 'wgPageName' ) ) );
171 * Get address to a script in the wiki root.
172 * For index.php use `mw.config.get( 'wgScript' )`.
175 * @param str string Name of script (eg. 'api'), defaults to 'index'
176 * @return string Address to script (eg. '/w/api.php' )
178 wikiScript: function ( str ) {
179 str = str || 'index';
180 if ( str === 'index' ) {
181 return mw.config.get( 'wgScript' );
182 } else if ( str === 'load' ) {
183 return mw.config.get( 'wgLoadScript' );
185 return mw.config.get( 'wgScriptPath' ) + '/' + str +
186 mw.config.get( 'wgScriptExtension' );
191 * Append a new style block to the head and return the CSSStyleSheet object.
192 * Use .ownerNode to access the `<style>` element, or use mw.loader#addStyleTag.
193 * This function returns the styleSheet object for convience (due to cross-browsers
194 * difference as to where it is located).
196 * var sheet = mw.util.addCSS('.foobar { display: none; }');
197 * $(foo).click(function () {
198 * // Toggle the sheet on and off
199 * sheet.disabled = !sheet.disabled;
202 * @param {string} text CSS to be appended
203 * @return {CSSStyleSheet} Use .ownerNode to get to the `<style>` element.
205 addCSS: function ( text ) {
206 var s = mw.loader.addStyleTag( text );
211 * Hide/show the table of contents element
213 * @param {jQuery} $toggleLink A jQuery object of the toggle link.
214 * @param {Function} [callback] Function to be called after the toggle is
215 * completed (including the animation).
216 * @return {Mixed} Boolean visibility of the toc (true if it's visible)
217 * or Null if there was no table of contents.
219 toggleToc: function ( $toggleLink, callback ) {
220 var $tocList = $( '#toc ul:first' );
222 // This function shouldn't be called if there's no TOC,
223 // but just in case...
224 if ( $tocList.length ) {
225 if ( $tocList.is( ':hidden' ) ) {
226 $tocList.slideDown( 'fast', callback );
227 $toggleLink.text( mw.msg( 'hidetoc' ) );
228 $( '#toc' ).removeClass( 'tochidden' );
229 $.cookie( 'mw_hidetoc', null, {
235 $tocList.slideUp( 'fast', callback );
236 $toggleLink.text( mw.msg( 'showtoc' ) );
237 $( '#toc' ).addClass( 'tochidden' );
238 $.cookie( 'mw_hidetoc', '1', {
250 * Grab the URL parameter value for the given parameter.
251 * Returns null if not found.
253 * @param {string} param The parameter name.
254 * @param {string} [url] URL to search through.
255 * @return {Mixed} Parameter value or null.
257 getParamValue: function ( param, url ) {
258 if ( url === undefined ) {
259 url = document.location.href;
261 // Get last match, stop at hash
262 var re = new RegExp( '^[^#]*[&?]' + $.escapeRE( param ) + '=([^&#]*)' ),
265 // Beware that decodeURIComponent is not required to understand '+'
266 // by spec, as encodeURIComponent does not produce it.
267 return decodeURIComponent( m[1].replace( /\+/g, '%20' ) );
274 * Access key prefix. Will be re-defined based on browser/operating system
275 * detection in mw.util#init.
277 tooltipAccessKeyPrefix: 'alt-',
281 * Regex to match accesskey tooltips.
290 * The accesskey is matched in group $6.
292 tooltipAccessKeyRegexp: /\[(ctrl-)?(option-)?(alt-)?(shift-)?(esc-)?(.)\]$/,
295 * Add the appropriate prefix to the accesskey shown in the tooltip.
296 * If the nodeList parameter is given, only those nodes are updated;
297 * otherwise, all the nodes that will probably have accesskeys by
298 * default are updated.
300 * @param {Array|jQuery} [$nodes] A jQuery object, or array of nodes to update.
302 updateTooltipAccessKeys: function ( $nodes ) {
304 // Rather than going into a loop of all anchor tags, limit to few elements that
305 // contain the relevant anchor tags.
306 // Input and label are rare enough that no such optimization is needed
307 $nodes = $( '#column-one a, #mw-head a, #mw-panel a, #p-logo a, input, label' );
308 } else if ( !( $nodes instanceof $ ) ) {
309 $nodes = $( $nodes );
312 $nodes.attr( 'title', function ( i, val ) {
313 if ( val && util.tooltipAccessKeyRegexp.test( val ) ) {
314 return val.replace( util.tooltipAccessKeyRegexp,
315 '[' + util.tooltipAccessKeyPrefix + '$6]' );
323 * A jQuery object that refers to the content area element.
324 * Populated by #init.
329 * Add a link to a portlet menu on the page, such as:
331 * p-cactions (Content actions), p-personal (Personal tools),
332 * p-navigation (Navigation), p-tb (Toolbox)
334 * The first three paramters are required, the others are optional and
335 * may be null. Though providing an id and tooltip is recommended.
337 * By default the new link will be added to the end of the list. To
338 * add the link before a given existing item, pass the DOM node
339 * (e.g. `document.getElementById( 'foobar' )`) or a jQuery-selector
340 * (e.g. `'#foobar'`) for that item.
342 * mw.util.addPortletLink(
343 * 'p-tb', 'http://mediawiki.org/',
344 * 'MediaWiki.org', 't-mworg', 'Go to MediaWiki.org ', 'm', '#t-print'
347 * @param {string} portlet ID of the target portlet ( 'p-cactions' or 'p-personal' etc.)
348 * @param {string} href Link URL
349 * @param {string} text Link text
350 * @param {string} [id] ID of the new item, should be unique and preferably have
351 * the appropriate prefix ( 'ca-', 'pt-', 'n-' or 't-' )
352 * @param {string} [tooltip] Text to show when hovering over the link, without accesskey suffix
353 * @param {string} [accesskey] Access key to activate this link (one character, try
354 * to avoid conflicts. Use `$( '[accesskey=x]' ).get()` in the console to
355 * see if 'x' is already used.
356 * @param {HTMLElement|jQuery|string} [nextnode] Element or jQuery-selector string to the item that
357 * the new item should be added before, should be another item in the same
358 * list, it will be ignored otherwise
360 * @return {HTMLElement|null} The added element (a ListItem or Anchor element,
361 * depending on the skin) or null if no element was added to the document.
363 addPortletLink: function ( portlet, href, text, id, tooltip, accesskey, nextnode ) {
364 var $item, $link, $portlet, $ul;
366 // Check if there's atleast 3 arguments to prevent a TypeError
367 if ( arguments.length < 3 ) {
370 // Setup the anchor tag
371 $link = $( '<a>' ).attr( 'href', href ).text( text );
373 $link.attr( 'title', tooltip );
376 // Select the specified portlet
377 $portlet = $( '#' + portlet );
378 if ( $portlet.length === 0 ) {
381 // Select the first (most likely only) unordered list inside the portlet
382 $ul = $portlet.find( 'ul' ).eq( 0 );
384 // If it didn't have an unordered list yet, create it
385 if ( $ul.length === 0 ) {
389 // If there's no <div> inside, append it to the portlet directly
390 if ( $portlet.find( 'div:first' ).length === 0 ) {
391 $portlet.append( $ul );
393 // otherwise if there's a div (such as div.body or div.pBody)
394 // append the <ul> to last (most likely only) div
395 $portlet.find( 'div' ).eq( -1 ).append( $ul );
399 if ( $ul.length === 0 ) {
403 // Unhide portlet if it was hidden before
404 $portlet.removeClass( 'emptyPortlet' );
406 // Wrap the anchor tag in a list item (and a span if $portlet is a Vector tab)
407 // and back up the selector to the list item
408 if ( $portlet.hasClass( 'vectorTabs' ) ) {
409 $item = $link.wrap( '<li><span></span></li>' ).parent().parent();
411 $item = $link.wrap( '<li></li>' ).parent();
414 // Implement the properties passed to the function
416 $item.attr( 'id', id );
420 // Trim any existing accesskey hint and the trailing space
421 tooltip = $.trim( tooltip.replace( util.tooltipAccessKeyRegexp, '' ) );
423 tooltip += ' [' + accesskey + ']';
425 $link.attr( 'title', tooltip );
427 util.updateTooltipAccessKeys( $link );
432 $link.attr( 'accesskey', accesskey );
435 // Where to put our node ?
436 // - nextnode is a DOM element (was the only option before MW 1.17, in wikibits.js)
437 if ( nextnode && nextnode.parentNode === $ul[0] ) {
438 $( nextnode ).before( $item );
440 // - nextnode is a CSS selector for jQuery
441 } else if ( typeof nextnode === 'string' && $ul.find( nextnode ).length !== 0 ) {
442 $ul.find( nextnode ).eq( 0 ).before( $item );
444 // If the jQuery selector isn't found within the <ul>,
445 // or if nextnode was invalid or not passed at all,
446 // then just append it at the end of the <ul> (this is the default behavior)
455 * Add a little box at the top of the screen to inform the user of
456 * something, replacing any previous message.
457 * Calling with no arguments, with an empty string or null will hide the message
459 * @param {Mixed} message The DOM-element, jQuery object or HTML-string to be put inside the message box.
460 * to allow CSS/JS to hide different boxes. null = no class used.
461 * @deprecated Use mw#notify
463 jsMessage: function ( message ) {
464 if ( !arguments.length || message === '' || message === null ) {
467 if ( typeof message !== 'object' ) {
468 message = $.parseHTML( message );
470 mw.notify( message, { autoHide: true, tag: 'legacy' } );
475 * Validate a string as representing a valid e-mail address
476 * according to HTML5 specification. Please note the specification
477 * does not validate a domain with one character.
479 * FIXME: should be moved to or replaced by a validation module.
481 * @param {string} mailtxt E-mail address to be validated.
482 * @return {boolean|null} Null if `mailtxt` was an empty string, otherwise true/false
483 * as determined by validation.
485 validateEmail: function ( mailtxt ) {
486 var rfc5322Atext, rfc1034LdhStr, html5EmailRegexp;
488 if ( mailtxt === '' ) {
492 // HTML5 defines a string as valid e-mail address if it matches
494 // 1 * ( atext / "." ) "@" ldh-str 1*( "." ldh-str )
496 // - atext : defined in RFC 5322 section 3.2.3
497 // - ldh-str : defined in RFC 1034 section 3.5
499 // (see STD 68 / RFC 5234 http://tools.ietf.org/html/std68)
500 // First, define the RFC 5322 'atext' which is pretty easy:
501 // atext = ALPHA / DIGIT / ; Printable US-ASCII
502 // "!" / "#" / ; characters not including
503 // "$" / "%" / ; specials. Used for atoms.
512 rfc5322Atext = 'a-z0-9!#$%&\'*+\\-/=?^_`{|}~';
514 // Next define the RFC 1034 'ldh-str'
515 // <domain> ::= <subdomain> | " "
516 // <subdomain> ::= <label> | <subdomain> "." <label>
517 // <label> ::= <letter> [ [ <ldh-str> ] <let-dig> ]
518 // <ldh-str> ::= <let-dig-hyp> | <let-dig-hyp> <ldh-str>
519 // <let-dig-hyp> ::= <let-dig> | "-"
520 // <let-dig> ::= <letter> | <digit>
521 rfc1034LdhStr = 'a-z0-9\\-';
523 html5EmailRegexp = new RegExp(
527 // User part which is liberal :p
528 '[' + rfc5322Atext + '\\.]+'
534 '[' + rfc1034LdhStr + ']+'
536 // Optional second part and following are separated by a dot
537 '(?:\\.[' + rfc1034LdhStr + ']+)*'
541 // RegExp is case insensitive
544 return (null !== mailtxt.match( html5EmailRegexp ) );
548 * Note: borrows from IP::isIPv4
550 * @param {string} address
551 * @param {boolean} allowBlock
554 isIPv4Address: function ( address, allowBlock ) {
555 if ( typeof address !== 'string' ) {
559 var block = allowBlock ? '(?:\\/(?:3[0-2]|[12]?\\d))?' : '',
560 RE_IP_BYTE = '(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9]?[0-9])',
561 RE_IP_ADD = '(?:' + RE_IP_BYTE + '\\.){3}' + RE_IP_BYTE;
563 return address.search( new RegExp( '^' + RE_IP_ADD + block + '$' ) ) !== -1;
567 * Note: borrows from IP::isIPv6
569 * @param {string} address
570 * @param {boolean} allowBlock
573 isIPv6Address: function ( address, allowBlock ) {
574 if ( typeof address !== 'string' ) {
578 var block = allowBlock ? '(?:\\/(?:12[0-8]|1[01][0-9]|[1-9]?\\d))?' : '',
580 '(?:' + // starts with "::" (including "::")
581 ':(?::|(?::' + '[0-9A-Fa-f]{1,4}' + '){1,7})' +
582 '|' + // ends with "::" (except "::")
583 '[0-9A-Fa-f]{1,4}' + '(?::' + '[0-9A-Fa-f]{1,4}' + '){0,6}::' +
584 '|' + // contains no "::"
585 '[0-9A-Fa-f]{1,4}' + '(?::' + '[0-9A-Fa-f]{1,4}' + '){7}' +
588 if ( address.search( new RegExp( '^' + RE_IPV6_ADD + block + '$' ) ) !== -1 ) {
592 RE_IPV6_ADD = // contains one "::" in the middle (single '::' check below)
593 '[0-9A-Fa-f]{1,4}' + '(?:::?' + '[0-9A-Fa-f]{1,4}' + '){1,6}';
595 return address.search( new RegExp( '^' + RE_IPV6_ADD + block + '$' ) ) !== -1
596 && address.search( /::/ ) !== -1 && address.search( /::.*::/ ) === -1;
602 }( mediaWiki, jQuery ) );