2 * MediaWiki Widgets - CategoryCapsuleItemWidget class.
4 * @copyright 2011-2015 MediaWiki Widgets Team and others; see AUTHORS.txt
5 * @license The MIT License (MIT); see LICENSE.txt
10 * @class mw.widgets.PageExistenceCache
12 * @param {mw.Api} [api]
14 function PageExistenceCache( api
) {
15 this.api
= api
|| new mw
.Api();
16 this.processExistenceCheckQueueDebounced
= OO
.ui
.debounce( this.processExistenceCheckQueue
);
17 this.currentRequest
= null;
18 this.existenceCache
= {};
19 this.existenceCheckQueue
= {};
23 * Check for existence of pages in the queue.
27 PageExistenceCache
.prototype.processExistenceCheckQueue = function () {
30 if ( this.currentRequest
) {
31 // Don't fire off a million requests at the same time
32 this.currentRequest
.always( function () {
33 cache
.currentRequest
= null;
34 cache
.processExistenceCheckQueueDebounced();
38 queue
= this.existenceCheckQueue
;
39 this.existenceCheckQueue
= {};
40 titles
= Object
.keys( queue
).filter( function ( title
) {
41 if ( cache
.existenceCache
.hasOwnProperty( title
) ) {
42 queue
[ title
].resolve( cache
.existenceCache
[ title
] );
44 return !cache
.existenceCache
.hasOwnProperty( title
);
46 if ( !titles
.length
) {
49 this.currentRequest
= this.api
.get( {
54 } ).done( function ( response
) {
58 $.each( response
.query
.normalized
|| [], function ( index
, data
) {
59 normalized
[ data
.fromencoded
? decodeURIComponent( data
.from ) : data
.from ] = data
.to
;
61 $.each( response
.query
.pages
, function ( index
, page
) {
62 pages
[ page
.title
] = !page
.missing
;
64 $.each( titles
, function ( index
, title
) {
65 var normalizedTitle
= title
;
66 while ( normalized
[ normalizedTitle
] ) {
67 normalizedTitle
= normalized
[ normalizedTitle
];
69 cache
.existenceCache
[ title
] = pages
[ normalizedTitle
];
70 queue
[ title
].resolve( cache
.existenceCache
[ title
] );
76 * Register a request to check whether a page exists.
79 * @param {mw.Title} title
80 * @return {jQuery.Promise} Promise resolved with true if the page exists or false otherwise
82 PageExistenceCache
.prototype.checkPageExistence = function ( title
) {
83 var key
= title
.getPrefixedText();
84 if ( !this.existenceCheckQueue
[ key
] ) {
85 this.existenceCheckQueue
[ key
] = $.Deferred();
87 this.processExistenceCheckQueueDebounced();
88 return this.existenceCheckQueue
[ key
].promise();
92 * @class mw.widgets.ForeignTitle
99 function ForeignTitle( title
, namespace ) {
100 // We only need to handle categories here... but we don't know the target language.
101 // So assume that any namespace-like prefix is the 'Category' namespace...
102 title
= title
.replace( /^(.+?)_*:_*(.*)$/, 'Category:$2' ); // HACK
103 ForeignTitle
.parent
.call( this, title
, namespace );
105 OO
.inheritClass( ForeignTitle
, mw
.Title
);
106 ForeignTitle
.prototype.getNamespacePrefix = function () {
107 // We only need to handle categories here...
108 return 'Category:'; // HACK
112 * @class mw.widgets.CategoryCapsuleItemWidget
114 * Category selector capsule item widget. Extends OO.ui.CapsuleItemWidget with the ability to link
115 * to the given page, and to show its existence status (i.e., whether it is a redlink).
118 * @extends OO.ui.CapsuleItemWidget
121 * @param {Object} config Configuration options
122 * @cfg {mw.Title} title Page title to use (required)
123 * @cfg {string} [apiUrl] API URL, if not the current wiki's API
125 mw
.widgets
.CategoryCapsuleItemWidget
= function MWWCategoryCapsuleItemWidget( config
) {
127 // Parent constructor
128 mw
.widgets
.CategoryCapsuleItemWidget
.parent
.call( this, $.extend( {
129 data
: config
.title
.getMainText(),
130 label
: config
.title
.getMainText()
134 this.title
= config
.title
;
135 this.apiUrl
= config
.apiUrl
|| '';
136 this.$link
= $( '<a>' )
138 .attr( 'target', '_blank' )
139 .on( 'click', function ( e
) {
140 // CapsuleMultiselectWidget really wants to prevent you from clicking the link, don't let it
145 this.setMissing( false );
146 this.$label
.replaceWith( this.$link
);
147 this.setLabelElement( this.$link
);
150 if ( !this.constructor.static.pageExistenceCaches
[ this.apiUrl
] ) {
151 this.constructor.static.pageExistenceCaches
[ this.apiUrl
] =
152 new PageExistenceCache( new mw
.ForeignApi( this.apiUrl
) );
154 this.constructor.static.pageExistenceCaches
[ this.apiUrl
]
155 .checkPageExistence( new ForeignTitle( this.title
.getPrefixedText() ) )
156 .done( function ( exists
) {
157 widget
.setMissing( !exists
);
164 OO
.inheritClass( mw
.widgets
.CategoryCapsuleItemWidget
, OO
.ui
.CapsuleItemWidget
);
166 /* Static Properties */
170 * Map of API URLs to PageExistenceCache objects.
176 mw
.widgets
.CategoryCapsuleItemWidget
.static.pageExistenceCaches
= {
177 '': new PageExistenceCache()
184 * Update label link href and CSS classes to reflect page existence status.
187 * @param {boolean} missing Whether the page is missing (does not exist)
189 mw
.widgets
.CategoryCapsuleItemWidget
.prototype.setMissing = function ( missing
) {
191 title
= new ForeignTitle( this.title
.getPrefixedText() ), // HACK
192 prefix
= this.apiUrl
.replace( '/w/api.php', '' ); // HACK
194 this.missing
= missing
;
198 .attr( 'href', prefix
+ title
.getUrl() )
199 .attr( 'title', title
.getPrefixedText() )
200 .removeClass( 'new' );
203 .attr( 'href', prefix
+ title
.getUrl( { action
: 'edit', redlink
: 1 } ) )
204 .attr( 'title', mw
.msg( 'red-link-title', title
.getPrefixedText() ) )
209 }( jQuery
, mediaWiki
) );