mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-11-26 23:31:02 +00:00
3269d53632
Bug: T76541 Depends-On: I227a0d704b9b337cff2102d424be9795d6362ed7 Change-Id: Iac71a51c8696434658f24fbb41c8142237bd810e
102 lines
4.1 KiB
JavaScript
102 lines
4.1 KiB
JavaScript
/*!
|
|
* VisualEditor MediaWiki DiffLoader.
|
|
*
|
|
* @copyright 2011-2019 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* Diff loader.
|
|
*
|
|
* @class mw.libs.ve.diffLoader
|
|
* @singleton
|
|
*/
|
|
( function () {
|
|
var revCache = {};
|
|
|
|
mw.libs.ve = mw.libs.ve || {};
|
|
|
|
mw.libs.ve.diffLoader = {
|
|
|
|
/**
|
|
* Get a ve.dm.Document model from a Parsoid response
|
|
*
|
|
* @param {Object} response Parsoid response from the VisualEditor API
|
|
* @param {number} [section] Section
|
|
* @return {ve.dm.Document|null} Document, or null if an invalid response
|
|
*/
|
|
getModelFromResponse: function ( response, section ) {
|
|
var doc,
|
|
targetClass = ve.init.mw.DesktopArticleTarget,
|
|
metadataIdRegExp = ve.init.platform.getMetadataIdRegExp(),
|
|
data = response ? ( response.visualeditor || response.visualeditoredit ) : null;
|
|
if ( data && typeof data.content === 'string' ) {
|
|
doc = targetClass.static.parseDocument( data.content, 'visual', section, true );
|
|
// Strip RESTBase IDs
|
|
Array.prototype.forEach.call( doc.querySelectorAll( '[id^="mw"]' ), function ( element ) {
|
|
if ( element.id.match( metadataIdRegExp ) ) {
|
|
element.removeAttribute( 'id' );
|
|
}
|
|
} );
|
|
return targetClass.static.createModelFromDom( doc, 'visual' );
|
|
}
|
|
return null;
|
|
},
|
|
|
|
/**
|
|
* Fetch a specific revision from Parsoid as a DM document, and cache in memory
|
|
*
|
|
* @param {number} revId Revision ID
|
|
* @param {string} [pageName] Page name, defaults to wgRelevantPageName
|
|
* @param {jQuery.Promise} [parseDocumentModulePromise] Promise which resolves when Target#parseDocument is available
|
|
* @param {number} [section] Section
|
|
* @return {jQuery.Promise} Promise which resolves with a document model
|
|
*/
|
|
fetchRevision: function ( revId, pageName, parseDocumentModulePromise, section ) {
|
|
var cacheKey = revId + ( section !== undefined ? '/' + section : '' );
|
|
|
|
parseDocumentModulePromise = parseDocumentModulePromise || $.Deferred().resolve().promise();
|
|
pageName = pageName || mw.config.get( 'wgRelevantPageName' );
|
|
|
|
revCache[ cacheKey ] = revCache[ cacheKey ] ||
|
|
mw.libs.ve.targetLoader.requestParsoidData( pageName, { oldId: revId, targetName: 'diff' } ).then( function ( response ) {
|
|
return parseDocumentModulePromise.then( function () {
|
|
return mw.libs.ve.diffLoader.getModelFromResponse( response, section );
|
|
} );
|
|
} );
|
|
|
|
return revCache[ cacheKey ];
|
|
},
|
|
|
|
/**
|
|
* Get a visual diff generator promise
|
|
*
|
|
* @param {number|jQuery.Promise} oldIdOrPromise Old revision ID, or document model promise
|
|
* @param {number|jQuery.Promise} newIdOrPromise New revision ID, or document model promise
|
|
* @param {jQuery.Promise} [parseDocumentModulePromise] Promise which resolves when Target#parseDocument is available
|
|
* @param {string} [oldPageName] Old revision's page name, defaults to wgRelevantPageName
|
|
* @param {string} [newPageName] New revision's page name, defaults to oldPageName
|
|
* @return {jQuery.Promise} Promise which resolves with a ve.dm.VisualDiff generator function
|
|
*/
|
|
getVisualDiffGeneratorPromise: function ( oldIdOrPromise, newIdOrPromise, parseDocumentModulePromise, oldPageName, newPageName ) {
|
|
var oldRevPromise, newRevPromise;
|
|
|
|
parseDocumentModulePromise = parseDocumentModulePromise || $.Deferred().resolve().promise();
|
|
oldPageName = oldPageName || mw.config.get( 'wgRelevantPageName' );
|
|
|
|
oldRevPromise = typeof oldIdOrPromise === 'number' ? this.fetchRevision( oldIdOrPromise, oldPageName, parseDocumentModulePromise ) : oldIdOrPromise;
|
|
newRevPromise = typeof newIdOrPromise === 'number' ? this.fetchRevision( newIdOrPromise, newPageName, parseDocumentModulePromise ) : newIdOrPromise;
|
|
|
|
return $.when( oldRevPromise, newRevPromise, parseDocumentModulePromise ).then( function ( oldDoc, newDoc ) {
|
|
// TODO: Differ expects newDoc to be derived from oldDoc and contain all its store data.
|
|
// We may want to remove that assumption from the differ?
|
|
newDoc.getStore().merge( oldDoc.getStore() );
|
|
return function () {
|
|
return new ve.dm.VisualDiff( oldDoc, newDoc );
|
|
};
|
|
} );
|
|
}
|
|
|
|
};
|
|
}() );
|