Chaturbate

Bots Home | Create an App
Welcome Message Plus
Author: harry241
You are viewing version 114635. There is a newer version of this app. See the latest version of this app.

Description Source Code Launch Bot Current Users
Created by: Harry241
There are 56 other versions of this script.
/**
 * Welcome Message Plus Bot
 *
 * Author: Harry241
 * Version: 1.0
 *
 * ToDo:
 * - exclude Model from userArray
 */


/* Bot Variables */
var botTitle = 'Welcome Message Plus by Harry241';
var botStartDate = new Date();
var userArray = [];
var userJoined = 0;
var quietUsers = false;
var quietUserTimer = false;
var quietUserCount = 0;
var quietUsersNotified = 0;

var noticeTextColor = '';
var noticeBGColor = '#A0522D';
var cmdTextColor = '#5F9EA0';
var cmdBGColor = '#F5DEB3';

var shy = '\u00ad'; // soft hyphen, &shy;

/* Chaturbate settings */
cb.settings_choices = [
	{	name: 'notifyArrDep',
		label: 'Do you want to be notified when a user enters or leaves?',
		type: 'choice',
		choice1:'Yes',
		choice2:'No',
		defaultValue: 'Yes'
	},
	{	name: 'alWelcomeMsg',
		label: 'This welcome message will be sent to all users',
		type: 'str',
		minLength: 0,
		maxLength: 255,
		required: false,
		defaultValue: ''
	},
	{	name: 'grWelcomeMsg',
		label: 'This welcome message will be sent to greys only',
		type: 'str',
		minLength: 0,
		maxLength: 255,
		required: false,
		defaultValue: ''
	},
	{	name: 'lbWelcomeMsg',
		label: 'This welcome message will be sent to light blues only',
		type: 'str',
		minLength: 0,
		maxLength: 255,
		required: false,
		defaultValue: ''
	},
	{	name: 'dbWelcomeMsg',
		label: 'This welcome message will be sent to dark blues only',
		type: 'str',
		minLength: 0,
		maxLength: 255,
		required: false,
		defaultValue: ''
	},
	{	name: 'quietNotice',
		label: 'Do you want to send a message to users that are quiet?',
		type: 'choice',
		choice1:'Yes',
		choice2:'No',
		defaultValue: 'Yes'
	},
	{	name: 'quietMinutes',
		label: 'After how many minutes should the message be sent',
		type: 'int',
		minValue: 5,
		maxValue: 45,
		required: false,
		defaultValue: 15
	},
	{	name: 'quietMsgAll',
		label: 'This message will be sent to all quiet users',
		type: 'str',
		minLength: 0,
		maxLength: 255,
		required: false,
		defaultValue: 'Psst..'
	},
	{	name: 'quietMsgGrey',
		label: 'This message will be sent to greys who are quiet',
		type: 'str',
		minLength: 0,
		maxLength: 255,
		required: false,
		defaultValue: ''
	},
	{	name: 'quietMsgLBlue',
		label: 'This message will be sent to light blues who are quiet',
		type: 'str',
		minLength: 0,
		maxLength: 255,
		required: false,
		defaultValue: ''
	},
	{	name: 'quietMsgDBlue',
		label: 'This message will be sent to dark blues who are quiet',
		type: 'str',
		minLength: 0,
		maxLength: 255,
		required: false,
		defaultValue: ''
	}
];


cb.onMessage(function(msg) {
  if (msg['user'] == cb.room_slug) {
    if (msg['m'].search(/^ *!(\S+) *.*$/) > -1) {
      
      cb.log('Model is using a !command');
      
      var p = msg['m'].match(/^ *!(\S+) *(\S+)? *(.*)?$/);
      
      cb.log(p);
      
      switch (p[1]) {
        case 'stats':
          showStats();
          break;
        case 'quiets':
          showQuiets();
          break;
        case 'msg':
          var valid_to = Array('mods','fans','blues','quiets');
          var to_grp = Array('red','green','blues','quiets');
          var to = '';
          
          if (valid_to.indexOf(p[2]) > -1) {
            to = to_grp[valid_to.indexOf(p[2])];
            
            if (!(p[3] == null)) {
            
              cb.log('<' + to + '> : "' + p[3] + '"');
              
              //
              switch (to) {
                case 'blues':
                  cb.sendNotice(p[3],'',noticeBGColor,noticeTextColor,'','blue');
                  cb.sendNotice(p[3],'',noticeBGColor,noticeTextColor,'','cyan');
                  break;
                case 'quiets':
                  
                  // TODO!
                  
                  break;
                default:
                  cb.sendNotice(p[3],'',noticeBGColor,noticeTextColor,'',to);
                  break;
              }
            } else {
              
              cb.log('No message given.');
            }
          } else {
            cb.log('Invalid group specified.');
          }
          
          // sendMsgNotice(p[2],[p3]);
          
          break;
        default:
          cb.log('Invalid command.');
          break;
      }

      msg['X-Spam'] = true;
      msg['background'] = cmdBGColor;
      msg['color'] = cmdTextColor;
    }
  }
  
  if (isUser(msg['user'])) {
    if (userArray[msg['user']].quiet) {
     
      cb.log(msg['user'] + ' is no longer quiet');
    
      userArray[msg['user']].quiet = false;
      quietUserCount--;
    }
  } else {
    
    cb.log('unknown user ' + msg['user'] + ' has spoken');
    
    addUser(msg,true);
  }
});

