Chaturbate

Bots Home | Create an App
Dulcey_John
Author: dulceys
You are viewing version 866998. There is a newer version of this app. See the latest version of this app.

Description Source Code Launch Bot Current Users
Created by: Dulceys
There are 2 other versions of this script.
// Top Tippers Today
// Author: asdfghjkl28

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 topn = {

        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 {
                    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;
        },

        name: "Top tippers today bot",

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

// Data structures for tippers and settings
        tippers: {},

        numberToShow: 3,
        interval: 5 * 60000,

        topNTippers: [],
        topNString: 'No tippers yet',
        topNCurrentCount: 0,
        changeThreshold: 0,
        lastNotice: new Date().getTime()

    }
    ;

// CB app settings
cb.settings_choices = [
    {name: 'nShow', label: 'Number of top tippers to show', type: 'int', minValue: 1, maxValue: 10, defaultValue: 3, required: true},
    {name: 'timer', label: 'Interval between displaying top tippers (minutes)', type: 'int', minValue: 1, defaultValue: 5, required: false}

];


// 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 topn.onMessage(msg);
});

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

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

// Main on message callback function
topn.onMessage = function (msg) {
    "use strict";

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

    return msg;
}
;

topn.onTip = function (tip) {
    "use strict";
    var amountTipped = parseInt(tip.amount, 10);

    var username = tip.from_user;

    if (!topn.tippers[username]) {
        topn.tippers[username] = {name: username, tips: 0, hightip: 0};
    }

    if (!topn.tippers[username].tips) {
        topn.tippers[username].tips = 0;
    }
    if (!topn.tippers[username].hightip) {
        topn.tippers[username].hightip = 0;
    }

    topn.tippers[username].tips += amountTipped;
    topn.tippers[username].tiptime = new Date().getTime();

    if (topn.tippers[username].tips > topn.changeThreshold) {
        topn.checkHighTippers();
    }
};

topn.checkHighTippers = function () {
    var ij = 0;
    var newHighTippers = objectToArray(topn.tippers);

//    newHighTippers.sort(dynamicSort('-tips'));
    newHighTippers.sort(dynamicSortMultiple('-tips','tiptime'));

    var topN = newHighTippers.slice(0, topn.numberToShow);

    topn.topNCurrentCount = topN.length;

    if (topn.topNCurrentCount == topn.numberToShow) {
        cb.log("ChangeThreshold changed: " + topn.changeThreshold);
        topn.changeThreshold = topN[topN.length - 1].tips;
    }

//    var top3Strings = [];
//    for (ij = 0; ij < topN.length; ij++) {
//        top3Strings[ij] = topN[ij].name + ": " + topN[ij].tips;
//    }

    topn.topNString = '';
    for (ij = 0; ij < topN.length; ij++) {
        topn.topNString += "\n" + topN[ij].name + ": " + topN[ij].tips;
    }
    topn.showTopTippers();
};

topn.showTopTippers = function () {
    if (topn.topNCurrentCount > 0) {
        cb.chatNotice('Top ' + topn.numberToShow + ' tippers this session:' + topn.topNString);
        topn.lastNotice = new Date().getTime();
    }
};

topn.intervalPrinter = function () {
    var now = new Date().getTime();
    var gap = now - topn.lastNotice;

    if (gap >= topn.interval) {
        // Last time we showed the list was more than the interval ago
        topn.showTopTippers();
        cb.setTimeout(topn.intervalPrinter, topn.interval);
    } else {
        // Last time was more recent than the interval, so set new timer for the remaining time
        cb.setTimeout(topn.intervalPrinter, topn.interval - gap);
    }
};


// 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)
topn.usage = function (msg) {
    "use strict";
    var u = msg.user;
    cb.chatNotice('Available commands:', u);

    var msgPerms = topn.msg2Perm(msg);

    for (var key in topn.commands) {
        if (topn.commands[key].perms & msgPerms) {
            // Command allowed for this user
            cb.chatNotice(key + topn.commands[key].helpText, u);
        }
    }
};

topn.grabSettings = function () {
    "use strict";
    if (cb.settings.timer) {
        topn.interval = cb.settings.timer * 60000;
    }
    if (cb.settings.nShow) {
        topn.numberToShow = cb.settings.nShow;
    }
};

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

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

    this.registerCommand('/ttthelp', ' - show this help message', true, true, true, true, true, true, function (msg, commandParts) {
        topn.usage(msg);
        return msg;
    });
