Merge pull request #4994 from evsh/availability-column

Add availability column to torrent contents

src/base/bittorrent/torrenthandle.cpp

@@ -1953,3 +1953,24 @@ void TorrentHandle::prioritizeFiles(const QVector<int> &priorities)
 
     updateStatus();
 }
+
+QVector<qreal> TorrentHandle::availableFileFractions() const
+{
+    QVector<int> piecesAvailability = pieceAvailability();
+    const auto filesCount = this->filesCount();
+    // libtorrent returns empty array for seeding only torrents
+    if (piecesAvailability.empty()) return QVector<qreal>(filesCount, -1.);
+
+    QVector<qreal> res;
+    res.reserve(filesCount);
+    TorrentInfo info = this->info();
+    for (int file = 0; file < filesCount; ++file) {
+        TorrentInfo::PieceRange filePieces = info.filePieces(file);
+        int availablePieces = 0;
+        for (int piece = filePieces.first(); piece <= filePieces.last(); ++piece) {
+            availablePieces += piecesAvailability[piece] > 0 ? 1 : 0;
+        }
+        res.push_back(static_cast<qreal>(availablePieces) / filePieces.size());
+    }
+    return res;
+}

src/base/bittorrent/torrenthandle.h

@@ -361,6 +361,14 @@ namespace BitTorrent
         void handleAppendExtensionToggled();
         void saveResumeData(bool updateStatus = false);
 
+        /**
+         * @brief fraction of file pieces that are available at least from one peer
+         *
+         * This is not the same as torrrent availability, it is just a fraction of pieces
+         * that can be downloaded right now. It varies between 0 to 1.
+         */
+        QVector<qreal> availableFileFractions() const;
+
     private:
         typedef boost::function<void ()> EventTrigger;
 

src/base/unicodestrings.h

@@ -39,6 +39,7 @@ const char C_NON_BREAKING_SPACE[] = " ";
 const char C_UP[] = "▲";
 const char C_DOWN[] = "▼";
 const char C_COPYRIGHT[] = "©";
+const char C_THIN_SPACE[] = " ";
 const char C_UTP[] = "μTP";
 const char C_LOCALE_ENGLISH[] = "English";
 const char C_LOCALE_ENGLISH_AUSTRALIA[] = "English(Australia)";

src/gui/addnewtorrentdialog.cpp

@@ -737,6 +737,7 @@ void AddNewTorrentDialog::setupTreeview()
         // Hide useless columns after loading the header state
         ui->contentTreeView->hideColumn(PROGRESS);
         ui->contentTreeView->hideColumn(REMAINING);
+        ui->contentTreeView->hideColumn(AVAILABILITY);
 
         // Expand root folder
         ui->contentTreeView->setExpanded(m_contentModel->index(0, 0), true);

src/gui/properties/propertieswidget.cpp

@@ -493,6 +493,7 @@ void PropertiesWidget::loadDynamicData()
             qDebug("Updating priorities in files tab");
             m_ui->filesList->setUpdatesEnabled(false);
             PropListModel->model()->updateFilesProgress(m_torrent->filesProgress());
+            PropListModel->model()->updateFilesAvailability(m_torrent->availableFileFractions());
             // XXX: We don't update file priorities regularly for performance
             // reasons. This means that priorities will not be updated if
             // set from the Web UI.

src/gui/properties/proplistdelegate.cpp

@@ -42,6 +42,7 @@
 #include <QProxyStyle>
 #endif
 
+#include "base/unicodestrings.h"
 #include "base/utils/misc.h"
 #include "base/utils/string.h"
 #include "propertieswidget.h"
@@ -131,6 +132,19 @@ void PropListDelegate::paint(QPainter *painter, const QStyleOptionViewItem &opti
         QItemDelegate::drawDisplay(painter, opt, option.rect, text);
         }
         break;
+    case AVAILABILITY: {
+            const qreal availability = index.data().toDouble();
+            if (availability < 0) {
+                QItemDelegate::drawDisplay(painter, opt, option.rect, tr("N/A"));
+            }
+            else {
+                const QString value = (availability >= 1.0)
+                                        ? QLatin1String("100")
+                                        : Utils::String::fromDouble(availability * 100., 1);
+                QItemDelegate::drawDisplay(painter, opt, option.rect, value + C_THIN_SPACE + QLatin1Char('%'));
+            }
+        }
+        break;
     default:
         QItemDelegate::paint(painter, option, index);
         break;

src/gui/properties/proplistdelegate.h

