/
ngx_http_flex_cache_module.c
407 lines (315 loc) · 11.2 KB
/
ngx_http_flex_cache_module.c
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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
/*
* Copyright (C) 2012 Yasar Semih Alev
*
*/
#include <ngx_config.h>
#include <ngx_core.h>
#include <ngx_http.h>
#include <nginx.h>
#if (NGX_HTTP_CACHE)
ngx_int_t ngx_http_flex_cache_init(ngx_conf_t *);
ngx_int_t ngx_http_flex_cache_add_variables(ngx_conf_t *);
void *ngx_http_flex_cache_create_loc_conf(ngx_conf_t *);
char *ngx_http_flex_cache_merge_loc_conf(ngx_conf_t *, void *, void *);
char *ngx_http_flex_cache_conf(ngx_conf_t *, ngx_command_t *, void *);
char *ngx_http_flex_cache_key_conf(ngx_conf_t *, ngx_command_t *, void *);
ngx_int_t ngx_http_flex_cache_status(ngx_http_request_t *,
ngx_http_variable_value_t *, uintptr_t);
ngx_int_t ngx_http_flex_cache_handler(ngx_http_request_t *);
ngx_int_t ngx_http_flex_cache_send(ngx_http_request_t *r);
typedef struct {
ngx_flag_t enabled;
ngx_shm_zone_t *cache;
size_t chunk_size;
ngx_http_complex_value_t cache_key;
ngx_uint_t cache_min_uses;
ngx_array_t *cache_valid;
} ngx_http_flex_cache_loc_conf_t;
typedef struct {
ngx_uint_t cache_status;
} ngx_http_flex_cache_ctx_t;
ngx_module_t ngx_http_flex_cache_module;
static ngx_command_t ngx_http_flex_cache_module_commands[] = {
{ ngx_string("flex_cache"),
NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_FLAG,
ngx_http_flex_cache_conf,
NGX_HTTP_LOC_CONF_OFFSET,
0,
NULL },
{ ngx_string("flex_cache_key"),
NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_FLAG,
ngx_http_flex_cache_key_conf,
NGX_HTTP_LOC_CONF_OFFSET,
0,
NULL },
{ ngx_string("flex_cache_path"),
NGX_HTTP_MAIN_CONF|NGX_CONF_2MORE,
ngx_http_file_cache_set_slot,
0,
0,
&ngx_http_flex_cache_module },
{ ngx_string("flex_cache_chunk_size"),
NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1,
ngx_conf_set_size_slot,
NGX_HTTP_LOC_CONF_OFFSET,
offsetof(ngx_http_flex_cache_loc_conf_t, chunk_size),
NULL },
{ ngx_string("flex_cache_min_uses"),
NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1,
ngx_conf_set_num_slot,
NGX_HTTP_LOC_CONF_OFFSET,
offsetof(ngx_http_flex_cache_loc_conf_t, cache_min_uses),
NULL },
{ ngx_string("flex_cache_valid"),
NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_1MORE,
ngx_http_file_cache_valid_set_slot,
NGX_HTTP_LOC_CONF_OFFSET,
offsetof(ngx_http_flex_cache_loc_conf_t, cache_valid),
NULL },
ngx_null_command
};
static ngx_http_variable_t ngx_http_flex_cache_module_variables[] = {
{ ngx_string("flex_cache_status"), NULL,
ngx_http_flex_cache_status, 0,
NGX_HTTP_VAR_NOHASH|NGX_HTTP_VAR_NOCACHEABLE, 0 },
{ ngx_null_string, NULL, NULL, 0, 0, 0 }
};
static ngx_http_module_t ngx_http_flex_cache_module_ctx = {
ngx_http_flex_cache_add_variables, /* preconfiguration */
ngx_http_flex_cache_init, /* postconfiguration */
NULL, /* create main configuration */
NULL, /* init main configuration */
NULL, /* create server configuration */
NULL, /* merge server configuration */
ngx_http_flex_cache_create_loc_conf, /* create location configuration */
ngx_http_flex_cache_merge_loc_conf /* merge location configuration */
};
ngx_module_t ngx_http_flex_cache_module = {
NGX_MODULE_V1,
&ngx_http_flex_cache_module_ctx, /* module context */
ngx_http_flex_cache_module_commands, /* module directives */
NGX_HTTP_MODULE, /* module type */
NULL, /* init master */
NULL, /* init module */
NULL, /* init process */
NULL, /* init thread */
NULL, /* exit thread */
NULL, /* exit process */
NULL, /* exit master */
NGX_MODULE_V1_PADDING
};
ngx_int_t
ngx_http_flex_cache_handler(ngx_http_request_t *r)
{
ngx_int_t rc;
ngx_http_flex_cache_loc_conf_t *fc;
fc = ngx_http_get_module_loc_conf(r, ngx_http_flex_cache_module);
if (!fc->enabled) {
return NGX_DECLINED;
}
if (!(r->method & (NGX_HTTP_GET|NGX_HTTP_HEAD))) {
return NGX_HTTP_NOT_ALLOWED;
}
if (r->uri.data[r->uri.len - 1] == '/') {
return NGX_DECLINED;
}
#if defined(nginx_version) \
&& ((nginx_version < 7066) \
|| ((nginx_version >= 8000) && (nginx_version < 8038)))
if (r->zero_in_uri) {
return NGX_DECLINED;
}
#endif
rc = ngx_http_discard_request_body(r);
if (rc != NGX_OK) {
return rc;
}
rc = ngx_http_flex_cache_send(r);
return rc;
}
ngx_int_t
ngx_http_flex_cache_send(ngx_http_request_t *r)
{
ngx_int_t rc;
u_char *last;
size_t root;
ngx_str_t path;
ngx_chain_t out;
ngx_buf_t *b;
size_t len;
last = ngx_http_map_uri_to_path(r, &path, &root, 0);
if (last == NULL) {
return NGX_HTTP_INTERNAL_SERVER_ERROR;
}
path.len = last - path.data;
len = sizeof("OK!") -1;
r->headers_out.content_type.len = sizeof("text/plain") - 1;
r->headers_out.content_type.data = (u_char *) "text/plain";
r->headers_out.status = NGX_HTTP_OK;
r->headers_out.content_length_n = len;
if (r->method == NGX_HTTP_HEAD) {
rc = ngx_http_send_header(r);
if (rc == NGX_ERROR || rc > NGX_OK || r->header_only) {
return rc;
}
}
b = ngx_create_temp_buf(r->pool, len);
if (b == NULL) {
return NGX_HTTP_INTERNAL_SERVER_ERROR;
}
out.buf = b;
out.next = NULL;
b->last = ngx_cpymem(b->last, "OK!", sizeof("OK!") - 1);
b->last_buf = 1;
rc = ngx_http_send_header(r);
if (rc == NGX_ERROR || rc > NGX_OK || r->header_only) {
return rc;
}
return ngx_http_output_filter(r, &out);
}
ngx_int_t
ngx_http_flex_cache_init(ngx_conf_t *cf)
{
ngx_http_handler_pt *h;
ngx_http_core_main_conf_t *cmcf;
cmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_core_module);
h = ngx_array_push(&cmcf->phases[NGX_HTTP_CONTENT_PHASE].handlers);
if (h == NULL) {
return NGX_ERROR;
}
*h = ngx_http_flex_cache_handler;
return NGX_OK;
}
ngx_int_t
ngx_http_flex_cache_status(ngx_http_request_t *r,
ngx_http_variable_value_t *v, uintptr_t data)
{
ngx_http_flex_cache_ctx_t *fcctx;
ngx_uint_t n;
fcctx = ngx_http_get_module_ctx(r, ngx_http_flex_cache_module);
if (fcctx == NULL || fcctx->cache_status == 0) {
v->not_found = 1;
return NGX_OK;
}
n = fcctx->cache_status - 1;
v->valid = 1;
v->no_cacheable = 0;
v->not_found = 0;
v->len = ngx_http_cache_status[n].len;
v->data = ngx_http_cache_status[n].data;
return NGX_OK;
}
char *
ngx_http_flex_cache_conf(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
{
ngx_str_t *value = cf->args->elts;
ngx_http_flex_cache_loc_conf_t *fc = conf;
if (fc->cache != NGX_CONF_UNSET_PTR && fc->cache != NULL) {
return "is duplicate";
}
if (ngx_strcmp(value[1].data, "off") == 0) {
fc->enabled = 0;
fc->cache = NULL;
return NGX_CONF_OK;
}
fc->cache = ngx_shared_memory_add(cf, &value[1], 0,
&ngx_http_flex_cache_module);
if (fc->cache == NULL) {
return NGX_CONF_ERROR;
}
fc->enabled = 1;
return NGX_CONF_OK;
}
char *
ngx_http_flex_cache_key_conf(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
{
ngx_str_t *value = cf->args->elts;
ngx_http_flex_cache_loc_conf_t *fc = conf;
ngx_http_compile_complex_value_t ccv;
if (fc->cache_key.value.len) {
return "is duplicate";
}
ngx_memzero(&ccv, sizeof(ngx_http_compile_complex_value_t));
ccv.cf = cf;
ccv.value = &value[1];
ccv.complex_value = &fc->cache_key;
if (ngx_http_compile_complex_value(&ccv) != NGX_OK) {
return NGX_CONF_ERROR;
}
return NGX_CONF_OK;
}
void *
ngx_http_flex_cache_create_loc_conf(ngx_conf_t *cf)
{
ngx_http_flex_cache_loc_conf_t *fc;
fc = ngx_pcalloc(cf->pool, sizeof(ngx_http_flex_cache_loc_conf_t));
if (fc == NULL) {
return NGX_CONF_ERROR;
}
fc->enabled = NGX_CONF_UNSET;
fc->cache = NGX_CONF_UNSET_PTR;
fc->chunk_size = NGX_CONF_UNSET_SIZE;
fc->cache_min_uses = NGX_CONF_UNSET_UINT;
fc->cache_valid = NGX_CONF_UNSET_PTR;
return fc;
}
char *
ngx_http_flex_cache_merge_loc_conf(ngx_conf_t *cf, void *parent, void *child)
{
ngx_http_flex_cache_loc_conf_t *prev = parent;
ngx_http_flex_cache_loc_conf_t *fc = child;
ngx_conf_merge_value(fc->enabled, prev->enabled, 0);
if (fc->cache_key.value.data == NULL) {
fc->cache_key = prev->cache_key;
}
ngx_conf_merge_ptr_value(fc->cache, prev->cache, NULL);
if (fc->cache && fc->cache->data == NULL) {
ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
"\"flex cache\" zone \"%V\" is unknown",
&fc->cache->shm.name);
return NGX_CONF_ERROR;
}
ngx_conf_merge_size_value(fc->chunk_size, prev->chunk_size, 512 * 1024);
ngx_conf_merge_uint_value(fc->cache_min_uses, prev->cache_min_uses, 1);
ngx_conf_merge_ptr_value(fc->cache_valid, prev->cache_valid, NULL);
return NGX_CONF_OK;
}
ngx_int_t
ngx_http_flex_cache_add_variables(ngx_conf_t *cf)
{
ngx_http_variable_t *var, *v;
v = ngx_http_flex_cache_module_variables;
var = ngx_http_add_variable(cf, &v->name, v->flags);
if (var == NULL) {
return NGX_ERROR;
}
var->get_handler = v->get_handler;
var->data = v->data;
return NGX_OK;
}
#else
static ngx_http_module_t ngx_http_flex_cache_module_ctx = {
NULL, /* preconfiguration */
NULL, /* postconfiguration */
NULL, /* create main configuration */
NULL, /* init main configuration */
NULL, /* create server configuration */
NULL, /* merge server configuration */
NULL, /* create location configuration */
NULL, /* merge location configuration */
};
ngx_module_t ngx_http_flex_cache_module = {
NGX_MODULE_V1,
&ngx_http_flex_cache_module_ctx, /* module context */
NULL, /* module directives */
NGX_HTTP_MODULE, /* module type */
NULL, /* init master */
NULL, /* init module */
NULL, /* init process */
NULL, /* init thread */
NULL, /* exit thread */
NULL, /* exit process */
NULL, /* exit master */
NGX_MODULE_V1_PADDING
};
#endif