mirror of
https://github.com/ether/etherpad-lite.git
synced 2025-04-23 00:46:16 -04:00
Rewrote server in typescript.
This commit is contained in:
SamTV12345
parent
331cf3d79f
commit
3c2129b1cc
57 changed files with 668 additions and 490 deletions
267
src/node/hooks/express.ts
Normal file
267
src/node/hooks/express.ts
Normal file
|
|
@ -0,0 +1,267 @@
|
|||
'use strict';
|
||||
|
||||
import _ from 'underscore';
|
||||
import cookieParser from 'cookie-parser';
|
||||
import events from "events";
|
||||
|
||||
import express from "express";
|
||||
|
||||
import fs from "fs";
|
||||
|
||||
import expressSession from "express-session";
|
||||
|
||||
import hooks from "../../static/js/pluginfw/hooks";
|
||||
|
||||
import log4js from "log4js";
|
||||
|
||||
import SessionStore from "../db/SessionStore";
|
||||
|
||||
import {
|
||||
cookie,
|
||||
exposeVersion,
|
||||
getEpVersion,
|
||||
getGitCommit,
|
||||
ip,
|
||||
loglevel,
|
||||
port,
|
||||
sessionKey,
|
||||
ssl, sslKeys,
|
||||
trustProxy,
|
||||
users
|
||||
} from "../utils/Settings";
|
||||
|
||||
import {createCollection} from "../stats";
|
||||
|
||||
import util from "util";
|
||||
|
||||
import {checkAccess, checkAccess2} from "./express/webaccess";
|
||||
import {Socket} from "net";
|
||||
|
||||
const logger = log4js.getLogger('http');
|
||||
let serverName;
|
||||
let sessionStore;
|
||||
const sockets = new Set<Socket>();
|
||||
const socketsEvents = new events.EventEmitter();
|
||||
const startTime = createCollection.settableGauge('httpStartTime');
|
||||
|
||||
export let server = null;
|
||||
export let sessionMiddleware;
|
||||
const closeServer = async () => {
|
||||
if (server != null) {
|
||||
logger.info('Closing HTTP server...');
|
||||
// Call exports.server.close() to reject new connections but don't await just yet because the
|
||||
// Promise won't resolve until all preexisting connections are closed.
|
||||
const p = util.promisify(server.close.bind(server))();
|
||||
await hooks.aCallAll('expressCloseServer');
|
||||
// Give existing connections some time to close on their own before forcibly terminating. The
|
||||
// time should be long enough to avoid interrupting most preexisting transmissions but short
|
||||
// enough to avoid a noticeable outage.
|
||||
const timeout = setTimeout(async () => {
|
||||
logger.info(`Forcibly terminating remaining ${sockets.size} HTTP connections...`);
|
||||
for (const socket of sockets) socket.destroy(new Error('HTTP server is closing'));
|
||||
}, 5000);
|
||||
let lastLogged = 0;
|
||||
while (sockets.size > 0) {
|
||||
if (Date.now() - lastLogged > 1000) { // Rate limit to avoid filling logs.
|
||||
logger.info(`Waiting for ${sockets.size} HTTP clients to disconnect...`);
|
||||
lastLogged = Date.now();
|
||||
}
|
||||
await events.once(socketsEvents, 'updated');
|
||||
}
|
||||
await p;
|
||||
clearTimeout(timeout);
|
||||
server = null;
|
||||
startTime.setValue(0);
|
||||
logger.info('HTTP server closed');
|
||||
}
|
||||
if (sessionStore) sessionStore.shutdown();
|
||||
sessionStore = null;
|
||||
};
|
||||
|
||||
export const createServer = async () => {
|
||||
console.log('Report bugs at https://github.com/ether/etherpad-lite/issues');
|
||||
|
||||
serverName = `Etherpad ${getGitCommit()} (https://etherpad.org)`;
|
||||
|
||||
console.log(`Your Etherpad version is ${getEpVersion()} (${getGitCommit()})`);
|
||||
|
||||
await restartServer();
|
||||
|
||||
if (ip.length===0) {
|
||||
// using Unix socket for connectivity
|
||||
console.log(`You can access your Etherpad instance using the Unix socket at ${port}`);
|
||||
} else {
|
||||
console.log(`You can access your Etherpad instance at http://${ip}:${port}/`);
|
||||
}
|
||||
|
||||
if (!_.isEmpty(users)) {
|
||||
console.log(`The plugin admin page is at http://${ip}:${port}/admin/plugins`);
|
||||
} else {
|
||||
console.warn('Admin username and password not set in settings.json. ' +
|
||||
'To access admin please uncomment and edit "users" in settings.json');
|
||||
}
|
||||
|
||||
const env = process.env.NODE_ENV || 'development';
|
||||
|
||||
if (env !== 'production') {
|
||||
console.warn('Etherpad is running in Development mode. This mode is slower for users and ' +
|
||||
'less secure than production mode. You should set the NODE_ENV environment ' +
|
||||
'variable to production by using: export NODE_ENV=production');
|
||||
}
|
||||
};
|
||||
|
||||
export const restartServer = async () => {
|
||||
await closeServer();
|
||||
|
||||
const app = express(); // New syntax for express v3
|
||||
|
||||
if (ssl) {
|
||||
console.log('SSL -- enabled');
|
||||
console.log(`SSL -- server key file: ${sslKeys.key}`);
|
||||
console.log(`SSL -- Certificate Authority's certificate file: ${sslKeys.cert}`);
|
||||
|
||||
const options = {
|
||||
key: fs.readFileSync(sslKeys.key),
|
||||
cert: fs.readFileSync(sslKeys.cert),
|
||||
ca: undefined
|
||||
};
|
||||
|
||||
if (sslKeys.ca) {
|
||||
options.ca = [];
|
||||
for (let i = 0; i < sslKeys.ca.length; i++) {
|
||||
const caFileName = sslKeys.ca[i];
|
||||
options.ca.push(fs.readFileSync(caFileName));
|
||||
}
|
||||
}
|
||||
|
||||
const https = require('https');
|
||||
server = https.createServer(options, app);
|
||||
} else {
|
||||
const http = require('http');
|
||||
server = http.createServer(app);
|
||||
}
|
||||
|
||||
app.use((req, res, next) => {
|
||||
// res.header("X-Frame-Options", "deny"); // breaks embedded pads
|
||||
if (ssl) {
|
||||
// we use SSL
|
||||
res.header('Strict-Transport-Security', 'max-age=31536000; includeSubDomains');
|
||||
}
|
||||
|
||||
// Stop IE going into compatability mode
|
||||
// https://github.com/ether/etherpad-lite/issues/2547
|
||||
res.header('X-UA-Compatible', 'IE=Edge,chrome=1');
|
||||
|
||||
// Enable a strong referrer policy. Same-origin won't drop Referers when
|
||||
// loading local resources, but it will drop them when loading foreign resources.
|
||||
// It's still a last bastion of referrer security. External URLs should be
|
||||
// already marked with rel="noreferer" and user-generated content pages are already
|
||||
// marked with <meta name="referrer" content="no-referrer">
|
||||
// https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy
|
||||
// https://github.com/ether/etherpad-lite/pull/3636
|
||||
res.header('Referrer-Policy', 'same-origin');
|
||||
|
||||
// send git version in the Server response header if exposeVersion is true.
|
||||
if (exposeVersion) {
|
||||
res.header('Server', serverName);
|
||||
}
|
||||
|
||||
next();
|
||||
});
|
||||
|
||||
if (trustProxy) {
|
||||
/*
|
||||
* If 'trust proxy' === true, the client’s IP address in req.ip will be the
|
||||
* left-most entry in the X-Forwarded-* header.
|
||||
*
|
||||
* Source: https://expressjs.com/en/guide/behind-proxies.html
|
||||
*/
|
||||
app.enable('trust proxy');
|
||||
}
|
||||
|
||||
// Measure response time
|
||||
app.use((req, res, next) => {
|
||||
const stopWatch = createCollection.timer('httpRequests').start();
|
||||
const sendFn = res.send.bind(res);
|
||||
// FIXME Check if this is still needed
|
||||
// @ts-ignore
|
||||
res.send = (...args) => { stopWatch.end(); sendFn(...args); };
|
||||
next();
|
||||
});
|
||||
|
||||
// If the log level specified in the config file is WARN or ERROR the application server never
|
||||
// starts listening to requests as reported in issue #158. Not installing the log4js connect
|
||||
// logger when the log level has a higher severity than INFO since it would not log at that level
|
||||
// anyway.
|
||||
if (!(loglevel === 'WARN') && loglevel === 'ERROR') {
|
||||
app.use(log4js.connectLogger(logger, {
|
||||
level: loglevel,
|
||||
format: ':status, :method :url',
|
||||
}));
|
||||
}
|
||||
|
||||
app.use(cookieParser(sessionKey, {}));
|
||||
|
||||
sessionStore = new SessionStore(cookie.sessionRefreshInterval);
|
||||
sessionMiddleware = expressSession({
|
||||
propagateTouch: true,
|
||||
rolling: true,
|
||||
secret: sessionKey,
|
||||
store: sessionStore,
|
||||
resave: false,
|
||||
saveUninitialized: false,
|
||||
// Set the cookie name to a javascript identifier compatible string. Makes code handling it
|
||||
// cleaner :)
|
||||
name: 'express_sid',
|
||||
cookie: {
|
||||
maxAge: cookie.sessionLifetime || null, // Convert 0 to null.
|
||||
sameSite: cookie.sameSite,
|
||||
|
||||
// The automatic express-session mechanism for determining if the application is being served
|
||||
// over ssl is similar to the one used for setting the language cookie, which check if one of
|
||||
// these conditions is true:
|
||||
//
|
||||
// 1. we are directly serving the nodejs application over SSL, using the "ssl" options in
|
||||
// settings.json
|
||||
//
|
||||
// 2. we are serving the nodejs application in plaintext, but we are using a reverse proxy
|
||||
// that terminates SSL for us. In this case, the user has to set trustProxy = true in
|
||||
// settings.json, and the information wheter the application is over SSL or not will be
|
||||
// extracted from the X-Forwarded-Proto HTTP header
|
||||
//
|
||||
// Please note that this will not be compatible with applications being served over http and
|
||||
// https at the same time.
|
||||
//
|
||||
// reference: https://github.com/expressjs/session/blob/v1.17.0/README.md#cookiesecure
|
||||
secure: 'auto',
|
||||
},
|
||||
});
|
||||
|
||||
// Give plugins an opportunity to install handlers/middleware before the express-session
|
||||
// middleware. This allows plugins to avoid creating an express-session record in the database
|
||||
// when it is not needed (e.g., public static content).
|
||||
await hooks.aCallAll('expressPreSession', {app});
|
||||
app.use(sessionMiddleware);
|
||||
|
||||
app.use(checkAccess2);
|
||||
|
||||
await Promise.all([
|
||||
hooks.aCallAll('expressConfigure', {app}),
|
||||
hooks.aCallAll('expressCreateServer', {app, server: server}),
|
||||
]);
|
||||
server.on('connection', (socket) => {
|
||||
sockets.add(socket);
|
||||
socketsEvents.emit('updated');
|
||||
socket.on('close', () => {
|
||||
sockets.delete(socket);
|
||||
socketsEvents.emit('updated');
|
||||
});
|
||||
});
|
||||
await util.promisify(server.listen).bind(server)(port, ip);
|
||||
startTime.setValue(Date.now());
|
||||
logger.info('HTTP server listening for connections');
|
||||
};
|
||||
|
||||
export const shutdown = async (hookName, context) => {
|
||||
await closeServer();
|
||||
};
|
||||
Loading…
Add table
Add a link
Reference in a new issue