omegga 0.1.85 → 1.0.2

package/src/webserver/backend/index.js

@@ -1,206 +0,0 @@
-const path = require('path');
-const http = require('http');
-const https = require('https');
-
-const express = require('express');
-const expressSession = require('express-session');
-const NedbStore = require('nedb-promises-session-store').default;
-const SocketIo = require('socket.io');
-const bodyParser = require('body-parser');
-
-const util = require('./util.js');
-const setupApi = require('./api.js');
-const setupMetrics = require('./metrics.js');
-const Database = require('./database.js');
-
-const soft = require('../../softconfig.js');
-
-// path to assets folder
-const ASSET_PATH = path.join(__dirname, '../frontend/assets');
-
-// path to frontend directory
-const FRONTEND_PATH = path.join(__dirname, '../frontend');
-
-// path to webpacked data
-const PUBLIC_PATH = path.join(__dirname, '../../../public');
-
-const log = (...args) => global.Omegga.log(...args);
-const error = (...args) => global.Omegga.error(...args);
-
-// the webserver servers an authenticated
-class Webserver {
-  #database = undefined;
-
-  // create a webserver
-  constructor(options, omegga) {
-    this.port = options.port || process.env.PORT || soft.DEFAULT_PORT;
-    this.options = options;
-    this.omegga = omegga;
-    this.dataPath = path.join(omegga.path, soft.DATA_PATH);
-
-    // the database provides omegga with metrics, chat logs, and more
-    // to help administrators keep track of their users and server
-    this.database = new Database(options, omegga);
-
-    // https status of the server
-    this.https = false;
-    // started status of the server
-    this.started = false;
-    this.created = this.createServer();
-  }
-
-  // create the webserver
-  async createServer() {
-    const hasOpenSSL = require('hasbin').sync('openssl');
-
-    // let the database do migrations
-    await this.database.doMigrations();
-
-    // create express app
-    this.app = express();
-
-    // create a server with https if applicable
-    const pickProtocol = async () => {
-      if (this.options.https) {
-        if (hasOpenSSL) {
-          const certFile = await util.getSSLKeys(this.dataPath);
-          if (certFile) {
-            // handy notification of generated ssl certs
-            if (certFile.new) log('>>'.green, 'Generated new SSL certificate');
-
-            this.https = true;
-            return https.createServer(
-              {
-                key: certFile.keys.serviceKey,
-                cert: certFile.keys.certificate,
-              },
-              this.app
-            );
-          } else {
-            error(
-              '!>'.red,
-              'Error generating SSL certificate - falling back to http'
-            );
-          }
-        }
-
-        // warn the user
-        log(
-          ':>'.yellow,
-          'Running web server with http - install ',
-          'openssl'.yellow.underline,
-          ' for https (more secure)'
-        );
-      }
-
-      // fallback to http
-      return http.Server(this.app);
-    };
-
-    // create http(s) server based on openssl availability
-    this.server = await pickProtocol();
-
-    this.app.set('trust proxy', 1);
-    const session = expressSession({
-      secret: util.getSessionSecret(this.dataPath),
-      resave: false,
-      saveUninitialized: false,
-      cookie: {
-        path: '/',
-        secure: this.https,
-        maxAge: 365 * 24 * 60 * 60 * 1000, // 1 year
-      },
-      // use a nedb database for session store
-      store: NedbStore({
-        filename: path.join(this.dataPath, soft.SESSION_STORE),
-        connect: expressSession,
-      }),
-    });
-    this.app.use(session);
-
-    // setup routes and webserver
-    await this.initWebUI(session);
-    return true;
-  }
-
-  // setup the web ui routes
-  async initWebUI(session) {
-    const io = SocketIo(this.server);
-    this.io = io;
-
-    await this.database.getInstanceId();
-
-    // use the session middleware
-    io.use((socket, next) => {
-      session(socket.request, socket.request.res || {}, async () => {
-        // check if user is authenticated
-        const user = await this.database.findUserById(
-          socket.request.session.userId
-        );
-        if (user && !user.isBanned) {
-          // TODO: check if user is banned while connected to disconnect websocket
-          socket.user = user;
-          await this.database.stores.users.update(
-            { _id: user._id },
-            { $set: { lastOnline: Date.now() } }
-          );
-          next();
-        } else {
-          next(new Error('unauthorized'));
-        }
-      });
-    });
-
-    // provide assets in the /public path
-    this.app.use('/public', express.static(PUBLIC_PATH));
-    this.app.use('/public', express.static(ASSET_PATH));
-    this.app.use(bodyParser.json());
-
-    this.rooms = ['chat', 'status', 'plugins', 'server'];
-
-    // setup the api
-    setupApi(this, io);
-
-    // setup metrics and tracking
-    setupMetrics(this, io);
-
-    // every request goes through the index file (frontend handles 404s)
-    this.app.use(async (req, res) => {
-      const user = await this.database.findUserById(req.session.userId);
-      const isAuth = user && !user.isBanned;
-
-      if (isAuth) {
-        res.sendFile(path.join(FRONTEND_PATH, 'app.html'));
-      } else {
-        res.sendFile(path.join(FRONTEND_PATH, 'auth.html'));
-      }
-    });
-  }
-
-  // start the webserver
-  async start() {
-    if (this.started) return;
-    await this.created;
-    return await new Promise(resolve => {
-      this.server.listen(this.port, () => {
-        log(
-          `${'>>'.green} Web UI available at`,
-          `http${this.https ? 's' : ''}://127.0.0.1:${this.port}`.green
-        );
-        this.started = true;
-        this.database.addChatLog('server', {}, 'Server started');
-        resolve();
-      });
-    });
-  }
-
-  // stop the webserver
-  stop() {
-    this.database.addChatLog('server', {}, 'Server stopped');
-    this.server.close();
-    this.started = false;
-    clearInterval(this.serverStatusInterval);
-  }
-}
-
-module.exports = Webserver;

