upnpscanner.cpp

Go to the documentation of this file.

// C++
#include <algorithm>
#include <chrono> // for milliseconds
#include <thread> // for sleep_for
#include <utility>
 
// Qt
#include <QCoreApplication>
#if QT_VERSION >= QT_VERSION_CHECK(6,0,0)
#include <QStringConverter>
#else
#include <QTextCodec>
#endif
 
// MythTV
#include "libmythbase/mythcorecontext.h"
#include "libmythbase/mythlogging.h"
#include "libmythupnp/ssdpcache.h"
 
// MythFrontend
#include "upnpscanner.h"
 
#define LOC QString("UPnPScan: ")
#define ERR QString("UPnPScan error: ")
 
static constexpr uint8_t MAX_ATTEMPTS { 5 };
 
QString MediaServerItem::NextUnbrowsed(void) const
{
    // items don't need scanning
    if (!m_url.isEmpty())
        return {};
 
    // scan this container
    if (!m_scanned)
        return m_id;
 
    // scan children
    for (const auto& value : std::as_const(m_children))
    {
        QString result = value.NextUnbrowsed();
        if (!result.isEmpty())
            return result;
    }
 
    return {};
}
 
MediaServerItem* MediaServerItem::Find(QString &id)
{
    if (m_id == id)
        return this;
 
    for (auto& value : m_children)
    {
        MediaServerItem* result = value.Find(id);
        if (result)
            return result;
    }
 
    return nullptr;
}
 
bool MediaServerItem::Add(const MediaServerItem &item)
{
    if (m_id == item.m_parentid)
    {
        m_children.insert(item.m_id, item);
        return true;
    }
    return false;
}
 
void MediaServerItem::Reset(void)
{
    m_children.clear();
    m_scanned = false;
}
 
class UpnpMediaServer : public MediaServerItem
{
  public:
    UpnpMediaServer()
     : MediaServerItem(QString("0"), QString(), QString(), QString()),
       m_friendlyName(QString("Unknown"))
    {
    }
    explicit UpnpMediaServer(QUrl URL)
     : MediaServerItem(QString("0"), QString(), QString(), QString()),
       m_serverURL(std::move(URL)),
       m_friendlyName(QString("Unknown"))
    {
    }
 
    bool ResetContent(int new_id)
    {
        bool result = true;
        if (m_systemUpdateID != -1)
        {
            result = false;
            Reset();
        }
        m_systemUpdateID = new_id;
        return result;
    }
 
    QUrl    m_serverURL;
    QUrl    m_controlURL;
    QUrl    m_eventSubURL;
    QUrl    m_eventSubPath;
    QString m_friendlyName;
    uint8_t m_connectionAttempts {0};
    bool    m_subscribed         {false};
    int     m_renewalTimerId     {0};
    int     m_systemUpdateID     {-1};
};
 
UPNPScanner* UPNPScanner::gUPNPScanner        = nullptr;
bool         UPNPScanner::gUPNPScannerEnabled = false;
MThread*     UPNPScanner::gUPNPScannerThread  = nullptr;
QRecursiveMutex* UPNPScanner::gUPNPScannerLock = new QRecursiveMutex();
 
UPNPScanner::~UPNPScanner()
{
    Stop();
}
 
void UPNPScanner::Enable(bool enable, UPNPSubscription *sub)
{
    QMutexLocker locker(gUPNPScannerLock);
    gUPNPScannerEnabled = enable;
    Instance(sub);
}
 
UPNPScanner* UPNPScanner::Instance(UPNPSubscription *sub)
{
    QMutexLocker locker(gUPNPScannerLock);
    if (!gUPNPScannerEnabled)
    {
        if (gUPNPScannerThread)
        {
            gUPNPScannerThread->quit();
            gUPNPScannerThread->wait();
        }
        delete gUPNPScannerThread;
        gUPNPScannerThread = nullptr;
        delete gUPNPScanner;
        gUPNPScanner = nullptr;
        return nullptr;
    }
 
    if (!gUPNPScannerThread)
        gUPNPScannerThread = new MThread("UPnPScanner");
    if (!gUPNPScanner)
        gUPNPScanner = new UPNPScanner(sub);
 
    if (!gUPNPScannerThread->isRunning())
    {
        gUPNPScanner->moveToThread(gUPNPScannerThread->qthread());
        QObject::connect(
            gUPNPScannerThread->qthread(), &QThread::started,
            gUPNPScanner,                  &UPNPScanner::Start);
        gUPNPScannerThread->start(QThread::LowestPriority);
    }
 
    return gUPNPScanner;
}
void UPNPScanner::StartFullScan(void)
{
    m_fullscan = true;
    auto *me = new MythEvent(QString("UPNP_STARTSCAN"));
    qApp->postEvent(this, me);
}
 
