mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-11-16 19:09:29 +00:00
92c3055628
In MediaWiki, section numbers may be prefixed with 'T-' if they refer
to sections on a transcluded page, so they are not really numbers.
Change e2cb9ce93e caused us to treat them as strings most of the time,
but it looks like there are several places where we treated them as
integer numbers, which I missed when making that patch.
The first two changes in ArticleTarget#restoreEditSection fix T248795
and T248968/T249112, respectively. The other changes are cleanup.
Bug: T248795
Bug: T248968
Bug: T249112
Change-Id: I8373a7ab515595769ce6f3051a182c922415b643
115 lines
4.5 KiB
JavaScript
115 lines
4.5 KiB
JavaScript
/*!
|
|
* VisualEditor MediaWiki DiffLoader.
|
|
*
|
|
* @copyright 2011-2020 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 {string|null} section Section. Null for the whole document.
|
|
* @return {ve.dm.Document|null} Document, or null if an invalid response
|
|
*/
|
|
getModelFromResponse: function ( response, section ) {
|
|
var doc,
|
|
// This method is only called after actually loading these, see `parseDocumentModulePromise`
|
|
// eslint-disable-next-line no-undef
|
|
targetClass = ve.init.mw.ArticleTarget,
|
|
// eslint-disable-next-line no-undef
|
|
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, section !== null );
|
|
// 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 {string|null} [section=null] Section. Null for the whole document.
|
|
* @param {jQuery.Promise} [parseDocumentModulePromise] Promise which resolves when Target#parseDocument is available
|
|
* @return {jQuery.Promise} Promise which resolves with a document model
|
|
*/
|
|
fetchRevision: function ( revId, pageName, section, parseDocumentModulePromise ) {
|
|
var cacheKey;
|
|
|
|
pageName = pageName || mw.config.get( 'wgRelevantPageName' );
|
|
parseDocumentModulePromise = parseDocumentModulePromise || $.Deferred().resolve().promise();
|
|
section = section !== undefined ? section : null;
|
|
|
|
cacheKey = revId + ( section !== null ? '/' + section : '' );
|
|
|
|
revCache[ cacheKey ] = revCache[ cacheKey ] ||
|
|
mw.libs.ve.targetLoader.requestParsoidData(
|
|
pageName,
|
|
{ oldId: revId, targetName: 'diff' },
|
|
false,
|
|
// noMetadata, we only use `content` in getModelFromResponse
|
|
true
|
|
).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, null, parseDocumentModulePromise ) : oldIdOrPromise;
|
|
newRevPromise = typeof newIdOrPromise === 'number' ? this.fetchRevision( newIdOrPromise, newPageName, null, 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 () {
|
|
// eslint-disable-next-line no-undef
|
|
return new ve.dm.VisualDiff( oldDoc, newDoc );
|
|
};
|
|
} );
|
|
}
|
|
|
|
};
|
|
}() );
|