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))
342 for (i = 0; i < cmcf->variables.nelts; i++) {
343 if (name->len != v[i].name.len
344 || ngx_strncasecmp(name->data, v[i].name.data, name->len) != 0)
353 v = ngx_array_push(&cmcf->variables);
358 v->name.len = name->len;
359 v->name.data = ngx_pnalloc(cf->pool, name->len);
360 if (v->name.data == NULL) {
364 ngx_strlow(v->name.data, name->data, name->len);
366 v->set_handler = NULL;
367 v->get_handler = NULL;
370 v->index = cmcf->variables.nelts - 1;
372 return cmcf->variables.nelts - 1;
376 ngx_http_variable_value_t *
377 ngx_http_get_indexed_variable(ngx_http_request_t *r, ngx_uint_t index)
379 ngx_http_variable_t *v;
380 ngx_http_core_main_conf_t *cmcf;
382 cmcf = ngx_http_get_module_main_conf(r, ngx_http_core_module);
384 if (cmcf->variables.nelts <= index) {
385 ngx_log_error(NGX_LOG_ALERT, r->connection->log, 0,
386 "unknown variable index: %d", index);
390 if (r->variables[index].not_found || r->variables[index].valid) {
391 return &r->variables[index];
394 v = cmcf->variables.elts;
396 if (v[index].get_handler(r, &r->variables[index], v[index].data)
399 if (v[index].flags & NGX_HTTP_VAR_NOCACHEABLE) {
400 r->variables[index].no_cacheable = 1;
403 return &r->variables[index];
406 r->variables[index].valid = 0;
407 r->variables[index].not_found = 1;
413 ngx_http_variable_value_t *
414 ngx_http_get_flushed_variable(ngx_http_request_t *r, ngx_uint_t index)
416 ngx_http_variable_value_t *v;
418 v = &r->variables[index];
421 if (!v->no_cacheable) {
429 return ngx_http_get_indexed_variable(r, index);
433 ngx_http_variable_value_t *
434 ngx_http_get_variable(ngx_http_request_t *r, ngx_str_t *name, ngx_uint_t key,
437 ngx_http_variable_t *v;
438 ngx_http_variable_value_t *vv;
439 ngx_http_core_main_conf_t *cmcf;
441 cmcf = ngx_http_get_module_main_conf(r, ngx_http_core_module);
443 v = ngx_hash_find(&cmcf->variables_hash, key, name->data, name->len);
446 if (v->flags & NGX_HTTP_VAR_INDEXED) {
447 return ngx_http_get_indexed_variable(r, v->index);
451 vv = ngx_palloc(r->pool, sizeof(ngx_http_variable_value_t));
453 if (vv && v->get_handler(r, vv, v->data) == NGX_OK) {
461 vv = ngx_palloc(r->pool, sizeof(ngx_http_variable_value_t));
466 if (ngx_strncmp(name->data, "http_", 5) == 0) {
468 if (ngx_http_variable_unknown_header_in(r, vv, (uintptr_t) name)
477 if (ngx_strncmp(name->data, "sent_http_", 10) == 0) {
479 if (ngx_http_variable_unknown_header_out(r, vv, (uintptr_t) name)
488 if (ngx_strncmp(name->data, "upstream_http_", 10) == 0) {
490 if (ngx_http_upstream_header_variable(r, vv, (uintptr_t) name)
499 if (ngx_strncmp(name->data, "cookie_", 7) == 0) {
501 if (ngx_http_variable_cookie(r, vv, (uintptr_t) name) == NGX_OK) {
508 if (ngx_strncmp(name->data, "arg_", 4) == 0) {
510 if (ngx_http_variable_argument(r, vv, (uintptr_t) name) == NGX_OK) {
520 ngx_log_error(NGX_LOG_ERR, r->connection->log, 0,
521 "unknown \"%V\" variable", name);
529 ngx_http_variable_request(ngx_http_request_t *r, ngx_http_variable_value_t *v,
534 s = (ngx_str_t *) ((char *) r + data);
552 ngx_http_variable_request_set(ngx_http_request_t *r,
553 ngx_http_variable_value_t *v, uintptr_t data)
557 s = (ngx_str_t *) ((char *) r + data);
565 ngx_http_variable_request_set_size(ngx_http_request_t *r,
566 ngx_http_variable_value_t *v, uintptr_t data)
574 s = ngx_parse_size(&val);
576 if (s == NGX_ERROR) {
577 ngx_log_error(NGX_LOG_ERR, r->connection->log, 0,
578 "invalid size \"%V\"", &val);
582 sp = (ssize_t *) ((char *) r + data);
591 ngx_http_variable_header(ngx_http_request_t *r, ngx_http_variable_value_t *v,
596 h = *(ngx_table_elt_t **) ((char *) r + data);
599 v->len = h->value.len;
603 v->data = h->value.data;
614 ngx_http_variable_headers(ngx_http_request_t *r, ngx_http_variable_value_t *v,
623 a = (ngx_array_t *) ((char *) r + data);
639 v->len = (*h)->value.len;
640 v->data = (*h)->value.data;
645 len = - (ssize_t) (sizeof("; ") - 1);
647 for (i = 0; i < n; i++) {
648 len += h[i]->value.len + sizeof("; ") - 1;
651 p = ngx_pnalloc(r->pool, len);
659 for (i = 0; /* void */ ; i++) {
660 p = ngx_copy(p, h[i]->value.data, h[i]->value.len);
666 *p++ = ';'; *p++ = ' ';
674 ngx_http_variable_unknown_header_in(ngx_http_request_t *r,
675 ngx_http_variable_value_t *v, uintptr_t data)
677 return ngx_http_variable_unknown_header(v, (ngx_str_t *) data,
678 &r->headers_in.headers.part,
679 sizeof("http_") - 1);
684 ngx_http_variable_unknown_header_out(ngx_http_request_t *r,
685 ngx_http_variable_value_t *v, uintptr_t data)
687 return ngx_http_variable_unknown_header(v, (ngx_str_t *) data,
688 &r->headers_out.headers.part,
689 sizeof("sent_http_") - 1);
694 ngx_http_variable_unknown_header(ngx_http_variable_value_t *v, ngx_str_t *var,
695 ngx_list_part_t *part, size_t prefix)
699 ngx_table_elt_t *header;
703 for (i = 0; /* void */ ; i++) {
705 if (i >= part->nelts) {
706 if (part->next == NULL) {
715 for (n = 0; n + prefix < var->len && n < header[i].key.len; n++) {
716 ch = header[i].key.data[n];
718 if (ch >= 'A' && ch <= 'Z') {
721 } else if (ch == '-') {
725 if (var->data[n + prefix] != ch) {
730 if (n + prefix == var->len && n == header[i].key.len) {
731 v->len = header[i].value.len;
735 v->data = header[i].value.data;
748 ngx_http_variable_cookie(ngx_http_request_t *r, ngx_http_variable_value_t *v,
751 ngx_str_t *name = (ngx_str_t *) data;
755 s.len = name->len - (sizeof("cookie_") - 1);
756 s.data = name->data + sizeof("cookie_") - 1;
758 if (ngx_http_parse_multi_header_lines(&r->headers_in.cookies, &s, &cookie)
769 v->data = cookie.data;
776 ngx_http_variable_argument(ngx_http_request_t *r, ngx_http_variable_value_t *v,
779 ngx_str_t *name = (ngx_str_t *) data;
785 len = name->len - (sizeof("arg_") - 1);
786 arg = name->data + sizeof("arg_") - 1;
788 if (ngx_http_arg(r, arg, len, &value) != NGX_OK) {
793 v->data = value.data;
804 ngx_http_variable_host(ngx_http_request_t *r, ngx_http_variable_value_t *v,
807 ngx_http_core_srv_conf_t *cscf;
809 if (r->headers_in.server.len) {
810 v->len = r->headers_in.server.len;
811 v->data = r->headers_in.server.data;
814 cscf = ngx_http_get_module_srv_conf(r, ngx_http_core_module);
816 v->len = cscf->server_name.len;
817 v->data = cscf->server_name.data;
829 ngx_http_variable_binary_remote_addr(ngx_http_request_t *r,
830 ngx_http_variable_value_t *v, uintptr_t data)
832 struct sockaddr_in *sin;
834 struct sockaddr_in6 *sin6;
837 switch (r->connection->sockaddr->sa_family) {
841 sin6 = (struct sockaddr_in6 *) r->connection->sockaddr;
843 v->len = sizeof(struct in6_addr);
847 v->data = (u_char *) &sin6->sin6_addr;
852 default: /* AF_INET */
853 sin = (struct sockaddr_in *) r->connection->sockaddr;
855 v->len = sizeof(in_addr_t);
859 v->data = (u_char *) &sin->sin_addr;
869 ngx_http_variable_remote_addr(ngx_http_request_t *r,
870 ngx_http_variable_value_t *v, uintptr_t data)
872 v->len = r->connection->addr_text.len;
876 v->data = r->connection->addr_text.data;
883 ngx_http_variable_remote_port(ngx_http_request_t *r,
884 ngx_http_variable_value_t *v, uintptr_t data)
887 struct sockaddr_in *sin;
889 struct sockaddr_in6 *sin6;
897 v->data = ngx_pnalloc(r->pool, sizeof("65535") - 1);
898 if (v->data == NULL) {
902 switch (r->connection->sockaddr->sa_family) {
906 sin6 = (struct sockaddr_in6 *) r->connection->sockaddr;
907 port = ntohs(sin6->sin6_port);
911 default: /* AF_INET */
912 sin = (struct sockaddr_in *) r->connection->sockaddr;
913 port = ntohs(sin->sin_port);
917 if (port > 0 && port < 65536) {
918 v->len = ngx_sprintf(v->data, "%ui", port) - v->data;
926 ngx_http_variable_server_addr(ngx_http_request_t *r,
927 ngx_http_variable_value_t *v, uintptr_t data)
930 u_char addr[NGX_SOCKADDR_STRLEN];
932 s.len = NGX_SOCKADDR_STRLEN;
935 if (ngx_http_server_addr(r, &s) != NGX_OK) {
939 s.data = ngx_pnalloc(r->pool, s.len);
940 if (s.data == NULL) {
944 ngx_memcpy(s.data, addr, s.len);
957 ngx_http_variable_server_port(ngx_http_request_t *r,
958 ngx_http_variable_value_t *v, uintptr_t data)
961 struct sockaddr_in *sin;
963 struct sockaddr_in6 *sin6;
971 if (ngx_http_server_addr(r, NULL) != NGX_OK) {
975 v->data = ngx_pnalloc(r->pool, sizeof("65535") - 1);
976 if (v->data == NULL) {
980 switch (r->connection->local_sockaddr->sa_family) {
984 sin6 = (struct sockaddr_in6 *) r->connection->local_sockaddr;
985 port = ntohs(sin6->sin6_port);
989 default: /* AF_INET */
990 sin = (struct sockaddr_in *) r->connection->local_sockaddr;
991 port = ntohs(sin->sin_port);
995 if (port > 0 && port < 65536) {
996 v->len = ngx_sprintf(v->data, "%ui", port) - v->data;
1004 ngx_http_variable_scheme(ngx_http_request_t *r,
1005 ngx_http_variable_value_t *v, uintptr_t data)
1009 if (r->connection->ssl) {
1010 v->len = sizeof("https") - 1;
1012 v->no_cacheable = 0;
1014 v->data = (u_char *) "https";
1021 v->len = sizeof("http") - 1;
1023 v->no_cacheable = 0;
1025 v->data = (u_char *) "http";
1032 ngx_http_variable_is_args(ngx_http_request_t *r,
1033 ngx_http_variable_value_t *v, uintptr_t data)
1036 v->no_cacheable = 0;
1039 if (r->args.len == 0) {
1046 v->data = (u_char *) "?";
1053 ngx_http_variable_document_root(ngx_http_request_t *r,
1054 ngx_http_variable_value_t *v, uintptr_t data)
1057 ngx_http_core_loc_conf_t *clcf;
1059 clcf = ngx_http_get_module_loc_conf(r, ngx_http_core_module);
1061 if (clcf->root_lengths == NULL) {
1062 v->len = clcf->root.len;
1064 v->no_cacheable = 0;
1066 v->data = clcf->root.data;
1069 if (ngx_http_script_run(r, &path, clcf->root_lengths->elts, 0,
1070 clcf->root_values->elts)
1076 if (ngx_conf_full_name((ngx_cycle_t *) ngx_cycle, &path, 0) != NGX_OK) {
1082 v->no_cacheable = 0;
1084 v->data = path.data;
1092 ngx_http_variable_realpath_root(ngx_http_request_t *r,
1093 ngx_http_variable_value_t *v, uintptr_t data)
1097 ngx_http_core_loc_conf_t *clcf;
1098 u_char real[NGX_MAX_PATH];
1100 clcf = ngx_http_get_module_loc_conf(r, ngx_http_core_module);
1102 if (clcf->root_lengths == NULL) {
1106 if (ngx_http_script_run(r, &path, clcf->root_lengths->elts, 1,
1107 clcf->root_values->elts)
1113 path.data[path.len - 1] = '\0';
1115 if (ngx_conf_full_name((ngx_cycle_t *) ngx_cycle, &path, 0) != NGX_OK) {
1120 if (ngx_realpath(path.data, real) == NULL) {
1121 ngx_log_error(NGX_LOG_CRIT, r->connection->log, ngx_errno,
1122 ngx_realpath_n " \"%s\" failed", path.data);
1126 len = ngx_strlen(real);
1128 v->data = ngx_pnalloc(r->pool, len);
1129 if (v->data == NULL) {
1135 v->no_cacheable = 0;
1138 ngx_memcpy(v->data, real, len);
1145 ngx_http_variable_request_filename(ngx_http_request_t *r,
1146 ngx_http_variable_value_t *v, uintptr_t data)
1151 if (ngx_http_map_uri_to_path(r, &path, &root, 0) == NULL) {
1155 /* ngx_http_map_uri_to_path() allocates memory for terminating '\0' */
1157 v->len = path.len - 1;
1159 v->no_cacheable = 0;
1161 v->data = path.data;
1168 ngx_http_variable_server_name(ngx_http_request_t *r,
1169 ngx_http_variable_value_t *v, uintptr_t data)
1171 ngx_http_core_srv_conf_t *cscf;
1173 cscf = ngx_http_get_module_srv_conf(r, ngx_http_core_module);
1175 v->len = cscf->server_name.len;
1177 v->no_cacheable = 0;
1179 v->data = cscf->server_name.data;
1186 ngx_http_variable_request_method(ngx_http_request_t *r,
1187 ngx_http_variable_value_t *v, uintptr_t data)
1189 if (r->main->method_name.data) {
1190 v->len = r->main->method_name.len;
1192 v->no_cacheable = 0;
1194 v->data = r->main->method_name.data;
1205 ngx_http_variable_remote_user(ngx_http_request_t *r,
1206 ngx_http_variable_value_t *v, uintptr_t data)
1210 rc = ngx_http_auth_basic_user(r);
1212 if (rc == NGX_DECLINED) {
1217 if (rc == NGX_ERROR) {
1221 v->len = r->headers_in.user.len;
1223 v->no_cacheable = 0;
1225 v->data = r->headers_in.user.data;
1232 ngx_http_variable_body_bytes_sent(ngx_http_request_t *r,
1233 ngx_http_variable_value_t *v, uintptr_t data)
1238 sent = r->connection->sent - r->header_size;
1244 p = ngx_pnalloc(r->pool, NGX_OFF_T_LEN);
1249 v->len = ngx_sprintf(p, "%O", sent) - p;
1251 v->no_cacheable = 0;
1260 ngx_http_variable_sent_content_type(ngx_http_request_t *r,
1261 ngx_http_variable_value_t *v, uintptr_t data)
1263 if (r->headers_out.content_type.len) {
1264 v->len = r->headers_out.content_type.len;
1266 v->no_cacheable = 0;
1268 v->data = r->headers_out.content_type.data;
1279 ngx_http_variable_sent_content_length(ngx_http_request_t *r,
1280 ngx_http_variable_value_t *v, uintptr_t data)
1284 if (r->headers_out.content_length) {
1285 v->len = r->headers_out.content_length->value.len;
1287 v->no_cacheable = 0;
1289 v->data = r->headers_out.content_length->value.data;
1294 if (r->headers_out.content_length_n >= 0) {
1295 p = ngx_pnalloc(r->pool, NGX_OFF_T_LEN);
1300 v->len = ngx_sprintf(p, "%O", r->headers_out.content_length_n) - p;
1302 v->no_cacheable = 0;
1316 ngx_http_variable_sent_location(ngx_http_request_t *r,
1317 ngx_http_variable_value_t *v, uintptr_t data)
1321 if (r->headers_out.location) {
1322 v->len = r->headers_out.location->value.len;
1324 v->no_cacheable = 0;
1326 v->data = r->headers_out.location->value.data;
1331 name.len = sizeof("sent_http_location") - 1;
1332 name.data = (u_char *) "sent_http_location";
1334 return ngx_http_variable_unknown_header(v, &name,
1335 &r->headers_out.headers.part,
1336 sizeof("sent_http_") - 1);
1341 ngx_http_variable_sent_last_modified(ngx_http_request_t *r,
1342 ngx_http_variable_value_t *v, uintptr_t data)
1346 if (r->headers_out.last_modified) {
1347 v->len = r->headers_out.last_modified->value.len;
1349 v->no_cacheable = 0;
1351 v->data = r->headers_out.last_modified->value.data;
1356 if (r->headers_out.last_modified_time >= 0) {
1357 p = ngx_pnalloc(r->pool,
1358 sizeof("Last-Modified: Mon, 28 Sep 1970 06:00:00 GMT") - 1);
1363 v->len = ngx_http_time(p, r->headers_out.last_modified_time) - p;
1365 v->no_cacheable = 0;
1379 ngx_http_variable_sent_connection(ngx_http_request_t *r,
1380 ngx_http_variable_value_t *v, uintptr_t data)
1386 len = sizeof("keep-alive") - 1;
1390 len = sizeof("close") - 1;
1396 v->no_cacheable = 0;
1398 v->data = (u_char *) p;
1405 ngx_http_variable_sent_keep_alive(ngx_http_request_t *r,
1406 ngx_http_variable_value_t *v, uintptr_t data)
1409 ngx_http_core_loc_conf_t *clcf;
1412 clcf = ngx_http_get_module_loc_conf(r, ngx_http_core_module);
1414 if (clcf->keepalive_header) {
1416 p = ngx_pnalloc(r->pool, sizeof("timeout=") - 1 + NGX_TIME_T_LEN);
1421 v->len = ngx_sprintf(p, "timeout=%T", clcf->keepalive_header) - p;
1423 v->no_cacheable = 0;
1438 ngx_http_variable_sent_transfer_encoding(ngx_http_request_t *r,
1439 ngx_http_variable_value_t *v, uintptr_t data)
1442 v->len = sizeof("chunked") - 1;
1444 v->no_cacheable = 0;
1446 v->data = (u_char *) "chunked";
1457 ngx_http_variable_request_completion(ngx_http_request_t *r,
1458 ngx_http_variable_value_t *v, uintptr_t data)
1460 if (r->request_complete) {
1463 v->no_cacheable = 0;
1465 v->data = (u_char *) "OK";
1472 v->no_cacheable = 0;
1474 v->data = (u_char *) "";
1481 ngx_http_variable_request_body_file(ngx_http_request_t *r,
1482 ngx_http_variable_value_t *v, uintptr_t data)
1484 if (r->request_body == NULL || r->request_body->temp_file == NULL) {
1490 v->len = r->request_body->temp_file->file.name.len;
1492 v->no_cacheable = 0;
1494 v->data = r->request_body->temp_file->file.name.data;
1501 ngx_http_variable_nginx_version(ngx_http_request_t *r,
1502 ngx_http_variable_value_t *v, uintptr_t data)
1504 v->len = sizeof(NGINX_VERSION) - 1;
1506 v->no_cacheable = 0;
1508 v->data = (u_char *) NGINX_VERSION;
1515 ngx_http_variable_hostname(ngx_http_request_t *r,
1516 ngx_http_variable_value_t *v, uintptr_t data)
1518 v->len = ngx_cycle->hostname.len;
1520 v->no_cacheable = 0;
1522 v->data = ngx_cycle->hostname.data;
1529 ngx_http_variable_pid(ngx_http_request_t *r,
1530 ngx_http_variable_value_t *v, uintptr_t data)
1534 p = ngx_pnalloc(r->pool, NGX_INT64_LEN);
1539 v->len = ngx_sprintf(p, "%P", ngx_pid) - p;
1541 v->no_cacheable = 0;
1550 ngx_http_variables_add_core_vars(ngx_conf_t *cf)
1553 ngx_http_variable_t *v;
1554 ngx_http_core_main_conf_t *cmcf;
1556 cmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_core_module);
1558 cmcf->variables_keys = ngx_pcalloc(cf->temp_pool,
1559 sizeof(ngx_hash_keys_arrays_t));
1560 if (cmcf->variables_keys == NULL) {
1564 cmcf->variables_keys->pool = cf->pool;
1565 cmcf->variables_keys->temp_pool = cf->pool;
1567 if (ngx_hash_keys_array_init(cmcf->variables_keys, NGX_HASH_SMALL)
1573 for (v = ngx_http_core_variables; v->name.len; v++) {
1574 rc = ngx_hash_add_key(cmcf->variables_keys, &v->name, v,
1575 NGX_HASH_READONLY_KEY);
1581 if (rc == NGX_BUSY) {
1582 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
1583 "conflicting variable name \"%V\"", &v->name);
1594 ngx_http_variables_init_vars(ngx_conf_t *cf)
1597 ngx_hash_key_t *key;
1598 ngx_hash_init_t hash;
1599 ngx_http_variable_t *v, *av;
1600 ngx_http_core_main_conf_t *cmcf;
1602 /* set the handlers for the indexed http variables */
1604 cmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_core_module);
1606 v = cmcf->variables.elts;
1607 key = cmcf->variables_keys->keys.elts;
1609 for (i = 0; i < cmcf->variables.nelts; i++) {
1611 for (n = 0; n < cmcf->variables_keys->keys.nelts; n++) {
1616 && v[i].name.len == key[n].key.len
1617 && ngx_strncmp(v[i].name.data, key[n].key.data, v[i].name.len)
1620 v[i].get_handler = av->get_handler;
1621 v[i].data = av->data;
1623 av->flags |= NGX_HTTP_VAR_INDEXED;
1624 v[i].flags = av->flags;
1632 if (ngx_strncmp(v[i].name.data, "http_", 5) == 0) {
1633 v[i].get_handler = ngx_http_variable_unknown_header_in;
1634 v[i].data = (uintptr_t) &v[i].name;
1639 if (ngx_strncmp(v[i].name.data, "sent_http_", 10) == 0) {
1640 v[i].get_handler = ngx_http_variable_unknown_header_out;
1641 v[i].data = (uintptr_t) &v[i].name;
1646 if (ngx_strncmp(v[i].name.data, "upstream_http_", 14) == 0) {
1647 v[i].get_handler = ngx_http_upstream_header_variable;
1648 v[i].data = (uintptr_t) &v[i].name;
1649 v[i].flags = NGX_HTTP_VAR_NOCACHEABLE;
1654 if (ngx_strncmp(v[i].name.data, "cookie_", 7) == 0) {
1655 v[i].get_handler = ngx_http_variable_cookie;
1656 v[i].data = (uintptr_t) &v[i].name;
1661 if (ngx_strncmp(v[i].name.data, "arg_", 4) == 0) {
1662 v[i].get_handler = ngx_http_variable_argument;
1663 v[i].data = (uintptr_t) &v[i].name;
1668 ngx_log_error(NGX_LOG_EMERG, cf->log, 0,
1669 "unknown \"%V\" variable", &v[i].name);
1678 for (n = 0; n < cmcf->variables_keys->keys.nelts; n++) {
1681 if (av->flags & NGX_HTTP_VAR_NOHASH) {
1682 key[n].key.data = NULL;
1687 hash.hash = &cmcf->variables_hash;
1688 hash.key = ngx_hash_key;
1689 hash.max_size = cmcf->variables_hash_max_size;
1690 hash.bucket_size = cmcf->variables_hash_bucket_size;
1691 hash.name = "variables_hash";
1692 hash.pool = cf->pool;
1693 hash.temp_pool = NULL;
1695 if (ngx_hash_init(&hash, cmcf->variables_keys->keys.elts,
1696 cmcf->variables_keys->keys.nelts)
1702 cmcf->variables_keys = NULL;
1709 ngx_http_variable_value_rbtree_insert(ngx_rbtree_node_t *temp,
1710 ngx_rbtree_node_t *node, ngx_rbtree_node_t *sentinel)
1712 ngx_rbtree_node_t **p;
1713 ngx_http_variable_value_node_t *vvn, *vvt;
1717 vvn = (ngx_http_variable_value_node_t *) node;
1718 vvt = (ngx_http_variable_value_node_t *) temp;
1720 if (node->key != temp->key) {
1722 p = (node->key < temp->key) ? &temp->left : &temp->right;
1724 } else if (vvn->len != vvt->len) {
1726 p = (vvn->len < vvt->len) ? &temp->left : &temp->right;
1729 p = (ngx_memcmp(vvn->value->data, vvt->value->data, vvn->len) < 0)
1730 ? &temp->left : &temp->right;
1733 if (*p == sentinel) {
1741 node->parent = temp;
1742 node->left = sentinel;
1743 node->right = sentinel;
1748 ngx_http_variable_value_t *
1749 ngx_http_variable_value_lookup(ngx_rbtree_t *rbtree, ngx_str_t *val,
1753 ngx_rbtree_node_t *node, *sentinel;
1754 ngx_http_variable_value_node_t *vvn;
1756 node = rbtree->root;
1757 sentinel = rbtree->sentinel;
1759 while (node != sentinel) {
1761 vvn = (ngx_http_variable_value_node_t *) node;
1763 if (hash != node->key) {
1764 node = (hash < node->key) ? node->left : node->right;
1768 if (val->len != vvn->len) {
1769 node = (val->len < vvn->len) ? node->left : node->right;
1773 rc = ngx_memcmp(val->data, vvn->value->data, val->len);