app.js

const express = require('express');
const path = require('path');
const morgan = require('morgan');
const cookieParser = require('cookie-parser');
const bodyParser = require('body-parser');
const compression = require('compression');
const Redis = require('ioredis');
const RedisStore = require('connect-redis').default;
const session = require('express-session');
const methodOverride = require('method-override');
const csurf = require('csurf');
const handlebars = require('handlebars');
const layouts = require('handlebars-layouts');
const handlebarsWax = require('handlebars-wax');
const { Configuration } = require('@hpi-schul-cloud/commons');

const { staticAssetsMiddleware } = require('./middleware/assets');
const { version } = require('./package.json');
const {
	filterLog,
	nonceValueSet,
	prometheus,
	tokenInjector,
	duplicateTokenHandler,
	csrfErrorHandler,
	logger,
	sha,
} = require('./helpers');

const {
	KEEP_ALIVE,
	SC_DOMAIN,
	SC_THEME,
	REDIS_URI,
	JWT_SHOW_TIMEOUT_WARNING_SECONDS,
	MAXIMUM_ALLOWABLE_TOTAL_ATTACHMENTS_SIZE_BYTE,
	JWT_TIMEOUT_SECONDS,
	API_HOST,
	PUBLIC_BACKEND_URL,
} = require('./config/global');

const app = express();

// print current configuration
Configuration.printHierarchy();

// setup prometheus metrics
prometheus(app);

// template stuff
const authHelper = require('./helpers/authentication');

// set custom response header for ha proxy
if (KEEP_ALIVE) {
	app.use((req, res, next) => {
		res.setHeader('Connection', 'Keep-Alive');
		next();
	});
}

// disable x-powered-by header
app.disable('x-powered-by');

// set security headers
const securityHeaders = require('./middleware/security_headers');

app.use(securityHeaders);

// generate nonce value
if (Configuration.get('CORS')) {
	app.use(nonceValueSet);
}

// set cors headers
app.use(require('./middleware/cors'));

app.use(compression());
app.set('trust proxy', true);
const themeName = SC_THEME;
// view engine setup
const handlebarsHelper = require('./helpers/handlebars');

const wax = handlebarsWax(handlebars)
	.partials(path.join(__dirname, 'views/**/*.{hbs,js}'))
	.helpers(layouts)
	.helpers(handlebarsHelper.helpers(app));

wax.partials(path.join(__dirname, `theme/${themeName}/views/**/*.{hbs,js}`));

const viewDirs = [path.join(__dirname, 'views')];
viewDirs.unshift(path.join(__dirname, `theme/${themeName}/views/`));

app.set('views', viewDirs);
app.engine('hbs', wax.engine);
app.set('view engine', 'hbs');

app.set('view cache', true);

// uncomment after placing your favicon in /public
// app.use(favicon(path.join(__dirname, 'public', 'favicon.ico')));
if (Configuration.get('FEATURE_MORGAN_LOG_ENABLED')) {
	let morganLogFormat = Configuration.get('MORGAN_LOG_FORMAT');
	const noColor = Configuration.has('NO_COLOR') && Configuration.get('NO_COLOR');

	if (morganLogFormat === 'dev' && noColor) {
		morganLogFormat = ':method :url :status :response-time ms - :res[content-length]';
	}

	app.use(morgan(morganLogFormat, {
		skip(req, res) {
			return req && ((req.route || {}).path || '').includes('tsp-login');
		},
	}));
}

app.use(bodyParser.json({ limit: '10mb' }));
app.use(bodyParser.urlencoded({ extended: true, limit: '10mb' }));
app.use(cookieParser());

staticAssetsMiddleware(app);

let sessionStore;
const redisUrl = REDIS_URI;
if (redisUrl) {
	logger.info(`Using Redis session store at '${redisUrl}'.`);
	const client = new Redis(redisUrl);

	// The error event must be handled, otherwise the app crashes on redis connection errors.
	// This is due to basic NodeJS behavior: https://nodejs.org/api/events.html#error-events
	client.on('error', (err) => {
		logger.error('Redis client error', err);
	});

	sessionStore = new RedisStore({ client });
} else {
	logger.info('Using in-memory session store.');
	sessionStore = new session.MemoryStore();
}

const SIX_HOURS = 1000 * 60 * 60 * 6;
app.use(session({
	cookie: {
		// TODO ...cookieDefaults,
		maxAge: SIX_HOURS,
	},
	rolling: true, // refresh session with every request within maxAge
	store: sessionStore,
	saveUninitialized: true,
	resave: false,
	secret: Configuration.get('COOKIE_SECRET'), // Secret used to sign the session ID cookie
}));

// CSRF middlewares
if (Configuration.get('FEATURE_CSRF_ENABLED')) {
	app.use(duplicateTokenHandler);
	app.use(csurf());
	app.use(tokenInjector);
	// there follows an csrf error handler below...
}

const setTheme = require('./helpers/theme');

function removeIds(url) {
	const checkForHexRegExp = /[a-f\d]{24}/ig;
	return url.replace(checkForHexRegExp, 'ID');
}