void UPNPScanner::GetInitialMetadata(VideoMetadataListManager::metadata_list* list,
                                     meta_dir_node *node)
{
    // nothing to see..
    QMap<QString,QString> servers = ServerList();
    if (servers.isEmpty())
        return;
 
    // Add MediaServers
    LOG(VB_GENERAL, LOG_INFO, QString("Adding MediaServer metadata."));
 
    smart_dir_node mediaservers = node->addSubDir(tr("Media Servers"));
    mediaservers->setPathRoot();
 
    m_lock.lock();
    for (auto it = m_servers.cbegin(); it != m_servers.cend(); ++it)
    {
        if (!it.value()->m_subscribed)
            continue;
 
        const QString& usn = it.key();
        GetServerContent(usn, it.value(), list, mediaservers.get());
    }
    m_lock.unlock();
}
 
void UPNPScanner::GetMetadata(VideoMetadataListManager::metadata_list* list,
                              meta_dir_node *node)
{
    // nothing to see..
    QMap<QString,QString> servers = ServerList();
    if (servers.isEmpty())
        return;
 
    // Start scanning if it isn't already running
    StartFullScan();
 
    // wait for the scanner to complete - with a 30 second timeout
    LOG(VB_GENERAL, LOG_INFO, LOC + "Waiting for scan to complete.");
 
    int count = 0;
    while (!m_scanComplete && (count++ < 300))
        std::this_thread::sleep_for(100ms);
 
    // some scans may just take too long (PlayOn)
    if (!m_scanComplete)
        LOG(VB_GENERAL, LOG_ERR, LOC + "MediaServer scan is incomplete.");
    else
        LOG(VB_GENERAL, LOG_INFO, LOC + "MediaServer scanning finished.");
 
 
    smart_dir_node mediaservers = node->addSubDir(tr("Media Servers"));
    mediaservers->setPathRoot();
 
    m_lock.lock();
    for (auto it = m_servers.cbegin(); it != m_servers.cend(); ++it)
    {
        if (!it.value()->m_subscribed)
            continue;
 
        const QString& usn = it.key();
        GetServerContent(usn, it.value(), list, mediaservers.get());
    }
    m_lock.unlock();
}
 
bool UPNPScanner::GetMetadata(QVariant &data)
{
    // we need a USN and objectID
    if (!data.canConvert<QStringList>())
        return false;
 
    QStringList list = data.toStringList();
    if (list.size() != 2)
        return false;
 
    const QString& usn = list[0];
    QString object = list[1];
 
    m_lock.lock();
    bool valid = m_servers.contains(usn);
    if (valid)
    {
        MediaServerItem* item = m_servers[usn]->Find(object);
        valid = item ? !item->m_scanned : false;
    }
    m_lock.unlock();
    if (!valid)
        return false;
 
    auto *me = new MythEvent("UPNP_BROWSEOBJECT", list);
    qApp->postEvent(this, me);
 
    int count = 0;
    bool found = false;
    LOG(VB_GENERAL, LOG_INFO, "START");
    while (!found && (count++ < 100)) // 10 seconds
    {
        std::this_thread::sleep_for(100ms);
        m_lock.lock();
        if (m_servers.contains(usn))
        {
            MediaServerItem *item = m_servers[usn]->Find(object);
            if (item)
            {
                found = item->m_scanned;
            }
            else
            {
                LOG(VB_GENERAL, LOG_INFO, QString("Item went away..."));
                found = true;
            }
        }
        else
        {
            LOG(VB_GENERAL, LOG_INFO,
                QString("Server went away while browsing."));
            found = true;
        }
        m_lock.unlock();
    }
    LOG(VB_GENERAL, LOG_INFO, "END");
    return true;
}
 
void UPNPScanner::GetServerContent(const QString &usn,
                                   const MediaServerItem *content,
                                   VideoMetadataListManager::metadata_list* list,
                                   meta_dir_node *node)
{
    if (!content->m_scanned)
    {
        smart_dir_node subnode = node->addSubDir(content->m_name);
 
        QStringList data;
        data << usn;
        data << content->m_id;
        subnode->SetData(data);
 
        VideoMetadataListManager::VideoMetadataPtr item(new VideoMetadata(QString()));
        item->SetTitle(QString("Dummy"));
        list->push_back(item);
        subnode->addEntry(smart_meta_node(new meta_data_node(item.get())));
        return;
    }
 
    node->SetData(QVariant());
 
    if (content->m_url.isEmpty())
    {
        smart_dir_node container = node->addSubDir(content->m_name);
        for (const auto& child : std::as_const(content->m_children))
            GetServerContent(usn, &child, list, container.get());
        return;
    }
 
    VideoMetadataListManager::VideoMetadataPtr item(new VideoMetadata(content->m_url));
    item->SetTitle(content->m_name);
    list->push_back(item);
    node->addEntry(smart_meta_node(new meta_data_node(item.get())));
}
 
QMap<QString,QString> UPNPScanner::ServerList(void)
{
    QMap<QString,QString> servers;
    m_lock.lock();
    for (auto it = m_servers.cbegin(); it != m_servers.cend(); ++it)
        servers.insert(it.key(), it.value()->m_friendlyName);
    m_lock.unlock();
    return servers;
}
 
