mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-09-27 12:16:51 +00:00
e484522161
Previously, we changed it on every load, which also occurs when switching editor modes. That caused it to not be restored when editor was closed. Bug: T197490 Change-Id: Icb20c38309fd440553d5245d865b05145542313f
1685 lines
51 KiB
JavaScript
1685 lines
51 KiB
JavaScript
/*!
|
|
* VisualEditor MediaWiki Initialization DesktopArticleTarget class.
|
|
*
|
|
* @copyright 2011-2018 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* MediaWiki desktop article target.
|
|
*
|
|
* @class
|
|
* @extends ve.init.mw.ArticleTarget
|
|
*
|
|
* @constructor
|
|
* @param {Object} config Configuration options
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget = function VeInitMwDesktopArticleTarget( config ) {
|
|
// Parent constructor
|
|
ve.init.mw.DesktopArticleTarget.super.call( this, config );
|
|
|
|
// Parent constructor bound key event handlers, but we don't want them bound until
|
|
// we activate; so unbind them again
|
|
this.unbindHandlers();
|
|
|
|
this.onWatchToggleHandler = this.onWatchToggle.bind( this );
|
|
|
|
// Properties
|
|
this.onBeforeUnloadFallback = null;
|
|
this.onBeforeUnload = this.onBeforeUnload.bind( this );
|
|
this.onUnloadHandler = this.onUnload.bind( this );
|
|
this.activating = false;
|
|
this.deactivating = false;
|
|
this.recreating = false;
|
|
this.activatingDeferred = null;
|
|
this.toolbarSetupDeferred = null;
|
|
this.suppressNormalStartupDialogs = false;
|
|
this.editingTabDialog = null;
|
|
|
|
// If this is true then #transformPage / #restorePage will not call pushState
|
|
// This is to avoid adding a new history entry for the url we just got from onpopstate
|
|
// (which would mess up with the expected order of Back/Forwards browsing)
|
|
this.actFromPopState = false;
|
|
this.popState = {
|
|
tag: 'visualeditor'
|
|
};
|
|
this.scrollTop = null;
|
|
this.section = null;
|
|
if ( $( '#wpSummary' ).length ) {
|
|
this.initialEditSummary = $( '#wpSummary' ).val();
|
|
} else {
|
|
this.initialEditSummary = this.currentUri.query.summary;
|
|
}
|
|
this.viewUri = new mw.Uri( mw.util.getUrl( this.getPageName() ) );
|
|
this.isViewPage = (
|
|
mw.config.get( 'wgAction' ) === 'view' &&
|
|
this.currentUri.query.diff === undefined
|
|
);
|
|
|
|
this.tabLayout = mw.config.get( 'wgVisualEditorConfig' ).tabLayout;
|
|
this.events = new ve.init.mw.ArticleTargetEvents( this );
|
|
this.$originalContent = $( '<div>' ).addClass( 've-init-mw-desktopArticleTarget-originalContent' );
|
|
this.$editableContent = this.getEditableContent().addClass( 've-init-mw-desktopArticleTarget-editableContent' );
|
|
|
|
// Initialization
|
|
this.$element
|
|
.addClass( 've-init-mw-desktopArticleTarget' )
|
|
.append( this.$originalContent );
|
|
|
|
if ( history.replaceState ) {
|
|
// We replace the current state with one that's marked with our tag. This way, when users
|
|
// use the Back button to exit the editor we can restore Read mode. This is because we want
|
|
// to ignore foreign states in onWindowPopState. Without this, the Read state is foreign.
|
|
// FIXME: There should be a much better solution than this.
|
|
history.replaceState( this.popState, document.title, this.currentUri );
|
|
}
|
|
|
|
this.setupSkinTabs();
|
|
|
|
window.addEventListener( 'popstate', this.onWindowPopState.bind( this ) );
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
OO.inheritClass( ve.init.mw.DesktopArticleTarget, ve.init.mw.ArticleTarget );
|
|
|
|
/* Static Properties */
|
|
|
|
ve.init.mw.DesktopArticleTarget.static.actionGroups = [
|
|
{
|
|
name: 'help',
|
|
include: [ 'help', 'notices' ]
|
|
},
|
|
{
|
|
name: 'pageMenu',
|
|
type: 'list',
|
|
icon: 'menu',
|
|
indicator: null,
|
|
title: ve.msg( 'visualeditor-pagemenu-tooltip' ),
|
|
include: [ 'meta', 'categories', 'settings', 'advancedSettings', 'languages', 'templatesUsed', 'changeDirectionality', 'findAndReplace' ]
|
|
},
|
|
{
|
|
name: 'editMode',
|
|
type: 'list',
|
|
icon: 'edit',
|
|
title: ve.msg( 'visualeditor-mweditmode-tooltip' ),
|
|
include: [ 'editModeVisual', 'editModeSource' ]
|
|
}
|
|
];
|
|
|
|
/**
|
|
* Compatibility map used with jQuery.client to decide if a browser should
|
|
* receive a compatibility warning. Blacklisting is handled in DesktopArticleTarget.init.
|
|
*
|
|
* @static
|
|
* @property
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.static.compatibility = {
|
|
// The key is the browser name returned by jQuery.client
|
|
// The value is either null (match all versions) or a list of tuples
|
|
// containing an inequality (<,>,<=,>=) and a version number
|
|
whitelist: {
|
|
chrome: [ [ '>=', 19 ] ],
|
|
iceweasel: [ [ '>=', 10 ] ],
|
|
opera: [ [ '>=', 15 ] ],
|
|
// All non-blacklisted versions are whitelisted:
|
|
firefox: null,
|
|
safari: null,
|
|
msie: null,
|
|
edge: null
|
|
}
|
|
};
|
|
|
|
ve.init.mw.DesktopArticleTarget.static.platformType = 'desktop';
|
|
|
|
/* Events */
|
|
|
|
/**
|
|
* @event deactivate
|
|
*/
|
|
|
|
/**
|
|
* @event transformPage
|
|
*/
|
|
|
|
/**
|
|
* @event restorePage
|
|
*/
|
|
|
|
/**
|
|
* @event saveWorkflowBegin
|
|
* Fired when user clicks the button to open the save dialog.
|
|
*/
|
|
|
|
/**
|
|
* @event saveWorkflowEnd
|
|
* Fired when user exits the save workflow
|
|
*/
|
|
|
|
/**
|
|
* @event saveReview
|
|
* Fired when user initiates review changes in save workflow
|
|
*/
|
|
|
|
/**
|
|
* @event saveInitiated
|
|
* Fired when user initiates saving of the document
|
|
*/
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.addSurface = function ( dmDoc, config ) {
|
|
config = ve.extendObject( { $overlayContainer: $( '#content' ) }, config );
|
|
return ve.init.mw.DesktopArticleTarget.parent.prototype.addSurface.call( this, dmDoc, config );
|
|
};
|
|
|
|
/**
|
|
* Get the editable part of the page
|
|
*
|
|
* @return {jQuery} Editable DOM selection
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.getEditableContent = function () {
|
|
var $editableContent, $content, $before,
|
|
namespaceIds = mw.config.get( 'wgNamespaceIds' );
|
|
|
|
if ( mw.config.get( 'wgAction' ) === 'view' ) {
|
|
switch ( mw.config.get( 'wgNamespaceNumber' ) ) {
|
|
case namespaceIds.category:
|
|
// Put contents in a single wrapper
|
|
// TODO: Fix upstream
|
|
$content = $( '#mw-content-text > :not( .mw-category-generated )' );
|
|
$editableContent = $( '<div>' ).prependTo( $( '#mw-content-text' ) ).append( $content );
|
|
break;
|
|
case namespaceIds.file:
|
|
$editableContent = $( '#mw-imagepage-content' );
|
|
if ( !$editableContent.length ) {
|
|
// No image content, file doesn't exist, or is on Commons?
|
|
$editableContent = $( '<div>' ).attr( 'id', 'mw-imagepage-content' );
|
|
$before = $( '.sharedUploadNotice, #mw-imagepage-nofile' );
|
|
if ( $before.length ) {
|
|
$before.first().after( $editableContent );
|
|
} else {
|
|
// Nothing to anchor to, just prepend inside #mw-content-text
|
|
$( '#mw-content-text' ).prepend( $editableContent );
|
|
}
|
|
}
|
|
break;
|
|
default:
|
|
$editableContent = $( '#mw-content-text' );
|
|
}
|
|
} else {
|
|
// TODO: Load view page content if switching from edit source
|
|
$editableContent = $( '#mw-content-text' );
|
|
}
|
|
|
|
return $editableContent;
|
|
};
|
|
|
|
/**
|
|
* Set the container for the target, appending the target to it
|
|
*
|
|
* @param {jQuery} $container Container
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.setContainer = function ( $container ) {
|
|
$container.append( this.$element );
|
|
this.$container = $container;
|
|
};
|
|
|
|
/**
|
|
* Verify that a PopStateEvent correlates to a state we created.
|
|
*
|
|
* @param {Mixed} popState From PopStateEvent#state
|
|
* @return {boolean}
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.verifyPopState = function ( popState ) {
|
|
return popState && popState.tag === 'visualeditor';
|
|
};
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.setupToolbar = function ( surface ) {
|
|
var toolbar,
|
|
mode = surface.getMode(),
|
|
wasSetup = !!this.toolbar,
|
|
target = this;
|
|
|
|
ve.track( 'trace.setupToolbar.enter', { mode: mode } );
|
|
|
|
// Parent method
|
|
ve.init.mw.DesktopArticleTarget.super.prototype.setupToolbar.call( this, surface );
|
|
|
|
toolbar = this.getToolbar();
|
|
|
|
ve.track( 'trace.setupToolbar.exit', { mode: mode } );
|
|
if ( !wasSetup ) {
|
|
if ( $( 'html' ).hasClass( 've-tempSourceEditing' ) ) {
|
|
toolbar.$element
|
|
.css( 'height', '' )
|
|
.addClass( 've-init-mw-desktopArticleTarget-toolbar-open' )
|
|
.addClass( 've-init-mw-desktopArticleTarget-toolbar-opened' );
|
|
this.toolbarSetupDeferred.resolve();
|
|
} else {
|
|
setTimeout( function () {
|
|
toolbar.$element
|
|
.css( 'height', toolbar.$bar[ 0 ].offsetHeight )
|
|
.addClass( 've-init-mw-desktopArticleTarget-toolbar-open' );
|
|
setTimeout( function () {
|
|
// Clear to allow growth during use and when resizing window
|
|
toolbar.$element
|
|
.css( 'height', '' )
|
|
.addClass( 've-init-mw-desktopArticleTarget-toolbar-opened' );
|
|
target.toolbarSetupDeferred.resolve();
|
|
}, 250 );
|
|
} );
|
|
}
|
|
|
|
this.toolbarSetupDeferred.done( function () {
|
|
var surface = target.getSurface();
|
|
// Check the surface wasn't torn down while the toolbar was animating
|
|
if ( surface ) {
|
|
ve.track( 'trace.initializeToolbar.enter', { mode: mode } );
|
|
target.getToolbar().initialize();
|
|
surface.getView().emit( 'position' );
|
|
surface.getContext().updateDimensions();
|
|
ve.track( 'trace.initializeToolbar.exit', { mode: mode } );
|
|
ve.track( 'trace.activate.exit', { mode: mode } );
|
|
}
|
|
} );
|
|
}
|
|
};
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.attachToolbar = function () {
|
|
// Move the toolbar to top of target, before heading etc.
|
|
// Avoid re-attaching as it breaks CSS animations
|
|
if ( !this.toolbar.$element.parent().is( this.$element ) ) {
|
|
this.toolbar.$element
|
|
// Set 0 before attach (expanded in #setupToolbar)
|
|
.css( 'height', '0' )
|
|
.addClass( 've-init-mw-desktopArticleTarget-toolbar' );
|
|
this.$element.prepend( this.toolbar.$element );
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Set up notices for things like unknown browsers.
|
|
* Needs to be done on each activation because localNoticeMessages is cleared in clearState.
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.setupLocalNoticeMessages = function () {
|
|
if ( mw.config.get( 'wgTranslatePageTranslation' ) === 'source' ) {
|
|
// Warn users if they're on a source of the Page Translation feature
|
|
this.localNoticeMessages.push( 'visualeditor-pagetranslationwarning' );
|
|
}
|
|
|
|
if ( !(
|
|
'vewhitelist' in this.currentUri.query ||
|
|
$.client.test( this.constructor.static.compatibility.whitelist, null, true )
|
|
) ) {
|
|
// Show warning in unknown browsers that pass the support test
|
|
// Continue at own risk.
|
|
this.localNoticeMessages.push( 'visualeditor-browserwarning' );
|
|
}
|
|
};
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.loadSuccess = function () {
|
|
var windowManager,
|
|
target = this;
|
|
|
|
// Parent method
|
|
ve.init.mw.DesktopArticleTarget.super.prototype.loadSuccess.apply( this, arguments );
|
|
|
|
this.wikitextFallbackLoading = false;
|
|
// Duplicate of this code in ve.init.mw.DesktopArticleTarget.init.js
|
|
if ( $( '#ca-edit' ).hasClass( 'visualeditor-showtabdialog' ) ) {
|
|
$( '#ca-edit' ).removeClass( 'visualeditor-showtabdialog' );
|
|
// Set up a temporary window manager
|
|
windowManager = new OO.ui.WindowManager();
|
|
$( 'body' ).append( windowManager.$element );
|
|
this.editingTabDialog = new mw.libs.ve.EditingTabDialog();
|
|
windowManager.addWindows( [ this.editingTabDialog ] );
|
|
windowManager.openWindow( this.editingTabDialog )
|
|
.closed.then( function ( data ) {
|
|
// Detach the temporary window manager
|
|
windowManager.destroy();
|
|
|
|
if ( data && data.action === 'prefer-wt' ) {
|
|
target.switchToWikitextEditor( true, false );
|
|
} else if ( data && data.action === 'multi-tab' ) {
|
|
location.reload();
|
|
}
|
|
} );
|
|
|
|
// Pretend the user saw the welcome dialog before suppressing it.
|
|
if ( mw.user.isAnon() ) {
|
|
if ( !mw.storage.set( 've-beta-welcome-dialog', 1 ) ) {
|
|
$.cookie( 've-beta-welcome-dialog', 1, { path: '/', expires: 30 } );
|
|
}
|
|
} else {
|
|
ve.init.target.getLocalApi().saveOption( 'visualeditor-hidebetawelcome', '1' );
|
|
mw.user.options.set( 'visualeditor-hidebetawelcome', '1' );
|
|
}
|
|
this.suppressNormalStartupDialogs = true;
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Handle the watch button being toggled on/off.
|
|
*
|
|
* @param {jQuery.Event} e Event object which triggered the event
|
|
* @param {string} actionPerformed 'watch' or 'unwatch'
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.onWatchToggle = function ( e, actionPerformed ) {
|
|
if ( !this.active && !this.activating ) {
|
|
return;
|
|
}
|
|
if ( this.checkboxesByName.wpWatchthis ) {
|
|
this.checkboxesByName.wpWatchthis.setSelected(
|
|
!!mw.user.options.get( 'watchdefault' ) ||
|
|
( !!mw.user.options.get( 'watchcreations' ) && !this.pageExists ) ||
|
|
actionPerformed === 'watch'
|
|
);
|
|
}
|
|
};
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.bindHandlers = function () {
|
|
ve.init.mw.DesktopArticleTarget.super.prototype.bindHandlers.call( this );
|
|
if ( this.onWatchToggleHandler ) {
|
|
$( '#ca-watch, #ca-unwatch' ).on( 'watchpage.mw', this.onWatchToggleHandler );
|
|
}
|
|
};
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.unbindHandlers = function () {
|
|
ve.init.mw.DesktopArticleTarget.super.prototype.unbindHandlers.call( this );
|
|
if ( this.onWatchToggleHandler ) {
|
|
$( '#ca-watch, #ca-unwatch' ).off( 'watchpage.mw', this.onWatchToggleHandler );
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Switch to edit mode.
|
|
*
|
|
* @param {jQuery.Promise} [dataPromise] Promise for pending request from
|
|
* mw.libs.ve.targetLoader#requestPageData, if any
|
|
* @return {jQuery.Promise}
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.activate = function ( dataPromise ) {
|
|
var surface,
|
|
target = this;
|
|
|
|
if ( !this.active && !this.activating ) {
|
|
this.activating = true;
|
|
this.activatingDeferred = $.Deferred();
|
|
this.toolbarSetupDeferred = $.Deferred();
|
|
|
|
$( 'html' ).addClass( 've-activating' );
|
|
$.when( this.activatingDeferred, this.toolbarSetupDeferred ).done( function () {
|
|
target.afterActivate();
|
|
} ).fail( function () {
|
|
$( 'html' ).removeClass( 've-activating' );
|
|
} );
|
|
|
|
// Handlers were unbound in constructor. Will be unbound again in teardown.
|
|
this.bindHandlers();
|
|
|
|
this.originalEditondbclick = mw.user.options.get( 'editondblclick' );
|
|
mw.user.options.set( 'editondblclick', 0 );
|
|
|
|
// Save the scroll position; will be restored by surfaceReady()
|
|
this.saveScrollPosition();
|
|
|
|
// User interface changes
|
|
this.changeDocumentTitle();
|
|
this.transformPage();
|
|
this.setupLocalNoticeMessages();
|
|
|
|
// Create dummy surface to show toolbar while loading
|
|
surface = this.addSurface( new ve.dm.Document( [
|
|
{ type: 'paragraph' }, { type: '/paragraph' },
|
|
{ type: 'internalList' }, { type: '/internalList' }
|
|
] ) );
|
|
surface.setDisabled( true );
|
|
// setSurface creates dummy toolbar
|
|
this.dummyToolbar = true;
|
|
this.setSurface( surface );
|
|
// Disconnect the tool factory listeners so the toolbar
|
|
// doesn't start showing new tools as they load, too
|
|
// much flickering
|
|
this.getToolbar().getToolFactory().off( 'register' );
|
|
// Disable all the tools
|
|
this.getToolbar().updateToolState();
|
|
|
|
this.load( dataPromise );
|
|
}
|
|
return this.activatingDeferred.promise();
|
|
};
|
|
|
|
/**
|
|
* Edit mode has finished activating
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.afterActivate = function () {
|
|
var surfaceModel, range;
|
|
$( 'html' ).removeClass( 've-activating' ).addClass( 've-active' );
|
|
if ( !this.editingTabDialog ) {
|
|
if ( this.sectionTitle ) {
|
|
this.sectionTitle.focus();
|
|
} else {
|
|
// We have to focus the page after hiding the original content, otherwise
|
|
// in firefox the contentEditable container was below the view page, and
|
|
// 'focus' scrolled the screen down.
|
|
// Support: Firefox
|
|
this.getSurface().getView().focus();
|
|
}
|
|
// Transfer and initial source range to the surface (e.g. from tempWikitextEditor)
|
|
if ( this.initialSourceRange && this.getSurface().getMode() === 'source' ) {
|
|
surfaceModel = ve.init.target.getSurface().getModel();
|
|
range = surfaceModel.getRangeFromSourceOffsets( this.initialSourceRange.from, this.initialSourceRange.to );
|
|
surfaceModel.setLinearSelection( range );
|
|
}
|
|
}
|
|
};
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.setSurface = function ( surface ) {
|
|
var resetSurface = surface !== this.surface;
|
|
|
|
if ( resetSurface ) {
|
|
this.$editableContent.after( surface.$element );
|
|
}
|
|
|
|
// Parent method
|
|
ve.init.mw.DesktopArticleTarget.super.prototype.setSurface.apply( this, arguments );
|
|
|
|
if ( resetSurface ) {
|
|
this.setupNewSection( surface );
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Setup new section input for a surface, if required
|
|
*
|
|
* @param {ve.ui.Surface} surface Surface
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.setupNewSection = function ( surface ) {
|
|
if ( surface.getMode() === 'source' && this.section === 'new' ) {
|
|
if ( !this.sectionTitle ) {
|
|
this.sectionTitle = new OO.ui.TextInputWidget( {
|
|
$element: $( '<h2>' ),
|
|
classes: [ 've-ui-init-desktopArticleTarget-sectionTitle' ],
|
|
maxLength: 255,
|
|
placeholder: ve.msg( 'visualeditor-section-title-placeholder' ),
|
|
spellcheck: true
|
|
} );
|
|
if ( this.recovered ) {
|
|
this.sectionTitle.setValue(
|
|
ve.init.platform.getSession( 've-docsectiontitle' ) || ''
|
|
);
|
|
}
|
|
this.sectionTitle.connect( this, { change: 'onSectionTitleChange' } );
|
|
}
|
|
surface.setPlaceholder( ve.msg( 'visualeditor-section-body-placeholder' ) );
|
|
this.$editableContent.before( this.sectionTitle.$element );
|
|
|
|
if ( this.currentUri.query.preloadtitle ) {
|
|
this.sectionTitle.setValue( this.currentUri.query.preloadtitle );
|
|
}
|
|
surface.once( 'destroy', this.teardownNewSection.bind( this, surface ) );
|
|
} else {
|
|
ve.init.platform.removeSession( 've-docsectiontitle' );
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Handle section title changes
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.onSectionTitleChange = function () {
|
|
ve.init.platform.setSession( 've-docsectiontitle', this.sectionTitle.getValue() );
|
|
this.updateToolbarSaveButtonState();
|
|
};
|
|
|
|
/**
|
|
* Teardown new section inputs
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.teardownNewSection = function ( surface ) {
|
|
surface.setPlaceholder( '' );
|
|
if ( this.sectionTitle ) {
|
|
this.sectionTitle.$element.remove();
|
|
this.sectionTitle = null;
|
|
}
|
|
};
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*
|
|
* A prompt will not be shown if tryTeardown() is called while activation is still in progress.
|
|
* If tryTeardown() is called while the target is deactivating, or while it's not active and
|
|
* not activating, nothing happens.
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.tryTeardown = function ( noPrompt, trackMechanism ) {
|
|
if ( this.deactivating || ( !this.active && !this.activating ) ) {
|
|
return;
|
|
}
|
|
|
|
// Just in case these weren't closed before
|
|
if ( this.welcomeDialog ) {
|
|
this.welcomeDialog.close();
|
|
}
|
|
if ( this.editingTabDialog ) {
|
|
this.editingTabDialog.close();
|
|
}
|
|
this.editingTabDialog = null;
|
|
|
|
// Parent method
|
|
return ve.init.mw.DesktopArticleTarget.super.prototype.tryTeardown.call( this, noPrompt || this.activating, trackMechanism );
|
|
};
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*
|
|
* @param {string} [trackMechanism]
|
|
* @fires deactivate
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.teardown = function ( trackMechanism ) {
|
|
var abortType,
|
|
saveDialogPromise = $.Deferred().resolve().promise(),
|
|
target = this;
|
|
|
|
this.emit( 'deactivate' );
|
|
|
|
// Event tracking
|
|
if ( trackMechanism ) {
|
|
if ( this.activating ) {
|
|
abortType = 'preinit';
|
|
} else if ( !this.edited ) {
|
|
abortType = 'nochange';
|
|
} else if ( this.saving ) {
|
|
abortType = 'abandonMidsave';
|
|
} else {
|
|
// switchwith and switchwithout do not go through this code path,
|
|
// they go through switchToWikitextEditor() instead
|
|
abortType = 'abandon';
|
|
}
|
|
ve.track( 'mwedit.abort', {
|
|
type: abortType,
|
|
mechanism: trackMechanism,
|
|
mode: this.surface ? this.surface.getMode() : this.getDefaultMode()
|
|
} );
|
|
}
|
|
|
|
// Cancel activating, start deactivating
|
|
this.deactivating = true;
|
|
this.activating = false;
|
|
this.activatingDeferred.reject();
|
|
$( 'html' ).addClass( 've-deactivating' ).removeClass( 've-activated ve-active' );
|
|
|
|
// User interface changes
|
|
this.restorePage();
|
|
this.restoreDocumentTitle();
|
|
|
|
mw.user.options.set( 'editondblclick', this.originalEditondbclick );
|
|
this.originalEditondbclick = undefined;
|
|
|
|
// TODO: Use better checks to see if these restorations are required.
|
|
if ( this.getSurface() ) {
|
|
if ( this.active ) {
|
|
this.teardownUnloadHandlers();
|
|
}
|
|
}
|
|
|
|
if ( this.saveDialog ) {
|
|
if ( this.saveDialog.isOpened() ) {
|
|
// If the save dialog is still open (from saving) close it
|
|
saveDialogPromise = this.saveDialog.close().closed;
|
|
}
|
|
// Release the reference
|
|
this.saveDialog = null;
|
|
}
|
|
|
|
return saveDialogPromise.then( function () {
|
|
// Parent method
|
|
return ve.init.mw.DesktopArticleTarget.super.prototype.teardown.call( target ).then( function () {
|
|
// After teardown
|
|
target.active = false;
|
|
|
|
// If there is a load in progress, abort it
|
|
if ( target.loading ) {
|
|
target.loading.abort();
|
|
}
|
|
|
|
target.clearState();
|
|
target.initialEditSummary = new mw.Uri().query.summary;
|
|
target.editSummaryValue = null;
|
|
|
|
target.deactivating = false;
|
|
$( 'html' ).removeClass( 've-deactivating' );
|
|
|
|
// Move original content back out of the target
|
|
target.$element.parent().append( target.$originalContent.children() );
|
|
$( '.ve-init-mw-desktopArticleTarget-uneditableContent' )
|
|
.removeClass( 've-init-mw-desktopArticleTarget-uneditableContent' );
|
|
|
|
mw.hook( 've.deactivationComplete' ).fire( target.edited );
|
|
} );
|
|
} );
|
|
};
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.loadFail = function ( code, errorDetails ) {
|
|
var errorInfo, confirmPromptMessage,
|
|
target = this;
|
|
|
|
this.activatingDeferred.reject();
|
|
|
|
// Parent method
|
|
ve.init.mw.DesktopArticleTarget.super.prototype.loadFail.apply( this, arguments );
|
|
|
|
if ( this.wikitextFallbackLoading ) {
|
|
// Failed twice now
|
|
mw.log.warn( 'Failed to fall back to wikitext', code, errorDetails );
|
|
location.href = target.viewUri.clone().extend( { action: 'edit', veswitched: 1 } );
|
|
return;
|
|
}
|
|
|
|
// Don't show an error if the load was manually aborted
|
|
// The response.status check here is to catch aborts triggered by navigation away from the page
|
|
if (
|
|
errorDetails &&
|
|
Object.prototype.hasOwnProperty.call( errorDetails, 'error' ) &&
|
|
Object.prototype.hasOwnProperty.call( errorDetails.error, 'info' )
|
|
) {
|
|
errorInfo = errorDetails.error.info;
|
|
} else {
|
|
errorInfo = errorDetails;
|
|
}
|
|
|
|
if ( !errorDetails || errorDetails.statusText !== 'abort' ) {
|
|
if ( code === 'http' || code === 'error' ) {
|
|
if ( errorDetails && ( errorDetails.status || ( errorDetails.xhr && errorDetails.xhr.status ) ) ) {
|
|
confirmPromptMessage = ve.msg(
|
|
'visualeditor-loadwarning',
|
|
'HTTP ' + ( errorDetails.status || errorDetails.xhr.status )
|
|
);
|
|
} else {
|
|
confirmPromptMessage = ve.msg(
|
|
'visualeditor-loadwarning',
|
|
ve.msg( 'visualeditor-loadwarning-noconnect' )
|
|
);
|
|
}
|
|
} else if ( errorInfo ) {
|
|
confirmPromptMessage = ve.msg( 'visualeditor-loadwarning', code + ': ' + errorInfo );
|
|
} else if ( typeof errorDetails === 'string' ) {
|
|
confirmPromptMessage = errorDetails;
|
|
} else {
|
|
// At least give the devs something to work from
|
|
confirmPromptMessage = JSON.stringify( errorDetails );
|
|
}
|
|
}
|
|
|
|
if ( confirmPromptMessage ) {
|
|
OO.ui.confirm( confirmPromptMessage ).done( function ( confirmed ) {
|
|
if ( confirmed ) {
|
|
target.load();
|
|
} else if ( $( '#wpTextbox1' ).length && !ve.init.target.isModeAvailable( 'source' ) ) {
|
|
// If we're switching from the wikitext editor, just deactivate
|
|
// don't try to switch back to it fully, that'd discard changes.
|
|
target.tryTeardown( true );
|
|
} else {
|
|
// TODO: Some sort of progress bar?
|
|
target.wikitextFallbackLoading = true;
|
|
target.switchToWikitextEditor( true, false );
|
|
}
|
|
} );
|
|
} else {
|
|
if ( errorDetails.statusText !== 'abort' ) {
|
|
mw.log.warn( 'Failed to find error message', code, errorDetails );
|
|
}
|
|
this.tryTeardown( true );
|
|
}
|
|
};
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.surfaceReady = function () {
|
|
var redirectMetaItems,
|
|
editNotices = this.getEditNotices(),
|
|
actionTools = this.actionsToolbar.tools,
|
|
surface = this.getSurface(),
|
|
surfaceReadyTime = ve.now(),
|
|
target = this;
|
|
|
|
if ( !this.activating ) {
|
|
// Activation was aborted before we got here. Do nothing
|
|
// TODO are there things we need to clean up?
|
|
return;
|
|
}
|
|
|
|
this.activating = false;
|
|
|
|
// TODO: mwTocWidget should probably live in a ve.ui.MWSurface subclass
|
|
if ( mw.config.get( 'wgVisualEditorConfig' ).enableTocWidget ) {
|
|
surface.mwTocWidget = new ve.ui.MWTocWidget( this.getSurface() );
|
|
surface.once( 'destroy', function () {
|
|
surface.mwTocWidget.$element.remove();
|
|
} );
|
|
}
|
|
|
|
this.transformCategoryLinks( $( '#catlinks' ) );
|
|
|
|
// Track how long it takes for the first transaction to happen
|
|
surface.getModel().getDocument().once( 'transact', function () {
|
|
ve.track( 'mwtiming.behavior.firstTransaction', {
|
|
duration: ve.now() - surfaceReadyTime,
|
|
targetName: target.constructor.static.trackingName,
|
|
mode: surface.getMode()
|
|
} );
|
|
} );
|
|
|
|
surface.getModel().getMetaList().connect( this, {
|
|
insert: 'onMetaItemInserted',
|
|
remove: 'onMetaItemRemoved'
|
|
} );
|
|
|
|
// Support: IE<=11
|
|
// IE requires us to defer before restoring the scroll position
|
|
setTimeout( function () {
|
|
target.restoreScrollPosition();
|
|
} );
|
|
|
|
// Parent method
|
|
ve.init.mw.DesktopArticleTarget.super.prototype.surfaceReady.apply( this, arguments );
|
|
|
|
redirectMetaItems = this.getSurface().getModel().getMetaList().getItemsInGroup( 'mwRedirect' );
|
|
if ( redirectMetaItems.length ) {
|
|
this.setFakeRedirectInterface( redirectMetaItems[ 0 ].getAttribute( 'title' ) );
|
|
} else {
|
|
this.setFakeRedirectInterface( null );
|
|
}
|
|
|
|
// Set edit notices, will be shown after meta dialog.
|
|
// Make sure notices actually exists, because this might be a mode-switch and
|
|
// we've already removed it.
|
|
if ( editNotices.length ) {
|
|
actionTools.notices.setNotices( this.getEditNotices() );
|
|
} else if ( actionTools.notices ) {
|
|
actionTools.notices.destroy();
|
|
actionTools.notices = null;
|
|
}
|
|
|
|
this.setupUnloadHandlers();
|
|
if ( !this.suppressNormalStartupDialogs ) {
|
|
this.maybeShowWelcomeDialog();
|
|
this.maybeShowMetaDialog();
|
|
}
|
|
|
|
this.activatingDeferred.resolve();
|
|
this.events.trackActivationComplete();
|
|
|
|
mw.hook( 've.activationComplete' ).fire();
|
|
};
|
|
|
|
/**
|
|
* Update the redirect and category interfaces when a meta item is inserted into the page.
|
|
*
|
|
* @param {ve.dm.MetaItem} metaItem Item that was inserted
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.onMetaItemInserted = function ( metaItem ) {
|
|
var metaList = this.getSurface().getModel().getMetaList();
|
|
switch ( metaItem.getType() ) {
|
|
case 'mwRedirect':
|
|
this.setFakeRedirectInterface( metaItem.getAttribute( 'title' ) );
|
|
break;
|
|
case 'mwCategory':
|
|
this.rebuildCategories( metaList.getItemsInGroup( 'mwCategory' ) );
|
|
break;
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Update the redirect and category interfaces when a meta item is removed from the page.
|
|
*
|
|
* @param {ve.dm.MetaItem} metaItem Item that was removed
|
|
* @param {number} offset Linear model offset that the item was at
|
|
* @param {number} index Index within that offset the item was at
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.onMetaItemRemoved = function ( metaItem ) {
|
|
var metaList = this.getSurface().getModel().getMetaList();
|
|
switch ( metaItem.getType() ) {
|
|
case 'mwRedirect':
|
|
this.setFakeRedirectInterface( null );
|
|
break;
|
|
case 'mwCategory':
|
|
this.rebuildCategories( metaList.getItemsInGroup( 'mwCategory' ) );
|
|
break;
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Redisplay the category list on the page
|
|
*
|
|
* This is used for the preview while editing. Leaving the editor either restores the initial
|
|
* categories, or uses the ones generated by the save API.
|
|
*
|
|
* @param {ve.dm.MetaItem[]} categoryItems Array of category metaitems to display
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.rebuildCategories = function ( categoryItems ) {
|
|
var target = this;
|
|
this.renderCategories( categoryItems ).done( function ( $categories ) {
|
|
// Clone the existing catlinks for any specific properties which might
|
|
// be needed by the rest of the page. Also gives us a not-attached
|
|
// version, which we can pass to wikipage.categories as it requests.
|
|
var $catlinks = $( '#catlinks' ).clone().empty().append( $categories.children() );
|
|
target.transformCategoryLinks( $catlinks );
|
|
mw.hook( 'wikipage.categories' ).fire( $catlinks );
|
|
$( '#catlinks' ).replaceWith( $catlinks );
|
|
ve.init.platform.linkCache.styleParsoidElements( $catlinks, target.doc );
|
|
} );
|
|
};
|
|
|
|
/**
|
|
* Handle Escape key presses.
|
|
*
|
|
* @param {jQuery.Event} e Keydown event
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.onDocumentKeyDown = function ( e ) {
|
|
var target = this;
|
|
|
|
// Parent method
|
|
ve.init.mw.DesktopArticleTarget.super.prototype.onDocumentKeyDown.apply( this, arguments );
|
|
|
|
if ( e.which === OO.ui.Keys.ESCAPE ) {
|
|
setTimeout( function () {
|
|
var toolbarDialogs;
|
|
// Listeners should stopPropagation if they handle the escape key, but
|
|
// also check they didn't fire after this event, as would be the case if
|
|
// they were bound to the document.
|
|
if ( !e.isPropagationStopped() ) {
|
|
toolbarDialogs = target.surface.getToolbarDialogs();
|
|
if ( toolbarDialogs.getCurrentWindow() ) {
|
|
toolbarDialogs.getCurrentWindow().close();
|
|
} else {
|
|
target.tryTeardown( false, 'navigate-read' );
|
|
}
|
|
}
|
|
} );
|
|
e.preventDefault();
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Handle clicks on the view tab.
|
|
*
|
|
* @method
|
|
* @param {jQuery.Event} e Mouse click event
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.onViewTabClick = function ( e ) {
|
|
if ( !ve.isUnmodifiedLeftClick( e ) ) {
|
|
return;
|
|
}
|
|
this.tryTeardown( false, 'navigate-read' );
|
|
e.preventDefault();
|
|
};
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.saveComplete = function (
|
|
html, categoriesHtml, newid, isRedirect, displayTitle, lastModified, contentSub, modules, jsconfigvars
|
|
) {
|
|
var newUrlParams, watchChecked, watch,
|
|
target = this;
|
|
|
|
// Parent method
|
|
ve.init.mw.DesktopArticleTarget.super.prototype.saveComplete.apply( this, arguments );
|
|
|
|
if ( !this.pageExists || this.restoring ) {
|
|
// Teardown the target, ensuring auto-save data is cleared
|
|
this.teardown().then( function () {
|
|
|
|
// This is a page creation or restoration, refresh the page
|
|
newUrlParams = newid === undefined ? {} : { venotify: this.restoring ? 'restored' : 'created' };
|
|
|
|
if ( isRedirect ) {
|
|
newUrlParams.redirect = 'no';
|
|
}
|
|
location.href = target.viewUri.extend( newUrlParams );
|
|
} );
|
|
} else {
|
|
// Update watch link to match 'watch checkbox' in save dialog.
|
|
// User logged in if module loaded.
|
|
if ( mw.loader.getState( 'mediawiki.page.watch.ajax' ) === 'ready' ) {
|
|
watch = require( 'mediawiki.page.watch.ajax' );
|
|
watchChecked = this.checkboxesByName.wpWatchthis && this.checkboxesByName.wpWatchthis.isSelected();
|
|
watch.updateWatchLink(
|
|
$( '#ca-watch a, #ca-unwatch a' ),
|
|
watchChecked ? 'unwatch' : 'watch'
|
|
);
|
|
}
|
|
|
|
// If we were explicitly editing an older version, make sure we won't
|
|
// load the same old version again, now that we've saved the next edit
|
|
// will be against the latest version.
|
|
// If there is an ?oldid= parameter in the URL, this will cause restorePage() to remove it.
|
|
this.restoring = false;
|
|
|
|
// Clear requestedRevId in case it was set by a retry or something; after saving
|
|
// we don't want to go back into oldid mode anyway
|
|
this.requestedRevId = undefined;
|
|
|
|
if ( newid !== undefined ) {
|
|
mw.config.set( {
|
|
wgCurRevisionId: newid,
|
|
wgRevisionId: newid
|
|
} );
|
|
this.revid = newid;
|
|
this.currentRevisionId = newid;
|
|
}
|
|
|
|
// Update module JS config values and notify ResourceLoader of any new
|
|
// modules needed to be added to the page
|
|
mw.config.set( jsconfigvars );
|
|
// Also load postEdit in case it's needed, below.
|
|
mw.loader.load( modules.concat( [ 'mediawiki.action.view.postEdit' ] ) );
|
|
|
|
mw.config.set( {
|
|
wgIsRedirect: !!isRedirect
|
|
} );
|
|
|
|
this.saveDialog.reset();
|
|
this.replacePageContent(
|
|
html,
|
|
categoriesHtml,
|
|
displayTitle,
|
|
lastModified,
|
|
contentSub
|
|
);
|
|
|
|
if ( newid !== undefined ) {
|
|
$( '#t-permalink a, #coll-download-as-rl a' ).each( function () {
|
|
var uri = new mw.Uri( $( this ).attr( 'href' ) );
|
|
uri.query.oldid = newid;
|
|
$( this ).attr( 'href', uri.toString() );
|
|
} );
|
|
}
|
|
|
|
// Tear down the target now that we're done saving
|
|
// Not passing trackMechanism because this isn't an abort action
|
|
this.tryTeardown( true );
|
|
if ( newid !== undefined ) {
|
|
mw.hook( 'postEdit' ).fire( {
|
|
// The following messages can be used here:
|
|
// postedit-confirmation-published
|
|
// postedit-confirmation-saved
|
|
message: ve.msg( 'postedit-confirmation-' + ( mw.config.get( 'wgEditSubmitButtonLabelPublish' ) ? 'published' : 'saved' ), mw.user )
|
|
} );
|
|
}
|
|
}
|
|
};
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.serializeFail = function ( jqXHR, status ) {
|
|
// Parent method
|
|
ve.init.mw.DesktopArticleTarget.super.prototype.serializeFail.apply( this, arguments );
|
|
|
|
OO.ui.alert( ve.msg( 'visualeditor-serializeerror', status ) );
|
|
|
|
this.getSurface().getDialogs().closeWindow( 'wikitextswitchconfirm' );
|
|
this.resetDocumentOpacity();
|
|
|
|
// It's possible to get here while the save dialog has never been opened (if the user uses
|
|
// the switch to source mode option)
|
|
if ( this.saveDialog ) {
|
|
this.saveDialog.popPending();
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Handle clicks on the MwMeta button in the toolbar.
|
|
*
|
|
* @method
|
|
* @param {jQuery.Event} e Mouse click event
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.onToolbarMetaButtonClick = function () {
|
|
this.getSurface().getDialogs().openWindow( 'meta' );
|
|
};
|
|
|
|
/**
|
|
* Open the dialog to switch to edit source mode with the current wikitext, or just do it straight
|
|
* away if the document is unmodified. If we open the dialog, the document opacity will be set to
|
|
* half, which can be reset with the resetDocumentOpacity function.
|
|
*
|
|
* @inheritdoc
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.editSource = function () {
|
|
var modified = this.fromEditedState || this.getSurface().getModel().hasBeenModified();
|
|
|
|
if ( ve.init.target.isModeAvailable( 'source' ) ) {
|
|
this.switchToWikitextEditor( false, modified );
|
|
} else if ( !modified ) {
|
|
this.switchToWikitextEditor( true, modified );
|
|
} else {
|
|
this.getSurface().getView().getDocument().getDocumentNode().$element.css( 'opacity', 0.5 );
|
|
|
|
ve.ui.actionFactory.create( 'window', this.getSurface() )
|
|
.open( 'wikitextswitchconfirm', { target: this } );
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Modify tabs in the skin to support in-place editing.
|
|
*
|
|
* 'Read' and 'Edit source' (when not using single edit tab) bound here,
|
|
* 'Edit' and single edit tab are bound in mw.DesktopArticleTarget.init.
|
|
*
|
|
* @method
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.setupSkinTabs = function () {
|
|
var namespaceKey,
|
|
target = this;
|
|
if ( this.isViewPage ) {
|
|
// Mimics getNamespaceKey in Title.php
|
|
namespaceKey = mw.config.get( 'wgCanonicalNamespace' ).toLowerCase() || 'main';
|
|
if ( namespaceKey === 'file' ) {
|
|
namespaceKey = 'image';
|
|
}
|
|
// Allow instant switching back to view mode, without refresh
|
|
$( '#ca-view a, #ca-nstab-' + namespaceKey + ' a' )
|
|
.on( 'click', this.onViewTabClick.bind( this ) );
|
|
|
|
}
|
|
if ( !mw.libs.ve.isSingleEditTab ) {
|
|
$( '#ca-viewsource, #ca-edit' ).on( 'click', function ( e ) {
|
|
if ( !target.active || !ve.isUnmodifiedLeftClick( e ) ) {
|
|
return;
|
|
}
|
|
|
|
if ( target.getSurface() && !target.deactivating && target.getDefaultMode() !== 'source' ) {
|
|
target.editSource();
|
|
|
|
if ( target.getSurface().getModel().hasBeenModified() || target.fromEditedState ) {
|
|
e.preventDefault();
|
|
}
|
|
}
|
|
} );
|
|
}
|
|
|
|
mw.hook( 've.skinTabSetupComplete' ).fire();
|
|
};
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.getSaveDialogOpeningData = function () {
|
|
var data = ve.init.mw.DesktopArticleTarget.super.prototype.getSaveDialogOpeningData.apply( this, arguments );
|
|
data.editSummary = this.editSummaryValue || this.initialEditSummary;
|
|
return data;
|
|
};
|
|
|
|
/**
|
|
* Remember the window's scroll position.
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.saveScrollPosition = function () {
|
|
if ( this.getDefaultMode() === 'source' && this.section !== null ) {
|
|
// Reset scroll to top if doing real section editing
|
|
this.scrollTop = 0;
|
|
} else {
|
|
this.scrollTop = $( window ).scrollTop();
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Restore the window's scroll position.
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.restoreScrollPosition = function () {
|
|
if ( this.scrollTop !== null ) {
|
|
$( window ).scrollTop( this.scrollTop );
|
|
this.scrollTop = null;
|
|
}
|
|
};
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.teardownToolbar = function () {
|
|
var target = this,
|
|
deferred = $.Deferred();
|
|
|
|
if ( !this.toolbar ) {
|
|
return deferred.resolve().promise();
|
|
}
|
|
|
|
this.toolbar.$element.css( 'height', this.toolbar.$bar[ 0 ].offsetHeight );
|
|
setTimeout( function () {
|
|
target.toolbar.$element
|
|
.css( 'height', '0' )
|
|
.removeClass( 've-init-mw-desktopArticleTarget-toolbar-open' )
|
|
.removeClass( 've-init-mw-desktopArticleTarget-toolbar-opened' );
|
|
setTimeout( function () {
|
|
// Parent method
|
|
ve.init.mw.DesktopArticleTarget.super.prototype.teardownToolbar.call( target );
|
|
deferred.resolve();
|
|
}, 250 );
|
|
} );
|
|
return deferred.promise();
|
|
};
|
|
|
|
/**
|
|
* Change the document title to state that we are now editing.
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.changeDocumentTitle = function () {
|
|
var title = mw.Title.newFromText( this.getPageName() );
|
|
|
|
// Use the real title if we loaded a view page, otherwise reconstruct it
|
|
this.originalDocumentTitle = this.isViewPage ? document.title : ve.msg( 'pagetitle', title.getPrefixedText() );
|
|
|
|
// Reconstruct an edit title
|
|
document.title = ve.msg( 'pagetitle',
|
|
ve.msg(
|
|
this.pageExists ? 'editing' : 'creating',
|
|
title.getPrefixedText()
|
|
)
|
|
);
|
|
};
|
|
|
|
/**
|
|
* Restore the original document title.
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.restoreDocumentTitle = function () {
|
|
document.title = this.originalDocumentTitle;
|
|
};
|
|
|
|
/**
|
|
* Page modifications for switching to edit mode.
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.transformPage = function () {
|
|
var $content;
|
|
|
|
this.updateTabs( true );
|
|
this.emit( 'transformPage' );
|
|
|
|
mw.hook( 've.activate' ).fire();
|
|
|
|
// Move all native content inside the target
|
|
// Exclude notification area to work around T143837
|
|
this.$originalContent.append( this.$element.siblings().not( '.mw-notification-area' ) );
|
|
this.$originalCategories = $( '#catlinks' ).clone( true );
|
|
|
|
// Mark every non-direct ancestor between editableContent and the container as uneditable
|
|
$content = this.$editableContent;
|
|
while ( $content && $content.length && !$content.parent().is( this.$container ) ) {
|
|
$content.prevAll( ':not( .ve-init-mw-tempWikitextEditorWidget )' ).addClass( 've-init-mw-desktopArticleTarget-uneditableContent' );
|
|
$content.nextAll( ':not( .ve-init-mw-tempWikitextEditorWidget )' ).addClass( 've-init-mw-desktopArticleTarget-uneditableContent' );
|
|
$content = $content.parent();
|
|
}
|
|
|
|
this.updateHistoryState();
|
|
};
|
|
|
|
/**
|
|
* Category link section transformations for switching to edit mode. Broken out
|
|
* so it can be re-applied when displaying changes to the categories.
|
|
*
|
|
* @param {jQuery} $catlinks Category links container element
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.transformCategoryLinks = function ( $catlinks ) {
|
|
var target = this;
|
|
// Un-disable the catlinks wrapper, but not the links
|
|
if ( this.getSurface() && this.getSurface().getMode() === 'visual' ) {
|
|
$catlinks.removeClass( 've-init-mw-desktopArticleTarget-uneditableContent' )
|
|
.on( 'click.ve-target', function () {
|
|
var windowAction = ve.ui.actionFactory.create( 'window', target.getSurface() );
|
|
windowAction.open( 'meta', { page: 'categories' } );
|
|
return false;
|
|
} )
|
|
.find( 'a' ).addClass( 've-init-mw-desktopArticleTarget-uneditableContent' );
|
|
} else {
|
|
$catlinks.addClass( 've-init-mw-desktopArticleTarget-uneditableContent' ).off( 'click.ve-target' );
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Update the history state based on the editor mode
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.updateHistoryState = function () {
|
|
var uri,
|
|
veaction = this.getDefaultMode() === 'visual' ? 'edit' : 'editsource';
|
|
|
|
// Push veaction=edit(source) url in history (if not already. If we got here by a veaction=edit(source)
|
|
// permalink then it will be there already and the constructor called #activate)
|
|
if (
|
|
!this.actFromPopState &&
|
|
history.pushState &&
|
|
(
|
|
this.currentUri.query.veaction !== veaction ||
|
|
this.currentUri.query.section !== this.section
|
|
) &&
|
|
this.currentUri.query.action !== 'edit'
|
|
) {
|
|
// Set the current URL
|
|
uri = this.currentUri;
|
|
|
|
if ( mw.libs.ve.isSingleEditTab ) {
|
|
uri.query.action = 'edit';
|
|
mw.config.set( 'wgAction', 'edit' );
|
|
} else {
|
|
uri.query.veaction = veaction;
|
|
delete uri.query.action;
|
|
mw.config.set( 'wgAction', 'view' );
|
|
}
|
|
if ( this.section !== null ) {
|
|
uri.query.section = this.section;
|
|
} else {
|
|
delete uri.query.section;
|
|
}
|
|
|
|
history.pushState( this.popState, document.title, uri );
|
|
}
|
|
this.actFromPopState = false;
|
|
};
|
|
|
|
/**
|
|
* Page modifications for switching back to view mode.
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.restorePage = function () {
|
|
var uri, keys, section, $section;
|
|
|
|
// Skins like monobook don't have a tab for view mode and instead just have the namespace tab
|
|
// selected. We didn't deselect the namespace tab, so we're ready after deselecting #ca-ve-edit.
|
|
// In skins having #ca-view (like Vector), select that.
|
|
this.updateTabs( false );
|
|
|
|
// Restore any previous redirectMsg/redirectsub
|
|
this.setRealRedirectInterface();
|
|
if ( this.$originalCategories ) {
|
|
$( '#catlinks' ).replaceWith( this.$originalCategories );
|
|
}
|
|
|
|
mw.hook( 've.deactivate' ).fire();
|
|
this.emit( 'restorePage' );
|
|
|
|
// Push article url into history
|
|
if ( !this.actFromPopState && history.pushState ) {
|
|
// Remove the VisualEditor query parameters
|
|
uri = this.currentUri;
|
|
if ( 'veaction' in uri.query ) {
|
|
delete uri.query.veaction;
|
|
}
|
|
if ( 'section' in uri.query ) {
|
|
// Translate into a fragment for the new URI:
|
|
// This should be after replacePageContent if this is post-save, so we can just look
|
|
// at the headers on the page.
|
|
section = uri.query.section.toString().indexOf( 'T-' ) === 0 ? +uri.query.section.slice( 2 ) : uri.query.section;
|
|
$section = this.$editableContent.find( 'h1, h2, h3, h4, h5, h6' )
|
|
// Ignore headings inside TOC
|
|
.filter( function () {
|
|
return $( this ).closest( '#toc' ).length === 0;
|
|
} );
|
|
if ( section === 'new' ) {
|
|
// A new section is appended to the end, so take the last one.
|
|
section = $section.length;
|
|
}
|
|
$section = $section.eq( section - 1 ).find( '.mw-headline' );
|
|
|
|
if ( $section.length && $section.attr( 'id' ) ) {
|
|
uri.fragment = $section.attr( 'id' );
|
|
this.viewUri.fragment = uri.fragment;
|
|
|
|
// Scroll the page to the edited section
|
|
setTimeout( function () {
|
|
$section[ 0 ].scrollIntoView( true );
|
|
} );
|
|
}
|
|
delete uri.query.section;
|
|
}
|
|
if ( 'action' in uri.query && $( '#wpTextbox1' ).length === 0 ) {
|
|
delete uri.query.action;
|
|
mw.config.set( 'wgAction', 'view' );
|
|
}
|
|
if ( 'oldid' in uri.query && !this.restoring ) {
|
|
// We have an oldid in the query string but it's the most recent one, so remove it
|
|
delete uri.query.oldid;
|
|
}
|
|
|
|
// If there are any other query parameters left, re-use that uri object.
|
|
// Otherwise use the canonical style view url (T44553, T102363).
|
|
keys = Object.keys( uri.query );
|
|
if ( !keys.length || ( keys.length === 1 && keys[ 0 ] === 'title' ) ) {
|
|
history.pushState( this.popState, document.title, this.viewUri );
|
|
} else {
|
|
history.pushState( this.popState, document.title, uri );
|
|
}
|
|
}
|
|
};
|
|
|
|
/**
|
|
* @param {Event} e Native event object
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.onWindowPopState = function ( e ) {
|
|
var veaction;
|
|
|
|
if ( !this.verifyPopState( e.state ) ) {
|
|
// Ignore popstate events fired for states not created by us
|
|
// This also filters out the initial fire in Chrome (bug 57901).
|
|
return;
|
|
}
|
|
|
|
this.currentUri = new mw.Uri( location.href );
|
|
veaction = this.currentUri.query.veaction;
|
|
|
|
if ( ve.init.target.isModeAvailable( 'source' ) && this.active ) {
|
|
if ( veaction === 'editsource' && this.getDefaultMode() === 'visual' ) {
|
|
this.actFromPopState = true;
|
|
this.switchToWikitextEditor();
|
|
} else if ( veaction === 'edit' && this.getDefaultMode() === 'source' ) {
|
|
this.actFromPopState = true;
|
|
this.switchToVisualEditor();
|
|
}
|
|
}
|
|
if ( !this.active && ( veaction === 'edit' || veaction === 'editsource' ) ) {
|
|
this.actFromPopState = true;
|
|
this.activate();
|
|
}
|
|
if ( this.active && veaction !== 'edit' && veaction !== 'editsource' ) {
|
|
this.actFromPopState = true;
|
|
this.tryTeardown( false, 'navigate-back' );
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Replace the page content with new HTML.
|
|
*
|
|
* @method
|
|
* @param {string} html Rendered HTML from server
|
|
* @param {string} categoriesHtml Rendered categories HTML from server
|
|
* @param {string} displayTitle HTML to show as the page title
|
|
* @param {Object} lastModified Object containing user-formatted date
|
|
* and time strings, or undefined if we made no change.
|
|
* @param {string} contentSub HTML to show as the content subtitle
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.replacePageContent = function (
|
|
html, categoriesHtml, displayTitle, lastModified, contentSub
|
|
) {
|
|
var $content = $( $.parseHTML( html ) ),
|
|
$categories;
|
|
|
|
if ( lastModified ) {
|
|
// If we were not viewing the most recent revision before (a requirement
|
|
// for lastmod to have been added by MediaWiki), we will be now.
|
|
if ( !$( '#footer-info-lastmod' ).length ) {
|
|
$( '#footer-info' ).prepend(
|
|
$( '<li>' ).attr( 'id', 'footer-info-lastmod' )
|
|
);
|
|
}
|
|
|
|
// Intentionally treated as HTML
|
|
$( '#footer-info-lastmod' ).html( ' ' + mw.msg(
|
|
'lastmodifiedat',
|
|
lastModified.date,
|
|
lastModified.time
|
|
) );
|
|
}
|
|
|
|
mw.hook( 'wikipage.content' ).fire( this.$editableContent.empty().append( $content ) );
|
|
if ( displayTitle ) {
|
|
$( '#firstHeading' ).html( displayTitle );
|
|
}
|
|
|
|
$categories = $( $.parseHTML( categoriesHtml ) );
|
|
mw.hook( 'wikipage.categories' ).fire( $categories );
|
|
$( '#catlinks' ).replaceWith( $categories );
|
|
this.$originalCategories = null;
|
|
|
|
$( '#contentSub' ).html( contentSub );
|
|
this.setRealRedirectInterface();
|
|
|
|
// Re-set any edit section handlers now that the page content has been replaced
|
|
mw.libs.ve.setupEditLinks();
|
|
};
|
|
|
|
/**
|
|
* Get the numeric index of a section in the page.
|
|
*
|
|
* @method
|
|
* @param {HTMLElement} heading Heading element of section
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.getEditSection = function ( heading ) {
|
|
var $page = $( '#mw-content-text' ),
|
|
section = 0;
|
|
$page.find( 'h1, h2, h3, h4, h5, h6' ).not( '#toc h2' ).each( function () {
|
|
section++;
|
|
if ( this === heading ) {
|
|
return false;
|
|
}
|
|
} );
|
|
return section;
|
|
};
|
|
|
|
/**
|
|
* Store the section for which the edit link has been triggered.
|
|
*
|
|
* @method
|
|
* @param {HTMLElement} heading Heading element of section
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.saveEditSection = function ( heading ) {
|
|
this.section = this.getEditSection( heading );
|
|
};
|
|
|
|
/**
|
|
* Add onunload and onbeforeunload handlers.
|
|
*
|
|
* @method
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.setupUnloadHandlers = function () {
|
|
if ( window.onbeforeunload !== this.onBeforeUnload ) {
|
|
// Remember any already set beforeunload handler
|
|
this.onBeforeUnloadFallback = window.onbeforeunload;
|
|
// Attach our handlers
|
|
window.onbeforeunload = this.onBeforeUnload;
|
|
window.addEventListener( 'unload', this.onUnloadHandler );
|
|
}
|
|
};
|
|
/**
|
|
* Remove onunload and onbeforunload handlers.
|
|
*
|
|
* @method
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.teardownUnloadHandlers = function () {
|
|
// Restore whatever previous onbeforeunload hook existed
|
|
window.onbeforeunload = this.onBeforeUnloadFallback;
|
|
this.onBeforeUnloadFallback = null;
|
|
window.removeEventListener( 'unload', this.onUnloadHandler );
|
|
};
|
|
|
|
/**
|
|
* Show the meta dialog as needed on load.
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.maybeShowMetaDialog = function () {
|
|
var windowAction, redirectMetaItems,
|
|
target = this;
|
|
|
|
if ( this.welcomeDialogPromise ) {
|
|
// Pop out the notices when the welcome dialog is closed
|
|
this.welcomeDialogPromise
|
|
.always( function () {
|
|
var popup;
|
|
if (
|
|
target.switched &&
|
|
!mw.user.options.get( 'visualeditor-hidevisualswitchpopup' )
|
|
) {
|
|
// Show "switched" popup
|
|
popup = new mw.libs.ve.SwitchPopupWidget( 'visual' );
|
|
target.actionsToolbar.tools.editModeSource.toolGroup.$element.append( popup.$element );
|
|
popup.toggle( true );
|
|
} else if ( target.actionsToolbar.tools.notices ) {
|
|
// Show notices
|
|
target.actionsToolbar.tools.notices.getPopup().toggle( true );
|
|
}
|
|
} );
|
|
}
|
|
|
|
redirectMetaItems = this.getSurface().getModel().getMetaList().getItemsInGroup( 'mwRedirect' );
|
|
if ( redirectMetaItems.length ) {
|
|
windowAction = ve.ui.actionFactory.create( 'window', this.getSurface() );
|
|
windowAction.open( 'meta', { page: 'settings' } );
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Handle before unload event.
|
|
*
|
|
* @method
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.onBeforeUnload = function () {
|
|
var fallbackResult;
|
|
// Check if someone already set on onbeforeunload hook
|
|
if ( this.onBeforeUnloadFallback ) {
|
|
// Get the result of their onbeforeunload hook
|
|
fallbackResult = this.onBeforeUnloadFallback();
|
|
// If it returned something, exit here and return their message
|
|
if ( fallbackResult !== undefined ) {
|
|
return fallbackResult;
|
|
}
|
|
}
|
|
// Check if there's been an edit
|
|
if (
|
|
this.getSurface() &&
|
|
$.contains( document, this.getSurface().$element.get( 0 ) ) &&
|
|
this.edited &&
|
|
!this.submitting &&
|
|
mw.user.options.get( 'useeditwarning' )
|
|
) {
|
|
// Return our message
|
|
return ve.msg( 'visualeditor-viewpage-savewarning' );
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Handle unload event.
|
|
*
|
|
* @method
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.onUnload = function () {
|
|
if ( !this.submitting ) {
|
|
ve.track( 'mwedit.abort', {
|
|
type: this.edited ? 'unknown-edited' : 'unknown',
|
|
mechanism: 'navigate',
|
|
mode: this.surface ? this.surface.getMode() : this.getDefaultMode()
|
|
} );
|
|
}
|
|
};
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.switchToFallbackWikitextEditor = function ( discardChanges, modified ) {
|
|
var uri, oldId, prefPromise,
|
|
target = this;
|
|
|
|
// Parent method
|
|
ve.init.mw.DesktopArticleTarget.super.prototype.switchToFallbackWikitextEditor.apply( this, arguments );
|
|
|
|
oldId = mw.config.get( 'wgRevisionId' ) || $( 'input[name=parentRevId]' ).val();
|
|
prefPromise = mw.libs.ve.setEditorPreference( 'wikitext' );
|
|
|
|
if ( discardChanges ) {
|
|
if ( modified ) {
|
|
ve.track( 'mwedit.abort', { type: 'switchwithout', mechanism: 'navigate', mode: 'visual' } );
|
|
} else {
|
|
ve.track( 'mwedit.abort', { type: 'switchnochange', mechanism: 'navigate', mode: 'visual' } );
|
|
}
|
|
this.submitting = true;
|
|
prefPromise.done( function () {
|
|
uri = target.viewUri.clone().extend( {
|
|
action: 'edit',
|
|
veswitched: 1
|
|
} );
|
|
if ( oldId ) {
|
|
uri.extend( { oldid: oldId } );
|
|
}
|
|
location.href = uri.toString();
|
|
} );
|
|
} else {
|
|
this.serialize(
|
|
this.getDocToSave(),
|
|
function ( wikitext ) {
|
|
ve.track( 'mwedit.abort', { type: 'switchwith', mechanism: 'navigate', mode: 'visual' } );
|
|
target.submitWithSaveFields( { wpDiff: 1, wpAutoSummary: '' }, wikitext );
|
|
}
|
|
);
|
|
}
|
|
};
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.reloadSurface = function () {
|
|
var target = this;
|
|
|
|
this.activating = true;
|
|
this.activatingDeferred = $.Deferred();
|
|
|
|
// Parent method
|
|
ve.init.mw.DesktopArticleTarget.super.prototype.reloadSurface.apply( this, arguments );
|
|
|
|
this.activatingDeferred.done( function () {
|
|
target.updateHistoryState();
|
|
target.afterActivate();
|
|
target.setupTriggerListeners();
|
|
} );
|
|
this.toolbarSetupDeferred.resolve();
|
|
};
|
|
|
|
/**
|
|
* Resets the document opacity when we've decided to cancel switching to the wikitext editor.
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.resetDocumentOpacity = function () {
|
|
this.getSurface().getView().getDocument().getDocumentNode().$element.css( 'opacity', 1 );
|
|
};
|
|
|
|
/**
|
|
* Set temporary redirect interface to match the current state of redirection in the editor.
|
|
*
|
|
* @param {string|null} title Current redirect target, or null if none
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.setFakeRedirectInterface = function ( title ) {
|
|
this.updateRedirectInterface(
|
|
title ? this.constructor.static.buildRedirectSub() : $(),
|
|
title ? this.constructor.static.buildRedirectMsg( title ) : $()
|
|
);
|
|
};
|
|
|
|
/**
|
|
* Set the redirect interface to match the page's redirect state.
|
|
*/
|
|
ve.init.mw.DesktopArticleTarget.prototype.setRealRedirectInterface = function () {
|
|
this.updateRedirectInterface(
|
|
mw.config.get( 'wgIsRedirect' ) ? this.constructor.static.buildRedirectSub() : $(),
|
|
// Remove our custom content header - the original one in #mw-content-text will be shown
|
|
$()
|
|
);
|
|
};
|
|
|
|
/* Registration */
|
|
|
|
ve.init.mw.targetFactory.register( ve.init.mw.DesktopArticleTarget );
|