resources/src/mediawiki.widgets/mw.widgets.CategoryCapsuleItemWidget.js

   1 /*!
   2  * MediaWiki Widgets - CategoryCapsuleItemWidget class.
   3  *
   4  * @copyright 2011-2015 MediaWiki Widgets Team and others; see AUTHORS.txt
   5  * @license The MIT License (MIT); see LICENSE.txt
   6  */
   7 ( function ( $, mw ) {
   8
   9         /**
  10          * @class mw.widgets.PageExistenceCache
  11          * @private
  12          * @param {mw.Api} [api]
  13          */
  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 = {};
  20         }
  21
  22         /**
  23          * Check for existence of pages in the queue.
  24          *
  25          * @private
  26          */
  27         PageExistenceCache.prototype.processExistenceCheckQueue = function () {
  28                 var queue, titles,
  29                         cache = this;
  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();
  35                         } );
  36                         return;
  37                 }
  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 ] );
  43                         }
  44                         return !cache.existenceCache.hasOwnProperty( title );
  45                 } );
  46                 if ( !titles.length ) {
  47                         return;
  48                 }
  49                 this.currentRequest = this.api.get( {
  50                         formatversion: 2,
  51                         action: 'query',
  52                         prop: [ 'info' ],
  53                         titles: titles
  54                 } ).done( function ( response ) {
  55                         $.each( response.query.pages, function ( index, page ) {
  56                                 var title = new ForeignTitle( page.title ).getPrefixedText();
  57                                 cache.existenceCache[ title ] = !page.missing;
  58                                 queue[ title ].resolve( cache.existenceCache[ title ] );
  59                         } );
  60                 } );
  61         };
  62
  63         /**
  64          * Register a request to check whether a page exists.
  65          *
  66          * @private
  67          * @param {mw.Title} title
  68          * @return {jQuery.Promise} Promise resolved with true if the page exists or false otherwise
  69          */
  70         PageExistenceCache.prototype.checkPageExistence = function ( title ) {
  71                 var key = title.getPrefixedText();
  72                 if ( !this.existenceCheckQueue[ key ] ) {
  73                         this.existenceCheckQueue[ key ] = $.Deferred();
  74                 }
  75                 this.processExistenceCheckQueueDebounced();
  76                 return this.existenceCheckQueue[ key ].promise();
  77         };
  78
  79         /**
  80          * @class mw.widgets.ForeignTitle
  81          * @private
  82          * @extends mw.Title
  83          *
  84          * @constructor
  85          * @inheritdoc
  86          */
  87         function ForeignTitle() {
  88                 ForeignTitle.parent.apply( this, arguments );
  89         }
  90         OO.inheritClass( ForeignTitle, mw.Title );
  91         ForeignTitle.prototype.getNamespacePrefix = function () {
  92                 // We only need to handle categories here...
  93                 return 'Category:'; // HACK
  94         };
  95
  96         /**
  97          * @class mw.widgets.CategoryCapsuleItemWidget
  98          *
  99          * Category selector capsule item widget. Extends OO.ui.CapsuleItemWidget with the ability to link
 100          * to the given page, and to show its existence status (i.e., whether it is a redlink).
 101          *
 102          * @uses mw.Api
 103          * @extends OO.ui.CapsuleItemWidget
 104          *
 105          * @constructor
 106          * @param {Object} config Configuration options
 107          * @cfg {mw.Title} title Page title to use (required)
 108          * @cfg {string} [apiUrl] API URL, if not the current wiki's API
 109          */
 110         mw.widgets.CategoryCapsuleItemWidget = function MWWCategoryCapsuleItemWidget( config ) {
 111                 var widget = this;
 112                 // Parent constructor
 113                 mw.widgets.CategoryCapsuleItemWidget.parent.call( this, $.extend( {
 114                         data: config.title.getMainText(),
 115                         label: config.title.getMainText()
 116                 }, config ) );
 117
 118                 // Properties
 119                 this.title = config.title;
 120                 this.apiUrl = config.apiUrl || '';
 121                 this.$link = $( '<a>' )
 122                         .text( this.label )
 123                         .attr( 'target', '_blank' )
 124                         .on( 'click', function ( e ) {
 125                                 // CapsuleMultiSelectWidget really wants to prevent you from clicking the link, don't let it
 126                                 e.stopPropagation();
 127                         } );
 128
 129                 // Initialize
 130                 this.setMissing( false );
 131                 this.$label.replaceWith( this.$link );
 132                 this.setLabelElement( this.$link );
 133
 134                 /*jshint -W024*/
 135                 if ( !this.constructor.static.pageExistenceCaches[ this.apiUrl ] ) {
 136                         this.constructor.static.pageExistenceCaches[ this.apiUrl ] =
 137                                 new PageExistenceCache( new mw.ForeignApi( this.apiUrl ) );
 138                 }
 139                 this.constructor.static.pageExistenceCaches[ this.apiUrl ]
 140                         .checkPageExistence( new ForeignTitle( this.title.getPrefixedText() ) )
 141                         .done( function ( exists ) {
 142                                 widget.setMissing( !exists );
 143                         } );
 144                 /*jshint +W024*/
 145         };
 146
 147         /* Setup */
 148
 149         OO.inheritClass( mw.widgets.CategoryCapsuleItemWidget, OO.ui.CapsuleItemWidget );
 150
 151         /* Static Properties */
 152
 153         /*jshint -W024*/
 154         /**
 155          * Map of API URLs to PageExistenceCache objects.
 156          *
 157          * @static
 158          * @inheritable
 159          * @property {Object}
 160          */
 161         mw.widgets.CategoryCapsuleItemWidget.static.pageExistenceCaches = {
 162                 '': new PageExistenceCache()
 163         };
 164         /*jshint +W024*/
 165
 166         /* Methods */
 167
 168         /**
 169          * Update label link href and CSS classes to reflect page existence status.
 170          *
 171          * @private
 172          * @param {boolean} missing Whether the page is missing (does not exist)
 173          */
 174         mw.widgets.CategoryCapsuleItemWidget.prototype.setMissing = function ( missing ) {
 175                 var
 176                         title = new ForeignTitle( this.title.getPrefixedText() ), // HACK
 177                         prefix = this.apiUrl.replace( '/w/api.php', '' ); // HACK
 178
 179                 this.missing = missing;
 180
 181                 if ( !missing ) {
 182                         this.$link
 183                                 .attr( 'href', prefix + title.getUrl() )
 184                                 .attr( 'title', title.getPrefixedText() )
 185                                 .removeClass( 'new' );
 186                 } else {
 187                         this.$link
 188                                 .attr( 'href', prefix + title.getUrl( { action: 'edit', redlink: 1 } ) )
 189                                 .attr( 'title', mw.msg( 'red-link-title', title.getPrefixedText() ) )
 190                                 .addClass( 'new' );
 191                 }
 192         };
 193
 194 }( jQuery, mediaWiki ) );