Chaturbate

Bots Home | My Uploads | Create an App
Helena-Auto-Filter
Author: jeffhips
Description Source Code Launch Bot Current Users
Created by: Jeffhips
var OWNER_FLAG = 32;
var MODERATOR_FLAG = 16;
var FANCLUB_FLAG = 8;
var DKBLUE_FLAG = 4;
var LTBLUE_FLAG = 2;
var GREY_FLAG = 1;
var TIP_MENU = [];
var TIP_MENU_PRICE = [];
var MAX_ITEMS = 7;

var helenaBot = {

        commands: {},
        registerCommand: function (command, helpText, owner, moderator, fanclub, dkblue, ltblue, grey, method) {
            "use strict";
            this.commands[command] = {method: method, helpText: helpText, perms: this.bool2Perm(owner, moderator, fanclub, dkblue, ltblue, grey)};
        },
        checkCommand: function (msg) {
            "use strict";
            var m = msg.m;
            var u = msg.user;

            if (m[0] === '/') {
                // Don't print commands
                msg['X-Spam'] = true;
                // Remove trailing spaces
                m = m.replace(/\s+$/, '');
                // Find command parameters
                var commandParts = m.split(/\s+/);
                var commandName = commandParts.shift();
                //cb.log(u + ' issued command: ' + commandName);

                if (this.commands[commandName] && (this.commands[commandName].perms & this.msg2Perm(msg))) {
                    cb.log(u + " allowed to run command:" + commandName);
                    msg = this.commands[commandName].method(msg, commandParts);
                    // Only don't print if it is a command we handle
                    return msg;
                } else {
                    if (!this.canControlBot(msg)) {
                        cb.log("You're not allowed to run command:" + commandName);
                    }
                    return false;
                }
            } else {
                return false;
            }
        },

        bool2Perm: function (owner, moderator, fanclub, dkblue, ltblue, grey) {
            "use strict";
            var perms = 0;
            perms = owner ? perms | OWNER_FLAG : perms;
            perms = moderator ? perms | MODERATOR_FLAG : perms;
            perms = fanclub ? perms | FANCLUB_FLAG : perms;
            perms = dkblue ? perms | DKBLUE_FLAG : perms;
            perms = ltblue ? perms | LTBLUE_FLAG : perms;
            perms = grey ? perms | GREY_FLAG : perms;
            return perms;
        },

        msg2Perm: function (msg) {
            "use strict";
            var perms = 0;
            perms = msg.user === cb.room_slug ? perms | OWNER_FLAG : perms;
            perms = msg.is_mod ? perms | MODERATOR_FLAG : perms;
            perms = msg.in_fanclub ? perms | FANCLUB_FLAG : perms;
            perms = msg.tipped_recently ? perms | DKBLUE_FLAG : perms;
            perms = msg.has_tokens ? perms | LTBLUE_FLAG : perms;
            perms = perms === 0 ? perms | GREY_FLAG : perms;
            return perms;
        },


// Commands the room owner and moderators can use
        unsilenceCommand: '/unsilence',
        silenceCommand: '/silence',
        silenceListCommand: '/silenceList',
        silenceManyCommand: '/silenceMany',
        statsCommand: '/hbstats',
        addCommand: '/addWord',
        addManyCommand: '/addManyWords',
        deleteCommand: '/deleteWord',
        modeCommand: '/changeMode',
        protectCommand: '/protectUser',
        unProtectCommand: '/unprotectUser',
        protectListCommand: '/protectedList',
        addSCommand: '/addSilence',
        addManySCommand: '/addManySilence',
        addSUserCommand: '/addSilentUser',
        addSUserPatternCommand: '/addSUserPattern',
        unsilenceSCommand: '/unsilenceS',

// Commands that everyone can use
        helpCommand: '/hbhelp',
        listCommand: '/list',

// Useful globals
        wordBoundary: "(\\s|\\b)",

// Data structures for silenced and warned lists
        silenced: {
        },
        Ssilenced: {
        },
        warned: {
        },
        protected: {
        },
        notified: {
        },
        maxWarnings: 1,
        totalWarnings: 0,
        totalSilenced: 0,
        totalMessagesBlocked: 0,
// Default patterns for single word matches (covers the three cases)
        wordPatternStart: '',
        wordPatternEnd: '',
        wordPatternMiddle: '',

// Default pattern for phrase matches (not as rigorous as the word matcher
        phrasePatternStart: '',
        phrasePatternEnd: '',
        phrasePatternMiddle: '',

        // Default patterns for single word matches (covers the three cases)
        SwordPatternStart: '',
        SwordPatternEnd: '',
        SwordPatternMiddle: '',

        SuserPattern: '',

// Pattern to find phrases in the bad word list
        phraseFinder: /\s+/i,

        emotePattern: /^:/,
        capitalised: /^[A-Z][^A-Z]*$/,

        anonibRegex: /anon.{0,3}ib/i,

        actualBanList: "",

        actualBannedWords: {
        },
        actualBannedPhrases: {
        },
        actualBannedSWords: {
        },
        actualBannedSUsers: {
        },

        haveBadWords: false,
        haveBadPhrases: false,
        haveBadSWords: false,
        haveBadSUserPattern: false
    };
