Add new status message system

2026-08-31 19:03:45 +02:00 · 2019-06-24 00:00:00 +00:00
parent 95160b0558
commit 17058c375c
9 changed files with 119 additions and 6 deletions
@@ -16,9 +16,15 @@
 */

 import { Router } from 'express'
+import { Database } from '../database'
 import { WebsocketApi } from '../websocket'
+import { setStatusMessage, getStatusMessage } from '../function/statusmessage'
+import * as escape from 'escape-html'
+import { json } from 'body-parser'
+import { BadRequest } from 'http-errors'

-export const createAdminRouter = ({ websocket }: {
+export const createAdminRouter = ({ database, websocket }: {
+  database: Database
  websocket: WebsocketApi
 }) => {
  const router = Router()
@@ -29,5 +35,33 @@ export const createAdminRouter = ({ websocket }: {
    })
  })

+  router.get('/status-message', async (_, res, next) => {
+    try {
+      const currentStatusMessage = await getStatusMessage({ database })
+
+      res.send('<html><body><form action="/admin/status-message" method="post"><textarea>' + escape(currentStatusMessage) + '</textarea><input type="submit" value="Save"></form></body></html>')
+    } catch (ex) {
+      next(ex)
+    }
+  })
+
+  router.post('/status-message', json(), async (req, res, next) => {
+    try {
+      if (typeof req.body !== 'object' || typeof req.body.smessage !== 'string') {
+        throw new BadRequest()
+      }
+
+      const newStatusMessage = req.body.smessage as string
+
+      await setStatusMessage({ database, newStatusMessage })
+
+      websocket.triggerImportantSyncAtAllDevicesInBackground()
+
+      res.json({ok: true})
+    } catch (ex) {
+      next(ex)
+    }
+  })
+
  return router
 }
@@ -62,7 +62,7 @@ export const createApi = ({ database, websocket, connectedDevicesManager }: {
        res.sendStatus(401)
      }
    },
-    createAdminRouter({ websocket })
+    createAdminRouter({ database, websocket })
  )

  return app
@@ -22,6 +22,7 @@ import { AppActivityModel, createAppActivityModel } from './appactivity'
 import { AuthTokenModel, createAuthtokenModel } from './authtoken'
 import { CategoryModel, createCategoryModel } from './category'
 import { CategoryAppModel, createCategoryAppModel } from './categoryapp'
+import { ConfigModel, createConfigModel } from './config'
 import { createDeviceModel, DeviceModel } from './device'
 import { createFamilyModel, FamilyModel } from './family'
 import { createMailLoginTokenModel, MailLoginTokenModel } from './maillogintoken'
