src/esi/VarState.h

   1
   2 /*
   3  *
   4  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   5  * ----------------------------------------------------------
   6  *
   7  *  Squid is the result of efforts by numerous individuals from
   8  *  the Internet community; see the CONTRIBUTORS file for full
   9  *  details.   Many organizations have provided support for Squid's
  10  *  development; see the SPONSORS file for full details.  Squid is
  11  *  Copyrighted (C) 2001 by the Regents of the University of
  12  *  California; see the COPYRIGHT file for full details.  Squid
  13  *  incorporates software developed and/or copyrighted by other
  14  *  sources; see the CREDITS file for full details.
  15  *
  16  *  This program is free software; you can redistribute it and/or modify
  17  *  it under the terms of the GNU General Public License as published by
  18  *  the Free Software Foundation; either version 2 of the License, or
  19  *  (at your option) any later version.
  20  *
  21  *  This program is distributed in the hope that it will be useful,
  22  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24  *  GNU General Public License for more details.
  25  *
  26  *  You should have received a copy of the GNU General Public License
  27  *  along with this program; if not, write to the Free Software
  28  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  29  *
  30  */
  31
  32 #ifndef SQUID_ESIVARSTATE_H
  33 #define SQUID_ESIVARSTATE_H
  34
  35 #include "base/Vector.h"
  36 #include "esi/Segment.h"
  37 #include "HttpHeader.h"
  38 #include "libTrie/Trie.h"
  39
  40 class HttpReply;
  41
  42 /* esi variable replacement logic */
  43
  44 typedef enum {
  45     ESI_BROWSER_MSIE,
  46     ESI_BROWSER_MOZILLA,
  47     ESI_BROWSER_OTHER
  48 } esiBrowser_t;
  49
  50 extern char const * esiBrowsers[];
  51
  52 /* Recursive uses are not supported by design */
  53
  54 struct _query_elem {char *var, *val;};
  55
  56 class ESIVarState
  57 {
  58
  59 public:
  60     ESISegment::Pointer extractList();
  61     char *extractChar();
  62     void feedData (const char *buf, size_t len);
  63     void buildVary (HttpReply *rep);
  64
  65     class Variable;
  66     void addVariable (char const *, size_t, Variable *);
  67     void removeVariable (String const &);
  68
  69     void *operator new (size_t byteCount);
  70     void operator delete (void *address);
  71     void freeResources();
  72     ESIVarState (HttpHeader const *hdr, char const *uri);
  73     ~ESIVarState();
  74
  75     /* For Variables */
  76     void cookieUsed();
  77     void hostUsed();
  78     void languageUsed();
  79     void refererUsed();
  80     void useragentUsed();
  81     ESISegment::Pointer &getOutput();
  82     HttpHeader &header();
  83
  84 private:
  85     ESISegment::Pointer input;
  86     ESISegment::Pointer output;
  87     HttpHeader hdr;
  88
  89     struct {
  90         int language:1;
  91         int cookie:1;
  92         int host:1;
  93         int referer:1;
  94         int useragent:1;
  95     } flags;
  96
  97 public:
  98
  99     class Variable
 100     {
 101
 102     public:
 103         Variable () {}
 104
 105         virtual ~Variable() {}
 106
 107         /* prevent synthetics */
 108         Variable (Variable const &) {}
 109
 110         Variable &operator= (Variable const &);
 111         virtual void eval (ESIVarState &state, char const *, char const *) const;
 112     };
 113
 114     Variable* GetVar(char const *s, int len);
 115
 116 private:
 117     void doIt ();
 118     void setupUserAgent();
 119     Trie variables;
 120     Vector<Variable*> variablesForCleanup;
 121     Variable *defaultVariable;
 122 };
 123
 124 class ESIVariableCookie : public ESIVarState::Variable
 125 {
 126
 127 public:
 128     virtual void eval (ESIVarState &state, char const *, char const *) const;
 129 };
 130
 131 class ESIVariableHost : public ESIVarState::Variable
 132 {
 133
 134 public:
 135     virtual void eval (ESIVarState &state, char const *, char const *) const;
 136 };
 137
 138 class ESIVariableLanguage : public ESIVarState::Variable
 139 {
 140
 141 public:
 142     virtual void eval (ESIVarState &state, char const *, char const *) const;
 143 };
 144
 145 class ESIVariableQuery : public ESIVarState::Variable
 146 {
 147
 148 public:
 149     ESIVariableQuery(char const *uri);
 150     ~ESIVariableQuery();
 151     virtual void eval (ESIVarState &state, char const *, char const *) const;
 152     char const *queryString() const;
 153
 154     struct _query_elem const *queryVector() const;
 155     size_t const &queryElements() const;
 156
 157     struct _query_elem *query;
 158     size_t query_sz;
 159     size_t query_elements;
 160     char *query_string;
 161 };
 162
 163 class ESIVariableReferer : public ESIVarState::Variable
 164 {
 165
 166 public:
 167     virtual void eval (ESIVarState &state, char const *, char const *) const;
 168 };
 169
 170 class ESIVariableUserAgent : public ESIVarState::Variable
 171 {
 172
 173 public:
 174     ~ESIVariableUserAgent();
 175     ESIVariableUserAgent (ESIVarState &state);
 176     virtual void eval (ESIVarState &state, char const *, char const *) const;
 177
 178 private:
 179     static char const * esiUserOs[];
 180     enum esiUserOs_t {
 181         ESI_OS_WIN,
 182         ESI_OS_MAC,
 183         ESI_OS_UNIX,
 184         ESI_OS_OTHER
 185     };
 186     esiUserOs_t identifyOs(char const *) const;
 187     char const *browserVersion() const {return browserversion;}
 188
 189     char *getProductVersion (char const *s);
 190     esiUserOs_t UserOs;
 191     esiBrowser_t browser;
 192     char *browserversion;
 193 };
 194
 195 #endif /* SQUID_ESIVARSTATE_H */