src/adaptation/icap/Options.h

   1
   2 /*
   3  * $Id$
   4  *
   5  *
   6  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   7  * ----------------------------------------------------------
   8  *
   9  *  Squid is the result of efforts by numerous individuals from
  10  *  the Internet community; see the CONTRIBUTORS file for full
  11  *  details.   Many organizations have provided support for Squid's
  12  *  development; see the SPONSORS file for full details.  Squid is
  13  *  Copyrighted (C) 2001 by the Regents of the University of
  14  *  California; see the COPYRIGHT file for full details.  Squid
  15  *  incorporates software developed and/or copyrighted by other
  16  *  sources; see the CREDITS file for full details.
  17  *
  18  *  This program is free software; you can redistribute it and/or modify
  19  *  it under the terms of the GNU General Public License as published by
  20  *  the Free Software Foundation; either version 2 of the License, or
  21  *  (at your option) any later version.
  22  *
  23  *  This program is distributed in the hope that it will be useful,
  24  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  25  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  *  GNU General Public License for more details.
  27  *
  28  *  You should have received a copy of the GNU General Public License
  29  *  along with this program; if not, write to the Free Software
  30  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  31  *
  32  */
  33
  34 #ifndef SQUID_ICAPOPTIONS_H
  35 #define SQUID_ICAPOPTIONS_H
  36
  37 #include "squid.h"
  38 #include "adaptation/icap/ServiceRep.h"
  39
  40 class wordlist;
  41
  42 namespace Adaptation
  43 {
  44 namespace Icap
  45 {
  46
  47 /* Maintains options supported by a given ICAP service.
  48  * See RFC 3507, Section "4.10.2 OPTIONS Response". */
  49
  50 class Options
  51 {
  52
  53 public:
  54     typedef void GetCallback(void *data, Options *options);
  55     static void Get(ServiceRep::Pointer &service, GetCallback *cb, void *data);
  56
  57 public:
  58     Options();
  59     ~Options();
  60
  61     void configure(const HttpReply *reply);
  62
  63     bool valid() const;
  64     bool fresh() const;
  65     int ttl() const;
  66     time_t expire() const;
  67     time_t timestamp() const { return theTimestamp; };
  68
  69     typedef enum { xferNone, xferPreview, xferIgnore, xferComplete } TransferKind;
  70     TransferKind transferKind(const String &urlPath) const;
  71
  72 public:
  73     const char *error; // human-readable information; set iff !valid()
  74
  75     // ICAP server MUST supply this info
  76     Vector<ICAP::Method> methods;
  77     String istag;
  78
  79     // ICAP server MAY supply this info. If not, Squid supplies defaults.
  80     String service;
  81     String serviceId;
  82     int max_connections;
  83     bool allow204;
  84     int preview;
  85
  86 protected:
  87     // Transfer-* extension list representation
  88     // maintains wordlist and does parsing/matching
  89     class TransferList
  90     {
  91     public:
  92         TransferList();
  93         ~TransferList();
  94
  95         bool matches(const String &urlPath) const;
  96
  97         void parse(const String &buf, bool &foundStar);
  98         void add(const char *extension);
  99         void report(int level, const char *prefix) const;
 100
 101     public:
 102         wordlist *extensions; // TODO: optimize with a hash of some sort
 103         const char *name;  // header name, mostly for debugging
 104         TransferKind kind; // to simplify caller's life
 105     };
 106
 107     // varios Transfer-* lists
 108     struct Transfers {
 109         TransferList preview;
 110         TransferList ignore;
 111         TransferList complete;
 112         TransferList *byDefault;  // Transfer-X that has '*'
 113     } theTransfers;
 114
 115     int theTTL;
 116     time_t theTimestamp;
 117
 118 private:
 119     void cfgMethod(ICAP::Method m);
 120     void cfgIntHeader(const HttpHeader *h, const char *fname, int &value);
 121     void cfgTransferList(const HttpHeader *h, TransferList &l);
 122 };
 123
 124
 125
 126
 127 } // namespace Icap
 128 } // namespace Adaptation
 129
 130 #endif /* SQUID_ICAPOPTIONS_H */