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