13 * (don't call before document ready)
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/Iceweasel 2.x and later
57 } else if ( ( profile
.name
=== 'firefox' || profile
.name
=== 'iceweasel' )
58 && profile
.versionBase
> '1' ) {
59 util
.tooltipAccessKeyPrefix
= 'alt-shift-';
62 /* Fill $content var */
63 util
.$content
= ( function () {
64 var i
, l
, $content
, selectors
;
66 // The preferred standard for setting $content (class="mw-body")
67 // You may also use (class="mw-body mw-body-primary") if you use
68 // mw-body in multiple locations.
69 // Or class="mw-body-primary" if you want $content to be deeper
70 // in the dom than mw-body
74 /* Legacy fallbacks for setting the content */
75 // Vector, Monobook, Chick, etc... based skins
81 // Standard, CologneBlue
84 // #content is present on almost all if not all skins. Most skins (the above cases)
85 // have #content too, but as an outer wrapper instead of the article text container.
86 // The skins that don't have an outer wrapper do have #content for everything
87 // so it's a good fallback
90 // If nothing better is found fall back to our bodytext div that is guaranteed to be here
93 // Should never happen... well, it could if someone is not finished writing a skin and has
94 // not inserted bodytext yet. But in any case <body> should always exist
97 for ( i
= 0, l
= selectors
.length
; i
< l
; i
++ ) {
98 $content
= $( selectors
[i
] ).first();
99 if ( $content
.length
) {
104 // Make sure we don't unset util.$content if it was preset and we don't find anything
105 return util
.$content
;
112 * Encode the string like PHP's rawurlencode
114 * @param {string} str String to be encoded.
116 rawurlencode: function ( str
) {
118 return encodeURIComponent( str
)
119 .replace( /!/g, '%21' ).replace( /'/g, '%27' ).replace( /\(/g, '%28' )
120 .replace( /\)/g, '%29' ).replace( /\*/g, '%2A
' ).replace( /~/g, '%7E
' );
124 * Encode page titles for use in a URL
125 * We want / and : to be included as literal characters in our title URLs
126 * as they otherwise fatally break the title
128 * @param {string} str String to be encoded.
130 wikiUrlencode: function ( str ) {
131 return util.rawurlencode( str )
132 .replace( /%20/g, '_
' ).replace( /%3A/g, ':' ).replace( /%2F/g, '/' );
136 * Get the link to a page name (relative to `wgServer`),
138 * @param {string} str Page name to get the link for.
139 * @param {Object} [params] A mapping of query parameter names to values,
140 * e.g. `{ action: 'edit
' }`.
141 * @return {string} Location for a page with name of `str` or boolean false on error.
143 getUrl: function ( str, params ) {
144 var url = mw.config.get( 'wgArticlePath
' ).replace( '$1',
145 util.wikiUrlencode( typeof str === 'string
' ? str : mw.config.get( 'wgPageName
' ) ) );
146 if ( params && !$.isEmptyObject( params ) ) {
147 url += url.indexOf( '?' ) !== -1 ? '&' : '?';
148 url += $.param( params );
154 * Get address to a script in the wiki root.
155 * For index.php use `mw.config.get( 'wgScript
' )`.
158 * @param str string Name of script (eg. 'api
'), defaults to 'index
'
159 * @return string Address to script (eg. '/w
/api
.php
' )
161 wikiScript: function ( str ) {
162 str = str || 'index
';
163 if ( str === 'index
' ) {
164 return mw.config.get( 'wgScript
' );
165 } else if ( str === 'load
' ) {
166 return mw.config.get( 'wgLoadScript
' );
168 return mw.config.get( 'wgScriptPath
' ) + '/' + str +
169 mw.config.get( 'wgScriptExtension
' );
174 * Append a new style block to the head and return the CSSStyleSheet object.
175 * Use .ownerNode to access the `<style>` element, or use mw.loader#addStyleTag.
176 * This function returns the styleSheet object for convience (due to cross-browsers
177 * difference as to where it is located).
179 * var sheet = mw.util.addCSS( '.foobar
{ display
: none
; }' );
180 * $( foo ).click( function () {
181 * // Toggle the sheet on and off
182 * sheet.disabled = !sheet.disabled;
185 * @param {string} text CSS to be appended
186 * @return {CSSStyleSheet} Use .ownerNode to get to the `<style>` element.
188 addCSS: function ( text ) {
189 var s = mw.loader.addStyleTag( text );
190 return s.sheet || s.styleSheet || s;
194 * Hide/show the table of contents element
196 * @param {jQuery} $toggleLink A jQuery object of the toggle link.
197 * @param {Function} [callback] Function to be called after the toggle is
198 * completed (including the animation).
199 * @return {Mixed} Boolean visibility of the toc (true if it's visible
)
200 * or Null
if there was no table
of contents
.
201 * @deprecated since
1.23 Use jQuery
203 toggleToc: function ( $toggleLink
, callback
) {
204 var ret
, $tocList
= $( '#toc ul:first' );
206 // This function shouldn't be called if there's no TOC,
207 // but just in case...
208 if ( !$tocList
.length
) {
211 ret
= $tocList
.is( ':hidden' );
213 $tocList
.promise().done( callback
);
218 * Grab the URL parameter value for the given parameter.
219 * Returns null if not found.
221 * @param {string} param The parameter name.
222 * @param {string} [url=document.location.href] URL to search through, defaulting to the current document's URL.
223 * @return {Mixed} Parameter value or null.
225 getParamValue: function ( param
, url
) {
226 if ( url
=== undefined ) {
227 url
= document
.location
.href
;
229 // Get last match, stop at hash
230 var re
= new RegExp( '^[^#]*[&?]' + $.escapeRE( param
) + '=([^&#]*)' ),
233 // Beware that decodeURIComponent is not required to understand '+'
234 // by spec, as encodeURIComponent does not produce it.
235 return decodeURIComponent( m
[1].replace( /\+/g, '%20' ) );
242 * Access key prefix. Will be re-defined based on browser/operating system
243 * detection in mw.util#init.
245 tooltipAccessKeyPrefix
: 'alt-',
249 * Regex to match accesskey tooltips.
258 * The accesskey is matched in group $6.
260 tooltipAccessKeyRegexp
: /\[(ctrl-)?(option-)?(alt-)?(shift-)?(esc-)?(.)\]$/,
263 * Add the appropriate prefix to the accesskey shown in the tooltip.
265 * If the `$nodes` parameter is given, only those nodes are updated;
266 * otherwise, depending on browser support, we update either all elements
267 * with accesskeys on the page or a bunch of elements which are likely to
268 * have them on core skins.
270 * @param {Array|jQuery} [$nodes] A jQuery object, or array of nodes to update.
272 updateTooltipAccessKeys: function ( $nodes
) {
274 if ( document
.querySelectorAll
) {
275 // If we're running on a browser where we can do this efficiently,
276 // just find all elements that have accesskeys. We can't use jQuery's
277 // polyfill for the selector since looping over all elements on page
278 // load might be too slow.
279 $nodes
= $( document
.querySelectorAll( '[accesskey]' ) );
281 // Otherwise go through some elements likely to have accesskeys rather
282 // than looping over all of them. Unfortunately this will not fully
283 // work for custom skins with different HTML structures. Input, label
284 // and button should be rare enough that no optimizations are needed.
285 $nodes
= $( '#column-one a, #mw-head a, #mw-panel a, #p-logo a, input, label, button' );
287 } else if ( !( $nodes
instanceof $ ) ) {
288 $nodes
= $( $nodes
);
291 $nodes
.attr( 'title', function ( i
, val
) {
292 if ( val
&& util
.tooltipAccessKeyRegexp
.test( val
) ) {
293 return val
.replace( util
.tooltipAccessKeyRegexp
,
294 '[' + util
.tooltipAccessKeyPrefix
+ '$6]' );
302 * A jQuery object that refers to the content area element.
303 * Populated by #init.
308 * Add a link to a portlet menu on the page, such as:
310 * p-cactions (Content actions), p-personal (Personal tools),
311 * p-navigation (Navigation), p-tb (Toolbox)
313 * The first three paramters are required, the others are optional and
314 * may be null. Though providing an id and tooltip is recommended.
316 * By default the new link will be added to the end of the list. To
317 * add the link before a given existing item, pass the DOM node
318 * (e.g. `document.getElementById( 'foobar' )`) or a jQuery-selector
319 * (e.g. `'#foobar'`) for that item.
321 * mw.util.addPortletLink(
322 * 'p-tb', 'http://mediawiki.org/',
323 * 'MediaWiki.org', 't-mworg', 'Go to MediaWiki.org ', 'm', '#t-print'
326 * @param {string} portlet ID of the target portlet ( 'p-cactions' or 'p-personal' etc.)
327 * @param {string} href Link URL
328 * @param {string} text Link text
329 * @param {string} [id] ID of the new item, should be unique and preferably have
330 * the appropriate prefix ( 'ca-', 'pt-', 'n-' or 't-' )
331 * @param {string} [tooltip] Text to show when hovering over the link, without accesskey suffix
332 * @param {string} [accesskey] Access key to activate this link (one character, try
333 * to avoid conflicts. Use `$( '[accesskey=x]' ).get()` in the console to
334 * see if 'x' is already used.
335 * @param {HTMLElement|jQuery|string} [nextnode] Element or jQuery-selector string to the item that
336 * the new item should be added before, should be another item in the same
337 * list, it will be ignored otherwise
339 * @return {HTMLElement|null} The added element (a ListItem or Anchor element,
340 * depending on the skin) or null if no element was added to the document.
342 addPortletLink: function ( portlet
, href
, text
, id
, tooltip
, accesskey
, nextnode
) {
343 var $item
, $link
, $portlet
, $ul
;
345 // Check if there's atleast 3 arguments to prevent a TypeError
346 if ( arguments
.length
< 3 ) {
349 // Setup the anchor tag
350 $link
= $( '<a>' ).attr( 'href', href
).text( text
);
352 $link
.attr( 'title', tooltip
);
355 // Select the specified portlet
356 $portlet
= $( '#' + portlet
);
357 if ( $portlet
.length
=== 0 ) {
360 // Select the first (most likely only) unordered list inside the portlet
361 $ul
= $portlet
.find( 'ul' ).eq( 0 );
363 // If it didn't have an unordered list yet, create it
364 if ( $ul
.length
=== 0 ) {
368 // If there's no <div> inside, append it to the portlet directly
369 if ( $portlet
.find( 'div:first' ).length
=== 0 ) {
370 $portlet
.append( $ul
);
372 // otherwise if there's a div (such as div.body or div.pBody)
373 // append the <ul> to last (most likely only) div
374 $portlet
.find( 'div' ).eq( -1 ).append( $ul
);
378 if ( $ul
.length
=== 0 ) {
382 // Unhide portlet if it was hidden before
383 $portlet
.removeClass( 'emptyPortlet' );
385 // Wrap the anchor tag in a list item (and a span if $portlet is a Vector tab)
386 // and back up the selector to the list item
387 if ( $portlet
.hasClass( 'vectorTabs' ) ) {
388 $item
= $link
.wrap( '<li><span></span></li>' ).parent().parent();
390 $item
= $link
.wrap( '<li></li>' ).parent();
393 // Implement the properties passed to the function
395 $item
.attr( 'id', id
);
399 // Trim any existing accesskey hint and the trailing space
400 tooltip
= $.trim( tooltip
.replace( util
.tooltipAccessKeyRegexp
, '' ) );
402 tooltip
+= ' [' + accesskey
+ ']';
404 $link
.attr( 'title', tooltip
);
406 util
.updateTooltipAccessKeys( $link
);
411 $link
.attr( 'accesskey', accesskey
);
415 if ( nextnode
.nodeType
|| typeof nextnode
=== 'string' ) {
416 // nextnode is a DOM element (was the only option before MW 1.17, in wikibits.js)
417 // or nextnode is a CSS selector for jQuery
418 nextnode
= $ul
.find( nextnode
);
419 } else if ( !nextnode
.jquery
|| ( nextnode
.length
&& nextnode
[0].parentNode
!== $ul
[0] ) ) {
424 if ( nextnode
.length
=== 1 ) {
425 // nextnode is a jQuery object that represents exactly one element
426 nextnode
.before( $item
);
431 // Fallback (this is the default behavior)
438 * Add a little box at the top of the screen to inform the user of
439 * something, replacing any previous message.
440 * Calling with no arguments, with an empty string or null will hide the message
442 * @param {Mixed} message The DOM-element, jQuery object or HTML-string to be put inside the message box.
443 * to allow CSS/JS to hide different boxes. null = no class used.
444 * @deprecated since 1.20 Use mw#notify
446 jsMessage: function ( message
) {
447 if ( !arguments
.length
|| message
=== '' || message
=== null ) {
450 if ( typeof message
!== 'object' ) {
451 message
= $.parseHTML( message
);
453 mw
.notify( message
, { autoHide
: true, tag
: 'legacy' } );
458 * Validate a string as representing a valid e-mail address
459 * according to HTML5 specification. Please note the specification
460 * does not validate a domain with one character.
462 * FIXME: should be moved to or replaced by a validation module.
464 * @param {string} mailtxt E-mail address to be validated.
465 * @return {boolean|null} Null if `mailtxt` was an empty string, otherwise true/false
466 * as determined by validation.
468 validateEmail: function ( mailtxt
) {
469 var rfc5322Atext
, rfc1034LdhStr
, html5EmailRegexp
;
471 if ( mailtxt
=== '' ) {
475 // HTML5 defines a string as valid e-mail address if it matches
477 // 1 * ( atext / "." ) "@" ldh-str 1*( "." ldh-str )
479 // - atext : defined in RFC 5322 section 3.2.3
480 // - ldh-str : defined in RFC 1034 section 3.5
482 // (see STD 68 / RFC 5234 http://tools.ietf.org/html/std68)
483 // First, define the RFC 5322 'atext' which is pretty easy:
484 // atext = ALPHA / DIGIT / ; Printable US-ASCII
485 // "!" / "#" / ; characters not including
486 // "$" / "%" / ; specials. Used for atoms.
495 rfc5322Atext
= 'a-z0-9!#$%&\'*+\\-/=?^_`{|}~';
497 // Next define the RFC 1034 'ldh-str'
498 // <domain> ::= <subdomain> | " "
499 // <subdomain> ::= <label> | <subdomain> "." <label>
500 // <label> ::= <letter> [ [ <ldh-str> ] <let-dig> ]
501 // <ldh-str> ::= <let-dig-hyp> | <let-dig-hyp> <ldh-str>
502 // <let-dig-hyp> ::= <let-dig> | "-"
503 // <let-dig> ::= <letter> | <digit>
504 rfc1034LdhStr
= 'a-z0-9\\-';
506 html5EmailRegexp
= new RegExp(
510 // User part which is liberal :p
511 '[' + rfc5322Atext
+ '\\.]+'
517 '[' + rfc1034LdhStr
+ ']+'
519 // Optional second part and following are separated by a dot
520 '(?:\\.[' + rfc1034LdhStr
+ ']+)*'
524 // RegExp is case insensitive
527 return ( null !== mailtxt
.match( html5EmailRegexp
) );
531 * Note: borrows from IP::isIPv4
533 * @param {string} address
534 * @param {boolean} allowBlock
537 isIPv4Address: function ( address
, allowBlock
) {
538 if ( typeof address
!== 'string' ) {
542 var block
= allowBlock
? '(?:\\/(?:3[0-2]|[12]?\\d))?' : '',
543 RE_IP_BYTE
= '(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9]?[0-9])',
544 RE_IP_ADD
= '(?:' + RE_IP_BYTE
+ '\\.){3}' + RE_IP_BYTE
;
546 return address
.search( new RegExp( '^' + RE_IP_ADD
+ block
+ '$' ) ) !== -1;
550 * Note: borrows from IP::isIPv6
552 * @param {string} address
553 * @param {boolean} allowBlock
556 isIPv6Address: function ( address
, allowBlock
) {
557 if ( typeof address
!== 'string' ) {
561 var block
= allowBlock
? '(?:\\/(?:12[0-8]|1[01][0-9]|[1-9]?\\d))?' : '',
563 '(?:' + // starts with "::" (including "::")
564 ':(?::|(?::' + '[0-9A-Fa-f]{1,4}' + '){1,7})' +
565 '|' + // ends with "::" (except "::")
566 '[0-9A-Fa-f]{1,4}' + '(?::' + '[0-9A-Fa-f]{1,4}' + '){0,6}::' +
567 '|' + // contains no "::"
568 '[0-9A-Fa-f]{1,4}' + '(?::' + '[0-9A-Fa-f]{1,4}' + '){7}' +
571 if ( address
.search( new RegExp( '^' + RE_IPV6_ADD
+ block
+ '$' ) ) !== -1 ) {
575 RE_IPV6_ADD
= // contains one "::" in the middle (single '::' check below)
576 '[0-9A-Fa-f]{1,4}' + '(?:::?' + '[0-9A-Fa-f]{1,4}' + '){1,6}';
578 return address
.search( new RegExp( '^' + RE_IPV6_ADD
+ block
+ '$' ) ) !== -1
579 && address
.search( /::/ ) !== -1 && address
.search( /::.*::/ ) === -1;
584 * @method wikiGetlink
585 * @inheritdoc #getUrl
586 * @deprecated since 1.23 Use #getUrl instead.
588 mw
.log
.deprecate( util
, 'wikiGetlink', util
.getUrl
, 'Use mw.util.getUrl instead.' );
592 }( mediaWiki
, jQuery
) );