One Level Up Top Level

src/http/ngx_http_script.h - nginx-1.31.4 nginx/ @ 8d9666701

Data types defined

Macros defined

Source code


  2. /*
  3. * Copyright (C) Igor Sysoev
  4. * Copyright (C) Nginx, Inc.
  5. */


  8. #ifndef _NGX_HTTP_SCRIPT_H_INCLUDED_
  9. ‌#define _NGX_HTTP_SCRIPT_H_INCLUDED_


  12. #include <ngx_config.h>
  13. #include <ngx_core.h>
  14. #include <ngx_http.h>


  17. ‌typedef struct {
  18.     u_char                     *ip;
  19.     u_char                     *pos;
  20.     u_char                     *end;
  21.     ngx_http_variable_value_t  *sp;

  23.     ngx_str_t                   buf;
  24.     ngx_str_t                   line;

  26.     /* the start of the rewritten arguments */
  27.     u_char                     *args;

  29.     unsigned                    flushed:1;
  30.     unsigned                    skip:1;
  31.     unsigned                    quote:1;
  32.     unsigned                    is_args:1;
  33.     unsigned                    log:1;

  35.     ngx_int_t                   status;
  36.     ngx_http_request_t         *request;
  37. ‌} ngx_http_script_engine_t;


  40. ‌typedef struct {
  41.     ngx_conf_t                 *cf;
  42.     ngx_str_t                  *source;

  44.     ngx_array_t               **flushes;
  45.     ngx_array_t               **lengths;
  46.     ngx_array_t               **values;

  48.     ngx_uint_t                  variables;
  49.     ngx_uint_t                  ncaptures;
  50.     ngx_uint_t                  captures_mask;
  51.     ngx_uint_t                  size;

  53.     void                       *main;

  55.     unsigned                    compile_args:1;
  56.     unsigned                    complete_lengths:1;
  57.     unsigned                    complete_values:1;
  58.     unsigned                    zero:1;
  59.     unsigned                    conf_prefix:1;
  60.     unsigned                    root_prefix:1;

  62.     unsigned                    dup_capture:1;
  63.     unsigned                    args:1;
  64. ‌} ngx_http_script_compile_t;


  67. ‌typedef struct {
  68.     ngx_str_t                   value;
  69.     ngx_uint_t                 *flushes;
  70.     void                       *lengths;
  71.     void                       *values;

  73. ‌    union {
  74.         size_t                  size;
  75.     } u;
  76. ‌} ngx_http_complex_value_t;


  79. ‌typedef struct {
  80.     ngx_conf_t                 *cf;
  81.     ngx_str_t                  *value;
  82.     ngx_http_complex_value_t   *complex_value;

  84.     unsigned                    zero:1;
  85.     unsigned                    conf_prefix:1;
  86.     unsigned                    root_prefix:1;
  87. ‌} ngx_http_compile_complex_value_t;


  90. ‌typedef void (*ngx_http_script_code_pt) (ngx_http_script_engine_t *e);
  91. ‌typedef size_t (*ngx_http_script_len_code_pt) (ngx_http_script_engine_t *e);


  94. ‌typedef struct {
  95.     ngx_http_script_code_pt     code;
  96.     uintptr_t                   len;
  97. ‌} ngx_http_script_copy_code_t;


  100. ‌typedef struct {
  101.     ngx_http_script_code_pt     code;
  102.     uintptr_t                   index;
  103. ‌} ngx_http_script_var_code_t;


  106. ‌typedef struct {
  107.     ngx_http_script_code_pt     code;
  108.     ngx_http_set_variable_pt    handler;
  109.     uintptr_t                   data;
  110. ‌} ngx_http_script_var_handler_code_t;


  113. ‌typedef struct {
  114.     ngx_http_script_code_pt     code;
  115.     uintptr_t                   n;
  116. ‌} ngx_http_script_copy_capture_code_t;


  119. #if (NGX_PCRE)

  121. ‌typedef struct {
  122.     ngx_http_script_code_pt     code;
  123.     ngx_http_regex_t           *regex;
  124.     ngx_array_t                *lengths;
  125.     uintptr_t                   size;
  126.     uintptr_t                   status;
  127.     uintptr_t                   next;

  129.     unsigned                    test:1;
  130.     unsigned                    negative_test:1;
  131.     unsigned                    uri:1;
  132.     unsigned                    args:1;

  134.     /* add the r->args to the new arguments */
  135.     unsigned                    add_args:1;

  137.     unsigned                    redirect:1;
  138.     unsigned                    break_cycle:1;

  140.     ngx_str_t                   name;
  141. ‌} ngx_http_script_regex_code_t;


  144. ‌typedef struct {
  145.     ngx_http_script_code_pt     code;

  147.     unsigned                    uri:1;
  148.     unsigned                    args:1;

  150.     /* add the r->args to the new arguments */
  151.     unsigned                    add_args:1;

  153.     unsigned                    redirect:1;
  154. ‌} ngx_http_script_regex_end_code_t;

  156. #endif


  159. ‌typedef struct {
  160.     ngx_http_script_code_pt     code;
  161.     uintptr_t                   conf_prefix;
  162. ‌} ngx_http_script_full_name_code_t;


  165. ‌typedef struct {
  166.     ngx_http_script_code_pt     code;
  167.     uintptr_t                   status;
  168.     ngx_http_complex_value_t    text;
  169. ‌} ngx_http_script_return_code_t;


  172. ‌typedef enum {
  173.     ngx_http_script_file_plain = 0,
  174.     ngx_http_script_file_not_plain,
  175.     ngx_http_script_file_dir,
  176.     ngx_http_script_file_not_dir,
  177.     ngx_http_script_file_exists,
  178.     ngx_http_script_file_not_exists,
  179.     ngx_http_script_file_exec,
  180.     ngx_http_script_file_not_exec
  181. ‌} ngx_http_script_file_op_e;


  184. ‌typedef struct {
  185.     ngx_http_script_code_pt     code;
  186.     uintptr_t                   op;
  187. ‌} ngx_http_script_file_code_t;


  190. ‌typedef struct {
  191.     ngx_http_script_code_pt     code;
  192.     uintptr_t                   next;
  193.     void                      **loc_conf;
  194. ‌} ngx_http_script_if_code_t;


  197. ‌typedef struct {
  198.     ngx_http_script_code_pt     code;
  199.     ngx_array_t                *lengths;
  200. ‌} ngx_http_script_complex_value_code_t;


  203. ‌typedef struct {
  204.     ngx_http_script_code_pt     code;
  205. ‌} ngx_http_script_complex_value_end_code_t;


  208. ‌typedef struct {
  209.     ngx_http_script_code_pt     code;
  210.     uintptr_t                   value;
  211.     uintptr_t                   text_len;
  212.     uintptr_t                   text_data;
  213. ‌} ngx_http_script_value_code_t;


  216. void ngx_http_script_flush_complex_value(ngx_http_request_t *r,
  217.     ngx_http_complex_value_t *val);
  218. ngx_int_t ngx_http_complex_value(ngx_http_request_t *r,
  219.     ngx_http_complex_value_t *val, ngx_str_t *value);
  220. size_t ngx_http_complex_value_size(ngx_http_request_t *r,
  221.     ngx_http_complex_value_t *val, size_t default_value);
  222. ngx_int_t ngx_http_compile_complex_value(ngx_http_compile_complex_value_t *ccv);
  223. char *ngx_http_set_complex_value_slot(ngx_conf_t *cf, ngx_command_t *cmd,
  224.     void *conf);
  225. char *ngx_http_set_complex_value_zero_slot(ngx_conf_t *cf, ngx_command_t *cmd,
  226.     void *conf);
  227. char *ngx_http_set_complex_value_size_slot(ngx_conf_t *cf, ngx_command_t *cmd,
  228.     void *conf);


  231. ngx_int_t ngx_http_test_predicates(ngx_http_request_t *r,
  232.     ngx_array_t *predicates);
  233. ngx_int_t ngx_http_test_required_predicates(ngx_http_request_t *r,
  234.     ngx_array_t *predicates);
  235. char *ngx_http_set_predicate_slot(ngx_conf_t *cf, ngx_command_t *cmd,
  236.     void *conf);

  238. ngx_uint_t ngx_http_script_variables_count(ngx_str_t *value);
  239. ngx_int_t ngx_http_script_compile(ngx_http_script_compile_t *sc);
  240. u_char *ngx_http_script_run(ngx_http_request_t *r, ngx_str_t *value,
  241.     void *code_lengths, size_t reserved, void *code_values);
  242. void ngx_http_script_flush_no_cacheable_variables(ngx_http_request_t *r,
  243.     ngx_array_t *indices);

  245. void *ngx_http_script_start_code(ngx_pool_t *pool, ngx_array_t **codes,
  246.     size_t size);
  247. void *ngx_http_script_add_code(ngx_array_t *codes, size_t size, void *code);

  249. ngx_int_t ngx_http_script_check_length(ngx_http_script_engine_t *e,
  250.     size_t len);

  252. size_t ngx_http_script_copy_len_code(ngx_http_script_engine_t *e);
  253. void ngx_http_script_copy_code(ngx_http_script_engine_t *e);
  254. size_t ngx_http_script_copy_var_len_code(ngx_http_script_engine_t *e);
  255. void ngx_http_script_copy_var_code(ngx_http_script_engine_t *e);
  256. size_t ngx_http_script_copy_capture_len_code(ngx_http_script_engine_t *e);
  257. void ngx_http_script_copy_capture_code(ngx_http_script_engine_t *e);
  258. size_t ngx_http_script_mark_args_code(ngx_http_script_engine_t *e);
  259. void ngx_http_script_start_args_code(ngx_http_script_engine_t *e);
  260. #if (NGX_PCRE)
  261. void ngx_http_script_regex_start_code(ngx_http_script_engine_t *e);
  262. void ngx_http_script_regex_end_code(ngx_http_script_engine_t *e);
  263. #endif
  264. void ngx_http_script_return_code(ngx_http_script_engine_t *e);
  265. void ngx_http_script_break_code(ngx_http_script_engine_t *e);
  266. void ngx_http_script_if_code(ngx_http_script_engine_t *e);
  267. void ngx_http_script_equal_code(ngx_http_script_engine_t *e);
  268. void ngx_http_script_not_equal_code(ngx_http_script_engine_t *e);
  269. void ngx_http_script_file_code(ngx_http_script_engine_t *e);
  270. void ngx_http_script_complex_value_code(ngx_http_script_engine_t *e);
  271. void ngx_http_script_complex_value_end_code(ngx_http_script_engine_t *e);
  272. void ngx_http_script_value_code(ngx_http_script_engine_t *e);
  273. void ngx_http_script_set_var_code(ngx_http_script_engine_t *e);
  274. void ngx_http_script_var_set_handler_code(ngx_http_script_engine_t *e);
  275. void ngx_http_script_var_code(ngx_http_script_engine_t *e);
  276. void ngx_http_script_nop_code(ngx_http_script_engine_t *e);


  279. #endif /* _NGX_HTTP_SCRIPT_H_INCLUDED_ */

One Level Up Top Level