]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/xline.h
Merge pull request #1018 from SaberUK/insp20+hidekills
[user/henk/code/inspircd.git] / include / xline.h
index 6d11256f21a170d36a773764e2bd086fbadd44d3..2a49d8b80efe1c49230137a847a4838a049485be 100644 (file)
@@ -1,22 +1,27 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/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>
+#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
@@ -29,9 +34,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,11 +50,9 @@ 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, const char* src, const char* re, const std::string &t)
-               : ServerInstance(Instance), set_time(s_time), duration(d), 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)
        {
-               source = strdup(src);
-               reason = strdup(re);
                expiry = set_time + duration;
        }
 
@@ -60,8 +60,6 @@ class CoreExport XLine : public classbase
         */
        virtual ~XLine()
        {
-               free(reason);
-               free(source);
        }
 
        /** Change creation time of an xline. Updates expiry
@@ -106,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;
@@ -121,18 +119,18 @@ class CoreExport XLine : public classbase
        /** 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. Does not contain useful data if the duration is 0.
         */
@@ -160,10 +158,9 @@ class CoreExport KLine : public XLine
         * @param ident Ident to match
         * @param host Host to match
         */
-       KLine(InspIRCd* Instance, time_t s_time, long d, const char* src, const char* re, const char* ident, const char* host) : XLine(Instance, s_time, d, src, re, "K")
+       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);
        }
@@ -172,8 +169,6 @@ class CoreExport KLine : public XLine
         */
        ~KLine()
        {
-               free(identmask);
-               free(hostmask);
        }
 
        virtual bool Matches(User *u);
@@ -190,10 +185,10 @@ class CoreExport KLine : public XLine
 
        /** Ident mask (ident part only)
         */
-       char* identmask;
+       std::string identmask;
        /** Host mask (host part only)
         */
-       char* hostmask;
+       std::string hostmask;
 
        std::string matchtext;
 };
@@ -211,10 +206,9 @@ class CoreExport GLine : public XLine
         * @param ident Ident to match
         * @param host Host to match
         */
-       GLine(InspIRCd* Instance, time_t s_time, long d, const char* src, const char* re, const char* ident, const char* host) : XLine(Instance, s_time, d, src, re, "G")
+       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);
        }
@@ -223,8 +217,6 @@ class CoreExport GLine : public XLine
         */
        ~GLine()
        {
-               free(identmask);
-               free(hostmask);
        }
 
        virtual bool Matches(User *u);
@@ -239,10 +231,10 @@ class CoreExport GLine : public XLine
 
        /** Ident mask (ident part only)
         */
-       char* identmask;
+       std::string identmask;
        /** Host mask (host part only)
         */
-       char* hostmask;
+       std::string hostmask;
 
        std::string matchtext;
 };
@@ -260,18 +252,15 @@ class CoreExport ELine : public XLine
         * @param ident Ident to match
         * @param host Host to match
         */
-       ELine(InspIRCd* Instance, time_t s_time, long d, const char* src, const char* re, const char* ident, const char* host) : XLine(Instance, s_time, d, src, re, "E")
+       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);
        }
 
        virtual bool Matches(User *u);
@@ -288,10 +277,10 @@ class CoreExport ELine : public XLine
 
        /** Ident mask (ident part only)
         */
-       char* identmask;
+       std::string identmask;
        /** Host mask (host part only)
         */
-       char* hostmask;
+       std::string hostmask;
 
        std::string matchtext;
 };
@@ -308,16 +297,15 @@ 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, const char* src, const char* re, const char* ip) : XLine(Instance, s_time, d, src, re, "Z")
+       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);
        }
 
        virtual bool Matches(User *u);
@@ -332,7 +320,7 @@ class CoreExport ZLine : public XLine
 
        /** IP mask (no ident part)
         */
-       char* ipaddr;
+       std::string ipaddr;
 };
 
 /** QLine class
@@ -347,17 +335,15 @@ 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, const char* src, const char* re, const char* nickname) : XLine(Instance, s_time, d, src, re, "Q")
+       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);
 
@@ -371,14 +357,10 @@ class CoreExport QLine : public XLine
 
        /** Nickname mask
         */
-       char* nick;
+       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 
+/** 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
@@ -389,17 +371,15 @@ 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
         */
@@ -413,44 +393,15 @@ class CoreExport XLineFactory
         * @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.
         */
-       virtual XLine* Generate(time_t set_time, long duration, const char* source, const char* reason, const char* xline_specific_mask) = 0;
+       virtual XLine* Generate(time_t set_time, long duration, std::string source, std::string reason, std::string xline_specific_mask) = 0;
+
+       virtual bool AutoApplyToUserList(XLine* x) { return true; }
 
        /** Destructor
         */
        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<std::string, XLineFactory*> XLineFactMap;
-
-/** A map of XLines indexed by string
- */
-typedef std::map<std::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.
@@ -458,10 +409,6 @@ typedef XLineLookup::iterator LookupIter;
 class CoreExport XLineManager
 {
  protected:
-       /** The owner/creator of this class
-        */
-       InspIRCd* ServerInstance;
-
        /** Used to hold XLines which have not yet been applied.
         */
        std::vector<XLine *> pending_lines;
@@ -470,16 +417,6 @@ class CoreExport XLineManager
         */
        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
@@ -490,9 +427,8 @@ class CoreExport XLineManager
  public:
 
        /** Constructor
-        * @param Instance A pointer to the creator object
         */
-       XLineManager(InspIRCd* Instance);
+       XLineManager();
 
        /** Destructor
         */
@@ -510,11 +446,15 @@ class CoreExport 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);
 
+       /** Remove all lines of a certain type.
+        */
+       void DelAll(const std::string &type);
+
        /** 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.
         */
@@ -541,7 +481,7 @@ class CoreExport XLineManager
         * 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 
+        * 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
@@ -589,6 +529,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
@@ -596,83 +537,4 @@ class CoreExport XLineManager
        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(InspIRCd* Instance) : XLineFactory(Instance, "G") { }
-
-       /** Generate a GLine
-        */
-       XLine* Generate(time_t set_time, long duration, const char* source, const char* reason, const char* xline_specific_mask)
-       {
-               IdentHostPair ih = ServerInstance->XLines->IdentSplit(xline_specific_mask);
-               return new GLine(ServerInstance, set_time, duration, source, reason, ih.first.c_str(), ih.second.c_str());
-       }
-};
-
-/** 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, const char* source, const char* reason, const char* xline_specific_mask)
-       {
-               IdentHostPair ih = ServerInstance->XLines->IdentSplit(xline_specific_mask);
-               return new ELine(ServerInstance, set_time, duration, source, reason, ih.first.c_str(), ih.second.c_str());
-       }
-};
-
-/** 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, const char* source, const char* reason, const char* xline_specific_mask)
-        {
-                IdentHostPair ih = ServerInstance->XLines->IdentSplit(xline_specific_mask);
-                return new KLine(ServerInstance, set_time, duration, source, reason, ih.first.c_str(), ih.second.c_str());
-        }
-};
-
-/** 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, const char* source, const char* reason, const char* 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, const char* source, const char* reason, const char* xline_specific_mask)
-        {
-                return new ZLine(ServerInstance, set_time, duration, source, reason, xline_specific_mask);
-        }
-};
-
 #endif
-