cb.onTip(function (tip) {
  if (isUser(tip['from_user'])) {
    if (userArray[tip['from_user']].quiet) {
     
      cb.log(tip['from_user'] + ' is no longer quiet (tipped)');
    
      userArray[tip['from_user']].quiet = false;
      quietUserCount--;
    }
  } else {
    
    cb.log('unknown user ' + tip['from_user'] + ' has tipped');
    
    var user = Array();
    user['user'] = tip['from_user'];
    user['is_mod'] = tip['from_user_is_mod'];
    user['has_tokens'] = tip['from_user_has_tokens'];
    user['tipped_recently'] = tip['from_user_tipped_recently'];
  
    addUser(user,true);
  }
});

cb.onEnter(function(user) {
  cb.log('user joined: ' + user['user']);

  if (cb.settings.notifyArrDep == 'Yes') {
    var str = '';
  
    str = (user['is_mod'])?'Moderator':(user['is_fan'])?'Fan':'User';
    str+= ' ' + user['user'] + ' just ' + (isUser(user['user'])?'returned':'arrived');
    str+= ' (' + ((user['gender']=='m')?'Male':(user['gender']=='f')?'Female':(user['gender']=='s')?'Shemale':'Couple');
    str+= ', ' + ((user['tipped_recently'])?'Dark Blue':((user['has_tokens'])?'Light Blue':'Grey')) + ')';
    
    cb.sendNotice(str,cb.room_slug,noticeBGColor,noticeTextColor);
  }
  
  sendWelcomeNotice(user);
  
  addUser(user,false);
});

cb.onLeave(function(user) {
  cb.log('user left: ' + user['user']);
  
  if (cb.settings.notifyArrDep == 'Yes') {
    
    if (isUser(user['user'])) {
      var t = new Date() - userArray[user['user']].login;
      var l = msecToTime(t);

      cb.log('time (s): ' + (t/1000));
    
      cb.sendNotice('User ' + user['user'] + ' just left after ' + l + '.',cb.room_slug,noticeBGColor,noticeTextColor);
    } else {
      
      cb.log('unknown user just left: ' + user['user']);
      
      cb.sendNotice('User ' + user['user'] + ' just left (unknown)',cb.room_slug,noticeBGColor,noticeTextColor);
    }
  }
  
  removeUser(user);
});


function showStats() {
  var stats = botTitle
  	+ '\nThis bot has been running for ' + msecToTime(new Date()-botStartDate)
  	+ '\n' + userJoined + ' user(s) '+ ((userJoined==1)?'has':'have') + ' joined since this bot started'
  	+ '\nThere '+ ((quietUserCount==1)?'is ':'are ') + quietUserCount + ' quiet user(s)'
  	+ '\nA notice has been sent to ' + quietUsersNotified + ' user(s)';
  
  cb.sendNotice(stats,cb.room_slug,noticeBGColor,noticeTextColor);
}

function showQuiets() {

  cb.log('quietUsers = ' + quietUsers + ' | quietUserCount = ' + quietUserCount);

  var usr,min,cnt=0,str='';
  // loop through the users that are logged in
  for (usr in userArray) {
    // if the user has been quiet so far
    if (userArray[usr].quiet && (userArray[usr].logout=='')) {
      // keep track of the number of quiet users
      cnt++;
      // set the number of minutes since this user logged in
      min = Math.ceil((new Date() - userArray[usr].login) / (1000*60));
      
      //
      str += usr + ' (' + min + 'm), ';
    }
  }
    
  cb.log(cnt + ' quiet user(s) in total');
  
  if (cnt>0) {
    str = 'The following users are quiet:\n' + str.substr(0,str.length-2);
    
    cb.sendNotice(str,cb.room_slug,noticeBGColor,noticeTextColor);
  } else {
    
    cb.sendNotice('There are no quiet users.',cb.room_slug,noticeBGColor,noticeTextColor);
  }
}

function msgQuiets() {

  cb.log('quietUsers = ' + quietUsers + ' | quietUserCount = ' + quietUserCount);

}

function sendMsgNotice(to,msg) {
  
  cb.log('send message to ' + to + ': "' + msg + '"');
  
}

function msecToTime(ms) {
  var s = Math.ceil(ms/1000);
  var m = Math.floor(s/60);
  s = s-m*60;
  var h = Math.floor(m/60);
  m = m-h*60;

  return ((h>0)?h+' hour'+((h>1)?'s':''):'')
  	+ ((m>0)?((h>0)?', ':'')+m+' minute'+((m>1)?'s':''):'')
  	+ ((s>0)?((m>0)?', ':'')+s+' second'+((s>1)?'s':''):'');
}