// CB app settings
cb.settings_choices = [
    {name: 'silenced', label: 'Issue permanent silence to (separated by commas)', type: 'str', minLength: 0, maxLength: 10240, required: false},
    {name: 'badwords', label: 'Banned Phrases (separated by commas)', type: 'str', minLength: 0, maxLength: 10240, defaultValue: 'show boobs, open pussy, boobs, pussy, ass, fuck, c2c, nude'},
    {name: 'allCapsChanger', type: 'choice', label: 'Prevent AUTO CAPS(doesn\'t affect emotes e.g. :HELLO)',
        choice1: 'Yes',
        choice2: 'No', defaultValue: 'No'},
    {name: 'maxWarnings', label: 'Number of warning before silence (0 for silence with no warning)', type: 'int', minValue: 0, maxValue: 10, defaultValue: 3},
    {name: 'hideOrSilence', type: 'choice', label: 'Hide Message or Silence User after Warning',
        choice1: 'Hide',
        choice2: 'Silence', defaultValue: 'Silence'},
    {name: 'allowTipToUnsilence', type: 'choice', label: 'Allow users to tip to become unsilenced',
        choice1: 'Yes',
        choice2: 'No', defaultValue: 'No'},
    {name: 'tokensToBeUnsilenced', label: 'Minimum size of tip to become unsilenced', type: 'int', minValue: 0, defaultValue: 30},
    {name: 'usersToProcess', label: 'User groups whose messages will be moderated (fan club members are always safe, users who have tipped within the last 24hrs are counted as blues)', type: 'choice', choice1: 'Greys only', choice2: 'Greys & Blues', defaultValue: 'Greys only'},
    {name: 'noticeTime', label: 'Advertise for every(minutes)', type: 'int', minValue: 0, defaultValue: 5},
    {name: 'tipMenuOne', label: 'Tip Menu Item #1', type: 'str'},
    {name: 'tipMenuOnePrice', label: 'Tip Menu Item #1 Price', type: 'int', minValue: 0},
    {name: 'tipMenuTwo', label: 'Tip Menu Item #2', type: 'str'},
    {name: 'tipMenuTwoPrice', label: 'Tip Menu Item #2 Price', type: 'int', minValue: 0},
    {name: 'tipMenuThree', label: 'Tip Menu Item #3', type: 'str'},
    {name: 'tipMenuThreePrice', label: 'Tip Menu Item #3 Price', type: 'int', minValue: 0},
    {name: 'tipMenuFour', label: 'Tip Menu Item #4', type: 'str'},
    {name: 'tipMenuFourPrice', label: 'Tip Menu Item #4 Price', type: 'int', minValue: 0},
    {name: 'tipMenuFive', label: 'Tip Menu Item #5', type: 'str'},
    {name: 'tipMenuFivePrice', label: 'Tip Menu Item #5 Price', type: 'int', minValue: 0},
    {name: 'tipMenuSix', label: 'Tip Menu Item #6', type: 'str'},
    {name: 'tipMenuSixPrice', label: 'Tip Menu Item #6 Price', type: 'int', minValue: 0},
    {name: 'tipMenuSeven', label: 'Tip Menu Item #7', type: 'str'},
    {name: 'tipMenuSevenPrice', label: 'Tip Menu Item #7 Price', type: 'int', minValue: 0},
    {name: 'tipMenuAdTime', label: 'Advertise tip menu for every(minutes)', type: 'int', minValue: 0}
];


// c: message color
// m: the message text
// user: username of message sender
// f: message font
// in_fanclub: is the user in the broadcasters fan club
// has_tokens: does the user have at least 1 token
// is_mod: is the user a moderator
// tipped_recently: is the user a dark blue?
// gender: m (male), f (female), s (shemale), or c (couple)
cb.onMessage(function (msg) {
    "use strict";
    return helenaBot.onMessage(msg);
});

cb.onTip(function (tip) {
    "use strict";
    helenaBot.onTip(tip);
});

cb.onEnter(function (user) {
    "use strict";
    helenaBot.onEnter(user);
});

helenaBot.onEnter = function (user) {
    "use strict";
    if (helenaBot.canProcessContent(user) && !(user.user in this.notified)) {
        cb.chatNotice('Welcome to my room, ' + user.user + ' :welcomew', user.user, '','#334FFF', 'bold');
        cb.chatNotice('The Helena-Bot is running. It hides messages containing words or phrases that the broadcaster has banned. :BANNED So please be polite and respectful!', user.user, '', '#C60303', 'bold');
        cb.chatNotice('NON-NUDE! No matter what!', user.user, '', '#C60303', 'bold');
        if (cb.settings.hideOrSilence === 'Silence') {
            if (cb.settings.maxWarnings > 0) {
                cb.chatNotice('If you choose to use a banned word or phrase, you will be warned up to ' + cb.settings.maxWarnings + ' times before being automatically silenced, be careful!', user.user, '','#334FFF', 'bold');
            } else {
                cb.chatNotice('The broadcaster has chosen a zero tolerance policy, you will be automatically silenced the first time you use a banned word or phrase, be careful!', user.user, '','#334FFF', 'bold');
            }
        }
        cb.chatNotice(':words2 To see the banned words and phrases, type /list into the chat window', user.user, '','#C70039', 'bold');
        this.notified[user.user] = 1;
    }
};