void UPNPScanner::Start()
{
    m_lock.lock();
 
    // create our network handler
    m_network = new QNetworkAccessManager();
    connect(m_network, &QNetworkAccessManager::finished,
            this, &UPNPScanner::replyFinished);
 
    // listen for SSDP updates
    SSDPCache::Instance()->addListener(this);
 
    // listen for subscriptions and events
    if (m_subscription)
        m_subscription->addListener(this);
 
    // create our update timer (driven by AddServer and ParseDescription)
    m_updateTimer = new QTimer(this);
    m_updateTimer->setSingleShot(true);
    connect(m_updateTimer, &QTimer::timeout, this, &UPNPScanner::Update);
 
    // create our watchdog timer (checks for stale servers)
    m_watchdogTimer = new QTimer(this);
    connect(m_watchdogTimer, &QTimer::timeout, this, &UPNPScanner::CheckStatus);
    m_watchdogTimer->start(10s);
 
    // avoid connecting to the master backend
    m_masterHost = gCoreContext->GetMasterServerIP();
    m_masterPort = gCoreContext->GetMasterServerStatusPort();
 
    m_lock.unlock();
    LOG(VB_GENERAL, LOG_INFO, LOC + "Started");
}
 
void UPNPScanner::Stop(void)
{
    m_lock.lock();
 
    // stop listening
    SSDPCache::Instance()->removeListener(this);
    if (m_subscription)
        m_subscription->removeListener(this);
 
    // disable updates
    if (m_updateTimer)
        m_updateTimer->stop();
    if (m_watchdogTimer)
        m_watchdogTimer->stop();
 
    // cleanup our servers and subscriptions
    for (auto it = m_servers.cbegin(); it != m_servers.cend(); ++it)
    {
        if (m_subscription && it.value()->m_subscribed)
            m_subscription->Unsubscribe(it.key());
        if (it.value()->m_renewalTimerId)
            killTimer(it.value()->m_renewalTimerId);
        delete it.value();
    }
    m_servers.clear();
 
    // cleanup the network
    for (QNetworkReply *reply : std::as_const(m_descriptionRequests))
    {
        reply->abort();
        delete reply;
    }
    m_descriptionRequests.clear();
    for (QNetworkReply *reply : std::as_const(m_browseRequests))
    {
        reply->abort();
        delete reply;
    }
    m_browseRequests.clear();
    delete m_network;
    m_network = nullptr;
 
    // delete the timers
    delete m_updateTimer;
    delete m_watchdogTimer;
    m_updateTimer   = nullptr;
    m_watchdogTimer = nullptr;
 
    m_lock.unlock();
    LOG(VB_GENERAL, LOG_INFO, LOC + "Finished");
}
 
void UPNPScanner::Update(void)
{
    // decide which servers still need to be checked
    m_lock.lock();
    if (m_servers.isEmpty())
    {
        m_lock.unlock();
        return;
    }
 
    // if our network queue is full, then we may need to come back later
    bool reschedule = false;
 
    for (auto *server : std::as_const(m_servers))
    {
        if ((server->m_connectionAttempts < MAX_ATTEMPTS) &&
            (server->m_controlURL.isEmpty()))
        {
            bool sent = false;
            QUrl url { server->m_serverURL };
            if (!m_descriptionRequests.contains(url) &&
                (m_descriptionRequests.empty()) &&
                url.isValid())
            {
                QNetworkReply *reply = m_network->get(QNetworkRequest(url));
                if (reply)
                {
                    sent = true;
                    m_descriptionRequests.insert(url, reply);
                    server->m_connectionAttempts++;
                }
            }
            if (!sent)
                reschedule = true;
        }
    }
 
    if (reschedule)
        ScheduleUpdate();
    m_lock.unlock();
}
 
void UPNPScanner::CheckStatus(void)
{
    // FIXME
    // Remove stale servers - the SSDP cache code does not send out removal
    // notifications for expired (rather than explicitly closed) connections
    m_lock.lock();
    for (auto it = m_servers.begin(); it != m_servers.end(); /* no inc */)
    {
        // FIXME UPNP version comparision done wrong, we are using urn:schemas-upnp-org:device:MediaServer:4 ourselves
        if (!SSDPCache::Instance()->Find("urn:schemas-upnp-org:device:MediaServer:1", it.key()))
        {
            LOG(VB_UPNP, LOG_INFO, LOC + QString("%1 no longer in SSDP cache. Removing")
                .arg(it.value()->m_serverURL.toString()));
            UpnpMediaServer* last = it.value();
            it = m_servers.erase(it);
            delete last;
        }
        else
        {
            ++it;
        }
    }
    m_lock.unlock();
}
 
