Add a check for libosl to configure.ac.
[paraslash.git] / stat.c
diff --git a/stat.c b/stat.c
index ac5fe8c..1062da3 100644 (file)
--- a/stat.c
+++ b/stat.c
@@ -1,99 +1,61 @@
 /*
- * Copyright (C) 2005-2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2009 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 "error.h"
 #include "string.h"
+#include "fd.h"
 
-/** the maximal number of simultaneous connections */
+/** The maximal number of simultaneous connections. */
 #define MAX_STAT_CLIENTS 50
 
+extern char *stat_item_values[NUM_STAT_ITEMS];
+
+/** Flags used for the stat command of para_audiod. */
+enum stat_client_flags {
+       /** Enable parser-friendly output. */
+       SCF_PARSER_FRIENDLY = 1,
+};
+
 /**
- * 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;
-/**
- *
- * 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. */
+       uint64_t item_mask;
+       /** See \ref stat_client flags. s*/
+       unsigned flags;
+       /** 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)
 {
@@ -105,12 +67,19 @@ 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.
+ * \param parser_friendly Enable parser-friendly output mode.
+ *
+ * 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)
+int stat_client_add(int fd, uint64_t mask, int parser_friendly)
 {
        struct stat_client *new_client;
 
@@ -124,156 +93,147 @@ int stat_client_add(int fd)
                initialized = 1;
        }
        PARA_INFO_LOG("adding client on fd %d\n", fd);
-       new_client = para_malloc(sizeof(struct stat_client));
+       new_client = para_calloc(sizeof(struct stat_client));
        new_client->fd = fd;
-       add_close_on_fork_list(fd);
-       list_add(&new_client->node, &client_list);
+       new_client->item_mask = mask;
+       if (parser_friendly)
+               new_client->flags = SCF_PARSER_FRIENDLY;
+       para_list_add(&new_client->node, &client_list);
        dump_stat_client_list();
        num_clients++;
        return 1;
 }
 /**
- * write a message to all connected stat clients
+ * Write a message to all connected status clients.
+ *
+ * \param item_num The number of the status item of \a msg.
  *
- * \param msg a \p NULL terminated buffer
+ * On write errors, remove the status client from the client list and close its
+ * file descriptor.
  */
