` : ` ${hookName}:`);
- const sortedHookEntry = new Map([...hookEntry].sort(sortStringKeys));
+ const sortedHookEntry = new Map([...hookEntry].sort(sortStringKeys));
hooks.set(hookName, sortedHookEntry);
for (const [pluginName, pluginEntry] of sortedHookEntry) {
lines.push(html ? `
${pluginName}:
` : ` ${pluginName}:`);
@@ -72,20 +83,20 @@ exports.formatHooks = (hookSetName, html) => {
return lines.join('\n');
};
-exports.pathNormalization = (part, hookFnName, hookName) => {
+export const pathNormalization = (part, hookFnName, hookName) => {
const tmp = hookFnName.split(':'); // hookFnName might be something like 'C:\\foo.js:myFunc'.
// If there is a single colon assume it's 'filename:funcname' not 'C:\\filename'.
const functionName = (tmp.length > 1 ? tmp.pop() : null) || hookName;
const moduleName = tmp.join(':') || part.plugin;
- const packageDir = path.dirname(defs.plugins[part.plugin].package.path);
+ const packageDir = path.dirname(plugins[part.plugin].package.path);
const fileName = path.join(packageDir, moduleName);
return `${fileName}:${functionName}`;
};
-exports.update = async () => {
+export const update = async () => {
const packages = await exports.getPackages();
- const parts = {}; // Key is full name. sortParts converts this into a topologically sorted array.
- const plugins = {};
+ let parts:{[keys: string]:any} = {}; // Key is full name. sortParts converts this into a topologically sorted array.
+ let plugins = {};
// Load plugin metadata ep.json
await Promise.all(Object.keys(packages).map(async (pluginName) => {
@@ -94,13 +105,13 @@ exports.update = async () => {
}));
logger.info(`Loaded ${Object.keys(packages).length} plugins`);
- defs.plugins = plugins;
- defs.parts = sortParts(parts);
- defs.hooks = pluginUtils.extractHooks(defs.parts, 'hooks', exports.pathNormalization);
- defs.loaded = true;
- await Promise.all(Object.keys(defs.plugins).map(async (p) => {
+ setPlugins(plugins);
+ setParts(sortParts(parts))
+ setHooks(extractHooks(parts, 'hooks', exports.pathNormalization));
+ setLoaded(true)
+ await Promise.all(Object.keys(plugins).map(async (p) => {
const logger = log4js.getLogger(`plugin:${p}`);
- await hooks.aCallAll(`init_${p}`, {logger});
+ await aCallAll(`init_${p}`, {logger});
}));
};
@@ -112,13 +123,15 @@ exports.getPackages = async () => {
// unset or set to `development`) because otherwise `npm ls` will not mention any packages
// that are not included in `package.json` (which is expected to not exist).
const cmd = ['npm', 'ls', '--long', '--json', '--depth=0', '--no-production'];
- const {dependencies = {}} = JSON.parse(await runCmd(cmd, {stdio: [null, 'string']}));
+ const {dependencies = {}} = JSON.parse(await exportCMD(cmd, {stdio: [null, 'string']}) as unknown as string);
await Promise.all(Object.entries(dependencies).map(async ([pkg, info]) => {
if (!pkg.startsWith(exports.prefix)) {
delete dependencies[pkg];
return;
}
- info.realPath = await fs.realpath(info.path);
+ const mappedInfo = info as PluginInfo
+
+ mappedInfo.realPath = await fs.realpath(mappedInfo.path);
}));
return dependencies;
};
@@ -126,7 +139,7 @@ exports.getPackages = async () => {
const loadPlugin = async (packages, pluginName, plugins, parts) => {
const pluginPath = path.resolve(packages[pluginName].path, 'ep.json');
try {
- const data = await fs.readFile(pluginPath);
+ const data = await fs.readFile(pluginPath, "utf8");
try {
const plugin = JSON.parse(data);
plugin.package = packages[pluginName];
@@ -145,7 +158,7 @@ const loadPlugin = async (packages, pluginName, plugins, parts) => {
};
const partsToParentChildList = (parts) => {
- const res = [];
+ const res:(string|number)[][] = [];
for (const name of Object.keys(parts)) {
for (const childName of parts[name].post || []) {
res.push([name, childName]);
@@ -161,6 +174,7 @@ const partsToParentChildList = (parts) => {
};
// Used only in Node, so no need for _
-const sortParts = (parts) => tsort(partsToParentChildList(parts))
- .filter((name) => parts[name] !== undefined)
- .map((name) => parts[name]);
+//FIXME Is this better
+const sortParts = (parts:PartType) => tsort(partsToParentChildList(parts))
+ .filter((name) => name !== undefined)
+ .map((name) => name);
diff --git a/src/static/js/pluginfw/shared.js b/src/static/js/pluginfw/shared.ts
similarity index 91%
rename from src/static/js/pluginfw/shared.js
rename to src/static/js/pluginfw/shared.ts
index 2c81ccd8198..ec22b8cc6be 100644
--- a/src/static/js/pluginfw/shared.js
+++ b/src/static/js/pluginfw/shared.ts
@@ -1,6 +1,6 @@
'use strict';
-const defs = require('./plugin_defs');
+import {parts} from './plugin_defs';
const disabledHookReasons = {
hooks: {
@@ -9,7 +9,7 @@ const disabledHookReasons = {
},
};
-const loadFn = (path, hookName) => {
+export const loadFn = (path, hookName) => {
let functionName;
const parts = path.split(':');
@@ -33,7 +33,7 @@ const loadFn = (path, hookName) => {
return fn;
};
-const extractHooks = (parts, hookSetName, normalizer) => {
+export const extractHooks = (parts, hookSetName, normalizer) => {
const hooks = {};
for (const part of parts) {
for (const [hookName, regHookFnName] of Object.entries(part[hookSetName] || {})) {
@@ -72,9 +72,7 @@ const extractHooks = (parts, hookSetName, normalizer) => {
}
}
return hooks;
-};
-
-exports.extractHooks = extractHooks;
+}
/*
* Returns an array containing the names of the installed client-side plugins
@@ -88,8 +86,8 @@ exports.extractHooks = extractHooks;
* No plugins: []
* Some plugins: [ 'ep_adminpads', 'ep_add_buttons', 'ep_activepads' ]
*/
-exports.clientPluginNames = () => {
- const clientPluginNames = defs.parts
+export const clientPluginNames = () => {
+ const clientPluginNames = parts
.filter((part) => Object.prototype.hasOwnProperty.call(part, 'client_hooks'))
.map((part) => `plugin-${part.plugin}`);
return [...new Set(clientPluginNames)];
diff --git a/src/static/js/pluginfw/tsort.js b/src/static/js/pluginfw/tsort.ts
similarity index 89%
rename from src/static/js/pluginfw/tsort.js
rename to src/static/js/pluginfw/tsort.ts
index 117f8555cd8..bebac95c0fc 100644
--- a/src/static/js/pluginfw/tsort.js
+++ b/src/static/js/pluginfw/tsort.ts
@@ -4,14 +4,14 @@
* general topological sort
* from https://gist.github.com/1232505
* @author SHIN Suzuki (shinout310@gmail.com)
- * @param Array edges : list of edges. each edge forms Array e.g. [12 , 3]
+ * @param edges Array edges : list of edges. each edge forms Array e.g. [12 , 3]
*
* @returns Array : topological sorted list of IDs
**/
-const tsort = (edges) => {
+export const tsort = (edges: (string|number)[][]) => {
const nodes = {}; // hash: stringified id of the node => { id: id, afters: lisf of ids }
- const sorted = []; // sorted list of IDs ( returned value )
+ const sorted: (string|number)[][]= []; // sorted list of IDs ( returned value )
const visited = {}; // hash: id of already visited node => true
const Node = function (id) {
@@ -62,7 +62,7 @@ const tsort = (edges) => {
**/
const tsortTest = () => {
// example 1: success
- let edges = [
+ let edges:(string|number)[][] = [
[1, 2],
[1, 3],
[2, 4],
diff --git a/src/static/module/InstallerModel.ts b/src/static/module/InstallerModel.ts
new file mode 100644
index 00000000000..39e6bf51d91
--- /dev/null
+++ b/src/static/module/InstallerModel.ts
@@ -0,0 +1,5 @@
+export type InstallerModel = {
+ name: string,
+ description: string,
+
+}
diff --git a/src/static/module/PluginInfo.ts b/src/static/module/PluginInfo.ts
new file mode 100644
index 00000000000..8508e3c4b66
--- /dev/null
+++ b/src/static/module/PluginInfo.ts
@@ -0,0 +1,4 @@
+export type PluginInfo = {
+ realPath: string,
+ path: string,
+}
diff --git a/src/tsconfig.json b/src/tsconfig.json
index b99c6c15aa7..fb9bc8c7ab9 100644
--- a/src/tsconfig.json
+++ b/src/tsconfig.json
@@ -1,5 +1,6 @@
{
"compilerOptions": {
+ "allowJs": true,
"typeRoots": ["node_modules/@types"],
"types": ["node", "jquery"],
"module": "commonjs",
@@ -7,7 +8,7 @@
"target": "es6",
"moduleResolution": "node",
"sourceMap": true,
- "outDir": "dist"
+ "outDir": "../dist"
},
"lib": ["es2015"]
}
From 237f7242ec1a5ebdf3f500daaeb2398c0f25c20b Mon Sep 17 00:00:00 2001
From: SamTV12345 <40429738+samtv12345@users.noreply.github.com>
Date: Fri, 23 Jun 2023 21:18:12 +0200
Subject: [PATCH 04/11] Moved to ts for other dependencies.
---
src/.eslintrc.cjs | 220 +-
src/node/db/Pad.ts | 2 +-
src/node/handler/PadMessageHandler.ts | 5 +-
src/static/js/{Changeset.ts => Changeset.js} | 2093 +++++++-----------
src/static/js/{ace.js => ace.ts} | 112 +-
src/static/module/Ace2EditorInfo.ts | 5 +
src/static/module/CustomWindow.ts | 14 +
src/tsconfig.json | 2 +-
8 files changed, 979 insertions(+), 1474 deletions(-)
rename src/static/js/{Changeset.ts => Changeset.js} (69%)
rename src/static/js/{ace.js => ace.ts} (84%)
create mode 100644 src/static/module/Ace2EditorInfo.ts
create mode 100644 src/static/module/CustomWindow.ts
diff --git a/src/.eslintrc.cjs b/src/.eslintrc.cjs
index 95c9efa07f2..0930b688898 100644
--- a/src/.eslintrc.cjs
+++ b/src/.eslintrc.cjs
@@ -1,10 +1,6 @@
+import "eslint-config-etherpad/patch/modern-module-resolution";
'use strict';
-
-// This is a workaround for https://github.com/eslint/eslint/issues/3458
-require('eslint-config-etherpad/patch/modern-module-resolution');
-
-module.exports = {
- ignorePatterns: [
+export const ignorePatterns = [
'/static/js/admin/jquery.autosize.js',
'/static/js/admin/minify.json.js',
'/static/js/vendors/browser.js',
@@ -14,128 +10,132 @@ module.exports = {
'/static/js/vendors/jquery.js',
'/static/js/vendors/nice-select.js',
'/tests/frontend/lib/',
- ],
- overrides: [
+];
+export const overrides = [
{
- files: [
- '**/.eslintrc.*',
- ],
- extends: 'etherpad/node',
+ files: [
+ '**/.eslintrc.*',
+ ],
+ extends: 'etherpad/node',
},
{
- files: [
- '**/*',
- ],
- excludedFiles: [
- '**/.eslintrc.*',
- 'tests/frontend/**/*',
- ],
- extends: 'etherpad/node',
+ files: [
+ '**/*',
+ ],
+ excludedFiles: [
+ '**/.eslintrc.*',
+ 'tests/frontend/**/*',
+ ],
+ extends: 'etherpad/node',
},
{
- files: [
- 'static/**/*',
- 'tests/frontend/helper.js',
- 'tests/frontend/helper/**/*',
- ],
- excludedFiles: [
- '**/.eslintrc.*',
- ],
- extends: 'etherpad/browser',
- env: {
- 'shared-node-browser': true,
- },
- overrides: [
- {
- files: [
+ files: [
+ 'static/**/*',
+ 'tests/frontend/helper.js',
'tests/frontend/helper/**/*',
- ],
- globals: {
- helper: 'readonly',
- },
+ ],
+ excludedFiles: [
+ '**/.eslintrc.*',
+ ],
+ extends: 'etherpad/browser',
+ env: {
+ 'shared-node-browser': true,
},
- ],
- },
- {
- files: [
- 'tests/**/*',
- ],
- excludedFiles: [
- '**/.eslintrc.*',
- 'tests/frontend/cypress/**/*',
- 'tests/frontend/helper.js',
- 'tests/frontend/helper/**/*',
- 'tests/frontend/travis/**/*',
- 'tests/ratelimit/**/*',
- ],
- extends: 'etherpad/tests',
- rules: {
- 'mocha/no-exports': 'off',
- 'mocha/no-top-level-hooks': 'off',
- },
+ overrides: [
+ {
+ files: [
+ 'tests/frontend/helper/**/*',
+ ],
+ globals: {
+ helper: 'readonly',
+ },
+ },
+ ],
},
{
- files: [
- 'tests/backend/**/*',
- ],
- excludedFiles: [
- '**/.eslintrc.*',
- ],
- extends: 'etherpad/tests/backend',
- overrides: [
- {
- files: [
- 'tests/backend/**/*',
- ],
- excludedFiles: [
- 'tests/backend/specs/**/*',
- ],
- rules: {
+ files: [
+ 'tests/**/*',
+ ],
+ excludedFiles: [
+ '**/.eslintrc.*',
+ 'tests/frontend/cypress/**/*',
+ 'tests/frontend/helper.js',
+ 'tests/frontend/helper/**/*',
+ 'tests/frontend/travis/**/*',
+ 'tests/ratelimit/**/*',
+ ],
+ extends: 'etherpad/tests',
+ rules: {
'mocha/no-exports': 'off',
'mocha/no-top-level-hooks': 'off',
- },
},
- ],
},
{
- files: [
- 'tests/frontend/**/*',
- ],
- excludedFiles: [
- '**/.eslintrc.*',
- 'tests/frontend/cypress/**/*',
- 'tests/frontend/helper.js',
- 'tests/frontend/helper/**/*',
- 'tests/frontend/travis/**/*',
- ],
- extends: 'etherpad/tests/frontend',
- overrides: [
- {
- files: [
+ files: [
+ 'tests/backend/**/*',
+ ],
+ excludedFiles: [
+ '**/.eslintrc.*',
+ ],
+ extends: 'etherpad/tests/backend',
+ overrides: [
+ {
+ files: [
+ 'tests/backend/**/*',
+ ],
+ excludedFiles: [
+ 'tests/backend/specs/**/*',
+ ],
+ rules: {
+ 'mocha/no-exports': 'off',
+ 'mocha/no-top-level-hooks': 'off',
+ },
+ },
+ ],
+ },
+ {
+ files: [
'tests/frontend/**/*',
- ],
- excludedFiles: [
- 'tests/frontend/specs/**/*',
- ],
- rules: {
- 'mocha/no-exports': 'off',
- 'mocha/no-top-level-hooks': 'off',
- },
- },
- ],
+ ],
+ excludedFiles: [
+ '**/.eslintrc.*',
+ 'tests/frontend/cypress/**/*',
+ 'tests/frontend/helper.js',
+ 'tests/frontend/helper/**/*',
+ 'tests/frontend/travis/**/*',
+ ],
+ extends: 'etherpad/tests/frontend',
+ overrides: [
+ {
+ files: [
+ 'tests/frontend/**/*',
+ ],
+ excludedFiles: [
+ 'tests/frontend/specs/**/*',
+ ],
+ rules: {
+ 'mocha/no-exports': 'off',
+ 'mocha/no-top-level-hooks': 'off',
+ },
+ },
+ ],
},
{
- files: [
- 'tests/frontend/cypress/**/*',
- ],
- extends: 'etherpad/tests/cypress',
+ files: [
+ 'tests/frontend/cypress/**/*',
+ ],
+ extends: 'etherpad/tests/cypress',
},
{
- files: [
- 'tests/frontend/travis/**/*',
- ],
- extends: 'etherpad/node',
+ files: [
+ 'tests/frontend/travis/**/*',
+ ],
+ extends: 'etherpad/node',
},
- ],
- root: true,
+];
+export const root = true;
+export default {
+ ignorePatterns,
+ overrides,
+ root
};
diff --git a/src/node/db/Pad.ts b/src/node/db/Pad.ts
index b894299c33e..b2bfc877b8c 100644
--- a/src/node/db/Pad.ts
+++ b/src/node/db/Pad.ts
@@ -4,7 +4,7 @@
*/
import AttributeMap from '../../static/js/AttributeMap';
-import {applyToAText, makeAText} from '../../static/js/Changeset';
+import {applyToAText, copyAText, makeAText} from '../../static/js/Changeset';
import ChatMessage from '../../static/js/ChatMessage';
import {AttributePool} from '../../static/js/AttributePool';
import {Stream} from '../utils/Stream';
diff --git a/src/node/handler/PadMessageHandler.ts b/src/node/handler/PadMessageHandler.ts
index edd97a703d5..07f939fa713 100644
--- a/src/node/handler/PadMessageHandler.ts
+++ b/src/node/handler/PadMessageHandler.ts
@@ -21,7 +21,7 @@
import AttributeMap from '../../static/js/AttributeMap';
import {getPad} from '../db/PadManager';
-import Changeset from '../../static/js/Changeset';
+import {} from '../../static/js/Changeset';
import ChatMessage from '../../static/js/ChatMessage';
import {AttributePool} from '../../static/js/AttributePool';
import AttributeManager from '../../static/js/AttributeManager';
@@ -797,6 +797,7 @@ const _correctMarkersInPad = (atext, apool) => {
return builder.toString();
};
+export let clientVars:any
/**
* Handles a CLIENT_READY. A CLIENT_READY is the first message from the client
* to the server. The Client sends his token
@@ -954,7 +955,7 @@ const handleClientReady = async (socket, message) => {
// Warning: never ever send sessionInfo.padId to the client. If the client is read only you
// would open a security hole 1 swedish mile wide...
- const clientVars = {
+ clientVars = {
skinName: skinName,
skinVariants: skinVariants,
randomVersionString: randomString(4),
diff --git a/src/static/js/Changeset.ts b/src/static/js/Changeset.js
similarity index 69%
rename from src/static/js/Changeset.ts
rename to src/static/js/Changeset.js
index e9f7dfc8d1b..614d820615c 100644
--- a/src/static/js/Changeset.ts
+++ b/src/static/js/Changeset.js
@@ -1,40 +1,13 @@
+import AttributeMap from "./AttributeMap.js";
+import AttributePool from "./AttributePool.js";
+import * as attributes from "./attributes.js";
+import { padutils } from "./pad_utils.js";
'use strict';
-
-/*
- * Copyright 2009 Google Inc., 2011 Peter 'Pita' Martischka (Primary Technology Ltd)
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS-IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/*
- * This is the Changeset library copied from the old Etherpad with some modifications
- * to use it in node.js. The original can be found at:
- * https://github.com/ether/pad/blob/master/infrastructure/ace/www/easysync2.js
- */
-
-import {CustomError} from "../../node/utils/customError";
-
-const AttributeMap = require('./AttributeMap');
-const AttributePool = require('./AttributePool');
-const attributes = require('./attributes');
-const {padutils} = require('./pad_utils');
-
/**
* A `[key, value]` pair of strings describing a text attribute.
*
* @typedef {[string, string]} Attribute
*/
-
/**
* A concatenated sequence of zero or more attribute identifiers, each one represented by an
* asterisk followed by a base-36 encoded attribute number.
@@ -43,18 +16,16 @@ const {padutils} = require('./pad_utils');
*
* @typedef {string} AttributeString
*/
-
/**
* This method is called whenever there is an error in the sync process.
*
* @param {string} msg - Just some message
*/
-export const error = (msg) => {
- const e = new CustomError(msg);
+const error = (msg) => {
+ const e = new Error(msg);
e.easysync = true;
throw e;
};
-
/**
* Assert that a condition is truthy. If the condition is falsy, the `error` function is called to
* throw an exception.
@@ -64,33 +35,13 @@ export const error = (msg) => {
* @type {(b: boolean, msg: string) => asserts b}
*/
const assert = (b, msg) => {
- if (!b) error(`Failed assertion: ${msg}`);
+ if (!b)
+ error(`Failed assertion: ${msg}`);
};
-
-/**
- * Parses a number from string base 36.
- *
- * @param {string} str - string of the number in base 36
- * @returns {number} number
- */
-export const parseNum = (str) => parseInt(str, 36);
-
-/**
- * Writes a number in base 36 and puts it in a string.
- *
- * @param {number} num - number
- * @returns {string} string
- */
-export const numToString = (num) => num.toString(36).toLowerCase();
-
/**
* An operation to apply to a shared document.
*/
class Op {
- opcode: string;
- chars: number;
- lines: number;
- attribs: string;
/**
* @param {(''|'='|'+'|'-')} [opcode=''] - Initial value of the `opcode` property.
*/
@@ -110,7 +61,6 @@ class Op {
* @public
*/
this.opcode = opcode;
-
/**
* The number of characters to keep, insert, or delete.
*
@@ -118,7 +68,6 @@ class Op {
* @public
*/
this.chars = 0;
-
/**
* The number of characters among the `chars` characters that are newlines. If non-zero, the
* last character must be a newline.
@@ -127,7 +76,6 @@ class Op {
* @public
*/
this.lines = 0;
-
/**
* Identifiers of attributes to apply to the text, represented as a repeated (zero or more)
* sequence of asterisk followed by a non-negative base-36 (lower-case) integer. For example,
@@ -148,66 +96,15 @@ class Op {
*/
this.attribs = '';
}
-
toString() {
- if (!this.opcode) throw new TypeError('null op');
- if (typeof this.attribs !== 'string') throw new TypeError('attribs must be a string');
- const l = this.lines ? `|${numToString(this.lines)}` : '';
- return this.attribs + l + this.opcode + numToString(this.chars);
+ if (!this.opcode)
+ throw new TypeError('null op');
+ if (typeof this.attribs !== 'string')
+ throw new TypeError('attribs must be a string');
+ const l = this.lines ? `|${exports.numToString(this.lines)}` : '';
+ return this.attribs + l + this.opcode + exports.numToString(this.chars);
}
}
-export const Op = Op;
-
-/**
- * Describes changes to apply to a document. Does not include the attribute pool or the original
- * document.
- *
- * @typedef {object} Changeset
- * @property {number} oldLen - The length of the base document.
- * @property {number} newLen - The length of the document after applying the changeset.
- * @property {string} ops - Serialized sequence of operations. Use `deserializeOps` to parse this
- * string.
- * @property {string} charBank - Characters inserted by insert operations.
- */
-
-/**
- * Returns the required length of the text before changeset can be applied.
- *
- * @param {string} cs - String representation of the Changeset
- * @returns {number} oldLen property
- */
-export const oldLen = (cs) => exports.unpack(cs).oldLen;
-
-/**
- * Returns the length of the text after changeset is applied.
- *
- * @param {string} cs - String representation of the Changeset
- * @returns {number} newLen property
- */
-export const newLen = (cs) => exports.unpack(cs).newLen;
-
-/**
- * Parses a string of serialized changeset operations.
- *
- * @param {string} ops - Serialized changeset operations.
- * @yields {Op}
- * @returns {Generator}
- */
-export const deserializeOps = function* (ops) {
- // TODO: Migrate to String.prototype.matchAll() once there is enough browser support.
- const regex = /((?:\*[0-9a-z]+)*)(?:\|([0-9a-z]+))?([-+=])([0-9a-z]+)|(.)/g;
- let match;
- while ((match = regex.exec(ops)) != null) {
- if (match[5] === '$') return; // Start of the insert operation character bank.
- if (match[5] != null) error(`invalid operation: ${ops.slice(regex.lastIndex - 1)}`);
- const op = new Op(match[3]);
- op.lines = parseNum(match[2] || '0');
- op.chars = parseNum(match[4]);
- op.attribs = match[1];
- yield op;
- }
-};
-
/**
* Iterator over a changeset's operations.
*
@@ -216,28 +113,19 @@ export const deserializeOps = function* (ops) {
* @deprecated Use `deserializeOps` instead.
*/
class OpIter {
- private _next: {
- value: any;
- done: boolean,
-
-
- };
- private _gen: any;
/**
* @param {string} ops - String encoding the change operations to iterate over.
*/
constructor(ops) {
- this._gen = deserializeOps(ops);
+ this._gen = exports.deserializeOps(ops);
this._next = this._gen.next();
}
-
/**
* @returns {boolean} Whether there are any remaining operations.
*/
hasNext() {
return !this._next.done;
}
-
/**
* Returns the next operation object and advances the iterator.
*
@@ -251,26 +139,13 @@ class OpIter {
if (this.hasNext()) {
copyOp(this._next.value, opOut);
this._next = this._gen.next();
- } else {
+ }
+ else {
clearOp(opOut);
}
return opOut;
}
}
-
-/**
- * Creates an iterator which decodes string changeset operations.
- *
- * @deprecated Use `deserializeOps` instead.
- * @param {string} opsStr - String encoding of the change operations to perform.
- * @returns {OpIter} Operator iterator object.
- */
-export const opIterator = (opsStr) => {
- padutils.warnDeprecated(
- 'Changeset.opIterator() is deprecated; use Changeset.deserializeOps() instead');
- return new OpIter(opsStr);
-};
-
/**
* Cleans an Op object.
*
@@ -282,19 +157,6 @@ const clearOp = (op) => {
op.lines = 0;
op.attribs = '';
};
-
-/**
- * Creates a new Op object
- *
- * @deprecated Use the `Op` class instead.
- * @param {('+'|'-'|'='|'')} [optOpcode=''] - The operation's operator.
- * @returns {Op}
- */
-export const newOp = (optOpcode) => {
- padutils.warnDeprecated('Changeset.newOp() is deprecated; use the Changeset.Op class instead');
- return new Op(optOpcode);
-};
-
/**
* Copies op1 to op2
*
@@ -303,7 +165,6 @@ export const newOp = (optOpcode) => {
* @returns {Op} `op2`
*/
const copyOp = (op1, op2 = new Op()) => Object.assign(op2, op1);
-
/**
* Serializes a sequence of Ops.
*
@@ -312,7 +173,6 @@ const copyOp = (op1, op2 = new Op()) => Object.assign(op2, op1);
* @property {Function} clear -
* @property {Function} toString -
*/
-
/**
* Efficiently merges consecutive operations that are mergeable, ignores no-ops, and drops final
* pure "keeps". It does not re-order operations.
@@ -323,7 +183,6 @@ const copyOp = (op1, op2 = new Op()) => Object.assign(op2, op1);
* @property {Function} endDocument -
* @property {Function} toString -
*/
-
/**
* Generates operations from the given text and attributes.
*
@@ -341,13 +200,14 @@ const copyOp = (op1, op2 = new Op()) => Object.assign(op2, op1);
const opsFromText = function* (opcode, text, attribs = '', pool = null) {
const op = new Op(opcode);
op.attribs = typeof attribs === 'string'
- ? attribs : new AttributeMap(pool).update(attribs || [], opcode === '+').toString();
+ ? attribs : new AttributeMap(pool).update(attribs || [], opcode === '+').toString();
const lastNewlinePos = text.lastIndexOf('\n');
if (lastNewlinePos < 0) {
op.chars = text.length;
op.lines = 0;
yield op;
- } else {
+ }
+ else {
op.chars = lastNewlinePos + 1;
op.lines = text.match(/\n/g).length;
yield op;
@@ -357,473 +217,120 @@ const opsFromText = function* (opcode, text, attribs = '', pool = null) {
yield op2;
}
};
-
/**
- * Creates an object that allows you to append operations (type Op) and also compresses them if
- * possible. Like MergingOpAssembler, but able to produce conforming exportss from slightly looser
- * input, at the cost of speed. Specifically:
- * - merges consecutive operations that can be merged
- * - strips final "="
- * - ignores 0-length changes
- * - reorders consecutive + and - (which MergingOpAssembler doesn't do)
- *
- * @typedef {object} SmartOpAssembler
- * @property {Function} append -
- * @property {Function} appendOpWithText -
- * @property {Function} clear -
- * @property {Function} endDocument -
- * @property {Function} getLengthChange -
- * @property {Function} toString -
+ * @typedef {object} StringArrayLike
+ * @property {(i: number) => string} get - Returns the line at index `i`.
+ * @property {(number|(() => number))} length - The number of lines, or a method that returns the
+ * number of lines.
+ * @property {(((start?: number, end?: number) => string[])|undefined)} slice - Like
+ * `Array.prototype.slice()`. Optional if the return value of the `removeLines` method is not
+ * needed.
+ * @property {(i: number, d?: number, ...l: string[]) => any} splice - Like
+ * `Array.prototype.splice()`.
*/
-
/**
- * Used to check if a Changeset is valid. This function does not check things that require access to
- * the attribute pool (e.g., attribute order) or original text (e.g., newline positions).
+ * Class to iterate and modify texts which have several lines. It is used for applying Changesets on
+ * arrays of lines.
*
- * @param {string} cs - Changeset to check
- * @returns {string} the checked Changeset
+ * Mutation operations have the same constraints as exports operations with respect to newlines, but
+ * not the other additional constraints (i.e. ins/del ordering, forbidden no-ops, non-mergeability,
+ * final newline). Can be used to mutate lists of strings where the last char of each string is not
+ * actually a newline, but for the purposes of N and L values, the caller should pretend it is, and
+ * for things to work right in that case, the input to the `insert` method should be a single line
+ * with no newlines.
*/
-export const checkRep = (cs) => {
- const unpacked = unpack(cs);
- const oldLen = unpacked.oldLen;
- const newLen = unpacked.newLen;
- const ops = unpacked.ops;
- let charBank = unpacked.charBank;
-
- const assem = smartOpAssembler();
- let oldPos = 0;
- let calcNewLen = 0;
- for (const o of deserializeOps(ops)) {
- switch (o.opcode) {
- case '=':
- oldPos += o.chars;
- calcNewLen += o.chars;
- break;
- case '-':
- oldPos += o.chars;
- assert(oldPos <= oldLen, `${oldPos} > ${oldLen} in ${cs}`);
- break;
- case '+':
- {
- assert(charBank.length >= o.chars, 'Invalid changeset: not enough chars in charBank');
- const chars = charBank.slice(0, o.chars);
- const nlines = (chars.match(/\n/g) || []).length;
- assert(nlines === o.lines,
- 'Invalid changeset: number of newlines in insert op does not match the charBank');
- assert(o.lines === 0 || chars.endsWith('\n'),
- 'Invalid changeset: multiline insert op does not end with a newline');
- charBank = charBank.slice(o.chars);
- calcNewLen += o.chars;
- assert(calcNewLen <= newLen, `${calcNewLen} > ${newLen} in ${cs}`);
- break;
- }
- default:
- assert(false, `Invalid changeset: Unknown opcode: ${JSON.stringify(o.opcode)}`);
+class TextLinesMutator {
+ /**
+ * @param {(string[]|StringArrayLike)} lines - Lines to mutate (in place).
+ */
+ constructor(lines) {
+ this._lines = lines;
+ /**
+ * this._curSplice holds values that will be passed as arguments to this._lines.splice() to
+ * insert, delete, or change lines:
+ * - this._curSplice[0] is an index into the this._lines array.
+ * - this._curSplice[1] is the number of lines that will be removed from the this._lines array
+ * starting at the index.
+ * - The other elements represent mutated (changed by ops) lines or new lines (added by ops)
+ * to insert at the index.
+ *
+ * @type {[number, number?, ...string[]?]}
+ */
+ this._curSplice = [0, 0];
+ this._inSplice = false;
+ // position in lines after curSplice is applied:
+ this._curLine = 0;
+ this._curCol = 0;
+ // invariant: if (inSplice) then (curLine is in curSplice[0] + curSplice.length - {2,3}) &&
+ // curLine >= curSplice[0]
+ // invariant: if (inSplice && (curLine >= curSplice[0] + curSplice.length - 2)) then
+ // curCol == 0
+ }
+ /**
+ * Get a line from `lines` at given index.
+ *
+ * @param {number} idx - an index
+ * @returns {string}
+ */
+ _linesGet(idx) {
+ if ('get' in this._lines) {
+ return this._lines.get(idx);
+ }
+ else {
+ return this._lines[idx];
}
- assem.append(o);
}
- calcNewLen += oldLen - oldPos;
- assert(calcNewLen === newLen, 'Invalid changeset: claimed length does not match actual length');
- assert(charBank === '', 'Invalid changeset: excess characters in the charBank');
- assem.endDocument();
- const normalized = pack(oldLen, calcNewLen, assem.toString(), unpacked.charBank);
- assert(normalized === cs, 'Invalid changeset: not in canonical form');
- return cs;
-};
-
-/**
- * @returns {SmartOpAssembler}
- */
-export const smartOpAssembler = () => {
- const minusAssem = mergingOpAssembler();
- const plusAssem = mergingOpAssembler();
- const keepAssem = mergingOpAssembler();
- const assem = stringAssembler();
- let lastOpcode = '';
- let lengthChange = 0;
-
- const flushKeeps = () => {
- assem.append(keepAssem.toString());
- keepAssem.clear();
- };
-
- const flushPlusMinus = () => {
- assem.append(minusAssem.toString());
- minusAssem.clear();
- assem.append(plusAssem.toString());
- plusAssem.clear();
- };
-
- const append = (op) => {
- if (!op.opcode) return;
- if (!op.chars) return;
-
- if (op.opcode === '-') {
- if (lastOpcode === '=') {
- flushKeeps();
- }
- minusAssem.append(op);
- lengthChange -= op.chars;
- } else if (op.opcode === '+') {
- if (lastOpcode === '=') {
- flushKeeps();
- }
- plusAssem.append(op);
- lengthChange += op.chars;
- } else if (op.opcode === '=') {
- if (lastOpcode !== '=') {
- flushPlusMinus();
- }
- keepAssem.append(op);
+ /**
+ * Return a slice from `lines`.
+ *
+ * @param {number} start - the start index
+ * @param {number} end - the end index
+ * @returns {string[]}
+ */
+ _linesSlice(start, end) {
+ // can be unimplemented if removeLines's return value not needed
+ if (this._lines.slice) {
+ return this._lines.slice(start, end);
}
- lastOpcode = op.opcode;
- };
-
+ else {
+ return [];
+ }
+ }
/**
- * Generates operations from the given text and attributes.
+ * Return the length of `lines`.
*
- * @deprecated Use `opsFromText` instead.
- * @param {('-'|'+'|'=')} opcode - The operator to use.
- * @param {string} text - The text to remove/add/keep.
- * @param {(string|Iterable)} attribs - The attributes to apply to the operations.
- * @param {?AttributePool} pool - Attribute pool. Only required if `attribs` is an iterable of
- * attribute key, value pairs.
+ * @returns {number}
*/
- const appendOpWithText = (opcode, text, attribs, pool) => {
- padutils.warnDeprecated('Changeset.smartOpAssembler().appendOpWithText() is deprecated; ' +
- 'use opsFromText() instead.');
- for (const op of opsFromText(opcode, text, attribs, pool)) append(op);
- };
-
- const toString = () => {
- flushPlusMinus();
- flushKeeps();
- return assem.toString();
- };
-
- const clear = () => {
- minusAssem.clear();
- plusAssem.clear();
- keepAssem.clear();
- assem.clear();
- lengthChange = 0;
- };
-
- const endDocument = () => {
- keepAssem.endDocument();
- };
-
- const getLengthChange = () => lengthChange;
-
- return {
- append,
- toString,
- clear,
- endDocument,
- appendOpWithText,
- getLengthChange,
- };
-};
-
-/**
- * @returns {MergingOpAssembler}
- */
-export const mergingOpAssembler = () => {
- const assem = opAssembler();
- const bufOp = new Op();
-
- // If we get, for example, insertions [xxx\n,yyy], those don't merge,
- // but if we get [xxx\n,yyy,zzz\n], that merges to [xxx\nyyyzzz\n].
- // This variable stores the length of yyy and any other newline-less
- // ops immediately after it.
- let bufOpAdditionalCharsAfterNewline = 0;
-
+ _linesLength() {
+ if (typeof this._lines.length === 'number') {
+ return this._lines.length;
+ }
+ else {
+ return this._lines.length();
+ }
+ }
/**
- * @param {boolean} [isEndDocument]
- */
- const flush = (isEndDocument?: boolean) => {
- if (!bufOp.opcode) return;
- if (isEndDocument && bufOp.opcode === '=' && !bufOp.attribs) {
- // final merged keep, leave it implicit
- } else {
- assem.append(bufOp);
- if (bufOpAdditionalCharsAfterNewline) {
- bufOp.chars = bufOpAdditionalCharsAfterNewline;
- bufOp.lines = 0;
- assem.append(bufOp);
- bufOpAdditionalCharsAfterNewline = 0;
- }
- }
- bufOp.opcode = '';
- };
-
- const append = (op) => {
- if (op.chars <= 0) return;
- if (bufOp.opcode === op.opcode && bufOp.attribs === op.attribs) {
- if (op.lines > 0) {
- // bufOp and additional chars are all mergeable into a multi-line op
- bufOp.chars += bufOpAdditionalCharsAfterNewline + op.chars;
- bufOp.lines += op.lines;
- bufOpAdditionalCharsAfterNewline = 0;
- } else if (bufOp.lines === 0) {
- // both bufOp and op are in-line
- bufOp.chars += op.chars;
- } else {
- // append in-line text to multi-line bufOp
- bufOpAdditionalCharsAfterNewline += op.chars;
- }
- } else {
- flush();
- copyOp(op, bufOp);
- }
- };
-
- const endDocument = () => {
- flush(true);
- };
-
- const toString = () => {
- flush();
- return assem.toString();
- };
-
- const clear = () => {
- assem.clear();
- clearOp(bufOp);
- };
- return {
- append,
- toString,
- clear,
- endDocument,
- };
-};
-
-/**
- * @returns {OpAssembler}
- */
-export const opAssembler = () => {
- let serialized = '';
-
- /**
- * @param {Op} op - Operation to add. Ownership remains with the caller.
- */
- const append = (op) => {
- assert(op instanceof Op, 'argument must be an instance of Op');
- serialized += op.toString();
- };
-
- const toString = () => serialized;
-
- const clear = () => {
- serialized = '';
- };
- return {
- append,
- toString,
- clear,
- };
-};
-
-/**
- * A custom made String Iterator
- *
- * @typedef {object} StringIterator
- * @property {Function} newlines -
- * @property {Function} peek -
- * @property {Function} remaining -
- * @property {Function} skip -
- * @property {Function} take -
- */
-
-/**
- * @param {string} str - String to iterate over
- * @returns {StringIterator}
- */
-export const stringIterator = (str) => {
- let curIndex = 0;
- // newLines is the number of \n between curIndex and str.length
- let newLines = str.split('\n').length - 1;
- const getnewLines = () => newLines;
-
- const assertRemaining = (n) => {
- assert(n <= remaining(), `!(${n} <= ${remaining()})`);
- };
-
- const take = (n) => {
- assertRemaining(n);
- const s = str.substr(curIndex, n);
- newLines -= s.split('\n').length - 1;
- curIndex += n;
- return s;
- };
-
- const peek = (n) => {
- assertRemaining(n);
- const s = str.substr(curIndex, n);
- return s;
- };
-
- const skip = (n) => {
- assertRemaining(n);
- curIndex += n;
- };
-
- const remaining = () => str.length - curIndex;
- return {
- take,
- skip,
- remaining,
- peek,
- newlines: getnewLines,
- };
-};
-
-/**
- * A custom made StringBuffer
- *
- * @typedef {object} StringAssembler
- * @property {Function} append -
- * @property {Function} toString -
- */
-
-/**
- * @returns {StringAssembler}
- */
-export const stringAssembler = () => ({
- _str: '',
- clear() { this._str = ''; },
- /**
- * @param {string} x -
- */
- append(x) { this._str += String(x); },
- toString() { return this._str; },
-});
-
-/**
- * @typedef {object} StringArrayLike
- * @property {(i: number) => string} get - Returns the line at index `i`.
- * @property {(number|(() => number))} length - The number of lines, or a method that returns the
- * number of lines.
- * @property {(((start?: number, end?: number) => string[])|undefined)} slice - Like
- * `Array.prototype.slice()`. Optional if the return value of the `removeLines` method is not
- * needed.
- * @property {(i: number, d?: number, ...l: string[]) => any} splice - Like
- * `Array.prototype.splice()`.
- */
-
-/**
- * Class to iterate and modify texts which have several lines. It is used for applying Changesets on
- * arrays of lines.
- *
- * Mutation operations have the same constraints as exports operations with respect to newlines, but
- * not the other additional constraints (i.e. ins/del ordering, forbidden no-ops, non-mergeability,
- * final newline). Can be used to mutate lists of strings where the last char of each string is not
- * actually a newline, but for the purposes of N and L values, the caller should pretend it is, and
- * for things to work right in that case, the input to the `insert` method should be a single line
- * with no newlines.
- */
-class TextLinesMutator {
- private _lines: any;
- private _curSplice: number[]|{[key: string]:any};
- private _inSplice: boolean;
- private _curLine: number;
- private _curCol: number;
- /**
- * @param {(string[]|StringArrayLike)} lines - Lines to mutate (in place).
- */
- constructor(lines) {
- this._lines = lines;
- /**
- * this._curSplice holds values that will be passed as arguments to this._lines.splice() to
- * insert, delete, or change lines:
- * - this._curSplice[0] is an index into the this._lines array.
- * - this._curSplice[1] is the number of lines that will be removed from the this._lines array
- * starting at the index.
- * - The other elements represent mutated (changed by ops) lines or new lines (added by ops)
- * to insert at the index.
- *
- * @type {[number, number?, ...string[]?]}
- */
- this._curSplice = [0, 0];
- this._inSplice = false;
- // position in lines after curSplice is applied:
- this._curLine = 0;
- this._curCol = 0;
- // invariant: if (inSplice) then (curLine is in curSplice[0] + curSplice.length - {2,3}) &&
- // curLine >= curSplice[0]
- // invariant: if (inSplice && (curLine >= curSplice[0] + curSplice.length - 2)) then
- // curCol == 0
- }
-
- /**
- * Get a line from `lines` at given index.
- *
- * @param {number} idx - an index
- * @returns {string}
- */
- _linesGet(idx) {
- if ('get' in this._lines) {
- return this._lines.get(idx);
- } else {
- return this._lines[idx];
- }
- }
-
- /**
- * Return a slice from `lines`.
- *
- * @param {number} start - the start index
- * @param {number} end - the end index
- * @returns {string[]}
- */
- _linesSlice(start, end) {
- // can be unimplemented if removeLines's return value not needed
- if (this._lines.slice) {
- return this._lines.slice(start, end);
- } else {
- return [];
- }
- }
-
- /**
- * Return the length of `lines`.
- *
- * @returns {number}
- */
- _linesLength() {
- if (typeof this._lines.length === 'number') {
- return this._lines.length;
- } else {
- return this._lines.length();
- }
- }
-
- /**
- * Starts a new splice.
+ * Starts a new splice.
*/
_enterSplice() {
this._curSplice[0] = this._curLine;
this._curSplice[1] = 0;
// TODO(doc) when is this the case?
// check all enterSplice calls and changes to curCol
- if (this._curCol > 0) this._putCurLineInSplice();
+ if (this._curCol > 0)
+ this._putCurLineInSplice();
this._inSplice = true;
}
-
/**
* Changes the lines array according to the values in curSplice and resets curSplice. Called via
* close or TODO(doc).
*/
_leaveSplice() {
- if(this._curSplice instanceof Array) {
- this._lines.splice(...this._curSplice);
- this._curSplice.length = 2;
- this._curSplice[0] = this._curSplice[1] = 0;
- this._inSplice = false;
- }
+ this._lines.splice(...this._curSplice);
+ this._curSplice.length = 2;
+ this._curSplice[0] = this._curSplice[1] = 0;
+ this._inSplice = false;
}
-
/**
* Indicates if curLine is already in the splice. This is necessary because the last element in
* curSplice is curLine when this line is currently worked on (e.g. when skipping or inserting).
@@ -836,7 +343,6 @@ class TextLinesMutator {
// are deleted).
return this._curLine - this._curSplice[0] < this._curSplice.length - 2;
}
-
/**
* Incorporates current line into the splice and marks its old position to be deleted.
*
@@ -850,29 +356,32 @@ class TextLinesMutator {
// TODO should be the same as this._curSplice.length - 1
return 2 + this._curLine - this._curSplice[0];
}
-
/**
* It will skip some newlines by putting them into the splice.
*
* @param {number} L -
* @param {boolean} includeInSplice - Indicates that attributes are present.
*/
- skipLines(L, includeInSplice?:boolean) {
- if (!L) return;
+ skipLines(L, includeInSplice) {
+ if (!L)
+ return;
if (includeInSplice) {
- if (!this._inSplice) this._enterSplice();
+ if (!this._inSplice)
+ this._enterSplice();
// TODO(doc) should this count the number of characters that are skipped to check?
for (let i = 0; i < L; i++) {
this._curCol = 0;
this._putCurLineInSplice();
this._curLine++;
}
- } else {
+ }
+ else {
if (this._inSplice) {
if (L > 1) {
// TODO(doc) figure out why single lines are incorporated into splice instead of ignored
this._leaveSplice();
- } else {
+ }
+ else {
this._putCurLineInSplice();
}
}
@@ -881,7 +390,6 @@ class TextLinesMutator {
}
// tests case foo in remove(), which isn't otherwise covered in current impl
}
-
/**
* Skip some characters. Can contain newlines.
*
@@ -890,11 +398,14 @@ class TextLinesMutator {
* @param {boolean} includeInSplice - indicates if attributes are present
*/
skip(N, L, includeInSplice) {
- if (!N) return;
+ if (!N)
+ return;
if (L) {
this.skipLines(L, includeInSplice);
- } else {
- if (includeInSplice && !this._inSplice) this._enterSplice();
+ }
+ else {
+ if (includeInSplice && !this._inSplice)
+ this._enterSplice();
if (this._inSplice) {
// although the line is put into splice curLine is not increased, because
// only some chars are skipped, not the whole line
@@ -903,7 +414,6 @@ class TextLinesMutator {
this._curCol += N;
}
}
-
/**
* Remove whole lines from lines array.
*
@@ -911,9 +421,10 @@ class TextLinesMutator {
* @returns {string}
*/
removeLines(L) {
- if (!L) return '';
- if (!this._inSplice) this._enterSplice();
-
+ if (!L)
+ return '';
+ if (!this._inSplice)
+ this._enterSplice();
/**
* Gets a string of joined lines after the end of the splice.
*
@@ -924,15 +435,15 @@ class TextLinesMutator {
const m = this._curSplice[0] + this._curSplice[1];
return this._linesSlice(m, m + k).join('');
};
-
- let removed:string|number = '';
+ let removed = '';
if (this._isCurLineInSplice()) {
if (this._curCol === 0) {
removed = this._curSplice[this._curSplice.length - 1];
this._curSplice.length--;
removed += nextKLinesText(L - 1);
this._curSplice[1] += L - 1;
- } else {
+ }
+ else {
removed = nextKLinesText(L - 1);
this._curSplice[1] += L - 1;
const sline = this._curSplice.length - 1;
@@ -941,13 +452,13 @@ class TextLinesMutator {
this._linesGet(this._curSplice[0] + this._curSplice[1]);
this._curSplice[1] += 1;
}
- } else {
+ }
+ else {
removed = nextKLinesText(L);
this._curSplice[1] += L;
}
return removed;
}
-
/**
* Remove text from lines array.
*
@@ -956,9 +467,12 @@ class TextLinesMutator {
* @returns {string}
*/
remove(N, L) {
- if (!N) return '';
- if (L) return this.removeLines(L);
- if (!this._inSplice) this._enterSplice();
+ if (!N)
+ return '';
+ if (L)
+ return this.removeLines(L);
+ if (!this._inSplice)
+ this._enterSplice();
// although the line is put into splice, curLine is not increased, because
// only some chars are removed not the whole line
const sline = this._putCurLineInSplice();
@@ -967,7 +481,6 @@ class TextLinesMutator {
this._curSplice[sline].substring(this._curCol + N);
return removed;
}
-
/**
* Inserts text into lines array.
*
@@ -975,10 +488,12 @@ class TextLinesMutator {
* @param {number} L - number of newlines in text
*/
insert(text, L) {
- if (!text) return;
- if (!this._inSplice) this._enterSplice();
+ if (!text)
+ return;
+ if (!this._inSplice)
+ this._enterSplice();
if (L) {
- const newLines = splitTextLines(text);
+ const newLines = exports.splitTextLines(text);
if (this._isCurLineInSplice()) {
const sline = this._curSplice.length - 1;
/** @type {string} */
@@ -995,17 +510,18 @@ class TextLinesMutator {
// when we started to insert new lines)
this._curSplice.push(theLine.substring(lineCol));
this._curCol = 0; // TODO(doc) why is this not set to the length of last line?
- } else {
+ }
+ else {
this._curSplice.push(...newLines);
this._curLine += newLines.length;
}
- } else {
+ }
+ else {
// There are no additional lines. Although the line is put into splice, curLine is not
// increased because there may be more chars in the line (newline is not reached).
const sline = this._putCurLineInSplice();
if (!this._curSplice[sline]) {
- const err = new Error(
- 'curSplice[sline] not populated, actual curSplice contents is ' +
+ const err = new Error('curSplice[sline] not populated, actual curSplice contents is ' +
`${JSON.stringify(this._curSplice)}. Possibly related to ` +
'https://github.com/ether/etherpad-lite/issues/2802');
console.error(err.stack || err.toString());
@@ -1015,7 +531,6 @@ class TextLinesMutator {
this._curCol += text.length;
}
}
-
/**
* Checks if curLine (the line we are in when curSplice is applied) is the last line in `lines`.
*
@@ -1028,15 +543,14 @@ class TextLinesMutator {
}
return this._curLine < docLines;
}
-
/**
* Closes the splice
*/
close() {
- if (this._inSplice) this._leaveSplice();
+ if (this._inSplice)
+ this._leaveSplice();
}
}
-
/**
* Apply operations to other operations.
*
@@ -1059,101 +573,514 @@ class TextLinesMutator {
* @returns {string} the integrated changeset
*/
const applyZip = (in1, in2, func) => {
- const ops1 = deserializeOps(in1);
- const ops2 = deserializeOps(in2);
+ const ops1 = exports.deserializeOps(in1);
+ const ops2 = exports.deserializeOps(in2);
let next1 = ops1.next();
let next2 = ops2.next();
- const assem = smartOpAssembler();
+ const assem = exports.smartOpAssembler();
while (!next1.done || !next2.done) {
- if (!next1.done && !next1.value.opcode) next1 = ops1.next();
- if (!next2.done && !next2.value.opcode) next2 = ops2.next();
- if (next1.value == null) next1.value = new Op();
- if (next2.value == null) next2.value = new Op();
- if (!next1.value.opcode && !next2.value.opcode) break;
+ if (!next1.done && !next1.value.opcode)
+ next1 = ops1.next();
+ if (!next2.done && !next2.value.opcode)
+ next2 = ops2.next();
+ if (next1.value == null)
+ next1.value = new Op();
+ if (next2.value == null)
+ next2.value = new Op();
+ if (!next1.value.opcode && !next2.value.opcode)
+ break;
const opOut = func(next1.value, next2.value);
- if (opOut && opOut.opcode) assem.append(opOut);
+ if (opOut && opOut.opcode)
+ assem.append(opOut);
}
assem.endDocument();
return assem.toString();
};
-
-/**
- * Parses an encoded changeset.
- *
- * @param {string} cs - The encoded changeset.
- * @returns {Changeset}
- */
-export const unpack = (cs) => {
- const headerRegex = /Z:([0-9a-z]+)([><])([0-9a-z]+)|/;
- const headerMatch = headerRegex.exec(cs);
- if ((!headerMatch) || (!headerMatch[0])) error(`Not a changeset: ${cs}`);
- const oldLen = parseNum(headerMatch[1]);
- const changeSign = (headerMatch[2] === '>') ? 1 : -1;
- const changeMag = parseNum(headerMatch[3]);
- const newLen = oldLen + changeSign * changeMag;
- const opsStart = headerMatch[0].length;
- let opsEnd = cs.indexOf('$');
- if (opsEnd < 0) opsEnd = cs.length;
- return {
- oldLen,
- newLen,
- ops: cs.substring(opsStart, opsEnd),
- charBank: cs.substring(opsEnd + 1),
- };
-};
-
-/**
- * Creates an encoded changeset.
- *
- * @param {number} oldLen - The length of the document before applying the changeset.
- * @param {number} newLen - The length of the document after applying the changeset.
- * @param {string} opsStr - Encoded operations to apply to the document.
- * @param {string} bank - Characters for insert operations.
- * @returns {string} The encoded changeset.
- */
-export const pack = (oldLen, newLen, opsStr, bank) => {
- const lenDiff = newLen - oldLen;
- const lenDiffStr = (lenDiff >= 0 ? `>${numToString(lenDiff)}`
- : `<${numToString(-lenDiff)}`);
- const a = [];
- a.push('Z:', numToString(oldLen), lenDiffStr, opsStr, '$', bank);
- return a.join('');
-};
-
/**
- * Applies a Changeset to a string.
+ * Function used as parameter for applyZip to apply a Changeset to an attribute.
*
- * @param {string} cs - String encoded Changeset
- * @param {string} str - String to which a Changeset should be applied
- * @returns {string}
+ * @param {Op} attOp - The op from the sequence that is being operated on, either an attribution
+ * string or the earlier of two exportss being composed.
+ * @param {Op} csOp -
+ * @param {AttributePool} pool - Can be null if definitely not needed.
+ * @returns {Op} The result of applying `csOp` to `attOp`.
*/
-export const applyToText = (cs, str) => {
- const unpacked = unpack(cs);
- assert(str.length === unpacked.oldLen, `mismatched apply: ${str.length} / ${unpacked.oldLen}`);
- const bankIter = stringIterator(unpacked.charBank);
- const strIter = stringIterator(str);
- const assem = stringAssembler();
- for (const op of deserializeOps(unpacked.ops)) {
- switch (op.opcode) {
- case '+':
- // op is + and op.lines 0: no newlines must be in op.chars
- // op is + and op.lines >0: op.chars must include op.lines newlines
- if (op.lines !== bankIter.peek(op.chars).split('\n').length - 1) {
- throw new Error(`newline count is wrong in op +; cs:${cs} and text:${str}`);
+const slicerZipperFunc = (attOp, csOp, pool) => {
+ const opOut = new Op();
+ if (!attOp.opcode) {
+ copyOp(csOp, opOut);
+ csOp.opcode = '';
+ }
+ else if (!csOp.opcode) {
+ copyOp(attOp, opOut);
+ attOp.opcode = '';
+ }
+ else if (attOp.opcode === '-') {
+ copyOp(attOp, opOut);
+ attOp.opcode = '';
+ }
+ else if (csOp.opcode === '+') {
+ copyOp(csOp, opOut);
+ csOp.opcode = '';
+ }
+ else {
+ for (const op of [attOp, csOp]) {
+ assert(op.chars >= op.lines, `op has more newlines than chars: ${op.toString()}`);
+ }
+ assert(attOp.chars < csOp.chars ? attOp.lines <= csOp.lines
+ : attOp.chars > csOp.chars ? attOp.lines >= csOp.lines
+ : attOp.lines === csOp.lines, 'line count mismatch when composing changesets A*B; ' +
+ `opA: ${attOp.toString()} opB: ${csOp.toString()}`);
+ assert(['+', '='].includes(attOp.opcode), `unexpected opcode in op: ${attOp.toString()}`);
+ assert(['-', '='].includes(csOp.opcode), `unexpected opcode in op: ${csOp.toString()}`);
+ opOut.opcode = {
+ '+': {
+ '-': '',
+ '=': '+',
+ },
+ '=': {
+ '-': '-',
+ '=': '=',
+ },
+ }[attOp.opcode][csOp.opcode];
+ const [fullyConsumedOp, partiallyConsumedOp] = [attOp, csOp].sort((a, b) => a.chars - b.chars);
+ opOut.chars = fullyConsumedOp.chars;
+ opOut.lines = fullyConsumedOp.lines;
+ opOut.attribs = csOp.opcode === '-'
+ // csOp is a remove op and remove ops normally never have any attributes, so this should
+ // normally be the empty string. However, padDiff.js adds attributes to remove ops and needs
+ // them preserved so they are copied here.
+ ? csOp.attribs
+ : exports.composeAttributes(attOp.attribs, csOp.attribs, attOp.opcode === '=', pool);
+ partiallyConsumedOp.chars -= fullyConsumedOp.chars;
+ partiallyConsumedOp.lines -= fullyConsumedOp.lines;
+ if (!partiallyConsumedOp.chars)
+ partiallyConsumedOp.opcode = '';
+ fullyConsumedOp.opcode = '';
+ }
+ return opOut;
+};
+/**
+ * Transforms a changeset into a list of splices in the form [startChar, endChar, newText] meaning
+ * replace text from startChar to endChar with newText.
+ *
+ * @param {string} cs - Changeset
+ * @returns {[number, number, string][]}
+ */
+const toSplices = (cs) => {
+ const unpacked = exports.unpack(cs);
+ /** @type {[number, number, string][]} */
+ const splices = [];
+ let oldPos = 0;
+ const charIter = exports.stringIterator(unpacked.charBank);
+ let inSplice = false;
+ for (const op of exports.deserializeOps(unpacked.ops)) {
+ if (op.opcode === '=') {
+ oldPos += op.chars;
+ inSplice = false;
+ }
+ else {
+ if (!inSplice) {
+ splices.push([oldPos, oldPos, '']);
+ inSplice = true;
+ }
+ if (op.opcode === '-') {
+ oldPos += op.chars;
+ splices[splices.length - 1][1] += op.chars;
+ }
+ else if (op.opcode === '+') {
+ splices[splices.length - 1][2] += charIter.take(op.chars);
+ }
+ }
+ }
+ return splices;
+};
+/**
+ * @deprecated Use an AttributeMap instead.
+ */
+const attribsAttributeValue = (attribs, key, pool) => {
+ if (!attribs)
+ return '';
+ for (const [k, v] of attributes.attribsFromString(attribs, pool)) {
+ if (k === key)
+ return v;
+ }
+ return '';
+};
+const followAttributes = (att1, att2, pool) => {
+ // The merge of two sets of attribute changes to the same text
+ // takes the lexically-earlier value if there are two values
+ // for the same key. Otherwise, all key/value changes from
+ // both attribute sets are taken. This operation is the "follow",
+ // so a set of changes is produced that can be applied to att1
+ // to produce the merged set.
+ if ((!att2) || (!pool))
+ return '';
+ if (!att1)
+ return att2;
+ const atts = new Map();
+ att2.replace(/\*([0-9a-z]+)/g, (_, a) => {
+ const [key, val] = pool.getAttrib(exports.parseNum(a));
+ atts.set(key, val);
+ return '';
+ });
+ att1.replace(/\*([0-9a-z]+)/g, (_, a) => {
+ const [key, val] = pool.getAttrib(exports.parseNum(a));
+ if (atts.has(key) && val <= atts.get(key))
+ atts.delete(key);
+ return '';
+ });
+ // we've only removed attributes, so they're already sorted
+ const buf = exports.stringAssembler();
+ for (const att of atts) {
+ buf.append('*');
+ buf.append(exports.numToString(pool.putAttrib(att)));
+ }
+ return buf.toString();
+};
+export const parseNum = (str) => parseInt(str, 36);
+export const numToString = (num) => num.toString(36).toLowerCase();
+export const oldLen = (cs) => exports.unpack(cs).oldLen;
+export const newLen = (cs) => exports.unpack(cs).newLen;
+export const deserializeOps = function* (ops) {
+ // TODO: Migrate to String.prototype.matchAll() once there is enough browser support.
+ const regex = /((?:\*[0-9a-z]+)*)(?:\|([0-9a-z]+))?([-+=])([0-9a-z]+)|(.)/g;
+ let match;
+ while ((match = regex.exec(ops)) != null) {
+ if (match[5] === '$')
+ return; // Start of the insert operation character bank.
+ if (match[5] != null)
+ error(`invalid operation: ${ops.slice(regex.lastIndex - 1)}`);
+ const op = new Op(match[3]);
+ op.lines = exports.parseNum(match[2] || '0');
+ op.chars = exports.parseNum(match[4]);
+ op.attribs = match[1];
+ yield op;
+ }
+};
+export const opIterator = (opsStr) => {
+ padutils.warnDeprecated('Changeset.opIterator() is deprecated; use Changeset.deserializeOps() instead');
+ return new OpIter(opsStr);
+};
+export const newOp = (optOpcode) => {
+ padutils.warnDeprecated('Changeset.newOp() is deprecated; use the Changeset.Op class instead');
+ return new Op(optOpcode);
+};
+export const checkRep = (cs) => {
+ const unpacked = exports.unpack(cs);
+ const oldLen = unpacked.oldLen;
+ const newLen = unpacked.newLen;
+ const ops = unpacked.ops;
+ let charBank = unpacked.charBank;
+ const assem = exports.smartOpAssembler();
+ let oldPos = 0;
+ let calcNewLen = 0;
+ for (const o of exports.deserializeOps(ops)) {
+ switch (o.opcode) {
+ case '=':
+ oldPos += o.chars;
+ calcNewLen += o.chars;
+ break;
+ case '-':
+ oldPos += o.chars;
+ assert(oldPos <= oldLen, `${oldPos} > ${oldLen} in ${cs}`);
+ break;
+ case '+':
+ {
+ assert(charBank.length >= o.chars, 'Invalid changeset: not enough chars in charBank');
+ const chars = charBank.slice(0, o.chars);
+ const nlines = (chars.match(/\n/g) || []).length;
+ assert(nlines === o.lines, 'Invalid changeset: number of newlines in insert op does not match the charBank');
+ assert(o.lines === 0 || chars.endsWith('\n'), 'Invalid changeset: multiline insert op does not end with a newline');
+ charBank = charBank.slice(o.chars);
+ calcNewLen += o.chars;
+ assert(calcNewLen <= newLen, `${calcNewLen} > ${newLen} in ${cs}`);
+ break;
+ }
+ default:
+ assert(false, `Invalid changeset: Unknown opcode: ${JSON.stringify(o.opcode)}`);
+ }
+ assem.append(o);
+ }
+ calcNewLen += oldLen - oldPos;
+ assert(calcNewLen === newLen, 'Invalid changeset: claimed length does not match actual length');
+ assert(charBank === '', 'Invalid changeset: excess characters in the charBank');
+ assem.endDocument();
+ const normalized = exports.pack(oldLen, calcNewLen, assem.toString(), unpacked.charBank);
+ assert(normalized === cs, 'Invalid changeset: not in canonical form');
+ return cs;
+};
+export const smartOpAssembler = () => {
+ const minusAssem = exports.mergingOpAssembler();
+ const plusAssem = exports.mergingOpAssembler();
+ const keepAssem = exports.mergingOpAssembler();
+ const assem = exports.stringAssembler();
+ let lastOpcode = '';
+ let lengthChange = 0;
+ const flushKeeps = () => {
+ assem.append(keepAssem.toString());
+ keepAssem.clear();
+ };
+ const flushPlusMinus = () => {
+ assem.append(minusAssem.toString());
+ minusAssem.clear();
+ assem.append(plusAssem.toString());
+ plusAssem.clear();
+ };
+ const append = (op) => {
+ if (!op.opcode)
+ return;
+ if (!op.chars)
+ return;
+ if (op.opcode === '-') {
+ if (lastOpcode === '=') {
+ flushKeeps();
+ }
+ minusAssem.append(op);
+ lengthChange -= op.chars;
+ }
+ else if (op.opcode === '+') {
+ if (lastOpcode === '=') {
+ flushKeeps();
+ }
+ plusAssem.append(op);
+ lengthChange += op.chars;
+ }
+ else if (op.opcode === '=') {
+ if (lastOpcode !== '=') {
+ flushPlusMinus();
+ }
+ keepAssem.append(op);
+ }
+ lastOpcode = op.opcode;
+ };
+ /**
+ * Generates operations from the given text and attributes.
+ *
+ * @deprecated Use `opsFromText` instead.
+ * @param {('-'|'+'|'=')} opcode - The operator to use.
+ * @param {string} text - The text to remove/add/keep.
+ * @param {(string|Iterable)} attribs - The attributes to apply to the operations.
+ * @param {?AttributePool} pool - Attribute pool. Only required if `attribs` is an iterable of
+ * attribute key, value pairs.
+ */
+ const appendOpWithText = (opcode, text, attribs, pool) => {
+ padutils.warnDeprecated('Changeset.smartOpAssembler().appendOpWithText() is deprecated; ' +
+ 'use opsFromText() instead.');
+ for (const op of opsFromText(opcode, text, attribs, pool))
+ append(op);
+ };
+ const toString = () => {
+ flushPlusMinus();
+ flushKeeps();
+ return assem.toString();
+ };
+ const clear = () => {
+ minusAssem.clear();
+ plusAssem.clear();
+ keepAssem.clear();
+ assem.clear();
+ lengthChange = 0;
+ };
+ const endDocument = () => {
+ keepAssem.endDocument();
+ };
+ const getLengthChange = () => lengthChange;
+ return {
+ append,
+ toString,
+ clear,
+ endDocument,
+ appendOpWithText,
+ getLengthChange,
+ };
+};
+export const mergingOpAssembler = () => {
+ const assem = exports.opAssembler();
+ const bufOp = new Op();
+ // If we get, for example, insertions [xxx\n,yyy], those don't merge,
+ // but if we get [xxx\n,yyy,zzz\n], that merges to [xxx\nyyyzzz\n].
+ // This variable stores the length of yyy and any other newline-less
+ // ops immediately after it.
+ let bufOpAdditionalCharsAfterNewline = 0;
+ /**
+ * @param {boolean} [isEndDocument]
+ */
+ const flush = (isEndDocument) => {
+ if (!bufOp.opcode)
+ return;
+ if (isEndDocument && bufOp.opcode === '=' && !bufOp.attribs) {
+ // final merged keep, leave it implicit
+ }
+ else {
+ assem.append(bufOp);
+ if (bufOpAdditionalCharsAfterNewline) {
+ bufOp.chars = bufOpAdditionalCharsAfterNewline;
+ bufOp.lines = 0;
+ assem.append(bufOp);
+ bufOpAdditionalCharsAfterNewline = 0;
+ }
+ }
+ bufOp.opcode = '';
+ };
+ const append = (op) => {
+ if (op.chars <= 0)
+ return;
+ if (bufOp.opcode === op.opcode && bufOp.attribs === op.attribs) {
+ if (op.lines > 0) {
+ // bufOp and additional chars are all mergeable into a multi-line op
+ bufOp.chars += bufOpAdditionalCharsAfterNewline + op.chars;
+ bufOp.lines += op.lines;
+ bufOpAdditionalCharsAfterNewline = 0;
+ }
+ else if (bufOp.lines === 0) {
+ // both bufOp and op are in-line
+ bufOp.chars += op.chars;
+ }
+ else {
+ // append in-line text to multi-line bufOp
+ bufOpAdditionalCharsAfterNewline += op.chars;
+ }
+ }
+ else {
+ flush();
+ copyOp(op, bufOp);
+ }
+ };
+ const endDocument = () => {
+ flush(true);
+ };
+ const toString = () => {
+ flush();
+ return assem.toString();
+ };
+ const clear = () => {
+ assem.clear();
+ clearOp(bufOp);
+ };
+ return {
+ append,
+ toString,
+ clear,
+ endDocument,
+ };
+};
+export const opAssembler = () => {
+ let serialized = '';
+ /**
+ * @param {Op} op - Operation to add. Ownership remains with the caller.
+ */
+ const append = (op) => {
+ assert(op instanceof Op, 'argument must be an instance of Op');
+ serialized += op.toString();
+ };
+ const toString = () => serialized;
+ const clear = () => {
+ serialized = '';
+ };
+ return {
+ append,
+ toString,
+ clear,
+ };
+};
+export const stringIterator = (str) => {
+ let curIndex = 0;
+ // newLines is the number of \n between curIndex and str.length
+ let newLines = str.split('\n').length - 1;
+ const getnewLines = () => newLines;
+ const assertRemaining = (n) => {
+ assert(n <= remaining(), `!(${n} <= ${remaining()})`);
+ };
+ const take = (n) => {
+ assertRemaining(n);
+ const s = str.substr(curIndex, n);
+ newLines -= s.split('\n').length - 1;
+ curIndex += n;
+ return s;
+ };
+ const peek = (n) => {
+ assertRemaining(n);
+ const s = str.substr(curIndex, n);
+ return s;
+ };
+ const skip = (n) => {
+ assertRemaining(n);
+ curIndex += n;
+ };
+ const remaining = () => str.length - curIndex;
+ return {
+ take,
+ skip,
+ remaining,
+ peek,
+ newlines: getnewLines,
+ };
+};
+export const stringAssembler = () => ({
+ _str: '',
+ clear() { this._str = ''; },
+ /**
+ * @param {string} x -
+ */
+ append(x) { this._str += String(x); },
+ toString() { return this._str; },
+});
+export const unpack = (cs) => {
+ const headerRegex = /Z:([0-9a-z]+)([><])([0-9a-z]+)|/;
+ const headerMatch = headerRegex.exec(cs);
+ if ((!headerMatch) || (!headerMatch[0]))
+ error(`Not a changeset: ${cs}`);
+ const oldLen = exports.parseNum(headerMatch[1]);
+ const changeSign = (headerMatch[2] === '>') ? 1 : -1;
+ const changeMag = exports.parseNum(headerMatch[3]);
+ const newLen = oldLen + changeSign * changeMag;
+ const opsStart = headerMatch[0].length;
+ let opsEnd = cs.indexOf('$');
+ if (opsEnd < 0)
+ opsEnd = cs.length;
+ return {
+ oldLen,
+ newLen,
+ ops: cs.substring(opsStart, opsEnd),
+ charBank: cs.substring(opsEnd + 1),
+ };
+};
+export const pack = (oldLen, newLen, opsStr, bank) => {
+ const lenDiff = newLen - oldLen;
+ const lenDiffStr = (lenDiff >= 0 ? `>${exports.numToString(lenDiff)}`
+ : `<${exports.numToString(-lenDiff)}`);
+ const a = [];
+ a.push('Z:', exports.numToString(oldLen), lenDiffStr, opsStr, '$', bank);
+ return a.join('');
+};
+export const applyToText = (cs, str) => {
+ const unpacked = exports.unpack(cs);
+ assert(str.length === unpacked.oldLen, `mismatched apply: ${str.length} / ${unpacked.oldLen}`);
+ const bankIter = exports.stringIterator(unpacked.charBank);
+ const strIter = exports.stringIterator(str);
+ const assem = exports.stringAssembler();
+ for (const op of exports.deserializeOps(unpacked.ops)) {
+ switch (op.opcode) {
+ case '+':
+ // op is + and op.lines 0: no newlines must be in op.chars
+ // op is + and op.lines >0: op.chars must include op.lines newlines
+ if (op.lines !== bankIter.peek(op.chars).split('\n').length - 1) {
+ throw new Error(`newline count is wrong in op +; cs:${cs} and text:${str}`);
}
assem.append(bankIter.take(op.chars));
break;
case '-':
- // op is - and op.lines 0: no newlines must be in the deleted string
- // op is - and op.lines >0: op.lines newlines must be in the deleted string
+ // op is - and op.lines 0: no newlines must be in the deleted string
+ // op is - and op.lines >0: op.lines newlines must be in the deleted string
if (op.lines !== strIter.peek(op.chars).split('\n').length - 1) {
throw new Error(`newline count is wrong in op -; cs:${cs} and text:${str}`);
}
strIter.skip(op.chars);
break;
case '=':
- // op is = and op.lines 0: no newlines must be in the copied string
- // op is = and op.lines >0: op.lines newlines must be in the copied string
+ // op is = and op.lines 0: no newlines must be in the copied string
+ // op is = and op.lines >0: op.lines newlines must be in the copied string
if (op.lines !== strIter.peek(op.chars).split('\n').length - 1) {
throw new Error(`newline count is wrong in op =; cs:${cs} and text:${str}`);
}
@@ -1162,20 +1089,13 @@ export const applyToText = (cs, str) => {
}
}
assem.append(strIter.take(strIter.remaining()));
- return assem.toString();
-};
-
-/**
- * Applies a changeset on an array of lines.
- *
- * @param {string} cs - the changeset to apply
- * @param {string[]} lines - The lines to which the changeset needs to be applied
- */
+ return assem.toString();
+};
export const mutateTextLines = (cs, lines) => {
- const unpacked = unpack(cs);
- const bankIter = stringIterator(unpacked.charBank);
+ const unpacked = exports.unpack(cs);
+ const bankIter = exports.stringIterator(unpacked.charBank);
const mut = new TextLinesMutator(lines);
- for (const op of deserializeOps(unpacked.ops)) {
+ for (const op of exports.deserializeOps(unpacked.ops)) {
switch (op.opcode) {
case '+':
mut.insert(bankIter.take(op.chars), op.lines);
@@ -1190,16 +1110,6 @@ export const mutateTextLines = (cs, lines) => {
}
mut.close();
};
-
-/**
- * Composes two attribute strings (see below) into one.
- *
- * @param {AttributeString} att1 - first attribute string
- * @param {AttributeString} att2 - second attribue string
- * @param {boolean} resultIsMutation -
- * @param {AttributePool} pool - attribute pool
- * @returns {string}
- */
export const composeAttributes = (att1, att2, resultIsMutation, pool) => {
// att1 and att2 are strings like "*3*f*1c", asMutation is a boolean.
// Sometimes attribute (key,value) pairs are treated as attribute presence
@@ -1221,93 +1131,15 @@ export const composeAttributes = (att1, att2, resultIsMutation, pool) => {
// attributes that are already gone, so don't do this optimization.
return att2;
}
- if (!att2) return att1;
+ if (!att2)
+ return att1;
return AttributeMap.fromString(att1, pool).updateFromString(att2, !resultIsMutation).toString();
};
-
-/**
- * Function used as parameter for applyZip to apply a Changeset to an attribute.
- *
- * @param {Op} attOp - The op from the sequence that is being operated on, either an attribution
- * string or the earlier of two exportss being composed.
- * @param {Op} csOp -
- * @param {AttributePool} pool - Can be null if definitely not needed.
- * @returns {Op} The result of applying `csOp` to `attOp`.
- */
-const slicerZipperFunc = (attOp, csOp, pool) => {
- const opOut = new Op();
- if (!attOp.opcode) {
- copyOp(csOp, opOut);
- csOp.opcode = '';
- } else if (!csOp.opcode) {
- copyOp(attOp, opOut);
- attOp.opcode = '';
- } else if (attOp.opcode === '-') {
- copyOp(attOp, opOut);
- attOp.opcode = '';
- } else if (csOp.opcode === '+') {
- copyOp(csOp, opOut);
- csOp.opcode = '';
- } else {
- for (const op of [attOp, csOp]) {
- assert(op.chars >= op.lines, `op has more newlines than chars: ${op.toString()}`);
- }
- assert(
- attOp.chars < csOp.chars ? attOp.lines <= csOp.lines
- : attOp.chars > csOp.chars ? attOp.lines >= csOp.lines
- : attOp.lines === csOp.lines,
- 'line count mismatch when composing changesets A*B; ' +
- `opA: ${attOp.toString()} opB: ${csOp.toString()}`);
- assert(['+', '='].includes(attOp.opcode), `unexpected opcode in op: ${attOp.toString()}`);
- assert(['-', '='].includes(csOp.opcode), `unexpected opcode in op: ${csOp.toString()}`);
- opOut.opcode = {
- '+': {
- '-': '', // The '-' cancels out (some of) the '+', leaving any remainder for the next call.
- '=': '+',
- },
- '=': {
- '-': '-',
- '=': '=',
- },
- }[attOp.opcode][csOp.opcode];
- const [fullyConsumedOp, partiallyConsumedOp] = [attOp, csOp].sort((a, b) => a.chars - b.chars);
- opOut.chars = fullyConsumedOp.chars;
- opOut.lines = fullyConsumedOp.lines;
- opOut.attribs = csOp.opcode === '-'
- // csOp is a remove op and remove ops normally never have any attributes, so this should
- // normally be the empty string. However, padDiff.js adds attributes to remove ops and needs
- // them preserved so they are copied here.
- ? csOp.attribs
- : composeAttributes(attOp.attribs, csOp.attribs, attOp.opcode === '=', pool);
- partiallyConsumedOp.chars -= fullyConsumedOp.chars;
- partiallyConsumedOp.lines -= fullyConsumedOp.lines;
- if (!partiallyConsumedOp.chars) partiallyConsumedOp.opcode = '';
- fullyConsumedOp.opcode = '';
- }
- return opOut;
-};
-
-/**
- * Applies a Changeset to the attribs string of a AText.
- *
- * @param {string} cs - Changeset
- * @param {string} astr - the attribs string of a AText
- * @param {AttributePool} pool - the attibutes pool
- * @returns {string}
- */
export const applyToAttribution = (cs, astr, pool) => {
- const unpacked = unpack(cs);
+ const unpacked = exports.unpack(cs);
return applyZip(astr, unpacked.ops, (op1, op2) => slicerZipperFunc(op1, op2, pool));
};
-
-/**
- * Applies a changeset to an array of attribute lines.
- *
- * @param {string} cs - The encoded changeset.
- * @param {Array} lines - Attribute lines. Modified in place.
- * @param {AttributePool} pool - Attribute pool.
- */
-exports.mutateAttributionLines = (cs, lines, pool) => {
+export const mutateAttributionLines = (cs, lines, pool) => {
const unpacked = exports.unpack(cs);
const csOps = exports.deserializeOps(unpacked.ops);
let csOpsNext = csOps.next();
@@ -1315,7 +1147,6 @@ exports.mutateAttributionLines = (cs, lines, pool) => {
let csBankIndex = 0;
// treat the attribution lines as text lines, mutating a line at a time
const mut = new TextLinesMutator(lines);
-
/**
* The Ops in the current line from `lines`.
*
@@ -1323,7 +1154,6 @@ exports.mutateAttributionLines = (cs, lines, pool) => {
*/
let lineOps = null;
let lineOpsNext = null;
-
const lineOpsHasNext = () => lineOpsNext && !lineOpsNext.done;
/**
* Returns false if we are on the last attribute line in `lines` and there is no additional op in
@@ -1332,7 +1162,6 @@ exports.mutateAttributionLines = (cs, lines, pool) => {
* @returns {boolean} True if there are more ops to go through.
*/
const isNextMutOp = () => lineOpsHasNext() || mut.hasMore();
-
/**
* @returns {Op} The next Op from `lineIter`. If there are no more Ops, `lineIter` is reset to
* iterate over the next line, which is consumed from `mut`. If there are no more lines,
@@ -1346,13 +1175,13 @@ exports.mutateAttributionLines = (cs, lines, pool) => {
lineOps = exports.deserializeOps(line);
lineOpsNext = lineOps.next();
}
- if (!lineOpsHasNext()) return new Op(); // No more ops and no more lines.
+ if (!lineOpsHasNext())
+ return new Op(); // No more ops and no more lines.
const op = lineOpsNext.value;
lineOpsNext = lineOps.next();
return op;
};
let lineAssem = null;
-
/**
* Appends an op to `lineAssem`. In case `lineAssem` includes one single newline, adds it to the
* `lines` mutator.
@@ -1362,13 +1191,13 @@ exports.mutateAttributionLines = (cs, lines, pool) => {
lineAssem = exports.mergingOpAssembler();
}
lineAssem.append(op);
- if (op.lines <= 0) return;
+ if (op.lines <= 0)
+ return;
assert(op.lines === 1, `Can't have op.lines of ${op.lines} in attribution lines`);
// ship it to the mut
mut.insert(lineAssem.toString(), 1);
lineAssem = null;
};
-
let csOp = new Op();
let attOp = new Op();
while (csOp.opcode || !csOpsNext.done || attOp.opcode || isNextMutOp()) {
@@ -1379,13 +1208,15 @@ exports.mutateAttributionLines = (cs, lines, pool) => {
}
if (!csOp.opcode && !attOp.opcode && !lineAssem && !lineOpsHasNext()) {
break; // done
- } else if (csOp.opcode === '=' && csOp.lines > 0 && !csOp.attribs && !attOp.opcode &&
- !lineAssem && !lineOpsHasNext()) {
+ }
+ else if (csOp.opcode === '=' && csOp.lines > 0 && !csOp.attribs && !attOp.opcode &&
+ !lineAssem && !lineOpsHasNext()) {
// Skip multiple lines without attributes; this is what makes small changes not order of the
// document size.
mut.skipLines(csOp.lines);
csOp.opcode = '';
- } else if (csOp.opcode === '+') {
+ }
+ else if (csOp.opcode === '+') {
const opOut = copyOp(csOp);
if (csOp.lines > 1) {
// Copy the first line from `csOp` to `opOut`.
@@ -1394,42 +1225,37 @@ exports.mutateAttributionLines = (cs, lines, pool) => {
csOp.lines--;
opOut.lines = 1;
opOut.chars = firstLineLen;
- } else {
+ }
+ else {
// Either one or no newlines in '+' `csOp`, copy to `opOut` and reset `csOp`.
csOp.opcode = '';
}
outputMutOp(opOut);
csBankIndex += opOut.chars;
- } else {
- if (!attOp.opcode && isNextMutOp()) attOp = nextMutOp();
+ }
+ else {
+ if (!attOp.opcode && isNextMutOp())
+ attOp = nextMutOp();
const opOut = slicerZipperFunc(attOp, csOp, pool);
- if (opOut.opcode) outputMutOp(opOut);
+ if (opOut.opcode)
+ outputMutOp(opOut);
}
}
-
assert(!lineAssem, `line assembler not finished:${cs}`);
mut.close();
};
-
-/**
- * Joins several Attribution lines.
- *
- * @param {string[]} theAlines - collection of Attribution lines
- * @returns {string} joined Attribution lines
- */
-exports.joinAttributionLines = (theAlines) => {
+export const joinAttributionLines = (theAlines) => {
const assem = exports.mergingOpAssembler();
for (const aline of theAlines) {
- for (const op of exports.deserializeOps(aline)) assem.append(op);
+ for (const op of exports.deserializeOps(aline))
+ assem.append(op);
}
return assem.toString();
};
-
-exports.splitAttributionLines = (attrOps, text) => {
+export const splitAttributionLines = (attrOps, text) => {
const assem = exports.mergingOpAssembler();
const lines = [];
let pos = 0;
-
const appendOp = (op) => {
assem.append(op);
if (op.lines > 0) {
@@ -1438,7 +1264,6 @@ exports.splitAttributionLines = (attrOps, text) => {
}
pos += op.chars;
};
-
for (const op of exports.deserializeOps(attrOps)) {
let numChars = op.chars;
let numLines = op.lines;
@@ -1457,27 +1282,10 @@ exports.splitAttributionLines = (attrOps, text) => {
}
appendOp(op);
}
-
return lines;
};
-
-/**
- * Splits text into lines.
- *
- * @param {string} text - text to split
- * @returns {string[]}
- */
-exports.splitTextLines = (text) => text.match(/[^\n]*(?:\n|[^\n]$)/g);
-
-/**
- * Compose two Changesets.
- *
- * @param {string} cs1 - first Changeset
- * @param {string} cs2 - second Changeset
- * @param {AttributePool} pool - Attribs pool
- * @returns {string}
- */
-exports.compose = (cs1, cs2, pool) => {
+export const splitTextLines = (text) => text.match(/[^\n]*(?:\n|[^\n]$)/g);
+export const compose = (cs1, cs2, pool) => {
const unpacked1 = exports.unpack(cs1);
const unpacked2 = exports.unpack(cs2);
const len1 = unpacked1.oldLen;
@@ -1487,7 +1295,6 @@ exports.compose = (cs1, cs2, pool) => {
const bankIter1 = exports.stringIterator(unpacked1.charBank);
const bankIter2 = exports.stringIterator(unpacked2.charBank);
const bankAssem = exports.stringAssembler();
-
const newOps = applyZip(unpacked1.ops, unpacked2.ops, (op1, op2) => {
const op1code = op1.opcode;
const op2code = op2.opcode;
@@ -1498,59 +1305,35 @@ exports.compose = (cs1, cs2, pool) => {
if (opOut.opcode === '+') {
if (op2code === '+') {
bankAssem.append(bankIter2.take(opOut.chars));
- } else {
+ }
+ else {
bankAssem.append(bankIter1.take(opOut.chars));
}
}
return opOut;
});
-
return exports.pack(len1, len3, newOps, bankAssem.toString());
};
-
-/**
- * Returns a function that tests if a string of attributes (e.g. '*3*4') contains a given attribute
- * key,value that is already present in the pool.
- *
- * @param {Attribute} attribPair - `[key, value]` pair of strings.
- * @param {AttributePool} pool - Attribute pool
- * @returns {Function}
- */
-exports.attributeTester = (attribPair, pool) => {
+export const attributeTester = (attribPair, pool) => {
const never = (attribs) => false;
- if (!pool) return never;
+ if (!pool)
+ return never;
const attribNum = pool.putAttrib(attribPair, true);
- if (attribNum < 0) return never;
+ if (attribNum < 0)
+ return never;
const re = new RegExp(`\\*${exports.numToString(attribNum)}(?!\\w)`);
return (attribs) => re.test(attribs);
};
-
-/**
- * Creates the identity Changeset of length N.
- *
- * @param {number} N - length of the identity changeset
- * @returns {string}
- */
-exports.identity = (N) => exports.pack(N, N, '', '');
-
-/**
- * Creates a Changeset which works on oldFullText and removes text from spliceStart to
- * spliceStart+numRemoved and inserts newText instead. Also gives possibility to add attributes
- * optNewTextAPairs for the new text.
- *
- * @param {string} orig - Original text.
- * @param {number} start - Index into `orig` where characters should be removed and inserted.
- * @param {number} ndel - Number of characters to delete at `start`.
- * @param {string} ins - Text to insert at `start` (after deleting `ndel` characters).
- * @param {string} [attribs] - Optional attributes to apply to the inserted text.
- * @param {AttributePool} [pool] - Attribute pool.
- * @returns {string}
- */
-exports.makeSplice = (orig, start, ndel, ins, attribs, pool) => {
- 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})`);
- if (start > orig.length) start = orig.length;
- if (ndel > orig.length - start) ndel = orig.length - start;
+export const identity = (N) => exports.pack(N, N, '', '');
+export const makeSplice = (orig, start, ndel, ins, attribs, pool) => {
+ 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})`);
+ if (start > orig.length)
+ start = orig.length;
+ if (ndel > orig.length - start)
+ ndel = orig.length - start;
const deleted = orig.substring(start, start + ndel);
const assem = exports.smartOpAssembler();
const ops = (function* () {
@@ -1558,55 +1341,12 @@ exports.makeSplice = (orig, start, ndel, ins, attribs, pool) => {
yield* opsFromText('-', deleted);
yield* opsFromText('+', ins, attribs, pool);
})();
- for (const op of ops) assem.append(op);
+ for (const op of ops)
+ assem.append(op);
assem.endDocument();
return exports.pack(orig.length, orig.length + ins.length - ndel, assem.toString(), ins);
};
-
-/**
- * Transforms a changeset into a list of splices in the form [startChar, endChar, newText] meaning
- * replace text from startChar to endChar with newText.
- *
- * @param {string} cs - Changeset
- * @returns {[number, number, string][]}
- */
-const toSplices = (cs) => {
- const unpacked = exports.unpack(cs);
- /** @type {[number, number, string][]} */
- const splices = [];
-
- let oldPos = 0;
- const charIter = exports.stringIterator(unpacked.charBank);
- let inSplice = false;
- for (const op of exports.deserializeOps(unpacked.ops)) {
- if (op.opcode === '=') {
- oldPos += op.chars;
- inSplice = false;
- } else {
- if (!inSplice) {
- splices.push([oldPos, oldPos, '']);
- inSplice = true;
- }
- if (op.opcode === '-') {
- oldPos += op.chars;
- splices[splices.length - 1][1] += op.chars;
- } else if (op.opcode === '+') {
- splices[splices.length - 1][2] += charIter.take(op.chars);
- }
- }
- }
-
- return splices;
-};
-
-/**
- * @param {string} cs -
- * @param {number} startChar -
- * @param {number} endChar -
- * @param {number} insertionsAfter -
- * @returns {[number, number]}
- */
-exports.characterRangeFollow = (cs, startChar, endChar, insertionsAfter) => {
+export const characterRangeFollow = (cs, startChar, endChar, insertionsAfter) => {
let newStartChar = startChar;
let newEndChar = endChar;
let lengthChangeSoFar = 0;
@@ -1615,48 +1355,42 @@ exports.characterRangeFollow = (cs, startChar, endChar, insertionsAfter) => {
const spliceEnd = splice[1] + lengthChangeSoFar;
const newTextLength = splice[2].length;
const thisLengthChange = newTextLength - (spliceEnd - spliceStart);
-
if (spliceStart <= newStartChar && spliceEnd >= newEndChar) {
// splice fully replaces/deletes range
// (also case that handles insertion at a collapsed selection)
if (insertionsAfter) {
newStartChar = newEndChar = spliceStart;
- } else {
+ }
+ else {
newStartChar = newEndChar = spliceStart + newTextLength;
}
- } else if (spliceEnd <= newStartChar) {
+ }
+ else if (spliceEnd <= newStartChar) {
// splice is before range
newStartChar += thisLengthChange;
newEndChar += thisLengthChange;
- } else if (spliceStart >= newEndChar) {
+ }
+ else if (spliceStart >= newEndChar) {
// splice is after range
- } else if (spliceStart >= newStartChar && spliceEnd <= newEndChar) {
+ }
+ else if (spliceStart >= newStartChar && spliceEnd <= newEndChar) {
// splice is inside range
newEndChar += thisLengthChange;
- } else if (spliceEnd < newEndChar) {
+ }
+ else if (spliceEnd < newEndChar) {
// splice overlaps beginning of range
newStartChar = spliceStart + newTextLength;
newEndChar += thisLengthChange;
- } else {
+ }
+ else {
// splice overlaps end of range
newEndChar = spliceStart;
}
-
lengthChangeSoFar += thisLengthChange;
}
-
return [newStartChar, newEndChar];
};
-
-/**
- * Iterate over attributes in a changeset and move them from oldPool to newPool.
- *
- * @param {string} cs - Chageset/attribution string to iterate over
- * @param {AttributePool} oldPool - old attributes pool
- * @param {AttributePool} newPool - new attributes pool
- * @returns {string} the new Changeset
- */
-exports.moveOpsToNewPool = (cs, oldPool, newPool) => {
+export const moveOpsToNewPool = (cs, oldPool, newPool) => {
// works on exports or attribution string
let dollarPos = cs.indexOf('$');
if (dollarPos < 0) {
@@ -1670,41 +1404,25 @@ exports.moveOpsToNewPool = (cs, oldPool, newPool) => {
const pair = oldPool.getAttrib(oldNum);
// The attribute might not be in the old pool if the user is viewing the current revision in the
// timeslider and text is deleted. See: https://github.com/ether/etherpad-lite/issues/3932
- if (!pair) return '';
+ if (!pair)
+ return '';
const newNum = newPool.putAttrib(pair);
return `*${exports.numToString(newNum)}`;
}) + fromDollar;
};
-
-/**
- * Create an attribution inserting a text.
- *
- * @param {string} text - text to insert
- * @returns {string}
- */
-exports.makeAttribution = (text) => {
+export const makeAttribution = (text) => {
const assem = exports.smartOpAssembler();
- for (const op of opsFromText('+', text)) assem.append(op);
+ for (const op of opsFromText('+', text))
+ assem.append(op);
return assem.toString();
};
-
-/**
- * Iterates over attributes in exports, attribution string, or attribs property of an op and runs
- * function func on them.
- *
- * @deprecated Use `attributes.decodeAttribString()` instead.
- * @param {string} cs - changeset
- * @param {Function} func - function to call
- */
-exports.eachAttribNumber = (cs, func) => {
- padutils.warnDeprecated(
- 'Changeset.eachAttribNumber() is deprecated; use attributes.decodeAttribString() instead');
+export const eachAttribNumber = (cs, func) => {
+ padutils.warnDeprecated('Changeset.eachAttribNumber() is deprecated; use attributes.decodeAttribString() instead');
let dollarPos = cs.indexOf('$');
if (dollarPos < 0) {
dollarPos = cs.length;
}
const upToDollar = cs.substring(0, dollarPos);
-
// WARNING: The following cannot be replaced with a call to `attributes.decodeAttribString()`
// because that function only works on attribute strings, not serialized operations or changesets.
upToDollar.replace(/\*([0-9a-z]+)/g, (_, a) => {
@@ -1712,126 +1430,63 @@ exports.eachAttribNumber = (cs, func) => {
return '';
});
};
-
-/**
- * Filter attributes which should remain in a Changeset. Callable on a exports, attribution string,
- * or attribs property of an op, though it may easily create adjacent ops that can be merged.
- *
- * @param {string} cs - changeset to filter
- * @param {Function} filter - fnc which returns true if an attribute X (int) should be kept in the
- * Changeset
- * @returns {string}
- */
-exports.filterAttribNumbers = (cs, filter) => exports.mapAttribNumbers(cs, filter);
-
-/**
- * Does exactly the same as exports.filterAttribNumbers.
- *
- * @param {string} cs -
- * @param {Function} func -
- * @returns {string}
- */
-exports.mapAttribNumbers = (cs, func) => {
+export const filterAttribNumbers = (cs, filter) => exports.mapAttribNumbers(cs, filter);
+export const mapAttribNumbers = (cs, func) => {
let dollarPos = cs.indexOf('$');
if (dollarPos < 0) {
dollarPos = cs.length;
}
const upToDollar = cs.substring(0, dollarPos);
-
const newUpToDollar = upToDollar.replace(/\*([0-9a-z]+)/g, (s, a) => {
const n = func(exports.parseNum(a));
if (n === true) {
return s;
- } else if ((typeof n) === 'number') {
+ }
+ else if ((typeof n) === 'number') {
return `*${exports.numToString(n)}`;
- } else {
+ }
+ else {
return '';
}
});
-
return newUpToDollar + cs.substring(dollarPos);
};
-
-/**
- * Represents text with attributes.
- *
- * @typedef {object} AText
- * @property {string} attribs - Serialized sequence of insert operations that cover the text in
- * `text`. These operations describe which parts of the text have what attributes.
- * @property {string} text - The text.
- */
-
-/**
- * Create a Changeset going from Identity to a certain state.
- *
- * @param {string} text - text of the final change
- * @param {string} attribs - optional, operations which insert the text and also puts the right
- * attributes
- * @returns {AText}
- */
export const makeAText = (text, attribs) => ({
text,
attribs: (attribs || exports.makeAttribution(text)),
});
-
-/**
- * Apply a Changeset to a AText.
- *
- * @param {string} cs - Changeset to apply
- * @param {AText} atext -
- * @param {AttributePool} pool - Attribute Pool to add to
- * @returns {AText}
- */
export const applyToAText = (cs, atext, pool) => ({
text: exports.applyToText(cs, atext.text),
attribs: exports.applyToAttribution(cs, atext.attribs, pool),
});
-
-/**
- * Clones a AText structure.
- *
- * @param {AText} atext -
- * @returns {AText}
- */
-exports.cloneAText = (atext) => {
- if (!atext) error('atext is null');
+export const cloneAText = (atext) => {
+ if (!atext)
+ error('atext is null');
return {
text: atext.text,
attribs: atext.attribs,
};
};
-
-/**
- * Copies a AText structure from atext1 to atext2.
- *
- * @param {AText} atext1 -
- * @param {AText} atext2 -
- */
export const copyAText = (atext1, atext2) => {
atext2.text = atext1.text;
atext2.attribs = atext1.attribs;
};
-
-/**
- * Convert AText to a series of operations. Strips final newline.
- *
- * @param {AText} atext - The AText to convert.
- * @yields {Op}
- * @returns {Generator}
- */
export const opsFromAText = function* (atext) {
// intentionally skips last newline char of atext
let lastOp = null;
- for (const op of deserializeOps(atext.attribs)) {
- if (lastOp != null) yield lastOp;
+ for (const op of exports.deserializeOps(atext.attribs)) {
+ if (lastOp != null)
+ yield lastOp;
lastOp = op;
}
- if (lastOp == null) return;
+ if (lastOp == null)
+ return;
// exclude final newline
if (lastOp.lines <= 1) {
lastOp.lines = 0;
lastOp.chars--;
- } else {
+ }
+ else {
const nextToLastNewlineEnd = atext.text.lastIndexOf('\n', atext.text.length - 2) + 1;
const lastLineLength = atext.text.length - nextToLastNewlineEnd - 1;
lastOp.lines--;
@@ -1840,30 +1495,15 @@ export const opsFromAText = function* (atext) {
lastOp.lines = 0;
lastOp.chars = lastLineLength;
}
- if (lastOp.chars) yield lastOp;
+ if (lastOp.chars)
+ yield lastOp;
};
-
-/**
- * Append the set of operations from atext to an assembler.
- *
- * @deprecated Use `opsFromAText` instead.
- * @param {AText} atext -
- * @param assem - Assembler like SmartOpAssembler TODO add desc
- */
-exports.appendATextToAssembler = (atext, assem) => {
- padutils.warnDeprecated(
- 'Changeset.appendATextToAssembler() is deprecated; use Changeset.opsFromAText() instead');
- for (const op of exports.opsFromAText(atext)) assem.append(op);
+export const appendATextToAssembler = (atext, assem) => {
+ padutils.warnDeprecated('Changeset.appendATextToAssembler() is deprecated; use Changeset.opsFromAText() instead');
+ for (const op of exports.opsFromAText(atext))
+ assem.append(op);
};
-
-/**
- * Creates a clone of a Changeset and it's APool.
- *
- * @param {string} cs -
- * @param {AttributePool} pool -
- * @returns {{translated: string, pool: AttributePool}}
- */
-exports.prepareForWire = (cs, pool) => {
+export const prepareForWire = (cs, pool) => {
const newPool = new AttributePool();
const newCs = exports.moveOpsToNewPool(cs, pool, newPool);
return {
@@ -1871,79 +1511,22 @@ exports.prepareForWire = (cs, pool) => {
pool: newPool,
};
};
-
-/**
- * Checks if a changeset s the identity changeset.
- *
- * @param {string} cs -
- * @returns {boolean}
- */
-exports.isIdentity = (cs) => {
+export const isIdentity = (cs) => {
const unpacked = exports.unpack(cs);
return unpacked.ops === '' && unpacked.oldLen === unpacked.newLen;
};
-
-/**
- * @deprecated Use an AttributeMap instead.
- */
-const attribsAttributeValue = (attribs, key, pool) => {
- if (!attribs) return '';
- for (const [k, v] of attributes.attribsFromString(attribs, pool)) {
- if (k === key) return v;
- }
- return '';
-};
-
-/**
- * Returns all the values of attributes with a certain key in an Op attribs string.
- *
- * @deprecated Use an AttributeMap instead.
- * @param {Op} op - Op
- * @param {string} key - string to search for
- * @param {AttributePool} pool - attribute pool
- * @returns {string}
- */
-exports.opAttributeValue = (op, key, pool) => {
- padutils.warnDeprecated(
- 'Changeset.opAttributeValue() is deprecated; use an AttributeMap instead');
+export const opAttributeValue = (op, key, pool) => {
+ padutils.warnDeprecated('Changeset.opAttributeValue() is deprecated; use an AttributeMap instead');
return attribsAttributeValue(op.attribs, key, pool);
};
-
-/**
- * Returns all the values of attributes with a certain key in an attribs string.
- *
- * @deprecated Use an AttributeMap instead.
- * @param {AttributeString} attribs - Attribute string
- * @param {string} key - string to search for
- * @param {AttributePool} pool - attribute pool
- * @returns {string}
- */
-exports.attribsAttributeValue = (attribs, key, pool) => {
- padutils.warnDeprecated(
- 'Changeset.attribsAttributeValue() is deprecated; use an AttributeMap instead');
+const attribsAttributeValue$0 = (attribs, key, pool) => {
+ padutils.warnDeprecated('Changeset.attribsAttributeValue() is deprecated; use an AttributeMap instead');
return attribsAttributeValue(attribs, key, pool);
};
-
-/**
- * Incrementally builds a Changeset.
- *
- * @typedef {object} Builder
- * @property {Function} insert -
- * @property {Function} keep -
- * @property {Function} keepText -
- * @property {Function} remove -
- * @property {Function} toString -
- */
-
-/**
- * @param {number} oldLen - Old length
- * @returns {Builder}
- */
-exports.builder = (oldLen) => {
+export const builder = (oldLen) => {
const assem = exports.smartOpAssembler();
const o = new Op();
const charBank = exports.stringAssembler();
-
const self = {
/**
* @param {number} N - Number of characters to keep.
@@ -1958,13 +1541,12 @@ exports.builder = (oldLen) => {
keep: (N, L, attribs, pool) => {
o.opcode = '=';
o.attribs = typeof attribs === 'string'
- ? attribs : new AttributeMap(pool).update(attribs || []).toString();
+ ? attribs : new AttributeMap(pool).update(attribs || []).toString();
o.chars = N;
o.lines = (L || 0);
assem.append(o);
return self;
},
-
/**
* @param {string} text - Text to keep.
* @param {(string|Attribute[])} attribs - Either [[key1,value1],[key2,value2],...] or '*0*1...'
@@ -1974,10 +1556,10 @@ exports.builder = (oldLen) => {
* @returns {Builder} this
*/
keepText: (text, attribs, pool) => {
- for (const op of opsFromText('=', text, attribs, pool)) assem.append(op);
+ for (const op of opsFromText('=', text, attribs, pool))
+ assem.append(op);
return self;
},
-
/**
* @param {string} text - Text to insert.
* @param {(string|Attribute[])} attribs - Either [[key1,value1],[key2,value2],...] or '*0*1...'
@@ -1987,11 +1569,11 @@ exports.builder = (oldLen) => {
* @returns {Builder} this
*/
insert: (text, attribs, pool) => {
- for (const op of opsFromText('+', text, attribs, pool)) assem.append(op);
+ for (const op of opsFromText('+', text, attribs, pool))
+ assem.append(op);
charBank.append(text);
return self;
},
-
/**
* @param {number} N - Number of characters to remove.
* @param {number} L - Number of newlines among the `N` characters. If positive, the last
@@ -2006,51 +1588,32 @@ exports.builder = (oldLen) => {
assem.append(o);
return self;
},
-
toString: () => {
assem.endDocument();
const newLen = oldLen + assem.getLengthChange();
return exports.pack(oldLen, newLen, assem.toString(), charBank.toString());
},
};
-
return self;
};
-
-/**
- * Constructs an attribute string from a sequence of attributes.
- *
- * @deprecated Use `AttributeMap.prototype.toString()` or `attributes.attribsToString()` instead.
- * @param {string} opcode - The opcode for the Op that will get the resulting attribute string.
- * @param {?(Iterable|AttributeString)} attribs - The attributes to insert into the pool
- * (if necessary) and encode. If an attribute string, no checking is performed to ensure that
- * the attributes exist in the pool, are in the canonical order, and contain no duplicate keys.
- * If this is an iterable of attributes, `pool` must be non-null.
- * @param {AttributePool} pool - Attribute pool. Required if `attribs` is an iterable of attributes,
- * ignored if `attribs` is an attribute string.
- * @returns {AttributeString}
- */
-exports.makeAttribsString = (opcode, attribs, pool) => {
- padutils.warnDeprecated(
- 'Changeset.makeAttribsString() is deprecated; ' +
+export const makeAttribsString = (opcode, attribs, pool) => {
+ padutils.warnDeprecated('Changeset.makeAttribsString() is deprecated; ' +
'use AttributeMap.prototype.toString() or attributes.attribsToString() instead');
- if (!attribs || !['=', '+'].includes(opcode)) return '';
- if (typeof attribs === 'string') return attribs;
+ if (!attribs || !['=', '+'].includes(opcode))
+ return '';
+ if (typeof attribs === 'string')
+ return attribs;
return new AttributeMap(pool).update(attribs, opcode === '+').toString();
};
-
-/**
- * Like "substring" but on a single-line attribution string.
- */
-exports.subattribution = (astr, start, optEnd) => {
+export const subattribution = (astr, start, optEnd) => {
const attOps = exports.deserializeOps(astr);
let attOpsNext = attOps.next();
const assem = exports.smartOpAssembler();
let attOp = new Op();
const csOp = new Op();
-
const doCsOp = () => {
- if (!csOp.chars) return;
+ if (!csOp.chars)
+ return;
while (csOp.opcode && (attOp.opcode || !attOpsNext.done)) {
if (!attOp.opcode) {
attOp = attOpsNext.value;
@@ -2061,15 +1624,13 @@ exports.subattribution = (astr, start, optEnd) => {
csOp.lines++;
}
const opOut = slicerZipperFunc(attOp, csOp, null);
- if (opOut.opcode) assem.append(opOut);
+ if (opOut.opcode)
+ assem.append(opOut);
}
};
-
csOp.opcode = '-';
csOp.chars = start;
-
doCsOp();
-
if (optEnd === undefined) {
if (attOp.opcode) {
assem.append(attOp);
@@ -2078,28 +1639,26 @@ exports.subattribution = (astr, start, optEnd) => {
assem.append(attOpsNext.value);
attOpsNext = attOps.next();
}
- } else {
+ }
+ else {
csOp.opcode = '=';
csOp.chars = optEnd - start;
doCsOp();
}
-
return assem.toString();
};
-
-exports.inverse = (cs, lines, alines, pool) => {
+export const inverse = (cs, lines, alines, pool) => {
// lines and alines are what the exports is meant to apply to.
// They may be arrays or objects with .get(i) and .length methods.
// They include final newlines on lines.
-
const linesGet = (idx) => {
if (lines.get) {
return lines.get(idx);
- } else {
+ }
+ else {
return lines[idx];
}
};
-
/**
* @param {number} idx -
* @returns {string}
@@ -2107,21 +1666,19 @@ exports.inverse = (cs, lines, alines, pool) => {
const alinesGet = (idx) => {
if (alines.get) {
return alines.get(idx);
- } else {
+ }
+ else {
return alines[idx];
}
};
-
let curLine = 0;
let curChar = 0;
let curLineOps = null;
let curLineOpsNext = null;
let curLineOpsLine;
let curLineNextOp = new Op('+');
-
const unpacked = exports.unpack(cs);
const builder = exports.builder(unpacked.newLen);
-
const consumeAttribRuns = (numChars, func /* (len, attribs, endsLine)*/) => {
if (!curLineOps || curLineOpsLine !== curLine) {
curLineOps = exports.deserializeOps(alinesGet(curLine));
@@ -2138,7 +1695,6 @@ exports.inverse = (cs, lines, alines, pool) => {
indexIntoLine += curLineNextOp.chars;
}
}
-
while (numChars > 0) {
if (!curLineNextOp.chars && curLineOpsNext.done) {
curLine++;
@@ -2151,7 +1707,8 @@ exports.inverse = (cs, lines, alines, pool) => {
if (!curLineNextOp.chars) {
if (curLineOpsNext.done) {
curLineNextOp = new Op();
- } else {
+ }
+ else {
curLineNextOp = curLineOpsNext.value;
curLineOpsNext = curLineOps.next();
}
@@ -2163,31 +1720,29 @@ exports.inverse = (cs, lines, alines, pool) => {
curLineNextOp.chars -= charsToUse;
curChar += charsToUse;
}
-
if (!curLineNextOp.chars && curLineOpsNext.done) {
curLine++;
curChar = 0;
}
};
-
const skip = (N, L) => {
if (L) {
curLine += L;
curChar = 0;
- } else if (curLineOps && curLineOpsLine === curLine) {
- consumeAttribRuns(N, () => {});
- } else {
+ }
+ else if (curLineOps && curLineOpsLine === curLine) {
+ consumeAttribRuns(N, () => { });
+ }
+ else {
curChar += N;
}
};
-
const nextText = (numChars) => {
let len = 0;
const assem = exports.stringAssembler();
const firstString = linesGet(curLine).substring(curChar);
len += firstString.length;
assem.append(firstString);
-
let lineNum = curLine + 1;
while (len < numChars) {
const nextString = linesGet(lineNum);
@@ -2195,10 +1750,8 @@ exports.inverse = (cs, lines, alines, pool) => {
assem.append(nextString);
lineNum++;
}
-
return assem.toString().substring(0, numChars);
};
-
const cachedStrFunc = (func) => {
const cache = {};
return (s) => {
@@ -2208,7 +1761,6 @@ exports.inverse = (cs, lines, alines, pool) => {
return cache[s];
};
};
-
for (const csOp of exports.deserializeOps(unpacked.ops)) {
if (csOp.opcode === '=') {
if (csOp.attribs) {
@@ -2218,7 +1770,8 @@ exports.inverse = (cs, lines, alines, pool) => {
const backAttribs = new AttributeMap(pool);
for (const [key, value] of attribs) {
const oldValue = oldAttribs.get(key) || '';
- if (oldValue !== value) backAttribs.set(key, oldValue);
+ if (oldValue !== value)
+ backAttribs.set(key, oldValue);
}
// TODO: backAttribs does not restore removed attributes (it is missing attributes that
// are in oldAttribs but not in attribs). I don't know if that is intentional.
@@ -2227,13 +1780,16 @@ exports.inverse = (cs, lines, alines, pool) => {
consumeAttribRuns(csOp.chars, (len, attribs, endsLine) => {
builder.keep(len, endsLine ? 1 : 0, undoBackToAttribs(attribs));
});
- } else {
+ }
+ else {
skip(csOp.chars, csOp.lines);
builder.keep(csOp.chars, csOp.lines);
}
- } else if (csOp.opcode === '+') {
+ }
+ else if (csOp.opcode === '+') {
builder.remove(csOp.chars, csOp.lines);
- } else if (csOp.opcode === '-') {
+ }
+ else if (csOp.opcode === '-') {
const textBank = nextText(csOp.chars);
let textBankIndex = 0;
consumeAttribRuns(csOp.chars, (len, attribs, endsLine) => {
@@ -2242,12 +1798,9 @@ exports.inverse = (cs, lines, alines, pool) => {
});
}
}
-
return exports.checkRep(builder.toString());
};
-
-// %CLIENT FILE ENDS HERE%
-exports.follow = (cs1, cs2, reverseInsertOrder, pool) => {
+export const follow = (cs1, cs2, reverseInsertOrder, pool) => {
const unpacked1 = exports.unpack(cs1);
const unpacked2 = exports.unpack(cs2);
const len1 = unpacked1.oldLen;
@@ -2255,22 +1808,21 @@ exports.follow = (cs1, cs2, reverseInsertOrder, pool) => {
assert(len1 === len2, 'mismatched follow - cannot transform cs1 on top of cs2');
const chars1 = exports.stringIterator(unpacked1.charBank);
const chars2 = exports.stringIterator(unpacked2.charBank);
-
const oldLen = unpacked1.newLen;
let oldPos = 0;
let newLen = 0;
-
const hasInsertFirst = exports.attributeTester(['insertorder', 'first'], pool);
-
const newOps = applyZip(unpacked1.ops, unpacked2.ops, (op1, op2) => {
const opOut = new Op();
if (op1.opcode === '+' || op2.opcode === '+') {
let whichToDo;
if (op2.opcode !== '+') {
whichToDo = 1;
- } else if (op1.opcode !== '+') {
+ }
+ else if (op1.opcode !== '+') {
whichToDo = 2;
- } else {
+ }
+ else {
// both +
const firstChar1 = chars1.peek(1);
const firstChar2 = chars2.peek(1);
@@ -2278,17 +1830,22 @@ exports.follow = (cs1, cs2, reverseInsertOrder, pool) => {
const insertFirst2 = hasInsertFirst(op2.attribs);
if (insertFirst1 && !insertFirst2) {
whichToDo = 1;
- } else if (insertFirst2 && !insertFirst1) {
+ }
+ else if (insertFirst2 && !insertFirst1) {
whichToDo = 2;
- } else if (firstChar1 === '\n' && firstChar2 !== '\n') {
+ }
+ else if (firstChar1 === '\n' && firstChar2 !== '\n') {
// insert string that doesn't start with a newline first so as not to break up lines
whichToDo = 2;
- } else if (firstChar1 !== '\n' && firstChar2 === '\n') {
+ }
+ else if (firstChar1 !== '\n' && firstChar2 === '\n') {
whichToDo = 1;
- } else if (reverseInsertOrder) {
+ }
+ else if (reverseInsertOrder) {
// break symmetry:
whichToDo = 2;
- } else {
+ }
+ else {
whichToDo = 1;
}
}
@@ -2299,32 +1856,38 @@ exports.follow = (cs1, cs2, reverseInsertOrder, pool) => {
opOut.chars = op1.chars;
opOut.attribs = '';
op1.opcode = '';
- } else {
+ }
+ else {
// whichToDo == 2
chars2.skip(op2.chars);
copyOp(op2, opOut);
op2.opcode = '';
}
- } else if (op1.opcode === '-') {
+ }
+ else if (op1.opcode === '-') {
if (!op2.opcode) {
op1.opcode = '';
- } else if (op1.chars <= op2.chars) {
+ }
+ else if (op1.chars <= op2.chars) {
op2.chars -= op1.chars;
op2.lines -= op1.lines;
op1.opcode = '';
if (!op2.chars) {
op2.opcode = '';
}
- } else {
+ }
+ else {
op1.chars -= op2.chars;
op1.lines -= op2.lines;
op2.opcode = '';
}
- } else if (op2.opcode === '-') {
+ }
+ else if (op2.opcode === '-') {
copyOp(op2, opOut);
if (!op1.opcode) {
op2.opcode = '';
- } else if (op2.chars <= op1.chars) {
+ }
+ else if (op2.chars <= op1.chars) {
// delete part or all of a keep
op1.chars -= op2.chars;
op1.lines -= op2.lines;
@@ -2332,7 +1895,8 @@ exports.follow = (cs1, cs2, reverseInsertOrder, pool) => {
if (!op1.chars) {
op1.opcode = '';
}
- } else {
+ }
+ else {
// delete all of a keep, and keep going
opOut.lines = op1.lines;
opOut.chars = op1.chars;
@@ -2340,15 +1904,18 @@ exports.follow = (cs1, cs2, reverseInsertOrder, pool) => {
op2.chars -= op1.chars;
op1.opcode = '';
}
- } else if (!op1.opcode) {
+ }
+ else if (!op1.opcode) {
copyOp(op2, opOut);
op2.opcode = '';
- } else if (!op2.opcode) {
+ }
+ else if (!op2.opcode) {
// @NOTE: Critical bugfix for EPL issue #1625. We do not copy op1 here
// in order to prevent attributes from leaking into result changesets.
// copyOp(op1, opOut);
op1.opcode = '';
- } else {
+ }
+ else {
// both keeps
opOut.opcode = '=';
opOut.attribs = followAttributes(op1.attribs, op2.attribs, pool);
@@ -2361,7 +1928,8 @@ exports.follow = (cs1, cs2, reverseInsertOrder, pool) => {
if (!op2.chars) {
op2.opcode = '';
}
- } else {
+ }
+ else {
opOut.chars = op2.chars;
opOut.lines = op2.lines;
op1.chars -= op2.chars;
@@ -2384,41 +1952,12 @@ exports.follow = (cs1, cs2, reverseInsertOrder, pool) => {
return opOut;
});
newLen += oldLen - oldPos;
-
return exports.pack(oldLen, newLen, newOps, unpacked2.charBank);
};
-
-const followAttributes = (att1, att2, pool) => {
- // The merge of two sets of attribute changes to the same text
- // takes the lexically-earlier value if there are two values
- // for the same key. Otherwise, all key/value changes from
- // both attribute sets are taken. This operation is the "follow",
- // so a set of changes is produced that can be applied to att1
- // to produce the merged set.
- if ((!att2) || (!pool)) return '';
- if (!att1) return att2;
- const atts = new Map();
- att2.replace(/\*([0-9a-z]+)/g, (_, a) => {
- const [key, val] = pool.getAttrib(exports.parseNum(a));
- atts.set(key, val);
- return '';
- });
- att1.replace(/\*([0-9a-z]+)/g, (_, a) => {
- const [key, val] = pool.getAttrib(exports.parseNum(a));
- if (atts.has(key) && val <= atts.get(key)) atts.delete(key);
- return '';
- });
- // we've only removed attributes, so they're already sorted
- const buf = exports.stringAssembler();
- for (const att of atts) {
- buf.append('*');
- buf.append(exports.numToString(pool.putAttrib(att)));
- }
- return buf.toString();
-};
-
-exports.exportedForTestingOnly = {
+export const exportedForTestingOnly = {
TextLinesMutator,
followAttributes,
toSplices,
};
+export { Op };
+export { attribsAttributeValue$0 as attribsAttributeValue };
diff --git a/src/static/js/ace.js b/src/static/js/ace.ts
similarity index 84%
rename from src/static/js/ace.js
rename to src/static/js/ace.ts
index b0a0425702e..e6878c72043 100644
--- a/src/static/js/ace.js
+++ b/src/static/js/ace.ts
@@ -1,49 +1,27 @@
+import * as hooks from "./pluginfw/hooks.js";
+import { makeCSSManager as makeCSSManager$0 } from "./cssmanager.js";
+import * as pluginUtils from "./pluginfw/shared.js";
+import {Ace2EditorInfo, AceDocType} from "../module/Ace2EditorInfo";
+import {clientVars} from "../../node/handler/PadMessageHandler";
+import {CustomWindow} from "../module/CustomWindow";
'use strict';
-/**
- * This code is mostly from the old Etherpad. Please help us to comment this code.
- * This helps other people to understand this code better and helps them to improve it.
- * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED
- */
-
-/**
- * Copyright 2009 Google Inc.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS-IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-// requires: top
-// requires: undefined
-
-const hooks = require('./pluginfw/hooks');
-const makeCSSManager = require('./cssmanager').makeCSSManager;
-const pluginUtils = require('./pluginfw/shared');
-
-const debugLog = (...args) => {};
+const makeCSSManager = { makeCSSManager: makeCSSManager$0 }.makeCSSManager;
+const debugLog = (...args) => { };
// The inner and outer iframe's locations are about:blank, so relative URLs are relative to that.
// Firefox and Chrome seem to do what the developer intends if given a relative URL, but Safari
// errors out unless given an absolute URL for a JavaScript-created element.
const absUrl = (url) => new URL(url, window.location.href).href;
-
const eventFired = async (obj, event, cleanups = [], predicate = () => true) => {
if (typeof cleanups === 'function') {
predicate = cleanups;
cleanups = [];
}
- await new Promise((resolve, reject) => {
+ await new Promise((resolve, reject) => {
let cleanup;
const successCb = () => {
- if (!predicate()) return;
+ if (!predicate())
+ return;
debugLog(`Ace2Editor.init() ${event} event on`, obj);
cleanup();
resolve();
@@ -55,7 +33,7 @@ const eventFired = async (obj, event, cleanups = [], predicate = () => true) =>
reject(err);
};
cleanup = () => {
- cleanup = () => {};
+ cleanup = () => { };
obj.removeEventListener(event, successCb);
obj.removeEventListener('error', errorCb);
};
@@ -64,14 +42,13 @@ const eventFired = async (obj, event, cleanups = [], predicate = () => true) =>
obj.addEventListener('error', errorCb);
});
};
-
// Resolves when the frame's document is ready to be mutated. Browsers seem to be quirky about
// iframe ready events so this function throws the kitchen sink at the problem. Maybe one day we'll
// find a concise general solution.
const frameReady = async (frame) => {
// Can't do `const doc = frame.contentDocument;` because Firefox seems to asynchronously replace
// the document object after the frame is first created for some reason. ¯\_(ツ)_/¯
- const doc = () => frame.contentDocument;
+ const doc:AceDocType = () => frame.contentDocument;
const cleanups = [];
try {
await Promise.race([
@@ -81,28 +58,27 @@ const frameReady = async (frame) => {
eventFired(doc(), 'DOMContentLoaded', cleanups),
eventFired(doc(), 'readystatechange', cleanups, () => doc.readyState === 'complete'),
]);
- } finally {
- for (const cleanup of cleanups) cleanup();
+ }
+ finally {
+ for (const cleanup of cleanups)
+ cleanup();
}
};
-
const Ace2Editor = function () {
- let info = {editor: this};
+ let info:Ace2EditorInfo = { editor: this };
let loaded = false;
-
let actionsPendingInit = [];
-
const pendingInit = (func) => function (...args) {
const action = () => func.apply(this, args);
- if (loaded) return action();
+ if (loaded)
+ return action();
actionsPendingInit.push(action);
};
-
const doActionsPendingInit = () => {
- for (const fn of actionsPendingInit) fn();
+ for (const fn of actionsPendingInit)
+ fn();
actionsPendingInit = [];
};
-
// The following functions (prefixed by 'ace_') are exposed by editor, but
// execution is delayed until init is complete
const aceFunctionsPendingInit = [
@@ -124,7 +100,6 @@ const Ace2Editor = function () {
'execCommand',
'replaceRange',
];
-
for (const fnName of aceFunctionsPendingInit) {
// Note: info[`ace_${fnName}`] does not exist yet, so it can't be passed directly to
// pendingInit(). A simple wrapper is used to defer the info[`ace_${fnName}`] lookup until
@@ -133,12 +108,9 @@ const Ace2Editor = function () {
info[`ace_${fnName}`].apply(this, args);
});
}
-
this.exportText = () => loaded ? info.ace_exportText() : '(awaiting init)\n';
-
this.getInInternationalComposition =
() => loaded ? info.ace_getInInternationalComposition() : null;
-
// prepareUserChangeset:
// Returns null if no new changes or ACE not ready. Otherwise, bundles up all user changes
// to the latest base text into a Changeset, which is returned (as a string if encodeAsString).
@@ -148,7 +120,6 @@ const Ace2Editor = function () {
// prepareUserChangeset will return an updated changeset that takes into account the latest user
// changes, and modify the changeset to be applied by applyPreparedChangesetToBase accordingly.
this.prepareUserChangeset = () => loaded ? info.ace_prepareUserChangeset() : null;
-
const addStyleTagsFor = (doc, files) => {
for (const file of files) {
const link = doc.createElement('link');
@@ -158,17 +129,14 @@ const Ace2Editor = function () {
doc.head.appendChild(link);
}
};
-
this.destroy = pendingInit(() => {
info.ace_dispose();
info.frame.parentNode.removeChild(info.frame);
info = null; // prevent IE 6 closure memory leaks
});
-
this.init = async function (containerId, initialCode) {
debugLog('Ace2Editor.init()');
this.importText(initialCode);
-
const includedCSS = [
`../static/css/iframe_editor.css?v=${clientVars.randomVersionString}`,
`../static/css/pad.css?v=${clientVars.randomVersionString}`,
@@ -177,12 +145,9 @@ const Ace2Editor = function () {
(p) => /\/\//.test(p) ? p : `../static/plugins/${p}`),
`../static/skins/${clientVars.skinName}/pad.css?v=${clientVars.randomVersionString}`,
];
-
const skinVariants = clientVars.skinVariants.split(' ').filter((x) => x !== '');
-
const outerFrame = document.createElement('iframe');
outerFrame.name = 'ace_outer';
- outerFrame.frameBorder = 0; // for IE
outerFrame.title = 'Ether';
// Some browsers do strange things unless the iframe has a src or srcdoc property:
// - Firefox replaces the frame's contentWindow.document object with a different object after
@@ -197,25 +162,20 @@ const Ace2Editor = function () {
info.frame = outerFrame;
document.getElementById(containerId).appendChild(outerFrame);
const outerWindow = outerFrame.contentWindow;
-
debugLog('Ace2Editor.init() waiting for outer frame');
await frameReady(outerFrame);
debugLog('Ace2Editor.init() outer frame ready');
-
// Firefox might replace the outerWindow.document object after iframe creation so this variable
// is assigned after the Window's load event.
const outerDocument = outerWindow.document;
-
// tag
outerDocument.documentElement.classList.add('outer-editor', 'outerdoc', ...skinVariants);
-
// tag
addStyleTagsFor(outerDocument, includedCSS);
const outerStyle = outerDocument.createElement('style');
outerStyle.type = 'text/css';
outerStyle.title = 'dynamicsyntax';
outerDocument.head.appendChild(outerStyle);
-
// tag
outerDocument.body.id = 'outerdocbody';
outerDocument.body.classList.add('outerdocbody', ...pluginUtils.clientPluginNames());
@@ -231,30 +191,24 @@ const Ace2Editor = function () {
lineMetricsDiv.id = 'linemetricsdiv';
lineMetricsDiv.appendChild(outerDocument.createTextNode('x'));
outerDocument.body.appendChild(lineMetricsDiv);
-
const innerFrame = outerDocument.createElement('iframe');
innerFrame.name = 'ace_inner';
innerFrame.title = 'pad';
innerFrame.scrolling = 'no';
- innerFrame.frameBorder = 0;
- innerFrame.allowTransparency = true; // for IE
+ innerFrame.frameBorder = String(0);
// The iframe MUST have a src or srcdoc property to avoid browser quirks. See the comment above
// outerFrame.srcdoc.
innerFrame.src = 'empty.html';
outerDocument.body.insertBefore(innerFrame, outerDocument.body.firstChild);
- const innerWindow = innerFrame.contentWindow;
-
+ const innerWindow = innerFrame.contentWindow as unknown as CustomWindow;
debugLog('Ace2Editor.init() waiting for inner frame');
await frameReady(innerFrame);
debugLog('Ace2Editor.init() inner frame ready');
-
// Firefox might replace the innerWindow.document object after iframe creation so this variable
// is assigned after the Window's load event.
const innerDocument = innerWindow.document;
-
// tag
innerDocument.documentElement.classList.add('inner-editor', ...skinVariants);
-
// tag
addStyleTagsFor(innerDocument, includedCSS);
const requireKernel = innerDocument.createElement('script');
@@ -267,7 +221,7 @@ const Ace2Editor = function () {
const script = innerDocument.createElement('script');
script.type = 'text/javascript';
script.src = absUrl(`../javascripts/lib/ep_etherpad-lite/static/js/${module}.js` +
- `?callback=require.define&v=${clientVars.randomVersionString}`);
+ `?callback=require.define&v=${clientVars.randomVersionString}`);
innerDocument.head.appendChild(script);
}
const innerStyle = innerDocument.createElement('style');
@@ -275,16 +229,13 @@ const Ace2Editor = function () {
innerStyle.title = 'dynamicsyntax';
innerDocument.head.appendChild(innerStyle);
const headLines = [];
- hooks.callAll('aceInitInnerdocbodyHead', {iframeHTML: headLines});
- innerDocument.head.appendChild(
- innerDocument.createRange().createContextualFragment(headLines.join('\n')));
-
+ hooks.callAll('aceInitInnerdocbodyHead', { iframeHTML: headLines });
+ innerDocument.head.appendChild(innerDocument.createRange().createContextualFragment(headLines.join('\n')));
// tag
innerDocument.body.id = 'innerdocbody';
innerDocument.body.classList.add('innerdocbody');
innerDocument.body.setAttribute('spellcheck', 'false');
innerDocument.body.appendChild(innerDocument.createTextNode('\u00A0')); //
-
debugLog('Ace2Editor.init() waiting for require kernel load');
await eventFired(requireKernel, 'load');
debugLog('Ace2Editor.init() require kernel loaded');
@@ -292,17 +243,13 @@ const Ace2Editor = function () {
require.setRootURI(absUrl('../javascripts/src'));
require.setLibraryURI(absUrl('../javascripts/lib'));
require.setGlobalKeyPath('require');
-
// intentially moved before requiring client_plugins to save a 307
innerWindow.Ace2Inner = require('ep_etherpad-lite/static/js/ace2_inner');
innerWindow.plugins = require('ep_etherpad-lite/static/js/pluginfw/client_plugins');
innerWindow.plugins.adoptPluginsFromAncestorsOf(innerWindow);
-
innerWindow.$ = innerWindow.jQuery = require('ep_etherpad-lite/static/js/rjquery').jQuery;
-
debugLog('Ace2Editor.init() waiting for plugins');
- await new Promise((resolve, reject) => innerWindow.plugins.ensure(
- (err) => err != null ? reject(err) : resolve()));
+ await new Promise((resolve, reject) => innerWindow.plugins.ensure((err) => err != null ? reject(err) : resolve()));
debugLog('Ace2Editor.init() waiting for Ace2Inner.init()');
await innerWindow.Ace2Inner.init(info, {
inner: makeCSSManager(innerStyle.sheet),
@@ -315,5 +262,4 @@ const Ace2Editor = function () {
debugLog('Ace2Editor.init() done');
};
};
-
-exports.Ace2Editor = Ace2Editor;
+export { Ace2Editor };
diff --git a/src/static/module/Ace2EditorInfo.ts b/src/static/module/Ace2EditorInfo.ts
new file mode 100644
index 00000000000..22b81cd7ac7
--- /dev/null
+++ b/src/static/module/Ace2EditorInfo.ts
@@ -0,0 +1,5 @@
+export type Ace2EditorInfo = {
+ [key: string]: any
+}
+
+export type AceDocType = any
diff --git a/src/static/module/CustomWindow.ts b/src/static/module/CustomWindow.ts
new file mode 100644
index 00000000000..40711b98d56
--- /dev/null
+++ b/src/static/module/CustomWindow.ts
@@ -0,0 +1,14 @@
+export type CustomWindow = {
+ require: RequireFunction,
+ Ace2Inner:any,
+ plugins: any,
+ jQuery: any,
+ document: any,
+}
+
+
+export type RequireFunction= {
+ setRootURI: (url: string)=>void,
+ setLibraryURI: (url: string)=>void,
+ setGlobalKeyPath: (path: string)=>void,
+}
diff --git a/src/tsconfig.json b/src/tsconfig.json
index fb9bc8c7ab9..c2b23ed4266 100644
--- a/src/tsconfig.json
+++ b/src/tsconfig.json
@@ -8,7 +8,7 @@
"target": "es6",
"moduleResolution": "node",
"sourceMap": true,
- "outDir": "../dist"
+ "outDir": "dist"
},
"lib": ["es2015"]
}
From 76a6f665a416a5c3a7b03cb1c73c5b23d9d3c8cd Mon Sep 17 00:00:00 2001
From: SamTV12345 <40429738+samtv12345@users.noreply.github.com>
Date: Sun, 25 Jun 2023 00:05:01 +0200
Subject: [PATCH 05/11] Move all files to esm
---
node_modules/ep_etherpad-lite | 1 -
src/node/db/Pad.ts | 30 +-
src/package-lock.json | 1553 +-
src/static/js/AttributeManager.js | 660 +-
src/static/js/AttributeMap.js | 133 +-
src/static/js/Changeset.js | 3306 +--
src/static/js/ChangesetUtils.js | 72 +-
src/static/js/ChatMessage.js | 155 +-
src/static/js/ace2_inner.js | 3527 ----
src/static/js/admin/jquery.autosize.js | 311 +-
src/static/js/admin/minify.json.js | 105 +-
src/static/js/admin/plugins.js | 494 +-
src/static/js/admin/settings.js | 122 +-
src/static/js/attributes.js | 161 +-
src/static/js/basic_error_handler.js | 74 +-
src/static/js/broadcast.js | 856 +-
src/static/js/broadcast_revisions.js | 157 +-
src/static/js/broadcast_slider.js | 619 +-
src/static/js/caretPosition.js | 314 +-
src/static/js/changesettracker.js | 364 +-
src/static/js/chat.js | 513 +-
src/static/js/collab_client.js | 890 +-
src/static/js/colorutils.js | 107 +-
src/static/js/contentcollector.js | 1288 +-
src/static/js/cssmanager.js | 115 +-
src/static/js/domline.js | 488 +-
src/static/js/index.js | 73 +-
src/static/js/l10n.js | 24 +-
src/static/js/linestylefilter.js | 473 +-
src/static/js/pad.js | 1362 +-
src/static/js/pad_automatic_reconnect.js | 259 +-
src/static/js/pad_connectionstatus.js | 130 +-
src/static/js/pad_cookie.js | 96 +-
src/static/js/pad_editbar.js | 873 +-
src/static/js/pad_editor.js | 355 +-
src/static/js/pad_impexp.js | 305 +-
src/static/js/pad_modals.js | 58 +-
src/static/js/pad_savedrevs.js | 34 +-
src/static/js/pad_userlist.js | 1102 +-
src/static/js/pluginfw/client_plugins.js | 102 +-
src/static/js/rjquery.js | 2 +-
src/static/js/scroll.js | 508 +-
src/static/js/security.js | 19 +-
src/static/js/skin_variants.js | 88 +-
src/static/js/skiplist.js | 560 +-
src/static/js/socketio.js | 29 +-
src/static/js/timeslider.js | 268 +-
src/static/js/underscore.js | 3 +-
src/static/js/undomodule.js | 502 +-
src/static/js/vendors/browser.js | 580 +-
src/static/js/vendors/farbtastic.js | 966 +-
src/static/js/vendors/gritter.js | 590 +-
src/static/js/vendors/html10n.js | 1863 +-
src/static/js/vendors/jquery.js | 17111 +++++++---------
src/static/js/vendors/nice-select.js | 379 +-
src/static/skins/colibris/index.js | 7 +-
src/static/skins/colibris/pad.js | 7 +-
src/static/skins/colibris/timeslider.js | 1 -
src/static/skins/no-skin/index.js | 7 +-
src/static/skins/no-skin/pad.js | 7 +-
src/static/skins/no-skin/timeslider.js | 7 +-
src/tests/backend/specs/ExportEtherpad.js | 116 +-
src/tests/backend/specs/ImportEtherpad.js | 367 +-
src/tests/backend/specs/Pad.js | 238 +-
src/tests/backend/specs/SessionStore.js | 436 +-
src/tests/backend/specs/Stream.js | 672 +-
src/tests/backend/specs/api/api.js | 77 +-
.../backend/specs/api/characterEncoding.js | 117 +-
src/tests/backend/specs/api/chat.js | 182 +-
src/tests/backend/specs/api/importexport.js | 475 +-
src/tests/backend/specs/caching_middleware.js | 172 +-
src/tests/backend/specs/chat.js | 287 +-
src/tests/backend/specs/contentcollector.js | 704 +-
src/tests/backend/specs/export.js | 41 +-
src/tests/backend/specs/favicon.js | 166 +-
src/tests/backend/specs/health.js | 98 +-
src/tests/backend/specs/hooks.js | 2235 +-
src/tests/backend/specs/messages.js | 314 +-
src/tests/backend/specs/pad_utils.js | 73 +-
src/tests/backend/specs/pads-with-spaces.js | 36 +-
src/tests/backend/specs/promises.js | 155 +-
src/tests/backend/specs/regression-db.js | 49 +-
src/tests/backend/specs/sanitizePathname.js | 183 +-
src/tests/backend/specs/settings.js | 111 +-
src/tests/backend/specs/socketio.js | 813 +-
src/tests/backend/specs/specialpages.js | 45 +-
src/tests/backend/specs/webaccess.js | 946 +-
87 files changed, 23617 insertions(+), 30656 deletions(-)
delete mode 120000 node_modules/ep_etherpad-lite
delete mode 100644 src/static/js/ace2_inner.js
diff --git a/node_modules/ep_etherpad-lite b/node_modules/ep_etherpad-lite
deleted file mode 120000
index 5cd551cf269..00000000000
--- a/node_modules/ep_etherpad-lite
+++ /dev/null
@@ -1 +0,0 @@
-../src
\ No newline at end of file
diff --git a/src/node/db/Pad.ts b/src/node/db/Pad.ts
index b2bfc877b8c..db5c5a4ca3e 100644
--- a/src/node/db/Pad.ts
+++ b/src/node/db/Pad.ts
@@ -4,7 +4,15 @@
*/
import AttributeMap from '../../static/js/AttributeMap';
-import {applyToAText, copyAText, makeAText} from '../../static/js/Changeset';
+import {
+ applyToAText, checkRep,
+ copyAText, deserializeOps,
+ makeAText,
+ makeSplice,
+ opsFromAText,
+ pack,
+ smartOpAssembler, unpack
+} from '../../static/js/Changeset';
import ChatMessage from '../../static/js/ChatMessage';
import {AttributePool} from '../../static/js/AttributePool';
import {Stream} from '../utils/Stream';
@@ -266,7 +274,7 @@ export class Pad {
(!ins && start > 0 && orig[start - 1] === '\n');
if (!willEndWithNewline) ins += '\n';
if (ndel === 0 && ins.length === 0) return;
- const changeset = Changeset.makeSplice(orig, start, ndel, ins);
+ const changeset = makeSplice(orig, start, ndel, ins);
await this.appendRevision(changeset, authorId);
}
@@ -366,7 +374,7 @@ export class Pad {
if (context.type !== 'text') throw new Error(`unsupported content type: ${context.type}`);
text = cleanText(context.content);
}
- const firstChangeset = Changeset.makeSplice('\n', 0, 0, text);
+ const firstChangeset = makeSplice('\n', 0, 0, text);
await this.appendRevision(firstChangeset, authorId);
}
await aCallAll('padLoad', {pad: this});
@@ -490,8 +498,8 @@ export class Pad {
const oldAText = this.atext;
// based on Changeset.makeSplice
- const assem = Changeset.smartOpAssembler();
- for (const op of Changeset.opsFromAText(oldAText)) assem.append(op);
+ const assem = smartOpAssembler();
+ for (const op of opsFromAText(oldAText)) assem.append(op);
assem.endDocument();
// although we have instantiated the dstPad with '\n', an additional '\n' is
@@ -503,7 +511,7 @@ export class Pad {
// 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);
+ const changeset = pack(oldLength, newLength, assem.toString(), newText);
dstPad.appendRevision(changeset, authorId);
await aCallAll('padCopy', {
@@ -677,7 +685,7 @@ export class Pad {
}
})
.batch(100).buffer(99);
- let atext = Changeset.makeAText('\n');
+ let atext = makeAText('\n');
for await (const [r, changeset, authorId, timestamp, isKeyRev, keyAText] of revs) {
try {
assert(authorId != null);
@@ -688,10 +696,10 @@ export class Pad {
assert(timestamp > 0);
assert(changeset != null);
assert.equal(typeof changeset, 'string');
- Changeset.checkRep(changeset);
- const unpacked = Changeset.unpack(changeset);
+ checkRep(changeset);
+ const unpacked = unpack(changeset);
let text = atext.text;
- for (const op of Changeset.deserializeOps(unpacked.ops)) {
+ for (const op of deserializeOps(unpacked.ops)) {
if (['=', '-'].includes(op.opcode)) {
assert(text.length >= op.chars);
const consumed = text.slice(0, op.chars);
@@ -702,7 +710,7 @@ export class Pad {
}
assert.equal(op.attribs, AttributeMap.fromString(op.attribs, pool).toString());
}
- atext = Changeset.applyToAText(changeset, atext, pool);
+ atext = applyToAText(changeset, atext, pool);
if (isKeyRev) assert.deepEqual(keyAText, atext);
} catch (err) {
err.message = `(pad ${this.id} revision ${r}) ${err.message}`;
diff --git a/src/package-lock.json b/src/package-lock.json
index 618ce284a97..47345ad47bc 100644
--- a/src/package-lock.json
+++ b/src/package-lock.json
@@ -4626,15 +4626,17 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/abbrev": {
"version": "1.1.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/agent-base": {
"version": "4.3.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"es6-promisify": "^5.0.0"
},
@@ -4644,9 +4646,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/agentkeepalive": {
"version": "3.5.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"humanize-ms": "^1.2.1"
},
@@ -4656,27 +4659,30 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/ansi-align": {
"version": "2.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"string-width": "^2.0.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/ansi-regex": {
"version": "2.1.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=0.10.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/ansi-styles": {
"version": "3.2.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"color-convert": "^1.9.0"
},
@@ -4686,33 +4692,38 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/ansicolors": {
"version": "0.3.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/ansistyles": {
"version": "0.1.3",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/aproba": {
"version": "2.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/archy": {
"version": "1.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/are-we-there-yet": {
"version": "1.1.4",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"delegates": "^1.0.0",
"readable-stream": "^2.0.6"
@@ -4720,9 +4731,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/are-we-there-yet/node_modules/readable-stream": {
"version": "2.3.6",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"core-util-is": "~1.0.0",
"inherits": "~2.0.3",
@@ -4735,78 +4747,89 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/are-we-there-yet/node_modules/string_decoder": {
"version": "1.1.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"safe-buffer": "~5.1.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/asap": {
"version": "2.0.6",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/asn1": {
"version": "0.2.4",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"safer-buffer": "~2.1.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/assert-plus": {
"version": "1.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=0.8"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/asynckit": {
"version": "0.4.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/aws-sign2": {
"version": "0.7.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "Apache-2.0",
+ "peer": true,
"engines": {
"node": "*"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/aws4": {
"version": "1.8.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/balanced-match": {
"version": "1.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/bcrypt-pbkdf": {
"version": "1.0.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "BSD-3-Clause",
+ "optional": true,
+ "peer": true,
"dependencies": {
"tweetnacl": "^0.14.3"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/bin-links": {
"version": "1.1.8",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "Artistic-2.0",
+ "peer": true,
"dependencies": {
"bluebird": "^3.5.3",
"cmd-shim": "^3.0.0",
@@ -4818,15 +4841,17 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/bluebird": {
"version": "3.5.5",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/boxen": {
"version": "1.3.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"ansi-align": "^2.0.0",
"camelcase": "^4.0.0",
@@ -4842,9 +4867,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/brace-expansion": {
"version": "1.1.11",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"balanced-match": "^1.0.0",
"concat-map": "0.0.1"
@@ -4852,39 +4878,44 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/buffer-from": {
"version": "1.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/builtins": {
"version": "1.0.3",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/byline": {
"version": "5.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=0.10.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/byte-size": {
"version": "5.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=6.0.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/cacache": {
"version": "12.0.3",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"bluebird": "^3.5.5",
"chownr": "^1.1.1",
@@ -4905,39 +4936,44 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/call-limit": {
"version": "1.1.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/camelcase": {
"version": "4.1.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=4"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/capture-stack-trace": {
"version": "1.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=0.10.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/caseless": {
"version": "0.12.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "Apache-2.0"
+ "license": "Apache-2.0",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/chalk": {
"version": "2.4.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"ansi-styles": "^3.2.1",
"escape-string-regexp": "^1.0.5",
@@ -4949,21 +4985,24 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/chownr": {
"version": "1.1.4",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/ci-info": {
"version": "2.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/cidr-regex": {
"version": "2.0.10",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "BSD-2-Clause",
+ "peer": true,
"dependencies": {
"ip-regex": "^2.1.0"
},
@@ -4973,18 +5012,20 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/cli-boxes": {
"version": "1.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=0.10.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/cli-columns": {
"version": "3.1.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"string-width": "^2.0.0",
"strip-ansi": "^3.0.1"
@@ -4995,9 +5036,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/cli-table3": {
"version": "0.5.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"object-assign": "^4.1.0",
"string-width": "^2.1.1"
@@ -5011,9 +5053,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/cliui": {
"version": "5.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"string-width": "^3.1.0",
"strip-ansi": "^5.2.0",
@@ -5022,27 +5065,30 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/cliui/node_modules/ansi-regex": {
"version": "4.1.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=6"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/cliui/node_modules/is-fullwidth-code-point": {
"version": "2.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=4"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/cliui/node_modules/string-width": {
"version": "3.1.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"emoji-regex": "^7.0.1",
"is-fullwidth-code-point": "^2.0.0",
@@ -5054,9 +5100,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/cliui/node_modules/strip-ansi": {
"version": "5.2.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"ansi-regex": "^4.1.0"
},
@@ -5066,18 +5113,20 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/clone": {
"version": "1.0.4",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=0.8"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/cmd-shim": {
"version": "3.0.3",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"graceful-fs": "^4.1.2",
"mkdirp": "~0.5.0"
@@ -5085,42 +5134,48 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/code-point-at": {
"version": "1.1.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=0.10.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/color-convert": {
"version": "1.9.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"color-name": "^1.1.1"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/color-name": {
"version": "1.1.3",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/colors": {
"version": "1.3.3",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "optional": true,
+ "peer": true,
"engines": {
"node": ">=0.1.90"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/columnify": {
"version": "1.5.4",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"strip-ansi": "^3.0.0",
"wcwidth": "^1.0.0"
@@ -5128,9 +5183,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/combined-stream": {
"version": "1.0.6",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"delayed-stream": "~1.0.0"
},
@@ -5140,18 +5196,20 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/concat-map": {
"version": "0.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/concat-stream": {
"version": "1.6.2",
+ "dev": true,
"engines": [
"node >= 0.8"
],
- "extraneous": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"buffer-from": "^1.0.0",
"inherits": "^2.0.3",
@@ -5161,9 +5219,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/concat-stream/node_modules/readable-stream": {
"version": "2.3.6",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"core-util-is": "~1.0.0",
"inherits": "~2.0.3",
@@ -5176,17 +5235,19 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/concat-stream/node_modules/string_decoder": {
"version": "1.1.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"safe-buffer": "~5.1.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/config-chain": {
"version": "1.1.12",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
+ "peer": true,
"dependencies": {
"ini": "^1.3.4",
"proto-list": "~1.2.1"
@@ -5194,9 +5255,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/configstore": {
"version": "3.1.5",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "BSD-2-Clause",
+ "peer": true,
"dependencies": {
"dot-prop": "^4.2.1",
"graceful-fs": "^4.1.2",
@@ -5211,15 +5273,17 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/console-control-strings": {
"version": "1.1.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/copy-concurrently": {
"version": "1.0.5",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"aproba": "^1.1.1",
"fs-write-stream-atomic": "^1.0.8",
@@ -5231,27 +5295,31 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/copy-concurrently/node_modules/aproba": {
"version": "1.2.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/copy-concurrently/node_modules/iferr": {
"version": "0.1.5",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/core-util-is": {
"version": "1.0.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/create-error-class": {
"version": "3.0.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"capture-stack-trace": "^1.0.0"
},
@@ -5261,9 +5329,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/cross-spawn": {
"version": "5.1.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"lru-cache": "^4.0.1",
"shebang-command": "^1.2.0",
@@ -5272,9 +5341,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/cross-spawn/node_modules/lru-cache": {
"version": "4.1.5",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"pseudomap": "^1.0.2",
"yallist": "^2.1.2"
@@ -5282,29 +5352,33 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/cross-spawn/node_modules/yallist": {
"version": "2.1.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/crypto-random-string": {
"version": "1.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=4"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/cyclist": {
"version": "0.2.2",
- "extraneous": true,
- "inBundle": true
+ "dev": true,
+ "inBundle": true,
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/dashdash": {
"version": "1.14.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"assert-plus": "^1.0.0"
},
@@ -5314,69 +5388,77 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/debug": {
"version": "3.1.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"ms": "2.0.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/debug/node_modules/ms": {
"version": "2.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/debuglog": {
"version": "1.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": "*"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/decamelize": {
"version": "1.2.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=0.10.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/decode-uri-component": {
"version": "0.2.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=0.10"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/deep-extend": {
"version": "0.6.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=4.0.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/defaults": {
"version": "1.0.3",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"clone": "^1.0.2"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/define-properties": {
"version": "1.1.3",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"object-keys": "^1.0.12"
},
@@ -5386,42 +5468,47 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/delayed-stream": {
"version": "1.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=0.4.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/delegates": {
"version": "1.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/detect-indent": {
"version": "5.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=4"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/detect-newline": {
"version": "2.1.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=0.10.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/dezalgo": {
"version": "1.0.3",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"asap": "^2.0.0",
"wrappy": "1"
@@ -5429,9 +5516,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/dot-prop": {
"version": "4.2.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"is-obj": "^1.0.0"
},
@@ -5441,24 +5529,27 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/dotenv": {
"version": "5.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "BSD-2-Clause",
+ "peer": true,
"engines": {
"node": ">=4.6.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/duplexer3": {
"version": "0.1.4",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "BSD-3-Clause"
+ "license": "BSD-3-Clause",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/duplexify": {
"version": "3.6.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"end-of-stream": "^1.0.0",
"inherits": "^2.0.1",
@@ -5468,9 +5559,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/duplexify/node_modules/readable-stream": {
"version": "2.3.6",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"core-util-is": "~1.0.0",
"inherits": "~2.0.3",
@@ -5483,18 +5575,21 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/duplexify/node_modules/string_decoder": {
"version": "1.1.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"safe-buffer": "~5.1.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/ecc-jsbn": {
"version": "0.1.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "optional": true,
+ "peer": true,
"dependencies": {
"jsbn": "~0.1.0",
"safer-buffer": "^2.1.0"
@@ -5502,54 +5597,61 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/editor": {
"version": "1.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/emoji-regex": {
"version": "7.0.3",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/encoding": {
"version": "0.1.12",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"iconv-lite": "~0.4.13"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/end-of-stream": {
"version": "1.4.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"once": "^1.4.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/env-paths": {
"version": "2.2.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=6"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/err-code": {
"version": "1.1.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/errno": {
"version": "0.1.7",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"prr": "~1.0.1"
},
@@ -5559,9 +5661,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/es-abstract": {
"version": "1.12.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"es-to-primitive": "^1.1.1",
"function-bind": "^1.1.1",
@@ -5575,9 +5678,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/es-to-primitive": {
"version": "1.2.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"is-callable": "^1.1.4",
"is-date-object": "^1.0.1",
@@ -5589,33 +5693,37 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/es6-promise": {
"version": "4.2.8",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/es6-promisify": {
"version": "5.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"es6-promise": "^4.0.3"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/escape-string-regexp": {
"version": "1.0.5",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=0.8.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/execa": {
"version": "0.7.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"cross-spawn": "^5.0.1",
"get-stream": "^3.0.0",
@@ -5631,51 +5739,58 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/execa/node_modules/get-stream": {
"version": "3.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=4"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/extend": {
"version": "3.0.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/extsprintf": {
"version": "1.3.0",
+ "dev": true,
"engines": [
"node >=0.6.0"
],
- "extraneous": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/fast-json-stable-stringify": {
"version": "2.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/figgy-pudding": {
"version": "3.5.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/find-npm-prefix": {
"version": "1.0.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/flush-write-stream": {
"version": "1.0.3",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"inherits": "^2.0.1",
"readable-stream": "^2.0.4"
@@ -5683,9 +5798,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/flush-write-stream/node_modules/readable-stream": {
"version": "2.3.6",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"core-util-is": "~1.0.0",
"inherits": "~2.0.3",
@@ -5698,27 +5814,30 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/flush-write-stream/node_modules/string_decoder": {
"version": "1.1.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"safe-buffer": "~5.1.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/forever-agent": {
"version": "0.6.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "Apache-2.0",
+ "peer": true,
"engines": {
"node": "*"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/form-data": {
"version": "2.3.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"asynckit": "^0.4.0",
"combined-stream": "1.0.6",
@@ -5730,9 +5849,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/from2": {
"version": "2.3.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"inherits": "^2.0.1",
"readable-stream": "^2.0.0"
@@ -5740,9 +5860,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/from2/node_modules/readable-stream": {
"version": "2.3.6",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"core-util-is": "~1.0.0",
"inherits": "~2.0.3",
@@ -5755,27 +5876,30 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/from2/node_modules/string_decoder": {
"version": "1.1.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"safe-buffer": "~5.1.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/fs-minipass": {
"version": "1.2.7",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"minipass": "^2.6.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/fs-minipass/node_modules/minipass": {
"version": "2.9.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"safe-buffer": "^5.1.2",
"yallist": "^3.0.0"
@@ -5783,9 +5907,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/fs-vacuum": {
"version": "1.2.10",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"graceful-fs": "^4.1.2",
"path-is-inside": "^1.0.1",
@@ -5794,9 +5919,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/fs-write-stream-atomic": {
"version": "1.0.10",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"graceful-fs": "^4.1.2",
"iferr": "^0.1.5",
@@ -5806,15 +5932,17 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/fs-write-stream-atomic/node_modules/iferr": {
"version": "0.1.5",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/fs-write-stream-atomic/node_modules/readable-stream": {
"version": "2.3.6",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"core-util-is": "~1.0.0",
"inherits": "~2.0.3",
@@ -5827,30 +5955,34 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/fs-write-stream-atomic/node_modules/string_decoder": {
"version": "1.1.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"safe-buffer": "~5.1.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/fs.realpath": {
"version": "1.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/function-bind": {
"version": "1.1.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/gauge": {
"version": "2.7.4",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"aproba": "^1.0.3",
"console-control-strings": "^1.0.0",
@@ -5864,15 +5996,17 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/gauge/node_modules/aproba": {
"version": "1.2.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/gauge/node_modules/string-width": {
"version": "1.0.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"code-point-at": "^1.0.0",
"is-fullwidth-code-point": "^1.0.0",
@@ -5884,15 +6018,17 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/genfun": {
"version": "5.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/gentle-fs": {
"version": "2.3.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "Artistic-2.0",
+ "peer": true,
"dependencies": {
"aproba": "^1.1.2",
"chownr": "^1.1.2",
@@ -5909,30 +6045,34 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/gentle-fs/node_modules/aproba": {
"version": "1.2.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/gentle-fs/node_modules/iferr": {
"version": "0.1.5",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/get-caller-file": {
"version": "2.0.5",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"engines": {
"node": "6.* || 8.* || >= 10.*"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/get-stream": {
"version": "4.1.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"pump": "^3.0.0"
},
@@ -5942,18 +6082,20 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/getpass": {
"version": "0.1.7",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"assert-plus": "^1.0.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/glob": {
"version": "7.1.6",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"fs.realpath": "^1.0.0",
"inflight": "^1.0.4",
@@ -5971,9 +6113,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/global-dirs": {
"version": "0.1.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"ini": "^1.3.4"
},
@@ -5983,9 +6126,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/got": {
"version": "6.7.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"create-error-class": "^3.0.0",
"duplexer3": "^0.1.4",
@@ -6005,24 +6149,27 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/got/node_modules/get-stream": {
"version": "3.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=4"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/graceful-fs": {
"version": "4.2.4",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/har-schema": {
"version": "2.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"engines": {
"node": ">=4"
}
@@ -6030,9 +6177,10 @@
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/har-validator": {
"version": "5.1.5",
"deprecated": "this library is no longer supported",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"ajv": "^6.12.3",
"har-schema": "^2.0.0"
@@ -6043,9 +6191,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/har-validator/node_modules/ajv": {
"version": "6.12.6",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"fast-deep-equal": "^3.1.1",
"fast-json-stable-stringify": "^2.0.0",
@@ -6059,21 +6208,24 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/har-validator/node_modules/fast-deep-equal": {
"version": "3.1.3",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/har-validator/node_modules/json-schema-traverse": {
"version": "0.4.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/has": {
"version": "1.0.3",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"function-bind": "^1.1.1"
},
@@ -6083,45 +6235,51 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/has-flag": {
"version": "3.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=4"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/has-symbols": {
"version": "1.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">= 0.4"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/has-unicode": {
"version": "2.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/hosted-git-info": {
"version": "2.8.9",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/http-cache-semantics": {
"version": "3.8.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "BSD-2-Clause"
+ "license": "BSD-2-Clause",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/http-proxy-agent": {
"version": "2.1.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"agent-base": "4",
"debug": "3.1.0"
@@ -6132,9 +6290,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/http-signature": {
"version": "1.2.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"assert-plus": "^1.0.0",
"jsprim": "^1.2.2",
@@ -6147,9 +6306,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/https-proxy-agent": {
"version": "2.2.4",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"agent-base": "^4.3.0",
"debug": "^3.1.0"
@@ -6160,18 +6320,20 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/humanize-ms": {
"version": "1.2.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"ms": "^2.0.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/iconv-lite": {
"version": "0.4.23",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"safer-buffer": ">= 2.1.2 < 3"
},
@@ -6181,51 +6343,57 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/iferr": {
"version": "1.0.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=6.0.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/ignore-walk": {
"version": "3.0.3",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"minimatch": "^3.0.4"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/import-lazy": {
"version": "2.1.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=4"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/imurmurhash": {
"version": "0.1.4",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=0.8.19"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/infer-owner": {
"version": "1.0.4",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/inflight": {
"version": "1.0.6",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"once": "^1.3.0",
"wrappy": "1"
@@ -6233,21 +6401,24 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/inherits": {
"version": "2.0.4",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/ini": {
"version": "1.3.8",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/init-package-json": {
"version": "1.10.3",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"glob": "^7.1.1",
"npm-package-arg": "^4.0.0 || ^5.0.0 || ^6.0.0",
@@ -6261,33 +6432,37 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/ip": {
"version": "1.1.5",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/ip-regex": {
"version": "2.1.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=4"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/is-callable": {
"version": "1.1.4",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">= 0.4"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/is-ci": {
"version": "1.2.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"ci-info": "^1.5.0"
},
@@ -6297,15 +6472,17 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/is-ci/node_modules/ci-info": {
"version": "1.6.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/is-cidr": {
"version": "3.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "BSD-2-Clause",
+ "peer": true,
"dependencies": {
"cidr-regex": "^2.0.10"
},
@@ -6315,18 +6492,20 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/is-date-object": {
"version": "1.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">= 0.4"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/is-fullwidth-code-point": {
"version": "1.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"number-is-nan": "^1.0.0"
},
@@ -6336,9 +6515,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/is-installed-globally": {
"version": "0.1.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"global-dirs": "^0.1.0",
"is-path-inside": "^1.0.0"
@@ -6349,27 +6529,30 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/is-npm": {
"version": "1.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=0.10.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/is-obj": {
"version": "1.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=0.10.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/is-path-inside": {
"version": "1.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"path-is-inside": "^1.0.1"
},
@@ -6379,18 +6562,20 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/is-redirect": {
"version": "1.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=0.10.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/is-regex": {
"version": "1.0.4",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"has": "^1.0.1"
},
@@ -6400,27 +6585,30 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/is-retry-allowed": {
"version": "1.2.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=0.10.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/is-stream": {
"version": "1.1.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=0.10.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/is-symbol": {
"version": "1.0.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"has-symbols": "^1.0.0"
},
@@ -6430,65 +6618,76 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/is-typedarray": {
"version": "1.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/isarray": {
"version": "1.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/isexe": {
"version": "2.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/isstream": {
"version": "0.1.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/jsbn": {
"version": "0.1.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "optional": true,
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/json-parse-better-errors": {
"version": "1.0.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/json-schema": {
"version": "0.2.3",
- "extraneous": true,
- "inBundle": true
+ "dev": true,
+ "inBundle": true,
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/json-stringify-safe": {
"version": "5.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/jsonparse": {
"version": "1.3.1",
+ "dev": true,
"engines": [
"node >= 0.2.0"
],
- "extraneous": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/JSONStream": {
"version": "1.3.5",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "(MIT OR Apache-2.0)",
+ "peer": true,
"dependencies": {
"jsonparse": "^1.2.0",
"through": ">=2.2.7 <3"
@@ -6502,12 +6701,13 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/jsprim": {
"version": "1.4.1",
+ "dev": true,
"engines": [
"node >=0.6.0"
],
- "extraneous": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"assert-plus": "1.0.0",
"extsprintf": "1.3.0",
@@ -6517,9 +6717,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/latest-version": {
"version": "3.1.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"package-json": "^4.0.0"
},
@@ -6529,15 +6730,17 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/lazy-property": {
"version": "1.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/libcipm": {
"version": "4.0.8",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"bin-links": "^1.1.2",
"bluebird": "^3.5.1",
@@ -6558,9 +6761,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/libnpm": {
"version": "3.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"bin-links": "^1.1.2",
"bluebird": "^3.5.3",
@@ -6586,9 +6790,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/libnpmaccess": {
"version": "3.0.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"aproba": "^2.0.0",
"get-stream": "^4.0.0",
@@ -6598,9 +6803,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/libnpmconfig": {
"version": "1.2.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"figgy-pudding": "^3.5.1",
"find-up": "^3.0.0",
@@ -6609,9 +6815,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/libnpmconfig/node_modules/find-up": {
"version": "3.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"locate-path": "^3.0.0"
},
@@ -6621,9 +6828,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/libnpmconfig/node_modules/locate-path": {
"version": "3.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"p-locate": "^3.0.0",
"path-exists": "^3.0.0"
@@ -6634,9 +6842,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/libnpmconfig/node_modules/p-limit": {
"version": "2.2.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"p-try": "^2.0.0"
},
@@ -6646,9 +6855,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/libnpmconfig/node_modules/p-locate": {
"version": "3.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"p-limit": "^2.0.0"
},
@@ -6658,18 +6868,20 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/libnpmconfig/node_modules/p-try": {
"version": "2.2.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=6"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/libnpmhook": {
"version": "5.0.3",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"aproba": "^2.0.0",
"figgy-pudding": "^3.4.1",
@@ -6679,9 +6891,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/libnpmorg": {
"version": "1.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"aproba": "^2.0.0",
"figgy-pudding": "^3.4.1",
@@ -6691,9 +6904,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/libnpmpublish": {
"version": "1.1.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"aproba": "^2.0.0",
"figgy-pudding": "^3.5.1",
@@ -6708,9 +6922,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/libnpmsearch": {
"version": "2.0.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"figgy-pudding": "^3.5.1",
"get-stream": "^4.0.0",
@@ -6719,9 +6934,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/libnpmteam": {
"version": "1.0.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"aproba": "^2.0.0",
"figgy-pudding": "^3.4.1",
@@ -6731,9 +6947,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/libnpx": {
"version": "10.2.4",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"dotenv": "^5.0.1",
"npm-package-arg": "^6.0.0",
@@ -6750,9 +6967,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/lock-verify": {
"version": "2.1.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"npm-package-arg": "^6.1.0",
"semver": "^5.4.1"
@@ -6760,24 +6978,27 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/lockfile": {
"version": "1.0.4",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"signal-exit": "^3.0.2"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/lodash._baseindexof": {
"version": "3.1.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/lodash._baseuniq": {
"version": "4.6.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"lodash._createset": "~4.0.0",
"lodash._root": "~3.0.0"
@@ -6785,96 +7006,110 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/lodash._bindcallback": {
"version": "3.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/lodash._cacheindexof": {
"version": "3.0.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/lodash._createcache": {
"version": "3.1.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"lodash._getnative": "^3.0.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/lodash._createset": {
"version": "4.0.3",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/lodash._getnative": {
"version": "3.9.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/lodash._root": {
"version": "3.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/lodash.clonedeep": {
"version": "4.5.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/lodash.restparam": {
"version": "3.6.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/lodash.union": {
"version": "4.6.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/lodash.uniq": {
"version": "4.5.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/lodash.without": {
"version": "4.4.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/lowercase-keys": {
"version": "1.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=0.10.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/lru-cache": {
"version": "5.1.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"yallist": "^3.0.2"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/make-dir": {
"version": "1.3.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"pify": "^3.0.0"
},
@@ -6884,9 +7119,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/make-fetch-happen": {
"version": "5.0.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"agentkeepalive": "^3.4.1",
"cacache": "^12.0.0",
@@ -6903,24 +7139,27 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/meant": {
"version": "1.0.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/mime-db": {
"version": "1.35.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">= 0.6"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/mime-types": {
"version": "2.1.19",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"mime-db": "~1.35.0"
},
@@ -6930,9 +7169,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/minimatch": {
"version": "3.0.4",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"brace-expansion": "^1.1.7"
},
@@ -6942,24 +7182,27 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/minimist": {
"version": "1.2.5",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/minizlib": {
"version": "1.3.3",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"minipass": "^2.9.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/minizlib/node_modules/minipass": {
"version": "2.9.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"safe-buffer": "^5.1.2",
"yallist": "^3.0.0"
@@ -6967,9 +7210,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/mississippi": {
"version": "3.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "BSD-2-Clause",
+ "peer": true,
"dependencies": {
"concat-stream": "^1.5.0",
"duplexify": "^3.4.2",
@@ -6988,9 +7232,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/mkdirp": {
"version": "0.5.5",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"minimist": "^1.2.5"
},
@@ -7000,15 +7245,17 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/mkdirp/node_modules/minimist": {
"version": "1.2.5",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/move-concurrently": {
"version": "1.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"aproba": "^1.1.1",
"copy-concurrently": "^1.0.0",
@@ -7020,27 +7267,31 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/move-concurrently/node_modules/aproba": {
"version": "1.2.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/ms": {
"version": "2.1.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/mute-stream": {
"version": "0.0.7",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/node-fetch-npm": {
"version": "2.0.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"encoding": "^0.1.11",
"json-parse-better-errors": "^1.0.0",
@@ -7052,9 +7303,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/node-gyp": {
"version": "5.1.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"env-paths": "^2.2.0",
"glob": "^7.1.4",
@@ -7077,9 +7329,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/nopt": {
"version": "4.0.3",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"abbrev": "1",
"osenv": "^0.1.4"
@@ -7090,9 +7343,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/normalize-package-data": {
"version": "2.5.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "BSD-2-Clause",
+ "peer": true,
"dependencies": {
"hosted-git-info": "^2.1.4",
"resolve": "^1.10.0",
@@ -7102,18 +7356,20 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/normalize-package-data/node_modules/resolve": {
"version": "1.10.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"path-parse": "^1.0.6"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/npm-audit-report": {
"version": "1.3.3",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"cli-table3": "^0.5.0",
"console-control-strings": "^1.1.0"
@@ -7121,33 +7377,37 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/npm-bundled": {
"version": "1.1.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"npm-normalize-package-bin": "^1.0.1"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/npm-cache-filename": {
"version": "1.0.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/npm-install-checks": {
"version": "3.0.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "BSD-2-Clause",
+ "peer": true,
"dependencies": {
"semver": "^2.3.0 || 3.x || 4 || 5"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/npm-lifecycle": {
"version": "3.1.5",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "Artistic-2.0",
+ "peer": true,
"dependencies": {
"byline": "^5.0.0",
"graceful-fs": "^4.1.15",
@@ -7161,21 +7421,24 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/npm-logical-tree": {
"version": "1.2.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/npm-normalize-package-bin": {
"version": "1.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/npm-package-arg": {
"version": "6.1.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"hosted-git-info": "^2.7.1",
"osenv": "^0.1.5",
@@ -7185,9 +7448,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/npm-packlist": {
"version": "1.4.8",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"ignore-walk": "^3.0.1",
"npm-bundled": "^1.0.1",
@@ -7196,9 +7460,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/npm-pick-manifest": {
"version": "3.0.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"figgy-pudding": "^3.5.1",
"npm-package-arg": "^6.0.0",
@@ -7207,9 +7472,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/npm-profile": {
"version": "4.0.4",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"aproba": "^1.1.2 || 2",
"figgy-pudding": "^3.4.1",
@@ -7218,9 +7484,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/npm-registry-fetch": {
"version": "4.0.7",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"bluebird": "^3.5.1",
"figgy-pudding": "^3.4.1",
@@ -7233,7 +7500,7 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/npm-registry-fetch/node_modules/safe-buffer": {
"version": "5.2.1",
- "extraneous": true,
+ "dev": true,
"funding": [
{
"type": "github",
@@ -7249,13 +7516,15 @@
}
],
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/npm-run-path": {
"version": "2.0.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"path-key": "^2.0.0"
},
@@ -7265,15 +7534,17 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/npm-user-validate": {
"version": "1.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "BSD-2-Clause"
+ "license": "BSD-2-Clause",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/npmlog": {
"version": "4.1.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"are-we-there-yet": "~1.1.2",
"console-control-strings": "~1.1.0",
@@ -7283,45 +7554,50 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/number-is-nan": {
"version": "1.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=0.10.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/oauth-sign": {
"version": "0.9.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "Apache-2.0",
+ "peer": true,
"engines": {
"node": "*"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/object-assign": {
"version": "4.1.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=0.10.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/object-keys": {
"version": "1.0.12",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">= 0.4"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/object.getownpropertydescriptors": {
"version": "2.0.3",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"define-properties": "^1.1.2",
"es-abstract": "^1.5.1"
@@ -7332,45 +7608,50 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/once": {
"version": "1.4.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"wrappy": "1"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/opener": {
"version": "1.5.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "(WTFPL OR MIT)",
+ "peer": true,
"bin": {
"opener": "bin/opener-bin.js"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/os-homedir": {
"version": "1.0.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=0.10.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/os-tmpdir": {
"version": "1.0.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=0.10.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/osenv": {
"version": "0.1.5",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"os-homedir": "^1.0.0",
"os-tmpdir": "^1.0.0"
@@ -7378,18 +7659,20 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/p-finally": {
"version": "1.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=4"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/package-json": {
"version": "4.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"got": "^6.7.1",
"registry-auth-token": "^3.0.1",
@@ -7402,9 +7685,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/pacote": {
"version": "9.5.12",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"bluebird": "^3.5.3",
"cacache": "^12.0.2",
@@ -7440,9 +7724,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/pacote/node_modules/minipass": {
"version": "2.9.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"safe-buffer": "^5.1.2",
"yallist": "^3.0.0"
@@ -7450,9 +7735,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/parallel-transform": {
"version": "1.1.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"cyclist": "~0.2.2",
"inherits": "^2.0.3",
@@ -7461,9 +7747,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/parallel-transform/node_modules/readable-stream": {
"version": "2.3.6",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"core-util-is": "~1.0.0",
"inherits": "~2.0.3",
@@ -7476,93 +7763,105 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/parallel-transform/node_modules/string_decoder": {
"version": "1.1.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"safe-buffer": "~5.1.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/path-exists": {
"version": "3.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=4"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/path-is-absolute": {
"version": "1.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=0.10.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/path-is-inside": {
"version": "1.0.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "(WTFPL OR MIT)"
+ "license": "(WTFPL OR MIT)",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/path-key": {
"version": "2.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=4"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/path-parse": {
"version": "1.0.6",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/performance-now": {
"version": "2.1.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/pify": {
"version": "3.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=4"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/prepend-http": {
"version": "1.0.4",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=0.10.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/process-nextick-args": {
"version": "2.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/promise-inflight": {
"version": "1.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/promise-retry": {
"version": "1.1.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"err-code": "^1.0.0",
"retry": "^0.10.0"
@@ -7573,60 +7872,68 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/promise-retry/node_modules/retry": {
"version": "0.10.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": "*"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/promzard": {
"version": "0.3.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"read": "1"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/proto-list": {
"version": "1.2.4",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/protoduck": {
"version": "5.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"genfun": "^5.0.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/prr": {
"version": "1.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/pseudomap": {
"version": "1.0.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/psl": {
"version": "1.1.29",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/pump": {
"version": "3.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"end-of-stream": "^1.1.0",
"once": "^1.3.1"
@@ -7634,9 +7941,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/pumpify": {
"version": "1.5.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"duplexify": "^3.6.0",
"inherits": "^2.0.3",
@@ -7645,9 +7953,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/pumpify/node_modules/pump": {
"version": "2.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"end-of-stream": "^1.1.0",
"once": "^1.3.1"
@@ -7655,32 +7964,36 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/punycode": {
"version": "1.4.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/qrcode-terminal": {
"version": "0.12.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
+ "peer": true,
"bin": {
"qrcode-terminal": "bin/qrcode-terminal.js"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/qs": {
"version": "6.5.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "BSD-3-Clause",
+ "peer": true,
"engines": {
"node": ">=0.6"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/query-string": {
"version": "6.8.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"decode-uri-component": "^0.2.0",
"split-on-first": "^1.0.0",
@@ -7692,15 +8005,17 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/qw": {
"version": "1.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/rc": {
"version": "1.2.8",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "(BSD-2-Clause OR MIT OR Apache-2.0)",
+ "peer": true,
"dependencies": {
"deep-extend": "^0.6.0",
"ini": "~1.3.0",
@@ -7713,9 +8028,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/read": {
"version": "1.0.7",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"mute-stream": "~0.0.4"
},
@@ -7725,18 +8041,20 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/read-cmd-shim": {
"version": "1.0.5",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"graceful-fs": "^4.1.2"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/read-installed": {
"version": "4.0.3",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"debuglog": "^1.0.1",
"read-package-json": "^2.0.0",
@@ -7751,9 +8069,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/read-package-json": {
"version": "2.1.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"glob": "^7.1.1",
"json-parse-better-errors": "^1.0.1",
@@ -7766,9 +8085,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/read-package-tree": {
"version": "5.3.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"read-package-json": "^2.0.0",
"readdir-scoped-modules": "^1.0.0",
@@ -7777,9 +8097,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/readable-stream": {
"version": "3.6.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"inherits": "^2.0.3",
"string_decoder": "^1.1.1",
@@ -7791,9 +8112,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/readdir-scoped-modules": {
"version": "1.1.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"debuglog": "^1.0.1",
"dezalgo": "^1.0.0",
@@ -7803,9 +8125,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/registry-auth-token": {
"version": "3.4.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"rc": "^1.1.6",
"safe-buffer": "^5.0.1"
@@ -7813,9 +8136,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/registry-url": {
"version": "3.1.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"rc": "^1.0.1"
},
@@ -7825,9 +8149,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/request": {
"version": "2.88.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "Apache-2.0",
+ "peer": true,
"dependencies": {
"aws-sign2": "~0.7.0",
"aws4": "^1.8.0",
@@ -7856,42 +8181,47 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/require-directory": {
"version": "2.1.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=0.10.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/require-main-filename": {
"version": "2.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/resolve-from": {
"version": "4.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=4"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/retry": {
"version": "0.12.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">= 4"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/rimraf": {
"version": "2.7.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"glob": "^7.1.3"
},
@@ -7901,45 +8231,51 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/run-queue": {
"version": "1.0.3",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"aproba": "^1.1.1"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/run-queue/node_modules/aproba": {
"version": "1.2.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/safe-buffer": {
"version": "5.1.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/safer-buffer": {
"version": "2.1.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/semver": {
"version": "5.7.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"bin": {
"semver": "bin/semver"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/semver-diff": {
"version": "2.1.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"semver": "^5.0.3"
},
@@ -7949,24 +8285,27 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/set-blocking": {
"version": "2.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/sha": {
"version": "3.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "(BSD-2-Clause OR MIT)",
+ "peer": true,
"dependencies": {
"graceful-fs": "^4.1.2"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/shebang-command": {
"version": "1.2.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"shebang-regex": "^1.0.0"
},
@@ -7976,33 +8315,37 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/shebang-regex": {
"version": "1.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=0.10.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/signal-exit": {
"version": "3.0.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/slide": {
"version": "1.1.6",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"engines": {
"node": "*"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/smart-buffer": {
"version": "4.1.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">= 6.0.0",
"npm": ">= 3.0.0"
@@ -8010,9 +8353,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/socks": {
"version": "2.3.3",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"ip": "1.1.5",
"smart-buffer": "^4.1.0"
@@ -8024,9 +8368,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/socks-proxy-agent": {
"version": "4.0.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"agent-base": "~4.2.1",
"socks": "~2.3.2"
@@ -8037,9 +8382,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/socks-proxy-agent/node_modules/agent-base": {
"version": "4.2.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"es6-promisify": "^5.0.0"
},
@@ -8049,15 +8395,17 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/sorted-object": {
"version": "2.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "(WTFPL OR MIT)"
+ "license": "(WTFPL OR MIT)",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/sorted-union-stream": {
"version": "2.1.3",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"from2": "^1.3.0",
"stream-iterate": "^1.1.0"
@@ -8065,9 +8413,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/sorted-union-stream/node_modules/from2": {
"version": "1.3.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"inherits": "~2.0.1",
"readable-stream": "~1.1.10"
@@ -8075,15 +8424,17 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/sorted-union-stream/node_modules/isarray": {
"version": "0.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/sorted-union-stream/node_modules/readable-stream": {
"version": "1.1.14",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"core-util-is": "~1.0.0",
"inherits": "~2.0.1",
@@ -8093,15 +8444,17 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/sorted-union-stream/node_modules/string_decoder": {
"version": "0.10.31",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/spdx-correct": {
"version": "3.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "Apache-2.0",
+ "peer": true,
"dependencies": {
"spdx-expression-parse": "^3.0.0",
"spdx-license-ids": "^3.0.0"
@@ -8109,15 +8462,17 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/spdx-exceptions": {
"version": "2.1.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "CC-BY-3.0"
+ "license": "CC-BY-3.0",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/spdx-expression-parse": {
"version": "3.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"spdx-exceptions": "^2.1.0",
"spdx-license-ids": "^3.0.0"
@@ -8125,24 +8480,27 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/spdx-license-ids": {
"version": "3.0.5",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "CC0-1.0"
+ "license": "CC0-1.0",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/split-on-first": {
"version": "1.1.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=6"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/sshpk": {
"version": "1.14.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"asn1": "~0.2.3",
"assert-plus": "^1.0.0",
@@ -8167,18 +8525,20 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/ssri": {
"version": "6.0.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"figgy-pudding": "^3.5.1"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/stream-each": {
"version": "1.2.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"end-of-stream": "^1.1.0",
"stream-shift": "^1.0.0"
@@ -8186,9 +8546,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/stream-iterate": {
"version": "1.2.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"readable-stream": "^2.1.5",
"stream-shift": "^1.0.0"
@@ -8196,9 +8557,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/stream-iterate/node_modules/readable-stream": {
"version": "2.3.6",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"core-util-is": "~1.0.0",
"inherits": "~2.0.3",
@@ -8211,48 +8573,54 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/stream-iterate/node_modules/string_decoder": {
"version": "1.1.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"safe-buffer": "~5.1.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/stream-shift": {
"version": "1.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/strict-uri-encode": {
"version": "2.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=4"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/string_decoder": {
"version": "1.3.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"safe-buffer": "~5.2.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/string_decoder/node_modules/safe-buffer": {
"version": "5.2.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/string-width": {
"version": "2.1.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"is-fullwidth-code-point": "^2.0.0",
"strip-ansi": "^4.0.0"
@@ -8263,27 +8631,30 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/string-width/node_modules/ansi-regex": {
"version": "3.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=4"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/string-width/node_modules/is-fullwidth-code-point": {
"version": "2.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=4"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/string-width/node_modules/strip-ansi": {
"version": "4.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"ansi-regex": "^3.0.0"
},
@@ -8293,15 +8664,17 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/stringify-package": {
"version": "1.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/strip-ansi": {
"version": "3.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"ansi-regex": "^2.0.0"
},
@@ -8311,27 +8684,30 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/strip-eof": {
"version": "1.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=0.10.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/strip-json-comments": {
"version": "2.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=0.10.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/supports-color": {
"version": "5.4.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"has-flag": "^3.0.0"
},
@@ -8341,9 +8717,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/tar": {
"version": "4.4.13",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"chownr": "^1.1.1",
"fs-minipass": "^1.2.5",
@@ -8359,9 +8736,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/tar/node_modules/minipass": {
"version": "2.9.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"safe-buffer": "^5.1.2",
"yallist": "^3.0.0"
@@ -8369,9 +8747,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/term-size": {
"version": "1.2.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"execa": "^0.7.0"
},
@@ -8381,21 +8760,24 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/text-table": {
"version": "0.2.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/through": {
"version": "2.3.8",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/through2": {
"version": "2.0.3",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"readable-stream": "^2.1.5",
"xtend": "~4.0.1"
@@ -8403,9 +8785,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/through2/node_modules/readable-stream": {
"version": "2.3.6",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"core-util-is": "~1.0.0",
"inherits": "~2.0.3",
@@ -8418,33 +8801,37 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/through2/node_modules/string_decoder": {
"version": "1.1.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"safe-buffer": "~5.1.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/timed-out": {
"version": "4.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=0.10.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/tiny-relative-date": {
"version": "1.3.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/tough-cookie": {
"version": "2.4.3",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "BSD-3-Clause",
+ "peer": true,
"dependencies": {
"psl": "^1.1.24",
"punycode": "^1.4.1"
@@ -8455,9 +8842,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/tunnel-agent": {
"version": "0.6.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "Apache-2.0",
+ "peer": true,
"dependencies": {
"safe-buffer": "^5.0.1"
},
@@ -8467,54 +8855,62 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/tweetnacl": {
"version": "0.14.5",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "Unlicense"
+ "license": "Unlicense",
+ "optional": true,
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/typedarray": {
"version": "0.0.6",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/uid-number": {
"version": "0.0.6",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"engines": {
"node": "*"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/umask": {
"version": "1.1.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/unique-filename": {
"version": "1.1.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"unique-slug": "^2.0.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/unique-slug": {
"version": "2.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"imurmurhash": "^0.1.4"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/unique-string": {
"version": "1.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"crypto-random-string": "^1.0.0"
},
@@ -8524,27 +8920,30 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/unpipe": {
"version": "1.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">= 0.8"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/unzip-response": {
"version": "2.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=4"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/update-notifier": {
"version": "2.5.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "BSD-2-Clause",
+ "peer": true,
"dependencies": {
"boxen": "^1.2.1",
"chalk": "^2.0.1",
@@ -8563,27 +8962,30 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/uri-js": {
"version": "4.4.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "BSD-2-Clause",
+ "peer": true,
"dependencies": {
"punycode": "^2.1.0"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/uri-js/node_modules/punycode": {
"version": "2.1.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=6"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/url-parse-lax": {
"version": "1.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"prepend-http": "^1.0.1"
},
@@ -8593,39 +8995,44 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/util-deprecate": {
"version": "1.0.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/util-extend": {
"version": "1.0.3",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "MIT"
+ "license": "MIT",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/util-promisify": {
"version": "2.1.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"object.getownpropertydescriptors": "^2.0.3"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/uuid": {
"version": "3.3.3",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"bin": {
"uuid": "bin/uuid"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/validate-npm-package-license": {
"version": "3.0.4",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "Apache-2.0",
+ "peer": true,
"dependencies": {
"spdx-correct": "^3.0.0",
"spdx-expression-parse": "^3.0.0"
@@ -8633,21 +9040,23 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/validate-npm-package-name": {
"version": "3.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"builtins": "^1.0.3"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/verror": {
"version": "1.10.0",
+ "dev": true,
"engines": [
"node >=0.6.0"
],
- "extraneous": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"assert-plus": "^1.0.0",
"core-util-is": "1.0.2",
@@ -8656,18 +9065,20 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/wcwidth": {
"version": "1.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"defaults": "^1.0.3"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/which": {
"version": "1.3.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"isexe": "^2.0.0"
},
@@ -8677,24 +9088,27 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/which-module": {
"version": "2.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/wide-align": {
"version": "1.1.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"string-width": "^1.0.2"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/wide-align/node_modules/string-width": {
"version": "1.0.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"code-point-at": "^1.0.0",
"is-fullwidth-code-point": "^1.0.0",
@@ -8706,9 +9120,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/widest-line": {
"version": "2.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"string-width": "^2.1.1"
},
@@ -8718,18 +9133,20 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/worker-farm": {
"version": "1.7.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"errno": "~0.1.7"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/wrap-ansi": {
"version": "5.1.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"ansi-styles": "^3.2.0",
"string-width": "^3.0.0",
@@ -8741,27 +9158,30 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/wrap-ansi/node_modules/ansi-regex": {
"version": "4.1.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=6"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/wrap-ansi/node_modules/is-fullwidth-code-point": {
"version": "2.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=4"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/wrap-ansi/node_modules/string-width": {
"version": "3.1.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"emoji-regex": "^7.0.1",
"is-fullwidth-code-point": "^2.0.0",
@@ -8773,9 +9193,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/wrap-ansi/node_modules/strip-ansi": {
"version": "5.2.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"ansi-regex": "^4.1.0"
},
@@ -8785,15 +9206,17 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/wrappy": {
"version": "1.0.2",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/write-file-atomic": {
"version": "2.4.3",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"graceful-fs": "^4.1.11",
"imurmurhash": "^0.1.4",
@@ -8802,39 +9225,44 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/xdg-basedir": {
"version": "3.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=4"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/xtend": {
"version": "4.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=0.4"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/y18n": {
"version": "4.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/yallist": {
"version": "3.0.3",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
- "license": "ISC"
+ "license": "ISC",
+ "peer": true
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/yargs": {
"version": "14.2.3",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"cliui": "^5.0.0",
"decamelize": "^1.2.0",
@@ -8851,9 +9279,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/yargs-parser": {
"version": "15.0.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "ISC",
+ "peer": true,
"dependencies": {
"camelcase": "^5.0.0",
"decamelize": "^1.2.0"
@@ -8861,27 +9290,30 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/yargs-parser/node_modules/camelcase": {
"version": "5.3.1",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=6"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/yargs/node_modules/ansi-regex": {
"version": "4.1.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=6"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/yargs/node_modules/find-up": {
"version": "3.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"locate-path": "^3.0.0"
},
@@ -8891,18 +9323,20 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/yargs/node_modules/is-fullwidth-code-point": {
"version": "2.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=4"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/yargs/node_modules/locate-path": {
"version": "3.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"p-locate": "^3.0.0",
"path-exists": "^3.0.0"
@@ -8913,9 +9347,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/yargs/node_modules/p-limit": {
"version": "2.3.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"p-try": "^2.0.0"
},
@@ -8928,9 +9363,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/yargs/node_modules/p-locate": {
"version": "3.0.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"p-limit": "^2.0.0"
},
@@ -8940,18 +9376,20 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/yargs/node_modules/p-try": {
"version": "2.2.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"engines": {
"node": ">=6"
}
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/yargs/node_modules/string-width": {
"version": "3.1.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"emoji-regex": "^7.0.1",
"is-fullwidth-code-point": "^2.0.0",
@@ -8963,9 +9401,10 @@
},
"node_modules/ep_etherpad-lite/node_modules/npm/node_modules/yargs/node_modules/strip-ansi": {
"version": "5.2.0",
- "extraneous": true,
+ "dev": true,
"inBundle": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"ansi-regex": "^4.1.0"
},
diff --git a/src/static/js/AttributeManager.js b/src/static/js/AttributeManager.js
index f508af64111..5734769f687 100644
--- a/src/static/js/AttributeManager.js
+++ b/src/static/js/AttributeManager.js
@@ -1,23 +1,18 @@
+import AttributeMap from "./AttributeMap.js";
+import * as Changeset from "./Changeset.js";
+import * as ChangesetUtils from "./ChangesetUtils.js";
+import * as attributes from "./attributes.js";
+import * as _ from "./underscore.js";
'use strict';
-
-const AttributeMap = require('./AttributeMap');
-const Changeset = require('./Changeset');
-const ChangesetUtils = require('./ChangesetUtils');
-const attributes = require('./attributes');
-const _ = require('./underscore');
-
const lineMarkerAttribute = 'lmkr';
-
// Some of these attributes are kept for compatibility purposes.
// Not sure if we need all of them
const DEFAULT_LINE_ATTRIBUTES = ['author', 'lmkr', 'insertorder', 'start'];
-
// If one of these attributes are set to the first character of a
// line it is considered as a line attribute marker i.e. attributes
// set on this marker are applied to the whole line.
// The list attribute is only maintained for compatibility reasons
const lineAttributes = [lineMarkerAttribute, 'list'];
-
/*
The Attribute manager builds changesets based on a document
representation for setting and removing range or line-based attributes.
@@ -32,351 +27,318 @@ const lineAttributes = [lineMarkerAttribute, 'list'];
- an Attribute pool `apool`
- a SkipList `lines` containing the text lines of the document.
*/
-
const AttributeManager = function (rep, applyChangesetCallback) {
- this.rep = rep;
- this.applyChangesetCallback = applyChangesetCallback;
- this.author = '';
-
- // If the first char in a line has one of the following attributes
- // it will be considered as a line marker
+ this.rep = rep;
+ this.applyChangesetCallback = applyChangesetCallback;
+ this.author = '';
+ // If the first char in a line has one of the following attributes
+ // it will be considered as a line marker
};
-
AttributeManager.DEFAULT_LINE_ATTRIBUTES = DEFAULT_LINE_ATTRIBUTES;
AttributeManager.lineAttributes = lineAttributes;
-
AttributeManager.prototype = _(AttributeManager.prototype).extend({
-
- applyChangeset(changeset) {
- if (!this.applyChangesetCallback) return changeset;
-
- const cs = changeset.toString();
- if (!Changeset.isIdentity(cs)) {
- this.applyChangesetCallback(cs);
- }
-
- return changeset;
- },
-
- /*
- Sets attributes on a range
- @param start [row, col] tuple pointing to the start of the range
- @param end [row, col] tuple pointing to the end of the range
- @param attribs: an array of attributes
- */
- setAttributesOnRange(start, end, attribs) {
- if (start[0] < 0) throw new RangeError('selection start line number is negative');
- if (start[1] < 0) throw new RangeError('selection start column number is negative');
- if (end[0] < 0) throw new RangeError('selection end line number is negative');
- if (end[1] < 0) throw new RangeError('selection end column number is negative');
- if (start[0] > end[0] || (start[0] === end[0] && start[1] > end[1])) {
- throw new RangeError('selection ends before it starts');
- }
-
- // instead of applying the attributes to the whole range at once, we need to apply them
- // line by line, to be able to disregard the "*" used as line marker. For more details,
- // see https://github.com/ether/etherpad-lite/issues/2772
- let allChangesets;
- for (let row = start[0]; row <= end[0]; row++) {
- const [startCol, endCol] = this._findRowRange(row, start, end);
- const rowChangeset = this._setAttributesOnRangeByLine(row, startCol, endCol, attribs);
-
- // compose changesets of all rows into a single changeset
- // as the range might not be continuous
- // due to the presence of line markers on the rows
- if (allChangesets) {
- allChangesets = Changeset.compose(
- allChangesets.toString(), rowChangeset.toString(), this.rep.apool);
- } else {
- allChangesets = rowChangeset;
- }
- }
-
- return this.applyChangeset(allChangesets);
- },
-
- _findRowRange(row, start, end) {
- if (row < start[0] || row > end[0]) throw new RangeError(`line ${row} not in selection`);
- if (row >= this.rep.lines.length()) throw new RangeError(`selected line ${row} does not exist`);
-
- // Subtract 1 for the end-of-line '\n' (it is never selected).
- const lineLength =
- this.rep.lines.offsetOfIndex(row + 1) - this.rep.lines.offsetOfIndex(row) - 1;
- const markerWidth = this.lineHasMarker(row) ? 1 : 0;
- if (lineLength - markerWidth < 0) throw new Error(`line ${row} has negative length`);
-
- if (start[1] < 0) throw new RangeError('selection starts at negative column');
- const startCol = Math.max(markerWidth, row === start[0] ? start[1] : 0);
- if (startCol > lineLength) throw new RangeError('selection starts after line end');
-
- if (end[1] < 0) throw new RangeError('selection ends at negative column');
- const endCol = Math.max(markerWidth, row === end[0] ? end[1] : lineLength);
- if (endCol > lineLength) throw new RangeError('selection ends after line end');
- if (startCol > endCol) throw new RangeError('selection ends before it starts');
-
- return [startCol, endCol];
- },
-
- /**
- * Sets attributes on a range, by line
- * @param row the row where range is
- * @param startCol column where range starts
- * @param endCol column where range ends (one past the last selected column)
- * @param attribs an array of attributes
- */
- _setAttributesOnRangeByLine(row, startCol, endCol, attribs) {
- const builder = Changeset.builder(this.rep.lines.totalWidth());
- ChangesetUtils.buildKeepToStartOfRange(this.rep, builder, [row, startCol]);
- ChangesetUtils.buildKeepRange(
- this.rep, builder, [row, startCol], [row, endCol], attribs, this.rep.apool);
- return builder;
- },
-
- /*
- Returns if the line already has a line marker
- @param lineNum: the number of the line
- */
- lineHasMarker(lineNum) {
- return lineAttributes.find(
- (attribute) => this.getAttributeOnLine(lineNum, attribute) !== '') !== undefined;
- },
-
- /*
- Gets a specified attribute on a line
- @param lineNum: the number of the line to set the attribute for
- @param attributeKey: the name of the attribute to get, e.g. list
- */
- getAttributeOnLine(lineNum, attributeName) {
- // get `attributeName` attribute of first char of line
- const aline = this.rep.alines[lineNum];
- if (!aline) return '';
- const [op] = Changeset.deserializeOps(aline);
- if (op == null) return '';
- return AttributeMap.fromString(op.attribs, this.rep.apool).get(attributeName) || '';
- },
-
- /*
- Gets all attributes on a line
- @param lineNum: the number of the line to get the attribute for
- */
- getAttributesOnLine(lineNum) {
- // get attributes of first char of line
- const aline = this.rep.alines[lineNum];
- if (!aline) return [];
- const [op] = Changeset.deserializeOps(aline);
- if (op == null) return [];
- return [...attributes.attribsFromString(op.attribs, this.rep.apool)];
- },
-
- /*
- Gets a given attribute on a selection
- @param attributeName
- @param prevChar
- returns true or false if an attribute is visible in range
- */
- getAttributeOnSelection(attributeName, prevChar) {
- const rep = this.rep;
- if (!(rep.selStart && rep.selEnd)) return;
- // If we're looking for the caret attribute not the selection
- // has the user already got a selection or is this purely a caret location?
- const isNotSelection = (rep.selStart[0] === rep.selEnd[0] && rep.selEnd[1] === rep.selStart[1]);
- if (isNotSelection) {
- if (prevChar) {
- // If it's not the start of the line
- if (rep.selStart[1] !== 0) {
- rep.selStart[1]--;
+ applyChangeset(changeset) {
+ if (!this.applyChangesetCallback)
+ return changeset;
+ const cs = changeset.toString();
+ if (!Changeset.isIdentity(cs)) {
+ this.applyChangesetCallback(cs);
}
- }
- }
-
- const withIt = new AttributeMap(rep.apool).set(attributeName, 'true').toString();
- const withItRegex = new RegExp(`${withIt.replace(/\*/g, '\\*')}(\\*|$)`);
- const hasIt = (attribs) => withItRegex.test(attribs);
-
- const rangeHasAttrib = (selStart, selEnd) => {
- // if range is collapsed -> no attribs in range
- if (selStart[1] === selEnd[1] && selStart[0] === selEnd[0]) return false;
-
- if (selStart[0] !== selEnd[0]) { // -> More than one line selected
- // from selStart to the end of the first line
- let hasAttrib = rangeHasAttrib(
- selStart, [selStart[0], rep.lines.atIndex(selStart[0]).text.length]);
-
- // for all lines in between
- for (let n = selStart[0] + 1; n < selEnd[0]; n++) {
- hasAttrib = hasAttrib && rangeHasAttrib([n, 0], [n, rep.lines.atIndex(n).text.length]);
+ return changeset;
+ },
+ /*
+ Sets attributes on a range
+ @param start [row, col] tuple pointing to the start of the range
+ @param end [row, col] tuple pointing to the end of the range
+ @param attribs: an array of attributes
+ */
+ setAttributesOnRange(start, end, attribs) {
+ if (start[0] < 0)
+ throw new RangeError('selection start line number is negative');
+ if (start[1] < 0)
+ throw new RangeError('selection start column number is negative');
+ if (end[0] < 0)
+ throw new RangeError('selection end line number is negative');
+ if (end[1] < 0)
+ throw new RangeError('selection end column number is negative');
+ if (start[0] > end[0] || (start[0] === end[0] && start[1] > end[1])) {
+ throw new RangeError('selection ends before it starts');
}
-
- // for the last, potentially partial, line
- hasAttrib = hasAttrib && rangeHasAttrib([selEnd[0], 0], [selEnd[0], selEnd[1]]);
-
- return hasAttrib;
- }
-
- // Logic tells us we now have a range on a single line
-
- const lineNum = selStart[0];
- const start = selStart[1];
- const end = selEnd[1];
- let hasAttrib = true;
-
- let indexIntoLine = 0;
- for (const op of Changeset.deserializeOps(rep.alines[lineNum])) {
- const opStartInLine = indexIntoLine;
- const opEndInLine = opStartInLine + op.chars;
- if (!hasIt(op.attribs)) {
- // does op overlap selection?
- if (!(opEndInLine <= start || opStartInLine >= end)) {
- // since it's overlapping but hasn't got the attrib -> range hasn't got it
- hasAttrib = false;
- break;
- }
+ // instead of applying the attributes to the whole range at once, we need to apply them
+ // line by line, to be able to disregard the "*" used as line marker. For more details,
+ // see https://github.com/ether/etherpad-lite/issues/2772
+ let allChangesets;
+ for (let row = start[0]; row <= end[0]; row++) {
+ const [startCol, endCol] = this._findRowRange(row, start, end);
+ const rowChangeset = this._setAttributesOnRangeByLine(row, startCol, endCol, attribs);
+ // compose changesets of all rows into a single changeset
+ // as the range might not be continuous
+ // due to the presence of line markers on the rows
+ if (allChangesets) {
+ allChangesets = Changeset.compose(allChangesets.toString(), rowChangeset.toString(), this.rep.apool);
+ }
+ else {
+ allChangesets = rowChangeset;
+ }
}
- indexIntoLine = opEndInLine;
- }
-
- return hasAttrib;
- };
- return rangeHasAttrib(rep.selStart, rep.selEnd);
- },
-
- /*
- Gets all attributes at a position containing line number and column
- @param lineNumber starting with zero
- @param column starting with zero
- returns a list of attributes in the format
- [ ["key","value"], ["key","value"], ... ]
- */
- getAttributesOnPosition(lineNumber, column) {
- // get all attributes of the line
- const aline = this.rep.alines[lineNumber];
-
- if (!aline) {
- return [];
- }
-
- // we need to sum up how much characters each operations take until the wanted position
- let currentPointer = 0;
-
- for (const currentOperation of Changeset.deserializeOps(aline)) {
- currentPointer += currentOperation.chars;
- if (currentPointer <= column) continue;
- return [...attributes.attribsFromString(currentOperation.attribs, this.rep.apool)];
- }
- return [];
- },
-
- /*
- Gets all attributes at caret position
- if the user selected a range, the start of the selection is taken
- returns a list of attributes in the format
- [ ["key","value"], ["key","value"], ... ]
- */
- getAttributesOnCaret() {
- return this.getAttributesOnPosition(this.rep.selStart[0], this.rep.selStart[1]);
- },
-
- /*
- Sets a specified attribute on a line
- @param lineNum: the number of the line to set the attribute for
- @param attributeKey: the name of the attribute to set, e.g. list
- @param attributeValue: an optional parameter to pass to the attribute (e.g. indention level)
-
- */
- setAttributeOnLine(lineNum, attributeName, attributeValue) {
- let loc = [0, 0];
- const builder = Changeset.builder(this.rep.lines.totalWidth());
- const hasMarker = this.lineHasMarker(lineNum);
-
- ChangesetUtils.buildKeepRange(this.rep, builder, loc, (loc = [lineNum, 0]));
-
- if (hasMarker) {
- ChangesetUtils.buildKeepRange(this.rep, builder, loc, (loc = [lineNum, 1]), [
- [attributeName, attributeValue],
- ], this.rep.apool);
- } else {
- // add a line marker
- builder.insert('*', [
- ['author', this.author],
- ['insertorder', 'first'],
- [lineMarkerAttribute, '1'],
- [attributeName, attributeValue],
- ], this.rep.apool);
- }
-
- return this.applyChangeset(builder);
- },
-
- /**
- * Removes a specified attribute on a line
- * @param lineNum the number of the affected line
- * @param attributeName the name of the attribute to remove, e.g. list
- * @param attributeValue if given only attributes with equal value will be removed
- */
- removeAttributeOnLine(lineNum, attributeName, attributeValue) {
- const builder = Changeset.builder(this.rep.lines.totalWidth());
- const hasMarker = this.lineHasMarker(lineNum);
- let found = false;
-
- const attribs = this.getAttributesOnLine(lineNum).map((attrib) => {
- if (attrib[0] === attributeName && (!attributeValue || attrib[0] === attributeValue)) {
- found = true;
- return [attrib[0], ''];
- } else if (attrib[0] === 'author') {
- // update last author to make changes to line attributes on this line
- return [attrib[0], this.author];
- }
- return attrib;
- });
-
- if (!found) {
- return;
- }
-
- ChangesetUtils.buildKeepToStartOfRange(this.rep, builder, [lineNum, 0]);
-
- const countAttribsWithMarker = _.chain(attribs).filter((a) => !!a[1])
- .map((a) => a[0]).difference(DEFAULT_LINE_ATTRIBUTES).size().value();
-
- // if we have marker and any of attributes don't need to have marker. we need delete it
- if (hasMarker && !countAttribsWithMarker) {
- ChangesetUtils.buildRemoveRange(this.rep, builder, [lineNum, 0], [lineNum, 1]);
- } else {
- ChangesetUtils.buildKeepRange(
- this.rep, builder, [lineNum, 0], [lineNum, 1], attribs, this.rep.apool);
- }
-
- return this.applyChangeset(builder);
- },
-
- /*
- Toggles a line attribute for the specified line number
- If a line attribute with the specified name exists with any value it will be removed
- Otherwise it will be set to the given value
- @param lineNum: the number of the line to toggle the attribute for
- @param attributeKey: the name of the attribute to toggle, e.g. list
- @param attributeValue: the value to pass to the attribute (e.g. indention level)
- */
- toggleAttributeOnLine(lineNum, attributeName, attributeValue) {
- return this.getAttributeOnLine(lineNum, attributeName)
- ? this.removeAttributeOnLine(lineNum, attributeName)
- : this.setAttributeOnLine(lineNum, attributeName, attributeValue);
- },
-
- hasAttributeOnSelectionOrCaretPosition(attributeName) {
- const hasSelection = (
- (this.rep.selStart[0] !== this.rep.selEnd[0]) || (this.rep.selEnd[1] !== this.rep.selStart[1])
- );
- let hasAttrib;
- if (hasSelection) {
- hasAttrib = this.getAttributeOnSelection(attributeName);
- } else {
- const attributesOnCaretPosition = this.getAttributesOnCaret();
- const allAttribs = [].concat(...attributesOnCaretPosition); // flatten
- hasAttrib = allAttribs.includes(attributeName);
- }
- return hasAttrib;
- },
+ return this.applyChangeset(allChangesets);
+ },
+ _findRowRange(row, start, end) {
+ if (row < start[0] || row > end[0])
+ throw new RangeError(`line ${row} not in selection`);
+ if (row >= this.rep.lines.length())
+ throw new RangeError(`selected line ${row} does not exist`);
+ // Subtract 1 for the end-of-line '\n' (it is never selected).
+ const lineLength = this.rep.lines.offsetOfIndex(row + 1) - this.rep.lines.offsetOfIndex(row) - 1;
+ const markerWidth = this.lineHasMarker(row) ? 1 : 0;
+ if (lineLength - markerWidth < 0)
+ throw new Error(`line ${row} has negative length`);
+ if (start[1] < 0)
+ throw new RangeError('selection starts at negative column');
+ const startCol = Math.max(markerWidth, row === start[0] ? start[1] : 0);
+ if (startCol > lineLength)
+ throw new RangeError('selection starts after line end');
+ if (end[1] < 0)
+ throw new RangeError('selection ends at negative column');
+ const endCol = Math.max(markerWidth, row === end[0] ? end[1] : lineLength);
+ if (endCol > lineLength)
+ throw new RangeError('selection ends after line end');
+ if (startCol > endCol)
+ throw new RangeError('selection ends before it starts');
+ return [startCol, endCol];
+ },
+ /**
+ * Sets attributes on a range, by line
+ * @param row the row where range is
+ * @param startCol column where range starts
+ * @param endCol column where range ends (one past the last selected column)
+ * @param attribs an array of attributes
+ */
+ _setAttributesOnRangeByLine(row, startCol, endCol, attribs) {
+ const builder = Changeset.builder(this.rep.lines.totalWidth());
+ ChangesetUtils.buildKeepToStartOfRange(this.rep, builder, [row, startCol]);
+ ChangesetUtils.buildKeepRange(this.rep, builder, [row, startCol], [row, endCol], attribs, this.rep.apool);
+ return builder;
+ },
+ /*
+ Returns if the line already has a line marker
+ @param lineNum: the number of the line
+ */
+ lineHasMarker(lineNum) {
+ return lineAttributes.find((attribute) => this.getAttributeOnLine(lineNum, attribute) !== '') !== undefined;
+ },
+ /*
+ Gets a specified attribute on a line
+ @param lineNum: the number of the line to set the attribute for
+ @param attributeKey: the name of the attribute to get, e.g. list
+ */
+ getAttributeOnLine(lineNum, attributeName) {
+ // get `attributeName` attribute of first char of line
+ const aline = this.rep.alines[lineNum];
+ if (!aline)
+ return '';
+ const [op] = Changeset.deserializeOps(aline);
+ if (op == null)
+ return '';
+ return AttributeMap.fromString(op.attribs, this.rep.apool).get(attributeName) || '';
+ },
+ /*
+ Gets all attributes on a line
+ @param lineNum: the number of the line to get the attribute for
+ */
+ getAttributesOnLine(lineNum) {
+ // get attributes of first char of line
+ const aline = this.rep.alines[lineNum];
+ if (!aline)
+ return [];
+ const [op] = Changeset.deserializeOps(aline);
+ if (op == null)
+ return [];
+ return [...attributes.attribsFromString(op.attribs, this.rep.apool)];
+ },
+ /*
+ Gets a given attribute on a selection
+ @param attributeName
+ @param prevChar
+ returns true or false if an attribute is visible in range
+ */
+ getAttributeOnSelection(attributeName, prevChar) {
+ const rep = this.rep;
+ if (!(rep.selStart && rep.selEnd))
+ return;
+ // If we're looking for the caret attribute not the selection
+ // has the user already got a selection or is this purely a caret location?
+ const isNotSelection = (rep.selStart[0] === rep.selEnd[0] && rep.selEnd[1] === rep.selStart[1]);
+ if (isNotSelection) {
+ if (prevChar) {
+ // If it's not the start of the line
+ if (rep.selStart[1] !== 0) {
+ rep.selStart[1]--;
+ }
+ }
+ }
+ const withIt = new AttributeMap(rep.apool).set(attributeName, 'true').toString();
+ const withItRegex = new RegExp(`${withIt.replace(/\*/g, '\\*')}(\\*|$)`);
+ const hasIt = (attribs) => withItRegex.test(attribs);
+ const rangeHasAttrib = (selStart, selEnd) => {
+ // if range is collapsed -> no attribs in range
+ if (selStart[1] === selEnd[1] && selStart[0] === selEnd[0])
+ return false;
+ if (selStart[0] !== selEnd[0]) { // -> More than one line selected
+ // from selStart to the end of the first line
+ let hasAttrib = rangeHasAttrib(selStart, [selStart[0], rep.lines.atIndex(selStart[0]).text.length]);
+ // for all lines in between
+ for (let n = selStart[0] + 1; n < selEnd[0]; n++) {
+ hasAttrib = hasAttrib && rangeHasAttrib([n, 0], [n, rep.lines.atIndex(n).text.length]);
+ }
+ // for the last, potentially partial, line
+ hasAttrib = hasAttrib && rangeHasAttrib([selEnd[0], 0], [selEnd[0], selEnd[1]]);
+ return hasAttrib;
+ }
+ // Logic tells us we now have a range on a single line
+ const lineNum = selStart[0];
+ const start = selStart[1];
+ const end = selEnd[1];
+ let hasAttrib = true;
+ let indexIntoLine = 0;
+ for (const op of Changeset.deserializeOps(rep.alines[lineNum])) {
+ const opStartInLine = indexIntoLine;
+ const opEndInLine = opStartInLine + op.chars;
+ if (!hasIt(op.attribs)) {
+ // does op overlap selection?
+ if (!(opEndInLine <= start || opStartInLine >= end)) {
+ // since it's overlapping but hasn't got the attrib -> range hasn't got it
+ hasAttrib = false;
+ break;
+ }
+ }
+ indexIntoLine = opEndInLine;
+ }
+ return hasAttrib;
+ };
+ return rangeHasAttrib(rep.selStart, rep.selEnd);
+ },
+ /*
+ Gets all attributes at a position containing line number and column
+ @param lineNumber starting with zero
+ @param column starting with zero
+ returns a list of attributes in the format
+ [ ["key","value"], ["key","value"], ... ]
+ */
+ getAttributesOnPosition(lineNumber, column) {
+ // get all attributes of the line
+ const aline = this.rep.alines[lineNumber];
+ if (!aline) {
+ return [];
+ }
+ // we need to sum up how much characters each operations take until the wanted position
+ let currentPointer = 0;
+ for (const currentOperation of Changeset.deserializeOps(aline)) {
+ currentPointer += currentOperation.chars;
+ if (currentPointer <= column)
+ continue;
+ return [...attributes.attribsFromString(currentOperation.attribs, this.rep.apool)];
+ }
+ return [];
+ },
+ /*
+ Gets all attributes at caret position
+ if the user selected a range, the start of the selection is taken
+ returns a list of attributes in the format
+ [ ["key","value"], ["key","value"], ... ]
+ */
+ getAttributesOnCaret() {
+ return this.getAttributesOnPosition(this.rep.selStart[0], this.rep.selStart[1]);
+ },
+ /*
+ Sets a specified attribute on a line
+ @param lineNum: the number of the line to set the attribute for
+ @param attributeKey: the name of the attribute to set, e.g. list
+ @param attributeValue: an optional parameter to pass to the attribute (e.g. indention level)
+
+ */
+ setAttributeOnLine(lineNum, attributeName, attributeValue) {
+ let loc = [0, 0];
+ const builder = Changeset.builder(this.rep.lines.totalWidth());
+ const hasMarker = this.lineHasMarker(lineNum);
+ ChangesetUtils.buildKeepRange(this.rep, builder, loc, (loc = [lineNum, 0]));
+ if (hasMarker) {
+ ChangesetUtils.buildKeepRange(this.rep, builder, loc, (loc = [lineNum, 1]), [
+ [attributeName, attributeValue],
+ ], this.rep.apool);
+ }
+ else {
+ // add a line marker
+ builder.insert('*', [
+ ['author', this.author],
+ ['insertorder', 'first'],
+ [lineMarkerAttribute, '1'],
+ [attributeName, attributeValue],
+ ], this.rep.apool);
+ }
+ return this.applyChangeset(builder);
+ },
+ /**
+ * Removes a specified attribute on a line
+ * @param lineNum the number of the affected line
+ * @param attributeName the name of the attribute to remove, e.g. list
+ * @param attributeValue if given only attributes with equal value will be removed
+ */
+ removeAttributeOnLine(lineNum, attributeName, attributeValue) {
+ const builder = Changeset.builder(this.rep.lines.totalWidth());
+ const hasMarker = this.lineHasMarker(lineNum);
+ let found = false;
+ const attribs = this.getAttributesOnLine(lineNum).map((attrib) => {
+ if (attrib[0] === attributeName && (!attributeValue || attrib[0] === attributeValue)) {
+ found = true;
+ return [attrib[0], ''];
+ }
+ else if (attrib[0] === 'author') {
+ // update last author to make changes to line attributes on this line
+ return [attrib[0], this.author];
+ }
+ return attrib;
+ });
+ if (!found) {
+ return;
+ }
+ ChangesetUtils.buildKeepToStartOfRange(this.rep, builder, [lineNum, 0]);
+ const countAttribsWithMarker = _.chain(attribs).filter((a) => !!a[1])
+ .map((a) => a[0]).difference(DEFAULT_LINE_ATTRIBUTES).size().value();
+ // if we have marker and any of attributes don't need to have marker. we need delete it
+ if (hasMarker && !countAttribsWithMarker) {
+ ChangesetUtils.buildRemoveRange(this.rep, builder, [lineNum, 0], [lineNum, 1]);
+ }
+ else {
+ ChangesetUtils.buildKeepRange(this.rep, builder, [lineNum, 0], [lineNum, 1], attribs, this.rep.apool);
+ }
+ return this.applyChangeset(builder);
+ },
+ /*
+ Toggles a line attribute for the specified line number
+ If a line attribute with the specified name exists with any value it will be removed
+ Otherwise it will be set to the given value
+ @param lineNum: the number of the line to toggle the attribute for
+ @param attributeKey: the name of the attribute to toggle, e.g. list
+ @param attributeValue: the value to pass to the attribute (e.g. indention level)
+ */
+ toggleAttributeOnLine(lineNum, attributeName, attributeValue) {
+ return this.getAttributeOnLine(lineNum, attributeName)
+ ? this.removeAttributeOnLine(lineNum, attributeName)
+ : this.setAttributeOnLine(lineNum, attributeName, attributeValue);
+ },
+ hasAttributeOnSelectionOrCaretPosition(attributeName) {
+ const hasSelection = ((this.rep.selStart[0] !== this.rep.selEnd[0]) || (this.rep.selEnd[1] !== this.rep.selStart[1]));
+ let hasAttrib;
+ if (hasSelection) {
+ hasAttrib = this.getAttributeOnSelection(attributeName);
+ }
+ else {
+ const attributesOnCaretPosition = this.getAttributesOnCaret();
+ const allAttribs = [].concat(...attributesOnCaretPosition); // flatten
+ hasAttrib = allAttribs.includes(attributeName);
+ }
+ return hasAttrib;
+ },
});
-
-module.exports = AttributeManager;
+export default AttributeManager;
diff --git a/src/static/js/AttributeMap.js b/src/static/js/AttributeMap.js
index 55640eb8bc6..4e55eb8a71f 100644
--- a/src/static/js/AttributeMap.js
+++ b/src/static/js/AttributeMap.js
@@ -1,13 +1,10 @@
+import * as attributes from "./attributes.js";
'use strict';
-
-const attributes = require('./attributes');
-
/**
* A `[key, value]` pair of strings describing a text attribute.
*
* @typedef {[string, string]} Attribute
*/
-
/**
* A concatenated sequence of zero or more attribute identifiers, each one represented by an
* asterisk followed by a base-36 encoded attribute number.
@@ -16,76 +13,70 @@ const attributes = require('./attributes');
*
* @typedef {string} AttributeString
*/
-
/**
* Convenience class to convert an Op's attribute string to/from a Map of key, value pairs.
*/
class AttributeMap extends Map {
- /**
- * Converts an attribute string into an AttributeMap.
- *
- * @param {AttributeString} str - The attribute string to convert into an AttributeMap.
- * @param {AttributePool} pool - Attribute pool.
- * @returns {AttributeMap}
- */
- static fromString(str, pool) {
- return new AttributeMap(pool).updateFromString(str);
- }
-
- /**
- * @param {AttributePool} pool - Attribute pool.
- */
- constructor(pool) {
- super();
- /** @public */
- this.pool = pool;
- }
-
- /**
- * @param {string} k - Attribute name.
- * @param {string} v - Attribute value.
- * @returns {AttributeMap} `this` (for chaining).
- */
- set(k, v) {
- k = k == null ? '' : String(k);
- v = v == null ? '' : String(v);
- this.pool.putAttrib([k, v]);
- return super.set(k, v);
- }
-
- toString() {
- return attributes.attribsToString(attributes.sort([...this]), this.pool);
- }
-
- /**
- * @param {Iterable} entries - [key, value] pairs to insert into this map.
- * @param {boolean} [emptyValueIsDelete] - If true and an entry's value is the empty string, the
- * key is removed from this map (if present).
- * @returns {AttributeMap} `this` (for chaining).
- */
- update(entries, emptyValueIsDelete = false) {
- for (let [k, v] of entries) {
- k = k == null ? '' : String(k);
- v = v == null ? '' : String(v);
- if (!v && emptyValueIsDelete) {
- this.delete(k);
- } else {
- this.set(k, v);
- }
+ /**
+ * Converts an attribute string into an AttributeMap.
+ *
+ * @param {AttributeString} str - The attribute string to convert into an AttributeMap.
+ * @param {AttributePool} pool - Attribute pool.
+ * @returns {AttributeMap}
+ */
+ static fromString(str, pool) {
+ return new AttributeMap(pool).updateFromString(str);
+ }
+ /**
+ * @param {AttributePool} pool - Attribute pool.
+ */
+ constructor(pool) {
+ super();
+ /** @public */
+ this.pool = pool;
+ }
+ /**
+ * @param {string} k - Attribute name.
+ * @param {string} v - Attribute value.
+ * @returns {AttributeMap} `this` (for chaining).
+ */
+ set(k, v) {
+ k = k == null ? '' : String(k);
+ v = v == null ? '' : String(v);
+ this.pool.putAttrib([k, v]);
+ return super.set(k, v);
+ }
+ toString() {
+ return attributes.attribsToString(attributes.sort([...this]), this.pool);
+ }
+ /**
+ * @param {Iterable} entries - [key, value] pairs to insert into this map.
+ * @param {boolean} [emptyValueIsDelete] - If true and an entry's value is the empty string, the
+ * key is removed from this map (if present).
+ * @returns {AttributeMap} `this` (for chaining).
+ */
+ update(entries, emptyValueIsDelete = false) {
+ for (let [k, v] of entries) {
+ k = k == null ? '' : String(k);
+ v = v == null ? '' : String(v);
+ if (!v && emptyValueIsDelete) {
+ this.delete(k);
+ }
+ else {
+ this.set(k, v);
+ }
+ }
+ return this;
+ }
+ /**
+ * @param {AttributeString} str - The attribute string identifying the attributes to insert into
+ * this map.
+ * @param {boolean} [emptyValueIsDelete] - If true and an entry's value is the empty string, the
+ * key is removed from this map (if present).
+ * @returns {AttributeMap} `this` (for chaining).
+ */
+ updateFromString(str, emptyValueIsDelete = false) {
+ return this.update(attributes.attribsFromString(str, this.pool), emptyValueIsDelete);
}
- return this;
- }
-
- /**
- * @param {AttributeString} str - The attribute string identifying the attributes to insert into
- * this map.
- * @param {boolean} [emptyValueIsDelete] - If true and an entry's value is the empty string, the
- * key is removed from this map (if present).
- * @returns {AttributeMap} `this` (for chaining).
- */
- updateFromString(str, emptyValueIsDelete = false) {
- return this.update(attributes.attribsFromString(str, this.pool), emptyValueIsDelete);
- }
}
-
-module.exports = AttributeMap;
+export default AttributeMap;
diff --git a/src/static/js/Changeset.js b/src/static/js/Changeset.js
index 614d820615c..c6fa8402ecb 100644
--- a/src/static/js/Changeset.js
+++ b/src/static/js/Changeset.js
@@ -22,9 +22,9 @@ import { padutils } from "./pad_utils.js";
* @param {string} msg - Just some message
*/
const error = (msg) => {
- const e = new Error(msg);
- e.easysync = true;
- throw e;
+ const e = new Error(msg);
+ e.easysync = true;
+ throw e;
};
/**
* Assert that a condition is truthy. If the condition is falsy, the `error` function is called to
@@ -35,75 +35,75 @@ const error = (msg) => {
* @type {(b: boolean, msg: string) => asserts b}
*/
const assert = (b, msg) => {
- if (!b)
- error(`Failed assertion: ${msg}`);
+ if (!b)
+ error(`Failed assertion: ${msg}`);
};
/**
* An operation to apply to a shared document.
*/
class Op {
- /**
- * @param {(''|'='|'+'|'-')} [opcode=''] - Initial value of the `opcode` property.
- */
- constructor(opcode = '') {
/**
- * The operation's operator:
- * - '=': Keep the next `chars` characters (containing `lines` newlines) from the base
- * document.
- * - '-': Remove the next `chars` characters (containing `lines` newlines) from the base
- * document.
- * - '+': Insert `chars` characters (containing `lines` newlines) at the current position in
- * the document. The inserted characters come from the changeset's character bank.
- * - '' (empty string): Invalid operator used in some contexts to signifiy the lack of an
- * operation.
- *
- * @type {(''|'='|'+'|'-')}
- * @public
- */
- this.opcode = opcode;
- /**
- * The number of characters to keep, insert, or delete.
- *
- * @type {number}
- * @public
- */
- this.chars = 0;
- /**
- * The number of characters among the `chars` characters that are newlines. If non-zero, the
- * last character must be a newline.
- *
- * @type {number}
- * @public
- */
- this.lines = 0;
- /**
- * Identifiers of attributes to apply to the text, represented as a repeated (zero or more)
- * sequence of asterisk followed by a non-negative base-36 (lower-case) integer. For example,
- * '*2*1o' indicates that attributes 2 and 60 apply to the text affected by the operation. The
- * identifiers come from the document's attribute pool.
- *
- * For keep ('=') operations, the attributes are merged with the base text's existing
- * attributes:
- * - A keep op attribute with a non-empty value replaces an existing base text attribute that
- * has the same key.
- * - A keep op attribute with an empty value is interpreted as an instruction to remove an
- * existing base text attribute that has the same key, if one exists.
- *
- * This is the empty string for remove ('-') operations.
- *
- * @type {string}
- * @public
+ * @param {(''|'='|'+'|'-')} [opcode=''] - Initial value of the `opcode` property.
*/
- this.attribs = '';
- }
- toString() {
- if (!this.opcode)
- throw new TypeError('null op');
- if (typeof this.attribs !== 'string')
- throw new TypeError('attribs must be a string');
- const l = this.lines ? `|${exports.numToString(this.lines)}` : '';
- return this.attribs + l + this.opcode + exports.numToString(this.chars);
- }
+ constructor(opcode = '') {
+ /**
+ * The operation's operator:
+ * - '=': Keep the next `chars` characters (containing `lines` newlines) from the base
+ * document.
+ * - '-': Remove the next `chars` characters (containing `lines` newlines) from the base
+ * document.
+ * - '+': Insert `chars` characters (containing `lines` newlines) at the current position in
+ * the document. The inserted characters come from the changeset's character bank.
+ * - '' (empty string): Invalid operator used in some contexts to signifiy the lack of an
+ * operation.
+ *
+ * @type {(''|'='|'+'|'-')}
+ * @public
+ */
+ this.opcode = opcode;
+ /**
+ * The number of characters to keep, insert, or delete.
+ *
+ * @type {number}
+ * @public
+ */
+ this.chars = 0;
+ /**
+ * The number of characters among the `chars` characters that are newlines. If non-zero, the
+ * last character must be a newline.
+ *
+ * @type {number}
+ * @public
+ */
+ this.lines = 0;
+ /**
+ * Identifiers of attributes to apply to the text, represented as a repeated (zero or more)
+ * sequence of asterisk followed by a non-negative base-36 (lower-case) integer. For example,
+ * '*2*1o' indicates that attributes 2 and 60 apply to the text affected by the operation. The
+ * identifiers come from the document's attribute pool.
+ *
+ * For keep ('=') operations, the attributes are merged with the base text's existing
+ * attributes:
+ * - A keep op attribute with a non-empty value replaces an existing base text attribute that
+ * has the same key.
+ * - A keep op attribute with an empty value is interpreted as an instruction to remove an
+ * existing base text attribute that has the same key, if one exists.
+ *
+ * This is the empty string for remove ('-') operations.
+ *
+ * @type {string}
+ * @public
+ */
+ this.attribs = '';
+ }
+ toString() {
+ if (!this.opcode)
+ throw new TypeError('null op');
+ if (typeof this.attribs !== 'string')
+ throw new TypeError('attribs must be a string');
+ const l = this.lines ? `|${exports.numToString(this.lines)}` : '';
+ return this.attribs + l + this.opcode + exports.numToString(this.chars);
+ }
}
/**
* Iterator over a changeset's operations.
@@ -113,38 +113,38 @@ class Op {
* @deprecated Use `deserializeOps` instead.
*/
class OpIter {
- /**
- * @param {string} ops - String encoding the change operations to iterate over.
- */
- constructor(ops) {
- this._gen = exports.deserializeOps(ops);
- this._next = this._gen.next();
- }
- /**
- * @returns {boolean} Whether there are any remaining operations.
- */
- hasNext() {
- return !this._next.done;
- }
- /**
- * Returns the next operation object and advances the iterator.
- *
- * Note: This does NOT implement the ECMAScript iterator protocol.
- *
- * @param {Op} [opOut] - Deprecated. Operation object to recycle for the return value.
- * @returns {Op} The next operation, or an operation with a falsy `opcode` property if there are
- * no more operations.
- */
- next(opOut = new Op()) {
- if (this.hasNext()) {
- copyOp(this._next.value, opOut);
- this._next = this._gen.next();
+ /**
+ * @param {string} ops - String encoding the change operations to iterate over.
+ */
+ constructor(ops) {
+ this._gen = exports.deserializeOps(ops);
+ this._next = this._gen.next();
}
- else {
- clearOp(opOut);
+ /**
+ * @returns {boolean} Whether there are any remaining operations.
+ */
+ hasNext() {
+ return !this._next.done;
+ }
+ /**
+ * Returns the next operation object and advances the iterator.
+ *
+ * Note: This does NOT implement the ECMAScript iterator protocol.
+ *
+ * @param {Op} [opOut] - Deprecated. Operation object to recycle for the return value.
+ * @returns {Op} The next operation, or an operation with a falsy `opcode` property if there are
+ * no more operations.
+ */
+ next(opOut = new Op()) {
+ if (this.hasNext()) {
+ copyOp(this._next.value, opOut);
+ this._next = this._gen.next();
+ }
+ else {
+ clearOp(opOut);
+ }
+ return opOut;
}
- return opOut;
- }
}
/**
* Cleans an Op object.
@@ -152,10 +152,10 @@ class OpIter {
* @param {Op} op - object to clear
*/
const clearOp = (op) => {
- op.opcode = '';
- op.chars = 0;
- op.lines = 0;
- op.attribs = '';
+ op.opcode = '';
+ op.chars = 0;
+ op.lines = 0;
+ op.attribs = '';
};
/**
* Copies op1 to op2
@@ -198,24 +198,24 @@ const copyOp = (op1, op2 = new Op()) => Object.assign(op2, op1);
* @returns {Generator}
*/
const opsFromText = function* (opcode, text, attribs = '', pool = null) {
- const op = new Op(opcode);
- op.attribs = typeof attribs === 'string'
- ? attribs : new AttributeMap(pool).update(attribs || [], opcode === '+').toString();
- const lastNewlinePos = text.lastIndexOf('\n');
- if (lastNewlinePos < 0) {
- op.chars = text.length;
- op.lines = 0;
- yield op;
- }
- else {
- op.chars = lastNewlinePos + 1;
- op.lines = text.match(/\n/g).length;
- yield op;
- const op2 = copyOp(op);
- op2.chars = text.length - (lastNewlinePos + 1);
- op2.lines = 0;
- yield op2;
- }
+ const op = new Op(opcode);
+ op.attribs = typeof attribs === 'string'
+ ? attribs : new AttributeMap(pool).update(attribs || [], opcode === '+').toString();
+ const lastNewlinePos = text.lastIndexOf('\n');
+ if (lastNewlinePos < 0) {
+ op.chars = text.length;
+ op.lines = 0;
+ yield op;
+ }
+ else {
+ op.chars = lastNewlinePos + 1;
+ op.lines = text.match(/\n/g).length;
+ yield op;
+ const op2 = copyOp(op);
+ op2.chars = text.length - (lastNewlinePos + 1);
+ op2.lines = 0;
+ yield op2;
+ }
};
/**
* @typedef {object} StringArrayLike
@@ -240,316 +240,316 @@ const opsFromText = function* (opcode, text, attribs = '', pool = null) {
* with no newlines.
*/
class TextLinesMutator {
- /**
- * @param {(string[]|StringArrayLike)} lines - Lines to mutate (in place).
- */
- constructor(lines) {
- this._lines = lines;
/**
- * this._curSplice holds values that will be passed as arguments to this._lines.splice() to
- * insert, delete, or change lines:
- * - this._curSplice[0] is an index into the this._lines array.
- * - this._curSplice[1] is the number of lines that will be removed from the this._lines array
- * starting at the index.
- * - The other elements represent mutated (changed by ops) lines or new lines (added by ops)
- * to insert at the index.
- *
- * @type {[number, number?, ...string[]?]}
+ * @param {(string[]|StringArrayLike)} lines - Lines to mutate (in place).
*/
- this._curSplice = [0, 0];
- this._inSplice = false;
- // position in lines after curSplice is applied:
- this._curLine = 0;
- this._curCol = 0;
- // invariant: if (inSplice) then (curLine is in curSplice[0] + curSplice.length - {2,3}) &&
- // curLine >= curSplice[0]
- // invariant: if (inSplice && (curLine >= curSplice[0] + curSplice.length - 2)) then
- // curCol == 0
- }
- /**
- * Get a line from `lines` at given index.
- *
- * @param {number} idx - an index
- * @returns {string}
- */
- _linesGet(idx) {
- if ('get' in this._lines) {
- return this._lines.get(idx);
+ constructor(lines) {
+ this._lines = lines;
+ /**
+ * this._curSplice holds values that will be passed as arguments to this._lines.splice() to
+ * insert, delete, or change lines:
+ * - this._curSplice[0] is an index into the this._lines array.
+ * - this._curSplice[1] is the number of lines that will be removed from the this._lines array
+ * starting at the index.
+ * - The other elements represent mutated (changed by ops) lines or new lines (added by ops)
+ * to insert at the index.
+ *
+ * @type {[number, number?, ...string[]?]}
+ */
+ this._curSplice = [0, 0];
+ this._inSplice = false;
+ // position in lines after curSplice is applied:
+ this._curLine = 0;
+ this._curCol = 0;
+ // invariant: if (inSplice) then (curLine is in curSplice[0] + curSplice.length - {2,3}) &&
+ // curLine >= curSplice[0]
+ // invariant: if (inSplice && (curLine >= curSplice[0] + curSplice.length - 2)) then
+ // curCol == 0
}
- else {
- return this._lines[idx];
+ /**
+ * Get a line from `lines` at given index.
+ *
+ * @param {number} idx - an index
+ * @returns {string}
+ */
+ _linesGet(idx) {
+ if ('get' in this._lines) {
+ return this._lines.get(idx);
+ }
+ else {
+ return this._lines[idx];
+ }
}
- }
- /**
- * Return a slice from `lines`.
- *
- * @param {number} start - the start index
- * @param {number} end - the end index
- * @returns {string[]}
- */
- _linesSlice(start, end) {
- // can be unimplemented if removeLines's return value not needed
- if (this._lines.slice) {
- return this._lines.slice(start, end);
+ /**
+ * Return a slice from `lines`.
+ *
+ * @param {number} start - the start index
+ * @param {number} end - the end index
+ * @returns {string[]}
+ */
+ _linesSlice(start, end) {
+ // can be unimplemented if removeLines's return value not needed
+ if (this._lines.slice) {
+ return this._lines.slice(start, end);
+ }
+ else {
+ return [];
+ }
}
- else {
- return [];
+ /**
+ * Return the length of `lines`.
+ *
+ * @returns {number}
+ */
+ _linesLength() {
+ if (typeof this._lines.length === 'number') {
+ return this._lines.length;
+ }
+ else {
+ return this._lines.length();
+ }
}
- }
- /**
- * Return the length of `lines`.
- *
- * @returns {number}
- */
- _linesLength() {
- if (typeof this._lines.length === 'number') {
- return this._lines.length;
+ /**
+ * Starts a new splice.
+ */
+ _enterSplice() {
+ this._curSplice[0] = this._curLine;
+ this._curSplice[1] = 0;
+ // TODO(doc) when is this the case?
+ // check all enterSplice calls and changes to curCol
+ if (this._curCol > 0)
+ this._putCurLineInSplice();
+ this._inSplice = true;
}
- else {
- return this._lines.length();
+ /**
+ * Changes the lines array according to the values in curSplice and resets curSplice. Called via
+ * close or TODO(doc).
+ */
+ _leaveSplice() {
+ this._lines.splice(...this._curSplice);
+ this._curSplice.length = 2;
+ this._curSplice[0] = this._curSplice[1] = 0;
+ this._inSplice = false;
}
- }
- /**
- * Starts a new splice.
- */
- _enterSplice() {
- this._curSplice[0] = this._curLine;
- this._curSplice[1] = 0;
- // TODO(doc) when is this the case?
- // check all enterSplice calls and changes to curCol
- if (this._curCol > 0)
- this._putCurLineInSplice();
- this._inSplice = true;
- }
- /**
- * Changes the lines array according to the values in curSplice and resets curSplice. Called via
- * close or TODO(doc).
- */
- _leaveSplice() {
- this._lines.splice(...this._curSplice);
- this._curSplice.length = 2;
- this._curSplice[0] = this._curSplice[1] = 0;
- this._inSplice = false;
- }
- /**
- * Indicates if curLine is already in the splice. This is necessary because the last element in
- * curSplice is curLine when this line is currently worked on (e.g. when skipping or inserting).
- *
- * @returns {boolean} true if curLine is in splice
- */
- _isCurLineInSplice() {
- // The value of `this._curSplice[1]` does not matter when determining the return value because
- // `this._curLine` refers to the line number *after* the splice is applied (so after those lines
- // are deleted).
- return this._curLine - this._curSplice[0] < this._curSplice.length - 2;
- }
- /**
- * Incorporates current line into the splice and marks its old position to be deleted.
- *
- * @returns {number} the index of the added line in curSplice
- */
- _putCurLineInSplice() {
- if (!this._isCurLineInSplice()) {
- this._curSplice.push(this._linesGet(this._curSplice[0] + this._curSplice[1]));
- this._curSplice[1]++;
+ /**
+ * Indicates if curLine is already in the splice. This is necessary because the last element in
+ * curSplice is curLine when this line is currently worked on (e.g. when skipping or inserting).
+ *
+ * @returns {boolean} true if curLine is in splice
+ */
+ _isCurLineInSplice() {
+ // The value of `this._curSplice[1]` does not matter when determining the return value because
+ // `this._curLine` refers to the line number *after* the splice is applied (so after those lines
+ // are deleted).
+ return this._curLine - this._curSplice[0] < this._curSplice.length - 2;
}
- // TODO should be the same as this._curSplice.length - 1
- return 2 + this._curLine - this._curSplice[0];
- }
- /**
- * It will skip some newlines by putting them into the splice.
- *
- * @param {number} L -
- * @param {boolean} includeInSplice - Indicates that attributes are present.
- */
- skipLines(L, includeInSplice) {
- if (!L)
- return;
- if (includeInSplice) {
- if (!this._inSplice)
- this._enterSplice();
- // TODO(doc) should this count the number of characters that are skipped to check?
- for (let i = 0; i < L; i++) {
- this._curCol = 0;
- this._putCurLineInSplice();
- this._curLine++;
- }
+ /**
+ * Incorporates current line into the splice and marks its old position to be deleted.
+ *
+ * @returns {number} the index of the added line in curSplice
+ */
+ _putCurLineInSplice() {
+ if (!this._isCurLineInSplice()) {
+ this._curSplice.push(this._linesGet(this._curSplice[0] + this._curSplice[1]));
+ this._curSplice[1]++;
+ }
+ // TODO should be the same as this._curSplice.length - 1
+ return 2 + this._curLine - this._curSplice[0];
}
- else {
- if (this._inSplice) {
- if (L > 1) {
- // TODO(doc) figure out why single lines are incorporated into splice instead of ignored
- this._leaveSplice();
+ /**
+ * It will skip some newlines by putting them into the splice.
+ *
+ * @param {number} L -
+ * @param {boolean} includeInSplice - Indicates that attributes are present.
+ */
+ skipLines(L, includeInSplice) {
+ if (!L)
+ return;
+ if (includeInSplice) {
+ if (!this._inSplice)
+ this._enterSplice();
+ // TODO(doc) should this count the number of characters that are skipped to check?
+ for (let i = 0; i < L; i++) {
+ this._curCol = 0;
+ this._putCurLineInSplice();
+ this._curLine++;
+ }
}
else {
- this._putCurLineInSplice();
+ if (this._inSplice) {
+ if (L > 1) {
+ // TODO(doc) figure out why single lines are incorporated into splice instead of ignored
+ this._leaveSplice();
+ }
+ else {
+ this._putCurLineInSplice();
+ }
+ }
+ this._curLine += L;
+ this._curCol = 0;
}
- }
- this._curLine += L;
- this._curCol = 0;
+ // tests case foo in remove(), which isn't otherwise covered in current impl
}
- // tests case foo in remove(), which isn't otherwise covered in current impl
- }
- /**
- * Skip some characters. Can contain newlines.
- *
- * @param {number} N - number of characters to skip
- * @param {number} L - number of newlines to skip
- * @param {boolean} includeInSplice - indicates if attributes are present
- */
- skip(N, L, includeInSplice) {
- if (!N)
- return;
- if (L) {
- this.skipLines(L, includeInSplice);
+ /**
+ * Skip some characters. Can contain newlines.
+ *
+ * @param {number} N - number of characters to skip
+ * @param {number} L - number of newlines to skip
+ * @param {boolean} includeInSplice - indicates if attributes are present
+ */
+ skip(N, L, includeInSplice) {
+ if (!N)
+ return;
+ if (L) {
+ this.skipLines(L, includeInSplice);
+ }
+ else {
+ if (includeInSplice && !this._inSplice)
+ this._enterSplice();
+ if (this._inSplice) {
+ // although the line is put into splice curLine is not increased, because
+ // only some chars are skipped, not the whole line
+ this._putCurLineInSplice();
+ }
+ this._curCol += N;
+ }
}
- else {
- if (includeInSplice && !this._inSplice)
- this._enterSplice();
- if (this._inSplice) {
- // although the line is put into splice curLine is not increased, because
- // only some chars are skipped, not the whole line
- this._putCurLineInSplice();
- }
- this._curCol += N;
+ /**
+ * Remove whole lines from lines array.
+ *
+ * @param {number} L - number of lines to remove
+ * @returns {string}
+ */
+ removeLines(L) {
+ if (!L)
+ return '';
+ if (!this._inSplice)
+ this._enterSplice();
+ /**
+ * Gets a string of joined lines after the end of the splice.
+ *
+ * @param {number} k - number of lines
+ * @returns {string} joined lines
+ */
+ const nextKLinesText = (k) => {
+ const m = this._curSplice[0] + this._curSplice[1];
+ return this._linesSlice(m, m + k).join('');
+ };
+ let removed = '';
+ if (this._isCurLineInSplice()) {
+ if (this._curCol === 0) {
+ removed = this._curSplice[this._curSplice.length - 1];
+ this._curSplice.length--;
+ removed += nextKLinesText(L - 1);
+ this._curSplice[1] += L - 1;
+ }
+ else {
+ removed = nextKLinesText(L - 1);
+ this._curSplice[1] += L - 1;
+ const sline = this._curSplice.length - 1;
+ removed = this._curSplice[sline].substring(this._curCol) + removed;
+ this._curSplice[sline] = this._curSplice[sline].substring(0, this._curCol) +
+ this._linesGet(this._curSplice[0] + this._curSplice[1]);
+ this._curSplice[1] += 1;
+ }
+ }
+ else {
+ removed = nextKLinesText(L);
+ this._curSplice[1] += L;
+ }
+ return removed;
}
- }
- /**
- * Remove whole lines from lines array.
- *
- * @param {number} L - number of lines to remove
- * @returns {string}
- */
- removeLines(L) {
- if (!L)
- return '';
- if (!this._inSplice)
- this._enterSplice();
/**
- * Gets a string of joined lines after the end of the splice.
+ * Remove text from lines array.
*
- * @param {number} k - number of lines
- * @returns {string} joined lines
+ * @param {number} N - characters to delete
+ * @param {number} L - lines to delete
+ * @returns {string}
*/
- const nextKLinesText = (k) => {
- const m = this._curSplice[0] + this._curSplice[1];
- return this._linesSlice(m, m + k).join('');
- };
- let removed = '';
- if (this._isCurLineInSplice()) {
- if (this._curCol === 0) {
- removed = this._curSplice[this._curSplice.length - 1];
- this._curSplice.length--;
- removed += nextKLinesText(L - 1);
- this._curSplice[1] += L - 1;
- }
- else {
- removed = nextKLinesText(L - 1);
- this._curSplice[1] += L - 1;
- const sline = this._curSplice.length - 1;
- removed = this._curSplice[sline].substring(this._curCol) + removed;
+ remove(N, L) {
+ if (!N)
+ return '';
+ if (L)
+ return this.removeLines(L);
+ if (!this._inSplice)
+ this._enterSplice();
+ // although the line is put into splice, curLine is not increased, because
+ // only some chars are removed not the whole line
+ const sline = this._putCurLineInSplice();
+ const removed = this._curSplice[sline].substring(this._curCol, this._curCol + N);
this._curSplice[sline] = this._curSplice[sline].substring(0, this._curCol) +
- this._linesGet(this._curSplice[0] + this._curSplice[1]);
- this._curSplice[1] += 1;
- }
+ this._curSplice[sline].substring(this._curCol + N);
+ return removed;
}
- else {
- removed = nextKLinesText(L);
- this._curSplice[1] += L;
- }
- return removed;
- }
- /**
- * Remove text from lines array.
- *
- * @param {number} N - characters to delete
- * @param {number} L - lines to delete
- * @returns {string}
- */
- remove(N, L) {
- if (!N)
- return '';
- if (L)
- return this.removeLines(L);
- if (!this._inSplice)
- this._enterSplice();
- // although the line is put into splice, curLine is not increased, because
- // only some chars are removed not the whole line
- const sline = this._putCurLineInSplice();
- const removed = this._curSplice[sline].substring(this._curCol, this._curCol + N);
- this._curSplice[sline] = this._curSplice[sline].substring(0, this._curCol) +
- this._curSplice[sline].substring(this._curCol + N);
- return removed;
- }
- /**
- * Inserts text into lines array.
- *
- * @param {string} text - the text to insert
- * @param {number} L - number of newlines in text
- */
- insert(text, L) {
- if (!text)
- return;
- if (!this._inSplice)
- this._enterSplice();
- if (L) {
- const newLines = exports.splitTextLines(text);
- if (this._isCurLineInSplice()) {
- const sline = this._curSplice.length - 1;
- /** @type {string} */
- const theLine = this._curSplice[sline];
- const lineCol = this._curCol;
- // Insert the chars up to `curCol` and the first new line.
- this._curSplice[sline] = theLine.substring(0, lineCol) + newLines[0];
- this._curLine++;
- newLines.splice(0, 1);
- // insert the remaining new lines
- this._curSplice.push(...newLines);
- this._curLine += newLines.length;
- // insert the remaining chars from the "old" line (e.g. the line we were in
- // when we started to insert new lines)
- this._curSplice.push(theLine.substring(lineCol));
- this._curCol = 0; // TODO(doc) why is this not set to the length of last line?
- }
- else {
- this._curSplice.push(...newLines);
- this._curLine += newLines.length;
- }
+ /**
+ * Inserts text into lines array.
+ *
+ * @param {string} text - the text to insert
+ * @param {number} L - number of newlines in text
+ */
+ insert(text, L) {
+ if (!text)
+ return;
+ if (!this._inSplice)
+ this._enterSplice();
+ if (L) {
+ const newLines = exports.splitTextLines(text);
+ if (this._isCurLineInSplice()) {
+ const sline = this._curSplice.length - 1;
+ /** @type {string} */
+ const theLine = this._curSplice[sline];
+ const lineCol = this._curCol;
+ // Insert the chars up to `curCol` and the first new line.
+ this._curSplice[sline] = theLine.substring(0, lineCol) + newLines[0];
+ this._curLine++;
+ newLines.splice(0, 1);
+ // insert the remaining new lines
+ this._curSplice.push(...newLines);
+ this._curLine += newLines.length;
+ // insert the remaining chars from the "old" line (e.g. the line we were in
+ // when we started to insert new lines)
+ this._curSplice.push(theLine.substring(lineCol));
+ this._curCol = 0; // TODO(doc) why is this not set to the length of last line?
+ }
+ else {
+ this._curSplice.push(...newLines);
+ this._curLine += newLines.length;
+ }
+ }
+ else {
+ // There are no additional lines. Although the line is put into splice, curLine is not
+ // increased because there may be more chars in the line (newline is not reached).
+ const sline = this._putCurLineInSplice();
+ if (!this._curSplice[sline]) {
+ const err = new Error('curSplice[sline] not populated, actual curSplice contents is ' +
+ `${JSON.stringify(this._curSplice)}. Possibly related to ` +
+ 'https://github.com/ether/etherpad-lite/issues/2802');
+ console.error(err.stack || err.toString());
+ }
+ this._curSplice[sline] = this._curSplice[sline].substring(0, this._curCol) + text +
+ this._curSplice[sline].substring(this._curCol);
+ this._curCol += text.length;
+ }
}
- else {
- // There are no additional lines. Although the line is put into splice, curLine is not
- // increased because there may be more chars in the line (newline is not reached).
- const sline = this._putCurLineInSplice();
- if (!this._curSplice[sline]) {
- const err = new Error('curSplice[sline] not populated, actual curSplice contents is ' +
- `${JSON.stringify(this._curSplice)}. Possibly related to ` +
- 'https://github.com/ether/etherpad-lite/issues/2802');
- console.error(err.stack || err.toString());
- }
- this._curSplice[sline] = this._curSplice[sline].substring(0, this._curCol) + text +
- this._curSplice[sline].substring(this._curCol);
- this._curCol += text.length;
+ /**
+ * Checks if curLine (the line we are in when curSplice is applied) is the last line in `lines`.
+ *
+ * @returns {boolean} indicates if there are lines left
+ */
+ hasMore() {
+ let docLines = this._linesLength();
+ if (this._inSplice) {
+ docLines += this._curSplice.length - 2 - this._curSplice[1];
+ }
+ return this._curLine < docLines;
}
- }
- /**
- * Checks if curLine (the line we are in when curSplice is applied) is the last line in `lines`.
- *
- * @returns {boolean} indicates if there are lines left
- */
- hasMore() {
- let docLines = this._linesLength();
- if (this._inSplice) {
- docLines += this._curSplice.length - 2 - this._curSplice[1];
+ /**
+ * Closes the splice
+ */
+ close() {
+ if (this._inSplice)
+ this._leaveSplice();
}
- return this._curLine < docLines;
- }
- /**
- * Closes the splice
- */
- close() {
- if (this._inSplice)
- this._leaveSplice();
- }
}
/**
* Apply operations to other operations.
@@ -573,28 +573,28 @@ class TextLinesMutator {
* @returns {string} the integrated changeset
*/
const applyZip = (in1, in2, func) => {
- const ops1 = exports.deserializeOps(in1);
- const ops2 = exports.deserializeOps(in2);
- let next1 = ops1.next();
- let next2 = ops2.next();
- const assem = exports.smartOpAssembler();
- while (!next1.done || !next2.done) {
- if (!next1.done && !next1.value.opcode)
- next1 = ops1.next();
- if (!next2.done && !next2.value.opcode)
- next2 = ops2.next();
- if (next1.value == null)
- next1.value = new Op();
- if (next2.value == null)
- next2.value = new Op();
- if (!next1.value.opcode && !next2.value.opcode)
- break;
- const opOut = func(next1.value, next2.value);
- if (opOut && opOut.opcode)
- assem.append(opOut);
- }
- assem.endDocument();
- return assem.toString();
+ const ops1 = exports.deserializeOps(in1);
+ const ops2 = exports.deserializeOps(in2);
+ let next1 = ops1.next();
+ let next2 = ops2.next();
+ const assem = exports.smartOpAssembler();
+ while (!next1.done || !next2.done) {
+ if (!next1.done && !next1.value.opcode)
+ next1 = ops1.next();
+ if (!next2.done && !next2.value.opcode)
+ next2 = ops2.next();
+ if (next1.value == null)
+ next1.value = new Op();
+ if (next2.value == null)
+ next2.value = new Op();
+ if (!next1.value.opcode && !next2.value.opcode)
+ break;
+ const opOut = func(next1.value, next2.value);
+ if (opOut && opOut.opcode)
+ assem.append(opOut);
+ }
+ assem.endDocument();
+ return assem.toString();
};
/**
* Function used as parameter for applyZip to apply a Changeset to an attribute.
@@ -606,59 +606,59 @@ const applyZip = (in1, in2, func) => {
* @returns {Op} The result of applying `csOp` to `attOp`.
*/
const slicerZipperFunc = (attOp, csOp, pool) => {
- const opOut = new Op();
- if (!attOp.opcode) {
- copyOp(csOp, opOut);
- csOp.opcode = '';
- }
- else if (!csOp.opcode) {
- copyOp(attOp, opOut);
- attOp.opcode = '';
- }
- else if (attOp.opcode === '-') {
- copyOp(attOp, opOut);
- attOp.opcode = '';
- }
- else if (csOp.opcode === '+') {
- copyOp(csOp, opOut);
- csOp.opcode = '';
- }
- else {
- for (const op of [attOp, csOp]) {
- assert(op.chars >= op.lines, `op has more newlines than chars: ${op.toString()}`);
+ const opOut = new Op();
+ if (!attOp.opcode) {
+ copyOp(csOp, opOut);
+ csOp.opcode = '';
+ }
+ else if (!csOp.opcode) {
+ copyOp(attOp, opOut);
+ attOp.opcode = '';
+ }
+ else if (attOp.opcode === '-') {
+ copyOp(attOp, opOut);
+ attOp.opcode = '';
+ }
+ else if (csOp.opcode === '+') {
+ copyOp(csOp, opOut);
+ csOp.opcode = '';
+ }
+ else {
+ for (const op of [attOp, csOp]) {
+ assert(op.chars >= op.lines, `op has more newlines than chars: ${op.toString()}`);
+ }
+ assert(attOp.chars < csOp.chars ? attOp.lines <= csOp.lines
+ : attOp.chars > csOp.chars ? attOp.lines >= csOp.lines
+ : attOp.lines === csOp.lines, 'line count mismatch when composing changesets A*B; ' +
+ `opA: ${attOp.toString()} opB: ${csOp.toString()}`);
+ assert(['+', '='].includes(attOp.opcode), `unexpected opcode in op: ${attOp.toString()}`);
+ assert(['-', '='].includes(csOp.opcode), `unexpected opcode in op: ${csOp.toString()}`);
+ opOut.opcode = {
+ '+': {
+ '-': '',
+ '=': '+',
+ },
+ '=': {
+ '-': '-',
+ '=': '=',
+ },
+ }[attOp.opcode][csOp.opcode];
+ const [fullyConsumedOp, partiallyConsumedOp] = [attOp, csOp].sort((a, b) => a.chars - b.chars);
+ opOut.chars = fullyConsumedOp.chars;
+ opOut.lines = fullyConsumedOp.lines;
+ opOut.attribs = csOp.opcode === '-'
+ // csOp is a remove op and remove ops normally never have any attributes, so this should
+ // normally be the empty string. However, padDiff.js adds attributes to remove ops and needs
+ // them preserved so they are copied here.
+ ? csOp.attribs
+ : exports.composeAttributes(attOp.attribs, csOp.attribs, attOp.opcode === '=', pool);
+ partiallyConsumedOp.chars -= fullyConsumedOp.chars;
+ partiallyConsumedOp.lines -= fullyConsumedOp.lines;
+ if (!partiallyConsumedOp.chars)
+ partiallyConsumedOp.opcode = '';
+ fullyConsumedOp.opcode = '';
}
- assert(attOp.chars < csOp.chars ? attOp.lines <= csOp.lines
- : attOp.chars > csOp.chars ? attOp.lines >= csOp.lines
- : attOp.lines === csOp.lines, 'line count mismatch when composing changesets A*B; ' +
- `opA: ${attOp.toString()} opB: ${csOp.toString()}`);
- assert(['+', '='].includes(attOp.opcode), `unexpected opcode in op: ${attOp.toString()}`);
- assert(['-', '='].includes(csOp.opcode), `unexpected opcode in op: ${csOp.toString()}`);
- opOut.opcode = {
- '+': {
- '-': '',
- '=': '+',
- },
- '=': {
- '-': '-',
- '=': '=',
- },
- }[attOp.opcode][csOp.opcode];
- const [fullyConsumedOp, partiallyConsumedOp] = [attOp, csOp].sort((a, b) => a.chars - b.chars);
- opOut.chars = fullyConsumedOp.chars;
- opOut.lines = fullyConsumedOp.lines;
- opOut.attribs = csOp.opcode === '-'
- // csOp is a remove op and remove ops normally never have any attributes, so this should
- // normally be the empty string. However, padDiff.js adds attributes to remove ops and needs
- // them preserved so they are copied here.
- ? csOp.attribs
- : exports.composeAttributes(attOp.attribs, csOp.attribs, attOp.opcode === '=', pool);
- partiallyConsumedOp.chars -= fullyConsumedOp.chars;
- partiallyConsumedOp.lines -= fullyConsumedOp.lines;
- if (!partiallyConsumedOp.chars)
- partiallyConsumedOp.opcode = '';
- fullyConsumedOp.opcode = '';
- }
- return opOut;
+ return opOut;
};
/**
* Transforms a changeset into a list of splices in the form [startChar, endChar, newText] meaning
@@ -668,1296 +668,1296 @@ const slicerZipperFunc = (attOp, csOp, pool) => {
* @returns {[number, number, string][]}
*/
const toSplices = (cs) => {
- const unpacked = exports.unpack(cs);
- /** @type {[number, number, string][]} */
- const splices = [];
- let oldPos = 0;
- const charIter = exports.stringIterator(unpacked.charBank);
- let inSplice = false;
- for (const op of exports.deserializeOps(unpacked.ops)) {
- if (op.opcode === '=') {
- oldPos += op.chars;
- inSplice = false;
- }
- else {
- if (!inSplice) {
- splices.push([oldPos, oldPos, '']);
- inSplice = true;
- }
- if (op.opcode === '-') {
- oldPos += op.chars;
- splices[splices.length - 1][1] += op.chars;
- }
- else if (op.opcode === '+') {
- splices[splices.length - 1][2] += charIter.take(op.chars);
- }
+ const unpacked = exports.unpack(cs);
+ /** @type {[number, number, string][]} */
+ const splices = [];
+ let oldPos = 0;
+ const charIter = exports.stringIterator(unpacked.charBank);
+ let inSplice = false;
+ for (const op of exports.deserializeOps(unpacked.ops)) {
+ if (op.opcode === '=') {
+ oldPos += op.chars;
+ inSplice = false;
+ }
+ else {
+ if (!inSplice) {
+ splices.push([oldPos, oldPos, '']);
+ inSplice = true;
+ }
+ if (op.opcode === '-') {
+ oldPos += op.chars;
+ splices[splices.length - 1][1] += op.chars;
+ }
+ else if (op.opcode === '+') {
+ splices[splices.length - 1][2] += charIter.take(op.chars);
+ }
+ }
}
- }
- return splices;
+ return splices;
};
/**
* @deprecated Use an AttributeMap instead.
*/
const attribsAttributeValue = (attribs, key, pool) => {
- if (!attribs)
+ if (!attribs)
+ return '';
+ for (const [k, v] of attributes.attribsFromString(attribs, pool)) {
+ if (k === key)
+ return v;
+ }
return '';
- for (const [k, v] of attributes.attribsFromString(attribs, pool)) {
- if (k === key)
- return v;
- }
- return '';
};
const followAttributes = (att1, att2, pool) => {
- // The merge of two sets of attribute changes to the same text
- // takes the lexically-earlier value if there are two values
- // for the same key. Otherwise, all key/value changes from
- // both attribute sets are taken. This operation is the "follow",
- // so a set of changes is produced that can be applied to att1
- // to produce the merged set.
- if ((!att2) || (!pool))
- return '';
- if (!att1)
- return att2;
- const atts = new Map();
- att2.replace(/\*([0-9a-z]+)/g, (_, a) => {
- const [key, val] = pool.getAttrib(exports.parseNum(a));
- atts.set(key, val);
- return '';
- });
- att1.replace(/\*([0-9a-z]+)/g, (_, a) => {
- const [key, val] = pool.getAttrib(exports.parseNum(a));
- if (atts.has(key) && val <= atts.get(key))
- atts.delete(key);
- return '';
- });
- // we've only removed attributes, so they're already sorted
- const buf = exports.stringAssembler();
- for (const att of atts) {
- buf.append('*');
- buf.append(exports.numToString(pool.putAttrib(att)));
- }
- return buf.toString();
+ // The merge of two sets of attribute changes to the same text
+ // takes the lexically-earlier value if there are two values
+ // for the same key. Otherwise, all key/value changes from
+ // both attribute sets are taken. This operation is the "follow",
+ // so a set of changes is produced that can be applied to att1
+ // to produce the merged set.
+ if ((!att2) || (!pool))
+ return '';
+ if (!att1)
+ return att2;
+ const atts = new Map();
+ att2.replace(/\*([0-9a-z]+)/g, (_, a) => {
+ const [key, val] = pool.getAttrib(exports.parseNum(a));
+ atts.set(key, val);
+ return '';
+ });
+ att1.replace(/\*([0-9a-z]+)/g, (_, a) => {
+ const [key, val] = pool.getAttrib(exports.parseNum(a));
+ if (atts.has(key) && val <= atts.get(key))
+ atts.delete(key);
+ return '';
+ });
+ // we've only removed attributes, so they're already sorted
+ const buf = exports.stringAssembler();
+ for (const att of atts) {
+ buf.append('*');
+ buf.append(exports.numToString(pool.putAttrib(att)));
+ }
+ return buf.toString();
};
export const parseNum = (str) => parseInt(str, 36);
export const numToString = (num) => num.toString(36).toLowerCase();
export const oldLen = (cs) => exports.unpack(cs).oldLen;
export const newLen = (cs) => exports.unpack(cs).newLen;
export const deserializeOps = function* (ops) {
- // TODO: Migrate to String.prototype.matchAll() once there is enough browser support.
- const regex = /((?:\*[0-9a-z]+)*)(?:\|([0-9a-z]+))?([-+=])([0-9a-z]+)|(.)/g;
- let match;
- while ((match = regex.exec(ops)) != null) {
- if (match[5] === '$')
- return; // Start of the insert operation character bank.
- if (match[5] != null)
- error(`invalid operation: ${ops.slice(regex.lastIndex - 1)}`);
- const op = new Op(match[3]);
- op.lines = exports.parseNum(match[2] || '0');
- op.chars = exports.parseNum(match[4]);
- op.attribs = match[1];
- yield op;
- }
+ // TODO: Migrate to String.prototype.matchAll() once there is enough browser support.
+ const regex = /((?:\*[0-9a-z]+)*)(?:\|([0-9a-z]+))?([-+=])([0-9a-z]+)|(.)/g;
+ let match;
+ while ((match = regex.exec(ops)) != null) {
+ if (match[5] === '$')
+ return; // Start of the insert operation character bank.
+ if (match[5] != null)
+ error(`invalid operation: ${ops.slice(regex.lastIndex - 1)}`);
+ const op = new Op(match[3]);
+ op.lines = exports.parseNum(match[2] || '0');
+ op.chars = exports.parseNum(match[4]);
+ op.attribs = match[1];
+ yield op;
+ }
};
export const opIterator = (opsStr) => {
- padutils.warnDeprecated('Changeset.opIterator() is deprecated; use Changeset.deserializeOps() instead');
- return new OpIter(opsStr);
+ padutils.warnDeprecated('Changeset.opIterator() is deprecated; use Changeset.deserializeOps() instead');
+ return new OpIter(opsStr);
};
export const newOp = (optOpcode) => {
- padutils.warnDeprecated('Changeset.newOp() is deprecated; use the Changeset.Op class instead');
- return new Op(optOpcode);
+ padutils.warnDeprecated('Changeset.newOp() is deprecated; use the Changeset.Op class instead');
+ return new Op(optOpcode);
};
export const checkRep = (cs) => {
- const unpacked = exports.unpack(cs);
- const oldLen = unpacked.oldLen;
- const newLen = unpacked.newLen;
- const ops = unpacked.ops;
- let charBank = unpacked.charBank;
- const assem = exports.smartOpAssembler();
- let oldPos = 0;
- let calcNewLen = 0;
- for (const o of exports.deserializeOps(ops)) {
- switch (o.opcode) {
- case '=':
- oldPos += o.chars;
- calcNewLen += o.chars;
- break;
- case '-':
- oldPos += o.chars;
- assert(oldPos <= oldLen, `${oldPos} > ${oldLen} in ${cs}`);
- break;
- case '+':
- {
- assert(charBank.length >= o.chars, 'Invalid changeset: not enough chars in charBank');
- const chars = charBank.slice(0, o.chars);
- const nlines = (chars.match(/\n/g) || []).length;
- assert(nlines === o.lines, 'Invalid changeset: number of newlines in insert op does not match the charBank');
- assert(o.lines === 0 || chars.endsWith('\n'), 'Invalid changeset: multiline insert op does not end with a newline');
- charBank = charBank.slice(o.chars);
- calcNewLen += o.chars;
- assert(calcNewLen <= newLen, `${calcNewLen} > ${newLen} in ${cs}`);
- break;
- }
- default:
- assert(false, `Invalid changeset: Unknown opcode: ${JSON.stringify(o.opcode)}`);
- }
- assem.append(o);
- }
- calcNewLen += oldLen - oldPos;
- assert(calcNewLen === newLen, 'Invalid changeset: claimed length does not match actual length');
- assert(charBank === '', 'Invalid changeset: excess characters in the charBank');
- assem.endDocument();
- const normalized = exports.pack(oldLen, calcNewLen, assem.toString(), unpacked.charBank);
- assert(normalized === cs, 'Invalid changeset: not in canonical form');
- return cs;
+ const unpacked = exports.unpack(cs);
+ const oldLen = unpacked.oldLen;
+ const newLen = unpacked.newLen;
+ const ops = unpacked.ops;
+ let charBank = unpacked.charBank;
+ const assem = exports.smartOpAssembler();
+ let oldPos = 0;
+ let calcNewLen = 0;
+ for (const o of exports.deserializeOps(ops)) {
+ switch (o.opcode) {
+ case '=':
+ oldPos += o.chars;
+ calcNewLen += o.chars;
+ break;
+ case '-':
+ oldPos += o.chars;
+ assert(oldPos <= oldLen, `${oldPos} > ${oldLen} in ${cs}`);
+ break;
+ case '+':
+ {
+ assert(charBank.length >= o.chars, 'Invalid changeset: not enough chars in charBank');
+ const chars = charBank.slice(0, o.chars);
+ const nlines = (chars.match(/\n/g) || []).length;
+ assert(nlines === o.lines, 'Invalid changeset: number of newlines in insert op does not match the charBank');
+ assert(o.lines === 0 || chars.endsWith('\n'), 'Invalid changeset: multiline insert op does not end with a newline');
+ charBank = charBank.slice(o.chars);
+ calcNewLen += o.chars;
+ assert(calcNewLen <= newLen, `${calcNewLen} > ${newLen} in ${cs}`);
+ break;
+ }
+ default:
+ assert(false, `Invalid changeset: Unknown opcode: ${JSON.stringify(o.opcode)}`);
+ }
+ assem.append(o);
+ }
+ calcNewLen += oldLen - oldPos;
+ assert(calcNewLen === newLen, 'Invalid changeset: claimed length does not match actual length');
+ assert(charBank === '', 'Invalid changeset: excess characters in the charBank');
+ assem.endDocument();
+ const normalized = exports.pack(oldLen, calcNewLen, assem.toString(), unpacked.charBank);
+ assert(normalized === cs, 'Invalid changeset: not in canonical form');
+ return cs;
};
export const smartOpAssembler = () => {
- const minusAssem = exports.mergingOpAssembler();
- const plusAssem = exports.mergingOpAssembler();
- const keepAssem = exports.mergingOpAssembler();
- const assem = exports.stringAssembler();
- let lastOpcode = '';
- let lengthChange = 0;
- const flushKeeps = () => {
- assem.append(keepAssem.toString());
- keepAssem.clear();
- };
- const flushPlusMinus = () => {
- assem.append(minusAssem.toString());
- minusAssem.clear();
- assem.append(plusAssem.toString());
- plusAssem.clear();
- };
- const append = (op) => {
- if (!op.opcode)
- return;
- if (!op.chars)
- return;
- if (op.opcode === '-') {
- if (lastOpcode === '=') {
- flushKeeps();
- }
- minusAssem.append(op);
- lengthChange -= op.chars;
- }
- else if (op.opcode === '+') {
- if (lastOpcode === '=') {
- flushKeeps();
- }
- plusAssem.append(op);
- lengthChange += op.chars;
- }
- else if (op.opcode === '=') {
- if (lastOpcode !== '=') {
+ const minusAssem = exports.mergingOpAssembler();
+ const plusAssem = exports.mergingOpAssembler();
+ const keepAssem = exports.mergingOpAssembler();
+ const assem = exports.stringAssembler();
+ let lastOpcode = '';
+ let lengthChange = 0;
+ const flushKeeps = () => {
+ assem.append(keepAssem.toString());
+ keepAssem.clear();
+ };
+ const flushPlusMinus = () => {
+ assem.append(minusAssem.toString());
+ minusAssem.clear();
+ assem.append(plusAssem.toString());
+ plusAssem.clear();
+ };
+ const append = (op) => {
+ if (!op.opcode)
+ return;
+ if (!op.chars)
+ return;
+ if (op.opcode === '-') {
+ if (lastOpcode === '=') {
+ flushKeeps();
+ }
+ minusAssem.append(op);
+ lengthChange -= op.chars;
+ }
+ else if (op.opcode === '+') {
+ if (lastOpcode === '=') {
+ flushKeeps();
+ }
+ plusAssem.append(op);
+ lengthChange += op.chars;
+ }
+ else if (op.opcode === '=') {
+ if (lastOpcode !== '=') {
+ flushPlusMinus();
+ }
+ keepAssem.append(op);
+ }
+ lastOpcode = op.opcode;
+ };
+ /**
+ * Generates operations from the given text and attributes.
+ *
+ * @deprecated Use `opsFromText` instead.
+ * @param {('-'|'+'|'=')} opcode - The operator to use.
+ * @param {string} text - The text to remove/add/keep.
+ * @param {(string|Iterable)} attribs - The attributes to apply to the operations.
+ * @param {?AttributePool} pool - Attribute pool. Only required if `attribs` is an iterable of
+ * attribute key, value pairs.
+ */
+ const appendOpWithText = (opcode, text, attribs, pool) => {
+ padutils.warnDeprecated('Changeset.smartOpAssembler().appendOpWithText() is deprecated; ' +
+ 'use opsFromText() instead.');
+ for (const op of opsFromText(opcode, text, attribs, pool))
+ append(op);
+ };
+ const toString = () => {
flushPlusMinus();
- }
- keepAssem.append(op);
- }
- lastOpcode = op.opcode;
- };
- /**
- * Generates operations from the given text and attributes.
- *
- * @deprecated Use `opsFromText` instead.
- * @param {('-'|'+'|'=')} opcode - The operator to use.
- * @param {string} text - The text to remove/add/keep.
- * @param {(string|Iterable)} attribs - The attributes to apply to the operations.
- * @param {?AttributePool} pool - Attribute pool. Only required if `attribs` is an iterable of
- * attribute key, value pairs.
- */
- const appendOpWithText = (opcode, text, attribs, pool) => {
- padutils.warnDeprecated('Changeset.smartOpAssembler().appendOpWithText() is deprecated; ' +
- 'use opsFromText() instead.');
- for (const op of opsFromText(opcode, text, attribs, pool))
- append(op);
- };
- const toString = () => {
- flushPlusMinus();
- flushKeeps();
- return assem.toString();
- };
- const clear = () => {
- minusAssem.clear();
- plusAssem.clear();
- keepAssem.clear();
- assem.clear();
- lengthChange = 0;
- };
- const endDocument = () => {
- keepAssem.endDocument();
- };
- const getLengthChange = () => lengthChange;
- return {
- append,
- toString,
- clear,
- endDocument,
- appendOpWithText,
- getLengthChange,
- };
+ flushKeeps();
+ return assem.toString();
+ };
+ const clear = () => {
+ minusAssem.clear();
+ plusAssem.clear();
+ keepAssem.clear();
+ assem.clear();
+ lengthChange = 0;
+ };
+ const endDocument = () => {
+ keepAssem.endDocument();
+ };
+ const getLengthChange = () => lengthChange;
+ return {
+ append,
+ toString,
+ clear,
+ endDocument,
+ appendOpWithText,
+ getLengthChange,
+ };
};
export const mergingOpAssembler = () => {
- const assem = exports.opAssembler();
- const bufOp = new Op();
- // If we get, for example, insertions [xxx\n,yyy], those don't merge,
- // but if we get [xxx\n,yyy,zzz\n], that merges to [xxx\nyyyzzz\n].
- // This variable stores the length of yyy and any other newline-less
- // ops immediately after it.
- let bufOpAdditionalCharsAfterNewline = 0;
- /**
- * @param {boolean} [isEndDocument]
- */
- const flush = (isEndDocument) => {
- if (!bufOp.opcode)
- return;
- if (isEndDocument && bufOp.opcode === '=' && !bufOp.attribs) {
- // final merged keep, leave it implicit
- }
- else {
- assem.append(bufOp);
- if (bufOpAdditionalCharsAfterNewline) {
- bufOp.chars = bufOpAdditionalCharsAfterNewline;
- bufOp.lines = 0;
- assem.append(bufOp);
- bufOpAdditionalCharsAfterNewline = 0;
- }
- }
- bufOp.opcode = '';
- };
- const append = (op) => {
- if (op.chars <= 0)
- return;
- if (bufOp.opcode === op.opcode && bufOp.attribs === op.attribs) {
- if (op.lines > 0) {
- // bufOp and additional chars are all mergeable into a multi-line op
- bufOp.chars += bufOpAdditionalCharsAfterNewline + op.chars;
- bufOp.lines += op.lines;
- bufOpAdditionalCharsAfterNewline = 0;
- }
- else if (bufOp.lines === 0) {
- // both bufOp and op are in-line
- bufOp.chars += op.chars;
- }
- else {
- // append in-line text to multi-line bufOp
- bufOpAdditionalCharsAfterNewline += op.chars;
- }
- }
- else {
- flush();
- copyOp(op, bufOp);
- }
- };
- const endDocument = () => {
- flush(true);
- };
- const toString = () => {
- flush();
- return assem.toString();
- };
- const clear = () => {
- assem.clear();
- clearOp(bufOp);
- };
- return {
- append,
- toString,
- clear,
- endDocument,
- };
+ const assem = exports.opAssembler();
+ const bufOp = new Op();
+ // If we get, for example, insertions [xxx\n,yyy], those don't merge,
+ // but if we get [xxx\n,yyy,zzz\n], that merges to [xxx\nyyyzzz\n].
+ // This variable stores the length of yyy and any other newline-less
+ // ops immediately after it.
+ let bufOpAdditionalCharsAfterNewline = 0;
+ /**
+ * @param {boolean} [isEndDocument]
+ */
+ const flush = (isEndDocument) => {
+ if (!bufOp.opcode)
+ return;
+ if (isEndDocument && bufOp.opcode === '=' && !bufOp.attribs) {
+ // final merged keep, leave it implicit
+ }
+ else {
+ assem.append(bufOp);
+ if (bufOpAdditionalCharsAfterNewline) {
+ bufOp.chars = bufOpAdditionalCharsAfterNewline;
+ bufOp.lines = 0;
+ assem.append(bufOp);
+ bufOpAdditionalCharsAfterNewline = 0;
+ }
+ }
+ bufOp.opcode = '';
+ };
+ const append = (op) => {
+ if (op.chars <= 0)
+ return;
+ if (bufOp.opcode === op.opcode && bufOp.attribs === op.attribs) {
+ if (op.lines > 0) {
+ // bufOp and additional chars are all mergeable into a multi-line op
+ bufOp.chars += bufOpAdditionalCharsAfterNewline + op.chars;
+ bufOp.lines += op.lines;
+ bufOpAdditionalCharsAfterNewline = 0;
+ }
+ else if (bufOp.lines === 0) {
+ // both bufOp and op are in-line
+ bufOp.chars += op.chars;
+ }
+ else {
+ // append in-line text to multi-line bufOp
+ bufOpAdditionalCharsAfterNewline += op.chars;
+ }
+ }
+ else {
+ flush();
+ copyOp(op, bufOp);
+ }
+ };
+ const endDocument = () => {
+ flush(true);
+ };
+ const toString = () => {
+ flush();
+ return assem.toString();
+ };
+ const clear = () => {
+ assem.clear();
+ clearOp(bufOp);
+ };
+ return {
+ append,
+ toString,
+ clear,
+ endDocument,
+ };
};
export const opAssembler = () => {
- let serialized = '';
- /**
- * @param {Op} op - Operation to add. Ownership remains with the caller.
- */
- const append = (op) => {
- assert(op instanceof Op, 'argument must be an instance of Op');
- serialized += op.toString();
- };
- const toString = () => serialized;
- const clear = () => {
- serialized = '';
- };
- return {
- append,
- toString,
- clear,
- };
+ let serialized = '';
+ /**
+ * @param {Op} op - Operation to add. Ownership remains with the caller.
+ */
+ const append = (op) => {
+ assert(op instanceof Op, 'argument must be an instance of Op');
+ serialized += op.toString();
+ };
+ const toString = () => serialized;
+ const clear = () => {
+ serialized = '';
+ };
+ return {
+ append,
+ toString,
+ clear,
+ };
};
export const stringIterator = (str) => {
- let curIndex = 0;
- // newLines is the number of \n between curIndex and str.length
- let newLines = str.split('\n').length - 1;
- const getnewLines = () => newLines;
- const assertRemaining = (n) => {
- assert(n <= remaining(), `!(${n} <= ${remaining()})`);
- };
- const take = (n) => {
- assertRemaining(n);
- const s = str.substr(curIndex, n);
- newLines -= s.split('\n').length - 1;
- curIndex += n;
- return s;
- };
- const peek = (n) => {
- assertRemaining(n);
- const s = str.substr(curIndex, n);
- return s;
- };
- const skip = (n) => {
- assertRemaining(n);
- curIndex += n;
- };
- const remaining = () => str.length - curIndex;
- return {
- take,
- skip,
- remaining,
- peek,
- newlines: getnewLines,
- };
+ let curIndex = 0;
+ // newLines is the number of \n between curIndex and str.length
+ let newLines = str.split('\n').length - 1;
+ const getnewLines = () => newLines;
+ const assertRemaining = (n) => {
+ assert(n <= remaining(), `!(${n} <= ${remaining()})`);
+ };
+ const take = (n) => {
+ assertRemaining(n);
+ const s = str.substr(curIndex, n);
+ newLines -= s.split('\n').length - 1;
+ curIndex += n;
+ return s;
+ };
+ const peek = (n) => {
+ assertRemaining(n);
+ const s = str.substr(curIndex, n);
+ return s;
+ };
+ const skip = (n) => {
+ assertRemaining(n);
+ curIndex += n;
+ };
+ const remaining = () => str.length - curIndex;
+ return {
+ take,
+ skip,
+ remaining,
+ peek,
+ newlines: getnewLines,
+ };
};
export const stringAssembler = () => ({
- _str: '',
- clear() { this._str = ''; },
- /**
- * @param {string} x -
- */
- append(x) { this._str += String(x); },
- toString() { return this._str; },
+ _str: '',
+ clear() { this._str = ''; },
+ /**
+ * @param {string} x -
+ */
+ append(x) { this._str += String(x); },
+ toString() { return this._str; },
});
export const unpack = (cs) => {
- const headerRegex = /Z:([0-9a-z]+)([><])([0-9a-z]+)|/;
- const headerMatch = headerRegex.exec(cs);
- if ((!headerMatch) || (!headerMatch[0]))
- error(`Not a changeset: ${cs}`);
- const oldLen = exports.parseNum(headerMatch[1]);
- const changeSign = (headerMatch[2] === '>') ? 1 : -1;
- const changeMag = exports.parseNum(headerMatch[3]);
- const newLen = oldLen + changeSign * changeMag;
- const opsStart = headerMatch[0].length;
- let opsEnd = cs.indexOf('$');
- if (opsEnd < 0)
- opsEnd = cs.length;
- return {
- oldLen,
- newLen,
- ops: cs.substring(opsStart, opsEnd),
- charBank: cs.substring(opsEnd + 1),
- };
+ const headerRegex = /Z:([0-9a-z]+)([><])([0-9a-z]+)|/;
+ const headerMatch = headerRegex.exec(cs);
+ if ((!headerMatch) || (!headerMatch[0]))
+ error(`Not a changeset: ${cs}`);
+ const oldLen = exports.parseNum(headerMatch[1]);
+ const changeSign = (headerMatch[2] === '>') ? 1 : -1;
+ const changeMag = exports.parseNum(headerMatch[3]);
+ const newLen = oldLen + changeSign * changeMag;
+ const opsStart = headerMatch[0].length;
+ let opsEnd = cs.indexOf('$');
+ if (opsEnd < 0)
+ opsEnd = cs.length;
+ return {
+ oldLen,
+ newLen,
+ ops: cs.substring(opsStart, opsEnd),
+ charBank: cs.substring(opsEnd + 1),
+ };
};
export const pack = (oldLen, newLen, opsStr, bank) => {
- const lenDiff = newLen - oldLen;
- const lenDiffStr = (lenDiff >= 0 ? `>${exports.numToString(lenDiff)}`
- : `<${exports.numToString(-lenDiff)}`);
- const a = [];
- a.push('Z:', exports.numToString(oldLen), lenDiffStr, opsStr, '$', bank);
- return a.join('');
+ const lenDiff = newLen - oldLen;
+ const lenDiffStr = (lenDiff >= 0 ? `>${exports.numToString(lenDiff)}`
+ : `<${exports.numToString(-lenDiff)}`);
+ const a = [];
+ a.push('Z:', exports.numToString(oldLen), lenDiffStr, opsStr, '$', bank);
+ return a.join('');
};
export const applyToText = (cs, str) => {
- const unpacked = exports.unpack(cs);
- assert(str.length === unpacked.oldLen, `mismatched apply: ${str.length} / ${unpacked.oldLen}`);
- const bankIter = exports.stringIterator(unpacked.charBank);
- const strIter = exports.stringIterator(str);
- const assem = exports.stringAssembler();
- for (const op of exports.deserializeOps(unpacked.ops)) {
- switch (op.opcode) {
- case '+':
- // op is + and op.lines 0: no newlines must be in op.chars
- // op is + and op.lines >0: op.chars must include op.lines newlines
- if (op.lines !== bankIter.peek(op.chars).split('\n').length - 1) {
- throw new Error(`newline count is wrong in op +; cs:${cs} and text:${str}`);
- }
- assem.append(bankIter.take(op.chars));
- break;
- case '-':
- // op is - and op.lines 0: no newlines must be in the deleted string
- // op is - and op.lines >0: op.lines newlines must be in the deleted string
- if (op.lines !== strIter.peek(op.chars).split('\n').length - 1) {
- throw new Error(`newline count is wrong in op -; cs:${cs} and text:${str}`);
- }
- strIter.skip(op.chars);
- break;
- case '=':
- // op is = and op.lines 0: no newlines must be in the copied string
- // op is = and op.lines >0: op.lines newlines must be in the copied string
- if (op.lines !== strIter.peek(op.chars).split('\n').length - 1) {
- throw new Error(`newline count is wrong in op =; cs:${cs} and text:${str}`);
- }
- assem.append(strIter.take(op.chars));
- break;
+ const unpacked = exports.unpack(cs);
+ assert(str.length === unpacked.oldLen, `mismatched apply: ${str.length} / ${unpacked.oldLen}`);
+ const bankIter = exports.stringIterator(unpacked.charBank);
+ const strIter = exports.stringIterator(str);
+ const assem = exports.stringAssembler();
+ for (const op of exports.deserializeOps(unpacked.ops)) {
+ switch (op.opcode) {
+ case '+':
+ // op is + and op.lines 0: no newlines must be in op.chars
+ // op is + and op.lines >0: op.chars must include op.lines newlines
+ if (op.lines !== bankIter.peek(op.chars).split('\n').length - 1) {
+ throw new Error(`newline count is wrong in op +; cs:${cs} and text:${str}`);
+ }
+ assem.append(bankIter.take(op.chars));
+ break;
+ case '-':
+ // op is - and op.lines 0: no newlines must be in the deleted string
+ // op is - and op.lines >0: op.lines newlines must be in the deleted string
+ if (op.lines !== strIter.peek(op.chars).split('\n').length - 1) {
+ throw new Error(`newline count is wrong in op -; cs:${cs} and text:${str}`);
+ }
+ strIter.skip(op.chars);
+ break;
+ case '=':
+ // op is = and op.lines 0: no newlines must be in the copied string
+ // op is = and op.lines >0: op.lines newlines must be in the copied string
+ if (op.lines !== strIter.peek(op.chars).split('\n').length - 1) {
+ throw new Error(`newline count is wrong in op =; cs:${cs} and text:${str}`);
+ }
+ assem.append(strIter.take(op.chars));
+ break;
+ }
}
- }
- assem.append(strIter.take(strIter.remaining()));
- return assem.toString();
+ assem.append(strIter.take(strIter.remaining()));
+ return assem.toString();
};
export const mutateTextLines = (cs, lines) => {
- const unpacked = exports.unpack(cs);
- const bankIter = exports.stringIterator(unpacked.charBank);
- const mut = new TextLinesMutator(lines);
- for (const op of exports.deserializeOps(unpacked.ops)) {
- switch (op.opcode) {
- case '+':
- mut.insert(bankIter.take(op.chars), op.lines);
- break;
- case '-':
- mut.remove(op.chars, op.lines);
- break;
- case '=':
- mut.skip(op.chars, op.lines, (!!op.attribs));
- break;
+ const unpacked = exports.unpack(cs);
+ const bankIter = exports.stringIterator(unpacked.charBank);
+ const mut = new TextLinesMutator(lines);
+ for (const op of exports.deserializeOps(unpacked.ops)) {
+ switch (op.opcode) {
+ case '+':
+ mut.insert(bankIter.take(op.chars), op.lines);
+ break;
+ case '-':
+ mut.remove(op.chars, op.lines);
+ break;
+ case '=':
+ mut.skip(op.chars, op.lines, (!!op.attribs));
+ break;
+ }
}
- }
- mut.close();
+ mut.close();
};
export const composeAttributes = (att1, att2, resultIsMutation, pool) => {
- // att1 and att2 are strings like "*3*f*1c", asMutation is a boolean.
- // Sometimes attribute (key,value) pairs are treated as attribute presence
- // information, while other times they are treated as operations that
- // mutate a set of attributes, and this affects whether an empty value
- // is a deletion or a change.
- // Examples, of the form (att1Items, att2Items, resultIsMutation) -> result
- // ([], [(bold, )], true) -> [(bold, )]
- // ([], [(bold, )], false) -> []
- // ([], [(bold, true)], true) -> [(bold, true)]
- // ([], [(bold, true)], false) -> [(bold, true)]
- // ([(bold, true)], [(bold, )], true) -> [(bold, )]
- // ([(bold, true)], [(bold, )], false) -> []
- // pool can be null if att2 has no attributes.
- if ((!att1) && resultIsMutation) {
- // In the case of a mutation (i.e. composing two exportss),
- // an att2 composed with an empy att1 is just att2. If att1
- // is part of an attribution string, then att2 may remove
- // attributes that are already gone, so don't do this optimization.
- return att2;
- }
- if (!att2)
- return att1;
- return AttributeMap.fromString(att1, pool).updateFromString(att2, !resultIsMutation).toString();
+ // att1 and att2 are strings like "*3*f*1c", asMutation is a boolean.
+ // Sometimes attribute (key,value) pairs are treated as attribute presence
+ // information, while other times they are treated as operations that
+ // mutate a set of attributes, and this affects whether an empty value
+ // is a deletion or a change.
+ // Examples, of the form (att1Items, att2Items, resultIsMutation) -> result
+ // ([], [(bold, )], true) -> [(bold, )]
+ // ([], [(bold, )], false) -> []
+ // ([], [(bold, true)], true) -> [(bold, true)]
+ // ([], [(bold, true)], false) -> [(bold, true)]
+ // ([(bold, true)], [(bold, )], true) -> [(bold, )]
+ // ([(bold, true)], [(bold, )], false) -> []
+ // pool can be null if att2 has no attributes.
+ if ((!att1) && resultIsMutation) {
+ // In the case of a mutation (i.e. composing two exportss),
+ // an att2 composed with an empy att1 is just att2. If att1
+ // is part of an attribution string, then att2 may remove
+ // attributes that are already gone, so don't do this optimization.
+ return att2;
+ }
+ if (!att2)
+ return att1;
+ return AttributeMap.fromString(att1, pool).updateFromString(att2, !resultIsMutation).toString();
};
export const applyToAttribution = (cs, astr, pool) => {
- const unpacked = exports.unpack(cs);
- return applyZip(astr, unpacked.ops, (op1, op2) => slicerZipperFunc(op1, op2, pool));
+ const unpacked = exports.unpack(cs);
+ return applyZip(astr, unpacked.ops, (op1, op2) => slicerZipperFunc(op1, op2, pool));
};
export const mutateAttributionLines = (cs, lines, pool) => {
- const unpacked = exports.unpack(cs);
- const csOps = exports.deserializeOps(unpacked.ops);
- let csOpsNext = csOps.next();
- const csBank = unpacked.charBank;
- let csBankIndex = 0;
- // treat the attribution lines as text lines, mutating a line at a time
- const mut = new TextLinesMutator(lines);
- /**
- * The Ops in the current line from `lines`.
- *
- * @type {?Generator}
- */
- let lineOps = null;
- let lineOpsNext = null;
- const lineOpsHasNext = () => lineOpsNext && !lineOpsNext.done;
- /**
- * Returns false if we are on the last attribute line in `lines` and there is no additional op in
- * that line.
- *
- * @returns {boolean} True if there are more ops to go through.
- */
- const isNextMutOp = () => lineOpsHasNext() || mut.hasMore();
- /**
- * @returns {Op} The next Op from `lineIter`. If there are no more Ops, `lineIter` is reset to
- * iterate over the next line, which is consumed from `mut`. If there are no more lines,
- * returns a null Op.
- */
- const nextMutOp = () => {
- if (!lineOpsHasNext() && mut.hasMore()) {
- // There are more attribute lines in `lines` to do AND either we just started so `lineIter` is
- // still null or there are no more ops in current `lineIter`.
- const line = mut.removeLines(1);
- lineOps = exports.deserializeOps(line);
- lineOpsNext = lineOps.next();
- }
- if (!lineOpsHasNext())
- return new Op(); // No more ops and no more lines.
- const op = lineOpsNext.value;
- lineOpsNext = lineOps.next();
- return op;
- };
- let lineAssem = null;
- /**
- * Appends an op to `lineAssem`. In case `lineAssem` includes one single newline, adds it to the
- * `lines` mutator.
- */
- const outputMutOp = (op) => {
- if (!lineAssem) {
- lineAssem = exports.mergingOpAssembler();
- }
- lineAssem.append(op);
- if (op.lines <= 0)
- return;
- assert(op.lines === 1, `Can't have op.lines of ${op.lines} in attribution lines`);
- // ship it to the mut
- mut.insert(lineAssem.toString(), 1);
- lineAssem = null;
- };
- let csOp = new Op();
- let attOp = new Op();
- while (csOp.opcode || !csOpsNext.done || attOp.opcode || isNextMutOp()) {
- if (!csOp.opcode && !csOpsNext.done) {
- // coOp done, but more ops in cs.
- csOp = csOpsNext.value;
- csOpsNext = csOps.next();
- }
- if (!csOp.opcode && !attOp.opcode && !lineAssem && !lineOpsHasNext()) {
- break; // done
- }
- else if (csOp.opcode === '=' && csOp.lines > 0 && !csOp.attribs && !attOp.opcode &&
- !lineAssem && !lineOpsHasNext()) {
- // Skip multiple lines without attributes; this is what makes small changes not order of the
- // document size.
- mut.skipLines(csOp.lines);
- csOp.opcode = '';
- }
- else if (csOp.opcode === '+') {
- const opOut = copyOp(csOp);
- if (csOp.lines > 1) {
- // Copy the first line from `csOp` to `opOut`.
- const firstLineLen = csBank.indexOf('\n', csBankIndex) + 1 - csBankIndex;
- csOp.chars -= firstLineLen;
- csOp.lines--;
- opOut.lines = 1;
- opOut.chars = firstLineLen;
- }
- else {
- // Either one or no newlines in '+' `csOp`, copy to `opOut` and reset `csOp`.
- csOp.opcode = '';
- }
- outputMutOp(opOut);
- csBankIndex += opOut.chars;
- }
- else {
- if (!attOp.opcode && isNextMutOp())
- attOp = nextMutOp();
- const opOut = slicerZipperFunc(attOp, csOp, pool);
- if (opOut.opcode)
- outputMutOp(opOut);
+ const unpacked = exports.unpack(cs);
+ const csOps = exports.deserializeOps(unpacked.ops);
+ let csOpsNext = csOps.next();
+ const csBank = unpacked.charBank;
+ let csBankIndex = 0;
+ // treat the attribution lines as text lines, mutating a line at a time
+ const mut = new TextLinesMutator(lines);
+ /**
+ * The Ops in the current line from `lines`.
+ *
+ * @type {?Generator}
+ */
+ let lineOps = null;
+ let lineOpsNext = null;
+ const lineOpsHasNext = () => lineOpsNext && !lineOpsNext.done;
+ /**
+ * Returns false if we are on the last attribute line in `lines` and there is no additional op in
+ * that line.
+ *
+ * @returns {boolean} True if there are more ops to go through.
+ */
+ const isNextMutOp = () => lineOpsHasNext() || mut.hasMore();
+ /**
+ * @returns {Op} The next Op from `lineIter`. If there are no more Ops, `lineIter` is reset to
+ * iterate over the next line, which is consumed from `mut`. If there are no more lines,
+ * returns a null Op.
+ */
+ const nextMutOp = () => {
+ if (!lineOpsHasNext() && mut.hasMore()) {
+ // There are more attribute lines in `lines` to do AND either we just started so `lineIter` is
+ // still null or there are no more ops in current `lineIter`.
+ const line = mut.removeLines(1);
+ lineOps = exports.deserializeOps(line);
+ lineOpsNext = lineOps.next();
+ }
+ if (!lineOpsHasNext())
+ return new Op(); // No more ops and no more lines.
+ const op = lineOpsNext.value;
+ lineOpsNext = lineOps.next();
+ return op;
+ };
+ let lineAssem = null;
+ /**
+ * Appends an op to `lineAssem`. In case `lineAssem` includes one single newline, adds it to the
+ * `lines` mutator.
+ */
+ const outputMutOp = (op) => {
+ if (!lineAssem) {
+ lineAssem = exports.mergingOpAssembler();
+ }
+ lineAssem.append(op);
+ if (op.lines <= 0)
+ return;
+ assert(op.lines === 1, `Can't have op.lines of ${op.lines} in attribution lines`);
+ // ship it to the mut
+ mut.insert(lineAssem.toString(), 1);
+ lineAssem = null;
+ };
+ let csOp = new Op();
+ let attOp = new Op();
+ while (csOp.opcode || !csOpsNext.done || attOp.opcode || isNextMutOp()) {
+ if (!csOp.opcode && !csOpsNext.done) {
+ // coOp done, but more ops in cs.
+ csOp = csOpsNext.value;
+ csOpsNext = csOps.next();
+ }
+ if (!csOp.opcode && !attOp.opcode && !lineAssem && !lineOpsHasNext()) {
+ break; // done
+ }
+ else if (csOp.opcode === '=' && csOp.lines > 0 && !csOp.attribs && !attOp.opcode &&
+ !lineAssem && !lineOpsHasNext()) {
+ // Skip multiple lines without attributes; this is what makes small changes not order of the
+ // document size.
+ mut.skipLines(csOp.lines);
+ csOp.opcode = '';
+ }
+ else if (csOp.opcode === '+') {
+ const opOut = copyOp(csOp);
+ if (csOp.lines > 1) {
+ // Copy the first line from `csOp` to `opOut`.
+ const firstLineLen = csBank.indexOf('\n', csBankIndex) + 1 - csBankIndex;
+ csOp.chars -= firstLineLen;
+ csOp.lines--;
+ opOut.lines = 1;
+ opOut.chars = firstLineLen;
+ }
+ else {
+ // Either one or no newlines in '+' `csOp`, copy to `opOut` and reset `csOp`.
+ csOp.opcode = '';
+ }
+ outputMutOp(opOut);
+ csBankIndex += opOut.chars;
+ }
+ else {
+ if (!attOp.opcode && isNextMutOp())
+ attOp = nextMutOp();
+ const opOut = slicerZipperFunc(attOp, csOp, pool);
+ if (opOut.opcode)
+ outputMutOp(opOut);
+ }
}
- }
- assert(!lineAssem, `line assembler not finished:${cs}`);
- mut.close();
+ assert(!lineAssem, `line assembler not finished:${cs}`);
+ mut.close();
};
export const joinAttributionLines = (theAlines) => {
- const assem = exports.mergingOpAssembler();
- for (const aline of theAlines) {
- for (const op of exports.deserializeOps(aline))
- assem.append(op);
- }
- return assem.toString();
+ const assem = exports.mergingOpAssembler();
+ for (const aline of theAlines) {
+ for (const op of exports.deserializeOps(aline))
+ assem.append(op);
+ }
+ return assem.toString();
};
export const splitAttributionLines = (attrOps, text) => {
- const assem = exports.mergingOpAssembler();
- const lines = [];
- let pos = 0;
- const appendOp = (op) => {
- assem.append(op);
- if (op.lines > 0) {
- lines.push(assem.toString());
- assem.clear();
- }
- pos += op.chars;
- };
- for (const op of exports.deserializeOps(attrOps)) {
- let numChars = op.chars;
- let numLines = op.lines;
- while (numLines > 1) {
- const newlineEnd = text.indexOf('\n', pos) + 1;
- assert(newlineEnd > 0, 'newlineEnd <= 0 in splitAttributionLines');
- op.chars = newlineEnd - pos;
- op.lines = 1;
- appendOp(op);
- numChars -= op.chars;
- numLines -= op.lines;
- }
- if (numLines === 1) {
- op.chars = numChars;
- op.lines = 1;
+ const assem = exports.mergingOpAssembler();
+ const lines = [];
+ let pos = 0;
+ const appendOp = (op) => {
+ assem.append(op);
+ if (op.lines > 0) {
+ lines.push(assem.toString());
+ assem.clear();
+ }
+ pos += op.chars;
+ };
+ for (const op of exports.deserializeOps(attrOps)) {
+ let numChars = op.chars;
+ let numLines = op.lines;
+ while (numLines > 1) {
+ const newlineEnd = text.indexOf('\n', pos) + 1;
+ assert(newlineEnd > 0, 'newlineEnd <= 0 in splitAttributionLines');
+ op.chars = newlineEnd - pos;
+ op.lines = 1;
+ appendOp(op);
+ numChars -= op.chars;
+ numLines -= op.lines;
+ }
+ if (numLines === 1) {
+ op.chars = numChars;
+ op.lines = 1;
+ }
+ appendOp(op);
}
- appendOp(op);
- }
- return lines;
+ return lines;
};
export const splitTextLines = (text) => text.match(/[^\n]*(?:\n|[^\n]$)/g);
export const compose = (cs1, cs2, pool) => {
- const unpacked1 = exports.unpack(cs1);
- const unpacked2 = exports.unpack(cs2);
- const len1 = unpacked1.oldLen;
- const len2 = unpacked1.newLen;
- assert(len2 === unpacked2.oldLen, 'mismatched composition of two changesets');
- const len3 = unpacked2.newLen;
- const bankIter1 = exports.stringIterator(unpacked1.charBank);
- const bankIter2 = exports.stringIterator(unpacked2.charBank);
- const bankAssem = exports.stringAssembler();
- const newOps = applyZip(unpacked1.ops, unpacked2.ops, (op1, op2) => {
- const op1code = op1.opcode;
- const op2code = op2.opcode;
- if (op1code === '+' && op2code === '-') {
- bankIter1.skip(Math.min(op1.chars, op2.chars));
- }
- const opOut = slicerZipperFunc(op1, op2, pool);
- if (opOut.opcode === '+') {
- if (op2code === '+') {
- bankAssem.append(bankIter2.take(opOut.chars));
- }
- else {
- bankAssem.append(bankIter1.take(opOut.chars));
- }
- }
- return opOut;
- });
- return exports.pack(len1, len3, newOps, bankAssem.toString());
+ const unpacked1 = exports.unpack(cs1);
+ const unpacked2 = exports.unpack(cs2);
+ const len1 = unpacked1.oldLen;
+ const len2 = unpacked1.newLen;
+ assert(len2 === unpacked2.oldLen, 'mismatched composition of two changesets');
+ const len3 = unpacked2.newLen;
+ const bankIter1 = exports.stringIterator(unpacked1.charBank);
+ const bankIter2 = exports.stringIterator(unpacked2.charBank);
+ const bankAssem = exports.stringAssembler();
+ const newOps = applyZip(unpacked1.ops, unpacked2.ops, (op1, op2) => {
+ const op1code = op1.opcode;
+ const op2code = op2.opcode;
+ if (op1code === '+' && op2code === '-') {
+ bankIter1.skip(Math.min(op1.chars, op2.chars));
+ }
+ const opOut = slicerZipperFunc(op1, op2, pool);
+ if (opOut.opcode === '+') {
+ if (op2code === '+') {
+ bankAssem.append(bankIter2.take(opOut.chars));
+ }
+ else {
+ bankAssem.append(bankIter1.take(opOut.chars));
+ }
+ }
+ return opOut;
+ });
+ return exports.pack(len1, len3, newOps, bankAssem.toString());
};
export const attributeTester = (attribPair, pool) => {
- const never = (attribs) => false;
- if (!pool)
- return never;
- const attribNum = pool.putAttrib(attribPair, true);
- if (attribNum < 0)
- return never;
- const re = new RegExp(`\\*${exports.numToString(attribNum)}(?!\\w)`);
- return (attribs) => re.test(attribs);
+ const never = (attribs) => false;
+ if (!pool)
+ return never;
+ const attribNum = pool.putAttrib(attribPair, true);
+ if (attribNum < 0)
+ return never;
+ const re = new RegExp(`\\*${exports.numToString(attribNum)}(?!\\w)`);
+ return (attribs) => re.test(attribs);
};
export const identity = (N) => exports.pack(N, N, '', '');
export const makeSplice = (orig, start, ndel, ins, attribs, pool) => {
- 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})`);
- if (start > orig.length)
- start = orig.length;
- if (ndel > orig.length - start)
- ndel = orig.length - start;
- const deleted = orig.substring(start, start + ndel);
- const assem = exports.smartOpAssembler();
- const ops = (function* () {
- yield* opsFromText('=', orig.substring(0, start));
- yield* opsFromText('-', deleted);
- yield* opsFromText('+', ins, attribs, pool);
- })();
- for (const op of ops)
- assem.append(op);
- assem.endDocument();
- return exports.pack(orig.length, orig.length + ins.length - ndel, assem.toString(), ins);
+ 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})`);
+ if (start > orig.length)
+ start = orig.length;
+ if (ndel > orig.length - start)
+ ndel = orig.length - start;
+ const deleted = orig.substring(start, start + ndel);
+ const assem = exports.smartOpAssembler();
+ const ops = (function* () {
+ yield* opsFromText('=', orig.substring(0, start));
+ yield* opsFromText('-', deleted);
+ yield* opsFromText('+', ins, attribs, pool);
+ })();
+ for (const op of ops)
+ assem.append(op);
+ assem.endDocument();
+ return exports.pack(orig.length, orig.length + ins.length - ndel, assem.toString(), ins);
};
export const characterRangeFollow = (cs, startChar, endChar, insertionsAfter) => {
- let newStartChar = startChar;
- let newEndChar = endChar;
- let lengthChangeSoFar = 0;
- for (const splice of toSplices(cs)) {
- const spliceStart = splice[0] + lengthChangeSoFar;
- const spliceEnd = splice[1] + lengthChangeSoFar;
- const newTextLength = splice[2].length;
- const thisLengthChange = newTextLength - (spliceEnd - spliceStart);
- if (spliceStart <= newStartChar && spliceEnd >= newEndChar) {
- // splice fully replaces/deletes range
- // (also case that handles insertion at a collapsed selection)
- if (insertionsAfter) {
- newStartChar = newEndChar = spliceStart;
- }
- else {
- newStartChar = newEndChar = spliceStart + newTextLength;
- }
- }
- else if (spliceEnd <= newStartChar) {
- // splice is before range
- newStartChar += thisLengthChange;
- newEndChar += thisLengthChange;
- }
- else if (spliceStart >= newEndChar) {
- // splice is after range
- }
- else if (spliceStart >= newStartChar && spliceEnd <= newEndChar) {
- // splice is inside range
- newEndChar += thisLengthChange;
- }
- else if (spliceEnd < newEndChar) {
- // splice overlaps beginning of range
- newStartChar = spliceStart + newTextLength;
- newEndChar += thisLengthChange;
- }
- else {
- // splice overlaps end of range
- newEndChar = spliceStart;
+ let newStartChar = startChar;
+ let newEndChar = endChar;
+ let lengthChangeSoFar = 0;
+ for (const splice of toSplices(cs)) {
+ const spliceStart = splice[0] + lengthChangeSoFar;
+ const spliceEnd = splice[1] + lengthChangeSoFar;
+ const newTextLength = splice[2].length;
+ const thisLengthChange = newTextLength - (spliceEnd - spliceStart);
+ if (spliceStart <= newStartChar && spliceEnd >= newEndChar) {
+ // splice fully replaces/deletes range
+ // (also case that handles insertion at a collapsed selection)
+ if (insertionsAfter) {
+ newStartChar = newEndChar = spliceStart;
+ }
+ else {
+ newStartChar = newEndChar = spliceStart + newTextLength;
+ }
+ }
+ else if (spliceEnd <= newStartChar) {
+ // splice is before range
+ newStartChar += thisLengthChange;
+ newEndChar += thisLengthChange;
+ }
+ else if (spliceStart >= newEndChar) {
+ // splice is after range
+ }
+ else if (spliceStart >= newStartChar && spliceEnd <= newEndChar) {
+ // splice is inside range
+ newEndChar += thisLengthChange;
+ }
+ else if (spliceEnd < newEndChar) {
+ // splice overlaps beginning of range
+ newStartChar = spliceStart + newTextLength;
+ newEndChar += thisLengthChange;
+ }
+ else {
+ // splice overlaps end of range
+ newEndChar = spliceStart;
+ }
+ lengthChangeSoFar += thisLengthChange;
}
- lengthChangeSoFar += thisLengthChange;
- }
- return [newStartChar, newEndChar];
+ return [newStartChar, newEndChar];
};
export const moveOpsToNewPool = (cs, oldPool, newPool) => {
- // works on exports or attribution string
- let dollarPos = cs.indexOf('$');
- if (dollarPos < 0) {
- dollarPos = cs.length;
- }
- const upToDollar = cs.substring(0, dollarPos);
- const fromDollar = cs.substring(dollarPos);
- // order of attribs stays the same
- return upToDollar.replace(/\*([0-9a-z]+)/g, (_, a) => {
- const oldNum = exports.parseNum(a);
- const pair = oldPool.getAttrib(oldNum);
- // The attribute might not be in the old pool if the user is viewing the current revision in the
- // timeslider and text is deleted. See: https://github.com/ether/etherpad-lite/issues/3932
- if (!pair)
- return '';
- const newNum = newPool.putAttrib(pair);
- return `*${exports.numToString(newNum)}`;
- }) + fromDollar;
+ // works on exports or attribution string
+ let dollarPos = cs.indexOf('$');
+ if (dollarPos < 0) {
+ dollarPos = cs.length;
+ }
+ const upToDollar = cs.substring(0, dollarPos);
+ const fromDollar = cs.substring(dollarPos);
+ // order of attribs stays the same
+ return upToDollar.replace(/\*([0-9a-z]+)/g, (_, a) => {
+ const oldNum = exports.parseNum(a);
+ const pair = oldPool.getAttrib(oldNum);
+ // The attribute might not be in the old pool if the user is viewing the current revision in the
+ // timeslider and text is deleted. See: https://github.com/ether/etherpad-lite/issues/3932
+ if (!pair)
+ return '';
+ const newNum = newPool.putAttrib(pair);
+ return `*${exports.numToString(newNum)}`;
+ }) + fromDollar;
};
export const makeAttribution = (text) => {
- const assem = exports.smartOpAssembler();
- for (const op of opsFromText('+', text))
- assem.append(op);
- return assem.toString();
+ const assem = exports.smartOpAssembler();
+ for (const op of opsFromText('+', text))
+ assem.append(op);
+ return assem.toString();
};
export const eachAttribNumber = (cs, func) => {
- padutils.warnDeprecated('Changeset.eachAttribNumber() is deprecated; use attributes.decodeAttribString() instead');
- let dollarPos = cs.indexOf('$');
- if (dollarPos < 0) {
- dollarPos = cs.length;
- }
- const upToDollar = cs.substring(0, dollarPos);
- // WARNING: The following cannot be replaced with a call to `attributes.decodeAttribString()`
- // because that function only works on attribute strings, not serialized operations or changesets.
- upToDollar.replace(/\*([0-9a-z]+)/g, (_, a) => {
- func(exports.parseNum(a));
- return '';
- });
+ padutils.warnDeprecated('Changeset.eachAttribNumber() is deprecated; use attributes.decodeAttribString() instead');
+ let dollarPos = cs.indexOf('$');
+ if (dollarPos < 0) {
+ dollarPos = cs.length;
+ }
+ const upToDollar = cs.substring(0, dollarPos);
+ // WARNING: The following cannot be replaced with a call to `attributes.decodeAttribString()`
+ // because that function only works on attribute strings, not serialized operations or changesets.
+ upToDollar.replace(/\*([0-9a-z]+)/g, (_, a) => {
+ func(exports.parseNum(a));
+ return '';
+ });
};
export const filterAttribNumbers = (cs, filter) => exports.mapAttribNumbers(cs, filter);
export const mapAttribNumbers = (cs, func) => {
- let dollarPos = cs.indexOf('$');
- if (dollarPos < 0) {
- dollarPos = cs.length;
- }
- const upToDollar = cs.substring(0, dollarPos);
- const newUpToDollar = upToDollar.replace(/\*([0-9a-z]+)/g, (s, a) => {
- const n = func(exports.parseNum(a));
- if (n === true) {
- return s;
- }
- else if ((typeof n) === 'number') {
- return `*${exports.numToString(n)}`;
- }
- else {
- return '';
- }
- });
- return newUpToDollar + cs.substring(dollarPos);
+ let dollarPos = cs.indexOf('$');
+ if (dollarPos < 0) {
+ dollarPos = cs.length;
+ }
+ const upToDollar = cs.substring(0, dollarPos);
+ const newUpToDollar = upToDollar.replace(/\*([0-9a-z]+)/g, (s, a) => {
+ const n = func(exports.parseNum(a));
+ if (n === true) {
+ return s;
+ }
+ else if ((typeof n) === 'number') {
+ return `*${exports.numToString(n)}`;
+ }
+ else {
+ return '';
+ }
+ });
+ return newUpToDollar + cs.substring(dollarPos);
};
export const makeAText = (text, attribs) => ({
- text,
- attribs: (attribs || exports.makeAttribution(text)),
+ text,
+ attribs: (attribs || exports.makeAttribution(text)),
});
export const applyToAText = (cs, atext, pool) => ({
- text: exports.applyToText(cs, atext.text),
- attribs: exports.applyToAttribution(cs, atext.attribs, pool),
+ text: exports.applyToText(cs, atext.text),
+ attribs: exports.applyToAttribution(cs, atext.attribs, pool),
});
export const cloneAText = (atext) => {
- if (!atext)
- error('atext is null');
- return {
- text: atext.text,
- attribs: atext.attribs,
- };
+ if (!atext)
+ error('atext is null');
+ return {
+ text: atext.text,
+ attribs: atext.attribs,
+ };
};
export const copyAText = (atext1, atext2) => {
- atext2.text = atext1.text;
- atext2.attribs = atext1.attribs;
+ atext2.text = atext1.text;
+ atext2.attribs = atext1.attribs;
};
export const opsFromAText = function* (atext) {
- // intentionally skips last newline char of atext
- let lastOp = null;
- for (const op of exports.deserializeOps(atext.attribs)) {
- if (lastOp != null)
- yield lastOp;
- lastOp = op;
- }
- if (lastOp == null)
- return;
- // exclude final newline
- if (lastOp.lines <= 1) {
- lastOp.lines = 0;
- lastOp.chars--;
- }
- else {
- const nextToLastNewlineEnd = atext.text.lastIndexOf('\n', atext.text.length - 2) + 1;
- const lastLineLength = atext.text.length - nextToLastNewlineEnd - 1;
- lastOp.lines--;
- lastOp.chars -= (lastLineLength + 1);
- yield copyOp(lastOp);
- lastOp.lines = 0;
- lastOp.chars = lastLineLength;
- }
- if (lastOp.chars)
- yield lastOp;
+ // intentionally skips last newline char of atext
+ let lastOp = null;
+ for (const op of exports.deserializeOps(atext.attribs)) {
+ if (lastOp != null)
+ yield lastOp;
+ lastOp = op;
+ }
+ if (lastOp == null)
+ return;
+ // exclude final newline
+ if (lastOp.lines <= 1) {
+ lastOp.lines = 0;
+ lastOp.chars--;
+ }
+ else {
+ const nextToLastNewlineEnd = atext.text.lastIndexOf('\n', atext.text.length - 2) + 1;
+ const lastLineLength = atext.text.length - nextToLastNewlineEnd - 1;
+ lastOp.lines--;
+ lastOp.chars -= (lastLineLength + 1);
+ yield copyOp(lastOp);
+ lastOp.lines = 0;
+ lastOp.chars = lastLineLength;
+ }
+ if (lastOp.chars)
+ yield lastOp;
};
export const appendATextToAssembler = (atext, assem) => {
- padutils.warnDeprecated('Changeset.appendATextToAssembler() is deprecated; use Changeset.opsFromAText() instead');
- for (const op of exports.opsFromAText(atext))
- assem.append(op);
+ padutils.warnDeprecated('Changeset.appendATextToAssembler() is deprecated; use Changeset.opsFromAText() instead');
+ for (const op of exports.opsFromAText(atext))
+ assem.append(op);
};
export const prepareForWire = (cs, pool) => {
- const newPool = new AttributePool();
- const newCs = exports.moveOpsToNewPool(cs, pool, newPool);
- return {
- translated: newCs,
- pool: newPool,
- };
+ const newPool = new AttributePool();
+ const newCs = exports.moveOpsToNewPool(cs, pool, newPool);
+ return {
+ translated: newCs,
+ pool: newPool,
+ };
};
export const isIdentity = (cs) => {
- const unpacked = exports.unpack(cs);
- return unpacked.ops === '' && unpacked.oldLen === unpacked.newLen;
+ const unpacked = exports.unpack(cs);
+ return unpacked.ops === '' && unpacked.oldLen === unpacked.newLen;
};
export const opAttributeValue = (op, key, pool) => {
- padutils.warnDeprecated('Changeset.opAttributeValue() is deprecated; use an AttributeMap instead');
- return attribsAttributeValue(op.attribs, key, pool);
+ padutils.warnDeprecated('Changeset.opAttributeValue() is deprecated; use an AttributeMap instead');
+ return attribsAttributeValue(op.attribs, key, pool);
};
const attribsAttributeValue$0 = (attribs, key, pool) => {
- padutils.warnDeprecated('Changeset.attribsAttributeValue() is deprecated; use an AttributeMap instead');
- return attribsAttributeValue(attribs, key, pool);
+ padutils.warnDeprecated('Changeset.attribsAttributeValue() is deprecated; use an AttributeMap instead');
+ return attribsAttributeValue(attribs, key, pool);
};
export const builder = (oldLen) => {
- const assem = exports.smartOpAssembler();
- const o = new Op();
- const charBank = exports.stringAssembler();
- const self = {
- /**
- * @param {number} N - Number of characters to keep.
- * @param {number} L - Number of newlines among the `N` characters. If positive, the last
- * character must be a newline.
- * @param {(string|Attribute[])} attribs - Either [[key1,value1],[key2,value2],...] or '*0*1...'
- * (no pool needed in latter case).
- * @param {?AttributePool} pool - Attribute pool, only required if `attribs` is a list of
- * attribute key, value pairs.
- * @returns {Builder} this
- */
- keep: (N, L, attribs, pool) => {
- o.opcode = '=';
- o.attribs = typeof attribs === 'string'
- ? attribs : new AttributeMap(pool).update(attribs || []).toString();
- o.chars = N;
- o.lines = (L || 0);
- assem.append(o);
- return self;
- },
- /**
- * @param {string} text - Text to keep.
- * @param {(string|Attribute[])} attribs - Either [[key1,value1],[key2,value2],...] or '*0*1...'
- * (no pool needed in latter case).
- * @param {?AttributePool} pool - Attribute pool, only required if `attribs` is a list of
- * attribute key, value pairs.
- * @returns {Builder} this
- */
- keepText: (text, attribs, pool) => {
- for (const op of opsFromText('=', text, attribs, pool))
- assem.append(op);
- return self;
- },
- /**
- * @param {string} text - Text to insert.
- * @param {(string|Attribute[])} attribs - Either [[key1,value1],[key2,value2],...] or '*0*1...'
- * (no pool needed in latter case).
- * @param {?AttributePool} pool - Attribute pool, only required if `attribs` is a list of
- * attribute key, value pairs.
- * @returns {Builder} this
- */
- insert: (text, attribs, pool) => {
- for (const op of opsFromText('+', text, attribs, pool))
- assem.append(op);
- charBank.append(text);
- return self;
- },
- /**
- * @param {number} N - Number of characters to remove.
- * @param {number} L - Number of newlines among the `N` characters. If positive, the last
- * character must be a newline.
- * @returns {Builder} this
- */
- remove: (N, L) => {
- o.opcode = '-';
- o.attribs = '';
- o.chars = N;
- o.lines = (L || 0);
- assem.append(o);
- return self;
- },
- toString: () => {
- assem.endDocument();
- const newLen = oldLen + assem.getLengthChange();
- return exports.pack(oldLen, newLen, assem.toString(), charBank.toString());
- },
- };
- return self;
+ const assem = exports.smartOpAssembler();
+ const o = new Op();
+ const charBank = exports.stringAssembler();
+ const self = {
+ /**
+ * @param {number} N - Number of characters to keep.
+ * @param {number} L - Number of newlines among the `N` characters. If positive, the last
+ * character must be a newline.
+ * @param {(string|Attribute[])} attribs - Either [[key1,value1],[key2,value2],...] or '*0*1...'
+ * (no pool needed in latter case).
+ * @param {?AttributePool} pool - Attribute pool, only required if `attribs` is a list of
+ * attribute key, value pairs.
+ * @returns {Builder} this
+ */
+ keep: (N, L, attribs, pool) => {
+ o.opcode = '=';
+ o.attribs = typeof attribs === 'string'
+ ? attribs : new AttributeMap(pool).update(attribs || []).toString();
+ o.chars = N;
+ o.lines = (L || 0);
+ assem.append(o);
+ return self;
+ },
+ /**
+ * @param {string} text - Text to keep.
+ * @param {(string|Attribute[])} attribs - Either [[key1,value1],[key2,value2],...] or '*0*1...'
+ * (no pool needed in latter case).
+ * @param {?AttributePool} pool - Attribute pool, only required if `attribs` is a list of
+ * attribute key, value pairs.
+ * @returns {Builder} this
+ */
+ keepText: (text, attribs, pool) => {
+ for (const op of opsFromText('=', text, attribs, pool))
+ assem.append(op);
+ return self;
+ },
+ /**
+ * @param {string} text - Text to insert.
+ * @param {(string|Attribute[])} attribs - Either [[key1,value1],[key2,value2],...] or '*0*1...'
+ * (no pool needed in latter case).
+ * @param {?AttributePool} pool - Attribute pool, only required if `attribs` is a list of
+ * attribute key, value pairs.
+ * @returns {Builder} this
+ */
+ insert: (text, attribs, pool) => {
+ for (const op of opsFromText('+', text, attribs, pool))
+ assem.append(op);
+ charBank.append(text);
+ return self;
+ },
+ /**
+ * @param {number} N - Number of characters to remove.
+ * @param {number} L - Number of newlines among the `N` characters. If positive, the last
+ * character must be a newline.
+ * @returns {Builder} this
+ */
+ remove: (N, L) => {
+ o.opcode = '-';
+ o.attribs = '';
+ o.chars = N;
+ o.lines = (L || 0);
+ assem.append(o);
+ return self;
+ },
+ toString: () => {
+ assem.endDocument();
+ const newLen = oldLen + assem.getLengthChange();
+ return exports.pack(oldLen, newLen, assem.toString(), charBank.toString());
+ },
+ };
+ return self;
};
export const makeAttribsString = (opcode, attribs, pool) => {
- padutils.warnDeprecated('Changeset.makeAttribsString() is deprecated; ' +
- 'use AttributeMap.prototype.toString() or attributes.attribsToString() instead');
- if (!attribs || !['=', '+'].includes(opcode))
- return '';
- if (typeof attribs === 'string')
- return attribs;
- return new AttributeMap(pool).update(attribs, opcode === '+').toString();
+ padutils.warnDeprecated('Changeset.makeAttribsString() is deprecated; ' +
+ 'use AttributeMap.prototype.toString() or attributes.attribsToString() instead');
+ if (!attribs || !['=', '+'].includes(opcode))
+ return '';
+ if (typeof attribs === 'string')
+ return attribs;
+ return new AttributeMap(pool).update(attribs, opcode === '+').toString();
};
export const subattribution = (astr, start, optEnd) => {
- const attOps = exports.deserializeOps(astr);
- let attOpsNext = attOps.next();
- const assem = exports.smartOpAssembler();
- let attOp = new Op();
- const csOp = new Op();
- const doCsOp = () => {
- if (!csOp.chars)
- return;
- while (csOp.opcode && (attOp.opcode || !attOpsNext.done)) {
- if (!attOp.opcode) {
- attOp = attOpsNext.value;
- attOpsNext = attOps.next();
- }
- if (csOp.opcode && attOp.opcode && csOp.chars >= attOp.chars &&
- attOp.lines > 0 && csOp.lines <= 0) {
- csOp.lines++;
- }
- const opOut = slicerZipperFunc(attOp, csOp, null);
- if (opOut.opcode)
- assem.append(opOut);
- }
- };
- csOp.opcode = '-';
- csOp.chars = start;
- doCsOp();
- if (optEnd === undefined) {
- if (attOp.opcode) {
- assem.append(attOp);
- }
- while (!attOpsNext.done) {
- assem.append(attOpsNext.value);
- attOpsNext = attOps.next();
- }
- }
- else {
- csOp.opcode = '=';
- csOp.chars = optEnd - start;
+ const attOps = exports.deserializeOps(astr);
+ let attOpsNext = attOps.next();
+ const assem = exports.smartOpAssembler();
+ let attOp = new Op();
+ const csOp = new Op();
+ const doCsOp = () => {
+ if (!csOp.chars)
+ return;
+ while (csOp.opcode && (attOp.opcode || !attOpsNext.done)) {
+ if (!attOp.opcode) {
+ attOp = attOpsNext.value;
+ attOpsNext = attOps.next();
+ }
+ if (csOp.opcode && attOp.opcode && csOp.chars >= attOp.chars &&
+ attOp.lines > 0 && csOp.lines <= 0) {
+ csOp.lines++;
+ }
+ const opOut = slicerZipperFunc(attOp, csOp, null);
+ if (opOut.opcode)
+ assem.append(opOut);
+ }
+ };
+ csOp.opcode = '-';
+ csOp.chars = start;
doCsOp();
- }
- return assem.toString();
-};
-export const inverse = (cs, lines, alines, pool) => {
- // lines and alines are what the exports is meant to apply to.
- // They may be arrays or objects with .get(i) and .length methods.
- // They include final newlines on lines.
- const linesGet = (idx) => {
- if (lines.get) {
- return lines.get(idx);
- }
- else {
- return lines[idx];
- }
- };
- /**
- * @param {number} idx -
- * @returns {string}
- */
- const alinesGet = (idx) => {
- if (alines.get) {
- return alines.get(idx);
+ if (optEnd === undefined) {
+ if (attOp.opcode) {
+ assem.append(attOp);
+ }
+ while (!attOpsNext.done) {
+ assem.append(attOpsNext.value);
+ attOpsNext = attOps.next();
+ }
}
else {
- return alines[idx];
- }
- };
- let curLine = 0;
- let curChar = 0;
- let curLineOps = null;
- let curLineOpsNext = null;
- let curLineOpsLine;
- let curLineNextOp = new Op('+');
- const unpacked = exports.unpack(cs);
- const builder = exports.builder(unpacked.newLen);
- const consumeAttribRuns = (numChars, func /* (len, attribs, endsLine)*/) => {
- if (!curLineOps || curLineOpsLine !== curLine) {
- curLineOps = exports.deserializeOps(alinesGet(curLine));
- curLineOpsNext = curLineOps.next();
- curLineOpsLine = curLine;
- let indexIntoLine = 0;
- while (!curLineOpsNext.done) {
- curLineNextOp = curLineOpsNext.value;
- curLineOpsNext = curLineOps.next();
- if (indexIntoLine + curLineNextOp.chars >= curChar) {
- curLineNextOp.chars -= (curChar - indexIntoLine);
- break;
- }
- indexIntoLine += curLineNextOp.chars;
- }
+ csOp.opcode = '=';
+ csOp.chars = optEnd - start;
+ doCsOp();
}
- while (numChars > 0) {
- if (!curLineNextOp.chars && curLineOpsNext.done) {
- curLine++;
- curChar = 0;
- curLineOpsLine = curLine;
- curLineNextOp.chars = 0;
- curLineOps = exports.deserializeOps(alinesGet(curLine));
- curLineOpsNext = curLineOps.next();
- }
- if (!curLineNextOp.chars) {
- if (curLineOpsNext.done) {
- curLineNextOp = new Op();
+ return assem.toString();
+};
+export const inverse = (cs, lines, alines, pool) => {
+ // lines and alines are what the exports is meant to apply to.
+ // They may be arrays or objects with .get(i) and .length methods.
+ // They include final newlines on lines.
+ const linesGet = (idx) => {
+ if (lines.get) {
+ return lines.get(idx);
}
else {
- curLineNextOp = curLineOpsNext.value;
- curLineOpsNext = curLineOps.next();
- }
- }
- const charsToUse = Math.min(numChars, curLineNextOp.chars);
- func(charsToUse, curLineNextOp.attribs, charsToUse === curLineNextOp.chars &&
- curLineNextOp.lines > 0);
- numChars -= charsToUse;
- curLineNextOp.chars -= charsToUse;
- curChar += charsToUse;
- }
- if (!curLineNextOp.chars && curLineOpsNext.done) {
- curLine++;
- curChar = 0;
- }
- };
- const skip = (N, L) => {
- if (L) {
- curLine += L;
- curChar = 0;
- }
- else if (curLineOps && curLineOpsLine === curLine) {
- consumeAttribRuns(N, () => { });
- }
- else {
- curChar += N;
- }
- };
- const nextText = (numChars) => {
- let len = 0;
- const assem = exports.stringAssembler();
- const firstString = linesGet(curLine).substring(curChar);
- len += firstString.length;
- assem.append(firstString);
- let lineNum = curLine + 1;
- while (len < numChars) {
- const nextString = linesGet(lineNum);
- len += nextString.length;
- assem.append(nextString);
- lineNum++;
- }
- return assem.toString().substring(0, numChars);
- };
- const cachedStrFunc = (func) => {
- const cache = {};
- return (s) => {
- if (!cache[s]) {
- cache[s] = func(s);
- }
- return cache[s];
+ return lines[idx];
+ }
};
- };
- for (const csOp of exports.deserializeOps(unpacked.ops)) {
- if (csOp.opcode === '=') {
- if (csOp.attribs) {
- const attribs = AttributeMap.fromString(csOp.attribs, pool);
- const undoBackToAttribs = cachedStrFunc((oldAttribsStr) => {
- const oldAttribs = AttributeMap.fromString(oldAttribsStr, pool);
- const backAttribs = new AttributeMap(pool);
- for (const [key, value] of attribs) {
- const oldValue = oldAttribs.get(key) || '';
- if (oldValue !== value)
- backAttribs.set(key, oldValue);
- }
- // TODO: backAttribs does not restore removed attributes (it is missing attributes that
- // are in oldAttribs but not in attribs). I don't know if that is intentional.
- return backAttribs.toString();
- });
- consumeAttribRuns(csOp.chars, (len, attribs, endsLine) => {
- builder.keep(len, endsLine ? 1 : 0, undoBackToAttribs(attribs));
- });
- }
- else {
- skip(csOp.chars, csOp.lines);
- builder.keep(csOp.chars, csOp.lines);
- }
- }
- else if (csOp.opcode === '+') {
- builder.remove(csOp.chars, csOp.lines);
- }
- else if (csOp.opcode === '-') {
- const textBank = nextText(csOp.chars);
- let textBankIndex = 0;
- consumeAttribRuns(csOp.chars, (len, attribs, endsLine) => {
- builder.insert(textBank.substr(textBankIndex, len), attribs);
- textBankIndex += len;
- });
+ /**
+ * @param {number} idx -
+ * @returns {string}
+ */
+ const alinesGet = (idx) => {
+ if (alines.get) {
+ return alines.get(idx);
+ }
+ else {
+ return alines[idx];
+ }
+ };
+ let curLine = 0;
+ let curChar = 0;
+ let curLineOps = null;
+ let curLineOpsNext = null;
+ let curLineOpsLine;
+ let curLineNextOp = new Op('+');
+ const unpacked = exports.unpack(cs);
+ const builder = exports.builder(unpacked.newLen);
+ const consumeAttribRuns = (numChars, func /* (len, attribs, endsLine)*/) => {
+ if (!curLineOps || curLineOpsLine !== curLine) {
+ curLineOps = exports.deserializeOps(alinesGet(curLine));
+ curLineOpsNext = curLineOps.next();
+ curLineOpsLine = curLine;
+ let indexIntoLine = 0;
+ while (!curLineOpsNext.done) {
+ curLineNextOp = curLineOpsNext.value;
+ curLineOpsNext = curLineOps.next();
+ if (indexIntoLine + curLineNextOp.chars >= curChar) {
+ curLineNextOp.chars -= (curChar - indexIntoLine);
+ break;
+ }
+ indexIntoLine += curLineNextOp.chars;
+ }
+ }
+ while (numChars > 0) {
+ if (!curLineNextOp.chars && curLineOpsNext.done) {
+ curLine++;
+ curChar = 0;
+ curLineOpsLine = curLine;
+ curLineNextOp.chars = 0;
+ curLineOps = exports.deserializeOps(alinesGet(curLine));
+ curLineOpsNext = curLineOps.next();
+ }
+ if (!curLineNextOp.chars) {
+ if (curLineOpsNext.done) {
+ curLineNextOp = new Op();
+ }
+ else {
+ curLineNextOp = curLineOpsNext.value;
+ curLineOpsNext = curLineOps.next();
+ }
+ }
+ const charsToUse = Math.min(numChars, curLineNextOp.chars);
+ func(charsToUse, curLineNextOp.attribs, charsToUse === curLineNextOp.chars &&
+ curLineNextOp.lines > 0);
+ numChars -= charsToUse;
+ curLineNextOp.chars -= charsToUse;
+ curChar += charsToUse;
+ }
+ if (!curLineNextOp.chars && curLineOpsNext.done) {
+ curLine++;
+ curChar = 0;
+ }
+ };
+ const skip = (N, L) => {
+ if (L) {
+ curLine += L;
+ curChar = 0;
+ }
+ else if (curLineOps && curLineOpsLine === curLine) {
+ consumeAttribRuns(N, () => { });
+ }
+ else {
+ curChar += N;
+ }
+ };
+ const nextText = (numChars) => {
+ let len = 0;
+ const assem = exports.stringAssembler();
+ const firstString = linesGet(curLine).substring(curChar);
+ len += firstString.length;
+ assem.append(firstString);
+ let lineNum = curLine + 1;
+ while (len < numChars) {
+ const nextString = linesGet(lineNum);
+ len += nextString.length;
+ assem.append(nextString);
+ lineNum++;
+ }
+ return assem.toString().substring(0, numChars);
+ };
+ const cachedStrFunc = (func) => {
+ const cache = {};
+ return (s) => {
+ if (!cache[s]) {
+ cache[s] = func(s);
+ }
+ return cache[s];
+ };
+ };
+ for (const csOp of exports.deserializeOps(unpacked.ops)) {
+ if (csOp.opcode === '=') {
+ if (csOp.attribs) {
+ const attribs = AttributeMap.fromString(csOp.attribs, pool);
+ const undoBackToAttribs = cachedStrFunc((oldAttribsStr) => {
+ const oldAttribs = AttributeMap.fromString(oldAttribsStr, pool);
+ const backAttribs = new AttributeMap(pool);
+ for (const [key, value] of attribs) {
+ const oldValue = oldAttribs.get(key) || '';
+ if (oldValue !== value)
+ backAttribs.set(key, oldValue);
+ }
+ // TODO: backAttribs does not restore removed attributes (it is missing attributes that
+ // are in oldAttribs but not in attribs). I don't know if that is intentional.
+ return backAttribs.toString();
+ });
+ consumeAttribRuns(csOp.chars, (len, attribs, endsLine) => {
+ builder.keep(len, endsLine ? 1 : 0, undoBackToAttribs(attribs));
+ });
+ }
+ else {
+ skip(csOp.chars, csOp.lines);
+ builder.keep(csOp.chars, csOp.lines);
+ }
+ }
+ else if (csOp.opcode === '+') {
+ builder.remove(csOp.chars, csOp.lines);
+ }
+ else if (csOp.opcode === '-') {
+ const textBank = nextText(csOp.chars);
+ let textBankIndex = 0;
+ consumeAttribRuns(csOp.chars, (len, attribs, endsLine) => {
+ builder.insert(textBank.substr(textBankIndex, len), attribs);
+ textBankIndex += len;
+ });
+ }
}
- }
- return exports.checkRep(builder.toString());
+ return exports.checkRep(builder.toString());
};
export const follow = (cs1, cs2, reverseInsertOrder, pool) => {
- const unpacked1 = exports.unpack(cs1);
- const unpacked2 = exports.unpack(cs2);
- const len1 = unpacked1.oldLen;
- const len2 = unpacked2.oldLen;
- assert(len1 === len2, 'mismatched follow - cannot transform cs1 on top of cs2');
- const chars1 = exports.stringIterator(unpacked1.charBank);
- const chars2 = exports.stringIterator(unpacked2.charBank);
- const oldLen = unpacked1.newLen;
- let oldPos = 0;
- let newLen = 0;
- const hasInsertFirst = exports.attributeTester(['insertorder', 'first'], pool);
- const newOps = applyZip(unpacked1.ops, unpacked2.ops, (op1, op2) => {
- const opOut = new Op();
- if (op1.opcode === '+' || op2.opcode === '+') {
- let whichToDo;
- if (op2.opcode !== '+') {
- whichToDo = 1;
- }
- else if (op1.opcode !== '+') {
- whichToDo = 2;
- }
- else {
- // both +
- const firstChar1 = chars1.peek(1);
- const firstChar2 = chars2.peek(1);
- const insertFirst1 = hasInsertFirst(op1.attribs);
- const insertFirst2 = hasInsertFirst(op2.attribs);
- if (insertFirst1 && !insertFirst2) {
- whichToDo = 1;
- }
- else if (insertFirst2 && !insertFirst1) {
- whichToDo = 2;
- }
- else if (firstChar1 === '\n' && firstChar2 !== '\n') {
- // insert string that doesn't start with a newline first so as not to break up lines
- whichToDo = 2;
- }
- else if (firstChar1 !== '\n' && firstChar2 === '\n') {
- whichToDo = 1;
- }
- else if (reverseInsertOrder) {
- // break symmetry:
- whichToDo = 2;
+ const unpacked1 = exports.unpack(cs1);
+ const unpacked2 = exports.unpack(cs2);
+ const len1 = unpacked1.oldLen;
+ const len2 = unpacked2.oldLen;
+ assert(len1 === len2, 'mismatched follow - cannot transform cs1 on top of cs2');
+ const chars1 = exports.stringIterator(unpacked1.charBank);
+ const chars2 = exports.stringIterator(unpacked2.charBank);
+ const oldLen = unpacked1.newLen;
+ let oldPos = 0;
+ let newLen = 0;
+ const hasInsertFirst = exports.attributeTester(['insertorder', 'first'], pool);
+ const newOps = applyZip(unpacked1.ops, unpacked2.ops, (op1, op2) => {
+ const opOut = new Op();
+ if (op1.opcode === '+' || op2.opcode === '+') {
+ let whichToDo;
+ if (op2.opcode !== '+') {
+ whichToDo = 1;
+ }
+ else if (op1.opcode !== '+') {
+ whichToDo = 2;
+ }
+ else {
+ // both +
+ const firstChar1 = chars1.peek(1);
+ const firstChar2 = chars2.peek(1);
+ const insertFirst1 = hasInsertFirst(op1.attribs);
+ const insertFirst2 = hasInsertFirst(op2.attribs);
+ if (insertFirst1 && !insertFirst2) {
+ whichToDo = 1;
+ }
+ else if (insertFirst2 && !insertFirst1) {
+ whichToDo = 2;
+ }
+ else if (firstChar1 === '\n' && firstChar2 !== '\n') {
+ // insert string that doesn't start with a newline first so as not to break up lines
+ whichToDo = 2;
+ }
+ else if (firstChar1 !== '\n' && firstChar2 === '\n') {
+ whichToDo = 1;
+ }
+ else if (reverseInsertOrder) {
+ // break symmetry:
+ whichToDo = 2;
+ }
+ else {
+ whichToDo = 1;
+ }
+ }
+ if (whichToDo === 1) {
+ chars1.skip(op1.chars);
+ opOut.opcode = '=';
+ opOut.lines = op1.lines;
+ opOut.chars = op1.chars;
+ opOut.attribs = '';
+ op1.opcode = '';
+ }
+ else {
+ // whichToDo == 2
+ chars2.skip(op2.chars);
+ copyOp(op2, opOut);
+ op2.opcode = '';
+ }
+ }
+ else if (op1.opcode === '-') {
+ if (!op2.opcode) {
+ op1.opcode = '';
+ }
+ else if (op1.chars <= op2.chars) {
+ op2.chars -= op1.chars;
+ op2.lines -= op1.lines;
+ op1.opcode = '';
+ if (!op2.chars) {
+ op2.opcode = '';
+ }
+ }
+ else {
+ op1.chars -= op2.chars;
+ op1.lines -= op2.lines;
+ op2.opcode = '';
+ }
+ }
+ else if (op2.opcode === '-') {
+ copyOp(op2, opOut);
+ if (!op1.opcode) {
+ op2.opcode = '';
+ }
+ else if (op2.chars <= op1.chars) {
+ // delete part or all of a keep
+ op1.chars -= op2.chars;
+ op1.lines -= op2.lines;
+ op2.opcode = '';
+ if (!op1.chars) {
+ op1.opcode = '';
+ }
+ }
+ else {
+ // delete all of a keep, and keep going
+ opOut.lines = op1.lines;
+ opOut.chars = op1.chars;
+ op2.lines -= op1.lines;
+ op2.chars -= op1.chars;
+ op1.opcode = '';
+ }
+ }
+ else if (!op1.opcode) {
+ copyOp(op2, opOut);
+ op2.opcode = '';
+ }
+ else if (!op2.opcode) {
+ // @NOTE: Critical bugfix for EPL issue #1625. We do not copy op1 here
+ // in order to prevent attributes from leaking into result changesets.
+ // copyOp(op1, opOut);
+ op1.opcode = '';
}
else {
- whichToDo = 1;
- }
- }
- if (whichToDo === 1) {
- chars1.skip(op1.chars);
- opOut.opcode = '=';
- opOut.lines = op1.lines;
- opOut.chars = op1.chars;
- opOut.attribs = '';
- op1.opcode = '';
- }
- else {
- // whichToDo == 2
- chars2.skip(op2.chars);
- copyOp(op2, opOut);
- op2.opcode = '';
- }
- }
- else if (op1.opcode === '-') {
- if (!op2.opcode) {
- op1.opcode = '';
- }
- else if (op1.chars <= op2.chars) {
- op2.chars -= op1.chars;
- op2.lines -= op1.lines;
- op1.opcode = '';
- if (!op2.chars) {
- op2.opcode = '';
- }
- }
- else {
- op1.chars -= op2.chars;
- op1.lines -= op2.lines;
- op2.opcode = '';
- }
- }
- else if (op2.opcode === '-') {
- copyOp(op2, opOut);
- if (!op1.opcode) {
- op2.opcode = '';
- }
- else if (op2.chars <= op1.chars) {
- // delete part or all of a keep
- op1.chars -= op2.chars;
- op1.lines -= op2.lines;
- op2.opcode = '';
- if (!op1.chars) {
- op1.opcode = '';
- }
- }
- else {
- // delete all of a keep, and keep going
- opOut.lines = op1.lines;
- opOut.chars = op1.chars;
- op2.lines -= op1.lines;
- op2.chars -= op1.chars;
- op1.opcode = '';
- }
- }
- else if (!op1.opcode) {
- copyOp(op2, opOut);
- op2.opcode = '';
- }
- else if (!op2.opcode) {
- // @NOTE: Critical bugfix for EPL issue #1625. We do not copy op1 here
- // in order to prevent attributes from leaking into result changesets.
- // copyOp(op1, opOut);
- op1.opcode = '';
- }
- else {
- // both keeps
- opOut.opcode = '=';
- opOut.attribs = followAttributes(op1.attribs, op2.attribs, pool);
- if (op1.chars <= op2.chars) {
- opOut.chars = op1.chars;
- opOut.lines = op1.lines;
- op2.chars -= op1.chars;
- op2.lines -= op1.lines;
- op1.opcode = '';
- if (!op2.chars) {
- op2.opcode = '';
- }
- }
- else {
- opOut.chars = op2.chars;
- opOut.lines = op2.lines;
- op1.chars -= op2.chars;
- op1.lines -= op2.lines;
- op2.opcode = '';
- }
- }
- switch (opOut.opcode) {
- case '=':
- oldPos += opOut.chars;
- newLen += opOut.chars;
- break;
- case '-':
- oldPos += opOut.chars;
- break;
- case '+':
- newLen += opOut.chars;
- break;
- }
- return opOut;
- });
- newLen += oldLen - oldPos;
- return exports.pack(oldLen, newLen, newOps, unpacked2.charBank);
+ // both keeps
+ opOut.opcode = '=';
+ opOut.attribs = followAttributes(op1.attribs, op2.attribs, pool);
+ if (op1.chars <= op2.chars) {
+ opOut.chars = op1.chars;
+ opOut.lines = op1.lines;
+ op2.chars -= op1.chars;
+ op2.lines -= op1.lines;
+ op1.opcode = '';
+ if (!op2.chars) {
+ op2.opcode = '';
+ }
+ }
+ else {
+ opOut.chars = op2.chars;
+ opOut.lines = op2.lines;
+ op1.chars -= op2.chars;
+ op1.lines -= op2.lines;
+ op2.opcode = '';
+ }
+ }
+ switch (opOut.opcode) {
+ case '=':
+ oldPos += opOut.chars;
+ newLen += opOut.chars;
+ break;
+ case '-':
+ oldPos += opOut.chars;
+ break;
+ case '+':
+ newLen += opOut.chars;
+ break;
+ }
+ return opOut;
+ });
+ newLen += oldLen - oldPos;
+ return exports.pack(oldLen, newLen, newOps, unpacked2.charBank);
};
export const exportedForTestingOnly = {
- TextLinesMutator,
- followAttributes,
- toSplices,
+ TextLinesMutator,
+ followAttributes,
+ toSplices,
};
export { Op };
export { attribsAttributeValue$0 as attribsAttributeValue };
diff --git a/src/static/js/ChangesetUtils.js b/src/static/js/ChangesetUtils.js
index ef2be2ebe07..b63481a5167 100644
--- a/src/static/js/ChangesetUtils.js
+++ b/src/static/js/ChangesetUtils.js
@@ -1,52 +1,28 @@
'use strict';
-
-/**
- * This module contains several helper Functions to build Changesets
- * based on a SkipList
- */
-
-/**
- * Copyright 2009 Google Inc.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS-IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-exports.buildRemoveRange = (rep, builder, start, end) => {
- const startLineOffset = rep.lines.offsetOfIndex(start[0]);
- const endLineOffset = rep.lines.offsetOfIndex(end[0]);
-
- if (end[0] > start[0]) {
- builder.remove(endLineOffset - startLineOffset - start[1], end[0] - start[0]);
- builder.remove(end[1]);
- } else {
- builder.remove(end[1] - start[1]);
- }
+export const buildRemoveRange = (rep, builder, start, end) => {
+ const startLineOffset = rep.lines.offsetOfIndex(start[0]);
+ const endLineOffset = rep.lines.offsetOfIndex(end[0]);
+ if (end[0] > start[0]) {
+ builder.remove(endLineOffset - startLineOffset - start[1], end[0] - start[0]);
+ builder.remove(end[1]);
+ }
+ else {
+ builder.remove(end[1] - start[1]);
+ }
};
-
-exports.buildKeepRange = (rep, builder, start, end, attribs, pool) => {
- const startLineOffset = rep.lines.offsetOfIndex(start[0]);
- const endLineOffset = rep.lines.offsetOfIndex(end[0]);
-
- if (end[0] > start[0]) {
- builder.keep(endLineOffset - startLineOffset - start[1], end[0] - start[0], attribs, pool);
- builder.keep(end[1], 0, attribs, pool);
- } else {
- builder.keep(end[1] - start[1], 0, attribs, pool);
- }
+export const buildKeepRange = (rep, builder, start, end, attribs, pool) => {
+ const startLineOffset = rep.lines.offsetOfIndex(start[0]);
+ const endLineOffset = rep.lines.offsetOfIndex(end[0]);
+ if (end[0] > start[0]) {
+ builder.keep(endLineOffset - startLineOffset - start[1], end[0] - start[0], attribs, pool);
+ builder.keep(end[1], 0, attribs, pool);
+ }
+ else {
+ builder.keep(end[1] - start[1], 0, attribs, pool);
+ }
};
-
-exports.buildKeepToStartOfRange = (rep, builder, start) => {
- const startLineOffset = rep.lines.offsetOfIndex(start[0]);
-
- builder.keep(startLineOffset, start[0]);
- builder.keep(start[1]);
+export const buildKeepToStartOfRange = (rep, builder, start) => {
+ const startLineOffset = rep.lines.offsetOfIndex(start[0]);
+ builder.keep(startLineOffset, start[0]);
+ builder.keep(start[1]);
};
diff --git a/src/static/js/ChatMessage.js b/src/static/js/ChatMessage.js
index a627f88f9f3..c9cc87e2879 100644
--- a/src/static/js/ChatMessage.js
+++ b/src/static/js/ChatMessage.js
@@ -1,7 +1,6 @@
+import { padutils } from "./pad_utils.js";
'use strict';
-
-const {padutils: {warnDeprecated}} = require('./pad_utils');
-
+const { padutils: { warnDeprecated } } = { padutils };
/**
* Represents a chat message stored in the database and transmitted among users. Plugins can extend
* the object with additional properties.
@@ -9,90 +8,84 @@ const {padutils: {warnDeprecated}} = require('./pad_utils');
* Supports serialization to JSON.
*/
class ChatMessage {
- static fromObject(obj) {
- // The userId property was renamed to authorId, and userName was renamed to displayName. Accept
- // the old names in case the db record was written by an older version of Etherpad.
- obj = Object.assign({}, obj); // Don't mutate the caller's object.
- if ('userId' in obj && !('authorId' in obj)) obj.authorId = obj.userId;
- delete obj.userId;
- if ('userName' in obj && !('displayName' in obj)) obj.displayName = obj.userName;
- delete obj.userName;
- return Object.assign(new ChatMessage(), obj);
- }
-
- /**
- * @param {?string} [text] - Initial value of the `text` property.
- * @param {?string} [authorId] - Initial value of the `authorId` property.
- * @param {?number} [time] - Initial value of the `time` property.
- */
- constructor(text = null, authorId = null, time = null) {
+ static fromObject(obj) {
+ // The userId property was renamed to authorId, and userName was renamed to displayName. Accept
+ // the old names in case the db record was written by an older version of Etherpad.
+ obj = Object.assign({}, obj); // Don't mutate the caller's object.
+ if ('userId' in obj && !('authorId' in obj))
+ obj.authorId = obj.userId;
+ delete obj.userId;
+ if ('userName' in obj && !('displayName' in obj))
+ obj.displayName = obj.userName;
+ delete obj.userName;
+ return Object.assign(new ChatMessage(), obj);
+ }
/**
- * The raw text of the user's chat message (before any rendering or processing).
- *
- * @type {?string}
- */
- this.text = text;
-
- /**
- * The user's author ID.
- *
- * @type {?string}
+ * @param {?string} [text] - Initial value of the `text` property.
+ * @param {?string} [authorId] - Initial value of the `authorId` property.
+ * @param {?number} [time] - Initial value of the `time` property.
*/
- this.authorId = authorId;
-
+ constructor(text = null, authorId = null, time = null) {
+ /**
+ * The raw text of the user's chat message (before any rendering or processing).
+ *
+ * @type {?string}
+ */
+ this.text = text;
+ /**
+ * The user's author ID.
+ *
+ * @type {?string}
+ */
+ this.authorId = authorId;
+ /**
+ * The message's timestamp, as milliseconds since epoch.
+ *
+ * @type {?number}
+ */
+ this.time = time;
+ /**
+ * The user's display name.
+ *
+ * @type {?string}
+ */
+ this.displayName = null;
+ }
/**
- * The message's timestamp, as milliseconds since epoch.
+ * Alias of `authorId`, for compatibility with old plugins.
*
- * @type {?number}
+ * @deprecated Use `authorId` instead.
+ * @type {string}
*/
- this.time = time;
-
+ get userId() {
+ warnDeprecated('ChatMessage.userId property is deprecated; use .authorId instead');
+ return this.authorId;
+ }
+ set userId(val) {
+ warnDeprecated('ChatMessage.userId property is deprecated; use .authorId instead');
+ this.authorId = val;
+ }
/**
- * The user's display name.
+ * Alias of `displayName`, for compatibility with old plugins.
*
- * @type {?string}
+ * @deprecated Use `displayName` instead.
+ * @type {string}
*/
- this.displayName = null;
- }
-
- /**
- * Alias of `authorId`, for compatibility with old plugins.
- *
- * @deprecated Use `authorId` instead.
- * @type {string}
- */
- get userId() {
- warnDeprecated('ChatMessage.userId property is deprecated; use .authorId instead');
- return this.authorId;
- }
- set userId(val) {
- warnDeprecated('ChatMessage.userId property is deprecated; use .authorId instead');
- this.authorId = val;
- }
-
- /**
- * Alias of `displayName`, for compatibility with old plugins.
- *
- * @deprecated Use `displayName` instead.
- * @type {string}
- */
- get userName() {
- warnDeprecated('ChatMessage.userName property is deprecated; use .displayName instead');
- return this.displayName;
- }
- set userName(val) {
- warnDeprecated('ChatMessage.userName property is deprecated; use .displayName instead');
- this.displayName = val;
- }
-
- // TODO: Delete this method once users are unlikely to roll back to a version of Etherpad that
- // doesn't support authorId and displayName.
- toJSON() {
- const {authorId, displayName, ...obj} = this;
- obj.userId = authorId;
- obj.userName = displayName;
- return obj;
- }
+ get userName() {
+ warnDeprecated('ChatMessage.userName property is deprecated; use .displayName instead');
+ return this.displayName;
+ }
+ set userName(val) {
+ warnDeprecated('ChatMessage.userName property is deprecated; use .displayName instead');
+ this.displayName = val;
+ }
+ // TODO: Delete this method once users are unlikely to roll back to a version of Etherpad that
+ // doesn't support authorId and displayName.
+ toJSON() {
+ const { authorId, displayName, ...obj } = this;
+ obj.userId = authorId;
+ obj.userName = displayName;
+ return obj;
+ }
}
-
-module.exports = ChatMessage;
+export default ChatMessage;
diff --git a/src/static/js/ace2_inner.js b/src/static/js/ace2_inner.js
deleted file mode 100644
index a8b98ac16db..00000000000
--- a/src/static/js/ace2_inner.js
+++ /dev/null
@@ -1,3527 +0,0 @@
-'use strict';
-
-/**
- * Copyright 2009 Google Inc.
- * Copyright 2020 John McLear - The Etherpad Foundation.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS-IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-let documentAttributeManager;
-
-const AttributeMap = require('./AttributeMap');
-const browser = require('./vendors/browser');
-const padutils = require('./pad_utils').padutils;
-const Ace2Common = require('./ace2_common');
-const $ = require('./rjquery').$;
-
-const isNodeText = Ace2Common.isNodeText;
-const getAssoc = Ace2Common.getAssoc;
-const setAssoc = Ace2Common.setAssoc;
-const noop = Ace2Common.noop;
-const hooks = require('./pluginfw/hooks');
-
-function Ace2Inner(editorInfo, cssManagers) {
- const makeChangesetTracker = require('./changesettracker').makeChangesetTracker;
- const colorutils = require('./colorutils').colorutils;
- const makeContentCollector = require('./contentcollector').makeContentCollector;
- const domline = require('./domline').domline;
- const AttribPool = require('./AttributePool');
- const Changeset = require('./Changeset');
- const ChangesetUtils = require('./ChangesetUtils');
- const linestylefilter = require('./linestylefilter').linestylefilter;
- const SkipList = require('./skiplist');
- const undoModule = require('./undomodule').undoModule;
- const AttributeManager = require('./AttributeManager');
- const Scroll = require('./scroll');
- const DEBUG = false;
-
- const THE_TAB = ' '; // 4
- const MAX_LIST_LEVEL = 16;
-
- const FORMATTING_STYLES = ['bold', 'italic', 'underline', 'strikethrough'];
- const SELECT_BUTTON_CLASS = 'selected';
-
- let thisAuthor = '';
-
- let disposed = false;
-
- const focus = () => {
- window.focus();
- };
-
- const outerWin = window.parent;
- const outerDoc = outerWin.document;
- const sideDiv = outerDoc.getElementById('sidediv');
- const lineMetricsDiv = outerDoc.getElementById('linemetricsdiv');
- const sideDivInner = outerDoc.getElementById('sidedivinner');
- const appendNewSideDivLine = () => {
- const lineDiv = outerDoc.createElement('div');
- sideDivInner.appendChild(lineDiv);
- const lineSpan = outerDoc.createElement('span');
- lineSpan.classList.add('line-number');
- lineSpan.appendChild(outerDoc.createTextNode(sideDivInner.children.length));
- lineDiv.appendChild(lineSpan);
- };
- appendNewSideDivLine();
-
- const scroll = Scroll.init(outerWin);
-
- let outsideKeyDown = noop;
- let outsideKeyPress = (e) => true;
- let outsideNotifyDirty = noop;
-
- /**
- * Document representation.
- */
- const rep = {
- /**
- * The contents of the document. Each entry in this skip list is an object representing a
- * line (actually paragraph) of text. The line objects are created by createDomLineEntry().
- */
- lines: new SkipList(),
- /**
- * Start of the selection. Represented as an array of two non-negative numbers that point to the
- * first character of the selection: [zeroBasedLineNumber, zeroBasedColumnNumber]. Notes:
- * - There is an implicit newline character (not actually stored) at the end of every line.
- * Because of this, a selection that starts at the end of a line (column number equals the
- * number of characters in the line, not including the implicit newline) is not equivalent
- * to a selection that starts at the beginning of the next line. The same goes for the
- * selection end.
- * - If there are N lines, [N, 0] is valid for the start of the selection. [N, 0] indicates
- * that the selection starts just after the implicit newline at the end of the document's
- * last line (if the document has any lines). The same goes for the end of the selection.
- * - If a line starts with a line marker, a selection that starts at the beginning of the line
- * may start either immediately before (column = 0) or immediately after (column = 1) the
- * line marker, and the two are considered to be semantically equivalent. For safety, all
- * code should be written to accept either but only produce selections that start after the
- * line marker (the column number should be 1, not 0, when there is a line marker). The same
- * goes for the end of the selection.
- */
- selStart: null,
- /**
- * End of the selection. Represented as an array of two non-negative numbers that point to the
- * character just after the end of the selection: [zeroBasedLineNumber, zeroBasedColumnNumber].
- * See the above notes for selStart.
- */
- selEnd: null,
- /**
- * Whether the selection extends "backwards", so that the focus point (controlled with the arrow
- * keys) is at the beginning. This is not supported in IE, though native IE selections have that
- * behavior (which we try not to interfere with). Must be false if selection is collapsed!
- */
- selFocusAtStart: false,
- alltext: '',
- alines: [],
- apool: new AttribPool(),
- };
-
- // lines, alltext, alines, and DOM are set up in init()
- if (undoModule.enabled) {
- undoModule.apool = rep.apool;
- }
-
- let isEditable = true;
- let doesWrap = true;
- let hasLineNumbers = true;
- let isStyled = true;
-
- let console = (DEBUG && window.console);
-
- if (!window.console) {
- const names = [
- 'log',
- 'debug',
- 'info',
- 'warn',
- 'error',
- 'assert',
- 'dir',
- 'dirxml',
- 'group',
- 'groupEnd',
- 'time',
- 'timeEnd',
- 'count',
- 'trace',
- 'profile',
- 'profileEnd',
- ];
- console = {};
- for (const name of names) console[name] = noop;
- }
-
- const scheduler = parent; // hack for opera required
-
- const performDocumentReplaceRange = (start, end, newText) => {
- if (start === undefined) start = rep.selStart;
- if (end === undefined) end = rep.selEnd;
-
- // start[0]: <--- start[1] --->CCCCCCCCCCC\n
- // CCCCCCCCCCCCCCCCCCCC\n
- // CCCC\n
- // end[0]: -------\n
- const builder = Changeset.builder(rep.lines.totalWidth());
- ChangesetUtils.buildKeepToStartOfRange(rep, builder, start);
- ChangesetUtils.buildRemoveRange(rep, builder, start, end);
- builder.insert(newText, [
- ['author', thisAuthor],
- ], rep.apool);
- const cs = builder.toString();
-
- performDocumentApplyChangeset(cs);
- };
-
- const changesetTracker = makeChangesetTracker(scheduler, rep.apool, {
- withCallbacks: (operationName, f) => {
- inCallStackIfNecessary(operationName, () => {
- fastIncorp(1);
- f(
- {
- setDocumentAttributedText: (atext) => {
- setDocAText(atext);
- },
- applyChangesetToDocument: (changeset, preferInsertionAfterCaret) => {
- const oldEventType = currentCallStack.editEvent.eventType;
- currentCallStack.startNewEvent('nonundoable');
-
- performDocumentApplyChangeset(changeset, preferInsertionAfterCaret);
-
- currentCallStack.startNewEvent(oldEventType);
- },
- });
- });
- },
- });
-
- const authorInfos = {}; // presence of key determines if author is present in doc
- const getAuthorInfos = () => authorInfos;
- editorInfo.ace_getAuthorInfos = getAuthorInfos;
-
- const setAuthorStyle = (author, info) => {
- const authorSelector = getAuthorColorClassSelector(getAuthorClassName(author));
-
- const authorStyleSet = hooks.callAll('aceSetAuthorStyle', {
- dynamicCSS: cssManagers.inner,
- outerDynamicCSS: cssManagers.outer,
- parentDynamicCSS: cssManagers.parent,
- info,
- author,
- authorSelector,
- });
-
- // Prevent default behaviour if any hook says so
- if (authorStyleSet.some((it) => it)) {
- return;
- }
-
- if (!info) {
- cssManagers.inner.removeSelectorStyle(authorSelector);
- cssManagers.parent.removeSelectorStyle(authorSelector);
- } else if (info.bgcolor) {
- let bgcolor = info.bgcolor;
- if ((typeof info.fade) === 'number') {
- bgcolor = fadeColor(bgcolor, info.fade);
- }
- const textColor =
- colorutils.textColorFromBackgroundColor(bgcolor, parent.parent.clientVars.skinName);
- const styles = [
- cssManagers.inner.selectorStyle(authorSelector),
- cssManagers.parent.selectorStyle(authorSelector),
- ];
- for (const style of styles) {
- style.backgroundColor = bgcolor;
- style.color = textColor;
- style['padding-top'] = '3px';
- style['padding-bottom'] = '4px';
- }
- }
- };
-
- const setAuthorInfo = (author, info) => {
- if (!author) return; // author ID not set for some reason
- if ((typeof author) !== 'string') {
- // Potentially caused by: https://github.com/ether/etherpad-lite/issues/2802");
- throw new Error(`setAuthorInfo: author (${author}) is not a string`);
- }
- if (!info) {
- delete authorInfos[author];
- } else {
- authorInfos[author] = info;
- }
- setAuthorStyle(author, info);
- };
-
- const getAuthorClassName = (author) => `author-${author.replace(/[^a-y0-9]/g, (c) => {
- if (c === '.') return '-';
- return `z${c.charCodeAt(0)}z`;
- })}`;
-
- const className2Author = (className) => {
- if (className.substring(0, 7) === 'author-') {
- return className.substring(7).replace(/[a-y0-9]+|-|z.+?z/g, (cc) => {
- if (cc === '-') { return '.'; } else if (cc.charAt(0) === 'z') {
- return String.fromCharCode(Number(cc.slice(1, -1)));
- } else {
- return cc;
- }
- });
- }
- return null;
- };
-
- const getAuthorColorClassSelector = (oneClassName) => `.authorColors .${oneClassName}`;
-
- const fadeColor = (colorCSS, fadeFrac) => {
- let color = colorutils.css2triple(colorCSS);
- color = colorutils.blend(color, [1, 1, 1], fadeFrac);
- return colorutils.triple2css(color);
- };
-
- editorInfo.ace_getRep = () => rep;
-
- editorInfo.ace_getAuthor = () => thisAuthor;
-
- const _nonScrollableEditEvents = {
- applyChangesToBase: 1,
- };
-
- for (const eventType of hooks.callAll('aceRegisterNonScrollableEditEvents')) {
- _nonScrollableEditEvents[eventType] = 1;
- }
-
- const isScrollableEditEvent = (eventType) => !_nonScrollableEditEvents[eventType];
-
- let currentCallStack = null;
-
- const inCallStack = (type, action) => {
- if (disposed) return;
-
- const newEditEvent = (eventType) => ({
- eventType,
- backset: null,
- });
-
- const submitOldEvent = (evt) => {
- if (rep.selStart && rep.selEnd) {
- const selStartChar = rep.lines.offsetOfIndex(rep.selStart[0]) + rep.selStart[1];
- const selEndChar = rep.lines.offsetOfIndex(rep.selEnd[0]) + rep.selEnd[1];
- evt.selStart = selStartChar;
- evt.selEnd = selEndChar;
- evt.selFocusAtStart = rep.selFocusAtStart;
- }
- if (undoModule.enabled) {
- let undoWorked = false;
- try {
- if (isPadLoading(evt.eventType)) {
- undoModule.clearHistory();
- } else if (evt.eventType === 'nonundoable') {
- if (evt.changeset) {
- undoModule.reportExternalChange(evt.changeset);
- }
- } else {
- undoModule.reportEvent(evt);
- }
- undoWorked = true;
- } finally {
- if (!undoWorked) {
- undoModule.enabled = false; // for safety
- }
- }
- }
- };
-
- const startNewEvent = (eventType, dontSubmitOld) => {
- const oldEvent = currentCallStack.editEvent;
- if (!dontSubmitOld) {
- submitOldEvent(oldEvent);
- }
- currentCallStack.editEvent = newEditEvent(eventType);
- return oldEvent;
- };
-
- currentCallStack = {
- type,
- docTextChanged: false,
- selectionAffected: false,
- userChangedSelection: false,
- domClean: false,
- isUserChange: false,
- // is this a "user change" type of call-stack
- repChanged: false,
- editEvent: newEditEvent(type),
- startNewEvent,
- };
- let cleanExit = false;
- let result;
- try {
- result = action();
-
- hooks.callAll('aceEditEvent', {
- callstack: currentCallStack,
- editorInfo,
- rep,
- documentAttributeManager,
- });
-
- cleanExit = true;
- } finally {
- const cs = currentCallStack;
- if (cleanExit) {
- submitOldEvent(cs.editEvent);
- if (cs.domClean && cs.type !== 'setup') {
- if (cs.selectionAffected) {
- updateBrowserSelectionFromRep();
- }
- if ((cs.docTextChanged || cs.userChangedSelection) && isScrollableEditEvent(cs.type)) {
- scrollSelectionIntoView();
- }
- if (cs.docTextChanged && cs.type.indexOf('importText') < 0) {
- outsideNotifyDirty();
- }
- }
- } else if (currentCallStack.type === 'idleWorkTimer') {
- idleWorkTimer.atLeast(1000);
- }
- currentCallStack = null;
- }
- return result;
- };
- editorInfo.ace_inCallStack = inCallStack;
-
- const inCallStackIfNecessary = (type, action) => {
- if (!currentCallStack) {
- inCallStack(type, action);
- } else {
- action();
- }
- };
- editorInfo.ace_inCallStackIfNecessary = inCallStackIfNecessary;
-
- const dispose = () => {
- disposed = true;
- if (idleWorkTimer) idleWorkTimer.never();
- teardown();
- };
-
- const setWraps = (newVal) => {
- doesWrap = newVal;
- document.body.classList.toggle('doesWrap', doesWrap);
- scheduler.setTimeout(() => {
- inCallStackIfNecessary('setWraps', () => {
- fastIncorp(7);
- recreateDOM();
- fixView();
- });
- }, 0);
- };
-
- const setStyled = (newVal) => {
- const oldVal = isStyled;
- isStyled = !!newVal;
-
- if (newVal !== oldVal) {
- if (!newVal) {
- // clear styles
- inCallStackIfNecessary('setStyled', () => {
- fastIncorp(12);
- const clearStyles = [];
- for (const k of Object.keys(STYLE_ATTRIBS)) {
- clearStyles.push([k, '']);
- }
- performDocumentApplyAttributesToCharRange(0, rep.alltext.length, clearStyles);
- });
- }
- }
- };
-
- const setTextFace = (face) => {
- document.body.style.fontFamily = face;
- lineMetricsDiv.style.fontFamily = face;
- };
-
- const recreateDOM = () => {
- // precond: normalized
- recolorLinesInRange(0, rep.alltext.length);
- };
-
- const setEditable = (newVal) => {
- isEditable = newVal;
- document.body.contentEditable = isEditable ? 'true' : 'false';
- document.body.classList.toggle('static', !isEditable);
- };
-
- const enforceEditability = () => setEditable(isEditable);
-
- const importText = (text, undoable, dontProcess) => {
- let lines;
- if (dontProcess) {
- if (text.charAt(text.length - 1) !== '\n') {
- throw new Error('new raw text must end with newline');
- }
- if (/[\r\t\xa0]/.exec(text)) {
- throw new Error('new raw text must not contain CR, tab, or nbsp');
- }
- lines = text.substring(0, text.length - 1).split('\n');
- } else {
- lines = text.split('\n').map(textify);
- }
- let newText = '\n';
- if (lines.length > 0) {
- newText = `${lines.join('\n')}\n`;
- }
-
- inCallStackIfNecessary(`importText${undoable ? 'Undoable' : ''}`, () => {
- setDocText(newText);
- });
-
- if (dontProcess && rep.alltext !== text) {
- throw new Error('mismatch error setting raw text in importText');
- }
- };
-
- const importAText = (atext, apoolJsonObj, undoable) => {
- atext = Changeset.cloneAText(atext);
- if (apoolJsonObj) {
- const wireApool = (new AttribPool()).fromJsonable(apoolJsonObj);
- atext.attribs = Changeset.moveOpsToNewPool(atext.attribs, wireApool, rep.apool);
- }
- inCallStackIfNecessary(`importText${undoable ? 'Undoable' : ''}`, () => {
- setDocAText(atext);
- });
- };
-
- const setDocAText = (atext) => {
- if (atext.text === '') {
- /*
- * The server is fine with atext.text being an empty string, but the front
- * end is not, and crashes.
- *
- * It is not clear if this is a problem in the server or in the client
- * code, and this is a client-side hack fix. The underlying problem needs
- * to be investigated.
- *
- * See for reference:
- * - https://github.com/ether/etherpad-lite/issues/3861
- */
- atext.text = '\n';
- }
-
- fastIncorp(8);
-
- const oldLen = rep.lines.totalWidth();
- const numLines = rep.lines.length();
- const upToLastLine = rep.lines.offsetOfIndex(numLines - 1);
- const lastLineLength = rep.lines.atIndex(numLines - 1).text.length;
- const assem = Changeset.smartOpAssembler();
- const o = new Changeset.Op('-');
- o.chars = upToLastLine;
- o.lines = numLines - 1;
- assem.append(o);
- o.chars = lastLineLength;
- o.lines = 0;
- assem.append(o);
- for (const op of Changeset.opsFromAText(atext)) assem.append(op);
- const newLen = oldLen + assem.getLengthChange();
- const changeset = Changeset.checkRep(
- Changeset.pack(oldLen, newLen, assem.toString(), atext.text.slice(0, -1)));
- performDocumentApplyChangeset(changeset);
-
- performSelectionChange(
- [0, rep.lines.atIndex(0).lineMarker], [0, rep.lines.atIndex(0).lineMarker]);
-
- idleWorkTimer.atMost(100);
-
- if (rep.alltext !== atext.text) {
- throw new Error('mismatch error setting raw text in setDocAText');
- }
- };
-
- const setDocText = (text) => {
- setDocAText(Changeset.makeAText(text));
- };
-
- const getDocText = () => {
- const alltext = rep.alltext;
- let len = alltext.length;
- if (len > 0) len--; // final extra newline
- return alltext.substring(0, len);
- };
-
- const exportText = () => {
- if (currentCallStack && !currentCallStack.domClean) {
- inCallStackIfNecessary('exportText', () => {
- fastIncorp(2);
- });
- }
- return getDocText();
- };
-
- const editorChangedSize = () => fixView();
-
- const setOnKeyPress = (handler) => {
- outsideKeyPress = handler;
- };
-
- const setOnKeyDown = (handler) => {
- outsideKeyDown = handler;
- };
-
- const setNotifyDirty = (handler) => {
- outsideNotifyDirty = handler;
- };
-
- const CMDS = {
- clearauthorship: (prompt) => {
- if ((!(rep.selStart && rep.selEnd)) || isCaret()) {
- if (prompt) {
- prompt();
- } else {
- performDocumentApplyAttributesToCharRange(0, rep.alltext.length, [
- ['author', ''],
- ]);
- }
- } else {
- setAttributeOnSelection('author', '');
- }
- },
- };
-
- const execCommand = (cmd, ...args) => {
- cmd = cmd.toLowerCase();
- if (CMDS[cmd]) {
- inCallStackIfNecessary(cmd, () => {
- fastIncorp(9);
- CMDS[cmd](...args);
- });
- }
- };
-
- const replaceRange = (start, end, text) => {
- inCallStackIfNecessary('replaceRange', () => {
- fastIncorp(9);
- performDocumentReplaceRange(start, end, text);
- });
- };
-
- editorInfo.ace_callWithAce = (fn, callStack, normalize) => {
- let wrapper = () => fn(editorInfo);
-
- if (normalize !== undefined) {
- const wrapper1 = wrapper;
- wrapper = () => {
- editorInfo.ace_fastIncorp(9);
- wrapper1();
- };
- }
-
- if (callStack !== undefined) {
- return editorInfo.ace_inCallStack(callStack, wrapper);
- } else {
- return wrapper();
- }
- };
-
- /**
- * This methed exposes a setter for some ace properties
- * @param key the name of the parameter
- * @param value the value to set to
- */
- editorInfo.ace_setProperty = (key, value) => {
- // These properties are exposed
- const setters = {
- wraps: setWraps,
- showsauthorcolors: (val) => document.body.classList.toggle('authorColors', !!val),
- showsuserselections: (val) => document.body.classList.toggle('userSelections', !!val),
- showslinenumbers: (value) => {
- hasLineNumbers = !!value;
- sideDiv.parentNode.classList.toggle('line-numbers-hidden', !hasLineNumbers);
- fixView();
- },
- userauthor: (value) => {
- thisAuthor = String(value);
- documentAttributeManager.author = thisAuthor;
- },
- styled: setStyled,
- textface: setTextFace,
- rtlistrue: (value) => {
- document.body.classList.toggle('rtl', value);
- document.body.classList.toggle('ltr', !value);
- document.documentElement.dir = value ? 'rtl' : 'ltr';
- },
- };
-
- const setter = setters[key.toLowerCase()];
-
- // check if setter is present
- if (setter !== undefined) {
- setter(value);
- }
- };
-
- editorInfo.ace_setBaseText = (txt) => {
- changesetTracker.setBaseText(txt);
- };
- editorInfo.ace_setBaseAttributedText = (atxt, apoolJsonObj) => {
- changesetTracker.setBaseAttributedText(atxt, apoolJsonObj);
- };
- editorInfo.ace_applyChangesToBase = (c, optAuthor, apoolJsonObj) => {
- changesetTracker.applyChangesToBase(c, optAuthor, apoolJsonObj);
- };
- editorInfo.ace_prepareUserChangeset = () => changesetTracker.prepareUserChangeset();
- editorInfo.ace_applyPreparedChangesetToBase = () => {
- changesetTracker.applyPreparedChangesetToBase();
- };
- editorInfo.ace_setUserChangeNotificationCallback = (f) => {
- changesetTracker.setUserChangeNotificationCallback(f);
- };
- editorInfo.ace_setAuthorInfo = (author, info) => {
- setAuthorInfo(author, info);
- };
-
- editorInfo.ace_getDocument = () => document;
-
- const now = () => Date.now();
-
- const newTimeLimit = (ms) => {
- const startTime = now();
- let exceededAlready = false;
- let printedTrace = false;
- const isTimeUp = () => {
- if (exceededAlready) {
- if ((!printedTrace)) {
- printedTrace = true;
- }
- return true;
- }
- const elapsed = now() - startTime;
- if (elapsed > ms) {
- exceededAlready = true;
- return true;
- } else {
- return false;
- }
- };
-
- isTimeUp.elapsed = () => now() - startTime;
- return isTimeUp;
- };
-
-
- const makeIdleAction = (func) => {
- let scheduledTimeout = null;
- let scheduledTime = 0;
-
- const unschedule = () => {
- if (scheduledTimeout) {
- scheduler.clearTimeout(scheduledTimeout);
- scheduledTimeout = null;
- }
- };
-
- const reschedule = (time) => {
- unschedule();
- scheduledTime = time;
- let delay = time - now();
- if (delay < 0) delay = 0;
- scheduledTimeout = scheduler.setTimeout(callback, delay);
- };
-
- const callback = () => {
- scheduledTimeout = null;
- // func may reschedule the action
- func();
- };
-
- return {
- atMost: (ms) => {
- const latestTime = now() + ms;
- if ((!scheduledTimeout) || scheduledTime > latestTime) {
- reschedule(latestTime);
- }
- },
- // atLeast(ms) will schedule the action if not scheduled yet.
- // In other words, "infinity" is replaced by ms, even though
- // it is technically larger.
- atLeast: (ms) => {
- const earliestTime = now() + ms;
- if ((!scheduledTimeout) || scheduledTime < earliestTime) {
- reschedule(earliestTime);
- }
- },
- never: () => {
- unschedule();
- },
- };
- };
-
- const fastIncorp = (n) => {
- // normalize but don't do any lexing or anything
- incorporateUserChanges();
- };
- editorInfo.ace_fastIncorp = fastIncorp;
-
- const idleWorkTimer = makeIdleAction(() => {
- if (inInternationalComposition) {
- // don't do idle input incorporation during international input composition
- idleWorkTimer.atLeast(500);
- return;
- }
-
- inCallStackIfNecessary('idleWorkTimer', () => {
- const isTimeUp = newTimeLimit(250);
-
- let finishedImportantWork = false;
- let finishedWork = false;
-
- try {
- incorporateUserChanges();
-
- if (isTimeUp()) return;
-
- updateLineNumbers(); // update line numbers if any time left
- if (isTimeUp()) return;
- finishedImportantWork = true;
- finishedWork = true;
- } finally {
- if (finishedWork) {
- idleWorkTimer.atMost(1000);
- } else if (finishedImportantWork) {
- // if we've finished highlighting the view area,
- // more highlighting could be counter-productive,
- // e.g. if the user just opened a triple-quote and will soon close it.
- idleWorkTimer.atMost(500);
- } else {
- let timeToWait = Math.round(isTimeUp.elapsed() / 2);
- if (timeToWait < 100) timeToWait = 100;
- idleWorkTimer.atMost(timeToWait);
- }
- }
- });
- });
-
- let _nextId = 1;
-
- const uniqueId = (n) => {
- // not actually guaranteed to be unique, e.g. if user copy-pastes
- // nodes with ids
- const nid = n.id;
- if (nid) return nid;
- return (n.id = `magicdomid${_nextId++}`);
- };
-
-
- const recolorLinesInRange = (startChar, endChar) => {
- if (endChar <= startChar) return;
- if (startChar < 0 || startChar >= rep.lines.totalWidth()) return;
- let lineEntry = rep.lines.atOffset(startChar); // rounds down to line boundary
- let lineStart = rep.lines.offsetOfEntry(lineEntry);
- let lineIndex = rep.lines.indexOfEntry(lineEntry);
- let selectionNeedsResetting = false;
- let firstLine = null;
-
- // tokenFunc function; accesses current value of lineEntry and curDocChar,
- // also mutates curDocChar
- const tokenFunc = (tokenText, tokenClass) => {
- lineEntry.domInfo.appendSpan(tokenText, tokenClass);
- };
-
- while (lineEntry && lineStart < endChar) {
- const lineEnd = lineStart + lineEntry.width;
- lineEntry.domInfo.clearSpans();
- getSpansForLine(lineEntry, tokenFunc, lineStart);
- lineEntry.domInfo.finishUpdate();
-
- markNodeClean(lineEntry.lineNode);
-
- if (rep.selStart && rep.selStart[0] === lineIndex ||
- rep.selEnd && rep.selEnd[0] === lineIndex) {
- selectionNeedsResetting = true;
- }
-
- if (firstLine == null) firstLine = lineIndex;
- lineStart = lineEnd;
- lineEntry = rep.lines.next(lineEntry);
- lineIndex++;
- }
- if (selectionNeedsResetting) {
- currentCallStack.selectionAffected = true;
- }
- };
-
- // like getSpansForRange, but for a line, and the func takes (text,class)
- // instead of (width,class); excludes the trailing '\n' from
- // consideration by func
-
-
- const getSpansForLine = (lineEntry, textAndClassFunc, lineEntryOffsetHint) => {
- let lineEntryOffset = lineEntryOffsetHint;
- if ((typeof lineEntryOffset) !== 'number') {
- lineEntryOffset = rep.lines.offsetOfEntry(lineEntry);
- }
- const text = lineEntry.text;
- if (text.length === 0) {
- // allow getLineStyleFilter to set line-div styles
- const func = linestylefilter.getLineStyleFilter(
- 0, '', textAndClassFunc, rep.apool);
- func('', '');
- } else {
- let filteredFunc = linestylefilter.getFilterStack(text, textAndClassFunc, browser);
- const lineNum = rep.lines.indexOfEntry(lineEntry);
- const aline = rep.alines[lineNum];
- filteredFunc = linestylefilter.getLineStyleFilter(
- text.length, aline, filteredFunc, rep.apool);
- filteredFunc(text, '');
- }
- };
-
- let observedChanges;
-
- const clearObservedChanges = () => {
- observedChanges = {
- cleanNodesNearChanges: {},
- };
- };
- clearObservedChanges();
-
- const getCleanNodeByKey = (key) => {
- let n = document.getElementById(key);
- // copying and pasting can lead to duplicate ids
- while (n && isNodeDirty(n)) {
- n.id = '';
- n = document.getElementById(key);
- }
- return n;
- };
-
- const observeChangesAroundNode = (node) => {
- // Around this top-level DOM node, look for changes to the document
- // (from how it looks in our representation) and record them in a way
- // that can be used to "normalize" the document (apply the changes to our
- // representation, and put the DOM in a canonical form).
- let cleanNode;
- let hasAdjacentDirtyness;
- if (!isNodeDirty(node)) {
- cleanNode = node;
- const prevSib = cleanNode.previousSibling;
- const nextSib = cleanNode.nextSibling;
- hasAdjacentDirtyness = ((prevSib && isNodeDirty(prevSib)) ||
- (nextSib && isNodeDirty(nextSib)));
- } else {
- // node is dirty, look for clean node above
- let upNode = node.previousSibling;
- while (upNode && isNodeDirty(upNode)) {
- upNode = upNode.previousSibling;
- }
- if (upNode) {
- cleanNode = upNode;
- } else {
- let downNode = node.nextSibling;
- while (downNode && isNodeDirty(downNode)) {
- downNode = downNode.nextSibling;
- }
- if (downNode) {
- cleanNode = downNode;
- }
- }
- if (!cleanNode) {
- // Couldn't find any adjacent clean nodes!
- // Since top and bottom of doc is dirty, the dirty area will be detected.
- return;
- }
- hasAdjacentDirtyness = true;
- }
-
- if (hasAdjacentDirtyness) {
- // previous or next line is dirty
- observedChanges.cleanNodesNearChanges[`$${uniqueId(cleanNode)}`] = true;
- } else {
- // next and prev lines are clean (if they exist)
- const lineKey = uniqueId(cleanNode);
- const prevSib = cleanNode.previousSibling;
- const nextSib = cleanNode.nextSibling;
- const actualPrevKey = ((prevSib && uniqueId(prevSib)) || null);
- const actualNextKey = ((nextSib && uniqueId(nextSib)) || null);
- const repPrevEntry = rep.lines.prev(rep.lines.atKey(lineKey));
- const repNextEntry = rep.lines.next(rep.lines.atKey(lineKey));
- const repPrevKey = ((repPrevEntry && repPrevEntry.key) || null);
- const repNextKey = ((repNextEntry && repNextEntry.key) || null);
- if (actualPrevKey !== repPrevKey || actualNextKey !== repNextKey) {
- observedChanges.cleanNodesNearChanges[`$${uniqueId(cleanNode)}`] = true;
- }
- }
- };
-
- const observeChangesAroundSelection = () => {
- if (currentCallStack.observedSelection) return;
- currentCallStack.observedSelection = true;
-
- const selection = getSelection();
-
- if (selection) {
- const node1 = topLevel(selection.startPoint.node);
- const node2 = topLevel(selection.endPoint.node);
- if (node1) observeChangesAroundNode(node1);
- if (node2 && node1 !== node2) {
- observeChangesAroundNode(node2);
- }
- }
- };
-
- const observeSuspiciousNodes = () => {
- // inspired by Firefox bug #473255, where pasting formatted text
- // causes the cursor to jump away, making the new HTML never found.
- if (document.body.getElementsByTagName) {
- const elts = document.body.getElementsByTagName('style');
- for (const elt of elts) {
- const n = topLevel(elt);
- if (n && n.parentNode === document.body) {
- observeChangesAroundNode(n);
- }
- }
- }
- };
-
- const incorporateUserChanges = () => {
- if (currentCallStack.domClean) return false;
-
- currentCallStack.isUserChange = true;
-
- if (DEBUG && window.DONT_INCORP || window.DEBUG_DONT_INCORP) return false;
-
- // returns true if dom changes were made
- if (!document.body.firstChild) {
- document.body.innerHTML = '';
- }
-
- observeChangesAroundSelection();
- observeSuspiciousNodes();
- let dirtyRanges = getDirtyRanges();
- let dirtyRangesCheckOut = true;
- let j = 0;
- let a, b;
- let scrollToTheLeftNeeded = false;
-
- while (j < dirtyRanges.length) {
- a = dirtyRanges[j][0];
- b = dirtyRanges[j][1];
- if (!((a === 0 || getCleanNodeByKey(rep.lines.atIndex(a - 1).key)) &&
- (b === rep.lines.length() || getCleanNodeByKey(rep.lines.atIndex(b).key)))) {
- dirtyRangesCheckOut = false;
- break;
- }
- j++;
- }
- if (!dirtyRangesCheckOut) {
- for (const bodyNode of document.body.childNodes) {
- if ((bodyNode.tagName) && ((!bodyNode.id) || (!rep.lines.containsKey(bodyNode.id)))) {
- observeChangesAroundNode(bodyNode);
- }
- }
- dirtyRanges = getDirtyRanges();
- }
-
- clearObservedChanges();
-
- const selection = getSelection();
-
- let selStart, selEnd; // each one, if truthy, has [line,char] needed to set selection
- let i = 0;
- const splicesToDo = [];
- let netNumLinesChangeSoFar = 0;
- const toDeleteAtEnd = [];
- const domInsertsNeeded = []; // each entry is [nodeToInsertAfter, [info1, info2, ...]]
- while (i < dirtyRanges.length) {
- const range = dirtyRanges[i];
- a = range[0];
- b = range[1];
- let firstDirtyNode = (((a === 0) && document.body.firstChild) ||
- getCleanNodeByKey(rep.lines.atIndex(a - 1).key).nextSibling);
- firstDirtyNode = (firstDirtyNode && isNodeDirty(firstDirtyNode) && firstDirtyNode);
-
- let lastDirtyNode = (((b === rep.lines.length()) && document.body.lastChild) ||
- getCleanNodeByKey(rep.lines.atIndex(b).key).previousSibling);
-
- lastDirtyNode = (lastDirtyNode && isNodeDirty(lastDirtyNode) && lastDirtyNode);
- if (firstDirtyNode && lastDirtyNode) {
- const cc = makeContentCollector(isStyled, browser, rep.apool, className2Author);
- cc.notifySelection(selection);
- const dirtyNodes = [];
- for (let n = firstDirtyNode; n &&
- !(n.previousSibling && n.previousSibling === lastDirtyNode);
- n = n.nextSibling) {
- cc.collectContent(n);
- dirtyNodes.push(n);
- }
- cc.notifyNextNode(lastDirtyNode.nextSibling);
- let lines = cc.getLines();
- if ((lines.length <= 1 || lines[lines.length - 1] !== '') && lastDirtyNode.nextSibling) {
- // dirty region doesn't currently end a line, even taking the following node
- // (or lack of node) into account, so include the following clean node.
- // It could be SPAN or a DIV; basically this is any case where the contentCollector
- // decides it isn't done.
- // Note that this clean node might need to be there for the next dirty range.
- b++;
- const cleanLine = lastDirtyNode.nextSibling;
- cc.collectContent(cleanLine);
- toDeleteAtEnd.push(cleanLine);
- cc.notifyNextNode(cleanLine.nextSibling);
- }
-
- const ccData = cc.finish();
- const ss = ccData.selStart;
- const se = ccData.selEnd;
- lines = ccData.lines;
- const lineAttribs = ccData.lineAttribs;
- const linesWrapped = ccData.linesWrapped;
-
- if (linesWrapped > 0) {
- // Chrome decides in its infinite wisdom that it's okay to put the browser's visisble
- // window in the middle of the span. An outcome of this is that the first chars of the
- // string are no longer visible to the user.. Yay chrome.. Move the browser's visible area
- // to the left hand side of the span. Firefox isn't quite so bad, but it's still pretty
- // quirky.
- scrollToTheLeftNeeded = true;
- }
-
- if (ss[0] >= 0) selStart = [ss[0] + a + netNumLinesChangeSoFar, ss[1]];
- if (se[0] >= 0) selEnd = [se[0] + a + netNumLinesChangeSoFar, se[1]];
-
- const entries = [];
- const nodeToAddAfter = lastDirtyNode;
- const lineNodeInfos = [];
- for (const lineString of lines) {
- const newEntry = createDomLineEntry(lineString);
- entries.push(newEntry);
- lineNodeInfos.push(newEntry.domInfo);
- }
- domInsertsNeeded.push([nodeToAddAfter, lineNodeInfos]);
- for (const n of dirtyNodes) toDeleteAtEnd.push(n);
- const spliceHints = {};
- if (selStart) spliceHints.selStart = selStart;
- if (selEnd) spliceHints.selEnd = selEnd;
- splicesToDo.push([a + netNumLinesChangeSoFar, b - a, entries, lineAttribs, spliceHints]);
- netNumLinesChangeSoFar += (lines.length - (b - a));
- } else if (b > a) {
- splicesToDo.push([a + netNumLinesChangeSoFar, b - a, [], []]);
- }
- i++;
- }
-
- const domChanges = (splicesToDo.length > 0);
-
- for (const splice of splicesToDo) doIncorpLineSplice(...splice);
- for (const ins of domInsertsNeeded) insertDomLines(...ins);
- for (const n of toDeleteAtEnd) n.remove();
-
- // needed to stop chrome from breaking the ui when long strings without spaces are pasted
- if (scrollToTheLeftNeeded) {
- $('#innerdocbody').scrollLeft(0);
- }
-
- // if the nodes that define the selection weren't encountered during
- // content collection, figure out where those nodes are now.
- if (selection && !selStart) {
- const selStartFromHook = hooks.callAll('aceStartLineAndCharForPoint', {
- callstack: currentCallStack,
- editorInfo,
- rep,
- root: document.body,
- point: selection.startPoint,
- documentAttributeManager,
- });
- selStart = (selStartFromHook == null || selStartFromHook.length === 0)
- ? getLineAndCharForPoint(selection.startPoint) : selStartFromHook;
- }
- if (selection && !selEnd) {
- const selEndFromHook = hooks.callAll('aceEndLineAndCharForPoint', {
- callstack: currentCallStack,
- editorInfo,
- rep,
- root: document.body,
- point: selection.endPoint,
- documentAttributeManager,
- });
- selEnd = (selEndFromHook == null ||
- selEndFromHook.length === 0)
- ? getLineAndCharForPoint(selection.endPoint) : selEndFromHook;
- }
-
- // selection from content collection can, in various ways, extend past final
- // BR in firefox DOM, so cap the line
- const numLines = rep.lines.length();
- if (selStart && selStart[0] >= numLines) {
- selStart[0] = numLines - 1;
- selStart[1] = rep.lines.atIndex(selStart[0]).text.length;
- }
- if (selEnd && selEnd[0] >= numLines) {
- selEnd[0] = numLines - 1;
- selEnd[1] = rep.lines.atIndex(selEnd[0]).text.length;
- }
-
- // update rep if we have a new selection
- // NOTE: IE loses the selection when you click stuff in e.g. the
- // editbar, so removing the selection when it's lost is not a good
- // idea.
- if (selection) repSelectionChange(selStart, selEnd, selection && selection.focusAtStart);
- // update browser selection
- if (selection && (domChanges || isCaret())) {
- // if no DOM changes (not this case), want to treat range selection delicately,
- // e.g. in IE not lose which end of the selection is the focus/anchor;
- // on the other hand, we may have just noticed a press of PageUp/PageDown
- currentCallStack.selectionAffected = true;
- }
-
- currentCallStack.domClean = true;
-
- fixView();
-
- return domChanges;
- };
-
- const STYLE_ATTRIBS = {
- bold: true,
- italic: true,
- underline: true,
- strikethrough: true,
- list: true,
- };
-
- const isStyleAttribute = (aname) => !!STYLE_ATTRIBS[aname];
-
- const isDefaultLineAttribute =
- (aname) => AttributeManager.DEFAULT_LINE_ATTRIBUTES.indexOf(aname) !== -1;
-
- const insertDomLines = (nodeToAddAfter, infoStructs) => {
- let lastEntry;
- let lineStartOffset;
- for (const info of infoStructs) {
- const node = info.node;
- const key = uniqueId(node);
- let entry;
- if (lastEntry) {
- // optimization to avoid recalculation
- const next = rep.lines.next(lastEntry);
- if (next && next.key === key) {
- entry = next;
- lineStartOffset += lastEntry.width;
- }
- }
- if (!entry) {
- entry = rep.lines.atKey(key);
- lineStartOffset = rep.lines.offsetOfKey(key);
- }
- lastEntry = entry;
- getSpansForLine(entry, (tokenText, tokenClass) => {
- info.appendSpan(tokenText, tokenClass);
- }, lineStartOffset);
- info.prepareForAdd();
- entry.lineMarker = info.lineMarker;
- if (!nodeToAddAfter) {
- document.body.insertBefore(node, document.body.firstChild);
- } else {
- document.body.insertBefore(node, nodeToAddAfter.nextSibling);
- }
- nodeToAddAfter = node;
- info.notifyAdded();
- markNodeClean(node);
- }
- };
-
- const isCaret = () => (rep.selStart && rep.selEnd &&
- rep.selStart[0] === rep.selEnd[0] && rep.selStart[1] === rep.selEnd[1]);
- editorInfo.ace_isCaret = isCaret;
-
- // prereq: isCaret()
- const caretLine = () => rep.selStart[0];
-
- editorInfo.ace_caretLine = caretLine;
-
- const caretColumn = () => rep.selStart[1];
-
- editorInfo.ace_caretColumn = caretColumn;
-
- const caretDocChar = () => rep.lines.offsetOfIndex(caretLine()) + caretColumn();
-
- editorInfo.ace_caretDocChar = caretDocChar;
-
- const handleReturnIndentation = () => {
- // on return, indent to level of previous line
- if (isCaret() && caretColumn() === 0 && caretLine() > 0) {
- const lineNum = caretLine();
- const thisLine = rep.lines.atIndex(lineNum);
- const prevLine = rep.lines.prev(thisLine);
- const prevLineText = prevLine.text;
- let theIndent = /^ *(?:)/.exec(prevLineText)[0];
- const shouldIndent = parent.parent.clientVars.indentationOnNewLine;
- if (shouldIndent && /[[(:{]\s*$/.exec(prevLineText)) {
- theIndent += THE_TAB;
- }
- const cs = Changeset.builder(rep.lines.totalWidth()).keep(
- rep.lines.offsetOfIndex(lineNum), lineNum).insert(
- theIndent, [
- ['author', thisAuthor],
- ], rep.apool).toString();
- performDocumentApplyChangeset(cs);
- performSelectionChange([lineNum, theIndent.length], [lineNum, theIndent.length]);
- }
- };
-
- const getPointForLineAndChar = (lineAndChar) => {
- const line = lineAndChar[0];
- let charsLeft = lineAndChar[1];
- const lineEntry = rep.lines.atIndex(line);
- charsLeft -= lineEntry.lineMarker;
- if (charsLeft < 0) {
- charsLeft = 0;
- }
- const lineNode = lineEntry.lineNode;
- let n = lineNode;
- let after = false;
- if (charsLeft === 0) {
- return {
- node: lineNode,
- index: 0,
- maxIndex: 1,
- };
- }
- while (!(n === lineNode && after)) {
- if (after) {
- if (n.nextSibling) {
- n = n.nextSibling;
- after = false;
- } else { n = n.parentNode; }
- } else if (isNodeText(n)) {
- const len = n.nodeValue.length;
- if (charsLeft <= len) {
- return {
- node: n,
- index: charsLeft,
- maxIndex: len,
- };
- }
- charsLeft -= len;
- after = true;
- } else if (n.firstChild) { n = n.firstChild; } else { after = true; }
- }
- return {
- node: lineNode,
- index: 1,
- maxIndex: 1,
- };
- };
-
- const nodeText = (n) => n.textContent || n.nodeValue || '';
-
- const getLineAndCharForPoint = (point) => {
- // Turn DOM node selection into [line,char] selection.
- // This method has to work when the DOM is not pristine,
- // assuming the point is not in a dirty node.
- if (point.node === document.body) {
- if (point.index === 0) {
- return [0, 0];
- } else {
- const N = rep.lines.length();
- const ln = rep.lines.atIndex(N - 1);
- return [N - 1, ln.text.length];
- }
- } else {
- let n = point.node;
- let col = 0;
- // if this part fails, it probably means the selection node
- // was dirty, and we didn't see it when collecting dirty nodes.
- if (isNodeText(n)) {
- col = point.index;
- } else if (point.index > 0) {
- col = nodeText(n).length;
- }
- let parNode, prevSib;
- while ((parNode = n.parentNode) !== document.body) {
- if ((prevSib = n.previousSibling)) {
- n = prevSib;
- col += nodeText(n).length;
- } else {
- n = parNode;
- }
- }
- if (n.firstChild && isBlockElement(n.firstChild)) {
- col += 1; // lineMarker
- }
- const lineEntry = rep.lines.atKey(n.id);
- const lineNum = rep.lines.indexOfEntry(lineEntry);
- return [lineNum, col];
- }
- };
- editorInfo.ace_getLineAndCharForPoint = getLineAndCharForPoint;
-
- const createDomLineEntry = (lineString) => {
- const info = doCreateDomLine(lineString.length > 0);
- const newNode = info.node;
- return {
- key: uniqueId(newNode),
- text: lineString,
- lineNode: newNode,
- domInfo: info,
- lineMarker: 0,
- };
- };
-
- const performDocumentApplyChangeset = (changes, insertsAfterSelection) => {
- const domAndRepSplice = (startLine, deleteCount, newLineStrings) => {
- const keysToDelete = [];
- if (deleteCount > 0) {
- let entryToDelete = rep.lines.atIndex(startLine);
- for (let i = 0; i < deleteCount; i++) {
- keysToDelete.push(entryToDelete.key);
- entryToDelete = rep.lines.next(entryToDelete);
- }
- }
-
- const lineEntries = newLineStrings.map(createDomLineEntry);
-
- doRepLineSplice(startLine, deleteCount, lineEntries);
-
- let nodeToAddAfter;
- if (startLine > 0) {
- nodeToAddAfter = getCleanNodeByKey(rep.lines.atIndex(startLine - 1).key);
- } else { nodeToAddAfter = null; }
-
- insertDomLines(nodeToAddAfter, lineEntries.map((entry) => entry.domInfo));
-
- for (const k of keysToDelete) {
- const n = document.getElementById(k);
- n.parentNode.removeChild(n);
- }
-
- if (
- (rep.selStart &&
- rep.selStart[0] >= startLine &&
- rep.selStart[0] <= startLine + deleteCount) ||
- (rep.selEnd && rep.selEnd[0] >= startLine && rep.selEnd[0] <= startLine + deleteCount)) {
- currentCallStack.selectionAffected = true;
- }
- };
-
- doRepApplyChangeset(changes, insertsAfterSelection);
-
- let requiredSelectionSetting = null;
- if (rep.selStart && rep.selEnd) {
- const selStartChar = rep.lines.offsetOfIndex(rep.selStart[0]) + rep.selStart[1];
- const selEndChar = rep.lines.offsetOfIndex(rep.selEnd[0]) + rep.selEnd[1];
- const result =
- Changeset.characterRangeFollow(changes, selStartChar, selEndChar, insertsAfterSelection);
- requiredSelectionSetting = [result[0], result[1], rep.selFocusAtStart];
- }
-
- const linesMutatee = {
- splice: (start, numRemoved, ...args) => {
- domAndRepSplice(start, numRemoved, args.map((s) => s.slice(0, -1)));
- },
- get: (i) => `${rep.lines.atIndex(i).text}\n`,
- length: () => rep.lines.length(),
- };
-
- Changeset.mutateTextLines(changes, linesMutatee);
-
- if (requiredSelectionSetting) {
- performSelectionChange(
- lineAndColumnFromChar(requiredSelectionSetting[0]),
- lineAndColumnFromChar(requiredSelectionSetting[1]),
- requiredSelectionSetting[2]);
- }
- };
-
- const doRepApplyChangeset = (changes, insertsAfterSelection) => {
- Changeset.checkRep(changes);
-
- if (Changeset.oldLen(changes) !== rep.alltext.length) {
- const errMsg = `${Changeset.oldLen(changes)}/${rep.alltext.length}`;
- throw new Error(`doRepApplyChangeset length mismatch: ${errMsg}`);
- }
-
- const editEvent = currentCallStack.editEvent;
- if (editEvent.eventType === 'nonundoable') {
- if (!editEvent.changeset) {
- editEvent.changeset = changes;
- } else {
- editEvent.changeset = Changeset.compose(editEvent.changeset, changes, rep.apool);
- }
- } else {
- const inverseChangeset = Changeset.inverse(changes, {
- get: (i) => `${rep.lines.atIndex(i).text}\n`,
- length: () => rep.lines.length(),
- }, rep.alines, rep.apool);
-
- if (!editEvent.backset) {
- editEvent.backset = inverseChangeset;
- } else {
- editEvent.backset = Changeset.compose(inverseChangeset, editEvent.backset, rep.apool);
- }
- }
-
- Changeset.mutateAttributionLines(changes, rep.alines, rep.apool);
-
- if (changesetTracker.isTracking()) {
- changesetTracker.composeUserChangeset(changes);
- }
- };
-
- /**
- * Converts the position of a char (index in String) into a [row, col] tuple
- */
- const lineAndColumnFromChar = (x) => {
- const lineEntry = rep.lines.atOffset(x);
- const lineStart = rep.lines.offsetOfEntry(lineEntry);
- const lineNum = rep.lines.indexOfEntry(lineEntry);
- return [lineNum, x - lineStart];
- };
-
- const performDocumentReplaceCharRange = (startChar, endChar, newText) => {
- if (startChar === endChar && newText.length === 0) {
- return;
- }
- // Requires that the replacement preserve the property that the
- // internal document text ends in a newline. Given this, we
- // rewrite the splice so that it doesn't touch the very last
- // char of the document.
- if (endChar === rep.alltext.length) {
- if (startChar === endChar) {
- // an insert at end
- startChar--;
- endChar--;
- newText = `\n${newText.substring(0, newText.length - 1)}`;
- } else if (newText.length === 0) {
- // a delete at end
- startChar--;
- endChar--;
- } else {
- // a replace at end
- endChar--;
- newText = newText.substring(0, newText.length - 1);
- }
- }
- performDocumentReplaceRange(
- lineAndColumnFromChar(startChar), lineAndColumnFromChar(endChar), newText);
- };
-
- const performDocumentApplyAttributesToCharRange = (start, end, attribs) => {
- end = Math.min(end, rep.alltext.length - 1);
- documentAttributeManager.setAttributesOnRange(
- lineAndColumnFromChar(start), lineAndColumnFromChar(end), attribs);
- };
-
- editorInfo.ace_performDocumentApplyAttributesToCharRange =
- performDocumentApplyAttributesToCharRange;
-
- const setAttributeOnSelection = (attributeName, attributeValue) => {
- if (!(rep.selStart && rep.selEnd)) return;
-
- documentAttributeManager.setAttributesOnRange(rep.selStart, rep.selEnd, [
- [attributeName, attributeValue],
- ]);
- };
- editorInfo.ace_setAttributeOnSelection = setAttributeOnSelection;
-
- const getAttributeOnSelection = (attributeName, prevChar) => {
- if (!(rep.selStart && rep.selEnd)) return;
- const isNotSelection = (rep.selStart[0] === rep.selEnd[0] && rep.selEnd[1] === rep.selStart[1]);
- if (isNotSelection) {
- if (prevChar) {
- // If it's not the start of the line
- if (rep.selStart[1] !== 0) {
- rep.selStart[1]--;
- }
- }
- }
-
- const withIt = new AttributeMap(rep.apool).set(attributeName, 'true').toString();
- const withItRegex = new RegExp(`${withIt.replace(/\*/g, '\\*')}(\\*|$)`);
- const hasIt = (attribs) => withItRegex.test(attribs);
-
- const rangeHasAttrib = (selStart, selEnd) => {
- // if range is collapsed -> no attribs in range
- if (selStart[1] === selEnd[1] && selStart[0] === selEnd[0]) return false;
-
- if (selStart[0] !== selEnd[0]) { // -> More than one line selected
- let hasAttrib = true;
-
- // from selStart to the end of the first line
- hasAttrib = hasAttrib &&
- rangeHasAttrib(selStart, [selStart[0], rep.lines.atIndex(selStart[0]).text.length]);
-
- // for all lines in between
- for (let n = selStart[0] + 1; n < selEnd[0]; n++) {
- hasAttrib = hasAttrib && rangeHasAttrib([n, 0], [n, rep.lines.atIndex(n).text.length]);
- }
-
- // for the last, potentially partial, line
- hasAttrib = hasAttrib && rangeHasAttrib([selEnd[0], 0], [selEnd[0], selEnd[1]]);
-
- return hasAttrib;
- }
-
- // Logic tells us we now have a range on a single line
-
- const lineNum = selStart[0];
- const start = selStart[1];
- const end = selEnd[1];
- let hasAttrib = true;
-
- let indexIntoLine = 0;
- for (const op of Changeset.deserializeOps(rep.alines[lineNum])) {
- const opStartInLine = indexIntoLine;
- const opEndInLine = opStartInLine + op.chars;
- if (!hasIt(op.attribs)) {
- // does op overlap selection?
- if (!(opEndInLine <= start || opStartInLine >= end)) {
- // since it's overlapping but hasn't got the attrib -> range hasn't got it
- hasAttrib = false;
- break;
- }
- }
- indexIntoLine = opEndInLine;
- }
-
- return hasAttrib;
- };
- return rangeHasAttrib(rep.selStart, rep.selEnd);
- };
-
- editorInfo.ace_getAttributeOnSelection = getAttributeOnSelection;
-
- const toggleAttributeOnSelection = (attributeName) => {
- if (!(rep.selStart && rep.selEnd)) return;
-
- let selectionAllHasIt = true;
- const withIt = new AttributeMap(rep.apool).set(attributeName, 'true').toString();
- const withItRegex = new RegExp(`${withIt.replace(/\*/g, '\\*')}(\\*|$)`);
-
- const hasIt = (attribs) => withItRegex.test(attribs);
-
- const selStartLine = rep.selStart[0];
- const selEndLine = rep.selEnd[0];
- for (let n = selStartLine; n <= selEndLine; n++) {
- let indexIntoLine = 0;
- let selectionStartInLine = 0;
- if (documentAttributeManager.lineHasMarker(n)) {
- selectionStartInLine = 1; // ignore "*" used as line marker
- }
- let selectionEndInLine = rep.lines.atIndex(n).text.length; // exclude newline
- if (n === selStartLine) {
- selectionStartInLine = rep.selStart[1];
- }
- if (n === selEndLine) {
- selectionEndInLine = rep.selEnd[1];
- }
- for (const op of Changeset.deserializeOps(rep.alines[n])) {
- const opStartInLine = indexIntoLine;
- const opEndInLine = opStartInLine + op.chars;
- if (!hasIt(op.attribs)) {
- // does op overlap selection?
- if (!(opEndInLine <= selectionStartInLine || opStartInLine >= selectionEndInLine)) {
- selectionAllHasIt = false;
- break;
- }
- }
- indexIntoLine = opEndInLine;
- }
- if (!selectionAllHasIt) {
- break;
- }
- }
-
-
- const attributeValue = selectionAllHasIt ? '' : 'true';
- documentAttributeManager.setAttributesOnRange(
- rep.selStart, rep.selEnd, [[attributeName, attributeValue]]);
- if (attribIsFormattingStyle(attributeName)) {
- updateStyleButtonState(attributeName, !selectionAllHasIt); // italic, bold, ...
- }
- };
- editorInfo.ace_toggleAttributeOnSelection = toggleAttributeOnSelection;
-
- const performDocumentReplaceSelection = (newText) => {
- if (!(rep.selStart && rep.selEnd)) return;
- performDocumentReplaceRange(rep.selStart, rep.selEnd, newText);
- };
-
- // Change the abstract representation of the document to have a different set of lines.
- // Must be called after rep.alltext is set.
- const doRepLineSplice = (startLine, deleteCount, newLineEntries) => {
- for (const entry of newLineEntries) entry.width = entry.text.length + 1;
-
- const startOldChar = rep.lines.offsetOfIndex(startLine);
- const endOldChar = rep.lines.offsetOfIndex(startLine + deleteCount);
-
- rep.lines.splice(startLine, deleteCount, newLineEntries);
- currentCallStack.docTextChanged = true;
- currentCallStack.repChanged = true;
- const newText = newLineEntries.map((e) => `${e.text}\n`).join('');
-
- rep.alltext = rep.alltext.substring(0, startOldChar) +
- newText + rep.alltext.substring(endOldChar, rep.alltext.length);
- };
-
- const doIncorpLineSplice = (startLine, deleteCount, newLineEntries, lineAttribs, hints) => {
- const startOldChar = rep.lines.offsetOfIndex(startLine);
- const endOldChar = rep.lines.offsetOfIndex(startLine + deleteCount);
-
- const oldRegionStart = rep.lines.offsetOfIndex(startLine);
-
- let selStartHintChar, selEndHintChar;
- if (hints && hints.selStart) {
- selStartHintChar =
- rep.lines.offsetOfIndex(hints.selStart[0]) + hints.selStart[1] - oldRegionStart;
- }
- if (hints && hints.selEnd) {
- selEndHintChar = rep.lines.offsetOfIndex(hints.selEnd[0]) + hints.selEnd[1] - oldRegionStart;
- }
-
- const newText = newLineEntries.map((e) => `${e.text}\n`).join('');
- const oldText = rep.alltext.substring(startOldChar, endOldChar);
- const oldAttribs = rep.alines.slice(startLine, startLine + deleteCount).join('');
- const newAttribs = `${lineAttribs.join('|1+1')}|1+1`; // not valid in a changeset
- const analysis =
- analyzeChange(oldText, newText, oldAttribs, newAttribs, selStartHintChar, selEndHintChar);
- const commonStart = analysis[0];
- let commonEnd = analysis[1];
- let shortOldText = oldText.substring(commonStart, oldText.length - commonEnd);
- let shortNewText = newText.substring(commonStart, newText.length - commonEnd);
- let spliceStart = startOldChar + commonStart;
- let spliceEnd = endOldChar - commonEnd;
- let shiftFinalNewlineToBeforeNewText = false;
-
- // adjust the splice to not involve the final newline of the document;
- // be very defensive
- if (shortOldText.charAt(shortOldText.length - 1) === '\n' &&
- shortNewText.charAt(shortNewText.length - 1) === '\n') {
- // replacing text that ends in newline with text that also ends in newline
- // (still, after analysis, somehow)
- shortOldText = shortOldText.slice(0, -1);
- shortNewText = shortNewText.slice(0, -1);
- spliceEnd--;
- commonEnd++;
- }
- if (shortOldText.length === 0 &&
- spliceStart === rep.alltext.length &&
- shortNewText.length > 0) {
- // inserting after final newline, bad
- spliceStart--;
- spliceEnd--;
- shortNewText = `\n${shortNewText.slice(0, -1)}`;
- shiftFinalNewlineToBeforeNewText = true;
- }
- if (spliceEnd === rep.alltext.length &&
- shortOldText.length > 0 &&
- shortNewText.length === 0) {
- // deletion at end of rep.alltext
- if (rep.alltext.charAt(spliceStart - 1) === '\n') {
- // (if not then what the heck? it will definitely lead
- // to a rep.alltext without a final newline)
- spliceStart--;
- spliceEnd--;
- }
- }
-
- if (!(shortOldText.length === 0 && shortNewText.length === 0)) {
- const oldDocText = rep.alltext;
- const oldLen = oldDocText.length;
-
- const spliceStartLine = rep.lines.indexOfOffset(spliceStart);
- const spliceStartLineStart = rep.lines.offsetOfIndex(spliceStartLine);
-
- const startBuilder = () => {
- const builder = Changeset.builder(oldLen);
- builder.keep(spliceStartLineStart, spliceStartLine);
- builder.keep(spliceStart - spliceStartLineStart);
- return builder;
- };
-
- const eachAttribRun = (attribs, func /* (startInNewText, endInNewText, attribs)*/) => {
- let textIndex = 0;
- const newTextStart = commonStart;
- const newTextEnd = newText.length - commonEnd - (shiftFinalNewlineToBeforeNewText ? 1 : 0);
- for (const op of Changeset.deserializeOps(attribs)) {
- const nextIndex = textIndex + op.chars;
- if (!(nextIndex <= newTextStart || textIndex >= newTextEnd)) {
- func(Math.max(newTextStart, textIndex), Math.min(newTextEnd, nextIndex), op.attribs);
- }
- textIndex = nextIndex;
- }
- };
-
- const justApplyStyles = (shortNewText === shortOldText);
- let theChangeset;
-
- if (justApplyStyles) {
- // create changeset that clears the incorporated styles on
- // the existing text. we compose this with the
- // changeset the applies the styles found in the DOM.
- // This allows us to incorporate, e.g., Safari's native "unbold".
- const incorpedAttribClearer = cachedStrFunc(
- (oldAtts) => Changeset.mapAttribNumbers(oldAtts, (n) => {
- const k = rep.apool.getAttribKey(n);
- if (isStyleAttribute(k)) {
- return rep.apool.putAttrib([k, '']);
- }
- return false;
- }));
-
- const builder1 = startBuilder();
- if (shiftFinalNewlineToBeforeNewText) {
- builder1.keep(1, 1);
- }
- eachAttribRun(oldAttribs, (start, end, attribs) => {
- builder1.keepText(newText.substring(start, end), incorpedAttribClearer(attribs));
- });
- const clearer = builder1.toString();
-
- const builder2 = startBuilder();
- if (shiftFinalNewlineToBeforeNewText) {
- builder2.keep(1, 1);
- }
- eachAttribRun(newAttribs, (start, end, attribs) => {
- builder2.keepText(newText.substring(start, end), attribs);
- });
- const styler = builder2.toString();
-
- theChangeset = Changeset.compose(clearer, styler, rep.apool);
- } else {
- const builder = startBuilder();
-
- const spliceEndLine = rep.lines.indexOfOffset(spliceEnd);
- const spliceEndLineStart = rep.lines.offsetOfIndex(spliceEndLine);
- if (spliceEndLineStart > spliceStart) {
- builder.remove(spliceEndLineStart - spliceStart, spliceEndLine - spliceStartLine);
- builder.remove(spliceEnd - spliceEndLineStart);
- } else {
- builder.remove(spliceEnd - spliceStart);
- }
-
- let isNewTextMultiauthor = false;
- const authorizer = cachedStrFunc((oldAtts) => {
- const attribs = AttributeMap.fromString(oldAtts, rep.apool);
- if (!isNewTextMultiauthor || !attribs.has('author')) attribs.set('author', thisAuthor);
- return attribs.toString();
- });
-
- let foundDomAuthor = '';
- eachAttribRun(newAttribs, (start, end, attribs) => {
- const a = AttributeMap.fromString(attribs, rep.apool).get('author');
- if (a && a !== foundDomAuthor) {
- if (!foundDomAuthor) {
- foundDomAuthor = a;
- } else {
- isNewTextMultiauthor = true; // multiple authors in DOM!
- }
- }
- });
-
- if (shiftFinalNewlineToBeforeNewText) {
- builder.insert('\n', authorizer(''));
- }
-
- eachAttribRun(newAttribs, (start, end, attribs) => {
- builder.insert(newText.substring(start, end), authorizer(attribs));
- });
- theChangeset = builder.toString();
- }
-
- doRepApplyChangeset(theChangeset);
- }
-
- // do this no matter what, because we need to get the right
- // line keys into the rep.
- doRepLineSplice(startLine, deleteCount, newLineEntries);
- };
-
- const cachedStrFunc = (func) => {
- const cache = {};
- return (s) => {
- if (!cache[s]) {
- cache[s] = func(s);
- }
- return cache[s];
- };
- };
-
- const analyzeChange = (
- oldText, newText, oldAttribs, newAttribs, optSelStartHint, optSelEndHint) => {
- // we need to take into account both the styles attributes & attributes defined by
- // the plugins, so basically we can ignore only the default line attribs used by
- // Etherpad
- const incorpedAttribFilter = (anum) => !isDefaultLineAttribute(rep.apool.getAttribKey(anum));
-
- const attribRuns = (attribs) => {
- const lengs = [];
- const atts = [];
- for (const op of Changeset.deserializeOps(attribs)) {
- lengs.push(op.chars);
- atts.push(op.attribs);
- }
- return [lengs, atts];
- };
-
- const attribIterator = (runs, backward) => {
- const lengs = runs[0];
- const atts = runs[1];
- let i = (backward ? lengs.length - 1 : 0);
- let j = 0;
- const next = () => {
- while (j >= lengs[i]) {
- if (backward) i--;
- else i++;
- j = 0;
- }
- const a = atts[i];
- j++;
- return a;
- };
- return next;
- };
-
- const oldLen = oldText.length;
- const newLen = newText.length;
- const minLen = Math.min(oldLen, newLen);
-
- const oldARuns = attribRuns(Changeset.filterAttribNumbers(oldAttribs, incorpedAttribFilter));
- const newARuns = attribRuns(Changeset.filterAttribNumbers(newAttribs, incorpedAttribFilter));
-
- let commonStart = 0;
- const oldStartIter = attribIterator(oldARuns, false);
- const newStartIter = attribIterator(newARuns, false);
- while (commonStart < minLen) {
- if (oldText.charAt(commonStart) === newText.charAt(commonStart) &&
- oldStartIter() === newStartIter()) {
- commonStart++;
- } else { break; }
- }
-
- let commonEnd = 0;
- const oldEndIter = attribIterator(oldARuns, true);
- const newEndIter = attribIterator(newARuns, true);
- while (commonEnd < minLen) {
- if (commonEnd === 0) {
- // assume newline in common
- oldEndIter();
- newEndIter();
- commonEnd++;
- } else if (
- oldText.charAt(oldLen - 1 - commonEnd) === newText.charAt(newLen - 1 - commonEnd) &&
- oldEndIter() === newEndIter()) {
- commonEnd++;
- } else { break; }
- }
-
- let hintedCommonEnd = -1;
- if ((typeof optSelEndHint) === 'number') {
- hintedCommonEnd = newLen - optSelEndHint;
- }
-
-
- if (commonStart + commonEnd > oldLen) {
- // ambiguous insertion
- const minCommonEnd = oldLen - commonStart;
- const maxCommonEnd = commonEnd;
- if (hintedCommonEnd >= minCommonEnd && hintedCommonEnd <= maxCommonEnd) {
- commonEnd = hintedCommonEnd;
- } else {
- commonEnd = minCommonEnd;
- }
- commonStart = oldLen - commonEnd;
- }
- if (commonStart + commonEnd > newLen) {
- // ambiguous deletion
- const minCommonEnd = newLen - commonStart;
- const maxCommonEnd = commonEnd;
- if (hintedCommonEnd >= minCommonEnd && hintedCommonEnd <= maxCommonEnd) {
- commonEnd = hintedCommonEnd;
- } else {
- commonEnd = minCommonEnd;
- }
- commonStart = newLen - commonEnd;
- }
-
- return [commonStart, commonEnd];
- };
-
- const equalLineAndChars = (a, b) => {
- if (!a) return !b;
- if (!b) return !a;
- return (a[0] === b[0] && a[1] === b[1]);
- };
-
- const performSelectionChange = (selectStart, selectEnd, focusAtStart) => {
- if (repSelectionChange(selectStart, selectEnd, focusAtStart)) {
- currentCallStack.selectionAffected = true;
- }
- };
- editorInfo.ace_performSelectionChange = performSelectionChange;
-
- // Change the abstract representation of the document to have a different selection.
- // Should not rely on the line representation. Should not affect the DOM.
-
-
- const repSelectionChange = (selectStart, selectEnd, focusAtStart) => {
- focusAtStart = !!focusAtStart;
-
- const newSelFocusAtStart = (focusAtStart && ((!selectStart) ||
- (!selectEnd) ||
- (selectStart[0] !== selectEnd[0]) ||
- (selectStart[1] !== selectEnd[1])));
-
- if ((!equalLineAndChars(rep.selStart, selectStart)) ||
- (!equalLineAndChars(rep.selEnd, selectEnd)) ||
- (rep.selFocusAtStart !== newSelFocusAtStart)) {
- rep.selStart = selectStart;
- rep.selEnd = selectEnd;
- rep.selFocusAtStart = newSelFocusAtStart;
- currentCallStack.repChanged = true;
-
- // select the formatting buttons when there is the style applied on selection
- selectFormattingButtonIfLineHasStyleApplied(rep);
-
- hooks.callAll('aceSelectionChanged', {
- rep,
- callstack: currentCallStack,
- documentAttributeManager,
- });
-
- // we scroll when user places the caret at the last line of the pad
- // when this settings is enabled
- const docTextChanged = currentCallStack.docTextChanged;
- if (!docTextChanged) {
- const isScrollableEvent = !isPadLoading(currentCallStack.type) &&
- isScrollableEditEvent(currentCallStack.type);
- const innerHeight = getInnerHeight();
- scroll.scrollWhenCaretIsInTheLastLineOfViewportWhenNecessary(
- rep, isScrollableEvent, innerHeight * 2);
- }
-
- return true;
- }
- return false;
- };
-
- const isPadLoading = (t) => t === 'setup' || t === 'setBaseText' || t === 'importText';
-
- const updateStyleButtonState = (attribName, hasStyleOnRepSelection) => {
- const $formattingButton = parent.parent.$(`[data-key="${attribName}"]`).find('a');
- $formattingButton.toggleClass(SELECT_BUTTON_CLASS, hasStyleOnRepSelection);
- };
-
- const attribIsFormattingStyle = (attribName) => FORMATTING_STYLES.indexOf(attribName) !== -1;
-
- const selectFormattingButtonIfLineHasStyleApplied = (rep) => {
- for (const style of FORMATTING_STYLES) {
- const hasStyleOnRepSelection =
- documentAttributeManager.hasAttributeOnSelectionOrCaretPosition(style);
- updateStyleButtonState(style, hasStyleOnRepSelection);
- }
- };
-
- const doCreateDomLine =
- (nonEmpty) => domline.createDomLine(nonEmpty, doesWrap, browser, document);
-
- const textify =
- (str) => str.replace(/[\n\r ]/g, ' ').replace(/\xa0/g, ' ').replace(/\t/g, ' ');
-
- const _blockElems = {
- div: 1,
- p: 1,
- pre: 1,
- li: 1,
- ol: 1,
- ul: 1,
- };
-
- for (const element of hooks.callAll('aceRegisterBlockElements')) _blockElems[element] = 1;
-
- const isBlockElement = (n) => !!_blockElems[(n.tagName || '').toLowerCase()];
- editorInfo.ace_isBlockElement = isBlockElement;
-
- const getDirtyRanges = () => {
- // based on observedChanges, return a list of ranges of original lines
- // that need to be removed or replaced with new user content to incorporate
- // the user's changes into the line representation. ranges may be zero-length,
- // indicating inserted content. for example, [0,0] means content was inserted
- // at the top of the document, while [3,4] means line 3 was deleted, modified,
- // or replaced with one or more new lines of content. ranges do not touch.
-
- const cleanNodeForIndexCache = {};
- const N = rep.lines.length(); // old number of lines
-
-
- const cleanNodeForIndex = (i) => {
- // if line (i) in the un-updated line representation maps to a clean node
- // in the document, return that node.
- // if (i) is out of bounds, return true. else return false.
- if (cleanNodeForIndexCache[i] === undefined) {
- let result;
- if (i < 0 || i >= N) {
- result = true; // truthy, but no actual node
- } else {
- const key = rep.lines.atIndex(i).key;
- result = (getCleanNodeByKey(key) || false);
- }
- cleanNodeForIndexCache[i] = result;
- }
- return cleanNodeForIndexCache[i];
- };
- const isConsecutiveCache = {};
-
- const isConsecutive = (i) => {
- if (isConsecutiveCache[i] === undefined) {
- isConsecutiveCache[i] = (() => {
- // returns whether line (i) and line (i-1), assumed to be map to clean DOM nodes,
- // or document boundaries, are consecutive in the changed DOM
- const a = cleanNodeForIndex(i - 1);
- const b = cleanNodeForIndex(i);
- if ((!a) || (!b)) return false; // violates precondition
- if ((a === true) && (b === true)) return !document.body.firstChild;
- if ((a === true) && b.previousSibling) return false;
- if ((b === true) && a.nextSibling) return false;
- if ((a === true) || (b === true)) return true;
- return a.nextSibling === b;
- })();
- }
- return isConsecutiveCache[i];
- };
-
- // returns whether line (i) in the un-updated representation maps to a clean node,
- // or is outside the bounds of the document
- const isClean = (i) => !!cleanNodeForIndex(i);
-
- // list of pairs, each representing a range of lines that is clean and consecutive
- // in the changed DOM. lines (-1) and (N) are always clean, but may or may not
- // be consecutive with lines in the document. pairs are in sorted order.
- const cleanRanges = [
- [-1, N + 1],
- ];
-
- // returns index of cleanRange containing i, or -1 if none
- const rangeForLine = (i) => {
- for (const [idx, r] of cleanRanges.entries()) {
- if (i < r[0]) return -1;
- if (i < r[1]) return idx;
- }
- return -1;
- };
-
- const removeLineFromRange = (rng, line) => {
- // rng is index into cleanRanges, line is line number
- // precond: line is in rng
- const a = cleanRanges[rng][0];
- const b = cleanRanges[rng][1];
- if ((a + 1) === b) cleanRanges.splice(rng, 1);
- else if (line === a) cleanRanges[rng][0]++;
- else if (line === (b - 1)) cleanRanges[rng][1]--;
- else cleanRanges.splice(rng, 1, [a, line], [line + 1, b]);
- };
-
- const splitRange = (rng, pt) => {
- // precond: pt splits cleanRanges[rng] into two non-empty ranges
- const a = cleanRanges[rng][0];
- const b = cleanRanges[rng][1];
- cleanRanges.splice(rng, 1, [a, pt], [pt, b]);
- };
-
- const correctedLines = {};
-
- const correctlyAssignLine = (line) => {
- if (correctedLines[line]) return true;
- correctedLines[line] = true;
- // "line" is an index of a line in the un-updated rep.
- // returns whether line was already correctly assigned (i.e. correctly
- // clean or dirty, according to cleanRanges, and if clean, correctly
- // attached or not attached (i.e. in the same range as) the prev and next lines).
- const rng = rangeForLine(line);
- const lineClean = isClean(line);
- if (rng < 0) {
- if (lineClean) {
- // somehow lost clean line
- }
- return true;
- }
- if (!lineClean) {
- // a clean-range includes this dirty line, fix it
- removeLineFromRange(rng, line);
- return false;
- } else {
- // line is clean, but could be wrongly connected to a clean line
- // above or below
- const a = cleanRanges[rng][0];
- const b = cleanRanges[rng][1];
- let didSomething = false;
- // we'll leave non-clean adjacent nodes in the clean range for the caller to
- // detect and deal with. we deal with whether the range should be split
- // just above or just below this line.
- if (a < line && isClean(line - 1) && !isConsecutive(line)) {
- splitRange(rng, line);
- didSomething = true;
- }
- if (b > (line + 1) && isClean(line + 1) && !isConsecutive(line + 1)) {
- splitRange(rng, line + 1);
- didSomething = true;
- }
- return !didSomething;
- }
- };
-
- const detectChangesAroundLine = (line, reqInARow) => {
- // make sure cleanRanges is correct about line number "line" and the surrounding
- // lines; only stops checking at end of document or after no changes need
- // making for several consecutive lines. note that iteration is over old lines,
- // so this operation takes time proportional to the number of old lines
- // that are changed or missing, not the number of new lines inserted.
- let correctInARow = 0;
- let currentIndex = line;
- while (correctInARow < reqInARow && currentIndex >= 0) {
- if (correctlyAssignLine(currentIndex)) {
- correctInARow++;
- } else { correctInARow = 0; }
- currentIndex--;
- }
- correctInARow = 0;
- currentIndex = line;
- while (correctInARow < reqInARow && currentIndex < N) {
- if (correctlyAssignLine(currentIndex)) {
- correctInARow++;
- } else { correctInARow = 0; }
- currentIndex++;
- }
- };
-
- if (N === 0) {
- if (!isConsecutive(0)) {
- splitRange(0, 0);
- }
- } else {
- detectChangesAroundLine(0, 1);
- detectChangesAroundLine(N - 1, 1);
-
- for (const k of Object.keys(observedChanges.cleanNodesNearChanges)) {
- const key = k.substring(1);
- if (rep.lines.containsKey(key)) {
- const line = rep.lines.indexOfKey(key);
- detectChangesAroundLine(line, 2);
- }
- }
- }
-
- const dirtyRanges = [];
- for (let r = 0; r < cleanRanges.length - 1; r++) {
- dirtyRanges.push([cleanRanges[r][1], cleanRanges[r + 1][0]]);
- }
-
- return dirtyRanges;
- };
-
- const markNodeClean = (n) => {
- // clean nodes have knownHTML that matches their innerHTML
- setAssoc(n, 'dirtiness', {nodeId: uniqueId(n), knownHTML: n.innerHTML});
- };
-
- const isNodeDirty = (n) => {
- if (n.parentNode !== document.body) return true;
- const data = getAssoc(n, 'dirtiness');
- if (!data) return true;
- if (n.id !== data.nodeId) return true;
- if (n.innerHTML !== data.knownHTML) return true;
- return false;
- };
-
- const handleClick = (evt) => {
- inCallStackIfNecessary('handleClick', () => {
- idleWorkTimer.atMost(200);
- });
-
- const isLink = (n) => (n.tagName || '').toLowerCase() === 'a' && n.href;
-
- // only want to catch left-click
- if ((!evt.ctrlKey) && (evt.button !== 2) && (evt.button !== 3)) {
- // find A tag with HREF
- let n = evt.target;
- while (n && n.parentNode && !isLink(n)) {
- n = n.parentNode;
- }
- if (n && isLink(n)) {
- try {
- window.open(n.href, '_blank', 'noopener,noreferrer');
- } catch (e) {
- // absorb "user canceled" error in IE for certain prompts
- }
- evt.preventDefault();
- }
- }
-
- hideEditBarDropdowns();
- };
-
- const hideEditBarDropdowns = () => {
- window.parent.parent.padeditbar.toggleDropDown('none');
- };
-
- const renumberList = (lineNum) => {
- // 1-check we are in a list
- let type = getLineListType(lineNum);
- if (!type) {
- return null;
- }
- type = /([a-z]+)[0-9]+/.exec(type);
- if (type[1] === 'indent') {
- return null;
- }
-
- // 2-find the first line of the list
- while (lineNum - 1 >= 0 && (type = getLineListType(lineNum - 1))) {
- type = /([a-z]+)[0-9]+/.exec(type);
- if (type[1] === 'indent') break;
- lineNum--;
- }
-
- // 3-renumber every list item of the same level from the beginning, level 1
- // IMPORTANT: never skip a level because there imbrication may be arbitrary
- const builder = Changeset.builder(rep.lines.totalWidth());
- let loc = [0, 0];
- const applyNumberList = (line, level) => {
- // init
- let position = 1;
- let curLevel = level;
- let listType;
- // loop over the lines
- while ((listType = getLineListType(line))) {
- // apply new num
- listType = /([a-z]+)([0-9]+)/.exec(listType);
- curLevel = Number(listType[2]);
- if (isNaN(curLevel) || listType[0] === 'indent') {
- return line;
- } else if (curLevel === level) {
- ChangesetUtils.buildKeepRange(rep, builder, loc, (loc = [line, 0]));
- ChangesetUtils.buildKeepRange(rep, builder, loc, (loc = [line, 1]), [
- ['start', position],
- ], rep.apool);
-
- position++;
- line++;
- } else if (curLevel < level) {
- return line;// back to parent
- } else {
- line = applyNumberList(line, level + 1);// recursive call
- }
- }
- return line;
- };
-
- applyNumberList(lineNum, 1);
- const cs = builder.toString();
- if (!Changeset.isIdentity(cs)) {
- performDocumentApplyChangeset(cs);
- }
-
- // 4-apply the modifications
- };
- editorInfo.ace_renumberList = renumberList;
-
- const setLineListType = (lineNum, listType) => {
- if (listType === '') {
- documentAttributeManager.removeAttributeOnLine(lineNum, listAttributeName);
- documentAttributeManager.removeAttributeOnLine(lineNum, 'start');
- } else {
- documentAttributeManager.setAttributeOnLine(lineNum, listAttributeName, listType);
- }
-
- // if the list has been removed, it is necessary to renumber
- // starting from the *next* line because the list may have been
- // separated. If it returns null, it means that the list was not cut, try
- // from the current one.
- if (renumberList(lineNum + 1) == null) {
- renumberList(lineNum);
- }
- };
-
- const doReturnKey = () => {
- if (!(rep.selStart && rep.selEnd)) {
- return;
- }
-
- const lineNum = rep.selStart[0];
- let listType = getLineListType(lineNum);
-
- if (listType) {
- const text = rep.lines.atIndex(lineNum).text;
- listType = /([a-z]+)([0-9]+)/.exec(listType);
- const type = listType[1];
- const level = Number(listType[2]);
-
- // detect empty list item; exclude indentation
- if (text === '*' && type !== 'indent') {
- // if not already on the highest level
- if (level > 1) {
- setLineListType(lineNum, type + (level - 1));// automatically decrease the level
- } else {
- setLineListType(lineNum, '');// remove the list
- renumberList(lineNum + 1);// trigger renumbering of list that may be right after
- }
- } else if (lineNum + 1 <= rep.lines.length()) {
- performDocumentReplaceSelection('\n');
- setLineListType(lineNum + 1, type + level);
- }
- } else {
- performDocumentReplaceSelection('\n');
- handleReturnIndentation();
- }
- };
- editorInfo.ace_doReturnKey = doReturnKey;
-
- const doIndentOutdent = (isOut) => {
- if (!((rep.selStart && rep.selEnd) ||
- (rep.selStart[0] === rep.selEnd[0] &&
- rep.selStart[1] === rep.selEnd[1] &&
- rep.selEnd[1] > 1)) &&
- isOut !== true) {
- return false;
- }
-
- const firstLine = rep.selStart[0];
- const lastLine = Math.max(firstLine, rep.selEnd[0] - ((rep.selEnd[1] === 0) ? 1 : 0));
- const mods = [];
- for (let n = firstLine; n <= lastLine; n++) {
- let listType = getLineListType(n);
- let t = 'indent';
- let level = 0;
- if (listType) {
- listType = /([a-z]+)([0-9]+)/.exec(listType);
- if (listType) {
- t = listType[1];
- level = Number(listType[2]);
- }
- }
- const newLevel = Math.max(0, Math.min(MAX_LIST_LEVEL, level + (isOut ? -1 : 1)));
- if (level !== newLevel) {
- mods.push([n, (newLevel > 0) ? t + newLevel : '']);
- }
- }
-
- for (const mod of mods) setLineListType(mod[0], mod[1]);
- return true;
- };
- editorInfo.ace_doIndentOutdent = doIndentOutdent;
-
- const doTabKey = (shiftDown) => {
- if (!doIndentOutdent(shiftDown)) {
- performDocumentReplaceSelection(THE_TAB);
- }
- };
-
- const doDeleteKey = (optEvt) => {
- const evt = optEvt || {};
- let handled = false;
- if (rep.selStart) {
- if (isCaret()) {
- const lineNum = caretLine();
- const col = caretColumn();
- const lineEntry = rep.lines.atIndex(lineNum);
- const lineText = lineEntry.text;
- const lineMarker = lineEntry.lineMarker;
- if (evt.metaKey && col > lineMarker) {
- // cmd-backspace deletes to start of line (if not already at start)
- performDocumentReplaceRange([lineNum, lineMarker], [lineNum, col], '');
- handled = true;
- } else if (/^ +$/.exec(lineText.substring(lineMarker, col))) {
- const col2 = col - lineMarker;
- const tabSize = THE_TAB.length;
- const toDelete = ((col2 - 1) % tabSize) + 1;
- performDocumentReplaceRange([lineNum, col - toDelete], [lineNum, col], '');
- handled = true;
- }
- }
- if (!handled) {
- if (isCaret()) {
- const theLine = caretLine();
- const lineEntry = rep.lines.atIndex(theLine);
- if (caretColumn() <= lineEntry.lineMarker) {
- // delete at beginning of line
- const prevLineListType = (theLine > 0 ? getLineListType(theLine - 1) : '');
- const thisLineListType = getLineListType(theLine);
- const prevLineEntry = (theLine > 0 && rep.lines.atIndex(theLine - 1));
- const prevLineBlank = (prevLineEntry &&
- prevLineEntry.text.length === prevLineEntry.lineMarker);
-
- const thisLineHasMarker = documentAttributeManager.lineHasMarker(theLine);
-
- if (thisLineListType) {
- // this line is a list
- if (prevLineBlank && !prevLineListType) {
- // previous line is blank, remove it
- performDocumentReplaceRange(
- [theLine - 1, prevLineEntry.text.length], [theLine, 0], '');
- } else {
- // delistify
- performDocumentReplaceRange([theLine, 0], [theLine, lineEntry.lineMarker], '');
- }
- } else if (thisLineHasMarker && prevLineEntry) {
- // If the line has any attributes assigned, remove them by removing the marker '*'
- performDocumentReplaceRange(
- [theLine - 1, prevLineEntry.text.length], [theLine, lineEntry.lineMarker], '');
- } else if (theLine > 0) {
- // remove newline
- performDocumentReplaceRange(
- [theLine - 1, prevLineEntry.text.length], [theLine, 0], '');
- }
- } else {
- const docChar = caretDocChar();
- if (docChar > 0) {
- if (evt.metaKey || evt.ctrlKey || evt.altKey) {
- // delete as many unicode "letters or digits" in a row as possible;
- // always delete one char, delete further even if that first char
- // isn't actually a word char.
- let deleteBackTo = docChar - 1;
- while (deleteBackTo > lineEntry.lineMarker &&
- isWordChar(rep.alltext.charAt(deleteBackTo - 1))) {
- deleteBackTo--;
- }
- performDocumentReplaceCharRange(deleteBackTo, docChar, '');
- } else {
- // normal delete
- performDocumentReplaceCharRange(docChar - 1, docChar, '');
- }
- }
- }
- } else {
- performDocumentReplaceSelection('');
- }
- }
- }
- // if the list has been removed, it is necessary to renumber
- // starting from the *next* line because the list may have been
- // separated. If it returns null, it means that the list was not cut, try
- // from the current one.
- const line = caretLine();
- if (line !== -1 && renumberList(line + 1) == null) {
- renumberList(line);
- }
- };
-
- const isWordChar = (c) => padutils.wordCharRegex.test(c);
- editorInfo.ace_isWordChar = isWordChar;
-
- const handleKeyEvent = (evt) => {
- if (!isEditable) return;
- const {type, charCode, keyCode, which, altKey, shiftKey} = evt;
-
- // Don't take action based on modifier keys going up and down.
- // Modifier keys do not generate "keypress" events.
- // 224 is the command-key under Mac Firefox.
- // 91 is the Windows key in IE; it is ASCII for open-bracket but isn't the keycode for that key
- // 20 is capslock in IE.
- const isModKey = !charCode && (type === 'keyup' || type === 'keydown') &&
- (keyCode === 16 || keyCode === 17 || keyCode === 18 ||
- keyCode === 20 || keyCode === 224 || keyCode === 91);
- if (isModKey) return;
-
- // If the key is a keypress and the browser is opera and the key is enter,
- // do nothign at all as this fires twice.
- if (keyCode === 13 && browser.opera && type === 'keypress') {
- // This stops double enters in Opera but double Tabs still show on single
- // tab keypress, adding keyCode == 9 to this doesn't help as the event is fired twice
- return;
- }
-
- const isTypeForSpecialKey = browser.safari || browser.chrome || browser.firefox
- ? type === 'keydown' : type === 'keypress';
- const isTypeForCmdKey = browser.safari || browser.chrome || browser.firefox
- ? type === 'keydown' : type === 'keypress';
-
- let stopped = false;
-
- inCallStackIfNecessary('handleKeyEvent', function () {
- if (type === 'keypress' || (isTypeForSpecialKey && keyCode === 13 /* return*/)) {
- // in IE, special keys don't send keypress, the keydown does the action
- if (!outsideKeyPress(evt)) {
- evt.preventDefault();
- stopped = true;
- }
- } else if (evt.key === 'Dead') {
- // If it's a dead key we don't want to do any Etherpad behavior.
- stopped = true;
- return true;
- } else if (type === 'keydown') {
- outsideKeyDown(evt);
- }
- let specialHandled = false;
- if (!stopped) {
- const specialHandledInHook = hooks.callAll('aceKeyEvent', {
- callstack: currentCallStack,
- editorInfo,
- rep,
- documentAttributeManager,
- evt,
- });
-
- // if any hook returned true, set specialHandled with true
- if (specialHandledInHook) {
- specialHandled = specialHandledInHook.indexOf(true) !== -1;
- }
-
- const padShortcutEnabled = parent.parent.clientVars.padShortcutEnabled;
- if (!specialHandled && isTypeForSpecialKey &&
- altKey && keyCode === 120 &&
- padShortcutEnabled.altF9) {
- // Alt F9 focuses on the File Menu and/or editbar.
- // Note that while most editors use Alt F10 this is not desirable
- // As ubuntu cannot use Alt F10....
- // Focus on the editbar.
- // -- TODO: Move Focus back to previous state (we know it so we can use it)
- const firstEditbarElement = parent.parent.$('#editbar')
- .children('ul').first().children().first()
- .children().first().children().first();
- $(this).blur();
- firstEditbarElement.focus();
- evt.preventDefault();
- }
- if (!specialHandled && type === 'keydown' &&
- altKey && keyCode === 67 &&
- padShortcutEnabled.altC) {
- // Alt c focuses on the Chat window
- $(this).blur();
- parent.parent.chat.show();
- parent.parent.$('#chatinput').focus();
- evt.preventDefault();
- }
- if (!specialHandled && type === 'keydown' &&
- evt.ctrlKey && shiftKey && keyCode === 50 &&
- padShortcutEnabled.cmdShift2) {
- // Control-Shift-2 shows a gritter popup showing a line author
- const lineNumber = rep.selEnd[0];
- const alineAttrs = rep.alines[lineNumber];
- const apool = rep.apool;
-
- // TODO: support selection ranges
- // TODO: Still work when authorship colors have been cleared
- // TODO: i18n
- // TODO: There appears to be a race condition or so.
- const authorIds = new Set();
- if (alineAttrs) {
- for (const op of Changeset.deserializeOps(alineAttrs)) {
- const authorId = AttributeMap.fromString(op.attribs, apool).get('author');
- if (authorId) authorIds.add(authorId);
- }
- }
- const idToName = new Map(parent.parent.pad.userList().map((a) => [a.userId, a.name]));
- const myId = parent.parent.clientVars.userId;
- const authors =
- [...authorIds].map((id) => id === myId ? 'me' : idToName.get(id) || 'unknown');
-
- parent.parent.$.gritter.add({
- title: 'Line Authors',
- text:
- authors.length === 0 ? 'No author information is available'
- : authors.length === 1 ? `The author of this line is ${authors[0]}`
- : `The authors of this line are ${authors.join(' & ')}`,
- sticky: false,
- time: '4000',
- });
- }
- if (!specialHandled && isTypeForSpecialKey &&
- keyCode === 8 &&
- padShortcutEnabled.delete) {
- // "delete" key; in mozilla, if we're at the beginning of a line, normalize now,
- // or else deleting a blank line can take two delete presses.
- // --
- // we do deletes completely customly now:
- // - allows consistent (and better) meta-delete behavior
- // - normalizing and then allowing default behavior confused IE
- // - probably eliminates a few minor quirks
- fastIncorp(3);
- evt.preventDefault();
- doDeleteKey(evt);
- specialHandled = true;
- }
- if (!specialHandled && isTypeForSpecialKey &&
- keyCode === 13 &&
- padShortcutEnabled.return) {
- // return key, handle specially;
- // note that in mozilla we need to do an incorporation for proper return behavior anyway.
- fastIncorp(4);
- evt.preventDefault();
- doReturnKey();
- scheduler.setTimeout(() => {
- outerWin.scrollBy(-100, 0);
- }, 0);
- specialHandled = true;
- }
- if (!specialHandled && isTypeForSpecialKey &&
- keyCode === 27 &&
- padShortcutEnabled.esc) {
- // prevent esc key;
- // in mozilla versions 14-19 avoid reconnecting pad.
-
- fastIncorp(4);
- evt.preventDefault();
- specialHandled = true;
-
- // close all gritters when the user hits escape key
- parent.parent.$.gritter.removeAll();
- }
- if (!specialHandled && isTypeForCmdKey &&
- /* Do a saved revision on ctrl S */
- (evt.metaKey || evt.ctrlKey) && String.fromCharCode(which).toLowerCase() === 's' &&
- !evt.altKey &&
- padShortcutEnabled.cmdS) {
- evt.preventDefault();
- const originalBackground = parent.parent.$('#revisionlink').css('background');
- parent.parent.$('#revisionlink').css({background: 'lightyellow'});
- scheduler.setTimeout(() => {
- parent.parent.$('#revisionlink').css({background: originalBackground});
- }, 1000);
- /* The parent.parent part of this is BAD and I feel bad.. It may break something */
- parent.parent.pad.collabClient.sendMessage({type: 'SAVE_REVISION'});
- specialHandled = true;
- }
- if (!specialHandled && isTypeForSpecialKey &&
- // tab
- keyCode === 9 &&
- !(evt.metaKey || evt.ctrlKey) &&
- padShortcutEnabled.tab) {
- fastIncorp(5);
- evt.preventDefault();
- doTabKey(evt.shiftKey);
- specialHandled = true;
- }
- if (!specialHandled && isTypeForCmdKey &&
- // cmd-Z (undo)
- (evt.metaKey || evt.ctrlKey) && String.fromCharCode(which).toLowerCase() === 'z' &&
- !evt.altKey &&
- padShortcutEnabled.cmdZ) {
- fastIncorp(6);
- evt.preventDefault();
- if (evt.shiftKey) {
- doUndoRedo('redo');
- } else {
- doUndoRedo('undo');
- }
- specialHandled = true;
- }
- if (!specialHandled && isTypeForCmdKey &&
- // cmd-Y (redo)
- (evt.metaKey || evt.ctrlKey) && String.fromCharCode(which).toLowerCase() === 'y' &&
- padShortcutEnabled.cmdY) {
- fastIncorp(10);
- evt.preventDefault();
- doUndoRedo('redo');
- specialHandled = true;
- }
- if (!specialHandled && isTypeForCmdKey &&
- // cmd-B (bold)
- (evt.metaKey || evt.ctrlKey) && String.fromCharCode(which).toLowerCase() === 'b' &&
- padShortcutEnabled.cmdB) {
- fastIncorp(13);
- evt.preventDefault();
- toggleAttributeOnSelection('bold');
- specialHandled = true;
- }
- if (!specialHandled && isTypeForCmdKey &&
- // cmd-I (italic)
- (evt.metaKey || evt.ctrlKey) && String.fromCharCode(which).toLowerCase() === 'i' &&
- padShortcutEnabled.cmdI) {
- fastIncorp(14);
- evt.preventDefault();
- toggleAttributeOnSelection('italic');
- specialHandled = true;
- }
- if (!specialHandled && isTypeForCmdKey &&
- // cmd-U (underline)
- (evt.metaKey || evt.ctrlKey) && String.fromCharCode(which).toLowerCase() === 'u' &&
- padShortcutEnabled.cmdU) {
- fastIncorp(15);
- evt.preventDefault();
- toggleAttributeOnSelection('underline');
- specialHandled = true;
- }
- if (!specialHandled && isTypeForCmdKey &&
- // cmd-5 (strikethrough)
- (evt.metaKey || evt.ctrlKey) && String.fromCharCode(which).toLowerCase() === '5' &&
- evt.altKey !== true &&
- padShortcutEnabled.cmd5) {
- fastIncorp(13);
- evt.preventDefault();
- toggleAttributeOnSelection('strikethrough');
- specialHandled = true;
- }
- if (!specialHandled && isTypeForCmdKey &&
- // cmd-shift-L (unorderedlist)
- (evt.metaKey || evt.ctrlKey) && String.fromCharCode(which).toLowerCase() === 'l' &&
- evt.shiftKey &&
- padShortcutEnabled.cmdShiftL) {
- fastIncorp(9);
- evt.preventDefault();
- doInsertUnorderedList();
- specialHandled = true;
- }
- if (!specialHandled && isTypeForCmdKey &&
- // cmd-shift-N and cmd-shift-1 (orderedlist)
- (evt.metaKey || evt.ctrlKey) && evt.shiftKey &&
- ((String.fromCharCode(which).toLowerCase() === 'n' && padShortcutEnabled.cmdShiftN) ||
- (String.fromCharCode(which) === '1' && padShortcutEnabled.cmdShift1))) {
- fastIncorp(9);
- evt.preventDefault();
- doInsertOrderedList();
- specialHandled = true;
- }
- if (!specialHandled && isTypeForCmdKey &&
- // cmd-shift-C (clearauthorship)
- (evt.metaKey || evt.ctrlKey) && evt.shiftKey &&
- String.fromCharCode(which).toLowerCase() === 'c' &&
- padShortcutEnabled.cmdShiftC) {
- fastIncorp(9);
- evt.preventDefault();
- CMDS.clearauthorship();
- }
- if (!specialHandled && isTypeForCmdKey &&
- // cmd-H (backspace)
- (evt.ctrlKey) && String.fromCharCode(which).toLowerCase() === 'h' &&
- padShortcutEnabled.cmdH) {
- fastIncorp(20);
- evt.preventDefault();
- doDeleteKey();
- specialHandled = true;
- }
- if (evt.ctrlKey === true && evt.which === 36 &&
- // Control Home send to Y = 0
- padShortcutEnabled.ctrlHome) {
- scroll.setScrollY(0);
- }
- if ((evt.which === 33 || evt.which === 34) && type === 'keydown' && !evt.ctrlKey) {
- // This is required, browsers will try to do normal default behavior on
- // page up / down and the default behavior SUCKS
- evt.preventDefault();
- const oldVisibleLineRange = scroll.getVisibleLineRange(rep);
- let topOffset = rep.selStart[0] - oldVisibleLineRange[0];
- if (topOffset < 0) {
- topOffset = 0;
- }
-
- const isPageDown = evt.which === 34;
- const isPageUp = evt.which === 33;
-
- scheduler.setTimeout(() => {
- // the visible lines IE 1,10
- const newVisibleLineRange = scroll.getVisibleLineRange(rep);
- // total count of lines in pad IE 10
- const linesCount = rep.lines.length();
- // How many lines are in the viewport right now?
- const numberOfLinesInViewport = newVisibleLineRange[1] - newVisibleLineRange[0];
-
- if (isPageUp && padShortcutEnabled.pageUp) {
- // move to the bottom line +1 in the viewport (essentially skipping over a page)
- rep.selEnd[0] -= numberOfLinesInViewport;
- // move to the bottom line +1 in the viewport (essentially skipping over a page)
- rep.selStart[0] -= numberOfLinesInViewport;
- }
-
- // if we hit page down
- if (isPageDown && padShortcutEnabled.pageDown) {
- // If the new viewpoint position is actually further than where we are right now
- if (rep.selEnd[0] >= oldVisibleLineRange[0]) {
- // dont go further in the page down than what's visible IE go from 0 to 50
- // if 50 is visible on screen but dont go below that else we miss content
- rep.selStart[0] = oldVisibleLineRange[1] - 1;
- // dont go further in the page down than what's visible IE go from 0 to 50
- // if 50 is visible on screen but dont go below that else we miss content
- rep.selEnd[0] = oldVisibleLineRange[1] - 1;
- }
- }
-
- // ensure min and max
- if (rep.selEnd[0] < 0) {
- rep.selEnd[0] = 0;
- }
- if (rep.selStart[0] < 0) {
- rep.selStart[0] = 0;
- }
- if (rep.selEnd[0] >= linesCount) {
- rep.selEnd[0] = linesCount - 1;
- }
- updateBrowserSelectionFromRep();
- // get the current caret selection, can't use rep. here because that only gives
- // us the start position not the current
- const myselection = document.getSelection();
- // get the carets selection offset in px IE 214
- let caretOffsetTop = myselection.focusNode.parentNode.offsetTop ||
- myselection.focusNode.offsetTop;
-
- // sometimes the first selection is -1 which causes problems
- // (Especially with ep_page_view)
- // so use focusNode.offsetTop value.
- if (caretOffsetTop === -1) caretOffsetTop = myselection.focusNode.offsetTop;
- // set the scrollY offset of the viewport on the document
- scroll.setScrollY(caretOffsetTop);
- }, 200);
- }
- }
-
- if (type === 'keydown') {
- idleWorkTimer.atLeast(500);
- } else if (type === 'keypress') {
- // OPINION ASKED. What's going on here? :D
- if (!specialHandled) {
- idleWorkTimer.atMost(0);
- } else {
- idleWorkTimer.atLeast(500);
- }
- } else if (type === 'keyup') {
- const wait = 0;
- idleWorkTimer.atLeast(wait);
- idleWorkTimer.atMost(wait);
- }
-
- // Is part of multi-keystroke international character on Firefox Mac
- const isFirefoxHalfCharacter =
- (browser.firefox && evt.altKey && charCode === 0 && keyCode === 0);
-
- // Is part of multi-keystroke international character on Safari Mac
- const isSafariHalfCharacter =
- (browser.safari && evt.altKey && keyCode === 229);
-
- if (thisKeyDoesntTriggerNormalize || isFirefoxHalfCharacter || isSafariHalfCharacter) {
- idleWorkTimer.atLeast(3000); // give user time to type
- // if this is a keydown, e.g., the keyup shouldn't trigger a normalize
- thisKeyDoesntTriggerNormalize = true;
- }
-
- if (!specialHandled && !thisKeyDoesntTriggerNormalize && !inInternationalComposition &&
- type !== 'keyup') {
- observeChangesAroundSelection();
- }
-
- if (type === 'keyup') {
- thisKeyDoesntTriggerNormalize = false;
- }
- });
- };
-
- let thisKeyDoesntTriggerNormalize = false;
-
- const doUndoRedo = (which) => {
- // precond: normalized DOM
- if (undoModule.enabled) {
- let whichMethod;
- if (which === 'undo') whichMethod = 'performUndo';
- if (which === 'redo') whichMethod = 'performRedo';
- if (whichMethod) {
- const oldEventType = currentCallStack.editEvent.eventType;
- currentCallStack.startNewEvent(which);
- undoModule[whichMethod]((backset, selectionInfo) => {
- if (backset) {
- performDocumentApplyChangeset(backset);
- }
- if (selectionInfo) {
- performSelectionChange(
- lineAndColumnFromChar(selectionInfo.selStart),
- lineAndColumnFromChar(selectionInfo.selEnd),
- selectionInfo.selFocusAtStart);
- }
- const oldEvent = currentCallStack.startNewEvent(oldEventType, true);
- return oldEvent;
- });
- }
- }
- };
- editorInfo.ace_doUndoRedo = doUndoRedo;
-
- const setSelection = (selection) => {
- const copyPoint = (pt) => ({
- node: pt.node,
- index: pt.index,
- maxIndex: pt.maxIndex,
- });
- let isCollapsed;
-
- const pointToRangeBound = (pt) => {
- const p = copyPoint(pt);
- // Make sure Firefox cursor is deep enough; fixes cursor jumping when at top level,
- // and also problem where cut/copy of a whole line selected with fake arrow-keys
- // copies the next line too.
- if (isCollapsed) {
- const diveDeep = () => {
- while (p.node.childNodes.length > 0) {
- if (p.index === 0) {
- p.node = p.node.firstChild;
- p.maxIndex = nodeMaxIndex(p.node);
- } else if (p.index === p.maxIndex) {
- p.node = p.node.lastChild;
- p.maxIndex = nodeMaxIndex(p.node);
- p.index = p.maxIndex;
- } else { break; }
- }
- };
- // now fix problem where cursor at end of text node at end of span-like element
- // with background doesn't seem to show up...
- if (isNodeText(p.node) && p.index === p.maxIndex) {
- let n = p.node;
- while (!n.nextSibling && n !== document.body && n.parentNode !== document.body) {
- n = n.parentNode;
- }
- if (n.nextSibling &&
- !(typeof n.nextSibling.tagName === 'string' &&
- n.nextSibling.tagName.toLowerCase() === 'br') &&
- n !== p.node && n !== document.body && n.parentNode !== document.body) {
- // found a parent, go to next node and dive in
- p.node = n.nextSibling;
- p.maxIndex = nodeMaxIndex(p.node);
- p.index = 0;
- diveDeep();
- }
- }
- // try to make sure insertion point is styled;
- // also fixes other FF problems
- if (!isNodeText(p.node)) {
- diveDeep();
- }
- }
- if (isNodeText(p.node)) {
- return {
- container: p.node,
- offset: p.index,
- };
- } else {
- // p.index in {0,1}
- return {
- container: p.node.parentNode,
- offset: childIndex(p.node) + p.index,
- };
- }
- };
- const browserSelection = window.getSelection();
- if (browserSelection) {
- browserSelection.removeAllRanges();
- if (selection) {
- isCollapsed = (selection.startPoint.node === selection.endPoint.node &&
- selection.startPoint.index === selection.endPoint.index);
- const start = pointToRangeBound(selection.startPoint);
- const end = pointToRangeBound(selection.endPoint);
-
- if (!isCollapsed && selection.focusAtStart &&
- browserSelection.collapse && browserSelection.extend) {
- // can handle "backwards"-oriented selection, shift-arrow-keys move start
- // of selection
- browserSelection.collapse(end.container, end.offset);
- browserSelection.extend(start.container, start.offset);
- } else {
- const range = document.createRange();
- range.setStart(start.container, start.offset);
- range.setEnd(end.container, end.offset);
- browserSelection.removeAllRanges();
- browserSelection.addRange(range);
- }
- }
- }
- };
-
- const updateBrowserSelectionFromRep = () => {
- // requires normalized DOM!
- const selStart = rep.selStart;
- const selEnd = rep.selEnd;
-
- if (!(selStart && selEnd)) {
- setSelection(null);
- return;
- }
-
- const selection = {};
-
- const ss = [selStart[0], selStart[1]];
- selection.startPoint = getPointForLineAndChar(ss);
-
- const se = [selEnd[0], selEnd[1]];
- selection.endPoint = getPointForLineAndChar(se);
-
- selection.focusAtStart = !!rep.selFocusAtStart;
- setSelection(selection);
- };
- editorInfo.ace_updateBrowserSelectionFromRep = updateBrowserSelectionFromRep;
- editorInfo.ace_focus = focus;
- editorInfo.ace_importText = importText;
- editorInfo.ace_importAText = importAText;
- editorInfo.ace_exportText = exportText;
- editorInfo.ace_editorChangedSize = editorChangedSize;
- editorInfo.ace_setOnKeyPress = setOnKeyPress;
- editorInfo.ace_setOnKeyDown = setOnKeyDown;
- editorInfo.ace_setNotifyDirty = setNotifyDirty;
- editorInfo.ace_dispose = dispose;
- editorInfo.ace_setEditable = setEditable;
- editorInfo.ace_execCommand = execCommand;
- editorInfo.ace_replaceRange = replaceRange;
- editorInfo.ace_getAuthorInfos = getAuthorInfos;
- editorInfo.ace_performDocumentReplaceRange = performDocumentReplaceRange;
- editorInfo.ace_performDocumentReplaceCharRange = performDocumentReplaceCharRange;
- editorInfo.ace_setSelection = setSelection;
-
- const nodeMaxIndex = (nd) => {
- if (isNodeText(nd)) return nd.nodeValue.length;
- else return 1;
- };
-
- const getSelection = () => {
- // returns null, or a structure containing startPoint and endPoint,
- // each of which has node (a magicdom node), index, and maxIndex. If the node
- // is a text node, maxIndex is the length of the text; else maxIndex is 1.
- // index is between 0 and maxIndex, inclusive.
- const browserSelection = window.getSelection();
- if (!browserSelection || browserSelection.type === 'None' ||
- browserSelection.rangeCount === 0) {
- return null;
- }
- const range = browserSelection.getRangeAt(0);
-
- const isInBody = (n) => {
- while (n && !(n.tagName && n.tagName.toLowerCase() === 'body')) {
- n = n.parentNode;
- }
- return !!n;
- };
-
- const pointFromRangeBound = (container, offset) => {
- if (!isInBody(container)) {
- // command-click in Firefox selects whole document, HEAD and BODY!
- return {
- node: document.body,
- index: 0,
- maxIndex: 1,
- };
- }
- const n = container;
- const childCount = n.childNodes.length;
- if (isNodeText(n)) {
- return {
- node: n,
- index: offset,
- maxIndex: n.nodeValue.length,
- };
- } else if (childCount === 0) {
- return {
- node: n,
- index: 0,
- maxIndex: 1,
- };
- // treat point between two nodes as BEFORE the second (rather than after the first)
- // if possible; this way point at end of a line block-element is treated as
- // at beginning of next line
- } else if (offset === childCount) {
- const nd = n.childNodes.item(childCount - 1);
- const max = nodeMaxIndex(nd);
- return {
- node: nd,
- index: max,
- maxIndex: max,
- };
- } else {
- const nd = n.childNodes.item(offset);
- const max = nodeMaxIndex(nd);
- return {
- node: nd,
- index: 0,
- maxIndex: max,
- };
- }
- };
- const selection = {
- startPoint: pointFromRangeBound(range.startContainer, range.startOffset),
- endPoint: pointFromRangeBound(range.endContainer, range.endOffset),
- focusAtStart:
- (range.startContainer !== range.endContainer || range.startOffset !== range.endOffset) &&
- browserSelection.anchorNode &&
- browserSelection.anchorNode === range.endContainer &&
- browserSelection.anchorOffset === range.endOffset,
- };
-
- if (selection.startPoint.node.ownerDocument !== window.document) {
- return null;
- }
-
- return selection;
- };
-
- const childIndex = (n) => {
- let idx = 0;
- while (n.previousSibling) {
- idx++;
- n = n.previousSibling;
- }
- return idx;
- };
-
- const fixView = () => {
- // calling this method repeatedly should be fast
- if (getInnerWidth() === 0 || getInnerHeight() === 0) {
- return;
- }
-
- enforceEditability();
-
- $(sideDiv).addClass('sidedivdelayed');
- };
-
- const _teardownActions = [];
-
- const teardown = () => { for (const a of _teardownActions) a(); };
-
- let inInternationalComposition = null;
- editorInfo.ace_getInInternationalComposition = () => inInternationalComposition;
-
- const bindTheEventHandlers = () => {
- $(document).on('keydown', handleKeyEvent);
- $(document).on('keypress', handleKeyEvent);
- $(document).on('keyup', handleKeyEvent);
- $(document).on('click', handleClick);
- // dropdowns on edit bar need to be closed on clicks on both pad inner and pad outer
- $(outerDoc).on('click', hideEditBarDropdowns);
-
- // If non-nullish, pasting on a link should be suppressed.
- let suppressPasteOnLink = null;
-
- $(document.body).on('auxclick', (e) => {
- if (e.originalEvent.button === 1 && (e.target.a || e.target.localName === 'a')) {
- // The user middle-clicked on a link. Usually users do this to open a link in a new tab, but
- // in X11 (Linux) this will instead paste the contents of the primary selection at the mouse
- // cursor. Users almost certainly do not want to paste when middle-clicking on a link, so
- // tell the 'paste' event handler to suppress the paste. This is done by starting a
- // short-lived timer that suppresses paste (when the target is a link) until either the
- // paste event arrives or the timer fires.
- //
- // Why it is implemented this way:
- // * Users want to be able to paste on a link via Ctrl-V, the Edit menu, or the context
- // menu (https://github.com/ether/etherpad-lite/issues/2775) so we cannot simply
- // suppress all paste actions when the target is a link.
- // * Non-X11 systems do not paste when the user middle-clicks, so the paste suppression
- // must be self-resetting.
- // * On non-X11 systems, middle click should continue to open the link in a new tab.
- // Suppressing the middle click here in the 'auxclick' handler (via e.preventDefault())
- // would break that behavior.
- suppressPasteOnLink = scheduler.setTimeout(() => { suppressPasteOnLink = null; }, 0);
- }
- });
-
- $(document.body).on('paste', (e) => {
- if (suppressPasteOnLink != null && (e.target.a || e.target.localName === 'a')) {
- scheduler.clearTimeout(suppressPasteOnLink);
- suppressPasteOnLink = null;
- e.preventDefault();
- return;
- }
-
- // Call paste hook
- hooks.callAll('acePaste', {
- editorInfo,
- rep,
- documentAttributeManager,
- e,
- });
- });
-
- // We reference document here, this is because if we don't this will expose a bug
- // in Google Chrome. This bug will cause the last character on the last line to
- // not fire an event when dropped into..
- $(document).on('drop', (e) => {
- if (e.target.a || e.target.localName === 'a') {
- e.preventDefault();
- }
-
- // Bug fix: when user drags some content and drop it far from its origin, we
- // need to merge the changes into a single changeset. So mark origin with empty ',
- wantHTML: 'empty
',
- wantText: 'empty\n\n',
- },
- 'indentedListsAreNotBullets': {
- description: 'Indented lists are represented with tabs and without bullets',
- input: '
indent
indent
',
- wantHTML: '
indent
indent
',
- wantText: '\tindent\n\tindent\n\n',
- },
- 'lineWithMultipleSpaces': {
- description: 'Multiple spaces should be collapsed',
- input: 'Text with more than one space. ',
- wantHTML: 'Text with more than one space.
',
- wantText: 'Text with more than one space.\n\n',
- },
- 'lineWithMultipleNonBreakingAndNormalSpaces': {
- // XXX the HTML between "than" and "one" looks strange
- description: 'non-breaking space should be preserved, but can be replaced when it',
- input: 'Text with more than one space. ',
- wantHTML: 'Text with more than one space.
',
- wantText: 'Text with more than one space.\n\n',
- },
- 'multiplenbsp': {
- description: 'Multiple non-breaking space should be preserved',
- input: ' ',
- wantHTML: '
',
- wantText: ' \n\n',
- },
- 'multipleNonBreakingSpaceBetweenWords': {
- description: 'A normal space is always inserted before a word',
- input: ' word1 word2 word3 ',
- wantHTML: ' word1 word2 word3
',
- wantText: ' word1 word2 word3\n\n',
- },
- 'nonBreakingSpacePreceededBySpaceBetweenWords': {
- description: 'A non-breaking space preceded by a normal space',
- input: ' word1 word2 word3 ',
- wantHTML: ' word1 word2 word3
',
- wantText: ' word1 word2 word3\n\n',
- },
- 'nonBreakingSpaceFollowededBySpaceBetweenWords': {
- description: 'A non-breaking space followed by a normal space',
- input: ' word1 word2 word3 ',
- wantHTML: ' word1 word2 word3
',
- wantText: 'something\n\n something\n\n',
- },
- 'collapseSpacesInsideElements': {
- description: 'Preserve only one space when multiple are present',
- input: 'Need more space s ! ',
- wantHTML: 'Need more space s !
',
- wantText: 'Need more space s !\n\n',
- },
- 'collapseSpacesAcrossNewlines': {
- description: 'Newlines and multiple spaces across newlines should be collapsed',
- input: `
+ 'malformed': {
+ input: '
',
+ wantText: '\t1. should be 1\n\t2. should be 2\n\n',
+ },
+ 'prefixcorrectlinenumbernested': {
+ input: '
should be 1
foo
should be 2
',
+ wantHTML: '
should be 1
foo
should be 2
',
+ wantText: '\t1. should be 1\n\t\t1.1. foo\n\t2. should be 2\n\n',
+ },
+ /*
+ "prefixcorrectlinenumber when introduced none list item - currently not supported see #3450": {
+ input: '
should be 1
test
should be 2
',
+ wantHTML: '
should be 1
test
should be 2
',
+ wantText: '\t1. should be 1\n\ttest\n\t2. should be 2\n\n',
+ }
+ ,
+ "newlinesshouldntresetlinenumber #2194": {
+ input: '
should be 1
test
should be 2
',
+ wantHTML: '
should be 1
test
should be 2
',
+ wantText: '\t1. should be 1\n\ttest\n\t2. should be 2\n\n',
+ }
+ */
+ 'ignoreAnyTagsOutsideBody': {
+ description: 'Content outside body should be ignored',
+ input: 'titleempty ',
+ wantHTML: 'empty
',
+ wantText: 'empty\n\n',
+ },
+ 'indentedListsAreNotBullets': {
+ description: 'Indented lists are represented with tabs and without bullets',
+ input: '
indent
indent
',
+ wantHTML: '
indent
indent
',
+ wantText: '\tindent\n\tindent\n\n',
+ },
+ 'lineWithMultipleSpaces': {
+ description: 'Multiple spaces should be collapsed',
+ input: 'Text with more than one space. ',
+ wantHTML: 'Text with more than one space.
',
+ wantText: 'Text with more than one space.\n\n',
+ },
+ 'lineWithMultipleNonBreakingAndNormalSpaces': {
+ // XXX the HTML between "than" and "one" looks strange
+ description: 'non-breaking space should be preserved, but can be replaced when it',
+ input: 'Text with more than one space. ',
+ wantHTML: 'Text with more than one space.
',
+ wantText: 'Text with more than one space.\n\n',
+ },
+ 'multiplenbsp': {
+ description: 'Multiple non-breaking space should be preserved',
+ input: ' ',
+ wantHTML: '
',
+ wantText: ' \n\n',
+ },
+ 'multipleNonBreakingSpaceBetweenWords': {
+ description: 'A normal space is always inserted before a word',
+ input: ' word1 word2 word3 ',
+ wantHTML: ' word1 word2 word3
',
+ wantText: ' word1 word2 word3\n\n',
+ },
+ 'nonBreakingSpacePreceededBySpaceBetweenWords': {
+ description: 'A non-breaking space preceded by a normal space',
+ input: ' word1 word2 word3 ',
+ wantHTML: ' word1 word2 word3
',
+ wantText: ' word1 word2 word3\n\n',
+ },
+ 'nonBreakingSpaceFollowededBySpaceBetweenWords': {
+ description: 'A non-breaking space followed by a normal space',
+ input: ' word1 word2 word3 ',
+ wantHTML: ' word1 word2 word3
',
+ wantText: 'something\n\n something\n\n',
+ },
+ 'collapseSpacesInsideElements': {
+ description: 'Preserve only one space when multiple are present',
+ input: 'Need more space s ! ',
+ wantHTML: 'Need more space s !
',
+ wantText: 'Need more space s !\n\n',
+ },
+ 'collapseSpacesAcrossNewlines': {
+ description: 'Newlines and multiple spaces across newlines should be collapsed',
+ input: `
Need
more
space
s
! `,
- wantHTML: 'Need more space s !
',
- wantText: 'Need more space s !\n\n',
- },
- 'multipleNewLinesAtBeginning': {
- description: 'Multiple new lines and paragraphs at the beginning should be preserved',
- input: '
first line
second line ',
- wantHTML: '
first line
second line
',
- wantText: '\n\n\n\nfirst line\n\nsecond line\n\n',
- },
- 'multiLineParagraph': {
- description: 'A paragraph with multiple lines should not loose spaces when lines are combined',
- input: `
+ wantHTML: 'Need more space s !
',
+ wantText: 'Need more space s !\n\n',
+ },
+ 'multipleNewLinesAtBeginning': {
+ description: 'Multiple new lines and paragraphs at the beginning should be preserved',
+ input: '
first line
second line ',
+ wantHTML: '
first line
second line
',
+ wantText: '\n\n\n\nfirst line\n\nsecond line\n\n',
+ },
+ 'multiLineParagraph': {
+ description: 'A paragraph with multiple lines should not loose spaces when lines are combined',
+ input: `
а б в г ґ д е є ж з и і ї й к л м н о
п р с т у ф х ц ч ш щ ю я ь
`,
- wantHTML: 'а б в г ґ д е є ж з и і ї й к л м н о п р с т у ф х ц ч ш щ ю я ь
',
- wantText: 'а б в г ґ д е є ж з и і ї й к л м н о п р с т у ф х ц ч ш щ ю я ь\n\n',
- },
- 'multiLineParagraphWithPre': {
- // XXX why is there before "in"?
- description: 'lines in preformatted text should be kept intact',
- input: `
+ wantHTML: 'а б в г ґ д е є ж з и і ї й к л м н о п р с т у ф х ц ч ш щ ю я ь
',
+ wantText: 'а б в г ґ д е є ж з и і ї й к л м н о п р с т у ф х ц ч ш щ ю я ь\n\n',
+ },
+ 'multiLineParagraphWithPre': {
+ // XXX why is there before "in"?
+ description: 'lines in preformatted text should be kept intact',
+ input: `
`,
- wantHTML: 'а б в г ґ д е є ж з и і ї й к л м н о multiple lines in pre
п р с т у ф х ц ч ш щ ю я ь
',
- wantText: 'а б в г ґ д е є ж з и і ї й к л м н о\nmultiple\n lines\n in\n pre\n\nп р с т у ф х ц ч ш щ ю я ь\n\n',
- },
- 'preIntroducesASpace': {
- description: 'pre should be on a new line not preceded by a space',
- input: `
+ wantHTML: '
а б в г ґ д е є ж з и і ї й к л м н о multiple lines in pre
п р с т у ф х ц ч ш щ ю я ь
',
+ wantText: 'а б в г ґ д е є ж з и і ї й к л м н о\nmultiple\n lines\n in\n pre\n\nп р с т у ф х ц ч ш щ ю я ь\n\n',
+ },
+ 'preIntroducesASpace': {
+ description: 'pre should be on a new line not preceded by a space',
+ input: `
1
preline
`,
- wantHTML: '1 preline
',
- wantText: '1\npreline\n\n\n',
- },
- 'dontDeleteSpaceInsideElements': {
- description: 'Preserve spaces inside elements',
- input: 'Need more space s ! ',
- wantHTML: 'Need more space s !
',
- wantText: 'Need more space s !\n\n',
- },
- 'dontDeleteSpaceOutsideElements': {
- description: 'Preserve spaces outside elements',
- input: 'Need more space s ! ',
- wantHTML: 'Need more space s !
',
- wantText: 'Need more space s !\n\n',
- },
- 'dontDeleteSpaceAtEndOfElement': {
- description: 'Preserve spaces at the end of an element',
- input: 'Need more space s ! ',
- wantHTML: 'Need more space s !
',
- wantText: 'Need more space s !\n\n',
- },
- 'dontDeleteSpaceAtBeginOfElements': {
- description: 'Preserve spaces at the start of an element',
- input: 'Need more space s ! ',
- wantHTML: 'Need more space s !
',
- wantText: 'Need more space s !\n\n',
- },
+ wantHTML: '1 preline
',
+ wantText: '1\npreline\n\n\n',
+ },
+ 'dontDeleteSpaceInsideElements': {
+ description: 'Preserve spaces inside elements',
+ input: 'Need more space s ! ',
+ wantHTML: 'Need more space s !
',
+ wantText: 'Need more space s !\n\n',
+ },
+ 'dontDeleteSpaceOutsideElements': {
+ description: 'Preserve spaces outside elements',
+ input: 'Need more space s ! ',
+ wantHTML: 'Need more space s !
',
+ wantText: 'Need more space s !\n\n',
+ },
+ 'dontDeleteSpaceAtEndOfElement': {
+ description: 'Preserve spaces at the end of an element',
+ input: 'Need more space s ! ',
+ wantHTML: 'Need more space s !
',
+ wantText: 'Need more space s !\n\n',
+ },
+ 'dontDeleteSpaceAtBeginOfElements': {
+ description: 'Preserve spaces at the start of an element',
+ input: 'Need more space s ! ',
+ wantHTML: 'Need more space s !
',
+ wantText: 'Need more space s !\n\n',
+ },
};
-
describe(__filename, function () {
- this.timeout(1000);
-
- before(async function () { agent = await common.init(); });
-
- Object.keys(testImports).forEach((testName) => {
- describe(testName, function () {
- const testPadId = makeid();
- const test = testImports[testName];
- if (test.disabled) {
- return xit(`DISABLED: ${testName}`, function (done) {
- done();
+ this.timeout(1000);
+ before(async function () { agent = await common.init(); });
+ Object.keys(testImports).forEach((testName) => {
+ describe(testName, function () {
+ const testPadId = makeid();
+ const test = testImports[testName];
+ if (test.disabled) {
+ return xit(`DISABLED: ${testName}`, function (done) {
+ done();
+ });
+ }
+ it('createPad', async function () {
+ const res = await agent.get(`${endPoint('createPad')}&padID=${testPadId}`)
+ .expect(200)
+ .expect('Content-Type', /json/);
+ assert.equal(res.body.code, 0);
+ });
+ it('setHTML', async function () {
+ const res = await agent.get(`${endPoint('setHTML')}&padID=${testPadId}` +
+ `&html=${encodeURIComponent(test.input)}`)
+ .expect(200)
+ .expect('Content-Type', /json/);
+ assert.equal(res.body.code, 0);
+ });
+ it('getHTML', async function () {
+ const res = await agent.get(`${endPoint('getHTML')}&padID=${testPadId}`)
+ .expect(200)
+ .expect('Content-Type', /json/);
+ assert.equal(res.body.data.html, test.wantHTML);
+ });
+ it('getText', async function () {
+ const res = await agent.get(`${endPoint('getText')}&padID=${testPadId}`)
+ .expect(200)
+ .expect('Content-Type', /json/);
+ assert.equal(res.body.data.text, test.wantText);
+ });
});
- }
-
- it('createPad', async function () {
- const res = await agent.get(`${endPoint('createPad')}&padID=${testPadId}`)
- .expect(200)
- .expect('Content-Type', /json/);
- assert.equal(res.body.code, 0);
- });
-
- it('setHTML', async function () {
- const res = await agent.get(`${endPoint('setHTML')}&padID=${testPadId}` +
- `&html=${encodeURIComponent(test.input)}`)
- .expect(200)
- .expect('Content-Type', /json/);
- assert.equal(res.body.code, 0);
- });
-
- it('getHTML', async function () {
- const res = await agent.get(`${endPoint('getHTML')}&padID=${testPadId}`)
- .expect(200)
- .expect('Content-Type', /json/);
- assert.equal(res.body.data.html, test.wantHTML);
- });
-
- it('getText', async function () {
- const res = await agent.get(`${endPoint('getText')}&padID=${testPadId}`)
- .expect(200)
- .expect('Content-Type', /json/);
- assert.equal(res.body.data.text, test.wantText);
- });
});
- });
});
-
function makeid() {
- let text = '';
- const possible = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
-
- for (let i = 0; i < 5; i++) {
- text += possible.charAt(Math.floor(Math.random() * possible.length));
- }
- return text;
+ let text = '';
+ const possible = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
+ for (let i = 0; i < 5; i++) {
+ text += possible.charAt(Math.floor(Math.random() * possible.length));
+ }
+ return text;
}
diff --git a/src/tests/backend/specs/caching_middleware.js b/src/tests/backend/specs/caching_middleware.js
index ebfd65d9ff0..ca2377d9540 100644
--- a/src/tests/backend/specs/caching_middleware.js
+++ b/src/tests/backend/specs/caching_middleware.js
@@ -1,18 +1,10 @@
+import * as common from "../common.js";
+import assertLegacy from "../assert-legacy.js";
+import queryString from "querystring";
+import * as settings from "../../../node/utils/Settings.js";
'use strict';
-
-/**
- * caching_middleware is responsible for serving everything under path `/javascripts/`
- * That includes packages as defined in `src/node/utils/tar.json` and probably also plugin code
- *
- */
-
-const common = require('../common');
-const assert = require('../assert-legacy').strict;
-const queryString = require('querystring');
-const settings = require('../../../node/utils/Settings');
-
+const assert = assertLegacy.strict;
let agent;
-
/**
* Hack! Returns true if the resource is not plaintext
* The file should start with the callback method, so we need the
@@ -23,95 +15,87 @@ let agent;
* @returns {boolean} if it is plaintext
*/
const isPlaintextResponse = (fileContent, resource) => {
- // callback=require.define&v=1234
- const query = (new URL(resource, 'http://localhost')).search.slice(1);
- // require.define
- const jsonp = queryString.parse(query).callback;
-
- // returns true if the first letters in fileContent equal the content of `jsonp`
- return fileContent.substring(0, jsonp.length) === jsonp;
+ // callback=require.define&v=1234
+ const query = (new URL(resource, 'http://localhost')).search.slice(1);
+ // require.define
+ const jsonp = queryString.parse(query).callback;
+ // returns true if the first letters in fileContent equal the content of `jsonp`
+ return fileContent.substring(0, jsonp.length) === jsonp;
};
-
/**
* A hack to disable `superagent`'s auto unzip functionality
*
* @param {Request} request
*/
const disableAutoDeflate = (request) => {
- request._shouldUnzip = () => false;
+ request._shouldUnzip = () => false;
};
-
describe(__filename, function () {
- const backups = {};
- const fantasyEncoding = 'brainwaves'; // non-working encoding until https://github.com/visionmedia/superagent/pull/1560 is resolved
- const packages = [
- '/javascripts/lib/ep_etherpad-lite/static/js/ace2_common.js?callback=require.define',
- '/javascripts/lib/ep_etherpad-lite/static/js/ace2_inner.js?callback=require.define',
- '/javascripts/lib/ep_etherpad-lite/static/js/pad.js?callback=require.define',
- '/javascripts/lib/ep_etherpad-lite/static/js/timeslider.js?callback=require.define',
- ];
-
- before(async function () {
- agent = await common.init();
- backups.settings = {};
- backups.settings.minify = settings.minify;
- });
- after(async function () {
- Object.assign(settings, backups.settings);
- });
-
- for (const minify of [false, true]) {
- context(`when minify is ${minify}`, function () {
- before(async function () {
- settings.minify = minify;
- });
-
- describe('gets packages uncompressed without Accept-Encoding gzip', function () {
- for (const resource of packages) {
- it(resource, async function () {
- await agent.get(resource)
- .set('Accept-Encoding', fantasyEncoding)
- .use(disableAutoDeflate)
- .expect(200)
- .expect('Content-Type', /application\/javascript/)
- .expect((res) => {
- assert.equal(res.header['content-encoding'], undefined);
- assert(isPlaintextResponse(res.text, resource));
- });
- });
- }
- });
-
- describe('gets packages compressed with Accept-Encoding gzip', function () {
- for (const resource of packages) {
- it(resource, async function () {
- await agent.get(resource)
- .set('Accept-Encoding', 'gzip')
- .use(disableAutoDeflate)
- .expect(200)
- .expect('Content-Type', /application\/javascript/)
- .expect('Content-Encoding', 'gzip')
- .expect((res) => {
- assert(!isPlaintextResponse(res.text, resource));
- });
- });
- }
- });
-
- it('does not cache content-encoding headers', async function () {
- await agent.get(packages[0])
- .set('Accept-Encoding', fantasyEncoding)
- .expect(200)
- .expect((res) => assert.equal(res.header['content-encoding'], undefined));
- await agent.get(packages[0])
- .set('Accept-Encoding', 'gzip')
- .expect(200)
- .expect('Content-Encoding', 'gzip');
- await agent.get(packages[0])
- .set('Accept-Encoding', fantasyEncoding)
- .expect(200)
- .expect((res) => assert.equal(res.header['content-encoding'], undefined));
- });
+ const backups = {};
+ const fantasyEncoding = 'brainwaves'; // non-working encoding until https://github.com/visionmedia/superagent/pull/1560 is resolved
+ const packages = [
+ '/javascripts/lib/ep_etherpad-lite/static/js/ace2_common.js?callback=require.define',
+ '/javascripts/lib/ep_etherpad-lite/static/js/ace2_inner.js?callback=require.define',
+ '/javascripts/lib/ep_etherpad-lite/static/js/pad.js?callback=require.define',
+ '/javascripts/lib/ep_etherpad-lite/static/js/timeslider.js?callback=require.define',
+ ];
+ before(async function () {
+ agent = await common.init();
+ backups.settings = {};
+ backups.settings.minify = settings.minify;
+ });
+ after(async function () {
+ Object.assign(settings, backups.settings);
});
- }
+ for (const minify of [false, true]) {
+ context(`when minify is ${minify}`, function () {
+ before(async function () {
+ settings.minify = minify;
+ });
+ describe('gets packages uncompressed without Accept-Encoding gzip', function () {
+ for (const resource of packages) {
+ it(resource, async function () {
+ await agent.get(resource)
+ .set('Accept-Encoding', fantasyEncoding)
+ .use(disableAutoDeflate)
+ .expect(200)
+ .expect('Content-Type', /application\/javascript/)
+ .expect((res) => {
+ assert.equal(res.header['content-encoding'], undefined);
+ assert(isPlaintextResponse(res.text, resource));
+ });
+ });
+ }
+ });
+ describe('gets packages compressed with Accept-Encoding gzip', function () {
+ for (const resource of packages) {
+ it(resource, async function () {
+ await agent.get(resource)
+ .set('Accept-Encoding', 'gzip')
+ .use(disableAutoDeflate)
+ .expect(200)
+ .expect('Content-Type', /application\/javascript/)
+ .expect('Content-Encoding', 'gzip')
+ .expect((res) => {
+ assert(!isPlaintextResponse(res.text, resource));
+ });
+ });
+ }
+ });
+ it('does not cache content-encoding headers', async function () {
+ await agent.get(packages[0])
+ .set('Accept-Encoding', fantasyEncoding)
+ .expect(200)
+ .expect((res) => assert.equal(res.header['content-encoding'], undefined));
+ await agent.get(packages[0])
+ .set('Accept-Encoding', 'gzip')
+ .expect(200)
+ .expect('Content-Encoding', 'gzip');
+ await agent.get(packages[0])
+ .set('Accept-Encoding', fantasyEncoding)
+ .expect(200)
+ .expect((res) => assert.equal(res.header['content-encoding'], undefined));
+ });
+ });
+ }
});
diff --git a/src/tests/backend/specs/chat.js b/src/tests/backend/specs/chat.js
index aefa64183f6..1bf0c1114cb 100644
--- a/src/tests/backend/specs/chat.js
+++ b/src/tests/backend/specs/chat.js
@@ -1,160 +1,153 @@
+import ChatMessage from "../../../static/js/ChatMessage.js";
+import { Pad } from "../../../node/db/Pad.js";
+import assert$0 from "assert";
+import * as common from "../common.js";
+import * as padManager from "../../../node/db/PadManager.js";
+import * as pluginDefs from "../../../static/js/pluginfw/plugin_defs.js";
'use strict';
-
-const ChatMessage = require('../../../static/js/ChatMessage');
-const {Pad} = require('../../../node/db/Pad');
-const assert = require('assert').strict;
-const common = require('../common');
-const padManager = require('../../../node/db/PadManager');
-const pluginDefs = require('../../../static/js/pluginfw/plugin_defs');
-
+const assert = assert$0.strict;
const logger = common.logger;
-
const checkHook = async (hookName, checkFn) => {
- if (pluginDefs.hooks[hookName] == null) pluginDefs.hooks[hookName] = [];
- await new Promise((resolve, reject) => {
- pluginDefs.hooks[hookName].push({
- hook_fn: async (hookName, context) => {
- if (checkFn == null) return;
- logger.debug(`hook ${hookName} invoked`);
- try {
- // Make sure checkFn is called only once.
- const _checkFn = checkFn;
- checkFn = null;
- await _checkFn(context);
- } catch (err) {
- reject(err);
- return;
- }
- resolve();
- },
+ if (pluginDefs.hooks[hookName] == null)
+ pluginDefs.hooks[hookName] = [];
+ await new Promise((resolve, reject) => {
+ pluginDefs.hooks[hookName].push({
+ hook_fn: async (hookName, context) => {
+ if (checkFn == null)
+ return;
+ logger.debug(`hook ${hookName} invoked`);
+ try {
+ // Make sure checkFn is called only once.
+ const _checkFn = checkFn;
+ checkFn = null;
+ await _checkFn(context);
+ }
+ catch (err) {
+ reject(err);
+ return;
+ }
+ resolve();
+ },
+ });
});
- });
};
-
const sendMessage = (socket, data) => {
- socket.send({
- type: 'COLLABROOM',
- component: 'pad',
- data,
- });
+ socket.send({
+ type: 'COLLABROOM',
+ component: 'pad',
+ data,
+ });
};
-
-const sendChat = (socket, message) => sendMessage(socket, {type: 'CHAT_MESSAGE', message});
-
+const sendChat = (socket, message) => sendMessage(socket, { type: 'CHAT_MESSAGE', message });
describe(__filename, function () {
- const padId = 'testChatPad';
- const hooksBackup = {};
-
- before(async function () {
- for (const [name, defs] of Object.entries(pluginDefs.hooks)) {
- if (defs == null) continue;
- hooksBackup[name] = defs;
- }
- });
-
- beforeEach(async function () {
- for (const [name, defs] of Object.entries(hooksBackup)) pluginDefs.hooks[name] = [...defs];
- for (const name of Object.keys(pluginDefs.hooks)) {
- if (hooksBackup[name] == null) delete pluginDefs.hooks[name];
- }
- if (await padManager.doesPadExist(padId)) {
- const pad = await padManager.getPad(padId);
- await pad.remove();
- }
- });
-
- after(async function () {
- Object.assign(pluginDefs.hooks, hooksBackup);
- for (const name of Object.keys(pluginDefs.hooks)) {
- if (hooksBackup[name] == null) delete pluginDefs.hooks[name];
- }
- });
-
- describe('chatNewMessage hook', function () {
- let authorId;
- let socket;
-
- beforeEach(async function () {
- socket = await common.connect();
- const {data: clientVars} = await common.handshake(socket, padId);
- authorId = clientVars.userId;
- });
-
- afterEach(async function () {
- socket.close();
- });
-
- it('message', async function () {
- const start = Date.now();
- await Promise.all([
- checkHook('chatNewMessage', ({message}) => {
- assert(message != null);
- assert(message instanceof ChatMessage);
- assert.equal(message.authorId, authorId);
- assert.equal(message.text, this.test.title);
- assert(message.time >= start);
- assert(message.time <= Date.now());
- }),
- sendChat(socket, {text: this.test.title}),
- ]);
+ const padId = 'testChatPad';
+ const hooksBackup = {};
+ before(async function () {
+ for (const [name, defs] of Object.entries(pluginDefs.hooks)) {
+ if (defs == null)
+ continue;
+ hooksBackup[name] = defs;
+ }
});
-
- it('pad', async function () {
- await Promise.all([
- checkHook('chatNewMessage', ({pad}) => {
- assert(pad != null);
- assert(pad instanceof Pad);
- assert.equal(pad.id, padId);
- }),
- sendChat(socket, {text: this.test.title}),
- ]);
+ beforeEach(async function () {
+ for (const [name, defs] of Object.entries(hooksBackup))
+ pluginDefs.hooks[name] = [...defs];
+ for (const name of Object.keys(pluginDefs.hooks)) {
+ if (hooksBackup[name] == null)
+ delete pluginDefs.hooks[name];
+ }
+ if (await padManager.doesPadExist(padId)) {
+ const pad = await padManager.getPad(padId);
+ await pad.remove();
+ }
});
-
- it('padId', async function () {
- await Promise.all([
- checkHook('chatNewMessage', (context) => {
- assert.equal(context.padId, padId);
- }),
- sendChat(socket, {text: this.test.title}),
- ]);
+ after(async function () {
+ Object.assign(pluginDefs.hooks, hooksBackup);
+ for (const name of Object.keys(pluginDefs.hooks)) {
+ if (hooksBackup[name] == null)
+ delete pluginDefs.hooks[name];
+ }
});
-
- it('mutations propagate', async function () {
- const listen = async (type) => await new Promise((resolve) => {
- const handler = (msg) => {
- if (msg.type !== 'COLLABROOM') return;
- if (msg.data == null || msg.data.type !== type) return;
- resolve(msg.data);
- socket.off('message', handler);
- };
- socket.on('message', handler);
- });
-
- const modifiedText = `${this.test.title} `;
- const customMetadata = {foo: this.test.title};
- await Promise.all([
- checkHook('chatNewMessage', ({message}) => {
- message.text = modifiedText;
- message.customMetadata = customMetadata;
- }),
- (async () => {
- const {message} = await listen('CHAT_MESSAGE');
- assert(message != null);
- assert.equal(message.text, modifiedText);
- assert.deepEqual(message.customMetadata, customMetadata);
- })(),
- sendChat(socket, {text: this.test.title}),
- ]);
- // Simulate fetch of historical chat messages when a pad is first loaded.
- await Promise.all([
- (async () => {
- const {messages: [message]} = await listen('CHAT_MESSAGES');
- assert(message != null);
- assert.equal(message.text, modifiedText);
- assert.deepEqual(message.customMetadata, customMetadata);
- })(),
- sendMessage(socket, {type: 'GET_CHAT_MESSAGES', start: 0, end: 0}),
- ]);
+ describe('chatNewMessage hook', function () {
+ let authorId;
+ let socket;
+ beforeEach(async function () {
+ socket = await common.connect();
+ const { data: clientVars } = await common.handshake(socket, padId);
+ authorId = clientVars.userId;
+ });
+ afterEach(async function () {
+ socket.close();
+ });
+ it('message', async function () {
+ const start = Date.now();
+ await Promise.all([
+ checkHook('chatNewMessage', ({ message }) => {
+ assert(message != null);
+ assert(message instanceof ChatMessage);
+ assert.equal(message.authorId, authorId);
+ assert.equal(message.text, this.test.title);
+ assert(message.time >= start);
+ assert(message.time <= Date.now());
+ }),
+ sendChat(socket, { text: this.test.title }),
+ ]);
+ });
+ it('pad', async function () {
+ await Promise.all([
+ checkHook('chatNewMessage', ({ pad }) => {
+ assert(pad != null);
+ assert(pad instanceof Pad);
+ assert.equal(pad.id, padId);
+ }),
+ sendChat(socket, { text: this.test.title }),
+ ]);
+ });
+ it('padId', async function () {
+ await Promise.all([
+ checkHook('chatNewMessage', (context) => {
+ assert.equal(context.padId, padId);
+ }),
+ sendChat(socket, { text: this.test.title }),
+ ]);
+ });
+ it('mutations propagate', async function () {
+ const listen = async (type) => await new Promise((resolve) => {
+ const handler = (msg) => {
+ if (msg.type !== 'COLLABROOM')
+ return;
+ if (msg.data == null || msg.data.type !== type)
+ return;
+ resolve(msg.data);
+ socket.off('message', handler);
+ };
+ socket.on('message', handler);
+ });
+ const modifiedText = `${this.test.title} `;
+ const customMetadata = { foo: this.test.title };
+ await Promise.all([
+ checkHook('chatNewMessage', ({ message }) => {
+ message.text = modifiedText;
+ message.customMetadata = customMetadata;
+ }),
+ (async () => {
+ const { message } = await listen('CHAT_MESSAGE');
+ assert(message != null);
+ assert.equal(message.text, modifiedText);
+ assert.deepEqual(message.customMetadata, customMetadata);
+ })(),
+ sendChat(socket, { text: this.test.title }),
+ ]);
+ // Simulate fetch of historical chat messages when a pad is first loaded.
+ await Promise.all([
+ (async () => {
+ const { messages: [message] } = await listen('CHAT_MESSAGES');
+ assert(message != null);
+ assert.equal(message.text, modifiedText);
+ assert.deepEqual(message.customMetadata, customMetadata);
+ })(),
+ sendMessage(socket, { type: 'GET_CHAT_MESSAGES', start: 0, end: 0 }),
+ ]);
+ });
});
- });
});
diff --git a/src/tests/backend/specs/contentcollector.js b/src/tests/backend/specs/contentcollector.js
index a4696307edf..5e4ad92d946 100644
--- a/src/tests/backend/specs/contentcollector.js
+++ b/src/tests/backend/specs/contentcollector.js
@@ -1,284 +1,273 @@
+import AttributePool from "../../../static/js/AttributePool.js";
+import * as Changeset from "../../../static/js/Changeset.js";
+import assert$0 from "assert";
+import * as attributes from "../../../static/js/attributes.js";
+import * as contentcollector from "../../../static/js/contentcollector.js";
+import * as jsdom from "jsdom";
'use strict';
-
-/*
- * While importexport tests target the `setHTML` API endpoint, which is nearly identical to what
- * happens when a user manually imports a document via the UI, the contentcollector tests here don't
- * use rehype to process the document. Rehype removes spaces and newĺines were applicable, so the
- * expected results here can differ from importexport.js.
- *
- * If you add tests here, please also add them to importexport.js
- */
-
-const AttributePool = require('../../../static/js/AttributePool');
-const Changeset = require('../../../static/js/Changeset');
-const assert = require('assert').strict;
-const attributes = require('../../../static/js/attributes');
-const contentcollector = require('../../../static/js/contentcollector');
-const jsdom = require('jsdom');
-
+const assert = assert$0.strict;
// All test case `wantAlines` values must only refer to attributes in this list so that the
// attribute numbers do not change due to changes in pool insertion order.
const knownAttribs = [
- ['insertorder', 'first'],
- ['italic', 'true'],
- ['list', 'bullet1'],
- ['list', 'bullet2'],
- ['list', 'number1'],
- ['list', 'number2'],
- ['lmkr', '1'],
- ['start', '1'],
- ['start', '2'],
+ ['insertorder', 'first'],
+ ['italic', 'true'],
+ ['list', 'bullet1'],
+ ['list', 'bullet2'],
+ ['list', 'number1'],
+ ['list', 'number2'],
+ ['lmkr', '1'],
+ ['start', '1'],
+ ['start', '2'],
];
-
const testCases = [
- {
- description: 'Simple',
- html: '
',
- wantAlines: [
- '*0*2*6+1+1',
- '*0*3*6+1+1',
- '*0*2*6+1+1',
- '+3',
- ],
- wantText: ['*a', '*b', '*a', 'foo'],
- },
- {
- description: 'Tests if ols properly get line numbers when in a normal OL',
- html: '
a
b
c
test
',
- wantAlines: [
- '*0*4*6*7+1+1',
- '*0*4*6*7+1+1',
- '*0*4*6*7+1+1',
- '+4',
- ],
- wantText: ['*a', '*b', '*c', 'test'],
- noteToSelf: 'Ensure empty P does not induce line attribute marker, wont this break the editor?',
- },
- {
- description: 'A single completely empty line break within an ol should reset count if OL is closed off..',
- html: '
should be 1
hello
should be 1
should be 2
',
- wantAlines: [
- '*0*4*6*7+1+b',
- '+5',
- '*0*4*6*8+1+b',
- '*0*4*6*8+1+b',
- '',
- ],
- wantText: ['*should be 1', 'hello', '*should be 1', '*should be 2', ''],
- noteToSelf: "Shouldn't include attribute marker in the
line",
- },
- {
- description: 'A single
should create a new line',
- html: '',
- wantAlines: ['', ''],
- wantText: ['', ''],
- noteToSelf: 'should create a line break but not break numbering',
- },
- {
- description: 'Tests if ols properly get line numbers when in a normal OL #2',
- html: 'a
b
c
notlist
foo
',
- wantAlines: [
- '+1',
- '*0*4*6*7+1+1',
- '*0*5*6*8+1+1',
- '+7',
- '+3',
- ],
- wantText: ['a', '*b', '*c', 'notlist', 'foo'],
- noteToSelf: 'Ensure empty P does not induce line attribute marker, wont this break the editor?',
- },
- {
- description: 'First item being an UL then subsequent being OL will fail',
- html: '
a
b
c
',
- wantAlines: ['+1', '*0*1*2*3+1+1', '*0*4*2*5+1+1'],
- wantText: ['a', '*b', '*c'],
- noteToSelf: 'Ensure empty P does not induce line attribute marker, wont this break the editor?',
- disabled: true,
- },
- {
- description: 'A single completely empty line break within an ol should NOT reset count',
- html: '
should be 1
should be 2
should be 3
',
- wantAlines: [],
- wantText: ['*should be 1', '*should be 2', '*should be 3'],
- noteToSelf: "should create a line break but not break numbering -- This is what I can't get working!",
- disabled: true,
- },
- {
- description: 'Content outside body should be ignored',
- html: 'titleempty ',
- wantAlines: ['+5'],
- wantText: ['empty'],
- },
- {
- description: 'Multiple spaces should be preserved',
- html: 'Text with more than one space. ',
- wantAlines: ['+10'],
- wantText: ['Text with more than one space.'],
- },
- {
- description: 'non-breaking and normal space should be preserved',
- html: 'Text with more than one space. ',
- wantAlines: ['+10'],
- wantText: ['Text with more than one space.'],
- },
- {
- description: 'Multiple nbsp should be preserved',
- html: ' ',
- wantAlines: ['+2'],
- wantText: [' '],
- },
- {
- description: 'Multiple nbsp between words ',
- html: ' word1 word2 word3 ',
- wantAlines: ['+m'],
- wantText: [' word1 word2 word3'],
- },
- {
- description: 'A non-breaking space preceded by a normal space',
- html: ' word1 word2 word3 ',
- wantAlines: ['+l'],
- wantText: [' word1 word2 word3'],
- },
- {
- description: 'A non-breaking space followed by a normal space',
- html: ' word1 word2 word3 ',
- wantAlines: ['+l'],
- wantText: [' word1 word2 word3'],
- },
- {
- description: 'Don\'t collapse spaces that follow a newline',
- html: 'something something ',
- wantAlines: ['+9', '+m'],
- wantText: ['something', ' something'],
- },
- {
- description: 'Don\'t collapse spaces that follow a empty paragraph',
- html: 'something something ',
- wantAlines: ['+9', '', '+m'],
- wantText: ['something', '', ' something'],
- },
- {
- description: 'Don\'t collapse spaces that preceed/follow a newline',
- html: 'something something ',
- wantAlines: ['+l', '+m'],
- wantText: ['something ', ' something'],
- },
- {
- description: 'Don\'t collapse spaces that preceed/follow a empty paragraph',
- html: 'something something ',
- wantAlines: ['+l', '', '+m'],
- wantText: ['something ', '', ' something'],
- },
- {
- description: 'Don\'t collapse non-breaking spaces that follow a newline',
- html: 'something something ',
- wantAlines: ['+9', '+c'],
- wantText: ['something', ' something'],
- },
- {
- description: 'Don\'t collapse non-breaking spaces that follow a paragraph',
- html: 'something something ',
- wantAlines: ['+9', '', '+c'],
- wantText: ['something', '', ' something'],
- },
- {
- description: 'Preserve all spaces when multiple are present',
- html: 'Need more space s ! ',
- wantAlines: ['+h*1+4+2'],
- wantText: ['Need more space s !'],
- },
- {
- description: 'Newlines and multiple spaces across newlines should be preserved',
- html: `
+ {
+ description: 'Simple',
+ html: '
',
+ wantAlines: [
+ '*0*2*6+1+1',
+ '*0*3*6+1+1',
+ '*0*2*6+1+1',
+ '+3',
+ ],
+ wantText: ['*a', '*b', '*a', 'foo'],
+ },
+ {
+ description: 'Tests if ols properly get line numbers when in a normal OL',
+ html: '
a
b
c
test
',
+ wantAlines: [
+ '*0*4*6*7+1+1',
+ '*0*4*6*7+1+1',
+ '*0*4*6*7+1+1',
+ '+4',
+ ],
+ wantText: ['*a', '*b', '*c', 'test'],
+ noteToSelf: 'Ensure empty P does not induce line attribute marker, wont this break the editor?',
+ },
+ {
+ description: 'A single completely empty line break within an ol should reset count if OL is closed off..',
+ html: '
should be 1
hello
should be 1
should be 2
',
+ wantAlines: [
+ '*0*4*6*7+1+b',
+ '+5',
+ '*0*4*6*8+1+b',
+ '*0*4*6*8+1+b',
+ '',
+ ],
+ wantText: ['*should be 1', 'hello', '*should be 1', '*should be 2', ''],
+ noteToSelf: "Shouldn't include attribute marker in the
line",
+ },
+ {
+ description: 'A single
should create a new line',
+ html: '',
+ wantAlines: ['', ''],
+ wantText: ['', ''],
+ noteToSelf: 'should create a line break but not break numbering',
+ },
+ {
+ description: 'Tests if ols properly get line numbers when in a normal OL #2',
+ html: 'a
b
c
notlist
foo
',
+ wantAlines: [
+ '+1',
+ '*0*4*6*7+1+1',
+ '*0*5*6*8+1+1',
+ '+7',
+ '+3',
+ ],
+ wantText: ['a', '*b', '*c', 'notlist', 'foo'],
+ noteToSelf: 'Ensure empty P does not induce line attribute marker, wont this break the editor?',
+ },
+ {
+ description: 'First item being an UL then subsequent being OL will fail',
+ html: '
a
b
c
',
+ wantAlines: ['+1', '*0*1*2*3+1+1', '*0*4*2*5+1+1'],
+ wantText: ['a', '*b', '*c'],
+ noteToSelf: 'Ensure empty P does not induce line attribute marker, wont this break the editor?',
+ disabled: true,
+ },
+ {
+ description: 'A single completely empty line break within an ol should NOT reset count',
+ html: '
should be 1
should be 2
should be 3
',
+ wantAlines: [],
+ wantText: ['*should be 1', '*should be 2', '*should be 3'],
+ noteToSelf: "should create a line break but not break numbering -- This is what I can't get working!",
+ disabled: true,
+ },
+ {
+ description: 'Content outside body should be ignored',
+ html: 'titleempty ',
+ wantAlines: ['+5'],
+ wantText: ['empty'],
+ },
+ {
+ description: 'Multiple spaces should be preserved',
+ html: 'Text with more than one space. ',
+ wantAlines: ['+10'],
+ wantText: ['Text with more than one space.'],
+ },
+ {
+ description: 'non-breaking and normal space should be preserved',
+ html: 'Text with more than one space. ',
+ wantAlines: ['+10'],
+ wantText: ['Text with more than one space.'],
+ },
+ {
+ description: 'Multiple nbsp should be preserved',
+ html: ' ',
+ wantAlines: ['+2'],
+ wantText: [' '],
+ },
+ {
+ description: 'Multiple nbsp between words ',
+ html: ' word1 word2 word3 ',
+ wantAlines: ['+m'],
+ wantText: [' word1 word2 word3'],
+ },
+ {
+ description: 'A non-breaking space preceded by a normal space',
+ html: ' word1 word2 word3 ',
+ wantAlines: ['+l'],
+ wantText: [' word1 word2 word3'],
+ },
+ {
+ description: 'A non-breaking space followed by a normal space',
+ html: ' word1 word2 word3 ',
+ wantAlines: ['+l'],
+ wantText: [' word1 word2 word3'],
+ },
+ {
+ description: 'Don\'t collapse spaces that follow a newline',
+ html: 'something something ',
+ wantAlines: ['+9', '+m'],
+ wantText: ['something', ' something'],
+ },
+ {
+ description: 'Don\'t collapse spaces that follow a empty paragraph',
+ html: 'something something ',
+ wantAlines: ['+9', '', '+m'],
+ wantText: ['something', '', ' something'],
+ },
+ {
+ description: 'Don\'t collapse spaces that preceed/follow a newline',
+ html: 'something something ',
+ wantAlines: ['+l', '+m'],
+ wantText: ['something ', ' something'],
+ },
+ {
+ description: 'Don\'t collapse spaces that preceed/follow a empty paragraph',
+ html: 'something something ',
+ wantAlines: ['+l', '', '+m'],
+ wantText: ['something ', '', ' something'],
+ },
+ {
+ description: 'Don\'t collapse non-breaking spaces that follow a newline',
+ html: 'something something ',
+ wantAlines: ['+9', '+c'],
+ wantText: ['something', ' something'],
+ },
+ {
+ description: 'Don\'t collapse non-breaking spaces that follow a paragraph',
+ html: 'something something ',
+ wantAlines: ['+9', '', '+c'],
+ wantText: ['something', '', ' something'],
+ },
+ {
+ description: 'Preserve all spaces when multiple are present',
+ html: 'Need more space s ! ',
+ wantAlines: ['+h*1+4+2'],
+ wantText: ['Need more space s !'],
+ },
+ {
+ description: 'Newlines and multiple spaces across newlines should be preserved',
+ html: `
Need
more
space
s
! `,
- wantAlines: ['+19*1+4+b'],
- wantText: ['Need more space s !'],
- },
- {
- description: 'Multiple new lines at the beginning should be preserved',
- html: '
first line
second line ',
- wantAlines: ['', '', '', '', '+a', '', '+b'],
- wantText: ['', '', '', '', 'first line', '', 'second line'],
- },
- {
- description: 'A paragraph with multiple lines should not loose spaces when lines are combined',
- html: `
+ wantAlines: ['+19*1+4+b'],
+ wantText: ['Need more space s !'],
+ },
+ {
+ description: 'Multiple new lines at the beginning should be preserved',
+ html: '
first line
second line ',
+ wantAlines: ['', '', '', '', '+a', '', '+b'],
+ wantText: ['', '', '', '', 'first line', '', 'second line'],
+ },
+ {
+ description: 'A paragraph with multiple lines should not loose spaces when lines are combined',
+ html: `
а б в г ґ д е є ж з и і ї й к л м н о
п р с т у ф х ц ч ш щ ю я ь
`,
- wantAlines: ['+1t'],
- wantText: ['а б в г ґ д е є ж з и і ї й к л м н о п р с т у ф х ц ч ш щ ю я ь'],
- },
- {
- description: 'lines in preformatted text should be kept intact',
- html: `
+ wantAlines: ['+1t'],
+ wantText: ['а б в г ґ д е є ж з и і ї й к л м н о п р с т у ф х ц ч ш щ ю я ь'],
+ },
+ {
+ description: 'lines in preformatted text should be kept intact',
+ html: `
а б в г ґ д е є ж з и і ї й к л м н о
multiple
lines
in
@@ -286,101 +275,98 @@ pre
п р с т у ф х ц ч ш щ ю я
ь
`,
- wantAlines: ['+11', '+8', '+5', '+2', '+3', '+r'],
- wantText: [
- 'а б в г ґ д е є ж з и і ї й к л м н о',
- 'multiple',
- 'lines',
- 'in',
- 'pre',
- 'п р с т у ф х ц ч ш щ ю я ь',
- ],
- },
- {
- description: 'pre should be on a new line not preceded by a space',
- html: `
+ wantAlines: ['+11', '+8', '+5', '+2', '+3', '+r'],
+ wantText: [
+ 'а б в г ґ д е є ж з и і ї й к л м н о',
+ 'multiple',
+ 'lines',
+ 'in',
+ 'pre',
+ 'п р с т у ф х ц ч ш щ ю я ь',
+ ],
+ },
+ {
+ description: 'pre should be on a new line not preceded by a space',
+ html: `
1
preline
`,
- wantAlines: ['+6', '+7'],
- wantText: [' 1 ', 'preline'],
- },
- {
- description: 'Preserve spaces on the beginning and end of a element',
- html: 'Need more space s ! ',
- wantAlines: ['+f*1+3+1'],
- wantText: ['Need more space s !'],
- },
- {
- description: 'Preserve spaces outside elements',
- html: 'Need more space s ! ',
- wantAlines: ['+g*1+1+2'],
- wantText: ['Need more space s !'],
- },
- {
- description: 'Preserve spaces at the end of an element',
- html: 'Need more space s ! ',
- wantAlines: ['+g*1+2+1'],
- wantText: ['Need more space s !'],
- },
- {
- description: 'Preserve spaces at the start of an element',
- html: 'Need more space s ! ',
- wantAlines: ['+f*1+2+2'],
- wantText: ['Need more space s !'],
- },
+ wantAlines: ['+6', '+7'],
+ wantText: [' 1 ', 'preline'],
+ },
+ {
+ description: 'Preserve spaces on the beginning and end of a element',
+ html: 'Need more space s ! ',
+ wantAlines: ['+f*1+3+1'],
+ wantText: ['Need more space s !'],
+ },
+ {
+ description: 'Preserve spaces outside elements',
+ html: 'Need more space s ! ',
+ wantAlines: ['+g*1+1+2'],
+ wantText: ['Need more space s !'],
+ },
+ {
+ description: 'Preserve spaces at the end of an element',
+ html: 'Need more space s ! ',
+ wantAlines: ['+g*1+2+1'],
+ wantText: ['Need more space s !'],
+ },
+ {
+ description: 'Preserve spaces at the start of an element',
+ html: 'Need more space s ! ',
+ wantAlines: ['+f*1+2+2'],
+ wantText: ['Need more space s !'],
+ },
];
-
describe(__filename, function () {
- for (const tc of testCases) {
- describe(tc.description, function () {
- let apool;
- let result;
-
- before(async function () {
- if (tc.disabled) return this.skip();
- const {window: {document}} = new jsdom.JSDOM(tc.html);
- apool = new AttributePool();
- // To reduce test fragility, the attribute pool is seeded with `knownAttribs`, and all
- // attributes in `tc.wantAlines` must be in `knownAttribs`. (This guarantees that attribute
- // numbers do not change if the attribute processing code changes.)
- for (const attrib of knownAttribs) apool.putAttrib(attrib);
- for (const aline of tc.wantAlines) {
- for (const op of Changeset.deserializeOps(aline)) {
- for (const n of attributes.decodeAttribString(op.attribs)) {
- assert(n < knownAttribs.length);
- }
- }
- }
- const cc = contentcollector.makeContentCollector(true, null, apool);
- cc.collectContent(document.body);
- result = cc.finish();
- });
-
- it('text matches', async function () {
- assert.deepEqual(result.lines, tc.wantText);
- });
-
- it('alines match', async function () {
- assert.deepEqual(result.lineAttribs, tc.wantAlines);
- });
-
- it('attributes are sorted in canonical order', async function () {
- const gotAttribs = [];
- const wantAttribs = [];
- for (const aline of result.lineAttribs) {
- const gotAlineAttribs = [];
- gotAttribs.push(gotAlineAttribs);
- const wantAlineAttribs = [];
- wantAttribs.push(wantAlineAttribs);
- for (const op of Changeset.deserializeOps(aline)) {
- const gotOpAttribs = [...attributes.attribsFromString(op.attribs, apool)];
- gotAlineAttribs.push(gotOpAttribs);
- wantAlineAttribs.push(attributes.sort([...gotOpAttribs]));
- }
- }
- assert.deepEqual(gotAttribs, wantAttribs);
- });
- });
- }
+ for (const tc of testCases) {
+ describe(tc.description, function () {
+ let apool;
+ let result;
+ before(async function () {
+ if (tc.disabled)
+ return this.skip();
+ const { window: { document } } = new jsdom.JSDOM(tc.html);
+ apool = new AttributePool();
+ // To reduce test fragility, the attribute pool is seeded with `knownAttribs`, and all
+ // attributes in `tc.wantAlines` must be in `knownAttribs`. (This guarantees that attribute
+ // numbers do not change if the attribute processing code changes.)
+ for (const attrib of knownAttribs)
+ apool.putAttrib(attrib);
+ for (const aline of tc.wantAlines) {
+ for (const op of Changeset.deserializeOps(aline)) {
+ for (const n of attributes.decodeAttribString(op.attribs)) {
+ assert(n < knownAttribs.length);
+ }
+ }
+ }
+ const cc = contentcollector.makeContentCollector(true, null, apool);
+ cc.collectContent(document.body);
+ result = cc.finish();
+ });
+ it('text matches', async function () {
+ assert.deepEqual(result.lines, tc.wantText);
+ });
+ it('alines match', async function () {
+ assert.deepEqual(result.lineAttribs, tc.wantAlines);
+ });
+ it('attributes are sorted in canonical order', async function () {
+ const gotAttribs = [];
+ const wantAttribs = [];
+ for (const aline of result.lineAttribs) {
+ const gotAlineAttribs = [];
+ gotAttribs.push(gotAlineAttribs);
+ const wantAlineAttribs = [];
+ wantAttribs.push(wantAlineAttribs);
+ for (const op of Changeset.deserializeOps(aline)) {
+ const gotOpAttribs = [...attributes.attribsFromString(op.attribs, apool)];
+ gotAlineAttribs.push(gotOpAttribs);
+ wantAlineAttribs.push(attributes.sort([...gotOpAttribs]));
+ }
+ }
+ assert.deepEqual(gotAttribs, wantAttribs);
+ });
+ });
+ }
});
diff --git a/src/tests/backend/specs/export.js b/src/tests/backend/specs/export.js
index d2fcde131dc..ea4a50be035 100644
--- a/src/tests/backend/specs/export.js
+++ b/src/tests/backend/specs/export.js
@@ -1,26 +1,21 @@
+import * as common from "../common.js";
+import * as padManager from "../../../node/db/PadManager.js";
+import * as settings from "../../../node/utils/Settings.js";
'use strict';
-
-const common = require('../common');
-const padManager = require('../../../node/db/PadManager');
-const settings = require('../../../node/utils/Settings');
-
describe(__filename, function () {
- let agent;
- const settingsBackup = {};
-
- before(async function () {
- agent = await common.init();
- settingsBackup.soffice = settings.soffice;
- await padManager.getPad('testExportPad', 'test content');
- });
-
- after(async function () {
- Object.assign(settings, settingsBackup);
- });
-
- it('returns 500 on export error', async function () {
- settings.soffice = 'false'; // '/bin/false' doesn't work on Windows
- await agent.get('/p/testExportPad/export/doc')
- .expect(500);
- });
+ let agent;
+ const settingsBackup = {};
+ before(async function () {
+ agent = await common.init();
+ settingsBackup.soffice = settings.soffice;
+ await padManager.getPad('testExportPad', 'test content');
+ });
+ after(async function () {
+ Object.assign(settings, settingsBackup);
+ });
+ it('returns 500 on export error', async function () {
+ settings.soffice = 'false'; // '/bin/false' doesn't work on Windows
+ await agent.get('/p/testExportPad/export/doc')
+ .expect(500);
+ });
});
diff --git a/src/tests/backend/specs/favicon.js b/src/tests/backend/specs/favicon.js
index a5e3095dee8..c69dfb3af82 100644
--- a/src/tests/backend/specs/favicon.js
+++ b/src/tests/backend/specs/favicon.js
@@ -1,91 +1,83 @@
+import assert$0 from "assert";
+import * as common from "../common.js";
+import fs from "fs";
+import path from "path";
+import * as settings from "../../../node/utils/Settings.js";
+import superagent from "superagent";
'use strict';
-
-const assert = require('assert').strict;
-const common = require('../common');
-const fs = require('fs');
+const assert = assert$0.strict;
const fsp = fs.promises;
-const path = require('path');
-const settings = require('../../../node/utils/Settings');
-const superagent = require('superagent');
-
describe(__filename, function () {
- let agent;
- let backupSettings;
- let skinDir;
- let wantCustomIcon;
- let wantDefaultIcon;
- let wantSkinIcon;
-
- before(async function () {
- agent = await common.init();
- wantCustomIcon = await fsp.readFile(path.join(__dirname, 'favicon-test-custom.png'));
- wantDefaultIcon = await fsp.readFile(path.join(settings.root, 'src', 'static', 'favicon.ico'));
- wantSkinIcon = await fsp.readFile(path.join(__dirname, 'favicon-test-skin.png'));
- });
-
- beforeEach(async function () {
- backupSettings = {...settings};
- skinDir = await fsp.mkdtemp(path.join(settings.root, 'src', 'static', 'skins', 'test-'));
- settings.skinName = path.basename(skinDir);
- });
-
- afterEach(async function () {
- delete settings.favicon;
- delete settings.skinName;
- Object.assign(settings, backupSettings);
- try {
- // TODO: The {recursive: true} option wasn't added to fsp.rmdir() until Node.js v12.10.0 so we
- // can't rely on it until support for Node.js v10 is dropped.
- await fsp.unlink(path.join(skinDir, 'favicon.ico'));
- await fsp.rmdir(skinDir, {recursive: true});
- } catch (err) { /* intentionally ignored */ }
- });
-
- it('uses custom favicon if set (relative pathname)', async function () {
- settings.favicon =
- path.relative(settings.root, path.join(__dirname, 'favicon-test-custom.png'));
- assert(!path.isAbsolute(settings.favicon));
- const {body: gotIcon} = await agent.get('/favicon.ico')
- .accept('png').buffer(true).parse(superagent.parse.image)
- .expect(200);
- assert(gotIcon.equals(wantCustomIcon));
- });
-
- it('uses custom favicon if set (absolute pathname)', async function () {
- settings.favicon = path.join(__dirname, 'favicon-test-custom.png');
- assert(path.isAbsolute(settings.favicon));
- const {body: gotIcon} = await agent.get('/favicon.ico')
- .accept('png').buffer(true).parse(superagent.parse.image)
- .expect(200);
- assert(gotIcon.equals(wantCustomIcon));
- });
-
- it('falls back if custom favicon is missing', async function () {
- // The previous default for settings.favicon was 'favicon.ico', so many users will continue to
- // have that in their settings.json for a long time. There is unlikely to be a favicon at
- // path.resolve(settings.root, 'favicon.ico'), so this test ensures that 'favicon.ico' won't be
- // a problem for those users.
- settings.favicon = 'favicon.ico';
- const {body: gotIcon} = await agent.get('/favicon.ico')
- .accept('png').buffer(true).parse(superagent.parse.image)
- .expect(200);
- assert(gotIcon.equals(wantDefaultIcon));
- });
-
- it('uses skin favicon if present', async function () {
- await fsp.writeFile(path.join(skinDir, 'favicon.ico'), wantSkinIcon);
- settings.favicon = null;
- const {body: gotIcon} = await agent.get('/favicon.ico')
- .accept('png').buffer(true).parse(superagent.parse.image)
- .expect(200);
- assert(gotIcon.equals(wantSkinIcon));
- });
-
- it('falls back to default favicon', async function () {
- settings.favicon = null;
- const {body: gotIcon} = await agent.get('/favicon.ico')
- .accept('png').buffer(true).parse(superagent.parse.image)
- .expect(200);
- assert(gotIcon.equals(wantDefaultIcon));
- });
+ let agent;
+ let backupSettings;
+ let skinDir;
+ let wantCustomIcon;
+ let wantDefaultIcon;
+ let wantSkinIcon;
+ before(async function () {
+ agent = await common.init();
+ wantCustomIcon = await fsp.readFile(path.join(__dirname, 'favicon-test-custom.png'));
+ wantDefaultIcon = await fsp.readFile(path.join(settings.root, 'src', 'static', 'favicon.ico'));
+ wantSkinIcon = await fsp.readFile(path.join(__dirname, 'favicon-test-skin.png'));
+ });
+ beforeEach(async function () {
+ backupSettings = { ...settings };
+ skinDir = await fsp.mkdtemp(path.join(settings.root, 'src', 'static', 'skins', 'test-'));
+ settings.skinName = path.basename(skinDir);
+ });
+ afterEach(async function () {
+ delete settings.favicon;
+ delete settings.skinName;
+ Object.assign(settings, backupSettings);
+ try {
+ // TODO: The {recursive: true} option wasn't added to fsp.rmdir() until Node.js v12.10.0 so we
+ // can't rely on it until support for Node.js v10 is dropped.
+ await fsp.unlink(path.join(skinDir, 'favicon.ico'));
+ await fsp.rmdir(skinDir, { recursive: true });
+ }
+ catch (err) { /* intentionally ignored */ }
+ });
+ it('uses custom favicon if set (relative pathname)', async function () {
+ settings.favicon =
+ path.relative(settings.root, path.join(__dirname, 'favicon-test-custom.png'));
+ assert(!path.isAbsolute(settings.favicon));
+ const { body: gotIcon } = await agent.get('/favicon.ico')
+ .accept('png').buffer(true).parse(superagent.parse.image)
+ .expect(200);
+ assert(gotIcon.equals(wantCustomIcon));
+ });
+ it('uses custom favicon if set (absolute pathname)', async function () {
+ settings.favicon = path.join(__dirname, 'favicon-test-custom.png');
+ assert(path.isAbsolute(settings.favicon));
+ const { body: gotIcon } = await agent.get('/favicon.ico')
+ .accept('png').buffer(true).parse(superagent.parse.image)
+ .expect(200);
+ assert(gotIcon.equals(wantCustomIcon));
+ });
+ it('falls back if custom favicon is missing', async function () {
+ // The previous default for settings.favicon was 'favicon.ico', so many users will continue to
+ // have that in their settings.json for a long time. There is unlikely to be a favicon at
+ // path.resolve(settings.root, 'favicon.ico'), so this test ensures that 'favicon.ico' won't be
+ // a problem for those users.
+ settings.favicon = 'favicon.ico';
+ const { body: gotIcon } = await agent.get('/favicon.ico')
+ .accept('png').buffer(true).parse(superagent.parse.image)
+ .expect(200);
+ assert(gotIcon.equals(wantDefaultIcon));
+ });
+ it('uses skin favicon if present', async function () {
+ await fsp.writeFile(path.join(skinDir, 'favicon.ico'), wantSkinIcon);
+ settings.favicon = null;
+ const { body: gotIcon } = await agent.get('/favicon.ico')
+ .accept('png').buffer(true).parse(superagent.parse.image)
+ .expect(200);
+ assert(gotIcon.equals(wantSkinIcon));
+ });
+ it('falls back to default favicon', async function () {
+ settings.favicon = null;
+ const { body: gotIcon } = await agent.get('/favicon.ico')
+ .accept('png').buffer(true).parse(superagent.parse.image)
+ .expect(200);
+ assert(gotIcon.equals(wantDefaultIcon));
+ });
});
diff --git a/src/tests/backend/specs/health.js b/src/tests/backend/specs/health.js
index 0090aedbb90..bc640af239e 100644
--- a/src/tests/backend/specs/health.js
+++ b/src/tests/backend/specs/health.js
@@ -1,56 +1,48 @@
+import assert$0 from "assert";
+import * as common from "../common.js";
+import * as settings from "../../../node/utils/Settings.js";
+import superagent from "superagent";
'use strict';
-
-const assert = require('assert').strict;
-const common = require('../common');
-const settings = require('../../../node/utils/Settings');
-const superagent = require('superagent');
-
+const assert = assert$0.strict;
describe(__filename, function () {
- let agent;
- const backup = {};
-
- const getHealth = () => agent.get('/health')
- .accept('application/health+json')
- .buffer(true)
- .parse(superagent.parse['application/json'])
- .expect(200)
- .expect((res) => assert.equal(res.type, 'application/health+json'));
-
- before(async function () {
- agent = await common.init();
- });
-
- beforeEach(async function () {
- backup.settings = {};
- for (const setting of ['requireAuthentication', 'requireAuthorization']) {
- backup.settings[setting] = settings[setting];
- }
- });
-
- afterEach(async function () {
- Object.assign(settings, backup.settings);
- });
-
- it('/health works', async function () {
- const res = await getHealth();
- assert.equal(res.body.status, 'pass');
- assert.equal(res.body.releaseId, settings.getEpVersion());
- });
-
- it('auth is not required', async function () {
- settings.requireAuthentication = true;
- settings.requireAuthorization = true;
- const res = await getHealth();
- assert.equal(res.body.status, 'pass');
- });
-
- // We actually want to test that no express-session state is created, but that is difficult to do
- // without intrusive changes or unpleasant ueberdb digging. Instead, we assume that the lack of a
- // cookie means that no express-session state was created (how would express-session look up the
- // session state if no ID was returned to the client?).
- it('no cookie is returned', async function () {
- const res = await getHealth();
- const cookie = res.headers['set-cookie'];
- assert(cookie == null, `unexpected Set-Cookie: ${cookie}`);
- });
+ let agent;
+ const backup = {};
+ const getHealth = () => agent.get('/health')
+ .accept('application/health+json')
+ .buffer(true)
+ .parse(superagent.parse['application/json'])
+ .expect(200)
+ .expect((res) => assert.equal(res.type, 'application/health+json'));
+ before(async function () {
+ agent = await common.init();
+ });
+ beforeEach(async function () {
+ backup.settings = {};
+ for (const setting of ['requireAuthentication', 'requireAuthorization']) {
+ backup.settings[setting] = settings[setting];
+ }
+ });
+ afterEach(async function () {
+ Object.assign(settings, backup.settings);
+ });
+ it('/health works', async function () {
+ const res = await getHealth();
+ assert.equal(res.body.status, 'pass');
+ assert.equal(res.body.releaseId, settings.getEpVersion());
+ });
+ it('auth is not required', async function () {
+ settings.requireAuthentication = true;
+ settings.requireAuthorization = true;
+ const res = await getHealth();
+ assert.equal(res.body.status, 'pass');
+ });
+ // We actually want to test that no express-session state is created, but that is difficult to do
+ // without intrusive changes or unpleasant ueberdb digging. Instead, we assume that the lack of a
+ // cookie means that no express-session state was created (how would express-session look up the
+ // session state if no ID was returned to the client?).
+ it('no cookie is returned', async function () {
+ const res = await getHealth();
+ const cookie = res.headers['set-cookie'];
+ assert(cookie == null, `unexpected Set-Cookie: ${cookie}`);
+ });
});
diff --git a/src/tests/backend/specs/hooks.js b/src/tests/backend/specs/hooks.js
index 3120911aea2..e8972943a7a 100644
--- a/src/tests/backend/specs/hooks.js
+++ b/src/tests/backend/specs/hooks.js
@@ -1,1209 +1,1106 @@
+import assertLegacy from "../assert-legacy.js";
+import * as hooks from "../../../static/js/pluginfw/hooks.js";
+import * as plugins from "../../../static/js/pluginfw/plugin_defs.js";
+import sinon from "sinon";
'use strict';
-
-const assert = require('../assert-legacy').strict;
-const hooks = require('../../../static/js/pluginfw/hooks');
-const plugins = require('../../../static/js/pluginfw/plugin_defs');
-const sinon = require('sinon');
-
+const assert = assertLegacy.strict;
describe(__filename, function () {
- const hookName = 'testHook';
- const hookFnName = 'testPluginFileName:testHookFunctionName';
- let testHooks; // Convenience shorthand for plugins.hooks[hookName].
- let hook; // Convenience shorthand for plugins.hooks[hookName][0].
-
- beforeEach(async function () {
- // Make sure these are not already set so that we don't accidentally step on someone else's
- // toes:
- assert(plugins.hooks[hookName] == null);
- assert(hooks.deprecationNotices[hookName] == null);
- assert(hooks.exportedForTestingOnly.deprecationWarned[hookFnName] == null);
-
- // Many of the tests only need a single registered hook function. Set that up here to reduce
- // boilerplate.
- hook = makeHook();
- plugins.hooks[hookName] = [hook];
- testHooks = plugins.hooks[hookName];
- });
-
- afterEach(async function () {
- sinon.restore();
- delete plugins.hooks[hookName];
- delete hooks.deprecationNotices[hookName];
- delete hooks.exportedForTestingOnly.deprecationWarned[hookFnName];
- });
-
- const makeHook = (ret) => ({
- hook_name: hookName,
- // Many tests will likely want to change this. Unfortunately, we can't use a convenience
- // wrapper like `(...args) => hookFn(..args)` because the hooks look at Function.length and
- // change behavior depending on the number of parameters.
- hook_fn: (hn, ctx, cb) => cb(ret),
- hook_fn_name: hookFnName,
- part: {plugin: 'testPluginName'},
- });
-
- // Hook functions that should work for both synchronous and asynchronous hooks.
- const supportedSyncHookFunctions = [
- {
- name: 'return non-Promise value, with callback parameter',
- fn: (hn, ctx, cb) => 'val',
- want: 'val',
- syncOk: true,
- },
- {
- name: 'return non-Promise value, without callback parameter',
- fn: (hn, ctx) => 'val',
- want: 'val',
- syncOk: true,
- },
- {
- name: 'return undefined, without callback parameter',
- fn: (hn, ctx) => {},
- want: undefined,
- syncOk: true,
- },
- {
- name: 'pass non-Promise value to callback',
- fn: (hn, ctx, cb) => { cb('val'); },
- want: 'val',
- syncOk: true,
- },
- {
- name: 'pass undefined to callback',
- fn: (hn, ctx, cb) => { cb(); },
- want: undefined,
- syncOk: true,
- },
- {
- name: 'return the value returned from the callback',
- fn: (hn, ctx, cb) => cb('val'),
- want: 'val',
- syncOk: true,
- },
- {
- name: 'throw',
- fn: (hn, ctx, cb) => { throw new Error('test exception'); },
- wantErr: 'test exception',
- syncOk: true,
- },
- ];
-
- describe('callHookFnSync', function () {
- const callHookFnSync = hooks.exportedForTestingOnly.callHookFnSync; // Convenience shorthand.
-
- describe('basic behavior', function () {
- it('passes hook name', async function () {
- hook.hook_fn = (hn) => { assert.equal(hn, hookName); };
- callHookFnSync(hook);
- });
-
- it('passes context', async function () {
- for (const val of ['value', null, undefined]) {
- hook.hook_fn = (hn, ctx) => { assert.equal(ctx, val); };
- callHookFnSync(hook, val);
- }
- });
-
- it('returns the value provided to the callback', async function () {
- for (const val of ['value', null, undefined]) {
- hook.hook_fn = (hn, ctx, cb) => { cb(ctx); };
- assert.equal(callHookFnSync(hook, val), val);
- }
- });
-
- it('returns the value returned by the hook function', async function () {
- for (const val of ['value', null, undefined]) {
- // Must not have the cb parameter otherwise returning undefined will error.
- hook.hook_fn = (hn, ctx) => ctx;
- assert.equal(callHookFnSync(hook, val), val);
- }
- });
-
- it('does not catch exceptions', async function () {
- hook.hook_fn = () => { throw new Error('test exception'); };
- assert.throws(() => callHookFnSync(hook), {message: 'test exception'});
- });
-
- it('callback returns undefined', async function () {
- hook.hook_fn = (hn, ctx, cb) => { assert.equal(cb('foo'), undefined); };
- callHookFnSync(hook);
- });
-
- it('checks for deprecation', async function () {
- sinon.stub(console, 'warn');
- hooks.deprecationNotices[hookName] = 'test deprecation';
- callHookFnSync(hook);
- assert.equal(hooks.exportedForTestingOnly.deprecationWarned[hookFnName], true);
- assert.equal(console.warn.callCount, 1);
- assert.match(console.warn.getCall(0).args[0], /test deprecation/);
- });
+ const hookName = 'testHook';
+ const hookFnName = 'testPluginFileName:testHookFunctionName';
+ let testHooks; // Convenience shorthand for plugins.hooks[hookName].
+ let hook; // Convenience shorthand for plugins.hooks[hookName][0].
+ beforeEach(async function () {
+ // Make sure these are not already set so that we don't accidentally step on someone else's
+ // toes:
+ assert(plugins.hooks[hookName] == null);
+ assert(hooks.deprecationNotices[hookName] == null);
+ assert(hooks.exportedForTestingOnly.deprecationWarned[hookFnName] == null);
+ // Many of the tests only need a single registered hook function. Set that up here to reduce
+ // boilerplate.
+ hook = makeHook();
+ plugins.hooks[hookName] = [hook];
+ testHooks = plugins.hooks[hookName];
});
-
- describe('supported hook function styles', function () {
- for (const tc of supportedSyncHookFunctions) {
- it(tc.name, async function () {
- sinon.stub(console, 'warn');
- sinon.stub(console, 'error');
- hook.hook_fn = tc.fn;
- const call = () => callHookFnSync(hook);
- if (tc.wantErr) {
- assert.throws(call, {message: tc.wantErr});
- } else {
- assert.equal(call(), tc.want);
- }
- assert.equal(console.warn.callCount, 0);
- assert.equal(console.error.callCount, 0);
- });
- }
+ afterEach(async function () {
+ sinon.restore();
+ delete plugins.hooks[hookName];
+ delete hooks.deprecationNotices[hookName];
+ delete hooks.exportedForTestingOnly.deprecationWarned[hookFnName];
});
-
- describe('bad hook function behavior (other than double settle)', function () {
- const promise1 = Promise.resolve('val1');
- const promise2 = Promise.resolve('val2');
-
- const testCases = [
+ const makeHook = (ret) => ({
+ hook_name: hookName,
+ // Many tests will likely want to change this. Unfortunately, we can't use a convenience
+ // wrapper like `(...args) => hookFn(..args)` because the hooks look at Function.length and
+ // change behavior depending on the number of parameters.
+ hook_fn: (hn, ctx, cb) => cb(ret),
+ hook_fn_name: hookFnName,
+ part: { plugin: 'testPluginName' },
+ });
+ // Hook functions that should work for both synchronous and asynchronous hooks.
+ const supportedSyncHookFunctions = [
{
- name: 'never settles -> buggy hook detected',
- // Note that returning undefined without calling the callback is permitted if the function
- // has 2 or fewer parameters, so this test function must have 3 parameters.
- fn: (hn, ctx, cb) => {},
- wantVal: undefined,
- wantError: /UNSETTLED FUNCTION BUG/,
+ name: 'return non-Promise value, with callback parameter',
+ fn: (hn, ctx, cb) => 'val',
+ want: 'val',
+ syncOk: true,
},
{
- name: 'returns a Promise -> buggy hook detected',
- fn: () => promise1,
- wantVal: promise1,
- wantError: /PROHIBITED PROMISE BUG/,
+ name: 'return non-Promise value, without callback parameter',
+ fn: (hn, ctx) => 'val',
+ want: 'val',
+ syncOk: true,
},
{
- name: 'passes a Promise to cb -> buggy hook detected',
- fn: (hn, ctx, cb) => cb(promise2),
- wantVal: promise2,
- wantError: /PROHIBITED PROMISE BUG/,
+ name: 'return undefined, without callback parameter',
+ fn: (hn, ctx) => { },
+ want: undefined,
+ syncOk: true,
},
- ];
-
- for (const tc of testCases) {
- it(tc.name, async function () {
- sinon.stub(console, 'error');
- hook.hook_fn = tc.fn;
- assert.equal(callHookFnSync(hook), tc.wantVal);
- assert.equal(console.error.callCount, tc.wantError ? 1 : 0);
- if (tc.wantError) assert.match(console.error.getCall(0).args[0], tc.wantError);
- });
- }
- });
-
- // Test various ways a hook might attempt to settle twice. (Examples: call the callback a second
- // time, or call the callback and then return a value.)
- describe('bad hook function behavior (double settle)', function () {
- beforeEach(async function () {
- sinon.stub(console, 'error');
- });
-
- // Each item in this array codifies a way to settle a synchronous hook function. Each of the
- // test cases below combines two of these behaviors in a single hook function and confirms
- // that callHookFnSync both (1) returns the result of the first settle attempt, and
- // (2) detects the second settle attempt.
- const behaviors = [
{
- name: 'throw',
- fn: (cb, err, val) => { throw err; },
- rejects: true,
+ name: 'pass non-Promise value to callback',
+ fn: (hn, ctx, cb) => { cb('val'); },
+ want: 'val',
+ syncOk: true,
},
{
- name: 'return value',
- fn: (cb, err, val) => val,
+ name: 'pass undefined to callback',
+ fn: (hn, ctx, cb) => { cb(); },
+ want: undefined,
+ syncOk: true,
},
{
- name: 'immediately call cb(value)',
- fn: (cb, err, val) => cb(val),
+ name: 'return the value returned from the callback',
+ fn: (hn, ctx, cb) => cb('val'),
+ want: 'val',
+ syncOk: true,
},
{
- name: 'defer call to cb(value)',
- fn: (cb, err, val) => { process.nextTick(cb, val); },
- async: true,
+ name: 'throw',
+ fn: (hn, ctx, cb) => { throw new Error('test exception'); },
+ wantErr: 'test exception',
+ syncOk: true,
},
- ];
-
- for (const step1 of behaviors) {
- // There can't be a second step if the first step is to return or throw.
- if (step1.name.startsWith('return ') || step1.name === 'throw') continue;
- for (const step2 of behaviors) {
- // If step1 and step2 are both async then there would be three settle attempts (first an
- // erroneous unsettled return, then async step 1, then async step 2). Handling triple
- // settle would complicate the tests, and it is sufficient to test only double settles.
- if (step1.async && step2.async) continue;
-
- it(`${step1.name} then ${step2.name} (diff. outcomes) -> log+throw`, async function () {
- hook.hook_fn = (hn, ctx, cb) => {
- step1.fn(cb, new Error(ctx.ret1), ctx.ret1);
- return step2.fn(cb, new Error(ctx.ret2), ctx.ret2);
- };
-
- // Temporarily remove unhandled error listeners so that the errors we expect to see
- // don't trigger a test failure (or terminate node).
- const events = ['uncaughtException', 'unhandledRejection'];
- const listenerBackups = {};
- for (const event of events) {
- listenerBackups[event] = process.rawListeners(event);
- process.removeAllListeners(event);
- }
-
- // We should see an asynchronous error (either an unhandled Promise rejection or an
- // uncaught exception) if and only if one of the two steps was asynchronous or there was
- // a throw (in which case the double settle is deferred so that the caller sees the
- // original error).
- const wantAsyncErr = step1.async || step2.async || step2.rejects;
- let tempListener;
- let asyncErr;
- try {
- const seenErrPromise = new Promise((resolve) => {
- tempListener = (err) => {
- assert.equal(asyncErr, undefined);
- asyncErr = err;
- resolve();
- };
- if (!wantAsyncErr) resolve();
- });
- events.forEach((event) => process.on(event, tempListener));
- const call = () => callHookFnSync(hook, {ret1: 'val1', ret2: 'val2'});
- if (step2.rejects) {
- assert.throws(call, {message: 'val2'});
- } else if (!step1.async && !step2.async) {
- assert.throws(call, {message: /DOUBLE SETTLE BUG/});
- } else {
- assert.equal(call(), step1.async ? 'val2' : 'val1');
- }
- await seenErrPromise;
- } finally {
- // Restore the original listeners.
- for (const event of events) {
- process.off(event, tempListener);
- for (const listener of listenerBackups[event]) {
- process.on(event, listener);
+ ];
+ describe('callHookFnSync', function () {
+ const callHookFnSync = hooks.exportedForTestingOnly.callHookFnSync; // Convenience shorthand.
+ describe('basic behavior', function () {
+ it('passes hook name', async function () {
+ hook.hook_fn = (hn) => { assert.equal(hn, hookName); };
+ callHookFnSync(hook);
+ });
+ it('passes context', async function () {
+ for (const val of ['value', null, undefined]) {
+ hook.hook_fn = (hn, ctx) => { assert.equal(ctx, val); };
+ callHookFnSync(hook, val);
+ }
+ });
+ it('returns the value provided to the callback', async function () {
+ for (const val of ['value', null, undefined]) {
+ hook.hook_fn = (hn, ctx, cb) => { cb(ctx); };
+ assert.equal(callHookFnSync(hook, val), val);
}
- }
+ });
+ it('returns the value returned by the hook function', async function () {
+ for (const val of ['value', null, undefined]) {
+ // Must not have the cb parameter otherwise returning undefined will error.
+ hook.hook_fn = (hn, ctx) => ctx;
+ assert.equal(callHookFnSync(hook, val), val);
+ }
+ });
+ it('does not catch exceptions', async function () {
+ hook.hook_fn = () => { throw new Error('test exception'); };
+ assert.throws(() => callHookFnSync(hook), { message: 'test exception' });
+ });
+ it('callback returns undefined', async function () {
+ hook.hook_fn = (hn, ctx, cb) => { assert.equal(cb('foo'), undefined); };
+ callHookFnSync(hook);
+ });
+ it('checks for deprecation', async function () {
+ sinon.stub(console, 'warn');
+ hooks.deprecationNotices[hookName] = 'test deprecation';
+ callHookFnSync(hook);
+ assert.equal(hooks.exportedForTestingOnly.deprecationWarned[hookFnName], true);
+ assert.equal(console.warn.callCount, 1);
+ assert.match(console.warn.getCall(0).args[0], /test deprecation/);
+ });
+ });
+ describe('supported hook function styles', function () {
+ for (const tc of supportedSyncHookFunctions) {
+ it(tc.name, async function () {
+ sinon.stub(console, 'warn');
+ sinon.stub(console, 'error');
+ hook.hook_fn = tc.fn;
+ const call = () => callHookFnSync(hook);
+ if (tc.wantErr) {
+ assert.throws(call, { message: tc.wantErr });
+ }
+ else {
+ assert.equal(call(), tc.want);
+ }
+ assert.equal(console.warn.callCount, 0);
+ assert.equal(console.error.callCount, 0);
+ });
}
- assert.equal(console.error.callCount, 1);
- assert.match(console.error.getCall(0).args[0], /DOUBLE SETTLE BUG/);
- if (wantAsyncErr) {
- assert(asyncErr instanceof Error);
- assert.match(asyncErr.message, /DOUBLE SETTLE BUG/);
+ });
+ describe('bad hook function behavior (other than double settle)', function () {
+ const promise1 = Promise.resolve('val1');
+ const promise2 = Promise.resolve('val2');
+ const testCases = [
+ {
+ name: 'never settles -> buggy hook detected',
+ // Note that returning undefined without calling the callback is permitted if the function
+ // has 2 or fewer parameters, so this test function must have 3 parameters.
+ fn: (hn, ctx, cb) => { },
+ wantVal: undefined,
+ wantError: /UNSETTLED FUNCTION BUG/,
+ },
+ {
+ name: 'returns a Promise -> buggy hook detected',
+ fn: () => promise1,
+ wantVal: promise1,
+ wantError: /PROHIBITED PROMISE BUG/,
+ },
+ {
+ name: 'passes a Promise to cb -> buggy hook detected',
+ fn: (hn, ctx, cb) => cb(promise2),
+ wantVal: promise2,
+ wantError: /PROHIBITED PROMISE BUG/,
+ },
+ ];
+ for (const tc of testCases) {
+ it(tc.name, async function () {
+ sinon.stub(console, 'error');
+ hook.hook_fn = tc.fn;
+ assert.equal(callHookFnSync(hook), tc.wantVal);
+ assert.equal(console.error.callCount, tc.wantError ? 1 : 0);
+ if (tc.wantError)
+ assert.match(console.error.getCall(0).args[0], tc.wantError);
+ });
}
- });
-
- // This next test is the same as the above test, except the second settle attempt is for
- // the same outcome. The two outcomes can't be the same if one step throws and the other
- // doesn't, so skip those cases.
- if (step1.rejects !== step2.rejects) continue;
-
- it(`${step1.name} then ${step2.name} (same outcome) -> only log`, async function () {
- const err = new Error('val');
- hook.hook_fn = (hn, ctx, cb) => {
- step1.fn(cb, err, 'val');
- return step2.fn(cb, err, 'val');
- };
-
- const errorLogged = new Promise((resolve) => console.error.callsFake(resolve));
- const call = () => callHookFnSync(hook);
- if (step2.rejects) {
- assert.throws(call, {message: 'val'});
- } else {
- assert.equal(call(), 'val');
+ });
+ // Test various ways a hook might attempt to settle twice. (Examples: call the callback a second
+ // time, or call the callback and then return a value.)
+ describe('bad hook function behavior (double settle)', function () {
+ beforeEach(async function () {
+ sinon.stub(console, 'error');
+ });
+ // Each item in this array codifies a way to settle a synchronous hook function. Each of the
+ // test cases below combines two of these behaviors in a single hook function and confirms
+ // that callHookFnSync both (1) returns the result of the first settle attempt, and
+ // (2) detects the second settle attempt.
+ const behaviors = [
+ {
+ name: 'throw',
+ fn: (cb, err, val) => { throw err; },
+ rejects: true,
+ },
+ {
+ name: 'return value',
+ fn: (cb, err, val) => val,
+ },
+ {
+ name: 'immediately call cb(value)',
+ fn: (cb, err, val) => cb(val),
+ },
+ {
+ name: 'defer call to cb(value)',
+ fn: (cb, err, val) => { process.nextTick(cb, val); },
+ async: true,
+ },
+ ];
+ for (const step1 of behaviors) {
+ // There can't be a second step if the first step is to return or throw.
+ if (step1.name.startsWith('return ') || step1.name === 'throw')
+ continue;
+ for (const step2 of behaviors) {
+ // If step1 and step2 are both async then there would be three settle attempts (first an
+ // erroneous unsettled return, then async step 1, then async step 2). Handling triple
+ // settle would complicate the tests, and it is sufficient to test only double settles.
+ if (step1.async && step2.async)
+ continue;
+ it(`${step1.name} then ${step2.name} (diff. outcomes) -> log+throw`, async function () {
+ hook.hook_fn = (hn, ctx, cb) => {
+ step1.fn(cb, new Error(ctx.ret1), ctx.ret1);
+ return step2.fn(cb, new Error(ctx.ret2), ctx.ret2);
+ };
+ // Temporarily remove unhandled error listeners so that the errors we expect to see
+ // don't trigger a test failure (or terminate node).
+ const events = ['uncaughtException', 'unhandledRejection'];
+ const listenerBackups = {};
+ for (const event of events) {
+ listenerBackups[event] = process.rawListeners(event);
+ process.removeAllListeners(event);
+ }
+ // We should see an asynchronous error (either an unhandled Promise rejection or an
+ // uncaught exception) if and only if one of the two steps was asynchronous or there was
+ // a throw (in which case the double settle is deferred so that the caller sees the
+ // original error).
+ const wantAsyncErr = step1.async || step2.async || step2.rejects;
+ let tempListener;
+ let asyncErr;
+ try {
+ const seenErrPromise = new Promise((resolve) => {
+ tempListener = (err) => {
+ assert.equal(asyncErr, undefined);
+ asyncErr = err;
+ resolve();
+ };
+ if (!wantAsyncErr)
+ resolve();
+ });
+ events.forEach((event) => process.on(event, tempListener));
+ const call = () => callHookFnSync(hook, { ret1: 'val1', ret2: 'val2' });
+ if (step2.rejects) {
+ assert.throws(call, { message: 'val2' });
+ }
+ else if (!step1.async && !step2.async) {
+ assert.throws(call, { message: /DOUBLE SETTLE BUG/ });
+ }
+ else {
+ assert.equal(call(), step1.async ? 'val2' : 'val1');
+ }
+ await seenErrPromise;
+ }
+ finally {
+ // Restore the original listeners.
+ for (const event of events) {
+ process.off(event, tempListener);
+ for (const listener of listenerBackups[event]) {
+ process.on(event, listener);
+ }
+ }
+ }
+ assert.equal(console.error.callCount, 1);
+ assert.match(console.error.getCall(0).args[0], /DOUBLE SETTLE BUG/);
+ if (wantAsyncErr) {
+ assert(asyncErr instanceof Error);
+ assert.match(asyncErr.message, /DOUBLE SETTLE BUG/);
+ }
+ });
+ // This next test is the same as the above test, except the second settle attempt is for
+ // the same outcome. The two outcomes can't be the same if one step throws and the other
+ // doesn't, so skip those cases.
+ if (step1.rejects !== step2.rejects)
+ continue;
+ it(`${step1.name} then ${step2.name} (same outcome) -> only log`, async function () {
+ const err = new Error('val');
+ hook.hook_fn = (hn, ctx, cb) => {
+ step1.fn(cb, err, 'val');
+ return step2.fn(cb, err, 'val');
+ };
+ const errorLogged = new Promise((resolve) => console.error.callsFake(resolve));
+ const call = () => callHookFnSync(hook);
+ if (step2.rejects) {
+ assert.throws(call, { message: 'val' });
+ }
+ else {
+ assert.equal(call(), 'val');
+ }
+ await errorLogged;
+ assert.equal(console.error.callCount, 1);
+ assert.match(console.error.getCall(0).args[0], /DOUBLE SETTLE BUG/);
+ });
+ }
}
- await errorLogged;
- assert.equal(console.error.callCount, 1);
- assert.match(console.error.getCall(0).args[0], /DOUBLE SETTLE BUG/);
- });
- }
- }
- });
- });
-
- describe('hooks.callAll', function () {
- describe('basic behavior', function () {
- it('calls all in order', async function () {
- testHooks.length = 0;
- testHooks.push(makeHook(1), makeHook(2), makeHook(3));
- assert.deepEqual(hooks.callAll(hookName), [1, 2, 3]);
- });
-
- it('passes hook name', async function () {
- hook.hook_fn = (hn) => { assert.equal(hn, hookName); };
- hooks.callAll(hookName);
- });
-
- it('undefined context -> {}', async function () {
- hook.hook_fn = (hn, ctx) => { assert.deepEqual(ctx, {}); };
- hooks.callAll(hookName);
- });
-
- it('null context -> {}', async function () {
- hook.hook_fn = (hn, ctx) => { assert.deepEqual(ctx, {}); };
- hooks.callAll(hookName, null);
- });
-
- it('context unmodified', async function () {
- const wantContext = {};
- hook.hook_fn = (hn, ctx) => { assert.equal(ctx, wantContext); };
- hooks.callAll(hookName, wantContext);
- });
- });
-
- describe('result processing', function () {
- it('no registered hooks (undefined) -> []', async function () {
- delete plugins.hooks.testHook;
- assert.deepEqual(hooks.callAll(hookName), []);
- });
-
- it('no registered hooks (empty list) -> []', async function () {
- testHooks.length = 0;
- assert.deepEqual(hooks.callAll(hookName), []);
- });
-
- it('flattens one level', async function () {
- testHooks.length = 0;
- testHooks.push(makeHook(1), makeHook([2]), makeHook([[3]]));
- assert.deepEqual(hooks.callAll(hookName), [1, 2, [3]]);
- });
-
- it('filters out undefined', async function () {
- testHooks.length = 0;
- testHooks.push(makeHook(), makeHook([2]), makeHook([[3]]));
- assert.deepEqual(hooks.callAll(hookName), [2, [3]]);
- });
-
- it('preserves null', async function () {
- testHooks.length = 0;
- testHooks.push(makeHook(null), makeHook([2]), makeHook([[3]]));
- assert.deepEqual(hooks.callAll(hookName), [null, 2, [3]]);
- });
-
- it('all undefined -> []', async function () {
- testHooks.length = 0;
- testHooks.push(makeHook(), makeHook());
- assert.deepEqual(hooks.callAll(hookName), []);
- });
- });
- });
-
- describe('hooks.callFirst', function () {
- it('no registered hooks (undefined) -> []', async function () {
- delete plugins.hooks.testHook;
- assert.deepEqual(hooks.callFirst(hookName), []);
- });
-
- it('no registered hooks (empty list) -> []', async function () {
- testHooks.length = 0;
- assert.deepEqual(hooks.callFirst(hookName), []);
- });
-
- it('passes hook name => {}', async function () {
- hook.hook_fn = (hn) => { assert.equal(hn, hookName); };
- hooks.callFirst(hookName);
- });
-
- it('undefined context => {}', async function () {
- hook.hook_fn = (hn, ctx) => { assert.deepEqual(ctx, {}); };
- hooks.callFirst(hookName);
- });
-
- it('null context => {}', async function () {
- hook.hook_fn = (hn, ctx) => { assert.deepEqual(ctx, {}); };
- hooks.callFirst(hookName, null);
- });
-
- it('context unmodified', async function () {
- const wantContext = {};
- hook.hook_fn = (hn, ctx) => { assert.equal(ctx, wantContext); };
- hooks.callFirst(hookName, wantContext);
- });
-
- it('predicate never satisfied -> calls all in order', async function () {
- const gotCalls = [];
- testHooks.length = 0;
- for (let i = 0; i < 3; i++) {
- const hook = makeHook();
- hook.hook_fn = () => { gotCalls.push(i); };
- testHooks.push(hook);
- }
- assert.deepEqual(hooks.callFirst(hookName), []);
- assert.deepEqual(gotCalls, [0, 1, 2]);
- });
-
- it('stops when predicate is satisfied', async function () {
- testHooks.length = 0;
- testHooks.push(makeHook(), makeHook('val1'), makeHook('val2'));
- assert.deepEqual(hooks.callFirst(hookName), ['val1']);
- });
-
- it('skips values that do not satisfy predicate (undefined)', async function () {
- testHooks.length = 0;
- testHooks.push(makeHook(), makeHook('val1'));
- assert.deepEqual(hooks.callFirst(hookName), ['val1']);
- });
-
- it('skips values that do not satisfy predicate (empty list)', async function () {
- testHooks.length = 0;
- testHooks.push(makeHook([]), makeHook('val1'));
- assert.deepEqual(hooks.callFirst(hookName), ['val1']);
- });
-
- it('null satisifes the predicate', async function () {
- testHooks.length = 0;
- testHooks.push(makeHook(null), makeHook('val1'));
- assert.deepEqual(hooks.callFirst(hookName), [null]);
- });
-
- it('non-empty arrays are returned unmodified', async function () {
- const want = ['val1'];
- testHooks.length = 0;
- testHooks.push(makeHook(want), makeHook(['val2']));
- assert.equal(hooks.callFirst(hookName), want); // Note: *NOT* deepEqual!
- });
-
- it('value can be passed via callback', async function () {
- const want = {};
- hook.hook_fn = (hn, ctx, cb) => { cb(want); };
- const got = hooks.callFirst(hookName);
- assert.deepEqual(got, [want]);
- assert.equal(got[0], want); // Note: *NOT* deepEqual!
+ });
});
- });
-
- describe('callHookFnAsync', function () {
- const callHookFnAsync = hooks.exportedForTestingOnly.callHookFnAsync; // Convenience shorthand.
-
- describe('basic behavior', function () {
- it('passes hook name', async function () {
- hook.hook_fn = (hn) => { assert.equal(hn, hookName); };
- await callHookFnAsync(hook);
- });
-
- it('passes context', async function () {
- for (const val of ['value', null, undefined]) {
- hook.hook_fn = (hn, ctx) => { assert.equal(ctx, val); };
- await callHookFnAsync(hook, val);
- }
- });
-
- it('returns the value provided to the callback', async function () {
- for (const val of ['value', null, undefined]) {
- hook.hook_fn = (hn, ctx, cb) => { cb(ctx); };
- assert.equal(await callHookFnAsync(hook, val), val);
- assert.equal(await callHookFnAsync(hook, Promise.resolve(val)), val);
- }
- });
-
- it('returns the value returned by the hook function', async function () {
- for (const val of ['value', null, undefined]) {
- // Must not have the cb parameter otherwise returning undefined will never resolve.
- hook.hook_fn = (hn, ctx) => ctx;
- assert.equal(await callHookFnAsync(hook, val), val);
- assert.equal(await callHookFnAsync(hook, Promise.resolve(val)), val);
- }
- });
-
- it('rejects if it throws an exception', async function () {
- hook.hook_fn = () => { throw new Error('test exception'); };
- await assert.rejects(callHookFnAsync(hook), {message: 'test exception'});
- });
-
- it('rejects if rejected Promise passed to callback', async function () {
- hook.hook_fn = (hn, ctx, cb) => cb(Promise.reject(new Error('test exception')));
- await assert.rejects(callHookFnAsync(hook), {message: 'test exception'});
- });
-
- it('rejects if rejected Promise returned', async function () {
- hook.hook_fn = (hn, ctx, cb) => Promise.reject(new Error('test exception'));
- await assert.rejects(callHookFnAsync(hook), {message: 'test exception'});
- });
-
- it('callback returns undefined', async function () {
- hook.hook_fn = (hn, ctx, cb) => { assert.equal(cb('foo'), undefined); };
- await callHookFnAsync(hook);
- });
-
- it('checks for deprecation', async function () {
- sinon.stub(console, 'warn');
- hooks.deprecationNotices[hookName] = 'test deprecation';
- await callHookFnAsync(hook);
- assert.equal(hooks.exportedForTestingOnly.deprecationWarned[hookFnName], true);
- assert.equal(console.warn.callCount, 1);
- assert.match(console.warn.getCall(0).args[0], /test deprecation/);
- });
+ describe('hooks.callAll', function () {
+ describe('basic behavior', function () {
+ it('calls all in order', async function () {
+ testHooks.length = 0;
+ testHooks.push(makeHook(1), makeHook(2), makeHook(3));
+ assert.deepEqual(hooks.callAll(hookName), [1, 2, 3]);
+ });
+ it('passes hook name', async function () {
+ hook.hook_fn = (hn) => { assert.equal(hn, hookName); };
+ hooks.callAll(hookName);
+ });
+ it('undefined context -> {}', async function () {
+ hook.hook_fn = (hn, ctx) => { assert.deepEqual(ctx, {}); };
+ hooks.callAll(hookName);
+ });
+ it('null context -> {}', async function () {
+ hook.hook_fn = (hn, ctx) => { assert.deepEqual(ctx, {}); };
+ hooks.callAll(hookName, null);
+ });
+ it('context unmodified', async function () {
+ const wantContext = {};
+ hook.hook_fn = (hn, ctx) => { assert.equal(ctx, wantContext); };
+ hooks.callAll(hookName, wantContext);
+ });
+ });
+ describe('result processing', function () {
+ it('no registered hooks (undefined) -> []', async function () {
+ delete plugins.hooks.testHook;
+ assert.deepEqual(hooks.callAll(hookName), []);
+ });
+ it('no registered hooks (empty list) -> []', async function () {
+ testHooks.length = 0;
+ assert.deepEqual(hooks.callAll(hookName), []);
+ });
+ it('flattens one level', async function () {
+ testHooks.length = 0;
+ testHooks.push(makeHook(1), makeHook([2]), makeHook([[3]]));
+ assert.deepEqual(hooks.callAll(hookName), [1, 2, [3]]);
+ });
+ it('filters out undefined', async function () {
+ testHooks.length = 0;
+ testHooks.push(makeHook(), makeHook([2]), makeHook([[3]]));
+ assert.deepEqual(hooks.callAll(hookName), [2, [3]]);
+ });
+ it('preserves null', async function () {
+ testHooks.length = 0;
+ testHooks.push(makeHook(null), makeHook([2]), makeHook([[3]]));
+ assert.deepEqual(hooks.callAll(hookName), [null, 2, [3]]);
+ });
+ it('all undefined -> []', async function () {
+ testHooks.length = 0;
+ testHooks.push(makeHook(), makeHook());
+ assert.deepEqual(hooks.callAll(hookName), []);
+ });
+ });
});
-
- describe('supported hook function styles', function () {
- const supportedHookFunctions = supportedSyncHookFunctions.concat([
- {
- name: 'legacy async cb',
- fn: (hn, ctx, cb) => { process.nextTick(cb, 'val'); },
- want: 'val',
- },
- // Already resolved Promises:
- {
- name: 'return resolved Promise, with callback parameter',
- fn: (hn, ctx, cb) => Promise.resolve('val'),
- want: 'val',
- },
- {
- name: 'return resolved Promise, without callback parameter',
- fn: (hn, ctx) => Promise.resolve('val'),
- want: 'val',
- },
- {
- name: 'pass resolved Promise to callback',
- fn: (hn, ctx, cb) => { cb(Promise.resolve('val')); },
- want: 'val',
- },
- // Not yet resolved Promises:
- {
- name: 'return unresolved Promise, with callback parameter',
- fn: (hn, ctx, cb) => new Promise((resolve) => process.nextTick(resolve, 'val')),
- want: 'val',
- },
- {
- name: 'return unresolved Promise, without callback parameter',
- fn: (hn, ctx) => new Promise((resolve) => process.nextTick(resolve, 'val')),
- want: 'val',
- },
- {
- name: 'pass unresolved Promise to callback',
- fn: (hn, ctx, cb) => { cb(new Promise((resolve) => process.nextTick(resolve, 'val'))); },
- want: 'val',
- },
- // Already rejected Promises:
- {
- name: 'return rejected Promise, with callback parameter',
- fn: (hn, ctx, cb) => Promise.reject(new Error('test rejection')),
- wantErr: 'test rejection',
- },
- {
- name: 'return rejected Promise, without callback parameter',
- fn: (hn, ctx) => Promise.reject(new Error('test rejection')),
- wantErr: 'test rejection',
- },
- {
- name: 'pass rejected Promise to callback',
- fn: (hn, ctx, cb) => { cb(Promise.reject(new Error('test rejection'))); },
- wantErr: 'test rejection',
- },
- // Not yet rejected Promises:
- {
- name: 'return unrejected Promise, with callback parameter',
- fn: (hn, ctx, cb) => new Promise((resolve, reject) => {
- process.nextTick(reject, new Error('test rejection'));
- }),
- wantErr: 'test rejection',
- },
- {
- name: 'return unrejected Promise, without callback parameter',
- fn: (hn, ctx) => new Promise((resolve, reject) => {
- process.nextTick(reject, new Error('test rejection'));
- }),
- wantErr: 'test rejection',
- },
- {
- name: 'pass unrejected Promise to callback',
- fn: (hn, ctx, cb) => {
- cb(new Promise((resolve, reject) => {
- process.nextTick(reject, new Error('test rejection'));
- }));
- },
- wantErr: 'test rejection',
- },
- ]);
-
- for (const tc of supportedSyncHookFunctions.concat(supportedHookFunctions)) {
- it(tc.name, async function () {
- sinon.stub(console, 'warn');
- sinon.stub(console, 'error');
- hook.hook_fn = tc.fn;
- const p = callHookFnAsync(hook);
- if (tc.wantErr) {
- await assert.rejects(p, {message: tc.wantErr});
- } else {
- assert.equal(await p, tc.want);
- }
- assert.equal(console.warn.callCount, 0);
- assert.equal(console.error.callCount, 0);
+ describe('hooks.callFirst', function () {
+ it('no registered hooks (undefined) -> []', async function () {
+ delete plugins.hooks.testHook;
+ assert.deepEqual(hooks.callFirst(hookName), []);
+ });
+ it('no registered hooks (empty list) -> []', async function () {
+ testHooks.length = 0;
+ assert.deepEqual(hooks.callFirst(hookName), []);
+ });
+ it('passes hook name => {}', async function () {
+ hook.hook_fn = (hn) => { assert.equal(hn, hookName); };
+ hooks.callFirst(hookName);
+ });
+ it('undefined context => {}', async function () {
+ hook.hook_fn = (hn, ctx) => { assert.deepEqual(ctx, {}); };
+ hooks.callFirst(hookName);
+ });
+ it('null context => {}', async function () {
+ hook.hook_fn = (hn, ctx) => { assert.deepEqual(ctx, {}); };
+ hooks.callFirst(hookName, null);
+ });
+ it('context unmodified', async function () {
+ const wantContext = {};
+ hook.hook_fn = (hn, ctx) => { assert.equal(ctx, wantContext); };
+ hooks.callFirst(hookName, wantContext);
+ });
+ it('predicate never satisfied -> calls all in order', async function () {
+ const gotCalls = [];
+ testHooks.length = 0;
+ for (let i = 0; i < 3; i++) {
+ const hook = makeHook();
+ hook.hook_fn = () => { gotCalls.push(i); };
+ testHooks.push(hook);
+ }
+ assert.deepEqual(hooks.callFirst(hookName), []);
+ assert.deepEqual(gotCalls, [0, 1, 2]);
+ });
+ it('stops when predicate is satisfied', async function () {
+ testHooks.length = 0;
+ testHooks.push(makeHook(), makeHook('val1'), makeHook('val2'));
+ assert.deepEqual(hooks.callFirst(hookName), ['val1']);
+ });
+ it('skips values that do not satisfy predicate (undefined)', async function () {
+ testHooks.length = 0;
+ testHooks.push(makeHook(), makeHook('val1'));
+ assert.deepEqual(hooks.callFirst(hookName), ['val1']);
+ });
+ it('skips values that do not satisfy predicate (empty list)', async function () {
+ testHooks.length = 0;
+ testHooks.push(makeHook([]), makeHook('val1'));
+ assert.deepEqual(hooks.callFirst(hookName), ['val1']);
+ });
+ it('null satisifes the predicate', async function () {
+ testHooks.length = 0;
+ testHooks.push(makeHook(null), makeHook('val1'));
+ assert.deepEqual(hooks.callFirst(hookName), [null]);
+ });
+ it('non-empty arrays are returned unmodified', async function () {
+ const want = ['val1'];
+ testHooks.length = 0;
+ testHooks.push(makeHook(want), makeHook(['val2']));
+ assert.equal(hooks.callFirst(hookName), want); // Note: *NOT* deepEqual!
+ });
+ it('value can be passed via callback', async function () {
+ const want = {};
+ hook.hook_fn = (hn, ctx, cb) => { cb(want); };
+ const got = hooks.callFirst(hookName);
+ assert.deepEqual(got, [want]);
+ assert.equal(got[0], want); // Note: *NOT* deepEqual!
});
- }
});
-
- // Test various ways a hook might attempt to settle twice. (Examples: call the callback a second
- // time, or call the callback and then return a value.)
- describe('bad hook function behavior (double settle)', function () {
- beforeEach(async function () {
- sinon.stub(console, 'error');
- });
-
- // Each item in this array codifies a way to settle an asynchronous hook function. Each of the
- // test cases below combines two of these behaviors in a single hook function and confirms
- // that callHookFnAsync both (1) resolves to the result of the first settle attempt, and (2)
- // detects the second settle attempt.
- //
- // The 'when' property specifies the relative time that two behaviors will cause the hook
- // function to settle:
- // * If behavior1.when <= behavior2.when and behavior1 is called before behavior2 then
- // behavior1 will settle the hook function before behavior2.
- // * Otherwise, behavior2 will settle the hook function before behavior1.
- const behaviors = [
- {
- name: 'throw',
- fn: (cb, err, val) => { throw err; },
- rejects: true,
- when: 0,
- },
- {
- name: 'return value',
- fn: (cb, err, val) => val,
- // This behavior has a later relative settle time vs. the 'throw' behavior because 'throw'
- // immediately settles the hook function, whereas the 'return value' case is settled by a
- // .then() function attached to a Promise. EcmaScript guarantees that a .then() function
- // attached to a Promise is enqueued on the event loop (not executed immediately) when the
- // Promise settles.
- when: 1,
- },
- {
- name: 'immediately call cb(value)',
- fn: (cb, err, val) => cb(val),
- // This behavior has the same relative time as the 'return value' case because it too is
- // settled by a .then() function attached to a Promise.
- when: 1,
- },
- {
- name: 'return resolvedPromise',
- fn: (cb, err, val) => Promise.resolve(val),
- // This behavior has the same relative time as the 'return value' case because the return
- // value is wrapped in a Promise via Promise.resolve(). The EcmaScript standard guarantees
- // that Promise.resolve(Promise.resolve(value)) is equivalent to Promise.resolve(value),
- // so returning an already resolved Promise vs. returning a non-Promise value are
- // equivalent.
- when: 1,
- },
- {
- name: 'immediately call cb(resolvedPromise)',
- fn: (cb, err, val) => cb(Promise.resolve(val)),
- when: 1,
- },
- {
- name: 'return rejectedPromise',
- fn: (cb, err, val) => Promise.reject(err),
- rejects: true,
- when: 1,
- },
- {
- name: 'immediately call cb(rejectedPromise)',
- fn: (cb, err, val) => cb(Promise.reject(err)),
- rejects: true,
- when: 1,
- },
- {
- name: 'return unresolvedPromise',
- fn: (cb, err, val) => new Promise((resolve) => process.nextTick(resolve, val)),
- when: 2,
- },
- {
- name: 'immediately call cb(unresolvedPromise)',
- fn: (cb, err, val) => cb(new Promise((resolve) => process.nextTick(resolve, val))),
- when: 2,
- },
- {
- name: 'return unrejectedPromise',
- fn: (cb, err, val) => new Promise((resolve, reject) => process.nextTick(reject, err)),
- rejects: true,
- when: 2,
- },
- {
- name: 'immediately call cb(unrejectedPromise)',
- fn: (cb, err, val) => cb(new Promise((resolve, reject) => process.nextTick(reject, err))),
- rejects: true,
- when: 2,
- },
- {
- name: 'defer call to cb(value)',
- fn: (cb, err, val) => { process.nextTick(cb, val); },
- when: 2,
- },
- {
- name: 'defer call to cb(resolvedPromise)',
- fn: (cb, err, val) => { process.nextTick(cb, Promise.resolve(val)); },
- when: 2,
- },
- {
- name: 'defer call to cb(rejectedPromise)',
- fn: (cb, err, val) => { process.nextTick(cb, Promise.reject(err)); },
- rejects: true,
- when: 2,
- },
- {
- name: 'defer call to cb(unresolvedPromise)',
- fn: (cb, err, val) => {
- process.nextTick(() => {
- cb(new Promise((resolve) => process.nextTick(resolve, val)));
+ describe('callHookFnAsync', function () {
+ const callHookFnAsync = hooks.exportedForTestingOnly.callHookFnAsync; // Convenience shorthand.
+ describe('basic behavior', function () {
+ it('passes hook name', async function () {
+ hook.hook_fn = (hn) => { assert.equal(hn, hookName); };
+ await callHookFnAsync(hook);
});
- },
- when: 3,
- },
- {
- name: 'defer call cb(unrejectedPromise)',
- fn: (cb, err, val) => {
- process.nextTick(() => {
- cb(new Promise((resolve, reject) => process.nextTick(reject, err)));
+ it('passes context', async function () {
+ for (const val of ['value', null, undefined]) {
+ hook.hook_fn = (hn, ctx) => { assert.equal(ctx, val); };
+ await callHookFnAsync(hook, val);
+ }
});
- },
- rejects: true,
- when: 3,
- },
- ];
-
- for (const step1 of behaviors) {
- // There can't be a second step if the first step is to return or throw.
- if (step1.name.startsWith('return ') || step1.name === 'throw') continue;
- for (const step2 of behaviors) {
- it(`${step1.name} then ${step2.name} (diff. outcomes) -> log+throw`, async function () {
- hook.hook_fn = (hn, ctx, cb) => {
- step1.fn(cb, new Error(ctx.ret1), ctx.ret1);
- return step2.fn(cb, new Error(ctx.ret2), ctx.ret2);
- };
-
- // Temporarily remove unhandled Promise rejection listeners so that the unhandled
- // rejections we expect to see don't trigger a test failure (or terminate node).
- const event = 'unhandledRejection';
- const listenersBackup = process.rawListeners(event);
- process.removeAllListeners(event);
-
- let tempListener;
- let asyncErr;
- try {
- const seenErrPromise = new Promise((resolve) => {
- tempListener = (err) => {
- assert.equal(asyncErr, undefined);
- asyncErr = err;
- resolve();
- };
- });
- process.on(event, tempListener);
- const step1Wins = step1.when <= step2.when;
- const winningStep = step1Wins ? step1 : step2;
- const winningVal = step1Wins ? 'val1' : 'val2';
- const p = callHookFnAsync(hook, {ret1: 'val1', ret2: 'val2'});
- if (winningStep.rejects) {
- await assert.rejects(p, {message: winningVal});
- } else {
- assert.equal(await p, winningVal);
- }
- await seenErrPromise;
- } finally {
- // Restore the original listeners.
- process.off(event, tempListener);
- for (const listener of listenersBackup) {
- process.on(event, listener);
- }
+ it('returns the value provided to the callback', async function () {
+ for (const val of ['value', null, undefined]) {
+ hook.hook_fn = (hn, ctx, cb) => { cb(ctx); };
+ assert.equal(await callHookFnAsync(hook, val), val);
+ assert.equal(await callHookFnAsync(hook, Promise.resolve(val)), val);
+ }
+ });
+ it('returns the value returned by the hook function', async function () {
+ for (const val of ['value', null, undefined]) {
+ // Must not have the cb parameter otherwise returning undefined will never resolve.
+ hook.hook_fn = (hn, ctx) => ctx;
+ assert.equal(await callHookFnAsync(hook, val), val);
+ assert.equal(await callHookFnAsync(hook, Promise.resolve(val)), val);
+ }
+ });
+ it('rejects if it throws an exception', async function () {
+ hook.hook_fn = () => { throw new Error('test exception'); };
+ await assert.rejects(callHookFnAsync(hook), { message: 'test exception' });
+ });
+ it('rejects if rejected Promise passed to callback', async function () {
+ hook.hook_fn = (hn, ctx, cb) => cb(Promise.reject(new Error('test exception')));
+ await assert.rejects(callHookFnAsync(hook), { message: 'test exception' });
+ });
+ it('rejects if rejected Promise returned', async function () {
+ hook.hook_fn = (hn, ctx, cb) => Promise.reject(new Error('test exception'));
+ await assert.rejects(callHookFnAsync(hook), { message: 'test exception' });
+ });
+ it('callback returns undefined', async function () {
+ hook.hook_fn = (hn, ctx, cb) => { assert.equal(cb('foo'), undefined); };
+ await callHookFnAsync(hook);
+ });
+ it('checks for deprecation', async function () {
+ sinon.stub(console, 'warn');
+ hooks.deprecationNotices[hookName] = 'test deprecation';
+ await callHookFnAsync(hook);
+ assert.equal(hooks.exportedForTestingOnly.deprecationWarned[hookFnName], true);
+ assert.equal(console.warn.callCount, 1);
+ assert.match(console.warn.getCall(0).args[0], /test deprecation/);
+ });
+ });
+ describe('supported hook function styles', function () {
+ const supportedHookFunctions = supportedSyncHookFunctions.concat([
+ {
+ name: 'legacy async cb',
+ fn: (hn, ctx, cb) => { process.nextTick(cb, 'val'); },
+ want: 'val',
+ },
+ // Already resolved Promises:
+ {
+ name: 'return resolved Promise, with callback parameter',
+ fn: (hn, ctx, cb) => Promise.resolve('val'),
+ want: 'val',
+ },
+ {
+ name: 'return resolved Promise, without callback parameter',
+ fn: (hn, ctx) => Promise.resolve('val'),
+ want: 'val',
+ },
+ {
+ name: 'pass resolved Promise to callback',
+ fn: (hn, ctx, cb) => { cb(Promise.resolve('val')); },
+ want: 'val',
+ },
+ // Not yet resolved Promises:
+ {
+ name: 'return unresolved Promise, with callback parameter',
+ fn: (hn, ctx, cb) => new Promise((resolve) => process.nextTick(resolve, 'val')),
+ want: 'val',
+ },
+ {
+ name: 'return unresolved Promise, without callback parameter',
+ fn: (hn, ctx) => new Promise((resolve) => process.nextTick(resolve, 'val')),
+ want: 'val',
+ },
+ {
+ name: 'pass unresolved Promise to callback',
+ fn: (hn, ctx, cb) => { cb(new Promise((resolve) => process.nextTick(resolve, 'val'))); },
+ want: 'val',
+ },
+ // Already rejected Promises:
+ {
+ name: 'return rejected Promise, with callback parameter',
+ fn: (hn, ctx, cb) => Promise.reject(new Error('test rejection')),
+ wantErr: 'test rejection',
+ },
+ {
+ name: 'return rejected Promise, without callback parameter',
+ fn: (hn, ctx) => Promise.reject(new Error('test rejection')),
+ wantErr: 'test rejection',
+ },
+ {
+ name: 'pass rejected Promise to callback',
+ fn: (hn, ctx, cb) => { cb(Promise.reject(new Error('test rejection'))); },
+ wantErr: 'test rejection',
+ },
+ // Not yet rejected Promises:
+ {
+ name: 'return unrejected Promise, with callback parameter',
+ fn: (hn, ctx, cb) => new Promise((resolve, reject) => {
+ process.nextTick(reject, new Error('test rejection'));
+ }),
+ wantErr: 'test rejection',
+ },
+ {
+ name: 'return unrejected Promise, without callback parameter',
+ fn: (hn, ctx) => new Promise((resolve, reject) => {
+ process.nextTick(reject, new Error('test rejection'));
+ }),
+ wantErr: 'test rejection',
+ },
+ {
+ name: 'pass unrejected Promise to callback',
+ fn: (hn, ctx, cb) => {
+ cb(new Promise((resolve, reject) => {
+ process.nextTick(reject, new Error('test rejection'));
+ }));
+ },
+ wantErr: 'test rejection',
+ },
+ ]);
+ for (const tc of supportedSyncHookFunctions.concat(supportedHookFunctions)) {
+ it(tc.name, async function () {
+ sinon.stub(console, 'warn');
+ sinon.stub(console, 'error');
+ hook.hook_fn = tc.fn;
+ const p = callHookFnAsync(hook);
+ if (tc.wantErr) {
+ await assert.rejects(p, { message: tc.wantErr });
+ }
+ else {
+ assert.equal(await p, tc.want);
+ }
+ assert.equal(console.warn.callCount, 0);
+ assert.equal(console.error.callCount, 0);
+ });
}
- assert.equal(console.error.callCount, 1,
- `Got errors:\n${
- console.error.getCalls().map((call) => call.args[0]).join('\n')}`);
- assert.match(console.error.getCall(0).args[0], /DOUBLE SETTLE BUG/);
- assert(asyncErr instanceof Error);
- assert.match(asyncErr.message, /DOUBLE SETTLE BUG/);
- });
-
- // This next test is the same as the above test, except the second settle attempt is for
- // the same outcome. The two outcomes can't be the same if one step rejects and the other
- // doesn't, so skip those cases.
- if (step1.rejects !== step2.rejects) continue;
-
- it(`${step1.name} then ${step2.name} (same outcome) -> only log`, async function () {
- const err = new Error('val');
- hook.hook_fn = (hn, ctx, cb) => {
- step1.fn(cb, err, 'val');
- return step2.fn(cb, err, 'val');
- };
- const winningStep = (step1.when <= step2.when) ? step1 : step2;
- const errorLogged = new Promise((resolve) => console.error.callsFake(resolve));
- const p = callHookFnAsync(hook);
- if (winningStep.rejects) {
- await assert.rejects(p, {message: 'val'});
- } else {
- assert.equal(await p, 'val');
+ });
+ // Test various ways a hook might attempt to settle twice. (Examples: call the callback a second
+ // time, or call the callback and then return a value.)
+ describe('bad hook function behavior (double settle)', function () {
+ beforeEach(async function () {
+ sinon.stub(console, 'error');
+ });
+ // Each item in this array codifies a way to settle an asynchronous hook function. Each of the
+ // test cases below combines two of these behaviors in a single hook function and confirms
+ // that callHookFnAsync both (1) resolves to the result of the first settle attempt, and (2)
+ // detects the second settle attempt.
+ //
+ // The 'when' property specifies the relative time that two behaviors will cause the hook
+ // function to settle:
+ // * If behavior1.when <= behavior2.when and behavior1 is called before behavior2 then
+ // behavior1 will settle the hook function before behavior2.
+ // * Otherwise, behavior2 will settle the hook function before behavior1.
+ const behaviors = [
+ {
+ name: 'throw',
+ fn: (cb, err, val) => { throw err; },
+ rejects: true,
+ when: 0,
+ },
+ {
+ name: 'return value',
+ fn: (cb, err, val) => val,
+ // This behavior has a later relative settle time vs. the 'throw' behavior because 'throw'
+ // immediately settles the hook function, whereas the 'return value' case is settled by a
+ // .then() function attached to a Promise. EcmaScript guarantees that a .then() function
+ // attached to a Promise is enqueued on the event loop (not executed immediately) when the
+ // Promise settles.
+ when: 1,
+ },
+ {
+ name: 'immediately call cb(value)',
+ fn: (cb, err, val) => cb(val),
+ // This behavior has the same relative time as the 'return value' case because it too is
+ // settled by a .then() function attached to a Promise.
+ when: 1,
+ },
+ {
+ name: 'return resolvedPromise',
+ fn: (cb, err, val) => Promise.resolve(val),
+ // This behavior has the same relative time as the 'return value' case because the return
+ // value is wrapped in a Promise via Promise.resolve(). The EcmaScript standard guarantees
+ // that Promise.resolve(Promise.resolve(value)) is equivalent to Promise.resolve(value),
+ // so returning an already resolved Promise vs. returning a non-Promise value are
+ // equivalent.
+ when: 1,
+ },
+ {
+ name: 'immediately call cb(resolvedPromise)',
+ fn: (cb, err, val) => cb(Promise.resolve(val)),
+ when: 1,
+ },
+ {
+ name: 'return rejectedPromise',
+ fn: (cb, err, val) => Promise.reject(err),
+ rejects: true,
+ when: 1,
+ },
+ {
+ name: 'immediately call cb(rejectedPromise)',
+ fn: (cb, err, val) => cb(Promise.reject(err)),
+ rejects: true,
+ when: 1,
+ },
+ {
+ name: 'return unresolvedPromise',
+ fn: (cb, err, val) => new Promise((resolve) => process.nextTick(resolve, val)),
+ when: 2,
+ },
+ {
+ name: 'immediately call cb(unresolvedPromise)',
+ fn: (cb, err, val) => cb(new Promise((resolve) => process.nextTick(resolve, val))),
+ when: 2,
+ },
+ {
+ name: 'return unrejectedPromise',
+ fn: (cb, err, val) => new Promise((resolve, reject) => process.nextTick(reject, err)),
+ rejects: true,
+ when: 2,
+ },
+ {
+ name: 'immediately call cb(unrejectedPromise)',
+ fn: (cb, err, val) => cb(new Promise((resolve, reject) => process.nextTick(reject, err))),
+ rejects: true,
+ when: 2,
+ },
+ {
+ name: 'defer call to cb(value)',
+ fn: (cb, err, val) => { process.nextTick(cb, val); },
+ when: 2,
+ },
+ {
+ name: 'defer call to cb(resolvedPromise)',
+ fn: (cb, err, val) => { process.nextTick(cb, Promise.resolve(val)); },
+ when: 2,
+ },
+ {
+ name: 'defer call to cb(rejectedPromise)',
+ fn: (cb, err, val) => { process.nextTick(cb, Promise.reject(err)); },
+ rejects: true,
+ when: 2,
+ },
+ {
+ name: 'defer call to cb(unresolvedPromise)',
+ fn: (cb, err, val) => {
+ process.nextTick(() => {
+ cb(new Promise((resolve) => process.nextTick(resolve, val)));
+ });
+ },
+ when: 3,
+ },
+ {
+ name: 'defer call cb(unrejectedPromise)',
+ fn: (cb, err, val) => {
+ process.nextTick(() => {
+ cb(new Promise((resolve, reject) => process.nextTick(reject, err)));
+ });
+ },
+ rejects: true,
+ when: 3,
+ },
+ ];
+ for (const step1 of behaviors) {
+ // There can't be a second step if the first step is to return or throw.
+ if (step1.name.startsWith('return ') || step1.name === 'throw')
+ continue;
+ for (const step2 of behaviors) {
+ it(`${step1.name} then ${step2.name} (diff. outcomes) -> log+throw`, async function () {
+ hook.hook_fn = (hn, ctx, cb) => {
+ step1.fn(cb, new Error(ctx.ret1), ctx.ret1);
+ return step2.fn(cb, new Error(ctx.ret2), ctx.ret2);
+ };
+ // Temporarily remove unhandled Promise rejection listeners so that the unhandled
+ // rejections we expect to see don't trigger a test failure (or terminate node).
+ const event = 'unhandledRejection';
+ const listenersBackup = process.rawListeners(event);
+ process.removeAllListeners(event);
+ let tempListener;
+ let asyncErr;
+ try {
+ const seenErrPromise = new Promise((resolve) => {
+ tempListener = (err) => {
+ assert.equal(asyncErr, undefined);
+ asyncErr = err;
+ resolve();
+ };
+ });
+ process.on(event, tempListener);
+ const step1Wins = step1.when <= step2.when;
+ const winningStep = step1Wins ? step1 : step2;
+ const winningVal = step1Wins ? 'val1' : 'val2';
+ const p = callHookFnAsync(hook, { ret1: 'val1', ret2: 'val2' });
+ if (winningStep.rejects) {
+ await assert.rejects(p, { message: winningVal });
+ }
+ else {
+ assert.equal(await p, winningVal);
+ }
+ await seenErrPromise;
+ }
+ finally {
+ // Restore the original listeners.
+ process.off(event, tempListener);
+ for (const listener of listenersBackup) {
+ process.on(event, listener);
+ }
+ }
+ assert.equal(console.error.callCount, 1, `Got errors:\n${console.error.getCalls().map((call) => call.args[0]).join('\n')}`);
+ assert.match(console.error.getCall(0).args[0], /DOUBLE SETTLE BUG/);
+ assert(asyncErr instanceof Error);
+ assert.match(asyncErr.message, /DOUBLE SETTLE BUG/);
+ });
+ // This next test is the same as the above test, except the second settle attempt is for
+ // the same outcome. The two outcomes can't be the same if one step rejects and the other
+ // doesn't, so skip those cases.
+ if (step1.rejects !== step2.rejects)
+ continue;
+ it(`${step1.name} then ${step2.name} (same outcome) -> only log`, async function () {
+ const err = new Error('val');
+ hook.hook_fn = (hn, ctx, cb) => {
+ step1.fn(cb, err, 'val');
+ return step2.fn(cb, err, 'val');
+ };
+ const winningStep = (step1.when <= step2.when) ? step1 : step2;
+ const errorLogged = new Promise((resolve) => console.error.callsFake(resolve));
+ const p = callHookFnAsync(hook);
+ if (winningStep.rejects) {
+ await assert.rejects(p, { message: 'val' });
+ }
+ else {
+ assert.equal(await p, 'val');
+ }
+ await errorLogged;
+ assert.equal(console.error.callCount, 1);
+ assert.match(console.error.getCall(0).args[0], /DOUBLE SETTLE BUG/);
+ });
+ }
}
- await errorLogged;
- assert.equal(console.error.callCount, 1);
- assert.match(console.error.getCall(0).args[0], /DOUBLE SETTLE BUG/);
- });
- }
- }
- });
- });
-
- describe('hooks.aCallAll', function () {
- describe('basic behavior', function () {
- it('calls all asynchronously, returns values in order', async function () {
- testHooks.length = 0; // Delete the boilerplate hook -- this test doesn't use it.
- let nextIndex = 0;
- const hookPromises = [];
- const hookStarted = [];
- const hookFinished = [];
- const makeHook = () => {
- const i = nextIndex++;
- const entry = {};
- hookStarted[i] = false;
- hookFinished[i] = false;
- hookPromises[i] = entry;
- entry.promise = new Promise((resolve) => {
- entry.resolve = () => {
- hookFinished[i] = true;
- resolve(i);
- };
- });
- return {hook_fn: () => {
- hookStarted[i] = true;
- return entry.promise;
- }};
- };
- testHooks.push(makeHook(), makeHook());
- const p = hooks.aCallAll(hookName);
- assert.deepEqual(hookStarted, [true, true]);
- assert.deepEqual(hookFinished, [false, false]);
- hookPromises[1].resolve();
- await hookPromises[1].promise;
- assert.deepEqual(hookFinished, [false, true]);
- hookPromises[0].resolve();
- assert.deepEqual(await p, [0, 1]);
- });
-
- it('passes hook name', async function () {
- hook.hook_fn = async (hn) => { assert.equal(hn, hookName); };
- await hooks.aCallAll(hookName);
- });
-
- it('undefined context -> {}', async function () {
- hook.hook_fn = async (hn, ctx) => { assert.deepEqual(ctx, {}); };
- await hooks.aCallAll(hookName);
- });
-
- it('null context -> {}', async function () {
- hook.hook_fn = async (hn, ctx) => { assert.deepEqual(ctx, {}); };
- await hooks.aCallAll(hookName, null);
- });
-
- it('context unmodified', async function () {
- const wantContext = {};
- hook.hook_fn = async (hn, ctx) => { assert.equal(ctx, wantContext); };
- await hooks.aCallAll(hookName, wantContext);
- });
+ });
});
-
- describe('aCallAll callback', function () {
- it('exception in callback rejects', async function () {
- const p = hooks.aCallAll(hookName, {}, () => { throw new Error('test exception'); });
- await assert.rejects(p, {message: 'test exception'});
- });
-
- it('propagates error on exception', async function () {
- hook.hook_fn = () => { throw new Error('test exception'); };
- await hooks.aCallAll(hookName, {}, (err) => {
- assert(err instanceof Error);
- assert.equal(err.message, 'test exception');
+ describe('hooks.aCallAll', function () {
+ describe('basic behavior', function () {
+ it('calls all asynchronously, returns values in order', async function () {
+ testHooks.length = 0; // Delete the boilerplate hook -- this test doesn't use it.
+ let nextIndex = 0;
+ const hookPromises = [];
+ const hookStarted = [];
+ const hookFinished = [];
+ const makeHook = () => {
+ const i = nextIndex++;
+ const entry = {};
+ hookStarted[i] = false;
+ hookFinished[i] = false;
+ hookPromises[i] = entry;
+ entry.promise = new Promise((resolve) => {
+ entry.resolve = () => {
+ hookFinished[i] = true;
+ resolve(i);
+ };
+ });
+ return { hook_fn: () => {
+ hookStarted[i] = true;
+ return entry.promise;
+ } };
+ };
+ testHooks.push(makeHook(), makeHook());
+ const p = hooks.aCallAll(hookName);
+ assert.deepEqual(hookStarted, [true, true]);
+ assert.deepEqual(hookFinished, [false, false]);
+ hookPromises[1].resolve();
+ await hookPromises[1].promise;
+ assert.deepEqual(hookFinished, [false, true]);
+ hookPromises[0].resolve();
+ assert.deepEqual(await p, [0, 1]);
+ });
+ it('passes hook name', async function () {
+ hook.hook_fn = async (hn) => { assert.equal(hn, hookName); };
+ await hooks.aCallAll(hookName);
+ });
+ it('undefined context -> {}', async function () {
+ hook.hook_fn = async (hn, ctx) => { assert.deepEqual(ctx, {}); };
+ await hooks.aCallAll(hookName);
+ });
+ it('null context -> {}', async function () {
+ hook.hook_fn = async (hn, ctx) => { assert.deepEqual(ctx, {}); };
+ await hooks.aCallAll(hookName, null);
+ });
+ it('context unmodified', async function () {
+ const wantContext = {};
+ hook.hook_fn = async (hn, ctx) => { assert.equal(ctx, wantContext); };
+ await hooks.aCallAll(hookName, wantContext);
+ });
});
- });
-
- it('propagages null error on success', async function () {
- await hooks.aCallAll(hookName, {}, (err) => {
- assert(err == null, `got non-null error: ${err}`);
+ describe('aCallAll callback', function () {
+ it('exception in callback rejects', async function () {
+ const p = hooks.aCallAll(hookName, {}, () => { throw new Error('test exception'); });
+ await assert.rejects(p, { message: 'test exception' });
+ });
+ it('propagates error on exception', async function () {
+ hook.hook_fn = () => { throw new Error('test exception'); };
+ await hooks.aCallAll(hookName, {}, (err) => {
+ assert(err instanceof Error);
+ assert.equal(err.message, 'test exception');
+ });
+ });
+ it('propagages null error on success', async function () {
+ await hooks.aCallAll(hookName, {}, (err) => {
+ assert(err == null, `got non-null error: ${err}`);
+ });
+ });
+ it('propagages results on success', async function () {
+ hook.hook_fn = () => 'val';
+ await hooks.aCallAll(hookName, {}, (err, results) => {
+ assert.deepEqual(results, ['val']);
+ });
+ });
+ it('returns callback return value', async function () {
+ assert.equal(await hooks.aCallAll(hookName, {}, () => 'val'), 'val');
+ });
});
- });
-
- it('propagages results on success', async function () {
- hook.hook_fn = () => 'val';
- await hooks.aCallAll(hookName, {}, (err, results) => {
- assert.deepEqual(results, ['val']);
+ describe('result processing', function () {
+ it('no registered hooks (undefined) -> []', async function () {
+ delete plugins.hooks[hookName];
+ assert.deepEqual(await hooks.aCallAll(hookName), []);
+ });
+ it('no registered hooks (empty list) -> []', async function () {
+ testHooks.length = 0;
+ assert.deepEqual(await hooks.aCallAll(hookName), []);
+ });
+ it('flattens one level', async function () {
+ testHooks.length = 0;
+ testHooks.push(makeHook(1), makeHook([2]), makeHook([[3]]));
+ assert.deepEqual(await hooks.aCallAll(hookName), [1, 2, [3]]);
+ });
+ it('filters out undefined', async function () {
+ testHooks.length = 0;
+ testHooks.push(makeHook(), makeHook([2]), makeHook([[3]]), makeHook(Promise.resolve()));
+ assert.deepEqual(await hooks.aCallAll(hookName), [2, [3]]);
+ });
+ it('preserves null', async function () {
+ testHooks.length = 0;
+ testHooks.push(makeHook(null), makeHook([2]), makeHook(Promise.resolve(null)));
+ assert.deepEqual(await hooks.aCallAll(hookName), [null, 2, null]);
+ });
+ it('all undefined -> []', async function () {
+ testHooks.length = 0;
+ testHooks.push(makeHook(), makeHook(Promise.resolve()));
+ assert.deepEqual(await hooks.aCallAll(hookName), []);
+ });
});
- });
-
- it('returns callback return value', async function () {
- assert.equal(await hooks.aCallAll(hookName, {}, () => 'val'), 'val');
- });
- });
-
- describe('result processing', function () {
- it('no registered hooks (undefined) -> []', async function () {
- delete plugins.hooks[hookName];
- assert.deepEqual(await hooks.aCallAll(hookName), []);
- });
-
- it('no registered hooks (empty list) -> []', async function () {
- testHooks.length = 0;
- assert.deepEqual(await hooks.aCallAll(hookName), []);
- });
-
- it('flattens one level', async function () {
- testHooks.length = 0;
- testHooks.push(makeHook(1), makeHook([2]), makeHook([[3]]));
- assert.deepEqual(await hooks.aCallAll(hookName), [1, 2, [3]]);
- });
-
- it('filters out undefined', async function () {
- testHooks.length = 0;
- testHooks.push(makeHook(), makeHook([2]), makeHook([[3]]), makeHook(Promise.resolve()));
- assert.deepEqual(await hooks.aCallAll(hookName), [2, [3]]);
- });
-
- it('preserves null', async function () {
- testHooks.length = 0;
- testHooks.push(makeHook(null), makeHook([2]), makeHook(Promise.resolve(null)));
- assert.deepEqual(await hooks.aCallAll(hookName), [null, 2, null]);
- });
-
- it('all undefined -> []', async function () {
- testHooks.length = 0;
- testHooks.push(makeHook(), makeHook(Promise.resolve()));
- assert.deepEqual(await hooks.aCallAll(hookName), []);
- });
});
- });
-
- describe('hooks.callAllSerial', function () {
- describe('basic behavior', function () {
- it('calls all asynchronously, serially, in order', async function () {
- const gotCalls = [];
- testHooks.length = 0;
- for (let i = 0; i < 3; i++) {
- const hook = makeHook();
- hook.hook_fn = async () => {
- gotCalls.push(i);
- // Check gotCalls asynchronously to ensure that the next hook function does not start
- // executing before this hook function has resolved.
- return await new Promise((resolve) => {
- setImmediate(() => {
- assert.deepEqual(gotCalls, [...Array(i + 1).keys()]);
- resolve(i);
- });
+ describe('hooks.callAllSerial', function () {
+ describe('basic behavior', function () {
+ it('calls all asynchronously, serially, in order', async function () {
+ const gotCalls = [];
+ testHooks.length = 0;
+ for (let i = 0; i < 3; i++) {
+ const hook = makeHook();
+ hook.hook_fn = async () => {
+ gotCalls.push(i);
+ // Check gotCalls asynchronously to ensure that the next hook function does not start
+ // executing before this hook function has resolved.
+ return await new Promise((resolve) => {
+ setImmediate(() => {
+ assert.deepEqual(gotCalls, [...Array(i + 1).keys()]);
+ resolve(i);
+ });
+ });
+ };
+ testHooks.push(hook);
+ }
+ assert.deepEqual(await hooks.callAllSerial(hookName), [0, 1, 2]);
+ assert.deepEqual(gotCalls, [0, 1, 2]);
});
- };
- testHooks.push(hook);
- }
- assert.deepEqual(await hooks.callAllSerial(hookName), [0, 1, 2]);
- assert.deepEqual(gotCalls, [0, 1, 2]);
- });
-
- it('passes hook name', async function () {
- hook.hook_fn = async (hn) => { assert.equal(hn, hookName); };
- await hooks.callAllSerial(hookName);
- });
-
- it('undefined context -> {}', async function () {
- hook.hook_fn = async (hn, ctx) => { assert.deepEqual(ctx, {}); };
- await hooks.callAllSerial(hookName);
- });
-
- it('null context -> {}', async function () {
- hook.hook_fn = async (hn, ctx) => { assert.deepEqual(ctx, {}); };
- await hooks.callAllSerial(hookName, null);
- });
-
- it('context unmodified', async function () {
- const wantContext = {};
- hook.hook_fn = async (hn, ctx) => { assert.equal(ctx, wantContext); };
- await hooks.callAllSerial(hookName, wantContext);
- });
- });
-
- describe('result processing', function () {
- it('no registered hooks (undefined) -> []', async function () {
- delete plugins.hooks[hookName];
- assert.deepEqual(await hooks.callAllSerial(hookName), []);
- });
-
- it('no registered hooks (empty list) -> []', async function () {
- testHooks.length = 0;
- assert.deepEqual(await hooks.callAllSerial(hookName), []);
- });
-
- it('flattens one level', async function () {
- testHooks.length = 0;
- testHooks.push(makeHook(1), makeHook([2]), makeHook([[3]]));
- assert.deepEqual(await hooks.callAllSerial(hookName), [1, 2, [3]]);
- });
-
- it('filters out undefined', async function () {
- testHooks.length = 0;
- testHooks.push(makeHook(), makeHook([2]), makeHook([[3]]), makeHook(Promise.resolve()));
- assert.deepEqual(await hooks.callAllSerial(hookName), [2, [3]]);
- });
-
- it('preserves null', async function () {
- testHooks.length = 0;
- testHooks.push(makeHook(null), makeHook([2]), makeHook(Promise.resolve(null)));
- assert.deepEqual(await hooks.callAllSerial(hookName), [null, 2, null]);
- });
-
- it('all undefined -> []', async function () {
- testHooks.length = 0;
- testHooks.push(makeHook(), makeHook(Promise.resolve()));
- assert.deepEqual(await hooks.callAllSerial(hookName), []);
- });
- });
- });
-
- describe('hooks.aCallFirst', function () {
- it('no registered hooks (undefined) -> []', async function () {
- delete plugins.hooks.testHook;
- assert.deepEqual(await hooks.aCallFirst(hookName), []);
- });
-
- it('no registered hooks (empty list) -> []', async function () {
- testHooks.length = 0;
- assert.deepEqual(await hooks.aCallFirst(hookName), []);
- });
-
- it('passes hook name => {}', async function () {
- hook.hook_fn = (hn) => { assert.equal(hn, hookName); };
- await hooks.aCallFirst(hookName);
- });
-
- it('undefined context => {}', async function () {
- hook.hook_fn = (hn, ctx) => { assert.deepEqual(ctx, {}); };
- await hooks.aCallFirst(hookName);
- });
-
- it('null context => {}', async function () {
- hook.hook_fn = (hn, ctx) => { assert.deepEqual(ctx, {}); };
- await hooks.aCallFirst(hookName, null);
- });
-
- it('context unmodified', async function () {
- const wantContext = {};
- hook.hook_fn = (hn, ctx) => { assert.equal(ctx, wantContext); };
- await hooks.aCallFirst(hookName, wantContext);
- });
-
- it('default predicate: predicate never satisfied -> calls all in order', async function () {
- const gotCalls = [];
- testHooks.length = 0;
- for (let i = 0; i < 3; i++) {
- const hook = makeHook();
- hook.hook_fn = () => { gotCalls.push(i); };
- testHooks.push(hook);
- }
- assert.deepEqual(await hooks.aCallFirst(hookName), []);
- assert.deepEqual(gotCalls, [0, 1, 2]);
- });
-
- it('calls hook functions serially', async function () {
- const gotCalls = [];
- testHooks.length = 0;
- for (let i = 0; i < 3; i++) {
- const hook = makeHook();
- hook.hook_fn = async () => {
- gotCalls.push(i);
- // Check gotCalls asynchronously to ensure that the next hook function does not start
- // executing before this hook function has resolved.
- return await new Promise((resolve) => {
- setImmediate(() => {
- assert.deepEqual(gotCalls, [...Array(i + 1).keys()]);
- resolve();
+ it('passes hook name', async function () {
+ hook.hook_fn = async (hn) => { assert.equal(hn, hookName); };
+ await hooks.callAllSerial(hookName);
});
- });
- };
- testHooks.push(hook);
- }
- assert.deepEqual(await hooks.aCallFirst(hookName), []);
- assert.deepEqual(gotCalls, [0, 1, 2]);
- });
-
- it('default predicate: stops when satisfied', async function () {
- testHooks.length = 0;
- testHooks.push(makeHook(), makeHook('val1'), makeHook('val2'));
- assert.deepEqual(await hooks.aCallFirst(hookName), ['val1']);
- });
-
- it('default predicate: skips values that do not satisfy (undefined)', async function () {
- testHooks.length = 0;
- testHooks.push(makeHook(), makeHook('val1'));
- assert.deepEqual(await hooks.aCallFirst(hookName), ['val1']);
- });
-
- it('default predicate: skips values that do not satisfy (empty list)', async function () {
- testHooks.length = 0;
- testHooks.push(makeHook([]), makeHook('val1'));
- assert.deepEqual(await hooks.aCallFirst(hookName), ['val1']);
- });
-
- it('default predicate: null satisifes', async function () {
- testHooks.length = 0;
- testHooks.push(makeHook(null), makeHook('val1'));
- assert.deepEqual(await hooks.aCallFirst(hookName), [null]);
- });
-
- it('custom predicate: called for each hook function', async function () {
- testHooks.length = 0;
- testHooks.push(makeHook(0), makeHook(1), makeHook(2));
- let got = 0;
- await hooks.aCallFirst(hookName, null, null, (val) => { ++got; return false; });
- assert.equal(got, 3);
- });
-
- it('custom predicate: boolean false/true continues/stops iteration', async function () {
- testHooks.length = 0;
- testHooks.push(makeHook(1), makeHook(2), makeHook(3));
- let nCall = 0;
- const predicate = (val) => {
- assert.deepEqual(val, [++nCall]);
- return nCall === 2;
- };
- assert.deepEqual(await hooks.aCallFirst(hookName, null, null, predicate), [2]);
- assert.equal(nCall, 2);
- });
-
- it('custom predicate: non-boolean falsy/truthy continues/stops iteration', async function () {
- testHooks.length = 0;
- testHooks.push(makeHook(1), makeHook(2), makeHook(3));
- let nCall = 0;
- const predicate = (val) => {
- assert.deepEqual(val, [++nCall]);
- return nCall === 2 ? {} : null;
- };
- assert.deepEqual(await hooks.aCallFirst(hookName, null, null, predicate), [2]);
- assert.equal(nCall, 2);
- });
-
- it('custom predicate: array value passed unmodified to predicate', async function () {
- const want = [0];
- hook.hook_fn = () => want;
- const predicate = (got) => { assert.equal(got, want); }; // Note: *NOT* deepEqual!
- await hooks.aCallFirst(hookName, null, null, predicate);
- });
-
- it('custom predicate: normalized value passed to predicate (undefined)', async function () {
- const predicate = (got) => { assert.deepEqual(got, []); };
- await hooks.aCallFirst(hookName, null, null, predicate);
- });
-
- it('custom predicate: normalized value passed to predicate (null)', async function () {
- hook.hook_fn = () => null;
- const predicate = (got) => { assert.deepEqual(got, [null]); };
- await hooks.aCallFirst(hookName, null, null, predicate);
- });
-
- it('non-empty arrays are returned unmodified', async function () {
- const want = ['val1'];
- testHooks.length = 0;
- testHooks.push(makeHook(want), makeHook(['val2']));
- assert.equal(await hooks.aCallFirst(hookName), want); // Note: *NOT* deepEqual!
+ it('undefined context -> {}', async function () {
+ hook.hook_fn = async (hn, ctx) => { assert.deepEqual(ctx, {}); };
+ await hooks.callAllSerial(hookName);
+ });
+ it('null context -> {}', async function () {
+ hook.hook_fn = async (hn, ctx) => { assert.deepEqual(ctx, {}); };
+ await hooks.callAllSerial(hookName, null);
+ });
+ it('context unmodified', async function () {
+ const wantContext = {};
+ hook.hook_fn = async (hn, ctx) => { assert.equal(ctx, wantContext); };
+ await hooks.callAllSerial(hookName, wantContext);
+ });
+ });
+ describe('result processing', function () {
+ it('no registered hooks (undefined) -> []', async function () {
+ delete plugins.hooks[hookName];
+ assert.deepEqual(await hooks.callAllSerial(hookName), []);
+ });
+ it('no registered hooks (empty list) -> []', async function () {
+ testHooks.length = 0;
+ assert.deepEqual(await hooks.callAllSerial(hookName), []);
+ });
+ it('flattens one level', async function () {
+ testHooks.length = 0;
+ testHooks.push(makeHook(1), makeHook([2]), makeHook([[3]]));
+ assert.deepEqual(await hooks.callAllSerial(hookName), [1, 2, [3]]);
+ });
+ it('filters out undefined', async function () {
+ testHooks.length = 0;
+ testHooks.push(makeHook(), makeHook([2]), makeHook([[3]]), makeHook(Promise.resolve()));
+ assert.deepEqual(await hooks.callAllSerial(hookName), [2, [3]]);
+ });
+ it('preserves null', async function () {
+ testHooks.length = 0;
+ testHooks.push(makeHook(null), makeHook([2]), makeHook(Promise.resolve(null)));
+ assert.deepEqual(await hooks.callAllSerial(hookName), [null, 2, null]);
+ });
+ it('all undefined -> []', async function () {
+ testHooks.length = 0;
+ testHooks.push(makeHook(), makeHook(Promise.resolve()));
+ assert.deepEqual(await hooks.callAllSerial(hookName), []);
+ });
+ });
});
-
- it('value can be passed via callback', async function () {
- const want = {};
- hook.hook_fn = (hn, ctx, cb) => { cb(want); };
- const got = await hooks.aCallFirst(hookName);
- assert.deepEqual(got, [want]);
- assert.equal(got[0], want); // Note: *NOT* deepEqual!
+ describe('hooks.aCallFirst', function () {
+ it('no registered hooks (undefined) -> []', async function () {
+ delete plugins.hooks.testHook;
+ assert.deepEqual(await hooks.aCallFirst(hookName), []);
+ });
+ it('no registered hooks (empty list) -> []', async function () {
+ testHooks.length = 0;
+ assert.deepEqual(await hooks.aCallFirst(hookName), []);
+ });
+ it('passes hook name => {}', async function () {
+ hook.hook_fn = (hn) => { assert.equal(hn, hookName); };
+ await hooks.aCallFirst(hookName);
+ });
+ it('undefined context => {}', async function () {
+ hook.hook_fn = (hn, ctx) => { assert.deepEqual(ctx, {}); };
+ await hooks.aCallFirst(hookName);
+ });
+ it('null context => {}', async function () {
+ hook.hook_fn = (hn, ctx) => { assert.deepEqual(ctx, {}); };
+ await hooks.aCallFirst(hookName, null);
+ });
+ it('context unmodified', async function () {
+ const wantContext = {};
+ hook.hook_fn = (hn, ctx) => { assert.equal(ctx, wantContext); };
+ await hooks.aCallFirst(hookName, wantContext);
+ });
+ it('default predicate: predicate never satisfied -> calls all in order', async function () {
+ const gotCalls = [];
+ testHooks.length = 0;
+ for (let i = 0; i < 3; i++) {
+ const hook = makeHook();
+ hook.hook_fn = () => { gotCalls.push(i); };
+ testHooks.push(hook);
+ }
+ assert.deepEqual(await hooks.aCallFirst(hookName), []);
+ assert.deepEqual(gotCalls, [0, 1, 2]);
+ });
+ it('calls hook functions serially', async function () {
+ const gotCalls = [];
+ testHooks.length = 0;
+ for (let i = 0; i < 3; i++) {
+ const hook = makeHook();
+ hook.hook_fn = async () => {
+ gotCalls.push(i);
+ // Check gotCalls asynchronously to ensure that the next hook function does not start
+ // executing before this hook function has resolved.
+ return await new Promise((resolve) => {
+ setImmediate(() => {
+ assert.deepEqual(gotCalls, [...Array(i + 1).keys()]);
+ resolve();
+ });
+ });
+ };
+ testHooks.push(hook);
+ }
+ assert.deepEqual(await hooks.aCallFirst(hookName), []);
+ assert.deepEqual(gotCalls, [0, 1, 2]);
+ });
+ it('default predicate: stops when satisfied', async function () {
+ testHooks.length = 0;
+ testHooks.push(makeHook(), makeHook('val1'), makeHook('val2'));
+ assert.deepEqual(await hooks.aCallFirst(hookName), ['val1']);
+ });
+ it('default predicate: skips values that do not satisfy (undefined)', async function () {
+ testHooks.length = 0;
+ testHooks.push(makeHook(), makeHook('val1'));
+ assert.deepEqual(await hooks.aCallFirst(hookName), ['val1']);
+ });
+ it('default predicate: skips values that do not satisfy (empty list)', async function () {
+ testHooks.length = 0;
+ testHooks.push(makeHook([]), makeHook('val1'));
+ assert.deepEqual(await hooks.aCallFirst(hookName), ['val1']);
+ });
+ it('default predicate: null satisifes', async function () {
+ testHooks.length = 0;
+ testHooks.push(makeHook(null), makeHook('val1'));
+ assert.deepEqual(await hooks.aCallFirst(hookName), [null]);
+ });
+ it('custom predicate: called for each hook function', async function () {
+ testHooks.length = 0;
+ testHooks.push(makeHook(0), makeHook(1), makeHook(2));
+ let got = 0;
+ await hooks.aCallFirst(hookName, null, null, (val) => { ++got; return false; });
+ assert.equal(got, 3);
+ });
+ it('custom predicate: boolean false/true continues/stops iteration', async function () {
+ testHooks.length = 0;
+ testHooks.push(makeHook(1), makeHook(2), makeHook(3));
+ let nCall = 0;
+ const predicate = (val) => {
+ assert.deepEqual(val, [++nCall]);
+ return nCall === 2;
+ };
+ assert.deepEqual(await hooks.aCallFirst(hookName, null, null, predicate), [2]);
+ assert.equal(nCall, 2);
+ });
+ it('custom predicate: non-boolean falsy/truthy continues/stops iteration', async function () {
+ testHooks.length = 0;
+ testHooks.push(makeHook(1), makeHook(2), makeHook(3));
+ let nCall = 0;
+ const predicate = (val) => {
+ assert.deepEqual(val, [++nCall]);
+ return nCall === 2 ? {} : null;
+ };
+ assert.deepEqual(await hooks.aCallFirst(hookName, null, null, predicate), [2]);
+ assert.equal(nCall, 2);
+ });
+ it('custom predicate: array value passed unmodified to predicate', async function () {
+ const want = [0];
+ hook.hook_fn = () => want;
+ const predicate = (got) => { assert.equal(got, want); }; // Note: *NOT* deepEqual!
+ await hooks.aCallFirst(hookName, null, null, predicate);
+ });
+ it('custom predicate: normalized value passed to predicate (undefined)', async function () {
+ const predicate = (got) => { assert.deepEqual(got, []); };
+ await hooks.aCallFirst(hookName, null, null, predicate);
+ });
+ it('custom predicate: normalized value passed to predicate (null)', async function () {
+ hook.hook_fn = () => null;
+ const predicate = (got) => { assert.deepEqual(got, [null]); };
+ await hooks.aCallFirst(hookName, null, null, predicate);
+ });
+ it('non-empty arrays are returned unmodified', async function () {
+ const want = ['val1'];
+ testHooks.length = 0;
+ testHooks.push(makeHook(want), makeHook(['val2']));
+ assert.equal(await hooks.aCallFirst(hookName), want); // Note: *NOT* deepEqual!
+ });
+ it('value can be passed via callback', async function () {
+ const want = {};
+ hook.hook_fn = (hn, ctx, cb) => { cb(want); };
+ const got = await hooks.aCallFirst(hookName);
+ assert.deepEqual(got, [want]);
+ assert.equal(got[0], want); // Note: *NOT* deepEqual!
+ });
});
- });
});
diff --git a/src/tests/backend/specs/messages.js b/src/tests/backend/specs/messages.js
index bccb2584dc0..e79a7e3d08b 100644
--- a/src/tests/backend/specs/messages.js
+++ b/src/tests/backend/specs/messages.js
@@ -1,171 +1,159 @@
+import assert$0 from "assert";
+import * as common from "../common.js";
+import * as padManager from "../../../node/db/PadManager.js";
+import * as plugins from "../../../static/js/pluginfw/plugin_defs.js";
+import * as readOnlyManager from "../../../node/db/ReadOnlyManager.js";
'use strict';
-
-const assert = require('assert').strict;
-const common = require('../common');
-const padManager = require('../../../node/db/PadManager');
-const plugins = require('../../../static/js/pluginfw/plugin_defs');
-const readOnlyManager = require('../../../node/db/ReadOnlyManager');
-
+const assert = assert$0.strict;
describe(__filename, function () {
- let agent;
- let pad;
- let padId;
- let roPadId;
- let rev;
- let socket;
- let roSocket;
- const backups = {};
-
- before(async function () {
- agent = await common.init();
- });
-
- beforeEach(async function () {
- backups.hooks = {handleMessageSecurity: plugins.hooks.handleMessageSecurity};
- plugins.hooks.handleMessageSecurity = [];
- padId = common.randomString();
- assert(!await padManager.doesPadExist(padId));
- pad = await padManager.getPad(padId, 'dummy text\n');
- await pad.setText('\n'); // Make sure the pad is created.
- assert.equal(pad.text(), '\n');
- let res = await agent.get(`/p/${padId}`).expect(200);
- socket = await common.connect(res);
- const {type, data: clientVars} = await common.handshake(socket, padId);
- assert.equal(type, 'CLIENT_VARS');
- rev = clientVars.collab_client_vars.rev;
-
- roPadId = await readOnlyManager.getReadOnlyId(padId);
- res = await agent.get(`/p/${roPadId}`).expect(200);
- roSocket = await common.connect(res);
- await common.handshake(roSocket, roPadId);
- });
-
- afterEach(async function () {
- Object.assign(plugins.hooks, backups.hooks);
- if (socket != null) socket.close();
- socket = null;
- if (roSocket != null) roSocket.close();
- roSocket = null;
- if (pad != null) await pad.remove();
- pad = null;
- });
-
- describe('CHANGESET_REQ', function () {
- it('users are unable to read changesets from other pads', async function () {
- const otherPadId = `${padId}other`;
- assert(!await padManager.doesPadExist(otherPadId));
- const otherPad = await padManager.getPad(otherPadId, 'other text\n');
- try {
- await otherPad.setText('other text\n');
- const resP = common.waitForSocketEvent(roSocket, 'message');
- await common.sendMessage(roSocket, {
- component: 'pad',
- padId: otherPadId, // The server should ignore this.
- type: 'CHANGESET_REQ',
- data: {
- granularity: 1,
- start: 0,
- requestID: 'requestId',
- },
- });
- const res = await resP;
- assert.equal(res.type, 'CHANGESET_REQ');
- assert.equal(res.data.requestID, 'requestId');
- // Should match padId's text, not otherPadId's text.
- assert.match(res.data.forwardsChangesets[0], /^[^$]*\$dummy text\n/);
- } finally {
- await otherPad.remove();
- }
- });
- });
-
- describe('USER_CHANGES', function () {
- const sendUserChanges =
- async (socket, cs) => await common.sendUserChanges(socket, {baseRev: rev, changeset: cs});
- const assertAccepted = async (socket, wantRev) => {
- await common.waitForAcceptCommit(socket, wantRev);
- rev = wantRev;
- };
- const assertRejected = async (socket) => {
- const msg = await common.waitForSocketEvent(socket, 'message');
- assert.deepEqual(msg, {disconnect: 'badChangeset'});
- };
-
- it('changes are applied', async function () {
- await Promise.all([
- assertAccepted(socket, rev + 1),
- sendUserChanges(socket, 'Z:1>5+5$hello'),
- ]);
- assert.equal(pad.text(), 'hello\n');
- });
-
- it('bad changeset is rejected', async function () {
- await Promise.all([
- assertRejected(socket),
- sendUserChanges(socket, 'this is not a valid changeset'),
- ]);
+ let agent;
+ let pad;
+ let padId;
+ let roPadId;
+ let rev;
+ let socket;
+ let roSocket;
+ const backups = {};
+ before(async function () {
+ agent = await common.init();
});
-
- it('retransmission is accepted, has no effect', async function () {
- const cs = 'Z:1>5+5$hello';
- await Promise.all([
- assertAccepted(socket, rev + 1),
- sendUserChanges(socket, cs),
- ]);
- --rev;
- await Promise.all([
- assertAccepted(socket, rev + 1),
- sendUserChanges(socket, cs),
- ]);
- assert.equal(pad.text(), 'hello\n');
+ beforeEach(async function () {
+ backups.hooks = { handleMessageSecurity: plugins.hooks.handleMessageSecurity };
+ plugins.hooks.handleMessageSecurity = [];
+ padId = common.randomString();
+ assert(!await padManager.doesPadExist(padId));
+ pad = await padManager.getPad(padId, 'dummy text\n');
+ await pad.setText('\n'); // Make sure the pad is created.
+ assert.equal(pad.text(), '\n');
+ let res = await agent.get(`/p/${padId}`).expect(200);
+ socket = await common.connect(res);
+ const { type, data: clientVars } = await common.handshake(socket, padId);
+ assert.equal(type, 'CLIENT_VARS');
+ rev = clientVars.collab_client_vars.rev;
+ roPadId = await readOnlyManager.getReadOnlyId(padId);
+ res = await agent.get(`/p/${roPadId}`).expect(200);
+ roSocket = await common.connect(res);
+ await common.handshake(roSocket, roPadId);
});
-
- it('identity changeset is accepted, has no effect', async function () {
- await Promise.all([
- assertAccepted(socket, rev + 1),
- sendUserChanges(socket, 'Z:1>5+5$hello'),
- ]);
- await Promise.all([
- assertAccepted(socket, rev),
- sendUserChanges(socket, 'Z:6>0$'),
- ]);
- assert.equal(pad.text(), 'hello\n');
+ afterEach(async function () {
+ Object.assign(plugins.hooks, backups.hooks);
+ if (socket != null)
+ socket.close();
+ socket = null;
+ if (roSocket != null)
+ roSocket.close();
+ roSocket = null;
+ if (pad != null)
+ await pad.remove();
+ pad = null;
});
-
- it('non-identity changeset with no net change is accepted, has no effect', async function () {
- await Promise.all([
- assertAccepted(socket, rev + 1),
- sendUserChanges(socket, 'Z:1>5+5$hello'),
- ]);
- await Promise.all([
- assertAccepted(socket, rev),
- sendUserChanges(socket, 'Z:6>0-5+5$hello'),
- ]);
- assert.equal(pad.text(), 'hello\n');
+ describe('CHANGESET_REQ', function () {
+ it('users are unable to read changesets from other pads', async function () {
+ const otherPadId = `${padId}other`;
+ assert(!await padManager.doesPadExist(otherPadId));
+ const otherPad = await padManager.getPad(otherPadId, 'other text\n');
+ try {
+ await otherPad.setText('other text\n');
+ const resP = common.waitForSocketEvent(roSocket, 'message');
+ await common.sendMessage(roSocket, {
+ component: 'pad',
+ padId: otherPadId,
+ type: 'CHANGESET_REQ',
+ data: {
+ granularity: 1,
+ start: 0,
+ requestID: 'requestId',
+ },
+ });
+ const res = await resP;
+ assert.equal(res.type, 'CHANGESET_REQ');
+ assert.equal(res.data.requestID, 'requestId');
+ // Should match padId's text, not otherPadId's text.
+ assert.match(res.data.forwardsChangesets[0], /^[^$]*\$dummy text\n/);
+ }
+ finally {
+ await otherPad.remove();
+ }
+ });
});
-
- it('handleMessageSecurity can grant one-time write access', async function () {
- const cs = 'Z:1>5+5$hello';
- const errRegEx = /write attempt on read-only pad/;
- // First try to send a change and verify that it was dropped.
- await assert.rejects(sendUserChanges(roSocket, cs), errRegEx);
- // sendUserChanges() waits for message ack, so if the message was accepted then head should
- // have already incremented by the time we get here.
- assert.equal(pad.head, rev); // Not incremented.
-
- // Now allow the change.
- plugins.hooks.handleMessageSecurity.push({hook_fn: () => 'permitOnce'});
- await Promise.all([
- assertAccepted(roSocket, rev + 1),
- sendUserChanges(roSocket, cs),
- ]);
- assert.equal(pad.text(), 'hello\n');
-
- // The next change should be dropped.
- plugins.hooks.handleMessageSecurity = [];
- await assert.rejects(sendUserChanges(roSocket, 'Z:6>6=5+6$ world'), errRegEx);
- assert.equal(pad.head, rev); // Not incremented.
- assert.equal(pad.text(), 'hello\n');
+ describe('USER_CHANGES', function () {
+ const sendUserChanges = async (socket, cs) => await common.sendUserChanges(socket, { baseRev: rev, changeset: cs });
+ const assertAccepted = async (socket, wantRev) => {
+ await common.waitForAcceptCommit(socket, wantRev);
+ rev = wantRev;
+ };
+ const assertRejected = async (socket) => {
+ const msg = await common.waitForSocketEvent(socket, 'message');
+ assert.deepEqual(msg, { disconnect: 'badChangeset' });
+ };
+ it('changes are applied', async function () {
+ await Promise.all([
+ assertAccepted(socket, rev + 1),
+ sendUserChanges(socket, 'Z:1>5+5$hello'),
+ ]);
+ assert.equal(pad.text(), 'hello\n');
+ });
+ it('bad changeset is rejected', async function () {
+ await Promise.all([
+ assertRejected(socket),
+ sendUserChanges(socket, 'this is not a valid changeset'),
+ ]);
+ });
+ it('retransmission is accepted, has no effect', async function () {
+ const cs = 'Z:1>5+5$hello';
+ await Promise.all([
+ assertAccepted(socket, rev + 1),
+ sendUserChanges(socket, cs),
+ ]);
+ --rev;
+ await Promise.all([
+ assertAccepted(socket, rev + 1),
+ sendUserChanges(socket, cs),
+ ]);
+ assert.equal(pad.text(), 'hello\n');
+ });
+ it('identity changeset is accepted, has no effect', async function () {
+ await Promise.all([
+ assertAccepted(socket, rev + 1),
+ sendUserChanges(socket, 'Z:1>5+5$hello'),
+ ]);
+ await Promise.all([
+ assertAccepted(socket, rev),
+ sendUserChanges(socket, 'Z:6>0$'),
+ ]);
+ assert.equal(pad.text(), 'hello\n');
+ });
+ it('non-identity changeset with no net change is accepted, has no effect', async function () {
+ await Promise.all([
+ assertAccepted(socket, rev + 1),
+ sendUserChanges(socket, 'Z:1>5+5$hello'),
+ ]);
+ await Promise.all([
+ assertAccepted(socket, rev),
+ sendUserChanges(socket, 'Z:6>0-5+5$hello'),
+ ]);
+ assert.equal(pad.text(), 'hello\n');
+ });
+ it('handleMessageSecurity can grant one-time write access', async function () {
+ const cs = 'Z:1>5+5$hello';
+ const errRegEx = /write attempt on read-only pad/;
+ // First try to send a change and verify that it was dropped.
+ await assert.rejects(sendUserChanges(roSocket, cs), errRegEx);
+ // sendUserChanges() waits for message ack, so if the message was accepted then head should
+ // have already incremented by the time we get here.
+ assert.equal(pad.head, rev); // Not incremented.
+ // Now allow the change.
+ plugins.hooks.handleMessageSecurity.push({ hook_fn: () => 'permitOnce' });
+ await Promise.all([
+ assertAccepted(roSocket, rev + 1),
+ sendUserChanges(roSocket, cs),
+ ]);
+ assert.equal(pad.text(), 'hello\n');
+ // The next change should be dropped.
+ plugins.hooks.handleMessageSecurity = [];
+ await assert.rejects(sendUserChanges(roSocket, 'Z:6>6=5+6$ world'), errRegEx);
+ assert.equal(pad.head, rev); // Not incremented.
+ assert.equal(pad.text(), 'hello\n');
+ });
});
- });
});
diff --git a/src/tests/backend/specs/pad_utils.js b/src/tests/backend/specs/pad_utils.js
index b4e815187b6..b2adae91c8e 100644
--- a/src/tests/backend/specs/pad_utils.js
+++ b/src/tests/backend/specs/pad_utils.js
@@ -1,43 +1,38 @@
+import assert$0 from "assert";
+import { padutils } from "../../../static/js/pad_utils.js";
'use strict';
-
-const assert = require('assert').strict;
-const {padutils} = require('../../../static/js/pad_utils');
-
+const assert = assert$0.strict;
describe(__filename, function () {
- describe('warnDeprecated', function () {
- const {warnDeprecated} = padutils;
- const backups = {};
-
- before(async function () {
- backups.logger = warnDeprecated.logger;
+ describe('warnDeprecated', function () {
+ const { warnDeprecated } = padutils;
+ const backups = {};
+ before(async function () {
+ backups.logger = warnDeprecated.logger;
+ });
+ afterEach(async function () {
+ warnDeprecated.logger = backups.logger;
+ delete warnDeprecated._rl; // Reset internal rate limiter state.
+ });
+ it('includes the stack', async function () {
+ let got;
+ warnDeprecated.logger = { warn: (stack) => got = stack };
+ warnDeprecated();
+ assert(got.includes(__filename));
+ });
+ it('rate limited', async function () {
+ let got = 0;
+ warnDeprecated.logger = { warn: () => ++got };
+ warnDeprecated(); // Initialize internal rate limiter state.
+ const { period } = warnDeprecated._rl;
+ got = 0;
+ const testCases = [[0, 1], [0, 1], [period - 1, 1], [period, 2]];
+ for (const [now, want] of testCases) { // In a loop so that the stack trace is the same.
+ warnDeprecated._rl.now = () => now;
+ warnDeprecated();
+ assert.equal(got, want);
+ }
+ warnDeprecated(); // Should have a different stack trace.
+ assert.equal(got, testCases[testCases.length - 1][1] + 1);
+ });
});
-
- afterEach(async function () {
- warnDeprecated.logger = backups.logger;
- delete warnDeprecated._rl; // Reset internal rate limiter state.
- });
-
- it('includes the stack', async function () {
- let got;
- warnDeprecated.logger = {warn: (stack) => got = stack};
- warnDeprecated();
- assert(got.includes(__filename));
- });
-
- it('rate limited', async function () {
- let got = 0;
- warnDeprecated.logger = {warn: () => ++got};
- warnDeprecated(); // Initialize internal rate limiter state.
- const {period} = warnDeprecated._rl;
- got = 0;
- const testCases = [[0, 1], [0, 1], [period - 1, 1], [period, 2]];
- for (const [now, want] of testCases) { // In a loop so that the stack trace is the same.
- warnDeprecated._rl.now = () => now;
- warnDeprecated();
- assert.equal(got, want);
- }
- warnDeprecated(); // Should have a different stack trace.
- assert.equal(got, testCases[testCases.length - 1][1] + 1);
- });
- });
});
diff --git a/src/tests/backend/specs/pads-with-spaces.js b/src/tests/backend/specs/pads-with-spaces.js
index 0db99865b80..f855340ff02 100644
--- a/src/tests/backend/specs/pads-with-spaces.js
+++ b/src/tests/backend/specs/pads-with-spaces.js
@@ -1,24 +1,20 @@
+import * as common from "../common.js";
+import assertLegacy from "../assert-legacy.js";
'use strict';
-
-const common = require('../common');
-const assert = require('../assert-legacy').strict;
-
+const assert = assertLegacy.strict;
let agent;
-
describe(__filename, function () {
- before(async function () {
- agent = await common.init();
- });
-
- it('supports pads with spaces, regression test for #4883', async function () {
- await agent.get('/p/pads with spaces')
- .expect(302)
- .expect('location', 'pads_with_spaces');
- });
-
- it('supports pads with spaces and query, regression test for #4883', async function () {
- await agent.get('/p/pads with spaces?showChat=true&noColors=false')
- .expect(302)
- .expect('location', 'pads_with_spaces?showChat=true&noColors=false');
- });
+ before(async function () {
+ agent = await common.init();
+ });
+ it('supports pads with spaces, regression test for #4883', async function () {
+ await agent.get('/p/pads with spaces')
+ .expect(302)
+ .expect('location', 'pads_with_spaces');
+ });
+ it('supports pads with spaces and query, regression test for #4883', async function () {
+ await agent.get('/p/pads with spaces?showChat=true&noColors=false')
+ .expect(302)
+ .expect('location', 'pads_with_spaces?showChat=true&noColors=false');
+ });
});
diff --git a/src/tests/backend/specs/promises.js b/src/tests/backend/specs/promises.js
index ad0c1ad9269..45fb135cb9b 100644
--- a/src/tests/backend/specs/promises.js
+++ b/src/tests/backend/specs/promises.js
@@ -1,85 +1,76 @@
-const assert = require('assert').strict;
-const promises = require('../../../node/utils/promises');
-
+import assert$0 from "assert";
+import * as promises from "../../../node/utils/promises.js";
+const assert = assert$0.strict;
describe(__filename, function () {
- describe('promises.timesLimit', function () {
- let wantIndex = 0;
- const testPromises = [];
- const makePromise = (index) => {
- // Make sure index increases by one each time.
- assert.equal(index, wantIndex++);
- // Save the resolve callback (so the test can trigger resolution)
- // and the promise itself (to wait for resolve to take effect).
- const p = {};
- const promise = new Promise((resolve) => {
- p.resolve = resolve;
- });
- p.promise = promise;
- testPromises.push(p);
- return p.promise;
- };
-
- const total = 11;
- const concurrency = 7;
- const timesLimitPromise = promises.timesLimit(total, concurrency, makePromise);
-
- it('honors concurrency', async function () {
- assert.equal(wantIndex, concurrency);
+ describe('promises.timesLimit', function () {
+ let wantIndex = 0;
+ const testPromises = [];
+ const makePromise = (index) => {
+ // Make sure index increases by one each time.
+ assert.equal(index, wantIndex++);
+ // Save the resolve callback (so the test can trigger resolution)
+ // and the promise itself (to wait for resolve to take effect).
+ const p = {};
+ const promise = new Promise((resolve) => {
+ p.resolve = resolve;
+ });
+ p.promise = promise;
+ testPromises.push(p);
+ return p.promise;
+ };
+ const total = 11;
+ const concurrency = 7;
+ const timesLimitPromise = promises.timesLimit(total, concurrency, makePromise);
+ it('honors concurrency', async function () {
+ assert.equal(wantIndex, concurrency);
+ });
+ it('creates another when one completes', async function () {
+ const { promise, resolve } = testPromises.shift();
+ resolve();
+ await promise;
+ assert.equal(wantIndex, concurrency + 1);
+ });
+ it('creates the expected total number of promises', async function () {
+ while (testPromises.length > 0) {
+ // Resolve them in random order to ensure that the resolution order doesn't matter.
+ const i = Math.floor(Math.random() * Math.floor(testPromises.length));
+ const { promise, resolve } = testPromises.splice(i, 1)[0];
+ resolve();
+ await promise;
+ }
+ assert.equal(wantIndex, total);
+ });
+ it('resolves', async function () {
+ await timesLimitPromise;
+ });
+ it('does not create too many promises if total < concurrency', async function () {
+ wantIndex = 0;
+ assert.equal(testPromises.length, 0);
+ const total = 7;
+ const concurrency = 11;
+ const timesLimitPromise = promises.timesLimit(total, concurrency, makePromise);
+ while (testPromises.length > 0) {
+ const { promise, resolve } = testPromises.pop();
+ resolve();
+ await promise;
+ }
+ await timesLimitPromise;
+ assert.equal(wantIndex, total);
+ });
+ it('accepts total === 0, concurrency > 0', async function () {
+ wantIndex = 0;
+ assert.equal(testPromises.length, 0);
+ await promises.timesLimit(0, concurrency, makePromise);
+ assert.equal(wantIndex, 0);
+ });
+ it('accepts total === 0, concurrency === 0', async function () {
+ wantIndex = 0;
+ assert.equal(testPromises.length, 0);
+ await promises.timesLimit(0, 0, makePromise);
+ assert.equal(wantIndex, 0);
+ });
+ it('rejects total > 0, concurrency === 0', async function () {
+ await assert.rejects(promises.timesLimit(total, 0, makePromise), RangeError);
+ });
});
-
- it('creates another when one completes', async function () {
- const {promise, resolve} = testPromises.shift();
- resolve();
- await promise;
- assert.equal(wantIndex, concurrency + 1);
- });
-
- it('creates the expected total number of promises', async function () {
- while (testPromises.length > 0) {
- // Resolve them in random order to ensure that the resolution order doesn't matter.
- const i = Math.floor(Math.random() * Math.floor(testPromises.length));
- const {promise, resolve} = testPromises.splice(i, 1)[0];
- resolve();
- await promise;
- }
- assert.equal(wantIndex, total);
- });
-
- it('resolves', async function () {
- await timesLimitPromise;
- });
-
- it('does not create too many promises if total < concurrency', async function () {
- wantIndex = 0;
- assert.equal(testPromises.length, 0);
- const total = 7;
- const concurrency = 11;
- const timesLimitPromise = promises.timesLimit(total, concurrency, makePromise);
- while (testPromises.length > 0) {
- const {promise, resolve} = testPromises.pop();
- resolve();
- await promise;
- }
- await timesLimitPromise;
- assert.equal(wantIndex, total);
- });
-
- it('accepts total === 0, concurrency > 0', async function () {
- wantIndex = 0;
- assert.equal(testPromises.length, 0);
- await promises.timesLimit(0, concurrency, makePromise);
- assert.equal(wantIndex, 0);
- });
-
- it('accepts total === 0, concurrency === 0', async function () {
- wantIndex = 0;
- assert.equal(testPromises.length, 0);
- await promises.timesLimit(0, 0, makePromise);
- assert.equal(wantIndex, 0);
- });
-
- it('rejects total > 0, concurrency === 0', async function () {
- await assert.rejects(promises.timesLimit(total, 0, makePromise), RangeError);
- });
- });
});
diff --git a/src/tests/backend/specs/regression-db.js b/src/tests/backend/specs/regression-db.js
index 388b8346ab4..aa81bace2db 100644
--- a/src/tests/backend/specs/regression-db.js
+++ b/src/tests/backend/specs/regression-db.js
@@ -1,30 +1,25 @@
+import * as AuthorManager from "../../../node/db/AuthorManager.js";
+import assert$0 from "assert";
+import * as common from "../common.js";
+import * as db from "../../../node/db/DB.js";
'use strict';
-
-const AuthorManager = require('../../../node/db/AuthorManager');
-const assert = require('assert').strict;
-const common = require('../common');
-const db = require('../../../node/db/DB');
-
+const assert = assert$0.strict;
describe(__filename, function () {
- let setBackup;
-
- before(async function () {
- await common.init();
- setBackup = db.set;
-
- db.set = async (...args) => {
- // delay db.set
- await new Promise((resolve) => { setTimeout(() => resolve(), 500); });
- return await setBackup.call(db, ...args);
- };
- });
-
- after(async function () {
- db.set = setBackup;
- });
-
- it('regression test for missing await in createAuthor (#5000)', async function () {
- const {authorID} = await AuthorManager.createAuthor(); // Should block until db.set() finishes.
- assert(await AuthorManager.doesAuthorExist(authorID));
- });
+ let setBackup;
+ before(async function () {
+ await common.init();
+ setBackup = db.set;
+ db.set = async (...args) => {
+ // delay db.set
+ await new Promise((resolve) => { setTimeout(() => resolve(), 500); });
+ return await setBackup.call(db, ...args);
+ };
+ });
+ after(async function () {
+ db.set = setBackup;
+ });
+ it('regression test for missing await in createAuthor (#5000)', async function () {
+ const { authorID } = await AuthorManager.createAuthor(); // Should block until db.set() finishes.
+ assert(await AuthorManager.doesAuthorExist(authorID));
+ });
});
diff --git a/src/tests/backend/specs/sanitizePathname.js b/src/tests/backend/specs/sanitizePathname.js
index 767221920dd..c99f3aafec6 100644
--- a/src/tests/backend/specs/sanitizePathname.js
+++ b/src/tests/backend/specs/sanitizePathname.js
@@ -1,96 +1,93 @@
+import assert$0 from "assert";
+import path from "path";
+import sanitizePathname from "../../../node/utils/sanitizePathname.js";
'use strict';
-
-const assert = require('assert').strict;
-const path = require('path');
-const sanitizePathname = require('../../../node/utils/sanitizePathname');
-
+const assert = assert$0.strict;
describe(__filename, function () {
- describe('absolute paths rejected', function () {
- const testCases = [
- ['posix', '/'],
- ['posix', '/foo'],
- ['win32', '/'],
- ['win32', '\\'],
- ['win32', 'C:/foo'],
- ['win32', 'C:\\foo'],
- ['win32', 'c:/foo'],
- ['win32', 'c:\\foo'],
- ['win32', '/foo'],
- ['win32', '\\foo'],
- ];
- for (const [platform, p] of testCases) {
- it(`${platform} ${p}`, async function () {
- assert.throws(() => sanitizePathname(p, path[platform]), {message: /absolute path/});
- });
- }
- });
- describe('directory traversal rejected', function () {
- const testCases = [
- ['posix', '..'],
- ['posix', '../'],
- ['posix', '../foo'],
- ['posix', 'foo/../..'],
- ['win32', '..'],
- ['win32', '../'],
- ['win32', '..\\'],
- ['win32', '../foo'],
- ['win32', '..\\foo'],
- ['win32', 'foo/../..'],
- ['win32', 'foo\\..\\..'],
- ];
- for (const [platform, p] of testCases) {
- it(`${platform} ${p}`, async function () {
- assert.throws(() => sanitizePathname(p, path[platform]), {message: /travers/});
- });
- }
- });
-
- describe('accepted paths', function () {
- const testCases = [
- ['posix', '', '.'],
- ['posix', '.'],
- ['posix', './'],
- ['posix', 'foo'],
- ['posix', 'foo/'],
- ['posix', 'foo/bar/..', 'foo'],
- ['posix', 'foo/bar/../', 'foo/'],
- ['posix', './foo', 'foo'],
- ['posix', 'foo/bar'],
- ['posix', 'foo\\bar'],
- ['posix', '\\foo'],
- ['posix', '..\\foo'],
- ['posix', 'foo/../bar', 'bar'],
- ['posix', 'C:/foo'],
- ['posix', 'C:\\foo'],
- ['win32', '', '.'],
- ['win32', '.'],
- ['win32', './'],
- ['win32', '.\\', './'],
- ['win32', 'foo'],
- ['win32', 'foo/'],
- ['win32', 'foo\\', 'foo/'],
- ['win32', 'foo/bar/..', 'foo'],
- ['win32', 'foo\\bar\\..', 'foo'],
- ['win32', 'foo/bar/../', 'foo/'],
- ['win32', 'foo\\bar\\..\\', 'foo/'],
- ['win32', './foo', 'foo'],
- ['win32', '.\\foo', 'foo'],
- ['win32', 'foo/bar'],
- ['win32', 'foo\\bar', 'foo/bar'],
- ['win32', 'foo/../bar', 'bar'],
- ['win32', 'foo\\..\\bar', 'bar'],
- ['win32', 'foo/..\\bar', 'bar'],
- ['win32', 'foo\\../bar', 'bar'],
- ];
- for (const [platform, p, tcWant] of testCases) {
- const want = tcWant == null ? p : tcWant;
- it(`${platform} ${p || ''} -> ${want}`, async function () {
- assert.equal(sanitizePathname(p, path[platform]), want);
- });
- }
- });
-
- it('default path API', async function () {
- assert.equal(sanitizePathname('foo'), 'foo');
- });
+ describe('absolute paths rejected', function () {
+ const testCases = [
+ ['posix', '/'],
+ ['posix', '/foo'],
+ ['win32', '/'],
+ ['win32', '\\'],
+ ['win32', 'C:/foo'],
+ ['win32', 'C:\\foo'],
+ ['win32', 'c:/foo'],
+ ['win32', 'c:\\foo'],
+ ['win32', '/foo'],
+ ['win32', '\\foo'],
+ ];
+ for (const [platform, p] of testCases) {
+ it(`${platform} ${p}`, async function () {
+ assert.throws(() => sanitizePathname(p, path[platform]), { message: /absolute path/ });
+ });
+ }
+ });
+ describe('directory traversal rejected', function () {
+ const testCases = [
+ ['posix', '..'],
+ ['posix', '../'],
+ ['posix', '../foo'],
+ ['posix', 'foo/../..'],
+ ['win32', '..'],
+ ['win32', '../'],
+ ['win32', '..\\'],
+ ['win32', '../foo'],
+ ['win32', '..\\foo'],
+ ['win32', 'foo/../..'],
+ ['win32', 'foo\\..\\..'],
+ ];
+ for (const [platform, p] of testCases) {
+ it(`${platform} ${p}`, async function () {
+ assert.throws(() => sanitizePathname(p, path[platform]), { message: /travers/ });
+ });
+ }
+ });
+ describe('accepted paths', function () {
+ const testCases = [
+ ['posix', '', '.'],
+ ['posix', '.'],
+ ['posix', './'],
+ ['posix', 'foo'],
+ ['posix', 'foo/'],
+ ['posix', 'foo/bar/..', 'foo'],
+ ['posix', 'foo/bar/../', 'foo/'],
+ ['posix', './foo', 'foo'],
+ ['posix', 'foo/bar'],
+ ['posix', 'foo\\bar'],
+ ['posix', '\\foo'],
+ ['posix', '..\\foo'],
+ ['posix', 'foo/../bar', 'bar'],
+ ['posix', 'C:/foo'],
+ ['posix', 'C:\\foo'],
+ ['win32', '', '.'],
+ ['win32', '.'],
+ ['win32', './'],
+ ['win32', '.\\', './'],
+ ['win32', 'foo'],
+ ['win32', 'foo/'],
+ ['win32', 'foo\\', 'foo/'],
+ ['win32', 'foo/bar/..', 'foo'],
+ ['win32', 'foo\\bar\\..', 'foo'],
+ ['win32', 'foo/bar/../', 'foo/'],
+ ['win32', 'foo\\bar\\..\\', 'foo/'],
+ ['win32', './foo', 'foo'],
+ ['win32', '.\\foo', 'foo'],
+ ['win32', 'foo/bar'],
+ ['win32', 'foo\\bar', 'foo/bar'],
+ ['win32', 'foo/../bar', 'bar'],
+ ['win32', 'foo\\..\\bar', 'bar'],
+ ['win32', 'foo/..\\bar', 'bar'],
+ ['win32', 'foo\\../bar', 'bar'],
+ ];
+ for (const [platform, p, tcWant] of testCases) {
+ const want = tcWant == null ? p : tcWant;
+ it(`${platform} ${p || ''} -> ${want}`, async function () {
+ assert.equal(sanitizePathname(p, path[platform]), want);
+ });
+ }
+ });
+ it('default path API', async function () {
+ assert.equal(sanitizePathname('foo'), 'foo');
+ });
});
diff --git a/src/tests/backend/specs/settings.js b/src/tests/backend/specs/settings.js
index e737f4f3445..6de6fae4110 100644
--- a/src/tests/backend/specs/settings.js
+++ b/src/tests/backend/specs/settings.js
@@ -1,61 +1,60 @@
+import assert$0 from "assert";
+import { exportedForTestingOnly } from "../../../node/utils/Settings.js";
+import path from "path";
+import process from "process";
'use strict';
-
-const assert = require('assert').strict;
-const {parseSettings} = require('../../../node/utils/Settings').exportedForTestingOnly;
-const path = require('path');
-const process = require('process');
-
+const assert = assert$0.strict;
+const { parseSettings } = { exportedForTestingOnly }.exportedForTestingOnly;
describe(__filename, function () {
- describe('parseSettings', function () {
- let settings;
- const envVarSubstTestCases = [
- {name: 'true', val: 'true', var: 'SET_VAR_TRUE', want: true},
- {name: 'false', val: 'false', var: 'SET_VAR_FALSE', want: false},
- {name: 'null', val: 'null', var: 'SET_VAR_NULL', want: null},
- {name: 'undefined', val: 'undefined', var: 'SET_VAR_UNDEFINED', want: undefined},
- {name: 'number', val: '123', var: 'SET_VAR_NUMBER', want: 123},
- {name: 'string', val: 'foo', var: 'SET_VAR_STRING', want: 'foo'},
- {name: 'empty string', val: '', var: 'SET_VAR_EMPTY_STRING', want: ''},
- ];
-
- before(async function () {
- for (const tc of envVarSubstTestCases) process.env[tc.var] = tc.val;
- delete process.env.UNSET_VAR;
- settings = parseSettings(path.join(__dirname, 'settings.json'), true);
- assert(settings != null);
- });
-
- describe('environment variable substitution', function () {
- describe('set', function () {
- for (const tc of envVarSubstTestCases) {
- it(tc.name, async function () {
- const obj = settings['environment variable substitution'].set;
- if (tc.name === 'undefined') {
- assert(!(tc.name in obj));
- } else {
- assert.equal(obj[tc.name], tc.want);
- }
- });
- }
- });
-
- describe('unset', function () {
- it('no default', async function () {
- const obj = settings['environment variable substitution'].unset;
- assert.equal(obj['no default'], null);
+ describe('parseSettings', function () {
+ let settings;
+ const envVarSubstTestCases = [
+ { name: 'true', val: 'true', var: 'SET_VAR_TRUE', want: true },
+ { name: 'false', val: 'false', var: 'SET_VAR_FALSE', want: false },
+ { name: 'null', val: 'null', var: 'SET_VAR_NULL', want: null },
+ { name: 'undefined', val: 'undefined', var: 'SET_VAR_UNDEFINED', want: undefined },
+ { name: 'number', val: '123', var: 'SET_VAR_NUMBER', want: 123 },
+ { name: 'string', val: 'foo', var: 'SET_VAR_STRING', want: 'foo' },
+ { name: 'empty string', val: '', var: 'SET_VAR_EMPTY_STRING', want: '' },
+ ];
+ before(async function () {
+ for (const tc of envVarSubstTestCases)
+ process.env[tc.var] = tc.val;
+ delete process.env.UNSET_VAR;
+ settings = parseSettings(path.join(__dirname, 'settings.json'), true);
+ assert(settings != null);
+ });
+ describe('environment variable substitution', function () {
+ describe('set', function () {
+ for (const tc of envVarSubstTestCases) {
+ it(tc.name, async function () {
+ const obj = settings['environment variable substitution'].set;
+ if (tc.name === 'undefined') {
+ assert(!(tc.name in obj));
+ }
+ else {
+ assert.equal(obj[tc.name], tc.want);
+ }
+ });
+ }
+ });
+ describe('unset', function () {
+ it('no default', async function () {
+ const obj = settings['environment variable substitution'].unset;
+ assert.equal(obj['no default'], null);
+ });
+ for (const tc of envVarSubstTestCases) {
+ it(tc.name, async function () {
+ const obj = settings['environment variable substitution'].unset;
+ if (tc.name === 'undefined') {
+ assert(!(tc.name in obj));
+ }
+ else {
+ assert.equal(obj[tc.name], tc.want);
+ }
+ });
+ }
+ });
});
-
- for (const tc of envVarSubstTestCases) {
- it(tc.name, async function () {
- const obj = settings['environment variable substitution'].unset;
- if (tc.name === 'undefined') {
- assert(!(tc.name in obj));
- } else {
- assert.equal(obj[tc.name], tc.want);
- }
- });
- }
- });
});
- });
});
diff --git a/src/tests/backend/specs/socketio.js b/src/tests/backend/specs/socketio.js
index 15f56177499..7f95d648a61 100644
--- a/src/tests/backend/specs/socketio.js
+++ b/src/tests/backend/specs/socketio.js
@@ -1,426 +1,405 @@
+import assert$0 from "assert";
+import * as common from "../common.js";
+import * as padManager from "../../../node/db/PadManager.js";
+import * as plugins from "../../../static/js/pluginfw/plugin_defs.js";
+import * as readOnlyManager from "../../../node/db/ReadOnlyManager.js";
+import * as settings from "../../../node/utils/Settings.js";
+import * as socketIoRouter from "../../../node/handler/SocketIORouter.js";
'use strict';
-
-const assert = require('assert').strict;
-const common = require('../common');
-const padManager = require('../../../node/db/PadManager');
-const plugins = require('../../../static/js/pluginfw/plugin_defs');
-const readOnlyManager = require('../../../node/db/ReadOnlyManager');
-const settings = require('../../../node/utils/Settings');
-const socketIoRouter = require('../../../node/handler/SocketIORouter');
-
+const assert = assert$0.strict;
describe(__filename, function () {
- this.timeout(30000);
- let agent;
- let authorize;
- const backups = {};
- const cleanUpPads = async () => {
- const padIds = ['pad', 'other-pad', 'päd'];
- await Promise.all(padIds.map(async (padId) => {
- if (await padManager.doesPadExist(padId)) {
- const pad = await padManager.getPad(padId);
- await pad.remove();
- }
- }));
- };
- let socket;
-
- before(async function () { agent = await common.init(); });
- beforeEach(async function () {
- backups.hooks = {};
- for (const hookName of ['preAuthorize', 'authenticate', 'authorize']) {
- backups.hooks[hookName] = plugins.hooks[hookName];
- plugins.hooks[hookName] = [];
- }
- backups.settings = {};
- for (const setting of ['editOnly', 'requireAuthentication', 'requireAuthorization', 'users']) {
- backups.settings[setting] = settings[setting];
- }
- settings.editOnly = false;
- settings.requireAuthentication = false;
- settings.requireAuthorization = false;
- settings.users = {
- admin: {password: 'admin-password', is_admin: true},
- user: {password: 'user-password'},
+ this.timeout(30000);
+ let agent;
+ let authorize;
+ const backups = {};
+ const cleanUpPads = async () => {
+ const padIds = ['pad', 'other-pad', 'päd'];
+ await Promise.all(padIds.map(async (padId) => {
+ if (await padManager.doesPadExist(padId)) {
+ const pad = await padManager.getPad(padId);
+ await pad.remove();
+ }
+ }));
};
- assert(socket == null);
- authorize = () => true;
- plugins.hooks.authorize = [{hook_fn: (hookName, {req}, cb) => cb([authorize(req)])}];
- await cleanUpPads();
- });
- afterEach(async function () {
- if (socket) socket.close();
- socket = null;
- await cleanUpPads();
- Object.assign(plugins.hooks, backups.hooks);
- Object.assign(settings, backups.settings);
- });
-
- describe('Normal accesses', function () {
- it('!authn anonymous cookie /p/pad -> 200, ok', async function () {
- const res = await agent.get('/p/pad').expect(200);
- socket = await common.connect(res);
- const clientVars = await common.handshake(socket, 'pad');
- assert.equal(clientVars.type, 'CLIENT_VARS');
- });
- it('!authn !cookie -> ok', async function () {
- socket = await common.connect(null);
- const clientVars = await common.handshake(socket, 'pad');
- assert.equal(clientVars.type, 'CLIENT_VARS');
- });
- it('!authn user /p/pad -> 200, ok', async function () {
- const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
- socket = await common.connect(res);
- const clientVars = await common.handshake(socket, 'pad');
- assert.equal(clientVars.type, 'CLIENT_VARS');
- });
- it('authn user /p/pad -> 200, ok', async function () {
- settings.requireAuthentication = true;
- const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
- socket = await common.connect(res);
- const clientVars = await common.handshake(socket, 'pad');
- assert.equal(clientVars.type, 'CLIENT_VARS');
- });
-
- for (const authn of [false, true]) {
- const desc = authn ? 'authn user' : '!authn anonymous';
- it(`${desc} read-only /p/pad -> 200, ok`, async function () {
- const get = (ep) => {
- let res = agent.get(ep);
- if (authn) res = res.auth('user', 'user-password');
- return res.expect(200);
- };
- settings.requireAuthentication = authn;
- let res = await get('/p/pad');
- socket = await common.connect(res);
- let clientVars = await common.handshake(socket, 'pad');
- assert.equal(clientVars.type, 'CLIENT_VARS');
- assert.equal(clientVars.data.readonly, false);
- const readOnlyId = clientVars.data.readOnlyId;
- assert(readOnlyManager.isReadOnlyId(readOnlyId));
- socket.close();
- res = await get(`/p/${readOnlyId}`);
- socket = await common.connect(res);
- clientVars = await common.handshake(socket, readOnlyId);
- assert.equal(clientVars.type, 'CLIENT_VARS');
- assert.equal(clientVars.data.readonly, true);
- });
- }
-
- it('authz user /p/pad -> 200, ok', async function () {
- settings.requireAuthentication = true;
- settings.requireAuthorization = true;
- const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
- socket = await common.connect(res);
- const clientVars = await common.handshake(socket, 'pad');
- assert.equal(clientVars.type, 'CLIENT_VARS');
- });
- it('supports pad names with characters that must be percent-encoded', async function () {
- settings.requireAuthentication = true;
- // requireAuthorization is set to true here to guarantee that the user's padAuthorizations
- // object is populated. Technically this isn't necessary because the user's padAuthorizations
- // is currently populated even if requireAuthorization is false, but setting this to true
- // ensures the test remains useful if the implementation ever changes.
- settings.requireAuthorization = true;
- const encodedPadId = encodeURIComponent('päd');
- const res = await agent.get(`/p/${encodedPadId}`).auth('user', 'user-password').expect(200);
- socket = await common.connect(res);
- const clientVars = await common.handshake(socket, 'päd');
- assert.equal(clientVars.type, 'CLIENT_VARS');
- });
- });
-
- describe('Abnormal access attempts', function () {
- it('authn anonymous /p/pad -> 401, error', async function () {
- settings.requireAuthentication = true;
- const res = await agent.get('/p/pad').expect(401);
- // Despite the 401, try to create the pad via a socket.io connection anyway.
- socket = await common.connect(res);
- const message = await common.handshake(socket, 'pad');
- assert.equal(message.accessStatus, 'deny');
- });
-
- it('authn anonymous read-only /p/pad -> 401, error', async function () {
- settings.requireAuthentication = true;
- let res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
- socket = await common.connect(res);
- const clientVars = await common.handshake(socket, 'pad');
- assert.equal(clientVars.type, 'CLIENT_VARS');
- const readOnlyId = clientVars.data.readOnlyId;
- assert(readOnlyManager.isReadOnlyId(readOnlyId));
- socket.close();
- res = await agent.get(`/p/${readOnlyId}`).expect(401);
- // Despite the 401, try to read the pad via a socket.io connection anyway.
- socket = await common.connect(res);
- const message = await common.handshake(socket, readOnlyId);
- assert.equal(message.accessStatus, 'deny');
- });
-
- it('authn !cookie -> error', async function () {
- settings.requireAuthentication = true;
- socket = await common.connect(null);
- const message = await common.handshake(socket, 'pad');
- assert.equal(message.accessStatus, 'deny');
- });
- it('authorization bypass attempt -> error', async function () {
- // Only allowed to access /p/pad.
- authorize = (req) => req.path === '/p/pad';
- settings.requireAuthentication = true;
- settings.requireAuthorization = true;
- // First authenticate and establish a session.
- const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
- socket = await common.connect(res);
- // Accessing /p/other-pad should fail, despite the successful fetch of /p/pad.
- const message = await common.handshake(socket, 'other-pad');
- assert.equal(message.accessStatus, 'deny');
- });
- });
-
- describe('Authorization levels via authorize hook', function () {
+ let socket;
+ before(async function () { agent = await common.init(); });
beforeEach(async function () {
- settings.requireAuthentication = true;
- settings.requireAuthorization = true;
- });
-
- it("level='create' -> can create", async function () {
- authorize = () => 'create';
- const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
- socket = await common.connect(res);
- const clientVars = await common.handshake(socket, 'pad');
- assert.equal(clientVars.type, 'CLIENT_VARS');
- assert.equal(clientVars.data.readonly, false);
- });
- it('level=true -> can create', async function () {
- authorize = () => true;
- const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
- socket = await common.connect(res);
- const clientVars = await common.handshake(socket, 'pad');
- assert.equal(clientVars.type, 'CLIENT_VARS');
- assert.equal(clientVars.data.readonly, false);
- });
- it("level='modify' -> can modify", async function () {
- await padManager.getPad('pad'); // Create the pad.
- authorize = () => 'modify';
- const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
- socket = await common.connect(res);
- const clientVars = await common.handshake(socket, 'pad');
- assert.equal(clientVars.type, 'CLIENT_VARS');
- assert.equal(clientVars.data.readonly, false);
- });
- it("level='create' settings.editOnly=true -> unable to create", async function () {
- authorize = () => 'create';
- settings.editOnly = true;
- const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
- socket = await common.connect(res);
- const message = await common.handshake(socket, 'pad');
- assert.equal(message.accessStatus, 'deny');
- });
- it("level='modify' settings.editOnly=false -> unable to create", async function () {
- authorize = () => 'modify';
- settings.editOnly = false;
- const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
- socket = await common.connect(res);
- const message = await common.handshake(socket, 'pad');
- assert.equal(message.accessStatus, 'deny');
- });
- it("level='readOnly' -> unable to create", async function () {
- authorize = () => 'readOnly';
- const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
- socket = await common.connect(res);
- const message = await common.handshake(socket, 'pad');
- assert.equal(message.accessStatus, 'deny');
- });
- it("level='readOnly' -> unable to modify", async function () {
- await padManager.getPad('pad'); // Create the pad.
- authorize = () => 'readOnly';
- const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
- socket = await common.connect(res);
- const clientVars = await common.handshake(socket, 'pad');
- assert.equal(clientVars.type, 'CLIENT_VARS');
- assert.equal(clientVars.data.readonly, true);
- });
- });
-
- describe('Authorization levels via user settings', function () {
- beforeEach(async function () {
- settings.requireAuthentication = true;
- });
-
- it('user.canCreate = true -> can create and modify', async function () {
- settings.users.user.canCreate = true;
- const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
- socket = await common.connect(res);
- const clientVars = await common.handshake(socket, 'pad');
- assert.equal(clientVars.type, 'CLIENT_VARS');
- assert.equal(clientVars.data.readonly, false);
- });
- it('user.canCreate = false -> unable to create', async function () {
- settings.users.user.canCreate = false;
- const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
- socket = await common.connect(res);
- const message = await common.handshake(socket, 'pad');
- assert.equal(message.accessStatus, 'deny');
- });
- it('user.readOnly = true -> unable to create', async function () {
- settings.users.user.readOnly = true;
- const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
- socket = await common.connect(res);
- const message = await common.handshake(socket, 'pad');
- assert.equal(message.accessStatus, 'deny');
- });
- it('user.readOnly = true -> unable to modify', async function () {
- await padManager.getPad('pad'); // Create the pad.
- settings.users.user.readOnly = true;
- const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
- socket = await common.connect(res);
- const clientVars = await common.handshake(socket, 'pad');
- assert.equal(clientVars.type, 'CLIENT_VARS');
- assert.equal(clientVars.data.readonly, true);
- });
- it('user.readOnly = false -> can create and modify', async function () {
- settings.users.user.readOnly = false;
- const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
- socket = await common.connect(res);
- const clientVars = await common.handshake(socket, 'pad');
- assert.equal(clientVars.type, 'CLIENT_VARS');
- assert.equal(clientVars.data.readonly, false);
- });
- it('user.readOnly = true, user.canCreate = true -> unable to create', async function () {
- settings.users.user.canCreate = true;
- settings.users.user.readOnly = true;
- const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
- socket = await common.connect(res);
- const message = await common.handshake(socket, 'pad');
- assert.equal(message.accessStatus, 'deny');
- });
- });
-
- describe('Authorization level interaction between authorize hook and user settings', function () {
- beforeEach(async function () {
- settings.requireAuthentication = true;
- settings.requireAuthorization = true;
- });
-
- it('authorize hook does not elevate level from user settings', async function () {
- settings.users.user.readOnly = true;
- authorize = () => 'create';
- const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
- socket = await common.connect(res);
- const message = await common.handshake(socket, 'pad');
- assert.equal(message.accessStatus, 'deny');
- });
- it('user settings does not elevate level from authorize hook', async function () {
- settings.users.user.readOnly = false;
- settings.users.user.canCreate = true;
- authorize = () => 'readOnly';
- const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
- socket = await common.connect(res);
- const message = await common.handshake(socket, 'pad');
- assert.equal(message.accessStatus, 'deny');
- });
- });
-
- describe('SocketIORouter.js', function () {
- const Module = class {
- setSocketIO(io) {}
- handleConnect(socket) {}
- handleDisconnect(socket) {}
- handleMessage(socket, message) {}
- };
-
- afterEach(async function () {
- socketIoRouter.deleteComponent(this.test.fullTitle());
- socketIoRouter.deleteComponent(`${this.test.fullTitle()} #2`);
- });
-
- it('setSocketIO', async function () {
- let ioServer;
- socketIoRouter.addComponent(this.test.fullTitle(), new class extends Module {
- setSocketIO(io) { ioServer = io; }
- }());
- assert(ioServer != null);
- });
-
- it('handleConnect', async function () {
- let serverSocket;
- socketIoRouter.addComponent(this.test.fullTitle(), new class extends Module {
- handleConnect(socket) { serverSocket = socket; }
- }());
- socket = await common.connect();
- assert(serverSocket != null);
- });
-
- it('handleDisconnect', async function () {
- let resolveConnected;
- const connected = new Promise((resolve) => resolveConnected = resolve);
- let resolveDisconnected;
- const disconnected = new Promise((resolve) => resolveDisconnected = resolve);
- socketIoRouter.addComponent(this.test.fullTitle(), new class extends Module {
- handleConnect(socket) {
- this._socket = socket;
- resolveConnected();
+ backups.hooks = {};
+ for (const hookName of ['preAuthorize', 'authenticate', 'authorize']) {
+ backups.hooks[hookName] = plugins.hooks[hookName];
+ plugins.hooks[hookName] = [];
}
- handleDisconnect(socket) {
- assert(socket != null);
- // There might be lingering disconnect events from sockets created by other tests.
- if (this._socket == null || socket.id !== this._socket.id) return;
- assert.equal(socket, this._socket);
- resolveDisconnected();
+ backups.settings = {};
+ for (const setting of ['editOnly', 'requireAuthentication', 'requireAuthorization', 'users']) {
+ backups.settings[setting] = settings[setting];
}
- }());
- socket = await common.connect();
- await connected;
- socket.close();
- socket = null;
- await disconnected;
- });
-
- it('handleMessage (success)', async function () {
- let serverSocket;
- const want = {
- component: this.test.fullTitle(),
- foo: {bar: 'asdf'},
- };
- let rx;
- const got = new Promise((resolve) => { rx = resolve; });
- socketIoRouter.addComponent(this.test.fullTitle(), new class extends Module {
- handleConnect(socket) { serverSocket = socket; }
- handleMessage(socket, message) { assert.equal(socket, serverSocket); rx(message); }
- }());
- socketIoRouter.addComponent(`${this.test.fullTitle()} #2`, new class extends Module {
- handleMessage(socket, message) { assert.fail('wrong handler called'); }
- }());
- socket = await common.connect();
- socket.send(want);
- assert.deepEqual(await got, want);
- });
-
- const tx = async (socket, message = {}) => await new Promise((resolve, reject) => {
- const AckErr = class extends Error {
- constructor(name, ...args) { super(...args); this.name = name; }
- };
- socket.send(message,
- (errj, val) => errj != null ? reject(new AckErr(errj.name, errj.message)) : resolve(val));
- });
-
- it('handleMessage with ack (success)', async function () {
- const want = 'value';
- socketIoRouter.addComponent(this.test.fullTitle(), new class extends Module {
- handleMessage(socket, msg) { return want; }
- }());
- socket = await common.connect();
- const got = await tx(socket, {component: this.test.fullTitle()});
- assert.equal(got, want);
+ settings.editOnly = false;
+ settings.requireAuthentication = false;
+ settings.requireAuthorization = false;
+ settings.users = {
+ admin: { password: 'admin-password', is_admin: true },
+ user: { password: 'user-password' },
+ };
+ assert(socket == null);
+ authorize = () => true;
+ plugins.hooks.authorize = [{ hook_fn: (hookName, { req }, cb) => cb([authorize(req)]) }];
+ await cleanUpPads();
});
-
- it('handleMessage with ack (error)', async function () {
- const InjectedError = class extends Error {
- constructor() { super('injected test error'); this.name = 'InjectedError'; }
- };
- socketIoRouter.addComponent(this.test.fullTitle(), new class extends Module {
- handleMessage(socket, msg) { throw new InjectedError(); }
- }());
- socket = await common.connect();
- await assert.rejects(tx(socket, {component: this.test.fullTitle()}), new InjectedError());
+ afterEach(async function () {
+ if (socket)
+ socket.close();
+ socket = null;
+ await cleanUpPads();
+ Object.assign(plugins.hooks, backups.hooks);
+ Object.assign(settings, backups.settings);
+ });
+ describe('Normal accesses', function () {
+ it('!authn anonymous cookie /p/pad -> 200, ok', async function () {
+ const res = await agent.get('/p/pad').expect(200);
+ socket = await common.connect(res);
+ const clientVars = await common.handshake(socket, 'pad');
+ assert.equal(clientVars.type, 'CLIENT_VARS');
+ });
+ it('!authn !cookie -> ok', async function () {
+ socket = await common.connect(null);
+ const clientVars = await common.handshake(socket, 'pad');
+ assert.equal(clientVars.type, 'CLIENT_VARS');
+ });
+ it('!authn user /p/pad -> 200, ok', async function () {
+ const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
+ socket = await common.connect(res);
+ const clientVars = await common.handshake(socket, 'pad');
+ assert.equal(clientVars.type, 'CLIENT_VARS');
+ });
+ it('authn user /p/pad -> 200, ok', async function () {
+ settings.requireAuthentication = true;
+ const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
+ socket = await common.connect(res);
+ const clientVars = await common.handshake(socket, 'pad');
+ assert.equal(clientVars.type, 'CLIENT_VARS');
+ });
+ for (const authn of [false, true]) {
+ const desc = authn ? 'authn user' : '!authn anonymous';
+ it(`${desc} read-only /p/pad -> 200, ok`, async function () {
+ const get = (ep) => {
+ let res = agent.get(ep);
+ if (authn)
+ res = res.auth('user', 'user-password');
+ return res.expect(200);
+ };
+ settings.requireAuthentication = authn;
+ let res = await get('/p/pad');
+ socket = await common.connect(res);
+ let clientVars = await common.handshake(socket, 'pad');
+ assert.equal(clientVars.type, 'CLIENT_VARS');
+ assert.equal(clientVars.data.readonly, false);
+ const readOnlyId = clientVars.data.readOnlyId;
+ assert(readOnlyManager.isReadOnlyId(readOnlyId));
+ socket.close();
+ res = await get(`/p/${readOnlyId}`);
+ socket = await common.connect(res);
+ clientVars = await common.handshake(socket, readOnlyId);
+ assert.equal(clientVars.type, 'CLIENT_VARS');
+ assert.equal(clientVars.data.readonly, true);
+ });
+ }
+ it('authz user /p/pad -> 200, ok', async function () {
+ settings.requireAuthentication = true;
+ settings.requireAuthorization = true;
+ const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
+ socket = await common.connect(res);
+ const clientVars = await common.handshake(socket, 'pad');
+ assert.equal(clientVars.type, 'CLIENT_VARS');
+ });
+ it('supports pad names with characters that must be percent-encoded', async function () {
+ settings.requireAuthentication = true;
+ // requireAuthorization is set to true here to guarantee that the user's padAuthorizations
+ // object is populated. Technically this isn't necessary because the user's padAuthorizations
+ // is currently populated even if requireAuthorization is false, but setting this to true
+ // ensures the test remains useful if the implementation ever changes.
+ settings.requireAuthorization = true;
+ const encodedPadId = encodeURIComponent('päd');
+ const res = await agent.get(`/p/${encodedPadId}`).auth('user', 'user-password').expect(200);
+ socket = await common.connect(res);
+ const clientVars = await common.handshake(socket, 'päd');
+ assert.equal(clientVars.type, 'CLIENT_VARS');
+ });
+ });
+ describe('Abnormal access attempts', function () {
+ it('authn anonymous /p/pad -> 401, error', async function () {
+ settings.requireAuthentication = true;
+ const res = await agent.get('/p/pad').expect(401);
+ // Despite the 401, try to create the pad via a socket.io connection anyway.
+ socket = await common.connect(res);
+ const message = await common.handshake(socket, 'pad');
+ assert.equal(message.accessStatus, 'deny');
+ });
+ it('authn anonymous read-only /p/pad -> 401, error', async function () {
+ settings.requireAuthentication = true;
+ let res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
+ socket = await common.connect(res);
+ const clientVars = await common.handshake(socket, 'pad');
+ assert.equal(clientVars.type, 'CLIENT_VARS');
+ const readOnlyId = clientVars.data.readOnlyId;
+ assert(readOnlyManager.isReadOnlyId(readOnlyId));
+ socket.close();
+ res = await agent.get(`/p/${readOnlyId}`).expect(401);
+ // Despite the 401, try to read the pad via a socket.io connection anyway.
+ socket = await common.connect(res);
+ const message = await common.handshake(socket, readOnlyId);
+ assert.equal(message.accessStatus, 'deny');
+ });
+ it('authn !cookie -> error', async function () {
+ settings.requireAuthentication = true;
+ socket = await common.connect(null);
+ const message = await common.handshake(socket, 'pad');
+ assert.equal(message.accessStatus, 'deny');
+ });
+ it('authorization bypass attempt -> error', async function () {
+ // Only allowed to access /p/pad.
+ authorize = (req) => req.path === '/p/pad';
+ settings.requireAuthentication = true;
+ settings.requireAuthorization = true;
+ // First authenticate and establish a session.
+ const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
+ socket = await common.connect(res);
+ // Accessing /p/other-pad should fail, despite the successful fetch of /p/pad.
+ const message = await common.handshake(socket, 'other-pad');
+ assert.equal(message.accessStatus, 'deny');
+ });
+ });
+ describe('Authorization levels via authorize hook', function () {
+ beforeEach(async function () {
+ settings.requireAuthentication = true;
+ settings.requireAuthorization = true;
+ });
+ it("level='create' -> can create", async function () {
+ authorize = () => 'create';
+ const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
+ socket = await common.connect(res);
+ const clientVars = await common.handshake(socket, 'pad');
+ assert.equal(clientVars.type, 'CLIENT_VARS');
+ assert.equal(clientVars.data.readonly, false);
+ });
+ it('level=true -> can create', async function () {
+ authorize = () => true;
+ const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
+ socket = await common.connect(res);
+ const clientVars = await common.handshake(socket, 'pad');
+ assert.equal(clientVars.type, 'CLIENT_VARS');
+ assert.equal(clientVars.data.readonly, false);
+ });
+ it("level='modify' -> can modify", async function () {
+ await padManager.getPad('pad'); // Create the pad.
+ authorize = () => 'modify';
+ const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
+ socket = await common.connect(res);
+ const clientVars = await common.handshake(socket, 'pad');
+ assert.equal(clientVars.type, 'CLIENT_VARS');
+ assert.equal(clientVars.data.readonly, false);
+ });
+ it("level='create' settings.editOnly=true -> unable to create", async function () {
+ authorize = () => 'create';
+ settings.editOnly = true;
+ const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
+ socket = await common.connect(res);
+ const message = await common.handshake(socket, 'pad');
+ assert.equal(message.accessStatus, 'deny');
+ });
+ it("level='modify' settings.editOnly=false -> unable to create", async function () {
+ authorize = () => 'modify';
+ settings.editOnly = false;
+ const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
+ socket = await common.connect(res);
+ const message = await common.handshake(socket, 'pad');
+ assert.equal(message.accessStatus, 'deny');
+ });
+ it("level='readOnly' -> unable to create", async function () {
+ authorize = () => 'readOnly';
+ const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
+ socket = await common.connect(res);
+ const message = await common.handshake(socket, 'pad');
+ assert.equal(message.accessStatus, 'deny');
+ });
+ it("level='readOnly' -> unable to modify", async function () {
+ await padManager.getPad('pad'); // Create the pad.
+ authorize = () => 'readOnly';
+ const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
+ socket = await common.connect(res);
+ const clientVars = await common.handshake(socket, 'pad');
+ assert.equal(clientVars.type, 'CLIENT_VARS');
+ assert.equal(clientVars.data.readonly, true);
+ });
+ });
+ describe('Authorization levels via user settings', function () {
+ beforeEach(async function () {
+ settings.requireAuthentication = true;
+ });
+ it('user.canCreate = true -> can create and modify', async function () {
+ settings.users.user.canCreate = true;
+ const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
+ socket = await common.connect(res);
+ const clientVars = await common.handshake(socket, 'pad');
+ assert.equal(clientVars.type, 'CLIENT_VARS');
+ assert.equal(clientVars.data.readonly, false);
+ });
+ it('user.canCreate = false -> unable to create', async function () {
+ settings.users.user.canCreate = false;
+ const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
+ socket = await common.connect(res);
+ const message = await common.handshake(socket, 'pad');
+ assert.equal(message.accessStatus, 'deny');
+ });
+ it('user.readOnly = true -> unable to create', async function () {
+ settings.users.user.readOnly = true;
+ const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
+ socket = await common.connect(res);
+ const message = await common.handshake(socket, 'pad');
+ assert.equal(message.accessStatus, 'deny');
+ });
+ it('user.readOnly = true -> unable to modify', async function () {
+ await padManager.getPad('pad'); // Create the pad.
+ settings.users.user.readOnly = true;
+ const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
+ socket = await common.connect(res);
+ const clientVars = await common.handshake(socket, 'pad');
+ assert.equal(clientVars.type, 'CLIENT_VARS');
+ assert.equal(clientVars.data.readonly, true);
+ });
+ it('user.readOnly = false -> can create and modify', async function () {
+ settings.users.user.readOnly = false;
+ const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
+ socket = await common.connect(res);
+ const clientVars = await common.handshake(socket, 'pad');
+ assert.equal(clientVars.type, 'CLIENT_VARS');
+ assert.equal(clientVars.data.readonly, false);
+ });
+ it('user.readOnly = true, user.canCreate = true -> unable to create', async function () {
+ settings.users.user.canCreate = true;
+ settings.users.user.readOnly = true;
+ const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
+ socket = await common.connect(res);
+ const message = await common.handshake(socket, 'pad');
+ assert.equal(message.accessStatus, 'deny');
+ });
+ });
+ describe('Authorization level interaction between authorize hook and user settings', function () {
+ beforeEach(async function () {
+ settings.requireAuthentication = true;
+ settings.requireAuthorization = true;
+ });
+ it('authorize hook does not elevate level from user settings', async function () {
+ settings.users.user.readOnly = true;
+ authorize = () => 'create';
+ const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
+ socket = await common.connect(res);
+ const message = await common.handshake(socket, 'pad');
+ assert.equal(message.accessStatus, 'deny');
+ });
+ it('user settings does not elevate level from authorize hook', async function () {
+ settings.users.user.readOnly = false;
+ settings.users.user.canCreate = true;
+ authorize = () => 'readOnly';
+ const res = await agent.get('/p/pad').auth('user', 'user-password').expect(200);
+ socket = await common.connect(res);
+ const message = await common.handshake(socket, 'pad');
+ assert.equal(message.accessStatus, 'deny');
+ });
+ });
+ describe('SocketIORouter.js', function () {
+ const Module = class {
+ setSocketIO(io) { }
+ handleConnect(socket) { }
+ handleDisconnect(socket) { }
+ handleMessage(socket, message) { }
+ };
+ afterEach(async function () {
+ socketIoRouter.deleteComponent(this.test.fullTitle());
+ socketIoRouter.deleteComponent(`${this.test.fullTitle()} #2`);
+ });
+ it('setSocketIO', async function () {
+ let ioServer;
+ socketIoRouter.addComponent(this.test.fullTitle(), new class extends Module {
+ setSocketIO(io) { ioServer = io; }
+ }());
+ assert(ioServer != null);
+ });
+ it('handleConnect', async function () {
+ let serverSocket;
+ socketIoRouter.addComponent(this.test.fullTitle(), new class extends Module {
+ handleConnect(socket) { serverSocket = socket; }
+ }());
+ socket = await common.connect();
+ assert(serverSocket != null);
+ });
+ it('handleDisconnect', async function () {
+ let resolveConnected;
+ const connected = new Promise((resolve) => resolveConnected = resolve);
+ let resolveDisconnected;
+ const disconnected = new Promise((resolve) => resolveDisconnected = resolve);
+ socketIoRouter.addComponent(this.test.fullTitle(), new class extends Module {
+ handleConnect(socket) {
+ this._socket = socket;
+ resolveConnected();
+ }
+ handleDisconnect(socket) {
+ assert(socket != null);
+ // There might be lingering disconnect events from sockets created by other tests.
+ if (this._socket == null || socket.id !== this._socket.id)
+ return;
+ assert.equal(socket, this._socket);
+ resolveDisconnected();
+ }
+ }());
+ socket = await common.connect();
+ await connected;
+ socket.close();
+ socket = null;
+ await disconnected;
+ });
+ it('handleMessage (success)', async function () {
+ let serverSocket;
+ const want = {
+ component: this.test.fullTitle(),
+ foo: { bar: 'asdf' },
+ };
+ let rx;
+ const got = new Promise((resolve) => { rx = resolve; });
+ socketIoRouter.addComponent(this.test.fullTitle(), new class extends Module {
+ handleConnect(socket) { serverSocket = socket; }
+ handleMessage(socket, message) { assert.equal(socket, serverSocket); rx(message); }
+ }());
+ socketIoRouter.addComponent(`${this.test.fullTitle()} #2`, new class extends Module {
+ handleMessage(socket, message) { assert.fail('wrong handler called'); }
+ }());
+ socket = await common.connect();
+ socket.send(want);
+ assert.deepEqual(await got, want);
+ });
+ const tx = async (socket, message = {}) => await new Promise((resolve, reject) => {
+ const AckErr = class extends Error {
+ constructor(name, ...args) { super(...args); this.name = name; }
+ };
+ socket.send(message, (errj, val) => errj != null ? reject(new AckErr(errj.name, errj.message)) : resolve(val));
+ });
+ it('handleMessage with ack (success)', async function () {
+ const want = 'value';
+ socketIoRouter.addComponent(this.test.fullTitle(), new class extends Module {
+ handleMessage(socket, msg) { return want; }
+ }());
+ socket = await common.connect();
+ const got = await tx(socket, { component: this.test.fullTitle() });
+ assert.equal(got, want);
+ });
+ it('handleMessage with ack (error)', async function () {
+ const InjectedError = class extends Error {
+ constructor() { super('injected test error'); this.name = 'InjectedError'; }
+ };
+ socketIoRouter.addComponent(this.test.fullTitle(), new class extends Module {
+ handleMessage(socket, msg) { throw new InjectedError(); }
+ }());
+ socket = await common.connect();
+ await assert.rejects(tx(socket, { component: this.test.fullTitle() }), new InjectedError());
+ });
});
- });
});
diff --git a/src/tests/backend/specs/specialpages.js b/src/tests/backend/specs/specialpages.js
index 93c8b3bc4ac..8be1b00fb8f 100644
--- a/src/tests/backend/specs/specialpages.js
+++ b/src/tests/backend/specs/specialpages.js
@@ -1,28 +1,25 @@
+import * as common from "../common.js";
+import * as settings from "../../../node/utils/Settings.js";
'use strict';
-
-const common = require('../common');
-const settings = require('../../../node/utils/Settings');
-
describe(__filename, function () {
- this.timeout(30000);
- let agent;
- const backups = {};
- before(async function () { agent = await common.init(); });
- beforeEach(async function () {
- backups.settings = {};
- for (const setting of ['requireAuthentication', 'requireAuthorization']) {
- backups.settings[setting] = settings[setting];
- }
- settings.requireAuthentication = false;
- settings.requireAuthorization = false;
- });
- afterEach(async function () {
- Object.assign(settings, backups.settings);
- });
-
- describe('/javascript', function () {
- it('/javascript -> 200', async function () {
- await agent.get('/javascript').expect(200);
+ this.timeout(30000);
+ let agent;
+ const backups = {};
+ before(async function () { agent = await common.init(); });
+ beforeEach(async function () {
+ backups.settings = {};
+ for (const setting of ['requireAuthentication', 'requireAuthorization']) {
+ backups.settings[setting] = settings[setting];
+ }
+ settings.requireAuthentication = false;
+ settings.requireAuthorization = false;
+ });
+ afterEach(async function () {
+ Object.assign(settings, backups.settings);
+ });
+ describe('/javascript', function () {
+ it('/javascript -> 200', async function () {
+ await agent.get('/javascript').expect(200);
+ });
});
- });
});
diff --git a/src/tests/backend/specs/webaccess.js b/src/tests/backend/specs/webaccess.js
index 23cd2d88968..ced776ca487 100644
--- a/src/tests/backend/specs/webaccess.js
+++ b/src/tests/backend/specs/webaccess.js
@@ -1,494 +1,478 @@
+import assert$0 from "assert";
+import * as common from "../common.js";
+import * as plugins from "../../../static/js/pluginfw/plugin_defs.js";
+import * as settings from "../../../node/utils/Settings.js";
'use strict';
-
-const assert = require('assert').strict;
-const common = require('../common');
-const plugins = require('../../../static/js/pluginfw/plugin_defs');
-const settings = require('../../../node/utils/Settings');
-
+const assert = assert$0.strict;
describe(__filename, function () {
- this.timeout(30000);
- let agent;
- const backups = {};
- const authHookNames = ['preAuthorize', 'authenticate', 'authorize'];
- const failHookNames = ['preAuthzFailure', 'authnFailure', 'authzFailure', 'authFailure'];
- const makeHook = (hookName, hookFn) => ({
- hook_fn: hookFn,
- hook_fn_name: `fake_plugin/${hookName}`,
- hook_name: hookName,
- part: {plugin: 'fake_plugin'},
- });
-
- before(async function () { agent = await common.init(); });
- beforeEach(async function () {
- backups.hooks = {};
- for (const hookName of authHookNames.concat(failHookNames)) {
- backups.hooks[hookName] = plugins.hooks[hookName];
- plugins.hooks[hookName] = [];
- }
- backups.settings = {};
- for (const setting of ['requireAuthentication', 'requireAuthorization', 'users']) {
- backups.settings[setting] = settings[setting];
- }
- settings.requireAuthentication = false;
- settings.requireAuthorization = false;
- settings.users = {
- admin: {password: 'admin-password', is_admin: true},
- user: {password: 'user-password'},
- };
- });
- afterEach(async function () {
- Object.assign(plugins.hooks, backups.hooks);
- Object.assign(settings, backups.settings);
- });
-
- describe('webaccess: without plugins', function () {
- it('!authn !authz anonymous / -> 200', async function () {
- settings.requireAuthentication = false;
- settings.requireAuthorization = false;
- await agent.get('/').expect(200);
+ this.timeout(30000);
+ let agent;
+ const backups = {};
+ const authHookNames = ['preAuthorize', 'authenticate', 'authorize'];
+ const failHookNames = ['preAuthzFailure', 'authnFailure', 'authzFailure', 'authFailure'];
+ const makeHook = (hookName, hookFn) => ({
+ hook_fn: hookFn,
+ hook_fn_name: `fake_plugin/${hookName}`,
+ hook_name: hookName,
+ part: { plugin: 'fake_plugin' },
});
- it('!authn !authz anonymous /admin/ -> 401', async function () {
- settings.requireAuthentication = false;
- settings.requireAuthorization = false;
- await agent.get('/admin/').expect(401);
- });
- it('authn !authz anonymous / -> 401', async function () {
- settings.requireAuthentication = true;
- settings.requireAuthorization = false;
- await agent.get('/').expect(401);
- });
- it('authn !authz user / -> 200', async function () {
- settings.requireAuthentication = true;
- settings.requireAuthorization = false;
- await agent.get('/').auth('user', 'user-password').expect(200);
- });
- it('authn !authz user /admin/ -> 403', async function () {
- settings.requireAuthentication = true;
- settings.requireAuthorization = false;
- await agent.get('/admin/').auth('user', 'user-password').expect(403);
- });
- it('authn !authz admin / -> 200', async function () {
- settings.requireAuthentication = true;
- settings.requireAuthorization = false;
- await agent.get('/').auth('admin', 'admin-password').expect(200);
- });
- it('authn !authz admin /admin/ -> 200', async function () {
- settings.requireAuthentication = true;
- settings.requireAuthorization = false;
- await agent.get('/admin/').auth('admin', 'admin-password').expect(200);
- });
- it('authn authz anonymous /robots.txt -> 200', async function () {
- settings.requireAuthentication = true;
- settings.requireAuthorization = true;
- await agent.get('/robots.txt').expect(200);
- });
- it('authn authz user / -> 403', async function () {
- settings.requireAuthentication = true;
- settings.requireAuthorization = true;
- await agent.get('/').auth('user', 'user-password').expect(403);
- });
- it('authn authz user /admin/ -> 403', async function () {
- settings.requireAuthentication = true;
- settings.requireAuthorization = true;
- await agent.get('/admin/').auth('user', 'user-password').expect(403);
- });
- it('authn authz admin / -> 200', async function () {
- settings.requireAuthentication = true;
- settings.requireAuthorization = true;
- await agent.get('/').auth('admin', 'admin-password').expect(200);
- });
- it('authn authz admin /admin/ -> 200', async function () {
- settings.requireAuthentication = true;
- settings.requireAuthorization = true;
- await agent.get('/admin/').auth('admin', 'admin-password').expect(200);
- });
-
- describe('login fails if password is nullish', function () {
- for (const adminPassword of [undefined, null]) {
- // https://tools.ietf.org/html/rfc7617 says that the username and password are sent as
- // base64(username + ':' + password), but there's nothing stopping a malicious user from
- // sending just base64(username) (no colon). The lack of colon could throw off credential
- // parsing, resulting in successful comparisons against a null or undefined password.
- for (const creds of ['admin', 'admin:']) {
- it(`admin password: ${adminPassword} credentials: ${creds}`, async function () {
- settings.users.admin.password = adminPassword;
- const encCreds = Buffer.from(creds).toString('base64');
- await agent.get('/admin/').set('Authorization', `Basic ${encCreds}`).expect(401);
- });
- }
- }
- });
- });
-
- describe('webaccess: preAuthorize, authenticate, and authorize hooks', function () {
- let callOrder;
- const Handler = class {
- constructor(hookName, suffix) {
- this.called = false;
- this.hookName = hookName;
- this.innerHandle = () => [];
- this.id = hookName + suffix;
- this.checkContext = () => {};
- }
- handle(hookName, context, cb) {
- assert.equal(hookName, this.hookName);
- assert(context != null);
- assert(context.req != null);
- assert(context.res != null);
- assert(context.next != null);
- this.checkContext(context);
- assert(!this.called);
- this.called = true;
- callOrder.push(this.id);
- return cb(this.innerHandle(context));
- }
- };
- const handlers = {};
-
+ before(async function () { agent = await common.init(); });
beforeEach(async function () {
- callOrder = [];
- for (const hookName of authHookNames) {
- // Create two handlers for each hook to test deferral to the next function.
- const h0 = new Handler(hookName, '_0');
- const h1 = new Handler(hookName, '_1');
- handlers[hookName] = [h0, h1];
- plugins.hooks[hookName] = [
- makeHook(hookName, h0.handle.bind(h0)),
- makeHook(hookName, h1.handle.bind(h1)),
- ];
- }
- });
-
- describe('preAuthorize', function () {
- beforeEach(async function () {
- settings.requireAuthentication = false;
- settings.requireAuthorization = false;
- });
-
- it('defers if it returns []', async function () {
- await agent.get('/').expect(200);
- // Note: The preAuthorize hook always runs even if requireAuthorization is false.
- assert.deepEqual(callOrder, ['preAuthorize_0', 'preAuthorize_1']);
- });
- it('bypasses authenticate and authorize hooks when true is returned', async function () {
- settings.requireAuthentication = true;
- settings.requireAuthorization = true;
- handlers.preAuthorize[0].innerHandle = () => [true];
- await agent.get('/').expect(200);
- assert.deepEqual(callOrder, ['preAuthorize_0']);
- });
- it('bypasses authenticate and authorize hooks when false is returned', async function () {
- settings.requireAuthentication = true;
- settings.requireAuthorization = true;
- handlers.preAuthorize[0].innerHandle = () => [false];
- await agent.get('/').expect(403);
- assert.deepEqual(callOrder, ['preAuthorize_0']);
- });
- it('bypasses authenticate and authorize hooks when next is called', async function () {
- settings.requireAuthentication = true;
- settings.requireAuthorization = true;
- handlers.preAuthorize[0].innerHandle = ({next}) => next();
- await agent.get('/').expect(200);
- assert.deepEqual(callOrder, ['preAuthorize_0']);
- });
- it('static content (expressPreSession) bypasses all auth checks', async function () {
- settings.requireAuthentication = true;
- settings.requireAuthorization = true;
- await agent.get('/static/robots.txt').expect(200);
- assert.deepEqual(callOrder, []);
- });
- it('cannot grant access to /admin', async function () {
- handlers.preAuthorize[0].innerHandle = () => [true];
- await agent.get('/admin/').expect(401);
- // Notes:
- // * preAuthorize[1] is called despite preAuthorize[0] returning a non-empty list because
- // 'true' entries are ignored for /admin/* requests.
- // * The authenticate hook always runs for /admin/* requests even if
- // settings.requireAuthentication is false.
- assert.deepEqual(callOrder, ['preAuthorize_0',
- 'preAuthorize_1',
- 'authenticate_0',
- 'authenticate_1']);
- });
- it('can deny access to /admin', async function () {
- handlers.preAuthorize[0].innerHandle = () => [false];
- await agent.get('/admin/').auth('admin', 'admin-password').expect(403);
- assert.deepEqual(callOrder, ['preAuthorize_0']);
- });
- it('runs preAuthzFailure hook when access is denied', async function () {
- handlers.preAuthorize[0].innerHandle = () => [false];
- let called = false;
- plugins.hooks.preAuthzFailure = [makeHook('preAuthzFailure', (hookName, {req, res}, cb) => {
- assert.equal(hookName, 'preAuthzFailure');
- assert(req != null);
- assert(res != null);
- assert(!called);
- called = true;
- res.status(200).send('injected');
- return cb([true]);
- })];
- await agent.get('/admin/').auth('admin', 'admin-password').expect(200, 'injected');
- assert(called);
- });
- it('returns 500 if an exception is thrown', async function () {
- handlers.preAuthorize[0].innerHandle = () => { throw new Error('exception test'); };
- await agent.get('/').expect(500);
- });
- });
-
- describe('authenticate', function () {
- beforeEach(async function () {
- settings.requireAuthentication = true;
- settings.requireAuthorization = false;
- });
-
- it('is not called if !requireAuthentication and not /admin/*', async function () {
- settings.requireAuthentication = false;
- await agent.get('/').expect(200);
- assert.deepEqual(callOrder, ['preAuthorize_0', 'preAuthorize_1']);
- });
- it('is called if !requireAuthentication and /admin/*', async function () {
+ backups.hooks = {};
+ for (const hookName of authHookNames.concat(failHookNames)) {
+ backups.hooks[hookName] = plugins.hooks[hookName];
+ plugins.hooks[hookName] = [];
+ }
+ backups.settings = {};
+ for (const setting of ['requireAuthentication', 'requireAuthorization', 'users']) {
+ backups.settings[setting] = settings[setting];
+ }
settings.requireAuthentication = false;
- await agent.get('/admin/').expect(401);
- assert.deepEqual(callOrder, ['preAuthorize_0',
- 'preAuthorize_1',
- 'authenticate_0',
- 'authenticate_1']);
- });
- it('defers if empty list returned', async function () {
- await agent.get('/').expect(401);
- assert.deepEqual(callOrder, ['preAuthorize_0',
- 'preAuthorize_1',
- 'authenticate_0',
- 'authenticate_1']);
- });
- it('does not defer if return [true], 200', async function () {
- handlers.authenticate[0].innerHandle = ({req}) => { req.session.user = {}; return [true]; };
- await agent.get('/').expect(200);
- // Note: authenticate_1 was not called because authenticate_0 handled it.
- assert.deepEqual(callOrder, ['preAuthorize_0', 'preAuthorize_1', 'authenticate_0']);
- });
- it('does not defer if return [false], 401', async function () {
- handlers.authenticate[0].innerHandle = () => [false];
- await agent.get('/').expect(401);
- // Note: authenticate_1 was not called because authenticate_0 handled it.
- assert.deepEqual(callOrder, ['preAuthorize_0', 'preAuthorize_1', 'authenticate_0']);
- });
- it('falls back to HTTP basic auth', async function () {
- await agent.get('/').auth('user', 'user-password').expect(200);
- assert.deepEqual(callOrder, ['preAuthorize_0',
- 'preAuthorize_1',
- 'authenticate_0',
- 'authenticate_1']);
- });
- it('passes settings.users in context', async function () {
- handlers.authenticate[0].checkContext = ({users}) => {
- assert.equal(users, settings.users);
- };
- await agent.get('/').expect(401);
- assert.deepEqual(callOrder, ['preAuthorize_0',
- 'preAuthorize_1',
- 'authenticate_0',
- 'authenticate_1']);
- });
- it('passes user, password in context if provided', async function () {
- handlers.authenticate[0].checkContext = ({username, password}) => {
- assert.equal(username, 'user');
- assert.equal(password, 'user-password');
- };
- await agent.get('/').auth('user', 'user-password').expect(200);
- assert.deepEqual(callOrder, ['preAuthorize_0',
- 'preAuthorize_1',
- 'authenticate_0',
- 'authenticate_1']);
- });
- it('does not pass user, password in context if not provided', async function () {
- handlers.authenticate[0].checkContext = ({username, password}) => {
- assert(username == null);
- assert(password == null);
- };
- await agent.get('/').expect(401);
- assert.deepEqual(callOrder, ['preAuthorize_0',
- 'preAuthorize_1',
- 'authenticate_0',
- 'authenticate_1']);
- });
- it('errors if req.session.user is not created', async function () {
- handlers.authenticate[0].innerHandle = () => [true];
- await agent.get('/').expect(500);
- assert.deepEqual(callOrder, ['preAuthorize_0', 'preAuthorize_1', 'authenticate_0']);
- });
- it('returns 500 if an exception is thrown', async function () {
- handlers.authenticate[0].innerHandle = () => { throw new Error('exception test'); };
- await agent.get('/').expect(500);
- assert.deepEqual(callOrder, ['preAuthorize_0', 'preAuthorize_1', 'authenticate_0']);
- });
- });
-
- describe('authorize', function () {
- beforeEach(async function () {
- settings.requireAuthentication = true;
- settings.requireAuthorization = true;
- });
-
- it('is not called if !requireAuthorization (non-/admin)', async function () {
settings.requireAuthorization = false;
- await agent.get('/').auth('user', 'user-password').expect(200);
- assert.deepEqual(callOrder, ['preAuthorize_0',
- 'preAuthorize_1',
- 'authenticate_0',
- 'authenticate_1']);
- });
- it('is not called if !requireAuthorization (/admin)', async function () {
- settings.requireAuthorization = false;
- await agent.get('/admin/').auth('admin', 'admin-password').expect(200);
- assert.deepEqual(callOrder, ['preAuthorize_0',
- 'preAuthorize_1',
- 'authenticate_0',
- 'authenticate_1']);
- });
- it('defers if empty list returned', async function () {
- await agent.get('/').auth('user', 'user-password').expect(403);
- assert.deepEqual(callOrder, ['preAuthorize_0',
- 'preAuthorize_1',
- 'authenticate_0',
- 'authenticate_1',
- 'authorize_0',
- 'authorize_1']);
- });
- it('does not defer if return [true], 200', async function () {
- handlers.authorize[0].innerHandle = () => [true];
- await agent.get('/').auth('user', 'user-password').expect(200);
- // Note: authorize_1 was not called because authorize_0 handled it.
- assert.deepEqual(callOrder, ['preAuthorize_0',
- 'preAuthorize_1',
- 'authenticate_0',
- 'authenticate_1',
- 'authorize_0']);
- });
- it('does not defer if return [false], 403', async function () {
- handlers.authorize[0].innerHandle = () => [false];
- await agent.get('/').auth('user', 'user-password').expect(403);
- // Note: authorize_1 was not called because authorize_0 handled it.
- assert.deepEqual(callOrder, ['preAuthorize_0',
- 'preAuthorize_1',
- 'authenticate_0',
- 'authenticate_1',
- 'authorize_0']);
- });
- it('passes req.path in context', async function () {
- handlers.authorize[0].checkContext = ({resource}) => {
- assert.equal(resource, '/');
+ settings.users = {
+ admin: { password: 'admin-password', is_admin: true },
+ user: { password: 'user-password' },
};
- await agent.get('/').auth('user', 'user-password').expect(403);
- assert.deepEqual(callOrder, ['preAuthorize_0',
- 'preAuthorize_1',
- 'authenticate_0',
- 'authenticate_1',
- 'authorize_0',
- 'authorize_1']);
- });
- it('returns 500 if an exception is thrown', async function () {
- handlers.authorize[0].innerHandle = () => { throw new Error('exception test'); };
- await agent.get('/').auth('user', 'user-password').expect(500);
- assert.deepEqual(callOrder, ['preAuthorize_0',
- 'preAuthorize_1',
- 'authenticate_0',
- 'authenticate_1',
- 'authorize_0']);
- });
});
- });
-
- describe('webaccess: authnFailure, authzFailure, authFailure hooks', function () {
- const Handler = class {
- constructor(hookName) {
- this.hookName = hookName;
- this.shouldHandle = false;
- this.called = false;
- }
- handle(hookName, context, cb) {
- assert.equal(hookName, this.hookName);
- assert(context != null);
- assert(context.req != null);
- assert(context.res != null);
- assert(!this.called);
- this.called = true;
- if (this.shouldHandle) {
- context.res.status(200).send(this.hookName);
- return cb([true]);
- }
- return cb([]);
- }
- };
- const handlers = {};
-
- beforeEach(async function () {
- failHookNames.forEach((hookName) => {
- const handler = new Handler(hookName);
- handlers[hookName] = handler;
- plugins.hooks[hookName] = [makeHook(hookName, handler.handle.bind(handler))];
- });
- settings.requireAuthentication = true;
- settings.requireAuthorization = true;
- });
-
- // authn failure tests
- it('authn fail, no hooks handle -> 401', async function () {
- await agent.get('/').expect(401);
- assert(handlers.authnFailure.called);
- assert(!handlers.authzFailure.called);
- assert(handlers.authFailure.called);
- });
- it('authn fail, authnFailure handles', async function () {
- handlers.authnFailure.shouldHandle = true;
- await agent.get('/').expect(200, 'authnFailure');
- assert(handlers.authnFailure.called);
- assert(!handlers.authzFailure.called);
- assert(!handlers.authFailure.called);
- });
- it('authn fail, authFailure handles', async function () {
- handlers.authFailure.shouldHandle = true;
- await agent.get('/').expect(200, 'authFailure');
- assert(handlers.authnFailure.called);
- assert(!handlers.authzFailure.called);
- assert(handlers.authFailure.called);
+ afterEach(async function () {
+ Object.assign(plugins.hooks, backups.hooks);
+ Object.assign(settings, backups.settings);
});
- it('authnFailure trumps authFailure', async function () {
- handlers.authnFailure.shouldHandle = true;
- handlers.authFailure.shouldHandle = true;
- await agent.get('/').expect(200, 'authnFailure');
- assert(handlers.authnFailure.called);
- assert(!handlers.authFailure.called);
+ describe('webaccess: without plugins', function () {
+ it('!authn !authz anonymous / -> 200', async function () {
+ settings.requireAuthentication = false;
+ settings.requireAuthorization = false;
+ await agent.get('/').expect(200);
+ });
+ it('!authn !authz anonymous /admin/ -> 401', async function () {
+ settings.requireAuthentication = false;
+ settings.requireAuthorization = false;
+ await agent.get('/admin/').expect(401);
+ });
+ it('authn !authz anonymous / -> 401', async function () {
+ settings.requireAuthentication = true;
+ settings.requireAuthorization = false;
+ await agent.get('/').expect(401);
+ });
+ it('authn !authz user / -> 200', async function () {
+ settings.requireAuthentication = true;
+ settings.requireAuthorization = false;
+ await agent.get('/').auth('user', 'user-password').expect(200);
+ });
+ it('authn !authz user /admin/ -> 403', async function () {
+ settings.requireAuthentication = true;
+ settings.requireAuthorization = false;
+ await agent.get('/admin/').auth('user', 'user-password').expect(403);
+ });
+ it('authn !authz admin / -> 200', async function () {
+ settings.requireAuthentication = true;
+ settings.requireAuthorization = false;
+ await agent.get('/').auth('admin', 'admin-password').expect(200);
+ });
+ it('authn !authz admin /admin/ -> 200', async function () {
+ settings.requireAuthentication = true;
+ settings.requireAuthorization = false;
+ await agent.get('/admin/').auth('admin', 'admin-password').expect(200);
+ });
+ it('authn authz anonymous /robots.txt -> 200', async function () {
+ settings.requireAuthentication = true;
+ settings.requireAuthorization = true;
+ await agent.get('/robots.txt').expect(200);
+ });
+ it('authn authz user / -> 403', async function () {
+ settings.requireAuthentication = true;
+ settings.requireAuthorization = true;
+ await agent.get('/').auth('user', 'user-password').expect(403);
+ });
+ it('authn authz user /admin/ -> 403', async function () {
+ settings.requireAuthentication = true;
+ settings.requireAuthorization = true;
+ await agent.get('/admin/').auth('user', 'user-password').expect(403);
+ });
+ it('authn authz admin / -> 200', async function () {
+ settings.requireAuthentication = true;
+ settings.requireAuthorization = true;
+ await agent.get('/').auth('admin', 'admin-password').expect(200);
+ });
+ it('authn authz admin /admin/ -> 200', async function () {
+ settings.requireAuthentication = true;
+ settings.requireAuthorization = true;
+ await agent.get('/admin/').auth('admin', 'admin-password').expect(200);
+ });
+ describe('login fails if password is nullish', function () {
+ for (const adminPassword of [undefined, null]) {
+ // https://tools.ietf.org/html/rfc7617 says that the username and password are sent as
+ // base64(username + ':' + password), but there's nothing stopping a malicious user from
+ // sending just base64(username) (no colon). The lack of colon could throw off credential
+ // parsing, resulting in successful comparisons against a null or undefined password.
+ for (const creds of ['admin', 'admin:']) {
+ it(`admin password: ${adminPassword} credentials: ${creds}`, async function () {
+ settings.users.admin.password = adminPassword;
+ const encCreds = Buffer.from(creds).toString('base64');
+ await agent.get('/admin/').set('Authorization', `Basic ${encCreds}`).expect(401);
+ });
+ }
+ }
+ });
});
-
- // authz failure tests
- it('authz fail, no hooks handle -> 403', async function () {
- await agent.get('/').auth('user', 'user-password').expect(403);
- assert(!handlers.authnFailure.called);
- assert(handlers.authzFailure.called);
- assert(handlers.authFailure.called);
- });
- it('authz fail, authzFailure handles', async function () {
- handlers.authzFailure.shouldHandle = true;
- await agent.get('/').auth('user', 'user-password').expect(200, 'authzFailure');
- assert(!handlers.authnFailure.called);
- assert(handlers.authzFailure.called);
- assert(!handlers.authFailure.called);
- });
- it('authz fail, authFailure handles', async function () {
- handlers.authFailure.shouldHandle = true;
- await agent.get('/').auth('user', 'user-password').expect(200, 'authFailure');
- assert(!handlers.authnFailure.called);
- assert(handlers.authzFailure.called);
- assert(handlers.authFailure.called);
+ describe('webaccess: preAuthorize, authenticate, and authorize hooks', function () {
+ let callOrder;
+ const Handler = class {
+ constructor(hookName, suffix) {
+ this.called = false;
+ this.hookName = hookName;
+ this.innerHandle = () => [];
+ this.id = hookName + suffix;
+ this.checkContext = () => { };
+ }
+ handle(hookName, context, cb) {
+ assert.equal(hookName, this.hookName);
+ assert(context != null);
+ assert(context.req != null);
+ assert(context.res != null);
+ assert(context.next != null);
+ this.checkContext(context);
+ assert(!this.called);
+ this.called = true;
+ callOrder.push(this.id);
+ return cb(this.innerHandle(context));
+ }
+ };
+ const handlers = {};
+ beforeEach(async function () {
+ callOrder = [];
+ for (const hookName of authHookNames) {
+ // Create two handlers for each hook to test deferral to the next function.
+ const h0 = new Handler(hookName, '_0');
+ const h1 = new Handler(hookName, '_1');
+ handlers[hookName] = [h0, h1];
+ plugins.hooks[hookName] = [
+ makeHook(hookName, h0.handle.bind(h0)),
+ makeHook(hookName, h1.handle.bind(h1)),
+ ];
+ }
+ });
+ describe('preAuthorize', function () {
+ beforeEach(async function () {
+ settings.requireAuthentication = false;
+ settings.requireAuthorization = false;
+ });
+ it('defers if it returns []', async function () {
+ await agent.get('/').expect(200);
+ // Note: The preAuthorize hook always runs even if requireAuthorization is false.
+ assert.deepEqual(callOrder, ['preAuthorize_0', 'preAuthorize_1']);
+ });
+ it('bypasses authenticate and authorize hooks when true is returned', async function () {
+ settings.requireAuthentication = true;
+ settings.requireAuthorization = true;
+ handlers.preAuthorize[0].innerHandle = () => [true];
+ await agent.get('/').expect(200);
+ assert.deepEqual(callOrder, ['preAuthorize_0']);
+ });
+ it('bypasses authenticate and authorize hooks when false is returned', async function () {
+ settings.requireAuthentication = true;
+ settings.requireAuthorization = true;
+ handlers.preAuthorize[0].innerHandle = () => [false];
+ await agent.get('/').expect(403);
+ assert.deepEqual(callOrder, ['preAuthorize_0']);
+ });
+ it('bypasses authenticate and authorize hooks when next is called', async function () {
+ settings.requireAuthentication = true;
+ settings.requireAuthorization = true;
+ handlers.preAuthorize[0].innerHandle = ({ next }) => next();
+ await agent.get('/').expect(200);
+ assert.deepEqual(callOrder, ['preAuthorize_0']);
+ });
+ it('static content (expressPreSession) bypasses all auth checks', async function () {
+ settings.requireAuthentication = true;
+ settings.requireAuthorization = true;
+ await agent.get('/static/robots.txt').expect(200);
+ assert.deepEqual(callOrder, []);
+ });
+ it('cannot grant access to /admin', async function () {
+ handlers.preAuthorize[0].innerHandle = () => [true];
+ await agent.get('/admin/').expect(401);
+ // Notes:
+ // * preAuthorize[1] is called despite preAuthorize[0] returning a non-empty list because
+ // 'true' entries are ignored for /admin/* requests.
+ // * The authenticate hook always runs for /admin/* requests even if
+ // settings.requireAuthentication is false.
+ assert.deepEqual(callOrder, ['preAuthorize_0',
+ 'preAuthorize_1',
+ 'authenticate_0',
+ 'authenticate_1']);
+ });
+ it('can deny access to /admin', async function () {
+ handlers.preAuthorize[0].innerHandle = () => [false];
+ await agent.get('/admin/').auth('admin', 'admin-password').expect(403);
+ assert.deepEqual(callOrder, ['preAuthorize_0']);
+ });
+ it('runs preAuthzFailure hook when access is denied', async function () {
+ handlers.preAuthorize[0].innerHandle = () => [false];
+ let called = false;
+ plugins.hooks.preAuthzFailure = [makeHook('preAuthzFailure', (hookName, { req, res }, cb) => {
+ assert.equal(hookName, 'preAuthzFailure');
+ assert(req != null);
+ assert(res != null);
+ assert(!called);
+ called = true;
+ res.status(200).send('injected');
+ return cb([true]);
+ })];
+ await agent.get('/admin/').auth('admin', 'admin-password').expect(200, 'injected');
+ assert(called);
+ });
+ it('returns 500 if an exception is thrown', async function () {
+ handlers.preAuthorize[0].innerHandle = () => { throw new Error('exception test'); };
+ await agent.get('/').expect(500);
+ });
+ });
+ describe('authenticate', function () {
+ beforeEach(async function () {
+ settings.requireAuthentication = true;
+ settings.requireAuthorization = false;
+ });
+ it('is not called if !requireAuthentication and not /admin/*', async function () {
+ settings.requireAuthentication = false;
+ await agent.get('/').expect(200);
+ assert.deepEqual(callOrder, ['preAuthorize_0', 'preAuthorize_1']);
+ });
+ it('is called if !requireAuthentication and /admin/*', async function () {
+ settings.requireAuthentication = false;
+ await agent.get('/admin/').expect(401);
+ assert.deepEqual(callOrder, ['preAuthorize_0',
+ 'preAuthorize_1',
+ 'authenticate_0',
+ 'authenticate_1']);
+ });
+ it('defers if empty list returned', async function () {
+ await agent.get('/').expect(401);
+ assert.deepEqual(callOrder, ['preAuthorize_0',
+ 'preAuthorize_1',
+ 'authenticate_0',
+ 'authenticate_1']);
+ });
+ it('does not defer if return [true], 200', async function () {
+ handlers.authenticate[0].innerHandle = ({ req }) => { req.session.user = {}; return [true]; };
+ await agent.get('/').expect(200);
+ // Note: authenticate_1 was not called because authenticate_0 handled it.
+ assert.deepEqual(callOrder, ['preAuthorize_0', 'preAuthorize_1', 'authenticate_0']);
+ });
+ it('does not defer if return [false], 401', async function () {
+ handlers.authenticate[0].innerHandle = () => [false];
+ await agent.get('/').expect(401);
+ // Note: authenticate_1 was not called because authenticate_0 handled it.
+ assert.deepEqual(callOrder, ['preAuthorize_0', 'preAuthorize_1', 'authenticate_0']);
+ });
+ it('falls back to HTTP basic auth', async function () {
+ await agent.get('/').auth('user', 'user-password').expect(200);
+ assert.deepEqual(callOrder, ['preAuthorize_0',
+ 'preAuthorize_1',
+ 'authenticate_0',
+ 'authenticate_1']);
+ });
+ it('passes settings.users in context', async function () {
+ handlers.authenticate[0].checkContext = ({ users }) => {
+ assert.equal(users, settings.users);
+ };
+ await agent.get('/').expect(401);
+ assert.deepEqual(callOrder, ['preAuthorize_0',
+ 'preAuthorize_1',
+ 'authenticate_0',
+ 'authenticate_1']);
+ });
+ it('passes user, password in context if provided', async function () {
+ handlers.authenticate[0].checkContext = ({ username, password }) => {
+ assert.equal(username, 'user');
+ assert.equal(password, 'user-password');
+ };
+ await agent.get('/').auth('user', 'user-password').expect(200);
+ assert.deepEqual(callOrder, ['preAuthorize_0',
+ 'preAuthorize_1',
+ 'authenticate_0',
+ 'authenticate_1']);
+ });
+ it('does not pass user, password in context if not provided', async function () {
+ handlers.authenticate[0].checkContext = ({ username, password }) => {
+ assert(username == null);
+ assert(password == null);
+ };
+ await agent.get('/').expect(401);
+ assert.deepEqual(callOrder, ['preAuthorize_0',
+ 'preAuthorize_1',
+ 'authenticate_0',
+ 'authenticate_1']);
+ });
+ it('errors if req.session.user is not created', async function () {
+ handlers.authenticate[0].innerHandle = () => [true];
+ await agent.get('/').expect(500);
+ assert.deepEqual(callOrder, ['preAuthorize_0', 'preAuthorize_1', 'authenticate_0']);
+ });
+ it('returns 500 if an exception is thrown', async function () {
+ handlers.authenticate[0].innerHandle = () => { throw new Error('exception test'); };
+ await agent.get('/').expect(500);
+ assert.deepEqual(callOrder, ['preAuthorize_0', 'preAuthorize_1', 'authenticate_0']);
+ });
+ });
+ describe('authorize', function () {
+ beforeEach(async function () {
+ settings.requireAuthentication = true;
+ settings.requireAuthorization = true;
+ });
+ it('is not called if !requireAuthorization (non-/admin)', async function () {
+ settings.requireAuthorization = false;
+ await agent.get('/').auth('user', 'user-password').expect(200);
+ assert.deepEqual(callOrder, ['preAuthorize_0',
+ 'preAuthorize_1',
+ 'authenticate_0',
+ 'authenticate_1']);
+ });
+ it('is not called if !requireAuthorization (/admin)', async function () {
+ settings.requireAuthorization = false;
+ await agent.get('/admin/').auth('admin', 'admin-password').expect(200);
+ assert.deepEqual(callOrder, ['preAuthorize_0',
+ 'preAuthorize_1',
+ 'authenticate_0',
+ 'authenticate_1']);
+ });
+ it('defers if empty list returned', async function () {
+ await agent.get('/').auth('user', 'user-password').expect(403);
+ assert.deepEqual(callOrder, ['preAuthorize_0',
+ 'preAuthorize_1',
+ 'authenticate_0',
+ 'authenticate_1',
+ 'authorize_0',
+ 'authorize_1']);
+ });
+ it('does not defer if return [true], 200', async function () {
+ handlers.authorize[0].innerHandle = () => [true];
+ await agent.get('/').auth('user', 'user-password').expect(200);
+ // Note: authorize_1 was not called because authorize_0 handled it.
+ assert.deepEqual(callOrder, ['preAuthorize_0',
+ 'preAuthorize_1',
+ 'authenticate_0',
+ 'authenticate_1',
+ 'authorize_0']);
+ });
+ it('does not defer if return [false], 403', async function () {
+ handlers.authorize[0].innerHandle = () => [false];
+ await agent.get('/').auth('user', 'user-password').expect(403);
+ // Note: authorize_1 was not called because authorize_0 handled it.
+ assert.deepEqual(callOrder, ['preAuthorize_0',
+ 'preAuthorize_1',
+ 'authenticate_0',
+ 'authenticate_1',
+ 'authorize_0']);
+ });
+ it('passes req.path in context', async function () {
+ handlers.authorize[0].checkContext = ({ resource }) => {
+ assert.equal(resource, '/');
+ };
+ await agent.get('/').auth('user', 'user-password').expect(403);
+ assert.deepEqual(callOrder, ['preAuthorize_0',
+ 'preAuthorize_1',
+ 'authenticate_0',
+ 'authenticate_1',
+ 'authorize_0',
+ 'authorize_1']);
+ });
+ it('returns 500 if an exception is thrown', async function () {
+ handlers.authorize[0].innerHandle = () => { throw new Error('exception test'); };
+ await agent.get('/').auth('user', 'user-password').expect(500);
+ assert.deepEqual(callOrder, ['preAuthorize_0',
+ 'preAuthorize_1',
+ 'authenticate_0',
+ 'authenticate_1',
+ 'authorize_0']);
+ });
+ });
});
- it('authzFailure trumps authFailure', async function () {
- handlers.authzFailure.shouldHandle = true;
- handlers.authFailure.shouldHandle = true;
- await agent.get('/').auth('user', 'user-password').expect(200, 'authzFailure');
- assert(handlers.authzFailure.called);
- assert(!handlers.authFailure.called);
+ describe('webaccess: authnFailure, authzFailure, authFailure hooks', function () {
+ const Handler = class {
+ constructor(hookName) {
+ this.hookName = hookName;
+ this.shouldHandle = false;
+ this.called = false;
+ }
+ handle(hookName, context, cb) {
+ assert.equal(hookName, this.hookName);
+ assert(context != null);
+ assert(context.req != null);
+ assert(context.res != null);
+ assert(!this.called);
+ this.called = true;
+ if (this.shouldHandle) {
+ context.res.status(200).send(this.hookName);
+ return cb([true]);
+ }
+ return cb([]);
+ }
+ };
+ const handlers = {};
+ beforeEach(async function () {
+ failHookNames.forEach((hookName) => {
+ const handler = new Handler(hookName);
+ handlers[hookName] = handler;
+ plugins.hooks[hookName] = [makeHook(hookName, handler.handle.bind(handler))];
+ });
+ settings.requireAuthentication = true;
+ settings.requireAuthorization = true;
+ });
+ // authn failure tests
+ it('authn fail, no hooks handle -> 401', async function () {
+ await agent.get('/').expect(401);
+ assert(handlers.authnFailure.called);
+ assert(!handlers.authzFailure.called);
+ assert(handlers.authFailure.called);
+ });
+ it('authn fail, authnFailure handles', async function () {
+ handlers.authnFailure.shouldHandle = true;
+ await agent.get('/').expect(200, 'authnFailure');
+ assert(handlers.authnFailure.called);
+ assert(!handlers.authzFailure.called);
+ assert(!handlers.authFailure.called);
+ });
+ it('authn fail, authFailure handles', async function () {
+ handlers.authFailure.shouldHandle = true;
+ await agent.get('/').expect(200, 'authFailure');
+ assert(handlers.authnFailure.called);
+ assert(!handlers.authzFailure.called);
+ assert(handlers.authFailure.called);
+ });
+ it('authnFailure trumps authFailure', async function () {
+ handlers.authnFailure.shouldHandle = true;
+ handlers.authFailure.shouldHandle = true;
+ await agent.get('/').expect(200, 'authnFailure');
+ assert(handlers.authnFailure.called);
+ assert(!handlers.authFailure.called);
+ });
+ // authz failure tests
+ it('authz fail, no hooks handle -> 403', async function () {
+ await agent.get('/').auth('user', 'user-password').expect(403);
+ assert(!handlers.authnFailure.called);
+ assert(handlers.authzFailure.called);
+ assert(handlers.authFailure.called);
+ });
+ it('authz fail, authzFailure handles', async function () {
+ handlers.authzFailure.shouldHandle = true;
+ await agent.get('/').auth('user', 'user-password').expect(200, 'authzFailure');
+ assert(!handlers.authnFailure.called);
+ assert(handlers.authzFailure.called);
+ assert(!handlers.authFailure.called);
+ });
+ it('authz fail, authFailure handles', async function () {
+ handlers.authFailure.shouldHandle = true;
+ await agent.get('/').auth('user', 'user-password').expect(200, 'authFailure');
+ assert(!handlers.authnFailure.called);
+ assert(handlers.authzFailure.called);
+ assert(handlers.authFailure.called);
+ });
+ it('authzFailure trumps authFailure', async function () {
+ handlers.authzFailure.shouldHandle = true;
+ handlers.authFailure.shouldHandle = true;
+ await agent.get('/').auth('user', 'user-password').expect(200, 'authzFailure');
+ assert(handlers.authzFailure.called);
+ assert(!handlers.authFailure.called);
+ });
});
- });
});
From aa6323e4884dd3acefec18448d3f7c68ecce3d7c Mon Sep 17 00:00:00 2001
From: SamTV12345 <40429738+samtv12345@users.noreply.github.com>
Date: Sun, 25 Jun 2023 13:22:01 +0200
Subject: [PATCH 06/11] Fixed startup to "Running npm to get a list of
installed plugins"
---
src/node/db/API.ts | 14 +-
src/node/handler/PadMessageHandler.ts | 64 +-
src/node/hooks/i18n.ts | 2 +-
src/node/utils/ExportHelper.ts | 8 +-
src/node/utils/ExportHtml.ts | 30 +-
src/node/utils/ImportHtml.ts | 14 +-
src/node/utils/Settings.ts | 4 +-
src/node/utils/UpdateCheck.ts | 7 +-
src/node/utils/padDiff.ts | 79 +-
src/package-lock.json | 9 +-
src/package.json | 3 +-
...ttributeManager.js => AttributeManager.ts} | 6 +-
.../js/{AttributeMap.js => AttributeMap.ts} | 1 +
src/static/js/{Changeset.js => Changeset.ts} | 37 +-
.../{ChangesetUtils.js => ChangesetUtils.ts} | 2 +-
.../js/{ChatMessage.js => ChatMessage.ts} | 11 +-
src/static/js/ace.ts | 13 +-
.../js/{attributes.js => attributes.ts} | 0
...rror_handler.js => basic_error_handler.ts} | 4 +-
src/static/js/{broadcast.js => broadcast.ts} | 65 +-
...st_revisions.js => broadcast_revisions.ts} | 12 +-
...roadcast_slider.js => broadcast_slider.ts} | 28 +-
.../js/{caretPosition.js => caretPosition.ts} | 4 +-
...hangesettracker.js => changesettracker.ts} | 5 +-
src/static/js/{chat.js => chat.ts} | 33 +-
.../js/{collab_client.js => collab_client.ts} | 38 +-
src/static/js/colorutils.js | 102 --
src/static/js/colorutils.ts | 113 +++
...ontentcollector.js => contentcollector.ts} | 456 +++++++--
.../js/{cssmanager.js => cssmanager.ts} | 0
src/static/js/domline.js | 244 -----
src/static/js/domline.ts | 408 ++++++++
src/static/js/{index.js => index.ts} | 15 +-
src/static/js/l10n.js | 14 -
...{linestylefilter.js => linestylefilter.ts} | 247 ++---
src/static/js/{pad.js => pad.ts} | 10 +-
...econnect.js => pad_automatic_reconnect.ts} | 7 +-
...ctionstatus.js => pad_connectionstatus.ts} | 9 +-
.../js/{pad_cookie.js => pad_cookie.ts} | 9 +-
.../js/{pad_editbar.js => pad_editbar.ts} | 2 +
.../js/{pad_editor.js => pad_editor.ts} | 2 +
.../js/{pad_impexp.js => pad_impexp.ts} | 28 +-
.../js/{pad_modals.js => pad_modals.ts} | 0
.../js/{pad_savedrevs.js => pad_savedrevs.ts} | 9 +-
.../js/{pad_userlist.js => pad_userlist.ts} | 50 +-
src/static/js/pad_utils.ts | 15 +-
.../{client_plugins.js => client_plugins.ts} | 2 +
src/static/js/pluginfw/plugin_defs.ts | 4 +-
src/static/js/pluginfw/plugins.ts | 8 +-
src/static/js/{rjquery.js => rjquery.ts} | 2 +
src/static/js/{scroll.js => scroll.ts} | 7 +-
src/static/js/security.js | 2 -
src/static/js/security.ts | 10 +
.../js/{skin_variants.js => skin_variants.ts} | 0
src/static/js/{skiplist.js => skiplist.ts} | 18 +-
src/static/js/{socketio.js => socketio.ts} | 8 +-
.../js/{timeslider.js => timeslider.ts} | 2 +
src/static/js/underscore.js | 2 -
.../js/{undomodule.js => undomodule.ts} | 2 +-
src/static/js/vendors/html10n.js | 943 ------------------
src/static/js/vendors/i18next.ts | 15 +
src/static/module/CustomWindow.ts | 40 +
src/tsconfig.json | 3 +-
63 files changed, 1535 insertions(+), 1766 deletions(-)
rename src/static/js/{AttributeManager.js => AttributeManager.ts} (99%)
rename src/static/js/{AttributeMap.js => AttributeMap.ts} (99%)
rename src/static/js/{Changeset.js => Changeset.ts} (98%)
rename src/static/js/{ChangesetUtils.js => ChangesetUtils.ts} (98%)
rename src/static/js/{ChatMessage.js => ChatMessage.ts} (92%)
rename src/static/js/{attributes.js => attributes.ts} (100%)
rename src/static/js/{basic_error_handler.js => basic_error_handler.ts} (94%)
rename src/static/js/{broadcast.js => broadcast.ts} (89%)
rename src/static/js/{broadcast_revisions.js => broadcast_revisions.ts} (92%)
rename src/static/js/{broadcast_slider.js => broadcast_slider.ts} (89%)
rename src/static/js/{caretPosition.js => caretPosition.ts} (97%)
rename src/static/js/{changesettracker.js => changesettracker.ts} (97%)
rename src/static/js/{chat.js => chat.ts} (90%)
mode change 100755 => 100644
rename src/static/js/{collab_client.js => collab_client.ts} (94%)
delete mode 100644 src/static/js/colorutils.js
create mode 100644 src/static/js/colorutils.ts
rename src/static/js/{contentcollector.js => contentcollector.ts} (57%)
rename src/static/js/{cssmanager.js => cssmanager.ts} (100%)
delete mode 100644 src/static/js/domline.js
create mode 100644 src/static/js/domline.ts
rename src/static/js/{index.js => index.ts} (83%)
delete mode 100644 src/static/js/l10n.js
rename src/static/js/{linestylefilter.js => linestylefilter.ts} (51%)
rename src/static/js/{pad.js => pad.ts} (99%)
rename src/static/js/{pad_automatic_reconnect.js => pad_automatic_reconnect.ts} (96%)
rename src/static/js/{pad_connectionstatus.js => pad_connectionstatus.ts} (95%)
rename src/static/js/{pad_cookie.js => pad_cookie.ts} (87%)
rename src/static/js/{pad_editbar.js => pad_editbar.ts} (99%)
rename src/static/js/{pad_editor.js => pad_editor.ts} (99%)
rename src/static/js/{pad_impexp.js => pad_impexp.ts} (85%)
rename src/static/js/{pad_modals.js => pad_modals.ts} (100%)
rename src/static/js/{pad_savedrevs.js => pad_savedrevs.ts} (81%)
rename src/static/js/{pad_userlist.js => pad_userlist.ts} (94%)
rename src/static/js/pluginfw/{client_plugins.js => client_plugins.ts} (99%)
rename src/static/js/{rjquery.js => rjquery.ts} (73%)
rename src/static/js/{scroll.js => scroll.ts} (97%)
delete mode 100644 src/static/js/security.js
create mode 100644 src/static/js/security.ts
rename src/static/js/{skin_variants.js => skin_variants.ts} (100%)
rename src/static/js/{skiplist.js => skiplist.ts} (96%)
rename src/static/js/{socketio.js => socketio.ts} (84%)
rename src/static/js/{timeslider.js => timeslider.ts} (98%)
delete mode 100644 src/static/js/underscore.js
rename src/static/js/{undomodule.js => undomodule.ts} (99%)
delete mode 100644 src/static/js/vendors/html10n.js
create mode 100644 src/static/js/vendors/i18next.ts
diff --git a/src/node/db/API.ts b/src/node/db/API.ts
index 6f585ccee09..5f07339085b 100644
--- a/src/node/db/API.ts
+++ b/src/node/db/API.ts
@@ -19,7 +19,7 @@
* limitations under the License.
*/
-import Changeset from '../../static/js/Changeset';
+import {builder, deserializeOps} from '../../static/js/Changeset';
import ChatMessage from '../../static/js/ChatMessage';
import {CustomError} from '../utils/customError';
import {doesPadExist, getPad, isValidPadId, listAllPads} from './PadManager';
@@ -518,7 +518,7 @@ export const restoreRevision = async (padID, rev, authorId = '') => {
let textIndex = 0;
const newTextStart = 0;
const newTextEnd = atext.text.length;
- for (const op of Changeset.deserializeOps(attribs)) {
+ for (const op of deserializeOps(attribs)) {
const nextIndex = textIndex + op.chars;
if (!(nextIndex <= newTextStart || textIndex >= newTextEnd)) {
func(Math.max(newTextStart, textIndex), Math.min(newTextEnd, nextIndex), op.attribs);
@@ -528,19 +528,19 @@ export const restoreRevision = async (padID, rev, authorId = '') => {
};
// create a new changeset with a helper builder object
- const builder = Changeset.builder(oldText.length);
+ const builder2 = builder(oldText.length);
// assemble each line into the builder
eachAttribRun(atext.attribs, (start, end, attribs) => {
- builder.insert(atext.text.substring(start, end), attribs);
+ builder2.insert(atext.text.substring(start, end), attribs);
});
const lastNewlinePos = oldText.lastIndexOf('\n');
if (lastNewlinePos < 0) {
- builder.remove(oldText.length - 1, 0);
+ builder2.remove(oldText.length - 1, 0);
} else {
- builder.remove(lastNewlinePos, oldText.match(/\n/g).length - 1);
- builder.remove(oldText.length - lastNewlinePos - 1, 0);
+ builder2.remove(lastNewlinePos, oldText.match(/\n/g).length - 1);
+ builder2.remove(oldText.length - lastNewlinePos - 1, 0);
}
const changeset = builder.toString();
diff --git a/src/node/handler/PadMessageHandler.ts b/src/node/handler/PadMessageHandler.ts
index 07f939fa713..52f47092612 100644
--- a/src/node/handler/PadMessageHandler.ts
+++ b/src/node/handler/PadMessageHandler.ts
@@ -21,7 +21,16 @@
import AttributeMap from '../../static/js/AttributeMap';
import {getPad} from '../db/PadManager';
-import {} from '../../static/js/Changeset';
+import {
+ builder,
+ checkRep, cloneAText, compose,
+ deserializeOps,
+ follow, inverse, makeAText,
+ makeSplice,
+ moveOpsToNewPool, mutateAttributionLines, mutateTextLines,
+ oldLen, prepareForWire, splitAttributionLines, splitTextLines,
+ unpack
+} from '../../static/js/Changeset';
import ChatMessage from '../../static/js/ChatMessage';
import {AttributePool} from '../../static/js/AttributePool';
import AttributeManager from '../../static/js/AttributeManager';
@@ -62,6 +71,7 @@ import {ErrorCaused} from "../models/ErrorCaused";
import {Pad} from "../db/Pad";
import {SessionInfo} from "../models/SessionInfo";
import {randomString} from "../utils/randomstring";
+import {identity} from "lodash";
const securityManager = require('../db/SecurityManager');
@@ -610,10 +620,10 @@ const handleUserChanges = async (socket, message) => {
const pad = await getPad(thisSession.padId, null, thisSession.author);
// Verify that the changeset has valid syntax and is in canonical form
- Changeset.checkRep(changeset);
+ checkRep(changeset);
// Validate all added 'author' attribs to be the same value as the current user
- for (const op of Changeset.deserializeOps(Changeset.unpack(changeset).ops)) {
+ for (const op of deserializeOps(unpack(changeset).ops)) {
// + can add text with attribs
// = can change or add attribs
// - can have attribs, but they are discarded and don't show up in the attribs -
@@ -632,7 +642,7 @@ const handleUserChanges = async (socket, message) => {
// ex. adoptChangesetAttribs
// Afaik, it copies the new attributes from the changeset, to the global Attribute Pool
- let rebasedChangeset = Changeset.moveOpsToNewPool(changeset, wireApool, pad.pool);
+ let rebasedChangeset = moveOpsToNewPool(changeset, wireApool, pad.pool);
// ex. applyUserChanges
let r = baseRev;
@@ -645,21 +655,21 @@ const handleUserChanges = async (socket, message) => {
const {changeset: c, meta: {author: authorId}} = await pad.getRevision(r);
if (changeset === c && thisSession.author === authorId) {
// Assume this is a retransmission of an already applied changeset.
- rebasedChangeset = Changeset.identity(Changeset.unpack(changeset).oldLen);
+ rebasedChangeset = identity(unpack(changeset).oldLen);
}
// At this point, both "c" (from the pad) and "changeset" (from the
// client) are relative to revision r - 1. The follow function
// rebases "changeset" so that it is relative to revision r
// and can be applied after "c".
- rebasedChangeset = Changeset.follow(c, rebasedChangeset, false, pad.pool);
+ rebasedChangeset = follow(c, rebasedChangeset, false, pad.pool);
}
const prevText = pad.text();
- if (Changeset.oldLen(rebasedChangeset) !== prevText.length) {
+ if (oldLen(rebasedChangeset) !== prevText.length) {
throw new Error(
`Can't apply changeset ${rebasedChangeset} with oldLen ` +
- `${Changeset.oldLen(rebasedChangeset)} to document of length ${prevText.length}`);
+ `${oldLen(rebasedChangeset)} to document of length ${prevText.length}`);
}
const newRev = await pad.appendRevision(rebasedChangeset, thisSession.author);
@@ -674,7 +684,7 @@ const handleUserChanges = async (socket, message) => {
// Make sure the pad always ends with an empty line.
if (pad.text().lastIndexOf('\n') !== pad.text().length - 1) {
- const nlChangeset = Changeset.makeSplice(pad.text(), pad.text().length - 1, 0, '\n');
+ const nlChangeset = makeSplice(pad.text(), pad.text().length - 1, 0, '\n');
await pad.appendRevision(nlChangeset, thisSession.author);
}
@@ -729,7 +739,7 @@ export const updatePadClients = async (pad) => {
const revChangeset = revision.changeset;
const currentTime = revision.meta.timestamp;
- const forWire = Changeset.prepareForWire(revChangeset, pad.pool);
+ const forWire = prepareForWire(revChangeset, pad.pool);
const msg = {
type: 'COLLABROOM',
data: {
@@ -764,7 +774,7 @@ const _correctMarkersInPad = (atext, apool) => {
// that aren't at the start of a line
const badMarkers = [];
let offset = 0;
- for (const op of Changeset.deserializeOps(atext.attribs)) {
+ for (const op of deserializeOps(atext.attribs)) {
const attribs = AttributeMap.fromString(op.attribs, apool);
const hasMarker = AttributeManager.lineAttributes.some((a) => attribs.has(a));
if (hasMarker) {
@@ -786,15 +796,15 @@ const _correctMarkersInPad = (atext, apool) => {
// create changeset that removes these bad markers
offset = 0;
- const builder = Changeset.builder(text.length);
+ const builder2 = builder(text.length);
badMarkers.forEach((pos) => {
- builder.keepText(text.substring(offset, pos));
- builder.remove(1);
+ builder2.keepText(text.substring(offset, pos));
+ builder2.remove(1);
offset = pos + 1;
});
- return builder.toString();
+ return builder2.toString();
};
export let clientVars:any
@@ -918,7 +928,7 @@ const handleClientReady = async (socket, message) => {
// return pending changesets
for (const r of revisionsNeeded) {
- const forWire = Changeset.prepareForWire(changesets[r].changeset, pad.pool);
+ const forWire = prepareForWire(changesets[r].changeset, pad.pool);
const wireMsg = {type: 'COLLABROOM',
data: {type: 'CLIENT_RECONNECT',
headRev: pad.getHeadRevisionNumber(),
@@ -943,8 +953,8 @@ const handleClientReady = async (socket, message) => {
let apool;
// prepare all values for the wire, there's a chance that this throws, if the pad is corrupted
try {
- atext = Changeset.cloneAText(pad.atext);
- const attribsForWire = Changeset.prepareForWire(atext.attribs, pad.pool);
+ atext = cloneAText(pad.atext);
+ const attribsForWire = prepareForWire(atext.attribs, pad.pool);
apool = attribsForWire.pool.toJsonable();
atext.attribs = attribsForWire.translated;
} catch (e) {
@@ -1175,13 +1185,13 @@ const getChangesetInfo = async (pad: Pad, startNum: number, endNum: number, gran
if (compositeEnd > endNum || compositeEnd > headRevision + 1) break;
const forwards = composedChangesets[`${compositeStart}/${compositeEnd}`];
- const backwards = Changeset.inverse(forwards, lines.textlines, lines.alines, pad.apool());
+ const backwards = inverse(forwards, lines.textlines, lines.alines, pad.apool());
- Changeset.mutateAttributionLines(forwards, lines.alines, pad.apool());
- Changeset.mutateTextLines(forwards, lines.textlines);
+ mutateAttributionLines(forwards, lines.alines, pad.apool());
+ mutateTextLines(forwards, lines.textlines);
- const forwards2 = Changeset.moveOpsToNewPool(forwards, pad.apool(), apool);
- const backwards2 = Changeset.moveOpsToNewPool(backwards, pad.apool(), apool);
+ const forwards2 = moveOpsToNewPool(forwards, pad.apool(), apool);
+ const backwards2 = moveOpsToNewPool(backwards, pad.apool(), apool);
const t1 = (compositeStart === 0) ? revisionDate[0] : revisionDate[compositeStart - 1];
const t2 = revisionDate[compositeEnd - 1];
@@ -1209,12 +1219,12 @@ const getPadLines = async (pad, revNum) => {
if (revNum >= 0) {
atext = await pad.getInternalRevisionAText(revNum);
} else {
- atext = Changeset.makeAText('\n');
+ atext = makeAText('\n');
}
return {
- textlines: Changeset.splitTextLines(atext.text),
- alines: Changeset.splitAttributionLines(atext.attribs, atext.text),
+ textlines: splitTextLines(atext.text),
+ alines: splitAttributionLines(atext.attribs, atext.text),
};
};
@@ -1249,7 +1259,7 @@ const composePadChangesets = async (pad, startNum, endNum) => {
for (r = startNum + 1; r < endNum; r++) {
const cs = changesets[r];
- changeset = Changeset.compose(changeset, cs, pool);
+ changeset = compose(changeset, cs, pool);
}
return changeset;
} catch (e) {
diff --git a/src/node/hooks/i18n.ts b/src/node/hooks/i18n.ts
index 7ce55f74482..001e87bd07d 100644
--- a/src/node/hooks/i18n.ts
+++ b/src/node/hooks/i18n.ts
@@ -50,7 +50,7 @@ const getAllLocales = () => {
// Build a locale index (merge all locale data other than user-supplied overrides)
const locales = {};
- _.each(locales2paths, (files, langcode) => {
+ _.each(locales2paths, (files:[], langcode) => {
locales[langcode] = {};
files.forEach((file) => {
diff --git a/src/node/utils/ExportHelper.ts b/src/node/utils/ExportHelper.ts
index b4a5765eed6..814ceef335d 100644
--- a/src/node/utils/ExportHelper.ts
+++ b/src/node/utils/ExportHelper.ts
@@ -20,12 +20,12 @@
*/
import AttributeMap from '../../static/js/AttributeMap';
-import Changeset from '../../static/js/Changeset';
+import {deserializeOps, splitAttributionLines, subattribution} from '../../static/js/Changeset';
export const getPadPlainText = (pad, revNum) => {
const atext = ((revNum !== undefined) ? pad.getInternalRevisionAText(revNum) : pad.atext);
const textLines = atext.text.slice(0, -1).split('\n');
- const attribLines = Changeset.splitAttributionLines(atext.attribs, atext.text);
+ const attribLines = splitAttributionLines(atext.attribs, atext.text);
const apool = pad.pool;
const pieces = [];
@@ -57,7 +57,7 @@ export const _analyzeLine = (text, aline, apool) => {
let lineMarker = 0;
line.listLevel = 0;
if (aline) {
- const [op] = Changeset.deserializeOps(aline);
+ const [op] = deserializeOps(aline);
if (op != null) {
const attribs = AttributeMap.fromString(op.attribs, apool);
let listType = attribs.get('list');
@@ -77,7 +77,7 @@ export const _analyzeLine = (text, aline, apool) => {
}
if (lineMarker) {
line.text = text.substring(1);
- line.aline = Changeset.subattribution(aline, 1);
+ line.aline = subattribution(aline, 1);
} else {
line.text = text;
line.aline = aline;
diff --git a/src/node/utils/ExportHtml.ts b/src/node/utils/ExportHtml.ts
index 8ec4fc104cf..5de740f5516 100644
--- a/src/node/utils/ExportHtml.ts
+++ b/src/node/utils/ExportHtml.ts
@@ -15,14 +15,22 @@
* limitations under the License.
*/
-import Changeset from '../../static/js/Changeset';
-import attributes from "../../static/js/attributes";
+import {
+ deserializeOps,
+ splitAttributionLines,
+ stringAssembler,
+ stringIterator,
+ subattribution
+} from '../../static/js/Changeset';
+import {decodeAttribString} from "../../static/js/attributes";
import {getPad} from "../db/PadManager";
import _ from "underscore";
-import Security from '../../static/js/security';
+// FIXME this is a hack to get around the fact that we don't have a good way
+// @ts-ignore
+import {escapeHTML,escapeHTMLAttribute} from '../../static/js/security';
import {aCallAll} from '../../static/js/pluginfw/hooks';
import {required} from '../eejs';
import {_analyzeLine, _encodeWhitespace} from "./ExportHelper";
@@ -44,7 +52,7 @@ const getPadHTML = async (pad, revNum) => {
export const getHTMLFromAtext = async (pad, atext, authorColors?) => {
const apool = pad.apool();
const textLines = atext.text.slice(0, -1).split('\n');
- const attribLines = Changeset.splitAttributionLines(atext.attribs, atext.text);
+ const attribLines = splitAttributionLines(atext.attribs, atext.text);
const tags = ['h1', 'h2', 'strong', 'em', 'u', 's'];
const props = ['heading1', 'heading2', 'bold', 'italic', 'underline', 'strikethrough'];
@@ -127,8 +135,8 @@ export const getHTMLFromAtext = async (pad, atext, authorColors?) => {
// Just boldBold and italicsJust italics
// becomes
// Just bold Bold and italicsJust italics
- const taker = Changeset.stringIterator(text);
- const assem = Changeset.stringAssembler();
+ const taker = stringIterator(text);
+ const assem = stringAssembler();
const openTags = [];
const getSpanClassFor = (i) => {
@@ -200,7 +208,7 @@ export const getHTMLFromAtext = async (pad, atext, authorColors?) => {
return;
}
- const ops = Changeset.deserializeOps(Changeset.subattribution(attribs, idx, idx + numChars));
+ const ops = deserializeOps(subattribution(attribs, idx, idx + numChars));
idx += numChars;
// this iterates over every op string and decides which tags to open or to close
@@ -209,7 +217,7 @@ export const getHTMLFromAtext = async (pad, atext, authorColors?) => {
const usedAttribs = [];
// mark all attribs as used
- for (const a of attributes.decodeAttribString(o.attribs)) {
+ for (const a of decodeAttribString(o.attribs)) {
if (a in anumMap) {
usedAttribs.push(anumMap[a]); // i = 0 => bold, etc.
}
@@ -249,7 +257,7 @@ export const getHTMLFromAtext = async (pad, atext, authorColors?) => {
// from but they break the abiword parser and are completly useless
s = s.replace(String.fromCharCode(12), '');
- assem.append(_encodeWhitespace(Security.escapeHTML(s)));
+ assem.append(_encodeWhitespace(escapeHTML(s)));
} // end iteration over spans in line
// close all the tags that are open after the last op
@@ -272,7 +280,7 @@ export const getHTMLFromAtext = async (pad, atext, authorColors?) => {
// https://html.spec.whatwg.org/multipage/links.html#link-type-noopener
// https://mathiasbynens.github.io/rel-noopener/
// https://github.com/ether/etherpad-lite/pull/3636
- assem.append(``);
+ assem.append(``);
processNextChars(urlLength);
assem.append('');
});
@@ -477,7 +485,7 @@ export const getPadHTMLDocument = async (padId, revNum, readOnlyId?) => {
return required('ep_etherpad-lite/templates/export_html.html', {
body: html,
- padId: Security.escapeHTML(readOnlyId || padId),
+ padId: escapeHTML(readOnlyId || padId),
extraCSS: stylesForExportCSS,
});
};
diff --git a/src/node/utils/ImportHtml.ts b/src/node/utils/ImportHtml.ts
index 2e5de910aff..34dfb05e42e 100644
--- a/src/node/utils/ImportHtml.ts
+++ b/src/node/utils/ImportHtml.ts
@@ -16,8 +16,8 @@
*/
import log4js from 'log4js';
-import Changeset from '../../static/js/Changeset';
-import contentcollector from '../../static/js/contentcollector';
+import {builder, deserializeOps} from '../../static/js/Changeset';
+import {makeContentCollector} from '../../static/js/contentcollector';
import jsdom from 'jsdom';
const apiLogger = log4js.getLogger('ImportHtml');
@@ -42,7 +42,7 @@ export const setPadHTML = async (pad, html, authorId = '') => {
// Convert a dom tree into a list of lines and attribute liens
// using the content collector object
- const cc = contentcollector.makeContentCollector(true, null, pad.pool);
+ const cc = makeContentCollector(true, null, pad.pool);
try {
// we use a try here because if the HTML is bad it will blow up
cc.collectContent(document.body);
@@ -68,24 +68,24 @@ export const setPadHTML = async (pad, html, authorId = '') => {
const newAttribs = `${result.lineAttribs.join('|1+1')}|1+1`;
// create a new changeset with a helper builder object
- const builder = Changeset.builder(1);
+ const builder2 = builder(1);
// assemble each line into the builder
let textIndex = 0;
const newTextStart = 0;
const newTextEnd = newText.length;
- for (const op of Changeset.deserializeOps(newAttribs)) {
+ for (const op of deserializeOps(newAttribs)) {
const nextIndex = textIndex + op.chars;
if (!(nextIndex <= newTextStart || textIndex >= newTextEnd)) {
const start = Math.max(newTextStart, textIndex);
const end = Math.min(newTextEnd, nextIndex);
- builder.insert(newText.substring(start, end), op.attribs);
+ builder2.insert(newText.substring(start, end), op.attribs);
}
textIndex = nextIndex;
}
// the changeset is ready!
- const theChangeset = builder.toString();
+ const theChangeset = builder2.toString();
apiLogger.debug(`The changeset: ${theChangeset}`);
await pad.setText('\n', authorId);
diff --git a/src/node/utils/Settings.ts b/src/node/utils/Settings.ts
index a505974698e..e12c14c7f3b 100644
--- a/src/node/utils/Settings.ts
+++ b/src/node/utils/Settings.ts
@@ -28,7 +28,7 @@
*/
import exp from "constants";
-
+import packageJSON from '../../../package.json'
import {findEtherpadRoot, makeAbsolute, isSubdir} from './AbsolutePaths';
import deepEqual from 'fast-deep-equal/es6';
import fs from 'fs';
@@ -507,7 +507,7 @@ export const getGitCommit = () => {
};
// Return etherpad version from package.json
-export const getEpVersion = () => require('../../package.json').version;
+export const getEpVersion = () => packageJSON.version;
/**
* Receives a settingsObj and, if the property name is a valid configuration
diff --git a/src/node/utils/UpdateCheck.ts b/src/node/utils/UpdateCheck.ts
index de18d2f179e..b80bfb954d3 100644
--- a/src/node/utils/UpdateCheck.ts
+++ b/src/node/utils/UpdateCheck.ts
@@ -48,12 +48,11 @@ export const needsUpdate = (cb?:(arg0: boolean)=>void) => {
}
const check = () => {
- const needsUpdate = ((needsUpdate: boolean) => {
- if (needsUpdate && infos) {
- console.warn(`Update available: Download the latest version ${infos.latestVersion}`);
+ needsUpdate((needsUpdate)=>{
+ if (needsUpdate) {
+ console.warn(`Update available: Download the actual version ${infos.latestVersion}`);
}
})
- needsUpdate(infos.latestVersion > getEpVersion());
}
export default {check, getLatestVersion}
diff --git a/src/node/utils/padDiff.ts b/src/node/utils/padDiff.ts
index 88dd3d4b407..737f830676a 100644
--- a/src/node/utils/padDiff.ts
+++ b/src/node/utils/padDiff.ts
@@ -1,9 +1,18 @@
'use strict';
import AttributeMap from '../../static/js/AttributeMap';
-import Changeset from '../../static/js/Changeset';
-import attributes from '../../static/js/attributes';
+import {
+ applyToAText,
+ builder, checkRep,
+ compose,
+ deserializeOps,
+ numToString, Op,
+ opAssembler, pack, splitAttributionLines, splitTextLines, stringAssembler,
+ unpack
+} from '../../static/js/Changeset';
+import {attribsFromString} from '../../static/js/attributes';
import {getHTMLFromAtext} from './ExportHtml';
+// @ts-ignore
import {PadDiffModel} from "ep_etherpad-lite/node/models/PadDiffModel";
export const PadDiff = (pad, fromRev, toRev)=> {
@@ -30,7 +39,7 @@ export const PadDiff = (pad, fromRev, toRev)=> {
PadDiff.prototype._isClearAuthorship = function (changeset) {
// unpack
- const unpacked = Changeset.unpack(changeset);
+ const unpacked = unpack(changeset);
// check if there is nothing in the charBank
if (unpacked.charBank !== '') {
@@ -42,7 +51,7 @@ PadDiff.prototype._isClearAuthorship = function (changeset) {
return false;
}
- const [clearOperator, anotherOp] = Changeset.deserializeOps(unpacked.ops);
+ const [clearOperator, anotherOp] = deserializeOps(unpacked.ops);
// check if there is only one operator
if (anotherOp != null) return false;
@@ -59,7 +68,7 @@ PadDiff.prototype._isClearAuthorship = function (changeset) {
}
const [appliedAttribute, anotherAttribute] =
- attributes.attribsFromString(clearOperator.attribs, this._pad.pool);
+ attribsFromString(clearOperator.attribs, this._pad.pool);
// Check that the operation has exactly one attribute.
if (appliedAttribute == null || anotherAttribute != null) return false;
@@ -76,9 +85,9 @@ PadDiff.prototype._createClearAuthorship = async function (rev) {
const atext = await this._pad.getInternalRevisionAText(rev);
// build clearAuthorship changeset
- const builder = Changeset.builder(atext.text.length);
- builder.keepText(atext.text, [['author', '']], this._pad.pool);
- const changeset = builder.toString();
+ const builder2 = builder(atext.text.length);
+ builder2.keepText(atext.text, [['author', '']], this._pad.pool);
+ const changeset = builder2.toString();
return changeset;
};
@@ -91,7 +100,7 @@ PadDiff.prototype._createClearStartAtext = async function (rev) {
const changeset = await this._createClearAuthorship(rev);
// apply the clearAuthorship changeset
- const newAText = Changeset.applyToAText(changeset, atext, this._pad.pool);
+ const newAText = applyToAText(changeset, atext, this._pad.pool);
return newAText;
};
@@ -160,7 +169,7 @@ PadDiff.prototype._createDiffAtext = async function () {
if (superChangeset == null) {
superChangeset = changeset;
} else {
- superChangeset = Changeset.compose(superChangeset, changeset, this._pad.pool);
+ superChangeset = compose(superChangeset, changeset, this._pad.pool);
}
}
@@ -174,10 +183,10 @@ PadDiff.prototype._createDiffAtext = async function () {
const deletionChangeset = this._createDeletionChangeset(superChangeset, atext, this._pad.pool);
// apply the superChangeset, which includes all addings
- atext = Changeset.applyToAText(superChangeset, atext, this._pad.pool);
+ atext = applyToAText(superChangeset, atext, this._pad.pool);
// apply the deletionChangeset, which adds a deletions
- atext = Changeset.applyToAText(deletionChangeset, atext, this._pad.pool);
+ atext = applyToAText(deletionChangeset, atext, this._pad.pool);
}
return atext;
@@ -217,22 +226,22 @@ PadDiff.prototype.getAuthors = async function () {
PadDiff.prototype._extendChangesetWithAuthor = (changeset, author, apool) => {
// unpack
- const unpacked = Changeset.unpack(changeset);
+ const unpacked = unpack(changeset);
- const assem = Changeset.opAssembler();
+ const assem = opAssembler();
// create deleted attribs
const authorAttrib = apool.putAttrib(['author', author || '']);
const deletedAttrib = apool.putAttrib(['removed', true]);
- const attribs = `*${Changeset.numToString(authorAttrib)}*${Changeset.numToString(deletedAttrib)}`;
+ const attribs = `*${numToString(authorAttrib)}*${numToString(deletedAttrib)}`;
- for (const operator of Changeset.deserializeOps(unpacked.ops)) {
+ for (const operator of deserializeOps(unpacked.ops)) {
if (operator.opcode === '-') {
// this is a delete operator, extend it with the author
operator.attribs = attribs;
} else if (operator.opcode === '=' && operator.attribs) {
// this is operator changes only attributes, let's mark which author did that
- operator.attribs += `*${Changeset.numToString(authorAttrib)}`;
+ operator.attribs += `*${numToString(authorAttrib)}`;
}
// append the new operator to our assembler
@@ -240,14 +249,14 @@ PadDiff.prototype._extendChangesetWithAuthor = (changeset, author, apool) => {
}
// return the modified changeset
- return Changeset.pack(unpacked.oldLen, unpacked.newLen, assem.toString(), unpacked.charBank);
+ return pack(unpacked.oldLen, unpacked.newLen, assem.toString(), unpacked.charBank);
};
// this method is 80% like Changeset.inverse. I just changed so instead of reverting,
// it adds deletions and attribute changes to to the atext.
PadDiff.prototype._createDeletionChangeset = function (cs, startAText, apool) {
- const lines = Changeset.splitTextLines(startAText.text);
- const alines = Changeset.splitAttributionLines(startAText.attribs, startAText.text);
+ const lines = splitTextLines(startAText.text);
+ const alines = splitAttributionLines(startAText.attribs, startAText.text);
// lines and alines are what the exports is meant to apply to.
// They may be arrays or objects with .get(i) and .length methods.
@@ -274,14 +283,14 @@ PadDiff.prototype._createDeletionChangeset = function (cs, startAText, apool) {
let curLineOps = null;
let curLineOpsNext = null;
let curLineOpsLine;
- let curLineNextOp = new Changeset.Op('+');
+ let curLineNextOp = new Op('+');
- const unpacked = Changeset.unpack(cs);
- const builder = Changeset.builder(unpacked.newLen);
+ const unpacked = unpack(cs);
+ const builder2 = builder(unpacked.newLen);
const consumeAttribRuns = (numChars, func /* (len, attribs, endsLine)*/) => {
if (!curLineOps || curLineOpsLine !== curLine) {
- curLineOps = Changeset.deserializeOps(aLinesGet(curLine));
+ curLineOps = deserializeOps(aLinesGet(curLine));
curLineOpsNext = curLineOps.next();
curLineOpsLine = curLine;
let indexIntoLine = 0;
@@ -302,13 +311,13 @@ PadDiff.prototype._createDeletionChangeset = function (cs, startAText, apool) {
curChar = 0;
curLineOpsLine = curLine;
curLineNextOp.chars = 0;
- curLineOps = Changeset.deserializeOps(aLinesGet(curLine));
+ curLineOps = deserializeOps(aLinesGet(curLine));
curLineOpsNext = curLineOps.next();
}
if (!curLineNextOp.chars) {
if (curLineOpsNext.done) {
- curLineNextOp = new Changeset.Op();
+ curLineNextOp = new Op();
} else {
curLineNextOp = curLineOpsNext.value;
curLineOpsNext = curLineOps.next();
@@ -343,7 +352,7 @@ PadDiff.prototype._createDeletionChangeset = function (cs, startAText, apool) {
const nextText = (numChars) => {
let len = 0;
- const assem = Changeset.stringAssembler();
+ const assem = stringAssembler();
const firstString = linesGet(curLine).substring(curChar);
len += firstString.length;
assem.append(firstString);
@@ -371,7 +380,7 @@ PadDiff.prototype._createDeletionChangeset = function (cs, startAText, apool) {
};
};
- for (const csOp of Changeset.deserializeOps(unpacked.ops)) {
+ for (const csOp of deserializeOps(unpacked.ops)) {
if (csOp.opcode === '=') {
const textBank = nextText(csOp.chars);
@@ -417,7 +426,7 @@ PadDiff.prototype._createDeletionChangeset = function (cs, startAText, apool) {
textLeftToProcess = textLeftToProcess.substr(lengthToProcess);
if (lineBreak) {
- builder.keep(1, 1); // just skip linebreaks, don't do a insert + keep for a linebreak
+ builder2.keep(1, 1); // just skip linebreaks, don't do a insert + keep for a linebreak
// consume the attributes of this linebreak
consumeAttribRuns(1, () => {});
@@ -429,31 +438,31 @@ PadDiff.prototype._createDeletionChangeset = function (cs, startAText, apool) {
// get the old attributes back
const oldAttribs = undoBackToAttribs(attribs);
- builder.insert(processText.substr(textBankIndex, len), oldAttribs);
+ builder2.insert(processText.substr(textBankIndex, len), oldAttribs);
textBankIndex += len;
});
- builder.keep(lengthToProcess, 0);
+ builder2.keep(lengthToProcess, 0);
}
}
} else {
skip(csOp.chars, csOp.lines);
- builder.keep(csOp.chars, csOp.lines);
+ builder2.keep(csOp.chars, csOp.lines);
}
} else if (csOp.opcode === '+') {
- builder.keep(csOp.chars, csOp.lines);
+ builder2.keep(csOp.chars, csOp.lines);
} else if (csOp.opcode === '-') {
const textBank = nextText(csOp.chars);
let textBankIndex = 0;
consumeAttribRuns(csOp.chars, (len, attribs, endsLine) => {
- builder.insert(textBank.substr(textBankIndex, len), attribs + csOp.attribs);
+ builder2.insert(textBank.substr(textBankIndex, len), attribs + csOp.attribs);
textBankIndex += len;
});
}
}
- return Changeset.checkRep(builder.toString());
+ return checkRep(builder.toString());
};
// export the constructor
diff --git a/src/package-lock.json b/src/package-lock.json
index 47345ad47bc..4a9eb06ba79 100644
--- a/src/package-lock.json
+++ b/src/package-lock.json
@@ -40,7 +40,7 @@
"rehype-minify-whitespace": "^5.0.1",
"request": "2.88.2",
"resolve": "1.22.2",
- "security": "1.0.0",
+ "security": "^1.0.0",
"semver": "^7.5.2",
"socket.io": "^2.4.1",
"superagent": "^8.0.9",
@@ -62,6 +62,7 @@
"@types/jquery": "^3.5.16",
"@types/js-cookie": "^3.0.3",
"@types/node": "^20.3.1",
+ "@types/underscore": "^1.11.5",
"concurrently": "^8.2.0",
"eslint": "^8.14.0",
"eslint-config-etherpad": "^3.0.13",
@@ -1227,6 +1228,12 @@
"@types/node": "*"
}
},
+ "node_modules/@types/underscore": {
+ "version": "1.11.5",
+ "resolved": "https://registry.npmjs.org/@types/underscore/-/underscore-1.11.5.tgz",
+ "integrity": "sha512-b8e//LrIlhoXaaBcMC0J/s2/lIF9y5VJYKqbW4nA+tW/nqqDk1Dacd1ULLT7zgGsKs7PGbSnqCPzqEniZ0RxYg==",
+ "dev": true
+ },
"node_modules/@types/unist": {
"version": "2.0.6",
"resolved": "https://registry.npmjs.org/@types/unist/-/unist-2.0.6.tgz",
diff --git a/src/package.json b/src/package.json
index 9b8a08abe2b..df513c468e2 100644
--- a/src/package.json
+++ b/src/package.json
@@ -61,7 +61,7 @@
"rehype-minify-whitespace": "^5.0.1",
"request": "2.88.2",
"resolve": "1.22.2",
- "security": "1.0.0",
+ "security": "^1.0.0",
"semver": "^7.5.2",
"socket.io": "^2.4.1",
"superagent": "^8.0.9",
@@ -83,6 +83,7 @@
"@types/jquery": "^3.5.16",
"@types/js-cookie": "^3.0.3",
"@types/node": "^20.3.1",
+ "@types/underscore": "^1.11.5",
"concurrently": "^8.2.0",
"eslint": "^8.14.0",
"eslint-config-etherpad": "^3.0.13",
diff --git a/src/static/js/AttributeManager.js b/src/static/js/AttributeManager.ts
similarity index 99%
rename from src/static/js/AttributeManager.js
rename to src/static/js/AttributeManager.ts
index 5734769f687..67a71c0ee6a 100644
--- a/src/static/js/AttributeManager.js
+++ b/src/static/js/AttributeManager.ts
@@ -2,7 +2,9 @@ import AttributeMap from "./AttributeMap.js";
import * as Changeset from "./Changeset.js";
import * as ChangesetUtils from "./ChangesetUtils.js";
import * as attributes from "./attributes.js";
-import * as _ from "./underscore.js";
+import _ from "underscore";
+export { map, each, identity} from "underscore";
+
'use strict';
const lineMarkerAttribute = 'lmkr';
// Some of these attributes are kept for compatibility purposes.
@@ -255,7 +257,7 @@ AttributeManager.prototype = _(AttributeManager.prototype).extend({
@param lineNum: the number of the line to set the attribute for
@param attributeKey: the name of the attribute to set, e.g. list
@param attributeValue: an optional parameter to pass to the attribute (e.g. indention level)
-
+
*/
setAttributeOnLine(lineNum, attributeName, attributeValue) {
let loc = [0, 0];
diff --git a/src/static/js/AttributeMap.js b/src/static/js/AttributeMap.ts
similarity index 99%
rename from src/static/js/AttributeMap.js
rename to src/static/js/AttributeMap.ts
index 4e55eb8a71f..ae39f9a05b9 100644
--- a/src/static/js/AttributeMap.js
+++ b/src/static/js/AttributeMap.ts
@@ -17,6 +17,7 @@ import * as attributes from "./attributes.js";
* Convenience class to convert an Op's attribute string to/from a Map of key, value pairs.
*/
class AttributeMap extends Map {
+ pool: any;
/**
* Converts an attribute string into an AttributeMap.
*
diff --git a/src/static/js/Changeset.js b/src/static/js/Changeset.ts
similarity index 98%
rename from src/static/js/Changeset.js
rename to src/static/js/Changeset.ts
index c6fa8402ecb..db29738abcc 100644
--- a/src/static/js/Changeset.js
+++ b/src/static/js/Changeset.ts
@@ -1,7 +1,8 @@
import AttributeMap from "./AttributeMap.js";
-import AttributePool from "./AttributePool.js";
+import {AttributePool} from "./AttributePool";
import * as attributes from "./attributes.js";
import { padutils } from "./pad_utils.js";
+import {CustomError} from "../../node/utils/customError";
'use strict';
/**
* A `[key, value]` pair of strings describing a text attribute.
@@ -22,7 +23,7 @@ import { padutils } from "./pad_utils.js";
* @param {string} msg - Just some message
*/
const error = (msg) => {
- const e = new Error(msg);
+ const e = new CustomError(msg);
e.easysync = true;
throw e;
};
@@ -42,6 +43,10 @@ const assert = (b, msg) => {
* An operation to apply to a shared document.
*/
class Op {
+ chars: number;
+ opcode: string;
+ lines: number;
+ attribs: string;
/**
* @param {(''|'='|'+'|'-')} [opcode=''] - Initial value of the `opcode` property.
*/
@@ -113,6 +118,8 @@ class Op {
* @deprecated Use `deserializeOps` instead.
*/
class OpIter {
+ private _gen: any;
+ private _next: any;
/**
* @param {string} ops - String encoding the change operations to iterate over.
*/
@@ -240,6 +247,12 @@ const opsFromText = function* (opcode, text, attribs = '', pool = null) {
* with no newlines.
*/
class TextLinesMutator {
+ _lines: any;
+ // FIXME What is this for a type?
+ _curSplice: any[];
+ _inSplice: boolean;
+ _curLine: number;
+ _curCol: number;
/**
* @param {(string[]|StringArrayLike)} lines - Lines to mutate (in place).
*/
@@ -362,7 +375,7 @@ class TextLinesMutator {
* @param {number} L -
* @param {boolean} includeInSplice - Indicates that attributes are present.
*/
- skipLines(L, includeInSplice) {
+ skipLines(L, includeInSplice?) {
if (!L)
return;
if (includeInSplice) {
@@ -906,7 +919,7 @@ export const mergingOpAssembler = () => {
/**
* @param {boolean} [isEndDocument]
*/
- const flush = (isEndDocument) => {
+ const flush = (isEndDocument?: boolean) => {
if (!bufOp.opcode)
return;
if (isEndDocument && bufOp.opcode === '=' && !bufOp.attribs) {
@@ -1325,7 +1338,7 @@ export const attributeTester = (attribPair, pool) => {
return (attribs) => re.test(attribs);
};
export const identity = (N) => exports.pack(N, N, '', '');
-export const makeSplice = (orig, start, ndel, ins, attribs, pool) => {
+export const makeSplice = (orig, start, ndel, ins, attribs?, pool?) => {
if (start < 0)
throw new RangeError(`start index must be non-negative (is ${start})`);
if (ndel < 0)
@@ -1346,7 +1359,7 @@ export const makeSplice = (orig, start, ndel, ins, attribs, pool) => {
assem.endDocument();
return exports.pack(orig.length, orig.length + ins.length - ndel, assem.toString(), ins);
};
-export const characterRangeFollow = (cs, startChar, endChar, insertionsAfter) => {
+export const characterRangeFollow = (cs, startChar, endChar, insertionsAfter?) => {
let newStartChar = startChar;
let newEndChar = endChar;
let lengthChangeSoFar = 0;
@@ -1451,7 +1464,7 @@ export const mapAttribNumbers = (cs, func) => {
});
return newUpToDollar + cs.substring(dollarPos);
};
-export const makeAText = (text, attribs) => ({
+export const makeAText = (text, attribs?) => ({
text,
attribs: (attribs || exports.makeAttribution(text)),
});
@@ -1538,7 +1551,7 @@ export const builder = (oldLen) => {
* attribute key, value pairs.
* @returns {Builder} this
*/
- keep: (N, L, attribs, pool) => {
+ keep: (N, L, attribs?, pool?) => {
o.opcode = '=';
o.attribs = typeof attribs === 'string'
? attribs : new AttributeMap(pool).update(attribs || []).toString();
@@ -1555,7 +1568,7 @@ export const builder = (oldLen) => {
* attribute key, value pairs.
* @returns {Builder} this
*/
- keepText: (text, attribs, pool) => {
+ keepText: (text, attribs?, pool?) => {
for (const op of opsFromText('=', text, attribs, pool))
assem.append(op);
return self;
@@ -1568,7 +1581,7 @@ export const builder = (oldLen) => {
* attribute key, value pairs.
* @returns {Builder} this
*/
- insert: (text, attribs, pool) => {
+ insert: (text, attribs, pool?) => {
for (const op of opsFromText('+', text, attribs, pool))
assem.append(op);
charBank.append(text);
@@ -1580,7 +1593,7 @@ export const builder = (oldLen) => {
* character must be a newline.
* @returns {Builder} this
*/
- remove: (N, L) => {
+ remove: (N, L?) => {
o.opcode = '-';
o.attribs = '';
o.chars = N;
@@ -1605,7 +1618,7 @@ export const makeAttribsString = (opcode, attribs, pool) => {
return attribs;
return new AttributeMap(pool).update(attribs, opcode === '+').toString();
};
-export const subattribution = (astr, start, optEnd) => {
+export const subattribution = (astr, start, optEnd?) => {
const attOps = exports.deserializeOps(astr);
let attOpsNext = attOps.next();
const assem = exports.smartOpAssembler();
diff --git a/src/static/js/ChangesetUtils.js b/src/static/js/ChangesetUtils.ts
similarity index 98%
rename from src/static/js/ChangesetUtils.js
rename to src/static/js/ChangesetUtils.ts
index b63481a5167..a527f1e74f0 100644
--- a/src/static/js/ChangesetUtils.js
+++ b/src/static/js/ChangesetUtils.ts
@@ -10,7 +10,7 @@ export const buildRemoveRange = (rep, builder, start, end) => {
builder.remove(end[1] - start[1]);
}
};
-export const buildKeepRange = (rep, builder, start, end, attribs, pool) => {
+export const buildKeepRange = (rep, builder, start, end, attribs?, pool?) => {
const startLineOffset = rep.lines.offsetOfIndex(start[0]);
const endLineOffset = rep.lines.offsetOfIndex(end[0]);
if (end[0] > start[0]) {
diff --git a/src/static/js/ChatMessage.js b/src/static/js/ChatMessage.ts
similarity index 92%
rename from src/static/js/ChatMessage.js
rename to src/static/js/ChatMessage.ts
index c9cc87e2879..3873e00004a 100644
--- a/src/static/js/ChatMessage.js
+++ b/src/static/js/ChatMessage.ts
@@ -8,6 +8,10 @@ const { padutils: { warnDeprecated } } = { padutils };
* Supports serialization to JSON.
*/
class ChatMessage {
+ private text: any;
+ authorId: any;
+ private time: any;
+ displayName: null;
static fromObject(obj) {
// The userId property was renamed to authorId, and userName was renamed to displayName. Accept
// the old names in case the db record was written by an older version of Etherpad.
@@ -83,9 +87,10 @@ class ChatMessage {
// doesn't support authorId and displayName.
toJSON() {
const { authorId, displayName, ...obj } = this;
- obj.userId = authorId;
- obj.userName = displayName;
- return obj;
+ let objExtendable = obj as any
+ objExtendable.userId = authorId;
+ objExtendable.userName = displayName;
+ return objExtendable;
}
}
export default ChatMessage;
diff --git a/src/static/js/ace.ts b/src/static/js/ace.ts
index e6878c72043..310171dd41d 100644
--- a/src/static/js/ace.ts
+++ b/src/static/js/ace.ts
@@ -3,7 +3,8 @@ import { makeCSSManager as makeCSSManager$0 } from "./cssmanager.js";
import * as pluginUtils from "./pluginfw/shared.js";
import {Ace2EditorInfo, AceDocType} from "../module/Ace2EditorInfo";
import {clientVars} from "../../node/handler/PadMessageHandler";
-import {CustomWindow} from "../module/CustomWindow";
+import {CustomElementWithSheet, CustomWindow} from "../module/CustomWindow";
+import {required} from "../../node/eejs";
'use strict';
const makeCSSManager = { makeCSSManager: makeCSSManager$0 }.makeCSSManager;
@@ -244,17 +245,17 @@ const Ace2Editor = function () {
require.setLibraryURI(absUrl('../javascripts/lib'));
require.setGlobalKeyPath('require');
// intentially moved before requiring client_plugins to save a 307
- innerWindow.Ace2Inner = require('ep_etherpad-lite/static/js/ace2_inner');
- innerWindow.plugins = require('ep_etherpad-lite/static/js/pluginfw/client_plugins');
+ innerWindow.Ace2Inner = required('ep_etherpad-lite/static/js/ace2_inner');
+ innerWindow.plugins = required('ep_etherpad-lite/static/js/pluginfw/client_plugins');
innerWindow.plugins.adoptPluginsFromAncestorsOf(innerWindow);
- innerWindow.$ = innerWindow.jQuery = require('ep_etherpad-lite/static/js/rjquery').jQuery;
+ innerWindow.$ = innerWindow.jQuery = required('ep_etherpad-lite/static/js/rjquery').jQuery;
debugLog('Ace2Editor.init() waiting for plugins');
- await new Promise((resolve, reject) => innerWindow.plugins.ensure((err) => err != null ? reject(err) : resolve()));
+ await new Promise((resolve, reject) => innerWindow.plugins.ensure((err) => err != null ? reject(err) : resolve()));
debugLog('Ace2Editor.init() waiting for Ace2Inner.init()');
await innerWindow.Ace2Inner.init(info, {
inner: makeCSSManager(innerStyle.sheet),
outer: makeCSSManager(outerStyle.sheet),
- parent: makeCSSManager(document.querySelector('style[title="dynamicsyntax"]').sheet),
+ parent: makeCSSManager((document.querySelector('style[title="dynamicsyntax"]') as unknown as CustomElementWithSheet).sheet),
});
debugLog('Ace2Editor.init() Ace2Inner.init() returned');
loaded = true;
diff --git a/src/static/js/attributes.js b/src/static/js/attributes.ts
similarity index 100%
rename from src/static/js/attributes.js
rename to src/static/js/attributes.ts
diff --git a/src/static/js/basic_error_handler.js b/src/static/js/basic_error_handler.ts
similarity index 94%
rename from src/static/js/basic_error_handler.js
rename to src/static/js/basic_error_handler.ts
index 77f93f5d27d..e162aad625a 100644
--- a/src/static/js/basic_error_handler.js
+++ b/src/static/js/basic_error_handler.ts
@@ -20,7 +20,9 @@
const msgBlock = document.createElement('blockquote');
box.appendChild(msgBlock);
msgBlock.style.fontWeight = 'bold';
- msgBlock.appendChild(document.createTextNode(msg));
+ if (typeof msg === "string") {
+ msgBlock.appendChild(document.createTextNode(msg));
+ }
const loc = document.createElement('p');
box.appendChild(loc);
loc.appendChild(document.createTextNode(`in ${url}`));
diff --git a/src/static/js/broadcast.js b/src/static/js/broadcast.ts
similarity index 89%
rename from src/static/js/broadcast.js
rename to src/static/js/broadcast.ts
index d891b0d8163..0d8824c65f0 100644
--- a/src/static/js/broadcast.js
+++ b/src/static/js/broadcast.ts
@@ -1,12 +1,15 @@
import { makeCSSManager as makeCSSManager$0 } from "./cssmanager.js";
import { domline as domline$0 } from "./domline.js";
-import AttribPool from "./AttributePool.js";
+import {AttributePool} from "./AttributePool.js";
import * as Changeset from "./Changeset.js";
import * as attributes from "./attributes.js";
import { linestylefilter as linestylefilter$0 } from "./linestylefilter.js";
import { colorutils as colorutils$0 } from "./colorutils.js";
-import * as _ from "./underscore.js";
+import * as _ from "underscore";
import * as hooks from "./pluginfw/hooks.js";
+import {clientVars} from "../../node/handler/PadMessageHandler";
+import {Author, AuthorData, CustomElementWithSheet, CustomWindow} from "../module/CustomWindow";
+import {i18nextvar} from "./vendors/i18next";
'use strict';
/**
* This code is mostly from the old Etherpad. Please help us to comment this code.
@@ -53,9 +56,10 @@ const loadBroadcastJS = (socket, sendSocketMsg, fireWhenAllScriptsAreLoaded, Bro
currentLines: Changeset.splitTextLines(clientVars.collab_client_vars.initialAttributedText.text),
currentDivs: null,
// to be filled in once the dom loads
- apool: (new AttribPool()).fromJsonable(clientVars.collab_client_vars.apool),
+ apool: (new AttributePool()).fromJsonable(clientVars.collab_client_vars.apool),
alines: Changeset.splitAttributionLines(clientVars.collab_client_vars.initialAttributedText.attribs, clientVars.collab_client_vars.initialAttributedText.text),
// generates a jquery element containing HTML for a line
+ targetRevision: undefined,
lineToElement(line, aline) {
const element = document.createElement('div');
const emptyLine = (line === '\n');
@@ -64,7 +68,7 @@ const loadBroadcastJS = (socket, sendSocketMsg, fireWhenAllScriptsAreLoaded, Bro
domInfo.prepareForAdd();
element.className = domInfo.node.className;
element.innerHTML = domInfo.node.innerHTML;
- element.id = Math.random();
+ element.id = String(Math.random());
return $(element);
},
// splice the lines
@@ -172,11 +176,12 @@ const loadBroadcastJS = (socket, sendSocketMsg, fireWhenAllScriptsAreLoaded, Bro
padContents.currentRevision = revision;
padContents.currentTime += timeDelta * 1000;
updateTimer();
+ // @ts-ignore
const authors = _.map(padContents.getActiveAuthors(), (name) => authorData[name]);
BroadcastSlider.setAuthors(authors);
};
const loadedNewChangeset = (changesetForward, changesetBackward, revision, timeDelta) => {
- const revisionInfo = window.revisionInfo;
+ const revisionInfo = (window as unknown as CustomWindow).revisionInfo;
const broadcasting = (BroadcastSlider.getSliderPosition() === revisionInfo.latest);
revisionInfo.addChangeset(revision, revision + 1, changesetForward, changesetBackward, timeDelta);
BroadcastSlider.setSliderLength(revisionInfo.latest);
@@ -203,7 +208,7 @@ const loadBroadcastJS = (socket, sendSocketMsg, fireWhenAllScriptsAreLoaded, Bro
const hours = zpad(date.getHours(), 2);
const minutes = zpad(date.getMinutes(), 2);
const seconds = zpad(date.getSeconds(), 2);
- return (html10n.get('timeslider.dateformat', {
+ return (i18nextvar('timeslider.dateformat', {
day,
month,
year,
@@ -213,21 +218,21 @@ const loadBroadcastJS = (socket, sendSocketMsg, fireWhenAllScriptsAreLoaded, Bro
}));
};
$('#timer').html(dateFormat());
- const revisionDate = html10n.get('timeslider.saved', {
+ const revisionDate = i18nextvar('timeslider.saved', {
day: date.getDate(),
month: [
- html10n.get('timeslider.month.january'),
- html10n.get('timeslider.month.february'),
- html10n.get('timeslider.month.march'),
- html10n.get('timeslider.month.april'),
- html10n.get('timeslider.month.may'),
- html10n.get('timeslider.month.june'),
- html10n.get('timeslider.month.july'),
- html10n.get('timeslider.month.august'),
- html10n.get('timeslider.month.september'),
- html10n.get('timeslider.month.october'),
- html10n.get('timeslider.month.november'),
- html10n.get('timeslider.month.december'),
+ i18nextvar('timeslider.month.january'),
+ i18nextvar('timeslider.month.february'),
+ i18nextvar('timeslider.month.march'),
+ i18nextvar('timeslider.month.april'),
+ i18nextvar('timeslider.month.may'),
+ i18nextvar('timeslider.month.june'),
+ i18nextvar('timeslider.month.july'),
+ i18nextvar('timeslider.month.august'),
+ i18nextvar('timeslider.month.september'),
+ i18nextvar('timeslider.month.october'),
+ i18nextvar('timeslider.month.november'),
+ i18nextvar('timeslider.month.december'),
][date.getMonth()],
year: date.getFullYear(),
});
@@ -236,7 +241,7 @@ const loadBroadcastJS = (socket, sendSocketMsg, fireWhenAllScriptsAreLoaded, Bro
updateTimer();
const goToRevision = (newRevision) => {
padContents.targetRevision = newRevision;
- const path = window.revisionInfo.getPath(padContents.currentRevision, newRevision);
+ const path = (window as unknown as CustomWindow).revisionInfo.getPath(padContents.currentRevision, newRevision);
hooks.aCallAll('goToRevisionEvent', {
rev: newRevision,
});
@@ -273,10 +278,11 @@ const loadBroadcastJS = (socket, sendSocketMsg, fireWhenAllScriptsAreLoaded, Bro
// Loading changeset history for old revision (to make diff between old and new revision)
loadChangesetsForRevision(padContents.currentRevision - 1);
}
+ // @ts-ignore
const authors = _.map(padContents.getActiveAuthors(), (name) => authorData[name]);
BroadcastSlider.setAuthors(authors);
};
- const loadChangesetsForRevision = (revision, callback) => {
+ const loadChangesetsForRevision = (revision, callback?) => {
if (BroadcastSlider.getSliderLength() > 10000) {
const start = (Math.floor((revision) / 10000) * 10000); // revision 0 to 10
changesetLoader.queueUp(start, 100);
@@ -348,7 +354,7 @@ const loadBroadcastJS = (socket, sendSocketMsg, fireWhenAllScriptsAreLoaded, Bro
setTimeout(() => this.loadFromQueue(), 10);
},
handleResponse: (data, start, granularity, callback) => {
- const pool = (new AttribPool()).fromJsonable(data.apool);
+ const pool = (new AttributePool()).fromJsonable(data.apool);
for (let i = 0; i < data.forwardsChangesets.length; i++) {
const astart = start + i * granularity - 1; // rev -1 is a blank single line
let aend = start + (i + 1) * granularity - 1; // totalRevs is the most recent revision
@@ -357,7 +363,7 @@ const loadBroadcastJS = (socket, sendSocketMsg, fireWhenAllScriptsAreLoaded, Bro
// debugLog("adding changeset:", astart, aend);
const forwardcs = Changeset.moveOpsToNewPool(data.forwardsChangesets[i], pool, padContents.apool);
const backwardcs = Changeset.moveOpsToNewPool(data.backwardsChangesets[i], pool, padContents.apool);
- window.revisionInfo.addChangeset(astart, aend, forwardcs, backwardcs, data.timeDeltas[i]);
+ (window as unknown as CustomWindow).revisionInfo.addChangeset(astart, aend, forwardcs, backwardcs, data.timeDeltas[i]);
}
if (callback)
callback(start - 1, start + data.forwardsChangesets.length * granularity - 1);
@@ -366,15 +372,16 @@ const loadBroadcastJS = (socket, sendSocketMsg, fireWhenAllScriptsAreLoaded, Bro
if (obj.type === 'COLLABROOM') {
obj = obj.data;
if (obj.type === 'NEW_CHANGES') {
- const changeset = Changeset.moveOpsToNewPool(obj.changeset, (new AttribPool()).fromJsonable(obj.apool), padContents.apool);
+ const changeset = Changeset.moveOpsToNewPool(obj.changeset, (new AttributePool()).fromJsonable(obj.apool), padContents.apool);
let changesetBack = Changeset.inverse(obj.changeset, padContents.currentLines, padContents.alines, padContents.apool);
- changesetBack = Changeset.moveOpsToNewPool(changesetBack, (new AttribPool()).fromJsonable(obj.apool), padContents.apool);
+ changesetBack = Changeset.moveOpsToNewPool(changesetBack, (new AttributePool()).fromJsonable(obj.apool), padContents.apool);
loadedNewChangeset(changeset, changesetBack, obj.newRev - 1, obj.timeDelta);
}
else if (obj.type === 'NEW_AUTHORDATA') {
const authorMap = {};
authorMap[obj.author] = obj.data;
receiveAuthorData(authorMap);
+ // @ts-ignore
const authors = _.map(padContents.getActiveAuthors(), (name) => authorData[name]);
BroadcastSlider.setAuthors(authors);
}
@@ -412,13 +419,15 @@ const loadBroadcastJS = (socket, sendSocketMsg, fireWhenAllScriptsAreLoaded, Bro
goToRevisionIfEnabledCount--;
}
else {
+ //FIXME what to do?
+ // @ts-ignore
goToRevision(...args);
}
- };
+ }
BroadcastSlider.onSlider(goToRevisionIfEnabled);
- const dynamicCSS = makeCSSManager(document.querySelector('style[title="dynamicsyntax"]').sheet);
+ const dynamicCSS = makeCSSManager((document.querySelector('style[title="dynamicsyntax"]') as unknown as CustomElementWithSheet).sheet);
const authorData = {};
- const receiveAuthorData = (newAuthorData) => {
+ const receiveAuthorData = (newAuthorData: Author) => {
for (const [author, data] of Object.entries(newAuthorData)) {
const bgcolor = typeof data.colorId === 'number'
? clientVars.colorPalette[data.colorId] : data.colorId;
diff --git a/src/static/js/broadcast_revisions.js b/src/static/js/broadcast_revisions.ts
similarity index 92%
rename from src/static/js/broadcast_revisions.js
rename to src/static/js/broadcast_revisions.ts
index 9409cd978f4..f29e570b406 100644
--- a/src/static/js/broadcast_revisions.js
+++ b/src/static/js/broadcast_revisions.ts
@@ -4,6 +4,9 @@
* This helps other people to understand this code better and helps them to improve it.
* TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED
*/
+import {clientVars} from "../../node/handler/PadMessageHandler";
+import {CustomWindow} from "../module/CustomWindow";
+
/**
* Copyright 2009 Google Inc.
*
@@ -36,7 +39,12 @@ const loadBroadcastRevisionsJS = () => {
this.changesets.push(changesetWrapper);
this.changesets.sort((a, b) => (b.deltaRev - a.deltaRev));
};
- const revisionInfo = {};
+ const revisionInfo = {
+ latest: undefined,
+ addChangeset: undefined,
+ createNew: undefined,
+ getPath: undefined
+ };
revisionInfo.addChangeset = function (fromIndex, toIndex, changeset, backChangeset, timeDelta) {
const startRevision = this[fromIndex] || this.createNew(fromIndex);
const endRevision = this[toIndex] || this.createNew(toIndex);
@@ -95,6 +103,6 @@ const loadBroadcastRevisionsJS = () => {
times,
};
};
- window.revisionInfo = revisionInfo;
+ (window as unknown as CustomWindow).revisionInfo = revisionInfo;
};
export { loadBroadcastRevisionsJS };
diff --git a/src/static/js/broadcast_slider.js b/src/static/js/broadcast_slider.ts
similarity index 89%
rename from src/static/js/broadcast_slider.js
rename to src/static/js/broadcast_slider.ts
index c2478ae48cf..46d6866d314 100644
--- a/src/static/js/broadcast_slider.js
+++ b/src/static/js/broadcast_slider.ts
@@ -1,13 +1,17 @@
-import * as _ from "./underscore.js";
+import _ from "underscore";
+
import { padmodals as padmodals$0 } from "./pad_modals.js";
import { colorutils as colorutils$0 } from "./colorutils.js";
+import {i18nextvar} from "./vendors/i18next";
+import {clientVars} from "../../node/handler/PadMessageHandler";
+import {CustomElementWithSheet} from "../module/CustomWindow";
'use strict';
const padmodals = { padmodals: padmodals$0 }.padmodals;
const colorutils = { colorutils: colorutils$0 }.colorutils;
const loadBroadcastSliderJS = (fireWhenAllScriptsAreLoaded) => {
let BroadcastSlider;
// Hack to ensure timeslider i18n values are in
- $("[data-key='timeslider_returnToPad'] > a > span").html(html10n.get('timeslider.toolbar.returnbutton'));
+ $("[data-key='timeslider_returnToPad'] > a > span").html(i18nextvar('timeslider.toolbar.returnbutton'));
(() => {
let sliderLength = 1000;
let sliderPos = 0;
@@ -56,7 +60,7 @@ const loadBroadcastSliderJS = (fireWhenAllScriptsAreLoaded) => {
$('a.tlink').map(function () {
$(this).attr('href', $(this).attr('thref').replace('%revision%', newpos));
});
- $('#revision_label').html(html10n.get('timeslider.version', { version: newpos }));
+ $('#revision_label').html(i18nextvar('timeslider.version', { version: newpos }));
$('#leftstar, #leftstep').toggleClass('disabled', newpos === 0);
$('#rightstar, #rightstep').toggleClass('disabled', newpos === sliderLength);
sliderPos = newpos;
@@ -100,7 +104,7 @@ const loadBroadcastSliderJS = (fireWhenAllScriptsAreLoaded) => {
}
});
if (numAnonymous > 0) {
- const anonymousAuthorString = html10n.get('timeslider.unnamedauthors', { num: numAnonymous });
+ const anonymousAuthorString = i18nextvar('timeslider.unnamedauthors', { num: numAnonymous });
if (numNamed !== 0) {
authorsList.append(` + ${anonymousAuthorString}`);
}
@@ -121,7 +125,7 @@ const loadBroadcastSliderJS = (fireWhenAllScriptsAreLoaded) => {
}
}
if (authors.length === 0) {
- authorsList.append(html10n.get('timeslider.toolbar.authorsList'));
+ authorsList.append(i18nextvar('timeslider.toolbar.authorsList'));
}
};
const playButtonUpdater = () => {
@@ -163,7 +167,7 @@ const loadBroadcastSliderJS = (fireWhenAllScriptsAreLoaded) => {
fireWhenAllScriptsAreLoaded.push(() => {
$(document).keyup((e) => {
if (!e)
- e = window.event;
+ e = window.event as any
const code = e.keyCode || e.which;
if (code === 37) { // left
if (e.shiftKey) {
@@ -196,19 +200,19 @@ const loadBroadcastSliderJS = (fireWhenAllScriptsAreLoaded) => {
});
// Slider dragging
$('#ui-slider-handle').mousedown(function (evt) {
- this.startLoc = evt.clientX;
- this.currentLoc = parseInt($(this).css('left'));
+ (this as unknown as CustomElementWithSheet).startLoc = evt.clientX;
+ (this as unknown as CustomElementWithSheet).currentLoc = parseInt($(this).css('left'));
sliderActive = true;
$(document).mousemove((evt2) => {
$(this).css('pointer', 'move');
- let newloc = this.currentLoc + (evt2.clientX - this.startLoc);
+ let newloc = (this as unknown as CustomElementWithSheet).currentLoc + (evt2.clientX - (this as unknown as CustomElementWithSheet).startLoc);
if (newloc < 0)
newloc = 0;
const maxPos = $('#ui-slider-bar').width() - 2;
if (newloc > maxPos)
newloc = maxPos;
const version = Math.floor(newloc * sliderLength / maxPos);
- $('#revision_label').html(html10n.get('timeslider.version', { version }));
+ $('#revision_label').html(i18nextvar('timeslider.version', { version }));
$(this).css('left', newloc);
if (getSliderPosition() !== version)
_callSliderCallbacks(version);
@@ -217,7 +221,7 @@ const loadBroadcastSliderJS = (fireWhenAllScriptsAreLoaded) => {
$(document).unbind('mousemove');
$(document).unbind('mouseup');
sliderActive = false;
- let newloc = this.currentLoc + (evt2.clientX - this.startLoc);
+ let newloc = (this as unknown as CustomElementWithSheet).currentLoc + (evt2.clientX - (this as unknown as CustomElementWithSheet).startLoc);
if (newloc < 0)
newloc = 0;
const maxPos = $('#ui-slider-bar').width() - 2;
@@ -229,7 +233,7 @@ const loadBroadcastSliderJS = (fireWhenAllScriptsAreLoaded) => {
$(this).css('left', '2px');
}
else {
- this.currentLoc = parseInt($(this).css('left'));
+ (this as unknown as CustomElementWithSheet).currentLoc = parseInt($(this).css('left'));
}
});
});
diff --git a/src/static/js/caretPosition.js b/src/static/js/caretPosition.ts
similarity index 97%
rename from src/static/js/caretPosition.js
rename to src/static/js/caretPosition.ts
index 3a27b0d606e..688bb8f875d 100644
--- a/src/static/js/caretPosition.js
+++ b/src/static/js/caretPosition.ts
@@ -1,4 +1,6 @@
'use strict';
+import {CustomElementWithSheet} from "../module/CustomWindow";
+
const createSelectionRange = (range) => {
const clonedRange = range.cloneRange();
// we set the selection start and end to avoid error when user selects a text bigger than
@@ -122,7 +124,7 @@ const getSelectionRange = () => {
};
export const getPosition = () => {
const range = getSelectionRange();
- if (!range || $(range.endContainer).closest('body')[0].id !== 'innerdocbody')
+ if (!range || ($(range.endContainer).closest('body')[0] as unknown as CustomElementWithSheet).id !== 'innerdocbody')
return null;
// When there's a or any element that has no height, we can't get the dimension of the
// element where the caret is. As we can't get the element height, we create a text node to get
diff --git a/src/static/js/changesettracker.js b/src/static/js/changesettracker.ts
similarity index 97%
rename from src/static/js/changesettracker.js
rename to src/static/js/changesettracker.ts
index 5db0fb1920e..e4f8ed0295f 100644
--- a/src/static/js/changesettracker.js
+++ b/src/static/js/changesettracker.ts
@@ -1,6 +1,7 @@
import AttributeMap from "./AttributeMap.js";
-import AttributePool from "./AttributePool.js";
+import {AttributePool} from "./AttributePool.js";
import * as Changeset from "./Changeset.js";
+import {CustomWindow} from "../module/CustomWindow";
'use strict';
const makeChangesetTracker = (scheduler, apool, aceCallbacksProvider) => {
// latest official text from server
@@ -111,7 +112,7 @@ const makeChangesetTracker = (scheduler, apool, aceCallbacksProvider) => {
}
else {
// Get my authorID
- const authorId = parent.parent.pad.myUserInfo.userId;
+ const authorId = (parent.parent as unknown as CustomWindow).pad.myUserInfo.userId;
// Sanitize authorship: Replace all author attributes with this user's author ID in case the
// text was copied from another author.
const cs = Changeset.unpack(userChangeset);
diff --git a/src/static/js/chat.js b/src/static/js/chat.ts
old mode 100755
new mode 100644
similarity index 90%
rename from src/static/js/chat.js
rename to src/static/js/chat.ts
index 74d45104472..66257668cf7
--- a/src/static/js/chat.js
+++ b/src/static/js/chat.ts
@@ -4,6 +4,9 @@ import { padcookie as padcookie$0 } from "./pad_cookie.js";
import Tinycon from "tinycon/tinycon";
import * as hooks from "./pluginfw/hooks.js";
import { padeditor as padeditor$0 } from "./pad_editor.js";
+import {CustomWindow, JQueryGritter} from "../module/CustomWindow";
+import {pad} from "./pad";
+import {i18nextvar} from "./vendors/i18next";
'use strict';
const padutils = { padutils: padutils$0 }.padutils;
const padcookie = { padcookie: padcookie$0 }.padcookie;
@@ -15,6 +18,8 @@ export const chat = (() => {
let userAndChat = false;
let chatMentions = 0;
return {
+ historyPointer: undefined, gotInitalMessages: false,
+
show() {
$('#chaticon').removeClass('visible');
$('#chatbox').addClass('visible');
@@ -22,7 +27,7 @@ export const chat = (() => {
chatMentions = 0;
Tinycon.setBubble(0);
$('.chat-gritter-msg').each(function () {
- $.gritter.remove(this.id);
+ ($ as unknown as JQueryGritter).gritter.remove(this.id);
});
},
focus: () => {
@@ -31,7 +36,7 @@ export const chat = (() => {
}, 100);
},
// Make chat stick to right hand side of screen
- stickToScreen(fromInitialCall) {
+ stickToScreen(fromInitialCall?) {
if (pad.settings.hideChat) {
return;
}
@@ -46,7 +51,7 @@ export const chat = (() => {
padcookie.setPref('chatAlwaysVisible', isStuck);
$('#options-stickychat').prop('checked', isStuck);
},
- chatAndUsers(fromInitialCall) {
+ chatAndUsers(fromInitialCall?) {
const toEnable = $('#options-chatandusers').is(':checked');
if (toEnable || !userAndChat || fromInitialCall) {
this.stickToScreen(true);
@@ -76,7 +81,7 @@ export const chat = (() => {
$('#chatbox').removeClass('visible');
}
},
- scrollDown(force) {
+ scrollDown(force?) {
if ($('#chatbox').hasClass('visible')) {
if (force || !this.lastMessage || !this.lastMessage.position() ||
this.lastMessage.position().top < ($('#chattext').outerHeight() + 20)) {
@@ -89,7 +94,7 @@ export const chat = (() => {
},
async send() {
const text = $('#chatinput').val();
- if (text.replace(/\s+/, '').length === 0)
+ if (typeof text !== "string" || text?.replace(/\s+/, '').length === 0)
return;
const message = new ChatMessage(text);
await hooks.aCallAll('chatSendMessage', Object.freeze({ message }));
@@ -117,7 +122,7 @@ export const chat = (() => {
})}`;
// the hook args
const ctx = {
- authorName: msg.displayName != null ? msg.displayName : html10n.get('pad.userlist.unnamed'),
+ authorName: msg.displayName != null ? msg.displayName : i18nextvar('pad.userlist.unnamed'),
author: msg.authorId,
text: padutils.escapeHtmlWithClickableLinks(msg.text, '_blank'),
message: msg,
@@ -140,8 +145,8 @@ export const chat = (() => {
// does the user already have the chatbox open?
const chatOpen = $('#chatbox').hasClass('visible');
// does this message contain this user's name? (is the current user mentioned?)
- const wasMentioned = msg.authorId !== window.clientVars.userId &&
- ctx.authorName !== html10n.get('pad.userlist.unnamed') &&
+ const wasMentioned = msg.authorId !== (window as unknown as CustomWindow).clientVars.userId &&
+ ctx.authorName !== i18nextvar('pad.userlist.unnamed') &&
normalize(ctx.text).includes(normalize(ctx.authorName));
// If the user was mentioned, make the message sticky
if (wasMentioned && !alreadyFocused && !isHistoryAdd && !chatOpen) {
@@ -169,7 +174,10 @@ export const chat = (() => {
chatMsg.insertAfter('#chatloadmessagesbutton');
else
$('#chattext').append(chatMsg);
- chatMsg.each((i, e) => html10n.translateElement(html10n.translations, e));
+ chatMsg.each((i, e) => {
+ //TODO Fix this and return the component
+ i18nextvar(e)
+ });
// should we increment the counter??
if (increment && !isHistoryAdd) {
// Update the counter of unread messages
@@ -182,8 +190,11 @@ export const chat = (() => {
// ctx.text was HTML-escaped before calling the hook. Hook functions are trusted
// to not introduce an XSS vulnerability by adding unescaped user input.
.append($('
').html(ctx.text).contents());
- text.each((i, e) => html10n.translateElement(html10n.translations, e));
- $.gritter.add({
+ text.each((i, e) => {
+ //TODO Fix this and return the component
+ i18nextvar(e.getAttribute('data-l10n-id'))
+ });;
+ ($ as unknown as JQueryGritter).gritter.add({
text,
sticky: ctx.sticky,
time: ctx.duration,
diff --git a/src/static/js/collab_client.js b/src/static/js/collab_client.ts
similarity index 94%
rename from src/static/js/collab_client.js
rename to src/static/js/collab_client.ts
index 5652c331c02..e29f33d7d55 100644
--- a/src/static/js/collab_client.js
+++ b/src/static/js/collab_client.ts
@@ -1,6 +1,8 @@
import { chat as chat$0 } from "./chat.js";
import * as hooks from "./pluginfw/hooks.js";
import browser from "./vendors/browser.js";
+import {clientVars} from "../../node/handler/PadMessageHandler";
+import {AuthorData} from "../module/CustomWindow";
'use strict';
/**
* This code is mostly from the old Etherpad. Please help us to comment this code.
@@ -46,14 +48,14 @@ const getCollabClient = (ace2editor, serverVars, initialUserInfo, options, _pad)
userSet[userId] = initialUserInfo;
let isPendingRevision = false;
const callbacks = {
- onUserJoin: () => { },
- onUserLeave: () => { },
- onUpdateUserInfo: () => { },
- onChannelStateChange: () => { },
- onClientMessage: () => { },
- onInternalAction: () => { },
- onConnectionTrouble: () => { },
- onServerMessage: () => { },
+ onUserJoin: (arg?) => { },
+ onUserLeave: (arg?) => { },
+ onUpdateUserInfo: (arg?) => { },
+ onChannelStateChange: (arg?, addArg?) => { },
+ onClientMessage: (arg?) => { },
+ onInternalAction: (arg?) => { },
+ onConnectionTrouble: (arg?) => { },
+ onServerMessage: (arg?) => { },
};
if (browser.firefox) {
// Prevent "escape" from taking effect and canceling a comet connection;
@@ -151,6 +153,7 @@ const getCollabClient = (ace2editor, serverVars, initialUserInfo, options, _pad)
});
};
const serverMessageTaskQueue = new class {
+ private _promiseChain: Promise;
constructor() {
this._promiseChain = Promise.resolve();
}
@@ -309,7 +312,7 @@ const getCollabClient = (ace2editor, serverVars, initialUserInfo, options, _pad)
const tellAceActiveAuthorInfo = (userInfo) => {
tellAceAuthorInfo(userInfo.userId, userInfo.colorId);
};
- const tellAceAuthorInfo = (userId, colorId, inactive) => {
+ const tellAceAuthorInfo = (userId, colorId, inactive?) => {
if (typeof colorId === 'number') {
colorId = clientVars.colorPalette[colorId];
}
@@ -333,11 +336,11 @@ const getCollabClient = (ace2editor, serverVars, initialUserInfo, options, _pad)
const tellAceAboutHistoricalAuthors = (hadata) => {
for (const [author, data] of Object.entries(hadata)) {
if (!userSet[author]) {
- tellAceAuthorInfo(author, data.colorId, true);
+ tellAceAuthorInfo(author, (data as AuthorData).colorId, true);
}
}
};
- const setChannelState = (newChannelState, moreInfo) => {
+ const setChannelState = (newChannelState, moreInfo?) => {
if (newChannelState !== channelState) {
channelState = newChannelState;
callbacks.onChannelStateChange(channelState, moreInfo);
@@ -353,7 +356,7 @@ const getCollabClient = (ace2editor, serverVars, initialUserInfo, options, _pad)
// We need to present a working interface even before the socket
// is connected for the first time.
let deferredActions = [];
- const defer = (func, tag) => function (...args) {
+ const defer = (func, tag?) => function (...args) {
const action = () => {
func.call(this, ...args);
};
@@ -365,7 +368,7 @@ const getCollabClient = (ace2editor, serverVars, initialUserInfo, options, _pad)
action();
}
};
- const doDeferredActions = (tag) => {
+ const doDeferredActions = (tag?) => {
const newArray = [];
for (let i = 0; i < deferredActions.length; i++) {
const a = deferredActions[i];
@@ -386,7 +389,14 @@ const getCollabClient = (ace2editor, serverVars, initialUserInfo, options, _pad)
};
const getCurrentRevisionNumber = () => rev;
const getMissedChanges = () => {
- const obj = {};
+ const obj = {
+ furtherChangeset: undefined,
+ furtherChangesetAPool: undefined,
+ committedChangesetAPool: undefined,
+ committedChangeset: undefined,
+ userInfo: undefined,
+ baseRev: undefined
+ };
obj.userInfo = userSet[userId];
obj.baseRev = rev;
if (committing && stateMessage) {
diff --git a/src/static/js/colorutils.js b/src/static/js/colorutils.js
deleted file mode 100644
index 25d67872862..00000000000
--- a/src/static/js/colorutils.js
+++ /dev/null
@@ -1,102 +0,0 @@
-'use strict';
-/**
- * This code is mostly from the old Etherpad. Please help us to comment this code.
- * This helps other people to understand this code better and helps them to improve it.
- * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED
- */
-// DO NOT EDIT THIS FILE, edit infrastructure/ace/www/colorutils.js
-// THIS FILE IS ALSO SERVED AS CLIENT-SIDE JS
-/**
- * Copyright 2009 Google Inc.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS-IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-const colorutils = {};
-// Check that a given value is a css hex color value, e.g.
-// "#ffffff" or "#fff"
-colorutils.isCssHex = (cssColor) => /^#([0-9a-f]{3}|[0-9a-f]{6})$/i.test(cssColor);
-// "#ffffff" or "#fff" or "ffffff" or "fff" to [1.0, 1.0, 1.0]
-colorutils.css2triple = (cssColor) => {
- const sixHex = colorutils.css2sixhex(cssColor);
- const hexToFloat = (hh) => Number(`0x${hh}`) / 255;
- return [
- hexToFloat(sixHex.substr(0, 2)),
- hexToFloat(sixHex.substr(2, 2)),
- hexToFloat(sixHex.substr(4, 2)),
- ];
-};
-// "#ffffff" or "#fff" or "ffffff" or "fff" to "ffffff"
-colorutils.css2sixhex = (cssColor) => {
- let h = /[0-9a-fA-F]+/.exec(cssColor)[0];
- if (h.length !== 6) {
- const a = h.charAt(0);
- const b = h.charAt(1);
- const c = h.charAt(2);
- h = a + a + b + b + c + c;
- }
- return h;
-};
-// [1.0, 1.0, 1.0] -> "#ffffff"
-colorutils.triple2css = (triple) => {
- const floatToHex = (n) => {
- const n2 = colorutils.clamp(Math.round(n * 255), 0, 255);
- return (`0${n2.toString(16)}`).slice(-2);
- };
- return `#${floatToHex(triple[0])}${floatToHex(triple[1])}${floatToHex(triple[2])}`;
-};
-colorutils.clamp = (v, bot, top) => v < bot ? bot : (v > top ? top : v);
-colorutils.min3 = (a, b, c) => (a < b) ? (a < c ? a : c) : (b < c ? b : c);
-colorutils.max3 = (a, b, c) => (a > b) ? (a > c ? a : c) : (b > c ? b : c);
-colorutils.colorMin = (c) => colorutils.min3(c[0], c[1], c[2]);
-colorutils.colorMax = (c) => colorutils.max3(c[0], c[1], c[2]);
-colorutils.scale = (v, bot, top) => colorutils.clamp(bot + v * (top - bot), 0, 1);
-colorutils.unscale = (v, bot, top) => colorutils.clamp((v - bot) / (top - bot), 0, 1);
-colorutils.scaleColor = (c, bot, top) => [
- colorutils.scale(c[0], bot, top),
- colorutils.scale(c[1], bot, top),
- colorutils.scale(c[2], bot, top),
-];
-colorutils.unscaleColor = (c, bot, top) => [
- colorutils.unscale(c[0], bot, top),
- colorutils.unscale(c[1], bot, top),
- colorutils.unscale(c[2], bot, top),
-];
-// rule of thumb for RGB brightness; 1.0 is white
-colorutils.luminosity = (c) => c[0] * 0.30 + c[1] * 0.59 + c[2] * 0.11;
-colorutils.saturate = (c) => {
- const min = colorutils.colorMin(c);
- const max = colorutils.colorMax(c);
- if (max - min <= 0)
- return [1.0, 1.0, 1.0];
- return colorutils.unscaleColor(c, min, max);
-};
-colorutils.blend = (c1, c2, t) => [
- colorutils.scale(t, c1[0], c2[0]),
- colorutils.scale(t, c1[1], c2[1]),
- colorutils.scale(t, c1[2], c2[2]),
-];
-colorutils.invert = (c) => [1 - c[0], 1 - c[1], 1 - c[2]];
-colorutils.complementary = (c) => {
- const inv = colorutils.invert(c);
- return [
- (inv[0] >= c[0]) ? Math.min(inv[0] * 1.30, 1) : (c[0] * 0.30),
- (inv[1] >= c[1]) ? Math.min(inv[1] * 1.59, 1) : (c[1] * 0.59),
- (inv[2] >= c[2]) ? Math.min(inv[2] * 1.11, 1) : (c[2] * 0.11),
- ];
-};
-colorutils.textColorFromBackgroundColor = (bgcolor, skinName) => {
- const white = skinName === 'colibris' ? 'var(--super-light-color)' : '#fff';
- const black = skinName === 'colibris' ? 'var(--super-dark-color)' : '#222';
- return colorutils.luminosity(colorutils.css2triple(bgcolor)) < 0.5 ? white : black;
-};
-export { colorutils };
diff --git a/src/static/js/colorutils.ts b/src/static/js/colorutils.ts
new file mode 100644
index 00000000000..a12db7d1155
--- /dev/null
+++ b/src/static/js/colorutils.ts
@@ -0,0 +1,113 @@
+'use strict';
+/**
+ * This code is mostly from the old Etherpad. Please help us to comment this code.
+ * This helps other people to understand this code better and helps them to improve it.
+ * TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED
+ */
+// DO NOT EDIT THIS FILE, edit infrastructure/ace/www/colorutils.js
+// THIS FILE IS ALSO SERVED AS CLIENT-SIDE JS
+/**
+ * Copyright 2009 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS-IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const colorutils = {
+ css2triple: (cssColor) => {
+ const sixHex = colorutils.css2sixhex(cssColor);
+ const hexToFloat = (hh) => Number(`0x${hh}`) / 255;
+ return [
+ hexToFloat(sixHex.substr(0, 2)),
+ hexToFloat(sixHex.substr(2, 2)),
+ hexToFloat(sixHex.substr(4, 2)),
+ ];
+ },
+ // "#ffffff" or "#fff" or "ffffff" or "fff" to "ffffff"
+ css2sixhex: (cssColor) => {
+ let h = /[0-9a-fA-F]+/.exec(cssColor)[0];
+ if (h.length !== 6) {
+ const a = h.charAt(0);
+ const b = h.charAt(1);
+ const c = h.charAt(2);
+ h = a + a + b + b + c + c;
+ }
+ return h;
+ },
+ // [1.0, 1.0, 1.0] -> "#ffffff"
+ triple2css: (triple) => {
+ const floatToHex = (n) => {
+ const n2 = colorutils.clamp(Math.round(n * 255), 0, 255);
+ return (`0${n2.toString(16)}`).slice(-2);
+ };
+ return `#${floatToHex(triple[0])}${floatToHex(triple[1])}${floatToHex(triple[2])}`;
+ },
+ isCssHex: (cssColor) => /^#([0-9a-f]{3}|[0-9a-f]{6})$/i.test(cssColor),
+ clamp: (v, bot, top) => v < bot ? bot : (v > top ? top : v),
+ min3: (a, b, c) => (a < b) ? (a < c ? a : c) : (b < c ? b : c),
+ max3: (a, b, c) => (a > b) ? (a > c ? a : c) : (b > c ? b : c),
+ colorMin: (c) => colorutils.min3(c[0], c[1], c[2]),
+ colorMax: (c) => colorutils.max3(c[0], c[1], c[2]),
+ scale: (v, bot, top) => colorutils.clamp(bot + v * (top - bot), 0, 1),
+ unscale: (v, bot, top) => colorutils.clamp((v - bot) / (top - bot), 0, 1),
+ scaleColor:(c, bot, top) => [
+ colorutils.scale(c[0], bot, top),
+ colorutils.scale(c[1], bot, top),
+ colorutils.scale(c[2], bot, top),
+ ],
+ unscaleColor: (c, bot, top) => [
+ colorutils.unscale(c[0], bot, top),
+ colorutils.unscale(c[1], bot, top),
+ colorutils.unscale(c[2], bot, top),
+ ],
+// rule of thumb for RGB brightness; 1.0 is white
+ luminosity: (c) => c[0] * 0.30 + c[1] * 0.59 + c[2] * 0.11,
+ saturate: (c) => {
+ const min = colorutils.colorMin(c);
+ const max = colorutils.colorMax(c);
+ if (max - min <= 0)
+ return [1.0, 1.0, 1.0];
+ return colorutils.unscaleColor(c, min, max);
+ },
+ blend: (c1, c2, t) => [
+ colorutils.scale(t, c1[0], c2[0]),
+ colorutils.scale(t, c1[1], c2[1]),
+ colorutils.scale(t, c1[2], c2[2]),
+ ],
+ invert: (c) => [1 - c[0], 1 - c[1], 1 - c[2]],
+ complementary: (c) => {
+ const inv = colorutils.invert(c);
+ return [
+ (inv[0] >= c[0]) ? Math.min(inv[0] * 1.30, 1) : (c[0] * 0.30),
+ (inv[1] >= c[1]) ? Math.min(inv[1] * 1.59, 1) : (c[1] * 0.59),
+ (inv[2] >= c[2]) ? Math.min(inv[2] * 1.11, 1) : (c[2] * 0.11),
+ ];
+ },
+ textColorFromBackgroundColor: (bgcolor, skinName) => {
+ const white = skinName === 'colibris' ? 'var(--super-light-color)' : '#fff';
+ const black = skinName === 'colibris' ? 'var(--super-dark-color)' : '#222';
+ return colorutils.luminosity(colorutils.css2triple(bgcolor)) < 0.5 ? white : black;
+ },
+};
+// Check that a given value is a css hex color value, e.g.
+// "#ffffff" or "#fff"
+// "#ffffff" or "#fff" or "ffffff" or "fff" to [1.0, 1.0, 1.0]
+colorutils.css2triple = (cssColor) => {
+ const sixHex = colorutils.css2sixhex(cssColor);
+ const hexToFloat = (hh) => Number(`0x${hh}`) / 255;
+ return [
+ hexToFloat(sixHex.substr(0, 2)),
+ hexToFloat(sixHex.substr(2, 2)),
+ hexToFloat(sixHex.substr(4, 2)),
+ ];
+};
+
+export { colorutils };
diff --git a/src/static/js/contentcollector.js b/src/static/js/contentcollector.ts
similarity index 57%
rename from src/static/js/contentcollector.js
rename to src/static/js/contentcollector.ts
index 41ec41c379a..0b78b393fa4 100644
--- a/src/static/js/contentcollector.js
+++ b/src/static/js/contentcollector.ts
@@ -1,3 +1,5 @@
+// @ts-nocheck
+//TODO make this file compatible with Typescript
import AttributeMap from "./AttributeMap.js";
import UNorm from "unorm";
import * as Changeset from "./Changeset.js";
@@ -51,7 +53,7 @@ const supportedElems = new Set([
'u',
'ul',
]);
-const makeContentCollector = (collectStyles, abrowser, apool, className2Author) => {
+const makeContentCollector = (collectStyles, abrowser, apool?, className2Author?) => {
const _blockElems = {
div: 1,
p: 1,
@@ -101,7 +103,380 @@ const makeContentCollector = (collectStyles, abrowser, apool, className2Author)
self.startNew();
return self;
})();
- const cc = {};
+ const cc = {
+ collectContent(body, state?) {
+ let unsupportedElements = null;
+ if (!state) {
+ state = {
+ flags: { /* name -> nesting counter*/},
+ localAttribs: null,
+ attribs: { /* name -> nesting counter*/},
+ attribString: '',
+ // lineAttributes maintain a map from attributes to attribute values set on a line
+ lineAttributes: {
+ /*
+ example:
+ 'list': 'bullet1',
+ */
+ },
+ unsupportedElements: new Set(),
+ };
+ unsupportedElements = state.unsupportedElements;
+ }
+ const localAttribs = state.localAttribs;
+ state.localAttribs = null;
+ const isBlock = isBlockElement(node);
+ if (!isBlock && node.name && (node.name !== 'body')) {
+ if (!supportedElems.has(node.name))
+ state.unsupportedElements.add(node.name);
+ }
+ const isEmpty = _isEmpty(node, state);
+ if (isBlock)
+ _ensureColumnZero(state);
+ const startLine = lines.length() - 1;
+ _reachBlockPoint(node, 0, state);
+ if (node.nodeType === node.TEXT_NODE) {
+ const tname = node.parentNode.getAttribute('name');
+ const context = { cc: this, state, tname, node, text: node.nodeValue };
+ // Hook functions may either return a string (deprecated) or modify context.text. If any hook
+ // function modifies context.text then all returned strings are ignored. If no hook functions
+ // modify context.text, the first hook function to return a string wins.
+ const [hookTxt] = hooks.callAll('collectContentLineText', context).filter((s) => typeof s === 'string');
+ let txt = context.text === node.nodeValue && hookTxt != null ? hookTxt : context.text;
+ let rest = '';
+ let x = 0; // offset into original text
+ if (txt.length === 0) {
+ if (startPoint && node === startPoint.node) {
+ selStart = _pointHere(0, state);
+ }
+ if (endPoint && node === endPoint.node) {
+ selEnd = _pointHere(0, state);
+ }
+ }
+ while (txt.length > 0) {
+ let consumed = 0;
+ if (state.flags.preMode) {
+ const firstLine = txt.split('\n', 1)[0];
+ consumed = firstLine.length + 1;
+ rest = txt.substring(consumed);
+ txt = firstLine;
+ }
+ else { /* will only run this loop body once */
+ }
+ if (startPoint && node === startPoint.node && startPoint.index - x <= txt.length) {
+ selStart = _pointHere(startPoint.index - x, state);
+ }
+ if (endPoint && node === endPoint.node && endPoint.index - x <= txt.length) {
+ selEnd = _pointHere(endPoint.index - x, state);
+ }
+ let txt2 = txt;
+ if ((!state.flags.preMode) && /^[\r\n]*$/.exec(txt)) {
+ // prevents textnodes containing just "\n" from being significant
+ // in safari when pasting text, now that we convert them to
+ // spaces instead of removing them, because in other cases
+ // removing "\n" from pasted HTML will collapse words together.
+ txt2 = '';
+ }
+ const atBeginningOfLine = lines.textOfLine(lines.length() - 1).length === 0;
+ if (atBeginningOfLine) {
+ // newlines in the source mustn't become spaces at beginning of line box
+ txt2 = txt2.replace(/^\n*/, '');
+ }
+ if (atBeginningOfLine && Object.keys(state.lineAttributes).length !== 0) {
+ _produceLineAttributesMarker(state);
+ }
+ lines.appendText(textify(txt2), state.attribString);
+ x += consumed;
+ txt = rest;
+ if (txt.length > 0) {
+ cc.startNewLine(state);
+ }
+ }
+ }
+ else if (node.nodeType === node.ELEMENT_NODE) {
+ const tname = tagName(node) || '';
+ if (tname === 'img') {
+ hooks.callAll('collectContentImage', {
+ cc,
+ state,
+ tname,
+ styl: null,
+ cls: null,
+ node,
+ });
+ }
+ else {
+ // THIS SEEMS VERY HACKY! -- Please submit a better fix!
+ delete state.lineAttributes.img;
+ }
+ if (tname === 'br') {
+ this.breakLine = true;
+ const tvalue = node.getAttribute('value');
+ const [startNewLine = true] = hooks.callAll('collectContentLineBreak', {
+ cc: this,
+ state,
+ tname,
+ tvalue,
+ styl: null,
+ cls: null,
+ });
+ if (startNewLine) {
+ cc.startNewLine(state);
+ }
+ }
+ else if (tname === 'script' || tname === 'style') {
+ // ignore
+ }
+ else if (!isEmpty) {
+ let styl = node.getAttribute('style');
+ let cls = node.getAttribute('class');
+ let isPre = (tname === 'pre');
+ if ((!isPre) && abrowser && abrowser.safari) {
+ isPre = (styl && /\bwhite-space:\s*pre\b/i.exec(styl));
+ }
+ if (isPre)
+ cc.incrementFlag(state, 'preMode');
+ let oldListTypeOrNull = null;
+ let oldAuthorOrNull = null;
+ // LibreOffice Writer puts in weird items during import or copy/paste, we should drop them.
+ if (cls === 'Numbering_20_Symbols' || cls === 'Bullet_20_Symbols') {
+ styl = null;
+ cls = null;
+ // We have to return here but this could break things in the future,
+ // for now it shows how to fix the problem
+ return;
+ }
+ if (collectStyles) {
+ hooks.callAll('collectContentPre', {
+ cc,
+ state,
+ tname,
+ styl,
+ cls,
+ });
+ if (tname === 'b' ||
+ (styl && /\bfont-weight:\s*bold\b/i.exec(styl)) ||
+ tname === 'strong') {
+ cc.doAttrib(state, 'bold');
+ }
+ if (tname === 'i' ||
+ (styl && /\bfont-style:\s*italic\b/i.exec(styl)) ||
+ tname === 'em') {
+ cc.doAttrib(state, 'italic');
+ }
+ if (tname === 'u' ||
+ (styl && /\btext-decoration:\s*underline\b/i.exec(styl)) ||
+ tname === 'ins') {
+ cc.doAttrib(state, 'underline');
+ }
+ if (tname === 's' ||
+ (styl && /\btext-decoration:\s*line-through\b/i.exec(styl)) ||
+ tname === 'del') {
+ cc.doAttrib(state, 'strikethrough');
+ }
+ if (tname === 'ul' || tname === 'ol') {
+ let type = node.getAttribute('class');
+ const rr = cls && /(?:^| )list-([a-z]+[0-9]+)\b/.exec(cls);
+ // lists do not need to have a type, so before we make a wrong guess
+ // check if we find a better hint within the node's children
+ if (!rr && !type) {
+ for (const child of node.childNodes) {
+ if (tagName(child) !== 'ul')
+ continue;
+ type = child.getAttribute('class');
+ if (type)
+ break;
+ }
+ }
+ if (rr && rr[1]) {
+ type = rr[1];
+ }
+ else {
+ if (tname === 'ul') {
+ const cls = node.getAttribute('class');
+ if ((type && type.match('indent')) || (cls && cls.match('indent'))) {
+ type = 'indent';
+ }
+ else {
+ type = 'bullet';
+ }
+ }
+ else {
+ type = 'number';
+ }
+ type += String(Math.min(_MAX_LIST_LEVEL, (state.listNesting || 0) + 1));
+ }
+ oldListTypeOrNull = (_enterList(state, type) || 'none');
+ }
+ else if ((tname === 'div' || tname === 'p') && cls && cls.match(/(?:^| )ace-line\b/)) {
+ // This has undesirable behavior in Chrome but is right in other browsers.
+ // See https://github.com/ether/etherpad-lite/issues/2412 for reasoning
+ if (!abrowser.chrome)
+ oldListTypeOrNull = (_enterList(state, undefined) || 'none');
+ }
+ else if (tname === 'li') {
+ state.lineAttributes.start = state.start || 0;
+ _recalcAttribString(state);
+ if (state.lineAttributes.list.indexOf('number') !== -1) {
+ /*
+ Nested OLs are not -->
1
nested
+ They are -->
1
nested
+ Note how the item has to be inside a
+ Because of this we don't increment the start number
+ */
+ if (node.parentNode && tagName(node.parentNode) !== 'ol') {
+ /*
+ TODO: start number has to increment based on indentLevel(numberX)
+ This means we have to build an object IE
+ {
+ 1: 4
+ 2: 3
+ 3: 5
+ }
+ But the browser seems to handle it fine using CSS.. Why can't we do the same
+ with exports? We can.. But let's leave this comment in because it might be useful
+ in the future..
+ */
+ state.start++; // not if it's parent is an OL or UL.
+ }
+ }
+ // UL list items never modify the start value.
+ if (node.parentNode && tagName(node.parentNode) === 'ul') {
+ state.start++;
+ // TODO, this is hacky.
+ // Because if the first item is an UL it will increment a list no?
+ // A much more graceful way would be to say, ul increases if it's within an OL
+ // But I don't know a way to do that because we're only aware of the previous Line
+ // As the concept of parent's doesn't exist when processing each domline...
+ }
+ }
+ else {
+ // Below needs more testin if it's neccesary as _exitList should take care of this.
+ // delete state.start;
+ // delete state.listNesting;
+ // _recalcAttribString(state);
+ }
+ if (className2Author && cls) {
+ const classes = cls.match(/\S+/g);
+ if (classes && classes.length > 0) {
+ for (let i = 0; i < classes.length; i++) {
+ const c = classes[i];
+ const a = className2Author(c);
+ if (a) {
+ oldAuthorOrNull = (_enterAuthor(state, a) || 'none');
+ break;
+ }
+ }
+ }
+ }
+ }
+ for (const c of node.childNodes) {
+ cc.collectContent(c, state);
+ }
+ if (collectStyles) {
+ hooks.callAll('collectContentPost', {
+ cc,
+ state,
+ tname,
+ styl,
+ cls,
+ });
+ }
+ if (isPre)
+ cc.decrementFlag(state, 'preMode');
+ if (state.localAttribs) {
+ for (let i = 0; i < state.localAttribs.length; i++) {
+ cc.decrementAttrib(state, state.localAttribs[i]);
+ }
+ }
+ if (oldListTypeOrNull) {
+ _exitList(state, oldListTypeOrNull);
+ }
+ if (oldAuthorOrNull) {
+ _exitAuthor(state, oldAuthorOrNull);
+ }
+ }
+ }
+ },
+ finish() {
+ lines.flush();
+ const lineAttribs = lines.attribLines();
+ const lineStrings = cc.getLines();
+ lineStrings.length--;
+ lineAttribs.length--;
+ const ss = getSelectionStart();
+ const se = getSelectionEnd();
+ const fixLongLines = () => {
+ // design mode does not deal with with really long lines!
+ const lineLimit = 2000; // chars
+ const buffer = 10; // chars allowed over before wrapping
+ let linesWrapped = 0;
+ let numLinesAfter = 0;
+ for (let i = lineStrings.length - 1; i >= 0; i--) {
+ let oldString = lineStrings[i];
+ let oldAttribString = lineAttribs[i];
+ if (oldString.length > lineLimit + buffer) {
+ const newStrings = [];
+ const newAttribStrings = [];
+ while (oldString.length > lineLimit) {
+ // var semiloc = oldString.lastIndexOf(';', lineLimit-1);
+ // var lengthToTake = (semiloc >= 0 ? (semiloc+1) : lineLimit);
+ const lengthToTake = lineLimit;
+ newStrings.push(oldString.substring(0, lengthToTake));
+ oldString = oldString.substring(lengthToTake);
+ newAttribStrings.push(Changeset.subattribution(oldAttribString, 0, lengthToTake));
+ oldAttribString = Changeset.subattribution(oldAttribString, lengthToTake);
+ }
+ if (oldString.length > 0) {
+ newStrings.push(oldString);
+ newAttribStrings.push(oldAttribString);
+ }
+ const fixLineNumber = (lineChar) => {
+ if (lineChar[0] < 0)
+ return;
+ let n = lineChar[0];
+ let c = lineChar[1];
+ if (n > i) {
+ n += (newStrings.length - 1);
+ }
+ else if (n === i) {
+ let a = 0;
+ while (c > newStrings[a].length) {
+ c -= newStrings[a].length;
+ a++;
+ }
+ n += a;
+ }
+ lineChar[0] = n;
+ lineChar[1] = c;
+ };
+ fixLineNumber(ss);
+ fixLineNumber(se);
+ linesWrapped++;
+ numLinesAfter += newStrings.length;
+ lineStrings.splice(i, 1, ...newStrings);
+ lineAttribs.splice(i, 1, ...newAttribStrings);
+ }
+ }
+ return {
+ linesWrapped,
+ numLinesAfter,
+ };
+ };
+ const wrapData = fixLongLines();
+ return {
+ selStart: ss,
+ selEnd: se,
+ linesWrapped: wrapData.linesWrapped,
+ numLinesAfter: wrapData.numLinesAfter,
+ lines: lineStrings,
+ lineAttribs,
+ };
+ }
+
+ }
+ return cc;
+ }
const _ensureColumnZero = (state) => {
if (!lines.atColumnZero()) {
cc.startNewLine(state);
@@ -615,83 +990,6 @@ const makeContentCollector = (collectStyles, abrowser, apool, className2Author)
// last line is complete (i.e. if a following span should be on a new line).
// can be called at any point
cc.getLines = () => lines.textLines();
- cc.finish = () => {
- lines.flush();
- const lineAttribs = lines.attribLines();
- const lineStrings = cc.getLines();
- lineStrings.length--;
- lineAttribs.length--;
- const ss = getSelectionStart();
- const se = getSelectionEnd();
- const fixLongLines = () => {
- // design mode does not deal with with really long lines!
- const lineLimit = 2000; // chars
- const buffer = 10; // chars allowed over before wrapping
- let linesWrapped = 0;
- let numLinesAfter = 0;
- for (let i = lineStrings.length - 1; i >= 0; i--) {
- let oldString = lineStrings[i];
- let oldAttribString = lineAttribs[i];
- if (oldString.length > lineLimit + buffer) {
- const newStrings = [];
- const newAttribStrings = [];
- while (oldString.length > lineLimit) {
- // var semiloc = oldString.lastIndexOf(';', lineLimit-1);
- // var lengthToTake = (semiloc >= 0 ? (semiloc+1) : lineLimit);
- const lengthToTake = lineLimit;
- newStrings.push(oldString.substring(0, lengthToTake));
- oldString = oldString.substring(lengthToTake);
- newAttribStrings.push(Changeset.subattribution(oldAttribString, 0, lengthToTake));
- oldAttribString = Changeset.subattribution(oldAttribString, lengthToTake);
- }
- if (oldString.length > 0) {
- newStrings.push(oldString);
- newAttribStrings.push(oldAttribString);
- }
- const fixLineNumber = (lineChar) => {
- if (lineChar[0] < 0)
- return;
- let n = lineChar[0];
- let c = lineChar[1];
- if (n > i) {
- n += (newStrings.length - 1);
- }
- else if (n === i) {
- let a = 0;
- while (c > newStrings[a].length) {
- c -= newStrings[a].length;
- a++;
- }
- n += a;
- }
- lineChar[0] = n;
- lineChar[1] = c;
- };
- fixLineNumber(ss);
- fixLineNumber(se);
- linesWrapped++;
- numLinesAfter += newStrings.length;
- lineStrings.splice(i, 1, ...newStrings);
- lineAttribs.splice(i, 1, ...newAttribStrings);
- }
- }
- return {
- linesWrapped,
- numLinesAfter,
- };
- };
- const wrapData = fixLongLines();
- return {
- selStart: ss,
- selEnd: se,
- linesWrapped: wrapData.linesWrapped,
- numLinesAfter: wrapData.numLinesAfter,
- lines: lineStrings,
- lineAttribs,
- };
- };
- return cc;
-};
export { sanitizeUnicode };
export { makeContentCollector };
export { supportedElems };
diff --git a/src/static/js/cssmanager.js b/src/static/js/cssmanager.ts
similarity index 100%
rename from src/static/js/cssmanager.js
rename to src/static/js/cssmanager.ts
diff --git a/src/static/js/domline.js b/src/static/js/domline.js
deleted file mode 100644
index aea7f84fa1b..00000000000
--- a/src/static/js/domline.js
+++ /dev/null
@@ -1,244 +0,0 @@
-import * as Security from "./security.js";
-import * as hooks from "./pluginfw/hooks.js";
-import * as _ from "./underscore.js";
-import { lineAttributeMarker as lineAttributeMarker$0 } from "./linestylefilter.js";
-'use strict';
-const lineAttributeMarker = { lineAttributeMarker: lineAttributeMarker$0 }.lineAttributeMarker;
-const noop = () => { };
-const domline = {};
-domline.addToLineClass = (lineClass, cls) => {
- // an "empty span" at any point can be used to add classes to
- // the line, using line:className. otherwise, we ignore
- // the span.
- cls.replace(/\S+/g, (c) => {
- if (c.indexOf('line:') === 0) {
- // add class to line
- lineClass = (lineClass ? `${lineClass} ` : '') + c.substring(5);
- }
- });
- return lineClass;
-};
-// if "document" is falsy we don't create a DOM node, just
-// an object with innerHTML and className
-domline.createDomLine = (nonEmpty, doesWrap, optBrowser, optDocument) => {
- const result = {
- node: null,
- appendSpan: noop,
- prepareForAdd: noop,
- notifyAdded: noop,
- clearSpans: noop,
- finishUpdate: noop,
- lineMarker: 0,
- };
- const document = optDocument;
- if (document) {
- result.node = document.createElement('div');
- // JAWS and NVDA screen reader compatibility. Only needed if in a real browser.
- result.node.setAttribute('aria-live', 'assertive');
- }
- else {
- result.node = {
- innerHTML: '',
- className: '',
- };
- }
- let html = [];
- let preHtml = '';
- let postHtml = '';
- let curHTML = null;
- const processSpaces = (s) => domline.processSpaces(s, doesWrap);
- const perTextNodeProcess = (doesWrap ? _.identity : processSpaces);
- const perHtmlLineProcess = (doesWrap ? processSpaces : _.identity);
- let lineClass = 'ace-line';
- result.appendSpan = (txt, cls) => {
- let processedMarker = false;
- // Handle lineAttributeMarker, if present
- if (cls.indexOf(lineAttributeMarker) >= 0) {
- let listType = /(?:^| )list:(\S+)/.exec(cls);
- const start = /(?:^| )start:(\S+)/.exec(cls);
- _.map(hooks.callAll('aceDomLinePreProcessLineAttributes', {
- domline,
- cls,
- }), (modifier) => {
- preHtml += modifier.preHtml;
- postHtml += modifier.postHtml;
- processedMarker |= modifier.processedMarker;
- });
- if (listType) {
- listType = listType[1];
- if (listType) {
- if (listType.indexOf('number') < 0) {
- preHtml += `
`;
- postHtml = `
${postHtml}`;
- }
- else {
- if (start) { // is it a start of a list with more than one item in?
- if (Number.parseInt(start[1]) === 1) { // if its the first one at this level?
- // Add start class to DIV node
- lineClass = `${lineClass} ` + `list-start-${listType}`;
- }
- preHtml +=
- `
';
- }
- }
- processedMarker = true;
- }
- _.map(hooks.callAll('aceDomLineProcessLineAttributes', {
- domline,
- cls,
- }), (modifier) => {
- preHtml += modifier.preHtml;
- postHtml += modifier.postHtml;
- processedMarker |= modifier.processedMarker;
- });
- if (processedMarker) {
- result.lineMarker += txt.length;
- return; // don't append any text
- }
- }
- let href = null;
- let simpleTags = null;
- if (cls.indexOf('url') >= 0) {
- cls = cls.replace(/(^| )url:(\S+)/g, (x0, space, url) => {
- href = url;
- return `${space}url`;
- });
- }
- if (cls.indexOf('tag') >= 0) {
- cls = cls.replace(/(^| )tag:(\S+)/g, (x0, space, tag) => {
- if (!simpleTags)
- simpleTags = [];
- simpleTags.push(tag.toLowerCase());
- return space + tag;
- });
- }
- let extraOpenTags = '';
- let extraCloseTags = '';
- _.map(hooks.callAll('aceCreateDomLine', {
- domline,
- cls,
- }), (modifier) => {
- cls = modifier.cls;
- extraOpenTags += modifier.extraOpenTags;
- extraCloseTags = modifier.extraCloseTags + extraCloseTags;
- });
- if ((!txt) && cls) {
- lineClass = domline.addToLineClass(lineClass, cls);
- }
- else if (txt) {
- if (href) {
- const urn_schemes = new RegExp('^(about|geo|mailto|tel):');
- // if the url doesn't include a protocol prefix, assume http
- if (!~href.indexOf('://') && !urn_schemes.test(href)) {
- href = `http://${href}`;
- }
- // Using rel="noreferrer" stops leaking the URL/location of the pad when
- // clicking links in the document.
- // Not all browsers understand this attribute, but it's part of the HTML5 standard.
- // https://html.spec.whatwg.org/multipage/links.html#link-type-noreferrer
- // Additionally, we do rel="noopener" to ensure a higher level of referrer security.
- // https://html.spec.whatwg.org/multipage/links.html#link-type-noopener
- // https://mathiasbynens.github.io/rel-noopener/
- // https://github.com/ether/etherpad-lite/pull/3636
- const escapedHref = Security.escapeHTMLAttribute(href);
- extraOpenTags = `${extraOpenTags}`;
- extraCloseTags = `${extraCloseTags}`;
- }
- if (simpleTags) {
- simpleTags.sort();
- extraOpenTags = `${extraOpenTags}<${simpleTags.join('><')}>`;
- simpleTags.reverse();
- extraCloseTags = `${extraCloseTags}`;
- }
- html.push('', extraOpenTags, perTextNodeProcess(Security.escapeHTML(txt)), extraCloseTags, '');
- }
- };
- result.clearSpans = () => {
- html = [];
- lineClass = 'ace-line';
- result.lineMarker = 0;
- };
- const writeHTML = () => {
- let newHTML = perHtmlLineProcess(html.join(''));
- if (!newHTML) {
- if ((!document) || (!optBrowser)) {
- newHTML += ' ';
- }
- else {
- newHTML += ' ';
- }
- }
- if (nonEmpty) {
- newHTML = (preHtml || '') + newHTML + (postHtml || '');
- }
- html = preHtml = postHtml = ''; // free memory
- if (newHTML !== curHTML) {
- curHTML = newHTML;
- result.node.innerHTML = curHTML;
- }
- if (lineClass != null)
- result.node.className = lineClass;
- hooks.callAll('acePostWriteDomLineHTML', {
- node: result.node,
- });
- };
- result.prepareForAdd = writeHTML;
- result.finishUpdate = writeHTML;
- return result;
-};
-domline.processSpaces = (s, doesWrap) => {
- if (s.indexOf('<') < 0 && !doesWrap) {
- // short-cut
- return s.replace(/ /g, ' ');
- }
- const parts = [];
- s.replace(/<[^>]*>?| |[^ <]+/g, (m) => {
- parts.push(m);
- });
- if (doesWrap) {
- let endOfLine = true;
- let beforeSpace = false;
- // last space in a run is normal, others are nbsp,
- // end of line is nbsp
- for (let i = parts.length - 1; i >= 0; i--) {
- const p = parts[i];
- if (p === ' ') {
- if (endOfLine || beforeSpace)
- parts[i] = ' ';
- endOfLine = false;
- beforeSpace = true;
- }
- else if (p.charAt(0) !== '<') {
- endOfLine = false;
- beforeSpace = false;
- }
- }
- // beginning of line is nbsp
- for (let i = 0; i < parts.length; i++) {
- const p = parts[i];
- if (p === ' ') {
- parts[i] = ' ';
- break;
- }
- else if (p.charAt(0) !== '<') {
- break;
- }
- }
- }
- else {
- for (let i = 0; i < parts.length; i++) {
- const p = parts[i];
- if (p === ' ') {
- parts[i] = ' ';
- }
- }
- }
- return parts.join('');
-};
-export { domline };
diff --git a/src/static/js/domline.ts b/src/static/js/domline.ts
new file mode 100644
index 00000000000..6b62a2231bb
--- /dev/null
+++ b/src/static/js/domline.ts
@@ -0,0 +1,408 @@
+import * as Security from "./security.js";
+import * as hooks from "./pluginfw/hooks.js";
+import * as _ from "underscore";
+import { lineAttributeMarker as lineAttributeMarker$0 } from "./linestylefilter.js";
+'use strict';
+const lineAttributeMarker = { lineAttributeMarker: lineAttributeMarker$0 }.lineAttributeMarker;
+const noop = () => { };
+const domline = {
+ processSpaces: (s, doesWrap) => {
+ if (s.indexOf('<') < 0 && !doesWrap) {
+ // short-cut
+ return s.replace(/ /g, ' ');
+ }
+ const parts = [];
+ s.replace(/<[^>]*>?| |[^ <]+/g, (m) => {
+ parts.push(m);
+ });
+ if (doesWrap) {
+ let endOfLine = true;
+ let beforeSpace = false;
+ // last space in a run is normal, others are nbsp,
+ // end of line is nbsp
+ for (let i = parts.length - 1; i >= 0; i--) {
+ const p = parts[i];
+ if (p === ' ') {
+ if (endOfLine || beforeSpace)
+ parts[i] = ' ';
+ endOfLine = false;
+ beforeSpace = true;
+ }
+ else if (p.charAt(0) !== '<') {
+ endOfLine = false;
+ beforeSpace = false;
+ }
+ }
+ // beginning of line is nbsp
+ for (let i = 0; i < parts.length; i++) {
+ const p = parts[i];
+ if (p === ' ') {
+ parts[i] = ' ';
+ break;
+ }
+ else if (p.charAt(0) !== '<') {
+ break;
+ }
+ }
+ }
+ else {
+ for (let i = 0; i < parts.length; i++) {
+ const p = parts[i];
+ if (p === ' ') {
+ parts[i] = ' ';
+ }
+ }
+ }
+ return parts.join('');
+ },
+ addToLineClass: (lineClass, cls) => {
+ // an "empty span" at any point can be used to add classes to
+ // the line, using line:className. otherwise, we ignore
+ // the span.
+ cls.replace(/\S+/g, (c) => {
+ if (c.indexOf('line:') === 0) {
+ // add class to line
+ lineClass = (lineClass ? `${lineClass} ` : '') + c.substring(5);
+ }
+ });
+ return lineClass;
+ },
+ createDomLine: (nonEmpty, doesWrap, optBrowser?, optDocument?) => {
+ const result = {
+ node: null,
+ prepareForAdd: noop,
+ notifyAdded: noop,
+ finishUpdate: noop,
+ lineMarker: 0,
+ clearSpans: () => {
+ html = [];
+ lineClass = 'ace-line';
+ result.lineMarker = 0;
+ },
+ appendSpan: (txt, cls) => {
+ let processedMarker:any = false;
+ // Handle lineAttributeMarker, if present
+ if (cls.indexOf(lineAttributeMarker) >= 0) {
+ let listType:any = /(?:^| )list:(\S+)/.exec(cls);
+ const start = /(?:^| )start:(\S+)/.exec(cls);
+ _.map(hooks.callAll('aceDomLinePreProcessLineAttributes', {
+ domline,
+ cls,
+ }), (modifier) => {
+ preHtml += modifier.preHtml;
+ postHtml += modifier.postHtml;
+ processedMarker |= modifier.processedMarker;
+ });
+ if (listType) {
+ listType = listType[1];
+ if (listType) {
+ if (listType.indexOf('number') < 0) {
+ preHtml += `
`;
+ postHtml = `
${postHtml}`;
+ } else {
+ if (start) { // is it a start of a list with more than one item in?
+ if (Number.parseInt(start[1]) === 1) { // if its the first one at this level?
+ // Add start class to DIV node
+ lineClass = `${lineClass} ` + `list-start-${listType}`;
+ }
+ preHtml +=
+ `
';
+ }
+ }
+ processedMarker = true;
+ }
+ _.map(hooks.callAll('aceDomLineProcessLineAttributes', {
+ domline,
+ cls,
+ }), (modifier) => {
+ preHtml += modifier.preHtml;
+ postHtml += modifier.postHtml;
+ processedMarker |= modifier.processedMarker;
+ });
+ if (processedMarker) {
+ result.lineMarker += txt.length;
+ return; // don't append any text
+ }
+ }
+ let href = null;
+ let simpleTags = null;
+ if (cls.indexOf('url') >= 0) {
+ cls = cls.replace(/(^| )url:(\S+)/g, (x0, space, url) => {
+ href = url;
+ return `${space}url`;
+ });
+ }
+ if (cls.indexOf('tag') >= 0) {
+ cls = cls.replace(/(^| )tag:(\S+)/g, (x0, space, tag) => {
+ if (!simpleTags)
+ simpleTags = [];
+ simpleTags.push(tag.toLowerCase());
+ return space + tag;
+ });
+ }
+ let extraOpenTags = '';
+ let extraCloseTags = '';
+ _.map(hooks.callAll('aceCreateDomLine', {
+ domline,
+ cls,
+ }), (modifier) => {
+ cls = modifier.cls;
+ extraOpenTags += modifier.extraOpenTags;
+ extraCloseTags = modifier.extraCloseTags + extraCloseTags;
+ });
+ if ((!txt) && cls) {
+ lineClass = domline.addToLineClass(lineClass, cls);
+ } else if (txt) {
+ if (href) {
+ const urn_schemes = new RegExp('^(about|geo|mailto|tel):');
+ // if the url doesn't include a protocol prefix, assume http
+ if (!~href.indexOf('://') && !urn_schemes.test(href)) {
+ href = `http://${href}`;
+ }
+ // Using rel="noreferrer" stops leaking the URL/location of the pad when
+ // clicking links in the document.
+ // Not all browsers understand this attribute, but it's part of the HTML5 standard.
+ // https://html.spec.whatwg.org/multipage/links.html#link-type-noreferrer
+ // Additionally, we do rel="noopener" to ensure a higher level of referrer security.
+ // https://html.spec.whatwg.org/multipage/links.html#link-type-noopener
+ // https://mathiasbynens.github.io/rel-noopener/
+ // https://github.com/ether/etherpad-lite/pull/3636
+ const escapedHref = Security.escapeHTMLAttribute(href);
+ extraOpenTags = `${extraOpenTags}`;
+ extraCloseTags = `${extraCloseTags}`;
+ }
+ if (simpleTags) {
+ simpleTags.sort();
+ extraOpenTags = `${extraOpenTags}<${simpleTags.join('><')}>`;
+ simpleTags.reverse();
+ extraCloseTags = `${extraCloseTags}`;
+ }
+ (html as any[]).push('', extraOpenTags,
+ perTextNodeProcess(Security.escapeHTML(txt)), extraCloseTags, '');
+ }
+ }
+
+ }
+ const document = optDocument;
+ if (document) {
+ result.node = document.createElement('div');
+ // JAWS and NVDA screen reader compatibility. Only needed if in a real browser.
+ result.node.setAttribute('aria-live', 'assertive');
+ }
+ else {
+ result.node = {
+ innerHTML: '',
+ className: '',
+ };
+ }
+ let html:any[]|string = [];
+ let preHtml = '';
+ let postHtml = '';
+ let curHTML = null;
+ const processSpaces = (s) => domline.processSpaces(s, doesWrap);
+ const perTextNodeProcess = (doesWrap ? _.identity : processSpaces);
+ const perHtmlLineProcess = (doesWrap ? processSpaces : _.identity);
+ let lineClass = 'ace-line';
+ const writeHTML = () => {
+ let newHTML = perHtmlLineProcess((html as any[]).join(''));
+ if (!newHTML) {
+ if ((!document) || (!optBrowser)) {
+ newHTML += ' ';
+ }
+ else {
+ newHTML += ' ';
+ }
+ }
+ if (nonEmpty) {
+ newHTML = (preHtml || '') + newHTML + (postHtml || '');
+ }
+ html = preHtml = postHtml = ''; // free memory
+ if (newHTML !== curHTML) {
+ curHTML = newHTML;
+ result.node.innerHTML = curHTML;
+ }
+ if (lineClass != null)
+ result.node.className = lineClass;
+ hooks.callAll('acePostWriteDomLineHTML', {
+ node: result.node,
+ });
+ };
+ result.prepareForAdd = writeHTML;
+ result.finishUpdate = writeHTML;
+ return result;
+ }
+}
+// if "document" is falsy we don't create a DOM node, just
+// an object with innerHTML and className
+domline.createDomLine = (nonEmpty, doesWrap, optBrowser, optDocument) => {
+ const result = {
+ node: null,
+ prepareForAdd: noop,
+ notifyAdded: noop,
+ clearSpans: noop,
+ finishUpdate: noop,
+ lineMarker: 0,
+ appendSpan: (txt, cls) => {
+ let processedMarker:any = false;
+ // Handle lineAttributeMarker, if present
+ if (cls.indexOf(lineAttributeMarker) >= 0) {
+ let listType:any = /(?:^| )list:(\S+)/.exec(cls);
+ const start = /(?:^| )start:(\S+)/.exec(cls);
+ _.map(hooks.callAll('aceDomLinePreProcessLineAttributes', {
+ domline,
+ cls,
+ }), (modifier) => {
+ preHtml += modifier.preHtml;
+ postHtml += modifier.postHtml;
+ processedMarker |= modifier.processedMarker;
+ });
+ if (listType) {
+ listType = listType[1];
+ if (listType) {
+ if (listType.indexOf('number') < 0) {
+ preHtml += `
`;
+ postHtml = `
${postHtml}`;
+ }
+ else {
+ if (start) { // is it a start of a list with more than one item in?
+ if (Number.parseInt(start[1]) === 1) { // if its the first one at this level?
+ // Add start class to DIV node
+ lineClass = `${lineClass} ` + `list-start-${listType}`;
+ }
+ preHtml +=
+ `