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