//    this.registerCommand('/ttlist', ' - print list of all tippers', true, true, true, true, true, true, function (msg, commandParts) {
//        topn.printBannedItemsMessage(msg.user);
//        return msg;
//
//    });

    cb.chatNotice('The ' + topn.name + ' tracks all of today\'s tippers and lists the top ' + topn.numberToShow);
    cb.chatNotice('To see the available commands, type /ttthelp into the chat window', cb.room_slug);
    cb.chatNotice('The ' + topn.name + ' was written by asdfghjkl28. If you like the bot, you can thank him by tipping your favourite model.');

    cb.setTimeout(topn.intervalPrinter, topn.interval);

};

topn.init();


// Start Helper functions section
function dynamicSort(property) {
    var sortOrder = 1;
    if (property[0] === "-") {
        sortOrder = -1;
        property = property.substr(1, property.length - 1);
    }
    var sortfunc = function (a, b) {
        if (typeof a[property] === "undefined") {
            if (typeof b[property] === "undefined") {
                // both undef
                return 0;
            } else {
                // b ok, a undef
                return -1;
            }
        }
        if (typeof b[property] === "undefined") {
            if (typeof a[property] === "undefined") {
                // both undef
                return 0;
            } else {
                // a ok, b undef
                return 1;
            }
        }

        var result = (a[property] < b[property]) ? -1 : (a[property] > b[property]) ? 1 : 0;
        return result * sortOrder;
    };
    return sortfunc;
}

function dynamicSortMultiple() {
    /*
     * save the arguments object as it will be overwritten
     * note that arguments object is an array-like object
     * consisting of the names of the properties to sort by
     */
    var props = arguments;
    return function (obj1, obj2) {
        var i = 0, result = 0, numberOfProperties = props.length;
        /* try getting a different result from 0 (equal)
         * as long as we have extra properties to compare
         */
        while(result === 0 && i < numberOfProperties) {
            result = dynamicSort(props[i])(obj1, obj2);
            i++;
        }
        return result;
    }
}

function objectToArray(myObj) {
    var arr = [];
    for (var i in myObj) {
        if (myObj.hasOwnProperty(i)) {
            arr.push(myObj[i]);
        }
    }
    return arr;
}
/*********************************************

<b><u>Tippers Leaderboard</u></b>

<p>Keeps track of all tips and shows a leaderboard of all tippers for the current session. The top 3 can be printed on a fixed interval, after each tip, or when the top 3 has changed.
</p><p>Users can view the full leaderboard using the "!lb" command.</p>
<p><u>These are the settings:</u>
</p><p><b>Print top 3 after tips</b>
</p><p>Whether to print the leaderboard after tips. Choices are:
</p><ul><li><b>always</b>: always print the leaderboard top 3 after tips have been received
<li><b>only if the top 3 changed</b>: only print the top 3 after receiving tips if there has been a change
<li><b>never</b>: don't print the top 3 after tips have been received
</ul><p><b>Print top 3 at least once every (minutes, 0 to disable)</b>
</p><p>Time (in minutes) to automatically print the top 3 if no tips were received that caused the leaderboard to be printed in that time (based on the previous setting).
</p><p>Setting this value to 0 disables this feature.
</p><p><b>Highlight tip leader in chat</b>
</p><p>Set to 'yes' to highlight the current leader.</p>
</p><p><b>Remind tippers who tipped 25 tokens to rate</b>
</p><p>When set to 'yes' any tipper who has tipped 25 tokens or more during this session is asked to rate.</p>

Version history:

3 Aug 2013: v1.0; initial release
3 Aug 2013: v1.1; sorting fixed, added option to run as both an App and Bot
23 Aug 2013: v1.2; more compact notice output, only sending !lb output to requesting user
28 Aug 2013: v1.2.1; only match !lb at the beginning of the input, don't process !lb if it was already handled
28 Dec 2013; v1.3; delay printing of leaderboard until tipping has stopped, only print top 3 if it has changed
30 Dec 2013; v1.4; added settings
31 Dec 2013; v1.4.1; code cleanup
13 Jul 2014; v1.5; added option to ask tippers who tipped over 25 tokens to rate

*********************************************/

var VERSION = '1.5',
    COMMAND_SHOW_LEADERBOARD = '!lb',
    CONFIG_COLOR_LEADER = '#9f9',
    INTERVAL_MULTIPLIER = 60000,
    UPDATE_TIME = 5000,
    RATE_FROM = 25,
    RATE_MESSAGE = ":rate-me",
    RATE_MESSAGE_DELAY = 1500,
    NL = '\n',
    user_total_tips = {},
    user_last_tip_time = {},
    last_top3 = '',
    leader_username,
    update_counter = 0,
    interval_counter = 0,
    silent_room = true;

