]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/xline.h
Use IsCTCP in blockcolor for ignoring CTCPs.
[user/henk/code/inspircd.git] / include / xline.h
index 7bf291253d00f6e97926d55fc974b17e2ed06877..420f10986b4a09d30cdc2eea697983779abe024f 100644 (file)
@@ -1,42 +1,47 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *   Copyright (C) 2019 Matt Schatz <genius3000@g3k.solutions>
+ *   Copyright (C) 2012-2013, 2017-2018, 2020 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2006-2008 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2004, 2006-2008, 2010 Craig Edwards <brain@inspircd.org>
  *
- * This program is free but copyrighted software; see
- *         the file COPYING for details.
+ * This file is part of InspIRCd.  InspIRCd is free software: you can
+ * redistribute it and/or modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation, version 2.
  *
- * ---------------------------------------------------
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#ifndef __XLINE_H
-#define __XLINE_H
-
-// include the common header files
 
-#include <string>
-#include <deque>
-#include <vector>
-#include "users.h"
-#include "channels.h"
+#pragma once
 
-const int APPLY_GLINES         = 1;
-const int APPLY_KLINES         = 2;
-const int APPLY_QLINES         = 4;
-const int APPLY_ZLINES         = 8;
-const int APPLY_PERM_ONLY      = 16;
-const int APPLY_ALL            = APPLY_GLINES | APPLY_KLINES | APPLY_QLINES | APPLY_ZLINES;
-
-/** XLine is the base class for ban lines such as G lines and K lines.
+/** XLine is the base class for ban lines such as G-lines and K-lines.
+ * Modules may derive from this, and their xlines will automatically be
+ * handled as expected by any protocol modules (e.g. m_spanningtree will
+ * propagate them using AddLine). The process of translating a type+pattern
+ * to a known line type is done by means of an XLineFactory object (see
+ * below).
  */
 class CoreExport XLine : public classbase
 {
  protected:
 
-       InspIRCd* ServerInstance;
-       void DefaultApply(User* u, char line);
+       /** Default 'apply' action. Quits the user.
+        * @param u User to apply the line against
+        * @param line The line typed, used for display purposes in the quit message
+        * @param bancache If true, the user will be added to the bancache if they match. Else not.
+        */
+       void DefaultApply(User* u, const std::string &line, bool bancache);
 
  public:
 
@@ -45,12 +50,16 @@ class CoreExport XLine : public classbase
         * @param d The duration of the xline
         * @param src The sender of the xline
         * @param re The reason of the xline
-        */
-       XLine(InspIRCd* Instance, time_t s_time, long d, const char* src, const char* re)
-               : ServerInstance(Instance), set_time(s_time), duration(d)
+        * @param t The line type, should be set by the derived class constructor
+        */
+       XLine(time_t s_time, unsigned long d, const std::string& src, const std::string& re, const std::string& t)
+               : set_time(s_time)
+               , duration(d)
+               , source(src)
+               , reason(re)
+               , type(t)
+               , from_config(false)
        {
-               source = strdup(src);
-               reason = strdup(re);
                expiry = set_time + duration;
        }
 
@@ -58,45 +67,91 @@ class CoreExport XLine : public classbase
         */
        virtual ~XLine()
        {
-               free(reason);
-               free(source);
+       }
+
+       /** Change creation time of an xline. Updates expiry
+        * to be after the creation time.
+        */
+       virtual void SetCreateTime(time_t created)
+       {
+               set_time = created;
+               expiry = created + duration;
        }
 
        /** Returns true whether or not the given user is covered by this line.
+        * @param u The user to match against. The mechanics of the match
+        * are defined by the derived class.
+        * @return True if there is a match.
         */
        virtual bool Matches(User *u) = 0;
 
-       virtual bool Matches(const std::string &str);
+       /** Returns true whether or not the given string is covered by this line.
+        * @param str The string to match against. The details of what must be
+        * in this string and the mechanics of the match are defined by the
+        * derived class.
+        * @return True if there is a match
+        */
+       virtual bool Matches(const std::string &str) = 0;
 
+       /** Apply a line against a user. The mechanics of what occurs when
+        * the line is applied are specific to the derived class.
+        * @param u The user to apply against
+        */
        virtual void Apply(User* u);
 
-       virtual void Unset() { };
+       /** Called when the line is unset either via expiry or
+        * via explicit removal.
+        */
+       virtual void Unset() { }
+
+       /** Called when the expiry message is to be displayed for the
+        * line. Usually a line in the form 'expiring X-line blah, set by...'
+        * see the DisplayExpiry methods of GLine, ELine etc.
+        */
+       virtual void DisplayExpiry();
 
-       virtual void DisplayExpiry() = 0;
+       /** Returns the displayable form of the pattern for this xline,
+        * e.g. '*\@foo' or '*baz*'. This must always return the full pattern
+        * in a form which can be used to construct an entire derived xline,
+        * even if it is stored differently internally (e.g. GLine stores the
+        * ident and host parts separately but will still return ident\@host
+        * for its Displayable() method).
+        */
+       virtual const std::string& Displayable() = 0;
+
+       /** Called when the xline has just been added.
+        */
+       virtual void OnAdd() { }
 
        /** The time the line was added.
         */
        time_t set_time;
-       
-       /** The duration of the ban, or 0 if permenant
+
+       /** The duration of the ban, or 0 if permanent
         */
-       long duration;
-       
+       unsigned long duration;
+
        /** Source of the ban. This can be a servername or an oper nickname
         */
-       char* source;
-       
+       std::string source;
+
        /** Reason for the ban
         */
-       char* reason;
+       std::string reason;
 
-       /** Expiry time
+       /** Expiry time. Does not contain useful data if the duration is 0.
         */
        time_t expiry;
 
-       /** Q, K, etc. Don't change this. Constructors set it.
+       /** "Q", "K", etc. Set only by derived classes constructor to the
+        * type of line this is.
         */
-       char type;
+       const std::string type;
+
+       // Whether this XLine was loaded from the server config.
+       bool from_config;
+
+       virtual bool IsBurstable();
 };
 
 /** KLine class
@@ -104,7 +159,8 @@ class CoreExport XLine : public classbase
 class CoreExport KLine : public XLine
 {
   public:
-       /** Create a K-Line.
+
+       /** Create a K-line.
         * @param s_time The set time
         * @param d The duration of the xline
         * @param src The sender of the xline
@@ -112,33 +168,37 @@ class CoreExport KLine : public XLine
         * @param ident Ident to match
         * @param host Host to match
         */
