Localisation updates from http://translatewiki.net.

[mediawiki.git] / resources / mediawiki / mediawiki.Uri.js

/**
 * Library for simple URI parsing and manipulation.  Requires jQuery.
 *
 * Do not expect full RFC 3986 compliance. Intended to be minimal, but featureful.
 * The use cases we have in mind are constructing 'next page' or 'previous page' URLs,
 * detecting whether we need to use cross-domain proxies for an API, constructing
 * simple URL-based API calls, etc.
 *
 * Intended to compress very well if you use a JS-parsing minifier.
 *
 * Dependencies: mw, jQuery
 *
 * Example:
 *
 *     var uri = new mw.Uri( 'http://foo.com/mysite/mypage.php?quux=2' );
 *
 *     if ( uri.host == 'foo.com' ) {
 *         uri.host = 'www.foo.com';
 *         uri.extend( { bar: 1 } );
 *
 *         $( 'a#id1' ).attr( 'href', uri );
 *         // anchor with id 'id1' now links to http://foo.com/mysite/mypage.php?bar=1&quux=2
 *
 *         $( 'a#id2' ).attr( 'href', uri.clone().extend( { bar: 3, pif: 'paf' } ) );
 *         // anchor with id 'id2' now links to http://foo.com/mysite/mypage.php?bar=3&quux=2&pif=paf
 *     }
 *
 * Parsing here is regex based, so may not work on all URIs, but is good enough for most.
 *
 * Given a URI like
 * 'http://usr:pwd@www.test.com:81/dir/dir.2/index.htm?q1=0&&test1&test2=&test3=value+%28escaped%29&r=1&r=2#top':
 * The returned object will have the following properties:
 *
 *    protocol  'http'
 *    user      'usr'
 *    password  'pwd'
 *    host      'www.test.com'
 *    port      '81'
 *    path      '/dir/dir.2/index.htm'
 *    query     {
 *                  q1: 0,
 *                  test1: null,
 *                  test2: '',
 *                  test3: 'value (escaped)'
 *                  r: [1, 2]
 *              }
 *    fragment  'top'
 *
 * n.b. 'password' is not technically allowed for HTTP URIs, but it is possible with other
 * sorts of URIs.
 * You can modify the properties directly. Then use the toString() method to extract the
 * full URI string again.
 *
 * Parsing based on parseUri 1.2.2 (c) Steven Levithan <stevenlevithan.com> MIT License
 * http://stevenlevithan.com/demo/parseuri/js/
 *
 */

