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