src/HttpHdrScTarget.h

   1 /*
   2  * Copyright (C) 1996-2018 The Squid Software Foundation and contributors
   3  *
   4  * Squid software is distributed under GPLv2+ license and includes
   5  * contributions from numerous individuals and organizations.
   6  * Please see the COPYING and CONTRIBUTORS files for details.
   7  */
   8
   9 #ifndef SQUID_HTTPHDRSURROGATECONTROLTARGET_H
  10 #define SQUID_HTTPHDRSURROGATECONTROLTARGET_H
  11
  12 #include "defines.h" //for bit mask operations
  13 #include "HttpHdrSc.h"
  14
  15 class Packable;
  16 class StatHist;
  17 class StoreEntry;
  18
  19 /** Representation of HTTP Surogate-Control header field targeted directive
  20  *
  21  * \see HttpHdrSc
  22  */
  23 class HttpHdrScTarget
  24 {
  25     MEMPROXY_CLASS(HttpHdrScTarget);
  26
  27     // parsing is done in HttpHdrSc, need to grant them access.
  28     friend class HttpHdrSc;
  29 public:
  30     static const int MAX_AGE_UNSET=-1; //max-age is unset
  31     static const int MAX_STALE_UNSET=0; //max-stale is unset
  32
  33     HttpHdrScTarget(const char *target_):
  34         mask(0), max_age(MAX_AGE_UNSET), max_stale(MAX_STALE_UNSET),target(target_) {}
  35     HttpHdrScTarget(const String &target_):
  36         mask(0), max_age(MAX_AGE_UNSET), max_stale(MAX_STALE_UNSET),target(target_) {}
  37     HttpHdrScTarget(const HttpHdrScTarget &t):
  38         mask(t.mask), max_age(t.max_age), max_stale(t.max_stale),
  39         content_(t.content_), target(t.target) {}
  40
  41     bool hasNoStore() const {return isSet(SC_NO_STORE); }
  42     void noStore(bool v) { setMask(SC_NO_STORE,v); }
  43     bool noStore() const { return isSet(SC_NO_STORE); }
  44     void clearNoStore() { setMask(SC_NO_STORE, false); }
  45
  46     bool hasNoStoreRemote() const {return isSet(SC_NO_STORE_REMOTE); }
  47     void noStoreRemote(bool v) { setMask(SC_NO_STORE_REMOTE,v); }
  48     bool noStoreRemote() const { return isSet(SC_NO_STORE_REMOTE); }
  49     void clearNoStoreRemote() { setMask(SC_NO_STORE_REMOTE, false); }
  50
  51     bool hasMaxAge() const { return isSet(SC_MAX_AGE); }
  52     void maxAge(int v) {
  53         if (v >= 0) { //setting
  54             setMask(SC_MAX_AGE,true);
  55             max_age=v;
  56         } else {
  57             setMask(SC_MAX_AGE,false);
  58             max_age=MAX_AGE_UNSET;
  59         }
  60     }
  61     int maxAge() const { return max_age; }
  62     void clearMaxAge() { setMask(SC_MAX_AGE,false); max_age=MAX_AGE_UNSET; }
  63
  64     //max_stale has no associated status-bit
  65     bool hasMaxStale() const { return max_stale != MAX_STALE_UNSET; }
  66     void maxStale(int v) { max_stale=v; }
  67     int maxStale() const { return max_stale; }
  68     void clearMaxStale() { max_stale=MAX_STALE_UNSET; }
  69
  70     bool hasContent() const { return isSet(SC_CONTENT); }
  71     void Content(const String &v) {
  72         setMask(SC_CONTENT,true);
  73         content_=v;
  74     }
  75     String content() const { return content_; }
  76     void clearContent() { setMask(SC_CONTENT,false); content_.clean(); }
  77
  78     bool hasTarget() const { return target.size() != 0; }
  79     String Target() const { return target; }
  80
  81     void mergeWith(const HttpHdrScTarget * new_sc);
  82     void packInto(Packable *p) const;
  83     void updateStats(StatHist *) const;
  84
  85 private:
  86     bool isSet(http_hdr_sc_type id) const {
  87         assert (id >= SC_NO_STORE && id < SC_ENUM_END);
  88         return EBIT_TEST(mask,id);
  89     }
  90
  91     void setMask(http_hdr_sc_type id, bool newval) {
  92         if (newval) EBIT_SET(mask,id);
  93         else EBIT_CLR(mask,id);
  94     }
  95
  96     int mask;
  97     int max_age;
  98     int max_stale;
  99     String content_;
 100     String target;
 101     dlink_node node;
 102 };
 103
 104 void httpHdrScTargetStatDumper(StoreEntry * sentry, int idx, double val, double size, int count);
 105
 106 #endif /* SQUID_HTTPHDRSURROGATECONTROLTARGET_H */
 107