-       KLine(InspIRCd* Instance, time_t s_time, long d, const char* src, const char* re, const char* ident, const char* host) : XLine(Instance, s_time, d, src, re)
+       KLine(time_t s_time, unsigned long d, const std::string& src, const std::string& re, const std::string& ident, const std::string& host)
+               : XLine(s_time, d, src, re, "K"), identmask(ident), hostmask(host)
        {
-               identmask = strdup(ident);
-               hostmask = strdup(host);
-               type = 'K';
+               matchtext = this->identmask;
+               matchtext.append("@").append(this->hostmask);
        }
 
        /** Destructor
         */
        ~KLine()
        {
-               free(identmask);
-               free(hostmask);
        }
 
-       virtual bool Matches(User *u);
+       bool Matches(User* u) CXX11_OVERRIDE;
 
-       virtual void Apply(User* u);
+       bool Matches(const std::string& str) CXX11_OVERRIDE;
 
-       virtual void DisplayExpiry();
+       void Apply(User* u) CXX11_OVERRIDE;
 
-       /** Ident mask
+       const std::string& Displayable() CXX11_OVERRIDE;
+
+       bool IsBurstable() CXX11_OVERRIDE;
+
+       /** Ident mask (ident part only)
         */
-       char* identmask;
-       /** Host mask
+       std::string identmask;
+       /** Host mask (host part only)
         */
