]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_spanningtree/main.h
Replace std::deque with std::vector in spanningtree and related modules
[user/henk/code/inspircd.git] / src / modules / m_spanningtree / main.h
index 6ca8490575b75aded78faeb563469a66d5754ef4..375d99b1489958b6d3c6041eb17be148b6234201 100644 (file)
+/*       +------------------------------------+
+ *       | Inspire Internet Relay Chat Daemon |
+ *       +------------------------------------+
+ *
+ *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ * See: http://wiki.inspircd.org/Credits
+ *
+ * This program is free but copyrighted software; see
+ *            the file COPYING for details.
+ *
+ * ---------------------------------------------------
+ */
+
 #ifndef __ST_MAIN__
 #define __ST_MAIN__
 
 #include "inspircd.h"
-#include "modules.h"
+#include <stdarg.h>
 
 /** If you make a change which breaks the protocol, increment this.
  * If you  completely change the protocol, completely change the number.
  *
  * IMPORTANT: If you make changes, document your changes here, without fail:
- * http://www.inspircd.org/wiki/List_of_protocol_changes_between_versions
+ * http://wiki.inspircd.org/List_of_protocol_changes_between_versions
  *
  * Failure to document your protocol changes will result in a painfully
  * painful death by pain. You have been warned.
  */
-const long ProtocolVersion = 1103;
+const long ProtocolVersion = 1201;
+const long MinCompatProtocol = 1201;
 
-
-class cmd_rconnect;
+/** Forward declarations
+ */
+class CommandRConnect;
+class CommandRSQuit;
 class SpanningTreeUtilities;
-class TimeSyncTimer;
+class CacheRefreshTimer;
 class TreeServer;
 class Link;
 
+/** This is the main class for the spanningtree module
+ */
 class ModuleSpanningTree : public Module
 {
-       int line;
-       int NumServers;
        unsigned int max_local;
        unsigned int max_global;
-       cmd_rconnect* command_rconnect;
+       CommandRConnect* command_rconnect;
+       CommandRSQuit* command_rsquit;
        SpanningTreeUtilities* Utils;
 
+       void RedoConfig(Module* mod, const std::string &name);
+
  public:
-       TimeSyncTimer *SyncTimer;
+       CacheRefreshTimer *RefreshTimer;
+       /** Set to true if inside a spanningtree call, to prevent sending
+        * xlines and other things back to their source
+        */
+       bool loopCall;
+
+       /** Constructor
+        */
        ModuleSpanningTree(InspIRCd* Me);
-       void ShowLinks(TreeServer* Current, userrec* user, int hops);
+
+       /** Shows /LINKS
+        */
+       void ShowLinks(TreeServer* Current, User* user, int hops);
+
+       /** Counts local servers
+        */
        int CountLocalServs();
+
+       /** Counts local and remote servers
+        */
        int CountServs();
-       void HandleLinks(const char** parameters, int pcnt, userrec* user);
-       void HandleLusers(const char** parameters, int pcnt, userrec* user);
-       void ShowMap(TreeServer* Current, userrec* user, int depth, char matrix[128][80], float &totusers, float &totservers);
-       int HandleMotd(const char** parameters, int pcnt, userrec* user);
-       int HandleAdmin(const char** parameters, int pcnt, userrec* user);
-       int HandleStats(const char** parameters, int pcnt, userrec* user);
-       void HandleMap(const char** parameters, int pcnt, userrec* user);
-       int HandleSquit(const char** parameters, int pcnt, userrec* user);
-       int HandleTime(const char** parameters, int pcnt, userrec* user);
-       int HandleRemoteWhois(const char** parameters, int pcnt, userrec* user);
+
+       /** Handle LINKS command
+        */
+       void HandleLinks(const std::vector<std::string>& parameters, User* user);
+
+       /** Handle LUSERS command
+        */
+       void HandleLusers(const std::vector<std::string>& parameters, User* user);
+
+       /** Show MAP output to a user (recursive)
+        */
+       void ShowMap(TreeServer* Current, User* user, int depth, int &line, char* names, int &maxnamew, char* stats);
+
+       /** Handle remote MOTD
+        */
+       int HandleMotd(const std::vector<std::string>& parameters, User* user);
+
+       /** Handle remote ADMIN
+        */
+       int HandleAdmin(const std::vector<std::string>& parameters, User* user);
+
+       /** Handle remote STATS
+        */
+       int HandleStats(const std::vector<std::string>& parameters, User* user);
+
+       /** Handle MAP command
+        */
+       int HandleMap(const std::vector<std::string>& parameters, User* user);
+
+       /** Handle SQUIT
+        */
+       int HandleSquit(const std::vector<std::string>& parameters, User* user);
+
+       /** Handle TIME
+        */
+       int HandleTime(const std::vector<std::string>& parameters, User* user);
+
+       /** Handle remote WHOIS
+        */
+       int HandleRemoteWhois(const std::vector<std::string>& parameters, User* user);
+
+       /** Handle remote MODULES
+        */
+       int HandleModules(const std::vector<std::string>& parameters, User* user);
+
+       /** Ping all local servers
+        */
        void DoPingChecks(time_t curtime);
+
+       /** Connect a server locally
+        */
        void ConnectServer(Link* x);
+
+       /** Check if any servers are due to be autoconnected
+        */
        void AutoConnectServers(time_t curtime);
-       int HandleVersion(const char** parameters, int pcnt, userrec* user);
-       int HandleConnect(const char** parameters, int pcnt, userrec* user);
-       void BroadcastTimeSync();
-       virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated, const std::string &original_line);
-       virtual void OnPostCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, CmdResult result, const std::string &original_line);
+
+       /** Check if any connecting servers should timeout
+        */
+       void DoConnectTimeout(time_t curtime);
+
+       /** Handle remote VERSON
+        */
+       int HandleVersion(const std::vector<std::string>& parameters, User* user);
+
+       /** Handle CONNECT
+        */
+       int HandleConnect(const std::vector<std::string>& parameters, User* user);
+
+       /** Attempt to send a message to a user
+        */
+       void RemoteMessage(User* user, const char* format, ...) CUSTOM_PRINTF(3, 4);
+
+       /** Returns oper-specific MAP information
+        */
+       const std::string MapOperInfo(TreeServer* Current);
+
+       /** Display a time as a human readable string
+        */
+       std::string TimeToStr(time_t secs);
+
+       /**
+        ** *** MODULE EVENTS ***
+        **/
+
+       virtual int OnPreCommand(std::string &command, std::vector<std::string>& parameters, User *user, bool validated, const std::string &original_line);
+       virtual void OnPostCommand(const std::string &command, const std::vector<std::string>& parameters, User *user, CmdResult result, const std::string &original_line);
        virtual void OnGetServerDescription(const std::string &servername,std::string &description);
