command_util: Generate properly documented command header files.
[paraslash.git] / mood.c
diff --git a/mood.c b/mood.c
index 56ee1c43b5af30b6da5766e8c1c23ff2a67f40bb..32a10e56503147819cbe0a27d3e2e96c1293de6e 100644 (file)
--- a/mood.c
+++ b/mood.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2007 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2007-2009 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -7,12 +7,14 @@
 /** \file mood.c Paraslash's mood handling functions. */
 
 #include <fnmatch.h>
+#include <osl.h>
 #include "para.h"
 #include "error.h"
+#include "string.h"
 #include "afh.h"
 #include "afs.h"
 #include "list.h"
-#include "string.h"
+#include "ipc.h"
 
 /**
  * Contains statistical data of the currently admissible audio files.
@@ -36,18 +38,18 @@ struct afs_statistics statistics;
 /**
  * Assign scores according to a mood_method.
  *
- * Each mood_method has its own mood_score_function. The first parameter passed
- * to that function is a pointer to a row of the audio file table.  It
- * determines the audio file for which a score is to be assigned.  The second
- * argument depends on the mood method this function is used for. It usually is
- * the argument given at the end of a mood line.
+ * Each mood_method has its own mood_score_function. The first three parameters
+ * passed to that function are informations about the audio file whose score is
+ * to be computed. The data argument depends on the mood method this function
+ * is used for. It usually is the argument given at the end of a mood line.
  *
  * Mood score functions must return values between -100 and +100 inclusively.
  * Boolean score functions should always return either -100 or +100.
  *
  * \sa struct mood_method, mood_parser.
  */
-typedef int mood_score_function(const struct osl_row*, void *);
+typedef int mood_score_function(const char *path, const struct afs_info *afsi,
+               const struct afh_info *afhi, const void *data);
 
 /**
  * Pre-process a mood line.
@@ -83,7 +85,7 @@ typedef void mood_cleanup_function(void *);
  * Used for scoring and to determine whether a file is admissible.
  */
 struct mood_method {
-       /* The name of the method. */
+       /** The name of the method. */
        const char *name;
        /** Pointer to the mood parser. */
        mood_parser *parser;
@@ -163,19 +165,34 @@ static uint64_t int_sqrt(uint64_t x)
        return res;
 }
 
