soapclient.cpp

Go to the documentation of this file.

// Program Name: soapclient.cpp
// Created     : Mar. 19, 2007
//
// Purpose     : SOAP client base class
//                                                                            
// Copyright (c) 2007 David Blain <dblain@mythtv.org>
//                                          
// Licensed under the GPL v2 or later, see LICENSE for details
//
 
#include <QBuffer>
#if QT_VERSION >= QT_VERSION_CHECK(6,0,0)
#include <QStringConverter>
#endif
 
#include "soapclient.h"
 
#include "libmythbase/mythdownloadmanager.h"
#include "libmythbase/mythlogging.h"
 
#include "httprequest.h"
#include "upnp.h"
 
#define LOC      QString("SOAPClient: ")
 
SOAPClient::SOAPClient(QUrl    url,
                       QString sNamespace,
                       QString sControlPath) :
    m_url(std::move(url)), m_sNamespace(std::move(sNamespace)),
    m_sControlPath(std::move(sControlPath))
{
}
 
 
bool SOAPClient::Init(const QUrl    &url,
                      const QString &sNamespace,
                      const QString &sControlPath)
{
    bool ok = true;
    if (sNamespace.isEmpty())
    {
        ok = false;
        LOG(VB_GENERAL, LOG_ERR, LOC + "Init() given blank namespace");
    }
 
    QUrl test(url);
    test.setPath(sControlPath);
    if (!test.isValid())
    {
        ok = false;
        LOG(VB_GENERAL, LOG_ERR, LOC +
            QString("Init() given invalid control URL %1")
                .arg(test.toString()));
    }
 
    if (ok)
    {
        m_url          = url;
        m_sNamespace   = sNamespace;
        m_sControlPath = sControlPath;
    }
    else
    {
        m_url = QUrl();
        m_sNamespace.clear();
        m_sControlPath.clear();
    }
 
    return ok;
}
 
QDomNode SOAPClient::FindNode(
    const QString &sName, const QDomNode &baseNode) const
{
#if QT_VERSION < QT_VERSION_CHECK(5,14,0)
    QStringList parts = sName.split('/', QString::SkipEmptyParts);
#else
    QStringList parts = sName.split('/', Qt::SkipEmptyParts);
#endif
    return FindNodeInternal(parts, baseNode);
}
 
QDomNode SOAPClient::FindNodeInternal(
    QStringList &sParts, const QDomNode &curNode) const
{
    if (sParts.empty())
        return curNode;
 
    QString sName = sParts.front();
    sParts.pop_front();
 
    QDomNode child = curNode.namedItem(sName);
 
    if (child.isNull() )
        sParts.clear();
 
    return FindNodeInternal(sParts, child);
}
 
int SOAPClient::GetNodeValue(
    const QDomNode &node, const QString &sName, int nDefault) const
{
    QString sValue = GetNodeValue(node, sName, QString::number(nDefault));
    return sValue.toInt();
}
 
bool SOAPClient::GetNodeValue(
    const QDomNode &node, const QString &sName, bool bDefault) const
{
    QString sDefault = (bDefault) ? "true" : "false";
    QString sValue   = GetNodeValue(node, sName, sDefault);
    if (sValue.isEmpty())
        return bDefault;
 
    char ret = sValue[0].toLatin1();
    switch (ret)
    {
        case 't': case 'T': case 'y': case 'Y': case '1':
            return true;
        case 'f': case 'F': case 'n': case 'N': case '0':
            return false;
        default:
            return bDefault;
    }
}
 
QString SOAPClient::GetNodeValue(
    const QDomNode &node, const QString &sName, const QString &sDefault) const
{
    if (node.isNull())
        return sDefault;
 
    QString  sValue  = "";
    QDomNode valNode = FindNode(sName, node);
 
    if (!valNode.isNull())
    {
        // -=>TODO: Assumes first child is Text Node.
 
        QDomText oText = valNode.firstChild().toText();
 
        if (!oText.isNull())
            sValue = oText.nodeValue();
 
        return QUrl::fromPercentEncoding(sValue.toUtf8());
    }
 
    return sDefault;
}
 