package/src/webserver/backend/metrics.js

@@ -1,148 +0,0 @@
-const soft = require('../../softconfig.js');
-
-const error = (...args) => global.Omegga.error(...args);
-
-module.exports = (server, io) => {
-  const { database, omegga } = server;
-
-  // server status is checked every minute
-  clearInterval(server.serverStatusInterval);
-  // heartbeat happens every 60 seconds
-  let empties = 0;
-
-  // last heartbeat hour
-  let lastHour = -1;
-  // players that have joined in the last hour
-  let hourlyPlayers = [];
-
-  server.lastReportedStatus = null;
-  server.serverStatusInterval = setInterval(async () => {
-    if (!omegga.started) return;
-    try {
-      // get the server status
-      const status = await omegga.getServerStatus();
-      if (!status) return;
-
-      // get players by id
-      const players = status.players.map(p => p.id);
-
-      // send the unaltered status to the frontend
-      server.lastReportedStatus = status;
-      io.to('status').emit('server.status', status);
-      try {
-        omegga.emit('metrics:heartbeat', status);
-      } catch (e) {
-        // prevent the omegga callback handlers from crashing this
-        error('Error in heartbeat emit', e);
-      }
-
-      // stop recording metrics after 3 empty server statuses
-      if (
-        players.length === 0 &&
-        ++empties > soft.METRIC_EMPTIES_BEFORE_PAUSE
-      ) {
-        return;
-      }
-
-      const now = new Date();
-      const hour = now.getUTCHours();
-      // check if it's a new hour (for punchcard unique player tracking)
-      if (hour !== lastHour) {
-        lastHour = hour;
-        hourlyPlayers = [];
-      }
-
-      // find all the players unique to this hour
-      const newPlayers = players.filter(p => !hourlyPlayers.includes(p));
-      if (newPlayers.length > 0) {
-        // update the punchcard
-        await database.updatePlayerPunchcard(newPlayers.length);
-        // mark those players as previously joined players
-        hourlyPlayers.push(...newPlayers);
-      }
-
-      // server is not empty, reset the counter
-      empties = 0;
-
-      const data = {
-        // number of bricks
-        bricks: status.bricks,
-        // unique players by id
-        players: players.filter((p, i) => players.indexOf(p) === i),
-        // addresses by player id
-        ips: Object.fromEntries(status.players.map(p => [p.id, p.address])),
-      };
-
-      // hand the server status off to the database
-      await database.addHeartbeat(data);
-    } catch (e) {
-      // probably an issue getting server status
-      error('Server Not Responding...');
-    }
-  }, soft.METRIC_HEARTBEAT_INTERVAL);
-
-  // chat events
-  omegga.on('chat', async (name, message) => {
-    const p = omegga.getPlayer(name);
-    const user = {
-      id: p.id,
-      name,
-      color: p.getNameColor(),
-    };
-
-    // tell web users about a chat message
-    io.to('chat').emit('chat', await database.addChatLog('msg', user, message));
-  });
-
-  // player leave events
-  omegga.on('leave', async ({ id, name }) => {
-    // tell web users a player left
-    io.to('chat').emit(
-      'chat',
-      await database.addChatLog('leave', { id, name })
-    );
-  });
-
-  // player join events
-  omegga.on('join', async ({ id, name }) => {
-    // add the visit to the database
-    const isFirst = await database.addVisit({ id, name });
-
-    // tell web users a player joined (and if it's their first time joining)
-    io.to('chat').emit(
-      'chat',
-      await database.addChatLog('join', {
-        id,
-        name,
-        ...(isFirst ? { isFirst } : {}),
-      })
-    );
-  });
-
-  // tell web users plugin status
-  omegga.on('plugin:status', (shortPath, info) => {
-    io.to('plugins').emit('plugin', shortPath, info);
-  });
-
-  // server status events
-  omegga.on('start', () =>
-    io
-      .to('server')
-      .emit('status', { started: true, starting: false, stopping: false })
-  );
-  omegga.on('server:starting', () =>
-    io
-      .to('server')
-      .emit('status', { started: false, starting: true, stopping: false })
-  );
-  omegga.on('server:stopped', () =>
-    io
-      .to('server')
-      .emit('status', { started: false, starting: false, stopping: false })
-  );
-  omegga.on('server:stopping', () =>
-    io
-      .to('server')
-      .emit('status', { started: true, starting: false, stopping: true })
-  );
-};

