Start documenting stuff for 3rd party developers. Comments only, won't affect feature...

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

diff --git a/include/bancache.h b/include/bancache.h
index d69306d7acd8c48d8b4a48c55a5991bf6121602f..b6e037f79dde8e955c3f5e99cceba6b2c75277ae 100644 (file)
--- a/include/bancache.h
+++ b/include/bancache.h
@@ -14,16 +14,29 @@
 #ifndef __BANCACHE_H
 #define __BANCACHE_H
 
-#include <string>
-
+/** 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 : public classbase
 {
  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)
@@ -32,7 +45,7 @@ class CoreExport BanCacheHit : public classbase
                this->Type = type;
                this->Reason = reason;
                this->IP = ip;
-               this->Expiry = time(NULL) + 60; // XXX changeme
+               this->Expiry = time(NULL) + 86400; // a day. this might seem long, but entries will be removed as glines/etc expire.
        }
 
        // overridden to allow custom time
@@ -46,18 +59,22 @@ class CoreExport BanCacheHit : public classbase
        }
 };
 
-// must be defined after class BanCacheHit.
+/* A container of ban cache items.
+ * must be defined after class BanCacheHit.
+ */
 #ifndef WIN32
-typedef nspace::hash_map<std::string, BanCacheHit *, nspace::hash<std::string> > BanCacheHash;
+typedef nspace::hash_map<std::string, BanCacheHit*, nspace::hash<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_compare<std::string, std::less<std::string> > > BanCacheHash;
 #endif
 
+/** A manager for ban cache, which allocates and deallocates and checks cached bans.
+ */
 class CoreExport BanCacheManager : public classbase
 {
  private:
-       BanCacheHash *BanHash;
-       InspIRCd *ServerInstance;
+       BanCacheHash* BanHash;
+       InspIRCd* ServerInstance;
  public:
 
        /** Creates and adds a Ban Cache item.
@@ -66,6 +83,9 @@ class CoreExport BanCacheManager : public classbase
         * @param reason The reason for the ban. Left .empty() if it's a negative match.
         */
        BanCacheHit *AddHit(const std::string &ip, const std::string &type, const std::string &reason);
+
+       // Overridden to allow an optional number of seconds before expiry
+       BanCacheHit *AddHit(const std::string &ip, const std::string &type, const std::string &reason, time_t seconds);
        BanCacheHit *GetHit(const std::string &ip);
        bool RemoveHit(BanCacheHit *b);