1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2007 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
17 // include the common header files
25 const int APPLY_GLINES = 1;
26 const int APPLY_KLINES = 2;
27 const int APPLY_QLINES = 4;
28 const int APPLY_ZLINES = 8;
29 const int APPLY_PERM_ONLY = 16;
30 const int APPLY_ALL = APPLY_GLINES | APPLY_KLINES | APPLY_QLINES | APPLY_ZLINES;
32 /** XLine is the base class for ban lines such as G lines and K lines.
34 class CoreExport XLine : public classbase
38 InspIRCd* ServerInstance;
39 void DefaultApply(User* u, char line);
44 * @param s_time The set time
45 * @param d The duration of the xline
46 * @param src The sender of the xline
47 * @param re The reason of the xline
49 XLine(InspIRCd* Instance, time_t s_time, long d, const char* src, const char* re, const char t)
50 : ServerInstance(Instance), set_time(s_time), duration(d), type(t)
54 expiry = set_time + duration;
65 /** Returns true whether or not the given user is covered by this line.
67 virtual bool Matches(User *u) = 0;
69 /** Returns true wether or not the given string exactly matches the gline
70 * (no wildcard use in this method) -- used for removal of a line
72 virtual bool MatchesLiteral(const std::string &str) = 0;
74 virtual bool Matches(const std::string &str) = 0;
76 virtual void Apply(User* u);
78 virtual void Unset() { }
80 virtual void DisplayExpiry() = 0;
82 virtual const char* Displayable() = 0;
84 virtual void OnAdd() { }
86 /** The time the line was added.
90 /** The duration of the ban, or 0 if permenant
94 /** Source of the ban. This can be a servername or an oper nickname
98 /** Reason for the ban
106 /** Q, K, etc. Don't change this. Constructors set it.
113 class CoreExport KLine : public XLine
117 * @param s_time The set time
118 * @param d The duration of the xline
119 * @param src The sender of the xline
120 * @param re The reason of the xline
121 * @param ident Ident to match
122 * @param host Host to match
124 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')
126 identmask = strdup(ident);
127 hostmask = strdup(host);
128 matchtext = this->identmask;
129 matchtext.append("@").append(this->hostmask);
140 virtual bool Matches(User *u);
142 virtual bool Matches(const std::string &str);
144 virtual bool MatchesLiteral(const std::string &str);
146 virtual void Apply(User* u);
148 virtual void DisplayExpiry();
150 virtual const char* Displayable();
159 std::string matchtext;
164 class CoreExport GLine : public XLine
168 * @param s_time The set time
169 * @param d The duration of the xline
170 * @param src The sender of the xline
171 * @param re The reason of the xline
172 * @param ident Ident to match
173 * @param host Host to match
175 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')
177 identmask = strdup(ident);
178 hostmask = strdup(host);
179 matchtext = this->identmask;
180 matchtext.append("@").append(this->hostmask);
191 virtual bool Matches(User *u);
193 virtual bool Matches(const std::string &str);
195 virtual bool MatchesLiteral(const std::string &str);
197 virtual void Apply(User* u);
199 virtual void DisplayExpiry();
201 virtual const char* Displayable();
210 std::string matchtext;
215 class CoreExport ELine : public XLine
218 /** Create an E-Line.
219 * @param s_time The set time
220 * @param d The duration of the xline
221 * @param src The sender of the xline
222 * @param re The reason of the xline
223 * @param ident Ident to match
224 * @param host Host to match
226 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')
228 identmask = strdup(ident);
229 hostmask = strdup(host);
230 matchtext = this->identmask;
231 matchtext.append("@").append(this->hostmask);
240 virtual bool Matches(User *u);
242 virtual bool Matches(const std::string &str);
244 virtual bool MatchesLiteral(const std::string &str);
246 virtual void Unset();
248 virtual void DisplayExpiry();
250 virtual void OnAdd();
252 virtual const char* Displayable();
261 std::string matchtext;
266 class CoreExport ZLine : public XLine
270 * @param s_time The set time
271 * @param d The duration of the xline
272 * @param src The sender of the xline
273 * @param re The reason of the xline
274 * @param ip IP to match
276 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')
288 virtual bool Matches(User *u);
290 virtual bool Matches(const std::string &str);
292 virtual bool MatchesLiteral(const std::string &str);
294 virtual void Apply(User* u);
296 virtual void DisplayExpiry();
298 virtual const char* Displayable();
307 class CoreExport QLine : public XLine
311 * @param s_time The set time
312 * @param d The duration of the xline
313 * @param src The sender of the xline
314 * @param re The reason of the xline
315 * @param nickname Nickname to match
317 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')
319 nick = strdup(nickname);
329 virtual bool Matches(User *u);
331 virtual bool Matches(const std::string &str);
333 virtual bool MatchesLiteral(const std::string &str);
335 virtual void Apply(User* u);
337 virtual void DisplayExpiry();
339 virtual const char* Displayable();
346 /* Required forward declarations
351 /** Contains an ident and host split into two strings
353 typedef std::pair<std::string, std::string> IdentHostPair;
355 /** XLineManager is a class used to manage glines, klines, elines, zlines and qlines.
357 class CoreExport XLineManager
360 /** The owner/creator of this class
362 InspIRCd* ServerInstance;
364 /** This functor is used by the std::sort() function to keep all lines in order
366 static bool XSortComparison (const XLine *one, const XLine *two);
368 /** Used to hold XLines which have not yet been applied.
370 std::vector<XLine *> pending_lines;
372 std::vector<XLine *> active_lines;
376 std::map<char, std::map<std::string, XLine *> > lookup_lines;
379 * @param Instance A pointer to the creator object
381 XLineManager(InspIRCd* Instance);
383 /** Split an ident and host into two seperate strings.
384 * This allows for faster matching.
386 IdentHostPair IdentSplit(const std::string &ident_and_host);
388 /** Checks what users match a given list of ELines and sets their ban exempt flag accordingly.
389 * @param ELines List of E:Lines to check.
391 void CheckELines(std::map<std::string, XLine *> &ELines);
394 * @param duration The duration of the line
395 * @param source The source of the line
396 * @param reason The reason for the line
397 * @param hostmask The hostmask
398 * @return True if the line was added successfully
400 bool AddLine(XLine* line);
403 * @param hostmask The host to remove
404 * @param type Type of line to remove
405 * @param simulate If this is true, don't actually remove the line, just return
406 * @return True if the line was deleted successfully
408 bool DelLine(const char* hostmask, char type, bool simulate = false);
410 /** Check if a nickname matches a QLine
411 * @return nick The nick to check against
412 * @return The reason for the line if there is a match, or NULL if there is no match
414 QLine* matches_qline(const char* nick);
416 /** Check if a hostname matches a GLine
417 * @param user The user to check against
418 * @return The reason for the line if there is a match, or NULL if there is no match
420 GLine* matches_gline(User* user);
422 /** Check if a user's IP matches a ZLine
423 * @param user The user to check against
424 * @return The reason for the line if there is a match, or NULL if there is no match
426 ZLine* matches_zline(User *user);
428 /** Check if a hostname matches a KLine
429 * @param user The user to check against
430 * @return The reason for the line if there is a match, or NULL if there is no match
432 KLine* matches_kline(User* user);
434 /** Check if a hostname matches a ELine
435 * @param user The user to check against
436 * @return The reason for the line if there is a match, or NULL if there is no match
438 ELine* matches_exception(User* user);
440 /** Expire any lines that should be expired.
444 /** Apply any new lines that are pending to be applied
449 * @param user The username making the query
450 * @param results The string_list to receive the results
452 void stats_k(User* user, string_list &results);
455 * @param user The username making the query
456 * @param results The string_list to receive the results
458 void stats_g(User* user, string_list &results);
461 * @param user The username making the query
462 * @param results The string_list to receive the results
464 void stats_q(User* user, string_list &results);
467 * @param user The username making the query
468 * @param results The string_list to receive the results
470 void stats_z(User* user, string_list &results);
473 * @param user The username making the query
474 * @param results The string_list to receive the results
476 void stats_e(User* user, string_list &results);
478 /** Change creation time of a GLine
479 * @param host The hostname to change
480 * @param create_Time The new creation time
482 void gline_set_creation_time(const char* host, time_t create_time);
484 /** Change creation time of a QLine
485 * @param nick The nickmask to change
486 * @param create_Time The new creation time
488 void qline_set_creation_time(const char* nick, time_t create_time);
490 /** Change creation time of a ZLine
491 * @param ip The ipmask to change
492 * @param create_Time The new creation time
494 void zline_set_creation_time(const char* ip, time_t create_time);
496 /** Change creation time of a ELine
497 * @param host The hostname to change
498 * @param create_Time The new creation time
500 void eline_set_creation_time(const char* host, time_t create_time);