X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fxline.h;h=9aae32b24b044068a33e5b8deb7c4de683531a06;hb=204d78aaa7b1cbfa98ef39f3961ad5fe428cf12b;hp=e2915e0247382a9a46e0997154964ae7bfd08b19;hpb=94bb5343b1464cbec9f58ee9d90a3deae3ac5308;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/xline.h b/include/xline.h index e2915e024..9aae32b24 100644 --- a/include/xline.h +++ b/include/xline.h @@ -1,22 +1,26 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd: (C) 2002-2009 InspIRCd Development Team - * See: http://wiki.inspircd.org/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 -//#include -//#include +#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 @@ -29,9 +33,6 @@ class CoreExport XLine : public classbase { 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 @@ -48,8 +49,8 @@ class CoreExport XLine : public classbase * @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, std::string src, std::string re, const std::string &t) - : ServerInstance(Instance), set_time(s_time), duration(d), source(src), reason(re), 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) { expiry = set_time + duration; } @@ -99,16 +100,16 @@ class CoreExport XLine : public classbase * line. Usually a line in the form 'expiring Xline 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 seperately 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. */ @@ -156,8 +157,8 @@ class CoreExport KLine : public XLine * @param ident Ident to match * @param host Host to match */ - KLine(InspIRCd* Instance, time_t s_time, long d, std::string src, std::string re, std::string ident, std::string host) - : XLine(Instance, s_time, d, src, re, "K"), identmask(ident), hostmask(host) + 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) { matchtext = this->identmask; matchtext.append("@").append(this->hostmask); @@ -169,17 +170,15 @@ class CoreExport KLine : public XLine { } - 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; - virtual bool IsBurstable(); + bool IsBurstable() CXX11_OVERRIDE; /** Ident mask (ident part only) */ @@ -204,8 +203,8 @@ class CoreExport GLine : public XLine * @param ident Ident to match * @param host Host to match */ - GLine(InspIRCd* Instance, time_t s_time, long d, std::string src, std::string re, std::string ident, std::string host) - : XLine(Instance, s_time, d, src, re, "G"), identmask(ident), hostmask(host) + 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) { matchtext = this->identmask; matchtext.append("@").append(this->hostmask); @@ -217,15 +216,13 @@ class CoreExport GLine : public XLine { } - 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); - - virtual void DisplayExpiry(); + void Apply(User* u) CXX11_OVERRIDE; - virtual const char* Displayable(); + const std::string& Displayable() CXX11_OVERRIDE; /** Ident mask (ident part only) */ @@ -250,8 +247,8 @@ class CoreExport ELine : public XLine * @param ident Ident to match * @param host Host to match */ - ELine(InspIRCd* Instance, time_t s_time, long d, std::string src, std::string re, std::string ident, std::string host) - : XLine(Instance, s_time, d, src, re, "E"), identmask(ident), hostmask(host) + 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) { matchtext = this->identmask; matchtext.append("@").append(this->hostmask); @@ -261,17 +258,15 @@ class CoreExport ELine : public XLine { } - 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(); - - virtual void OnAdd(); + void OnAdd() CXX11_OVERRIDE; - virtual const char* Displayable(); + const std::string& Displayable() CXX11_OVERRIDE; /** Ident mask (ident part only) */ @@ -295,8 +290,8 @@ class CoreExport ZLine : public XLine * @param re The reason of the xline * @param ip IP to match */ - ZLine(InspIRCd* Instance, time_t s_time, long d, std::string src, std::string re, std::string ip) - : XLine(Instance, s_time, d, src, re, "Z"), ipaddr(ip) + 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) { } @@ -306,15 +301,13 @@ class CoreExport ZLine : public XLine { } - 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); - - virtual void DisplayExpiry(); + void Apply(User* u) CXX11_OVERRIDE; - virtual const char* Displayable(); + const std::string& Displayable() CXX11_OVERRIDE; /** IP mask (no ident part) */ @@ -333,8 +326,8 @@ class CoreExport QLine : public XLine * @param re The reason of the xline * @param nickname Nickname to match */ - QLine(InspIRCd* Instance, time_t s_time, long d, std::string src, std::string re, std::string nickname) - : XLine(Instance, s_time, d, src, re, "Q"), nick(nickname) + 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) { } @@ -343,25 +336,19 @@ class CoreExport QLine : public XLine ~QLine() { } - 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); - - virtual void DisplayExpiry(); + void Apply(User* u) CXX11_OVERRIDE; - virtual const char* Displayable(); + const std::string& Displayable() CXX11_OVERRIDE; /** Nickname mask */ std::string nick; }; -/** Contains an ident and host split into two strings - */ -typedef std::pair IdentHostPair; - /** 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 @@ -369,20 +356,18 @@ typedef std::pair IdentHostPair; * does not have to know the specifics of the internals of an XLine class * and/or how to call its constructor. */ -class CoreExport XLineFactory : public classbase +class CoreExport XLineFactory { 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 @@ -406,48 +391,13 @@ class CoreExport XLineFactory : public classbase 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 XLineFactMap; - -/** A map of XLines indexed by string - */ -typedef std::map XLineLookup; - -/** A map of XLineLookup maps indexed by string - */ -typedef std::map 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, * 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 : public classbase +class CoreExport XLineManager { protected: - /** The owner/creator of this class - */ - InspIRCd* ServerInstance; - /** Used to hold XLines which have not yet been applied. */ std::vector pending_lines; @@ -456,16 +406,6 @@ class CoreExport XLineManager : public classbase */ 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 @@ -476,9 +416,8 @@ class CoreExport XLineManager : public classbase public: /** Constructor - * @param Instance A pointer to the creator object */ - XLineManager(InspIRCd* Instance); + XLineManager(); /** Destructor */ @@ -496,7 +435,7 @@ class CoreExport XLineManager : public classbase /** 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 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); @@ -579,89 +518,9 @@ class CoreExport XLineManager : public classbase /** 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 std::string &type, int numeric, User* user, string_list &results); + void InvokeStats(const std::string& type, unsigned int numeric, Stats::Context& stats); }; - -/** 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, std::string source, std::string reason, std::string xline_specific_mask) - { - IdentHostPair ih = ServerInstance->XLines->IdentSplit(xline_specific_mask); - return new GLine(ServerInstance, set_time, duration, source, reason, ih.first, ih.second); - } -}; - -/** 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, std::string source, std::string reason, std::string xline_specific_mask) - { - IdentHostPair ih = ServerInstance->XLines->IdentSplit(xline_specific_mask); - return new ELine(ServerInstance, set_time, duration, source, reason, ih.first, ih.second); - } -}; - -/** An XLineFactory specialized to generate KLine* pointers - */ -class CoreExport KLineFactory : public XLineFactory -{ - public: - KLineFactory(InspIRCd* Instance) : XLineFactory(Instance, "K") { } - - /** Generate a KLine - */ - XLine* Generate(time_t set_time, long duration, std::string source, std::string reason, std::string xline_specific_mask) - { - IdentHostPair ih = ServerInstance->XLines->IdentSplit(xline_specific_mask); - return new KLine(ServerInstance, set_time, duration, source, reason, ih.first, ih.second); - } -}; - -/** An XLineFactory specialized to generate QLine* pointers - */ -class CoreExport QLineFactory : public XLineFactory -{ - public: - QLineFactory(InspIRCd* Instance) : XLineFactory(Instance, "Q") { } - - /** Generate a QLine - */ - XLine* Generate(time_t set_time, long duration, std::string source, std::string reason, std::string 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, std::string source, std::string reason, std::string xline_specific_mask) - { - return new ZLine(ServerInstance, set_time, duration, source, reason, xline_specific_mask); - } -}; - -#endif