package/src/webserver/backend/util.js

@@ -1,75 +0,0 @@
-const path = require('path');
-const fs = require('fs');
-
-const crypto = require('crypto');
-const pem = require('pem').promisified;
-
-const soft = require('../../softconfig.js');
-
-module.exports = {
-  // generate SSL certs for the https server
-  async getSSLKeys(dataPath) {
-    const certsPath = path.join(dataPath, soft.WEB_CERTS_DATA);
-    let certData;
-    const now = Date.now();
-
-    // read cert data from json file
-    if (fs.existsSync(certsPath)) {
-      try {
-        certData = JSON.parse(fs.readFileSync(certsPath, 'utf8'));
-
-        // make sure the cert is not expired
-        if (certData.expires < now) certData = undefined;
-      } catch (e) {
-        // nothing to do here - probably bad json
-      }
-    }
-
-    // otherwise generate it
-    if (!certData) {
-      // expires in half the real duration time
-      const days = 360;
-      const expires = now + (days / 2) * 24 * 60 * 60 * 1000;
-      try {
-        const keys = await pem.createCertificate({ days, selfSigned: true });
-        certData = { keys, expires };
-
-        fs.writeFileSync(certsPath, JSON.stringify(certData));
-        certData.new = true;
-      } catch (e) {
-        // probably missing openssl or something
-      }
-    }
-
-    return certData;
-  },
-
-  // generate a session secret for the cookies
-  getSessionSecret(dataPath) {
-    const tokenPath = path.join(dataPath, soft.WEB_SESSION_TOKEN);
-    const secretSize = 64;
-    let secret;
-    // read secret from file
-    if (fs.existsSync(tokenPath)) {
-      try {
-        secret = fs.readFileSync(tokenPath, 'utf8');
-      } catch (e) {
-        // nothing to do here - probably file is a folder or something
-      }
-    }
-
-    if (!secret) {
-      // generate a new secret
-      const buf = Buffer.alloc(secretSize);
-      secret = crypto.randomFillSync(buf).toString('hex');
-      try {
-        // write secret to file
-        fs.writeFileSync(tokenPath, secret);
-      } catch (e) {
-        // nothing to do here - maybe missing perms?
-      }
-    }
-
-    return secret;
-  },
-};

package/src/webserver/frontend/.eslintrc.yml

@@ -1,26 +0,0 @@
-env:
-  browser: true
-  es2021: true
-globals:
-  io: readonly
-extends:
-  - 'eslint:recommended'
-  - 'plugin:vue/essential'
-parserOptions:
-  ecmaVersion: 12
-  sourceType: module
-plugins:
-  - vue
-rules:
-  indent:
-    - error
-    - 2
-  linebreak-style:
-    - error
-    - unix
-  quotes:
-    - error
-    - single
-  semi:
-    - error
-    - always

package/src/webserver/frontend/app.js

