GCOV - Varnish Cache


/*-
 * Copyright (c) 2006 Verdens Gang AS
 * Copyright (c) 2006-2016 Varnish Software AS
 * All rights reserved.
 *
 * Author: Poul-Henning Kamp <phk@phk.freebsd.dk>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 */

#include "config.h"

#include <stdio.h>
#include <stdint.h>
#include <stdlib.h>

#include "cache_varnishd.h"
#include "cache_vcl.h"
#include "vrt_obj.h"

#include "vct.h"

#include "cache_filter.h"

/*--------------------------------------------------------------------
 */

struct vfilter {
        unsigned                        magic;
#define VFILTER_MAGIC                   0xd40894e9
        const struct vfp                *vfp;
        const struct vdp                *vdp;
        const char                      *name;
        int                             nlen;
        VTAILQ_ENTRY(vfilter)           list;
};

static struct vfilter_head vrt_filters =
    VTAILQ_HEAD_INITIALIZER(vrt_filters);

static const char *
is_dup_filter(const struct vfilter_head *head, const struct vfp * vfp,
    const struct vdp *vdp, const char *name)
{
        struct vfilter *vp;
        VTAILQ_FOREACH(vp, head, list) {
                if (vfp != NULL && vp->vfp != NULL) {
                        if (vp->vfp == vfp)
                                return ("VFP already registered");
                        if (!strcasecmp(vp->name, name))
                                return ("VFP name already used");
                }
                if (vdp != NULL && vp->vdp != NULL) {
                        if (vp->vdp == vdp)
                                return ("VDP already registered");
                        if (!strcasecmp(vp->name, name))
                                return ("VDP name already used");
                }
        }
        return (NULL);
}

static const char *
vrt_addfilter(VRT_CTX, const struct vfp *vfp, const struct vdp *vdp)
{
        struct vfilter *vp;
        struct vfilter_head *hd = &vrt_filters;
        const char *err, *name = NULL;

        CHECK_OBJ_ORNULL(ctx, VRT_CTX_MAGIC);
        assert(vfp != NULL || vdp != NULL);
        assert(vfp == NULL || vfp->name != NULL);
        assert(vdp == NULL || vdp->name != NULL);
        assert(vfp == NULL || vdp == NULL || !strcasecmp(vfp->name, vdp->name));
        if (vfp != NULL)
                name = vfp->name;
        else if (vdp != NULL)
                name = vdp->name;
        AN(name);

        err = is_dup_filter(hd, vfp, vdp, name);
        if (err != NULL) {
                if (ctx != NULL)
                        VRT_fail(ctx, "%s: %s (global)", name, err);
                return (err);
        }
        if (ctx != NULL) {
                ASSERT_CLI();
                CHECK_OBJ_NOTNULL(ctx->vcl, VCL_MAGIC);
                hd = &ctx->vcl->filters;
                err = is_dup_filter(hd, vfp, vdp, name);
                if (err != NULL) {
                        VRT_fail(ctx, "%s: %s (per-vcl)", name, err);
                        return (err);
                }
        }

        ALLOC_OBJ(vp, VFILTER_MAGIC);
        AN(vp);
        vp->vfp = vfp;
        vp->vdp = vdp;
        vp->name = name;
        vp->nlen = strlen(name);
        VTAILQ_INSERT_TAIL(hd, vp, list);
        return (err);
}

const char *
VRT_AddFilter(VRT_CTX, const struct vfp *vfp, const struct vdp *vdp)
{

        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
        return (vrt_addfilter(ctx, vfp, vdp));
}

void
VRT_RemoveFilter(VRT_CTX, const struct vfp *vfp, const struct vdp *vdp)
{
        struct vfilter *vp;
        struct vfilter_head *hd;

        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
        CHECK_OBJ_NOTNULL(ctx->vcl, VCL_MAGIC);
        hd = &ctx->vcl->filters;
        assert(vfp != NULL || vdp != NULL);
        assert(vfp == NULL || vfp->name != NULL);
        assert(vdp == NULL || vdp->name != NULL);
        assert(vfp == NULL || vdp == NULL || !strcasecmp(vfp->name, vdp->name));

        ASSERT_CLI();
        VTAILQ_FOREACH(vp, hd, list) {
                CHECK_OBJ_NOTNULL(vp, VFILTER_MAGIC);
                if (vp->vfp == vfp && vp->vdp == vdp)
                        break;
        }
        AN(vp);
        assert(vfp == NULL || !strcasecmp(vfp->name, vp->name));
        assert(vdp == NULL || !strcasecmp(vdp->name, vp->name));
        VTAILQ_REMOVE(hd, vp, list);
        FREE_OBJ(vp);
}

