wikimedia/mediawiki-extensions-VisualEditor
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor synced 2024-09-25 19:26:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge "Create SaveErrorHandler class to better define structure"

Browse source
This commit is contained in:
jenkins-bot 2018-11-30 23:06:11 +00:00 committed by Gerrit Code Review
parent 85e4bc7846 041e7b77a1
commit 7927a8e395
3 changed files with 77 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
extension.json
View file

@ -667,6 +667,7 @@
},
"ext.visualEditor.articleTarget": {
"scripts": [
"modules/ve-mw/init/ve.init.mw.SaveErrorHandler.js",
"modules/ve-mw/init/ve.init.mw.ArticleTarget.js",
"modules/ve-mw/init/ve.init.mw.ArticleTargetEvents.js",
"modules/ve-mw/ui/tools/ve.ui.MWEditModeTool.js"

60
modules/ve-mw/init/ve.init.mw.ArticleTarget.js
View file

@ -730,7 +730,7 @@ ve.init.mw.ArticleTarget.prototype.saveComplete = function () {
*/
ve.init.mw.ArticleTarget.prototype.saveFail = function ( doc, saveData, wasRetry, jqXHR, status, data ) {
var editApi, name, handler,
saveErrorHandlerRegistry = ve.init.mw.saveErrorHandlerRegistry,
saveErrorHandlerFactory = ve.init.mw.saveErrorHandlerFactory,
target = this;
this.saving = false;
@ -780,9 +780,10 @@ ve.init.mw.ArticleTarget.prototype.saveFail = function ( doc, saveData, wasRetry
return;
}
for ( name in saveErrorHandlerRegistry.registry ) {
handler = saveErrorHandlerRegistry.lookup( name );
if ( handler( editApi, this ) ) {
for ( name in saveErrorHandlerFactory.registry ) {
handler = saveErrorHandlerFactory.lookup( name );
if ( handler.static.matchFunction( editApi ) ) {
handler.static.process( editApi, this );
// Error was handled
return;
}
@ -2566,51 +2567,56 @@ ve.init.mw.ArticleTarget.prototype.renderCategories = function ( categoryItems )
*
* The method takes the editApi result object, and the target instance as arguments
* and should return a boolean indicating if the error was handled.
*
* Example:
* ve.init.mw.saveErrorHandlerRegistry.register( 'blocked', function ( editApi, target ) {
* if ( !editApi.blocked ) {
* return false;
* }
* target.showSaveError( $( $.parseHTML( editApi.blockedMessage ) ) );
* return true;
* } );
*/
ve.init.mw.saveErrorHandlerRegistry = new OO.Registry();
ve.init.mw.saveErrorHandlerFactory = new OO.Factory();
// TODO: Move these to their respective extensions
// Extension:AbuseFilter
ve.init.mw.saveErrorHandlerRegistry.register( 'abuseFilter', function ( editApi, target ) {
ve.init.mw.AbuseFilterSaveErrorHandler = function () {};
OO.inheritClass( ve.init.mw.AbuseFilterSaveErrorHandler, ve.init.mw.SaveErrorHandler );
ve.init.mw.AbuseFilterSaveErrorHandler.static.name = 'abuseFilter';
ve.init.mw.AbuseFilterSaveErrorHandler.static.matchFunction = function ( editApi ) {
return !!editApi.abusefilter;
};
ve.init.mw.AbuseFilterSaveErrorHandler.static.process = function ( editApi, target ) {
// Handle warnings/errors from Extension:AbuseFilter
if ( !editApi.abusefilter ) {
return false;
}
target.showSaveError( $( $.parseHTML( editApi.warning ) ) );
// Don't disable the save button. If the action is not disallowed the user may save the
// edit by pressing Save again. The AbuseFilter API currently has no way to distinguish
// between filter triggers that are and aren't disallowing the action.
// Emit event for tracking. TODO: This is a bad design
target.emit( 'saveErrorAbuseFilter' );
return true;
} );
};
ve.init.mw.saveErrorHandlerFactory.register( ve.init.mw.AbuseFilterSaveErrorHandler );
// Extension:SpamBlacklist
ve.init.mw.saveErrorHandlerRegistry.register( 'spamBlacklist', function ( editApi, target ) {
ve.init.mw.SpamBlacklistSaveErrorHandler = function () {};
OO.inheritClass( ve.init.mw.SpamBlacklistSaveErrorHandler, ve.init.mw.SaveErrorHandler );
ve.init.mw.SpamBlacklistSaveErrorHandler.static.name = 'spamBlacklist';
ve.init.mw.SpamBlacklistSaveErrorHandler.static.matchFunction = function ( editApi ) {
return !!editApi.spamblacklist;
};
ve.init.mw.SpamBlacklistSaveErrorHandler.static.process = function ( editApi, target ) {
// Handle spam blacklist error from Extension:SpamBlacklist
if ( !editApi.spamblacklist ) {
return false;
}
target.showSaveError(
$( $.parseHTML( editApi.sberrorparsed ) ),
false // prevents reapply
);
// Emit event for tracking. TODO: This is a bad design
target.emit( 'saveErrorSpamBlacklist' );
return true;
} );
};
/* Registration */
ve.init.mw.saveErrorHandlerFactory.register( ve.init.mw.SpamBlacklistSaveErrorHandler );
// Used in tryTeardown
ve.ui.windowFactory.register( mw.widgets.AbandonEditDialog );

43
modules/ve-mw/init/ve.init.mw.SaveErrorHandler.js Normal file
View file

@ -0,0 +1,43 @@
/*!
* VisualEditor Initialization save error handler class
*
* @copyright 2011-2018 VisualEditor Team and others; see http://ve.mit-license.org
*/
/**
* Data transfer handler.
*
* @class
* @abstract
*
* @constructor
*/
ve.init.mw.SaveErrorHandler = function () {};
/* Inheritance */
OO.initClass( ve.init.mw.SaveErrorHandler );
/* Static methods */
/**
* Test if this handler should handle as specific API response
*
* @static
* @inheritable
* @method
* @param {Object} editApi Edit API response
* @return {boolean}
*/
ve.init.mw.SaveErrorHandler.static.matchFunction = null;
/**
* Process the save error
*
* @static
* @inheritable
* @method
* @param {Object} editApi Edit API response
* @param {ve.init.mw.ArticleTarget} target Target
*/
ve.init.mw.SaveErrorHandler.static.process = null;