playlist: don't pass "fd" to playlist.c functions

The playlist library shouldn't talk to the client if possible.
Introduce the "enum playlist_result" type which the caller
(i.e. command.c) may use to generate an error message.

1 files changed, 88 insertions, 128 deletions

diff --git a/src/playlist.c b/src/playlist.c
index 7d782c1a1..9271bb037 100644
--- a/src/playlist.c
+++ b/src/playlist.c
@@ -301,13 +301,12 @@ static void loadPlaylistFromStateFile(FILE *fp, char *buffer,
 		song = atoi(temp);
 		if (!(temp = strtok(NULL, "")))
 			state_file_fatal();
-		if (!addToPlaylist(STDERR_FILENO, temp, NULL)
+		if (addToPlaylist(temp, NULL) == PLAYLIST_RESULT_SUCCESS
 		    && current == song) {
 			if (state == OB_STATE_PAUSE)
 				ob_trigger_action(OB_ACTION_PAUSE_SET);
 			if (state != OB_STATE_STOP) {
-				seekSongInPlaylist(STDERR_FILENO,
-						   playlist.length - 1,
+				seekSongInPlaylist(playlist.length - 1,
 						   seek_time);
 			}
 		}
@@ -428,7 +427,7 @@ int playlistChangesPosId(int fd, mpd_uint32 version)
 	return 0;
 }
 
-int playlistInfo(int fd, int song)
+enum playlist_result playlistInfo(int fd, int song)
 {
 	int i;
 	int begin = 0;
@@ -438,36 +437,31 @@ int playlistInfo(int fd, int song)
 		begin = song;
 		end = song + 1;
 	}
-	if (song >= playlist.length) {
-		commandError(fd, ACK_ERROR_NO_EXIST,
-			     "song doesn't exist: \"%i\"", song);
-		return -1;
-	}
+	if (song >= playlist.length)
+		return PLAYLIST_RESULT_BAD_RANGE;
 
 	for (i = begin; i < end; i++)
 		printPlaylistSongInfo(fd, i);
 
-	return 0;
+	return PLAYLIST_RESULT_SUCCESS;
 }
 
-# define checkSongId(id) { \
-	if(id < 0 || id >= PLAYLIST_HASH_MULT*playlist_max_length || \
-			playlist.idToPosition[id] == -1 ) \
-	{ \
-		commandError(fd, ACK_ERROR_NO_EXIST, \
-			"song id doesn't exist: \"%i\"", id); \
-		return -1; \
-	} \
+static int song_id_exists(int id)
+{
+	return id >= 0 && id < PLAYLIST_HASH_MULT*playlist_max_length &&
+		playlist.idToPosition[id] != -1;
 }
 
-int playlistId(int fd, int id)
+enum playlist_result playlistId(int fd, int id)
 {
 	int i;
 	int begin = 0;
 	int end = playlist.length;
 
 	if (id >= 0) {
-		checkSongId(id);
+		if (!song_id_exists(id))
+			return PLAYLIST_RESULT_NO_SUCH_SONG;
+
 		begin = playlist.idToPosition[id];
 		end = begin + 1;
 	}
@@ -475,7 +469,7 @@ int playlistId(int fd, int id)
 	for (i = begin; i < end; i++)
 		printPlaylistSongInfo(fd, i);
 
-	return 0;
+	return PLAYLIST_RESULT_SUCCESS;
 }
 
 static void swapSongs(int song1, int song2)
@@ -595,7 +589,7 @@ static int clear_queue(void)
 	return playlist.queued;
 }
 
-int addToPlaylist(int fd, const char *url, int *added_id)
+enum playlist_result addToPlaylist(const char *url, int *added_id)
 {
 	Song *song;
 
@@ -604,13 +598,10 @@ int addToPlaylist(int fd, const char *url, int *added_id)
 	if ((song = getSongFromDB(url))) {
 	} else if (!(isValidRemoteUtf8Url(url) &&
 		     (song = newSong(url, SONG_TYPE_URL, NULL)))) {
-		commandError(fd, ACK_ERROR_NO_EXIST,
-			     "\"%s\" is not in the music db or is "
-			     "not a valid url", url);
-		return -1;
+		return PLAYLIST_RESULT_NO_SUCH_SONG;
 	}
 
-	return addSongToPlaylist(fd, song, added_id);
+	return addSongToPlaylist(song, added_id);
 }
 
 int addToStoredPlaylist(int fd, const char *url, const char *utf8file)
