fix index file handling
[project/uhttpd.git] / uhttpd.h
1 /*
2  * uhttpd - Tiny single-threaded httpd - Main header
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 #ifndef __UHTTPD_H
21 #define __UHTTPD_H
22
23 #include <netinet/in.h>
24 #include <limits.h>
25 #include <dirent.h>
26
27 #include <libubox/list.h>
28 #include <libubox/uloop.h>
29 #include <libubox/ustream.h>
30 #include <libubox/blob.h>
31 #include <libubox/utils.h>
32
33 #include "utils.h"
34
35 #define UH_LIMIT_CLIENTS        64
36
37 #define __enum_header(_name) HDR_##_name,
38 #define __blobmsg_header(_name) [HDR_##_name] = { .name = #_name, .type = BLOBMSG_TYPE_STRING },
39
40 struct client;
41
42 struct config {
43         const char *docroot;
44         const char *realm;
45         const char *file;
46         const char *error_handler;
47         const char *cgi_prefix;
48         const char *cgi_path;
49         int no_symlinks;
50         int no_dirlists;
51         int network_timeout;
52         int rfc1918_filter;
53         int tcp_keepalive;
54         int max_requests;
55         int http_keepalive;
56         int script_timeout;
57 };
58
59 struct auth_realm {
60         struct list_head list;
61         const char *path;
62         const char *user;
63         const char *pass;
64 };
65
66 enum http_method {
67         UH_HTTP_MSG_GET,
68         UH_HTTP_MSG_POST,
69         UH_HTTP_MSG_HEAD,
70 };
71
72 enum http_version {
73         UH_HTTP_VER_0_9,
74         UH_HTTP_VER_1_0,
75         UH_HTTP_VER_1_1,
76 };
77
78 struct http_request {
79         enum http_method method;
80         enum http_version version;
81         bool expect_cont;
82         int redirect_status;
83         const char *url;
84         const struct auth_realm *realm;
85 };
86
87 enum client_state {
88         CLIENT_STATE_INIT,
89         CLIENT_STATE_HEADER,
90         CLIENT_STATE_DATA,
91         CLIENT_STATE_DONE,
92         CLIENT_STATE_CLOSE,
93 };
94
95 struct interpreter {
96         struct list_head list;
97         const char *path;
98         const char *ext;
99 };
100
101 struct path_info {
102         const char *root;
103         const char *phys;
104         const char *name;
105         const char *info;
106         const char *query;
107         const char *auth;
108         bool redirected;
109         struct stat stat;
110         const struct interpreter *ip;
111 };
112
113 struct env_var {
114         const char *name;
115         const char *value;
116 };
117
118 struct relay {
119         struct ustream_fd sfd;
120         struct uloop_process proc;
121         struct client *cl;
122
123         bool process_done;
124         int ret;
125         int header_ofs;
126
127         void (*header_cb)(struct relay *r, const char *name, const char *value);
128         void (*header_end)(struct relay *r);
129         void (*close)(struct relay *r, int ret);
130 };
131
132 struct dispatch_handler {
133         struct list_head list;
134
135         bool (*check_url)(const char *url);
136         bool (*check_path)(struct path_info *pi, const char *url);
137         void (*handle_request)(struct client *cl, const char *url, struct path_info *pi);
138 };
139
140 struct client {
141         struct list_head list;
142         int id;
143
144         struct ustream *us;
145         struct ustream_fd sfd;
146 #ifdef HAVE_TLS
147         struct ustream_ssl stream_ssl;
148 #endif
149         struct uloop_timeout timeout;
150
151         enum client_state state;
152
153         struct http_request request;
154         struct uh_addr srv_addr, peer_addr;
155
156         struct blob_buf hdr;
157
158         struct {
159                 void (*write_cb)(struct client *cl);
160                 void (*close_fds)(struct client *cl);
161                 void (*free)(struct client *cl);
162                 union {
163                         struct {
164                                 struct blob_attr **hdr;
165                                 int fd;
166                         } file;
167                         struct {
168                                 struct blob_buf hdr;
169                                 struct relay r;
170                                 int status_code;
171                                 char *status_msg;
172                         } proc;
173                 };
174         } dispatch;
175 };
176
177 extern char uh_buf[4096];
178 extern int n_clients;
179 extern struct config conf;
180 extern const char * const http_versions[];
181 extern const char * const http_methods[];
182 extern struct dispatch_handler cgi_dispatch;
183
184 void uh_index_add(const char *filename);
185
186 void uh_accept_client(int fd);
187
188 void uh_unblock_listeners(void);
189 void uh_setup_listeners(void);
190 int uh_socket_bind(const char *host, const char *port, bool tls);
191
192 bool uh_use_chunked(struct client *cl);
193 void uh_chunk_write(struct client *cl, const void *data, int len);
194 void uh_chunk_vprintf(struct client *cl, const char *format, va_list arg);
195
196 void __printf(2, 3)
197 uh_chunk_printf(struct client *cl, const char *format, ...);
198
199 void uh_chunk_eof(struct client *cl);
200 void uh_request_done(struct client *cl);
201
202 void uh_http_header(struct client *cl, int code, const char *summary);
203 void __printf(4, 5)
204 uh_client_error(struct client *cl, int code, const char *summary, const char *fmt, ...);
205
206 void uh_handle_request(struct client *cl);
207
208 void uh_auth_add(const char *path, const char *user, const char *pass);
209 bool uh_auth_check(struct client *cl, struct path_info *pi);
210
211 void uh_close_listen_fds(void);
212 void uh_close_fds(void);
213
214 void uh_interpreter_add(const char *ext, const char *path);
215 void uh_dispatch_add(struct dispatch_handler *d);
216
217 void uh_relay_open(struct client *cl, struct relay *r, int fd, int pid);
218 void uh_relay_close(struct relay *r, int ret);
219 void uh_relay_free(struct relay *r);
220
221 struct env_var *uh_get_process_vars(struct client *cl, struct path_info *pi);
222 bool uh_create_process(struct client *cl, struct path_info *pi,
223                        void (*cb)(struct client *cl, struct path_info *pi, int fd));
224
225 #endif