]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_spanningtree/main.h
Merge pull request #495 from SaberUK/master+fix-libcpp
[user/henk/code/inspircd.git] / src / modules / m_spanningtree / main.h
index dd0e6b4e0205c0e85b6e6db85a5db017b9dceec4..8cc2d984f6906fb06a3ae3728b6f5fc5acdc9a9f 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"
 
 /** 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 = 1205;
+const long MinCompatProtocol = 1202;
 
-class cmd_rconnect;
+/** Forward declarations
+ */
+class SpanningTreeCommands;
 class SpanningTreeUtilities;
-class TimeSyncTimer;
+class CacheRefreshTimer;
 class TreeServer;
 class Link;
+class Autoconnect;
 
+/** 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;
-        SpanningTreeUtilities* Utils;
+       SpanningTreeCommands* commands;
+       void LocalMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list, const char* message_type);
 
  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);
-        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();
-};
+       SpanningTreeUtilities* Utils;
+
+       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();
+       void init();
+
+       /** Shows /LINKS
+        */
+       void ShowLinks(TreeServer* Current, User* user, int hops);
+
+       /** Counts local and remote servers
+        */
+       int CountServs();
+
+       /** Handle LINKS command
+        */
+       void HandleLinks(const std::vector<std::string>& parameters, User* user);
 
-#endif
+       /** Show MAP output to a user (recursive)
+        */
+       void ShowMap(TreeServer* Current, User* user, int depth, int &line, char* names, int &maxnamew, char* stats);
+
+       /** Handle MAP command
+        */
+       bool HandleMap(const std::vector<std::string>& parameters, User* user);
+
+       /** Handle SQUIT
+        */
+       ModResult HandleSquit(const std::vector<std::string>& parameters, User* user);
+
+       /** Handle remote WHOIS
+        */
+       ModResult HandleRemoteWhois(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, 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);
+
+       /** Check if any connecting servers should timeout
+        */
+       void DoConnectTimeout(time_t curtime);
+
+       /** Handle remote VERSON
+        */
+       ModResult HandleVersion(const std::vector<std::string>& parameters, User* user);
+
+       /** Handle CONNECT
+        */
+       ModResult 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 ***
+        **/
+
+       ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, LocalUser *user, bool validated, const std::string &original_line);
+       void OnPostCommand(const std::string &command, const std::vector<std::string>& parameters, LocalUser *user, CmdResult result, const std::string &original_line);
+       void OnGetServerDescription(const std::string &servername,std::string &description);
+       void OnUserConnect(LocalUser* source);
+       void OnUserInvite(User* source,User* dest,Channel* channel, time_t);
+       void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
+       void OnWallops(User* user, const std::string &text);
+       void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
+       void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
+       void OnBackgroundTimer(time_t curtime);
+       void OnUserJoin(Membership* memb, bool sync, bool created, CUList& excepts);
+       void OnChangeHost(User* user, const std::string &newhost);
+       void OnChangeName(User* user, const std::string &gecos);
+       void OnChangeIdent(User* user, const std::string &ident);
+       void OnUserPart(Membership* memb, std::string &partmessage, CUList& excepts);
+       void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message);
+       void OnUserPostNick(User* user, const std::string &oldnick);
+       void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& excepts);
+       void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
+       void OnPreRehash(User* user, const std::string &parameter);
+       void OnRehash(User* user);
+       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);
+       void OnAddLine(User *u, XLine *x);
+       void OnDelLine(User *u, XLine *x);
+       void OnMode(User* user, void* dest, int target_type, const std::vector<std::string> &text, const std::vector<TranslateType> &translate);
+       ModResult OnStats(char statschar, User* user, string_list &results);
+       ModResult OnSetAway(User* user, const std::string &awaymsg);
+       void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::vector<std::string> &modeline, const std::vector<TranslateType> &translate);
+       void ProtoSendMetaData(void* opaque, Extensible* target, const std::string &extname, const std::string &extdata);
+       void OnLoadModule(Module* mod);
+       void OnUnloadModule(Module* mod);
+       ModResult OnAcceptConnection(int newsock, ListenSocket* from, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
+       CullResult cull();
+       ~ModuleSpanningTree();
+       Version GetVersion();
+       void Prioritize();
+};