void UPNPScanner::replyFinished(QNetworkReply *reply)
{
    if (!reply)
        return;
 
    QUrl url   = reply->url();
    bool valid = reply->error() == QNetworkReply::NoError;
 
    if (!valid)
    {
        LOG(VB_UPNP, LOG_ERR, LOC +
            QString("Network request for '%1' returned error '%2'")
                .arg(url.toString(), reply->errorString()));
    }
 
    bool description = false;
    bool browse      = false;
 
    m_lock.lock();
    if (m_descriptionRequests.contains(url, reply))
    {
        m_descriptionRequests.remove(url, reply);
        description = true;
    }
    else if (m_browseRequests.contains(url, reply))
    {
        m_browseRequests.remove(url, reply);
        browse = true;
    }
    m_lock.unlock();
 
    if (browse && valid)
    {
        ParseBrowse(url, reply);
        if (m_fullscan)
            BrowseNextContainer();
    }
    else if (description)
    {
        if (!valid || !ParseDescription(url, reply))
        {
            // if there will be no more attempts, update the logs
            CheckFailure(url);
            // try again
            ScheduleUpdate();
        }
    }
    else
    {
        LOG(VB_UPNP, LOG_ERR, LOC + "Received unknown reply");
    }
 
    reply->deleteLater();
}
 
void UPNPScanner::customEvent(QEvent *event)
{
    if (event->type() != MythEvent::kMythEventMessage)
        return;
 
    // UPnP events
    auto *me = dynamic_cast<MythEvent *>(event);
    if (me == nullptr)
        return;
 
    const QString&    ev  = me->Message();
 
    if (ev == "UPNP_STARTSCAN")
    {
        BrowseNextContainer();
        return;
    }
    if (ev == "UPNP_BROWSEOBJECT")
    {
        if (me->ExtraDataCount() == 2)
        {
            QUrl url;
            const QString& usn = me->ExtraData(0);
            const QString& objectid = me->ExtraData(1);
            m_lock.lock();
            if (m_servers.contains(usn))
            {
                url = m_servers[usn]->m_controlURL;
                LOG(VB_GENERAL, LOG_INFO, QString("UPNP_BROWSEOBJECT: %1->%2")
                    .arg(m_servers[usn]->m_friendlyName, objectid));
            }
            m_lock.unlock();
            if (!url.isEmpty())
                SendBrowseRequest(url, objectid);
        }
        return;
    }
    if (ev == "UPNP_EVENT")
    {
        auto *info = (MythInfoMapEvent*)event;
        if (!info)
            return;
        if (!info->GetInfoMap())
            return;
 
        QString usn = info->GetInfoMap()->value("usn");
        QString id  = info->GetInfoMap()->value("SystemUpdateID");
        if (usn.isEmpty() || id.isEmpty())
            return;
 
        m_lock.lock();
        if (m_servers.contains(usn))
        {
            int newid = id.toInt();
            if (m_servers[usn]->m_systemUpdateID != newid)
            {
                m_scanComplete &= m_servers[usn]->ResetContent(newid);
                LOG(VB_GENERAL, LOG_INFO, LOC +
                    QString("New SystemUpdateID '%1' for %2").arg(id, usn));
                Debug();
            }
        }
        m_lock.unlock();
        return;
    }
 
    // process SSDP cache updates
    QString    uri = me->ExtraDataCount() > 0 ? me->ExtraData(0) : QString();
    QString    usn = me->ExtraDataCount() > 1 ? me->ExtraData(1) : QString();
 
    // FIXME UPNP version comparision done wrong, we are using urn:schemas-upnp-org:device:MediaServer:4 ourselves
    if (uri == "urn:schemas-upnp-org:device:MediaServer:1")
    {
        QString url = (ev == "SSDP_ADD") ? me->ExtraData(2) : QString();
        AddServer(usn, url);
    }
}
 
void UPNPScanner::timerEvent(QTimerEvent * event)
{
    int id = event->timerId();
    if (id)
        killTimer(id);
 
    std::chrono::seconds timeout = 0s;
    QString usn;
 
    m_lock.lock();
    for (auto it = m_servers.cbegin(); it != m_servers.cend(); ++it)
    {
        if (it.value()->m_renewalTimerId == id)
        {
            it.value()->m_renewalTimerId = 0;
            usn = it.key();
            if (m_subscription)
                timeout = m_subscription->Renew(usn);
        }
    }
    m_lock.unlock();
 
    if (timeout > 0s)
    {
        ScheduleRenewal(usn, timeout);
        LOG(VB_GENERAL, LOG_INFO, LOC +
            QString("Re-subscribed for %1 seconds to %2")
                .arg(timeout.count()).arg(usn));
    }
}
 
void UPNPScanner::ScheduleUpdate(void)
{
    m_lock.lock();
    if (m_updateTimer && !m_updateTimer->isActive())
        m_updateTimer->start(200ms);
    m_lock.unlock();
}
 
void UPNPScanner::CheckFailure(const QUrl &url)
{
    m_lock.lock();
    for (auto *server : std::as_const(m_servers))
    {
        if (server->m_serverURL == url && server->m_connectionAttempts == MAX_ATTEMPTS)
        {
            Debug();
            break;
        }
    }
    m_lock.unlock();
}
 
