Chaturbate

Bots Home | Create an App
Notifier
Author: bobomb
You are viewing version 50614. There is a newer version of this app. See the latest version of this app.

Description Source Code Launch Bot Current Users
Created by: Bobomb
There are 41 other versions of this script.
/**
 * Notifier
 *
 * Author: Bobomb
 * Version: 0.3.9
 * Last update: 09-05-2013
 *
 * Build on:
 * Framework version 1.0
 *	<PluginBase (version 1.5.1)>
 *	<Bobomb (version 1.7.3)>
 *
 * Usage:
 * Set the initial settings. The bot will now post the set message at the set interval to the room.
 *
 * Full list of supported commands:
 * /help
 * /showsettings
 * /exportsettings
 * /importsettings
 * /setmessage
 * /setinterval
 * /showmessage
 *
 * Change log:
 * -- 0.3.9 (09-05-2013) --
 *  > Reworked to my own, new scripting framework.
 *  > Added a new command: /showmessage. Show the message to the room.
 *
 * -- 0.1.6 (07-05-2013) --
 *  > Initial release.
 *
 */

/* ChaturBate set-up */
cb.settings_choices =
[
	{ name: 'message', type: 'str', minLength: 1, label: 'Message' },
	{ name: 'interval', type: 'int', minValue: 1, defaultValue: 10, maxValue: 60, label: "The interval for posting the message" }
];
/* END */


/* Plugin */
var Plugin =
{
	// Variables
	settings: { message: "", interval: 10 },
	
	// Constants
	name: "Notifier",
	commandList:
	[
		{ command: "/help", description: "show all available commands.", accessLevel: 2 },
		{ command: "/showsettings", description: "show the current settings.", accessLevel: 2 },
		{ command: "/exportsettings", description: "returns a JSON string that can be imported on the next run.", accessLevel: 2 },
		{ command: "/importsettings", description: "import settings from a previously exported JSON string.", accessLevel: 2 },
		{ command: "/setmessage", parameters: "x", description: "set message x to be displayed in the room.", accessLevel: 2 },
		{ command: "/setinterval", parameters: "#", description: "set interval # in minutes for the periodic displaying of the message.", accessLevel: 2 },
		{ command: "/showmessage", description: "show the message to the room.", accessLevel: 1, toRoom: true },
	]
};

/* General functions */
/* processCommand */
Plugin.processCommand = function(commandMessage, accessLevel)
{
	if(accessLevel == 2 && commandMessage.indexOf("/setmessage") != -1)
	{
		var newMessage = commandMessage.split("/setmessage");
		if(newMessage.length == 2)
		{
			Plugin.settings.message = newMessage[1];
		}
		cb.chatNotice("Invalid syntax found for command /setmessage!", cb.room_slug);
		return "";
	}
	else if(accessLevel == 2 && commandMessage.indexOf("/setinterval") != -1)
	{
		var newInterval = commandMessage.match(/[0-9]{1,2}/);
		if(newInterval != null)
		{
			newInterval = newInterval[0];
			if(isFinite(newInterval) && newInterval > 0 && newInterval <= 60)
			{
				Plugin.settings.interval = parseInt(newInterval);
				return "Interval has been set to " + newInterval + " minutes!";
			}
			cb.chatNotice("Invalid values found for command /setinterval!", cb.room_slug);
			return "";
		}
		cb.chatNotice("Invalid syntax found for command /setinterval!", cb.room_slug);
		return "";
	}
	else if(accessLevel >= 1 && commandMessage.indexOf("/showmessage") != -1)
	{
		return Plugin.settings.message;
	}
	return "";
}

/* postMessage */
Plugin.postMessage = function()
{
	cb.chatNotice(Plugin.settings.message);
	cb.setTimeout("Plugin.postMessage()", (Plugin.settings.interval * 60000));
}

/* init */
Plugin.init = function()
{
	Plugin.postMessage();
}
/* END */


/**
 * Bobomb
 *
 * Author: Bobomb
 * Version: 1.7.3
 * Last update: 09-05-2013
 *
 * Bobomb's main module with generic functions to extend CB's functionality. Appended to the end of all apps and bots made by Bobomb.
 *
 * Change log:
 * -- 1.7.3 (09-05-2013) --
 *  > Initial public release.
 *
 * -- 1.3.5 (08-05-2013) --
 *  > Initial implementation.
 *
 */

/* Bobomb */
var Bobomb =
{
	// Function grouping
	SettingsManager: {},
	MessageManager: {},
	UserManager: {}
};


/* Settings Manager */
/* translateSettings */
Bobomb.SettingsManager.translateSettings = function()
{
	for(setting in Plugin.settings)
	{
		Plugin.settings[setting] = cb.settings[setting];
	}
}

/* exportSetting */
Bobomb.SettingsManager.exportSetting = function(setting)
{
	return '"' + setting + '":' + JSON.stringify(Plugin[setting]);
}

/* exportAll */
Bobomb.SettingsManager.exportAll = function()
{
	var string = "{";
	for(part in Plugin)
	{
		if(Plugin[part].constructor == Object)
		{
			string += Bobomb.SettingsManager.exportSetting(part);
		}
	}
	return string + "}";
}

