-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
*
- * InspIRCd: (C) 2002-2008 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 <string>
-#include <deque>
-#include <vector>
+#pragma once
-/** 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
- * propogate them using AddLine). The process of translating a type+pattern
+ * 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).
*/
{
protected:
- /** Creator */
- InspIRCd* ServerInstance;
-
/** 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 re The reason of the xline
* @param t The line type, should be set by the derived class constructor
*/
- XLine(InspIRCd* Instance, time_t s_time, long d, const char* src, const char* re, const std::string &t)
- : ServerInstance(Instance), set_time(s_time), duration(d), type(t)
+ 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;
}
*/
virtual ~XLine()
{
- free(reason);
- free(source);
}
/** Change creation time of an xline. Updates expiry
- * to be after the creation time
+ * to be after the creation time.
*/
virtual void SetCreateTime(time_t created)
{
virtual void Unset() { }
/** Called when the expiry message is to be displayed for the
- * line. Usually a line in the form 'expiring Xline blah, set by...'
+ * line. Usually a line in the form 'expiring X-line blah, set by...'
* see the DisplayExpiry methods of GLine, ELine etc.
*/
- virtual void DisplayExpiry() = 0;
+ 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
+ * 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 seperately but will still return ident@host
- * for its Displayable() method)
+ * ident and host parts separately but will still return ident\@host
+ * for its Displayable() method).
*/
- virtual const char* Displayable() = 0;
+ virtual const std::string& Displayable() = 0;
/** Called when the xline has just been added.
*/
/** 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. Does not contain useful data if the duration is 0.
*/
* 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
{
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
* @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, "K")
+ 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);
matchtext = this->identmask;
matchtext.append("@").append(this->hostmask);
}
*/
~KLine()
{
- free(identmask);
- free(hostmask);
}
- 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;
- virtual const char* Displayable();
+ bool IsBurstable() CXX11_OVERRIDE;
/** Ident mask (ident part only)
*/
- char* identmask;
+ std::string identmask;
/** Host mask (host part only)
*/
- char* hostmask;
+ std::string hostmask;
std::string matchtext;
};
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
* @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, "G")
+ 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);
matchtext = this->identmask;
matchtext.append("@").append(this->hostmask);
}
*/
~GLine()
{
- free(identmask);
- free(hostmask);
}
- 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();
-
- virtual const char* Displayable();
+ const std::string& Displayable() CXX11_OVERRIDE;
/** Ident mask (ident part only)
*/
- char* identmask;
+ std::string identmask;
/** Host mask (host part only)
*/
- char* hostmask;
+ std::string hostmask;
std::string matchtext;
};
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
* @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, "E")
+ 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);
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 bool Matches(const std::string &str);
+ bool Matches(const std::string& str) CXX11_OVERRIDE;
- virtual void Unset();
+ void Unset() CXX11_OVERRIDE;
- virtual void DisplayExpiry();
+ void OnAdd() CXX11_OVERRIDE;
- virtual void OnAdd();
-
- virtual const char* Displayable();
+ const std::string& Displayable() CXX11_OVERRIDE;
/** Ident mask (ident part only)
*/
- char* identmask;
+ std::string identmask;
/** Host mask (host part only)
*/
- char* hostmask;
+ std::string hostmask;
std::string matchtext;
};
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, "Z")
+ 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);
}
/** Destructor
*/
~ZLine()
{
- free(ipaddr);
}
- virtual bool Matches(User *u);
-
- virtual bool Matches(const std::string &str);
+ 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;
- virtual const char* Displayable();
+ const std::string& Displayable() CXX11_OVERRIDE;
/** IP mask (no ident part)
*/
- char* ipaddr;
+ std::string ipaddr;
};
/** QLine class
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, "Q")
+ 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);
}
/** Destructor
*/
~QLine()
{
- free(nick);
-
}
- virtual bool Matches(User *u);
+ bool Matches(User* u) CXX11_OVERRIDE;
- virtual bool Matches(const std::string &str);
-
- virtual void Apply(User* u);
+ bool Matches(const std::string& str) CXX11_OVERRIDE;
- virtual void DisplayExpiry();
+ void Apply(User* u) CXX11_OVERRIDE;
- virtual const char* Displayable();
+ const std::string& Displayable() CXX11_OVERRIDE;
/** Nickname mask
*/
- char* nick;
+ std::string nick;
};
-/** Contains an ident and host split into two strings
- */
-typedef std::pair<std::string, std::string> IdentHostPair;
-
-/** XLineFactory is used to generate an XLine pointer, given just the
+/** 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
{
protected:
- InspIRCd* ServerInstance;
std::string type;
public:
/** Create an XLine factory
- * @param Instance creator
* @param t Type of XLine this factory generates
*/
- XLineFactory(InspIRCd* Instance, const std::string &t) : ServerInstance(Instance), type(t) { }
-
+ XLineFactory(const std::string &t) : type(t) { }
+
/** Return the type of XLine this factory generates
* @return The type of XLine this factory generates
*/
* @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, long duration, const char* source, const char* reason, const char* xline_specific_mask) = 0;
+ 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() { }
};
-/* Required forward declarations
- */
-class ServerConfig;
-class InspIRCd;
-
-class GLineFactory;
-class ELineFactory;
-class QLineFactory;
-class ZLineFactory;
-class KLineFactory;
-
-/** A map of xline factories
- */
-typedef std::map<std::string, XLineFactory*> XLineFactMap;
-
-/** A map of XLines indexed by string
- */
-typedef std::map<std::string, XLine *> XLineLookup;
-
-/** A map of XLineLookup maps indexed by string
- */
-typedef std::map<std::string, XLineLookup > XLineContainer;
-
-/** An iterator in an XLineContainer
- */
-typedef XLineContainer::iterator ContainerIter;
-
-/** An interator in an XLineLookup
- */
-typedef XLineLookup::iterator LookupIter;
-
-/** 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
- */
- InspIRCd* ServerInstance;
-
/** Used to hold XLines which have not yet been applied.
*/
std::vector<XLine *> pending_lines;
*/
XLineFactMap line_factory;
- /** Core xline factories for G/E/K/Q/Z lines
- * (These generate GLine, ELine, KLine, QLine and ZLine
- * respectively)
- */
- GLineFactory* GFact;
- ELineFactory* EFact;
- KLineFactory* KFact;
- QLineFactory* QFact;
- ZLineFactory* ZFact;
-
/** 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
public:
/** Constructor
- * @param Instance A pointer to the creator object
*/
- XLineManager(InspIRCd* Instance);
+ XLineManager();
/** Destructor
*/
~XLineManager();
- /** Split an ident and host into two seperate strings.
+ /** Split an ident and host into two separate 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.
+ /** 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 The type to look up
+ * @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.
*/
/** 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, const std::string &type, User* user, bool simulate = false);
+ bool DelLine(const char* hostmask, const std::string& type, std::string& reason, 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 glines some data it will return a
+ * 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
+ * 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
/** 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 ExpireLine(ContainerIter container, LookupIter item);
+ void ExpireLine(ContainerIter container, LookupIter item, bool silent = false);
/** Apply any new lines that are pending to be applied.
* This will only apply lines in the pending_lines list, to save on
*/
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 numeric The numeric to give to each result line
- * @param user The username making the query
- * @param results The string_list to receive the results
- */
- void InvokeStats(const std::string &type, int numeric, User* user, string_list &results);
-};
-
-/** An XLineFactory specialized to generate GLine* pointers
- */
-class CoreExport GLineFactory : public XLineFactory
-{
- public:
- GLineFactory(InspIRCd* Instance) : XLineFactory(Instance, "G") { }
-
- /** Generate a GLine
- */
- XLine* Generate(time_t set_time, long duration, const char* source, const char* reason, const char* xline_specific_mask)
- {
- IdentHostPair ih = ServerInstance->XLines->IdentSplit(xline_specific_mask);
- return new GLine(ServerInstance, set_time, duration, source, reason, ih.first.c_str(), ih.second.c_str());
- }
-};
-
-/** An XLineFactory specialized to generate ELine* pointers
- */
-class CoreExport ELineFactory : public XLineFactory
-{
- public:
- ELineFactory(InspIRCd* Instance) : XLineFactory(Instance, "E") { }
-
- /** Generate an ELine
- */
- XLine* Generate(time_t set_time, long duration, const char* source, const char* reason, const char* xline_specific_mask)
- {
- IdentHostPair ih = ServerInstance->XLines->IdentSplit(xline_specific_mask);
- return new ELine(ServerInstance, set_time, duration, source, reason, ih.first.c_str(), ih.second.c_str());
- }
-};
-
-/** An XLineFactory specialized to generate KLine* pointers
- */
-class CoreExport KLineFactory : public XLineFactory
-{
- public:
- KLineFactory(InspIRCd* Instance) : XLineFactory(Instance, "K") { }
+ /** 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));
- /** Generate a KLine
+ /** 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.
*/
- XLine* Generate(time_t set_time, long duration, const char* source, const char* reason, const char* xline_specific_mask)
- {
- IdentHostPair ih = ServerInstance->XLines->IdentSplit(xline_specific_mask);
- return new KLine(ServerInstance, set_time, duration, source, reason, ih.first.c_str(), ih.second.c_str());
- }
-};
-
-/** An XLineFactory specialized to generate QLine* pointers
- */
-class CoreExport QLineFactory : public XLineFactory
-{
- public:
- QLineFactory(InspIRCd* Instance) : XLineFactory(Instance, "Q") { }
+ bool InvokeStats(const std::string& type, Stats::Context& context);
- /** Generate a QLine
- */
- XLine* Generate(time_t set_time, long duration, const char* source, const char* reason, const char* xline_specific_mask)
- {
- return new QLine(ServerInstance, set_time, duration, source, reason, xline_specific_mask);
- }
-};
-
-/** An XLineFactory specialized to generate ZLine* pointers
- */
-class CoreExport ZLineFactory : public XLineFactory
-{
- public:
- ZLineFactory(InspIRCd* Instance) : XLineFactory(Instance, "Z") { }
-
- /** Generate a ZLine
- */
- XLine* Generate(time_t set_time, long duration, const char* source, const char* reason, const char* xline_specific_mask)
- {
- return new ZLine(ServerInstance, set_time, duration, source, reason, xline_specific_mask);
- }
+ /** 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
-
projects / user / henk / code / inspircd.git / blobdiff