afs.c: Introduce client list for afs (fixes dosable bug).
[paraslash.git] / afs.h
diff --git a/afs.h b/afs.h
index 1fb6a43..7167da4 100644 (file)
--- a/afs.h
+++ b/afs.h
 /*
- * Copyright (C) 2005-2007 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2007 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
-/** \file afs.h data structures common to all audio file selectors */
+#include <regex.h>
+#include "osl.h"
+#include "hash.h"
 
-#include <sys/select.h>
+/** Audio file selector data stored in the audio file table. */
+struct afs_info {
+       /** Seconds since the epoch. */
+       uint64_t last_played;
+       /** Bit field of set attributes. */
+       uint64_t attributes;
+       /** Counts how many times the file was selected. */
+       uint32_t num_played;
+       /** Image blob associated with this file (foreign key). */
+       uint32_t image_id;
+       /** Lyrics blob associated with this file (foreign key). */
+       uint32_t lyrics_id;
+       /** Mp3, ogg or aac. */
+       uint8_t audio_format_id;
+};
 
+enum afs_table_flags {TBLFLAG_SKIP_CREATE};
 
-int find_audio_files(const char *dirname, int (*f)(const char *, const char *));
+struct table_info {
+       const struct osl_table_description *desc;
+       enum afs_table_flags flags;
+};
 
