chiark / gitweb /
remove become from client; more docs updates
[disorder] / clients / disorder.c
1 /*
2  * This file is part of DisOrder.
3  * Copyright (C) 2004, 2005, 2006, 2007 Richard Kettlewell
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
18  * USA
19  */
20
21 #include <config.h>
22 #include "types.h"
23
24 #include <getopt.h>
25 #include <sys/types.h>
26 #include <sys/socket.h>
27 #include <sys/un.h>
28 #include <stdio.h>
29 #include <errno.h>
30 #include <stdlib.h>
31 #include <string.h>
32 #include <locale.h>
33 #include <time.h>
34 #include <stddef.h>
35 #include <unistd.h>
36 #include <assert.h>
37 #include <pcre.h>
38 #include <ctype.h>
39
40 #include "configuration.h"
41 #include "syscalls.h"
42 #include "log.h"
43 #include "queue.h"
44 #include "client.h"
45 #include "wstat.h"
46 #include "table.h"
47 #include "charset.h"
48 #include "kvp.h"
49 #include "split.h"
50 #include "sink.h"
51 #include "plugin.h"
52 #include "mem.h"
53 #include "defs.h"
54 #include "authorize.h"
55 #include "vector.h"
56
57 static int auto_reconfigure;
58
59 static const struct option options[] = {
60   { "help", no_argument, 0, 'h' },
61   { "version", no_argument, 0, 'V' },
62   { "config", required_argument, 0, 'c' },
63   { "debug", no_argument, 0, 'd' },
64   { "local", no_argument, 0, 'l' },
65   { "no-per-user-config", no_argument, 0, 'N' },
66   { "help-commands", no_argument, 0, 'H' },
67   { "user", required_argument, 0, 'u' },
68   { "password", required_argument, 0, 'p' },
69   { 0, 0, 0, 0 }
70 };
71
72 /* display usage message and terminate */
73 static void help(void) {
74   xprintf("Usage:\n"
75           "  disorder [OPTIONS] COMMAND ...\n"
76           "Options:\n"
77           "  --help, -h              Display usage message\n"
78           "  --help-commands, -H     List commands\n"
79           "  --version, -V           Display version number\n"
80           "  --config PATH, -c PATH  Set configuration file\n"
81           "  --local, -l             Force connection to local server\n"
82           "  --debug, -d             Turn on debugging\n");
83   xfclose(stdout);
84   exit(0);
85 }
86
87 /* display version number and terminate */
88 static void version(void) {
89   xprintf("%s", disorder_version_string);
90   xfclose(stdout);
91   exit(0);
92 }
93
94 static void cf_version(disorder_client *c,
95                        char attribute((unused)) **argv) {
96   char *v;
97
98   if(disorder_version(c, &v)) exit(EXIT_FAILURE);
99   xprintf("%s\n", nullcheck(utf82mb(v)));
100 }
101
102 static void print_queue_entry(const struct queue_entry *q) {
103   if(q->track) xprintf("track %s\n", nullcheck(utf82mb(q->track)));
104   if(q->id) xprintf("  id %s\n", nullcheck(utf82mb(q->id)));
105   if(q->submitter) xprintf("  submitted by %s at %s",
106                            nullcheck(utf82mb(q->submitter)), ctime(&q->when));
107   if(q->played) xprintf("  played at %s", ctime(&q->played));
108   if(q->state == playing_started
109      || q->state == playing_paused) xprintf("  %lds so far",  q->sofar);
110   else if(q->expected) xprintf("  might start at %s", ctime(&q->expected));
111   if(q->scratched) xprintf("  scratched by %s\n",
112                            nullcheck(utf82mb(q->scratched)));
113   else xprintf("  %s\n", playing_states[q->state]);
114   if(q->wstat) xprintf("  %s\n", wstat(q->wstat));
115 }
116
117 static void cf_playing(disorder_client *c,
118                        char attribute((unused)) **argv) {
119   struct queue_entry *q;
120
121   if(disorder_playing(c, &q)) exit(EXIT_FAILURE);
122   if(q)
123     print_queue_entry(q);
124   else
125     xprintf("nothing\n");
126 }
127
128 static void cf_play(disorder_client *c, char **argv) {
129   while(*argv)
130     if(disorder_play(c, *argv++)) exit(EXIT_FAILURE);
131 }
132
133 static void cf_remove(disorder_client *c, char **argv) {
134   if(disorder_remove(c, argv[0])) exit(EXIT_FAILURE);
135 }
136
137 static void cf_disable(disorder_client *c,
138                        char attribute((unused)) **argv) {
139   if(disorder_disable(c)) exit(EXIT_FAILURE);
140 }
141
142 static void cf_enable(disorder_client *c, char attribute((unused)) **argv) {
143   if(disorder_enable(c)) exit(EXIT_FAILURE);
144 }
145
146 static void cf_scratch(disorder_client *c,
147                        char **argv) {
148   if(disorder_scratch(c, argv[0])) exit(EXIT_FAILURE);
149 }
150
151 static void cf_shutdown(disorder_client *c,
152                         char attribute((unused)) **argv) {
153   if(disorder_shutdown(c)) exit(EXIT_FAILURE);
154 }
155
156 static void cf_reconfigure(disorder_client *c,
157                            char attribute((unused)) **argv) {
158   /* Re-check configuration for server */
159   if(config_read(1)) fatal(0, "cannot read configuration");
160   if(disorder_reconfigure(c)) exit(EXIT_FAILURE);
161 }
162
163 static void cf_rescan(disorder_client *c, char attribute((unused)) **argv) {
164   if(disorder_rescan(c)) exit(EXIT_FAILURE);
165 }
166
167 static void cf_somequeue(disorder_client *c,
168                          int (*fn)(disorder_client *c,
169                                    struct queue_entry **qp)) {
170   struct queue_entry *q;
171
172   if(fn(c, &q)) exit(EXIT_FAILURE);
173   while(q) {
174     print_queue_entry(q);
175     q = q->next;
176   }
177 }
178
179 static void cf_recent(disorder_client *c, char attribute((unused)) **argv) {
180   cf_somequeue(c, disorder_recent);
181 }
182
183 static void cf_queue(disorder_client *c, char attribute((unused)) **argv) {
184   cf_somequeue(c, disorder_queue);
185 }
186
187 static void cf_quack(disorder_client attribute((unused)) *c,
188                      char attribute((unused)) **argv) {
189   xprintf("\n"
190           " .------------------.\n"
191           " | Naath is a babe! |\n"
192           " `---------+--------'\n"
193           "            \\\n"
194           "              >0\n"
195           "               (<)'\n"
196           "~~~~~~~~~~~~~~~~~~~~~~\n"
197           "\n");
198 }
199
200 static void cf_somelist(disorder_client *c, char **argv,
201                         int (*fn)(disorder_client *c,
202                                   const char *arg, const char *re,
203                                   char ***vecp, int *nvecp)) {
204   char **vec;
205   const char *re;
206
207   if(argv[1])
208     re = xstrdup(argv[1] + 1);
209   else
210     re = 0;
211   if(fn(c, argv[0], re, &vec, 0)) exit(EXIT_FAILURE);
212   while(*vec)
213     xprintf("%s\n", nullcheck(utf82mb(*vec++)));
214 }
215
216 static int isarg_regexp(const char *s) {
217   return s[0] == '~';
218 }
219
220 static void cf_dirs(disorder_client *c,
221                     char **argv) {
222   cf_somelist(c, argv, disorder_directories);
223 }
224
225 static void cf_files(disorder_client *c, char **argv) {
226   cf_somelist(c, argv, disorder_files);
227 }
228
229 static void cf_allfiles(disorder_client *c, char **argv) {
230   cf_somelist(c, argv, disorder_allfiles);
231 }
232
233 static void cf_get(disorder_client *c, char **argv) {
234   char *value;
235
236   if(disorder_get(c, argv[0], argv[1], &value)) exit(EXIT_FAILURE);
237   xprintf("%s\n", nullcheck(utf82mb(value)));
238 }
239
240 static void cf_length(disorder_client *c, char **argv) {
241   long length;
242
243   if(disorder_length(c, argv[0], &length)) exit(EXIT_FAILURE);
244   xprintf("%ld\n", length);
245 }
246
247 static void cf_set(disorder_client *c, char **argv) {
248   if(disorder_set(c, argv[0], argv[1], argv[2])) exit(EXIT_FAILURE);
249 }
250
251 static void cf_unset(disorder_client *c, char **argv) {
252   if(disorder_unset(c, argv[0], argv[1])) exit(EXIT_FAILURE);
253 }
254
255 static void cf_prefs(disorder_client *c, char **argv) {
256   struct kvp *k;
257
258   if(disorder_prefs(c, argv[0], &k)) exit(EXIT_FAILURE);
259   for(; k; k = k->next)
260     xprintf("%s = %s\n",
261             nullcheck(utf82mb(k->name)), nullcheck(utf82mb(k->value)));
262 }
263
264 static void cf_search(disorder_client *c, char **argv) {
265   char **results;
266   int nresults, n;
267
268   if(disorder_search(c, *argv, &results, &nresults)) exit(EXIT_FAILURE);
269   for(n = 0; n < nresults; ++n)
270     xprintf("%s\n", nullcheck(utf82mb(results[n])));
271 }
272
273 static void cf_random_disable(disorder_client *c,
274                               char attribute((unused)) **argv) {
275   if(disorder_random_disable(c)) exit(EXIT_FAILURE);
276 }
277
278 static void cf_random_enable(disorder_client *c,
279                              char attribute((unused)) **argv) {
280   if(disorder_random_enable(c)) exit(EXIT_FAILURE);
281 }
282
283 static void cf_stats(disorder_client *c,
284                      char attribute((unused)) **argv) {
285   char **vec;
286
287   if(disorder_stats(c, &vec, 0)) exit(EXIT_FAILURE);
288   while(*vec)
289       xprintf("%s\n", nullcheck(utf82mb(*vec++)));
290 }
291
292 static void cf_get_volume(disorder_client *c,
293                           char attribute((unused)) **argv) {
294   int l, r;
295
296   if(disorder_get_volume(c, &l, &r)) exit(EXIT_FAILURE);
297   xprintf("%d %d\n", l, r);
298 }
299
300 static void cf_set_volume(disorder_client *c,
301                           char **argv) {
302   if(disorder_set_volume(c, atoi(argv[0]), atoi(argv[1]))) exit(EXIT_FAILURE);
303 }
304
305 static void cf_log(disorder_client *c,
306                    char attribute((unused)) **argv) {
307   if(disorder_log(c, sink_stdio("stdout", stdout))) exit(EXIT_FAILURE);
308 }
309
310 static void cf_move(disorder_client *c,
311                    char **argv) {
312   long n;
313   int e;
314   
315   if((e = xstrtol(&n, argv[1], 0, 10)))
316     fatal(e, "cannot convert '%s'", argv[1]);
317   if(n > INT_MAX || n < INT_MIN)
318     fatal(e, "%ld out of range", n);
319   if(disorder_move(c, argv[0], (int)n)) exit(EXIT_FAILURE);
320 }
321
322 static void cf_part(disorder_client *c,
323                     char **argv) {
324   char *s;
325
326   if(disorder_part(c, &s, argv[0], argv[1], argv[2])) exit(EXIT_FAILURE);
327   xprintf("%s\n", nullcheck(utf82mb(s)));
328 }
329
330 static int isarg_filename(const char *s) {
331   return s[0] == '/';
332 }
333
334 static void cf_authorize(disorder_client *c,
335                          char **argv) {
336   if(!authorize(c, argv[0]))
337     auto_reconfigure = 1;
338 }
339
340 static void cf_resolve(disorder_client *c,
341                        char **argv) {
342   char *track;
343
344   if(disorder_resolve(c, &track, argv[0])) exit(EXIT_FAILURE);
345   xprintf("%s\n", nullcheck(utf82mb(track)));
346 }
347
348 static void cf_pause(disorder_client *c,
349                         char attribute((unused)) **argv) {
350   if(disorder_pause(c)) exit(EXIT_FAILURE);
351 }
352
353 static void cf_resume(disorder_client *c,
354                         char attribute((unused)) **argv) {
355   if(disorder_resume(c)) exit(EXIT_FAILURE);
356 }
357
358 static void cf_tags(disorder_client *c,
359                      char attribute((unused)) **argv) {
360   char **vec;
361
362   if(disorder_tags(c, &vec, 0)) exit(EXIT_FAILURE);
363   while(*vec)
364       xprintf("%s\n", nullcheck(utf82mb(*vec++)));
365 }
366
367 static void cf_users(disorder_client *c,
368                      char attribute((unused)) **argv) {
369   char **vec;
370
371   if(disorder_users(c, &vec, 0)) exit(EXIT_FAILURE);
372   while(*vec)
373     xprintf("%s\n", nullcheck(utf82mb(*vec++)));
374 }
375
376 static void cf_get_global(disorder_client *c, char **argv) {
377   char *value;
378
379   if(disorder_get_global(c, argv[0], &value)) exit(EXIT_FAILURE);
380   xprintf("%s\n", nullcheck(utf82mb(value)));
381 }
382
383 static void cf_set_global(disorder_client *c, char **argv) {
384   if(disorder_set_global(c, argv[0], argv[1])) exit(EXIT_FAILURE);
385 }
386
387 static void cf_unset_global(disorder_client *c, char **argv) {
388   if(disorder_unset_global(c, argv[0])) exit(EXIT_FAILURE);
389 }
390
391 static int isarg_integer(const char *s) {
392   if(!*s) return 0;
393   while(*s) {
394     if(!isdigit((unsigned char)*s))
395       return 0;
396     ++s;
397   }
398   return 1;
399 }
400
401 static void cf_new(disorder_client *c,
402                    char **argv) {
403   char **vec;
404
405   if(disorder_new_tracks(c, &vec, 0, argv[0] ? atoi(argv[0]) : 0))
406     exit(EXIT_FAILURE);
407   while(*vec)
408     xprintf("%s\n", nullcheck(utf82mb(*vec++)));
409 }
410
411 static void cf_rtp_address(disorder_client *c,
412                            char attribute((unused)) **argv) {
413   char *address, *port;
414
415   if(disorder_rtp_address(c, &address, &port)) exit(EXIT_FAILURE);
416   xprintf("address: %s\nport: %s\n", address, port);
417 }
418
419 static void cf_adduser(disorder_client *c,
420                        char **argv) {
421   if(disorder_adduser(c, argv[0], argv[1]))
422     exit(EXIT_FAILURE);
423 }
424
425 static void cf_deluser(disorder_client *c,
426                        char **argv) {
427   if(disorder_deluser(c, argv[0]))
428     exit(EXIT_FAILURE);
429 }
430
431 static void cf_edituser(disorder_client *c,
432                         char **argv) {
433   if(disorder_edituser(c, argv[0], argv[1], argv[2]))
434     exit(EXIT_FAILURE);
435 }
436
437 static void cf_userinfo(disorder_client *c, char **argv) {
438   char *s;
439
440   if(disorder_userinfo(c, argv[0], argv[1], &s))
441     exit(EXIT_FAILURE);
442   xprintf("%s\n", nullcheck(utf82mb(s)));
443 }
444
445 static const struct command {
446   const char *name;
447   int min, max;
448   void (*fn)(disorder_client *c, char **);
449   int (*isarg)(const char *);
450   const char *argstr, *desc;
451 } commands[] = {
452   { "adduser",        2, 2, cf_adduser, 0, "USER PASSWORD",
453                       "Create a new user" },
454   { "allfiles",       1, 2, cf_allfiles, isarg_regexp, "DIR [~REGEXP]",
455                       "List all files and directories in DIR" },
456   { "authorize",      1, 1, cf_authorize, 0, "USER",
457                       "Authorize USER to connect to the server" },
458   { "deluser",        1, 1, cf_deluser, 0, "USER",
459                       "Delete a user" },
460   { "dirs",           1, 2, cf_dirs, isarg_regexp, "DIR [~REGEXP]",
461                       "List directories in DIR" },
462   { "disable",        0, 0, cf_disable, 0, "",
463                       "Disable play" },
464   { "disable-random", 0, 0, cf_random_disable, 0, "",
465                       "Disable random play" },
466   { "edituser",       3, 3, cf_edituser, 0, "USER PROPERTY VALUE",
467                       "Set a property of a user" },
468   { "enable",         0, 0, cf_enable, 0, "",
469                       "Enable play" },
470   { "enable-random",  0, 0, cf_random_enable, 0, "",
471                       "Enable random play" },
472   { "files",          1, 2, cf_files, isarg_regexp, "DIR [~REGEXP]",
473                       "List files in DIR" },
474   { "get",            2, 2, cf_get, 0, "TRACK NAME",
475                       "Get a preference value" },
476   { "get-global",     1, 1, cf_get_global, 0, "NAME",
477                       "Get a global preference value" },
478   { "get-volume",     0, 0, cf_get_volume, 0, "",
479                       "Get the current volume" },
480   { "length",         1, 1, cf_length, 0, "TRACK",
481                       "Get the length of TRACK in seconds" },
482   { "log",            0, 0, cf_log, 0, "",
483                       "Copy event log to stdout" },
484   { "move",           2, 2, cf_move, 0, "TRACK DELTA",
485                       "Move a track in the queue" },
486   { "new",            0, 1, cf_new, isarg_integer, "[MAX]",
487                       "Get the most recently added MAX tracks" },
488   { "part",           3, 3, cf_part, 0, "TRACK CONTEXT PART",
489                       "Find a track name part" },
490   { "pause",          0, 0, cf_pause, 0, "",
491                       "Pause the currently playing track" },
492   { "play",           1, INT_MAX, cf_play, isarg_filename, "TRACKS...",
493                       "Add TRACKS to the end of the queue" },
494   { "playing",        0, 0, cf_playing, 0, "",
495                       "Report the playing track" },
496   { "prefs",          1, 1, cf_prefs, 0, "TRACK",
497                       "Display all the preferences for TRACK" },
498   { "quack",          0, 0, cf_quack, 0, 0, 0 },
499   { "queue",          0, 0, cf_queue, 0, "",
500                       "Display the current queue" },
501   { "random-disable", 0, 0, cf_random_disable, 0, "",
502                       "Disable random play" },
503   { "random-enable",  0, 0, cf_random_enable, 0, "",
504                       "Enable random play" },
505   { "recent",         0, 0, cf_recent, 0, "",
506                       "Display recently played track" },
507   { "reconfigure",    0, 0, cf_reconfigure, 0, "",
508                       "Reconfigure the daemon" },
509   { "remove",         1, 1, cf_remove, 0, "TRACK",
510                       "Remove a track from the queue" },
511   { "rescan",         0, 0, cf_rescan, 0, "",
512                       "Rescan for new tracks" },
513   { "resolve",        1, 1, cf_resolve, 0, "TRACK",
514                       "Resolve alias for TRACK" },
515   { "resume",         0, 0, cf_resume, 0, "",
516                       "Resume after a pause" },
517   { "rtp-address",    0, 0, cf_rtp_address, 0, "",
518                       "Report server's broadcast address" },
519   { "scratch",        0, 0, cf_scratch, 0, "",
520                       "Scratch the currently playing track" },
521   { "scratch-id",     1, 1, cf_scratch, 0, "ID",
522                       "Scratch the currently playing track" },
523   { "search",         1, 1, cf_search, 0, "WORDS",
524                       "Display tracks matching all the words" },
525   { "set",            3, 3, cf_set, 0, "TRACK NAME VALUE",
526                       "Set a preference value" },
527   { "set-global",     2, 2, cf_set_global, 0, "NAME VALUE",
528                       "Set a global preference value" },
529   { "set-volume",     2, 2, cf_set_volume, 0, "LEFT RIGHT",
530                       "Set the volume" },
531   { "shutdown",       0, 0, cf_shutdown, 0, "",
532                       "Shut down the daemon" },
533   { "stats",          0, 0, cf_stats, 0, "",
534                       "Display server statistics" },
535   { "tags",           0, 0, cf_tags, 0, "",
536                       "List known tags" },
537   { "unset",          2, 2, cf_unset, 0, "TRACK NAME",
538                       "Unset a preference" },
539   { "unset-global",   1, 1, cf_unset_global, 0, "NAME",
540                       "Unset a global preference" },
541   { "userinfo",       2, 2, cf_userinfo, 0, "USER PROPERTY",
542                       "Get a property of as user" },
543   { "users",          0, 0, cf_users, 0, "",
544                       "List all users" },
545   { "version",        0, 0, cf_version, 0, "",
546                       "Display the server version" },
547 };
548
549 static void help_commands(void) {
550   unsigned n, max = 0, l;
551
552   xprintf("Command summary:\n");
553   for(n = 0; n < sizeof commands / sizeof *commands; ++n) {
554     if(!commands[n].desc) continue;
555     l = strlen(commands[n].name);
556     if(*commands[n].argstr)
557       l += strlen(commands[n].argstr) + 1;
558     if(l > max)
559       max = l;
560   }
561   for(n = 0; n < sizeof commands / sizeof *commands; ++n) {
562     if(!commands[n].desc) continue;
563     l = strlen(commands[n].name);
564     if(*commands[n].argstr)
565       l += strlen(commands[n].argstr) + 1;
566     xprintf("  %s%s%s%*s  %s\n", commands[n].name,
567             *commands[n].argstr ? " " : "",
568             commands[n].argstr,
569             max - l, "",
570             commands[n].desc);
571   }
572   xfclose(stdout);
573   exit(0);
574 }
575
576 int main(int argc, char **argv) {
577   int n, i, j, local = 0;
578   disorder_client *c = 0;
579   int status = 0;
580   struct vector args;
581   const char *user = 0, *password = 0;
582
583   mem_init();
584   /* garbage-collect PCRE's memory */
585   pcre_malloc = xmalloc;
586   pcre_free = xfree;
587   if(!setlocale(LC_CTYPE, "")) fatal(errno, "error calling setlocale");
588   while((n = getopt_long(argc, argv, "hVc:dHlNu:p:", options, 0)) >= 0) {
589     switch(n) {
590     case 'h': help();
591     case 'H': help_commands();
592     case 'V': version();
593     case 'c': configfile = optarg; break;
594     case 'd': debugging = 1; break;
595     case 'l': local = 1; break;
596     case 'N': config_per_user = 0; break;
597     case 'u': user = optarg; break;
598     case 'p': password = optarg; break;
599     default: fatal(0, "invalid option");
600     }
601   }
602   if(config_read(0)) fatal(0, "cannot read configuration");
603   if(user) {
604     config->username = user;
605     config->password = 0;
606   }
607   if(password)
608     config->password = password;
609   if(local)
610     config->connect.n = 0;
611   if(!(c = disorder_new(1))) exit(EXIT_FAILURE);
612   if(disorder_connect(c)) exit(EXIT_FAILURE);
613   n = optind;
614   /* accumulate command args */
615   while(n < argc) {
616     if((i = TABLE_FIND(commands, struct command, name, argv[n])) < 0)
617       fatal(0, "unknown command '%s'", argv[n]);
618     if(n + commands[i].min >= argc)
619       fatal(0, "missing arguments to '%s'", argv[n]);
620     n++;
621     vector_init(&args);
622     for(j = 0; j < commands[i].min; ++j)
623       vector_append(&args, nullcheck(mb2utf8(argv[n + j])));
624     for(; j < commands[i].max
625           && n + j < argc
626           && commands[i].isarg(argv[n + j]); ++j)
627       vector_append(&args, nullcheck(mb2utf8(argv[n + j])));
628     vector_terminate(&args);
629     commands[i].fn(c, args.vec);
630     n += j;
631   }
632   if(auto_reconfigure) {
633     assert(c != 0);
634     if(disorder_reconfigure(c)) exit(EXIT_FAILURE);
635   }
636   if(c && disorder_close(c)) exit(EXIT_FAILURE);
637   if(fclose(stdout) < 0) fatal(errno, "error closing stdout");
638   return status;
639 }
640
641 /*
642 Local Variables:
643 c-basic-offset:2
644 comment-column:40
645 End:
646 */