-       char* hostmask;
+       std::string hostmask;
+
+       std::string matchtext;
 };
 
 /** GLine class
@@ -146,7 +206,7 @@ class CoreExport KLine : public XLine
 class CoreExport GLine : public XLine
 {
   public:
-       /** Create a G-Line.
+       /** Create a G-line.
         * @param s_time The set time
         * @param d The duration of the xline
         * @param src The sender of the xline
@@ -154,33 +214,35 @@ class CoreExport GLine : public XLine
         * @param ident Ident to match
         * @param host Host to match
         */
-       GLine(InspIRCd* Instance, time_t s_time, long d, const char* src, const char* re, const char* ident, const char* host) : XLine(Instance, s_time, d, src, re)
+       GLine(time_t s_time, unsigned long d, const std::string& src, const std::string& re, const std::string& ident, const std::string& host)
+               : XLine(s_time, d, src, re, "G"), identmask(ident), hostmask(host)
        {
-               identmask = strdup(ident);
-               hostmask = strdup(host);
-               type = 'G';
+               matchtext = this->identmask;
+               matchtext.append("@").append(this->hostmask);
        }
 
        /** Destructor
         */
        ~GLine()
        {
-               free(identmask);
-               free(hostmask);
        }
 
-       virtual bool Matches(User *u);
+       bool Matches(User* u) CXX11_OVERRIDE;
 
-       virtual void Apply(User* u);
+       bool Matches(const std::string& str) CXX11_OVERRIDE;
 
-       virtual void DisplayExpiry();
+       void Apply(User* u)  CXX11_OVERRIDE;
+
+       const std::string& Displayable() CXX11_OVERRIDE;
 
-       /** Ident mask
+       /** Ident mask (ident part only)
         */
-       char* identmask;
-       /** Host mask
+       std::string identmask;
+       /** Host mask (host part only)
         */
-       char* hostmask;
+       std::string hostmask;
+
+       std::string matchtext;
 };
 
 /** ELine class
@@ -188,7 +250,7 @@ class CoreExport GLine : public XLine
 class CoreExport ELine : public XLine
 {
   public:
-       /** Create an E-Line.
+       /** Create an E-line.
         * @param s_time The set time
         * @param d The duration of the xline
         * @param src The sender of the xline
@@ -196,31 +258,35 @@ class CoreExport ELine : public XLine
         * @param ident Ident to match
         * @param host Host to match
         */
-       ELine(InspIRCd* Instance, time_t s_time, long d, const char* src, const char* re, const char* ident, const char* host) : XLine(Instance, s_time, d, src, re)
+       ELine(time_t s_time, unsigned long d, const std::string& src, const std::string& re, const std::string& ident, const std::string& host)
+               : XLine(s_time, d, src, re, "E"), identmask(ident), hostmask(host)
        {
-               identmask = strdup(ident);
-               hostmask = strdup(host);
-               type = 'E';
+               matchtext = this->identmask;
+               matchtext.append("@").append(this->hostmask);
        }
 
        ~ELine()
        {
-               free(identmask);
-               free(hostmask);
        }
 
-       virtual bool Matches(User *u);
+       bool Matches(User* u) CXX11_OVERRIDE;
 
-       virtual void Unset();
+       bool Matches(const std::string& str) CXX11_OVERRIDE;
 
-       virtual void DisplayExpiry();
+       void Unset() CXX11_OVERRIDE;
+
+       void OnAdd() CXX11_OVERRIDE;
+
+       const std::string& Displayable() CXX11_OVERRIDE;
 
-       /** Ident mask
+       /** Ident mask (ident part only)
         */
-       char* identmask;
-       /** Host mask
+       std::string identmask;
+       /** Host mask (host part only)
         */
