2 * This file is part of DisOrder.
3 * Copyright (C) 2004-2009 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 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU 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, see <http://www.gnu.org/licenses/>.
19 #include "disorder-server.h"
23 # define NONCE_SIZE 16
27 /** @brief Size of nonce in confirmation string in 32-bit words
29 * 64 bits gives 11 digits (in base 62).
31 # define CONFIRM_SIZE 2
34 int volume_left, volume_right; /* last known volume */
36 /** @brief Accept all well-formed login attempts
49 /** @brief Signature for line reader callback
52 * @return 0 if incomplete, 1 if complete
54 * @p line is 0-terminated and excludes the newline. It points into the
55 * input buffer so will become invalid shortly.
57 typedef int line_reader_type(struct conn *c,
60 /** @brief Signature for with-body command callbacks
62 * @param body List of body lines
63 * @param nbody Number of body lines
64 * @param u As passed to fetch_body()
65 * @return 0 to suspend input, 1 if complete
67 * The body strings are allocated (so survive indefinitely) and don't include
70 typedef int body_callback_type(struct conn *c,
75 /** @brief One client connection */
77 /** @brief Read commands from here */
79 /** @brief Send responses to here */
81 /** @brief Underlying file descriptor */
83 /** @brief Unique identifier for connection used in log messages */
85 /** @brief Login name or NULL */
87 /** @brief Event loop */
89 /** @brief Nonce chosen for this connection */
90 unsigned char nonce[NONCE_SIZE];
91 /** @brief Current reader callback
93 * We change this depending on whether we're servicing the @b log command
95 ev_reader_callback *reader;
96 /** @brief Event log output sending to this connection */
97 struct eventlog_output *lo;
98 /** @brief Parent listener */
99 const struct listener *l;
100 /** @brief Login cookie or NULL */
102 /** @brief Connection rights */
104 /** @brief Next connection */
106 /** @brief True if pending rescan had 'wait' set */
108 /** @brief Playlist that this connection locks */
109 const char *locked_playlist;
110 /** @brief When that playlist was locked */
112 /** @brief Line reader function */
113 line_reader_type *line_reader;
114 /** @brief Called when command body has been read */
115 body_callback_type *body_callback;
116 /** @brief Passed to @c body_callback */
118 /** @brief Accumulating body */
119 struct vector body[1];
122 /** @brief Linked list of connections */
123 static struct conn *connections;
125 static int reader_callback(ev_source *ev,
131 static int c_playlist_set_body(struct conn *c,
135 static int fetch_body(struct conn *c,
136 body_callback_type body_callback,
138 static int body_line(struct conn *c, char *line);
139 static int command(struct conn *c, char *line);
141 static const char *noyes[] = { "no", "yes" };
143 /** @brief Remove a connection from the connection list */
144 static void remove_connection(struct conn *c) {
147 for(cc = &connections; *cc && *cc != c; cc = &(*cc)->next)
153 /** @brief Called when a connection's writer fails or is shut down
155 * If the connection still has a raeder that is cancelled.
157 static int writer_error(ev_source attribute((unused)) *ev,
162 D(("server writer_error S%x %d", c->tag, errno_value));
163 if(errno_value == 0) {
165 D(("S%x writer completed", c->tag));
167 if(errno_value != EPIPE)
168 error(errno_value, "S%x write error on socket", c->tag);
170 D(("cancel reader"));
171 ev_reader_cancel(c->r);
174 D(("done cancel reader"));
178 remove_connection(c);
182 /** @brief Called when a conncetion's reader fails or is shut down
184 * If connection still has a writer then it is closed.
186 static int reader_error(ev_source attribute((unused)) *ev,
191 D(("server reader_error S%x %d", c->tag, errno_value));
192 error(errno_value, "S%x read error on socket", c->tag);
194 ev_writer_close(c->w);
198 remove_connection(c);
202 static int c_disable(struct conn *c, char **vec, int nvec) {
204 disable_playing(c->who);
205 else if(nvec == 1 && !strcmp(vec[0], "now"))
206 disable_playing(c->who);
208 sink_writes(ev_writer_sink(c->w), "550 invalid argument\n");
209 return 1; /* completed */
211 sink_writes(ev_writer_sink(c->w), "250 OK\n");
212 return 1; /* completed */
215 static int c_enable(struct conn *c,
216 char attribute((unused)) **vec,
217 int attribute((unused)) nvec) {
218 enable_playing(c->who, c->ev);
219 /* Enable implicitly unpauses if there is nothing playing */
220 if(paused && !playing) resume_playing(c->who);
221 sink_writes(ev_writer_sink(c->w), "250 OK\n");
222 return 1; /* completed */
225 static int c_enabled(struct conn *c,
226 char attribute((unused)) **vec,
227 int attribute((unused)) nvec) {
228 sink_printf(ev_writer_sink(c->w), "252 %s\n", noyes[playing_is_enabled()]);
229 return 1; /* completed */
232 static int c_play(struct conn *c, char **vec,
233 int attribute((unused)) nvec) {
235 struct queue_entry *q;
237 if(!trackdb_exists(vec[0])) {
238 sink_writes(ev_writer_sink(c->w), "550 track is not in database\n");
241 if(!(track = trackdb_resolve(vec[0]))) {
242 sink_writes(ev_writer_sink(c->w), "550 cannot resolve track\n");
245 q = queue_add(track, c->who, WHERE_BEFORE_RANDOM, origin_picked);
247 /* If we added the first track, and something is playing, then prepare the
248 * new track. If nothing is playing then we don't bother as it wouldn't gain
250 if(q == qhead.next && playing)
252 sink_printf(ev_writer_sink(c->w), "252 %s\n", q->id);
253 /* If the queue was empty but we are for some reason paused then
255 if(!playing) resume_playing(0);
257 return 1; /* completed */
260 static int c_remove(struct conn *c, char **vec,
261 int attribute((unused)) nvec) {
262 struct queue_entry *q;
264 if(!(q = queue_find(vec[0]))) {
265 sink_writes(ev_writer_sink(c->w), "550 no such track on the queue\n");
268 if(!right_removable(c->rights, c->who, q)) {
269 error(0, "%s attempted remove but lacks required rights", c->who);
270 sink_writes(ev_writer_sink(c->w),
271 "510 Not authorized to remove that track\n");
274 queue_remove(q, c->who);
275 /* De-prepare the track. */
277 /* See about adding a new random track */
278 add_random_track(c->ev);
279 /* Prepare whatever the next head track is. */
280 if(qhead.next != &qhead)
281 prepare(c->ev, qhead.next);
283 sink_writes(ev_writer_sink(c->w), "250 removed\n");
284 return 1; /* completed */
287 static int c_scratch(struct conn *c,
291 sink_writes(ev_writer_sink(c->w), "250 nothing is playing\n");
292 return 1; /* completed */
294 /* TODO there is a bug here: if we specify an ID but it's not the currently
295 * playing track then you will get 550 if you weren't authorized to scratch
296 * the currently playing track. */
297 if(!right_scratchable(c->rights, c->who, playing)) {
298 error(0, "%s attempted scratch but lacks required rights", c->who);
299 sink_writes(ev_writer_sink(c->w),
300 "510 Not authorized to scratch that track\n");
303 scratch(c->who, nvec == 1 ? vec[0] : 0);
304 /* If you scratch an unpaused track then it is automatically unpaused */
306 sink_writes(ev_writer_sink(c->w), "250 scratched\n");
307 return 1; /* completed */
310 static int c_pause(struct conn *c,
311 char attribute((unused)) **vec,
312 int attribute((unused)) nvec) {
314 sink_writes(ev_writer_sink(c->w), "250 nothing is playing\n");
315 return 1; /* completed */
318 sink_writes(ev_writer_sink(c->w), "250 already paused\n");
319 return 1; /* completed */
321 if(pause_playing(c->who) < 0)
322 sink_writes(ev_writer_sink(c->w), "550 cannot pause this track\n");
324 sink_writes(ev_writer_sink(c->w), "250 paused\n");
328 static int c_resume(struct conn *c,
329 char attribute((unused)) **vec,
330 int attribute((unused)) nvec) {
332 sink_writes(ev_writer_sink(c->w), "250 not paused\n");
333 return 1; /* completed */
335 resume_playing(c->who);
336 sink_writes(ev_writer_sink(c->w), "250 paused\n");
340 static int c_shutdown(struct conn *c,
341 char attribute((unused)) **vec,
342 int attribute((unused)) nvec) {
343 info("S%x shut down by %s", c->tag, c->who);
344 sink_writes(ev_writer_sink(c->w), "250 shutting down\n");
345 ev_writer_flush(c->w);
349 static int c_reconfigure(struct conn *c,
350 char attribute((unused)) **vec,
351 int attribute((unused)) nvec) {
352 info("S%x reconfigure by %s", c->tag, c->who);
353 if(reconfigure(c->ev, 1))
354 sink_writes(ev_writer_sink(c->w), "550 error reading new config\n");
356 sink_writes(ev_writer_sink(c->w), "250 installed new config\n");
357 return 1; /* completed */
360 static void finished_rescan(void *ru) {
361 struct conn *const c = ru;
363 sink_writes(ev_writer_sink(c->w), "250 rescan completed\n");
364 /* Turn this connection back on */
365 ev_reader_enable(c->r);
368 static void start_fresh_rescan(void *ru) {
369 struct conn *const c = ru;
371 if(trackdb_rescan_underway()) {
372 /* Some other waiter beat us to it. However in this case we're happy to
373 * piggyback; the requirement is that a new rescan be started, not that it
374 * was _our_ rescan. */
376 /* We block until the rescan completes */
377 trackdb_add_rescanned(finished_rescan, c);
379 /* We report that the new rescan has started */
380 sink_writes(ev_writer_sink(c->w), "250 rescan initiated\n");
381 /* Turn this connection back on */
382 ev_reader_enable(c->r);
385 /* We are the first connection to get a callback so we must start a
388 /* We want to block until the new rescan completes */
389 trackdb_rescan(c->ev, 1/*check*/, finished_rescan, c);
391 /* We can report back immediately */
392 trackdb_rescan(c->ev, 1/*check*/, 0, 0);
393 sink_writes(ev_writer_sink(c->w), "250 rescan initiated\n");
394 /* Turn this connection back on */
395 ev_reader_enable(c->r);
400 static int c_rescan(struct conn *c,
403 int flag_wait = 0, flag_fresh = 0, n;
406 for(n = 0; n < nvec; ++n) {
407 if(!strcmp(vec[n], "wait"))
408 flag_wait = 1; /* wait for rescan to complete */
410 /* Currently disabled because untested (and hard to test). */
411 else if(!strcmp(vec[n], "fresh"))
412 flag_fresh = 1; /* don't piggyback underway rescan */
415 sink_writes(ev_writer_sink(c->w), "550 unknown flag\n");
416 return 1; /* completed */
419 /* Report what was requested */
420 info("S%x rescan by %s (%s %s)", c->tag, c->who,
421 flag_wait ? "wait" : "",
422 flag_fresh ? "fresh" : "");
423 if(trackdb_rescan_underway()) {
425 /* We want a fresh rescan but there is already one underway. Arrange a
426 * callback when it completes and then set off a new one. */
427 c->rescan_wait = flag_wait;
428 trackdb_add_rescanned(start_fresh_rescan, c);
432 sink_writes(ev_writer_sink(c->w), "250 rescan queued\n");
436 /* There's a rescan underway, and it's acceptable to piggyback on it */
438 /* We want to block until completion. */
439 trackdb_add_rescanned(finished_rescan, c);
442 /* We don't want to block. So we just report that things are in
444 sink_writes(ev_writer_sink(c->w), "250 rescan already underway\n");
449 /* No rescan is underway. fresh is therefore irrelevant. */
451 /* We want to block until completion */
452 trackdb_rescan(c->ev, 1/*check*/, finished_rescan, c);
455 /* We don't want to block. */
456 trackdb_rescan(c->ev, 1/*check*/, 0, 0);
457 sink_writes(ev_writer_sink(c->w), "250 rescan initiated\n");
458 return 1; /* completed */
463 static int c_version(struct conn *c,
464 char attribute((unused)) **vec,
465 int attribute((unused)) nvec) {
466 /* VERSION had better only use the basic character set */
467 sink_printf(ev_writer_sink(c->w), "251 %s\n", disorder_short_version_string);
468 return 1; /* completed */
471 static int c_playing(struct conn *c,
472 char attribute((unused)) **vec,
473 int attribute((unused)) nvec) {
475 queue_fix_sofar(playing);
476 playing->expected = 0;
477 sink_printf(ev_writer_sink(c->w), "252 %s\n", queue_marshall(playing));
479 sink_printf(ev_writer_sink(c->w), "259 nothing playing\n");
480 return 1; /* completed */
483 static const char *connection_host(struct conn *c) {
486 struct sockaddr_in in;
487 struct sockaddr_in6 in6;
493 /* get connection data */
495 if(getpeername(c->fd, &u.sa, &l) < 0) {
496 error(errno, "S%x error calling getpeername", c->tag);
499 if(c->l->pf != PF_UNIX) {
500 if((n = getnameinfo(&u.sa, l,
501 host, sizeof host, 0, 0, NI_NUMERICHOST))) {
502 error(0, "S%x error calling getnameinfo: %s", c->tag, gai_strerror(n));
505 return xstrdup(host);
510 static int c_user(struct conn *c,
512 int attribute((unused)) nvec) {
514 const char *res, *host, *password;
518 sink_writes(ev_writer_sink(c->w), "530 already authenticated\n");
521 /* get connection data */
522 if(!(host = connection_host(c))) {
523 sink_writes(ev_writer_sink(c->w), "530 authentication failure\n");
527 k = trackdb_getuserinfo(vec[0]);
528 /* reject nonexistent users */
530 error(0, "S%x unknown user '%s' from %s", c->tag, vec[0], host);
531 sink_writes(ev_writer_sink(c->w), "530 authentication failed\n");
534 /* reject unconfirmed users */
535 if(kvp_get(k, "confirmation")) {
536 error(0, "S%x unconfirmed user '%s' from %s", c->tag, vec[0], host);
537 sink_writes(ev_writer_sink(c->w), "530 authentication failed\n");
540 password = kvp_get(k, "password");
541 if(!password) password = "";
542 if(parse_rights(kvp_get(k, "rights"), &rights, 1)) {
543 error(0, "error parsing rights for %s", vec[0]);
544 sink_writes(ev_writer_sink(c->w), "530 authentication failed\n");
547 /* check whether the response is right */
548 res = authhash(c->nonce, sizeof c->nonce, password,
549 config->authorization_algorithm);
550 if(wideopen || (res && !strcmp(res, vec[1]))) {
553 /* currently we only bother logging remote connections */
554 if(strcmp(host, "local"))
555 info("S%x %s connected from %s", c->tag, vec[0], host);
557 c->rights |= RIGHT__LOCAL;
558 sink_writes(ev_writer_sink(c->w), "230 OK\n");
561 /* oops, response was wrong */
562 info("S%x authentication failure for %s from %s", c->tag, vec[0], host);
563 sink_writes(ev_writer_sink(c->w), "530 authentication failed\n");
567 static int c_recent(struct conn *c,
568 char attribute((unused)) **vec,
569 int attribute((unused)) nvec) {
570 const struct queue_entry *q;
572 sink_writes(ev_writer_sink(c->w), "253 Tracks follow\n");
573 for(q = phead.next; q != &phead; q = q->next)
574 sink_printf(ev_writer_sink(c->w), " %s\n", queue_marshall(q));
575 sink_writes(ev_writer_sink(c->w), ".\n");
576 return 1; /* completed */
579 static int c_queue(struct conn *c,
580 char attribute((unused)) **vec,
581 int attribute((unused)) nvec) {
582 struct queue_entry *q;
587 sink_writes(ev_writer_sink(c->w), "253 Tracks follow\n");
588 if(playing_is_enabled() && !paused) {
590 queue_fix_sofar(playing);
591 if((l = trackdb_get(playing->track, "_length"))
592 && (length = atol(l))) {
594 when += length - playing->sofar + config->gap;
597 /* Nothing is playing but playing is enabled, so whatever is
598 * first in the queue can be expected to start immediately. */
601 for(q = qhead.next; q != &qhead; q = q->next) {
602 /* fill in estimated start time */
604 sink_printf(ev_writer_sink(c->w), " %s\n", queue_marshall(q));
605 /* update for next track */
607 if((l = trackdb_get(q->track, "_length"))
608 && (length = atol(l)))
609 when += length + config->gap;
614 sink_writes(ev_writer_sink(c->w), ".\n");
615 return 1; /* completed */
618 static int output_list(struct conn *c, char **vec) {
620 sink_printf(ev_writer_sink(c->w), "%s\n", *vec++);
621 sink_writes(ev_writer_sink(c->w), ".\n");
625 static int files_dirs(struct conn *c,
628 enum trackdb_listable what) {
629 const char *dir, *re, *errstr;
635 case 0: dir = 0; re = 0; break;
636 case 1: dir = vec[0]; re = 0; break;
637 case 2: dir = vec[0]; re = vec[1]; break;
640 /* A bit of a bodge to make sure the args don't trample on cache keys */
641 if(dir && strchr(dir, '\n')) {
642 sink_writes(ev_writer_sink(c->w), "550 invalid directory name\n");
645 if(re && strchr(re, '\n')) {
646 sink_writes(ev_writer_sink(c->w), "550 invalid regexp\n");
649 /* We bother eliminating "" because the web interface is relatively
650 * likely to send it */
652 byte_xasprintf(&key, "%d\n%s\n%s", (int)what, dir ? dir : "", re);
653 fvec = (char **)cache_get(&cache_files_type, key);
655 /* Got a cache hit, don't store the answer in the cache */
658 rec = 0; /* quieten compiler */
660 /* Cache miss, we'll do the lookup and key != 0 so we'll store the answer
662 if(!(rec = pcre_compile(re, PCRE_CASELESS|PCRE_UTF8,
663 &errstr, &erroffset, 0))) {
664 sink_printf(ev_writer_sink(c->w), "550 Error compiling regexp: %s\n",
668 /* It only counts as a miss if the regexp was valid. */
669 ++cache_files_misses;
672 /* No regexp, don't bother caching the result */
678 /* No cache hit (either because a miss, or because we did not look) so do
681 fvec = trackdb_list(dir, 0, what, rec);
683 fvec = trackdb_list(0, 0, what, rec);
686 /* Put the answer in the cache */
687 cache_put(&cache_files_type, key, fvec);
688 sink_writes(ev_writer_sink(c->w), "253 Listing follow\n");
689 return output_list(c, fvec);
692 static int c_files(struct conn *c,
695 return files_dirs(c, vec, nvec, trackdb_files);
698 static int c_dirs(struct conn *c,
701 return files_dirs(c, vec, nvec, trackdb_directories);
704 static int c_allfiles(struct conn *c,
707 return files_dirs(c, vec, nvec, trackdb_directories|trackdb_files);
710 static int c_get(struct conn *c,
712 int attribute((unused)) nvec) {
713 const char *v, *track;
715 if(!(track = trackdb_resolve(vec[0]))) {
716 sink_writes(ev_writer_sink(c->w), "550 cannot resolve track\n");
719 if(vec[1][0] != '_' && (v = trackdb_get(track, vec[1])))
720 sink_printf(ev_writer_sink(c->w), "252 %s\n", quoteutf8(v));
722 sink_writes(ev_writer_sink(c->w), "555 not found\n");
726 static int c_length(struct conn *c,
728 int attribute((unused)) nvec) {
729 const char *track, *v;
731 if(!(track = trackdb_resolve(vec[0]))) {
732 sink_writes(ev_writer_sink(c->w), "550 cannot resolve track\n");
735 if((v = trackdb_get(track, "_length")))
736 sink_printf(ev_writer_sink(c->w), "252 %s\n", quoteutf8(v));
738 sink_writes(ev_writer_sink(c->w), "550 not found\n");
742 static int c_set(struct conn *c,
744 int attribute((unused)) nvec) {
747 if(!(track = trackdb_resolve(vec[0]))) {
748 sink_writes(ev_writer_sink(c->w), "550 cannot resolve track\n");
751 if(vec[1][0] != '_' && !trackdb_set(track, vec[1], vec[2]))
752 sink_writes(ev_writer_sink(c->w), "250 OK\n");
754 sink_writes(ev_writer_sink(c->w), "550 not found\n");
758 static int c_prefs(struct conn *c,
760 int attribute((unused)) nvec) {
764 if(!(track = trackdb_resolve(vec[0]))) {
765 sink_writes(ev_writer_sink(c->w), "550 cannot resolve track\n");
768 k = trackdb_get_all(track);
769 sink_writes(ev_writer_sink(c->w), "253 prefs follow\n");
770 for(; k; k = k->next)
771 if(k->name[0] != '_') /* omit internal values */
772 sink_printf(ev_writer_sink(c->w),
773 " %s %s\n", quoteutf8(k->name), quoteutf8(k->value));
774 sink_writes(ev_writer_sink(c->w), ".\n");
778 static int c_exists(struct conn *c,
780 int attribute((unused)) nvec) {
781 /* trackdb_exists() does its own alias checking */
782 sink_printf(ev_writer_sink(c->w), "252 %s\n", noyes[trackdb_exists(vec[0])]);
786 static void search_parse_error(const char *msg, void *u) {
787 *(const char **)u = msg;
790 static int c_search(struct conn *c,
792 int attribute((unused)) nvec) {
793 char **terms, **results;
794 int nterms, nresults, n;
795 const char *e = "unknown error";
797 /* This is a bit of a bodge. Initially it's there to make the eclient
798 * interface a bit more convenient to add searching to, but it has the more
799 * compelling advantage that if everything uses it, then interpretation of
800 * user-supplied search strings will be the same everywhere. */
801 if(!(terms = split(vec[0], &nterms, SPLIT_QUOTES, search_parse_error, &e))) {
802 sink_printf(ev_writer_sink(c->w), "550 %s\n", e);
804 results = trackdb_search(terms, nterms, &nresults);
805 sink_printf(ev_writer_sink(c->w), "253 %d matches\n", nresults);
806 for(n = 0; n < nresults; ++n)
807 sink_printf(ev_writer_sink(c->w), "%s\n", results[n]);
808 sink_writes(ev_writer_sink(c->w), ".\n");
813 static int c_random_enable(struct conn *c,
814 char attribute((unused)) **vec,
815 int attribute((unused)) nvec) {
816 enable_random(c->who, c->ev);
817 /* Enable implicitly unpauses if there is nothing playing */
818 if(paused && !playing) resume_playing(c->who);
819 sink_writes(ev_writer_sink(c->w), "250 OK\n");
820 return 1; /* completed */
823 static int c_random_disable(struct conn *c,
824 char attribute((unused)) **vec,
825 int attribute((unused)) nvec) {
826 disable_random(c->who);
827 sink_writes(ev_writer_sink(c->w), "250 OK\n");
828 return 1; /* completed */
831 static int c_random_enabled(struct conn *c,
832 char attribute((unused)) **vec,
833 int attribute((unused)) nvec) {
834 sink_printf(ev_writer_sink(c->w), "252 %s\n", noyes[random_is_enabled()]);
835 return 1; /* completed */
838 static void got_stats(char *stats, void *u) {
839 struct conn *const c = u;
841 sink_printf(ev_writer_sink(c->w), "253 stats\n%s\n.\n", stats);
842 /* Now we can start processing commands again */
843 ev_reader_enable(c->r);
846 static int c_stats(struct conn *c,
847 char attribute((unused)) **vec,
848 int attribute((unused)) nvec) {
849 trackdb_stats_subprocess(c->ev, got_stats, c);
850 return 0; /* not yet complete */
853 static int c_volume(struct conn *c,
865 l = r = atoi(vec[0]);
876 rights = set ? RIGHT_VOLUME : RIGHT_READ;
877 if(!(c->rights & rights)) {
878 error(0, "%s attempted to set volume but lacks required rights", c->who);
879 sink_writes(ev_writer_sink(c->w), "510 Prohibited\n");
882 if(!api || !api->set_volume) {
883 sink_writes(ev_writer_sink(c->w), "550 error accessing mixer\n");
886 (set ? api->set_volume : api->get_volume)(&l, &r);
887 sink_printf(ev_writer_sink(c->w), "252 %d %d\n", l, r);
888 if(l != volume_left || r != volume_right) {
891 snprintf(lb, sizeof lb, "%d", l);
892 snprintf(rb, sizeof rb, "%d", r);
893 eventlog("volume", lb, rb, (char *)0);
898 /** @brief Called when data arrives on a log connection
900 * We just discard all such data. The client may occasionally send data as a
903 static int logging_reader_callback(ev_source attribute((unused)) *ev,
905 void attribute((unused)) *ptr,
907 int attribute((unused)) eof,
908 void attribute((unused)) *u) {
911 ev_reader_consume(reader, bytes);
913 /* Oops, that's all for now */
914 D(("logging reader eof"));
917 ev_writer_close(c->w);
921 remove_connection(c);
926 static void logclient(const char *msg, void *user) {
927 struct conn *c = user;
930 /* This connection has gone up in smoke for some reason */
931 eventlog_remove(c->lo);
935 /* user_* messages are restricted */
936 if(!strncmp(msg, "user_", 5)) {
937 /* They are only sent to admin users */
938 if(!(c->rights & RIGHT_ADMIN))
940 /* They are not sent over TCP connections unless remote user-management is
942 if(!config->remote_userman && !(c->rights & RIGHT__LOCAL))
945 sink_printf(ev_writer_sink(c->w), "%"PRIxMAX" %s\n",
946 (uintmax_t)xtime(0), msg);
949 static int c_log(struct conn *c,
950 char attribute((unused)) **vec,
951 int attribute((unused)) nvec) {
954 sink_writes(ev_writer_sink(c->w), "254 OK\n");
955 /* pump out initial state */
957 sink_printf(ev_writer_sink(c->w), "%"PRIxMAX" state %s\n",
959 playing_is_enabled() ? "enable_play" : "disable_play");
960 sink_printf(ev_writer_sink(c->w), "%"PRIxMAX" state %s\n",
962 random_is_enabled() ? "enable_random" : "disable_random");
963 sink_printf(ev_writer_sink(c->w), "%"PRIxMAX" state %s\n",
965 paused ? "pause" : "resume");
967 sink_printf(ev_writer_sink(c->w), "%"PRIxMAX" state playing\n",
970 sink_printf(ev_writer_sink(c->w), "%"PRIxMAX" volume %d %d\n",
971 (uintmax_t)now, volume_left, volume_right);
972 c->lo = xmalloc(sizeof *c->lo);
973 c->lo->fn = logclient;
976 c->reader = logging_reader_callback;
980 /** @brief Test whether a move is allowed
981 * @param c Connection
982 * @param qs List of IDs on queue
983 * @param nqs Number of IDs
984 * @return 0 if move is prohibited, non-0 if it is allowed
986 static int has_move_rights(struct conn *c, struct queue_entry **qs, int nqs) {
987 for(; nqs > 0; ++qs, --nqs) {
988 struct queue_entry *const q = *qs;
990 if(!right_movable(c->rights, c->who, q))
996 static int c_move(struct conn *c,
998 int attribute((unused)) nvec) {
999 struct queue_entry *q;
1002 if(!(q = queue_find(vec[0]))) {
1003 sink_writes(ev_writer_sink(c->w), "550 no such track on the queue\n");
1006 if(!has_move_rights(c, &q, 1)) {
1007 error(0, "%s attempted move but lacks required rights", c->who);
1008 sink_writes(ev_writer_sink(c->w),
1009 "510 Not authorized to move that track\n");
1012 n = queue_move(q, atoi(vec[1]), c->who);
1013 sink_printf(ev_writer_sink(c->w), "252 %d\n", n);
1014 /* If we've moved to the head of the queue then prepare the track. */
1020 static int c_moveafter(struct conn *c,
1022 int attribute((unused)) nvec) {
1023 struct queue_entry *q, **qs;
1027 if(!(q = queue_find(vec[0]))) {
1028 sink_writes(ev_writer_sink(c->w), "550 no such track on the queue\n");
1035 qs = xcalloc(nvec, sizeof *qs);
1036 for(n = 0; n < nvec; ++n)
1037 if(!(qs[n] = queue_find(vec[n]))) {
1038 sink_writes(ev_writer_sink(c->w), "550 no such track on the queue\n");
1041 if(!has_move_rights(c, qs, nvec)) {
1042 error(0, "%s attempted moveafter but lacks required rights", c->who);
1043 sink_writes(ev_writer_sink(c->w),
1044 "510 Not authorized to move those tracks\n");
1047 queue_moveafter(q, nvec, qs, c->who);
1048 sink_printf(ev_writer_sink(c->w), "250 Moved tracks\n");
1049 /* If we've moved to the head of the queue then prepare the track. */
1055 static int c_part(struct conn *c,
1057 int attribute((unused)) nvec) {
1060 if(!(track = trackdb_resolve(vec[0]))) {
1061 sink_writes(ev_writer_sink(c->w), "550 cannot resolve track\n");
1064 sink_printf(ev_writer_sink(c->w), "252 %s\n",
1065 quoteutf8(trackdb_getpart(track, vec[1], vec[2])));
1069 static int c_resolve(struct conn *c,
1071 int attribute((unused)) nvec) {
1074 if(!(track = trackdb_resolve(vec[0]))) {
1075 sink_writes(ev_writer_sink(c->w), "550 cannot resolve track\n");
1078 sink_printf(ev_writer_sink(c->w), "252 %s\n", quoteutf8(track));
1082 static int list_response(struct conn *c,
1085 sink_printf(ev_writer_sink(c->w), "253 %s\n", reply);
1087 sink_printf(ev_writer_sink(c->w), "%s%s\n",
1088 **list == '.' ? "." : "", *list);
1091 sink_writes(ev_writer_sink(c->w), ".\n");
1092 return 1; /* completed */
1095 static int c_tags(struct conn *c,
1096 char attribute((unused)) **vec,
1097 int attribute((unused)) nvec) {
1098 return list_response(c, "Tag list follows", trackdb_alltags());
1101 static int c_set_global(struct conn *c,
1103 int attribute((unused)) nvec) {
1104 if(vec[0][0] == '_') {
1105 sink_writes(ev_writer_sink(c->w), "550 cannot set internal global preferences\n");
1108 trackdb_set_global(vec[0], vec[1], c->who);
1109 sink_printf(ev_writer_sink(c->w), "250 OK\n");
1113 static int c_get_global(struct conn *c,
1115 int attribute((unused)) nvec) {
1116 const char *s = trackdb_get_global(vec[0]);
1119 sink_printf(ev_writer_sink(c->w), "252 %s\n", quoteutf8(s));
1121 sink_writes(ev_writer_sink(c->w), "555 not found\n");
1125 static int c_nop(struct conn *c,
1126 char attribute((unused)) **vec,
1127 int attribute((unused)) nvec) {
1128 sink_printf(ev_writer_sink(c->w), "250 Quack\n");
1132 static int c_new(struct conn *c,
1142 if(max <= 0 || max > config->new_max)
1143 max = config->new_max;
1144 tracks = trackdb_new(0, max);
1145 sink_printf(ev_writer_sink(c->w), "253 New track list follows\n");
1148 sink_printf(ev_writer_sink(c->w), "%s%s\n",
1149 **tracks == '.' ? "." : "", *tracks);
1152 sink_writes(ev_writer_sink(c->w), ".\n");
1153 return 1; /* completed */
1157 static int c_rtp_address(struct conn *c,
1158 char attribute((unused)) **vec,
1159 int attribute((unused)) nvec) {
1160 if(api == &uaudio_rtp) {
1163 netaddress_format(&config->broadcast, NULL, &addr);
1164 sink_printf(ev_writer_sink(c->w), "252 %s %s\n",
1166 quoteutf8(addr[2]));
1168 sink_writes(ev_writer_sink(c->w), "550 No RTP\n");
1172 static int c_cookie(struct conn *c,
1174 int attribute((unused)) nvec) {
1179 /* Can't log in twice on the same connection */
1181 sink_writes(ev_writer_sink(c->w), "530 already authenticated\n");
1184 /* Get some kind of peer identifcation */
1185 if(!(host = connection_host(c))) {
1186 sink_writes(ev_writer_sink(c->w), "530 authentication failure\n");
1189 /* Check the cookie */
1190 user = verify_cookie(vec[0], &rights);
1192 sink_writes(ev_writer_sink(c->w), "530 authentication failure\n");
1199 if(strcmp(host, "local"))
1200 info("S%x %s connected with cookie from %s", c->tag, user, host);
1202 c->rights |= RIGHT__LOCAL;
1203 /* Response contains username so client knows who they are acting as */
1204 sink_printf(ev_writer_sink(c->w), "232 %s\n", quoteutf8(user));
1208 static int c_make_cookie(struct conn *c,
1209 char attribute((unused)) **vec,
1210 int attribute((unused)) nvec) {
1211 const char *cookie = make_cookie(c->who);
1214 sink_printf(ev_writer_sink(c->w), "252 %s\n", quoteutf8(cookie));
1216 sink_writes(ev_writer_sink(c->w), "550 Cannot create cookie\n");
1220 static int c_revoke(struct conn *c,
1221 char attribute((unused)) **vec,
1222 int attribute((unused)) nvec) {
1224 revoke_cookie(c->cookie);
1225 sink_writes(ev_writer_sink(c->w), "250 OK\n");
1227 sink_writes(ev_writer_sink(c->w), "550 Did not log in with cookie\n");
1231 static int c_adduser(struct conn *c,
1236 if(!config->remote_userman && !(c->rights & RIGHT__LOCAL)) {
1237 error(0, "S%x: remote adduser", c->tag);
1238 sink_writes(ev_writer_sink(c->w), "550 Remote user management is disabled\n");
1243 if(parse_rights(vec[2], 0, 1)) {
1244 sink_writes(ev_writer_sink(c->w), "550 Invalid rights list\n");
1248 rights = config->default_rights;
1249 if(trackdb_adduser(vec[0], vec[1], rights,
1250 0/*email*/, 0/*confirmation*/))
1251 sink_writes(ev_writer_sink(c->w), "550 Cannot create user\n");
1253 sink_writes(ev_writer_sink(c->w), "250 User created\n");
1257 static int c_deluser(struct conn *c,
1259 int attribute((unused)) nvec) {
1262 if(!config->remote_userman && !(c->rights & RIGHT__LOCAL)) {
1263 error(0, "S%x: remote deluser", c->tag);
1264 sink_writes(ev_writer_sink(c->w), "550 Remote user management is disabled\n");
1267 if(trackdb_deluser(vec[0])) {
1268 sink_writes(ev_writer_sink(c->w), "550 Cannot delete user\n");
1271 /* Zap connections belonging to deleted user */
1272 for(d = connections; d; d = d->next)
1273 if(!strcmp(d->who, vec[0]))
1275 sink_writes(ev_writer_sink(c->w), "250 User deleted\n");
1279 static int c_edituser(struct conn *c,
1281 int attribute((unused)) nvec) {
1284 if(!config->remote_userman && !(c->rights & RIGHT__LOCAL)) {
1285 error(0, "S%x: remote edituser", c->tag);
1286 sink_writes(ev_writer_sink(c->w), "550 Remote user management is disabled\n");
1289 /* RIGHT_ADMIN can do anything; otherwise you can only set your own email
1290 * address and password. */
1291 if((c->rights & RIGHT_ADMIN)
1292 || (!strcmp(c->who, vec[0])
1293 && (!strcmp(vec[1], "email")
1294 || !strcmp(vec[1], "password")))) {
1295 if(trackdb_edituserinfo(vec[0], vec[1], vec[2])) {
1296 sink_writes(ev_writer_sink(c->w), "550 Failed to change setting\n");
1299 if(!strcmp(vec[1], "password")) {
1300 /* Zap all connections for this user after a password change */
1301 for(d = connections; d; d = d->next)
1302 if(!strcmp(d->who, vec[0]))
1304 } else if(!strcmp(vec[1], "rights")) {
1305 /* Update rights for this user */
1308 if(!parse_rights(vec[2], &r, 1)) {
1309 const char *new_rights = rights_string(r);
1310 for(d = connections; d; d = d->next) {
1311 if(!strcmp(d->who, vec[0])) {
1314 /* Notify any log connections */
1316 sink_printf(ev_writer_sink(d->w),
1317 "%"PRIxMAX" rights_changed %s\n",
1318 (uintmax_t)xtime(0),
1319 quoteutf8(new_rights));
1324 sink_writes(ev_writer_sink(c->w), "250 OK\n");
1326 error(0, "%s attempted edituser but lacks required rights", c->who);
1327 sink_writes(ev_writer_sink(c->w), "510 Restricted to administrators\n");
1332 static int c_userinfo(struct conn *c,
1333 char attribute((unused)) **vec,
1334 int attribute((unused)) nvec) {
1338 /* We allow remote querying of rights so that clients can figure out what
1339 * they're allowed to do */
1340 if(!config->remote_userman
1341 && !(c->rights & RIGHT__LOCAL)
1342 && strcmp(vec[1], "rights")) {
1343 error(0, "S%x: remote userinfo %s %s", c->tag, vec[0], vec[1]);
1344 sink_writes(ev_writer_sink(c->w), "550 Remote user management is disabled\n");
1347 /* RIGHT_ADMIN allows anything; otherwise you can only get your own email
1348 * address and rights list. */
1349 if((c->rights & RIGHT_ADMIN)
1350 || (!strcmp(c->who, vec[0])
1351 && (!strcmp(vec[1], "email")
1352 || !strcmp(vec[1], "rights")))) {
1353 if((k = trackdb_getuserinfo(vec[0])))
1354 if((value = kvp_get(k, vec[1])))
1355 sink_printf(ev_writer_sink(c->w), "252 %s\n", quoteutf8(value));
1357 sink_writes(ev_writer_sink(c->w), "555 Not set\n");
1359 sink_writes(ev_writer_sink(c->w), "550 No such user\n");
1361 error(0, "%s attempted userinfo but lacks required rights", c->who);
1362 sink_writes(ev_writer_sink(c->w), "510 Restricted to administrators\n");
1367 static int c_users(struct conn *c,
1368 char attribute((unused)) **vec,
1369 int attribute((unused)) nvec) {
1370 return list_response(c, "User list follows", trackdb_listusers());
1373 static int c_register(struct conn *c,
1375 int attribute((unused)) nvec) {
1377 uint32_t nonce[CONFIRM_SIZE];
1378 char nonce_str[(32 * CONFIRM_SIZE) / 5 + 1];
1380 /* The confirmation string is username/base62(nonce). The confirmation
1381 * process will pick the username back out to identify them but the _whole_
1382 * string is used as the confirmation string. Base 62 means we used only
1383 * letters and digits, minimizing the chance of the URL being mispasted. */
1384 gcry_randomize(nonce, sizeof nonce, GCRY_STRONG_RANDOM);
1385 if(basen(nonce, CONFIRM_SIZE, nonce_str, sizeof nonce_str, 62)) {
1386 error(0, "buffer too small encoding confirmation string");
1387 sink_writes(ev_writer_sink(c->w), "550 Cannot create user\n");
1389 byte_xasprintf(&cs, "%s/%s", vec[0], nonce_str);
1390 if(trackdb_adduser(vec[0], vec[1], config->default_rights, vec[2], cs))
1391 sink_writes(ev_writer_sink(c->w), "550 Cannot create user\n");
1393 sink_printf(ev_writer_sink(c->w), "252 %s\n", quoteutf8(cs));
1397 static int c_confirm(struct conn *c,
1399 int attribute((unused)) nvec) {
1404 /* Get some kind of peer identifcation */
1405 if(!(host = connection_host(c))) {
1406 sink_writes(ev_writer_sink(c->w), "530 Authentication failure\n");
1409 /* Picking the LAST / means we don't (here) rule out slashes in usernames. */
1410 if(!(sep = strrchr(vec[0], '/'))) {
1411 sink_writes(ev_writer_sink(c->w), "550 Malformed confirmation string\n");
1414 user = xstrndup(vec[0], sep - vec[0]);
1415 if(trackdb_confirm(user, vec[0], &rights))
1416 sink_writes(ev_writer_sink(c->w), "550 Incorrect confirmation string\n");
1421 if(strcmp(host, "local"))
1422 info("S%x %s confirmed from %s", c->tag, user, host);
1424 c->rights |= RIGHT__LOCAL;
1425 /* Response contains username so client knows who they are acting as */
1426 sink_printf(ev_writer_sink(c->w), "232 %s\n", quoteutf8(user));
1431 static int sent_reminder(ev_source attribute((unused)) *ev,
1432 pid_t attribute((unused)) pid,
1434 const struct rusage attribute((unused)) *rusage,
1436 struct conn *const c = u;
1438 /* Tell the client what went down */
1440 sink_writes(ev_writer_sink(c->w), "250 OK\n");
1442 error(0, "reminder subprocess %s", wstat(status));
1443 sink_writes(ev_writer_sink(c->w), "550 Cannot send a reminder email\n");
1445 /* Re-enable this connection */
1446 ev_reader_enable(c->r);
1450 static int c_reminder(struct conn *c,
1452 int attribute((unused)) nvec) {
1454 const char *password, *email, *text, *encoding, *charset, *content_type;
1459 static hash *last_reminder;
1461 if(!config->mail_sender) {
1462 error(0, "cannot send password reminders because mail_sender not set");
1463 sink_writes(ev_writer_sink(c->w), "550 Cannot send a reminder email\n");
1466 if(!(k = trackdb_getuserinfo(vec[0]))) {
1467 error(0, "reminder for user '%s' who does not exist", vec[0]);
1468 sink_writes(ev_writer_sink(c->w), "550 Cannot send a reminder email\n");
1471 if(!(email = kvp_get(k, "email"))
1472 || !email_valid(email)) {
1473 error(0, "user '%s' has no valid email address", vec[0]);
1474 sink_writes(ev_writer_sink(c->w), "550 Cannot send a reminder email\n");
1477 if(!(password = kvp_get(k, "password"))
1479 error(0, "user '%s' has no password", vec[0]);
1480 sink_writes(ev_writer_sink(c->w), "550 Cannot send a reminder email\n");
1483 /* Rate-limit reminders. This hash is bounded in size by the number of
1484 * users. If this is actually a problem for anyone then we can periodically
1487 last_reminder = hash_new(sizeof (time_t));
1488 last = hash_find(last_reminder, vec[0]);
1490 if(last && now < *last + config->reminder_interval) {
1491 error(0, "sent a password reminder to '%s' too recently", vec[0]);
1492 sink_writes(ev_writer_sink(c->w), "550 Cannot send a reminder email\n");
1495 /* Send the reminder */
1496 /* TODO this should be templatized and to some extent merged with
1497 * the code in act_register() */
1498 byte_xasprintf((char **)&text,
1499 "Someone requested that you be sent a reminder of your DisOrder password.\n"
1500 "Your password is:\n"
1503 if(!(text = mime_encode_text(text, &charset, &encoding)))
1504 fatal(0, "cannot encode email");
1505 byte_xasprintf((char **)&content_type, "text/plain;charset=%s",
1506 quote822(charset, 0));
1507 pid = sendmail_subprocess("", config->mail_sender, email,
1508 "DisOrder password reminder",
1509 encoding, content_type, text);
1511 sink_writes(ev_writer_sink(c->w), "550 Cannot send a reminder email\n");
1514 hash_add(last_reminder, vec[0], &now, HASH_INSERT_OR_REPLACE);
1515 info("sending a passsword reminder to user '%s'", vec[0]);
1516 /* We can only continue when the subprocess finishes */
1517 ev_child(c->ev, pid, 0, sent_reminder, c);
1521 static int c_schedule_list(struct conn *c,
1522 char attribute((unused)) **vec,
1523 int attribute((unused)) nvec) {
1524 char **ids = schedule_list(0);
1525 sink_writes(ev_writer_sink(c->w), "253 ID list follows\n");
1527 sink_printf(ev_writer_sink(c->w), "%s\n", *ids++);
1528 sink_writes(ev_writer_sink(c->w), ".\n");
1529 return 1; /* completed */
1532 static int c_schedule_get(struct conn *c,
1534 int attribute((unused)) nvec) {
1535 struct kvp *actiondata = schedule_get(vec[0]), *k;
1538 sink_writes(ev_writer_sink(c->w), "555 No such event\n");
1539 return 1; /* completed */
1541 /* Scheduled events are public information. Anyone with RIGHT_READ can see
1543 sink_writes(ev_writer_sink(c->w), "253 Event information follows\n");
1544 for(k = actiondata; k; k = k->next)
1545 sink_printf(ev_writer_sink(c->w), " %s %s\n",
1546 quoteutf8(k->name), quoteutf8(k->value));
1547 sink_writes(ev_writer_sink(c->w), ".\n");
1548 return 1; /* completed */
1551 static int c_schedule_del(struct conn *c,
1553 int attribute((unused)) nvec) {
1554 struct kvp *actiondata = schedule_get(vec[0]);
1557 sink_writes(ev_writer_sink(c->w), "555 No such event\n");
1558 return 1; /* completed */
1560 /* If you have admin rights you can delete anything. If you don't then you
1561 * can only delete your own scheduled events. */
1562 if(!(c->rights & RIGHT_ADMIN)) {
1563 const char *who = kvp_get(actiondata, "who");
1565 if(!who || !c->who || strcmp(who, c->who)) {
1566 sink_writes(ev_writer_sink(c->w), "551 Not authorized\n");
1567 return 1; /* completed */
1570 if(schedule_del(vec[0]))
1571 sink_writes(ev_writer_sink(c->w), "550 Could not delete scheduled event\n");
1573 sink_writes(ev_writer_sink(c->w), "250 Deleted\n");
1574 return 1; /* completed */
1577 static int c_schedule_add(struct conn *c,
1580 struct kvp *actiondata = 0;
1583 /* Standard fields */
1584 kvp_set(&actiondata, "who", c->who);
1585 kvp_set(&actiondata, "when", vec[0]);
1586 kvp_set(&actiondata, "priority", vec[1]);
1587 kvp_set(&actiondata, "action", vec[2]);
1588 /* Action-dependent fields */
1589 if(!strcmp(vec[2], "play")) {
1591 sink_writes(ev_writer_sink(c->w), "550 Wrong number of arguments\n");
1594 if(!trackdb_exists(vec[3])) {
1595 sink_writes(ev_writer_sink(c->w), "550 Track is not in database\n");
1598 kvp_set(&actiondata, "track", vec[3]);
1599 } else if(!strcmp(vec[2], "set-global")) {
1600 if(nvec < 4 || nvec > 5) {
1601 sink_writes(ev_writer_sink(c->w), "550 Wrong number of arguments\n");
1604 kvp_set(&actiondata, "key", vec[3]);
1606 kvp_set(&actiondata, "value", vec[4]);
1608 sink_writes(ev_writer_sink(c->w), "550 Unknown action\n");
1611 /* schedule_add() checks user rights */
1612 id = schedule_add(c->ev, actiondata);
1614 sink_writes(ev_writer_sink(c->w), "550 Cannot add scheduled event\n");
1616 sink_printf(ev_writer_sink(c->w), "252 %s\n", id);
1620 static int c_adopt(struct conn *c,
1622 int attribute((unused)) nvec) {
1623 struct queue_entry *q;
1626 sink_writes(ev_writer_sink(c->w), "550 no identity\n");
1629 if(!(q = queue_find(vec[0]))) {
1630 sink_writes(ev_writer_sink(c->w), "550 no such track on the queue\n");
1633 if(q->origin != origin_random) {
1634 sink_writes(ev_writer_sink(c->w), "550 not a random track\n");
1637 q->origin = origin_adopted;
1638 q->submitter = xstrdup(c->who);
1639 eventlog("adopted", q->id, q->submitter, (char *)0);
1641 sink_writes(ev_writer_sink(c->w), "250 OK\n");
1645 static int playlist_response(struct conn *c,
1649 assert(!"cannot cope with success");
1651 sink_writes(ev_writer_sink(c->w), "550 Access denied\n");
1654 sink_writes(ev_writer_sink(c->w), "550 Invalid playlist name\n");
1657 sink_writes(ev_writer_sink(c->w), "555 No such playlist\n");
1660 sink_writes(ev_writer_sink(c->w), "550 Error accessing playlist\n");
1666 static int c_playlist_get(struct conn *c,
1668 int attribute((unused)) nvec) {
1672 if(!(err = trackdb_playlist_get(vec[0], c->who, &tracks, 0, 0)))
1673 return list_response(c, "Playlist contents follows", tracks);
1675 return playlist_response(c, err);
1678 static int c_playlist_set(struct conn *c,
1680 int attribute((unused)) nvec) {
1681 return fetch_body(c, c_playlist_set_body, vec[0]);
1684 static int c_playlist_set_body(struct conn *c,
1688 const char *playlist = u;
1691 if(!c->locked_playlist
1692 || strcmp(playlist, c->locked_playlist)) {
1693 sink_writes(ev_writer_sink(c->w), "550 Playlist is not locked\n");
1696 if(!(err = trackdb_playlist_set(playlist, c->who,
1698 sink_printf(ev_writer_sink(c->w), "250 OK\n");
1701 return playlist_response(c, err);
1704 static int c_playlist_get_share(struct conn *c,
1706 int attribute((unused)) nvec) {
1710 if(!(err = trackdb_playlist_get(vec[0], c->who, 0, 0, &share))) {
1711 sink_printf(ev_writer_sink(c->w), "252 %s\n", quoteutf8(share));
1714 return playlist_response(c, err);
1717 static int c_playlist_set_share(struct conn *c,
1719 int attribute((unused)) nvec) {
1722 if(!(err = trackdb_playlist_set(vec[0], c->who, 0, 0, vec[1]))) {
1723 sink_printf(ev_writer_sink(c->w), "250 OK\n");
1726 return playlist_response(c, err);
1729 static int c_playlists(struct conn *c,
1730 char attribute((unused)) **vec,
1731 int attribute((unused)) nvec) {
1734 trackdb_playlist_list(c->who, &p, 0);
1735 return list_response(c, "List of playlists follows", p);
1738 static int c_playlist_delete(struct conn *c,
1740 int attribute((unused)) nvec) {
1743 if(!(err = trackdb_playlist_delete(vec[0], c->who))) {
1744 sink_writes(ev_writer_sink(c->w), "250 OK\n");
1747 return playlist_response(c, err);
1750 static int c_playlist_lock(struct conn *c,
1752 int attribute((unused)) nvec) {
1756 /* Check we're allowed to modify this playlist */
1757 if((err = trackdb_playlist_set(vec[0], c->who, 0, 0, 0)))
1758 return playlist_response(c, err);
1759 /* If we hold a lock don't allow a new one */
1760 if(c->locked_playlist) {
1761 sink_writes(ev_writer_sink(c->w), "550 Already holding a lock\n");
1764 /* See if some other connection locks the same playlist */
1765 for(cc = connections; cc; cc = cc->next)
1766 if(cc->locked_playlist && !strcmp(cc->locked_playlist, vec[0]))
1769 /* TODO: implement config->playlist_lock_timeout */
1770 sink_writes(ev_writer_sink(c->w), "550 Already locked\n");
1773 c->locked_playlist = xstrdup(vec[0]);
1774 time(&c->locked_when);
1775 sink_writes(ev_writer_sink(c->w), "250 Acquired lock\n");
1779 static int c_playlist_unlock(struct conn *c,
1780 char attribute((unused)) **vec,
1781 int attribute((unused)) nvec) {
1782 if(!c->locked_playlist) {
1783 sink_writes(ev_writer_sink(c->w), "550 Not holding a lock\n");
1786 c->locked_playlist = 0;
1787 sink_writes(ev_writer_sink(c->w), "250 Released lock\n");
1791 static const struct command {
1792 /** @brief Command name */
1795 /** @brief Minimum number of arguments */
1798 /** @brief Maximum number of arguments */
1801 /** @brief Function to process command */
1802 int (*fn)(struct conn *, char **, int);
1804 /** @brief Rights required to execute command
1806 * 0 means that the command can be issued without logging in. If multiple
1807 * bits are listed here any of those rights will do.
1811 { "adduser", 2, 3, c_adduser, RIGHT_ADMIN|RIGHT__LOCAL },
1812 { "adopt", 1, 1, c_adopt, RIGHT_PLAY },
1813 { "allfiles", 0, 2, c_allfiles, RIGHT_READ },
1814 { "confirm", 1, 1, c_confirm, 0 },
1815 { "cookie", 1, 1, c_cookie, 0 },
1816 { "deluser", 1, 1, c_deluser, RIGHT_ADMIN|RIGHT__LOCAL },
1817 { "dirs", 0, 2, c_dirs, RIGHT_READ },
1818 { "disable", 0, 1, c_disable, RIGHT_GLOBAL_PREFS },
1819 { "edituser", 3, 3, c_edituser, RIGHT_ADMIN|RIGHT_USERINFO },
1820 { "enable", 0, 0, c_enable, RIGHT_GLOBAL_PREFS },
1821 { "enabled", 0, 0, c_enabled, RIGHT_READ },
1822 { "exists", 1, 1, c_exists, RIGHT_READ },
1823 { "files", 0, 2, c_files, RIGHT_READ },
1824 { "get", 2, 2, c_get, RIGHT_READ },
1825 { "get-global", 1, 1, c_get_global, RIGHT_READ },
1826 { "length", 1, 1, c_length, RIGHT_READ },
1827 { "log", 0, 0, c_log, RIGHT_READ },
1828 { "make-cookie", 0, 0, c_make_cookie, RIGHT_READ },
1829 { "move", 2, 2, c_move, RIGHT_MOVE__MASK },
1830 { "moveafter", 1, INT_MAX, c_moveafter, RIGHT_MOVE__MASK },
1831 { "new", 0, 1, c_new, RIGHT_READ },
1832 { "nop", 0, 0, c_nop, 0 },
1833 { "part", 3, 3, c_part, RIGHT_READ },
1834 { "pause", 0, 0, c_pause, RIGHT_PAUSE },
1835 { "play", 1, 1, c_play, RIGHT_PLAY },
1836 { "playing", 0, 0, c_playing, RIGHT_READ },
1837 { "playlist-delete", 1, 1, c_playlist_delete, RIGHT_PLAY },
1838 { "playlist-get", 1, 1, c_playlist_get, RIGHT_READ },
1839 { "playlist-get-share", 1, 1, c_playlist_get_share, RIGHT_READ },
1840 { "playlist-lock", 1, 1, c_playlist_lock, RIGHT_PLAY },
1841 { "playlist-set", 1, 1, c_playlist_set, RIGHT_PLAY },
1842 { "playlist-set-share", 2, 2, c_playlist_set_share, RIGHT_PLAY },
1843 { "playlist-unlock", 0, 0, c_playlist_unlock, RIGHT_PLAY },
1844 { "playlists", 0, 0, c_playlists, RIGHT_READ },
1845 { "prefs", 1, 1, c_prefs, RIGHT_READ },
1846 { "queue", 0, 0, c_queue, RIGHT_READ },
1847 { "random-disable", 0, 0, c_random_disable, RIGHT_GLOBAL_PREFS },
1848 { "random-enable", 0, 0, c_random_enable, RIGHT_GLOBAL_PREFS },
1849 { "random-enabled", 0, 0, c_random_enabled, RIGHT_READ },
1850 { "recent", 0, 0, c_recent, RIGHT_READ },
1851 { "reconfigure", 0, 0, c_reconfigure, RIGHT_ADMIN },
1852 { "register", 3, 3, c_register, RIGHT_REGISTER|RIGHT__LOCAL },
1853 { "reminder", 1, 1, c_reminder, RIGHT__LOCAL },
1854 { "remove", 1, 1, c_remove, RIGHT_REMOVE__MASK },
1855 { "rescan", 0, INT_MAX, c_rescan, RIGHT_RESCAN },
1856 { "resolve", 1, 1, c_resolve, RIGHT_READ },
1857 { "resume", 0, 0, c_resume, RIGHT_PAUSE },
1858 { "revoke", 0, 0, c_revoke, RIGHT_READ },
1859 { "rtp-address", 0, 0, c_rtp_address, 0 },
1860 { "schedule-add", 3, INT_MAX, c_schedule_add, RIGHT_READ },
1861 { "schedule-del", 1, 1, c_schedule_del, RIGHT_READ },
1862 { "schedule-get", 1, 1, c_schedule_get, RIGHT_READ },
1863 { "schedule-list", 0, 0, c_schedule_list, RIGHT_READ },
1864 { "scratch", 0, 1, c_scratch, RIGHT_SCRATCH__MASK },
1865 { "search", 1, 1, c_search, RIGHT_READ },
1866 { "set", 3, 3, c_set, RIGHT_PREFS, },
1867 { "set-global", 2, 2, c_set_global, RIGHT_GLOBAL_PREFS },
1868 { "shutdown", 0, 0, c_shutdown, RIGHT_ADMIN },
1869 { "stats", 0, 0, c_stats, RIGHT_READ },
1870 { "tags", 0, 0, c_tags, RIGHT_READ },
1871 { "unset", 2, 2, c_set, RIGHT_PREFS },
1872 { "unset-global", 1, 1, c_set_global, RIGHT_GLOBAL_PREFS },
1873 { "user", 2, 2, c_user, 0 },
1874 { "userinfo", 2, 2, c_userinfo, RIGHT_READ },
1875 { "users", 0, 0, c_users, RIGHT_READ },
1876 { "version", 0, 0, c_version, RIGHT_READ },
1877 { "volume", 0, 2, c_volume, RIGHT_READ|RIGHT_VOLUME }
1880 /** @brief Fetch a command body
1881 * @param c Connection
1882 * @param body_callback Called with body
1883 * @param u Passed to body_callback
1886 static int fetch_body(struct conn *c,
1887 body_callback_type body_callback,
1889 assert(c->line_reader == command);
1890 c->line_reader = body_line;
1891 c->body_callback = body_callback;
1893 vector_init(c->body);
1897 /** @brief @ref line_reader_type callback for command body lines
1898 * @param c Connection
1900 * @return 1 if complete, 0 if incomplete
1902 * Called from reader_callback().
1904 static int body_line(struct conn *c,
1909 /* That's the lot */
1910 c->line_reader = command;
1911 vector_terminate(c->body);
1912 return c->body_callback(c, c->body->vec, c->body->nvec, c->body_u);
1915 vector_append(c->body, xstrdup(line));
1916 return 1; /* completed */
1919 static void command_error(const char *msg, void *u) {
1922 sink_printf(ev_writer_sink(c->w), "500 parse error: %s\n", msg);
1925 /** @brief @ref line_reader_type callback for commands
1926 * @param c Connection
1928 * @return 1 if complete, 0 if incomplete
1930 * Called from reader_callback().
1932 static int command(struct conn *c, char *line) {
1936 D(("server command %s", line));
1937 /* We force everything into NFC as early as possible */
1938 if(!(line = utf8_compose_canon(line, strlen(line), 0))) {
1939 sink_writes(ev_writer_sink(c->w), "500 cannot normalize command\n");
1942 if(!(vec = split(line, &nvec, SPLIT_QUOTES, command_error, c))) {
1943 sink_writes(ev_writer_sink(c->w), "500 cannot parse command\n");
1947 sink_writes(ev_writer_sink(c->w), "500 do what?\n");
1950 if((n = TABLE_FIND(commands, name, vec[0])) < 0)
1951 sink_writes(ev_writer_sink(c->w), "500 unknown command\n");
1953 if(commands[n].rights
1954 && !(c->rights & commands[n].rights)) {
1955 error(0, "%s attempted %s but lacks required rights", c->who ? c->who : "NULL",
1957 sink_writes(ev_writer_sink(c->w), "510 Prohibited\n");
1962 if(nvec < commands[n].minargs) {
1963 sink_writes(ev_writer_sink(c->w), "500 missing argument(s)\n");
1966 if(nvec > commands[n].maxargs) {
1967 sink_writes(ev_writer_sink(c->w), "500 too many arguments\n");
1970 return commands[n].fn(c, vec, nvec);
1972 return 1; /* completed */
1975 /* redirect to the right reader callback for our current state */
1976 static int redirect_reader_callback(ev_source *ev,
1984 return c->reader(ev, reader, ptr, bytes, eof, u);
1987 /* the main command reader */
1988 static int reader_callback(ev_source attribute((unused)) *ev,
1998 D(("server reader_callback"));
1999 while((eol = memchr(ptr, '\n', bytes))) {
2001 ev_reader_consume(reader, eol - (char *)ptr);
2002 complete = c->line_reader(c, ptr); /* usually command() */
2003 bytes -= (eol - (char *)ptr);
2006 /* the command had better have set a new reader callback */
2008 /* there are further bytes to read, or we are at eof; arrange for the
2009 * command's reader callback to handle them */
2010 return ev_reader_incomplete(reader);
2011 /* nothing's going on right now */
2014 /* command completed, we can go around and handle the next one */
2018 error(0, "S%x unterminated line", c->tag);
2019 D(("normal reader close"));
2022 D(("close associated writer"));
2023 ev_writer_close(c->w);
2026 remove_connection(c);
2031 static int listen_callback(ev_source *ev,
2033 const struct sockaddr attribute((unused)) *remote,
2034 socklen_t attribute((unused)) rlen,
2036 const struct listener *l = u;
2037 struct conn *c = xmalloc(sizeof *c);
2038 static unsigned tags;
2040 D(("server listen_callback fd %d (%s)", fd, l->name));
2043 c->next = connections;
2046 c->w = ev_writer_new(ev, fd, writer_error, c,
2049 error(0, "ev_writer_new for file inbound connection (fd=%d) failed",
2054 c->r = ev_reader_new(ev, fd, redirect_reader_callback, reader_error, c,
2057 /* Main reason for failure is the FD is too big and that will already have
2059 fatal(0, "ev_reader_new for file inbound connection (fd=%d) failed", fd);
2062 c->reader = reader_callback;
2065 c->line_reader = command;
2067 gcry_randomize(c->nonce, sizeof c->nonce, GCRY_STRONG_RANDOM);
2068 sink_printf(ev_writer_sink(c->w), "231 %d %s %s\n",
2070 config->authorization_algorithm,
2071 hex(c->nonce, sizeof c->nonce));
2075 int server_start(ev_source *ev, int pf,
2076 size_t socklen, const struct sockaddr *sa,
2079 struct listener *l = xmalloc(sizeof *l);
2080 static const int one = 1;
2082 D(("server_init socket %s", name));
2083 fd = xsocket(pf, SOCK_STREAM, 0);
2084 xsetsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &one, sizeof one);
2085 if(bind(fd, sa, socklen) < 0) {
2086 error(errno, "error binding to %s", name);
2094 if(ev_listen(ev, fd, listen_callback, l, "server listener"))
2096 info("listening on %s", name);
2100 int server_stop(ev_source *ev, int fd) {
2102 return ev_listen_cancel(ev, fd);