varnish-cache/lib/libvcc/vcc_source.c
0
/*-
1
 * Copyright (c) 2006 Verdens Gang AS
2
 * Copyright (c) 2006-2015 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
#include "config.h"
32
33
#include <glob.h>
34
#include <stdlib.h>
35
#include <string.h>
36
#include <unistd.h>
37
38
#include "vcc_compile.h"
39
40
#include "vfil.h"
41
42
struct source *
43 52584
vcc_new_source(const char *src, const char *kind, const char *name)
44
{
45
        struct source *sp;
46
47 52584
        AN(src);
48 52584
        AN(name);
49 52584
        ALLOC_OBJ(sp, SOURCE_MAGIC);
50 52584
        AN(sp);
51 52584
        REPLACE(sp->name, name);
52 52584
        sp->kind = kind;
53 52584
        sp->b = src;
54 52584
        sp->e = strchr(src, '\0');
55 52584
        VTAILQ_INIT(&sp->src_tokens);
56 52584
        return (sp);
57
}
58
59
/*--------------------------------------------------------------------*/
60
61
struct source *
62 624
vcc_file_source(struct vcc *tl, const char *fn)
63
{
64
        char *f, *fnp;
65
        struct source *sp;
66
67 624
        if (!tl->unsafe_path && strchr(fn, '/') != NULL) {
68 12
                VSB_printf(tl->sb, "VCL filename '%s' is unsafe.\n", fn);
69 12
                tl->err = 1;
70 12
                return (NULL);
71
        }
72 612
        f = NULL;
73 612
        if (VFIL_searchpath(tl->vcl_path, NULL, &f, fn, &fnp) || f == NULL) {
74 24
                VSB_printf(tl->sb, "Cannot read file '%s' (%s)\n",
75 12
                    fnp != NULL ? fnp : fn, strerror(errno));
76 12
                free(fnp);
77 12
                tl->err = 1;
78 12
                return (NULL);
79
        }
80 600
        sp = vcc_new_source(f, "file", fnp);
81 600
        free(fnp);
82 600
        return (sp);
83 624
}
84
85
/*--------------------------------------------------------------------*/
86
87
static void
88 480
vcc_include_file(struct vcc *tl, const struct source *src_sp,
89
    const char *filename, const struct token *parent_token)
90
{
91
        struct source *sp;
92
93 480
        sp = vcc_file_source(tl, filename);
94 480
        if (sp == NULL)
95 12
                return;
96
97 468
        sp->parent = src_sp;
98 468
        sp->parent_tok = parent_token;
99 468
        vcc_lex_source(tl, sp, 0);
100 480
}
101
102
/*--------------------------------------------------------------------*/
103
104
static void
105 48
vcc_include_glob_file(struct vcc *tl, const struct source *src_sp,
106
    const char *filename, const struct token *parent_token)
107
{
108
        glob_t  g[1];
109
        unsigned u;
110
        int i;
111
112 48
        memset(g, 0, sizeof g);
113 48
        i = glob(filename, 0, NULL, g);
114 48
        switch (i) {
115
        case 0:
116 96
                for (u = 0; !tl->err && u < g->gl_pathc; u++) {
117 60
                        vcc_include_file(
118 60
                            tl, src_sp, g->gl_pathv[u], parent_token);
119 60
                }
120 36
                break;
121
        case GLOB_NOMATCH:
122 12
                VSB_cat(tl->sb, "glob pattern matched no files.\n");
123 12
                tl->err = 1;
124 12
                break;
125
        default:
126 0
                VSB_printf(tl->sb, "glob(3) expansion failed (%d)\n", i);
127 0
                tl->err = 1;
128 0
                break;
129
        }
130 48
        globfree(g);
131 48
}
132
133
/*--------------------------------------------------------------------
134
 * NB: We cannot use vcc_ErrWhere2() on tokens which are not on the
135
 * NB: tl->tokens list.
136
 */
