-/* +------------------------------------+
- * | 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) 2008 Craig Edwards <craigedwards@brainbox.cc>
+ * Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
*
- * 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 __BANCACHE_H
-#define __BANCACHE_H
-#include <string>
+#pragma once
-class CoreExport BanCacheHit : public classbase
+/** Stores a cached ban entry.
+ * Each ban has one of these hashed in a hash_map to make for faster removal
+ * of already-banned users in the case that they try to reconnect. As no wildcard
+ * matching is done on these IPs, the speed of the system is improved. These cache
+ * entries expire every few hours, which is a reasonable expiry for any reasonable
+ * sized network.
+ */
+class CoreExport BanCacheHit
{
- private:
- InspIRCd *ServerInstance;
public:
+ /** Type of cached ban
+ */
std::string Type;
+ /** Reason, shown as quit message
+ */
std::string Reason;
- std::string IP;
+ /** Time that the ban expires at
+ */
time_t Expiry;
- BanCacheHit(InspIRCd *Instance, const std::string &ip, const std::string &type, const std::string &reason)
- {
- ServerInstance = Instance;
- this->Type = type;
- this->Reason = reason;
- this->IP = ip;
- this->Expiry = time(NULL) + 60; // XXX changeme
- }
+ BanCacheHit(const std::string& type, const std::string& reason, time_t seconds);
- // overridden to allow custom time
- BanCacheHit(InspIRCd *Instance, const std::string &ip, const std::string &type, const std::string &reason, time_t seconds)
- {
- ServerInstance = Instance;
- this->Type = type;
- this->Reason = reason;
- this->IP = ip;
- this->Expiry = time(NULL) + seconds;
- }
+ bool IsPositive() const { return (!Reason.empty()); }
};
-// must be defined after class BanCacheHit.
-#ifndef WIN32
-typedef nspace::hash_map<std::string, BanCacheHit *, nspace::hash<std::string> > BanCacheHash;
-#else
-typedef nspace::hash_map<std::string, BanCacheHit*, nspace::hash_compare<string, less<string> > > BanCacheHash;
-#endif
-
-class CoreExport BanCacheManager : public classbase
+/** A manager for ban cache, which allocates and deallocates and checks cached bans.
+ */
+class CoreExport BanCacheManager
{
- private:
- BanCacheHash *BanHash;
- InspIRCd *ServerInstance;
+ /** A container of ban cache items.
+ */
+ typedef TR1NS::unordered_map<std::string, BanCacheHit*, TR1NS::hash<std::string> > BanCacheHash;
+
+ BanCacheHash BanHash;
+ bool RemoveIfExpired(BanCacheHash::iterator& it);
+
public:
/** Creates and adds a Ban Cache item.
* @param ip The IP the item is for.
* @param type The type of ban cache item. std::string. .empty() means it's a negative match (user is allowed freely).
* @param reason The reason for the ban. Left .empty() if it's a negative match.
+ * @param seconds Number of seconds before nuking the bancache entry, the default is a day. This might seem long, but entries will be removed as G-lines/etc expire.
*/
- BanCacheHit *AddHit(const std::string &ip, const std::string &type, const std::string &reason);
-
- // Overridden to allow an optional number of seconds before expiry
- BanCacheHit *AddHit(const std::string &ip, const std::string &type, const std::string &reason, time_t seconds);
+ BanCacheHit *AddHit(const std::string &ip, const std::string &type, const std::string &reason, time_t seconds = 0);
BanCacheHit *GetHit(const std::string &ip);
- bool RemoveHit(BanCacheHit *b);
/** Removes all entries of a given type, either positive or negative. Returns the number of hits removed.
* @param type The type of bancache entries to remove (e.g. 'G')
* @param positive Remove either positive (true) or negative (false) hits.
*/
- unsigned int RemoveEntries(const std::string &type, bool positive);
-
- BanCacheManager(InspIRCd *Instance)
- {
- this->ServerInstance = Instance;
- this->BanHash = new BanCacheHash();
- }
+ void RemoveEntries(const std::string& type, bool positive);
- void RehashCache();
+ ~BanCacheManager();
};
-
-#endif