/* importSetting */
Bobomb.SettingsManager.importSetting = function(importObject, setting)
{
	if(importObject[setting] != undefined && Plugin[setting] != undefined)
	{
		Plugin[setting] = importObject[setting];
	}
}

/* importAll */
Bobomb.SettingsManager.importAll = function(importString)
{
	if(importString.indexOf("Notice:") != -1)
	{
		importString = importString.split("Notice: ")[1];
	}
	try
	{
		var importObject = JSON.parse(importString);
	}
	catch(e)
	{
		return "Import failed!";
	}
	for(part in Plugin)
	{
		if(Plugin[part].constructor == Object)
		{
			Bobomb.SettingsManager.importSetting(importObject, part);
		}
	}
	return "Import successfull!";
}
/* END */


/* Message Manager */
/* getToRoom */
Bobomb.MessageManager.getToRoom = function(command)
{
	if(command.indexOf(" ") != -1)
	{
		command = command.slice(0, command.indexOf(" "));
	}
	for(var i = 0; i < Plugin.commandList.length; i++)
	{
		if((commandObj = Plugin.commandList[i]).command == command)
		{
			if(commandObj.toRoom != undefined)
			{
				return commandObj.toRoom;
			}
			return false;
		}
	}
	return false;
}

/* makeList */
Bobomb.MessageManager.makeList = function(fromList, accessLevel)
{
	var output = "";
	if(fromList == Plugin.commandList)
	{
		output += "Commands for " + Plugin.name + ": \n";
		var restOfOutput = "";
		for(var i = 0; i < Plugin.commandList.length; i++)
		{
			if((Plugin.commandList[i].module == undefined || Plugin.settings[Plugin.commandList[i].module]) && Plugin.commandList[i].accessLevel <= accessLevel)
			{
				if(restOfOutput.length > 0)
				{
					restOfOutput += "\n";
				}
				restOfOutput += Plugin.commandList[i].command;
				if(Plugin.commandList[i].parameters != undefined)
				{
					restOfOutput += " " + Plugin.commandList[i].parameters;
				}
				restOfOutput += " | " + Plugin.commandList[i].description;
				if(Plugin.commandList[i].variation != undefined)
				{
					restOfOutput += "\n" + Plugin.commandList[i].command + " " + Plugin.commandList[i].parameters + " " + Plugin.commandList[i].variation + " | " + Plugin.commandList[i].description;
				}
			}
		}
		output = output + restOfOutput + "\nNote: by adding !private to a command, the return message will always be hidden from the room.";
	}
	return output;
}

/* processCommand */
Bobomb.MessageManager.processCommand = function(commandMessage, accessLevel)
{
	if(accessLevel == 2 && commandMessage.indexOf("/importsettings") != -1)
	{
		returnMessage = Bobomb.SettingsManager.importAll(commandMessage.slice(15));
		return returnMessage;
	}
	else
	{
		commandMessage = commandMessage.toLowerCase();
		if(accessLevel >= 2 && commandMessage.indexOf("/help") != -1)
		{
			return Bobomb.MessageManager.makeList(Plugin.commandList, accessLevel);
		}
		else if(accessLevel == 2 && commandMessage.indexOf("/showsettings") != -1)
		{
			var output = "Current settings:";
			for(setting in Plugin.settings)
			{
				output += "\n" + setting + ": " + Plugin.settings[setting];
			}
			return output;
		}
		else if(accessLevel == 2 && commandMessage.indexOf("/exportsettings") != -1)
		{
			return Bobomb.SettingsManager.exportAll();
		}
		else
		{
			return Plugin.processCommand(commandMessage, accessLevel);
		}
	}
	return "";
}

/* messageHandler */
Bobomb.MessageManager.messageHandler = function(message)
{
	if(message['m'].search(/^\/[A-z]+/) != -1)
	{
		if((returnMessage = Bobomb.MessageManager.processCommand(message['m'], Bobomb.UserManager.getAccessLevel({ name: message['user'], is_mod: message['is_mod'] }), message['user'].toLowerCase())).length > 0)
		{
			if(message['m'].indexOf("!private") == -1 && Bobomb.MessageManager.getToRoom(message['m']))
			{
				cb.chatNotice(returnMessage);
			}
			else
			{
				cb.chatNotice(returnMessage + "\n(Not shown to room)", message['user']);
			}
		}
		message['m'] += " (intercepted as command by " + Plugin.name + ")";
		message['X-Spam'] = true;
	}
	else if(Plugin.processNormalMessage != undefined)
	{
		message = Plugin.processNormalMessage(message);
	}
	return message;
}
/* END */


/* User Manager */
/* getAccessLevel */
Bobomb.UserManager.getAccessLevel = function(user)
{
	if(user['name'] == cb.room_slug)
	{
		return 2;
	}
	else if(user['is_mod'])
	{
		return 1;
	}
	return 0;
}
/* END */


/* General functions */
/* init */
Bobomb.init = function()
{
	Bobomb.SettingsManager.translateSettings();
	if(Plugin.processCommand != undefined)
	{
		cb.onMessage(Bobomb.MessageManager.messageHandler);
	}
	if(Plugin.init != undefined)
	{
		Plugin.init();
	}
}
/* END */


Bobomb.init();