src/modules/m_spanningtree/utils.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
   6  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
   7  *   Copyright (C) 2007 Craig Edwards <craigedwards@brainbox.cc>
   8  *
   9  * This file is part of InspIRCd.  InspIRCd is free software: you can
  10  * redistribute it and/or modify it under the terms of the GNU General Public
  11  * License as published by the Free Software Foundation, version 2.
  12  *
  13  * This program is distributed in the hope that it will be useful, but WITHOUT
  14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22
  23 #pragma once
  24
  25 #include "inspircd.h"
  26 #include "cachetimer.h"
  27
  28 class TreeServer;
  29 class TreeSocket;
  30 class Link;
  31 class Autoconnect;
  32 class ModuleSpanningTree;
  33 class SpanningTreeUtilities;
  34 class CmdBuilder;
  35
  36 extern SpanningTreeUtilities* Utils;
  37
  38 /** Associative container type, mapping server names/ids to TreeServers
  39  */
  40 typedef TR1NS::unordered_map<std::string, TreeServer*, irc::insensitive, irc::StrHashComp> server_hash;
  41
  42 /** Contains helper functions and variables for this module,
  43  * and keeps them out of the global namespace
  44  */
  45 class SpanningTreeUtilities : public classbase
  46 {
  47         CacheRefreshTimer RefreshTimer;
  48
  49  public:
  50         typedef std::set<TreeSocket*> TreeSocketSet;
  51         typedef std::map<TreeSocket*, std::pair<std::string, int> > TimeoutList;
  52
  53         /** Creator module
  54          */
  55         ModuleSpanningTree* Creator;
  56
  57         /** Flatten links and /MAP for non-opers
  58          */
  59         bool FlatLinks;
  60         /** Hide U-Lined servers in /MAP and /LINKS
  61          */
  62         bool HideULines;
  63         /** Announce TS changes to channels on merge
  64          */
  65         bool AnnounceTSChange;
  66
  67         /** Allow modules marked as VF_OPTCOMMON to be mismatched when linking
  68          */
  69         bool AllowOptCommon;
  70
  71         /** Make snomasks +CQ quiet during bursts and splits
  72          */
  73         bool quiet_bursts;
  74
  75         /* Number of seconds that a server can go without ping
  76          * before opers are warned of high latency.
  77          */
  78         int PingWarnTime;
  79         /** This variable represents the root of the server tree
  80          */
  81         TreeServer *TreeRoot;
  82         /** IPs allowed to link to us
  83          */
  84         std::vector<std::string> ValidIPs;
  85         /** Hash of currently connected servers by name
  86          */
  87         server_hash serverlist;
  88         /** Hash of currently known server ids
  89          */
  90         server_hash sidlist;
  91         /** List of all outgoing sockets and their timeouts
  92          */
  93         TimeoutList timeoutlist;
  94         /** Holds the data from the <link> tags in the conf
  95          */
  96         std::vector<reference<Link> > LinkBlocks;
  97         /** Holds the data from the <autoconnect> tags in the conf
  98          */
  99         std::vector<reference<Autoconnect> > AutoconnectBlocks;
 100
 101         /** Ping frequency of server to server links
 102          */
 103         int PingFreq;
 104
 105         /** Initialise utility class
 106          */
 107         SpanningTreeUtilities(ModuleSpanningTree* Creator);
 108
 109         /** Prepare for class destruction
 110          */
 111         CullResult cull();
 112
 113         /** Destroy class and free listeners etc
 114          */
 115         ~SpanningTreeUtilities();
 116
 117         void RouteCommand(TreeServer* origin, CommandBase* cmd, const parameterlist& parameters, User* user);
 118
 119         /** Send a message from this server to one other local or remote
 120          */
 121         void DoOneToOne(const CmdBuilder& params, Server* target);
 122
 123         /** Send a message from this server to all but one other, local or remote
 124          */
 125         void DoOneToAllButSender(const CmdBuilder& params, TreeServer* omit);
 126
 127         /** Send a message from this server to all others
 128          */
 129         void DoOneToMany(const CmdBuilder& params);
 130
 131         /** Read the spanningtree module's tags from the config file
 132          */
 133         void ReadConfiguration();
 134
 135         /** Handle nick collision
 136          */
 137         bool DoCollision(User* u, TreeServer* server, time_t remotets, const std::string& remoteident, const std::string& remoteip, const std::string& remoteuid, const char* collidecmd);
 138
 139         /** Compile a list of servers which contain members of channel c
 140          */
 141         void GetListOfServersForChannel(Channel* c, TreeSocketSet& list, char status, const CUList& exempt_list);
 142
 143         /** Find a server by name or SID
 144          */
 145         TreeServer* FindServer(const std::string &ServerName);
 146
 147         /** Find server by SID
 148          */
 149         TreeServer* FindServerID(const std::string &id);
 150
 151         /** Find a server based on a target string.
 152          * @param target Target string where a command should be routed to. May be a server name, a sid, a nickname or a uuid.
 153          */
 154         TreeServer* FindRouteTarget(const std::string& target);
 155
 156         /** Find a server by glob mask
 157          */
 158         TreeServer* FindServerMask(const std::string &ServerName);
 159
 160         /** Find a link tag from a server name
 161          */
 162         Link* FindLink(const std::string& name);
 163
 164         /** Refresh the IP cache used for allowing inbound connections
 165          */
 166         void RefreshIPCache();
 167
 168         /** Sends a PRIVMSG or a NOTICE to a channel obeying an exempt list and an optional prefix
 169          */
 170         void SendChannelMessage(const std::string& prefix, Channel* target, const std::string& text, char status, const CUList& exempt_list, const char* message_type, TreeSocket* omit = NULL);
 171 };
 172
 173 inline void SpanningTreeUtilities::DoOneToMany(const CmdBuilder& params)
 174 {
 175         DoOneToAllButSender(params, NULL);
 176 }