QDomDocument SOAPClient::SendSOAPRequest(const QString &sMethod,
                                         QStringMap    &list,
                                         int           &nErrCode,
                                         QString       &sErrDesc)
{
    QUrl url(m_url);
 
    url.setPath(m_sControlPath);
 
    nErrCode = UPnPResult_Success;
    sErrDesc = "";
 
    QDomDocument xmlResult;
    if (m_sNamespace.isEmpty())
    {
        nErrCode = UPnPResult_MythTV_NoNamespaceGiven;
        sErrDesc = "No namespace given";
        return xmlResult;
    }
 
    // --------------------------------------------------------------
    // Add appropriate headers
    // --------------------------------------------------------------
    QHash<QByteArray, QByteArray> headers;
 
    headers.insert("Content-Type", "text/xml; charset=\"utf-8\"");
    QString soapHeader = QString("\"%1#%2\"").arg(m_sNamespace, sMethod);
    headers.insert("SOAPACTION", soapHeader.toUtf8());
    headers.insert("User-Agent", "Mozilla/9.876 (X11; U; Linux 2.2.12-20 i686, en) "
                                 "Gecko/25250101 Netscape/5.432b1");
    // --------------------------------------------------------------
    // Build request payload
    // --------------------------------------------------------------
 
    QByteArray  aBuffer;
    QTextStream os( &aBuffer );
 
#if QT_VERSION < QT_VERSION_CHECK(6,0,0)
    os.setCodec("UTF-8");
#else
    os.setEncoding(QStringConverter::Utf8);
#endif
 
    os << "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n"; 
    os << "<s:Envelope "
        " s:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\""
        " xmlns:s=\"http://schemas.xmlsoap.org/soap/envelope/\">\r\n";
    os << " <s:Body>\r\n";
    os << "  <u:" << sMethod << " xmlns:u=\"" << m_sNamespace << "\">\r\n";
 
    // --------------------------------------------------------------
    // Add parameters from list
    // --------------------------------------------------------------
 
    for (QStringMap::iterator it = list.begin(); it != list.end(); ++it)
    {                                                               
        os << "   <" << it.key() << ">";
        os << HTTPRequest::Encode( *it );
        os << "</"   << it.key() << ">\r\n";
    }
 
    os << "  </u:" << sMethod << ">\r\n";
    os << " </s:Body>\r\n";
    os << "</s:Envelope>\r\n";
 
    os.flush();
 
    // --------------------------------------------------------------
    // Perform Request
    // --------------------------------------------------------------
 
    LOG(VB_UPNP, LOG_DEBUG,
        QString("SOAPClient(%1) sending:\n %2").arg(url.toString(), aBuffer.constData()));
 
    QString sXml;
 
    if (!GetMythDownloadManager()->postAuth(url.toString(), &aBuffer, nullptr, nullptr, &headers))
    {
        LOG(VB_GENERAL, LOG_ERR, QString("SOAPClient::SendSOAPRequest: request failed: %1")
                                         .arg(url.toString()));
    }
    else
        sXml = QString(aBuffer);
 
    // --------------------------------------------------------------
    // Parse response
    // --------------------------------------------------------------
 
    LOG(VB_UPNP, LOG_DEBUG, "SOAPClient response:\n" +
                            QString("%1\n").arg(sXml));
 
    // TODO handle timeout without response correctly.
 
    list.clear();
 
    QDomDocument doc;
    int ErrLineNum = 0;
 
    if (!doc.setContent(sXml, true, &sErrDesc, &ErrLineNum))
    {
        nErrCode = UPnPResult_MythTV_XmlParseError;
        LOG(VB_UPNP, LOG_ERR,
            QString("SendSOAPRequest(%1) - Invalid response from %2. Error %3: %4. Response: %5")
                .arg(sMethod, url.toString(),
                     QString::number(nErrCode), sErrDesc, sXml));
        return xmlResult;
    }
 
    // --------------------------------------------------------------
    // Is this a valid response?
    // --------------------------------------------------------------
 
    QString      sResponseName = sMethod + "Response";
    QDomNodeList oNodeList     =
        doc.elementsByTagNameNS(m_sNamespace, sResponseName);
 
    if (oNodeList.count() == 0)
    {
        // --------------------------------------------------------------
        // Must be a fault... parse it to return reason
        // --------------------------------------------------------------
 
        nErrCode = GetNodeValue(
            doc, "Envelope/Body/Fault/detail/UPnPResult/errorCode", 500);
        sErrDesc = GetNodeValue(
            doc, "Envelope/Body/Fault/detail/UPnPResult/errorDescription", "");
        if (sErrDesc.isEmpty())
            sErrDesc = QString("Unknown #%1").arg(nErrCode);
 
        QDomNode oNode  = FindNode( "Envelope/Body/Fault", doc );
 
        oNode = xmlResult.importNode( oNode, true );
        xmlResult.appendChild( oNode );
 
        return xmlResult;
    }
 
    QDomNode oMethod = oNodeList.item(0);
    if (oMethod.isNull())
        return xmlResult;
 
    QDomNode oNode = oMethod.firstChild(); 
    for (; !oNode.isNull(); oNode = oNode.nextSibling())
    {
        QDomElement e = oNode.toElement();
        if (e.isNull())
            continue;
 
        QString sName  = e.tagName();
        QString sValue = "";
    
        QDomText  oText = oNode.firstChild().toText();
    
        if (!oText.isNull())
            sValue = oText.nodeValue();
 
        list.insert(QUrl::fromPercentEncoding(sName.toUtf8()),
                    QUrl::fromPercentEncoding(sValue.toUtf8()));
    }
 
    // Create copy of oMethod that can be used with xmlResult.
 
    oMethod = xmlResult.importNode( oMethod.firstChild(), true  );
 
    // importNode does not attach the new nodes to the document,
    // do it here.
 
    xmlResult.appendChild( oMethod );
 
    return xmlResult;
}