Merge "Fix IGNORE option for sqlite update"
[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;
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/Iceweasel 2.x and later
57 } else if ( ( profile.name === 'firefox' || profile.name === 'iceweasel' )
58 && profile.versionBase > '1' ) {
59 util.tooltipAccessKeyPrefix = 'alt-shift-';
60 }
61
62 /* Fill $content var */
63 util.$content = ( function () {
64 var i, l, $content, selectors;
65 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
71 '.mw-body-primary',
72 '.mw-body',
73
74 /* Legacy fallbacks for setting the content */
75 // Vector, Monobook, Chick, etc... based skins
76 '#bodyContent',
77
78 // Modern based skins
79 '#mw_contentholder',
80
81 // Standard, CologneBlue
82 '#article',
83
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
88 '#content',
89
90 // If nothing better is found fall back to our bodytext div that is guaranteed to be here
91 '#mw-content-text',
92
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
95 'body'
96 ];
97 for ( i = 0, l = selectors.length; i < l; i++ ) {
98 $content = $( selectors[i] ).first();
99 if ( $content.length ) {
100 return $content;
101 }
102 }
103
104 // Make sure we don't unset util.$content if it was preset and we don't find anything
105 return util.$content;
106 } )();
107 },
108
109 /* Main body */
110
111 /**
112 * Encode the string like PHP's rawurlencode
113 *
114 * @param {string} str String to be encoded.
115 */
116 rawurlencode: function ( str ) {
117 str = String( 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' );
121 },
122
123 /**
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
127 *
128 * @param {string} str String to be encoded.
129 */
130 wikiUrlencode: function ( str ) {
131 return util.rawurlencode( str )
132 .replace( /%20/g, '_' ).replace( /%3A/g, ':' ).replace( /%2F/g, '/' );
133 },
134
135 /**
136 * Get the link to a page name (relative to `wgServer`),
137 *
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.
142 */
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 );
149 }
150 return url;
151 },
152
153 /**
154 * Get address to a script in the wiki root.
155 * For index.php use `mw.config.get( 'wgScript' )`.
156 *
157 * @since 1.18
158 * @param str string Name of script (eg. 'api'), defaults to 'index'
159 * @return string Address to script (eg. '/w/api.php' )
160 */
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' );
167 } else {
168 return mw.config.get( 'wgScriptPath' ) + '/' + str +
169 mw.config.get( 'wgScriptExtension' );
170 }
171 },
172
173 /**
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).
178 *
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;
183 * } );
184 *
185 * @param {string} text CSS to be appended
186 * @return {CSSStyleSheet} Use .ownerNode to get to the `<style>` element.
187 */
188 addCSS: function ( text ) {
189 var s = mw.loader.addStyleTag( text );
190 return s.sheet || s.styleSheet || s;
191 },
192
193 /**
194 * Hide/show the table of contents element
195 *
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
202 */
203 toggleToc: function ( $toggleLink, callback ) {
204 var ret, $tocList = $( '#toc ul:first' );
205
206 // This function shouldn't be called if there's no TOC,
207 // but just in case...
208 if ( !$tocList.length ) {
209 return null;
210 }
211 ret = $tocList.is( ':hidden' );
212 $toggleLink.click();
213 $tocList.promise().done( callback );
214 return ret;
215 },
216
217 /**
218 * Grab the URL parameter value for the given parameter.
219 * Returns null if not found.
220 *
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.
224 */
225 getParamValue: function ( param, url ) {
226 if ( url === undefined ) {
227 url = document.location.href;
228 }
229 // Get last match, stop at hash
230 var re = new RegExp( '^[^#]*[&?]' + $.escapeRE( param ) + '=([^&#]*)' ),
231 m = re.exec( url );
232 if ( m ) {
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' ) );
236 }
237 return null;
238 },
239
240 /**
241 * @property {string}
242 * Access key prefix. Will be re-defined based on browser/operating system
243 * detection in mw.util#init.
244 */
245 tooltipAccessKeyPrefix: 'alt-',
246
247 /**
248 * @property {RegExp}
249 * Regex to match accesskey tooltips.
250 *
251 * Should match:
252 *
253 * - "ctrl-option-"
254 * - "alt-shift-"
255 * - "ctrl-alt-"
256 * - "ctrl-"
257 *
258 * The accesskey is matched in group $6.
259 */
260 tooltipAccessKeyRegexp: /\[(ctrl-)?(option-)?(alt-)?(shift-)?(esc-)?(.)\]$/,
261
262 /**
263 * Add the appropriate prefix to the accesskey shown in the tooltip.
264 *
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.
269 *
270 * @param {Array|jQuery} [$nodes] A jQuery object, or array of nodes to update.
271 */
272 updateTooltipAccessKeys: function ( $nodes ) {
273 if ( !$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]' ) );
280 } else {
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' );
286 }
287 } else if ( !( $nodes instanceof $ ) ) {
288 $nodes = $( $nodes );
289 }
290
291 $nodes.attr( 'title', function ( i, val ) {
292 if ( val && util.tooltipAccessKeyRegexp.test( val ) ) {
293 return val.replace( util.tooltipAccessKeyRegexp,
294 '[' + util.tooltipAccessKeyPrefix + '$6]' );
295 }
296 return val;
297 } );
298 },
299
300 /*
301 * @property {jQuery}
302 * A jQuery object that refers to the content area element.
303 * Populated by #init.
304 */
305 $content: null,
306
307 /**
308 * Add a link to a portlet menu on the page, such as:
309 *
310 * p-cactions (Content actions), p-personal (Personal tools),
311 * p-navigation (Navigation), p-tb (Toolbox)
312 *
313 * The first three paramters are required, the others are optional and
314 * may be null. Though providing an id and tooltip is recommended.
315 *
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.
320 *
321 * mw.util.addPortletLink(
322 * 'p-tb', 'http://mediawiki.org/',
323 * 'MediaWiki.org', 't-mworg', 'Go to MediaWiki.org ', 'm', '#t-print'
324 * );
325 *
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
338 *
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.
341 */
342 addPortletLink: function ( portlet, href, text, id, tooltip, accesskey, nextnode ) {
343 var $item, $link, $portlet, $ul;
344
345 // Check if there's atleast 3 arguments to prevent a TypeError
346 if ( arguments.length < 3 ) {
347 return null;
348 }
349 // Setup the anchor tag
350 $link = $( '<a>' ).attr( 'href', href ).text( text );
351 if ( tooltip ) {
352 $link.attr( 'title', tooltip );
353 }
354
355 // Select the specified portlet
356 $portlet = $( '#' + portlet );
357 if ( $portlet.length === 0 ) {
358 return null;
359 }
360 // Select the first (most likely only) unordered list inside the portlet
361 $ul = $portlet.find( 'ul' ).eq( 0 );
362
363 // If it didn't have an unordered list yet, create it
364 if ( $ul.length === 0 ) {
365
366 $ul = $( '<ul>' );
367
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 );
371 } else {
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 );
375 }
376 }
377 // Just in case..
378 if ( $ul.length === 0 ) {
379 return null;
380 }
381
382 // Unhide portlet if it was hidden before
383 $portlet.removeClass( 'emptyPortlet' );
384
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();
389 } else {
390 $item = $link.wrap( '<li></li>' ).parent();
391 }
392
393 // Implement the properties passed to the function
394 if ( id ) {
395 $item.attr( 'id', id );
396 }
397
398 if ( tooltip ) {
399 // Trim any existing accesskey hint and the trailing space
400 tooltip = $.trim( tooltip.replace( util.tooltipAccessKeyRegexp, '' ) );
401 if ( accesskey ) {
402 tooltip += ' [' + accesskey + ']';
403 }
404 $link.attr( 'title', tooltip );
405 if ( accesskey ) {
406 util.updateTooltipAccessKeys( $link );
407 }
408 }
409
410 if ( accesskey ) {
411 $link.attr( 'accesskey', accesskey );
412 }
413
414 if ( nextnode ) {
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] ) ) {
420 // Fallback
421 $ul.append( $item );
422 return $item[0];
423 }
424 if ( nextnode.length === 1 ) {
425 // nextnode is a jQuery object that represents exactly one element
426 nextnode.before( $item );
427 return $item[0];
428 }
429 }
430
431 // Fallback (this is the default behavior)
432 $ul.append( $item );
433 return $item[0];
434
435 },
436
437 /**
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
441 *
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
445 */
446 jsMessage: function ( message ) {
447 if ( !arguments.length || message === '' || message === null ) {
448 return true;
449 }
450 if ( typeof message !== 'object' ) {
451 message = $.parseHTML( message );
452 }
453 mw.notify( message, { autoHide: true, tag: 'legacy' } );
454 return true;
455 },
456
457 /**
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.
461 *
462 * FIXME: should be moved to or replaced by a validation module.
463 *
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.
467 */
468 validateEmail: function ( mailtxt ) {
469 var rfc5322Atext, rfc1034LdhStr, html5EmailRegexp;
470
471 if ( mailtxt === '' ) {
472 return null;
473 }
474
475 // HTML5 defines a string as valid e-mail address if it matches
476 // the ABNF:
477 // 1 * ( atext / "." ) "@" ldh-str 1*( "." ldh-str )
478 // With:
479 // - atext : defined in RFC 5322 section 3.2.3
480 // - ldh-str : defined in RFC 1034 section 3.5
481 //
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.
487 // "&" / "'" /
488 // "*" / "+" /
489 // "-" / "/" /
490 // "=" / "?" /
491 // "^" / "_" /
492 // "`" / "{" /
493 // "|" / "}" /
494 // "~"
495 rfc5322Atext = 'a-z0-9!#$%&\'*+\\-/=?^_`{|}~';
496
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\\-';
505
506 html5EmailRegexp = new RegExp(
507 // start of string
508 '^'
509 +
510 // User part which is liberal :p
511 '[' + rfc5322Atext + '\\.]+'
512 +
513 // 'at'
514 '@'
515 +
516 // Domain first part
517 '[' + rfc1034LdhStr + ']+'
518 +
519 // Optional second part and following are separated by a dot
520 '(?:\\.[' + rfc1034LdhStr + ']+)*'
521 +
522 // End of string
523 '$',
524 // RegExp is case insensitive
525 'i'
526 );
527 return ( null !== mailtxt.match( html5EmailRegexp ) );
528 },
529
530 /**
531 * Note: borrows from IP::isIPv4
532 *
533 * @param {string} address
534 * @param {boolean} allowBlock
535 * @return {boolean}
536 */
537 isIPv4Address: function ( address, allowBlock ) {
538 if ( typeof address !== 'string' ) {
539 return false;
540 }
541
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;
545
546 return address.search( new RegExp( '^' + RE_IP_ADD + block + '$' ) ) !== -1;
547 },
548
549 /**
550 * Note: borrows from IP::isIPv6
551 *
552 * @param {string} address
553 * @param {boolean} allowBlock
554 * @return {boolean}
555 */
556 isIPv6Address: function ( address, allowBlock ) {
557 if ( typeof address !== 'string' ) {
558 return false;
559 }
560
561 var block = allowBlock ? '(?:\\/(?:12[0-8]|1[01][0-9]|[1-9]?\\d))?' : '',
562 RE_IPV6_ADD =
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}' +
569 ')';
570
571 if ( address.search( new RegExp( '^' + RE_IPV6_ADD + block + '$' ) ) !== -1 ) {
572 return true;
573 }
574
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}';
577
578 return address.search( new RegExp( '^' + RE_IPV6_ADD + block + '$' ) ) !== -1
579 && address.search( /::/ ) !== -1 && address.search( /::.*::/ ) === -1;
580 }
581 };
582
583 /**
584 * @method wikiGetlink
585 * @inheritdoc #getUrl
586 * @deprecated since 1.23 Use #getUrl instead.
587 */
588 mw.log.deprecate( util, 'wikiGetlink', util.getUrl, 'Use mw.util.getUrl instead.' );
589
590 mw.util = util;
591
592 }( mediaWiki, jQuery ) );