forked from qbittorrent/qBittorrent
-
Notifications
You must be signed in to change notification settings - Fork 0
/
rss.h
626 lines (551 loc) · 16.8 KB
/
rss.h
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
/*
* Bittorrent Client using Qt4 and libtorrent.
* Copyright (C) 2006 Christophe Dumez, Arnaud Demaiziere
*
* 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.
*
* Contact : [email protected], [email protected]
*/
#ifndef RSS_H
#define RSS_H
// MAX ITEM A STREAM
#define STREAM_MAX_ITEM 50
// 10min
#define STREAM_REFRESH_INTERVAL 600000
#include <QFile>
#include <QList>
#include <QTemporaryFile>
#include <QSettings>
#include <QDomDocument>
#include <QTime>
#include <QUrl>
#include <QTimer>
#include <QImage>
#include <QHash>
#include "misc.h"
#include "downloadThread.h"
#ifndef NO_MAGICK
#include <Magick++.h>
using namespace Magick;
#endif
class RssManager;
class RssStream;
class RssItem;
// Item of a rss stream, single information
class RssItem : public QObject {
Q_OBJECT
private:
QString title;
QString link;
QString description;
QString image;
bool read;
QString downloadLink;
public:
// public constructor
RssItem(const QDomElement& properties) : read(false), downloadLink("none") {
QDomElement property = properties.firstChild().toElement();
while(!property.isNull()) {
if (property.tagName() == "title")
title = property.text();
else if (property.tagName() == "link")
link = property.text();
else if (property.tagName() == "description")
description = property.text();
else if (property.tagName() == "image")
image = property.text();
property = property.nextSibling().toElement();
}
}
~RssItem(){
}
QString getTitle() const{
return title;
}
QString getLink() const{
return link;
}
QString getDescription() const{
if(description.isEmpty())
return tr("No description available");
return description;
}
QString getImage() const{
return image;
}
QString getDownloadLink() const{
return downloadLink;
}
bool isRead() const{
return read;
}
void setRead(){
read = true;
}
};
// Rss stream, loaded form an xml file
class RssStream : public QObject{
Q_OBJECT
private:
QString title;
QString link;
QString description;
QString image;
QString url;
QString alias;
QString filePath;
QString iconPath;
QList<RssItem*> listItem;
QTime lastRefresh;
bool read;
bool refreshed;
bool downloadFailure;
bool currently_loading;
public slots :
// read and store the downloaded rss' informations
void processDownloadedFile(QString file_path) {
// delete the old file
if(QFile::exists(filePath)) {
QFile::remove(filePath);
}
filePath = file_path;
downloadFailure = false;
openRss();
lastRefresh.start();
refreshed = true;
}
void setDownloadFailed(){
downloadFailure = true;
lastRefresh.start();
}
public:
RssStream(QString _url): url(_url), alias(""), iconPath(":/Icons/rss.png"), refreshed(false), downloadFailure(false), currently_loading(false) {
qDebug("RSSStream constructed");
}
~RssStream(){
removeAllItems();
if(QFile::exists(filePath))
QFile::remove(filePath);
if(QFile::exists(iconPath) && !iconPath.startsWith(":/"))
QFile::remove(iconPath);
}
// delete all the items saved
void removeAllItems() {
qDeleteAll(listItem);
listItem.clear();
}
void setLoading(bool val) {
currently_loading = val;
}
bool isLoading() {
return currently_loading;
}
QString getTitle() const{
return title;
}
QString getAlias() const{
return alias;
}
void setAlias(QString _alias){
alias = _alias;
}
// Return the alias if the stream has one, the url if it has no alias
QString getAliasOrUrl() const{
if(!alias.isEmpty())
return alias;
if(!title.isEmpty())
return title;
return url;
}
QString getLink() const{
return link;
}
QString getUrl() const{
return url;
}
QString getDescription() const{
return description;
}
QString getImage() const{
return image;
}
QString getFilePath() const{
return filePath;
}
QString getIconPath() const{
if(downloadFailure)
return ":/Icons/unavailable.png";
return iconPath;
}
bool hasCustomIcon() const{
return !iconPath.startsWith(":/");
}
void setIconPath(QString path) {
iconPath = path;
}
RssItem* getItem(unsigned int index) const{
return listItem.at(index);
}
unsigned int getNbNews() const{
return listItem.size();
}
unsigned int getNbUnRead() const{
unsigned int nbUnread=0;
RssItem *item;
foreach(item, listItem){
if(!item->isRead())
++nbUnread;
}
return nbUnread;
}
QList<RssItem*> getNewsList() const{
return listItem;
}
QString getLastRefreshElapsedString() const{
if(!refreshed)
return tr("Never");
return tr("%1 ago", "10min ago").arg(misc::userFriendlyDuration((long)(lastRefresh.elapsed()/1000.)).replace("<", "<"));
}
unsigned int getLastRefreshElapsed() const{
if(!refreshed)
return STREAM_REFRESH_INTERVAL+1;
return lastRefresh.elapsed();
}
// download the icon from the adress
QString getIconUrl() {
QUrl siteUrl(url);
return QString::fromUtf8("http:https://")+siteUrl.host()+QString::fromUtf8("/favicon.ico");
}
private:
// read and create items from a rss document
short readDoc(const QDomDocument& doc) {
// is it a rss file ?
QDomElement root = doc.documentElement();
if(root.tagName() == QString::fromUtf8("html")){
qDebug("the file is empty, maybe the url is invalid or the server is too busy");
return -1;
}
else if(root.tagName() != QString::fromUtf8("rss")){
qDebug("the file is not a rss stream, <rss> omitted: %s", root.tagName().toUtf8().data());
return -1;
}
QDomNode rss = root.firstChild();
QDomElement channel = root.firstChild().toElement();
unsigned short listsize = getNbNews();
for(unsigned short i=0; i<listsize; ++i) {
listItem.removeLast();
}
while(!channel.isNull()) {
// we are reading the rss'main info
if (channel.tagName() == "channel") {
QDomElement property = channel.firstChild().toElement();
while(!property.isNull()) {
if (property.tagName() == "title") {
title = property.text();
if(alias==getUrl())
setAlias(title);
}
else if (property.tagName() == "link")
link = property.text();
else if (property.tagName() == "description")
description = property.text();
else if (property.tagName() == "image")
image = property.text();
else if(property.tagName() == "item") {
if(getNbNews() < STREAM_MAX_ITEM) {
listItem.append(new RssItem(property));
}
}
property = property.nextSibling().toElement();
}
}
channel = channel.nextSibling().toElement();
}
return 0;
}
// not actually used, it is used to resize the list of item AFTER the update, instead of delete it BEFORE, some troubles
void resizeList() {
unsigned short lastindex = 0;
QString firstTitle = getItem(0)->getTitle();
unsigned short listsize = getNbNews();
for(unsigned short i=0; i<listsize; ++i) {
if(getItem(i)->getTitle() == firstTitle)
lastindex = i;
}
for(unsigned short i=0; i<lastindex; ++i) {
listItem.removeFirst();
}
while(getNbNews()>STREAM_MAX_ITEM) {
listItem.removeAt(STREAM_MAX_ITEM);
}
}
// existing and opening test after download
short openRss(){
QDomDocument doc("Rss Seed");
QFile fileRss(filePath);
if(!fileRss.open(QIODevice::ReadOnly | QIODevice::Text)) {
qDebug("error : open failed, no file or locked, "+filePath.toUtf8());
if(QFile::exists(filePath)) {
fileRss.remove();
}
return -1;
}
if(!doc.setContent(&fileRss)) {
qDebug("can't read temp file, might be empty");
fileRss.close();
if(QFile::exists(filePath)) {
fileRss.remove();
}
return -1;
}
// start reading the xml
short return_lecture = readDoc(doc);
fileRss.close();
if(QFile::exists(filePath)) {
fileRss.remove();
}
return return_lecture;
}
};
// global class, manage the whole rss stream
class RssManager : public QObject{
Q_OBJECT
private :
QHash<QString, RssStream*> streams;
downloadThread *downloader;
QTimer newsRefresher;
signals:
void feedInfosChanged(QString url, QString aliasOrUrl, unsigned int nbUnread);
void feedIconChanged(QString url, QString icon_path);
public slots :
void processFinishedDownload(QString url, QString path) {
if(url.endsWith("favicon.ico")){
// Icon downloaded
QImage fileIcon;
#ifndef NO_MAGICK
try{
QFile::copy(path, path+".ico");
Image image(QDir::cleanPath(path+".ico").toUtf8().data());
// Convert to PNG since we can't read ICO format
image.magick("PNG");
image.write(path.toUtf8().data());
QFile::remove(path+".ico");
}catch(Magick::Exception &error_){
qDebug("favicon conversion to PNG failure: %s", error_.what());
}
#endif
if(fileIcon.load(path)) {
QList<RssStream*> res = findFeedsWithIcon(url);
RssStream* stream;
foreach(stream, res){
stream->setIconPath(path);
if(!stream->isLoading())
emit feedIconChanged(stream->getUrl(), stream->getIconPath());
}
}else{
qDebug("Unsupported icon format at %s", (const char*)url.toUtf8());
}
return;
}
RssStream *stream = streams.value(url, 0);
if(!stream){
qDebug("This rss stream was deleted in the meantime, nothing to update");
return;
}
stream->processDownloadedFile(path);
stream->setLoading(false);
// If the feed has no alias, then we use the title as Alias
// this is more user friendly
if(stream->getAlias().isEmpty()){
if(!stream->getTitle().isEmpty())
stream->setAlias(stream->getTitle());
}
emit feedInfosChanged(url, stream->getAliasOrUrl(), stream->getNbUnRead());
}
void handleDownloadFailure(QString url, QString reason) {
if(url.endsWith("favicon.ico")){
// Icon download failure
qDebug("Could not download icon at %s, reason: %s", (const char*)url.toUtf8(), (const char*)reason.toUtf8());
return;
}
RssStream *stream = streams.value(url, 0);
if(!stream){
qDebug("This rss stream was deleted in the meantime, nothing to update");
return;
}
stream->setLoading(false);
qDebug("Could not download Rss at %s, reason: %s", (const char*)url.toUtf8(), (const char*)reason.toUtf8());
stream->setDownloadFailed();
emit feedInfosChanged(url, stream->getAliasOrUrl(), stream->getNbUnRead());
}
void refreshOldFeeds(){
RssStream *stream;
foreach(stream, streams){
QString url = stream->getUrl();
if(stream->isLoading()) return;
if(stream->getLastRefreshElapsed() < STREAM_REFRESH_INTERVAL) return;
qDebug("Refreshing old feed: %s...", (const char*)url.toUtf8());
stream->setLoading(true);
downloader->downloadUrl(url);
if(!stream->hasCustomIcon()){
downloader->downloadUrl(stream->getIconUrl());
}
}
}
public :
RssManager(){
downloader = new downloadThread(this);
connect(downloader, SIGNAL(downloadFinished(QString, QString)), this, SLOT(processFinishedDownload(QString, QString)));
connect(downloader, SIGNAL(downloadFailure(QString, QString)), this, SLOT(handleDownloadFailure(QString, QString)));
loadStreamList();
connect(&newsRefresher, SIGNAL(timeout()), this, SLOT(refreshOldFeeds()));
newsRefresher.start(60000);
}
~RssManager(){
qDeleteAll(streams);
delete downloader;
}
// load the list of the rss stream
void loadStreamList(){
QSettings settings("qBittorrent", "qBittorrent");
QStringList streamsUrl = settings.value("Rss/streamList").toStringList();
QStringList aliases = settings.value("Rss/streamAlias").toStringList();
if(streamsUrl.size() != aliases.size()){
std::cerr << "Corrupted Rss list, not loading it\n";
return;
}
QString url;
unsigned int i = 0;
foreach(url, streamsUrl){
RssStream *stream = new RssStream(url);
QString alias = aliases.at(i);
if(!alias.isEmpty()) {
stream->setAlias(alias);
}
streams[url] = stream;
++i;
}
qDebug("NB RSS streams loaded: %d", streamsUrl.size());
}
// save the list of the rss stream for the next session
void saveStreamList(){
QList<QPair<QString, QString> > streamsList;
QStringList streamsUrl;
QStringList aliases;
RssStream *stream;
foreach(stream, streams){
streamsUrl << stream->getUrl();
aliases << stream->getAlias();
}
QSettings settings("qBittorrent", "qBittorrent");
settings.beginGroup("Rss");
settings.setValue("streamList", streamsUrl);
settings.setValue("streamAlias", aliases);
settings.endGroup();
}
// add a stream to the manager
void addStream(RssStream* stream){
QString url = stream->getUrl();
if(streams.contains(url)){
qDebug("Not adding the Rss stream because it is already in the list");
return;
}
streams[url] = stream;
emit feedIconChanged(url, stream->getIconPath());
}
// add a stream to the manager
RssStream* addStream(QString url){
if(streams.contains(url)){
qDebug("Not adding the Rss stream because it is already in the list");
return 0;
}
RssStream* stream = new RssStream(url);
streams[url] = stream;
refresh(url);
return stream;
}
// remove a stream from the manager
void removeStream(RssStream* stream){
QString url = stream->getUrl();
Q_ASSERT(streams.contains(url));
delete streams.take(url);
}
QList<RssStream*> findFeedsWithIcon(QString icon_url){
QList<RssStream*> res;
RssStream* stream;
foreach(stream, streams){
if(stream->getIconUrl() == icon_url)
res << stream;
}
return res;
}
void removeStream(QString url){
Q_ASSERT(streams.contains(url));
delete streams.take(url);
}
// remove all the streams in the manager
void removeAll(){
qDeleteAll(streams);
streams.clear();
}
// reload all the xml files from the web
void refreshAll(){
qDebug("Refreshing all rss feeds");
RssStream *stream;
foreach(stream, streams){
QString url = stream->getUrl();
if(stream->isLoading()) return;
qDebug("Refreshing feed: %s...", (const char*)url.toUtf8());
stream->setLoading(true);
downloader->downloadUrl(url);
if(!stream->hasCustomIcon()){
downloader->downloadUrl(stream->getIconUrl());
}
}
}
void refresh(QString url) {
Q_ASSERT(streams.contains(url));
RssStream *stream = streams[url];
if(stream->isLoading()) return;
stream->setLoading(true);
downloader->downloadUrl(url);
if(!stream->hasCustomIcon()){
downloader->downloadUrl(stream->getIconUrl());
}else{
qDebug("No need to download this feed's icon, it was already downloaded");
}
}
// XXX: Used?
unsigned int getNbFeeds() {
return streams.size();
}
RssStream* getFeed(QString url){
Q_ASSERT(streams.contains(url));
return streams[url];
}
// Set an alias for a stream and save it for later
void setAlias(QString url, QString newAlias) {
Q_ASSERT(!newAlias.isEmpty());
RssStream * stream = streams.value(url, 0);
Q_ASSERT(stream != 0);
stream->setAlias(newAlias);
emit feedInfosChanged(url, stream->getAliasOrUrl(), stream->getNbUnRead());
}
// Return all the rss feeds we have
QList<RssStream*> getRssFeeds() const {
return streams.values();
}
};
#endif