include/mode.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
   6  *                       E-mail:
   7  *                <brain@chatspike.net>
   8  *                <Craig@chatspike.net>
   9  *
  10  * Written by Craig Edwards, Craig McLure, and others.
  11  * This program is free but copyrighted software; see
  12  *            the file COPYING for details.
  13  *
  14  * ---------------------------------------------------
  15  */
  16
  17 #ifndef __MODE_H
  18 #define __MODE_H
  19
  20 // include the common header files
  21
  22 #include <typeinfo>
  23 #include <iostream>
  24 #include <string>
  25 #include <deque>
  26 #include <sstream>
  27 #include <vector>
  28 #include "users.h"
  29 #include "channels.h"
  30 #include "ctables.h"
  31
  32 enum UserModeBits {
  33         UM_INVISIBLE = 1,
  34         UM_SERVERNOTICE = 2,
  35         UM_WALLOPS = 4
  36 };
  37
  38 enum ModeType {
  39         MODETYPE_USER = 0,
  40         MODETYPE_CHANNEL = 1
  41 };
  42
  43 enum ModeAction {
  44         MODEACTION_DENY = 0, /* Drop the mode change, AND a parameter if its a parameterized mode */
  45         MODEACTION_ALLOW = 1 /* Allow the mode */
  46 };
  47
  48 class ModeHandler
  49 {
  50         char mode;
  51         int n_params;
  52         bool list;
  53         ModeType m_type;
  54         bool oper;
  55
  56  public:
  57         ModeHandler(char modeletter, int parameters, bool listmode, ModeType type, bool operonly);
  58         virtual ~ModeHandler();
  59
  60         bool IsListMode();
  61         ModeType GetModeType();
  62         bool NeedsOper();
  63         int GetNumParams();
  64         char GetModeChar();
  65
  66         virtual ModeAction OnModeChange(userrec* source, userrec* dest, chanrec* channel, std::string &parameter, bool adding); /* Can change the mode parameter as its a ref */
  67         virtual void DisplayList(userrec* user, chanrec* channel);
  68         virtual bool CheckTimeStamp(time_t theirs, time_t ours, const std::string &their_param, const std::string &our_param, chanrec* channel);
  69 };
  70
  71 class ModeWatcher
  72 {
  73         char mode;
  74         ModeType m_type;
  75
  76  public:
  77         ModeWatcher(char modeletter, ModeType type);
  78         virtual ~ModeWatcher();
  79
  80         char GetModeChar();
  81         ModeType GetModeType();
  82
  83         virtual bool BeforeMode(userrec* source, userrec* dest, chanrec* channel, std::string &parameter, bool adding, ModeType type); /* Can change the mode parameter */
  84         virtual void AfterMode(userrec* source, userrec* dest, chanrec* channel, const std::string &parameter, bool adding, ModeType type);
  85 };
  86
  87 class ModeParser
  88 {
  89  private:
  90         /**
  91          * Mode handlers for each mode, to access a handler subtract
  92          * 65 from the ascii value of the mode letter.
  93          */
  94         ModeHandler* modehandlers[64];
  95         /**
  96          * Mode watcher classes
  97          */
  98         std::vector<ModeWatcher*> modewatchers[65];
  99
 100         char* GiveOps(userrec *user,char *dest,chanrec *chan,int status);
 101         char* GiveHops(userrec *user,char *dest,chanrec *chan,int status);
 102         char* GiveVoice(userrec *user,char *dest,chanrec *chan,int status);
 103         char* TakeOps(userrec *user,char *dest,chanrec *chan,int status);
 104         char* TakeHops(userrec *user,char *dest,chanrec *chan,int status);
 105         char* TakeVoice(userrec *user,char *dest,chanrec *chan,int status);
 106         char* AddBan(userrec *user,char *dest,chanrec *chan,int status);
 107         char* TakeBan(userrec *user,char *dest,chanrec *chan,int status);
 108         userrec* SanityChecks(userrec *user,char *dest,chanrec *chan,int status);
 109         char* Grant(userrec *d,chanrec *chan,int MASK);
 110         char* Revoke(userrec *d,chanrec *chan,int MASK);
 111  public:
 112         void Process(char **parameters, int pcnt, userrec *user);
 113         std::string CompressModes(std::string modes,bool channelmodes);
 114         void ProcessModes(char **parameters,userrec* user,chanrec *chan,int status, int pcnt, bool servermode, bool silent, bool local);
 115         bool AllowedUmode(char umode, char* sourcemodes,bool adding,bool serveroverride);
 116         bool ProcessModuleUmode(char umode, userrec* source, void* dest, bool adding);
 117         void ServerMode(char **parameters, int pcnt, userrec *user);
 118 };
 119
 120 class cmd_mode : public command_t
 121 {
 122  public:
 123         cmd_mode () : command_t("MODE",0,1) { }
 124         void Handle(char **parameters, int pcnt, userrec *user);
 125 };
 126
 127 #endif