3 * Copyright (C) Igor Sysoev
4 * Copyright (C) Nginx, Inc.
8 #include <ngx_config.h>
13 typedef struct ngx_http_header_val_s ngx_http_header_val_t
;
15 typedef ngx_int_t (*ngx_http_set_header_pt
)(ngx_http_request_t
*r
,
16 ngx_http_header_val_t
*hv
, ngx_str_t
*value
);
22 ngx_http_set_header_pt handler
;
23 } ngx_http_set_header_t
;
26 struct ngx_http_header_val_s
{
27 ngx_http_complex_value_t value
;
29 ngx_http_set_header_pt handler
;
36 NGX_HTTP_EXPIRES_EPOCH
,
38 NGX_HTTP_EXPIRES_ACCESS
,
39 NGX_HTTP_EXPIRES_MODIFIED
,
40 NGX_HTTP_EXPIRES_DAILY
,
41 NGX_HTTP_EXPIRES_UNSET
46 ngx_http_expires_t expires
;
49 } ngx_http_headers_conf_t
;
52 static ngx_int_t
ngx_http_set_expires(ngx_http_request_t
*r
,
53 ngx_http_headers_conf_t
*conf
);
54 static ngx_int_t
ngx_http_add_cache_control(ngx_http_request_t
*r
,
55 ngx_http_header_val_t
*hv
, ngx_str_t
*value
);
56 static ngx_int_t
ngx_http_add_header(ngx_http_request_t
*r
,
57 ngx_http_header_val_t
*hv
, ngx_str_t
*value
);
58 static ngx_int_t
ngx_http_set_last_modified(ngx_http_request_t
*r
,
59 ngx_http_header_val_t
*hv
, ngx_str_t
*value
);
60 static ngx_int_t
ngx_http_set_response_header(ngx_http_request_t
*r
,
61 ngx_http_header_val_t
*hv
, ngx_str_t
*value
);
63 static void *ngx_http_headers_create_conf(ngx_conf_t
*cf
);
64 static char *ngx_http_headers_merge_conf(ngx_conf_t
*cf
,
65 void *parent
, void *child
);
66 static ngx_int_t
ngx_http_headers_filter_init(ngx_conf_t
*cf
);
67 static char *ngx_http_headers_expires(ngx_conf_t
*cf
, ngx_command_t
*cmd
,
69 static char *ngx_http_headers_add(ngx_conf_t
*cf
, ngx_command_t
*cmd
,
73 static ngx_http_set_header_t ngx_http_set_headers
[] = {
75 { ngx_string("Cache-Control"), 0, ngx_http_add_cache_control
},
77 { ngx_string("Last-Modified"),
78 offsetof(ngx_http_headers_out_t
, last_modified
),
79 ngx_http_set_last_modified
},
82 offsetof(ngx_http_headers_out_t
, etag
),
83 ngx_http_set_response_header
},
85 { ngx_null_string
, 0, NULL
}
89 static ngx_command_t ngx_http_headers_filter_commands
[] = {
91 { ngx_string("expires"),
92 NGX_HTTP_MAIN_CONF
|NGX_HTTP_SRV_CONF
|NGX_HTTP_LOC_CONF
|NGX_HTTP_LIF_CONF
94 ngx_http_headers_expires
,
95 NGX_HTTP_LOC_CONF_OFFSET
,
99 { ngx_string("add_header"),
100 NGX_HTTP_MAIN_CONF
|NGX_HTTP_SRV_CONF
|NGX_HTTP_LOC_CONF
|NGX_HTTP_LIF_CONF
102 ngx_http_headers_add
,
103 NGX_HTTP_LOC_CONF_OFFSET
,
111 static ngx_http_module_t ngx_http_headers_filter_module_ctx
= {
112 NULL
, /* preconfiguration */
113 ngx_http_headers_filter_init
, /* postconfiguration */
115 NULL
, /* create main configuration */
116 NULL
, /* init main configuration */
118 NULL
, /* create server configuration */
119 NULL
, /* merge server configuration */
121 ngx_http_headers_create_conf
, /* create location configuration */
122 ngx_http_headers_merge_conf
/* merge location configuration */
126 ngx_module_t ngx_http_headers_filter_module
= {
128 &ngx_http_headers_filter_module_ctx
, /* module context */
129 ngx_http_headers_filter_commands
, /* module directives */
130 NGX_HTTP_MODULE
, /* module type */
131 NULL
, /* init master */
132 NULL
, /* init module */
133 NULL
, /* init process */
134 NULL
, /* init thread */
135 NULL
, /* exit thread */
136 NULL
, /* exit process */
137 NULL
, /* exit master */
138 NGX_MODULE_V1_PADDING
142 static ngx_http_output_header_filter_pt ngx_http_next_header_filter
;
146 ngx_http_headers_filter(ngx_http_request_t
*r
)
150 ngx_http_header_val_t
*h
;
151 ngx_http_headers_conf_t
*conf
;
153 conf
= ngx_http_get_module_loc_conf(r
, ngx_http_headers_filter_module
);
155 if ((conf
->expires
== NGX_HTTP_EXPIRES_OFF
&& conf
->headers
== NULL
)
157 || (r
->headers_out
.status
!= NGX_HTTP_OK
158 && r
->headers_out
.status
!= NGX_HTTP_CREATED
159 && r
->headers_out
.status
!= NGX_HTTP_NO_CONTENT
160 && r
->headers_out
.status
!= NGX_HTTP_PARTIAL_CONTENT
161 && r
->headers_out
.status
!= NGX_HTTP_MOVED_PERMANENTLY
162 && r
->headers_out
.status
!= NGX_HTTP_MOVED_TEMPORARILY
163 && r
->headers_out
.status
!= NGX_HTTP_SEE_OTHER
164 && r
->headers_out
.status
!= NGX_HTTP_NOT_MODIFIED
165 && r
->headers_out
.status
!= NGX_HTTP_TEMPORARY_REDIRECT
))
167 return ngx_http_next_header_filter(r
);
170 if (conf
->expires
!= NGX_HTTP_EXPIRES_OFF
) {
171 if (ngx_http_set_expires(r
, conf
) != NGX_OK
) {
177 h
= conf
->headers
->elts
;
178 for (i
= 0; i
< conf
->headers
->nelts
; i
++) {
180 if (ngx_http_complex_value(r
, &h
[i
].value
, &value
) != NGX_OK
) {
184 if (h
[i
].handler(r
, &h
[i
], &value
) != NGX_OK
) {
190 return ngx_http_next_header_filter(r
);
195 ngx_http_set_expires(ngx_http_request_t
*r
, ngx_http_headers_conf_t
*conf
)
198 time_t now
, expires_time
, max_age
;
200 ngx_table_elt_t
*expires
, *cc
, **ccp
;
202 expires
= r
->headers_out
.expires
;
204 if (expires
== NULL
) {
206 expires
= ngx_list_push(&r
->headers_out
.headers
);
207 if (expires
== NULL
) {
211 r
->headers_out
.expires
= expires
;
214 ngx_str_set(&expires
->key
, "Expires");
217 len
= sizeof("Mon, 28 Sep 1970 06:00:00 GMT");
218 expires
->value
.len
= len
- 1;
220 ccp
= r
->headers_out
.cache_control
.elts
;
224 if (ngx_array_init(&r
->headers_out
.cache_control
, r
->pool
,
225 1, sizeof(ngx_table_elt_t
*))
231 ccp
= ngx_array_push(&r
->headers_out
.cache_control
);
236 cc
= ngx_list_push(&r
->headers_out
.headers
);
242 ngx_str_set(&cc
->key
, "Cache-Control");
246 for (i
= 1; i
< r
->headers_out
.cache_control
.nelts
; i
++) {
253 if (conf
->expires
== NGX_HTTP_EXPIRES_EPOCH
) {
254 expires
->value
.data
= (u_char
*) "Thu, 01 Jan 1970 00:00:01 GMT";
255 ngx_str_set(&cc
->value
, "no-cache");
259 if (conf
->expires
== NGX_HTTP_EXPIRES_MAX
) {
260 expires
->value
.data
= (u_char
*) "Thu, 31 Dec 2037 23:55:55 GMT";
262 ngx_str_set(&cc
->value
, "max-age=315360000");
266 expires
->value
.data
= ngx_pnalloc(r
->pool
, len
);
267 if (expires
->value
.data
== NULL
) {
271 if (conf
->expires_time
== 0 && conf
->expires
!= NGX_HTTP_EXPIRES_DAILY
) {
272 ngx_memcpy(expires
->value
.data
, ngx_cached_http_time
.data
,
273 ngx_cached_http_time
.len
+ 1);
274 ngx_str_set(&cc
->value
, "max-age=0");
280 if (conf
->expires
== NGX_HTTP_EXPIRES_DAILY
) {
281 expires_time
= ngx_next_time(conf
->expires_time
);
282 max_age
= expires_time
- now
;
284 } else if (conf
->expires
== NGX_HTTP_EXPIRES_ACCESS
285 || r
->headers_out
.last_modified_time
== -1)
287 expires_time
= now
+ conf
->expires_time
;
288 max_age
= conf
->expires_time
;
291 expires_time
= r
->headers_out
.last_modified_time
+ conf
->expires_time
;
292 max_age
= expires_time
- now
;
295 ngx_http_time(expires
->value
.data
, expires_time
);
297 if (conf
->expires_time
< 0 || max_age
< 0) {
298 ngx_str_set(&cc
->value
, "no-cache");
302 cc
->value
.data
= ngx_pnalloc(r
->pool
,
303 sizeof("max-age=") + NGX_TIME_T_LEN
+ 1);
304 if (cc
->value
.data
== NULL
) {
308 cc
->value
.len
= ngx_sprintf(cc
->value
.data
, "max-age=%T", max_age
)
316 ngx_http_add_header(ngx_http_request_t
*r
, ngx_http_header_val_t
*hv
,
322 h
= ngx_list_push(&r
->headers_out
.headers
);
337 ngx_http_add_cache_control(ngx_http_request_t
*r
, ngx_http_header_val_t
*hv
,
340 ngx_table_elt_t
*cc
, **ccp
;
342 ccp
= r
->headers_out
.cache_control
.elts
;
346 if (ngx_array_init(&r
->headers_out
.cache_control
, r
->pool
,
347 1, sizeof(ngx_table_elt_t
*))
354 ccp
= ngx_array_push(&r
->headers_out
.cache_control
);
359 cc
= ngx_list_push(&r
->headers_out
.headers
);
365 ngx_str_set(&cc
->key
, "Cache-Control");
375 ngx_http_set_last_modified(ngx_http_request_t
*r
, ngx_http_header_val_t
*hv
,
378 if (ngx_http_set_response_header(r
, hv
, value
) != NGX_OK
) {
382 r
->headers_out
.last_modified_time
=
383 (value
->len
) ? ngx_http_parse_time(value
->data
, value
->len
) : -1;
390 ngx_http_set_response_header(ngx_http_request_t
*r
, ngx_http_header_val_t
*hv
,
393 ngx_table_elt_t
*h
, **old
;
395 old
= (ngx_table_elt_t
**) ((char *) &r
->headers_out
+ hv
->offset
);
397 if (value
->len
== 0) {
410 h
= ngx_list_push(&r
->headers_out
.headers
);
427 ngx_http_headers_create_conf(ngx_conf_t
*cf
)
429 ngx_http_headers_conf_t
*conf
;
431 conf
= ngx_pcalloc(cf
->pool
, sizeof(ngx_http_headers_conf_t
));
437 * set by ngx_pcalloc():
439 * conf->headers = NULL;
440 * conf->expires_time = 0;
443 conf
->expires
= NGX_HTTP_EXPIRES_UNSET
;
450 ngx_http_headers_merge_conf(ngx_conf_t
*cf
, void *parent
, void *child
)
452 ngx_http_headers_conf_t
*prev
= parent
;
453 ngx_http_headers_conf_t
*conf
= child
;
455 if (conf
->expires
== NGX_HTTP_EXPIRES_UNSET
) {
456 conf
->expires
= prev
->expires
;
457 conf
->expires_time
= prev
->expires_time
;
459 if (conf
->expires
== NGX_HTTP_EXPIRES_UNSET
) {
460 conf
->expires
= NGX_HTTP_EXPIRES_OFF
;
464 if (conf
->headers
== NULL
) {
465 conf
->headers
= prev
->headers
;
473 ngx_http_headers_filter_init(ngx_conf_t
*cf
)
475 ngx_http_next_header_filter
= ngx_http_top_header_filter
;
476 ngx_http_top_header_filter
= ngx_http_headers_filter
;
483 ngx_http_headers_expires(ngx_conf_t
*cf
, ngx_command_t
*cmd
, void *conf
)
485 ngx_http_headers_conf_t
*hcf
= conf
;
490 if (hcf
->expires
!= NGX_HTTP_EXPIRES_UNSET
) {
491 return "is duplicate";
494 value
= cf
->args
->elts
;
496 if (cf
->args
->nelts
== 2) {
498 if (ngx_strcmp(value
[1].data
, "epoch") == 0) {
499 hcf
->expires
= NGX_HTTP_EXPIRES_EPOCH
;
503 if (ngx_strcmp(value
[1].data
, "max") == 0) {
504 hcf
->expires
= NGX_HTTP_EXPIRES_MAX
;
508 if (ngx_strcmp(value
[1].data
, "off") == 0) {
509 hcf
->expires
= NGX_HTTP_EXPIRES_OFF
;
513 hcf
->expires
= NGX_HTTP_EXPIRES_ACCESS
;
517 } else { /* cf->args->nelts == 3 */
519 if (ngx_strcmp(value
[1].data
, "modified") != 0) {
520 return "invalid value";
523 hcf
->expires
= NGX_HTTP_EXPIRES_MODIFIED
;
528 if (value
[n
].data
[0] == '@') {
533 if (hcf
->expires
== NGX_HTTP_EXPIRES_MODIFIED
) {
534 return "daily time cannot be used with \"modified\" parameter";
537 hcf
->expires
= NGX_HTTP_EXPIRES_DAILY
;
539 } else if (value
[n
].data
[0] == '+') {
544 } else if (value
[n
].data
[0] == '-') {
553 hcf
->expires_time
= ngx_parse_time(&value
[n
], 1);
555 if (hcf
->expires_time
== (time_t) NGX_ERROR
) {
556 return "invalid value";
559 if (hcf
->expires
== NGX_HTTP_EXPIRES_DAILY
560 && hcf
->expires_time
> 24 * 60 * 60)
562 return "daily time value must be less than 24 hours";
566 hcf
->expires_time
= - hcf
->expires_time
;
574 ngx_http_headers_add(ngx_conf_t
*cf
, ngx_command_t
*cmd
, void *conf
)
576 ngx_http_headers_conf_t
*hcf
= conf
;
580 ngx_http_header_val_t
*hv
;
581 ngx_http_set_header_t
*set
;
582 ngx_http_compile_complex_value_t ccv
;
584 value
= cf
->args
->elts
;
586 if (hcf
->headers
== NULL
) {
587 hcf
->headers
= ngx_array_create(cf
->pool
, 1,
588 sizeof(ngx_http_header_val_t
));
589 if (hcf
->headers
== NULL
) {
590 return NGX_CONF_ERROR
;
594 hv
= ngx_array_push(hcf
->headers
);
596 return NGX_CONF_ERROR
;
600 hv
->handler
= ngx_http_add_header
;
603 set
= ngx_http_set_headers
;
604 for (i
= 0; set
[i
].name
.len
; i
++) {
605 if (ngx_strcasecmp(value
[1].data
, set
[i
].name
.data
) != 0) {
609 hv
->offset
= set
[i
].offset
;
610 hv
->handler
= set
[i
].handler
;
615 if (value
[2].len
== 0) {
616 ngx_memzero(&hv
->value
, sizeof(ngx_http_complex_value_t
));
620 ngx_memzero(&ccv
, sizeof(ngx_http_compile_complex_value_t
));
623 ccv
.value
= &value
[2];
624 ccv
.complex_value
= &hv
->value
;
626 if (ngx_http_compile_complex_value(&ccv
) != NGX_OK
) {
627 return NGX_CONF_ERROR
;