X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=src%2Fmodules%2Fm_spanningtree%2Fmain.h;h=0763694938810f289c1298592deb8d738c41bbfb;hb=b618b194f3166a55ca7e7889c7346b65c174d397;hp=9ea48aaea562ee13d11a43a4627b4b37d509b670;hpb=4ab1c43c1eee708fc50a4808f714a731891b75e8;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/src/modules/m_spanningtree/main.h b/src/modules/m_spanningtree/main.h index 9ea48aaea..076369493 100644 --- a/src/modules/m_spanningtree/main.h +++ b/src/modules/m_spanningtree/main.h @@ -1,11 +1,16 @@ /* * InspIRCd -- Internet Relay Chat Daemon * - * Copyright (C) 2009 Daniel De Graaf - * Copyright (C) 2008 Thomas Stagner - * Copyright (C) 2007-2008 Craig Edwards + * Copyright (C) 2019 linuxdaemon + * Copyright (C) 2013-2016, 2018 Attila Molnar + * Copyright (C) 2013, 2017-2020 Sadie Powell + * Copyright (C) 2013 Adam + * Copyright (C) 2012 Robby + * Copyright (C) 2009-2010 Daniel De Graaf + * Copyright (C) 2009 Uli Schlachter + * Copyright (C) 2007-2008 Dennis Friis + * Copyright (C) 2007, 2009-2010 Craig Edwards * Copyright (C) 2007 Robin Burchell - * Copyright (C) 2007 Dennis Friis * * 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 @@ -24,23 +29,45 @@ #pragma once #include "inspircd.h" - +#include "event.h" #include "modules/dns.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://wiki.inspircd.org/List_of_protocol_changes_between_versions +#include "modules/ssl.h" +#include "modules/stats.h" +#include "modules/ctctags.h" +#include "modules/server.h" +#include "servercommand.h" +#include "commands.h" +#include "protocolinterface.h" +#include "tags.h" + +/** An enumeration of all known protocol versions. * - * Failure to document your protocol changes will result in a painfully - * painful death by pain. You have been warned. + * If you introduce new protocol versions please document them here: + * https://docs.inspircd.org/spanningtree/changes */ -const long ProtocolVersion = 1205; -const long MinCompatProtocol = 1202; +enum ProtocolVersion +{ + /** The linking protocol version introduced in InspIRCd v2.0. */ + PROTO_INSPIRCD_20 = 1202, + + /** The linking protocol version introduced in InspIRCd v2.1 alpha 0. */ + PROTO_INSPIRCD_21_A0 = 1203, + + /** The linking protocol version introduced in InspIRCd v2.1 beta 2. */ + PROTO_INSPIRCD_21_B2 = 1204, + + /** The linking protocol version introduced in InspIRCd v3.0. */ + PROTO_INSPIRCD_30 = 1205, + + /** The oldest version of the protocol that we support. */ + PROTO_OLDEST = PROTO_INSPIRCD_20, + + /** The newest version of the protocol that we support. */ + PROTO_NEWEST = PROTO_INSPIRCD_30 +}; /** Forward declarations */ -class SpanningTreeCommands; class SpanningTreeUtilities; class CacheRefreshTimer; class TreeServer; @@ -49,15 +76,55 @@ class Autoconnect; /** This is the main class for the spanningtree module */ -class ModuleSpanningTree : public Module +class ModuleSpanningTree + : public Module + , public Away::EventListener + , public Stats::EventListener + , public CTCTags::EventListener { - 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); + /** 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 broadcast events. */ + Events::ModuleEventProvider broadcasteventprov; + + /** Event provider for our link events. */ + Events::ModuleEventProvider linkeventprov; + + /** Event provider for our message events. */ + Events::ModuleEventProvider messageeventprov; + + /** Event provider for our sync events. */ + Events::ModuleEventProvider synceventprov; + + /** API for accessing user SSL certificates. */ + UserCertificateAPI sslapi; + + /** Tag for marking services pseudoclients. */ + ServiceTag servicetag; public: dynamic_reference DNS; - SpanningTreeUtilities* Utils; + /** Event provider for message tags. */ + ClientProtocol::MessageTagEvent tagevprov; + + ServerCommandManager CmdManager; /** Set to true if inside a spanningtree call, to prevent sending * xlines and other things back to their source @@ -73,33 +140,17 @@ class ModuleSpanningTree : public Module */ void ShowLinks(TreeServer* Current, User* user, int hops); - /** Counts local and remote servers - */ - int CountServs(); - /** Handle LINKS command */ - void HandleLinks(const std::vector& 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 MAP command - */ - bool HandleMap(const std::vector& parameters, User* user); + void HandleLinks(const CommandBase::Params& parameters, User* user); /** Handle SQUIT */ - ModResult HandleSquit(const std::vector& parameters, User* user); + ModResult HandleSquit(const CommandBase::Params& parameters, User* user); /** Handle remote WHOIS */ - ModResult HandleRemoteWhois(const std::vector& parameters, User* user); - - /** Ping all local servers - */ - void DoPingChecks(time_t curtime); + ModResult HandleRemoteWhois(const CommandBase::Params& parameters, User* user); /** Connect a server locally */ @@ -117,65 +168,62 @@ class ModuleSpanningTree : public Module */ void DoConnectTimeout(time_t curtime); - /** Handle remote VERSON + /** Handle remote VERSION */ - ModResult HandleVersion(const std::vector& parameters, User* user); + ModResult HandleVersion(const CommandBase::Params& parameters, User* user); /** Handle CONNECT */ - ModResult HandleConnect(const std::vector& parameters, User* user); + ModResult HandleConnect(const CommandBase::Params& parameters, User* user); - /** Attempt to send a message to a user - */ - void RemoteMessage(User* user, const char* format, ...) CUSTOM_PRINTF(3, 4); + /** Retrieves the event provider for broadcast events. */ + const Events::ModuleEventProvider& GetBroadcastEventProvider() const { return broadcasteventprov; } - /** Returns oper-specific MAP information - */ - const std::string MapOperInfo(TreeServer* Current); + /** Retrieves the event provider for link events. */ + const Events::ModuleEventProvider& GetLinkEventProvider() const { return linkeventprov; } - /** Display a time as a human readable string - */ - std::string TimeToStr(time_t secs); + /** Retrieves the event provider for message events. */ + const Events::ModuleEventProvider& GetMessageEventProvider() const { return messageeventprov; } + + /** Retrieves the event provider for sync events. */ + const Events::ModuleEventProvider& GetSyncEventProvider() const { return synceventprov; } /** ** *** MODULE EVENTS *** **/ - ModResult OnPreCommand(std::string &command, std::vector& parameters, LocalUser *user, bool validated, const std::string &original_line) CXX11_OVERRIDE; - void OnPostCommand(const std::string &command, const std::vector& parameters, LocalUser *user, CmdResult result, const std::string &original_line) CXX11_OVERRIDE; - void OnGetServerDescription(const std::string &servername,std::string &description) CXX11_OVERRIDE; + ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated) CXX11_OVERRIDE; + void OnPostCommand(Command*, const CommandBase::Params& parameters, LocalUser* user, CmdResult result, bool loop) CXX11_OVERRIDE; void OnUserConnect(LocalUser* source) CXX11_OVERRIDE; - void OnUserInvite(User* source,User* dest,Channel* channel, time_t) 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 OnWallops(User* user, const std::string &text) CXX11_OVERRIDE; - void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list) CXX11_OVERRIDE; - void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list) CXX11_OVERRIDE; + void OnUserPostMessage(User* user, const MessageTarget& target, const MessageDetails& details) CXX11_OVERRIDE; + void OnUserPostTagMessage(User* user, const MessageTarget& target, const CTCTags::TagMessageDetails& 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 OnChangeName(User* user, const std::string &gecos) 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 OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason) CXX11_OVERRIDE; void OnPreRehash(User* user, const std::string ¶meter) CXX11_OVERRIDE; - void OnRehash(User* user) CXX11_OVERRIDE; + void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE; void OnOper(User* user, const std::string &opertype) CXX11_OVERRIDE; - void OnLine(User* source, const std::string &host, bool adding, char linetype, long duration, const std::string &reason); void OnAddLine(User *u, XLine *x) CXX11_OVERRIDE; void OnDelLine(User *u, XLine *x) CXX11_OVERRIDE; - void OnMode(User* user, void* dest, int target_type, const std::vector &text, const std::vector &translate) CXX11_OVERRIDE; - ModResult OnStats(char statschar, User* user, string_list &results) CXX11_OVERRIDE; - ModResult OnSetAway(User* user, const std::string &awaymsg) CXX11_OVERRIDE; - void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::vector &modeline, const std::vector &translate); - void ProtoSendMetaData(void* opaque, Extensible* target, const std::string &extname, const std::string &extdata); + ModResult OnStats(Stats::Context& stats) CXX11_OVERRIDE; + void OnUserAway(User* user) CXX11_OVERRIDE; + void OnUserBack(User* user) 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; - CullResult cull(); + void OnMode(User* source, User* u, Channel* c, const Modes::ChangeList& modes, ModeParser::ModeProcessFlag processflags) CXX11_OVERRIDE; + void OnShutdown(const std::string& reason) CXX11_OVERRIDE; + CullResult cull() CXX11_OVERRIDE; ~ModuleSpanningTree(); Version GetVersion() CXX11_OVERRIDE; - void Prioritize(); + void Prioritize() CXX11_OVERRIDE; };