3 var ApiSandbox
, Util
, WidgetMethods
, Validators
,
4 $content
, panel
, booklet
, oldhash
, windowManager
,
10 suppressErrors
= true,
11 updatingBooklet
= false,
17 * A wrapper for a widget that provides an enable/disable button
22 * @param {OO.ui.Widget} widget
23 * @param {Object} [config] Configuration options
25 function OptionalWidget( widget
, config
) {
28 config
= config
|| {};
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 );
36 OptionalWidget
.super.call( this, config
);
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
);
45 widget
.connect( this, {
46 change
: [ this.emit
, 'change' ]
49 this.$cover
.on( 'click', this.onOverlayClick
.bind( this ) );
52 .addClass( 'mw-apisandbox-optionalWidget' )
55 $( '<div>' ).addClass( 'mw-apisandbox-optionalWidget-fields' ).append(
56 $( '<div>' ).addClass( 'mw-apisandbox-optionalWidget-widget' ).append(
59 $( '<div>' ).addClass( 'mw-apisandbox-optionalWidget-checkbox' ).append(
60 this.checkbox
.$element
65 this.setDisabled( widget
.isDisabled() );
67 OO
.inheritClass( OptionalWidget
, OO
.ui
.Widget
);
68 OptionalWidget
.prototype.onCheckboxChange = function ( checked
) {
69 this.setDisabled( !checked
);
71 OptionalWidget
.prototype.onOverlayClick = function () {
72 this.setDisabled( false );
73 if ( typeof this.widget
.focus
=== 'function' ) {
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' );
88 getApiValue: function () {
89 return this.getValue();
91 setApiValue: function ( v
) {
92 if ( v
=== undefined ) {
93 v
= this.paramInfo
.default;
97 apiCheckValid: function () {
99 return this.getValidity().then( function () {
100 return $.Deferred().resolve( true ).promise();
102 return $.Deferred().resolve( false ).promise();
103 } ).done( function ( ok
) {
104 ok
= ok
|| suppressErrors
;
105 that
.setIcon( ok
? null : 'alert' );
106 that
.setIconTitle( ok
? '' : mw
.message( 'apisandbox-alert-field' ).plain() );
111 dateTimeInputWidget
: {
112 getValidity: function () {
113 if ( !Util
.apiBool( this.paramInfo
.required
) || this.getApiValue() !== '' ) {
114 return $.Deferred().resolve().promise();
116 return $.Deferred().reject().promise();
122 alertTokenError: function ( code
, error
) {
123 windowManager
.openWindow( 'errorAlert', {
124 title
: Util
.parseMsg( 'apisandbox-results-fixtoken-fail', this.paramInfo
.tokentype
),
129 label
: OO
.ui
.msg( 'ooui-dialog-process-dismiss' ),
135 fetchToken: function () {
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 ) );
142 setApiValue: function ( v
) {
143 WidgetMethods
.textInputWidget
.setApiValue
.call( this, v
);
144 if ( v
=== '123ABC' ) {
151 getApiValueForDisplay: function () {
156 toggleSwitchWidget
: {
157 getApiValue: function () {
158 return this.getValue() ? 1 : undefined;
160 setApiValue: function ( v
) {
161 this.setValue( Util
.apiBool( v
) );
163 apiCheckValid: function () {
164 return $.Deferred().resolve( true ).promise();
169 getApiValue: function () {
170 var item
= this.getMenu().findSelectedItem();
171 return item
=== null ? undefined : item
.getData();
173 setApiValue: function ( v
) {
174 var menu
= this.getMenu();
176 if ( v
=== undefined ) {
177 v
= this.paramInfo
.default;
179 if ( v
=== undefined ) {
182 menu
.selectItemByData( String( v
) );
185 apiCheckValid: function () {
186 var ok
= this.getApiValue() !== undefined || suppressErrors
;
187 this.setIcon( ok
? null : 'alert' );
188 this.setIconTitle( ok
? '' : mw
.message( 'apisandbox-alert-field' ).plain() );
189 return $.Deferred().resolve( ok
).promise();
194 parseApiValue: function ( v
) {
195 if ( v
=== undefined || v
=== '' || v
=== '\x1f' ) {
199 if ( v
[ 0 ] !== '\x1f' ) {
200 return v
.split( '|' );
202 return v
.substr( 1 ).split( '\x1f' );
206 getApiValueForTemplates: function () {
207 return this.isDisabled() ? this.parseApiValue( this.paramInfo
.default ) : this.getValue();
209 getApiValue: function () {
210 var items
= this.getValue();
211 if ( items
.join( '' ).indexOf( '|' ) === -1 ) {
212 return items
.join( '|' );
214 return '\x1f' + items
.join( '\x1f' );
217 setApiValue: function ( v
) {
218 if ( v
=== undefined ) {
219 v
= this.paramInfo
.default;
221 this.setValue( this.parseApiValue( v
) );
223 apiCheckValid: function () {
227 if ( !suppressErrors
) {
228 ok
= this.getApiValue() !== undefined && !(
229 pi
.allspecifier
!== undefined &&
230 this.getValue().length
> 1 &&
231 this.getValue().indexOf( pi
.allspecifier
) !== -1
235 this.setIcon( ok
? null : 'alert' );
236 this.setIconTitle( ok
? '' : mw
.message( 'apisandbox-alert-field' ).plain() );
237 return $.Deferred().resolve( ok
).promise();
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
244 item
.$element
.addClass( 'apihelp-deprecated-value' );
251 getApiValue: function () {
252 return this.isDisabled() ? undefined : this.widget
.getApiValue();
254 setApiValue: function ( v
) {
255 this.setDisabled( v
=== undefined );
256 this.widget
.setApiValue( v
);
258 apiCheckValid: function () {
259 if ( this.isDisabled() ) {
260 return $.Deferred().resolve( true ).promise();
262 return this.widget
.apiCheckValid();
268 single: function () {
269 var v
= this.isDisabled() ? this.paramInfo
.default : this.getApiValue();
270 return v
=== undefined ? [] : [ { value
: v
, path
: this.paramInfo
.submodules
[ v
] } ];
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
] };
282 getApiValueForDisplay: function () {
285 getApiValue: function () {
286 return this.getValue();
288 setApiValue: function () {
291 apiCheckValid: function () {
292 var ok
= this.getValue() !== null || suppressErrors
;
293 this.setIcon( ok
? null : 'alert' );
294 this.setIconTitle( ok
? '' : mw
.message( 'apisandbox-alert-field' ).plain() );
295 return $.Deferred().resolve( ok
).promise();
301 generic: function () {
302 return !Util
.apiBool( this.paramInfo
.required
) || this.getApiValue() !== '';
307 * @class mw.special.ApiSandbox.Util
312 * Fetch API module info
314 * @param {string} module Module to fetch data for
315 * @return {jQuery.Promise}
317 fetchModuleInfo: function ( module
) {
319 deferred
= $.Deferred();
321 if ( Object
.prototype.hasOwnProperty
.call( moduleInfoCache
, module
) ) {
323 .resolve( moduleInfoCache
[ module
] )
324 .promise( { abort: function () {} } );
326 apiPromise
= api
.post( {
330 uselang
: mw
.config
.get( 'wgUserLanguage' )
331 } ).done( function ( data
) {
334 if ( data
.warnings
&& data
.warnings
.paraminfo
) {
335 deferred
.reject( '???', data
.warnings
.paraminfo
[ '*' ] );
339 info
= data
.paraminfo
.modules
;
340 if ( !info
|| info
.length
!== 1 || info
[ 0 ].path
!== module
) {
341 deferred
.reject( '???', 'No module data returned' );
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
;
353 deferred
.reject( code
, details
);
356 .promise( { abort
: apiPromise
.abort
} );
361 * Mark all currently-in-use tokens as bad
363 markTokensBad: function () {
364 var page
, subpages
, i
,
365 checkPages
= [ pages
.main
];
367 while ( checkPages
.length
) {
368 page
= checkPages
.shift();
370 if ( page
.tokenWidget
) {
371 api
.badToken( page
.tokenWidget
.paramInfo
.tokentype
);
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
] );
384 * Test an API boolean
386 * @param {Mixed} value
389 apiBool: function ( value
) {
390 return value
!== undefined && value
!== false;
394 * Create a widget for a parameter.
396 * @param {Object} pi Parameter info from API
397 * @param {Object} opts Additional options
398 * @return {OO.ui.Widget}
400 createWidgetForParameter: function ( pi
, opts
) {
401 var widget
, innerWidget
, finalWidget
, items
, $content
, func
,
402 multiModeButton
= null,
403 multiModeInput
= null,
404 multiModeAllowed
= false;
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
418 if ( Util
.apiBool( pi
.multi
) ) {
419 widget
= new OO
.ui
.TagMultiselectWidget( {
420 allowArbitrary
: true,
421 allowDuplicates
: Util
.apiBool( pi
.allowsduplicates
),
424 widget
.paramInfo
= pi
;
425 $.extend( widget
, WidgetMethods
.tagWidget
);
427 widget
= new OO
.ui
.TextInputWidget( {
428 required
: Util
.apiBool( pi
.required
)
431 if ( !Util
.apiBool( pi
.multi
) ) {
432 widget
.paramInfo
= pi
;
433 $.extend( widget
, WidgetMethods
.textInputWidget
);
434 widget
.setValidation( Validators
.generic
);
436 if ( pi
.tokentype
) {
437 widget
.paramInfo
= pi
;
438 $.extend( widget
, WidgetMethods
.textInputWidget
);
439 $.extend( widget
, WidgetMethods
.tokenWidget
);
444 widget
= new OO
.ui
.MultilineTextInputWidget( {
445 required
: Util
.apiBool( pi
.required
)
447 widget
.paramInfo
= pi
;
448 $.extend( widget
, WidgetMethods
.textInputWidget
);
449 widget
.setValidation( Validators
.generic
);
453 widget
= new OO
.ui
.TextInputWidget( {
455 required
: Util
.apiBool( pi
.required
)
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
;
466 widget
= new OO
.ui
.NumberInputWidget( {
467 required
: Util
.apiBool( pi
.required
),
470 widget
.setIcon
= widget
.input
.setIcon
.bind( widget
.input
);
471 widget
.setIconTitle
= widget
.input
.setIconTitle
.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
);
478 multiModeAllowed
= true;
479 multiModeInput
= widget
;
483 widget
= new OO
.ui
.TextInputWidget( {
484 required
: Util
.apiBool( pi
.required
)
486 widget
.setValidation( function ( value
) {
487 var n
, pi
= this.paramInfo
;
489 if ( value
=== 'max' ) {
493 return !isNaN( n
) && isFinite( n
) &&
494 Math
.floor( n
) === n
&&
495 n
>= pi
.min
&& n
<= pi
.apiSandboxMax
;
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
;
507 widget
= new mw
.widgets
.datetime
.DateTimeInputWidget( {
509 format
: '${year|0}-${month|0}-${day|0}T${hour|0}:${minute|0}:${second|0}${zone|short}'
511 required
: Util
.apiBool( pi
.required
),
514 widget
.paramInfo
= pi
;
515 $.extend( widget
, WidgetMethods
.textInputWidget
);
516 $.extend( widget
, WidgetMethods
.dateTimeInputWidget
);
517 multiModeAllowed
= true;
521 widget
= new OO
.ui
.SelectFileWidget();
522 widget
.paramInfo
= pi
;
523 $.extend( widget
, WidgetMethods
.uploadWidget
);
527 // eslint-disable-next-line jquery/no-map-util
528 items
= $.map( mw
.config
.get( 'wgFormattedNamespaces' ), function ( name
, ns
) {
530 name
= mw
.message( 'blanknamespace' ).text();
532 return new OO
.ui
.MenuOptionWidget( { data
: ns
, label
: name
} );
533 } ).sort( function ( a
, b
) {
534 return a
.data
- b
.data
;
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()
544 widget
= new OO
.ui
.MenuTagMultiselectWidget( {
545 menu
: { items
: items
},
548 widget
.paramInfo
= pi
;
549 $.extend( widget
, WidgetMethods
.tagWidget
);
551 widget
= new OO
.ui
.DropdownWidget( {
552 menu
: { items
: items
},
555 widget
.paramInfo
= pi
;
556 $.extend( widget
, WidgetMethods
.dropdownWidget
);
561 if ( !Array
.isArray( pi
.type
) ) {
562 throw new Error( 'Unknown parameter type ' + pi
.type
);
565 items
= pi
.type
.map( function ( v
) {
571 if ( pi
.deprecatedvalues
&& pi
.deprecatedvalues
.indexOf( v
) >= 0 ) {
572 config
.classes
.push( 'apihelp-deprecated-value' );
574 return new OO
.ui
.MenuOptionWidget( config
);
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()
584 widget
= new OO
.ui
.MenuTagMultiselectWidget( {
585 menu
: { items
: items
},
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
);
595 widget
= new OO
.ui
.DropdownWidget( {
596 menu
: { items
: items
},
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
);
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
618 if ( Util
.apiBool( pi
.multi
) && multiModeAllowed
) {
619 innerWidget
= widget
;
621 multiModeButton
= new OO
.ui
.ButtonWidget( {
622 label
: mw
.message( 'apisandbox-add-multi' ).text()
624 $content
= innerWidget
.$element
.add( multiModeButton
.$element
);
626 widget
= new OO
.ui
.PopupTagMultiselectWidget( {
627 allowArbitrary
: true,
628 allowDuplicates
: Util
.apiBool( pi
.allowsduplicates
),
631 classes
: [ 'mw-apisandbox-popup' ],
636 widget
.paramInfo
= pi
;
637 $.extend( widget
, WidgetMethods
.tagWidget
);
640 if ( !innerWidget
.isDisabled() ) {
641 innerWidget
.apiCheckValid().done( function ( ok
) {
643 widget
.addTag( innerWidget
.getApiValue() );
644 innerWidget
.setApiValue( undefined );
651 if ( multiModeInput
) {
652 multiModeInput
.on( 'enter', func
);
654 multiModeButton
.on( 'click', func
);
657 if ( Util
.apiBool( pi
.required
) || opts
.nooptional
) {
658 finalWidget
= widget
;
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
);
669 if ( widget
.getApiValueForTemplates
) {
670 finalWidget
.getApiValueForTemplates
= widget
.getApiValueForTemplates
.bind( widget
);
672 finalWidget
.setDisabled( true );
675 widget
.setApiValue( pi
.default );
681 * Parse an HTML string and call Util.fixupHTML()
683 * @param {string} html HTML to parse
686 parseHTML: function ( html
) {
687 var $ret
= $( $.parseHTML( html
) );
688 return Util
.fixupHTML( $ret
);
692 * Parse an i18n message and call Util.fixupHTML()
694 * @param {string} key Key of message to get
695 * @param {...Mixed} parameters Values for $N replacements
698 parseMsg: function () {
699 var $ret
= mw
.message
.apply( mw
.message
, arguments
).parseDom();
700 return Util
.fixupHTML( $ret
);
704 * Fix HTML for ApiSandbox display
707 * - Add target="_blank" to any links
709 * @param {jQuery} $html DOM to process
712 fixupHTML: function ( $html
) {
713 $html
.filter( 'a' ).add( $html
.find( 'a' ) )
714 .filter( '[href]:not([target])' )
715 .attr( 'target', '_blank' );
720 * Format a request and return a bunch of menu option widgets
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
726 formatRequest: function ( displayParams
, rawParams
) {
729 new OO
.ui
.MenuOptionWidget( {
730 label
: Util
.parseMsg( 'apisandbox-request-format-url-label' ),
731 data
: new OO
.ui
.FieldLayout(
732 new OO
.ui
.TextInputWidget( {
734 value
: mw
.util
.wikiScript( 'api' ) + '?' + $.param( displayParams
)
736 label
: Util
.parseMsg( 'apisandbox-request-url-label' )
740 new OO
.ui
.MenuOptionWidget( {
741 label
: Util
.parseMsg( 'apisandbox-request-format-json-label' ),
742 data
: new OO
.ui
.FieldLayout(
743 jsonInput
= new OO
.ui
.MultilineTextInputWidget( {
744 classes
: [ 'mw-apisandbox-textInputCode' ],
748 value
: JSON
.stringify( displayParams
, null, '\t' )
750 label
: Util
.parseMsg( 'apisandbox-request-json-label' )
752 ).on( 'toggle', function ( visible
) {
754 // Call updatePosition instead of adjustSize
755 // because the latter has weird caching
756 // behavior and the former bypasses it.
757 jsonInput
.updatePosition();
763 mw
.hook( 'apisandbox.formatRequest' ).fire( items
, displayParams
, rawParams
);
769 * Event handler for when formatDropdown's selection changes
771 onFormatDropdownChange: function () {
773 menu
= formatDropdown
.getMenu(),
774 items
= menu
.getItems(),
775 selectedField
= menu
.findSelectedItem() ? menu
.findSelectedItem().getData() : null;
777 for ( i
= 0; i
< items
.length
; i
++ ) {
778 items
[ i
].getData().toggle( items
[ i
].getData() === selectedField
);
784 * Interface to ApiSandbox UI
786 * @class mw.special.ApiSandbox
792 * Automatically called on $.ready()
797 $content
= $( '#mw-apisandbox' );
799 windowManager
= new OO
.ui
.WindowManager();
800 $( 'body' ).append( windowManager
.$element
);
801 windowManager
.addWindows( {
802 errorAlert
: new OO
.ui
.MessageDialog()
805 $toolbar
= $( '<div>' )
806 .addClass( 'mw-apisandbox-toolbar' )
808 new OO
.ui
.ButtonWidget( {
809 label
: mw
.message( 'apisandbox-submit' ).text(),
810 flags
: [ 'primary', 'progressive' ]
811 } ).on( 'click', ApiSandbox
.sendRequest
).$element
,
812 new OO
.ui
.ButtonWidget( {
813 label
: mw
.message( 'apisandbox-reset' ).text(),
815 } ).on( 'click', ApiSandbox
.resetUI
).$element
818 booklet
= new OO
.ui
.BookletLayout( {
824 panel
= new OO
.ui
.PanelLayout( {
825 classes
: [ 'mw-apisandbox-container' ],
826 content
: [ booklet
],
831 pages
.main
= new ApiSandbox
.PageLayout( { key
: 'main', path
: 'main' } );
833 // Parse the current hash string
834 if ( !ApiSandbox
.loadFromHash() ) {
835 ApiSandbox
.updateUI();
838 $( window
).on( 'hashchange', ApiSandbox
.loadFromHash
);
842 .append( $( '<p>' ).append( Util
.parseMsg( 'apisandbox-intro' ) ) )
844 $( '<div>' ).attr( 'id', 'mw-apisandbox-ui' )
846 .append( panel
.$element
)
851 * Update the current query when the page hash changes
853 * @return {boolean} Successful
855 loadFromHash: function () {
857 hash
= location
.hash
;
859 if ( oldhash
=== hash
) {
867 // I'm surprised this doesn't seem to exist in jQuery or mw.util.
869 hash
= hash
.replace( /\+/g, '%20' );
870 re
= /([^&=#]+)=?([^&#]*)/g;
871 while ( ( m
= re
.exec( hash
) ) ) {
872 params
[ decodeURIComponent( m
[ 1 ] ) ] = decodeURIComponent( m
[ 2 ] );
875 ApiSandbox
.updateUI( params
);
880 * Update the pages in the booklet
882 * @param {Object} [params] Optional query parameters to load
884 updateUI: function ( params
) {
885 var i
, page
, subpages
, j
, removePages
,
888 if ( !$.isPlainObject( params
) ) {
892 if ( updatingBooklet
) {
895 updatingBooklet
= true;
897 if ( params
!== undefined ) {
898 pages
.main
.loadQueryParams( params
);
900 addPages
.push( pages
.main
);
901 if ( resultPage
!== null ) {
902 addPages
.push( resultPage
);
904 pages
.main
.apiCheckValid();
907 while ( addPages
.length
) {
908 page
= addPages
.shift();
909 if ( bookletPages
[ i
] !== page
) {
910 for ( j
= i
; j
< bookletPages
.length
; j
++ ) {
911 if ( bookletPages
[ j
].getName() === page
.getName() ) {
912 bookletPages
.splice( j
, 1 );
915 bookletPages
.splice( i
, 0, page
);
916 booklet
.addPages( [ page
], i
);
920 if ( page
.getSubpages
) {
921 subpages
= page
.getSubpages();
922 for ( j
= 0; j
< subpages
.length
; j
++ ) {
923 if ( !Object
.prototype.hasOwnProperty
.call( pages
, subpages
[ j
].key
) ) {
924 subpages
[ j
].indentLevel
= page
.indentLevel
+ 1;
925 pages
[ subpages
[ j
].key
] = new ApiSandbox
.PageLayout( subpages
[ j
] );
927 if ( params
!== undefined ) {
928 pages
[ subpages
[ j
].key
].loadQueryParams( params
);
930 addPages
.splice( j
, 0, pages
[ subpages
[ j
].key
] );
931 pages
[ subpages
[ j
].key
].apiCheckValid();
936 if ( bookletPages
.length
> i
) {
937 removePages
= bookletPages
.splice( i
, bookletPages
.length
- i
);
938 booklet
.removePages( removePages
);
941 if ( !booklet
.getCurrentPageName() ) {
942 booklet
.selectFirstSelectablePage();
945 updatingBooklet
= false;
950 * Reset button handler
952 resetUI: function () {
953 suppressErrors
= true;
955 main
: new ApiSandbox
.PageLayout( { key
: 'main', path
: 'main' } )
958 ApiSandbox
.updateUI();
962 * Submit button handler
964 * @param {Object} [params] Use this set of params instead of those in the form fields.
965 * The form fields will be updated to match.
967 sendRequest: function ( params
) {
968 var page
, subpages
, i
, query
, $result
, $focus
,
969 progress
, $progressText
, progressLoading
,
971 paramsAreForced
= !!params
,
974 checkPages
= [ pages
.main
];
976 // Blur any focused widget before submit, because
977 // OO.ui.ButtonWidget doesn't take focus itself (T128054)
978 $focus
= $( '#mw-apisandbox-ui' ).find( document
.activeElement
);
979 if ( $focus
.length
) {
983 suppressErrors
= false;
985 // save widget state in params (or load from it if we are forced)
986 if ( paramsAreForced
) {
987 ApiSandbox
.updateUI( params
);
990 while ( checkPages
.length
) {
991 page
= checkPages
.shift();
992 if ( page
.tokenWidget
) {
993 tokenWidgets
.push( page
.tokenWidget
);
995 deferreds
= deferreds
.concat( page
.apiCheckValid() );
996 page
.getQueryParams( params
, displayParams
);
997 subpages
= page
.getSubpages();
998 for ( i
= 0; i
< subpages
.length
; i
++ ) {
999 if ( Object
.prototype.hasOwnProperty
.call( pages
, subpages
[ i
].key
) ) {
1000 checkPages
.push( pages
[ subpages
[ i
].key
] );
1005 if ( !paramsAreForced
) {
1006 // forced params means we are continuing a query; the base query should be preserved
1007 baseRequestParams
= $.extend( {}, params
);
1010 $.when
.apply( $, deferreds
).done( function () {
1011 var formatItems
, menu
, selectedLabel
, deferred
, actions
, errorCount
;
1013 // Count how many times `value` occurs in `array`.
1014 function countValues( value
, array
) {
1017 for ( i
= 0; i
< array
.length
; i
++ ) {
1018 if ( array
[ i
] === value
) {
1025 errorCount
= countValues( false, arguments
);
1026 if ( errorCount
> 0 ) {
1030 label
: OO
.ui
.msg( 'ooui-dialog-process-dismiss' ),
1034 if ( tokenWidgets
.length
) {
1035 // Check all token widgets' validity separately
1036 deferred
= $.when
.apply( $, tokenWidgets
.map( function ( w
) {
1037 return w
.apiCheckValid();
1040 deferred
.done( function () {
1041 // If only the tokens are invalid, offer to fix them
1042 var tokenErrorCount
= countValues( false, arguments
);
1043 if ( tokenErrorCount
=== errorCount
) {
1044 delete actions
[ 0 ].flags
;
1047 label
: mw
.message( 'apisandbox-results-fixtoken' ).text(),
1053 deferred
= $.Deferred().resolve();
1055 deferred
.always( function () {
1056 windowManager
.openWindow( 'errorAlert', {
1057 title
: Util
.parseMsg( 'apisandbox-submit-invalid-fields-title' ),
1058 message
: Util
.parseMsg( 'apisandbox-submit-invalid-fields-message' ),
1060 } ).closed
.then( function ( data
) {
1061 if ( data
&& data
.action
=== 'fix' ) {
1062 ApiSandbox
.fixTokenAndResend();
1069 query
= $.param( displayParams
);
1071 formatItems
= Util
.formatRequest( displayParams
, params
);
1073 // Force a 'fm' format with wrappedhtml=1, if available
1074 if ( params
.format
!== undefined ) {
1075 if ( Object
.prototype.hasOwnProperty
.call( availableFormats
, params
.format
+ 'fm' ) ) {
1076 params
.format
= params
.format
+ 'fm';
1078 if ( params
.format
.substr( -2 ) === 'fm' ) {
1079 params
.wrappedhtml
= 1;
1083 progressLoading
= false;
1084 $progressText
= $( '<span>' ).text( mw
.message( 'apisandbox-sending-request' ).text() );
1085 progress
= new OO
.ui
.ProgressBarWidget( {
1087 $content
: $progressText
1090 $result
= $( '<div>' )
1091 .append( progress
.$element
);
1093 resultPage
= page
= new OO
.ui
.PageLayout( '|results|', { expanded
: false } );
1094 page
.setupOutlineItem = function () {
1095 this.outlineItem
.setLabel( mw
.message( 'apisandbox-results' ).text() );
1098 if ( !formatDropdown
) {
1099 formatDropdown
= new OO
.ui
.DropdownWidget( {
1100 menu
: { items
: [] },
1103 formatDropdown
.getMenu().on( 'select', Util
.onFormatDropdownChange
);
1106 menu
= formatDropdown
.getMenu();
1107 selectedLabel
= menu
.findSelectedItem() ? menu
.findSelectedItem().getLabel() : '';
1108 if ( typeof selectedLabel
!== 'string' ) {
1109 selectedLabel
= selectedLabel
.text();
1111 menu
.clearItems().addItems( formatItems
);
1112 menu
.chooseItem( menu
.getItemFromLabel( selectedLabel
) || menu
.findFirstSelectableItem() );
1114 // Fire the event to update field visibilities
1115 Util
.onFormatDropdownChange();
1117 page
.$element
.empty()
1119 new OO
.ui
.FieldLayout(
1121 label
: Util
.parseMsg( 'apisandbox-request-selectformat-label' )
1124 formatItems
.map( function ( item
) {
1125 return item
.getData().$element
;
1129 ApiSandbox
.updateUI();
1130 booklet
.setPage( '|results|' );
1132 location
.href
= oldhash
= '#' + query
;
1135 contentType
: 'multipart/form-data',
1138 var xhr
= new window
.XMLHttpRequest();
1139 xhr
.upload
.addEventListener( 'progress', function ( e
) {
1140 if ( !progressLoading
) {
1141 if ( e
.lengthComputable
) {
1142 progress
.setProgress( e
.loaded
* 100 / e
.total
);
1144 progress
.setProgress( false );
1148 xhr
.addEventListener( 'progress', function ( e
) {
1149 if ( !progressLoading
) {
1150 progressLoading
= true;
1151 $progressText
.text( mw
.message( 'apisandbox-loading-results' ).text() );
1153 if ( e
.lengthComputable
) {
1154 progress
.setProgress( e
.loaded
* 100 / e
.total
);
1156 progress
.setProgress( false );
1162 .catch( function ( code
, data
, result
, jqXHR
) {
1163 var deferred
= $.Deferred();
1165 if ( code
!== 'http' ) {
1166 // Not really an error, work around mw.Api thinking it is.
1167 deferred
.resolve( result
, jqXHR
);
1170 deferred
.reject
.apply( deferred
, arguments
);
1172 return deferred
.promise();
1174 .then( function ( data
, jqXHR
) {
1175 var m
, loadTime
, button
, clear
,
1176 ct
= jqXHR
.getResponseHeader( 'Content-Type' ),
1177 loginSuppressed
= jqXHR
.getResponseHeader( 'MediaWiki-Login-Suppressed' ) || 'false';
1180 if ( loginSuppressed
!== 'false' ) {
1182 .addClass( 'warning' )
1183 .append( Util
.parseMsg( 'apisandbox-results-login-suppressed' ) )
1184 .appendTo( $result
);
1186 if ( /^text\/mediawiki-api-prettyprint-wrapped(?:;|$)/.test( ct
) ) {
1187 data
= JSON
.parse( data
);
1188 if ( data
.modules
.length
) {
1189 mw
.loader
.load( data
.modules
);
1191 if ( data
.status
&& data
.status
!== 200 ) {
1193 .addClass( 'api-pretty-header api-pretty-status' )
1194 .append( Util
.parseMsg( 'api-format-prettyprint-status', data
.status
, data
.statustext
) )
1195 .appendTo( $result
);
1197 $result
.append( Util
.parseHTML( data
.html
) );
1198 loadTime
= data
.time
;
1199 } else if ( ( m
= data
.match( /<pre[ >][\s\S]*<\/pre>/ ) ) ) {
1200 $result
.append( Util
.parseHTML( m
[ 0 ] ) );
1201 if ( ( m
= data
.match( /"wgBackendResponseTime":\s*(\d+)/ ) ) ) {
1202 loadTime
= parseInt( m
[ 1 ], 10 );
1206 .addClass( 'api-pretty-content' )
1208 .appendTo( $result
);
1210 if ( paramsAreForced
|| data
.continue ) {
1212 $( '<div>' ).append(
1213 new OO
.ui
.ButtonWidget( {
1214 label
: mw
.message( 'apisandbox-continue' ).text()
1215 } ).on( 'click', function () {
1216 ApiSandbox
.sendRequest( $.extend( {}, baseRequestParams
, data
.continue ) );
1217 } ).setDisabled( !data
.continue ).$element
,
1218 ( clear
= new OO
.ui
.ButtonWidget( {
1219 label
: mw
.message( 'apisandbox-continue-clear' ).text()
1220 } ).on( 'click', function () {
1221 ApiSandbox
.updateUI( baseRequestParams
);
1222 clear
.setDisabled( true );
1223 booklet
.setPage( '|results|' );
1224 } ).setDisabled( !paramsAreForced
) ).$element
,
1225 new OO
.ui
.PopupButtonWidget( {
1230 $content
: $( '<div>' ).append( Util
.parseMsg( 'apisandbox-continue-help' ) ),
1238 if ( typeof loadTime
=== 'number' ) {
1240 $( '<div>' ).append(
1241 new OO
.ui
.LabelWidget( {
1242 label
: mw
.message( 'apisandbox-request-time', loadTime
).text()
1248 if ( jqXHR
.getResponseHeader( 'MediaWiki-API-Error' ) === 'badtoken' ) {
1249 // Flush all saved tokens in case one of them is the bad one.
1250 Util
.markTokensBad();
1251 button
= new OO
.ui
.ButtonWidget( {
1252 label
: mw
.message( 'apisandbox-results-fixtoken' ).text()
1254 button
.on( 'click', ApiSandbox
.fixTokenAndResend
)
1255 .on( 'click', button
.setDisabled
, [ true ], button
)
1256 .$element
.appendTo( $result
);
1258 }, function ( code
, data
) {
1259 var details
= 'HTTP error: ' + data
.exception
;
1262 new OO
.ui
.LabelWidget( {
1263 label
: mw
.message( 'apisandbox-results-error', details
).text(),
1264 classes
: [ 'error' ]
1272 * Handler for the "Correct token and resubmit" button
1274 * Used on a 'badtoken' error, it re-fetches token parameters for all
1275 * pages and then re-submits the query.
1277 fixTokenAndResend: function () {
1278 var page
, subpages
, i
, k
,
1280 tokenWait
= { dummy
: true },
1281 checkPages
= [ pages
.main
],
1282 success = function ( k
) {
1283 delete tokenWait
[ k
];
1284 if ( ok
&& $.isEmptyObject( tokenWait
) ) {
1285 ApiSandbox
.sendRequest();
1288 failure = function ( k
) {
1289 delete tokenWait
[ k
];
1293 while ( checkPages
.length
) {
1294 page
= checkPages
.shift();
1296 if ( page
.tokenWidget
) {
1297 k
= page
.apiModule
+ page
.tokenWidget
.paramInfo
.name
;
1298 tokenWait
[ k
] = page
.tokenWidget
.fetchToken();
1300 .done( success
.bind( page
.tokenWidget
, k
) )
1301 .fail( failure
.bind( page
.tokenWidget
, k
) );
1304 subpages
= page
.getSubpages();
1305 for ( i
= 0; i
< subpages
.length
; i
++ ) {
1306 if ( Object
.prototype.hasOwnProperty
.call( pages
, subpages
[ i
].key
) ) {
1307 checkPages
.push( pages
[ subpages
[ i
].key
] );
1312 success( 'dummy', '' );
1316 * Reset validity indicators for all widgets
1318 updateValidityIndicators: function () {
1319 var page
, subpages
, i
,
1320 checkPages
= [ pages
.main
];
1322 while ( checkPages
.length
) {
1323 page
= checkPages
.shift();
1324 page
.apiCheckValid();
1325 subpages
= page
.getSubpages();
1326 for ( i
= 0; i
< subpages
.length
; i
++ ) {
1327 if ( Object
.prototype.hasOwnProperty
.call( pages
, subpages
[ i
].key
) ) {
1328 checkPages
.push( pages
[ subpages
[ i
].key
] );
1336 * PageLayout for API modules
1340 * @extends OO.ui.PageLayout
1342 * @param {Object} [config] Configuration options
1344 ApiSandbox
.PageLayout = function ( config
) {
1345 config
= $.extend( { prefix
: '', expanded
: false }, config
);
1346 this.displayText
= config
.key
;
1347 this.apiModule
= config
.path
;
1348 this.prefix
= config
.prefix
;
1349 this.paramInfo
= null;
1350 this.apiIsValid
= true;
1351 this.loadFromQueryParams
= null;
1353 this.itemsFieldset
= null;
1354 this.deprecatedItemsFieldset
= null;
1355 this.templatedItemsCache
= {};
1356 this.tokenWidget
= null;
1357 this.indentLevel
= config
.indentLevel
? config
.indentLevel
: 0;
1358 ApiSandbox
.PageLayout
.super.call( this, config
.key
, config
);
1359 this.loadParamInfo();
1361 OO
.inheritClass( ApiSandbox
.PageLayout
, OO
.ui
.PageLayout
);
1362 ApiSandbox
.PageLayout
.prototype.setupOutlineItem = function () {
1363 this.outlineItem
.setLevel( this.indentLevel
);
1364 this.outlineItem
.setLabel( this.displayText
);
1365 this.outlineItem
.setIcon( this.apiIsValid
|| suppressErrors
? null : 'alert' );
1366 this.outlineItem
.setIconTitle(
1367 this.apiIsValid
|| suppressErrors
? '' : mw
.message( 'apisandbox-alert-page' ).plain()
1371 function widgetLabelOnClick() {
1372 var f
= this.getField();
1373 if ( typeof f
.setDisabled
=== 'function' ) {
1374 f
.setDisabled( false );
1376 if ( typeof f
.focus
=== 'function' ) {
1382 * Create a widget and the FieldLayouts it needs
1384 * @param {Object} ppi API paraminfo data for the parameter
1385 * @param {string} name API parameter name
1387 * @return {OO.ui.Widget} return.widget
1388 * @return {OO.ui.FieldLayout} return.widgetField
1389 * @return {OO.ui.FieldLayout} return.helpField
1391 ApiSandbox
.PageLayout
.prototype.makeWidgetFieldLayouts = function ( ppi
, name
) {
1392 var j
, l
, widget
, descriptionContainer
, tmp
, flag
, count
, button
, widgetField
, helpField
, layoutConfig
;
1394 widget
= Util
.createWidgetForParameter( ppi
);
1395 if ( ppi
.tokentype
) {
1396 this.tokenWidget
= widget
;
1398 if ( this.paramInfo
.templatedparameters
.length
) {
1399 widget
.on( 'change', this.updateTemplatedParameters
, [ null ], this );
1402 descriptionContainer
= $( '<div>' );
1404 tmp
= Util
.parseHTML( ppi
.description
);
1405 tmp
.filter( 'dl' ).makeCollapsible( {
1407 } ).children( '.mw-collapsible-toggle' ).each( function () {
1408 var $this = $( this );
1409 $this.parent().prev( 'p' ).append( $this );
1411 descriptionContainer
.append( $( '<div>' ).addClass( 'description' ).append( tmp
) );
1413 if ( ppi
.info
&& ppi
.info
.length
) {
1414 for ( j
= 0; j
< ppi
.info
.length
; j
++ ) {
1415 descriptionContainer
.append( $( '<div>' )
1417 .append( Util
.parseHTML( ppi
.info
[ j
] ) )
1423 switch ( ppi
.type
) {
1426 count
= mw
.config
.get( 'wgFormattedNamespaces' ).length
;
1430 if ( ppi
.highmax
!== undefined ) {
1431 descriptionContainer
.append( $( '<div>' )
1435 'api-help-param-limit2', ppi
.max
, ppi
.highmax
1438 Util
.parseMsg( 'apisandbox-param-limit' )
1442 descriptionContainer
.append( $( '<div>' )
1445 Util
.parseMsg( 'api-help-param-limit', ppi
.max
),
1447 Util
.parseMsg( 'apisandbox-param-limit' )
1455 if ( ppi
.min
!== undefined ) {
1458 if ( ppi
.max
!== undefined ) {
1462 descriptionContainer
.append( $( '<div>' )
1464 .append( Util
.parseMsg(
1465 'api-help-param-integer-' + tmp
,
1466 Util
.apiBool( ppi
.multi
) ? 2 : 1,
1474 if ( Array
.isArray( ppi
.type
) ) {
1476 count
= ppi
.type
.length
;
1480 if ( Util
.apiBool( ppi
.multi
) ) {
1482 if ( flag
&& !( widget
instanceof OO
.ui
.TagMultiselectWidget
) &&
1484 widget
instanceof OptionalWidget
&&
1485 widget
.widget
instanceof OO
.ui
.TagMultiselectWidget
1488 tmp
.push( mw
.message( 'api-help-param-multi-separate' ).parse() );
1490 if ( count
> ppi
.lowlimit
) {
1492 mw
.message( 'api-help-param-multi-max', ppi
.lowlimit
, ppi
.highlimit
).parse()
1496 descriptionContainer
.append( $( '<div>' )
1498 .append( Util
.parseHTML( tmp
.join( ' ' ) ) )
1502 if ( 'maxbytes' in ppi
) {
1503 descriptionContainer
.append( $( '<div>' )
1505 .append( Util
.parseMsg( 'api-help-param-maxbytes', ppi
.maxbytes
) )
1508 if ( 'maxchars' in ppi
) {
1509 descriptionContainer
.append( $( '<div>' )
1511 .append( Util
.parseMsg( 'api-help-param-maxchars', ppi
.maxchars
) )
1514 if ( ppi
.usedTemplateVars
&& ppi
.usedTemplateVars
.length
) {
1516 for ( j
= 0, l
= ppi
.usedTemplateVars
.length
; j
< l
; j
++ ) {
1517 tmp
= tmp
.add( $( '<var>' ).text( ppi
.usedTemplateVars
[ j
] ) );
1518 if ( j
=== l
- 2 ) {
1519 tmp
= tmp
.add( mw
.message( 'and' ).parseDom() );
1520 tmp
= tmp
.add( mw
.message( 'word-separator' ).parseDom() );
1521 } else if ( j
!== l
- 1 ) {
1522 tmp
= tmp
.add( mw
.message( 'comma-separator' ).parseDom() );
1525 descriptionContainer
.append( $( '<div>' )
1527 .append( Util
.parseMsg(
1528 'apisandbox-templated-parameter-reason',
1529 ppi
.usedTemplateVars
.length
,
1535 helpField
= new OO
.ui
.FieldLayout(
1538 classes
: [ 'mw-apisandbox-spacer' ]
1541 classes
: [ 'mw-apisandbox-help-field' ],
1542 label
: descriptionContainer
1548 classes
: [ 'mw-apisandbox-widget-field' ],
1552 if ( ppi
.tokentype
) {
1553 button
= new OO
.ui
.ButtonWidget( {
1554 label
: mw
.message( 'apisandbox-fetch-token' ).text()
1556 button
.on( 'click', widget
.fetchToken
, [], widget
);
1558 widgetField
= new OO
.ui
.ActionFieldLayout( widget
, button
, layoutConfig
);
1560 widgetField
= new OO
.ui
.FieldLayout( widget
, layoutConfig
);
1563 // We need our own click handler on the widget label to
1564 // turn off the disablement.
1565 widgetField
.$label
.on( 'click', widgetLabelOnClick
.bind( widgetField
) );
1567 // Don't grey out the label when the field is disabled,
1568 // it makes it too hard to read and our "disabled"
1569 // isn't really disabled.
1570 widgetField
.onFieldDisable( false );
1571 widgetField
.onFieldDisable
= $.noop
;
1573 widgetField
.apiParamIndex
= ppi
.index
;
1577 widgetField
: widgetField
,
1578 helpField
: helpField
1583 * Update templated parameters in the page
1585 * @param {Object} [params] Query parameters for initializing the widgets
1587 ApiSandbox
.PageLayout
.prototype.updateTemplatedParameters = function ( params
) {
1588 var p
, toProcess
, doProcess
, tmp
, toRemove
,
1590 pi
= this.paramInfo
,
1591 prefix
= that
.prefix
+ pi
.prefix
;
1593 if ( !pi
|| !pi
.templatedparameters
.length
) {
1597 if ( !$.isPlainObject( params
) ) {
1602 // eslint-disable-next-line jquery/no-each-util
1603 $.each( this.templatedItemsCache
, function ( k
, el
) {
1604 if ( el
.widget
.isElementAttached() ) {
1609 // This bit duplicates the PHP logic in ApiBase::extractRequestParams().
1610 // If you update this, see if that needs updating too.
1611 toProcess
= pi
.templatedparameters
.map( function ( p
) {
1613 name
: prefix
+ p
.name
,
1615 vars
: $.extend( {}, p
.templatevars
),
1619 doProcess = function ( placeholder
, target
) {
1620 var values
, container
, index
, usedVars
, done
, items
, i
;
1622 target
= prefix
+ target
;
1624 if ( !that
.widgets
[ target
] ) {
1625 // The target wasn't processed yet, try the next one.
1626 // If all hit this case, the parameter has no expansions.
1630 if ( !that
.widgets
[ target
].getApiValueForTemplates
) {
1631 // Not a multi-valued widget, so it can't have expansions.
1635 values
= that
.widgets
[ target
].getApiValueForTemplates();
1636 if ( !Array
.isArray( values
) || !values
.length
) {
1637 // The target was processed but has no (valid) values.
1638 // That means it has no expansions.
1642 // Expand this target in the name and all other targets,
1643 // then requeue if there are more targets left or create the widget
1644 // and add it to the form if all are done.
1645 delete p
.vars
[ placeholder
];
1646 usedVars
= p
.usedVars
.concat( [ target
] );
1647 placeholder
= '{' + placeholder
+ '}';
1648 done
= $.isEmptyObject( p
.vars
);
1650 container
= Util
.apiBool( p
.info
.deprecated
) ? that
.deprecatedItemsFieldset
: that
.itemsFieldset
;
1651 items
= container
.getItems();
1653 for ( i
= 0; i
< items
.length
; i
++ ) {
1654 if ( items
[ i
].apiParamIndex
!== undefined && items
[ i
].apiParamIndex
> p
.info
.index
) {
1660 values
.forEach( function ( value
) {
1663 if ( !/^[^{}]*$/.exec( value
) ) {
1664 // Skip values that make invalid parameter names
1668 name
= p
.name
.replace( placeholder
, value
);
1670 if ( that
.templatedItemsCache
[ name
] ) {
1671 tmp
= that
.templatedItemsCache
[ name
];
1673 tmp
= that
.makeWidgetFieldLayouts(
1674 $.extend( {}, p
.info
, { usedTemplateVars
: usedVars
} ), name
1676 that
.templatedItemsCache
[ name
] = tmp
;
1678 delete toRemove
[ name
];
1679 if ( !tmp
.widget
.isElementAttached() ) {
1680 that
.widgets
[ name
] = tmp
.widget
;
1681 container
.addItems( [ tmp
.widgetField
, tmp
.helpField
], index
);
1682 if ( index
!== undefined ) {
1687 tmp
.widget
.setApiValue( Object
.prototype.hasOwnProperty
.call( params
, name
) ? params
[ name
] : undefined );
1691 // eslint-disable-next-line jquery/no-each-util
1692 $.each( p
.vars
, function ( k
, v
) {
1693 newVars
[ k
] = v
.replace( placeholder
, value
);
1705 while ( toProcess
.length
) {
1706 p
= toProcess
.shift();
1707 // eslint-disable-next-line jquery/no-each-util
1708 $.each( p
.vars
, doProcess
);
1711 // eslint-disable-next-line jquery/no-map-util
1712 toRemove
= $.map( toRemove
, function ( el
, name
) {
1713 delete that
.widgets
[ name
];
1714 return [ el
.widgetField
, el
.helpField
];
1716 if ( toRemove
.length
) {
1717 this.itemsFieldset
.removeItems( toRemove
);
1718 this.deprecatedItemsFieldset
.removeItems( toRemove
);
1723 * Fetch module information for this page's module, then create UI
1725 ApiSandbox
.PageLayout
.prototype.loadParamInfo = function () {
1726 var dynamicFieldset
, dynamicParamNameWidget
,
1728 removeDynamicParamWidget = function ( name
, layout
) {
1729 dynamicFieldset
.removeItems( [ layout
] );
1730 delete that
.widgets
[ name
];
1732 addDynamicParamWidget = function () {
1733 var name
, layout
, widget
, button
;
1735 // Check name is filled in
1736 name
= dynamicParamNameWidget
.getValue().trim();
1737 if ( name
=== '' ) {
1738 dynamicParamNameWidget
.focus();
1742 if ( that
.widgets
[ name
] !== undefined ) {
1743 windowManager
.openWindow( 'errorAlert', {
1744 title
: Util
.parseMsg( 'apisandbox-dynamic-error-exists', name
),
1748 label
: OO
.ui
.msg( 'ooui-dialog-process-dismiss' ),
1756 widget
= Util
.createWidgetForParameter( {
1763 button
= new OO
.ui
.ButtonWidget( {
1765 flags
: 'destructive'
1767 layout
= new OO
.ui
.ActionFieldLayout(
1775 button
.on( 'click', removeDynamicParamWidget
, [ name
, layout
] );
1776 that
.widgets
[ name
] = widget
;
1777 dynamicFieldset
.addItems( [ layout
], dynamicFieldset
.getItems().length
- 1 );
1780 dynamicParamNameWidget
.setValue( '' );
1783 this.$element
.empty()
1784 .append( new OO
.ui
.ProgressBarWidget( {
1786 text
: mw
.message( 'apisandbox-loading', this.displayText
).text()
1789 Util
.fetchModuleInfo( this.apiModule
)
1790 .done( function ( pi
) {
1791 var prefix
, i
, j
, tmp
,
1793 deprecatedItems
= [],
1795 filterFmModules = function ( v
) {
1796 return v
.substr( -2 ) !== 'fm' ||
1797 !Object
.prototype.hasOwnProperty
.call( availableFormats
, v
.substr( 0, v
.length
- 2 ) );
1800 // This is something of a hack. We always want the 'format' and
1801 // 'action' parameters from the main module to be specified,
1802 // and for 'format' we also want to simplify the dropdown since
1803 // we always send the 'fm' variant.
1804 if ( that
.apiModule
=== 'main' ) {
1805 for ( i
= 0; i
< pi
.parameters
.length
; i
++ ) {
1806 if ( pi
.parameters
[ i
].name
=== 'action' ) {
1807 pi
.parameters
[ i
].required
= true;
1808 delete pi
.parameters
[ i
].default;
1810 if ( pi
.parameters
[ i
].name
=== 'format' ) {
1811 tmp
= pi
.parameters
[ i
].type
;
1812 for ( j
= 0; j
< tmp
.length
; j
++ ) {
1813 availableFormats
[ tmp
[ j
] ] = true;
1815 pi
.parameters
[ i
].type
= tmp
.filter( filterFmModules
);
1816 pi
.parameters
[ i
].default = 'json';
1817 pi
.parameters
[ i
].required
= true;
1822 // Hide the 'wrappedhtml' parameter on format modules
1823 if ( pi
.group
=== 'format' ) {
1824 pi
.parameters
= pi
.parameters
.filter( function ( p
) {
1825 return p
.name
!== 'wrappedhtml';
1829 that
.paramInfo
= pi
;
1831 items
.push( new OO
.ui
.FieldLayout(
1832 new OO
.ui
.Widget( {} ).toggle( false ), {
1834 label
: Util
.parseHTML( pi
.description
)
1838 if ( pi
.helpurls
.length
) {
1839 buttons
.push( new OO
.ui
.PopupButtonWidget( {
1841 label
: mw
.message( 'apisandbox-helpurls' ).text(),
1846 $content
: $( '<ul>' ).append( pi
.helpurls
.map( function ( link
) {
1847 return $( '<li>' ).append( $( '<a>' )
1848 .attr( { href
: link
, target
: '_blank' } )
1856 if ( pi
.examples
.length
) {
1857 buttons
.push( new OO
.ui
.PopupButtonWidget( {
1859 label
: mw
.message( 'apisandbox-examples' ).text(),
1864 $content
: $( '<ul>' ).append( pi
.examples
.map( function ( example
) {
1866 .attr( 'href', '#' + example
.query
)
1867 .html( example
.description
);
1868 a
.find( 'a' ).contents().unwrap(); // Can't nest links
1869 return $( '<li>' ).append( a
);
1875 if ( buttons
.length
) {
1876 items
.push( new OO
.ui
.FieldLayout(
1877 new OO
.ui
.ButtonGroupWidget( {
1879 } ), { align
: 'top' }
1883 if ( pi
.parameters
.length
) {
1884 prefix
= that
.prefix
+ pi
.prefix
;
1885 for ( i
= 0; i
< pi
.parameters
.length
; i
++ ) {
1886 tmp
= that
.makeWidgetFieldLayouts( pi
.parameters
[ i
], prefix
+ pi
.parameters
[ i
].name
);
1887 that
.widgets
[ prefix
+ pi
.parameters
[ i
].name
] = tmp
.widget
;
1888 if ( Util
.apiBool( pi
.parameters
[ i
].deprecated
) ) {
1889 deprecatedItems
.push( tmp
.widgetField
, tmp
.helpField
);
1891 items
.push( tmp
.widgetField
, tmp
.helpField
);
1896 if ( !pi
.parameters
.length
&& !Util
.apiBool( pi
.dynamicparameters
) ) {
1897 items
.push( new OO
.ui
.FieldLayout(
1898 new OO
.ui
.Widget( {} ).toggle( false ), {
1900 label
: Util
.parseMsg( 'apisandbox-no-parameters' )
1905 that
.$element
.empty();
1907 that
.itemsFieldset
= new OO
.ui
.FieldsetLayout( {
1908 label
: that
.displayText
1910 that
.itemsFieldset
.addItems( items
);
1911 that
.itemsFieldset
.$element
.appendTo( that
.$element
);
1913 if ( Util
.apiBool( pi
.dynamicparameters
) ) {
1914 dynamicFieldset
= new OO
.ui
.FieldsetLayout();
1915 dynamicParamNameWidget
= new OO
.ui
.TextInputWidget( {
1916 placeholder
: mw
.message( 'apisandbox-dynamic-parameters-add-placeholder' ).text()
1917 } ).on( 'enter', addDynamicParamWidget
);
1918 dynamicFieldset
.addItems( [
1919 new OO
.ui
.FieldLayout(
1920 new OO
.ui
.Widget( {} ).toggle( false ), {
1922 label
: Util
.parseHTML( pi
.dynamicparameters
)
1925 new OO
.ui
.ActionFieldLayout(
1926 dynamicParamNameWidget
,
1927 new OO
.ui
.ButtonWidget( {
1929 flags
: 'progressive'
1930 } ).on( 'click', addDynamicParamWidget
),
1932 label
: mw
.message( 'apisandbox-dynamic-parameters-add-label' ).text(),
1939 $( '<legend>' ).text( mw
.message( 'apisandbox-dynamic-parameters' ).text() ),
1940 dynamicFieldset
.$element
1942 .appendTo( that
.$element
);
1945 that
.deprecatedItemsFieldset
= new OO
.ui
.FieldsetLayout().addItems( deprecatedItems
).toggle( false );
1946 tmp
= $( '<fieldset>' )
1947 .toggle( !that
.deprecatedItemsFieldset
.isEmpty() )
1949 $( '<legend>' ).append(
1950 new OO
.ui
.ToggleButtonWidget( {
1951 label
: mw
.message( 'apisandbox-deprecated-parameters' ).text()
1952 } ).on( 'change', that
.deprecatedItemsFieldset
.toggle
, [], that
.deprecatedItemsFieldset
).$element
1954 that
.deprecatedItemsFieldset
.$element
1956 .appendTo( that
.$element
);
1957 that
.deprecatedItemsFieldset
.on( 'add', function () {
1958 this.toggle( !that
.deprecatedItemsFieldset
.isEmpty() );
1960 that
.deprecatedItemsFieldset
.on( 'remove', function () {
1961 this.toggle( !that
.deprecatedItemsFieldset
.isEmpty() );
1964 // Load stored params, if any, then update the booklet if we
1965 // have subpages (or else just update our valid-indicator).
1966 tmp
= that
.loadFromQueryParams
;
1967 that
.loadFromQueryParams
= null;
1968 if ( $.isPlainObject( tmp
) ) {
1969 that
.loadQueryParams( tmp
);
1971 that
.updateTemplatedParameters();
1973 if ( that
.getSubpages().length
> 0 ) {
1974 ApiSandbox
.updateUI( tmp
);
1976 that
.apiCheckValid();
1978 } ).fail( function ( code
, detail
) {
1979 that
.$element
.empty()
1981 new OO
.ui
.LabelWidget( {
1982 label
: mw
.message( 'apisandbox-load-error', that
.apiModule
, detail
).text(),
1983 classes
: [ 'error' ]
1985 new OO
.ui
.ButtonWidget( {
1986 label
: mw
.message( 'apisandbox-retry' ).text()
1987 } ).on( 'click', that
.loadParamInfo
, [], that
).$element
1993 * Check that all widgets on the page are in a valid state.
1995 * @return {jQuery.Promise[]} One promise for each widget, resolved with `false` if invalid
1997 ApiSandbox
.PageLayout
.prototype.apiCheckValid = function () {
1998 var promises
, that
= this;
2000 if ( this.paramInfo
=== null ) {
2003 // eslint-disable-next-line jquery/no-map-util
2004 promises
= $.map( this.widgets
, function ( widget
) {
2005 return widget
.apiCheckValid();
2007 $.when
.apply( $, promises
).then( function () {
2008 that
.apiIsValid
= Array
.prototype.indexOf
.call( arguments
, false ) === -1;
2009 if ( that
.getOutlineItem() ) {
2010 that
.getOutlineItem().setIcon( that
.apiIsValid
|| suppressErrors
? null : 'alert' );
2011 that
.getOutlineItem().setIconTitle(
2012 that
.apiIsValid
|| suppressErrors
? '' : mw
.message( 'apisandbox-alert-page' ).plain()
2021 * Load form fields from query parameters
2023 * @param {Object} params
2025 ApiSandbox
.PageLayout
.prototype.loadQueryParams = function ( params
) {
2026 if ( this.paramInfo
=== null ) {
2027 this.loadFromQueryParams
= params
;
2029 // eslint-disable-next-line jquery/no-each-util
2030 $.each( this.widgets
, function ( name
, widget
) {
2031 var v
= Object
.prototype.hasOwnProperty
.call( params
, name
) ? params
[ name
] : undefined;
2032 widget
.setApiValue( v
);
2034 this.updateTemplatedParameters( params
);
2039 * Load query params from form fields
2041 * @param {Object} params Write query parameters into this object
2042 * @param {Object} displayParams Write query parameters for display into this object
2044 ApiSandbox
.PageLayout
.prototype.getQueryParams = function ( params
, displayParams
) {
2045 // eslint-disable-next-line jquery/no-each-util
2046 $.each( this.widgets
, function ( name
, widget
) {
2047 var value
= widget
.getApiValue();
2048 if ( value
!== undefined ) {
2049 params
[ name
] = value
;
2050 if ( typeof widget
.getApiValueForDisplay
=== 'function' ) {
2051 value
= widget
.getApiValueForDisplay();
2053 displayParams
[ name
] = value
;
2059 * Fetch a list of subpage names loaded by this page
2063 ApiSandbox
.PageLayout
.prototype.getSubpages = function () {
2065 // eslint-disable-next-line jquery/no-each-util
2066 $.each( this.widgets
, function ( name
, widget
) {
2068 if ( typeof widget
.getSubmodules
=== 'function' ) {
2069 submodules
= widget
.getSubmodules();
2070 for ( i
= 0; i
< submodules
.length
; i
++ ) {
2072 key
: name
+ '=' + submodules
[ i
].value
,
2073 path
: submodules
[ i
].path
,
2074 prefix
: widget
.paramInfo
.submoduleparamprefix
|| ''
2082 $( ApiSandbox
.init
);
2084 module
.exports
= ApiSandbox
;