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
20 /** @file server/actions.c
21 * @brief DisOrder web actions
23 * Actions are anything that the web interface does beyond passive template
24 * expansion and inspection of state recieved from the server. This means
25 * playing tracks, editing prefs etc but also setting extra headers e.g. to
26 * auto-refresh the playing list.
29 #include "disorder-cgi.h"
31 /** @brief Redirect to some other action or URL */
32 static void redirect(const char *url) {
33 /* By default use the 'back' argument */
35 url = cgi_get("back");
37 if(strncmp(url, "http", 4))
38 /* If the target is not a full URL assume it's the action */
39 url = cgi_makeurl(config->url, "action", url, (char *)0);
41 /* If back= is not set just go back to the front page */
44 if(printf("Location: %s\n"
46 "\n", url, dcgi_cookie_header()) < 0)
47 fatal(errno, "error writing to stdout");
52 * Expands \fIplaying.tmpl\fR as if there was no special 'playing' action, but
53 * adds a Refresh: field to the HTTP header. The maximum refresh interval is
54 * defined by \fBrefresh\fR (see \fBdisorder_config\fR(5)) but may be less if
55 * the end of the track is near.
59 * Expands \fIplaying.tmpl\fR (NB not \fImanage.tmpl\fR) as if there was no
60 * special 'playing' action, and adds a Refresh: field to the HTTP header. The
61 * maximum refresh interval is defined by \Bfrefresh\fR (see
62 * \fBdisorder_config\fR(5)) but may be less if the end of the track is near.
64 static void act_playing(void) {
65 long refresh = config->refresh;
71 dcgi_lookup(DCGI_PLAYING|DCGI_QUEUE|DCGI_ENABLED|DCGI_RANDOM_ENABLED);
73 && dcgi_playing->state == playing_started /* i.e. not paused */
74 && !disorder_length(dcgi_client, dcgi_playing->track, &length)
76 && dcgi_playing->sofar >= 0) {
77 /* Try to put the next refresh at the start of the next track. */
79 fin = now + length - dcgi_playing->sofar + config->gap;
80 if(now + refresh > fin)
83 if(dcgi_queue && dcgi_queue->state == playing_isscratch) {
84 /* next track is a scratch, don't leave more than the inter-track gap */
85 if(refresh > config->gap)
86 refresh = config->gap;
90 && dcgi_queue->state != playing_random)
91 || dcgi_random_enabled)
93 /* no track playing but playing is enabled and there is something coming
94 * up, must be in a gap */
95 if(refresh > config->gap)
96 refresh = config->gap;
98 if((action = cgi_get("action")))
99 url = cgi_makeurl(config->url, "action", action, (char *)0);
102 if(printf("Refresh: %ld;url=%s\n",
104 fatal(errno, "error writing to stdout");
105 dcgi_expand("playing", 1);
112 static void act_disable(void) {
114 disorder_disable(dcgi_client);
122 static void act_enable(void) {
124 disorder_enable(dcgi_client);
130 * Disables random play.
132 static void act_random_disable(void) {
134 disorder_random_disable(dcgi_client);
140 * Enables random play.
142 static void act_random_enable(void) {
144 disorder_random_enable(dcgi_client);
150 * Pauses the current track (if there is one and it's not paused already).
152 static void act_pause(void) {
154 disorder_pause(dcgi_client);
160 * Resumes the current track (if there is one and it's paused).
162 static void act_resume(void) {
164 disorder_resume(dcgi_client);
170 * Removes the track given by the \fBid\fR argument. If this is the currently
171 * playing track then it is scratched.
173 static void act_remove(void) {
175 struct queue_entry *q;
178 if(!(id = cgi_get("id")))
179 error(0, "missing 'id' argument");
180 else if(!(q = dcgi_findtrack(id)))
181 error(0, "unknown queue id %s", id);
182 else switch(q->state) {
183 case playing_isscratch:
185 case playing_no_player:
187 case playing_quitting:
188 case playing_scratched:
189 error(0, "does not make sense to scratch %s", id);
191 case playing_paused: /* started but paused */
192 case playing_started: /* started to play */
193 disorder_scratch(dcgi_client, id);
195 case playing_random: /* unplayed randomly chosen track */
196 case playing_unplayed: /* haven't played this track yet */
197 disorder_remove(dcgi_client, id);
206 * Moves the track given by the \fBid\fR argument the distance given by the
207 * \fBdelta\fR argument. If this is positive the track is moved earlier in the
208 * queue and if negative, later.
210 static void act_move(void) {
211 const char *id, *delta;
212 struct queue_entry *q;
215 if(!(id = cgi_get("id")))
216 error(0, "missing 'id' argument");
217 else if(!(delta = cgi_get("delta")))
218 error(0, "missing 'delta' argument");
219 else if(!(q = dcgi_findtrack(id)))
220 error(0, "unknown queue id %s", id);
221 else switch(q->state) {
222 case playing_random: /* unplayed randomly chosen track */
223 case playing_unplayed: /* haven't played this track yet */
224 disorder_move(dcgi_client, id, atol(delta));
227 error(0, "does not make sense to scratch %s", id);
236 * Play the track given by the \fBtrack\fR argument, or if that is not set all
237 * the tracks in the directory given by the \fBdir\fR argument.
239 static void act_play(void) {
240 const char *track, *dir;
243 struct dcgi_entry *e;
246 if((track = cgi_get("track"))) {
247 disorder_play(dcgi_client, track);
248 } else if((dir = cgi_get("dir"))) {
249 if(disorder_files(dcgi_client, dir, 0, &tracks, &ntracks))
251 /* TODO use tracksort_init */
252 e = xmalloc(ntracks * sizeof (struct dcgi_entry));
253 for(n = 0; n < ntracks; ++n) {
254 e[n].track = tracks[n];
255 e[n].sort = trackname_transform("track", tracks[n], "sort");
256 e[n].display = trackname_transform("track", tracks[n], "display");
258 qsort(e, ntracks, sizeof (struct dcgi_entry), dcgi_compare_entry);
259 for(n = 0; n < ntracks; ++n)
260 disorder_play(dcgi_client, e[n].track);
266 static int clamp(int n, int min, int max) {
276 * If the \fBdelta\fR argument is set: adjust both channels by that amount (up
277 * if positive, down if negative).
279 * Otherwise if \fBleft\fR and \fBright\fR are set, set the channels
280 * independently to those values.
282 static void act_volume(void) {
283 const char *l, *r, *d;
287 if((d = cgi_get("delta"))) {
288 dcgi_lookup(DCGI_VOLUME);
289 nd = clamp(atoi(d), -255, 255);
290 disorder_set_volume(dcgi_client,
291 clamp(dcgi_volume_left + nd, 0, 255),
292 clamp(dcgi_volume_right + nd, 0, 255));
293 } else if((l = cgi_get("left")) && (r = cgi_get("right")))
294 disorder_set_volume(dcgi_client, atoi(l), atoi(r));
299 /** @brief Expand the login template with @b @@error set to @p error
300 * @param e Error keyword
302 static void login_error(const char *e) {
303 dcgi_error_string = e;
304 dcgi_expand("login", 1);
308 * @param username Login name
309 * @param password Password
310 * @return 0 on success, non-0 on error
312 * On error, calls login_error() to expand the login template.
314 static int login_as(const char *username, const char *password) {
317 if(dcgi_cookie && dcgi_client)
318 disorder_revoke(dcgi_client);
319 /* We'll need a new connection as we are going to stop being guest */
321 if(disorder_connect_user(c, username, password)) {
322 login_error("loginfailed");
325 /* Generate a cookie so we can log in again later */
326 if(disorder_make_cookie(c, &dcgi_cookie)) {
327 login_error("cookiefailed");
330 /* Use the new connection henceforth */
338 * If \fBusername\fR and \fBpassword\fR are set (and the username isn't
339 * "guest") then attempt to log in using those credentials. On success,
340 * redirects to the \fBback\fR argument if that is set, or just expands
341 * \fIlogin.tmpl\fI otherwise, with \fB@status\fR set to \fBloginok\fR.
343 * If they aren't set then just expands \fIlogin.tmpl\fI.
345 static void act_login(void) {
346 const char *username, *password;
348 /* We try all this even if not connected since the subsequent connection may
351 username = cgi_get("username");
352 password = cgi_get("password");
355 || !strcmp(username, "guest")/*bodge to avoid guest cookies*/) {
356 /* We're just visiting the login page, not performing an action at all. */
357 dcgi_expand("login", 1);
360 if(!login_as(username, password)) {
361 /* Report the succesful login */
362 dcgi_status_string = "loginok";
363 /* Redirect back to where we came from, if necessary */
367 dcgi_expand("login", 1);
373 * Logs out the current user and expands \fIlogin.tmpl\fR with \fBstatus\fR or
374 * \fB@error\fR set according to the result.
376 static void act_logout(void) {
378 /* Ask the server to revoke the cookie */
379 if(!disorder_revoke(dcgi_client))
380 dcgi_status_string = "logoutok";
382 dcgi_error_string = "revokefailed";
384 /* We can't guarantee a logout if we can't connect to the server to revoke
385 * the cookie, so we report an error. We'll still ask the browser to
386 * forget the cookie though. */
387 dcgi_error_string = "connect";
389 /* Attempt to reconnect without the cookie */
392 /* Back to login page, hopefuly forcing the browser to forget the cookie. */
393 dcgi_expand("login", 1);
398 * Register a new user using \fBusername\fR, \fBpassword1\fR, \fBpassword2\fR
399 * and \fBemail\fR and expands \fIlogin.tmpl\fR with \fBstatus\fR or
400 * \fB@error\fR set according to the result.
402 static void act_register(void) {
403 const char *username, *password, *password2, *email;
404 char *confirm, *content_type;
405 const char *text, *encoding, *charset;
407 /* If we're not connected then this is a hopeless exercise */
409 login_error("connect");
413 /* Collect arguments */
414 username = cgi_get("username");
415 password = cgi_get("password1");
416 password2 = cgi_get("password2");
417 email = cgi_get("email");
419 /* Verify arguments */
420 if(!username || !*username) {
421 login_error("nousername");
424 if(!password || !*password) {
425 login_error("nopassword");
428 if(!password2 || !*password2 || strcmp(password, password2)) {
429 login_error("passwordmismatch");
432 if(!email || !*email) {
433 login_error("noemail");
436 /* We could well do better address validation but for now we'll just do the
438 if(!email_valid(email)) {
439 login_error("bademail");
442 if(disorder_register(dcgi_client, username, password, email, &confirm)) {
443 login_error("cannotregister");
446 /* Send the user a mail */
447 /* TODO templatize this */
448 byte_xasprintf((char **)&text,
449 "Welcome to DisOrder. To active your login, please visit this URL:\n"
451 "%s?c=%s\n", config->url, urlencodestring(confirm));
452 if(!(text = mime_encode_text(text, &charset, &encoding)))
453 fatal(0, "cannot encode email");
454 byte_xasprintf(&content_type, "text/plain;charset=%s",
455 quote822(charset, 0));
456 sendmail("", config->mail_sender, email, "Welcome to DisOrder",
457 encoding, content_type, text); /* TODO error checking */
458 /* We'll go back to the login page with a suitable message */
459 dcgi_status_string = "registered";
460 dcgi_expand("login", 1);
465 * Confirm a user registration using the nonce supplied in \fBc\fR and expands
466 * \fIlogin.tmpl\fR with \fBstatus\fR or \fB@error\fR set according to the
469 static void act_confirm(void) {
470 const char *confirmation;
472 /* If we're not connected then this is a hopeless exercise */
474 login_error("connect");
478 if(!(confirmation = cgi_get("c"))) {
479 login_error("noconfirm");
482 /* Confirm our registration */
483 if(disorder_confirm(dcgi_client, confirmation)) {
484 login_error("badconfirm");
488 if(disorder_make_cookie(dcgi_client, &dcgi_cookie)) {
489 login_error("cookiefailed");
492 /* Junk cached data */
495 dcgi_status_string = "confirmed";
496 dcgi_expand("login", 1);
501 * Edit user details using \fBusername\fR, \fBchangepassword1\fR,
502 * \fBchangepassword2\fR and \fBemail\fR and expands \fIlogin.tmpl\fR with
503 * \fBstatus\fR or \fB@error\fR set according to the result.
505 static void act_edituser(void) {
506 const char *email = cgi_get("email"), *password = cgi_get("changepassword1");
507 const char *password2 = cgi_get("changepassword2");
510 /* If we're not connected then this is a hopeless exercise */
512 login_error("connect");
518 /* If either password or password2 is set we insist they match. If they
519 * don't we report an error. */
520 if((password && *password) || (password2 && *password2)) {
521 if(!password || !password2 || strcmp(password, password2)) {
522 login_error("passwordmismatch");
526 password = password2 = 0;
527 if(email && !email_valid(email)) {
528 login_error("bademail");
534 if(disorder_edituser(dcgi_client, disorder_user(dcgi_client),
536 login_error("badedit");
541 if(disorder_edituser(dcgi_client, disorder_user(dcgi_client),
542 "password", password)) {
543 login_error("badedit");
550 /* If we changed the password, the cookie is now invalid, so we must log
552 if(login_as(disorder_user(dcgi_client), password))
556 dcgi_status_string = "edited";
557 dcgi_expand("login", 1);
562 * Issue an email password reminder to \fBusername\fR and expands
563 * \fIlogin.tmpl\fR with \fBstatus\fR or \fB@error\fR set according to the
566 static void act_reminder(void) {
567 const char *const username = cgi_get("username");
569 /* If we're not connected then this is a hopeless exercise */
571 login_error("connect");
575 if(!username || !*username) {
576 login_error("nousername");
579 if(disorder_reminder(dcgi_client, username)) {
580 login_error("reminderfailed");
584 dcgi_status_string = "reminded";
585 dcgi_expand("login", 1);
588 /** @brief Get the numbered version of an argument
589 * @param argname Base argument name
590 * @param numfile File number
591 * @return cgi_get(NUMFILE_ARGNAME)
593 static const char *numbered_arg(const char *argname, int numfile) {
596 byte_xasprintf(&fullname, "%d_%s", numfile, argname);
597 return cgi_get(fullname);
600 /** @brief Set preferences for file @p numfile
601 * @return 0 on success, -1 if there is no such track number
603 * The old @b nfiles parameter has been abolished, we just keep look for more
604 * files until we run out.
606 static int process_prefs(int numfile) {
607 const char *file, *name, *value, *part, *parts, *context;
610 if(!(file = numbered_arg("track", numfile)))
612 if(!(parts = cgi_get("parts")))
613 parts = "artist album title";
614 if(!(context = cgi_get("context")))
616 partslist = split(parts, 0, 0, 0, 0);
617 while((part = *partslist++)) {
618 if(!(value = numbered_arg(part, numfile)))
620 byte_xasprintf((char **)&name, "trackname_%s_%s", context, part);
621 disorder_set(dcgi_client, file, name, value);
623 if((value = numbered_arg("random", numfile)))
624 disorder_unset(dcgi_client, file, "pick_at_random");
626 disorder_set(dcgi_client, file, "pick_at_random", "0");
627 if((value = numbered_arg("tags", numfile))) {
629 disorder_unset(dcgi_client, file, "tags");
631 disorder_set(dcgi_client, file, "tags", value);
633 if((value = numbered_arg("weight", numfile))) {
635 disorder_unset(dcgi_client, file, "weight");
637 disorder_set(dcgi_client, file, "weight", value);
644 * Set preferences on a number of tracks.
646 * The tracks to modify are specified in arguments \fB0_track\fR, \fB1_track\fR
647 * etc. The number sequence must be contiguous and start from 0.
649 * For each track \fIINDEX\fB_track\fR:
650 * - \fIINDEX\fB_\fIPART\fR is used to set the trackname preference for
651 * that part. (See \fBparts\fR below.)
652 * - \fIINDEX\fB_\fIrandom\fR if present enables random play for this track
653 * or disables it if absent.
654 * - \fIINDEX\fB_\fItags\fR sets the list of tags for this track.
655 * - \fIINDEX\fB_\fIweight\fR sets the weight for this track.
657 * \fBparts\fR can be set to the track name parts to modify. The default is
658 * "artist album title".
660 * \fBcontext\fR can be set to the context to modify. The default is
663 * If the server detects a preference being set to its default, it removes the
664 * preference, thus keeping the database tidy.
666 static void act_set(void) {
670 for(numfile = 0; !process_prefs(numfile); ++numfile)
676 /** @brief Table of actions */
677 static const struct action {
678 /** @brief Action name */
680 /** @brief Action handler */
681 void (*handler)(void);
682 /** @brief Union of suitable rights */
685 { "confirm", act_confirm, 0 },
686 { "disable", act_disable, RIGHT_GLOBAL_PREFS },
687 { "edituser", act_edituser, 0 },
688 { "enable", act_enable, RIGHT_GLOBAL_PREFS },
689 { "login", act_login, 0 },
690 { "logout", act_logout, 0 },
691 { "manage", act_playing, 0 },
692 { "move", act_move, RIGHT_MOVE__MASK },
693 { "pause", act_pause, RIGHT_PAUSE },
694 { "play", act_play, RIGHT_PLAY },
695 { "playing", act_playing, 0 },
696 { "randomdisable", act_random_disable, RIGHT_GLOBAL_PREFS },
697 { "randomenable", act_random_enable, RIGHT_GLOBAL_PREFS },
698 { "register", act_register, 0 },
699 { "reminder", act_reminder, 0 },
700 { "remove", act_remove, RIGHT_MOVE__MASK|RIGHT_SCRATCH__MASK },
701 { "resume", act_resume, RIGHT_PAUSE },
702 { "set", act_set, RIGHT_PREFS },
703 { "volume", act_volume, RIGHT_VOLUME },
706 /** @brief Check that an action name is valid
708 * @return 1 if valid, 0 if not
710 static int dcgi_valid_action(const char *name) {
713 /* First character must be letter or digit (this also requires there to _be_
714 * a first character) */
715 if(!isalnum((unsigned char)*name))
717 /* Only letters, digits, '.' and '-' allowed */
718 while((c = (unsigned char)*name++)) {
727 /** @brief Expand a template
728 * @param name Base name of template, or NULL to consult CGI args
729 * @param header True to write header
731 void dcgi_expand(const char *name, int header) {
732 const char *p, *found;
734 /* Parse macros first */
735 if((found = mx_find("macros.tmpl", 1/*report*/)))
736 mx_expand_file(found, sink_discard(), 0);
737 if((found = mx_find("user.tmpl", 0/*report*/)))
738 mx_expand_file(found, sink_discard(), 0);
739 /* For unknown actions check that they aren't evil */
740 if(!dcgi_valid_action(name))
741 fatal(0, "invalid action name '%s'", name);
742 byte_xasprintf((char **)&p, "%s.tmpl", name);
743 if(!(found = mx_find(p, 0/*report*/)))
744 fatal(errno, "cannot find %s", p);
746 if(printf("Content-Type: text/html; charset=UTF-8\n"
748 "\n", dcgi_cookie_header()) < 0)
749 fatal(errno, "error writing to stdout");
751 if(mx_expand_file(found, sink_stdio("stdout", stdout), 0) == -1
752 || fflush(stdout) < 0)
753 fatal(errno, "error writing to stdout");
756 /** @brief Execute a web action
757 * @param action Action to perform, or NULL to consult CGI args
759 * If no recognized action is specified then 'playing' is assumed.
761 void dcgi_action(const char *action) {
764 /* Consult CGI args if caller had no view */
766 action = cgi_get("action");
767 /* Pick a default if nobody cares at all */
769 /* We allow URLs which are just c=... in order to keep confirmation URLs,
770 * which are user-facing, as short as possible. Actually we could lose the
776 /* Make sure 'action' is always set */
777 cgi_set("action", action);
779 if((n = TABLE_FIND(actions, name, action)) >= 0) {
780 if(actions[n].rights) {
781 /* Some right or other is required */
782 dcgi_lookup(DCGI_RIGHTS);
783 if(!(actions[n].rights & dcgi_rights)) {
784 const char *back = cgi_thisurl(config->url);
785 /* Failed operations jump you to the login screen with an error
786 * message. On success, the user comes back to the page they were
789 cgi_set("back", back);
790 login_error("noright");
794 /* It's a known action */
795 actions[n].handler();
797 /* Just expand the template */
798 dcgi_expand(action, 1/*header*/);
802 /** @brief Generate an error page */
803 void dcgi_error(const char *key) {
804 dcgi_error_string = xstrdup(key);
805 dcgi_expand("error", 1);