// Main on message callback function
helenaBot.onMessage = function (msg) {
    "use strict";
    // vars for ease of use
    var m = msg.m;
    var u = msg.user;
    var commandParam = "";

    var newMsg = helenaBot.checkCommand(msg);
    if (newMsg) {
        return msg;
    }

    // check for action
    if (m[0] === '/') {
        // don't print commands
        msg['X-Spam'] = true;

        // Remove trailing spaces
        m = m.replace(/\s+$/, '');

        // Find command parameters
        var commandParts = m.split(/\s+/);

        var commandName = commandParts[0];
//        cb.log(u + ' issued command: ' + commandName);

        // check if controller (owner or moderator)
        if (this.canControlBot(msg)) {
            if (commandName === this.unsilenceCommand && commandParts.length > 1) // unsilence with username parameter
            {
                commandParam = commandParts[1];
                if (this.unSilenceUser(commandParam)) {
                    cb.chatNotice('User ' + commandParam + ' has been unsilenced by ' + u, '', '', '#0FC600', 'bold');
                    cb.chatNotice('You have been unsilenced by ' + u + ' however if you break the rules again, you will be warned and/or silenced.', commandParam, '', '#FFD500', 'bold');
                } else {
                    cb.chatNotice('User ' + commandParam + ' was not on the unsilence list.', u, '', '#E3230C', 'bold');
                }
            }
            else if (commandName === this.protectCommand && commandParts.length > 1) // protect with username parameter
            {
                var commandParam = commandParts[1];
                if (this.protectUser(commandParam)) {
                    cb.chatNotice('You have been protected by ' + u + ' so your messages won\'t be moderated by the Helena-Bot, however if you behave badly you may be unprotected.', commandParam, '', '#0FC600', 'bold');
                    cb.chatNotice('You have protected ' + commandParam, u, '', '#0FC600', 'bold');
                } else {
                    cb.chatNotice('User ' + commandParam + ' was already on the protect list.', u, '', '#0FC600', 'bold');
                }
            }
            else if (commandName === this.unProtectCommand && commandParts.length > 1) // unprotect with username parameter
            {
                commandParam = commandParts[1];
                if (this.unProtectUser(commandParam)) {
                    cb.chatNotice('You have been unprotected by ' + u + ' so your messages will now be moderated by the Helena-Bot.', commandParam, '', '#E3230C', 'bold');
                    cb.chatNotice('You have unprotected ' + commandParam, u,  '', '#E3230C', 'bold');
                } else {
                    cb.chatNotice('User ' + commandParam + ' was not on the protect list.', u,  '', '#E3230C', 'bold');
                }
            }
            else if (commandName === this.modeCommand && commandParts.length > 1) // mode command with parameter
            {
                commandParam = commandParts[1];
                if (commandParam === 'silence') {
                    if (cb.settings.hideOrSilence === 'Hide') {
                        cb.chatNotice('Changing to Silence mode', u, '', '#0FC600', 'bold');
                        cb.settings.hideOrSilence = 'Silence';
                    } else {
                        cb.chatNotice('Already in Silence mode', u, '', '#E3230C', 'bold');
                    }

                } else if (commandParam === 'hide') {
                    if (cb.settings.hideOrSilence === 'Silence') {
                        cb.chatNotice('Changing to Hide mode', u, '', '#0FC600', 'bold');
                        cb.settings.hideOrSilence = 'Hide';
                    } else {
                        cb.chatNotice('Already in Hide mode', u, '', '#E3230C', 'bold');
                    }
                } else {
                    cb.chatNotice('Unrecognised mode: ' + commandParam, u, '', '#E3230C', 'bold');
                    cb.chatNotice('The Available modes are silence and hide', u, '', '#E3230C', 'bold')
                    //this.usage(msg);
                }
            }
            else if (commandParts[0] === this.addCommand && commandParts.length > 1) // add word/phrase
            {
                if (commandParts.length > 2) {
                    // phrase
                    commandParts.shift();
                    var localPhrase = commandParts.join(' ');
                    this.addToActualBanList(localPhrase, 'phrase');
                    this.buildBanLists();
                    cb.chatNotice("Added new phrase [" + localPhrase + "] to banned list", u, '', '#0FC600', 'bold');
                } else {
                    this.addToActualBanList(commandParts[1], 'word');
                    this.buildBanLists();
                    cb.chatNotice("Added new word [" + commandParts[1] + "] to banned list", u, '', '#0FC600', 'bold');
                }
            }
            else if (commandParts[0] === this.addManyCommand && commandParts.length > 1) // add many words
            {
                if (/,/.test(m)) {
                    cb.chatNotice("You must use spaces not commas as the separator for the /addManyWords command, not processing", '', '#E3230C', 'bold');
                } else {
                    commandParts.shift();

                    for (var jj = 0; jj < commandParts.length; jj++) {
                        this.addToActualBanList(commandParts[jj], 'word');
                    }
                    this.buildBanLists();
                    cb.chatNotice("Added new words [" + commandParts.join(',') + "] to banned list", u, '', '#0FC600', 'bold');
                }
            }
            else if (commandParts[0] === this.addSCommand && commandParts.length > 1) // add word/phrase
            {
                this.addToActualSBanList(commandParts[1]);
                this.buildBanLists();
                cb.chatNotice("Added new word [" + commandParts[1] + "] to silent ban list", u, '', '#0FC600', 'bold');
            }
            else if (commandParts[0] === this.addSUserCommand && commandParts.length > 1) // add S user
            {
                this.SsilenceUser(commandParts[1]);
                cb.chatNotice("Added user [" + commandParts[1] + "] to silent ban list", u, '', '#0FC600', 'bold');
            }
            else if (commandParts[0] === this.unsilenceSCommand && commandParts.length > 1) // unsilence S user
            {
                if (this.unSsilenceUser(commandParts[1])) {
                    cb.chatNotice("Removed user [" + commandParts[1] + "] from silent ban list", u, '', '#0FC600', 'bold');
                } else {
                    cb.chatNotice("User [" + commandParts[1] + "] was not on the silent ban list", u, '', '#E3230C', 'bold');
                }
            }
            else if (commandParts[0] === this.addSUserPatternCommand && commandParts.length > 1) // add S user pattern
            {
                this.addToActualSUserBanList(commandParts[1]);
                this.buildBanLists();
                cb.chatNotice("Added user pattern [" + commandParts[1] + "] to silent ban list", u, '', '#0FC600', 'bold');
            }
            else if (commandParts[0] === this.addManySCommand && commandParts.length > 1) // add many S words
            {
                if (/,/.test(m)) {
                    cb.chatNotice("You must use spaces not commas as the separator for the /addManyWords command, not processing", u, '', '#E3230C', 'bold');
                } else {
                    commandParts.shift();

                    for (var jj = 0; jj < commandParts.length; jj++) {
                        this.addToActualSBanList(commandParts[jj]);
                    }
                    this.buildBanLists();
                    cb.chatNotice("Added new words [" + commandParts.join(',') + "] to silent ban list", u, '', '#0FC600', 'bold');
                }
            }
            else if (commandParts[0] === this.deleteCommand && commandParts.length > 1) // delete word/phrase
            {
                if (commandParts.length > 2) {
                    // phrase
                    commandParts.shift();
                    var localPhrase = commandParts.join(' ');
                    if (this.removeFromActualBanList(localPhrase, 'phrase')) {
                        this.buildBanLists();
                        cb.chatNotice("Deleted phrase [" + localPhrase + "] from banned list", u, '', '#0FC600', 'bold');
                    } else {
                        cb.chatNotice("Phrase [" + localPhrase + "] was not found in banned list, can't remove", u, '', '#E3230C', 'bold');
                    }
                } else {
                    if (this.removeFromActualBanList(commandParts[1], 'word')) {
                        this.buildBanLists();
                        cb.chatNotice("Deleted word [" + commandParts[1] + "] from banned list", u, '', '#0FC600', 'bold');
                    } else {
                        cb.chatNotice("Word [" + commandParts[1] + "] was not found in banned list, can't remove", u, '', '#E3230C', 'bold');
                    }
                }
            }
//            else {
//                cb.chatNotice('Command \'' + commandName + '\' not recognised.', u);
//                this.usage(msg);
//            }
        }
    }
    else if (this.isSSilenced(u)) {
        msg['X-Spam'] = true;
    }
    else if (this.hasBannedSWord(m)) {
        msg['X-Spam'] = true;
        if (!this.canControlBot(msg)) {
            cb.chatNotice("Private notice: The Helena-Bot just secret silenced user [" + u + "] because they said something bad. This notice was not broadcast to the room.", cb.room_slug, '', '#E3230C', 'bold');
            this.SsilenceUser(u);
        }
    }
    else if (!helenaBot.canControlBot(msg) && this.haveBadSUserPattern) {
        if (this.SuserPattern.exec(u)) {
            cb.chatNotice("Private notice: The Helena-Bot just secret silenced user [" + u + "] because of their username. This notice was not broadcast to the room.", cb.room_slug, '', '#E3230C', 'bold');
            this.SsilenceUser(u);
            msg['X-Spam'] = true;
        }
    }
    else if (this.isSilenced(u)) {
        cb.chatNotice('Your message was rejected because you have been silenced because you ignored the warnings about banned words or behaviour (either this session on or a previous occasion), your messages won\'t be seen by anyone else', u, '', '#E3230C', 'bold');
        msg['X-Spam'] = true;
        this.totalMessagesBlocked++;

        if (cb.settings.allowTipToUnsilence === "Yes") {
            cb.chatNotice('You can tip ' + cb.settings.tokensToBeUnsilenced + ' tokens or more in one tip to become unsilenced.', u, '', '#581845', 'bold');
        }
    } else {
        if (!helenaBot.canControlBot(msg)) {
            // Block all caps for everyone except controllers
            // All caps changer
            if (cb.settings.allCapsChanger === "Yes") {
                var parts = m.split(" ");
                var cleaned = [];
                for (var kk = 0; kk < parts.length; kk++) {
                    var word = parts[kk];
                    if (this.emotePattern.test(word) || this.capitalised.test(word)) {
                        cleaned.push(word);
                    } else {
                        cleaned.push(word.toLowerCase());
                    }
                }
                m = cleaned.join(' ');
            }
        }

        if (this.canProcessContent(msg)) {
            // Not room owner or moderator and not silenced so test message content against patterns

            // Special unicode blocker for cunning spammers
            for (var i = 0; i < msg.m.length; i++) {
                if (msg.m.charCodeAt(i) >= 65280 && msg.m.charCodeAt(i) <= 65519) {
                    msg['X-Spam'] = true;
                    break;
                }
            }

            var bannedWord = this.hasBannedWord(m);
            if (bannedWord) {
                msg['X-Spam'] = true;
                this.totalMessagesBlocked++;
                this.doBanOrSilence(u, bannedWord);
            }
            else {
                var bannedPhrase = this.hasBannedPhrase(m);
                if (bannedPhrase) {
                    msg['X-Spam'] = true;
                    this.totalMessagesBlocked++;
                    this.doBanOrSilence(u, bannedPhrase);
                } else {
    
                }
            }


            if (this.anonibRegex.test(u)) {
                // Auto-silencing anonib
                msg['X-Spam'] = true;
            }
        }
        else {
            //cb.log('Not checking content of message because user is a controller, or settings set to greys only or on protected list');
        }
    }


    msg.m = m;
    return msg;
}
;

