]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_spanningtree/main.h
Remove the 'debug' snotice character.
[user/henk/code/inspircd.git] / src / modules / m_spanningtree / main.h
index 71723a6a9702a7fc95226fa501ee7ba9871bdfbd..4479b07001128c569a6b3df2b516689e6e988a27 100644 (file)
-#ifndef __ST_MAIN__
-#define __ST_MAIN__
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
+ *
+ *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
+ *   Copyright (C) 2007-2008 Craig Edwards <craigedwards@brainbox.cc>
+ *   Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *
+ * This file is part of InspIRCd.  InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+
+#pragma once
 
 #include "inspircd.h"
-#include "modules.h"
+#include "event.h"
+#include "modules/dns.h"
+#include "modules/stats.h"
+#include "servercommand.h"
+#include "commands.h"
+#include "protocolinterface.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
+ * https://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 = 1104;
-
+const long ProtocolVersion = 1205;
+const long MinCompatProtocol = 1202;
 
-class cmd_rconnect;
+/** Forward declarations
+ */
 class SpanningTreeUtilities;
-class TimeSyncTimer;
+class CacheRefreshTimer;
 class TreeServer;
 class Link;
+class Autoconnect;
 
-class ModuleSpanningTree : public Module
+/** This is the main class for the spanningtree module
+ */
+class ModuleSpanningTree : public Module, public Stats::EventListener
 {
-       int line;
-       int NumServers;
-       unsigned int max_local;
-       unsigned int max_global;
-       cmd_rconnect* command_rconnect;
-       SpanningTreeUtilities* Utils;
+       /** Client to server commands, registered in the core
+        */
+       CommandRConnect rconnect;
+       CommandRSQuit rsquit;
+       CommandMap map;
+
+       /** Server to server only commands, not registered in the core
+        */
+       SpanningTreeCommands commands;
+
+       /** Next membership id assigned when a local user joins a channel
+        */
+       Membership::Id currmembid;
+
+       /** The specialized ProtocolInterface that is assigned to ServerInstance->PI on load
+        */
+       SpanningTreeProtocolInterface protocolinterface;
+
+       /** Event provider for our events
+        */
+       Events::ModuleEventProvider eventprov;
 
  public:
-       TimeSyncTimer *SyncTimer;
-       ModuleSpanningTree(InspIRCd* Me);
-       void ShowLinks(TreeServer* Current, userrec* user, int hops);
-       int CountLocalServs();
-       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);
-       void DoPingChecks(time_t curtime);
-       void ConnectServer(Link* x);
+       dynamic_reference<DNS::Manager> DNS;
+
+       ServerCommandManager CmdManager;
+
+       /** Set to true if inside a spanningtree call, to prevent sending
+        * xlines and other things back to their source
+        */
+       bool loopCall;
+
+       /** Constructor
+        */
+       ModuleSpanningTree();
+       void init() CXX11_OVERRIDE;
+
+       /** Shows /LINKS
+        */
+       void ShowLinks(TreeServer* Current, User* user, int hops);
+
+       /** Handle LINKS command
+        */
+       void HandleLinks(const CommandBase::Params& parameters, User* user);
+
+       /** Handle SQUIT
+        */
+       ModResult HandleSquit(const CommandBase::Params& parameters, User* user);
+
+       /** Handle remote WHOIS
+        */
+       ModResult HandleRemoteWhois(const CommandBase::Params& parameters, User* user);
+
+       /** Connect a server locally
+        */
+       void ConnectServer(Link* x, Autoconnect* y = NULL);
+
+       /** Connect the next autoconnect server
+        */
+       void ConnectServer(Autoconnect* y, bool on_timer);
+
+       /** 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);
-       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 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 OnEvent(Event* event);
-       virtual ~ModuleSpanningTree();
-       virtual Version GetVersion();
-       void Implements(char* List);
-       Priority Prioritize();
-};
 
-#endif
+       /** Check if any connecting servers should timeout
+        */
+       void DoConnectTimeout(time_t curtime);
+
+       /** Handle remote VERSON
+        */
+       ModResult HandleVersion(const CommandBase::Params& parameters, User* user);
+
+       /** Handle CONNECT
+        */
+       ModResult HandleConnect(const CommandBase::Params& parameters, User* user);
+
+       /** Display a time as a human readable string
+        */
+       static std::string TimeToStr(time_t secs);
+
+       const Events::ModuleEventProvider& GetEventProvider() const { return eventprov; }
+
+       /**
+        ** *** MODULE EVENTS ***
+        **/
+
+       ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated, const std::string& original_line) CXX11_OVERRIDE;
+       void OnPostCommand(Command*, const CommandBase::Params& parameters, LocalUser* user, CmdResult result, const std::string& original_line) CXX11_OVERRIDE;
+       void OnUserConnect(LocalUser* source) CXX11_OVERRIDE;
+       void OnUserInvite(User* source, User* dest, Channel* channel, time_t timeout, unsigned int notifyrank, CUList& notifyexcepts) CXX11_OVERRIDE;
+       ModResult OnPreTopicChange(User* user, Channel* chan, const std::string& topic) CXX11_OVERRIDE;
+       void OnPostTopicChange(User* user, Channel* chan, const std::string &topic) CXX11_OVERRIDE;
+       void OnUserPostMessage(User* user, const MessageTarget& target, const MessageDetails& details) CXX11_OVERRIDE;
+       void OnBackgroundTimer(time_t curtime) CXX11_OVERRIDE;
+       void OnUserJoin(Membership* memb, bool sync, bool created, CUList& excepts) CXX11_OVERRIDE;
+       void OnChangeHost(User* user, const std::string &newhost) CXX11_OVERRIDE;
+       void OnChangeRealName(User* user, const std::string& real) CXX11_OVERRIDE;
+       void OnChangeIdent(User* user, const std::string &ident) CXX11_OVERRIDE;
+       void OnUserPart(Membership* memb, std::string &partmessage, CUList& excepts) CXX11_OVERRIDE;
+       void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message) CXX11_OVERRIDE;
+       void OnUserPostNick(User* user, const std::string &oldnick) CXX11_OVERRIDE;
+       void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& excepts) CXX11_OVERRIDE;
+       void OnPreRehash(User* user, const std::string &parameter) CXX11_OVERRIDE;
+       void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE;
+       void OnOper(User* user, const std::string &opertype) CXX11_OVERRIDE;
+       void OnAddLine(User *u, XLine *x) CXX11_OVERRIDE;
+       void OnDelLine(User *u, XLine *x) CXX11_OVERRIDE;
+       ModResult OnStats(Stats::Context& stats) CXX11_OVERRIDE;
+       ModResult OnSetAway(User* user, const std::string &awaymsg) CXX11_OVERRIDE;
+       void OnLoadModule(Module* mod) CXX11_OVERRIDE;
+       void OnUnloadModule(Module* mod) CXX11_OVERRIDE;
+       ModResult OnAcceptConnection(int newsock, ListenSocket* from, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server) CXX11_OVERRIDE;
+       void OnMode(User* source, User* u, Channel* c, const Modes::ChangeList& modes, ModeParser::ModeProcessFlag processflags, const std::string& output_mode) CXX11_OVERRIDE;
+       CullResult cull() CXX11_OVERRIDE;
+       ~ModuleSpanningTree();
+       Version GetVersion() CXX11_OVERRIDE;
+       void Prioritize() CXX11_OVERRIDE;
+};