Merge commit 'fml/master' into next
[paraslash.git] / mood.c
diff --git a/mood.c b/mood.c
index a8d87cd..239911f 100644 (file)
--- a/mood.c
+++ b/mood.c
@@ -1,18 +1,23 @@
 /*
- * 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.
  */
 
 /** \file mood.c Paraslash's mood handling functions. */
 
+#include <time.h>
+#include <regex.h>
 #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 "ipc.h"
 
 /**
  * Contains statistical data of the currently admissible audio files.
@@ -47,7 +52,7 @@ struct afs_statistics statistics;
  * \sa struct mood_method, mood_parser.
  */
 typedef int mood_score_function(const char *path, const struct afs_info *afsi,
-               const struct audio_format_info *afhi, const void *data);
+               const struct afh_info *afhi, const void *data);
 
 /**
  * Pre-process a mood line.
@@ -61,11 +66,11 @@ typedef int mood_score_function(const char *path, const struct afs_info *afsi,
  * Some mood parsers pre-process the data given in the mood line to compute a
  * structure which depends of the particular mood_method and which is used
  * later in the mood_score_function of the mood_method. The mood_parser may
- * store a pointer to its structure via the second argument.
+ * store a pointer to its structure via the void** pointer.
  *
  * \sa mood_open(), mood_cleanup_function, mood_score_function.
  */
