mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-12-11 22:16:15 +00:00
2c77e88d2c
Change-Id: I30539877543dc2a57bd1428a00d10ac46d8fc294
140 lines
3.6 KiB
JavaScript
140 lines
3.6 KiB
JavaScript
/*!
|
|
* VisualEditor ContentEditable MWSignatureNode class.
|
|
*
|
|
* @copyright 2011-2020 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* ContentEditable MediaWiki signature node. This defines the behavior of the signature node
|
|
* inserted into the ContentEditable document.
|
|
*
|
|
* @class
|
|
* @extends ve.ce.MWTransclusionInlineNode
|
|
*
|
|
* @constructor
|
|
* @param {ve.dm.MWSignatureNode} model Model to observe
|
|
* @param {Object} [config] Configuration options
|
|
*/
|
|
ve.ce.MWSignatureNode = function VeCeMWSignatureNode() {
|
|
// Parent constructor
|
|
ve.ce.MWSignatureNode.super.apply( this, arguments );
|
|
|
|
// DOM changes
|
|
this.$element.addClass( 've-ce-mwSignatureNode' );
|
|
|
|
if ( this.isGenerating() ) {
|
|
// Use an initial rendering of '~~~~' as a placeholder to avoid
|
|
// the width changing when using the Sequence.
|
|
this.$element.text( '~~~~' );
|
|
}
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
OO.inheritClass( ve.ce.MWSignatureNode, ve.ce.MWTransclusionInlineNode );
|
|
|
|
/* Static Properties */
|
|
|
|
ve.ce.MWSignatureNode.static.name = 'mwSignature';
|
|
|
|
ve.ce.MWSignatureNode.static.tagName = 'span';
|
|
|
|
ve.ce.MWSignatureNode.static.primaryCommandName = 'mwSignature';
|
|
|
|
ve.ce.MWSignatureNode.static.liveSignatures = [];
|
|
|
|
// Update the timestamp on inserted signatures every minute.
|
|
setInterval( function () {
|
|
var updatedSignatures, i, sig,
|
|
liveSignatures = ve.ce.MWSignatureNode.static.liveSignatures;
|
|
|
|
updatedSignatures = [];
|
|
for ( i = 0; i < liveSignatures.length; i++ ) {
|
|
sig = liveSignatures[ i ];
|
|
try {
|
|
sig.forceUpdate();
|
|
updatedSignatures.push( sig );
|
|
} catch ( er ) {
|
|
// Do nothing
|
|
}
|
|
}
|
|
liveSignatures = updatedSignatures;
|
|
}, 60 * 1000 );
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
ve.ce.MWSignatureNode.prototype.onSetup = function () {
|
|
// Parent method
|
|
ve.ce.MWSignatureNode.super.prototype.onSetup.call( this );
|
|
|
|
// Keep track for regular updating of timestamp
|
|
this.constructor.static.liveSignatures.push( this );
|
|
};
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
ve.ce.MWSignatureNode.prototype.onTeardown = function () {
|
|
var index,
|
|
liveSignatures = this.constructor.static.liveSignatures;
|
|
|
|
// Parent method
|
|
ve.ce.MWSignatureNode.super.prototype.onTeardown.call( this );
|
|
|
|
// Stop tracking
|
|
index = liveSignatures.indexOf( this );
|
|
if ( index !== -1 ) {
|
|
liveSignatures.splice( index, 1 );
|
|
}
|
|
};
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
ve.ce.MWSignatureNode.prototype.generateContents = function () {
|
|
var wikitext, signatureNode, deferred, xhr;
|
|
// Parsoid doesn't support pre-save transforms. PHP parser doesn't support Parsoid's
|
|
// meta attributes (that may or may not be required).
|
|
|
|
// We could try hacking up one (or even both) of these, but just calling the two parsers
|
|
// in order seems slightly saner.
|
|
|
|
// We must have only one top-level node, this is the easiest way.
|
|
wikitext = '<span>~~~~</span>';
|
|
signatureNode = this;
|
|
|
|
deferred = ve.createDeferred();
|
|
xhr = ve.init.target.getContentApi( this.getModel().getDocument() ).post( {
|
|
action: 'parse',
|
|
text: wikitext,
|
|
contentmodel: 'wikitext',
|
|
prop: 'text',
|
|
onlypst: true
|
|
} )
|
|
.done( function ( resp ) {
|
|
var wikitext = ve.getProp( resp, 'parse', 'text' );
|
|
if ( wikitext ) {
|
|
// Call parent method with the wikitext with PST applied.
|
|
ve.ce.MWSignatureNode.parent.prototype.generateContents.call(
|
|
signatureNode,
|
|
{ wikitext: wikitext }
|
|
).done( function ( nodes ) {
|
|
deferred.resolve( nodes );
|
|
} );
|
|
} else {
|
|
signatureNode.onParseError( deferred );
|
|
}
|
|
} )
|
|
.fail( this.onParseError.bind( this, deferred ) );
|
|
|
|
return deferred.promise( { abort: xhr.abort } );
|
|
};
|
|
|
|
/* Registration */
|
|
|
|
ve.ce.nodeFactory.register( ve.ce.MWSignatureNode );
|