static const struct vfilter vfilter_error[1] = {{0}};

static const struct vfilter *
vcl_filter_list_iter(int want_vfp, const struct vfilter_head *h1,
    const struct vfilter_head *h2, const char **flp)
{
        const char *fl, *q;
        const struct vfilter *vp;

        AN(h1);
        AN(h2);
        AN(flp);

        fl = *flp;
        AN(fl);

        while (vct_isspace(*fl))
                fl++;
        if (*fl == '\0') {
                *flp = NULL;
                return (NULL);
        }
        for (q = fl; *q && !vct_isspace(*q); q++)
                continue;
        *flp = q;
        VTAILQ_FOREACH(vp, h1, list) {
                if (want_vfp && vp->vfp == NULL)
                        continue;
                else if (!want_vfp && vp->vdp == NULL)
                        continue;
                if (vp->nlen == q - fl && !memcmp(fl, vp->name, vp->nlen))
                        return (vp);
        }
        VTAILQ_FOREACH(vp, h2, list) {
                if (want_vfp && vp->vfp == NULL)
                        continue;
                else if (!want_vfp && vp->vdp == NULL)
                        continue;
                if (vp->nlen == q - fl && !memcmp(fl, vp->name, vp->nlen))
                        return (vp);
        }
        *flp = fl;
        return (vfilter_error);
}

int
VCL_StackVFP(struct vfp_ctx *vc, const struct vcl *vcl, const char *fl)
{
        const struct vfilter *vp;

        AN(fl);
        VSLbs(vc->wrk->vsl, SLT_Filters, TOSTRAND(fl));

        while (1) {
                vp = vcl_filter_list_iter(1, &vrt_filters, &vcl->filters, &fl);
                if (vp == NULL)
                        return (0);
                if (vp == vfilter_error)
                        return (VFP_Error(vc, "Filter '...%s' not found", fl));
                if (VFP_Push(vc, vp->vfp) == NULL)
                        return (-1);
        }
}

int
VCL_StackVDP(struct vdp_ctx *vdc, const struct vcl *vcl, const char *fl,
    struct req *req, struct busyobj *bo)
{
        const struct vfilter *vp;
        struct vrt_ctx ctx[1];

        CHECK_OBJ_NOTNULL(vdc, VDP_CTX_MAGIC);
        AN(vcl);
        AN(fl);

        CHECK_OBJ_ORNULL(req, REQ_MAGIC);
        CHECK_OBJ_ORNULL(bo, BUSYOBJ_MAGIC);

        assert((req ? 1 : 0) ^ (bo ? 1 : 0));

        VSLbs(vdc->vsl, SLT_Filters, TOSTRAND(fl));
        INIT_OBJ(ctx, VRT_CTX_MAGIC);

        if (req)
                VCL_Req2Ctx(ctx, req);
        else
                VCL_Bo2Ctx(ctx, bo);

        while (1) {
                vp = vcl_filter_list_iter(0, &vrt_filters, &vcl->filters, &fl);
                if (vp == NULL)
                        return (0);
                if (vp == vfilter_error) {
                        VSLb(ctx->vsl, SLT_Error,
                            "Filter '...%s' not found", fl);
                        return (-1);
                }
                if (VDP_Push(ctx, vdc, ctx->ws, vp->vdp, NULL))
                        return (-1);
        }
}

void
VCL_VRT_Init(void)
{
        AZ(vrt_addfilter(NULL, &VFP_testgunzip, NULL));
        AZ(vrt_addfilter(NULL, &VFP_gunzip, NULL));
        AZ(vrt_addfilter(NULL, &VFP_gzip, NULL));
        AZ(vrt_addfilter(NULL, &VFP_esi, NULL));
        AZ(vrt_addfilter(NULL, &VFP_esi_gzip, NULL));
        AZ(vrt_addfilter(NULL, NULL, &VDP_esi));
        AZ(vrt_addfilter(NULL, NULL, &VDP_gunzip));
        AZ(vrt_addfilter(NULL, NULL, &VDP_range));
}

