resources/src/mediawiki/mediawiki.Title.js

   1 /*!
   2  * @author Neil Kandalgaonkar, 2010
   3  * @author Timo Tijhof, 2011-2013
   4  * @since 1.18
   5  */
   6 ( function ( mw, $ ) {
   7         /*jshint latedef:false */
   8
   9         /**
  10          * @class mw.Title
  11          *
  12          * Parse titles into an object structure. Note that when using the constructor
  13          * directly, passing invalid titles will result in an exception. Use #newFromText to use the
  14          * logic directly and get null for invalid titles which is easier to work with.
  15          *
  16          * @constructor
  17          * @param {string} title Title of the page. If no second argument given,
  18          *  this will be searched for a namespace
  19          * @param {number} [namespace=NS_MAIN] If given, will used as default namespace for the given title
  20          * @throws {Error} When the title is invalid
  21          */
  22         function Title( title, namespace ) {
  23                 var parsed = parse( title, namespace );
  24                 if ( !parsed ) {
  25                         throw new Error( 'Unable to parse title' );
  26                 }
  27
  28                 this.namespace = parsed.namespace;
  29                 this.title = parsed.title;
  30                 this.ext = parsed.ext;
  31                 this.fragment = parsed.fragment;
  32
  33                 return this;
  34         }
  35
  36         /* Private members */
  37
  38         var
  39
  40         /**
  41          * @private
  42          * @static
  43          * @property NS_MAIN
  44          */
  45         NS_MAIN = 0,
  46
  47         /**
  48          * @private
  49          * @static
  50          * @property NS_TALK
  51          */
  52         NS_TALK = 1,
  53
  54         /**
  55          * @private
  56          * @static
  57          * @property NS_SPECIAL
  58          */
  59         NS_SPECIAL = -1,
  60
  61         /**
  62          * @private
  63          * @static
  64          * @property NS_MEDIA
  65          */
  66         NS_MEDIA = -2,
  67
  68         /**
  69          * @private
  70          * @static
  71          * @property NS_FILE
  72          */
  73         NS_FILE = 6,
  74
  75         /**
  76          * @private
  77          * @static
  78          * @property FILENAME_MAX_BYTES
  79          */
  80         FILENAME_MAX_BYTES = 240,
  81
  82         /**
  83          * @private
  84          * @static
  85          * @property TITLE_MAX_BYTES
  86          */
  87         TITLE_MAX_BYTES = 255,
  88
  89         /**
  90          * Get the namespace id from a namespace name (either from the localized, canonical or alias
  91          * name).
  92          *
  93          * Example: On a German wiki this would return 6 for any of 'File', 'Datei', 'Image' or
  94          * even 'Bild'.
  95          *
  96          * @private
  97          * @static
  98          * @method getNsIdByName
  99          * @param {string} ns Namespace name (case insensitive, leading/trailing space ignored)
 100          * @return {number|boolean} Namespace id or boolean false
 101          */
 102         getNsIdByName = function ( ns ) {
 103                 var id;
 104
 105                 // Don't cast non-strings to strings, because null or undefined should not result in
 106                 // returning the id of a potential namespace called "Null:" (e.g. on null.example.org/wiki)
 107                 // Also, toLowerCase throws exception on null/undefined, because it is a String method.
 108                 if ( typeof ns !== 'string' ) {
 109                         return false;
 110                 }
 111                 ns = ns.toLowerCase();
 112                 id = mw.config.get( 'wgNamespaceIds' )[ ns ];
 113                 if ( id === undefined ) {
 114                         return false;
 115                 }
 116                 return id;
 117         },
 118
 119         rUnderscoreTrim = /^_+|_+$/g,
 120
 121         rSplit = /^(.+?)_*:_*(.*)$/,
 122
 123         // See MediaWikiTitleCodec.php#getTitleInvalidRegex
 124         rInvalid = new RegExp(
 125                 '[^' + mw.config.get( 'wgLegalTitleChars' ) + ']' +
 126                 // URL percent encoding sequences interfere with the ability
 127                 // to round-trip titles -- you can't link to them consistently.
 128                 '|%[0-9A-Fa-f]{2}' +
 129                 // XML/HTML character references produce similar issues.
 130                 '|&[A-Za-z0-9\u0080-\uFFFF]+;' +
 131                 '|&#[0-9]+;' +
 132                 '|&#x[0-9A-Fa-f]+;'
 133         ),
 134
 135         // From MediaWikiTitleCodec.php#L225 @26fcab1f18c568a41
 136         // "Clean up whitespace" in function MediaWikiTitleCodec::splitTitleString()
 137         rWhitespace = /[ _\u0009\u00A0\u1680\u180E\u2000-\u200A\u2028\u2029\u202F\u205F\u3000\s]+/g,
 138
 139         /**
 140          * Slightly modified from Flinfo. Credit goes to Lupo and Flominator.
 141          * @private
 142          * @static
 143          * @property sanitationRules
 144          */
 145         sanitationRules = [
 146                 // "signature"
 147                 {
 148                         pattern: /~{3}/g,
 149                         replace: '',
 150                         generalRule: true
 151                 },
 152                 // Space, underscore, tab, NBSP and other unusual spaces
 153                 {
 154                         pattern: rWhitespace,
 155                         replace: ' ',
 156                         generalRule: true
 157                 },
 158                 // unicode bidi override characters: Implicit, Embeds, Overrides
 159                 {
 160                         pattern: /[\u200E\u200F\u202A-\u202E]/g,
 161                         replace: '',
 162                         generalRule: true
 163                 },
 164                 // control characters
 165                 {
 166                         pattern: /[\x00-\x1f\x7f]/g,
 167                         replace: '',
 168                         generalRule: true
 169                 },
 170                 // URL encoding (possibly)
 171                 {
 172                         pattern: /%([0-9A-Fa-f]{2})/g,
 173                         replace: '% $1',
 174                         generalRule: true
 175                 },
 176                 // HTML-character-entities
 177                 {
 178                         pattern: /&(([A-Za-z0-9\x80-\xff]+|#[0-9]+|#x[0-9A-Fa-f]+);)/g,
 179                         replace: '& $1',
 180                         generalRule: true
 181                 },
 182                 // slash, colon (not supported by file systems like NTFS/Windows, Mac OS 9 [:], ext4 [/])
 183                 {
 184                         pattern: /[:\/#]/g,
 185                         replace: '-',
 186                         fileRule: true
 187                 },
 188                 // brackets, greater than
 189                 {
 190                         pattern: /[\]\}>]/g,
 191                         replace: ')',
 192                         generalRule: true
 193                 },
 194                 // brackets, lower than
 195                 {
 196                         pattern: /[\[\{<]/g,
 197                         replace: '(',
 198                         generalRule: true
 199                 },
 200                 // everything that wasn't covered yet
 201                 {
 202                         pattern: new RegExp( rInvalid.source, 'g' ),
 203                         replace: '-',
 204                         generalRule: true
 205                 },
 206                 // directory structures
 207                 {
 208                         pattern: /^(\.|\.\.|\.\/.*|\.\.\/.*|.*\/\.\/.*|.*\/\.\.\/.*|.*\/\.|.*\/\.\.)$/g,
 209                         replace: '',
 210                         generalRule: true
 211                 }
 212         ],
 213
 214         /**
 215          * Internal helper for #constructor and #newFromtext.
 216          *
 217          * Based on Title.php#secureAndSplit
 218          *
 219          * @private
 220          * @static
 221          * @method parse
 222          * @param {string} title
 223          * @param {number} [defaultNamespace=NS_MAIN]
 224          * @return {Object|boolean}
 225          */
 226         parse = function ( title, defaultNamespace ) {
 227                 var namespace, m, id, i, fragment, ext;
 228
 229                 namespace = defaultNamespace === undefined ? NS_MAIN : defaultNamespace;
 230
 231                 title = title
 232                         // Normalise whitespace to underscores and remove duplicates
 233                         .replace( /[ _\s]+/g, '_' )
 234                         // Trim underscores
 235                         .replace( rUnderscoreTrim, '' );
 236
 237                 // Process initial colon
 238                 if ( title !== '' && title[ 0 ] === ':' ) {
 239                         // Initial colon means main namespace instead of specified default
 240                         namespace = NS_MAIN;
 241                         title = title
 242                                 // Strip colon
 243                                 .slice( 1 )
 244                                 // Trim underscores
 245                                 .replace( rUnderscoreTrim, '' );
 246                 }
 247
 248                 if ( title === '' ) {
 249                         return false;
 250                 }
 251
 252                 // Process namespace prefix (if any)
 253                 m = title.match( rSplit );
 254                 if ( m ) {
 255                         id = getNsIdByName( m[ 1 ] );
 256                         if ( id !== false ) {
 257                                 // Ordinary namespace
 258                                 namespace = id;
 259                                 title = m[ 2 ];
 260
 261                                 // For Talk:X pages, make sure X has no "namespace" prefix
 262                                 if ( namespace === NS_TALK && ( m = title.match( rSplit ) ) ) {
 263                                         // Disallow titles like Talk:File:x (subject should roundtrip: talk:file:x -> file:x -> file_talk:x)
 264                                         if ( getNsIdByName( m[ 1 ] ) !== false ) {
 265                                                 return false;
 266                                         }
 267                                 }
 268                         }
 269                 }
 270
 271                 // Process fragment
 272                 i = title.indexOf( '#' );
 273                 if ( i === -1 ) {
 274                         fragment = null;
 275                 } else {
 276                         fragment = title
 277                                 // Get segment starting after the hash
 278                                 .slice( i + 1 )
 279                                 // Convert to text
 280                                 // NB: Must not be trimmed ("Example#_foo" is not the same as "Example#foo")
 281                                 .replace( /_/g, ' ' );
 282
 283                         title = title
 284                                 // Strip hash
 285                                 .slice( 0, i )
 286                                 // Trim underscores, again (strips "_" from "bar" in "Foo_bar_#quux")
 287                                 .replace( rUnderscoreTrim, '' );
 288                 }
 289
 290                 // Reject illegal characters
 291                 if ( title.match( rInvalid ) ) {
 292                         return false;
 293                 }
 294
 295                 // Disallow titles that browsers or servers might resolve as directory navigation
 296                 if (
 297                         title.indexOf( '.' ) !== -1 && (
 298                                 title === '.' || title === '..' ||
 299                                 title.indexOf( './' ) === 0 ||
 300                                 title.indexOf( '../' ) === 0 ||
 301                                 title.indexOf( '/./' ) !== -1 ||
 302                                 title.indexOf( '/../' ) !== -1 ||
 303                                 title.slice( -2 ) === '/.' ||
 304                                 title.slice( -3 ) === '/..'
 305                         )
 306                 ) {
 307                         return false;
 308                 }
 309
 310                 // Disallow magic tilde sequence
 311                 if ( title.indexOf( '~~~' ) !== -1 ) {
 312                         return false;
 313                 }
 314
 315                 // Disallow titles exceeding the TITLE_MAX_BYTES byte size limit (size of underlying database field)
 316                 // Except for special pages, e.g. [[Special:Block/Long name]]
 317                 // Note: The PHP implementation also asserts that even in NS_SPECIAL, the title should
 318                 // be less than 512 bytes.
 319                 if ( namespace !== NS_SPECIAL && $.byteLength( title ) > TITLE_MAX_BYTES ) {
 320                         return false;
 321                 }
 322
 323                 // Can't make a link to a namespace alone.
 324                 if ( title === '' && namespace !== NS_MAIN ) {
 325                         return false;
 326                 }
 327
 328                 // Any remaining initial :s are illegal.
 329                 if ( title[ 0 ] === ':' ) {
 330                         return false;
 331                 }
 332
 333                 // For backwards-compatibility with old mw.Title, we separate the extension from the
 334                 // rest of the title.
 335                 i = title.lastIndexOf( '.' );
 336                 if ( i === -1 || title.length <= i + 1 ) {
 337                         // Extensions are the non-empty segment after the last dot
 338                         ext = null;
 339                 } else {
 340                         ext = title.slice( i + 1 );
 341                         title = title.slice( 0, i );
 342                 }
 343
 344                 return {
 345                         namespace: namespace,
 346                         title: title,
 347                         ext: ext,
 348                         fragment: fragment
 349                 };
 350         },
 351
 352         /**
 353          * Convert db-key to readable text.
 354          *
 355          * @private
 356          * @static
 357          * @method text
 358          * @param {string} s
 359          * @return {string}
 360          */
 361         text = function ( s ) {
 362                 if ( s !== null && s !== undefined ) {
 363                         return s.replace( /_/g, ' ' );
 364                 } else {
 365                         return '';
 366                 }
 367         },
 368
 369         /**
 370          * Sanitizes a string based on a rule set and a filter
 371          *
 372          * @private
 373          * @static
 374          * @method sanitize
 375          * @param {string} s
 376          * @param {Array} filter
 377          * @return {string}
 378          */
 379         sanitize = function ( s, filter ) {
 380                 var i, ruleLength, rule, m, filterLength,
 381                         rules = sanitationRules;
 382
 383                 for ( i = 0, ruleLength = rules.length; i < ruleLength; ++i ) {
 384                         rule = rules[ i ];
 385                         for ( m = 0, filterLength = filter.length; m < filterLength; ++m ) {
 386                                 if ( rule[ filter[ m ] ] ) {
 387                                         s = s.replace( rule.pattern, rule.replace );
 388                                 }
 389                         }
 390                 }
 391                 return s;
 392         },
 393
 394         /**
 395          * Cuts a string to a specific byte length, assuming UTF-8
 396          * or less, if the last character is a multi-byte one
 397          *
 398          * @private
 399          * @static
 400          * @method trimToByteLength
 401          * @param {string} s
 402          * @param {number} length
 403          * @return {string}
 404          */
 405         trimToByteLength = function ( s, length ) {
 406                 var byteLength, chopOffChars, chopOffBytes;
 407
 408                 // bytelength is always greater or equal to the length in characters
 409                 s = s.substr( 0, length );
 410                 while ( ( byteLength = $.byteLength( s ) ) > length ) {
 411                         // Calculate how many characters can be safely removed
 412                         // First, we need to know how many bytes the string exceeds the threshold
 413                         chopOffBytes = byteLength - length;
 414                         // A character in UTF-8 is at most 4 bytes
 415                         // One character must be removed in any case because the
 416                         // string is too long
 417                         chopOffChars = Math.max( 1, Math.floor( chopOffBytes / 4 ) );
 418                         s = s.substr( 0, s.length - chopOffChars );
 419                 }
 420                 return s;
 421         },
 422
 423         /**
 424          * Cuts a file name to a specific byte length
 425          *
 426          * @private
 427          * @static
 428          * @method trimFileNameToByteLength
 429          * @param {string} name without extension
 430          * @param {string} extension file extension
 431          * @return {string} The full name, including extension
 432          */
 433         trimFileNameToByteLength = function ( name, extension ) {
 434                 // There is a special byte limit for file names and ... remember the dot
 435                 return trimToByteLength( name, FILENAME_MAX_BYTES - extension.length - 1 ) + '.' + extension;
 436         },
 437
 438         // Polyfill for ES5 Object.create
 439         createObject = Object.create || ( function () {
 440                 return function ( o ) {
 441                         function Title() {}
 442                         if ( o !== Object( o ) ) {
 443                                 throw new Error( 'Cannot inherit from a non-object' );
 444                         }
 445                         Title.prototype = o;
 446                         return new Title();
 447                 };
 448         }() );
 449
 450         /* Static members */
 451
 452         /**
 453          * Constructor for Title objects with a null return instead of an exception for invalid titles.
 454          *
 455          * @static
 456          * @param {string} title
 457          * @param {number} [namespace=NS_MAIN] Default namespace
 458          * @return {mw.Title|null} A valid Title object or null if the title is invalid
 459          */
 460         Title.newFromText = function ( title, namespace ) {
 461                 var t, parsed = parse( title, namespace );
 462                 if ( !parsed ) {
 463                         return null;
 464                 }
 465
 466                 t = createObject( Title.prototype );
 467                 t.namespace = parsed.namespace;
 468                 t.title = parsed.title;
 469                 t.ext = parsed.ext;
 470                 t.fragment = parsed.fragment;
 471
 472                 return t;
 473         };
 474
 475         /**
 476          * Constructor for Title objects from user input altering that input to
 477          * produce a title that MediaWiki will accept as legal
 478          *
 479          * @static
 480          * @param {string} title
 481          * @param {number} [defaultNamespace=NS_MAIN]
 482          *  If given, will used as default namespace for the given title.
 483          * @param {Object} [options] additional options
 484          * @param {boolean} [options.forUploading=true]
 485          *  Makes sure that a file is uploadable under the title returned.
 486          *  There are pages in the file namespace under which file upload is impossible.
 487          *  Automatically assumed if the title is created in the Media namespace.
 488          * @return {mw.Title|null} A valid Title object or null if the input cannot be turned into a valid title
 489          */
 490         Title.newFromUserInput = function ( title, defaultNamespace, options ) {
 491                 var namespace, m, id, ext, parts;
 492
 493                 // defaultNamespace is optional; check whether options moves up
 494                 if ( arguments.length < 3 && $.type( defaultNamespace ) === 'object' ) {
 495                         options = defaultNamespace;
 496                         defaultNamespace = undefined;
 497                 }
 498
 499                 // merge options into defaults
 500                 options = $.extend( {
 501                         forUploading: true
 502                 }, options );
 503
 504                 namespace = defaultNamespace === undefined ? NS_MAIN : defaultNamespace;
 505
 506                 // Normalise whitespace and remove duplicates
 507                 title = $.trim( title.replace( rWhitespace, ' ' ) );
 508
 509                 // Process initial colon
 510                 if ( title !== '' && title[ 0 ] === ':' ) {
 511                         // Initial colon means main namespace instead of specified default
 512                         namespace = NS_MAIN;
 513                         title = title
 514                                 // Strip colon
 515                                 .substr( 1 )
 516                                 // Trim underscores
 517                                 .replace( rUnderscoreTrim, '' );
 518                 }
 519
 520                 // Process namespace prefix (if any)
 521                 m = title.match( rSplit );
 522                 if ( m ) {
 523                         id = getNsIdByName( m[ 1 ] );
 524                         if ( id !== false ) {
 525                                 // Ordinary namespace
 526                                 namespace = id;
 527                                 title = m[ 2 ];
 528                         }
 529                 }
 530
 531                 if ( namespace === NS_MEDIA
 532                         || ( options.forUploading && ( namespace === NS_FILE ) )
 533                 ) {
 534
 535                         title = sanitize( title, [ 'generalRule', 'fileRule' ] );
 536
 537                         // Operate on the file extension
 538                         // Although it is possible having spaces between the name and the ".ext" this isn't nice for
 539                         // operating systems hiding file extensions -> strip them later on
 540                         parts = title.split( '.' );
 541
 542                         if ( parts.length > 1 ) {
 543
 544                                 // Get the last part, which is supposed to be the file extension
 545                                 ext = parts.pop();
 546
 547                                 // Remove whitespace of the name part (that W/O extension)
 548                                 title = $.trim( parts.join( '.' ) );
 549
 550                                 // Cut, if too long and append file extension
 551                                 title = trimFileNameToByteLength( title, ext );
 552
 553                         } else {
 554
 555                                 // Missing file extension
 556                                 title = $.trim( parts.join( '.' ) );
 557
 558                                 // Name has no file extension and a fallback wasn't provided either
 559                                 return null;
 560                         }
 561                 } else {
 562
 563                         title = sanitize( title, [ 'generalRule' ] );
 564
 565                         // Cut titles exceeding the TITLE_MAX_BYTES byte size limit
 566                         // (size of underlying database field)
 567                         if ( namespace !== NS_SPECIAL ) {
 568                                 title = trimToByteLength( title, TITLE_MAX_BYTES );
 569                         }
 570                 }
 571
 572                 // Any remaining initial :s are illegal.
 573                 title = title.replace( /^\:+/, '' );
 574
 575                 return Title.newFromText( title, namespace );
 576         };
 577
 578         /**
 579          * Sanitizes a file name as supplied by the user, originating in the user's file system
 580          * so it is most likely a valid MediaWiki title and file name after processing.
 581          * Returns null on fatal errors.
 582          *
 583          * @static
 584          * @param {string} uncleanName The unclean file name including file extension but
 585          *   without namespace
 586          * @return {mw.Title|null} A valid Title object or null if the title is invalid
 587          */
 588         Title.newFromFileName = function ( uncleanName ) {
 589
 590                 return Title.newFromUserInput( 'File:' + uncleanName, {
 591                         forUploading: true
 592                 } );
 593         };
 594
 595         /**
 596          * Get the file title from an image element
 597          *
 598          *     var title = mw.Title.newFromImg( $( 'img:first' ) );
 599          *
 600          * @static
 601          * @param {HTMLElement|jQuery} img The image to use as a base
 602          * @return {mw.Title|null} The file title or null if unsuccessful
 603          */
 604         Title.newFromImg = function ( img ) {
 605                 var matches, i, regex, src, decodedSrc,
 606
 607                         // thumb.php-generated thumbnails
 608                         thumbPhpRegex = /thumb\.php/,
 609                         regexes = [
 610                                 // Thumbnails
 611                                 /\/[a-f0-9]\/[a-f0-9]{2}\/([^\s\/]+)\/[^\s\/]+-[^\s\/]*$/,
 612
 613                                 // Thumbnails in non-hashed upload directories
 614                                 /\/([^\s\/]+)\/[^\s\/]+-(?:\1|thumbnail)[^\s\/]*$/,
 615
 616                                 // Full size images
 617                                 /\/[a-f0-9]\/[a-f0-9]{2}\/([^\s\/]+)$/,
 618
 619                                 // Full-size images in non-hashed upload directories
 620                                 /\/([^\s\/]+)$/
 621                         ],
 622
 623                         recount = regexes.length;
 624
 625                 src = img.jquery ? img[ 0 ].src : img.src;
 626
 627                 matches = src.match( thumbPhpRegex );
 628
 629                 if ( matches ) {
 630                         return mw.Title.newFromText( 'File:' + mw.util.getParamValue( 'f', src ) );
 631                 }
 632
 633                 decodedSrc = decodeURIComponent( src );
 634
 635                 for ( i = 0; i < recount; i++ ) {
 636                         regex = regexes[ i ];
 637                         matches = decodedSrc.match( regex );
 638
 639                         if ( matches && matches[ 1 ] ) {
 640                                 return mw.Title.newFromText( 'File:' + matches[ 1 ] );
 641                         }
 642                 }
 643
 644                 return null;
 645         };
 646
 647         /**
 648          * Whether this title exists on the wiki.
 649          *
 650          * @static
 651          * @param {string|mw.Title} title prefixed db-key name (string) or instance of Title
 652          * @return {boolean|null} Boolean if the information is available, otherwise null
 653          */
 654         Title.exists = function ( title ) {
 655                 var match,
 656                         type = $.type( title ),
 657                         obj = Title.exist.pages;
 658
 659                 if ( type === 'string' ) {
 660                         match = obj[ title ];
 661                 } else if ( type === 'object' && title instanceof Title ) {
 662                         match = obj[ title.toString() ];
 663                 } else {
 664                         throw new Error( 'mw.Title.exists: title must be a string or an instance of Title' );
 665                 }
 666
 667                 if ( typeof match === 'boolean' ) {
 668                         return match;
 669                 }
 670
 671                 return null;
 672         };
 673
 674         /**
 675          * Store page existence
 676          *
 677          * @static
 678          * @property {Object} exist
 679          * @property {Object} exist.pages Keyed by title. Boolean true value indicates page does exist.
 680          *
 681          * @property {Function} exist.set The setter function.
 682          *
 683          *  Example to declare existing titles:
 684          *
 685          *     Title.exist.set( ['User:John_Doe', ...] );
 686          *
 687          *  Example to declare titles nonexistent:
 688          *
 689          *     Title.exist.set( ['File:Foo_bar.jpg', ...], false );
 690          *
 691          * @property {string|Array} exist.set.titles Title(s) in strict prefixedDb title form
 692          * @property {boolean} [exist.set.state=true] State of the given titles
 693          * @return {boolean}
 694          */
 695         Title.exist = {
 696                 pages: {},
 697
 698                 set: function ( titles, state ) {
 699                         titles = $.isArray( titles ) ? titles : [ titles ];
 700                         state = state === undefined ? true : !!state;
 701                         var i,
 702                                 pages = this.pages,
 703                                 len = titles.length;
 704
 705                         for ( i = 0; i < len; i++ ) {
 706                                 pages[ titles[ i ] ] = state;
 707                         }
 708                         return true;
 709                 }
 710         };
 711
 712         /**
 713          * Normalize a file extension to the common form, making it lowercase and checking some synonyms,
 714          * and ensure it's clean. Extensions with non-alphanumeric characters will be discarded.
 715          * Keep in sync with File::normalizeExtension() in PHP.
 716          *
 717          * @param {string} extension File extension (without the leading dot)
 718          * @return {string} File extension in canonical form
 719          */
 720         Title.normalizeExtension = function ( extension ) {
 721                 var
 722                         lower = extension.toLowerCase(),
 723                         squish = {
 724                                 htm: 'html',
 725                                 jpeg: 'jpg',
 726                                 mpeg: 'mpg',
 727                                 tiff: 'tif',
 728                                 ogv: 'ogg'
 729                         };
 730                 if ( squish.hasOwnProperty( lower ) ) {
 731                         return squish[ lower ];
 732                 } else if ( /^[0-9a-z]+$/.test( lower ) ) {
 733                         return lower;
 734                 } else {
 735                         return '';
 736                 }
 737         };
 738
 739         /* Public members */
 740
 741         Title.prototype = {
 742                 constructor: Title,
 743
 744                 /**
 745                  * Get the namespace number
 746                  *
 747                  * Example: 6 for "File:Example_image.svg".
 748                  *
 749                  * @return {number}
 750                  */
 751                 getNamespaceId: function () {
 752                         return this.namespace;
 753                 },
 754
 755                 /**
 756                  * Get the namespace prefix (in the content language)
 757                  *
 758                  * Example: "File:" for "File:Example_image.svg".
 759                  * In #NS_MAIN this is '', otherwise namespace name plus ':'
 760                  *
 761                  * @return {string}
 762                  */
 763                 getNamespacePrefix: function () {
 764                         return this.namespace === NS_MAIN ?
 765                                 '' :
 766                                 ( mw.config.get( 'wgFormattedNamespaces' )[ this.namespace ].replace( / /g, '_' ) + ':' );
 767                 },
 768
 769                 /**
 770                  * Get the page name without extension or namespace prefix
 771                  *
 772                  * Example: "Example_image" for "File:Example_image.svg".
 773                  *
 774                  * For the page title (full page name without namespace prefix), see #getMain.
 775                  *
 776                  * @return {string}
 777                  */
 778                 getName: function () {
 779                         if (
 780                                 $.inArray( this.namespace, mw.config.get( 'wgCaseSensitiveNamespaces' ) ) !== -1 ||
 781                                 !this.title.length
 782                         ) {
 783                                 return this.title;
 784                         }
 785                         return this.title[ 0 ].toUpperCase() + this.title.slice( 1 );
 786                 },
 787
 788                 /**
 789                  * Get the page name (transformed by #text)
 790                  *
 791                  * Example: "Example image" for "File:Example_image.svg".
 792                  *
 793                  * For the page title (full page name without namespace prefix), see #getMainText.
 794                  *
 795                  * @return {string}
 796                  */
 797                 getNameText: function () {
 798                         return text( this.getName() );
 799                 },
 800
 801                 /**
 802                  * Get the extension of the page name (if any)
 803                  *
 804                  * @return {string|null} Name extension or null if there is none
 805                  */
 806                 getExtension: function () {
 807                         return this.ext;
 808                 },
 809
 810                 /**
 811                  * Shortcut for appendable string to form the main page name.
 812                  *
 813                  * Returns a string like ".json", or "" if no extension.
 814                  *
 815                  * @return {string}
 816                  */
 817                 getDotExtension: function () {
 818                         return this.ext === null ? '' : '.' + this.ext;
 819                 },
 820
 821                 /**
 822                  * Get the main page name
 823                  *
 824                  * Example: "Example_image.svg" for "File:Example_image.svg".
 825                  *
 826                  * @return {string}
 827                  */
 828                 getMain: function () {
 829                         return this.getName() + this.getDotExtension();
 830                 },
 831
 832                 /**
 833                  * Get the main page name (transformed by #text)
 834                  *
 835                  * Example: "Example image.svg" for "File:Example_image.svg".
 836                  *
 837                  * @return {string}
 838                  */
 839                 getMainText: function () {
 840                         return text( this.getMain() );
 841                 },
 842
 843                 /**
 844                  * Get the full page name
 845                  *
 846                  * Example: "File:Example_image.svg".
 847                  * Most useful for API calls, anything that must identify the "title".
 848                  *
 849                  * @return {string}
 850                  */
 851                 getPrefixedDb: function () {
 852                         return this.getNamespacePrefix() + this.getMain();
 853                 },
 854
 855                 /**
 856                  * Get the full page name (transformed by #text)
 857                  *
 858                  * Example: "File:Example image.svg" for "File:Example_image.svg".
 859                  *
 860                  * @return {string}
 861                  */
 862                 getPrefixedText: function () {
 863                         return text( this.getPrefixedDb() );
 864                 },
 865
 866                 /**
 867                  * Get the page name relative to a namespace
 868                  *
 869                  * Example:
 870                  *
 871                  * - "Foo:Bar" relative to the Foo namespace becomes "Bar".
 872                  * - "Bar" relative to any non-main namespace becomes ":Bar".
 873                  * - "Foo:Bar" relative to any namespace other than Foo stays "Foo:Bar".
 874                  *
 875                  * @param {number} namespace The namespace to be relative to
 876                  * @return {string}
 877                  */
 878                 getRelativeText: function ( namespace ) {
 879                         if ( this.getNamespaceId() === namespace ) {
 880                                 return this.getMainText();
 881                         } else if ( this.getNamespaceId() === NS_MAIN ) {
 882                                 return ':' + this.getPrefixedText();
 883                         } else {
 884                                 return this.getPrefixedText();
 885                         }
 886                 },
 887
 888                 /**
 889                  * Get the fragment (if any).
 890                  *
 891                  * Note that this method (by design) does not include the hash character and
 892                  * the value is not url encoded.
 893                  *
 894                  * @return {string|null}
 895                  */
 896                 getFragment: function () {
 897                         return this.fragment;
 898                 },
 899
 900                 /**
 901                  * Get the URL to this title
 902                  *
 903                  * @see mw.util#getUrl
 904                  * @param {Object} [params] A mapping of query parameter names to values,
 905                  *     e.g. `{ action: 'edit' }`.
 906                  * @return {string}
 907                  */
 908                 getUrl: function ( params ) {
 909                         var fragment = this.getFragment();
 910                         if ( fragment ) {
 911                                 return mw.util.getUrl( this.toString() + '#' + this.getFragment(), params );
 912                         } else {
 913                                 return mw.util.getUrl( this.toString(), params );
 914                         }
 915                 },
 916
 917                 /**
 918                  * Whether this title exists on the wiki.
 919                  *
 920                  * @see #static-method-exists
 921                  * @return {boolean|null} Boolean if the information is available, otherwise null
 922                  */
 923                 exists: function () {
 924                         return Title.exists( this );
 925                 }
 926         };
 927
 928         /**
 929          * @alias #getPrefixedDb
 930          * @method
 931          */
 932         Title.prototype.toString = Title.prototype.getPrefixedDb;
 933
 934         /**
 935          * @alias #getPrefixedText
 936          * @method
 937          */
 938         Title.prototype.toText = Title.prototype.getPrefixedText;
 939
 940         // Expose
 941         mw.Title = Title;
 942
 943 }( mediaWiki, jQuery ) );