-/* +------------------------------------+
- * | 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 <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 <string>
-//#include <deque>
-//#include <vector>
+#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
* 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.
*/
virtual void Apply(User* u);
- virtual void DisplayExpiry();
-
- virtual const char* Displayable();
+ virtual const std::string& Displayable();
virtual bool IsBurstable();
virtual void Apply(User* u);
- virtual void DisplayExpiry();
-
- virtual const char* Displayable();
+ virtual const std::string& Displayable();
/** Ident mask (ident part only)
*/
virtual void Unset();
- virtual void DisplayExpiry();
-
virtual void OnAdd();
- virtual const char* Displayable();
+ virtual const std::string& Displayable();
/** Ident mask (ident part only)
*/
virtual void Apply(User* u);
- virtual void DisplayExpiry();
-
- virtual const char* Displayable();
+ virtual const std::string& Displayable();
/** IP mask (no ident part)
*/
virtual void Apply(User* u);
- virtual void DisplayExpiry();
-
- virtual const char* Displayable();
+ virtual const std::string& Displayable();
/** Nickname mask
*/
std::string nick;
};
-/** Contains an ident and host split into two strings
- */
-typedef std::pair<std::string, std::string> 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
* 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:
public:
/** Create an XLine factory
- * @param Instance creator
* @param t Type of XLine this factory generates
*/
XLineFactory(const std::string &t) : type(t) { }
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<std::string, XLineFactory*> XLineFactMap;
-
-/** A map of XLines indexed by string
- */
-typedef std::map<irc::string, XLine *> XLineLookup;
-
-/** A map of XLineLookup maps indexed by string
- */
-typedef std::map<std::string, XLineLookup > 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.
*/
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
public:
/** Constructor
- * @param Instance A pointer to the creator object
*/
XLineManager();
/** 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 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);
/** 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 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
projects / user / henk / code / inspircd.git / blobdiff