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"
30 /** the maximal number of simultaneous connections */
31 #define MAX_STAT_CLIENTS 50
34 * The structure associated with a connected client that sent the 'stat' command
37 * A status client is identified by its file descriptor. para_audiod
38 * keeps a list of connected status clients.
44 * the stat client's file descriptor
47 long unsigned item_mask;
50 * its entry in the list of stat clients
52 struct list_head node;
55 static struct list_head client_list;
56 static int initialized;
57 static int num_clients;
60 * the list of all status items sent by para_server/para_audiod
62 const char *status_item_list[NUM_STAT_ITEMS] = {
63 [SI_STATUS_BAR] = "status_bar",
64 [SI_STATUS] = "status",
65 [SI_NUM_PLAYED] = "num_played",
68 [SI_LENGTH_MIN] = "length_min",
69 [SI_LENGTH_SEC] = "length_sec",
71 [SI_FILE_SIZE] = "file_size",
72 [SI_STATUS_FLAGS] = "status_flags",
73 [SI_FORMAT] = "format",
76 [SI_AUDIO_INFO1] = "audio_file_info1",
77 [SI_AUDIO_INFO2] = "audio_file_info2",
79 [SI_AUDIO_INFO3] = "audio_file_info3",
80 [SI_DBINFO1] = "dbinfo1",
81 [SI_DBINFO2] = "dbinfo2",
83 [SI_DBINFO3] = "dbinfo3",
84 [SI_DECODER_FLAGS] = "decoder_flags",
85 [SI_AUDIOD_STATUS] = "audiod_status",
87 [SI_PLAY_TIME] = "play_time",
88 [SI_UPTIME] = "uptime",
89 [SI_OFFSET] = "offset",
91 [SI_LENGTH] = "length",
92 [SI_STREAM_START] = "stream_start",
93 [SI_CURRENT_TIME] = "current_time",
95 [SI_AUDIOD_UPTIME] = "audiod_uptime",
96 [SI_SELECTOR] = "dbtool"
98 #define FOR_EACH_STAT_ITEM(i) for (i = 0; i < NUM_STAT_ITEMS; i++)
100 static void dump_stat_client_list(void)
102 struct stat_client *sc;
106 list_for_each_entry(sc, &client_list, node)
107 PARA_INFO_LOG("stat client on fd %d\n", sc->fd);
110 * add a status client to the list
112 * \return Positive value on success, or -E_TOO_MANY_CLIENTS if
113 * the number of connected clients exceeds #MAX_STAT_CLIENTS
115 int stat_client_add(int fd, long unsigned mask)
117 struct stat_client *new_client;
119 if (num_clients >= MAX_STAT_CLIENTS) {
120 PARA_ERROR_LOG("maximal number of stat clients (%d) exceeded\n",
122 return -E_TOO_MANY_CLIENTS;
125 INIT_LIST_HEAD(&client_list);
128 PARA_INFO_LOG("adding client on fd %d\n", fd);
129 new_client = para_malloc(sizeof(struct stat_client));
131 new_client->item_mask = mask;
132 add_close_on_fork_list(fd);
133 list_add(&new_client->node, &client_list);
134 dump_stat_client_list();
139 * write a message to all connected status clients
141 * \param msg a \p NULL terminated buffer
142 * \param itemnum The number of the status item of \a msg
144 * On write errors, remove the status client from the client list and close its
147 void stat_client_write(char *msg, int itemnum)
149 struct stat_client *sc, *tmp;
151 struct timeval tv = {0 , 0};
156 list_for_each_entry_safe(sc, tmp, &client_list, node) {
157 int fd = sc->fd, ret;
160 if (!((1 << itemnum) & sc->item_mask))
164 // PARA_DEBUG_LOG("%s: p=%lx\n", __func__, (long)p);
165 ret = para_select(fd + 1, NULL, &wfds, &tv);
167 ret = write(fd, msg, len);
168 PARA_DEBUG_LOG("dumped %s to fd %d, ret = %d\n", msg, fd, ret);
172 /* write error or fd not ready for writing */
174 del_close_on_fork_list(fd);
176 PARA_INFO_LOG("deleting client on fd %d\n", fd);
179 dump_stat_client_list();
181 PARA_DEBUG_LOG("%d client(s)\n", num_clients);
185 * send empty status list
187 * Send to each connected client the full status item list
190 void dump_empty_status(void)
196 FOR_EACH_STAT_ITEM(i) {
197 char *tmp = make_message("%s:\n", status_item_list[i]);
198 stat_client_write(tmp, i);
204 * check if string is a known status item.
206 * \param item buffer containing the text to check
208 * \return If \a item is a valid status item, the number of that status item is
209 * returned. Otherwise, this function returns \p -E_UNKNOWN_STAT_ITEM.
211 int stat_item_valid(const char *item)
214 if (!item || !*item) {
215 PARA_ERROR_LOG("%s\n", "no item");
216 return -E_UNKNOWN_STAT_ITEM;
218 FOR_EACH_STAT_ITEM(i)
219 if (!strcmp(status_item_list[i], item))
221 return -E_UNKNOWN_STAT_ITEM;
225 * check if line starts with known status item.
227 * \param line buffer containing the line
229 * \return If the beginning of \a line matches any paraslash status item and is
230 * followed by a colon, the number of that status item is returned. Otherwise,
231 * this function returns \p -E_UNKNOWN_STAT_ITEM.
233 int stat_line_valid(const char *line)
239 return -E_UNKNOWN_STAT_ITEM;
240 line_len = strlen(line);
241 FOR_EACH_STAT_ITEM(i) {
242 const char *s = status_item_list[i];
243 size_t item_len = strlen(s);
245 if (line_len > item_len && line[item_len] == ':' &&
246 !strncmp(line, s, item_len))
249 return -E_UNKNOWN_STAT_ITEM;
253 * call a custom function for each complete line
255 * \param buf the buffer containing data seperated by newlines
256 * \param n the number of bytes in \a buf
257 * \param line_handler the custom function
259 * If \a line_handler is \p NULL, return number of complete lines in buf.
260 * Otherwise, call \a line_handler for each complete line. The rest of the
261 * buffer (last chunk containing incomplete line is moved to the beginning of
264 * \return If line_handler is not NULL, this function returns the number
265 * of bytes not handled to \a line_handler.
267 unsigned for_each_line(char *buf, int n, void (*line_handler)(char *))
269 char *start = buf, *end;
270 int i, num_lines = 0;
272 // PARA_INFO_LOG("buf: %s", buf);
273 while (start < buf + n) {
277 next_cr = memchr(start, '\n', buf + n - start);
278 next_null = memchr(start, '\0', buf + n - start);
279 if (!next_cr && !next_null)
281 if (next_cr && next_null) {
282 end = next_cr < next_null? next_cr : next_null;
283 } else if (next_null) {
290 // PARA_INFO_LOG("calling line handler: %s\n", start);
300 memmove(buf, start, i);