-       virtual void OnUserInvite(userrec* source,userrec* dest,chanrec* channel);
-       virtual void OnPostLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic);
-       virtual void OnWallops(userrec* user, const std::string &text);
-       virtual void OnUserNotice(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
-       virtual void OnUserMessage(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
+       virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t);
+       virtual void OnPostLocalTopicChange(User* user, Channel* chan, const std::string &topic);
+       virtual void OnWallops(User* user, const std::string &text);
+       virtual void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
+       virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
        virtual void OnBackgroundTimer(time_t curtime);
-       virtual void OnUserJoin(userrec* user, chanrec* channel);
-       virtual void OnChangeHost(userrec* user, const std::string &newhost);
-       virtual void OnChangeName(userrec* user, const std::string &gecos);
-       virtual void OnUserPart(userrec* user, chanrec* channel, const std::string &partmessage);
-       virtual void OnUserConnect(userrec* user);
-       virtual void OnUserQuit(userrec* user, const std::string &reason);
-       virtual void OnUserPostNick(userrec* user, const std::string &oldnick);
-       virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason);
-       virtual void OnRemoteKill(userrec* source, userrec* dest, const std::string &reason);
-       virtual void OnRehash(userrec* user, const std::string &parameter);
-       virtual void OnOper(userrec* user, const std::string &opertype);
-       void OnLine(userrec* source, const std::string &host, bool adding, char linetype, long duration, const std::string &reason);
-       virtual void OnAddGLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
-       virtual void OnAddZLine(long duration, userrec* source, const std::string &reason, const std::string &ipmask);
-       virtual void OnAddQLine(long duration, userrec* source, const std::string &reason, const std::string &nickmask);
-       virtual void OnAddELine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
-       virtual void OnDelGLine(userrec* source, const std::string &hostmask);
-       virtual void OnDelZLine(userrec* source, const std::string &ipmask);
-       virtual void OnDelQLine(userrec* source, const std::string &nickmask);
-       virtual void OnDelELine(userrec* source, const std::string &hostmask);
-       virtual void OnMode(userrec* user, void* dest, int target_type, const std::string &text);
-       virtual int OnStats(char statschar, userrec* user, string_list &results);
-       virtual void OnSetAway(userrec* user);
-       virtual void OnCancelAway(userrec* user);
-       virtual void ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline);
-       virtual void ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata);
+       virtual void OnUserJoin(User* user, Channel* channel, bool sync, bool &silent);
+       virtual int OnChangeLocalUserHost(User* user, const std::string &newhost);
+       virtual void OnChangeName(User* user, const std::string &gecos);
+       virtual void OnUserPart(User* user, Channel* channel, std::string &partmessage, bool &silent);
+       virtual void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message);
+       virtual void OnUserPostNick(User* user, const std::string &oldnick);
+       virtual void OnUserKick(User* source, User* user, Channel* chan, const std::string &reason, bool &silent);
+       virtual void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
+       virtual void OnPreRehash(User* user, const std::string &parameter);
+       virtual void OnRehash(User* user);
+       virtual void OnOper(User* user, const std::string &opertype);
+       void OnLine(User* source, const std::string &host, bool adding, char linetype, long duration, const std::string &reason);
+       virtual void OnAddLine(User *u, XLine *x);
+       virtual void OnDelLine(User *u, XLine *x);
+       virtual void OnMode(User* user, void* dest, int target_type, const std::vector<std::string> &text, const std::vector<TranslateType> &translate);
+       virtual int OnStats(char statschar, User* user, string_list &results);
+       virtual int OnSetAway(User* user, const std::string &awaymsg);
+       virtual void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::vector<std::string> &modeline, const std::vector<TranslateType> &translate);
+       virtual void ProtoSendMetaData(void* opaque, TargetTypeFlags target_type, void* target, const std::string &extname, const std::string &extdata);
        virtual void OnEvent(Event* event);
+       virtual void OnLoadModule(Module* mod,const std::string &name);
+       virtual void OnUnloadModule(Module* mod,const std::string &name);
        virtual ~ModuleSpanningTree();
        virtual Version GetVersion();
-       void Implements(char* List);
-       Priority Prioritize();
+       void Prioritize();
 };
 
 #endif