etherpad-lite/src/node/hooks/express/specialpages.ts

211 lines
6.9 KiB
TypeScript
Raw Normal View History

'use strict';
2020-11-23 13:24:19 -05:00
const path = require('path');
2024-07-12 15:00:44 +02:00
const eejs = require('../../eejs')
const fs = require('fs');
const fsp = fs.promises;
const toolbar = require('../../utils/toolbar');
const hooks = require('../../../static/js/pluginfw/hooks');
2020-11-23 13:24:19 -05:00
const settings = require('../../utils/Settings');
const util = require('util');
const webaccess = require('./webaccess');
2024-07-12 15:00:44 +02:00
const plugins = require('../../../static/js/pluginfw/plugin_defs');
2024-07-13 20:40:56 +02:00
import {hash, createHash} from 'node:crypto'
2024-07-12 15:00:44 +02:00
import {buildSync} from 'esbuild'
2024-02-22 11:36:43 +01:00
exports.expressPreSession = async (hookName:string, {app}:any) => {
// This endpoint is intended to conform to:
// https://www.ietf.org/archive/id/draft-inadarei-api-health-check-06.html
2024-02-22 11:36:43 +01:00
app.get('/health', (req:any, res:any) => {
res.set('Content-Type', 'application/health+json');
res.json({
status: 'pass',
releaseId: settings.getEpVersion(),
});
});
2024-02-22 11:36:43 +01:00
app.get('/stats', (req:any, res:any) => {
res.json(require('../../stats').toJSON());
2020-11-23 13:24:19 -05:00
});
2024-02-22 11:36:43 +01:00
app.get('/javascript', (req:any, res:any) => {
res.send(eejs.require('ep_etherpad-lite/templates/javascript.html', {req}));
2016-09-20 09:06:07 +02:00
});
2024-02-22 11:36:43 +01:00
app.get('/robots.txt', (req:any, res:any) => {
let filePath =
path.join(settings.root, 'src', 'static', 'skins', settings.skinName, 'robots.txt');
2024-02-22 11:36:43 +01:00
res.sendFile(filePath, (err:any) => {
2020-11-23 13:24:19 -05:00
// there is no custom robots.txt, send the default robots.txt which dissallows all
if (err) {
filePath = path.join(settings.root, 'src', 'static', 'robots.txt');
2015-04-07 07:55:05 -05:00
res.sendFile(filePath);
2012-11-01 13:32:04 +00:00
}
});
});
2024-02-22 11:36:43 +01:00
app.get('/favicon.ico', (req:any, res:any, next:Function) => {
(async () => {
/*
If this is a url we simply redirect to that one.
*/
if (settings.favicon && settings.favicon.startsWith('http')) {
res.redirect(settings.favicon);
res.send();
return;
}
const fns = [
...(settings.favicon ? [path.resolve(settings.root, settings.favicon)] : []),
path.join(settings.root, 'src', 'static', 'skins', settings.skinName, 'favicon.ico'),
path.join(settings.root, 'src', 'static', 'favicon.ico'),
];
for (const fn of fns) {
try {
await fsp.access(fn, fs.constants.R_OK);
} catch (err) {
continue;
}
res.setHeader('Cache-Control', `public, max-age=${settings.maxAge}`);
await util.promisify(res.sendFile.bind(res))(fn);
return;
}
next();
})().catch((err) => next(err || new Error(err)));
});
};
2024-07-12 15:00:44 +02:00
exports.expressCreateServer = async (hookName: string, args: any, cb: Function) => {
// serve index.html under /
2024-07-12 15:00:44 +02:00
args.app.get('/', (req: any, res: any) => {
res.send(eejs.require('ep_etherpad-lite/templates/index.html', {req}));
});
2024-07-12 15:00:44 +02:00
await fsp.writeFile(
path.join(settings.root, 'var/js/padbootstrap.js'),
eejs.require('ep_etherpad-lite/templates/padBootstrap.js', {
pluginModules: (() => {
const pluginModules = new Set();
for (const part of plugins.parts) {
for (const [, hookFnName] of Object.entries(part.client_hooks || {})) {
2024-07-13 21:45:25 +02:00
console.log(hookFnName.split(':')[0])
2024-07-12 15:00:44 +02:00
pluginModules.add(hookFnName.split(':')[0]);
}
}
return [...pluginModules];
})(),
settings,
}));
2024-07-16 13:47:59 +02:00
await fsp.writeFile(
path.join(settings.root, 'var/js/timesliderBootstrap.js'),
eejs.require('ep_etherpad-lite/templates/timeSliderBootstrap.js', {
pluginModules: (() => {
const pluginModules = new Set();
for (const part of plugins.parts) {
for (const [, hookFnName] of Object.entries(part.client_hooks || {})) {
console.log(hookFnName.split(':')[0])
pluginModules.add(hookFnName.split(':')[0]);
}
}
return [...pluginModules];
})(),
settings,
}));
2024-07-13 20:40:56 +02:00
const hash = createHash('sha256').update(fs.readFileSync(path.join(settings.root, 'var/js/padbootstrap.js'))).digest('hex');
2024-07-16 13:47:59 +02:00
const hashTimeSlider = createHash('sha256').update(fs.readFileSync(path.join(settings.root, 'var/js/timeSliderBootstrap.js'))).digest('hex');
2024-07-12 15:00:44 +02:00
2024-07-13 20:40:56 +02:00
const fileName = `padbootstrap-${hash.substring(0,16)}.min.js`
2024-07-16 13:47:59 +02:00
const fileNameTimeSlider = `timeSliderBootstrap-${hash.substring(0,16)}.min.js`
buildSync({
2024-07-13 20:40:56 +02:00
entryPoints: [settings.root + "/var/js/padbootstrap.js"], // Entry file(s)
2024-07-12 15:00:44 +02:00
bundle: true, // Bundle the files together
2024-07-13 20:40:56 +02:00
minify: false, // Minify the output
2024-07-12 15:00:44 +02:00
sourcemap: true, // Generate source maps
sourceRoot: settings.root+"/src/static/js/",
target: ['es2020'], // Target ECMAScript version
2024-07-13 20:40:56 +02:00
metafile: true,
write: true, // Do not write to file system,
outfile: settings.root + `/var/js/${fileName}`, // Output file
2024-07-12 15:00:44 +02:00
})
2024-07-16 13:47:59 +02:00
buildSync({
entryPoints: [settings.root + "/var/js/timesliderBootstrap.js"], // Entry file(s)
bundle: true, // Bundle the files together
minify: false, // Minify the output
sourcemap: true, // Generate source maps
sourceRoot: settings.root+"/src/static/js/",
target: ['es2020'], // Target ECMAScript version
metafile: true,
write: true, // Do not write to file system,
outfile: settings.root + `/var/js/${fileNameTimeSlider}`, // Output file
})
2024-07-13 20:40:56 +02:00
args.app.get(`/${fileName}`, (req: any, res: any) => {
res.sendFile(settings.root+`/var/js/${fileName}`)
})
args.app.get(`/${fileName}.map`, (req: any, res: any) => {
res.sendFile(settings.root+`/var/js/${fileName}.map`)
})
2024-07-12 15:00:44 +02:00
2024-07-16 13:47:59 +02:00
args.app.get(`/${fileNameTimeSlider}`, (req: any, res: any) => {
res.sendFile(settings.root+`/var/js/${fileNameTimeSlider}`)
})
args.app.get(`/${fileNameTimeSlider}.map`, (req: any, res: any) => {
res.sendFile(settings.root+`/var/js/${fileNameTimeSlider}.map`)
})
2024-07-12 15:00:44 +02:00
2020-11-23 13:24:19 -05:00
// serve pad.html under /p
2024-07-12 15:00:44 +02:00
args.app.get('/p/:pad', (req: any, res: any, next: Function) => {
2015-05-19 16:57:53 +01:00
// The below might break for pads being rewritten
2021-04-12 17:57:44 -04:00
const isReadOnly = !webaccess.userCanModify(req.params.pad, req);
2015-05-19 16:57:53 +01:00
2020-11-23 13:24:19 -05:00
hooks.callAll('padInitToolbar', {
toolbar,
2024-07-13 20:40:56 +02:00
isReadOnly
2013-04-13 12:06:51 -07:00
});
// can be removed when require-kernel is dropped
res.header('Feature-Policy', 'sync-xhr \'self\'');
2020-11-23 13:24:19 -05:00
res.send(eejs.require('ep_etherpad-lite/templates/pad.html', {
req,
toolbar,
isReadOnly,
2024-07-13 20:40:56 +02:00
entrypoint: "/"+fileName
2013-04-13 12:06:51 -07:00
}));
2012-11-04 13:02:55 +01:00
});
2020-11-23 13:24:19 -05:00
// serve timeslider.html under /p/$padname/timeslider
2024-07-12 15:00:44 +02:00
args.app.get('/p/:pad/timeslider', (req: any, res: any, next: Function) => {
2020-11-23 13:24:19 -05:00
hooks.callAll('padInitToolbar', {
toolbar,
});
2016-01-17 21:44:03 -05:00
2020-11-23 13:24:19 -05:00
res.send(eejs.require('ep_etherpad-lite/templates/timeslider.html', {
req,
toolbar,
2024-07-16 13:47:59 +02:00
entrypoint: "/"+fileNameTimeSlider
}));
2012-11-04 13:02:55 +01:00
});
// The client occasionally polls this endpoint to get an updated expiration for the express_sid
// cookie. This handler must be installed after the express-session middleware.
2024-07-12 15:00:44 +02:00
args.app.put('/_extendExpressSessionLifetime', (req: any, res: any) => {
// express-session automatically calls req.session.touch() so we don't need to do it here.
res.json({status: 'ok'});
});
2020-11-23 13:24:19 -05:00
};