2 * This file is part of DisOrder
3 * Copyright (C) 2008 Richard Kettlewell
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
21 /** @file server/schedule.c
22 * @brief Scheduled events
24 * @ref trackdb_scheduledb is a mapping from ID strings to encoded
25 * key-value pairs called 'actiondata'.
27 * Possible actiondata keys are:
28 * - @b when: when to perform this action (required)
29 * - @b who: originator for action (required)
30 * - @b action: action to perform (required)
31 * - @b track: for @c action=play, the track to play
32 * - @b key: for @c action=set-global, the global pref to set
33 * - @b value: for @c action=set-global, the value to set (omit to unset)
34 * - @b priority: the importance of this action
35 * - @b recurs: how the event recurs; NOT IMPLEMENTED
36 * - ...others to be defined
38 * Possible actions are:
39 * - @b play: play a track
40 * - @b set-global: set or unset a global pref
41 * - ...others to be defined
43 * Possible priorities are:
44 * - @b junk: junk actions that are in the past at startup are discarded
45 * - @b normal: normal actions that are in the past at startup are run
46 * immediately. (This the default.)
47 * - ...others to be defined
49 * On startup the schedule database is read and a timeout set on the event loop
50 * for each action. Similarly when an action is added, a timeout is set on the
51 * event loop. The timeout has the ID attached as user data so that the action
52 * can easily be found again.
54 * Recurring events are NOT IMPLEMENTED yet but this is the proposed
57 * Recurring events are updated with a new 'when' field when they are processed
58 * (event on error). Non-recurring events are just deleted after processing.
60 * The recurs field is a whitespace-delimited list of criteria:
61 * - nn:nn or nn:nn:nn define a time of day, in local time. There must be
62 * at least one of these but can be more than one.
63 * - a day name (monday, tuesday, ...) defines the days of the week on
64 * which the event will recur. There can be more than one.
65 * - a day number and month name (1 january, 5 february, ...) defines
66 * the days of the year on which the event will recur. There can be
67 * more than one of these.
69 * Day and month names are case insensitive. Multiple languages are
70 * likely to be supported, especially if people send me pointers to
71 * their month and day names. Abbreviations are NOT supported, as
72 * there is more of a risk of a clash between different languages that
75 * If there are no week or year days then the event recurs every day.
77 * If there are both week and year days then the union of them is
78 * taken, rather than the intersection.
80 * TODO: support recurring events.
82 * TODO: add disorder-dump support
94 #include "trackdb-int.h"
100 #include "server-queue.h"
107 static int schedule_trigger(ev_source *ev,
108 const struct timeval *now,
110 static int schedule_lookup(const char *id,
111 struct kvp *actiondata);
113 /** @brief List of required fields in a scheduled event */
114 static const char *const schedule_required[] = {"when", "who", "action"};
116 /** @brief Number of elements in @ref schedule_required */
117 #define NREQUIRED (int)(sizeof schedule_required / sizeof *schedule_required)
119 /** @brief Parse a scheduled event key and data
120 * @param k Pointer to key
121 * @param whenp Where to store timestamp
122 * @return 0 on success, non-0 on error
124 * Rejects entries that are invalid in various ways.
126 static int schedule_parse(const DBT *k,
129 struct kvp **actiondatap,
132 struct kvp *actiondata;
135 /* Reject bogus keys */
136 if(!k->size || k->size > 128) {
137 error(0, "bogus schedule.db key (%lu bytes)", (unsigned long)k->size);
140 id = xstrndup(k->data, k->size);
141 actiondata = kvp_urldecode(d->data, d->size);
142 /* Reject items without the required fields */
143 for(n = 0; n < NREQUIRED; ++n) {
144 if(!kvp_get(actiondata, schedule_required[n])) {
145 error(0, "scheduled event %s: missing required field '%s'",
146 id, schedule_required[n]);
150 /* Return the results */
154 *actiondatap = actiondata;
156 *whenp = (time_t)atoll(kvp_get(actiondata, "when"));
160 /** @brief Delete via a cursor
161 * @return 0 or @c DB_LOCK_DEADLOCK */
162 static int cdel(DBC *cursor) {
165 switch(err = cursor->c_del(cursor, 0)) {
168 case DB_LOCK_DEADLOCK:
169 error(0, "error deleting from schedule.db: %s", db_strerror(err));
172 fatal(0, "error deleting from schedule.db: %s", db_strerror(err));
177 /** @brief Initialize the schedule
178 * @param ev Event loop
179 * @param tid Transaction ID
181 * Sets a callback for all action times except for junk actions that are
182 * already in the past, which are discarded.
184 static int schedule_init_tid(ev_source *ev,
190 cursor = trackdb_opencursor(trackdb_scheduledb, tid);
191 while(!(err = cursor->c_get(cursor, prepare_data(&k), prepare_data(&d),
194 struct kvp *actiondata;
197 /* Parse the key. We destroy bogus entries on sight. */
198 if(schedule_parse(&k, &d, &id, &actiondata, &when.tv_sec)) {
199 if((err = cdel(cursor)))
204 /* The action might be in the past */
205 if(when.tv_sec < time(0)) {
206 const char *priority = kvp_get(actiondata, "priority");
208 if(priority && !strcmp(priority, "junk")) {
209 /* Junk actions that are in the past are discarded during startup */
210 /* TODO recurring events should be handled differently here */
217 /* Arrange a callback when the scheduled event is due */
218 ev_timeout(ev, 0/*handlep*/, &when, schedule_trigger, id);
224 case DB_LOCK_DEADLOCK:
225 error(0, "error querying schedule.db: %s", db_strerror(err));
228 fatal(0, "error querying schedule.db: %s", db_strerror(err));
231 if(trackdb_closecursor(cursor))
232 err = DB_LOCK_DEADLOCK;
236 /** @brief Initialize the schedule
237 * @param ev Event loop
239 * Sets a callback for all action times except for junk actions that are
240 * already in the past, which are discarded.
242 void schedule_init(ev_source *ev) {
244 WITH_TRANSACTION(schedule_init_tid(ev, tid));
247 /******************************************************************************/
249 /** @brief Create a scheduled event
250 * @param ev Event loop
251 * @param actiondata Action data
253 * The caller should set the timeout themselves.
255 static int schedule_add_tid(const char *id,
256 struct kvp *actiondata,
261 memset(&k, 0, sizeof k);
264 switch(err = trackdb_scheduledb->put(trackdb_scheduledb, tid, &k,
265 encode_data(&d, actiondata), 0)) {
268 case DB_LOCK_DEADLOCK:
269 error(0, "error updating schedule.db: %s", db_strerror(err));
274 fatal(0, "error updating schedule.db: %s", db_strerror(err));
279 /** @brief Create a scheduled event
280 * @param ev Event loop
281 * @param actiondata Action actiondata
282 * @return Scheduled event ID or NULL on error
284 * Events are rejected if they lack the required fields, if the user
285 * is not allowed to perform them or if they are scheduled for a time
288 char *schedule_add(ev_source *ev,
289 struct kvp *actiondata) {
294 /* TODO: handle recurring events */
295 /* Check that the required field are present */
296 for(n = 0; n < NREQUIRED; ++n) {
297 if(!kvp_get(actiondata, schedule_required[n])) {
298 error(0, "new scheduled event is missing required field '%s'",
299 schedule_required[n]);
303 /* Check that the user is allowed to do whatever it is */
304 if(schedule_lookup("[new]", actiondata) < 0)
306 when.tv_sec = atoll(kvp_get(actiondata, "when"));
308 /* Reject events in the past */
309 if(when.tv_sec <= time(0)) {
310 error(0, "new scheduled event is in the past");
315 WITH_TRANSACTION(schedule_add_tid(id, actiondata, tid));
316 } while(e == DB_KEYEXIST);
317 ev_timeout(ev, 0/*handlep*/, &when, schedule_trigger, id);
321 /******************************************************************************/
323 /** @brief Get the action data for a scheduled event
325 * @return Event data or NULL
327 struct kvp *schedule_get(const char *id) {
329 struct kvp *actiondata;
331 WITH_TRANSACTION(trackdb_getdata(trackdb_scheduledb, id, &actiondata, tid));
332 /* Check that the required field are present */
333 for(n = 0; n < NREQUIRED; ++n) {
334 if(!kvp_get(actiondata, schedule_required[n])) {
335 error(0, "scheduled event %s is missing required field '%s'",
336 id, schedule_required[n]);
343 /******************************************************************************/
345 /** @brief Delete a scheduled event
346 * @param id Event to delete
347 * @return 0 on success, non-0 if it did not exist
349 int schedule_del(const char *id) {
352 WITH_TRANSACTION(trackdb_delkey(trackdb_scheduledb, id, tid));
353 return e == 0 ? 0 : -1;
356 /******************************************************************************/
358 /** @brief Get a list of scheduled events
359 * @param neventsp Where to put count of events (or NULL)
360 * @return 0-terminate list of ID strings
362 char **schedule_list(int *neventsp) {
367 WITH_TRANSACTION(trackdb_listkeys(trackdb_scheduledb, v, tid));
373 /******************************************************************************/
375 static void schedule_play(ev_source *ev,
378 struct kvp *actiondata) {
379 const char *track = kvp_get(actiondata, "track");
380 struct queue_entry *q;
382 /* This stuff has rather a lot in common with c_play() */
384 error(0, "scheduled event %s: no track field", id);
387 if(!trackdb_exists(track)) {
388 error(0, "scheduled event %s: no such track as %s", id, track);
391 if(!(track = trackdb_resolve(track))) {
392 error(0, "scheduled event %s: cannot resolve track %s", id, track);
395 info("scheduled event %s: %s play %s", id, who, track);
396 q = queue_add(track, who, WHERE_START);
398 if(q == qhead.next && playing)
403 static void schedule_set_global(ev_source attribute((unused)) *ev,
406 struct kvp *actiondata) {
407 const char *key = kvp_get(actiondata, "key");
408 const char *value = kvp_get(actiondata, "value");
411 error(0, "scheduled event %s: no key field", id);
415 error(0, "scheduled event %s: cannot set internal global preferences (%s)",
420 info("scheduled event %s: %s set-global %s=%s", id, who, key, value);
422 info("scheduled event %s: %s set-global %s unset", id, who, key);
423 trackdb_set_global(key, value, who);
426 /** @brief Table of schedule actions
428 * Must be kept sorted.
432 void (*callback)(ev_source *ev,
433 const char *id, const char *who,
434 struct kvp *actiondata);
436 } schedule_actions[] = {
437 { "play", schedule_play, RIGHT_PLAY },
438 { "set-global", schedule_set_global, RIGHT_GLOBAL_PREFS },
441 /** @brief Look up a scheduled event
442 * @param actiondata Event description
443 * @return index in schedule_actions[] on success, -1 on error
445 * Unknown events are rejected as are those that the user is not allowed to do.
447 static int schedule_lookup(const char *id,
448 struct kvp *actiondata) {
449 const char *who = kvp_get(actiondata, "who");
450 const char *action = kvp_get(actiondata, "action");
452 struct kvp *userinfo;
456 /* Look up the action */
457 n = TABLE_FIND(schedule_actions, typeof(schedule_actions[0]), name, action);
459 error(0, "scheduled event %s: unrecognized action '%s'", id, action);
463 if(!(userinfo = trackdb_getuserinfo(who))) {
464 error(0, "scheduled event %s: user '%s' does not exist", id, who);
467 /* Check that they have suitable rights */
468 if(!(rights = kvp_get(userinfo, "rights"))) {
469 error(0, "scheduled event %s: user %s' has no rights???", id, who);
472 if(parse_rights(rights, &r, 1)) {
473 error(0, "scheduled event %s: user %s has invalid rights '%s'",
477 if(!(r & schedule_actions[n].right)) {
478 error(0, "scheduled event %s: user %s lacks rights for action %s",
485 /** @brief Called when an action is due */
486 static int schedule_trigger(ev_source *ev,
487 const struct timeval attribute((unused)) *now,
489 const char *action, *id = u;
490 struct kvp *actiondata = schedule_get(id);
495 /* schedule_get() enforces these being present */
496 action = kvp_get(actiondata, "action");
497 /* Look up the action */
498 n = schedule_lookup(id, actiondata);
501 /* Go ahead and do it */
502 schedule_actions[n].callback(ev, id, kvp_get(actiondata, "who"), actiondata);
504 /* TODO: rewrite recurring events for their next trigger time,
505 * rather than deleting them */