void UPNPScanner::Debug(void)
{
    m_lock.lock();
    LOG(VB_UPNP, LOG_INFO, LOC + QString("%1 media servers discovered:")
                                   .arg(m_servers.size()));
    for (auto *server: std::as_const(m_servers))
    {
        QString status = "Probing";
        if (server->m_controlURL.toString().isEmpty())
        {
            if (server->m_connectionAttempts >= MAX_ATTEMPTS)
                status = "Failed";
        }
        else
        {
            status = "Yes";
        }
        LOG(VB_UPNP, LOG_INFO, LOC +
            QString("'%1' Connected: %2 Subscribed: %3 SystemUpdateID: "
                    "%4 timerId: %5")
                .arg(server->m_friendlyName, status,
                     server->m_subscribed ? "Yes" : "No",
                     QString::number(server->m_systemUpdateID),
                     QString::number(server->m_renewalTimerId)));
    }
    m_lock.unlock();
}
 
void UPNPScanner::BrowseNextContainer(void)
{
    QMutexLocker locker(&m_lock);
 
    bool complete = true;
    for (auto *server : std::as_const(m_servers))
    {
        if (server->m_subscribed)
        {
            // limit browse requests to one active per server
            if (m_browseRequests.contains(server->m_controlURL))
            {
                complete = false;
                continue;
            }
 
            QString next = server->NextUnbrowsed();
            if (!next.isEmpty())
            {
                complete = false;
                SendBrowseRequest(server->m_controlURL, next);
                continue;
            }
 
            LOG(VB_UPNP, LOG_INFO, LOC + QString("Scan completed for %1")
                .arg(server->m_friendlyName));
        }
    }
 
    if (complete)
    {
        LOG(VB_GENERAL, LOG_INFO, LOC +
            QString("Media Server scan is complete."));
        m_scanComplete = true;
        m_fullscan = false;
    }
}
 
void UPNPScanner::SendBrowseRequest(const QUrl &url, const QString &objectid)
{
    QNetworkRequest req = QNetworkRequest(url);
    req.setRawHeader("CONTENT-TYPE", "text/xml; charset=\"utf-8\"");
    req.setRawHeader("SOAPACTION",
                  "\"urn:schemas-upnp-org:service:ContentDirectory:1#Browse\"");
#if 0
    req.setRawHeader("MAN", "\"http://schemasxmlsoap.org/soap/envelope/\"");
    req.setRawHeader("01-SOAPACTION",
                  "\"urn:schemas-upnp-org:service:ContentDirectory:1#Browse\"");
#endif
 
    QByteArray body;
    QTextStream data(&body);
#if QT_VERSION < QT_VERSION_CHECK(6,0,0)
    data.setCodec(QTextCodec::codecForName("UTF-8"));
#else
    data.setEncoding(QStringConverter::Utf8);
#endif
    data << "<?xml version=\"1.0\"?>\r\n";
    data << "<s:Envelope xmlns:s=\"http://schemas.xmlsoap.org/soap/envelope/\" s:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\">\r\n";
    data << "  <s:Body>\r\n";
    data << "    <u:Browse xmlns:u=\"urn:schemas-upnp-org:service:ContentDirectory:1\">\r\n";
    data << "      <ObjectID>" << objectid.toUtf8() << "</ObjectID>\r\n";
    data << "      <BrowseFlag>BrowseDirectChildren</BrowseFlag>\r\n";
    data << "      <Filter>*</Filter>\r\n";
    data << "      <StartingIndex>0</StartingIndex>\r\n";
    data << "      <RequestedCount>0</RequestedCount>\r\n";
    data << "      <SortCriteria></SortCriteria>\r\n";
    data << "    </u:Browse>\r\n";
    data << "  </s:Body>\r\n";
    data << "</s:Envelope>\r\n";
    data.flush();
 
    m_lock.lock();
    QNetworkReply *reply = m_network->post(req, body);
    if (reply)
        m_browseRequests.insert(url, reply);
    m_lock.unlock();
}
 
void UPNPScanner::AddServer(const QString &usn, const QString &url)
{
    if (url.isEmpty())
    {
        RemoveServer(usn);
        return;
    }
 
    // sometimes initialisation is too early and m_masterHost is empty
    if (m_masterHost.isEmpty())
    {
        m_masterHost = gCoreContext->GetMasterServerIP();
        m_masterPort = gCoreContext->GetMasterServerStatusPort();
    }
 
    QUrl qurl(url);
    if (!qurl.isValid())
    {
        LOG(VB_UPNP, LOG_INFO, LOC + "Ignoring invalid url: " + url);
        return;
    }
    if (qurl.host() == m_masterHost && qurl.port() == m_masterPort)
    {
        LOG(VB_UPNP, LOG_INFO, LOC + "Ignoring master backend.");
        return;
    }
 
    m_lock.lock();
    if (!m_servers.contains(usn))
    {
        m_servers.insert(usn, new UpnpMediaServer(qurl));
        LOG(VB_GENERAL, LOG_INFO, LOC + QString("Adding: %1").arg(usn));
        ScheduleUpdate();
    }
    m_lock.unlock();
}
 
