X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fxline.h;h=fe564358f630c1fc2fbfb1e749e9d81fc7b38c8b;hb=9a0046a709e1fe9236d54838e2de530813972400;hp=7c102c8825c7df6469fb22d3e52b61ab22e880ed;hpb=876b1ae4e280e99f24d37da4b819f108ddb3f1e3;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/xline.h b/include/xline.h index 7c102c882..fe564358f 100644 --- a/include/xline.h +++ b/include/xline.h @@ -1,10 +1,14 @@ /* * InspIRCd -- Internet Relay Chat Daemon * + * Copyright (C) 2019 Matt Schatz + * Copyright (C) 2013, 2016 Attila Molnar + * Copyright (C) 2012-2013, 2017-2018 Sadie Powell + * Copyright (C) 2012, 2018-2019 Robby * Copyright (C) 2009 Daniel De Graaf - * Copyright (C) 2004-2007 Craig Edwards - * Copyright (C) 2007 Robin Burchell + * Copyright (C) 2007-2008 Robin Burchell * Copyright (C) 2007 Dennis Friis + * Copyright (C) 2006-2008, 2010 Craig Edwards * * 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 @@ -22,7 +26,7 @@ #pragma once -/** XLine is the base class for ban lines such as G lines and K lines. +/** 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 * handled as expected by any protocol modules (e.g. m_spanningtree will * propogate them using AddLine). The process of translating a type+pattern @@ -49,7 +53,7 @@ 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(time_t s_time, long d, std::string src, std::string re, const std::string &t) + XLine(time_t s_time, unsigned long d, const std::string& src, const std::string& re, const std::string& t) : set_time(s_time) , duration(d) , source(src) @@ -67,7 +71,7 @@ class CoreExport XLine : public classbase } /** Change creation time of an xline. Updates expiry - * to be after the creation time + * to be after the creation time. */ virtual void SetCreateTime(time_t created) { @@ -102,7 +106,7 @@ class CoreExport XLine : public classbase virtual void Unset() { } /** Called when the expiry message is to be displayed for the - * line. Usually a line in the form 'expiring Xline blah, set by...' + * line. Usually a line in the form 'expiring X-line blah, set by...' * see the DisplayExpiry methods of GLine, ELine etc. */ virtual void DisplayExpiry(); @@ -111,7 +115,7 @@ class CoreExport XLine : public classbase * 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 separately but will still return ident\@host * for its Displayable() method). */ virtual const std::string& Displayable() = 0; @@ -126,7 +130,7 @@ class CoreExport XLine : public classbase /** The duration of the ban, or 0 if permenant */ - long duration; + unsigned long duration; /** Source of the ban. This can be a servername or an oper nickname */ @@ -157,7 +161,7 @@ class CoreExport KLine : public XLine { public: - /** Create a K-Line. + /** Create a K-line. * @param s_time The set time * @param d The duration of the xline * @param src The sender of the xline @@ -165,7 +169,7 @@ class CoreExport KLine : public XLine * @param ident Ident to match * @param host Host to match */ - KLine(time_t s_time, long d, std::string src, std::string re, std::string ident, std::string host) + KLine(time_t s_time, unsigned long d, const std::string& src, const std::string& re, const std::string& ident, const std::string& host) : XLine(s_time, d, src, re, "K"), identmask(ident), hostmask(host) { matchtext = this->identmask; @@ -203,7 +207,7 @@ class CoreExport KLine : public XLine class CoreExport GLine : public XLine { public: - /** Create a G-Line. + /** Create a G-line. * @param s_time The set time * @param d The duration of the xline * @param src The sender of the xline @@ -211,7 +215,7 @@ class CoreExport GLine : public XLine * @param ident Ident to match * @param host Host to match */ - GLine(time_t s_time, long d, std::string src, std::string re, std::string ident, std::string host) + GLine(time_t s_time, unsigned long d, const std::string& src, const std::string& re, const std::string& ident, const std::string& host) : XLine(s_time, d, src, re, "G"), identmask(ident), hostmask(host) { matchtext = this->identmask; @@ -247,7 +251,7 @@ class CoreExport GLine : public XLine class CoreExport ELine : public XLine { public: - /** Create an E-Line. + /** Create an E-line. * @param s_time The set time * @param d The duration of the xline * @param src The sender of the xline @@ -255,7 +259,7 @@ class CoreExport ELine : public XLine * @param ident Ident to match * @param host Host to match */ - ELine(time_t s_time, long d, std::string src, std::string re, std::string ident, std::string host) + ELine(time_t s_time, unsigned long d, const std::string& src, const std::string& re, const std::string& ident, const std::string& host) : XLine(s_time, d, src, re, "E"), identmask(ident), hostmask(host) { matchtext = this->identmask; @@ -291,14 +295,14 @@ class CoreExport ELine : public XLine class CoreExport ZLine : public XLine { public: - /** Create a Z-Line. + /** 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, std::string src, std::string re, std::string ip) + ZLine(time_t s_time, unsigned long d, const std::string& src, const std::string& re, const std::string& ip) : XLine(s_time, d, src, re, "Z"), ipaddr(ip) { } @@ -327,14 +331,14 @@ class CoreExport ZLine : public XLine class CoreExport QLine : public XLine { public: - /** Create a G-Line. + /** Create a Q-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, std::string src, std::string re, std::string nickname) + QLine(time_t s_time, unsigned long d, const std::string& src, const std::string& re, const std::string& nickname) : XLine(s_time, d, src, re, "Q"), nick(nickname) { } @@ -390,7 +394,7 @@ 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, std::string source, std::string reason, std::string xline_specific_mask) = 0; + virtual XLine* Generate(time_t set_time, unsigned long duration, const std::string& source, const std::string& reason, const std::string& xline_specific_mask) = 0; virtual bool AutoApplyToUserList(XLine* x) { return true; } @@ -399,7 +403,7 @@ class CoreExport XLineFactory virtual ~XLineFactory() { } }; -/** XLineManager is a class used to manage glines, klines, elines, zlines and qlines, +/** XLineManager is a class used to manage G-lines, K-lines, E-lines, Z-lines and Q-lines, * or any other line created by a module. It also manages XLineFactory classes which * can generate a specialized XLine for use by another module. */ @@ -436,7 +440,7 @@ class CoreExport XLineManager */ IdentHostPair IdentSplit(const std::string &ident_and_host); - /** Checks what users match e:lines and sets their ban exempt flag accordingly. + /** Checks what users match E-lines and sets their ban exempt flag accordingly. */ void CheckELines(); @@ -467,16 +471,17 @@ class CoreExport XLineManager /** Delete an XLine * @param hostmask The xline-specific string identifying the line, e.g. "*@foo" * @param type The type of xline + * @param reason The xline reason, if it is being removed successfully * @param user The user removing the line or NULL if its the local server * @param simulate If this is true, don't actually remove the line, just return * @return True if the line was deleted successfully */ - bool DelLine(const char* hostmask, const std::string &type, User* user, bool simulate = false); + bool DelLine(const char* hostmask, const std::string& type, std::string& reason, User* user, bool simulate = false); /** Registers an xline factory. * An xline factory is a class which when given a particular xline type, * 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 + * pass the XLineFactory that handles G-lines 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 * server protocol module like m_spanningtree, when you receive xlines from other @@ -514,8 +519,9 @@ class CoreExport XLineManager /** Expire a line given two iterators which identify it in the main map. * @param container Iterator to the first level of entries the map * @param item Iterator to the second level of entries in the map + * @param silent If true, doesn't send an expiry SNOTICE. */ - void ExpireLine(ContainerIter container, LookupIter item); + void ExpireLine(ContainerIter container, LookupIter item, bool silent = false); /** Apply any new lines that are pending to be applied. * This will only apply lines in the pending_lines list, to save on @@ -523,15 +529,16 @@ class CoreExport XLineManager */ void ApplyLines(); - /** 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 stats Stats context + /** DEPRECATED: use the `bool InvokeStats(const std::string&, Stats::Context&)` overload instead. */ + DEPRECATED_METHOD(void InvokeStats(const std::string& type, unsigned int numeric, Stats::Context& stats)); + + /** Generates a /STATS response for the given X-line type. + * @param type The type of X-line to look up. + * @param context The stats context to respond with. + * @return True if a response was sent; otherwise, false. */ - void InvokeStats(const std::string& type, unsigned int numeric, Stats::Context& stats); + bool InvokeStats(const std::string& type, Stats::Context& context); - /** Clears any XLines which were added by the server configuration. */ - void ClearConfigLines(); + /** Expire X-lines which were added by the server configuration and have been removed. */ + void ExpireRemovedConfigLines(const std::string& type, const insp::flat_set& configlines); };