/*--------------------------------------------------------------------
 */

typedef void filter_list_t(void *, struct vsb *vsb);

static const char *
filter_on_ws(struct ws *ws, filter_list_t *func, void *arg)
{
        struct vsb vsb[1];
        const char *p;

        AN(func);
        AN(arg);
        WS_VSB_new(vsb, ws);
        func(arg, vsb);
        p = WS_VSB_finish(vsb, ws, NULL);
        if (p == NULL)
                p = "";
        return (p);
}

/*--------------------------------------------------------------------
 */

static void v_matchproto_(filter_list_t)
vbf_default_filter_list(void *arg, struct vsb *vsb)
{
        const struct busyobj *bo;
        const char *p;
        int do_gzip, do_gunzip, is_gzip = 0, is_gunzip = 0;

        CAST_OBJ_NOTNULL(bo, arg, BUSYOBJ_MAGIC);

        do_gzip = bo->do_gzip;
        do_gunzip = bo->do_gunzip;

        /*
         * The VCL variables beresp.do_g[un]zip tells us how we want the
         * object processed before it is stored.
         *
         * The backend Content-Encoding header tells us what we are going
         * to receive, which we classify in the following three classes:
         *
         *      "Content-Encoding: gzip"        --> object is gzipped.
         *      no Content-Encoding             --> object is not gzipped.
         *      anything else                   --> do nothing wrt gzip
         */

        /* No body -> done */
        if (bo->htc->body_status == BS_NONE || bo->htc->content_length == 0)
                return;

        if (!cache_param->http_gzip_support)
                do_gzip = do_gunzip = 0;

        if (http_GetHdr(bo->beresp, H_Content_Encoding, &p))
                is_gzip = !strcasecmp(p, "gzip");
        else
                is_gunzip = 1;

        /* We won't gunzip unless it is gzipped */
        if (do_gunzip && !is_gzip)
                do_gunzip = 0;

        /* We wont gzip unless if it already is gzipped */
        if (do_gzip && !is_gunzip)
                do_gzip = 0;

        if (do_gunzip || (is_gzip && bo->do_esi))
                VSB_cat(vsb, " gunzip");

        if (bo->do_esi && (do_gzip || (is_gzip && !do_gunzip))) {
                VSB_cat(vsb, " esi_gzip");
                return;
        }

        if (bo->do_esi) {
                VSB_cat(vsb, " esi");
                return;
        }

        if (do_gzip)
                VSB_cat(vsb, " gzip");

        if (is_gzip && !do_gunzip)
                VSB_cat(vsb, " testgunzip");
}

const char *
VBF_Get_Filter_List(struct busyobj *bo)
{

        CHECK_OBJ_NOTNULL(bo, BUSYOBJ_MAGIC);
        return (filter_on_ws(bo->ws, vbf_default_filter_list, bo));
}

static const char *
bereq_Empty_Filter(struct busyobj *bo)
{

        CHECK_OBJ_NOTNULL(bo, BUSYOBJ_MAGIC);
        return ("");
}

/*--------------------------------------------------------------------
 */

static void v_matchproto_(filter_list_t)
resp_default_filter_list(void *arg, struct vsb *vsb)
{
        struct req *req;

        CAST_OBJ_NOTNULL(req, arg, REQ_MAGIC);

        if (!req->disable_esi && req->objcore != NULL &&
            ObjHasAttr(req->wrk, req->objcore, OA_ESIDATA))
                VSB_cat(vsb, " esi");

        if (cache_param->http_gzip_support &&
            req->objcore != NULL &&
            ObjCheckFlag(req->wrk, req->objcore, OF_GZIPED) &&
            !RFC2616_Req_Gzip(req->http))
                VSB_cat(vsb, " gunzip");

        if (cache_param->http_range_support &&
            http_GetStatus(req->resp) == 200 &&
            http_GetHdr(req->http, H_Range, NULL))
                VSB_cat(vsb, " range");
}

