X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fxline.h;h=119e29dc12930e7429804f11e81f61e6bdd48822;hb=326852f7dd3fd6989d37ad2991f8a174b3a86b65;hp=4ad1c63be8e7e12eaa297a3f80260af2852bc318;hpb=355b17f151fe8258a025a3db3240339ab7cea445;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/xline.h b/include/xline.h index 4ad1c63be..119e29dc1 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 @@ -96,13 +100,13 @@ 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 + * ident and host parts seperately but will still return ident\@host * for its Displayable() method) */ virtual const char* Displayable() = 0; @@ -172,8 +176,6 @@ class CoreExport KLine : public XLine virtual void Apply(User* u); - virtual void DisplayExpiry(); - virtual const char* Displayable(); virtual bool IsBurstable(); @@ -220,8 +222,6 @@ class CoreExport GLine : public XLine virtual void Apply(User* u); - virtual void DisplayExpiry(); - virtual const char* Displayable(); /** Ident mask (ident part only) @@ -264,8 +264,6 @@ class CoreExport ELine : public XLine virtual void Unset(); - virtual void DisplayExpiry(); - virtual void OnAdd(); virtual const char* Displayable(); @@ -309,8 +307,6 @@ class CoreExport ZLine : public XLine virtual void Apply(User* u); - virtual void DisplayExpiry(); - virtual const char* Displayable(); /** IP mask (no ident part) @@ -346,8 +342,6 @@ class CoreExport QLine : public XLine virtual void Apply(User* u); - virtual void DisplayExpiry(); - virtual const char* Displayable(); /** Nickname mask @@ -355,10 +349,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 @@ -375,7 +365,6 @@ class CoreExport XLineFactory public: /** Create an XLine factory - * @param Instance creator * @param t Type of XLine this factory generates */ XLineFactory(const std::string &t) : type(t) { } @@ -402,30 +391,6 @@ class CoreExport XLineFactory virtual ~XLineFactory() { } }; -/* Required forward declarations - */ -class ServerConfig; - -/** 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. @@ -451,7 +416,6 @@ class CoreExport XLineManager public: /** Constructor - * @param Instance A pointer to the creator object */ XLineManager(); @@ -471,7 +435,7 @@ class CoreExport XLineManager /** 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); @@ -554,6 +518,7 @@ class CoreExport XLineManager /** 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 @@ -561,4 +526,3 @@ class CoreExport XLineManager void InvokeStats(const std::string &type, int numeric, User* user, string_list &results); }; -#endif