dbot/modules/ignore/ignore.js

/**
 * Module Name: Ignore
 * Description: Handles commands in which users can choose to ignore listeners
 * and commands from certain modules. It also populates the JSBot instance with
 * this information, since that actually performs the ignorance. Also provides
 * commands for moderators to choose the bot to ignore certain channels.
 */
var _ = require('underscore')._,
    databank = require('databank'),
    NoSuchThingError = databank.NoSuchThingError;

var ignore = function(dbot) {
    this.internalAPI = {
        'isUserImpeded': function(server, user, item, by, callback) {
            this.api.getUserIgnores(server, user, function(err, user, ignores) {
                var isImpeded = false;
                if(!err && ignores) {
                    if(_.has(dbot.commands, item)) {
                        item = dbot.commands[item].module;
                    }
                    if(_.include(ignores[by], item)) {
                        isImpeded = true;
                    }
                }
                callback(isImpeded);
            });
        }.bind(this)
    };

    var commands = {
        '~ignore': function(event) {
            var module = event.params[1];
            var ignorableModules = _.chain(dbot.modules)
                .filter(function(module, name) {
                    return dbot.config[module].ignorable === true;
                })
                .pluck('name')
                .value();
            var ignoreCreated = function(err, result) {
                if(!err) {
                    dbot.instance.ignoreTag(event.user, module);
                    event.reply(dbot.t('ignored', {
                        'user': event.user, 
                        'module': module
                    }));
                }
            };

            if(_.isUndefined(module)) {
                event.reply(dbot.t('ignore_usage', {
                    'user': event.user, 
                    'modules': ignorableModules.join(', ')
                }));
            } else {
                if(module == '*' || _.include(ignorableModules, module)) {
                    this.api.getUserIgnores(event.server, event.user, function(err, user, ignores) {
                        if(!err) {
                            if(!ignores) {
                                this.db.create('ignores', user.id, {
                                    'id': user.id,
                                    'ignores': [ module ],
                                    'bans': []
                                }, ignoreCreated);
                            } else {
                                if(!_.include(ignores.ignores, module)) {
                                    ignores.ignores.push(module);
                                    this.db.save('ignores', user.id, ignores, ignoreCreated);
                                } else {
                                    event.reply(dbot.t('already_ignoring', { 'user': event.user }));
                                }
                            }
                        }
                    }.bind(this));
                } else {
                    event.reply(dbot.t('invalid_ignore', { 'user': event.user }));
                }
            }
        }, 

        '~unignore': function(event) {
            var module = event.params[1];

            this.api.getUserIgnores(event.server, event.user, function(err, user, ignores) {
                if(err || !ignores || _.isUndefined(module)) {
                    event.reply(dbot.t('unignore_usage', {
                        'user': event.user, 
                        'modules': ignores.ignores.join(', ')
                    }));
                } else {
                    if(_.include(ignores.ignores, module)) {
                        ignores.ignores = _.without(ignores.ignores, module);
                        this.db.save('ignores', user.id, ignores, function(err) {
                            if(!err) {
                                dbot.instance.removeIgnore(event.user, module)
                                event.reply(dbot.t('unignored', {
                                    'user': event.user, 
                                    'module': module
                                }));
                            }
                        });
                    } else {
                        event.reply(dbot.t('invalid_unignore', { 'user': event.user }));
                    }
                }
            }.bind(this));
        },

        '~ban': function(event) {
            var user = event.input[1],
                item = event.input[2];
            var banCreated = function(err, result) {
                if(!err) {
                    event.reply(dbot.t('banned_success', {
                        'user': event.user, 
                        'banned': user,
                        'module': item 
                    }));
                }
            };

            if(module == '*' || _.include(dbot.config.moduleNames, item) || _.include(dbot.commands, item)) {
                this.api.getUserIgnores(event.server, user, function(err, user, ignores) {
                    if(!err) {
                        if(!ignores) {
                            this.db.create('ignores', user.id, {
                                'id': user.id,
                                'ignores': [],
                                'bans': [ item ] 
                            }, banCreated);
                        } else {
                            if(!_.include(ignores.bans, item)) {
                                ignores.bans.push(item);
                                this.db.save('ignores', user.id, ignores, banCreated);
                            } else {
                                event.reply(dbot.t('already_banned', {
                                    'user': event.user,
                                    'banned': user
                                }));
                            }
                        }
                    }
                }.bind(this));
            } else {
                event.reply(dbot.t('invalid_ban', { 'user': event.user }));
            }
        },

        '~unban': function(event) {
            var nick = event.input[1];
            var item = event.input[2];

            this.api.getUserIgnores(event.server, nick, function(err, user, ignores) {
                if(err || !ignores) {
                    event.reply(dbot.t('invalid_unban', {
                        'user': event.user,
                        'banned': nick 
                    }));
                } else {
                    if(_.include(ignores.bans, item)) {
                        ignores.bans = _.without(ignores.bans, item); 
                        this.db.save('ignores', user.id, ignores, function(err) {
                            event.reply(dbot.t('unbanned_success', {
                                'user': event.user,
                                'banned': nick,
                                'module': item
                            }));
                        });
                    } else {
                        event.reply(dbot.t('invalid_unban', {
                            'user': event.user,
                            'banned': nick
                        }));
                    }
                }
            }.bind(this));
        },

        '~ignorechannel': function(event) {
            var channel = ((event.params[1] == '@') ? event.channel.name : event.params[1]);
            var module = event.params[2];

            // Ignoring the value of 'ignorable' at the moment
            if(module == '*' || _.include(dbot.config.moduleNames, module)) {
                if(!_.has(dbot.db.ignores, channel)) dbot.db.ignores[channel] = [];
                if(!_.include(dbot.db.ignores[channel], module)) {
                    dbot.db.ignores[channel].push(module);
                    dbot.instance.ignoreTag(channel, module);
                    event.reply(dbot.t('ignoring_channel', {
                        'module': module,
                        'channel': channel
                    }));
                } else {
                    event.reply(dbot.t('already_ignoring_channel', {
                        'module': module,
                        'channel': channel
                    }));
                }
            } else {
                event.reply(dbot.t('module_not_exist', { 'module': module }));
            }
        },

        '~unignorechannel': function(event) {
            var channel = ((event.params[1] == '@') ? event.channel.name : event.params[1]);
            var module = event.params[2];

            if(!_.has(dbot.db.ignores, channel)) dbot.db.ignores[channel] = [];
            if(_.include(dbot.db.ignores[channel], module)) {
                dbot.db.ignores[channel] = _.without(dbot.db.ignores[channel], module); 
                dbot.instance.removeIgnore(channel, module);
                event.reply(dbot.t('unignoring_channel', {
                    'module': module,
                    'channel': channel
                }));
            } else {
                event.reply(dbot.t('not_ignoring_channel', {
                    'module': module,
                    'channel': channel
                }));
            }
        }
    };

    commands['~ban'].regex = [/^~ban ([^ ]+) ([^ ]+)$/, 3];
    commands['~unban'].regex = [/^~unban ([^ ]+) ([^ ]+)$/, 3];

    commands['~ban'].access = 'moderator';
    commands['~unban'].access = 'moderator';
    commands['~ignorechannel'].access = 'moderator';
    commands['~unignorechannel'].access = 'moderator';

    this.commands = commands;

    this.onLoad = function() {
        dbot.instance.clearIgnores();

        this.db.scan('ignores', function(ignores) {
            dbot.api.users.getUser(ignores.id, function(user) {
                if(user) {
                    _.each(ignores.ignores, function(module) {
                        dbot.instance.ignoreTag(user.primaryNick, module);
                    });
                }
            });
        }, function(err) { });
    };
};

exports.fetch = function(dbot) {
    return new ignore(dbot);
};