mrnodebot/scripts/modules/voiceRegulars.js

Your Friendly NodeJS IRC Bot

const scriptInfo = {
    name: 'voiceRegulars',
    desc: 'Voice regulars',
    createdBy: 'IronY',
};
const _ = require('lodash');
const logger = require('../../lib/logger');
const scheduler = require('../../lib/scheduler');
const voiceUsers = require('../lib/_voiceUsersInChannel');

module.exports = (app) => {
    // We are missing things
    if (!app.Database ||
        !_.isObject(app.Config.features.voiceRegulars) || // We need a voiceRegulars block in the features section
        _.isEmpty(app.Config.features.voiceRegulars) || // It must not be empty
        !app.Config.features.voiceRegulars.autoVoice // It is not enabled
    ) return scriptInfo;

    const threshold = (
        _.isSafeInteger(app.Config.features.voiceRegulars.threshold) &&
        app.Config.features.voiceRegulars.threshold >= 0
    ) ? app.Config.features.voiceRegulars.threshold : 250;

    const autoVoiceTimeInMins = (
        _.isSafeInteger(app.Config.features.autoVoiceTimeInMins) &&
        app.Config.features.voiceRegulars >= 1
    ) ? app.Config.features.voiceRegulars.autoVoiceTimeInMins : 40;

    const autoVoiceChannelIgnore = _.isArray(app.Config.features.autoVoiceChannelIgnore) ? app.Config.features.voiceRegulars.autoVoiceChannelIgnore : [];

    const cronTime = new scheduler.RecurrenceRule();
    cronTime.minute = autoVoiceTimeInMins;

    scheduler.schedule('voiceRegulars', cronTime, () =>
        _.forEach(app.channels, async (channel) => {
            // we are not an op in said channel, or channel is in ignore list
            if (_.includes(autoVoiceChannelIgnore, channel) || !app._ircClient.isOpInChannel(channel, app.nick)) return;

            try {
                const result = await voiceUsers(channel, threshold, app);
                logger.info(`Running Voice Regulars in ${channel}`);
            } catch (err) {
                logger.error('Error in Voice Regulars', {
                    message: err.message || '',
                    stack: err.stack || '',
                });
            }
        }));

    // Voice Users on join if they meet a certain threshold
    app.OnJoin.set('voice-regulars', {
        call: async (channel, nick, message) => {
            // we are not an op in said channel, or channel is in ignore list
            if (nick === app.nick || _.includes(autoVoiceChannelIgnore, channel) || !app._ircClient.isOpInChannel(channel, app.nick)) return;

            try {
                await voiceUsers(channel, threshold, app, {
                    nicks: [nick],
                });
            } catch (err) {
                logger.error('Something went wrong in the voice-regulars on-join', {
                    message: err.message || '',
                    stack: err.stack || '',
                });
            }
        },
        name: 'voice-regulars',
    });

    // Manually voice regulars
    app.Commands.set('voice-regulars', {
        desc: '[channel?] voice regulars in the channel',
        access: app.Config.accessLevels.channelOpIdentified,
        call: async (to, from, text, message) => {
            const channel = text.split(' ')[0] || to;
            if (!app._ircClient.isOpInChannel(channel, app.nick)) {
                app.say(from, `I am not a op in ${to}, ${from}`);
                return;
            }
            try {
                await voiceUsers(channel, threshold, app);
                app.say(to, `I have just voiced all users who meet the threshold of ${threshold} messages (per month), ${from}`);
            } catch (err) {
                logger.error('Something went wrong in the voice-regulars command', {
                    message: err.message || '',
                    stack: err.stack || '',
                });
                app.say(to, `Something went wrong trying to voice the regulars, ${from}`);
            }
        },
    });

    return scriptInfo;
};