feat: merge all route to single file

Signed-off-by: BoHong Li <raccoon@hackmd.io>

Author: a60814billy

app.js

@@ -206,13 +206,7 @@ app.locals.enableDropBoxSave = config.isDropboxEnable
 app.locals.enableGitHubGist = config.isGitHubEnable
 app.locals.enableGitlabSnippets = config.isGitlabSnippetsEnable
 
-app.use(require('./lib/web/baseRouter'))
-app.use(require('./lib/web/statusRouter'))
-app.use(require('./lib/web/auth'))
-app.use(require('./lib/web/historyRouter'))
-app.use(require('./lib/web/userRouter'))
-app.use(require('./lib/web/imageRouter'))
-app.use(require('./lib/web/noteRouter'))
+app.use(require('./lib/web/routes').router)
 
 // response not found if no any route matxches
 app.get('*', function (req, res) {

lib/realtime.js

@@ -14,7 +14,7 @@ const get = require('lodash/get')
 // core
 const config = require('./config')
 const logger = require('./logger')
-const history = require('./history')
+const history = require('./web/history')
 const models = require('./models')
 
 // ot
@@ -247,59 +247,62 @@ async function _updateNoteAsync (note) {
 }
 
 // TODO: test it
-function getStatus (callback) {
-  models.Note.count().then(function (notecount) {
-    var distinctaddresses = []
-    var regaddresses = []
-    var distinctregaddresses = []
-    Object.keys(users).forEach(function (key) {
-      var user = users[key]
-      if (!user) return
-      let found = false
-      for (let i = 0; i < distinctaddresses.length; i++) {
-        if (user.address === distinctaddresses[i]) {
-          found = true
-          break
-        }
-      }
-      if (!found) {
-        distinctaddresses.push(user.address)
-      }
-      if (user.login) {
-        regaddresses.push(user.address)
+function getStatus () {
+  return models.Note.count()
+    .then(function (notecount) {
+      var distinctaddresses = []
+      var regaddresses = []
+      var distinctregaddresses = []
+      Object.keys(users).forEach(function (key) {
+        var user = users[key]
+        if (!user) return
         let found = false
-        for (let i = 0; i < distinctregaddresses.length; i++) {
-          if (user.address === distinctregaddresses[i]) {
+        for (let i = 0; i < distinctaddresses.length; i++) {
+          if (user.address === distinctaddresses[i]) {
             found = true
             break
           }
         }
         if (!found) {
-          distinctregaddresses.push(user.address)
+          distinctaddresses.push(user.address)
         }
-      }
-    })
-    models.User.count().then(function (regcount) {
-      // eslint-disable-next-line standard/no-callback-literal
-      return callback ? callback({
-        onlineNotes: Object.keys(notes).length,
-        onlineUsers: Object.keys(users).length,
-        distinctOnlineUsers: distinctaddresses.length,
-        notesCount: notecount,
-        registeredUsers: regcount,
-        onlineRegisteredUsers: regaddresses.length,
-        distinctOnlineRegisteredUsers: distinctregaddresses.length,
-        isConnectionBusy: connectProcessQueue.lock,
-        connectionSocketQueueLength: connectProcessQueue.queue.length,
-        isDisconnectBusy: disconnectProcessQueue.lock,
-        disconnectSocketQueueLength: disconnectProcessQueue.queue.length
-      }) : null
+        if (user.login) {
+          regaddresses.push(user.address)
+          let found = false
+          for (let i = 0; i < distinctregaddresses.length; i++) {
+            if (user.address === distinctregaddresses[i]) {
+              found = true
+              break
+            }
+          }
+          if (!found) {
+            distinctregaddresses.push(user.address)
+          }
+        }
+      })
+
+      return models.User.count()
+        .then(function (regcount) {
+          return {
+            onlineNotes: Object.keys(notes).length,
+            onlineUsers: Object.keys(users).length,
+            distinctOnlineUsers: distinctaddresses.length,
+            notesCount: notecount,
+            registeredUsers: regcount,
+            onlineRegisteredUsers: regaddresses.length,
+            distinctOnlineRegisteredUsers: distinctregaddresses.length,
+            isConnectionBusy: connectProcessQueue.lock,
+            connectionSocketQueueLength: connectProcessQueue.queue.length,
+            isDisconnectBusy: disconnectProcessQueue.lock,
+            disconnectSocketQueueLength: disconnectProcessQueue.queue.length
+          }
+        })
+        .catch(function (err) {
+          return logger.error('count user failed: ' + err)
+        })
     }).catch(function (err) {
-      return logger.error('count user failed: ' + err)
+      return logger.error('count note failed: ' + err)
     })
-  }).catch(function (err) {
-    return logger.error('count note failed: ' + err)
-  })
 }
 
 // TODO: test it

lib/response.js

@@ -14,9 +14,10 @@ const config = require('./config')
 const logger = require('./logger')
 const models = require('./models')
 const utils = require('./utils')
-const history = require('./history')
+const history = require('./web/history')
 
 // public
+exports.responseError = responseError
 exports.errorForbidden = errorForbidden
 exports.errorNotFound = errorNotFound
 exports.errorBadRequest = errorBadRequest
@@ -33,6 +34,7 @@ exports.publishNoteActions = publishNoteActions
 exports.publishSlideActions = publishSlideActions
 exports.githubActions = githubActions
 exports.gitlabActions = gitlabActions
+exports.checkViewPermission = checkViewPermission
 
 function errorForbidden (res) {
   const { req } = res

lib/web/baseRouter.js

@@ -0,0 +1,21 @@
+'use strict'
+
+const config = require('../../config')
+const { responseError } = require('../../response')
+
+exports.errorForbidden = (req, res) => {
+  if (req.user) {
+    return responseError(res, '403', 'Forbidden', 'oh no.')
+  }
+
+  req.flash('error', 'You are not allowed to access this page. Maybe try logging in?')
+  res.redirect(config.serverURL + '/')
+}
+
+exports.errorNotFound = (req, res) => {
+  responseError(res, '404', 'Not Found', 'oops.')
+}
+
+exports.errorInternalError = (req, res) => {
+  responseError(res, '500', 'Internal Error', 'wtf.')
+}

lib/web/errorPage/index.js

@@ -4,10 +4,10 @@
 var LZString = require('@hackmd/lz-string')
 
 // core
-var config = require('./config')
-var logger = require('./logger')
-var response = require('./response')
-var models = require('./models')
+var config = require('../../config')
+var logger = require('../../logger')
+var response = require('../../response')
+var models = require('../../models')
 
 function getHistory (userid, callback) {
   models.User.findOne({

lib/history.js renamed to lib/web/history/index.js

@@ -0,0 +1,38 @@
+'use strict'
+
+const fs = require('fs')
+const path = require('path')
+const config = require('../../config')
+const { User } = require('../../models')
+const logger = require('../../logger')
+
+exports.showIndex = async (req, res) => {
+  const isLogin = req.isAuthenticated()
+  const deleteToken = ''
+
+  const data = {
+    signin: isLogin,
+    infoMessage: req.flash('info'),
+    errorMessage: req.flash('error'),
+    privacyStatement: fs.existsSync(path.join(config.docsPath, 'privacy.md')),
+    termsOfUse: fs.existsSync(path.join(config.docsPath, 'terms-of-use.md')),
+    deleteToken: deleteToken
+  }
+
+  if (!isLogin) {
+    return res.render('index.ejs', data)
+  }
+
+  const user = await User.findOne({
+    where: {
+      id: req.user.id
+    }
+  })
+  if (user) {
+    data.deleteToken = user.deleteToken
+    return res.render('index.ejs', data)
+  }
+
+  logger.error(`error: user not found with id ${req.user.id}`)
+  return res.render('index.ejs', data)
+}

lib/web/historyRouter.js

@@ -0,0 +1,80 @@
+'use strict'
+
+const { Router } = require('express')
+
+const { wrap, urlencodedParser, markdownParser } = require('./utils')
+
+// load controller
+const indexController = require('./homepage')
+const errorPageController = require('./errorPage')
+const statusController = require('./status')
+const historyController = require('./history')
+const userController = require('./user')
+const response = require('../response')
+const appRouter = Router()
+
+// register route
+
+// get index
+appRouter.get('/', wrap(indexController.showIndex))
+
+// ----- error page -----
+// get 403 forbidden
+appRouter.get('/403', errorPageController.errorForbidden)
+// get 404 not found
+appRouter.get('/404', errorPageController.errorNotFound)
+// get 500 internal error
+appRouter.get('/500', errorPageController.errorInternalError)
+
+appRouter.get('/status', wrap(statusController.getStatus))
+appRouter.get('/config', statusController.getConfig)
+
+// register auth module
+appRouter.use(require('./auth'))
+
+// get history
+appRouter.get('/history', historyController.historyGet)
+// post history
+appRouter.post('/history', urlencodedParser, historyController.historyPost)
+// post history by note id
+appRouter.post('/history/:noteId', urlencodedParser, historyController.historyPost)
+// delete history
+appRouter.delete('/history', historyController.historyDelete)
+// delete history by note id
+appRouter.delete('/history/:noteId', historyController.historyDelete)
+
+// user
+// get me info
+appRouter.get('/me', wrap(userController.getMe))
+
+// delete the currently authenticated user
+appRouter.get('/me/delete/:token?', wrap(userController.deleteUser))
+
+// export the data of the authenticated user
+appRouter.get('/me/export', userController.exportMyData)
+
+appRouter.get('/user/:username/avatar.svg', userController.getMyAvatar)
+
+// register image upload module
+appRouter.use(require('./imageRouter'))
+
+// get new note
+appRouter.get('/new', response.newNote)
+// post new note with content
+appRouter.post('/new', markdownParser, response.newNote)
+// get publish note
+appRouter.get('/s/:shortid', response.showPublishNote)
+// publish note actions
+appRouter.get('/s/:shortid/:action', response.publishNoteActions)
+// get publish slide
+appRouter.get('/p/:shortid', response.showPublishSlide)
+// publish slide actions
+appRouter.get('/p/:shortid/:action', response.publishSlideActions)
+// get note by id
+appRouter.get('/:noteId', response.showNote)
+// note actions
+appRouter.get('/:noteId/:action', response.noteActions)
+// note actions with action id
+appRouter.get('/:noteId/:action/:actionId', response.noteActions)
+
+exports.router = appRouter