include/bancache.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2008 Craig Edwards <craigedwards@brainbox.cc>
   5  *   Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
   6  *
   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.
  10  *
  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
  14  * details.
  15  *
  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/>.
  18  */
  19
  20
  21 #pragma once
  22
  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
  28  * sized network.
  29  */
  30 class CoreExport BanCacheHit
  31 {
  32  public:
  33         /** Type of cached ban
  34          */
  35         std::string Type;
  36         /** Reason, shown as quit message
  37          */
  38         std::string Reason;
  39         /** Time that the ban expires at
  40          */
  41         time_t Expiry;
  42
  43         BanCacheHit(const std::string& type, const std::string& reason, time_t seconds);
  44
  45         bool IsPositive() const { return (!Reason.empty()); }
  46 };
  47
  48 /** A manager for ban cache, which allocates and deallocates and checks cached bans.
  49  */
  50 class CoreExport BanCacheManager
  51 {
  52         /** A container of ban cache items.
  53          */
  54         typedef TR1NS::unordered_map<std::string, BanCacheHit*, TR1NS::hash<std::string> > BanCacheHash;
  55
  56         BanCacheHash BanHash;
  57         bool RemoveIfExpired(BanCacheHash::iterator& it);
  58
  59  public:
  60
  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.
  66          */
  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);
  69
  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.
  73          */
  74         void RemoveEntries(const std::string& type, bool positive);
  75
  76         ~BanCacheManager();
  77 };