playlist.c

   1 /*
   2  * Copyright (C) 2007-2008 Andre Noll <maan@systemlinux.org>
   3  *
   4  * Licensed under the GPL v2. For licencing details see COPYING.
   5  */
   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
  14 /** \file playlist.c Functions for loading and saving playlists. */
  15
  16 /** Structure used for adding entries to a playlist. */
  17 struct playlist_info {
  18         /** The name of the playlist. */
  19         char *name;
  20         /** The number of entries currently in the playlist. */
  21         unsigned length;
  22 };
  23 static struct playlist_info current_playlist;
  24
  25 /**
  26  * Re-insert an audio file into the tree of admissible files.
  27  *
  28  * \param aft_row Determines the audio file.
  29  *
  30  * \return The return value of score_update().
  31  */
  32 static int playlist_update_audio_file(const struct osl_row *aft_row)
  33 {
  34         /* always re-insert to the top of the tree */
  35         return score_update(aft_row, 0);
  36 }
  37
  38 static int add_playlist_entry(char *path, void *data)
  39 {
  40         struct playlist_info *playlist = data;
  41         struct osl_row *aft_row;
  42         int ret = aft_get_row_of_path(path, &aft_row);
  43
  44         if (ret < 0) {
  45                 PARA_NOTICE_LOG("%s: %s\n", path, para_strerror(-ret));
  46                 return 1;
  47         }
  48         ret = score_add(aft_row, -playlist->length);
  49         if (ret < 0) {
  50                 PARA_ERROR_LOG("failed to add %s: %s\n", path, para_strerror(-ret));
  51                 return ret;
  52         }
  53         playlist->length++;
  54         return 1;
  55 }
  56
  57 /* returns -E_PLAYLIST_LOADED on _success_ to terminate the loop */
  58 static int load_playlist(struct osl_row *row, void *data)
  59 {
  60         struct playlist_info *playlist = data;
  61         struct osl_object playlist_def;
  62         char *playlist_name;
  63         int ret;
  64
  65         ret = pl_get_name_and_def_by_row(row, &playlist_name, &playlist_def);
  66         if (ret < 0)
  67                 goto err;
  68         playlist->length = 0;
  69         ret = for_each_line_ro(playlist_def.data, playlist_def.size,
  70                 add_playlist_entry, playlist);
  71         osl_close_disk_object(&playlist_def);
  72         if (ret < 0)
  73                 goto err;
  74         ret = -E_PLAYLIST_EMPTY;
  75         if (!playlist->length)
  76                 goto err;
  77         playlist->name = para_strdup(playlist_name);
  78         PARA_NOTICE_LOG("loaded playlist %s (%u files)\n", playlist->name,
  79                 playlist->length);
  80         return -E_PLAYLIST_LOADED;
  81 err:
  82         if (ret != -E_DUMMY_ROW)
  83                 PARA_NOTICE_LOG("unable to load playlist (%s)\n",
  84                         para_strerror(-ret));
  85         return 1;
  86 }
  87
  88 static int check_playlist_path(char *path, void *data)
  89 {
  90         struct para_buffer *pb = data;
  91         struct osl_row *aft_row;
  92         int ret = aft_get_row_of_path(path, &aft_row);
  93
  94         if (ret >= 0)
  95                 return 1;
  96         return para_printf(pb, "%s: %s\n", path, para_strerror(-ret));
  97 }
  98
  99 static int check_playlist(struct osl_row *row, void *data)
 100 {
 101         struct para_buffer *pb = data;
 102         struct osl_object playlist_def;
 103         char *playlist_name;
 104         int ret = pl_get_name_and_def_by_row(row, &playlist_name, &playlist_def);
 105
 106         if (ret < 0)
 107                 return para_printf(pb, "failed to get playlist data: %s\n",
 108                         para_strerror(-ret));
 109         if (*playlist_name) { /* skip dummy row */
 110                 ret = para_printf(pb, "checking playlist %s...\n", playlist_name);
 111                 if (ret < 0)
 112                         return ret;
 113                 ret = for_each_line_ro(playlist_def.data, playlist_def.size,
 114                         check_playlist_path, pb);
 115         }
 116         osl_close_disk_object(&playlist_def);
 117         return ret;
 118 }
 119
 120 /**
 121  * Check the playlist table for inconsistencies.
 122  *
 123  * \param query Unused.
 124  * \param result Contains messages about inconsistencies.
 125  *
 126  * \return The return value of the underlying call to osl_rbtree_loop().
 127  */
 128 void playlist_check_callback(int fd, __a_unused const struct osl_object *query)
 129 {
 130         struct para_buffer pb = {
 131                 .max_size = SHMMAX,
 132                 .private_data = &fd,
 133                 .max_size_handler = pass_buffer_as_shm
 134         };
 135         int ret = para_printf(&pb, "checking playlists...\n");
 136
 137         if (ret < 0)
 138                 return;
 139         osl_rbtree_loop(playlists_table, BLOBCOL_ID, &pb,
 140                 check_playlist);
 141         if (pb.offset)
 142                 pass_buffer_as_shm(pb.buf, pb.offset, &fd);
 143         free(pb.buf);
 144 }
 145
 146 /**
 147  * Close the current playlist.
 148  *
 149  * \sa playlist_open().
 150  */
 151 void playlist_close(void)
 152 {
 153         if (!current_playlist.name)
 154                 return;
 155         free(current_playlist.name);
 156         current_playlist.name = NULL;
 157 }
 158
 159 /**
 160  * Open the given playlist.
 161  *
 162  * \param name The name of the playlist to open.
 163  *
 164  * Files which are listed in the playlist, but not contained in the database
 165  * are ignored.  This is not considered an error.
 166  *
 167  * \return Standard.
 168  */
 169 int playlist_open(char *name)
 170 {
 171         struct osl_object obj;
 172         int ret;
 173         struct osl_row *row;
 174
 175         obj.data = name;
 176         obj.size = strlen(obj.data);
 177         ret = osl_get_row(playlists_table, BLOBCOL_NAME, &obj, &row);
 178         if (ret < 0) {
 179                 PARA_NOTICE_LOG("failed to load playlist %s\n", name);
 180                 return ret;
 181         }
 182         playlist_close();
 183         ret = load_playlist(row, &current_playlist);
 184         return (ret == -E_PLAYLIST_LOADED)? current_playlist.length : ret;
 185 }
 186
 187 static int search_path(char *path, void *data)
 188 {
 189         if (strcmp(path, data))
 190                 return 1;
 191         return -E_PATH_FOUND;
 192 }
 193
 194 static int handle_audio_file_event(enum afs_events event, void *data)
 195 {
 196         int ret, was_admissible = 0, is_admissible;
 197         struct osl_object playlist_def;
 198         char *new_path;
 199         const struct osl_row *row = data;
 200
 201         if (!current_playlist.name)
 202                 return 1;
 203         if (event == AUDIO_FILE_RENAME) {
 204                 ret = row_belongs_to_score_table(row, NULL);
 205                 if (ret < 0)
 206                         return ret;
 207                 was_admissible = ret;
 208         }
 209         ret = get_audio_file_path_of_row(row, &new_path);
 210         if (ret < 0)
 211                 return ret;
 212         ret = pl_get_def_by_name(current_playlist.name, &playlist_def);
 213         if (ret < 0)
 214                 return ret;
 215         ret = for_each_line_ro(playlist_def.data, playlist_def.size,
 216                 search_path, new_path);
 217         osl_close_disk_object(&playlist_def);
 218         is_admissible = (ret < 0);
 219         if (was_admissible && is_admissible)
 220                 return 1;
 221         if (!was_admissible && !is_admissible)
 222                 return 1;
 223         if (was_admissible && !is_admissible) {
 224                 current_playlist.length--;
 225                 return score_delete(row);
 226         }
 227         /* !was_admissible && is_admissible */
 228         current_playlist.length++;
 229         return score_add(row, 0); /* play it immediately */
 230 }
 231
 232 /**
 233  * Handle afs events relevant to playlists.
 234  *
 235  * \param event The event type.
 236  * \param pb Unused.
 237  * \param data Depends on the event type.
 238  *
 239  * \return Standard.
 240  */
 241 int playlists_event_handler(enum afs_events event,
 242         __a_unused struct para_buffer *pb, void *data)
 243 {
 244         int ret;
 245         struct afsi_change_event_data *aced = data;
 246
 247         switch(event) {
 248         case AFSI_CHANGE:
 249                 return playlist_update_audio_file(aced->aft_row);
 250         case AUDIO_FILE_RENAME:
 251         case AUDIO_FILE_ADD:
 252                 return handle_audio_file_event(event, data);
 253         case AUDIO_FILE_REMOVE:
 254                 ret = row_belongs_to_score_table(data, NULL);
 255                 if (ret < 0)
 256                         return ret;
 257                 if (!ret)
 258                         return 1;
 259                 current_playlist.length--;
 260                 return score_delete(data);
 261         default:
 262                 return 1;
 263         }
 264 }