libre-service.eu/pad.libre-service.eu-etherpad
libre-service.eu/pad.libre-service.eu-etherpad
1
0
Fork 0
mirror of https://github.com/ether/etherpad-lite.git synced 2025-01-19 06:03:34 +01:00
Code Issues Projects Releases Wiki Activity

Added querying and removing plugins. (#6274)

Browse source 
* Added querying and removing plugins.

* Added listing and removing plugins via cli
This commit is contained in:
SamTV12345 2024-05-18 11:56:41 +02:00 committed by GitHub
parent d9a0ecba53
commit 54860cd35a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 127 additions and 61 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
bin/commonPlugins.ts Normal file
View file

@ -0,0 +1,17 @@
import {PackageData} from "ep_etherpad-lite/node/types/PackageInfo";
import {writeFileSync} from "fs";
import {installedPluginsPath} from "ep_etherpad-lite/static/js/pluginfw/installer";
const pluginsModule = require('ep_etherpad-lite/static/js/pluginfw/plugins');
export const persistInstalledPlugins = async () => {
const plugins:PackageData[] = []
const installedPlugins = {plugins: plugins};
for (const pkg of Object.values(await pluginsModule.getPackages()) as PackageData[]) {
installedPlugins.plugins.push({
name: pkg.name,
version: pkg.version,
});
}
installedPlugins.plugins = [...new Set(installedPlugins.plugins)];
writeFileSync(installedPluginsPath, JSON.stringify(installedPlugins));
};

59
bin/installPlugins.ts
View file

@ -1,59 +0,0 @@
'use strict';
import {writeFileSync} from 'fs'
import {linkInstaller, installedPluginsPath} from "ep_etherpad-lite/static/js/pluginfw/installer";
import {PackageData} from "ep_etherpad-lite/node/types/PackageInfo";
const pluginsModule = require('ep_etherpad-lite/static/js/pluginfw/plugins');
if (process.argv.length === 2) {
console.error('Expected at least one argument!');
process.exit(1);
}
let args = process.argv.slice(2)
let registryPlugins: string[] = [];
let localPlugins: string[] = [];
if (args.indexOf('--path') !== -1) {
const indexToSplit = args.indexOf('--path');
registryPlugins = args.slice(0, indexToSplit);
localPlugins = args.slice(indexToSplit + 1);
} else {
registryPlugins = args;
}
const persistInstalledPlugins = async () => {
const plugins:PackageData[] = []
const installedPlugins = {plugins: plugins};
for (const pkg of Object.values(await pluginsModule.getPackages()) as PackageData[]) {
installedPlugins.plugins.push({
name: pkg.name,
version: pkg.version,
});
}
installedPlugins.plugins = [...new Set(installedPlugins.plugins)];
writeFileSync(installedPluginsPath, JSON.stringify(installedPlugins));
};
async function run() {
for (const plugin of registryPlugins) {
console.log(`Installing plugin from registry: ${plugin}`)
if (plugin.includes('@')) {
const [name, version] = plugin.split('@');
await linkInstaller.installPlugin(name, version);
continue;
}
await linkInstaller.installPlugin(plugin);
}
for (const plugin of localPlugins) {
console.log(`Installing plugin from path: ${plugin}`);
await linkInstaller.installFromPath(plugin);
}
}
(async () => {
await run();
await persistInstalledPlugins();
})();

2
bin/package.json
View file

@ -32,7 +32,7 @@
"rebuildPad": "node --import tsx rebuildPad.ts",
"stalePlugins": "node --import tsx ./plugins/stalePlugins.ts",
"checkPlugin": "node --import tsx ./plugins/checkPlugin.ts",
"install-plugins": "node --import tsx ./installPlugins.ts"
"plugins": "node --import tsx ./plugins.ts"
},
"author": "",
"license": "ISC"

106
bin/plugins.ts Normal file
View file

@ -0,0 +1,106 @@
'use strict';
import {linkInstaller} from "ep_etherpad-lite/static/js/pluginfw/installer";
import {persistInstalledPlugins} from "./commonPlugins";
import fs from "node:fs";
const settings = require('ep_etherpad-lite/node/utils/Settings');
if (process.argv.length === 2) {
console.error('Expected at least one argument!');
process.exit(1);
}
let args = process.argv.slice(2)
// 3d arg is ls, install or rm
let action = args[0];
const install = ()=> {
let registryPlugins: string[] = [];
let localPlugins: string[] = [];
if (args.indexOf('--path') !== -1) {
const indexToSplit = args.indexOf('--path');
registryPlugins = args.slice(1, indexToSplit);
localPlugins = args.slice(indexToSplit + 1);
} else {
registryPlugins = args;
}
async function run() {
for (const plugin of registryPlugins) {
console.log(`Installing plugin from registry: ${plugin}`)
if (plugin.includes('@')) {
const [name, version] = plugin.split('@');
await linkInstaller.installPlugin(name, version);
continue;
}
await linkInstaller.installPlugin(plugin);
}
for (const plugin of localPlugins) {
console.log(`Installing plugin from path: ${plugin}`);
await linkInstaller.installFromPath(plugin);
}
}
(async () => {
await run();
await persistInstalledPlugins();
})();
}
const list = ()=>{
const walk = async () => {
const plugins = fs.readFileSync(settings.root+"/var/installed_plugins.json", "utf-8")
const pluginNames = JSON.parse(plugins).plugins.map((plugin: any) => plugin.name).join(", ")
console.log("Installed plugins are:", pluginNames)
}
(async () => {
await walk();
})();
}
const remove = (plugins: string[])=>{
const walk = async () => {
for (const plugin of plugins) {
console.log(`Uninstalling plugin: ${plugin}`)
await linkInstaller.uninstallPlugin(plugin);
}
await persistInstalledPlugins();
}
(async () => {
await walk();
})();
}
switch (action) {
case "install":
install();
break;
case "i":
install();
break;
case "ls":
list();
break;
case "list":
list();
break;
case "rm":
remove(args.slice(1));
break;
default:
console.error('Expected at least one argument!');
process.exit(1);
}

4
package.json
View file

@ -24,7 +24,9 @@
"test-ui:ui": "pnpm --filter ep_etherpad-lite run test-ui:ui",
"test-admin": "pnpm --filter ep_etherpad-lite run test-admin",
"test-admin:ui": "pnpm --filter ep_etherpad-lite run test-admin:ui",
"install-plugins": "pnpm --filter bin run install-plugins"
"install-plugins": "pnpm --filter bin run install-plugins",
"remove-plugins": "pnpm --filter bin run remove-plugins",
"list-plugins": "pnpm --filter bin run list-plugins"
},
"dependencies": {
"ep_etherpad-lite": "workspace:./src"