void UPNPScanner::RemoveServer(const QString &usn)
{
    m_lock.lock();
    if (m_servers.contains(usn))
    {
        LOG(VB_GENERAL, LOG_INFO, LOC + QString("Removing: %1").arg(usn));
        UpnpMediaServer* old = m_servers[usn];
        if (old->m_renewalTimerId)
            killTimer(old->m_renewalTimerId);
        m_servers.remove(usn);
        delete old;
        if (m_subscription)
            m_subscription->Remove(usn);
    }
    m_lock.unlock();
 
    Debug();
}
 
void UPNPScanner::ScheduleRenewal(const QString &usn, std::chrono::seconds timeout)
{
    // sanitise the timeout
    std::chrono::seconds twelvehours { 12h };
    std::chrono::seconds renew = std::clamp(timeout - 10s, 10s, twelvehours);
 
    m_lock.lock();
    if (m_servers.contains(usn))
        m_servers[usn]->m_renewalTimerId = startTimer(renew);
    m_lock.unlock();
}
 
void UPNPScanner::ParseBrowse(const QUrl &url, QNetworkReply *reply)
{
    QByteArray data = reply->readAll();
    if (data.isEmpty())
        return;
 
    // Open the response for parsing
    auto *parent = new QDomDocument();
#if QT_VERSION < QT_VERSION_CHECK(6,5,0)
    QString errorMessage;
    int errorLine   = 0;
    int errorColumn = 0;
    if (!parent->setContent(data, false, &errorMessage, &errorLine,
                            &errorColumn))
    {
        LOG(VB_GENERAL, LOG_ERR, LOC +
            QString("DIDL Parse error, Line: %1 Col: %2 Error: '%3'")
                .arg(errorLine).arg(errorColumn).arg(errorMessage));
        delete parent;
        return;
    }
#else
    auto parseResult = parent->setContent(data);
    if (!parseResult)
    {
        LOG(VB_GENERAL, LOG_ERR, LOC +
            QString("DIDL Parse error, Line: %1 Col: %2 Error: '%3'")
                .arg(parseResult.errorLine).arg(parseResult.errorColumn)
                .arg(parseResult.errorMessage));
        delete parent;
        return;
    }
#endif
 
    LOG(VB_UPNP, LOG_INFO, "\n\n" + parent->toString(4) + "\n\n");
 
    // pull out the actual result
    QDomDocument *result = nullptr;
    uint num      = 0;
    uint total    = 0;
    uint updateid = 0;
    QDomElement docElem = parent->documentElement();
    QDomNode n = docElem.firstChild();
    if (!n.isNull())
        result = FindResult(n, num, total, updateid);
    delete parent;
 
    if (!result || num < 1 || total < 1)
    {
        LOG(VB_GENERAL, LOG_ERR, LOC +
            QString("Failed to find result for %1") .arg(url.toString()));
        return;
    }
 
    // determine the 'server' which requested the browse
    m_lock.lock();
 
    UpnpMediaServer* server = nullptr;
    auto it = std::find_if(m_servers.cbegin(), m_servers.cend(),
                            [&url](UpnpMediaServer* s){ return url == s->m_controlURL;} );
    if (it != m_servers.cend())
        server = it.value();
 
    // discard unmatched responses
    if (!server)
    {
        m_lock.unlock();
        LOG(VB_GENERAL, LOG_ERR, LOC +
            QString("Received unknown response for %1").arg(url.toString()));
        return;
    }
 
    // check the update ID
    if (server->m_systemUpdateID != (int)updateid)
    {
        // if this is not the root container, this browse will now fail
        // as the appropriate parentID will not be found
        LOG(VB_GENERAL, LOG_ERR, LOC +
            QString("%1 updateID changed during browse (old %2 new %3)")
                .arg(server->m_friendlyName).arg(server->m_systemUpdateID)
                .arg(updateid));
        m_scanComplete &= server->ResetContent(updateid);
        Debug();
    }
 
    // find containers (directories) and actual items and add them and reset
    // the parent when we have found the first item
    bool reset = true;
    docElem = result->documentElement();
    n = docElem.firstChild();
    while (!n.isNull())
    {
        FindItems(n, *server, reset);
        n = n.nextSibling();
    }
    delete result;
 
    m_lock.unlock();
}
 
