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
  27 /* Foward declarations */
  28 class TreeServer;
  29 class TreeSocket;
  30 class Link;
  31 class Autoconnect;
  32 class ModuleSpanningTree;
  33 class SpanningTreeUtilities;
  34
  35 /* This hash_map holds the hash equivalent of the server
  36  * tree, used for rapid linear lookups.
  37  */
  38 typedef TR1NS::unordered_map<std::string, TreeServer*, irc::insensitive, irc::StrHashComp> server_hash;
  39
  40 typedef std::set<TreeServer*> TreeServerList;
  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         /** Creates a line in the :<prefix> <command> [<params>] format
  48          */
  49         std::string ConstructLine(const std::string& prefix, const std::string& command, const parameterlist& params);
  50
  51  public:
  52         /** Creator module
  53          */
  54         ModuleSpanningTree* Creator;
  55
  56         /** Flatten links and /MAP for non-opers
  57          */
  58         bool FlatLinks;
  59         /** Hide U-Lined servers in /MAP and /LINKS
  60          */
  61         bool HideULines;
  62         /** Announce TS changes to channels on merge
  63          */
  64         bool AnnounceTSChange;
  65
  66         /** Allow modules marked as VF_OPTCOMMON to be mismatched when linking
  67          */
  68         bool AllowOptCommon;
  69
  70         /** Make snomasks +CQ quiet during bursts and splits
  71          */
  72         bool quiet_bursts;
  73
  74         /* Number of seconds that a server can go without ping
  75          * before opers are warned of high latency.
  76          */
  77         int PingWarnTime;
  78         /** This variable represents the root of the server tree
  79          */
  80         TreeServer *TreeRoot;
  81         /** IPs allowed to link to us
  82          */
  83         std::vector<std::string> ValidIPs;
  84         /** Hash of currently connected servers by name
  85          */
  86         server_hash serverlist;
  87         /** Hash of currently known server ids
  88          */
  89         server_hash sidlist;
  90         /** Hash of servers currently bursting but not initialized as connected
  91          */
  92         std::map<irc::string,TreeSocket*> burstingserverlist;
  93         /** List of all outgoing sockets and their timeouts
  94          */
  95         std::map<TreeSocket*, std::pair<std::string, int> > timeoutlist;
  96         /** Holds the data from the <link> tags in the conf
  97          */
  98         std::vector<reference<Link> > LinkBlocks;
  99         /** Holds the data from the <autoconnect> tags in the conf
 100          */
 101         std::vector<reference<Autoconnect> > AutoconnectBlocks;
 102
 103         /** True (default) if we are to use challenge-response HMAC
 104          * to authenticate passwords.
 105          *
 106          * NOTE: This defaults to on, but should be turned off if
 107          * you are linking to an older version of inspircd.
 108          */
 109         bool ChallengeResponse;
 110
 111         /** Ping frequency of server to server links
 112          */
 113         int PingFreq;
 114
 115         /** Initialise utility class
 116          */
 117         SpanningTreeUtilities(ModuleSpanningTree* Creator);
 118
 119         /** Prepare for class destruction
 120          */
 121         CullResult cull();
 122
 123         /** Destroy class and free listeners etc
 124          */
 125         ~SpanningTreeUtilities();
 126
 127         void RouteCommand(TreeServer*, const std::string&, const parameterlist&, User*);
 128
 129         /** Send a message from this server to one other local or remote
 130          */
 131         bool DoOneToOne(const std::string& prefix, const std::string& command, const parameterlist& params, const std::string& target);
 132
 133         /** Send a message from this server to all but one other, local or remote
 134          */
 135         bool DoOneToAllButSender(const std::string &prefix, const std::string &command, const parameterlist& params, const std::string& omit);
 136
 137         /** Send a message from this server to all others
 138          */
 139         bool DoOneToMany(const std::string &prefix, const std::string &command, const parameterlist &params);
 140
 141         /** Read the spanningtree module's tags from the config file
 142          */
 143         void ReadConfiguration();
 144
 145         /** Compile a list of servers which contain members of channel c
 146          */
 147         void GetListOfServersForChannel(Channel* c, TreeServerList &list, char status, const CUList &exempt_list);
 148
 149         /** Find a server by name
 150          */
 151         TreeServer* FindServer(const std::string &ServerName);
 152
 153         /** Find server by SID
 154          */
 155         TreeServer* FindServerID(const std::string &id);
 156
 157         /** Find a route to a server by name
 158          */
 159         TreeServer* BestRouteTo(const std::string &ServerName);
 160
 161         /** Find a server by glob mask
 162          */
 163         TreeServer* FindServerMask(const std::string &ServerName);
 164
 165         /** Find a link tag from a server name
 166          */
 167         Link* FindLink(const std::string& name);
 168
 169         /** Refresh the IP cache used for allowing inbound connections
 170          */
 171         void RefreshIPCache();
 172
 173         /** Sends a PRIVMSG or a NOTICE to a channel obeying an exempt list and an optional prefix
 174          */
 175         void SendChannelMessage(const std::string& prefix, Channel* target, const std::string &text, char status, const CUList& exempt_list, const char* message_type);
 176 };