2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2008 Craig Edwards <craigedwards@brainbox.cc>
5 * Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
7 * This file is part of InspIRCd. InspIRCd is free software: you can
8 * redistribute it and/or modify it under the terms of the GNU General Public
9 * License as published by the Free Software Foundation, version 2.
11 * This program is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
13 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
23 /** Stores a cached ban entry.
24 * Each ban has one of these hashed in a hash_map to make for faster removal
25 * of already-banned users in the case that they try to reconnect. As no wildcard
26 * matching is done on these IPs, the speed of the system is improved. These cache
27 * entries expire every few hours, which is a reasonable expiry for any reasonable
30 class CoreExport BanCacheHit
33 /** Type of cached ban
36 /** Reason, shown as quit message
39 /** Time that the ban expires at
43 BanCacheHit(const std::string& type, const std::string& reason, time_t seconds);
45 bool IsPositive() const { return (!Reason.empty()); }
48 /** A manager for ban cache, which allocates and deallocates and checks cached bans.
50 class CoreExport BanCacheManager
52 /** A container of ban cache items.
54 typedef TR1NS::unordered_map<std::string, BanCacheHit*, TR1NS::hash<std::string> > BanCacheHash;
57 bool RemoveIfExpired(BanCacheHash::iterator& it);
61 /** Creates and adds a Ban Cache item.
62 * @param ip The IP the item is for.
63 * @param type The type of ban cache item. std::string. .empty() means it's a negative match (user is allowed freely).
64 * @param reason The reason for the ban. Left .empty() if it's a negative match.
65 * @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.
67 BanCacheHit *AddHit(const std::string &ip, const std::string &type, const std::string &reason, time_t seconds = 0);
68 BanCacheHit *GetHit(const std::string &ip);
70 /** Removes all entries of a given type, either positive or negative. Returns the number of hits removed.
71 * @param type The type of bancache entries to remove (e.g. 'G')
72 * @param positive Remove either positive (true) or negative (false) hits.
74 void RemoveEntries(const std::string& type, bool positive);