2 * This file is part of DisOrder.
3 * Copyright (C) 2004, 2005, 2006, 2007 Richard Kettlewell
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.
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.
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
25 #include <sys/types.h>
26 #include <sys/socket.h>
39 #include <netinet/in.h>
45 #include "server-queue.h"
52 #include "configuration.h"
63 #include "trackname.h"
72 # define NONCE_SIZE 16
75 int volume_left, volume_right; /* last known volume */
77 /** @brief Accept all well-formed login attempts
88 /** @brief One client connection */
90 /** @brief Read commands from here */
92 /** @brief Send responses to here */
94 /** @brief Underlying file descriptor */
96 /** @brief Unique identifier for connection used in log messages */
98 /** @brief Login name or NULL */
100 /** @brief Event loop */
102 /** @brief Nonce chosen for this connection */
103 unsigned char nonce[NONCE_SIZE];
104 /** @brief Current reader callback
106 * We change this depending on whether we're servicing the @b log command
108 ev_reader_callback *reader;
109 /** @brief Event log output sending to this connection */
110 struct eventlog_output *lo;
111 /** @brief Parent listener */
112 const struct listener *l;
113 /** @brief Login cookie or NULL */
115 /** @brief Connection rights */
119 static int reader_callback(ev_source *ev,
126 static const char *noyes[] = { "no", "yes" };
128 /** @brief Called when a connection's writer fails or is shut down
130 * If the connection still has a raeder that is cancelled.
132 static int writer_error(ev_source attribute((unused)) *ev,
137 D(("server writer_error S%x %d", c->tag, errno_value));
138 if(errno_value == 0) {
140 D(("S%x writer completed", c->tag));
142 if(errno_value != EPIPE)
143 error(errno_value, "S%x write error on socket", c->tag);
145 D(("cancel reader"));
146 ev_reader_cancel(c->r);
149 D(("done cancel reader"));
156 /** @brief Called when a conncetion's reader fails or is shut down
158 * If connection still has a writer then it is closed.
160 static int reader_error(ev_source attribute((unused)) *ev,
165 D(("server reader_error S%x %d", c->tag, errno_value));
166 error(errno_value, "S%x read error on socket", c->tag);
168 ev_writer_close(c->w);
175 static int c_disable(struct conn *c, char **vec, int nvec) {
177 disable_playing(c->who);
178 else if(nvec == 1 && !strcmp(vec[0], "now"))
179 disable_playing(c->who);
181 sink_writes(ev_writer_sink(c->w), "550 invalid argument\n");
182 return 1; /* completed */
184 sink_writes(ev_writer_sink(c->w), "250 OK\n");
185 return 1; /* completed */
188 static int c_enable(struct conn *c,
189 char attribute((unused)) **vec,
190 int attribute((unused)) nvec) {
191 enable_playing(c->who, c->ev);
192 /* Enable implicitly unpauses if there is nothing playing */
193 if(paused && !playing) resume_playing(c->who);
194 sink_writes(ev_writer_sink(c->w), "250 OK\n");
195 return 1; /* completed */
198 static int c_enabled(struct conn *c,
199 char attribute((unused)) **vec,
200 int attribute((unused)) nvec) {
201 sink_printf(ev_writer_sink(c->w), "252 %s\n", noyes[playing_is_enabled()]);
202 return 1; /* completed */
205 static int c_play(struct conn *c, char **vec,
206 int attribute((unused)) nvec) {
208 struct queue_entry *q;
210 if(!trackdb_exists(vec[0])) {
211 sink_writes(ev_writer_sink(c->w), "550 track is not in database\n");
214 if(!(track = trackdb_resolve(vec[0]))) {
215 sink_writes(ev_writer_sink(c->w), "550 cannot resolve track\n");
218 q = queue_add(track, c->who, WHERE_BEFORE_RANDOM);
220 /* If we added the first track, and something is playing, then prepare the
221 * new track. If nothing is playing then we don't bother as it wouldn't gain
223 if(q == qhead.next && playing)
225 sink_printf(ev_writer_sink(c->w), "252 %s\n", q->id);
226 /* If the queue was empty but we are for some reason paused then
228 if(!playing) resume_playing(0);
230 return 1; /* completed */
233 static int c_remove(struct conn *c, char **vec,
234 int attribute((unused)) nvec) {
235 struct queue_entry *q;
238 if(!(q = queue_find(vec[0]))) {
239 sink_writes(ev_writer_sink(c->w), "550 no such track on the queue\n");
243 if(!strcmp(q->submitter, c->who))
244 r = RIGHT_REMOVE_MINE|RIGHT_REMOVE_ANY;
246 r = RIGHT_REMOVE_ANY;
248 r = RIGHT_REMOVE_RANDOM|RIGHT_REMOVE_ANY;
249 if(!(c->rights & r)) {
250 error(0, "%s attempted remove but lacks required rights", c->who);
251 sink_writes(ev_writer_sink(c->w),
252 "510 Not authorized to remove that track\n");
255 queue_remove(q, c->who);
256 /* De-prepare the track. */
258 /* If we removed a random track then add another one. */
259 if(q->state == playing_random)
261 /* Prepare whatever the next head track is. */
262 if(qhead.next != &qhead)
263 prepare(c->ev, qhead.next);
265 sink_writes(ev_writer_sink(c->w), "250 removed\n");
266 return 1; /* completed */
269 static int c_scratch(struct conn *c,
275 sink_writes(ev_writer_sink(c->w), "250 nothing is playing\n");
276 return 1; /* completed */
278 /* TODO there is a bug here: if we specify an ID but it's not the currently
279 * playing track then you will get 550 if you weren't authorized to scratch
280 * the currently playing track. */
281 if(playing->submitter)
282 if(!strcmp(playing->submitter, c->who))
283 r = RIGHT_SCRATCH_MINE|RIGHT_SCRATCH_ANY;
285 r = RIGHT_SCRATCH_ANY;
287 r = RIGHT_SCRATCH_RANDOM|RIGHT_SCRATCH_ANY;
288 if(!(c->rights & r)) {
289 error(0, "%s attempted scratch but lacks required rights", c->who);
290 sink_writes(ev_writer_sink(c->w),
291 "510 Not authorized to scratch that track\n");
294 scratch(c->who, nvec == 1 ? vec[0] : 0);
295 /* If you scratch an unpaused track then it is automatically unpaused */
297 sink_writes(ev_writer_sink(c->w), "250 scratched\n");
298 return 1; /* completed */
301 static int c_pause(struct conn *c,
302 char attribute((unused)) **vec,
303 int attribute((unused)) nvec) {
305 sink_writes(ev_writer_sink(c->w), "250 nothing is playing\n");
306 return 1; /* completed */
309 sink_writes(ev_writer_sink(c->w), "250 already paused\n");
310 return 1; /* completed */
312 if(pause_playing(c->who) < 0)
313 sink_writes(ev_writer_sink(c->w), "550 cannot pause this track\n");
315 sink_writes(ev_writer_sink(c->w), "250 paused\n");
319 static int c_resume(struct conn *c,
320 char attribute((unused)) **vec,
321 int attribute((unused)) nvec) {
323 sink_writes(ev_writer_sink(c->w), "250 not paused\n");
324 return 1; /* completed */
326 resume_playing(c->who);
327 sink_writes(ev_writer_sink(c->w), "250 paused\n");
331 static int c_shutdown(struct conn *c,
332 char attribute((unused)) **vec,
333 int attribute((unused)) nvec) {
334 info("S%x shut down by %s", c->tag, c->who);
335 sink_writes(ev_writer_sink(c->w), "250 shutting down\n");
336 ev_writer_flush(c->w);
340 static int c_reconfigure(struct conn *c,
341 char attribute((unused)) **vec,
342 int attribute((unused)) nvec) {
343 info("S%x reconfigure by %s", c->tag, c->who);
344 if(reconfigure(c->ev, 1))
345 sink_writes(ev_writer_sink(c->w), "550 error reading new config\n");
347 sink_writes(ev_writer_sink(c->w), "250 installed new config\n");
348 return 1; /* completed */
351 static int c_rescan(struct conn *c,
352 char attribute((unused)) **vec,
353 int attribute((unused)) nvec) {
354 info("S%x rescan by %s", c->tag, c->who);
355 trackdb_rescan(c->ev);
356 sink_writes(ev_writer_sink(c->w), "250 initiated rescan\n");
357 return 1; /* completed */
360 static int c_version(struct conn *c,
361 char attribute((unused)) **vec,
362 int attribute((unused)) nvec) {
363 /* VERSION had better only use the basic character set */
364 sink_printf(ev_writer_sink(c->w), "251 %s\n", disorder_short_version_string);
365 return 1; /* completed */
368 static int c_playing(struct conn *c,
369 char attribute((unused)) **vec,
370 int attribute((unused)) nvec) {
372 queue_fix_sofar(playing);
373 playing->expected = 0;
374 sink_printf(ev_writer_sink(c->w), "252 %s\n", queue_marshall(playing));
376 sink_printf(ev_writer_sink(c->w), "259 nothing playing\n");
377 return 1; /* completed */
380 static const char *connection_host(struct conn *c) {
383 struct sockaddr_in in;
384 struct sockaddr_in6 in6;
390 /* get connection data */
392 if(getpeername(c->fd, &u.sa, &l) < 0) {
393 error(errno, "S%x error calling getpeername", c->tag);
396 if(c->l->pf != PF_UNIX) {
397 if((n = getnameinfo(&u.sa, l,
398 host, sizeof host, 0, 0, NI_NUMERICHOST))) {
399 error(0, "S%x error calling getnameinfo: %s", c->tag, gai_strerror(n));
402 return xstrdup(host);
407 static int c_user(struct conn *c,
409 int attribute((unused)) nvec) {
411 const char *res, *host, *password;
415 sink_writes(ev_writer_sink(c->w), "530 already authenticated\n");
418 /* get connection data */
419 if(!(host = connection_host(c))) {
420 sink_writes(ev_writer_sink(c->w), "530 authentication failure\n");
424 k = trackdb_getuserinfo(vec[0]);
425 /* reject nonexistent users */
427 error(0, "S%x unknown user '%s' from %s", c->tag, vec[0], host);
428 sink_writes(ev_writer_sink(c->w), "530 authentication failed\n");
431 /* reject unconfirmed users */
432 if(kvp_get(k, "confirmation")) {
433 error(0, "S%x unconfirmed user '%s' from %s", c->tag, vec[0], host);
434 sink_writes(ev_writer_sink(c->w), "530 authentication failed\n");
437 password = kvp_get(k, "password");
438 if(!password) password = "";
439 if(parse_rights(kvp_get(k, "rights"), &rights, 1)) {
440 error(0, "error parsing rights for %s", vec[0]);
441 sink_writes(ev_writer_sink(c->w), "530 authentication failed\n");
444 /* check whether the response is right */
445 res = authhash(c->nonce, sizeof c->nonce, password,
446 config->authorization_algorithm);
447 if(wideopen || (res && !strcmp(res, vec[1]))) {
450 /* currently we only bother logging remote connections */
451 if(strcmp(host, "local")) {
452 info("S%x %s connected from %s", c->tag, vec[0], host);
453 c->rights |= RIGHT__LOCAL;
455 sink_writes(ev_writer_sink(c->w), "230 OK\n");
458 /* oops, response was wrong */
459 info("S%x authentication failure for %s from %s", c->tag, vec[0], host);
460 sink_writes(ev_writer_sink(c->w), "530 authentication failed\n");
464 static int c_recent(struct conn *c,
465 char attribute((unused)) **vec,
466 int attribute((unused)) nvec) {
467 const struct queue_entry *q;
469 sink_writes(ev_writer_sink(c->w), "253 Tracks follow\n");
470 for(q = phead.next; q != &phead; q = q->next)
471 sink_printf(ev_writer_sink(c->w), " %s\n", queue_marshall(q));
472 sink_writes(ev_writer_sink(c->w), ".\n");
473 return 1; /* completed */
476 static int c_queue(struct conn *c,
477 char attribute((unused)) **vec,
478 int attribute((unused)) nvec) {
479 struct queue_entry *q;
484 sink_writes(ev_writer_sink(c->w), "253 Tracks follow\n");
485 if(playing_is_enabled() && !paused) {
487 queue_fix_sofar(playing);
488 if((l = trackdb_get(playing->track, "_length"))
489 && (length = atol(l))) {
491 when += length - playing->sofar + config->gap;
494 /* Nothing is playing but playing is enabled, so whatever is
495 * first in the queue can be expected to start immediately. */
498 for(q = qhead.next; q != &qhead; q = q->next) {
499 /* fill in estimated start time */
501 sink_printf(ev_writer_sink(c->w), " %s\n", queue_marshall(q));
502 /* update for next track */
504 if((l = trackdb_get(q->track, "_length"))
505 && (length = atol(l)))
506 when += length + config->gap;
511 sink_writes(ev_writer_sink(c->w), ".\n");
512 return 1; /* completed */
515 static int output_list(struct conn *c, char **vec) {
517 sink_printf(ev_writer_sink(c->w), "%s\n", *vec++);
518 sink_writes(ev_writer_sink(c->w), ".\n");
522 static int files_dirs(struct conn *c,
525 enum trackdb_listable what) {
526 const char *dir, *re, *errstr;
532 case 0: dir = 0; re = 0; break;
533 case 1: dir = vec[0]; re = 0; break;
534 case 2: dir = vec[0]; re = vec[1]; break;
537 /* A bit of a bodge to make sure the args don't trample on cache keys */
538 if(dir && strchr(dir, '\n')) {
539 sink_writes(ev_writer_sink(c->w), "550 invalid directory name\n");
542 if(re && strchr(re, '\n')) {
543 sink_writes(ev_writer_sink(c->w), "550 invalid regexp\n");
546 /* We bother eliminating "" because the web interface is relatively
547 * likely to send it */
549 byte_xasprintf(&key, "%d\n%s\n%s", (int)what, dir ? dir : "", re);
550 fvec = (char **)cache_get(&cache_files_type, key);
552 /* Got a cache hit, don't store the answer in the cache */
555 rec = 0; /* quieten compiler */
557 /* Cache miss, we'll do the lookup and key != 0 so we'll store the answer
559 if(!(rec = pcre_compile(re, PCRE_CASELESS|PCRE_UTF8,
560 &errstr, &erroffset, 0))) {
561 sink_printf(ev_writer_sink(c->w), "550 Error compiling regexp: %s\n",
565 /* It only counts as a miss if the regexp was valid. */
566 ++cache_files_misses;
569 /* No regexp, don't bother caching the result */
575 /* No cache hit (either because a miss, or because we did not look) so do
578 fvec = trackdb_list(dir, 0, what, rec);
580 fvec = trackdb_list(0, 0, what, rec);
583 /* Put the answer in the cache */
584 cache_put(&cache_files_type, key, fvec);
585 sink_writes(ev_writer_sink(c->w), "253 Listing follow\n");
586 return output_list(c, fvec);
589 static int c_files(struct conn *c,
592 return files_dirs(c, vec, nvec, trackdb_files);
595 static int c_dirs(struct conn *c,
598 return files_dirs(c, vec, nvec, trackdb_directories);
601 static int c_allfiles(struct conn *c,
604 return files_dirs(c, vec, nvec, trackdb_directories|trackdb_files);
607 static int c_get(struct conn *c,
609 int attribute((unused)) nvec) {
612 if(vec[1][0] != '_' && (v = trackdb_get(vec[0], vec[1])))
613 sink_printf(ev_writer_sink(c->w), "252 %s\n", quoteutf8(v));
615 sink_writes(ev_writer_sink(c->w), "555 not found\n");
619 static int c_length(struct conn *c,
621 int attribute((unused)) nvec) {
622 const char *track, *v;
624 if(!(track = trackdb_resolve(vec[0]))) {
625 sink_writes(ev_writer_sink(c->w), "550 cannot resolve track\n");
628 if((v = trackdb_get(track, "_length")))
629 sink_printf(ev_writer_sink(c->w), "252 %s\n", quoteutf8(v));
631 sink_writes(ev_writer_sink(c->w), "550 not found\n");
635 static int c_set(struct conn *c,
637 int attribute((unused)) nvec) {
638 if(vec[1][0] != '_' && !trackdb_set(vec[0], vec[1], vec[2]))
639 sink_writes(ev_writer_sink(c->w), "250 OK\n");
641 sink_writes(ev_writer_sink(c->w), "550 not found\n");
645 static int c_prefs(struct conn *c,
647 int attribute((unused)) nvec) {
650 k = trackdb_get_all(vec[0]);
651 sink_writes(ev_writer_sink(c->w), "253 prefs follow\n");
652 for(; k; k = k->next)
653 if(k->name[0] != '_') /* omit internal values */
654 sink_printf(ev_writer_sink(c->w),
655 " %s %s\n", quoteutf8(k->name), quoteutf8(k->value));
656 sink_writes(ev_writer_sink(c->w), ".\n");
660 static int c_exists(struct conn *c,
662 int attribute((unused)) nvec) {
663 sink_printf(ev_writer_sink(c->w), "252 %s\n", noyes[trackdb_exists(vec[0])]);
667 static void search_parse_error(const char *msg, void *u) {
668 *(const char **)u = msg;
671 static int c_search(struct conn *c,
673 int attribute((unused)) nvec) {
674 char **terms, **results;
675 int nterms, nresults, n;
676 const char *e = "unknown error";
678 /* This is a bit of a bodge. Initially it's there to make the eclient
679 * interface a bit more convenient to add searching to, but it has the more
680 * compelling advantage that if everything uses it, then interpretation of
681 * user-supplied search strings will be the same everywhere. */
682 if(!(terms = split(vec[0], &nterms, SPLIT_QUOTES, search_parse_error, &e))) {
683 sink_printf(ev_writer_sink(c->w), "550 %s\n", e);
685 results = trackdb_search(terms, nterms, &nresults);
686 sink_printf(ev_writer_sink(c->w), "253 %d matches\n", nresults);
687 for(n = 0; n < nresults; ++n)
688 sink_printf(ev_writer_sink(c->w), "%s\n", results[n]);
689 sink_writes(ev_writer_sink(c->w), ".\n");
694 static int c_random_enable(struct conn *c,
695 char attribute((unused)) **vec,
696 int attribute((unused)) nvec) {
697 enable_random(c->who, c->ev);
698 /* Enable implicitly unpauses if there is nothing playing */
699 if(paused && !playing) resume_playing(c->who);
700 sink_writes(ev_writer_sink(c->w), "250 OK\n");
701 return 1; /* completed */
704 static int c_random_disable(struct conn *c,
705 char attribute((unused)) **vec,
706 int attribute((unused)) nvec) {
707 disable_random(c->who);
708 sink_writes(ev_writer_sink(c->w), "250 OK\n");
709 return 1; /* completed */
712 static int c_random_enabled(struct conn *c,
713 char attribute((unused)) **vec,
714 int attribute((unused)) nvec) {
715 sink_printf(ev_writer_sink(c->w), "252 %s\n", noyes[random_is_enabled()]);
716 return 1; /* completed */
719 static void got_stats(char *stats, void *u) {
720 struct conn *const c = u;
722 sink_printf(ev_writer_sink(c->w), "253 stats\n%s\n.\n", stats);
723 /* Now we can start processing commands again */
724 ev_reader_enable(c->r);
727 static int c_stats(struct conn *c,
728 char attribute((unused)) **vec,
729 int attribute((unused)) nvec) {
730 trackdb_stats_subprocess(c->ev, got_stats, c);
731 return 0; /* not yet complete */
734 static int c_volume(struct conn *c,
746 l = r = atoi(vec[0]);
757 rights = set ? RIGHT_VOLUME : RIGHT_READ;
758 if(!(c->rights & rights)) {
759 error(0, "%s attempted to set volume but lacks required rights", c->who);
760 sink_writes(ev_writer_sink(c->w), "510 Prohibited\n");
763 if(mixer_control(&l, &r, set))
764 sink_writes(ev_writer_sink(c->w), "550 error accessing mixer\n");
766 sink_printf(ev_writer_sink(c->w), "252 %d %d\n", l, r);
767 if(l != volume_left || r != volume_right) {
770 snprintf(lb, sizeof lb, "%d", l);
771 snprintf(rb, sizeof rb, "%d", r);
772 eventlog("volume", lb, rb, (char *)0);
778 /** @brief Called when data arrives on a log connection
780 * We just discard all such data. The client may occasionally send data as a
783 static int logging_reader_callback(ev_source attribute((unused)) *ev,
785 void attribute((unused)) *ptr,
787 int attribute((unused)) eof,
788 void attribute((unused)) *u) {
791 ev_reader_consume(reader, bytes);
793 /* Oops, that's all for now */
794 D(("logging reader eof"));
797 ev_writer_close(c->w);
805 static void logclient(const char *msg, void *user) {
806 struct conn *c = user;
809 /* This connection has gone up in smoke for some reason */
810 eventlog_remove(c->lo);
813 sink_printf(ev_writer_sink(c->w), "%"PRIxMAX" %s\n",
814 (uintmax_t)time(0), msg);
817 static int c_log(struct conn *c,
818 char attribute((unused)) **vec,
819 int attribute((unused)) nvec) {
822 sink_writes(ev_writer_sink(c->w), "254 OK\n");
823 /* pump out initial state */
825 sink_printf(ev_writer_sink(c->w), "%"PRIxMAX" state %s\n",
827 playing_is_enabled() ? "enable_play" : "disable_play");
828 sink_printf(ev_writer_sink(c->w), "%"PRIxMAX" state %s\n",
830 random_is_enabled() ? "enable_random" : "disable_random");
831 sink_printf(ev_writer_sink(c->w), "%"PRIxMAX" state %s\n",
833 paused ? "pause" : "resume");
835 sink_printf(ev_writer_sink(c->w), "%"PRIxMAX" state playing\n",
838 sink_printf(ev_writer_sink(c->w), "%"PRIxMAX" volume %d %d\n",
839 (uintmax_t)now, volume_left, volume_right);
840 c->lo = xmalloc(sizeof *c->lo);
841 c->lo->fn = logclient;
844 c->reader = logging_reader_callback;
848 /** @brief Test whether a move is allowed
849 * @param c Connection
850 * @param qs List of IDs on queue
851 * @param nqs Number of IDs
852 * @return 0 if move is prohibited, non-0 if it is allowed
854 static int has_move_rights(struct conn *c, struct queue_entry **qs, int nqs) {
857 for(; nqs > 0; ++qs, --nqs) {
858 struct queue_entry *const q = *qs;
861 if(!strcmp(q->submitter, c->who))
862 r |= RIGHT_MOVE_MINE|RIGHT_MOVE_ANY;
866 r |= RIGHT_MOVE_RANDOM|RIGHT_MOVE_ANY;
868 return !!(c->rights & r);
871 static int c_move(struct conn *c,
873 int attribute((unused)) nvec) {
874 struct queue_entry *q;
877 if(!(q = queue_find(vec[0]))) {
878 sink_writes(ev_writer_sink(c->w), "550 no such track on the queue\n");
881 if(!has_move_rights(c, &q, 1)) {
882 error(0, "%s attempted move but lacks required rights", c->who);
883 sink_writes(ev_writer_sink(c->w),
884 "510 Not authorized to move that track\n");
887 n = queue_move(q, atoi(vec[1]), c->who);
888 sink_printf(ev_writer_sink(c->w), "252 %d\n", n);
889 /* If we've moved to the head of the queue then prepare the track. */
895 static int c_moveafter(struct conn *c,
897 int attribute((unused)) nvec) {
898 struct queue_entry *q, **qs;
902 if(!(q = queue_find(vec[0]))) {
903 sink_writes(ev_writer_sink(c->w), "550 no such track on the queue\n");
910 qs = xcalloc(nvec, sizeof *qs);
911 for(n = 0; n < nvec; ++n)
912 if(!(qs[n] = queue_find(vec[n]))) {
913 sink_writes(ev_writer_sink(c->w), "550 no such track on the queue\n");
916 if(!has_move_rights(c, qs, nvec)) {
917 error(0, "%s attempted moveafter but lacks required rights", c->who);
918 sink_writes(ev_writer_sink(c->w),
919 "510 Not authorized to move those tracks\n");
922 queue_moveafter(q, nvec, qs, c->who);
923 sink_printf(ev_writer_sink(c->w), "250 Moved tracks\n");
924 /* If we've moved to the head of the queue then prepare the track. */
930 static int c_part(struct conn *c,
932 int attribute((unused)) nvec) {
933 sink_printf(ev_writer_sink(c->w), "252 %s\n",
934 quoteutf8(trackdb_getpart(vec[0], vec[1], vec[2])));
938 static int c_resolve(struct conn *c,
940 int attribute((unused)) nvec) {
943 if(!(track = trackdb_resolve(vec[0]))) {
944 sink_writes(ev_writer_sink(c->w), "550 cannot resolve track\n");
947 sink_printf(ev_writer_sink(c->w), "252 %s\n", quoteutf8(track));
951 static int c_tags(struct conn *c,
952 char attribute((unused)) **vec,
953 int attribute((unused)) nvec) {
954 char **tags = trackdb_alltags();
956 sink_printf(ev_writer_sink(c->w), "253 Tag list follows\n");
958 sink_printf(ev_writer_sink(c->w), "%s%s\n",
959 **tags == '.' ? "." : "", *tags);
962 sink_writes(ev_writer_sink(c->w), ".\n");
963 return 1; /* completed */
966 static int c_set_global(struct conn *c,
968 int attribute((unused)) nvec) {
969 if(vec[0][0] == '_') {
970 sink_writes(ev_writer_sink(c->w), "550 cannot set internal global preferences\n");
973 trackdb_set_global(vec[0], vec[1], c->who);
974 sink_printf(ev_writer_sink(c->w), "250 OK\n");
978 static int c_get_global(struct conn *c,
980 int attribute((unused)) nvec) {
981 const char *s = trackdb_get_global(vec[0]);
984 sink_printf(ev_writer_sink(c->w), "252 %s\n", quoteutf8(s));
986 sink_writes(ev_writer_sink(c->w), "555 not found\n");
990 static int c_nop(struct conn *c,
991 char attribute((unused)) **vec,
992 int attribute((unused)) nvec) {
993 sink_printf(ev_writer_sink(c->w), "250 Quack\n");
997 static int c_new(struct conn *c,
1000 char **tracks = trackdb_new(0, nvec > 0 ? atoi(vec[0]) : INT_MAX);
1002 sink_printf(ev_writer_sink(c->w), "253 New track list follows\n");
1004 sink_printf(ev_writer_sink(c->w), "%s%s\n",
1005 **tracks == '.' ? "." : "", *tracks);
1008 sink_writes(ev_writer_sink(c->w), ".\n");
1009 return 1; /* completed */
1013 static int c_rtp_address(struct conn *c,
1014 char attribute((unused)) **vec,
1015 int attribute((unused)) nvec) {
1016 if(config->speaker_backend == BACKEND_NETWORK) {
1017 sink_printf(ev_writer_sink(c->w), "252 %s %s\n",
1018 quoteutf8(config->broadcast.s[0]),
1019 quoteutf8(config->broadcast.s[1]));
1021 sink_writes(ev_writer_sink(c->w), "550 No RTP\n");
1025 static int c_cookie(struct conn *c,
1027 int attribute((unused)) nvec) {
1032 /* Can't log in twice on the same connection */
1034 sink_writes(ev_writer_sink(c->w), "530 already authenticated\n");
1037 /* Get some kind of peer identifcation */
1038 if(!(host = connection_host(c))) {
1039 sink_writes(ev_writer_sink(c->w), "530 authentication failure\n");
1042 /* Check the cookie */
1043 user = verify_cookie(vec[0], &rights);
1045 sink_writes(ev_writer_sink(c->w), "530 authentication failure\n");
1052 if(strcmp(host, "local")) {
1053 info("S%x %s connected with cookie from %s", c->tag, user, host);
1054 c->rights |= RIGHT__LOCAL;
1056 /* Response contains username so client knows who they are acting as */
1057 sink_printf(ev_writer_sink(c->w), "232 %s\n", quoteutf8(user));
1061 static int c_make_cookie(struct conn *c,
1062 char attribute((unused)) **vec,
1063 int attribute((unused)) nvec) {
1064 const char *cookie = make_cookie(c->who);
1067 sink_printf(ev_writer_sink(c->w), "252 %s\n", quoteutf8(cookie));
1069 sink_writes(ev_writer_sink(c->w), "550 Cannot create cookie\n");
1073 static int c_revoke(struct conn *c,
1074 char attribute((unused)) **vec,
1075 int attribute((unused)) nvec) {
1077 revoke_cookie(c->cookie);
1078 sink_writes(ev_writer_sink(c->w), "250 OK\n");
1080 sink_writes(ev_writer_sink(c->w), "550 Did not log in with cookie\n");
1084 static int c_adduser(struct conn *c,
1091 if(parse_rights(vec[2], 0, 1)) {
1092 sink_writes(ev_writer_sink(c->w), "550 Invalid rights list\n");
1096 rights = config->default_rights;
1097 if(trackdb_adduser(vec[0], vec[1], rights,
1098 0/*email*/, 0/*confirmation*/))
1099 sink_writes(ev_writer_sink(c->w), "550 Cannot create user\n");
1101 sink_writes(ev_writer_sink(c->w), "250 User created\n");
1105 static int c_deluser(struct conn *c,
1107 int attribute((unused)) nvec) {
1108 if(trackdb_deluser(vec[0]))
1109 sink_writes(ev_writer_sink(c->w), "550 Cannot delete user\n");
1111 sink_writes(ev_writer_sink(c->w), "250 User deleted\n");
1115 static int c_edituser(struct conn *c,
1117 int attribute((unused)) nvec) {
1118 /* RIGHT_ADMIN can do anything; otherwise you can only set your own email
1119 * address and password. */
1120 if((c->rights & RIGHT_ADMIN)
1121 || (!strcmp(c->who, vec[0])
1122 && (!strcmp(vec[1], "email")
1123 || !strcmp(vec[1], "password")))) {
1124 if(trackdb_edituserinfo(vec[0], vec[1], vec[2]))
1125 sink_writes(ev_writer_sink(c->w), "550 Failed to change setting\n");
1127 sink_writes(ev_writer_sink(c->w), "250 OK\n");
1129 error(0, "%s attempted edituser but lacks required rights", c->who);
1130 sink_writes(ev_writer_sink(c->w), "510 Restricted to administrators\n");
1135 static int c_userinfo(struct conn *c,
1136 char attribute((unused)) **vec,
1137 int attribute((unused)) nvec) {
1141 /* RIGHT_ADMIN allows anything; otherwise you can only get your own email
1142 * address and righst list. */
1143 if((c->rights & RIGHT_ADMIN)
1144 || (!strcmp(c->who, vec[0])
1145 && (!strcmp(vec[1], "email")
1146 || !strcmp(vec[1], "rights")))) {
1147 if((k = trackdb_getuserinfo(vec[0])))
1148 if((value = kvp_get(k, vec[1])))
1149 sink_printf(ev_writer_sink(c->w), "252 %s\n", quoteutf8(value));
1151 sink_writes(ev_writer_sink(c->w), "555 Not set\n");
1153 sink_writes(ev_writer_sink(c->w), "550 No such user\n");
1155 error(0, "%s attempted userinfo but lacks required rights", c->who);
1156 sink_writes(ev_writer_sink(c->w), "510 Restricted to administrators\n");
1161 static int c_users(struct conn *c,
1162 char attribute((unused)) **vec,
1163 int attribute((unused)) nvec) {
1164 /* TODO de-dupe with c_tags */
1165 char **users = trackdb_listusers();
1167 sink_writes(ev_writer_sink(c->w), "253 User list follows\n");
1169 sink_printf(ev_writer_sink(c->w), "%s%s\n",
1170 **users == '.' ? "." : "", *users);
1173 sink_writes(ev_writer_sink(c->w), ".\n");
1174 return 1; /* completed */
1177 static int c_register(struct conn *c,
1179 int attribute((unused)) nvec) {
1184 /* The confirmation string is base64(username;nonce) */
1185 bufsize = strlen(vec[0]) + NONCE_SIZE + 2;
1186 buf = xmalloc_noptr(bufsize);
1187 offset = byte_snprintf(buf, bufsize, "%s;", vec[0]);
1188 gcry_randomize(buf + offset, NONCE_SIZE, GCRY_STRONG_RANDOM);
1189 cs = mime_to_base64((uint8_t *)buf, offset + NONCE_SIZE);
1190 if(trackdb_adduser(vec[0], vec[1], config->default_rights, vec[2], cs))
1191 sink_writes(ev_writer_sink(c->w), "550 Cannot create user\n");
1193 sink_printf(ev_writer_sink(c->w), "252 %s\n", quoteutf8(cs));
1197 static int c_confirm(struct conn *c,
1199 int attribute((unused)) nvec) {
1203 if(!(user = mime_base64(vec[0], &nuser))
1204 || !(sep = memchr(user, ';', nuser))) {
1205 sink_writes(ev_writer_sink(c->w), "550 Malformed confirmation string\n");
1209 if(trackdb_confirm(user, vec[0]))
1210 sink_writes(ev_writer_sink(c->w), "550 Incorrect confirmation string\n");
1212 sink_writes(ev_writer_sink(c->w), "250 OK\n");
1216 static const struct command {
1217 /** @brief Command name */
1220 /** @brief Minimum number of arguments */
1223 /** @brief Maximum number of arguments */
1226 /** @brief Function to process command */
1227 int (*fn)(struct conn *, char **, int);
1229 /** @brief Rights required to execute command
1231 * 0 means that the command can be issued without logging in. If multiple
1232 * bits are listed here any of those rights will do.
1236 { "adduser", 2, 3, c_adduser, RIGHT_ADMIN|RIGHT__LOCAL },
1237 { "allfiles", 0, 2, c_allfiles, RIGHT_READ },
1238 { "confirm", 1, 1, c_confirm, 0 },
1239 { "cookie", 1, 1, c_cookie, 0 },
1240 { "deluser", 1, 1, c_deluser, RIGHT_ADMIN|RIGHT__LOCAL },
1241 { "dirs", 0, 2, c_dirs, RIGHT_READ },
1242 { "disable", 0, 1, c_disable, RIGHT_GLOBAL_PREFS },
1243 { "edituser", 3, 3, c_edituser, RIGHT_ADMIN|RIGHT_USERINFO },
1244 { "enable", 0, 0, c_enable, RIGHT_GLOBAL_PREFS },
1245 { "enabled", 0, 0, c_enabled, RIGHT_READ },
1246 { "exists", 1, 1, c_exists, RIGHT_READ },
1247 { "files", 0, 2, c_files, RIGHT_READ },
1248 { "get", 2, 2, c_get, RIGHT_READ },
1249 { "get-global", 1, 1, c_get_global, RIGHT_READ },
1250 { "length", 1, 1, c_length, RIGHT_READ },
1251 { "log", 0, 0, c_log, RIGHT_READ },
1252 { "make-cookie", 0, 0, c_make_cookie, RIGHT_READ },
1253 { "move", 2, 2, c_move, RIGHT_MOVE__MASK },
1254 { "moveafter", 1, INT_MAX, c_moveafter, RIGHT_MOVE__MASK },
1255 { "new", 0, 1, c_new, RIGHT_READ },
1256 { "nop", 0, 0, c_nop, 0 },
1257 { "part", 3, 3, c_part, RIGHT_READ },
1258 { "pause", 0, 0, c_pause, RIGHT_PAUSE },
1259 { "play", 1, 1, c_play, RIGHT_PLAY },
1260 { "playing", 0, 0, c_playing, RIGHT_READ },
1261 { "prefs", 1, 1, c_prefs, RIGHT_READ },
1262 { "queue", 0, 0, c_queue, RIGHT_READ },
1263 { "random-disable", 0, 0, c_random_disable, RIGHT_GLOBAL_PREFS },
1264 { "random-enable", 0, 0, c_random_enable, RIGHT_GLOBAL_PREFS },
1265 { "random-enabled", 0, 0, c_random_enabled, RIGHT_READ },
1266 { "recent", 0, 0, c_recent, RIGHT_READ },
1267 { "reconfigure", 0, 0, c_reconfigure, RIGHT_ADMIN },
1268 { "register", 3, 3, c_register, RIGHT_REGISTER|RIGHT__LOCAL },
1269 { "remove", 1, 1, c_remove, RIGHT_REMOVE__MASK },
1270 { "rescan", 0, 0, c_rescan, RIGHT_RESCAN },
1271 { "resolve", 1, 1, c_resolve, RIGHT_READ },
1272 { "resume", 0, 0, c_resume, RIGHT_PAUSE },
1273 { "revoke", 0, 0, c_revoke, RIGHT_READ },
1274 { "rtp-address", 0, 0, c_rtp_address, 0 },
1275 { "scratch", 0, 1, c_scratch, RIGHT_SCRATCH__MASK },
1276 { "search", 1, 1, c_search, RIGHT_READ },
1277 { "set", 3, 3, c_set, RIGHT_PREFS, },
1278 { "set-global", 2, 2, c_set_global, RIGHT_GLOBAL_PREFS },
1279 { "shutdown", 0, 0, c_shutdown, RIGHT_ADMIN },
1280 { "stats", 0, 0, c_stats, RIGHT_READ },
1281 { "tags", 0, 0, c_tags, RIGHT_READ },
1282 { "unset", 2, 2, c_set, RIGHT_PREFS },
1283 { "unset-global", 1, 1, c_set_global, RIGHT_GLOBAL_PREFS },
1284 { "user", 2, 2, c_user, 0 },
1285 { "userinfo", 2, 2, c_userinfo, RIGHT_READ },
1286 { "users", 0, 0, c_users, RIGHT_READ },
1287 { "version", 0, 0, c_version, RIGHT_READ },
1288 { "volume", 0, 2, c_volume, RIGHT_READ|RIGHT_VOLUME }
1291 static void command_error(const char *msg, void *u) {
1294 sink_printf(ev_writer_sink(c->w), "500 parse error: %s\n", msg);
1297 /* process a command. Return 1 if complete, 0 if incomplete. */
1298 static int command(struct conn *c, char *line) {
1302 D(("server command %s", line));
1303 /* We force everything into NFC as early as possible */
1304 if(!(line = utf8_compose_canon(line, strlen(line), 0))) {
1305 sink_writes(ev_writer_sink(c->w), "500 cannot normalize command\n");
1308 if(!(vec = split(line, &nvec, SPLIT_QUOTES, command_error, c))) {
1309 sink_writes(ev_writer_sink(c->w), "500 cannot parse command\n");
1313 sink_writes(ev_writer_sink(c->w), "500 do what?\n");
1316 if((n = TABLE_FIND(commands, struct command, name, vec[0])) < 0)
1317 sink_writes(ev_writer_sink(c->w), "500 unknown command\n");
1319 if(commands[n].rights
1320 && !(c->rights & commands[n].rights)) {
1321 error(0, "%s attempted %s but lacks required rights", c->who ? c->who : "NULL",
1323 sink_writes(ev_writer_sink(c->w), "510 Prohibited\n");
1328 if(nvec < commands[n].minargs) {
1329 sink_writes(ev_writer_sink(c->w), "500 missing argument(s)\n");
1332 if(nvec > commands[n].maxargs) {
1333 sink_writes(ev_writer_sink(c->w), "500 too many arguments\n");
1336 return commands[n].fn(c, vec, nvec);
1338 return 1; /* completed */
1341 /* redirect to the right reader callback for our current state */
1342 static int redirect_reader_callback(ev_source *ev,
1350 return c->reader(ev, reader, ptr, bytes, eof, u);
1353 /* the main command reader */
1354 static int reader_callback(ev_source attribute((unused)) *ev,
1364 D(("server reader_callback"));
1365 while((eol = memchr(ptr, '\n', bytes))) {
1367 ev_reader_consume(reader, eol - (char *)ptr);
1368 complete = command(c, ptr);
1369 bytes -= (eol - (char *)ptr);
1372 /* the command had better have set a new reader callback */
1374 /* there are further bytes to read, or we are at eof; arrange for the
1375 * command's reader callback to handle them */
1376 return ev_reader_incomplete(reader);
1377 /* nothing's going on right now */
1380 /* command completed, we can go around and handle the next one */
1384 error(0, "S%x unterminated line", c->tag);
1385 D(("normal reader close"));
1388 D(("close associated writer"));
1389 ev_writer_close(c->w);
1396 static int listen_callback(ev_source *ev,
1398 const struct sockaddr attribute((unused)) *remote,
1399 socklen_t attribute((unused)) rlen,
1401 const struct listener *l = u;
1402 struct conn *c = xmalloc(sizeof *c);
1403 static unsigned tags;
1405 D(("server listen_callback fd %d (%s)", fd, l->name));
1410 c->w = ev_writer_new(ev, fd, writer_error, c,
1412 c->r = ev_reader_new(ev, fd, redirect_reader_callback, reader_error, c,
1416 c->reader = reader_callback;
1419 gcry_randomize(c->nonce, sizeof c->nonce, GCRY_STRONG_RANDOM);
1420 sink_printf(ev_writer_sink(c->w), "231 %d %s %s\n",
1422 config->authorization_algorithm,
1423 hex(c->nonce, sizeof c->nonce));
1427 int server_start(ev_source *ev, int pf,
1428 size_t socklen, const struct sockaddr *sa,
1431 struct listener *l = xmalloc(sizeof *l);
1432 static const int one = 1;
1434 D(("server_init socket %s", name));
1435 fd = xsocket(pf, SOCK_STREAM, 0);
1436 xsetsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &one, sizeof one);
1437 if(bind(fd, sa, socklen) < 0) {
1438 error(errno, "error binding to %s", name);
1446 if(ev_listen(ev, fd, listen_callback, l, "server listener"))
1451 int server_stop(ev_source *ev, int fd) {
1453 return ev_listen_cancel(ev, fd);