helenaBot.canProcessContent = function (msg) {
    "use strict";
    if (this.canControlBot(msg) || msg.in_fanclub || helenaBot.isProtected(msg.user)) {
        // Owner, moderator or fan club or protected
        return false;
    }
    else {
        if (cb.settings.usersToProcess === 'Greys only') {
            if (msg.has_tokens || msg.tipped_recently) {
                // Blue or recently blue
                return false;
            }
            // Greys are the only ones left by this point
            return true;
        } else {
            // Everyone left
            return true;
        }
    }
};

helenaBot.protectUser = function (username) {
    "use strict";
    if (this.isProtected(username)) {
        return false;
    } else {
        this.protected[username] = 1;
        this.unSilenceUser(username);
        return true;
    }
};

helenaBot.unProtectUser = function (username) {
    "use strict";
    if (this.isProtected(username)) {
        delete this.protected[username];
        return true;
    } else {
        return false;
    }
};

helenaBot.isProtected = function (username) {
    "use strict";
    return username in helenaBot.protected;
};

helenaBot.doBanOrSilence = function (u, badThing) {
    "use strict";
    // Used a bad word or phrase
    if (cb.settings.hideOrSilence === 'Silence') {
        // cb.log("Doing silence routine");
        if (u in this.warned) {
            this.warned[u] = {'warnedScore': this.warned[u].warnedScore + 1};
        } else {
            this.warned[u] = {'warnedScore': 1};
        }
        //   cb.log("Warned: " + u + " " + this.warned[u].warnedScore + " times.");
        this.totalWarnings++;
        // Actually silence users who have been warned more than threshold
        if (this.warned[u].warnedScore > cb.settings.maxWarnings) {
            // Silence the user
            this.silenceUser(u);
            cb.chatNotice(':banned You have been silenced because you ignored the warnings and said "' + badThing + '" which is on the banned list, your messages won\'t be seen by anyone else', u, '', '#E3230C', 'bold');
            cb.chatNotice('User ' + u + ' has been silenced by the Helena-Bot', "", '', '#E3230C', 'bold');
            cb.chatNotice('Broadcaster: you can unsilence this user by typing the following:\n' + this.unsilenceCommand + ' ' + u, cb.room_slug, '', '#581845', 'bold');
        } else {
            // Actually warn the user
            var remainingWarnings = (cb.settings.maxWarnings - this.warned[u].warnedScore) + 1;
            if (remainingWarnings > 1) {
                cb.chatNotice('Your last message was rejected because you said "' + badThing + '" which is on the banned list. If you do this ' + remainingWarnings + ' more times, you will be permanently silenced and all of your messages will be rejected. :silence2 ', u, '', '#E0C21B', 'bold');
                cb.chatNotice('To see the full banned list, type /list', u, '','#C70039', 'bold');
            } else {
                cb.chatNotice('Your last message was rejected because you said "' + badThing + '" which is on the banned list. If you do this again, you will be permanently silenced and all of your messages will be rejected. :silence2 ', u, '', '#E0C21B', 'bold');
                cb.chatNotice('To see the full banned list, type /list', u, '','#C70039', 'bold');
            }

        }
    } else {
        // Just hide this message
        cb.chatNotice('Your last message was rejected because you said "' + badThing + '" which is on the banned list. :silence2 ', u, '', '#E0C21B', 'bold');
        cb.chatNotice('To see the full banned list, type /list', u, '','#C70039', 'bold');
    }
};

