2 * Copyright (C) 2005-2008 Andre Noll <maan@systemlinux.org>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file http_send.c paraslash's http sender */
15 #include "server.cmdline.h"
23 #include "close_on_fork.h"
26 #include "chunk_queue.h"
28 /** Message sent to clients that do not send a valid get request. */
29 #define HTTP_ERR_MSG "HTTP/1.0 400 Bad Request\n"
32 /** The possible states of a client from the server's POV. */
34 /** We accepted the connection on the tcp socket. */
36 /** Successfully received the get request. */
38 /** We sent the OK message back to the client. */
40 /** Connection established, we might need to send the audio file header. */
42 /** Connection is ready for sending audio data. */
44 /** We didn't receive a valid get request. */
45 HTTP_INVALID_GET_REQUEST
48 /** Clients will be kicked if there are more than that many bytes pending. */
49 #define MAX_BACKLOG 400000
50 /** The list of connected clients. */
51 static struct list_head clients;
52 /** The whitelist/blacklist. */
53 static struct list_head access_perm_list;
55 /** Describes one client that connected the tcp port of the http sender. */
57 /** The file descriptor of the client. */
59 /** The socket `name' of the client. */
61 /** The client's current status. */
62 enum http_status status;
63 /** Non-zero if we included \a fd in the read set.*/
65 /** Non-zero if we included \a fd in the write set. */
67 /** The position of this client in the client list. */
68 struct list_head node;
69 /** The list of pending chunks for this client. */
70 struct chunk_queue *cq;
74 * Describes one entry in the blacklist/whitelist of the http sender.
77 /** The address to be black/whitelisted. */
79 /** The netmask for this entry. */
81 /** The position of this entry in the access_perm_list. */
82 struct list_head node;
85 static int server_fd = -1, numclients;
86 static struct sender *self;
89 static void http_shutdown_client(struct http_client *hc, const char *msg)
91 PARA_INFO_LOG("shutting down %s on fd %d (%s)\n", hc->name, hc->fd,
96 del_close_on_fork_list(hc->fd);
102 static void http_shutdown_clients(void)
104 struct http_client *hc, *tmp;
105 list_for_each_entry_safe(hc, tmp, &clients, node)
106 http_shutdown_client(hc, "vss request");
109 static int http_send_msg(struct http_client *hc, const char *msg)
111 int ret = send_buffer(hc->fd, msg);
114 http_shutdown_client(hc, "send msg failed");
118 static void http_send_ok_msg(struct http_client *hc)
120 PARA_INFO_LOG("sending http ok message to fd %d\n", hc->fd);
121 http_send_msg(hc, HTTP_OK_MSG);
124 static int http_send_err_msg(struct http_client *hc)
126 PARA_NOTICE_LOG("sending bad request message to fd %d\n", hc->fd);
127 return http_send_msg(hc, HTTP_ERR_MSG);
130 static int send_queued_chunks(struct http_client *hc)
132 struct queued_chunk *qc;
133 while ((qc = cq_peek(hc->cq))) {
136 int ret = write_ok(hc->fd);
138 return ret? -E_WRITE_OK : 0;
139 cq_get(qc, &buf, &len);
140 ret = write(hc->fd, buf, len);
142 return -E_SEND_QUEUED_CHUNK;
143 cq_update(hc->cq, ret);
151 static int queue_chunk_or_shutdown(struct http_client *hc, long unsigned chunk_num,
154 int ret = cq_enqueue(hc->cq, chunk_num, sent);
156 http_shutdown_client(hc, "queue error");
160 static void http_send( long unsigned current_chunk,
161 __a_unused long unsigned chunks_sent, const char *buf, size_t len)
163 struct http_client *hc, *tmp;
166 list_for_each_entry_safe(hc, tmp, &clients, node) {
167 if (hc->status != HTTP_STREAMING &&
168 hc->status != HTTP_READY_TO_STREAM)
170 if (hc->status == HTTP_READY_TO_STREAM) {
172 char *hbuf = vss_get_header(&hlen);
173 if (hbuf && hlen > 0 && current_chunk) {
174 /* need to send header */
175 PARA_INFO_LOG("queueing header: %zu\n", hlen);
176 if (queue_chunk_or_shutdown(hc, -1U, 0) < 0)
179 PARA_INFO_LOG("no need to queue header\n");
180 hc->status = HTTP_STREAMING;
182 ret = send_queued_chunks(hc);
184 http_shutdown_client(hc, "queue send error");
189 if (!ret || write_ok(hc->fd) <= 0) {
190 queue_chunk_or_shutdown(hc, current_chunk, 0);
193 // PARA_DEBUG_LOG("sending %d -> %s\n", len, remote_name(hc->fd));
194 ret = write(hc->fd, buf, len);
195 // PARA_DEBUG_LOG("ret: %d\n", ret);
197 http_shutdown_client(hc, "send error");
201 queue_chunk_or_shutdown(hc, current_chunk, ret);
206 * Return true if addr_1 matches addr_2 in the first `netmask' bits.
208 static int v4_addr_match(uint32_t addr_1, uint32_t addr_2, uint8_t netmask)
213 mask <<= (32 - netmask);
214 return (htonl(addr_1) & mask) == (htonl(addr_2) & mask);
217 static int host_in_access_perm_list(struct http_client *hc)
219 struct access_info *ai, *tmp;
220 struct sockaddr_storage ss;
221 socklen_t sslen = sizeof(ss);
222 struct in_addr v4_addr;
224 if (getpeername(hc->fd, (struct sockaddr *)&ss, &sslen) < 0) {
225 PARA_ERROR_LOG("Can not determine peer address: %s\n", strerror(errno));
228 v4_addr = extract_v4_addr(&ss);
232 list_for_each_entry_safe(ai, tmp, &access_perm_list, node)
233 if (v4_addr_match(v4_addr.s_addr, ai->addr.s_addr, ai->netmask))
239 static void http_post_select(fd_set *rfds, fd_set *wfds)
242 struct http_client *hc, *tmp;
245 list_for_each_entry_safe(hc, tmp, &clients, node) {
247 // PARA_DEBUG_LOG("handling client %d: %s\n", i, remote_name(hc->fd));
248 switch (hc->status) {
249 case HTTP_STREAMING: /* nothing to do */
250 case HTTP_READY_TO_STREAM:
252 case HTTP_CONNECTED: /* need to recv get request */
253 if (hc->check_r && FD_ISSET(hc->fd, rfds)) {
254 if (recv_pattern(hc->fd, HTTP_GET_MSG, MAXLINE)
256 hc->status = HTTP_INVALID_GET_REQUEST;
258 hc->status = HTTP_GOT_GET_REQUEST;
260 "received get request\n");
264 case HTTP_GOT_GET_REQUEST: /* need to send ok msg */
265 if (hc->check_w && FD_ISSET(hc->fd, wfds)) {
266 hc->status = HTTP_SENT_OK_MSG;
267 http_send_ok_msg(hc);
270 case HTTP_INVALID_GET_REQUEST: /* need to send err msg */
271 if (hc->check_w && FD_ISSET(hc->fd, wfds)) {
272 if (http_send_err_msg(hc) >= 0)
273 http_shutdown_client(hc,
274 "invalid get request");
277 case HTTP_SENT_OK_MSG: /* need to send header? */
278 if (hc->check_w && FD_ISSET(hc->fd, wfds))
279 hc->status = HTTP_READY_TO_STREAM;
283 if (!FD_ISSET(server_fd, rfds))
285 hc = para_calloc(sizeof(struct http_client));
286 err_msg = "accept error";
287 hc->fd = para_accept(server_fd, NULL, 0);
290 hc->name = make_message("%s", remote_name(hc->fd));
291 PARA_NOTICE_LOG("connection from %s (fd %d)\n", hc->name, hc->fd);
292 if (conf.http_max_clients_arg > 0 && numclients >=
293 conf.http_max_clients_arg) {
294 err_msg = "server full";
297 match = host_in_access_perm_list(hc);
298 PARA_DEBUG_LOG("host_in_access_perm_list: %d\n", match);
299 if ((match && !conf.http_default_deny_given) ||
300 (!match && conf.http_default_deny_given)) {
301 err_msg = "permission denied";
304 hc->status = HTTP_CONNECTED;
305 hc->cq = cq_new(MAX_BACKLOG);
307 PARA_INFO_LOG("accepted client #%d: %s (fd %d)\n", numclients,
309 para_list_add(&hc->node, &clients);
310 add_close_on_fork_list(hc->fd);
311 mark_fd_nonblocking(hc->fd);
314 PARA_WARNING_LOG("ignoring connect request from %s (%s)\n",
321 static void http_pre_select(int *max_fileno, fd_set *rfds, fd_set *wfds)
323 struct http_client *hc, *tmp;
327 para_fd_set(server_fd, rfds, max_fileno);
328 list_for_each_entry_safe(hc, tmp, &clients, node) {
329 //PARA_DEBUG_LOG("hc %p on fd %d: status %d\n", hc, hc->fd, hc->status);
332 switch (hc->status) {
334 case HTTP_READY_TO_STREAM:
336 case HTTP_CONNECTED: /* need to recv get request */
337 para_fd_set(hc->fd, rfds, max_fileno);
340 case HTTP_GOT_GET_REQUEST: /* need to send ok msg */
341 case HTTP_INVALID_GET_REQUEST: /* need to send err msg */
342 para_fd_set(hc->fd, wfds, max_fileno);
345 case HTTP_SENT_OK_MSG:
347 break; /* wait until server starts playing */
348 para_fd_set(hc->fd, wfds, max_fileno);
355 static int open_tcp_port(int port)
359 server_fd = para_listen(AF_UNSPEC, IPPROTO_TCP, port);
361 http_shutdown_clients();
362 self->status = SENDER_OFF;
365 ret = mark_fd_nonblocking(server_fd);
367 PARA_EMERG_LOG("%s\n", para_strerror(-ret));
370 self->status = SENDER_ON;
371 add_close_on_fork_list(server_fd);
375 static int http_com_on(__a_unused struct sender_command_data *scd)
377 if (self->status == SENDER_ON)
379 return open_tcp_port(conf.http_port_arg);
382 static int http_com_off(__a_unused struct sender_command_data *scd)
384 self->status = SENDER_OFF;
387 del_close_on_fork_list(server_fd);
390 http_shutdown_clients();
394 static void del_perm_list_entry(struct sender_command_data *scd)
396 struct access_info *ai, *tmp;
398 list_for_each_entry_safe(ai, tmp, &access_perm_list, node) {
399 char *nad = para_strdup(inet_ntoa(ai->addr));
400 if (!strcmp(nad, inet_ntoa(scd->addr)) &&
401 ai->netmask == scd->netmask) {
402 PARA_NOTICE_LOG("removing %s/%i from access list\n",
411 static void add_perm_list_entry(struct sender_command_data *scd)
413 struct access_info *ai = para_malloc(sizeof(struct access_info));
414 ai->addr = scd->addr;
415 ai->netmask = scd->netmask;
416 PARA_INFO_LOG("adding %s/%i to access list\n", inet_ntoa(ai->addr),
418 para_list_add(&ai->node, &access_perm_list);
421 static int http_com_deny(struct sender_command_data *scd)
423 if (conf.http_default_deny_given)
424 del_perm_list_entry(scd);
426 add_perm_list_entry(scd);
430 static int http_com_allow(struct sender_command_data *scd)
432 if (conf.http_default_deny_given)
433 add_perm_list_entry(scd);
435 del_perm_list_entry(scd);
439 static char *http_info(void)
441 char *clnts = NULL, *ap = NULL, *ret;
442 struct access_info *ai, *tmp_ai;
443 struct http_client *hc, *tmp_hc;
445 list_for_each_entry_safe(ai, tmp_ai, &access_perm_list, node) {
446 char *tmp = make_message("%s%s/%d ", ap? ap : "",
447 inet_ntoa(ai->addr), ai->netmask);
451 list_for_each_entry_safe(hc, tmp_hc, &clients, node) {
452 char *tmp = make_message("%s%s ", clnts? clnts : "", hc->name);
458 "http tcp port: %d\n"
460 "http maximal number of clients: %d%s\n"
461 "http connected clients: %s\n"
462 "http access %s list: %s\n",
463 (self->status == SENDER_ON)? "on" : "off",
466 conf.http_max_clients_arg,
467 conf.http_max_clients_arg > 0? "" : " (unlimited)",
468 clnts? clnts : "(none)",
469 conf.http_default_deny_given? "allow" : "deny",
477 static void init_access_control_list(void)
480 struct sender_command_data scd;
482 INIT_LIST_HEAD(&access_perm_list);
483 for (i = 0; i < conf.http_access_given; i++) {
484 char *arg = para_strdup(conf.http_access_arg[i]);
485 char *p = strchr(arg, '/');
489 if (!inet_pton(AF_INET, arg, &scd.addr))
491 scd.netmask = atoi(++p);
492 if (scd.netmask < 0 || scd.netmask > 32)
494 add_perm_list_entry(&scd);
497 PARA_CRIT_LOG("syntax error for http_access option "
498 "#%d, ignoring\n", i);
505 static char *http_help(void)
509 "usage: {allow|deny} IP mask\n"
510 "example: allow 127.0.0.1 32\n"
515 * The init function of the http sender.
517 * \param s Pointer to the http sender struct.
519 * It initializes all function pointers of \a s, the client list and the access
520 * control list. If the autostart option was given, the tcp port is opened.
522 void http_send_init(struct sender *s)
524 INIT_LIST_HEAD(&clients);
527 s->pre_select = http_pre_select;
528 s->post_select = http_post_select;
529 s->shutdown_clients = http_shutdown_clients;
531 s->client_cmds[SENDER_ON] = http_com_on;
532 s->client_cmds[SENDER_OFF] = http_com_off;
533 s->client_cmds[SENDER_DENY] = http_com_deny;
534 s->client_cmds[SENDER_ALLOW] = http_com_allow;
535 s->client_cmds[SENDER_ADD] = NULL;
536 s->client_cmds[SENDER_DELETE] = NULL;
538 init_access_control_list();
539 if (!conf.http_no_autostart_given)
540 open_tcp_port(conf.http_port_arg); /* ignore errors */
541 PARA_DEBUG_LOG("%s", "http sender init complete\n");