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 #define DEBUG 10
00012 #define VERBOSE 20
00013 #define DEFAULT 30
00014 #define SPARSE 40
00015 #define NONE 50
00016 
00017 #define MT_CHANNEL 1
00018 #define MT_CLIENT 2
00019 #define MT_SERVER 3
00020 
00021 #include "dynamic.h"
00022 #include "base.h"
00023 #include "ctables.h"
00024 #include <string>
00025 #include <deque>
00026 #include <sstream>
00027 
00030 typedef std::deque<std::string> file_cache;
00031 typedef file_cache string_list;
00032 
00033 
00034 // This #define allows us to call a method in all
00035 // loaded modules in a readable simple way, e.g.:
00036 // 'FOREACH_MOD OnConnect(user);'
00037 
00038 #define FOREACH_MOD for (int i = 0; i <= MODCOUNT; i++) modules[i]->
00039 
00040 // This define is similar to the one above but returns a result in MOD_RESULT.
00041 // The first module to return a nonzero result is the value to be accepted,
00042 // and any modules after are ignored.
00043 
00044 // *********************************************************************************************
00045 
00046 #define FOREACH_RESULT(x) { MOD_RESULT = 0; \
00047                         for (int i = 0; i <= MODCOUNT; i++) { \
00048                         int res = modules[i]->x ; \
00049                         if (res) { \
00050                                 MOD_RESULT = res; \
00051                                 break; \
00052                         } \
00053                 } \
00054    } 
00055    
00056 // *********************************************************************************************
00057 
00058 extern void createcommand(char* cmd, handlerfunc f, char flags, int minparams);
00059 extern void server_mode(char **parameters, int pcnt, userrec *user);
00060 
00061 // class Version holds the version information of a Module, returned
00062 // by Module::GetVersion (thanks RD)
00063 
00068 class Version : public classbase
00069 {
00070  public:
00071          const int Major, Minor, Revision, Build;
00072          Version(int major, int minor, int revision, int build);
00073 };
00074 
00080 class Admin : public classbase
00081 {
00082  public:
00083          const std::string Name, Email, Nick;
00084          Admin(std::string name, std::string email, std::string nick);
00085 };
00086 
00092 class Module : public classbase
00093 {
00094  public:
00095 
00099         Module();
00100 
00104         virtual ~Module();
00105 
00110         virtual Version GetVersion();
00111 
00115         virtual void OnUserConnect(userrec* user);
00116 
00120         virtual void OnUserQuit(userrec* user);
00121 
00126         virtual void OnUserJoin(userrec* user, chanrec* channel);
00127 
00132         virtual void OnUserPart(userrec* user, chanrec* channel);
00133 
00140         virtual void OnPacketTransmit(char *p);
00141 
00149         virtual void OnPacketReceive(char *p);
00150 
00156         virtual void OnRehash();
00157 
00164         virtual void OnServerRaw(std::string &raw, bool inbound);
00165 
00175         virtual bool OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list &params);
00176         
00189         virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname);
00190         
00191         
00196         virtual void OnOper(userrec* user);
00197         
00206         virtual void OnInfo(userrec* user);
00207         
00212         virtual void OnWhois(userrec* source, userrec* dest);
00213         
00222         virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string text);
00223 
00232         virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string text);
00233 };
00234 
00235 
00241 class Server : public classbase
00242 {
00243  public:
00247         Server();
00251         virtual ~Server();
00252 
00256         virtual void SendOpers(std::string s);
00261         virtual void Log(int level, std::string s);
00266         virtual void Send(int Socket, std::string s);
00271         virtual void SendServ(int Socket, std::string s);
00276         virtual void SendFrom(int Socket, userrec* User, std::string s);
00291         virtual void SendTo(userrec* Source, userrec* Dest, std::string s);
00298         virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender);
00303         virtual bool CommonChannels(userrec* u1, userrec* u2);
00311         virtual void SendCommon(userrec* User, std::string text,bool IncludeSender);
00316         virtual void SendWallops(userrec* User, std::string text);
00317 
00321         virtual bool IsNick(std::string nick);
00325         virtual int CountUsers(chanrec* c);
00329         virtual userrec* FindNick(std::string nick);
00333         virtual chanrec* FindChannel(std::string channel);
00338         virtual std::string ChanMode(userrec* User, chanrec* Chan);
00341         virtual std::string GetServerName();
00344         virtual std::string GetNetworkName();
00350         virtual Admin GetAdmin();
00369         virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off);
00370 
00385         virtual void AddCommand(char* cmd, handlerfunc f, char flags, int minparams);
00386          
00408         virtual void SendMode(char **parameters, int pcnt, userrec *user);
00409         
00422         virtual void SendToModeMask(std::string modes, int flags, std::string text);
00423 
00429         virtual chanrec* JoinUserToChannel(userrec* user, std::string cname, std::string key);
00430         
00436         virtual chanrec* PartUserFromChannel(userrec* user, std::string cname, std::string reason);
00437         
00443         virtual void ChangeUserNick(userrec* user, std::string nickname);
00444         
00455         virtual void QuitUser(userrec* user, std::string reason);
00456         
00461         virtual bool MatchText(std::string sliteral, std::string spattern);
00462         
00474         virtual void CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user);
00475         
00481         virtual void ChangeHost(userrec* user, std::string host);
00482         
00488         virtual void ChangeGECOS(userrec* user, std::string gecos);
00489 };
00490 
00497 class ConfigReader : public classbase
00498 {
00499   protected:
00505         std::stringstream *cache;
00508         bool error;
00509         
00510   public:
00515         ConfigReader();                 // default constructor reads ircd.conf
00519         ConfigReader(std::string filename);     // read a module-specific config
00523         ~ConfigReader();
00528         std::string ReadValue(std::string tag, std::string name, int index);
00535         int Enumerate(std::string tag);
00540         bool Verify();
00541 
00547         int EnumerateValues(std::string tag, int index);
00548 };
00549 
00550 
00551 
00557 class FileReader : public classbase
00558 {
00559  file_cache fc;
00560  public:
00565          FileReader();
00566 
00572          FileReader(std::string filename);
00573 
00577          ~FileReader();
00578 
00584          void LoadFile(std::string filename);
00585 
00589          bool Exists();
00590          
00595          std::string GetLine(int x);
00596 
00602          int FileSize();
00603 };
00604 
00605 
00612 class ModuleFactory : public classbase
00613 {
00614  public:
00615         ModuleFactory() { }
00616         virtual ~ModuleFactory() { }
00621         virtual Module * CreateModule() = 0;
00622 };
00623 
00624 
00625 typedef DLLFactory<ModuleFactory> ircd_module;
00626 
00627 #endif

Generated on Sat Apr 17 13:33:44 2004 for InspIRCd by doxygen1.3-rc3