mirror of
https://github.com/inspircd/inspircd.git
synced 2025-03-09 18:49:03 -04:00
83 lines
3.1 KiB
C++
83 lines
3.1 KiB
C++
/*
|
|
* InspIRCd -- Internet Relay Chat Daemon
|
|
*
|
|
* Copyright (C) 2019 Matt Schatz <genius3000@g3k.solutions>
|
|
* Copyright (C) 2013, 2021-2022 Sadie Powell <sadie@witchery.services>
|
|
* Copyright (C) 2012-2014 Attila Molnar <attilamolnar@hush.com>
|
|
* Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
|
|
* Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
|
|
* Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
|
|
* Copyright (C) 2007-2008 Craig Edwards <brain@inspircd.org>
|
|
*
|
|
* 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/>.
|
|
*/
|
|
|
|
|
|
#pragma once
|
|
|
|
/** 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 final
|
|
{
|
|
public:
|
|
/** Type of cached ban
|
|
*/
|
|
std::string Type;
|
|
/** Reason, shown as quit message
|
|
*/
|
|
std::string Reason;
|
|
/** Time that the ban expires at
|
|
*/
|
|
time_t Expiry;
|
|
|
|
BanCacheHit(const std::string& type, const std::string& reason, time_t seconds);
|
|
|
|
bool IsPositive() const { return (!Reason.empty()); }
|
|
};
|
|
|
|
/** A manager for ban cache, which allocates and deallocates and checks cached bans.
|
|
*/
|
|
class CoreExport BanCacheManager final
|
|
{
|
|
/** A container of ban cache items.
|
|
*/
|
|
typedef std::unordered_map<std::string, BanCacheHit*> 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, time_t seconds = 0);
|
|
BanCacheHit* GetHit(const std::string& ip);
|
|
|
|
/** 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.
|
|
*/
|
|
void RemoveEntries(const std::string& type, bool positive);
|
|
|
|
~BanCacheManager();
|
|
};
|