Merge branch 'refs/heads/t/blob'
[paraslash.git] / http_send.c
index 2a14f4282e4b453a465dbbfeb6ee16fcf611a726..330b45ac1b3ec675a497796be614c07c0bbd9c36 100644 (file)
-/*
- * Copyright (C) 2005-2008 Andre Noll <maan@systemlinux.org>
- *
- * Licensed under the GPL v2. For licencing details see COPYING.
- */
+/* Copyright (C) 2005 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
 
 /** \file http_send.c paraslash's http sender */
 
+#include <netinet/in.h>
+#include <sys/socket.h>
+#include <regex.h>
 #include <sys/types.h>
-#include <dirent.h>
+#include <arpa/inet.h>
+#include <sys/un.h>
+#include <netdb.h>
+#include <lopsub.h>
 
+#include "server.lsg.h"
 #include "para.h"
 #include "error.h"
 #include "string.h"
-#include "server.cmdline.h"
 #include "afh.h"
-#include "afs.h"
+#include "net.h"
 #include "server.h"
 #include "http.h"
-#include "vss.h"
-#include "send.h"
 #include "list.h"
+#include "send.h"
+#include "sched.h"
+#include "vss.h"
 #include "close_on_fork.h"
-#include "net.h"
 #include "fd.h"
 #include "chunk_queue.h"
-#include "acl.h"
 
 /** Message sent to clients that do not send a valid get request. */
 #define HTTP_ERR_MSG "HTTP/1.0 400 Bad Request\n"
 
-
 /** The possible states of a client from the server's POV. */
