src/HttpHdrScTarget.h

   1 /*
   2  * $Id$
   3  *
   4  *
   5  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   6  * ----------------------------------------------------------
   7  *
   8  *  Squid is the result of efforts by numerous individuals from
   9  *  the Internet community; see the CONTRIBUTORS file for full
  10  *  details.   Many organizations have provided support for Squid's
  11  *  development; see the SPONSORS file for full details.  Squid is
  12  *  Copyrighted (C) 2001 by the Regents of the University of
  13  *  California; see the COPYRIGHT file for full details.  Squid
  14  *  incorporates software developed and/or copyrighted by other
  15  *  sources; see the CREDITS file for full details.
  16  *
  17  *  This program is free software; you can redistribute it and/or modify
  18  *  it under the terms of the GNU General Public License as published by
  19  *  the Free Software Foundation; either version 2 of the License, or
  20  *  (at your option) any later version.
  21  *
  22  *  This program is distributed in the hope that it will be useful,
  23  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  *  GNU General Public License for more details.
  26  *
  27  *  You should have received a copy of the GNU General Public License
  28  *  along with this program; if not, write to the Free Software
  29  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  30  *
  31  */
  32 #ifndef SQUID_HTTPHDRSURROGATECONTROLTARGET_H
  33 #define SQUID_HTTPHDRSURROGATECONTROLTARGET_H
  34
  35 #include "MemPool.h"
  36 #include "defines.h"
  37 #include "dlink.h"
  38 #include "SquidString.h"
  39 #include "typedefs.h"
  40
  41 class StatHist;
  42 class Packer;
  43 class StoreEntry;
  44
  45 /** Representation of HTTP Surogate-Control header field targeted directive
  46  *
  47  * \see HttpHdrSc
  48  */
  49 class HttpHdrScTarget
  50 {
  51     // parsing is done in HttpHdrSc, need to grant them access.
  52     friend class HttpHdrSc;
  53 public:
  54     static const int MAX_AGE_UNSET=-1; //max-age is unset
  55     static const int MAX_STALE_UNSET=0; //max-stale is unset
  56
  57     HttpHdrScTarget(const char *target_):
  58             mask(0), max_age(MAX_AGE_UNSET), max_stale(MAX_STALE_UNSET),target(target_) {}
  59     HttpHdrScTarget(const String &target_):
  60             mask(0), max_age(MAX_AGE_UNSET), max_stale(MAX_STALE_UNSET),target(target_) {}
  61     HttpHdrScTarget(const HttpHdrScTarget &t):
  62             mask(t.mask), max_age(t.max_age), max_stale(t.max_stale),
  63             content_(t.content_), target(t.target) {}
  64
  65     bool hasNoStore() const {return isSet(SC_NO_STORE); }
  66     void noStore(bool v) { setMask(SC_NO_STORE,v); }
  67     bool noStore() const { return isSet(SC_NO_STORE); }
  68     void clearNoStore() { setMask(SC_NO_STORE, false); }
  69
  70     bool hasNoStoreRemote() const {return isSet(SC_NO_STORE_REMOTE); }
  71     void noStoreRemote(bool v) { setMask(SC_NO_STORE_REMOTE,v); }
  72     bool noStoreRemote() const { return isSet(SC_NO_STORE_REMOTE); }
  73     void clearNoStoreRemote() { setMask(SC_NO_STORE_REMOTE, false); }
  74
  75     bool hasMaxAge() const { return isSet(SC_MAX_AGE); }
  76     void maxAge(int v) {
  77         if (v >= 0) { //setting
  78             setMask(SC_MAX_AGE,true);
  79             max_age=v;
  80         } else {
  81             setMask(SC_MAX_AGE,false);
  82             max_age=MAX_AGE_UNSET;
  83         }
  84     }
  85     int maxAge() const { return max_age; }
  86     void clearMaxAge() { setMask(SC_MAX_AGE,false); max_age=MAX_AGE_UNSET; }
  87
  88     //max_stale has no associated status-bit
  89     bool hasMaxStale() const { return max_stale != MAX_STALE_UNSET; }
  90     void maxStale(int v) { max_stale=v; }
  91     int maxStale() const { return max_stale; }
  92     void clearMaxStale() { max_stale=MAX_STALE_UNSET; }
  93
  94     bool hasContent() const { return isSet(SC_CONTENT); }
  95     void Content(const String &v) {
  96         setMask(SC_CONTENT,true);
  97         content_=v;
  98     }
  99     String content() const { return content_; }
 100     void clearContent() { setMask(SC_CONTENT,false); content_.clean(); }
 101
 102     bool hasTarget() const { return target.size() != 0; }
 103     String Target() const { return target; }
 104
 105     void mergeWith(const HttpHdrScTarget * new_sc);
 106     void packInto (Packer *p) const;
 107     void updateStats(StatHist *) const;
 108
 109     MEMPROXY_CLASS(HttpHdrScTarget);
 110 private:
 111     bool isSet(http_hdr_sc_type id) const {
 112         assert (id >= SC_NO_STORE && id < SC_ENUM_END);
 113         return EBIT_TEST(mask,id);
 114     }
 115
 116     void setMask(http_hdr_sc_type id, bool newval) {
 117         if (newval) EBIT_SET(mask,id);
 118         else EBIT_CLR(mask,id);
 119     }
 120
 121     int mask;
 122     int max_age;
 123     int max_stale;
 124     String content_;
 125     String target;
 126     dlink_node node;
 127 };
 128
 129 MEMPROXY_CLASS_INLINE(HttpHdrScTarget);
 130
 131 extern void httpHdrScTargetStatDumper(StoreEntry * sentry, int idx, double val, double size, int count);
 132
 133
 134
 135 #endif /* SQUID_HTTPHDRSURROGATECONTROLTARGET_H */