Chaturbate

Bots Home | Create an App
Luckys Helper Bot - User Filter+
Author: lucky_larry
You are viewing version 1342842. There is a newer version of this app. See the latest version of this app.

Description Source Code Launch Bot Current Users
There are 19 other versions of this script.
//Lucky_Larry User-Filter-Chat bot Version 20210927

var botVersion = 'Luckys User-Filter Bot Version R4';

//R4-Implements user-count system and alerts Broadcaster if a new viewer is Female
  //and implements a quick way to silence their chat to anyone but the Broadcaster
//R3 adding Broadcaster Messages
//R2 adding code to get number of followers
//R1 Initial main purpose is to allow a broadcaster to specify a part of a username and 
  //then any username that contains that part will be unable to send messages into the chat.

//Seems this global declaration is not creating anything
//var uname_parts;

//To hold broadcaster's name
var bname;

//Do we show blocked messages to Broadcaster & bot-Admins?
var showBlkdMsgs = true;

//To hold a count of users in the room as well as index the room visitors array for easy access to users later
var userIndex;
const userArray = [];
const userSilencedArray = [];

//For font weight of messages
var msgBCWeight = 'bolder';
var msgAllWeight = 'bolder';

//To hold Motivational Message current index and timeout values in milliseconds
var motvNextMessage = -1;
var motvMsgInterval = -1;
var motvMsgDefaultInterval = 660000; //11 Minutes by default
var motvMsgCount = -1;
var motvMsgArray;

//***************************************************************************************
//******************  ARRAY TO STRING ***************************************************
function arrayToString(x,maxLength=255) {
//Function to take an array and build a string with it up to the maxLength

  sendBroadcasterMsg('Users array has length of [' + x.length + ']');

  var xOut = 'Start:[';
  
  for (let i = 0; i<x.length; i++) {
    sendBroadcasterMsg('Processing array element [' + i + '] which has a value of [' + x[i] + '] and length of [' + x[i].length + ']');
    if (xOut.length + x[i].length + 1 > maxLength) {return xOut + ']';}
    xOut = xOut + x[i] + ';';
  }
  return xOut + ']';
}  //End arrayToString

//***************************************************************************************
//******************  OUTPUT ARRAY ******************************************************
function outputArray(x,reqBy = 'BC') {
// Send a message to broadcaster for each element in the Array
  for (let i = 0; i<x.length; i++) {
    sendBroadcasterMsg('Processing array element [' + i + '] which has a value of [' + x[i] + '] and length of [' + x[i].length + ']',false,reqBy);
  }
}  //End outputArray

//***************************************************************************************
//******************  GET CURRENT TIME **************************************************
function getCurrentTime() {
  let d = new Date();
  let timeValue = d.getTime();
  timeValue = timeValue / 1000;
  return timeValue; 
}  //End getCurrentTime

//***************************************************************************************
//******************  SEND BROADCASTER MESSAGE ******************************************
function sendBroadcasterMsg(msgForBroadcaster,showTime = false,reqBy = 'BC',copyLarry = true) {
  let message = msgForBroadcaster;
  if (showTime == true) {
    message = getCurrentTime() + ' ' + message;
  }
  if (reqBy == 'BC' || reqBy == bname) {cb.sendNotice(message,bname,'','',msgBCWeight);}
  if (copyLarry == true || reqBy == 'lucky_larry') {cb.sendNotice(message,'lucky_larry','','',msgBCWeight);}
}  //End sendBroadcasterMsg

//***************************************************************************************
//******************  SEND UNAME SPLIT ***********************************************
function send_uname_split(uname_split) {
  //Loop through all username parts to send a message to lucky_larry that it is being monitored for
        
  for (let i=0; i<uname_split.length; i++) {

    cb.sendNotice('Monitoring for Username part [' + uname_split[i] + ']','lucky_larry');

    cb.sendNotice('Monitoring for Username part [' + uname_split[i] + ']',bname);
    
  }
  return true;
} //End function send_uname_split

