Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

modules.h

Go to the documentation of this file.
00001 /*
00002 
00003 
00004 
00005 */
00006 
00007 
00008 #ifndef __PLUGIN_H
00009 #define __PLUGIN_H
00010 
00011 // log levels
00012 
00013 #define DEBUG 10
00014 #define VERBOSE 20
00015 #define DEFAULT 30
00016 #define SPARSE 40
00017 #define NONE 50
00018 
00019 // used with OnExtendedMode() method of modules
00020 
00021 #define MT_CHANNEL 1
00022 #define MT_CLIENT 2
00023 #define MT_SERVER 3
00024 
00025 // used with OnAccessCheck() method of modules
00026 
00027 #define ACR_DEFAULT 0           // Do default action (act as if the module isnt even loaded)
00028 #define ACR_DENY 1              // deny the action
00029 #define ACR_ALLOW 2             // allow the action
00030 
00031 #define AC_KICK 0               // a user is being kicked
00032 #define AC_DEOP 1               // a user is being deopped
00033 #define AC_OP 2                 // a user is being opped
00034 #define AC_VOICE 3              // a user is being voiced
00035 #define AC_DEVOICE 4            // a user is being devoiced
00036 #define AC_HALFOP 5             // a user is being halfopped
00037 #define AC_DEHALFOP 6           // a user is being dehalfopped
00038 #define AC_INVITE 7             // a user is being invited
00039 #define AC_GENERAL_MODE 8       // a user channel mode is being changed
00040 
00041 #include "dynamic.h"
00042 #include "base.h"
00043 #include "ctables.h"
00044 #include <string>
00045 #include <deque>
00046 #include <sstream>
00047 
00050 typedef std::deque<std::string> file_cache;
00051 typedef file_cache string_list;
00052 
00055 typedef std::deque<userrec*> chanuserlist;
00056 
00057 
00058 // This #define allows us to call a method in all
00059 // loaded modules in a readable simple way, e.g.:
00060 // 'FOREACH_MOD OnConnect(user);'
00061 
00062 #define FOREACH_MOD for (int i = 0; i <= MODCOUNT; i++) modules[i]->
00063 
00064 // This define is similar to the one above but returns a result in MOD_RESULT.
00065 // The first module to return a nonzero result is the value to be accepted,
00066 // and any modules after are ignored.
00067 
00068 // *********************************************************************************************
00069 
00070 #define FOREACH_RESULT(x) { MOD_RESULT = 0; \
00071                         for (int i = 0; i <= MODCOUNT; i++) { \
00072                         int res = modules[i]->x ; \
00073                         if (res) { \
00074                                 MOD_RESULT = res; \
00075                                 break; \
00076                         } \
00077                 } \
00078    } 
00079    
00080 // *********************************************************************************************
00081 
00082 extern void createcommand(char* cmd, handlerfunc f, char flags, int minparams);
00083 extern void server_mode(char **parameters, int pcnt, userrec *user);
00084 
00085 // class Version holds the version information of a Module, returned
00086 // by Module::GetVersion (thanks RD)
00087 
00092 class Version : public classbase
00093 {
00094  public:
00095          const int Major, Minor, Revision, Build;
00096          Version(int major, int minor, int revision, int build);
00097 };
00098 
00104 class Admin : public classbase
00105 {
00106  public:
00107          const std::string Name, Email, Nick;
00108          Admin(std::string name, std::string email, std::string nick);
00109 };
00110 
00116 class Module : public classbase
00117 {
00118  public:
00119 
00123         Module();
00124 
00128         virtual ~Module();
00129 
00134         virtual Version GetVersion();
00135 
00139         virtual void OnUserConnect(userrec* user);
00140 
00144         virtual void OnUserQuit(userrec* user);
00145 
00150         virtual void OnUserJoin(userrec* user, chanrec* channel);
00151 
00156         virtual void OnUserPart(userrec* user, chanrec* channel);
00157 
00164         virtual void OnPacketTransmit(char *p);
00165 
00173         virtual void OnPacketReceive(char *p);
00174 
00180         virtual void OnRehash();
00181 
00190         virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
00191 
00201         virtual int OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list &params);
00202         
00215         virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname);
00216         
00217         
00222         virtual void OnOper(userrec* user);
00223         
00232         virtual void OnInfo(userrec* user);
00233         
00238         virtual void OnWhois(userrec* source, userrec* dest);
00239         
00248         virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string text);
00249 
00258         virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string text);
00259         
00267         virtual int OnUserPreNick(userrec* user, std::string newnick);
00268         
00291         virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type);
00297         virtual string_list OnUserSync(userrec* user);
00298 
00304         virtual string_list OnChannelSync(chanrec* chan);
00305 };
00306 
00307 
00313 class Server : public classbase
00314 {
00315  public:
00319         Server();
00323         virtual ~Server();
00324 
00328         virtual void SendOpers(std::string s);
00333         virtual void Log(int level, std::string s);
00338         virtual void Send(int Socket, std::string s);
00343         virtual void SendServ(int Socket, std::string s);
00348         virtual void SendFrom(int Socket, userrec* User, std::string s);
00363         virtual void SendTo(userrec* Source, userrec* Dest, std::string s);
00370         virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender);
00375         virtual bool CommonChannels(userrec* u1, userrec* u2);
00383         virtual void SendCommon(userrec* User, std::string text,bool IncludeSender);
00388         virtual void SendWallops(userrec* User, std::string text);
00389 
00393         virtual bool IsNick(std::string nick);
00397         virtual int CountUsers(chanrec* c);
00401         virtual userrec* FindNick(std::string nick);
00405         virtual chanrec* FindChannel(std::string channel);
00410         virtual std::string ChanMode(userrec* User, chanrec* Chan);
00414         virtual bool IsOnChannel(userrec* User, chanrec* Chan);
00417         virtual std::string GetServerName();
00420         virtual std::string GetNetworkName();
00426         virtual Admin GetAdmin();
00445         virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off);
00446 
00468         virtual bool AddExtendedListMode(char modechar);
00469         
00484         virtual void AddCommand(char* cmd, handlerfunc f, char flags, int minparams);
00485          
00507         virtual void SendMode(char **parameters, int pcnt, userrec *user);
00508         
00521         virtual void SendToModeMask(std::string modes, int flags, std::string text);
00522 
00528         virtual chanrec* JoinUserToChannel(userrec* user, std::string cname, std::string key);
00529         
00535         virtual chanrec* PartUserFromChannel(userrec* user, std::string cname, std::string reason);
00536         
00542         virtual void ChangeUserNick(userrec* user, std::string nickname);
00543         
00554         virtual void QuitUser(userrec* user, std::string reason);
00555         
00560         virtual bool MatchText(std::string sliteral, std::string spattern);
00561         
00573         virtual void CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user);
00574         
00580         virtual void ChangeHost(userrec* user, std::string host);
00581         
00587         virtual void ChangeGECOS(userrec* user, std::string gecos);
00588         
00597         virtual bool IsUlined(std::string server);
00598         
00602         virtual chanuserlist GetUsers(chanrec* chan);
00603 
00604 };
00605 
00612 class ConfigReader : public classbase
00613 {
00614   protected:
00620         std::stringstream *cache;
00623         bool error;
00624         
00625   public:
00630         ConfigReader();                 // default constructor reads ircd.conf
00634         ConfigReader(std::string filename);     // read a module-specific config
00638         ~ConfigReader();
00643         std::string ReadValue(std::string tag, std::string name, int index);
00650         int Enumerate(std::string tag);
00655         bool Verify();
00656 
00662         int EnumerateValues(std::string tag, int index);
00663 };
00664 
00665 
00666 
00672 class FileReader : public classbase
00673 {
00674  file_cache fc;
00675  public:
00680          FileReader();
00681 
00687          FileReader(std::string filename);
00688 
00692          ~FileReader();
00693 
00699          void LoadFile(std::string filename);
00700 
00704          bool Exists();
00705          
00710          std::string GetLine(int x);
00711 
00717          int FileSize();
00718 };
00719 
00720 
00727 class ModuleFactory : public classbase
00728 {
00729  public:
00730         ModuleFactory() { }
00731         virtual ~ModuleFactory() { }
00736         virtual Module * CreateModule() = 0;
00737 };
00738 
00739 
00740 typedef DLLFactory<ModuleFactory> ircd_module;
00741 
00742 #endif

Generated on Sat May 1 17:50:07 2004 for InspIRCd by doxygen1.3-rc3