Do not check return value of WRITE_STATUS_ITEM().
[paraslash.git] / 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 fd The afs socket.
128  * \param query Unused.
129  */
130 void playlist_check_callback(int fd, __a_unused const struct osl_object *query)
131 {
132         struct para_buffer pb = {
133                 .max_size = shm_get_shmmax(),
134                 .private_data = &(struct afs_max_size_handler_data) {
135                         .fd = fd,
136                         .band = SBD_OUTPUT
137                 },
138                 .max_size_handler = afs_max_size_handler,
139         };
140         para_printf(&pb, "checking playlists...\n");
141         osl_rbtree_loop(playlists_table, BLOBCOL_ID, &pb,
142                 check_playlist);
143         if (pb.offset)
144                 pass_buffer_as_shm(fd, SBD_OUTPUT, pb.buf, pb.offset);
145         free(pb.buf);
146 }
147
148 /**
149  * Close the current playlist.
150  *
151  * \sa playlist_open().
152  */
153 void playlist_close(void)
154 {
155         if (!current_playlist.name)
156                 return;
157         free(current_playlist.name);
158         current_playlist.name = NULL;
159 }
160
161 /**
162  * Open the given playlist.
163  *
164  * \param name The name of the playlist to open.
165  *
166  * Files which are listed in the playlist, but not contained in the database
167  * are ignored.  This is not considered an error.
168  *
169  * \return Standard.
170  */
171 int playlist_open(char *name)
172 {
173         struct osl_object obj;
174         int ret;
175         struct osl_row *row;
176
177         obj.data = name;
178         obj.size = strlen(obj.data);
179         ret = osl(osl_get_row(playlists_table, BLOBCOL_NAME, &obj, &row));
180         if (ret < 0) {
181                 PARA_NOTICE_LOG("failed to load playlist %s\n", name);
182                 return ret;
183         }
184         playlist_close();
185         ret = load_playlist(row, &current_playlist);
186         return (ret == -E_PLAYLIST_LOADED)? current_playlist.length : ret;
187 }
188
189 static int search_path(char *path, void *data)
190 {
191         if (strcmp(path, data))
192                 return 1;
193         return -E_PATH_FOUND;
194 }
195
196 static int handle_audio_file_event(enum afs_events event, void *data)
197 {
198         int ret, was_admissible = 0, is_admissible;
199         struct osl_object playlist_def;
200         char *new_path;
201         const struct osl_row *row = data;
202
203         if (!current_playlist.name)
204                 return 1;
205         if (event == AUDIO_FILE_RENAME) {
206                 ret = row_belongs_to_score_table(row, NULL);
207                 if (ret < 0)
208                         return ret;
209                 was_admissible = ret;
210         }
211         ret = get_audio_file_path_of_row(row, &new_path);
212         if (ret < 0)
213                 return ret;
214         ret = pl_get_def_by_name(current_playlist.name, &playlist_def);
215         if (ret < 0)
216                 return ret;
217         ret = for_each_line(FELF_READ_ONLY, playlist_def.data,
218                 playlist_def.size, search_path, new_path);
219         osl_close_disk_object(&playlist_def);
220         is_admissible = (ret < 0);
221         if (was_admissible && is_admissible)
222                 return 1;
223         if (!was_admissible && !is_admissible)
224                 return 1;
225         if (was_admissible && !is_admissible) {
226                 current_playlist.length--;
227                 return score_delete(row);
228         }
229         /* !was_admissible && is_admissible */
230         current_playlist.length++;
231         return score_add(row, 0); /* play it immediately */
232 }
233
234 /**
235  * Handle afs events relevant to playlists.
236  *
237  * \param event The event type.
238  * \param pb Unused.
239  * \param data Depends on the event type.
240  *
241  * \return Standard.
242  */
243 int playlists_event_handler(enum afs_events event,
244         __a_unused struct para_buffer *pb, void *data)
245 {
246         int ret;
247         struct afsi_change_event_data *aced = data;
248
249         switch(event) {
250         case AFSI_CHANGE:
251                 return playlist_update_audio_file(aced->aft_row);
252         case AUDIO_FILE_RENAME:
253         case AUDIO_FILE_ADD:
254                 return handle_audio_file_event(event, data);
255         case AUDIO_FILE_REMOVE:
256                 ret = row_belongs_to_score_table(data, NULL);
257                 if (ret < 0)
258                         return ret;
259                 if (!ret)
260                         return 1;
261                 current_playlist.length--;
262                 return score_delete(data);
263         default:
264                 return 1;
265         }
266 }