summaryrefslogtreecommitdiff
path: root/include/bots.h
blob: 01581ea0e987e56f8cf772e707ca398624870337 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
/*
 * Copyright (C) 2008-2010 Robin Burchell <w00t@inspircd.org>
 * Copyright (C) 2008-2010 Anope Team <team@anope.org>
 *
 * Please read COPYING and README for further details.
 *
 *
 * $Id$
 *
 */

/** Flags settable on a bot
 */
enum BotFlag
{
	BI_BEGIN,

	/* This bot can only be assigned by IRCops */
	BI_PRIVATE,
	/* The following flags are used to determin what bot really is what.
	 * Since you *could* have ChanServ really named BotServ or something stupid,
	 * this keeps track of them and allows them to be renamed in the config
	 * at any time, even if they already exist in the database
	 */
	BI_CHANSERV,
	BI_BOTSERV,
	BI_HOSTSERV,
	BI_OPERSERV,
	BI_MEMOSERV,
	BI_NICKSERV,
	BI_GLOBAL,

	BI_END
};

struct CommandHash;

class CoreExport BotInfo : public Extensible, public Flags<BotFlag>
{
 public:
	BotInfo *next, *prev;

	std::string uid;		/* required for UID supporting servers, as opposed to the shitty struct Uid. */
	std::string nick;		/* Nickname of the bot */
	std::string user;		/* Its user name */
	std::string host;		/* Its hostname */
	std::string real;		/* Its real name */
	time_t created; 		/* Birth date ;) */
	int16 chancount;		/* Number of channels that use the bot. */
	/* Dynamic data */
	time_t lastmsg;			/* Last time we said something */
	CommandHash **cmdTable;

	/** 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.
	 */
	BotInfo(const std::string &nick, const std::string &user = "", const std::string &host = "", const std::string &real = "");

	/** Destroy a bot, clearing up appropriately.
	 */
	virtual ~BotInfo();

	/** Change the nickname set on a bot.
	 * @param newnick The nick to change to
	 */
	void ChangeNick(const char *newnick);

	/** Rejoins all channels that this bot is assigned to.
	 * Used on /kill, rename, etc.
	 */
	void RejoinAll();

	/** 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);
};