void UPNPScanner::FindItems(const QDomNode &n, MediaServerItem &content,
                            bool &resetparent)
{
    QDomElement node = n.toElement();
    if (node.isNull())
        return;
 
    if (node.tagName() == "container")
    {
        QString title = "ERROR";
        QDomNode next = node.firstChild();
        while (!next.isNull())
        {
            QDomElement container = next.toElement();
            if (!container.isNull() && container.tagName() == "title")
                title = container.text();
            next = next.nextSibling();
        }
 
        QString thisid   = node.attribute("id", "ERROR");
        QString parentid = node.attribute("parentID", "ERROR");
        MediaServerItem container =
            MediaServerItem(thisid, parentid, title, QString());
        MediaServerItem *parent = content.Find(parentid);
        if (parent)
        {
            if (resetparent)
            {
                parent->Reset();
                resetparent = false;
            }
            parent->m_scanned = true;
            parent->Add(container);
        }
        return;
    }
 
    if (node.tagName() == "item")
    {
        QString title = "ERROR";
        QString url = "ERROR";
        QDomNode next = node.firstChild();
        while (!next.isNull())
        {
            QDomElement item = next.toElement();
            if (!item.isNull())
            {
                if(item.tagName() == "res")
                    url = item.text();
                if(item.tagName() == "title")
                    title = item.text();
            }
            next = next.nextSibling();
        }
 
        QString thisid   = node.attribute("id", "ERROR");
        QString parentid = node.attribute("parentID", "ERROR");
        MediaServerItem item =
                MediaServerItem(thisid, parentid, title, url);
        item.m_scanned = true;
        MediaServerItem *parent = content.Find(parentid);
        if (parent)
        {
            if (resetparent)
            {
                parent->Reset();
                resetparent = false;
            }
            parent->m_scanned = true;
            parent->Add(item);
        }
        return;
    }
 
    QDomNode next = node.firstChild();
    while (!next.isNull())
    {
        FindItems(next, content, resetparent);
        next = next.nextSibling();
    }
}
 
QDomDocument* UPNPScanner::FindResult(const QDomNode &n, uint &num,
                                      uint &total, uint &updateid)
{
    QDomDocument *result = nullptr;
    QDomElement node = n.toElement();
    if (node.isNull())
        return nullptr;
 
    if (node.tagName() == "NumberReturned")
        num = node.text().toUInt();
    if (node.tagName() == "TotalMatches")
        total = node.text().toUInt();
    if (node.tagName() == "UpdateID")
        updateid = node.text().toUInt();
    if (node.tagName() == "Result" && !result)
    {
        result = new QDomDocument();
#if QT_VERSION < QT_VERSION_CHECK(6,5,0)
        QString errorMessage;
        int errorLine   = 0;
        int errorColumn = 0;
        if (!result->setContent(node.text(), true, &errorMessage, &errorLine, &errorColumn))
        {
            LOG(VB_GENERAL, LOG_ERR, LOC +
                QString("DIDL Parse error, Line: %1 Col: %2 Error: '%3'")
                    .arg(errorLine).arg(errorColumn).arg(errorMessage));
            delete result;
            result = nullptr;
        }
#else
        auto parseResult =
            result->setContent(node.text(),
                               QDomDocument::ParseOption::UseNamespaceProcessing);
        if (!parseResult)
        {
            LOG(VB_GENERAL, LOG_ERR, LOC +
                QString("DIDL Parse error, Line: %1 Col: %2 Error: '%3'")
                    .arg(parseResult.errorLine).arg(parseResult.errorColumn)
                    .arg(parseResult.errorMessage));
            delete result;
            result = nullptr;
        }
#endif
    }
 
    QDomNode next = node.firstChild();
    while (!next.isNull())
    {
        QDomDocument *res = FindResult(next, num, total, updateid);
        if (res)
            result = res;
        next = next.nextSibling();
    }
    return result;
}
 
static QUrl urlAddBaseAndPath (QUrl base, const QUrl& relative)
{
    base.setFragment("");
    base.setQuery("");
    base.setPath(relative.path());
    return base;
}
 
