2 * Copyright (C) 2005-2006 Andre Noll <maan@systemlinux.org>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
20 * \file stat.c functions used for sending/receiving the status of para_server
24 #include "close_on_fork.h"
29 /** the maximal number of simultaneous connections */
30 #define MAX_STAT_CLIENTS 50
33 * The structure associated with a connected client that sent the 'stat' command
36 * A status client is identified by its file descriptor. para_audiod
37 * keeps a list of connected status clients.
43 * the stat client's file descriptor
46 long unsigned item_mask;
49 * its entry in the list of stat clients
51 struct list_head node;
54 static struct list_head client_list;
55 static int initialized;
56 static int num_clients;
59 * the list of all status items sent by para_server/para_audiod
61 const char *status_item_list[NUM_STAT_ITEMS] = {
62 [SI_STATUS_BAR] = "status_bar",
63 [SI_STATUS] = "status",
64 [SI_NUM_PLAYED] = "num_played",
67 [SI_LENGTH_MIN] = "length_min",
68 [SI_LENGTH_SEC] = "length_sec",
70 [SI_FILE_SIZE] = "file_size",
71 [SI_STATUS_FLAGS] = "status_flags",
72 [SI_FORMAT] = "format",
75 [SI_AUDIO_INFO1] = "audio_file_info1",
76 [SI_AUDIO_INFO2] = "audio_file_info2",
78 [SI_AUDIO_INFO3] = "audio_file_info3",
79 [SI_DBINFO1] = "dbinfo1",
80 [SI_DBINFO2] = "dbinfo2",
82 [SI_DBINFO3] = "dbinfo3",
83 [SI_DECODER_FLAGS] = "decoder_flags",
84 [SI_AUDIOD_STATUS] = "audiod_status",
86 [SI_PLAY_TIME] = "play_time",
87 [SI_UPTIME] = "uptime",
88 [SI_OFFSET] = "offset",
90 [SI_LENGTH] = "length",
91 [SI_STREAM_START] = "stream_start",
92 [SI_CURRENT_TIME] = "current_time",
94 [SI_AUDIOD_UPTIME] = "audiod_uptime",
95 [SI_SELECTOR] = "dbtool"
97 #define FOR_EACH_STAT_ITEM(i) for (i = 0; i < NUM_STAT_ITEMS; i++)
99 static void dump_stat_client_list(void)
101 struct stat_client *sc;
105 list_for_each_entry(sc, &client_list, node)
106 PARA_INFO_LOG("stat client on fd %d\n", sc->fd);
109 * add a status client to the list
111 * \return Positive value on success, or -E_TOO_MANY_CLIENTS if
112 * the number of connected clients exceeds #MAX_STAT_CLIENTS
114 int stat_client_add(int fd, long unsigned mask)
116 struct stat_client *new_client;
118 if (num_clients >= MAX_STAT_CLIENTS) {
119 PARA_ERROR_LOG("maximal number of stat clients (%d) exceeded\n",
121 return -E_TOO_MANY_CLIENTS;
124 INIT_LIST_HEAD(&client_list);
127 PARA_INFO_LOG("adding client on fd %d\n", fd);
128 new_client = para_malloc(sizeof(struct stat_client));
130 new_client->item_mask = mask;
131 add_close_on_fork_list(fd);
132 list_add(&new_client->node, &client_list);
133 dump_stat_client_list();
138 * write a message to all connected status clients
140 * \param msg a \p NULL terminated buffer
141 * \param itemnum The number of the status item of \a msg
143 * On write errors, remove the status client from the client list and close its
146 void stat_client_write(char *msg, int itemnum)
148 struct stat_client *sc, *tmp;
150 struct timeval tv = {0 , 0};
155 list_for_each_entry_safe(sc, tmp, &client_list, node) {
156 int fd = sc->fd, ret;
159 if (!((1 << itemnum) & sc->item_mask))
163 // PARA_DEBUG_LOG("%s: p=%lx\n", __func__, (long)p);
165 ret = select(fd + 1, NULL, &wfds, NULL, &tv);
166 while (ret < 0 && errno == EINTR);
168 ret = write(fd, msg, len);
169 PARA_DEBUG_LOG("dumped %s to fd %d, ret = %d\n", msg, fd, ret);
173 /* write error or fd not ready for writing */
175 del_close_on_fork_list(fd);
177 PARA_INFO_LOG("deleting client on fd %d\n", fd);
180 dump_stat_client_list();
182 PARA_DEBUG_LOG("%d client(s)\n", num_clients);
186 * send empty status list
188 * Send to each connected client the full status item list
191 void dump_empty_status(void)
197 FOR_EACH_STAT_ITEM(i) {
198 char *tmp = make_message("%s:\n", status_item_list[i]);
199 stat_client_write(tmp, i);
205 * check if string is a known status item.
207 * \param item buffer containing the text to check
209 * \return If \a item is a valid status item, the number of that status item is
210 * returned. Otherwise, this function returns \p -E_UNKNOWN_STAT_ITEM.
212 int stat_item_valid(const char *item)
216 return -E_UNKNOWN_STAT_ITEM;
217 FOR_EACH_STAT_ITEM(i)
218 if (!strcmp(status_item_list[i], item))
220 return -E_UNKNOWN_STAT_ITEM;
224 * check if line starts with known status item.
226 * \param line buffer containing the line
228 * \return If the beginning of \a line matches any paraslash status item and is
229 * followed by a colon, the number of that status item is returned. Otherwise,
230 * this function returns \p -E_UNKNOWN_STAT_ITEM.
232 int stat_line_valid(const char *line)
238 return -E_UNKNOWN_STAT_ITEM;
239 line_len = strlen(line);
240 FOR_EACH_STAT_ITEM(i) {
241 const char *s = status_item_list[i];
242 size_t item_len = strlen(s);
244 if (line_len > item_len && line[item_len] == ':' &&
245 !strncmp(line, s, item_len))
248 return -E_UNKNOWN_STAT_ITEM;
252 * call a custom function for each complete line
254 * \param buf the buffer containing data seperated by newlines
255 * \param n the number of bytes in \a buf
256 * \param line_handler the custom function
258 * If \a line_handler is \p NULL, return number of complete lines in buf.
259 * Otherwise, call \a line_handler for each complete line. The rest of the
260 * buffer (last chunk containing incomplete line is moved to the beginning of
263 * \return If line_handler is not NULL, this function returns the number
264 * of bytes not handled to \a line_handler.
266 unsigned for_each_line(char *buf, int n, void (*line_handler)(char *))
268 char *start = buf, *end;
269 int i, num_lines = 0;
271 while (start < buf + n) {
275 next_cr = memchr(start, '\n', buf + n - start);
276 next_null = memchr(start, '\0', buf + n - start);
277 if (!next_cr && !next_null)
279 if (next_cr && next_null) {
280 end = next_cr < next_null? next_cr : next_null;
281 } else if (next_null) {
297 memmove(buf, start, i);