helenaBot.onTip = function (tip) {
    "use strict";
    var amountTipped = parseInt(tip.amount, 10);
    if (cb.settings.allowTipToUnsilence === "Yes" && this.isSilenced(tip.from_user)) {
        if (amountTipped >= cb.settings.tokensToBeUnsilenced) {
            this.unSilenceUser(tip.from_user);
            cb.chatNotice('User ' + tip.from_user + ' has been unsilenced because they tipped at least ' + cb.settings.tokensToBeUnsilenced + ' tokens',"", '', '#581845', 'bold');
        }
    }
    var i;
    cb.chatNotice('Thank you :hearts ' + tip.from_user, '', '', '#581845', 'bold' );
    for(i = 0; i < MAX_ITEMS; i++) {
        if(amountTipped == TIP_MENU_PRICE[i]) {
            cb.chatNotice(tip.from_user + ' has tipped ' + amountTipped + ' tokens for ' + TIP_MENU[i], "", '', '#581845', 'bold' );
        }    
    }
};

helenaBot.hasBannedWord = function (text) {
    "use strict";
    if (!this.haveBadWords) {
        // No banned words
        return false;
    } else {
        var match;
        while (match = this.wordPatternStart.exec(text)) {
            if (match[1] !== cb.room_slug) {
                cb.log("Matched [" + match[1] + "] on word start. Full message: [" + text + "]");
                this.wordPatternStart.lastIndex = 0;
                return match[1];
            }
        }
        while (match = this.wordPatternEnd.exec(text)) {
            if (match[2] !== cb.room_slug) {
                cb.log("Matched [" + match[2] + "] on word end. Full message: [" + text + "]");
                this.wordPatternEnd.lastIndex = 0;
                return match[2];
            }
        }
        while (match = this.wordPatternMiddle.exec(text)) {
            if (match[2] !== cb.room_slug) {
                cb.log("Matched [" + match[2] + "] on word middle. Full message: ["+text+"]");
                this.wordPatternMiddle.lastIndex = 0;
                return match[2];
            }
        }
    }
    //  cb.log("No banned words found");
    return false;
};

helenaBot.hasBannedPhrase = function (text) {
    "use strict";
    if (!this.haveBadPhrases) {
        // No banned words
        return false;
    } else {
        var match;
        while (match = this.phrasePatternStart.exec(text)) {
            if (match[1] !== cb.room_slug) {
                cb.log("Matched " + match[1] + " on phrase start");
                this.phrasePatternStart.lastIndex = 0;
                return match[1];
            }
        }
        while (match = this.phrasePatternEnd.exec(text)) {
            if (match[2] !== cb.room_slug) {
                cb.log("Matched " + match[2] + " on phrase end");
                this.phrasePatternEnd.lastIndex = 0;
                return match[2];
            }
        }
        while (match = this.phrasePatternMiddle.exec(text)) {
            if (match[2] !== cb.room_slug) {
                cb.log("Matched " + match[2] + " on phrase middle");
                this.phrasePatternMiddle.lastIndex = 0;
                return match[2];
            }
        }
    }
//    cb.log("No banned phrases found");
    return false;
};

helenaBot.hasBannedSWord = function (text) {
    "use strict";
    if (!this.haveBadSWords) {
        // No S banned words
        return false;
    } else {
        var match;
        while (match = this.SwordPatternStart.exec(text)) {
            if (match[1] !== cb.room_slug) {
                this.SwordPatternStart.lastIndex = 0;
                return match[1];
            }
        }
        while (match = this.SwordPatternEnd.exec(text)) {
            if (match[2] !== cb.room_slug) {
                this.SwordPatternEnd.lastIndex = 0;
                return match[2];
            }
        }
        while (match = this.SwordPatternMiddle.exec(text)) {
            if (match[2] !== cb.room_slug) {
                this.SwordPatternMiddle.lastIndex = 0;
                return match[2];
            }
        }
    }
    return false;
};


helenaBot.printBannedItemsMessage = function (user) {
    "use strict";
    cb.chatNotice('Banned words and phrases: ' + this.actualBanList, user, '', '#C70039', 'bold');
};

