1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
|
/*
*
* SQUID Web Proxy Cache http://www.squid-cache.org/
* ----------------------------------------------------------
*
* Squid is the result of efforts by numerous individuals from
* the Internet community; see the CONTRIBUTORS file for full
* details. Many organizations have provided support for Squid's
* development; see the SPONSORS file for full details. Squid is
* Copyrighted (C) 2001 by the Regents of the University of
* California; see the COPYRIGHT file for full details. Squid
* incorporates software developed and/or copyrighted by other
* sources; see the CREDITS file for full details.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
*
* Copyright (c) 2003, Robert Collins <robertc@squid-cache.org>
*/
#ifndef SQUID_ESICONTEXT_H
#define SQUID_ESICONTEXT_H
#include "esi/Parser.h"
#include "esi/Element.h"
#include "clientStream.h"
#include "err_type.h"
#include "HttpReply.h"
#include "http/StatusCode.h"
class ESIVarState;
class ClientHttpRequest;
/* ESIContext */
class ESIContext : public esiTreeParent, public ESIParserClient
{
public:
typedef RefCount<ESIContext> Pointer;
ESIContext() :
thisNode(NULL),
http(NULL),
errorpage(ERR_NONE),
errorstatus(Http::scNone),
errormessage(NULL),
rep(NULL),
outbound_offset(0),
readpos(0),
pos(0),
varState(NULL),
cachedASTInUse(false),
reading_(true),
processing(false) {
memset(&flags, 0, sizeof(flags));
}
~ESIContext();
enum esiKick_t {
ESI_KICK_FAILED,
ESI_KICK_PENDING,
ESI_KICK_SENT,
ESI_KICK_INPROGRESS
};
/* when esi processing completes */
void provideData(ESISegment::Pointer, ESIElement *source);
void fail (ESIElement *source, char const*anError = NULL);
void startRead();
void finishRead();
bool reading() const;
void setError();
void setErrorMessage(char const *);
void addStackElement (ESIElement::Pointer element);
void addLiteral (const char *s, int len);
void finishChildren ();
clientStreamNode *thisNode; /* our stream node */
/* the request we are processing. HMM: cbdataReferencing this will result
* in a circular reference, so we don't. Note: we are automatically freed
* when it is, so thats ok. */
ClientHttpRequest *http;
struct {
int passthrough:1;
int oktosend:1;
int finished:1;
/* an error has occured, send full body replies
* regardless. Note that we don't fail midstream
* because we buffer until we can not fail
*/
int error:1;
int finishedtemplate:1; /* we've read the entire template */
int clientwantsdata:1; /* we need to satisfy a read request */
int kicked:1; /* note on reentering the kick routine */
int detached:1; /* our downstream has detached */
} flags;
err_type errorpage; /* if we error what page to use */
Http::StatusCode errorstatus; /* if we error, what code to return */
char *errormessage; /* error to pass to error page */
HttpReply::Pointer rep; /* buffered until we pass data downstream */
ESISegment::Pointer buffered; /* unprocessed data - for whatever reason */
ESISegment::Pointer incoming;
/* processed data we are waiting to send, or for
* potential errors to be resolved
*/
ESISegment::Pointer outbound;
ESISegment::Pointer outboundtail; /* our write segment */
/* the offset to the next character to send -
* non zero if we haven't sent the entire segment
* for some reason
*/
size_t outbound_offset;
int64_t readpos; /* the logical position we are reading from */
int64_t pos; /* the logical position of outbound_offset in the data stream */
class ParserState
{
public:
ESIElement::Pointer stack[10]; /* a stack of esi elements that are open */
int stackdepth; /* self explanatory */
ESIParser::Pointer theParser;
ESIElement::Pointer top();
void init (ESIParserClient *);
bool inited() const;
ParserState();
void freeResources();
void popAll();
int parsing:1; /* libexpat is not reentrant on the same context */
private:
bool inited_;
}
parserState; /* todo factor this off somewhere else; */
ESIVarState *varState;
ESIElement::Pointer tree;
esiKick_t kick ();
RefCount<ESIContext> cbdataLocker;
bool failed() const {return flags.error != 0;}
bool cachedASTInUse;
private:
void fail ();
void freeResources();
void fixupOutboundTail();
void trimBlanks();
size_t send ();
bool reading_;
void appendOutboundData(ESISegment::Pointer theData);
esiProcessResult_t process ();
void parse();
void parseOneBuffer();
void updateCachedAST();
bool hasCachedAST() const;
void getCachedAST();
virtual void start(const char *el, const char **attr, size_t attrCount);
virtual void end(const char *el);
virtual void parserDefault (const char *s, int len);
virtual void parserComment (const char *s);
bool processing;
CBDATA_CLASS2(ESIContext);
};
#endif /* SQUID_ESICONTEXT_H */
|
