manual: Mention that audio format handlers are part
[paraslash.git] / audioc.c
1 /*
2  * Copyright (C) 2005-2014 Andre Noll <maan@systemlinux.org>
3  *
4  * Licensed under the GPL v2. For licencing details see COPYING.
5  */
6
7 /** \file audioc.c The client program used to connect to para_audiod. */
8
9 #include <netinet/in.h>
10 #include <sys/socket.h>
11 #include <regex.h>
12 #include <sys/types.h>
13 #include <arpa/inet.h>
14 #include <sys/un.h>
15 #include <netdb.h>
16 #include <stdbool.h>
17 #include <signal.h>
18
19 #include "audioc.cmdline.h"
20 #include "para.h"
21 #include "error.h"
22 #include "net.h"
23 #include "string.h"
24 #include "fd.h"
25 #include "ggo.h"
26 #include "version.h"
27
28 INIT_AUDIOC_ERRLISTS;
29
30 /** The gengetopt structure containing command line args. */
31 static struct audioc_args_info conf;
32 static char *socket_name;
33
34
35 static int loglevel;
36 INIT_STDERR_LOGGING(loglevel);
37
38 static char *concat_args(unsigned argc, char * const *argv)
39 {
40         int i;
41         char *buf = NULL;
42
43         for (i = 0; i < argc; i++) {
44                 buf = para_strcat(buf, argv[i]);
45                 if (i != argc - 1)
46                         buf = para_strcat(buf, "\n");
47         }
48         return buf;
49 }
50
51 static int connect_audiod(const char *sname, char *args)
52 {
53         int fd = -1, ret;
54
55         ret = connect_local_socket(sname);
56         if (ret < 0)
57                 goto fail;
58         fd = ret;
59         ret = send_cred_buffer(fd, args);
60         if (ret < 0)
61                 goto fail;
62         return fd;
63 fail:
64         PARA_ERROR_LOG("could not connect %s\n", sname);
65         if (fd >= 0)
66                 close(fd);
67         return ret;
68 }
69
70 #ifdef HAVE_READLINE
71 #include "list.h"
72 #include "sched.h"
73 #include "buffer_tree.h"
74 #include "interactive.h"
75 #include "audiod_completion.h"
76
77 static struct sched sched;
78
79 struct audioc_task {
80         int fd;
81         struct btr_node *btrn;
82         struct task task;
83 };
84
85 static struct i9e_completer audiod_completers[];
86
87 I9E_DUMMY_COMPLETER(cycle);
88 I9E_DUMMY_COMPLETER(off);
89 I9E_DUMMY_COMPLETER(on);
90 I9E_DUMMY_COMPLETER(sb);
91 I9E_DUMMY_COMPLETER(tasks);
92 I9E_DUMMY_COMPLETER(term);
93
94 static void help_completer(struct i9e_completion_info *ci,
95                 struct i9e_completion_result *result)
96 {
97         result->matches = i9e_complete_commands(ci->word, audiod_completers);
98 }
99
100 static void version_completer(struct i9e_completion_info *ci,
101                 struct i9e_completion_result *cr)
102 {
103         char *opts[] = {"-v", NULL};
104
105         if (ci->word_num <= 2 && ci->word && ci->word[0] == '-')
106                 i9e_complete_option(opts, ci, cr);
107 }
108
109 static void stat_completer(struct i9e_completion_info *ci,
110                 struct i9e_completion_result *cr)
111 {
112         char *sia[] = {STATUS_ITEM_ARRAY NULL};
113         char *opts[] = {"-p", NULL};
114
115         if (ci->word_num <= 2 && ci->word && ci->word[0] == '-')
116                 i9e_complete_option(opts, ci, cr);
117         else
118                 i9e_extract_completions(ci->word, sia, &cr->matches);
119 }
120
121 static void grab_completer(struct i9e_completion_info *ci,
122                 struct i9e_completion_result *cr)
123 {
124         char *opts[] = {"-ms", "-ms", "-ma", "-p=", "-n=", "-o", NULL};
125         i9e_complete_option(opts, ci, cr);
126 }
127
128 static struct i9e_completer audiod_completers[] = {
129         AUDIOD_COMPLETERS
130         {.name = NULL}
131 };
132
133 static void audioc_pre_select(struct sched *s, struct task *t)
134 {
135         struct audioc_task *at = container_of(t, struct audioc_task, task);
136         int ret = btr_node_status(at->btrn, 0, BTR_NT_ROOT);
137
138         if (ret < 0)
139                 sched_min_delay(s);
140         para_fd_set(at->fd, &s->rfds, &s->max_fileno);
141 }
142
143 static int audioc_post_select(struct sched *s, struct task *t)
144 {
145         char *buf = NULL;
146         struct audioc_task *at = container_of(t, struct audioc_task, task);
147         int ret = btr_node_status(at->btrn, 0, BTR_NT_ROOT);
148
149         if (ret < 0)
150                 goto out;
151         if (!FD_ISSET(at->fd, &s->rfds))
152                 return 0;
153         buf = para_malloc(conf.bufsize_arg);
154         ret = recv_bin_buffer(at->fd, buf, conf.bufsize_arg);
155         PARA_DEBUG_LOG("recv: %d\n", ret);
156         if (ret == 0)
157                 ret = -E_AUDIOC_EOF;
158         if (ret < 0)
159                 goto out;
160         btr_add_output(buf, ret, at->btrn);
161         return 0;
162 out:
163         if (ret < 0) {
164                 free(buf);
165                 btr_remove_node(&at->btrn);
166                 close(at->fd);
167         }
168         return ret;
169 }
170
171 static struct audioc_task audioc_task = {
172         .task = {
173                 .pre_select = audioc_pre_select,
174                 .post_select = audioc_post_select,
175                 .status = "audioc task"
176         },
177 }, *at = &audioc_task;
178
179 static int audioc_i9e_line_handler(char *line)
180 {
181         char *args = NULL;
182         int ret;
183
184         PARA_DEBUG_LOG("line: %s\n", line);
185         ret = create_argv(line, " ", &conf.inputs);
186         if (ret < 0)
187                 return ret;
188         conf.inputs_num = ret;
189         args = concat_args(conf.inputs_num, conf.inputs);
190         free_argv(conf.inputs);
191         if (!args)
192                 return 0;
193         conf.inputs_num = 0; /* required for audioc_cmdline_parser_free() */
194         ret = connect_audiod(socket_name, args);
195         if (ret < 0)
196                 goto out;
197         at->fd = ret;
198         ret = mark_fd_nonblocking(at->fd);
199         if (ret < 0)
200                 goto close;
201         free(args);
202         args = NULL;
203         at->btrn = btr_new_node(&(struct btr_node_description)
204                 EMBRACE(.name = "audioc line handler"));
205         at->task.error = 0;
206         register_task(&sched, &at->task);
207         i9e_attach_to_stdout(at->btrn);
208         return 1;
209 close:
210         close(at->fd);
211 out:
212         free(args);
213         return ret;
214 }
215
216 __noreturn static void interactive_session(void)
217 {
218         int ret;
219         char *history_file;
220         struct sigaction act;
221         struct i9e_client_info ici = {
222                 .fds = {0, 1, 2},
223                 .prompt = "para_audioc> ",
224                 .line_handler = audioc_i9e_line_handler,
225                 .loglevel = loglevel,
226                 .completers = audiod_completers,
227         };
228         PARA_NOTICE_LOG("\n%s\n", version_text("audioc"));
229         if (conf.history_file_given)
230                 history_file = para_strdup(conf.history_file_arg);
231         else {
232                 char *home = para_homedir();
233                 history_file = make_message("%s/.paraslash/audioc.history",
234                         home);
235                 free(home);
236         }
237         ici.history_file = history_file;
238
239         act.sa_handler = i9e_signal_dispatch;
240         sigemptyset(&act.sa_mask);
241         act.sa_flags = 0;
242         sigaction(SIGINT, &act, NULL);
243         sched.select_function = i9e_select;
244
245         sched.default_timeout.tv_sec = 1;
246         ret = i9e_open(&ici, &sched);
247         if (ret < 0)
248                 goto out;
249         para_log = i9e_log;
250         ret = schedule(&sched);
251         i9e_close();
252         para_log = stderr_log;
253 out:
254         free(history_file);
255         audioc_cmdline_parser_free(&conf);
256         if (ret < 0)
257                 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
258         exit(ret < 0? EXIT_FAILURE : EXIT_SUCCESS);
259 }
260
261 __noreturn static void print_completions(void)
262 {
263         int ret = i9e_print_completions(audiod_completers);
264         exit(ret <= 0? EXIT_FAILURE : EXIT_SUCCESS);
265 }
266
267 #else /* HAVE_READLINE */
268
269 __noreturn static void interactive_session(void)
270 {
271         PARA_EMERG_LOG("interactive sessions not available\n");
272         exit(EXIT_FAILURE);
273 }
274
275 __noreturn static void print_completions(void)
276 {
277         PARA_EMERG_LOG("command completion not available\n");
278         exit(EXIT_FAILURE);
279 }
280
281 #endif /* HAVE_READLINE */
282
283 static char *configfile_exists(void)
284 {
285         char *config_file;
286         struct stat statbuf;
287         char *home = para_homedir();
288
289         config_file = make_message("%s/.paraslash/audioc.conf", home);
290         free(home);
291         if (!stat(config_file, &statbuf))
292                 return config_file;
293         free(config_file);
294         return NULL;
295 }
296
297 __noreturn static void print_help_and_die(void)
298 {
299         struct ggo_help h = DEFINE_GGO_HELP(audioc);
300         bool d = conf.detailed_help_given;
301
302         ggo_print_help(&h, d? GPH_STANDARD_FLAGS_DETAILED : GPH_STANDARD_FLAGS);
303         exit(0);
304 }
305
306 /**
307  * The client program to connect to para_audiod.
308  *
309  * \param argc Usual argument count.
310  * \param argv Usual argument vector.
311  *
312  * It connects to the "well-known" local socket to communicate with
313  * para_audiod. Authentication is performed by sending a ucred buffer
314  * containing the user id to the local socket.
315  *
316  * Any data received from the socket is written to stdout.
317  *
318  * \return EXIT_SUCCESS or EXIT_FAILURE.
319  *
320  * \sa send_cred_buffer(), para_audioc(1), para_audiod(1).
321  */
322 int main(int argc, char *argv[])
323 {
324         int ret, fd;
325         char *cf, *buf = NULL, *args = NULL;
326         size_t bufsize;
327
328         audioc_cmdline_parser(argc, argv, &conf);
329         loglevel = get_loglevel_by_name(conf.loglevel_arg);
330         version_handle_flag("audioc", conf.version_given);
331         if (conf.help_given || conf.detailed_help_given)
332                 print_help_and_die();
333         cf = configfile_exists();
334         if (cf) {
335                 struct audioc_cmdline_parser_params params = {
336                         .override = 0,
337                         .initialize = 0,
338                         .check_required = 0,
339                         .check_ambiguity = 0,
340                         .print_errors = 1,
341
342                 };
343                 audioc_cmdline_parser_config_file(cf, &conf, &params);
344                 free(cf);
345                 loglevel = get_loglevel_by_name(conf.loglevel_arg);
346         }
347         if (conf.socket_given)
348                 socket_name = para_strdup(conf.socket_arg);
349         else {
350                 char *hn = para_hostname();
351                 socket_name = make_message("/var/paraslash/audiod_socket.%s",
352                         hn);
353                 free(hn);
354         }
355
356         if (conf.complete_given)
357                 print_completions();
358
359         if (conf.inputs_num == 0)
360                 interactive_session();
361         args = concat_args(conf.inputs_num, conf.inputs);
362
363         ret = connect_audiod(socket_name, args);
364         free(socket_name);
365         if (ret < 0)
366                 goto out;
367         fd = ret;
368         ret = mark_fd_blocking(STDOUT_FILENO);
369         if (ret < 0)
370                 goto out;
371         bufsize = conf.bufsize_arg;
372         buf = para_malloc(bufsize);
373         do {
374                 size_t n = ret = recv_bin_buffer(fd, buf, bufsize);
375                 if (ret <= 0)
376                         break;
377                 ret = write_all(STDOUT_FILENO, buf, n);
378         } while (ret >= 0);
379 out:
380         free(buf);
381         free(args);
382         if (ret < 0)
383                 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
384         return ret < 0? EXIT_FAILURE : EXIT_SUCCESS;
385 }