annotate src/http/ngx_http_variables.h @ 616:8214eaef3530 NGINX_0_9_6

nginx 0.9.6 *) Feature: the "map" directive supports regular expressions as value of the first parameter. *) Feature: $time_iso8601 access_log variable. Thanks to Michael Lustfield.
author Igor Sysoev <http://sysoev.ru>
date Mon, 21 Mar 2011 00:00:00 +0300
parents c456a023113c
children 83b58b182b76
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
48
6cfc63e68377 nginx 0.1.24
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
1
6cfc63e68377 nginx 0.1.24
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
2 /*
6cfc63e68377 nginx 0.1.24
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
3 * Copyright (C) Igor Sysoev
6cfc63e68377 nginx 0.1.24
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
4 */
6cfc63e68377 nginx 0.1.24
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
5
6cfc63e68377 nginx 0.1.24
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
6
6cfc63e68377 nginx 0.1.24
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
7 #ifndef _NGX_HTTP_VARIABLES_H_INCLUDED_
6cfc63e68377 nginx 0.1.24
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
8 #define _NGX_HTTP_VARIABLES_H_INCLUDED_
6cfc63e68377 nginx 0.1.24
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
9
6cfc63e68377 nginx 0.1.24
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
10
6cfc63e68377 nginx 0.1.24
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
11 #include <ngx_config.h>
6cfc63e68377 nginx 0.1.24
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
12 #include <ngx_core.h>
6cfc63e68377 nginx 0.1.24
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
13 #include <ngx_http.h>
6cfc63e68377 nginx 0.1.24
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
14
6cfc63e68377 nginx 0.1.24
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
15
320
95183808f549 nginx 0.6.4
Igor Sysoev <http://sysoev.ru>
parents: 296
diff changeset
16 typedef ngx_variable_value_t ngx_http_variable_value_t;
48
6cfc63e68377 nginx 0.1.24
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
17
376
edf1cb6c328e nginx 0.7.0
Igor Sysoev <http://sysoev.ru>
parents: 340
diff changeset
18 #define ngx_http_variable(v) { sizeof(v) - 1, 1, 0, 0, 0, (u_char *) v }
122
d25a1d6034f1 nginx 0.3.8
Igor Sysoev <http://sysoev.ru>
parents: 82
diff changeset
19
48
6cfc63e68377 nginx 0.1.24
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
20 typedef struct ngx_http_variable_s ngx_http_variable_t;
6cfc63e68377 nginx 0.1.24
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
21
186
54aabf2b0bc6 nginx 0.3.40
Igor Sysoev <http://sysoev.ru>
parents: 184
diff changeset
22 typedef void (*ngx_http_set_variable_pt) (ngx_http_request_t *r,
54aabf2b0bc6 nginx 0.3.40
Igor Sysoev <http://sysoev.ru>
parents: 184
diff changeset
23 ngx_http_variable_value_t *v, uintptr_t data);
122
d25a1d6034f1 nginx 0.3.8
Igor Sysoev <http://sysoev.ru>
parents: 82
diff changeset
24 typedef ngx_int_t (*ngx_http_get_variable_pt) (ngx_http_request_t *r,
d25a1d6034f1 nginx 0.3.8
Igor Sysoev <http://sysoev.ru>
parents: 82
diff changeset
25 ngx_http_variable_value_t *v, uintptr_t data);
48
6cfc63e68377 nginx 0.1.24
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
26
6cfc63e68377 nginx 0.1.24
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
27
340
10cc350ed8a1 nginx 0.6.14
Igor Sysoev <http://sysoev.ru>
parents: 320
diff changeset
28 #define NGX_HTTP_VAR_CHANGEABLE 1
10cc350ed8a1 nginx 0.6.14
Igor Sysoev <http://sysoev.ru>
parents: 320
diff changeset
29 #define NGX_HTTP_VAR_NOCACHEABLE 2
10cc350ed8a1 nginx 0.6.14
Igor Sysoev <http://sysoev.ru>
parents: 320
diff changeset
30 #define NGX_HTTP_VAR_INDEXED 4
10cc350ed8a1 nginx 0.6.14
Igor Sysoev <http://sysoev.ru>
parents: 320
diff changeset
31 #define NGX_HTTP_VAR_NOHASH 8
58
b55cbf18157e nginx 0.1.29
Igor Sysoev <http://sysoev.ru>
parents: 50
diff changeset
32
b55cbf18157e nginx 0.1.29
Igor Sysoev <http://sysoev.ru>
parents: 50
diff changeset
33
48
6cfc63e68377 nginx 0.1.24
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
34 struct ngx_http_variable_s {
122
d25a1d6034f1 nginx 0.3.8
Igor Sysoev <http://sysoev.ru>
parents: 82
diff changeset
35 ngx_str_t name; /* must be first to build the hash */
186
54aabf2b0bc6 nginx 0.3.40
Igor Sysoev <http://sysoev.ru>
parents: 184
diff changeset
36 ngx_http_set_variable_pt set_handler;
54aabf2b0bc6 nginx 0.3.40
Igor Sysoev <http://sysoev.ru>
parents: 184
diff changeset
37 ngx_http_get_variable_pt get_handler;
122
d25a1d6034f1 nginx 0.3.8
Igor Sysoev <http://sysoev.ru>
parents: 82
diff changeset
38 uintptr_t data;
d25a1d6034f1 nginx 0.3.8
Igor Sysoev <http://sysoev.ru>
parents: 82
diff changeset
39 ngx_uint_t flags;
d25a1d6034f1 nginx 0.3.8
Igor Sysoev <http://sysoev.ru>
parents: 82
diff changeset
40 ngx_uint_t index;
48
6cfc63e68377 nginx 0.1.24
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
41 };
6cfc63e68377 nginx 0.1.24
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
42
6cfc63e68377 nginx 0.1.24
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
43
50
72eb30262aac nginx 0.1.25
Igor Sysoev <http://sysoev.ru>
parents: 48
diff changeset
44 ngx_http_variable_t *ngx_http_add_variable(ngx_conf_t *cf, ngx_str_t *name,
58
b55cbf18157e nginx 0.1.29
Igor Sysoev <http://sysoev.ru>
parents: 50
diff changeset
45 ngx_uint_t flags);
b55cbf18157e nginx 0.1.29
Igor Sysoev <http://sysoev.ru>
parents: 50
diff changeset
46 ngx_int_t ngx_http_get_variable_index(ngx_conf_t *cf, ngx_str_t *name);
48
6cfc63e68377 nginx 0.1.24
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
47 ngx_http_variable_value_t *ngx_http_get_indexed_variable(ngx_http_request_t *r,
6cfc63e68377 nginx 0.1.24
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
48 ngx_uint_t index);
122
d25a1d6034f1 nginx 0.3.8
Igor Sysoev <http://sysoev.ru>
parents: 82
diff changeset
49 ngx_http_variable_value_t *ngx_http_get_flushed_variable(ngx_http_request_t *r,
d25a1d6034f1 nginx 0.3.8
Igor Sysoev <http://sysoev.ru>
parents: 82
diff changeset
50 ngx_uint_t index);
d25a1d6034f1 nginx 0.3.8
Igor Sysoev <http://sysoev.ru>
parents: 82
diff changeset
51
48
6cfc63e68377 nginx 0.1.24
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
52 ngx_http_variable_value_t *ngx_http_get_variable(ngx_http_request_t *r,
568
566e105a89f1 nginx 0.8.36
Igor Sysoev <http://sysoev.ru>
parents: 552
diff changeset
53 ngx_str_t *name, ngx_uint_t key);
58
b55cbf18157e nginx 0.1.29
Igor Sysoev <http://sysoev.ru>
parents: 50
diff changeset
54
296
2ceaee987f37 nginx 0.5.18
Igor Sysoev <http://sysoev.ru>
parents: 186
diff changeset
55 ngx_int_t ngx_http_variable_unknown_header(ngx_http_variable_value_t *v,
2ceaee987f37 nginx 0.5.18
Igor Sysoev <http://sysoev.ru>
parents: 186
diff changeset
56 ngx_str_t *var, ngx_list_part_t *part, size_t prefix);
2ceaee987f37 nginx 0.5.18
Igor Sysoev <http://sysoev.ru>
parents: 186
diff changeset
57
2ceaee987f37 nginx 0.5.18
Igor Sysoev <http://sysoev.ru>
parents: 186
diff changeset
58
122
d25a1d6034f1 nginx 0.3.8
Igor Sysoev <http://sysoev.ru>
parents: 82
diff changeset
59 #define ngx_http_clear_variable(r, index) r->variables0[index].text.data = NULL;
d25a1d6034f1 nginx 0.3.8
Igor Sysoev <http://sysoev.ru>
parents: 82
diff changeset
60
d25a1d6034f1 nginx 0.3.8
Igor Sysoev <http://sysoev.ru>
parents: 82
diff changeset
61
552
43e02819c5cf nginx 0.8.28
Igor Sysoev <http://sysoev.ru>
parents: 546
diff changeset
62 #if (NGX_PCRE)
43e02819c5cf nginx 0.8.28
Igor Sysoev <http://sysoev.ru>
parents: 546
diff changeset
63
43e02819c5cf nginx 0.8.28
Igor Sysoev <http://sysoev.ru>
parents: 546
diff changeset
64 typedef struct {
43e02819c5cf nginx 0.8.28
Igor Sysoev <http://sysoev.ru>
parents: 546
diff changeset
65 ngx_uint_t capture;
43e02819c5cf nginx 0.8.28
Igor Sysoev <http://sysoev.ru>
parents: 546
diff changeset
66 ngx_int_t index;
43e02819c5cf nginx 0.8.28
Igor Sysoev <http://sysoev.ru>
parents: 546
diff changeset
67 } ngx_http_regex_variable_t;
43e02819c5cf nginx 0.8.28
Igor Sysoev <http://sysoev.ru>
parents: 546
diff changeset
68
43e02819c5cf nginx 0.8.28
Igor Sysoev <http://sysoev.ru>
parents: 546
diff changeset
69
43e02819c5cf nginx 0.8.28
Igor Sysoev <http://sysoev.ru>
parents: 546
diff changeset
70 typedef struct {
43e02819c5cf nginx 0.8.28
Igor Sysoev <http://sysoev.ru>
parents: 546
diff changeset
71 ngx_regex_t *regex;
43e02819c5cf nginx 0.8.28
Igor Sysoev <http://sysoev.ru>
parents: 546
diff changeset
72 ngx_uint_t ncaptures;
43e02819c5cf nginx 0.8.28
Igor Sysoev <http://sysoev.ru>
parents: 546
diff changeset
73 ngx_http_regex_variable_t *variables;
43e02819c5cf nginx 0.8.28
Igor Sysoev <http://sysoev.ru>
parents: 546
diff changeset
74 ngx_uint_t nvariables;
43e02819c5cf nginx 0.8.28
Igor Sysoev <http://sysoev.ru>
parents: 546
diff changeset
75 ngx_str_t name;
43e02819c5cf nginx 0.8.28
Igor Sysoev <http://sysoev.ru>
parents: 546
diff changeset
76 } ngx_http_regex_t;
43e02819c5cf nginx 0.8.28
Igor Sysoev <http://sysoev.ru>
parents: 546
diff changeset
77
43e02819c5cf nginx 0.8.28
Igor Sysoev <http://sysoev.ru>
parents: 546
diff changeset
78
616
8214eaef3530 nginx 0.9.6
Igor Sysoev <http://sysoev.ru>
parents: 582
diff changeset
79 typedef struct {
8214eaef3530 nginx 0.9.6
Igor Sysoev <http://sysoev.ru>
parents: 582
diff changeset
80 ngx_http_regex_t *regex;
8214eaef3530 nginx 0.9.6
Igor Sysoev <http://sysoev.ru>
parents: 582
diff changeset
81 void *value;
8214eaef3530 nginx 0.9.6
Igor Sysoev <http://sysoev.ru>
parents: 582
diff changeset
82 } ngx_http_map_regex_t;
8214eaef3530 nginx 0.9.6
Igor Sysoev <http://sysoev.ru>
parents: 582
diff changeset
83
8214eaef3530 nginx 0.9.6
Igor Sysoev <http://sysoev.ru>
parents: 582
diff changeset
84
546
e19e5f542878 nginx 0.8.25
Igor Sysoev <http://sysoev.ru>
parents: 422
diff changeset
85 ngx_http_regex_t *ngx_http_regex_compile(ngx_conf_t *cf,
e19e5f542878 nginx 0.8.25
Igor Sysoev <http://sysoev.ru>
parents: 422
diff changeset
86 ngx_regex_compile_t *rc);
e19e5f542878 nginx 0.8.25
Igor Sysoev <http://sysoev.ru>
parents: 422
diff changeset
87 ngx_int_t ngx_http_regex_exec(ngx_http_request_t *r, ngx_http_regex_t *re,
e19e5f542878 nginx 0.8.25
Igor Sysoev <http://sysoev.ru>
parents: 422
diff changeset
88 ngx_str_t *s);
e19e5f542878 nginx 0.8.25
Igor Sysoev <http://sysoev.ru>
parents: 422
diff changeset
89
552
43e02819c5cf nginx 0.8.28
Igor Sysoev <http://sysoev.ru>
parents: 546
diff changeset
90 #endif
43e02819c5cf nginx 0.8.28
Igor Sysoev <http://sysoev.ru>
parents: 546
diff changeset
91
546
e19e5f542878 nginx 0.8.25
Igor Sysoev <http://sysoev.ru>
parents: 422
diff changeset
92
616
8214eaef3530 nginx 0.9.6
Igor Sysoev <http://sysoev.ru>
parents: 582
diff changeset
93 typedef struct {
8214eaef3530 nginx 0.9.6
Igor Sysoev <http://sysoev.ru>
parents: 582
diff changeset
94 ngx_hash_combined_t hash;
8214eaef3530 nginx 0.9.6
Igor Sysoev <http://sysoev.ru>
parents: 582
diff changeset
95 #if (NGX_PCRE)
8214eaef3530 nginx 0.9.6
Igor Sysoev <http://sysoev.ru>
parents: 582
diff changeset
96 ngx_http_map_regex_t *regex;
8214eaef3530 nginx 0.9.6
Igor Sysoev <http://sysoev.ru>
parents: 582
diff changeset
97 ngx_uint_t nregex;
8214eaef3530 nginx 0.9.6
Igor Sysoev <http://sysoev.ru>
parents: 582
diff changeset
98 #endif
8214eaef3530 nginx 0.9.6
Igor Sysoev <http://sysoev.ru>
parents: 582
diff changeset
99 } ngx_http_map_t;
8214eaef3530 nginx 0.9.6
Igor Sysoev <http://sysoev.ru>
parents: 582
diff changeset
100
8214eaef3530 nginx 0.9.6
Igor Sysoev <http://sysoev.ru>
parents: 582
diff changeset
101
8214eaef3530 nginx 0.9.6
Igor Sysoev <http://sysoev.ru>
parents: 582
diff changeset
102 void *ngx_http_map_find(ngx_http_request_t *r, ngx_http_map_t *map,
8214eaef3530 nginx 0.9.6
Igor Sysoev <http://sysoev.ru>
parents: 582
diff changeset
103 ngx_uint_t key, u_char *text, size_t len, ngx_str_t *match);
8214eaef3530 nginx 0.9.6
Igor Sysoev <http://sysoev.ru>
parents: 582
diff changeset
104
8214eaef3530 nginx 0.9.6
Igor Sysoev <http://sysoev.ru>
parents: 582
diff changeset
105
58
b55cbf18157e nginx 0.1.29
Igor Sysoev <http://sysoev.ru>
parents: 50
diff changeset
106 ngx_int_t ngx_http_variables_add_core_vars(ngx_conf_t *cf);
b55cbf18157e nginx 0.1.29
Igor Sysoev <http://sysoev.ru>
parents: 50
diff changeset
107 ngx_int_t ngx_http_variables_init_vars(ngx_conf_t *cf);
48
6cfc63e68377 nginx 0.1.24
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
108
6cfc63e68377 nginx 0.1.24
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
109
126
df17fbafec8f nginx 0.3.10
Igor Sysoev <http://sysoev.ru>
parents: 122
diff changeset
110 extern ngx_http_variable_value_t ngx_http_variable_null_value;
df17fbafec8f nginx 0.3.10
Igor Sysoev <http://sysoev.ru>
parents: 122
diff changeset
111 extern ngx_http_variable_value_t ngx_http_variable_true_value;
df17fbafec8f nginx 0.3.10
Igor Sysoev <http://sysoev.ru>
parents: 122
diff changeset
112
df17fbafec8f nginx 0.3.10
Igor Sysoev <http://sysoev.ru>
parents: 122
diff changeset
113
48
6cfc63e68377 nginx 0.1.24
Igor Sysoev <http://sysoev.ru>
parents:
diff changeset
114 #endif /* _NGX_HTTP_VARIABLES_H_INCLUDED_ */