Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

home » brain » inspircd-cvs » 1_1_stable » include

channels.h

Go to the documentation of this file.

/*       +------------------------------------+
 *       | Inspire Internet Relay Chat Daemon |
 *       +------------------------------------+
 *
 *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
 * See: http://www.inspircd.org/wiki/index.php/Credits
 *
 * This program is free but copyrighted software; see
 *            the file COPYING for details.
 *
 * ---------------------------------------------------
 */

#ifndef __CHANNELS_H__
#define __CHANNELS_H__

#include "inspircd_config.h"
#include "base.h"
#include <time.h>
#include <vector>
#include <string>
#include <map>

enum ChannelModes {
        CM_TOPICLOCK = 't'-65,  /* +t: Only operators can change topic */
        CM_NOEXTERNAL = 'n'-65, /* +n: Only users in the channel can message it */
        CM_INVITEONLY = 'i'-65, /* +i: Invite only */
        CM_MODERATED = 'm'-65,  /* +m: Only voices and above can talk */
        CM_SECRET = 's'-65,     /* +s: Secret channel */
        CM_PRIVATE = 'p'-65,    /* +p: Private channel */
        CM_KEY = 'k'-65,        /* +k: Keyed channel */
        CM_LIMIT = 'l'-65       /* +l: Maximum user limit */
};

/* Forward declarations - needed */
class userrec;
class chanrec;

class HostItem : public classbase
{
 public:
        time_t set_time;
        char set_by[NICKMAX];
        char data[MAXBUF];

        HostItem() { /* stub */ }
        virtual ~HostItem() { /* stub */ }
};

class BanItem : public HostItem
{
};

typedef std::vector<BanItem>    BanList;

typedef std::map<userrec*,std::string> CUList;

typedef CUList::iterator CUListIter;

typedef CUList::const_iterator CUListConstIter;

typedef std::map<char,char*> CustomModeList;


enum UserChannelModes {
        UCMODE_OP       = 1,    /* Opped user */
        UCMODE_VOICE    = 2,    /* Voiced user */
        UCMODE_HOP      = 4     /* Halfopped user */
};

/* Forward declaration -- required */
class InspIRCd;

typedef std::pair<char, unsigned int> prefixtype;

typedef std::vector<prefixtype> pfxcontainer;

typedef std::map<userrec*, std::vector<prefixtype> > prefixlist;

class CoreExport chanrec : public Extensible
{
 private:

        InspIRCd* ServerInstance;

        static chanrec* ForceChan(InspIRCd* Instance, chanrec* Ptr, userrec* user, const std::string &privs);

        void SetDefaultModes();

        prefixlist prefixes;

        int maxbans;

 public:
        char name[CHANMAX];

        char modes[64];

        CUList internal_userlist;

        CUList internal_op_userlist;

        CUList internal_halfop_userlist;

        CUList internal_voice_userlist;

        CustomModeList custom_mode_params;

        char topic[MAXTOPIC];

        time_t created;

        time_t topicset;

        char setby[128];

        short int limit;
        
        char key[32];

        BanList bans;
        
        void SetMode(char mode,bool mode_on);

        void SetModeParam(char mode,const char* parameter,bool mode_on);
 
        bool IsModeSet(char mode);

        std::string GetModeParameter(char mode);

        long GetUserCounter();

        void AddUser(userrec* user);

        void AddOppedUser(userrec* user);

        void AddHalfoppedUser(userrec* user);

        void AddVoicedUser(userrec* user);

        unsigned long DelUser(userrec* user);

        void DelOppedUser(userrec* user);

        void DelHalfoppedUser(userrec* user);

        void DelVoicedUser(userrec* user);

        CUList* GetUsers();

        CUList* GetOppedUsers();

        CUList* GetHalfoppedUsers();

        CUList* GetVoicedUsers();

        bool HasUser(userrec* user);

        chanrec(InspIRCd* Instance);

        long KickUser(userrec *src, userrec *user, const char* reason);

        long ServerKickUser(userrec* user, const char* reason, bool triggerevents);

        long PartUser(userrec *user, const char* reason = NULL);

        /* 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 chanrec the user was joined to. A new chanrec 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 chanrec* JoinUser(InspIRCd* ServerInstance, userrec *user, const char* cn, bool override, const char* key, time_t TS = 0);

        void WriteChannel(userrec* user, char* text, ...);

        void WriteChannel(userrec* user, const std::string &text);

        void WriteChannelWithServ(const char* ServName, const char* text, ...);

        void WriteChannelWithServ(const char* ServName, const std::string &text);

        void WriteAllExceptSender(userrec* user, bool serversource, char status, char* text, ...);

        void WriteAllExcept(userrec* user, bool serversource, char status, CUList &except_list, char* text, ...);

        void WriteAllExceptSender(userrec* user, bool serversource, char status, const std::string& text);

        void WriteAllExcept(userrec* user, bool serversource, char status, CUList &except_list, const std::string& text);

        long GetMaxBans();

        char* ChanModes(bool showkey);

        void UserList(userrec *user, CUList* ulist = NULL);

        int CountInvisible();

        int GetStatus(userrec *user);

        int GetStatusFlags(userrec *user);

        const char* GetPrefixChar(userrec *user);

        const char* GetAllPrefixChars(userrec* user);

        unsigned int GetPrefixValue(userrec* user);

        void RemoveAllPrefixes(userrec* user);

        void SetPrefix(userrec* user, char prefix, unsigned int prefix_rank, bool adding);

        bool IsBanned(userrec* user);

        void ResetMaxBans();

        virtual ~chanrec() { /* stub */ }
};

#endif