1e18a033bSKonstantin Ananyev
2e18a033bSKonstantin Ananyev/*
3e18a033bSKonstantin Ananyev * Copyright (C) Igor Sysoev
4e18a033bSKonstantin Ananyev * Copyright (C) Nginx, Inc.
5e18a033bSKonstantin Ananyev */
6e18a033bSKonstantin Ananyev
7e18a033bSKonstantin Ananyev
8e18a033bSKonstantin Ananyev#ifndef _NGX_HTTP_VARIABLES_H_INCLUDED_
9e18a033bSKonstantin Ananyev#define _NGX_HTTP_VARIABLES_H_INCLUDED_
10e18a033bSKonstantin Ananyev
11e18a033bSKonstantin Ananyev
12e18a033bSKonstantin Ananyev#include <ngx_config.h>
13e18a033bSKonstantin Ananyev#include <ngx_core.h>
14e18a033bSKonstantin Ananyev#include <ngx_http.h>
15e18a033bSKonstantin Ananyev
16e18a033bSKonstantin Ananyev
17e18a033bSKonstantin Ananyevtypedef ngx_variable_value_t  ngx_http_variable_value_t;
18e18a033bSKonstantin Ananyev
19e18a033bSKonstantin Ananyev#define ngx_http_variable(v)     { sizeof(v) - 1, 1, 0, 0, 0, (u_char *) v }
20e18a033bSKonstantin Ananyev
21e18a033bSKonstantin Ananyevtypedef struct ngx_http_variable_s  ngx_http_variable_t;
22e18a033bSKonstantin Ananyev
23e18a033bSKonstantin Ananyevtypedef void (*ngx_http_set_variable_pt) (ngx_http_request_t *r,
24e18a033bSKonstantin Ananyev    ngx_http_variable_value_t *v, uintptr_t data);
25e18a033bSKonstantin Ananyevtypedef ngx_int_t (*ngx_http_get_variable_pt) (ngx_http_request_t *r,
26e18a033bSKonstantin Ananyev    ngx_http_variable_value_t *v, uintptr_t data);
27e18a033bSKonstantin Ananyev
28e18a033bSKonstantin Ananyev
29e18a033bSKonstantin Ananyev#define NGX_HTTP_VAR_CHANGEABLE   1
30e18a033bSKonstantin Ananyev#define NGX_HTTP_VAR_NOCACHEABLE  2
31e18a033bSKonstantin Ananyev#define NGX_HTTP_VAR_INDEXED      4
32e18a033bSKonstantin Ananyev#define NGX_HTTP_VAR_NOHASH       8
33e18a033bSKonstantin Ananyev#define NGX_HTTP_VAR_WEAK         16
34e18a033bSKonstantin Ananyev#define NGX_HTTP_VAR_PREFIX       32
35e18a033bSKonstantin Ananyev
36e18a033bSKonstantin Ananyev
37e18a033bSKonstantin Ananyevstruct ngx_http_variable_s {
38e18a033bSKonstantin Ananyev    ngx_str_t                     name;   /* must be first to build the hash */
39e18a033bSKonstantin Ananyev    ngx_http_set_variable_pt      set_handler;
40e18a033bSKonstantin Ananyev    ngx_http_get_variable_pt      get_handler;
41e18a033bSKonstantin Ananyev    uintptr_t                     data;
42e18a033bSKonstantin Ananyev    ngx_uint_t                    flags;
43e18a033bSKonstantin Ananyev    ngx_uint_t                    index;
44e18a033bSKonstantin Ananyev};
45e18a033bSKonstantin Ananyev
46e18a033bSKonstantin Ananyev
47e18a033bSKonstantin Ananyevngx_http_variable_t *ngx_http_add_variable(ngx_conf_t *cf, ngx_str_t *name,
48e18a033bSKonstantin Ananyev    ngx_uint_t flags);
49e18a033bSKonstantin Ananyevngx_int_t ngx_http_get_variable_index(ngx_conf_t *cf, ngx_str_t *name);
50e18a033bSKonstantin Ananyevngx_http_variable_value_t *ngx_http_get_indexed_variable(ngx_http_request_t *r,
51e18a033bSKonstantin Ananyev    ngx_uint_t index);
52e18a033bSKonstantin Ananyevngx_http_variable_value_t *ngx_http_get_flushed_variable(ngx_http_request_t *r,
53e18a033bSKonstantin Ananyev    ngx_uint_t index);
54e18a033bSKonstantin Ananyev
55e18a033bSKonstantin Ananyevngx_http_variable_value_t *ngx_http_get_variable(ngx_http_request_t *r,
56e18a033bSKonstantin Ananyev    ngx_str_t *name, ngx_uint_t key);
57e18a033bSKonstantin Ananyev
58e18a033bSKonstantin Ananyevngx_int_t ngx_http_variable_unknown_header(ngx_http_variable_value_t *v,
59e18a033bSKonstantin Ananyev    ngx_str_t *var, ngx_list_part_t *part, size_t prefix);
60e18a033bSKonstantin Ananyev
61e18a033bSKonstantin Ananyev
62e18a033bSKonstantin Ananyev#if (NGX_PCRE)
63e18a033bSKonstantin Ananyev
64e18a033bSKonstantin Ananyevtypedef struct {
65e18a033bSKonstantin Ananyev    ngx_uint_t                    capture;
66e18a033bSKonstantin Ananyev    ngx_int_t                     index;
67e18a033bSKonstantin Ananyev} ngx_http_regex_variable_t;
68e18a033bSKonstantin Ananyev
69e18a033bSKonstantin Ananyev
70e18a033bSKonstantin Ananyevtypedef struct {
71e18a033bSKonstantin Ananyev    ngx_regex_t                  *regex;
72e18a033bSKonstantin Ananyev    ngx_uint_t                    ncaptures;
73e18a033bSKonstantin Ananyev    ngx_http_regex_variable_t    *variables;
74e18a033bSKonstantin Ananyev    ngx_uint_t                    nvariables;
75e18a033bSKonstantin Ananyev    ngx_str_t                     name;
76e18a033bSKonstantin Ananyev} ngx_http_regex_t;
77e18a033bSKonstantin Ananyev
78e18a033bSKonstantin Ananyev
79e18a033bSKonstantin Ananyevtypedef struct {
80e18a033bSKonstantin Ananyev    ngx_http_regex_t             *regex;
81e18a033bSKonstantin Ananyev    void                         *value;
82e18a033bSKonstantin Ananyev} ngx_http_map_regex_t;
83e18a033bSKonstantin Ananyev
84e18a033bSKonstantin Ananyev
85e18a033bSKonstantin Ananyevngx_http_regex_t *ngx_http_regex_compile(ngx_conf_t *cf,
86e18a033bSKonstantin Ananyev    ngx_regex_compile_t *rc);
87e18a033bSKonstantin Ananyevngx_int_t ngx_http_regex_exec(ngx_http_request_t *r, ngx_http_regex_t *re,
88e18a033bSKonstantin Ananyev    ngx_str_t *s);
89e18a033bSKonstantin Ananyev
90e18a033bSKonstantin Ananyev#endif
91e18a033bSKonstantin Ananyev
92e18a033bSKonstantin Ananyev
93e18a033bSKonstantin Ananyevtypedef struct {
94e18a033bSKonstantin Ananyev    ngx_hash_combined_t           hash;
95e18a033bSKonstantin Ananyev#if (NGX_PCRE)
96e18a033bSKonstantin Ananyev    ngx_http_map_regex_t         *regex;
97e18a033bSKonstantin Ananyev    ngx_uint_t                    nregex;
98e18a033bSKonstantin Ananyev#endif
99e18a033bSKonstantin Ananyev} ngx_http_map_t;
100e18a033bSKonstantin Ananyev
101e18a033bSKonstantin Ananyev
102e18a033bSKonstantin Ananyevvoid *ngx_http_map_find(ngx_http_request_t *r, ngx_http_map_t *map,
103e18a033bSKonstantin Ananyev    ngx_str_t *match);
104e18a033bSKonstantin Ananyev
105e18a033bSKonstantin Ananyev
106e18a033bSKonstantin Ananyevngx_int_t ngx_http_variables_add_core_vars(ngx_conf_t *cf);
107e18a033bSKonstantin Ananyevngx_int_t ngx_http_variables_init_vars(ngx_conf_t *cf);
108e18a033bSKonstantin Ananyev
109e18a033bSKonstantin Ananyev
110e18a033bSKonstantin Ananyevextern ngx_http_variable_value_t  ngx_http_variable_null_value;
111e18a033bSKonstantin Ananyevextern ngx_http_variable_value_t  ngx_http_variable_true_value;
112e18a033bSKonstantin Ananyev
113e18a033bSKonstantin Ananyev
114e18a033bSKonstantin Ananyev#endif /* _NGX_HTTP_VARIABLES_H_INCLUDED_ */
115