-/**
- * describes one supported audio file selector
- *
- * There is one such struct for each supported selector.  During the startup
- * part of para_server the \a init() function of the activated selector gets
- * called which fills in all other function pointers.
- *
- */
-struct audio_file_selector {
-/**
- * name name of this selector
- */
-const char *name;
-/**
- * the init routine of the selector
- *
- * It should check its command line options and do all necessary initialization
- * like connecting to a database server.
- *
- * A negative return value indicates an initialization error and means that
- * this selector should be ignored for now (it may later be activated again via
- * the chs command).
- *
- * If \a init() returns success (non-negative return value), it must have
- * initialized in all non-optional function pointers of the given selector
- * struct. Moreover, \a cmd_list must point to a NULL-terminated array which
- * holds the list of all commands that are supported by this selector.
- */
-int (*init)(struct audio_file_selector *self);
-/**
- * list of commands supported by this selector
- */
-struct server_command *cmd_list;
-/**
- * pointer to function returning list of at most \a num audio files to be
- * streamed next
- *
- * \a get_audio_file_list() must return a pointer to a array of at most \a num
- * char* pointers (terminated by a NULL pointer), or NULL on errors.  Both the
- * array and its contents must be dynamically allocated and are freed by the
- * caller.
- *
-*/
-char **(*get_audio_file_list)(unsigned int num);
-/**
- *
- * the update hook
- *
- * The \a update_audio_file pointer is optional and need not be supplied. In this
- * case it is not neccessary to init this pointer from within init(). If
- * \a update_audio_file is non-NULL, the function it points to gets called
- * whenever a new audio file was successfully loaded and is going to be
- * streamed by any of paraslash's senders. The full path of the audio file is
- * passed \a update_audio_file().
- *
- */
-void (*update_audio_file)(char *audio_file);
-/**
- *
- * shutdown this selector and free all resources
- *
- * This gets called whenever the audio file selector changes. The reason for
- * this change might be that some user sent the chs command, that para_server
- * receives the HUP signal, or that para_server shuts down. It is assumed to
- * succeed.
- */
-void (*shutdown)(void);
-/**
- *
- * add file descriptors to fd_sets
- *
- * The pre_select function of the activated selector gets called just before
- * para_server enters its main select loop. The selector may add its own file
- * descriptors to the \a rfds or the \a wfds set.
- *
- * \return The highest-numbered file descriptor which was added to either of
- * the two fd sets (or -1 if no file descriptors were added).
- *
- * \sa select(2)
- */
-int (*pre_select)(fd_set *rfds, fd_set *wfds);
-/**
- * handle the file descriptors which are ready for I/O
- *
- * If the pre_select hook added one ore more file descriptors to the read or write
- * set, this is the hook to check the result and do any I/O on those descriptors
- * which are ready for reading/writing.
- */
-void (*post_select)(fd_set *rfds, fd_set *wfds);
-/**
- * each selector has its private data pointer */
-void *private_data;
+enum play_mode {PLAY_MODE_MOOD, PLAY_MODE_PLAYLIST};
+
+struct audio_file_data {
+       enum play_mode current_play_mode;
+       long score;
+       struct afs_info afsi;
+       struct audio_format_info afhi;
+       char *path;
+       struct osl_object map;
+};
+
+enum pattern_match_flags {
+       PM_REVERSE_LOOP = 1,
+       PM_NO_PATTERN_MATCHES_EVERYTHING = 2,
+       PM_SKIP_EMPTY_NAME = 4,
 };
 
-int mysql_selector_init(struct audio_file_selector*);
-int playlist_selector_init(struct audio_file_selector*);
-int random_selector_init(struct audio_file_selector*);
+struct pattern_match_data {
+       struct osl_table *table;
+       unsigned loop_col_num;
+       unsigned match_col_num;
+       unsigned pm_flags;
+       int fnmatch_flags;
+       struct osl_object patterns;
+       void *data;
+       int (*action)(struct osl_table *table, struct osl_row *row, const char *name, void *data);
+};
+
+/* afs */
+typedef int callback_function(const struct osl_object *, struct osl_object *);
+__noreturn int afs_init(uint32_t cookie, int socket_fd);
+int send_callback_request(callback_function *f, struct osl_object *query,
+       struct osl_object *result);
+int send_standard_callback_request(int argc, char * const * const argv,
+               callback_function *f, struct osl_object *result);
+int send_option_arg_callback_request(struct osl_object *options,
+       int argc, char * const * const argv, callback_function *f,
+       struct osl_object *result);
+int stdin_command(int fd, struct osl_object *arg_obj, callback_function *f,
+               unsigned max_len, struct osl_object *result);
+int string_compare(const struct osl_object *obj1, const struct osl_object *obj2);
+int open_next_audio_file(struct audio_file_data *afd);
+int close_audio_file(struct audio_file_data *afd);
+int for_each_matching_row(struct pattern_match_data *pmd);
+
+/* score */
+int score_init(struct table_info *ti, const char *db);
+void score_shutdown(enum osl_close_flags flags);
+int admissible_file_loop(void *data, osl_rbtree_loop_func *func);
+int admissible_file_loop_reverse(void *data, osl_rbtree_loop_func *func);
+int score_get_best(struct osl_row **aft_row, long *score);
+int get_score_and_aft_row(struct osl_row *score_row, long *score, struct osl_row **aft_row);
+int score_add(const struct osl_row *row, long score);
+int score_update(const struct osl_row *aft_row, long new_score);
+int get_num_admissible_files(unsigned *num);
+int score_delete(const struct osl_row *aft_row);
+int row_belongs_to_score_table(const struct osl_row *aft_row);
+
+/* attribute */
+int attribute_init(struct table_info *ti, const char *db);
+void attribute_shutdown(enum osl_close_flags flags);
+void get_attribute_bitmap(const uint64_t *atts, char *buf); /* needed by com_ls() */
+int get_attribute_bitnum_by_name(const char *att_name, unsigned char *bitnum);
+int get_attribute_text(uint64_t *atts, const char *delim, char **text);
+
+/* aft */
+int aft_init(struct table_info *ti, const char *db);
+void aft_shutdown(enum osl_close_flags flags);
+int aft_get_row_of_path(const char *path, struct osl_row **row);
+int open_and_update_audio_file(struct osl_row *aft_row, struct audio_file_data *afd);
+int load_afsi(struct afs_info *afsi, struct osl_object *obj);
+void save_afsi(struct afs_info *afsi, struct osl_object *obj);
+int get_afsi_of_row(const struct osl_row *row, struct afs_info *afsi);
+int get_afhi_of_row(const struct osl_row *row, struct audio_format_info *afhi);
+int get_afsi_of_path(const char *path, struct afs_info *afsi);
+int get_audio_file_path_of_row(const struct osl_row *row, char **path);
+int get_afsi_object_of_row(const struct osl_row *row, struct osl_object *obj);
+int audio_file_loop(void *private_data, osl_rbtree_loop_func *func);
+int aft_check_callback(const struct osl_object *query, struct osl_object *result);
+
+/* mood */
+int change_current_mood(char *mood_name);
+void close_current_mood(void);
+int mood_update_audio_file(const struct osl_row *aft_row, struct afs_info *old_afsi);
+int reload_current_mood(void);
+int mood_delete_audio_file(const struct osl_row *aft_row);
+int mood_check_callback(__a_unused const struct osl_object *query,
+       struct osl_object *result);
+
+
+/* playlist */
+int playlist_open(char *name);
+void playlist_close(void);
+int playlist_update_audio_file(struct osl_row *aft_row);
+int playlist_check_callback(__a_unused const struct osl_object *query,
+       struct osl_object *result);
+
+/** evaluates to 1 if x < y, to -1 if x > y and to 0 if x == y */
+#define NUM_COMPARE(x, y) ((int)((x) < (y)) - (int)((x) > (y)))
+
+
+#define DECLARE_BLOB_SYMBOLS(table_name, cmd_prefix) \
+       int table_name ## _init(struct table_info *ti, const char *db); \
+       void table_name ## _shutdown(enum osl_close_flags flags); \
+       int cmd_prefix ## _get_name_by_id(uint32_t id, char **name); \
+       int cmd_prefix ## _get_def_by_id(uint32_t id, struct osl_object *def); \
+       int cmd_prefix ## _get_name_and_def_by_row(const struct osl_row *row, \
+               char **name, struct osl_object *def); \
+       extern struct osl_table *table_name ## _table;
+
+DECLARE_BLOB_SYMBOLS(lyrics, lyr);
+DECLARE_BLOB_SYMBOLS(images, img);
+DECLARE_BLOB_SYMBOLS(moods, mood);
+DECLARE_BLOB_SYMBOLS(playlists, pl);
+
+/** The columns of an abstract blob table. */
+enum blob_table_columns {
+       /** The identifier, a positive integer that never repeats. */
+       BLOBCOL_ID,
+       /** The unique name of the blob. */
+       BLOBCOL_NAME,
+       /** The actual blob contents. */
+       BLOBCOL_DEF,
+       /** A blob table has that many columns. */
+       NUM_BLOB_COLUMNS
+};
+
+#define DEFINE_BLOB_TABLE_DESC(table_name) \
+       struct osl_table_description table_name ## _table_desc = { \
+               .name = #table_name, \
+               .num_columns = NUM_BLOB_COLUMNS, \
+               .flags = OSL_LARGE_TABLE, \
+               .column_descriptions = blob_cols \
+       };
+
+#define DEFINE_BLOB_TABLE_PTR(table_name) struct osl_table *table_name ## _table;
+
+#define INIT_BLOB_TABLE(table_name) \
+       DEFINE_BLOB_TABLE_DESC(table_name); \
+       DEFINE_BLOB_TABLE_PTR(table_name);