src/modules/m_spanningtree/main.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
   6  * See: http://www.inspircd.org/wiki/index.php/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *            the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #ifndef __ST_MAIN__
  15 #define __ST_MAIN__
  16
  17 #include "inspircd.h"
  18 #include <stdarg.h>
  19
  20 /** If you make a change which breaks the protocol, increment this.
  21  * If you  completely change the protocol, completely change the number.
  22  *
  23  * IMPORTANT: If you make changes, document your changes here, without fail:
  24  * http://www.inspircd.org/wiki/List_of_protocol_changes_between_versions
  25  *
  26  * Failure to document your protocol changes will result in a painfully
  27  * painful death by pain. You have been warned.
  28  */
  29 const long ProtocolVersion = 1201;
  30
  31 /** Forward declarations
  32  */
  33 class CommandRConnect;
  34 class CommandRSQuit;
  35 class SpanningTreeUtilities;
  36 class CacheRefreshTimer;
  37 class TreeServer;
  38 class Link;
  39
  40 /** This is the main class for the spanningtree module
  41  */
  42 class ModuleSpanningTree : public Module
  43 {
  44         int line;
  45         int NumServers;
  46         unsigned int max_local;
  47         unsigned int max_global;
  48         CommandRConnect* command_rconnect;
  49         CommandRSQuit* command_rsquit;
  50         SpanningTreeUtilities* Utils;
  51
  52         void RedoConfig(Module* mod, const std::string &name);
  53
  54  public:
  55         CacheRefreshTimer *RefreshTimer;
  56
  57         /** Constructor
  58          */
  59         ModuleSpanningTree(InspIRCd* Me);
  60
  61         /** Shows /LINKS
  62          */
  63         void ShowLinks(TreeServer* Current, User* user, int hops);
  64
  65         /** Counts local servers
  66          */
  67         int CountLocalServs();
  68
  69         /** Counts local and remote servers
  70          */
  71         int CountServs();
  72
  73         /** Handle LINKS command
  74          */
  75         void HandleLinks(const std::vector<std::string>& parameters, User* user);
  76
  77         /** Handle LUSERS command
  78          */
  79         void HandleLusers(const std::vector<std::string>& parameters, User* user);
  80
  81         /** Show MAP output to a user (recursive)
  82          */
  83         void ShowMap(TreeServer* Current, User* user, int depth, char matrix[250][250], float &totusers, float &totservers);
  84
  85         /** Handle remote MOTD
  86          */
  87         int HandleMotd(const std::vector<std::string>& parameters, User* user);
  88
  89         /** Handle remote ADMIN
  90          */
  91         int HandleAdmin(const std::vector<std::string>& parameters, User* user);
  92
  93         /** Handle remote STATS
  94          */
  95         int HandleStats(const std::vector<std::string>& parameters, User* user);
  96
  97         /** Handle MAP command
  98          */
  99         int HandleMap(const std::vector<std::string>& parameters, User* user);
 100
 101         /** Handle SQUIT
 102          */
 103         int HandleSquit(const std::vector<std::string>& parameters, User* user);
 104
 105         /** Handle TIME
 106          */
 107         int HandleTime(const std::vector<std::string>& parameters, User* user);
 108
 109         /** Handle remote WHOIS
 110          */
 111         int HandleRemoteWhois(const std::vector<std::string>& parameters, User* user);
 112
 113         /** Handle remote MODULES
 114          */
 115         int HandleModules(const std::vector<std::string>& parameters, User* user);
 116
 117         /** Ping all local servers
 118          */
 119         void DoPingChecks(time_t curtime);
 120
 121         /** Connect a server locally
 122          */
 123         void ConnectServer(Link* x);
 124
 125         /** Check if any servers are due to be autoconnected
 126          */
 127         void AutoConnectServers(time_t curtime);
 128
 129         /** Check if any connecting servers should timeout
 130          */
 131         void DoConnectTimeout(time_t curtime);
 132
 133         /** Handle remote VERSON
 134          */
 135         int HandleVersion(const std::vector<std::string>& parameters, User* user);
 136
 137         /** Handle CONNECT
 138          */
 139         int HandleConnect(const std::vector<std::string>& parameters, User* user);
 140
 141         /** Attempt to send a message to a user
 142          */
 143         void RemoteMessage(User* user, const char* format, ...) CUSTOM_PRINTF(3, 4);
 144
 145         /** Returns oper-specific MAP information
 146          */
 147         const std::string MapOperInfo(TreeServer* Current);
 148
 149         /** Display a time as a human readable string
 150          */
 151         std::string TimeToStr(time_t secs);
 152
 153         /**
 154          ** *** MODULE EVENTS ***
 155          **/
 156
 157         virtual int OnPreCommand(std::string &command, std::vector<std::string>& parameters, User *user, bool validated, const std::string &original_line);
 158         virtual void OnPostCommand(const std::string &command, const std::vector<std::string>& parameters, User *user, CmdResult result, const std::string &original_line);
 159         virtual void OnGetServerDescription(const std::string &servername,std::string &description);
 160         virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t);
 161         virtual void OnPostLocalTopicChange(User* user, Channel* chan, const std::string &topic);
 162         virtual void OnWallops(User* user, const std::string &text);
 163         virtual void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
 164         virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
 165         virtual void OnBackgroundTimer(time_t curtime);
 166         virtual void OnUserJoin(User* user, Channel* channel, bool sync, bool &silent);
 167         virtual int OnChangeLocalUserHost(User* user, const std::string &newhost);
 168         virtual void OnChangeName(User* user, const std::string &gecos);
 169         virtual void OnUserPart(User* user, Channel* channel, std::string &partmessage, bool &silent);
 170         virtual void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message);
 171         virtual void OnUserPostNick(User* user, const std::string &oldnick);
 172         virtual void OnUserKick(User* source, User* user, Channel* chan, const std::string &reason, bool &silent);
 173         virtual void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
 174         virtual void OnRehash(User* user, const std::string &parameter);
 175         virtual void OnOper(User* user, const std::string &opertype);
 176         void OnLine(User* source, const std::string &host, bool adding, char linetype, long duration, const std::string &reason);
 177         virtual void OnAddLine(User *u, XLine *x);
 178         virtual void OnDelLine(User *u, XLine *x);
 179         virtual void OnMode(User* user, void* dest, int target_type, const std::string &text);
 180         virtual int OnStats(char statschar, User* user, string_list &results);
 181         virtual int OnSetAway(User* user, const std::string &awaymsg);
 182         virtual void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::string &modeline);
 183         virtual void ProtoSendMetaData(void* opaque, TargetTypeFlags target_type, void* target, const std::string &extname, const std::string &extdata);
 184         virtual void OnEvent(Event* event);
 185         virtual void OnLoadModule(Module* mod,const std::string &name);
 186         virtual void OnUnloadModule(Module* mod,const std::string &name);
 187         virtual ~ModuleSpanningTree();
 188         virtual Version GetVersion();
 189         void Prioritize();
 190 };
 191
 192 #endif