-enum http_status {
+enum http_client_status {
        /** We accepted the connection on the tcp socket. */
        HTTP_CONNECTED,
        /** Successfully received the get request. */
        HTTP_GOT_GET_REQUEST,
-       /** We sent the OK message back to the client. */
-       HTTP_SENT_OK_MSG,
-       /** Connection established, we might need to send the audio file header. */
-       HTTP_READY_TO_STREAM,
        /** Connection is ready for sending audio data. */
        HTTP_STREAMING,
        /** We didn't receive a valid get request. */
        HTTP_INVALID_GET_REQUEST
 };
 
-/** Clients will be kicked if there are more than that many bytes pending. */
-#define MAX_BACKLOG 400000
-/** The list of connected clients. */
-static struct list_head clients;
-/** The whitelist/blacklist. */
-static struct list_head http_acl;
-
-/** Describes one client that connected the tcp port of the http sender. */
-struct http_client {
-       /** The file descriptor of the client. */
-       int fd;
-       /** The socket `name' of the client. */
-       char *name;
-       /** The client's current status. */
-       enum http_status status;
-       /** Non-zero if we included \a fd in the read set.*/
-       int check_r;
-       /** Non-zero if we included \a fd in the write set. */
-       int check_w;
-       /** The position of this client in the client list. */
-       struct list_head node;
-       /** The list of pending chunks for this client. */
-       struct chunk_queue *cq;
+/** For each connected client, a structure of this type is maintained. */
+struct private_http_sender_data {
+       /** The current state of this client. */
+       enum http_client_status status;
 };
 
-static int listen_fd = -1, numclients;
-static struct sender *self;
+static struct sender_status http_sender_status, *hss = &http_sender_status;
 
-
-static void http_shutdown_client(struct http_client *hc, const char *msg)
+static int http_send_msg(struct sender_client *sc, const char *msg)
 {
-       PARA_INFO_LOG("shutting down %s on fd %d (%s)\n", hc->name, hc->fd,
-               msg);
-       numclients--;
-       free(hc->name);
-       close(hc->fd);
-       del_close_on_fork_list(hc->fd);
-       cq_destroy(hc->cq);
-       list_del(&hc->node);
-       free(hc);
-}
+       int ret = write_buffer(sc->fd, msg);
 
-static void http_shutdown_clients(void)
-{
-       struct http_client *hc, *tmp;
-       list_for_each_entry_safe(hc, tmp, &clients, node)
-               http_shutdown_client(hc, "vss request");
+       if (ret < 0)
+               shutdown_client(sc, hss);
+       return ret;
 }
 
-static int http_send_msg(struct http_client *hc, const char *msg)
+static void http_send_ok_msg(struct sender_client *sc)
 {
-       int ret = send_buffer(hc->fd, msg);
-
-       if (ret < 0)
-               http_shutdown_client(hc, "send msg failed");
-       return ret;
+       PARA_INFO_LOG("sending http ok message to fd %d\n", sc->fd);
+       http_send_msg(sc, HTTP_OK_MSG);
 }
 
-static void http_send_ok_msg(struct http_client *hc)
+static int http_send_err_msg(struct sender_client *sc)
 {
-       PARA_INFO_LOG("sending http ok message to fd %d\n", hc->fd);
-       http_send_msg(hc, HTTP_OK_MSG);
+       PARA_NOTICE_LOG("sending bad request message to fd %d\n", sc->fd);
+       return http_send_msg(sc, HTTP_ERR_MSG);
 }
 
-static int http_send_err_msg(struct http_client *hc)
+static void http_shutdown_clients(void)
 {
-       PARA_NOTICE_LOG("sending bad request message to fd %d\n", hc->fd);
-       return http_send_msg(hc, HTTP_ERR_MSG);
+       shutdown_clients(hss);
 }
 
-static int send_queued_chunks(struct http_client *hc)
+static void http_shutdown(void)
 {
-       struct queued_chunk *qc;
-       while ((qc = cq_peek(hc->cq))) {
-               char *buf;
-               size_t len;
-               int ret = write_ok(hc->fd);
-               if (ret <= 0)
-                       return ret? -E_WRITE_OK : 0;
-               cq_get(qc, &buf, &len);
-               ret = write(hc->fd, buf, len);
-               if (ret < 0)
-                       return -E_SEND_QUEUED_CHUNK;
-               cq_update(hc->cq, ret);
-               if (ret != len)
-                       return 1;
-               cq_dequeue(hc->cq);
-       }
-       return 1;
+       http_shutdown_clients();
+       generic_acl_deplete(&hss->acl);
 }
 
-static int queue_chunk_or_shutdown(struct http_client *hc, long unsigned chunk_num,
-       size_t sent)
+static int queue_chunk_or_shutdown(struct sender_client *sc,
+               struct sender_status *ss, const char *buf, size_t num_bytes)
 {
-       int ret = cq_enqueue(hc->cq, chunk_num, sent);
+       int ret = cq_enqueue(sc->cq, buf, num_bytes);
        if (ret < 0)
-               http_shutdown_client(hc, "queue error");
+               shutdown_client(sc, ss);
        return ret;
 }
 
-static void http_send( long unsigned current_chunk,
-       __a_unused long unsigned chunks_sent, const char *buf, size_t len)
+/**
+ * Send one chunk of audio data to a connected client.
+ *
+ * \param sc The client.
+ * \param ss The sender.
+ * \param current_chunk The number of the chunk to write.
+ * \param buf The data to write.
+ * \param len The number of bytes of \a buf.
+ * \param header_buf The audio file header.
+ * \param header_len The number of bytes of \a header_buf.
+ *
+ * On errors, the client is shut down. If only a part of the buffer could be
+ * written, the remainder is put into the chunk queue for that client.
+ */
+static void http_send_chunk(struct sender_client *sc, struct sender_status *ss,
+               long unsigned current_chunk, const char *buf, size_t len,
+               const char *header_buf, size_t header_len)
 {
-       struct http_client *hc, *tmp;
        int ret;
 
-       list_for_each_entry_safe(hc, tmp, &clients, node) {
-               if (hc->status != HTTP_STREAMING &&
-                               hc->status != HTTP_READY_TO_STREAM)
-                       continue;
-               if (hc->status == HTTP_READY_TO_STREAM) {
-                       size_t hlen;
-                       char *hbuf = vss_get_header(&hlen);
-                       if (hbuf && hlen > 0 && current_chunk) {
-                               /* need to send header */
-                               PARA_INFO_LOG("queueing header: %zu\n", hlen);
-                               if (queue_chunk_or_shutdown(hc, -1U, 0) < 0)
-                                       continue;
-                       } else
-                               PARA_INFO_LOG("no need to queue header\n");
-                       hc->status = HTTP_STREAMING;
-               }
-               ret = send_queued_chunks(hc);
-               if (ret < 0) {
-                       http_shutdown_client(hc, "queue send error");
-                       continue;
+       if (!sc->header_sent && current_chunk) {
+               if (header_buf && header_len > 0) {
+                       ret = queue_chunk_or_shutdown(sc, ss, header_buf, header_len);
+                       if (ret < 0)
+                               goto out;
                }
-               if (!len)
-                       continue;
-               if (!ret || write_ok(hc->fd) <= 0) {
-                       queue_chunk_or_shutdown(hc, current_chunk, 0);
-                       continue;
-               }
-//             PARA_DEBUG_LOG("sending %d -> %s\n", len, remote_name(hc->fd));
-               ret = write(hc->fd, buf, len);
-//             PARA_DEBUG_LOG("ret: %d\n", ret);
-               if (ret < 0) {
-                       http_shutdown_client(hc, "send error");
-                       continue;
-               }
-               if (ret != len)
-                       queue_chunk_or_shutdown(hc, current_chunk, ret);
        }
+       sc->header_sent = 1;
+       ret = send_queued_chunks(sc->fd, sc->cq);
+       if (ret < 0) {
+               shutdown_client(sc, ss);
+               goto out;
+       }
+       if (!len)
+               goto out;
+       if (!ret) { /* still data left in the queue */
+               ret = queue_chunk_or_shutdown(sc, ss, buf, len);
+               goto out;
+       }
+       ret = xwrite(sc->fd, buf, len);
+       if (ret < 0) {
+               shutdown_client(sc, ss);
+               goto out;
+       }
+       if (ret != len)
+               ret = queue_chunk_or_shutdown(sc, ss, buf + ret, len - ret);
+out:
+       if (ret < 0)
+               PARA_NOTICE_LOG("%s\n", para_strerror(-ret));
 }
 
-static void http_post_select(fd_set *rfds, fd_set *wfds)
+static void http_send(long unsigned current_chunk,
+       __a_unused long unsigned chunks_sent, const char *buf, size_t len,
+       const char *header_buf, size_t header_len)
 {
-       int i = -1, match;
-       struct http_client *hc, *tmp;
-       const char *err_msg;
+       struct sender_client *sc, *tmp;
 
-       if (listen_fd < 0)
-               return;
-       list_for_each_entry_safe(hc, tmp, &clients, node) {
-               i++;
-//             PARA_DEBUG_LOG("handling client %d: %s\n", i, remote_name(hc->fd));
-               switch (hc->status) {
-               case HTTP_STREAMING: /* nothing to do */
-               case HTTP_READY_TO_STREAM:
-                       break;
-               case HTTP_CONNECTED: /* need to recv get request */
-                       if (hc->check_r && FD_ISSET(hc->fd, rfds)) {
-                               if (recv_pattern(hc->fd, HTTP_GET_MSG, MAXLINE)
-                                               < 0) {
-                                       hc->status = HTTP_INVALID_GET_REQUEST;
-                               } else {
-                                       hc->status = HTTP_GOT_GET_REQUEST;
-                                       PARA_INFO_LOG("%s",
-                                               "received get request\n");
-                               }
-                       }
-                       break;
-               case HTTP_GOT_GET_REQUEST: /* need to send ok msg */
-                       if (hc->check_w && FD_ISSET(hc->fd, wfds)) {
-                               hc->status = HTTP_SENT_OK_MSG;
-                               http_send_ok_msg(hc);
-                       }
-                       break;
-               case HTTP_INVALID_GET_REQUEST: /* need to send err msg */
-                       if (hc->check_w && FD_ISSET(hc->fd, wfds)) {
-                               if (http_send_err_msg(hc) >= 0)
-                                       http_shutdown_client(hc,
-                                               "invalid get request");
-                       }
-                       break;
-               case HTTP_SENT_OK_MSG: /* need to send header? */
-                       if (hc->check_w && FD_ISSET(hc->fd, wfds))
-                               hc->status = HTTP_READY_TO_STREAM;
-                       break;
-               }
-       }
-       if (!FD_ISSET(listen_fd, rfds))
-               return;
-       hc = para_calloc(sizeof(struct http_client));
-       err_msg = "accept error";
-       hc->fd = para_accept(listen_fd, NULL, 0);
-       if (hc->fd <= 0)
-               goto err_out;
-       hc->name = make_message("%s", remote_name(hc->fd));
-       PARA_NOTICE_LOG("connection from %s (fd %d)\n", hc->name, hc->fd);
-       if (conf.http_max_clients_arg > 0 && numclients >=
-                       conf.http_max_clients_arg) {
-               err_msg = "server full";
-               goto err_out;
-       }
-       match = acl_lookup(hc->fd, &http_acl);
-       PARA_DEBUG_LOG("acl lookup returned %d\n", match);
-       if ((match && !conf.http_default_deny_given) ||
-                       (!match && conf.http_default_deny_given)) {
-               err_msg = "permission denied";
-               goto err_out;
+       list_for_each_entry_safe(sc, tmp, &hss->client_list, node) {
+               struct private_http_sender_data *phsd = sc->private_data;
+
+               if (phsd->status == HTTP_STREAMING)
+                       http_send_chunk(sc, hss, current_chunk, buf, len,
+                                  header_buf, header_len);
        }
-       hc->status = HTTP_CONNECTED;
-       hc->cq = cq_new(MAX_BACKLOG);
-       numclients++;
-       PARA_INFO_LOG("accepted client #%d: %s (fd %d)\n", numclients,
-               hc->name, hc->fd);
-       para_list_add(&hc->node, &clients);
-       add_close_on_fork_list(hc->fd);
-       mark_fd_nonblocking(hc->fd);
-       return;
-err_out:
-       PARA_WARNING_LOG("ignoring connect request from %s (%s)\n",
-               hc->name, err_msg);
-       if (hc->fd > 0)
-               close(hc->fd);
-       free(hc);
 }
 
-static void http_pre_select(int *max_fileno, fd_set *rfds, fd_set *wfds)
+static void http_post_select(fd_set *rfds, __a_unused fd_set *wfds)
 {
-       struct http_client *hc, *tmp;
+       struct sender_client *sc, *tmp;
+       struct private_http_sender_data *phsd;
+       int ret;
 
-       if (listen_fd < 0)
-               return;
-       para_fd_set(listen_fd, rfds, max_fileno);
-       list_for_each_entry_safe(hc, tmp, &clients, node) {
-               //PARA_DEBUG_LOG("hc %p on fd %d: status %d\n", hc, hc->fd, hc->status);
-               hc->check_r = 0;
-               hc->check_w = 0;
-               switch (hc->status) {
-               case HTTP_STREAMING:
-               case HTTP_READY_TO_STREAM:
+       list_for_each_entry_safe(sc, tmp, &hss->client_list, node) {
+               phsd = sc->private_data;
+               switch (phsd->status) {
+               case HTTP_STREAMING: /* nothing to do */
                        break;
                case HTTP_CONNECTED: /* need to recv get request */
-                       para_fd_set(hc->fd, rfds, max_fileno);
-                       hc->check_r = 1;
+                       ret = read_pattern(sc->fd, HTTP_GET_MSG, MAXLINE, rfds);
+                       if (ret < 0)
+                               phsd->status = HTTP_INVALID_GET_REQUEST;
+                       else if (ret > 0) {
+                               phsd->status = HTTP_GOT_GET_REQUEST;
+                               PARA_INFO_LOG("received get request\n");
+                       }
                        break;
                case HTTP_GOT_GET_REQUEST: /* need to send ok msg */
-               case HTTP_INVALID_GET_REQUEST: /* need to send err msg */
-                       para_fd_set(hc->fd, wfds, max_fileno);
-                       hc->check_w = 1;
+                       phsd->status = HTTP_STREAMING;
+                       http_send_ok_msg(sc);
                        break;
-               case HTTP_SENT_OK_MSG:
-                       if (!vss_playing())
-                               break; /* wait until server starts playing */
-                       para_fd_set(hc->fd, wfds, max_fileno);
-                       hc->check_w = 1;
+               case HTTP_INVALID_GET_REQUEST: /* need to send err msg */
+                       if (http_send_err_msg(sc) >= 0)
+                               shutdown_client(sc, hss);
                        break;
                }
        }
+       sc = accept_sender_client(hss, rfds);
+       if (!sc)
+               return;
+       phsd = para_malloc(sizeof(*phsd));
+       sc->private_data = phsd;
+       phsd->status = HTTP_CONNECTED;
 }
 
-static int http_open(int port)
+static void http_pre_select(int *max_fileno, fd_set *rfds, fd_set *wfds)
 {
-       int ret;
+       struct sender_client *sc, *tmp;
+       unsigned n;
 
-       listen_fd = para_listen(AF_UNSPEC, IPPROTO_TCP, port);
-       if (listen_fd < 0) {
-               http_shutdown_clients();
-               return listen_fd;
+       FOR_EACH_LISTEN_FD(n, hss) {
+               if (hss->listen_fds[n] < 0)
+                       continue;
+               para_fd_set(hss->listen_fds[n], rfds, max_fileno);
        }
-       ret = mark_fd_nonblocking(listen_fd);
-       if (ret < 0) {
-               PARA_EMERG_LOG("%s\n", para_strerror(-ret));
-               exit(EXIT_FAILURE);
+       list_for_each_entry_safe(sc, tmp, &hss->client_list, node) {
+               struct private_http_sender_data *phsd = sc->private_data;
+               if (phsd->status == HTTP_CONNECTED) /* need to recv get request */
+                       para_fd_set(sc->fd, rfds, max_fileno);
+               if (phsd->status == HTTP_GOT_GET_REQUEST ||
+                               phsd->status == HTTP_INVALID_GET_REQUEST)
+                       para_fd_set(sc->fd, wfds, max_fileno);
        }
-       add_close_on_fork_list(listen_fd);
-       return 1;
 }
 
 static int http_com_on(__a_unused struct sender_command_data *scd)
 {
-       if (listen_fd >= 0)
-               return 1;
-       return http_open(conf.http_port_arg);
+       generic_com_on(hss, IPPROTO_TCP);
+       return 1;
 }
 
 static int http_com_off(__a_unused struct sender_command_data *scd)
 {
-       if (listen_fd < 0)
-               return 1;
-       PARA_NOTICE_LOG("closing http port %d\n", conf.http_port_arg);
-       close(listen_fd);
-       del_close_on_fork_list(listen_fd);
-       http_shutdown_clients();
-       listen_fd = -1;
+       generic_com_off(hss);
        return 1;
 }
 
 static int http_com_deny(struct sender_command_data *scd)
 {
-       if (conf.http_default_deny_given)
-               acl_del_entry(&http_acl, scd->addr, scd->netmask);
-       else
-               acl_add_entry(&http_acl, scd->addr, scd->netmask);
+       generic_com_deny(scd, hss);
        return 1;
 }
 
 static int http_com_allow(struct sender_command_data *scd)
 {
-       if (conf.http_default_deny_given)
-               acl_add_entry(&http_acl, scd->addr, scd->netmask);
-       else
-               acl_del_entry(&http_acl, scd->addr, scd->netmask);
+       generic_com_allow(scd, hss);
        return 1;
 }
 
-static char *http_info(void)
+static char *http_status(void)
 {
-       char *clnts = NULL, *ret;
-       struct http_client *hc, *tmp_hc;
-
-       char *acl_contents = acl_get_contents(&http_acl);
-       list_for_each_entry_safe(hc, tmp_hc, &clients, node) {
-               char *tmp = make_message("%s%s ", clnts? clnts : "", hc->name);
-               free(clnts);
-               clnts = tmp;
-       }
-       ret = make_message(
-               "http status: %s\n"
-               "http tcp port: %d\n"
-               "http clients: %d\n"
-               "http maximal number of clients: %d%s\n"
-               "http connected clients: %s\n"
-               "http access %s list: %s\n",
-               (listen_fd >= 0)? "on" : "off",
-               conf.http_port_arg,
-               numclients,
-               conf.http_max_clients_arg,
-               conf.http_max_clients_arg > 0? "" : " (unlimited)",
-               clnts? clnts : "(none)",
-               conf.http_default_deny_given? "allow" : "deny",
-               acl_contents? acl_contents : "(none)"
-       );
-       free(acl_contents);
-       free(clnts);
-       return ret;
+       return generic_sender_status(hss, "http");
 }
 
-static char *http_help(void)
+/*
+ * Initialize the client list and the access control list, and optionally
+ * listen on the tcp port.
+ */
+static void http_send_init(void)
 {
-       return make_message(
-               "usage: {on|off}\n"
-               "usage: {allow|deny} IP mask\n"
-               "example: allow 127.0.0.1 32\n"
-       );
+       init_sender_status(hss, OPT_RESULT(HTTP_ACCESS),
+               OPT_RESULT(HTTP_LISTEN_ADDRESS),
+               OPT_UINT32_VAL(HTTP_PORT), OPT_UINT32_VAL(HTTP_MAX_CLIENTS),
+               OPT_GIVEN(HTTP_DEFAULT_DENY));
+       if (OPT_GIVEN(HTTP_NO_AUTOSTART))
+               return;
+       generic_com_on(hss, IPPROTO_TCP);
 }
 
 /**
- * The init function of the http sender.
- *
- * \param s Pointer to the http sender struct.
+ * The HTTP sender.
  *
- * It initializes all function pointers of \a s, the client list and the access
- * control list. If the autostart option was given, the tcp port is opened.
+ * This is the only sender which does not FEC-encode the stream. This is not
+ * necessary because HTTP sits on top of TCP, a reliable transport which
+ * retransmits lost packets automatically. The sender employs per-client queues
+ * which queue chunks of audio data if they can not be sent immediately because
+ * the write operation would block. Most methods of the sender are implemented
+ * as wrappers for the generic functions defined in \ref send_common.c.
  */
-void http_send_init(struct sender *s)
-{
-       INIT_LIST_HEAD(&clients);
-       s->info = http_info;
-       s->send = http_send;
-       s->pre_select = http_pre_select;
-       s->post_select = http_post_select;
-       s->shutdown_clients = http_shutdown_clients;
-       s->help = http_help;
-       s->client_cmds[SENDER_ON] = http_com_on;
-       s->client_cmds[SENDER_OFF] = http_com_off;
-       s->client_cmds[SENDER_DENY] = http_com_deny;
-       s->client_cmds[SENDER_ALLOW] = http_com_allow;
-       s->client_cmds[SENDER_ADD] = NULL;
-       s->client_cmds[SENDER_DELETE] = NULL;
-       self = s;
-       acl_init(&http_acl, conf.http_access_arg, conf.http_access_given);
-       if (!conf.http_no_autostart_given)
-               http_open(conf.http_port_arg); /* ignore errors */
-       PARA_DEBUG_LOG("%s", "http sender init complete\n");
-}
+const struct sender http_sender = {
+       .name = "http",
+       .init = http_send_init,
+       .shutdown = http_shutdown,
+       .pre_select = http_pre_select,
+       .post_select = http_post_select,
+       .send = http_send,
+       .shutdown_clients = http_shutdown_clients,
+       .client_cmds = {
+               [SENDER_on] = http_com_on,
+               [SENDER_off] = http_com_off,
+               [SENDER_deny] = http_com_deny,
+               [SENDER_allow] = http_com_allow,
+       },
+       .help = generic_sender_help,
+       .status = http_status,
+};