X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=stat.c;h=1062da360b3fe97090c67ebfd74363d5fa3035d9;hp=1ea2318dabc51d1d5c650e8ee8047615312a0aa3;hb=ca659e6bf0d7f783849244105a077e79fcf741ad;hpb=d85f74ca004d40e251d58ce8eed31e6786a6a6a3;ds=sidebyside diff --git a/stat.c b/stat.c index 1ea2318d..1062da36 100644 --- a/stat.c +++ b/stat.c @@ -1,12 +1,12 @@ /* - * Copyright (C) 2005-2007 Andre Noll + * Copyright (C) 2005-2009 Andre Noll * * 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. */ @@ -20,11 +20,19 @@ #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, +}; + /** - * describes a status client of para_audiod + * Describes a status client of para_audiod. * * There's one such structure per audiod client that sent the 'stat' command. * @@ -32,11 +40,13 @@ * keeps a list of connected status clients. */ struct stat_client { - /** the stat client's file descriptor */ + /** 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 */ + /** 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; }; @@ -44,45 +54,8 @@ static struct list_head client_list; static int initialized; static int num_clients; -/** The list of all status items used by para_server/para_audiod. */ -const char *status_item_list[NUM_STAT_ITEMS] = { - [SI_BASENAME] = "basename", - [SI_STATUS] = "status", - [SI_NUM_PLAYED] = "num_played", - - [SI_MTIME] = "mtime", - [SI_BITRATE] = "bitrate", - [SI_FREQUENCY] = "frequency", - - [SI_FILE_SIZE] = "file_size", - [SI_STATUS_FLAGS] = "status_flags", - [SI_FORMAT] = "format", - - [SI_SCORE] = "score", - [SI_AUDIO_FILE_INFO] = "audio_file_info", - - [SI_TAG_INFO1] = "taginfo1", - [SI_TAG_INFO2] = "taginfo2", - [SI_AFS_MODE] = "afs_mode", - [SI_ATTRIBUTES_TXT] = "attributes_txt", - - [SI_DIRECTORY] = "dir", - [SI_DECODER_FLAGS] = "decoder_flags", - [SI_AUDIOD_STATUS] = "audiod_status", - - [SI_PLAY_TIME] = "play_time", - [SI_ATTRIBUTES_BITMAP] = "attributes_bitmap", - [SI_OFFSET] = "offset", - - [SI_SECONDS_TOTAL] = "seconds_total", - [SI_STREAM_START] = "stream_start", - [SI_CURRENT_TIME] = "current_time", - - [SI_AUDIOD_UPTIME] = "audiod_uptime", - [SI_IMAGE_ID] = "image_id", - [SI_LYRICS_ID] = "lyrics_id", - [SI_DURATION] = "duration" -}; +/** 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) { @@ -94,10 +67,11 @@ 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 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. @@ -105,7 +79,7 @@ static void dump_stat_client_list(void) * \return Positive value on success, or -E_TOO_MANY_CLIENTS if * the number of connected clients exceeds #MAX_STAT_CLIENTS. */ -int stat_client_add(int fd, long unsigned mask) +int stat_client_add(int fd, uint64_t mask, int parser_friendly) { struct stat_client *new_client; @@ -119,45 +93,47 @@ int stat_client_add(int fd, long unsigned mask) 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; 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 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 item_num 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(const char *msg, int itemnum) +void stat_client_write_item(int item_num) { struct stat_client *sc, *tmp; - size_t len = strlen(msg); - 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 || !len) + if (!initialized) return; list_for_each_entry_safe(sc, tmp, &client_list, node) { int fd = sc->fd, ret; - fd_set wfds; - if (!((1 << itemnum) & sc->item_mask)) + if (!((one << item_num) & 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) { - ret = write(fd, msg, len); - PARA_DEBUG_LOG("dumped %s to fd %d, ret = %d\n", msg, fd, ret); - if (ret == len ) + 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 */ @@ -168,13 +144,16 @@ void stat_client_write(const char *msg, int itemnum) free(sc); dump_stat_client_list(); } - PARA_DEBUG_LOG("%d client(s)\n", num_clients); + free(pb.buf); + free(pfpb.buf); +// 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. @@ -186,38 +165,75 @@ int stat_item_valid(const char *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; } +/** The minimal length of a status item buffer. */ +#define MIN_STAT_ITEM_LEN 9 /* 5 + 2 + 2, e.g. '0005 00:\n' */ + /** - * check if line starts with known status item. + * Call a function for each complete status item of a buffer. + * + * \param item_buf The source buffer. + * \param num_bytes The length of \a buf. + * \param item_handler Function to call for each complete item. * - * \param line buffer containing the line + * \return Negative on errors, the number of bytes _not_ passed to \a + * item_handler. * - * \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. + * Status items are expected in the format used by parser-friendly output mode + * of the stat command of para_client/para_audioc. */ -int stat_line_valid(const char *line) +int for_each_stat_item(char *item_buf, size_t num_bytes, + int (*item_handler)(int, char *)) { - int i; - size_t line_len; - - if (!line || !*line) - return -E_UNKNOWN_STAT_ITEM; - line_len = strlen(line); - FOR_EACH_STAT_ITEM(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; + char *buf = item_buf; + int len = num_bytes; + + for (;;) { + int i, ret, item_len, item_num = 0; + if (len < MIN_STAT_ITEM_LEN) + break; + 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); } - return -E_UNKNOWN_STAT_ITEM; + assert(len >= 0); + if (len && len != num_bytes) + memmove(item_buf, item_buf + num_bytes - len, len); + return len; } -