137
138
static struct token *
139 528
vcc_lex_include(struct vcc *tl, const struct source *src_sp, struct token *t)
140
{
141
        struct token *tok1;
142 528
        int i, glob_flag = 0;
143 528
        struct vsb *vsb = NULL;
144
        const char *filename;
145
        const char *p;
146
147 528
        assert(vcc_IdIs(t, "include"));
148
149 528
        tok1 = VTAILQ_NEXT(t, src_list);
150 528
        AN(tok1);
151
152 588
        while (1) {
153 588
                t = VTAILQ_NEXT(tok1, src_list);
154 588
                AN(t);
155 588
                i = vcc_IsFlagRaw(tl, tok1, t);
156 588
                if (i < 0)
157 528
                        break;
158 60
                if (vcc_IdIs(t, "glob")) {
159 60
                        glob_flag = i;
160 60
                } else {
161 0
                        VSB_cat(tl->sb, "Unknown include flag:\n");
162 0
                        vcc_ErrWhere(tl, t);
163 0
                        return (t);
164
                }
165 60
                tok1 = VTAILQ_NEXT(t, src_list);
166 60
                AN(tok1);
167
        }
168
169 528
        if (tok1->tok != CSTR) {
170 24
                VSB_cat(tl->sb,
171
                    "include not followed by string constant.\n");
172 24
                vcc_ErrWhere(tl, tok1);
173 24
                return (t);
174
        }
175 504
        t = VTAILQ_NEXT(tok1, src_list);
176 504
        AN(t);
177
178 504
        if (t->tok != ';') {
179 12
                VSB_cat(tl->sb,
180
                    "include <string> not followed by semicolon.\n");
181 12
                vcc_ErrWhere(tl, tok1);
182 12
                return (t);
183
        }
184
185 492
        filename = tok1->dec;
186
187 492
        if (filename[0] == '.' && filename[1] == '/') {
188
                /*
189
                 * Nested include filenames, starting with "./" are
190
                 * resolved relative to the VCL file which contains
191
                 * the include directive.
192
                 */
193 120
                if (src_sp->name[0] != '/') {
194 24
                        VSB_cat(tl->sb,
195
                            "include \"./xxxxx\"; needs absolute "
196
                            "filename of including file.\n");
197 24
                        vcc_ErrWhere(tl, tok1);
198 24
                        return (t);
199
                }
200 96
                vsb = VSB_new_auto();
201 96
                AN(vsb);
202 96
                p = strrchr(src_sp->name, '/');
203 96
                AN(p);
204 96
                VSB_bcat(vsb, src_sp->name, p - src_sp->name);
205 96
                VSB_cat(vsb, filename + 1);
206 96
                AZ(VSB_finish(vsb));
207 96
                filename = VSB_data(vsb);
208 96
        }
209
210 468
        if (glob_flag)
211 48
                vcc_include_glob_file(tl, src_sp, filename, tok1);
212
        else
213 420
                vcc_include_file(tl, src_sp, filename, tok1);
214 468
        if (vsb != NULL)
215 96
                VSB_destroy(&vsb);
216 468
        if (tl->err)
217 84
                vcc_ErrWhere(tl, tok1);
218 468
        return (t);
219 528
}
220
221
void
222 52584
vcc_lex_source(struct vcc *tl, struct source *src_sp, int eoi)
223
{
224
        struct token *t;
225
        const struct source *sp1;
226
227 52584
        CHECK_OBJ_NOTNULL(src_sp, SOURCE_MAGIC);
228
229 53208
        for (sp1 = src_sp->parent; sp1 != NULL; sp1 = sp1->parent) {
230 648
                if (!strcmp(sp1->name, src_sp->name) &&
231 24
                    !strcmp(sp1->kind, src_sp->kind)) {
232 48
                        VSB_printf(tl->sb,
233
                            "Recursive use of %s \"%s\"\n\n",
234 24
                            src_sp->kind, src_sp->name);
235 24
                        tl->err = 1;
236 24
                        return;
237
                }
238 624
        }
239
240 52560
        VTAILQ_INSERT_TAIL(&tl->sources, src_sp, list);
241 52560
        src_sp->idx = tl->nsources++;
242
243 52560
        vcc_Lexer(tl, src_sp);
244 52560
        if (tl->err)
245 276
                return;
246 27000492
        VTAILQ_FOREACH(t, &src_sp->src_tokens, src_list) {
247 26965872
                if (!eoi && t->tok == EOI)
248 17520
                        break;
249
250 26948352
                if (t->tok == ID && vcc_IdIs(t, "include")) {
251 528
                        t = vcc_lex_include(tl, src_sp, t);
252 528
                } else {
253 26947824
                        VTAILQ_INSERT_TAIL(&tl->tokens, t, list);
254
                }
255 26948352
                if (tl->err)
256 144
                        return;
257 26948208
        }
258 52584
}