cityssm/corporate-records-manager

import createError from "http-errors";
import express from "express";

import { abuseCheck } from "@cityssm/express-abuse-points";
import compression from "compression";
import path from "path";
import cookieParser from "cookie-parser";
import csurf from "csurf";
import rateLimit from "express-rate-limit";

import session from "express-session";
import FileStore from "session-file-store";

import * as configFns from "./helpers/configFns.js";
import * as stringFns from "@cityssm/expressjs-server-js/stringFns.js";
import * as dateTimeFns from "@cityssm/expressjs-server-js/dateTimeFns.js";
import * as docuShareFns from "./helpers/docuShareFns.js";
import { version } from "./version.js";

import * as permissionHandlers from "./handlers/permissions.js";
import routerLogin from "./routes/login.js";
import routerDashboard from "./routes/dashboard.js";
import routerNew from "./routes/new.js";
import routerView from "./routes/view.js";
import routerEdit from "./routes/edit.js";
import routerReports from "./routes/reports.js";
import routerAdmin from "./routes/admin.js";

import { getRecordTypes } from "./helpers/recordsDB/configCache.js";

import { generatePassword } from "@cityssm/simple-password-generator";
import type { User } from "./types/recordTypes";

import debug from "debug";
const debugApp = debug("corporate-records-manager:app");


export const tempAdmin: User = {
  userName: "~tempAdmin",
  fullName: "Temporary Administrator",
  canViewAll: false,
  canUpdate: false,
  isAdmin: true,
  password: generatePassword({
    pattern: "xxxxxXXXXXnnnnn",
    doShufflePattern: true
  })
};

if (configFns.getProperty("application.enableTempAdminUser")) {
  debugApp("WARNING:" + tempAdmin.userName + " (" + tempAdmin.fullName + ") currently enabled.");
}


/*
 * INITIALIZE APP
 */


export const app = express();

if (!configFns.getProperty("reverseProxy.disableEtag")) {
  app.set("etag", false);
}

// View engine setup
app.set("views", "views");
app.set("view engine", "ejs");

app.use(abuseCheck({
  byXForwardedFor: configFns.getProperty("reverseProxy.blockViaXForwardedFor"),
  byIP: !configFns.getProperty("reverseProxy.blockViaXForwardedFor")
}));

if (!configFns.getProperty("reverseProxy.disableCompression")) {
  app.use(compression());
}

app.use((request, _response, next) => {
  debugApp(request.method + " " + request.url);
  next();
});

app.use(express.json());

app.use(express.urlencoded({
  extended: false
}));

app.use(cookieParser());
app.use(csurf({ cookie: true }));


/*
 * Rate Limiter
 */

const limiter = rateLimit({
  windowMs: 60 * 1000,
  max: 1000
});

app.use(limiter);


/*
 * STATIC ROUTES
 */


const urlPrefix = configFns.getProperty("reverseProxy.urlPrefix");

if (urlPrefix && urlPrefix !== "") {
  debugApp("urlPrefix = " + urlPrefix);
}


app.use(urlPrefix, express.static("public"));

app.use(urlPrefix + "/lib/fontsource-barlow",
  express.static(path.join("node_modules", "@fontsource", "barlow")));

app.use(urlPrefix + "/lib/bulma-js",
  express.static(path.join("node_modules", "@cityssm", "bulma-js", "dist")));

app.use(urlPrefix + "/lib/bulma-webapp-js",
  express.static(path.join("node_modules", "@cityssm", "bulma-webapp-js", "dist")));

app.use(urlPrefix + "/lib/date-diff",
  express.static(path.join("node_modules", "@cityssm", "date-diff", "es2015")));

app.use(urlPrefix + "/lib/fa5",
  express.static(path.join("node_modules", "@fortawesome", "fontawesome-free")));


/*
 * REDIRECTS
 */


app.use("/favicon.ico", (_request, response) => {
  response.redirect(301, urlPrefix + "/images/favicon.ico");
});


/*
 * SESSION MANAGEMENT
 */


const sessionCookieName = configFns.getProperty("session.cookieName");

const FileStoreSession = FileStore(session);


// Initialize session
app.use(session({
  store: new FileStoreSession({
    path: "./data/sessions",
    logFn: debug("corporate-records-manager:session")
  }),
  name: sessionCookieName,
  secret: configFns.getProperty("session.secret"),
  resave: true,
  saveUninitialized: false,
  rolling: true,
  cookie: {
    maxAge: configFns.getProperty("session.maxAgeMillis"),
    sameSite: "strict"
  }
}));

// Clear cookie if no corresponding session
app.use((request, response, next) => {

  if (request.cookies[sessionCookieName] && !request.session.user) {
    response.clearCookie(sessionCookieName);
  }

  next();
});

// Redirect logged in users
const sessionChecker = (request: express.Request, response: express.Response, next: express.NextFunction) => {

  if (request.session.user && request.cookies[sessionCookieName]) {
    return next();
  }

  return response.redirect(urlPrefix + "/login");
};


/*
 * ROUTES
 */


// Make config objects available to the templates
app.use(async (request, response, next) => {
  response.locals.configFns = configFns;
  response.locals.dateTimeFns = dateTimeFns;
  response.locals.stringFns = stringFns;

  response.locals.user = request.session.user;
  response.locals.csrfToken = request.csrfToken();

  response.locals.buildNumber = version;
  response.locals.urlPrefix = configFns.getProperty("reverseProxy.urlPrefix");
  response.locals.recordTypes = await getRecordTypes();
  response.locals.headTitle = "";
  next();
});


app.get(urlPrefix + "/", sessionChecker, (_request, response) => {
  response.redirect(urlPrefix + "/dashboard");
});

app.use(urlPrefix + "/dashboard", sessionChecker, routerDashboard);

app.use(urlPrefix + "/view", sessionChecker, routerView);

app.use(urlPrefix + "/new", sessionChecker, permissionHandlers.canUpdate, routerNew);

app.use(urlPrefix + "/edit", sessionChecker, permissionHandlers.canUpdate, routerEdit);

app.use(urlPrefix + "/reports", sessionChecker, permissionHandlers.canViewAll, routerReports);

app.use(urlPrefix + "/admin", sessionChecker, permissionHandlers.isAdmin, routerAdmin);

app.use(urlPrefix + "/login", routerLogin);

app.get(urlPrefix + "/logout", (request, response) => {

  if (request.session.user && request.cookies[sessionCookieName]) {

    // eslint-disable-next-line unicorn/no-null
    request.session.destroy(null);

    request.session = undefined;
    response.clearCookie(sessionCookieName);

  }

  response.redirect(urlPrefix + "/login");
});


// Catch 404 and forward to error handler
app.use((_request, _response, next) => {
  next(createError(404));
});


// Error handler
app.use((error: Error, request: express.Request, response: express.Response) => {

  // Set locals, only providing error in development
  response.locals.message = error.message;
  response.locals.error = request.app.get("env") === "development" ? error : {};

  // Render the error page
  response.status(error.status || 500);
  response.render("error");
});


if (configFns.getProperty("integrations.docuShare.isEnabled")) {
  docuShareFns.doSetup();
}

export default app;