//***************************************************************************************
//******************  NEXT MOTIVATION MESSAGE *******************************************
function nextMotivMsg() {
//Send the next motivational method and start a new timer for calling this function again to send the next one
    
    //Check the One-Based Motivational Message Next-Message value and if greater than the number of messages reset to zero.
    if (motvNextMessage > motvMsgCount - 1) {
      motvNextMessage = 1;
    } else {
      motvNextMessage++;
    }
    
    //Send the motivational message for the current value of motvNextMessage index
    sendBroadcasterMsg(motvMsgArray[motvNextMessage]);
    
    //This was for building and troubleshooting:
    //sendBroadcasterMsg('Motivational Index = [' + motvNextMessage + '] and Message: [' + motvMsgArray[motvNextMessage] + ']',true);
    
    cb.setTimeout(nextMotivMsg, motvMsgInterval);
}  //End nextMotivMsg

//***************************************************************************************
//******************  SETUP MOTIVATION MESSAGES *****************************************
function setupMotivationalMessages() {
//Combine the Motivational Messages set by the broadcaster into an array and create timers for each based on the motvInterval setting also set by the Broadcaster.  Array will be 1-based.  Setting the "0" element of the array to a value we will never reference to hold he Zeroth place.
  
  //Set the motivational message interval x 1,000 of value user put in for minutes since it is expressed in Milliseconds.
  if(cb.settings.motvInterval <= 0) {
    motvMsgInterval = motvMsgDefaultInterval;
  } else {
    motvMsgInterval = cb.settings.motvInterval * 60000; //60,000 Milliseconds is one minute
  }
  
  //Set the motvMsgArray equal to all the different Broadcaster specified messages
  motvMsgArray = ['Ignore Zeroth',cb.settings.motvMsg1,cb.settings.motvMsg2,cb.settings.motvMsg3,
    cb.settings.motvMsg4,cb.settings.motvMsg5,cb.settings.motvMsg6,cb.settings.motvMsg7,
    cb.settings.motvMsg8,cb.settings.motvMsg9,cb.settings.motvMsg10];

  sendBroadcasterMsg('In setupMotivationalMessages and motvMsgInterval set to [' + motvMsgInterval + '] and Messages Array length = [' + motvMsgArray.length + ']');
    
  //Check if anything other than the Ignore Zeroth message was populated into the Motivational Messages array and if so call next message
  if (motvMsgArray.length > 1) {
    motvNextMessage = 0;
    motvMsgCount = motvMsgArray.length - 1;
    nextMotivMsg();
  }  //End if motvMsgArray Length > 1
  
}  //End setupMotivationalMessages

