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 the string like Sanitizer::escapeId in PHP
64 * @param {string} str String to be encoded.
66 escapeId: function ( str ) {
68 return util.rawurlencode( str.replace( / /g, '_
' ) )
69 .replace( /%3A/g, ':' )
70 .replace( /%/g, '.' );
74 * Encode page titles for use in a URL
76 * We want / and : to be included as literal characters in our title URLs
77 * as they otherwise fatally break the title.
79 * The others are decoded because we can, it's prettier and matches behaviour
80 * of `wfUrlencode` in PHP
.
82 * @param
{string
} str String to be encoded
.
84 wikiUrlencode: function ( str
) {
85 return util
.rawurlencode( str
)
86 .replace( /%20/g, '_' )
87 // wfUrlencode replacements
88 .replace( /%3B/g, ';' )
89 .replace( /%40/g, '@' )
90 .replace( /%24/g, '$' )
91 .replace( /%21/g, '!' )
92 .replace( /%2A/g, '*' )
93 .replace( /%28/g, '(' )
94 .replace( /%29/g, ')' )
95 .replace( /%2C/g, ',' )
96 .replace( /%2F/g, '/' )
97 .replace( /%7E/g, '~' )
98 .replace( /%3A/g, ':' );
102 * Get the link to a page name (relative to `wgServer`),
104 * @param {string|null} [str=wgPageName] Page name
105 * @param {Object} [params] A mapping of query parameter names to values,
106 * e.g. `{ action: 'edit' }`
107 * @return {string} Url of the page with name of `str`
109 getUrl: function ( str
, params
) {
110 var titleFragmentStart
,
113 pageName
= typeof str
=== 'string' ? str
: mw
.config
.get( 'wgPageName' );
115 // Find any fragment should one exist
116 if ( typeof str
=== 'string' ) {
117 titleFragmentStart
= pageName
.indexOf( '#' );
118 if ( titleFragmentStart
!== -1 ) {
119 fragment
= pageName
.slice( titleFragmentStart
+ 1 );
120 // Exclude the fragment from the page name
121 pageName
= pageName
.slice( 0, titleFragmentStart
);
125 url
= mw
.config
.get( 'wgArticlePath' ).replace( '$1', util
.wikiUrlencode( pageName
) );
127 // Add query string if necessary
128 if ( params
&& !$.isEmptyObject( params
) ) {
129 url
+= ( url
.indexOf( '?' ) !== -1 ? '&' : '?' ) + $.param( params
);
132 // Append the encoded fragment
133 if ( fragment
.length
> 0 ) {
134 url
+= '#' + util
.escapeId( fragment
);
141 * Get address to a script in the wiki root.
142 * For index.php use `mw.config.get( 'wgScript' )`.
145 * @param {string} str Name of script (e.g. 'api'), defaults to 'index'
146 * @return {string} Address to script (e.g. '/w/api.php' )
148 wikiScript: function ( str
) {
149 str
= str
|| 'index';
150 if ( str
=== 'index' ) {
151 return mw
.config
.get( 'wgScript' );
152 } else if ( str
=== 'load' ) {
153 return mw
.config
.get( 'wgLoadScript' );
155 return mw
.config
.get( 'wgScriptPath' ) + '/' + str
+ '.php';
160 * Append a new style block to the head and return the CSSStyleSheet object.
161 * Use .ownerNode to access the `<style>` element, or use mw.loader#addStyleTag.
162 * This function returns the styleSheet object for convience (due to cross-browsers
163 * difference as to where it is located).
165 * var sheet = mw.util.addCSS( '.foobar { display: none; }' );
166 * $( foo ).click( function () {
167 * // Toggle the sheet on and off
168 * sheet.disabled = !sheet.disabled;
171 * @param {string} text CSS to be appended
172 * @return {CSSStyleSheet} Use .ownerNode to get to the `<style>` element.
174 addCSS: function ( text
) {
175 var s
= mw
.loader
.addStyleTag( text
);
176 return s
.sheet
|| s
.styleSheet
|| s
;
180 * Grab the URL parameter value for the given parameter.
181 * Returns null if not found.
183 * @param {string} param The parameter name.
184 * @param {string} [url=location.href] URL to search through, defaulting to the current browsing location.
185 * @return {Mixed} Parameter value or null.
187 getParamValue: function ( param
, url
) {
188 if ( url
=== undefined ) {
191 // Get last match, stop at hash
192 var re
= new RegExp( '^[^#]*[&?]' + mw
.RegExp
.escape( param
) + '=([^&#]*)' ),
195 // Beware that decodeURIComponent is not required to understand '+'
196 // by spec, as encodeURIComponent does not produce it.
197 return decodeURIComponent( m
[ 1 ].replace( /\+/g, '%20' ) );
203 * The content wrapper of the skin (e.g. `.mw-body`).
205 * Populated on document ready by #init. To use this property,
206 * wait for `$.ready` and be sure to have a module depedendency on
207 * `mediawiki.util` and `mediawiki.page.startup` which will ensure
208 * your document ready handler fires after #init.
210 * Because of the lazy-initialised nature of this property,
211 * you're discouraged from using it.
213 * If you need just the wikipage content (not any of the
214 * extra elements output by the skin), use `$( '#mw-content-text' )`
215 * instead. Or listen to mw.hook#wikipage_content which will
216 * allow your code to re-run when the page changes (e.g. live preview
217 * or re-render after ajax save).
224 * Add a link to a portlet menu on the page, such as:
226 * p-cactions (Content actions), p-personal (Personal tools),
227 * p-navigation (Navigation), p-tb (Toolbox)
229 * The first three parameters are required, the others are optional and
230 * may be null. Though providing an id and tooltip is recommended.
232 * By default the new link will be added to the end of the list. To
233 * add the link before a given existing item, pass the DOM node
234 * (e.g. `document.getElementById( 'foobar' )`) or a jQuery-selector
235 * (e.g. `'#foobar'`) for that item.
237 * mw.util.addPortletLink(
238 * 'p-tb', 'https://www.mediawiki.org/',
239 * 'mediawiki.org', 't-mworg', 'Go to mediawiki.org', 'm', '#t-print'
242 * var node = mw.util.addPortletLink(
244 * new mw.Title( 'Special:Example' ).getUrl(),
247 * $( node ).on( 'click', function ( e ) {
248 * console.log( 'Example' );
249 * e.preventDefault();
252 * @param {string} portlet ID of the target portlet ( 'p-cactions' or 'p-personal' etc.)
253 * @param {string} href Link URL
254 * @param {string} text Link text
255 * @param {string} [id] ID of the new item, should be unique and preferably have
256 * the appropriate prefix ( 'ca-', 'pt-', 'n-' or 't-' )
257 * @param {string} [tooltip] Text to show when hovering over the link, without accesskey suffix
258 * @param {string} [accesskey] Access key to activate this link (one character, try
259 * to avoid conflicts. Use `$( '[accesskey=x]' ).get()` in the console to
260 * see if 'x' is already used.
261 * @param {HTMLElement|jQuery|string} [nextnode] Element or jQuery-selector string to the item that
262 * the new item should be added before, should be another item in the same
263 * list, it will be ignored otherwise
265 * @return {HTMLElement|null} The added element (a ListItem or Anchor element,
266 * depending on the skin) or null if no element was added to the document.
268 addPortletLink: function ( portlet
, href
, text
, id
, tooltip
, accesskey
, nextnode
) {
269 var $item
, $link
, $portlet
, $ul
;
271 // Check if there's at least 3 arguments to prevent a TypeError
272 if ( arguments
.length
< 3 ) {
275 // Setup the anchor tag
276 $link
= $( '<a>' ).attr( 'href', href
).text( text
);
278 $link
.attr( 'title', tooltip
);
281 // Select the specified portlet
282 $portlet
= $( '#' + portlet
);
283 if ( $portlet
.length
=== 0 ) {
286 // Select the first (most likely only) unordered list inside the portlet
287 $ul
= $portlet
.find( 'ul' ).eq( 0 );
289 // If it didn't have an unordered list yet, create it
290 if ( $ul
.length
=== 0 ) {
294 // If there's no <div> inside, append it to the portlet directly
295 if ( $portlet
.find( 'div:first' ).length
=== 0 ) {
296 $portlet
.append( $ul
);
298 // otherwise if there's a div (such as div.body or div.pBody)
299 // append the <ul> to last (most likely only) div
300 $portlet
.find( 'div' ).eq( -1 ).append( $ul
);
304 if ( $ul
.length
=== 0 ) {
308 // Unhide portlet if it was hidden before
309 $portlet
.removeClass( 'emptyPortlet' );
311 // Wrap the anchor tag in a list item (and a span if $portlet is a Vector tab)
312 // and back up the selector to the list item
313 if ( $portlet
.hasClass( 'vectorTabs' ) ) {
314 $item
= $link
.wrap( '<li><span></span></li>' ).parent().parent();
316 $item
= $link
.wrap( '<li></li>' ).parent();
319 // Implement the properties passed to the function
321 $item
.attr( 'id', id
);
325 $link
.attr( 'accesskey', accesskey
);
329 $link
.attr( 'title', tooltip
);
333 // Case: nextnode is a DOM element (was the only option before MW 1.17, in wikibits.js)
334 // Case: nextnode is a CSS selector for jQuery
335 if ( nextnode
.nodeType
|| typeof nextnode
=== 'string' ) {
336 nextnode
= $ul
.find( nextnode
);
337 } else if ( !nextnode
.jquery
) {
338 // Error: Invalid nextnode
339 nextnode
= undefined;
341 if ( nextnode
&& ( nextnode
.length
!== 1 || nextnode
[ 0 ].parentNode
!== $ul
[ 0 ] ) ) {
342 // Error: nextnode must resolve to a single node
343 // Error: nextnode must have the associated <ul> as its parent
344 nextnode
= undefined;
348 // Case: nextnode is a jQuery-wrapped DOM element
350 nextnode
.before( $item
);
352 // Fallback (this is the default behavior)
356 // Update tooltip for the access key after inserting into DOM
357 // to get a localized access key label (bug 67946).
358 $link
.updateTooltipAccessKeys();
364 * Validate a string as representing a valid e-mail address
365 * according to HTML5 specification. Please note the specification
366 * does not validate a domain with one character.
368 * FIXME: should be moved to or replaced by a validation module.
370 * @param {string} mailtxt E-mail address to be validated.
371 * @return {boolean|null} Null if `mailtxt` was an empty string, otherwise true/false
372 * as determined by validation.
374 validateEmail: function ( mailtxt
) {
375 var rfc5322Atext
, rfc1034LdhStr
, html5EmailRegexp
;
377 if ( mailtxt
=== '' ) {
381 // HTML5 defines a string as valid e-mail address if it matches
383 // 1 * ( atext / "." ) "@" ldh-str 1*( "." ldh-str )
385 // - atext : defined in RFC 5322 section 3.2.3
386 // - ldh-str : defined in RFC 1034 section 3.5
388 // (see STD 68 / RFC 5234 http://tools.ietf.org/html/std68)
389 // First, define the RFC 5322 'atext' which is pretty easy:
390 // atext = ALPHA / DIGIT / ; Printable US-ASCII
391 // "!" / "#" / ; characters not including
392 // "$" / "%" / ; specials. Used for atoms.
401 rfc5322Atext
= 'a-z0-9!#$%&\'*+\\-/=?^_`{|}~';
403 // Next define the RFC 1034 'ldh-str'
404 // <domain> ::= <subdomain> | " "
405 // <subdomain> ::= <label> | <subdomain> "." <label>
406 // <label> ::= <letter> [ [ <ldh-str> ] <let-dig> ]
407 // <ldh-str> ::= <let-dig-hyp> | <let-dig-hyp> <ldh-str>
408 // <let-dig-hyp> ::= <let-dig> | "-"
409 // <let-dig> ::= <letter> | <digit>
410 rfc1034LdhStr
= 'a-z0-9\\-';
412 html5EmailRegexp
= new RegExp(
416 // User part which is liberal :p
417 '[' + rfc5322Atext
+ '\\.]+'
423 '[' + rfc1034LdhStr
+ ']+'
425 // Optional second part and following are separated by a dot
426 '(?:\\.[' + rfc1034LdhStr
+ ']+)*'
430 // RegExp is case insensitive
433 return ( mailtxt
.match( html5EmailRegexp
) !== null );
437 * Note: borrows from IP::isIPv4
439 * @param {string} address
440 * @param {boolean} allowBlock
443 isIPv4Address: function ( address
, allowBlock
) {
444 if ( typeof address
!== 'string' ) {
448 var block
= allowBlock
? '(?:\\/(?:3[0-2]|[12]?\\d))?' : '',
449 RE_IP_BYTE
= '(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9]?[0-9])',
450 RE_IP_ADD
= '(?:' + RE_IP_BYTE
+ '\\.){3}' + RE_IP_BYTE
;
452 return address
.search( new RegExp( '^' + RE_IP_ADD
+ block
+ '$' ) ) !== -1;
456 * Note: borrows from IP::isIPv6
458 * @param {string} address
459 * @param {boolean} allowBlock
462 isIPv6Address: function ( address
, allowBlock
) {
463 if ( typeof address
!== 'string' ) {
467 var block
= allowBlock
? '(?:\\/(?:12[0-8]|1[01][0-9]|[1-9]?\\d))?' : '',
469 '(?:' + // starts with "::" (including "::")
470 ':(?::|(?::' + '[0-9A-Fa-f]{1,4}' + '){1,7})' +
471 '|' + // ends with "::" (except "::")
472 '[0-9A-Fa-f]{1,4}' + '(?::' + '[0-9A-Fa-f]{1,4}' + '){0,6}::' +
473 '|' + // contains no "::"
474 '[0-9A-Fa-f]{1,4}' + '(?::' + '[0-9A-Fa-f]{1,4}' + '){7}' +
477 if ( address
.search( new RegExp( '^' + RE_IPV6_ADD
+ block
+ '$' ) ) !== -1 ) {
481 RE_IPV6_ADD
= // contains one "::" in the middle (single '::' check below)
482 '[0-9A-Fa-f]{1,4}' + '(?:::?' + '[0-9A-Fa-f]{1,4}' + '){1,6}';
484 return address
.search( new RegExp( '^' + RE_IPV6_ADD
+ block
+ '$' ) ) !== -1
485 && address
.search( /::/ ) !== -1 && address
.search( /::.*::/ ) === -1;
489 * Check whether a string is an IP address
492 * @param {string} address String to check
493 * @param {boolean} allowBlock True if a block of IPs should be allowed
496 isIPAddress: function ( address
, allowBlock
) {
497 return util
.isIPv4Address( address
, allowBlock
) ||
498 util
.isIPv6Address( address
, allowBlock
);
503 * @method wikiGetlink
504 * @inheritdoc #getUrl
505 * @deprecated since 1.23 Use #getUrl instead.
507 mw
.log
.deprecate( util
, 'wikiGetlink', util
.getUrl
, 'Use mw.util.getUrl instead.' );
510 * Access key prefix. Might be wrong for browsers implementing the accessKeyLabel property.
511 * @property {string} tooltipAccessKeyPrefix
512 * @deprecated since 1.24 Use the module jquery.accessKeyLabel instead.
514 mw
.log
.deprecate( util
, 'tooltipAccessKeyPrefix', $.fn
.updateTooltipAccessKeys
.getAccessKeyPrefix(), 'Use jquery.accessKeyLabel instead.' );
517 * Regex to match accesskey tooltips.
521 * - "[ctrl-option-x]"
526 * The accesskey is matched in group $6.
528 * Will probably not work for browsers implementing the accessKeyLabel property.
530 * @property {RegExp} tooltipAccessKeyRegexp
531 * @deprecated since 1.24 Use the module jquery.accessKeyLabel instead.
533 mw
.log
.deprecate( util
, 'tooltipAccessKeyRegexp', /\[(ctrl-)?(option-)?(alt-)?(shift-)?(esc-)?(.)\]$/, 'Use jquery.accessKeyLabel instead.' );
536 * Add the appropriate prefix to the accesskey shown in the tooltip.
538 * If the `$nodes` parameter is given, only those nodes are updated;
539 * otherwise, depending on browser support, we update either all elements
540 * with accesskeys on the page or a bunch of elements which are likely to
541 * have them on core skins.
543 * @method updateTooltipAccessKeys
544 * @param {Array|jQuery} [$nodes] A jQuery object, or array of nodes to update.
545 * @deprecated since 1.24 Use the module jquery.accessKeyLabel instead.
547 mw
.log
.deprecate( util
, 'updateTooltipAccessKeys', function ( $nodes
) {
549 if ( document
.querySelectorAll
) {
550 // If we're running on a browser where we can do this efficiently,
551 // just find all elements that have accesskeys. We can't use jQuery's
552 // polyfill for the selector since looping over all elements on page
553 // load might be too slow.
554 $nodes
= $( document
.querySelectorAll( '[accesskey]' ) );
556 // Otherwise go through some elements likely to have accesskeys rather
557 // than looping over all of them. Unfortunately this will not fully
558 // work for custom skins with different HTML structures. Input, label
559 // and button should be rare enough that no optimizations are needed.
560 $nodes
= $( '#column-one a, #mw-head a, #mw-panel a, #p-logo a, input, label, button' );
562 } else if ( !( $nodes
instanceof $ ) ) {
563 $nodes
= $( $nodes
);
566 $nodes
.updateTooltipAccessKeys();
567 }, 'Use jquery.accessKeyLabel instead.' );
570 * Add a little box at the top of the screen to inform the user of
571 * something, replacing any previous message.
572 * Calling with no arguments, with an empty string or null will hide the message
575 * @deprecated since 1.20 Use mw#notify
576 * @param {Mixed} message The DOM-element, jQuery object or HTML-string to be put inside the message box.
577 * to allow CSS/JS to hide different boxes. null = no class used.
579 mw
.log
.deprecate( util
, 'jsMessage', function ( message
) {
580 if ( !arguments
.length
|| message
=== '' || message
=== null ) {
583 if ( typeof message
!== 'object' ) {
584 message
= $.parseHTML( message
);
586 mw
.notify( message
, { autoHide
: true, tag
: 'legacy' } );
588 }, 'Use mw.notify instead.' );
592 }( mediaWiki
, jQuery
) );