]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/xline.h
Provide error output on failure to load a core command; to console on startup, and...
[user/henk/code/inspircd.git] / include / xline.h
index daefe8a1efbe84e52875b4ee19eb11c5915a5181..bb59a97355bd2acea87cc74fe3d38680ccd5450d 100644 (file)
@@ -2,14 +2,11 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
- *                       E-mail:
- *                <brain@chatspike.net>
- *               <Craig@chatspike.net>
- *     
- * Written by Craig Edwards, Craig McLure, and others.
+ *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/Credits
+ *
  * This program is free but copyrighted software; see
- *            the file COPYING for details.
+ *         the file COPYING for details.
  *
  * ---------------------------------------------------
  */
 #include "users.h"
 #include "channels.h"
 
-const int APPLY_GLINES = 1;
-const int APPLY_KLINES = 2;
-const int APPLY_QLINES = 4;
-const int APPLY_ZLINES = 8;
-const int APPLY_ALL    = APPLY_GLINES | APPLY_KLINES | APPLY_QLINES | APPLY_ZLINES;
+const int APPLY_GLINES         = 1;
+const int APPLY_KLINES         = 2;
+const int APPLY_QLINES         = 4;
+const int APPLY_ZLINES         = 8;
+const int APPLY_PERM_ONLY      = 16;
+const int APPLY_ALL            = APPLY_GLINES | APPLY_KLINES | APPLY_QLINES | APPLY_ZLINES;
 
 /** XLine is the base class for ban lines such as G lines and K lines.
  */