//***************************************************************************************
//******************  CB SETTINGS CHOICES ***********************************************
//Establishes the variables input by Broadcaster
//Would like to add a setting that Broadcaster can opt-out of seeing the messages and only send to mods.
cb.settings_choices = [
    {name:'botversion', type:'choice',choice1:'R3', label: "Luckys User Filter Version R3"},
    {name:'uname_parts', type:'str',
        minLength:1, maxLength:255, defaultValue:"bad,user,name,part", label: "Comma-Separated Username Fragments"},
    {name:'uname_forward', type:'str',
        minLength:1,maxLength:255, defaultValue:"lucky_larry", label: "In this version lucky_larry will always see messages regardless of what you put here.  Flexibility here coming in future release."},
    {name:'showBlkdMsgs', type:'choice', 
      choice1:'Yes', choice2:'No', defaultValue: 'No', label: 'When messages are blocked do you want to see them privately?  If you choose No they will just be ignored.'},    
    {name:'useMotivateMsgs', type:'choice', 
      choice1:'Yes', choice2:'No', defaultValue: 'No', label: 'Do you want to use the Motivation and Helper Messages feature?  These are messages that only the Broadcaster will see at the interval you specify in the next setting.'},
    {name:'motvInterval', type:'int', minValue:0, maxValue:99, defaultValue:7, label: "Enter the number of minutes between messages:"},
    {name:'motvMsg1', type:'str',
        minLength:1,maxLength:255, defaultValue:"YOU ARE GODDESS!  MAY THEY HEAR YOU ROAR!!", label: "Motivational Money Message 1"},
    {name:'motvMsg2', type:'str',
        minLength:1,maxLength:255, defaultValue:"WHAT CAN YOU DO RIGHT NOW TO ENGAGE MORE WITH YOUR GUYS??", label: "Motivational Money Message 2"},
    {name:'motvMsg3', type:'str',
        minLength:1,maxLength:255, defaultValue:"DO YOU NEED WATER?", label: "Motivational Money Message 3"},
    {name:'motvMsg4', type:'str',
        minLength:1,maxLength:255, defaultValue:"YOU ARE BEAUTIFUL POWERFUL & ABUNDANCE IS HEADED YOUR WAY!!", label: "Motivational Money Message 4"},
    {name:'motvMsg5', type:'str',
        minLength:1,maxLength:255, defaultValue:"HAVE YOU THANKED EVERYONE FOR VISITING YOU LATELY?", label: "Motivational Money Message 5"},
    {name:'motvMsg6', type:'str',
        minLength:1,maxLength:255, defaultValue:"BUBBLES??", label: "Motivational Money Message 6"},
    {name:'motvMsg7', type:'str',
        minLength:1,maxLength:255, defaultValue:"HULA??", label: "Motivational Money Message 7"},
    {name:'motvMsg8', type:'str',
        minLength:1,maxLength:255, defaultValue:"YOU ARE BEAUTIFUL POWERFUL & ABUNDANCE IS HEADED YOUR WAY!!", label: "Motivational Money Message 8"},
    {name:'motvMsg9', type:'str',
        minLength:1,maxLength:255, defaultValue:"SHOUT OUT CLIP STORES & LINK!", label: "Motivational Money Message 9"},
    {name:'motvMsg10', type:'str',
        minLength:1,maxLength:255, defaultValue:"WHAT CAN YOU DO RIGHT NOW TO ENGAGE MORE WITH YOUR GUYS??", label: "Motivational Money Message 10"}  
]; //End Settings_Choices set

//**********************************************************************************
//******************  ON START *****************************************************
cb.onStart(user => {

    //Store Broadcaster's name
    bname = cb.room_slug;
    
    //Store setting to show blocked messages
    showBlkdMsgs = cb.settings.showBlkdMsgs;
    
    sendBroadcasterMsg('Broadcaster will see blocked messages?  [' + showBlkdMsgs +']');
    
    //cb.chatNotice(user['user'] + ' started an app!');
    cb.chatNotice(bname + ' started bot Luckys_User_Filter_Flexible! ' + botVersion);

    //Store Broadcaster is Zeroth entry in userArray
    userArray[0] = bname;
    
    //Initialize userSilencedArray to make it 1-based
    userSilencedArray[0] = 'Placeholder so that Index 1 becomes the first user silenced.';
    
    //Set global array to the comma-delimited list of name-parts
    //let uname_parts = cb.settings.uname_parts.split(",");
    
    //Uncomment below to print a private list of all username parts that will be scanned for into the chat at bot-start
    //send_uname_split(cb.settings.uname_parts.split(','));
    
    //Function to setup the Motivational Messages
    if (cb.settings.useMotivateMsgs == "Yes") {
      setupMotivationalMessages();
    }  //End IF if Motivational Messages should be used    
  }  //End function passed into cb.onStart event
);  //End cb.onStart event code

cb.getRoomOwnerData(ownerData => {
    if (ownerData['success']) {
        cb.chatNotice(cb.room_slug + ' has ' + ownerData['data']['followers'] + ' followers!')
    }
});