const char *
resp_Get_Filter_List(struct req *req)
{

        CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
        return (filter_on_ws(req->ws, resp_default_filter_list, req));
}

static const char *
req_Empty_Filter(struct req *req)
{

        CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
        return ("");
}

/*--------------------------------------------------------------------
 * control if "set req.filters" is allowed
 *
 * req.body (conversely to other body object) is one where VCL has control over
 * when it gets processed by means of std.cache_req_body(): Filters act on the
 * received body when that function is called, so confusion could be caused if
 * people expect filters to have an effect when set/changed after the req.body
 * is already cached.
 */

static int
req_filter_can(struct req *req)
{

        CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
        return (req->req_body_status->avail == 1);
}

/*--------------------------------------------------------------------*/

//lint -emacro(506, FILTER_VAR) constant value boolean
//lint -emacro(774, FILTER_VAR) if always evaluates to false
#define FILTER_VAR(vcl, in, func, cond, fld)                            \
        VCL_STRING                                                      \
        VRT_r_##vcl##_filters(VRT_CTX)                                  \
        {                                                               \
                                                                        \
                CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);                  \
                if (ctx->in->fld != NULL)                               \
                        return(ctx->in->fld);                           \
                return (func(ctx->in));                                 \
        }                                                               \
                                                                        \
        VCL_VOID                                                        \
        VRT_l_##vcl##_filters(VRT_CTX, const char *str, VCL_STRANDS s)  \
        {                                                               \
                const char *b;                                          \
                                                                        \
                (void)str;                                              \
                CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);                  \
                if (! (cond)) {                                         \
                        VRT_fail(ctx, #vcl ".filters not settable");    \
                        return;                                         \
                }                                                       \
                b = VRT_StrandsWS(ctx->in->ws, str, s);                 \
                if (b == NULL)                                          \
                        WS_MarkOverflow(ctx->in->ws);                   \
                else                                                    \
                        ctx->in->fld = b;                               \
        }

FILTER_VAR(bereq, bo, bereq_Empty_Filter, 1, vdp_filter_list)
FILTER_VAR(beresp, bo, VBF_Get_Filter_List, 1, vfp_filter_list)
FILTER_VAR(req, req, req_Empty_Filter, req_filter_can(ctx->req), vfp_filter_list)
FILTER_VAR(resp, req, resp_Get_Filter_List, 1, vdp_filter_list)

		varnish-cache/bin/varnishd/cache/cache_vrt_filter.c
