oysteikt/mpd
0
0
Fork 0
Code Issues Pull Requests Releases Activity

lib/upnp/Action: common UpnpSendAction() wrapper for pupnp and npupnp

Browse Source 
Merge a lot of duplicate code.
This commit is contained in:
Max Kellermann 2024-01-04 16:44:12 +01:00
parent 95842e7984
commit cbd031ca7f
8 changed files with 187 additions and 308 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

205
src/db/plugins/upnp/ContentDirectoryService.cxx
View File

@ -2,33 +2,21 @@
// Copyright The Music Player Daemon Project
#include "lib/upnp/ContentDirectoryService.hxx"
#include "lib/upnp/Error.hxx"
#include "lib/upnp/Action.hxx"
#include "Directory.hxx"
#include "util/NumberParser.hxx"
#include "util/ScopeExit.hxx"
#include "config.h"
#ifdef USING_PUPNP
#include "lib/upnp/ixmlwrap.hxx"
#include "lib/upnp/Action.hxx"
#include "lib/upnp/UniqueIxml.hxx"
#endif
#include <fmt/format.h>
#include <algorithm>
#ifdef USING_PUPNP
static void
ReadResultTag(UPnPDirContent &dirbuf, IXML_Document *response)
ReadResultTag(UPnPDirContent &dirbuf, const UpnpActionResponse &response)
{
const char *p = ixmlwrap::getFirstElementValue(response, "Result");
const char *p = response.GetValue("Result");
if (p == nullptr)
p = "";
dirbuf.Parse(p);
}
#endif
inline void
ContentDirectoryService::readDirSlice(UpnpClient_Handle hdl,
@ -37,71 +25,28 @@ ContentDirectoryService::readDirSlice(UpnpClient_Handle hdl,
unsigned &didreadp,
unsigned &totalp) const
{
#ifdef USING_PUPNP
// Some devices require an empty SortCriteria, else bad params
IXML_Document *request =
MakeActionHelper("Browse", m_serviceType.c_str(),
"ObjectID", objectId,
"BrowseFlag", "BrowseDirectChildren",
"Filter", "*",
"SortCriteria", "",
"StartingIndex",
fmt::format_int{offset}.c_str(),
"RequestedCount",
fmt::format_int{count}.c_str());
if (request == nullptr)
throw std::runtime_error("UpnpMakeAction() failed");
const auto response = UpnpSendAction(hdl, m_actionURL.c_str(),
"Browse", m_serviceType.c_str(),
{
{"ObjectID", objectId},
{"BrowseFlag", "BrowseDirectChildren"},
{"Filter", "*"},
{"SortCriteria", ""},
{"StartingIndex", fmt::format_int{offset}.c_str()},
{"RequestedCount", fmt::format_int{count}.c_str()},
});
AtScopeExit(request) { ixmlDocument_free(request); };
IXML_Document *response;
int code = UpnpSendAction(hdl, m_actionURL.c_str(), m_serviceType.c_str(),
nullptr /*devUDN*/, request, &response);
if (code != UPNP_E_SUCCESS)
throw Upnp::MakeError(code, "UpnpSendAction() failed");
AtScopeExit(response) { ixmlDocument_free(response); };
const char *value = ixmlwrap::getFirstElementValue(response, "NumberReturned");
const char *value = response.GetValue("NumberReturned");
didreadp = value != nullptr
? ParseUnsigned(value)
: 0;
value = ixmlwrap::getFirstElementValue(response, "TotalMatches");
value = response.GetValue("TotalMatches");
if (value != nullptr)
totalp = ParseUnsigned(value);
ReadResultTag(dirbuf, response);
#else
std::vector<std::pair<std::string, std::string>> actionParams{
{"ObjectID", objectId},
{"BrowseFlag", "BrowseDirectChildren"},
{"Filter", "*"},
{"SortCriteria", ""},
{"StartingIndex", fmt::format_int{offset}.c_str()},
{"RequestedCount", fmt::format_int{count}.c_str()},
};
std::vector<std::pair<std::string, std::string>> responseData;
int errcode;
std::string errdesc;
int code = UpnpSendAction(hdl, "", m_actionURL, m_serviceType, "Browse",
actionParams, responseData, &errcode, errdesc);
if (code != UPNP_E_SUCCESS)
throw Upnp::MakeError(code, "UpnpSendAction() failed");
const char *p = "";
didreadp = 0;
for (const auto &entry : responseData) {
if (entry.first == "Result") {
p = entry.second.c_str();
} else if (entry.first == "TotalMatches") {
totalp = ParseUnsigned(entry.second.c_str());
} else if (entry.first == "NumberReturned") {
didreadp = ParseUnsigned(entry.second.c_str());
}
}
dirbuf.Parse(p);
#endif
}
UPnPDirContent
@ -130,73 +75,29 @@ ContentDirectoryService::search(UpnpClient_Handle hdl,
unsigned offset = 0, total = -1, count;
do {
#ifdef USING_PUPNP
UniqueIxmlDocument request(MakeActionHelper("Search", m_serviceType.c_str(),
"ContainerID", objectId,
"SearchCriteria", ss,
"Filter", "*",
"SortCriteria", "",
"StartingIndex",
fmt::format_int{offset}.c_str(),
"RequestedCount", "0")); // Setting a value here gets twonky into fits
if (!request)
throw std::runtime_error("UpnpMakeAction() failed");
const auto response = UpnpSendAction(hdl, m_actionURL.c_str(),
"Search", m_serviceType.c_str(),
{
{"ContainerID", objectId},
{"SearchCriteria", ss},
{"Filter", "*"},
{"SortCriteria", ""},
{"StartingIndex", fmt::format_int{offset}.c_str()},
{"RequestedCount", "0"}, // Setting a value here gets twonky into fits
});
IXML_Document *_response;
auto code = UpnpSendAction(hdl, m_actionURL.c_str(),
m_serviceType.c_str(),
nullptr /*devUDN*/,
request.get(), &_response);
if (code != UPNP_E_SUCCESS)
throw Upnp::MakeError(code, "UpnpSendAction() failed");
UniqueIxmlDocument response(_response);
const char *value =
ixmlwrap::getFirstElementValue(response.get(),
"NumberReturned");
const char *value = response.GetValue("NumberReturned");
count = value != nullptr
? ParseUnsigned(value)
: 0;
offset += count;
value = ixmlwrap::getFirstElementValue(response.get(),
"TotalMatches");
value = response.GetValue("TotalMatches");
if (value != nullptr)
total = ParseUnsigned(value);
ReadResultTag(dirbuf, response.get());
#else
std::vector<std::pair<std::string, std::string>> actionParams{
{"ContainerID", objectId},
{"SearchCriteria", ss},
{"Filter", "*"},
{"SortCriteria", ""},
{"StartingIndex", fmt::format_int{offset}.c_str()},
{"RequestedCount", "0"}};
std::vector<std::pair<std::string, std::string>> responseData;
int errcode;
std::string errdesc;
int code = UpnpSendAction(hdl, "", m_actionURL, m_serviceType, "Search",
actionParams, responseData, &errcode, errdesc);
if (code != UPNP_E_SUCCESS)
throw Upnp::MakeError(code, "UpnpSendAction() failed");
const char *p = "";
count = 0;
for (const auto &entry : responseData) {
if (entry.first == "Result") {
p = entry.second.c_str();
} else if (entry.first == "TotalMatches") {
total = ParseUnsigned(entry.second.c_str());
} else if (entry.first == "NumberReturned") {
count = ParseUnsigned(entry.second.c_str());
offset += count;
}
}
dirbuf.Parse(p);
#endif
ReadResultTag(dirbuf, response);
} while (count > 0 && offset < total);
return dirbuf;
@ -206,46 +107,18 @@ UPnPDirContent
ContentDirectoryService::getMetadata(UpnpClient_Handle hdl,
const char *objectId) const
{
#ifdef USING_PUPNP
// Create request
UniqueIxmlDocument request(MakeActionHelper("Browse", m_serviceType.c_str(),
"ObjectID", objectId,
"BrowseFlag", "BrowseMetadata",
"Filter", "*",
"SortCriteria", "",
"StartingIndex", "0",
"RequestedCount", "1"));
if (request == nullptr)
throw std::runtime_error("UpnpMakeAction() failed");
const auto response = UpnpSendAction(hdl, m_actionURL.c_str(),
"Browse", m_serviceType.c_str(),
{
{"ObjectID", objectId},
{"BrowseFlag", "BrowseMetadata"},
{"Filter", "*"},
{"SortCriteria", ""},
{"StartingIndex", "0"},
{"RequestedCount", "1"},
});
IXML_Document *_response;
auto code = UpnpSendAction(hdl, m_actionURL.c_str(),
m_serviceType.c_str(),
nullptr /*devUDN*/, request.get(), &_response);
if (code != UPNP_E_SUCCESS)
throw Upnp::MakeError(code, "UpnpSendAction() failed");
UniqueIxmlDocument response(_response);
UPnPDirContent dirbuf;
ReadResultTag(dirbuf, response.get());
ReadResultTag(dirbuf, response);
return dirbuf;
#else
std::vector<std::pair<std::string, std::string>> actionParams{
{"ObjectID", objectId}, {"BrowseFlag", "BrowseMetadata"},
{"Filter", "*"}, {"SortCriteria", ""},
{"StartingIndex", "0"}, {"RequestedCount", "1"}};
std::vector<std::pair<std::string, std::string>> responseData;
int errcode;
std::string errdesc;
int code = UpnpSendAction(hdl, "", m_actionURL, m_serviceType, "Browse",
actionParams, responseData, &errcode, errdesc);
if (code != UPNP_E_SUCCESS)
throw Upnp::MakeError(code, "UpnpSendAction() failed");
auto it = std::find_if(responseData.begin(), responseData.end(), [](auto&& entry){ return entry.first == "Result"; });
const char *p = it != responseData.end() ? it->second.c_str() : "";
UPnPDirContent dirbuf;
dirbuf.Parse(p);
return dirbuf;
#endif
}

81
src/lib/upnp/Action.cxx Normal file
View File

@ -0,0 +1,81 @@
// SPDX-License-Identifier: GPL-2.0-or-later
// Copyright The Music Player Daemon Project
#include "Action.hxx"
#include "Error.hxx"
#ifdef USING_PUPNP
#include "util/ScopeExit.hxx"
#include <upnptools.h>
static IXML_Document *
UpnpMakeAction(const char *action_name, const char *service_type,
std::initializer_list<std::pair<const char *, const char *>> args)
{
IXML_Document *doc = UpnpMakeAction(action_name, service_type, 0, nullptr, nullptr);
for (const auto &[name, value] : args)
UpnpAddToAction(&doc, action_name, service_type, name, value);
return doc;
}
const char *
UpnpActionResponse::GetValue(const char *name) const noexcept
{
IXML_NodeList *nodes = ixmlDocument_getElementsByTagName(document, name);
if (!nodes)
return nullptr;
AtScopeExit(nodes) { ixmlNodeList_free(nodes); };
IXML_Node *first = ixmlNodeList_item(nodes, 0);
if (!first)
return nullptr;
IXML_Node *dnode = ixmlNode_getFirstChild(first);
if (!dnode)
return nullptr;
return ixmlNode_getNodeValue(dnode);
}
UpnpActionResponse
UpnpSendAction(UpnpClient_Handle handle, const char *url,
const char *action_name, const char *service_type,
std::initializer_list<std::pair<const char *, const char *>> args)
{
IXML_Document *request = UpnpMakeAction(action_name, service_type, args);
AtScopeExit(request) { ixmlDocument_free(request); };
IXML_Document *response;
int code = UpnpSendAction(handle, url, service_type, nullptr,
request, &response);
if (code != UPNP_E_SUCCESS)
throw Upnp::MakeError(code, "UpnpSendAction() failed");
return UpnpActionResponse{response};
}
#else // USING_PUPNP
UpnpActionResponse
UpnpSendAction(UpnpClient_Handle handle, const char *url,
const char *action_name, const char *service_type,
const std::vector<std::pair<std::string, std::string>> &args)
{
std::vector<std::pair<std::string, std::string>> params{args};
std::vector<std::pair<std::string, std::string>> response;
int errcode;
std::string errdesc;
int code = UpnpSendAction(handle, "", url, service_type, action_name,
params, response, &errcode, errdesc);
if (code != UPNP_E_SUCCESS)
throw Upnp::MakeError(code, "UpnpSendAction() failed");
return UpnpActionResponse{std::move(response)};
}
#endif // !USING_PUPNP

88
src/lib/upnp/Action.hxx
View File

@ -3,33 +3,67 @@
#pragma once
#include <upnptools.h>
#include "config.h" // for USING_PUPNP
static constexpr unsigned
CountNameValuePairs() noexcept
{
return 0;
}
#include <upnp.h> // for UpnpClient_Handle
template<typename... Args>
static constexpr unsigned
CountNameValuePairs([[maybe_unused]] const char *name, [[maybe_unused]] const char *value,
Args... args) noexcept
{
return 1 + CountNameValuePairs(args...);
}
#include <utility> // for std::pair
/**
* A wrapper for UpnpMakeAction() that counts the number of name/value
* pairs and adds the nullptr sentinel.
*/
template<typename... Args>
static inline IXML_Document *
MakeActionHelper(const char *action_name, const char *service_type,
Args... args) noexcept
{
const unsigned n = CountNameValuePairs(args...);
return UpnpMakeAction(action_name, service_type, n,
args...,
nullptr, nullptr);
}
#ifdef USING_PUPNP
#include <initializer_list>
class UpnpActionResponse {
IXML_Document *document;
public:
explicit UpnpActionResponse(IXML_Document *_document) noexcept
:document(_document) {}
~UpnpActionResponse() noexcept {
ixmlDocument_free(document);
}
UpnpActionResponse(const UpnpActionResponse &) = delete;
UpnpActionResponse &operator=(const UpnpActionResponse &) = delete;
[[gnu::pure]]
const char *GetValue(const char *name) const noexcept;
};
UpnpActionResponse
UpnpSendAction(UpnpClient_Handle handle, const char *url,
const char *action_name, const char *service_type,
std::initializer_list<std::pair<const char *, const char *>> args);
#else // USING_PUPNP
#include <string>
#include <vector>
class UpnpActionResponse {
std::vector<std::pair<std::string, std::string>> data;
public:
explicit UpnpActionResponse(std::vector<std::pair<std::string, std::string>> &&_data) noexcept
:data(_data) {}
UpnpActionResponse(const UpnpActionResponse &) = delete;
UpnpActionResponse &operator=(const UpnpActionResponse &) = delete;
[[gnu::pure]]
const char *GetValue(std::string_view name) const noexcept {
for (const auto &i : data)
if (i.first == name)
return i.second.c_str();
return nullptr;
}
};
UpnpActionResponse
UpnpSendAction(UpnpClient_Handle handle, const char *url,
const char *action_name, const char *service_type,
const std::vector<std::pair<std::string, std::string>> &args);
#endif // !USING_PUPNP

50
src/lib/upnp/ContentDirectoryService.cxx
View File

@ -2,23 +2,13 @@
// Copyright The Music Player Daemon Project
#include "ContentDirectoryService.hxx"
#include "Action.hxx"
#include "Device.hxx"
#include "Error.hxx"
#include "util/IterableSplitString.hxx"
#include "util/UriRelative.hxx"
#include "util/UriUtil.hxx"
#include "config.h"
#ifdef USING_PUPNP
#include "ixmlwrap.hxx"
#include "Action.hxx"
#include "UniqueIxml.hxx"
#endif
#include <algorithm>
#include <upnptools.h>
using std::string_view_literals::operator""sv;
ContentDirectoryService::ContentDirectoryService(const UPnPDevice &device,
@ -42,41 +32,11 @@ ContentDirectoryService::~ContentDirectoryService() noexcept = default;
std::forward_list<std::string>
ContentDirectoryService::getSearchCapabilities(UpnpClient_Handle hdl) const
{
#ifdef USING_PUPNP
UniqueIxmlDocument request(UpnpMakeAction("GetSearchCapabilities", m_serviceType.c_str(),
0,
nullptr, nullptr));
if (!request)
throw std::runtime_error("UpnpMakeAction() failed");
const auto response = UpnpSendAction(hdl, m_actionURL.c_str(),
"GetSearchCapabilities", m_serviceType.c_str(),
{});
IXML_Document *_response;
auto code = UpnpSendAction(hdl, m_actionURL.c_str(),
m_serviceType.c_str(),
nullptr /*devUDN*/, request.get(), &_response);
if (code != UPNP_E_SUCCESS)
throw Upnp::MakeError(code, "UpnpSendAction() failed");
UniqueIxmlDocument response(_response);
const char *s = ixmlwrap::getFirstElementValue(response.get(),
"SearchCaps");
#else
std::vector<std::pair<std::string, std::string>> responseData;
int errcode;
std::string errdesc;
auto code = UpnpSendAction(hdl, "", m_actionURL, m_serviceType,
"GetSearchCapabilities", {}, responseData, &errcode,
errdesc);
if (code != UPNP_E_SUCCESS)
throw Upnp::MakeError(code, "UpnpSendAction() failed");
const char *s{nullptr};
for (auto &entry : responseData) {
if (entry.first == "SearchCaps") {
s = entry.second.c_str();
}
}
#endif
const char *s = response.GetValue("SearchCaps");
if (s == nullptr || *s == 0)
return {};

21
src/lib/upnp/UniqueIxml.hxx
View File

@ -1,21 +0,0 @@
// SPDX-License-Identifier: GPL-2.0-or-later
// Copyright The Music Player Daemon Project
#pragma once
#include <ixml.h>
#include <memory>
struct UpnpIxmlDeleter {
void operator()(IXML_Document *doc) noexcept {
ixmlDocument_free(doc);
}
void operator()(IXML_NodeList *nl) noexcept {
ixmlNodeList_free(nl);
}
};
typedef std::unique_ptr<IXML_Document, UpnpIxmlDeleter> UniqueIxmlDocument;
typedef std::unique_ptr<IXML_NodeList, UpnpIxmlDeleter> UniqueIxmlNodeList;

31
src/lib/upnp/ixmlwrap.cxx
View File

@ -1,31 +0,0 @@
// SPDX-License-Identifier: GPL-2.0-or-later
// Copyright J.F.Dockes
#include "config.h"
#ifdef USING_PUPNP
# include "ixmlwrap.hxx"
# include "UniqueIxml.hxx"
namespace ixmlwrap {
const char *
getFirstElementValue(IXML_Document *doc, const char *name) noexcept
{
UniqueIxmlNodeList nodes(ixmlDocument_getElementsByTagName(doc, name));
if (!nodes)
return nullptr;
IXML_Node *first = ixmlNodeList_item(nodes.get(), 0);
if (!first)
return nullptr;
IXML_Node *dnode = ixmlNode_getFirstChild(first);
if (!dnode)
return nullptr;
return ixmlNode_getNodeValue(dnode);
}
} // namespace ixmlwrap
#endif

17
src/lib/upnp/ixmlwrap.hxx
View File

@ -1,17 +0,0 @@
// SPDX-License-Identifier: GPL-2.0-or-later
// Copyright J.F.Dockes
#pragma once
#include <ixml.h>
namespace ixmlwrap {
/**
* Retrieve the text content for the first element of given
* name. Returns nullptr if the element does not
* contain a text node
*/
const char *getFirstElementValue(IXML_Document *doc,
const char *name) noexcept;
}

2
src/lib/upnp/meson.build
View File

@ -47,8 +47,8 @@ upnp = static_library(
'Device.cxx',
'ContentDirectoryService.cxx',
'Discovery.cxx',
'ixmlwrap.cxx',
'Util.cxx',
'Action.cxx',
include_directories: inc,
dependencies: [
log_dep,