2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2019 Matt Schatz <genius3000@g3k.solutions>
5 * Copyright (C) 2013 Sadie Powell <sadie@witchery.services>
6 * Copyright (C) 2012-2014 Attila Molnar <attilamolnar@hush.com>
7 * Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
8 * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
9 * Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
10 * Copyright (C) 2007-2008 Craig Edwards <brain@inspircd.org>
12 * This file is part of InspIRCd. InspIRCd is free software: you can
13 * redistribute it and/or modify it under the terms of the GNU General Public
14 * License as published by the Free Software Foundation, version 2.
16 * This program is distributed in the hope that it will be useful, but WITHOUT
17 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
18 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
28 /** Stores a cached ban entry.
29 * Each ban has one of these hashed in a hash_map to make for faster removal
30 * of already-banned users in the case that they try to reconnect. As no wildcard
31 * matching is done on these IPs, the speed of the system is improved. These cache
32 * entries expire every few hours, which is a reasonable expiry for any reasonable
35 class CoreExport BanCacheHit
38 /** Type of cached ban
41 /** Reason, shown as quit message
44 /** Time that the ban expires at
48 BanCacheHit(const std::string& type, const std::string& reason, time_t seconds);
50 bool IsPositive() const { return (!Reason.empty()); }
53 /** A manager for ban cache, which allocates and deallocates and checks cached bans.
55 class CoreExport BanCacheManager
57 /** A container of ban cache items.
59 typedef TR1NS::unordered_map<std::string, BanCacheHit*, TR1NS::hash<std::string> > BanCacheHash;
62 bool RemoveIfExpired(BanCacheHash::iterator& it);
66 /** Creates and adds a Ban Cache item.
67 * @param ip The IP the item is for.
68 * @param type The type of ban cache item. std::string. .empty() means it's a negative match (user is allowed freely).
69 * @param reason The reason for the ban. Left .empty() if it's a negative match.
70 * @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.
72 BanCacheHit *AddHit(const std::string &ip, const std::string &type, const std::string &reason, time_t seconds = 0);
73 BanCacheHit *GetHit(const std::string &ip);
75 /** Removes all entries of a given type, either positive or negative. Returns the number of hits removed.
76 * @param type The type of bancache entries to remove (e.g. 'G')
77 * @param positive Remove either positive (true) or negative (false) hits.
79 void RemoveEntries(const std::string& type, bool positive);