-       char* hostmask;
+       std::string hostmask;
+
+       std::string matchtext;
 };
 
 /** ZLine class
@@ -228,37 +294,35 @@ class CoreExport ELine : public XLine
 class CoreExport ZLine : public XLine
 {
   public:
-       /** Create a Z-Line.
+       /** Create a Z-line.
         * @param s_time The set time
         * @param d The duration of the xline
         * @param src The sender of the xline
         * @param re The reason of the xline
         * @param ip IP to match
         */
-       ZLine(InspIRCd* Instance, time_t s_time, long d, const char* src, const char* re, const char* ip) : XLine(Instance, s_time, d, src, re)
+       ZLine(time_t s_time, unsigned long d, const std::string& src, const std::string& re, const std::string& ip)
+               : XLine(s_time, d, src, re, "Z"), ipaddr(ip)
        {
-               ipaddr = strdup(ip);
-               type = 'Z';
        }
 
        /** Destructor
         */
        ~ZLine()
        {
-               free(ipaddr);
        }
 
-       virtual bool Matches(User *u);
+       bool Matches(User* u) CXX11_OVERRIDE;
 
-       virtual bool Matches(const std::string &str);
+       bool Matches(const std::string& str) CXX11_OVERRIDE;
 
-       virtual void Apply(User* u);
+       void Apply(User* u) CXX11_OVERRIDE;
 
-       virtual void DisplayExpiry();
+       const std::string& Displayable() CXX11_OVERRIDE;
 
-       /** IP mask
+       /** IP mask (no ident part)
         */
-       char* ipaddr;
+       std::string ipaddr;
 };
 
 /** QLine class
@@ -266,256 +330,214 @@ class CoreExport ZLine : public XLine
 class CoreExport QLine : public XLine
 {
   public:
-       /** Create a G-Line.
+       /** Create a Q-line.
         * @param s_time The set time
         * @param d The duration of the xline
         * @param src The sender of the xline
         * @param re The reason of the xline
         * @param nickname Nickname to match
         */
-       QLine(InspIRCd* Instance, time_t s_time, long d, const char* src, const char* re, const char* nickname) : XLine(Instance, s_time, d, src, re)
+       QLine(time_t s_time, unsigned long d, const std::string& src, const std::string& re, const std::string& nickname)
+               : XLine(s_time, d, src, re, "Q"), nick(nickname)
        {
-               nick = strdup(nickname);
-               type = 'Q';
        }
 
        /** Destructor
         */
        ~QLine()
        {
-               free(nick);
-
        }
-       virtual bool Matches(User *u);
+       bool Matches(User* u) CXX11_OVERRIDE;
 
-       virtual bool Matches(const std::string &str);
+       bool Matches(const std::string& str) CXX11_OVERRIDE;
 
-       virtual void Apply(User* u);
+       void Apply(User* u) CXX11_OVERRIDE;
 
-       virtual void DisplayExpiry();
+       const std::string& Displayable() CXX11_OVERRIDE;
 
        /** Nickname mask
         */
-       char* nick;
+       std::string nick;
 };
 
-/* Required forward declarations
+/** XLineFactory is used to generate an XLine pointer, given just the
+ * pattern, timing information and type of line to create. This is used
+ * for example in the spanningtree module which will call an XLineFactory
+ * to create a new XLine when it is inbound on a server link, so that it
+ * does not have to know the specifics of the internals of an XLine class
+ * and/or how to call its constructor.
  */
