channels.h

Go to the documentation of this file.

/* Channel support
 *
 * (C) 2008-2013 Anope Team
 * Contact us at team@anope.org
 *
 * Please read COPYING and README for further details.
 *
 */

#ifndef CHANNELS_H
#define CHANNELS_H

#include "anope.h"
#include "extensible.h"
#include "modes.h"
#include "serialize.h"

typedef Anope::hash_map<Channel *> channel_map;

extern CoreExport channel_map ChannelList;

/* A user container, there is one of these per user per channel. */
struct ChanUserContainer : public Extensible
{
        User *user;
        Channel *chan;
        /* Status the user has in the channel */
        ChannelStatus status;

        ChanUserContainer(User *u, Channel *c) : user(u), chan(c) { }
};

enum ChannelFlag
{
        /* ChanServ is currently holding the channel */
        CH_INHABIT,
        /* Channel still exists when emptied */
        CH_PERSIST,
        /* If set the channel is syncing users (channel was just created) and it should not be deleted */
        CH_SYNCING
};

class CoreExport Channel : public Base, public Extensible
{
 public:
        typedef std::multimap<Anope::string, Anope::string> ModeList;
 private:
        ModeList modes;

 public:
        /* Channel name */
        Anope::string name;
        /* Set if this channel is registered. ci->c == this. Contains information relevant to the registered channel */
        Serialize::Reference<ChannelInfo> ci;
        /* When the channel was created */
        time_t creation_time;
        std::set<ChannelFlag> flags;

        /* Users in the channel */
        typedef std::list<ChanUserContainer *> ChanUserList;
        ChanUserList users;

        /* Current topic of the channel */
        Anope::string topic;
        /* Who set the topic */
        Anope::string topic_setter;
        /* The timestamp associated with the topic. Not necessarually anywhere close to Anope::CurTime.
         * This is the time the topic was *originally set*. When we restore the topic we want to change the TS back
         * to this, but we can only do this on certain IRCds.
         */
        time_t topic_ts;
        /* The actual time the topic was set, probably close to Anope::CurTime */
        time_t topic_time;

        time_t server_modetime;         /* Time of last server MODE */
        time_t chanserv_modetime;       /* Time of last check_modes() */
        int16_t server_modecount;       /* Number of server MODEs this second */
        int16_t chanserv_modecount;     /* Number of check_mode()'s this sec */
        int16_t bouncy_modes;           /* Did we fail to set modes here? */

        Channel(const Anope::string &nname, time_t ts = Anope::CurTime);

        ~Channel();

        void Reset();

        void Sync();

        void CheckModes();

        ChanUserContainer* JoinUser(User *u);

        void DeleteUser(User *u);

        ChanUserContainer *FindUser(const User *u) const;

        bool HasUserStatus(const User *u, ChannelModeStatus *cms) const;

        bool HasUserStatus(const User *u, const Anope::string &name) const;

        size_t HasMode(const Anope::string &name, const Anope::string &param = "");

        void SetModeInternal(MessageSource &source, ChannelMode *cm, const Anope::string &param = "", bool enforce_mlock = true);

        void RemoveModeInternal(MessageSource &source, ChannelMode *cm, const Anope::string &param = "", bool enforce_mlock = true);

        void SetMode(BotInfo *bi, ChannelMode *cm, const Anope::string &param = "", bool enforce_mlock = true);

        void SetMode(BotInfo *bi, const Anope::string &name, const Anope::string &param = "", bool enforce_mlock = true);

        void RemoveMode(BotInfo *bi, ChannelMode *cm, const Anope::string &param = "", bool enforce_mlock = true);

        void RemoveMode(BotInfo *bi, const Anope::string &name, const Anope::string &param = "", bool enforce_mlock = true);

        bool GetParam(const Anope::string &name, Anope::string &target) const;

        void SetModes(BotInfo *bi, bool enforce_mlock, const char *cmodes, ...);

        void SetModesInternal(MessageSource &source, const Anope::string &mode, time_t ts = 0, bool enforce_mlock = true);

        bool MatchesList(User *u, const Anope::string &list);

        void KickInternal(MessageSource &source, const Anope::string &nick, const Anope::string &reason);

        bool Kick(BotInfo *bi, User *u, const char *reason = NULL, ...);

        const ModeList &GetModes() const;

        std::pair<ModeList::iterator, ModeList::iterator> GetModeList(const Anope::string &name);

        Anope::string GetModes(bool complete, bool plus);

        void ChangeTopicInternal(const Anope::string &user, const Anope::string &newtopic, time_t ts = Anope::CurTime);

        void ChangeTopic(const Anope::string &user, const Anope::string &newtopic, time_t ts = Anope::CurTime);

        void Hold();

        void SetCorrectModes(User *u, bool give_mode, bool check_noop);

        bool Unban(const User *u, bool full = false);

        static Channel* Find(const Anope::string &name);
};

#endif // CHANNELS_H