// Custom flash middleware
app.use(async (req, res, next) => {
	// if there's a flash message in the session request, make it available in the response, then delete it
	res.locals.notification = req.session.notification;
	res.locals.inline = req.query.inline || false;
	setTheme(res);
	res.locals.domain = SC_DOMAIN;
	res.locals.production = req.app.get('env') === 'production';
	res.locals.env = req.app.get('env') || false; // TODO: ist das false hier nicht quatsch?
	res.locals.JWT_SHOW_TIMEOUT_WARNING_SECONDS = Number(JWT_SHOW_TIMEOUT_WARNING_SECONDS);
	res.locals.MAXIMUM_ALLOWABLE_TOTAL_ATTACHMENTS_SIZE_BYTE = Number(MAXIMUM_ALLOWABLE_TOTAL_ATTACHMENTS_SIZE_BYTE);
	// eslint-disable-next-line max-len
	res.locals.MAXIMUM_ALLOWABLE_TOTAL_ATTACHMENTS_SIZE_MEGABYTE = (MAXIMUM_ALLOWABLE_TOTAL_ATTACHMENTS_SIZE_BYTE / 1024 / 1024);
	res.locals.JWT_TIMEOUT_SECONDS = Number(JWT_TIMEOUT_SECONDS);
	res.locals.API_HOST = PUBLIC_BACKEND_URL || `${API_HOST}/`;
	res.locals.version = version;
	res.locals.sha = sha;
	res.locals.ROCKETCHAT_SERVICE_ENABLED = Configuration.get('ROCKETCHAT_SERVICE_ENABLED');
	delete req.session.notification;
	try {
		await authHelper.populateCurrentUser(req, res);
	} catch (error) {
		return next(error);
	}
	return next();
});

app.use(methodOverride('_method')); // for GET requests
app.use(methodOverride((req, res, next) => { // for POST requests
	if (req.body && typeof req.body === 'object' && '_method' in req.body) {
		// eslint-disable-next-line no-underscore-dangle
		const method = req.body._method;
		// eslint-disable-next-line no-underscore-dangle
		delete req.body._method;
		return method;
	}
	return undefined;
}));

// add res.$t method for i18n with users prefered language
app.use(require('./middleware/i18n'));
app.use(require('./middleware/datetime'));

const redirectUrl = Configuration.get('ROOT_URL_REDIRECT');
if (redirectUrl !== '') {
	app.get('/', (req, res, next) => {
		res.redirect(redirectUrl);
	});
}

// Initialize the modules and their routes
app.use(require('./controllers'));

// catch 404 and forward to error handler
app.use((req, res, next) => {
	const url = req.originalUrl || req.url;
	const err = new Error(`Page Not Found ${url}`);
	err.status = 404;
	next(err);
});

// error handlers
if (Configuration.get('FEATURE_CSRF_ENABLED')) {
	app.use(csrfErrorHandler);
}

// no statusCode exist for this cases
const isTimeoutError = (err) => err && err.message && (
	err.message.includes('ESOCKETTIMEDOUT')
	|| err.message.includes('ECONNREFUSED')
	|| err.message.includes('ETIMEDOUT')
);

app.use((err, req, res, next) => {
	const error = err.error || err;
	const status = error.status || error.statusCode || 500;
	error.statusCode = status;

	if (!error.options) {
		error.options = {};
	}
	if (!res.locals) {
		res.locals = {};
	}
	// prevent logging jwts and x-api-keys
	delete error.options.headers;

	if (Configuration.get('FEATURE_LOG_REQUEST') === true) {
		const reqInfo = {
			url: req.originalUrl || req.url,
			method: req.originalMethod || req.method,
			params: req.params,
			body: req.body,
		};
		error.requestInfo = filterLog(reqInfo);
	}

	if (res.locals.currentUser) {
		res.locals.loggedin = true;
		const { _id, schoolId, roles } = res.locals.currentUser;
		error.currentUser = {
			userId: _id,
			schoolId,
			roles: (roles || []).map((r) => r.name),
		};
	}

	if (error.message) {
		res.setHeader('error-message', error.message);
		res.locals.message = error.message;
	} else {
		res.locals.message = `Error with statusCode ${status}`;
	}

	// override with try again message by timeouts
	if (isTimeoutError(error)) {
		const baseRoute = typeof err.options.baseUrl === 'string' ? err.options.baseUrl.slice(0, -1) : '';
		const route = baseRoute + err.options.uri;
		const routeMessage = res.locals.production ? '' : ` beim Aufruf der Route ${route}`;
		res.locals.message = `Es ist ein Fehler aufgetreten${routeMessage}. Bitte versuche es erneut.`;
	}

	// do not show full errors in production mode
	res.locals.error = req.app.get('env') === 'development' ? err : { status };

	logger.error(error);

	// keep sidebar restricted in error page
	authHelper.restrictSidebar(req, res);

	// render the error page
	res.status(status).render('lib/error', {
		pageTitle: res.$t('lib.error.headline.pageTitle'),
		loggedin: res.locals.loggedin,
		inline: res.locals.inline ? true : !res.locals.loggedin,
	});
});

module.exports = app;