kget/core/transfer.h

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