Implement modular LookupTable and use it for HttpHeader.cc:headerTable.

diff --git a/src/HttpHeader.cc b/src/HttpHeader.cc
index ea705f800d05bc0a12aad1197d966ad9d39ee05d..ee32647d53f0a4965b9ab59e06ffa8b675af2491 100644 (file)
--- a/src/HttpHeader.cc
+++ b/src/HttpHeader.cc
@@ -159,103 +159,109 @@ static const HttpHeaderFieldAttrs HeadersAttrs[] = {
     HttpHeaderFieldAttrs("Other:", HDR_OTHER, ftStr)    /* ':' will not allow matches */
 };
 
-// Note: MUST be sorted by value of http_hdr_type
-static const LookupTable<http_hdr_type>::Record headerTable[] = {
-    {"Accept", HDR_ACCEPT},
-    {"Accept-Charset", HDR_ACCEPT_CHARSET},
-    {"Accept-Encoding", HDR_ACCEPT_ENCODING},
-    {"Accept-Language", HDR_ACCEPT_LANGUAGE},
-    {"Accept-Ranges", HDR_ACCEPT_RANGES},
-    {"Age", HDR_AGE},
-    {"Allow", HDR_ALLOW},
-    {"Alternate-Protocol", HDR_ALTERNATE_PROTOCOL},
-    {"Authorization", HDR_AUTHORIZATION},    /* for now */
-    {"Cache-Control", HDR_CACHE_CONTROL},
-    {"Connection", HDR_CONNECTION},
-    {"Content-Base", HDR_CONTENT_BASE},
-    {"Content-Disposition", HDR_CONTENT_DISPOSITION},  /* for now */
-    {"Content-Encoding", HDR_CONTENT_ENCODING},
-    {"Content-Language", HDR_CONTENT_LANGUAGE},
-    {"Content-Length", HDR_CONTENT_LENGTH},
-    {"Content-Location", HDR_CONTENT_LOCATION},
-    {"Content-MD5", HDR_CONTENT_MD5},    /* for now */
-    {"Content-Range", HDR_CONTENT_RANGE},
-    {"Content-Type", HDR_CONTENT_TYPE},
-    {"Cookie", HDR_COOKIE},
-    {"Cookie2", HDR_COOKIE2},
-    {"Date", HDR_DATE},
-    {"ETag", HDR_ETAG},
-    {"Expect", HDR_EXPECT},
-    {"Expires", HDR_EXPIRES},
-    {"Forwarded", HDR_FORWARDED},
-    {"From", HDR_FROM},
-    {"Host", HDR_HOST},
-    {"HTTP2-Settings", HDR_HTTP2_SETTINGS}, /* for now */
-    {"If-Match", HDR_IF_MATCH},  /* for now */
-    {"If-Modified-Since", HDR_IF_MODIFIED_SINCE},
-    {"If-None-Match", HDR_IF_NONE_MATCH},    /* for now */
-    {"If-Range", HDR_IF_RANGE},
-    {"If-Unmodified-Since", HDR_IF_UNMODIFIED_SINCE},
-    {"Keep-Alive", HDR_KEEP_ALIVE},
-    {"Key", HDR_KEY},
-    {"Last-Modified", HDR_LAST_MODIFIED},
-    {"Link", HDR_LINK},
-    {"Location", HDR_LOCATION},
-    {"Max-Forwards", HDR_MAX_FORWARDS},
-    {"Mime-Version", HDR_MIME_VERSION},  /* for now */
-    {"Negotiate", HDR_NEGOTIATE},
-    {"Origin", HDR_ORIGIN},
-    {"Pragma", HDR_PRAGMA},
-    {"Proxy-Authenticate", HDR_PROXY_AUTHENTICATE},
-    {"Proxy-Authentication-Info", HDR_PROXY_AUTHENTICATION_INFO},
-    {"Proxy-Authorization", HDR_PROXY_AUTHORIZATION},
-    {"Proxy-Connection", HDR_PROXY_CONNECTION},
-    {"Proxy-support", HDR_PROXY_SUPPORT},
-    {"Public", HDR_PUBLIC},
-    {"Range", HDR_RANGE},
-    {"Referer", HDR_REFERER},
-    {"Request-Range", HDR_REQUEST_RANGE}, /* usually matches HDR_RANGE */
-    {"Retry-After", HDR_RETRY_AFTER},    /* for now (ftDate_1123 or ftInt!) */
-    {"Server", HDR_SERVER},
-    {"Set-Cookie", HDR_SET_COOKIE},
-    {"Set-Cookie2", HDR_SET_COOKIE2},
-    {"TE", HDR_TE},
-    {"Title", HDR_TITLE},
-    {"Trailer", HDR_TRAILER},
-    {"Transfer-Encoding", HDR_TRANSFER_ENCODING},
-    {"Translate", HDR_TRANSLATE},    /* for now. may need to crop */
-    {"Unless-Modified-Since", HDR_UNLESS_MODIFIED_SINCE},  /* for now ignore. may need to crop */
-    {"Upgrade", HDR_UPGRADE},    /* for now */
-    {"User-Agent", HDR_USER_AGENT},
-    {"Vary", HDR_VARY},  /* for now */
-    {"Via", HDR_VIA},    /* for now */
-    {"Warning", HDR_WARNING},    /* for now */
-    {"WWW-Authenticate", HDR_WWW_AUTHENTICATE},
-    {"Authentication-Info", HDR_AUTHENTICATION_INFO},
-    {"X-Cache", HDR_X_CACHE},
-    {"X-Cache-Lookup", HDR_X_CACHE_LOOKUP},
-    {"X-Forwarded-For", HDR_X_FORWARDED_FOR},
-    {"X-Request-URI", HDR_X_REQUEST_URI},
-    {"X-Squid-Error", HDR_X_SQUID_ERROR},
+struct HeaderTableRecord {
+    const char *name;
+    http_hdr_type id;
+    field_type type;
+};
+// Note: MUST be sorted by value of http_hdr_type.
+// invariant: for each index in headerTable, (int)headerTable[index] = index
+static const HeaderTableRecord headerTable[] = {
+    {"Accept", HDR_ACCEPT, ftStr},
+    {"Accept-Charset", HDR_ACCEPT_CHARSET, ftStr},
+    {"Accept-Encoding", HDR_ACCEPT_ENCODING, ftStr},
+    {"Accept-Language", HDR_ACCEPT_LANGUAGE, ftStr},
+    {"Accept-Ranges", HDR_ACCEPT_RANGES, ftStr},
+    {"Age", HDR_AGE, ftInt},
+    {"Allow", HDR_ALLOW, ftStr},
+    {"Alternate-Protocol", HDR_ALTERNATE_PROTOCOL, ftStr},
+    {"Authorization", HDR_AUTHORIZATION, ftStr},    /* for now */
+    {"Cache-Control", HDR_CACHE_CONTROL, ftPCc},
+    {"Connection", HDR_CONNECTION, ftStr},
+    {"Content-Base", HDR_CONTENT_BASE, ftStr},
+    {"Content-Disposition", HDR_CONTENT_DISPOSITION, ftStr},  /* for now */
+    {"Content-Encoding", HDR_CONTENT_ENCODING, ftStr},
+    {"Content-Language", HDR_CONTENT_LANGUAGE, ftStr},
+    {"Content-Length", HDR_CONTENT_LENGTH, ftInt64},
+    {"Content-Location", HDR_CONTENT_LOCATION, ftStr},
+    {"Content-MD5", HDR_CONTENT_MD5, ftStr},    /* for now */
+    {"Content-Range", HDR_CONTENT_RANGE, ftPContRange},
+    {"Content-Type", HDR_CONTENT_TYPE, ftStr},
+    {"Cookie", HDR_COOKIE, ftStr},
+    {"Cookie2", HDR_COOKIE2, ftStr},
+    {"Date", HDR_DATE, ftDate_1123},
+    {"ETag", HDR_ETAG, ftETag},
+    {"Expect", HDR_EXPECT, ftStr},
+    {"Expires", HDR_EXPIRES, ftDate_1123},
+    {"Forwarded", HDR_FORWARDED, ftStr},
+    {"From", HDR_FROM, ftStr},
+    {"Host", HDR_HOST, ftStr},
+    {"HTTP2-Settings", HDR_HTTP2_SETTINGS, ftStr}, /* for now */
+    {"If-Match", HDR_IF_MATCH, ftStr},  /* for now */
+    {"If-Modified-Since", HDR_IF_MODIFIED_SINCE, ftDate_1123},
+    {"If-None-Match", HDR_IF_NONE_MATCH, ftStr},    /* for now */
+    {"If-Range", HDR_IF_RANGE, ftDate_1123_or_ETag},
+    {"If-Unmodified-Since", HDR_IF_UNMODIFIED_SINCE, ftDate_1123},
+    {"Keep-Alive", HDR_KEEP_ALIVE, ftStr},
+    {"Key", HDR_KEY, ftStr},
+    {"Last-Modified", HDR_LAST_MODIFIED, ftDate_1123},
+    {"Link", HDR_LINK, ftStr},
+    {"Location", HDR_LOCATION, ftStr},
+    {"Max-Forwards", HDR_MAX_FORWARDS, ftInt64},
+    {"Mime-Version", HDR_MIME_VERSION, ftStr},  /* for now */
+    {"Negotiate", HDR_NEGOTIATE, ftStr},
+    {"Origin", HDR_ORIGIN, ftStr},
+    {"Pragma", HDR_PRAGMA, ftStr},
+    {"Proxy-Authenticate", HDR_PROXY_AUTHENTICATE, ftStr},
+    {"Proxy-Authentication-Info", HDR_PROXY_AUTHENTICATION_INFO, ftStr},
+    {"Proxy-Authorization", HDR_PROXY_AUTHORIZATION, ftStr},
+    {"Proxy-Connection", HDR_PROXY_CONNECTION, ftStr},
+    {"Proxy-support", HDR_PROXY_SUPPORT, ftStr},
+    {"Public", HDR_PUBLIC, ftStr},
+    {"Range", HDR_RANGE, ftPRange},
+    {"Referer", HDR_REFERER, ftStr},
+    {"Request-Range", HDR_REQUEST_RANGE, ftPRange}, /* usually matches HDR_RANGE */
+    {"Retry-After", HDR_RETRY_AFTER, ftStr},    /* for now (ftDate_1123 or ftInt!} */
+    {"Server", HDR_SERVER, ftStr},
+    {"Set-Cookie", HDR_SET_COOKIE, ftStr},
+    {"Set-Cookie2", HDR_SET_COOKIE2, ftStr},
+    {"TE", HDR_TE, ftStr},
+    {"Title", HDR_TITLE, ftStr},
+    {"Trailer", HDR_TRAILER, ftStr},
+    {"Transfer-Encoding", HDR_TRANSFER_ENCODING, ftStr},
+    {"Translate", HDR_TRANSLATE, ftStr},    /* for now. may need to crop */
+    {"Unless-Modified-Since", HDR_UNLESS_MODIFIED_SINCE, ftStr},  /* for now ignore. may need to crop */
+    {"Upgrade", HDR_UPGRADE, ftStr},    /* for now */
+    {"User-Agent", HDR_USER_AGENT, ftStr},
+    {"Vary", HDR_VARY, ftStr},  /* for now */
+    {"Via", HDR_VIA, ftStr},    /* for now */
+    {"Warning", HDR_WARNING, ftStr},    /* for now */
+    {"WWW-Authenticate", HDR_WWW_AUTHENTICATE, ftStr},
+    {"Authentication-Info", HDR_AUTHENTICATION_INFO, ftStr},
+    {"X-Cache", HDR_X_CACHE, ftStr},
+    {"X-Cache-Lookup", HDR_X_CACHE_LOOKUP, ftStr},
+    {"X-Forwarded-For", HDR_X_FORWARDED_FOR, ftStr},
+    {"X-Request-URI", HDR_X_REQUEST_URI, ftStr},
+    {"X-Squid-Error", HDR_X_SQUID_ERROR, ftStr},
 #if X_ACCELERATOR_VARY
-    {"X-Accelerator-Vary", HDR_X_ACCELERATOR_VARY},
+    {"X-Accelerator-Vary", HDR_X_ACCELERATOR_VARY, ftStr},
 #endif
 #if USE_ADAPTATION
-    {"X-Next-Services", HDR_X_NEXT_SERVICES},
+    {"X-Next-Services", HDR_X_NEXT_SERVICES, ftStr},
 #endif
-    {"Surrogate-Capability", HDR_SURROGATE_CAPABILITY},
-    {"Surrogate-Control", HDR_SURROGATE_CONTROL},
-    {"Front-End-Https", HDR_FRONT_END_HTTPS},
-    {"FTP-Command", HDR_FTP_COMMAND},
-    {"FTP-Arguments", HDR_FTP_ARGUMENTS},
-    {"FTP-Pre", HDR_FTP_PRE},
-    {"FTP-Status", HDR_FTP_STATUS},
-    {"FTP-Reason", HDR_FTP_REASON},
+    {"Surrogate-Capability", HDR_SURROGATE_CAPABILITY, ftStr},
+    {"Surrogate-Control", HDR_SURROGATE_CONTROL, ftPSc},
+    {"Front-End-Https", HDR_FRONT_END_HTTPS, ftStr},
+    {"FTP-Command", HDR_FTP_COMMAND, ftStr},
+    {"FTP-Arguments", HDR_FTP_ARGUMENTS, ftStr},
+    {"FTP-Pre", HDR_FTP_PRE, ftStr},
+    {"FTP-Status", HDR_FTP_STATUS, ftInt},
+    {"FTP-Reason", HDR_FTP_REASON, ftStr},
     {nullptr, HDR_OTHER}    /* ':' will not allow matches */
 };
 
 static HttpHeaderFieldInfo *Headers = NULL;
-LookupTable<http_hdr_type> headerLookupTable(HDR_OTHER, headerTable);
+LookupTable<http_hdr_type, HeaderTableRecord> headerLookupTable(HDR_OTHER, headerTable);
 std::vector<HttpHeaderFieldStat> headerStatsTable(HDR_OTHER);
 
 http_hdr_type &operator++ (http_hdr_type &aHeader)

diff --git a/src/base/LookupTable.h b/src/base/LookupTable.h
index 1a63702c7a17ab27c62aefe3e7598b60bae8aba1..795f499800175dcace1d0b379512d71813dc6213 100644 (file)
--- a/src/base/LookupTable.h
+++ b/src/base/LookupTable.h
@@ -13,6 +13,22 @@
 
 #include <map>
 
+/**
+ * a record in he initializer list for a LookupTable
+ *
+ * In case it is wished to extend the structure of a LookupTable's initializer
+ * list, it can be done by using a custom struct which must match
+ * LookupTableRecord's signature plus any extra custom fields the user may
+ * wish to add; the extended record type must then be passed as RecordType
+ * template parameter to LookupTable.
+ */
+template <typename EnumType>
+struct LookupTableRecord
+{
+    const char *name;
+    EnumType id;
+};
+
 /**
  * SBuf -> enum lookup table
  *
@@ -29,15 +45,12 @@
  * if (item != ENUM_INVALID_VALUE) { // do stuff }
  *
  */
-template<typename EnumType>
+template<typename EnumType, typename RecordType = LookupTableRecord<EnumType> >
 class LookupTable
 {
 public:
     /// element of the lookup table initialization list
-    typedef struct {
-        const char *name;
-        EnumType id;
-    } Record;
+    typedef RecordType Record;
 
     LookupTable(const EnumType theInvalid, const Record data[]) :
         invalidValue(theInvalid)
@@ -46,6 +59,7 @@ public:
             lookupTable[SBuf(data[i].name)] = data[i].id;
         }
     }
+
     EnumType lookup(const SBuf &key) const {
         auto r = lookupTable.find(key);
         if (r == lookupTable.end())