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_AddVFP(VRT_CTX, const struct vfp *filter)
{
        AZ(VRT_AddFilter(ctx, filter, NULL));
}

void
VRT_AddVDP(VRT_CTX, const struct vdp *filter)
{
        AZ(VRT_AddFilter(ctx, NULL, filter));
}

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);
}

void
VRT_RemoveVFP(VRT_CTX, const struct vfp *filter)
{

        VRT_RemoveFilter(ctx, filter, NULL);
}

void
VRT_RemoveVDP(VRT_CTX, const struct vdp *filter)
{

        VRT_RemoveFilter(ctx, NULL, filter);
}

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	35600	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	171964	VTAILQ_FOREACH(vp, head, list) {
68	136368	if (vfp != NULL && vp->vfp != NULL) {
69	41784	if (vp->vfp == vfp)
70	4	return ("VFP already registered");
71	41780	if (!strcasecmp(vp->name, name))
72	0	return ("VFP name already used");
73	41780	}
74	136364	if (vdp != NULL && vp->vdp != NULL) {
75	28794	if (vp->vdp == vdp)
76	0	return ("VDP already registered");
77	28794	if (!strcasecmp(vp->name, name))
78	0	return ("VDP name already used");
79	28794	}
80	136364	}
81	35596	return (NULL);
82	35600	}
83
84		static const char *
85	32656	vrt_addfilter(VRT_CTX, const struct vfp vfp, const struct vdp vdp)
86		{
87		struct vfilter *vp;
88	32656	struct vfilter_head *hd = &vrt_filters;
89	32656	const char err, name = NULL;
90
91	32656	CHECK_OBJ_ORNULL(ctx, VRT_CTX_MAGIC);
92	32656	assert(vfp != NULL \|\| vdp != NULL);
93	32656	assert(vfp == NULL \|\| vfp->name != NULL);
94	32656	assert(vdp == NULL \|\| vdp->name != NULL);
95	32656	assert(vfp == NULL \|\| vdp == NULL \|\| !strcasecmp(vfp->name, vdp->name));
96	32656	if (vfp != NULL)
97	19414	name = vfp->name;
98	13242	else if (vdp != NULL)
99	13242	name = vdp->name;
100	32656	AN(name);
101
102	32656	err = is_dup_filter(hd, vfp, vdp, name);
103	32656	if (err != NULL) {
104	0	if (ctx != NULL)
105	0	VRT_fail(ctx, "%s: %s (global)", name, err);
106	0	return (err);
107		}
108	32656	if (ctx != NULL) {
109	2944	ASSERT_CLI();
110	2944	CHECK_OBJ_NOTNULL(ctx->vcl, VCL_MAGIC);
111	2944	hd = &ctx->vcl->filters;
112	2944	err = is_dup_filter(hd, vfp, vdp, name);
113	2944	if (err != NULL) {
114	4	VRT_fail(ctx, "%s: %s (per-vcl)", name, err);
115	4	return (err);
116		}
117	2940	}
118
119	32652	ALLOC_OBJ(vp, VFILTER_MAGIC);
120	32652	AN(vp);
121	32652	vp->vfp = vfp;
122	32652	vp->vdp = vdp;
123	32652	vp->name = name;
124	32652	vp->nlen = strlen(name);
125	32652	VTAILQ_INSERT_TAIL(hd, vp, list);
126	32652	return (err);
127	32656	}
128
129		const char *
130	2944	VRT_AddFilter(VRT_CTX, const struct vfp vfp, const struct vdp vdp)
131		{
132
133	2944	CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
134	2944	return (vrt_addfilter(ctx, vfp, vdp));
135		}
136
137		void
138	0	VRT_AddVFP(VRT_CTX, const struct vfp *filter)
139		{
140	0	AZ(VRT_AddFilter(ctx, filter, NULL));
141	0	}
142
143		void
144	0	VRT_AddVDP(VRT_CTX, const struct vdp *filter)
145		{
146	0	AZ(VRT_AddFilter(ctx, NULL, filter));
147	0	}
148
149		void
150	644	VRT_RemoveFilter(VRT_CTX, const struct vfp vfp, const struct vdp vdp)
151		{
152		struct vfilter *vp;
153		struct vfilter_head *hd;
154
155	644	CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
156	644	CHECK_OBJ_NOTNULL(ctx->vcl, VCL_MAGIC);
157	644	hd = &ctx->vcl->filters;
158	644	assert(vfp != NULL \|\| vdp != NULL);
159	644	assert(vfp == NULL \|\| vfp->name != NULL);
160	644	assert(vdp == NULL \|\| vdp->name != NULL);
161	644	assert(vfp == NULL \|\| vdp == NULL \|\| !strcasecmp(vfp->name, vdp->name));
162
163	644	ASSERT_CLI();
164	920	VTAILQ_FOREACH(vp, hd, list) {
165	920	CHECK_OBJ_NOTNULL(vp, VFILTER_MAGIC);
166	920	if (vp->vfp == vfp && vp->vdp == vdp)
167	644	break;
168	276	}
169	644	AN(vp);
170	644	assert(vfp == NULL \|\| !strcasecmp(vfp->name, vp->name));
171	644	assert(vdp == NULL \|\| !strcasecmp(vdp->name, vp->name));
172	644	VTAILQ_REMOVE(hd, vp, list);
173	644	FREE_OBJ(vp);
174	644	}
175
176		void
177	0	VRT_RemoveVFP(VRT_CTX, const struct vfp *filter)
178		{
179
180	0	VRT_RemoveFilter(ctx, filter, NULL);
181	0	}
182
183		void
184	0	VRT_RemoveVDP(VRT_CTX, const struct vdp *filter)
185		{
186
187	0	VRT_RemoveFilter(ctx, NULL, filter);
188	0	}
189
190		static const struct vfilter vfilter_error[1] = {{0}};
191
192		static const struct vfilter *
193	26184	vcl_filter_list_iter(int want_vfp, const struct vfilter_head *h1,
194		const struct vfilter_head h2, const char *flp)
195		{
196		const char fl, q;
197		const struct vfilter *vp;
198
199	26184	AN(h1);
200	26184	AN(h2);
201	26184	AN(flp);
202
203	26184	fl = *flp;
204	26184	AN(fl);
205
206	30520	while (vct_isspace(*fl))
207	4336	fl++;
208	26184	if (*fl == '\0') {
209	21688	*flp = NULL;
210	21688	return (NULL);
211		}
212	37252	for (q = fl; q && !vct_isspace(q); q++)
213	32756	continue;
214	4496	*flp = q;
215	26512	VTAILQ_FOREACH(vp, h1, list) {
216	25280	if (want_vfp && vp->vfp == NULL)
217	156	continue;
218	25124	else if (!want_vfp && vp->vdp == NULL)
219	12660	continue;
220	12464	if (vp->nlen == q - fl && !memcmp(fl, vp->name, vp->nlen))
221	3264	return (vp);
222	9200	}
223	2644	VTAILQ_FOREACH(vp, h2, list) {
224	2632	if (want_vfp && vp->vfp == NULL)
225	40	continue;
226	2592	else if (!want_vfp && vp->vdp == NULL)
227	0	continue;
228	2592	if (vp->nlen == q - fl && !memcmp(fl, vp->name, vp->nlen))
229	1220	return (vp);
230	1372	}
231	12	*flp = fl;
232	12	return (vfilter_error);
233	26184	}
234
235		int
236	7671	VCL_StackVFP(struct vfp_ctx vc, const struct vcl vcl, const char *fl)
237		{
238		const struct vfilter *vp;
239
240	7671	AN(fl);
241	7671	VSLbs(vc->wrk->vsl, SLT_Filters, TOSTRAND(fl));
242
243	9539	while (1) {
244	9539	vp = vcl_filter_list_iter(1, &vrt_filters, &vcl->filters, &fl);
245	9539	if (vp == NULL)
246	7575	return (0);
247	1964	if (vp == vfilter_error)
248	8	return (VFP_Error(vc, "Filter '...%s' not found", fl));
249	1956	if (VFP_Push(vc, vp->vfp) == NULL)
250	88	return (-1);
251		}
252	7671	}
253
254		int
255	14365	VCL_StackVDP(struct vdp_ctx vdc, const struct vcl vcl, const char *fl,
256		struct req req, struct busyobj bo)
257		{
258		const struct vfilter *vp;
259		struct vrt_ctx ctx[1];
260
261	14365	CHECK_OBJ_NOTNULL(vdc, VDP_CTX_MAGIC);
262	14365	AN(vcl);
263	14365	AN(fl);
264
265	14365	CHECK_OBJ_ORNULL(req, REQ_MAGIC);
266	14365	CHECK_OBJ_ORNULL(bo, BUSYOBJ_MAGIC);
267
268	14365	assert((req ? 1 : 0) ^ (bo ? 1 : 0));
269
270	14365	VSLbs(vdc->vsl, SLT_Filters, TOSTRAND(fl));
271	14365	INIT_OBJ(ctx, VRT_CTX_MAGIC);
272
273	14365	if (req)
274	14337	VCL_Req2Ctx(ctx, req);
275		else
276	28	VCL_Bo2Ctx(ctx, bo);
277
278	16645	while (1) {
279	16645	vp = vcl_filter_list_iter(0, &vrt_filters, &vcl->filters, &fl);
280	16645	if (vp == NULL)
281	14113	return (0);
282	2532	if (vp == vfilter_error) {
283	8	VSLb(ctx->vsl, SLT_Error,
284	4	"Filter '...%s' not found", fl);
285	4	return (-1);
286		}
287	2528	if (VDP_Push(ctx, vdc, ctx->ws, vp->vdp, NULL))
288	248	return (-1);
289		}
290	14365	}
291
292		void
293	3714	VCL_VRT_Init(void)
294		{
295	3714	AZ(vrt_addfilter(NULL, &VFP_testgunzip, NULL));
296	3714	AZ(vrt_addfilter(NULL, &VFP_gunzip, NULL));
297	3714	AZ(vrt_addfilter(NULL, &VFP_gzip, NULL));
298	3714	AZ(vrt_addfilter(NULL, &VFP_esi, NULL));
299	3714	AZ(vrt_addfilter(NULL, &VFP_esi_gzip, NULL));
300	3714	AZ(vrt_addfilter(NULL, NULL, &VDP_esi));
301	3714	AZ(vrt_addfilter(NULL, NULL, &VDP_gunzip));
302	3714	AZ(vrt_addfilter(NULL, NULL, &VDP_range));
303	3714	}
304
305		/*--------------------------------------------------------------------
306		*/
307
308		typedef void filter_list_t(void , struct vsb vsb);
309
310		static const char *
311	19188	filter_on_ws(struct ws ws, filter_list_t func, void *arg)
312		{
313		struct vsb vsb[1];
314		const char *p;
315
316	19188	AN(func);
317	19188	AN(arg);
318	19188	WS_VSB_new(vsb, ws);
319	19188	func(arg, vsb);
320	19188	p = WS_VSB_finish(vsb, ws, NULL);
321	19188	if (p == NULL)
322	92	p = "";
323	19188	return (p);
324		}
325
326		/*--------------------------------------------------------------------
327		*/
328
329		static void v_matchproto_(filter_list_t)
330	4775	vbf_default_filter_list(void arg, struct vsb vsb)
331		{
332		const struct busyobj *bo;
333		const char *p;
334	4775	int do_gzip, do_gunzip, is_gzip = 0, is_gunzip = 0;
335
336	4775	CAST_OBJ_NOTNULL(bo, arg, BUSYOBJ_MAGIC);
337
338	4775	do_gzip = bo->do_gzip;
339	4775	do_gunzip = bo->do_gunzip;
340
341		/*
342		* The VCL variables beresp.do_g[un]zip tells us how we want the
343		* object processed before it is stored.
344		*
345		* The backend Content-Encoding header tells us what we are going
346		* to receive, which we classify in the following three classes:
347		*
348		* "Content-Encoding: gzip" --> object is gzipped.
349		* no Content-Encoding --> object is not gzipped.
350		* anything else --> do nothing wrt gzip
351		*/
352
353		/* No body -> done */
354	4775	if (bo->htc->body_status == BS_NONE \|\| bo->htc->content_length == 0)
355	0	return;
356
357	4775	if (!cache_param->http_gzip_support)
358	16	do_gzip = do_gunzip = 0;
359
360	4775	if (http_GetHdr(bo->beresp, H_Content_Encoding, &p))
361	801	is_gzip = !strcasecmp(p, "gzip");
362		else
363	3974	is_gunzip = 1;
364
365		/* We won't gunzip unless it is gzipped */
366	4775	if (do_gunzip && !is_gzip)
367	8	do_gunzip = 0;
368
369		/* We wont gzip unless if it already is gzipped */
370	4775	if (do_gzip && !is_gunzip)
371	0	do_gzip = 0;
372
373	4775	if (do_gunzip \|\| (is_gzip && bo->do_esi))
374	636	VSB_cat(vsb, " gunzip");
375
376	4775	if (bo->do_esi && (do_gzip \|\| (is_gzip && !do_gunzip))) {
377	648	VSB_cat(vsb, " esi_gzip");
378	648	return;
379		}
380
381	4127	if (bo->do_esi) {
382	600	VSB_cat(vsb, " esi");
383	600	return;
384		}
385
386	3527	if (do_gzip)
387	64	VSB_cat(vsb, " gzip");
388
389	3527	if (is_gzip && !do_gunzip)
390	164	VSB_cat(vsb, " testgunzip");
391	4775	}
392
393		const char *
394	4776	VBF_Get_Filter_List(struct busyobj *bo)
395		{
396
397	4776	CHECK_OBJ_NOTNULL(bo, BUSYOBJ_MAGIC);
398	4776	return (filter_on_ws(bo->ws, vbf_default_filter_list, bo));
399		}
400
401		static const char *
402	4	bereq_Empty_Filter(struct busyobj *bo)
403		{
404
405	4	CHECK_OBJ_NOTNULL(bo, BUSYOBJ_MAGIC);
406	4	return ("");
407		}
408
409		/*--------------------------------------------------------------------
410		*/
411
412		static void v_matchproto_(filter_list_t)
413	14413	resp_default_filter_list(void arg, struct vsb vsb)
414		{
415		struct req *req;
416
417	14413	CAST_OBJ_NOTNULL(req, arg, REQ_MAGIC);
418
419	14413	if (!req->disable_esi && req->objcore != NULL &&
420	14353	ObjHasAttr(req->wrk, req->objcore, OA_ESIDATA))
421	900	VSB_cat(vsb, " esi");
422
423	15449	if (cache_param->http_gzip_support &&
424	14381	req->objcore != NULL &&
425	14373	ObjCheckFlag(req->wrk, req->objcore, OF_GZIPED) &&
426	1036	!RFC2616_Req_Gzip(req->http))
427	344	VSB_cat(vsb, " gunzip");
428
429	26357	if (cache_param->http_range_support &&
430	14396	http_GetStatus(req->resp) == 200 &&
431	11944	http_GetHdr(req->http, H_Range, NULL))
432	228	VSB_cat(vsb, " range");
433	14413	}
434
435		const char *
436	14410	resp_Get_Filter_List(struct req *req)
437		{
438
439	14410	CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
440	14410	return (filter_on_ws(req->ws, resp_default_filter_list, req));
441		}
442
443		static const char *
444	8	req_Empty_Filter(struct req *req)
445		{
446
447	8	CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
448	8	return ("");
449		}
450
451		/*--------------------------------------------------------------------
452		* control if "set req.filters" is allowed
453		*
454		* req.body (conversely to other body object) is one where VCL has control over
455		* when it gets processed by means of std.cache_req_body(): Filters act on the
456		* received body when that function is called, so confusion could be caused if
457		* people expect filters to have an effect when set/changed after the req.body
458		* is already cached.
459		*/
460
461		static int
462	40	req_filter_can(struct req *req)
463		{
464
465	40	CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
466	40	return (req->req_body_status->avail == 1);
467		}
468
469		/--------------------------------------------------------------------/
470
471		//lint -emacro(506, FILTER_VAR) constant value boolean
472		//lint -emacro(774, FILTER_VAR) if always evaluates to false
473		#define FILTER_VAR(vcl, in, func, cond, fld) \
474		VCL_STRING \
475		VRT_r_##vcl##_filters(VRT_CTX) \
476		{ \
477		\
478		CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC); \
479		if (ctx->in->fld != NULL) \
480		return(ctx->in->fld); \
481		return (func(ctx->in)); \
482		} \
483		\
484		VCL_VOID \
485		VRT_l_##vcl##_filters(VRT_CTX, const char *str, VCL_STRANDS s) \
486		{ \
487		const char *b; \
488		\
489		(void)str; \
490		CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC); \
491		if (! (cond)) { \
492		VRT_fail(ctx, #vcl ".filters not settable"); \
493		return; \
494		} \
495		b = VRT_StrandsWS(ctx->in->ws, str, s); \
496		if (b == NULL) \
497		WS_MarkOverflow(ctx->in->ws); \
498		else \
499		ctx->in->fld = b; \