?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
nginx 0.7.8
[nginx-catap.git] / src / http / ngx_http_variables.c
blobcd706a2a945e2e9f2319c97d90dd2debf1a77276
1
2 /*
3 * Copyright (C) Igor Sysoev
4 */
5
6
7 #include <ngx_config.h>
8 #include <ngx_core.h>
9 #include <ngx_event.h>
10 #include <ngx_http.h>
11 #include <nginx.h>
12
13
14 static ngx_int_t ngx_http_variable_request(ngx_http_request_t *r,
15 ngx_http_variable_value_t *v, uintptr_t data);
16 static void ngx_http_variable_request_set(ngx_http_request_t *r,
17 ngx_http_variable_value_t *v, uintptr_t data);
18 static void ngx_http_variable_request_set_size(ngx_http_request_t *r,
19 ngx_http_variable_value_t *v, uintptr_t data);
20 static ngx_int_t ngx_http_variable_header(ngx_http_request_t *r,
21 ngx_http_variable_value_t *v, uintptr_t data);
22 static ngx_int_t ngx_http_variable_headers(ngx_http_request_t *r,
23 ngx_http_variable_value_t *v, uintptr_t data);
24
25 static ngx_int_t ngx_http_variable_unknown_header_in(ngx_http_request_t *r,
26 ngx_http_variable_value_t *v, uintptr_t data);
27 static ngx_int_t ngx_http_variable_unknown_header_out(ngx_http_request_t *r,
28 ngx_http_variable_value_t *v, uintptr_t data);
29 static ngx_int_t ngx_http_variable_argument(ngx_http_request_t *r,
30 ngx_http_variable_value_t *v, uintptr_t data);
31
32 static ngx_int_t ngx_http_variable_host(ngx_http_request_t *r,
33 ngx_http_variable_value_t *v, uintptr_t data);
34 static ngx_int_t ngx_http_variable_binary_remote_addr(ngx_http_request_t *r,
35 ngx_http_variable_value_t *v, uintptr_t data);
36 static ngx_int_t ngx_http_variable_remote_addr(ngx_http_request_t *r,
37 ngx_http_variable_value_t *v, uintptr_t data);
38 static ngx_int_t ngx_http_variable_remote_port(ngx_http_request_t *r,
39 ngx_http_variable_value_t *v, uintptr_t data);
40 static ngx_int_t ngx_http_variable_server_addr(ngx_http_request_t *r,
41 ngx_http_variable_value_t *v, uintptr_t data);
42 static ngx_int_t ngx_http_variable_server_port(ngx_http_request_t *r,
43 ngx_http_variable_value_t *v, uintptr_t data);
44 static ngx_int_t ngx_http_variable_scheme(ngx_http_request_t *r,
45 ngx_http_variable_value_t *v, uintptr_t data);
46 static ngx_int_t ngx_http_variable_is_args(ngx_http_request_t *r,
47 ngx_http_variable_value_t *v, uintptr_t data);
48 static ngx_int_t ngx_http_variable_document_root(ngx_http_request_t *r,
49 ngx_http_variable_value_t *v, uintptr_t data);
50 static ngx_int_t ngx_http_variable_request_filename(ngx_http_request_t *r,
51 ngx_http_variable_value_t *v, uintptr_t data);
52 static ngx_int_t ngx_http_variable_server_name(ngx_http_request_t *r,
53 ngx_http_variable_value_t *v, uintptr_t data);
54 static ngx_int_t ngx_http_variable_request_method(ngx_http_request_t *r,
55 ngx_http_variable_value_t *v, uintptr_t data);
56 static ngx_int_t ngx_http_variable_remote_user(ngx_http_request_t *r,
57 ngx_http_variable_value_t *v, uintptr_t data);
58 static ngx_int_t ngx_http_variable_body_bytes_sent(ngx_http_request_t *r,
59 ngx_http_variable_value_t *v, uintptr_t data);
60 static ngx_int_t ngx_http_variable_request_completion(ngx_http_request_t *r,
61 ngx_http_variable_value_t *v, uintptr_t data);
62 static ngx_int_t ngx_http_variable_request_body_file(ngx_http_request_t *r,
63 ngx_http_variable_value_t *v, uintptr_t data);
64
65 static ngx_int_t ngx_http_variable_sent_content_type(ngx_http_request_t *r,
66 ngx_http_variable_value_t *v, uintptr_t data);
67 static ngx_int_t ngx_http_variable_sent_content_length(ngx_http_request_t *r,
68 ngx_http_variable_value_t *v, uintptr_t data);
69 static ngx_int_t ngx_http_variable_sent_last_modified(ngx_http_request_t *r,
70 ngx_http_variable_value_t *v, uintptr_t data);
71 static ngx_int_t ngx_http_variable_sent_connection(ngx_http_request_t *r,
72 ngx_http_variable_value_t *v, uintptr_t data);
73 static ngx_int_t ngx_http_variable_sent_keep_alive(ngx_http_request_t *r,
74 ngx_http_variable_value_t *v, uintptr_t data);
75 static ngx_int_t ngx_http_variable_sent_transfer_encoding(ngx_http_request_t *r,
76 ngx_http_variable_value_t *v, uintptr_t data);
77
78 static ngx_int_t ngx_http_variable_nginx_version(ngx_http_request_t *r,
79 ngx_http_variable_value_t *v, uintptr_t data);
80 static ngx_int_t ngx_http_variable_hostname(ngx_http_request_t *r,
81 ngx_http_variable_value_t *v, uintptr_t data);
82
83 /*
84 * TODO:
85 * Apache CGI: AUTH_TYPE, PATH_INFO (null), PATH_TRANSLATED
86 * REMOTE_HOST (null), REMOTE_IDENT (null),
87 * SERVER_SOFTWARE
88 *
89 * Apache SSI: DOCUMENT_NAME, LAST_MODIFIED, USER_NAME (file owner)
90 */
91
92 /*
93 * the $http_host, $http_user_agent, $http_referer, $http_via,
94 * and $http_x_forwarded_for variables may be handled by generic
95 * ngx_http_variable_unknown_header_in(), but for perfomance reasons
96 * they are handled using dedicated entries
97 */
98
99 static ngx_http_variable_t ngx_http_core_variables[] = {
100
101 { ngx_string("http_host"), NULL, ngx_http_variable_header,
102 offsetof(ngx_http_request_t, headers_in.host), 0, 0 },
103
104 { ngx_string("http_user_agent"), NULL, ngx_http_variable_header,
105 offsetof(ngx_http_request_t, headers_in.user_agent), 0, 0 },
106
107 { ngx_string("http_referer"), NULL, ngx_http_variable_header,
108 offsetof(ngx_http_request_t, headers_in.referer), 0, 0 },
109
110 #if (NGX_HTTP_GZIP)
111 { ngx_string("http_via"), NULL, ngx_http_variable_header,
112 offsetof(ngx_http_request_t, headers_in.via), 0, 0 },
113 #endif
114
115 #if (NGX_HTTP_PROXY || NGX_HTTP_REALIP)
116 { ngx_string("http_x_forwarded_for"), NULL, ngx_http_variable_header,
117 offsetof(ngx_http_request_t, headers_in.x_forwarded_for), 0, 0 },
118 #endif
119
120 { ngx_string("http_cookie"), NULL, ngx_http_variable_headers,
121 offsetof(ngx_http_request_t, headers_in.cookies), 0, 0 },
122
123 { ngx_string("content_length"), NULL, ngx_http_variable_header,
124 offsetof(ngx_http_request_t, headers_in.content_length), 0, 0 },
125
126 { ngx_string("content_type"), NULL, ngx_http_variable_header,
127 offsetof(ngx_http_request_t, headers_in.content_type), 0, 0 },
128
129 { ngx_string("host"), NULL, ngx_http_variable_host, 0, 0, 0 },
130
131 { ngx_string("binary_remote_addr"), NULL,
132 ngx_http_variable_binary_remote_addr, 0, 0, 0 },
133
134 { ngx_string("remote_addr"), NULL, ngx_http_variable_remote_addr, 0, 0, 0 },
135
136 { ngx_string("remote_port"), NULL, ngx_http_variable_remote_port, 0, 0, 0 },
137
138 { ngx_string("server_addr"), NULL, ngx_http_variable_server_addr, 0, 0, 0 },
139
140 { ngx_string("server_port"), NULL, ngx_http_variable_server_port, 0, 0, 0 },
141
142 { ngx_string("server_protocol"), NULL, ngx_http_variable_request,
143 offsetof(ngx_http_request_t, http_protocol), 0, 0 },
144
145 { ngx_string("scheme"), NULL, ngx_http_variable_scheme, 0, 0, 0 },
146
147 { ngx_string("request_uri"), NULL, ngx_http_variable_request,
148 offsetof(ngx_http_request_t, unparsed_uri), 0, 0 },
149
150 { ngx_string("uri"), NULL, ngx_http_variable_request,
151 offsetof(ngx_http_request_t, uri),
152 NGX_HTTP_VAR_NOCACHEABLE, 0 },
153
154 { ngx_string("document_uri"), NULL, ngx_http_variable_request,
155 offsetof(ngx_http_request_t, uri),
156 NGX_HTTP_VAR_NOCACHEABLE, 0 },
157
158 { ngx_string("request"), NULL, ngx_http_variable_request,
159 offsetof(ngx_http_request_t, request_line), 0, 0 },
160
161 { ngx_string("document_root"), NULL,
162 ngx_http_variable_document_root, 0, NGX_HTTP_VAR_NOCACHEABLE, 0 },
163
164 { ngx_string("query_string"), NULL, ngx_http_variable_request,
165 offsetof(ngx_http_request_t, args),
166 NGX_HTTP_VAR_NOCACHEABLE, 0 },
167
168 { ngx_string("args"),
169 ngx_http_variable_request_set,
170 ngx_http_variable_request,
171 offsetof(ngx_http_request_t, args),
172 NGX_HTTP_VAR_CHANGEABLE|NGX_HTTP_VAR_NOCACHEABLE, 0 },
173
174 { ngx_string("is_args"), NULL, ngx_http_variable_is_args,
175 0, NGX_HTTP_VAR_NOCACHEABLE, 0 },
176
177 { ngx_string("request_filename"), NULL,
178 ngx_http_variable_request_filename, 0,
179 NGX_HTTP_VAR_NOCACHEABLE, 0 },
180
181 { ngx_string("server_name"), NULL, ngx_http_variable_server_name, 0, 0, 0 },
182
183 { ngx_string("request_method"), NULL,
184 ngx_http_variable_request_method, 0, 0, 0 },
185
186 { ngx_string("remote_user"), NULL, ngx_http_variable_remote_user, 0, 0, 0 },
187
188 { ngx_string("body_bytes_sent"), NULL, ngx_http_variable_body_bytes_sent,
189 0, 0, 0 },
190
191 { ngx_string("request_completion"), NULL,
192 ngx_http_variable_request_completion,
193 0, 0, 0 },
194
195 { ngx_string("request_body_file"), NULL,
196 ngx_http_variable_request_body_file,
197 0, 0, 0 },
198
199 { ngx_string("sent_http_content_type"), NULL,
200 ngx_http_variable_sent_content_type, 0, 0, 0 },
201
202 { ngx_string("sent_http_content_length"), NULL,
203 ngx_http_variable_sent_content_length, 0, 0, 0 },
204
205 { ngx_string("sent_http_last_modified"), NULL,
206 ngx_http_variable_sent_last_modified, 0, 0, 0 },
207
208 { ngx_string("sent_http_connection"), NULL,
209 ngx_http_variable_sent_connection, 0, 0, 0 },
210
211 { ngx_string("sent_http_keep_alive"), NULL,
212 ngx_http_variable_sent_keep_alive, 0, 0, 0 },
213
214 { ngx_string("sent_http_transfer_encoding"), NULL,
215 ngx_http_variable_sent_transfer_encoding, 0, 0, 0 },
216
217 { ngx_string("sent_http_cache_control"), NULL, ngx_http_variable_headers,
218 offsetof(ngx_http_request_t, headers_out.cache_control), 0, 0 },
219
220 { ngx_string("limit_rate"), ngx_http_variable_request_set_size,
221 ngx_http_variable_request,
222 offsetof(ngx_http_request_t, limit_rate),
223 NGX_HTTP_VAR_CHANGEABLE|NGX_HTTP_VAR_NOCACHEABLE, 0 },
224
225 { ngx_string("nginx_version"), NULL, ngx_http_variable_nginx_version,
226 0, 0, 0 },
227
228 { ngx_string("hostname"), NULL, ngx_http_variable_hostname,
229 0, 0, 0 },
230
231 { ngx_null_string, NULL, NULL, 0, 0, 0 }
232 };
233
234
235 ngx_http_variable_value_t ngx_http_variable_null_value =
236 ngx_http_variable("");
237 ngx_http_variable_value_t ngx_http_variable_true_value =
238 ngx_http_variable("1");
239
240
241 ngx_http_variable_t *
242 ngx_http_add_variable(ngx_conf_t *cf, ngx_str_t *name, ngx_uint_t flags)
243 {
244 ngx_int_t rc;
245 ngx_uint_t i;
246 ngx_hash_key_t *key;
247 ngx_http_variable_t *v;
248 ngx_http_core_main_conf_t *cmcf;
249
250 cmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_core_module);
251
252 key = cmcf->variables_keys->keys.elts;
253 for (i = 0; i < cmcf->variables_keys->keys.nelts; i++) {
254 if (name->len != key[i].key.len
255 || ngx_strncasecmp(name->data, key[i].key.data, name->len) != 0)
256 {
257 continue;
258 }
259
260 v = key[i].value;
261
262 if (!(v->flags & NGX_HTTP_VAR_CHANGEABLE)) {
263 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
264 "the duplicate \"%V\" variable", name);
265 return NULL;
266 }
267
268 return v;
269 }
270
271 v = ngx_palloc(cf->pool, sizeof(ngx_http_variable_t));
272 if (v == NULL) {
273 return NULL;
274 }
275
276 v->name.len = name->len;
277 v->name.data = ngx_pnalloc(cf->pool, name->len);
278 if (v->name.data == NULL) {
279 return NULL;
280 }
281
282 ngx_strlow(v->name.data, name->data, name->len);
283
284 v->set_handler = NULL;
285 v->get_handler = NULL;
286 v->data = 0;
287 v->flags = flags;
288 v->index = 0;
289
290 rc = ngx_hash_add_key(cmcf->variables_keys, &v->name, v, 0);
291
292 if (rc == NGX_ERROR) {
293 return NULL;
294 }
295
296 if (rc == NGX_BUSY) {
297 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
298 "conflicting variable name \"%V\"", name);
299 return NULL;
300 }
301
302 return v;
303 }
304
305
306 ngx_int_t
307 ngx_http_get_variable_index(ngx_conf_t *cf, ngx_str_t *name)
308 {
309 ngx_uint_t i;
310 ngx_http_variable_t *v;
311 ngx_http_core_main_conf_t *cmcf;
312
313 cmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_core_module);
314
315 v = cmcf->variables.elts;
316
317 if (v == NULL) {
318 if (ngx_array_init(&cmcf->variables, cf->pool, 4,
319 sizeof(ngx_http_variable_t)) == NGX_ERROR)
320 {
321 return NGX_ERROR;
322 }
323
324 } else {
325 for (i = 0; i < cmcf->variables.nelts; i++) {
326 if (name->len != v[i].name.len
327 || ngx_strncasecmp(name->data, v[i].name.data, name->len) != 0)
328 {
329 continue;
330 }
331
332 return i;
333 }
334 }
335
336 v = ngx_array_push(&cmcf->variables);
337 if (v == NULL) {
338 return NGX_ERROR;
339 }
340
341 v->name.len = name->len;
342 v->name.data = ngx_pnalloc(cf->pool, name->len);
343 if (v->name.data == NULL) {
344 return NGX_ERROR;
345 }
346
347 ngx_strlow(v->name.data, name->data, name->len);
348
349 v->set_handler = NULL;
350 v->get_handler = NULL;
351 v->data = 0;
352 v->flags = 0;
353 v->index = cmcf->variables.nelts - 1;
354
355 return cmcf->variables.nelts - 1;
356 }
357
358
359 ngx_http_variable_value_t *
360 ngx_http_get_indexed_variable(ngx_http_request_t *r, ngx_uint_t index)
361 {
362 ngx_http_variable_t *v;
363 ngx_http_core_main_conf_t *cmcf;
364
365 cmcf = ngx_http_get_module_main_conf(r, ngx_http_core_module);
366
367 if (cmcf->variables.nelts <= index) {
368 ngx_log_error(NGX_LOG_ALERT, r->connection->log, 0,
369 "unknown variable index: %d", index);
370 return NULL;
371 }
372
373 if (r->variables[index].not_found || r->variables[index].valid) {
374 return &r->variables[index];
375 }
376
377 v = cmcf->variables.elts;
378
379 if (v[index].get_handler(r, &r->variables[index], v[index].data)
380 == NGX_OK)
381 {
382 if (v[index].flags & NGX_HTTP_VAR_NOCACHEABLE) {
383 r->variables[index].no_cacheable = 1;
384 }
385
386 return &r->variables[index];
387 }
388
389 r->variables[index].valid = 0;
390 r->variables[index].not_found = 1;
391
392 return NULL;
393 }
394
395
396 ngx_http_variable_value_t *
397 ngx_http_get_flushed_variable(ngx_http_request_t *r, ngx_uint_t index)
398 {
399 ngx_http_variable_value_t *v;
400
401 v = &r->variables[index];
402
403 if (v->valid) {
404 if (!v->no_cacheable) {
405 return v;
406 }
407
408 v->valid = 0;
409 v->not_found = 0;
410 }
411
412 return ngx_http_get_indexed_variable(r, index);
413 }
414
415
416 ngx_http_variable_value_t *
417 ngx_http_get_variable(ngx_http_request_t *r, ngx_str_t *name, ngx_uint_t key,
418 ngx_uint_t nowarn)
419 {
420 ngx_http_variable_t *v;
421 ngx_http_variable_value_t *vv;
422 ngx_http_core_main_conf_t *cmcf;
423
424 cmcf = ngx_http_get_module_main_conf(r, ngx_http_core_module);
425
426 v = ngx_hash_find(&cmcf->variables_hash, key, name->data, name->len);
427
428 if (v) {
429 if (v->flags & NGX_HTTP_VAR_INDEXED) {
430 return ngx_http_get_indexed_variable(r, v->index);
431
432 } else {
433
434 vv = ngx_palloc(r->pool, sizeof(ngx_http_variable_value_t));
435
436 if (vv && v->get_handler(r, vv, v->data) == NGX_OK) {
437 return vv;
438 }
439
440 return NULL;
441 }
442 }
443
444 vv = ngx_palloc(r->pool, sizeof(ngx_http_variable_value_t));
445 if (vv == NULL) {
446 return NULL;
447 }
448
449 if (ngx_strncmp(name->data, "http_", 5) == 0) {
450
451 if (ngx_http_variable_unknown_header_in(r, vv, (uintptr_t) name)
452 == NGX_OK)
453 {
454 return vv;
455 }
456
457 return NULL;
458 }
459
460 if (ngx_strncmp(name->data, "sent_http_", 10) == 0) {
461
462 if (ngx_http_variable_unknown_header_out(r, vv, (uintptr_t) name)
463 == NGX_OK)
464 {
465 return vv;
466 }
467
468 return NULL;
469 }
470
471 if (ngx_strncmp(name->data, "upstream_http_", 10) == 0) {
472
473 if (ngx_http_upstream_header_variable(r, vv, (uintptr_t) name)
474 == NGX_OK)
475 {
476 return vv;
477 }
478
479 return NULL;
480 }
481
482 if (ngx_strncmp(name->data, "arg_", 4) == 0) {
483
484 if (ngx_http_variable_argument(r, vv, (uintptr_t) name) == NGX_OK) {
485 return vv;
486 }
487
488 return NULL;
489 }
490
491 vv->not_found = 1;
492
493 if (nowarn == 0) {
494 ngx_log_error(NGX_LOG_ERR, r->connection->log, 0,
495 "unknown \"%V\" variable", name);
496 }
497
498 return vv;
499 }
500
501
502 static ngx_int_t
503 ngx_http_variable_request(ngx_http_request_t *r, ngx_http_variable_value_t *v,
504 uintptr_t data)
505 {
506 ngx_str_t *s;
507
508 s = (ngx_str_t *) ((char *) r + data);
509
510 if (s->data) {
511 v->len = s->len;
512 v->valid = 1;
513 v->no_cacheable = 0;
514 v->not_found = 0;
515 v->data = s->data;
516
517 } else {
518 v->not_found = 1;
519 }
520
521 return NGX_OK;
522 }
523
524
525 static void
526 ngx_http_variable_request_set(ngx_http_request_t *r,
527 ngx_http_variable_value_t *v, uintptr_t data)
528 {
529 ngx_str_t *s;
530
531 s = (ngx_str_t *) ((char *) r + data);
532
533 s->len = v->len;
534 s->data = v->data;
535 }
536
537
538 static void
539 ngx_http_variable_request_set_size(ngx_http_request_t *r,
540 ngx_http_variable_value_t *v, uintptr_t data)
541 {
542 ssize_t s, *sp;
543 ngx_str_t val;
544
545 val.len = v->len;
546 val.data = v->data;
547
548 s = ngx_parse_size(&val);
549
550 if (s == NGX_ERROR) {
551 ngx_log_error(NGX_LOG_ERR, r->connection->log, 0,
552 "invalid size \"%V\"", &val);
553 return;
554 }
555
556 sp = (ssize_t *) ((char *) r + data);
557
558 *sp = s;
559
560 return;
561 }
562
563
564 static ngx_int_t
565 ngx_http_variable_header(ngx_http_request_t *r, ngx_http_variable_value_t *v,
566 uintptr_t data)
567 {
568 ngx_table_elt_t *h;
569
570 h = *(ngx_table_elt_t **) ((char *) r + data);
571
572 if (h) {
573 v->len = h->value.len;
574 v->valid = 1;
575 v->no_cacheable = 0;
576 v->not_found = 0;
577 v->data = h->value.data;
578
579 } else {
580 v->not_found = 1;
581 }
582
583 return NGX_OK;
584 }
585
586
587 static ngx_int_t
588 ngx_http_variable_headers(ngx_http_request_t *r, ngx_http_variable_value_t *v,
589 uintptr_t data)
590 {
591 ssize_t len;
592 u_char *p;
593 ngx_uint_t i, n;
594 ngx_array_t *a;
595 ngx_table_elt_t **h;
596
597 a = (ngx_array_t *) ((char *) r + data);
598
599 n = a->nelts;
600
601 if (n == 0) {
602 v->not_found = 1;
603 return NGX_OK;
604 }
605
606 v->valid = 1;
607 v->no_cacheable = 0;
608 v->not_found = 0;
609
610 h = a->elts;
611
612 if (n == 1) {
613 v->len = (*h)->value.len;
614 v->data = (*h)->value.data;
615
616 return NGX_OK;
617 }
618
619 len = - (ssize_t) (sizeof("; ") - 1);
620
621 for (i = 0; i < n; i++) {
622 len += h[i]->value.len + sizeof("; ") - 1;
623 }
624
625 p = ngx_pnalloc(r->pool, len);
626 if (p == NULL) {
627 return NGX_ERROR;
628 }
629
630 v->len = len;
631 v->data = p;
632
633 for (i = 0; /* void */ ; i++) {
634 p = ngx_copy(p, h[i]->value.data, h[i]->value.len);
635
636 if (i == n - 1) {
637 break;
638 }
639
640 *p++ = ';'; *p++ = ' ';
641 }
642
643 return NGX_OK;
644 }
645
646
647 static ngx_int_t
648 ngx_http_variable_unknown_header_in(ngx_http_request_t *r,
649 ngx_http_variable_value_t *v, uintptr_t data)
650 {
651 return ngx_http_variable_unknown_header(v, (ngx_str_t *) data,
652 &r->headers_in.headers.part,
653 sizeof("http_") - 1);
654 }
655
656
657 static ngx_int_t
658 ngx_http_variable_unknown_header_out(ngx_http_request_t *r,
659 ngx_http_variable_value_t *v, uintptr_t data)
660 {
661 return ngx_http_variable_unknown_header(v, (ngx_str_t *) data,
662 &r->headers_out.headers.part,
663 sizeof("sent_http_") - 1);
664 }
665
666
667 ngx_int_t
668 ngx_http_variable_unknown_header(ngx_http_variable_value_t *v, ngx_str_t *var,
669 ngx_list_part_t *part, size_t prefix)
670 {
671 u_char ch;
672 ngx_uint_t i, n;
673 ngx_table_elt_t *header;
674
675 header = part->elts;
676
677 for (i = 0; /* void */ ; i++) {
678
679 if (i >= part->nelts) {
680 if (part->next == NULL) {
681 break;
682 }
683
684 part = part->next;
685 header = part->elts;
686 i = 0;
687 }
688
689 for (n = 0; n + prefix < var->len && n < header[i].key.len; n++) {
690 ch = header[i].key.data[n];
691
692 if (ch >= 'A' && ch <= 'Z') {
693 ch |= 0x20;
694
695 } else if (ch == '-') {
696 ch = '_';
697 }
698
699 if (var->data[n + prefix] != ch) {
700 break;
701 }
702 }
703
704 if (n + prefix == var->len && n == header[i].key.len) {
705 v->len = header[i].value.len;
706 v->valid = 1;
707 v->no_cacheable = 0;
708 v->not_found = 0;
709 v->data = header[i].value.data;
710
711 return NGX_OK;
712 }
713 }
714
715 v->not_found = 1;
716
717 return NGX_OK;
718 }
719
720
721 static ngx_int_t
722 ngx_http_variable_argument(ngx_http_request_t *r, ngx_http_variable_value_t *v,
723 uintptr_t data)
724 {
725 ngx_str_t *name = (ngx_str_t *) data;
726
727 u_char *p, *arg;
728 size_t len;
729
730 if (r->args.len == 0) {
731 v->not_found = 1;
732 return NGX_OK;
733 }
734
735 len = name->len - 1 - (sizeof("arg_") - 1);
736 arg = name->data + sizeof("arg_") - 1;
737
738 for (p = r->args.data; *p && *p != ' '; p++) {
739
740 /*
741 * although r->args.data is not null-terminated by itself,
742 * however, there is null in the end of request line
743 */
744
745 p = ngx_strcasestrn(p, (char *) arg, len);
746
747 if (p == NULL) {
748 v->not_found = 1;
749 return NGX_OK;
750 }
751
752 if ((p == r->args.data || *(p - 1) == '&') && *(p + len + 1) == '=') {
753
754 v->data = p + len + 2;
755
756 p = (u_char *) ngx_strchr(p, '&');
757
758 if (p == NULL) {
759 p = r->args.data + r->args.len;
760 }
761
762 v->len = p - v->data;
763 v->valid = 1;
764 v->no_cacheable = 0;
765 v->not_found = 0;
766
767 return NGX_OK;
768 }
769 }
770
771 v->not_found = 1;
772
773 return NGX_OK;
774 }
775
776
777 static ngx_int_t
778 ngx_http_variable_host(ngx_http_request_t *r, ngx_http_variable_value_t *v,
779 uintptr_t data)
780 {
781 ngx_http_core_srv_conf_t *cscf;
782
783 if (r->headers_in.server.len) {
784 v->len = r->headers_in.server.len;
785 v->data = r->headers_in.server.data;
786
787 } else {
788 cscf = ngx_http_get_module_srv_conf(r, ngx_http_core_module);
789
790 v->len = cscf->server_name.len;
791 v->data = cscf->server_name.data;
792 }
793
794 v->valid = 1;
795 v->no_cacheable = 0;
796 v->not_found = 0;
797
798 return NGX_OK;
799 }
800
801
802 static ngx_int_t
803 ngx_http_variable_binary_remote_addr(ngx_http_request_t *r,
804 ngx_http_variable_value_t *v, uintptr_t data)
805 {
806 struct sockaddr_in *sin;
807
808 /* AF_INET only */
809
810 sin = (struct sockaddr_in *) r->connection->sockaddr;
811
812 v->len = sizeof(in_addr_t);
813 v->valid = 1;
814 v->no_cacheable = 0;
815 v->not_found = 0;
816 v->data = (u_char *) &sin->sin_addr.s_addr;
817
818 return NGX_OK;
819 }
820
821
822 static ngx_int_t
823 ngx_http_variable_remote_addr(ngx_http_request_t *r,
824 ngx_http_variable_value_t *v, uintptr_t data)
825 {
826 v->len = r->connection->addr_text.len;
827 v->valid = 1;
828 v->no_cacheable = 0;
829 v->not_found = 0;
830 v->data = r->connection->addr_text.data;
831
832 return NGX_OK;
833 }
834
835
836 static ngx_int_t
837 ngx_http_variable_remote_port(ngx_http_request_t *r,
838 ngx_http_variable_value_t *v, uintptr_t data)
839 {
840 ngx_uint_t port;
841 struct sockaddr_in *sin;
842
843 v->len = 0;
844 v->valid = 1;
845 v->no_cacheable = 0;
846 v->not_found = 0;
847
848 v->data = ngx_pnalloc(r->pool, sizeof("65535") - 1);
849 if (v->data == NULL) {
850 return NGX_ERROR;
851 }
852
853 /* AF_INET only */
854
855 if (r->connection->sockaddr->sa_family == AF_INET) {
856 sin = (struct sockaddr_in *) r->connection->sockaddr;
857
858 port = ntohs(sin->sin_port);
859
860 if (port > 0 && port < 65536) {
861 v->len = ngx_sprintf(v->data, "%ui", port) - v->data;
862 }
863 }
864
865 return NGX_OK;
866 }
867
868
869 static ngx_int_t
870 ngx_http_variable_server_addr(ngx_http_request_t *r,
871 ngx_http_variable_value_t *v, uintptr_t data)
872 {
873 ngx_str_t s;
874
875 s.data = ngx_pnalloc(r->pool, INET_ADDRSTRLEN);
876 if (s.data == NULL) {
877 return NGX_ERROR;
878 }
879
880 if (ngx_http_server_addr(r, &s) != NGX_OK) {
881 return NGX_ERROR;
882 }
883
884 v->len = s.len;
885 v->valid = 1;
886 v->no_cacheable = 0;
887 v->not_found = 0;
888 v->data = s.data;
889
890 return NGX_OK;
891 }
892
893
894 static ngx_int_t
895 ngx_http_variable_server_port(ngx_http_request_t *r,
896 ngx_http_variable_value_t *v, uintptr_t data)
897 {
898 v->len = r->port_text->len - 1;
899 v->valid = 1;
900 v->no_cacheable = 0;
901 v->not_found = 0;
902 v->data = r->port_text->data + 1;
903
904 return NGX_OK;
905 }
906
907
908 static ngx_int_t
909 ngx_http_variable_scheme(ngx_http_request_t *r,
910 ngx_http_variable_value_t *v, uintptr_t data)
911 {
912 #if (NGX_HTTP_SSL)
913
914 if (r->connection->ssl) {
915 v->len = sizeof("https") - 1;
916 v->valid = 1;
917 v->no_cacheable = 0;
918 v->not_found = 0;
919 v->data = (u_char *) "https";
920
921 return NGX_OK;
922 }
923
924 #endif
925
926 v->len = sizeof("http") - 1;
927 v->valid = 1;
928 v->no_cacheable = 0;
929 v->not_found = 0;
930 v->data = (u_char *) "http";
931
932 return NGX_OK;
933 }
934
935
936 static ngx_int_t
937 ngx_http_variable_is_args(ngx_http_request_t *r,
938 ngx_http_variable_value_t *v, uintptr_t data)
939 {
940 v->valid = 1;
941 v->no_cacheable = 0;
942 v->not_found = 0;
943
944 if (r->args.len == 0) {
945 v->len = 0;
946 v->data = NULL;
947 return NGX_OK;
948 }
949
950 v->len = 1;
951 v->data = (u_char *) "?";
952
953 return NGX_OK;
954 }
955
956
957 static ngx_int_t
958 ngx_http_variable_document_root(ngx_http_request_t *r,
959 ngx_http_variable_value_t *v, uintptr_t data)
960 {
961 ngx_str_t path;
962 ngx_http_core_loc_conf_t *clcf;
963
964 clcf = ngx_http_get_module_loc_conf(r, ngx_http_core_module);
965
966 if (clcf->root_lengths == NULL) {
967 v->len = clcf->root.len;
968 v->valid = 1;
969 v->no_cacheable = 0;
970 v->not_found = 0;
971 v->data = clcf->root.data;
972
973 } else {
974 if (ngx_http_script_run(r, &path, clcf->root_lengths->elts, 0,
975 clcf->root_values->elts)
976 == NULL)
977 {
978 return NGX_ERROR;
979 }
980
981 if (ngx_conf_full_name((ngx_cycle_t *) ngx_cycle, &path, 0)
982 == NGX_ERROR)
983 {
984 return NGX_ERROR;
985 }
986
987 v->len = path.len;
988 v->valid = 1;
989 v->no_cacheable = 0;
990 v->not_found = 0;
991 v->data = path.data;
992 }
993
994 return NGX_OK;
995 }
996
997
998 static ngx_int_t
999 ngx_http_variable_request_filename(ngx_http_request_t *r,
1000 ngx_http_variable_value_t *v, uintptr_t data)
1001 {
1002 size_t root;
1003 ngx_str_t path;
1004
1005 if (ngx_http_map_uri_to_path(r, &path, &root, 0) == NULL) {
1006 return NGX_ERROR;
1007 }
1008
1009 /* ngx_http_map_uri_to_path() allocates memory for terminating '\0' */
1010
1011 v->len = path.len - 1;
1012 v->valid = 1;
1013 v->no_cacheable = 0;
1014 v->not_found = 0;
1015 v->data = path.data;
1016
1017 return NGX_OK;
1018 }
1019
1020
1021 static ngx_int_t
1022 ngx_http_variable_server_name(ngx_http_request_t *r,
1023 ngx_http_variable_value_t *v, uintptr_t data)
1024 {
1025 ngx_http_core_srv_conf_t *cscf;
1026
1027 cscf = ngx_http_get_module_srv_conf(r, ngx_http_core_module);
1028
1029 v->len = cscf->server_name.len;
1030 v->valid = 1;
1031 v->no_cacheable = 0;
1032 v->not_found = 0;
1033 v->data = cscf->server_name.data;
1034
1035 return NGX_OK;
1036 }
1037
1038
1039 static ngx_int_t
1040 ngx_http_variable_request_method(ngx_http_request_t *r,
1041 ngx_http_variable_value_t *v, uintptr_t data)
1042 {
1043 if (r->main->method_name.data) {
1044 v->len = r->main->method_name.len;
1045 v->valid = 1;
1046 v->no_cacheable = 0;
1047 v->not_found = 0;
1048 v->data = r->main->method_name.data;
1049
1050 } else {
1051 v->not_found = 1;
1052 }
1053
1054 return NGX_OK;
1055 }
1056
1057
1058 static ngx_int_t
1059 ngx_http_variable_remote_user(ngx_http_request_t *r,
1060 ngx_http_variable_value_t *v, uintptr_t data)
1061 {
1062 ngx_int_t rc;
1063
1064 rc = ngx_http_auth_basic_user(r);
1065
1066 if (rc == NGX_DECLINED) {
1067 v->not_found = 1;
1068 return NGX_OK;
1069 }
1070
1071 if (rc == NGX_ERROR) {
1072 return NGX_ERROR;
1073 }
1074
1075 v->len = r->headers_in.user.len;
1076 v->valid = 1;
1077 v->no_cacheable = 0;
1078 v->not_found = 0;
1079 v->data = r->headers_in.user.data;
1080
1081 return NGX_OK;
1082 }
1083
1084
1085 static ngx_int_t
1086 ngx_http_variable_body_bytes_sent(ngx_http_request_t *r,
1087 ngx_http_variable_value_t *v, uintptr_t data)
1088 {
1089 off_t sent;
1090 u_char *p;
1091
1092 sent = r->connection->sent - r->header_size;
1093
1094 if (sent < 0) {
1095 sent = 0;
1096 }
1097
1098 p = ngx_pnalloc(r->pool, NGX_OFF_T_LEN);
1099 if (p == NULL) {
1100 return NGX_ERROR;
1101 }
1102
1103 v->len = ngx_sprintf(p, "%O", sent) - p;
1104 v->valid = 1;
1105 v->no_cacheable = 0;
1106 v->not_found = 0;
1107 v->data = p;
1108
1109 return NGX_OK;
1110 }
1111
1112
1113 static ngx_int_t
1114 ngx_http_variable_sent_content_type(ngx_http_request_t *r,
1115 ngx_http_variable_value_t *v, uintptr_t data)
1116 {
1117 if (r->headers_out.content_type.len) {
1118 v->len = r->headers_out.content_type.len;
1119 v->valid = 1;
1120 v->no_cacheable = 0;
1121 v->not_found = 0;
1122 v->data = r->headers_out.content_type.data;
1123
1124 } else {
1125 v->not_found = 1;
1126 }
1127
1128 return NGX_OK;
1129 }
1130
1131
1132 static ngx_int_t
1133 ngx_http_variable_sent_content_length(ngx_http_request_t *r,
1134 ngx_http_variable_value_t *v, uintptr_t data)
1135 {
1136 u_char *p;
1137
1138 if (r->headers_out.content_length) {
1139 v->len = r->headers_out.content_length->value.len;
1140 v->valid = 1;
1141 v->no_cacheable = 0;
1142 v->not_found = 0;
1143 v->data = r->headers_out.content_length->value.data;
1144
1145 return NGX_OK;
1146 }
1147
1148 if (r->headers_out.content_length_n >= 0) {
1149 p = ngx_pnalloc(r->pool, NGX_OFF_T_LEN);
1150 if (p == NULL) {
1151 return NGX_ERROR;
1152 }
1153
1154 v->len = ngx_sprintf(p, "%O", r->headers_out.content_length_n) - p;
1155 v->valid = 1;
1156 v->no_cacheable = 0;
1157 v->not_found = 0;
1158 v->data = p;
1159
1160 return NGX_OK;
1161 }
1162
1163 v->not_found = 1;
1164
1165 return NGX_OK;
1166 }
1167
1168
1169 static ngx_int_t
1170 ngx_http_variable_sent_last_modified(ngx_http_request_t *r,
1171 ngx_http_variable_value_t *v, uintptr_t data)
1172 {
1173 u_char *p;
1174
1175 if (r->headers_out.last_modified) {
1176 v->len = r->headers_out.last_modified->value.len;
1177 v->valid = 1;
1178 v->no_cacheable = 0;
1179 v->not_found = 0;
1180 v->data = r->headers_out.last_modified->value.data;
1181
1182 return NGX_OK;
1183 }
1184
1185 if (r->headers_out.last_modified_time >= 0) {
1186 p = ngx_pnalloc(r->pool,
1187 sizeof("Last-Modified: Mon, 28 Sep 1970 06:00:00 GMT") - 1);
1188 if (p == NULL) {
1189 return NGX_ERROR;
1190 }
1191
1192 v->len = ngx_http_time(p, r->headers_out.last_modified_time) - p;
1193 v->valid = 1;
1194 v->no_cacheable = 0;
1195 v->not_found = 0;
1196 v->data = p;
1197
1198 return NGX_OK;
1199 }
1200
1201 v->not_found = 1;
1202
1203 return NGX_OK;
1204 }
1205
1206
1207 static ngx_int_t
1208 ngx_http_variable_sent_connection(ngx_http_request_t *r,
1209 ngx_http_variable_value_t *v, uintptr_t data)
1210 {
1211 size_t len;
1212 char *p;
1213
1214 if (r->keepalive) {
1215 len = sizeof("keep-alive") - 1;
1216 p = "keep-alive";
1217
1218 } else {
1219 len = sizeof("close") - 1;
1220 p = "close";
1221 }
1222
1223 v->len = len;
1224 v->valid = 1;
1225 v->no_cacheable = 0;
1226 v->not_found = 0;
1227 v->data = (u_char *) p;
1228
1229 return NGX_OK;
1230 }
1231
1232
1233 static ngx_int_t
1234 ngx_http_variable_sent_keep_alive(ngx_http_request_t *r,
1235 ngx_http_variable_value_t *v, uintptr_t data)
1236 {
1237 u_char *p;
1238 ngx_http_core_loc_conf_t *clcf;
1239
1240 if (r->keepalive) {
1241 clcf = ngx_http_get_module_loc_conf(r, ngx_http_core_module);
1242
1243 if (clcf->keepalive_header) {
1244
1245 p = ngx_pnalloc(r->pool, sizeof("timeout=") - 1 + NGX_TIME_T_LEN);
1246 if (p == NULL) {
1247 return NGX_ERROR;
1248 }
1249
1250 v->len = ngx_sprintf(p, "timeout=%T", clcf->keepalive_header) - p;
1251 v->valid = 1;
1252 v->no_cacheable = 0;
1253 v->not_found = 0;
1254 v->data = p;
1255
1256 return NGX_OK;
1257 }
1258 }
1259
1260 v->not_found = 1;
1261
1262 return NGX_OK;
1263 }
1264
1265
1266 static ngx_int_t
1267 ngx_http_variable_sent_transfer_encoding(ngx_http_request_t *r,
1268 ngx_http_variable_value_t *v, uintptr_t data)
1269 {
1270 if (r->chunked) {
1271 v->len = sizeof("chunked") - 1;
1272 v->valid = 1;
1273 v->no_cacheable = 0;
1274 v->not_found = 0;
1275 v->data = (u_char *) "chunked";
1276
1277 } else {
1278 v->not_found = 1;
1279 }
1280
1281 return NGX_OK;
1282 }
1283
1284
1285 static ngx_int_t
1286 ngx_http_variable_request_completion(ngx_http_request_t *r,
1287 ngx_http_variable_value_t *v, uintptr_t data)
1288 {
1289 if (r->request_complete) {
1290 v->len = 2;
1291 v->valid = 1;
1292 v->no_cacheable = 0;
1293 v->not_found = 0;
1294 v->data = (u_char *) "OK";
1295
1296 return NGX_OK;
1297 }
1298
1299 v->len = 0;
1300 v->valid = 1;
1301 v->no_cacheable = 0;
1302 v->not_found = 0;
1303 v->data = (u_char *) "";
1304
1305 return NGX_OK;
1306 }
1307
1308
1309 static ngx_int_t
1310 ngx_http_variable_request_body_file(ngx_http_request_t *r,
1311 ngx_http_variable_value_t *v, uintptr_t data)
1312 {
1313 if (r->request_body == NULL || r->request_body->temp_file == NULL) {
1314 v->not_found = 1;
1315
1316 return NGX_OK;
1317 }
1318
1319 v->len = r->request_body->temp_file->file.name.len;
1320 v->valid = 1;
1321 v->no_cacheable = 0;
1322 v->not_found = 0;
1323 v->data = r->request_body->temp_file->file.name.data;
1324
1325 return NGX_OK;
1326 }
1327
1328
1329 static ngx_int_t
1330 ngx_http_variable_nginx_version(ngx_http_request_t *r,
1331 ngx_http_variable_value_t *v, uintptr_t data)
1332 {
1333 v->len = sizeof(NGINX_VERSION) - 1;
1334 v->valid = 1;
1335 v->no_cacheable = 0;
1336 v->not_found = 0;
1337 v->data = (u_char *) NGINX_VERSION;
1338
1339 return NGX_OK;
1340 }
1341
1342
1343 static ngx_int_t
1344 ngx_http_variable_hostname(ngx_http_request_t *r,
1345 ngx_http_variable_value_t *v, uintptr_t data)
1346 {
1347 v->len = ngx_cycle->hostname.len;
1348 v->valid = 1;
1349 v->no_cacheable = 0;
1350 v->not_found = 0;
1351 v->data = ngx_cycle->hostname.data;
1352
1353 return NGX_OK;
1354 }
1355
1356
1357 ngx_int_t
1358 ngx_http_variables_add_core_vars(ngx_conf_t *cf)
1359 {
1360 ngx_int_t rc;
1361 ngx_http_variable_t *v;
1362 ngx_http_core_main_conf_t *cmcf;
1363
1364 cmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_core_module);
1365
1366 cmcf->variables_keys = ngx_pcalloc(cf->temp_pool,
1367 sizeof(ngx_hash_keys_arrays_t));
1368 if (cmcf->variables_keys == NULL) {
1369 return NGX_ERROR;
1370 }
1371
1372 cmcf->variables_keys->pool = cf->pool;
1373 cmcf->variables_keys->temp_pool = cf->pool;
1374
1375 if (ngx_hash_keys_array_init(cmcf->variables_keys, NGX_HASH_SMALL)
1376 != NGX_OK)
1377 {
1378 return NGX_ERROR;
1379 }
1380
1381 for (v = ngx_http_core_variables; v->name.len; v++) {
1382 rc = ngx_hash_add_key(cmcf->variables_keys, &v->name, v,
1383 NGX_HASH_READONLY_KEY);
1384
1385 if (rc == NGX_OK) {
1386 continue;
1387 }
1388
1389 if (rc == NGX_BUSY) {
1390 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
1391 "conflicting variable name \"%V\"", &v->name);
1392 }
1393
1394 return NGX_ERROR;
1395 }
1396
1397 return NGX_OK;
1398 }
1399
1400
1401 ngx_int_t
1402 ngx_http_variables_init_vars(ngx_conf_t *cf)
1403 {
1404 ngx_uint_t i, n;
1405 ngx_hash_key_t *key;
1406 ngx_hash_init_t hash;
1407 ngx_http_variable_t *v, *av;
1408 ngx_http_core_main_conf_t *cmcf;
1409
1410 /* set the handlers for the indexed http variables */
1411
1412 cmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_core_module);
1413
1414 v = cmcf->variables.elts;
1415 key = cmcf->variables_keys->keys.elts;
1416
1417 for (i = 0; i < cmcf->variables.nelts; i++) {
1418
1419 for (n = 0; n < cmcf->variables_keys->keys.nelts; n++) {
1420
1421 av = key[n].value;
1422
1423 if (av->get_handler
1424 && v[i].name.len == key[n].key.len
1425 && ngx_strncmp(v[i].name.data, key[n].key.data, v[i].name.len)
1426 == 0)
1427 {
1428 v[i].get_handler = av->get_handler;
1429 v[i].data = av->data;
1430
1431 av->flags |= NGX_HTTP_VAR_INDEXED;
1432 v[i].flags = av->flags;
1433
1434 av->index = i;
1435
1436 goto next;
1437 }
1438 }
1439
1440 if (ngx_strncmp(v[i].name.data, "http_", 5) == 0) {
1441 v[i].get_handler = ngx_http_variable_unknown_header_in;
1442 v[i].data = (uintptr_t) &v[i].name;
1443
1444 continue;
1445 }
1446
1447 if (ngx_strncmp(v[i].name.data, "sent_http_", 10) == 0) {
1448 v[i].get_handler = ngx_http_variable_unknown_header_out;
1449 v[i].data = (uintptr_t) &v[i].name;
1450
1451 continue;
1452 }
1453
1454 if (ngx_strncmp(v[i].name.data, "upstream_http_", 14) == 0) {
1455 v[i].get_handler = ngx_http_upstream_header_variable;
1456 v[i].data = (uintptr_t) &v[i].name;
1457 v[i].flags = NGX_HTTP_VAR_NOCACHEABLE;
1458
1459 continue;
1460 }
1461
1462 if (ngx_strncmp(v[i].name.data, "arg_", 4) == 0) {
1463 v[i].get_handler = ngx_http_variable_argument;
1464 v[i].data = (uintptr_t) &v[i].name;
1465
1466 continue;
1467 }
1468
1469 ngx_log_error(NGX_LOG_EMERG, cf->log, 0,
1470 "unknown \"%V\" variable", &v[i].name);
1471
1472 return NGX_ERROR;
1473
1474 next:
1475 continue;
1476 }
1477
1478
1479 for (n = 0; n < cmcf->variables_keys->keys.nelts; n++) {
1480 av = key[n].value;
1481
1482 if (av->flags & NGX_HTTP_VAR_NOHASH) {
1483 key[n].key.data = NULL;
1484 }
1485 }
1486
1487
1488 hash.hash = &cmcf->variables_hash;
1489 hash.key = ngx_hash_key;
1490 hash.max_size = cmcf->variables_hash_max_size;
1491 hash.bucket_size = cmcf->variables_hash_bucket_size;
1492 hash.name = "variables_hash";
1493 hash.pool = cf->pool;
1494 hash.temp_pool = NULL;
1495
1496 if (ngx_hash_init(&hash, cmcf->variables_keys->keys.elts,
1497 cmcf->variables_keys->keys.nelts)
1498 != NGX_OK)
1499 {
1500 return NGX_ERROR;
1501 }
1502
1503 cmcf->variables_keys = NULL;
1504
1505 return NGX_OK;
1506 }
catap's nginx repository