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