2 * MediaWiki Widgets - TitleWidget class.
4 * @copyright 2011-2015 MediaWiki Widgets Team and others; see AUTHORS.txt
5 * @license The MIT License (MIT); see LICENSE.txt
10 * Mixin for title widgets
16 * @param {Object} [config] Configuration options
17 * @cfg {number} [limit=10] Number of results to show
18 * @cfg {number} [namespace] Namespace to prepend to queries
19 * @cfg {number} [maxLength=255] Maximum query length
20 * @cfg {boolean} [relative=true] If a namespace is set, display titles relative to it
21 * @cfg {boolean} [suggestions=true] Display search suggestions
22 * @cfg {boolean} [showRedirectTargets=true] Show the targets of redirects
23 * @cfg {boolean} [showImages] Show page images
24 * @cfg {boolean} [showDescriptions] Show page descriptions
25 * @cfg {boolean} [excludeCurrentPage] Exclude the current page from suggestions
26 * @cfg {boolean} [validateTitle=true] Whether the input must be a valid title (if set to true,
27 * the widget will marks itself red for invalid inputs, including an empty query).
28 * @cfg {Object} [cache] Result cache which implements a 'set' method, taking keyed values as an argument
29 * @cfg {mw.Api} [api] API object to use, creates a default mw.Api instance if not specified
31 mw
.widgets
.TitleWidget
= function MwWidgetsTitleWidget( config
) {
32 // Config initialization
39 this.limit
= config
.limit
;
40 this.maxLength
= config
.maxLength
;
41 this.namespace = config
.namespace !== undefined ? config
.namespace : null;
42 this.relative
= config
.relative
!== undefined ? config
.relative
: true;
43 this.suggestions
= config
.suggestions
!== undefined ? config
.suggestions
: true;
44 this.showRedirectTargets
= config
.showRedirectTargets
!== false;
45 this.showImages
= !!config
.showImages
;
46 this.showDescriptions
= !!config
.showDescriptions
;
47 this.excludeCurrentPage
= !!config
.excludeCurrentPage
;
48 this.validateTitle
= config
.validateTitle
!== undefined ? config
.validateTitle
: true;
49 this.cache
= config
.cache
;
50 this.api
= config
.api
|| new mw
.Api();
53 this.$element
.addClass( 'mw-widget-titleWidget' );
58 OO
.initClass( mw
.widgets
.TitleWidget
);
60 /* Static properties */
62 mw
.widgets
.TitleWidget
.static.interwikiPrefixesPromiseCache
= {};
67 * Get the current value of the search query
70 * @return {string} Search query
72 mw
.widgets
.TitleWidget
.prototype.getQueryValue
= null;
75 * Get the namespace to prepend to titles in suggestions, if any.
77 * @return {number|null} Namespace number
79 mw
.widgets
.TitleWidget
.prototype.getNamespace = function () {
80 return this.namespace;
84 * Set the namespace to prepend to titles in suggestions, if any.
86 * @param {number|null} namespace Namespace number
88 mw
.widgets
.TitleWidget
.prototype.setNamespace = function ( namespace ) {
89 this.namespace = namespace;
92 mw
.widgets
.TitleWidget
.prototype.getInterwikiPrefixesPromise = function () {
93 var api
= this.getApi(),
94 cache
= this.constructor.static.interwikiPrefixesPromiseCache
,
95 key
= api
.defaults
.ajax
.url
;
96 if ( !cache
.hasOwnProperty( key
) ) {
97 cache
[ key
] = api
.get( {
100 siprop
: 'interwikimap',
101 // Cache client-side for a day since this info is mostly static
102 maxage
: 60 * 60 * 24,
103 smaxage
: 60 * 60 * 24,
104 // Workaround T97096 by setting uselang=content
106 } ).then( function ( data
) {
107 return $.map( data
.query
.interwikimap
, function ( interwiki
) {
108 return interwiki
.prefix
;
116 * Get a promise which resolves with an API repsonse for suggested
117 * links for the current query.
119 * @return {jQuery.Promise} Suggestions promise
121 mw
.widgets
.TitleWidget
.prototype.getSuggestionsPromise = function () {
124 query
= this.getQueryValue(),
126 promiseAbortObject
= { abort: function () {
127 // Do nothing. This is just so OOUI doesn't break due to abort being undefined.
130 if ( mw
.Title
.newFromText( query
) ) {
131 return this.getInterwikiPrefixesPromise().then( function ( interwikiPrefixes
) {
132 var interwiki
= query
.substring( 0, query
.indexOf( ':' ) );
134 interwiki
&& interwiki
!== '' &&
135 interwikiPrefixes
.indexOf( interwiki
) !== -1
137 return $.Deferred().resolve( { query
: {
141 } } ).promise( promiseAbortObject
);
143 req
= api
.get( widget
.getApiParams( query
) );
144 promiseAbortObject
.abort
= req
.abort
.bind( req
); // TODO ew
145 return req
.then( function ( ret
) {
146 if ( ret
.query
=== undefined ) {
147 ret
= api
.get( { action
: 'query', titles
: query
} );
148 promiseAbortObject
.abort
= ret
.abort
.bind( ret
);
153 } ).promise( promiseAbortObject
);
155 // Don't send invalid titles to the API.
156 // Just pretend it returned nothing so we can show the 'invalid title' section
157 return $.Deferred().resolve( {} ).promise( promiseAbortObject
);
162 * Get API params for a given query
164 * @param {string} query User query
165 * @return {Object} API params
167 mw
.widgets
.TitleWidget
.prototype.getApiParams = function ( query
) {
170 prop
: [ 'info', 'pageprops' ],
171 generator
: 'prefixsearch',
173 gpsnamespace
: this.namespace !== null ? this.namespace : undefined,
174 gpslimit
: this.limit
,
175 ppprop
: 'disambiguation'
177 if ( this.showRedirectTargets
) {
178 params
.redirects
= true;
180 if ( this.showImages
) {
181 params
.prop
.push( 'pageimages' );
182 params
.pithumbsize
= 80;
183 params
.pilimit
= this.limit
;
185 if ( this.showDescriptions
) {
186 params
.prop
.push( 'pageterms' );
187 params
.wbptterms
= 'description';
193 * Get the API object for title requests
195 * @return {mw.Api} MediaWiki API
197 mw
.widgets
.TitleWidget
.prototype.getApi = function () {
202 * Get option widgets from the server response
204 * @param {Object} data Query result
205 * @return {OO.ui.OptionWidget[]} Menu items
207 mw
.widgets
.TitleWidget
.prototype.getOptionsFromData = function ( data
) {
208 var i
, len
, index
, pageExists
, pageExistsExact
, suggestionPage
, page
, redirect
, redirects
,
209 currentPageName
= new mw
.Title( mw
.config
.get( 'wgRelevantPageName' ) ).getPrefixedText(),
212 titleObj
= mw
.Title
.newFromText( this.getQueryValue() ),
216 if ( data
.redirects
) {
217 for ( i
= 0, len
= data
.redirects
.length
; i
< len
; i
++ ) {
218 redirect
= data
.redirects
[ i
];
219 redirectsTo
[ redirect
.to
] = redirectsTo
[ redirect
.to
] || [];
220 redirectsTo
[ redirect
.to
].push( redirect
.from );
224 for ( index
in data
.pages
) {
225 suggestionPage
= data
.pages
[ index
];
226 // When excludeCurrentPage is set, don't list the current page unless the user has type the full title
227 if ( this.excludeCurrentPage
&& suggestionPage
.title
=== currentPageName
&& suggestionPage
.title
!== titleObj
.getPrefixedText() ) {
230 pageData
[ suggestionPage
.title
] = {
231 known
: suggestionPage
.known
!== undefined,
232 missing
: suggestionPage
.missing
!== undefined,
233 redirect
: suggestionPage
.redirect
!== undefined,
234 disambiguation
: OO
.getProp( suggestionPage
, 'pageprops', 'disambiguation' ) !== undefined,
235 imageUrl
: OO
.getProp( suggestionPage
, 'thumbnail', 'source' ),
236 description
: OO
.getProp( suggestionPage
, 'terms', 'description' ),
238 index
: suggestionPage
.index
,
239 originalData
: suggestionPage
242 // Throw away pages from wrong namespaces. This can happen when 'showRedirectTargets' is true
243 // and we encounter a cross-namespace redirect.
244 if ( this.namespace === null || this.namespace === suggestionPage
.ns
) {
245 titles
.push( suggestionPage
.title
);
248 redirects
= redirectsTo
[ suggestionPage
.title
] || [];
249 for ( i
= 0, len
= redirects
.length
; i
< len
; i
++ ) {
250 pageData
[ redirects
[ i
] ] = {
254 disambiguation
: false,
255 description
: mw
.msg( 'mw-widgets-titleinput-description-redirect', suggestionPage
.title
),
256 // Sort index, just below its target
257 index
: suggestionPage
.index
+ 0.5,
258 originalData
: suggestionPage
260 titles
.push( redirects
[ i
] );
264 titles
.sort( function ( a
, b
) {
265 return pageData
[ a
].index
- pageData
[ b
].index
;
268 // If not found, run value through mw.Title to avoid treating a match as a
269 // mismatch where normalisation would make them matching (T50476)
272 Object
.prototype.hasOwnProperty
.call( pageData
, this.getQueryValue() ) &&
274 !pageData
[ this.getQueryValue() ].missing
||
275 pageData
[ this.getQueryValue() ].known
278 pageExists
= pageExistsExact
|| (
280 Object
.prototype.hasOwnProperty
.call( pageData
, titleObj
.getPrefixedText() ) &&
282 !pageData
[ titleObj
.getPrefixedText() ].missing
||
283 pageData
[ titleObj
.getPrefixedText() ].known
288 this.cache
.set( pageData
);
291 // Offer the exact text as a suggestion if the page exists
292 if ( pageExists
&& !pageExistsExact
) {
293 titles
.unshift( this.getQueryValue() );
296 for ( i
= 0, len
= titles
.length
; i
< len
; i
++ ) {
297 page
= pageData
[ titles
[ i
] ] || {};
298 items
.push( this.createOptionWidget( this.getOptionWidgetData( titles
[ i
], page
) ) );
305 * Create a menu option widget with specified data
307 * @param {Object} data Data for option widget
308 * @return {OO.ui.MenuOptionWidget} Data for option widget
310 mw
.widgets
.TitleWidget
.prototype.createOptionWidget = function ( data
) {
311 return new mw
.widgets
.TitleOptionWidget( data
);
315 * Get menu option widget data from the title and page data
317 * @param {string} title Title object
318 * @param {Object} data Page data
319 * @return {Object} Data for option widget
321 mw
.widgets
.TitleWidget
.prototype.getOptionWidgetData = function ( title
, data
) {
322 var mwTitle
= new mw
.Title( title
),
323 description
= data
.description
;
324 if ( data
.missing
&& !description
) {
325 description
= mw
.msg( 'mw-widgets-titleinput-description-new-page' );
328 data
: this.namespace !== null && this.relative
?
329 mwTitle
.getRelativeText( this.namespace ) :
331 url
: mwTitle
.getUrl(),
332 imageUrl
: this.showImages
? data
.imageUrl
: null,
333 description
: this.showDescriptions
? description
: null,
334 missing
: data
.missing
,
335 redirect
: data
.redirect
,
336 disambiguation
: data
.disambiguation
,
337 query
: this.getQueryValue()
342 * Get title object corresponding to given value, or #getQueryValue if not given.
344 * @param {string} [value] Value to get a title for
345 * @return {mw.Title|null} Title object, or null if value is invalid
347 mw
.widgets
.TitleWidget
.prototype.getTitle = function ( value
) {
348 var title
= value
!== undefined ? value
: this.getQueryValue(),
349 // mw.Title doesn't handle null well
350 titleObj
= mw
.Title
.newFromText( title
, this.namespace !== null ? this.namespace : undefined );
356 * Check if the query is valid
358 * @return {boolean} The query is valid
360 mw
.widgets
.TitleWidget
.prototype.isQueryValid = function () {
361 return this.validateTitle
? !!this.getTitle() : true;
364 }( jQuery
, mediaWiki
) );