resources/mediawiki/mediawiki.Uri.js

   1 /**
   2  * Library for simple URI parsing and manipulation.  Requires jQuery.
   3  *
   4  * Do not expect full RFC 3986 compliance. Intended to be minimal, but featureful.
   5  * The use cases we have in mind are constructing 'next page' or 'previous page' URLs,
   6  * detecting whether we need to use cross-domain proxies for an API, constructing
   7  * simple URL-based API calls, etc.
   8  *
   9  * Intended to compress very well if you use a JS-parsing minifier.
  10  *
  11  * Dependencies: mw, jQuery
  12  *
  13  * Example:
  14  *
  15  *     var uri = new mw.Uri( 'http://foo.com/mysite/mypage.php?quux=2' );
  16  *
  17  *     if ( uri.host == 'foo.com' ) {
  18  *         uri.host = 'www.foo.com';
  19  *         uri.extend( { bar: 1 } );
  20  *
  21  *         $( 'a#id1' ).attr( 'href', uri );
  22  *         // anchor with id 'id1' now links to http://foo.com/mysite/mypage.php?bar=1&quux=2
  23  *
  24  *         $( 'a#id2' ).attr( 'href', uri.clone().extend( { bar: 3, pif: 'paf' } ) );
  25  *         // anchor with id 'id2' now links to http://foo.com/mysite/mypage.php?bar=3&quux=2&pif=paf
  26  *     }
  27  *
  28  * Parsing here is regex based, so may not work on all URIs, but is good enough for most.
  29  *
  30  * Given a URI like
  31  * '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':
  32  * The returned object will have the following properties:
  33  *
  34  *    protocol  'http'
  35  *    user      'usr'
  36  *    password  'pwd'
  37  *    host      'www.test.com'
  38  *    port      '81'
  39  *    path      '/dir/dir.2/index.htm'
  40  *    query     {
  41  *                  q1: 0,
  42  *                  test1: null,
  43  *                  test2: '',
  44  *                  test3: 'value (escaped)'
  45  *                  r: [1, 2]
  46  *              }
  47  *    fragment  'top'
  48  *
  49  * n.b. 'password' is not technically allowed for HTTP URIs, but it is possible with other
  50  * sorts of URIs.
  51  * You can modify the properties directly. Then use the toString() method to extract the
  52  * full URI string again.
  53  *
  54  * Parsing based on parseUri 1.2.2 (c) Steven Levithan <stevenlevithan.com> MIT License
  55  * http://stevenlevithan.com/demo/parseuri/js/
  56  *
  57  */
  58
  59 ( function ( mw, $ ) {
  60
  61         /**
  62          * Function that's useful when constructing the URI string -- we frequently encounter the pattern of
  63          * 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.
  64          * @param {String} to prepend, if value not empty
  65          * @param {String} value to include, if not empty
  66          * @param {String} to append, if value not empty
  67          * @param {Boolean} raw -- if true, do not URI encode
  68          * @return {String}
  69          */
  70         function cat( pre, val, post, raw ) {
  71                 if ( val === undefined || val === null || val === '' ) {
  72                         return '';
  73                 }
  74                 return pre + ( raw ? val : mw.Uri.encode( val ) ) + post;
  75         }
  76
  77         // Regular expressions to parse many common URIs.
  78         var parser = {
  79                 strict: /^(?:([^:\/?#]+):)?(?:\/\/(?:(?:([^:@]*)(?::([^:@]*))?)?@)?([^:\/?#]*)(?::(\d*))?)?((?:[^?#\/]*\/)*[^?#]*)(?:\?([^#]*))?(?:#(.*))?/,
  80                 loose:  /^(?:(?![^:@]+:[^:@\/]*@)([^:\/?#.]+):)?(?:\/\/)?(?:(?:([^:@]*)(?::([^:@]*))?)?@)?([^:\/?#]*)(?::(\d*))?((?:\/(?:[^?#](?![^?#\/]*\.[^?#\/.]+(?:[?#]|$)))*\/?)?[^?#\/]*)(?:\?([^#]*))?(?:#(.*))?/
  81         },
  82
  83         // The order here matches the order of captured matches in the above parser regexes.
  84         properties = [
  85                 'protocol',  // http
  86                 'user',      // usr
  87                 'password',  // pwd
  88                 'host',      // www.test.com
  89                 'port',      // 81
  90                 'path',      // /dir/dir.2/index.htm
  91                 'query',     // q1=0&&test1&test2=value (will become { q1: '0', test1: '', test2: 'value' } )
  92                 'fragment'   // top
  93         ];
  94
  95
  96         /**
  97          * We use a factory to inject a document location, for relative URLs, including protocol-relative URLs.
  98          * so the library is still testable & purely functional.
  99          */
 100         mw.UriRelative = function ( documentLocation ) {
 101                 var defaultUri;
 102
 103                 /**
 104                  * Constructs URI object. Throws error if arguments are illegal/impossible, or otherwise don't parse.
 105                  * @constructor
 106                  * @param {Object|String} URI string, or an Object with appropriate properties (especially another URI object to clone).
 107                  * Object must have non-blank 'protocol', 'host', and 'path' properties.
 108                  * @param {Object|Boolean} Object with options, or (backwards compatibility) a boolean for strictMode
 109                  * - strictMode {Boolean} Trigger strict mode parsing of the url. Default: false
 110                  * - overrideKeys {Boolean} Wether to let duplicate query parameters override eachother (true) or automagically
 111                  *   convert to an array (false, default).
 112                  */
 113                 function Uri( uri, options ) {
 114                         options = typeof options === 'object' ? options : { strictMode: !!options };
 115                         options = $.extend( {
 116                                 strictMode: false,
 117                                 overrideKeys: false
 118                         }, options );
 119
 120                         if ( uri !== undefined && uri !== null || uri !== '' ) {
 121                                 if ( typeof uri === 'string' ) {
 122                                         this.parse( uri, options );
 123                                 } else if ( typeof uri === 'object' ) {
 124                                         // Copy data over from existing URI object
 125                                         for ( var prop in uri ) {
 126                                                 // Only copy direct properties, not inherited ones
 127                                                 if ( uri.hasOwnProperty( prop ) ) {
 128                                                         // Deep copy object properties
 129                                                         if ( $.isArray( uri[prop] ) || $.isPlainObject( uri[prop] ) ) {
 130                                                                 this[prop] = $.extend( true, {}, uri[prop] );
 131                                                         } else {
 132                                                                 this[prop] = uri[prop];
 133                                                         }
 134                                                 }
 135                                         }
 136                                         if ( !this.query ) {
 137                                                 this.query = {};
 138                                         }
 139                                 }
 140                         }
 141
 142                         // protocol-relative URLs
 143                         if ( !this.protocol ) {
 144                                 this.protocol = defaultUri.protocol;
 145                         }
 146                         // No host given:
 147                         if ( !this.host ) {
 148                                 this.host = defaultUri.host;
 149                                 // port ?
 150                                 if ( !this.port ) {
 151                                         this.port = defaultUri.port;
 152                                 }
 153                         }
 154                         if ( this.path && this.path.charAt( 0 ) !== '/' ) {
 155                                 // A real relative URL, relative to defaultUri.path. We can't really handle that since we cannot
 156                                 // figure out whether the last path compoennt of defaultUri.path is a directory or a file.
 157                                 throw new Error( 'Bad constructor arguments' );
 158                         }
 159                         if ( !( this.protocol && this.host && this.path ) ) {
 160                                 throw new Error( 'Bad constructor arguments' );
 161                         }
 162                 }
 163
 164                 /**
 165                  * Standard encodeURIComponent, with extra stuff to make all browsers work similarly and more compliant with RFC 3986
 166                  * Similar to rawurlencode from PHP and our JS library mw.util.rawurlencode, but we also replace space with a +
 167                  * @param {String} string
 168                  * @return {String} encoded for URI
 169                  */
 170                 Uri.encode = function ( s ) {
 171                         return encodeURIComponent( s )
 172                                 .replace( /!/g, '%21').replace( /'/g, '%27').replace( /\(/g, '%28')
 173                                 .replace( /\)/g, '%29').replace( /\*/g, '%2A')
 174                                 .replace( /%20/g, '+' );
 175                 };
 176
 177                 /**
 178                  * Standard decodeURIComponent, with '+' to space
 179                  * @param {String} string encoded for URI
 180                  * @return {String} decoded string
 181                  */
 182                 Uri.decode = function ( s ) {
 183                         return decodeURIComponent( s.replace( /\+/g, '%20' ) );
 184                 };
 185
 186                 Uri.prototype = {
 187
 188                         /**
 189                          * Parse a string and set our properties accordingly.
 190                          * @param {String} URI
 191                          * @param {Object} options
 192                          * @return {Boolean} success
 193                          */
 194                         parse: function ( str, options ) {
 195                                 var q,
 196                                         uri = this,
 197                                         matches = parser[ options.strictMode ? 'strict' : 'loose' ].exec( str );
 198                                 $.each( properties, function ( i, property ) {
 199                                         uri[ property ] = matches[ i+1 ];
 200                                 } );
 201
 202                                 // uri.query starts out as the query string; we will parse it into key-val pairs then make
 203                                 // that object the "query" property.
 204                                 // we overwrite query in uri way to make cloning easier, it can use the same list of properties.
 205                                 q = {};
 206                                 // using replace to iterate over a string
 207                                 if ( uri.query ) {
 208                                         uri.query.replace( /(?:^|&)([^&=]*)(?:(=)([^&]*))?/g, function ($0, $1, $2, $3) {
 209                                                 var k, v;
 210                                                 if ( $1 ) {
 211                                                         k = Uri.decode( $1 );
 212                                                         v = ( $2 === '' || $2 === undefined ) ? null : Uri.decode( $3 );
 213
 214                                                         // If overrideKeys, always (re)set top level value.
 215                                                         // If not overrideKeys but this key wasn't set before, then we set it as well.
 216                                                         if ( options.overrideKeys || q[ k ] === undefined ) {
 217                                                                 q[ k ] = v;
 218
 219                                                         // Use arrays if overrideKeys is false and key was already seen before
 220                                                         } else {
 221                                                                 // Once before, still a string, turn into an array
 222                                                                 if ( typeof q[ k ] === 'string' ) {
 223                                                                         q[ k ] = [ q[ k ] ];
 224                                                                 }
 225                                                                 // Add to the array
 226                                                                 if ( $.isArray( q[ k ] ) ) {
 227                                                                         q[ k ].push( v );
 228                                                                 }
 229                                                         }
 230                                                 }
 231                                         } );
 232                                 }
 233                                 this.query = q;
 234                         },
 235
 236                         /**
 237                          * Returns user and password portion of a URI.
 238                          * @return {String}
 239                          */
 240                         getUserInfo: function () {
 241                                 return cat( '', this.user, cat( ':', this.password, '' ) );
 242                         },
 243
 244                         /**
 245                          * Gets host and port portion of a URI.
 246                          * @return {String}
 247                          */
 248                         getHostPort: function () {
 249                                 return this.host + cat( ':', this.port, '' );
 250                         },
 251
 252                         /**
 253                          * Returns the userInfo and host and port portion of the URI.
 254                          * In most real-world URLs, this is simply the hostname, but it is more general.
 255                          * @return {String}
 256                          */
 257                         getAuthority: function () {
 258                                 return cat( '', this.getUserInfo(), '@' ) + this.getHostPort();
 259                         },
 260
 261                         /**
 262                          * Returns the query arguments of the URL, encoded into a string
 263                          * Does not preserve the order of arguments passed into the URI. Does handle escaping.
 264                          * @return {String}
 265                          */
 266                         getQueryString: function () {
 267                                 var args = [];
 268                                 $.each( this.query, function ( key, val ) {
 269                                         var k = Uri.encode( key ),
 270                                                 vals = val === null ? [ null ] : $.makeArray( val );
 271                                         $.each( vals, function ( i, v ) {
 272                                                 args.push( k + ( v === null ? '' : '=' + Uri.encode( v ) ) );
 273                                         } );
 274                                 } );
 275                                 return args.join( '&' );
 276                         },
 277
 278                         /**
 279                          * Returns everything after the authority section of the URI
 280                          * @return {String}
 281                          */
 282                         getRelativePath: function () {
 283                                 return this.path + cat( '?', this.getQueryString(), '', true ) + cat( '#', this.fragment, '' );
 284                         },
 285
 286                         /**
 287                          * Gets the entire URI string. May not be precisely the same as input due to order of query arguments.
 288                          * @return {String} the URI string
 289                          */
 290                         toString: function () {
 291                                 return this.protocol + '://' + this.getAuthority() + this.getRelativePath();
 292                         },
 293
 294                         /**
 295                          * Clone this URI
 296                          * @return {Object} new URI object with same properties
 297                          */
 298                         clone: function () {
 299                                 return new Uri( this );
 300                         },
 301
 302                         /**
 303                          * Extend the query -- supply query parameters to override or add to ours
 304                          * @param {Object} query parameters in key-val form to override or add
 305                          * @return {Object} this URI object
 306                          */
 307                         extend: function ( parameters ) {
 308                                 $.extend( this.query, parameters );
 309                                 return this;
 310                         }
 311                 };
 312
 313                 defaultUri = new Uri( documentLocation );
 314
 315                 return Uri;
 316         };
 317
 318         // if we are running in a browser, inject the current document location, for relative URLs
 319         if ( document && document.location && document.location.href ) {
 320                 mw.Uri = mw.UriRelative( document.location.href );
 321         }
 322
 323 }( mediaWiki, jQuery ) );