command: add commands "addtagid", "cleartagid"

Makefile.am

@@ -82,6 +82,7 @@ src_mpd_SOURCES = \
 	src/command/CommandError.cxx src/command/CommandError.hxx \
 	src/command/AllCommands.cxx src/command/AllCommands.hxx \
 	src/command/QueueCommands.cxx src/command/QueueCommands.hxx \
+	src/command/TagCommands.cxx src/command/TagCommands.hxx \
 	src/command/PlayerCommands.cxx src/command/PlayerCommands.hxx \
 	src/command/PlaylistCommands.cxx src/command/PlaylistCommands.hxx \
 	src/command/DatabaseCommands.cxx src/command/DatabaseCommands.hxx \
@@ -170,6 +171,7 @@ src_mpd_SOURCES = \
 	src/PlaylistGlobal.cxx src/PlaylistGlobal.hxx \
 	src/PlaylistControl.cxx \
 	src/PlaylistEdit.cxx \
+	src/PlaylistTag.cxx \
 	src/PlaylistPrint.cxx src/PlaylistPrint.hxx \
 	src/PlaylistSave.cxx src/PlaylistSave.hxx \
 	src/PlaylistMapper.cxx src/PlaylistMapper.hxx \

NEWS

@@ -1,4 +1,6 @@
 ver 0.19 (not yet released)
+* protocol
+  - new commands "addtagid", "cleartagid"
 * new resampler option using libsoxr
 
 ver 0.18.5 (2013/11/23)

doc/protocol.xml

@@ -1258,6 +1258,44 @@ OK
             </para>
           </listitem>
         </varlistentry>
+
+        <varlistentry id="command_addtagid">
+          <term>
+            <cmdsynopsis>
+              <command>addtagid</command>
+              <arg choice="req"><replaceable>SONGID</replaceable></arg>
+              <arg choice="req"><replaceable>TAG</replaceable></arg>
+              <arg choice="req"><replaceable>VALUE</replaceable></arg>
+            </cmdsynopsis>
+          </term>
+          <listitem>
+            <para>
+              Adds a tag to the specified song.  Editing song tags is
+              only possible for remote songs.  This change is
+              volatile: it may be overwritten by tags received from
+              the server, and the data is gone when the song gets
+              removed from the queue.
+            </para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry id="command_cleartagid">
+          <term>
+            <cmdsynopsis>
+              <command>cleartagid</command>
+              <arg choice="req"><replaceable>SONGID</replaceable></arg>
+              <arg choice="opt"><replaceable>TAG</replaceable></arg>
+            </cmdsynopsis>
+          </term>
+          <listitem>
+            <para>
+              Removes tags from the specified song.  If
+              <varname>TAG</varname> is not specified, then all tag
+              values will be removed.  Editing song tags is only
+              possible for remote songs.
+            </para>
+          </listitem>
+        </varlistentry>
       </variablelist>
     </section>
 

src/Playlist.hxx

@@ -23,8 +23,10 @@
 #include "Queue.hxx"
 #include "PlaylistError.hxx"
 
+enum TagType : uint8_t;
 struct PlayerControl;
 struct Song;