@@ -641,15 +632,12 @@ fail:
 	return -1;
 }
 
-int addSongToPlaylist(int fd, Song * song, int *added_id)
+enum playlist_result addSongToPlaylist(Song * song, int *added_id)
 {
 	int id;
 
-	if (playlist.length == playlist_max_length) {
-		commandError(fd, ACK_ERROR_PLAYLIST_MAX,
-			     "playlist is at the max size");
-		return -1;
-	}
+	if (playlist.length == playlist_max_length)
+		return PLAYLIST_RESULT_TOO_LARGE;
 
 	if (playlist_state == PLAYLIST_STATE_PLAY) {
 		if (playlist.queued >= 0
@@ -692,24 +680,17 @@ int addSongToPlaylist(int fd, Song * song, int *added_id)
 	if (added_id)
 		*added_id = id;
 
-	return 0;
+	return PLAYLIST_RESULT_SUCCESS;
 }
 
-int swapSongsInPlaylist(int fd, int song1, int song2)
+enum playlist_result swapSongsInPlaylist(int song1, int song2)
 {
 	int queuedSong = -1;
 	int currentSong;
 
-	if (song1 < 0 || song1 >= playlist.length) {
-		commandError(fd, ACK_ERROR_NO_EXIST,
-			     "song doesn't exist: \"%i\"", song1);
-		return -1;
-	}
-	if (song2 < 0 || song2 >= playlist.length) {
-		commandError(fd, ACK_ERROR_NO_EXIST,
-			     "song doesn't exist: \"%i\"", song2);
-		return -1;
-	}
+	if (song1 < 0 || song1 >= playlist.length ||
+	    song2 < 0 || song2 >= playlist.length)
+		return PLAYLIST_RESULT_BAD_RANGE;
 
 	if (playlist_state == PLAYLIST_STATE_PLAY) {
 		if (playlist.queued >= 0) {
@@ -747,15 +728,15 @@ int swapSongsInPlaylist(int fd, int song1, int song2)
 
 	incrPlaylistVersion();
 
-	return 0;
+	return PLAYLIST_RESULT_SUCCESS;
 }
 
-int swapSongsInPlaylistById(int fd, int id1, int id2)
+enum playlist_result swapSongsInPlaylistById(int id1, int id2)
 {
-	checkSongId(id1);
-	checkSongId(id2);
+	if (!song_id_exists(id1) || !song_id_exists(id2))
+		return PLAYLIST_RESULT_NO_SUCH_SONG;
 
-	return swapSongsInPlaylist(fd, playlist.idToPosition[id1],
+	return swapSongsInPlaylist(playlist.idToPosition[id1],
 				   playlist.idToPosition[id2]);
 }
 
@@ -766,18 +747,15 @@ int swapSongsInPlaylistById(int fd, int id1, int id2)
 	playlist.songMod[to] = playlist.version; \
 }
 
-int deleteFromPlaylist(int fd, int song)
+enum playlist_result deleteFromPlaylist(int song)
 {
 	int i;
 	int songOrder;
 	int stop_current = 0;
 	int prev_queued = playlist.queued;
 
-	if (song < 0 || song >= playlist.length) {
-		commandError(fd, ACK_ERROR_NO_EXIST,
-			     "song doesn't exist: \"%i\"", song);
-		return -1;
-	}
+	if (song < 0 || song >= playlist.length)
+		return PLAYLIST_RESULT_BAD_RANGE;
 
 	if (playlist_state == PLAYLIST_STATE_PLAY) {
 		if (prev_queued >= 0
@@ -842,14 +820,15 @@ int deleteFromPlaylist(int fd, int song)
 		queueNextSongInPlaylist();
 	}
 
-	return 0;
+	return PLAYLIST_RESULT_SUCCESS;
 }
 
-int deleteFromPlaylistById(int fd, int id)
+enum playlist_result deleteFromPlaylistById(int id)
 {
-	checkSongId(id);
+	if (!song_id_exists(id))
+		return PLAYLIST_RESULT_NO_SUCH_SONG;
 
-	return deleteFromPlaylist(fd, playlist.idToPosition[id]);
+	return deleteFromPlaylist(playlist.idToPosition[id]);
 }
 
 void deleteASongFromPlaylist(Song * song)
@@ -861,7 +840,7 @@ void deleteASongFromPlaylist(Song * song)
 
 	for (i = 0; i < playlist.length; i++) {
 		if (song == playlist.songs[i]) {
-			deleteFromPlaylist(STDERR_FILENO, i);
+			deleteFromPlaylist(i);
 		}
 	}
 }
@@ -907,7 +886,7 @@ static void play_order_num(int order_num, float seek_time)
 		playlist.current = order_num;
 }
 
-int playPlaylist(int fd, int song, int stopOnError)
+enum playlist_result playPlaylist(int song, int stopOnError)
 {
 	int i = song;
 
@@ -917,11 +896,11 @@ int playPlaylist(int fd, int song, int stopOnError)
 
 	if (song == -1) {
 		if (playlist.length == 0)
-			return 0;
+			return PLAYLIST_RESULT_SUCCESS;
 
 		if (playlist_state == PLAYLIST_STATE_PLAY) {
 			ob_trigger_action(OB_ACTION_PAUSE_UNSET);
-			return 0;
+			return PLAYLIST_RESULT_SUCCESS;
 		}
 		if (playlist.current >= 0 && playlist.current < playlist.length) {
 			i = playlist.current;
@@ -929,9 +908,7 @@ int playPlaylist(int fd, int song, int stopOnError)
 			i = 0;
 		}
 	} else if (song < 0 || song >= playlist.length) {
-		commandError(fd, ACK_ERROR_NO_EXIST,
-			     "song doesn't exist: \"%i\"", song);
-		return -1;
+		return PLAYLIST_RESULT_BAD_RANGE;
 	}
 
 	if (playlist.random) {
@@ -953,18 +930,19 @@ int playPlaylist(int fd, int song, int stopOnError)
 	ERROR(__FILE__ ": %d current:%d\n", __LINE__, playlist.current);
 	ob_trigger_action(OB_ACTION_PAUSE_UNSET);
 	play_order_num(i, 0);
-	return 0;
+	return PLAYLIST_RESULT_SUCCESS;
 }
 
-int playPlaylistById(int fd, int id, int stopOnError)
+enum playlist_result playPlaylistById(int id, int stopOnError)
 {
 	if (id == -1) {
-		return playPlaylist(fd, id, stopOnError);
+		return playPlaylist(id, stopOnError);
 	}
 
-	checkSongId(id);
+	if (!song_id_exists(id))
+		return PLAYLIST_RESULT_NO_SUCH_SONG;
 
-	return playPlaylist(fd, playlist.idToPosition[id], stopOnError);
+	return playPlaylist(playlist.idToPosition[id], stopOnError);
 }
 
 /* This is used when we stream data out to shout while playing static files */
@@ -1051,7 +1029,7 @@ void setPlaylistRepeatStatus(int status)
 	playlist.repeat = status;
 }
 
-int moveSongInPlaylist(int fd, int from, int to)
+enum playlist_result moveSongInPlaylist(int from, int to)
 {
 	int i;
 	Song *tmpSong;
@@ -1059,21 +1037,15 @@ int moveSongInPlaylist(int fd, int from, int to)
 	int currentSong;
 	int queued_is_current = (playlist.queued == playlist.current);
 
-	if (from < 0 || from >= playlist.length) {
-		commandError(fd, ACK_ERROR_NO_EXIST,
-			     "song doesn't exist: \"%i\"", from);
-		return -1;
-	}
+	if (from < 0 || from >= playlist.length)
+		return PLAYLIST_RESULT_BAD_RANGE;
 
 	if ((to >= 0 && to >= playlist.length) ||
-	    (to < 0 && abs(to) > playlist.length)) {
-		commandError(fd, ACK_ERROR_NO_EXIST,
-			     "song doesn't exist: \"%i\"", to);
-		return -1;
-	}
+	    (to < 0 && abs(to) > playlist.length))
+		return PLAYLIST_RESULT_BAD_RANGE;
 
 	if (from == to) /* no-op */
-		return 0;
+		return PLAYLIST_RESULT_SUCCESS;
 
 	/*
 	 * (to < 0) => move to offset from current song
@@ -1083,7 +1055,7 @@ int moveSongInPlaylist(int fd, int from, int to)
 	if (to < 0 && playlist.current >= 0) {
 		if (currentSong == from)
 			/* no-op, can't be moved to offset of itself */
-			return 0;
+			return PLAYLIST_RESULT_SUCCESS;
 		to = (currentSong + abs(to)) % playlist.length;
 	}
 
@@ -1138,14 +1110,15 @@ int moveSongInPlaylist(int fd, int from, int to)
 	queueNextSongInPlaylist();
 	incrPlaylistVersion();
 
-	return 0;
+	return PLAYLIST_RESULT_SUCCESS;
 }
 
-int moveSongInPlaylistById(int fd, int id1, int to)
+enum playlist_result moveSongInPlaylistById(int id1, int to)
 {
-	checkSongId(id1);
+	if (!song_id_exists(id1))
+		return PLAYLIST_RESULT_NO_SUCH_SONG;
 
-	return moveSongInPlaylist(fd, playlist.idToPosition[id1], to);
+	return moveSongInPlaylist(playlist.idToPosition[id1], to);
 }
 
 static void orderPlaylist(void)
@@ -1254,7 +1227,7 @@ void previousSongInPlaylist(void)
 	play_order_num(prev_order_num, 0);
 }
 
