wikimedia/mediawiki-extensions-VisualEditor
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor synced 2024-11-23 14:06:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add a Process to the save workflow

Browse source 
A new hook `ve.preSaveProcess` is triggered to give other code the
chance to add steps to the process. The save dialog won't show until
the process completes. A step can be failed to return to normal
editing.

Change-Id: Id0740ff58ba9d9519c81174100ef1b8f8740870b
This commit is contained in:
David Lynch 2023-05-08 23:32:41 -05:00 committed by Ed Sanders
parent 4c69113ed8
commit 228596cba0
1 changed files with 61 additions and 54 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

115
modules/ve-mw/init/targets/ve.init.mw.ArticleTarget.js
View file

@ -1975,73 +1975,80 @@ ve.init.mw.ArticleTarget.prototype.showSaveDialog = function ( action, checkboxN
this.saveDialogIsOpening = true;
this.emit( 'saveWorkflowBegin' );
var saveProcess = new OO.ui.Process();
mw.hook( 've.preSaveProcess' ).fire( saveProcess, target );
// Preload the serialization
this.prepareCacheKey( this.getDocToSave() );
saveProcess.execute().done( function () {
target.emit( 'saveWorkflowBegin' );
// Get the save dialog
this.getSurface().getDialogs().getWindow( 'mwSave' ).done( function ( win ) {
var windowAction = ve.ui.actionFactory.create( 'window', target.getSurface() );
// Preload the serialization
target.prepareCacheKey( target.getDocToSave() );
if ( !target.saveDialog ) {
target.saveDialog = win;
firstLoad = true;
// Get the save dialog
target.getSurface().getDialogs().getWindow( 'mwSave' ).done( function ( win ) {
var windowAction = ve.ui.actionFactory.create( 'window', target.getSurface() );
// Connect to save dialog
target.saveDialog.connect( target, {
save: 'onSaveDialogSave',
review: 'onSaveDialogReview',
preview: 'onSaveDialogPreview',
resolve: 'onSaveDialogResolveConflict',
retry: 'onSaveDialogRetry',
// The array syntax is a way to call `this.emit( 'saveWorkflowEnd' )`.
close: [ 'emit', 'saveWorkflowEnd' ]
} );
if ( !target.saveDialog ) {
target.saveDialog = win;
firstLoad = true;
// Attach custom overlay
target.saveDialog.$element.append( target.$saveDialogOverlay );
}
// Connect to save dialog
target.saveDialog.connect( target, {
save: 'onSaveDialogSave',
review: 'onSaveDialogReview',
preview: 'onSaveDialogPreview',
resolve: 'onSaveDialogResolveConflict',
retry: 'onSaveDialogRetry',
// The array syntax is a way to call `this.emit( 'saveWorkflowEnd' )`.
close: [ 'emit', 'saveWorkflowEnd' ]
} );
var data = target.getSaveDialogOpeningData();
// Attach custom overlay
target.saveDialog.$element.append( target.$saveDialogOverlay );
}
if (
( action === 'review' && !data.canReview ) ||
( action === 'preview' && !data.canPreview )
) {
target.saveDialogIsOpening = false;
return;
}
var data = target.getSaveDialogOpeningData();
if ( firstLoad ) {
for ( var name in target.checkboxesByName ) {
if ( target.initialCheckboxes[ name ] !== undefined ) {
target.checkboxesByName[ name ].setSelected( target.initialCheckboxes[ name ] );
if (
( action === 'review' && !data.canReview ) ||
( action === 'preview' && !data.canPreview )
) {
target.saveDialogIsOpening = false;
return;
}
if ( firstLoad ) {
for ( var name in target.checkboxesByName ) {
if ( target.initialCheckboxes[ name ] !== undefined ) {
target.checkboxesByName[ name ].setSelected( target.initialCheckboxes[ name ] );
}
}
}
}
var checkbox;
if ( checkboxName && ( checkbox = target.checkboxesByName[ checkboxName ] ) ) {
var isSelected = !checkbox.isSelected();
// Wait for native access key change to happen
setTimeout( function () {
checkbox.setSelected( isSelected );
} );
}
var checkbox;
if ( checkboxName && ( checkbox = target.checkboxesByName[ checkboxName ] ) ) {
var isSelected = !checkbox.isSelected();
// Wait for native access key change to happen
setTimeout( function () {
checkbox.setSelected( isSelected );
} );
}
// When calling review/preview action, switch to those panels immediately
if ( action === 'review' || action === 'preview' ) {
data.initialPanel = action;
}
// When calling review/preview action, switch to those panels immediately
if ( action === 'review' || action === 'preview' ) {
data.initialPanel = action;
}
// Open the dialog
var openPromise = windowAction.open( 'mwSave', data, action );
if ( openPromise ) {
openPromise.always( function () {
target.saveDialogIsOpening = false;
} );
}
// Open the dialog
var openPromise = windowAction.open( 'mwSave', data, action );
if ( openPromise ) {
openPromise.always( function () {
target.saveDialogIsOpening = false;
} );
}
} );
} ).fail( function () {
target.saveDialogIsOpening = false;
} );
};