3 * DEBUG: section 90 HTTP Cache Control Header
4 * AUTHOR: Alex Rousskov
5 * Robert Collins (Surrogate-Control is derived from
7 * Francesco Chemolli (c++ refactoring)
9 * SQUID Web Proxy Cache http://www.squid-cache.org/
10 * ----------------------------------------------------------
12 * Squid is the result of efforts by numerous individuals from
13 * the Internet community; see the CONTRIBUTORS file for full
14 * details. Many organizations have provided support for Squid's
15 * development; see the SPONSORS file for full details. Squid is
16 * Copyrighted (C) 2001 by the Regents of the University of
17 * California; see the COPYRIGHT file for full details. Squid
18 * incorporates software developed and/or copyrighted by other
19 * sources; see the CREDITS file for full details.
21 * This program is free software; you can redistribute it and/or modify
22 * it under the terms of the GNU General Public License as published by
23 * the Free Software Foundation; either version 2 of the License, or
24 * (at your option) any later version.
26 * This program is distributed in the hope that it will be useful,
27 * but WITHOUT ANY WARRANTY; without even the implied warranty of
28 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
29 * GNU General Public License for more details.
31 * You should have received a copy of the GNU General Public License
32 * along with this program; if not, write to the Free Software
33 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
38 #include "HttpHdrSc.h"
39 #include "HttpHeader.h"
40 #include "HttpHeaderFieldInfo.h"
41 #include "HttpHeaderFieldStat.h"
42 #include "HttpHeaderStat.h"
43 #include "HttpHeaderTools.h"
51 /* a row in the table used for parsing surrogate-control header and statistics */
55 HttpHeaderFieldStat stat
;
58 /* this table is used for parsing surrogate control header */
59 /* order must match that of enum http_hdr_sc_type. The constraint is verified at initialization time */
60 //todo: implement constraint
61 static const HttpHeaderFieldAttrs ScAttrs
[SC_ENUM_END
] = {
62 {"no-store", (http_hdr_type
)SC_NO_STORE
},
63 {"no-store-remote", (http_hdr_type
)SC_NO_STORE_REMOTE
},
64 {"max-age", (http_hdr_type
)SC_MAX_AGE
},
65 {"content", (http_hdr_type
)SC_CONTENT
},
66 {"Other,", (http_hdr_type
)SC_OTHER
} /* ',' will protect from matches */
69 HttpHeaderFieldInfo
*ScFieldsInfo
= NULL
;
71 http_hdr_sc_type
&operator++ (http_hdr_sc_type
&aHeader
)
73 int tmp
= (int)aHeader
;
74 aHeader
= (http_hdr_sc_type
)(++tmp
);
78 int operator - (http_hdr_sc_type
const &anSc
, http_hdr_sc_type
const &anSc2
)
80 return (int)anSc
- (int)anSc2
;
83 /* module initialization */
86 httpHdrScInitModule(void)
88 ScFieldsInfo
= httpHeaderBuildFieldsInfo(ScAttrs
, SC_ENUM_END
);
92 httpHdrScCleanModule(void)
94 httpHeaderDestroyFieldsInfo(ScFieldsInfo
, SC_ENUM_END
);
100 /* creates an sc object from a 0-terminating string */
102 httpHdrScParseCreate(const String
& str
)
104 HttpHdrSc
*sc
= new HttpHdrSc();
106 if (!sc
->parse(&str
)) {
114 /* parses a 0-terminating string and inits sc */
116 HttpHdrSc::parse(const String
* str
)
120 const char *p
; /* '=' parameter */
121 const char *pos
= NULL
;
122 const char *target
= NULL
; /* ;foo */
123 const char *temp
= NULL
; /* temp buffer */
127 HttpHdrScTarget
*sct
;
130 /* iterate through comma separated list */
132 while (strListGetItem(str
, ',', &item
, &ilen
, &pos
)) {
135 /* decrease ilen to still match the token for '=' statements */
137 if ((p
= strchr(item
, '=')) && (p
- item
< ilen
)) {
138 vlen
= ilen
- (p
+ 1 - item
);
143 /* decrease ilen to still match the token for ';' qualified non '=' statments */
144 else if ((p
= strchr(item
, ';')) && (p
- item
< ilen
)) {
150 /* TODO: use a type-safe map-based lookup */
151 type
= httpHeaderIdByName(item
, ilen
,
152 ScFieldsInfo
, SC_ENUM_END
);
155 debugs(90, 2, "hdr sc: unknown control-directive: near '" << item
<< "' in '" << str
<< "'");
159 /* Is this a targeted directive? */
160 /* TODO: remove the temporary useage and use memrchr and the information we have instead */
161 temp
= xstrndup (item
, initiallen
+ 1);
163 if (!((target
= strrchr (temp
, ';')) && !strchr (target
, '"') && *(target
+ 1) != '\0'))
168 sct
= sc
->findTarget(target
);
171 sct
= new HttpHdrScTarget(target
);
177 if (sct
->isSet(static_cast<http_hdr_sc_type
>(type
))) {
178 if (type
!= SC_OTHER
)
179 debugs(90, 2, "hdr sc: ignoring duplicate control-directive: near '" << item
<< "' in '" << str
<< "'");
181 ++ ScFieldsInfo
[type
].stat
.repCount
;
186 /* process directives */
192 case SC_NO_STORE_REMOTE
:
193 sct
->noStoreRemote(true);
198 if (p
&& httpHeaderParseInt(p
, &ma
)) {
201 debugs(90, 2, "sc: invalid max-age specs near '" << item
<< "'");
205 if ((p
= strchr (p
, '+'))) {
207 ++p
; //skip the + char
208 if (httpHeaderParseInt(p
, &ms
)) {
211 debugs(90, 2, "sc: invalid max-stale specs near '" << item
<< "'");
212 sct
->clearMaxStale();
213 /* leave the max-age alone */
221 if ( p
&& httpHeaderParseQuotedString(p
, vlen
, &sct
->content_
)) {
222 sct
->setMask(SC_CONTENT
,true); // ugly but saves a copy
224 debugs(90, 2, "sc: invalid content= quoted string near '" << item
<< "'");
235 return sc
->targets
.head
!= NULL
;
238 HttpHdrSc::~HttpHdrSc()
241 dlink_node
*sct
= targets
.head
;
244 HttpHdrScTarget
*t
= static_cast<HttpHdrScTarget
*>(sct
->data
);
246 dlinkDelete (&t
->node
, &targets
);
252 HttpHdrSc::HttpHdrSc(const HttpHdrSc
&sc
)
254 dlink_node
*node
= sc
.targets
.head
;
257 HttpHdrScTarget
*dupsct
= new HttpHdrScTarget(*static_cast<HttpHdrScTarget
*>(node
->data
));
258 addTargetAtTail(dupsct
);
264 HttpHdrScTarget::packInto(Packer
* p
) const
266 http_hdr_sc_type flag
;
270 for (flag
= SC_NO_STORE
; flag
< SC_ENUM_END
; ++flag
) {
271 if (isSet(flag
) && flag
!= SC_OTHER
) {
273 /* print option name */
274 packerPrintf(p
, (pcount
? ", " SQUIDSTRINGPH
: SQUIDSTRINGPH
),
275 SQUIDSTRINGPRINT(ScFieldsInfo
[flag
].name
));
277 /* handle options with values */
279 if (flag
== SC_MAX_AGE
)
280 packerPrintf(p
, "=%d", (int) max_age
);
282 if (flag
== SC_CONTENT
)
283 packerPrintf(p
, "=\"" SQUIDSTRINGPH
"\"", SQUIDSTRINGPRINT(content_
));
290 packerPrintf (p
, ";" SQUIDSTRINGPH
, SQUIDSTRINGPRINT(target
));
294 HttpHdrSc::packInto(Packer
* p
) const
301 static_cast<HttpHdrScTarget
*>(node
->data
)->packInto(p
);
306 /* negative max_age will clean old max_Age setting */
308 HttpHdrSc::setMaxAge(char const *target
, int max_age
)
310 HttpHdrScTarget
*sct
= findTarget(target
);
313 sct
= new HttpHdrScTarget(target
);
314 dlinkAddTail (sct
, &sct
->node
, &targets
);
317 sct
->maxAge(max_age
);
321 HttpHdrSc::updateStats(StatHist
* hist
) const
323 dlink_node
*sct
= targets
.head
;
326 static_cast<HttpHdrScTarget
*>(sct
->data
)->updateStats(hist
);
332 httpHdrScTargetStatDumper(StoreEntry
* sentry
, int idx
, double val
, double size
, int count
)
334 extern const HttpHeaderStat
*dump_stat
; /* argh! */
335 const int id
= (int) val
;
336 const int valid_id
= id
>= 0 && id
< SC_ENUM_END
;
337 const char *name
= valid_id
? ScFieldsInfo
[id
].name
.termedBuf() : "INVALID";
339 if (count
|| valid_id
)
340 storeAppendPrintf(sentry
, "%2d\t %-20s\t %5d\t %6.2f\n",
341 id
, name
, count
, xdiv(count
, dump_stat
->scParsedCount
));
345 httpHdrScStatDumper(StoreEntry
* sentry
, int idx
, double val
, double size
, int count
)
347 extern const HttpHeaderStat
*dump_stat
; /* argh! */
348 const int id
= (int) val
;
349 const int valid_id
= id
>= 0 && id
< SC_ENUM_END
;
350 const char *name
= valid_id
? ScFieldsInfo
[id
].name
.termedBuf() : "INVALID";
352 if (count
|| valid_id
)
353 storeAppendPrintf(sentry
, "%2d\t %-20s\t %5d\t %6.2f\n",
354 id
, name
, count
, xdiv(count
, dump_stat
->scParsedCount
));
358 HttpHdrSc::findTarget(const char *target
)
364 HttpHdrScTarget
*sct
= (HttpHdrScTarget
*)node
->data
;
366 if (target
&& sct
->target
.defined() && !strcmp (target
, sct
->target
.termedBuf()))
368 else if (!target
&& sct
->target
.undefined())
378 HttpHdrSc::getMergedTarget(const char *ourtarget
)
380 HttpHdrScTarget
*sctus
= findTarget(ourtarget
);
381 HttpHdrScTarget
*sctgeneric
= findTarget(NULL
);
383 if (sctgeneric
|| sctus
) {
384 HttpHdrScTarget
*sctusable
= new HttpHdrScTarget(NULL
);
387 sctusable
->mergeWith(sctgeneric
);
390 sctusable
->mergeWith(sctus
);