@@ -46,7 +46,8 @@ enum PropColumn
     PCSIZE,
     PROGRESS,
     PRIORITY,
-    REMAINING
+    REMAINING,
+    AVAILABILITY
 };
 
 class PropListDelegate: public QItemDelegate
@@ -72,3 +73,4 @@ private:
 };
 
 #endif
+

src/gui/torrentcontentmodel.cpp

@@ -56,7 +56,7 @@ namespace
 
 TorrentContentModel::TorrentContentModel(QObject *parent)
     : QAbstractItemModel(parent)
-    , m_rootItem(new TorrentContentModelFolder(QList<QVariant>({ tr("Name"), tr("Size"), tr("Progress"), tr("Download Priority"), tr("Remaining") })))
+    , m_rootItem(new TorrentContentModelFolder(QList<QVariant>({ tr("Name"), tr("Size"), tr("Progress"), tr("Download Priority"), tr("Remaining"), tr("Availability") })))
 {
 }
 
@@ -76,6 +76,7 @@ void TorrentContentModel::updateFilesProgress(const QVector<qreal> &fp)
         m_filesIndex[i]->setProgress(fp[i]);
     // Update folders progress in the tree
     m_rootItem->recalculateProgress();
+    m_rootItem->recalculateAvailability();
     emit dataChanged(index(0, 0), index(rowCount(), columnCount()));
 }
 
@@ -92,6 +93,20 @@ void TorrentContentModel::updateFilesPriorities(const QVector<int> &fprio)
     emit dataChanged(index(0, 0), index(rowCount(), columnCount()));
 }
 