bool UPNPScanner::ParseDescription(const QUrl &url, QNetworkReply *reply)
{
    if (url.isEmpty() || !reply)
        return false;
 
    QByteArray data = reply->readAll();
    if (data.isEmpty())
    {
        LOG(VB_GENERAL, LOG_ERR, LOC +
            QString("%1 returned an empty device description.")
                .arg(url.toString()));
        return false;
    }
 
    // parse the device description
    QUrl    URLBase;
    QUrl    controlURL;
    QUrl    eventURL;
    QString friendlyName = QString("Unknown");
 
    QDomDocument doc;
#if QT_VERSION < QT_VERSION_CHECK(6,5,0)
    QString errorMessage;
    int errorLine   = 0;
    int errorColumn = 0;
    if (!doc.setContent(data, false, &errorMessage, &errorLine, &errorColumn))
    {
        LOG(VB_GENERAL, LOG_ERR, LOC +
            QString("Failed to parse device description from %1")
                .arg(url.toString()));
        LOG(VB_GENERAL, LOG_ERR, LOC + QString("Line: %1 Col: %2 Error: '%3'")
            .arg(errorLine).arg(errorColumn).arg(errorMessage));
        return false;
    }
#else
    auto parseResult = doc.setContent(data);
    if (!parseResult)
    {
        LOG(VB_GENERAL, LOG_ERR, LOC +
            QString("Failed to parse device description from %1")
                .arg(url.toString()));
        LOG(VB_GENERAL, LOG_ERR, LOC + QString("Line: %1 Col: %2 Error: '%3'")
            .arg(parseResult.errorLine).arg(parseResult.errorColumn)
            .arg(parseResult.errorMessage));
        return false;
    }
#endif
 
    QDomElement docElem = doc.documentElement();
    QDomNode n = docElem.firstChild();
    while (!n.isNull())
    {
        QDomElement e1 = n.toElement();
        if (!e1.isNull())
        {
            if(e1.tagName() == "device")
                ParseDevice(e1, controlURL, eventURL, friendlyName);
            if (e1.tagName() == "URLBase")
                URLBase = QUrl(e1.text());
        }
        n = n.nextSibling();
    }
 
    if (!controlURL.isValid())
    {
        LOG(VB_UPNP, LOG_ERR, LOC +
            QString("Failed to parse device description for %1")
                .arg(url.toString()));
        return false;
    }
 
    // if no URLBase was provided, use the known url
    if (!URLBase.isValid())
    {
        URLBase = url;
        URLBase.setPath("");
        URLBase.setFragment("");
        URLBase.setQuery("");
    }
 
    if (controlURL.isRelative())
        controlURL = urlAddBaseAndPath(URLBase, controlURL);
    if (eventURL.isRelative())
        eventURL = urlAddBaseAndPath(URLBase, eventURL);
 
    LOG(VB_UPNP, LOG_INFO, LOC + QString("Control URL for %1 at %2")
            .arg(friendlyName, controlURL.toString()));
    LOG(VB_UPNP, LOG_INFO, LOC + QString("Event URL for %1 at %2")
            .arg(friendlyName, eventURL.toString()));
 
    // update the server details. If the server has gone away since the request
    // was posted, this will silently fail and we won't try again
    QString usn;
    std::chrono::seconds timeout = 0s;
 
    m_lock.lock();
    auto it = std::find_if(m_servers.cbegin(), m_servers.cend(),
                           [&url](UpnpMediaServer* server){ return url == server->m_serverURL;} );
    if (it != m_servers.cend())
    {
        usn = it.key();
        UpnpMediaServer* server = it.value();
        server->m_controlURL   = controlURL;
        server->m_eventSubURL  = eventURL;
        server->m_eventSubPath = eventURL;
        server->m_friendlyName = friendlyName;
        server->m_name         = friendlyName;
    }
 
    if (m_subscription && !usn.isEmpty())
    {
        timeout = m_subscription->Subscribe(usn, eventURL, eventURL.toString());
        m_servers[usn]->m_subscribed = (timeout > 0s);
    }
    m_lock.unlock();
 
    if (timeout > 0s)
    {
        LOG(VB_GENERAL, LOG_INFO, LOC +
            QString("Subscribed for %1 seconds to %2") .arg(timeout.count()).arg(usn));
        ScheduleRenewal(usn, timeout);
        // we only scan servers we are subscribed to - and the scan is now
        // incomplete
        m_scanComplete = false;
    }
 
    Debug();
    return true;
}
 
 
void UPNPScanner::ParseDevice(QDomElement &element, QUrl &controlURL,
                              QUrl &eventURL, QString &friendlyName)
{
    QDomNode dev = element.firstChild();
    while (!dev.isNull())
    {
        QDomElement e = dev.toElement();
        if (!e.isNull())
        {
            if (e.tagName() == "friendlyName")
                friendlyName = e.text();
            if (e.tagName() == "serviceList")
                ParseServiceList(e, controlURL, eventURL);
        }
        dev = dev.nextSibling();
    }
}
 
void UPNPScanner::ParseServiceList(QDomElement &element, QUrl &controlURL,
                                   QUrl &eventURL)
{
    QDomNode list = element.firstChild();
    while (!list.isNull())
    {
        QDomElement e = list.toElement();
        if (!e.isNull())
            if (e.tagName() == "service")
                ParseService(e, controlURL, eventURL);
        list = list.nextSibling();
    }
}
 
void UPNPScanner::ParseService(QDomElement &element, QUrl &controlURL,
                               QUrl &eventURL)
{
    bool     iscds       = false;
    QUrl     control_url;
    QUrl     event_url;
    QDomNode service     = element.firstChild();
 
    while (!service.isNull())
    {
        QDomElement e = service.toElement();
        if (!e.isNull())
        {
            if (e.tagName() == "serviceType")
                // FIXME UPNP version comparision done wrong, we are using urn:schemas-upnp-org:device:MediaServer:4 ourselves
                iscds = (e.text() == "urn:schemas-upnp-org:service:ContentDirectory:1");
            if (e.tagName() == "controlURL")
                control_url = QUrl(e.text());
            if (e.tagName() == "eventSubURL")
                event_url = QUrl(e.text());
        }
        service = service.nextSibling();
    }
 
    if (iscds)
    {
        controlURL = control_url;
        eventURL   = event_url;
    }
}