express-init.js 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147
  1. import { manifestPath as presetThemesManifestPath } from '@growi/preset-themes';
  2. import csrf from 'csurf';
  3. import qs from 'qs';
  4. import loggerFactory from '~/utils/logger';
  5. import { resolveFromRoot } from '~/utils/project-dir-utils';
  6. import registerSafeRedirectFactory from '../middlewares/safe-redirect';
  7. const logger = loggerFactory('growi:crowi:express-init');
  8. module.exports = function(crowi, app) {
  9. const debug = require('debug')('growi:crowi:express-init');
  10. const path = require('path');
  11. const express = require('express');
  12. const compression = require('compression');
  13. const helmet = require('helmet');
  14. const bodyParser = require('body-parser');
  15. const cookieParser = require('cookie-parser');
  16. const methodOverride = require('method-override');
  17. const passport = require('passport');
  18. const expressSession = require('express-session');
  19. const flash = require('connect-flash');
  20. const mongoSanitize = require('express-mongo-sanitize');
  21. const promster = require('../middlewares/promster')(crowi, app);
  22. const registerSafeRedirect = registerSafeRedirectFactory();
  23. const injectCurrentuserToLocalvars = require('../middlewares/inject-currentuser-to-localvars')();
  24. const autoReconnectToS2sMsgServer = require('../middlewares/auto-reconnect-to-s2s-msg-server')(crowi);
  25. const avoidSessionRoutes = require('../routes/avoid-session-routes');
  26. const env = crowi.node_env;
  27. // see: https://qiita.com/nazomikan/items/9458d591a4831480098d
  28. // Cannot set a custom query parser after app.use() has been called: https://github.com/expressjs/express/issues/3454
  29. app.set('query parser', str => qs.parse(str, { arrayLimit: Infinity }));
  30. app.use(compression());
  31. const { configManager } = crowi;
  32. const trustProxyBool = configManager.getConfig('crowi', 'security:trustProxyBool');
  33. const trustProxyCsv = configManager.getConfig('crowi', 'security:trustProxyCsv');
  34. const trustProxyHops = configManager.getConfig('crowi', 'security:trustProxyHops');
  35. const trustProxy = trustProxyBool ?? trustProxyCsv ?? trustProxyHops;
  36. try {
  37. if (trustProxy != null) {
  38. const isNotSpec = [trustProxyBool, trustProxyCsv, trustProxyHops].filter(trustProxy => trustProxy != null).length !== 1;
  39. if (isNotSpec) {
  40. // eslint-disable-next-line max-len
  41. logger.warn(`If more than one TRUST_PROXY_ ~ environment variable is set, the values are set in the following order of inequality size (BOOL > CSV > HOPS) first. Set value: ${trustProxy}`);
  42. }
  43. app.set('trust proxy', trustProxy);
  44. }
  45. }
  46. catch (err) {
  47. logger.error(err);
  48. }
  49. app.use(helmet({
  50. contentSecurityPolicy: false,
  51. expectCt: false,
  52. referrerPolicy: false,
  53. permittedCrossDomainPolicies: false,
  54. }));
  55. app.use((req, res, next) => {
  56. const now = new Date();
  57. // for datez
  58. app.set('tzoffset', crowi.appService.getTzoffset());
  59. res.locals.req = req;
  60. res.locals.baseUrl = crowi.appService.getSiteUrl();
  61. res.locals.env = env;
  62. res.locals.now = now;
  63. next();
  64. });
  65. app.set('port', crowi.port);
  66. const staticOption = (crowi.node_env === 'production') ? { maxAge: '30d' } : {};
  67. app.use(express.static(crowi.publicDir, staticOption));
  68. app.use('/static/preset-themes', express.static(
  69. resolveFromRoot(`../../node_modules/@growi/preset-themes/${path.dirname(presetThemesManifestPath)}`),
  70. ));
  71. app.use('/static/plugins', express.static(path.resolve(__dirname, '../../../tmp/plugins')));
  72. app.use(methodOverride());
  73. // inject rawBody to req
  74. app.use((req, res, next) => {
  75. if (!req.is('multipart/form-data')) {
  76. req.rawBody = '';
  77. req.on('data', (chunk) => {
  78. req.rawBody += chunk;
  79. });
  80. }
  81. next();
  82. });
  83. app.use(bodyParser.urlencoded({ extended: true, limit: '50mb' }));
  84. app.use(bodyParser.json({ limit: '50mb' }));
  85. app.use(cookieParser());
  86. // configure express-session
  87. const sessionMiddleware = expressSession(crowi.sessionConfig);
  88. app.use((req, res, next) => {
  89. // test whether the route is listed in avoidSessionRoutes
  90. for (const regex of avoidSessionRoutes) {
  91. if (regex.test(req.path)) {
  92. return next();
  93. }
  94. }
  95. sessionMiddleware(req, res, next);
  96. });
  97. // csurf should be initialized after express-session
  98. // default methods + PUT. See: https://expressjs.com/en/resources/middleware/csurf.html#ignoremethods
  99. app.use(csrf({ ignoreMethods: ['GET', 'HEAD', 'OPTIONS', 'PUT', 'POST', 'DELETE'], cookie: false }));
  100. // passport
  101. debug('initialize Passport');
  102. app.use(passport.initialize());
  103. app.use(passport.session());
  104. app.use(flash());
  105. app.use(mongoSanitize());
  106. app.use(promster);
  107. app.use(registerSafeRedirect);
  108. app.use(injectCurrentuserToLocalvars);
  109. app.use(autoReconnectToS2sMsgServer);
  110. // TODO: Remove this workaround implementation when i18n works correctly.
  111. // For now, req.t returns string given to req.t(string)
  112. app.use((req, res, next) => {
  113. req.t = str => (typeof str === 'string' ? str : '');
  114. next();
  115. });
  116. };