mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/TemplateData
synced 2024-11-27 17:20:01 +00:00
379 lines
10 KiB
JavaScript
379 lines
10 KiB
JavaScript
/**
|
|
* Template data edit ui target
|
|
*
|
|
* @class
|
|
* @abstract
|
|
* @extends OO.ui.Element
|
|
* @mixin OO.EventEmitter
|
|
*
|
|
* @constructor
|
|
* @param {Object} config Configuration options
|
|
*/
|
|
mw.TemplateData.Target = function mwTemplateDataTarget( config ) {
|
|
var $helpLink, relatedPage,
|
|
target = this;
|
|
|
|
// Parent constructor
|
|
mw.TemplateData.Target.super.apply( this, arguments );
|
|
|
|
// Mixin constructor
|
|
OO.EventEmitter.call( this );
|
|
|
|
this.pageName = config.pageName;
|
|
this.parentPage = config.parentPage;
|
|
this.isPageSubLevel = !!config.isPageSubLevel;
|
|
this.isDocPage = !!config.isDocPage;
|
|
|
|
this.editOpenDialogButton = new OO.ui.ButtonWidget( {
|
|
label: mw.msg( 'templatedata-editbutton' )
|
|
} );
|
|
|
|
this.editNoticeLabel = new OO.ui.LabelWidget( {
|
|
classes: [ 'tdg-editscreen-error-msg' ]
|
|
} )
|
|
.toggle( false );
|
|
|
|
$helpLink = $( '<a>' )
|
|
.attr( {
|
|
href: mw.msg( 'templatedata-helplink-target' ),
|
|
target: '_blank'
|
|
} )
|
|
.addClass( 'tdg-editscreen-main-helplink' )
|
|
.text( mw.msg( 'templatedata-helplink' ) );
|
|
|
|
this.windowManager = new OO.ui.WindowManager();
|
|
$( 'body' ).append( this.windowManager.$element );
|
|
|
|
// Dialog
|
|
this.tdgDialog = new mw.TemplateData.Dialog( config );
|
|
this.windowManager.addWindows( [ this.tdgDialog ] );
|
|
|
|
this.sourceHandler = new mw.TemplateData.SourceHandler( {
|
|
fullPageName: this.pageName,
|
|
parentPage: this.parentPage,
|
|
isPageSubLevel: this.isPageSubLevel
|
|
} );
|
|
|
|
// Check if there's already a templatedata in a related page
|
|
// TODO: Hard-coding 'doc' is dangerous for i18n. We need to find
|
|
// a better way to define 'related' pages for a template.
|
|
relatedPage = this.isDocPage ? this.parentPage : this.pageName + '/doc';
|
|
this.sourceHandler.getApi( relatedPage )
|
|
.then( function ( result ) {
|
|
var msg, matches, content,
|
|
response = result.query.pages[ result.query.pageids[ 0 ] ];
|
|
// HACK: When checking whether a related page (parent for /doc page or
|
|
// vice versa) already has a templatedata string, we shouldn't
|
|
// ask for the 'templatedata' action but rather the actual content
|
|
// of the related page, otherwise we get embedded templatedata and
|
|
// wrong information is presented.
|
|
if ( response.missing === undefined ) {
|
|
content = response.revisions[ 0 ][ '*' ];
|
|
matches = content.match( /<templatedata>/i );
|
|
// There's a templatedata string
|
|
if ( matches ) {
|
|
// HACK: Setting a link in the messages doesn't work. The bug report offers
|
|
// a somewhat hacky work around that includes setting a separate message
|
|
// to be parsed.
|
|
// https://phabricator.wikimedia.org/T49395#490610
|
|
msg = mw.message( 'templatedata-exists-on-related-page', relatedPage ).plain();
|
|
mw.messages.set( { 'templatedata-string-exists-hack-message': msg } );
|
|
msg = mw.message( 'templatedata-string-exists-hack-message' ).parse();
|
|
|
|
target.setNoticeMessage( msg, 'warning', true );
|
|
}
|
|
}
|
|
} );
|
|
|
|
// Events
|
|
this.editOpenDialogButton.connect( this, { click: 'onEditOpenDialogButton' } );
|
|
this.tdgDialog.connect( this, { apply: 'onDialogApply' } );
|
|
|
|
this.$element
|
|
.addClass( 'tdg-editscreen-main' )
|
|
.append(
|
|
this.editOpenDialogButton.$element,
|
|
$helpLink,
|
|
this.editNoticeLabel.$element
|
|
);
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
OO.inheritClass( mw.TemplateData.Target, OO.ui.Element );
|
|
|
|
OO.mixinClass( mw.TemplateData.Target, OO.EventEmitter );
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* Get wikitext from the editor
|
|
*
|
|
* @method
|
|
* @abstract
|
|
* @return {string} Wikitext
|
|
*/
|
|
mw.TemplateData.Target.prototype.getWikitext = null;
|
|
|
|
/**
|
|
* Write wikitext back to the target
|
|
*
|
|
* @method
|
|
* @abstract
|
|
* @param {string} newWikitext New wikitext
|
|
*/
|
|
mw.TemplateData.Target.prototype.setWikitext = null;
|
|
|
|
/**
|
|
* Destroy the target
|
|
*/
|
|
mw.TemplateData.Target.prototype.destroy = function () {
|
|
this.windowManager.destroy();
|
|
this.$element.remove();
|
|
};
|
|
|
|
/**
|
|
* Display error message in the edit window
|
|
*
|
|
* @method setNoticeMessage
|
|
* @param {string} msg Message to display
|
|
* @param {string} [type='error'] Message type 'notice' or 'warning' or 'error'
|
|
* @param {boolean} [parseHTML] The message should be parsed
|
|
*/
|
|
mw.TemplateData.Target.prototype.setNoticeMessage = function ( msg, type, parseHTML ) {
|
|
type = type || 'error';
|
|
this.editNoticeLabel.$element
|
|
.toggleClass( 'errorbox', type === 'error' )
|
|
.toggleClass( 'warningbox', type === 'warning' );
|
|
|
|
if ( parseHTML ) {
|
|
// OOUI's label elements do not parse strings and display them
|
|
// as-is. If the message contains html that should be parsed,
|
|
// we have to transform it into a jQuery object
|
|
msg = $( '<span>' ).append( $.parseHTML( msg ) );
|
|
}
|
|
this.editNoticeLabel.setLabel( msg );
|
|
this.editNoticeLabel.toggle( true );
|
|
};
|
|
|
|
/**
|
|
* Reset the error message in the edit window
|
|
*
|
|
* @method resetNoticeMessage
|
|
*/
|
|
mw.TemplateData.Target.prototype.resetNoticeMessage = function () {
|
|
this.editNoticeLabel.setLabel( '' );
|
|
this.editNoticeLabel.toggle( false );
|
|
};
|
|
|
|
/**
|
|
* Open the templatedata edit dialog
|
|
*
|
|
* @method openEditDialog
|
|
* @param {mw.TemplateData.Model} dataModel The data model
|
|
* associated with this edit dialog.
|
|
*/
|
|
mw.TemplateData.Target.prototype.openEditDialog = function ( dataModel ) {
|
|
// Open the edit dialog
|
|
this.windowManager.openWindow( 'TemplateDataDialog', {
|
|
model: dataModel
|
|
} );
|
|
};
|
|
|
|
/**
|
|
* Respond to edit dialog button click.
|
|
*
|
|
* @method onEditOpenDialogButton
|
|
*/
|
|
mw.TemplateData.Target.prototype.onEditOpenDialogButton = function () {
|
|
var target = this;
|
|
|
|
// Reset notice message
|
|
this.resetNoticeMessage();
|
|
|
|
this.originalWikitext = this.getWikitext();
|
|
|
|
// Build the model
|
|
this.sourceHandler.buildModel( this.originalWikitext )
|
|
.then(
|
|
// Success
|
|
function ( model ) {
|
|
target.openEditDialog( model );
|
|
},
|
|
// Failure
|
|
function () {
|
|
// Open a message dialog
|
|
OO.ui.getWindowManager().openWindow( 'message', {
|
|
title: mw.msg( 'templatedata-modal-title' ),
|
|
message: mw.msg( 'templatedata-errormsg-jsonbadformat' ),
|
|
verbose: true,
|
|
actions: [
|
|
{
|
|
action: 'accept',
|
|
label: mw.msg( 'templatedata-modal-json-error-replace' ),
|
|
flags: [ 'primary', 'destructive' ]
|
|
},
|
|
{
|
|
action: 'reject',
|
|
label: OO.ui.deferMsg( 'ooui-dialog-message-reject' ),
|
|
flags: 'safe'
|
|
}
|
|
]
|
|
} ).closed.then( function ( data ) {
|
|
var model;
|
|
if ( data && data.action === 'accept' ) {
|
|
// Open the dialog with an empty model
|
|
model = mw.TemplateData.Model.static.newFromObject(
|
|
{ params: {} },
|
|
target.sourceHandler.getTemplateSourceCodeParams()
|
|
);
|
|
target.openEditDialog( model );
|
|
}
|
|
} );
|
|
}
|
|
);
|
|
};
|
|
|
|
/**
|
|
* Replace the old templatedata string with the new one, or
|
|
* insert the new one into the page if an old one doesn't exist
|
|
*
|
|
* @method replaceTemplateData
|
|
* @param {Object} newTemplateData New templatedata
|
|
* @return {string} Full wikitext content with the new templatedata
|
|
* string.
|
|
*/
|
|
mw.TemplateData.Target.prototype.replaceTemplateData = function ( newTemplateData ) {
|
|
var finalOutput,
|
|
endNoIncludeLength = '</noinclude>'.length,
|
|
// NB: This pattern contains no matching groups: (). This avoids
|
|
// corruption if the template data JSON contains $1 etc.
|
|
templatedataPattern = /<templatedata>[\s\S]*?<\/templatedata>/i;
|
|
|
|
if ( this.originalWikitext.match( templatedataPattern ) ) {
|
|
// <templatedata> exists. Replace it
|
|
finalOutput = this.originalWikitext.replace(
|
|
templatedataPattern,
|
|
'<templatedata>\n' + JSON.stringify( newTemplateData, null, '\t' ) + '\n</templatedata>'
|
|
);
|
|
} else {
|
|
finalOutput = this.originalWikitext;
|
|
if ( finalOutput.substr( -1 ) !== '\n' ) {
|
|
finalOutput += '\n';
|
|
}
|
|
|
|
if ( !this.isPageSubLevel ) {
|
|
if ( finalOutput.substr( -endNoIncludeLength - 1 ) === '</noinclude>\n' ) {
|
|
finalOutput = finalOutput.substr( 0, finalOutput.length - endNoIncludeLength - 1 );
|
|
} else {
|
|
finalOutput += '<noinclude>\n';
|
|
}
|
|
}
|
|
finalOutput += '<templatedata>\n' +
|
|
JSON.stringify( newTemplateData, null, '\t' ) +
|
|
'\n</templatedata>\n';
|
|
if ( !this.isPageSubLevel ) {
|
|
finalOutput += '</noinclude>\n';
|
|
}
|
|
}
|
|
return finalOutput;
|
|
};
|
|
|
|
/**
|
|
* Respond to edit dialog apply event
|
|
*
|
|
* @method onDialogApply
|
|
* @param {Object} templateData New templatedata
|
|
*/
|
|
mw.TemplateData.Target.prototype.onDialogApply = function ( templateData ) {
|
|
var target = this;
|
|
|
|
if (
|
|
Object.keys( templateData ).length > 1 ||
|
|
Object.keys( templateData.params ).length > 0
|
|
) {
|
|
this.setWikitext( this.replaceTemplateData( templateData ) );
|
|
} else {
|
|
this.windowManager.closeWindow( this.windowManager.getCurrentWindow() );
|
|
OO.ui.getWindowManager().openWindow( 'message', {
|
|
title: mw.msg( 'templatedata-modal-title' ),
|
|
message: mw.msg( 'templatedata-errormsg-insertblank' ),
|
|
actions: [
|
|
{
|
|
label: mw.msg( 'templatedata-modal-button-cancel' ),
|
|
flags: [ 'primary', 'safe' ]
|
|
},
|
|
{
|
|
action: 'apply',
|
|
label: mw.msg( 'templatedata-modal-button-apply' )
|
|
}
|
|
]
|
|
} ).closed.then( function ( data ) {
|
|
if ( data && data.action === 'apply' ) {
|
|
target.setWikitext( target.replaceTemplateData( templateData ) );
|
|
}
|
|
} );
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Textarea target
|
|
*
|
|
* @class
|
|
* @extends mw.TemplateData.Target
|
|
*
|
|
* @constructor
|
|
* @param {jQuery} $textarea Editor textarea
|
|
* @param {Object} config Configuration options
|
|
*/
|
|
mw.TemplateData.TextareaTarget = function mwTemplateDataTextareaTarget( $textarea, config ) {
|
|
// Parent constructor
|
|
mw.TemplateData.TextareaTarget.super.call( this, config );
|
|
|
|
this.$textarea = $textarea;
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
OO.inheritClass( mw.TemplateData.TextareaTarget, mw.TemplateData.Target );
|
|
|
|
mw.TemplateData.TextareaTarget.prototype.getWikitext = function () {
|
|
return this.$textarea.val();
|
|
};
|
|
|
|
mw.TemplateData.TextareaTarget.prototype.setWikitext = function ( newWikitext ) {
|
|
this.$textarea.val( newWikitext );
|
|
};
|
|
|
|
/* global ve */
|
|
|
|
/**
|
|
* VisualEditor target
|
|
*
|
|
* @class
|
|
* @extends mw.TemplateData.Target
|
|
*
|
|
* @constructor
|
|
* @param {ve.ui.Surface} surface VE surface
|
|
* @param {Object} config Configuration options
|
|
*/
|
|
mw.TemplateData.VETarget = function mwTemplateDataVETarget( surface, config ) {
|
|
// Parent constructor
|
|
mw.TemplateData.VETarget.super.call( this, config );
|
|
|
|
this.surface = surface;
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
OO.inheritClass( mw.TemplateData.VETarget, mw.TemplateData.Target );
|
|
|
|
mw.TemplateData.VETarget.prototype.getWikitext = function () {
|
|
return this.surface.getDom();
|
|
};
|
|
|
|
mw.TemplateData.VETarget.prototype.setWikitext = function ( newWikitext ) {
|
|
this.surface.getModel().getLinearFragment( new ve.Range( 0, this.surface.getModel().getDocument().data.getLength() ) )
|
|
.insertContent( newWikitext );
|
|
};
|