kget/core/transfergroup.h

   1 /* This file is part of the KDE project
   2
   3    Copyright (C) 2005 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
  12 #ifndef GROUP_H
  13 #define GROUP_H
  14
  15 #include <kio/netaccess.h>
  16 #include <KIcon>
  17 #include <KDebug>
  18
  19 #include "jobqueue.h"
  20 #include "kget_export.h"
  21 #include "transfer.h"
  22
  23 class QDomElement;
  24
  25 class TransferGroupHandler;
  26 class TransferTreeModel;
  27
  28 /**
  29  * class TransferGroup:
  30  *
  31  * This class abstracts the concept of transfer group by means of which
  32  * the user can sort his transfers into categories.
  33  * By definition, we want each TransferGroup (transfer group) to be a JobQueue.
  34  * Moreover this class calculates information such as:
  35  * - the size obtained by the sum of all the transfer's size
  36  * - the size obtained by the sum of all the transfer's processed size
  37  * - the global progress percentage within the group
  38  * - the global speed within the group
  39  */
  40 class KGET_EXPORT TransferGroup : public JobQueue
  41 {
  42     public:
  43         enum GroupChange
  44         {
  45             Gc_None                = 0x00000000,
  46             // These flags respect the Model columns order
  47             Gc_GroupName           = 0x00000001,
  48             Gc_Status              = 0x00000002,
  49             Gc_TotalSize           = 0x00000004,
  50             Gc_Percent             = 0x00000008,
  51             Gc_UploadSpeed         = 0x00000010,
  52             Gc_DownloadSpeed       = 0x00000020,
  53             // Misc
  54             Gc_ProcessedSize       = 0x00010000
  55         };
  56
  57         typedef int ChangesFlags;
  58
  59         TransferGroup(TransferTreeModel * model, Scheduler * scheduler, const QString & name=QString());
  60
  61         virtual ~TransferGroup();
  62
  63         /**
  64          * This function is reimplemented by JobQueue::setStatus
  65          *
  66          * @param queueStatus the new JobQueue status
  67          */
  68         void setStatus(Status queueStatus);
  69
  70         /**
  71          * Appends a new transfer to the list of the transfers
  72          *
  73          * @param transfer the transfer to append
  74          */
  75         void append(Transfer * transfer);
  76
  77         /**
  78          * Prepends a new transfer to the list of the transfers
  79          *
  80          * @param transfer the transfer to prepend
  81          */
  82         void prepend(Transfer * transfer);
  83
  84         /**
  85          * inserts a transfer to the current group after the given transfer
  86          *
  87          * @param transfer The transfer to add in the current Group
  88          * @param after The transfer after which to add the transfer
  89          */
  90         void insert(Transfer * transfer, Transfer * after);
  91
  92         /**
  93          * Removes the given transfer from the list of the transfers
  94          *
  95          * @param transfer the transfer to remove
  96          */
  97         void remove(Transfer * transfer);
  98
  99         /**
 100          * Moves a transfer in the list
 101          *
 102          * @param transfer The transfer to move. Note that this transfer can
 103          *                  belong to other groups. In this situation this
 104          *                  transfer is deleted from the previous group and
 105          *                  moved inside this one.
 106          * @param after The transfer after which we have to move the given one
 107          */
 108         void move(Transfer * transfer, Transfer * after);
 109
 110         /**
 111          * Finds the first transfer with source src
 112          *
 113          * @param src the url of the source location
 114          *
 115          * @return the transfer pointer if the transfer has been found. Otherwise
 116          * it returns 0
 117          */
 118         Transfer * findTransfer(const KUrl &src);
 119
 120         /**
 121          * Finds the first transfer with destination dest
 122          *
 123          * @param dest the url of the destination location
 124          *
 125          * @return the transfer pointer if the transfer has been found, else return 0
 126          */
 127          Transfer *findTransferByDestination(const KUrl &dest);
 128
 129         /**
 130          * @returns the Job in the queue at the given index i
 131          */
 132         Transfer * operator[] (int i) const;
 133
 134         /**Set the group name
 135          * @param name group name
 136          */
 137         void  setName(const QString &name)    {m_name=name;}
 138
 139         /**
 140          * @return the group name
 141          */
 142         const QString & name()    {return m_name;}
 143
 144         /**
 145          * @return the sum of the sizes of the transfers belonging to
 146          * this group
 147          */
 148         int totalSize() const     {return m_totalSize;}
 149
 150         /**
 151          * @return the sum of the downloaded sizes of the transfers
 152          * belonging to this group
 153          */
 154         int downloadedSize() const {return m_downloadedSize;}
 155
 156         /**
 157          * @return the sum of the uploaded sizes of the transfers
 158          * belonging to this group
 159          */
 160         int uploadedSize() const {return m_uploadedSize;}
 161
 162         /**
 163          * @return the progress percentage
 164          */
 165         int percent() const       {return m_percent;}
 166
 167         /**
 168          * @return the sum of the download speeds of the running transfers
 169          * belonging this group
 170          */
 171         int downloadSpeed();
 172
 173         /**
 174          * @return the sum of the download speeds of the running transfers
 175          * belonging this group
 176          */
 177         int uploadSpeed();
 178
 179         /**
 180          * Set a default Folder for the group
 181          * @param folder the new default folder
 182          */
 183         void setDefaultFolder(QString folder) {m_defaultFolder = folder;}
 184
 185         /**
 186          * @return the groups default folder
 187          */
 188         QString defaultFolder() {return m_defaultFolder;}
 189
 190         /**
 191          * @return true if the group supports SpeedLimits
 192          */
 193         bool supportsSpeedLimits();
 194
 195         /**
 196          * Set a Download-Limit for the group
 197          * @param limit the new download-limit
 198          * @note if limit is 0, no download-limit is set
 199          */
 200         void setDownloadLimit(int dlLimit, Transfer::SpeedLimit limit);
 201
 202         /**
 203          * @return the group's Download-Limit
 204          */
 205         int downloadLimit(Transfer::SpeedLimit limit) const;
 206
 207         /**
 208          * Set a Upload-Limit for the group
 209          * @param limit the new upload-limit
 210          * @note if limit is 0, no upload-limit is set
 211          */
 212         void setUploadLimit(int ulLimit, Transfer::SpeedLimit limit);
 213
 214         /**
 215          * @return the group's Upload-Limit
 216          */
 217         int uploadLimit(Transfer::SpeedLimit limit) const;
 218
 219         /**
 220          * Set the group's icon
 221          * @param name the icon's name
 222          */
 223         void setIconName(QString name) {m_iconName = name;}
 224
 225         /**
 226          * @return the group's icon
 227          */
 228         QPixmap pixmap() {return KIcon(m_iconName).pixmap(32);}
 229
 230         /**
 231          * @return the handler associated with this group
 232          */
 233         TransferGroupHandler * handler() const;
 234
 235         /**
 236          * @returns the TransferTreeModel that owns this group
 237          */
 238         TransferTreeModel * model()     {return m_model;}
 239
 240         /**
 241          * Calculates the whole SpeedLimits
 242          */
 243         void calculateSpeedLimits();
 244
 245         /**
 246          * Calculates the DownloadLimits
 247          */
 248         void calculateDownloadLimit();
 249
 250         /**
 251          * Calculates the DownloadLimits
 252          */
 253         void calculateUploadLimit();
 254
 255         /**
 256          * Notifies that the given transfer has changed
 257          *
 258          * @param transfer The transfer that has changed
 259          */
 260         void transferChangedEvent(Transfer * transfer);
 261
 262         /**
 263          * Saves this group object to the given QDomNode
 264          *
 265          * @param n The QDomNode where the group will be saved
 266          */
 267         void save(QDomElement e);
 268
 269         /**
 270          * Adds all the groups in the given QDomNode * to the group
 271          *
 272          * @param n The QDomNode where the group will look for the transfers to add
 273          */
 274         void load(const QDomElement & e);
 275
 276     private:
 277         TransferTreeModel * m_model;
 278         TransferGroupHandler * m_handler;
 279
 280         //TransferGroup info
 281         QString m_name;
 282         int m_totalSize;
 283         int m_downloadedSize;
 284         int m_uploadedSize;
 285         int m_percent;
 286         int m_downloadSpeed;
 287         int m_uploadSpeed;
 288         int m_downloadLimit;
 289         int m_uploadLimit;
 290         int m_visibleDownloadLimit;
 291         int m_visibleUploadLimit;
 292         QString m_iconName;
 293         QString m_defaultFolder;
 294 };
 295
 296 #endif