2 * Copyright (C) 2005-2007 Andre Noll <maan@systemlinux.org>
4 * Licensed under the GPL v2. For licencing details see COPYING.
8 * \file stat.c functions used for sending/receiving the status of para_server
13 #include <sys/types.h>
17 #include "close_on_fork.h"
23 /** the maximal number of simultaneous connections */
24 #define MAX_STAT_CLIENTS 50
27 * describes a status client of para_audiod
29 * There's one such structure per audiod client that sent the 'stat' command.
31 * A status client is identified by its file descriptor. para_audiod
32 * keeps a list of connected status clients.
35 /** the stat client's file descriptor */
37 /** bitmask of those status items the client is interested in */
38 long unsigned item_mask;
39 /** its entry in the list of stat clients */
40 struct list_head node;
43 static struct list_head client_list;
44 static int initialized;
45 static int num_clients;
47 /** The list of all status items used by para_server/para_audiod. */
48 const char *status_item_list[NUM_STAT_ITEMS] = {
49 [SI_BASENAME] = "basename",
50 [SI_STATUS] = "status",
51 [SI_NUM_PLAYED] = "num_played",
54 [SI_BITRATE] = "bitrate",
55 [SI_FREQUENCY] = "frequency",
57 [SI_FILE_SIZE] = "file_size",
58 [SI_STATUS_FLAGS] = "status_flags",
59 [SI_FORMAT] = "format",
62 [SI_AUDIO_FILE_INFO] = "audio_file_info",
64 [SI_TAG_INFO1] = "taginfo1",
65 [SI_TAG_INFO2] = "taginfo2",
66 [SI_AFS_MODE] = "afs_mode",
67 [SI_ATTRIBUTES_TXT] = "attributes_txt",
69 [SI_DIRECTORY] = "dir",
70 [SI_DECODER_FLAGS] = "decoder_flags",
71 [SI_AUDIOD_STATUS] = "audiod_status",
73 [SI_PLAY_TIME] = "play_time",
74 [SI_ATTRIBUTES_BITMAP] = "attributes_bitmap",
75 [SI_OFFSET] = "offset",
77 [SI_SECONDS_TOTAL] = "seconds_total",
78 [SI_STREAM_START] = "stream_start",
79 [SI_CURRENT_TIME] = "current_time",
81 [SI_AUDIOD_UPTIME] = "audiod_uptime",
82 [SI_IMAGE_ID] = "image_id",
83 [SI_LYRICS_ID] = "lyrics_id",
84 [SI_DURATION] = "duration"
87 static void dump_stat_client_list(void)
89 struct stat_client *sc;
93 list_for_each_entry(sc, &client_list, node)
94 PARA_INFO_LOG("stat client on fd %d\n", sc->fd);
97 * add a status client to the list
99 * \param fd the file descriptor of the client
100 * \param mask bitfield of status items for this client
102 * Only those status items having the bit set in \a mask will be
103 * sent to the client.
105 * \return Positive value on success, or -E_TOO_MANY_CLIENTS if
106 * the number of connected clients exceeds #MAX_STAT_CLIENTS.
108 int stat_client_add(int fd, long unsigned mask)
110 struct stat_client *new_client;
112 if (num_clients >= MAX_STAT_CLIENTS) {
113 PARA_ERROR_LOG("maximal number of stat clients (%d) exceeded\n",
115 return -E_TOO_MANY_CLIENTS;
118 INIT_LIST_HEAD(&client_list);
121 PARA_INFO_LOG("adding client on fd %d\n", fd);
122 new_client = para_malloc(sizeof(struct stat_client));
124 new_client->item_mask = mask;
125 para_list_add(&new_client->node, &client_list);
126 dump_stat_client_list();
131 * write a message to all connected status clients
133 * \param msg a \p NULL terminated buffer
134 * \param itemnum The number of the status item of \a msg
136 * On write errors, remove the status client from the client list and close its
139 void stat_client_write(const char *msg, int itemnum)
141 struct stat_client *sc, *tmp;
142 size_t len = strlen(msg);
143 struct timeval tv = {0 , 0};
145 if (!initialized || !len)
147 list_for_each_entry_safe(sc, tmp, &client_list, node) {
148 int fd = sc->fd, ret;
151 if (!((1 << itemnum) & sc->item_mask))
155 // PARA_DEBUG_LOG("%s: p=%lx\n", __func__, (long)p);
156 ret = para_select(fd + 1, NULL, &wfds, &tv);
158 ret = write(fd, msg, len);
159 PARA_DEBUG_LOG("dumped %s to fd %d, ret = %d\n", msg, fd, ret);
163 /* write error or fd not ready for writing */
166 PARA_INFO_LOG("deleting client on fd %d\n", fd);
169 dump_stat_client_list();
171 PARA_DEBUG_LOG("%d client(s)\n", num_clients);
175 * check if string is a known status item.
177 * \param item buffer containing the text to check
179 * \return If \a item is a valid status item, the number of that status item is
180 * returned. Otherwise, this function returns \p -E_UNKNOWN_STAT_ITEM.
182 int stat_item_valid(const char *item)
185 if (!item || !*item) {
186 PARA_ERROR_LOG("%s\n", "no item");
187 return -E_UNKNOWN_STAT_ITEM;
189 FOR_EACH_STAT_ITEM(i)
190 if (!strcmp(status_item_list[i], item))
192 PARA_ERROR_LOG("invalid stat item: %s\n", item);
193 return -E_UNKNOWN_STAT_ITEM;
197 * check if line starts with known status item.
199 * \param line buffer containing the line
201 * \return If the beginning of \a line matches any paraslash status item and is
202 * followed by a colon, the number of that status item is returned. Otherwise,
203 * this function returns \p -E_UNKNOWN_STAT_ITEM.
205 int stat_line_valid(const char *line)
211 return -E_UNKNOWN_STAT_ITEM;
212 line_len = strlen(line);
213 FOR_EACH_STAT_ITEM(i) {
214 const char *s = status_item_list[i];
215 size_t item_len = strlen(s);
217 if (line_len > item_len && line[item_len] == ':' &&
218 !strncmp(line, s, item_len))
221 return -E_UNKNOWN_STAT_ITEM;