resources/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
   8         /**
   9          * @class mw.Title
  10          *
  11          * Parse titles into an object struture. Note that when using the constructor
  12          * directly, passing invalid titles will result in an exception. Use #newFromText to use the
  13          * logic directly and get null for invalid titles which is easier to work with.
  14          *
  15          * @constructor
  16          * @param {string} title Title of the page. If no second argument given,
  17          *  this will be searched for a namespace
  18          * @param {number} [namespace=NS_MAIN] If given, will used as default namespace for the given title
  19          * @throws {Error} When the title is invalid
  20          */
  21         function Title( title, namespace ) {
  22                 var parsed = parse( title, namespace );
  23                 if ( !parsed ) {
  24                         throw new Error( 'Unable to parse title' );
  25                 }
  26
  27                 this.namespace = parsed.namespace;
  28                 this.title = parsed.title;
  29                 this.ext = parsed.ext;
  30                 this.fragment = parsed.fragment;
  31
  32                 return this;
  33         }
  34
  35         /* Private members */
  36
  37         var
  38
  39         /**
  40          * @private
  41          * @static
  42          * @property NS_MAIN
  43          */
  44         NS_MAIN = 0,
  45
  46         /**
  47          * @private
  48          * @static
  49          * @property NS_TALK
  50          */
  51         NS_TALK = 1,
  52
  53         /**
  54          * @private
  55          * @static
  56          * @property NS_SPECIAL
  57          */
  58         NS_SPECIAL = -1,
  59
  60         /**
  61          * Get the namespace id from a namespace name (either from the localized, canonical or alias
  62          * name).
  63          *
  64          * Example: On a German wiki this would return 6 for any of 'File', 'Datei', 'Image' or
  65          * even 'Bild'.
  66          *
  67          * @private
  68          * @static
  69          * @method getNsIdByName
  70          * @param {string} ns Namespace name (case insensitive, leading/trailing space ignored)
  71          * @return {number|boolean} Namespace id or boolean false
  72          */
  73         getNsIdByName = function ( ns ) {
  74                 var id;
  75
  76                 // Don't cast non-strings to strings, because null or undefined should not result in
  77                 // returning the id of a potential namespace called "Null:" (e.g. on null.example.org/wiki)
  78                 // Also, toLowerCase throws exception on null/undefined, because it is a String method.
  79                 if ( typeof ns !== 'string' ) {
  80                         return false;
  81                 }
  82                 ns = ns.toLowerCase();
  83                 id = mw.config.get( 'wgNamespaceIds' )[ns];
  84                 if ( id === undefined ) {
  85                         return false;
  86                 }
  87                 return id;
  88         },
  89
  90         rUnderscoreTrim = /^_+|_+$/g,
  91
  92         rSplit = /^(.+?)_*:_*(.*)$/,
  93
  94         // See Title.php#getTitleInvalidRegex
  95         rInvalid = new RegExp(
  96                 '[^' + mw.config.get( 'wgLegalTitleChars' ) + ']' +
  97                 // URL percent encoding sequences interfere with the ability
  98                 // to round-trip titles -- you can't link to them consistently.
  99                 '|%[0-9A-Fa-f]{2}' +
 100                 // XML/HTML character references produce similar issues.
 101                 '|&[A-Za-z0-9\u0080-\uFFFF]+;' +
 102                 '|&#[0-9]+;' +
 103                 '|&#x[0-9A-Fa-f]+;'
 104         ),
 105
 106         /**
 107          * Internal helper for #constructor and #newFromtext.
 108          *
 109          * Based on Title.php#secureAndSplit
 110          *
 111          * @private
 112          * @static
 113          * @method parse
 114          * @param {string} title
 115          * @param {number} [defaultNamespace=NS_MAIN]
 116          * @return {Object|boolean}
 117          */
 118         parse = function ( title, defaultNamespace ) {
 119                 var namespace, m, id, i, fragment, ext;
 120
 121                 namespace = defaultNamespace === undefined ? NS_MAIN : defaultNamespace;
 122
 123                 title = title
 124                         // Normalise whitespace to underscores and remove duplicates
 125                         .replace( /[ _\s]+/g, '_' )
 126                         // Trim underscores
 127                         .replace( rUnderscoreTrim, '' );
 128
 129                 if ( title === '' ) {
 130                         return false;
 131                 }
 132
 133                 // Process initial colon
 134                 if ( title.charAt( 0 ) === ':' ) {
 135                         // Initial colon means main namespace instead of specified default
 136                         namespace = NS_MAIN;
 137                         title = title
 138                                 // Strip colon
 139                                 .substr( 1 )
 140                                 // Trim underscores
 141                                 .replace( rUnderscoreTrim, '' );
 142                 }
 143
 144                 // Process namespace prefix (if any)
 145                 m = title.match( rSplit );
 146                 if ( m ) {
 147                         id = getNsIdByName( m[1] );
 148                         if ( id !== false ) {
 149                                 // Ordinary namespace
 150                                 namespace = id;
 151                                 title = m[2];
 152
 153                                 // For Talk:X pages, make sure X has no "namespace" prefix
 154                                 if ( namespace === NS_TALK && ( m = title.match( rSplit ) ) ) {
 155                                         // Disallow titles like Talk:File:x (subject should roundtrip: talk:file:x -> file:x -> file_talk:x)
 156                                         if ( getNsIdByName( m[1] ) !== false ) {
 157                                                 return false;
 158                                         }
 159                                 }
 160                         }
 161                 }
 162
 163                 // Process fragment
 164                 i = title.indexOf( '#' );
 165                 if ( i === -1 ) {
 166                         fragment = null;
 167                 } else {
 168                         fragment = title
 169                                 // Get segment starting after the hash
 170                                 .substr( i + 1 )
 171                                 // Convert to text
 172                                 // NB: Must not be trimmed ("Example#_foo" is not the same as "Example#foo")
 173                                 .replace( /_/g, ' ' );
 174
 175                         title = title
 176                                 // Strip hash
 177                                 .substr( 0, i )
 178                                 // Trim underscores, again (strips "_" from "bar" in "Foo_bar_#quux")
 179                                 .replace( rUnderscoreTrim, '' );
 180                 }
 181
 182
 183                 // Reject illegal characters
 184                 if ( title.match( rInvalid ) ) {
 185                         return false;
 186                 }
 187
 188                 // Disallow titles that browsers or servers might resolve as directory navigation
 189                 if (
 190                         title.indexOf( '.' ) !== -1 && (
 191                                 title === '.' || title === '..' ||
 192                                 title.indexOf( './' ) === 0 ||
 193                                 title.indexOf( '../' ) === 0 ||
 194                                 title.indexOf( '/./' ) !== -1 ||
 195                                 title.indexOf( '/../' ) !== -1 ||
 196                                 title.substr( -2 ) === '/.' ||
 197                                 title.substr( -3 ) === '/..'
 198                         )
 199                 ) {
 200                         return false;
 201                 }
 202
 203                 // Disallow magic tilde sequence
 204                 if ( title.indexOf( '~~~' ) !== -1 ) {
 205                         return false;
 206                 }
 207
 208                 // Disallow titles exceeding the 255 byte size limit (size of underlying database field)
 209                 // Except for special pages, e.g. [[Special:Block/Long name]]
 210                 // Note: The PHP implementation also asserts that even in NS_SPECIAL, the title should
 211                 // be less than 512 bytes.
 212                 if ( namespace !== NS_SPECIAL && $.byteLength( title ) > 255 ) {
 213                         return false;
 214                 }
 215
 216                 // Can't make a link to a namespace alone.
 217                 if ( title === '' && namespace !== NS_MAIN ) {
 218                         return false;
 219                 }
 220
 221                 // Any remaining initial :s are illegal.
 222                 if ( title.charAt( 0 ) === ':' ) {
 223                         return false;
 224                 }
 225
 226                 // For backwards-compatibility with old mw.Title, we separate the extension from the
 227                 // rest of the title.
 228                 i = title.lastIndexOf( '.' );
 229                 if ( i === -1 || title.length <= i + 1 ) {
 230                         // Extensions are the non-empty segment after the last dot
 231                         ext = null;
 232                 } else {
 233                         ext = title.substr( i + 1 );
 234                         title = title.substr( 0, i );
 235                 }
 236
 237                 return {
 238                         namespace: namespace,
 239                         title: title,
 240                         ext: ext,
 241                         fragment: fragment
 242                 };
 243         },
 244
 245         /**
 246          * Convert db-key to readable text.
 247          *
 248          * @private
 249          * @static
 250          * @method text
 251          * @param {string} s
 252          * @return {string}
 253          */
 254         text = function ( s ) {
 255                 if ( s !== null && s !== undefined ) {
 256                         return s.replace( /_/g, ' ' );
 257                 } else {
 258                         return '';
 259                 }
 260         },
 261
 262         // Polyfill for ES5 Object.create
 263         createObject = Object.create || ( function () {
 264                 return function ( o ) {
 265                         function Title() {}
 266                         if ( o !== Object( o ) ) {
 267                                 throw new Error( 'Cannot inherit from a non-object' );
 268                         }
 269                         Title.prototype = o;
 270                         return new Title();
 271                 };
 272         }() );
 273
 274
 275         /* Static members */
 276
 277         /**
 278          * Constructor for Title objects with a null return instead of an exception for invalid titles.
 279          *
 280          * @static
 281          * @method
 282          * @param {string} title
 283          * @param {number} [namespace=NS_MAIN] Default namespace
 284          * @return {mw.Title|null} A valid Title object or null if the title is invalid
 285          */
 286         Title.newFromText = function ( title, namespace ) {
 287                 var t, parsed = parse( title, namespace );
 288                 if ( !parsed ) {
 289                         return null;
 290                 }
 291
 292                 t = createObject( Title.prototype );
 293                 t.namespace = parsed.namespace;
 294                 t.title = parsed.title;
 295                 t.ext = parsed.ext;
 296                 t.fragment = parsed.fragment;
 297
 298                 return t;
 299         };
 300
 301         /**
 302          * Whether this title exists on the wiki.
 303          *
 304          * @static
 305          * @param {string|mw.Title} title prefixed db-key name (string) or instance of Title
 306          * @return {boolean|null} Boolean if the information is available, otherwise null
 307          */
 308         Title.exists = function ( title ) {
 309                 var match,
 310                         type = $.type( title ),
 311                         obj = Title.exist.pages;
 312
 313                 if ( type === 'string' ) {
 314                         match = obj[title];
 315                 } else if ( type === 'object' && title instanceof Title ) {
 316                         match = obj[title.toString()];
 317                 } else {
 318                         throw new Error( 'mw.Title.exists: title must be a string or an instance of Title' );
 319                 }
 320
 321                 if ( typeof match === 'boolean' ) {
 322                         return match;
 323                 }
 324
 325                 return null;
 326         };
 327
 328         Title.exist = {
 329                 /**
 330                  * Boolean true value indicates page does exist.
 331                  *
 332                  * @static
 333                  * @property {Object} exist.pages Keyed by PrefixedDb title.
 334                  */
 335                 pages: {},
 336
 337                 /**
 338                  * Example to declare existing titles:
 339                  *     Title.exist.set(['User:John_Doe', ...]);
 340                  * Eample to declare titles nonexistent:
 341                  *     Title.exist.set(['File:Foo_bar.jpg', ...], false);
 342                  *
 343                  * @static
 344                  * @property exist.set
 345                  * @param {string|Array} titles Title(s) in strict prefixedDb title form
 346                  * @param {boolean} [state=true] State of the given titles
 347                  * @return {boolean}
 348                  */
 349                 set: function ( titles, state ) {
 350                         titles = $.isArray( titles ) ? titles : [titles];
 351                         state = state === undefined ? true : !!state;
 352                         var pages = this.pages, i, len = titles.length;
 353                         for ( i = 0; i < len; i++ ) {
 354                                 pages[ titles[i] ] = state;
 355                         }
 356                         return true;
 357                 }
 358         };
 359
 360         /* Public members */
 361
 362         Title.prototype = {
 363                 constructor: Title,
 364
 365                 /**
 366                  * Get the namespace number
 367                  *
 368                  * Example: 6 for "File:Example_image.svg".
 369                  *
 370                  * @return {number}
 371                  */
 372                 getNamespaceId: function () {
 373                         return this.namespace;
 374                 },
 375
 376                 /**
 377                  * Get the namespace prefix (in the content language)
 378                  *
 379                  * Example: "File:" for "File:Example_image.svg".
 380                  * In #NS_MAIN this is '', otherwise namespace name plus ':'
 381                  *
 382                  * @return {string}
 383                  */
 384                 getNamespacePrefix: function () {
 385                         return this.namespace === NS_MAIN ?
 386                                 '' :
 387                                 ( mw.config.get( 'wgFormattedNamespaces' )[ this.namespace ].replace( / /g, '_' ) + ':' );
 388                 },
 389
 390                 /**
 391                  * Get the page name without extension or namespace prefix
 392                  *
 393                  * Example: "Example_image" for "File:Example_image.svg".
 394                  *
 395                  * For the page title (full page name without namespace prefix), see #getMain.
 396                  *
 397                  * @return {string}
 398                  */
 399                 getName: function () {
 400                         if ( $.inArray( this.namespace, mw.config.get( 'wgCaseSensitiveNamespaces' ) ) !== -1 ) {
 401                                 return this.title;
 402                         } else {
 403                                 return $.ucFirst( this.title );
 404                         }
 405                 },
 406
 407                 /**
 408                  * Get the page name (transformed by #text)
 409                  *
 410                  * Example: "Example image" for "File:Example_image.svg".
 411                  *
 412                  * For the page title (full page name without namespace prefix), see #getMainText.
 413                  *
 414                  * @return {string}
 415                  */
 416                 getNameText: function () {
 417                         return text( this.getName() );
 418                 },
 419
 420                 /**
 421                  * Get the extension of the page name (if any)
 422                  *
 423                  * @return {string|null} Name extension or null if there is none
 424                  */
 425                 getExtension: function () {
 426                         return this.ext;
 427                 },
 428
 429                 /**
 430                  * Shortcut for appendable string to form the main page name.
 431                  *
 432                  * Returns a string like ".json", or "" if no extension.
 433                  *
 434                  * @return {string}
 435                  */
 436                 getDotExtension: function () {
 437                         return this.ext === null ? '' : '.' + this.ext;
 438                 },
 439
 440                 /**
 441                  * Get the main page name (transformed by #text)
 442                  *
 443                  * Example: "Example_image.svg" for "File:Example_image.svg".
 444                  *
 445                  * @return {string}
 446                  */
 447                 getMain: function () {
 448                         return this.getName() + this.getDotExtension();
 449                 },
 450
 451                 /**
 452                  * Get the main page name (transformed by #text)
 453                  *
 454                  * Example: "Example image.svg" for "File:Example_image.svg".
 455                  *
 456                  * @return {string}
 457                  */
 458                 getMainText: function () {
 459                         return text( this.getMain() );
 460                 },
 461
 462                 /**
 463                  * Get the full page name
 464                  *
 465                  * Eaxample: "File:Example_image.svg".
 466                  * Most useful for API calls, anything that must identify the "title".
 467                  *
 468                  * @return {string}
 469                  */
 470                 getPrefixedDb: function () {
 471                         return this.getNamespacePrefix() + this.getMain();
 472                 },
 473
 474                 /**
 475                  * Get the full page name (transformed by #text)
 476                  *
 477                  * Example: "File:Example image.svg" for "File:Example_image.svg".
 478                  *
 479                  * @return {string}
 480                  */
 481                 getPrefixedText: function () {
 482                         return text( this.getPrefixedDb() );
 483                 },
 484
 485                 /**
 486                  * Get the fragment (if any).
 487                  *
 488                  * Note that this method (by design) does not include the hash character and
 489                  * the value is not url encoded.
 490                  *
 491                  * @return {string|null}
 492                  */
 493                 getFragment: function () {
 494                         return this.fragment;
 495                 },
 496
 497                 /**
 498                  * Get the URL to this title
 499                  *
 500                  * @see mw.util#wikiGetlink
 501                  * @return {string}
 502                  */
 503                 getUrl: function () {
 504                         return mw.util.wikiGetlink( this.toString() );
 505                 },
 506
 507                 /**
 508                  * Whether this title exists on the wiki.
 509                  *
 510                  * @see #static-method-exists
 511                  * @return {boolean|null} Boolean if the information is available, otherwise null
 512                  */
 513                 exists: function () {
 514                         return Title.exists( this );
 515                 }
 516         };
 517
 518         /**
 519          * @alias #getPrefixedDb
 520          * @method
 521          */
 522         Title.prototype.toString = Title.prototype.getPrefixedDb;
 523
 524
 525         /**
 526          * @alias #getPrefixedText
 527          * @method
 528          */
 529         Title.prototype.toText = Title.prototype.getPrefixedText;
 530
 531         // Expose
 532         mw.Title = Title;
 533
 534 }( mediaWiki, jQuery ) );