-
Notifications
You must be signed in to change notification settings - Fork 345
/
upnpscanner.cpp
1402 lines (1250 loc) · 39.5 KB
/
upnpscanner.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// C++
#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/ssdp.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)
{
// items don't need scanning
if (!m_url.isEmpty())
return {};
// scan this container
if (!m_scanned)
return m_id;
// scan children
QMutableMapIterator<QString,MediaServerItem> it(m_children);
while (it.hasNext())
{
it.next();
QString result = it.value().NextUnbrowsed();
if (!result.isEmpty())
return result;
}
return {};
}
MediaServerItem* MediaServerItem::Find(QString &id)
{
if (m_id == id)
return this;
QMutableMapIterator<QString,MediaServerItem> it(m_children);
while (it.hasNext())
{
it.next();
MediaServerItem* result = it.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
* A simple wrapper containing details about a UPnP Media Server
*/
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;
QString 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();
/**
* \class UPNPScanner
* UPnPScanner detects UPnP Media Servers available on the local network (via
* the UPnP SSDP cache), requests the device description from those devices
* and, if the device description is successfully parsed, will request a
* a subscription to the device's event control url in order to receive
* notifications when the available media has changed. The subscription is
* renewed at an appropriate time before it expires. The available media for
* each device can then be queried by sending browse requests as needed.
*/
UPNPScanner::~UPNPScanner()
{
Stop();
}
/**
* \fn UPNPScanner::Enable(bool, UPNPSubscription*)
* Creates or destroys the global UPNPScanner instance.
*/
void UPNPScanner::Enable(bool enable, UPNPSubscription *sub)
{
QMutexLocker locker(gUPNPScannerLock);
gUPNPScannerEnabled = enable;
Instance(sub);
}
/**
* \fn UPNPScanner::Instance(UPNPSubscription*)
* Returns the global UPNPScanner instance if it has been enabled or nullptr
* if UPNPScanner is currently disabled.
*/
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;
}
/**
* \fn UPNPScanner::StartFullScan
* Instruct the UPNPScanner thread to start a full scan of metadata from
* known media servers.
*/
void UPNPScanner::StartFullScan(void)
{
m_fullscan = true;
auto *me = new MythEvent(QString("UPNP_STARTSCAN"));
qApp->postEvent(this, me);
}
/**
* \fn UPNPScanner::GetInitialMetadata
* Fill the given metadata_list and meta_dir_node with the root media
* server metadata (i.e. the MediaServers) and any additional metadata that
* that has already been scanned and cached.
*/
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();
QMutableHashIterator<QString,UpnpMediaServer*> it(m_servers);
while (it.hasNext())
{
it.next();
if (!it.value()->m_subscribed)
continue;
QString usn = it.key();
GetServerContent(usn, it.value(), list, mediaservers.get());
}
m_lock.unlock();
}
/**
* Fill the given metadata_list and meta_dir_node with the metadata
* of content retrieved from known media servers. A full scan is triggered.
*/
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();
QMutableHashIterator<QString,UpnpMediaServer*> it(m_servers);
while (it.hasNext())
{
it.next();
if (!it.value()->m_subscribed)
continue;
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;
}
/**
* \fn UPNPScanner::GetServerContent
* Recursively search a MediaServerItem for video metadata and add it to
* the metadata_list and meta_dir_node.
*/
void UPNPScanner::GetServerContent(QString &usn,
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);
QMutableMapIterator<QString,MediaServerItem> it(content->m_children);
while (it.hasNext())
{
it.next();
GetServerContent(usn, &it.value(), 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())));
}
/**
* \fn UPNPScanner::ServerList(void)
* Returns a list of valid Media Servers discovered on the network. The
* returned map is a QString pair of USNs and friendly names.
*/
QMap<QString,QString> UPNPScanner::ServerList(void)
{
QMap<QString,QString> servers;
m_lock.lock();
QHashIterator<QString,UpnpMediaServer*> it(m_servers);
while (it.hasNext())
{
it.next();
servers.insert(it.key(), it.value()->m_friendlyName);
}
m_lock.unlock();
return servers;
}
/**
* \fn UPNPScanner::Start(void)
* Initialises the scanner, hooks it up to the subscription service and the
* SSDP cache and starts scanning.
*/
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
SSDP::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");
}
/**
* \fn UPNPScanner::Stop(void)
* Stops scanning.
*/
void UPNPScanner::Stop(void)
{
m_lock.lock();
// stop listening
SSDP::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
QHashIterator<QString,UpnpMediaServer*> it(m_servers);
while (it.hasNext())
{
it.next();
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");
}
/**
* \fn UPNPScanner::Update(void)
* Iterates through the list of known servers and initialises a connection by
* requesting the device description.
*/
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;
QHashIterator<QString,UpnpMediaServer*> it(m_servers);
while (it.hasNext())
{
it.next();
if ((it.value()->m_connectionAttempts < MAX_ATTEMPTS) &&
(it.value()->m_controlURL.isEmpty()))
{
bool sent = false;
QUrl url = it.value()->m_url;
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);
it.value()->m_connectionAttempts++;
}
}
if (!sent)
reschedule = true;
}
}
if (reschedule)
ScheduleUpdate();
m_lock.unlock();
}
/**
* \fn UPNPScanner::CheckStatus(void)
* Removes media servers that can no longer be found in the SSDP cache.
*/
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();
QMutableHashIterator<QString,UpnpMediaServer*> it(m_servers);
while (it.hasNext())
{
it.next();
// FIXME UPNP version comparision done wrong, we are using urn:schemas-upnp-org:device:MediaServer:4 ourselves
if (!SSDP::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.remove();
delete last;
}
}
m_lock.unlock();
}
/**
* \fn UPNPScanner::replyFinished(void)
* Validates network responses against known requests and parses expected
* responses for the required data.
*/
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();
}
/**
* Processes subscription and SSDP cache update events.
*/
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);
}
}
/**
* \fn UPNPScanner::timerEvent(QTimerEvent*)
* Handles subscription renewal timer events.
*/
void UPNPScanner::timerEvent(QTimerEvent * event)
{
int id = event->timerId();
if (id)
killTimer(id);
std::chrono::seconds timeout = 0s;
QString usn;
m_lock.lock();
QHashIterator<QString,UpnpMediaServer*> it(m_servers);
while (it.hasNext())
{
it.next();
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));
}
}
/**
* \fn UPNPScanner::ScheduleUpdate(void)
*/
void UPNPScanner::ScheduleUpdate(void)
{
m_lock.lock();
if (m_updateTimer && !m_updateTimer->isActive())
m_updateTimer->start(200ms);
m_lock.unlock();
}
/**
* \fn UPNPScanner::CheckFailure(const QUrl&)
* Updates the logs for failed server connections.
*/
void UPNPScanner::CheckFailure(const QUrl &url)
{
m_lock.lock();
QHashIterator<QString,UpnpMediaServer*> it(m_servers);
while (it.hasNext())
{
it.next();
if (it.value()->m_serverURL == url && it.value()->m_connectionAttempts == MAX_ATTEMPTS)
{
Debug();
break;
}
}
m_lock.unlock();
}
/**
* \fn UPNPScanner::Debug(void)
*/
void UPNPScanner::Debug(void)
{
m_lock.lock();
LOG(VB_UPNP, LOG_INFO, LOC + QString("%1 media servers discovered:")
.arg(m_servers.size()));
QHashIterator<QString,UpnpMediaServer*> it(m_servers);
while (it.hasNext())
{
it.next();
QString status = "Probing";
if (it.value()->m_controlURL.toString().isEmpty())
{
if (it.value()->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(it.value()->m_friendlyName, status,
it.value()->m_subscribed ? "Yes" : "No",
QString::number(it.value()->m_systemUpdateID),
QString::number(it.value()->m_renewalTimerId)));
}
m_lock.unlock();
}
/**
* \fn UPNPScanner::BrowseNextContainer
* For each known media server, find the next container which needs to be
* browsed and trigger sending of the browse request (with a maximum of one
* active browse request for each server). Once all containers have been
* browsed, the scan is considered complete. N.B. failed browse requests
* are ignored.
*/
void UPNPScanner::BrowseNextContainer(void)
{
QMutexLocker locker(&m_lock);
QHashIterator<QString,UpnpMediaServer*> it(m_servers);
bool complete = true;
while (it.hasNext())
{
it.next();
if (it.value()->m_subscribed)
{
// limit browse requests to one active per server
if (m_browseRequests.contains(it.value()->m_controlURL))
{
complete = false;
continue;
}
QString next = it.value()->NextUnbrowsed();
if (!next.isEmpty())
{
complete = false;
SendBrowseRequest(it.value()->m_controlURL, next);
continue;
}
LOG(VB_UPNP, LOG_INFO, LOC + QString("Scan completed for %1")
.arg(it.value()->m_friendlyName));
}
}
if (complete)
{
LOG(VB_GENERAL, LOG_INFO, LOC +
QString("Media Server scan is complete."));
m_scanComplete = true;
m_fullscan = false;
}
}
/**
* \fn UPNPScanner::SendBrowseRequest(const QUrl&, const QString&)
* Formulates and sends a ContentDirectory Service Browse Request to the given
* control URL, requesting data for the object identified by objectid.
*/
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();
}
/**
* \fn UPNPScanner::AddServer(const QString&, const QString&)
* Adds the server identified by usn and reachable via url to the list of
* known media servers and schedules an update to initiate a connection.
*/
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.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(url));
LOG(VB_GENERAL, LOG_INFO, LOC + QString("Adding: %1").arg(usn));
ScheduleUpdate();
}
m_lock.unlock();
}
/**
* \fn UPNPScanner::RemoveServer(const QString&)
*/
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();
}
/**
* Creates a QTimer to trigger a subscription renewal for a given media server.
*/
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();
}
/**
* \fn UPNPScanner::ParseBrowse(const QUrl&, QNetworkReply*)
* Parse the XML returned from Content Directory Service browse request.
*/
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();