2 * This file is part of DisOrder.
3 * Copyright (C) 2004-2008 Richard Kettlewell
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
21 #include "disorder-server.h"
24 # define NONCE_SIZE 16
28 # define CONFIRM_SIZE 10
31 int volume_left, volume_right; /* last known volume */
33 /** @brief Accept all well-formed login attempts
46 /** @brief Signature for line reader callback
49 * @return 0 if incomplete, 1 if complete
51 * @p line is 0-terminated and excludes the newline. It points into the
52 * input buffer so will become invalid shortly.
54 typedef int line_reader_type(struct conn *c,
57 /** @brief Signature for with-body command callbacks
59 * @param body List of body lines
60 * @param nbody Number of body lines
61 * @param u As passed to fetch_body()
62 * @return 0 to suspend input, 1 if complete
64 * The body strings are allocated (so survive indefinitely) and don't include
67 typedef int body_callback_type(struct conn *c,
72 /** @brief One client connection */
74 /** @brief Read commands from here */
76 /** @brief Send responses to here */
78 /** @brief Underlying file descriptor */
80 /** @brief Unique identifier for connection used in log messages */
82 /** @brief Login name or NULL */
84 /** @brief Event loop */
86 /** @brief Nonce chosen for this connection */
87 unsigned char nonce[NONCE_SIZE];
88 /** @brief Current reader callback
90 * We change this depending on whether we're servicing the @b log command
92 ev_reader_callback *reader;
93 /** @brief Event log output sending to this connection */
94 struct eventlog_output *lo;
95 /** @brief Parent listener */
96 const struct listener *l;
97 /** @brief Login cookie or NULL */
99 /** @brief Connection rights */
101 /** @brief Next connection */
103 /** @brief True if pending rescan had 'wait' set */
105 /** @brief Playlist that this connection locks */
106 const char *locked_playlist;
107 /** @brief When that playlist was locked */
109 /** @brief Line reader function */
110 line_reader_type *line_reader;
111 /** @brief Called when command body has been read */
112 body_callback_type *body_callback;
113 /** @brief Passed to @c body_callback */
115 /** @brief Accumulating body */
116 struct vector body[1];
119 /** @brief Linked list of connections */
120 static struct conn *connections;
122 static int reader_callback(ev_source *ev,
128 static int c_playlist_set_body(struct conn *c,
132 static int fetch_body(struct conn *c,
133 body_callback_type body_callback,
135 static int body_line(struct conn *c, char *line);
136 static int command(struct conn *c, char *line);
138 static const char *noyes[] = { "no", "yes" };
140 /** @brief Remove a connection from the connection list */
141 static void remove_connection(struct conn *c) {
144 for(cc = &connections; *cc && *cc != c; cc = &(*cc)->next)
150 /** @brief Called when a connection's writer fails or is shut down
152 * If the connection still has a raeder that is cancelled.
154 static int writer_error(ev_source attribute((unused)) *ev,
159 D(("server writer_error S%x %d", c->tag, errno_value));
160 if(errno_value == 0) {
162 D(("S%x writer completed", c->tag));
164 if(errno_value != EPIPE)
165 error(errno_value, "S%x write error on socket", c->tag);
167 D(("cancel reader"));
168 ev_reader_cancel(c->r);
171 D(("done cancel reader"));
175 remove_connection(c);
179 /** @brief Called when a conncetion's reader fails or is shut down
181 * If connection still has a writer then it is closed.
183 static int reader_error(ev_source attribute((unused)) *ev,
188 D(("server reader_error S%x %d", c->tag, errno_value));
189 error(errno_value, "S%x read error on socket", c->tag);
191 ev_writer_close(c->w);
195 remove_connection(c);
199 static int c_disable(struct conn *c, char **vec, int nvec) {
201 disable_playing(c->who);
202 else if(nvec == 1 && !strcmp(vec[0], "now"))
203 disable_playing(c->who);
205 sink_writes(ev_writer_sink(c->w), "550 invalid argument\n");
206 return 1; /* completed */
208 sink_writes(ev_writer_sink(c->w), "250 OK\n");
209 return 1; /* completed */
212 static int c_enable(struct conn *c,
213 char attribute((unused)) **vec,
214 int attribute((unused)) nvec) {
215 enable_playing(c->who, c->ev);
216 /* Enable implicitly unpauses if there is nothing playing */
217 if(paused && !playing) resume_playing(c->who);
218 sink_writes(ev_writer_sink(c->w), "250 OK\n");
219 return 1; /* completed */
222 static int c_enabled(struct conn *c,
223 char attribute((unused)) **vec,
224 int attribute((unused)) nvec) {
225 sink_printf(ev_writer_sink(c->w), "252 %s\n", noyes[playing_is_enabled()]);
226 return 1; /* completed */
229 static int c_play(struct conn *c, char **vec,
230 int attribute((unused)) nvec) {
232 struct queue_entry *q;
234 if(!trackdb_exists(vec[0])) {
235 sink_writes(ev_writer_sink(c->w), "550 track is not in database\n");
238 if(!(track = trackdb_resolve(vec[0]))) {
239 sink_writes(ev_writer_sink(c->w), "550 cannot resolve track\n");
242 q = queue_add(track, c->who, WHERE_BEFORE_RANDOM);
244 /* If we added the first track, and something is playing, then prepare the
245 * new track. If nothing is playing then we don't bother as it wouldn't gain
247 if(q == qhead.next && playing)
249 sink_printf(ev_writer_sink(c->w), "252 %s\n", q->id);
250 /* If the queue was empty but we are for some reason paused then
252 if(!playing) resume_playing(0);
254 return 1; /* completed */
257 static int c_remove(struct conn *c, char **vec,
258 int attribute((unused)) nvec) {
259 struct queue_entry *q;
261 if(!(q = queue_find(vec[0]))) {
262 sink_writes(ev_writer_sink(c->w), "550 no such track on the queue\n");
265 if(!right_removable(c->rights, c->who, q)) {
266 error(0, "%s attempted remove but lacks required rights", c->who);
267 sink_writes(ev_writer_sink(c->w),
268 "510 Not authorized to remove that track\n");
271 queue_remove(q, c->who);
272 /* De-prepare the track. */
274 /* See about adding a new random track */
275 add_random_track(c->ev);
276 /* Prepare whatever the next head track is. */
277 if(qhead.next != &qhead)
278 prepare(c->ev, qhead.next);
280 sink_writes(ev_writer_sink(c->w), "250 removed\n");
281 return 1; /* completed */
284 static int c_scratch(struct conn *c,
288 sink_writes(ev_writer_sink(c->w), "250 nothing is playing\n");
289 return 1; /* completed */
291 /* TODO there is a bug here: if we specify an ID but it's not the currently
292 * playing track then you will get 550 if you weren't authorized to scratch
293 * the currently playing track. */
294 if(!right_scratchable(c->rights, c->who, playing)) {
295 error(0, "%s attempted scratch but lacks required rights", c->who);
296 sink_writes(ev_writer_sink(c->w),
297 "510 Not authorized to scratch that track\n");
300 scratch(c->who, nvec == 1 ? vec[0] : 0);
301 /* If you scratch an unpaused track then it is automatically unpaused */
303 sink_writes(ev_writer_sink(c->w), "250 scratched\n");
304 return 1; /* completed */
307 static int c_pause(struct conn *c,
308 char attribute((unused)) **vec,
309 int attribute((unused)) nvec) {
311 sink_writes(ev_writer_sink(c->w), "250 nothing is playing\n");
312 return 1; /* completed */
315 sink_writes(ev_writer_sink(c->w), "250 already paused\n");
316 return 1; /* completed */
318 if(pause_playing(c->who) < 0)
319 sink_writes(ev_writer_sink(c->w), "550 cannot pause this track\n");
321 sink_writes(ev_writer_sink(c->w), "250 paused\n");
325 static int c_resume(struct conn *c,
326 char attribute((unused)) **vec,
327 int attribute((unused)) nvec) {
329 sink_writes(ev_writer_sink(c->w), "250 not paused\n");
330 return 1; /* completed */
332 resume_playing(c->who);
333 sink_writes(ev_writer_sink(c->w), "250 paused\n");
337 static int c_shutdown(struct conn *c,
338 char attribute((unused)) **vec,
339 int attribute((unused)) nvec) {
340 info("S%x shut down by %s", c->tag, c->who);
341 sink_writes(ev_writer_sink(c->w), "250 shutting down\n");
342 ev_writer_flush(c->w);
346 static int c_reconfigure(struct conn *c,
347 char attribute((unused)) **vec,
348 int attribute((unused)) nvec) {
349 info("S%x reconfigure by %s", c->tag, c->who);
350 if(reconfigure(c->ev, 1))
351 sink_writes(ev_writer_sink(c->w), "550 error reading new config\n");
353 sink_writes(ev_writer_sink(c->w), "250 installed new config\n");
354 return 1; /* completed */
357 static void finished_rescan(void *ru) {
358 struct conn *const c = ru;
360 sink_writes(ev_writer_sink(c->w), "250 rescan completed\n");
361 /* Turn this connection back on */
362 ev_reader_enable(c->r);
365 static void start_fresh_rescan(void *ru) {
366 struct conn *const c = ru;
368 if(trackdb_rescan_underway()) {
369 /* Some other waiter beat us to it. However in this case we're happy to
370 * piggyback; the requirement is that a new rescan be started, not that it
371 * was _our_ rescan. */
373 /* We block until the rescan completes */
374 trackdb_add_rescanned(finished_rescan, c);
376 /* We report that the new rescan has started */
377 sink_writes(ev_writer_sink(c->w), "250 rescan initiated\n");
378 /* Turn this connection back on */
379 ev_reader_enable(c->r);
382 /* We are the first connection to get a callback so we must start a
385 /* We want to block until the new rescan completes */
386 trackdb_rescan(c->ev, 1/*check*/, finished_rescan, c);
388 /* We can report back immediately */
389 trackdb_rescan(c->ev, 1/*check*/, 0, 0);
390 sink_writes(ev_writer_sink(c->w), "250 rescan initiated\n");
391 /* Turn this connection back on */
392 ev_reader_enable(c->r);
397 static int c_rescan(struct conn *c,
400 int flag_wait = 0, flag_fresh = 0, n;
403 for(n = 0; n < nvec; ++n) {
404 if(!strcmp(vec[n], "wait"))
405 flag_wait = 1; /* wait for rescan to complete */
407 /* Currently disabled because untested (and hard to test). */
408 else if(!strcmp(vec[n], "fresh"))
409 flag_fresh = 1; /* don't piggyback underway rescan */
412 sink_writes(ev_writer_sink(c->w), "550 unknown flag\n");
413 return 1; /* completed */
416 /* Report what was requested */
417 info("S%x rescan by %s (%s %s)", c->tag, c->who,
418 flag_wait ? "wait" : "",
419 flag_fresh ? "fresh" : "");
420 if(trackdb_rescan_underway()) {
422 /* We want a fresh rescan but there is already one underway. Arrange a
423 * callback when it completes and then set off a new one. */
424 c->rescan_wait = flag_wait;
425 trackdb_add_rescanned(start_fresh_rescan, c);
429 sink_writes(ev_writer_sink(c->w), "250 rescan queued\n");
433 /* There's a rescan underway, and it's acceptable to piggyback on it */
435 /* We want to block until completion. */
436 trackdb_add_rescanned(finished_rescan, c);
439 /* We don't want to block. So we just report that things are in
441 sink_writes(ev_writer_sink(c->w), "250 rescan already underway\n");
446 /* No rescan is underway. fresh is therefore irrelevant. */
448 /* We want to block until completion */
449 trackdb_rescan(c->ev, 1/*check*/, finished_rescan, c);
452 /* We don't want to block. */
453 trackdb_rescan(c->ev, 1/*check*/, 0, 0);
454 sink_writes(ev_writer_sink(c->w), "250 rescan initiated\n");
455 return 1; /* completed */
460 static int c_version(struct conn *c,
461 char attribute((unused)) **vec,
462 int attribute((unused)) nvec) {
463 /* VERSION had better only use the basic character set */
464 sink_printf(ev_writer_sink(c->w), "251 %s\n", disorder_short_version_string);
465 return 1; /* completed */
468 static int c_playing(struct conn *c,
469 char attribute((unused)) **vec,
470 int attribute((unused)) nvec) {
472 queue_fix_sofar(playing);
473 playing->expected = 0;
474 sink_printf(ev_writer_sink(c->w), "252 %s\n", queue_marshall(playing));
476 sink_printf(ev_writer_sink(c->w), "259 nothing playing\n");
477 return 1; /* completed */
480 static const char *connection_host(struct conn *c) {
483 struct sockaddr_in in;
484 struct sockaddr_in6 in6;
490 /* get connection data */
492 if(getpeername(c->fd, &u.sa, &l) < 0) {
493 error(errno, "S%x error calling getpeername", c->tag);
496 if(c->l->pf != PF_UNIX) {
497 if((n = getnameinfo(&u.sa, l,
498 host, sizeof host, 0, 0, NI_NUMERICHOST))) {
499 error(0, "S%x error calling getnameinfo: %s", c->tag, gai_strerror(n));
502 return xstrdup(host);
507 static int c_user(struct conn *c,
509 int attribute((unused)) nvec) {
511 const char *res, *host, *password;
515 sink_writes(ev_writer_sink(c->w), "530 already authenticated\n");
518 /* get connection data */
519 if(!(host = connection_host(c))) {
520 sink_writes(ev_writer_sink(c->w), "530 authentication failure\n");
524 k = trackdb_getuserinfo(vec[0]);
525 /* reject nonexistent users */
527 error(0, "S%x unknown user '%s' from %s", c->tag, vec[0], host);
528 sink_writes(ev_writer_sink(c->w), "530 authentication failed\n");
531 /* reject unconfirmed users */
532 if(kvp_get(k, "confirmation")) {
533 error(0, "S%x unconfirmed user '%s' from %s", c->tag, vec[0], host);
534 sink_writes(ev_writer_sink(c->w), "530 authentication failed\n");
537 password = kvp_get(k, "password");
538 if(!password) password = "";
539 if(parse_rights(kvp_get(k, "rights"), &rights, 1)) {
540 error(0, "error parsing rights for %s", vec[0]);
541 sink_writes(ev_writer_sink(c->w), "530 authentication failed\n");
544 /* check whether the response is right */
545 res = authhash(c->nonce, sizeof c->nonce, password,
546 config->authorization_algorithm);
547 if(wideopen || (res && !strcmp(res, vec[1]))) {
550 /* currently we only bother logging remote connections */
551 if(strcmp(host, "local"))
552 info("S%x %s connected from %s", c->tag, vec[0], host);
554 c->rights |= RIGHT__LOCAL;
555 sink_writes(ev_writer_sink(c->w), "230 OK\n");
558 /* oops, response was wrong */
559 info("S%x authentication failure for %s from %s", c->tag, vec[0], host);
560 sink_writes(ev_writer_sink(c->w), "530 authentication failed\n");
564 static int c_recent(struct conn *c,
565 char attribute((unused)) **vec,
566 int attribute((unused)) nvec) {
567 const struct queue_entry *q;
569 sink_writes(ev_writer_sink(c->w), "253 Tracks follow\n");
570 for(q = phead.next; q != &phead; q = q->next)
571 sink_printf(ev_writer_sink(c->w), " %s\n", queue_marshall(q));
572 sink_writes(ev_writer_sink(c->w), ".\n");
573 return 1; /* completed */
576 static int c_queue(struct conn *c,
577 char attribute((unused)) **vec,
578 int attribute((unused)) nvec) {
579 struct queue_entry *q;
584 sink_writes(ev_writer_sink(c->w), "253 Tracks follow\n");
585 if(playing_is_enabled() && !paused) {
587 queue_fix_sofar(playing);
588 if((l = trackdb_get(playing->track, "_length"))
589 && (length = atol(l))) {
591 when += length - playing->sofar + config->gap;
594 /* Nothing is playing but playing is enabled, so whatever is
595 * first in the queue can be expected to start immediately. */
598 for(q = qhead.next; q != &qhead; q = q->next) {
599 /* fill in estimated start time */
601 sink_printf(ev_writer_sink(c->w), " %s\n", queue_marshall(q));
602 /* update for next track */
604 if((l = trackdb_get(q->track, "_length"))
605 && (length = atol(l)))
606 when += length + config->gap;
611 sink_writes(ev_writer_sink(c->w), ".\n");
612 return 1; /* completed */
615 static int output_list(struct conn *c, char **vec) {
617 sink_printf(ev_writer_sink(c->w), "%s\n", *vec++);
618 sink_writes(ev_writer_sink(c->w), ".\n");
622 static int files_dirs(struct conn *c,
625 enum trackdb_listable what) {
626 const char *dir, *re, *errstr;
632 case 0: dir = 0; re = 0; break;
633 case 1: dir = vec[0]; re = 0; break;
634 case 2: dir = vec[0]; re = vec[1]; break;
637 /* A bit of a bodge to make sure the args don't trample on cache keys */
638 if(dir && strchr(dir, '\n')) {
639 sink_writes(ev_writer_sink(c->w), "550 invalid directory name\n");
642 if(re && strchr(re, '\n')) {
643 sink_writes(ev_writer_sink(c->w), "550 invalid regexp\n");
646 /* We bother eliminating "" because the web interface is relatively
647 * likely to send it */
649 byte_xasprintf(&key, "%d\n%s\n%s", (int)what, dir ? dir : "", re);
650 fvec = (char **)cache_get(&cache_files_type, key);
652 /* Got a cache hit, don't store the answer in the cache */
655 rec = 0; /* quieten compiler */
657 /* Cache miss, we'll do the lookup and key != 0 so we'll store the answer
659 if(!(rec = pcre_compile(re, PCRE_CASELESS|PCRE_UTF8,
660 &errstr, &erroffset, 0))) {
661 sink_printf(ev_writer_sink(c->w), "550 Error compiling regexp: %s\n",
665 /* It only counts as a miss if the regexp was valid. */
666 ++cache_files_misses;
669 /* No regexp, don't bother caching the result */
675 /* No cache hit (either because a miss, or because we did not look) so do
678 fvec = trackdb_list(dir, 0, what, rec);
680 fvec = trackdb_list(0, 0, what, rec);
683 /* Put the answer in the cache */
684 cache_put(&cache_files_type, key, fvec);
685 sink_writes(ev_writer_sink(c->w), "253 Listing follow\n");
686 return output_list(c, fvec);
689 static int c_files(struct conn *c,
692 return files_dirs(c, vec, nvec, trackdb_files);
695 static int c_dirs(struct conn *c,
698 return files_dirs(c, vec, nvec, trackdb_directories);
701 static int c_allfiles(struct conn *c,
704 return files_dirs(c, vec, nvec, trackdb_directories|trackdb_files);
707 static int c_get(struct conn *c,
709 int attribute((unused)) nvec) {
710 const char *v, *track;
712 if(!(track = trackdb_resolve(vec[0]))) {
713 sink_writes(ev_writer_sink(c->w), "550 cannot resolve track\n");
716 if(vec[1][0] != '_' && (v = trackdb_get(track, vec[1])))
717 sink_printf(ev_writer_sink(c->w), "252 %s\n", quoteutf8(v));
719 sink_writes(ev_writer_sink(c->w), "555 not found\n");
723 static int c_length(struct conn *c,
725 int attribute((unused)) nvec) {
726 const char *track, *v;
728 if(!(track = trackdb_resolve(vec[0]))) {
729 sink_writes(ev_writer_sink(c->w), "550 cannot resolve track\n");
732 if((v = trackdb_get(track, "_length")))
733 sink_printf(ev_writer_sink(c->w), "252 %s\n", quoteutf8(v));
735 sink_writes(ev_writer_sink(c->w), "550 not found\n");
739 static int c_set(struct conn *c,
741 int attribute((unused)) nvec) {
744 if(!(track = trackdb_resolve(vec[0]))) {
745 sink_writes(ev_writer_sink(c->w), "550 cannot resolve track\n");
748 if(vec[1][0] != '_' && !trackdb_set(track, vec[1], vec[2]))
749 sink_writes(ev_writer_sink(c->w), "250 OK\n");
751 sink_writes(ev_writer_sink(c->w), "550 not found\n");
755 static int c_prefs(struct conn *c,
757 int attribute((unused)) nvec) {
761 if(!(track = trackdb_resolve(vec[0]))) {
762 sink_writes(ev_writer_sink(c->w), "550 cannot resolve track\n");
765 k = trackdb_get_all(track);
766 sink_writes(ev_writer_sink(c->w), "253 prefs follow\n");
767 for(; k; k = k->next)
768 if(k->name[0] != '_') /* omit internal values */
769 sink_printf(ev_writer_sink(c->w),
770 " %s %s\n", quoteutf8(k->name), quoteutf8(k->value));
771 sink_writes(ev_writer_sink(c->w), ".\n");
775 static int c_exists(struct conn *c,
777 int attribute((unused)) nvec) {
778 /* trackdb_exists() does its own alias checking */
779 sink_printf(ev_writer_sink(c->w), "252 %s\n", noyes[trackdb_exists(vec[0])]);
783 static void search_parse_error(const char *msg, void *u) {
784 *(const char **)u = msg;
787 static int c_search(struct conn *c,
789 int attribute((unused)) nvec) {
790 char **terms, **results;
791 int nterms, nresults, n;
792 const char *e = "unknown error";
794 /* This is a bit of a bodge. Initially it's there to make the eclient
795 * interface a bit more convenient to add searching to, but it has the more
796 * compelling advantage that if everything uses it, then interpretation of
797 * user-supplied search strings will be the same everywhere. */
798 if(!(terms = split(vec[0], &nterms, SPLIT_QUOTES, search_parse_error, &e))) {
799 sink_printf(ev_writer_sink(c->w), "550 %s\n", e);
801 results = trackdb_search(terms, nterms, &nresults);
802 sink_printf(ev_writer_sink(c->w), "253 %d matches\n", nresults);
803 for(n = 0; n < nresults; ++n)
804 sink_printf(ev_writer_sink(c->w), "%s\n", results[n]);
805 sink_writes(ev_writer_sink(c->w), ".\n");
810 static int c_random_enable(struct conn *c,
811 char attribute((unused)) **vec,
812 int attribute((unused)) nvec) {
813 enable_random(c->who, c->ev);
814 /* Enable implicitly unpauses if there is nothing playing */
815 if(paused && !playing) resume_playing(c->who);
816 sink_writes(ev_writer_sink(c->w), "250 OK\n");
817 return 1; /* completed */
820 static int c_random_disable(struct conn *c,
821 char attribute((unused)) **vec,
822 int attribute((unused)) nvec) {
823 disable_random(c->who);
824 sink_writes(ev_writer_sink(c->w), "250 OK\n");
825 return 1; /* completed */
828 static int c_random_enabled(struct conn *c,
829 char attribute((unused)) **vec,
830 int attribute((unused)) nvec) {
831 sink_printf(ev_writer_sink(c->w), "252 %s\n", noyes[random_is_enabled()]);
832 return 1; /* completed */
835 static void got_stats(char *stats, void *u) {
836 struct conn *const c = u;
838 sink_printf(ev_writer_sink(c->w), "253 stats\n%s\n.\n", stats);
839 /* Now we can start processing commands again */
840 ev_reader_enable(c->r);
843 static int c_stats(struct conn *c,
844 char attribute((unused)) **vec,
845 int attribute((unused)) nvec) {
846 trackdb_stats_subprocess(c->ev, got_stats, c);
847 return 0; /* not yet complete */
850 static int c_volume(struct conn *c,
862 l = r = atoi(vec[0]);
873 rights = set ? RIGHT_VOLUME : RIGHT_READ;
874 if(!(c->rights & rights)) {
875 error(0, "%s attempted to set volume but lacks required rights", c->who);
876 sink_writes(ev_writer_sink(c->w), "510 Prohibited\n");
879 if(mixer_control(-1/*as configured*/, &l, &r, set))
880 sink_writes(ev_writer_sink(c->w), "550 error accessing mixer\n");
882 sink_printf(ev_writer_sink(c->w), "252 %d %d\n", l, r);
883 if(l != volume_left || r != volume_right) {
886 snprintf(lb, sizeof lb, "%d", l);
887 snprintf(rb, sizeof rb, "%d", r);
888 eventlog("volume", lb, rb, (char *)0);
894 /** @brief Called when data arrives on a log connection
896 * We just discard all such data. The client may occasionally send data as a
899 static int logging_reader_callback(ev_source attribute((unused)) *ev,
901 void attribute((unused)) *ptr,
903 int attribute((unused)) eof,
904 void attribute((unused)) *u) {
907 ev_reader_consume(reader, bytes);
909 /* Oops, that's all for now */
910 D(("logging reader eof"));
913 ev_writer_close(c->w);
917 remove_connection(c);
922 static void logclient(const char *msg, void *user) {
923 struct conn *c = user;
926 /* This connection has gone up in smoke for some reason */
927 eventlog_remove(c->lo);
931 /* user_* messages are restricted */
932 if(!strncmp(msg, "user_", 5)) {
933 /* They are only sent to admin users */
934 if(!(c->rights & RIGHT_ADMIN))
936 /* They are not sent over TCP connections unless remote user-management is
938 if(!config->remote_userman && !(c->rights & RIGHT__LOCAL))
941 sink_printf(ev_writer_sink(c->w), "%"PRIxMAX" %s\n",
942 (uintmax_t)time(0), msg);
945 static int c_log(struct conn *c,
946 char attribute((unused)) **vec,
947 int attribute((unused)) nvec) {
950 sink_writes(ev_writer_sink(c->w), "254 OK\n");
951 /* pump out initial state */
953 sink_printf(ev_writer_sink(c->w), "%"PRIxMAX" state %s\n",
955 playing_is_enabled() ? "enable_play" : "disable_play");
956 sink_printf(ev_writer_sink(c->w), "%"PRIxMAX" state %s\n",
958 random_is_enabled() ? "enable_random" : "disable_random");
959 sink_printf(ev_writer_sink(c->w), "%"PRIxMAX" state %s\n",
961 paused ? "pause" : "resume");
963 sink_printf(ev_writer_sink(c->w), "%"PRIxMAX" state playing\n",
966 sink_printf(ev_writer_sink(c->w), "%"PRIxMAX" volume %d %d\n",
967 (uintmax_t)now, volume_left, volume_right);
968 c->lo = xmalloc(sizeof *c->lo);
969 c->lo->fn = logclient;
972 c->reader = logging_reader_callback;
976 /** @brief Test whether a move is allowed
977 * @param c Connection
978 * @param qs List of IDs on queue
979 * @param nqs Number of IDs
980 * @return 0 if move is prohibited, non-0 if it is allowed
982 static int has_move_rights(struct conn *c, struct queue_entry **qs, int nqs) {
983 for(; nqs > 0; ++qs, --nqs) {
984 struct queue_entry *const q = *qs;
986 if(!right_movable(c->rights, c->who, q))
992 static int c_move(struct conn *c,
994 int attribute((unused)) nvec) {
995 struct queue_entry *q;
998 if(!(q = queue_find(vec[0]))) {
999 sink_writes(ev_writer_sink(c->w), "550 no such track on the queue\n");
1002 if(!has_move_rights(c, &q, 1)) {
1003 error(0, "%s attempted move but lacks required rights", c->who);
1004 sink_writes(ev_writer_sink(c->w),
1005 "510 Not authorized to move that track\n");
1008 n = queue_move(q, atoi(vec[1]), c->who);
1009 sink_printf(ev_writer_sink(c->w), "252 %d\n", n);
1010 /* If we've moved to the head of the queue then prepare the track. */
1016 static int c_moveafter(struct conn *c,
1018 int attribute((unused)) nvec) {
1019 struct queue_entry *q, **qs;
1023 if(!(q = queue_find(vec[0]))) {
1024 sink_writes(ev_writer_sink(c->w), "550 no such track on the queue\n");
1031 qs = xcalloc(nvec, sizeof *qs);
1032 for(n = 0; n < nvec; ++n)
1033 if(!(qs[n] = queue_find(vec[n]))) {
1034 sink_writes(ev_writer_sink(c->w), "550 no such track on the queue\n");
1037 if(!has_move_rights(c, qs, nvec)) {
1038 error(0, "%s attempted moveafter but lacks required rights", c->who);
1039 sink_writes(ev_writer_sink(c->w),
1040 "510 Not authorized to move those tracks\n");
1043 queue_moveafter(q, nvec, qs, c->who);
1044 sink_printf(ev_writer_sink(c->w), "250 Moved tracks\n");
1045 /* If we've moved to the head of the queue then prepare the track. */
1051 static int c_part(struct conn *c,
1053 int attribute((unused)) nvec) {
1056 if(!(track = trackdb_resolve(vec[0]))) {
1057 sink_writes(ev_writer_sink(c->w), "550 cannot resolve track\n");
1060 sink_printf(ev_writer_sink(c->w), "252 %s\n",
1061 quoteutf8(trackdb_getpart(track, vec[1], vec[2])));
1065 static int c_resolve(struct conn *c,
1067 int attribute((unused)) nvec) {
1070 if(!(track = trackdb_resolve(vec[0]))) {
1071 sink_writes(ev_writer_sink(c->w), "550 cannot resolve track\n");
1074 sink_printf(ev_writer_sink(c->w), "252 %s\n", quoteutf8(track));
1078 static int list_response(struct conn *c,
1081 sink_printf(ev_writer_sink(c->w), "253 %s\n", reply);
1083 sink_printf(ev_writer_sink(c->w), "%s%s\n",
1084 **list == '.' ? "." : "", *list);
1087 sink_writes(ev_writer_sink(c->w), ".\n");
1088 return 1; /* completed */
1091 static int c_tags(struct conn *c,
1092 char attribute((unused)) **vec,
1093 int attribute((unused)) nvec) {
1094 return list_response(c, "Tag list follows", trackdb_alltags());
1097 static int c_set_global(struct conn *c,
1099 int attribute((unused)) nvec) {
1100 if(vec[0][0] == '_') {
1101 sink_writes(ev_writer_sink(c->w), "550 cannot set internal global preferences\n");
1104 trackdb_set_global(vec[0], vec[1], c->who);
1105 sink_printf(ev_writer_sink(c->w), "250 OK\n");
1109 static int c_get_global(struct conn *c,
1111 int attribute((unused)) nvec) {
1112 const char *s = trackdb_get_global(vec[0]);
1115 sink_printf(ev_writer_sink(c->w), "252 %s\n", quoteutf8(s));
1117 sink_writes(ev_writer_sink(c->w), "555 not found\n");
1121 static int c_nop(struct conn *c,
1122 char attribute((unused)) **vec,
1123 int attribute((unused)) nvec) {
1124 sink_printf(ev_writer_sink(c->w), "250 Quack\n");
1128 static int c_new(struct conn *c,
1138 if(max <= 0 || max > config->new_max)
1139 max = config->new_max;
1140 tracks = trackdb_new(0, max);
1141 sink_printf(ev_writer_sink(c->w), "253 New track list follows\n");
1144 sink_printf(ev_writer_sink(c->w), "%s%s\n",
1145 **tracks == '.' ? "." : "", *tracks);
1148 sink_writes(ev_writer_sink(c->w), ".\n");
1149 return 1; /* completed */
1153 static int c_rtp_address(struct conn *c,
1154 char attribute((unused)) **vec,
1155 int attribute((unused)) nvec) {
1156 if(config->api == BACKEND_NETWORK) {
1157 sink_printf(ev_writer_sink(c->w), "252 %s %s\n",
1158 quoteutf8(config->broadcast.s[0]),
1159 quoteutf8(config->broadcast.s[1]));
1161 sink_writes(ev_writer_sink(c->w), "550 No RTP\n");
1165 static int c_cookie(struct conn *c,
1167 int attribute((unused)) nvec) {
1172 /* Can't log in twice on the same connection */
1174 sink_writes(ev_writer_sink(c->w), "530 already authenticated\n");
1177 /* Get some kind of peer identifcation */
1178 if(!(host = connection_host(c))) {
1179 sink_writes(ev_writer_sink(c->w), "530 authentication failure\n");
1182 /* Check the cookie */
1183 user = verify_cookie(vec[0], &rights);
1185 sink_writes(ev_writer_sink(c->w), "530 authentication failure\n");
1192 if(strcmp(host, "local"))
1193 info("S%x %s connected with cookie from %s", c->tag, user, host);
1195 c->rights |= RIGHT__LOCAL;
1196 /* Response contains username so client knows who they are acting as */
1197 sink_printf(ev_writer_sink(c->w), "232 %s\n", quoteutf8(user));
1201 static int c_make_cookie(struct conn *c,
1202 char attribute((unused)) **vec,
1203 int attribute((unused)) nvec) {
1204 const char *cookie = make_cookie(c->who);
1207 sink_printf(ev_writer_sink(c->w), "252 %s\n", quoteutf8(cookie));
1209 sink_writes(ev_writer_sink(c->w), "550 Cannot create cookie\n");
1213 static int c_revoke(struct conn *c,
1214 char attribute((unused)) **vec,
1215 int attribute((unused)) nvec) {
1217 revoke_cookie(c->cookie);
1218 sink_writes(ev_writer_sink(c->w), "250 OK\n");
1220 sink_writes(ev_writer_sink(c->w), "550 Did not log in with cookie\n");
1224 static int c_adduser(struct conn *c,
1229 if(!config->remote_userman && !(c->rights & RIGHT__LOCAL)) {
1230 error(0, "S%x: remote adduser", c->tag);
1231 sink_writes(ev_writer_sink(c->w), "550 Remote user management is disabled\n");
1236 if(parse_rights(vec[2], 0, 1)) {
1237 sink_writes(ev_writer_sink(c->w), "550 Invalid rights list\n");
1241 rights = config->default_rights;
1242 if(trackdb_adduser(vec[0], vec[1], rights,
1243 0/*email*/, 0/*confirmation*/))
1244 sink_writes(ev_writer_sink(c->w), "550 Cannot create user\n");
1246 sink_writes(ev_writer_sink(c->w), "250 User created\n");
1250 static int c_deluser(struct conn *c,
1252 int attribute((unused)) nvec) {
1255 if(!config->remote_userman && !(c->rights & RIGHT__LOCAL)) {
1256 error(0, "S%x: remote deluser", c->tag);
1257 sink_writes(ev_writer_sink(c->w), "550 Remote user management is disabled\n");
1260 if(trackdb_deluser(vec[0])) {
1261 sink_writes(ev_writer_sink(c->w), "550 Cannot delete user\n");
1264 /* Zap connections belonging to deleted user */
1265 for(d = connections; d; d = d->next)
1266 if(!strcmp(d->who, vec[0]))
1268 sink_writes(ev_writer_sink(c->w), "250 User deleted\n");
1272 static int c_edituser(struct conn *c,
1274 int attribute((unused)) nvec) {
1277 if(!config->remote_userman && !(c->rights & RIGHT__LOCAL)) {
1278 error(0, "S%x: remote edituser", c->tag);
1279 sink_writes(ev_writer_sink(c->w), "550 Remote user management is disabled\n");
1282 /* RIGHT_ADMIN can do anything; otherwise you can only set your own email
1283 * address and password. */
1284 if((c->rights & RIGHT_ADMIN)
1285 || (!strcmp(c->who, vec[0])
1286 && (!strcmp(vec[1], "email")
1287 || !strcmp(vec[1], "password")))) {
1288 if(trackdb_edituserinfo(vec[0], vec[1], vec[2])) {
1289 sink_writes(ev_writer_sink(c->w), "550 Failed to change setting\n");
1292 if(!strcmp(vec[1], "password")) {
1293 /* Zap all connections for this user after a password change */
1294 for(d = connections; d; d = d->next)
1295 if(!strcmp(d->who, vec[0]))
1297 } else if(!strcmp(vec[1], "rights")) {
1298 /* Update rights for this user */
1301 if(!parse_rights(vec[2], &r, 1)) {
1302 const char *new_rights = rights_string(r);
1303 for(d = connections; d; d = d->next) {
1304 if(!strcmp(d->who, vec[0])) {
1307 /* Notify any log connections */
1309 sink_printf(ev_writer_sink(d->w),
1310 "%"PRIxMAX" rights_changed %s\n",
1312 quoteutf8(new_rights));
1317 sink_writes(ev_writer_sink(c->w), "250 OK\n");
1319 error(0, "%s attempted edituser but lacks required rights", c->who);
1320 sink_writes(ev_writer_sink(c->w), "510 Restricted to administrators\n");
1325 static int c_userinfo(struct conn *c,
1326 char attribute((unused)) **vec,
1327 int attribute((unused)) nvec) {
1331 /* We allow remote querying of rights so that clients can figure out what
1332 * they're allowed to do */
1333 if(!config->remote_userman
1334 && !(c->rights & RIGHT__LOCAL)
1335 && strcmp(vec[1], "rights")) {
1336 error(0, "S%x: remote userinfo %s %s", c->tag, vec[0], vec[1]);
1337 sink_writes(ev_writer_sink(c->w), "550 Remote user management is disabled\n");
1340 /* RIGHT_ADMIN allows anything; otherwise you can only get your own email
1341 * address and rights list. */
1342 if((c->rights & RIGHT_ADMIN)
1343 || (!strcmp(c->who, vec[0])
1344 && (!strcmp(vec[1], "email")
1345 || !strcmp(vec[1], "rights")))) {
1346 if((k = trackdb_getuserinfo(vec[0])))
1347 if((value = kvp_get(k, vec[1])))
1348 sink_printf(ev_writer_sink(c->w), "252 %s\n", quoteutf8(value));
1350 sink_writes(ev_writer_sink(c->w), "555 Not set\n");
1352 sink_writes(ev_writer_sink(c->w), "550 No such user\n");
1354 error(0, "%s attempted userinfo but lacks required rights", c->who);
1355 sink_writes(ev_writer_sink(c->w), "510 Restricted to administrators\n");
1360 static int c_users(struct conn *c,
1361 char attribute((unused)) **vec,
1362 int attribute((unused)) nvec) {
1363 return list_response(c, "User list follows", trackdb_listusers());
1366 /** @brief Base64 mapping table for confirmation strings
1368 * This is used with generic_to_base64() and generic_base64(). We cannot use
1369 * the MIME table as that contains '+' and '=' which get quoted when
1370 * URL-encoding. (The CGI still does the URL encoding but it is desirable to
1371 * avoid it being necessary.)
1373 static const char confirm_base64_table[] =
1374 "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789/.*";
1376 static int c_register(struct conn *c,
1378 int attribute((unused)) nvec) {
1383 /* The confirmation string is base64(username;nonce) */
1384 bufsize = strlen(vec[0]) + CONFIRM_SIZE + 2;
1385 buf = xmalloc_noptr(bufsize);
1386 offset = byte_snprintf(buf, bufsize, "%s;", vec[0]);
1387 gcry_randomize(buf + offset, CONFIRM_SIZE, GCRY_STRONG_RANDOM);
1388 cs = generic_to_base64((uint8_t *)buf, offset + CONFIRM_SIZE,
1389 confirm_base64_table);
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) {
1405 /* Get some kind of peer identifcation */
1406 if(!(host = connection_host(c))) {
1407 sink_writes(ev_writer_sink(c->w), "530 Authentication failure\n");
1410 if(!(user = generic_base64(vec[0], &nuser, confirm_base64_table))
1411 || !(sep = memchr(user, ';', nuser))) {
1412 sink_writes(ev_writer_sink(c->w), "550 Malformed confirmation string\n");
1416 if(trackdb_confirm(user, vec[0], &rights))
1417 sink_writes(ev_writer_sink(c->w), "550 Incorrect confirmation string\n");
1422 if(strcmp(host, "local"))
1423 info("S%x %s confirmed from %s", c->tag, user, host);
1425 c->rights |= RIGHT__LOCAL;
1426 /* Response contains username so client knows who they are acting as */
1427 sink_printf(ev_writer_sink(c->w), "232 %s\n", quoteutf8(user));
1432 static int sent_reminder(ev_source attribute((unused)) *ev,
1433 pid_t attribute((unused)) pid,
1435 const struct rusage attribute((unused)) *rusage,
1437 struct conn *const c = u;
1439 /* Tell the client what went down */
1441 sink_writes(ev_writer_sink(c->w), "250 OK\n");
1443 error(0, "reminder subprocess %s", wstat(status));
1444 sink_writes(ev_writer_sink(c->w), "550 Cannot send a reminder email\n");
1446 /* Re-enable this connection */
1447 ev_reader_enable(c->r);
1451 static int c_reminder(struct conn *c,
1453 int attribute((unused)) nvec) {
1455 const char *password, *email, *text, *encoding, *charset, *content_type;
1460 static hash *last_reminder;
1462 if(!config->mail_sender) {
1463 error(0, "cannot send password reminders because mail_sender not set");
1464 sink_writes(ev_writer_sink(c->w), "550 Cannot send a reminder email\n");
1467 if(!(k = trackdb_getuserinfo(vec[0]))) {
1468 error(0, "reminder for user '%s' who does not exist", vec[0]);
1469 sink_writes(ev_writer_sink(c->w), "550 Cannot send a reminder email\n");
1472 if(!(email = kvp_get(k, "email"))
1473 || !email_valid(email)) {
1474 error(0, "user '%s' has no valid email address", vec[0]);
1475 sink_writes(ev_writer_sink(c->w), "550 Cannot send a reminder email\n");
1478 if(!(password = kvp_get(k, "password"))
1480 error(0, "user '%s' has no password", vec[0]);
1481 sink_writes(ev_writer_sink(c->w), "550 Cannot send a reminder email\n");
1484 /* Rate-limit reminders. This hash is bounded in size by the number of
1485 * users. If this is actually a problem for anyone then we can periodically
1488 last_reminder = hash_new(sizeof (time_t));
1489 last = hash_find(last_reminder, vec[0]);
1491 if(last && now < *last + config->reminder_interval) {
1492 error(0, "sent a password reminder to '%s' too recently", vec[0]);
1493 sink_writes(ev_writer_sink(c->w), "550 Cannot send a reminder email\n");
1496 /* Send the reminder */
1497 /* TODO this should be templatized and to some extent merged with
1498 * the code in act_register() */
1499 byte_xasprintf((char **)&text,
1500 "Someone requested that you be sent a reminder of your DisOrder password.\n"
1501 "Your password is:\n"
1504 if(!(text = mime_encode_text(text, &charset, &encoding)))
1505 fatal(0, "cannot encode email");
1506 byte_xasprintf((char **)&content_type, "text/plain;charset=%s",
1507 quote822(charset, 0));
1508 pid = sendmail_subprocess("", config->mail_sender, email,
1509 "DisOrder password reminder",
1510 encoding, content_type, text);
1512 sink_writes(ev_writer_sink(c->w), "550 Cannot send a reminder email\n");
1515 hash_add(last_reminder, vec[0], &now, HASH_INSERT_OR_REPLACE);
1516 info("sending a passsword reminder to user '%s'", vec[0]);
1517 /* We can only continue when the subprocess finishes */
1518 ev_child(c->ev, pid, 0, sent_reminder, c);
1522 static int c_schedule_list(struct conn *c,
1523 char attribute((unused)) **vec,
1524 int attribute((unused)) nvec) {
1525 char **ids = schedule_list(0);
1526 sink_writes(ev_writer_sink(c->w), "253 ID list follows\n");
1528 sink_printf(ev_writer_sink(c->w), "%s\n", *ids++);
1529 sink_writes(ev_writer_sink(c->w), ".\n");
1530 return 1; /* completed */
1533 static int c_schedule_get(struct conn *c,
1535 int attribute((unused)) nvec) {
1536 struct kvp *actiondata = schedule_get(vec[0]), *k;
1539 sink_writes(ev_writer_sink(c->w), "555 No such event\n");
1540 return 1; /* completed */
1542 /* Scheduled events are public information. Anyone with RIGHT_READ can see
1544 sink_writes(ev_writer_sink(c->w), "253 Event information follows\n");
1545 for(k = actiondata; k; k = k->next)
1546 sink_printf(ev_writer_sink(c->w), " %s %s\n",
1547 quoteutf8(k->name), quoteutf8(k->value));
1548 sink_writes(ev_writer_sink(c->w), ".\n");
1549 return 1; /* completed */
1552 static int c_schedule_del(struct conn *c,
1554 int attribute((unused)) nvec) {
1555 struct kvp *actiondata = schedule_get(vec[0]);
1558 sink_writes(ev_writer_sink(c->w), "555 No such event\n");
1559 return 1; /* completed */
1561 /* If you have admin rights you can delete anything. If you don't then you
1562 * can only delete your own scheduled events. */
1563 if(!(c->rights & RIGHT_ADMIN)) {
1564 const char *who = kvp_get(actiondata, "who");
1566 if(!who || !c->who || strcmp(who, c->who)) {
1567 sink_writes(ev_writer_sink(c->w), "551 Not authorized\n");
1568 return 1; /* completed */
1571 if(schedule_del(vec[0]))
1572 sink_writes(ev_writer_sink(c->w), "550 Could not delete scheduled event\n");
1574 sink_writes(ev_writer_sink(c->w), "250 Deleted\n");
1575 return 1; /* completed */
1578 static int c_schedule_add(struct conn *c,
1581 struct kvp *actiondata = 0;
1584 /* Standard fields */
1585 kvp_set(&actiondata, "who", c->who);
1586 kvp_set(&actiondata, "when", vec[0]);
1587 kvp_set(&actiondata, "priority", vec[1]);
1588 kvp_set(&actiondata, "action", vec[2]);
1589 /* Action-dependent fields */
1590 if(!strcmp(vec[2], "play")) {
1592 sink_writes(ev_writer_sink(c->w), "550 Wrong number of arguments\n");
1595 if(!trackdb_exists(vec[3])) {
1596 sink_writes(ev_writer_sink(c->w), "550 Track is not in database\n");
1599 kvp_set(&actiondata, "track", vec[3]);
1600 } else if(!strcmp(vec[2], "set-global")) {
1601 if(nvec < 4 || nvec > 5) {
1602 sink_writes(ev_writer_sink(c->w), "550 Wrong number of arguments\n");
1605 kvp_set(&actiondata, "key", vec[3]);
1607 kvp_set(&actiondata, "value", vec[4]);
1609 sink_writes(ev_writer_sink(c->w), "550 Unknown action\n");
1612 /* schedule_add() checks user rights */
1613 id = schedule_add(c->ev, actiondata);
1615 sink_writes(ev_writer_sink(c->w), "550 Cannot add scheduled event\n");
1617 sink_printf(ev_writer_sink(c->w), "252 %s\n", id);
1621 static int playlist_response(struct conn *c,
1625 assert(!"cannot cope with success");
1627 sink_writes(ev_writer_sink(c->w), "550 Access denied\n");
1630 sink_writes(ev_writer_sink(c->w), "550 Invalid playlist name\n");
1633 sink_writes(ev_writer_sink(c->w), "555 No such playlist\n");
1636 sink_writes(ev_writer_sink(c->w), "550 Error accessing playlist\n");
1642 static int c_playlist_get(struct conn *c,
1644 int attribute((unused)) nvec) {
1648 if(!(err = trackdb_playlist_get(vec[0], c->who, &tracks, 0, 0)))
1649 return list_response(c, "Playlist contents follows", tracks);
1651 return playlist_response(c, err);
1654 static int c_playlist_set(struct conn *c,
1656 int attribute((unused)) nvec) {
1657 return fetch_body(c, c_playlist_set_body, vec[0]);
1660 static int c_playlist_set_body(struct conn *c,
1664 const char *playlist = u;
1667 if(!(err = trackdb_playlist_set(playlist, c->who,
1669 sink_printf(ev_writer_sink(c->w), "250 OK\n");
1672 return playlist_response(c, err);
1675 static int c_playlist_get_share(struct conn *c,
1677 int attribute((unused)) nvec) {
1681 if(!(err = trackdb_playlist_get(vec[0], c->who, 0, 0, &share))) {
1682 sink_printf(ev_writer_sink(c->w), "252 %s\n", quoteutf8(share));
1685 return playlist_response(c, err);
1688 static int c_playlist_set_share(struct conn *c,
1690 int attribute((unused)) nvec) {
1693 if(!(err = trackdb_playlist_set(vec[0], c->who, 0, 0, vec[1]))) {
1694 sink_printf(ev_writer_sink(c->w), "250 OK\n");
1697 return playlist_response(c, err);
1700 static int c_playlists(struct conn *c,
1701 char attribute((unused)) **vec,
1702 int attribute((unused)) nvec) {
1705 trackdb_playlist_list(c->who, &p, 0);
1706 return list_response(c, "List of playlists follows", p);
1709 static int c_playlist_delete(struct conn *c,
1711 int attribute((unused)) nvec) {
1714 if(!(err = trackdb_playlist_delete(vec[0], c->who))) {
1715 sink_writes(ev_writer_sink(c->w), "250 OK\n");
1718 return playlist_response(c, err);
1721 static int c_playlist_lock(struct conn *c,
1723 int attribute((unused)) nvec) {
1727 /* Check we're allowed to modify this playlist */
1728 if((err = trackdb_playlist_set(vec[0], c->who, 0, 0, 0)))
1729 return playlist_response(c, err);
1730 /* If we hold a lock don't allow a new one */
1731 if(c->locked_playlist) {
1732 sink_writes(ev_writer_sink(c->w), "550 Already holding a lock\n");
1735 /* See if some other connection locks the same playlist */
1736 for(cc = connections; cc; cc = cc->next)
1737 if(cc->locked_playlist && !strcmp(cc->locked_playlist, vec[0]))
1740 /* TODO: implement config->playlist_lock_timeout */
1741 sink_writes(ev_writer_sink(c->w), "550 Already locked\n");
1744 c->locked_playlist = xstrdup(vec[0]);
1745 time(&c->locked_when);
1746 sink_writes(ev_writer_sink(c->w), "250 Acquired lock\n");
1750 static int c_playlist_unlock(struct conn *c,
1751 char attribute((unused)) **vec,
1752 int attribute((unused)) nvec) {
1753 if(!c->locked_playlist) {
1754 sink_writes(ev_writer_sink(c->w), "550 Not holding a lock\n");
1757 c->locked_playlist = 0;
1758 sink_writes(ev_writer_sink(c->w), "250 Released lock\n");
1762 static const struct command {
1763 /** @brief Command name */
1766 /** @brief Minimum number of arguments */
1769 /** @brief Maximum number of arguments */
1772 /** @brief Function to process command */
1773 int (*fn)(struct conn *, char **, int);
1775 /** @brief Rights required to execute command
1777 * 0 means that the command can be issued without logging in. If multiple
1778 * bits are listed here any of those rights will do.
1782 { "adduser", 2, 3, c_adduser, RIGHT_ADMIN|RIGHT__LOCAL },
1783 { "allfiles", 0, 2, c_allfiles, RIGHT_READ },
1784 { "confirm", 1, 1, c_confirm, 0 },
1785 { "cookie", 1, 1, c_cookie, 0 },
1786 { "deluser", 1, 1, c_deluser, RIGHT_ADMIN|RIGHT__LOCAL },
1787 { "dirs", 0, 2, c_dirs, RIGHT_READ },
1788 { "disable", 0, 1, c_disable, RIGHT_GLOBAL_PREFS },
1789 { "edituser", 3, 3, c_edituser, RIGHT_ADMIN|RIGHT_USERINFO },
1790 { "enable", 0, 0, c_enable, RIGHT_GLOBAL_PREFS },
1791 { "enabled", 0, 0, c_enabled, RIGHT_READ },
1792 { "exists", 1, 1, c_exists, RIGHT_READ },
1793 { "files", 0, 2, c_files, RIGHT_READ },
1794 { "get", 2, 2, c_get, RIGHT_READ },
1795 { "get-global", 1, 1, c_get_global, RIGHT_READ },
1796 { "length", 1, 1, c_length, RIGHT_READ },
1797 { "log", 0, 0, c_log, RIGHT_READ },
1798 { "make-cookie", 0, 0, c_make_cookie, RIGHT_READ },
1799 { "move", 2, 2, c_move, RIGHT_MOVE__MASK },
1800 { "moveafter", 1, INT_MAX, c_moveafter, RIGHT_MOVE__MASK },
1801 { "new", 0, 1, c_new, RIGHT_READ },
1802 { "nop", 0, 0, c_nop, 0 },
1803 { "part", 3, 3, c_part, RIGHT_READ },
1804 { "pause", 0, 0, c_pause, RIGHT_PAUSE },
1805 { "play", 1, 1, c_play, RIGHT_PLAY },
1806 { "playing", 0, 0, c_playing, RIGHT_READ },
1807 { "playlist-delete", 1, 1, c_playlist_delete, RIGHT_PLAY },
1808 { "playlist-get", 1, 1, c_playlist_get, RIGHT_READ },
1809 { "playlist-get-share", 1, 1, c_playlist_get_share, RIGHT_READ },
1810 { "playlist-lock", 1, 1, c_playlist_lock, RIGHT_PLAY },
1811 { "playlist-set", 1, 1, c_playlist_set, RIGHT_PLAY },
1812 { "playlist-set-share", 2, 2, c_playlist_set_share, RIGHT_PLAY },
1813 { "playlist-unlock", 0, 0, c_playlist_unlock, RIGHT_PLAY },
1814 { "playlists", 0, 0, c_playlists, RIGHT_READ },
1815 { "prefs", 1, 1, c_prefs, RIGHT_READ },
1816 { "queue", 0, 0, c_queue, RIGHT_READ },
1817 { "random-disable", 0, 0, c_random_disable, RIGHT_GLOBAL_PREFS },
1818 { "random-enable", 0, 0, c_random_enable, RIGHT_GLOBAL_PREFS },
1819 { "random-enabled", 0, 0, c_random_enabled, RIGHT_READ },
1820 { "recent", 0, 0, c_recent, RIGHT_READ },
1821 { "reconfigure", 0, 0, c_reconfigure, RIGHT_ADMIN },
1822 { "register", 3, 3, c_register, RIGHT_REGISTER|RIGHT__LOCAL },
1823 { "reminder", 1, 1, c_reminder, RIGHT__LOCAL },
1824 { "remove", 1, 1, c_remove, RIGHT_REMOVE__MASK },
1825 { "rescan", 0, INT_MAX, c_rescan, RIGHT_RESCAN },
1826 { "resolve", 1, 1, c_resolve, RIGHT_READ },
1827 { "resume", 0, 0, c_resume, RIGHT_PAUSE },
1828 { "revoke", 0, 0, c_revoke, RIGHT_READ },
1829 { "rtp-address", 0, 0, c_rtp_address, 0 },
1830 { "schedule-add", 3, INT_MAX, c_schedule_add, RIGHT_READ },
1831 { "schedule-del", 1, 1, c_schedule_del, RIGHT_READ },
1832 { "schedule-get", 1, 1, c_schedule_get, RIGHT_READ },
1833 { "schedule-list", 0, 0, c_schedule_list, RIGHT_READ },
1834 { "scratch", 0, 1, c_scratch, RIGHT_SCRATCH__MASK },
1835 { "search", 1, 1, c_search, RIGHT_READ },
1836 { "set", 3, 3, c_set, RIGHT_PREFS, },
1837 { "set-global", 2, 2, c_set_global, RIGHT_GLOBAL_PREFS },
1838 { "shutdown", 0, 0, c_shutdown, RIGHT_ADMIN },
1839 { "stats", 0, 0, c_stats, RIGHT_READ },
1840 { "tags", 0, 0, c_tags, RIGHT_READ },
1841 { "unset", 2, 2, c_set, RIGHT_PREFS },
1842 { "unset-global", 1, 1, c_set_global, RIGHT_GLOBAL_PREFS },
1843 { "user", 2, 2, c_user, 0 },
1844 { "userinfo", 2, 2, c_userinfo, RIGHT_READ },
1845 { "users", 0, 0, c_users, RIGHT_READ },
1846 { "version", 0, 0, c_version, RIGHT_READ },
1847 { "volume", 0, 2, c_volume, RIGHT_READ|RIGHT_VOLUME }
1850 /** @brief Fetch a command body
1851 * @param c Connection
1852 * @param body_callback Called with body
1853 * @param u Passed to body_callback
1856 static int fetch_body(struct conn *c,
1857 body_callback_type body_callback,
1859 assert(c->line_reader == command);
1860 c->line_reader = body_line;
1861 c->body_callback = body_callback;
1863 vector_init(c->body);
1867 /** @brief @ref line_reader_type callback for command body lines
1868 * @param c Connection
1870 * @return 1 if complete, 0 if incomplete
1872 * Called from reader_callback().
1874 static int body_line(struct conn *c,
1879 /* That's the lot */
1880 c->line_reader = command;
1881 vector_terminate(c->body);
1882 return c->body_callback(c, c->body->vec, c->body->nvec, c->body_u);
1885 vector_append(c->body, xstrdup(line));
1886 return 1; /* completed */
1889 static void command_error(const char *msg, void *u) {
1892 sink_printf(ev_writer_sink(c->w), "500 parse error: %s\n", msg);
1895 /** @brief @ref line_reader_type callback for commands
1896 * @param c Connection
1898 * @return 1 if complete, 0 if incomplete
1900 * Called from reader_callback().
1902 static int command(struct conn *c, char *line) {
1906 D(("server command %s", line));
1907 /* We force everything into NFC as early as possible */
1908 if(!(line = utf8_compose_canon(line, strlen(line), 0))) {
1909 sink_writes(ev_writer_sink(c->w), "500 cannot normalize command\n");
1912 if(!(vec = split(line, &nvec, SPLIT_QUOTES, command_error, c))) {
1913 sink_writes(ev_writer_sink(c->w), "500 cannot parse command\n");
1917 sink_writes(ev_writer_sink(c->w), "500 do what?\n");
1920 if((n = TABLE_FIND(commands, name, vec[0])) < 0)
1921 sink_writes(ev_writer_sink(c->w), "500 unknown command\n");
1923 if(commands[n].rights
1924 && !(c->rights & commands[n].rights)) {
1925 error(0, "%s attempted %s but lacks required rights", c->who ? c->who : "NULL",
1927 sink_writes(ev_writer_sink(c->w), "510 Prohibited\n");
1932 if(nvec < commands[n].minargs) {
1933 sink_writes(ev_writer_sink(c->w), "500 missing argument(s)\n");
1936 if(nvec > commands[n].maxargs) {
1937 sink_writes(ev_writer_sink(c->w), "500 too many arguments\n");
1940 return commands[n].fn(c, vec, nvec);
1942 return 1; /* completed */
1945 /* redirect to the right reader callback for our current state */
1946 static int redirect_reader_callback(ev_source *ev,
1954 return c->reader(ev, reader, ptr, bytes, eof, u);
1957 /* the main command reader */
1958 static int reader_callback(ev_source attribute((unused)) *ev,
1968 D(("server reader_callback"));
1969 while((eol = memchr(ptr, '\n', bytes))) {
1971 ev_reader_consume(reader, eol - (char *)ptr);
1972 complete = c->line_reader(c, ptr); /* usually command() */
1973 bytes -= (eol - (char *)ptr);
1976 /* the command had better have set a new reader callback */
1978 /* there are further bytes to read, or we are at eof; arrange for the
1979 * command's reader callback to handle them */
1980 return ev_reader_incomplete(reader);
1981 /* nothing's going on right now */
1984 /* command completed, we can go around and handle the next one */
1988 error(0, "S%x unterminated line", c->tag);
1989 D(("normal reader close"));
1992 D(("close associated writer"));
1993 ev_writer_close(c->w);
1996 remove_connection(c);
2001 static int listen_callback(ev_source *ev,
2003 const struct sockaddr attribute((unused)) *remote,
2004 socklen_t attribute((unused)) rlen,
2006 const struct listener *l = u;
2007 struct conn *c = xmalloc(sizeof *c);
2008 static unsigned tags;
2010 D(("server listen_callback fd %d (%s)", fd, l->name));
2013 c->next = connections;
2016 c->w = ev_writer_new(ev, fd, writer_error, c,
2018 c->r = ev_reader_new(ev, fd, redirect_reader_callback, reader_error, c,
2022 c->reader = reader_callback;
2025 c->line_reader = command;
2027 gcry_randomize(c->nonce, sizeof c->nonce, GCRY_STRONG_RANDOM);
2028 sink_printf(ev_writer_sink(c->w), "231 %d %s %s\n",
2030 config->authorization_algorithm,
2031 hex(c->nonce, sizeof c->nonce));
2035 int server_start(ev_source *ev, int pf,
2036 size_t socklen, const struct sockaddr *sa,
2039 struct listener *l = xmalloc(sizeof *l);
2040 static const int one = 1;
2042 D(("server_init socket %s", name));
2043 fd = xsocket(pf, SOCK_STREAM, 0);
2044 xsetsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &one, sizeof one);
2045 if(bind(fd, sa, socklen) < 0) {
2046 error(errno, "error binding to %s", name);
2054 if(ev_listen(ev, fd, listen_callback, l, "server listener"))
2059 int server_stop(ev_source *ev, int fd) {
2061 return ev_listen_cancel(ev, fd);