2021-01-21 21:06:52 +00:00
|
|
|
'use strict';
|
|
|
|
|
2020-11-23 13:24:19 -05:00
|
|
|
const minify = require('../../utils/Minify');
|
2021-01-21 21:06:52 +00:00
|
|
|
const plugins = require('../../../static/js/pluginfw/plugin_defs');
|
2020-11-23 13:24:19 -05:00
|
|
|
const CachingMiddleware = require('../../utils/caching_middleware');
|
|
|
|
const Yajsml = require('etherpad-yajsml');
|
|
|
|
const _ = require('underscore');
|
2012-02-24 20:45:02 +01:00
|
|
|
|
2021-01-21 21:06:52 +00:00
|
|
|
exports.expressCreateServer = (hookName, args, cb) => {
|
2012-03-04 23:45:33 +01:00
|
|
|
// Cache both minified and static.
|
2020-11-23 13:24:19 -05:00
|
|
|
const assetCache = new CachingMiddleware();
|
2015-04-11 09:54:40 -05:00
|
|
|
args.app.all(/\/javascripts\/(.*)/, assetCache.handle);
|
2012-03-04 23:45:33 +01:00
|
|
|
|
|
|
|
// Minify will serve static files compressed (minify enabled). It also has
|
|
|
|
// file-specific hacks for ace/require-kernel/etc.
|
2015-04-10 05:52:58 -05:00
|
|
|
args.app.all('/static/:filename(*)', minify.minify);
|
2012-03-04 23:45:33 +01:00
|
|
|
|
|
|
|
// Setup middleware that will package JavaScript files served by minify for
|
|
|
|
// CommonJS loader on the client-side.
|
Fix misparse of port when binding Unix socket
The hostname:port of URIs used in Minify are currently bogus and refer
to localhost only for historical reasons; there's no reason to retain
them and omitting them avoids generating an invalid URI when "port" is
not an integer.
Context: settings.port is passed to express's listen; if not numeric, it
is used a filename for a Unix domain socket.
This allows e.g. starting a server to be reverse-proxied on a multi-user
system, using the filesystem to handle access control and avoiding need
to allocate port numbers.
Before this change, etherpad-lite starts without error when configured
to listen on a Unix domain socket in this manner. However, `pad.js` and
`ace2_common.js` are generated incorrecting, causing an error
"Uncaught Error: The module at "ep_etherpad-lite/static/js/rjquery" does not exist."
when loading the editor:
When settings.port is a non-numeric string, e.g. `etherpad.sock`, a URI
of the form `http://localhost:etherpad.sock/static/js/rjquery.js` is
generated and parsed to find the file needed. In this case, the file
searched for is `:etherpad.sock/static/js/rjquery.js`, rather than the
expected `static/js/rjquery.js`. No such file exists, and the required
code is silently omitted from the bundle.
As a workaround, hard-code a (meaningless) hostname which can be parsed
correctly, since the current code makes no use of it anyway.
2018-07-28 04:38:17 -04:00
|
|
|
// Hostname "invalid.invalid" is a dummy value to allow parsing as a URI.
|
2020-11-23 13:24:19 -05:00
|
|
|
const jsServer = new (Yajsml.Server)({
|
|
|
|
rootPath: 'javascripts/src/',
|
|
|
|
rootURI: 'http://invalid.invalid/static/js/',
|
|
|
|
libraryPath: 'javascripts/lib/',
|
|
|
|
libraryURI: 'http://invalid.invalid/static/plugins/',
|
|
|
|
requestURIs: minify.requestURIs, // Loop-back is causing problems, this is a workaround.
|
2012-02-25 19:43:00 +01:00
|
|
|
});
|
|
|
|
|
2020-11-23 13:24:19 -05:00
|
|
|
const StaticAssociator = Yajsml.associators.StaticAssociator;
|
|
|
|
const associations =
|
2012-03-04 23:45:33 +01:00
|
|
|
Yajsml.associators.associationsForSimpleMapping(minify.tar);
|
2020-11-23 13:24:19 -05:00
|
|
|
const associator = new StaticAssociator(associations);
|
2012-03-04 23:45:33 +01:00
|
|
|
jsServer.setAssociator(associator);
|
2015-04-07 07:55:05 -05:00
|
|
|
|
|
|
|
args.app.use(jsServer.handle.bind(jsServer));
|
2012-03-04 23:45:33 +01:00
|
|
|
|
|
|
|
// serve plugin definitions
|
2021-01-21 21:06:52 +00:00
|
|
|
// not very static, but served here so that client can do
|
|
|
|
// require("pluginfw/static/js/plugin-definitions.js");
|
2020-11-23 13:24:19 -05:00
|
|
|
args.app.get('/pluginfw/plugin-definitions.json', (req, res, next) => {
|
|
|
|
const clientParts = _(plugins.parts)
|
|
|
|
.filter((part) => _(part).has('client_hooks'));
|
2019-04-16 00:34:29 +02:00
|
|
|
|
2020-11-23 13:24:19 -05:00
|
|
|
const clientPlugins = {};
|
2019-04-16 00:34:29 +02:00
|
|
|
|
2012-04-04 15:10:27 +02:00
|
|
|
_(clientParts).chain()
|
2020-11-23 13:24:19 -05:00
|
|
|
.map((part) => part.plugin)
|
|
|
|
.uniq()
|
|
|
|
.each((name) => {
|
|
|
|
clientPlugins[name] = _(plugins.plugins[name]).clone();
|
|
|
|
delete clientPlugins[name].package;
|
|
|
|
});
|
|
|
|
|
|
|
|
res.header('Content-Type', 'application/json; charset=utf-8');
|
|
|
|
res.write(JSON.stringify({plugins: clientPlugins, parts: clientParts}));
|
2012-03-04 23:45:33 +01:00
|
|
|
res.end();
|
2012-02-24 20:45:02 +01:00
|
|
|
});
|
2020-10-10 22:51:26 -04:00
|
|
|
|
|
|
|
return cb();
|
2020-11-23 13:24:19 -05:00
|
|
|
};
|