-static int mm_played_rarely_score_function(const struct osl_row *row,
-       __a_unused void *ignored)
+static int mm_no_attributes_set_parser(const char *arg, __a_unused void **ignored)
+{
+       if (arg && *arg)
+               PARA_WARNING_LOG("ignored junk at eol: %s\n", arg);
+       return 1;
+}
+
+static int mm_no_attributes_set_score_function(__a_unused const char *path,
+               const struct afs_info *afsi,
+               __a_unused const struct afh_info *afhi,
+               __a_unused const void *data)
+{
+       if (!afsi->attributes)
+               return 100;
+       return -100;
+}
+
+static int mm_played_rarely_score_function(__a_unused const char *path,
+               const struct afs_info *afsi,
+               __a_unused const struct afh_info *afhi,
+               __a_unused const void *data)
 {
-       struct afs_info afsi;
        unsigned num;
-       int ret = get_afsi_of_row(row, &afsi);
+       int ret = get_num_admissible_files(&num);
 
        if (ret < 0)
                return 0;
-       ret = get_num_admissible_files(&num);
-       if (ret < 0)
-               return 0;
-       if (statistics.num_played_sum - num * afsi.num_played
+       if (statistics.num_played_sum - num * afsi->num_played
                        > int_sqrt(statistics.num_played_qd * num))
                return 100;
        return -100;
@@ -183,29 +200,28 @@ static int mm_played_rarely_score_function(const struct osl_row *row,
 
 static int mm_played_rarely_parser(const char *arg, __a_unused void **ignored)
 {
-       if (*arg)
+       if (arg && *arg)
                PARA_WARNING_LOG("ignored junk at eol: %s\n", arg);
        return 1;
 }
 
-static int mm_name_like_score_function(const struct osl_row *row, void *data)
+static int mm_path_matches_score_function(const char *path,
+               __a_unused const struct afs_info *afsi,
+               __a_unused const struct afh_info *afhi,
+               const void *data)
 {
-       char *path;
-       int ret = get_audio_file_path_of_row(row, &path);
-
-       if (ret < 0)
-               return 0;
-       ret = fnmatch(data, path, 0);
-       return ret? -100 : 100;
+       if (fnmatch(data, path, 0))
+               return -100;
+       return 100;
 }
 
-static int mm_name_like_parser(const char *arg, void **data)
+static int mm_path_matches_parser(const char *arg, void **data)
 {
        *data = para_strdup(arg);
        return 1;
 }
 
-static void mm_name_like_cleanup(void *data)
+static void mm_path_matches_cleanup(void *data)
 {
        free(data);
 }
@@ -222,28 +238,40 @@ static int mm_is_set_parser(const char *arg, void **bitnum)
        return ret;
 }
 
-static int mm_is_set_score_function(const struct osl_row *row, void *bitnum)
+static int mm_is_set_score_function(__a_unused const char *path,
+               __a_unused const struct afs_info *afsi,
+               __a_unused const struct afh_info *afhi,
+               const void *data)
 {
-       unsigned char *bn = bitnum;
-       struct afs_info afsi;
-       int ret = get_afsi_of_row(row, &afsi);
-
-       if (ret < 0)
-               return 0;
-       if (afsi.attributes & (1ULL << *bn))
+       const unsigned char *bn = data;
+       if (afsi->attributes & (1ULL << *bn))
                return 100;
        return -100;
 }
 
-/* returns 1 if row matches score item, -1 otherwise */
+/* returns 1 if row matches score item, negative otherwise */
 static int add_item_score(const struct osl_row *row, struct mood_item *item, long *score,
                long *score_arg_sum)
 {
-       int ret = 100;
+       struct afs_info afsi;
+       struct afh_info afhi;
+       char *path;
+       int ret;
 
        *score_arg_sum += item->random_score? 100 : PARA_ABS(item->score_arg);
+       ret = 100;
        if (item->method) {
-               ret = item->method->score_function(row, item->parser_data);
+               ret = get_afsi_of_row(row, &afsi);
+               if (ret< 0)
+                       return ret;
+               ret = get_afhi_of_row(row, &afhi);
+               if (ret< 0)
+                       return ret;
+               ret = get_audio_file_path_of_row(row, &path);
+               if (ret< 0)
+                       return ret;
+               ret = item->method->score_function(path, &afsi, &afhi,
+                       item->parser_data);
                if ((ret < 0 && !item->logical_not) || (ret >= 0 && item->logical_not))
                        return -1; /* no match */
        }
@@ -270,8 +298,6 @@ static int compute_mood_score(const struct osl_row *aft_row, struct mood *m,
        list_for_each_entry(item, &m->accept_list, mood_item_node)
                if (add_item_score(aft_row, item, &score, &score_arg_sum) > 0)
                        match = 1;
-       if (list_empty(&m->accept_list))
-               PARA_NOTICE_LOG("accrpt list empty\n");
        /* reject if there is no matching entry in the accept list */
        if (!match && !list_empty(&m->accept_list))
                return -E_NOT_ADMISSIBLE;
@@ -283,26 +309,21 @@ static int compute_mood_score(const struct osl_row *aft_row, struct mood *m,
        return 1;
 }
 
+#define DEFINE_MOOD_METHOD(_name) \
+.parser = mm_ ## _name ## _parser, \
+.score_function = mm_ ## _name ## _score_function, \
+.name = #_name
+
+#define DEFINE_MOOD_METHOD_WITH_CLEANUP(_name) \
+       DEFINE_MOOD_METHOD(_name), \
+       .cleanup = mm_ ## _name ## _cleanup
+
 static const struct mood_method mood_methods[] = {
-{
-       .parser = mm_played_rarely_parser,
-       .score_function = mm_played_rarely_score_function,
-       .name = "played_rarely"
-},
-{
-       .parser = mm_is_set_parser,
-       .score_function = mm_is_set_score_function,
-       .name = "is_set"
-},
-{
-       .parser = mm_name_like_parser,
-       .score_function = mm_name_like_score_function,
-       .cleanup = mm_name_like_cleanup,
-       .name = "name_like"
-},
-{
-       .parser = NULL
-}
+       {DEFINE_MOOD_METHOD(no_attributes_set)},
+       {DEFINE_MOOD_METHOD(played_rarely)},
+       {DEFINE_MOOD_METHOD(is_set)},
+       {DEFINE_MOOD_METHOD_WITH_CLEANUP(path_matches)},
+       {.parser = NULL}
 };
 
 static void cleanup_list_entry(struct mood_item *item)
@@ -353,8 +374,11 @@ enum mood_line_type {
        ML_SCORE
 };
 
+/** Data passed to the parser of a mood line. */
 struct mood_line_parser_data {
+       /** The mood this mood line belongs to. */
        struct mood *m;
+       /** The line number in the mood definition. */
        unsigned line_num;
 };
 
@@ -400,11 +424,13 @@ static int parse_mood_line(char *mood_line, void *data)
                w++;
                if (!*w)
                        goto out;
-               if (!strcmp(*w, "with")) {
-                       w++;
-                       if (!*w)
-                               goto out;
-               }
+               if (strcmp(*w, "with"))
+                       goto check_for_if;
+               w++;
+               if (!*w)
+                       goto out;
+               if (strcmp(*w, "score"))
+                       goto out;
        }
        if (mlt == ML_SCORE || !strcmp(*w, "score")) {
                ret = -E_MOOD_SYNTAX;
@@ -427,6 +453,7 @@ static int parse_mood_line(char *mood_line, void *data)
        w++;
        if (!*w)
                goto out;
+check_for_if:
        if (!strcmp(*w, "if")) {
                ret = -E_MOOD_SYNTAX;
                w++;
@@ -495,44 +522,14 @@ static int load_mood(const struct osl_row *mood_row, struct mood **m)
        osl_close_disk_object(&mood_def);
        if (ret < 0) {
                PARA_ERROR_LOG("unable to load mood %s: %s\n", mlpd.m->name,
-                       PARA_STRERROR(-ret));
+                       para_strerror(-ret));
                destroy_mood(mlpd.m);
                return ret;
        }
-       PARA_INFO_LOG("loaded mood %s\n", mlpd.m->name);
        *m = mlpd.m;
        return 1;
 }
 
-/*
- * Calls load_mood() and reverts its error value: It returns -E_MOOD_LOADED
- * on _success_, and 1 on errors. This way the loop over all moods stops at the
- * first valid mood.
- */
-static int load_mood_loop_func(struct osl_row *mood_row, void *data)
-{
-       struct mood **m = data;
-       int ret = load_mood(mood_row, m);
-       if (ret < 0) {
-               if (ret != -E_DUMMY_ROW)
-                       PARA_NOTICE_LOG("invalid mood (%d), trying next mood\n", ret);
-               return 1;
-       }
-       return -E_MOOD_LOADED;
-}
-
-static int load_first_available_mood(struct mood **m)
-{
-       int ret = osl_rbtree_loop(moods_table, BLOBCOL_NAME, m,
-               load_mood_loop_func);
-       if (ret == -E_MOOD_LOADED) /* success */
-               return 1;
-       if (ret < 0)
-               return ret; /* error */
-       PARA_NOTICE_LOG("no valid mood found\n");
-       return -E_NO_MOOD;
-}
-
 static int check_mood(struct osl_row *mood_row, void *data)
 {
        struct para_buffer *pb = data;
@@ -543,39 +540,47 @@ static int check_mood(struct osl_row *mood_row, void *data)
        int ret = mood_get_name_and_def_by_row(mood_row, &mood_name, &mood_def);
 
        if (ret < 0) {
-               para_printf(pb, "failed to get mood definition\n");
+               para_printf(pb, "failed to get mood definition: %s\n",
+                       para_strerror(-ret));
                return ret;
        }
        if (!*mood_name) /* ignore dummy row */
                goto out;
-       para_printf(pb, "checking mood %s...\n", mood_name);
+       ret = para_printf(pb, "checking mood %s...\n", mood_name);
+       if (ret < 0)
+               goto out;
        ret = for_each_line_ro(mood_def.data, mood_def.size,
                parse_mood_line, &mlpd);
        if (ret < 0)
                para_printf(pb, "%s line %u: %s\n", mood_name, mlpd.line_num,
-                       PARA_STRERROR(-ret));
+                       para_strerror(-ret));
 out:
        osl_close_disk_object(&mood_def);
-       return 1;
+       return ret;
 }
 
 /**
  * Check all moods for syntax errors.
  *
+ * \param fd The afs socket.
  * \param query Unused.
- * \param result: Contains check messages.
  */
-int mood_check_callback(__a_unused const struct osl_object *query,
-       struct osl_object *result)
+void mood_check_callback(int fd, __a_unused const struct osl_object *query)
 {
-       struct para_buffer pb = {.buf = NULL};
+       struct para_buffer pb = {
+               .max_size = SHMMAX,
+               .private_data = &fd,
+               .max_size_handler = pass_buffer_as_shm
+       };
 
-       para_printf(&pb, "checking moods...\n");
+       int ret = para_printf(&pb, "checking moods...\n");
+       if (ret < 0)
+               return;
        osl_rbtree_loop(moods_table, BLOBCOL_ID, &pb,
                check_mood);
-       result->data = pb.buf;
-       result->size = pb.size;
-       return 1;
+       if (pb.offset)
+               pass_buffer_as_shm(pb.buf, pb.offset, &fd);
+       free(pb.buf);
 }
 
 #if 0
@@ -833,13 +838,13 @@ static int delete_from_statistics_and_score_table(const struct osl_row *aft_row)
  *
  * \return Positive on success, negative on errors.
  *
- * \sa score_delete(), mood_update_audio_file().
+ * \sa score_delete().
  */
-int mood_delete_audio_file(const struct osl_row *aft_row)
+static int mood_delete_audio_file(const struct osl_row *aft_row)
 {
        int ret;
 
-       ret = row_belongs_to_score_table(aft_row);
+       ret = row_belongs_to_score_table(aft_row, NULL);
        if (ret < 0)
                return ret;
        if (!ret) /* not admissible, nothing to do */
@@ -858,15 +863,17 @@ int mood_delete_audio_file(const struct osl_row *aft_row)
  *
  * \return Positive on success, negative on errors.
  */
-int mood_update_audio_file(const struct osl_row *aft_row, struct afs_info *old_afsi)
+static int mood_update_audio_file(const struct osl_row *aft_row,
+               struct afs_info *old_afsi)
 {
        long score, percent;
        int ret, is_admissible, was_admissible = 0;
        struct afs_info afsi;
+       unsigned rank;
 
        if (!current_mood)
                return 1; /* nothing to do */
-       ret = row_belongs_to_score_table(aft_row);
+       ret = row_belongs_to_score_table(aft_row, &rank);
        if (ret < 0)
                return ret;
        was_admissible = ret;
@@ -900,7 +907,7 @@ int mood_update_audio_file(const struct osl_row *aft_row, struct afs_info *old_a
                percent = 100;
        else if (percent < 0)
                percent = 0;
-       PARA_DEBUG_LOG("re-inserting at %lu%%\n", percent);
+       PARA_DEBUG_LOG("moving from rank %u to %lu%%\n", rank, percent);
        return score_update(aft_row, percent);
 }
 
@@ -912,23 +919,35 @@ static void log_statistics(void)
                PARA_NOTICE_LOG("no admissible files\n");
                return;
        }
-       PARA_NOTICE_LOG("last_played mean: %lli, last_played sigma: %llu\n",
+       PARA_INFO_LOG("last_played mean: %lli, last_played sigma: %llu\n",
                (long long int)(statistics.last_played_sum / n),
                (long long unsigned)int_sqrt(statistics.last_played_qd / n));
-       PARA_NOTICE_LOG("num_played mean: %lli, num_played sigma: %llu\n",
+       PARA_INFO_LOG("num_played mean: %lli, num_played sigma: %llu\n",
                (long long int)statistics.num_played_sum / n,
                (long long unsigned)int_sqrt(statistics.num_played_qd / n));
 }
 
+/**
+ * Close the current mood.
+ *
+ * Free all resources of the current mood which were allocated during
+ * mood_open().
+ */
+void close_current_mood(void)
+{
+       destroy_mood(current_mood);
+       current_mood = NULL;
+       memset(&statistics, 0, sizeof(statistics));
+}
+
+
 /**
  * Change the current mood.
  *
  * \param mood_name The name of the mood to open.
  *
- * There are two special cases: If \a mood_name is \a NULL, load the
- * first available mood. If \a mood_name is the empty string "", load
- * the dummy mood that accepts every audio file and uses a scoring method
- * based only on the \a last_played information.
+ * If \a mood_name is \a NULL, load the dummy mood that accepts every audio file
+ * and uses a scoring method based only on the \a last_played information.
  *
  * If there is already an open mood, it will be closed first.
  *
@@ -946,21 +965,14 @@ int change_current_mood(char *mood_name)
                .array = NULL
        };
 
-       if (!mood_name) {
-               struct mood *m;
-               ret = load_first_available_mood(&m);
-               if (ret < 0)
-                       return ret;
-               destroy_mood(current_mood);
-               current_mood = m;
-       } else if (*mood_name) {
+       if (mood_name) {
                struct mood *m;
                struct osl_row *row;
                struct osl_object obj = {
                        .data = mood_name,
                        .size = strlen(mood_name) + 1
                };
-               ret = osl_get_row(moods_table, BLOBCOL_NAME, &obj, &row);
+               ret = osl(osl_get_row(moods_table, BLOBCOL_NAME, &obj, &row));
                if (ret < 0) {
                        PARA_NOTICE_LOG("no such mood: %s\n", mood_name);
                        return ret;
@@ -968,46 +980,31 @@ int change_current_mood(char *mood_name)
                ret = load_mood(row, &m);
                if (ret < 0)
                        return ret;
-               destroy_mood(current_mood);
+               close_current_mood();
                current_mood = m;
        } else {
-               destroy_mood(current_mood);
+               close_current_mood();
                current_mood = alloc_new_mood("dummy");
        }
        aa.m = current_mood;
-       PARA_NOTICE_LOG("loaded mood %s\n", current_mood->name);
-       PARA_INFO_LOG("%s\n", "computing statistics of admissible files");
+       PARA_NOTICE_LOG("computing statistics of admissible files\n");
        ret = audio_file_loop(&aa, add_if_admissible);
        if (ret < 0)
                return ret;
        log_statistics();
-       PARA_NOTICE_LOG("%d admissible files \n", statistics.num);
+       PARA_INFO_LOG("%d admissible files \n", statistics.num);
        for (i = 0; i < statistics.num; i++) {
                struct admissible_file_info *a = aa.array + i;
                ret = add_to_score_table(a->aft_row, a->score);
                if (ret < 0)
                        goto out;
        }
-       PARA_NOTICE_LOG("score add complete\n");
-       ret = 1;
+       PARA_NOTICE_LOG("loaded mood %s\n", current_mood->name);
+       ret = statistics.num;
 out:
        free(aa.array);
        return ret;
 }
-
-/**
- * Close the current mood.
- *
- * Free all resources of the current mood which were allocated during
- * mood_open().
- */
-void close_current_mood(void)
-{
-       destroy_mood(current_mood);
-       current_mood = NULL;
-       memset(&statistics, 0, sizeof(statistics));
-}
-
 /**
  * Close and re-open the current mood.
  *
@@ -1024,14 +1021,52 @@ void close_current_mood(void)
 int reload_current_mood(void)
 {
        int ret;
-       char *mood_name;
+       char *mood_name = NULL;
 
        if (!current_mood)
                return 1;
-       score_shutdown(0);
-       mood_name = para_strdup(current_mood->name);
+       PARA_NOTICE_LOG("reloading %s\n", current_mood->name?
+               current_mood->name : "(dummy)");
+       if (current_mood->name)
+               mood_name = para_strdup(current_mood->name);
        close_current_mood();
        ret = change_current_mood(mood_name);
        free(mood_name);
        return ret;
 }
+
+int moods_event_handler(enum afs_events event, __a_unused struct para_buffer *pb,
+               void *data)
+{
+       switch(event) {
+       /*
+        * The three blob events might change the set of admissible files,
+        * so we must reload the score list.
+        */
+       case BLOB_RENAME:
+       case BLOB_REMOVE:
+       case BLOB_ADD:
+               if (data == moods_table || data == playlists_table)
+                       return 1; /* no reload necessary for these */
+               return reload_current_mood();
+       /* these also require reload of the score table */
+       case ATTRIBUTE_ADD:
+       case ATTRIBUTE_REMOVE:
+       case ATTRIBUTE_RENAME:
+               return reload_current_mood();
+       /* changes to the aft only require to re-examine the audio file */
+       case AFSI_CHANGE: {
+               struct afsi_change_event_data *aced = data;
+               return mood_update_audio_file(aced->aft_row, aced->old_afsi);
+               }
+       case AFHI_CHANGE:
+       case AUDIO_FILE_RENAME:
+       case AUDIO_FILE_ADD:
+               return mood_update_audio_file(data, NULL);
+       case AUDIO_FILE_REMOVE:
+               return mood_delete_audio_file(data);
+       default:
+               return 1;
+       }
+}
+