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_info {
  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_info 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_info *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 /* returns -E_PLAYLIST_LOADED on _success_ to terminate the loop */
  59 static int load_playlist(struct osl_row *row, void *data)
  60 {
  61         struct playlist_info *playlist = data;
  62         struct osl_object playlist_def;
  63         char *playlist_name;
  64         int ret;
  65
  66         ret = pl_get_name_and_def_by_row(row, &playlist_name, &playlist_def);
  67         if (ret < 0)
  68                 goto err;
  69         playlist->length = 0;
  70         ret = for_each_line(FELF_READ_ONLY, playlist_def.data,
  71                 playlist_def.size, add_playlist_entry, playlist);
  72         osl_close_disk_object(&playlist_def);
  73         if (ret < 0)
  74                 goto err;
  75         ret = -E_PLAYLIST_EMPTY;
  76         if (!playlist->length)
  77                 goto err;
  78         playlist->name = para_strdup(playlist_name);
  79         PARA_NOTICE_LOG("loaded playlist %s (%u files)\n", playlist->name,
  80                 playlist->length);
  81         return -E_PLAYLIST_LOADED;
  82 err:
  83         if (ret != -E_DUMMY_ROW)
  84                 PARA_NOTICE_LOG("unable to load playlist (%s)\n",
  85                         para_strerror(-ret));
  86         return 1;
  87 }
  88
  89 static int check_playlist_path(char *path, void *data)
  90 {
  91         struct para_buffer *pb = data;
  92         struct osl_row *aft_row;
  93         int ret = aft_get_row_of_path(path, &aft_row);
  94
  95         if (ret < 0)
  96                 para_printf(pb, "%s: %s\n", path, para_strerror(-ret));
  97         return 1; /* do not fail the loop on bad paths */
  98 }
  99
 100 static int check_playlist(struct osl_row *row, void *data)
 101 {
 102         struct para_buffer *pb = data;
 103         struct osl_object playlist_def;
 104         char *playlist_name;
 105         int ret = pl_get_name_and_def_by_row(row, &playlist_name, &playlist_def);
 106
 107         if (ret < 0) { /* log error, but continue */
 108                 para_printf(pb, "failed to get playlist data: %s\n",
 109                         para_strerror(-ret));
 110                 return 1;
 111         }
 112         if (*playlist_name) { /* skip dummy row */
 113                 para_printf(pb, "checking playlist %s...\n", playlist_name);
 114                 for_each_line(FELF_READ_ONLY, playlist_def.data,
 115                         playlist_def.size, check_playlist_path, pb);
 116         }
 117         osl_close_disk_object(&playlist_def);
 118         return 1;
 119 }
 120
 121 /**
 122  * Check the playlist table for inconsistencies.
 123  *
 124  * \param aca This callback ignores ->query.
 125  *
 126  * \return Standard. Invalid paths are reported, but are not considered an
 127  * error.
 128  */
 129 int playlist_check_callback(struct afs_callback_arg *aca)
 130 {
 131         para_printf(&aca->pbout, "checking playlists...\n");
 132         return osl(osl_rbtree_loop(playlists_table, BLOBCOL_ID, &aca->pbout,
 133                 check_playlist));
 134 }
 135
 136 /**
 137  * Close the current playlist.
 138  *
 139  * \sa \ref playlist_open().
 140  */
 141 void playlist_close(void)
 142 {
 143         if (!current_playlist.name)
 144                 return;
 145         free(current_playlist.name);
 146         current_playlist.name = NULL;
 147 }
 148
 149 /**
 150  * Open and load the given playlist.
 151  *
 152  * \param name The name of the playlist to open.
 153  * \param errmsg To be sent to the client (if called via select command).
 154  *
 155  * Files which are listed in the playlist, but not contained in the database
 156  * are ignored.  This is not considered an error.
 157  *
 158  * \return The length of the loaded playlist on success, negative error code
 159  * else.
 160  */
 161 int playlist_open(const char *name, char **errmsg)
 162 {
 163         struct osl_object obj;
 164         int ret;
 165         struct osl_row *row;
 166
 167         obj.data = (char *)name;
 168         obj.size = strlen(obj.data);
 169         ret = osl(osl_get_row(playlists_table, BLOBCOL_NAME, &obj, &row));
 170         if (ret < 0) {
 171                 if (errmsg)
 172                         *errmsg = make_message("could not open playlist %s",
 173                                 name);
 174                 return ret;
 175         }
 176         playlist_close();
 177         ret = load_playlist(row, &current_playlist);
 178         return (ret == -E_PLAYLIST_LOADED)? current_playlist.length : ret;
 179 }
 180
 181 static int search_path(char *path, void *data)
 182 {
 183         if (strcmp(path, data))
 184                 return 1;
 185         return -E_PATH_FOUND;
 186 }
 187
 188 static int handle_audio_file_event(enum afs_events event, void *data)
 189 {
 190         int ret;
 191         bool was_admissible = false, is_admissible;
 192         struct osl_object playlist_def;
 193         char *new_path;
 194         const struct osl_row *row = data;
 195
 196         if (event == AUDIO_FILE_RENAME) {
 197                 ret = row_belongs_to_score_table(row, NULL);
 198                 if (ret < 0)
 199                         return ret;
 200                 was_admissible = ret;
 201         }
 202         ret = get_audio_file_path_of_row(row, &new_path);
 203         if (ret < 0)
 204                 return ret;
 205         ret = pl_get_def_by_name(current_playlist.name, &playlist_def);
 206         if (ret < 0)
 207                 return ret;
 208         ret = for_each_line(FELF_READ_ONLY, playlist_def.data,
 209                 playlist_def.size, search_path, new_path);
 210         osl_close_disk_object(&playlist_def);
 211         is_admissible = (ret < 0);
 212         if (was_admissible && is_admissible)
 213                 return 1;
 214         if (!was_admissible && !is_admissible)
 215                 return 1;
 216         if (was_admissible && !is_admissible) {
 217                 current_playlist.length--;
 218                 return score_delete(row);
 219         }
 220         /* !was_admissible && is_admissible */
 221         current_playlist.length++;
 222         return score_add(row, 0); /* play it immediately */
 223 }
 224
 225 /**
 226  * Handle afs events relevant to playlists.
 227  *
 228  * \param event The event type.
 229  * \param pb Unused.
 230  * \param data Depends on the event type.
 231  *
 232  * \return Standard.
 233  */
 234 int playlists_event_handler(enum afs_events event,
 235         __a_unused struct para_buffer *pb, void *data)
 236 {
 237         int ret;
 238         struct afsi_change_event_data *aced = data;
 239
 240         if (!current_playlist.name)
 241                 return 1;
 242         switch (event) {
 243         case AFSI_CHANGE:
 244                 return playlist_update_audio_file(aced->aft_row);
 245         case AUDIO_FILE_RENAME:
 246         case AUDIO_FILE_ADD:
 247                 return handle_audio_file_event(event, data);
 248         case AUDIO_FILE_REMOVE:
 249                 ret = row_belongs_to_score_table(data, NULL);
 250                 if (ret < 0)
 251                         return ret;
 252                 if (!ret)
 253                         return 1;
 254                 current_playlist.length--;
 255                 return score_delete(data);
 256         default:
 257                 return 1;
 258         }
 259 }