// c: message color
// m: the message text
// user: username of message sender
// f: message font
// in_fanclub: is the user in the broadcasters fan club
// has_tokens: does the user have at least 1 token
// is_mod: is the user a moderator
// tipped_recently: is the user a dark blue?
// gender: m (male), f (female), s (shemale), or c (couple)
helenaBot.usage = function (msg) {
    "use strict";
    var u = msg.user;
    cb.chatNotice(':heart7 Available commands: :heart7', u, '', '#581845', 'bold');
    cb.setTimeout(function() {
        cb.log(u);
        var msgPerms = helenaBot.msg2Perm(msg);
        for (var key in helenaBot.commands) {
            if (helenaBot.commands[key].perms & msgPerms) {
                // Command allowed for this user
                cb.chatNotice(":heart7 " +  key + helenaBot.commands[key].helpText, u , '', '#C70039', 'bold');
            }
        }
    }, 200);
};

helenaBot.silenceUser = function (username) {
    "use strict";
    if (this.isSilenced(username)) {
        return false;
    } else {
        this.silenced[username] = 1;
        return true;
    }
};

helenaBot.SsilenceUser = function (username) {
    "use strict";
    if (this.isSSilenced(username)) {
        return false;
    } else {
        this.Ssilenced[username] = 1;
        return true;
    }
};

helenaBot.unSilenceUser = function (username) {
    "use strict";
    if (this.isSilenced(username)) {
        delete this.silenced[username];
        delete this.warned[username];
        return true;
    } else {
        return false;
    }
};


helenaBot.unSsilenceUser = function (username) {
    "use strict";
    if (this.isSSilenced(username)) {
        delete this.Ssilenced[username];
        return true;
    } else {
        return false;
    }
};


helenaBot.isSilenced = function (username) {
    "use strict";
    return (username in this.silenced);
};

helenaBot.isSSilenced = function (username) {
    "use strict";
    return (username in this.Ssilenced);
};

helenaBot.canControlBot = function (msg) {
    "use strict";
    return ((msg.user === cb.room_slug) || msg.is_mod);
};

helenaBot.grabSettings = function () {
    "use strict";
    if (cb.settings.silenced) {
        var silencedSettings = cb.settings.silenced.replace(/\s+/, ",").split(',');
        for (var ii = 0; ii < silencedSettings.length; ii++) {
            this.silenced[silencedSettings[ii]] = {'u': 1};
        }
    }

    if (cb.settings.badwords) {
        var badWordsSettings = cb.settings.badwords.split(',');
        for (var ii = 0; ii < badWordsSettings.length; ii++) {
            // Trim leading and following spaces
            var clean = badWordsSettings[ii].replace(/^\s+/, "");
            clean = clean.replace(/\s+$/, "");

            // Check still something left to add!
            if (clean.length > 1) {
                if (this.phraseFinder.test(clean)) {
                    // Only add phrases which are long enough (likely to have 2 chars in each word)
                    if (clean.length > 4) {
                        this.addToActualBanList(clean, 'phrase');
                    } else {
                        cb.chatNotice("WARNING: This phrase was too short (must be at least 4 letters long), didn't add to list: " + clean, cb.room_slug, '', '#E3230C', 'bold');
                    }
                } else {
                    this.addToActualBanList(clean, 'word');
                }
            } else {
                cb.chatNotice("WARNING: This word was too short (must be at least 2 letters long), didn't add to list: " + clean, cb.room_slug, '', '#E3230C', 'bold');
            }
        }
        this.buildBanLists();
    }
    TIP_MENU = [cb.settings.tipMenuOne, cb.settings.tipMenuTwo, cb.settings.tipMenuThree, cb.settings.tipMenuFour, cb.settings.tipMenuFive, cb.settings.tipMenuSix, , cb.settings.tipMenuSeven];
    TIP_MENU_PRICE = [cb.settings.tipMenuOnePrice, cb.settings.tipMenuTwoPrice, cb.settings.tipMenuThreePrice, cb.settings.tipMenuFourPrice, cb.settings.tipMenuFivePrice, cb.settings.tipMenuSixPrice, cb.settings.tipMenuSevenPrice];
};

helenaBot.addToActualBanList = function (item, type) {
    "use strict";
    if (type === 'phrase') {
        var lengthBefore = this.actualBannedPhrases.length;
        this.actualBannedPhrases[item] = {u: 1};
        var diff = this.actualBannedPhrases.length - lengthBefore;
        if (diff > 0) {
            return true;
        }
    } else if (type === 'word') {
        var lengthBefore = this.actualBannedWords.length;
        this.actualBannedWords[item] = {u: 1};
        var diff = this.actualBannedWords.length - lengthBefore;
        if (diff > 0) {
            return true;
        }
    } else {
        cb.log("Unrecognised type [" + type + "] for item [" + item + "]");
        return false;
    }
    return false;
};

helenaBot.removeFromActualBanList = function (item, type) {
    "use strict";
    if (type === 'phrase') {
        var lengthBefore = Object.keys(this.actualBannedPhrases).length;
        delete this.actualBannedPhrases[item];
        var diff = Object.keys(this.actualBannedPhrases).length - lengthBefore;
        if (diff < 0) {
            return true;
        }
    } else if (type === 'word') {
        var lengthBefore = Object.keys(this.actualBannedWords).length;
        delete this.actualBannedWords[item];
        var diff = Object.keys(this.actualBannedWords).length - lengthBefore;
        if (diff < 0) {
            return true;
        }
    } else {
        cb.log("Unrecognised type [" + type + "] for item [" + item + "]");
        return false;
    }
    return false;
};

helenaBot.addToActualSBanList = function (item) {
    "use strict";
    var lengthBefore = this.actualBannedSWords.length;
    this.actualBannedSWords[item] = {u: 1};
    var diff = this.actualBannedSWords.length - lengthBefore;
    if (diff > 0) {
        return true;
    }
    return false;
};

