annotate ngx_http_delay_body_filter_module.c @ 0:a386f95c5ae9

Initial module skeleton. Mostly based on catch body filter. Does not work yet.
author Maxim Dounin <mdounin@mdounin.ru>
date Tue, 17 Aug 2021 22:51:56 +0300
parents
children 7c2d64d9c656
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
1
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
2 /*
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
3 * Copyright (C) Maxim Dounin
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
4 */
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
5
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
6 #include <ngx_config.h>
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
7 #include <ngx_core.h>
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
8 #include <ngx_http.h>
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
9
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
10
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
11 typedef struct {
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
12 ngx_msec_t delay;
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
13 } ngx_http_delay_body_conf_t;
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
14
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
15
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
16 static void *ngx_http_delay_body_create_conf(ngx_conf_t *cf);
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
17 static char *ngx_http_delay_body_merge_conf(ngx_conf_t *cf, void *parent,
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
18 void *child);
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
19 static ngx_int_t ngx_http_delay_body_init(ngx_conf_t *cf);
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
20
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
21
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
22 static ngx_command_t ngx_http_delay_body_commands[] = {
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
23
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
24 { ngx_string("delay_body"),
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
25 NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_FLAG,
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
26 ngx_conf_set_msec_slot,
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
27 NGX_HTTP_LOC_CONF_OFFSET,
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
28 offsetof(ngx_http_delay_body_conf_t, delay),
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
29 NULL },
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
30
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
31 ngx_null_command
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
32 };
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
33
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
34
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
35 static ngx_http_module_t ngx_http_delay_body_module_ctx = {
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
36 NULL, /* preconfiguration */
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
37 ngx_http_delay_body_init, /* postconfiguration */
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
38
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
39 NULL, /* create main configuration */
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
40 NULL, /* init main configuration */
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
41
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
42 NULL, /* create server configuration */
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
43 NULL, /* merge server configuration */
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
44
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
45 ngx_http_delay_body_create_conf, /* create location configuration */
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
46 ngx_http_delay_body_merge_conf /* merge location configuration */
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
47 };
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
48
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
49
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
50 ngx_module_t ngx_http_delay_body_filter_module = {
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
51 NGX_MODULE_V1,
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
52 &ngx_http_delay_body_module_ctx, /* module context */
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
53 ngx_http_delay_body_commands, /* module directives */
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
54 NGX_HTTP_MODULE, /* module type */
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
55 NULL, /* init master */
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
56 NULL, /* init module */
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
57 NULL, /* init process */
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
58 NULL, /* init thread */
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
59 NULL, /* exit thread */
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
60 NULL, /* exit process */
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
61 NULL, /* exit master */
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
62 NGX_MODULE_V1_PADDING
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
63 };
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
64
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
65
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
66 static ngx_http_request_body_filter_pt ngx_http_next_request_body_filter;
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
67
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
68
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
69 static ngx_int_t
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
70 ngx_http_delay_body_filter(ngx_http_request_t *r, ngx_chain_t *in)
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
71 {
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
72 ngx_chain_t *cl;
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
73 ngx_http_delay_body_conf_t *conf;
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
74
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
75 conf = ngx_http_get_module_loc_conf(r, ngx_http_delay_body_filter_module);
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
76
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
77 if (!conf->delay) {
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
78 return ngx_http_next_request_body_filter(r, in);
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
79 }
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
80
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
81 ngx_log_debug0(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
82 "delay request body filter");
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
83
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
84 /* TODO: delay */
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
85
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
86 for (cl = in; cl; cl = cl->next) {
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
87
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
88 if (cl->buf->last_buf) {
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
89 ngx_log_debug0(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
90 "delay body: last buf");
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
91 }
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
92
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
93 }
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
94
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
95 return ngx_http_next_request_body_filter(r, in);
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
96 }
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
97
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
98
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
99 static void *
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
100 ngx_http_delay_body_create_conf(ngx_conf_t *cf)
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
101 {
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
102 ngx_http_delay_body_conf_t *conf;
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
103
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
104 conf = ngx_pcalloc(cf->pool, sizeof(ngx_http_delay_body_conf_t));
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
105 if (conf == NULL) {
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
106 return NULL;
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
107 }
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
108
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
109 conf->delay = NGX_CONF_UNSET_MSEC;
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
110
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
111 return conf;
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
112 }
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
113
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
114
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
115 static char *
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
116 ngx_http_delay_body_merge_conf(ngx_conf_t *cf, void *parent, void *child)
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
117 {
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
118 ngx_http_delay_body_conf_t *prev = parent;
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
119 ngx_http_delay_body_conf_t *conf = child;
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
120
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
121 ngx_conf_merge_msec_value(conf->delay, prev->delay, 0);
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
122
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
123 return NGX_CONF_OK;
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
124 }
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
125
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
126
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
127 static ngx_int_t
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
128 ngx_http_delay_body_init(ngx_conf_t *cf)
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
129 {
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
130 ngx_http_next_request_body_filter = ngx_http_top_request_body_filter;
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
131 ngx_http_top_request_body_filter = ngx_http_delay_body_filter;
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
132
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
133 return NGX_OK;
a386f95c5ae9 Initial module skeleton.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
134 }