kget/core/transfer.h

   1 /* This file is part of the KDE project
   2
   3    Copyright (C) 2004 Dario Massarin <nekkar@libero.it>
   4
   5    This program is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU General Public
   7    License as published by the Free Software Foundation; either
   8    version 2 of the License, or (at your option) any later version.
   9 */
  10
  11 #ifndef TRANSFER_H
  12 #define TRANSFER_H
  13
  14 #include "job.h"
  15 #include "kget_export.h"
  16
  17 #include <QPixmap>
  18
  19 #include <kurl.h>
  20 #include <kio/global.h>
  21
  22 class QDomElement;
  23
  24 class TransferHandler;
  25 class TransferFactory;
  26 class TransferGroup;
  27 class Scheduler;
  28 class TransferTreeModel;
  29
  30 class KGET_EXPORT Transfer : public Job
  31 {
  32     friend class TransferHandler;
  33     friend class TransferTreeModel;
  34
  35     public:
  36
  37         /**
  38          * Here we define the flags that should be shared by all the transfers.
  39          * A transfer should also be able to define additional flags, in the future.
  40          */
  41         enum TransferChange
  42         {
  43             Tc_None           = 0x00000000,
  44             // These flags respect the Model columns order
  45             Tc_FileName       = 0x00000001,
  46             Tc_Status         = 0x00000002,
  47             Tc_TotalSize      = 0x00000004,
  48             Tc_Percent        = 0x00000008,
  49             Tc_DownloadSpeed  = 0x00000010,
  50             Tc_UploadSpeed    = 0x00000016,
  51             // Misc
  52             Tc_UploadLimit    = 0x00000100,
  53             Tc_DownloadLimit  = 0x00000200,
  54             Tc_CanResume      = 0x00000400,
  55             Tc_DownloadedSize = 0x00000800,
  56             Tc_UploadedSize   = 0x00001000,
  57             Tc_Log            = 0x00002000,
  58             Tc_Group          = 0x00004000,
  59             Tc_Selection      = 0x00006000
  60         };
  61
  62         enum LogLevel
  63         {
  64             info,
  65             warning,
  66             error
  67         };
  68         typedef int ChangesFlags;
  69
  70         Transfer(TransferGroup * parent, TransferFactory * factory,
  71                  Scheduler * scheduler, const KUrl & src, const KUrl & dest,
  72                  const QDomElement * e = 0);
  73
  74         virtual ~Transfer();
  75
  76         const KUrl & source() const            {return m_source;}
  77         const KUrl & dest() const              {return m_dest;}
  78
  79         //Transfer status
  80         KIO::filesize_t totalSize() const      {return m_totalSize;}
  81         KIO::filesize_t downloadedSize() const {return m_downloadedSize;}
  82         KIO::filesize_t uploadedSize() const   {return m_uploadedSize;}
  83         QString statusText() const             {return m_statusText;}
  84         QPixmap statusPixmap() const           {return m_statusPixmap;}
  85
  86         int percent() const                    {return m_percent;}
  87         int downloadSpeed() const              {return m_downloadSpeed;}
  88         int uploadSpeed() const                {return m_uploadSpeed;}
  89
  90         virtual bool supportsSpeedLimits() const {return false;}
  91
  92         /**
  93          * Set the Transfer's UploadLimit
  94          * @note this is not displayed in any GUI, use setVisibleUploadLimit(int) instead
  95          * @param visibleUlLimit upload Limit
  96          */
  97         virtual void setUploadLimit(int ulLimit) {Q_UNUSED(ulLimit);}
  98
  99         /**
 100          * Set the Transfer's UploadLimit, which are displayed in the GUI
 101          * @note this is not displayed in any GUI, use setVisibleDownloadLimit(int) instead
 102          * @param visibleUlLimit upload Limit
 103          */
 104         virtual void setDownloadLimit(int dlLimit) {Q_UNUSED(dlLimit);}
 105
 106         /**
 107          * @return the UploadLimit, which is invisible in the GUI
 108          */
 109         int uploadLimit() const {return m_ulLimit;}
 110
 111         /**
 112          * @return the DownloadLimit, which is invisible in the GUI
 113          */
 114         int downloadLimit() const {return m_dlLimit;}
 115
 116         /**
 117          * Set the Transfer's UploadLimit, which are displayed in the GUI
 118          * @note use this, when a user changes the UploadLimit manually
 119          * @param visibleUlLimit upload Limit
 120          */
 121         void setVisibleUploadLimit(int visibleUlLimit);
 122
 123         /**
 124          * Set the Transfer's UploadLimit, which are displayed in the GUI
 125          * @note use this, when a user changes the UploadLimit manually
 126          * @param visibleUlLimit upload Limit
 127          */
 128         void setVisibleDownloadLimit(int visibleDlLimit);
 129
 130         /**
 131          * @return the visible UploadLimit
 132          */
 133         int visibleUploadLimit() const {return m_visibleUlLimit;}
 134
 135         /**
 136          * @return the visible DownloadLimit
 137          */
 138         int visibleDownloadLimit() const {return m_visibleDlLimit;}
 139
 140         /**
 141          * Set the maximum share-ratio
 142          * @param ratio the new maximum share-ratio
 143          */
 144         void setMaximumShareRatio(double ratio);
 145
 146         /**
 147          * @return the maximum share-ratio
 148          */
 149         double maximumShareRatio() {return m_ratio;}
 150
 151         /**
 152          * Recalculate the share ratio
 153          */
 154         void checkShareRatio();
 155
 156         // --- Job virtual functions ---
 157         virtual void setDelay(int seconds);
 158         virtual void delayTimerEvent();
 159
 160
 161         bool isSelected() const             {return m_isSelected;}
 162
 163         /**
 164          * Transfer history
 165          */
 166         const QStringList log() const;
 167
 168         /**
 169          * Set Transfer history
 170          */
 171          void setLog(const QString& message, LogLevel level = info);
 172
 173         /**
 174          * Defines the order between transfers
 175          */
 176         bool operator<(const Transfer& t2) const;
 177
 178         /**
 179          * The owner group
 180          */
 181         TransferGroup * group() const   {return (TransferGroup *) m_jobQueue;}
 182
 183         /**
 184          * @return the associated TransferHandler
 185          */
 186         TransferHandler * handler();
 187
 188         /**
 189          * @returns the TransferTreeModel that owns this group
 190          */
 191         TransferTreeModel * model();
 192
 193         /**
 194          * @returns a pointer to the TransferFactory object
 195          */
 196         TransferFactory * factory() const   {return m_factory;}
 197
 198         /**
 199          * Saves this transfer to the given QDomNode
 200          *
 201          * @param n The pointer to the QDomNode where the transfer will be saved
 202          * @return  The created QDomElement
 203          */
 204         virtual void save(const QDomElement &element);
 205
 206     protected:
 207         //Function used to load and save the transfer's info from xml
 208         virtual void load(const QDomElement &e);
 209
 210         /**
 211          * Sets the Job status to jobStatus, the status text to text and
 212          * the status pixmap to pix.
 213          */
 214         void setStatus(Job::Status jobStatus, const QString &text, const QPixmap &pix);
 215
 216         /**
 217          * Makes the TransferHandler associated with this transfer know that
 218          * a change in this transfer has occurred.
 219          *
 220          * @param change: the TransferChange flags to be set
 221          */
 222         virtual void setTransferChange(ChangesFlags change, bool postEvent=false);
 223
 224         // --- Transfer information ---
 225         KUrl m_source;
 226         KUrl m_dest;
 227
 228         QStringList   m_log;
 229         KIO::filesize_t m_totalSize;
 230         KIO::filesize_t m_downloadedSize;
 231         KIO::filesize_t m_uploadedSize;
 232         int           m_percent;
 233         int           m_downloadSpeed;
 234         int           m_uploadSpeed;
 235
 236         int           m_ulLimit;
 237         int           m_dlLimit;
 238
 239         bool m_isSelected;
 240
 241     private:
 242         int m_visibleUlLimit;
 243         int m_visibleDlLimit;
 244         double m_ratio;
 245
 246         QString m_statusText;
 247         QPixmap m_statusPixmap;
 248
 249         TransferHandler * m_handler;
 250         TransferFactory * m_factory;
 251 };
 252
 253 #endif