3 * Copyright (C) Igor Sysoev
7 #include <ngx_config.h>
13 static ngx_int_t ngx_http_variable_request(ngx_http_request_t *r,
14 ngx_http_variable_value_t *v, uintptr_t data);
15 static void ngx_http_variable_request_set(ngx_http_request_t *r,
16 ngx_http_variable_value_t *v, uintptr_t data);
17 static void ngx_http_variable_request_set_size(ngx_http_request_t *r,
18 ngx_http_variable_value_t *v, uintptr_t data);
19 static ngx_int_t ngx_http_variable_header(ngx_http_request_t *r,
20 ngx_http_variable_value_t *v, uintptr_t data);
21 static ngx_int_t ngx_http_variable_headers(ngx_http_request_t *r,
22 ngx_http_variable_value_t *v, uintptr_t data);
24 static ngx_int_t ngx_http_variable_unknown_header_in(ngx_http_request_t *r,
25 ngx_http_variable_value_t *v, uintptr_t data);
26 static ngx_int_t ngx_http_variable_unknown_header_out(ngx_http_request_t *r,
27 ngx_http_variable_value_t *v, uintptr_t data);
28 static ngx_int_t ngx_http_variable_cookie(ngx_http_request_t *r,
29 ngx_http_variable_value_t *v, uintptr_t data);
30 static ngx_int_t ngx_http_variable_argument(ngx_http_request_t *r,
31 ngx_http_variable_value_t *v, uintptr_t data);
33 static ngx_int_t ngx_http_variable_host(ngx_http_request_t *r,
34 ngx_http_variable_value_t *v, uintptr_t data);
35 static ngx_int_t ngx_http_variable_binary_remote_addr(ngx_http_request_t *r,
36 ngx_http_variable_value_t *v, uintptr_t data);
37 static ngx_int_t ngx_http_variable_remote_addr(ngx_http_request_t *r,
38 ngx_http_variable_value_t *v, uintptr_t data);
39 static ngx_int_t ngx_http_variable_remote_port(ngx_http_request_t *r,
40 ngx_http_variable_value_t *v, uintptr_t data);
41 static ngx_int_t ngx_http_variable_server_addr(ngx_http_request_t *r,
42 ngx_http_variable_value_t *v, uintptr_t data);
43 static ngx_int_t ngx_http_variable_server_port(ngx_http_request_t *r,
44 ngx_http_variable_value_t *v, uintptr_t data);
45 static ngx_int_t ngx_http_variable_scheme(ngx_http_request_t *r,
46 ngx_http_variable_value_t *v, uintptr_t data);
47 static ngx_int_t ngx_http_variable_is_args(ngx_http_request_t *r,
48 ngx_http_variable_value_t *v, uintptr_t data);
49 static ngx_int_t ngx_http_variable_document_root(ngx_http_request_t *r,
50 ngx_http_variable_value_t *v, uintptr_t data);
51 static ngx_int_t ngx_http_variable_realpath_root(ngx_http_request_t *r,
52 ngx_http_variable_value_t *v, uintptr_t data);
53 static ngx_int_t ngx_http_variable_request_filename(ngx_http_request_t *r,
54 ngx_http_variable_value_t *v, uintptr_t data);
55 static ngx_int_t ngx_http_variable_server_name(ngx_http_request_t *r,
56 ngx_http_variable_value_t *v, uintptr_t data);
57 static ngx_int_t ngx_http_variable_request_method(ngx_http_request_t *r,
58 ngx_http_variable_value_t *v, uintptr_t data);
59 static ngx_int_t ngx_http_variable_remote_user(ngx_http_request_t *r,
60 ngx_http_variable_value_t *v, uintptr_t data);
61 static ngx_int_t ngx_http_variable_body_bytes_sent(ngx_http_request_t *r,
62 ngx_http_variable_value_t *v, uintptr_t data);
63 static ngx_int_t ngx_http_variable_request_completion(ngx_http_request_t *r,
64 ngx_http_variable_value_t *v, uintptr_t data);
65 static ngx_int_t ngx_http_variable_request_body_file(ngx_http_request_t *r,
66 ngx_http_variable_value_t *v, uintptr_t data);
68 static ngx_int_t ngx_http_variable_sent_content_type(ngx_http_request_t *r,
69 ngx_http_variable_value_t *v, uintptr_t data);
70 static ngx_int_t ngx_http_variable_sent_content_length(ngx_http_request_t *r,
71 ngx_http_variable_value_t *v, uintptr_t data);
72 static ngx_int_t ngx_http_variable_sent_last_modified(ngx_http_request_t *r,
73 ngx_http_variable_value_t *v, uintptr_t data);
74 static ngx_int_t ngx_http_variable_sent_connection(ngx_http_request_t *r,
75 ngx_http_variable_value_t *v, uintptr_t data);
76 static ngx_int_t ngx_http_variable_sent_keep_alive(ngx_http_request_t *r,
77 ngx_http_variable_value_t *v, uintptr_t data);
78 static ngx_int_t ngx_http_variable_sent_transfer_encoding(ngx_http_request_t *r,
79 ngx_http_variable_value_t *v, uintptr_t data);
81 static ngx_int_t ngx_http_variable_nginx_version(ngx_http_request_t *r,
82 ngx_http_variable_value_t *v, uintptr_t data);
83 static ngx_int_t ngx_http_variable_hostname(ngx_http_request_t *r,
84 ngx_http_variable_value_t *v, uintptr_t data);
85 static ngx_int_t ngx_http_variable_pid(ngx_http_request_t *r,
86 ngx_http_variable_value_t *v, uintptr_t data);
90 * Apache CGI: AUTH_TYPE, PATH_INFO (null), PATH_TRANSLATED
91 * REMOTE_HOST (null), REMOTE_IDENT (null),
94 * Apache SSI: DOCUMENT_NAME, LAST_MODIFIED, USER_NAME (file owner)
98 * the $http_host, $http_user_agent, $http_referer, $http_via,
99 * and $http_x_forwarded_for variables may be handled by generic
100 * ngx_http_variable_unknown_header_in(), but for perfomance reasons
101 * they are handled using dedicated entries
104 static ngx_http_variable_t ngx_http_core_variables[] = {
106 { ngx_string("http_host"), NULL, ngx_http_variable_header,
107 offsetof(ngx_http_request_t, headers_in.host), 0, 0 },
109 { ngx_string("http_user_agent"), NULL, ngx_http_variable_header,
110 offsetof(ngx_http_request_t, headers_in.user_agent), 0, 0 },
112 { ngx_string("http_referer"), NULL, ngx_http_variable_header,
113 offsetof(ngx_http_request_t, headers_in.referer), 0, 0 },
116 { ngx_string("http_via"), NULL, ngx_http_variable_header,
117 offsetof(ngx_http_request_t, headers_in.via), 0, 0 },
120 #if (NGX_HTTP_PROXY || NGX_HTTP_REALIP)
121 { ngx_string("http_x_forwarded_for"), NULL, ngx_http_variable_header,
122 offsetof(ngx_http_request_t, headers_in.x_forwarded_for), 0, 0 },
125 { ngx_string("http_cookie"), NULL, ngx_http_variable_headers,
126 offsetof(ngx_http_request_t, headers_in.cookies), 0, 0 },
128 { ngx_string("content_length"), NULL, ngx_http_variable_header,
129 offsetof(ngx_http_request_t, headers_in.content_length), 0, 0 },
131 { ngx_string("content_type"), NULL, ngx_http_variable_header,
132 offsetof(ngx_http_request_t, headers_in.content_type), 0, 0 },
134 { ngx_string("host"), NULL, ngx_http_variable_host, 0, 0, 0 },
136 { ngx_string("binary_remote_addr"), NULL,
137 ngx_http_variable_binary_remote_addr, 0, 0, 0 },
139 { ngx_string("remote_addr"), NULL, ngx_http_variable_remote_addr, 0, 0, 0 },
141 { ngx_string("remote_port"), NULL, ngx_http_variable_remote_port, 0, 0, 0 },
143 { ngx_string("server_addr"), NULL, ngx_http_variable_server_addr, 0, 0, 0 },
145 { ngx_string("server_port"), NULL, ngx_http_variable_server_port, 0, 0, 0 },
147 { ngx_string("server_protocol"), NULL, ngx_http_variable_request,
148 offsetof(ngx_http_request_t, http_protocol), 0, 0 },
150 { ngx_string("scheme"), NULL, ngx_http_variable_scheme, 0, 0, 0 },
152 { ngx_string("request_uri"), NULL, ngx_http_variable_request,
153 offsetof(ngx_http_request_t, unparsed_uri), 0, 0 },
155 { ngx_string("uri"), NULL, ngx_http_variable_request,
156 offsetof(ngx_http_request_t, uri),
157 NGX_HTTP_VAR_NOCACHEABLE, 0 },
159 { ngx_string("document_uri"), NULL, ngx_http_variable_request,
160 offsetof(ngx_http_request_t, uri),
161 NGX_HTTP_VAR_NOCACHEABLE, 0 },
163 { ngx_string("request"), NULL, ngx_http_variable_request,
164 offsetof(ngx_http_request_t, request_line), 0, 0 },
166 { ngx_string("document_root"), NULL,
167 ngx_http_variable_document_root, 0, NGX_HTTP_VAR_NOCACHEABLE, 0 },
169 { ngx_string("realpath_root"), NULL,
170 ngx_http_variable_realpath_root, 0, NGX_HTTP_VAR_NOCACHEABLE, 0 },
172 { ngx_string("query_string"), NULL, ngx_http_variable_request,
173 offsetof(ngx_http_request_t, args),
174 NGX_HTTP_VAR_NOCACHEABLE, 0 },
176 { ngx_string("args"),
177 ngx_http_variable_request_set,
178 ngx_http_variable_request,
179 offsetof(ngx_http_request_t, args),
180 NGX_HTTP_VAR_CHANGEABLE|NGX_HTTP_VAR_NOCACHEABLE, 0 },
182 { ngx_string("is_args"), NULL, ngx_http_variable_is_args,
183 0, NGX_HTTP_VAR_NOCACHEABLE, 0 },
185 { ngx_string("request_filename"), NULL,
186 ngx_http_variable_request_filename, 0,
187 NGX_HTTP_VAR_NOCACHEABLE, 0 },
189 { ngx_string("server_name"), NULL, ngx_http_variable_server_name, 0, 0, 0 },
191 { ngx_string("request_method"), NULL,
192 ngx_http_variable_request_method, 0, 0, 0 },
194 { ngx_string("remote_user"), NULL, ngx_http_variable_remote_user, 0, 0, 0 },
196 { ngx_string("body_bytes_sent"), NULL, ngx_http_variable_body_bytes_sent,
199 { ngx_string("request_completion"), NULL,
200 ngx_http_variable_request_completion,
203 { ngx_string("request_body_file"), NULL,
204 ngx_http_variable_request_body_file,
207 { ngx_string("sent_http_content_type"), NULL,
208 ngx_http_variable_sent_content_type, 0, 0, 0 },
210 { ngx_string("sent_http_content_length"), NULL,
211 ngx_http_variable_sent_content_length, 0, 0, 0 },
213 { ngx_string("sent_http_last_modified"), NULL,
214 ngx_http_variable_sent_last_modified, 0, 0, 0 },
216 { ngx_string("sent_http_connection"), NULL,
217 ngx_http_variable_sent_connection, 0, 0, 0 },
219 { ngx_string("sent_http_keep_alive"), NULL,
220 ngx_http_variable_sent_keep_alive, 0, 0, 0 },
222 { ngx_string("sent_http_transfer_encoding"), NULL,
223 ngx_http_variable_sent_transfer_encoding, 0, 0, 0 },
225 { ngx_string("sent_http_cache_control"), NULL, ngx_http_variable_headers,
226 offsetof(ngx_http_request_t, headers_out.cache_control), 0, 0 },
228 { ngx_string("limit_rate"), ngx_http_variable_request_set_size,
229 ngx_http_variable_request,
230 offsetof(ngx_http_request_t, limit_rate),
231 NGX_HTTP_VAR_CHANGEABLE|NGX_HTTP_VAR_NOCACHEABLE, 0 },
233 { ngx_string("nginx_version"), NULL, ngx_http_variable_nginx_version,
236 { ngx_string("hostname"), NULL, ngx_http_variable_hostname,
239 { ngx_string("pid"), NULL, ngx_http_variable_pid,
242 { ngx_null_string, NULL, NULL, 0, 0, 0 }
246 ngx_http_variable_value_t ngx_http_variable_null_value =
247 ngx_http_variable("");
248 ngx_http_variable_value_t ngx_http_variable_true_value =
249 ngx_http_variable("1");
252 ngx_http_variable_t *
253 ngx_http_add_variable(ngx_conf_t *cf, ngx_str_t *name, ngx_uint_t flags)
258 ngx_http_variable_t *v;
259 ngx_http_core_main_conf_t *cmcf;
261 cmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_core_module);
263 key = cmcf->variables_keys->keys.elts;
264 for (i = 0; i < cmcf->variables_keys->keys.nelts; i++) {
265 if (name->len != key[i].key.len
266 || ngx_strncasecmp(name->data, key[i].key.data, name->len) != 0)
273 if (!(v->flags & NGX_HTTP_VAR_CHANGEABLE)) {
274 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
275 "the duplicate \"%V\" variable", name);
282 v = ngx_palloc(cf->pool, sizeof(ngx_http_variable_t));
287 v->name.len = name->len;
288 v->name.data = ngx_pnalloc(cf->pool, name->len);
289 if (v->name.data == NULL) {
293 ngx_strlow(v->name.data, name->data, name->len);
295 v->set_handler = NULL;
296 v->get_handler = NULL;
301 rc = ngx_hash_add_key(cmcf->variables_keys, &v->name, v, 0);
303 if (rc == NGX_ERROR) {
307 if (rc == NGX_BUSY) {
308 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
309 "conflicting variable name \"%V\"", name);
318 ngx_http_get_variable_index(ngx_conf_t *cf, ngx_str_t *name)
321 ngx_http_variable_t *v;
322 ngx_http_core_main_conf_t *cmcf;
324 cmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_core_module);
326 v = cmcf->variables.elts;
329 if (ngx_array_init(&cmcf->variables, cf->pool, 4,
330 sizeof(ngx_http_variable_t)) == NGX_ERROR)
336 for (i = 0; i < cmcf->variables.nelts; i++) {
337 if (name->len != v[i].name.len
338 || ngx_strncasecmp(name->data, v[i].name.data, name->len) != 0)
347 v = ngx_array_push(&cmcf->variables);
352 v->name.len = name->len;
353 v->name.data = ngx_pnalloc(cf->pool, name->len);
354 if (v->name.data == NULL) {
358 ngx_strlow(v->name.data, name->data, name->len);
360 v->set_handler = NULL;
361 v->get_handler = NULL;
364 v->index = cmcf->variables.nelts - 1;
366 return cmcf->variables.nelts - 1;
370 ngx_http_variable_value_t *
371 ngx_http_get_indexed_variable(ngx_http_request_t *r, ngx_uint_t index)
373 ngx_http_variable_t *v;
374 ngx_http_core_main_conf_t *cmcf;
376 cmcf = ngx_http_get_module_main_conf(r, ngx_http_core_module);
378 if (cmcf->variables.nelts <= index) {
379 ngx_log_error(NGX_LOG_ALERT, r->connection->log, 0,
380 "unknown variable index: %d", index);
384 if (r->variables[index].not_found || r->variables[index].valid) {
385 return &r->variables[index];
388 v = cmcf->variables.elts;
390 if (v[index].get_handler(r, &r->variables[index], v[index].data)
393 if (v[index].flags & NGX_HTTP_VAR_NOCACHEABLE) {
394 r->variables[index].no_cacheable = 1;
397 return &r->variables[index];
400 r->variables[index].valid = 0;
401 r->variables[index].not_found = 1;
407 ngx_http_variable_value_t *
408 ngx_http_get_flushed_variable(ngx_http_request_t *r, ngx_uint_t index)
410 ngx_http_variable_value_t *v;
412 v = &r->variables[index];
415 if (!v->no_cacheable) {
423 return ngx_http_get_indexed_variable(r, index);
427 ngx_http_variable_value_t *
428 ngx_http_get_variable(ngx_http_request_t *r, ngx_str_t *name, ngx_uint_t key,
431 ngx_http_variable_t *v;
432 ngx_http_variable_value_t *vv;
433 ngx_http_core_main_conf_t *cmcf;
435 cmcf = ngx_http_get_module_main_conf(r, ngx_http_core_module);
437 v = ngx_hash_find(&cmcf->variables_hash, key, name->data, name->len);
440 if (v->flags & NGX_HTTP_VAR_INDEXED) {
441 return ngx_http_get_indexed_variable(r, v->index);
445 vv = ngx_palloc(r->pool, sizeof(ngx_http_variable_value_t));
447 if (vv && v->get_handler(r, vv, v->data) == NGX_OK) {
455 vv = ngx_palloc(r->pool, sizeof(ngx_http_variable_value_t));
460 if (ngx_strncmp(name->data, "http_", 5) == 0) {
462 if (ngx_http_variable_unknown_header_in(r, vv, (uintptr_t) name)
471 if (ngx_strncmp(name->data, "sent_http_", 10) == 0) {
473 if (ngx_http_variable_unknown_header_out(r, vv, (uintptr_t) name)
482 if (ngx_strncmp(name->data, "upstream_http_", 10) == 0) {
484 if (ngx_http_upstream_header_variable(r, vv, (uintptr_t) name)
493 if (ngx_strncmp(name->data, "cookie_", 7) == 0) {
495 if (ngx_http_variable_cookie(r, vv, (uintptr_t) name) == NGX_OK) {
502 if (ngx_strncmp(name->data, "arg_", 4) == 0) {
504 if (ngx_http_variable_argument(r, vv, (uintptr_t) name) == NGX_OK) {
514 ngx_log_error(NGX_LOG_ERR, r->connection->log, 0,
515 "unknown \"%V\" variable", name);
523 ngx_http_variable_request(ngx_http_request_t *r, ngx_http_variable_value_t *v,
528 s = (ngx_str_t *) ((char *) r + data);
546 ngx_http_variable_request_set(ngx_http_request_t *r,
547 ngx_http_variable_value_t *v, uintptr_t data)
551 s = (ngx_str_t *) ((char *) r + data);
559 ngx_http_variable_request_set_size(ngx_http_request_t *r,
560 ngx_http_variable_value_t *v, uintptr_t data)
568 s = ngx_parse_size(&val);
570 if (s == NGX_ERROR) {
571 ngx_log_error(NGX_LOG_ERR, r->connection->log, 0,
572 "invalid size \"%V\"", &val);
576 sp = (ssize_t *) ((char *) r + data);
585 ngx_http_variable_header(ngx_http_request_t *r, ngx_http_variable_value_t *v,
590 h = *(ngx_table_elt_t **) ((char *) r + data);
593 v->len = h->value.len;
597 v->data = h->value.data;
608 ngx_http_variable_headers(ngx_http_request_t *r, ngx_http_variable_value_t *v,
617 a = (ngx_array_t *) ((char *) r + data);
633 v->len = (*h)->value.len;
634 v->data = (*h)->value.data;
639 len = - (ssize_t) (sizeof("; ") - 1);
641 for (i = 0; i < n; i++) {
642 len += h[i]->value.len + sizeof("; ") - 1;
645 p = ngx_pnalloc(r->pool, len);
653 for (i = 0; /* void */ ; i++) {
654 p = ngx_copy(p, h[i]->value.data, h[i]->value.len);
660 *p++ = ';'; *p++ = ' ';
668 ngx_http_variable_unknown_header_in(ngx_http_request_t *r,
669 ngx_http_variable_value_t *v, uintptr_t data)
671 return ngx_http_variable_unknown_header(v, (ngx_str_t *) data,
672 &r->headers_in.headers.part,
673 sizeof("http_") - 1);
678 ngx_http_variable_unknown_header_out(ngx_http_request_t *r,
679 ngx_http_variable_value_t *v, uintptr_t data)
681 return ngx_http_variable_unknown_header(v, (ngx_str_t *) data,
682 &r->headers_out.headers.part,
683 sizeof("sent_http_") - 1);
688 ngx_http_variable_unknown_header(ngx_http_variable_value_t *v, ngx_str_t *var,
689 ngx_list_part_t *part, size_t prefix)
693 ngx_table_elt_t *header;
697 for (i = 0; /* void */ ; i++) {
699 if (i >= part->nelts) {
700 if (part->next == NULL) {
709 for (n = 0; n + prefix < var->len && n < header[i].key.len; n++) {
710 ch = header[i].key.data[n];
712 if (ch >= 'A' && ch <= 'Z') {
715 } else if (ch == '-') {
719 if (var->data[n + prefix] != ch) {
724 if (n + prefix == var->len && n == header[i].key.len) {
725 v->len = header[i].value.len;
729 v->data = header[i].value.data;
742 ngx_http_variable_cookie(ngx_http_request_t *r, ngx_http_variable_value_t *v,
745 ngx_str_t *name = (ngx_str_t *) data;
749 s.len = name->len - (sizeof("cookie_") - 1);
750 s.data = name->data + sizeof("cookie_") - 1;
752 if (ngx_http_parse_multi_header_lines(&r->headers_in.cookies, &s, &cookie)
763 v->data = cookie.data;
770 ngx_http_variable_argument(ngx_http_request_t *r, ngx_http_variable_value_t *v,
773 ngx_str_t *name = (ngx_str_t *) data;
779 len = name->len - (sizeof("arg_") - 1);
780 arg = name->data + sizeof("arg_") - 1;
782 if (ngx_http_arg(r, arg, len, &value) != NGX_OK) {
787 v->data = value.data;
798 ngx_http_variable_host(ngx_http_request_t *r, ngx_http_variable_value_t *v,
801 ngx_http_core_srv_conf_t *cscf;
803 if (r->headers_in.server.len) {
804 v->len = r->headers_in.server.len;
805 v->data = r->headers_in.server.data;
808 cscf = ngx_http_get_module_srv_conf(r, ngx_http_core_module);
810 v->len = cscf->server_name.len;
811 v->data = cscf->server_name.data;
823 ngx_http_variable_binary_remote_addr(ngx_http_request_t *r,
824 ngx_http_variable_value_t *v, uintptr_t data)
826 struct sockaddr_in *sin;
830 sin = (struct sockaddr_in *) r->connection->sockaddr;
832 v->len = sizeof(in_addr_t);
836 v->data = (u_char *) &sin->sin_addr.s_addr;
843 ngx_http_variable_remote_addr(ngx_http_request_t *r,
844 ngx_http_variable_value_t *v, uintptr_t data)
846 v->len = r->connection->addr_text.len;
850 v->data = r->connection->addr_text.data;
857 ngx_http_variable_remote_port(ngx_http_request_t *r,
858 ngx_http_variable_value_t *v, uintptr_t data)
861 struct sockaddr_in *sin;
868 v->data = ngx_pnalloc(r->pool, sizeof("65535") - 1);
869 if (v->data == NULL) {
875 if (r->connection->sockaddr->sa_family == AF_INET) {
876 sin = (struct sockaddr_in *) r->connection->sockaddr;
878 port = ntohs(sin->sin_port);
880 if (port > 0 && port < 65536) {
881 v->len = ngx_sprintf(v->data, "%ui", port) - v->data;
890 ngx_http_variable_server_addr(ngx_http_request_t *r,
891 ngx_http_variable_value_t *v, uintptr_t data)
895 s.data = ngx_pnalloc(r->pool, NGX_INET_ADDRSTRLEN);
896 if (s.data == NULL) {
900 if (ngx_http_server_addr(r, &s) != NGX_OK) {
915 ngx_http_variable_server_port(ngx_http_request_t *r,
916 ngx_http_variable_value_t *v, uintptr_t data)
918 v->len = r->port_text->len - 1;
922 v->data = r->port_text->data + 1;
929 ngx_http_variable_scheme(ngx_http_request_t *r,
930 ngx_http_variable_value_t *v, uintptr_t data)
934 if (r->connection->ssl) {
935 v->len = sizeof("https") - 1;
939 v->data = (u_char *) "https";
946 v->len = sizeof("http") - 1;
950 v->data = (u_char *) "http";
957 ngx_http_variable_is_args(ngx_http_request_t *r,
958 ngx_http_variable_value_t *v, uintptr_t data)
964 if (r->args.len == 0) {
971 v->data = (u_char *) "?";
978 ngx_http_variable_document_root(ngx_http_request_t *r,
979 ngx_http_variable_value_t *v, uintptr_t data)
982 ngx_http_core_loc_conf_t *clcf;
984 clcf = ngx_http_get_module_loc_conf(r, ngx_http_core_module);
986 if (clcf->root_lengths == NULL) {
987 v->len = clcf->root.len;
991 v->data = clcf->root.data;
994 if (ngx_http_script_run(r, &path, clcf->root_lengths->elts, 0,
995 clcf->root_values->elts)
1001 if (ngx_conf_full_name((ngx_cycle_t *) ngx_cycle, &path, 0)
1009 v->no_cacheable = 0;
1011 v->data = path.data;
1019 ngx_http_variable_realpath_root(ngx_http_request_t *r,
1020 ngx_http_variable_value_t *v, uintptr_t data)
1024 ngx_http_core_loc_conf_t *clcf;
1025 u_char real[NGX_MAX_PATH];
1027 clcf = ngx_http_get_module_loc_conf(r, ngx_http_core_module);
1029 if (clcf->root_lengths == NULL) {
1033 if (ngx_http_script_run(r, &path, clcf->root_lengths->elts, 1,
1034 clcf->root_values->elts)
1040 path.data[path.len - 1] = '\0';
1042 if (ngx_conf_full_name((ngx_cycle_t *) ngx_cycle, &path, 0)
1049 if (ngx_realpath(path.data, real) == NULL) {
1050 ngx_log_error(NGX_LOG_CRIT, r->connection->log, ngx_errno,
1051 ngx_realpath_n " \"%s\" failed", path.data);
1055 len = ngx_strlen(real);
1057 v->data = ngx_pnalloc(r->pool, len);
1058 if (v->data == NULL) {
1064 v->no_cacheable = 0;
1067 ngx_memcpy(v->data, real, len);
1074 ngx_http_variable_request_filename(ngx_http_request_t *r,
1075 ngx_http_variable_value_t *v, uintptr_t data)
1080 if (ngx_http_map_uri_to_path(r, &path, &root, 0) == NULL) {
1084 /* ngx_http_map_uri_to_path() allocates memory for terminating '\0' */
1086 v->len = path.len - 1;
1088 v->no_cacheable = 0;
1090 v->data = path.data;
1097 ngx_http_variable_server_name(ngx_http_request_t *r,
1098 ngx_http_variable_value_t *v, uintptr_t data)
1100 ngx_http_core_srv_conf_t *cscf;
1102 cscf = ngx_http_get_module_srv_conf(r, ngx_http_core_module);
1104 v->len = cscf->server_name.len;
1106 v->no_cacheable = 0;
1108 v->data = cscf->server_name.data;
1115 ngx_http_variable_request_method(ngx_http_request_t *r,
1116 ngx_http_variable_value_t *v, uintptr_t data)
1118 if (r->main->method_name.data) {
1119 v->len = r->main->method_name.len;
1121 v->no_cacheable = 0;
1123 v->data = r->main->method_name.data;
1134 ngx_http_variable_remote_user(ngx_http_request_t *r,
1135 ngx_http_variable_value_t *v, uintptr_t data)
1139 rc = ngx_http_auth_basic_user(r);
1141 if (rc == NGX_DECLINED) {
1146 if (rc == NGX_ERROR) {
1150 v->len = r->headers_in.user.len;
1152 v->no_cacheable = 0;
1154 v->data = r->headers_in.user.data;
1161 ngx_http_variable_body_bytes_sent(ngx_http_request_t *r,
1162 ngx_http_variable_value_t *v, uintptr_t data)
1167 sent = r->connection->sent - r->header_size;
1173 p = ngx_pnalloc(r->pool, NGX_OFF_T_LEN);
1178 v->len = ngx_sprintf(p, "%O", sent) - p;
1180 v->no_cacheable = 0;
1189 ngx_http_variable_sent_content_type(ngx_http_request_t *r,
1190 ngx_http_variable_value_t *v, uintptr_t data)
1192 if (r->headers_out.content_type.len) {
1193 v->len = r->headers_out.content_type.len;
1195 v->no_cacheable = 0;
1197 v->data = r->headers_out.content_type.data;
1208 ngx_http_variable_sent_content_length(ngx_http_request_t *r,
1209 ngx_http_variable_value_t *v, uintptr_t data)
1213 if (r->headers_out.content_length) {
1214 v->len = r->headers_out.content_length->value.len;
1216 v->no_cacheable = 0;
1218 v->data = r->headers_out.content_length->value.data;
1223 if (r->headers_out.content_length_n >= 0) {
1224 p = ngx_pnalloc(r->pool, NGX_OFF_T_LEN);
1229 v->len = ngx_sprintf(p, "%O", r->headers_out.content_length_n) - p;
1231 v->no_cacheable = 0;
1245 ngx_http_variable_sent_last_modified(ngx_http_request_t *r,
1246 ngx_http_variable_value_t *v, uintptr_t data)
1250 if (r->headers_out.last_modified) {
1251 v->len = r->headers_out.last_modified->value.len;
1253 v->no_cacheable = 0;
1255 v->data = r->headers_out.last_modified->value.data;
1260 if (r->headers_out.last_modified_time >= 0) {
1261 p = ngx_pnalloc(r->pool,
1262 sizeof("Last-Modified: Mon, 28 Sep 1970 06:00:00 GMT") - 1);
1267 v->len = ngx_http_time(p, r->headers_out.last_modified_time) - p;
1269 v->no_cacheable = 0;
1283 ngx_http_variable_sent_connection(ngx_http_request_t *r,
1284 ngx_http_variable_value_t *v, uintptr_t data)
1290 len = sizeof("keep-alive") - 1;
1294 len = sizeof("close") - 1;
1300 v->no_cacheable = 0;
1302 v->data = (u_char *) p;
1309 ngx_http_variable_sent_keep_alive(ngx_http_request_t *r,
1310 ngx_http_variable_value_t *v, uintptr_t data)
1313 ngx_http_core_loc_conf_t *clcf;
1316 clcf = ngx_http_get_module_loc_conf(r, ngx_http_core_module);
1318 if (clcf->keepalive_header) {
1320 p = ngx_pnalloc(r->pool, sizeof("timeout=") - 1 + NGX_TIME_T_LEN);
1325 v->len = ngx_sprintf(p, "timeout=%T", clcf->keepalive_header) - p;
1327 v->no_cacheable = 0;
1342 ngx_http_variable_sent_transfer_encoding(ngx_http_request_t *r,
1343 ngx_http_variable_value_t *v, uintptr_t data)
1346 v->len = sizeof("chunked") - 1;
1348 v->no_cacheable = 0;
1350 v->data = (u_char *) "chunked";
1361 ngx_http_variable_request_completion(ngx_http_request_t *r,
1362 ngx_http_variable_value_t *v, uintptr_t data)
1364 if (r->request_complete) {
1367 v->no_cacheable = 0;
1369 v->data = (u_char *) "OK";
1376 v->no_cacheable = 0;
1378 v->data = (u_char *) "";
1385 ngx_http_variable_request_body_file(ngx_http_request_t *r,
1386 ngx_http_variable_value_t *v, uintptr_t data)
1388 if (r->request_body == NULL || r->request_body->temp_file == NULL) {
1394 v->len = r->request_body->temp_file->file.name.len;
1396 v->no_cacheable = 0;
1398 v->data = r->request_body->temp_file->file.name.data;
1405 ngx_http_variable_nginx_version(ngx_http_request_t *r,
1406 ngx_http_variable_value_t *v, uintptr_t data)
1408 v->len = sizeof(NGINX_VERSION) - 1;
1410 v->no_cacheable = 0;
1412 v->data = (u_char *) NGINX_VERSION;
1419 ngx_http_variable_hostname(ngx_http_request_t *r,
1420 ngx_http_variable_value_t *v, uintptr_t data)
1422 v->len = ngx_cycle->hostname.len;
1424 v->no_cacheable = 0;
1426 v->data = ngx_cycle->hostname.data;
1433 ngx_http_variable_pid(ngx_http_request_t *r,
1434 ngx_http_variable_value_t *v, uintptr_t data)
1438 p = ngx_pnalloc(r->pool, NGX_INT64_LEN);
1443 v->len = ngx_sprintf(p, "%P", ngx_pid) - p;
1445 v->no_cacheable = 0;
1454 ngx_http_variables_add_core_vars(ngx_conf_t *cf)
1457 ngx_http_variable_t *v;
1458 ngx_http_core_main_conf_t *cmcf;
1460 cmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_core_module);
1462 cmcf->variables_keys = ngx_pcalloc(cf->temp_pool,
1463 sizeof(ngx_hash_keys_arrays_t));
1464 if (cmcf->variables_keys == NULL) {
1468 cmcf->variables_keys->pool = cf->pool;
1469 cmcf->variables_keys->temp_pool = cf->pool;
1471 if (ngx_hash_keys_array_init(cmcf->variables_keys, NGX_HASH_SMALL)
1477 for (v = ngx_http_core_variables; v->name.len; v++) {
1478 rc = ngx_hash_add_key(cmcf->variables_keys, &v->name, v,
1479 NGX_HASH_READONLY_KEY);
1485 if (rc == NGX_BUSY) {
1486 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
1487 "conflicting variable name \"%V\"", &v->name);
1498 ngx_http_variables_init_vars(ngx_conf_t *cf)
1501 ngx_hash_key_t *key;
1502 ngx_hash_init_t hash;
1503 ngx_http_variable_t *v, *av;
1504 ngx_http_core_main_conf_t *cmcf;
1506 /* set the handlers for the indexed http variables */
1508 cmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_core_module);
1510 v = cmcf->variables.elts;
1511 key = cmcf->variables_keys->keys.elts;
1513 for (i = 0; i < cmcf->variables.nelts; i++) {
1515 for (n = 0; n < cmcf->variables_keys->keys.nelts; n++) {
1520 && v[i].name.len == key[n].key.len
1521 && ngx_strncmp(v[i].name.data, key[n].key.data, v[i].name.len)
1524 v[i].get_handler = av->get_handler;
1525 v[i].data = av->data;
1527 av->flags |= NGX_HTTP_VAR_INDEXED;
1528 v[i].flags = av->flags;
1536 if (ngx_strncmp(v[i].name.data, "http_", 5) == 0) {
1537 v[i].get_handler = ngx_http_variable_unknown_header_in;
1538 v[i].data = (uintptr_t) &v[i].name;
1543 if (ngx_strncmp(v[i].name.data, "sent_http_", 10) == 0) {
1544 v[i].get_handler = ngx_http_variable_unknown_header_out;
1545 v[i].data = (uintptr_t) &v[i].name;
1550 if (ngx_strncmp(v[i].name.data, "upstream_http_", 14) == 0) {
1551 v[i].get_handler = ngx_http_upstream_header_variable;
1552 v[i].data = (uintptr_t) &v[i].name;
1553 v[i].flags = NGX_HTTP_VAR_NOCACHEABLE;
1558 if (ngx_strncmp(v[i].name.data, "cookie_", 7) == 0) {
1559 v[i].get_handler = ngx_http_variable_cookie;
1560 v[i].data = (uintptr_t) &v[i].name;
1565 if (ngx_strncmp(v[i].name.data, "arg_", 4) == 0) {
1566 v[i].get_handler = ngx_http_variable_argument;
1567 v[i].data = (uintptr_t) &v[i].name;
1572 ngx_log_error(NGX_LOG_EMERG, cf->log, 0,
1573 "unknown \"%V\" variable", &v[i].name);
1582 for (n = 0; n < cmcf->variables_keys->keys.nelts; n++) {
1585 if (av->flags & NGX_HTTP_VAR_NOHASH) {
1586 key[n].key.data = NULL;
1591 hash.hash = &cmcf->variables_hash;
1592 hash.key = ngx_hash_key;
1593 hash.max_size = cmcf->variables_hash_max_size;
1594 hash.bucket_size = cmcf->variables_hash_bucket_size;
1595 hash.name = "variables_hash";
1596 hash.pool = cf->pool;
1597 hash.temp_pool = NULL;
1599 if (ngx_hash_init(&hash, cmcf->variables_keys->keys.elts,
1600 cmcf->variables_keys->keys.nelts)
1606 cmcf->variables_keys = NULL;
1613 ngx_http_variable_value_rbtree_insert(ngx_rbtree_node_t *temp,
1614 ngx_rbtree_node_t *node, ngx_rbtree_node_t *sentinel)
1616 ngx_rbtree_node_t **p;
1617 ngx_http_variable_value_node_t *vvn, *vvt;
1621 vvn = (ngx_http_variable_value_node_t *) node;
1622 vvt = (ngx_http_variable_value_node_t *) temp;
1624 if (node->key != temp->key) {
1626 p = (node->key < temp->key) ? &temp->left : &temp->right;
1628 } else if (vvn->len != vvt->len) {
1630 p = (vvn->len < vvt->len) ? &temp->left : &temp->right;
1633 p = (ngx_memcmp(vvn->value->data, vvt->value->data, vvn->len) < 0)
1634 ? &temp->left : &temp->right;
1637 if (*p == sentinel) {
1645 node->parent = temp;
1646 node->left = sentinel;
1647 node->right = sentinel;
1652 ngx_http_variable_value_t *
1653 ngx_http_variable_value_lookup(ngx_rbtree_t *rbtree, ngx_str_t *val,
1657 ngx_rbtree_node_t *node, *sentinel;
1658 ngx_http_variable_value_node_t *vvn;
1660 node = rbtree->root;
1661 sentinel = rbtree->sentinel;
1663 while (node != sentinel) {
1665 vvn = (ngx_http_variable_value_node_t *) node;
1667 if (hash != node->key) {
1668 node = (hash < node->key) ? node->left : node->right;
1672 if (val->len != vvn->len) {
1673 node = (val->len < vvn->len) ? node->left : node->right;
1677 rc = ngx_memcmp(val->data, vvn->value->data, val->len);