//**********************************************************************************
//******************  ON ENTER *****************************************************
cb.onEnter(function(user) {

    //Add new user into user array
    userIndex = userArray.push(user['user']) - 1;
    
    //Turn on below to give a message for each new person joining.
    //cb.chatNotice('Welcome ' + user['user'] + '! You are visitor number ' + userIndex + ' into my room today!');
    
    //Check if new user is female and if so prompt broadcaster with that info and how to quickly silence them.
    if (user['gender'] == 'f') {
      sendBroadcasterMsg(
        'WARNING!  User #' + userIndex + ' ' + user['user'] + ' is FEMALE.  ' 
        + 'Are they broadcasting? Enter sss' + userIndex + ' to silence them.');
    } //End if user is female
});

//*******************************************************************************
//******************  IS USERNAME FILTERED **************************************
function isUserNameFiltered(checkuname,uname_split) {
//Check if the passed-in username matches any of the username fragments that
  //should be blocked and if so add them to the Silenced-Users Array
  
  for (let i=0; i<uname_split.length; i++) {
  
    if (checkuname.includes(uname_split[i])) {
    
      //Add user to the SilencedArray to shortcut this next time they send a message
      userSilencedArray.push(checkuname);
          
      return true;
    }  //End IF block testing if message-sender's username contains any of the username split parts
  }  //End For-Each block iterating through all the username-parts
  return false;
}

//*******************************************************************************
//******************  SHOULD_BLOCK_MSG ******************************************
function should_block_msg(msg) {
//Determine if the message sent should be blocked for various reasons

  let checkuname = msg['user'];
  let uname_split = cb.settings.uname_parts.split(',');
  let doBlockMessage = false;

  //cb.sendNotice('In should_block_msg:  checkuname = [' + checkuname + '] and uname_split has [' + uname_split.length + '] elements from uname_parts = [' + cb.settings.uname_parts + ']',bname);

  //If the username is in the userSilencedArray set via Broadcaster typing 'sss' and X for the user index then they are silenced
  if (userSilencedArray.includes(checkuname) == true) {
    cb.sendNotice('Blocked message from ' + checkuname + ': [' + msg['m'] + ']','lucky_larry','bolder');      
    if (showBlkdMsgs == 'Yes') {cb.sendNotice('Blocked message from ' + checkuname + ': [' + msg['m'] + ']',bname,'bolder');}      
    return true;
  } else {

    doBlockMessage = isUserNameFiltered(checkuname,uname_split);

    if (doBlockMessage == true) {
      cb.sendNotice('Blocked message from ' + checkuname + ': [' + msg['m'] + ']','lucky_larry','bolder');  
      if (showBlkdMsgs == 'Yes') {cb.sendNotice('Blocked message from ' + checkuname + ': [' + msg['m'] + ']',bname,'bolder');}
  
    }  //End If doBlockMessage is true
  }  //If username in SilencedArray
  return doBlockMessage;  
}  //End function should block message

//**********************************************************************************
//******************  SEND_FOLLOWER_COUNT ******************************************
function sendFollowerCount() {
  //This function is intended to create a notice in the chatroom indicating the number of followers.
  cb.getRoomOwnerData(ownerData => {
    if (ownerData['success']) {
        cb.chatNotice(cb.room_slug + ' has ' + ownerData['data']['followers'] + ' followers!')
    }
  });
}  //End function SendFollowerCount

