export uh_request_done to plugins
[project/uhttpd.git] / proc.c
1 /*
2  * uhttpd - Tiny single-threaded httpd
3  *
4  *   Copyright (C) 2010-2012 Jo-Philipp Wich <xm@subsignal.org>
5  *   Copyright (C) 2012 Felix Fietkau <nbd@openwrt.org>
6  *
7  *  Licensed under the Apache License, Version 2.0 (the "License");
8  *  you may not use this file except in compliance with the License.
9  *  You may obtain a copy of the License at
10  *
11  *      http://www.apache.org/licenses/LICENSE-2.0
12  *
13  *  Unless required by applicable law or agreed to in writing, software
14  *  distributed under the License is distributed on an "AS IS" BASIS,
15  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  *  See the License for the specific language governing permissions and
17  *  limitations under the License.
18  */
19
20 #include <arpa/inet.h>
21 #include <libubox/blobmsg.h>
22 #include "uhttpd.h"
23
24 #define __headers \
25         __header(accept) \
26         __header(accept_charset) \
27         __header(accept_encoding) \
28         __header(accept_language) \
29         __header(authorization) \
30         __header(connection) \
31         __header(cookie) \
32         __header(host) \
33         __header(referer) \
34         __header(user_agent) \
35         __header(content_type) \
36         __header(content_length)
37
38 #undef __header
39 #define __header __enum_header
40 enum client_hdr {
41         __headers
42         __HDR_MAX,
43 };
44
45 #undef __header
46 #define __header __blobmsg_header
47 static const struct blobmsg_policy hdr_policy[__HDR_MAX] = {
48         __headers
49 };
50
51 static const struct {
52         const char *name;
53         int idx;
54 } proc_header_env[] = {
55         { "HTTP_ACCEPT", HDR_accept },
56         { "HTTP_ACCEPT_CHARSET", HDR_accept_charset },
57         { "HTTP_ACCEPT_ENCODING", HDR_accept_encoding },
58         { "HTTP_ACCEPT_LANGUAGE", HDR_accept_language },
59         { "HTTP_AUTHORIZATION", HDR_authorization },
60         { "HTTP_CONNECTION", HDR_connection },
61         { "HTTP_COOKIE", HDR_cookie },
62         { "HTTP_HOST", HDR_host },
63         { "HTTP_REFERER", HDR_referer },
64         { "HTTP_USER_AGENT", HDR_user_agent },
65         { "CONTENT_TYPE", HDR_content_type },
66         { "CONTENT_LENGTH", HDR_content_length },
67 };
68
69 enum extra_vars {
70         /* no update needed */
71         _VAR_GW,
72         _VAR_SOFTWARE,
73
74         /* updated by uh_get_process_vars */
75         VAR_SCRIPT_NAME,
76         VAR_SCRIPT_FILE,
77         VAR_DOCROOT,
78         VAR_QUERY,
79         VAR_REQUEST,
80         VAR_PROTO,
81         VAR_METHOD,
82         VAR_PATH_INFO,
83         VAR_USER,
84         VAR_REDIRECT,
85         VAR_SERVER_NAME,
86         VAR_SERVER_ADDR,
87         VAR_SERVER_PORT,
88         VAR_REMOTE_NAME,
89         VAR_REMOTE_ADDR,
90         VAR_REMOTE_PORT,
91
92         __VAR_MAX,
93 };
94
95 static char local_addr[INET6_ADDRSTRLEN], remote_addr[INET6_ADDRSTRLEN];
96 static char local_port[6], remote_port[6];
97 static char redirect_status[4];
98
99 static struct env_var extra_vars[] = {
100         [_VAR_GW] = { "GATEWAY_INTERFACE", "CGI/1.1" },
101         [_VAR_SOFTWARE] = { "SERVER_SOFTWARE", "uhttpd" },
102         [VAR_SCRIPT_NAME] = { "SCRIPT_NAME" },
103         [VAR_SCRIPT_FILE] = { "SCRIPT_FILENAME" },
104         [VAR_DOCROOT] = { "DOCUMENT_ROOT" },
105         [VAR_QUERY] = { "QUERY_STRING" },
106         [VAR_REQUEST] = { "REQUEST_URI" },
107         [VAR_PROTO] = { "SERVER_PROTOCOL" },
108         [VAR_METHOD] = { "REQUEST_METHOD" },
109         [VAR_PATH_INFO] = { "PATH_INFO" },
110         [VAR_USER] = { "REMOTE_USER" },
111         [VAR_REDIRECT] = { "REDIRECT_STATUS", redirect_status },
112         [VAR_SERVER_NAME] = { "SERVER_NAME", local_addr },
113         [VAR_SERVER_ADDR] = { "SERVER_ADDR", local_addr },
114         [VAR_SERVER_PORT] = { "SERVER_PORT", local_port },
115         [VAR_REMOTE_NAME] = { "REMOTE_HOST", remote_addr },
116         [VAR_REMOTE_ADDR] = { "REMOTE_ADDR", remote_addr },
117         [VAR_REMOTE_PORT] = { "REMOTE_PORT", remote_port },
118 };
119
120 struct env_var *uh_get_process_vars(struct client *cl, struct path_info *pi)
121 {
122         struct http_request *req = &cl->request;
123         struct blob_attr *data = cl->hdr.head;
124         struct env_var *vars = (void *) uh_buf;
125         struct blob_attr *tb[__HDR_MAX];
126         const char *url;
127         int len;
128         int i;
129
130         url = blobmsg_data(blob_data(cl->hdr.head));
131         len = ARRAY_SIZE(proc_header_env);
132         len += ARRAY_SIZE(extra_vars);
133         len *= sizeof(struct env_var);
134
135         BUILD_BUG_ON(sizeof(uh_buf) < len);
136
137         extra_vars[VAR_SCRIPT_NAME].value = pi->name;
138         extra_vars[VAR_SCRIPT_FILE].value = pi->phys;
139         extra_vars[VAR_DOCROOT].value = pi->root;
140         extra_vars[VAR_QUERY].value = pi->query ? pi->query : "";
141         extra_vars[VAR_REQUEST].value = url;
142         extra_vars[VAR_PROTO].value = http_versions[req->version];
143         extra_vars[VAR_METHOD].value = http_methods[req->method];
144         extra_vars[VAR_PATH_INFO].value = pi->info;
145         extra_vars[VAR_USER].value = req->realm ? req->realm->user : NULL;
146
147         snprintf(redirect_status, sizeof(redirect_status),
148                  "%d", req->redirect_status);
149         inet_ntop(cl->srv_addr.family, &cl->srv_addr.in, local_addr, sizeof(local_addr));
150         inet_ntop(cl->peer_addr.family, &cl->peer_addr.in, remote_addr, sizeof(remote_addr));
151
152         blobmsg_parse(hdr_policy, __HDR_MAX, tb, blob_data(data), blob_len(data));
153         for (i = 0; i < ARRAY_SIZE(proc_header_env); i++) {
154                 struct blob_attr *cur;
155
156                 cur = tb[proc_header_env[i].idx];
157                 vars[i].name = proc_header_env[i].name;
158                 vars[i].value = cur ? blobmsg_data(cur) : "";
159         }
160
161         memcpy(&vars[i], extra_vars, sizeof(extra_vars));
162         i += ARRAY_SIZE(extra_vars);
163         vars[i].name = NULL;
164         vars[i].value = NULL;
165
166         return vars;
167 }
168
169 static void proc_close_fds(struct client *cl)
170 {
171         struct dispatch_proc *p = &cl->dispatch.proc;
172
173         close(p->r.sfd.fd.fd);
174         if (p->wrfd.fd >= 0)
175                 close(p->wrfd.fd);
176 }
177
178 static void proc_handle_close(struct relay *r, int ret)
179 {
180         if (r->header_cb) {
181                 uh_client_error(r->cl, 502, "Bad Gateway",
182                                 "The process did not produce any response");
183                 return;
184         }
185
186         uh_request_done(r->cl);
187 }
188
189 static void proc_handle_header(struct relay *r, const char *name, const char *val)
190 {
191         static char status_buf[64];
192         struct client *cl = r->cl;
193         char *sep;
194         char buf[4];
195
196         if (!strcmp(name, "Status")) {
197                 sep = strchr(val, ' ');
198                 if (sep != val + 3)
199                         return;
200
201                 memcpy(buf, val, 3);
202                 buf[3] = 0;
203                 snprintf(status_buf, sizeof(status_buf), "%s", sep + 1);
204                 cl->dispatch.proc.status_msg = status_buf;
205                 cl->dispatch.proc.status_code = atoi(buf);
206                 return;
207         }
208
209         blobmsg_add_string(&cl->dispatch.proc.hdr, name, val);
210 }
211
212 static void proc_handle_header_end(struct relay *r)
213 {
214         struct client *cl = r->cl;
215         struct blob_attr *cur;
216         int rem;
217
218         uh_http_header(cl, cl->dispatch.proc.status_code, cl->dispatch.proc.status_msg);
219         blob_for_each_attr(cur, cl->dispatch.proc.hdr.head, rem)
220                 ustream_printf(cl->us, "%s: %s\r\n", blobmsg_name(cur), blobmsg_data(cur));
221
222         ustream_printf(cl->us, "\r\n");
223 }
224
225 static void proc_write_close(struct client *cl)
226 {
227         struct dispatch_proc *p = &cl->dispatch.proc;
228
229         if (p->wrfd.fd < 0)
230                 return;
231
232         uloop_fd_delete(&p->wrfd);
233         close(p->wrfd.fd);
234         p->wrfd.fd = -1;
235 }
236
237 static void proc_free(struct client *cl)
238 {
239         struct dispatch_proc *p = &cl->dispatch.proc;
240         blob_buf_free(&p->hdr);
241         proc_write_close(cl);
242         uh_relay_free(&p->r);
243 }
244
245 static void proc_write_cb(struct uloop_fd *fd, unsigned int events)
246 {
247         struct client *cl = container_of(fd, struct client, dispatch.proc.wrfd);
248
249         client_poll_post_data(cl);
250 }
251
252 static void proc_relay_write_cb(struct client *cl)
253 {
254         struct dispatch_proc *p = &cl->dispatch.proc;
255
256         if (ustream_pending_data(cl->us, true))
257                 return;
258
259         ustream_set_read_blocked(&p->r.sfd.stream, false);
260 }
261
262 static int proc_data_send(struct client *cl, const char *data, int len)
263 {
264         struct dispatch_proc *p = &cl->dispatch.proc;
265         int retlen = 0;
266         int ret;
267
268         while (len) {
269                 ret = write(p->wrfd.fd, data, len);
270
271                 if (ret < 0) {
272                         if (errno == EINTR)
273                                 continue;
274
275                         if (errno == EAGAIN || errno == EWOULDBLOCK)
276                                 break;
277
278                         /* error, no retry */
279                         len = 0;
280                         break;
281                 }
282
283                 if (!ret)
284                         break;
285
286                 retlen += ret;
287                 len -= ret;
288                 data += ret;
289         }
290
291         if (len)
292                 uloop_fd_add(&p->wrfd, ULOOP_WRITE);
293         else
294                 uloop_fd_delete(&p->wrfd);
295
296         return retlen;
297 }
298
299 bool uh_create_process(struct client *cl, struct path_info *pi, char *url,
300                        void (*cb)(struct client *cl, struct path_info *pi, char *url))
301 {
302         struct dispatch *d = &cl->dispatch;
303         struct dispatch_proc *proc = &d->proc;
304         int rfd[2], wfd[2];
305         int pid;
306
307         blob_buf_init(&proc->hdr, 0);
308         proc->status_code = 200;
309         proc->status_msg = "OK";
310
311         if (pipe(rfd))
312                 return false;
313
314         if (pipe(wfd))
315                 goto close_rfd;
316
317         pid = fork();
318         if (pid < 0)
319                 goto close_wfd;
320
321         if (!pid) {
322                 close(0);
323                 close(1);
324
325                 dup2(rfd[1], 1);
326                 dup2(wfd[0], 0);
327
328                 close(rfd[0]);
329                 close(rfd[1]);
330                 close(wfd[0]);
331                 close(wfd[1]);
332
333                 uh_close_fds();
334                 cb(cl, pi, url);
335                 exit(0);
336         }
337
338         close(rfd[1]);
339         close(wfd[0]);
340
341         proc->wrfd.fd = wfd[1];
342         uh_relay_open(cl, &proc->r, rfd[0], pid);
343
344         d->free = proc_free;
345         d->close_fds = proc_close_fds;
346         d->data_send = proc_data_send;
347         d->data_done = proc_write_close;
348         d->write_cb = proc_relay_write_cb;
349         proc->r.header_cb = proc_handle_header;
350         proc->r.header_end = proc_handle_header_end;
351         proc->r.close = proc_handle_close;
352         proc->wrfd.cb = proc_write_cb;
353
354         return true;
355
356 close_wfd:
357         close(wfd[0]);
358         close(wfd[1]);
359 close_rfd:
360         close(rfd[0]);
361         close(rfd[1]);
362
363         return false;
364 }