Go to the documentation of this file.
23 #define DIDL_LITE_BEGIN "<DIDL-Lite xmlns:dc=\"http://purl.org/dc/elements/1.1/\" xmlns:upnp=\"urn:schemas-upnp-org:metadata-1-0/upnp/\" xmlns=\"urn:schemas-upnp-org:metadata-1-0/DIDL-Lite/\">"
24 #define DIDL_LITE_END "</DIDL-Lite>";
45 for (
auto *
const object : qAsConst(objects))
61 for (
auto *item : qAsConst(
m_List))
62 sXML += item->toXml(filter, ignoreChildren);
72 :
Eventing(
"UPnpCDS",
"CDS_Event", sSharePath )
87 SetValue< uint16_t >(
"SystemUpdateID", 0 );
92 SetValue< QString >(
"ServiceResetToken",
110 "urn:schemas-upnp-org:av:avs" ));
112 "http://www.w3.org/2001/XMLSchema-instance" ));
114 "urn:schemas-upnp-org:av:avs "
115 "http://www.upnp.org/schemas/av/avs.xsd" ));
142 if (sURI ==
"X_GetFeatureList" ||
172 CDSShortCutList::iterator it;
173 for (it = shortcuts.begin(); it != shortcuts.end(); ++it)
198 const QString& objectID)
235 LOG(VB_UPNP, LOG_DEBUG,
236 QString(
"UPnpCDS::ProcessRequest - BaseUrl (%1) not ours...")
283 "Windows-Media-Player/" },
287 "Mozilla/4.0 (compatible; UPnP/1.0; Windows 9x" },
299 R
"(cn="Sony Corporation"; mn="Blu-ray Disc Player")" },
312 int idx = sHeaderValue.indexOf(except.sHeaderValue);
316 pCDSRequest->
m_eClient = except.nClientType;
318 idx += except.sHeaderValue.length();
322 if ( sHeaderValue[idx] ==
'/')
328 QString
version = sHeaderValue.mid(idx).trimmed();
332 idx =
version.indexOf(
'.', idx + 1 );
346 LOG(VB_UPNP, LOG_INFO,
347 QString(
"DetermineClient %1:%2 Identified as %3 version %4")
348 .
arg(except.sHeaderKey) .arg(sHeaderValue)
374 pRequest->
m_mapParams[
"requestedcount"].toUShort();
380 LOG(VB_UPNP, LOG_DEBUG, QString(
"UPnpCDS::ProcessRequest \n"
384 ": BrowseFlag = %4 \n"
386 ": StartingIndex = %6 \n"
387 ": RequestedCount = %7 \n"
388 ": SortCriteria = %8 " )
399 QString sErrorDesc =
"";
406 LOG(VB_UPNP, LOG_INFO,
407 QString(
"UPnpCDS::HandleBrowse ObjectID=%1")
453 for (
uint i = nStart;
455 (nNumberReturned < nCount);
460 sResultXML += pExtensionRoot->
toXml(filter,
true);
475 UPnpCDSExtensionList::iterator it =
m_extensions.begin();
478 LOG(VB_UPNP, LOG_INFO,
479 QString(
"UPNP Browse : Searching for : %1 / ObjectID : %2")
482 pResult = (*it)->Browse(&request);
485 if (pResult !=
nullptr)
494 pResult->
m_List.takeLast()->DecrRef();
497 nNumberReturned = pResult->
m_List.count();
520 sResults += sResultXML;
523 list.push_back(
NameValue(
"Result", sResults));
524 list.push_back(
NameValue(
"NumberReturned", nNumberReturned));
525 list.push_back(
NameValue(
"TotalMatches", nTotalMatches));
526 list.push_back(
NameValue(
"UpdateID", nUpdateID));
545 QString sErrorDesc =
"";
562 LOG(VB_UPNP, LOG_INFO,
563 QString(
"UPnpCDS::HandleSearch ObjectID=%1, ContainerId=%2")
571 QRegularExpression re {
"\\b(or|and)\\b", QRegularExpression::CaseInsensitiveOption};
573 #if QT_VERSION < QT_VERSION_CHECK(5,14,0)
575 re, QString::SkipEmptyParts);
578 re, Qt::SkipEmptyParts);
587 for ( QStringList::Iterator it = request.
m_sSearchList.begin();
591 if ((*it).contains(
"upnp:class derivedfrom", Qt::CaseInsensitive))
593 #if QT_VERSION < QT_VERSION_CHECK(5,14,0)
594 QStringList sParts = (*it).split(
' ', QString::SkipEmptyParts);
596 QStringList sParts = (*it).split(
' ', Qt::SkipEmptyParts);
599 if (sParts.count() > 2)
612 LOG(VB_UPNP, LOG_INFO, QString(
"UPnpCDS::ProcessRequest \n"
616 ": SearchCriteria = %4 \n"
618 ": StartingIndex = %6 \n"
619 ": RequestedCount = %7 \n"
620 ": SortCriteria = %8 \n"
621 ": SearchClass = %9" )
633 bool bSearchDone =
false;
636 UPnpCDSExtensionList::iterator it =
m_extensions.begin();
638 pResult = (*it)->Search(&request);
640 if (pResult !=
nullptr)
648 nNumberReturned = pResult->
m_List.count();
663 LOG(VB_UPNP, LOG_DEBUG, sResultXML);
670 sResults += sResultXML;
673 list.push_back(
NameValue(
"Result", sResults));
674 list.push_back(
NameValue(
"NumberReturned", nNumberReturned));
675 list.push_back(
NameValue(
"TotalMatches", nTotalMatches));
676 list.push_back(
NameValue(
"UpdateID", nUpdateID));
694 LOG(VB_UPNP, LOG_INFO,
695 QString(
"UPnpCDS::ProcessRequest : %1 : %2")
720 LOG(VB_UPNP, LOG_INFO,
721 QString(
"UPnpCDS::ProcessRequest : %1 : %2")
744 LOG(VB_UPNP, LOG_INFO,
745 QString(
"UPnpCDS::ProcessRequest : %1 : %2")
748 auto nId = GetValue<uint16_t>(
"SystemUpdateID");
762 LOG(VB_UPNP, LOG_INFO,
763 QString(
"UPnpCDS::ProcessRequest : %1 : %2")
768 list.push_back(
NameValue(
"FeatureList", sResults));
777 LOG(VB_UPNP, LOG_INFO,
778 QString(
"UPnpCDS::ProcessRequest : %1 : %2")
781 auto sToken = GetValue<QString>(
"ServiceResetToken");
783 list.push_back(
NameValue(
"ResetToken", sToken));
839 LOG(VB_UPNP, LOG_DEBUG, QString(
"Browse (%1): Current Token '%2'")
848 if (pResults !=
nullptr)
863 LOG(VB_UPNP, LOG_DEBUG, QString(
"UPnpCDS::Browse: BrowseMetadata (%1)").
arg(pRequest->
m_sObjectId));
864 if (
LoadMetadata(pRequest, pResults, tokens, currentToken))
873 LOG(VB_UPNP, LOG_DEBUG, QString(
"UPnpCDS::Browse: BrowseDirectChildren (%1)").
arg(pRequest->
m_sObjectId));
874 if (
LoadChildren(pRequest, pResults, tokens, currentToken))
883 pResults->m_sErrorDesc =
"";
910 QStringList sEmptyList;
911 LOG(VB_UPNP, LOG_INFO,
912 QString(
"UPnpCDSExtension::Search : m_sClass = %1 : "
913 "m_sSearchClass = %2")
918 LOG(VB_UPNP, LOG_INFO,
919 QString(
"UPnpCDSExtension::Search - Not For Us : "
920 "m_sClass = %1 : m_sSearchClass = %2")
937 const QString &sStr,
int num )
939 QString sResult(
"" );
942 for (
int nIdx=0; nIdx < num; nIdx++)
944 if ((nPos = sStr.lastIndexOf( sToken, nPos )) == -1)
949 sResult = sStr.left( nPos );
1015 QStringList tokens = Id.split(
'/');
1017 QStringList::iterator it;
1018 for (it = tokens.begin() + 1; it < tokens.end(); ++it)
1021 QString key = (*it).section(
'=', 0, 0).toLower();
1022 QString value = (*it).section(
'=', 1, 1);
1024 tokenMap.insert(key, value);
1025 LOG(VB_UPNP, LOG_DEBUG, QString(
"Token Key: %1 Value: %2").
arg(key)
1049 QStringList tokens = Id.split(
'/');
1050 QString
current = tokens.last();
1051 QString key =
current.section(
'=', 0, 0).toLower();
1052 QString value =
current.section(
'=', 1, 1);
1058 const QString &name,
1065 const QString &name,
1066 const QString &value)
1069 QString currentName = currentToken.first;
1070 QString currentValue = currentToken.second;
1074 if (currentName == name.toLower() && !currentValue.isEmpty() &&
1075 currentValue == value.toLower())
1077 if (currentName == name.toLower() && currentValue.isEmpty())
1078 return QString(
"%1=%2").arg(requestId).arg(value);
1079 return QString(
"%1/%2=%3").arg(requestId).arg(name).arg(value);
1084 LOG(VB_GENERAL, LOG_CRIT,
"UPnpCDSExtension::CreateRoot() called on base class");
1106 xml =
"<shortcutlist>\r\n";
1108 QMap<ShortCutType, QString>::iterator it;
1112 QString objectID = *it;
1113 xml +=
"<shortcut>\r\n";
1116 xml +=
"</shortcut>\r\n";
1119 xml +=
"</shortcutlist>\r\n";
1125 const QString &objectID)
1131 LOG(VB_GENERAL, LOG_ERR, QString(
"UPnPCDSShortcuts::AddShortCut(): "
1132 "Attempted to register duplicate "
1149 str =
"MUSIC_ALBUMS";
1152 str =
"MUSIC_ARTISTS";
1155 str =
"MUSIC_GENRES";
1158 str =
"MUSIC_PLAYLISTS";
1161 str =
"MUSIC_RECENTLY_ADDED";
1164 str =
"MUSIC_LAST_PLAYED";
1167 str =
"MUSIC_AUDIOBOOKS";
1170 str =
"MUSIC_STATIONS";
1176 str =
"MUSIC_FOLDER_STRUCTURE";
1183 str =
"IMAGES_YEARS";
1186 str =
"IMAGES_YEARS_MONTH";
1189 str =
"IMAGES_ALBUM";
1192 str =
"IMAGES_SLIDESHOWS";
1195 str =
"IMAGES_RECENTLY_ADDED";
1198 str =
"IMAGES_LAST_WATCHED";
1204 str =
"IMAGES_FOLDER_STRUCTURE";
1211 str =
"VIDEOS_GENRES";
1214 str =
"VIDEOS_YEARS";
1217 str =
"VIDEOS_YEARS_MONTH";
1220 str =
"VIDEOS_ALBUM";
1223 str =
"VIDEOS_RECENTLY_ADDED";
1226 str =
"VIDEOS_LAST_PLAYED";
1229 str =
"VIDEOS_RECORDINGS";
1236 str =
"VIDEOS_FOLDER_STRUCTURE";
QString GetResultXML(FilterMap &filter, bool ignoreChildren=false)
QString GetRequestHeader(const QString &sKey, const QString &sDefault)
uint16_t m_nRequestedCount
UPnPFeatureList m_features
QStringList GetBasePaths() override
virtual void CreateRoot()
QMap< UPnPShortcutFeature::ShortCutType, QString > CDSShortCutList
virtual int DecrRef(void)
Decrements reference count and deletes on 0.
virtual ~UPnpCDSExtension()
QStringList GetBasePaths() override
static void HandleGetSortCapabilities(HTTPRequest *pRequest)
Return the list of supported sorting fields.
Standard UPnP Shortcut feature.
void HandleSearch(HTTPRequest *pRequest)
void HandleGetSystemUpdateID(HTTPRequest *pRequest)
static QString CreateIDString(const QString &RequestId, const QString &Name, int Value)
arg(title).arg(filename).arg(doDelete))
uint16_t m_nStartingIndex
UPnpCDSExtensionList m_extensions
virtual bool IsSearchRequestForUs(UPnpCDSRequest *pRequest)
void AddFeature(UPnPFeature *feature)
#define LOG(_MASK_, _LEVEL_, _QSTRING_)
bool ProcessRequest(HTTPRequest *pRequest) override
static IDTokenMap TokenizeIDString(const QString &Id)
Split the 'Id' String up into tokens for handling by each extension.
void SetChildContainerCount(uint32_t nCount)
Allows the caller to set childContainerCount without having to load children.
UPnpCDSBrowseFlag m_eBrowseFlag
static QString Encode(const QString &sIn)
QDateTime current(bool stripped)
Returns current Date and Time in UTC.
static void FormatErrorResponse(HTTPRequest *pRequest, UPnPResultCode eCode, const QString &sMsg="")
virtual UPnpCDSExtensionResults * Browse(UPnpCDSRequest *pRequest)
@ CDS_BrowseDirectChildren
QString toString(MarkTypes type)
void FormatActionResponse(Serializer *ser)
void RegisterService(UPnpDevice *device)
Creates a UPnpService and adds it to the UPnpDevice's list of services.
UPnpCDS(UPnpDevice *pDevice, const QString &sSharePath)
QMap< uint, int > FilterMap
static void DetermineClient(HTTPRequest *pRequest, UPnpCDSRequest *pCDSRequest)
QString m_sSearchCriteria
static const std::array< featureStruct, 7 > feature
static const std::array< const UPnpCDSClientException, 5 > clientExceptions
void HandleGetServiceResetToken(HTTPRequest *pRequest)
void UnregisterExtension(UPnpCDSExtension *pExtension)
QString m_sServiceDescFileName
virtual UPnpCDSExtensionResults * Search(UPnpCDSRequest *pRequest)
void Add(CDSObject *pObject)
QMap< ShortCutType, QString > m_shortcuts
@ CDSM_GetSearchCapabilities
void AddAttribute(const NameValue &attribute)
void RegisterFeature(UPnPFeature *feature)
UPnPResultCode m_eErrorCode
QList< CDSObject * > CDSObjects
bool AddShortCut(ShortCutType type, const QString &objectID)
@ IMAGES_FOLDER_STRUCTURE
void SetChildCount(uint32_t nCount)
Allows the caller to set childCount without having to load children.
void HandleBrowse(HTTPRequest *pRequest)
@ CDSM_GetServiceDescription
bool ProcessRequest(HTTPRequest *pRequest) override
static UPnpCDSBrowseFlag GetBrowseFlag(const QString &sFlag)
virtual bool LoadMetadata(const UPnpCDSRequest *pRequest, UPnpCDSExtensionResults *pResults, const IDTokenMap &tokens, const QString ¤tToken)
Fetch just the metadata for the item identified in the request.
ShortCutType
Allowed values for the Container Shortcut feature.
@ UPnPResult_InvalidAction
virtual bool LoadChildren(const UPnpCDSRequest *pRequest, UPnpCDSExtensionResults *pResults, const IDTokenMap &tokens, const QString ¤tToken)
Fetch the children of the container identified in the request.
static UPnpCDSMethod GetMethod(const QString &sURI)
QStringList m_sSearchList
const T & Max(const T &x, const T &y)
virtual CDSObject * GetRoot()
const T & Min(const T &x, const T &y)
void FormatFileResponse(const QString &sFileName)
QMap< QString, QString > IDTokenMap
static QString RemoveToken(const QString &sToken, const QString &sStr, int num)
@ UPnPResult_CDS_NoSuchObject
static CDSObject * CreateContainer(const QString &sId, const QString &sTitle, const QString &sParentId, CDSObject *pObject=nullptr)
@ CDSM_GetSortCapabilities
virtual int GetValue(const QString &sSetting, int Default)=0
static void HandleGetSearchCapabilities(HTTPRequest *pRequest)
Return the list of supported search fields.
void AddVariable(StateVariableBase *pBase)
static Configuration * GetConfiguration()
QString toXml(FilterMap &filter, bool ignoreChildren=false) const
QPair< QString, QString > IDToken
@ VIDEOS_FOLDER_STRUCTURE
QString CreateXML() override
void RegisterExtension(UPnpCDSExtension *pExtension)
virtual int IncrRef(void)
Increments reference count.
static QString TypeToName(ShortCutType type)
static IDToken GetCurrentToken(const QString &Id)
Split the 'Id' String up into tokens and return the last (current) token.
virtual CDSShortCutList GetShortCuts()
@ CDSM_GetServiceResetToken
UPnPShortcutFeature * m_pShortCuts
void HandleGetFeatureList(HTTPRequest *pRequest)
void RegisterShortCut(UPnPShortcutFeature::ShortCutType type, const QString &objectID)
virtual bool IsBrowseRequestForUs(UPnpCDSRequest *pRequest)