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/>.
24 /** Stores a cached ban entry.
25 * Each ban has one of these hashed in a hash_map to make for faster removal
26 * of already-banned users in the case that they try to reconnect. As no wildcard
27 * matching is done on these IPs, the speed of the system is improved. These cache
28 * entries expire every few hours, which is a reasonable expiry for any reasonable
31 class CoreExport BanCacheHit
34 /** Type of cached ban
37 /** Reason, shown as quit message
40 /** IP to match against, no wildcards here (of course)
43 /** Time that the ban expires at
47 BanCacheHit(const std::string &ip, const std::string &type, const std::string &reason)
50 this->Reason = reason;
52 this->Expiry = ServerInstance->Time() + 86400; // a day. this might seem long, but entries will be removed as glines/etc expire.
55 // overridden to allow custom time
56 BanCacheHit(const std::string &ip, const std::string &type, const std::string &reason, time_t seconds)
59 this->Reason = reason;
61 this->Expiry = ServerInstance->Time() + seconds;
65 /* A container of ban cache items.
66 * must be defined after class BanCacheHit.
68 typedef nspace::hash_map<std::string, BanCacheHit*, nspace::hash<std::string> > BanCacheHash;
70 /** A manager for ban cache, which allocates and deallocates and checks cached bans.
72 class CoreExport BanCacheManager
75 BanCacheHash* BanHash;
78 /** Creates and adds a Ban Cache item.
79 * @param ip The IP the item is for.
80 * @param type The type of ban cache item. std::string. .empty() means it's a negative match (user is allowed freely).
81 * @param reason The reason for the ban. Left .empty() if it's a negative match.
83 BanCacheHit *AddHit(const std::string &ip, const std::string &type, const std::string &reason);
85 // Overridden to allow an optional number of seconds before expiry
86 BanCacheHit *AddHit(const std::string &ip, const std::string &type, const std::string &reason, time_t seconds);
87 BanCacheHit *GetHit(const std::string &ip);
88 bool RemoveHit(BanCacheHit *b);
90 /** Removes all entries of a given type, either positive or negative. Returns the number of hits removed.
91 * @param type The type of bancache entries to remove (e.g. 'G')
92 * @param positive Remove either positive (true) or negative (false) hits.
94 unsigned int RemoveEntries(const std::string &type, bool positive);
98 this->BanHash = new BanCacheHash();