-void shufflePlaylist(mpd_unused int fd)
+void shufflePlaylist(void)
 {
 	int i;
 	int ri;
@@ -1293,50 +1266,39 @@ void shufflePlaylist(mpd_unused int fd)
 	}
 }
 
-int deletePlaylist(int fd, const char *utf8file)
+enum playlist_result deletePlaylist(const char *utf8file)
 {
 	char path_max_tmp[MPD_PATH_MAX];
 
 	utf8_to_fs_playlist_path(path_max_tmp, utf8file);
 
-	if (!isPlaylist(path_max_tmp)) {
-		commandError(fd, ACK_ERROR_NO_EXIST,
-			     "playlist \"%s\" not found", utf8file);
-		return -1;
-	}
+	if (!isPlaylist(path_max_tmp))
+		return PLAYLIST_RESULT_NO_SUCH_LIST;
 
-	if (unlink(path_max_tmp) < 0) {
-		commandError(fd, ACK_ERROR_SYSTEM,
-			     "problems deleting file");
-		return -1;
-	}
+	if (unlink(path_max_tmp) < 0)
+		return PLAYLIST_RESULT_ERRNO;
 
-	return 0;
+	return PLAYLIST_RESULT_SUCCESS;
 }
 
-int savePlaylist(int fd, const char *utf8file)
+enum playlist_result savePlaylist(const char *utf8file)
 {
 	FILE *fp;
 	int i;
 	struct stat sb;
 	char path_max_tmp[MPD_PATH_MAX];
 
-	if (!valid_playlist_name(fd, utf8file))
-		return -1;
+	if (!is_valid_playlist_name(utf8file))
+		return PLAYLIST_RESULT_BAD_NAME;
 
 	utf8_to_fs_playlist_path(path_max_tmp, utf8file);
-	if (!stat(path_max_tmp, &sb)) {
-		commandError(fd, ACK_ERROR_EXIST, "a file or directory already "
-			     "exists with the name \"%s\"", utf8file);
-		return -1;
-	}
+	if (!stat(path_max_tmp, &sb))
+		return PLAYLIST_RESULT_LIST_EXISTS;
 
 	while (!(fp = fopen(path_max_tmp, "w")) && errno == EINTR);
 
-	if (fp == NULL) {
-		commandError(fd, ACK_ERROR_SYSTEM, "failed to create file");
-		return -1;
-	}
+	if (fp == NULL)
+		return PLAYLIST_RESULT_ERRNO;
 
 	for (i = 0; i < playlist.length; i++) {
 		char tmp[MPD_PATH_MAX];
@@ -1353,7 +1315,7 @@ int savePlaylist(int fd, const char *utf8file)
 
 	while (fclose(fp) && errno == EINTR) ;
 
-	return 0;
+	return PLAYLIST_RESULT_SUCCESS;
 }
 
 int getPlaylistCurrentSong(void)
@@ -1380,16 +1342,13 @@ int getPlaylistLength(void)
  * This command will always return 0 regardless of whether or
  * not the seek succeeded (it's always been the case, apparently)
  */
-int seekSongInPlaylist(int fd, int song, float seek_time)
+enum playlist_result seekSongInPlaylist(int song, float seek_time)
 {
 	int i = song;
 	char path[MPD_PATH_MAX];
 
-	if (song < 0 || song >= playlist.length) {
-		commandError(fd, ACK_ERROR_NO_EXIST,
-			     "song doesn't exist: \"%i\"", song);
-		return -1;
-	}
+	if (song < 0 || song >= playlist.length)
+		return PLAYLIST_RESULT_BAD_RANGE;
 
 	if (playlist.random)
 		for (i = 0; song != playlist.order[i]; i++) ;
@@ -1402,7 +1361,7 @@ int seekSongInPlaylist(int fd, int song, float seek_time)
 	    (playlist.current == i && playlist.queued == i)) {
 		dc_trigger_action(DC_ACTION_SEEK, seek_time);
 		if (dc.seek_where != DC_SEEK_MISMATCH)
-			return 0;
+			return PLAYLIST_RESULT_SUCCESS;
 		/*
 		 * if near end of decoding can cause seek to fail (since we're
 		 * already on another song) (leading to DC_SEEK_MISMATCH),
@@ -1412,14 +1371,15 @@ int seekSongInPlaylist(int fd, int song, float seek_time)
 
 	DEBUG("playlist: seek %i:\"%s\"\n", i, get_song_url(path, song_at(i)));
 	play_order_num(i, seek_time);
-	return 0;
+	return PLAYLIST_RESULT_SUCCESS;
 }
 
-int seekSongInPlaylistById(int fd, int id, float seek_time)
+enum playlist_result seekSongInPlaylistById(int id, float seek_time)
 {
-	checkSongId(id);
+	if (!song_id_exists(id))
+		return PLAYLIST_RESULT_NO_SUCH_SONG;
 
-	return seekSongInPlaylist(fd, playlist.idToPosition[id], seek_time);
+	return seekSongInPlaylist(playlist.idToPosition[id], seek_time);
 }
 
 int getPlaylistSongId(int song)
@@ -1470,7 +1430,7 @@ int loadPlaylist(int fd, const char *utf8file)
 	node = list->firstNode;
 	while (node != NULL) {
 		char *temp = node->data;
-		if ((addToPlaylist(STDERR_FILENO, temp, NULL)) < 0) {
+		if ((addToPlaylist(temp, NULL)) != PLAYLIST_RESULT_SUCCESS) {
 			/* for windows compatibility, convert slashes */
 			char *temp2 = xstrdup(temp);
 			char *p = temp2;
@@ -1479,7 +1439,7 @@ int loadPlaylist(int fd, const char *utf8file)
 					*p = '/';
 				p++;
 			}
-			if ((addToPlaylist(STDERR_FILENO, temp2, NULL)) < 0) {
+			if ((addToPlaylist(temp, NULL)) != PLAYLIST_RESULT_SUCCESS) {
 				commandError(fd, ACK_ERROR_PLAYLIST_LOAD,
 							"can't add file \"%s\"", temp2);
 			}