-/* +------------------------------------+
- * | 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) 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 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"
-
-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;
+#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:
- 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:
* @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(InspIRCd* Instance, time_t s_time, long d, const char* src, const char* re, const char t)
- : ServerInstance(Instance), set_time(s_time), duration(d), type(t)
+ XLine(time_t s_time, long d, std::string src, std::string re, const std::string &t)
+ : set_time(s_time), duration(d), source(src), reason(re), type(t)
{
- 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
+ */
virtual void SetCreateTime(time_t created)
{
set_time = created;
}
/** 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 wether or not the given string exactly matches the gline
- * (no wildcard use in this method) -- used for removal of a line
+ /** 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 MatchesLiteral(const std::string &str) = 0;
-
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() { }
- virtual void DisplayExpiry() = 0;
+ /** Called when the expiry message is to be displayed for the
+ * line. Usually a line in the form 'expiring Xline blah, set by...'
+ * see the DisplayExpiry methods of GLine, ELine etc.
+ */
+ virtual void DisplayExpiry();
- virtual const char* Displayable() = 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 seperately 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
*/
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.
*/
- const char type;
+ const std::string type;
+
+ 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 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, long d, std::string src, std::string re, std::string ident, 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 bool MatchesLiteral(const std::string &str);
+ void Apply(User* u) CXX11_OVERRIDE;
- virtual void Apply(User* u);
+ const std::string& Displayable() CXX11_OVERRIDE;
- virtual void DisplayExpiry();
-
- virtual const char* Displayable();
+ bool IsBurstable() 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;
};
* @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, long d, std::string src, std::string re, std::string ident, 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 bool MatchesLiteral(const std::string &str);
+ void Apply(User* u) CXX11_OVERRIDE;
- virtual void Apply(User* u);
+ const std::string& Displayable() CXX11_OVERRIDE;
- virtual void DisplayExpiry();
-
- virtual const char* Displayable();
-
- /** 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;
};
* @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, long d, std::string src, std::string re, std::string ident, 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 bool MatchesLiteral(const std::string &str);
-
- virtual void Unset();
-
- virtual void DisplayExpiry();
+ void Unset() CXX11_OVERRIDE;
- virtual void OnAdd();
+ void OnAdd() CXX11_OVERRIDE;
- virtual const char* Displayable();
+ 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;
};
* @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, long d, std::string src, std::string re, std::string ip)
+ : XLine(s_time, d, src, re, "Z"), ipaddr(ip)
{
- ipaddr = strdup(ip);
}
/** 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 bool MatchesLiteral(const std::string &str);
+ void Apply(User* u) CXX11_OVERRIDE;
- virtual void Apply(User* u);
-
- virtual void DisplayExpiry();
-
- virtual const char* Displayable();
+ const std::string& Displayable() CXX11_OVERRIDE;
- /** IP mask
+ /** IP mask (no ident part)
*/
- char* ipaddr;
+ std::string ipaddr;
};
/** QLine class
* @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, long d, std::string src, std::string re, 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);
+ bool Matches(const std::string& str) CXX11_OVERRIDE;
- virtual bool MatchesLiteral(const std::string &str);
+ void Apply(User* u) CXX11_OVERRIDE;
- virtual void Apply(User* u);
-
- virtual void DisplayExpiry();
-
- 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
+/** 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.
*/
-typedef std::pair<std::string, std::string> IdentHostPair;
-
-
class CoreExport XLineFactory
{
protected:
- InspIRCd* ServerInstance;
- const char type;
+ std::string type;
public:
- XLineFactory(InspIRCd* Instance, const char t) : ServerInstance(Instance), type(t) { }
-
- virtual const char GetType() { return type; }
+ /** 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, long duration, std::string source, std::string reason, std::string xline_specific_mask) = 0;
- virtual XLine* Generate(time_t set_time, long duration, const char* source, const char* reason, const char* 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;
-
-/** XLineManager is a class used to manage glines, klines, elines, zlines and qlines.
+/** XLineManager is a class used to manage glines, klines, elines, zlines and qlines,
+ * 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;
-
- /** This functor is used by the std::sort() function to keep all lines in order
- */
- static bool XSortComparison (const XLine *one, const XLine *two);
-
/** Used to hold XLines which have not yet been applied.
*/
std::vector<XLine *> pending_lines;
- std::vector<XLine *> active_lines;
-
- std::map<char, XLineFactory*> line_factory;
-
- GLineFactory* GFact;
- ELineFactory* EFact;
- KLineFactory* KFact;
- QLineFactory* QFact;
- ZLineFactory* ZFact;
+ /** Current xline factories
+ */
+ XLineFactMap line_factory;
- unsigned int PermLines;
+ /** 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:
- std::map<char, std::map<std::string, XLine *> > lookup_lines;
-
/** Constructor
- * @param Instance A pointer to the creator object
*/
- XLineManager(InspIRCd* Instance);
+ XLineManager();
+ /** Destructor
+ */
~XLineManager();
/** Split an ident and host into two seperate strings.
*/
IdentHostPair IdentSplit(const std::string &ident_and_host);
- /** Checks what users match a given list of ELines and sets their ban exempt flag accordingly.
- * @param ELines List of E:Lines to check.
+ /** Checks what users match e:lines and sets their ban exempt flag accordingly.
*/
- void CheckELines(std::map<std::string, XLine *> &ELines);
+ void CheckELines();
- /** Add a new GLine
+ /** 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 a GLine
+ /** 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, char type, User* user, bool simulate = false);
+ 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 glines 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
*/
bool RegisterFactory(XLineFactory* xlf);
- /** Unregisters an xline factory
+ /** 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
- */
- XLineFactory* GetFactory(const char type);
-
- /** 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
+ * Returns NULL if there is no known handler for this xline type.
+ * @param type The type of XLine you require the XLineFactory for
*/
- QLine* matches_qline(const char* nick);
+ XLineFactory* GetFactory(const std::string &type);
- /** Check if a hostname matches a GLine
- * @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
*/
- GLine* matches_gline(User* user);
+ XLine* MatchesLine(const std::string &type, User* user);
- /** 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
+ /** 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
*/
- ZLine* matches_zline(User *user);
+ XLine* MatchesLine(const std::string &type, const std::string &pattern);
- /** Check if a hostname matches a KLine
- * @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
- */
- KLine* matches_kline(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
+ /** 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
*/
- ELine* matches_exception(User* user);
+ void ExpireLine(ContainerIter container, LookupIter item);
- /** Expire any lines that should be expired.
- */
- void expire_lines();
-
- /** 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 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 user The username making the query
- * @param results The string_list to receive the results
+ * @param stats Stats context
*/
- void InvokeStats(const char type, int numeric, User* user, string_list &results);
-};
-
-class CoreExport GLineFactory : public XLineFactory
-{
- public:
- GLineFactory(InspIRCd* Instance) : XLineFactory(Instance, 'G') { }
-
- 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());
- }
-};
-
-class CoreExport ELineFactory : public XLineFactory
-{
- public:
- ELineFactory(InspIRCd* Instance) : XLineFactory(Instance, 'E') { }
-
- 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());
- }
-};
-
-class CoreExport KLineFactory : public XLineFactory
-{
- public:
- KLineFactory(InspIRCd* Instance) : XLineFactory(Instance, 'K') { }
-
- 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());
- }
-};
-
-class CoreExport QLineFactory : public XLineFactory
-{
- public:
- QLineFactory(InspIRCd* Instance) : XLineFactory(Instance, 'Q') { }
-
- 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);
- }
+ void InvokeStats(const std::string& type, unsigned int numeric, Stats::Context& stats);
};
-
-class CoreExport ZLineFactory : public XLineFactory
-{
- public:
- ZLineFactory(InspIRCd* Instance) : XLineFactory(Instance, 'Z') { }
-
- 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);
- }
-};
-
-#endif