-class XLine : public classbase
+class CoreExport XLine : public classbase
 {
   public:
 
+       /** Create an XLine.
+        * @param s_time The set time
+        * @param d The duration of the xline
+        * @param src The sender of the xline
+        * @param re The reason of the xline
+        */
        XLine(time_t s_time, long d, const char* src, const char* re)
                : set_time(s_time), duration(d)
        {
@@ -45,6 +49,8 @@ class XLine : public classbase
                expiry = set_time + duration;
        }
 
+       /** Destructor
+        */
        virtual ~XLine()
        {
                free(reason);
@@ -73,11 +79,16 @@ class XLine : public classbase
 
 /** KLine class
  */
-class KLine : public XLine
+class CoreExport KLine : public XLine
 {
   public:
-       /** Hostmask (ident@host) to match against
-        * May contain wildcards.
+       /** Create a K-Line.
+        * @param s_time The set time
+        * @param d The duration of the xline
+        * @param src The sender of the xline
+        * @param re The reason of the xline
+        * @param ident Ident to match
+        * @param host Host to match
         */
        KLine(time_t s_time, long d, const char* src, const char* re, const char* ident, const char* host) : XLine(s_time, d, src, re)
        {
@@ -85,23 +96,34 @@ class KLine : public XLine
                hostmask = strdup(host);
        }
 
+       /** Destructor
+        */
        ~KLine()
        {
                free(identmask);
                free(hostmask);
        }
 
+       /** Ident mask
+        */
        char* identmask;
+       /** Host mask
+        */
        char* hostmask;
 };
 
 /** GLine class
  */
-class GLine : public XLine
+class CoreExport GLine : public XLine
 {
   public:
-       /** Hostmask (ident@host) to match against
-        * May contain wildcards.
+       /** Create a G-Line.
+        * @param s_time The set time
+        * @param d The duration of the xline
+        * @param src The sender of the xline
+        * @param re The reason of the xline
+        * @param ident Ident to match
+        * @param host Host to match
         */
        GLine(time_t s_time, long d, const char* src, const char* re, const char* ident, const char* host) : XLine(s_time, d, src, re)
        {
@@ -109,24 +131,35 @@ class GLine : public XLine
                hostmask = strdup(host);
        }
 
+       /** Destructor
+        */
        ~GLine()
        {
                free(identmask);
                free(hostmask);
        }
 
+       /** Ident mask
+        */
        char* identmask;
+       /** Host mask
+        */
        char* hostmask;
 };
 
 /** ELine class
  */
-class ELine : public XLine
+class CoreExport ELine : public XLine
 {
   public:
-        /** Hostmask (ident@host) to match against
-         * May contain wildcards.
-         */
+       /** Create an E-Line.
+        * @param s_time The set time
+        * @param d The duration of the xline
+        * @param src The sender of the xline
+        * @param re The reason of the xline
+        * @param ident Ident to match
+        * @param host Host to match
+        */
        ELine(time_t s_time, long d, const char* src, const char* re, const char* ident, const char* host) : XLine(s_time, d, src, re)
        {
                identmask = strdup(ident);
@@ -139,68 +172,114 @@ class ELine : public XLine
                free(hostmask);
        }
 
+       /** Ident mask
+        */
        char* identmask;
-        char* hostmask;
+       /** Host mask
+        */
+       char* hostmask;
 };
 
 /** ZLine class
  */
-class ZLine : public XLine
+class CoreExport ZLine : public XLine
 {
   public:
-       /** IP Address (xx.yy.zz.aa) to match against
-        * May contain wildcards.
+       /** Create a Z-Line.
+        * @param s_time The set time
+        * @param d The duration of the xline
+        * @param src The sender of the xline
+        * @param re The reason of the xline
+        * @param ip IP to match
         */
        ZLine(time_t s_time, long d, const char* src, const char* re, const char* ip) : XLine(s_time, d, src, re)
        {
                ipaddr = strdup(ip);
        }
 
+       /** Destructor
+        */
        ~ZLine()
        {
                free(ipaddr);
        }
 
+       /** IP mask
+        */
        char* ipaddr;
 };
 
 /** QLine class
  */
-class QLine : public XLine
+class CoreExport QLine : public XLine
 {
   public:
-       /** Nickname to match against.
-        * May contain wildcards.
+       /** Create a G-Line.
+        * @param s_time The set time
+        * @param d The duration of the xline
+        * @param src The sender of the xline
+        * @param re The reason of the xline
+        * @param nickname Nickname to match
         */
        QLine(time_t s_time, long d, const char* src, const char* re, const char* nickname) : XLine(s_time, d, src, re)
        {
                nick = strdup(nickname);
        }
 
+       /** Destructor
+        */
        ~QLine()
        {
                free(nick);
        }
 
+       /** Nickname mask
+        */
        char* nick;
 };
 
+/* Required forward declarations
+ */
 class ServerConfig;
 class InspIRCd;
 
+/** Initialize x line
+ */
 bool InitXLine(ServerConfig* conf, const char* tag);
-bool DoneXLine(ServerConfig* conf, const char* tag);
 
-bool DoZLine(ServerConfig* conf, const char* tag, char** entries, void** values, int* types);
-bool DoQLine(ServerConfig* conf, const char* tag, char** entries, void** values, int* types);
-bool DoKLine(ServerConfig* conf, const char* tag, char** entries, void** values, int* types);
-bool DoELine(ServerConfig* conf, const char* tag, char** entries, void** values, int* types);
+/** Done adding zlines from the config
+ */
+bool DoneZLine(ServerConfig* conf, const char* tag);
+/** Done adding qlines from the config
+ */
+bool DoneQLine(ServerConfig* conf, const char* tag);
+/** Done adding klines from the config
+ */
+bool DoneKLine(ServerConfig* conf, const char* tag);
+/** Done adding elines from the config
+ */
+bool DoneELine(ServerConfig* conf, const char* tag);
 
+/** Add a config-defined zline
+ */
+bool DoZLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
+/** Add a config-defined qline
+ */
+bool DoQLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
+/** Add a config-defined kline
+ */
+bool DoKLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
+/** Add a config-defined eline
+ */
+bool DoELine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types);
+
+/** Contains an ident and host split into two strings
+ */
 typedef std::pair<std::string, std::string> IdentHostPair;
 
 /** XLineManager is a class used to manage glines, klines, elines, zlines and qlines.
  */
-class XLineManager
+class CoreExport XLineManager
 {
  protected:
        /** The owner/creator of this class
@@ -266,6 +345,9 @@ class XLineManager
         */
        XLineManager(InspIRCd* Instance);
 
+       /** Split an ident and host into two seperate strings.
+        * This allows for faster matching.
+        */
        IdentHostPair IdentSplit(const std::string &ident_and_host);
 
        /** Add a new GLine
@@ -314,64 +396,69 @@ class XLineManager
        bool add_eline(long duration, const char* source, const char* reason, const char* hostmask);
 
        /** Delete a GLine
-        * @return hostmask The host to remove
+        * @param hostmask The host to remove
+        * @param simulate If this is true, don't actually remove the line, just return
         * @return True if the line was deleted successfully
         */
-       bool del_gline(const char* hostmask);
+       bool del_gline(const char* hostmask, bool simulate = false);
 
        /** Delete a QLine
-        * @return nickname The nick to remove
+        * @param nickname The nick to remove
+        * @param simulate If this is true, don't actually remove the line, just return
         * @return True if the line was deleted successfully
         */
-       bool del_qline(const char* nickname);
+       bool del_qline(const char* nickname, bool simulate = false);
 
        /** Delete a ZLine
-        * @return ipaddr The IP to remove
+        * @param ipaddr The IP to remove
+        * @param simulate If this is true, don't actually remove the line, just return
         * @return True if the line was deleted successfully
         */
-       bool del_zline(const char* ipaddr);
+       bool del_zline(const char* ipaddr, bool simulate = false);
 
        /** Delete a KLine
-        * @return hostmask The host to remove
+        * @param hostmask The host to remove
+        * @param simulate If this is true, don't actually remove the line, just return
         * @return True if the line was deleted successfully
         */
-       bool del_kline(const char* hostmask);
+       bool del_kline(const char* hostmask, bool simulate = false);
 
        /** Delete a ELine
-        * @return hostmask The host to remove
+        * @param hostmask The host to remove
+        * @param simulate If this is true, don't actually remove the line, just return
         * @return True if the line was deleted successfully
         */
-       bool del_eline(const char* hostmask);
+       bool del_eline(const char* hostmask, bool simulate = false);
 
        /** Check if a nickname matches a QLine
         * @return nick The nick to check against
         * @return The reason for the line if there is a match, or NULL if there is no match
         */
-       QLine* matches_qline(const char* nick);
+       QLine* matches_qline(const char* nick, bool permonly = false);
 
        /** Check if a hostname matches a GLine
         * @param user The user to check against
         * @return The reason for the line if there is a match, or NULL if there is no match
         */
-       GLine* matches_gline(userrec* user);
+       GLine* matches_gline(userrec* user, bool permonly = false);
 
        /** Check if a IP matches a ZLine
         * @param ipaddr The IP to check against
         * @return The reason for the line if there is a match, or NULL if there is no match
         */
-       ZLine* matches_zline(const char* ipaddr);
+       ZLine* matches_zline(const char* ipaddr, bool permonly = false);
 
        /** Check if a hostname matches a KLine
         * @param user The user to check against
         * @return The reason for the line if there is a match, or NULL if there is no match
         */
-       KLine* matches_kline(userrec* user);
+       KLine* matches_kline(userrec* user, bool permonly = false);
 
        /** Check if a hostname matches a ELine
         * @param user The user to check against
         * @return The reason for the line if there is a match, or NULL if there is no match
         */
-       ELine* matches_exception(userrec* user);
+       ELine* matches_exception(userrec* user, bool permonly = false);
 
        /** Expire any pending non-permenant lines
         */
@@ -380,6 +467,7 @@ class XLineManager
        /** Apply any new lines
         * @param What The types of lines to apply, from the set
         * APPLY_GLINES | APPLY_KLINES | APPLY_QLINES | APPLY_ZLINES | APPLY_ALL
+        * | APPLY_LOCAL_ONLY
         */
        void apply_lines(const int What);
 
@@ -439,3 +527,4 @@ class XLineManager
 };
 
 #endif
+