0		/*-
1		* Copyright (c) 2006 Verdens Gang AS
2		* Copyright (c) 2006-2016 Varnish Software AS
3		* All rights reserved.
4		*
5		* Author: Poul-Henning Kamp <phk@phk.freebsd.dk>
6		*
7		* SPDX-License-Identifier: BSD-2-Clause
8		*
9		* Redistribution and use in source and binary forms, with or without
10		* modification, are permitted provided that the following conditions
11		* are met:
12		* 1. Redistributions of source code must retain the above copyright
13		* notice, this list of conditions and the following disclaimer.
14		* 2. Redistributions in binary form must reproduce the above copyright
15		* notice, this list of conditions and the following disclaimer in the
16		* documentation and/or other materials provided with the distribution.
17		*
18		* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19		* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20		* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21		* ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
22		* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23		* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24		* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25		* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26		* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27		* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28		* SUCH DAMAGE.
29		*
30		*/
31
32		#include "config.h"
33
34		#include <stdio.h>
35		#include <stdint.h>
36		#include <stdlib.h>
37
38		#include "cache_varnishd.h"
39		#include "cache_vcl.h"
40		#include "vrt_obj.h"
41
42		#include "vct.h"
43
44		#include "cache_filter.h"
45
46		/*--------------------------------------------------------------------
47		*/
48
49		struct vfilter {
50		unsigned magic;
51		#define VFILTER_MAGIC 0xd40894e9
52		const struct vfp *vfp;
53		const struct vdp *vdp;
54		const char *name;
55		int nlen;
56		VTAILQ_ENTRY(vfilter) list;
57		};
58
59		static struct vfilter_head vrt_filters =
60		VTAILQ_HEAD_INITIALIZER(vrt_filters);
61
62		static const char *
63	374064	is_dup_filter(const struct vfilter_head head, const struct vfp vfp,
64		const struct vdp vdp, const char name)
65		{
66		struct vfilter *vp;
67	1840288	VTAILQ_FOREACH(vp, head, list) {
68	1466264	if (vfp != NULL && vp->vfp != NULL) {
69	428480	if (vp->vfp == vfp)
70	40	return ("VFP already registered");
71	428440	if (!strcasecmp(vp->name, name))
72	0	return ("VFP name already used");
73	428440	}
74	1466224	if (vdp != NULL && vp->vdp != NULL) {
75	340924	if (vp->vdp == vdp)
76	0	return ("VDP already registered");
77	340924	if (!strcasecmp(vp->name, name))
78	0	return ("VDP name already used");
79	340924	}
80	1466224	}
81	374024	return (NULL);
82	374064	}
83
84		static const char *
85	339144	vrt_addfilter(VRT_CTX, const struct vfp vfp, const struct vdp vdp)
86		{
87		struct vfilter *vp;
88	339144	struct vfilter_head *hd = &vrt_filters;
89	339144	const char err, name = NULL;
90
91	339144	CHECK_OBJ_ORNULL(ctx, VRT_CTX_MAGIC);
92	339144	assert(vfp != NULL \|\| vdp != NULL);
93	339144	assert(vfp == NULL \|\| vfp->name != NULL);
94	339144	assert(vdp == NULL \|\| vdp->name != NULL);
95	339144	assert(vfp == NULL \|\| vdp == NULL \|\| !strcasecmp(vfp->name, vdp->name));
96	339144	if (vfp != NULL)
97	198900	name = vfp->name;
98	140244	else if (vdp != NULL)
99	140244	name = vdp->name;
100	339144	AN(name);
101
102	339144	err = is_dup_filter(hd, vfp, vdp, name);
103	339144	if (err != NULL) {
104	0	if (ctx != NULL)
105	0	VRT_fail(ctx, "%s: %s (global)", name, err);
106	0	return (err);
107		}
108	339144	if (ctx != NULL) {
109	34920	ASSERT_CLI();
110	34920	CHECK_OBJ_NOTNULL(ctx->vcl, VCL_MAGIC);
111	34920	hd = &ctx->vcl->filters;
112	34920	err = is_dup_filter(hd, vfp, vdp, name);
113	34920	if (err != NULL) {
114	40	VRT_fail(ctx, "%s: %s (per-vcl)", name, err);
115	40	return (err);
116		}
117	34880	}
118
119	339104	ALLOC_OBJ(vp, VFILTER_MAGIC);
120	339104	AN(vp);
121	339104	vp->vfp = vfp;
122	339104	vp->vdp = vdp;
123	339104	vp->name = name;
124	339104	vp->nlen = strlen(name);
125	339104	VTAILQ_INSERT_TAIL(hd, vp, list);
126	339104	return (err);
127	339144	}
128
129		const char *
130	34920	VRT_AddFilter(VRT_CTX, const struct vfp vfp, const struct vdp vdp)
131		{
132
133	34920	CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
134	34920	return (vrt_addfilter(ctx, vfp, vdp));
135		}
136
137		void
138	7360	VRT_RemoveFilter(VRT_CTX, const struct vfp vfp, const struct vdp vdp)
139		{
140		struct vfilter *vp;
141		struct vfilter_head *hd;
142
143	7360	CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
144	7360	CHECK_OBJ_NOTNULL(ctx->vcl, VCL_MAGIC);
145	7360	hd = &ctx->vcl->filters;
146	7360	assert(vfp != NULL \|\| vdp != NULL);
147	7360	assert(vfp == NULL \|\| vfp->name != NULL);
148	7360	assert(vdp == NULL \|\| vdp->name != NULL);
149	7360	assert(vfp == NULL \|\| vdp == NULL \|\| !strcasecmp(vfp->name, vdp->name));
150
151	7360	ASSERT_CLI();
152	10120	VTAILQ_FOREACH(vp, hd, list) {
153	10120	CHECK_OBJ_NOTNULL(vp, VFILTER_MAGIC);
154	10120	if (vp->vfp == vfp && vp->vdp == vdp)
155	7360	break;
156	2760	}
157	7360	AN(vp);
158	7360	assert(vfp == NULL \|\| !strcasecmp(vfp->name, vp->name));
159	7360	assert(vdp == NULL \|\| !strcasecmp(vdp->name, vp->name));
160	7360	VTAILQ_REMOVE(hd, vp, list);
161	7360	FREE_OBJ(vp);
162	7360	}
163
164		static const struct vfilter vfilter_error[1] = {{0}};
165
166		static const struct vfilter *
167	269440	vcl_filter_list_iter(int want_vfp, const struct vfilter_head *h1,
168		const struct vfilter_head h2, const char *flp)
169		{
170		const char fl, q;
171		const struct vfilter *vp;
172
173	269440	AN(h1);
174	269440	AN(h2);
175	269440	AN(flp);
176
177	269440	fl = *flp;
178	269440	AN(fl);
179
180	314840	while (vct_isspace(*fl))
181	45400	fl++;
182	269440	if (*fl == '\0') {
183	222361	*flp = NULL;
184	222361	return (NULL);
185		}
186	391718	for (q = fl; q && !vct_isspace(q); q++)
187	344639	continue;
188	47079	*flp = q;
189	281870	VTAILQ_FOREACH(vp, h1, list) {
190	268511	if (want_vfp && vp->vfp == NULL)
191	1680	continue;
192	266831	else if (!want_vfp && vp->vdp == NULL)
193	136794	continue;
194	130037	if (vp->nlen == q - fl && !memcmp(fl, vp->name, vp->nlen))
195	33720	return (vp);
196	96317	}
197	29838	VTAILQ_FOREACH(vp, h2, list) {
198	29718	if (want_vfp && vp->vfp == NULL)
199	560	continue;
200	29158	else if (!want_vfp && vp->vdp == NULL)
201	0	continue;
202	29158	if (vp->nlen == q - fl && !memcmp(fl, vp->name, vp->nlen))
203	13239	return (vp);
204	15919	}
205	120	*flp = fl;
206	120	return (vfilter_error);
207	269440	}
208
209		int
210	77873	VCL_StackVFP(struct vfp_ctx vc, const struct vcl vcl, const char *fl)
211		{
212		const struct vfilter *vp;
213
214	77873	AN(fl);
215	77873	VSLbs(vc->wrk->vsl, SLT_Filters, TOSTRAND(fl));
216
217	96633	while (1) {
218	96633	vp = vcl_filter_list_iter(1, &vrt_filters, &vcl->filters, &fl);
219	96633	if (vp == NULL)
220	76913	return (0);
221	19720	if (vp == vfilter_error)
222	80	return (VFP_Error(vc, "Filter '...%s' not found", fl));
223	19640	if (VFP_Push(vc, vp->vfp) == NULL)
224	880	return (-1);
225		}
226	77873	}
227
228		int
229	147967	VCL_StackVDP(struct vdp_ctx vdc, const struct vcl vcl, const char *fl,
230		struct req req, struct busyobj bo)
231		{
232		const struct vfilter *vp;
233		struct vrt_ctx ctx[1];
234
235	147967	CHECK_OBJ_NOTNULL(vdc, VDP_CTX_MAGIC);
236	147967	AN(vcl);
237	147967	AN(fl);
238
239	147967	CHECK_OBJ_ORNULL(req, REQ_MAGIC);
240	147967	CHECK_OBJ_ORNULL(bo, BUSYOBJ_MAGIC);
241
242	147967	assert((req ? 1 : 0) ^ (bo ? 1 : 0));
243
244	147967	VSLbs(vdc->vsl, SLT_Filters, TOSTRAND(fl));
245	147967	INIT_OBJ(ctx, VRT_CTX_MAGIC);
246
247	147967	if (req)
248	147647	VCL_Req2Ctx(ctx, req);
249		else
250	320	VCL_Bo2Ctx(ctx, bo);
251
252	172807	while (1) {
253	172807	vp = vcl_filter_list_iter(0, &vrt_filters, &vcl->filters, &fl);
254	172807	if (vp == NULL)
255	145447	return (0);
256	27360	if (vp == vfilter_error) {
257	80	VSLb(ctx->vsl, SLT_Error,
258	40	"Filter '...%s' not found", fl);
259	40	return (-1);
260		}
261	27320	if (VDP_Push(ctx, vdc, ctx->ws, vp->vdp, NULL))
262	2480	return (-1);
263		}
264	147967	}
265
266		void
267	38028	VCL_VRT_Init(void)
268		{
269	38028	AZ(vrt_addfilter(NULL, &VFP_testgunzip, NULL));
270	38028	AZ(vrt_addfilter(NULL, &VFP_gunzip, NULL));
271	38028	AZ(vrt_addfilter(NULL, &VFP_gzip, NULL));
272	38028	AZ(vrt_addfilter(NULL, &VFP_esi, NULL));
273	38028	AZ(vrt_addfilter(NULL, &VFP_esi_gzip, NULL));
274	38028	AZ(vrt_addfilter(NULL, NULL, &VDP_esi));
275	38028	AZ(vrt_addfilter(NULL, NULL, &VDP_gunzip));
276	38028	AZ(vrt_addfilter(NULL, NULL, &VDP_range));
277	38028	}
278
279		/*--------------------------------------------------------------------
280		*/
281
282		typedef void filter_list_t(void , struct vsb vsb);
283
284		static const char *
285	197773	filter_on_ws(struct ws ws, filter_list_t func, void *arg)
286		{
287		struct vsb vsb[1];
288		const char *p;
289
290	197773	AN(func);
291	197773	AN(arg);
292	197773	WS_VSB_new(vsb, ws);
293	197773	func(arg, vsb);
294	197773	p = WS_VSB_finish(vsb, ws, NULL);
295	197773	if (p == NULL)
296	920	p = "";
297	197773	return (p);
298		}
299
300		/*--------------------------------------------------------------------
301		*/
302
303		static void v_matchproto_(filter_list_t)
304	48481	vbf_default_filter_list(void arg, struct vsb vsb)
305		{
306		const struct busyobj *bo;
307		const char *p;
308	48481	int do_gzip, do_gunzip, is_gzip = 0, is_gunzip = 0;
309
310	48481	CAST_OBJ_NOTNULL(bo, arg, BUSYOBJ_MAGIC);
311
312	48481	do_gzip = bo->do_gzip;
313	48481	do_gunzip = bo->do_gunzip;
314
315		/*
316		* The VCL variables beresp.do_g[un]zip tells us how we want the
317		* object processed before it is stored.
318		*
319		* The backend Content-Encoding header tells us what we are going
320		* to receive, which we classify in the following three classes:
321		*
322		* "Content-Encoding: gzip" --> object is gzipped.
323		* no Content-Encoding --> object is not gzipped.
324		* anything else --> do nothing wrt gzip
325		*/
326
327		/* No body -> done */
328	48481	if (bo->htc->body_status == BS_NONE \|\| bo->htc->content_length == 0)
329	20	return;
330
331	48475	if (!cache_param->http_gzip_support)
332	160	do_gzip = do_gunzip = 0;
333
334	48475	if (http_GetHdr(bo->beresp, H_Content_Encoding, &p))
335	8039	is_gzip = !strcasecmp(p, "gzip");
336		else
337	40436	is_gunzip = 1;
338
339		/* We won't gunzip unless it is gzipped */
340	48475	if (do_gunzip && !is_gzip)
341	80	do_gunzip = 0;
342
343		/* We wont gzip unless if it already is gzipped */
344	48475	if (do_gzip && !is_gunzip)
345	0	do_gzip = 0;
346
347	48475	if (do_gunzip \|\| (is_gzip && bo->do_esi))
348	6360	VSB_cat(vsb, " gunzip");
349
350	48475	if (bo->do_esi && (do_gzip \|\| (is_gzip && !do_gunzip))) {
351	6480	VSB_cat(vsb, " esi_gzip");
352	6480	return;
353		}
354
355	41995	if (bo->do_esi) {
356	6000	VSB_cat(vsb, " esi");
357	6000	return;
358		}
359
360	35995	if (do_gzip)
361	640	VSB_cat(vsb, " gzip");
362
363	35995	if (is_gzip && !do_gunzip)
364	1680	VSB_cat(vsb, " testgunzip");
365	48475	}
366
367		const char *
368	48470	VBF_Get_Filter_List(struct busyobj *bo)
369		{
370
371	48470	CHECK_OBJ_NOTNULL(bo, BUSYOBJ_MAGIC);
372	48470	return (filter_on_ws(bo->ws, vbf_default_filter_list, bo));
373		}
374
375		static const char *
376	40	bereq_Empty_Filter(struct busyobj *bo)
377		{
378
379	40	CHECK_OBJ_NOTNULL(bo, BUSYOBJ_MAGIC);
380	40	return ("");
381		}
382
383		/*--------------------------------------------------------------------
384		*/
385
386		static void v_matchproto_(filter_list_t)
387	149311	resp_default_filter_list(void arg, struct vsb vsb)
388		{
389		struct req *req;
390
391	149311	CAST_OBJ_NOTNULL(req, arg, REQ_MAGIC);
392
393	149311	if (!req->disable_esi && req->objcore != NULL &&
394	148717	ObjHasAttr(req->wrk, req->objcore, OA_ESIDATA))
395	8999	VSB_cat(vsb, " esi");
396
397	162231	if (cache_param->http_gzip_support &&
398	148987	req->objcore != NULL &&
399	148907	ObjCheckFlag(req->wrk, req->objcore, OF_GZIPED) &&
400	12920	!RFC2616_Req_Gzip(req->http))
401	4720	VSB_cat(vsb, " gunzip");
402
403	273104	if (cache_param->http_range_support &&
404	149157	http_GetStatus(req->resp) == 200 &&
405	123793	http_GetHdr(req->http, H_Range, NULL))
406	2320	VSB_cat(vsb, " range");
407	149311	}
408
409		const char *
410	149310	resp_Get_Filter_List(struct req *req)
411		{
412
413	149310	CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
414	149310	return (filter_on_ws(req->ws, resp_default_filter_list, req));
415		}
416
417		static const char *
418	80	req_Empty_Filter(struct req *req)
419		{
420
421	80	CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
422	80	return ("");
423		}
424
425		/*--------------------------------------------------------------------
426		* control if "set req.filters" is allowed
427		*
428		* req.body (conversely to other body object) is one where VCL has control over
429		* when it gets processed by means of std.cache_req_body(): Filters act on the
430		* received body when that function is called, so confusion could be caused if
431		* people expect filters to have an effect when set/changed after the req.body
432		* is already cached.
433		*/
434
435		static int
436	400	req_filter_can(struct req *req)
437		{
438
439	400	CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
440	400	return (req->req_body_status->avail == 1);
441		}
442
443		/--------------------------------------------------------------------/
444
445		//lint -emacro(506, FILTER_VAR) constant value boolean
446		//lint -emacro(774, FILTER_VAR) if always evaluates to false
447		#define FILTER_VAR(vcl, in, func, cond, fld) \
448		VCL_STRING \
449		VRT_r_##vcl##_filters(VRT_CTX) \
450		{ \
451		\
452		CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC); \
453		if (ctx->in->fld != NULL) \
454		return(ctx->in->fld); \
455		return (func(ctx->in)); \
456		} \
457		\
458		VCL_VOID \
459		VRT_l_##vcl##_filters(VRT_CTX, const char *str, VCL_STRANDS s) \
460		{ \
461		const char *b; \
462		\
463		(void)str; \
464		CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC); \
465		if (! (cond)) { \
466		VRT_fail(ctx, #vcl ".filters not settable"); \
467		return; \
468		} \
469		b = VRT_StrandsWS(ctx->in->ws, str, s); \
470		if (b == NULL) \
471		WS_MarkOverflow(ctx->in->ws); \
472		else \
473		ctx->in->fld = b; \
474		}
475
476	360	FILTER_VAR(bereq, bo, bereq_Empty_Filter, 1, vdp_filter_list)
477	1680	FILTER_VAR(beresp, bo, VBF_Get_Filter_List, 1, vfp_filter_list)
478	480	FILTER_VAR(req, req, req_Empty_Filter, req_filter_can(ctx->req), vfp_filter_list)
479	25559	FILTER_VAR(resp, req, resp_Get_Filter_List, 1, vdp_filter_list)