mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-11-27 15:50:29 +00:00
332 lines
11 KiB
JavaScript
332 lines
11 KiB
JavaScript
/*!
|
|
* VisualEditor MediaWiki CollabTarget init.
|
|
*
|
|
* @copyright See AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/* eslint-disable no-jquery/no-global-selector */
|
|
|
|
( function () {
|
|
let target,
|
|
$padTab = $( '#ca-pad' );
|
|
const $specialTab = $( '#ca-nstab-special' ),
|
|
conf = mw.config.get( 'wgVisualEditorConfig' ),
|
|
pageName = mw.config.get( 'collabPadPageName' ) || '',
|
|
pageTitle = mw.Title.newFromText( pageName ),
|
|
modules = [ OO.ui.isMobile() ? 'ext.visualEditor.collabTarget.mobile' : 'ext.visualEditor.collabTarget.desktop' ]
|
|
// Add modules from $wgVisualEditorPluginModules
|
|
.concat( conf.pluginModules.filter( mw.loader.getState ) ),
|
|
modulePromise = mw.loader.using( modules ),
|
|
progressBar = OO.ui.infuse( $( '.ve-init-mw-collabTarget-loading' ) ),
|
|
documentNameInput = OO.ui.infuse( $( '.ve-init-mw-collabTarget-nameInput' ) ),
|
|
documentNameButton = OO.ui.infuse( $( '.ve-init-mw-collabTarget-nameButton' ) ),
|
|
importInput = OO.ui.infuse( $( '.ve-init-mw-collabTarget-importInput' ), {
|
|
showImages: mw.config.get( 'wgVisualEditorConfig' ).usePageImages,
|
|
showDescriptions: mw.config.get( 'wgVisualEditorConfig' ).usePageDescriptions
|
|
} ),
|
|
importButton = OO.ui.infuse( $( '.ve-init-mw-collabTarget-importButton' ) ),
|
|
// Infuse the form last to avoid recursive infusion with no config
|
|
form = OO.ui.infuse( $( '.ve-init-mw-collabTarget-form' ) ),
|
|
$targetContainer = $(
|
|
document.querySelector( '[data-mw-ve-target-container]' ) ||
|
|
document.getElementById( 'content' )
|
|
);
|
|
|
|
if ( !VisualEditorSupportCheck() ) {
|
|
// VE not supported - say something?
|
|
return;
|
|
}
|
|
|
|
function setTitle( title ) {
|
|
$( '#firstHeading' ).text( title );
|
|
document.title = title;
|
|
}
|
|
|
|
function showPage( title, importTitle ) {
|
|
const specialTitle = mw.Title.newFromText( 'Special:CollabPad/' + title.toString() );
|
|
|
|
setTitle( mw.msg( 'collabpad-doctitle', title.getPrefixedText() ) );
|
|
|
|
mw.config.set( 'wgRelevantPageName', specialTitle.getPrefixedText() );
|
|
mw.config.set( 'wgPageName', specialTitle.getPrefixedText() );
|
|
if ( !$padTab.length ) {
|
|
$padTab = $( '<li>' ).attr( 'id', 'ca-pad' ).addClass( 'selected' ).append(
|
|
$( '<span>' ).append(
|
|
$( '<a>' ).attr( 'href', '' ).text( title.getPrefixedText() )
|
|
)
|
|
);
|
|
}
|
|
$padTab.insertAfter( $specialTab.removeClass( 'selected' ) );
|
|
|
|
progressBar.toggle( true );
|
|
form.toggle( false );
|
|
|
|
modulePromise.done( () => {
|
|
target = ve.init.mw.targetFactory.create( 'collab', title, conf.rebaserUrl, { importTitle: importTitle } );
|
|
// If the target emits a 'close' event (via the toolbar back button on mobile) then go to the landing page.
|
|
target.once( 'close', () => {
|
|
showForm( true );
|
|
} );
|
|
|
|
$( 'body' ).addClass( 've-activated ve-active' );
|
|
|
|
$targetContainer.prepend( target.$element );
|
|
|
|
target.transformPage();
|
|
$( '#firstHeading' ).addClass( 've-init-mw-desktopArticleTarget-uneditableContent' );
|
|
|
|
// Add a dummy surface while the doc is loading
|
|
const dummySurface = target.addSurface( ve.dm.converter.getModelFromDom( ve.createDocumentFromHtml( '' ) ) );
|
|
dummySurface.setReadOnly( true );
|
|
|
|
// TODO: Create the correct model surface type (ve.ui.Surface#createModel)
|
|
let surfaceModel = new ve.dm.Surface( ve.dm.converter.getModelFromDom( ve.createDocumentFromHtml( '' ) ) );
|
|
const username = mw.user.getName();
|
|
surfaceModel.createSynchronizer(
|
|
mw.config.get( 'wgWikiID' ) + '/' + title.toString(),
|
|
{
|
|
server: conf.rebaserUrl,
|
|
// TODO: server could communicate with MW (via oauth?) to know the
|
|
// current-user's name. Disable changing name if logged in?
|
|
// Communicate an I-am-a-valid-user flag to other clients?
|
|
defaultName: username
|
|
}
|
|
);
|
|
|
|
const progressDeferred = ve.createDeferred();
|
|
dummySurface.createProgress( progressDeferred.promise(), ve.msg( 'visualeditor-rebase-client-connecting' ), true );
|
|
|
|
surfaceModel.synchronizer.once( 'initDoc', ( error ) => {
|
|
let initPromise;
|
|
|
|
progressDeferred.resolve();
|
|
// Resolving the progress bar doesn't close the window in this cycle,
|
|
// so wait until we call clearSurfaces which destroys the window manager.
|
|
setTimeout( () => {
|
|
target.clearSurfaces();
|
|
// Don't add the surface until the history has been applied
|
|
target.addSurface( surfaceModel );
|
|
if ( error ) {
|
|
const $errorMsg = ve.htmlMsg( 'visualeditor-rebase-corrupted-document-error', $( '<pre>' ).text( error.stack ) );
|
|
OO.ui.alert(
|
|
$( '<p>' ).append( $errorMsg ),
|
|
{ title: ve.msg( 'visualeditor-rebase-corrupted-document-title' ), size: 'large' }
|
|
).then( () => {
|
|
showForm( true );
|
|
} );
|
|
return;
|
|
}
|
|
target.once( 'surfaceReady', () => {
|
|
initPromise.then( () => {
|
|
target.getSurface().getView().selectFirstSelectableContentOffset();
|
|
const isNewAuthor = !ve.init.platform.sessionStorage.get( 've-collab-author' );
|
|
// For new anon users, open the author list so they can set their name
|
|
if ( isNewAuthor && !username ) {
|
|
// Something (an animation?) steals focus during load, so wait a bit
|
|
// before opening and focusing the authorList.
|
|
setTimeout( () => {
|
|
target.toolbar.tools.authorList.onSelect();
|
|
}, 500 );
|
|
}
|
|
} );
|
|
} );
|
|
|
|
if ( target.importTitle && !surfaceModel.getDocument().getCompleteHistoryLength() ) {
|
|
initPromise = mw.libs.ve.targetLoader.requestParsoidData( target.importTitle.toString(), { targetName: 'collabpad' } ).then( ( response ) => {
|
|
const data = response.visualeditor;
|
|
|
|
if ( data && data.content ) {
|
|
const doc = target.constructor.static.parseDocument( data.content );
|
|
const dmDoc = target.constructor.static.createModelFromDom( doc );
|
|
const fragment = surfaceModel.getLinearFragment( new ve.Range( 0, 2 ) );
|
|
fragment.insertDocument( dmDoc );
|
|
|
|
target.etag = data.etag;
|
|
target.baseTimeStamp = data.basetimestamp;
|
|
target.startTimeStamp = data.starttimestamp;
|
|
target.revid = data.oldid;
|
|
|
|
// Store the document metadata as a hidden meta item
|
|
fragment.collapseToEnd().insertContent( [
|
|
{
|
|
type: 'alienMeta',
|
|
attributes: {
|
|
importedDocument: {
|
|
title: target.importTitle.toString(),
|
|
etag: target.etag,
|
|
baseTimeStamp: target.baseTimeStamp,
|
|
startTimeStamp: target.startTimeStamp,
|
|
revid: target.revid
|
|
}
|
|
}
|
|
},
|
|
{ type: '/alienMeta' }
|
|
] );
|
|
} else {
|
|
// Import failed
|
|
return ve.createDeferred().reject( 'No content for ' + target.importTitle ).promise();
|
|
}
|
|
} );
|
|
} else {
|
|
// No import, or history already exists
|
|
initPromise = ve.createDeferred().resolve().promise();
|
|
|
|
// Look for import metadata in document
|
|
surfaceModel = target.getSurface().getModel();
|
|
surfaceModel.getDocument().getMetaList().getItemsInGroup( 'misc' ).some( ( item ) => {
|
|
const importedDocument = item.getAttribute( 'importedDocument' );
|
|
if ( importedDocument ) {
|
|
target.importTitle = mw.Title.newFromText( importedDocument.title );
|
|
target.etag = importedDocument.etag;
|
|
target.baseTimeStamp = importedDocument.baseTimeStamp;
|
|
target.startTimeStamp = importedDocument.startTimeStamp;
|
|
target.revid = importedDocument.revid;
|
|
return true;
|
|
}
|
|
return false;
|
|
} );
|
|
}
|
|
initPromise.fail( ( err ) => {
|
|
setTimeout( () => {
|
|
throw new Error( err );
|
|
} );
|
|
} );
|
|
initPromise.always( () => {
|
|
progressDeferred.resolve();
|
|
} );
|
|
} );
|
|
} );
|
|
|
|
} ).always( () => {
|
|
form.toggle( false );
|
|
progressBar.toggle( false );
|
|
} ).fail( ( err ) => {
|
|
mw.log.error( err );
|
|
showForm( true );
|
|
} );
|
|
}
|
|
|
|
function showForm( pushState ) {
|
|
const specialTitle = mw.Title.newFromText( 'Special:CollabPad' );
|
|
|
|
if ( pushState ) {
|
|
history.pushState( { tag: 'collabTarget' }, '', specialTitle.getUrl() );
|
|
}
|
|
|
|
if ( target ) {
|
|
$( '#firstHeading' ).removeClass( 've-init-mw-desktopArticleTarget-uneditableContent' );
|
|
target.restorePage();
|
|
target.destroy();
|
|
|
|
$( 'body' ).removeClass( 've-activated ve-active' );
|
|
}
|
|
|
|
setTitle( mw.msg( 'collabpad' ) );
|
|
mw.config.set( 'wgRelevantPageName', specialTitle.getPrefixedText() );
|
|
mw.config.set( 'wgPageName', specialTitle.getPrefixedText() );
|
|
if ( $padTab ) {
|
|
$padTab.detach();
|
|
}
|
|
$specialTab.addClass( 'selected' );
|
|
|
|
progressBar.toggle( false );
|
|
form.toggle( true );
|
|
}
|
|
|
|
function loadTitle( title, importTitle ) {
|
|
const specialTitle = mw.Title.newFromText( 'Special:CollabPad/' + title.toString() );
|
|
// TODO: Handle popstate
|
|
history.pushState( { tag: 'collabTarget', title: title.toString() }, '', specialTitle.getUrl() );
|
|
showPage( title, importTitle );
|
|
}
|
|
|
|
function getRandomTitle() {
|
|
return ve.init.platform.generateUniqueId();
|
|
}
|
|
|
|
function onNameChange() {
|
|
documentNameInput.getValidity().then( () => {
|
|
documentNameButton.setDisabled( false );
|
|
}, () => {
|
|
documentNameButton.setDisabled( true );
|
|
} );
|
|
}
|
|
|
|
function loadFromName() {
|
|
documentNameInput.getValidity().then( () => {
|
|
const title = mw.Title.newFromText(
|
|
documentNameInput.getValue().trim() || getRandomTitle()
|
|
);
|
|
|
|
if ( title ) {
|
|
loadTitle( title );
|
|
} else {
|
|
documentNameInput.focus();
|
|
}
|
|
} );
|
|
}
|
|
|
|
// Empty input will create a random document name, otherwise must be valid
|
|
documentNameInput.setValidation( ( value ) => value === '' || !!mw.Title.newFromText( value ) );
|
|
documentNameButton.setDisabled( false );
|
|
|
|
documentNameInput.on( 'change', onNameChange );
|
|
documentNameInput.on( 'enter', loadFromName );
|
|
documentNameButton.on( 'click', loadFromName );
|
|
onNameChange();
|
|
|
|
function onImportChange() {
|
|
importInput.getValidity().then( () => {
|
|
importButton.setDisabled( false );
|
|
}, () => {
|
|
importButton.setDisabled( true );
|
|
} );
|
|
}
|
|
|
|
function onImportSubmit() {
|
|
importInput.getValidity().then( () => {
|
|
const title = mw.Title.newFromText( importInput.getValue().trim() );
|
|
|
|
if ( title ) {
|
|
loadTitle( mw.Title.newFromText( getRandomTitle() ), title );
|
|
} else {
|
|
documentNameInput.focus();
|
|
}
|
|
} );
|
|
}
|
|
|
|
// TODO: Check page exists?
|
|
importInput.setValidation( ( value ) => !!mw.Title.newFromText( value ) );
|
|
importInput.on( 'change', onImportChange );
|
|
importInput.on( 'enter', onImportSubmit );
|
|
importButton.on( 'click', onImportSubmit );
|
|
onImportChange();
|
|
|
|
if ( pageTitle ) {
|
|
const url = new URL( location.href ),
|
|
importTitleText = url.searchParams.get( 'import' ),
|
|
importTitleParam = ( importTitleText ? mw.Title.newFromText( importTitleText ) : null );
|
|
showPage( pageTitle, importTitleParam );
|
|
} else {
|
|
showForm();
|
|
}
|
|
|
|
$specialTab.on( 'click', ( e ) => {
|
|
showForm( true );
|
|
e.preventDefault();
|
|
} );
|
|
|
|
// Tag current state
|
|
history.replaceState( { tag: 'collabTarget', title: pageName }, '', location.href );
|
|
window.addEventListener( 'popstate', ( e ) => {
|
|
if ( e.state && e.state.tag === 'collabTarget' ) {
|
|
if ( e.state.title ) {
|
|
showPage( mw.Title.newFromText( e.state.title ) );
|
|
} else {
|
|
showForm();
|
|
}
|
|
}
|
|
} );
|
|
}() );
|