( function ( mw, $ ) {

        /**
         * Function that's useful when constructing the URI string -- we frequently encounter the pattern of
         * having to add something to the URI as we go, but only if it's present, and to include a character before or after if so.
         * @param {string|undefined} pre To prepend.
         * @param {string} val To include.
         * @param {string} post To append.
         * @param {boolean} raw If true, val will not be encoded.
         * @return {string} Result.
         */
        function cat( pre, val, post, raw ) {
                if ( val === undefined || val === null || val === '' ) {
                        return '';
                }
                return pre + ( raw ? val : mw.Uri.encode( val ) ) + post;
        }

        // Regular expressions to parse many common URIs.
        var parser = {
                strict: /^(?:([^:\/?#]+):)?(?:\/\/(?:(?:([^:@\/?#]*)(?::([^:@\/?#]*))?)?@)?([^:\/?#]*)(?::(\d*))?)?((?:[^?#\/]*\/)*[^?#]*)(?:\?([^#]*))?(?:#(.*))?/,
                loose:  /^(?:(?![^:@]+:[^:@\/]*@)([^:\/?#.]+):)?(?:\/\/)?(?:(?:([^:@\/?#]*)(?::([^:@\/?#]*))?)?@)?([^:\/?#]*)(?::(\d*))?((?:\/(?:[^?#](?![^?#\/]*\.[^?#\/.]+(?:[?#]|$)))*\/?)?[^?#\/]*)(?:\?([^#]*))?(?:#(.*))?/
        },

        // The order here matches the order of captured matches in the above parser regexes.
        properties = [
                'protocol',  // http
                'user',      // usr
                'password',  // pwd
                'host',      // www.test.com
                'port',      // 81
                'path',      // /dir/dir.2/index.htm
                'query',     // q1=0&&test1&test2=value (will become { q1: '0', test1: '', test2: 'value' } )
                'fragment'   // top
        ];


        /**
         * We use a factory to inject a document location, for relative URLs, including protocol-relative URLs.
         * so the library is still testable & purely functional.
         */
        mw.UriRelative = function ( documentLocation ) {
                var defaultUri;

                /**
                 * Constructs URI object. Throws error if arguments are illegal/impossible, or otherwise don't parse.
                 * @constructor
                 * @param {Object|string} uri URI string, or an Object with appropriate properties (especially another URI object to clone).
                 * Object must have non-blank 'protocol', 'host', and 'path' properties.
                 *  This parameter is optional. If omitted (or set to undefined, null or empty string), then an object will be created
                 *  for the default uri of this constructor (e.g. document.location for mw.Uri in MediaWiki core).
                 * @param {Object|boolean} Object with options, or (backwards compatibility) a boolean for strictMode
                 *  - {boolean} strictMode Trigger strict mode parsing of the url. Default: false
                 *  - {boolean} overrideKeys Wether to let duplicate query parameters override eachother (true) or automagically
                 *     convert to an array (false, default).
                 */
                function Uri( uri, options ) {
                        options = typeof options === 'object' ? options : { strictMode: !!options };
                        options = $.extend( {
                                strictMode: false,
                                overrideKeys: false
                        }, options );

                        if ( uri !== undefined && uri !== null && uri !== '' ) {
                                if ( typeof uri === 'string' ) {
                                        this.parse( uri, options );
                                } else if ( typeof uri === 'object' ) {
                                        // Copy data over from existing URI object
                                        for ( var prop in uri ) {
                                                // Only copy direct properties, not inherited ones
                                                if ( uri.hasOwnProperty( prop ) ) {
                                                        // Deep copy object properties
                                                        if ( $.isArray( uri[prop] ) || $.isPlainObject( uri[prop] ) ) {
                                                                this[prop] = $.extend( true, {}, uri[prop] );
                                                        } else {
                                                                this[prop] = uri[prop];
                                                        }
                                                }
                                        }
                                        if ( !this.query ) {
                                                this.query = {};
                                        }
                                }
                        } else {
                                // If we didn't get a URI in the constructor, use the default one.
                                return defaultUri.clone();
                        }

                        // protocol-relative URLs
                        if ( !this.protocol ) {
                                this.protocol = defaultUri.protocol;
                        }
                        // No host given:
                        if ( !this.host ) {
                                this.host = defaultUri.host;
                                // port ?
                                if ( !this.port ) {
                                        this.port = defaultUri.port;
                                }
                        }
                        if ( this.path && this.path.charAt( 0 ) !== '/' ) {
                                // A real relative URL, relative to defaultUri.path. We can't really handle that since we cannot
                                // figure out whether the last path component of defaultUri.path is a directory or a file.
                                throw new Error( 'Bad constructor arguments' );
                        }
                        if ( !( this.protocol && this.host && this.path ) ) {
                                throw new Error( 'Bad constructor arguments' );
                        }
                }

                /**
                 * Standard encodeURIComponent, with extra stuff to make all browsers work similarly and more compliant with RFC 3986
                 * Similar to rawurlencode from PHP and our JS library mw.util.rawurlencode, but we also replace space with a +
                 * @param {string} s String to encode.
                 * @return {string} Encoded string for URI.
                 */
                Uri.encode = function ( s ) {
                        return encodeURIComponent( s )
                                .replace( /!/g, '%21').replace( /'/g, '%27').replace( /\(/g, '%28')
                                .replace( /\)/g, '%29').replace( /\*/g, '%2A')
                                .replace( /%20/g, '+' );
                };

                /**
                 * Standard decodeURIComponent, with '+' to space.
                 * @param {string} s String encoded for URI.
                 * @return {string} Decoded string.
                 */
                Uri.decode = function ( s ) {
                        return decodeURIComponent( s.replace( /\+/g, '%20' ) );
                };

                Uri.prototype = {

                        /**
                         * Parse a string and set our properties accordingly.
                         * @param {string} str URI
                         * @param {Object} options
                         * @return {boolean} Success.
                         */
                        parse: function ( str, options ) {
                                var q,
                                        uri = this,
                                        matches = parser[ options.strictMode ? 'strict' : 'loose' ].exec( str );
                                $.each( properties, function ( i, property ) {
                                        uri[ property ] = matches[ i + 1 ];
                                } );

                                // uri.query starts out as the query string; we will parse it into key-val pairs then make
                                // that object the "query" property.
                                // we overwrite query in uri way to make cloning easier, it can use the same list of properties.
                                q = {};
                                // using replace to iterate over a string
                                if ( uri.query ) {
                                        uri.query.replace( /(?:^|&)([^&=]*)(?:(=)([^&]*))?/g, function ( $0, $1, $2, $3 ) {
                                                var k, v;
                                                if ( $1 ) {
                                                        k = Uri.decode( $1 );
                                                        v = ( $2 === '' || $2 === undefined ) ? null : Uri.decode( $3 );

                                                        // If overrideKeys, always (re)set top level value.
                                                        // If not overrideKeys but this key wasn't set before, then we set it as well.
                                                        if ( options.overrideKeys || q[ k ] === undefined ) {
                                                                q[ k ] = v;

                                                        // Use arrays if overrideKeys is false and key was already seen before
                                                        } else {
                                                                // Once before, still a string, turn into an array
                                                                if ( typeof q[ k ] === 'string' ) {
                                                                        q[ k ] = [ q[ k ] ];
                                                                }
                                                                // Add to the array
                                                                if ( $.isArray( q[ k ] ) ) {
                                                                        q[ k ].push( v );
                                                                }
                                                        }
                                                }
                                        } );
                                }
                                this.query = q;
                        },

                        /**
                         * Returns user and password portion of a URI.
                         * @return {string}
                         */
                        getUserInfo: function () {
                                return cat( '', this.user, cat( ':', this.password, '' ) );
                        },

                        /**
                         * Gets host and port portion of a URI.
                         * @return {string}
                         */
                        getHostPort: function () {
                                return this.host + cat( ':', this.port, '' );
                        },

                        /**
                         * Returns the userInfo and host and port portion of the URI.
                         * In most real-world URLs, this is simply the hostname, but it is more general.
                         * @return {string}
                         */
                        getAuthority: function () {
                                return cat( '', this.getUserInfo(), '@' ) + this.getHostPort();
                        },

                        /**
                         * Returns the query arguments of the URL, encoded into a string
                         * Does not preserve the order of arguments passed into the URI. Does handle escaping.
                         * @return {string}
                         */
                        getQueryString: function () {
                                var args = [];
                                $.each( this.query, function ( key, val ) {
                                        var k = Uri.encode( key ),
                                                vals = $.isArray( val ) ? val : [ val ];
                                        $.each( vals, function ( i, v ) {
                                                if ( v === null ) {
                                                        args.push( k );
                                                } else if ( k === 'title' ) {
                                                        args.push( k + '=' + mw.util.wikiUrlencode( v ) );
                                                } else {
                                                        args.push( k + '=' + Uri.encode( v ) );
                                                }
                                        } );
                                } );
                                return args.join( '&' );
                        },

                        /**
                         * Returns everything after the authority section of the URI
                         * @return {string}
                         */
                        getRelativePath: function () {
                                return this.path + cat( '?', this.getQueryString(), '', true ) + cat( '#', this.fragment, '' );
                        },

                        /**
                         * Gets the entire URI string. May not be precisely the same as input due to order of query arguments.
                         * @return {string} The URI string.
                         */
                        toString: function () {
                                return this.protocol + '://' + this.getAuthority() + this.getRelativePath();
                        },

                        /**
                         * Clone this URI
                         * @return {Object} new URI object with same properties
                         */
                        clone: function () {
                                return new Uri( this );
                        },

                        /**
                         * Extend the query -- supply query parameters to override or add to ours
                         * @param {Object} query parameters in key-val form to override or add
                         * @return {Object} this URI object
                         */
                        extend: function ( parameters ) {
                                $.extend( this.query, parameters );
                                return this;
                        }
                };

                defaultUri = new Uri( documentLocation );

                return Uri;
        };

        // if we are running in a browser, inject the current document location, for relative URLs
        if ( document && document.location && document.location.href ) {
                mw.Uri = mw.UriRelative( document.location.href );
        }

}( mediaWiki, jQuery ) );