+void TorrentContentModel::updateFilesAvailability(const QVector<qreal> &fa)
+{
+    Q_ASSERT(m_filesIndex.size() == fa.size());
+    // XXX: Why is this necessary?
+    if (m_filesIndex.size() != fa.size()) return;
+
+    emit layoutAboutToBeChanged();
+    for (int i = 0; i < fa.size(); ++i)
+        m_filesIndex[i]->setAvailability(fa[i]);
+    // Update folders progress in the tree
+    m_rootItem->recalculateProgress();
+    emit dataChanged(index(0, 0), index(rowCount(), columnCount()));
+}
+
 QVector<int> TorrentContentModel::getFilePriorities() const
 {
     QVector<int> prio;
@@ -134,6 +149,7 @@ bool TorrentContentModel::setData(const QModelIndex& index, const QVariant& valu
                 item->setPriority(prio::NORMAL);
             // Update folders progress in the tree
             m_rootItem->recalculateProgress();
+            m_rootItem->recalculateAvailability();
             emit dataChanged(this->index(0, 0), this->index(rowCount() - 1, columnCount() - 1));
             emit filteredFilesChanged();
         }

src/gui/torrentcontentmodel.h

@@ -41,7 +41,8 @@
 
 class TorrentContentModelFile;
 
-class TorrentContentModel:  public QAbstractItemModel {
+class TorrentContentModel: public QAbstractItemModel
+{
     Q_OBJECT
 
 public:
@@ -50,6 +51,7 @@ public:
 
     void updateFilesProgress(const QVector<qreal> &fp);
     void updateFilesPriorities(const QVector<int> &fprio);
+    void updateFilesAvailability(const QVector<qreal> &fa);
     QVector<int> getFilePriorities() const;
     bool allFiltered() const;
     virtual int columnCount(const QModelIndex &parent = QModelIndex()) const;

src/gui/torrentcontentmodelfile.cpp

@@ -32,9 +32,9 @@
 #include "torrentcontentmodelfolder.h"
 
 TorrentContentModelFile::TorrentContentModelFile(const QString &fileName, qulonglong fileSize,
-                                                 TorrentContentModelFolder* parent, int file_index)
+                                                 TorrentContentModelFolder *parent, int fileIndex)
     : TorrentContentModelItem(parent)
-  , m_fileIndex(file_index)
+    , m_fileIndex(fileIndex)
 {
     Q_ASSERT(parent);
 
@@ -52,23 +52,34 @@ int TorrentContentModelFile::fileIndex() const
     return m_fileIndex;
 }
 
-void TorrentContentModelFile::setPriority(int new_prio, bool update_parent)
+void TorrentContentModelFile::setPriority(int newPriority, bool updateParent)
 {
-  Q_ASSERT(new_prio != prio::MIXED);
+    Q_ASSERT(newPriority != prio::MIXED);
 
-  if (m_priority == new_prio)
+    if (m_priority == newPriority)
         return;
 
-  m_priority = new_prio;
+    m_priority = newPriority;
 
     // Update parent
-  if (update_parent)
+    if (updateParent)
         m_parentItem->updatePriority();
 }
 
 void TorrentContentModelFile::setProgress(qreal progress)
 {
     m_progress = progress;
-  m_remaining = (qulonglong)(m_size * (1.0 - m_progress));
+    m_remaining = static_cast<qulonglong>(m_size * (1.0 - m_progress));
     Q_ASSERT(m_progress <= 1.);
 }
+
+void TorrentContentModelFile::setAvailability(qreal availability)
+{
+    m_availability = availability;
+    Q_ASSERT(m_availability <= 1.);
+}
+
+TorrentContentModelItem::ItemType TorrentContentModelFile::itemType() const
+{
+    return FileType;
+}

src/gui/torrentcontentmodelfile.h

@@ -37,12 +37,13 @@ class TorrentContentModelFile : public TorrentContentModelItem
 {
 public:
     TorrentContentModelFile(const QString &fileName, qulonglong fileSize,
-                          TorrentContentModelFolder* parent, int file_index);
+                            TorrentContentModelFolder *parent, int fileIndex);
 
     int fileIndex() const;
-  void setPriority(int new_prio, bool update_parent = true);
+    void setPriority(int newPriority, bool updateParent = true) override;
     void setProgress(qreal progress);
-  ItemType itemType() const { return FileType; }
+    void setAvailability(qreal availability);
+    ItemType itemType() const override;
 
 private:
     int m_fileIndex;

src/gui/torrentcontentmodelfolder.cpp

@@ -53,6 +53,11 @@ TorrentContentModelFolder::~TorrentContentModelFolder()
     qDeleteAll(m_childItems);
 }
 
+TorrentContentModelItem::ItemType TorrentContentModelFolder::itemType() const
+{
+    return FolderType;
+}
+
 void TorrentContentModelFolder::deleteAllChildren()
 {
     Q_ASSERT(isRootItem());
@@ -81,10 +86,9 @@ TorrentContentModelItem* TorrentContentModelFolder::child(int row) const
 
 TorrentContentModelFolder *TorrentContentModelFolder::childFolderWithName(const QString &name) const
 {
-  foreach (TorrentContentModelItem* child, m_childItems) {
-    if (child->itemType() == FolderType && child->name() == name)
+    foreach (TorrentContentModelItem *child, m_childItems)
+        if ((child->itemType() == FolderType) && (child->name() == name))
             return static_cast<TorrentContentModelFolder *>(child);
-  }
     return 0;
 }
 
@@ -116,23 +120,22 @@ void TorrentContentModelFolder::updatePriority()
     setPriority(prio);
 }
 
-void TorrentContentModelFolder::setPriority(int new_prio, bool update_parent)
+void TorrentContentModelFolder::setPriority(int newPriority, bool updateParent)
 {
-  if (m_priority == new_prio)
+    if (m_priority == newPriority)
         return;
 
-  m_priority = new_prio;
+    m_priority = newPriority;
 
     // Update parent priority
-  if (update_parent)
+    if (updateParent)
         m_parentItem->updatePriority();
 
     // Update children
-  if (m_priority != prio::MIXED) {
+    if (m_priority != prio::MIXED)
         foreach (TorrentContentModelItem *child, m_childItems)
             child->setPriority(m_priority, false);
 }
-}
 
 void TorrentContentModelFolder::recalculateProgress()
 {
@@ -149,13 +152,41 @@ void TorrentContentModelFolder::recalculateProgress()
         }
     }
 
-  if (!isRootItem() && tSize > 0) {
+    if (!isRootItem() && (tSize > 0)) {
         m_progress = tProgress / tSize;
         m_remaining = tRemaining;
         Q_ASSERT(m_progress <= 1.);
     }
 }
 
