dépôts / lhc / web / wiklou.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
history | raw | HEAD
ApiSandbox: Use CopyTextLayouts for snippets
[lhc/web/wiklou.git] / resources / src / mediawiki.special.apisandbox / apisandbox.js
1 ( function () {
2 'use strict';
3 var ApiSandbox, Util, WidgetMethods, Validators,
4 $content, panel, booklet, oldhash, windowManager,
5 formatDropdown,
6 api = new mw.Api(),
7 bookletPages = [],
8 availableFormats = {},
9 resultPage = null,
10 suppressErrors = true,
11 updatingBooklet = false,
12 pages = {},
13 moduleInfoCache = {},
14 baseRequestParams;
15
16 /**
17 * A wrapper for a widget that provides an enable/disable button
18 *
19 * @class
20 * @private
21 * @constructor
22 * @param {OO.ui.Widget} widget
23 * @param {Object} [config] Configuration options
24 */
25 function OptionalWidget( widget, config ) {
26 var k;
27
28 config = config || {};
29
30 this.widget = widget;
31 this.$cover = config.$cover ||
32 $( '<div>' ).addClass( 'mw-apisandbox-optionalWidget-cover' );
33 this.checkbox = new OO.ui.CheckboxInputWidget( config.checkbox )
34 .on( 'change', this.onCheckboxChange, [], this );
35
36 OptionalWidget.super.call( this, config );
37
38 // Forward most methods for convenience
39 for ( k in this.widget ) {
40 if ( typeof this.widget[ k ] === 'function' && !this[ k ] ) {
41 this[ k ] = this.widget[ k ].bind( this.widget );
42 }
43 }
44
45 widget.connect( this, {
46 change: [ this.emit, 'change' ]
47 } );
48
49 this.$cover.on( 'click', this.onOverlayClick.bind( this ) );
50
51 this.$element
52 .addClass( 'mw-apisandbox-optionalWidget' )
53 .append(
54 this.$cover,
55 $( '<div>' ).addClass( 'mw-apisandbox-optionalWidget-fields' ).append(
56 $( '<div>' ).addClass( 'mw-apisandbox-optionalWidget-widget' ).append(
57 widget.$element
58 ),
59 $( '<div>' ).addClass( 'mw-apisandbox-optionalWidget-checkbox' ).append(
60 this.checkbox.$element
61 )
62 )
63 );
64
65 this.setDisabled( widget.isDisabled() );
66 }
67 OO.inheritClass( OptionalWidget, OO.ui.Widget );
68 OptionalWidget.prototype.onCheckboxChange = function ( checked ) {
69 this.setDisabled( !checked );
70 };
71 OptionalWidget.prototype.onOverlayClick = function () {
72 this.setDisabled( false );
73 if ( typeof this.widget.focus === 'function' ) {
74 this.widget.focus();
75 }
76 };
77 OptionalWidget.prototype.setDisabled = function ( disabled ) {
78 OptionalWidget.super.prototype.setDisabled.call( this, disabled );
79 this.widget.setDisabled( this.isDisabled() );
80 this.checkbox.setSelected( !this.isDisabled() );
81 this.$cover.toggle( this.isDisabled() );
82 this.emit( 'change' );
83 return this;
84 };
85
86 WidgetMethods = {
87 textInputWidget: {
88 getApiValue: function () {
89 return this.getValue();
90 },
91 setApiValue: function ( v ) {
92 if ( v === undefined ) {
93 v = this.paramInfo.default;
94 }
95 this.setValue( v );
96 },
97 apiCheckValid: function () {
98 var that = this;
99 return this.getValidity().then( function () {
100 return $.Deferred().resolve( true ).promise();
101 }, function () {
102 return $.Deferred().resolve( false ).promise();
103 } ).done( function ( ok ) {
104 ok = ok || suppressErrors;
105 that.setIcon( ok ? null : 'alert' );
106 that.setTitle( ok ? '' : mw.message( 'apisandbox-alert-field' ).plain() );
107 } );
108 }
109 },
110
111 dateTimeInputWidget: {
112 getValidity: function () {
113 if ( !Util.apiBool( this.paramInfo.required ) || this.getApiValue() !== '' ) {
114 return $.Deferred().resolve().promise();
115 } else {
116 return $.Deferred().reject().promise();
117 }
118 }
119 },
120
121 tokenWidget: {
122 alertTokenError: function ( code, error ) {
123 windowManager.openWindow( 'errorAlert', {
124 title: Util.parseMsg( 'apisandbox-results-fixtoken-fail', this.paramInfo.tokentype ),
125 message: error,
126 actions: [
127 {
128 action: 'accept',
129 label: OO.ui.msg( 'ooui-dialog-process-dismiss' ),
130 flags: 'primary'
131 }
132 ]
133 } );
134 },
135 fetchToken: function () {
136 this.pushPending();
137 return api.getToken( this.paramInfo.tokentype )
138 .done( this.setApiValue.bind( this ) )
139 .fail( this.alertTokenError.bind( this ) )
140 .always( this.popPending.bind( this ) );
141 },
142 setApiValue: function ( v ) {
143 WidgetMethods.textInputWidget.setApiValue.call( this, v );
144 if ( v === '123ABC' ) {
145 this.fetchToken();
146 }
147 }
148 },
149
150 passwordWidget: {
151 getApiValueForDisplay: function () {
152 return '';
153 }
154 },
155
156 toggleSwitchWidget: {
157 getApiValue: function () {
158 return this.getValue() ? 1 : undefined;
159 },
160 setApiValue: function ( v ) {
161 this.setValue( Util.apiBool( v ) );
162 },
163 apiCheckValid: function () {
164 return $.Deferred().resolve( true ).promise();
165 }
166 },
167
168 dropdownWidget: {
169 getApiValue: function () {
170 var item = this.getMenu().findSelectedItem();
171 return item === null ? undefined : item.getData();
172 },
173 setApiValue: function ( v ) {
174 var menu = this.getMenu();
175
176 if ( v === undefined ) {
177 v = this.paramInfo.default;
178 }
179 if ( v === undefined ) {
180 menu.selectItem();
181 } else {
182 menu.selectItemByData( String( v ) );
183 }
184 },
185 apiCheckValid: function () {
186 var ok = this.getApiValue() !== undefined || suppressErrors;
187 this.setIcon( ok ? null : 'alert' );
188 this.setTitle( ok ? '' : mw.message( 'apisandbox-alert-field' ).plain() );
189 return $.Deferred().resolve( ok ).promise();
190 }
191 },
192
193 tagWidget: {
194 parseApiValue: function ( v ) {
195 if ( v === undefined || v === '' || v === '\x1f' ) {
196 return [];
197 } else {
198 v = String( v );
199 if ( v[ 0 ] !== '\x1f' ) {
200 return v.split( '|' );
201 } else {
202 return v.substr( 1 ).split( '\x1f' );
203 }
204 }
205 },
206 getApiValueForTemplates: function () {
207 return this.isDisabled() ? this.parseApiValue( this.paramInfo.default ) : this.getValue();
208 },
209 getApiValue: function () {
210 var items = this.getValue();
211 if ( items.join( '' ).indexOf( '|' ) === -1 ) {
212 return items.join( '|' );
213 } else {
214 return '\x1f' + items.join( '\x1f' );
215 }
216 },
217 setApiValue: function ( v ) {
218 if ( v === undefined ) {
219 v = this.paramInfo.default;
220 }
221 this.setValue( this.parseApiValue( v ) );
222 },
223 apiCheckValid: function () {
224 var ok = true,
225 pi = this.paramInfo;
226
227 if ( !suppressErrors ) {
228 ok = this.getApiValue() !== undefined && !(
229 pi.allspecifier !== undefined &&
230 this.getValue().length > 1 &&
231 this.getValue().indexOf( pi.allspecifier ) !== -1
232 );
233 }
234
235 this.setIcon( ok ? null : 'alert' );
236 this.setTitle( ok ? '' : mw.message( 'apisandbox-alert-field' ).plain() );
237 return $.Deferred().resolve( ok ).promise();
238 },
239 createTagItemWidget: function ( data, label ) {
240 var item = OO.ui.TagMultiselectWidget.prototype.createTagItemWidget.call( this, data, label );
241 if ( this.paramInfo.deprecatedvalues &&
242 this.paramInfo.deprecatedvalues.indexOf( data ) >= 0
243 ) {
244 item.$element.addClass( 'apihelp-deprecated-value' );
245 }
246 return item;
247 }
248 },
249
250 optionalWidget: {
251 getApiValue: function () {
252 return this.isDisabled() ? undefined : this.widget.getApiValue();
253 },
254 setApiValue: function ( v ) {
255 this.setDisabled( v === undefined );
256 this.widget.setApiValue( v );
257 },
258 apiCheckValid: function () {
259 if ( this.isDisabled() ) {
260 return $.Deferred().resolve( true ).promise();
261 } else {
262 return this.widget.apiCheckValid();
263 }
264 }
265 },
266
267 submoduleWidget: {
268 single: function () {
269 var v = this.isDisabled() ? this.paramInfo.default : this.getApiValue();
270 return v === undefined ? [] : [ { value: v, path: this.paramInfo.submodules[ v ] } ];
271 },
272 multi: function () {
273 var map = this.paramInfo.submodules,
274 v = this.isDisabled() ? this.paramInfo.default : this.getApiValue();
275 return v === undefined || v === '' ? [] : String( v ).split( '|' ).map( function ( v ) {
276 return { value: v, path: map[ v ] };
277 } );
278 }
279 },
280
281 uploadWidget: {
282 getApiValueForDisplay: function () {
283 return '...';
284 },
285 getApiValue: function () {
286 return this.getValue();
287 },
288 setApiValue: function () {
289 // Can't, sorry.
290 },
291 apiCheckValid: function () {
292 var ok = this.getValue() !== null || suppressErrors;
293 this.setIcon( ok ? null : 'alert' );
294 this.setTitle( ok ? '' : mw.message( 'apisandbox-alert-field' ).plain() );
295 return $.Deferred().resolve( ok ).promise();
296 }
297 }
298 };
299
300 Validators = {
301 generic: function () {
302 return !Util.apiBool( this.paramInfo.required ) || this.getApiValue() !== '';
303 }
304 };
305
306 /**
307 * @class mw.special.ApiSandbox.Util
308 * @private
309 */
310 Util = {
311 /**
312 * Fetch API module info
313 *
314 * @param {string} module Module to fetch data for
315 * @return {jQuery.Promise}
316 */
317 fetchModuleInfo: function ( module ) {
318 var apiPromise,
319 deferred = $.Deferred();
320
321 if ( Object.prototype.hasOwnProperty.call( moduleInfoCache, module ) ) {
322 return deferred
323 .resolve( moduleInfoCache[ module ] )
324 .promise( { abort: function () {} } );
325 } else {
326 apiPromise = api.post( {
327 action: 'paraminfo',
328 modules: module,
329 helpformat: 'html',
330 uselang: mw.config.get( 'wgUserLanguage' )
331 } ).done( function ( data ) {
332 var info;
333
334 if ( data.warnings && data.warnings.paraminfo ) {
335 deferred.reject( '???', data.warnings.paraminfo[ '*' ] );
336 return;
337 }
338
339 info = data.paraminfo.modules;
340 if ( !info || info.length !== 1 || info[ 0 ].path !== module ) {
341 deferred.reject( '???', 'No module data returned' );
342 return;
343 }
344
345 moduleInfoCache[ module ] = info[ 0 ];
346 deferred.resolve( info[ 0 ] );
347 } ).fail( function ( code, details ) {
348 if ( code === 'http' ) {
349 details = 'HTTP error: ' + details.exception;
350 } else if ( details.error ) {
351 details = details.error.info;
352 }
353 deferred.reject( code, details );
354 } );
355 return deferred
356 .promise( { abort: apiPromise.abort } );
357 }
358 },
359
360 /**
361 * Mark all currently-in-use tokens as bad
362 */
363 markTokensBad: function () {
364 var page, subpages, i,
365 checkPages = [ pages.main ];
366
367 while ( checkPages.length ) {
368 page = checkPages.shift();
369
370 if ( page.tokenWidget ) {
371 api.badToken( page.tokenWidget.paramInfo.tokentype );
372 }
373
374 subpages = page.getSubpages();
375 for ( i = 0; i < subpages.length; i++ ) {
376 if ( Object.prototype.hasOwnProperty.call( pages, subpages[ i ].key ) ) {
377 checkPages.push( pages[ subpages[ i ].key ] );
378 }
379 }
380 }
381 },
382
383 /**
384 * Test an API boolean
385 *
386 * @param {Mixed} value
387 * @return {boolean}
388 */
389 apiBool: function ( value ) {
390 return value !== undefined && value !== false;
391 },
392
393 /**
394 * Create a widget for a parameter.
395 *
396 * @param {Object} pi Parameter info from API
397 * @param {Object} opts Additional options
398 * @return {OO.ui.Widget}
399 */
400 createWidgetForParameter: function ( pi, opts ) {
401 var widget, innerWidget, finalWidget, items, $content, func,
402 multiModeButton = null,
403 multiModeInput = null,
404 multiModeAllowed = false;
405
406 opts = opts || {};
407
408 switch ( pi.type ) {
409 case 'boolean':
410 widget = new OO.ui.ToggleSwitchWidget();
411 widget.paramInfo = pi;
412 $.extend( widget, WidgetMethods.toggleSwitchWidget );
413 pi.required = true; // Avoid wrapping in the non-required widget
414 break;
415
416 case 'string':
417 case 'user':
418 if ( Util.apiBool( pi.multi ) ) {
419 widget = new OO.ui.TagMultiselectWidget( {
420 allowArbitrary: true,
421 allowDuplicates: Util.apiBool( pi.allowsduplicates ),
422 $overlay: true
423 } );
424 widget.paramInfo = pi;
425 $.extend( widget, WidgetMethods.tagWidget );
426 } else {
427 widget = new OO.ui.TextInputWidget( {
428 required: Util.apiBool( pi.required )
429 } );
430 }
431 if ( !Util.apiBool( pi.multi ) ) {
432 widget.paramInfo = pi;
433 $.extend( widget, WidgetMethods.textInputWidget );
434 widget.setValidation( Validators.generic );
435 }
436 if ( pi.tokentype ) {
437 widget.paramInfo = pi;
438 $.extend( widget, WidgetMethods.textInputWidget );
439 $.extend( widget, WidgetMethods.tokenWidget );
440 }
441 break;
442
443 case 'text':
444 widget = new OO.ui.MultilineTextInputWidget( {
445 required: Util.apiBool( pi.required )
446 } );
447 widget.paramInfo = pi;
448 $.extend( widget, WidgetMethods.textInputWidget );
449 widget.setValidation( Validators.generic );
450 break;
451
452 case 'password':
453 widget = new OO.ui.TextInputWidget( {
454 type: 'password',
455 required: Util.apiBool( pi.required )
456 } );
457 widget.paramInfo = pi;
458 $.extend( widget, WidgetMethods.textInputWidget );
459 $.extend( widget, WidgetMethods.passwordWidget );
460 widget.setValidation( Validators.generic );
461 multiModeAllowed = true;
462 multiModeInput = widget;
463 break;
464
465 case 'integer':
466 widget = new OO.ui.NumberInputWidget( {
467 required: Util.apiBool( pi.required ),
468 isInteger: true
469 } );
470 widget.setIcon = widget.input.setIcon.bind( widget.input );
471 widget.setTitle = widget.input.setTitle.bind( widget.input );
472 widget.getValidity = widget.input.getValidity.bind( widget.input );
473 widget.paramInfo = pi;
474 $.extend( widget, WidgetMethods.textInputWidget );
475 if ( Util.apiBool( pi.enforcerange ) ) {
476 widget.setRange( pi.min || -Infinity, pi.max || Infinity );
477 }
478 multiModeAllowed = true;
479 multiModeInput = widget;
480 break;
481
482 case 'limit':
483 widget = new OO.ui.TextInputWidget( {
484 required: Util.apiBool( pi.required )
485 } );
486 widget.setValidation( function ( value ) {
487 var n, pi = this.paramInfo;
488
489 if ( value === 'max' ) {
490 return true;
491 } else {
492 n = +value;
493 return !isNaN( n ) && isFinite( n ) &&
494 Math.floor( n ) === n &&
495 n >= pi.min && n <= pi.apiSandboxMax;
496 }
497 } );
498 pi.min = pi.min || 0;
499 pi.apiSandboxMax = mw.config.get( 'apihighlimits' ) ? pi.highmax : pi.max;
500 widget.paramInfo = pi;
501 $.extend( widget, WidgetMethods.textInputWidget );
502 multiModeAllowed = true;
503 multiModeInput = widget;
504 break;
505
506 case 'timestamp':
507 widget = new mw.widgets.datetime.DateTimeInputWidget( {
508 formatter: {
509 format: '${year|0}-${month|0}-${day|0}T${hour|0}:${minute|0}:${second|0}${zone|short}'
510 },
511 required: Util.apiBool( pi.required ),
512 clearable: false
513 } );
514 widget.paramInfo = pi;
515 $.extend( widget, WidgetMethods.textInputWidget );
516 $.extend( widget, WidgetMethods.dateTimeInputWidget );
517 multiModeAllowed = true;
518 break;
519
520 case 'upload':
521 widget = new OO.ui.SelectFileWidget();
522 widget.paramInfo = pi;
523 $.extend( widget, WidgetMethods.uploadWidget );
524 break;
525
526 case 'namespace':
527 // eslint-disable-next-line no-jquery/no-map-util
528 items = $.map( mw.config.get( 'wgFormattedNamespaces' ), function ( name, ns ) {
529 if ( ns === '0' ) {
530 name = mw.message( 'blanknamespace' ).text();
531 }
532 return new OO.ui.MenuOptionWidget( { data: ns, label: name } );
533 } ).sort( function ( a, b ) {
534 return a.data - b.data;
535 } );
536 if ( Util.apiBool( pi.multi ) ) {
537 if ( pi.allspecifier !== undefined ) {
538 items.unshift( new OO.ui.MenuOptionWidget( {
539 data: pi.allspecifier,
540 label: mw.message( 'apisandbox-multivalue-all-namespaces', pi.allspecifier ).text()
541 } ) );
542 }
543
544 widget = new OO.ui.MenuTagMultiselectWidget( {
545 menu: { items: items },
546 $overlay: true
547 } );
548 widget.paramInfo = pi;
549 $.extend( widget, WidgetMethods.tagWidget );
550 } else {
551 widget = new OO.ui.DropdownWidget( {
552 menu: { items: items },
553 $overlay: true
554 } );
555 widget.paramInfo = pi;
556 $.extend( widget, WidgetMethods.dropdownWidget );
557 }
558 break;
559
560 default:
561 if ( !Array.isArray( pi.type ) ) {
562 throw new Error( 'Unknown parameter type ' + pi.type );
563 }
564
565 items = pi.type.map( function ( v ) {
566 var config = {
567 data: String( v ),
568 label: String( v ),
569 classes: []
570 };
571 if ( pi.deprecatedvalues && pi.deprecatedvalues.indexOf( v ) >= 0 ) {
572 config.classes.push( 'apihelp-deprecated-value' );
573 }
574 return new OO.ui.MenuOptionWidget( config );
575 } );
576 if ( Util.apiBool( pi.multi ) ) {
577 if ( pi.allspecifier !== undefined ) {
578 items.unshift( new OO.ui.MenuOptionWidget( {
579 data: pi.allspecifier,
580 label: mw.message( 'apisandbox-multivalue-all-values', pi.allspecifier ).text()
581 } ) );
582 }
583
584 widget = new OO.ui.MenuTagMultiselectWidget( {
585 menu: { items: items },
586 $overlay: true
587 } );
588 widget.paramInfo = pi;
589 $.extend( widget, WidgetMethods.tagWidget );
590 if ( Util.apiBool( pi.submodules ) ) {
591 widget.getSubmodules = WidgetMethods.submoduleWidget.multi;
592 widget.on( 'change', ApiSandbox.updateUI );
593 }
594 } else {
595 widget = new OO.ui.DropdownWidget( {
596 menu: { items: items },
597 $overlay: true
598 } );
599 widget.paramInfo = pi;
600 $.extend( widget, WidgetMethods.dropdownWidget );
601 if ( Util.apiBool( pi.submodules ) ) {
602 widget.getSubmodules = WidgetMethods.submoduleWidget.single;
603 widget.getMenu().on( 'select', ApiSandbox.updateUI );
604 }
605 if ( pi.deprecatedvalues ) {
606 widget.getMenu().on( 'select', function ( item ) {
607 this.$element.toggleClass(
608 'apihelp-deprecated-value',
609 pi.deprecatedvalues.indexOf( item.data ) >= 0
610 );
611 }, [], widget );
612 }
613 }
614
615 break;
616 }
617
618 if ( Util.apiBool( pi.multi ) && multiModeAllowed ) {
619 innerWidget = widget;
620
621 multiModeButton = new OO.ui.ButtonWidget( {
622 label: mw.message( 'apisandbox-add-multi' ).text()
623 } );
624 $content = innerWidget.$element.add( multiModeButton.$element );
625
626 widget = new OO.ui.PopupTagMultiselectWidget( {
627 allowArbitrary: true,
628 allowDuplicates: Util.apiBool( pi.allowsduplicates ),
629 $overlay: true,
630 popup: {
631 classes: [ 'mw-apisandbox-popup' ],
632 padded: true,
633 $content: $content
634 }
635 } );
636 widget.paramInfo = pi;
637 $.extend( widget, WidgetMethods.tagWidget );
638
639 func = function () {
640 if ( !innerWidget.isDisabled() ) {
641 innerWidget.apiCheckValid().done( function ( ok ) {
642 if ( ok ) {
643 widget.addTag( innerWidget.getApiValue() );
644 innerWidget.setApiValue( undefined );
645 }
646 } );
647 return false;
648 }
649 };
650
651 if ( multiModeInput ) {
652 multiModeInput.on( 'enter', func );
653 }
654 multiModeButton.on( 'click', func );
655 }
656
657 if ( Util.apiBool( pi.required ) || opts.nooptional ) {
658 finalWidget = widget;
659 } else {
660 finalWidget = new OptionalWidget( widget );
661 finalWidget.paramInfo = pi;
662 $.extend( finalWidget, WidgetMethods.optionalWidget );
663 if ( widget.getSubmodules ) {
664 finalWidget.getSubmodules = widget.getSubmodules.bind( widget );
665 finalWidget.on( 'disable', function () {
666 setTimeout( ApiSandbox.updateUI );
667 } );
668 }
669 if ( widget.getApiValueForTemplates ) {
670 finalWidget.getApiValueForTemplates = widget.getApiValueForTemplates.bind( widget );
671 }
672 finalWidget.setDisabled( true );
673 }
674
675 widget.setApiValue( pi.default );
676
677 return finalWidget;
678 },
679
680 /**
681 * Parse an HTML string and call Util.fixupHTML()
682 *
683 * @param {string} html HTML to parse
684 * @return {jQuery}
685 */
686 parseHTML: function ( html ) {
687 var $ret = $( $.parseHTML( html ) );
688 return Util.fixupHTML( $ret );
689 },
690
691 /**
692 * Parse an i18n message and call Util.fixupHTML()
693 *
694 * @param {string} key Key of message to get
695 * @param {...Mixed} parameters Values for $N replacements
696 * @return {jQuery}
697 */
698 parseMsg: function () {
699 var $ret = mw.message.apply( mw.message, arguments ).parseDom();
700 return Util.fixupHTML( $ret );
701 },
702
703 /**
704 * Fix HTML for ApiSandbox display
705 *
706 * Fixes are:
707 * - Add target="_blank" to any links
708 *
709 * @param {jQuery} $html DOM to process
710 * @return {jQuery}
711 */
712 fixupHTML: function ( $html ) {
713 $html.filter( 'a' ).add( $html.find( 'a' ) )
714 .filter( '[href]:not([target])' )
715 .attr( 'target', '_blank' );
716 return $html;
717 },
718
719 /**
720 * Format a request and return a bunch of menu option widgets
721 *
722 * @param {Object} displayParams Query parameters, sanitized for display.
723 * @param {Object} rawParams Query parameters. You should probably use displayParams instead.
724 * @return {OO.ui.MenuOptionWidget[]} Each item's data should be an OO.ui.FieldLayout
725 */
726 formatRequest: function ( displayParams, rawParams ) {
727 var jsonLayout,
728 items = [
729 new OO.ui.MenuOptionWidget( {
730 label: Util.parseMsg( 'apisandbox-request-format-url-label' ),
731 data: new mw.widgets.CopyTextLayout( {
732 label: Util.parseMsg( 'apisandbox-request-url-label' ),
733 copyText: mw.util.wikiScript( 'api' ) + '?' + $.param( displayParams )
734 } )
735 } ),
736 new OO.ui.MenuOptionWidget( {
737 label: Util.parseMsg( 'apisandbox-request-format-json-label' ),
738 data: jsonLayout = new mw.widgets.CopyTextLayout( {
739 label: Util.parseMsg( 'apisandbox-request-json-label' ),
740 copyText: JSON.stringify( displayParams, null, '\t' ),
741 multiline: true,
742 textInput: {
743 classes: [ 'mw-apisandbox-textInputCode' ],
744 autosize: true,
745 maxRows: 6
746 }
747 } ).on( 'toggle', function ( visible ) {
748 if ( visible ) {
749 // Call updatePosition instead of adjustSize
750 // because the latter has weird caching
751 // behavior and the former bypasses it.
752 jsonLayout.textInput.updatePosition();
753 }
754 } )
755 } )
756 ];
757
758 mw.hook( 'apisandbox.formatRequest' ).fire( items, displayParams, rawParams );
759
760 return items;
761 },
762
763 /**
764 * Event handler for when formatDropdown's selection changes
765 */
766 onFormatDropdownChange: function () {
767 var i,
768 menu = formatDropdown.getMenu(),
769 items = menu.getItems(),
770 selectedField = menu.findSelectedItem() ? menu.findSelectedItem().getData() : null;
771
772 for ( i = 0; i < items.length; i++ ) {
773 items[ i ].getData().toggle( items[ i ].getData() === selectedField );
774 }
775 }
776 };
777
778 /**
779 * Interface to ApiSandbox UI
780 *
781 * @class mw.special.ApiSandbox
782 */
783 ApiSandbox = {
784 /**
785 * Initialize the UI
786 *
787 * Automatically called on $.ready()
788 */
789 init: function () {
790 var $toolbar;
791
792 $content = $( '#mw-apisandbox' );
793
794 windowManager = new OO.ui.WindowManager();
795 $( 'body' ).append( windowManager.$element );
796 windowManager.addWindows( {
797 errorAlert: new OO.ui.MessageDialog()
798 } );
799
800 $toolbar = $( '<div>' )
801 .addClass( 'mw-apisandbox-toolbar' )
802 .append(
803 new OO.ui.ButtonWidget( {
804 label: mw.message( 'apisandbox-submit' ).text(),
805 flags: [ 'primary', 'progressive' ]
806 } ).on( 'click', ApiSandbox.sendRequest ).$element,
807 new OO.ui.ButtonWidget( {
808 label: mw.message( 'apisandbox-reset' ).text(),
809 flags: 'destructive'
810 } ).on( 'click', ApiSandbox.resetUI ).$element
811 );
812
813 booklet = new OO.ui.BookletLayout( {
814 expanded: false,
815 outlined: true,
816 autoFocus: false
817 } );
818
819 panel = new OO.ui.PanelLayout( {
820 classes: [ 'mw-apisandbox-container' ],
821 content: [ booklet ],
822 expanded: false,
823 framed: true
824 } );
825
826 pages.main = new ApiSandbox.PageLayout( { key: 'main', path: 'main' } );
827
828 // Parse the current hash string
829 if ( !ApiSandbox.loadFromHash() ) {
830 ApiSandbox.updateUI();
831 }
832
833 $( window ).on( 'hashchange', ApiSandbox.loadFromHash );
834
835 $content
836 .empty()
837 .append( $( '<p>' ).append( Util.parseMsg( 'apisandbox-intro' ) ) )
838 .append(
839 $( '<div>' ).attr( 'id', 'mw-apisandbox-ui' )
840 .append( $toolbar )
841 .append( panel.$element )
842 );
843 },
844
845 /**
846 * Update the current query when the page hash changes
847 *
848 * @return {boolean} Successful
849 */
850 loadFromHash: function () {
851 var params, m, re,
852 hash = location.hash;
853
854 if ( oldhash === hash ) {
855 return false;
856 }
857 oldhash = hash;
858 if ( hash === '' ) {
859 return false;
860 }
861
862 // I'm surprised this doesn't seem to exist in jQuery or mw.util.
863 params = {};
864 hash = hash.replace( /\+/g, '%20' );
865 re = /([^&=#]+)=?([^&#]*)/g;
866 while ( ( m = re.exec( hash ) ) ) {
867 params[ decodeURIComponent( m[ 1 ] ) ] = decodeURIComponent( m[ 2 ] );
868 }
869
870 ApiSandbox.updateUI( params );
871 return true;
872 },
873
874 /**
875 * Update the pages in the booklet
876 *
877 * @param {Object} [params] Optional query parameters to load
878 */
879 updateUI: function ( params ) {
880 var i, page, subpages, j, removePages,
881 addPages = [];
882
883 if ( !$.isPlainObject( params ) ) {
884 params = undefined;
885 }
886
887 if ( updatingBooklet ) {
888 return;
889 }
890 updatingBooklet = true;
891 try {
892 if ( params !== undefined ) {
893 pages.main.loadQueryParams( params );
894 }
895 addPages.push( pages.main );
896 if ( resultPage !== null ) {
897 addPages.push( resultPage );
898 }
899 pages.main.apiCheckValid();
900
901 i = 0;
902 while ( addPages.length ) {
903 page = addPages.shift();
904 if ( bookletPages[ i ] !== page ) {
905 for ( j = i; j < bookletPages.length; j++ ) {
906 if ( bookletPages[ j ].getName() === page.getName() ) {
907 bookletPages.splice( j, 1 );
908 }
909 }
910 bookletPages.splice( i, 0, page );
911 booklet.addPages( [ page ], i );
912 }
913 i++;
914
915 if ( page.getSubpages ) {
916 subpages = page.getSubpages();
917 for ( j = 0; j < subpages.length; j++ ) {
918 if ( !Object.prototype.hasOwnProperty.call( pages, subpages[ j ].key ) ) {
919 subpages[ j ].indentLevel = page.indentLevel + 1;
920 pages[ subpages[ j ].key ] = new ApiSandbox.PageLayout( subpages[ j ] );
921 }
922 if ( params !== undefined ) {
923 pages[ subpages[ j ].key ].loadQueryParams( params );
924 }
925 addPages.splice( j, 0, pages[ subpages[ j ].key ] );
926 pages[ subpages[ j ].key ].apiCheckValid();
927 }
928 }
929 }
930
931 if ( bookletPages.length > i ) {
932 removePages = bookletPages.splice( i, bookletPages.length - i );
933 booklet.removePages( removePages );
934 }
935
936 if ( !booklet.getCurrentPageName() ) {
937 booklet.selectFirstSelectablePage();
938 }
939 } finally {
940 updatingBooklet = false;
941 }
942 },
943
944 /**
945 * Reset button handler
946 */
947 resetUI: function () {
948 suppressErrors = true;
949 pages = {
950 main: new ApiSandbox.PageLayout( { key: 'main', path: 'main' } )
951 };
952 resultPage = null;
953 ApiSandbox.updateUI();
954 },
955
956 /**
957 * Submit button handler
958 *
959 * @param {Object} [params] Use this set of params instead of those in the form fields.
960 * The form fields will be updated to match.
961 */
962 sendRequest: function ( params ) {
963 var page, subpages, i, query, $result, $focus,
964 progress, $progressText, progressLoading,
965 deferreds = [],
966 paramsAreForced = !!params,
967 displayParams = {},
968 tokenWidgets = [],
969 checkPages = [ pages.main ];
970
971 // Blur any focused widget before submit, because
972 // OO.ui.ButtonWidget doesn't take focus itself (T128054)
973 $focus = $( '#mw-apisandbox-ui' ).find( document.activeElement );
974 if ( $focus.length ) {
975 $focus[ 0 ].blur();
976 }
977
978 suppressErrors = false;
979
980 // save widget state in params (or load from it if we are forced)
981 if ( paramsAreForced ) {
982 ApiSandbox.updateUI( params );
983 }
984 params = {};
985 while ( checkPages.length ) {
986 page = checkPages.shift();
987 if ( page.tokenWidget ) {
988 tokenWidgets.push( page.tokenWidget );
989 }
990 deferreds = deferreds.concat( page.apiCheckValid() );
991 page.getQueryParams( params, displayParams );
992 subpages = page.getSubpages();
993 for ( i = 0; i < subpages.length; i++ ) {
994 if ( Object.prototype.hasOwnProperty.call( pages, subpages[ i ].key ) ) {
995 checkPages.push( pages[ subpages[ i ].key ] );
996 }
997 }
998 }
999
1000 if ( !paramsAreForced ) {
1001 // forced params means we are continuing a query; the base query should be preserved
1002 baseRequestParams = $.extend( {}, params );
1003 }
1004
1005 $.when.apply( $, deferreds ).done( function () {
1006 var formatItems, menu, selectedLabel, deferred, actions, errorCount;
1007
1008 // Count how many times `value` occurs in `array`.
1009 function countValues( value, array ) {
1010 var count, i;
1011 count = 0;
1012 for ( i = 0; i < array.length; i++ ) {
1013 if ( array[ i ] === value ) {
1014 count++;
1015 }
1016 }
1017 return count;
1018 }
1019
1020 errorCount = countValues( false, arguments );
1021 if ( errorCount > 0 ) {
1022 actions = [
1023 {
1024 action: 'accept',
1025 label: OO.ui.msg( 'ooui-dialog-process-dismiss' ),
1026 flags: 'primary'
1027 }
1028 ];
1029 if ( tokenWidgets.length ) {
1030 // Check all token widgets' validity separately
1031 deferred = $.when.apply( $, tokenWidgets.map( function ( w ) {
1032 return w.apiCheckValid();
1033 } ) );
1034
1035 deferred.done( function () {
1036 // If only the tokens are invalid, offer to fix them
1037 var tokenErrorCount = countValues( false, arguments );
1038 if ( tokenErrorCount === errorCount ) {
1039 delete actions[ 0 ].flags;
1040 actions.push( {
1041 action: 'fix',
1042 label: mw.message( 'apisandbox-results-fixtoken' ).text(),
1043 flags: 'primary'
1044 } );
1045 }
1046 } );
1047 } else {
1048 deferred = $.Deferred().resolve();
1049 }
1050 deferred.always( function () {
1051 windowManager.openWindow( 'errorAlert', {
1052 title: Util.parseMsg( 'apisandbox-submit-invalid-fields-title' ),
1053 message: Util.parseMsg( 'apisandbox-submit-invalid-fields-message' ),
1054 actions: actions
1055 } ).closed.then( function ( data ) {
1056 if ( data && data.action === 'fix' ) {
1057 ApiSandbox.fixTokenAndResend();
1058 }
1059 } );
1060 } );
1061 return;
1062 }
1063
1064 query = $.param( displayParams );
1065
1066 formatItems = Util.formatRequest( displayParams, params );
1067
1068 // Force a 'fm' format with wrappedhtml=1, if available
1069 if ( params.format !== undefined ) {
1070 if ( Object.prototype.hasOwnProperty.call( availableFormats, params.format + 'fm' ) ) {
1071 params.format = params.format + 'fm';
1072 }
1073 if ( params.format.substr( -2 ) === 'fm' ) {
1074 params.wrappedhtml = 1;
1075 }
1076 }
1077
1078 progressLoading = false;
1079 $progressText = $( '<span>' ).text( mw.message( 'apisandbox-sending-request' ).text() );
1080 progress = new OO.ui.ProgressBarWidget( {
1081 progress: false,
1082 $content: $progressText
1083 } );
1084
1085 $result = $( '<div>' )
1086 .append( progress.$element );
1087
1088 resultPage = page = new OO.ui.PageLayout( '|results|', { expanded: false } );
1089 page.setupOutlineItem = function () {
1090 this.outlineItem.setLabel( mw.message( 'apisandbox-results' ).text() );
1091 };
1092
1093 if ( !formatDropdown ) {
1094 formatDropdown = new OO.ui.DropdownWidget( {
1095 menu: { items: [] },
1096 $overlay: true
1097 } );
1098 formatDropdown.getMenu().on( 'select', Util.onFormatDropdownChange );
1099 }
1100
1101 menu = formatDropdown.getMenu();
1102 selectedLabel = menu.findSelectedItem() ? menu.findSelectedItem().getLabel() : '';
1103 if ( typeof selectedLabel !== 'string' ) {
1104 selectedLabel = selectedLabel.text();
1105 }
1106 menu.clearItems().addItems( formatItems );
1107 menu.chooseItem( menu.getItemFromLabel( selectedLabel ) || menu.findFirstSelectableItem() );
1108
1109 // Fire the event to update field visibilities
1110 Util.onFormatDropdownChange();
1111
1112 page.$element.empty()
1113 .append(
1114 new OO.ui.FieldLayout(
1115 formatDropdown, {
1116 label: Util.parseMsg( 'apisandbox-request-selectformat-label' )
1117 }
1118 ).$element,
1119 formatItems.map( function ( item ) {
1120 return item.getData().$element;
1121 } ),
1122 $result
1123 );
1124 ApiSandbox.updateUI();
1125 booklet.setPage( '|results|' );
1126
1127 location.href = oldhash = '#' + query;
1128
1129 api.post( params, {
1130 contentType: 'multipart/form-data',
1131 dataType: 'text',
1132 xhr: function () {
1133 var xhr = new window.XMLHttpRequest();
1134 xhr.upload.addEventListener( 'progress', function ( e ) {
1135 if ( !progressLoading ) {
1136 if ( e.lengthComputable ) {
1137 progress.setProgress( e.loaded * 100 / e.total );
1138 } else {
1139 progress.setProgress( false );
1140 }
1141 }
1142 } );
1143 xhr.addEventListener( 'progress', function ( e ) {
1144 if ( !progressLoading ) {
1145 progressLoading = true;
1146 $progressText.text( mw.message( 'apisandbox-loading-results' ).text() );
1147 }
1148 if ( e.lengthComputable ) {
1149 progress.setProgress( e.loaded * 100 / e.total );
1150 } else {
1151 progress.setProgress( false );
1152 }
1153 } );
1154 return xhr;
1155 }
1156 } )
1157 .catch( function ( code, data, result, jqXHR ) {
1158 var deferred = $.Deferred();
1159
1160 if ( code !== 'http' ) {
1161 // Not really an error, work around mw.Api thinking it is.
1162 deferred.resolve( result, jqXHR );
1163 } else {
1164 // Just forward it.
1165 deferred.reject.apply( deferred, arguments );
1166 }
1167 return deferred.promise();
1168 } )
1169 .then( function ( data, jqXHR ) {
1170 var m, loadTime, button, clear,
1171 ct = jqXHR.getResponseHeader( 'Content-Type' ),
1172 loginSuppressed = jqXHR.getResponseHeader( 'MediaWiki-Login-Suppressed' ) || 'false';
1173
1174 $result.empty();
1175 if ( loginSuppressed !== 'false' ) {
1176 $( '<div>' )
1177 .addClass( 'warning' )
1178 .append( Util.parseMsg( 'apisandbox-results-login-suppressed' ) )
1179 .appendTo( $result );
1180 }
1181 if ( /^text\/mediawiki-api-prettyprint-wrapped(?:;|$)/.test( ct ) ) {
1182 data = JSON.parse( data );
1183 if ( data.modules.length ) {
1184 mw.loader.load( data.modules );
1185 }
1186 if ( data.status && data.status !== 200 ) {
1187 $( '<div>' )
1188 .addClass( 'api-pretty-header api-pretty-status' )
1189 .append( Util.parseMsg( 'api-format-prettyprint-status', data.status, data.statustext ) )
1190 .appendTo( $result );
1191 }
1192 $result.append( Util.parseHTML( data.html ) );
1193 loadTime = data.time;
1194 } else if ( ( m = data.match( /<pre[ >][\s\S]*<\/pre>/ ) ) ) {
1195 $result.append( Util.parseHTML( m[ 0 ] ) );
1196 if ( ( m = data.match( /"wgBackendResponseTime":\s*(\d+)/ ) ) ) {
1197 loadTime = parseInt( m[ 1 ], 10 );
1198 }
1199 } else {
1200 $( '<pre>' )
1201 .addClass( 'api-pretty-content' )
1202 .text( data )
1203 .appendTo( $result );
1204 }
1205 if ( paramsAreForced || data.continue ) {
1206 $result.append(
1207 $( '<div>' ).append(
1208 new OO.ui.ButtonWidget( {
1209 label: mw.message( 'apisandbox-continue' ).text()
1210 } ).on( 'click', function () {
1211 ApiSandbox.sendRequest( $.extend( {}, baseRequestParams, data.continue ) );
1212 } ).setDisabled( !data.continue ).$element,
1213 ( clear = new OO.ui.ButtonWidget( {
1214 label: mw.message( 'apisandbox-continue-clear' ).text()
1215 } ).on( 'click', function () {
1216 ApiSandbox.updateUI( baseRequestParams );
1217 clear.setDisabled( true );
1218 booklet.setPage( '|results|' );
1219 } ).setDisabled( !paramsAreForced ) ).$element,
1220 new OO.ui.PopupButtonWidget( {
1221 $overlay: true,
1222 framed: false,
1223 icon: 'info',
1224 popup: {
1225 $content: $( '<div>' ).append( Util.parseMsg( 'apisandbox-continue-help' ) ),
1226 padded: true,
1227 width: 'auto'
1228 }
1229 } ).$element
1230 )
1231 );
1232 }
1233 if ( typeof loadTime === 'number' ) {
1234 $result.append(
1235 $( '<div>' ).append(
1236 new OO.ui.LabelWidget( {
1237 label: mw.message( 'apisandbox-request-time', loadTime ).text()
1238 } ).$element
1239 )
1240 );
1241 }
1242
1243 if ( jqXHR.getResponseHeader( 'MediaWiki-API-Error' ) === 'badtoken' ) {
1244 // Flush all saved tokens in case one of them is the bad one.
1245 Util.markTokensBad();
1246 button = new OO.ui.ButtonWidget( {
1247 label: mw.message( 'apisandbox-results-fixtoken' ).text()
1248 } );
1249 button.on( 'click', ApiSandbox.fixTokenAndResend )
1250 .on( 'click', button.setDisabled, [ true ], button )
1251 .$element.appendTo( $result );
1252 }
1253 }, function ( code, data ) {
1254 var details = 'HTTP error: ' + data.exception;
1255 $result.empty()
1256 .append(
1257 new OO.ui.LabelWidget( {
1258 label: mw.message( 'apisandbox-results-error', details ).text(),
1259 classes: [ 'error' ]
1260 } ).$element
1261 );
1262 } );
1263 } );
1264 },
1265
1266 /**
1267 * Handler for the "Correct token and resubmit" button
1268 *
1269 * Used on a 'badtoken' error, it re-fetches token parameters for all
1270 * pages and then re-submits the query.
1271 */
1272 fixTokenAndResend: function () {
1273 var page, subpages, i, k,
1274 ok = true,
1275 tokenWait = { dummy: true },
1276 checkPages = [ pages.main ],
1277 success = function ( k ) {
1278 delete tokenWait[ k ];
1279 if ( ok && $.isEmptyObject( tokenWait ) ) {
1280 ApiSandbox.sendRequest();
1281 }
1282 },
1283 failure = function ( k ) {
1284 delete tokenWait[ k ];
1285 ok = false;
1286 };
1287
1288 while ( checkPages.length ) {
1289 page = checkPages.shift();
1290
1291 if ( page.tokenWidget ) {
1292 k = page.apiModule + page.tokenWidget.paramInfo.name;
1293 tokenWait[ k ] = page.tokenWidget.fetchToken();
1294 tokenWait[ k ]
1295 .done( success.bind( page.tokenWidget, k ) )
1296 .fail( failure.bind( page.tokenWidget, k ) );
1297 }
1298
1299 subpages = page.getSubpages();
1300 for ( i = 0; i < subpages.length; i++ ) {
1301 if ( Object.prototype.hasOwnProperty.call( pages, subpages[ i ].key ) ) {
1302 checkPages.push( pages[ subpages[ i ].key ] );
1303 }
1304 }
1305 }
1306
1307 success( 'dummy', '' );
1308 },
1309
1310 /**
1311 * Reset validity indicators for all widgets
1312 */
1313 updateValidityIndicators: function () {
1314 var page, subpages, i,
1315 checkPages = [ pages.main ];
1316
1317 while ( checkPages.length ) {
1318 page = checkPages.shift();
1319 page.apiCheckValid();
1320 subpages = page.getSubpages();
1321 for ( i = 0; i < subpages.length; i++ ) {
1322 if ( Object.prototype.hasOwnProperty.call( pages, subpages[ i ].key ) ) {
1323 checkPages.push( pages[ subpages[ i ].key ] );
1324 }
1325 }
1326 }
1327 }
1328 };
1329
1330 /**
1331 * PageLayout for API modules
1332 *
1333 * @class
1334 * @private
1335 * @extends OO.ui.PageLayout
1336 * @constructor
1337 * @param {Object} [config] Configuration options
1338 */
1339 ApiSandbox.PageLayout = function ( config ) {
1340 config = $.extend( { prefix: '', expanded: false }, config );
1341 this.displayText = config.key;
1342 this.apiModule = config.path;
1343 this.prefix = config.prefix;
1344 this.paramInfo = null;
1345 this.apiIsValid = true;
1346 this.loadFromQueryParams = null;
1347 this.widgets = {};
1348 this.itemsFieldset = null;
1349 this.deprecatedItemsFieldset = null;
1350 this.templatedItemsCache = {};
1351 this.tokenWidget = null;
1352 this.indentLevel = config.indentLevel ? config.indentLevel : 0;
1353 ApiSandbox.PageLayout.super.call( this, config.key, config );
1354 this.loadParamInfo();
1355 };
1356 OO.inheritClass( ApiSandbox.PageLayout, OO.ui.PageLayout );
1357 ApiSandbox.PageLayout.prototype.setupOutlineItem = function () {
1358 this.outlineItem.setLevel( this.indentLevel );
1359 this.outlineItem.setLabel( this.displayText );
1360 this.outlineItem.setIcon( this.apiIsValid || suppressErrors ? null : 'alert' );
1361 this.outlineItem.setTitle(
1362 this.apiIsValid || suppressErrors ? '' : mw.message( 'apisandbox-alert-page' ).plain()
1363 );
1364 };
1365
1366 function widgetLabelOnClick() {
1367 var f = this.getField();
1368 if ( typeof f.setDisabled === 'function' ) {
1369 f.setDisabled( false );
1370 }
1371 if ( typeof f.focus === 'function' ) {
1372 f.focus();
1373 }
1374 }
1375
1376 /**
1377 * Create a widget and the FieldLayouts it needs
1378 * @private
1379 * @param {Object} ppi API paraminfo data for the parameter
1380 * @param {string} name API parameter name
1381 * @return {Object}
1382 * @return {OO.ui.Widget} return.widget
1383 * @return {OO.ui.FieldLayout} return.widgetField
1384 * @return {OO.ui.FieldLayout} return.helpField
1385 */
1386 ApiSandbox.PageLayout.prototype.makeWidgetFieldLayouts = function ( ppi, name ) {
1387 var j, l, widget, descriptionContainer, tmp, flag, count, button, widgetField, helpField, layoutConfig;
1388
1389 widget = Util.createWidgetForParameter( ppi );
1390 if ( ppi.tokentype ) {
1391 this.tokenWidget = widget;
1392 }
1393 if ( this.paramInfo.templatedparameters.length ) {
1394 widget.on( 'change', this.updateTemplatedParameters, [ null ], this );
1395 }
1396
1397 descriptionContainer = $( '<div>' );
1398
1399 tmp = Util.parseHTML( ppi.description );
1400 tmp.filter( 'dl' ).makeCollapsible( {
1401 collapsed: true
1402 } ).children( '.mw-collapsible-toggle' ).each( function () {
1403 var $this = $( this );
1404 $this.parent().prev( 'p' ).append( $this );
1405 } );
1406 descriptionContainer.append( $( '<div>' ).addClass( 'description' ).append( tmp ) );
1407
1408 if ( ppi.info && ppi.info.length ) {
1409 for ( j = 0; j < ppi.info.length; j++ ) {
1410 descriptionContainer.append( $( '<div>' )
1411 .addClass( 'info' )
1412 .append( Util.parseHTML( ppi.info[ j ] ) )
1413 );
1414 }
1415 }
1416 flag = true;
1417 count = Infinity;
1418 switch ( ppi.type ) {
1419 case 'namespace':
1420 flag = false;
1421 count = mw.config.get( 'wgFormattedNamespaces' ).length;
1422 break;
1423
1424 case 'limit':
1425 if ( ppi.highmax !== undefined ) {
1426 descriptionContainer.append( $( '<div>' )
1427 .addClass( 'info' )
1428 .append(
1429 Util.parseMsg(
1430 'api-help-param-limit2', ppi.max, ppi.highmax
1431 ),
1432 ' ',
1433 Util.parseMsg( 'apisandbox-param-limit' )
1434 )
1435 );
1436 } else {
1437 descriptionContainer.append( $( '<div>' )
1438 .addClass( 'info' )
1439 .append(
1440 Util.parseMsg( 'api-help-param-limit', ppi.max ),
1441 ' ',
1442 Util.parseMsg( 'apisandbox-param-limit' )
1443 )
1444 );
1445 }
1446 break;
1447
1448 case 'integer':
1449 tmp = '';
1450 if ( ppi.min !== undefined ) {
1451 tmp += 'min';
1452 }
1453 if ( ppi.max !== undefined ) {
1454 tmp += 'max';
1455 }
1456 if ( tmp !== '' ) {
1457 descriptionContainer.append( $( '<div>' )
1458 .addClass( 'info' )
1459 .append( Util.parseMsg(
1460 'api-help-param-integer-' + tmp,
1461 Util.apiBool( ppi.multi ) ? 2 : 1,
1462 ppi.min, ppi.max
1463 ) )
1464 );
1465 }
1466 break;
1467
1468 default:
1469 if ( Array.isArray( ppi.type ) ) {
1470 flag = false;
1471 count = ppi.type.length;
1472 }
1473 break;
1474 }
1475 if ( Util.apiBool( ppi.multi ) ) {
1476 tmp = [];
1477 if ( flag && !( widget instanceof OO.ui.TagMultiselectWidget ) &&
1478 !(
1479 widget instanceof OptionalWidget &&
1480 widget.widget instanceof OO.ui.TagMultiselectWidget
1481 )
1482 ) {
1483 tmp.push( mw.message( 'api-help-param-multi-separate' ).parse() );
1484 }
1485 if ( count > ppi.lowlimit ) {
1486 tmp.push(
1487 mw.message( 'api-help-param-multi-max', ppi.lowlimit, ppi.highlimit ).parse()
1488 );
1489 }
1490 if ( tmp.length ) {
1491 descriptionContainer.append( $( '<div>' )
1492 .addClass( 'info' )
1493 .append( Util.parseHTML( tmp.join( ' ' ) ) )
1494 );
1495 }
1496 }
1497 if ( 'maxbytes' in ppi ) {
1498 descriptionContainer.append( $( '<div>' )
1499 .addClass( 'info' )
1500 .append( Util.parseMsg( 'api-help-param-maxbytes', ppi.maxbytes ) )
1501 );
1502 }
1503 if ( 'maxchars' in ppi ) {
1504 descriptionContainer.append( $( '<div>' )
1505 .addClass( 'info' )
1506 .append( Util.parseMsg( 'api-help-param-maxchars', ppi.maxchars ) )
1507 );
1508 }
1509 if ( ppi.usedTemplateVars && ppi.usedTemplateVars.length ) {
1510 tmp = $();
1511 for ( j = 0, l = ppi.usedTemplateVars.length; j < l; j++ ) {
1512 tmp = tmp.add( $( '<var>' ).text( ppi.usedTemplateVars[ j ] ) );
1513 if ( j === l - 2 ) {
1514 tmp = tmp.add( mw.message( 'and' ).parseDom() );
1515 tmp = tmp.add( mw.message( 'word-separator' ).parseDom() );
1516 } else if ( j !== l - 1 ) {
1517 tmp = tmp.add( mw.message( 'comma-separator' ).parseDom() );
1518 }
1519 }
1520 descriptionContainer.append( $( '<div>' )
1521 .addClass( 'info' )
1522 .append( Util.parseMsg(
1523 'apisandbox-templated-parameter-reason',
1524 ppi.usedTemplateVars.length,
1525 tmp
1526 ) )
1527 );
1528 }
1529
1530 helpField = new OO.ui.FieldLayout(
1531 new OO.ui.Widget( {
1532 $content: '\xa0',
1533 classes: [ 'mw-apisandbox-spacer' ]
1534 } ), {
1535 align: 'inline',
1536 classes: [ 'mw-apisandbox-help-field' ],
1537 label: descriptionContainer
1538 }
1539 );
1540
1541 layoutConfig = {
1542 align: 'left',
1543 classes: [ 'mw-apisandbox-widget-field' ],
1544 label: name
1545 };
1546
1547 if ( ppi.tokentype ) {
1548 button = new OO.ui.ButtonWidget( {
1549 label: mw.message( 'apisandbox-fetch-token' ).text()
1550 } );
1551 button.on( 'click', widget.fetchToken, [], widget );
1552
1553 widgetField = new OO.ui.ActionFieldLayout( widget, button, layoutConfig );
1554 } else {
1555 widgetField = new OO.ui.FieldLayout( widget, layoutConfig );
1556 }
1557
1558 // We need our own click handler on the widget label to
1559 // turn off the disablement.
1560 widgetField.$label.on( 'click', widgetLabelOnClick.bind( widgetField ) );
1561
1562 // Don't grey out the label when the field is disabled,
1563 // it makes it too hard to read and our "disabled"
1564 // isn't really disabled.
1565 widgetField.onFieldDisable( false );
1566 widgetField.onFieldDisable = function () {};
1567
1568 widgetField.apiParamIndex = ppi.index;
1569
1570 return {
1571 widget: widget,
1572 widgetField: widgetField,
1573 helpField: helpField
1574 };
1575 };
1576
1577 /**
1578 * Update templated parameters in the page
1579 * @private
1580 * @param {Object} [params] Query parameters for initializing the widgets
1581 */
1582 ApiSandbox.PageLayout.prototype.updateTemplatedParameters = function ( params ) {
1583 var p, toProcess, doProcess, tmp, toRemove,
1584 that = this,
1585 pi = this.paramInfo,
1586 prefix = that.prefix + pi.prefix;
1587
1588 if ( !pi || !pi.templatedparameters.length ) {
1589 return;
1590 }
1591
1592 if ( !$.isPlainObject( params ) ) {
1593 params = null;
1594 }
1595
1596 toRemove = {};
1597 // eslint-disable-next-line no-jquery/no-each-util
1598 $.each( this.templatedItemsCache, function ( k, el ) {
1599 if ( el.widget.isElementAttached() ) {
1600 toRemove[ k ] = el;
1601 }
1602 } );
1603
1604 // This bit duplicates the PHP logic in ApiBase::extractRequestParams().
1605 // If you update this, see if that needs updating too.
1606 toProcess = pi.templatedparameters.map( function ( p ) {
1607 return {
1608 name: prefix + p.name,
1609 info: p,
1610 vars: $.extend( {}, p.templatevars ),
1611 usedVars: []
1612 };
1613 } );
1614 doProcess = function ( placeholder, target ) {
1615 var values, container, index, usedVars, done, items, i;
1616
1617 target = prefix + target;
1618
1619 if ( !that.widgets[ target ] ) {
1620 // The target wasn't processed yet, try the next one.
1621 // If all hit this case, the parameter has no expansions.
1622 return true;
1623 }
1624
1625 if ( !that.widgets[ target ].getApiValueForTemplates ) {
1626 // Not a multi-valued widget, so it can't have expansions.
1627 return false;
1628 }
1629
1630 values = that.widgets[ target ].getApiValueForTemplates();
1631 if ( !Array.isArray( values ) || !values.length ) {
1632 // The target was processed but has no (valid) values.
1633 // That means it has no expansions.
1634 return false;
1635 }
1636
1637 // Expand this target in the name and all other targets,
1638 // then requeue if there are more targets left or create the widget
1639 // and add it to the form if all are done.
1640 delete p.vars[ placeholder ];
1641 usedVars = p.usedVars.concat( [ target ] );
1642 placeholder = '{' + placeholder + '}';
1643 done = $.isEmptyObject( p.vars );
1644 if ( done ) {
1645 container = Util.apiBool( p.info.deprecated ) ? that.deprecatedItemsFieldset : that.itemsFieldset;
1646 items = container.getItems();
1647 index = undefined;
1648 for ( i = 0; i < items.length; i++ ) {
1649 if ( items[ i ].apiParamIndex !== undefined && items[ i ].apiParamIndex > p.info.index ) {
1650 index = i;
1651 break;
1652 }
1653 }
1654 }
1655 values.forEach( function ( value ) {
1656 var name, newVars;
1657
1658 if ( !/^[^{}]*$/.exec( value ) ) {
1659 // Skip values that make invalid parameter names
1660 return;
1661 }
1662
1663 name = p.name.replace( placeholder, value );
1664 if ( done ) {
1665 if ( that.templatedItemsCache[ name ] ) {
1666 tmp = that.templatedItemsCache[ name ];
1667 } else {
1668 tmp = that.makeWidgetFieldLayouts(
1669 $.extend( {}, p.info, { usedTemplateVars: usedVars } ), name
1670 );
1671 that.templatedItemsCache[ name ] = tmp;
1672 }
1673 delete toRemove[ name ];
1674 if ( !tmp.widget.isElementAttached() ) {
1675 that.widgets[ name ] = tmp.widget;
1676 container.addItems( [ tmp.widgetField, tmp.helpField ], index );
1677 if ( index !== undefined ) {
1678 index += 2;
1679 }
1680 }
1681 if ( params ) {
1682 tmp.widget.setApiValue( Object.prototype.hasOwnProperty.call( params, name ) ? params[ name ] : undefined );
1683 }
1684 } else {
1685 newVars = {};
1686 // eslint-disable-next-line no-jquery/no-each-util
1687 $.each( p.vars, function ( k, v ) {
1688 newVars[ k ] = v.replace( placeholder, value );
1689 } );
1690 toProcess.push( {
1691 name: name,
1692 info: p.info,
1693 vars: newVars,
1694 usedVars: usedVars
1695 } );
1696 }
1697 } );
1698 return false;
1699 };
1700 while ( toProcess.length ) {
1701 p = toProcess.shift();
1702 // eslint-disable-next-line no-jquery/no-each-util
1703 $.each( p.vars, doProcess );
1704 }
1705
1706 // eslint-disable-next-line no-jquery/no-map-util
1707 toRemove = $.map( toRemove, function ( el, name ) {
1708 delete that.widgets[ name ];
1709 return [ el.widgetField, el.helpField ];
1710 } );
1711 if ( toRemove.length ) {
1712 this.itemsFieldset.removeItems( toRemove );
1713 this.deprecatedItemsFieldset.removeItems( toRemove );
1714 }
1715 };
1716
1717 /**
1718 * Fetch module information for this page's module, then create UI
1719 */
1720 ApiSandbox.PageLayout.prototype.loadParamInfo = function () {
1721 var dynamicFieldset, dynamicParamNameWidget,
1722 that = this,
1723 removeDynamicParamWidget = function ( name, layout ) {
1724 dynamicFieldset.removeItems( [ layout ] );
1725 delete that.widgets[ name ];
1726 },
1727 addDynamicParamWidget = function () {
1728 var name, layout, widget, button;
1729
1730 // Check name is filled in
1731 name = dynamicParamNameWidget.getValue().trim();
1732 if ( name === '' ) {
1733 dynamicParamNameWidget.focus();
1734 return;
1735 }
1736
1737 if ( that.widgets[ name ] !== undefined ) {
1738 windowManager.openWindow( 'errorAlert', {
1739 title: Util.parseMsg( 'apisandbox-dynamic-error-exists', name ),
1740 actions: [
1741 {
1742 action: 'accept',
1743 label: OO.ui.msg( 'ooui-dialog-process-dismiss' ),
1744 flags: 'primary'
1745 }
1746 ]
1747 } );
1748 return;
1749 }
1750
1751 widget = Util.createWidgetForParameter( {
1752 name: name,
1753 type: 'string',
1754 default: ''
1755 }, {
1756 nooptional: true
1757 } );
1758 button = new OO.ui.ButtonWidget( {
1759 icon: 'trash',
1760 flags: 'destructive'
1761 } );
1762 layout = new OO.ui.ActionFieldLayout(
1763 widget,
1764 button,
1765 {
1766 label: name,
1767 align: 'left'
1768 }
1769 );
1770 button.on( 'click', removeDynamicParamWidget, [ name, layout ] );
1771 that.widgets[ name ] = widget;
1772 dynamicFieldset.addItems( [ layout ], dynamicFieldset.getItems().length - 1 );
1773 widget.focus();
1774
1775 dynamicParamNameWidget.setValue( '' );
1776 };
1777
1778 this.$element.empty()
1779 .append( new OO.ui.ProgressBarWidget( {
1780 progress: false,
1781 text: mw.message( 'apisandbox-loading', this.displayText ).text()
1782 } ).$element );
1783
1784 Util.fetchModuleInfo( this.apiModule )
1785 .done( function ( pi ) {
1786 var prefix, i, j, tmp,
1787 items = [],
1788 deprecatedItems = [],
1789 buttons = [],
1790 filterFmModules = function ( v ) {
1791 return v.substr( -2 ) !== 'fm' ||
1792 !Object.prototype.hasOwnProperty.call( availableFormats, v.substr( 0, v.length - 2 ) );
1793 };
1794
1795 // This is something of a hack. We always want the 'format' and
1796 // 'action' parameters from the main module to be specified,
1797 // and for 'format' we also want to simplify the dropdown since
1798 // we always send the 'fm' variant.
1799 if ( that.apiModule === 'main' ) {
1800 for ( i = 0; i < pi.parameters.length; i++ ) {
1801 if ( pi.parameters[ i ].name === 'action' ) {
1802 pi.parameters[ i ].required = true;
1803 delete pi.parameters[ i ].default;
1804 }
1805 if ( pi.parameters[ i ].name === 'format' ) {
1806 tmp = pi.parameters[ i ].type;
1807 for ( j = 0; j < tmp.length; j++ ) {
1808 availableFormats[ tmp[ j ] ] = true;
1809 }
1810 pi.parameters[ i ].type = tmp.filter( filterFmModules );
1811 pi.parameters[ i ].default = 'json';
1812 pi.parameters[ i ].required = true;
1813 }
1814 }
1815 }
1816
1817 // Hide the 'wrappedhtml' parameter on format modules
1818 if ( pi.group === 'format' ) {
1819 pi.parameters = pi.parameters.filter( function ( p ) {
1820 return p.name !== 'wrappedhtml';
1821 } );
1822 }
1823
1824 that.paramInfo = pi;
1825
1826 items.push( new OO.ui.FieldLayout(
1827 new OO.ui.Widget( {} ).toggle( false ), {
1828 align: 'top',
1829 label: Util.parseHTML( pi.description )
1830 }
1831 ) );
1832
1833 if ( pi.helpurls.length ) {
1834 buttons.push( new OO.ui.PopupButtonWidget( {
1835 $overlay: true,
1836 label: mw.message( 'apisandbox-helpurls' ).text(),
1837 icon: 'help',
1838 popup: {
1839 width: 'auto',
1840 padded: true,
1841 $content: $( '<ul>' ).append( pi.helpurls.map( function ( link ) {
1842 return $( '<li>' ).append( $( '<a>' )
1843 .attr( { href: link, target: '_blank' } )
1844 .text( link )
1845 );
1846 } ) )
1847 }
1848 } ) );
1849 }
1850
1851 if ( pi.examples.length ) {
1852 buttons.push( new OO.ui.PopupButtonWidget( {
1853 $overlay: true,
1854 label: mw.message( 'apisandbox-examples' ).text(),
1855 icon: 'code',
1856 popup: {
1857 width: 'auto',
1858 padded: true,
1859 $content: $( '<ul>' ).append( pi.examples.map( function ( example ) {
1860 var a = $( '<a>' )
1861 .attr( 'href', '#' + example.query )
1862 .html( example.description );
1863 a.find( 'a' ).contents().unwrap(); // Can't nest links
1864 return $( '<li>' ).append( a );
1865 } ) )
1866 }
1867 } ) );
1868 }
1869
1870 if ( buttons.length ) {
1871 items.push( new OO.ui.FieldLayout(
1872 new OO.ui.ButtonGroupWidget( {
1873 items: buttons
1874 } ), { align: 'top' }
1875 ) );
1876 }
1877
1878 if ( pi.parameters.length ) {
1879 prefix = that.prefix + pi.prefix;
1880 for ( i = 0; i < pi.parameters.length; i++ ) {
1881 tmp = that.makeWidgetFieldLayouts( pi.parameters[ i ], prefix + pi.parameters[ i ].name );
1882 that.widgets[ prefix + pi.parameters[ i ].name ] = tmp.widget;
1883 if ( Util.apiBool( pi.parameters[ i ].deprecated ) ) {
1884 deprecatedItems.push( tmp.widgetField, tmp.helpField );
1885 } else {
1886 items.push( tmp.widgetField, tmp.helpField );
1887 }
1888 }
1889 }
1890
1891 if ( !pi.parameters.length && !Util.apiBool( pi.dynamicparameters ) ) {
1892 items.push( new OO.ui.FieldLayout(
1893 new OO.ui.Widget( {} ).toggle( false ), {
1894 align: 'top',
1895 label: Util.parseMsg( 'apisandbox-no-parameters' )
1896 }
1897 ) );
1898 }
1899
1900 that.$element.empty();
1901
1902 that.itemsFieldset = new OO.ui.FieldsetLayout( {
1903 label: that.displayText
1904 } );
1905 that.itemsFieldset.addItems( items );
1906 that.itemsFieldset.$element.appendTo( that.$element );
1907
1908 if ( Util.apiBool( pi.dynamicparameters ) ) {
1909 dynamicFieldset = new OO.ui.FieldsetLayout();
1910 dynamicParamNameWidget = new OO.ui.TextInputWidget( {
1911 placeholder: mw.message( 'apisandbox-dynamic-parameters-add-placeholder' ).text()
1912 } ).on( 'enter', addDynamicParamWidget );
1913 dynamicFieldset.addItems( [
1914 new OO.ui.FieldLayout(
1915 new OO.ui.Widget( {} ).toggle( false ), {
1916 align: 'top',
1917 label: Util.parseHTML( pi.dynamicparameters )
1918 }
1919 ),
1920 new OO.ui.ActionFieldLayout(
1921 dynamicParamNameWidget,
1922 new OO.ui.ButtonWidget( {
1923 icon: 'add',
1924 flags: 'progressive'
1925 } ).on( 'click', addDynamicParamWidget ),
1926 {
1927 label: mw.message( 'apisandbox-dynamic-parameters-add-label' ).text(),
1928 align: 'left'
1929 }
1930 )
1931 ] );
1932 $( '<fieldset>' )
1933 .append(
1934 $( '<legend>' ).text( mw.message( 'apisandbox-dynamic-parameters' ).text() ),
1935 dynamicFieldset.$element
1936 )
1937 .appendTo( that.$element );
1938 }
1939
1940 that.deprecatedItemsFieldset = new OO.ui.FieldsetLayout().addItems( deprecatedItems ).toggle( false );
1941 tmp = $( '<fieldset>' )
1942 .toggle( !that.deprecatedItemsFieldset.isEmpty() )
1943 .append(
1944 $( '<legend>' ).append(
1945 new OO.ui.ToggleButtonWidget( {
1946 label: mw.message( 'apisandbox-deprecated-parameters' ).text()
1947 } ).on( 'change', that.deprecatedItemsFieldset.toggle, [], that.deprecatedItemsFieldset ).$element
1948 ),
1949 that.deprecatedItemsFieldset.$element
1950 )
1951 .appendTo( that.$element );
1952 that.deprecatedItemsFieldset.on( 'add', function () {
1953 this.toggle( !that.deprecatedItemsFieldset.isEmpty() );
1954 }, [], tmp );
1955 that.deprecatedItemsFieldset.on( 'remove', function () {
1956 this.toggle( !that.deprecatedItemsFieldset.isEmpty() );
1957 }, [], tmp );
1958
1959 // Load stored params, if any, then update the booklet if we
1960 // have subpages (or else just update our valid-indicator).
1961 tmp = that.loadFromQueryParams;
1962 that.loadFromQueryParams = null;
1963 if ( $.isPlainObject( tmp ) ) {
1964 that.loadQueryParams( tmp );
1965 } else {
1966 that.updateTemplatedParameters();
1967 }
1968 if ( that.getSubpages().length > 0 ) {
1969 ApiSandbox.updateUI( tmp );
1970 } else {
1971 that.apiCheckValid();
1972 }
1973 } ).fail( function ( code, detail ) {
1974 that.$element.empty()
1975 .append(
1976 new OO.ui.LabelWidget( {
1977 label: mw.message( 'apisandbox-load-error', that.apiModule, detail ).text(),
1978 classes: [ 'error' ]
1979 } ).$element,
1980 new OO.ui.ButtonWidget( {
1981 label: mw.message( 'apisandbox-retry' ).text()
1982 } ).on( 'click', that.loadParamInfo, [], that ).$element
1983 );
1984 } );
1985 };
1986
1987 /**
1988 * Check that all widgets on the page are in a valid state.
1989 *
1990 * @return {jQuery.Promise[]} One promise for each widget, resolved with `false` if invalid
1991 */
1992 ApiSandbox.PageLayout.prototype.apiCheckValid = function () {
1993 var promises, that = this;
1994
1995 if ( this.paramInfo === null ) {
1996 return [];
1997 } else {
1998 // eslint-disable-next-line no-jquery/no-map-util
1999 promises = $.map( this.widgets, function ( widget ) {
2000 return widget.apiCheckValid();
2001 } );
2002 $.when.apply( $, promises ).then( function () {
2003 that.apiIsValid = Array.prototype.indexOf.call( arguments, false ) === -1;
2004 if ( that.getOutlineItem() ) {
2005 that.getOutlineItem().setIcon( that.apiIsValid || suppressErrors ? null : 'alert' );
2006 that.getOutlineItem().setTitle(
2007 that.apiIsValid || suppressErrors ? '' : mw.message( 'apisandbox-alert-page' ).plain()
2008 );
2009 }
2010 } );
2011 return promises;
2012 }
2013 };
2014
2015 /**
2016 * Load form fields from query parameters
2017 *
2018 * @param {Object} params
2019 */
2020 ApiSandbox.PageLayout.prototype.loadQueryParams = function ( params ) {
2021 if ( this.paramInfo === null ) {
2022 this.loadFromQueryParams = params;
2023 } else {
2024 // eslint-disable-next-line no-jquery/no-each-util
2025 $.each( this.widgets, function ( name, widget ) {
2026 var v = Object.prototype.hasOwnProperty.call( params, name ) ? params[ name ] : undefined;
2027 widget.setApiValue( v );
2028 } );
2029 this.updateTemplatedParameters( params );
2030 }
2031 };
2032
2033 /**
2034 * Load query params from form fields
2035 *
2036 * @param {Object} params Write query parameters into this object
2037 * @param {Object} displayParams Write query parameters for display into this object
2038 */
2039 ApiSandbox.PageLayout.prototype.getQueryParams = function ( params, displayParams ) {
2040 // eslint-disable-next-line no-jquery/no-each-util
2041 $.each( this.widgets, function ( name, widget ) {
2042 var value = widget.getApiValue();
2043 if ( value !== undefined ) {
2044 params[ name ] = value;
2045 if ( typeof widget.getApiValueForDisplay === 'function' ) {
2046 value = widget.getApiValueForDisplay();
2047 }
2048 displayParams[ name ] = value;
2049 }
2050 } );
2051 };
2052
2053 /**
2054 * Fetch a list of subpage names loaded by this page
2055 *
2056 * @return {Array}
2057 */
2058 ApiSandbox.PageLayout.prototype.getSubpages = function () {
2059 var ret = [];
2060 // eslint-disable-next-line no-jquery/no-each-util
2061 $.each( this.widgets, function ( name, widget ) {
2062 var submodules, i;
2063 if ( typeof widget.getSubmodules === 'function' ) {
2064 submodules = widget.getSubmodules();
2065 for ( i = 0; i < submodules.length; i++ ) {
2066 ret.push( {
2067 key: name + '=' + submodules[ i ].value,
2068 path: submodules[ i ].path,
2069 prefix: widget.paramInfo.submoduleparamprefix || ''
2070 } );
2071 }
2072 }
2073 } );
2074 return ret;
2075 };
2076
2077 $( ApiSandbox.init );
2078
2079 module.exports = ApiSandbox;
2080
2081 }() );
Wiklou, le Wiki du Wiklou