src/stored_playlist.c

   1 /*
   2  * Copyright (C) 2003-2010 The Music Player Daemon Project
   3  * http://www.musicpd.org
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18  */
  19
  20 #include "config.h"
  21 #include "stored_playlist.h"
  22 #include "playlist_save.h"
  23 #include "song.h"
  24 #include "mapper.h"
  25 #include "path.h"
  26 #include "uri.h"
  27 #include "database.h"
  28 #include "idle.h"
  29 #include "conf.h"
  30
  31 #include <assert.h>
  32 #include <sys/types.h>
  33 #include <sys/stat.h>
  34 #include <unistd.h>
  35 #include <dirent.h>
  36 #include <string.h>
  37 #include <errno.h>
  38
  39 static unsigned playlist_max_length;
  40 bool playlist_saveAbsolutePaths = DEFAULT_PLAYLIST_SAVE_ABSOLUTE_PATHS;
  41
  42 void
  43 spl_global_init(void)
  44 {
  45         playlist_max_length = config_get_positive(CONF_MAX_PLAYLIST_LENGTH,
  46                                                   DEFAULT_PLAYLIST_MAX_LENGTH);
  47
  48         playlist_saveAbsolutePaths =
  49                 config_get_bool(CONF_SAVE_ABSOLUTE_PATHS,
  50                                 DEFAULT_PLAYLIST_SAVE_ABSOLUTE_PATHS);
  51 }
  52
  53 bool
  54 spl_valid_name(const char *name_utf8)
  55 {
  56         /*
  57          * Not supporting '/' was done out of laziness, and we should
  58          * really strive to support it in the future.
  59          *
  60          * Not supporting '\r' and '\n' is done out of protocol
  61          * limitations (and arguably laziness), but bending over head
  62          * over heels to modify the protocol (and compatibility with
  63          * all clients) to support idiots who put '\r' and '\n' in
  64          * filenames isn't going to happen, either.
  65          */
  66
  67         return strchr(name_utf8, '/') == NULL &&
  68                 strchr(name_utf8, '\n') == NULL &&
  69                 strchr(name_utf8, '\r') == NULL;
  70 }
  71
  72 static struct stored_playlist_info *
  73 load_playlist_info(const char *parent_path_fs, const char *name_fs)
  74 {
  75         size_t name_length = strlen(name_fs);
  76         char *path_fs, *name, *name_utf8;
  77         int ret;
  78         struct stat st;
  79         struct stored_playlist_info *playlist;
  80
  81         if (name_length < sizeof(PLAYLIST_FILE_SUFFIX) ||
  82             memchr(name_fs, '\n', name_length) != NULL)
  83                 return NULL;
  84
  85         if (!g_str_has_suffix(name_fs, PLAYLIST_FILE_SUFFIX))
  86                 return NULL;
  87
  88         path_fs = g_build_filename(parent_path_fs, name_fs, NULL);
  89         ret = stat(path_fs, &st);
  90         g_free(path_fs);
  91         if (ret < 0 || !S_ISREG(st.st_mode))
  92                 return NULL;
  93
  94         name = g_strndup(name_fs,
  95                          name_length + 1 - sizeof(PLAYLIST_FILE_SUFFIX));
  96         name_utf8 = fs_charset_to_utf8(name);
  97         g_free(name);
  98         if (name_utf8 == NULL)
  99                 return NULL;
 100
 101         playlist = g_new(struct stored_playlist_info, 1);
 102         playlist->name = name_utf8;
 103         playlist->mtime = st.st_mtime;
 104         return playlist;
 105 }
 106
 107 GPtrArray *
 108 spl_list(void)
 109 {
 110         const char *parent_path_fs = map_spl_path();
 111         DIR *dir;
 112         struct dirent *ent;
 113         GPtrArray *list;
 114         struct stored_playlist_info *playlist;
 115
 116         if (parent_path_fs == NULL)
 117                 return NULL;
 118
 119         dir = opendir(parent_path_fs);
 120         if (dir == NULL)
 121                 return NULL;
 122
 123         list = g_ptr_array_new();
 124
 125         while ((ent = readdir(dir)) != NULL) {
 126                 playlist = load_playlist_info(parent_path_fs, ent->d_name);
 127                 if (playlist != NULL)
 128                         g_ptr_array_add(list, playlist);
 129         }
 130
 131         closedir(dir);
 132         return list;
 133 }
 134
 135 void
 136 spl_list_free(GPtrArray *list)
 137 {
 138         for (unsigned i = 0; i < list->len; ++i) {
 139                 struct stored_playlist_info *playlist =
 140                         g_ptr_array_index(list, i);
 141                 g_free(playlist->name);
 142                 g_free(playlist);
 143         }
 144
 145         g_ptr_array_free(list, true);
 146 }
 147
 148 static enum playlist_result
 149 spl_save(GPtrArray *list, const char *utf8path)
 150 {
 151         FILE *file;
 152         char *path_fs;
 153
 154         assert(utf8path != NULL);
 155
 156         if (map_spl_path() == NULL)
 157                 return PLAYLIST_RESULT_DISABLED;
 158
 159         path_fs = map_spl_utf8_to_fs(utf8path);
 160         if (path_fs == NULL)
 161                 return PLAYLIST_RESULT_BAD_NAME;
 162
 163         while (!(file = fopen(path_fs, "w")) && errno == EINTR);
 164         g_free(path_fs);
 165         if (file == NULL)
 166                 return PLAYLIST_RESULT_ERRNO;
 167
 168         for (unsigned i = 0; i < list->len; ++i) {
 169                 const char *uri = g_ptr_array_index(list, i);
 170                 playlist_print_uri(file, uri);
 171         }
 172
 173         while (fclose(file) != 0 && errno == EINTR);
 174         return PLAYLIST_RESULT_SUCCESS;
 175 }
 176
 177 GPtrArray *
 178 spl_load(const char *utf8path)
 179 {
 180         FILE *file;
 181         GPtrArray *list;
 182         char buffer[MPD_PATH_MAX];
 183         char *path_fs;
 184
 185         if (!spl_valid_name(utf8path) || map_spl_path() == NULL)
 186                 return NULL;
 187
 188         path_fs = map_spl_utf8_to_fs(utf8path);
 189         if (path_fs == NULL)
 190                 return NULL;
 191
 192         while (!(file = fopen(path_fs, "r")) && errno == EINTR);
 193         g_free(path_fs);
 194         if (file == NULL)
 195                 return NULL;
 196
 197         list = g_ptr_array_new();
 198
 199         while (fgets(buffer, sizeof(buffer), file)) {
 200                 char *s = buffer;
 201
 202                 if (*s == PLAYLIST_COMMENT)
 203                         continue;
 204
 205                 g_strchomp(buffer);
 206
 207                 if (!uri_has_scheme(s)) {
 208                         char *path_utf8;
 209                         struct song *song;
 210
 211                         path_utf8 = map_fs_to_utf8(s);
 212                         if (path_utf8 == NULL)
 213                                 continue;
 214
 215                         song = db_get_song(path_utf8);
 216                         g_free(path_utf8);
 217                         if (song == NULL)
 218                                 continue;
 219
 220                         s = song_get_uri(song);
 221                 } else
 222                         s = g_strdup(s);
 223
 224                 g_ptr_array_add(list, s);
 225
 226                 if (list->len >= playlist_max_length)
 227                         break;
 228         }
 229
 230         while (fclose(file) && errno == EINTR);
 231         return list;
 232 }
 233
 234 void
 235 spl_free(GPtrArray *list)
 236 {
 237         for (unsigned i = 0; i < list->len; ++i) {
 238                 char *uri = g_ptr_array_index(list, i);
 239                 g_free(uri);
 240         }
 241
 242         g_ptr_array_free(list, true);
 243 }
 244
 245 static char *
 246 spl_remove_index_internal(GPtrArray *list, unsigned idx)
 247 {
 248         char *uri;
 249
 250         assert(idx < list->len);
 251
 252         uri = g_ptr_array_remove_index(list, idx);
 253         assert(uri != NULL);
 254         return uri;
 255 }
 256
 257 static void
 258 spl_insert_index_internal(GPtrArray *list, unsigned idx, char *uri)
 259 {
 260         assert(idx <= list->len);
 261
 262         g_ptr_array_add(list, uri);
 263
 264         memmove(list->pdata + idx + 1, list->pdata + idx,
 265                 (list->len - idx - 1) * sizeof(list->pdata[0]));
 266         g_ptr_array_index(list, idx) = uri;
 267 }
 268
 269 enum playlist_result
 270 spl_move_index(const char *utf8path, unsigned src, unsigned dest)
 271 {
 272         GPtrArray *list;
 273         char *uri;
 274         enum playlist_result result;
 275
 276         if (src == dest)
 277                 /* this doesn't check whether the playlist exists, but
 278                    what the hell.. */
 279                 return PLAYLIST_RESULT_SUCCESS;
 280
 281         if (!(list = spl_load(utf8path)))
 282                 return PLAYLIST_RESULT_NO_SUCH_LIST;
 283
 284         if (src >= list->len || dest >= list->len) {
 285                 spl_free(list);
 286                 return PLAYLIST_RESULT_BAD_RANGE;
 287         }
 288
 289         uri = spl_remove_index_internal(list, src);
 290         spl_insert_index_internal(list, dest, uri);
 291
 292         result = spl_save(list, utf8path);
 293
 294         spl_free(list);
 295
 296         idle_add(IDLE_STORED_PLAYLIST);
 297         return result;
 298 }
 299
 300 enum playlist_result
 301 spl_clear(const char *utf8path)
 302 {
 303         char *path_fs;
 304         FILE *file;
 305
 306         if (map_spl_path() == NULL)
 307                 return PLAYLIST_RESULT_DISABLED;
 308
 309         if (!spl_valid_name(utf8path))
 310                 return PLAYLIST_RESULT_BAD_NAME;
 311
 312         path_fs = map_spl_utf8_to_fs(utf8path);
 313         if (path_fs == NULL)
 314                 return PLAYLIST_RESULT_BAD_NAME;
 315
 316         while (!(file = fopen(path_fs, "w")) && errno == EINTR);
 317         g_free(path_fs);
 318         if (file == NULL)
 319                 return PLAYLIST_RESULT_ERRNO;
 320
 321         while (fclose(file) != 0 && errno == EINTR);
 322
 323         idle_add(IDLE_STORED_PLAYLIST);
 324         return PLAYLIST_RESULT_SUCCESS;
 325 }
 326
 327 enum playlist_result
 328 spl_delete(const char *name_utf8)
 329 {
 330         char *path_fs;
 331         int ret;
 332
 333         if (map_spl_path() == NULL)
 334                 return PLAYLIST_RESULT_DISABLED;
 335
 336         if (!spl_valid_name(name_utf8))
 337                 return PLAYLIST_RESULT_BAD_NAME;
 338
 339         path_fs = map_spl_utf8_to_fs(name_utf8);
 340         if (path_fs == NULL)
 341                 return PLAYLIST_RESULT_BAD_NAME;
 342
 343         ret = unlink(path_fs);
 344         g_free(path_fs);
 345         if (ret < 0)
 346                 return errno == ENOENT
 347                         ? PLAYLIST_RESULT_NO_SUCH_LIST
 348                         : PLAYLIST_RESULT_ERRNO;
 349
 350         idle_add(IDLE_STORED_PLAYLIST);
 351         return PLAYLIST_RESULT_SUCCESS;
 352 }
 353
 354 enum playlist_result
 355 spl_remove_index(const char *utf8path, unsigned pos)
 356 {
 357         GPtrArray *list;
 358         char *uri;
 359         enum playlist_result result;
 360
 361         if (!(list = spl_load(utf8path)))
 362                 return PLAYLIST_RESULT_NO_SUCH_LIST;
 363
 364         if (pos >= list->len) {
 365                 spl_free(list);
 366                 return PLAYLIST_RESULT_BAD_RANGE;
 367         }
 368
 369         uri = spl_remove_index_internal(list, pos);
 370         g_free(uri);
 371         result = spl_save(list, utf8path);
 372
 373         spl_free(list);
 374
 375         idle_add(IDLE_STORED_PLAYLIST);
 376         return result;
 377 }
 378
 379 enum playlist_result
 380 spl_append_song(const char *utf8path, struct song *song)
 381 {
 382         FILE *file;
 383         struct stat st;
 384         char *path_fs;
 385
 386         if (map_spl_path() == NULL)
 387                 return PLAYLIST_RESULT_DISABLED;
 388
 389         if (!spl_valid_name(utf8path))
 390                 return PLAYLIST_RESULT_BAD_NAME;
 391
 392         path_fs = map_spl_utf8_to_fs(utf8path);
 393         if (path_fs == NULL)
 394                 return PLAYLIST_RESULT_BAD_NAME;
 395
 396         while (!(file = fopen(path_fs, "a")) && errno == EINTR);
 397         g_free(path_fs);
 398         if (file == NULL)
 399                 return PLAYLIST_RESULT_ERRNO;
 400
 401         if (fstat(fileno(file), &st) < 0) {
 402                 int save_errno = errno;
 403                 while (fclose(file) != 0 && errno == EINTR);
 404                 errno = save_errno;
 405                 return PLAYLIST_RESULT_ERRNO;
 406         }
 407
 408         if (st.st_size / (MPD_PATH_MAX + 1) >= (off_t)playlist_max_length) {
 409                 while (fclose(file) != 0 && errno == EINTR);
 410                 return PLAYLIST_RESULT_TOO_LARGE;
 411         }
 412
 413         playlist_print_song(file, song);
 414
 415         while (fclose(file) != 0 && errno == EINTR);
 416
 417         idle_add(IDLE_STORED_PLAYLIST);
 418         return PLAYLIST_RESULT_SUCCESS;
 419 }
 420
 421 enum playlist_result
 422 spl_append_uri(const char *url, const char *utf8file)
 423 {
 424         struct song *song;
 425
 426         if (uri_has_scheme(url)) {
 427                 enum playlist_result ret;
 428
 429                 song = song_remote_new(url);
 430                 ret = spl_append_song(utf8file, song);
 431                 song_free(song);
 432                 return ret;
 433         } else {
 434                 song = db_get_song(url);
 435                 if (song == NULL)
 436                         return PLAYLIST_RESULT_NO_SUCH_SONG;
 437
 438                 return spl_append_song(utf8file, song);
 439         }
 440 }
 441
 442 static enum playlist_result
 443 spl_rename_internal(const char *from_path_fs, const char *to_path_fs)
 444 {
 445         if (!g_file_test(from_path_fs, G_FILE_TEST_IS_REGULAR))
 446                 return PLAYLIST_RESULT_NO_SUCH_LIST;
 447
 448         if (g_file_test(to_path_fs, G_FILE_TEST_EXISTS))
 449                 return PLAYLIST_RESULT_LIST_EXISTS;
 450
 451         if (rename(from_path_fs, to_path_fs) < 0)
 452                 return PLAYLIST_RESULT_ERRNO;
 453
 454         idle_add(IDLE_STORED_PLAYLIST);
 455         return PLAYLIST_RESULT_SUCCESS;
 456 }
 457
 458 enum playlist_result
 459 spl_rename(const char *utf8from, const char *utf8to)
 460 {
 461         char *from_path_fs, *to_path_fs;
 462         static enum playlist_result ret;
 463
 464         if (map_spl_path() == NULL)
 465                 return PLAYLIST_RESULT_DISABLED;
 466
 467         if (!spl_valid_name(utf8from) || !spl_valid_name(utf8to))
 468                 return PLAYLIST_RESULT_BAD_NAME;
 469
 470         from_path_fs = map_spl_utf8_to_fs(utf8from);
 471         to_path_fs = map_spl_utf8_to_fs(utf8to);
 472
 473         if (from_path_fs != NULL && to_path_fs != NULL)
 474                 ret = spl_rename_internal(from_path_fs, to_path_fs);
 475         else
 476                 ret = PLAYLIST_RESULT_BAD_NAME;
 477
 478         g_free(from_path_fs);
 479         g_free(to_path_fs);
 480
 481         return ret;
 482 }