playlist.c

   1 /*
   2  * Copyright (C) 2007 Andre Noll <maan@tuebingen.mpg.de>
   3  *
   4  * Licensed under the GPL v2. For licencing details see COPYING.
   5  */
   6
   7 #include <regex.h>
   8 #include <osl.h>
   9
  10 #include "para.h"
  11 #include "error.h"
  12 #include "string.h"
  13 #include "afh.h"
  14 #include "afs.h"
  15 #include "ipc.h"
  16 #include "sideband.h"
  17
  18 /** \file playlist.c Functions for loading and saving playlists. */
  19
  20 /** Structure used for adding entries to a playlist. */
  21 struct playlist_info {
  22         /** The name of the playlist. */
  23         char *name;
  24         /** The number of entries currently in the playlist. */
  25         unsigned length;
  26 };
  27 static struct playlist_info current_playlist;
  28
  29 /**
  30  * Re-insert an audio file into the tree of admissible files.
  31  *
  32  * \param aft_row Determines the audio file.
  33  *
  34  * \return The return value of score_update().
  35  */
  36 static int playlist_update_audio_file(const struct osl_row *aft_row)
  37 {
  38         /* always re-insert to the top of the tree */
  39         return score_update(aft_row, 0);
  40 }
  41
  42 static int add_playlist_entry(char *path, void *data)
  43 {
  44         struct playlist_info *playlist = data;
  45         struct osl_row *aft_row;
  46         int ret = aft_get_row_of_path(path, &aft_row);
  47
  48         if (ret < 0) {
  49                 PARA_NOTICE_LOG("%s: %s\n", path, para_strerror(-ret));
  50                 return 1;
  51         }
  52         ret = score_add(aft_row, -playlist->length);
  53         if (ret < 0) {
  54                 PARA_ERROR_LOG("failed to add %s: %s\n", path, para_strerror(-ret));
  55                 return ret;
  56         }
  57         playlist->length++;
  58         return 1;
  59 }
  60
  61 /* returns -E_PLAYLIST_LOADED on _success_ to terminate the loop */
  62 static int load_playlist(struct osl_row *row, void *data)
  63 {
  64         struct playlist_info *playlist = data;
  65         struct osl_object playlist_def;
  66         char *playlist_name;
  67         int ret;
  68
  69         ret = pl_get_name_and_def_by_row(row, &playlist_name, &playlist_def);
  70         if (ret < 0)
  71                 goto err;
  72         playlist->length = 0;
  73         ret = for_each_line(FELF_READ_ONLY, playlist_def.data,
  74                 playlist_def.size, add_playlist_entry, playlist);
  75         osl_close_disk_object(&playlist_def);
  76         if (ret < 0)
  77                 goto err;
  78         ret = -E_PLAYLIST_EMPTY;
  79         if (!playlist->length)
  80                 goto err;
  81         playlist->name = para_strdup(playlist_name);
  82         PARA_NOTICE_LOG("loaded playlist %s (%u files)\n", playlist->name,
  83                 playlist->length);
  84         return -E_PLAYLIST_LOADED;
  85 err:
  86         if (ret != -E_DUMMY_ROW)
  87                 PARA_NOTICE_LOG("unable to load playlist (%s)\n",
  88                         para_strerror(-ret));
  89         return 1;
  90 }
  91
  92 static int check_playlist_path(char *path, void *data)
  93 {
  94         struct para_buffer *pb = data;
  95         struct osl_row *aft_row;
  96         int ret = aft_get_row_of_path(path, &aft_row);
  97
  98         if (ret < 0)
  99                 para_printf(pb, "%s: %s\n", path, para_strerror(-ret));
 100         return 1; /* do not fail the loop on bad paths */
 101 }
 102
 103 static int check_playlist(struct osl_row *row, void *data)
 104 {
 105         struct para_buffer *pb = data;
 106         struct osl_object playlist_def;
 107         char *playlist_name;
 108         int ret = pl_get_name_and_def_by_row(row, &playlist_name, &playlist_def);
 109
 110         if (ret < 0) { /* log error, but continue */
 111                 para_printf(pb, "failed to get playlist data: %s\n",
 112                         para_strerror(-ret));
 113                 return 1;
 114         }
 115         if (*playlist_name) { /* skip dummy row */
 116                 para_printf(pb, "checking playlist %s...\n", playlist_name);
 117                 for_each_line(FELF_READ_ONLY, playlist_def.data,
 118                         playlist_def.size, check_playlist_path, pb);
 119         }
 120         osl_close_disk_object(&playlist_def);
 121         return 1;
 122 }
 123
 124 /**
 125  * Check the playlist table for inconsistencies.
 126  *
 127  * \param aca This callback ignores ->query.
 128  *
 129  * \return Standard. Invalid paths are reported, but are not considered an
 130  * error.
 131  */
 132 int playlist_check_callback(struct afs_callback_arg *aca)
 133 {
 134         para_printf(&aca->pbout, "checking playlists...\n");
 135         return osl(osl_rbtree_loop(playlists_table, BLOBCOL_ID, &aca->pbout,
 136                 check_playlist));
 137 }
 138
 139 /**
 140  * Close the current playlist.
 141  *
 142  * \sa playlist_open().
 143  */
 144 void playlist_close(void)
 145 {
 146         if (!current_playlist.name)
 147                 return;
 148         free(current_playlist.name);
 149         current_playlist.name = NULL;
 150 }
 151
 152 /**
 153  * Open the given playlist.
 154  *
 155  * \param name The name of the playlist to open.
 156  *
 157  * Files which are listed in the playlist, but not contained in the database
 158  * are ignored.  This is not considered an error.
 159  *
 160  * \return Standard.
 161  */
 162 int playlist_open(char *name)
 163 {
 164         struct osl_object obj;
 165         int ret;
 166         struct osl_row *row;
 167
 168         obj.data = name;
 169         obj.size = strlen(obj.data);
 170         ret = osl(osl_get_row(playlists_table, BLOBCOL_NAME, &obj, &row));
 171         if (ret < 0) {
 172                 PARA_NOTICE_LOG("failed to load playlist %s\n", name);
 173                 return ret;
 174         }
 175         playlist_close();
 176         ret = load_playlist(row, &current_playlist);
 177         return (ret == -E_PLAYLIST_LOADED)? current_playlist.length : ret;
 178 }
 179
 180 static int search_path(char *path, void *data)
 181 {
 182         if (strcmp(path, data))
 183                 return 1;
 184         return -E_PATH_FOUND;
 185 }
 186
 187 static int handle_audio_file_event(enum afs_events event, void *data)
 188 {
 189         int ret, was_admissible = 0, is_admissible;
 190         struct osl_object playlist_def;
 191         char *new_path;
 192         const struct osl_row *row = data;
 193
 194         if (!current_playlist.name)
 195                 return 1;
 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         switch(event) {
 241         case AFSI_CHANGE:
 242                 return playlist_update_audio_file(aced->aft_row);
 243         case AUDIO_FILE_RENAME:
 244         case AUDIO_FILE_ADD:
 245                 return handle_audio_file_event(event, data);
 246         case AUDIO_FILE_REMOVE:
 247                 ret = row_belongs_to_score_table(data, NULL);
 248                 if (ret < 0)
 249                         return ret;
 250                 if (!ret)
 251                         return 1;
 252                 current_playlist.length--;
 253                 return score_delete(data);
 254         default:
 255                 return 1;
 256         }
 257 }