From 406452f019f097bf52d8db529eabe8dd2d0e977a Mon Sep 17 00:00:00 2001 From: Jean-Francois Dockes Date: Fri, 1 Nov 2013 19:26:01 +0100 Subject: UPnP database plugin [mk: renamed source files, applied coding style, reduced bloat, using MPD's threading library, using MPD's error reporting and logging library and refactoring, fixed lots of bugs] --- src/db/upnp/ContentDirectoryService.cxx | 316 ++++++++++++++++++++++++++++++++ 1 file changed, 316 insertions(+) create mode 100644 src/db/upnp/ContentDirectoryService.cxx (limited to 'src/db/upnp/ContentDirectoryService.cxx') diff --git a/src/db/upnp/ContentDirectoryService.cxx b/src/db/upnp/ContentDirectoryService.cxx new file mode 100644 index 000000000..b40f55c54 --- /dev/null +++ b/src/db/upnp/ContentDirectoryService.cxx @@ -0,0 +1,316 @@ +/* + * 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 "ContentDirectoryService.hxx" +#include "Domain.hxx" +#include "Device.hxx" +#include "ixmlwrap.hxx" +#include "Directory.hxx" +#include "Util.hxx" +#include "upnpplib.hxx" +#include "util/Error.hxx" + +#include + +#include +#include + +ContentDirectoryService::ContentDirectoryService(const UPnPDevice &device, + const UPnPService &service) + :m_actionURL(caturl(device.URLBase, service.controlURL)), + m_serviceType(service.serviceType), + m_deviceId(device.UDN), + m_friendlyName(device.friendlyName), + m_manufacturer(device.manufacturer), + m_modelName(device.modelName), + m_rdreqcnt(200) +{ + if (!m_modelName.compare("MediaTomb")) { + // Readdir by 200 entries is good for most, but MediaTomb likes + // them really big. Actually 1000 is better but I don't dare + m_rdreqcnt = 500; + } +} + +class DirBResFree { +public: + IXML_Document **rqpp, **rspp; + DirBResFree(IXML_Document** _rqpp, IXML_Document **_rspp) + :rqpp(_rqpp), rspp(_rspp) {} + ~DirBResFree() + { + if (*rqpp) + ixmlDocument_free(*rqpp); + if (*rspp) + ixmlDocument_free(*rspp); + } +}; + +bool +ContentDirectoryService::readDirSlice(const char *objectId, int offset, + int count, UPnPDirContent &dirbuf, + int *didreadp, int *totalp, + Error &error) +{ + LibUPnP *lib = LibUPnP::getLibUPnP(error); + if (lib == nullptr) + return false; + + UpnpClient_Handle hdl = lib->getclh(); + + IXML_Document *request(0); + IXML_Document *response(0); + DirBResFree cleaner(&request, &response); + + // Create request + char ofbuf[100], cntbuf[100]; + sprintf(ofbuf, "%d", offset); + sprintf(cntbuf, "%d", count); + int argcnt = 6; + // Some devices require an empty SortCriteria, else bad params + request = UpnpMakeAction("Browse", m_serviceType.c_str(), argcnt, + "ObjectID", objectId, + "BrowseFlag", "BrowseDirectChildren", + "Filter", "*", + "SortCriteria", "", + "StartingIndex", ofbuf, + "RequestedCount", cntbuf, + nullptr, nullptr); + if (request == nullptr) { + error.Set(upnp_domain, "UpnpMakeAction() failed"); + return false; + } + + int code = UpnpSendAction(hdl, m_actionURL.c_str(), m_serviceType.c_str(), + 0 /*devUDN*/, request, &response); + if (code != UPNP_E_SUCCESS) { + error.Format(upnp_domain, code, + "UpnpSendAction() failed: %s", + UpnpGetErrorMessage(code)); + return false; + } + + int didread = -1; + std::string tbuf = ixmlwrap::getFirstElementValue(response, "NumberReturned"); + if (!tbuf.empty()) + didread = atoi(tbuf.c_str()); + + if (count == -1 || count == 0) { + // TODO: what's this? + error.Set(upnp_domain, "got -1 or 0 entries"); + return false; + } + + tbuf = ixmlwrap::getFirstElementValue(response, "TotalMatches"); + if (!tbuf.empty()) + *totalp = atoi(tbuf.c_str()); + + tbuf = ixmlwrap::getFirstElementValue(response, "Result"); + + if (!dirbuf.parse(tbuf, error)) + return false; + + *didreadp = didread; + return true; +} + +bool +ContentDirectoryService::readDir(const char *objectId, + UPnPDirContent &dirbuf, + Error &error) +{ + int offset = 0; + int total = 1000;// Updated on first read. + + while (offset < total) { + int count; + if (!readDirSlice(objectId, offset, m_rdreqcnt, dirbuf, + &count, &total, error)) + return false; + + offset += count; + } + + return true; +} + +bool +ContentDirectoryService::search(const char *objectId, + const char *ss, + UPnPDirContent &dirbuf, + Error &error) +{ + LibUPnP *lib = LibUPnP::getLibUPnP(error); + if (lib == nullptr) + return false; + + UpnpClient_Handle hdl = lib->getclh(); + + IXML_Document *request(0); + IXML_Document *response(0); + + int offset = 0; + int total = 1000;// Updated on first read. + + while (offset < total) { + DirBResFree cleaner(&request, &response); + char ofbuf[100]; + sprintf(ofbuf, "%d", offset); + // Create request + int argcnt = 6; + request = UpnpMakeAction("Search", m_serviceType.c_str(), argcnt, + "ContainerID", objectId, + "SearchCriteria", ss, + "Filter", "*", + "SortCriteria", "", + "StartingIndex", ofbuf, + "RequestedCount", "0", // Setting a value here gets twonky into fits + nullptr, nullptr); + if (request == 0) { + error.Set(upnp_domain, "UpnpMakeAction() failed"); + return false; + } + + auto code = UpnpSendAction(hdl, m_actionURL.c_str(), + m_serviceType.c_str(), + 0 /*devUDN*/, request, &response); + if (code != UPNP_E_SUCCESS) { + error.Format(upnp_domain, code, + "UpnpSendAction() failed: %s", + UpnpGetErrorMessage(code)); + return false; + } + + int count = -1; + std::string tbuf = + ixmlwrap::getFirstElementValue(response, "NumberReturned"); + if (!tbuf.empty()) + count = atoi(tbuf.c_str()); + + if (count == -1 || count == 0) { + // TODO: what's this? + error.Set(upnp_domain, "got -1 or 0 entries"); + return false; + } + + offset += count; + + tbuf = ixmlwrap::getFirstElementValue(response, "TotalMatches"); + if (!tbuf.empty()) + total = atoi(tbuf.c_str()); + + tbuf = ixmlwrap::getFirstElementValue(response, "Result"); + + if (!dirbuf.parse(tbuf, error)) + return false; + } + + return true; +} + +bool +ContentDirectoryService::getSearchCapabilities(std::set &result, + Error &error) +{ + LibUPnP *lib = LibUPnP::getLibUPnP(error); + if (lib == nullptr) + return false; + + UpnpClient_Handle hdl = lib->getclh(); + + IXML_Document *request(0); + IXML_Document *response(0); + + request = UpnpMakeAction("GetSearchCapabilities", m_serviceType.c_str(), + 0, + nullptr, nullptr); + if (request == 0) { + error.Set(upnp_domain, "UpnpMakeAction() failed"); + return false; + } + + auto code = UpnpSendAction(hdl, m_actionURL.c_str(), + m_serviceType.c_str(), + 0 /*devUDN*/, request, &response); + if (code != UPNP_E_SUCCESS) { + error.Format(upnp_domain, code, + "UpnpSendAction() failed: %s", + UpnpGetErrorMessage(code)); + return false; + } + + std::string tbuf = ixmlwrap::getFirstElementValue(response, "SearchCaps"); + + result.clear(); + if (!tbuf.compare("*")) { + result.insert(result.end(), "*"); + } else if (!tbuf.empty()) { + if (!csvToStrings(tbuf, result)) { + error.Set(upnp_domain, "Bad response"); + return false; + } + } + + return true; +} + +bool +ContentDirectoryService::getMetadata(const char *objectId, + UPnPDirContent &dirbuf, + Error &error) +{ + LibUPnP *lib = LibUPnP::getLibUPnP(error); + if (lib == nullptr) + return false; + + UpnpClient_Handle hdl = lib->getclh(); + + IXML_Document *response(0); + + // Create request + int argcnt = 6; + IXML_Document *request = + UpnpMakeAction("Browse", m_serviceType.c_str(), argcnt, + "ObjectID", objectId, + "BrowseFlag", "BrowseMetadata", + "Filter", "*", + "SortCriteria", "", + "StartingIndex", "0", + "RequestedCount", "1", + nullptr, nullptr); + DirBResFree cleaner(&request, &response); + if (request == nullptr) { + error.Set(upnp_domain, "UpnpMakeAction() failed"); + return false; + } + + auto code = UpnpSendAction(hdl, m_actionURL.c_str(), + m_serviceType.c_str(), + 0 /*devUDN*/, request, &response); + if (code != UPNP_E_SUCCESS) { + error.Format(upnp_domain, code, + "UpnpSendAction() failed: %s", + UpnpGetErrorMessage(code)); + return false; + } + + std::string tbuf = ixmlwrap::getFirstElementValue(response, "Result"); + return dirbuf.parse(tbuf, error); +} -- cgit v1.2.3