-typedef int mood_parser(const char *, void **);
+typedef int mood_parser(int, char **, void **);
 
 /**
  * Deallocate resources which were allocated by the mood_parser.
@@ -83,7 +88,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,16 +168,131 @@ static uint64_t int_sqrt(uint64_t x)
        return res;
 }
 
-static int mm_no_attributes_set_parser(const char *arg, __a_unused void **ignored)
+#define MOOD_COMPARATORS \
+       MC(LESS, <) \
+       MC(LESS_OR_EQUAL, <=) \
+       MC(EQUAL, =) \
+       MC(EQUAL2, ==) \
+       MC(NOT_EQUAL, !=) \
+       MC(NOT_EQUAL2, <>) \
+       MC(GREATER, >) \
+       MC(GREATER_OR_EQUAL, >=) \
+
+#define MC(a, b) MC_ ## a,
+enum mood_comparator_id {MOOD_COMPARATORS NUM_MOOD_COMPARATORS};
+#undef MC
+#define MC(a, b) # b,
+const char const *mood_comparators[] = {MOOD_COMPARATORS};
+#undef MC
+
+static int parse_mood_comparator(const char *word)
 {
-       if (arg && *arg)
-               PARA_WARNING_LOG("ignored junk at eol: %s\n", arg);
+       int i;
+
+       for (i = 0; i < NUM_MOOD_COMPARATORS; i++)
+               if (!strcmp(word, mood_comparators[i]))
+                       return i;
+       return -E_MOOD_SYNTAX;
+}
+
+static int compare_int32(int32_t a, int32_t b, enum mood_comparator_id id)
+{
+       int res;
+
+       switch (id) {
+       case MC_LESS:
+               res = a < b; break;
+       case MC_LESS_OR_EQUAL:
+               res = a <= b; break;
+       case MC_EQUAL:
+       case MC_EQUAL2:
+               res = a == b; break;
+       case MC_NOT_EQUAL:
+       case MC_NOT_EQUAL2:
+               res = a != b; break;
+       case MC_GREATER:
+               res = a > b; break;
+       case MC_GREATER_OR_EQUAL:
+               res = a >= b; break;
+       default:
+               PARA_EMERG_LOG("BUG: invalid mood comparator\n");
+               exit(EXIT_FAILURE);
+       }
+       return res? 100 : -100;
+}
+
+struct mm_year_data {
+       /** The year given at the mood line. */
+       int32_t year;
+       /** Used to detect Y2K issues. */
+       int32_t current_year;
+       /** <, <=, =, !=, >=, or >. */
+       enum mood_comparator_id id;
+};
+
+static int mm_year_parser(int argc, char **argv, void **private)
+{
+       int ret = -E_MOOD_SYNTAX;
+       struct mm_year_data *mmyd = para_malloc(sizeof(*mmyd));
+       time_t current_time;
+       struct tm *gmt;
+
+       if (argc != 2)
+               goto err;
+       ret = parse_mood_comparator(argv[1]);
+       mmyd->id = ret;
+       if (ret < 0)
+               goto err;
+       ret = para_atoi32(argv[2], &mmyd->year);
+       if (ret < 0)
+               goto err;
+       current_time = time(NULL);
+       gmt = gmtime(&current_time);
+       /* tm_year is the number of years since 1900 */
+       mmyd->current_year = gmt->tm_year + 1900;
+       *private = mmyd;
        return 1;
+err:
+       free(mmyd);
+       return ret;
+}
+
+static int mm_year_score_function(__a_unused const char *path,
+               __a_unused const struct afs_info *afsi,
+               const struct afh_info *afhi,
+               const void *private)
+{
+       const struct mm_year_data *mmyd = private;
+       int32_t tag_year;
+       int ret = para_atoi32(afhi->tags.year, &tag_year);
+
+       if (ret < 0) /* year tag not present or not a number */
+               return -100;
+       if (tag_year < 0)
+               return -100;
+       /* try to work around Y2K issues */
+       if (tag_year < 100) {
+               tag_year += 1900;
+               if (tag_year + 100 <= mmyd->current_year)
+                       tag_year += 100; /* assume tag_year >= 2000 */
+       }
+       return compare_int32(tag_year, mmyd->year, mmyd->id);
+}
+
+static void mm_year_cleanup(void *private)
+{
+       free(private);
+}
+
+static int mm_no_attributes_set_parser(int argc, __a_unused char **argv,
+               __a_unused void **ignored)
+{
+       return argc? -E_MOOD_SYNTAX : 1;
 }
 
 static int mm_no_attributes_set_score_function(__a_unused const char *path,
                const struct afs_info *afsi,
-               __a_unused const struct audio_format_info *afhi,
+               __a_unused const struct afh_info *afhi,
                __a_unused const void *data)
 {
        if (!afsi->attributes)
@@ -182,7 +302,7 @@ static int mm_no_attributes_set_score_function(__a_unused const char *path,
 
 static int mm_played_rarely_score_function(__a_unused const char *path,
                const struct afs_info *afsi,
-               __a_unused const struct audio_format_info *afhi,
+               __a_unused const struct afh_info *afhi,
                __a_unused const void *data)
 {
        unsigned num;
@@ -196,16 +316,15 @@ static int mm_played_rarely_score_function(__a_unused const char *path,
        return -100;
 }
 
-static int mm_played_rarely_parser(const char *arg, __a_unused void **ignored)
+static int mm_played_rarely_parser(int argc, __a_unused char **argv,
+               __a_unused void **ignored)
 {
-       if (arg && *arg)
-               PARA_WARNING_LOG("ignored junk at eol: %s\n", arg);
-       return 1;
+       return argc? -E_MOOD_SYNTAX : 1;
 }
 
-static int mm_name_like_score_function(const char *path,
+static int mm_path_matches_score_function(const char *path,
                __a_unused const struct afs_info *afsi,
-               __a_unused const struct audio_format_info *afhi,
+               __a_unused const struct afh_info *afhi,
                const void *data)
 {
        if (fnmatch(data, path, 0))
@@ -213,32 +332,38 @@ static int mm_name_like_score_function(const char *path,
        return 100;
 }
 
-static int mm_name_like_parser(const char *arg, void **data)
+static int mm_path_matches_parser(int argc, char **argv, void **data)
 {
-       *data = para_strdup(arg);
+       if (argc != 1)
+               return -E_MOOD_SYNTAX;
+       *data = para_strdup(argv[1]);
        return 1;
 }
 
-static void mm_name_like_cleanup(void *data)
+static void mm_path_matches_cleanup(void *data)
 {
        free(data);
 }
 
-static int mm_is_set_parser(const char *arg, void **bitnum)
+static int mm_is_set_parser(int argc, char **argv, void **bitnum)
 {
-       unsigned char *c = para_malloc(1);
-       int ret = get_attribute_bitnum_by_name(arg, c);
+       int ret;
+       unsigned char c, *res;
 
-       if (ret >= 0)
-               *bitnum = c;
-       else
-               free(c);
-       return ret;
+       if (argc != 1)
+               return -E_MOOD_SYNTAX;
+       ret = get_attribute_bitnum_by_name(argv[1], &c);
+       if (ret < 0)
+               return ret;
+       res = para_malloc(1);
+       *res = c;
+       *bitnum = res;
+       return 1;
 }
 
 static int mm_is_set_score_function(__a_unused const char *path,
                __a_unused const struct afs_info *afsi,
-               __a_unused const struct audio_format_info *afhi,
+               __a_unused const struct afh_info *afhi,
                const void *data)
 {
        const unsigned char *bn = data;
@@ -252,7 +377,7 @@ static int add_item_score(const struct osl_row *row, struct mood_item *item, lon
                long *score_arg_sum)
 {
        struct afs_info afsi;
-       struct audio_format_info afhi;
+       struct afh_info afhi;
        char *path;
        int ret;
 
@@ -320,7 +445,8 @@ static const struct mood_method mood_methods[] = {
        {DEFINE_MOOD_METHOD(no_attributes_set)},
        {DEFINE_MOOD_METHOD(played_rarely)},
        {DEFINE_MOOD_METHOD(is_set)},
-       {DEFINE_MOOD_METHOD_WITH_CLEANUP(name_like)},
+       {DEFINE_MOOD_METHOD_WITH_CLEANUP(path_matches)},
+       {DEFINE_MOOD_METHOD_WITH_CLEANUP(year)},
        {.parser = NULL}
 };
 
@@ -372,8 +498,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;
 };
 
@@ -388,17 +517,17 @@ static int parse_mood_line(char *mood_line, void *data)
 {
        struct mood_line_parser_data *mlpd = data;
        char **argv;
-       char *delim = " \t";
        unsigned num_words;
        char **w;
        int i, ret;
        enum mood_line_type mlt = ML_INVALID;
        struct mood_item *mi = NULL;
-       char *buf = para_strdup(mood_line);
 
        mlpd->line_num++;
-       num_words = split_args(buf, &argv, delim);
-       ret = 1;
+       ret = create_argv(mood_line, " \t", &argv);
+       if (ret < 0)
+               return ret;
+       num_words = ret;
        if (!num_words) /* empty line */
                goto out;
        w = argv;
@@ -419,11 +548,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;
@@ -446,6 +577,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++;
@@ -468,8 +600,8 @@ static int parse_mood_line(char *mood_line, void *data)
        ret = -E_MOOD_SYNTAX;
        if (!mood_methods[i].parser)
                goto out;
-       w++;
-       ret = mood_methods[i].parser(*w, &mi->parser_data);
+       ret = mood_methods[i].parser(num_words - 1 - (w - argv), w,
+               &mi->parser_data);
        if (ret < 0)
                goto out;
        mi->method = &mood_methods[i];
@@ -486,8 +618,7 @@ success:
                (mlt == ML_DENY? "deny" : "score"), mi->method);
        ret = 1;
 out:
-       free(argv);
-       free(buf);
+       free_argv(argv);
        if (ret >= 0)
                return ret;
        if (mi) {
@@ -514,44 +645,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;
@@ -562,39 +663,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
@@ -933,23 +1042,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.
  *
@@ -967,21 +1088,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;
@@ -989,46 +1103,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().
- */
-static void close_current_mood(void)
-{
-       destroy_mood(current_mood);
-       current_mood = NULL;
-       memset(&statistics, 0, sizeof(statistics));
-}
-
 /**
  * Close and re-open the current mood.
  *
@@ -1045,25 +1144,40 @@ static void close_current_mood(void)
 int reload_current_mood(void)
 {
        int ret;
-       char *mood_name;
+       char *mood_name = NULL;
 
        if (!current_mood)
                return 1;
-       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, struct para_buffer *pb,
+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);
@@ -1077,6 +1191,5 @@ int moods_event_handler(enum afs_events event, struct para_buffer *pb,
        default:
                return 1;
        }
-       return 1;
 }