/**
- * Utilities
+ * Implements mediaWiki.util library
*/
( function ( $, mw ) {
-"use strict";
+ "use strict";
// Local cache and alias
- var util = mw.util = {
+ var util = {
/**
* Initialisation
* (don't call before document ready)
*/
- 'init' : function() {
- var profile = $.client.profile(),
- $tocContainer = $( '#toc' ),
- $tocTitle = $( '#toctitle' ),
- $tocToggleLink = $( '#togglelink' ),
- hideTocCookie;
+ init: function () {
+ var profile, $tocTitle, $tocToggleLink, hideTocCookie;
/* Set up $.messageBox */
$.messageBoxNew( {
- 'id': 'mw-js-message',
- 'parent': '#content'
+ id: 'mw-js-message',
+ parent: '#content'
} );
/* Set tooltipAccessKeyPrefix */
+ profile = $.client.profile();
// Opera on any platform
if ( profile.name === 'opera' ) {
// Chrome on any platform
} else if ( profile.name === 'chrome' ) {
- // Chrome on Mac or Chrome on other platform ?
- util.tooltipAccessKeyPrefix = ( profile.platform === 'mac'
- ? 'ctrl-option-' : 'alt-' );
+
+ util.tooltipAccessKeyPrefix = (
+ profile.platform === 'mac'
+ // Chrome on Mac
+ ? 'ctrl-option-'
+ : profile.platform === 'win'
+ // Chrome on Windows
+ // (both alt- and alt-shift work, but alt-f triggers Chrome wrench menu
+ // which alt-shift-f does not)
+ ? 'alt-shift-'
+ // Chrome on other (Ubuntu?)
+ : 'alt-'
+ );
// Non-Windows Safari with webkit_version > 526
} else if ( profile.platform !== 'win'
}
// Table of contents toggle
+ $tocTitle = $( '#toctitle' );
+ $tocToggleLink = $( '#togglelink' );
// Only add it if there is a TOC and there is no toggle added already
- if ( $tocContainer.length && $tocTitle.length && !$tocToggleLink.length ) {
+ if ( $( '#toc' ).length && $tocTitle.length && !$tocToggleLink.length ) {
hideTocCookie = $.cookie( 'mw_hidetoc' );
$tocToggleLink = $( '<a href="#" class="internal" id="togglelink"></a>' )
.text( mw.msg( 'hidetoc' ) )
- .click( function(e){
+ .click( function ( e ) {
e.preventDefault();
util.toggleToc( $(this) );
- } );
+ } );
$tocTitle.append(
$tocToggleLink
.wrap( '<span class="toctoggle"></span>' )
.append( '] ' )
);
- if ( hideTocCookie == '1' ) {
- // Cookie says user want toc hidden
- $tocToggleLink.click();
+ if ( hideTocCookie === '1' ) {
+ util.toggleToc( $tocToggleLink );
}
}
},
*
* @param str string String to be encoded
*/
- 'rawurlencode' : function( str ) {
- str = ( str + '' ).toString();
+ rawurlencode: function ( str ) {
+ str = String( str );
return encodeURIComponent( str )
.replace( /!/g, '%21' ).replace( /'/g, '%27' ).replace( /\(/g, '%28' )
.replace( /\)/g, '%29' ).replace( /\*/g, '%2A' ).replace( /~/g, '%7E' );
*
* @param str string String to be encoded
*/
- 'wikiUrlencode' : function( str ) {
- return this.rawurlencode( str )
+ wikiUrlencode: function ( str ) {
+ return util.rawurlencode( str )
.replace( /%20/g, '_' ).replace( /%3A/g, ':' ).replace( /%2F/g, '/' );
},
/**
* Get the link to a page name (relative to wgServer)
*
- * @param str string Page name to get the link for.
- * @return string Location for a page with name of 'str' or boolean false on error.
+ * @param str String: Page name to get the link for.
+ * @return String: Location for a page with name of 'str' or boolean false on error.
*/
- 'wikiGetlink' : function( str ) {
+ wikiGetlink: function ( str ) {
return mw.config.get( 'wgArticlePath' ).replace( '$1',
- this.wikiUrlencode( str || mw.config.get( 'wgPageName' ) ) );
+ util.wikiUrlencode( typeof str === 'string' ? str : mw.config.get( 'wgPageName' ) ) );
},
/**
* Get address to a script in the wiki root.
* For index.php use mw.config.get( 'wgScript' )
*
+ * @since 1.18
* @param str string Name of script (eg. 'api'), defaults to 'index'
* @return string Address to script (eg. '/w/api.php' )
*/
- 'wikiScript' : function( str ) {
+ wikiScript: function ( str ) {
return mw.config.get( 'wgScriptPath' ) + '/' + ( str || 'index' ) +
mw.config.get( 'wgScriptExtension' );
},
/**
- * Append a new style block to the head
+ * Append a new style block to the head and return the CSSStyleSheet object.
+ * Use .ownerNode to access the <style> element, or use mw.loader.addStyleTag.
+ * This function returns the styleSheet object for convience (due to cross-browsers
+ * difference as to where it is located).
+ * @example
+ * <code>
+ * var sheet = mw.util.addCSS('.foobar { display: none; }');
+ * $(foo).click(function () {
+ * // Toggle the sheet on and off
+ * sheet.disabled = !sheet.disabled;
+ * });
+ * </code>
*
* @param text string CSS to be appended
- * @return CSSStyleSheet
+ * @return CSSStyleSheet (use .ownerNode to get to the <style> element)
*/
- 'addCSS' : function( text ) {
- var s = document.createElement( 'style' );
- s.type = 'text/css';
- s.rel = 'stylesheet';
- if ( s.styleSheet ) {
- s.styleSheet.cssText = text; // IE
- } else {
- // Safari sometimes borks on null
- s.appendChild( document.createTextNode( text + '' ) );
- }
- document.getElementsByTagName('head')[0].appendChild( s );
+ addCSS: function ( text ) {
+ var s = mw.loader.addStyleTag( text );
return s.sheet || s;
},
* @return mixed Boolean visibility of the toc (true if it's visible)
* or Null if there was no table of contents.
*/
- 'toggleToc' : function( $toggleLink, callback ) {
+ toggleToc: function ( $toggleLink, callback ) {
var $tocList = $( '#toc ul:first' );
// This function shouldn't be called if there's no TOC,
* @param url string URL to search through (optional)
* @return mixed Parameter value or null.
*/
- 'getParamValue' : function( param, url ) {
+ getParamValue: function ( param, url ) {
url = url || document.location.href;
// Get last match, stop at hash
var re = new RegExp( '^[^#]*[&?]' + $.escapeRE( param ) + '=([^&#]*)' ),
m = re.exec( url );
- if ( m && m.length > 1 ) {
+ if ( m ) {
// Beware that decodeURIComponent is not required to understand '+'
// by spec, as encodeURIComponent does not produce it.
return decodeURIComponent( m[1].replace( /\+/g, '%20' ) );
* Access key prefix. Will be re-defined based on browser/operating system
* detection in mw.util.init().
*/
- 'tooltipAccessKeyPrefix' : 'alt-',
+ tooltipAccessKeyPrefix: 'alt-',
/**
* @var RegExp
* Regex to match accesskey tooltips.
*/
- 'tooltipAccessKeyRegexp': /\[(ctrl-)?(alt-)?(shift-)?(esc-)?(.)\]$/,
+ tooltipAccessKeyRegexp: /\[(ctrl-)?(alt-)?(shift-)?(esc-)?(.)\]$/,
/**
* Add the appropriate prefix to the accesskey shown in the tooltip.
* otherwise, all the nodes that will probably have accesskeys by
* default are updated.
*
- * @param nodeList {Array|jQuery} [optional] A jQuery object, or array
+ * @param $nodes {Array|jQuery} [optional] A jQuery object, or array
* of elements to update.
*/
- 'updateTooltipAccessKeys' : function( nodeList ) {
- var $nodes;
- if ( !nodeList ) {
-
- // Rather than scanning all links, just the elements that
- // contain the relevant links
- this.updateTooltipAccessKeys(
- $( '#column-one a, #mw-head a, #mw-panel a, #p-logo a' ) );
-
- // these are rare enough that no such optimization is needed
- this.updateTooltipAccessKeys( $( 'input' ) );
- this.updateTooltipAccessKeys( $( 'label' ) );
-
- return;
-
- } else if ( nodeList instanceof $ ) {
- $nodes = nodeList;
- } else {
- $nodes = $( nodeList );
+ updateTooltipAccessKeys: function ( $nodes ) {
+ if ( !$nodes ) {
+ // Rather than going into a loop of all anchor tags, limit to few elements that
+ // contain the relevant anchor tags.
+ // Input and label are rare enough that no such optimization is needed
+ $nodes = $( '#column-one a, #mw-head a, #mw-panel a, #p-logo a, input, label' );
+ } else if ( !( $nodes instanceof $ ) ) {
+ $nodes = $( $nodes );
}
- $nodes.each( function ( i ) {
- var tip = $(this).attr( 'title' );
- if ( !!tip && util.tooltipAccessKeyRegexp.exec( tip ) ) {
- tip = tip.replace( util.tooltipAccessKeyRegexp,
- '[' + util.tooltipAccessKeyPrefix + "$5]" );
- $(this).attr( 'title', tip );
+ $nodes.attr( 'title', function ( i, val ) {
+ if ( val && util.tooltipAccessKeyRegexp.exec( val ) ) {
+ return val.replace( util.tooltipAccessKeyRegexp,
+ '[' + util.tooltipAccessKeyPrefix + '$5]' );
}
+ return val;
} );
},
* A jQuery object that refers to the page-content element
* Populated by init().
*/
- '$content' : null,
+ $content: null,
/**
* Add a link to a portlet menu on the page, such as:
* @return mixed The DOM Node of the added item (a ListItem or Anchor element,
* depending on the skin) or null if no element was added to the document.
*/
- 'addPortletLink' : function( portlet, href, text, id, tooltip, accesskey, nextnode ) {
+ addPortletLink: function ( portlet, href, text, id, tooltip, accesskey, nextnode ) {
var $item, $link, $portlet, $ul;
// Check if there's atleast 3 arguments to prevent a TypeError
// Some skins don't have any portlets
// just add it to the bottom of their 'sidebar' element as a fallback
switch ( mw.config.get( 'skin' ) ) {
- case 'standard' :
- case 'cologneblue' :
+ case 'standard':
+ case 'cologneblue':
$( '#quickbar' ).append( $link.after( '<br/>' ) );
return $link[0];
- case 'nostalgia' :
- $( '#searchform' ).before( $link).before( ' | ' );
+ case 'nostalgia':
+ $( '#searchform' ).before( $link ).before( ' | ' );
return $link[0];
- default : // Skins like chick, modern, monobook, myskin, simple, vector...
+ default: // Skins like chick, modern, monobook, myskin, simple, vector...
// Select the specified portlet
$portlet = $( '#' + portlet );
$link.attr( 'title', tooltip );
}
if ( accesskey && tooltip ) {
- this.updateTooltipAccessKeys( $link );
+ util.updateTooltipAccessKeys( $link );
}
// Where to put our node ?
} else if ( typeof nextnode === 'string' && $ul.find( nextnode ).length !== 0 ) {
$ul.find( nextnode ).eq( 0 ).before( $item );
-
// If the jQuery selector isn't found within the <ul>,
// or if nextnode was invalid or not passed at all,
// then just append it at the end of the <ul> (this is the default behaviour)
* something, replacing any previous message.
* Calling with no arguments, with an empty string or null will hide the message
*
- * @param message mixed The DOM-element or HTML-string to be put inside the message box.
- * @param className string Used in adding a class; should be different for each call
+ * @param message {mixed} The DOM-element, jQuery object or HTML-string to be put inside the message box.
+ * @param className {String} Used in adding a class; should be different for each call
* to allow CSS/JS to hide different boxes. null = no class used.
- * @return boolean True on success, false on failure.
+ * @return {Boolean} True on success, false on failure.
*/
- 'jsMessage' : function( message, className ) {
-
+ jsMessage: function ( message, className ) {
if ( !arguments.length || message === '' || message === null ) {
-
$( '#mw-js-message' ).empty().hide();
return true; // Emptying and hiding message is intended behaviour, return true
if ( typeof message === 'object' ) {
$messageDiv.empty();
- $messageDiv.append( message ); // Append new content
+ $messageDiv.append( message );
} else {
$messageDiv.html( message );
}
* @return mixed Null if mailtxt was an empty string, otherwise true/false
* is determined by validation.
*/
- 'validateEmail' : function( mailtxt ) {
- if( mailtxt === '' ) {
+ validateEmail: function ( mailtxt ) {
+ var rfc5322_atext, rfc1034_ldh_str, HTML5_email_regexp;
+
+ if ( mailtxt === '' ) {
return null;
}
*/
/**
- * First, define the RFC 5322 'atext' which is pretty easy :
+ * First, define the RFC 5322 'atext' which is pretty easy:
* atext = ALPHA / DIGIT / ; Printable US-ASCII
"!" / "#" / ; characters not including
"$" / "%" / ; specials. Used for atoms.
"|" / "}" /
"~"
*/
- var rfc5322_atext = "a-z0-9!#$%&'*+\\-/=?^_`{|}~",
+ rfc5322_atext = "a-z0-9!#$%&'*+\\-/=?^_`{|}~";
/**
* Next define the RFC 1034 'ldh-str'
* <let-dig-hyp> ::= <let-dig> | "-"
* <let-dig> ::= <letter> | <digit>
*/
- rfc1034_ldh_str = "a-z0-9\\-",
-
- HTML5_email_regexp = new RegExp(
- // start of string
- '^'
- +
- // User part which is liberal :p
- '[' + rfc5322_atext + '\\.]+'
- +
- // 'at'
- '@'
- +
- // Domain first part
- '[' + rfc1034_ldh_str + ']+'
- +
- // Optional second part and following are separated by a dot
- '(?:\\.[' + rfc1034_ldh_str + ']+)*'
- +
- // End of string
- '$',
- // RegExp is case insensitive
- 'i'
- );
+ rfc1034_ldh_str = "a-z0-9\\-";
+
+ HTML5_email_regexp = new RegExp(
+ // start of string
+ '^'
+ +
+ // User part which is liberal :p
+ '[' + rfc5322_atext + '\\.]+'
+ +
+ // 'at'
+ '@'
+ +
+ // Domain first part
+ '[' + rfc1034_ldh_str + ']+'
+ +
+ // Optional second part and following are separated by a dot
+ '(?:\\.[' + rfc1034_ldh_str + ']+)*'
+ +
+ // End of string
+ '$',
+ // RegExp is case insensitive
+ 'i'
+ );
return (null !== mailtxt.match( HTML5_email_regexp ) );
},
* @param allowBlock boolean
* @return boolean
*/
- 'isIPv4Address' : function( address, allowBlock ) {
+ isIPv4Address: function ( address, allowBlock ) {
if ( typeof address !== 'string' ) {
return false;
}
* @param allowBlock boolean
* @return boolean
*/
- 'isIPv6Address' : function( address, allowBlock ) {
+ isIPv6Address: function ( address, allowBlock ) {
if ( typeof address !== 'string' ) {
return false;
}
return address.search( new RegExp( '^' + RE_IPV6_ADD + block + '$' ) ) !== -1
&& address.search( /::/ ) !== -1 && address.search( /::.*::/ ) === -1;
}
-
};
+ mw.util = util;
+
} )( jQuery, mediaWiki );
dépôts / lhc / web / wiklou.git / blobdiff