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 #ifndef BANCACHE_H
  22 #define BANCACHE_H
  23
  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
  29  * sized network.
  30  */
  31 class CoreExport BanCacheHit
  32 {
  33  public:
  34         /** Type of cached ban
  35          */
  36         std::string Type;
  37         /** Reason, shown as quit message
  38          */
  39         std::string Reason;
  40         /** Time that the ban expires at
  41          */
  42         time_t Expiry;
  43
  44         BanCacheHit(const std::string &type, const std::string &reason, time_t seconds)
  45                 : Type(type), Reason(reason), Expiry(ServerInstance->Time() + seconds)
  46         {
  47         }
  48
  49         bool IsPositive() const { return (!Reason.empty()); }
  50 };
  51
  52 /* A container of ban cache items.
  53  * must be defined after class BanCacheHit.
  54  */
  55 typedef std::tr1::unordered_map<std::string, BanCacheHit*, std::tr1::hash<std::string> > BanCacheHash;
  56
  57 /** A manager for ban cache, which allocates and deallocates and checks cached bans.
  58  */
  59 class CoreExport BanCacheManager
  60 {
  61  private:
  62         BanCacheHash* BanHash;
  63  public:
  64
  65         /** Creates and adds a Ban Cache item.
  66          * @param ip The IP the item is for.
  67          * @param type The type of ban cache item. std::string. .empty() means it's a negative match (user is allowed freely).
  68          * @param reason The reason for the ban. Left .empty() if it's a negative match.
  69          * @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 glines/etc expire.
  70          */
  71         BanCacheHit *AddHit(const std::string &ip, const std::string &type, const std::string &reason, time_t seconds = 0);
  72         BanCacheHit *GetHit(const std::string &ip);
  73
  74         /** Removes all entries of a given type, either positive or negative. Returns the number of hits removed.
  75          * @param type The type of bancache entries to remove (e.g. 'G')
  76          * @param positive Remove either positive (true) or negative (false) hits.
  77          */
  78         void RemoveEntries(const std::string& type, bool positive);
  79
  80         BanCacheManager()
  81         {
  82                 this->BanHash = new BanCacheHash();
  83         }
  84         ~BanCacheManager();
  85         void RehashCache();
  86 };
  87
  88 #endif