Merge commit 'meins/master'
[paraslash.git] / stat.c
diff --git a/stat.c b/stat.c
index 9def507..e640e4c 100644 (file)
--- a/stat.c
+++ b/stat.c
@@ -1,25 +1,18 @@
 /*
- * Copyright (C) 2005-2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2008 Andre Noll <maan@systemlinux.org>
  *
- *     This program is free software; you can redistribute it and/or modify
- *     it under the terms of the GNU General Public License as published by
- *     the Free Software Foundation; either version 2 of the License, or
- *     (at your option) any later version.
- *
- *     This program is distributed in the hope that it will be useful,
- *     but WITHOUT ANY WARRANTY; without even the implied warranty of
- *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *     GNU General Public License for more details.
- *
- *     You should have received a copy of the GNU General Public License
- *     along with this program; if not, write to the Free Software
- *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
 /**
- *  \file stat.c functions used for sending/receiving the status of para_server
- *  and para_audiod
+ *  \file stat.c Functions used for sending/receiving the status of para_server
+ *  and para_audiod.
  */
+
+
+#include <sys/types.h>
+#include <dirent.h>
+
 #include "para.h"
 #include "close_on_fork.h"
 #include "list.h"
 #include "string.h"
 #include "fd.h"
 
-/** the maximal number of simultaneous connections */
+/** The maximal number of simultaneous connections. */
 #define MAX_STAT_CLIENTS 50
 
 /**
- * The structure associated with a connected client that sent the 'stat' command
-*
+ * Describes a status client of para_audiod.
+ *
+ * There's one such structure per audiod client that sent the 'stat' command.
  *
  * A status client is identified by its file descriptor.  para_audiod
  * keeps a list of connected status clients.
  */
 struct stat_client {
-/**
- *
- *
- * the stat client's file descriptor
- */
-int fd;
-long unsigned item_mask;
-/**
- *
- * its entry in the list of stat clients
-*/
-struct list_head node;
+       /** The stat client's file descriptor. */
+       int fd;
+       /** Bitmask of those status items the client is interested in. */
+       long unsigned item_mask;
+       /** Its entry in the list of stat clients. */
+       struct list_head node;
 };
 
 static struct list_head client_list;
 static int initialized;
 static int num_clients;
 
-/**
- * the list of all status items sent by para_server/para_audiod
- */
-const char *status_item_list[NUM_STAT_ITEMS] = {
-       [SI_STATUS_BAR] = "status_bar",
-       [SI_STATUS] = "status",
-       [SI_NUM_PLAYED] = "num_played",
-
-       [SI_MTIME] = "mtime",
-       [SI_LENGTH_MIN] = "length_min",
-       [SI_LENGTH_SEC] = "length_sec",
-
-       [SI_FILE_SIZE] = "file_size",
-       [SI_STATUS_FLAGS] = "status_flags",
-       [SI_FORMAT] = "format",
-
-       [SI_SCORE] = "score",
-       [SI_AUDIO_INFO1] = "audio_file_info1",
-       [SI_AUDIO_INFO2] = "audio_file_info2",
-
-       [SI_AUDIO_INFO3] = "audio_file_info3",
-       [SI_DBINFO1] = "dbinfo1",
-       [SI_DBINFO2] = "dbinfo2",
-
-       [SI_DBINFO3] = "dbinfo3",
-       [SI_DECODER_FLAGS] = "decoder_flags",
-       [SI_AUDIOD_STATUS] = "audiod_status",
-
-       [SI_PLAY_TIME] = "play_time",
-       [SI_UPTIME] = "uptime",
-       [SI_OFFSET] = "offset",
-
-       [SI_LENGTH] = "length",
-       [SI_STREAM_START] = "stream_start",
-       [SI_CURRENT_TIME] = "current_time",
-
-       [SI_AUDIOD_UPTIME] = "audiod_uptime",
-       [SI_SELECTOR] = "dbtool"
-};
-#define FOR_EACH_STAT_ITEM(i) for (i = 0; i < NUM_STAT_ITEMS; i++)
+/** The list of all status items used by para_{server,audiod,gui}. */
+const char *status_item_list[] = {STATUS_ITEM_ARRAY};
 
 static void dump_stat_client_list(void)
 {
@@ -107,10 +57,16 @@ static void dump_stat_client_list(void)
                PARA_INFO_LOG("stat client on fd %d\n", sc->fd);
 }
 /**
- * add a status client to the list
+ * Add a status client to the list.
+ *
+ * \param fd The file descriptor of the client.
+ * \param mask Bitfield of status items for this client.
+ *
+ * Only those status items having the bit set in \a mask will be
+ * sent to the client.
  *
  * \return Positive value on success, or -E_TOO_MANY_CLIENTS if
- * the number of connected clients exceeds #MAX_STAT_CLIENTS
+ * the number of connected clients exceeds #MAX_STAT_CLIENTS.
  */
 int stat_client_add(int fd, long unsigned mask)
 {
@@ -129,81 +85,54 @@ int stat_client_add(int fd, long unsigned mask)
        new_client = para_malloc(sizeof(struct stat_client));
        new_client->fd = fd;
        new_client->item_mask = mask;
-       add_close_on_fork_list(fd);
-       list_add(&new_client->node, &client_list);
+       para_list_add(&new_client->node, &client_list);
        dump_stat_client_list();
        num_clients++;
        return 1;
 }
 /**
- * write a message to all connected status clients
+ * Write a message to all connected status clients.
  *
- * \param msg a \p NULL terminated buffer
- * \param itemnum The number of the status item of \a msg
+ * \param msg A \p NULL terminated buffer.
+ * \param itemnum The number of the status item of \a msg.
  *
  * On write errors, remove the status client from the client list and close its
  * file descriptor.
  */
