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 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/>.
18 /** @file cgi/actions.c
19 * @brief DisOrder web actions
21 * Actions are anything that the web interface does beyond passive template
22 * expansion and inspection of state recieved from the server. This means
23 * playing tracks, editing prefs etc but also setting extra headers e.g. to
24 * auto-refresh the playing list.
26 * See @ref lib/macros-builtin.c for docstring syntax.
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 disorder_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;
80 if(now + refresh > fin)
83 if(dcgi_queue && dcgi_queue->origin == origin_scratch) {
84 /* next track is a scratch, refresh immediately */
89 && dcgi_queue->origin != origin_random)
90 || dcgi_random_enabled)
92 /* no track playing but playing is enabled and there is something coming
93 * up, so refresh immediately */
96 /* Bound the refresh interval below as a back-stop against the above
97 * calculations coming up with a stupid answer */
98 if(refresh < config->refresh_min)
99 refresh = config->refresh_min;
100 if((action = cgi_get("action")))
101 url = cgi_makeurl(config->url, "action", action, (char *)0);
104 if(printf("Refresh: %ld;url=%s\n",
106 disorder_fatal(errno, "error writing to stdout");
107 dcgi_expand("playing", 1);
114 static void act_disable(void) {
116 disorder_disable(dcgi_client);
124 static void act_enable(void) {
126 disorder_enable(dcgi_client);
132 * Disables random play.
134 static void act_random_disable(void) {
136 disorder_random_disable(dcgi_client);
142 * Enables random play.
144 static void act_random_enable(void) {
146 disorder_random_enable(dcgi_client);
152 * Pauses the current track (if there is one and it's not paused already).
154 static void act_pause(void) {
156 disorder_pause(dcgi_client);
162 * Resumes the current track (if there is one and it's paused).
164 static void act_resume(void) {
166 disorder_resume(dcgi_client);
172 * Removes the track given by the \fBid\fR argument. If this is the currently
173 * playing track then it is scratched.
175 static void act_remove(void) {
177 struct queue_entry *q;
180 if(!(id = cgi_get("id")))
181 disorder_error(0, "missing 'id' argument");
182 else if(!(q = dcgi_findtrack(id)))
183 disorder_error(0, "unknown queue id %s", id);
184 else if(q->origin == origin_scratch)
185 /* can't scratch scratches */
186 disorder_error(0, "does not make sense to scratch or remove %s", id);
187 else if(q->state == playing_paused
188 || q->state == playing_started)
189 /* removing the playing track = scratching */
190 disorder_scratch(dcgi_client, id);
191 else if(q->state == playing_unplayed)
192 /* otherwise it must be in the queue */
193 disorder_remove(dcgi_client, id);
195 /* various error states */
196 disorder_error(0, "does not make sense to scratch or remove %s", id);
203 * Moves the track given by the \fBid\fR argument the distance given by the
204 * \fBdelta\fR argument. If this is positive the track is moved earlier in the
205 * queue and if negative, later.
207 static void act_move(void) {
208 const char *id, *delta;
209 struct queue_entry *q;
212 if(!(id = cgi_get("id")))
213 disorder_error(0, "missing 'id' argument");
214 else if(!(delta = cgi_get("delta")))
215 disorder_error(0, "missing 'delta' argument");
216 else if(!(q = dcgi_findtrack(id)))
217 disorder_error(0, "unknown queue id %s", id);
218 else switch(q->state) {
219 case playing_random: /* unplayed randomly chosen track */
220 case playing_unplayed: /* haven't played this track yet */
221 disorder_move(dcgi_client, id, atol(delta));
224 disorder_error(0, "does not make sense to scratch %s", id);
233 * Play the track given by the \fBtrack\fR argument, or if that is not set all
234 * the tracks in the directory given by the \fBdir\fR argument.
236 static void act_play(void) {
237 const char *track, *dir;
240 struct tracksort_data *tsd;
244 if((track = cgi_get("track"))) {
245 disorder_play(dcgi_client, track, &id);
246 } else if((dir = cgi_get("dir"))) {
247 if(disorder_files(dcgi_client, dir, 0, &tracks, &ntracks))
249 tsd = tracksort_init(ntracks, tracks, "track");
250 for(n = 0; n < ntracks; ++n)
251 disorder_play(dcgi_client, tsd[n].track, &id);
257 static int clamp(int n, int min, int max) {
267 * If the \fBdelta\fR argument is set: adjust both channels by that amount (up
268 * if positive, down if negative).
270 * Otherwise if \fBleft\fR and \fBright\fR are set, set the channels
271 * independently to those values.
273 static void act_volume(void) {
274 const char *l, *r, *d;
278 if((d = cgi_get("delta"))) {
279 dcgi_lookup(DCGI_VOLUME);
280 nd = clamp(atoi(d), -255, 255);
281 disorder_set_volume(dcgi_client,
282 clamp(dcgi_volume_left + nd, 0, 255),
283 clamp(dcgi_volume_right + nd, 0, 255));
284 } else if((l = cgi_get("left")) && (r = cgi_get("right")))
285 disorder_set_volume(dcgi_client, atoi(l), atoi(r));
290 /** @brief Expand the login template with @b @@error set to @p error
291 * @param e Error keyword
293 static void login_error(const char *e) {
294 dcgi_error_string = e;
295 dcgi_expand("login", 1);
299 * @param username Login name
300 * @param password Password
301 * @return 0 on success, non-0 on error
303 * On error, calls login_error() to expand the login template.
305 static int login_as(const char *username, const char *password) {
308 if(dcgi_cookie && dcgi_client)
309 disorder_revoke(dcgi_client);
310 /* We'll need a new connection as we are going to stop being guest */
312 if(disorder_connect_user(c, username, password)) {
313 login_error("loginfailed");
316 /* Generate a cookie so we can log in again later */
317 if(disorder_make_cookie(c, &dcgi_cookie)) {
318 login_error("cookiefailed");
321 /* Use the new connection henceforth */
329 * If \fBusername\fR and \fBpassword\fR are set (and the username isn't
330 * "guest") then attempt to log in using those credentials. On success,
331 * redirects to the \fBback\fR argument if that is set, or just expands
332 * \fIlogin.tmpl\fI otherwise, with \fB@status\fR set to \fBloginok\fR.
334 * If they aren't set then just expands \fIlogin.tmpl\fI.
336 static void act_login(void) {
337 const char *username, *password;
339 /* We try all this even if not connected since the subsequent connection may
342 username = cgi_get("username");
343 password = cgi_get("password");
346 || !strcmp(username, "guest")/*bodge to avoid guest cookies*/) {
347 /* We're just visiting the login page, not performing an action at all. */
348 dcgi_expand("login", 1);
351 if(!login_as(username, password)) {
352 /* Report the succesful login */
353 dcgi_status_string = "loginok";
354 /* Redirect back to where we came from, if necessary */
358 dcgi_expand("login", 1);
364 * Logs out the current user and expands \fIlogin.tmpl\fR with \fBstatus\fR or
365 * \fB@error\fR set according to the result.
367 static void act_logout(void) {
369 /* Ask the server to revoke the cookie */
370 if(!disorder_revoke(dcgi_client))
371 dcgi_status_string = "logoutok";
373 dcgi_error_string = "revokefailed";
375 /* We can't guarantee a logout if we can't connect to the server to revoke
376 * the cookie, so we report an error. We'll still ask the browser to
377 * forget the cookie though. */
378 dcgi_error_string = "connect";
380 /* Attempt to reconnect without the cookie */
383 /* Back to login page, hopefuly forcing the browser to forget the cookie. */
384 dcgi_expand("login", 1);
389 * Register a new user using \fBusername\fR, \fBpassword1\fR, \fBpassword2\fR
390 * and \fBemail\fR and expands \fIlogin.tmpl\fR with \fBstatus\fR or
391 * \fB@error\fR set according to the result.
393 static void act_register(void) {
394 const char *username, *password, *password2, *email;
395 char *confirm, *content_type;
396 const char *text, *encoding, *charset;
398 /* If we're not connected then this is a hopeless exercise */
400 login_error("connect");
404 /* Collect arguments */
405 username = cgi_get("username");
406 password = cgi_get("password1");
407 password2 = cgi_get("password2");
408 email = cgi_get("email");
410 /* Verify arguments */
411 if(!username || !*username) {
412 login_error("nousername");
415 if(!password || !*password) {
416 login_error("nopassword");
419 if(!password2 || !*password2 || strcmp(password, password2)) {
420 login_error("passwordmismatch");
423 if(!email || !*email) {
424 login_error("noemail");
427 /* We could well do better address validation but for now we'll just do the
429 if(!email_valid(email)) {
430 login_error("bademail");
433 if(disorder_register(dcgi_client, username, password, email, &confirm)) {
434 login_error("cannotregister");
437 /* Send the user a mail */
438 /* TODO templatize this */
439 byte_xasprintf((char **)&text,
440 "Welcome to DisOrder. To active your login, please visit this URL:\n"
442 "%s?c=%s\n", config->url, urlencodestring(confirm));
443 if(!(text = mime_encode_text(text, &charset, &encoding)))
444 disorder_fatal(0, "cannot encode email");
445 byte_xasprintf(&content_type, "text/plain;charset=%s",
446 quote822(charset, 0));
447 sendmail("", config->mail_sender, email, "Welcome to DisOrder",
448 encoding, content_type, text); /* TODO error checking */
449 /* We'll go back to the login page with a suitable message */
450 dcgi_status_string = "registered";
451 dcgi_expand("login", 1);
456 * Confirm a user registration using the nonce supplied in \fBc\fR and expands
457 * \fIlogin.tmpl\fR with \fBstatus\fR or \fB@error\fR set according to the
460 static void act_confirm(void) {
461 const char *confirmation;
463 /* If we're not connected then this is a hopeless exercise */
465 login_error("connect");
469 if(!(confirmation = cgi_get("c"))) {
470 login_error("noconfirm");
473 /* Confirm our registration */
474 if(disorder_confirm(dcgi_client, confirmation)) {
475 login_error("badconfirm");
479 if(disorder_make_cookie(dcgi_client, &dcgi_cookie)) {
480 login_error("cookiefailed");
483 /* Junk cached data */
486 dcgi_status_string = "confirmed";
487 dcgi_expand("login", 1);
492 * Edit user details using \fBusername\fR, \fBchangepassword1\fR,
493 * \fBchangepassword2\fR and \fBemail\fR and expands \fIlogin.tmpl\fR with
494 * \fBstatus\fR or \fB@error\fR set according to the result.
496 static void act_edituser(void) {
497 const char *email = cgi_get("email"), *password = cgi_get("changepassword1");
498 const char *password2 = cgi_get("changepassword2");
501 /* If we're not connected then this is a hopeless exercise */
503 login_error("connect");
509 /* If either password or password2 is set we insist they match. If they
510 * don't we report an error. */
511 if((password && *password) || (password2 && *password2)) {
512 if(!password || !password2 || strcmp(password, password2)) {
513 login_error("passwordmismatch");
517 password = password2 = 0;
518 if(email && !email_valid(email)) {
519 login_error("bademail");
525 if(disorder_edituser(dcgi_client, disorder_user(dcgi_client),
527 login_error("badedit");
532 if(disorder_edituser(dcgi_client, disorder_user(dcgi_client),
533 "password", password)) {
534 login_error("badedit");
541 /* If we changed the password, the cookie is now invalid, so we must log
543 if(login_as(disorder_user(dcgi_client), password))
547 dcgi_status_string = "edited";
548 dcgi_expand("login", 1);
553 * Issue an email password reminder to \fBusername\fR and expands
554 * \fIlogin.tmpl\fR with \fBstatus\fR or \fB@error\fR set according to the
557 static void act_reminder(void) {
558 const char *const username = cgi_get("username");
560 /* If we're not connected then this is a hopeless exercise */
562 login_error("connect");
566 if(!username || !*username) {
567 login_error("nousername");
570 if(disorder_reminder(dcgi_client, username)) {
571 login_error("reminderfailed");
575 dcgi_status_string = "reminded";
576 dcgi_expand("login", 1);
579 /** @brief Get the numbered version of an argument
580 * @param argname Base argument name
581 * @param numfile File number
582 * @return cgi_get(NUMFILE_ARGNAME)
584 static const char *numbered_arg(const char *argname, int numfile) {
587 byte_xasprintf(&fullname, "%d_%s", numfile, argname);
588 return cgi_get(fullname);
591 /** @brief Set preferences for file @p numfile
592 * @return 0 on success, -1 if there is no such track number
594 * The old @b nfiles parameter has been abolished, we just keep look for more
595 * files until we run out.
597 static int process_prefs(int numfile) {
598 const char *file, *name, *value, *part, *parts, *context;
601 if(!(file = numbered_arg("track", numfile)))
603 if(!(parts = cgi_get("parts")))
604 parts = "artist album title";
605 if(!(context = cgi_get("context")))
607 partslist = split(parts, 0, 0, 0, 0);
608 while((part = *partslist++)) {
609 if(!(value = numbered_arg(part, numfile)))
611 byte_xasprintf((char **)&name, "trackname_%s_%s", context, part);
612 disorder_set(dcgi_client, file, name, value);
614 if(numbered_arg("random", numfile))
615 disorder_unset(dcgi_client, file, "pick_at_random");
617 disorder_set(dcgi_client, file, "pick_at_random", "0");
618 if((value = numbered_arg("tags", numfile))) {
620 disorder_unset(dcgi_client, file, "tags");
622 disorder_set(dcgi_client, file, "tags", value);
624 if((value = numbered_arg("weight", numfile))) {
626 disorder_unset(dcgi_client, file, "weight");
628 disorder_set(dcgi_client, file, "weight", value);
635 * Set preferences on a number of tracks.
637 * The tracks to modify are specified in arguments \fB0_track\fR, \fB1_track\fR
638 * etc. The number sequence must be contiguous and start from 0.
640 * For each track \fIINDEX\fB_track\fR:
641 * - \fIINDEX\fB_\fIPART\fR is used to set the trackname preference for
642 * that part. (See \fBparts\fR below.)
643 * - \fIINDEX\fB_\fIrandom\fR if present enables random play for this track
644 * or disables it if absent.
645 * - \fIINDEX\fB_\fItags\fR sets the list of tags for this track.
646 * - \fIINDEX\fB_\fIweight\fR sets the weight for this track.
648 * \fBparts\fR can be set to the track name parts to modify. The default is
649 * "artist album title".
651 * \fBcontext\fR can be set to the context to modify. The default is
654 * If the server detects a preference being set to its default, it removes the
655 * preference, thus keeping the database tidy.
657 static void act_set(void) {
661 for(numfile = 0; !process_prefs(numfile); ++numfile)
667 /** @brief Table of actions */
668 static const struct action {
669 /** @brief Action name */
671 /** @brief Action handler */
672 void (*handler)(void);
673 /** @brief Union of suitable rights */
676 { "confirm", act_confirm, 0 },
677 { "disable", act_disable, RIGHT_GLOBAL_PREFS },
678 { "edituser", act_edituser, 0 },
679 { "enable", act_enable, RIGHT_GLOBAL_PREFS },
680 { "login", act_login, 0 },
681 { "logout", act_logout, 0 },
682 { "manage", act_playing, 0 },
683 { "move", act_move, RIGHT_MOVE__MASK },
684 { "pause", act_pause, RIGHT_PAUSE },
685 { "play", act_play, RIGHT_PLAY },
686 { "playing", act_playing, 0 },
687 { "randomdisable", act_random_disable, RIGHT_GLOBAL_PREFS },
688 { "randomenable", act_random_enable, RIGHT_GLOBAL_PREFS },
689 { "register", act_register, 0 },
690 { "reminder", act_reminder, 0 },
691 { "remove", act_remove, RIGHT_MOVE__MASK|RIGHT_SCRATCH__MASK },
692 { "resume", act_resume, RIGHT_PAUSE },
693 { "set", act_set, RIGHT_PREFS },
694 { "volume", act_volume, RIGHT_VOLUME },
697 /** @brief Check that an action name is valid
699 * @return 1 if valid, 0 if not
701 static int dcgi_valid_action(const char *name) {
704 /* First character must be letter or digit (this also requires there to _be_
705 * a first character) */
706 if(!isalnum((unsigned char)*name))
708 /* Only letters, digits, '.' and '-' allowed */
709 while((c = (unsigned char)*name++)) {
718 /** @brief Expand a template
719 * @param name Base name of template, or NULL to consult CGI args
720 * @param header True to write header
722 void dcgi_expand(const char *name, int header) {
723 const char *p, *found;
725 /* Parse macros first */
726 if((found = mx_find("macros.tmpl", 1/*report*/)))
727 mx_expand_file(found, sink_discard(), 0);
728 if((found = mx_find("user.tmpl", 0/*report*/)))
729 mx_expand_file(found, sink_discard(), 0);
730 /* For unknown actions check that they aren't evil */
731 if(!dcgi_valid_action(name))
732 disorder_fatal(0, "invalid action name '%s'", name);
733 byte_xasprintf((char **)&p, "%s.tmpl", name);
734 if(!(found = mx_find(p, 0/*report*/)))
735 disorder_fatal(errno, "cannot find %s", p);
737 if(printf("Content-Type: text/html; charset=UTF-8\n"
739 "\n", dcgi_cookie_header()) < 0)
740 disorder_fatal(errno, "error writing to stdout");
742 if(mx_expand_file(found, sink_stdio("stdout", stdout), 0) == -1
743 || fflush(stdout) < 0)
744 disorder_fatal(errno, "error writing to stdout");
747 /** @brief Execute a web action
748 * @param action Action to perform, or NULL to consult CGI args
750 * If no recognized action is specified then 'playing' is assumed.
752 void dcgi_action(const char *action) {
755 /* Consult CGI args if caller had no view */
757 action = cgi_get("action");
758 /* Pick a default if nobody cares at all */
760 /* We allow URLs which are just c=... in order to keep confirmation URLs,
761 * which are user-facing, as short as possible. Actually we could lose the
767 /* Make sure 'action' is always set */
768 cgi_set("action", action);
770 if((n = TABLE_FIND(actions, name, action)) >= 0) {
771 if(actions[n].rights) {
772 /* Some right or other is required */
773 dcgi_lookup(DCGI_RIGHTS);
774 if(!(actions[n].rights & dcgi_rights)) {
775 const char *back = cgi_thisurl(config->url);
776 /* Failed operations jump you to the login screen with an error
777 * message. On success, the user comes back to the page they were
780 cgi_set("back", back);
781 login_error("noright");
785 /* It's a known action */
786 actions[n].handler();
788 /* Just expand the template */
789 dcgi_expand(action, 1/*header*/);
793 /** @brief Generate an error page */
794 void dcgi_error(const char *key) {
795 dcgi_error_string = xstrdup(key);
796 dcgi_expand("error", 1);