Documentation updates for 0.4.
[paraslash.git] / send_common.c
index 448ce52..a1757a5 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2005-2008 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2009 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -7,6 +7,7 @@
 /** \file send_common.c Functions used by more than one paraslash sender. */
 
 #include <dirent.h>
+#include <osl.h>
 #include "para.h"
 #include "error.h"
 #include "string.h"
@@ -62,6 +63,8 @@ static int open_sender(unsigned l4type, int port)
  * Close the file descriptor given by \a sc, remove it from the close-on-fork
  * list, destroy the chunk queue of this client, delete the client from the
  * list of connected clients and free the sender_client struct.
+ *
+ * \sa shutdown_clients().
  */
 void shutdown_client(struct sender_client *sc, struct sender_status *ss)
 {
@@ -76,79 +79,55 @@ void shutdown_client(struct sender_client *sc, struct sender_status *ss)
        ss->num_clients--;
 }
 
-void shutdown_clients(struct sender_status *ss)
-{
-       struct sender_client *sc, *tmp;
-       list_for_each_entry_safe(sc, tmp, &ss->client_list, node)
-               shutdown_client(sc, ss);
-}
-
 /**
- * Write a buffer to a non-blocking file descriptor.
+ * Shut down all clients connected to a paraslash sender.
  *
- * \param fd The file descriptor.
- * \param buf the buffer to write.
- * \param len the number of bytes of \a buf.
- * \param max_bytes_per_write Do not write more than that many bytes at once.
- *
- * If \a max_bytes_per_write is non-zero, do not send more than that many bytes
- * per write().
- *
- * EAGAIN is not considered an error condition.  For example CCID3 has a
- * sending wait queue which fills up and is emptied asynchronously. The EAGAIN
- * case means that there is currently no space in the wait queue, but this can
- * change at any moment.
+ * \param ss The sender whose clients are to be shut down.
  *
- * \return Negative on errors, number of bytes written else.
+ * This just loops over all connected clients and calls shutdown_client()
+ * for each client.
  */
-static int write_nonblock(int fd, const char *buf, size_t len,
-               size_t max_bytes_per_write)
+void shutdown_clients(struct sender_status *ss)
 {
-       size_t written = 0;
-       int ret = 0;
-
-       while (written < len) {
-               size_t num = len - written;
-
-               if (max_bytes_per_write && max_bytes_per_write < num)
-                       num = max_bytes_per_write;
-               ret = write(fd, buf + written, num);
-               if (ret < 0 && errno == EAGAIN)
-                       return written;
-               if (ret < 0)
-                       return -ERRNO_TO_PARA_ERROR(errno);
-               written += ret;
-       }
-       return written;
+       struct sender_client *sc, *tmp;
+       list_for_each_entry_safe(sc, tmp, &ss->client_list, node)
+               shutdown_client(sc, ss);
 }
 
 static int queue_chunk_or_shutdown(struct sender_client *sc,
-               struct sender_status *ss, long unsigned chunk_num,
-               size_t sent)
+               struct sender_status *ss, const char *buf, size_t num_bytes)
 {
-       int ret = cq_enqueue(sc->cq, chunk_num, sent);
+       int ret = cq_enqueue(sc->cq, buf, num_bytes);
        if (ret < 0)
                shutdown_client(sc, ss);
        return ret;
 }
 
