src/ESIVarState.h

   1
   2 /*
   3  * $Id: ESIVarState.h,v 1.4 2007/05/29 13:31:37 amosjeffries Exp $
   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_ESIVARSTATE_H
  35 #define SQUID_ESIVARSTATE_H
  36
  37 #include "ESISegment.h"
  38 #include "Trie.h"
  39 #include "Array.h"
  40 #include "HttpHeader.h"
  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     {
  91         int language:1;
  92         int cookie:1;
  93         int host:1;
  94         int referer:1;
  95         int useragent:1;
  96     } flags;
  97
  98 public:
  99
 100     class Variable
 101     {
 102
 103     public:
 104         Variable () {}
 105
 106         virtual ~Variable(){}
 107
 108         /* prevent synthetics */
 109         Variable (Variable const &) {}
 110
 111         Variable &operator= (Variable const &);
 112         virtual void eval (ESIVarState &state, char const *, char const *) const;
 113     };
 114
 115     Variable* GetVar(char const *s, int len);
 116
 117 private:
 118     void doIt ();
 119     void setupUserAgent();
 120     Trie variables;
 121     Vector<Variable*> variablesForCleanup;
 122     Variable *defaultVariable;
 123 };
 124
 125 class ESIVariableCookie : public ESIVarState::Variable
 126 {
 127
 128 public:
 129     virtual void eval (ESIVarState &state, char const *, char const *) const;
 130 };
 131
 132 class ESIVariableHost : public ESIVarState::Variable
 133 {
 134
 135 public:
 136     virtual void eval (ESIVarState &state, char const *, char const *) const;
 137 };
 138
 139 class ESIVariableLanguage : public ESIVarState::Variable
 140 {
 141
 142 public:
 143     virtual void eval (ESIVarState &state, char const *, char const *) const;
 144 };
 145
 146 class ESIVariableQuery : public ESIVarState::Variable
 147 {
 148
 149 public:
 150     ESIVariableQuery(char const *uri);
 151     ~ESIVariableQuery();
 152     virtual void eval (ESIVarState &state, char const *, char const *) const;
 153     char const *queryString() const;
 154
 155     struct _query_elem const *queryVector() const;
 156     size_t const &queryElements() const;
 157
 158     struct _query_elem *query;
 159     size_t query_sz;
 160     size_t query_elements;
 161     char *query_string;
 162 };
 163
 164 class ESIVariableReferer : public ESIVarState::Variable
 165 {
 166
 167 public:
 168     virtual void eval (ESIVarState &state, char const *, char const *) const;
 169 };
 170
 171 class ESIVariableUserAgent : public ESIVarState::Variable
 172 {
 173
 174 public:
 175     ~ESIVariableUserAgent();
 176     ESIVariableUserAgent (ESIVarState &state);
 177     virtual void eval (ESIVarState &state, char const *, char const *) const;
 178
 179 private:
 180     static char const * esiUserOs[];
 181     enum esiUserOs_t{
 182         ESI_OS_WIN,
 183         ESI_OS_MAC,
 184         ESI_OS_UNIX,
 185         ESI_OS_OTHER
 186     };
 187     esiUserOs_t identifyOs(char const *) const;
 188     char const *browserVersion() const {return browserversion;}
 189
 190     char *getProductVersion (char const *s);
 191     esiUserOs_t UserOs;
 192     esiBrowser_t browser;
 193     char *browserversion;
 194 };
 195
 196
 197
 198 #endif /* SQUID_ESIVARSTATE_H */