source: trunk/qt/torrent.h @ 11086

Last change on this file since 11086 was 11086, checked in by Longinus00, 12 years ago

(trunk) #3471:Add 'finished' to filterbar

  • Property svn:keywords set to Date Rev Author Id
File size: 11.6 KB
Line 
1/*
2 * This file Copyright (C) 2009-2010 Mnemosyne LLC
3 *
4 * This file is licensed by the GPL version 2.  Works owned by the
5 * Transmission project are granted a special exemption to clause 2(b)
6 * so that the bulk of its code can remain under the MIT license.
7 * This exemption does not extend to derived works not owned by
8 * the Transmission project.
9 *
10 * $Id: torrent.h 11086 2010-08-01 17:43:35Z Longinus00 $
11 */
12
13#ifndef QTR_TORRENT_H
14#define QTR_TORRENT_H
15
16#include <QObject>
17#include <QIcon>
18#include <QMetaType>
19#include <QDateTime>
20#include <QString>
21#include <QStringList>
22#include <QList>
23#include <QTemporaryFile>
24#include <QVariant>
25
26#include <libtransmission/transmission.h>
27
28#include "speed.h"
29#include "types.h"
30
31extern "C"
32{
33    struct tr_benc;
34}
35
36class Prefs;
37class QPixmap;
38class QStyle;
39
40struct Peer
41{
42    QString address;
43    QString clientName;
44    bool clientIsChoked;
45    bool clientIsInterested;
46    QString flagStr;
47    bool isDownloadingFrom;
48    bool isEncrypted;
49    bool isIncoming;
50    bool isUploadingTo;
51    bool peerIsChoked;
52    bool peerIsInterested;
53    int port;
54    double progress;
55    Speed rateToClient;
56    Speed rateToPeer;
57};
58
59typedef QList<Peer> PeerList;
60Q_DECLARE_METATYPE(Peer)
61Q_DECLARE_METATYPE(PeerList)
62
63struct TrackerStat
64{
65    QString announce;
66    int announceState;
67    int downloadCount;
68    bool hasAnnounced;
69    bool hasScraped;
70    QString host;
71    int id;
72    bool isBackup;
73    int lastAnnouncePeerCount;
74    QString lastAnnounceResult;
75    int lastAnnounceStartTime;
76    bool lastAnnounceSucceeded;
77    int lastAnnounceTime;
78    bool lastAnnounceTimedOut;
79    QString lastScrapeResult;
80    int lastScrapeStartTime;
81    bool lastScrapeSucceeded;
82    int lastScrapeTime;
83    bool lastScrapeTimedOut;
84    int leecherCount;
85    int nextAnnounceTime;
86    int nextScrapeTime;
87    int scrapeState;
88    int seederCount;
89    int tier;
90    QPixmap getFavicon( ) const;
91};
92
93typedef QList<TrackerStat> TrackerStatsList;
94Q_DECLARE_METATYPE(TrackerStat)
95Q_DECLARE_METATYPE(TrackerStatsList)
96
97struct TrFile
98{
99    TrFile(): index(-1), priority(0), wanted(true), size(0), have(0) { }
100    int index;
101    int priority;
102    bool wanted;
103    uint64_t size;
104    uint64_t have;
105    QString filename;
106};
107
108typedef QList<TrFile> FileList;
109Q_DECLARE_METATYPE(TrFile)
110Q_DECLARE_METATYPE(FileList)
111
112
113class Torrent: public QObject
114{
115        Q_OBJECT;
116
117    public:
118
119        enum
120        {
121            ID,
122            UPLOAD_SPEED,
123            DOWNLOAD_SPEED,
124            DOWNLOAD_DIR,
125            ACTIVITY,
126            NAME,
127            ERROR,
128            ERROR_STRING,
129            SIZE_WHEN_DONE,
130            LEFT_UNTIL_DONE,
131            HAVE_UNCHECKED,
132            HAVE_VERIFIED,
133            DESIRED_AVAILABLE,
134            TOTAL_SIZE,
135            PIECE_SIZE,
136            PIECE_COUNT,
137            PEERS_GETTING_FROM_US,
138            PEERS_SENDING_TO_US,
139            WEBSEEDS_SENDING_TO_US,
140            PERCENT_DONE,
141            METADATA_PERCENT_DONE,
142            PERCENT_VERIFIED,
143            DATE_ACTIVITY,
144            DATE_ADDED,
145            DATE_STARTED,
146            DATE_CREATED,
147            PEERS_CONNECTED,
148            ETA,
149            RATIO,
150            DOWNLOADED_EVER,
151            UPLOADED_EVER,
152            FAILED_EVER,
153            TRACKERS,
154            TRACKERSTATS,
155            MIME_ICON,
156            SEED_RATIO_LIMIT,
157            SEED_RATIO_MODE,
158            SEED_IDLE_LIMIT,
159            SEED_IDLE_MODE,
160            DOWN_LIMIT,
161            DOWN_LIMITED,
162            UP_LIMIT,
163            UP_LIMITED,
164            HONORS_SESSION_LIMITS,
165            PEER_LIMIT,
166            HASH_STRING,
167            IS_FINISHED,
168            IS_PRIVATE,
169            COMMENT,
170            CREATOR,
171            MANUAL_ANNOUNCE_TIME,
172            PEERS,
173            TORRENT_FILE,
174            BANDWIDTH_PRIORITY,
175
176            PROPERTY_COUNT
177        };
178
179    public:
180        Torrent( Prefs&, int id );
181        virtual ~Torrent( );
182
183    signals:
184        void torrentChanged( int id );
185
186    private:
187
188        enum Group
189        {
190            INFO, // info fields that only need to be loaded once
191            STAT, // commonly-used stats that should be refreshed often
192            STAT_EXTRA,  // rarely used; only refresh if details dialog is open
193            DERIVED // doesn't come from RPC
194        };
195
196        struct Property
197        {
198            int id;
199            const char * key;
200            int type;
201            int group;
202        };
203
204        static Property myProperties[];
205
206        bool magnetTorrent;
207
208    public:
209        typedef QList<const char*> KeyList;
210        static const KeyList& getInfoKeys( );
211        static const KeyList& getStatKeys( );
212        static const KeyList& getExtraStatKeys( );
213
214    private:
215        static KeyList buildKeyList( Group group );
216
217    private:
218        QVariant myValues[PROPERTY_COUNT];
219
220        int getInt            ( int key ) const;
221        bool getBool          ( int key ) const;
222        QTime getTime         ( int key ) const;
223        QIcon getIcon         ( int key ) const;
224        double getDouble      ( int key ) const;
225        qulonglong getSize    ( int key ) const;
226        QString getString     ( int key ) const;
227        QDateTime getDateTime ( int key ) const;
228
229        bool setInt        ( int key, int value );
230        bool setBool       ( int key, bool value );
231        bool setIcon       ( int key, const QIcon& );
232        bool setDouble     ( int key, double );
233        bool setString     ( int key, const char * );
234        bool setSize       ( int key, qulonglong );
235        bool setDateTime   ( int key, const QDateTime& );
236
237    public:
238        int getBandwidthPriority( ) const { return getInt( BANDWIDTH_PRIORITY ); }
239        int id( ) const { return getInt( ID ); }
240        QString name( ) const { return getString( NAME ); }
241        QString creator( ) const { return getString( CREATOR ); }
242        QString comment( ) const { return getString( COMMENT ); }
243        QString getPath( ) const { return getString( DOWNLOAD_DIR ); }
244        QString getError( ) const;
245        QString hashString( ) const { return getString( HASH_STRING ); }
246        QString torrentFile( ) const { return getString( TORRENT_FILE ); }
247        bool hasError( ) const { return !getError( ).isEmpty( ); }
248        bool isDone( ) const { return getSize( LEFT_UNTIL_DONE ) == 0; }
249        bool isSeed( ) const { return haveVerified() >= totalSize(); }
250        bool isPrivate( ) const { return getBool( IS_PRIVATE ); }
251        bool getSeedRatio( double& setme ) const;
252        uint64_t haveVerified( ) const { return getSize( HAVE_VERIFIED ); }
253        uint64_t haveUnverified( ) const { return getSize( HAVE_UNCHECKED ); }
254        uint64_t desiredAvailable( ) const { return getSize( DESIRED_AVAILABLE ); }
255        uint64_t haveTotal( ) const { return haveVerified( ) + haveUnverified(); }
256        uint64_t totalSize( ) const { return getSize( TOTAL_SIZE ); }
257        uint64_t sizeWhenDone( ) const { return getSize( SIZE_WHEN_DONE ); }
258        uint64_t leftUntilDone( ) const { return getSize( LEFT_UNTIL_DONE ); }
259        uint64_t pieceSize( ) const { return getSize( PIECE_SIZE ); }
260        bool hasMetadata( ) const { return getDouble( METADATA_PERCENT_DONE ) >= 1.0; }
261        bool isMagnet( ) const { return magnetTorrent; }
262        int  pieceCount( ) const { return getInt( PIECE_COUNT ); }
263        double ratio( ) const { return getDouble( RATIO ); }
264        double percentComplete( ) const { return haveTotal() / (double)totalSize(); }
265        double percentDone( ) const { return getDouble( PERCENT_DONE ); }
266        double metadataPercentDone( ) const { return getDouble( METADATA_PERCENT_DONE ); }
267        uint64_t downloadedEver( ) const { return getSize( DOWNLOADED_EVER ); }
268        uint64_t uploadedEver( ) const { return getSize( UPLOADED_EVER ); }
269        uint64_t failedEver( ) const { return getSize( FAILED_EVER ); }
270        int compareTracker( const Torrent& ) const;
271        int compareRatio( const Torrent& ) const;
272        int compareETA( const Torrent& ) const;
273        bool hasETA( ) const { return getETA( ) >= 0; }
274        int getETA( ) const { return getInt( ETA ); }
275        QDateTime lastActivity( ) const { return getDateTime( DATE_ACTIVITY ); }
276        QDateTime lastStarted( ) const { return getDateTime( DATE_STARTED ); }
277        QDateTime dateAdded( ) const { return getDateTime( DATE_ADDED ); }
278        QDateTime dateCreated( ) const { return getDateTime( DATE_CREATED ); }
279        QDateTime manualAnnounceTime( ) const { return getDateTime( MANUAL_ANNOUNCE_TIME ); }
280        bool canManualAnnounce( ) const { return isReadyToTransfer() && (manualAnnounceTime()<=QDateTime::currentDateTime()); }
281        int peersWeAreDownloadingFrom( ) const { return getInt( PEERS_SENDING_TO_US ) + getInt( WEBSEEDS_SENDING_TO_US ); }
282        int peersWeAreUploadingTo( ) const { return getInt( PEERS_GETTING_FROM_US ); }
283        bool isUploading( ) const { return peersWeAreUploadingTo( ) > 0; }
284        int connectedPeers( ) const { return getInt( PEERS_CONNECTED ); }
285        int connectedPeersAndWebseeds( ) const { return connectedPeers( ) + getInt( WEBSEEDS_SENDING_TO_US ); }
286        Speed downloadSpeed( ) const { return Speed::fromKBps( getDouble( DOWNLOAD_SPEED ) ); }
287        Speed uploadSpeed( ) const { return Speed::fromKBps( getDouble( UPLOAD_SPEED ) ); }
288        double getVerifyProgress( ) const { return getDouble( PERCENT_VERIFIED ); }
289        bool hasFileSubstring( const QString& substr ) const;
290        bool hasTrackerSubstring( const QString& substr ) const;
291        Speed uploadLimit( ) const { return Speed::fromKBps( getInt( UP_LIMIT ) ); }
292        Speed downloadLimit( ) const { return Speed::fromKBps( getInt( DOWN_LIMIT ) ); }
293        bool uploadIsLimited( ) const { return getBool( UP_LIMITED ); }
294        bool downloadIsLimited( ) const { return getBool( DOWN_LIMITED ); }
295        bool honorsSessionLimits( ) const { return getBool( HONORS_SESSION_LIMITS ); }
296        int peerLimit( ) const { return getInt( PEER_LIMIT ); }
297        double seedRatioLimit( ) const { return getDouble( SEED_RATIO_LIMIT ); }
298        tr_ratiolimit seedRatioMode( ) const { return (tr_ratiolimit) getInt( SEED_RATIO_MODE ); }
299        int seedIdleLimit( ) const { return getInt( SEED_IDLE_LIMIT ); }
300        tr_idlelimit seedIdleMode( ) const { return (tr_idlelimit) getInt( SEED_IDLE_MODE ); }
301        TrackerStatsList trackerStats( ) const{ return myValues[TRACKERSTATS].value<TrackerStatsList>(); }
302        QStringList trackers() const { return myValues[TRACKERS].value<QStringList>(); }
303        PeerList peers( ) const{ return myValues[PEERS].value<PeerList>(); }
304        const FileList& files( ) const { return myFiles; }
305
306    public:
307        QString activityString( ) const;
308        tr_torrent_activity getActivity( ) const { return (tr_torrent_activity) getInt( ACTIVITY ); }
309        bool isFinished( ) const { return getBool( IS_FINISHED ); }
310        bool isPaused( ) const { return getActivity( ) == TR_STATUS_STOPPED; }
311        bool isWaitingToVerify( ) const { return getActivity( ) == TR_STATUS_CHECK_WAIT; }
312        bool isVerifying( ) const { return getActivity( ) == TR_STATUS_CHECK; }
313        bool isDownloading( ) const { return getActivity( ) == TR_STATUS_DOWNLOAD; }
314        bool isSeeding( ) const { return getActivity( ) == TR_STATUS_SEED; }
315        bool isReadyToTransfer( ) const { return getActivity()==TR_STATUS_DOWNLOAD || getActivity()==TR_STATUS_SEED; }
316        void notifyComplete( ) const;
317
318    public:
319        void update( tr_benc * dict );
320        void setMagnet( bool magnet ) { magnetTorrent = magnet; }
321
322    private:
323        const char * getMimeTypeString( ) const;
324        void updateMimeIcon( );
325
326    public:
327        QIcon getMimeTypeIcon( ) const { return getIcon( MIME_ICON ); }
328
329    private:
330        Prefs& myPrefs;
331        FileList myFiles;
332};
333
334Q_DECLARE_METATYPE(const Torrent*)
335
336#endif
337
Note: See TracBrowser for help on using the repository browser.