-void stat_client_write(char *msg, int itemnum)
+void stat_client_write(const char *msg, int itemnum)
 {
        struct stat_client *sc, *tmp;
-       ssize_t len;
-       struct timeval tv = {0 , 0};
+       size_t len = strlen(msg);
 
-       if (!initialized)
+       if (!initialized || !len)
                return;
-       len = strlen(msg);
        list_for_each_entry_safe(sc, tmp, &client_list, node) {
                int fd = sc->fd, ret;
-               fd_set wfds;
 
                if (!((1 << itemnum) & sc->item_mask))
                        continue;
-               FD_ZERO(&wfds);
-               FD_SET(fd, &wfds);
-//             PARA_DEBUG_LOG("%s: p=%lx\n", __func__, (long)p);
-               ret = para_select(fd + 1, NULL, &wfds, &tv);
-               if (ret > 0) {
+               if (write_ok(fd) > 0) {
                        ret = write(fd, msg, len);
-                       PARA_DEBUG_LOG("dumped %s to fd %d, ret = %d\n", msg, fd, ret);
-                       if (ret == len )
+       //              PARA_DEBUG_LOG("dumped %s to fd %d, ret = %d\n", msg, fd, ret);
+                       if (ret == len)
                                continue;
                }
                /* write error or fd not ready for writing */
                close(fd);
-               del_close_on_fork_list(fd);
                num_clients--;
                PARA_INFO_LOG("deleting client on fd %d\n", fd);
                list_del(&sc->node);
                free(sc);
                dump_stat_client_list();
        }
-       PARA_DEBUG_LOG("%d client(s)\n", num_clients);
-}
-
-/**
- * send empty status list
- *
- * Send to  each connected client the full status item list
- * with empty values.
- */
-void dump_empty_status(void)
-{
-       int i;
-
-       if (!initialized)
-               return;
-       FOR_EACH_STAT_ITEM(i) {
-               char *tmp = make_message("%s:\n", status_item_list[i]);
-               stat_client_write(tmp, i);
-               free(tmp);
-       }
+//     if (num_clients)
+//             PARA_DEBUG_LOG("%d client(s)\n", num_clients);
 }
 
 /**
- * check if string is a known status item.
+ * Check if string is a known status item.
  *
- * \param item buffer containing the text to check
+ * \param item Buffer containing the text to check.
  *
  * \return If \a item is a valid status item, the number of that status item is
  * returned. Otherwise, this function returns \p -E_UNKNOWN_STAT_ITEM.
@@ -212,19 +141,20 @@ int stat_item_valid(const char *item)
 {
        int i;
        if (!item || !*item) {
-       PARA_ERROR_LOG("%s\n", "no item");
+               PARA_ERROR_LOG("%s\n", "no item");
                return -E_UNKNOWN_STAT_ITEM;
        }
-       FOR_EACH_STAT_ITEM(i)
+       FOR_EACH_STATUS_ITEM(i)
                if (!strcmp(status_item_list[i], item))
                        return i;
+       PARA_ERROR_LOG("invalid stat item: %s\n", item);
        return -E_UNKNOWN_STAT_ITEM;
 }
 
 /**
- * check if line starts with known status item.
+ * Check if line starts with known status item.
  *
- * \param line buffer containing the line
+ * \param line Buffer containing the line.
  *
  * \return If the beginning of \a line matches any paraslash status item and is
  * followed by a colon, the number of that status item is returned. Otherwise,
@@ -238,7 +168,7 @@ int stat_line_valid(const char *line)
        if (!line || !*line)
                return -E_UNKNOWN_STAT_ITEM;
        line_len = strlen(line);
-       FOR_EACH_STAT_ITEM(i) {
+       FOR_EACH_STATUS_ITEM(i) {
                const char *s = status_item_list[i];
                size_t item_len = strlen(s);
 
@@ -249,55 +179,3 @@ int stat_line_valid(const char *line)
        return -E_UNKNOWN_STAT_ITEM;
 }
 
-/**
- * call a custom function for each complete line
- *
- * \param buf the buffer containing data seperated by newlines
- * \param n the number of bytes in \a buf
- * \param line_handler the custom function
- *
- * If \a line_handler is \p NULL, return number of complete lines in buf.
- * Otherwise, call \a line_handler for each complete line.  The rest of the
- * buffer (last chunk containing incomplete line is moved to the beginning of
- * the buffer.
- *
- * \return If line_handler is not NULL, this function returns the number
- * of bytes not handled to \a line_handler.
- */
-unsigned for_each_line(char *buf, int n, void (*line_handler)(char *))
-{
-       char *start = buf, *end;
-       int i, num_lines = 0;
-
-//     PARA_INFO_LOG("buf: %s", buf);
-       while (start < buf + n) {
-               char *next_null;
-               char *next_cr;
-
-               next_cr = memchr(start, '\n', buf + n - start);
-               next_null = memchr(start, '\0', buf + n - start);
-               if (!next_cr && !next_null)
-                       break;
-               if (next_cr && next_null) {
-                       end = next_cr < next_null? next_cr : next_null;
-               } else if (next_null) {
-                       end = next_null;
-               } else
-                       end = next_cr;
-               num_lines++;
-               if (line_handler) {
-                       *end = '\0';
-//                     PARA_INFO_LOG("calling line handler: %s\n", start);
-                       line_handler(start);
-                       start = ++end;
-               } else
-                       start = ++end;
-       }
-       if (!line_handler)
-               return num_lines;
-       i = buf + n - start;
-       if (i && i != n)
-               memmove(buf, start, i);
-       return i;
-}
-