2 * This file is part of DisOrder.
3 * Copyright (C) 2004-2012 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];
122 /** @brief Nonzero if an active RTP request exists */
125 /** @brief RTP destination (if @ref rtp_requested is nonzero) */
126 struct sockaddr_storage rtp_destination
;
129 /** @brief Linked list of connections */
130 static struct conn
*connections
;
132 static int reader_callback(ev_source
*ev
,
138 static int c_playlist_set_body(struct conn
*c
,
142 static int fetch_body(struct conn
*c
,
143 body_callback_type body_callback
,
145 static int body_line(struct conn
*c
, char *line
);
146 static int command(struct conn
*c
, char *line
);
148 static const char *noyes
[] = { "no", "yes" };
150 /** @brief Remove a connection from the connection list
152 * This is a good place for cleaning things up when connections are closed for
155 static void remove_connection(struct conn
*c
) {
158 if(c
->rtp_requested
) {
159 rtp_request_cancel(&c
->rtp_destination
);
160 c
->rtp_requested
= 0;
162 for(cc
= &connections
; *cc
&& *cc
!= c
; cc
= &(*cc
)->next
)
168 /** @brief Called when a connection's writer fails or is shut down
170 * If the connection still has a raeder that is cancelled.
172 static int writer_error(ev_source
attribute((unused
)) *ev
,
177 D(("server writer_error S%x %d", c
->tag
, errno_value
));
178 if(errno_value
== 0) {
180 D(("S%x writer completed", c
->tag
));
182 if(errno_value
!= EPIPE
)
183 disorder_error(errno_value
, "S%x write error on socket", c
->tag
);
185 D(("cancel reader"));
186 ev_reader_cancel(c
->r
);
189 D(("done cancel reader"));
193 remove_connection(c
);
197 /** @brief Called when a conncetion's reader fails or is shut down
199 * If connection still has a writer then it is closed.
201 static int reader_error(ev_source
attribute((unused
)) *ev
,
206 D(("server reader_error S%x %d", c
->tag
, errno_value
));
207 disorder_error(errno_value
, "S%x read error on socket", c
->tag
);
209 ev_writer_close(c
->w
);
213 remove_connection(c
);
217 static int c_disable(struct conn
*c
, char **vec
, int nvec
) {
219 disable_playing(c
->who
, c
->ev
);
220 else if(nvec
== 1 && !strcmp(vec
[0], "now"))
221 disable_playing(c
->who
, c
->ev
);
223 sink_writes(ev_writer_sink(c
->w
), "550 invalid argument\n");
224 return 1; /* completed */
226 sink_writes(ev_writer_sink(c
->w
), "250 OK\n");
227 return 1; /* completed */
230 static int c_enable(struct conn
*c
,
231 char attribute((unused
)) **vec
,
232 int attribute((unused
)) nvec
) {
233 enable_playing(c
->who
, c
->ev
);
234 /* Enable implicitly unpauses if there is nothing playing */
235 if(paused
&& !playing
) resume_playing(c
->who
);
236 sink_writes(ev_writer_sink(c
->w
), "250 OK\n");
237 return 1; /* completed */
240 static int c_enabled(struct conn
*c
,
241 char attribute((unused
)) **vec
,
242 int attribute((unused
)) nvec
) {
243 sink_printf(ev_writer_sink(c
->w
), "252 %s\n", noyes
[playing_is_enabled()]);
244 return 1; /* completed */
247 static int c_play(struct conn
*c
, char **vec
,
248 int attribute((unused
)) nvec
) {
250 struct queue_entry
*q
;
252 if(!trackdb_exists(vec
[0])) {
253 sink_writes(ev_writer_sink(c
->w
), "550 track is not in database\n");
256 if(!(track
= trackdb_resolve(vec
[0]))) {
257 sink_writes(ev_writer_sink(c
->w
), "550 cannot resolve track\n");
260 q
= queue_add(track
, c
->who
, WHERE_BEFORE_RANDOM
, NULL
, origin_picked
);
262 sink_printf(ev_writer_sink(c
->w
), "252 %s\n", q
->id
);
263 /* We make sure the track at the head of the queue is prepared, just in case
264 * we added it. We could be more subtle but prepare() will ensure we don't
265 * prepare the same track twice so there's no point. */
266 if(qhead
.next
!= &qhead
)
267 prepare(c
->ev
, qhead
.next
);
268 /* If the queue was empty but we are for some reason paused then
270 if(!playing
) resume_playing(0);
272 return 1; /* completed */
275 static int c_playafter(struct conn
*c
, char **vec
,
276 int attribute((unused
)) nvec
) {
278 struct queue_entry
*q
;
279 const char *afterme
= vec
[0];
281 for(int n
= 1; n
< nvec
; ++n
) {
282 if(!trackdb_exists(vec
[n
])) {
283 sink_writes(ev_writer_sink(c
->w
), "550 track is not in database\n");
286 if(!(track
= trackdb_resolve(vec
[n
]))) {
287 sink_writes(ev_writer_sink(c
->w
), "550 cannot resolve track\n");
290 q
= queue_add(track
, c
->who
, WHERE_AFTER
, afterme
, origin_picked
);
292 sink_printf(ev_writer_sink(c
->w
), "550 No such ID\n");
295 disorder_info("added %s as %s after %s", track
, q
->id
, afterme
);
299 sink_printf(ev_writer_sink(c
->w
), "252 OK\n");
300 /* We make sure the track at the head of the queue is prepared, just in case
301 * we added it. We could be more subtle but prepare() will ensure we don't
302 * prepare the same track twice so there's no point. */
303 if(qhead
.next
!= &qhead
) {
304 prepare(c
->ev
, qhead
.next
);
305 disorder_info("prepared %s", qhead
.next
->id
);
307 /* If the queue was empty but we are for some reason paused then
312 return 1; /* completed */
315 static int c_remove(struct conn
*c
, char **vec
,
316 int attribute((unused
)) nvec
) {
317 struct queue_entry
*q
;
319 if(!(q
= queue_find(vec
[0]))) {
320 sink_writes(ev_writer_sink(c
->w
), "550 no such track on the queue\n");
323 if(!right_removable(c
->rights
, c
->who
, q
)) {
324 disorder_error(0, "%s attempted remove but lacks required rights", c
->who
);
325 sink_writes(ev_writer_sink(c
->w
),
326 "510 Not authorized to remove that track\n");
329 queue_remove(q
, c
->who
);
330 /* De-prepare the track. */
332 /* See about adding a new random track */
333 add_random_track(c
->ev
);
334 /* Prepare whatever the next head track is. */
335 if(qhead
.next
!= &qhead
)
336 prepare(c
->ev
, qhead
.next
);
338 sink_writes(ev_writer_sink(c
->w
), "250 removed\n");
339 return 1; /* completed */
342 static int c_scratch(struct conn
*c
,
346 sink_writes(ev_writer_sink(c
->w
), "250 nothing is playing\n");
347 return 1; /* completed */
349 /* TODO there is a bug here: if we specify an ID but it's not the currently
350 * playing track then you will get 550 if you weren't authorized to scratch
351 * the currently playing track. */
352 if(!right_scratchable(c
->rights
, c
->who
, playing
)) {
353 disorder_error(0, "%s attempted scratch but lacks required rights", c
->who
);
354 sink_writes(ev_writer_sink(c
->w
),
355 "510 Not authorized to scratch that track\n");
358 scratch(c
->who
, nvec
== 1 ? vec
[0] : 0);
359 /* If you scratch an unpaused track then it is automatically unpaused */
361 sink_writes(ev_writer_sink(c
->w
), "250 scratched\n");
362 return 1; /* completed */
365 static int c_pause(struct conn
*c
,
366 char attribute((unused
)) **vec
,
367 int attribute((unused
)) nvec
) {
369 sink_writes(ev_writer_sink(c
->w
), "250 nothing is playing\n");
370 return 1; /* completed */
373 sink_writes(ev_writer_sink(c
->w
), "250 already paused\n");
374 return 1; /* completed */
376 if(pause_playing(c
->who
) < 0)
377 sink_writes(ev_writer_sink(c
->w
), "550 cannot pause this track\n");
379 sink_writes(ev_writer_sink(c
->w
), "250 paused\n");
383 static int c_resume(struct conn
*c
,
384 char attribute((unused
)) **vec
,
385 int attribute((unused
)) nvec
) {
387 sink_writes(ev_writer_sink(c
->w
), "250 not paused\n");
388 return 1; /* completed */
390 resume_playing(c
->who
);
391 sink_writes(ev_writer_sink(c
->w
), "250 paused\n");
395 static int c_shutdown(struct conn
*c
,
396 char attribute((unused
)) **vec
,
397 int attribute((unused
)) nvec
) {
398 disorder_info("S%x shut down by %s", c
->tag
, c
->who
);
399 sink_writes(ev_writer_sink(c
->w
), "250 shutting down\n");
400 ev_writer_flush(c
->w
);
404 static int c_reconfigure(struct conn
*c
,
405 char attribute((unused
)) **vec
,
406 int attribute((unused
)) nvec
) {
407 disorder_info("S%x reconfigure by %s", c
->tag
, c
->who
);
408 if(reconfigure(c
->ev
, 1))
409 sink_writes(ev_writer_sink(c
->w
), "550 error reading new config\n");
411 sink_writes(ev_writer_sink(c
->w
), "250 installed new config\n");
412 return 1; /* completed */
415 static void finished_rescan(void *ru
) {
416 struct conn
*const c
= ru
;
418 sink_writes(ev_writer_sink(c
->w
), "250 rescan completed\n");
419 /* Turn this connection back on */
420 ev_reader_enable(c
->r
);
423 static void start_fresh_rescan(void *ru
) {
424 struct conn
*const c
= ru
;
426 if(trackdb_rescan_underway()) {
427 /* Some other waiter beat us to it. However in this case we're happy to
428 * piggyback; the requirement is that a new rescan be started, not that it
429 * was _our_ rescan. */
431 /* We block until the rescan completes */
432 trackdb_add_rescanned(finished_rescan
, c
);
434 /* We report that the new rescan has started */
435 sink_writes(ev_writer_sink(c
->w
), "250 rescan initiated\n");
436 /* Turn this connection back on */
437 ev_reader_enable(c
->r
);
440 /* We are the first connection to get a callback so we must start a
443 /* We want to block until the new rescan completes */
444 trackdb_rescan(c
->ev
, 1/*check*/, finished_rescan
, c
);
446 /* We can report back immediately */
447 trackdb_rescan(c
->ev
, 1/*check*/, 0, 0);
448 sink_writes(ev_writer_sink(c
->w
), "250 rescan initiated\n");
449 /* Turn this connection back on */
450 ev_reader_enable(c
->r
);
455 static int c_rescan(struct conn
*c
,
458 int flag_wait
= 0, flag_fresh
= 0, n
;
461 for(n
= 0; n
< nvec
; ++n
) {
462 if(!strcmp(vec
[n
], "wait"))
463 flag_wait
= 1; /* wait for rescan to complete */
465 /* Currently disabled because untested (and hard to test). */
466 else if(!strcmp(vec
[n
], "fresh"))
467 flag_fresh
= 1; /* don't piggyback underway rescan */
470 sink_writes(ev_writer_sink(c
->w
), "550 unknown flag\n");
471 return 1; /* completed */
474 /* Report what was requested */
475 disorder_info("S%x rescan by %s (%s %s)", c
->tag
, c
->who
,
476 flag_wait ?
"wait" : "",
477 flag_fresh ?
"fresh" : "");
478 if(trackdb_rescan_underway()) {
480 /* We want a fresh rescan but there is already one underway. Arrange a
481 * callback when it completes and then set off a new one. */
482 c
->rescan_wait
= flag_wait
;
483 trackdb_add_rescanned(start_fresh_rescan
, c
);
487 sink_writes(ev_writer_sink(c
->w
), "250 rescan queued\n");
491 /* There's a rescan underway, and it's acceptable to piggyback on it */
493 /* We want to block until completion. */
494 trackdb_add_rescanned(finished_rescan
, c
);
497 /* We don't want to block. So we just report that things are in
499 sink_writes(ev_writer_sink(c
->w
), "250 rescan already underway\n");
504 /* No rescan is underway. fresh is therefore irrelevant. */
506 /* We want to block until completion */
507 trackdb_rescan(c
->ev
, 1/*check*/, finished_rescan
, c
);
510 /* We don't want to block. */
511 trackdb_rescan(c
->ev
, 1/*check*/, 0, 0);
512 sink_writes(ev_writer_sink(c
->w
), "250 rescan initiated\n");
513 return 1; /* completed */
518 static int c_version(struct conn
*c
,
519 char attribute((unused
)) **vec
,
520 int attribute((unused
)) nvec
) {
521 /* VERSION had better only use the basic character set */
522 sink_printf(ev_writer_sink(c
->w
), "251 %s\n", disorder_short_version_string
);
523 return 1; /* completed */
526 static int c_playing(struct conn
*c
,
527 char attribute((unused
)) **vec
,
528 int attribute((unused
)) nvec
) {
530 queue_fix_sofar(playing
);
531 playing
->expected
= 0;
532 sink_printf(ev_writer_sink(c
->w
), "252 %s\n", queue_marshall(playing
));
534 sink_printf(ev_writer_sink(c
->w
), "259 nothing playing\n");
535 return 1; /* completed */
538 static const char *connection_host(struct conn
*c
) {
541 struct sockaddr_in in
;
542 struct sockaddr_in6 in6
;
548 /* get connection data */
550 if(getpeername(c
->fd
, &u
.sa
, &l
) < 0) {
551 disorder_error(errno
, "S%x error calling getpeername", c
->tag
);
554 if(c
->l
->pf
!= PF_UNIX
) {
555 if((n
= getnameinfo(&u
.sa
, l
,
556 host
, sizeof host
, 0, 0, NI_NUMERICHOST
))) {
557 disorder_error(0, "S%x error calling getnameinfo: %s",
558 c
->tag
, gai_strerror(n
));
561 return xstrdup(host
);
566 static int c_user(struct conn
*c
,
568 int attribute((unused
)) nvec
) {
570 const char *res
, *host
, *password
;
574 sink_writes(ev_writer_sink(c
->w
), "530 already authenticated\n");
577 /* get connection data */
578 if(!(host
= connection_host(c
))) {
579 sink_writes(ev_writer_sink(c
->w
), "530 authentication failure\n");
583 k
= trackdb_getuserinfo(vec
[0]);
584 /* reject nonexistent users */
586 disorder_error(0, "S%x unknown user '%s' from %s", c
->tag
, vec
[0], host
);
587 sink_writes(ev_writer_sink(c
->w
), "530 authentication failed\n");
590 /* reject unconfirmed users */
591 if(kvp_get(k
, "confirmation")) {
592 disorder_error(0, "S%x unconfirmed user '%s' from %s",
593 c
->tag
, vec
[0], host
);
594 sink_writes(ev_writer_sink(c
->w
), "530 authentication failed\n");
597 password
= kvp_get(k
, "password");
598 if(!password
) password
= "";
599 if(parse_rights(kvp_get(k
, "rights"), &rights
, 1)) {
600 disorder_error(0, "error parsing rights for %s", vec
[0]);
601 sink_writes(ev_writer_sink(c
->w
), "530 authentication failed\n");
604 /* check whether the response is right */
605 res
= authhash(c
->nonce
, sizeof c
->nonce
, password
,
606 config
->authorization_algorithm
);
607 if(wideopen
|| c
->l
->privileged
|| (res
&& !strcmp(res
, vec
[1]))) {
610 /* currently we only bother logging remote connections */
611 if(strcmp(host
, "local"))
612 disorder_info("S%x %s connected from %s", c
->tag
, vec
[0], host
);
614 c
->rights
|= RIGHT__LOCAL
;
615 sink_writes(ev_writer_sink(c
->w
), "230 OK\n");
618 /* oops, response was wrong */
619 disorder_info("S%x authentication failure for %s from %s",
620 c
->tag
, vec
[0], host
);
621 sink_writes(ev_writer_sink(c
->w
), "530 authentication failed\n");
625 static int c_recent(struct conn
*c
,
626 char attribute((unused
)) **vec
,
627 int attribute((unused
)) nvec
) {
628 const struct queue_entry
*q
;
630 sink_writes(ev_writer_sink(c
->w
), "253 Tracks follow\n");
631 for(q
= phead
.next
; q
!= &phead
; q
= q
->next
)
632 sink_printf(ev_writer_sink(c
->w
), " %s\n", queue_marshall(q
));
633 sink_writes(ev_writer_sink(c
->w
), ".\n");
634 return 1; /* completed */
637 static int c_queue(struct conn
*c
,
638 char attribute((unused
)) **vec
,
639 int attribute((unused
)) nvec
) {
640 struct queue_entry
*q
;
645 sink_writes(ev_writer_sink(c
->w
), "253 Tracks follow\n");
646 if(playing_is_enabled() && !paused
) {
648 queue_fix_sofar(playing
);
649 if((l
= trackdb_get(playing
->track
, "_length"))
650 && (length
= atol(l
))) {
652 when
+= length
- playing
->sofar
;
655 /* Nothing is playing but playing is enabled, so whatever is
656 * first in the queue can be expected to start immediately. */
659 for(q
= qhead
.next
; q
!= &qhead
; q
= q
->next
) {
660 /* fill in estimated start time */
662 sink_printf(ev_writer_sink(c
->w
), " %s\n", queue_marshall(q
));
663 /* update for next track */
665 if((l
= trackdb_get(q
->track
, "_length"))
666 && (length
= atol(l
)))
672 sink_writes(ev_writer_sink(c
->w
), ".\n");
673 return 1; /* completed */
676 static int output_list(struct conn
*c
, char **vec
) {
678 sink_printf(ev_writer_sink(c
->w
), "%s\n", *vec
++);
679 sink_writes(ev_writer_sink(c
->w
), ".\n");
683 static int files_dirs(struct conn
*c
,
686 enum trackdb_listable what
) {
687 const char *dir
, *re
;
688 char errstr
[RXCERR_LEN
];
694 case 0: dir
= 0; re
= 0; break;
695 case 1: dir
= vec
[0]; re
= 0; break;
696 case 2: dir
= vec
[0]; re
= vec
[1]; break;
699 /* A bit of a bodge to make sure the args don't trample on cache keys */
700 if(dir
&& strchr(dir
, '\n')) {
701 sink_writes(ev_writer_sink(c
->w
), "550 invalid directory name\n");
704 if(re
&& strchr(re
, '\n')) {
705 sink_writes(ev_writer_sink(c
->w
), "550 invalid regexp\n");
708 /* We bother eliminating "" because the web interface is relatively
709 * likely to send it */
711 byte_xasprintf(&key
, "%d\n%s\n%s", (int)what
, dir ? dir
: "", re
);
712 fvec
= (char **)cache_get(&cache_files_type
, key
);
714 /* Got a cache hit, don't store the answer in the cache */
717 rec
= 0; /* quieten compiler */
719 /* Cache miss, we'll do the lookup and key != 0 so we'll store the answer
721 if(!(rec
= regexp_compile(re
, RXF_CASELESS
,
722 errstr
, sizeof(errstr
), &erroffset
))) {
723 sink_printf(ev_writer_sink(c
->w
), "550 Error compiling regexp: %s\n",
727 /* It only counts as a miss if the regexp was valid. */
728 ++cache_files_misses
;
731 /* No regexp, don't bother caching the result */
737 /* No cache hit (either because a miss, or because we did not look) so do
740 fvec
= trackdb_list(dir
, 0, what
, rec
);
742 fvec
= trackdb_list(0, 0, what
, rec
);
745 /* Put the answer in the cache */
746 cache_put(&cache_files_type
, key
, fvec
);
747 sink_writes(ev_writer_sink(c
->w
), "253 Listing follow\n");
748 return output_list(c
, fvec
);
751 static int c_files(struct conn
*c
,
754 return files_dirs(c
, vec
, nvec
, trackdb_files
);
757 static int c_dirs(struct conn
*c
,
760 return files_dirs(c
, vec
, nvec
, trackdb_directories
);
763 static int c_allfiles(struct conn
*c
,
766 return files_dirs(c
, vec
, nvec
, trackdb_directories
|trackdb_files
);
769 static int c_get(struct conn
*c
,
771 int attribute((unused
)) nvec
) {
772 const char *v
, *track
;
774 if(!(track
= trackdb_resolve(vec
[0]))) {
775 sink_writes(ev_writer_sink(c
->w
), "550 cannot resolve track\n");
778 if(vec
[1][0] != '_' && (v
= trackdb_get(track
, vec
[1])))
779 sink_printf(ev_writer_sink(c
->w
), "252 %s\n", quoteutf8(v
));
781 sink_writes(ev_writer_sink(c
->w
), "555 not found\n");
785 static int c_length(struct conn
*c
,
787 int attribute((unused
)) nvec
) {
788 const char *track
, *v
;
790 if(!(track
= trackdb_resolve(vec
[0]))) {
791 sink_writes(ev_writer_sink(c
->w
), "550 cannot resolve track\n");
794 if((v
= trackdb_get(track
, "_length")))
795 sink_printf(ev_writer_sink(c
->w
), "252 %s\n", quoteutf8(v
));
797 sink_writes(ev_writer_sink(c
->w
), "550 not found\n");
801 static int c_set(struct conn
*c
,
803 int attribute((unused
)) nvec
) {
806 if(!(track
= trackdb_resolve(vec
[0]))) {
807 sink_writes(ev_writer_sink(c
->w
), "550 cannot resolve track\n");
810 if(vec
[1][0] != '_' && !trackdb_set(track
, vec
[1], vec
[2]))
811 sink_writes(ev_writer_sink(c
->w
), "250 OK\n");
813 sink_writes(ev_writer_sink(c
->w
), "550 not found\n");
817 static int c_prefs(struct conn
*c
,
819 int attribute((unused
)) nvec
) {
823 if(!(track
= trackdb_resolve(vec
[0]))) {
824 sink_writes(ev_writer_sink(c
->w
), "550 cannot resolve track\n");
827 k
= trackdb_get_all(track
);
828 sink_writes(ev_writer_sink(c
->w
), "253 prefs follow\n");
829 for(; k
; k
= k
->next
)
830 if(k
->name
[0] != '_') /* omit internal values */
831 sink_printf(ev_writer_sink(c
->w
),
832 " %s %s\n", quoteutf8(k
->name
), quoteutf8(k
->value
));
833 sink_writes(ev_writer_sink(c
->w
), ".\n");
837 static int c_exists(struct conn
*c
,
839 int attribute((unused
)) nvec
) {
840 /* trackdb_exists() does its own alias checking */
841 sink_printf(ev_writer_sink(c
->w
), "252 %s\n", noyes
[trackdb_exists(vec
[0])]);
845 static void search_parse_error(const char *msg
, void *u
) {
846 *(const char **)u
= msg
;
849 static int c_search(struct conn
*c
,
851 int attribute((unused
)) nvec
) {
852 char **terms
, **results
;
853 int nterms
, nresults
, n
;
854 const char *e
= "unknown error";
856 /* This is a bit of a bodge. Initially it's there to make the eclient
857 * interface a bit more convenient to add searching to, but it has the more
858 * compelling advantage that if everything uses it, then interpretation of
859 * user-supplied search strings will be the same everywhere. */
860 if(!(terms
= split(vec
[0], &nterms
, SPLIT_QUOTES
, search_parse_error
, &e
))) {
861 sink_printf(ev_writer_sink(c
->w
), "550 %s\n", e
);
863 results
= trackdb_search(terms
, nterms
, &nresults
);
864 sink_printf(ev_writer_sink(c
->w
), "253 %d matches\n", nresults
);
865 for(n
= 0; n
< nresults
; ++n
)
866 sink_printf(ev_writer_sink(c
->w
), "%s\n", results
[n
]);
867 sink_writes(ev_writer_sink(c
->w
), ".\n");
872 static int c_random_enable(struct conn
*c
,
873 char attribute((unused
)) **vec
,
874 int attribute((unused
)) nvec
) {
875 enable_random(c
->who
, c
->ev
);
876 /* Enable implicitly unpauses if there is nothing playing */
877 if(paused
&& !playing
) resume_playing(c
->who
);
878 sink_writes(ev_writer_sink(c
->w
), "250 OK\n");
879 return 1; /* completed */
882 static int c_random_disable(struct conn
*c
,
883 char attribute((unused
)) **vec
,
884 int attribute((unused
)) nvec
) {
885 disable_random(c
->who
, c
->ev
);
886 sink_writes(ev_writer_sink(c
->w
), "250 OK\n");
887 return 1; /* completed */
890 static int c_random_enabled(struct conn
*c
,
891 char attribute((unused
)) **vec
,
892 int attribute((unused
)) nvec
) {
893 sink_printf(ev_writer_sink(c
->w
), "252 %s\n", noyes
[random_is_enabled()]);
894 return 1; /* completed */
897 static void got_stats(char *stats
, void *u
) {
898 struct conn
*const c
= u
;
900 sink_printf(ev_writer_sink(c
->w
), "253 stats\n%s\n.\n", stats
);
901 /* Now we can start processing commands again */
902 ev_reader_enable(c
->r
);
905 static int c_stats(struct conn
*c
,
906 char attribute((unused
)) **vec
,
907 int attribute((unused
)) nvec
) {
908 trackdb_stats_subprocess(c
->ev
, got_stats
, c
);
909 return 0; /* not yet complete */
912 static int c_volume(struct conn
*c
,
924 l
= r
= atoi(vec
[0]);
935 rights
= set ? RIGHT_VOLUME
: RIGHT_READ
;
936 if(!(c
->rights
& rights
)) {
937 disorder_error(0, "%s attempted to set volume but lacks required rights",
939 sink_writes(ev_writer_sink(c
->w
), "510 Prohibited\n");
942 if(!api
|| !api
->set_volume
) {
943 sink_writes(ev_writer_sink(c
->w
), "550 error accessing mixer\n");
946 (set ? api
->set_volume
: api
->get_volume
)(&l
, &r
);
947 sink_printf(ev_writer_sink(c
->w
), "252 %d %d\n", l
, r
);
948 if(l
!= volume_left
|| r
!= volume_right
) {
951 snprintf(lb
, sizeof lb
, "%d", l
);
952 snprintf(rb
, sizeof rb
, "%d", r
);
953 eventlog("volume", lb
, rb
, (char *)0);
958 /** @brief Called when data arrives on a log connection
960 * We just discard all such data. The client may occasionally send data as a
963 static int logging_reader_callback(ev_source
attribute((unused
)) *ev
,
965 void attribute((unused
)) *ptr
,
967 int attribute((unused
)) eof
,
968 void attribute((unused
)) *u
) {
971 ev_reader_consume(reader
, bytes
);
973 /* Oops, that's all for now */
974 D(("logging reader eof"));
977 ev_writer_close(c
->w
);
981 remove_connection(c
);
986 static void logclient(const char *msg
, void *user
) {
987 struct conn
*c
= user
;
990 /* This connection has gone up in smoke for some reason */
991 eventlog_remove(c
->lo
);
995 /* user_* messages are restricted */
996 if(!strncmp(msg
, "user_", 5)) {
997 /* They are only sent to admin users */
998 if(!(c
->rights
& RIGHT_ADMIN
))
1000 /* They are not sent over TCP connections unless remote user-management is
1002 if(!config
->remote_userman
&& !(c
->rights
& RIGHT__LOCAL
))
1005 sink_printf(ev_writer_sink(c
->w
), "%"PRIxMAX
" %s\n",
1006 (uintmax_t)xtime(0), msg
);
1009 static int c_log(struct conn
*c
,
1010 char attribute((unused
)) **vec
,
1011 int attribute((unused
)) nvec
) {
1014 sink_writes(ev_writer_sink(c
->w
), "254 OK\n");
1015 /* pump out initial state */
1017 sink_printf(ev_writer_sink(c
->w
), "%"PRIxMAX
" state %s\n",
1019 playing_is_enabled() ?
"enable_play" : "disable_play");
1020 sink_printf(ev_writer_sink(c
->w
), "%"PRIxMAX
" state %s\n",
1022 random_is_enabled() ?
"enable_random" : "disable_random");
1023 sink_printf(ev_writer_sink(c
->w
), "%"PRIxMAX
" state %s\n",
1025 paused ?
"pause" : "resume");
1027 sink_printf(ev_writer_sink(c
->w
), "%"PRIxMAX
" state playing\n",
1029 /* Initial volume */
1030 sink_printf(ev_writer_sink(c
->w
), "%"PRIxMAX
" volume %d %d\n",
1031 (uintmax_t)now
, volume_left
, volume_right
);
1032 c
->lo
= xmalloc(sizeof *c
->lo
);
1033 c
->lo
->fn
= logclient
;
1035 eventlog_add(c
->lo
);
1036 c
->reader
= logging_reader_callback
;
1040 /** @brief Test whether a move is allowed
1041 * @param c Connection
1042 * @param qs List of IDs on queue
1043 * @param nqs Number of IDs
1044 * @return 0 if move is prohibited, non-0 if it is allowed
1046 static int has_move_rights(struct conn
*c
, struct queue_entry
**qs
, int nqs
) {
1047 for(; nqs
> 0; ++qs
, --nqs
) {
1048 struct queue_entry
*const q
= *qs
;
1050 if(!right_movable(c
->rights
, c
->who
, q
))
1056 static int c_move(struct conn
*c
,
1058 int attribute((unused
)) nvec
) {
1059 struct queue_entry
*q
;
1062 if(!(q
= queue_find(vec
[0]))) {
1063 sink_writes(ev_writer_sink(c
->w
), "550 no such track on the queue\n");
1066 if(!has_move_rights(c
, &q
, 1)) {
1067 disorder_error(0, "%s attempted move but lacks required rights", c
->who
);
1068 sink_writes(ev_writer_sink(c
->w
),
1069 "510 Not authorized to move that track\n");
1072 n
= queue_move(q
, atoi(vec
[1]), c
->who
);
1073 sink_printf(ev_writer_sink(c
->w
), "252 %d\n", n
);
1074 /* If we've moved to the head of the queue then prepare the track. */
1080 static int c_moveafter(struct conn
*c
,
1082 int attribute((unused
)) nvec
) {
1083 struct queue_entry
*q
, **qs
;
1087 if(!(q
= queue_find(vec
[0]))) {
1088 sink_writes(ev_writer_sink(c
->w
), "550 no such track on the queue\n");
1095 qs
= xcalloc(nvec
, sizeof *qs
);
1096 for(n
= 0; n
< nvec
; ++n
)
1097 if(!(qs
[n
] = queue_find(vec
[n
]))) {
1098 sink_writes(ev_writer_sink(c
->w
), "550 no such track on the queue\n");
1101 if(!has_move_rights(c
, qs
, nvec
)) {
1102 disorder_error(0, "%s attempted moveafter but lacks required rights",
1104 sink_writes(ev_writer_sink(c
->w
),
1105 "510 Not authorized to move those tracks\n");
1108 queue_moveafter(q
, nvec
, qs
, c
->who
);
1109 sink_printf(ev_writer_sink(c
->w
), "250 Moved tracks\n");
1110 /* If we've moved to the head of the queue then prepare the track. */
1116 static int c_part(struct conn
*c
,
1118 int attribute((unused
)) nvec
) {
1121 if(!(track
= trackdb_resolve(vec
[0]))) {
1122 sink_writes(ev_writer_sink(c
->w
), "550 cannot resolve track\n");
1125 sink_printf(ev_writer_sink(c
->w
), "252 %s\n",
1126 quoteutf8(trackdb_getpart(track
, vec
[1], vec
[2])));
1130 static int c_resolve(struct conn
*c
,
1132 int attribute((unused
)) nvec
) {
1135 if(!(track
= trackdb_resolve(vec
[0]))) {
1136 sink_writes(ev_writer_sink(c
->w
), "550 cannot resolve track\n");
1139 sink_printf(ev_writer_sink(c
->w
), "252 %s\n", quoteutf8(track
));
1143 static int list_response(struct conn
*c
,
1146 sink_printf(ev_writer_sink(c
->w
), "253 %s\n", reply
);
1148 sink_printf(ev_writer_sink(c
->w
), "%s%s\n",
1149 **list
== '.' ?
"." : "", *list
);
1152 sink_writes(ev_writer_sink(c
->w
), ".\n");
1153 return 1; /* completed */
1156 static int c_tags(struct conn
*c
,
1157 char attribute((unused
)) **vec
,
1158 int attribute((unused
)) nvec
) {
1159 return list_response(c
, "Tag list follows", trackdb_alltags());
1162 static int c_set_global(struct conn
*c
,
1164 int attribute((unused
)) nvec
) {
1165 if(vec
[0][0] == '_') {
1166 sink_writes(ev_writer_sink(c
->w
), "550 cannot set internal global preferences\n");
1169 /* We special-case the 'magic' preferences here. */
1170 if(!strcmp(vec
[0], "playing")) {
1171 (flag_enabled(vec
[1]) ? enable_playing
: disable_playing
)(c
->who
, c
->ev
);
1172 sink_printf(ev_writer_sink(c
->w
), "250 OK\n");
1173 } else if(!strcmp(vec
[0], "random-play")) {
1174 (flag_enabled(vec
[1]) ? enable_random
: disable_random
)(c
->who
, c
->ev
);
1175 sink_printf(ev_writer_sink(c
->w
), "250 OK\n");
1177 if(!trackdb_set_global(vec
[0], vec
[1], c
->who
))
1178 sink_printf(ev_writer_sink(c
->w
), "250 OK\n");
1180 sink_writes(ev_writer_sink(c
->w
), "550 not found\n");
1185 static int c_get_global(struct conn
*c
,
1187 int attribute((unused
)) nvec
) {
1188 const char *s
= trackdb_get_global(vec
[0]);
1191 sink_printf(ev_writer_sink(c
->w
), "252 %s\n", quoteutf8(s
));
1193 sink_writes(ev_writer_sink(c
->w
), "555 not found\n");
1197 static int c_nop(struct conn
*c
,
1198 char attribute((unused
)) **vec
,
1199 int attribute((unused
)) nvec
) {
1200 sink_printf(ev_writer_sink(c
->w
), "250 Quack\n");
1204 static int c_new(struct conn
*c
,
1214 if(max
<= 0 || max
> config
->new_max
)
1215 max
= config
->new_max
;
1216 tracks
= trackdb_new(0, max
);
1217 sink_printf(ev_writer_sink(c
->w
), "253 New track list follows\n");
1219 sink_printf(ev_writer_sink(c
->w
), "%s%s\n",
1220 **tracks
== '.' ?
"." : "", *tracks
);
1223 sink_writes(ev_writer_sink(c
->w
), ".\n");
1224 return 1; /* completed */
1228 static int c_rtp_address(struct conn
*c
,
1229 char attribute((unused
)) **vec
,
1230 int attribute((unused
)) nvec
) {
1231 if(api
== &uaudio_rtp
) {
1234 if(!strcmp(config
->rtp_mode
, "request"))
1235 sink_printf(ev_writer_sink(c
->w
), "252 - -\n");
1237 netaddress_format(&config
->broadcast
, NULL
, &addr
);
1238 sink_printf(ev_writer_sink(c
->w
), "252 %s %s\n",
1240 quoteutf8(addr
[2]));
1243 sink_writes(ev_writer_sink(c
->w
), "550 No RTP\n");
1247 static int c_rtp_cancel(struct conn
*c
,
1248 char attribute((unused
)) **vec
,
1249 int attribute((unused
)) nvec
) {
1250 if(!c
->rtp_requested
) {
1251 sink_writes(ev_writer_sink(c
->w
), "550 No active RTP stream\n");
1254 rtp_request_cancel(&c
->rtp_destination
);
1255 c
->rtp_requested
= 0;
1256 sink_writes(ev_writer_sink(c
->w
), "250 Cancelled RTP stream\n");
1260 static int c_rtp_request(struct conn
*c
,
1262 int attribute((unused
)) nvec
) {
1263 static const struct addrinfo hints
= {
1264 .ai_family
= AF_UNSPEC
,
1265 .ai_socktype
= SOCK_DGRAM
,
1266 .ai_protocol
= IPPROTO_UDP
,
1267 .ai_flags
= AI_NUMERICHOST
|AI_NUMERICSERV
,
1269 struct addrinfo
*res
;
1270 int rc
= getaddrinfo(vec
[0], vec
[1], &hints
, &res
);
1272 disorder_error(0, "%s port %s: %s",
1273 vec
[0], vec
[1], gai_strerror(rc
));
1274 sink_writes(ev_writer_sink(c
->w
), "550 Invalid address\n");
1277 disorder_info("%s requested RTP stream to %s %s", c
->who
, vec
[0], vec
[1]);
1278 /* TODO might be useful to tighten this up to restrict clients to targetting
1279 * themselves only */
1280 if(c
->rtp_requested
) {
1281 rtp_request_cancel(&c
->rtp_destination
);
1282 c
->rtp_requested
= 0;
1284 memcpy(&c
->rtp_destination
, res
->ai_addr
, res
->ai_addrlen
);
1286 rtp_request(&c
->rtp_destination
);
1287 c
->rtp_requested
= 1;
1288 sink_writes(ev_writer_sink(c
->w
), "250 Initiated RTP stream\n");
1289 // TODO teardown on connection close
1293 static int c_cookie(struct conn
*c
,
1295 int attribute((unused
)) nvec
) {
1300 /* Can't log in twice on the same connection */
1302 sink_writes(ev_writer_sink(c
->w
), "530 already authenticated\n");
1305 /* Get some kind of peer identifcation */
1306 if(!(host
= connection_host(c
))) {
1307 sink_writes(ev_writer_sink(c
->w
), "530 authentication failure\n");
1310 /* Check the cookie */
1311 user
= verify_cookie(vec
[0], &rights
);
1313 sink_writes(ev_writer_sink(c
->w
), "530 authentication failure\n");
1320 if(strcmp(host
, "local"))
1321 disorder_info("S%x %s connected with cookie from %s", c
->tag
, user
, host
);
1323 c
->rights
|= RIGHT__LOCAL
;
1324 /* Response contains username so client knows who they are acting as */
1325 sink_printf(ev_writer_sink(c
->w
), "232 %s\n", quoteutf8(user
));
1329 static int c_make_cookie(struct conn
*c
,
1330 char attribute((unused
)) **vec
,
1331 int attribute((unused
)) nvec
) {
1332 const char *cookie
= make_cookie(c
->who
);
1335 sink_printf(ev_writer_sink(c
->w
), "252 %s\n", quoteutf8(cookie
));
1337 sink_writes(ev_writer_sink(c
->w
), "550 Cannot create cookie\n");
1341 static int c_revoke(struct conn
*c
,
1342 char attribute((unused
)) **vec
,
1343 int attribute((unused
)) nvec
) {
1345 revoke_cookie(c
->cookie
);
1346 sink_writes(ev_writer_sink(c
->w
), "250 OK\n");
1348 sink_writes(ev_writer_sink(c
->w
), "510 Did not log in with cookie\n");
1352 static int c_adduser(struct conn
*c
,
1357 if(!config
->remote_userman
&& !(c
->rights
& RIGHT__LOCAL
)) {
1358 disorder_error(0, "S%x: remote adduser", c
->tag
);
1359 sink_writes(ev_writer_sink(c
->w
), "510 Remote user management is disabled\n");
1364 if(parse_rights(vec
[2], 0, 1)) {
1365 sink_writes(ev_writer_sink(c
->w
), "550 Invalid rights list\n");
1369 rights
= config
->default_rights
;
1370 if(trackdb_adduser(vec
[0], vec
[1], rights
,
1371 0/*email*/, 0/*confirmation*/))
1372 sink_writes(ev_writer_sink(c
->w
), "550 Cannot create user\n");
1374 sink_writes(ev_writer_sink(c
->w
), "250 User created\n");
1378 static int c_deluser(struct conn
*c
,
1380 int attribute((unused
)) nvec
) {
1383 if(!config
->remote_userman
&& !(c
->rights
& RIGHT__LOCAL
)) {
1384 disorder_error(0, "S%x: remote deluser", c
->tag
);
1385 sink_writes(ev_writer_sink(c
->w
), "510 Remote user management is disabled\n");
1388 if(trackdb_deluser(vec
[0])) {
1389 sink_writes(ev_writer_sink(c
->w
), "550 Cannot delete user\n");
1392 /* Zap connections belonging to deleted user */
1393 for(d
= connections
; d
; d
= d
->next
)
1394 if(!strcmp(d
->who
, vec
[0]))
1396 sink_writes(ev_writer_sink(c
->w
), "250 User deleted\n");
1400 static int c_edituser(struct conn
*c
,
1402 int attribute((unused
)) nvec
) {
1405 if(!config
->remote_userman
&& !(c
->rights
& RIGHT__LOCAL
)) {
1406 disorder_error(0, "S%x: remote edituser", c
->tag
);
1407 sink_writes(ev_writer_sink(c
->w
), "510 Remote user management is disabled\n");
1410 /* RIGHT_ADMIN can do anything; otherwise you can only set your own email
1411 * address and password. */
1412 if((c
->rights
& RIGHT_ADMIN
)
1413 || (!strcmp(c
->who
, vec
[0])
1414 && (!strcmp(vec
[1], "email")
1415 || !strcmp(vec
[1], "password")))) {
1416 if(trackdb_edituserinfo(vec
[0], vec
[1], vec
[2])) {
1417 sink_writes(ev_writer_sink(c
->w
), "550 Failed to change setting\n");
1420 if(!strcmp(vec
[1], "password")) {
1421 /* Zap all connections for this user after a password change */
1422 for(d
= connections
; d
; d
= d
->next
)
1423 if(!strcmp(d
->who
, vec
[0]))
1425 } else if(!strcmp(vec
[1], "rights")) {
1426 /* Update rights for this user */
1429 if(!parse_rights(vec
[2], &r
, 1)) {
1430 const char *new_rights
= rights_string(r
);
1431 for(d
= connections
; d
; d
= d
->next
) {
1432 if(!strcmp(d
->who
, vec
[0])) {
1435 /* Notify any log connections */
1437 sink_printf(ev_writer_sink(d
->w
),
1438 "%"PRIxMAX
" rights_changed %s\n",
1439 (uintmax_t)xtime(0),
1440 quoteutf8(new_rights
));
1445 sink_writes(ev_writer_sink(c
->w
), "250 OK\n");
1447 disorder_error(0, "%s attempted edituser but lacks required rights",
1449 sink_writes(ev_writer_sink(c
->w
), "510 Restricted to administrators\n");
1454 static int c_userinfo(struct conn
*c
,
1455 char attribute((unused
)) **vec
,
1456 int attribute((unused
)) nvec
) {
1460 /* We allow remote querying of rights so that clients can figure out what
1461 * they're allowed to do */
1462 if(!config
->remote_userman
1463 && !(c
->rights
& RIGHT__LOCAL
)
1464 && strcmp(vec
[1], "rights")) {
1465 disorder_error(0, "S%x: remote userinfo %s %s", c
->tag
, vec
[0], vec
[1]);
1466 sink_writes(ev_writer_sink(c
->w
), "510 Remote user management is disabled\n");
1469 /* RIGHT_ADMIN allows anything; otherwise you can only get your own email
1470 * address and rights list. */
1471 if((c
->rights
& RIGHT_ADMIN
)
1472 || (!strcmp(c
->who
, vec
[0])
1473 && (!strcmp(vec
[1], "email")
1474 || !strcmp(vec
[1], "rights")))) {
1475 if((k
= trackdb_getuserinfo(vec
[0])))
1476 if((value
= kvp_get(k
, vec
[1])))
1477 sink_printf(ev_writer_sink(c
->w
), "252 %s\n", quoteutf8(value
));
1479 sink_writes(ev_writer_sink(c
->w
), "555 Not set\n");
1481 sink_writes(ev_writer_sink(c
->w
), "550 No such user\n");
1483 disorder_error(0, "%s attempted userinfo but lacks required rights",
1485 sink_writes(ev_writer_sink(c
->w
), "510 Restricted to administrators\n");
1490 static int c_users(struct conn
*c
,
1491 char attribute((unused
)) **vec
,
1492 int attribute((unused
)) nvec
) {
1493 return list_response(c
, "User list follows", trackdb_listusers());
1496 static int c_register(struct conn
*c
,
1498 int attribute((unused
)) nvec
) {
1500 uint32_t nonce
[CONFIRM_SIZE
];
1501 char nonce_str
[(32 * CONFIRM_SIZE
) / 5 + 1];
1503 /* The confirmation string is username/base62(nonce). The confirmation
1504 * process will pick the username back out to identify them but the _whole_
1505 * string is used as the confirmation string. Base 62 means we used only
1506 * letters and digits, minimizing the chance of the URL being mispasted. */
1507 gcry_randomize(nonce
, sizeof nonce
, GCRY_STRONG_RANDOM
);
1508 if(basen(nonce
, CONFIRM_SIZE
, nonce_str
, sizeof nonce_str
, 62)) {
1509 disorder_error(0, "buffer too small encoding confirmation string");
1510 sink_writes(ev_writer_sink(c
->w
), "550 Cannot create user\n");
1512 byte_xasprintf(&cs
, "%s/%s", vec
[0], nonce_str
);
1513 if(trackdb_adduser(vec
[0], vec
[1], config
->default_rights
, vec
[2], cs
))
1514 sink_writes(ev_writer_sink(c
->w
), "550 Cannot create user\n");
1516 sink_printf(ev_writer_sink(c
->w
), "252 %s\n", quoteutf8(cs
));
1520 static int c_confirm(struct conn
*c
,
1522 int attribute((unused
)) nvec
) {
1527 /* Get some kind of peer identifcation */
1528 if(!(host
= connection_host(c
))) {
1529 sink_writes(ev_writer_sink(c
->w
), "530 Authentication failure\n");
1532 /* Picking the LAST / means we don't (here) rule out slashes in usernames. */
1533 if(!(sep
= strrchr(vec
[0], '/'))) {
1534 sink_writes(ev_writer_sink(c
->w
), "550 Malformed confirmation string\n");
1537 user
= xstrndup(vec
[0], sep
- vec
[0]);
1538 if(trackdb_confirm(user
, vec
[0], &rights
))
1539 sink_writes(ev_writer_sink(c
->w
), "510 Incorrect confirmation string\n");
1544 if(strcmp(host
, "local"))
1545 disorder_info("S%x %s confirmed from %s", c
->tag
, user
, host
);
1547 c
->rights
|= RIGHT__LOCAL
;
1548 /* Response contains username so client knows who they are acting as */
1549 sink_printf(ev_writer_sink(c
->w
), "232 %s\n", quoteutf8(user
));
1554 static int sent_reminder(ev_source
attribute((unused
)) *ev
,
1555 pid_t
attribute((unused
)) pid
,
1557 const struct rusage
attribute((unused
)) *rusage
,
1559 struct conn
*const c
= u
;
1561 /* Tell the client what went down */
1563 sink_writes(ev_writer_sink(c
->w
), "250 OK\n");
1565 disorder_error(0, "reminder subprocess %s", wstat(status
));
1566 sink_writes(ev_writer_sink(c
->w
), "550 Cannot send a reminder email\n");
1568 /* Re-enable this connection */
1569 ev_reader_enable(c
->r
);
1573 static int c_reminder(struct conn
*c
,
1575 int attribute((unused
)) nvec
) {
1577 const char *password
, *email
, *text
, *encoding
, *charset
, *content_type
;
1582 static hash
*last_reminder
;
1584 if(!config
->mail_sender
) {
1585 disorder_error(0, "cannot send password reminders because mail_sender not set");
1586 sink_writes(ev_writer_sink(c
->w
), "550 Cannot send a reminder email\n");
1589 if(!(k
= trackdb_getuserinfo(vec
[0]))) {
1590 disorder_error(0, "reminder for user '%s' who does not exist", vec
[0]);
1591 sink_writes(ev_writer_sink(c
->w
), "550 Cannot send a reminder email\n");
1594 if(!(email
= kvp_get(k
, "email"))
1595 || !email_valid(email
)) {
1596 disorder_error(0, "user '%s' has no valid email address", vec
[0]);
1597 sink_writes(ev_writer_sink(c
->w
), "550 Cannot send a reminder email\n");
1600 if(!(password
= kvp_get(k
, "password"))
1602 disorder_error(0, "user '%s' has no password", vec
[0]);
1603 sink_writes(ev_writer_sink(c
->w
), "550 Cannot send a reminder email\n");
1606 /* Rate-limit reminders. This hash is bounded in size by the number of
1607 * users. If this is actually a problem for anyone then we can periodically
1610 last_reminder
= hash_new(sizeof (time_t));
1611 last
= hash_find(last_reminder
, vec
[0]);
1613 if(last
&& now
< *last
+ config
->reminder_interval
) {
1614 disorder_error(0, "sent a password reminder to '%s' too recently", vec
[0]);
1615 sink_writes(ev_writer_sink(c
->w
), "550 Cannot send a reminder email\n");
1618 /* Send the reminder */
1619 /* TODO this should be templatized and to some extent merged with
1620 * the code in act_register() */
1621 byte_xasprintf((char **)&text
,
1622 "Someone requested that you be sent a reminder of your DisOrder password.\n"
1623 "Your password is:\n"
1626 if(!(text
= mime_encode_text(text
, &charset
, &encoding
)))
1627 disorder_fatal(0, "cannot encode email");
1628 byte_xasprintf((char **)&content_type
, "text/plain;charset=%s",
1629 quote822(charset
, 0));
1630 pid
= sendmail_subprocess("", config
->mail_sender
, email
,
1631 "DisOrder password reminder",
1632 encoding
, content_type
, text
);
1634 sink_writes(ev_writer_sink(c
->w
), "550 Cannot send a reminder email\n");
1637 hash_add(last_reminder
, vec
[0], &now
, HASH_INSERT_OR_REPLACE
);
1638 disorder_info("sending a passsword reminder to user '%s'", vec
[0]);
1639 /* We can only continue when the subprocess finishes */
1640 ev_child(c
->ev
, pid
, 0, sent_reminder
, c
);
1644 static int c_schedule_list(struct conn
*c
,
1645 char attribute((unused
)) **vec
,
1646 int attribute((unused
)) nvec
) {
1647 char **ids
= schedule_list(0);
1648 sink_writes(ev_writer_sink(c
->w
), "253 ID list follows\n");
1650 sink_printf(ev_writer_sink(c
->w
), "%s\n", *ids
++);
1651 sink_writes(ev_writer_sink(c
->w
), ".\n");
1652 return 1; /* completed */
1655 static int c_schedule_get(struct conn
*c
,
1657 int attribute((unused
)) nvec
) {
1658 struct kvp
*actiondata
= schedule_get(vec
[0]), *k
;
1661 sink_writes(ev_writer_sink(c
->w
), "555 No such event\n");
1662 return 1; /* completed */
1664 /* Scheduled events are public information. Anyone with RIGHT_READ can see
1666 sink_writes(ev_writer_sink(c
->w
), "253 Event information follows\n");
1667 for(k
= actiondata
; k
; k
= k
->next
)
1668 sink_printf(ev_writer_sink(c
->w
), " %s %s\n",
1669 quoteutf8(k
->name
), quoteutf8(k
->value
));
1670 sink_writes(ev_writer_sink(c
->w
), ".\n");
1671 return 1; /* completed */
1674 static int c_schedule_del(struct conn
*c
,
1676 int attribute((unused
)) nvec
) {
1677 struct kvp
*actiondata
= schedule_get(vec
[0]);
1680 sink_writes(ev_writer_sink(c
->w
), "555 No such event\n");
1681 return 1; /* completed */
1683 /* If you have admin rights you can delete anything. If you don't then you
1684 * can only delete your own scheduled events. */
1685 if(!(c
->rights
& RIGHT_ADMIN
)) {
1686 const char *who
= kvp_get(actiondata
, "who");
1688 if(!who
|| !c
->who
|| strcmp(who
, c
->who
)) {
1689 sink_writes(ev_writer_sink(c
->w
), "510 Not authorized\n");
1690 return 1; /* completed */
1693 if(schedule_del(vec
[0]))
1694 sink_writes(ev_writer_sink(c
->w
), "550 Could not delete scheduled event\n");
1696 sink_writes(ev_writer_sink(c
->w
), "250 Deleted\n");
1697 return 1; /* completed */
1700 static int c_schedule_add(struct conn
*c
,
1703 struct kvp
*actiondata
= 0;
1706 /* Standard fields */
1707 kvp_set(&actiondata
, "who", c
->who
);
1708 kvp_set(&actiondata
, "when", vec
[0]);
1709 kvp_set(&actiondata
, "priority", vec
[1]);
1710 kvp_set(&actiondata
, "action", vec
[2]);
1711 /* Action-dependent fields */
1712 if(!strcmp(vec
[2], "play")) {
1714 sink_writes(ev_writer_sink(c
->w
), "550 Wrong number of arguments\n");
1717 if(!trackdb_exists(vec
[3])) {
1718 sink_writes(ev_writer_sink(c
->w
), "550 Track is not in database\n");
1721 kvp_set(&actiondata
, "track", vec
[3]);
1722 } else if(!strcmp(vec
[2], "set-global")) {
1723 if(nvec
< 4 || nvec
> 5) {
1724 sink_writes(ev_writer_sink(c
->w
), "550 Wrong number of arguments\n");
1727 kvp_set(&actiondata
, "key", vec
[3]);
1729 kvp_set(&actiondata
, "value", vec
[4]);
1731 sink_writes(ev_writer_sink(c
->w
), "550 Unknown action\n");
1734 /* schedule_add() checks user rights */
1735 id
= schedule_add(c
->ev
, actiondata
);
1737 sink_writes(ev_writer_sink(c
->w
), "550 Cannot add scheduled event\n");
1739 sink_printf(ev_writer_sink(c
->w
), "252 %s\n", id
);
1743 static int c_adopt(struct conn
*c
,
1745 int attribute((unused
)) nvec
) {
1746 struct queue_entry
*q
;
1749 sink_writes(ev_writer_sink(c
->w
), "550 no identity\n");
1752 if(!(q
= queue_find(vec
[0]))) {
1753 sink_writes(ev_writer_sink(c
->w
), "550 no such track on the queue\n");
1756 if(q
->origin
!= origin_random
) {
1757 sink_writes(ev_writer_sink(c
->w
), "550 not a random track\n");
1760 q
->origin
= origin_adopted
;
1761 q
->submitter
= xstrdup(c
->who
);
1762 eventlog("adopted", q
->id
, q
->submitter
, (char *)0);
1764 sink_writes(ev_writer_sink(c
->w
), "250 OK\n");
1768 static int playlist_response(struct conn
*c
,
1772 assert(!"cannot cope with success");
1774 sink_writes(ev_writer_sink(c
->w
), "510 Access denied\n");
1777 sink_writes(ev_writer_sink(c
->w
), "550 Invalid playlist name\n");
1780 sink_writes(ev_writer_sink(c
->w
), "555 No such playlist\n");
1783 sink_writes(ev_writer_sink(c
->w
), "550 Error accessing playlist\n");
1789 static int c_playlist_get(struct conn
*c
,
1791 int attribute((unused
)) nvec
) {
1795 if(!(err
= trackdb_playlist_get(vec
[0], c
->who
, &tracks
, 0, 0)))
1796 return list_response(c
, "Playlist contents follows", tracks
);
1798 return playlist_response(c
, err
);
1801 static int c_playlist_set(struct conn
*c
,
1803 int attribute((unused
)) nvec
) {
1804 return fetch_body(c
, c_playlist_set_body
, vec
[0]);
1807 static int c_playlist_set_body(struct conn
*c
,
1811 const char *playlist
= u
;
1814 if(!c
->locked_playlist
1815 || strcmp(playlist
, c
->locked_playlist
)) {
1816 sink_writes(ev_writer_sink(c
->w
), "550 Playlist is not locked\n");
1819 if(!(err
= trackdb_playlist_set(playlist
, c
->who
,
1821 sink_printf(ev_writer_sink(c
->w
), "250 OK\n");
1824 return playlist_response(c
, err
);
1827 static int c_playlist_get_share(struct conn
*c
,
1829 int attribute((unused
)) nvec
) {
1833 if(!(err
= trackdb_playlist_get(vec
[0], c
->who
, 0, 0, &share
))) {
1834 sink_printf(ev_writer_sink(c
->w
), "252 %s\n", quoteutf8(share
));
1837 return playlist_response(c
, err
);
1840 static int c_playlist_set_share(struct conn
*c
,
1842 int attribute((unused
)) nvec
) {
1845 if(!(err
= trackdb_playlist_set(vec
[0], c
->who
, 0, 0, vec
[1]))) {
1846 sink_printf(ev_writer_sink(c
->w
), "250 OK\n");
1849 return playlist_response(c
, err
);
1852 static int c_playlists(struct conn
*c
,
1853 char attribute((unused
)) **vec
,
1854 int attribute((unused
)) nvec
) {
1857 trackdb_playlist_list(c
->who
, &p
, 0);
1858 return list_response(c
, "List of playlists follows", p
);
1861 static int c_playlist_delete(struct conn
*c
,
1863 int attribute((unused
)) nvec
) {
1866 if(!(err
= trackdb_playlist_delete(vec
[0], c
->who
))) {
1867 sink_writes(ev_writer_sink(c
->w
), "250 OK\n");
1870 return playlist_response(c
, err
);
1873 static int c_playlist_lock(struct conn
*c
,
1875 int attribute((unused
)) nvec
) {
1879 /* Check we're allowed to modify this playlist */
1880 if((err
= trackdb_playlist_set(vec
[0], c
->who
, 0, 0, 0)))
1881 return playlist_response(c
, err
);
1882 /* If we hold a lock don't allow a new one */
1883 if(c
->locked_playlist
) {
1884 sink_writes(ev_writer_sink(c
->w
), "550 Already holding a lock\n");
1887 /* See if some other connection locks the same playlist */
1888 for(cc
= connections
; cc
; cc
= cc
->next
)
1889 if(cc
->locked_playlist
&& !strcmp(cc
->locked_playlist
, vec
[0]))
1892 /* TODO: implement config->playlist_lock_timeout */
1893 sink_writes(ev_writer_sink(c
->w
), "550 Already locked\n");
1896 c
->locked_playlist
= xstrdup(vec
[0]);
1897 time(&c
->locked_when
);
1898 sink_writes(ev_writer_sink(c
->w
), "250 Acquired lock\n");
1902 static int c_playlist_unlock(struct conn
*c
,
1903 char attribute((unused
)) **vec
,
1904 int attribute((unused
)) nvec
) {
1905 if(!c
->locked_playlist
) {
1906 sink_writes(ev_writer_sink(c
->w
), "550 Not holding a lock\n");
1909 c
->locked_playlist
= 0;
1910 sink_writes(ev_writer_sink(c
->w
), "250 Released lock\n");
1914 /** @brief Server's definition of a command */
1915 static const struct server_command
{
1916 /** @brief Command name */
1919 /** @brief Minimum number of arguments */
1922 /** @brief Maximum number of arguments */
1925 /** @brief Function to process command */
1926 int (*fn
)(struct conn
*, char **, int);
1928 /** @brief Rights required to execute command
1930 * 0 means that the command can be issued without logging in. If multiple
1931 * bits are listed here any of those rights will do.
1935 { "adduser", 2, 3, c_adduser
, RIGHT_ADMIN
},
1936 { "adopt", 1, 1, c_adopt
, RIGHT_PLAY
},
1937 { "allfiles", 0, 2, c_allfiles
, RIGHT_READ
},
1938 { "confirm", 1, 1, c_confirm
, 0 },
1939 { "cookie", 1, 1, c_cookie
, 0 },
1940 { "deluser", 1, 1, c_deluser
, RIGHT_ADMIN
},
1941 { "dirs", 0, 2, c_dirs
, RIGHT_READ
},
1942 { "disable", 0, 1, c_disable
, RIGHT_GLOBAL_PREFS
},
1943 { "edituser", 3, 3, c_edituser
, RIGHT_ADMIN
|RIGHT_USERINFO
},
1944 { "enable", 0, 0, c_enable
, RIGHT_GLOBAL_PREFS
},
1945 { "enabled", 0, 0, c_enabled
, RIGHT_READ
},
1946 { "exists", 1, 1, c_exists
, RIGHT_READ
},
1947 { "files", 0, 2, c_files
, RIGHT_READ
},
1948 { "get", 2, 2, c_get
, RIGHT_READ
},
1949 { "get-global", 1, 1, c_get_global
, RIGHT_READ
},
1950 { "length", 1, 1, c_length
, RIGHT_READ
},
1951 { "log", 0, 0, c_log
, RIGHT_READ
},
1952 { "make-cookie", 0, 0, c_make_cookie
, RIGHT_READ
},
1953 { "move", 2, 2, c_move
, RIGHT_MOVE__MASK
},
1954 { "moveafter", 1, INT_MAX
, c_moveafter
, RIGHT_MOVE__MASK
},
1955 { "new", 0, 1, c_new
, RIGHT_READ
},
1956 { "nop", 0, 0, c_nop
, 0 },
1957 { "part", 3, 3, c_part
, RIGHT_READ
},
1958 { "pause", 0, 0, c_pause
, RIGHT_PAUSE
},
1959 { "play", 1, 1, c_play
, RIGHT_PLAY
},
1960 { "playafter", 2, INT_MAX
, c_playafter
, RIGHT_PLAY
},
1961 { "playing", 0, 0, c_playing
, RIGHT_READ
},
1962 { "playlist-delete", 1, 1, c_playlist_delete
, RIGHT_PLAY
},
1963 { "playlist-get", 1, 1, c_playlist_get
, RIGHT_READ
},
1964 { "playlist-get-share", 1, 1, c_playlist_get_share
, RIGHT_READ
},
1965 { "playlist-lock", 1, 1, c_playlist_lock
, RIGHT_PLAY
},
1966 { "playlist-set", 1, 1, c_playlist_set
, RIGHT_PLAY
},
1967 { "playlist-set-share", 2, 2, c_playlist_set_share
, RIGHT_PLAY
},
1968 { "playlist-unlock", 0, 0, c_playlist_unlock
, RIGHT_PLAY
},
1969 { "playlists", 0, 0, c_playlists
, RIGHT_READ
},
1970 { "prefs", 1, 1, c_prefs
, RIGHT_READ
},
1971 { "queue", 0, 0, c_queue
, RIGHT_READ
},
1972 { "random-disable", 0, 0, c_random_disable
, RIGHT_GLOBAL_PREFS
},
1973 { "random-enable", 0, 0, c_random_enable
, RIGHT_GLOBAL_PREFS
},
1974 { "random-enabled", 0, 0, c_random_enabled
, RIGHT_READ
},
1975 { "recent", 0, 0, c_recent
, RIGHT_READ
},
1976 { "reconfigure", 0, 0, c_reconfigure
, RIGHT_ADMIN
},
1977 { "register", 3, 3, c_register
, RIGHT_REGISTER
},
1978 { "reminder", 1, 1, c_reminder
, RIGHT__LOCAL
},
1979 { "remove", 1, 1, c_remove
, RIGHT_REMOVE__MASK
},
1980 { "rescan", 0, INT_MAX
, c_rescan
, RIGHT_RESCAN
},
1981 { "resolve", 1, 1, c_resolve
, RIGHT_READ
},
1982 { "resume", 0, 0, c_resume
, RIGHT_PAUSE
},
1983 { "revoke", 0, 0, c_revoke
, RIGHT_READ
},
1984 { "rtp-address", 0, 0, c_rtp_address
, 0 },
1985 { "rtp-cancel", 0, 0, c_rtp_cancel
, 0 },
1986 { "rtp-request", 2, 2, c_rtp_request
, RIGHT_READ
},
1987 { "schedule-add", 3, INT_MAX
, c_schedule_add
, RIGHT_READ
},
1988 { "schedule-del", 1, 1, c_schedule_del
, RIGHT_READ
},
1989 { "schedule-get", 1, 1, c_schedule_get
, RIGHT_READ
},
1990 { "schedule-list", 0, 0, c_schedule_list
, RIGHT_READ
},
1991 { "scratch", 0, 1, c_scratch
, RIGHT_SCRATCH__MASK
},
1992 { "search", 1, 1, c_search
, RIGHT_READ
},
1993 { "set", 3, 3, c_set
, RIGHT_PREFS
, },
1994 { "set-global", 2, 2, c_set_global
, RIGHT_GLOBAL_PREFS
},
1995 { "shutdown", 0, 0, c_shutdown
, RIGHT_ADMIN
},
1996 { "stats", 0, 0, c_stats
, RIGHT_READ
},
1997 { "tags", 0, 0, c_tags
, RIGHT_READ
},
1998 { "unset", 2, 2, c_set
, RIGHT_PREFS
},
1999 { "unset-global", 1, 1, c_set_global
, RIGHT_GLOBAL_PREFS
},
2000 { "user", 2, 2, c_user
, 0 },
2001 { "userinfo", 2, 2, c_userinfo
, RIGHT_READ
},
2002 { "users", 0, 0, c_users
, RIGHT_READ
},
2003 { "version", 0, 0, c_version
, RIGHT_READ
},
2004 { "volume", 0, 2, c_volume
, RIGHT_READ
|RIGHT_VOLUME
}
2007 /** @brief Fetch a command body
2008 * @param c Connection
2009 * @param body_callback Called with body
2010 * @param u Passed to body_callback
2013 static int fetch_body(struct conn
*c
,
2014 body_callback_type body_callback
,
2016 assert(c
->line_reader
== command
);
2017 c
->line_reader
= body_line
;
2018 c
->body_callback
= body_callback
;
2020 vector_init(c
->body
);
2024 /** @brief @ref line_reader_type callback for command body lines
2025 * @param c Connection
2027 * @return 1 if complete, 0 if incomplete
2029 * Called from reader_callback().
2031 static int body_line(struct conn
*c
,
2036 /* That's the lot */
2037 c
->line_reader
= command
;
2038 vector_terminate(c
->body
);
2039 return c
->body_callback(c
, c
->body
->vec
, c
->body
->nvec
, c
->body_u
);
2042 vector_append(c
->body
, xstrdup(line
));
2043 return 1; /* completed */
2046 static void command_error(const char *msg
, void *u
) {
2049 sink_printf(ev_writer_sink(c
->w
), "500 parse error: %s\n", msg
);
2052 /** @brief @ref line_reader_type callback for commands
2053 * @param c Connection
2055 * @return 1 if complete, 0 if incomplete
2057 * Called from reader_callback().
2059 static int command(struct conn
*c
, char *line
) {
2063 D(("server command %s", line
));
2064 /* We force everything into NFC as early as possible */
2065 if(!(line
= utf8_compose_canon(line
, strlen(line
), 0))) {
2066 sink_writes(ev_writer_sink(c
->w
), "500 cannot normalize command\n");
2069 if(!(vec
= split(line
, &nvec
, SPLIT_QUOTES
, command_error
, c
))) {
2070 sink_writes(ev_writer_sink(c
->w
), "500 cannot parse command\n");
2074 sink_writes(ev_writer_sink(c
->w
), "500 do what?\n");
2077 if((n
= TABLE_FIND(commands
, name
, vec
[0])) < 0)
2078 sink_writes(ev_writer_sink(c
->w
), "500 unknown command\n");
2080 if(commands
[n
].rights
2081 && !(c
->rights
& commands
[n
].rights
)) {
2082 disorder_error(0, "%s attempted %s but lacks required rights",
2083 c
->who ? c
->who
: "NULL",
2085 sink_writes(ev_writer_sink(c
->w
), "510 Prohibited\n");
2090 if(nvec
< commands
[n
].minargs
) {
2091 sink_writes(ev_writer_sink(c
->w
), "500 missing argument(s)\n");
2094 if(nvec
> commands
[n
].maxargs
) {
2095 sink_writes(ev_writer_sink(c
->w
), "500 too many arguments\n");
2098 return commands
[n
].fn(c
, vec
, nvec
);
2100 return 1; /* completed */
2103 /* redirect to the right reader callback for our current state */
2104 static int redirect_reader_callback(ev_source
*ev
,
2112 return c
->reader(ev
, reader
, ptr
, bytes
, eof
, u
);
2115 /* the main command reader */
2116 static int reader_callback(ev_source
attribute((unused
)) *ev
,
2126 D(("server reader_callback"));
2127 while((eol
= memchr(ptr
, '\n', bytes
))) {
2129 ev_reader_consume(reader
, eol
- (char *)ptr
);
2130 complete
= c
->line_reader(c
, ptr
); /* usually command() */
2131 bytes
-= (eol
- (char *)ptr
);
2134 /* the command had better have set a new reader callback */
2136 /* there are further bytes to read, or we are at eof; arrange for the
2137 * command's reader callback to handle them */
2138 return ev_reader_incomplete(reader
);
2139 /* nothing's going on right now */
2142 /* command completed, we can go around and handle the next one */
2146 disorder_error(0, "S%x unterminated line", c
->tag
);
2147 D(("normal reader close"));
2150 D(("close associated writer"));
2151 ev_writer_close(c
->w
);
2154 remove_connection(c
);
2159 static int listen_callback(ev_source
*ev
,
2161 const struct sockaddr
attribute((unused
)) *remote
,
2162 socklen_t
attribute((unused
)) rlen
,
2164 const struct listener
*l
= u
;
2165 struct conn
*c
= xmalloc(sizeof *c
);
2166 static unsigned tags
;
2168 D(("server listen_callback fd %d (%s)", fd
, l
->name
));
2171 c
->next
= connections
;
2174 c
->w
= ev_writer_new(ev
, fd
, writer_error
, c
,
2177 disorder_error(0, "ev_writer_new for file inbound connection (fd=%d) failed",
2182 c
->r
= ev_reader_new(ev
, fd
, redirect_reader_callback
, reader_error
, c
,
2185 /* Main reason for failure is the FD is too big and that will already have
2188 "ev_reader_new for file inbound connection (fd=%d) failed",
2192 c
->reader
= reader_callback
;
2195 c
->line_reader
= command
;
2197 gcry_randomize(c
->nonce
, sizeof c
->nonce
, GCRY_STRONG_RANDOM
);
2198 sink_printf(ev_writer_sink(c
->w
), "231 %d %s %s\n",
2200 config
->authorization_algorithm
,
2201 hex(c
->nonce
, sizeof c
->nonce
));
2205 int server_start(ev_source
*ev
, int pf
,
2206 size_t socklen
, const struct sockaddr
*sa
,
2210 struct listener
*l
= xmalloc(sizeof *l
);
2211 static const int one
= 1;
2213 D(("server_init socket %s privileged=%d", name
, privileged
));
2215 if(privileged
&& pf
!= AF_UNIX
)
2216 disorder_fatal(0, "cannot create a privileged listener on a non-local port");
2217 fd
= xsocket(pf
, SOCK_STREAM
, 0);
2218 xsetsockopt(fd
, SOL_SOCKET
, SO_REUSEADDR
, &one
, sizeof one
);
2219 if(bind(fd
, sa
, socklen
) < 0) {
2220 disorder_error(errno
, "error binding to %s", name
);
2228 l
->privileged
= privileged
;
2229 if(ev_listen(ev
, fd
, listen_callback
, l
, "server listener"))
2231 disorder_info("listening on %s", name
);
2235 int server_stop(ev_source
*ev
, int fd
) {
2237 return ev_listen_cancel(ev
, fd
);