Added typescript to etherpad

* Fixed determining file extension. * Added ts-node * Fixed backend tests. * Fixed frontend test runs. * Fixed tests. * Use script approach for starting etherpad. * Change directory to src. * Fixed env. * Change directory * Fixed build arg. * Fixed docker build. * Fixed. * Fixed cypress file path. * Fixed. * Use latest node container. * Fixed windows workflow. * Use tsx and optimized docker image. * Added workflow for type checks. * Fixed. * Added tsconfig. * Converted more files to typescript. * Removed commented keys. * Typed caching middleware. * Added script for checking the types. * Moved SecretRotator to typescript. * Fixed npm installation and moved to types folder. * Use better scripts for watching typescript changes. * Update windows.yml * Fixed order of npm installation. * Converted i18n. * Added more types. * Added more types. * Fixed import. * Fixed tests. * Fixed tests. * Fixed type checking test. * Fixed stats * Added express types. * fixed.
2025-04-21 07:56:16 -04:00 · 2024-02-05 21:13:02 +01:00 · 2024-02-05 21:13:02 +01:00 · ead3c0ea38
commit ead3c0ea38
parent c3202284bc
74 changed files with 1259 additions and 612 deletions
--- a/src/node/hooks/express/adminplugins.ts
+++ b/src/node/hooks/express/adminplugins.ts
@ -0,0 +1,152 @@
+'use strict';
+
+import {ArgsExpressType} from "../../types/ArgsExpressType";
+import {Socket} from "node:net";
+import {ErrorCaused} from "../../types/ErrorCaused";
+import {QueryType} from "../../types/QueryType";
+import {PluginType} from "../../types/Plugin";
+
+const eejs = require('../../eejs');
+const settings = require('../../utils/Settings');
+const installer = require('../../../static/js/pluginfw/installer');
+const pluginDefs = require('../../../static/js/pluginfw/plugin_defs');
+const plugins = require('../../../static/js/pluginfw/plugins');
+const semver = require('semver');
+const UpdateCheck = require('../../utils/UpdateCheck');
+
+exports.expressCreateServer = (hookName:string, args: ArgsExpressType, cb:Function) => {
+  args.app.get('/admin/plugins', (req:any, res:any) => {
+    res.send(eejs.require('ep_etherpad-lite/templates/admin/plugins.html', {
+      plugins: pluginDefs.plugins,
+      req,
+      errors: [],
+    }));
+  });
+
+  args.app.get('/admin/plugins/info', (req:any, res:any) => {
+    const gitCommit = settings.getGitCommit();
+    const epVersion = settings.getEpVersion();
+
+    res.send(eejs.require('ep_etherpad-lite/templates/admin/plugins-info.html', {
+      gitCommit,
+      epVersion,
+      installedPlugins: `<pre>${plugins.formatPlugins().replace(/, /g, '\n')}</pre>`,
+      installedParts: `<pre>${plugins.formatParts()}</pre>`,
+      installedServerHooks: `<div>${plugins.formatHooks('hooks', true)}</div>`,
+      installedClientHooks: `<div>${plugins.formatHooks('client_hooks', true)}</div>`,
+      latestVersion: UpdateCheck.getLatestVersion(),
+      req,
+    }));
+  });
+
+  return cb();
+};
+
+exports.socketio = (hookName:string, args:ArgsExpressType, cb:Function) => {
+  const io = args.io.of('/pluginfw/installer');
+  io.on('connection', (socket:any) => {
+    // @ts-ignore
+    const {session: {user: {is_admin: isAdmin} = {}} = {}} = socket.conn.request;
+    if (!isAdmin) return;
+
+    socket.on('getInstalled', (query:string) => {
+      // send currently installed plugins
+      const installed =
+          Object.keys(pluginDefs.plugins).map((plugin) => pluginDefs.plugins[plugin].package);
+
+      socket.emit('results:installed', {installed});
+    });
+
+    socket.on('checkUpdates', async () => {
+      // Check plugins for updates
+      try {
+        const results = await installer.getAvailablePlugins(/* maxCacheAge:*/ 60 * 10);
+
+        const updatable = Object.keys(pluginDefs.plugins).filter((plugin) => {
+          if (!results[plugin]) return false;
+
+          const latestVersion = results[plugin].version;
+          const currentVersion = pluginDefs.plugins[plugin].package.version;
+
+          return semver.gt(latestVersion, currentVersion);
+        });
+
+        socket.emit('results:updatable', {updatable});
+      } catch (err) {
+        const errc = err as ErrorCaused
+        console.warn(errc.stack || errc.toString());
+
+        socket.emit('results:updatable', {updatable: {}});
+      }
+    });
+
+    socket.on('getAvailable', async (query:string) => {
+      try {
+        const results = await installer.getAvailablePlugins(/* maxCacheAge:*/ false);
+        socket.emit('results:available', results);
+      } catch (er) {
+        console.error(er);
+        socket.emit('results:available', {});
+      }
+    });
+
+    socket.on('search', async (query: QueryType) => {
+      try {
+        const results = await installer.search(query.searchTerm, /* maxCacheAge:*/ 60 * 10);
+        let res = Object.keys(results)
+            .map((pluginName) => results[pluginName])
+            .filter((plugin) => !pluginDefs.plugins[plugin.name]);
+        res = sortPluginList(res, query.sortBy, query.sortDir)
+            .slice(query.offset, query.offset + query.limit);
+        socket.emit('results:search', {results: res, query});
+      } catch (er) {
+        console.error(er);
+
+        socket.emit('results:search', {results: {}, query});
+      }
+    });
+
+    socket.on('install', (pluginName: string) => {
+      installer.install(pluginName, (err: ErrorCaused) => {
+        if (err) console.warn(err.stack || err.toString());
+
+        socket.emit('finished:install', {
+          plugin: pluginName,
+          code: err ? err.code : null,
+          error: err ? err.message : null,
+        });
+      });
+    });
+
+    socket.on('uninstall', (pluginName:string) => {
+      installer.uninstall(pluginName, (err:ErrorCaused) => {
+        if (err) console.warn(err.stack || err.toString());
+
+        socket.emit('finished:uninstall', {plugin: pluginName, error: err ? err.message : null});
+      });
+    });
+  });
+  return cb();
+};
+
+/**
+ * Sorts  a list of plugins by a property
+ * @param {Object} plugins The plugins to sort
+ * @param {Object} property The property to sort by
+ * @param  {String} dir The directory of the plugin
+ * @return {Object[]}
+ */
+const sortPluginList = (plugins:PluginType[], property:string, /* ASC?*/dir:string): object[] => plugins.sort((a, b) => {
+  // @ts-ignore
+  if (a[property] < b[property]) {
+    return dir ? -1 : 1;
+  }
+
+  // @ts-ignore
+  if (a[property] > b[property]) {
+    return dir ? 1 : -1;
+  }
+
+  // a must be equal to b
+  return 0;
+});