13 * (don't call before document ready)
16 util
.$content
= ( function () {
17 var i
, l
, $node
, selectors
;
20 // The preferred standard is class "mw-body".
21 // You may also use class "mw-body mw-body-primary" if you use
22 // mw-body in multiple locations. Or class "mw-body-primary" if
23 // you use mw-body deeper in the DOM.
27 // If the skin has no such class, fall back to the parser output
30 // Should never happen... well, it could if someone is not finished writing a
31 // skin and has not yet inserted bodytext yet.
35 for ( i
= 0, l
= selectors
.length
; i
< l
; i
++ ) {
36 $node
= $( selectors
[ i
] );
42 // Preserve existing customized value in case it was preset
50 * Encode the string like PHP's rawurlencode
52 * @param {string} str String to be encoded.
54 rawurlencode: function ( str
) {
56 return encodeURIComponent( str
)
57 .replace( /!/g, '%21' ).replace( /'/g, '%27' ).replace( /\(/g, '%28' )
58 .replace( /\)/g, '%29' ).replace( /\*/g, '%2A
' ).replace( /~/g, '%7E
' );
62 * Encode page titles for use in a URL
64 * We want / and : to be included as literal characters in our title URLs
65 * as they otherwise fatally break the title.
67 * The others are decoded because we can, it's prettier and matches behaviour
68 * of `wfUrlencode` in PHP
.
70 * @param
{string
} str String to be encoded
.
72 wikiUrlencode: function ( str
) {
73 return util
.rawurlencode( str
)
74 .replace( /%20/g, '_' )
75 // wfUrlencode replacements
76 .replace( /%3B/g, ';' )
77 .replace( /%40/g, '@' )
78 .replace( /%24/g, '$' )
79 .replace( /%21/g, '!' )
80 .replace( /%2A/g, '*' )
81 .replace( /%28/g, '(' )
82 .replace( /%29/g, ')' )
83 .replace( /%2C/g, ',' )
84 .replace( /%2F/g, '/' )
85 .replace( /%7E/g, '~' )
86 .replace( /%3A/g, ':' );
90 * Get the link to a page name (relative to `wgServer`),
92 * @param {string|null} [str=wgPageName] Page name
93 * @param {Object} [params] A mapping of query parameter names to values,
94 * e.g. `{ action: 'edit' }`
95 * @return {string} Url of the page with name of `str`
97 getUrl: function ( str
, params
) {
98 var url
= mw
.config
.get( 'wgArticlePath' ).replace(
100 util
.wikiUrlencode( typeof str
=== 'string' ? str
: mw
.config
.get( 'wgPageName' ) )
103 if ( params
&& !$.isEmptyObject( params
) ) {
104 url
+= ( url
.indexOf( '?' ) !== -1 ? '&' : '?' ) + $.param( params
);
111 * Get address to a script in the wiki root.
112 * For index.php use `mw.config.get( 'wgScript' )`.
115 * @param str string Name of script (eg. 'api'), defaults to 'index'
116 * @return {string} Address to script (eg. '/w/api.php' )
118 wikiScript: function ( str
) {
119 str
= str
|| 'index';
120 if ( str
=== 'index' ) {
121 return mw
.config
.get( 'wgScript' );
122 } else if ( str
=== 'load' ) {
123 return mw
.config
.get( 'wgLoadScript' );
125 return mw
.config
.get( 'wgScriptPath' ) + '/' + str
+
126 mw
.config
.get( 'wgScriptExtension' );
131 * Append a new style block to the head and return the CSSStyleSheet object.
132 * Use .ownerNode to access the `<style>` element, or use mw.loader#addStyleTag.
133 * This function returns the styleSheet object for convience (due to cross-browsers
134 * difference as to where it is located).
136 * var sheet = mw.util.addCSS( '.foobar { display: none; }' );
137 * $( foo ).click( function () {
138 * // Toggle the sheet on and off
139 * sheet.disabled = !sheet.disabled;
142 * @param {string} text CSS to be appended
143 * @return {CSSStyleSheet} Use .ownerNode to get to the `<style>` element.
145 addCSS: function ( text
) {
146 var s
= mw
.loader
.addStyleTag( text
);
147 return s
.sheet
|| s
.styleSheet
|| s
;
151 * Grab the URL parameter value for the given parameter.
152 * Returns null if not found.
154 * @param {string} param The parameter name.
155 * @param {string} [url=location.href] URL to search through, defaulting to the current browsing location.
156 * @return {Mixed} Parameter value or null.
158 getParamValue: function ( param
, url
) {
159 if ( url
=== undefined ) {
162 // Get last match, stop at hash
163 var re
= new RegExp( '^[^#]*[&?]' + mw
.RegExp
.escape( param
) + '=([^&#]*)' ),
166 // Beware that decodeURIComponent is not required to understand '+'
167 // by spec, as encodeURIComponent does not produce it.
168 return decodeURIComponent( m
[ 1 ].replace( /\+/g, '%20' ) );
174 * The content wrapper of the skin (e.g. `.mw-body`).
176 * Populated on document ready by #init. To use this property,
177 * wait for `$.ready` and be sure to have a module depedendency on
178 * `mediawiki.util` and `mediawiki.page.startup` which will ensure
179 * your document ready handler fires after #init.
181 * Because of the lazy-initialised nature of this property,
182 * you're discouraged from using it.
184 * If you need just the wikipage content (not any of the
185 * extra elements output by the skin), use `$( '#mw-content-text' )`
186 * instead. Or listen to mw.hook#wikipage_content which will
187 * allow your code to re-run when the page changes (e.g. live preview
188 * or re-render after ajax save).
195 * Add a link to a portlet menu on the page, such as:
197 * p-cactions (Content actions), p-personal (Personal tools),
198 * p-navigation (Navigation), p-tb (Toolbox)
200 * The first three parameters are required, the others are optional and
201 * may be null. Though providing an id and tooltip is recommended.
203 * By default the new link will be added to the end of the list. To
204 * add the link before a given existing item, pass the DOM node
205 * (e.g. `document.getElementById( 'foobar' )`) or a jQuery-selector
206 * (e.g. `'#foobar'`) for that item.
208 * mw.util.addPortletLink(
209 * 'p-tb', 'http://mediawiki.org/',
210 * 'MediaWiki.org', 't-mworg', 'Go to MediaWiki.org ', 'm', '#t-print'
213 * @param {string} portlet ID of the target portlet ( 'p-cactions' or 'p-personal' etc.)
214 * @param {string} href Link URL
215 * @param {string} text Link text
216 * @param {string} [id] ID of the new item, should be unique and preferably have
217 * the appropriate prefix ( 'ca-', 'pt-', 'n-' or 't-' )
218 * @param {string} [tooltip] Text to show when hovering over the link, without accesskey suffix
219 * @param {string} [accesskey] Access key to activate this link (one character, try
220 * to avoid conflicts. Use `$( '[accesskey=x]' ).get()` in the console to
221 * see if 'x' is already used.
222 * @param {HTMLElement|jQuery|string} [nextnode] Element or jQuery-selector string to the item that
223 * the new item should be added before, should be another item in the same
224 * list, it will be ignored otherwise
226 * @return {HTMLElement|null} The added element (a ListItem or Anchor element,
227 * depending on the skin) or null if no element was added to the document.
229 addPortletLink: function ( portlet
, href
, text
, id
, tooltip
, accesskey
, nextnode
) {
230 var $item
, $link
, $portlet
, $ul
;
232 // Check if there's at least 3 arguments to prevent a TypeError
233 if ( arguments
.length
< 3 ) {
236 // Setup the anchor tag
237 $link
= $( '<a>' ).attr( 'href', href
).text( text
);
239 $link
.attr( 'title', tooltip
);
242 // Select the specified portlet
243 $portlet
= $( '#' + portlet
);
244 if ( $portlet
.length
=== 0 ) {
247 // Select the first (most likely only) unordered list inside the portlet
248 $ul
= $portlet
.find( 'ul' ).eq( 0 );
250 // If it didn't have an unordered list yet, create it
251 if ( $ul
.length
=== 0 ) {
255 // If there's no <div> inside, append it to the portlet directly
256 if ( $portlet
.find( 'div:first' ).length
=== 0 ) {
257 $portlet
.append( $ul
);
259 // otherwise if there's a div (such as div.body or div.pBody)
260 // append the <ul> to last (most likely only) div
261 $portlet
.find( 'div' ).eq( -1 ).append( $ul
);
265 if ( $ul
.length
=== 0 ) {
269 // Unhide portlet if it was hidden before
270 $portlet
.removeClass( 'emptyPortlet' );
272 // Wrap the anchor tag in a list item (and a span if $portlet is a Vector tab)
273 // and back up the selector to the list item
274 if ( $portlet
.hasClass( 'vectorTabs' ) ) {
275 $item
= $link
.wrap( '<li><span></span></li>' ).parent().parent();
277 $item
= $link
.wrap( '<li></li>' ).parent();
280 // Implement the properties passed to the function
282 $item
.attr( 'id', id
);
286 $link
.attr( 'accesskey', accesskey
);
290 $link
.attr( 'title', tooltip
);
294 // Case: nextnode is a DOM element (was the only option before MW 1.17, in wikibits.js)
295 // Case: nextnode is a CSS selector for jQuery
296 if ( nextnode
.nodeType
|| typeof nextnode
=== 'string' ) {
297 nextnode
= $ul
.find( nextnode
);
298 } else if ( !nextnode
.jquery
) {
299 // Error: Invalid nextnode
300 nextnode
= undefined;
302 if ( nextnode
&& ( nextnode
.length
!== 1 || nextnode
[ 0 ].parentNode
!== $ul
[ 0 ] ) ) {
303 // Error: nextnode must resolve to a single node
304 // Error: nextnode must have the associated <ul> as its parent
305 nextnode
= undefined;
309 // Case: nextnode is a jQuery-wrapped DOM element
311 nextnode
.before( $item
);
313 // Fallback (this is the default behavior)
317 // Update tooltip for the access key after inserting into DOM
318 // to get a localized access key label (bug 67946).
319 $link
.updateTooltipAccessKeys();
325 * Validate a string as representing a valid e-mail address
326 * according to HTML5 specification. Please note the specification
327 * does not validate a domain with one character.
329 * FIXME: should be moved to or replaced by a validation module.
331 * @param {string} mailtxt E-mail address to be validated.
332 * @return {boolean|null} Null if `mailtxt` was an empty string, otherwise true/false
333 * as determined by validation.
335 validateEmail: function ( mailtxt
) {
336 var rfc5322Atext
, rfc1034LdhStr
, html5EmailRegexp
;
338 if ( mailtxt
=== '' ) {
342 // HTML5 defines a string as valid e-mail address if it matches
344 // 1 * ( atext / "." ) "@" ldh-str 1*( "." ldh-str )
346 // - atext : defined in RFC 5322 section 3.2.3
347 // - ldh-str : defined in RFC 1034 section 3.5
349 // (see STD 68 / RFC 5234 http://tools.ietf.org/html/std68)
350 // First, define the RFC 5322 'atext' which is pretty easy:
351 // atext = ALPHA / DIGIT / ; Printable US-ASCII
352 // "!" / "#" / ; characters not including
353 // "$" / "%" / ; specials. Used for atoms.
362 rfc5322Atext
= 'a-z0-9!#$%&\'*+\\-/=?^_`{|}~';
364 // Next define the RFC 1034 'ldh-str'
365 // <domain> ::= <subdomain> | " "
366 // <subdomain> ::= <label> | <subdomain> "." <label>
367 // <label> ::= <letter> [ [ <ldh-str> ] <let-dig> ]
368 // <ldh-str> ::= <let-dig-hyp> | <let-dig-hyp> <ldh-str>
369 // <let-dig-hyp> ::= <let-dig> | "-"
370 // <let-dig> ::= <letter> | <digit>
371 rfc1034LdhStr
= 'a-z0-9\\-';
373 html5EmailRegexp
= new RegExp(
377 // User part which is liberal :p
378 '[' + rfc5322Atext
+ '\\.]+'
384 '[' + rfc1034LdhStr
+ ']+'
386 // Optional second part and following are separated by a dot
387 '(?:\\.[' + rfc1034LdhStr
+ ']+)*'
391 // RegExp is case insensitive
394 return ( mailtxt
.match( html5EmailRegexp
) !== null );
398 * Note: borrows from IP::isIPv4
400 * @param {string} address
401 * @param {boolean} allowBlock
404 isIPv4Address: function ( address
, allowBlock
) {
405 if ( typeof address
!== 'string' ) {
409 var block
= allowBlock
? '(?:\\/(?:3[0-2]|[12]?\\d))?' : '',
410 RE_IP_BYTE
= '(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9]?[0-9])',
411 RE_IP_ADD
= '(?:' + RE_IP_BYTE
+ '\\.){3}' + RE_IP_BYTE
;
413 return address
.search( new RegExp( '^' + RE_IP_ADD
+ block
+ '$' ) ) !== -1;
417 * Note: borrows from IP::isIPv6
419 * @param {string} address
420 * @param {boolean} allowBlock
423 isIPv6Address: function ( address
, allowBlock
) {
424 if ( typeof address
!== 'string' ) {
428 var block
= allowBlock
? '(?:\\/(?:12[0-8]|1[01][0-9]|[1-9]?\\d))?' : '',
430 '(?:' + // starts with "::" (including "::")
431 ':(?::|(?::' + '[0-9A-Fa-f]{1,4}' + '){1,7})' +
432 '|' + // ends with "::" (except "::")
433 '[0-9A-Fa-f]{1,4}' + '(?::' + '[0-9A-Fa-f]{1,4}' + '){0,6}::' +
434 '|' + // contains no "::"
435 '[0-9A-Fa-f]{1,4}' + '(?::' + '[0-9A-Fa-f]{1,4}' + '){7}' +
438 if ( address
.search( new RegExp( '^' + RE_IPV6_ADD
+ block
+ '$' ) ) !== -1 ) {
442 RE_IPV6_ADD
= // contains one "::" in the middle (single '::' check below)
443 '[0-9A-Fa-f]{1,4}' + '(?:::?' + '[0-9A-Fa-f]{1,4}' + '){1,6}';
445 return address
.search( new RegExp( '^' + RE_IPV6_ADD
+ block
+ '$' ) ) !== -1
446 && address
.search( /::/ ) !== -1 && address
.search( /::.*::/ ) === -1;
450 * Check whether a string is an IP address
453 * @param {string} address String to check
454 * @param {boolean} allowBlock True if a block of IPs should be allowed
457 isIPAddress: function ( address
, allowBlock
) {
458 return util
.isIPv4Address( address
, allowBlock
) ||
459 util
.isIPv6Address( address
, allowBlock
);
464 * @method wikiGetlink
465 * @inheritdoc #getUrl
466 * @deprecated since 1.23 Use #getUrl instead.
468 mw
.log
.deprecate( util
, 'wikiGetlink', util
.getUrl
, 'Use mw.util.getUrl instead.' );
471 * Access key prefix. Might be wrong for browsers implementing the accessKeyLabel property.
472 * @property {string} tooltipAccessKeyPrefix
473 * @deprecated since 1.24 Use the module jquery.accessKeyLabel instead.
475 mw
.log
.deprecate( util
, 'tooltipAccessKeyPrefix', $.fn
.updateTooltipAccessKeys
.getAccessKeyPrefix(), 'Use jquery.accessKeyLabel instead.' );
478 * Regex to match accesskey tooltips.
482 * - "[ctrl-option-x]"
487 * The accesskey is matched in group $6.
489 * Will probably not work for browsers implementing the accessKeyLabel property.
491 * @property {RegExp} tooltipAccessKeyRegexp
492 * @deprecated since 1.24 Use the module jquery.accessKeyLabel instead.
494 mw
.log
.deprecate( util
, 'tooltipAccessKeyRegexp', /\[(ctrl-)?(option-)?(alt-)?(shift-)?(esc-)?(.)\]$/, 'Use jquery.accessKeyLabel instead.' );
497 * Add the appropriate prefix to the accesskey shown in the tooltip.
499 * If the `$nodes` parameter is given, only those nodes are updated;
500 * otherwise, depending on browser support, we update either all elements
501 * with accesskeys on the page or a bunch of elements which are likely to
502 * have them on core skins.
504 * @method updateTooltipAccessKeys
505 * @param {Array|jQuery} [$nodes] A jQuery object, or array of nodes to update.
506 * @deprecated since 1.24 Use the module jquery.accessKeyLabel instead.
508 mw
.log
.deprecate( util
, 'updateTooltipAccessKeys', function ( $nodes
) {
510 if ( document
.querySelectorAll
) {
511 // If we're running on a browser where we can do this efficiently,
512 // just find all elements that have accesskeys. We can't use jQuery's
513 // polyfill for the selector since looping over all elements on page
514 // load might be too slow.
515 $nodes
= $( document
.querySelectorAll( '[accesskey]' ) );
517 // Otherwise go through some elements likely to have accesskeys rather
518 // than looping over all of them. Unfortunately this will not fully
519 // work for custom skins with different HTML structures. Input, label
520 // and button should be rare enough that no optimizations are needed.
521 $nodes
= $( '#column-one a, #mw-head a, #mw-panel a, #p-logo a, input, label, button' );
523 } else if ( !( $nodes
instanceof $ ) ) {
524 $nodes
= $( $nodes
);
527 $nodes
.updateTooltipAccessKeys();
528 }, 'Use jquery.accessKeyLabel instead.' );
531 * Add a little box at the top of the screen to inform the user of
532 * something, replacing any previous message.
533 * Calling with no arguments, with an empty string or null will hide the message
536 * @deprecated since 1.20 Use mw#notify
537 * @param {Mixed} message The DOM-element, jQuery object or HTML-string to be put inside the message box.
538 * to allow CSS/JS to hide different boxes. null = no class used.
540 mw
.log
.deprecate( util
, 'jsMessage', function ( message
) {
541 if ( !arguments
.length
|| message
=== '' || message
=== null ) {
544 if ( typeof message
!== 'object' ) {
545 message
= $.parseHTML( message
);
547 mw
.notify( message
, { autoHide
: true, tag
: 'legacy' } );
549 }, 'Use mw.notify instead.' );
553 }( mediaWiki
, jQuery
) );