mirror of git://git.acid.vegas/anope.git
136 lines
4.1 KiB
C++
136 lines
4.1 KiB
C++
/*
|
|
*
|
|
* (C) 2008-2011 Robin Burchell <w00t@inspircd.org>
|
|
* (C) 2008-2022 Anope Team <team@anope.org>
|
|
*
|
|
* Please read COPYING and README for further details.
|
|
*/
|
|
|
|
#ifndef BOTS_H
|
|
#define BOTS_H
|
|
|
|
#include "users.h"
|
|
#include "anope.h"
|
|
#include "serialize.h"
|
|
#include "commands.h"
|
|
|
|
|
|
typedef Anope::map<BotInfo *> botinfo_map;
|
|
|
|
extern CoreExport Serialize::Checker<botinfo_map> BotListByNick, BotListByUID;
|
|
|
|
/* A service bot (NickServ, ChanServ, a BotServ bot, etc). */
|
|
class CoreExport BotInfo : public User, public Serializable
|
|
{
|
|
/* Channels this bot is assigned to */
|
|
Serialize::Checker<std::set<ChannelInfo *> > channels;
|
|
public:
|
|
time_t created;
|
|
/* Last time this bot said something (via privmsg) */
|
|
time_t lastmsg;
|
|
/* Map of actual command names -> service name/permission required */
|
|
CommandInfo::map commands;
|
|
/* Modes the bot should have as configured in service:modes */
|
|
Anope::string botmodes;
|
|
/* Channels the bot should be in as configured in service:channels */
|
|
std::vector<Anope::string> botchannels;
|
|
/* Whether or not this bot is introduced to the network */
|
|
bool introduced;
|
|
/* Bot can only be assigned by irc ops */
|
|
bool oper_only;
|
|
/* Bot is defined in the configuration file */
|
|
bool conf;
|
|
|
|
/** Create a new bot.
|
|
* @param nick The nickname to assign to the bot.
|
|
* @param user The ident to give the bot.
|
|
* @param host The hostname to give the bot.
|
|
* @param real The realname to give the bot.
|
|
* @param bmodes The modes to give the bot.
|
|
*/
|
|
BotInfo(const Anope::string &nick, const Anope::string &user = "", const Anope::string &host = "", const Anope::string &real = "", const Anope::string &bmodes = "");
|
|
|
|
/** Destroy a bot, clearing up appropriately.
|
|
*/
|
|
virtual ~BotInfo();
|
|
|
|
void Serialize(Serialize::Data &data) const;
|
|
static Serializable* Unserialize(Serializable *obj, Serialize::Data &);
|
|
|
|
void GenerateUID();
|
|
|
|
void OnKill();
|
|
|
|
/** Change the nickname for the bot.
|
|
* @param newnick The nick to change to
|
|
*/
|
|
void SetNewNick(const Anope::string &newnick);
|
|
|
|
/** Return the channels this bot is assigned to
|
|
*/
|
|
const std::set<ChannelInfo *> &GetChannels() const;
|
|
|
|
/** Assign this bot to a given channel, removing the existing assigned bot if one exists.
|
|
* @param u The user assigning the bot, or NULL
|
|
* @param ci The channel registration to assign the bot to.
|
|
*/
|
|
void Assign(User *u, ChannelInfo *ci);
|
|
|
|
/** Remove this bot from a given channel.
|
|
* @param u The user requesting the unassign, or NULL.
|
|
* @param ci The channel registration to remove the bot from.
|
|
*/
|
|
void UnAssign(User *u, ChannelInfo *ci);
|
|
|
|
/** Get the number of channels this bot is assigned to
|
|
*/
|
|
unsigned GetChannelCount() const;
|
|
|
|
/** Join this bot to a channel
|
|
* @param c The channel
|
|
* @param status The status the bot should have on the channel
|
|
*/
|
|
void Join(Channel *c, ChannelStatus *status = NULL);
|
|
|
|
/** Join this bot to a channel
|
|
* @param chname The channel name
|
|
* @param status The status the bot should have on the channel
|
|
*/
|
|
void Join(const Anope::string &chname, ChannelStatus *status = NULL);
|
|
|
|
/** Part this bot from a channel
|
|
* @param c The channel
|
|
* @param reason The reason we're parting
|
|
*/
|
|
void Part(Channel *c, const Anope::string &reason = "");
|
|
|
|
/** Called when a user messages this bot
|
|
* @param u The user
|
|
* @param message The users' message
|
|
*/
|
|
virtual void OnMessage(User *u, const Anope::string &message);
|
|
|
|
/** Link a command name to a command in services
|
|
* @param cname The command name
|
|
* @param sname The service name
|
|
* @param permission Permission required to execute the command, if any
|
|
* @return The commandinfo for the newly created command
|
|
*/
|
|
CommandInfo& SetCommand(const Anope::string &cname, const Anope::string &sname, const Anope::string &permission = "");
|
|
|
|
/** Get command info for a command
|
|
* @param cname The command name
|
|
* @return A struct containing service name and permission
|
|
*/
|
|
CommandInfo *GetCommand(const Anope::string &cname);
|
|
|
|
/** Find a bot by nick
|
|
* @param nick The nick
|
|
* @param nick_only True to only look by nick, and not by UID
|
|
* @return The bot, if it exists
|
|
*/
|
|
static BotInfo* Find(const Anope::string &nick, bool nick_only = false);
|
|
};
|
|
|
|
#endif // BOTS_H
|