Merge "merging latest master" into Wikidata
[lhc/web/wiklou.git] / resources / mediawiki / mediawiki.util.js
1 /**
2 * Implements mediaWiki.util library
3 */
4 ( function ( mw, $ ) {
5 'use strict';
6
7 // Local cache and alias
8 var hideMessageTimeout,
9 messageBoxEvents = false,
10 util = {
11
12 /**
13 * Initialisation
14 * (don't call before document ready)
15 */
16 init: function () {
17 var profile, $tocTitle, $tocToggleLink, hideTocCookie;
18
19 /* Set up $.messageBox */
20 $.messageBoxNew( {
21 id: 'mw-js-message',
22 parent: '#content'
23 } );
24
25 /* Set tooltipAccessKeyPrefix */
26 profile = $.client.profile();
27
28 // Opera on any platform
29 if ( profile.name === 'opera' ) {
30 util.tooltipAccessKeyPrefix = 'shift-esc-';
31
32 // Chrome on any platform
33 } else if ( profile.name === 'chrome' ) {
34
35 util.tooltipAccessKeyPrefix = (
36 profile.platform === 'mac'
37 // Chrome on Mac
38 ? 'ctrl-option-'
39 : profile.platform === 'win'
40 // Chrome on Windows
41 // (both alt- and alt-shift work, but alt-f triggers Chrome wrench menu
42 // which alt-shift-f does not)
43 ? 'alt-shift-'
44 // Chrome on other (Ubuntu?)
45 : 'alt-'
46 );
47
48 // Non-Windows Safari with webkit_version > 526
49 } else if ( profile.platform !== 'win'
50 && profile.name === 'safari'
51 && profile.layoutVersion > 526 ) {
52 util.tooltipAccessKeyPrefix = 'ctrl-alt-';
53
54 // Safari/Konqueror on any platform, or any browser on Mac
55 // (but not Safari on Windows)
56 } else if ( !( profile.platform === 'win' && profile.name === 'safari' )
57 && ( profile.name === 'safari'
58 || profile.platform === 'mac'
59 || profile.name === 'konqueror' ) ) {
60 util.tooltipAccessKeyPrefix = 'ctrl-';
61
62 // Firefox 2.x and later
63 } else if ( profile.name === 'firefox' && profile.versionBase > '1' ) {
64 util.tooltipAccessKeyPrefix = 'alt-shift-';
65 }
66
67 /* Fill $content var */
68 if ( $( '#bodyContent' ).length ) {
69 // Vector, Monobook, Chick etc.
70 util.$content = $( '#bodyContent' );
71
72 } else if ( $( '#mw_contentholder' ).length ) {
73 // Modern
74 util.$content = $( '#mw_contentholder' );
75
76 } else if ( $( '#article' ).length ) {
77 // Standard, CologneBlue
78 util.$content = $( '#article' );
79
80 } else {
81 // #content is present on almost all if not all skins. Most skins (the above cases)
82 // have #content too, but as an outer wrapper instead of the article text container.
83 // The skins that don't have an outer wrapper do have #content for everything
84 // so it's a good fallback
85 util.$content = $( '#content' );
86 }
87
88 // Table of contents toggle
89 $tocTitle = $( '#toctitle' );
90 $tocToggleLink = $( '#togglelink' );
91 // Only add it if there is a TOC and there is no toggle added already
92 if ( $( '#toc' ).length && $tocTitle.length && !$tocToggleLink.length ) {
93 hideTocCookie = $.cookie( 'mw_hidetoc' );
94 $tocToggleLink = $( '<a href="#" class="internal" id="togglelink"></a>' )
95 .text( mw.msg( 'hidetoc' ) )
96 .click( function ( e ) {
97 e.preventDefault();
98 util.toggleToc( $(this) );
99 } );
100 $tocTitle.append(
101 $tocToggleLink
102 .wrap( '<span class="toctoggle"></span>' )
103 .parent()
104 .prepend( '&nbsp;[' )
105 .append( ']&nbsp;' )
106 );
107
108 if ( hideTocCookie === '1' ) {
109 util.toggleToc( $tocToggleLink );
110 }
111 }
112 },
113
114 /* Main body */
115
116 /**
117 * Encode the string like PHP's rawurlencode
118 *
119 * @param str string String to be encoded
120 */
121 rawurlencode: function ( str ) {
122 str = String( str );
123 return encodeURIComponent( str )
124 .replace( /!/g, '%21' ).replace( /'/g, '%27' ).replace( /\(/g, '%28' )
125 .replace( /\)/g, '%29' ).replace( /\*/g, '%2A' ).replace( /~/g, '%7E' );
126 },
127
128 /**
129 * Encode page titles for use in a URL
130 * We want / and : to be included as literal characters in our title URLs
131 * as they otherwise fatally break the title
132 *
133 * @param str string String to be encoded
134 */
135 wikiUrlencode: function ( str ) {
136 return util.rawurlencode( str )
137 .replace( /%20/g, '_' ).replace( /%3A/g, ':' ).replace( /%2F/g, '/' );
138 },
139
140 /**
141 * Get the link to a page name (relative to wgServer)
142 *
143 * @param str String: Page name to get the link for.
144 * @return String: Location for a page with name of 'str' or boolean false on error.
145 */
146 wikiGetlink: function ( str ) {
147 return mw.config.get( 'wgArticlePath' ).replace( '$1',
148 util.wikiUrlencode( typeof str === 'string' ? str : mw.config.get( 'wgPageName' ) ) );
149 },
150
151 /**
152 * Get address to a script in the wiki root.
153 * For index.php use mw.config.get( 'wgScript' )
154 *
155 * @since 1.18
156 * @param str string Name of script (eg. 'api'), defaults to 'index'
157 * @return string Address to script (eg. '/w/api.php' )
158 */
159 wikiScript: function ( str ) {
160 return mw.config.get( 'wgScriptPath' ) + '/' + ( str || 'index' ) +
161 mw.config.get( 'wgScriptExtension' );
162 },
163
164 /**
165 * Append a new style block to the head and return the CSSStyleSheet object.
166 * Use .ownerNode to access the <style> element, or use mw.loader.addStyleTag.
167 * This function returns the styleSheet object for convience (due to cross-browsers
168 * difference as to where it is located).
169 * @example
170 * <code>
171 * var sheet = mw.util.addCSS('.foobar { display: none; }');
172 * $(foo).click(function () {
173 * // Toggle the sheet on and off
174 * sheet.disabled = !sheet.disabled;
175 * });
176 * </code>
177 *
178 * @param text string CSS to be appended
179 * @return CSSStyleSheet (use .ownerNode to get to the <style> element)
180 */
181 addCSS: function ( text ) {
182 var s = mw.loader.addStyleTag( text );
183 return s.sheet || s;
184 },
185
186 /**
187 * Hide/show the table of contents element
188 *
189 * @param $toggleLink jQuery A jQuery object of the toggle link.
190 * @param callback function Function to be called after the toggle is
191 * completed (including the animation) (optional)
192 * @return mixed Boolean visibility of the toc (true if it's visible)
193 * or Null if there was no table of contents.
194 */
195 toggleToc: function ( $toggleLink, callback ) {
196 var $tocList = $( '#toc ul:first' );
197
198 // This function shouldn't be called if there's no TOC,
199 // but just in case...
200 if ( $tocList.length ) {
201 if ( $tocList.is( ':hidden' ) ) {
202 $tocList.slideDown( 'fast', callback );
203 $toggleLink.text( mw.msg( 'hidetoc' ) );
204 $( '#toc' ).removeClass( 'tochidden' );
205 $.cookie( 'mw_hidetoc', null, {
206 expires: 30,
207 path: '/'
208 } );
209 return true;
210 } else {
211 $tocList.slideUp( 'fast', callback );
212 $toggleLink.text( mw.msg( 'showtoc' ) );
213 $( '#toc' ).addClass( 'tochidden' );
214 $.cookie( 'mw_hidetoc', '1', {
215 expires: 30,
216 path: '/'
217 } );
218 return false;
219 }
220 } else {
221 return null;
222 }
223 },
224
225 /**
226 * Grab the URL parameter value for the given parameter.
227 * Returns null if not found.
228 *
229 * @param param string The parameter name.
230 * @param url string URL to search through (optional)
231 * @return mixed Parameter value or null.
232 */
233 getParamValue: function ( param, url ) {
234 url = url || document.location.href;
235 // Get last match, stop at hash
236 var re = new RegExp( '^[^#]*[&?]' + $.escapeRE( param ) + '=([^&#]*)' ),
237 m = re.exec( url );
238 if ( m ) {
239 // Beware that decodeURIComponent is not required to understand '+'
240 // by spec, as encodeURIComponent does not produce it.
241 return decodeURIComponent( m[1].replace( /\+/g, '%20' ) );
242 }
243 return null;
244 },
245
246 /**
247 * @var string
248 * Access key prefix. Will be re-defined based on browser/operating system
249 * detection in mw.util.init().
250 */
251 tooltipAccessKeyPrefix: 'alt-',
252
253 /**
254 * @var RegExp
255 * Regex to match accesskey tooltips.
256 */
257 tooltipAccessKeyRegexp: /\[(ctrl-)?(alt-)?(shift-)?(esc-)?(.)\]$/,
258
259 /**
260 * Add the appropriate prefix to the accesskey shown in the tooltip.
261 * If the nodeList parameter is given, only those nodes are updated;
262 * otherwise, all the nodes that will probably have accesskeys by
263 * default are updated.
264 *
265 * @param $nodes {Array|jQuery} [optional] A jQuery object, or array
266 * of elements to update.
267 */
268 updateTooltipAccessKeys: function ( $nodes ) {
269 if ( !$nodes ) {
270 // Rather than going into a loop of all anchor tags, limit to few elements that
271 // contain the relevant anchor tags.
272 // Input and label are rare enough that no such optimization is needed
273 $nodes = $( '#column-one a, #mw-head a, #mw-panel a, #p-logo a, input, label' );
274 } else if ( !( $nodes instanceof $ ) ) {
275 $nodes = $( $nodes );
276 }
277
278 $nodes.attr( 'title', function ( i, val ) {
279 if ( val && util.tooltipAccessKeyRegexp.exec( val ) ) {
280 return val.replace( util.tooltipAccessKeyRegexp,
281 '[' + util.tooltipAccessKeyPrefix + '$5]' );
282 }
283 return val;
284 } );
285 },
286
287 /*
288 * @var jQuery
289 * A jQuery object that refers to the page-content element
290 * Populated by init().
291 */
292 $content: null,
293
294 /**
295 * Add a link to a portlet menu on the page, such as:
296 *
297 * p-cactions (Content actions), p-personal (Personal tools),
298 * p-navigation (Navigation), p-tb (Toolbox)
299 *
300 * The first three paramters are required, the others are optional and
301 * may be null. Though providing an id and tooltip is recommended.
302 *
303 * By default the new link will be added to the end of the list. To
304 * add the link before a given existing item, pass the DOM node
305 * (document.getElementById( 'foobar' )) or the jQuery-selector
306 * ( '#foobar' ) of that item.
307 *
308 * @example mw.util.addPortletLink(
309 * 'p-tb', 'http://mediawiki.org/',
310 * 'MediaWiki.org', 't-mworg', 'Go to MediaWiki.org ', 'm', '#t-print'
311 * )
312 *
313 * @param portlet string ID of the target portlet ( 'p-cactions' or 'p-personal' etc.)
314 * @param href string Link URL
315 * @param text string Link text
316 * @param id string ID of the new item, should be unique and preferably have
317 * the appropriate prefix ( 'ca-', 'pt-', 'n-' or 't-' )
318 * @param tooltip string Text to show when hovering over the link, without accesskey suffix
319 * @param accesskey string Access key to activate this link (one character, try
320 * to avoid conflicts. Use $( '[accesskey=x]' ).get() in the console to
321 * see if 'x' is already used.
322 * @param nextnode mixed DOM Node or jQuery-selector string of the item that the new
323 * item should be added before, should be another item in the same
324 * list, it will be ignored otherwise
325 *
326 * @return mixed The DOM Node of the added item (a ListItem or Anchor element,
327 * depending on the skin) or null if no element was added to the document.
328 */
329 addPortletLink: function ( portlet, href, text, id, tooltip, accesskey, nextnode ) {
330 var $item, $link, $portlet, $ul;
331
332 // Check if there's atleast 3 arguments to prevent a TypeError
333 if ( arguments.length < 3 ) {
334 return null;
335 }
336 // Setup the anchor tag
337 $link = $( '<a>' ).attr( 'href', href ).text( text );
338 if ( tooltip ) {
339 $link.attr( 'title', tooltip );
340 }
341
342 // Some skins don't have any portlets
343 // just add it to the bottom of their 'sidebar' element as a fallback
344 switch ( mw.config.get( 'skin' ) ) {
345 case 'standard':
346 case 'cologneblue':
347 $( '#quickbar' ).append( $link.after( '<br/>' ) );
348 return $link[0];
349 case 'nostalgia':
350 $( '#searchform' ).before( $link ).before( ' &#124; ' );
351 return $link[0];
352 default: // Skins like chick, modern, monobook, myskin, simple, vector...
353
354 // Select the specified portlet
355 $portlet = $( '#' + portlet );
356 if ( $portlet.length === 0 ) {
357 return null;
358 }
359 // Select the first (most likely only) unordered list inside the portlet
360 $ul = $portlet.find( 'ul' ).eq( 0 );
361
362 // If it didn't have an unordered list yet, create it
363 if ( $ul.length === 0 ) {
364
365 $ul = $( '<ul>' );
366
367 // If there's no <div> inside, append it to the portlet directly
368 if ( $portlet.find( 'div:first' ).length === 0 ) {
369 $portlet.append( $ul );
370 } else {
371 // otherwise if there's a div (such as div.body or div.pBody)
372 // append the <ul> to last (most likely only) div
373 $portlet.find( 'div' ).eq( -1 ).append( $ul );
374 }
375 }
376 // Just in case..
377 if ( $ul.length === 0 ) {
378 return null;
379 }
380
381 // Unhide portlet if it was hidden before
382 $portlet.removeClass( 'emptyPortlet' );
383
384 // Wrap the anchor tag in a list item (and a span if $portlet is a Vector tab)
385 // and back up the selector to the list item
386 if ( $portlet.hasClass( 'vectorTabs' ) ) {
387 $item = $link.wrap( '<li><span></span></li>' ).parent().parent();
388 } else {
389 $item = $link.wrap( '<li></li>' ).parent();
390 }
391
392 // Implement the properties passed to the function
393 if ( id ) {
394 $item.attr( 'id', id );
395 }
396 if ( accesskey ) {
397 $link.attr( 'accesskey', accesskey );
398 tooltip += ' [' + accesskey + ']';
399 $link.attr( 'title', tooltip );
400 }
401 if ( accesskey && tooltip ) {
402 util.updateTooltipAccessKeys( $link );
403 }
404
405 // Where to put our node ?
406 // - nextnode is a DOM element (was the only option before MW 1.17, in wikibits.js)
407 if ( nextnode && nextnode.parentNode === $ul[0] ) {
408 $(nextnode).before( $item );
409
410 // - nextnode is a CSS selector for jQuery
411 } else if ( typeof nextnode === 'string' && $ul.find( nextnode ).length !== 0 ) {
412 $ul.find( nextnode ).eq( 0 ).before( $item );
413
414 // If the jQuery selector isn't found within the <ul>,
415 // or if nextnode was invalid or not passed at all,
416 // then just append it at the end of the <ul> (this is the default behaviour)
417 } else {
418 $ul.append( $item );
419 }
420
421
422 return $item[0];
423 }
424 },
425
426 /**
427 * Add a little box at the top of the screen to inform the user of
428 * something, replacing any previous message.
429 * Calling with no arguments, with an empty string or null will hide the message
430 *
431 * @param message {mixed} The DOM-element, jQuery object or HTML-string to be put inside the message box.
432 * @param className {String} Used in adding a class; should be different for each call
433 * to allow CSS/JS to hide different boxes. null = no class used.
434 * @return {Boolean} True on success, false on failure.
435 */
436 jsMessage: function ( message, className ) {
437 var $messageDiv = $( '#mw-js-message' );
438
439 if ( !arguments.length || message === '' || message === null ) {
440 $messageDiv.empty().hide();
441 stopHideMessageTimeout();
442 return true; // Emptying and hiding message is intended behaviour, return true
443 } else {
444 // We special-case skin structures provided by the software. Skins that
445 // choose to abandon or significantly modify our formatting can just define
446 // an mw-js-message div to start with.
447 if ( !$messageDiv.length ) {
448 $messageDiv = $( '<div id="mw-js-message"></div>' );
449 if ( util.$content.parent().length ) {
450 util.$content.parent().prepend( $messageDiv );
451 } else {
452 return false;
453 }
454 }
455
456 if ( !messageBoxEvents ) {
457 messageBoxEvents = true;
458 $messageDiv
459 .on( {
460 'mouseenter': stopHideMessageTimeout,
461 'mouseleave': startHideMessageTimeout,
462 'click': hideMessage
463 } )
464 .on( 'click', 'a', function ( e ) {
465 // Prevent links, even those that don't exist yet, from causing the
466 // message box to close when clicked
467 e.stopPropagation();
468 } );
469 }
470
471 if ( className ) {
472 $messageDiv.prop( 'className', 'mw-js-message-' + className );
473 }
474
475 if ( typeof message === 'object' ) {
476 $messageDiv.empty();
477 $messageDiv.append( message );
478 } else {
479 $messageDiv.html( message );
480 }
481
482 $messageDiv.slideDown();
483 startHideMessageTimeout();
484 return true;
485 }
486 },
487
488 /**
489 * Validate a string as representing a valid e-mail address
490 * according to HTML5 specification. Please note the specification
491 * does not validate a domain with one character.
492 *
493 * @todo FIXME: should be moved to or replaced by a JavaScript validation module.
494 *
495 * @param mailtxt string E-mail address to be validated.
496 * @return mixed Null if mailtxt was an empty string, otherwise true/false
497 * is determined by validation.
498 */
499 validateEmail: function ( mailtxt ) {
500 var rfc5322_atext, rfc1034_ldh_str, HTML5_email_regexp;
501
502 if ( mailtxt === '' ) {
503 return null;
504 }
505
506 /**
507 * HTML5 defines a string as valid e-mail address if it matches
508 * the ABNF:
509 * 1 * ( atext / "." ) "@" ldh-str 1*( "." ldh-str )
510 * With:
511 * - atext : defined in RFC 5322 section 3.2.3
512 * - ldh-str : defined in RFC 1034 section 3.5
513 *
514 * (see STD 68 / RFC 5234 http://tools.ietf.org/html/std68):
515 */
516
517 /**
518 * First, define the RFC 5322 'atext' which is pretty easy:
519 * atext = ALPHA / DIGIT / ; Printable US-ASCII
520 "!" / "#" / ; characters not including
521 "$" / "%" / ; specials. Used for atoms.
522 "&" / "'" /
523 "*" / "+" /
524 "-" / "/" /
525 "=" / "?" /
526 "^" / "_" /
527 "`" / "{" /
528 "|" / "}" /
529 "~"
530 */
531 rfc5322_atext = "a-z0-9!#$%&'*+\\-/=?^_`{|}~";
532
533 /**
534 * Next define the RFC 1034 'ldh-str'
535 * <domain> ::= <subdomain> | " "
536 * <subdomain> ::= <label> | <subdomain> "." <label>
537 * <label> ::= <letter> [ [ <ldh-str> ] <let-dig> ]
538 * <ldh-str> ::= <let-dig-hyp> | <let-dig-hyp> <ldh-str>
539 * <let-dig-hyp> ::= <let-dig> | "-"
540 * <let-dig> ::= <letter> | <digit>
541 */
542 rfc1034_ldh_str = "a-z0-9\\-";
543
544 HTML5_email_regexp = new RegExp(
545 // start of string
546 '^'
547 +
548 // User part which is liberal :p
549 '[' + rfc5322_atext + '\\.]+'
550 +
551 // 'at'
552 '@'
553 +
554 // Domain first part
555 '[' + rfc1034_ldh_str + ']+'
556 +
557 // Optional second part and following are separated by a dot
558 '(?:\\.[' + rfc1034_ldh_str + ']+)*'
559 +
560 // End of string
561 '$',
562 // RegExp is case insensitive
563 'i'
564 );
565 return (null !== mailtxt.match( HTML5_email_regexp ) );
566 },
567
568 /**
569 * Note: borrows from IP::isIPv4
570 *
571 * @param address string
572 * @param allowBlock boolean
573 * @return boolean
574 */
575 isIPv4Address: function ( address, allowBlock ) {
576 if ( typeof address !== 'string' ) {
577 return false;
578 }
579
580 var block = allowBlock ? '(?:\\/(?:3[0-2]|[12]?\\d))?' : '',
581 RE_IP_BYTE = '(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|0?[0-9]?[0-9])',
582 RE_IP_ADD = '(?:' + RE_IP_BYTE + '\\.){3}' + RE_IP_BYTE;
583
584 return address.search( new RegExp( '^' + RE_IP_ADD + block + '$' ) ) !== -1;
585 },
586
587 /**
588 * Note: borrows from IP::isIPv6
589 *
590 * @param address string
591 * @param allowBlock boolean
592 * @return boolean
593 */
594 isIPv6Address: function ( address, allowBlock ) {
595 if ( typeof address !== 'string' ) {
596 return false;
597 }
598
599 var block = allowBlock ? '(?:\\/(?:12[0-8]|1[01][0-9]|[1-9]?\\d))?' : '',
600 RE_IPV6_ADD =
601 '(?:' + // starts with "::" (including "::")
602 ':(?::|(?::' + '[0-9A-Fa-f]{1,4}' + '){1,7})' +
603 '|' + // ends with "::" (except "::")
604 '[0-9A-Fa-f]{1,4}' + '(?::' + '[0-9A-Fa-f]{1,4}' + '){0,6}::' +
605 '|' + // contains no "::"
606 '[0-9A-Fa-f]{1,4}' + '(?::' + '[0-9A-Fa-f]{1,4}' + '){7}' +
607 ')';
608
609 if ( address.search( new RegExp( '^' + RE_IPV6_ADD + block + '$' ) ) !== -1 ) {
610 return true;
611 }
612
613 RE_IPV6_ADD = // contains one "::" in the middle (single '::' check below)
614 '[0-9A-Fa-f]{1,4}' + '(?:::?' + '[0-9A-Fa-f]{1,4}' + '){1,6}';
615
616 return address.search( new RegExp( '^' + RE_IPV6_ADD + block + '$' ) ) !== -1
617 && address.search( /::/ ) !== -1 && address.search( /::.*::/ ) === -1;
618 }
619 };
620
621 // Message auto-hide helpers
622 function hideMessage() {
623 $( '#mw-js-message' ).fadeOut( 'slow' );
624 }
625 function stopHideMessageTimeout() {
626 clearTimeout( hideMessageTimeout );
627 }
628 function startHideMessageTimeout() {
629 clearTimeout( hideMessageTimeout );
630 hideMessageTimeout = setTimeout( hideMessage, 5000 );
631 }
632
633 mw.util = util;
634
635 }( mediaWiki, jQuery ) );