init.js
No OneTemporary
Actions

Size

12 KB

Referenced Files

None

Subscribers

None

init.js
View Options

	mw.editcheck = {
	config: require( './config.json' ),
	ecenable: !!( new URL( location.href ).searchParams.get( 'ecenable' ) \|\| window.MWVE_FORCE_EDIT_CHECK_ENABLED )
	};

	require( './EditCheckContextItem.js' );
	require( './EditCheckInspector.js' );
	require( './EditCheckDialog.js' );
	require( './EditCheckFactory.js' );
	require( './EditCheckAction.js' );
	require( './BaseEditCheck.js' );

	// TODO: Load these checks behind feature flags
	// require( './ConvertReferenceEditCheck.js' );
	// require( './TextMatchEditCheck.js' );
	require( './AddReferenceEditCheck.js' );

	/**
	* Return the content ranges (content branch node interiors) contained within a range
	*
	* For a content branch node entirely contained within the range, its entire interior
	* range will be included. For a content branch node overlapping with the range boundary,
	* only the covered part of its interior range will be included.
	*
	* @param {ve.dm.Document} documentModel The documentModel to search
	* @param {ve.Range} range The range to include
	* @param {boolean} covers Only include ranges which cover the whole of their node
	* @return {ve.Range[]} The contained content ranges (content branch node interiors)
	*/
	mw.editcheck.getContentRanges = function ( documentModel, range, covers ) {
	const ranges = [];
	documentModel.selectNodes( range, 'branches' ).forEach( ( spec ) => {
	if (
	spec.node.canContainContent() && (
	!covers \|\| (
	!spec.range \|\| // an empty range means the node is covered
	spec.range.equalsSelection( spec.nodeRange )
	)
	)
	) {
	ranges.push( spec.range \|\| spec.nodeRange );
	}
	} );
	return ranges;
	};

	mw.editcheck.hasAddedContentNeedingReference = function ( documentModel, includeReferencedContent ) {
	// helper for ve.init.mw.ArticleTarget save-tagging, keep logic below in-sync with AddReferenceEditCheck.
	// This is bypassing the normal "should this check apply?" logic for creation, so we need to manually
	// apply the "only the main namespace" rule.
	if ( mw.config.get( 'wgNamespaceNumber' ) !== mw.config.get( 'wgNamespaceIds' )[ '' ] ) {
	return false;
	}
	const check = mw.editcheck.editCheckFactory.create( 'addReference', mw.editcheck.config.addReference );
	return check.findAddedContent( documentModel, includeReferencedContent ).length > 0;
	};

	mw.editcheck.getModifiedRanges = function ( documentModel, coveredNodesOnly ) {
	if ( !documentModel.completeHistory.getLength() ) {
	return [];
	}
	const operations = documentModel.completeHistory.squash().transactions[ 0 ].operations;
	const ranges = [];
	let offset = 0;
	const endOffset = documentModel.getDocumentRange().end;
	operations.every( ( op ) => {
	if ( op.type === 'retain' ) {
	offset += op.length;
	} else if ( op.type === 'replace' ) {
	const insertedRange = new ve.Range( offset, offset + op.insert.length );
	offset += op.insert.length;
	// 1. Only trigger if the check is a pure insertion, with no adjacent content removed (T340088)
	if ( op.remove.length === 0 ) {
	ve.batchPush(
	ranges,
	// 2. Only fully inserted paragraphs (ranges that cover the whole node) (T345121)
	mw.editcheck.getContentRanges( documentModel, insertedRange, coveredNodesOnly )
	);
	}
	}
	// Reached the end of the doc / start of internal list, stop searching
	return offset < endOffset;
	} );
	return ranges;
	};

	mw.editcheck.rejections = [];

	mw.editcheck.getRejectionReasons = function () {
	return mw.editcheck.rejections;
	};

	mw.editcheck.refCheckShown = false;

	if ( mw.config.get( 'wgVisualEditorConfig' ).editCheckTagging ) {
	mw.hook( 've.activationComplete' ).add( () => {
	const target = ve.init.target;

	function getRefNodes() {
	// The firstNodes list is a numerically indexed array of reference nodes in the document.
	// The list is append only, and removed references are set to undefined in place.
	// To check if a new reference is being published, we just need to know if a reference
	// with an index beyond the initial list (initLength) is still set.
	const internalList = target.getSurface().getModel().getDocument().getInternalList();
	const group = internalList.getNodeGroup( 'mwReference/' );
	return group ? group.firstNodes \|\| [] : [];
	}

	const initLength = getRefNodes().length;
	target.saveFields.vetags = function () {
	const refNodes = getRefNodes();
	const newLength = refNodes.length;
	let newNodesInDoc = false;
	for ( let i = initLength; i < newLength; i++ ) {
	if ( refNodes[ i ] ) {
	newNodesInDoc = true;
	break;
	}
	}
	const tags = [];
	if ( newNodesInDoc ) {
	tags.push( 'editcheck-newreference' );
	}
	if ( mw.editcheck.refCheckShown ) {
	tags.push( 'editcheck-references-activated' );
	}
	return tags.join( ',' );
	};
	} );
	mw.hook( 've.deactivationComplete' ).add( () => {
	const target = ve.init.target;
	delete target.saveFields.vetags;
	} );
	}

	if ( mw.config.get( 'wgVisualEditorConfig' ).editCheck \|\| mw.editcheck.ecenable ) {
	let saveProcessDeferred;

	mw.hook( 've.preSaveProcess' ).add( ( saveProcess, target ) => {
	const surface = target.getSurface();

	if ( surface.getMode() !== 'visual' ) {
	// Some checks will entirely work in source mode for most cases.
	// But others will fail spectacularly -- e.g. reference check
	// isn't aware of <ref> tags and so will suggest that all content
	// has references added. As such, disable in source mode for now.
	return;
	}

	ve.track( 'counter.editcheck.preSaveChecksAvailable' );

	// clear rejection-reasons between runs of the save process, so only the last one counts
	mw.editcheck.rejections.length = 0;

	let checks = mw.editcheck.editCheckFactory.createAllByListener( 'onBeforeSave', surface.getModel() );
	if ( checks.length ) {
	ve.track( 'counter.editcheck.preSaveChecksShown' );
	mw.editcheck.refCheckShown = true;

	const surfaceView = surface.getView();
	const toolbar = target.getToolbar();
	const reviewToolbar = new ve.ui.PositionedTargetToolbar( target, target.toolbarConfig );
	reviewToolbar.setup( [
	{
	name: 'back',
	type: 'bar',
	include: [ 'editCheckBack' ]
	},
	// Placeholder toolbar groups
	// TODO: Make a proper TitleTool?
	{
	name: 'title',
	type: 'bar',
	include: []
	},
	{
	name: 'save',
	// TODO: MobileArticleTarget should ignore 'align'
	align: OO.ui.isMobile() ? 'before' : 'after',
	type: 'bar',
	include: [ 'showSaveDisabled' ]
	}
	], surface );
	reviewToolbar.$element.addClass( 've-ui-editCheck-toolbar' );

	reviewToolbar.items[ 1 ].$element.removeClass( 'oo-ui-toolGroup-empty' );
	reviewToolbar.items[ 1 ].$group.append(
	$( '<span>' ).addClass( 've-ui-editCheck-toolbar-title' ).text( ve.msg( 'editcheck-dialog-title' ) )
	);
	if ( OO.ui.isMobile() ) {
	reviewToolbar.$element.addClass( 've-init-mw-mobileArticleTarget-toolbar' );
	}
	target.toolbar.$element.before( reviewToolbar.$element );
	target.toolbar = reviewToolbar;

	saveProcessDeferred = ve.createDeferred();
	const context = surface.getContext();

	// TODO: Allow multiple checks to be shown when multicheck is enabled
	checks = checks.slice( 0, 1 );

	// eslint-disable-next-line no-shadow
	const drawSelections = ( checks ) => {
	const highlightNodes = [];
	const selections = [];
	checks.forEach( ( check ) => {
	highlightNodes.push.apply( highlightNodes, surfaceView.getDocument().selectNodes( check.highlight.getSelection().getCoveringRange(), 'branches' ).map( ( spec ) => spec.node ) );
	const selection = ve.ce.Selection.static.newFromModel( check.highlight.getSelection(), surfaceView );
	selections.push( selection );
	} );
	// TODO: Make selections clickable when multicheck is enabled
	surfaceView.drawSelections(
	'editCheck',
	checks.map( ( check ) => ve.ce.Selection.static.newFromModel( check.highlight.getSelection(), surfaceView ) )
	);
	surfaceView.setReviewMode( true, highlightNodes );
	};

	const contextDone = ( responseData, contextData ) => {
	if ( !responseData ) {
	// this is the back button
	return saveProcessDeferred.resolve();
	}
	const selectionIndex = checks.indexOf( contextData.action );

	if ( responseData.action !== 'reject' ) {
	mw.notify( ve.msg( 'editcheck-dialog-addref-success-notify' ), { type: 'success' } );
	} else if ( responseData.reason ) {
	mw.editcheck.rejections.push( responseData.reason );
	}
	// TODO: Move on to the next issue, when multicheck is enabled
	// checks = mw.editcheck.editCheckFactory.createAllByListener( 'onBeforeSave', surface.getModel() );
	checks = [];

	if ( checks.length ) {
	context.removePersistentSource( 'editCheckReferences' );
	setTimeout( () => {
	// timeout needed to wait out the newly added content being focused
	surface.getModel().setNullSelection();
	drawSelections( checks );
	setTimeout( () => {
	// timeout needed to allow the context to reposition
	showCheckContext( checks[ Math.min( selectionIndex, checks.length - 1 ) ] );
	} );
	}, 500 );
	} else {
	saveProcessDeferred.resolve( true );
	}
	};

	// eslint-disable-next-line no-inner-declarations
	function showCheckContext( check ) {
	const fragment = check.highlight;

	// Select the found content to correctly position the context on desktop
	fragment.select();

	context.addPersistentSource( {
	embeddable: false,
	data: {
	action: check,
	fragment: fragment,
	callback: contextDone,
	saveProcessDeferred: saveProcessDeferred
	},
	name: 'editCheckReferences'
	} );

	// Deactivate to prevent selection suppressing mobile context
	surface.getView().deactivate();

	// Once the context is positioned, clear the selection
	setTimeout( () => {
	surface.getModel().setNullSelection();
	} );
	}

	drawSelections( checks );
	toolbar.toggle( false );
	target.onContainerScroll();

	saveProcess.next( () => {
	showCheckContext( checks[ 0 ] );

	return saveProcessDeferred.promise().then( ( data ) => {
	context.removePersistentSource( 'editCheckReferences' );

	surfaceView.drawSelections( 'editCheck', [] );
	surfaceView.setReviewMode( false );

	reviewToolbar.$element.remove();
	toolbar.toggle( true );
	target.toolbar = toolbar;
	target.onContainerScroll();

	// Check the user inserted a citation
	if ( data ) {
	const delay = ve.createDeferred();
	// If they inserted, wait 2 seconds on desktop before showing save dialog
	setTimeout( () => {
	ve.track( 'counter.editcheck.preSaveChecksCompleted' );
	delay.resolve();
	}, !OO.ui.isMobile() && data.action !== 'reject' ? 2000 : 0 );
	return delay.promise();
	} else {
	ve.track( 'counter.editcheck.preSaveChecksAbandoned' );
	return ve.createDeferred().reject().promise();
	}
	} );
	} );
	} else {
	// Counterpart to earlier preSaveChecksShown, for use in tracking
	// errors in check-generation:
	ve.track( 'counter.editcheck.preSaveChecksNotShown' );
	}
	} );
	mw.hook( 've.deactivationComplete' ).add( () => {
	if ( saveProcessDeferred ) {
	saveProcessDeferred.reject();
	}
	} );
	}

	ve.ui.EditCheckBack = function VeUiEditCheckBack() {
	// Parent constructor
	ve.ui.EditCheckBack.super.apply( this, arguments );

	this.setDisabled( false );
	};
	OO.inheritClass( ve.ui.EditCheckBack, ve.ui.Tool );
	ve.ui.EditCheckBack.static.name = 'editCheckBack';
	ve.ui.EditCheckBack.static.icon = 'previous';
	ve.ui.EditCheckBack.static.autoAddToCatchall = false;
	ve.ui.EditCheckBack.static.autoAddToGroup = false;
	ve.ui.EditCheckBack.static.title =
	OO.ui.deferMsg( 'visualeditor-backbutton-tooltip' );
	ve.ui.EditCheckBack.prototype.onSelect = function () {
	const context = this.toolbar.getSurface().getContext();
	if ( context.inspector ) {
	context.inspector.close();
	} else {
	context.items[ 0 ].close();
	}
	this.setActive( false );
	};
	ve.ui.EditCheckBack.prototype.onUpdateState = function () {
	this.setDisabled( false );
	};
	ve.ui.toolFactory.register( ve.ui.EditCheckBack );

	ve.ui.EditCheckSaveDisabled = function VeUiEditCheckSaveDisabled() {
	// Parent constructor
	ve.ui.EditCheckSaveDisabled.super.apply( this, arguments );
	};
	OO.inheritClass( ve.ui.EditCheckSaveDisabled, ve.ui.MWSaveTool );
	ve.ui.EditCheckSaveDisabled.static.name = 'showSaveDisabled';
	ve.ui.EditCheckSaveDisabled.static.autoAddToCatchall = false;
	ve.ui.EditCheckSaveDisabled.static.autoAddToGroup = false;
	ve.ui.EditCheckSaveDisabled.prototype.onUpdateState = function () {
	this.setDisabled( true );
	};

	ve.ui.toolFactory.register( ve.ui.EditCheckSaveDisabled );

File Metadata

Mime Type: text/plain
Expires: Sat, May 16, 12:02 (18 h, 16 m)
Storage Engine: local-disk
Storage Format: Raw Data
Storage Handle: 3a/e8/d6f3f75c05129c4c6743f33dca98
Default Alt Text: init.js (12 KB)

init.jsNo OneTemporaryActions

init.jsView Options

File Metadata

Event Timeline

init.js
No OneTemporary
Actions

init.js
View Options