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 NumServers;
  45         unsigned int max_local;
  46         unsigned int max_global;
  47         CommandRConnect* command_rconnect;
  48         CommandRSQuit* command_rsquit;
  49         SpanningTreeUtilities* Utils;
  50
  51         void RedoConfig(Module* mod, const std::string &name);
  52
  53  public:
  54         CacheRefreshTimer *RefreshTimer;
  55
  56         /** Constructor
  57          */
  58         ModuleSpanningTree(InspIRCd* Me);
  59
  60         /** Shows /LINKS
  61          */
  62         void ShowLinks(TreeServer* Current, User* user, int hops);
  63
  64         /** Counts local servers
  65          */
  66         int CountLocalServs();
  67
  68         /** Counts local and remote servers
  69          */
  70         int CountServs();
  71
  72         /** Handle LINKS command
  73          */
  74         void HandleLinks(const std::vector<std::string>& parameters, User* user);
  75
  76         /** Handle LUSERS command
  77          */
  78         void HandleLusers(const std::vector<std::string>& parameters, User* user);
  79
  80         /** Show MAP output to a user (recursive)
  81          */
  82         void ShowMap(TreeServer* Current, User* user, int depth, int &line, char* names, int &maxnamew, char* stats);
  83
  84         /** Handle remote MOTD
  85          */
  86         int HandleMotd(const std::vector<std::string>& parameters, User* user);
  87
  88         /** Handle remote ADMIN
  89          */
  90         int HandleAdmin(const std::vector<std::string>& parameters, User* user);
  91
  92         /** Handle remote STATS
  93          */
  94         int HandleStats(const std::vector<std::string>& parameters, User* user);
  95
  96         /** Handle MAP command
  97          */
  98         int HandleMap(const std::vector<std::string>& parameters, User* user);
  99
 100         /** Handle SQUIT
 101          */
 102         int HandleSquit(const std::vector<std::string>& parameters, User* user);
 103
 104         /** Handle TIME
 105          */
 106         int HandleTime(const std::vector<std::string>& parameters, User* user);
 107
 108         /** Handle remote WHOIS
 109          */
 110         int HandleRemoteWhois(const std::vector<std::string>& parameters, User* user);
 111
 112         /** Handle remote MODULES
 113          */
 114         int HandleModules(const std::vector<std::string>& parameters, User* user);
 115
 116         /** Ping all local servers
 117          */
 118         void DoPingChecks(time_t curtime);
 119
 120         /** Connect a server locally
 121          */
 122         void ConnectServer(Link* x);
 123
 124         /** Check if any servers are due to be autoconnected
 125          */
 126         void AutoConnectServers(time_t curtime);
 127
 128         /** Check if any connecting servers should timeout
 129          */
 130         void DoConnectTimeout(time_t curtime);
 131
 132         /** Handle remote VERSON
 133          */
 134         int HandleVersion(const std::vector<std::string>& parameters, User* user);
 135
 136         /** Handle CONNECT
 137          */
 138         int HandleConnect(const std::vector<std::string>& parameters, User* user);
 139
 140         /** Attempt to send a message to a user
 141          */
 142         void RemoteMessage(User* user, const char* format, ...) CUSTOM_PRINTF(3, 4);
 143
 144         /** Returns oper-specific MAP information
 145          */
 146         const std::string MapOperInfo(TreeServer* Current);
 147
 148         /** Display a time as a human readable string
 149          */
 150         std::string TimeToStr(time_t secs);
 151
 152         /**
 153          ** *** MODULE EVENTS ***
 154          **/
 155
 156         virtual int OnPreCommand(std::string &command, std::vector<std::string>& parameters, User *user, bool validated, const std::string &original_line);
 157         virtual void OnPostCommand(const std::string &command, const std::vector<std::string>& parameters, User *user, CmdResult result, const std::string &original_line);
 158         virtual void OnGetServerDescription(const std::string &servername,std::string &description);
 159         virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t);
 160         virtual void OnPostLocalTopicChange(User* user, Channel* chan, const std::string &topic);
 161         virtual void OnWallops(User* user, const std::string &text);
 162         virtual void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
 163         virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
 164         virtual void OnBackgroundTimer(time_t curtime);
 165         virtual void OnUserJoin(User* user, Channel* channel, bool sync, bool &silent);
 166         virtual int OnChangeLocalUserHost(User* user, const std::string &newhost);
 167         virtual void OnChangeName(User* user, const std::string &gecos);
 168         virtual void OnUserPart(User* user, Channel* channel, std::string &partmessage, bool &silent);
 169         virtual void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message);
 170         virtual void OnUserPostNick(User* user, const std::string &oldnick);
 171         virtual void OnUserKick(User* source, User* user, Channel* chan, const std::string &reason, bool &silent);
 172         virtual void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
 173         virtual void OnRehash(User* user, const std::string &parameter);
 174         virtual void OnOper(User* user, const std::string &opertype);
 175         void OnLine(User* source, const std::string &host, bool adding, char linetype, long duration, const std::string &reason);
 176         virtual void OnAddLine(User *u, XLine *x);
 177         virtual void OnDelLine(User *u, XLine *x);
 178         virtual void OnMode(User* user, void* dest, int target_type, const std::string &text);
 179         virtual int OnStats(char statschar, User* user, string_list &results);
 180         virtual int OnSetAway(User* user, const std::string &awaymsg);
 181         virtual void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::string &modeline);
 182         virtual void ProtoSendMetaData(void* opaque, TargetTypeFlags target_type, void* target, const std::string &extname, const std::string &extdata);
 183         virtual void OnEvent(Event* event);
 184         virtual void OnLoadModule(Module* mod,const std::string &name);
 185         virtual void OnUnloadModule(Module* mod,const std::string &name);
 186         virtual ~ModuleSpanningTree();
 187         virtual Version GetVersion();
 188         void Prioritize();
 189 };
 190
 191 #endif