+class Error;
 
 struct playlist {
 	/**
@@ -205,6 +207,10 @@ public:
 	PlaylistResult SetPriorityId(PlayerControl &pc,
 				     unsigned song_id, uint8_t priority);
 
+	bool AddSongIdTag(unsigned id, TagType tag_type, const char *value,
+			  Error &error);
+	bool ClearSongIdTag(unsigned id, TagType tag_type, Error &error);
+
 	void Stop(PlayerControl &pc);
 
 	PlaylistResult PlayPosition(PlayerControl &pc, int position);

src/PlaylistTag.cxx

@@ -0,0 +1,87 @@
+/*
+ * Copyright (C) 2003-2013 The Music Player Daemon Project
+ * http://www.musicpd.org
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+/*
+ * Functions for editing the playlist (adding, removing, reordering
+ * songs in the queue).
+ *
+ */
+
+#include "config.h"
+#include "Playlist.hxx"
+#include "PlaylistError.hxx"
+#include "Song.hxx"
+#include "tag/Tag.hxx"
+#include "util/Error.hxx"
+
+bool
+playlist::AddSongIdTag(unsigned id, TagType tag_type, const char *value,
+		       Error &error)
+{
+	const int position = queue.IdToPosition(id);
+	if (position < 0) {
+		error.Set(playlist_domain, int(PlaylistResult::NO_SUCH_SONG),
+			  "No such song");
+		return false;
+	}
+
+	Song &song = queue.Get(position);
+	if (song.IsFile()) {
+		error.Set(playlist_domain, int(PlaylistResult::DENIED),
+			  "Cannot edit tags of local file");
+		return false;
+	}
+
+	if (song.tag == nullptr)
+		song.tag = new Tag();
+	song.tag->AddItem(tag_type, value);
+	queue.ModifyAtPosition(position);
+	OnModified();
+	return true;
+}
+
+bool
+playlist::ClearSongIdTag(unsigned id, TagType tag_type,
+			 Error &error)
+{
+	const int position = queue.IdToPosition(id);
+	if (position < 0) {
+		error.Set(playlist_domain, int(PlaylistResult::NO_SUCH_SONG),
+			  "No such song");
+		return false;
+	}
+
+	Song &song = queue.Get(position);
+	if (song.IsFile()) {
+		error.Set(playlist_domain, int(PlaylistResult::DENIED),
+			  "Cannot edit tags of local file");
+		return false;
+	}
+
+	if (song.tag == nullptr)
+		return true;
+
+	if (tag_type == TAG_NUM_OF_ITEM_TYPES)
+		song.tag->RemoveAll();
+	else
+		song.tag->RemoveType(tag_type);
+	queue.ModifyAtPosition(position);
+	OnModified();
+	return true;
+}

src/command/AllCommands.cxx

@@ -20,6 +20,7 @@
 #include "config.h"
 #include "AllCommands.hxx"
 #include "QueueCommands.hxx"
+#include "TagCommands.hxx"
 #include "PlayerCommands.hxx"
 #include "PlaylistCommands.hxx"
 #include "DatabaseCommands.hxx"
@@ -74,9 +75,11 @@ handle_not_commands(Client &client, int argc, char *argv[]);
 static const struct command commands[] = {
 	{ "add", PERMISSION_ADD, 1, 1, handle_add },
 	{ "addid", PERMISSION_ADD, 1, 2, handle_addid },
+	{ "addtagid", PERMISSION_ADD, 3, 3, handle_addtagid },
 	{ "channels", PERMISSION_READ, 0, 0, handle_channels },
 	{ "clear", PERMISSION_CONTROL, 0, 0, handle_clear },
 	{ "clearerror", PERMISSION_CONTROL, 0, 0, handle_clearerror },
+	{ "cleartagid", PERMISSION_ADD, 1, 2, handle_cleartagid },
 	{ "close", PERMISSION_NONE, -1, -1, handle_close },
 	{ "commands", PERMISSION_NONE, 0, 0, handle_commands },
 	{ "config", PERMISSION_ADMIN, 0, 0, handle_config },

src/command/TagCommands.cxx

@@ -0,0 +1,78 @@
+/*
+ * Copyright (C) 2003-2013 The Music Player Daemon Project
+ * http://www.musicpd.org
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#include "config.h"
+#include "TagCommands.hxx"
+#include "CommandError.hxx"
+#include "Client.hxx"
+#include "protocol/ArgParser.hxx"
+#include "protocol/Result.hxx"
+#include "tag/Tag.hxx"
+#include "Partition.hxx"
+
+CommandResult
+handle_addtagid(Client &client, gcc_unused int argc, char *argv[])
+{
+	unsigned song_id;
+	if (!check_unsigned(client, &song_id, argv[1]))
+		return CommandResult::ERROR;
+
+	const char *const tag_name = argv[2];
+	const TagType tag_type = tag_name_parse_i(tag_name);
+	if (tag_type == TAG_NUM_OF_ITEM_TYPES) {
+		command_error(client, ACK_ERROR_ARG,
+			      "Unknown tag type: %s", tag_name);
+		return CommandResult::ERROR;
+	}
+
+	const char *const value = argv[3];
+
+	Error error;
+	if (!client.partition.playlist.AddSongIdTag(song_id, tag_type, value,
+						    error))
+		return print_error(client, error);
+
+	return CommandResult::OK;
+}
+
+CommandResult
+handle_cleartagid(Client &client, int argc, char *argv[])
+{
+	unsigned song_id;
+	if (!check_unsigned(client, &song_id, argv[1]))
+		return CommandResult::ERROR;
+
+	TagType tag_type = TAG_NUM_OF_ITEM_TYPES;
+	if (argc >= 3) {
+		const char *const tag_name = argv[2];
+		tag_type = tag_name_parse_i(tag_name);
+		if (tag_type == TAG_NUM_OF_ITEM_TYPES) {
+			command_error(client, ACK_ERROR_ARG,
+				      "Unknown tag type: %s", tag_name);
+			return CommandResult::ERROR;
+		}
+	}
+
+	Error error;
+	if (!client.partition.playlist.ClearSongIdTag(song_id, tag_type,
+						      error))
+		return print_error(client, error);
+
+	return CommandResult::OK;
+}

src/command/TagCommands.hxx

@@ -0,0 +1,33 @@
+/*
+ * Copyright (C) 2003-2013 The Music Player Daemon Project
+ * http://www.musicpd.org
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#ifndef MPD_TAG_COMMANDS_HXX
+#define MPD_TAG_COMMANDS_HXX
+
+#include "CommandResult.hxx"
+
+class Client;
+
+CommandResult
+handle_addtagid(Client &client, int argc, char *argv[]);
+
+CommandResult
+handle_cleartagid(Client &client, int argc, char *argv[]);
+
+#endif