input/curl: move code to class CurlRequest

Makefile.am

@@ -1277,8 +1277,10 @@ if ENABLE_CURL
 libinput_a_SOURCES += \
 	src/input/IcyInputStream.cxx src/input/IcyInputStream.hxx \
 	src/input/plugins/CurlInputPlugin.cxx src/input/plugins/CurlInputPlugin.hxx \
+	src/lib/curl/Version.cxx src/lib/curl/Version.hxx \
 	src/lib/curl/Global.cxx src/lib/curl/Global.hxx \
-	src/lib/curl/Request.hxx \
+	src/lib/curl/Request.cxx src/lib/curl/Request.hxx \
+	src/lib/curl/Handler.hxx \
 	src/lib/curl/Easy.hxx \
 	src/lib/curl/Multi.hxx \
 	src/IcyMetaDataParser.cxx src/IcyMetaDataParser.hxx

src/lib/curl/Global.cxx

@@ -179,6 +179,8 @@ CurlGlobal::Remove(CURL *easy)
 	assert(easy != nullptr);
 
 	curl_multi_remove_handle(multi.Get(), easy);
+
+	InvalidateSockets();
 }
 
 static CurlRequest *

src/lib/curl/Handler.hxx

+/*
+ * Copyright (C) 2008-2017 Max Kellermann <max@duempel.org>
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * - Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *
+ * - Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the
+ * distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
+ * FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+ * OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef CURL_HANDLER_HXX
+#define CURL_HANDLER_HXX
+
+#include "util/ConstBuffer.hxx"
+
+#include <exception>
+#include <string>
+#include <map>
+
+class CurlResponseHandler {
+public:
+	virtual void OnHeaders(unsigned status,
+			       std::multimap<std::string, std::string> &&headers) = 0;
+	virtual void OnData(ConstBuffer<void> data) = 0;
+	virtual void OnEnd() = 0;
+	virtual void OnError(std::exception_ptr e) = 0;
+};
+
+#endif

src/lib/curl/Request.cxx

+/*
+ * Copyright (C) 2008-2017 Max Kellermann <max@duempel.org>
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * - Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *
+ * - Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the
+ * distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
+ * FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+ * OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include "config.h"
+#include "Request.hxx"
+#include "Global.hxx"
+#include "Version.hxx"
+#include "Handler.hxx"
+#include "util/RuntimeError.hxx"
+#include "util/StringUtil.hxx"
+#include "util/StringView.hxx"
+#include "util/CharUtil.hxx"
+
+#include <curl/curl.h>
+
+#include <algorithm>
+
+#include <assert.h>
+#include <string.h>
+
+CurlRequest::CurlRequest(CurlGlobal &_global, const char *url,
+			 CurlResponseHandler &_handler)
+	:global(_global), handler(_handler)
+{
+	error_buffer[0] = 0;
+
+	easy.SetOption(CURLOPT_PRIVATE, (void *)this);
+	easy.SetOption(CURLOPT_USERAGENT, "Music Player Daemon " VERSION);
+	easy.SetOption(CURLOPT_HEADERFUNCTION, _HeaderFunction);
+	easy.SetOption(CURLOPT_WRITEHEADER, this);
+	easy.SetOption(CURLOPT_WRITEFUNCTION, WriteFunction);
+	easy.SetOption(CURLOPT_WRITEDATA, this);
+	easy.SetOption(CURLOPT_NETRC, 1l);
+	easy.SetOption(CURLOPT_ERRORBUFFER, error_buffer);
+	easy.SetOption(CURLOPT_NOPROGRESS, 1l);
+	easy.SetOption(CURLOPT_NOSIGNAL, 1l);
+	easy.SetOption(CURLOPT_CONNECTTIMEOUT, 10l);
+	easy.SetOption(CURLOPT_URL, url);
+
+	global.Add(easy.Get(), *this);
+}
+
+CurlRequest::~CurlRequest()
+{
+	FreeEasy();
+}
+
+void
+CurlRequest::FreeEasy()
+{
+	if (!easy)
+		return;
+
+	global.Remove(easy.Get());
+	easy = nullptr;
+}
+
+void
+CurlRequest::Resume()
+{
+	curl_easy_pause(easy.Get(), CURLPAUSE_CONT);
+
+	if (IsCurlOlderThan(0x072000))
+		/* libcurl older than 7.32.0 does not update
+		   its sockets after curl_easy_pause(); force
+		   libcurl to do it now */
+		global.ResumeSockets();
+
+	global.InvalidateSockets();
+}
+
+bool
+CurlRequest::FinishHeaders()
+{
+	if (state != State::HEADERS)
+		return true;
+
+	state = State::BODY;
+
+	long status = 0;
+	curl_easy_getinfo(easy.Get(), CURLINFO_RESPONSE_CODE, &status);
+
+	try {
+		handler.OnHeaders(status, std::move(headers));
+		return true;
+	} catch (...) {
+		state = State::CLOSED;
+		handler.OnError(std::current_exception());
+		return false;
+	}
+}
+
+void
+CurlRequest::FinishBody()
+{
+	if (!FinishHeaders())
+		return;
+
+	if (state != State::BODY)
+		return;
+
+	state = State::CLOSED;
+	handler.OnEnd();
+}
+
+void
+CurlRequest::Done(CURLcode result)
+{
+	FreeEasy();
+
+	try {
+		if (result != CURLE_OK) {
+			StripRight(error_buffer);
+			const char *msg = error_buffer;
+			if (*msg == 0)
+				msg = curl_easy_strerror(result);
+			throw FormatRuntimeError("CURL failed: %s", msg);
+		}
+	} catch (...) {
+		state = State::CLOSED;
+		handler.OnError(std::current_exception());
+		return;
+	}
+
+	FinishBody();
+}
+
+inline void
+CurlRequest::HeaderFunction(StringView s)
+{
+	if (state > State::HEADERS)
+		return;
+
+	if (s.size > 5 && memcmp(s.data, "HTTP/", 5) == 0) {
+		/* this is the boundary to a new response, for example
+		   after a redirect */
+		headers.clear();
+		return;
+	}
+
+	const char *header = s.data;
+	const char *end = StripRight(header, header + s.size);
+
+	const char *value = s.Find(':');
+	if (value == nullptr)
+		return;
+
+	std::string name(header, value);
+	std::transform(name.begin(), name.end(), name.begin(), ToLowerASCII);
+
+	/* skip the colon */
+
+	++value;
+
+	/* strip the value */
+
+	value = StripLeft(value, end);
+	end = StripRight(value, end);
+
+	headers.emplace(std::move(name), std::string(value, end));
+}
+
+size_t
+CurlRequest::_HeaderFunction(void *ptr, size_t size, size_t nmemb, void *stream)
+{
+	CurlRequest &c = *(CurlRequest *)stream;
+
+	size *= nmemb;
+
+	c.HeaderFunction({(const char *)ptr, size});
+	return size;
+}
+
+inline size_t
+CurlRequest::DataReceived(const void *ptr, size_t received_size)
+{
+	assert(received_size > 0);
+
+	if (!FinishHeaders())
+		return 0;
+
+	try {
+		handler.OnData({ptr, received_size});
+		return received_size;
+	} catch (Pause) {
+		return CURL_WRITEFUNC_PAUSE;
+	} catch (...) {
+		state = State::CLOSED;
+		handler.OnError(std::current_exception());
+		return 0;
+	}
+
+}
+
+size_t
+CurlRequest::WriteFunction(void *ptr, size_t size, size_t nmemb, void *stream)
+{
+	CurlRequest &c = *(CurlRequest *)stream;
+
+	size *= nmemb;
+	if (size == 0)
+		return 0;
+
+	return c.DataReceived(ptr, size);
+}

