src/modules/m_spanningtree/main.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
   6  *   Copyright (C) 2007-2008 Craig Edwards <craigedwards@brainbox.cc>
   7  *   Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
   8  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
   9  *
  10  * This file is part of InspIRCd.  InspIRCd is free software: you can
  11  * redistribute it and/or modify it under the terms of the GNU General Public
  12  * License as published by the Free Software Foundation, version 2.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  */
  22
  23
  24 #ifndef M_SPANNINGTREE_MAIN_H
  25 #define M_SPANNINGTREE_MAIN_H
  26
  27 #include "inspircd.h"
  28 #include <stdarg.h>
  29
  30 /** If you make a change which breaks the protocol, increment this.
  31  * If you  completely change the protocol, completely change the number.
  32  *
  33  * IMPORTANT: If you make changes, document your changes here, without fail:
  34  * http://wiki.inspircd.org/List_of_protocol_changes_between_versions
  35  *
  36  * Failure to document your protocol changes will result in a painfully
  37  * painful death by pain. You have been warned.
  38  */
  39 const long ProtocolVersion = 1202;
  40 const long MinCompatProtocol = 1201;
  41
  42 /** Forward declarations
  43  */
  44 class SpanningTreeCommands;
  45 class SpanningTreeUtilities;
  46 class CacheRefreshTimer;
  47 class TreeServer;
  48 class Link;
  49 class Autoconnect;
  50
  51 /** This is the main class for the spanningtree module
  52  */
  53 class ModuleSpanningTree : public Module
  54 {
  55         SpanningTreeCommands* commands;
  56
  57  public:
  58         SpanningTreeUtilities* Utils;
  59
  60         CacheRefreshTimer *RefreshTimer;
  61         /** Set to true if inside a spanningtree call, to prevent sending
  62          * xlines and other things back to their source
  63          */
  64         bool loopCall;
  65
  66         /** If true OnUserPostNick() won't update the nick TS before sending the NICK,
  67          * used when handling SVSNICK.
  68          */
  69         bool KeepNickTS;
  70
  71         /** Constructor
  72          */
  73         ModuleSpanningTree();
  74         void init();
  75
  76         /** Shows /LINKS
  77          */
  78         void ShowLinks(TreeServer* Current, User* user, int hops);
  79
  80         /** Counts local and remote servers
  81          */
  82         int CountServs();
  83
  84         /** Handle LINKS command
  85          */
  86         void HandleLinks(const std::vector<std::string>& parameters, User* user);
  87
  88         /** Show MAP output to a user (recursive)
  89          */
  90         void ShowMap(TreeServer* Current, User* user, int depth, int &line, char* names, int &maxnamew, char* stats);
  91
  92         /** Handle MAP command
  93          */
  94         bool HandleMap(const std::vector<std::string>& parameters, User* user);
  95
  96         /** Handle SQUIT
  97          */
  98         ModResult HandleSquit(const std::vector<std::string>& parameters, User* user);
  99
 100         /** Handle remote WHOIS
 101          */
 102         ModResult HandleRemoteWhois(const std::vector<std::string>& parameters, User* user);
 103
 104         /** Ping all local servers
 105          */
 106         void DoPingChecks(time_t curtime);
 107
 108         /** Connect a server locally
 109          */
 110         void ConnectServer(Link* x, Autoconnect* y = NULL);
 111
 112         /** Connect the next autoconnect server
 113          */
 114         void ConnectServer(Autoconnect* y, bool on_timer);
 115
 116         /** Check if any servers are due to be autoconnected
 117          */
 118         void AutoConnectServers(time_t curtime);
 119
 120         /** Check if any connecting servers should timeout
 121          */
 122         void DoConnectTimeout(time_t curtime);
 123
 124         /** Handle remote VERSON
 125          */
 126         ModResult HandleVersion(const std::vector<std::string>& parameters, User* user);
 127
 128         /** Handle CONNECT
 129          */
 130         ModResult HandleConnect(const std::vector<std::string>& parameters, User* user);
 131
 132         /** Attempt to send a message to a user
 133          */
 134         void RemoteMessage(User* user, const char* format, ...) CUSTOM_PRINTF(3, 4);
 135
 136         /** Returns oper-specific MAP information
 137          */
 138         const std::string MapOperInfo(TreeServer* Current);
 139
 140         /** Display a time as a human readable string
 141          */
 142         std::string TimeToStr(time_t secs);
 143
 144         /**
 145          ** *** MODULE EVENTS ***
 146          **/
 147
 148         ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, LocalUser *user, bool validated, const std::string &original_line);
 149         void OnPostCommand(const std::string &command, const std::vector<std::string>& parameters, LocalUser *user, CmdResult result, const std::string &original_line);
 150         void OnGetServerDescription(const std::string &servername,std::string &description);
 151         void OnUserConnect(LocalUser* source);
 152         void OnUserInvite(User* source,User* dest,Channel* channel, time_t);
 153         void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
 154         void OnWallops(User* user, const std::string &text);
 155         void OnUserNotice(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
 156         void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
 157         void OnBackgroundTimer(time_t curtime);
 158         void OnUserJoin(Membership* memb, bool sync, bool created, CUList& excepts);
 159         void OnChangeHost(User* user, const std::string &newhost);
 160         void OnChangeName(User* user, const std::string &gecos);
 161         void OnChangeIdent(User* user, const std::string &ident);
 162         void OnUserPart(Membership* memb, std::string &partmessage, CUList& excepts);
 163         void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message);
 164         void OnUserPostNick(User* user, const std::string &oldnick);
 165         void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& excepts);
 166         void OnRemoteKill(User* source, User* dest, const std::string &reason, const std::string &operreason);
 167         void OnPreRehash(User* user, const std::string &parameter);
 168         void OnRehash(User* user);
 169         void OnOper(User* user, const std::string &opertype);
 170         void OnLine(User* source, const std::string &host, bool adding, char linetype, long duration, const std::string &reason);
 171         void OnAddLine(User *u, XLine *x);
 172         void OnDelLine(User *u, XLine *x);
 173         void OnMode(User* user, void* dest, int target_type, const std::vector<std::string> &text, const std::vector<TranslateType> &translate);
 174         ModResult OnStats(char statschar, User* user, string_list &results);
 175         ModResult OnSetAway(User* user, const std::string &awaymsg);
 176         void ProtoSendMode(void* opaque, TargetTypeFlags target_type, void* target, const std::vector<std::string> &modeline, const std::vector<TranslateType> &translate);
 177         void ProtoSendMetaData(void* opaque, Extensible* target, const std::string &extname, const std::string &extdata);
 178         void OnLoadModule(Module* mod);
 179         void OnUnloadModule(Module* mod);
 180         ModResult OnAcceptConnection(int newsock, ListenSocket* from, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
 181         void OnRequest(Request& request);
 182         CullResult cull();
 183         ~ModuleSpanningTree();
 184         Version GetVersion();
 185         void Prioritize();
 186 };
 187
 188 #endif