src/modules/m_spanningtree/utils.h

   1 /*       +------------------------------------+\r *       | Inspire Internet Relay Chat Daemon |\r *       +------------------------------------+\r *\r *  InspIRCd: (C) 2002-2007 InspIRCd Development Team\r * See: http://www.inspircd.org/wiki/index.php/Credits\r *\r * This program is free but copyrighted software; see\r *            the file COPYING for details.\r *\r * ---------------------------------------------------\r */\r\r#ifndef __ST__UTIL__\r#define __ST__UTIL__\r\r#include "configreader.h"\r#include "users.h"\r#include "channels.h"\r#include "modules.h"\r#include "inspircd.h"\r\r/* Foward declarations */\rclass TreeServer;\rclass TreeSocket;\rclass Link;\rclass ModuleSpanningTree;\r\r/* This hash_map holds the hash equivalent of the server\r * tree, used for rapid linear lookups.\r */\r#ifdef WINDOWS\rtypedef nspace::hash_map<std::string, TreeServer*, nspace::hash_compare<string, less<string> > > server_hash;\r#else\rtypedef nspace::hash_map<std::string, TreeServer*, nspace::hash<string>, irc::StrHashComp> server_hash;\r#endif\r\rtypedef std::map<TreeServer*,TreeServer*> TreeServerList;\r\r/** A group of modules that implement InspSocketHook\r * that we can use to hook our server to server connections.\r */\rtypedef std::map<irc::string, Module*> hookmodules;\r\r/** Contains helper functions and variables for this module,\r * and keeps them out of the global namespace\r */\rclass SpanningTreeUtilities\r{\r private:\r        /** Creator server\r      */\r    InspIRCd* ServerInstance;\r public:\r     /** Creator module\r      */\r    ModuleSpanningTree* Creator;\r   /** Remote servers that are currently bursting\r  */\r    server_hash RemoteServersBursting;\r     /** Flatten links and /MAP for non-opers\r        */\r    bool FlatLinks;\r        /** Hide U-Lined servers in /MAP and /LINKS\r     */\r    bool HideULines;\r       /** Announce TS changes to channels on merge\r    */\r    bool AnnounceTSChange;\r /** Synchronize timestamps between servers\r      */\r    bool EnableTimeSync;\r   /** Make snomasks +CQ quiet during bursts and splits\r    */\r    bool quiet_bursts;\r     /** Socket bindings for listening sockets\r       */\r    std::vector<TreeSocket*> Bindings;\r     /* Number of seconds that a server can go without ping\r  * before opers are warned of high latency.\r     */\r    int PingWarnTime;\r      /** This variable represents the root of the server tree\r        */\r    TreeServer *TreeRoot;\r  /** IPs allowed to link to us\r   */\r    std::vector<std::string> ValidIPs;\r     /** Hash of currently connected servers by name\r         */\r    server_hash serverlist;\r        /** Hash of servers currently bursting but not initialized as connected\r         */\r    std::map<irc::string,TreeSocket*> burstingserverlist;\r  /** Holds the data from the <link> tags in the conf\r     */\r    std::vector<Link> LinkBlocks;\r  /** Holds a bitmask of queued xline types waiting to be applied.\r        * Will be a mask containing values APPLY_GLINES, APPLY_KLINES,\r         * APPLY_QLINES and APPLY_ZLINES.\r       */\r    int lines_to_apply;\r\r   /** If this is true, this server is the master sync server for time\r     * synching - e.g. it is the server with its clock correct. It will\r     * send out the correct time at intervals.\r      */\r    bool MasterTime;\r\r      /** List of module pointers which can provide I/O abstraction\r   */\r    hookmodules hooks;\r\r    /** List of module names which can provide I/O abstraction\r      */\r    std::vector<std::string> hooknames;\r\r   /** True (default) if we are to use challenge-response HMAC\r     * to authenticate passwords.\r   *\r      * NOTE: This defaults to on, but should be turned off if\r       * you are linking to an older version of inspircd.\r     */\r    bool ChallengeResponse;\r\r       /** Initialise utility class\r    */\r    SpanningTreeUtilities(InspIRCd* Instance, ModuleSpanningTree* Creator);\r        /** Destroy class and free listeners etc\r        */\r    ~SpanningTreeUtilities();\r      /** Send a message from this server to one other local or remote\r        */\r    bool DoOneToOne(const std::string &prefix, const std::string &command, std::deque<std::string> &params, std::string target);\r   /** Send a message from this server to all but one other, local or remote\r       */\r    bool DoOneToAllButSender(const std::string &prefix, const std::string &command, std::deque<std::string> &params, std::string omit);\r    /** Send a message from this server to all but one other, local or remote\r       */\r    bool DoOneToAllButSender(const char* prefix, const char* command, std::deque<std::string> &params, std::string omit);\r  /** Send a message from this server to all others\r       */\r    bool DoOneToMany(const std::string &prefix, const std::string &command, std::deque<std::string> &params);\r      /** Send a message from this server to all others\r       */\r    bool DoOneToMany(const char* prefix, const char* command, std::deque<std::string> &params);\r    /** 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)\r         */\r    bool DoOneToAllButSenderRaw(const std::string &data, const std::string &omit, const std::string &prefix, const irc::string &command, std::deque<std::string> &params);\r /** Read the spanningtree module's tags from the config file\r    */\r    void ReadConfiguration(bool rebind);\r   /** Add a server to the server list for GetListOfServersForChannel\r      */\r    void AddThisServer(TreeServer* server, TreeServerList &list);\r  /** Compile a list of servers which contain members of channel c\r        */\r    void GetListOfServersForChannel(chanrec* c, TreeServerList &list, char status, const CUList &exempt_list);\r     /** Find a server by name\r       */\r    TreeServer* FindServer(const std::string &ServerName);\r /** Find a remote bursting server by name\r       */\r    TreeServer* FindRemoteBurstServer(TreeServer* Server);\r /** Set a remote server to bursting or not bursting\r     */\r    void SetRemoteBursting(TreeServer* Server, bool bursting);\r     /** Find a route to a server by name\r    */\r    TreeServer* BestRouteTo(const std::string &ServerName);\r        /** Find a server by glob mask\r  */\r    TreeServer* FindServerMask(const std::string &ServerName);\r     /** Returns true if this is a server name we recognise\r  */\r    bool IsServer(const std::string &ServerName);\r  /** Attempt to connect to the failover link of link x\r   */\r    void DoFailOver(Link* x);\r      /** Find a link tag from a server name\r  */\r    Link* FindLink(const std::string& name);\r       /** Refresh the IP cache used for allowing inbound connections\r  */\r    void RefreshIPCache();\r\r        TreeSocket* FindBurstingServer(const std::string &ServerName);\r\r        void AddBurstingServer(const std::string &ServerName, TreeSocket* s);\r\r void DelBurstingServer(TreeSocket* s);\r};\r\r#endif\r