mirrors/etherpad-lite
1
0
Fork 0
mirror of https://github.com/ether/etherpad-lite.git synced 2025-04-22 16:36:15 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 33

Pad: Plumb author ID through mutation operations

Browse source
This commit is contained in:
Richard Hansen 2022-02-17 00:01:07 -05:00
parent 5f60b3aab2
commit 3b8549342a
7 changed files with 35 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

25
src/node/db/Pad.js
View file

@ -274,8 +274,9 @@ Pad.prototype.text = function () {
* @param {number} ndel - Number of characters to remove starting at `start`. Must be a non-negative
* integer less than or equal to `this.text().length - start`.
* @param {string} ins - New text to insert at `start` (after the `ndel` characters are deleted).
* @param {string} [authorId] - Author ID of the user making the change (if applicable).
*/
Pad.prototype.spliceText = async function (start, ndel, ins) {
Pad.prototype.spliceText = async function (start, ndel, ins, authorId = '') {
if (start < 0) throw new RangeError(`start index must be non-negative (is ${start})`);
if (ndel < 0) throw new RangeError(`characters to delete must be non-negative (is ${ndel})`);
const orig = this.text();
@ -289,7 +290,7 @@ Pad.prototype.spliceText = async function (start, ndel, ins) {
if (!willEndWithNewline) ins += '\n';
if (ndel === 0 && ins.length === 0) return;
const changeset = Changeset.makeSplice(orig, start, ndel, ins);
await this.appendRevision(changeset);
await this.appendRevision(changeset, authorId);
};
/**
@ -297,18 +298,20 @@ Pad.prototype.spliceText = async function (start, ndel, ins) {
*
* @param {string} newText - The pad's new text. If this string does not end with a newline, one
* will be automatically appended.
* @param {string} [authorId] - The author ID of the user that initiated the change, if applicable.
*/
Pad.prototype.setText = async function (newText) {
await this.spliceText(0, this.text().length, newText);
Pad.prototype.setText = async function (newText, authorId = '') {
await this.spliceText(0, this.text().length, newText, authorId);
};
/**
* Appends text to the pad.
*
* @param {string} newText - Text to insert just BEFORE the pad's existing terminating newline.
* @param {string} [authorId] - The author ID of the user that initiated the change, if applicable.
*/
Pad.prototype.appendText = async function (newText) {
await this.spliceText(this.text().length - 1, 0, newText);
Pad.prototype.appendText = async function (newText, authorId = '') {
await this.spliceText(this.text().length - 1, 0, newText, authorId);
};
/**
@ -368,7 +371,7 @@ Pad.prototype.getChatMessages = async function (start, end) {
});
};
Pad.prototype.init = async function (text) {
Pad.prototype.init = async function (text, authorId = '') {
// replace text with default text if text isn't set
if (text == null) {
text = settings.defaultPadText;
@ -391,7 +394,7 @@ Pad.prototype.init = async function (text) {
// this pad doesn't exist, so create it
const firstChangeset = Changeset.makeSplice('\n', 0, 0, exports.cleanText(text));
await this.appendRevision(firstChangeset, '');
await this.appendRevision(firstChangeset, authorId);
}
};
@ -476,7 +479,7 @@ Pad.prototype.copyAuthorInfoToDestinationPad = async function (destinationID) {
(authorID) => authorManager.addPad(authorID, destinationID)));
};
Pad.prototype.copyPadWithoutHistory = async function (destinationID, force) {
Pad.prototype.copyPadWithoutHistory = async function (destinationID, force, authorId = '') {
// flush the source pad
this.saveToDatabase();
@ -494,7 +497,7 @@ Pad.prototype.copyPadWithoutHistory = async function (destinationID, force) {
}
// initialize the pad with a new line to avoid getting the defaultText
const newPad = await padManager.getPad(destinationID, '\n');
const newPad = await padManager.getPad(destinationID, '\n', authorId);
newPad.pool = this.pool.clone();
const oldAText = this.atext;
@ -514,7 +517,7 @@ Pad.prototype.copyPadWithoutHistory = async function (destinationID, force) {
// create a changeset that removes the previous text and add the newText with
// all atributes present on the source pad
const changeset = Changeset.pack(oldLength, newLength, assem.toString(), newText);
newPad.appendRevision(changeset);
newPad.appendRevision(changeset, authorId);
await hooks.aCallAll('padCopy', {originalPad: this, destinationID});

8
src/node/db/PadManager.js
View file

@ -91,9 +91,11 @@ const padList = new class {
/**
* Returns a Pad Object with the callback
* @param id A String with the id of the pad
* @param {Function} callback
* @param {string} [text] - Optional initial pad text if creating a new pad.
* @param {string} [authorId] - Optional author ID of the user that initiated the pad creation (if
* applicable).
*/
exports.getPad = async (id, text) => {
exports.getPad = async (id, text, authorId = '') => {
// check if this is a valid padId
if (!exports.isValidPadId(id)) {
throw new CustomError(`${id} is not a valid padId`, 'apierror');
@ -123,7 +125,7 @@ exports.getPad = async (id, text) => {
pad = new Pad.Pad(id);
// initialize the pad
await pad.init(text);
await pad.init(text, authorId);
hooks.callAll('padLoad', {pad});
globalPads.set(id, pad);
padList.addPad(id);