-class ServerConfig;
-class InspIRCd;
+class CoreExport XLineFactory
+{
+ protected:
 
-/** Initialize x line
- */
-bool InitXLine(ServerConfig* conf, const char* tag);
+       std::string type;
 
-/** Done adding zlines from the config
- */
-bool DoneZLine(ServerConfig* conf, const char* tag);
-/** Done adding qlines from the config
- */
-bool DoneQLine(ServerConfig* conf, const char* tag);
-/** Done adding klines from the config
- */
-bool DoneKLine(ServerConfig* conf, const char* tag);
-/** Done adding elines from the config
- */
-bool DoneELine(ServerConfig* conf, const char* tag);
+ public:
 
-/** Add a config-defined zline
- */
-bool DoZLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
-/** Add a config-defined qline
- */
-bool DoQLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
-/** Add a config-defined kline
- */
-bool DoKLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
-/** Add a config-defined eline
- */
-bool DoELine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
+       /** Create an XLine factory
+        * @param t Type of XLine this factory generates
+        */
+       XLineFactory(const std::string &t) : type(t) { }
 
-/** Contains an ident and host split into two strings
- */
-typedef std::pair<std::string, std::string> IdentHostPair;
+       /** Return the type of XLine this factory generates
+        * @return The type of XLine this factory generates
+        */
+       virtual const std::string& GetType() { return type; }
+
+       /** Generate a specialized XLine*.
+        * @param set_time Time this line was created
+        * @param duration Duration of the line
+        * @param source The sender of the line, nickname or server
+        * @param reason The reason for the line
+        * @param xline_specific_mask The mask string for the line, specific to the XLine type being created.
+        * @return A specialized XLine class of the given type for this factory.
+        */
+       virtual XLine* Generate(time_t set_time, unsigned long duration, const std::string& source, const std::string& reason, const std::string& xline_specific_mask) = 0;
+
+       virtual bool AutoApplyToUserList(XLine* x) { return true; }
+
+       /** Destructor
+        */
+       virtual ~XLineFactory() { }
+};
 