@@ -39,6 +40,7 @@ export interface Database {
  appActivity: AppActivityModel
  category: CategoryModel
  categoryApp: CategoryAppModel
+  config: ConfigModel
  device: DeviceModel
  family: FamilyModel
  mailLoginToken: MailLoginTokenModel
@@ -57,6 +59,7 @@ const createDatabase = (sequelize: Sequelize.Sequelize): Database => ({
  appActivity: createAppActivityModel(sequelize),
  category: createCategoryModel(sequelize),
  categoryApp: createCategoryAppModel(sequelize),
+  config: createConfigModel(sequelize),
  device: createDeviceModel(sequelize),
  family: createFamilyModel(sequelize),
  mailLoginToken: createMailLoginTokenModel(sequelize),
@@ -0,0 +1,48 @@
+/*
+ * server component for the TimeLimit App
+ * Copyright (C) 2019 Jonas Lochmann
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, version 3 of the License.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+import { Database } from '../../database'
+import { configItemIds } from '../../database/config'
+import * as Sequelize from 'sequelize'
+
+export const getStatusMessage = async ({ database, transaction }: {
+  database: Database
+  transaction?: Sequelize.Transaction
+}) => {
+  const currentStatusMessageItem = await database.config.findById(configItemIds.statusMessage, { transaction })
+  const currentStatusMessage = (currentStatusMessageItem ? currentStatusMessageItem.value : null) || ''
+
+  return currentStatusMessage
+}
+
+export const setStatusMessage = async ({ database, newStatusMessage }: {
+  database: Database
+  newStatusMessage: string
+}) => {
+  if (newStatusMessage === '') {
+    await database.config.destroy({
+      where: {
+        id: configItemIds.statusMessage
+      }
+    })
+  } else {
+    await database.config.insertOrUpdate({
+      id: configItemIds.statusMessage,
+      value: newStatusMessage
+    })
+  }
+}
@@ -24,6 +24,7 @@ import {
  ServerUpdatedCategoryBaseData, ServerUpdatedCategoryUsedTimes,
  ServerUpdatedTimeLimitRules
 } from '../../object/serverdatastatus'
+import { getStatusMessage } from '../../function/statusmessage'

 export const generateServerDataStatus = async ({ database, clientStatus, familyId, transaction }: {
  database: Database,
@@ -57,7 +58,7 @@ export const generateServerDataStatus = async ({ database, clientStatus, familyI

  let result: ServerDataStatus = {
    fullVersion: familyEntry.hasFullVersion ? parseInt(familyEntry.fullVersionUntil, 10) : 0,
-    message: process.env.STATUS_MESSAGE || undefined
+    message: await getStatusMessage({ database, transaction }) || undefined
  }

  if (familyEntry.deviceListVersion !== clientStatus.devices) {
@@ -19,6 +19,7 @@ import * as io from 'socket.io'
 import { ConnectedDevicesManager, VisibleConnectedDevicesManager } from '../connected-devices'
 import { Database } from '../database'
 import { deviceByAuthTokenRoom } from './rooms'
+import * as EventEmitter from 'events'

 export const createWebsocketHandler = ({ connectedDevicesManager, database }: {
  connectedDevicesManager: VisibleConnectedDevicesManager
@@ -27,6 +28,14 @@ export const createWebsocketHandler = ({ connectedDevicesManager, database }: {
  websocketServer: io.Server
  websocketApi: WebsocketApi
 } => {
+  const events = new EventEmitter()
+
+  // this disables warnings for many listeners
+  // this is required because very single socket causes listeners
+  events.setMaxListeners(0)
+
+  const eventTriggerImportantSyncForAll = 'triggerimportantsyncforall'
+
  let socketCounter = 0
  const server = io()

@@ -43,6 +52,15 @@ export const createWebsocketHandler = ({ connectedDevicesManager, database }: {

      socket.join(deviceByAuthTokenRoom(deviceAuthToken))

+      const importantSyncForAllListener = () => {
+        setTimeout(() => {
+          socket.connected && socket.emit('should sync', { isImportant: true })
+        }, Math.random() * 1000 * 60 /* wait up to one minute */)
+      }
+
+      events.on(eventTriggerImportantSyncForAll, importantSyncForAllListener)
+      socket.on('disconnect', () => events.off(eventTriggerImportantSyncForAll, importantSyncForAllListener))
+
      ;(async () => {
        const deviceEntryUnsafe = await database.device.findOne({
          where: {
@@ -94,6 +112,9 @@ export const createWebsocketHandler = ({ connectedDevicesManager, database }: {
        .to(deviceByAuthTokenRoom(deviceAuthToken))
        .emit('sign out')
    },
+    triggerImportantSyncAtAllDevicesInBackground: () => {
+      events.emit(eventTriggerImportantSyncForAll)
+    },
    countConnections: () => socketCounter
  }

@@ -106,5 +127,6 @@ export const createWebsocketHandler = ({ connectedDevicesManager, database }: {
 export interface WebsocketApi {
  triggerSyncByDeviceAuthToken: (params: {deviceAuthToken: string, isImportant: boolean}) => void
  triggerLogoutByDeviceAuthToken: (params: {deviceAuthToken: string}) => void
+  triggerImportantSyncAtAllDevicesInBackground: () => void
  countConnections: () => number
 }