channels.h

/*
 * InspIRCd -- Internet Relay Chat Daemon
 *
 *   Copyright (C) 2009 Daniel De Graaf <[email protected]>
 *   Copyright (C) 2007 Robin Burchell <[email protected]>
 *   Copyright (C) 2007 Dennis Friis <[email protected]>
 *   Copyright (C) 2003-2007 Craig Edwards <[email protected]>
 *
 * This file is part of InspIRCd.  InspIRCd is free software: you can
 * redistribute it and/or modify it under the terms of the GNU General Public
 * License as published by the Free Software Foundation, version 2.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 
#ifndef CHANNELS_H
#define CHANNELS_H
 
#include "membership.h"
#include "mode.h"
 
class HostItem
{
 public:
        time_t set_time;
        std::string set_by;
        std::string data;
 
        HostItem() { /* stub */ }
        virtual ~HostItem() { /* stub */ }
};
 
class BanItem : public HostItem
{
};
 
class CoreExport Channel : public Extensible, public InviteBase
{
        static Channel* ForceChan(Channel* Ptr, User* user, const std::string &privs, bool bursting, bool created);
 
        void SetDefaultModes();
 
        int maxbans;
 
        std::bitset<64> modes;
 
        CustomModeList custom_mode_params;
 
 public:
        Channel(const std::string &name, time_t ts);
 
        std::string name;
 
        time_t age;
 
        UserMembList userlist;
 
        std::string topic;
 
        time_t topicset;
 
        std::string setby; /* 128 */
 
        BanList bans;
 
        void SetMode(ModeHandler* mode, bool value);
        void SetMode(char mode,bool mode_on);
 
        void SetModeParam(ModeHandler* mode, const std::string& parameter);
        void SetModeParam(char mode, const std::string& parameter);
 
        inline bool IsModeSet(char mode) { return modes[mode-'A']; }
        inline bool IsModeSet(ModeHandler* mode) { return modes[mode->GetModeChar()-'A']; }
 
 
        std::string GetModeParameter(char mode);
        std::string GetModeParameter(ModeHandler* mode);
 
        int SetTopic(User *u, std::string &t, bool forceset = false);
 
        long GetUserCounter();
 
        Membership* AddUser(User* user);
 
        void DelUser(User* user);
 
        const UserMembList* GetUsers();
 
        bool HasUser(User* user);
 
        Membership* GetUser(User* user);
 
        void KickUser(User *src, User *user, const char* reason);
 
        void PartUser(User *user, std::string &reason);
 
        /* Join a user to a channel. May be a channel that doesnt exist yet.
         * @param user The user to join to the channel.
         * @param cn The channel name to join to. Does not have to exist.
         * @param key The key of the channel, if given
         * @param override If true, override all join restrictions such as +bkil
         * @return A pointer to the Channel the user was joined to. A new Channel may have
         * been created if the channel did not exist before the user was joined to it.
         * If the user could not be joined to a channel, the return value may be NULL.
         */
        static Channel* JoinUser(User *user, const char* cn, bool override, const char* key, bool bursting, time_t TS = 0);
 
        void WriteChannel(User* user, const char* text, ...) CUSTOM_PRINTF(3, 4);
 
        void WriteChannel(User* user, const std::string &text);
 
        void WriteChannelWithServ(const std::string& ServName, const char* text, ...) CUSTOM_PRINTF(3, 4);
 
        void WriteChannelWithServ(const std::string& ServName, const std::string &text);
 
        void WriteAllExceptSender(User* user, bool serversource, char status, const char* text, ...) CUSTOM_PRINTF(5, 6);
 
        void WriteAllExcept(User* user, bool serversource, char status, CUList &except_list, const char* text, ...) CUSTOM_PRINTF(6, 7);
 
        void WriteAllExceptSender(User* user, bool serversource, char status, const std::string& text);
 
        void WriteAllExcept(User* user, bool serversource, char status, CUList &except_list, const std::string& text);
        void RawWriteAllExcept(User* user, bool serversource, char status, CUList &except_list, const std::string& text);
 
        long GetMaxBans();
 
        char* ChanModes(bool showkey);
 
        void UserList(User *user);
 
        int CountInvisible();
 
        const char* GetPrefixChar(User *user);
 
        const char* GetAllPrefixChars(User* user);
 
        unsigned int GetPrefixValue(User* user);
 
        void RemoveAllPrefixes(User* user);
 
        bool SetPrefix(User* user, char prefix, bool adding);
 
        bool IsBanned(User* user);
 
        bool CheckBan(User* user, const std::string& banmask);
 
        ModResult GetExtBanStatus(User *u, char type);
 
        void ResetMaxBans();
};
 
#endif