//*************************************************************************
//******************  ON MESSAGE ******************************************
cb.onMessage(function (msg) {

  let uname = msg['user'];
  let umsg = msg['m'];
  let umsg3 = umsg.substr(3);
  
  //cb.sendNotice('In onMessage:  uname = [' + uname + '] and bname = [' + bname + '] and m = [' + msg['m'] + ']',bname);
  
  if (uname == bname || uname == 'lucky_larry') {
  
    //Code to execute if the message sender is the Broadcaster or Bot-Admin
    
      //Check for Broadcaster code to request Follower count
    if (umsg == 'fff') {
    
      //Suppress the line of chat requesting Follower count
      msg['X-Spam'] = true;
      
      sendFollowerCount();
        
      //Check for silence code from Broadcaster
    } else if (umsg.startsWith('sss') == true) {
      
      //Suppress the line of chat
      msg['X-Spam'] = true;
      
      //Debug message can probably delete it
      //sendBroadcasterMsg('Message = [' + msg['m'] + '] Length = [' + msg['m'].length + '] Substring = [' + msg['m'].substring(3,msg['m'].length-3) + ']',false,uname);
      
      //Code to somehow indicate that the indicated user should be silenced
      let userToSilence = umsg3;
      
      //Add the user to the array of silenced users
      userSilencedArray.push(userArray[userToSilence]);
      
      //Leaving Requested By parameter blank so both broadcaster & Larry get the notification
      sendBroadcasterMsg('User #' + userToSilence + ', ' + userArray[userToSilence] + ', has been added to the silence list.');
          
    } else if (umsg.startsWith('shh') == true) {
    
      if (umsg == 'shh') {
    
        //Implement code to show the user that belongs to a given index
        outputArray(userArray.sort(),uname);
      
      } else {
        
        //Output user at a specific number
        let chkUser = umsg3;
        
        sendBroadcasterMsg('User #' + chkUser + ' is ' + userArray[chkUser] + '.',false,uname);
      
      }
      
      //Suppress the line of chat
      msg['X-Spam'] = true; 
      
    } else if (umsg.startsWith('shu') == true) {
    
      outputArray(userSilencedArray,uname);  
    
    } else if (umsg.startsWith('uuu')){

      //Suppress the line of chat
      msg['X-Spam'] = true; 
            
      //Code to remove a user from the silence array
      userUnsilence = Number(umsg3);

      sendBroadcasterMsg('Running unsilence command for ' + umsg + ' and userUnsilence value = [' + userUnsilence + '].',false,uname);
      
      //if (userUnsilence == NaN) {
			if (userUnsilence == false || userSilencedArray.includes(umsg3) == true) {

        //Must have been the alpha-numeric username passed so get the Index of that username from the userSilencedArray
        userIndex = userSilencedArray.indexOf(umsg3);
        
        //Change that array element to remove the username from there
        userSilencedArray[userIndex] = 'Unsilenced ' + userIndex;
        
        //Pass confirmation message to broadcaster & bot-admin
        sendBroadcasterMsg('String Unsilenced ' + umsg3 + ' Index [' + userIndex + '] and now reads [' + userSilencedArray[userIndex] + ']',false,uname);
            
      } else if (Number(umsg3) >= 0) {
      
        //Get the Username from the userArray
        getUser = userArray[umsg3];
        
        //Get the Index of the user in the SilencedArray
        userIndex = userSilencedArray.indexOf(getUser);

        userSilencedArray[userIndex] = 'Unsilenced ' + userUnsilence;
        sendBroadcasterMsg('Integer Unsilencing [' + getUser + '] Index [' + umsg3 + '] and now reads [' + userSilencedArray[userIndex] + ']',false,uname);
      
      } else {
      
        sendBroadcasterMsg('Unsilence Failure on [' + umsg3 + '] because Number check came up [' + (Number(umsg3)) + ']',false,uname);
      
      }  //End if userUnsilence == Nan
      
    }  //End if for special Broadcaster codes
    
    return msg;
    
  } else {

    //cb.sendNotice('In else section before call should_block_message',bname);
    
    //Code to execute if the message sender is not the Broadcaster  
    msg['X-Spam'] = should_block_msg(msg);
    return msg;

  } // End IF uname = bname block
  
  return msg;
}  //End cb.onMessge event function
);  //End cb.onMessage event code