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  *       | Inspire Internet Relay Chat Daemon |
00003  *       +------------------------------------+
00004  *
00005  *  Inspire is copyright (C) 2002-2004 ChatSpike-Dev.
00006  *                       E-mail:
00007  *                <brain@chatspike.net>
00008  *                <Craig@chatspike.net>
00009  *     
00010  * Written by Craig Edwards, Craig McLure, and others.
00011  * This program is free but copyrighted software; see
00012  *            the file COPYING for details.
00013  *
00014  * ---------------------------------------------------
00015  */
00016 
00017 
00018 #ifndef __PLUGIN_H
00019 #define __PLUGIN_H
00020 
00021 // log levels
00022 
00023 #define DEBUG 10
00024 #define VERBOSE 20
00025 #define DEFAULT 30
00026 #define SPARSE 40
00027 #define NONE 50
00028 
00029 // used with OnExtendedMode() method of modules
00030 
00031 #define MT_CHANNEL 1
00032 #define MT_CLIENT 2
00033 #define MT_SERVER 3
00034 
00035 // used with OnAccessCheck() method of modules
00036 
00037 #define ACR_DEFAULT 0           // Do default action (act as if the module isnt even loaded)
00038 #define ACR_DENY 1              // deny the action
00039 #define ACR_ALLOW 2             // allow the action
00040 
00041 #define AC_KICK 0               // a user is being kicked
00042 #define AC_DEOP 1               // a user is being deopped
00043 #define AC_OP 2                 // a user is being opped
00044 #define AC_VOICE 3              // a user is being voiced
00045 #define AC_DEVOICE 4            // a user is being devoiced
00046 #define AC_HALFOP 5             // a user is being halfopped
00047 #define AC_DEHALFOP 6           // a user is being dehalfopped
00048 #define AC_INVITE 7             // a user is being invited
00049 #define AC_GENERAL_MODE 8       // a user channel mode is being changed
00050 
00051 // used to define a set of behavior bits for a module
00052 
00053 #define VF_STATIC               1       // module is static, cannot be /unloadmodule'd
00054 #define VF_VENDOR               2       // module is a vendor module (came in the original tarball, not 3rd party)
00055 #define VF_SERVICEPROVIDER      4       // module provides a service to other modules (can be a dependency)
00056 #define VF_COMMON               8       // module needs to be common on all servers in a mesh to link
00057 
00058 #include "dynamic.h"
00059 #include "base.h"
00060 #include "ctables.h"
00061 #include <string>
00062 #include <deque>
00063 #include <sstream>
00064 
00067 typedef std::deque<std::string> file_cache;
00068 typedef file_cache string_list;
00069 
00072 typedef std::deque<userrec*> chanuserlist;
00073 
00074 
00075 // This #define allows us to call a method in all
00076 // loaded modules in a readable simple way, e.g.:
00077 // 'FOREACH_MOD OnConnect(user);'
00078 
00079 #define FOREACH_MOD for (int i = 0; i <= MODCOUNT; i++) modules[i]->
00080 
00081 // This define is similar to the one above but returns a result in MOD_RESULT.
00082 // The first module to return a nonzero result is the value to be accepted,
00083 // and any modules after are ignored.
00084 
00085 // *********************************************************************************************
00086 
00087 #define FOREACH_RESULT(x) { MOD_RESULT = 0; \
00088                         for (int i = 0; i <= MODCOUNT; i++) { \
00089                         int res = modules[i]->x ; \
00090                         if (res != 0) { \
00091                                 MOD_RESULT = res; \
00092                                 break; \
00093                         } \
00094                 } \
00095         } 
00096    
00097 // *********************************************************************************************
00098 
00099 #define FD_MAGIC_NUMBER -42
00100 
00101 extern void createcommand(char* cmd, handlerfunc f, char flags, int minparams, char* source);
00102 extern void server_mode(char **parameters, int pcnt, userrec *user);
00103 
00104 // class Version holds the version information of a Module, returned
00105 // by Module::GetVersion (thanks RD)
00106 
00111 class Version : public classbase
00112 {
00113  public:
00114          const int Major, Minor, Revision, Build, Flags;
00115          Version(int major, int minor, int revision, int build, int flags);
00116 };
00117 
00123 class Admin : public classbase
00124 {
00125  public:
00126          const std::string Name, Email, Nick;
00127          Admin(std::string name, std::string email, std::string nick);
00128 };
00129 
00135 class Module : public classbase
00136 {
00137  public:
00138 
00142         Module();
00143 
00147         virtual ~Module();
00148 
00153         virtual Version GetVersion();
00154 
00158         virtual void OnUserConnect(userrec* user);
00159 
00163         virtual void OnUserQuit(userrec* user);
00164 
00169         virtual void OnUserJoin(userrec* user, chanrec* channel);
00170 
00175         virtual void OnUserPart(userrec* user, chanrec* channel);
00176 
00182         virtual void OnPacketTransmit(std::string &data, std::string serv);
00183 
00190         virtual void OnPacketReceive(std::string &data, std::string serv);
00191 
00197         virtual void OnRehash();
00198 
00207         virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
00208 
00218         virtual int OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list &params);
00219         
00233         virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname);
00234         
00240         virtual int OnUserPreKick(userrec* source, userrec* user, chanrec* chan, std::string reason);
00241 
00246         virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, std::string reason);
00247 
00252         virtual void OnOper(userrec* user);
00253         
00262         virtual void OnInfo(userrec* user);
00263         
00268         virtual void OnWhois(userrec* source, userrec* dest);
00269         
00275         virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel);
00276         
00285         virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text);
00286 
00298         virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text);
00299         
00307         virtual int OnUserPreNick(userrec* user, std::string newnick);
00308         
00316         virtual void OnUserPostNick(userrec* user, std::string oldnick);
00317 
00339         virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type);
00340 
00346         virtual string_list OnUserSync(userrec* user);
00347 
00353         virtual string_list OnChannelSync(chanrec* chan);
00354 
00358         virtual void On005Numeric(std::string &output);
00359 
00369         virtual int OnKill(userrec* source, userrec* dest, std::string reason);
00370 
00381         virtual void OnLoadModule(Module* mod,std::string name);
00382 
00388         virtual void OnBackgroundTimer(time_t curtime);
00389 
00397         virtual void OnSendList(userrec* user, chanrec* channel, char mode);
00398 
00409         virtual int OnPreCommand(std::string command, char **parameters, int pcnt, userrec *user);
00410 
00419         virtual bool OnCheckReady(userrec* user);
00420 
00428         virtual void OnUserRegister(userrec* user);
00429 
00435         virtual int OnRawMode(userrec* user, chanrec* chan, char mode, std::string param, bool adding, int pcnt);
00436 
00442         virtual int OnCheckInvite(userrec* user, chanrec* chan);
00443 
00450         virtual int OnCheckKey(userrec* user, chanrec* chan, std::string keygiven);
00451 
00457         virtual int OnCheckLimit(userrec* user, chanrec* chan);
00458 
00464         virtual int OnCheckBan(userrec* user, chanrec* chan);
00465 
00469         virtual void OnStats(char symbol);
00470 
00474         virtual int OnChangeLocalUserHost(userrec* user, std::string newhost);
00475 
00479         virtual int OnChangeLocalUserGECOS(userrec* user, std::string newhost); 
00480 
00484         virtual int OnLocalTopicChange(userrec* user, chanrec* chan, std::string topic);
00485 
00496         virtual int OnMeshToken(char token,string_list params,serverrec* source,serverrec* reply, std::string tcp_host,std::string ipaddr,int port);
00497 };
00498 
00499 
00505 class Server : public classbase
00506 {
00507  public:
00511         Server();
00515         virtual ~Server();
00516 
00520         virtual void SendOpers(std::string s);
00525         virtual void Log(int level, std::string s);
00530         virtual void Send(int Socket, std::string s);
00535         virtual void SendServ(int Socket, std::string s);
00540         virtual void SendFrom(int Socket, userrec* User, std::string s);
00555         virtual void SendTo(userrec* Source, userrec* Dest, std::string s);
00562         virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender);
00567         virtual bool CommonChannels(userrec* u1, userrec* u2);
00575         virtual void SendCommon(userrec* User, std::string text,bool IncludeSender);
00580         virtual void SendWallops(userrec* User, std::string text);
00581 
00585         virtual bool IsNick(std::string nick);
00589         virtual int CountUsers(chanrec* c);
00593         virtual userrec* FindNick(std::string nick);
00597         virtual chanrec* FindChannel(std::string channel);
00602         virtual std::string ChanMode(userrec* User, chanrec* Chan);
00606         virtual bool IsOnChannel(userrec* User, chanrec* Chan);
00609         virtual std::string GetServerName();
00612         virtual std::string GetNetworkName();
00618         virtual Admin GetAdmin();
00637         virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off);
00638 
00660         virtual bool AddExtendedListMode(char modechar);
00661 
00679         virtual void AddCommand(char* cmd, handlerfunc f, char flags, int minparams, char* source);
00680          
00702         virtual void SendMode(char **parameters, int pcnt, userrec *user);
00703         
00716         virtual void SendToModeMask(std::string modes, int flags, std::string text);
00717 
00723         virtual chanrec* JoinUserToChannel(userrec* user, std::string cname, std::string key);
00724         
00730         virtual chanrec* PartUserFromChannel(userrec* user, std::string cname, std::string reason);
00731         
00737         virtual void ChangeUserNick(userrec* user, std::string nickname);
00738         
00749         virtual void QuitUser(userrec* user, std::string reason);
00750         
00755         virtual bool MatchText(std::string sliteral, std::string spattern);
00756         
00768         virtual void CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user);
00769         
00775         virtual void ChangeHost(userrec* user, std::string host);
00776         
00782         virtual void ChangeGECOS(userrec* user, std::string gecos);
00783         
00792         virtual bool IsUlined(std::string server);
00793         
00797         virtual chanuserlist GetUsers(chanrec* chan);
00798 
00805         virtual bool UserToPseudo(userrec* user,std::string message);
00806 
00813         virtual bool PseudoToUser(userrec* alive,userrec* zombie,std::string message);
00814 
00822         virtual void AddGLine(long duration, std::string source, std::string reason, std::string hostmask);
00823 
00831         virtual void AddQLine(long duration, std::string source, std::string reason, std::string nickname);
00832 
00840         virtual void AddZLine(long duration, std::string source, std::string reason, std::string ipaddr);
00841 
00849         virtual void AddKLine(long duration, std::string source, std::string reason, std::string hostmask);
00850 
00858         virtual void AddELine(long duration, std::string source, std::string reason, std::string hostmask);
00859 
00862         virtual bool DelGLine(std::string hostmask);
00863 
00866         virtual bool DelQLine(std::string nickname);
00867 
00870         virtual bool DelZLine(std::string ipaddr);
00871 
00874         virtual bool DelKLine(std::string hostmask);
00875 
00878         virtual bool DelELine(std::string hostmask);
00879 
00885         virtual long CalcDuration(std::string duration);
00886 
00889         virtual bool IsValidMask(std::string mask);
00890 
00895         virtual void MeshSendAll(std::string text);
00896 
00903         virtual void MeshSendCommon(userrec* user, std::string text);
00904 
00907         virtual void MeshSendAllAlive(std::string text);
00908 
00912         virtual void MeshSendUnicast(std::string destination, std::string text);
00913 
00918         virtual void MeshSendAllExcept(std::string target, std::string text);
00919 
00923         virtual bool MeshCheckChan(chanrec *c,std::string servername);
00924 
00928         virtual bool MeshCheckCommon(userrec* u,std::string servername);
00929 };
00930 
00931 
00932 #define CONF_NOT_A_NUMBER       0x000010
00933 #define CONF_NOT_UNSIGNED       0x000080
00934 #define CONF_VALUE_NOT_FOUND    0x000100
00935 #define CONF_FILE_NOT_FOUND     0x000200
00936 
00937 
00944 class ConfigReader : public classbase
00945 {
00946   protected:
00952         std::stringstream *cache;
00953         std::stringstream *errorlog;
00956         bool readerror;
00957         long error;
00958         
00959   public:
00964         ConfigReader();                 // default constructor reads ircd.conf
00968         ConfigReader(std::string filename);     // read a module-specific config
00972         ~ConfigReader();
00977         std::string ReadValue(std::string tag, std::string name, int index);
00983         bool ReadFlag(std::string tag, std::string name, int index);
00992         long ReadInteger(std::string tag, std::string name, int index, bool needs_unsigned);
00997         long GetError();
01004         int Enumerate(std::string tag);
01009         bool Verify();
01016         void DumpErrors(bool bail,userrec* user);
01017 
01023         int EnumerateValues(std::string tag, int index);
01024 };
01025 
01026 
01027 
01033 class FileReader : public classbase
01034 {
01035  file_cache fc;
01036  public:
01041          FileReader();
01042 
01048          FileReader(std::string filename);
01049 
01053          ~FileReader();
01054 
01060          void LoadFile(std::string filename);
01061 
01065          bool Exists();
01066          
01071          std::string GetLine(int x);
01072 
01078          int FileSize();
01079 };
01080 
01081 
01088 class ModuleFactory : public classbase
01089 {
01090  public:
01091         ModuleFactory() { }
01092         virtual ~ModuleFactory() { }
01097         virtual Module * CreateModule() = 0;
01098 };
01099 
01100 
01101 typedef DLLFactory<ModuleFactory> ircd_module;
01102 
01103 #endif

Generated on Sat Apr 16 18:57:13 2005 for InspIRCd by doxygen 1.3.3