X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;ds=sidebyside;f=include%2Fxline.h;h=2a49d8b80efe1c49230137a847a4838a049485be;hb=808a0a09577009c2d6e494979c2189426b332aef;hp=7ac4aa7f1944eb533933dd1d67ce1902ea7b911e;hpb=6d03943426dcce76ba66567a9b18425a5ebb4c0c;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/xline.h b/include/xline.h index 7ac4aa7f1..2a49d8b80 100644 --- a/include/xline.h +++ b/include/xline.h @@ -1,22 +1,27 @@ -/* +------------------------------------+ - * | 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 +#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 @@ -99,10 +104,10 @@ class CoreExport XLine : public classbase 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 + * 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 + * ident and host parts seperately but will still return ident\@host * for its Displayable() method) */ virtual const char* Displayable() = 0; @@ -355,10 +360,6 @@ class CoreExport QLine : public XLine 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 @@ -366,7 +367,7 @@ 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: @@ -375,7 +376,6 @@ class CoreExport XLineFactory : public classbase public: /** Create an XLine factory - * @param Instance creator * @param t Type of XLine this factory generates */ XLineFactory(const std::string &t) : type(t) { } @@ -402,41 +402,11 @@ class CoreExport XLineFactory : public classbase virtual ~XLineFactory() { } }; -/* Required forward declarations - */ -class ServerConfig; - -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: /** Used to hold XLines which have not yet been applied. @@ -447,16 +417,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 @@ -467,7 +427,6 @@ class CoreExport XLineManager : public classbase public: /** Constructor - * @param Instance A pointer to the creator object */ XLineManager(); @@ -487,7 +446,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); @@ -570,6 +529,7 @@ 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 @@ -577,82 +537,4 @@ class CoreExport XLineManager : public classbase 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() : XLineFactory("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(set_time, duration, source, reason, ih.first, ih.second); - } -}; - -/** An XLineFactory specialized to generate ELine* pointers - */ -class CoreExport ELineFactory : public XLineFactory -{ - public: - ELineFactory() : XLineFactory("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(set_time, duration, source, reason, ih.first, ih.second); - } -}; - -/** An XLineFactory specialized to generate KLine* pointers - */ -class CoreExport KLineFactory : public XLineFactory -{ - public: - KLineFactory() : XLineFactory("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(set_time, duration, source, reason, ih.first, ih.second); - } -}; - -/** An XLineFactory specialized to generate QLine* pointers - */ -class CoreExport QLineFactory : public XLineFactory -{ - public: - QLineFactory() : XLineFactory("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(set_time, duration, source, reason, xline_specific_mask); - } -}; - -/** An XLineFactory specialized to generate ZLine* pointers - */ -class CoreExport ZLineFactory : public XLineFactory -{ - public: - ZLineFactory() : XLineFactory("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(set_time, duration, source, reason, xline_specific_mask); - } -}; - #endif