function sendWelcomeNotice(user) {
 var str = '';
 
 if (cb.settings.alWelcomeMsg != '') { str = cb.settings.alWelcomeMsg.replace(/USERNAME/g,user['user']); }

 if (user['tipped_recently']) {
   if (cb.settings.dbWelcomeMsg != '') { str+= ((str!='')?'\n':'') + cb.settings.dbWelcomeMsg.replace(/USERNAME/g,user['user']); }
 } else if (user['has_tokens']) {
   if (cb.settings.lbWelcomeMsg != '') { str+= ((str!='')?'\n':'') + cb.settings.lbWelcomeMsg.replace(/USERNAME/g,user['user']); }
 } else  {
   if (cb.settings.grWelcomeMsg != '') { str+= ((str!='')?'\n':'') + cb.settings.grWelcomeMsg.replace(/USERNAME/g,user['user']); }
 }
 
 cb.sendNotice(str,user['user'],noticeBGColor,noticeTextColor,'bold');
}

function sendQuietNotice(usr) {
 var str = '';
 
 if (cb.settings.quietMsgAll != '') { str = cb.settings.quietMsgAll.replace(/USERNAME/g,usr); }

 if (userArray[usr].tipped_recently) {
   if (cb.settings.quietMsgDBlue != '') { str+= ((str!='')?'\n':'') + cb.settings.quietMsgDBlue.replace(/USERNAME/g,usr); }
 } else if (userArray[usr].has_tokens) {
   if (cb.settings.quietMsgLBlue != '') { str+= ((str!='')?'\n':'') + cb.settings.quietMsgLBlue.replace(/USERNAME/g,usr); }
 } else  {
   if (cb.settings.quietMsgGrey != '') { str+= ((str!='')?'\n':'') + cb.settings.quietMsgGrey.replace(/USERNAME/g,usr); }
 }
 
 cb.sendNotice(str,usr,noticeBGColor,noticeTextColor);
 
 quietUsersNotified++;
}

function isUser(username) {
  return (username in userArray);
}

function addUser(user,late) {
  var n = true;
  if (user['is_mod']) { n = false; }
  
  if (isUser(user['user'])) {
    userArray[user['user']].login = new Date();
    userArray[user['user']].logout = '';
    userArray[user['user']].notice = n;
  } else {
    userArray[user['user']] = {'notice': n, 'quiet': true, 'tipped_recently': user['tipped_recently'], 'has_tokens': user['has_tokens'], 'login': new Date(), 'logout': ''};
    
    if (late) {
      userArray[user['user']].quiet = false;
      userArray[user['user']].login = '';
    } else {
      userJoined++;
    }
  }
  
  if (userArray[user['user']].quiet) {
    quietUserAdd();
  }
}

function removeUser(user) {
  if (isUser(user['user'])) {
    if (userArray[user['user']].quiet) {
      quietUserCount--;
    }
    
    // remove the user object from the userArray
    userArray[user['user']].notice = false;
    userArray[user['user']].logout = new Date();
  }
}

function quietUserAdd() {
  quietUsers = true;
  // if the quiet notice is active
  if (cb.settings.quietNotice=='Yes') {
    // increase the number of quiet users
    quietUserCount++
    // if the timer is not active
    if (!quietUserTimer) {
      
      cb.log('starting quiet timer');
      
      // set the timeout to 2 minutes
      cb.setTimeout(quietUserTimeout,2*60*1000);
      quietUserTimer = true;
    }
  }
}

function quietUserTimeout() {
  // if there are quiet users
  if (quietUsers) {

    var usr,min,cnt=0;
    // loop through the users that are logged in
    for (usr in userArray) {
      // if the user has been quiet so far and a notice needs to be sent
      if (userArray[usr].quiet && userArray[usr].notice) {
        // keep track of the number of quiet users that havent received a notice
        cnt++;
        // set the number of minutes since this user logged in
        min = Math.ceil((new Date() - userArray[usr].login) / (1000*60));
        
        if (min >= cb.settings.quietMinutes) {
        
          // send a notice to the user
          sendQuietNotice(usr);
          userArray[usr].notice = false;
          
          cb.log('quiet notice sent to ' + usr);
          
          // keep track of the number of quiet users that havent received a notice
          cnt--;
        }
      }
    }

    // if there are still quiet users left that havent received a notice
    if (cnt>0) {

      cb.log('starting quiet timer');
      
      cb.setTimeout(quietUserTimeout,2*60*1000);
      
    } else {
      
      cb.log('stopping quiet timer');
      
      quietUsers = false;
      quietUserTimer = false;
    }
  }
}

function onLoad() {
  var str = botTitle
  	+ '\nuse "!stats" for statistics'
  	+ '\nuse "!quiets" for a list of quiet users'
  	+ '\nuse "!msg <group> <message>" to send a notice to a group of users (mods,fans,blues,quiets)';
  
  cb.sendNotice(str,cb.room_slug,noticeBGColor,noticeTextColor);
}

onLoad();