@@ -1,78 +0,0 @@
-import Vue from 'vue';
-
-import './components/index.js';
-import './widgets/tooltip.js';
-import './widgets/index.js';
-import './partials/index.js';
-
-import Main from './views/Main.vue';
-
-Vue.prototype.logout = () =>
-  fetch('/api/v1/logout').then(() => location.reload());
-
-Vue.prototype.user = {};
-Vue.prototype.roles = [];
-Vue.prototype.userLookup = [];
-Vue.prototype.showLogout = false;
-Vue.prototype.omeggaData = {};
-
-Vue.prototype.xss = str =>
-  str
-    .replace(/&/g, '&')
-    .replace(/</g, '&lt;')
-    .replace(/>/g, '&gt;')
-    .replace(/"/g, '&quot;')
-    .replace(/'/g, '&apos;');
-
-// convert minutes into min/hour/day
-Vue.prototype.heartbeatAgo = mins => {
-  if (mins < 60) return mins + ' mins';
-  mins /= 60;
-  if (mins < 24) return Math.round(mins) + ' hours';
-  mins /= 24;
-  return Math.round(mins) + ' days';
-};
-
-// convert ms into sec/min/hour
-Vue.prototype.duration = ago => {
-  if (ago < 0) return 'not yet';
-  ago /= 1000;
-
-  if (ago < 5) return 'a moment';
-  if (ago < 60) return Math.round(ago) + ' secs';
-  ago /= 60;
-  if (ago < 60) return Math.round(ago) + ' mins';
-  ago /= 60;
-  if (ago < 24) return Math.round(ago) + ' hours';
-  ago /= 24;
-  return Math.round(ago) + ' days';
-};
-
-// only date
-Vue.prototype.isoDate = time => {
-  return Vue.prototype.isoTime(time).split(' ')[0];
-};
-
-// date time in semi-iso format
-Vue.prototype.isoTime = time => {
-  const date = new Date(time);
-  const pad = s => (s + '').padStart(2, '0');
-  return (
-    date.getFullYear() +
-    '-' +
-    pad(date.getMonth() + 1) +
-    '-' +
-    pad(date.getDate()) +
-    ' ' +
-    pad(date.getHours()) +
-    ':' +
-    pad(date.getMinutes()) +
-    ':' +
-    pad(date.getSeconds())
-  );
-};
-
-new Vue({
-  el: '#app',
-  ...Main,
-});

package/src/webserver/frontend/auth.js

@@ -1,16 +0,0 @@
-import Vue from 'vue';
-
-import './components';
-import Auth from './views/Auth.vue';
-
-Vue.prototype.omeggaData = {};
-
-new Vue({
-  el: '#app',
-  data() {
-    return {};
-  },
-  render(h) {
-    return h(Auth);
-  },
-});

package/src/webserver/frontend/components/Background.vue

@@ -1,83 +0,0 @@
-<style scoped lang="scss">
-@import '../css/theme';
-
-.background {
-  position: fixed;
-  left: 0;
-  top: 0;
-  width: 100%;
-  height: 100%;
-  overflow: visible;
-
-  background-image: url('/public/img/auth_bg.webp');
-  background-repeat: no-repeat;
-  background-attachment: fixed;
-  background-size: cover;
-  background-position: 50% 50%;
-}
-
-.bg-img {
-  position: absolute;
-  filter: blur(20px);
-  left: -40px;
-  top: -40px;
-  width: calc(100% + 80px);
-  height: calc(100% + 80px);
-  object-fit: cover;
-}
-
-.version {
-  position: absolute;
-  top: 5px;
-  right: 5px;
-  font-weight: 200;
-  font-size: 12px;
-  color: rgba(255, 255, 255, 0.5);
-  text-shadow: 0 0 2px rgba(0, 0, 0, 0.5);
-}
-
-
-@media (prefers-color-scheme: dark) {
-  .background {
-    background-image: url('/public/img/dark_bg.webp');
-
-    .light {
-      display: none;
-    }
-  }
-}
-
-@media (prefers-color-scheme: light) {
-  .dark {
-    display: none;
-  }
-}
-
-</style>
-
-<template>
-  <div class="background">
-    <img class="bg-img dark" src="/public/img/dark_bg.webp">
-    <img class="bg-img light" src="/public/img/auth_bg.webp">
-    <div class="version" v-if="version">Omegga v{{version}}</div>
-    <slot />
-  </div>
-</template>
-<script>
-
-import Vue from 'vue';
-
-export default Vue.component('br-background', {
-  sockets: {
-    data(data) {
-      this.version = data.version;
-    }
-  },
-  data() {
-    return {
-      version: this.omeggaData && this.omeggaData.version,
-    };
-  }
-});
-
-</script>