-void stat_client_write(char *msg)
+void stat_client_write_item(int item_num)
 {
        struct stat_client *sc, *tmp;
-       char *buf;
-       ssize_t len;
-       struct timeval tv = {0 , 0};
+       struct para_buffer pb = {.flags = 0};
+       struct para_buffer pfpb = {.flags = PBF_SIZE_PREFIX};
+       const uint64_t one = 1;
 
        if (!initialized)
                return;
-       buf = make_message("%s\n", msg);
-       len = strlen(buf);
        list_for_each_entry_safe(sc, tmp, &client_list, node) {
                int fd = sc->fd, ret;
-               fd_set wfds;
-               FD_ZERO(&wfds);
-               FD_SET(fd, &wfds);
-//             PARA_DEBUG_LOG("%s: p=%lx\n", __func__, (long)p);
-               do
-                       ret = select(fd + 1, NULL, &wfds, NULL, &tv);
-               while (ret < 0 && errno == EINTR);
-               if (ret) {
-                       ret = write(fd, buf, len);
-                       PARA_DEBUG_LOG("dumped %s to fd %d, ret = %d\n", msg, fd, ret);
-                       if (ret == len )
+
+               if (!((one << item_num) & sc->item_mask))
+                       continue;
+               if (write_ok(fd) > 0) {
+                       struct para_buffer *b =
+                               (sc->flags & SCF_PARSER_FRIENDLY)? &pfpb : &pb;
+                       char *msg = stat_item_values[item_num];
+                       if (!b->buf)
+                               WRITE_STATUS_ITEM(b, item_num, "%s\n",
+                                       msg? msg : "");
+                       ret = write(fd, b->buf, b->offset);
+                       if (ret == b->offset)
                                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();
        }
-       free(buf);
-       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;
-       char *empty_items = NULL;
-
-       if (!initialized)
-               return;
-       FOR_EACH_STAT_ITEM(i) {
-               char *tmp = make_message("%s%s:\n", empty_items? empty_items : "",
-                       status_item_list[i]);
-               free(empty_items);
-               empty_items = tmp;
-       }
-       stat_client_write(empty_items);
-       free(empty_items);
+       free(pb.buf);
+       free(pfpb.buf);
+//     if (num_clients)
+//             PARA_DEBUG_LOG("%d client(s)\n", num_clients);
 }
 
 /**
- * check if line starts with known status item.
+ * Check if string is a known status item.
  *
- * \param line buffer containing the line
+ * \param item Buffer containing the text to check.
  *
- * \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,
- * this function returns \p -E_UNKNOWN_STAT_ITEM.
+ * \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.
  */
-int stat_line_valid(const char *line)
+int stat_item_valid(const char *item)
 {
        int i;
-       size_t line_len;
-
-       if (!line || !*line)
+       if (!item || !*item) {
+               PARA_ERROR_LOG("%s\n", "no item");
                return -E_UNKNOWN_STAT_ITEM;
-       line_len = strlen(line);
-       for (i = 0; i < NUM_STAT_ITEMS; i++) {
-               const char *s = status_item_list[i];
-               size_t item_len = strlen(s);
-
-               if (line_len > item_len && line[item_len] == ':' &&
-                               !strncmp(line, s, item_len))
-                       return 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;
 }
 
+/** The minimal length of a status item buffer. */
+#define MIN_STAT_ITEM_LEN 9 /* 5 + 2 + 2, e.g. '0005 00:\n' */
+
 /**
- * call a custom function for each complete line
+ * Call a function for each complete status item of a buffer.
  *
- * \param buf the buffer containing data seperated by newlines
- * \param n the number of bytes in \a buf
- * \param line_handler the custom function
+ * \param item_buf The source buffer.
+ * \param num_bytes The length of \a buf.
+ * \param item_handler Function to call for each complete item.
  *
- * 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 Negative on errors, the number of bytes _not_ passed to \a
+ * item_handler.
  *
- * \return If line_handler is not NULL, this function returns the number
- * of bytes not handled to \a line_handler.
+ * Status items are expected in the format used by parser-friendly output mode
+ * of the stat command of para_client/para_audioc.
  */
-unsigned for_each_line(char *buf, int n, void (*line_handler)(char *))
+int for_each_stat_item(char *item_buf, size_t num_bytes,
+       int (*item_handler)(int, char *))
 {
-       char *start = buf, *end;
-       int i, num_lines = 0;
-
-       while (start < buf + n) {
-               char *next_null;
-               char *next_cr;
+       char *buf = item_buf;
+       int len = num_bytes;
 
-               next_cr = memchr(start, '\n', buf + n - start);
-               next_null = memchr(start, '\0', buf + n - start);
-               if (!next_cr && !next_null)
+       for (;;) {
+               int i, ret, item_len, item_num = 0;
+               if (len < MIN_STAT_ITEM_LEN)
                        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';
-                       line_handler(start);
-                       start = ++end;
-               } else
-                       start = ++end;
+               ret = read_size_header(buf);
+               if (ret < 0)
+                       return ret;
+               item_len = ret;
+               if (item_len > len - 5) /* item not complete */
+                       break;
+               for (i = 0; i < 2; i++) {
+                       unsigned char c = buf[5 + i];
+                       item_num <<= 4;
+                       if (c >= '0' && c <= '9') {
+                               item_num += c - '0';
+                               continue;
+                       }
+                       if (c >= 'a' && c <= 'f') {
+                               item_num += c - 'a' + 10;
+                               continue;
+                       }
+                       return -E_STAT_ITEM_PARSE;
+               }
+               if (buf[7] != ':' || buf[5 + item_len - 1] != '\n')
+                       return -E_STAT_ITEM_PARSE;
+               buf[5 + item_len - 1] = '\0';
+               if (item_num >= NUM_STAT_ITEMS)
+                       PARA_WARNING_LOG("unknown status item %d: %s\n",
+                               item_num, buf + 8);
+               else {
+                       ret = item_handler(item_num, buf + 8);
+                       if (ret < 0)
+                               return ret;
+               }
+               buf += 5 + item_len;
+               len -= 5 + item_len;
+               assert(len >= 0 && buf <= item_buf + num_bytes);
        }
-       if (!line_handler)
-               return num_lines;
-       i = buf + n - start;
-       if (i && i != n)
-               memmove(buf, start, i);
-       return i;
+       assert(len >= 0);
+       if (len && len != num_bytes)
+               memmove(item_buf, item_buf + num_bytes - len, len);
+       return len;
 }
-