-/* +------------------------------------+\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 __XLINE_H\r#define __XLINE_H\r\r// include the common header files\r\r#include <string>\r#include <deque>\r#include <vector>\r#include "users.h"\r#include "channels.h"\r\rconst int APPLY_GLINES = 1;\rconst int APPLY_KLINES = 2;\rconst int APPLY_QLINES = 4;\rconst int APPLY_ZLINES = 8;\rconst int APPLY_PERM_ONLY = 16;\rconst int APPLY_ALL = APPLY_GLINES | APPLY_KLINES | APPLY_QLINES | APPLY_ZLINES;\r\r/** XLine is the base class for ban lines such as G lines and K lines.\r */\rclass CoreExport XLine : public classbase\r{\r public:\r\r /** Create an XLine.\r * @param s_time The set time\r * @param d The duration of the xline\r * @param src The sender of the xline\r * @param re The reason of the xline\r */\r XLine(time_t s_time, long d, const char* src, const char* re)\r : set_time(s_time), duration(d)\r {\r source = strdup(src);\r reason = strdup(re);\r expiry = set_time + duration;\r }\r\r /** Destructor\r */\r virtual ~XLine()\r {\r free(reason);\r free(source);\r }\r /** The time the line was added.\r */\r time_t set_time;\r \r /** The duration of the ban, or 0 if permenant\r */\r long duration;\r \r /** Source of the ban. This can be a servername or an oper nickname\r */\r char* source;\r \r /** Reason for the ban\r */\r char* reason;\r\r /** Expiry time\r */\r time_t expiry;\r};\r\r/** KLine class\r */\rclass CoreExport KLine : public XLine\r{\r public:\r /** Create a K-Line.\r * @param s_time The set time\r * @param d The duration of the xline\r * @param src The sender of the xline\r * @param re The reason of the xline\r * @param ident Ident to match\r * @param host Host to match\r */\r KLine(time_t s_time, long d, const char* src, const char* re, const char* ident, const char* host) : XLine(s_time, d, src, re)\r {\r identmask = strdup(ident);\r hostmask = strdup(host);\r }\r\r /** Destructor\r */\r ~KLine()\r {\r free(identmask);\r free(hostmask);\r }\r\r /** Ident mask\r */\r char* identmask;\r /** Host mask\r */\r char* hostmask;\r};\r\r/** GLine class\r */\rclass CoreExport GLine : public XLine\r{\r public:\r /** Create a G-Line.\r * @param s_time The set time\r * @param d The duration of the xline\r * @param src The sender of the xline\r * @param re The reason of the xline\r * @param ident Ident to match\r * @param host Host to match\r */\r GLine(time_t s_time, long d, const char* src, const char* re, const char* ident, const char* host) : XLine(s_time, d, src, re)\r {\r identmask = strdup(ident);\r hostmask = strdup(host);\r }\r\r /** Destructor\r */\r ~GLine()\r {\r free(identmask);\r free(hostmask);\r }\r\r /** Ident mask\r */\r char* identmask;\r /** Host mask\r */\r char* hostmask;\r};\r\r/** ELine class\r */\rclass CoreExport ELine : public XLine\r{\r public:\r /** Create an E-Line.\r * @param s_time The set time\r * @param d The duration of the xline\r * @param src The sender of the xline\r * @param re The reason of the xline\r * @param ident Ident to match\r * @param host Host to match\r */\r ELine(time_t s_time, long d, const char* src, const char* re, const char* ident, const char* host) : XLine(s_time, d, src, re)\r {\r identmask = strdup(ident);\r hostmask = strdup(host);\r }\r\r ~ELine()\r {\r free(identmask);\r free(hostmask);\r }\r\r /** Ident mask\r */\r char* identmask;\r /** Host mask\r */\r char* hostmask;\r};\r\r/** ZLine class\r */\rclass CoreExport ZLine : public XLine\r{\r public:\r /** Create a Z-Line.\r * @param s_time The set time\r * @param d The duration of the xline\r * @param src The sender of the xline\r * @param re The reason of the xline\r * @param ip IP to match\r */\r ZLine(time_t s_time, long d, const char* src, const char* re, const char* ip) : XLine(s_time, d, src, re)\r {\r ipaddr = strdup(ip);\r }\r\r /** Destructor\r */\r ~ZLine()\r {\r free(ipaddr);\r }\r\r /** IP mask\r */\r char* ipaddr;\r};\r\r/** QLine class\r */\rclass CoreExport QLine : public XLine\r{\r public:\r /** Create a G-Line.\r * @param s_time The set time\r * @param d The duration of the xline\r * @param src The sender of the xline\r * @param re The reason of the xline\r * @param nickname Nickname to match\r */\r QLine(time_t s_time, long d, const char* src, const char* re, const char* nickname) : XLine(s_time, d, src, re)\r {\r nick = strdup(nickname);\r }\r\r /** Destructor\r */\r ~QLine()\r {\r free(nick);\r }\r\r /** Nickname mask\r */\r char* nick;\r};\r\r/* Required forward declarations\r */\rclass ServerConfig;\rclass InspIRCd;\r\r/** Initialize x line\r */\rbool InitXLine(ServerConfig* conf, const char* tag);\r\r/** Done adding zlines from the config\r */\rbool DoneZLine(ServerConfig* conf, const char* tag);\r/** Done adding qlines from the config\r */\rbool DoneQLine(ServerConfig* conf, const char* tag);\r/** Done adding klines from the config\r */\rbool DoneKLine(ServerConfig* conf, const char* tag);\r/** Done adding elines from the config\r */\rbool DoneELine(ServerConfig* conf, const char* tag);\r\r/** Add a config-defined zline\r */\rbool DoZLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);\r/** Add a config-defined qline\r */\rbool DoQLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);\r/** Add a config-defined kline\r */\rbool DoKLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);\r/** Add a config-defined eline\r */\rbool DoELine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);\r\r/** Contains an ident and host split into two strings\r */\rtypedef std::pair<std::string, std::string> IdentHostPair;\r\r/** XLineManager is a class used to manage glines, klines, elines, zlines and qlines.\r */\rclass CoreExport XLineManager\r{\r protected:\r /** The owner/creator of this class\r */\r InspIRCd* ServerInstance;\r\r /** This functor is used by the std::sort() function to keep glines in order\r */\r static bool GSortComparison ( const GLine* one, const GLine* two );\r\r /** This functor is used by the std::sort() function to keep elines in order\r */\r static bool ESortComparison ( const ELine* one, const ELine* two );\r\r /** This functor is used by the std::sort() function to keep zlines in order\r */\r static bool ZSortComparison ( const ZLine* one, const ZLine* two );\r\r /** This functor is used by the std::sort() function to keep klines in order\r */\r static bool KSortComparison ( const KLine* one, const KLine* two );\r\r /** This functor is used by the std::sort() function to keep qlines in order\r */\r static bool QSortComparison ( const QLine* one, const QLine* two );\r public:\r /* Lists for temporary lines with an expiry time */\r\r /** Temporary KLines */\r std::vector<KLine*> klines;\r\r /** Temporary Glines */\r std::vector<GLine*> glines;\r\r /** Temporary Zlines */\r std::vector<ZLine*> zlines;\r\r /** Temporary QLines */\r std::vector<QLine*> qlines;\r\r /** Temporary ELines */\r std::vector<ELine*> elines;\r\r /* Seperate lists for perm XLines that isnt checked by expiry functions */\r\r /** Permenant KLines */\r std::vector<KLine*> pklines;\r\r /** Permenant GLines */\r std::vector<GLine*> pglines;\r\r /** Permenant ZLines */\r std::vector<ZLine*> pzlines;\r\r /** Permenant QLines */\r std::vector<QLine*> pqlines;\r\r /** Permenant ELines */\r std::vector<ELine*> pelines;\r \r /** Constructor\r * @param Instance A pointer to the creator object\r */\r XLineManager(InspIRCd* Instance);\r\r /** Split an ident and host into two seperate strings.\r * This allows for faster matching.\r */\r IdentHostPair IdentSplit(const std::string &ident_and_host);\r\r /** Add a new GLine\r * @param duration The duration of the line\r * @param source The source of the line\r * @param reason The reason for the line\r * @param hostmask The hostmask\r * @return True if the line was added successfully\r */\r bool add_gline(long duration, const char* source, const char* reason, const char* hostmask);\r\r /** Add a new QLine\r * @param duration The duration of the line\r * @param source The source of the line\r * @param reason The reason for the line\r * @param nickname The nickmask\r * @return True if the line was added successfully\r */\r bool add_qline(long duration, const char* source, const char* reason, const char* nickname);\r\r /** Add a new ZLine\r * @param duration The duration of the line\r * @param source The source of the line\r * @param reason The reason for the line\r * @param ipaddr The IP mask\r * @return True if the line was added successfully\r */\r bool add_zline(long duration, const char* source, const char* reason, const char* ipaddr);\r\r /** Add a new KLine\r * @param duration The duration of the line\r * @param source The source of the line\r * @param reason The reason for the line\r * @param hostmask The hostmask\r * @return True if the line was added successfully\r */\r bool add_kline(long duration, const char* source, const char* reason, const char* hostmask);\r\r /** Add a new ELine\r * @param duration The duration of the line\r * @param source The source of the line\r * @param reason The reason for the line\r * @param hostmask The hostmask\r * @return True if the line was added successfully\r */\r bool add_eline(long duration, const char* source, const char* reason, const char* hostmask);\r\r /** Delete a GLine\r * @param hostmask The host to remove\r * @param simulate If this is true, don't actually remove the line, just return\r * @return True if the line was deleted successfully\r */\r bool del_gline(const char* hostmask, bool simulate = false);\r\r /** Delete a QLine\r * @param nickname The nick to remove\r * @param simulate If this is true, don't actually remove the line, just return\r * @return True if the line was deleted successfully\r */\r bool del_qline(const char* nickname, bool simulate = false);\r\r /** Delete a ZLine\r * @param ipaddr The IP to remove\r * @param simulate If this is true, don't actually remove the line, just return\r * @return True if the line was deleted successfully\r */\r bool del_zline(const char* ipaddr, bool simulate = false);\r\r /** Delete a KLine\r * @param hostmask The host to remove\r * @param simulate If this is true, don't actually remove the line, just return\r * @return True if the line was deleted successfully\r */\r bool del_kline(const char* hostmask, bool simulate = false);\r\r /** Delete a ELine\r * @param hostmask The host to remove\r * @param simulate If this is true, don't actually remove the line, just return\r * @return True if the line was deleted successfully\r */\r bool del_eline(const char* hostmask, bool simulate = false);\r\r /** Check if a nickname matches a QLine\r * @return nick The nick to check against\r * @return The reason for the line if there is a match, or NULL if there is no match\r */\r QLine* matches_qline(const char* nick, bool permonly = false);\r\r /** Check if a hostname matches a GLine\r * @param user The user to check against\r * @return The reason for the line if there is a match, or NULL if there is no match\r */\r GLine* matches_gline(userrec* user, bool permonly = false);\r\r /** Check if a IP matches a ZLine\r * @param ipaddr The IP to check against\r * @return The reason for the line if there is a match, or NULL if there is no match\r */\r ZLine* matches_zline(const char* ipaddr, bool permonly = false);\r\r /** Check if a hostname matches a KLine\r * @param user The user to check against\r * @return The reason for the line if there is a match, or NULL if there is no match\r */\r KLine* matches_kline(userrec* user, bool permonly = false);\r\r /** Check if a hostname matches a ELine\r * @param user The user to check against\r * @return The reason for the line if there is a match, or NULL if there is no match\r */\r ELine* matches_exception(userrec* user, bool permonly = false);\r\r /** Expire any pending non-permenant lines\r */\r void expire_lines();\r\r /** Apply any new lines\r * @param What The types of lines to apply, from the set\r * APPLY_GLINES | APPLY_KLINES | APPLY_QLINES | APPLY_ZLINES | APPLY_ALL\r * | APPLY_LOCAL_ONLY\r */\r void apply_lines(const int What);\r\r /** Handle /STATS K\r * @param user The username making the query\r * @param results The string_list to receive the results\r */\r void stats_k(userrec* user, string_list &results);\r\r /** Handle /STATS G\r * @param user The username making the query\r * @param results The string_list to receive the results\r */\r void stats_g(userrec* user, string_list &results);\r\r /** Handle /STATS Q\r * @param user The username making the query\r * @param results The string_list to receive the results\r */\r void stats_q(userrec* user, string_list &results);\r\r /** Handle /STATS Z\r * @param user The username making the query\r * @param results The string_list to receive the results\r */\r void stats_z(userrec* user, string_list &results);\r\r /** Handle /STATS E\r * @param user The username making the query\r * @param results The string_list to receive the results\r */\r void stats_e(userrec* user, string_list &results);\r\r /** Change creation time of a GLine\r * @param host The hostname to change\r * @param create_Time The new creation time\r */\r void gline_set_creation_time(const char* host, time_t create_time);\r\r /** Change creation time of a QLine\r * @param nick The nickmask to change\r * @param create_Time The new creation time\r */\r void qline_set_creation_time(const char* nick, time_t create_time);\r\r /** Change creation time of a ZLine\r * @param ip The ipmask to change\r * @param create_Time The new creation time\r */\r void zline_set_creation_time(const char* ip, time_t create_time);\r\r /** Change creation time of a ELine\r * @param host The hostname to change\r * @param create_Time The new creation time\r */\r void eline_set_creation_time(const char* host, time_t create_time);\r};\r\r#endif\r\r
\ No newline at end of file
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
+ *
+ * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
+ * Copyright (C) 2004-2007 Craig Edwards <craigedwards@brainbox.cc>
+ * Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
+ * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *
+ * 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/>.
+ */
+
+
+#pragma once
+
+/** 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
+ * propogate 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:
+
+ /** 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:
+
+ /** Create an XLine.
+ * @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 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)
+ {
+ expiry = set_time + duration;
+ }
+
+ /** Destructor
+ */
+ virtual ~XLine()
+ {
+ }
+
+ /** 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;
+
+ /** 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);
+
+ /** 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();
+
+ /** 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
+ */
+ unsigned long duration;
+
+ /** Source of the ban. This can be a servername or an oper nickname
+ */
+ std::string source;
+
+ /** Reason for the ban
+ */
+ std::string reason;
+
+ /** Expiry time. Does not contain useful data if the duration is 0.
+ */
+ time_t expiry;
+
+ /** "Q", "K", etc. Set only by derived classes constructor to the
+ * type of line this is.
+ */
+ const std::string type;
+
+ // Whether this XLine was loaded from the server config.
+ bool from_config;
+
+ virtual bool IsBurstable();
+};
+
+/** KLine class
+ */
+class CoreExport KLine : public XLine
+{
+ public:
+
+ /** Create a K-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 ident Ident to match
+ * @param host Host to match
+ */
+ 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)
+ {
+ matchtext = this->identmask;
+ matchtext.append("@").append(this->hostmask);
+ }
+
+ /** Destructor
+ */
+ ~KLine()
+ {
+ }
+
+ bool Matches(User* u) CXX11_OVERRIDE;
+
+ bool Matches(const std::string& str) CXX11_OVERRIDE;
+
+ void Apply(User* u) CXX11_OVERRIDE;
+
+ const std::string& Displayable() CXX11_OVERRIDE;
+
+ bool IsBurstable() CXX11_OVERRIDE;
+
+ /** Ident mask (ident part only)
+ */
+ std::string identmask;
+ /** Host mask (host part only)
+ */
+ std::string hostmask;
+
+ std::string matchtext;
+};
+
+/** GLine class
+ */
+class CoreExport GLine : public XLine
+{
+ public:
+ /** Create a G-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 ident Ident to match
+ * @param host Host to match
+ */
+ 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)
+ {
+ matchtext = this->identmask;
+ matchtext.append("@").append(this->hostmask);
+ }
+
+ /** Destructor
+ */
+ ~GLine()
+ {
+ }
+
+ bool Matches(User* u) CXX11_OVERRIDE;
+
+ bool Matches(const std::string& str) CXX11_OVERRIDE;
+
+ void Apply(User* u) CXX11_OVERRIDE;
+
+ const std::string& Displayable() CXX11_OVERRIDE;
+
+ /** Ident mask (ident part only)
+ */
+ std::string identmask;
+ /** Host mask (host part only)
+ */
+ std::string hostmask;
+
+ std::string matchtext;
+};
+
+/** ELine class
+ */
+class CoreExport ELine : public XLine
+{
+ public:
+ /** Create an E-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 ident Ident to match
+ * @param host Host to match
+ */
+ 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)
+ {
+ matchtext = this->identmask;
+ matchtext.append("@").append(this->hostmask);
+ }
+
+ ~ELine()
+ {
+ }
+
+ bool Matches(User* u) CXX11_OVERRIDE;
+
+ bool Matches(const std::string& str) CXX11_OVERRIDE;
+
+ void Unset() CXX11_OVERRIDE;
+
+ void OnAdd() CXX11_OVERRIDE;
+
+ const std::string& Displayable() CXX11_OVERRIDE;
+
+ /** Ident mask (ident part only)
+ */
+ std::string identmask;
+ /** Host mask (host part only)
+ */
+ std::string hostmask;
+
+ std::string matchtext;
+};
+
+/** ZLine class
+ */
+class CoreExport ZLine : public XLine
+{
+ public:
+ /** 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(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)
+ {
+ }
+
+ /** Destructor
+ */
+ ~ZLine()
+ {
+ }
+
+ bool Matches(User* u) CXX11_OVERRIDE;
+
+ bool Matches(const std::string& str) CXX11_OVERRIDE;
+
+ void Apply(User* u) CXX11_OVERRIDE;
+
+ const std::string& Displayable() CXX11_OVERRIDE;
+
+ /** IP mask (no ident part)
+ */
+ std::string ipaddr;
+};
+
+/** QLine class
+ */
+class CoreExport QLine : public XLine
+{
+ public:
+ /** 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(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)
+ {
+ }
+
+ /** Destructor
+ */
+ ~QLine()
+ {
+ }
+ bool Matches(User* u) CXX11_OVERRIDE;
+
+ bool Matches(const std::string& str) CXX11_OVERRIDE;
+
+ void Apply(User* u) CXX11_OVERRIDE;
+
+ const std::string& Displayable() CXX11_OVERRIDE;
+
+ /** Nickname mask
+ */
+ std::string nick;
+};
+
+/** 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 CoreExport XLineFactory
+{
+ protected:
+
+ std::string type;
+
+ public:
+
+ /** Create an XLine factory
+ * @param t Type of XLine this factory generates
+ */
+ XLineFactory(const std::string &t) : type(t) { }
+
+ /** 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 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:
+ /** Used to hold XLines which have not yet been applied.
+ */
+ std::vector<XLine *> pending_lines;
+
+ /** Current xline factories
+ */
+ XLineFactMap line_factory;
+
+ /** 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.
+ */
+ XLineContainer lookup_lines;
+
+ public:
+
+ /** Constructor
+ */
+ XLineManager();
+
+ /** Destructor
+ */
+ ~XLineManager();
+
+ /** Split an ident and host into two seperate strings.
+ * This allows for faster matching.
+ */
+ IdentHostPair IdentSplit(const std::string &ident_and_host);
+
+ /** Checks what users match E-lines and sets their ban exempt flag accordingly.
+ */
+ void CheckELines();
+
+ /** 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.
+ */
+ XLineLookup* GetAll(const std::string &type);
+
+ /** Remove all lines of a certain type.
+ */
+ void DelAll(const std::string &type);
+
+ /** 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.
+ */
+ std::vector<std::string> GetAllTypes();
+
+ /** 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 AddLine(XLine* line, User* user);
+
+ /** Delete an XLine
+ * @param hostmask The xline-specific string identifying the line, e.g. "*@foo"
+ * @param type The type of xline
+ * @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, const std::string &type, User* user, bool simulate = false);
+
+ /** 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
+ */
+ bool RegisterFactory(XLineFactory* xlf);
+
+ /** Unregisters an xline factory.
+ * You must do this when your module unloads.
+ * @param xlf XLineFactory pointer to unregister
+ */
+ bool UnregisterFactory(XLineFactory* xlf);
+
+ /** 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
+ */
+ XLineFactory* GetFactory(const std::string &type);
+
+ /** 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
+ */
+ XLine* MatchesLine(const std::string &type, User* user);
+
+ /** 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
+ */
+ XLine* MatchesLine(const std::string &type, const std::string &pattern);
+
+ /** 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
+ */
+ void ExpireLine(ContainerIter container, LookupIter item);
+
+ /** 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 for a given type.
+ * NOTE: Any items in the list for this particular line type which have expired
+ * will be expired and removed before the list is displayed.
+ * @param type The type of stats to show
+ * @param numeric The numeric to give to each result line
+ * @param stats Stats context
+ */
+ void InvokeStats(const std::string& type, unsigned int numeric, Stats::Context& stats);
+
+ /** Clears any XLines which were added by the server configuration. */
+ void ClearConfigLines();
+};
projects / user / henk / code / inspircd.git / blobdiff