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

   1 /*!
   2  * MediaWiki Widgets - TitleWidget 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         var interwikiPrefixesPromise = new mw.Api().get( {
  10                         action: 'query',
  11                         meta: 'siteinfo',
  12                         siprop: 'interwikimap'
  13                 } ).then( function ( data ) {
  14                         return $.map( data.query.interwikimap, function ( interwiki ) {
  15                                 return interwiki.prefix;
  16                         } );
  17                 } );
  18
  19         /**
  20          * Mixin for title widgets
  21          *
  22          * @class
  23          * @abstract
  24          *
  25          * @constructor
  26          * @param {Object} [config] Configuration options
  27          * @cfg {number} [limit=10] Number of results to show
  28          * @cfg {number} [namespace] Namespace to prepend to queries
  29          * @cfg {number} [maxLength=255] Maximum query length
  30          * @cfg {boolean} [relative=true] If a namespace is set, display titles relative to it
  31          * @cfg {boolean} [suggestions=true] Display search suggestions
  32          * @cfg {boolean} [showRedirectTargets=true] Show the targets of redirects
  33          * @cfg {boolean} [showRedlink] Show red link to exact match if it doesn't exist
  34          * @cfg {boolean} [showImages] Show page images
  35          * @cfg {boolean} [showDescriptions] Show page descriptions
  36          * @cfg {boolean} [validateTitle=true] Whether the input must be a valid title (if set to true,
  37          *  the widget will marks itself red for invalid inputs, including an empty query).
  38          * @cfg {Object} [cache] Result cache which implements a 'set' method, taking keyed values as an argument
  39          */
  40         mw.widgets.TitleWidget = function MwWidgetsTitleWidget( config ) {
  41                 // Config initialization
  42                 config = $.extend( {
  43                         maxLength: 255,
  44                         limit: 10
  45                 }, config );
  46
  47                 // Properties
  48                 this.limit = config.limit;
  49                 this.maxLength = config.maxLength;
  50                 this.namespace = config.namespace !== undefined ? config.namespace : null;
  51                 this.relative = config.relative !== undefined ? config.relative : true;
  52                 this.suggestions = config.suggestions !== undefined ? config.suggestions : true;
  53                 this.showRedirectTargets = config.showRedirectTargets !== false;
  54                 this.showRedlink = !!config.showRedlink;
  55                 this.showImages = !!config.showImages;
  56                 this.showDescriptions = !!config.showDescriptions;
  57                 this.validateTitle = config.validateTitle !== undefined ? config.validateTitle : true;
  58                 this.cache = config.cache;
  59
  60                 // Initialization
  61                 this.$element.addClass( 'mw-widget-titleWidget' );
  62         };
  63
  64         /* Setup */
  65
  66         OO.initClass( mw.widgets.TitleWidget );
  67
  68         /* Methods */
  69
  70         /**
  71          * Get the current value of the search query
  72          *
  73          * @abstract
  74          * @return {string} Search query
  75          */
  76         mw.widgets.TitleWidget.prototype.getQueryValue = null;
  77
  78         /**
  79          * Get the namespace to prepend to titles in suggestions, if any.
  80          *
  81          * @return {number|null} Namespace number
  82          */
  83         mw.widgets.TitleWidget.prototype.getNamespace = function () {
  84                 return this.namespace;
  85         };
  86
  87         /**
  88          * Set the namespace to prepend to titles in suggestions, if any.
  89          *
  90          * @param {number|null} namespace Namespace number
  91          */
  92         mw.widgets.TitleWidget.prototype.setNamespace = function ( namespace ) {
  93                 this.namespace = namespace;
  94         };
  95
  96         /**
  97          * Get a promise which resolves with an API repsonse for suggested
  98          * links for the current query.
  99          *
 100          * @return {jQuery.Promise} Suggestions promise
 101          */
 102         mw.widgets.TitleWidget.prototype.getSuggestionsPromise = function () {
 103                 var req,
 104                         query = this.getQueryValue(),
 105                         widget = this,
 106                         promiseAbortObject = { abort: function () {
 107                                 // Do nothing. This is just so OOUI doesn't break due to abort being undefined.
 108                         } };
 109
 110                 if ( mw.Title.newFromText( query ) ) {
 111                         return interwikiPrefixesPromise.then( function ( interwikiPrefixes ) {
 112                                 var params,
 113                                         interwiki = query.substring( 0, query.indexOf( ':' ) );
 114                                 if (
 115                                         interwiki && interwiki !== '' &&
 116                                         interwikiPrefixes.indexOf( interwiki ) !== -1
 117                                 ) {
 118                                         return $.Deferred().resolve( { query: {
 119                                                 pages: [ {
 120                                                         title: query
 121                                                 } ]
 122                                         } } ).promise( promiseAbortObject );
 123                                 } else {
 124                                         params = {
 125                                                 action: 'query',
 126                                                 prop: [ 'info', 'pageprops' ],
 127                                                 generator: 'prefixsearch',
 128                                                 gpssearch: query,
 129                                                 gpsnamespace: widget.namespace !== null ? widget.namespace : undefined,
 130                                                 gpslimit: widget.limit,
 131                                                 ppprop: 'disambiguation'
 132                                         };
 133                                         if ( widget.showRedirectTargets ) {
 134                                                 params.redirects = true;
 135                                         }
 136                                         if ( widget.showImages ) {
 137                                                 params.prop.push( 'pageimages' );
 138                                                 params.pithumbsize = 80;
 139                                                 params.pilimit = widget.limit;
 140                                         }
 141                                         if ( widget.showDescriptions ) {
 142                                                 params.prop.push( 'pageterms' );
 143                                                 params.wbptterms = 'description';
 144                                         }
 145                                         req = new mw.Api().get( params );
 146                                         promiseAbortObject.abort = req.abort.bind( req ); // TODO ew
 147                                         return req;
 148                                 }
 149                         } ).promise( promiseAbortObject );
 150                 } else {
 151                         // Don't send invalid titles to the API.
 152                         // Just pretend it returned nothing so we can show the 'invalid title' section
 153                         return $.Deferred().resolve( {} ).promise( promiseAbortObject );
 154                 }
 155         };
 156
 157         /**
 158          * Get option widgets from the server response
 159          *
 160          * @param {Object} data Query result
 161          * @return {OO.ui.OptionWidget[]} Menu items
 162          */
 163         mw.widgets.TitleWidget.prototype.getOptionsFromData = function ( data ) {
 164                 var i, len, index, pageExists, pageExistsExact, suggestionPage, page, redirect, redirects,
 165                         items = [],
 166                         titles = [],
 167                         titleObj = mw.Title.newFromText( this.getQueryValue() ),
 168                         redirectsTo = {},
 169                         pageData = {};
 170
 171                 if ( data.redirects ) {
 172                         for ( i = 0, len = data.redirects.length; i < len; i++ ) {
 173                                 redirect = data.redirects[ i ];
 174                                 redirectsTo[ redirect.to ] = redirectsTo[ redirect.to ] || [];
 175                                 redirectsTo[ redirect.to ].push( redirect.from );
 176                         }
 177                 }
 178
 179                 for ( index in data.pages ) {
 180                         suggestionPage = data.pages[ index ];
 181                         pageData[ suggestionPage.title ] = {
 182                                 missing: suggestionPage.missing !== undefined,
 183                                 redirect: suggestionPage.redirect !== undefined,
 184                                 disambiguation: OO.getProp( suggestionPage, 'pageprops', 'disambiguation' ) !== undefined,
 185                                 imageUrl: OO.getProp( suggestionPage, 'thumbnail', 'source' ),
 186                                 description: OO.getProp( suggestionPage, 'terms', 'description' ),
 187                                 // Sort index
 188                                 index: suggestionPage.index
 189                         };
 190
 191                         // Throw away pages from wrong namespaces. This can happen when 'showRedirectTargets' is true
 192                         // and we encounter a cross-namespace redirect.
 193                         if ( this.namespace === null || this.namespace === suggestionPage.ns ) {
 194                                 titles.push( suggestionPage.title );
 195                         }
 196
 197                         redirects = redirectsTo[ suggestionPage.title ] || [];
 198                         for ( i = 0, len = redirects.length; i < len; i++ ) {
 199                                 pageData[ redirects[ i ] ] = {
 200                                         missing: false,
 201                                         redirect: true,
 202                                         disambiguation: false,
 203                                         description: mw.msg( 'mw-widgets-titleinput-description-redirect', suggestionPage.title ),
 204                                         // Sort index, just below its target
 205                                         index: suggestionPage.index + 0.5
 206                                 };
 207                                 titles.push( redirects[ i ] );
 208                         }
 209                 }
 210
 211                 titles.sort( function ( a, b ) {
 212                         return pageData[ a ].index - pageData[ b ].index;
 213                 } );
 214
 215                 // If not found, run value through mw.Title to avoid treating a match as a
 216                 // mismatch where normalisation would make them matching (bug 48476)
 217
 218                 pageExistsExact = titles.indexOf( this.getQueryValue() ) !== -1;
 219                 pageExists = pageExistsExact || (
 220                         titleObj && titles.indexOf( titleObj.getPrefixedText() ) !== -1
 221                 );
 222
 223                 if ( !pageExists ) {
 224                         pageData[ this.getQueryValue() ] = {
 225                                 missing: true, redirect: false, disambiguation: false,
 226                                 description: mw.msg( 'mw-widgets-titleinput-description-new-page' )
 227                         };
 228                 }
 229
 230                 if ( this.cache ) {
 231                         this.cache.set( pageData );
 232                 }
 233
 234                 // Offer the exact text as a suggestion if the page exists
 235                 if ( pageExists && !pageExistsExact ) {
 236                         titles.unshift( this.getQueryValue() );
 237                 }
 238                 // Offer the exact text as a new page if the title is valid
 239                 if ( this.showRedlink && !pageExists && titleObj ) {
 240                         titles.push( this.getQueryValue() );
 241                 }
 242                 for ( i = 0, len = titles.length; i < len; i++ ) {
 243                         page = pageData[ titles[ i ] ] || {};
 244                         items.push( new mw.widgets.TitleOptionWidget( this.getOptionWidgetData( titles[ i ], page ) ) );
 245                 }
 246
 247                 return items;
 248         };
 249
 250         /**
 251          * Get menu option widget data from the title and page data
 252          *
 253          * @param {string} title Title object
 254          * @param {Object} data Page data
 255          * @return {Object} Data for option widget
 256          */
 257         mw.widgets.TitleWidget.prototype.getOptionWidgetData = function ( title, data ) {
 258                 var mwTitle = new mw.Title( title );
 259                 return {
 260                         data: this.namespace !== null && this.relative
 261                                 ? mwTitle.getRelativeText( this.namespace )
 262                                 : title,
 263                         url: mwTitle.getUrl(),
 264                         imageUrl: this.showImages ? data.imageUrl : null,
 265                         description: this.showDescriptions ? data.description : null,
 266                         missing: data.missing,
 267                         redirect: data.redirect,
 268                         disambiguation: data.disambiguation,
 269                         query: this.getQueryValue()
 270                 };
 271         };
 272
 273         /**
 274          * Get title object corresponding to given value, or #getQueryValue if not given.
 275          *
 276          * @param {string} [value] Value to get a title for
 277          * @return {mw.Title|null} Title object, or null if value is invalid
 278          */
 279         mw.widgets.TitleWidget.prototype.getTitle = function ( value ) {
 280                 var title = value !== undefined ? value : this.getQueryValue(),
 281                         // mw.Title doesn't handle null well
 282                         titleObj = mw.Title.newFromText( title, this.namespace !== null ? this.namespace : undefined );
 283
 284                 return titleObj;
 285         };
 286
 287         /**
 288          * Check if the query is valid
 289          *
 290          * @return {boolean} The query is valid
 291          */
 292         mw.widgets.TitleWidget.prototype.isQueryValid = function () {
 293                 return this.validateTitle ? !!this.getTitle() : true;
 294         };
 295
 296 }( jQuery, mediaWiki ) );