src/lib/curl/Request.hxx

 /*
- * Copyright (C) 2008-2016 Max Kellermann <max@duempel.org>
+ * Copyright (C) 2008-2017 Max Kellermann <max@duempel.org>
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
@@ -30,14 +30,85 @@
 #ifndef CURL_REQUEST_HXX
 #define CURL_REQUEST_HXX
 
-#include <curl/curl.h>
+#include "Easy.hxx"
+
+#include <map>
+#include <string>
+
+struct StringView;
+class CurlGlobal;
+class CurlResponseHandler;
 
 class CurlRequest {
+	CurlGlobal &global;
+
+	CurlResponseHandler &handler;
+
+	/** the curl handle */
+	CurlEasy easy;
+
+	enum class State {
+		HEADERS,
+		BODY,
+		CLOSED,
+	} state = State::HEADERS;
+
+	std::multimap<std::string, std::string> headers;
+
+	/** error message provided by libcurl */
+	char error_buffer[CURL_ERROR_SIZE];
+
 public:
+	CurlRequest(CurlGlobal &_global, const char *url,
+		    CurlResponseHandler &_handler);
+	~CurlRequest();
+
+	CurlRequest(const CurlRequest &) = delete;
+	CurlRequest &operator=(const CurlRequest &) = delete;
+
+	CURL *Get() {
+		return easy.Get();
+	}
+
+	template<typename T>
+	void SetOption(CURLoption option, T value) {
+		easy.SetOption(option, value);
+	}
+
+	/**
+	 * CurlResponseHandler::OnData() shall throw this to pause the
+	 * stream.  Call Resume() to resume the transfer.
+	 */
+	struct Pause {};
+
+	void Resume();
+
 	/**
 	 * A HTTP request is finished.  Called by #CurlGlobal.
 	 */
-	virtual void Done(CURLcode result) = 0;
+	void Done(CURLcode result);
+
+private:
+	/**
+	 * Frees the current "libcurl easy" handle, and everything
+	 * associated with it.
+	 */
+	void FreeEasy();
+
+	bool FinishHeaders();
+	void FinishBody();
+
+	size_t DataReceived(const void *ptr, size_t size);
+
+	void HeaderFunction(StringView s);
+
+	/** called by curl when new data is available */
+	static size_t _HeaderFunction(void *ptr, size_t size, size_t nmemb,
+				      void *stream);
+
+	/** called by curl when new data is available */
+	static size_t WriteFunction(void *ptr, size_t size, size_t nmemb,
+				    void *stream);
 };
 
 #endif

src/lib/curl/Version.cxx

+/*
+ * Copyright (C) 2017 Max Kellermann <max@duempel.org>
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * - Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *
+ * - Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the
+ * distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
+ * FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+ * OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include "Version.hxx"
+
+#include <curl/curl.h>
+
+bool
+IsCurlOlderThan(unsigned version_num)
+{
+	const auto *const info = curl_version_info(CURLVERSION_FIRST);
+	return info == nullptr || info->version_num < version_num;
+}

src/lib/curl/Version.hxx

+/*
+ * Copyright (C) 2017 Max Kellermann <max@duempel.org>
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * - Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ *
+ * - Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the
+ * distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
+ * FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+ * OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef CURL_VERSION_HXX
+#define CURL_VERSION_HXX
+
+#include "Compiler.h"
+
+gcc_const
+bool
+IsCurlOlderThan(unsigned version_num);
+
+#endif