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