Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class 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 
00023 #define DEBUG 10
00024 #define VERBOSE 20
00025 #define DEFAULT 30
00026 #define SPARSE 40
00027 #define NONE 50
00028 
00031 #define MT_CHANNEL 1
00032 #define MT_CLIENT 2
00033 #define MT_SERVER 3
00034 
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 #define AC_KICK 0               // a user is being kicked
00041 #define AC_DEOP 1               // a user is being deopped
00042 #define AC_OP 2                 // a user is being opped
00043 #define AC_VOICE 3              // a user is being voiced
00044 #define AC_DEVOICE 4            // a user is being devoiced
00045 #define AC_HALFOP 5             // a user is being halfopped
00046 #define AC_DEHALFOP 6           // a user is being dehalfopped
00047 #define AC_INVITE 7             // a user is being invited
00048 #define AC_GENERAL_MODE 8       // a user channel mode is being changed
00049 
00052 #define VF_STATIC               1       // module is static, cannot be /unloadmodule'd
00053 #define VF_VENDOR               2       // module is a vendor module (came in the original tarball, not 3rd party)
00054 #define VF_SERVICEPROVIDER      4       // module provides a service to other modules (can be a dependency)
00055 #define VF_COMMON               8       // module needs to be common on all servers in a mesh to link
00056 
00057 #include "dynamic.h"
00058 #include "base.h"
00059 #include "ctables.h"
00060 #include "socket.h"
00061 #include <string>
00062 #include <deque>
00063 #include <sstream>
00064 
00065 class Server;
00066 
00069 typedef std::deque<std::string> file_cache;
00070 typedef file_cache string_list;
00071 
00074 typedef std::deque<userrec*> chanuserlist;
00075 
00076 
00077 // This #define allows us to call a method in all
00078 // loaded modules in a readable simple way, e.g.:
00079 // 'FOREACH_MOD OnConnect(user);'
00080 
00081 #define FOREACH_MOD for (int _i = 0; _i <= MODCOUNT; _i++) modules[_i]->
00082 
00083 // This define is similar to the one above but returns a result in MOD_RESULT.
00084 // The first module to return a nonzero result is the value to be accepted,
00085 // and any modules after are ignored.
00086 
00087 // *********************************************************************************************
00088 
00089 #define FOREACH_RESULT(x) { MOD_RESULT = 0; \
00090                         for (int _i = 0; _i <= MODCOUNT; _i++) { \
00091                         int res = modules[_i]->x ; \
00092                         if (res != 0) { \
00093                                 MOD_RESULT = res; \
00094                                 break; \
00095                         } \
00096                 } \
00097         } 
00098    
00099 // *********************************************************************************************
00100 
00101 #define FD_MAGIC_NUMBER -42
00102 
00103 extern void createcommand(char* cmd, handlerfunc f, char flags, int minparams, char* source);
00104 extern void server_mode(char **parameters, int pcnt, userrec *user);
00105 
00106 // class Version holds the version information of a Module, returned
00107 // by Module::GetVersion (thanks RD)
00108 
00113 class Version : public classbase
00114 {
00115  public:
00116          const int Major, Minor, Revision, Build, Flags;
00117          Version(int major, int minor, int revision, int build, int flags);
00118 };
00119 
00125 class Admin : public classbase
00126 {
00127  public:
00128          const std::string Name, Email, Nick;
00129          Admin(std::string name, std::string email, std::string nick);
00130 };
00131 
00132 
00133 // Forward-delacare module for ModuleMessage etc
00134 class Module;
00135 
00136 // Thanks to Rob (from anope) for the idea of this message passing API
00137 // (its been done before, but this seemed a very neat and tidy way...
00138 
00143 class ModuleMessage : public classbase
00144 {
00145  public:
00148         virtual char* Send() = 0;
00149         virtual ~ModuleMessage() {};
00150 };
00151 
00157 class Request : public ModuleMessage
00158 {
00159  protected:
00162         char* data;
00166         Module* source;
00169         Module* dest;
00170  public:
00173         Request(char* anydata, Module* src, Module* dst);
00176         char* GetData();
00179         Module* GetSource();
00182         Module* GetDest();
00188         char* Send();
00189 };
00190 
00191 
00197 class Event : public ModuleMessage
00198 {
00199  protected:
00202         char* data;
00206         Module* source;
00211         std::string id;
00212  public:
00215         Event(char* anydata, Module* src, std::string eventid);
00218         char* GetData();
00221         Module* GetSource();
00225         std::string GetEventID();
00230         char* Send();
00231 };
00232 
00233 
00239 class Module : public classbase
00240 {
00241  public:
00242 
00247         Module(Server* Me);
00248 
00252         virtual ~Module();
00253 
00258         virtual Version GetVersion();
00259 
00264         virtual void OnUserConnect(userrec* user);
00265 
00273         virtual void OnUserQuit(userrec* user, std::string message);
00274 
00281         virtual void OnUserDisconnect(userrec* user);
00282 
00289         virtual void OnUserJoin(userrec* user, chanrec* channel);
00290 
00297         virtual void OnUserPart(userrec* user, chanrec* channel);
00298 
00306         virtual void OnRehash(std::string parameter);
00307 
00319         virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
00320 
00336         virtual int OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list &params);
00337         
00354         virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname);
00355         
00366         virtual int OnUserPreKick(userrec* source, userrec* user, chanrec* chan, std::string reason);
00367 
00376         virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, std::string reason);
00377 
00384         virtual void OnOper(userrec* user, std::string opertype);
00385         
00396         virtual void OnInfo(userrec* user);
00397         
00404         virtual void OnWhois(userrec* source, userrec* dest);
00405         
00415         virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel);
00416         
00424         virtual void OnUserInvite(userrec* source,userrec* dest,chanrec* channel);
00425         
00439         virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text);
00440 
00457         virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text);
00458         
00469         virtual int OnUserPreNick(userrec* user, std::string newnick);
00470 
00479         virtual void OnUserMessage(userrec* user, void* dest, int target_type, std::string text);
00480 
00489         virtual void OnUserNotice(userrec* user, void* dest, int target_type, std::string text);
00490 
00500         virtual void OnMode(userrec* user, void* dest, int target_type, std::string text);
00501 
00510         virtual void OnGetServerDescription(std::string servername,std::string &description);
00511 
00524         virtual void OnSyncUser(userrec* user, Module* proto, void* opaque);
00525 
00541         virtual void OnSyncChannel(chanrec* chan, Module* proto, void* opaque);
00542 
00543         /* Allows modules to syncronize metadata related to channels over the network during a netburst.
00544          * Whenever the linking module wants to send out data, but doesnt know what the data
00545          * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
00546          * this method is called.You should use the ProtoSendMetaData function after you've
00547          * correctly decided how the data should be represented, to send the metadata on its way if it belongs
00548          * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
00549          * @param chan The channel whos metadata is being syncronized
00550          * @param proto A pointer to the module handling network protocol
00551          * @param opaque An opaque pointer set by the protocol module, should not be modified!
00552          * @param extname The extensions name which is being searched for
00553          */
00554         virtual void OnSyncChannelMetaData(chanrec* chan, Module* proto,void* opaque, std::string extname);
00555 
00556         /* Allows modules to syncronize metadata related to users over the network during a netburst.
00557          * Whenever the linking module wants to send out data, but doesnt know what the data
00558          * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
00559          * this method is called. You should use the ProtoSendMetaData function after you've
00560          * correctly decided how the data should be represented, to send the metadata on its way if
00561          * if it belongs to your module.
00562          * @param user The user whos metadata is being syncronized
00563          * @param proto A pointer to the module handling network protocol
00564          * @param opaque An opaque pointer set by the protocol module, should not be modified!
00565          * @param extname The extensions name which is being searched for
00566          */
00567         virtual void OnSyncUserMetaData(userrec* user, Module* proto,void* opaque, std::string extname);
00568 
00576         virtual void OnDecodeMetaData(int target_type, void* target, std::string extname, std::string extdata);
00577 
00591         virtual void ProtoSendMode(void* opaque, int target_type, void* target, std::string modeline);
00592 
00607         virtual void ProtoSendMetaData(void* opaque, int target_type, void* target, std::string extname, std::string extdata);
00608         
00613         virtual void OnWallops(userrec* user, std::string text);
00614 
00620         virtual void OnChangeHost(userrec* user, std::string newhost);
00621 
00627         virtual void OnChangeName(userrec* user, std::string gecos);
00628 
00636         virtual void OnAddGLine(long duration, userrec* source, std::string reason, std::string hostmask);
00637 
00645         virtual void OnAddZLine(long duration, userrec* source, std::string reason, std::string ipmask);
00646 
00654         virtual void OnAddKLine(long duration, userrec* source, std::string reason, std::string hostmask);
00655 
00663         virtual void OnAddQLine(long duration, userrec* source, std::string reason, std::string nickmask);
00664 
00672         virtual void OnAddELine(long duration, userrec* source, std::string reason, std::string hostmask);
00673 
00679         virtual void OnDelGLine(userrec* source, std::string hostmask);
00680 
00686         virtual void OnDelZLine(userrec* source, std::string ipmask);
00687 
00693         virtual void OnDelKLine(userrec* source, std::string hostmask);
00694         
00700         virtual void OnDelQLine(userrec* source, std::string nickmask);
00701 
00707         virtual void OnDelELine(userrec* source, std::string hostmask);
00708 
00718         virtual void OnCleanup(int target_type, void* item);
00719 
00729         virtual void OnUserPostNick(userrec* user, std::string oldnick);
00730 
00756         virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type);
00757 
00762         virtual void On005Numeric(std::string &output);
00763 
00777         virtual int OnKill(userrec* source, userrec* dest, std::string reason);
00778 
00784         virtual void OnRemoteKill(userrec* source, userrec* dest, std::string reason);
00785 
00798         virtual void OnLoadModule(Module* mod,std::string name);
00799 
00812         virtual void OnUnloadModule(Module* mod,std::string name);
00813 
00820         virtual void OnBackgroundTimer(time_t curtime);
00821 
00832         virtual void OnSendList(userrec* user, chanrec* channel, char mode);
00833 
00849         virtual int OnPreCommand(std::string command, char **parameters, int pcnt, userrec *user);
00850 
00861         virtual bool OnCheckReady(userrec* user);
00862 
00871         virtual void OnUserRegister(userrec* user);
00872 
00885         virtual int OnRawMode(userrec* user, chanrec* chan, char mode, std::string param, bool adding, int pcnt);
00886 
00895         virtual int OnCheckInvite(userrec* user, chanrec* chan);
00896 
00906         virtual int OnCheckKey(userrec* user, chanrec* chan, std::string keygiven);
00907 
00916         virtual int OnCheckLimit(userrec* user, chanrec* chan);
00917 
00926         virtual int OnCheckBan(userrec* user, chanrec* chan);
00927 
00932         virtual void OnStats(char symbol);
00933 
00940         virtual int OnChangeLocalUserHost(userrec* user, std::string newhost);
00941 
00948         virtual int OnChangeLocalUserGECOS(userrec* user, std::string newhost); 
00949 
00957         virtual int OnLocalTopicChange(userrec* user, chanrec* chan, std::string topic);
00958 
00965         virtual void OnPostLocalTopicChange(userrec* user, chanrec* chan, std::string topic);
00966 
00973         virtual void OnEvent(Event* event);
00974 
00982         virtual char* OnRequest(Request* request);
00983 
00993         virtual int OnOperCompare(std::string password, std::string input);
00994 
01001         virtual void OnGlobalOper(userrec* user);
01002 
01008         virtual void OnGlobalConnect(userrec* user);
01009 
01017         virtual int OnAddBan(userrec* source, chanrec* channel,std::string banmask);
01018 
01026         virtual int OnDelBan(userrec* source, chanrec* channel,std::string banmask);
01027 
01037         virtual void OnRawSocketAccept(int fd, std::string ip, int localport);
01038 
01049         virtual int OnRawSocketWrite(int fd, char* buffer, int count);
01050 
01055         virtual void OnRawSocketClose(int fd);
01056 
01072         virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
01073 };
01074 
01075 
01081 class Server : public classbase
01082 {
01083  public:
01087         Server();
01091         virtual ~Server();
01092 
01096         virtual void SendOpers(std::string s);
01101         virtual void Log(int level, std::string s);
01106         virtual void Send(int Socket, std::string s);
01111         virtual void SendServ(int Socket, std::string s);
01115         virtual void SendChannelServerNotice(std::string ServName, chanrec* Channel, std::string text);
01120         virtual void SendFrom(int Socket, userrec* User, std::string s);
01135         virtual void SendTo(userrec* Source, userrec* Dest, std::string s);
01142         virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender);
01147         virtual bool CommonChannels(userrec* u1, userrec* u2);
01155         virtual void SendCommon(userrec* User, std::string text,bool IncludeSender);
01160         virtual void SendWallops(userrec* User, std::string text);
01161 
01165         virtual bool IsNick(std::string nick);
01169         virtual int CountUsers(chanrec* c);
01173         virtual userrec* FindNick(std::string nick);
01177         virtual userrec* FindDescriptor(int socket);
01181         virtual chanrec* FindChannel(std::string channel);
01186         virtual std::string ChanMode(userrec* User, chanrec* Chan);
01190         virtual bool IsOnChannel(userrec* User, chanrec* Chan);
01193         virtual std::string GetServerName();
01196         virtual std::string GetNetworkName();
01199         virtual std::string GetServerDescription();
01205         virtual Admin GetAdmin();
01224         virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off);
01225 
01247         virtual bool AddExtendedListMode(char modechar);
01248 
01266         virtual void AddCommand(char* cmd, handlerfunc f, char flags, int minparams, char* source);
01267          
01289         virtual void SendMode(char **parameters, int pcnt, userrec *user);
01290         
01303         virtual void SendToModeMask(std::string modes, int flags, std::string text);
01304 
01310         virtual chanrec* JoinUserToChannel(userrec* user, std::string cname, std::string key);
01311         
01317         virtual chanrec* PartUserFromChannel(userrec* user, std::string cname, std::string reason);
01318         
01324         virtual void ChangeUserNick(userrec* user, std::string nickname);
01325         
01336         virtual void QuitUser(userrec* user, std::string reason);
01337         
01342         virtual bool MatchText(std::string sliteral, std::string spattern);
01343         
01355         virtual void CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user);
01356 
01357         virtual bool IsValidModuleCommand(std::string commandname, int pcnt, userrec* user);
01358         
01364         virtual void ChangeHost(userrec* user, std::string host);
01365         
01371         virtual void ChangeGECOS(userrec* user, std::string gecos);
01372         
01381         virtual bool IsUlined(std::string server);
01382         
01386         virtual chanuserlist GetUsers(chanrec* chan);
01387 
01394         virtual bool UserToPseudo(userrec* user,std::string message);
01395 
01402         virtual bool PseudoToUser(userrec* alive,userrec* zombie,std::string message);
01403 
01411         virtual void AddGLine(long duration, std::string source, std::string reason, std::string hostmask);
01412 
01420         virtual void AddQLine(long duration, std::string source, std::string reason, std::string nickname);
01421 
01429         virtual void AddZLine(long duration, std::string source, std::string reason, std::string ipaddr);
01430 
01438         virtual void AddKLine(long duration, std::string source, std::string reason, std::string hostmask);
01439 
01447         virtual void AddELine(long duration, std::string source, std::string reason, std::string hostmask);
01448 
01451         virtual bool DelGLine(std::string hostmask);
01452 
01455         virtual bool DelQLine(std::string nickname);
01456 
01459         virtual bool DelZLine(std::string ipaddr);
01460 
01463         virtual bool DelKLine(std::string hostmask);
01464 
01467         virtual bool DelELine(std::string hostmask);
01468 
01474         virtual long CalcDuration(std::string duration);
01475 
01478         virtual bool IsValidMask(std::string mask);
01479 
01484         virtual Module* FindModule(std::string name);
01485 
01488         virtual void AddSocket(InspSocket* sock);
01489 
01492         virtual void DelSocket(InspSocket* sock);
01493 
01494         virtual void RehashServer();
01495 };
01496 
01497 
01498 #define CONF_NOT_A_NUMBER       0x000010
01499 #define CONF_NOT_UNSIGNED       0x000080
01500 #define CONF_VALUE_NOT_FOUND    0x000100
01501 #define CONF_FILE_NOT_FOUND     0x000200
01502 
01503 
01510 class ConfigReader : public classbase
01511 {
01512   protected:
01518         std::stringstream *cache;
01519         std::stringstream *errorlog;
01522         bool readerror;
01523         long error;
01524         
01525   public:
01530         ConfigReader();                 // default constructor reads ircd.conf
01534         ConfigReader(std::string filename);     // read a module-specific config
01538         ~ConfigReader();
01543         std::string ReadValue(std::string tag, std::string name, int index);
01549         bool ReadFlag(std::string tag, std::string name, int index);
01558         long ReadInteger(std::string tag, std::string name, int index, bool needs_unsigned);
01563         long GetError();
01570         int Enumerate(std::string tag);
01575         bool Verify();
01582         void DumpErrors(bool bail,userrec* user);
01583 
01589         int EnumerateValues(std::string tag, int index);
01590 };
01591 
01592 
01593 
01599 class FileReader : public classbase
01600 {
01601  file_cache fc;
01602  public:
01607          FileReader();
01608 
01614          FileReader(std::string filename);
01615 
01619          ~FileReader();
01620 
01626          void LoadFile(std::string filename);
01627 
01631          bool Exists();
01632          
01637          std::string GetLine(int x);
01638 
01644          int FileSize();
01645 };
01646 
01647 
01654 class ModuleFactory : public classbase
01655 {
01656  public:
01657         ModuleFactory() { }
01658         virtual ~ModuleFactory() { }
01663         virtual Module * CreateModule(Server* Me) = 0;
01664 };
01665 
01666 
01667 typedef DLLFactory<ModuleFactory> ircd_module;
01668 
01669 #endif

Generated on Mon Dec 12 13:31:08 2005 for InspIRCd by  doxygen 1.4.4-20050815