helenaBot.addToActualSUserBanList = function (item) {
    "use strict";
    var lengthBefore = this.actualBannedSUsers.length;
    this.actualBannedSUsers[item] = {u: 1};
    var diff = this.actualBannedSUsers.length - lengthBefore;
    if (diff > 0) {
        return true;
    }
    return false;
};

helenaBot.buildBanLists = function () {
    "use strict";
    this.actualBanList = "";
    var maxLineLength = 60;
    var currentLineLength = 0;
    if (Object.keys(this.actualBannedWords).length > 0) {
//        cb.log("have banned words");
        this.haveBadWords = true;
        var localBadWordPattern = '(' + Object.keys(this.actualBannedWords).join('|') + ')';
//        cb.log("Builder: " + localBadWordPattern);
        this.wordPatternStart = new RegExp('^' + localBadWordPattern + '' + this.wordBoundary, 'ig');
        this.wordPatternEnd = new RegExp(this.wordBoundary + localBadWordPattern + '$', 'ig');
        this.wordPatternMiddle = new RegExp(this.wordBoundary + localBadWordPattern + this.wordBoundary, 'ig');
//        this.actualBanList += localBadWordPattern;

        for (var word in this.actualBannedWords) {
            if (currentLineLength === 0) {
                this.actualBanList += word;
                currentLineLength = word.length;
            } else if ((currentLineLength + word.length) > maxLineLength) {
                this.actualBanList += '\n' + word;
                currentLineLength = word.length;
            }
            else {
                this.actualBanList += ',' + word;
                currentLineLength += word.length;
            }
        }
    }
    if (Object.keys(this.actualBannedPhrases).length > 0) {
        this.haveBadPhrases = true;
//        cb.log("have banned phrases");
        var localBadPhrasePattern = '(' + Object.keys(this.actualBannedPhrases).join('|') + ')';
//        cb.log("Builder" + localBadPhrasePattern);
        this.phrasePatternStart = new RegExp('^' + localBadPhrasePattern + this.wordBoundary, 'ig');
        this.phrasePatternEnd = new RegExp(this.wordBoundary + localBadPhrasePattern + '$', 'ig');
        this.phrasePatternMiddle = new RegExp(this.wordBoundary + localBadPhrasePattern + this.wordBoundary, 'ig');
//        this.actualBanList += localBadPhrasePattern;
        for (var word in this.actualBannedPhrases) {
            if (currentLineLength === 0) {
                this.actualBanList += word;
                currentLineLength = word.length;
            } else if ((currentLineLength + word.length) > maxLineLength) {
                this.actualBanList += '\n' + word;
                currentLineLength = word.length;
            }
            else {
                this.actualBanList += ',' + word;
                currentLineLength += word.length;
            }
        }
    }


    if (Object.keys(this.actualBannedSWords).length > 0) {
//        cb.log("have banned words");
        this.haveBadSWords = true;
        var localBadSWordPattern = '(' + Object.keys(this.actualBannedSWords).join('|') + ')';
//        cb.log("Builder: " + localBadWordPattern);
        this.SwordPatternStart = new RegExp('^' + localBadSWordPattern + '' + this.wordBoundary, 'ig');
        this.SwordPatternEnd = new RegExp(this.wordBoundary + localBadSWordPattern + '$', 'ig');
        this.SwordPatternMiddle = new RegExp(this.wordBoundary + localBadSWordPattern + this.wordBoundary, 'ig');
//        this.actualBanList += localBadWordPattern;
    }

    if (Object.keys(this.actualBannedSUsers).length > 0) {
//        cb.log("have banned words");
        this.haveBadSUserPattern = true;
        var localBadSUserPattern = '';
        if (Object.keys(this.actualBannedSUsers).length > 1) {
            localBadSUserPattern = '(' + Object.keys(this.actualBannedSUsers).join('|') + ')';
        } else {
            localBadSUserPattern = Object.keys(this.actualBannedSUsers)[0];
        }
        this.SuserPattern = new RegExp(localBadSUserPattern, 'ig');
    }

};

helenaBot.wrapText = function (item, pre, suf) {
    "use strict";
    return pre + item + suf;
};

helenaBot.showAppAdd = function() {
    cb.chatNotice(':butterfly-valentine The Helena-Bot hides messages containing words or phrases that Helena has banned. It may also automatically silence all messages from users who repeatedly use these words.\nIf one of your messages is hidden you will be notified to help you avoid it in future. :butterfly-valentine ', '','', '#C70039', 'bold');
    helenaBot.printBannedItemsMessage();
    cb.chatNotice(':butterfly-valentine To see the available commands, type /hbhelp into the chat window :butterfly-valentine ', cb.room_slug, '', '#C70039', 'bold');
    cb.chatNotice('The Helena-Bot was written by jeffhips :catkisscat', '','', '#C70039', 'bold');
}

helenaBot.advertise = function() {
    helenaBot.showAppAdd();
    cb.setTimeout(helenaBot.advertise, parseInt(cb.settings.noticeTime) * 60000);
};

helenaBot.tipMenuAd = function() {
    tipMenuItemOne = ':heart7 ' + cb.settings.tipMenuOne + '(' + cb.settings.tipMenuOnePrice + ') :heart7';
    tipMenuItemTwo = ' :heart7 ' + cb.settings.tipMenuTwo + '(' + cb.settings.tipMenuTwoPrice + ') :heart7';
    tipMenuItemThree = ' :heart7 ' + cb.settings.tipMenuThree + '(' + cb.settings.tipMenuThreePrice + ') :heart7';
    tipMenuItemFour = ' :heart7 ' + cb.settings.tipMenuFour + '(' + cb.settings.tipMenuFourPrice + ') :heart7';
    tipMenuItemFive = ' :heart7 ' + cb.settings.tipMenuFive + '(' + cb.settings.tipMenuFivePrice + ') :heart7';
    tipMenuItemSix = ' :heart7 ' + cb.settings.tipMenuSix + '(' + cb.settings.tipMenuSixPrice + ') :heart7';
    tipMenuItemSeven = ' :heart7 ' + cb.settings.tipMenuSeven + '(' + cb.settings.tipMenuSevenPrice + ') :heart7';
    cb.chatNotice(':butterfly TIP MENU :butterfly', '', '', '#581845', 'bold');
    cb.chatNotice(tipMenuItemOne + tipMenuItemTwo + tipMenuItemThree + tipMenuItemFour + tipMenuItemFive + tipMenuItemSix + tipMenuItemSeven, '', '', '#581845', 'bold');
};

