include/inspircd.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 __INSPIRCD_H__
  18 #define __INSPIRCD_H__
  19
  20 #include <time.h>
  21 #include <string>
  22 #include <sstream>
  23 #include "inspircd_config.h"
  24 #include "users.h"
  25 #include "channels.h"
  26 #include "socket.h"
  27 #include "mode.h"
  28 #include "helperfuncs.h"
  29 #include "socketengine.h"
  30 #include "command_parse.h"
  31
  32 /* Some misc defines */
  33 #define ERROR -1
  34 #define MAXCOMMAND 32
  35
  36 /* Crucial defines */
  37 #define ETIREDGERBILS EAGAIN
  38
  39 /* This define is used in place of strcmp when we
  40  * want to check if a char* string contains only one
  41  * letter. Pretty fast, its just two compares and an
  42  * addition.
  43  */
  44 #define IS_SINGLE(x,y) ( (*x == y) && (*(x+1) == 0) )
  45
  46 #define DELETE(x) { InspIRCd::Log(DEBUG,"%s:%d: delete()",__FILE__,__LINE__); if (x) { delete x; x = NULL; } else InspIRCd::Log(DEBUG,"Attempt to delete NULL pointer!"); }
  47
  48 template<typename T> inline std::string ConvToStr(const T &in)
  49 {
  50         std::stringstream tmp;
  51         if (!(tmp << in)) return std::string();
  52         return tmp.str();
  53 }
  54
  55 class serverstats : public classbase
  56 {
  57   public:
  58         unsigned long statsAccept;
  59         unsigned long statsRefused;
  60         unsigned long statsUnknown;
  61         unsigned long statsCollisions;
  62         unsigned long statsDns;
  63         unsigned long statsDnsGood;
  64         unsigned long statsDnsBad;
  65         unsigned long statsConnects;
  66         double statsSent;
  67         double statsRecv;
  68         unsigned long BoundPortCount;
  69
  70         serverstats()
  71         {
  72                 statsAccept = statsRefused = statsUnknown = 0;
  73                 statsCollisions = statsDns = statsDnsGood = 0;
  74                 statsDnsBad = statsConnects = 0;
  75                 statsSent = statsRecv = 0.0;
  76                 BoundPortCount = 0;
  77         }
  78 };
  79
  80
  81 class InspIRCd : public classbase
  82 {
  83  private:
  84         char MODERR[MAXBUF];
  85         bool expire_run;
  86         servernamelist servernames;
  87
  88         void EraseFactory(int j);
  89         void EraseModule(int j);
  90         void BuildISupport();
  91         void MoveTo(std::string modulename,int slot);
  92         void Start();
  93         void SetSignals(bool SEGVHandler);
  94         bool DaemonSeed();
  95         void MakeLowerMap();
  96         void MoveToLast(std::string modulename);
  97         void MoveToFirst(std::string modulename);
  98         void MoveAfter(std::string modulename, std::string after);
  99         void MoveBefore(std::string modulename, std::string before);
 100
 101         void ProcessUser(userrec* cu);
 102         void DoSocketTimeouts(time_t TIME);
 103         void DoBackgroundUserStuff(time_t TIME);
 104
 105         bool AllModulesReportReady(userrec* user);
 106
 107  public:
 108         time_t startup_time;
 109         ModeParser* ModeGrok;
 110         CommandParser* Parser;
 111         SocketEngine* SE;
 112         serverstats* stats;
 113         ServerConfig* Config;
 114         std::vector<InspSocket*> module_sockets;
 115         InspSocket* socket_ref[MAX_DESCRIPTORS];        /* XXX: This should probably be made private, with inline accessors */
 116         userrec* fd_ref_table[MAX_DESCRIPTORS];         /* XXX: Ditto */
 117         user_hash clientlist;
 118         chan_hash chanlist;
 119         std::vector<userrec*> local_users;
 120         DNS* Res;
 121         TimerManager* Timers;
 122
 123         void AddServerName(const std::string &servername);
 124         const char* FindServerNamePtr(const std::string &servername);
 125         bool FindServerName(const std::string &servername);
 126
 127         std::string GetServerDescription(const char* servername);
 128
 129         void WriteOpers(const char* text, ...);
 130         void WriteOpers(const std::string &text);
 131
 132         userrec* FindNick(const std::string &nick);
 133         userrec* FindNick(const char* nick);
 134
 135         chanrec* FindChan(const std::string &chan);
 136         chanrec* FindChan(const char* chan);
 137
 138         void LoadAllModules();
 139         void CheckDie();
 140         void CheckRoot();
 141         void OpenLog(char** argv, int argc);
 142
 143         bool UserToPseudo(userrec* user, const std::string &message);
 144         bool PseudoToUser(userrec* alive, userrec* zombie, const std::string &message);
 145
 146         void ServerNoticeAll(char* text, ...);
 147         void ServerPrivmsgAll(char* text, ...);
 148         void WriteMode(const char* modes, int flags, const char* text, ...);
 149
 150         bool IsChannel(const char *chname);
 151
 152         static void Error(int status);
 153         static void Rehash(int status);
 154         static void Exit(int status);
 155
 156         int usercnt();
 157         int registered_usercount();
 158         int usercount_invisible();
 159         int usercount_opers();
 160         int usercount_unknown();
 161         long chancount();
 162         long local_count();
 163
 164         void SendError(const char *s);
 165
 166         /** For use with Module::Prioritize().
 167          * When the return value of this function is returned from
 168          * Module::Prioritize(), this specifies that the module wishes
 169          * to be ordered exactly BEFORE 'modulename'. For more information
 170          * please see Module::Prioritize().
 171          * @param modulename The module your module wants to be before in the call list
 172          * @returns a priority ID which the core uses to relocate the module in the list
 173          */
 174         long PriorityBefore(const std::string &modulename);
 175
 176         /** For use with Module::Prioritize().
 177          * When the return value of this function is returned from
 178          * Module::Prioritize(), this specifies that the module wishes
 179          * to be ordered exactly AFTER 'modulename'. For more information please
 180          * see Module::Prioritize().
 181          * @param modulename The module your module wants to be after in the call list
 182          * @returns a priority ID which the core uses to relocate the module in the list
 183          */
 184         long PriorityAfter(const std::string &modulename);
 185
 186         /** Publish a 'feature'.
 187          * There are two ways for a module to find another module it depends on.
 188          * Either by name, using InspIRCd::FindModule, or by feature, using this
 189          * function. A feature is an arbitary string which identifies something this
 190          * module can do. For example, if your module provides SSL support, but other
 191          * modules provide SSL support too, all the modules supporting SSL should
 192          * publish an identical 'SSL' feature. This way, any module requiring use
 193          * of SSL functions can just look up the 'SSL' feature using FindFeature,
 194          * then use the module pointer they are given.
 195          * @param FeatureName The case sensitive feature name to make available
 196          * @param Mod a pointer to your module class
 197          * @returns True on success, false if the feature is already published by
 198          * another module.
 199          */
 200         bool PublishFeature(const std::string &FeatureName, Module* Mod);
 201
 202         /** Unpublish a 'feature'.
 203          * When your module exits, it must call this method for every feature it
 204          * is providing so that the feature table is cleaned up.
 205          * @param FeatureName the feature to remove
 206          */
 207         bool UnpublishFeature(const std::string &FeatureName);
 208
 209         /** Find a 'feature'.
 210          * There are two ways for a module to find another module it depends on.
 211          * Either by name, using InspIRCd::FindModule, or by feature, using the
 212          * InspIRCd::PublishFeature method. A feature is an arbitary string which
 213          * identifies something this module can do. For example, if your module
 214          * provides SSL support, but other modules provide SSL support too, all
 215          * the modules supporting SSL should publish an identical 'SSL' feature.
 216          * To find a module capable of providing the feature you want, simply
 217          * call this method with the feature name you are looking for.
 218          * @param FeatureName The feature name you wish to obtain the module for
 219          * @returns A pointer to a valid module class on success, NULL on failure.
 220          */
 221         Module* FindFeature(const std::string &FeatureName);
 222
 223         const std::string& GetModuleName(Module* m);
 224
 225         bool IsNick(const char* n);
 226         bool IsIdent(const char* n);
 227
 228         std::string GetRevision();
 229         std::string GetVersionString();
 230         void WritePID(const std::string &filename);
 231         char* ModuleError();
 232         bool LoadModule(const char* filename);
 233         bool UnloadModule(const char* filename);
 234         InspIRCd(int argc, char** argv);
 235         void DoOneIteration(bool process_module_sockets);
 236         static void Log(int level, const char* text, ...);
 237         static void Log(int level, const std::string &text);
 238         int Run();
 239 };
 240
 241 #endif