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 tracksort_data
*tsd
;
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 tsd
= tracksort_init(ntracks
, tracks
, "track");
252 for(n
= 0; n
< ntracks
; ++n
)
253 disorder_play(dcgi_client
, tsd
[n
].track
);
259 static int clamp(int n
, int min
, int max
) {
269 * If the \fBdelta\fR argument is set: adjust both channels by that amount (up
270 * if positive, down if negative).
272 * Otherwise if \fBleft\fR and \fBright\fR are set, set the channels
273 * independently to those values.
275 static void act_volume(void) {
276 const char *l
, *r
, *d
;
280 if((d
= cgi_get("delta"))) {
281 dcgi_lookup(DCGI_VOLUME
);
282 nd
= clamp(atoi(d
), -255, 255);
283 disorder_set_volume(dcgi_client
,
284 clamp(dcgi_volume_left
+ nd
, 0, 255),
285 clamp(dcgi_volume_right
+ nd
, 0, 255));
286 } else if((l
= cgi_get("left")) && (r
= cgi_get("right")))
287 disorder_set_volume(dcgi_client
, atoi(l
), atoi(r
));
292 /** @brief Expand the login template with @b @@error set to @p error
293 * @param e Error keyword
295 static void login_error(const char *e
) {
296 dcgi_error_string
= e
;
297 dcgi_expand("login", 1);
301 * @param username Login name
302 * @param password Password
303 * @return 0 on success, non-0 on error
305 * On error, calls login_error() to expand the login template.
307 static int login_as(const char *username
, const char *password
) {
310 if(dcgi_cookie
&& dcgi_client
)
311 disorder_revoke(dcgi_client
);
312 /* We'll need a new connection as we are going to stop being guest */
314 if(disorder_connect_user(c
, username
, password
)) {
315 login_error("loginfailed");
318 /* Generate a cookie so we can log in again later */
319 if(disorder_make_cookie(c
, &dcgi_cookie
)) {
320 login_error("cookiefailed");
323 /* Use the new connection henceforth */
331 * If \fBusername\fR and \fBpassword\fR are set (and the username isn't
332 * "guest") then attempt to log in using those credentials. On success,
333 * redirects to the \fBback\fR argument if that is set, or just expands
334 * \fIlogin.tmpl\fI otherwise, with \fB@status\fR set to \fBloginok\fR.
336 * If they aren't set then just expands \fIlogin.tmpl\fI.
338 static void act_login(void) {
339 const char *username
, *password
;
341 /* We try all this even if not connected since the subsequent connection may
344 username
= cgi_get("username");
345 password
= cgi_get("password");
348 || !strcmp(username
, "guest")/*bodge to avoid guest cookies*/) {
349 /* We're just visiting the login page, not performing an action at all. */
350 dcgi_expand("login", 1);
353 if(!login_as(username
, password
)) {
354 /* Report the succesful login */
355 dcgi_status_string
= "loginok";
356 /* Redirect back to where we came from, if necessary */
360 dcgi_expand("login", 1);
366 * Logs out the current user and expands \fIlogin.tmpl\fR with \fBstatus\fR or
367 * \fB@error\fR set according to the result.
369 static void act_logout(void) {
371 /* Ask the server to revoke the cookie */
372 if(!disorder_revoke(dcgi_client
))
373 dcgi_status_string
= "logoutok";
375 dcgi_error_string
= "revokefailed";
377 /* We can't guarantee a logout if we can't connect to the server to revoke
378 * the cookie, so we report an error. We'll still ask the browser to
379 * forget the cookie though. */
380 dcgi_error_string
= "connect";
382 /* Attempt to reconnect without the cookie */
385 /* Back to login page, hopefuly forcing the browser to forget the cookie. */
386 dcgi_expand("login", 1);
391 * Register a new user using \fBusername\fR, \fBpassword1\fR, \fBpassword2\fR
392 * and \fBemail\fR and expands \fIlogin.tmpl\fR with \fBstatus\fR or
393 * \fB@error\fR set according to the result.
395 static void act_register(void) {
396 const char *username
, *password
, *password2
, *email
;
397 char *confirm
, *content_type
;
398 const char *text
, *encoding
, *charset
;
400 /* If we're not connected then this is a hopeless exercise */
402 login_error("connect");
406 /* Collect arguments */
407 username
= cgi_get("username");
408 password
= cgi_get("password1");
409 password2
= cgi_get("password2");
410 email
= cgi_get("email");
412 /* Verify arguments */
413 if(!username
|| !*username
) {
414 login_error("nousername");
417 if(!password
|| !*password
) {
418 login_error("nopassword");
421 if(!password2
|| !*password2
|| strcmp(password
, password2
)) {
422 login_error("passwordmismatch");
425 if(!email
|| !*email
) {
426 login_error("noemail");
429 /* We could well do better address validation but for now we'll just do the
431 if(!email_valid(email
)) {
432 login_error("bademail");
435 if(disorder_register(dcgi_client
, username
, password
, email
, &confirm
)) {
436 login_error("cannotregister");
439 /* Send the user a mail */
440 /* TODO templatize this */
441 byte_xasprintf((char **)&text
,
442 "Welcome to DisOrder. To active your login, please visit this URL:\n"
444 "%s?c=%s\n", config
->url
, urlencodestring(confirm
));
445 if(!(text
= mime_encode_text(text
, &charset
, &encoding
)))
446 fatal(0, "cannot encode email");
447 byte_xasprintf(&content_type
, "text/plain;charset=%s",
448 quote822(charset
, 0));
449 sendmail("", config
->mail_sender
, email
, "Welcome to DisOrder",
450 encoding
, content_type
, text
); /* TODO error checking */
451 /* We'll go back to the login page with a suitable message */
452 dcgi_status_string
= "registered";
453 dcgi_expand("login", 1);
458 * Confirm a user registration using the nonce supplied in \fBc\fR and expands
459 * \fIlogin.tmpl\fR with \fBstatus\fR or \fB@error\fR set according to the
462 static void act_confirm(void) {
463 const char *confirmation
;
465 /* If we're not connected then this is a hopeless exercise */
467 login_error("connect");
471 if(!(confirmation
= cgi_get("c"))) {
472 login_error("noconfirm");
475 /* Confirm our registration */
476 if(disorder_confirm(dcgi_client
, confirmation
)) {
477 login_error("badconfirm");
481 if(disorder_make_cookie(dcgi_client
, &dcgi_cookie
)) {
482 login_error("cookiefailed");
485 /* Junk cached data */
488 dcgi_status_string
= "confirmed";
489 dcgi_expand("login", 1);
494 * Edit user details using \fBusername\fR, \fBchangepassword1\fR,
495 * \fBchangepassword2\fR and \fBemail\fR and expands \fIlogin.tmpl\fR with
496 * \fBstatus\fR or \fB@error\fR set according to the result.
498 static void act_edituser(void) {
499 const char *email
= cgi_get("email"), *password
= cgi_get("changepassword1");
500 const char *password2
= cgi_get("changepassword2");
503 /* If we're not connected then this is a hopeless exercise */
505 login_error("connect");
511 /* If either password or password2 is set we insist they match. If they
512 * don't we report an error. */
513 if((password
&& *password
) || (password2
&& *password2
)) {
514 if(!password
|| !password2
|| strcmp(password
, password2
)) {
515 login_error("passwordmismatch");
519 password
= password2
= 0;
520 if(email
&& !email_valid(email
)) {
521 login_error("bademail");
527 if(disorder_edituser(dcgi_client
, disorder_user(dcgi_client
),
529 login_error("badedit");
534 if(disorder_edituser(dcgi_client
, disorder_user(dcgi_client
),
535 "password", password
)) {
536 login_error("badedit");
543 /* If we changed the password, the cookie is now invalid, so we must log
545 if(login_as(disorder_user(dcgi_client
), password
))
549 dcgi_status_string
= "edited";
550 dcgi_expand("login", 1);
555 * Issue an email password reminder to \fBusername\fR and expands
556 * \fIlogin.tmpl\fR with \fBstatus\fR or \fB@error\fR set according to the
559 static void act_reminder(void) {
560 const char *const username
= cgi_get("username");
562 /* If we're not connected then this is a hopeless exercise */
564 login_error("connect");
568 if(!username
|| !*username
) {
569 login_error("nousername");
572 if(disorder_reminder(dcgi_client
, username
)) {
573 login_error("reminderfailed");
577 dcgi_status_string
= "reminded";
578 dcgi_expand("login", 1);
581 /** @brief Get the numbered version of an argument
582 * @param argname Base argument name
583 * @param numfile File number
584 * @return cgi_get(NUMFILE_ARGNAME)
586 static const char *numbered_arg(const char *argname
, int numfile
) {
589 byte_xasprintf(&fullname
, "%d_%s", numfile
, argname
);
590 return cgi_get(fullname
);
593 /** @brief Set preferences for file @p numfile
594 * @return 0 on success, -1 if there is no such track number
596 * The old @b nfiles parameter has been abolished, we just keep look for more
597 * files until we run out.
599 static int process_prefs(int numfile
) {
600 const char *file
, *name
, *value
, *part
, *parts
, *context
;
603 if(!(file
= numbered_arg("track", numfile
)))
605 if(!(parts
= cgi_get("parts")))
606 parts
= "artist album title";
607 if(!(context
= cgi_get("context")))
609 partslist
= split(parts
, 0, 0, 0, 0);
610 while((part
= *partslist
++)) {
611 if(!(value
= numbered_arg(part
, numfile
)))
613 byte_xasprintf((char **)&name
, "trackname_%s_%s", context
, part
);
614 disorder_set(dcgi_client
, file
, name
, value
);
616 if((value
= numbered_arg("random", numfile
)))
617 disorder_unset(dcgi_client
, file
, "pick_at_random");
619 disorder_set(dcgi_client
, file
, "pick_at_random", "0");
620 if((value
= numbered_arg("tags", numfile
))) {
622 disorder_unset(dcgi_client
, file
, "tags");
624 disorder_set(dcgi_client
, file
, "tags", value
);
626 if((value
= numbered_arg("weight", numfile
))) {
628 disorder_unset(dcgi_client
, file
, "weight");
630 disorder_set(dcgi_client
, file
, "weight", value
);
637 * Set preferences on a number of tracks.
639 * The tracks to modify are specified in arguments \fB0_track\fR, \fB1_track\fR
640 * etc. The number sequence must be contiguous and start from 0.
642 * For each track \fIINDEX\fB_track\fR:
643 * - \fIINDEX\fB_\fIPART\fR is used to set the trackname preference for
644 * that part. (See \fBparts\fR below.)
645 * - \fIINDEX\fB_\fIrandom\fR if present enables random play for this track
646 * or disables it if absent.
647 * - \fIINDEX\fB_\fItags\fR sets the list of tags for this track.
648 * - \fIINDEX\fB_\fIweight\fR sets the weight for this track.
650 * \fBparts\fR can be set to the track name parts to modify. The default is
651 * "artist album title".
653 * \fBcontext\fR can be set to the context to modify. The default is
656 * If the server detects a preference being set to its default, it removes the
657 * preference, thus keeping the database tidy.
659 static void act_set(void) {
663 for(numfile
= 0; !process_prefs(numfile
); ++numfile
)
669 /** @brief Table of actions */
670 static const struct action
{
671 /** @brief Action name */
673 /** @brief Action handler */
674 void (*handler
)(void);
675 /** @brief Union of suitable rights */
678 { "confirm", act_confirm
, 0 },
679 { "disable", act_disable
, RIGHT_GLOBAL_PREFS
},
680 { "edituser", act_edituser
, 0 },
681 { "enable", act_enable
, RIGHT_GLOBAL_PREFS
},
682 { "login", act_login
, 0 },
683 { "logout", act_logout
, 0 },
684 { "manage", act_playing
, 0 },
685 { "move", act_move
, RIGHT_MOVE__MASK
},
686 { "pause", act_pause
, RIGHT_PAUSE
},
687 { "play", act_play
, RIGHT_PLAY
},
688 { "playing", act_playing
, 0 },
689 { "randomdisable", act_random_disable
, RIGHT_GLOBAL_PREFS
},
690 { "randomenable", act_random_enable
, RIGHT_GLOBAL_PREFS
},
691 { "register", act_register
, 0 },
692 { "reminder", act_reminder
, 0 },
693 { "remove", act_remove
, RIGHT_MOVE__MASK
|RIGHT_SCRATCH__MASK
},
694 { "resume", act_resume
, RIGHT_PAUSE
},
695 { "set", act_set
, RIGHT_PREFS
},
696 { "volume", act_volume
, RIGHT_VOLUME
},
699 /** @brief Check that an action name is valid
701 * @return 1 if valid, 0 if not
703 static int dcgi_valid_action(const char *name
) {
706 /* First character must be letter or digit (this also requires there to _be_
707 * a first character) */
708 if(!isalnum((unsigned char)*name
))
710 /* Only letters, digits, '.' and '-' allowed */
711 while((c
= (unsigned char)*name
++)) {
720 /** @brief Expand a template
721 * @param name Base name of template, or NULL to consult CGI args
722 * @param header True to write header
724 void dcgi_expand(const char *name
, int header
) {
725 const char *p
, *found
;
727 /* Parse macros first */
728 if((found
= mx_find("macros.tmpl", 1/*report*/)))
729 mx_expand_file(found
, sink_discard(), 0);
730 if((found
= mx_find("user.tmpl", 0/*report*/)))
731 mx_expand_file(found
, sink_discard(), 0);
732 /* For unknown actions check that they aren't evil */
733 if(!dcgi_valid_action(name
))
734 fatal(0, "invalid action name '%s'", name
);
735 byte_xasprintf((char **)&p
, "%s.tmpl", name
);
736 if(!(found
= mx_find(p
, 0/*report*/)))
737 fatal(errno
, "cannot find %s", p
);
739 if(printf("Content-Type: text/html; charset=UTF-8\n"
741 "\n", dcgi_cookie_header()) < 0)
742 fatal(errno
, "error writing to stdout");
744 if(mx_expand_file(found
, sink_stdio("stdout", stdout
), 0) == -1
745 || fflush(stdout
) < 0)
746 fatal(errno
, "error writing to stdout");
749 /** @brief Execute a web action
750 * @param action Action to perform, or NULL to consult CGI args
752 * If no recognized action is specified then 'playing' is assumed.
754 void dcgi_action(const char *action
) {
757 /* Consult CGI args if caller had no view */
759 action
= cgi_get("action");
760 /* Pick a default if nobody cares at all */
762 /* We allow URLs which are just c=... in order to keep confirmation URLs,
763 * which are user-facing, as short as possible. Actually we could lose the
769 /* Make sure 'action' is always set */
770 cgi_set("action", action
);
772 if((n
= TABLE_FIND(actions
, name
, action
)) >= 0) {
773 if(actions
[n
].rights
) {
774 /* Some right or other is required */
775 dcgi_lookup(DCGI_RIGHTS
);
776 if(!(actions
[n
].rights
& dcgi_rights
)) {
777 const char *back
= cgi_thisurl(config
->url
);
778 /* Failed operations jump you to the login screen with an error
779 * message. On success, the user comes back to the page they were
782 cgi_set("back", back
);
783 login_error("noright");
787 /* It's a known action */
788 actions
[n
].handler();
790 /* Just expand the template */
791 dcgi_expand(action
, 1/*header*/);
795 /** @brief Generate an error page */
796 void dcgi_error(const char *key
) {
797 dcgi_error_string
= xstrdup(key
);
798 dcgi_expand("error", 1);