Merge "Call $wgContLang->findVariantLink() in {{PAGESINCATEGORY: }}"
[lhc/web/wiklou.git] / resources / mediawiki / mediawiki.util.js
1 ( function ( mw, $ ) {
2 'use strict';
3
4 /**
5 * Utility library
6 * @class mw.util
7 * @singleton
8 */
9 var util = {
10
11 /**
12 * Initialisation
13 * (don't call before document ready)
14 */
15 init: function () {
16 var profile, $tocTitle, $tocToggleLink, hideTocCookie;
17
18 /* Set tooltipAccessKeyPrefix */
19 profile = $.client.profile();
20
21 // Opera on any platform
22 if ( profile.name === 'opera' ) {
23 util.tooltipAccessKeyPrefix = 'shift-esc-';
24
25 // Chrome on any platform
26 } else if ( profile.name === 'chrome' ) {
27
28 util.tooltipAccessKeyPrefix = (
29 profile.platform === 'mac'
30 // Chrome on Mac
31 ? 'ctrl-option-'
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)
35 : 'alt-shift-'
36 );
37
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-';
43 // Firefox 14+ on Mac
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-';
55
56 // Firefox 2.x and later
57 } else if ( profile.name === 'firefox' && profile.versionBase > '1' ) {
58 util.tooltipAccessKeyPrefix = 'alt-shift-';
59 }
60
61 /* Fill $content var */
62 util.$content = ( function () {
63 var i, l, $content, selectors;
64 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
70 '.mw-body-primary',
71 '.mw-body',
72
73 /* Legacy fallbacks for setting the content */
74 // Vector, Monobook, Chick, etc... based skins
75 '#bodyContent',
76
77 // Modern based skins
78 '#mw_contentholder',
79
80 // Standard, CologneBlue
81 '#article',
82
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
87 '#content',
88
89 // If nothing better is found fall back to our bodytext div that is guaranteed to be here
90 '#mw-content-text',
91
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
94 'body'
95 ];
96 for ( i = 0, l = selectors.length; i < l; i++ ) {
97 $content = $( selectors[i] ).first();
98 if ( $content.length ) {
99 return $content;
100 }
101 }
102
103 // Make sure we don't unset util.$content if it was preset and we don't find anything
104 return util.$content;
105 } )();
106
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 ) {
116 e.preventDefault();
117 util.toggleToc( $(this) );
118 } );
119 $tocTitle.append(
120 $tocToggleLink
121 .wrap( '<span class="toctoggle"></span>' )
122 .parent()
123 .prepend( '&nbsp;[' )
124 .append( ']&nbsp;' )
125 );
126
127 if ( hideTocCookie === '1' ) {
128 util.toggleToc( $tocToggleLink );
129 }
130 }
131 },
132
133 /* Main body */
134
135 /**
136 * Encode the string like PHP's rawurlencode
137 *
138 * @param {string} str String to be encoded.
139 */
140 rawurlencode: function ( str ) {
141 str = String( 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' );
145 },
146
147 /**
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
151 *
152 * @param {string} str String to be encoded.
153 */
154 wikiUrlencode: function ( str ) {
155 return util.rawurlencode( str )
156 .replace( /%20/g, '_' ).replace( /%3A/g, ':' ).replace( /%2F/g, '/' );
157 },
158
159 /**
160 * Get the link to a page name (relative to `wgServer`),
161 *
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.
164 */
165 wikiGetlink: function ( str ) {
166 return mw.config.get( 'wgArticlePath' ).replace( '$1',
167 util.wikiUrlencode( typeof str === 'string' ? str : mw.config.get( 'wgPageName' ) ) );
168 },
169
170 /**
171 * Get address to a script in the wiki root.
172 * For index.php use `mw.config.get( 'wgScript' )`.
173 *
174 * @since 1.18
175 * @param str string Name of script (eg. 'api'), defaults to 'index'
176 * @return string Address to script (eg. '/w/api.php' )
177 */
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' );
184 } else {
185 return mw.config.get( 'wgScriptPath' ) + '/' + str +
186 mw.config.get( 'wgScriptExtension' );
187 }
188 },
189
190 /**
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).
195 *
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;
200 * });
201 *
202 * @param {string} text CSS to be appended
203 * @return {CSSStyleSheet} Use .ownerNode to get to the `<style>` element.
204 */
205 addCSS: function ( text ) {
206 var s = mw.loader.addStyleTag( text );
207 return s.sheet || s;
208 },
209
210 /**
211 * Hide/show the table of contents element
212 *
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.
218 */
219 toggleToc: function ( $toggleLink, callback ) {
220 var $tocList = $( '#toc ul:first' );
221
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, {
230 expires: 30,
231 path: '/'
232 } );
233 return true;
234 } else {
235 $tocList.slideUp( 'fast', callback );
236 $toggleLink.text( mw.msg( 'showtoc' ) );
237 $( '#toc' ).addClass( 'tochidden' );
238 $.cookie( 'mw_hidetoc', '1', {
239 expires: 30,
240 path: '/'
241 } );
242 return false;
243 }
244 } else {
245 return null;
246 }
247 },
248
249 /**
250 * Grab the URL parameter value for the given parameter.
251 * Returns null if not found.
252 *
253 * @param {string} param The parameter name.
254 * @param {string} [url=document.location.href] URL to search through, defaulting to the current document's URL.
255 * @return {Mixed} Parameter value or null.
256 */
257 getParamValue: function ( param, url ) {
258 if ( url === undefined ) {
259 url = document.location.href;
260 }
261 // Get last match, stop at hash
262 var re = new RegExp( '^[^#]*[&?]' + $.escapeRE( param ) + '=([^&#]*)' ),
263 m = re.exec( url );
264 if ( m ) {
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' ) );
268 }
269 return null;
270 },
271
272 /**
273 * @property {string}
274 * Access key prefix. Will be re-defined based on browser/operating system
275 * detection in mw.util#init.
276 */
277 tooltipAccessKeyPrefix: 'alt-',
278
279 /**
280 * @property {RegExp}
281 * Regex to match accesskey tooltips.
282 *
283 * Should match:
284 *
285 * - "ctrl-option-"
286 * - "alt-shift-"
287 * - "ctrl-alt-"
288 * - "ctrl-"
289 *
290 * The accesskey is matched in group $6.
291 */
292 tooltipAccessKeyRegexp: /\[(ctrl-)?(option-)?(alt-)?(shift-)?(esc-)?(.)\]$/,
293
294 /**
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.
299 *
300 * @param {Array|jQuery} [$nodes] A jQuery object, or array of nodes to update.
301 */
302 updateTooltipAccessKeys: function ( $nodes ) {
303 if ( !$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 );
310 }
311
312 $nodes.attr( 'title', function ( i, val ) {
313 if ( val && util.tooltipAccessKeyRegexp.test( val ) ) {
314 return val.replace( util.tooltipAccessKeyRegexp,
315 '[' + util.tooltipAccessKeyPrefix + '$6]' );
316 }
317 return val;
318 } );
319 },
320
321 /*
322 * @property {jQuery}
323 * A jQuery object that refers to the content area element.
324 * Populated by #init.
325 */
326 $content: null,
327
328 /**
329 * Add a link to a portlet menu on the page, such as:
330 *
331 * p-cactions (Content actions), p-personal (Personal tools),
332 * p-navigation (Navigation), p-tb (Toolbox)
333 *
334 * The first three paramters are required, the others are optional and
335 * may be null. Though providing an id and tooltip is recommended.
336 *
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.
341 *
342 * mw.util.addPortletLink(
343 * 'p-tb', 'http://mediawiki.org/',
344 * 'MediaWiki.org', 't-mworg', 'Go to MediaWiki.org ', 'm', '#t-print'
345 * );
346 *
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
359 *
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.
362 */
363 addPortletLink: function ( portlet, href, text, id, tooltip, accesskey, nextnode ) {
364 var $item, $link, $portlet, $ul;
365
366 // Check if there's atleast 3 arguments to prevent a TypeError
367 if ( arguments.length < 3 ) {
368 return null;
369 }
370 // Setup the anchor tag
371 $link = $( '<a>' ).attr( 'href', href ).text( text );
372 if ( tooltip ) {
373 $link.attr( 'title', tooltip );
374 }
375
376 // Select the specified portlet
377 $portlet = $( '#' + portlet );
378 if ( $portlet.length === 0 ) {
379 return null;
380 }
381 // Select the first (most likely only) unordered list inside the portlet
382 $ul = $portlet.find( 'ul' ).eq( 0 );
383
384 // If it didn't have an unordered list yet, create it
385 if ( $ul.length === 0 ) {
386
387 $ul = $( '<ul>' );
388
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 );
392 } else {
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 );
396 }
397 }
398 // Just in case..
399 if ( $ul.length === 0 ) {
400 return null;
401 }
402
403 // Unhide portlet if it was hidden before
404 $portlet.removeClass( 'emptyPortlet' );
405
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();
410 } else {
411 $item = $link.wrap( '<li></li>' ).parent();
412 }
413
414 // Implement the properties passed to the function
415 if ( id ) {
416 $item.attr( 'id', id );
417 }
418
419 if ( tooltip ) {
420 // Trim any existing accesskey hint and the trailing space
421 tooltip = $.trim( tooltip.replace( util.tooltipAccessKeyRegexp, '' ) );
422 if ( accesskey ) {
423 tooltip += ' [' + accesskey + ']';
424 }
425 $link.attr( 'title', tooltip );
426 if ( accesskey ) {
427 util.updateTooltipAccessKeys( $link );
428 }
429 }
430
431 if ( accesskey ) {
432 $link.attr( 'accesskey', accesskey );
433 }
434
435 if ( nextnode ) {
436 if ( nextnode.nodeType || typeof nextnode === 'string' ) {
437 // nextnode is a DOM element (was the only option before MW 1.17, in wikibits.js)
438 // or nextnode is a CSS selector for jQuery
439 nextnode = $ul.find( nextnode );
440 } else if ( !nextnode.jquery || nextnode[0].parentNode !== $ul[0] ) {
441 // Fallback
442 $ul.append( $item );
443 return $item[0];
444 }
445 if ( nextnode.length === 1 ) {
446 // nextnode is a jQuery object that represents exactly one element
447 nextnode.before( $item );
448 return $item[0];
449 }
450 }
451
452 // Fallback (this is the default behavior)
453 $ul.append( $item );
454 return $item[0];
455
456 },
457
458 /**
459 * Add a little box at the top of the screen to inform the user of
460 * something, replacing any previous message.
461 * Calling with no arguments, with an empty string or null will hide the message
462 *
463 * @param {Mixed} message The DOM-element, jQuery object or HTML-string to be put inside the message box.
464 * to allow CSS/JS to hide different boxes. null = no class used.
465 * @deprecated since 1.20 Use mw#notify
466 */
467 jsMessage: function ( message ) {
468 if ( !arguments.length || message === '' || message === null ) {
469 return true;
470 }
471 if ( typeof message !== 'object' ) {
472 message = $.parseHTML( message );
473 }
474 mw.notify( message, { autoHide: true, tag: 'legacy' } );
475 return true;
476 },
477
478 /**
479 * Validate a string as representing a valid e-mail address
480 * according to HTML5 specification. Please note the specification
481 * does not validate a domain with one character.
482 *
483 * FIXME: should be moved to or replaced by a validation module.
484 *
485 * @param {string} mailtxt E-mail address to be validated.
486 * @return {boolean|null} Null if `mailtxt` was an empty string, otherwise true/false
487 * as determined by validation.
488 */
489 validateEmail: function ( mailtxt ) {
490 var rfc5322Atext, rfc1034LdhStr, html5EmailRegexp;
491
492 if ( mailtxt === '' ) {
493 return null;
494 }
495
496 // HTML5 defines a string as valid e-mail address if it matches
497 // the ABNF:
498 // 1 * ( atext / "." ) "@" ldh-str 1*( "." ldh-str )
499 // With:
500 // - atext : defined in RFC 5322 section 3.2.3
501 // - ldh-str : defined in RFC 1034 section 3.5
502 //
503 // (see STD 68 / RFC 5234 http://tools.ietf.org/html/std68)
504 // First, define the RFC 5322 'atext' which is pretty easy:
505 // atext = ALPHA / DIGIT / ; Printable US-ASCII
506 // "!" / "#" / ; characters not including
507 // "$" / "%" / ; specials. Used for atoms.
508 // "&" / "'" /
509 // "*" / "+" /
510 // "-" / "/" /
511 // "=" / "?" /
512 // "^" / "_" /
513 // "`" / "{" /
514 // "|" / "}" /
515 // "~"
516 rfc5322Atext = 'a-z0-9!#$%&\'*+\\-/=?^_`{|}~';
517
518 // Next define the RFC 1034 'ldh-str'
519 // <domain> ::= <subdomain> | " "
520 // <subdomain> ::= <label> | <subdomain> "." <label>
521 // <label> ::= <letter> [ [ <ldh-str> ] <let-dig> ]
522 // <ldh-str> ::= <let-dig-hyp> | <let-dig-hyp> <ldh-str>
523 // <let-dig-hyp> ::= <let-dig> | "-"
524 // <let-dig> ::= <letter> | <digit>
525 rfc1034LdhStr = 'a-z0-9\\-';
526
527 html5EmailRegexp = new RegExp(
528 // start of string
529 '^'
530 +
531 // User part which is liberal :p
532 '[' + rfc5322Atext + '\\.]+'
533 +
534 // 'at'
535 '@'
536 +
537 // Domain first part
538 '[' + rfc1034LdhStr + ']+'
539 +
540 // Optional second part and following are separated by a dot
541 '(?:\\.[' + rfc1034LdhStr + ']+)*'
542 +
543 // End of string
544 '$',
545 // RegExp is case insensitive
546 'i'
547 );
548 return (null !== mailtxt.match( html5EmailRegexp ) );
549 },
550
551 /**
552 * Note: borrows from IP::isIPv4
553 *
554 * @param {string} address
555 * @param {boolean} allowBlock
556 * @return {boolean}
557 */
558 isIPv4Address: function ( address, allowBlock ) {
559 if ( typeof address !== 'string' ) {
560 return false;
561 }
562
563 var block = allowBlock ? '(?:\\/(?:3[0-2]|[12]?\\d))?' : '',
564 RE_IP_BYTE = '(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9]?[0-9])',
565 RE_IP_ADD = '(?:' + RE_IP_BYTE + '\\.){3}' + RE_IP_BYTE;
566
567 return address.search( new RegExp( '^' + RE_IP_ADD + block + '$' ) ) !== -1;
568 },
569
570 /**
571 * Note: borrows from IP::isIPv6
572 *
573 * @param {string} address
574 * @param {boolean} allowBlock
575 * @return {boolean}
576 */
577 isIPv6Address: function ( address, allowBlock ) {
578 if ( typeof address !== 'string' ) {
579 return false;
580 }
581
582 var block = allowBlock ? '(?:\\/(?:12[0-8]|1[01][0-9]|[1-9]?\\d))?' : '',
583 RE_IPV6_ADD =
584 '(?:' + // starts with "::" (including "::")
585 ':(?::|(?::' + '[0-9A-Fa-f]{1,4}' + '){1,7})' +
586 '|' + // ends with "::" (except "::")
587 '[0-9A-Fa-f]{1,4}' + '(?::' + '[0-9A-Fa-f]{1,4}' + '){0,6}::' +
588 '|' + // contains no "::"
589 '[0-9A-Fa-f]{1,4}' + '(?::' + '[0-9A-Fa-f]{1,4}' + '){7}' +
590 ')';
591
592 if ( address.search( new RegExp( '^' + RE_IPV6_ADD + block + '$' ) ) !== -1 ) {
593 return true;
594 }
595
596 RE_IPV6_ADD = // contains one "::" in the middle (single '::' check below)
597 '[0-9A-Fa-f]{1,4}' + '(?:::?' + '[0-9A-Fa-f]{1,4}' + '){1,6}';
598
599 return address.search( new RegExp( '^' + RE_IPV6_ADD + block + '$' ) ) !== -1
600 && address.search( /::/ ) !== -1 && address.search( /::.*::/ ) === -1;
601 }
602 };
603
604 mw.util = util;
605
606 }( mediaWiki, jQuery ) );