import { EventEmitter } from "events"; import { PluginOptions } from "knub"; import { GuildCounters } from "../../data/GuildCounters"; import { CounterTrigger, parseCounterConditionString } from "../../data/entities/CounterTrigger"; import { mapToPublicFn } from "../../pluginUtils"; import { MINUTES, convertDelayStringToMS, values } from "../../utils"; import { zeppelinGuildPlugin } from "../ZeppelinPluginBlueprint"; import { AddCounterCmd } from "./commands/AddCounterCmd"; import { CountersListCmd } from "./commands/CountersListCmd"; import { ResetAllCounterValuesCmd } from "./commands/ResetAllCounterValuesCmd"; import { ResetCounterCmd } from "./commands/ResetCounterCmd"; import { SetCounterCmd } from "./commands/SetCounterCmd"; import { ViewCounterCmd } from "./commands/ViewCounterCmd"; import { changeCounterValue } from "./functions/changeCounterValue"; import { counterExists } from "./functions/counterExists"; import { decayCounter } from "./functions/decayCounter"; import { getPrettyNameForCounter } from "./functions/getPrettyNameForCounter"; import { getPrettyNameForCounterTrigger } from "./functions/getPrettyNameForCounterTrigger"; import { offCounterEvent } from "./functions/offCounterEvent"; import { onCounterEvent } from "./functions/onCounterEvent"; import { setCounterValue } from "./functions/setCounterValue"; import { CountersPluginType, zCountersConfig } from "./types"; const DECAY_APPLY_INTERVAL = 5 * MINUTES; const defaultOptions: PluginOptions = { config: { counters: {}, can_view: false, can_edit: false, can_reset_all: false, }, overrides: [ { level: ">=50", config: { can_view: true, }, }, { level: ">=100", config: { can_edit: true, }, }, ], }; /** * The Counters plugin keeps track of simple integer values that are tied to a user, channel, both, or neither — "counters". * These values can be changed using the functions in the plugin's public interface. * These values can also be set to automatically decay over time. * * Triggers can be registered that check for a specific condition, e.g. "when this counter is over 100". * Triggers are checked against every time a counter's value changes, and will emit an event when triggered. * A single trigger can only trigger once per user/channel/in general, depending on how specific the counter is (e.g. a per-user trigger can only trigger once per user). * After being triggered, a trigger is "reset" if the counter value no longer matches the trigger (e.g. drops to 100 or below in the above example). After this, that trigger can be triggered again. */ export const CountersPlugin = zeppelinGuildPlugin()({ name: "counters", showInDocs: true, info: { prettyName: "Counters", description: "Keep track of per-user, per-channel, or global numbers and trigger specific actions based on this number", configurationGuide: "See Counters setup guide", configSchema: zCountersConfig, }, defaultOptions, // TODO: Separate input and output types configParser: (input) => zCountersConfig.parse(input), public: { counterExists: mapToPublicFn(counterExists), // Change a counter's value by a relative amount, e.g. +5 changeCounterValue: mapToPublicFn(changeCounterValue), // Set a counter's value to an absolute value setCounterValue: mapToPublicFn(setCounterValue), getPrettyNameForCounter: mapToPublicFn(getPrettyNameForCounter), getPrettyNameForCounterTrigger: mapToPublicFn(getPrettyNameForCounterTrigger), onCounterEvent: mapToPublicFn(onCounterEvent), offCounterEvent: mapToPublicFn(offCounterEvent), }, // prettier-ignore messageCommands: [ CountersListCmd, ViewCounterCmd, AddCounterCmd, SetCounterCmd, ResetCounterCmd, ResetAllCounterValuesCmd, ], async beforeLoad(pluginData) { const { state, guild } = pluginData; state.counters = new GuildCounters(guild.id); state.events = new EventEmitter(); state.counterTriggersByCounterId = new Map(); const activeTriggerIds: number[] = []; // Initialize and store the IDs of each of the counters internally state.counterIds = {}; const config = pluginData.config.get(); for (const counter of Object.values(config.counters)) { const dbCounter = await state.counters.findOrCreateCounter(counter.name, counter.per_channel, counter.per_user); state.counterIds[counter.name] = dbCounter.id; const thisCounterTriggers: CounterTrigger[] = []; state.counterTriggersByCounterId.set(dbCounter.id, thisCounterTriggers); // Initialize triggers for (const trigger of values(counter.triggers)) { const parsedCondition = parseCounterConditionString(trigger.condition)!; const parsedReverseCondition = parseCounterConditionString(trigger.reverse_condition)!; const counterTrigger = await state.counters.initCounterTrigger( dbCounter.id, trigger.name, parsedCondition[0], parsedCondition[1], parsedReverseCondition[0], parsedReverseCondition[1], ); activeTriggerIds.push(counterTrigger.id); thisCounterTriggers.push(counterTrigger); } } // Mark old/unused counters to be deleted later await state.counters.markUnusedCountersToBeDeleted([...Object.values(state.counterIds)]); // Mark old/unused triggers to be deleted later await state.counters.markUnusedTriggersToBeDeleted(activeTriggerIds); }, async afterLoad(pluginData) { const { state } = pluginData; const config = pluginData.config.get(); // Start decay timers state.decayTimers = []; for (const [counterName, counter] of Object.entries(config.counters)) { if (!counter.decay) { continue; } const decay = counter.decay; const decayPeriodMs = convertDelayStringToMS(decay.every)!; if (decayPeriodMs === 0) { continue; } state.decayTimers.push( setInterval(() => { decayCounter(pluginData, counterName, decayPeriodMs, decay.amount); }, DECAY_APPLY_INTERVAL), ); } }, beforeUnload(pluginData) { const { state } = pluginData; if (state.decayTimers) { for (const interval of state.decayTimers) { clearInterval(interval); } } state.events.removeAllListeners(); }, });