+void TorrentContentModelFolder::recalculateAvailability()
+{
+    qreal tAvailability = 0;
+    qulonglong tSize = 0;
+    bool foundAnyData = false;
+    foreach (TorrentContentModelItem* child, m_childItems) {
+        if (child->priority() == prio::IGNORED)
+            continue;
+
+        if (child->itemType() == FolderType)
+            static_cast<TorrentContentModelFolder*>(child)->recalculateAvailability();
+        const qreal childAvailability = child->availability();
+        if (childAvailability >= 0) { // -1 means "no data"
+            tAvailability += childAvailability * child->size();
+            foundAnyData = true;
+        }
+        tSize += child->size();
+    }
+
+    if (!isRootItem() && (tSize > 0) && foundAnyData) {
+        m_availability = tAvailability / tSize;
+        Q_ASSERT(m_availability <= 1.);
+    }
+    else {
+        m_availability = -1.;
+    }
+}
+
 void TorrentContentModelFolder::increaseSize(qulonglong delta)
 {
     if (isRootItem())

src/gui/torrentcontentmodelfolder.h

@@ -44,13 +44,14 @@ public:
 
     ~TorrentContentModelFolder();
 
-  ItemType itemType() const { return FolderType; }
+    ItemType itemType() const override;
 
     void increaseSize(qulonglong delta);
     void recalculateProgress();
+    void recalculateAvailability();
     void updatePriority();
 
-  void setPriority(int new_prio, bool update_parent = true);
+    void setPriority(int newPriority, bool updateParent = true) override;
 
     void deleteAllChildren();
     const QList<TorrentContentModelItem*>& children() const;

src/gui/torrentcontentmodelitem.cpp

@@ -40,11 +40,15 @@ TorrentContentModelItem::TorrentContentModelItem(TorrentContentModelFolder* pare
     , m_remaining(0)
     , m_priority(prio::NORMAL)
     , m_progress(0)
+    , m_availability(-1.)
 {
 }
 
-TorrentContentModelItem::~TorrentContentModelItem()
+TorrentContentModelItem::~TorrentContentModelItem() = default;
+
+bool TorrentContentModelItem::isRootItem() const
 {
+    return !m_parentItem;
 }
 
 QString TorrentContentModelItem::name() const
@@ -81,6 +85,13 @@ qulonglong TorrentContentModelItem::remaining() const
     return m_remaining;
 }
 
+qreal TorrentContentModelItem::availability() const
+{
+    Q_ASSERT(!isRootItem());
+
+    return m_size > 0 ? m_availability : 0.;
+}
+
 int TorrentContentModelItem::priority() const
 {
     Q_ASSERT(!isRootItem());
@@ -108,6 +119,8 @@ QVariant TorrentContentModelItem::data(int column) const
         return m_size;
     case COL_REMAINING:
         return remaining();
+    case COL_AVAILABILITY:
+        return availability();
     default:
         Q_ASSERT(false);
         return QVariant();
@@ -125,3 +138,4 @@ TorrentContentModelFolder* TorrentContentModelItem::parent() const
 {
     return m_parentItem;
 }
+

src/gui/torrentcontentmodelitem.h

@@ -34,21 +34,44 @@
 #include <QList>
 #include <QVariant>
 
-namespace prio {
-enum FilePriority {IGNORED=0, NORMAL=1, HIGH=6, MAXIMUM=7, MIXED=-1};
+namespace prio
+{
+    enum FilePriority
+    {
+        IGNORED=0,
+        NORMAL=1,
+        HIGH=6,
+        MAXIMUM=7,
+        MIXED=-1
+    };
 }
 
 class TorrentContentModelFolder;
 
-class TorrentContentModelItem {
+class TorrentContentModelItem
+{
 public:
-  enum TreeItemColumns {COL_NAME, COL_SIZE, COL_PROGRESS, COL_PRIO, COL_REMAINING, NB_COL};
-  enum ItemType { FileType, FolderType };
+    enum TreeItemColumns
+    {
+        COL_NAME,
+        COL_SIZE,
+        COL_PROGRESS,
+        COL_PRIO,
+        COL_REMAINING,
+        COL_AVAILABILITY,
+        NB_COL
+    };
+
+    enum ItemType
+    {
+        FileType,
+        FolderType
+    };
 
     TorrentContentModelItem(TorrentContentModelFolder *parent);
     virtual ~TorrentContentModelItem();
 
-  inline bool isRootItem() const { return !m_parentItem; }
+    bool isRootItem() const;
     TorrentContentModelFolder *parent() const;
     virtual ItemType itemType() const = 0;
 
@@ -59,8 +82,10 @@ public:
     qreal progress() const;
     qulonglong remaining() const;
 
+    qreal availability() const;
+
     int priority() const;
-  virtual void setPriority(int new_prio, bool update_parent = true) = 0;
+    virtual void setPriority(int newPriority, bool updateParent = true) = 0;
 
     int columnCount() const;
     QVariant data(int column) const;
@@ -76,6 +101,7 @@ protected:
     qulonglong m_remaining;
     int m_priority;
     qreal m_progress;
+    qreal m_availability;
 };
 
 #endif // TORRENTCONTENTMODELITEM_H