-/* return: negative on errors, zero if not everything was sent, one otherwise */
-static int send_queued_chunks(struct sender_client *sc,
+/**
+ * Try to empty the chunk queue for this fd.
+ *
+ * \param fd The file descriptor.
+ * \param cq The list of queued chunks.
+ * \param max_bytes_per_write Do not send more than this in one go.
+ *
+ * \return Negative on errors, zero if not everything was sent, one otherwise.
+ */
+int send_queued_chunks(int fd, struct chunk_queue *cq,
                size_t max_bytes_per_write)
 {
        struct queued_chunk *qc;
-       while ((qc = cq_peek(sc->cq))) {
-               char *buf;
+       while ((qc = cq_peek(cq))) {
+               const char *buf;
                size_t len;
                int ret;
                cq_get(qc, &buf, &len);
-               ret = write_nonblock(sc->fd, buf, len, max_bytes_per_write);
+               ret = write_nonblock(fd, buf, len, max_bytes_per_write);
                if (ret < 0)
                        return ret;
-               cq_update(sc->cq, ret);
+               cq_update(cq, ret);
                if (ret != len)
                        return 0;
-               cq_dequeue(sc->cq);
+               cq_dequeue(cq);
        }
        return 1;
 }
@@ -162,27 +141,28 @@ static int send_queued_chunks(struct sender_client *sc,
  * \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.
  */
 void send_chunk(struct sender_client *sc, struct sender_status *ss,
                size_t max_bytes_per_write, long unsigned current_chunk,
-               const char *buf, size_t len)
+               const char *buf, size_t len, const char *header_buf,
+               size_t header_len)
 {
        int ret;
 
        if (!sc->header_sent && current_chunk) {
-               size_t header_len;
-               char *header_buf = vss_get_header(&header_len);
                if (header_buf && header_len > 0) {
-                       ret = queue_chunk_or_shutdown(sc, ss, -1U, 0);
+                       ret = queue_chunk_or_shutdown(sc, ss, header_buf, header_len);
                        if (ret < 0)
                                goto out;
                }
                sc->header_sent = 1;
        }
-       ret = send_queued_chunks(sc, max_bytes_per_write);
+       ret = send_queued_chunks(sc->fd, sc->cq, max_bytes_per_write);
        if (ret < 0) {
                shutdown_client(sc, ss);
                goto out;
@@ -190,7 +170,7 @@ void send_chunk(struct sender_client *sc, struct sender_status *ss,
        if (!len)
                goto out;
        if (!ret) { /* still data left in the queue */
-               ret = queue_chunk_or_shutdown(sc, ss, current_chunk, 0);
+               ret = queue_chunk_or_shutdown(sc, ss, buf, len);
                goto out;
        }
        ret = write_nonblock(sc->fd, buf, len, max_bytes_per_write);
@@ -199,7 +179,7 @@ void send_chunk(struct sender_client *sc, struct sender_status *ss,
                goto out;
        }
        if (ret != len)
-               ret = queue_chunk_or_shutdown(sc, ss, current_chunk, ret);
+               ret = queue_chunk_or_shutdown(sc, ss, buf + ret, len - ret);
 out:
        if (ret < 0)
                PARA_NOTICE_LOG("%s\n", para_strerror(-ret));
@@ -235,7 +215,7 @@ void init_sender_status(struct sender_status *ss, char **access_arg,
  *
  * \return The string printed in the "si" command.
  */
-char *get_sender_info(struct sender_status *ss, char *name)
+char *get_sender_info(struct sender_status *ss, const char *name)
 {
        char *clnts = NULL, *ret;
        struct sender_client *sc, *tmp_sc;
@@ -280,7 +260,7 @@ char *get_sender_info(struct sender_status *ss, char *name)
 void generic_com_allow(struct sender_command_data *scd,
                struct sender_status *ss)
 {
-       acl_allow(scd->addr, scd->netmask, &ss->acl, ss->default_deny);
+       acl_allow(scd->host, scd->netmask, &ss->acl, ss->default_deny);
 }
 
 /**
@@ -294,7 +274,7 @@ void generic_com_allow(struct sender_command_data *scd,
 void generic_com_deny(struct sender_command_data *scd,
                struct sender_status *ss)
 {
-       acl_deny(scd->addr, scd->netmask, &ss->acl, ss->default_deny);
+       acl_deny(scd->host, scd->netmask, &ss->acl, ss->default_deny);
 }
 
 /**
@@ -410,7 +390,96 @@ char *generic_sender_help(void)
 {
        return make_message(
                "usage: {on|off}\n"
-               "usage: {allow|deny} IP mask\n"
-               "example: allow 127.0.0.1 32\n"
+               "usage: {allow|deny} IP[/netmask]\n"
+               "       where mask defaults to 32\n"
+               "example: allow 192.168.0.1/24\n"
        );
 }
+
+static int parse_fec_parms(const char *arg, struct sender_command_data *scd)
+{
+       int32_t val;
+       char *a = para_strdup(arg), *b = a, *e = strchr(b, ':');
+       int ret = -E_COMMAND_SYNTAX;
+
+       /* parse max slice bytes */
+       if (!e)
+               goto out;
+       *e = '\0';
+       ret = para_atoi32(b, &val);
+       if (ret < 0)
+               goto out;
+       ret = -ERRNO_TO_PARA_ERROR(EINVAL);
+       if (val < 0 || val > 65535)
+               goto out;
+       scd->max_slice_bytes = val;
+       /* parse data_slices_per_group */
+       b = e + 1;
+       e = strchr(b, ':');
+       ret = -E_COMMAND_SYNTAX;
+       if (!e)
+               goto out;
+       *e = '\0';
+       ret = para_atoi32(b, &val);
+       if (ret < 0)
+               goto out;
+       ret = -ERRNO_TO_PARA_ERROR(EINVAL);
+       if (val < 0 || val > 255)
+               goto out;
+       scd->data_slices_per_group = val;
+       /* parse slices_per_group */
+       b = e + 1;
+       ret = para_atoi32(b, &val);
+       if (ret < 0)
+               goto out;
+       ret = -ERRNO_TO_PARA_ERROR(EINVAL);
+       if (val < 0 || val < scd->data_slices_per_group)
+               goto out;
+       scd->slices_per_group = val;
+       ret = 0;
+out:
+       free(a);
+       return ret;
+}
+
+/**
+ * Parse a FEC URL string.
+ *
+ * \param arg the URL string to parse.
+ * \param scd The structure containing host, port and the FEC parameters.
+ *
+ * \return Standard.
+ *
+ * A FEC URL consists of an ordinary URL string according to RFC 3986,
+ * optionally followed by a slash and the three FEC parameters slice_size,
+ * data_slices_per_group and slices_per_group. The three FEC parameters are
+ * separated by colons.
+ *
+ * \sa \ref parse_url().
+ */
+int parse_fec_url(const char *arg, struct sender_command_data *scd)
+{
+       int ret;
+       ssize_t len = sizeof(scd->host);
+       char *a = para_strdup(arg), *p = strchr(a, '/');
+
+       if (p) {
+               *p = '\0';
+               len = strlen(a);
+       }
+       ret = -ERRNO_TO_PARA_ERROR(EINVAL);
+       if (!parse_url(a, scd->host, len, &scd->port))
+               goto out;
+       if (p) {
+               ret = parse_fec_parms(p + 1, scd);
+               goto out;
+       }
+       /* use default fec parameters. */
+       scd->max_slice_bytes = 1490;
+       scd->slices_per_group = 16;
+       scd->data_slices_per_group = 14;
+       ret = 0;
+out:
+       free(a);
+       return ret;
+}