playlist/*: move to playlist/plugins/

src/playlist/plugins/XspfPlaylistPlugin.cxx

@@ -0,0 +1,234 @@
+/*
+ * Copyright (C) 2003-2014 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 "XspfPlaylistPlugin.hxx"
+#include "../PlaylistPlugin.hxx"
+#include "../MemorySongEnumerator.hxx"
+#include "DetachedSong.hxx"
+#include "InputStream.hxx"
+#include "tag/TagBuilder.hxx"
+#include "util/Error.hxx"
+#include "util/Domain.hxx"
+#include "Expat.hxx"
+#include "Log.hxx"
+
+#include <string.h>
+
+static constexpr Domain xspf_domain("xspf");
+
+/**
+ * This is the state object for the GLib XML parser.
+ */
+struct XspfParser {
+	/**
+	 * The list of songs (in reverse order because that's faster
+	 * while adding).
+	 */
+	std::forward_list<DetachedSong> songs;
+
+	/**
+	 * The current position in the XML file.
+	 */
+	enum {
+		ROOT, PLAYLIST, TRACKLIST, TRACK,
+		LOCATION,
+	} state;
+
+	/**
+	 * The current tag within the "track" element.  This is only
+	 * valid if state==TRACK.  TAG_NUM_OF_ITEM_TYPES means there
+	 * is no (known) tag.
+	 */
+	TagType tag_type;
+
+	/**
+	 * The current song URI.  It is set by the "location" element.
+	 */
+	std::string location;
+
+	TagBuilder tag_builder;
+
+	XspfParser()
+		:state(ROOT) {}
+};
+
+static void XMLCALL
+xspf_start_element(void *user_data, const XML_Char *element_name,
+		   gcc_unused const XML_Char **atts)
+{
+	XspfParser *parser = (XspfParser *)user_data;
+
+	switch (parser->state) {
+	case XspfParser::ROOT:
+		if (strcmp(element_name, "playlist") == 0)
+			parser->state = XspfParser::PLAYLIST;
+
+		break;
+
+	case XspfParser::PLAYLIST:
+		if (strcmp(element_name, "trackList") == 0)
+			parser->state = XspfParser::TRACKLIST;
+
+		break;
+
+	case XspfParser::TRACKLIST:
+		if (strcmp(element_name, "track") == 0) {
+			parser->state = XspfParser::TRACK;
+			parser->location.clear();
+			parser->tag_type = TAG_NUM_OF_ITEM_TYPES;
+		}
+
+		break;
+
+	case XspfParser::TRACK:
+		if (strcmp(element_name, "location") == 0)
+			parser->state = XspfParser::LOCATION;
+		else if (strcmp(element_name, "title") == 0)
+			parser->tag_type = TAG_TITLE;
+		else if (strcmp(element_name, "creator") == 0)
+			/* TAG_COMPOSER would be more correct
+			   according to the XSPF spec */
+			parser->tag_type = TAG_ARTIST;
+		else if (strcmp(element_name, "annotation") == 0)
+			parser->tag_type = TAG_COMMENT;
+		else if (strcmp(element_name, "album") == 0)
+			parser->tag_type = TAG_ALBUM;
+		else if (strcmp(element_name, "trackNum") == 0)
+			parser->tag_type = TAG_TRACK;
+
+		break;
+
+	case XspfParser::LOCATION:
+		break;
+	}
+}
+
+static void XMLCALL
+xspf_end_element(void *user_data, const XML_Char *element_name)
+{
+	XspfParser *parser = (XspfParser *)user_data;
+
+	switch (parser->state) {
+	case XspfParser::ROOT:
+		break;
+
+	case XspfParser::PLAYLIST:
+		if (strcmp(element_name, "playlist") == 0)
+			parser->state = XspfParser::ROOT;
+
+		break;
+
+	case XspfParser::TRACKLIST:
+		if (strcmp(element_name, "tracklist") == 0)
+			parser->state = XspfParser::PLAYLIST;
+
+		break;
+
+	case XspfParser::TRACK:
+		if (strcmp(element_name, "track") == 0) {
+			if (!parser->location.empty())
+				parser->songs.emplace_front(std::move(parser->location),
+							    parser->tag_builder.Commit());
+
+			parser->state = XspfParser::TRACKLIST;
+		} else
+			parser->tag_type = TAG_NUM_OF_ITEM_TYPES;
+
+		break;
+
+	case XspfParser::LOCATION:
+		parser->state = XspfParser::TRACK;
+		break;
+	}
+}
+
+static void XMLCALL
+xspf_char_data(void *user_data, const XML_Char *s, int len)
+{
+	XspfParser *parser = (XspfParser *)user_data;
+
+	switch (parser->state) {
+	case XspfParser::ROOT:
+	case XspfParser::PLAYLIST:
+	case XspfParser::TRACKLIST:
+		break;
+
+	case XspfParser::TRACK:
+		if (!parser->location.empty() &&
+		    parser->tag_type != TAG_NUM_OF_ITEM_TYPES)
+			parser->tag_builder.AddItem(parser->tag_type, s, len);
+
+		break;
+
+	case XspfParser::LOCATION:
+		parser->location.assign(s, len);
+
+		break;
+	}
+}
+
+/*
+ * The playlist object
+ *
+ */
+
+static SongEnumerator *
+xspf_open_stream(InputStream &is)
+{
+	XspfParser parser;
+
+	{
+		ExpatParser expat(&parser);
+		expat.SetElementHandler(xspf_start_element, xspf_end_element);
+		expat.SetCharacterDataHandler(xspf_char_data);
+
+		Error error;
+		if (!expat.Parse(is, error)) {
+			LogError(error);
+			return nullptr;
+		}
+	}
+
+	parser.songs.reverse();
+	return new MemorySongEnumerator(std::move(parser.songs));
+}
+
+static const char *const xspf_suffixes[] = {
+	"xspf",
+	nullptr
+};
+
+static const char *const xspf_mime_types[] = {
+	"application/xspf+xml",
+	nullptr
+};
+
+const struct playlist_plugin xspf_playlist_plugin = {
+	"xspf",
+
+	nullptr,
+	nullptr,
+	nullptr,
+	xspf_open_stream,
+
+	nullptr,
+	xspf_suffixes,
+	xspf_mime_types,
+};