Merge pull request #16 from Adam-/insp20

[user/henk/code/inspircd.git] / include / bancache.h

diff --git a/include/bancache.h b/include/bancache.h
index 3aee3cffdaa5096f3d0918860f0a689497955db9..917d2567a4b50ccd2aa1c515002e204da235c5fd 100644 (file)
--- a/include/bancache.h
+++ b/include/bancache.h
@@ -2,8 +2,8 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *  InspIRCd: (C) 2002-2010 InspIRCd Development Team
+ * See: http://wiki.inspircd.org/Credits
  *
  * This program is free but copyrighted software; see
  *         the file COPYING for details.
@@ -14,48 +14,62 @@
 #ifndef __BANCACHE_H
 #define __BANCACHE_H
 
-class CoreExport BanCacheHit : public classbase
+/** 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
 {
- private:
-       InspIRCd *ServerInstance;
  public:
+       /** Type of cached ban
+        */
        std::string Type;
+       /** Reason, shown as quit message
+        */
        std::string Reason;
+       /** IP to match against, no wildcards here (of course)
+        */
        std::string IP;
+       /** Time that the ban expires at
+        */
        time_t Expiry;
 
-       BanCacheHit(InspIRCd *Instance, const std::string &ip, const std::string &type, const std::string &reason)
+       BanCacheHit(const std::string &ip, const std::string &type, const std::string &reason)
        {
-               ServerInstance = Instance;
                this->Type = type;
                this->Reason = reason;
                this->IP = ip;
-               this->Expiry = time(NULL) + 86400; // a day. this might seem long, but entries will be removed as glines/etc expire.
+               this->Expiry = ServerInstance->Time() + 86400; // a day. this might seem long, but entries will be removed as glines/etc expire.
        }
 
        // overridden to allow custom time
-       BanCacheHit(InspIRCd *Instance, const std::string &ip, const std::string &type, const std::string &reason, time_t seconds)
+       BanCacheHit(const std::string &ip, const std::string &type, const std::string &reason, time_t seconds)
        {
-               ServerInstance = Instance;
                this->Type = type;
                this->Reason = reason;
                this->IP = ip;
-               this->Expiry = time(NULL) + seconds;
+               this->Expiry = ServerInstance->Time() + seconds;
        }
 };
 
-// must be defined after class BanCacheHit.
-#ifndef WIN32
-typedef nspace::hash_map<std::string, BanCacheHit *, nspace::hash<std::string> > BanCacheHash;
+/* A container of ban cache items.
+ * must be defined after class BanCacheHit.
+ */
+#if defined(WINDOWS) && !defined(HASHMAP_DEPRECATED)
+typedef nspace::hash_map<std::string, BanCacheHit*, nspace::hash_compare<std::string, std::less<std::string> > > BanCacheHash;
 #else
-typedef nspace::hash_map<std::string, BanCacheHit*, nspace::hash_compare<string, less<string> > > BanCacheHash;
+typedef nspace::hash_map<std::string, BanCacheHit*, nspace::hash<std::string> > BanCacheHash;
 #endif
 
-class CoreExport BanCacheManager : public classbase
+/** A manager for ban cache, which allocates and deallocates and checks cached bans.
+ */
+class CoreExport BanCacheManager
 {
  private:
-       BanCacheHash *BanHash;
-       InspIRCd *ServerInstance;
+       BanCacheHash* BanHash;
  public:
 
        /** Creates and adds a Ban Cache item.
@@ -76,12 +90,11 @@ class CoreExport BanCacheManager : public classbase
         */
        unsigned int RemoveEntries(const std::string &type, bool positive);
 
-       BanCacheManager(InspIRCd *Instance)
+       BanCacheManager()
        {
-               this->ServerInstance = Instance;
                this->BanHash = new BanCacheHash();
        }
-
+       ~BanCacheManager();
        void RehashCache();
 };