mCaptcha/templates/panel/sitekey/add/advance/ts/levels/index.ts

// Copyright (C) 2022  Aravinth Manivannan <realaravinth@batsense.net>
// SPDX-FileCopyrightText: 2023 Aravinth Manivannan <realaravinth@batsense.net>
//
// SPDX-License-Identifier: AGPL-3.0-or-later

import log from "../../../../../../logger";

/** Datatype represenging an mCaptcha level */
export type Level = {
  difficulty_factor: number;
  visitor_threshold: number;
};

/** Datatype representing a collection of mCaptcha levels */
class Levels {
  levels: Array<Level>;

  constructor() {
    this.levels = [];
  }

  add = (newLevel: Level) => {
    log.debug(`[levels/index.ts] levels lenght: ${this.levels.length}`);
    if (newLevel.difficulty_factor <= 0) {
      throw new Error(
        `Level ${this.levels.length}'s difficulty must be greater than zero`,
      );
    }

    if (newLevel.visitor_threshold <= 0) {
      throw new Error(
        `Level ${this.levels.length}'s visitors must be greater than zero`,
      );
    }

    if (this.levels.length == 0) {
      this.levels.push(newLevel);
      return true;
    }

    let count = 1;

    this.levels.forEach(level => {
      if (level.visitor_threshold >= newLevel.visitor_threshold) {
        const msg = `Level ${this.levels.length}'s visitor count should be greater than previous levels(Level ${count} is greater)`;
        throw new Error(msg);
      } else if (level.difficulty_factor >= newLevel.difficulty_factor) {
        const msg = `Level ${this.levels.length} difficulty should be greater than previous levels(Level ${count} is greater)`;
        throw new Error(msg);
      } else {
        count++;
      }
    });

    this.levels.push(newLevel);
  };

  get = () => this.levels;
}

/** Singleton that does manipulations on Levels object */
export const LEVELS = (function() {
  const levels = new Levels();

  return {
    /** get levels */
    getLevels: () => levels.get(),

    /** add new level */
    add: (newLevel: Level) => levels.add(newLevel),

    /** update levels */
    update: (updateLevel: Level, id: number) => {
      const tmpLevel = new Levels();

      id -= 1;
      try {
        for (let i = 0; i < levels.levels.length; i++) {
          if (id == i) {
            tmpLevel.add(updateLevel);
          } else {
            tmpLevel.add(levels.levels[i]);
          }
        }
        levels.levels = tmpLevel.levels;
        log.debug("post update:");
        LEVELS.print();
        return true;
      } catch (e) {
        log.debug(e);
        return false;
      }
    },

    print: () =>
      levels.levels.forEach(level =>
        log.debug(
          `difficulty_factor: ${level.difficulty_factor} visitor ${level.visitor_threshold}`,
        ),
      ),

    /** remove level */
    remove: (id: number) => {
      log.debug(`[LEVELS] received order to remove ${id} element`);

      const tmpLevel = new Levels();

      id -= 1;
      try {
        for (let i = 0; i < levels.levels.length; i++) {
          if (id != i) {
            tmpLevel.add(levels.levels[i]);
          } else {
            log.debug(`[LEVELS] removing ${i} element`);
            const rmElement = levels.levels[i];
            log.debug(
              `[LEVELS] removing element: 
              difficulty_factor: ${rmElement.difficulty_factor} 
              visitor_threshold: ${rmElement.visitor_threshold}`,
            );
          }
        }
        levels.levels = tmpLevel.levels;
        log.debug("Post remove:");
        LEVELS.print();
        return true;
      } catch (e) {
        log.debug(e);
        return false;
      }
    },
  };
})();