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 #ifndef M_SPANNINGTREE_UTILS_H
  24 #define M_SPANNINGTREE_UTILS_H
  25
  26 #include "inspircd.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 /* This hash_map holds the hash equivalent of the server
  37  * tree, used for rapid linear lookups.
  38  */
  39 #if defined(WINDOWS) && !defined(HASHMAP_DEPRECATED)
  40         typedef nspace::hash_map<std::string, TreeServer*, nspace::hash_compare<std::string, std::less<std::string> > > server_hash;
  41 #else
  42         #ifdef HASHCOMP_DEPRECATED
  43                 typedef nspace::hash_map<std::string, TreeServer*, nspace::insensitive, irc::StrHashComp> server_hash;
  44         #else
  45                 typedef nspace::hash_map<std::string, TreeServer*, nspace::hash<std::string>, irc::StrHashComp> server_hash;
  46         #endif
  47 #endif
  48
  49 typedef std::map<TreeServer*,TreeServer*> TreeServerList;
  50
  51 /** Contains helper functions and variables for this module,
  52  * and keeps them out of the global namespace
  53  */
  54 class SpanningTreeUtilities : public classbase
  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         /** Hash of servers currently bursting but not initialized as connected
  96          */
  97         std::map<irc::string,TreeSocket*> burstingserverlist;
  98         /** List of all outgoing sockets and their timeouts
  99          */
 100         std::map<TreeSocket*, std::pair<std::string, int> > timeoutlist;
 101         /** Holds the data from the <link> tags in the conf
 102          */
 103         std::vector<reference<Link> > LinkBlocks;
 104         /** Holds the data from the <autoconnect> tags in the conf
 105          */
 106         std::vector<reference<Autoconnect> > AutoconnectBlocks;
 107
 108         /** True (default) if we are to use challenge-response HMAC
 109          * to authenticate passwords.
 110          *
 111          * NOTE: This defaults to on, but should be turned off if
 112          * you are linking to an older version of inspircd.
 113          */
 114         bool ChallengeResponse;
 115
 116         /** Ping frequency of server to server links
 117          */
 118         int PingFreq;
 119
 120         /** Initialise utility class
 121          */
 122         SpanningTreeUtilities(ModuleSpanningTree* Creator);
 123
 124         /** Prepare for class destruction
 125          */
 126         CullResult cull();
 127
 128         /** Destroy class and free listeners etc
 129          */
 130         ~SpanningTreeUtilities();
 131
 132         void RouteCommand(TreeServer*, const std::string&, const parameterlist&, User*);
 133
 134         /** Send a message from this server to one other local or remote
 135          */
 136         bool DoOneToOne(const std::string &prefix, const std::string &command, const parameterlist &params, std::string target);
 137
 138         /** Send a message from this server to all but one other, local or remote
 139          */
 140         bool DoOneToAllButSender(const std::string &prefix, const std::string &command, const parameterlist &params, std::string omit);
 141
 142         /** Send a message from this server to all but one other, local or remote
 143          */
 144         bool DoOneToAllButSender(const char* prefix, const char* command, const parameterlist &params, std::string omit);
 145
 146         /** Send a message from this server to all others
 147          */
 148         bool DoOneToMany(const std::string &prefix, const std::string &command, const parameterlist &params);
 149
 150         /** Send a message from this server to all others
 151          */
 152         bool DoOneToMany(const char* prefix, const char* command, const parameterlist &params);
 153
 154         /** Send a message from this server to all others, without doing any processing on the command (e.g. send it as-is with colons and all)
 155          */
 156         bool DoOneToAllButSenderRaw(const std::string &data, const std::string &omit, const std::string &prefix, const irc::string &command, const parameterlist &params);
 157
 158         /** Read the spanningtree module's tags from the config file
 159          */
 160         void ReadConfiguration();
 161
 162         /** Add a server to the server list for GetListOfServersForChannel
 163          */
 164         void AddThisServer(TreeServer* server, TreeServerList &list);
 165
 166         /** Compile a list of servers which contain members of channel c
 167          */
 168         void GetListOfServersForChannel(Channel* c, TreeServerList &list, char status, const CUList &exempt_list);
 169
 170         /** Find a server by name
 171          */
 172         TreeServer* FindServer(const std::string &ServerName);
 173
 174         /** Find server by SID
 175          */
 176         TreeServer* FindServerID(const std::string &id);
 177
 178         /** Find a route to a server by name
 179          */
 180         TreeServer* BestRouteTo(const std::string &ServerName);
 181
 182         /** Find a server by glob mask
 183          */
 184         TreeServer* FindServerMask(const std::string &ServerName);
 185
 186         /** Returns true if this is a server name we recognise
 187          */
 188         bool IsServer(const std::string &ServerName);
 189
 190         /** Find a link tag from a server name
 191          */
 192         Link* FindLink(const std::string& name);
 193
 194         /** Refresh the IP cache used for allowing inbound connections
 195          */
 196         void RefreshIPCache();
 197 };
 198
 199 #endif