playlist.c

   1 /* Copyright (C) 2007 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
   2
   3 #include <regex.h>
   4 #include <osl.h>
   5 #include <lopsub.h>
   6
   7 #include "para.h"
   8 #include "error.h"
   9 #include "string.h"
  10 #include "afh.h"
  11 #include "afs.h"
  12 #include "ipc.h"
  13 #include "sideband.h"
  14
  15 /** \file playlist.c Functions for loading and saving playlists. */
  16
  17 /** Structure used for adding entries to a playlist. */
  18 struct playlist_instance {
  19         /** The name of the playlist. */
  20         char *name;
  21         /** The number of entries currently in the playlist. */
  22         unsigned length;
  23 };
  24 static struct playlist_instance current_playlist;
  25
  26 /**
  27  * Re-insert an audio file into the tree of admissible files.
  28  *
  29  * \param aft_row Determines the audio file.
  30  *
  31  * \return The return value of score_update().
  32  */
  33 static int playlist_update_audio_file(const struct osl_row *aft_row)
  34 {
  35         /* always re-insert to the top of the tree */
  36         return score_update(aft_row, 0);
  37 }
  38
  39 static int add_playlist_entry(char *path, void *data)
  40 {
  41         struct playlist_instance *playlist = data;
  42         struct osl_row *aft_row;
  43         int ret = aft_get_row_of_path(path, &aft_row);
  44
  45         if (ret < 0) {
  46                 PARA_NOTICE_LOG("%s: %s\n", path, para_strerror(-ret));
  47                 return 1;
  48         }
  49         ret = score_add(aft_row, -playlist->length);
  50         if (ret < 0) {
  51                 PARA_ERROR_LOG("failed to add %s: %s\n", path, para_strerror(-ret));
  52                 return ret;
  53         }
  54         playlist->length++;
  55         return 1;
  56 }
  57
  58 static int check_playlist_path(char *path, void *data)
  59 {
  60         struct para_buffer *pb = data;
  61         struct osl_row *aft_row;
  62         int ret = aft_get_row_of_path(path, &aft_row);
  63
  64         if (ret < 0)
  65                 para_printf(pb, "%s: %s\n", path, para_strerror(-ret));
  66         return 1; /* do not fail the loop on bad paths */
  67 }
  68
  69 static int check_playlist(struct osl_row *row, void *data)
  70 {
  71         struct para_buffer *pb = data;
  72         struct osl_object playlist_def;
  73         char *playlist_name;
  74         int ret = pl_get_name_and_def_by_row(row, &playlist_name, &playlist_def);
  75
  76         if (ret < 0) { /* log error, but continue */
  77                 para_printf(pb, "failed to get playlist data: %s\n",
  78                         para_strerror(-ret));
  79                 return 1;
  80         }
  81         if (*playlist_name) { /* skip dummy row */
  82                 para_printf(pb, "checking playlist %s...\n", playlist_name);
  83                 for_each_line(FELF_READ_ONLY, playlist_def.data,
  84                         playlist_def.size, check_playlist_path, pb);
  85         }
  86         osl_close_disk_object(&playlist_def);
  87         return 1;
  88 }
  89
  90 /**
  91  * Check the playlist table for inconsistencies.
  92  *
  93  * \param aca This callback ignores ->query.
  94  *
  95  * \return Standard. Invalid paths are reported, but are not considered an
  96  * error.
  97  */
  98 int playlist_check_callback(struct afs_callback_arg *aca)
  99 {
 100         para_printf(&aca->pbout, "checking playlists...\n");
 101         return osl(osl_rbtree_loop(playlists_table, BLOBCOL_ID, &aca->pbout,
 102                 check_playlist));
 103 }
 104
 105 /** Free all resources of the current playlist, if any. */
 106 void playlist_unload(void)
 107 {
 108         if (!current_playlist.name)
 109                 return;
 110         free(current_playlist.name);
 111         current_playlist.name = NULL;
 112         current_playlist.length = 0;
 113 }
 114
 115 /**
 116  * Populate the score table from the paths of a playlist database object.
 117  *
 118  * This loads the blob object which corresponds to the given name from the
 119  * playlist table. Each line of the blob is regarded as a path which is looked
 120  * up in the audio file table. If the path lookup succeeds, a reference to the
 121  * corresponding row of the audio file table is added to the score table.
 122  *
 123  * \param name The name of the playlist to load.
 124  * \param msg Error message or playlist info is returned here.
 125  *
 126  * \return The length of the loaded playlist on success, negative error code
 127  * else. Files which are listed in the playlist, but are not contained in the
 128  * database are ignored. This is not considered an error.
 129  */
 130 int playlist_load(const char *name, char **msg)
 131 {
 132         int ret;
 133         struct playlist_instance *playlist = &current_playlist;
 134         struct osl_object playlist_def;
 135
 136         ret = pl_get_def_by_name(name, &playlist_def);
 137         if (ret < 0) {
 138                 *msg = make_message("could not read playlist %s\n", name);
 139                 return ret;
 140         }
 141         playlist_unload();
 142         ret = for_each_line(FELF_READ_ONLY, playlist_def.data,
 143                 playlist_def.size, add_playlist_entry, playlist);
 144         osl_close_disk_object(&playlist_def);
 145         if (ret < 0)
 146                 goto err;
 147         ret = -E_PLAYLIST_EMPTY;
 148         if (!playlist->length)
 149                 goto err;
 150         playlist->name = para_strdup(name);
 151         *msg = make_message("loaded playlist %s (%u files)\n", playlist->name,
 152                 playlist->length);
 153         /* success */
 154         return current_playlist.length;
 155 err:
 156         PARA_NOTICE_LOG("unable to load playlist %s\n", name);
 157         *msg = make_message("unable to load playlist %s\n", name);
 158         return ret;
 159 }
 160
 161 static int search_path(char *path, void *data)
 162 {
 163         if (strcmp(path, data))
 164                 return 1;
 165         return -E_PATH_FOUND;
 166 }
 167
 168 static int handle_audio_file_event(enum afs_events event, void *data)
 169 {
 170         int ret;
 171         bool was_admissible = false, is_admissible;
 172         struct osl_object playlist_def;
 173         char *new_path;
 174         const struct osl_row *row = data;
 175
 176         if (event == AUDIO_FILE_RENAME)
 177                 was_admissible = row_belongs_to_score_table(row);
 178         ret = get_audio_file_path_of_row(row, &new_path);
 179         if (ret < 0)
 180                 return ret;
 181         ret = pl_get_def_by_name(current_playlist.name, &playlist_def);
 182         if (ret < 0)
 183                 return ret;
 184         ret = for_each_line(FELF_READ_ONLY, playlist_def.data,
 185                 playlist_def.size, search_path, new_path);
 186         osl_close_disk_object(&playlist_def);
 187         is_admissible = (ret < 0);
 188         if (was_admissible && is_admissible)
 189                 return 1;
 190         if (!was_admissible && !is_admissible)
 191                 return 1;
 192         if (was_admissible && !is_admissible) {
 193                 current_playlist.length--;
 194                 return score_delete(row);
 195         }
 196         /* !was_admissible && is_admissible */
 197         current_playlist.length++;
 198         return score_add(row, 0); /* play it immediately */
 199 }
 200
 201 /**
 202  * Handle afs events relevant to playlists.
 203  *
 204  * \param event The event type.
 205  * \param pb Unused.
 206  * \param data Depends on the event type.
 207  *
 208  * \return Standard.
 209  */
 210 int playlists_event_handler(enum afs_events event,
 211         __a_unused struct para_buffer *pb, void *data)
 212 {
 213         struct afsi_change_event_data *aced = data;
 214
 215         if (!current_playlist.name)
 216                 return 1;
 217         switch (event) {
 218         case AFSI_CHANGE:
 219                 return playlist_update_audio_file(aced->aft_row);
 220         case AUDIO_FILE_RENAME:
 221         case AUDIO_FILE_ADD:
 222                 return handle_audio_file_event(event, data);
 223         case AUDIO_FILE_REMOVE:
 224                 if (!row_belongs_to_score_table(data))
 225                         return 1;
 226                 current_playlist.length--;
 227                 return score_delete(data);
 228         default:
 229                 return 1;
 230         }
 231 }