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_location(ngx_http_request_t *r,
73 ngx_http_variable_value_t *v, uintptr_t data);
74 static ngx_int_t ngx_http_variable_sent_last_modified(ngx_http_request_t *r,
75 ngx_http_variable_value_t *v, uintptr_t data);
76 static ngx_int_t ngx_http_variable_sent_connection(ngx_http_request_t *r,
77 ngx_http_variable_value_t *v, uintptr_t data);
78 static ngx_int_t ngx_http_variable_sent_keep_alive(ngx_http_request_t *r,
79 ngx_http_variable_value_t *v, uintptr_t data);
80 static ngx_int_t ngx_http_variable_sent_transfer_encoding(ngx_http_request_t *r,
81 ngx_http_variable_value_t *v, uintptr_t data);
83 static ngx_int_t ngx_http_variable_nginx_version(ngx_http_request_t *r,
84 ngx_http_variable_value_t *v, uintptr_t data);
85 static ngx_int_t ngx_http_variable_hostname(ngx_http_request_t *r,
86 ngx_http_variable_value_t *v, uintptr_t data);
87 static ngx_int_t ngx_http_variable_pid(ngx_http_request_t *r,
88 ngx_http_variable_value_t *v, uintptr_t data);
92 * Apache CGI: AUTH_TYPE, PATH_INFO (null), PATH_TRANSLATED
93 * REMOTE_HOST (null), REMOTE_IDENT (null),
96 * Apache SSI: DOCUMENT_NAME, LAST_MODIFIED, USER_NAME (file owner)
100 * the $http_host, $http_user_agent, $http_referer, $http_via,
101 * and $http_x_forwarded_for variables may be handled by generic
102 * ngx_http_variable_unknown_header_in(), but for perfomance reasons
103 * they are handled using dedicated entries
106 static ngx_http_variable_t ngx_http_core_variables[] = {
108 { ngx_string("http_host"), NULL, ngx_http_variable_header,
109 offsetof(ngx_http_request_t, headers_in.host), 0, 0 },
111 { ngx_string("http_user_agent"), NULL, ngx_http_variable_header,
112 offsetof(ngx_http_request_t, headers_in.user_agent), 0, 0 },
114 { ngx_string("http_referer"), NULL, ngx_http_variable_header,
115 offsetof(ngx_http_request_t, headers_in.referer), 0, 0 },
118 { ngx_string("http_via"), NULL, ngx_http_variable_header,
119 offsetof(ngx_http_request_t, headers_in.via), 0, 0 },
122 #if (NGX_HTTP_PROXY || NGX_HTTP_REALIP)
123 { ngx_string("http_x_forwarded_for"), NULL, ngx_http_variable_header,
124 offsetof(ngx_http_request_t, headers_in.x_forwarded_for), 0, 0 },
127 { ngx_string("http_cookie"), NULL, ngx_http_variable_headers,
128 offsetof(ngx_http_request_t, headers_in.cookies), 0, 0 },
130 { ngx_string("content_length"), NULL, ngx_http_variable_header,
131 offsetof(ngx_http_request_t, headers_in.content_length), 0, 0 },
133 { ngx_string("content_type"), NULL, ngx_http_variable_header,
134 offsetof(ngx_http_request_t, headers_in.content_type), 0, 0 },
136 { ngx_string("host"), NULL, ngx_http_variable_host, 0, 0, 0 },
138 { ngx_string("binary_remote_addr"), NULL,
139 ngx_http_variable_binary_remote_addr, 0, 0, 0 },
141 { ngx_string("remote_addr"), NULL, ngx_http_variable_remote_addr, 0, 0, 0 },
143 { ngx_string("remote_port"), NULL, ngx_http_variable_remote_port, 0, 0, 0 },
145 { ngx_string("server_addr"), NULL, ngx_http_variable_server_addr, 0, 0, 0 },
147 { ngx_string("server_port"), NULL, ngx_http_variable_server_port, 0, 0, 0 },
149 { ngx_string("server_protocol"), NULL, ngx_http_variable_request,
150 offsetof(ngx_http_request_t, http_protocol), 0, 0 },
152 { ngx_string("scheme"), NULL, ngx_http_variable_scheme, 0, 0, 0 },
154 { ngx_string("request_uri"), NULL, ngx_http_variable_request,
155 offsetof(ngx_http_request_t, unparsed_uri), 0, 0 },
157 { ngx_string("uri"), NULL, ngx_http_variable_request,
158 offsetof(ngx_http_request_t, uri),
159 NGX_HTTP_VAR_NOCACHEABLE, 0 },
161 { ngx_string("document_uri"), NULL, ngx_http_variable_request,
162 offsetof(ngx_http_request_t, uri),
163 NGX_HTTP_VAR_NOCACHEABLE, 0 },
165 { ngx_string("request"), NULL, ngx_http_variable_request,
166 offsetof(ngx_http_request_t, request_line), 0, 0 },
168 { ngx_string("document_root"), NULL,
169 ngx_http_variable_document_root, 0, NGX_HTTP_VAR_NOCACHEABLE, 0 },
171 { ngx_string("realpath_root"), NULL,
172 ngx_http_variable_realpath_root, 0, NGX_HTTP_VAR_NOCACHEABLE, 0 },
174 { ngx_string("query_string"), NULL, ngx_http_variable_request,
175 offsetof(ngx_http_request_t, args),
176 NGX_HTTP_VAR_NOCACHEABLE, 0 },
178 { ngx_string("args"),
179 ngx_http_variable_request_set,
180 ngx_http_variable_request,
181 offsetof(ngx_http_request_t, args),
182 NGX_HTTP_VAR_CHANGEABLE|NGX_HTTP_VAR_NOCACHEABLE, 0 },
184 { ngx_string("is_args"), NULL, ngx_http_variable_is_args,
185 0, NGX_HTTP_VAR_NOCACHEABLE, 0 },
187 { ngx_string("request_filename"), NULL,
188 ngx_http_variable_request_filename, 0,
189 NGX_HTTP_VAR_NOCACHEABLE, 0 },
191 { ngx_string("server_name"), NULL, ngx_http_variable_server_name, 0, 0, 0 },
193 { ngx_string("request_method"), NULL,
194 ngx_http_variable_request_method, 0, 0, 0 },
196 { ngx_string("remote_user"), NULL, ngx_http_variable_remote_user, 0, 0, 0 },
198 { ngx_string("body_bytes_sent"), NULL, ngx_http_variable_body_bytes_sent,
201 { ngx_string("request_completion"), NULL,
202 ngx_http_variable_request_completion,
205 { ngx_string("request_body_file"), NULL,
206 ngx_http_variable_request_body_file,
209 { ngx_string("sent_http_content_type"), NULL,
210 ngx_http_variable_sent_content_type, 0, 0, 0 },
212 { ngx_string("sent_http_content_length"), NULL,
213 ngx_http_variable_sent_content_length, 0, 0, 0 },
215 { ngx_string("sent_http_location"), NULL,
216 ngx_http_variable_sent_location, 0, 0, 0 },
218 { ngx_string("sent_http_last_modified"), NULL,
219 ngx_http_variable_sent_last_modified, 0, 0, 0 },
221 { ngx_string("sent_http_connection"), NULL,
222 ngx_http_variable_sent_connection, 0, 0, 0 },
224 { ngx_string("sent_http_keep_alive"), NULL,
225 ngx_http_variable_sent_keep_alive, 0, 0, 0 },
227 { ngx_string("sent_http_transfer_encoding"), NULL,
228 ngx_http_variable_sent_transfer_encoding, 0, 0, 0 },
230 { ngx_string("sent_http_cache_control"), NULL, ngx_http_variable_headers,
231 offsetof(ngx_http_request_t, headers_out.cache_control), 0, 0 },
233 { ngx_string("limit_rate"), ngx_http_variable_request_set_size,
234 ngx_http_variable_request,
235 offsetof(ngx_http_request_t, limit_rate),
236 NGX_HTTP_VAR_CHANGEABLE|NGX_HTTP_VAR_NOCACHEABLE, 0 },
238 { ngx_string("nginx_version"), NULL, ngx_http_variable_nginx_version,
241 { ngx_string("hostname"), NULL, ngx_http_variable_hostname,
244 { ngx_string("pid"), NULL, ngx_http_variable_pid,
247 { ngx_null_string, NULL, NULL, 0, 0, 0 }
251 ngx_http_variable_value_t ngx_http_variable_null_value =
252 ngx_http_variable("");
253 ngx_http_variable_value_t ngx_http_variable_true_value =
254 ngx_http_variable("1");
257 ngx_http_variable_t *
258 ngx_http_add_variable(ngx_conf_t *cf, ngx_str_t *name, ngx_uint_t flags)
263 ngx_http_variable_t *v;
264 ngx_http_core_main_conf_t *cmcf;
266 cmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_core_module);
268 key = cmcf->variables_keys->keys.elts;
269 for (i = 0; i < cmcf->variables_keys->keys.nelts; i++) {
270 if (name->len != key[i].key.len
271 || ngx_strncasecmp(name->data, key[i].key.data, name->len) != 0)
278 if (!(v->flags & NGX_HTTP_VAR_CHANGEABLE)) {
279 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
280 "the duplicate \"%V\" variable", name);
287 v = ngx_palloc(cf->pool, sizeof(ngx_http_variable_t));
292 v->name.len = name->len;
293 v->name.data = ngx_pnalloc(cf->pool, name->len);
294 if (v->name.data == NULL) {
298 ngx_strlow(v->name.data, name->data, name->len);
300 v->set_handler = NULL;
301 v->get_handler = NULL;
306 rc = ngx_hash_add_key(cmcf->variables_keys, &v->name, v, 0);
308 if (rc == NGX_ERROR) {
312 if (rc == NGX_BUSY) {
313 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
314 "conflicting variable name \"%V\"", name);
323 ngx_http_get_variable_index(ngx_conf_t *cf, ngx_str_t *name)
326 ngx_http_variable_t *v;
327 ngx_http_core_main_conf_t *cmcf;
329 cmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_core_module);
331 v = cmcf->variables.elts;
334 if (ngx_array_init(&cmcf->variables, cf->pool, 4,
335 sizeof(ngx_http_variable_t)) == NGX_ERROR)
341 for (i = 0; i < cmcf->variables.nelts; i++) {
342 if (name->len != v[i].name.len
343 || ngx_strncasecmp(name->data, v[i].name.data, name->len) != 0)
352 v = ngx_array_push(&cmcf->variables);
357 v->name.len = name->len;
358 v->name.data = ngx_pnalloc(cf->pool, name->len);
359 if (v->name.data == NULL) {
363 ngx_strlow(v->name.data, name->data, name->len);
365 v->set_handler = NULL;
366 v->get_handler = NULL;
369 v->index = cmcf->variables.nelts - 1;
371 return cmcf->variables.nelts - 1;
375 ngx_http_variable_value_t *
376 ngx_http_get_indexed_variable(ngx_http_request_t *r, ngx_uint_t index)
378 ngx_http_variable_t *v;
379 ngx_http_core_main_conf_t *cmcf;
381 cmcf = ngx_http_get_module_main_conf(r, ngx_http_core_module);
383 if (cmcf->variables.nelts <= index) {
384 ngx_log_error(NGX_LOG_ALERT, r->connection->log, 0,
385 "unknown variable index: %d", index);
389 if (r->variables[index].not_found || r->variables[index].valid) {
390 return &r->variables[index];
393 v = cmcf->variables.elts;
395 if (v[index].get_handler(r, &r->variables[index], v[index].data)
398 if (v[index].flags & NGX_HTTP_VAR_NOCACHEABLE) {
399 r->variables[index].no_cacheable = 1;
402 return &r->variables[index];
405 r->variables[index].valid = 0;
406 r->variables[index].not_found = 1;
412 ngx_http_variable_value_t *
413 ngx_http_get_flushed_variable(ngx_http_request_t *r, ngx_uint_t index)
415 ngx_http_variable_value_t *v;
417 v = &r->variables[index];
420 if (!v->no_cacheable) {
428 return ngx_http_get_indexed_variable(r, index);
432 ngx_http_variable_value_t *
433 ngx_http_get_variable(ngx_http_request_t *r, ngx_str_t *name, ngx_uint_t key,
436 ngx_http_variable_t *v;
437 ngx_http_variable_value_t *vv;
438 ngx_http_core_main_conf_t *cmcf;
440 cmcf = ngx_http_get_module_main_conf(r, ngx_http_core_module);
442 v = ngx_hash_find(&cmcf->variables_hash, key, name->data, name->len);
445 if (v->flags & NGX_HTTP_VAR_INDEXED) {
446 return ngx_http_get_indexed_variable(r, v->index);
450 vv = ngx_palloc(r->pool, sizeof(ngx_http_variable_value_t));
452 if (vv && v->get_handler(r, vv, v->data) == NGX_OK) {
460 vv = ngx_palloc(r->pool, sizeof(ngx_http_variable_value_t));
465 if (ngx_strncmp(name->data, "http_", 5) == 0) {
467 if (ngx_http_variable_unknown_header_in(r, vv, (uintptr_t) name)
476 if (ngx_strncmp(name->data, "sent_http_", 10) == 0) {
478 if (ngx_http_variable_unknown_header_out(r, vv, (uintptr_t) name)
487 if (ngx_strncmp(name->data, "upstream_http_", 10) == 0) {
489 if (ngx_http_upstream_header_variable(r, vv, (uintptr_t) name)
498 if (ngx_strncmp(name->data, "cookie_", 7) == 0) {
500 if (ngx_http_variable_cookie(r, vv, (uintptr_t) name) == NGX_OK) {
507 if (ngx_strncmp(name->data, "arg_", 4) == 0) {
509 if (ngx_http_variable_argument(r, vv, (uintptr_t) name) == NGX_OK) {
519 ngx_log_error(NGX_LOG_ERR, r->connection->log, 0,
520 "unknown \"%V\" variable", name);
528 ngx_http_variable_request(ngx_http_request_t *r, ngx_http_variable_value_t *v,
533 s = (ngx_str_t *) ((char *) r + data);
551 ngx_http_variable_request_set(ngx_http_request_t *r,
552 ngx_http_variable_value_t *v, uintptr_t data)
556 s = (ngx_str_t *) ((char *) r + data);
564 ngx_http_variable_request_set_size(ngx_http_request_t *r,
565 ngx_http_variable_value_t *v, uintptr_t data)
573 s = ngx_parse_size(&val);
575 if (s == NGX_ERROR) {
576 ngx_log_error(NGX_LOG_ERR, r->connection->log, 0,
577 "invalid size \"%V\"", &val);
581 sp = (ssize_t *) ((char *) r + data);
590 ngx_http_variable_header(ngx_http_request_t *r, ngx_http_variable_value_t *v,
595 h = *(ngx_table_elt_t **) ((char *) r + data);
598 v->len = h->value.len;
602 v->data = h->value.data;
613 ngx_http_variable_headers(ngx_http_request_t *r, ngx_http_variable_value_t *v,
622 a = (ngx_array_t *) ((char *) r + data);
638 v->len = (*h)->value.len;
639 v->data = (*h)->value.data;
644 len = - (ssize_t) (sizeof("; ") - 1);
646 for (i = 0; i < n; i++) {
647 len += h[i]->value.len + sizeof("; ") - 1;
650 p = ngx_pnalloc(r->pool, len);
658 for (i = 0; /* void */ ; i++) {
659 p = ngx_copy(p, h[i]->value.data, h[i]->value.len);
665 *p++ = ';'; *p++ = ' ';
673 ngx_http_variable_unknown_header_in(ngx_http_request_t *r,
674 ngx_http_variable_value_t *v, uintptr_t data)
676 return ngx_http_variable_unknown_header(v, (ngx_str_t *) data,
677 &r->headers_in.headers.part,
678 sizeof("http_") - 1);
683 ngx_http_variable_unknown_header_out(ngx_http_request_t *r,
684 ngx_http_variable_value_t *v, uintptr_t data)
686 return ngx_http_variable_unknown_header(v, (ngx_str_t *) data,
687 &r->headers_out.headers.part,
688 sizeof("sent_http_") - 1);
693 ngx_http_variable_unknown_header(ngx_http_variable_value_t *v, ngx_str_t *var,
694 ngx_list_part_t *part, size_t prefix)
698 ngx_table_elt_t *header;
702 for (i = 0; /* void */ ; i++) {
704 if (i >= part->nelts) {
705 if (part->next == NULL) {
714 for (n = 0; n + prefix < var->len && n < header[i].key.len; n++) {
715 ch = header[i].key.data[n];
717 if (ch >= 'A' && ch <= 'Z') {
720 } else if (ch == '-') {
724 if (var->data[n + prefix] != ch) {
729 if (n + prefix == var->len && n == header[i].key.len) {
730 v->len = header[i].value.len;
734 v->data = header[i].value.data;
747 ngx_http_variable_cookie(ngx_http_request_t *r, ngx_http_variable_value_t *v,
750 ngx_str_t *name = (ngx_str_t *) data;
754 s.len = name->len - (sizeof("cookie_") - 1);
755 s.data = name->data + sizeof("cookie_") - 1;
757 if (ngx_http_parse_multi_header_lines(&r->headers_in.cookies, &s, &cookie)
768 v->data = cookie.data;
775 ngx_http_variable_argument(ngx_http_request_t *r, ngx_http_variable_value_t *v,
778 ngx_str_t *name = (ngx_str_t *) data;
784 len = name->len - (sizeof("arg_") - 1);
785 arg = name->data + sizeof("arg_") - 1;
787 if (ngx_http_arg(r, arg, len, &value) != NGX_OK) {
792 v->data = value.data;
803 ngx_http_variable_host(ngx_http_request_t *r, ngx_http_variable_value_t *v,
806 ngx_http_core_srv_conf_t *cscf;
808 if (r->headers_in.server.len) {
809 v->len = r->headers_in.server.len;
810 v->data = r->headers_in.server.data;
813 cscf = ngx_http_get_module_srv_conf(r, ngx_http_core_module);
815 v->len = cscf->server_name.len;
816 v->data = cscf->server_name.data;
828 ngx_http_variable_binary_remote_addr(ngx_http_request_t *r,
829 ngx_http_variable_value_t *v, uintptr_t data)
831 struct sockaddr_in *sin;
833 struct sockaddr_in6 *sin6;
836 switch (r->connection->sockaddr->sa_family) {
840 sin6 = (struct sockaddr_in6 *) r->connection->sockaddr;
842 v->len = sizeof(struct in6_addr);
846 v->data = (u_char *) &sin6->sin6_addr;
851 default: /* AF_INET */
852 sin = (struct sockaddr_in *) r->connection->sockaddr;
854 v->len = sizeof(in_addr_t);
858 v->data = (u_char *) &sin->sin_addr;
868 ngx_http_variable_remote_addr(ngx_http_request_t *r,
869 ngx_http_variable_value_t *v, uintptr_t data)
871 v->len = r->connection->addr_text.len;
875 v->data = r->connection->addr_text.data;
882 ngx_http_variable_remote_port(ngx_http_request_t *r,
883 ngx_http_variable_value_t *v, uintptr_t data)
886 struct sockaddr_in *sin;
888 struct sockaddr_in6 *sin6;
896 v->data = ngx_pnalloc(r->pool, sizeof("65535") - 1);
897 if (v->data == NULL) {
901 switch (r->connection->sockaddr->sa_family) {
905 sin6 = (struct sockaddr_in6 *) r->connection->sockaddr;
906 port = ntohs(sin6->sin6_port);
910 default: /* AF_INET */
911 sin = (struct sockaddr_in *) r->connection->sockaddr;
912 port = ntohs(sin->sin_port);
916 if (port > 0 && port < 65536) {
917 v->len = ngx_sprintf(v->data, "%ui", port) - v->data;
925 ngx_http_variable_server_addr(ngx_http_request_t *r,
926 ngx_http_variable_value_t *v, uintptr_t data)
929 u_char addr[NGX_SOCKADDR_STRLEN];
931 s.len = NGX_SOCKADDR_STRLEN;
934 if (ngx_http_server_addr(r, &s) != NGX_OK) {
938 s.data = ngx_pnalloc(r->pool, s.len);
939 if (s.data == NULL) {
943 ngx_memcpy(s.data, addr, s.len);
956 ngx_http_variable_server_port(ngx_http_request_t *r,
957 ngx_http_variable_value_t *v, uintptr_t data)
959 v->len = r->port_text->len - 1;
963 v->data = r->port_text->data + 1;
970 ngx_http_variable_scheme(ngx_http_request_t *r,
971 ngx_http_variable_value_t *v, uintptr_t data)
975 if (r->connection->ssl) {
976 v->len = sizeof("https") - 1;
980 v->data = (u_char *) "https";
987 v->len = sizeof("http") - 1;
991 v->data = (u_char *) "http";
998 ngx_http_variable_is_args(ngx_http_request_t *r,
999 ngx_http_variable_value_t *v, uintptr_t data)
1002 v->no_cacheable = 0;
1005 if (r->args.len == 0) {
1012 v->data = (u_char *) "?";
1019 ngx_http_variable_document_root(ngx_http_request_t *r,
1020 ngx_http_variable_value_t *v, uintptr_t data)
1023 ngx_http_core_loc_conf_t *clcf;
1025 clcf = ngx_http_get_module_loc_conf(r, ngx_http_core_module);
1027 if (clcf->root_lengths == NULL) {
1028 v->len = clcf->root.len;
1030 v->no_cacheable = 0;
1032 v->data = clcf->root.data;
1035 if (ngx_http_script_run(r, &path, clcf->root_lengths->elts, 0,
1036 clcf->root_values->elts)
1042 if (ngx_conf_full_name((ngx_cycle_t *) ngx_cycle, &path, 0)
1050 v->no_cacheable = 0;
1052 v->data = path.data;
1060 ngx_http_variable_realpath_root(ngx_http_request_t *r,
1061 ngx_http_variable_value_t *v, uintptr_t data)
1065 ngx_http_core_loc_conf_t *clcf;
1066 u_char real[NGX_MAX_PATH];
1068 clcf = ngx_http_get_module_loc_conf(r, ngx_http_core_module);
1070 if (clcf->root_lengths == NULL) {
1074 if (ngx_http_script_run(r, &path, clcf->root_lengths->elts, 1,
1075 clcf->root_values->elts)
1081 path.data[path.len - 1] = '\0';
1083 if (ngx_conf_full_name((ngx_cycle_t *) ngx_cycle, &path, 0)
1090 if (ngx_realpath(path.data, real) == NULL) {
1091 ngx_log_error(NGX_LOG_CRIT, r->connection->log, ngx_errno,
1092 ngx_realpath_n " \"%s\" failed", path.data);
1096 len = ngx_strlen(real);
1098 v->data = ngx_pnalloc(r->pool, len);
1099 if (v->data == NULL) {
1105 v->no_cacheable = 0;
1108 ngx_memcpy(v->data, real, len);
1115 ngx_http_variable_request_filename(ngx_http_request_t *r,
1116 ngx_http_variable_value_t *v, uintptr_t data)
1121 if (ngx_http_map_uri_to_path(r, &path, &root, 0) == NULL) {
1125 /* ngx_http_map_uri_to_path() allocates memory for terminating '\0' */
1127 v->len = path.len - 1;
1129 v->no_cacheable = 0;
1131 v->data = path.data;
1138 ngx_http_variable_server_name(ngx_http_request_t *r,
1139 ngx_http_variable_value_t *v, uintptr_t data)
1141 ngx_http_core_srv_conf_t *cscf;
1143 cscf = ngx_http_get_module_srv_conf(r, ngx_http_core_module);
1145 v->len = cscf->server_name.len;
1147 v->no_cacheable = 0;
1149 v->data = cscf->server_name.data;
1156 ngx_http_variable_request_method(ngx_http_request_t *r,
1157 ngx_http_variable_value_t *v, uintptr_t data)
1159 if (r->main->method_name.data) {
1160 v->len = r->main->method_name.len;
1162 v->no_cacheable = 0;
1164 v->data = r->main->method_name.data;
1175 ngx_http_variable_remote_user(ngx_http_request_t *r,
1176 ngx_http_variable_value_t *v, uintptr_t data)
1180 rc = ngx_http_auth_basic_user(r);
1182 if (rc == NGX_DECLINED) {
1187 if (rc == NGX_ERROR) {
1191 v->len = r->headers_in.user.len;
1193 v->no_cacheable = 0;
1195 v->data = r->headers_in.user.data;
1202 ngx_http_variable_body_bytes_sent(ngx_http_request_t *r,
1203 ngx_http_variable_value_t *v, uintptr_t data)
1208 sent = r->connection->sent - r->header_size;
1214 p = ngx_pnalloc(r->pool, NGX_OFF_T_LEN);
1219 v->len = ngx_sprintf(p, "%O", sent) - p;
1221 v->no_cacheable = 0;
1230 ngx_http_variable_sent_content_type(ngx_http_request_t *r,
1231 ngx_http_variable_value_t *v, uintptr_t data)
1233 if (r->headers_out.content_type.len) {
1234 v->len = r->headers_out.content_type.len;
1236 v->no_cacheable = 0;
1238 v->data = r->headers_out.content_type.data;
1249 ngx_http_variable_sent_content_length(ngx_http_request_t *r,
1250 ngx_http_variable_value_t *v, uintptr_t data)
1254 if (r->headers_out.content_length) {
1255 v->len = r->headers_out.content_length->value.len;
1257 v->no_cacheable = 0;
1259 v->data = r->headers_out.content_length->value.data;
1264 if (r->headers_out.content_length_n >= 0) {
1265 p = ngx_pnalloc(r->pool, NGX_OFF_T_LEN);
1270 v->len = ngx_sprintf(p, "%O", r->headers_out.content_length_n) - p;
1272 v->no_cacheable = 0;
1286 ngx_http_variable_sent_location(ngx_http_request_t *r,
1287 ngx_http_variable_value_t *v, uintptr_t data)
1289 if (r->headers_out.location) {
1290 v->len = r->headers_out.location->value.len;
1292 v->no_cacheable = 0;
1294 v->data = r->headers_out.location->value.data;
1299 return ngx_http_variable_unknown_header(v, (ngx_str_t *) data,
1300 &r->headers_out.headers.part,
1301 sizeof("sent_http_") - 1);
1306 ngx_http_variable_sent_last_modified(ngx_http_request_t *r,
1307 ngx_http_variable_value_t *v, uintptr_t data)
1311 if (r->headers_out.last_modified) {
1312 v->len = r->headers_out.last_modified->value.len;
1314 v->no_cacheable = 0;
1316 v->data = r->headers_out.last_modified->value.data;
1321 if (r->headers_out.last_modified_time >= 0) {
1322 p = ngx_pnalloc(r->pool,
1323 sizeof("Last-Modified: Mon, 28 Sep 1970 06:00:00 GMT") - 1);
1328 v->len = ngx_http_time(p, r->headers_out.last_modified_time) - p;
1330 v->no_cacheable = 0;
1344 ngx_http_variable_sent_connection(ngx_http_request_t *r,
1345 ngx_http_variable_value_t *v, uintptr_t data)
1351 len = sizeof("keep-alive") - 1;
1355 len = sizeof("close") - 1;
1361 v->no_cacheable = 0;
1363 v->data = (u_char *) p;
1370 ngx_http_variable_sent_keep_alive(ngx_http_request_t *r,
1371 ngx_http_variable_value_t *v, uintptr_t data)
1374 ngx_http_core_loc_conf_t *clcf;
1377 clcf = ngx_http_get_module_loc_conf(r, ngx_http_core_module);
1379 if (clcf->keepalive_header) {
1381 p = ngx_pnalloc(r->pool, sizeof("timeout=") - 1 + NGX_TIME_T_LEN);
1386 v->len = ngx_sprintf(p, "timeout=%T", clcf->keepalive_header) - p;
1388 v->no_cacheable = 0;
1403 ngx_http_variable_sent_transfer_encoding(ngx_http_request_t *r,
1404 ngx_http_variable_value_t *v, uintptr_t data)
1407 v->len = sizeof("chunked") - 1;
1409 v->no_cacheable = 0;
1411 v->data = (u_char *) "chunked";
1422 ngx_http_variable_request_completion(ngx_http_request_t *r,
1423 ngx_http_variable_value_t *v, uintptr_t data)
1425 if (r->request_complete) {
1428 v->no_cacheable = 0;
1430 v->data = (u_char *) "OK";
1437 v->no_cacheable = 0;
1439 v->data = (u_char *) "";
1446 ngx_http_variable_request_body_file(ngx_http_request_t *r,
1447 ngx_http_variable_value_t *v, uintptr_t data)
1449 if (r->request_body == NULL || r->request_body->temp_file == NULL) {
1455 v->len = r->request_body->temp_file->file.name.len;
1457 v->no_cacheable = 0;
1459 v->data = r->request_body->temp_file->file.name.data;
1466 ngx_http_variable_nginx_version(ngx_http_request_t *r,
1467 ngx_http_variable_value_t *v, uintptr_t data)
1469 v->len = sizeof(NGINX_VERSION) - 1;
1471 v->no_cacheable = 0;
1473 v->data = (u_char *) NGINX_VERSION;
1480 ngx_http_variable_hostname(ngx_http_request_t *r,
1481 ngx_http_variable_value_t *v, uintptr_t data)
1483 v->len = ngx_cycle->hostname.len;
1485 v->no_cacheable = 0;
1487 v->data = ngx_cycle->hostname.data;
1494 ngx_http_variable_pid(ngx_http_request_t *r,
1495 ngx_http_variable_value_t *v, uintptr_t data)
1499 p = ngx_pnalloc(r->pool, NGX_INT64_LEN);
1504 v->len = ngx_sprintf(p, "%P", ngx_pid) - p;
1506 v->no_cacheable = 0;
1515 ngx_http_variables_add_core_vars(ngx_conf_t *cf)
1518 ngx_http_variable_t *v;
1519 ngx_http_core_main_conf_t *cmcf;
1521 cmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_core_module);
1523 cmcf->variables_keys = ngx_pcalloc(cf->temp_pool,
1524 sizeof(ngx_hash_keys_arrays_t));
1525 if (cmcf->variables_keys == NULL) {
1529 cmcf->variables_keys->pool = cf->pool;
1530 cmcf->variables_keys->temp_pool = cf->pool;
1532 if (ngx_hash_keys_array_init(cmcf->variables_keys, NGX_HASH_SMALL)
1538 for (v = ngx_http_core_variables; v->name.len; v++) {
1539 rc = ngx_hash_add_key(cmcf->variables_keys, &v->name, v,
1540 NGX_HASH_READONLY_KEY);
1546 if (rc == NGX_BUSY) {
1547 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
1548 "conflicting variable name \"%V\"", &v->name);
1559 ngx_http_variables_init_vars(ngx_conf_t *cf)
1562 ngx_hash_key_t *key;
1563 ngx_hash_init_t hash;
1564 ngx_http_variable_t *v, *av;
1565 ngx_http_core_main_conf_t *cmcf;
1567 /* set the handlers for the indexed http variables */
1569 cmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_core_module);
1571 v = cmcf->variables.elts;
1572 key = cmcf->variables_keys->keys.elts;
1574 for (i = 0; i < cmcf->variables.nelts; i++) {
1576 for (n = 0; n < cmcf->variables_keys->keys.nelts; n++) {
1581 && v[i].name.len == key[n].key.len
1582 && ngx_strncmp(v[i].name.data, key[n].key.data, v[i].name.len)
1585 v[i].get_handler = av->get_handler;
1586 v[i].data = av->data;
1588 av->flags |= NGX_HTTP_VAR_INDEXED;
1589 v[i].flags = av->flags;
1597 if (ngx_strncmp(v[i].name.data, "http_", 5) == 0) {
1598 v[i].get_handler = ngx_http_variable_unknown_header_in;
1599 v[i].data = (uintptr_t) &v[i].name;
1604 if (ngx_strncmp(v[i].name.data, "sent_http_", 10) == 0) {
1605 v[i].get_handler = ngx_http_variable_unknown_header_out;
1606 v[i].data = (uintptr_t) &v[i].name;
1611 if (ngx_strncmp(v[i].name.data, "upstream_http_", 14) == 0) {
1612 v[i].get_handler = ngx_http_upstream_header_variable;
1613 v[i].data = (uintptr_t) &v[i].name;
1614 v[i].flags = NGX_HTTP_VAR_NOCACHEABLE;
1619 if (ngx_strncmp(v[i].name.data, "cookie_", 7) == 0) {
1620 v[i].get_handler = ngx_http_variable_cookie;
1621 v[i].data = (uintptr_t) &v[i].name;
1626 if (ngx_strncmp(v[i].name.data, "arg_", 4) == 0) {
1627 v[i].get_handler = ngx_http_variable_argument;
1628 v[i].data = (uintptr_t) &v[i].name;
1633 ngx_log_error(NGX_LOG_EMERG, cf->log, 0,
1634 "unknown \"%V\" variable", &v[i].name);
1643 for (n = 0; n < cmcf->variables_keys->keys.nelts; n++) {
1646 if (av->flags & NGX_HTTP_VAR_NOHASH) {
1647 key[n].key.data = NULL;
1652 hash.hash = &cmcf->variables_hash;
1653 hash.key = ngx_hash_key;
1654 hash.max_size = cmcf->variables_hash_max_size;
1655 hash.bucket_size = cmcf->variables_hash_bucket_size;
1656 hash.name = "variables_hash";
1657 hash.pool = cf->pool;
1658 hash.temp_pool = NULL;
1660 if (ngx_hash_init(&hash, cmcf->variables_keys->keys.elts,
1661 cmcf->variables_keys->keys.nelts)
1667 cmcf->variables_keys = NULL;
1674 ngx_http_variable_value_rbtree_insert(ngx_rbtree_node_t *temp,
1675 ngx_rbtree_node_t *node, ngx_rbtree_node_t *sentinel)
1677 ngx_rbtree_node_t **p;
1678 ngx_http_variable_value_node_t *vvn, *vvt;
1682 vvn = (ngx_http_variable_value_node_t *) node;
1683 vvt = (ngx_http_variable_value_node_t *) temp;
1685 if (node->key != temp->key) {
1687 p = (node->key < temp->key) ? &temp->left : &temp->right;
1689 } else if (vvn->len != vvt->len) {
1691 p = (vvn->len < vvt->len) ? &temp->left : &temp->right;
1694 p = (ngx_memcmp(vvn->value->data, vvt->value->data, vvn->len) < 0)
1695 ? &temp->left : &temp->right;
1698 if (*p == sentinel) {
1706 node->parent = temp;
1707 node->left = sentinel;
1708 node->right = sentinel;
1713 ngx_http_variable_value_t *
1714 ngx_http_variable_value_lookup(ngx_rbtree_t *rbtree, ngx_str_t *val,
1718 ngx_rbtree_node_t *node, *sentinel;
1719 ngx_http_variable_value_node_t *vvn;
1721 node = rbtree->root;
1722 sentinel = rbtree->sentinel;
1724 while (node != sentinel) {
1726 vvn = (ngx_http_variable_value_node_t *) node;
1728 if (hash != node->key) {
1729 node = (hash < node->key) ? node->left : node->right;
1733 if (val->len != vvn->len) {
1734 node = (val->len < vvn->len) ? node->left : node->right;
1738 rc = ngx_memcmp(val->data, vvn->value->data, val->len);