rixty/SillyTavern
1
0
Fork 0
mirror of https://github.com/SillyTavern/SillyTavern.git synced 2025-06-05 21:59:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

[wip] Add global extensions

Browse Source
This commit is contained in:
Cohee
2024-12-07 17:10:26 +02:00
parent bea991b665
commit abe51682c8
7 changed files with 162 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
src/constants.js
View File

@@ -3,6 +3,7 @@ export const PUBLIC_DIRECTORIES = {
backups: 'backups/',
sounds: 'public/sounds',
extensions: 'public/scripts/extensions',
globalExtensions: 'public/scripts/extensions/third-party',
};
export const SETTINGS_FILE = 'settings.json';

86
src/endpoints/extensions.js
View File

@@ -73,8 +73,18 @@ router.post('/install', jsonParser, async (request, response) => {
fs.mkdirSync(path.join(request.user.directories.extensions));
}
const url = request.body.url;
const extensionPath = path.join(request.user.directories.extensions, path.basename(url, '.git'));
if (!fs.existsSync(PUBLIC_DIRECTORIES.globalExtensions)) {
fs.mkdirSync(PUBLIC_DIRECTORIES.globalExtensions);
}
const { url, global } = request.body;
if (global && !request.user.profile.admin) {
return response.status(403).send('Forbidden: No permission to install global extensions.');
}
const basePath = global ? PUBLIC_DIRECTORIES.globalExtensions : request.user.directories.extensions;
const extensionPath = path.join(basePath, sanitize(path.basename(url, '.git')));
if (fs.existsSync(extensionPath)) {
return response.status(409).send(`Directory already exists at ${extensionPath}`);
@@ -83,10 +93,8 @@ router.post('/install', jsonParser, async (request, response) => {
await git.clone(url, extensionPath, { '--depth': 1 });
console.log(`Extension has been cloned at ${extensionPath}`);
const { version, author, display_name } = await getManifest(extensionPath);
return response.send({ version, author, display_name, extensionPath });
} catch (error) {
console.log('Importing custom content failed', error);
@@ -112,8 +120,14 @@ router.post('/update', jsonParser, async (request, response) => {
}
try {
const extensionName = request.body.extensionName;
const extensionPath = path.join(request.user.directories.extensions, extensionName);
const { extensionName, global } = request.body;
if (global && !request.user.profile.admin) {
return response.status(403).send('Forbidden: No permission to update global extensions.');
}
const basePath = global ? PUBLIC_DIRECTORIES.globalExtensions : request.user.directories.extensions;
const extensionPath = path.join(basePath, extensionName);
if (!fs.existsSync(extensionPath)) {
return response.status(404).send(`Directory does not exist at ${extensionPath}`);
@@ -122,7 +136,6 @@ router.post('/update', jsonParser, async (request, response) => {
const { isUpToDate, remoteUrl } = await checkIfRepoIsUpToDate(extensionPath);
const currentBranch = await git.cwd(extensionPath).branch();
if (!isUpToDate) {
await git.cwd(extensionPath).pull('origin', currentBranch.current);
console.log(`Extension has been updated at ${extensionPath}`);
} else {
@@ -157,8 +170,9 @@ router.post('/version', jsonParser, async (request, response) => {
}
try {
const extensionName = request.body.extensionName;
const extensionPath = path.join(request.user.directories.extensions, extensionName);
const { extensionName, global } = request.body;
const basePath = global ? PUBLIC_DIRECTORIES.globalExtensions : request.user.directories.extensions;
const extensionPath = path.join(basePath, sanitize(extensionName));
if (!fs.existsSync(extensionPath)) {
return response.status(404).send(`Directory does not exist at ${extensionPath}`);
@@ -193,11 +207,15 @@ router.post('/delete', jsonParser, async (request, response) => {
return response.status(400).send('Bad Request: extensionName is required in the request body.');
}
// Sanitize the extension name to prevent directory traversal
const extensionName = sanitize(request.body.extensionName);
try {
const extensionPath = path.join(request.user.directories.extensions, extensionName);
const { extensionName, global } = request.body;
if (global && !request.user.profile.admin) {
return response.status(403).send('Forbidden: No permission to delete global extensions.');
}
const basePath = global ? PUBLIC_DIRECTORIES.globalExtensions : request.user.directories.extensions;
const extensionPath = path.join(basePath, sanitize(extensionName));
if (!fs.existsSync(extensionPath)) {
return response.status(404).send(`Directory does not exist at ${extensionPath}`);
@@ -219,26 +237,36 @@ router.post('/delete', jsonParser, async (request, response) => {
* If the folder is called third-party, search for subfolders instead
*/
router.get('/discover', jsonParser, function (request, response) {
// get all folders in the extensions folder, except third-party
const extensions = fs
.readdirSync(PUBLIC_DIRECTORIES.extensions)
.filter(f => fs.statSync(path.join(PUBLIC_DIRECTORIES.extensions, f)).isDirectory())
.filter(f => f !== 'third-party');
// get all folders in the third-party folder, if it exists
if (!fs.existsSync(path.join(request.user.directories.extensions))) {
return response.send(extensions);
fs.mkdirSync(path.join(request.user.directories.extensions));
}
const thirdPartyExtensions = fs
if (!fs.existsSync(PUBLIC_DIRECTORIES.globalExtensions)) {
fs.mkdirSync(PUBLIC_DIRECTORIES.globalExtensions);
}
// Get all folders in system extensions folder, excluding third-party
const buildInExtensions = fs
.readdirSync(PUBLIC_DIRECTORIES.extensions)
.filter(f => fs.statSync(path.join(PUBLIC_DIRECTORIES.extensions, f)).isDirectory())
.filter(f => f !== 'third-party')
.map(f => ({ type: 'system', name: f }));
// Get all folders in global extensions folder
const globalExtensions = fs
.readdirSync(PUBLIC_DIRECTORIES.globalExtensions)
.filter(f => fs.statSync(path.join(PUBLIC_DIRECTORIES.globalExtensions, f)).isDirectory())
.map(f => ({ type: 'global', name: `third-party/${f}` }));
// Get all folders in local extensions folder
const userExtensions = fs
.readdirSync(path.join(request.user.directories.extensions))
.filter(f => fs.statSync(path.join(request.user.directories.extensions, f)).isDirectory());
.filter(f => fs.statSync(path.join(request.user.directories.extensions, f)).isDirectory())
.map(f => ({ type: 'local', name: `third-party/${f}` }));
// add the third-party extensions to the extensions array
extensions.push(...thirdPartyExtensions.map(f => `third-party/${f}`));
console.log(extensions);
// Combine all extensions
const allExtensions = Array.from(new Set([...buildInExtensions, ...globalExtensions, ...userExtensions]));
console.log(allExtensions);
return response.send(extensions);
return response.send(allExtensions);
});

30
src/users.js
View File

@@ -782,6 +782,34 @@ function createRouteHandler(directoryFn) {
};
}
/**
* Creates a route handler for serving extensions.
* @param {(req: import('express').Request) => string} directoryFn A function that returns the directory path to serve files from
* @returns {import('express').RequestHandler}
*/
function createExtensionsRouteHandler(directoryFn) {
return async (req, res) => {
try {
const directory = directoryFn(req);
const filePath = decodeURIComponent(req.params[0]);
const existsLocal = fs.existsSync(path.join(directory, filePath));
if (existsLocal) {
return res.sendFile(filePath, { root: directory });
}
const existsGlobal = fs.existsSync(path.join(PUBLIC_DIRECTORIES.globalExtensions, filePath));
if (existsGlobal) {
return res.sendFile(filePath, { root: PUBLIC_DIRECTORIES.globalExtensions });
}
return res.sendStatus(404);
} catch (error) {
return res.sendStatus(500);
}
};
}
/**
* Verifies that the current user is an admin.
* @param {import('express').Request} request Request object
@@ -872,4 +900,4 @@ router.use('/User%20Avatars/*', createRouteHandler(req => req.user.directories.a
router.use('/assets/*', createRouteHandler(req => req.user.directories.assets));
router.use('/user/images/*', createRouteHandler(req => req.user.directories.userImages));
router.use('/user/files/*', createRouteHandler(req => req.user.directories.files));
router.use('/scripts/extensions/third-party/*', createRouteHandler(req => req.user.directories.extensions));
router.use('/scripts/extensions/third-party/*', createExtensionsRouteHandler(req => req.user.directories.extensions));