helenaBot.tipMenuAdvertise = function() {
    helenaBot.tipMenuAd();
    cb.setTimeout(helenaBot.tipMenuAdvertise, parseInt(cb.settings.tipMenuAdTime) * 60000);
};

helenaBot.init = function () {
    "use strict";
    this.grabSettings();

    this.registerCommand('/unsilence', ' <username> - Unsilence <username>', true, true, false, false, false, false, function (msg, commandParts) {
    });
    this.registerCommand('/silence', ' <username> - Silence <username> [<optional reason>]', true, true, false, false, false, false, function (msg, commandParts) {
        var u = msg.user;
        if (commandParts.length > 0) {
            var commandParam = commandParts.shift();
            if (helenaBot.silenceUser(commandParam)) {
                var reason = " probably for breaking room rules.";
                if (commandParts.length > 0) {
                    // Custom reason given
                    reason = " for reason: " + commandParts.join(' ');
                }

                cb.chatNotice('User ' + commandParam + ' has been silenced by ' + u + reason, "", '', '#E3230C', 'bold');
                cb.chatNotice('You have been silenced by ' + u + reason, commandParam, '', '#E3230C', 'bold');
                if (cb.settings.allowTipToUnsilence === "Yes") {
                    cb.chatNotice('You can tip ' + cb.settings.tokensToBeUnsilenced + ' tokens or more in one tip to become unsilenced.', commandParam, '', '#581845', 'bold');
                }
            } else {
                cb.chatNotice('User ' + commandParam + ' was already on the silence list.', u, '', '#E3230C', 'bold');
            }
        } else {
            cb.chatNotice('Invalid /silence command - you need to tell me who to silence', u, '', '#E3230C', 'bold');
        }
        return msg;
    });
    this.registerCommand('/silenceList', ' - Show list of silenced users', true, true, false, false, false, false, function (msg, commandParts) {
        var silencedPeople = Object.keys(helenaBot.silenced);
        cb.log(silencedPeople);
        if(silencedPeople.length > 0) {
            cb.chatNotice(':butterfly SILENCE LIST: ' + Object.keys(helenaBot.silenced) + " :butterfly", msg.user, '', '#E3230C', 'bold');
        } else {
            cb.chatNotice('No user has been silenced yet! Everything\'s been okay so far!', msg.user, '', '#0FC600', 'bold')
        }
        return msg;
    });
//    this.registerCommand('/silenceMany', 'Silence many', true, true, false, false, false, false, function (msg, commandParts) {
//    });
    this.registerCommand('/hbstats', ' - Show stats on total messages blocked, users silenced etc.', true, true, false, false, false, false, function (msg, commandParts) {
        var u = msg.user;
        cb.chatNotice(':butterfly Helena-Bot Stats :butterfly ', u, '', '#FA064C', 'bold');
        cb.setTimeout(function() {
            cb.chatNotice(':butterfly Messages blocked: ' + helenaBot.totalMessagesBlocked + " :butterfly", u, '', '#FA064C', 'bold');
            if (cb.settings.hideOrSilence === 'Silence') {
                cb.chatNotice(':butterfly Warnings issued: ' + helenaBot.totalWarnings + " :butterfly", u, '', '#FA064C', 'bold');
                cb.chatNotice(':butterfly Users silenced: ' + helenaBot.totalSilenced + " :butterfly", u, '', '#FA064C', 'bold');
            }
            return msg;
        }, 100);
    });
    this.registerCommand('/addWord', ' <word/phrase> - Add word or phrase to banned list for this session only', true, true, false, false, false, false, function (msg, commandParts) {
    });
    this.registerCommand('/addManyWords', ' <words separated by spaces> - Add many words at once', true, true, false, false, false, false, function (msg, commandParts) {
    });
    this.registerCommand('/deleteWord', ' <word/phrase> - Delete word or phrase from banned list for this session only', true, true, false, false, false, false, function (msg, commandParts) {
    });
    this.registerCommand('/changeMode', ' <hide|silence> - Change to hide or silence mode', true, true, false, false, false, false, function (msg, commandParts) {
    });
    this.registerCommand('/protectUser', ' <username> - Protect <username> (they won\'t be moderated by the bot, automatically unsilences them)', true, true, false, false, false, false, function (msg, commandParts) {
    });
    this.registerCommand('/unprotectUser', ' <username> - Unprotect <username> (they will be moderated by the bot again)', true, true, false, false, false, false, function (msg, commandParts) {
    });
    this.registerCommand('/protectList', ' - Show list of protected users', true, true, false, false, false, false, function (msg, commandParts) {
        var protectedPeople = Object.keys(helenaBot.protected);
        if(protectedPeople.length > 0) {
            cb.chatNotice(':butterfly PROTECT LIST ' + Object.keys(helenaBot.protected) + ":butterfly", msg.user, '', '#E3230C', 'bold');
        } else {
            cb.chatNotice(':butterfly You haven\'t protected anyone today! :butterfly', msg.user, '', '#C70039', 'bold');
        }
        return msg;
    });
    this.registerCommand('/hbhelp', ' - Show this help message', true, true, true, true, true, true, function (msg, commandParts) {
        helenaBot.usage(msg);
        return msg;
    });
    this.registerCommand('/list', ' - Print list of current banned words', true, true, true, true, true, true, function (msg, commandParts) {
        helenaBot.printBannedItemsMessage(msg.user);
        return msg;

    });
    helenaBot.advertise();
    helenaBot.tipMenuAdvertise();
};

helenaBot.init();