-/** XLineManager is a class used to manage glines, klines, elines, zlines and qlines.
+/** XLineManager is a class used to manage G-lines, K-lines, E-lines, Z-lines and Q-lines,
+ * or any other line created by a module. It also manages XLineFactory classes which
+ * can generate a specialized XLine for use by another module.
  */
 class CoreExport XLineManager
 {
  protected:
-       /** The owner/creator of this class
+       /** Used to hold XLines which have not yet been applied.
         */
-       InspIRCd* ServerInstance;
+       std::vector<XLine *> pending_lines;
 
-       /** This functor is used by the std::sort() function to keep all lines in order
+       /** Current xline factories
         */
-       static bool XSortComparison (const XLine *one, const XLine *two);
+       XLineFactMap line_factory;
 
-       /** Used to hold XLines which have not yet been applied.
+       /** Container of all lines, this is a map of maps which
+        * allows for fast lookup for add/remove of a line, and
+        * the shortest possible timed O(n) for checking a user
+        * against a line.
         */
-       std::vector<XLine *> pending_lines;
-
-       std::vector<XLine *> active_lines;
+       XLineContainer lookup_lines;
 
  public:
 
-       std::map<char, std::map<std::string, XLine *> > lookup_lines;
-
        /** Constructor
-        * @param Instance A pointer to the creator object
         */
-       XLineManager(InspIRCd* Instance);
+       XLineManager();
 
-       /** Split an ident and host into two seperate strings.
+       /** Destructor
+        */
+       ~XLineManager();
+
+       /** Split an ident and host into two separate strings.
         * This allows for faster matching.
         */
        IdentHostPair IdentSplit(const std::string &ident_and_host);
 
-       /** Add a new GLine
-        * @param duration The duration of the line
-        * @param source The source of the line
-        * @param reason The reason for the line
-        * @param hostmask The hostmask
-        * @return True if the line was added successfully
+       /** Checks what users match E-lines and sets their ban exempt flag accordingly.
         */
-       bool AddGLine(long duration, const char* source, const char* reason, const char* hostmask);
+       void CheckELines();
 
-       /** Add a new QLine
-        * @param duration The duration of the line
-        * @param source The source of the line
-        * @param reason The reason for the line
-        * @param nickname The nickmask
-        * @return True if the line was added successfully
+       /** Get all lines of a certain type to an XLineLookup (std::map<std::string, XLine*>).
+        * NOTE: When this function runs any expired items are removed from the list before it
+        * is returned to the caller.
+        * @param type The type to look up
+        * @return A list of all XLines of the given type.
         */
-       bool AddQLine(long duration, const char* source, const char* reason, const char* nickname);
+       XLineLookup* GetAll(const std::string &type);
 
-       /** Add a new ZLine
-        * @param duration The duration of the line
-        * @param source The source of the line
-        * @param reason The reason for the line
-        * @param ipaddr The IP mask
-        * @return True if the line was added successfully
+       /** Remove all lines of a certain type.
         */
-       bool AddZLine(long duration, const char* source, const char* reason, const char* ipaddr);
+       void DelAll(const std::string &type);
 
-       /** Add a new KLine
-        * @param duration The duration of the line
-        * @param source The source of the line
-        * @param reason The reason for the line
-        * @param hostmask The hostmask
-        * @return True if the line was added successfully
+       /** Return all known types of line currently stored by the XLineManager.
+        * @return A vector containing all known line types currently stored in the main list.
         */
-       bool AddKLine(long duration, const char* source, const char* reason, const char* hostmask);
+       std::vector<std::string> GetAllTypes();
 
-       /** Add a new ELine
-        * @param duration The duration of the line
-        * @param source The source of the line
-        * @param reason The reason for the line
-        * @param hostmask The hostmask
+       /** Add a new XLine
+        * @param line The line to be added
+        * @param user The user adding the line or NULL for the local server
         * @return True if the line was added successfully
         */
-       bool AddELine(long duration, const char* source, const char* reason, const char* hostmask);
+       bool AddLine(XLine* line, User* user);
 
-       /** Delete a GLine
-        * @param hostmask The host to remove
-        * @param type Type of line to remove
+       /** Delete an XLine
+        * @param hostmask The xline-specific string identifying the line, e.g. "*@foo"
+        * @param type The type of xline
+        * @param reason The xline reason, if it is being removed successfully
+        * @param user The user removing the line or NULL if its the local server
         * @param simulate If this is true, don't actually remove the line, just return
         * @return True if the line was deleted successfully
         */
-       bool DelLine(const char* hostmask, char type, bool simulate = false);
+       bool DelLine(const char* hostmask, const std::string& type, std::string& reason, User* user, bool simulate = false);
 
-       /** Check if a nickname matches a QLine
-        * @return nick The nick to check against
-        * @return The reason for the line if there is a match, or NULL if there is no match
+       /** Registers an xline factory.
+        * An xline factory is a class which when given a particular xline type,
+        * will generate a new XLine specialized to that type. For example if you
+        * pass the XLineFactory that handles G-lines some data it will return a
+        * pointer to a GLine, polymorphically represented as XLine. This is used where
+        * you do not know the full details of the item you wish to create, e.g. in a
+        * server protocol module like m_spanningtree, when you receive xlines from other
+        * servers.
+        * @param xlf XLineFactory pointer to register
         */
-       QLine* matches_qline(const char* nick);
+       bool RegisterFactory(XLineFactory* xlf);
 
-       /** Check if a hostname matches a GLine
-        * @param user The user to check against
-        * @return The reason for the line if there is a match, or NULL if there is no match
+       /** Unregisters an xline factory.
+        * You must do this when your module unloads.
+        * @param xlf XLineFactory pointer to unregister
         */
-       GLine* matches_gline(User* user);
+       bool UnregisterFactory(XLineFactory* xlf);
 
-       /** Check if a user's IP matches a ZLine
-        * @param user The user to check against
-        * @return The reason for the line if there is a match, or NULL if there is no match
+       /** Get the XLineFactory for a specific type.
+        * Returns NULL if there is no known handler for this xline type.
+        * @param type The type of XLine you require the XLineFactory for
         */
-       ZLine* matches_zline(User *user);
+       XLineFactory* GetFactory(const std::string &type);
 
-       /** Check if a hostname matches a KLine
-        * @param user The user to check against
+       /** Check if a user matches an XLine
+        * @param type The type of line to look up
+        * @param user The user to match against (what is checked is specific to the xline type)
         * @return The reason for the line if there is a match, or NULL if there is no match
         */
-       KLine* matches_kline(User* user);
+       XLine* MatchesLine(const std::string &type, User* user);
 
-       /** Check if a hostname matches a ELine
-        * @param user The user to check against
-        * @return The reason for the line if there is a match, or NULL if there is no match
+       /** Check if a pattern matches an XLine
+        * @param type The type of line to look up
+        * @param pattern A pattern string specific to the xline type
+        * @return The matching XLine if there is a match, or NULL if there is no match
         */
-       ELine* matches_exception(User* user);
+       XLine* MatchesLine(const std::string &type, const std::string &pattern);
 
-       /** Expire any lines that should be expired.
+       /** Expire a line given two iterators which identify it in the main map.
+        * @param container Iterator to the first level of entries the map
+        * @param item Iterator to the second level of entries in the map
+        * @param silent If true, doesn't send an expiry SNOTICE.
         */
-       void expire_lines();
+       void ExpireLine(ContainerIter container, LookupIter item, bool silent = false);
 
-       /** Apply any new lines that are pending to be applied
+       /** Apply any new lines that are pending to be applied.
+        * This will only apply lines in the pending_lines list, to save on
+        * CPU time.
         */
        void ApplyLines();
 
-       /** Handle /STATS K
-        * @param user The username making the query
-        * @param results The string_list to receive the results
-        */
-       void stats_k(User* user, string_list &results);
-
-       /** Handle /STATS G
-        * @param user The username making the query
-        * @param results The string_list to receive the results
-        */
-       void stats_g(User* user, string_list &results);
+       /** DEPRECATED: use the `bool InvokeStats(const std::string&, Stats::Context&)` overload instead. */
+       DEPRECATED_METHOD(void InvokeStats(const std::string& type, unsigned int numeric, Stats::Context& stats));
 
-       /** Handle /STATS Q
-        * @param user The username making the query
-        * @param results The string_list to receive the results
+       /** Generates a /STATS response for the given X-line type.
+        * @param type The type of X-line to look up.
+        * @param context The stats context to respond with.
+        * @return True if a response was sent; otherwise, false.
         */
-       void stats_q(User* user, string_list &results);
+       bool InvokeStats(const std::string& type, Stats::Context& context);
 
-       /** Handle /STATS Z
-        * @param user The username making the query
-        * @param results The string_list to receive the results
-        */
-       void stats_z(User* user, string_list &results);
-
-       /** Handle /STATS E
-        * @param user The username making the query
-        * @param results The string_list to receive the results
-        */
-       void stats_e(User* user, string_list &results);
-
-       /** Change creation time of a GLine
-        * @param host The hostname to change
-        * @param create_Time The new creation time
-        */
-       void gline_set_creation_time(const char* host, time_t create_time);
-
-       /** Change creation time of a QLine
-        * @param nick The nickmask to change
-        * @param create_Time The new creation time
-        */
-       void qline_set_creation_time(const char* nick, time_t create_time);
-
-       /** Change creation time of a ZLine
-        * @param ip The ipmask to change
-        * @param create_Time The new creation time
-        */
-       void zline_set_creation_time(const char* ip, time_t create_time);
-
-       /** Change creation time of a ELine
-        * @param host The hostname to change
-        * @param create_Time The new creation time
-        */
-       void eline_set_creation_time(const char* host, time_t create_time);
+       /** Expire X-lines which were added by the server configuration and have been removed. */
+       void ExpireRemovedConfigLines(const std::string& type, const insp::flat_set<std::string>& configlines);
 };
-
-#endif
-