bots.h

Go to the documentation of this file.

/*
 *
 * Copyright (C) 2008-2011 Robin Burchell <w00t@inspircd.org>
 * Copyright (C) 2008-2013 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
{
 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;

        BotInfo(const Anope::string &nick, const Anope::string &user = "", const Anope::string &host = "", const Anope::string &real = "", const Anope::string &bmodes = "");

        virtual ~BotInfo();

        void Serialize(Serialize::Data &data) const;
        static Serializable* Unserialize(Serializable *obj, Serialize::Data &);

        void GenerateUID();

        void SetNewNick(const Anope::string &newnick);

        void RejoinAll();

        void Assign(User *u, ChannelInfo *ci);

        void UnAssign(User *u, ChannelInfo *ci);

        unsigned GetChannelCount() const;

        void Join(Channel *c, ChannelStatus *status = NULL);

        void Join(const Anope::string &chname, ChannelStatus *status = NULL);

        void Part(Channel *c, const Anope::string &reason = "");

        virtual void OnMessage(User *u, const Anope::string &message);

        CommandInfo& SetCommand(const Anope::string &cname, const Anope::string &sname, const Anope::string &permission = "");

        CommandInfo *GetCommand(const Anope::string &cname);

        static BotInfo* Find(const Anope::string &nick, bool nick_only = false);
};

extern CoreExport BotInfo *BotServ, *ChanServ, *Global, *HostServ, *MemoServ, *NickServ, *OperServ;

#endif // BOTS_H