From: Amos Jeffries <squid3@treenet.co.nz>
Date: Tue, 8 Sep 2015 14:33:47 +0000 (-0700)
Subject: Rename UsernameCache to CredentialsCache
X-Git-Tag: SQUID_4_0_1~21^2~16
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=638cfbc471001dfc5135078779cefb9d00584615;p=thirdparty%2Fsquid.git

Rename UsernameCache to CredentialsCache
---

diff --git a/src/auth/UserNameCache.cc b/src/auth/CredentialsCache.cc
similarity index 75%
rename from src/auth/UserNameCache.cc
rename to src/auth/CredentialsCache.cc
index bedd64601a..fcc60ba76f 100644
--- a/src/auth/UserNameCache.cc
+++ b/src/auth/CredentialsCache.cc
@@ -10,7 +10,7 @@
 
 #include "squid.h"
 #include "acl/Gadgets.h"
-#include "auth/UserNameCache.h"
+#include "auth/CredentialsCache.h"
 #include "Debug.h"
 #include "event.h"
 #include "SquidConfig.h"
@@ -18,20 +18,21 @@
 
 namespace Auth {
 
-CBDATA_CLASS_INIT(UserNameCache);
+CBDATA_CLASS_INIT(CredentialsCache);
 
-UserNameCache::UserNameCache(const char *name) :
-    cachename(name), cacheCleanupEventName("User cache cleanup: ")
+CredentialsCache::CredentialsCache(const char *name) :
+    cachename(name),
+    cacheCleanupEventName("User cache cleanup: ")
 {
     debugs(29, 5, "initializing " << name << " username cache");
     cacheCleanupEventName.append(name);
-    eventAdd(cacheCleanupEventName.c_str(), &UserNameCache::Cleanup,
+    eventAdd(cacheCleanupEventName.c_str(), &CredentialsCache::Cleanup,
              this, ::Config.authenticateGCInterval, 1);
     RegisterRunner(this);
 }
 
 Auth::User::Pointer
-UserNameCache::lookup(const SBuf &userKey) const
+CredentialsCache::lookup(const SBuf &userKey) const
 {
     debugs(29, 6, "lookup for " << userKey);
     auto p = store_.find(userKey);
@@ -41,16 +42,16 @@ UserNameCache::lookup(const SBuf &userKey) const
 }
 
 void
-UserNameCache::Cleanup(void *data)
+CredentialsCache::Cleanup(void *data)
 {
     debugs(29, 5, "checkpoint");
     // data is this in disguise
-    UserNameCache *self = static_cast<UserNameCache *>(data);
+    CredentialsCache *self = static_cast<CredentialsCache *>(data);
     self->cleanup();
 }
 
 void
-UserNameCache::cleanup()
+CredentialsCache::cleanup()
 {
     // cache entries with expiretime <= expirationTime are to be evicted
     const time_t expirationTime =  current_time.tv_sec - ::Config.authenticateTTL;
@@ -66,21 +67,21 @@ UserNameCache::cleanup()
             ++i;
         }
     }
-    eventAdd(cacheCleanupEventName.c_str(), &UserNameCache::Cleanup,
+    eventAdd(cacheCleanupEventName.c_str(), &CredentialsCache::Cleanup,
              this, ::Config.authenticateGCInterval, 1);
 }
 
 void
-UserNameCache::insert(Auth::User::Pointer anAuth_user)
+CredentialsCache::insert(Auth::User::Pointer anAuth_user)
 {
     debugs(29, 6, "adding " << anAuth_user->userKey());
     store_[anAuth_user->userKey()] = anAuth_user;
 }
 
 // generates the list of cached usernames in a format that is convenient
-// to merge with equivalent lists obtained from other UserNameCaches.
+// to merge with equivalent lists obtained from other CredentialsCaches.
 std::vector<Auth::User::Pointer>
-UserNameCache::sortedUsersList() const
+CredentialsCache::sortedUsersList() const
 {
     std::vector<Auth::User::Pointer> rv(size(), nullptr);
     std::transform(store_.begin(), store_.end(), rv.begin(),
@@ -95,15 +96,15 @@ UserNameCache::sortedUsersList() const
 }
 
 void
-UserNameCache::endingShutdown()
+CredentialsCache::endingShutdown()
 {
     debugs(29, 5, "Shutting down username cache " << cachename);
-    eventDelete(&UserNameCache::Cleanup, this);
+    eventDelete(&CredentialsCache::Cleanup, this);
     reset();
 }
 
 void
-UserNameCache::syncConfig()
+CredentialsCache::syncConfig()
 {
     debugs(29, 5, "Reconfiguring username cache " << cachename);
     for (auto i : store_) {
diff --git a/src/auth/UserNameCache.h b/src/auth/CredentialsCache.h
similarity index 80%
rename from src/auth/UserNameCache.h
rename to src/auth/CredentialsCache.h
index b498ec3a68..a9797475e2 100644
--- a/src/auth/UserNameCache.h
+++ b/src/auth/CredentialsCache.h
@@ -6,8 +6,8 @@
  * Please see the COPYING and CONTRIBUTORS files for details.
  */
 
-#ifndef SQUID_SRC_AUTH_UERNAMECACHE_H
-#define SQUID_SRC_AUTH_UERNAMECACHE_H
+#ifndef SQUID_SRC_AUTH_CREDENTIALSCACHE_H
+#define SQUID_SRC_AUTH_CREDENTIALSCACHE_H
 
 #include "auth/User.h"
 #include "base/RunnersRegistry.h"
@@ -19,21 +19,21 @@
 namespace Auth {
 
 /// Cache of Auth::User credentials, keyed by Auth::User::userKey
-class UserNameCache : public RegisteredRunner
+class CredentialsCache : public RegisteredRunner
 {
 private:
-    CBDATA_CLASS(UserNameCache);
+    CBDATA_CLASS(CredentialsCache);
 
     /// key is User::userKey(), mapped value is User::Pointer
     typedef std::unordered_map<SBuf, Auth::User::Pointer> StoreType;
 
 public:
-    UserNameCache() = delete;
-    explicit UserNameCache(const char *name);
+    CredentialsCache() = delete;
+    explicit CredentialsCache(const char *name);
 
-    ~UserNameCache() = default;
-    UserNameCache(const UserNameCache& ) = delete;
-    UserNameCache& operator=(const UserNameCache&) = delete;
+    ~CredentialsCache() = default;
+    CredentialsCache(const CredentialsCache& ) = delete;
+    CredentialsCache& operator=(const CredentialsCache&) = delete;
 
     /// obtain pointer to user if present, or Pointer(nullptr) if not
     /// \returns a pointer to cached credentials, or nil if none found
@@ -80,5 +80,5 @@ private:
 
 } /* namespace Auth */
 
-#endif /* SQUID_SRC_AUTH_UERNAMECACHE_H */
+#endif /* SQUID_SRC_AUTH_CREDENTIALSCACHE_H */
 
diff --git a/src/auth/Gadgets.cc b/src/auth/Gadgets.cc
index a157721c04..33886a1970 100644
--- a/src/auth/Gadgets.cc
+++ b/src/auth/Gadgets.cc
@@ -24,7 +24,7 @@
 #include "auth/ntlm/User.h"
 #include "auth/Scheme.h"
 #include "auth/User.h"
-#include "auth/UserNameCache.h"
+#include "auth/CredentialsCache.h"
 #include "auth/UserRequest.h"
 #include "client_side.h"
 #include "globals.h"
diff --git a/src/auth/Makefile.am b/src/auth/Makefile.am
index f12dedda6e..68c39c6200 100644
--- a/src/auth/Makefile.am
+++ b/src/auth/Makefile.am
@@ -32,8 +32,8 @@ libauth_la_SOURCES = \
 	State.cc \
 	User.h \
 	User.cc \
-	UserNameCache.h \
-	UserNameCache.cc \
+	CredentialsCache.h \
+	CredentialsCache.cc \
 	UserRequest.h \
 	UserRequest.cc
 
diff --git a/src/auth/User.cc b/src/auth/User.cc
index 305fbbab69..a9ba096efe 100644
--- a/src/auth/User.cc
+++ b/src/auth/User.cc
@@ -14,7 +14,7 @@
 #include "auth/Config.h"
 #include "auth/Gadgets.h"
 #include "auth/User.h"
-#include "auth/UserNameCache.h"
+#include "auth/CredentialsCache.h"
 #include "auth/UserRequest.h"
 #include "event.h"
 #include "globals.h"
@@ -242,7 +242,7 @@ Auth::User::BuildUserKey(const char *username, const char *realm)
  * Dump the username cache statictics for viewing...
  */
 void
-Auth::User::UsernameCacheStats(StoreEntry *output)
+Auth::User::CredentialsCacheStats(StoreEntry *output)
 {
     auto userlist = authenticateCachedUsersList();
     storeAppendPrintf(output, "Cached Usernames: %d", static_cast<int32_t>(userlist.size()));
diff --git a/src/auth/User.h b/src/auth/User.h
index 8ff1af048c..a2645245e2 100644
--- a/src/auth/User.h
+++ b/src/auth/User.h
@@ -26,7 +26,7 @@ namespace Auth
 {
 
 class Config;
-class UserNameCache;
+class CredentialsCache;
 
 /**
  *  \ingroup AuthAPI
@@ -80,11 +80,11 @@ public:
 
     /// add the Auth::User to the protocol-specific username cache.
     virtual void addToNameCache() = 0;
-    static void UsernameCacheStats(StoreEntry * output);
+    static void CredentialsCacheStats(StoreEntry * output);
 
     // userKey ->Auth::User::Pointer cache
     // must be reimplemented in subclasses
-    static CbcPointer<Auth::UserNameCache> Cache();
+    static CbcPointer<Auth::CredentialsCache> Cache();
 
     CredentialState credentials() const;
     void credentials(CredentialState);
diff --git a/src/auth/basic/Config.cc b/src/auth/basic/Config.cc
index 321e69907e..d62e093fc6 100644
--- a/src/auth/basic/Config.cc
+++ b/src/auth/basic/Config.cc
@@ -19,7 +19,7 @@
 #include "auth/basic/UserRequest.h"
 #include "auth/Gadgets.h"
 #include "auth/State.h"
-#include "auth/UserNameCache.h"
+#include "auth/CredentialsCache.h"
 #include "cache_cf.h"
 #include "charset.h"
 #include "helper.h"
diff --git a/src/auth/basic/User.cc b/src/auth/basic/User.cc
index c8be6cf9b0..9c732a254d 100644
--- a/src/auth/basic/User.cc
+++ b/src/auth/basic/User.cc
@@ -9,7 +9,7 @@
 #include "squid.h"
 #include "auth/basic/Config.h"
 #include "auth/basic/User.h"
-#include "auth/UserNameCache.h"
+#include "auth/CredentialsCache.h"
 #include "Debug.h"
 #include "SquidConfig.h"
 #include "SquidTime.h"
@@ -80,10 +80,10 @@ Auth::Basic::User::updateCached(Auth::Basic::User *from)
     }
 }
 
-CbcPointer<Auth::UserNameCache>
+CbcPointer<Auth::CredentialsCache>
 Auth::Basic::User::Cache()
 {
-    static CbcPointer<Auth::UserNameCache> p(new Auth::UserNameCache("basic"));
+    static CbcPointer<Auth::CredentialsCache> p(new Auth::CredentialsCache("basic"));
     return p;
 }
 
diff --git a/src/auth/basic/User.h b/src/auth/basic/User.h
index 97dc193258..340e7c8f31 100644
--- a/src/auth/basic/User.h
+++ b/src/auth/basic/User.h
@@ -37,7 +37,7 @@ public:
     virtual int32_t ttl() const;
 
     /* Auth::User API */
-    static CbcPointer<Auth::UserNameCache> Cache();
+    static CbcPointer<Auth::CredentialsCache> Cache();
     virtual void addToNameCache() override;
 
     char *passwd;
diff --git a/src/auth/digest/Config.cc b/src/auth/digest/Config.cc
index 90a6ff9eb8..eea2f30d3d 100644
--- a/src/auth/digest/Config.cc
+++ b/src/auth/digest/Config.cc
@@ -19,7 +19,7 @@
 #include "auth/digest/UserRequest.h"
 #include "auth/Gadgets.h"
 #include "auth/State.h"
-#include "auth/UserNameCache.h"
+#include "auth/CredentialsCache.h"
 #include "base/LookupTable.h"
 #include "base64.h"
 #include "cache_cf.h"
diff --git a/src/auth/digest/User.cc b/src/auth/digest/User.cc
index a6d85a26df..81788f10fb 100644
--- a/src/auth/digest/User.cc
+++ b/src/auth/digest/User.cc
@@ -9,7 +9,7 @@
 #include "squid.h"
 #include "auth/digest/Config.h"
 #include "auth/digest/User.h"
-#include "auth/UserNameCache.h"
+#include "auth/CredentialsCache.h"
 #include "Debug.h"
 #include "dlink.h"
 #include "SquidConfig.h"
@@ -73,10 +73,10 @@ Auth::Digest::User::currentNonce()
     return nonce;
 }
 
-CbcPointer<Auth::UserNameCache>
+CbcPointer<Auth::CredentialsCache>
 Auth::Digest::User::Cache()
 {
-    static CbcPointer<Auth::UserNameCache> p(new Auth::UserNameCache("digest"));
+    static CbcPointer<Auth::CredentialsCache> p(new Auth::CredentialsCache("digest"));
     return p;
 }
 
diff --git a/src/auth/digest/User.h b/src/auth/digest/User.h
index 0ba69db2f8..f823bb5256 100644
--- a/src/auth/digest/User.h
+++ b/src/auth/digest/User.h
@@ -30,7 +30,7 @@ public:
     virtual int32_t ttl() const;
 
     /* Auth::User API */
-    static CbcPointer<Auth::UserNameCache> Cache();
+    static CbcPointer<Auth::CredentialsCache> Cache();
     virtual void addToNameCache() override;
 
     HASH HA1;
diff --git a/src/auth/negotiate/User.cc b/src/auth/negotiate/User.cc
index d97489c772..3a264d86c9 100644
--- a/src/auth/negotiate/User.cc
+++ b/src/auth/negotiate/User.cc
@@ -9,7 +9,7 @@
 #include "squid.h"
 #include "auth/Config.h"
 #include "auth/negotiate/User.h"
-#include "auth/UserNameCache.h"
+#include "auth/CredentialsCache.h"
 #include "Debug.h"
 
 Auth::Negotiate::User::User(Auth::Config *aConfig, const char *aRequestRealm) :
@@ -28,10 +28,10 @@ Auth::Negotiate::User::ttl() const
     return -1; // Negotiate cannot be cached.
 }
 
-CbcPointer<Auth::UserNameCache>
+CbcPointer<Auth::CredentialsCache>
 Auth::Negotiate::User::Cache()
 {
-    static CbcPointer<Auth::UserNameCache> p(new Auth::UserNameCache("negotiate"));
+    static CbcPointer<Auth::CredentialsCache> p(new Auth::CredentialsCache("negotiate"));
     return p;
 }
 
diff --git a/src/auth/negotiate/User.h b/src/auth/negotiate/User.h
index 91ae262710..3df41a4eb9 100644
--- a/src/auth/negotiate/User.h
+++ b/src/auth/negotiate/User.h
@@ -30,7 +30,7 @@ public:
     virtual int32_t ttl() const;
 
     /* Auth::User API */
-    static CbcPointer<Auth::UserNameCache> Cache();
+    static CbcPointer<Auth::CredentialsCache> Cache();
     virtual void addToNameCache() override;
 
     dlink_list proxy_auth_list;
diff --git a/src/auth/negotiate/UserRequest.cc b/src/auth/negotiate/UserRequest.cc
index b5d418a445..165d970a7f 100644
--- a/src/auth/negotiate/UserRequest.cc
+++ b/src/auth/negotiate/UserRequest.cc
@@ -13,7 +13,7 @@
 #include "auth/negotiate/UserRequest.h"
 #include "auth/State.h"
 #include "auth/User.h"
-#include "auth/UserNameCache.h"
+#include "auth/CredentialsCache.h"
 #include "client_side.h"
 #include "fatal.h"
 #include "format/Format.h"
diff --git a/src/auth/ntlm/User.cc b/src/auth/ntlm/User.cc
index e1a96fbb30..bd03c96b87 100644
--- a/src/auth/ntlm/User.cc
+++ b/src/auth/ntlm/User.cc
@@ -9,7 +9,7 @@
 #include "squid.h"
 #include "auth/Config.h"
 #include "auth/ntlm/User.h"
-#include "auth/UserNameCache.h"
+#include "auth/CredentialsCache.h"
 #include "Debug.h"
 
 Auth::Ntlm::User::User(Auth::Config *aConfig, const char *aRequestRealm) :
@@ -28,10 +28,10 @@ Auth::Ntlm::User::ttl() const
     return -1; // NTLM credentials cannot be cached.
 }
 
-CbcPointer<Auth::UserNameCache>
+CbcPointer<Auth::CredentialsCache>
 Auth::Ntlm::User::Cache()
 {
-    static CbcPointer<Auth::UserNameCache> p(new Auth::UserNameCache("ntlm"));
+    static CbcPointer<Auth::CredentialsCache> p(new Auth::CredentialsCache("ntlm"));
     return p;
 }
 
diff --git a/src/auth/ntlm/User.h b/src/auth/ntlm/User.h
index d845a478bb..acb2cd724e 100644
--- a/src/auth/ntlm/User.h
+++ b/src/auth/ntlm/User.h
@@ -30,7 +30,7 @@ public:
     virtual int32_t ttl() const;
 
     /* Auth::User API */
-    static CbcPointer<Auth::UserNameCache> Cache();
+    static CbcPointer<Auth::CredentialsCache> Cache();
     virtual void addToNameCache() override;
 
     dlink_list proxy_auth_list;
diff --git a/src/auth/ntlm/UserRequest.cc b/src/auth/ntlm/UserRequest.cc
index f223e89f65..cf732da6ea 100644
--- a/src/auth/ntlm/UserRequest.cc
+++ b/src/auth/ntlm/UserRequest.cc
@@ -12,7 +12,7 @@
 #include "auth/ntlm/User.h"
 #include "auth/ntlm/UserRequest.h"
 #include "auth/State.h"
-#include "auth/UserNameCache.h"
+#include "auth/CredentialsCache.h"
 #include "cbdata.h"
 #include "client_side.h"
 #include "fatal.h"
diff --git a/src/stat.cc b/src/stat.cc
index cee9b4c700..13d18c1105 100644
--- a/src/stat.cc
+++ b/src/stat.cc
@@ -1216,7 +1216,7 @@ statRegisterWithCacheManager(void)
 #if USE_AUTH
     Mgr::RegisterAction("username_cache",
                         "Active Cached Usernames",
-                        Auth::User::UsernameCacheStats, 0, 1);
+                        Auth::User::CredentialsCacheStats, 0, 1);
 #endif
 #if DEBUG_OPENFD
     Mgr::RegisterAction("openfd_objects", "Objects with Swapout files open",
diff --git a/src/tests/stub_libauth.cc b/src/tests/stub_libauth.cc
index 2f27a73a62..dcaad79cc8 100644
--- a/src/tests/stub_libauth.cc
+++ b/src/tests/stub_libauth.cc
@@ -42,8 +42,7 @@ Auth::User::~User() STUB_NOP
 void Auth::User::clearIp() STUB
 void Auth::User::removeIp(Ip::Address) STUB
 void Auth::User::addIp(Ip::Address) STUB
-void Auth::User::addToNameCache() STUB
-void Auth::User::UsernameCacheStats(StoreEntry *) STUB
+void Auth::User::CredentialsCacheStats(StoreEntry *) STUB
 
 #include "auth/UserRequest.h"
 char const * Auth::UserRequest::username() const STUB_RETVAL("stub_username")