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
50 /** @brief Signature for line reader callback
53 * @return 0 if incomplete, 1 if complete
55 * @p line is 0-terminated and excludes the newline. It points into the
56 * input buffer so will become invalid shortly.
58 typedef int line_reader_type(struct conn *c,
61 /** @brief Signature for with-body command callbacks
63 * @param body List of body lines
64 * @param nbody Number of body lines
65 * @param u As passed to fetch_body()
66 * @return 0 to suspend input, 1 if complete
68 * The body strings are allocated (so survive indefinitely) and don't include
71 typedef int body_callback_type(struct conn *c,
76 /** @brief One client connection */
78 /** @brief Read commands from here */
80 /** @brief Send responses to here */
82 /** @brief Underlying file descriptor */
84 /** @brief Unique identifier for connection used in log messages */
86 /** @brief Login name or NULL */
88 /** @brief Event loop */
90 /** @brief Nonce chosen for this connection */
91 unsigned char nonce[NONCE_SIZE];
92 /** @brief Current reader callback
94 * We change this depending on whether we're servicing the @b log command
96 ev_reader_callback *reader;
97 /** @brief Event log output sending to this connection */
98 struct eventlog_output *lo;
99 /** @brief Parent listener */
100 const struct listener *l;
101 /** @brief Login cookie or NULL */
103 /** @brief Connection rights */
105 /** @brief Next connection */
107 /** @brief True if pending rescan had 'wait' set */
109 /** @brief Playlist that this connection locks */
110 const char *locked_playlist;
111 /** @brief When that playlist was locked */
113 /** @brief Line reader function */
114 line_reader_type *line_reader;
115 /** @brief Called when command body has been read */
116 body_callback_type *body_callback;
117 /** @brief Passed to @c body_callback */
119 /** @brief Accumulating body */
120 struct vector body[1];
123 /** @brief Linked list of connections */
124 static struct conn *connections;
126 static int reader_callback(ev_source *ev,
132 static int c_playlist_set_body(struct conn *c,
136 static int fetch_body(struct conn *c,
137 body_callback_type body_callback,
139 static int body_line(struct conn *c, char *line);
140 static int command(struct conn *c, char *line);
142 static const char *noyes[] = { "no", "yes" };
144 /** @brief Remove a connection from the connection list */
145 static void remove_connection(struct conn *c) {
148 for(cc = &connections; *cc && *cc != c; cc = &(*cc)->next)
154 /** @brief Called when a connection's writer fails or is shut down
156 * If the connection still has a raeder that is cancelled.
158 static int writer_error(ev_source attribute((unused)) *ev,
163 D(("server writer_error S%x %d", c->tag, errno_value));
164 if(errno_value == 0) {
166 D(("S%x writer completed", c->tag));
168 if(errno_value != EPIPE)
169 disorder_error(errno_value, "S%x write error on socket", c->tag);
171 D(("cancel reader"));
172 ev_reader_cancel(c->r);
175 D(("done cancel reader"));
179 remove_connection(c);
183 /** @brief Called when a conncetion's reader fails or is shut down
185 * If connection still has a writer then it is closed.
187 static int reader_error(ev_source attribute((unused)) *ev,
192 D(("server reader_error S%x %d", c->tag, errno_value));
193 disorder_error(errno_value, "S%x read error on socket", c->tag);
195 ev_writer_close(c->w);
199 remove_connection(c);
203 static int c_disable(struct conn *c, char **vec, int nvec) {
205 disable_playing(c->who, c->ev);
206 else if(nvec == 1 && !strcmp(vec[0], "now"))
207 disable_playing(c->who, c->ev);
209 sink_writes(ev_writer_sink(c->w), "550 invalid argument\n");
210 return 1; /* completed */
212 sink_writes(ev_writer_sink(c->w), "250 OK\n");
213 return 1; /* completed */
216 static int c_enable(struct conn *c,
217 char attribute((unused)) **vec,
218 int attribute((unused)) nvec) {
219 enable_playing(c->who, c->ev);
220 /* Enable implicitly unpauses if there is nothing playing */
221 if(paused && !playing) resume_playing(c->who);
222 sink_writes(ev_writer_sink(c->w), "250 OK\n");
223 return 1; /* completed */
226 static int c_enabled(struct conn *c,
227 char attribute((unused)) **vec,
228 int attribute((unused)) nvec) {
229 sink_printf(ev_writer_sink(c->w), "252 %s\n", noyes[playing_is_enabled()]);
230 return 1; /* completed */
233 static int c_play(struct conn *c, char **vec,
234 int attribute((unused)) nvec) {
236 struct queue_entry *q;
238 if(!trackdb_exists(vec[0])) {
239 sink_writes(ev_writer_sink(c->w), "550 track is not in database\n");
242 if(!(track = trackdb_resolve(vec[0]))) {
243 sink_writes(ev_writer_sink(c->w), "550 cannot resolve track\n");
246 q = queue_add(track, c->who, WHERE_BEFORE_RANDOM, NULL, origin_picked);
248 sink_printf(ev_writer_sink(c->w), "252 %s\n", q->id);
249 /* We make sure the track at the head of the queue is prepared, just in case
250 * we added it. We could be more subtle but prepare() will ensure we don't
251 * prepare the same track twice so there's no point. */
252 if(qhead.next != &qhead)
253 prepare(c->ev, qhead.next);
254 /* If the queue was empty but we are for some reason paused then
256 if(!playing) resume_playing(0);
258 return 1; /* completed */
261 static int c_playafter(struct conn *c, char **vec,
262 int attribute((unused)) nvec) {
264 struct queue_entry *q;
265 const char *afterme = vec[0];
267 for(int n = 1; n < nvec; ++n) {
268 if(!trackdb_exists(vec[n])) {
269 sink_writes(ev_writer_sink(c->w), "550 track is not in database\n");
272 if(!(track = trackdb_resolve(vec[n]))) {
273 sink_writes(ev_writer_sink(c->w), "550 cannot resolve track\n");
276 q = queue_add(track, c->who, WHERE_AFTER, afterme, origin_picked);
278 sink_printf(ev_writer_sink(c->w), "550 No such ID\n");
281 disorder_info("added %s as %s after %s", track, q->id, afterme);
285 sink_printf(ev_writer_sink(c->w), "252 OK\n");
286 /* We make sure the track at the head of the queue is prepared, just in case
287 * we added it. We could be more subtle but prepare() will ensure we don't
288 * prepare the same track twice so there's no point. */
289 if(qhead.next != &qhead) {
290 prepare(c->ev, qhead.next);
291 disorder_info("prepared %s", qhead.next->id);
293 /* If the queue was empty but we are for some reason paused then
298 return 1; /* completed */
301 static int c_remove(struct conn *c, char **vec,
302 int attribute((unused)) nvec) {
303 struct queue_entry *q;
305 if(!(q = queue_find(vec[0]))) {
306 sink_writes(ev_writer_sink(c->w), "550 no such track on the queue\n");
309 if(!right_removable(c->rights, c->who, q)) {
310 disorder_error(0, "%s attempted remove but lacks required rights", c->who);
311 sink_writes(ev_writer_sink(c->w),
312 "510 Not authorized to remove that track\n");
315 queue_remove(q, c->who);
316 /* De-prepare the track. */
318 /* See about adding a new random track */
319 add_random_track(c->ev);
320 /* Prepare whatever the next head track is. */
321 if(qhead.next != &qhead)
322 prepare(c->ev, qhead.next);
324 sink_writes(ev_writer_sink(c->w), "250 removed\n");
325 return 1; /* completed */
328 static int c_scratch(struct conn *c,
332 sink_writes(ev_writer_sink(c->w), "250 nothing is playing\n");
333 return 1; /* completed */
335 /* TODO there is a bug here: if we specify an ID but it's not the currently
336 * playing track then you will get 550 if you weren't authorized to scratch
337 * the currently playing track. */
338 if(!right_scratchable(c->rights, c->who, playing)) {
339 disorder_error(0, "%s attempted scratch but lacks required rights", c->who);
340 sink_writes(ev_writer_sink(c->w),
341 "510 Not authorized to scratch that track\n");
344 scratch(c->who, nvec == 1 ? vec[0] : 0);
345 /* If you scratch an unpaused track then it is automatically unpaused */
347 sink_writes(ev_writer_sink(c->w), "250 scratched\n");
348 return 1; /* completed */
351 static int c_pause(struct conn *c,
352 char attribute((unused)) **vec,
353 int attribute((unused)) nvec) {
355 sink_writes(ev_writer_sink(c->w), "250 nothing is playing\n");
356 return 1; /* completed */
359 sink_writes(ev_writer_sink(c->w), "250 already paused\n");
360 return 1; /* completed */
362 if(pause_playing(c->who) < 0)
363 sink_writes(ev_writer_sink(c->w), "550 cannot pause this track\n");
365 sink_writes(ev_writer_sink(c->w), "250 paused\n");
369 static int c_resume(struct conn *c,
370 char attribute((unused)) **vec,
371 int attribute((unused)) nvec) {
373 sink_writes(ev_writer_sink(c->w), "250 not paused\n");
374 return 1; /* completed */
376 resume_playing(c->who);
377 sink_writes(ev_writer_sink(c->w), "250 paused\n");
381 static int c_shutdown(struct conn *c,
382 char attribute((unused)) **vec,
383 int attribute((unused)) nvec) {
384 disorder_info("S%x shut down by %s", c->tag, c->who);
385 sink_writes(ev_writer_sink(c->w), "250 shutting down\n");
386 ev_writer_flush(c->w);
390 static int c_reconfigure(struct conn *c,
391 char attribute((unused)) **vec,
392 int attribute((unused)) nvec) {
393 disorder_info("S%x reconfigure by %s", c->tag, c->who);
394 if(reconfigure(c->ev, 1))
395 sink_writes(ev_writer_sink(c->w), "550 error reading new config\n");
397 sink_writes(ev_writer_sink(c->w), "250 installed new config\n");
398 return 1; /* completed */
401 static void finished_rescan(void *ru) {
402 struct conn *const c = ru;
404 sink_writes(ev_writer_sink(c->w), "250 rescan completed\n");
405 /* Turn this connection back on */
406 ev_reader_enable(c->r);
409 static void start_fresh_rescan(void *ru) {
410 struct conn *const c = ru;
412 if(trackdb_rescan_underway()) {
413 /* Some other waiter beat us to it. However in this case we're happy to
414 * piggyback; the requirement is that a new rescan be started, not that it
415 * was _our_ rescan. */
417 /* We block until the rescan completes */
418 trackdb_add_rescanned(finished_rescan, c);
420 /* We report that the new rescan has started */
421 sink_writes(ev_writer_sink(c->w), "250 rescan initiated\n");
422 /* Turn this connection back on */
423 ev_reader_enable(c->r);
426 /* We are the first connection to get a callback so we must start a
429 /* We want to block until the new rescan completes */
430 trackdb_rescan(c->ev, 1/*check*/, finished_rescan, c);
432 /* We can report back immediately */
433 trackdb_rescan(c->ev, 1/*check*/, 0, 0);
434 sink_writes(ev_writer_sink(c->w), "250 rescan initiated\n");
435 /* Turn this connection back on */
436 ev_reader_enable(c->r);
441 static int c_rescan(struct conn *c,
444 int flag_wait = 0, flag_fresh = 0, n;
447 for(n = 0; n < nvec; ++n) {
448 if(!strcmp(vec[n], "wait"))
449 flag_wait = 1; /* wait for rescan to complete */
451 /* Currently disabled because untested (and hard to test). */
452 else if(!strcmp(vec[n], "fresh"))
453 flag_fresh = 1; /* don't piggyback underway rescan */
456 sink_writes(ev_writer_sink(c->w), "550 unknown flag\n");
457 return 1; /* completed */
460 /* Report what was requested */
461 disorder_info("S%x rescan by %s (%s %s)", c->tag, c->who,
462 flag_wait ? "wait" : "",
463 flag_fresh ? "fresh" : "");
464 if(trackdb_rescan_underway()) {
466 /* We want a fresh rescan but there is already one underway. Arrange a
467 * callback when it completes and then set off a new one. */
468 c->rescan_wait = flag_wait;
469 trackdb_add_rescanned(start_fresh_rescan, c);
473 sink_writes(ev_writer_sink(c->w), "250 rescan queued\n");
477 /* There's a rescan underway, and it's acceptable to piggyback on it */
479 /* We want to block until completion. */
480 trackdb_add_rescanned(finished_rescan, c);
483 /* We don't want to block. So we just report that things are in
485 sink_writes(ev_writer_sink(c->w), "250 rescan already underway\n");
490 /* No rescan is underway. fresh is therefore irrelevant. */
492 /* We want to block until completion */
493 trackdb_rescan(c->ev, 1/*check*/, finished_rescan, c);
496 /* We don't want to block. */
497 trackdb_rescan(c->ev, 1/*check*/, 0, 0);
498 sink_writes(ev_writer_sink(c->w), "250 rescan initiated\n");
499 return 1; /* completed */
504 static int c_version(struct conn *c,
505 char attribute((unused)) **vec,
506 int attribute((unused)) nvec) {
507 /* VERSION had better only use the basic character set */
508 sink_printf(ev_writer_sink(c->w), "251 %s\n", disorder_short_version_string);
509 return 1; /* completed */
512 static int c_playing(struct conn *c,
513 char attribute((unused)) **vec,
514 int attribute((unused)) nvec) {
516 queue_fix_sofar(playing);
517 playing->expected = 0;
518 sink_printf(ev_writer_sink(c->w), "252 %s\n", queue_marshall(playing));
520 sink_printf(ev_writer_sink(c->w), "259 nothing playing\n");
521 return 1; /* completed */
524 static const char *connection_host(struct conn *c) {
527 struct sockaddr_in in;
528 struct sockaddr_in6 in6;
534 /* get connection data */
536 if(getpeername(c->fd, &u.sa, &l) < 0) {
537 disorder_error(errno, "S%x error calling getpeername", c->tag);
540 if(c->l->pf != PF_UNIX) {
541 if((n = getnameinfo(&u.sa, l,
542 host, sizeof host, 0, 0, NI_NUMERICHOST))) {
543 disorder_error(0, "S%x error calling getnameinfo: %s",
544 c->tag, gai_strerror(n));
547 return xstrdup(host);
552 static int c_user(struct conn *c,
554 int attribute((unused)) nvec) {
556 const char *res, *host, *password;
560 sink_writes(ev_writer_sink(c->w), "530 already authenticated\n");
563 /* get connection data */
564 if(!(host = connection_host(c))) {
565 sink_writes(ev_writer_sink(c->w), "530 authentication failure\n");
569 k = trackdb_getuserinfo(vec[0]);
570 /* reject nonexistent users */
572 disorder_error(0, "S%x unknown user '%s' from %s", c->tag, vec[0], host);
573 sink_writes(ev_writer_sink(c->w), "530 authentication failed\n");
576 /* reject unconfirmed users */
577 if(kvp_get(k, "confirmation")) {
578 disorder_error(0, "S%x unconfirmed user '%s' from %s",
579 c->tag, vec[0], host);
580 sink_writes(ev_writer_sink(c->w), "530 authentication failed\n");
583 password = kvp_get(k, "password");
584 if(!password) password = "";
585 if(parse_rights(kvp_get(k, "rights"), &rights, 1)) {
586 disorder_error(0, "error parsing rights for %s", vec[0]);
587 sink_writes(ev_writer_sink(c->w), "530 authentication failed\n");
590 /* check whether the response is right */
591 res = authhash(c->nonce, sizeof c->nonce, password,
592 config->authorization_algorithm);
593 if(wideopen || c->l->privileged || (res && !strcmp(res, vec[1]))) {
596 /* currently we only bother logging remote connections */
597 if(strcmp(host, "local"))
598 disorder_info("S%x %s connected from %s", c->tag, vec[0], host);
600 c->rights |= RIGHT__LOCAL;
601 sink_writes(ev_writer_sink(c->w), "230 OK\n");
604 /* oops, response was wrong */
605 disorder_info("S%x authentication failure for %s from %s",
606 c->tag, vec[0], host);
607 sink_writes(ev_writer_sink(c->w), "530 authentication failed\n");
611 static int c_recent(struct conn *c,
612 char attribute((unused)) **vec,
613 int attribute((unused)) nvec) {
614 const struct queue_entry *q;
616 sink_writes(ev_writer_sink(c->w), "253 Tracks follow\n");
617 for(q = phead.next; q != &phead; q = q->next)
618 sink_printf(ev_writer_sink(c->w), " %s\n", queue_marshall(q));
619 sink_writes(ev_writer_sink(c->w), ".\n");
620 return 1; /* completed */
623 static int c_queue(struct conn *c,
624 char attribute((unused)) **vec,
625 int attribute((unused)) nvec) {
626 struct queue_entry *q;
631 sink_writes(ev_writer_sink(c->w), "253 Tracks follow\n");
632 if(playing_is_enabled() && !paused) {
634 queue_fix_sofar(playing);
635 if((l = trackdb_get(playing->track, "_length"))
636 && (length = atol(l))) {
638 when += length - playing->sofar;
641 /* Nothing is playing but playing is enabled, so whatever is
642 * first in the queue can be expected to start immediately. */
645 for(q = qhead.next; q != &qhead; q = q->next) {
646 /* fill in estimated start time */
648 sink_printf(ev_writer_sink(c->w), " %s\n", queue_marshall(q));
649 /* update for next track */
651 if((l = trackdb_get(q->track, "_length"))
652 && (length = atol(l)))
658 sink_writes(ev_writer_sink(c->w), ".\n");
659 return 1; /* completed */
662 static int output_list(struct conn *c, char **vec) {
664 sink_printf(ev_writer_sink(c->w), "%s\n", *vec++);
665 sink_writes(ev_writer_sink(c->w), ".\n");
669 static int files_dirs(struct conn *c,
672 enum trackdb_listable what) {
673 const char *dir, *re, *errstr;
679 case 0: dir = 0; re = 0; break;
680 case 1: dir = vec[0]; re = 0; break;
681 case 2: dir = vec[0]; re = vec[1]; break;
684 /* A bit of a bodge to make sure the args don't trample on cache keys */
685 if(dir && strchr(dir, '\n')) {
686 sink_writes(ev_writer_sink(c->w), "550 invalid directory name\n");
689 if(re && strchr(re, '\n')) {
690 sink_writes(ev_writer_sink(c->w), "550 invalid regexp\n");
693 /* We bother eliminating "" because the web interface is relatively
694 * likely to send it */
696 byte_xasprintf(&key, "%d\n%s\n%s", (int)what, dir ? dir : "", re);
697 fvec = (char **)cache_get(&cache_files_type, key);
699 /* Got a cache hit, don't store the answer in the cache */
702 rec = 0; /* quieten compiler */
704 /* Cache miss, we'll do the lookup and key != 0 so we'll store the answer
706 if(!(rec = pcre_compile(re, PCRE_CASELESS|PCRE_UTF8,
707 &errstr, &erroffset, 0))) {
708 sink_printf(ev_writer_sink(c->w), "550 Error compiling regexp: %s\n",
712 /* It only counts as a miss if the regexp was valid. */
713 ++cache_files_misses;
716 /* No regexp, don't bother caching the result */
722 /* No cache hit (either because a miss, or because we did not look) so do
725 fvec = trackdb_list(dir, 0, what, rec);
727 fvec = trackdb_list(0, 0, what, rec);
730 /* Put the answer in the cache */
731 cache_put(&cache_files_type, key, fvec);
732 sink_writes(ev_writer_sink(c->w), "253 Listing follow\n");
733 return output_list(c, fvec);
736 static int c_files(struct conn *c,
739 return files_dirs(c, vec, nvec, trackdb_files);
742 static int c_dirs(struct conn *c,
745 return files_dirs(c, vec, nvec, trackdb_directories);
748 static int c_allfiles(struct conn *c,
751 return files_dirs(c, vec, nvec, trackdb_directories|trackdb_files);
754 static int c_get(struct conn *c,
756 int attribute((unused)) nvec) {
757 const char *v, *track;
759 if(!(track = trackdb_resolve(vec[0]))) {
760 sink_writes(ev_writer_sink(c->w), "550 cannot resolve track\n");
763 if(vec[1][0] != '_' && (v = trackdb_get(track, vec[1])))
764 sink_printf(ev_writer_sink(c->w), "252 %s\n", quoteutf8(v));
766 sink_writes(ev_writer_sink(c->w), "555 not found\n");
770 static int c_length(struct conn *c,
772 int attribute((unused)) nvec) {
773 const char *track, *v;
775 if(!(track = trackdb_resolve(vec[0]))) {
776 sink_writes(ev_writer_sink(c->w), "550 cannot resolve track\n");
779 if((v = trackdb_get(track, "_length")))
780 sink_printf(ev_writer_sink(c->w), "252 %s\n", quoteutf8(v));
782 sink_writes(ev_writer_sink(c->w), "550 not found\n");
786 static int c_set(struct conn *c,
788 int attribute((unused)) nvec) {
791 if(!(track = trackdb_resolve(vec[0]))) {
792 sink_writes(ev_writer_sink(c->w), "550 cannot resolve track\n");
795 if(vec[1][0] != '_' && !trackdb_set(track, vec[1], vec[2]))
796 sink_writes(ev_writer_sink(c->w), "250 OK\n");
798 sink_writes(ev_writer_sink(c->w), "550 not found\n");
802 static int c_prefs(struct conn *c,
804 int attribute((unused)) nvec) {
808 if(!(track = trackdb_resolve(vec[0]))) {
809 sink_writes(ev_writer_sink(c->w), "550 cannot resolve track\n");
812 k = trackdb_get_all(track);
813 sink_writes(ev_writer_sink(c->w), "253 prefs follow\n");
814 for(; k; k = k->next)
815 if(k->name[0] != '_') /* omit internal values */
816 sink_printf(ev_writer_sink(c->w),
817 " %s %s\n", quoteutf8(k->name), quoteutf8(k->value));
818 sink_writes(ev_writer_sink(c->w), ".\n");
822 static int c_exists(struct conn *c,
824 int attribute((unused)) nvec) {
825 /* trackdb_exists() does its own alias checking */
826 sink_printf(ev_writer_sink(c->w), "252 %s\n", noyes[trackdb_exists(vec[0])]);
830 static void search_parse_error(const char *msg, void *u) {
831 *(const char **)u = msg;
834 static int c_search(struct conn *c,
836 int attribute((unused)) nvec) {
837 char **terms, **results;
838 int nterms, nresults, n;
839 const char *e = "unknown error";
841 /* This is a bit of a bodge. Initially it's there to make the eclient
842 * interface a bit more convenient to add searching to, but it has the more
843 * compelling advantage that if everything uses it, then interpretation of
844 * user-supplied search strings will be the same everywhere. */
845 if(!(terms = split(vec[0], &nterms, SPLIT_QUOTES, search_parse_error, &e))) {
846 sink_printf(ev_writer_sink(c->w), "550 %s\n", e);
848 results = trackdb_search(terms, nterms, &nresults);
849 sink_printf(ev_writer_sink(c->w), "253 %d matches\n", nresults);
850 for(n = 0; n < nresults; ++n)
851 sink_printf(ev_writer_sink(c->w), "%s\n", results[n]);
852 sink_writes(ev_writer_sink(c->w), ".\n");
857 static int c_random_enable(struct conn *c,
858 char attribute((unused)) **vec,
859 int attribute((unused)) nvec) {
860 enable_random(c->who, c->ev);
861 /* Enable implicitly unpauses if there is nothing playing */
862 if(paused && !playing) resume_playing(c->who);
863 sink_writes(ev_writer_sink(c->w), "250 OK\n");
864 return 1; /* completed */
867 static int c_random_disable(struct conn *c,
868 char attribute((unused)) **vec,
869 int attribute((unused)) nvec) {
870 disable_random(c->who, c->ev);
871 sink_writes(ev_writer_sink(c->w), "250 OK\n");
872 return 1; /* completed */
875 static int c_random_enabled(struct conn *c,
876 char attribute((unused)) **vec,
877 int attribute((unused)) nvec) {
878 sink_printf(ev_writer_sink(c->w), "252 %s\n", noyes[random_is_enabled()]);
879 return 1; /* completed */
882 static void got_stats(char *stats, void *u) {
883 struct conn *const c = u;
885 sink_printf(ev_writer_sink(c->w), "253 stats\n%s\n.\n", stats);
886 /* Now we can start processing commands again */
887 ev_reader_enable(c->r);
890 static int c_stats(struct conn *c,
891 char attribute((unused)) **vec,
892 int attribute((unused)) nvec) {
893 trackdb_stats_subprocess(c->ev, got_stats, c);
894 return 0; /* not yet complete */
897 static int c_volume(struct conn *c,
909 l = r = atoi(vec[0]);
920 rights = set ? RIGHT_VOLUME : RIGHT_READ;
921 if(!(c->rights & rights)) {
922 disorder_error(0, "%s attempted to set volume but lacks required rights",
924 sink_writes(ev_writer_sink(c->w), "510 Prohibited\n");
927 if(!api || !api->set_volume) {
928 sink_writes(ev_writer_sink(c->w), "550 error accessing mixer\n");
931 (set ? api->set_volume : api->get_volume)(&l, &r);
932 sink_printf(ev_writer_sink(c->w), "252 %d %d\n", l, r);
933 if(l != volume_left || r != volume_right) {
936 snprintf(lb, sizeof lb, "%d", l);
937 snprintf(rb, sizeof rb, "%d", r);
938 eventlog("volume", lb, rb, (char *)0);
943 /** @brief Called when data arrives on a log connection
945 * We just discard all such data. The client may occasionally send data as a
948 static int logging_reader_callback(ev_source attribute((unused)) *ev,
950 void attribute((unused)) *ptr,
952 int attribute((unused)) eof,
953 void attribute((unused)) *u) {
956 ev_reader_consume(reader, bytes);
958 /* Oops, that's all for now */
959 D(("logging reader eof"));
962 ev_writer_close(c->w);
966 remove_connection(c);
971 static void logclient(const char *msg, void *user) {
972 struct conn *c = user;
975 /* This connection has gone up in smoke for some reason */
976 eventlog_remove(c->lo);
980 /* user_* messages are restricted */
981 if(!strncmp(msg, "user_", 5)) {
982 /* They are only sent to admin users */
983 if(!(c->rights & RIGHT_ADMIN))
985 /* They are not sent over TCP connections unless remote user-management is
987 if(!config->remote_userman && !(c->rights & RIGHT__LOCAL))
990 sink_printf(ev_writer_sink(c->w), "%"PRIxMAX" %s\n",
991 (uintmax_t)xtime(0), msg);
994 static int c_log(struct conn *c,
995 char attribute((unused)) **vec,
996 int attribute((unused)) nvec) {
999 sink_writes(ev_writer_sink(c->w), "254 OK\n");
1000 /* pump out initial state */
1002 sink_printf(ev_writer_sink(c->w), "%"PRIxMAX" state %s\n",
1004 playing_is_enabled() ? "enable_play" : "disable_play");
1005 sink_printf(ev_writer_sink(c->w), "%"PRIxMAX" state %s\n",
1007 random_is_enabled() ? "enable_random" : "disable_random");
1008 sink_printf(ev_writer_sink(c->w), "%"PRIxMAX" state %s\n",
1010 paused ? "pause" : "resume");
1012 sink_printf(ev_writer_sink(c->w), "%"PRIxMAX" state playing\n",
1014 /* Initial volume */
1015 sink_printf(ev_writer_sink(c->w), "%"PRIxMAX" volume %d %d\n",
1016 (uintmax_t)now, volume_left, volume_right);
1017 c->lo = xmalloc(sizeof *c->lo);
1018 c->lo->fn = logclient;
1020 eventlog_add(c->lo);
1021 c->reader = logging_reader_callback;
1025 /** @brief Test whether a move is allowed
1026 * @param c Connection
1027 * @param qs List of IDs on queue
1028 * @param nqs Number of IDs
1029 * @return 0 if move is prohibited, non-0 if it is allowed
1031 static int has_move_rights(struct conn *c, struct queue_entry **qs, int nqs) {
1032 for(; nqs > 0; ++qs, --nqs) {
1033 struct queue_entry *const q = *qs;
1035 if(!right_movable(c->rights, c->who, q))
1041 static int c_move(struct conn *c,
1043 int attribute((unused)) nvec) {
1044 struct queue_entry *q;
1047 if(!(q = queue_find(vec[0]))) {
1048 sink_writes(ev_writer_sink(c->w), "550 no such track on the queue\n");
1051 if(!has_move_rights(c, &q, 1)) {
1052 disorder_error(0, "%s attempted move but lacks required rights", c->who);
1053 sink_writes(ev_writer_sink(c->w),
1054 "510 Not authorized to move that track\n");
1057 n = queue_move(q, atoi(vec[1]), c->who);
1058 sink_printf(ev_writer_sink(c->w), "252 %d\n", n);
1059 /* If we've moved to the head of the queue then prepare the track. */
1065 static int c_moveafter(struct conn *c,
1067 int attribute((unused)) nvec) {
1068 struct queue_entry *q, **qs;
1072 if(!(q = queue_find(vec[0]))) {
1073 sink_writes(ev_writer_sink(c->w), "550 no such track on the queue\n");
1080 qs = xcalloc(nvec, sizeof *qs);
1081 for(n = 0; n < nvec; ++n)
1082 if(!(qs[n] = queue_find(vec[n]))) {
1083 sink_writes(ev_writer_sink(c->w), "550 no such track on the queue\n");
1086 if(!has_move_rights(c, qs, nvec)) {
1087 disorder_error(0, "%s attempted moveafter but lacks required rights",
1089 sink_writes(ev_writer_sink(c->w),
1090 "510 Not authorized to move those tracks\n");
1093 queue_moveafter(q, nvec, qs, c->who);
1094 sink_printf(ev_writer_sink(c->w), "250 Moved tracks\n");
1095 /* If we've moved to the head of the queue then prepare the track. */
1101 static int c_part(struct conn *c,
1103 int attribute((unused)) nvec) {
1106 if(!(track = trackdb_resolve(vec[0]))) {
1107 sink_writes(ev_writer_sink(c->w), "550 cannot resolve track\n");
1110 sink_printf(ev_writer_sink(c->w), "252 %s\n",
1111 quoteutf8(trackdb_getpart(track, vec[1], vec[2])));
1115 static int c_resolve(struct conn *c,
1117 int attribute((unused)) nvec) {
1120 if(!(track = trackdb_resolve(vec[0]))) {
1121 sink_writes(ev_writer_sink(c->w), "550 cannot resolve track\n");
1124 sink_printf(ev_writer_sink(c->w), "252 %s\n", quoteutf8(track));
1128 static int list_response(struct conn *c,
1131 sink_printf(ev_writer_sink(c->w), "253 %s\n", reply);
1133 sink_printf(ev_writer_sink(c->w), "%s%s\n",
1134 **list == '.' ? "." : "", *list);
1137 sink_writes(ev_writer_sink(c->w), ".\n");
1138 return 1; /* completed */
1141 static int c_tags(struct conn *c,
1142 char attribute((unused)) **vec,
1143 int attribute((unused)) nvec) {
1144 return list_response(c, "Tag list follows", trackdb_alltags());
1147 static int c_set_global(struct conn *c,
1149 int attribute((unused)) nvec) {
1150 if(vec[0][0] == '_') {
1151 sink_writes(ev_writer_sink(c->w), "550 cannot set internal global preferences\n");
1154 /* We special-case the 'magic' preferences here. */
1155 if(!strcmp(vec[0], "playing")) {
1156 (flag_enabled(vec[1]) ? enable_playing : disable_playing)(c->who, c->ev);
1157 sink_printf(ev_writer_sink(c->w), "250 OK\n");
1158 } else if(!strcmp(vec[0], "random-play")) {
1159 (flag_enabled(vec[1]) ? enable_random : disable_random)(c->who, c->ev);
1160 sink_printf(ev_writer_sink(c->w), "250 OK\n");
1162 if(!trackdb_set_global(vec[0], vec[1], c->who))
1163 sink_printf(ev_writer_sink(c->w), "250 OK\n");
1165 sink_writes(ev_writer_sink(c->w), "550 not found\n");
1170 static int c_get_global(struct conn *c,
1172 int attribute((unused)) nvec) {
1173 const char *s = trackdb_get_global(vec[0]);
1176 sink_printf(ev_writer_sink(c->w), "252 %s\n", quoteutf8(s));
1178 sink_writes(ev_writer_sink(c->w), "555 not found\n");
1182 static int c_nop(struct conn *c,
1183 char attribute((unused)) **vec,
1184 int attribute((unused)) nvec) {
1185 sink_printf(ev_writer_sink(c->w), "250 Quack\n");
1189 static int c_new(struct conn *c,
1199 if(max <= 0 || max > config->new_max)
1200 max = config->new_max;
1201 tracks = trackdb_new(0, max);
1202 sink_printf(ev_writer_sink(c->w), "253 New track list follows\n");
1204 sink_printf(ev_writer_sink(c->w), "%s%s\n",
1205 **tracks == '.' ? "." : "", *tracks);
1208 sink_writes(ev_writer_sink(c->w), ".\n");
1209 return 1; /* completed */
1213 static int c_rtp_address(struct conn *c,
1214 char attribute((unused)) **vec,
1215 int attribute((unused)) nvec) {
1216 if(api == &uaudio_rtp) {
1219 netaddress_format(&config->broadcast, NULL, &addr);
1220 sink_printf(ev_writer_sink(c->w), "252 %s %s\n",
1222 quoteutf8(addr[2]));
1224 sink_writes(ev_writer_sink(c->w), "550 No RTP\n");
1228 static int c_cookie(struct conn *c,
1230 int attribute((unused)) nvec) {
1235 /* Can't log in twice on the same connection */
1237 sink_writes(ev_writer_sink(c->w), "530 already authenticated\n");
1240 /* Get some kind of peer identifcation */
1241 if(!(host = connection_host(c))) {
1242 sink_writes(ev_writer_sink(c->w), "530 authentication failure\n");
1245 /* Check the cookie */
1246 user = verify_cookie(vec[0], &rights);
1248 sink_writes(ev_writer_sink(c->w), "530 authentication failure\n");
1255 if(strcmp(host, "local"))
1256 disorder_info("S%x %s connected with cookie from %s", c->tag, user, host);
1258 c->rights |= RIGHT__LOCAL;
1259 /* Response contains username so client knows who they are acting as */
1260 sink_printf(ev_writer_sink(c->w), "232 %s\n", quoteutf8(user));
1264 static int c_make_cookie(struct conn *c,
1265 char attribute((unused)) **vec,
1266 int attribute((unused)) nvec) {
1267 const char *cookie = make_cookie(c->who);
1270 sink_printf(ev_writer_sink(c->w), "252 %s\n", quoteutf8(cookie));
1272 sink_writes(ev_writer_sink(c->w), "550 Cannot create cookie\n");
1276 static int c_revoke(struct conn *c,
1277 char attribute((unused)) **vec,
1278 int attribute((unused)) nvec) {
1280 revoke_cookie(c->cookie);
1281 sink_writes(ev_writer_sink(c->w), "250 OK\n");
1283 sink_writes(ev_writer_sink(c->w), "510 Did not log in with cookie\n");
1287 static int c_adduser(struct conn *c,
1292 if(!config->remote_userman && !(c->rights & RIGHT__LOCAL)) {
1293 disorder_error(0, "S%x: remote adduser", c->tag);
1294 sink_writes(ev_writer_sink(c->w), "510 Remote user management is disabled\n");
1299 if(parse_rights(vec[2], 0, 1)) {
1300 sink_writes(ev_writer_sink(c->w), "550 Invalid rights list\n");
1304 rights = config->default_rights;
1305 if(trackdb_adduser(vec[0], vec[1], rights,
1306 0/*email*/, 0/*confirmation*/))
1307 sink_writes(ev_writer_sink(c->w), "550 Cannot create user\n");
1309 sink_writes(ev_writer_sink(c->w), "250 User created\n");
1313 static int c_deluser(struct conn *c,
1315 int attribute((unused)) nvec) {
1318 if(!config->remote_userman && !(c->rights & RIGHT__LOCAL)) {
1319 disorder_error(0, "S%x: remote deluser", c->tag);
1320 sink_writes(ev_writer_sink(c->w), "510 Remote user management is disabled\n");
1323 if(trackdb_deluser(vec[0])) {
1324 sink_writes(ev_writer_sink(c->w), "550 Cannot delete user\n");
1327 /* Zap connections belonging to deleted user */
1328 for(d = connections; d; d = d->next)
1329 if(!strcmp(d->who, vec[0]))
1331 sink_writes(ev_writer_sink(c->w), "250 User deleted\n");
1335 static int c_edituser(struct conn *c,
1337 int attribute((unused)) nvec) {
1340 if(!config->remote_userman && !(c->rights & RIGHT__LOCAL)) {
1341 disorder_error(0, "S%x: remote edituser", c->tag);
1342 sink_writes(ev_writer_sink(c->w), "510 Remote user management is disabled\n");
1345 /* RIGHT_ADMIN can do anything; otherwise you can only set your own email
1346 * address and password. */
1347 if((c->rights & RIGHT_ADMIN)
1348 || (!strcmp(c->who, vec[0])
1349 && (!strcmp(vec[1], "email")
1350 || !strcmp(vec[1], "password")))) {
1351 if(trackdb_edituserinfo(vec[0], vec[1], vec[2])) {
1352 sink_writes(ev_writer_sink(c->w), "550 Failed to change setting\n");
1355 if(!strcmp(vec[1], "password")) {
1356 /* Zap all connections for this user after a password change */
1357 for(d = connections; d; d = d->next)
1358 if(!strcmp(d->who, vec[0]))
1360 } else if(!strcmp(vec[1], "rights")) {
1361 /* Update rights for this user */
1364 if(!parse_rights(vec[2], &r, 1)) {
1365 const char *new_rights = rights_string(r);
1366 for(d = connections; d; d = d->next) {
1367 if(!strcmp(d->who, vec[0])) {
1370 /* Notify any log connections */
1372 sink_printf(ev_writer_sink(d->w),
1373 "%"PRIxMAX" rights_changed %s\n",
1374 (uintmax_t)xtime(0),
1375 quoteutf8(new_rights));
1380 sink_writes(ev_writer_sink(c->w), "250 OK\n");
1382 disorder_error(0, "%s attempted edituser but lacks required rights",
1384 sink_writes(ev_writer_sink(c->w), "510 Restricted to administrators\n");
1389 static int c_userinfo(struct conn *c,
1390 char attribute((unused)) **vec,
1391 int attribute((unused)) nvec) {
1395 /* We allow remote querying of rights so that clients can figure out what
1396 * they're allowed to do */
1397 if(!config->remote_userman
1398 && !(c->rights & RIGHT__LOCAL)
1399 && strcmp(vec[1], "rights")) {
1400 disorder_error(0, "S%x: remote userinfo %s %s", c->tag, vec[0], vec[1]);
1401 sink_writes(ev_writer_sink(c->w), "510 Remote user management is disabled\n");
1404 /* RIGHT_ADMIN allows anything; otherwise you can only get your own email
1405 * address and rights list. */
1406 if((c->rights & RIGHT_ADMIN)
1407 || (!strcmp(c->who, vec[0])
1408 && (!strcmp(vec[1], "email")
1409 || !strcmp(vec[1], "rights")))) {
1410 if((k = trackdb_getuserinfo(vec[0])))
1411 if((value = kvp_get(k, vec[1])))
1412 sink_printf(ev_writer_sink(c->w), "252 %s\n", quoteutf8(value));
1414 sink_writes(ev_writer_sink(c->w), "555 Not set\n");
1416 sink_writes(ev_writer_sink(c->w), "550 No such user\n");
1418 disorder_error(0, "%s attempted userinfo but lacks required rights",
1420 sink_writes(ev_writer_sink(c->w), "510 Restricted to administrators\n");
1425 static int c_users(struct conn *c,
1426 char attribute((unused)) **vec,
1427 int attribute((unused)) nvec) {
1428 return list_response(c, "User list follows", trackdb_listusers());
1431 static int c_register(struct conn *c,
1433 int attribute((unused)) nvec) {
1435 uint32_t nonce[CONFIRM_SIZE];
1436 char nonce_str[(32 * CONFIRM_SIZE) / 5 + 1];
1438 /* The confirmation string is username/base62(nonce). The confirmation
1439 * process will pick the username back out to identify them but the _whole_
1440 * string is used as the confirmation string. Base 62 means we used only
1441 * letters and digits, minimizing the chance of the URL being mispasted. */
1442 gcry_randomize(nonce, sizeof nonce, GCRY_STRONG_RANDOM);
1443 if(basen(nonce, CONFIRM_SIZE, nonce_str, sizeof nonce_str, 62)) {
1444 disorder_error(0, "buffer too small encoding confirmation string");
1445 sink_writes(ev_writer_sink(c->w), "550 Cannot create user\n");
1447 byte_xasprintf(&cs, "%s/%s", vec[0], nonce_str);
1448 if(trackdb_adduser(vec[0], vec[1], config->default_rights, vec[2], cs))
1449 sink_writes(ev_writer_sink(c->w), "550 Cannot create user\n");
1451 sink_printf(ev_writer_sink(c->w), "252 %s\n", quoteutf8(cs));
1455 static int c_confirm(struct conn *c,
1457 int attribute((unused)) nvec) {
1462 /* Get some kind of peer identifcation */
1463 if(!(host = connection_host(c))) {
1464 sink_writes(ev_writer_sink(c->w), "530 Authentication failure\n");
1467 /* Picking the LAST / means we don't (here) rule out slashes in usernames. */
1468 if(!(sep = strrchr(vec[0], '/'))) {
1469 sink_writes(ev_writer_sink(c->w), "550 Malformed confirmation string\n");
1472 user = xstrndup(vec[0], sep - vec[0]);
1473 if(trackdb_confirm(user, vec[0], &rights))
1474 sink_writes(ev_writer_sink(c->w), "510 Incorrect confirmation string\n");
1479 if(strcmp(host, "local"))
1480 disorder_info("S%x %s confirmed from %s", c->tag, user, host);
1482 c->rights |= RIGHT__LOCAL;
1483 /* Response contains username so client knows who they are acting as */
1484 sink_printf(ev_writer_sink(c->w), "232 %s\n", quoteutf8(user));
1489 static int sent_reminder(ev_source attribute((unused)) *ev,
1490 pid_t attribute((unused)) pid,
1492 const struct rusage attribute((unused)) *rusage,
1494 struct conn *const c = u;
1496 /* Tell the client what went down */
1498 sink_writes(ev_writer_sink(c->w), "250 OK\n");
1500 disorder_error(0, "reminder subprocess %s", wstat(status));
1501 sink_writes(ev_writer_sink(c->w), "550 Cannot send a reminder email\n");
1503 /* Re-enable this connection */
1504 ev_reader_enable(c->r);
1508 static int c_reminder(struct conn *c,
1510 int attribute((unused)) nvec) {
1512 const char *password, *email, *text, *encoding, *charset, *content_type;
1517 static hash *last_reminder;
1519 if(!config->mail_sender) {
1520 disorder_error(0, "cannot send password reminders because mail_sender not set");
1521 sink_writes(ev_writer_sink(c->w), "550 Cannot send a reminder email\n");
1524 if(!(k = trackdb_getuserinfo(vec[0]))) {
1525 disorder_error(0, "reminder for user '%s' who does not exist", vec[0]);
1526 sink_writes(ev_writer_sink(c->w), "550 Cannot send a reminder email\n");
1529 if(!(email = kvp_get(k, "email"))
1530 || !email_valid(email)) {
1531 disorder_error(0, "user '%s' has no valid email address", vec[0]);
1532 sink_writes(ev_writer_sink(c->w), "550 Cannot send a reminder email\n");
1535 if(!(password = kvp_get(k, "password"))
1537 disorder_error(0, "user '%s' has no password", vec[0]);
1538 sink_writes(ev_writer_sink(c->w), "550 Cannot send a reminder email\n");
1541 /* Rate-limit reminders. This hash is bounded in size by the number of
1542 * users. If this is actually a problem for anyone then we can periodically
1545 last_reminder = hash_new(sizeof (time_t));
1546 last = hash_find(last_reminder, vec[0]);
1548 if(last && now < *last + config->reminder_interval) {
1549 disorder_error(0, "sent a password reminder to '%s' too recently", vec[0]);
1550 sink_writes(ev_writer_sink(c->w), "550 Cannot send a reminder email\n");
1553 /* Send the reminder */
1554 /* TODO this should be templatized and to some extent merged with
1555 * the code in act_register() */
1556 byte_xasprintf((char **)&text,
1557 "Someone requested that you be sent a reminder of your DisOrder password.\n"
1558 "Your password is:\n"
1561 if(!(text = mime_encode_text(text, &charset, &encoding)))
1562 disorder_fatal(0, "cannot encode email");
1563 byte_xasprintf((char **)&content_type, "text/plain;charset=%s",
1564 quote822(charset, 0));
1565 pid = sendmail_subprocess("", config->mail_sender, email,
1566 "DisOrder password reminder",
1567 encoding, content_type, text);
1569 sink_writes(ev_writer_sink(c->w), "550 Cannot send a reminder email\n");
1572 hash_add(last_reminder, vec[0], &now, HASH_INSERT_OR_REPLACE);
1573 disorder_info("sending a passsword reminder to user '%s'", vec[0]);
1574 /* We can only continue when the subprocess finishes */
1575 ev_child(c->ev, pid, 0, sent_reminder, c);
1579 static int c_schedule_list(struct conn *c,
1580 char attribute((unused)) **vec,
1581 int attribute((unused)) nvec) {
1582 char **ids = schedule_list(0);
1583 sink_writes(ev_writer_sink(c->w), "253 ID list follows\n");
1585 sink_printf(ev_writer_sink(c->w), "%s\n", *ids++);
1586 sink_writes(ev_writer_sink(c->w), ".\n");
1587 return 1; /* completed */
1590 static int c_schedule_get(struct conn *c,
1592 int attribute((unused)) nvec) {
1593 struct kvp *actiondata = schedule_get(vec[0]), *k;
1596 sink_writes(ev_writer_sink(c->w), "555 No such event\n");
1597 return 1; /* completed */
1599 /* Scheduled events are public information. Anyone with RIGHT_READ can see
1601 sink_writes(ev_writer_sink(c->w), "253 Event information follows\n");
1602 for(k = actiondata; k; k = k->next)
1603 sink_printf(ev_writer_sink(c->w), " %s %s\n",
1604 quoteutf8(k->name), quoteutf8(k->value));
1605 sink_writes(ev_writer_sink(c->w), ".\n");
1606 return 1; /* completed */
1609 static int c_schedule_del(struct conn *c,
1611 int attribute((unused)) nvec) {
1612 struct kvp *actiondata = schedule_get(vec[0]);
1615 sink_writes(ev_writer_sink(c->w), "555 No such event\n");
1616 return 1; /* completed */
1618 /* If you have admin rights you can delete anything. If you don't then you
1619 * can only delete your own scheduled events. */
1620 if(!(c->rights & RIGHT_ADMIN)) {
1621 const char *who = kvp_get(actiondata, "who");
1623 if(!who || !c->who || strcmp(who, c->who)) {
1624 sink_writes(ev_writer_sink(c->w), "510 Not authorized\n");
1625 return 1; /* completed */
1628 if(schedule_del(vec[0]))
1629 sink_writes(ev_writer_sink(c->w), "550 Could not delete scheduled event\n");
1631 sink_writes(ev_writer_sink(c->w), "250 Deleted\n");
1632 return 1; /* completed */
1635 static int c_schedule_add(struct conn *c,
1638 struct kvp *actiondata = 0;
1641 /* Standard fields */
1642 kvp_set(&actiondata, "who", c->who);
1643 kvp_set(&actiondata, "when", vec[0]);
1644 kvp_set(&actiondata, "priority", vec[1]);
1645 kvp_set(&actiondata, "action", vec[2]);
1646 /* Action-dependent fields */
1647 if(!strcmp(vec[2], "play")) {
1649 sink_writes(ev_writer_sink(c->w), "550 Wrong number of arguments\n");
1652 if(!trackdb_exists(vec[3])) {
1653 sink_writes(ev_writer_sink(c->w), "550 Track is not in database\n");
1656 kvp_set(&actiondata, "track", vec[3]);
1657 } else if(!strcmp(vec[2], "set-global")) {
1658 if(nvec < 4 || nvec > 5) {
1659 sink_writes(ev_writer_sink(c->w), "550 Wrong number of arguments\n");
1662 kvp_set(&actiondata, "key", vec[3]);
1664 kvp_set(&actiondata, "value", vec[4]);
1666 sink_writes(ev_writer_sink(c->w), "550 Unknown action\n");
1669 /* schedule_add() checks user rights */
1670 id = schedule_add(c->ev, actiondata);
1672 sink_writes(ev_writer_sink(c->w), "550 Cannot add scheduled event\n");
1674 sink_printf(ev_writer_sink(c->w), "252 %s\n", id);
1678 static int c_adopt(struct conn *c,
1680 int attribute((unused)) nvec) {
1681 struct queue_entry *q;
1684 sink_writes(ev_writer_sink(c->w), "550 no identity\n");
1687 if(!(q = queue_find(vec[0]))) {
1688 sink_writes(ev_writer_sink(c->w), "550 no such track on the queue\n");
1691 if(q->origin != origin_random) {
1692 sink_writes(ev_writer_sink(c->w), "550 not a random track\n");
1695 q->origin = origin_adopted;
1696 q->submitter = xstrdup(c->who);
1697 eventlog("adopted", q->id, q->submitter, (char *)0);
1699 sink_writes(ev_writer_sink(c->w), "250 OK\n");
1703 static int playlist_response(struct conn *c,
1707 assert(!"cannot cope with success");
1709 sink_writes(ev_writer_sink(c->w), "510 Access denied\n");
1712 sink_writes(ev_writer_sink(c->w), "550 Invalid playlist name\n");
1715 sink_writes(ev_writer_sink(c->w), "555 No such playlist\n");
1718 sink_writes(ev_writer_sink(c->w), "550 Error accessing playlist\n");
1724 static int c_playlist_get(struct conn *c,
1726 int attribute((unused)) nvec) {
1730 if(!(err = trackdb_playlist_get(vec[0], c->who, &tracks, 0, 0)))
1731 return list_response(c, "Playlist contents follows", tracks);
1733 return playlist_response(c, err);
1736 static int c_playlist_set(struct conn *c,
1738 int attribute((unused)) nvec) {
1739 return fetch_body(c, c_playlist_set_body, vec[0]);
1742 static int c_playlist_set_body(struct conn *c,
1746 const char *playlist = u;
1749 if(!c->locked_playlist
1750 || strcmp(playlist, c->locked_playlist)) {
1751 sink_writes(ev_writer_sink(c->w), "550 Playlist is not locked\n");
1754 if(!(err = trackdb_playlist_set(playlist, c->who,
1756 sink_printf(ev_writer_sink(c->w), "250 OK\n");
1759 return playlist_response(c, err);
1762 static int c_playlist_get_share(struct conn *c,
1764 int attribute((unused)) nvec) {
1768 if(!(err = trackdb_playlist_get(vec[0], c->who, 0, 0, &share))) {
1769 sink_printf(ev_writer_sink(c->w), "252 %s\n", quoteutf8(share));
1772 return playlist_response(c, err);
1775 static int c_playlist_set_share(struct conn *c,
1777 int attribute((unused)) nvec) {
1780 if(!(err = trackdb_playlist_set(vec[0], c->who, 0, 0, vec[1]))) {
1781 sink_printf(ev_writer_sink(c->w), "250 OK\n");
1784 return playlist_response(c, err);
1787 static int c_playlists(struct conn *c,
1788 char attribute((unused)) **vec,
1789 int attribute((unused)) nvec) {
1792 trackdb_playlist_list(c->who, &p, 0);
1793 return list_response(c, "List of playlists follows", p);
1796 static int c_playlist_delete(struct conn *c,
1798 int attribute((unused)) nvec) {
1801 if(!(err = trackdb_playlist_delete(vec[0], c->who))) {
1802 sink_writes(ev_writer_sink(c->w), "250 OK\n");
1805 return playlist_response(c, err);
1808 static int c_playlist_lock(struct conn *c,
1810 int attribute((unused)) nvec) {
1814 /* Check we're allowed to modify this playlist */
1815 if((err = trackdb_playlist_set(vec[0], c->who, 0, 0, 0)))
1816 return playlist_response(c, err);
1817 /* If we hold a lock don't allow a new one */
1818 if(c->locked_playlist) {
1819 sink_writes(ev_writer_sink(c->w), "550 Already holding a lock\n");
1822 /* See if some other connection locks the same playlist */
1823 for(cc = connections; cc; cc = cc->next)
1824 if(cc->locked_playlist && !strcmp(cc->locked_playlist, vec[0]))
1827 /* TODO: implement config->playlist_lock_timeout */
1828 sink_writes(ev_writer_sink(c->w), "550 Already locked\n");
1831 c->locked_playlist = xstrdup(vec[0]);
1832 time(&c->locked_when);
1833 sink_writes(ev_writer_sink(c->w), "250 Acquired lock\n");
1837 static int c_playlist_unlock(struct conn *c,
1838 char attribute((unused)) **vec,
1839 int attribute((unused)) nvec) {
1840 if(!c->locked_playlist) {
1841 sink_writes(ev_writer_sink(c->w), "550 Not holding a lock\n");
1844 c->locked_playlist = 0;
1845 sink_writes(ev_writer_sink(c->w), "250 Released lock\n");
1849 /** @brief Server's definition of a command */
1850 static const struct server_command {
1851 /** @brief Command name */
1854 /** @brief Minimum number of arguments */
1857 /** @brief Maximum number of arguments */
1860 /** @brief Function to process command */
1861 int (*fn)(struct conn *, char **, int);
1863 /** @brief Rights required to execute command
1865 * 0 means that the command can be issued without logging in. If multiple
1866 * bits are listed here any of those rights will do.
1870 { "adduser", 2, 3, c_adduser, RIGHT_ADMIN },
1871 { "adopt", 1, 1, c_adopt, RIGHT_PLAY },
1872 { "allfiles", 0, 2, c_allfiles, RIGHT_READ },
1873 { "confirm", 1, 1, c_confirm, 0 },
1874 { "cookie", 1, 1, c_cookie, 0 },
1875 { "deluser", 1, 1, c_deluser, RIGHT_ADMIN },
1876 { "dirs", 0, 2, c_dirs, RIGHT_READ },
1877 { "disable", 0, 1, c_disable, RIGHT_GLOBAL_PREFS },
1878 { "edituser", 3, 3, c_edituser, RIGHT_ADMIN|RIGHT_USERINFO },
1879 { "enable", 0, 0, c_enable, RIGHT_GLOBAL_PREFS },
1880 { "enabled", 0, 0, c_enabled, RIGHT_READ },
1881 { "exists", 1, 1, c_exists, RIGHT_READ },
1882 { "files", 0, 2, c_files, RIGHT_READ },
1883 { "get", 2, 2, c_get, RIGHT_READ },
1884 { "get-global", 1, 1, c_get_global, RIGHT_READ },
1885 { "length", 1, 1, c_length, RIGHT_READ },
1886 { "log", 0, 0, c_log, RIGHT_READ },
1887 { "make-cookie", 0, 0, c_make_cookie, RIGHT_READ },
1888 { "move", 2, 2, c_move, RIGHT_MOVE__MASK },
1889 { "moveafter", 1, INT_MAX, c_moveafter, RIGHT_MOVE__MASK },
1890 { "new", 0, 1, c_new, RIGHT_READ },
1891 { "nop", 0, 0, c_nop, 0 },
1892 { "part", 3, 3, c_part, RIGHT_READ },
1893 { "pause", 0, 0, c_pause, RIGHT_PAUSE },
1894 { "play", 1, 1, c_play, RIGHT_PLAY },
1895 { "playafter", 2, INT_MAX, c_playafter, RIGHT_PLAY },
1896 { "playing", 0, 0, c_playing, RIGHT_READ },
1897 { "playlist-delete", 1, 1, c_playlist_delete, RIGHT_PLAY },
1898 { "playlist-get", 1, 1, c_playlist_get, RIGHT_READ },
1899 { "playlist-get-share", 1, 1, c_playlist_get_share, RIGHT_READ },
1900 { "playlist-lock", 1, 1, c_playlist_lock, RIGHT_PLAY },
1901 { "playlist-set", 1, 1, c_playlist_set, RIGHT_PLAY },
1902 { "playlist-set-share", 2, 2, c_playlist_set_share, RIGHT_PLAY },
1903 { "playlist-unlock", 0, 0, c_playlist_unlock, RIGHT_PLAY },
1904 { "playlists", 0, 0, c_playlists, RIGHT_READ },
1905 { "prefs", 1, 1, c_prefs, RIGHT_READ },
1906 { "queue", 0, 0, c_queue, RIGHT_READ },
1907 { "random-disable", 0, 0, c_random_disable, RIGHT_GLOBAL_PREFS },
1908 { "random-enable", 0, 0, c_random_enable, RIGHT_GLOBAL_PREFS },
1909 { "random-enabled", 0, 0, c_random_enabled, RIGHT_READ },
1910 { "recent", 0, 0, c_recent, RIGHT_READ },
1911 { "reconfigure", 0, 0, c_reconfigure, RIGHT_ADMIN },
1912 { "register", 3, 3, c_register, RIGHT_REGISTER },
1913 { "reminder", 1, 1, c_reminder, RIGHT__LOCAL },
1914 { "remove", 1, 1, c_remove, RIGHT_REMOVE__MASK },
1915 { "rescan", 0, INT_MAX, c_rescan, RIGHT_RESCAN },
1916 { "resolve", 1, 1, c_resolve, RIGHT_READ },
1917 { "resume", 0, 0, c_resume, RIGHT_PAUSE },
1918 { "revoke", 0, 0, c_revoke, RIGHT_READ },
1919 { "rtp-address", 0, 0, c_rtp_address, 0 },
1920 { "schedule-add", 3, INT_MAX, c_schedule_add, RIGHT_READ },
1921 { "schedule-del", 1, 1, c_schedule_del, RIGHT_READ },
1922 { "schedule-get", 1, 1, c_schedule_get, RIGHT_READ },
1923 { "schedule-list", 0, 0, c_schedule_list, RIGHT_READ },
1924 { "scratch", 0, 1, c_scratch, RIGHT_SCRATCH__MASK },
1925 { "search", 1, 1, c_search, RIGHT_READ },
1926 { "set", 3, 3, c_set, RIGHT_PREFS, },
1927 { "set-global", 2, 2, c_set_global, RIGHT_GLOBAL_PREFS },
1928 { "shutdown", 0, 0, c_shutdown, RIGHT_ADMIN },
1929 { "stats", 0, 0, c_stats, RIGHT_READ },
1930 { "tags", 0, 0, c_tags, RIGHT_READ },
1931 { "unset", 2, 2, c_set, RIGHT_PREFS },
1932 { "unset-global", 1, 1, c_set_global, RIGHT_GLOBAL_PREFS },
1933 { "user", 2, 2, c_user, 0 },
1934 { "userinfo", 2, 2, c_userinfo, RIGHT_READ },
1935 { "users", 0, 0, c_users, RIGHT_READ },
1936 { "version", 0, 0, c_version, RIGHT_READ },
1937 { "volume", 0, 2, c_volume, RIGHT_READ|RIGHT_VOLUME }
1940 /** @brief Fetch a command body
1941 * @param c Connection
1942 * @param body_callback Called with body
1943 * @param u Passed to body_callback
1946 static int fetch_body(struct conn *c,
1947 body_callback_type body_callback,
1949 assert(c->line_reader == command);
1950 c->line_reader = body_line;
1951 c->body_callback = body_callback;
1953 vector_init(c->body);
1957 /** @brief @ref line_reader_type callback for command body lines
1958 * @param c Connection
1960 * @return 1 if complete, 0 if incomplete
1962 * Called from reader_callback().
1964 static int body_line(struct conn *c,
1969 /* That's the lot */
1970 c->line_reader = command;
1971 vector_terminate(c->body);
1972 return c->body_callback(c, c->body->vec, c->body->nvec, c->body_u);
1975 vector_append(c->body, xstrdup(line));
1976 return 1; /* completed */
1979 static void command_error(const char *msg, void *u) {
1982 sink_printf(ev_writer_sink(c->w), "500 parse error: %s\n", msg);
1985 /** @brief @ref line_reader_type callback for commands
1986 * @param c Connection
1988 * @return 1 if complete, 0 if incomplete
1990 * Called from reader_callback().
1992 static int command(struct conn *c, char *line) {
1996 D(("server command %s", line));
1997 /* We force everything into NFC as early as possible */
1998 if(!(line = utf8_compose_canon(line, strlen(line), 0))) {
1999 sink_writes(ev_writer_sink(c->w), "500 cannot normalize command\n");
2002 if(!(vec = split(line, &nvec, SPLIT_QUOTES, command_error, c))) {
2003 sink_writes(ev_writer_sink(c->w), "500 cannot parse command\n");
2007 sink_writes(ev_writer_sink(c->w), "500 do what?\n");
2010 if((n = TABLE_FIND(commands, name, vec[0])) < 0)
2011 sink_writes(ev_writer_sink(c->w), "500 unknown command\n");
2013 if(commands[n].rights
2014 && !(c->rights & commands[n].rights)) {
2015 disorder_error(0, "%s attempted %s but lacks required rights",
2016 c->who ? c->who : "NULL",
2018 sink_writes(ev_writer_sink(c->w), "510 Prohibited\n");
2023 if(nvec < commands[n].minargs) {
2024 sink_writes(ev_writer_sink(c->w), "500 missing argument(s)\n");
2027 if(nvec > commands[n].maxargs) {
2028 sink_writes(ev_writer_sink(c->w), "500 too many arguments\n");
2031 return commands[n].fn(c, vec, nvec);
2033 return 1; /* completed */
2036 /* redirect to the right reader callback for our current state */
2037 static int redirect_reader_callback(ev_source *ev,
2045 return c->reader(ev, reader, ptr, bytes, eof, u);
2048 /* the main command reader */
2049 static int reader_callback(ev_source attribute((unused)) *ev,
2059 D(("server reader_callback"));
2060 while((eol = memchr(ptr, '\n', bytes))) {
2062 ev_reader_consume(reader, eol - (char *)ptr);
2063 complete = c->line_reader(c, ptr); /* usually command() */
2064 bytes -= (eol - (char *)ptr);
2067 /* the command had better have set a new reader callback */
2069 /* there are further bytes to read, or we are at eof; arrange for the
2070 * command's reader callback to handle them */
2071 return ev_reader_incomplete(reader);
2072 /* nothing's going on right now */
2075 /* command completed, we can go around and handle the next one */
2079 disorder_error(0, "S%x unterminated line", c->tag);
2080 D(("normal reader close"));
2083 D(("close associated writer"));
2084 ev_writer_close(c->w);
2087 remove_connection(c);
2092 static int listen_callback(ev_source *ev,
2094 const struct sockaddr attribute((unused)) *remote,
2095 socklen_t attribute((unused)) rlen,
2097 const struct listener *l = u;
2098 struct conn *c = xmalloc(sizeof *c);
2099 static unsigned tags;
2101 D(("server listen_callback fd %d (%s)", fd, l->name));
2104 c->next = connections;
2107 c->w = ev_writer_new(ev, fd, writer_error, c,
2110 disorder_error(0, "ev_writer_new for file inbound connection (fd=%d) failed",
2115 c->r = ev_reader_new(ev, fd, redirect_reader_callback, reader_error, c,
2118 /* Main reason for failure is the FD is too big and that will already have
2121 "ev_reader_new for file inbound connection (fd=%d) failed",
2125 c->reader = reader_callback;
2128 c->line_reader = command;
2130 gcry_randomize(c->nonce, sizeof c->nonce, GCRY_STRONG_RANDOM);
2131 sink_printf(ev_writer_sink(c->w), "231 %d %s %s\n",
2133 config->authorization_algorithm,
2134 hex(c->nonce, sizeof c->nonce));
2138 int server_start(ev_source *ev, int pf,
2139 size_t socklen, const struct sockaddr *sa,
2143 struct listener *l = xmalloc(sizeof *l);
2144 static const int one = 1;
2146 D(("server_init socket %s privileged=%d", name, privileged));
2148 if(privileged && pf != AF_UNIX)
2149 disorder_fatal(0, "cannot create a privileged listener on a non-local port");
2150 fd = xsocket(pf, SOCK_STREAM, 0);
2151 xsetsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &one, sizeof one);
2152 if(bind(fd, sa, socklen) < 0) {
2153 disorder_error(errno, "error binding to %s", name);
2161 l->privileged = privileged;
2162 if(ev_listen(ev, fd, listen_callback, l, "server listener"))
2164 disorder_info("listening on %s", name);
2168 int server_stop(ev_source *ev, int fd) {
2170 return ev_listen_cancel(ev, fd);