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

home » brain » inspircd-cvs » inspircd » include

mode.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 __MODE_H
#define __MODE_H

/* Forward declarations. */
class User;

#include "channels.h"

enum ModeType
{
        MODETYPE_USER = 0,
        MODETYPE_CHANNEL = 1
};

enum ModeAction
{
        MODEACTION_DENY = 0, /* Drop the mode change, AND a parameter if its a parameterized mode */
        MODEACTION_ALLOW = 1 /* Allow the mode */
};

enum ModeMasks
{
        MASK_USER = 128,        /* A user mode */
        MASK_CHANNEL = 0        /* A channel mode */
};

enum PrefixModeValue
{
        /* +v */
        VOICE_VALUE     =       10000,
        /* +h */
        HALFOP_VALUE    =       20000,
        /* +o */
        OP_VALUE        =       30000
};

typedef std::pair<bool,std::string> ModePair;

class CoreExport ModeHandler : public Extensible
{
 protected:
        InspIRCd* ServerInstance;
        char mode;
        int n_params_on;
        int n_params_off;
        bool list;
        ModeType m_type;
        bool oper;

        char prefix;

        unsigned int count;

        char prefixneeded;

 public:
        ModeHandler(InspIRCd* Instance, char modeletter, int parameters_on, int parameters_off, bool listmode, ModeType type, bool operonly, char mprefix = 0, char prefixrequired = '%');
        virtual ~ModeHandler();
        bool IsListMode();
        char GetPrefix();
        virtual unsigned int GetCount();
        virtual void ChangeCount(int modifier);
        virtual unsigned int GetPrefixRank();
        ModeType GetModeType();
        bool NeedsOper();
        int GetNumParams(bool adding);
        char GetModeChar();

        virtual std::string GetUserParameter(User* useor);

        virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding, bool servermode = false); /* Can change the mode parameter as its a ref */
        virtual void DisplayList(User* user, Channel* channel);

        virtual void OnParameterMissing(User* user, User* dest, Channel* channel);

        virtual void DisplayEmptyList(User* user, Channel* channel);

        virtual bool CheckTimeStamp(time_t theirs, time_t ours, const std::string &their_param, const std::string &our_param, Channel* channel);

        virtual ModePair ModeSet(User* source, User* dest, Channel* channel, const std::string &parameter);

        virtual void RemoveMode(User* user, irc::modestacker* stack = NULL);

        virtual void RemoveMode(Channel* channel, irc::modestacker* stack = NULL);

        char GetNeededPrefix();

        void SetNeededPrefix(char needsprefix);
};

class CoreExport SimpleUserModeHandler : public ModeHandler
{
 public:
        SimpleUserModeHandler(InspIRCd* Instance, char modeletter);
        virtual ~SimpleUserModeHandler();
        virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding, bool servermode = false);
};

class CoreExport SimpleChannelModeHandler : public ModeHandler
{
 public:
        SimpleChannelModeHandler(InspIRCd* Instance, char modeletter);
        virtual ~SimpleChannelModeHandler();
        virtual ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding, bool servermode = false);
};

class CoreExport ModeWatcher : public Extensible
{
 protected:
        InspIRCd* ServerInstance;
        char mode;
        ModeType m_type;

 public:
        ModeWatcher(InspIRCd* Instance, char modeletter, ModeType type);
        virtual ~ModeWatcher();

        char GetModeChar();
        ModeType GetModeType();

        virtual bool BeforeMode(User* source, User* dest, Channel* channel, std::string &parameter, bool adding, ModeType type, bool servermode = false);
        virtual void AfterMode(User* source, User* dest, Channel* channel, const std::string &parameter, bool adding, ModeType type, bool servermode = false);
};

typedef std::vector<ModeWatcher*>::iterator ModeWatchIter;

class CoreExport ModeParser : public classbase
{
 private:
        InspIRCd* ServerInstance;
        ModeHandler* modehandlers[256];
        std::vector<ModeWatcher*> modewatchers[256];
        void DisplayCurrentModes(User *user, User* targetuser, Channel* targetchannel, const char* text);

        std::string LastParse;

        unsigned int sent[256];

        unsigned int seq;

 public:

        ModeParser(InspIRCd* Instance);

        User* SanityChecks(User *user,const char *dest,Channel *chan,int status);
        const char* Grant(User *d,Channel *chan,int MASK);
        const char* Revoke(User *d,Channel *chan,int MASK);
        static void CleanMask(std::string &mask);
        const std::string& GetLastParse();
        bool AddMode(ModeHandler* mh);
        bool DelMode(ModeHandler* mh);
        bool AddModeWatcher(ModeWatcher* mw);
        bool DelModeWatcher(ModeWatcher* mw);
        void Process(const std::vector<std::string>& parameters, User *user, bool servermode);

        ModeHandler* FindMode(unsigned const char modeletter, ModeType mt);

        ModeHandler* FindPrefix(unsigned const char pfxletter);

        std::string UserModeList();

        std::string ChannelModeList();

        std::string ParaModeList();

        std::string GiveModeList(ModeMasks m);

        static bool PrefixComparison(prefixtype one, prefixtype two);

        std::string BuildPrefixes();

        std::string ModeString(User* user, Channel* channel, bool nick_suffix = true);
};

#endif