/
ngx_http_filter_cache_module.c
1395 lines (1142 loc) · 43.3 KB
/
ngx_http_filter_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
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#include <ngx_config.h>
#include <ngx_core.h>
#include <ngx_http.h>
/* see ngx_http_request.h */
#define NGX_HTTP_FILTERCACHE_BUFFERED 0x80
ngx_module_t ngx_http_filter_cache_module;
/*config */
typedef struct {
ngx_http_upstream_conf_t upstream; /*we use upstream, just bcs configs and helper functions already exist*/
ngx_uint_t headers_hash_max_size;
ngx_uint_t headers_hash_bucket_size;
ngx_int_t index;
ngx_flag_t handler;
ngx_http_handler_pt orig_handler;
time_t grace; /*how long after something is stale will be allow to serve stale*/
ngx_http_complex_value_t cache_key;
} ngx_http_filter_cache_conf_t;
static ngx_http_output_header_filter_pt ngx_http_next_header_filter;
static ngx_http_output_body_filter_pt ngx_http_next_body_filter;
static ngx_str_t ngx_http_filter_cache_key = ngx_string("filter_cache_key");
static ngx_int_t ngx_http_filter_cache_init(ngx_conf_t *cf);
static ngx_int_t ngx_http_filter_cache_content_handler(ngx_http_request_t *r);
static ngx_int_t ngx_http_filter_cache_handler(ngx_http_request_t *r);
static void *ngx_http_filter_cache_create_conf(ngx_conf_t *cf);
static char *ngx_http_filter_cache_merge_conf(ngx_conf_t *cf, void *parent, void *child);
static char *ngx_http_filter_cache(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
static ngx_int_t ngx_http_filter_cache_header_filter(ngx_http_request_t *r);
static ngx_int_t ngx_http_filter_cache_body_filter(ngx_http_request_t *r, ngx_chain_t *in);
static ngx_int_t ngx_http_filter_cache_add_variables(ngx_conf_t *cf);
static ngx_int_t ngx_http_gzip_ok_variable(ngx_http_request_t *r, ngx_http_variable_value_t *v, uintptr_t data);
static ngx_int_t ngx_http_filter_cache_status(ngx_http_request_t *r,
ngx_http_variable_value_t *v, uintptr_t data);
static ngx_int_t ngx_http_filter_cache_new(ngx_http_request_t *r);
/*static ngx_int_t ngx_http_filter_cache_create(ngx_http_request_t *r);*/
static void ngx_http_filter_cache_create_key(ngx_http_request_t *r);
static ngx_int_t ngx_http_filter_cache_open(ngx_http_request_t *r);
static void ngx_http_filter_cache_set_header(ngx_http_request_t *r, u_char *buf);
static void ngx_http_filter_cache_update(ngx_http_request_t *r, ngx_temp_file_t *tf);
static void ngx_http_filter_cache_free(ngx_http_cache_t *c, ngx_temp_file_t *tf);
static time_t ngx_http_filter_cache_valid(ngx_array_t *cache_valid, ngx_uint_t status);
static ngx_int_t ngx_http_filter_cache_send_header(ngx_http_request_t *r);
static ngx_int_t ngx_http_filter_cache_send(ngx_http_request_t *r);
/*meta information prepended to every cache file */
typedef struct
{
ngx_uint_t status;
unsigned gzip_vary:1; /* Note: we leave this in on every compile, just in case someone switches between nginx binaries with/without gzip support while object is valid. A long shot I know*/
time_t last_modified_time;
} ngx_http_filter_cache_meta_t;
#define FILTER_TRYCACHE 0
#define FILTER_CACHEABLE 1
#define FILTER_DONOTCACHE 2 /*don't attempt to cache */
#define FILTER_CACHEDONE 3 /* we are done cacheing*/
/*context for the filter*/
typedef struct
{
unsigned cache_status:3;
unsigned cacheable:3;
ngx_str_t key;
ngx_http_cache_t *cache;
ngx_temp_file_t *tf;
ngx_buf_t buffer;
} ngx_http_filter_cache_ctx_t;
static ngx_conf_bitmask_t ngx_http_filter_cache_next_upstream_masks[] = {
{ ngx_string("error"), NGX_HTTP_UPSTREAM_FT_ERROR },
{ ngx_string("timeout"), NGX_HTTP_UPSTREAM_FT_TIMEOUT },
{ ngx_string("invalid_header"), NGX_HTTP_UPSTREAM_FT_INVALID_HEADER },
{ ngx_string("http_500"), NGX_HTTP_UPSTREAM_FT_HTTP_500 },
{ ngx_string("http_503"), NGX_HTTP_UPSTREAM_FT_HTTP_503 },
{ ngx_string("http_404"), NGX_HTTP_UPSTREAM_FT_HTTP_404 },
{ ngx_string("updating"), NGX_HTTP_UPSTREAM_FT_UPDATING },
{ ngx_string("off"), NGX_HTTP_UPSTREAM_FT_OFF },
{ ngx_null_string, 0 }
};
static ngx_str_t ngx_http_filter_cache_hide_headers[] = {
ngx_string("Content-Length"),
ngx_string("Content-Encoding"),
ngx_string("Set-Cookie"),
ngx_string("Last-Modified"),
ngx_null_string
};
static ngx_command_t ngx_http_filter_cache_commands[] = {
{ ngx_string("filter_cache"),
NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_HTTP_LIF_CONF|NGX_CONF_TAKE1,
ngx_http_filter_cache,
NGX_HTTP_LOC_CONF_OFFSET,
0,
NULL },
{ ngx_string("filter_cache_path"),
NGX_HTTP_MAIN_CONF|NGX_CONF_2MORE,
ngx_http_file_cache_set_slot,
0,
0,
&ngx_http_filter_cache_module },
{ ngx_string("filter_cache_bypass"),
NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_1MORE,
ngx_http_set_predicate_slot,
NGX_HTTP_LOC_CONF_OFFSET,
offsetof(ngx_http_filter_cache_conf_t, upstream.cache_bypass),
NULL },
{ ngx_string("filter_cache_disable"),
NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_1MORE,
ngx_http_set_predicate_slot,
NGX_HTTP_LOC_CONF_OFFSET,
offsetof(ngx_http_filter_cache_conf_t, upstream.no_cache),
NULL },
{ ngx_string("filter_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_filter_cache_conf_t, upstream.cache_valid),
NULL },
{ ngx_string("filter_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_filter_cache_conf_t, upstream.cache_min_uses),
NULL },
{ ngx_string("filter_cache_use_stale"),
NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_1MORE,
ngx_conf_set_bitmask_slot,
NGX_HTTP_LOC_CONF_OFFSET,
offsetof(ngx_http_filter_cache_conf_t, upstream.cache_use_stale),
&ngx_http_filter_cache_next_upstream_masks },
{ ngx_string("filter_cache_methods"),
NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_1MORE,
ngx_conf_set_bitmask_slot,
NGX_HTTP_LOC_CONF_OFFSET,
offsetof(ngx_http_filter_cache_conf_t, upstream.cache_methods),
&ngx_http_upstream_cache_method_mask },
{ ngx_string("filter_cache_temp_path"),
NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1234,
ngx_conf_set_path_slot,
NGX_HTTP_LOC_CONF_OFFSET,
offsetof(ngx_http_filter_cache_conf_t, upstream.temp_path),
NULL },
{ ngx_string("filter_cache_buffer_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_filter_cache_conf_t, upstream.buffer_size),
NULL },
{ ngx_string("filter_cache_hide_header"),
NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1,
ngx_conf_set_str_array_slot,
NGX_HTTP_LOC_CONF_OFFSET,
offsetof(ngx_http_filter_cache_conf_t, upstream.hide_headers),
NULL },
{ ngx_string("filter_cache_grace"),
NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1,
ngx_conf_set_sec_slot,
NGX_HTTP_LOC_CONF_OFFSET,
offsetof(ngx_http_filter_cache_conf_t, grace),
NULL },
{ ngx_string("filter_cache_headers_hash_max_size"),
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_filter_cache_conf_t, headers_hash_max_size),
NULL },
{ ngx_string("filter_cache_headers_hash_bucket_size"),
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_filter_cache_conf_t, headers_hash_bucket_size),
NULL },
{ ngx_string("filter_cache_handler"),
NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_FLAG,
ngx_conf_set_flag_slot,
NGX_HTTP_LOC_CONF_OFFSET,
offsetof(ngx_http_filter_cache_conf_t, handler),
NULL },
ngx_null_command
};
static ngx_http_module_t ngx_http_filter_cache_module_ctx = {
ngx_http_filter_cache_add_variables, /* preconfiguration */
ngx_http_filter_cache_init, /* postconfiguration */
NULL, /* create main configuration */
NULL, /* init main configuration */
NULL, /* create server configuration */
NULL, /* merge server configuration */
ngx_http_filter_cache_create_conf, /* create location configuration */
ngx_http_filter_cache_merge_conf /* merge location configuration */
};
ngx_module_t ngx_http_filter_cache_module = {
NGX_MODULE_V1,
&ngx_http_filter_cache_module_ctx, /* module context */
ngx_http_filter_cache_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
};
/* will cleanup the cache, including possible temp file, if we didn't cache it*/
static void
filter_cache_cleanup(void *data)
{
ngx_http_filter_cache_ctx_t *ctx = data;
/*if(ctx && !ctx->cacheable && ctx->cache) {*/
if( ctx && (FILTER_CACHEDONE != ctx->cacheable) && ctx->cache) {
ngx_http_filter_cache_free(ctx->cache, ctx->tf);
}
}
static ngx_http_variable_t ngx_http_filter_cache_vars[] = {
{ ngx_string("filter_cache_status"), NULL,
ngx_http_filter_cache_status, 0,
NGX_HTTP_VAR_NOHASH|NGX_HTTP_VAR_NOCACHEABLE, 0 },
{ ngx_string("gzip_ok"), NULL,
ngx_http_gzip_ok_variable, 0,
NGX_HTTP_VAR_NOHASH|NGX_HTTP_VAR_NOCACHEABLE, 0 },
{ ngx_null_string, NULL, NULL, 0, 0, 0 }
};
static ngx_int_t
ngx_http_filter_cache_add_variables(ngx_conf_t *cf)
{
ngx_http_variable_t *var, *v;
for (v = ngx_http_filter_cache_vars; v->name.len; v++) {
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;
}
static ngx_int_t
ngx_http_gzip_ok_variable(ngx_http_request_t *r, ngx_http_variable_value_t *v, uintptr_t data)
{
char ok = '0';
v->valid = 1;
v->no_cacheable = 0;
v->not_found = 0;
if (!r->gzip_tested) {
ngx_http_gzip_ok(r);
}
if (r->gzip_ok) {
ok = '1';
}
v->data = ngx_pnalloc(r->pool, 2);
v->data[0] = ok;
v->data[1] = '\0';
v->len = 1;
return NGX_OK;
}
static ngx_int_t
ngx_http_filter_cache_init(ngx_conf_t *cf)
{
ngx_http_handler_pt *h;
ngx_http_core_main_conf_t *cmcf;
ngx_http_next_header_filter = ngx_http_top_header_filter;
ngx_http_top_header_filter = ngx_http_filter_cache_header_filter;
ngx_http_next_body_filter = ngx_http_top_body_filter;
ngx_http_top_body_filter = ngx_http_filter_cache_body_filter;
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_filter_cache_content_handler;
return NGX_OK;
}
static void *
ngx_http_filter_cache_create_conf(ngx_conf_t *cf)
{
ngx_http_filter_cache_conf_t *conf = NULL;
conf = ngx_pcalloc(cf->pool, sizeof(ngx_http_filter_cache_conf_t));
if (conf == NULL) {
return NULL;
}
conf->upstream.cache = NGX_CONF_UNSET_PTR;
conf->upstream.cache_min_uses = NGX_CONF_UNSET_UINT;
conf->upstream.cache_bypass = NGX_CONF_UNSET_PTR;
conf->upstream.no_cache = NGX_CONF_UNSET_PTR;
conf->upstream.cache_valid = NGX_CONF_UNSET_PTR;
conf->upstream.buffer_size = NGX_CONF_UNSET_SIZE;
conf->grace = NGX_CONF_UNSET;
conf->upstream.hide_headers = NGX_CONF_UNSET_PTR;
conf->upstream.pass_headers = NGX_CONF_UNSET_PTR;
conf->headers_hash_max_size = NGX_CONF_UNSET_UINT;
conf->headers_hash_bucket_size = NGX_CONF_UNSET_UINT;
conf->handler = NGX_CONF_UNSET;
return conf;
}
static ngx_path_init_t ngx_http_filter_cache_temp_path = {
ngx_string("/tmp/filter_cache"), { 1, 2, 0 }
};
static ngx_int_t find_string_in_array(ngx_str_t *s, ngx_array_t *array)
{
ngx_uint_t i;
ngx_str_t *h;
if(!s || !array || !s->len || !s->data || !array->nelts) {
return 0;
}
h = array->elts;
for (i = 0; i < array->nelts; i++) {
/* we already made sure s->len is not 0 above */
if( (h[i].len == s->len) && h[i].data ) {
/*only need to do check if lengths are the same*/
if(!ngx_strncasecmp((u_char *)h[i].data, (u_char *)s->data, s->len)) {
return 1;
}
}
}
return 0;
}
static ngx_int_t ngx_http_filter_cache_hide_headers_merge(ngx_conf_t *cf, ngx_http_filter_cache_conf_t *conf, ngx_http_filter_cache_conf_t *prev, ngx_str_t *default_hide_headers)
{
ngx_str_t *h, *hk;
ngx_int_t merge = 0;
if (conf->upstream.hide_headers == NGX_CONF_UNSET_PTR) {
conf->upstream.hide_headers = ngx_array_create(cf->pool, 16, sizeof(ngx_str_t));
if (conf->upstream.hide_headers == NULL) {
return NGX_ERROR;
}
}
if(prev->upstream.hide_headers == NGX_CONF_UNSET_PTR) {
/*easy case, neither are set*/
for (h = default_hide_headers; h->len && h->data; h++) {
hk = ngx_array_push(conf->upstream.hide_headers);
if (hk == NULL) {
return NGX_ERROR;
}
*hk = *h;
}
} else {
merge = 1;
}
if(merge) {
/*probably wrong. just make this a list*/
for (h = prev->upstream.hide_headers->elts; h->len; h++) {
/*if we really wanted to squeeze the nth degree out of this, we could sort them and jump out if we find a value "larger" than us??
* or use something qsort and disgard the duplicates? find_string_in_array is pretty effecient, as it only uses stncasecmp as a last resort
*/
if(!find_string_in_array(h, conf->upstream.hide_headers)){
hk = ngx_array_push(conf->upstream.hide_headers);
if (hk == NULL) {
return NGX_ERROR;
}
*hk = *h;
}
}
}
return NGX_OK;
}
static char *
ngx_http_filter_cache_merge_conf(ngx_conf_t *cf, void *parent, void *child)
{
ngx_http_filter_cache_conf_t *prev = parent;
ngx_http_filter_cache_conf_t *conf = child;
/* ngx_hash_init_t hash; */
ngx_conf_merge_uint_value(conf->headers_hash_max_size,
prev->headers_hash_max_size, 512);
ngx_conf_merge_uint_value(conf->headers_hash_bucket_size,
prev->headers_hash_bucket_size, 64);
conf->headers_hash_bucket_size = ngx_align(conf->headers_hash_bucket_size,
ngx_cacheline_size);
if (ngx_http_filter_cache_hide_headers_merge(cf, conf, prev, ngx_http_filter_cache_hide_headers)
!= NGX_OK)
{
return NGX_CONF_ERROR;
}
ngx_conf_merge_ptr_value(conf->upstream.cache,
prev->upstream.cache, NULL);
if (conf->upstream.cache && conf->upstream.cache->data == NULL) {
ngx_shm_zone_t *shm_zone = NULL;
shm_zone = conf->upstream.cache;
ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
"\"filter_cache\" zone \"%V\" is unknown",
&shm_zone->shm.name);
return NGX_CONF_ERROR;
}
ngx_conf_merge_uint_value(conf->upstream.cache_min_uses,
prev->upstream.cache_min_uses, 1);
ngx_conf_merge_bitmask_value(conf->upstream.cache_use_stale,
prev->upstream.cache_use_stale,
(NGX_CONF_BITMASK_SET
|NGX_HTTP_UPSTREAM_FT_OFF));
if (conf->upstream.cache_use_stale & NGX_HTTP_UPSTREAM_FT_OFF) {
conf->upstream.cache_use_stale = NGX_CONF_BITMASK_SET
|NGX_HTTP_UPSTREAM_FT_OFF;
}
if (conf->upstream.cache_methods == 0) {
conf->upstream.cache_methods = prev->upstream.cache_methods;
}
conf->upstream.cache_methods |= NGX_HTTP_GET|NGX_HTTP_HEAD;
ngx_conf_merge_ptr_value(conf->upstream.cache_bypass,
prev->upstream.cache_bypass, NULL);
ngx_conf_merge_ptr_value(conf->upstream.no_cache,
prev->upstream.no_cache, NULL);
if (conf->upstream.no_cache && conf->upstream.cache_bypass == NULL) {
ngx_log_error(NGX_LOG_WARN, cf->log, 0,
"\"filter_cache_disable\" should generally be used together with \"filter_cache_bypass\"");
}
ngx_conf_merge_ptr_value(conf->upstream.cache_valid,
prev->upstream.cache_valid, NULL);
if (conf->cache_key.value.data == NULL) {
conf->cache_key = prev->cache_key;
}
if (ngx_conf_merge_path_value(cf, &conf->upstream.temp_path,
prev->upstream.temp_path,
&ngx_http_filter_cache_temp_path)
!= NGX_OK)
{
return NGX_CONF_ERROR;
}
ngx_conf_merge_size_value(conf->upstream.buffer_size,
prev->upstream.buffer_size,
(size_t) ngx_pagesize);
/* hash.max_size = conf->headers_hash_max_size; */
/* hash.bucket_size = conf->headers_hash_bucket_size; */
/* hash.name = "filter_cache_headers_hash"; */
/* if (ngx_http_upstream_hide_headers_hash(cf, &conf->upstream, */
/* &prev->upstream, ngx_http_filter_cache_hide_headers, &hash) */
/* != NGX_OK) */
/* { */
/* return NGX_CONF_ERROR; */
/* } */
ngx_conf_merge_value(conf->grace,
prev->grace, 0);
ngx_conf_merge_value(conf->handler,
prev->handler, 1);
return NGX_CONF_OK;
}
static char *
ngx_http_filter_cache(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
{
ngx_http_filter_cache_conf_t *lcf = conf;
ngx_http_core_loc_conf_t *core_conf = NULL;
ngx_str_t *value = NULL;
value = cf->args->elts;
if (ngx_strcmp(value[1].data, "off") == 0) {
lcf->upstream.cache = NULL;
return NGX_CONF_OK;
}
if (lcf->upstream.cache != NGX_CONF_UNSET_PTR) {
return "is duplicate";
}
lcf->index = ngx_http_get_variable_index(cf, &ngx_http_filter_cache_key);
if (lcf->index == NGX_ERROR) {
return NGX_CONF_ERROR;
}
lcf->upstream.cache = ngx_shared_memory_add(cf, &value[1], 0,
&ngx_http_filter_cache_module);
if (lcf->upstream.cache == NULL) {
return NGX_CONF_ERROR;
}
core_conf = ngx_http_conf_get_module_loc_conf(cf, ngx_http_core_module);
lcf->orig_handler = core_conf->handler;
if(conf->handler) {
core_conf->handler = ngx_http_filter_cache_handler;
}
return NGX_CONF_OK;
}
/* return 598 when we are not going to attempt to cache this, 599 if it was just a cache miss of some type */
static ngx_int_t cache_miss(ngx_http_request_t *r, ngx_http_filter_cache_ctx_t *ctx, int set_filter, int handler)
{
if(ctx) {
if(set_filter && !r->header_only) {
r->filter_cache = ctx;
ctx->cacheable = FILTER_TRYCACHE; /*this is a hack. the filter will figure out if it is cacheable?? */
if (handler) {
return 599;
} else {
ngx_http_filter_cache_conf_t *conf = ngx_http_get_module_loc_conf(r, ngx_http_filter_cache_module);
return conf->orig_handler ? conf->orig_handler(r) : NGX_DECLINED;
}
}
}
return handler ? 598 : NGX_DECLINED;
}
static ngx_int_t
filter_cache_send(ngx_http_request_t *r)
{
ngx_http_cache_t *c = NULL;
u_char *raw,*p,*hs;
int flag = 0;
ngx_table_elt_t *h = NULL;
ngx_str_t key,value;
ngx_http_filter_cache_meta_t *meta;
ngx_http_filter_cache_ctx_t *ctx = r->filter_cache;
r->cached = 1;
c = ctx->cache;
if (c->header_start == c->body_start) {
r->http_version = NGX_HTTP_VERSION_9;
return ngx_http_filter_cache_send(r);
}
r->headers_out.content_length_n = c->length - c->body_start;
/* Headers */
/* Headers that arent' in the table */
/*initialize ptrs*/
hs = raw = (u_char *)(c->buf->start + c->header_start);
/* Meta data */
meta = (ngx_http_filter_cache_meta_t *)raw;
raw += sizeof(ngx_http_filter_cache_meta_t);
r->headers_out.status = meta->status;
#if (NGX_HTTP_GZIP)
r->gzip_vary = meta->gzip_vary;
#endif
r->headers_out.last_modified_time = meta->last_modified_time;
/* ngx_memcpy((void *)(&r->headers_out.status), (void *)raw, sizeof(ngx_int_t)); */
/* raw += sizeof(ngx_int_t); */
/* Content Type */
key.data = raw;
p = memchr((void *)raw, '\0', c->length - c->header_start);
if ( !p ) {
return NGX_HTTP_INTERNAL_SERVER_ERROR;
}
key.len = p - raw;
raw = p + 1;
r->headers_out.content_type.data = key.data;
r->headers_out.content_type.len = key.len;
r->headers_out.content_type_len = key.len;
r->headers_out.content_type_lowcase = ngx_pnalloc(r->pool, key.len);
if (r->headers_out.content_type_lowcase == NULL ) {
return NGX_HTTP_INTERNAL_SERVER_ERROR;
}
ngx_strlow(r->headers_out.content_type_lowcase, key.data, key.len);
r->headers_out.content_type_hash = ngx_hash_key_lc(key.data, key.len);
/* Charset */
key.data = raw;
p = memchr( (void *)raw, '\0', c->length - c->header_start - ( raw - hs ));
key.len = p - raw;
raw = p + 1;
r->headers_out.charset.data = key.data;
r->headers_out.charset.len = key.len;
/* content encoding */
key.data = raw;
p = memchr( (void *)raw, '\0', c->length - c->header_start - ( raw - hs ));
key.len = p - raw;
if(key.len) {
/*copied from ngx_http_gzip_static_module.c */
h = ngx_list_push(&r->headers_out.headers);
if ( h == NULL ) {
return NGX_HTTP_INTERNAL_SERVER_ERROR;
}
ngx_str_set(&h->key, "Content-Encoding");
h->hash = 1;
h->value.len = key.len;
h->value.data = key.data;
r->headers_out.content_encoding = h;
r->ignore_content_encoding = 1;
}
raw = p + 1;
/* last-modified*/
key.data = raw;
p = memchr( (void *)raw, '\0', c->length - c->header_start - ( raw - hs ));
key.len = p - raw;
if(key.len) {
/*copied from ngx_http_gzip_static_module.c */
h = ngx_list_push(&r->headers_out.headers);
if ( h == NULL ) {
return NGX_HTTP_INTERNAL_SERVER_ERROR;
}
ngx_str_set(&h->key, "Last-Modified");
h->hash = 1;
h->value.len = key.len;
h->value.data = key.data;
r->headers_out.last_modified = h;
}
raw = p + 1;
/* Stuff from the Table */
key.data = raw;
key.len = 0;
value.data = NULL;
value.len = 0;
while( raw < c->buf->start + c->body_start ) {
if ( *raw == '\0' ) {
if ( flag == 0 ) {
flag = 1;
key.len = raw - key.data;
value.data = raw + 1;
}
else {
flag = 0;
value.len = raw - value.data;
/* all this crap pushes a header */
h = ngx_list_push(&r->headers_out.headers);
if ( h == NULL ) {
return NGX_HTTP_INTERNAL_SERVER_ERROR;
}
h->key.len = key.len;
h->key.data = key.data;
h->hash = ngx_hash_key_lc(key.data, key.len);
h->value.len = value.len;
h->value.data = value.data;
if((h->lowcase_key = ngx_pnalloc(r->pool, h->key.len +1)) == NULL) {
return NGX_HTTP_INTERNAL_SERVER_ERROR;
}
ngx_strlow(h->lowcase_key, h->key.data, h->key.len);
key.data = raw + 1;
}
}
raw++;
}
return ngx_http_filter_cache_send(r);
}
static ngx_int_t
ngx_http_filter_cache_content_handler(ngx_http_request_t *r)
{
ngx_http_filter_cache_conf_t *conf = ngx_http_get_module_loc_conf(r, ngx_http_filter_cache_module);
if (conf->orig_handler || conf->handler) {
/*we have another handler, so we can't handle it here at all*/
return NGX_DECLINED;
}
return ngx_http_filter_cache_handler(r);
}
static ngx_int_t
ngx_http_filter_cache_handler(ngx_http_request_t *r)
{
ngx_http_filter_cache_ctx_t *ctx = NULL;
ngx_http_filter_cache_conf_t *conf = NULL;
ngx_http_variable_value_t *vv = NULL;
ngx_http_cache_t *c = NULL;
ngx_str_t *key = NULL;
ngx_int_t rc = NGX_ERROR;
if(r != r->main) {
/* we don't currently serve subrequests
* if we ever do subrequests, we will need a way to associate a ctx with this request
* maybe keep an r in ctx and compare to r here?
*/
return cache_miss(r, NULL, 0, 0);
}
conf = ngx_http_get_module_loc_conf(r, ngx_http_filter_cache_module);
/* turned off */
if (NULL == conf->upstream.cache) {
return cache_miss(r, NULL, 0, conf->handler);
}
ctx = r->filter_cache;
if(ctx) {
/*loop detected??*/
ngx_log_error(NGX_LOG_INFO, r->connection->log, 0,
"cache loop in " __FILE__);
/* XXX: this causes a 598 to be returned. Is that what we want???
* should loop return yet another status code??
* be configurable and default to 598??
*/
return cache_miss(r, NULL, 0, conf->handler);
}
ctx = ngx_pcalloc(r->pool, sizeof(ngx_http_filter_cache_ctx_t));
if (ctx == NULL) {
return NGX_ERROR;
}
ctx->cache = NULL;
ctx->cacheable = FILTER_DONOTCACHE;
ctx->cache_status = NGX_HTTP_CACHE_MISS;
/* needed so the ctx works in cache status*/
r->filter_cache = ctx;
switch (ngx_http_test_predicates(r, conf->upstream.cache_bypass)) {
case NGX_ERROR:
ngx_log_error(NGX_LOG_ERR, r->connection->log, 0, __FILE__" ngx_http_test_predicates returned an error for bypass");
return NGX_ERROR;
case NGX_DECLINED:
ctx->cache_status = NGX_HTTP_CACHE_BYPASS;
return cache_miss(r, NULL, 0, conf->handler);
default: /* NGX_OK */
break;
}
if (!(r->method & conf->upstream.cache_methods)) {
return cache_miss(r, NULL, 0, conf->handler);
}
rc = ngx_http_discard_request_body(r);
if (rc != NGX_OK && rc != NGX_AGAIN) {
return rc;
}
vv = ngx_http_get_indexed_variable(r, conf->index);
if (vv == NULL || vv->not_found || vv->len == 0) {
ngx_log_error(NGX_LOG_ERR, r->connection->log, 0,
"the \"filter_cache_key\" variable is not set");
return NGX_ERROR;
}
ctx->key.data = vv->data;
ctx->key.len = vv->len;
c = ctx->cache = NULL;
if (ngx_http_filter_cache_new(r) != NGX_OK) {
return NGX_ERROR;
}
key = ngx_array_push(&ctx->cache->keys);
if (key == NULL) {
return NGX_ERROR;
}
key->data = ctx->key.data;
key->len = ctx->key.len;
ctx->cache->file_cache = conf->upstream.cache->data;
ngx_http_filter_cache_create_key(r);
/* ngx_http_filter_cache_create(r); */
c = ctx->cache;
c->min_uses = conf->upstream.cache_min_uses;
c->body_start = conf->upstream.buffer_size;
c->file_cache = conf->upstream.cache->data;
rc = ngx_http_filter_cache_open(r);
switch(rc) {
case NGX_HTTP_CACHE_UPDATING:
if (conf->upstream.cache_use_stale & NGX_HTTP_UPSTREAM_FT_UPDATING) {
if(ctx->cache && conf->grace && ( (ctx->cache->valid_sec - ngx_time() ) < conf->grace)) {
ctx->cache_status = NGX_HTTP_CACHE_UPDATING;
rc = NGX_OK;
} else {
rc = NGX_HTTP_CACHE_STALE;
}
} else {
rc = NGX_HTTP_CACHE_STALE;
}
break;
case NGX_OK:
ctx->cache_status = NGX_HTTP_CACHE_HIT;
}
switch (rc) {
case NGX_OK:
return filter_cache_send(r);
break;
case NGX_HTTP_CACHE_STALE:
ctx->cache_status = NGX_HTTP_CACHE_EXPIRED;
/*return 599;*/
break;
case NGX_DECLINED:
break;
case NGX_HTTP_CACHE_SCARCE:
return cache_miss(r, ctx, 0, conf->handler);
break;
case NGX_AGAIN:
return NGX_BUSY;
case NGX_ERROR:
return NGX_ERROR;
default:
/*????*/
break;
}
return cache_miss(r, ctx, 1, conf->handler);
}
static ngx_int_t
ngx_http_filter_cache_header_filter(ngx_http_request_t *r)
{
ngx_http_filter_cache_ctx_t *ctx = NULL;
ngx_http_filter_cache_conf_t *conf = NULL;
time_t now, valid;
ngx_temp_file_t *tf;
ngx_chain_t out;
ssize_t offset;
ngx_list_part_t *part;
ngx_table_elt_t *h;
ngx_uint_t i;
u_char *p;
size_t len;
ngx_pool_cleanup_t *cln = NULL;
ngx_http_filter_cache_meta_t meta;
if(r != r->main) {
/*just skip as we got headers in main*/
return ngx_http_next_header_filter(r);
}
conf = ngx_http_get_module_loc_conf(r, ngx_http_filter_cache_module);
switch (ngx_http_test_predicates(r, conf->upstream.no_cache)) {
case NGX_ERROR:
ngx_log_error(NGX_LOG_ERR, r->connection->log, 0, __FILE__" ngx_http_test_predicates returned an error for no_cache");
return NGX_ERROR;
case NGX_DECLINED:
goto nocache;
default: /* NGX_OK */
break;
}
ctx = r->filter_cache;
if(!ctx || (FILTER_DONOTCACHE == ctx->cacheable)) {
goto nocache;
}
/* ngx_http_filter_cache_create(r); */
if (ctx->cache && ctx->cache->file.fd != NGX_INVALID_FILE) {
ngx_pool_run_cleanup_file(r->pool, ctx->cache->file.fd);
ctx->cache->file.fd = NGX_INVALID_FILE;
}
ctx->cache->valid_sec = 0;
now = ngx_time();
valid = 0;
valid = ngx_http_filter_cache_valid(conf->upstream.cache_valid,
r->headers_out.status);
if (valid) {
ctx->cache->valid_sec = now + valid;
} else {
goto nocache;
}
tf = ngx_pcalloc(r->pool, sizeof(ngx_temp_file_t));
if (tf == NULL) {
return NGX_ERROR;
}
tf->file.fd = NGX_INVALID_FILE;
tf->file.log = r->connection->log;
tf->path = conf->upstream.temp_path;
tf->pool = r->pool;
tf->persistent = 1;
if (ngx_create_temp_file(&tf->file, tf->path, tf->pool,
tf->persistent, tf->clean, tf->access)
!= NGX_OK) {
return NGX_ERROR;
}
ctx->tf = tf;
cln = ngx_pool_cleanup_add(r->pool, 0);
if (cln == NULL) {
return NGX_ERROR;
}
cln->handler = filter_cache_cleanup;
cln->data = ctx;
ctx->buffer.pos = ctx->buffer.start = ngx_palloc(r->pool, conf->upstream.buffer_size);
ctx->buffer.end = ctx->buffer.start + conf->upstream.buffer_size;
ctx->buffer.temporary = 1;
ctx->buffer.memory = 1;
ctx->buffer.last_buf = 1;
ctx->buffer.pos += ctx->cache->header_start;
ctx->cache->last_modified = r->headers_out.last_modified_time;
ctx->cache->date = now;
/* Headers */
/* fill in the metadata*/
meta.status = r->headers_out.status;
#if (NGX_HTTP_GZIP)
meta.gzip_vary = r->gzip_vary; /* Note: there is still some wierdness to how gzip_vary works...*/
#endif
meta.last_modified_time = r->headers_out.last_modified_time;
ngx_memcpy((void *)(ctx->buffer.pos), (void *)(&meta), sizeof(ngx_http_filter_cache_meta_t) );
ctx->buffer.pos += sizeof(ngx_http_filter_cache_meta_t);
/* Headers taht aren't in teh table for some reason */
/*Do we need to try to set it if it's not set???*/
/* Content Type */
if ( r->headers_out.content_type.data ) {