// settings
cb.settings_choices = [{
    name: 'print_on_tip',
    type: 'choice',
    choice1: 'always',
    choice2: 'only if the top 3 changed',
    choice3: 'never',
    defaultValue: 'only if the top 3 changed',
    label: "Print top 3 after tips"
}, {
    name: 'print_interval',
    type: 'int',
    minValue: 0,
    defaultValue: 10,
    label: "Print top 3 at least once every (minutes, 0 to disable)",
    required: true
}, {
    name: 'highlight',
    type: 'choice',
    choice1: 'yes',
    choice2: 'no',
    defaultValue: 'no',
    label: "Highlight tip leader in chat"
}, {
    name: 'rate',
    type: 'choice',
    choice1: 'yes',
    choice2: 'no',
    defaultValue: 'yes',
    label: "Remind tippers who tipped 25 tokens to rate"
}];

// handlers
cb.onTip(function (tip) {
    handleTip(tip.amount, tip.from_user);
    scheduleUpdate();

    silent_room = false;
});

cb.onMessage(function (msg) {
	// handle user commands
	if ((msg.m.indexOf(COMMAND_SHOW_LEADERBOARD) == 0) && !msg['X-Spam']) {
        sendLeaderboard(true, msg.user);
        msg['X-Spam'] = true;
	}

    // highlight leader
	if ((cb.settings.highlight == 'yes') && (msg.user == leader_username))  {
		msg.background = CONFIG_COLOR_LEADER;
	}

    // schedule interval
    if (update_counter == 0){
        scheduleInterval();
    }

    if (!msg['X-Spam']){
        silent_room = false;
    }

	return msg;
});

// functions
function handleTip(amount, user) {
    if (amount <= 0) return;

    var before = user_total_tips[user] || 0,
        after = user_total_tips[user] = before + amount;

    user_last_tip_time[user] = new Date().valueOf();

    if ((before < RATE_FROM) && (after >= RATE_FROM)){
        cb.setTimeout(function(){
            cb.chatNotice(RATE_MESSAGE, user);
        }, RATE_MESSAGE_DELAY);
    }
}

function sortLeaderboard(){
    var lb = [];

    for (var user in user_total_tips) {
        if (user_total_tips.hasOwnProperty(user)){
            lb.push([user_total_tips[user], -user_last_tip_time[user], user]);
        }
    }

    if (lb.length > 0){
        lb.sort(function(a, b){
            for (var i=0; i < a.length; i++){
                if (a[i] < b[i]){
                    return 1;
                }
                if (a[i] > b[i]){
                    return -1;
                }
            }
            return 0;
        });
        leader_username = lb[0][2];
    }

    return lb;
}

function formatRanking(leaderboard, rank){
    if (rank < leaderboard.length) {
        var p = leaderboard[rank];
        return p[2] + ' (' + p[0] + ' token' + (p[0]!=1 ? 's' : '') + ')';
    }
    else {
        return '--';
    }
}

function getTop3(leaderboard){
    var rank, result='';
    for (rank=0; rank<3; rank++){
        if (rank>0){
            result += '|';
        }
        if (rank < leaderboard.length){
            result += leaderboard[rank][2];
        }
    }
    return result;
}

function sendLeaderboard(force, to_user) {
	var lb = sortLeaderboard(),
        l = to_user ? lb.length : 3,
        out = 'Tippers leaderboard';

    if (!force) {
        var top3 = getTop3(lb);
        if (top3 == last_top3){
            return;
        }
        last_top3 = top3;
    }

    if (l<3) { l=3; }

    if (l < lb.length) {
        out += ' top 3 (Type !lb to see the full leaderboard)';
    }
    if (to_user){
        out += ' [v' + VERSION+']';
    }

    for (var rank=0; rank<l; rank++) {
        out += NL + '' + (rank+1) + '. ' + formatRanking(lb, rank);
    }

	cb.chatNotice(out, to_user);

    if (!to_user){
        scheduleInterval();
    }
}

function scheduleUpdate(){
    var print_on_tip = cb.settings.print_on_tip;

    if (print_on_tip != 'never') {
        var counter = ++update_counter;

        cb.setTimeout(function(){
            if (update_counter == counter){
                sendLeaderboard(print_on_tip == 'always');
            }
        }, UPDATE_TIME);
    }
}

function scheduleInterval(){
    var interval = cb.settings.print_interval;

    if (interval > 0) {
        var counter = ++interval_counter;

        cb.setTimeout(function(){
            if (interval_counter == counter){
                sendLeaderboard(!silent_room);
            }
        }, interval*INTERVAL_MULTIPLIER);

        silent_room = true;
    }
}

function init(){

}