* | 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:
+ protected:
+
+ InspIRCd* ServerInstance;
+ void DefaultApply(User* u, char line);
- XLine(time_t s_time, long d, const char* src, const char* re)
- : set_time(s_time), duration(d)
+ 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(InspIRCd* Instance, time_t s_time, long d, const char* src, const char* re)
+ : ServerInstance(Instance), set_time(s_time), duration(d)
{
source = strdup(src);
reason = strdup(re);
expiry = set_time + duration;
}
+ /** Destructor
+ */
virtual ~XLine()
{
free(reason);
free(source);
}
+
+ /** Returns true whether or not the given user is covered by this line.
+ */
+ virtual bool Matches(User *u) = 0;
+
+ virtual bool Matches(const std::string &str);
+
+ virtual void Apply(User* u);
+
/** The time the line was added.
*/
time_t set_time;
/** Expiry time
*/
time_t expiry;
+
+ /** Q, K, etc. Don't change this. Constructors set it.
+ */
+ char type;
};
/** KLine class
*/
-class KLine : public XLine
+class CoreExport KLine : public XLine
{
public:
- /** Hostmask (ident@host) to match against
- * May contain wildcards.
- */
- 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)
+ /** 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(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)
{
identmask = strdup(ident);
hostmask = strdup(host);
+ type = 'K';
}
+ /** Destructor
+ */
~KLine()
{
free(identmask);
free(hostmask);
}
+ virtual bool Matches(User *u);
+
+ virtual void Apply(User* u);
+
+ /** 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.
- */
- 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)
+ /** 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(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)
{
identmask = strdup(ident);
hostmask = strdup(host);
+ type = 'G';
}
+ /** Destructor
+ */
~GLine()
{
free(identmask);
free(hostmask);
}
+ virtual bool Matches(User *u);
+
+ virtual void Apply(User* u);
+
+ /** 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.
- */
- 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)
+ /** 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(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)
{
identmask = strdup(ident);
hostmask = strdup(host);
+ type = 'E';
}
~ELine()
free(hostmask);
}
+ virtual bool Matches(User *u);
+
+ /** 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.
- */
- ZLine(time_t s_time, long d, const char* src, const char* re, const char* ip) : XLine(s_time, d, src, re)
+ /** 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(InspIRCd* Instance, time_t s_time, long d, const char* src, const char* re, const char* ip) : XLine(Instance, s_time, d, src, re)
{
ipaddr = strdup(ip);
+ type = 'Z';
}
+ /** Destructor
+ */
~ZLine()
{
free(ipaddr);
}
+ virtual bool Matches(User *u);
+
+ virtual bool Matches(const std::string &str);
+
+ virtual void Apply(User* u);
+
+ /** IP mask
+ */
char* ipaddr;
};
/** QLine class
*/
-class QLine : public XLine
+class CoreExport QLine : public XLine
{
public:
- /** Nickname to match against.
- * May contain wildcards.
- */
- QLine(time_t s_time, long d, const char* src, const char* re, const char* nickname) : XLine(s_time, d, src, re)
+ /** 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(InspIRCd* Instance, time_t s_time, long d, const char* src, const char* re, const char* nickname) : XLine(Instance, s_time, d, src, re)
{
nick = strdup(nickname);
+ type = 'Q';
}
+ /** Destructor
+ */
~QLine()
{
free(nick);
+
}
+ virtual bool Matches(User *u);
+ virtual bool Matches(const std::string &str);
+
+ virtual void Apply(User* u);
+
+ /** 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);
+/** 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
*/
InspIRCd* ServerInstance;
- /** This functor is used by the std::sort() function to keep glines in order
+ /** This functor is used by the std::sort() function to keep all lines in order
*/
- static bool GSortComparison ( const GLine* one, const GLine* two );
+ static bool XSortComparison (const XLine *one, const XLine *two);
- /** This functor is used by the std::sort() function to keep elines in order
+ /** Used to hold XLines which have not yet been applied.
*/
- static bool ESortComparison ( const ELine* one, const ELine* two );
-
- /** This functor is used by the std::sort() function to keep zlines in order
- */
- static bool ZSortComparison ( const ZLine* one, const ZLine* two );
-
- /** This functor is used by the std::sort() function to keep klines in order
- */
- static bool KSortComparison ( const KLine* one, const KLine* two );
-
- /** This functor is used by the std::sort() function to keep qlines in order
- */
- static bool QSortComparison ( const QLine* one, const QLine* two );
+ std::vector<XLine *> pending_lines;
public:
/* Lists for temporary lines with an expiry time */
/** Temporary ELines */
std::vector<ELine*> elines;
- /* Seperate lists for perm XLines that isnt checked by expiry functions */
-
- /** Permenant KLines */
- std::vector<KLine*> pklines;
-
- /** Permenant GLines */
- std::vector<GLine*> pglines;
-
- /** Permenant ZLines */
- std::vector<ZLine*> pzlines;
-
- /** Permenant QLines */
- std::vector<QLine*> pqlines;
-
- /** Permenant ELines */
- std::vector<ELine*> pelines;
-
/** Constructor
* @param Instance A pointer to the creator object
*/
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
* @param hostmask The hostmask
* @return True if the line was added successfully
*/
- bool add_gline(long duration, const char* source, const char* reason, const char* hostmask);
+ bool AddGLine(long duration, const char* source, const char* reason, const char* hostmask);
/** Add a new QLine
* @param duration The duration of the line
* @param nickname The nickmask
* @return True if the line was added successfully
*/
- bool add_qline(long duration, const char* source, const char* reason, const char* nickname);
+ bool AddQLine(long duration, const char* source, const char* reason, const char* nickname);
/** Add a new ZLine
* @param duration The duration of the line
* @param ipaddr The IP mask
* @return True if the line was added successfully
*/
- bool add_zline(long duration, const char* source, const char* reason, const char* ipaddr);
+ bool AddZLine(long duration, const char* source, const char* reason, const char* ipaddr);
/** Add a new KLine
* @param duration The duration of the line
* @param hostmask The hostmask
* @return True if the line was added successfully
*/
- bool add_kline(long duration, const char* source, const char* reason, const char* hostmask);
+ bool AddKLine(long duration, const char* source, const char* reason, const char* hostmask);
/** Add a new ELine
* @param duration The duration of the line
* @param hostmask The hostmask
* @return True if the line was added successfully
*/
- bool add_eline(long duration, const char* source, const char* reason, const char* hostmask);
+ bool AddELine(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 DelGLine(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 DelQLine(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 DelZLine(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 DelKLine(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 DelELine(const char* hostmask, bool simulate = false);
/** Check if a nickname matches a QLine
* @return nick The nick to check against
* @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(User* user);
- /** Check if a IP matches a ZLine
- * @param ipaddr The IP to check against
+ /** Check if a user's IP matches a ZLine
+ * @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
*/
- ZLine* matches_zline(const char* ipaddr);
+ ZLine* matches_zline(User *user);
/** 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(User* user);
/** 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(User* user);
- /** Expire any pending non-permenant lines
+ /** Expire any lines that should be expired.
*/
void expire_lines();
- /** 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 any new lines that are pending to be applied
*/
- void apply_lines(const int What);
+ void ApplyLines();
/** Handle /STATS K
* @param user The username making the query
* @param results The string_list to receive the results
*/
- void stats_k(userrec* user, string_list &results);
+ void stats_k(User* user, string_list &results);
/** Handle /STATS G
* @param user The username making the query
* @param results The string_list to receive the results
*/
- void stats_g(userrec* user, string_list &results);
+ void stats_g(User* user, string_list &results);
/** Handle /STATS Q
* @param user The username making the query
* @param results The string_list to receive the results
*/
- void stats_q(userrec* user, string_list &results);
+ void stats_q(User* user, string_list &results);
/** Handle /STATS Z
* @param user The username making the query
* @param results The string_list to receive the results
*/
- void stats_z(userrec* user, string_list &results);
+ void stats_z(User* user, string_list &results);
/** Handle /STATS E
* @param user The username making the query
* @param results The string_list to receive the results
*/
- void stats_e(userrec* user, string_list &results);
+ void stats_e(User* user, string_list &results);
/** Change creation time of a GLine
* @param host The hostname to change
};
#endif
+