X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fxline.h;h=2a49d8b80efe1c49230137a847a4838a049485be;hb=e6601069038c35c546fd3f3dce95024b0d13f1b4;hp=0b4ef6e127263b872ec632f222caf9874666f53b;hpb=9cf56d917d92959701694477f7944d45ad2c38ed;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/xline.h b/include/xline.h index 0b4ef6e12..2a49d8b80 100644 --- a/include/xline.h +++ b/include/xline.h @@ -1,72 +1,147 @@ -/* +------------------------------------+ - * | 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 + * Copyright (C) 2004-2007 Craig Edwards + * Copyright (C) 2007 Robin Burchell + * Copyright (C) 2007 Dennis Friis * - * 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 . */ -#ifndef __XLINE_H -#define __XLINE_H - -// include the common header files - -#include -#include -#include -#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; +#ifndef XLINE_H +#define XLINE_H /** 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 { - public: + protected: - XLine(time_t s_time, long d, const char* src, const char* re) - : set_time(s_time), duration(d) + /** 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, 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; } + /** Destructor + */ 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; + + /** 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 Xline blah, set by...' + * see the DisplayExpiry methods of GLine, ELine etc. + */ + 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 seperately but will still return ident\@host + * for its Displayable() method) + */ + virtual const char* 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. Set only by derived classes constructor to the + * type of line this is. + */ + const std::string type; + + virtual bool IsBurstable(); }; /** KLine class @@ -74,23 +149,48 @@ class CoreExport XLine : public classbase class CoreExport KLine : public XLine { public: - /** Hostmask (ident@host) to match against - * May contain wildcards. + + /** 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, long d, const char* src, const char* re, const char* ident, const char* host) : XLine(s_time, d, src, re) + 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); } + /** Destructor + */ ~KLine() { - free(identmask); - free(hostmask); } - char* identmask; - char* hostmask; + virtual bool Matches(User *u); + + virtual bool Matches(const std::string &str); + + virtual void Apply(User* u); + + virtual void DisplayExpiry(); + + virtual const char* Displayable(); + + virtual bool IsBurstable(); + + /** Ident mask (ident part only) + */ + std::string identmask; + /** Host mask (host part only) + */ + std::string hostmask; + + std::string matchtext; }; /** GLine class @@ -98,23 +198,45 @@ class CoreExport KLine : public XLine class CoreExport GLine : public XLine { public: - /** Hostmask (ident@host) to match against - * May contain wildcards. - */ - 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) + /** 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, 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); } + /** Destructor + */ ~GLine() { - free(identmask); - free(hostmask); } - char* identmask; - char* hostmask; + virtual bool Matches(User *u); + + virtual bool Matches(const std::string &str); + + virtual void Apply(User* u); + + virtual void DisplayExpiry(); + + virtual const char* Displayable(); + + /** Ident mask (ident part only) + */ + std::string identmask; + /** Host mask (host part only) + */ + std::string hostmask; + + std::string matchtext; }; /** ELine class @@ -122,23 +244,45 @@ class CoreExport GLine : public XLine class CoreExport ELine : public XLine { public: - /** Hostmask (ident@host) to match against - * May contain wildcards. - */ - 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) + /** 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, 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); } - char* identmask; - char* hostmask; + virtual bool Matches(User *u); + + virtual bool Matches(const std::string &str); + + virtual void Unset(); + + virtual void DisplayExpiry(); + + virtual void OnAdd(); + + virtual const char* Displayable(); + + /** Ident mask (ident part only) + */ + std::string identmask; + /** Host mask (host part only) + */ + std::string hostmask; + + std::string matchtext; }; /** ZLine class @@ -146,20 +290,37 @@ class CoreExport ELine : public XLine class CoreExport ZLine : public XLine { public: - /** IP Address (xx.yy.zz.aa) to match against - * May contain wildcards. - */ - ZLine(time_t s_time, long d, const char* src, const char* re, const char* ip) : XLine(s_time, d, src, re) + /** 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, 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); } - char* ipaddr; + virtual bool Matches(User *u); + + virtual bool Matches(const std::string &str); + + virtual void Apply(User* u); + + virtual void DisplayExpiry(); + + virtual const char* Displayable(); + + /** IP mask (no ident part) + */ + std::string ipaddr; }; /** QLine class @@ -167,278 +328,213 @@ class CoreExport ZLine : public XLine class CoreExport QLine : public XLine { public: - /** Nickname to match against. - * May contain wildcards. - */ - QLine(time_t s_time, long d, const char* src, const char* re, const char* nickname) : XLine(s_time, d, src, re) + /** 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 nickname Nickname to match + */ + 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); - char* nick; -}; - -class ServerConfig; -class InspIRCd; + virtual bool Matches(const std::string &str); -bool InitXLine(ServerConfig* conf, const char* tag); + virtual void Apply(User* u); -bool DoneZLine(ServerConfig* conf, const char* tag); -bool DoneQLine(ServerConfig* conf, const char* tag); -bool DoneKLine(ServerConfig* conf, const char* tag); -bool DoneELine(ServerConfig* conf, const char* tag); + virtual void DisplayExpiry(); -bool DoZLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types); -bool DoQLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types); -bool DoKLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types); -bool DoELine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types); + virtual const char* Displayable(); -typedef std::pair IdentHostPair; + /** Nickname mask + */ + std::string nick; +}; -/** XLineManager is a class used to manage glines, klines, elines, zlines and qlines. +/** 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 XLineManager +class CoreExport XLineFactory { protected: - /** The owner/creator of this class - */ - InspIRCd* ServerInstance; - /** This functor is used by the std::sort() function to keep glines in order - */ - static bool GSortComparison ( const GLine* one, const GLine* two ); - - /** This functor is used by the std::sort() function to keep elines in order - */ - static bool ESortComparison ( const ELine* one, const ELine* two ); + std::string type; - /** This functor is used by the std::sort() function to keep zlines in order - */ - static bool ZSortComparison ( const ZLine* one, const ZLine* two ); - - /** This functor is used by the std::sort() function to keep klines in order - */ - static bool KSortComparison ( const KLine* one, const KLine* two ); - - /** This functor is used by the std::sort() function to keep qlines in order - */ - static bool QSortComparison ( const QLine* one, const QLine* two ); public: - /* Lists for temporary lines with an expiry time */ - - /** Temporary KLines */ - std::vector klines; - - /** Temporary Glines */ - std::vector glines; - - /** Temporary Zlines */ - std::vector zlines; - - /** Temporary QLines */ - std::vector qlines; - /** Temporary ELines */ - std::vector elines; - - /* Seperate lists for perm XLines that isnt checked by expiry functions */ - - /** Permenant KLines */ - std::vector pklines; - - /** Permenant GLines */ - std::vector pglines; - - /** Permenant ZLines */ - std::vector pzlines; - - /** Permenant QLines */ - std::vector pqlines; - - /** Permenant ELines */ - std::vector pelines; - - /** Constructor - * @param Instance A pointer to the creator object - */ - XLineManager(InspIRCd* Instance); - - 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 + /** Create an XLine factory + * @param t Type of XLine this factory generates */ - bool add_gline(long duration, const char* source, const char* reason, const char* hostmask); + XLineFactory(const std::string &t) : type(t) { } - /** 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 + /** Return the type of XLine this factory generates + * @return The type of XLine this factory generates */ - bool add_qline(long duration, const char* source, const char* reason, const char* nickname); + virtual const std::string& GetType() { return type; } - /** Add a new ZLine - * @param duration The duration of the line - * @param source The source of the line + /** 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 ipaddr The IP mask - * @return True if the line was added successfully + * @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. */ - bool add_zline(long duration, const char* source, const char* reason, const char* ipaddr); + virtual XLine* Generate(time_t set_time, long duration, std::string source, std::string reason, std::string xline_specific_mask) = 0; - /** 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 - */ - bool add_kline(long duration, const char* source, const char* reason, const char* hostmask); + virtual bool AutoApplyToUserList(XLine* x) { return true; } - /** 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 - * @return True if the line was added successfully + /** Destructor */ - bool add_eline(long duration, const char* source, const char* reason, const char* hostmask); + virtual ~XLineFactory() { } +}; - /** Delete a GLine - * @return hostmask The host to remove - * @return True if the line was deleted successfully +/** 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: + /** Used to hold XLines which have not yet been applied. */ - bool del_gline(const char* hostmask); + std::vector pending_lines; - /** Delete a QLine - * @return nickname The nick to remove - * @return True if the line was deleted successfully + /** Current xline factories */ - bool del_qline(const char* nickname); + XLineFactMap line_factory; - /** Delete a ZLine - * @return ipaddr The IP to remove - * @return True if the line was deleted successfully + /** 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. */ - bool del_zline(const char* ipaddr); + XLineContainer lookup_lines; - /** Delete a KLine - * @return hostmask The host to remove - * @return True if the line was deleted successfully - */ - bool del_kline(const char* hostmask); + public: - /** Delete a ELine - * @return hostmask The host to remove - * @return True if the line was deleted successfully + /** Constructor */ - bool del_eline(const char* hostmask); + XLineManager(); - /** 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 + /** Destructor */ - QLine* matches_qline(const char* nick, bool permonly = false); + ~XLineManager(); - /** 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 + /** Split an ident and host into two seperate strings. + * This allows for faster matching. */ - GLine* matches_gline(userrec* user, bool permonly = false); + IdentHostPair IdentSplit(const std::string &ident_and_host); - /** Check if a IP matches a ZLine - * @param ipaddr The IP to check against - * @return The reason for the line if there is a match, or NULL if there is no match + /** Checks what users match e:lines and sets their ban exempt flag accordingly. */ - ZLine* matches_zline(const char* ipaddr, bool permonly = false); + void CheckELines(); - /** 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 + /** Get all lines of a certain type to an XLineLookup (std::map). + * 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. */ - KLine* matches_kline(userrec* user, bool permonly = false); + XLineLookup* GetAll(const std::string &type); - /** 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 + /** Remove all lines of a certain type. */ - ELine* matches_exception(userrec* user, bool permonly = false); + void DelAll(const std::string &type); - /** Expire any pending non-permenant lines + /** 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. */ - void expire_lines(); + std::vector GetAllTypes(); - /** Apply any new lines - * @param What The types of lines to apply, from the set - * APPLY_GLINES | APPLY_KLINES | APPLY_QLINES | APPLY_ZLINES | APPLY_ALL - * | APPLY_LOCAL_ONLY + /** 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 */ - void apply_lines(const int What); + bool AddLine(XLine* line, User* user); - /** Handle /STATS K - * @param user The username making the query - * @param results The string_list to receive the results + /** 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 */ - void stats_k(userrec* user, string_list &results); + bool DelLine(const char* hostmask, const std::string &type, User* user, bool simulate = false); - /** Handle /STATS G - * @param user The username making the query - * @param results The string_list to receive the results + /** 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 + * server protocol module like m_spanningtree, when you receive xlines from other + * servers. + * @param xlf XLineFactory pointer to register */ - void stats_g(userrec* user, string_list &results); + bool RegisterFactory(XLineFactory* xlf); - /** Handle /STATS Q - * @param user The username making the query - * @param results The string_list to receive the results + /** Unregisters an xline factory. + * You must do this when your module unloads. + * @param xlf XLineFactory pointer to unregister */ - void stats_q(userrec* user, string_list &results); + bool UnregisterFactory(XLineFactory* xlf); - /** Handle /STATS Z - * @param user The username making the query - * @param results The string_list to receive the results + /** 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 */ - void stats_z(userrec* user, string_list &results); + XLineFactory* GetFactory(const std::string &type); - /** Handle /STATS E - * @param user The username making the query - * @param results The string_list to receive the results + /** 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 */ - void stats_e(userrec* user, string_list &results); + XLine* MatchesLine(const std::string &type, User* user); - /** Change creation time of a GLine - * @param host The hostname to change - * @param create_Time The new creation time + /** 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 */ - void gline_set_creation_time(const char* host, time_t create_time); + XLine* MatchesLine(const std::string &type, const std::string &pattern); - /** Change creation time of a QLine - * @param nick The nickmask to change - * @param create_Time The new creation time + /** 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 qline_set_creation_time(const char* nick, time_t create_time); + void ExpireLine(ContainerIter container, LookupIter item); - /** Change creation time of a ZLine - * @param ip The ipmask to change - * @param create_Time The new creation time + /** 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 zline_set_creation_time(const char* ip, time_t create_time); + void ApplyLines(); - /** Change creation time of a ELine - * @param host The hostname to change - * @param create_Time The new creation time + /** 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 */ - void eline_set_creation_time(const char* host, time_t create_time); + void InvokeStats(const std::string &type, int numeric, User* user, string_list &results); }; #endif