src/gui/trackerlist/trackerlistwidget.cpp

   1 /*
   2  * Bittorrent Client using Qt and libtorrent.
   3  * Copyright (C) 2023  Vladimir Golovnev <glassez@yandex.ru>
   4  * Copyright (C) 2006  Christophe Dumez <chris@qbittorrent.org>
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version 2
   9  * of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  *
  20  * In addition, as a special exception, the copyright holders give permission to
  21  * link this program with the OpenSSL project's "OpenSSL" library (or with
  22  * modified versions of it that use the same license as the "OpenSSL" library),
  23  * and distribute the linked executables. You must obey the GNU General Public
  24  * License in all respects for all of the code used other than "OpenSSL".  If you
  25  * modify file(s), you may extend this exception to your version of the file(s),
  26  * but you are not obligated to do so. If you do not wish to do so, delete this
  27  * exception statement from your version.
  28  */
  29
  30 #include "trackerlistwidget.h"
  31
  32 #include <QAction>
  33 #include <QApplication>
  34 #include <QClipboard>
  35 #include <QColor>
  36 #include <QDebug>
  37 #include <QHeaderView>
  38 #include <QList>
  39 #include <QLocale>
  40 #include <QMenu>
  41 #include <QMessageBox>
  42 #include <QShortcut>
  43 #include <QStringList>
  44 #include <QTreeWidgetItem>
  45 #include <QUrl>
  46 #include <QWheelEvent>
  47
  48 #include "base/bittorrent/session.h"
  49 #include "base/bittorrent/torrent.h"
  50 #include "base/bittorrent/trackerentrystatus.h"
  51 #include "base/global.h"
  52 #include "base/preferences.h"
  53 #include "gui/autoexpandabledialog.h"
  54 #include "gui/trackersadditiondialog.h"
  55 #include "gui/uithememanager.h"
  56 #include "trackerlistitemdelegate.h"
  57 #include "trackerlistmodel.h"
  58 #include "trackerlistsortmodel.h"
  59
  60 TrackerListWidget::TrackerListWidget(QWidget *parent)
  61     : QTreeView(parent)
  62 {
  63 #ifdef QBT_USES_LIBTORRENT2
  64     setColumnHidden(TrackerListModel::COL_PROTOCOL, true); // Must be set before calling loadSettings()
  65 #endif
  66
  67     setExpandsOnDoubleClick(false);
  68     setAllColumnsShowFocus(true);
  69     setSelectionMode(QAbstractItemView::ExtendedSelection);
  70     setSortingEnabled(true);
  71     setUniformRowHeights(true);
  72     setContextMenuPolicy(Qt::CustomContextMenu);
  73
  74     header()->setSortIndicator(0, Qt::AscendingOrder);
  75     header()->setFirstSectionMovable(true);
  76     header()->setStretchLastSection(false); // Must be set after loadSettings() in order to work
  77     header()->setTextElideMode(Qt::ElideRight);
  78     header()->setContextMenuPolicy(Qt::CustomContextMenu);
  79
  80     m_model = new TrackerListModel(BitTorrent::Session::instance(), this);
  81     auto *sortModel = new TrackerListSortModel(m_model, this);
  82     QTreeView::setModel(sortModel);
  83
  84     setItemDelegate(new TrackerListItemDelegate(this));
  85
  86     loadSettings();
  87
  88     // Ensure that at least one column is visible at all times
  89     if (visibleColumnsCount() == 0)
  90         setColumnHidden(TrackerListModel::COL_URL, false);
  91     // To also mitigate the above issue, we have to resize each column when
  92     // its size is 0, because explicitly 'showing' the column isn't enough
  93     // in the above scenario.
  94     for (int i = 0; i < TrackerListModel::COL_COUNT; ++i)
  95     {
  96         if ((columnWidth(i) <= 0) && !isColumnHidden(i))
  97             resizeColumnToContents(i);
  98     }
  99
 100     connect(this, &QWidget::customContextMenuRequested, this, &TrackerListWidget::showTrackerListMenu);
 101     connect(header(), &QWidget::customContextMenuRequested, this, &TrackerListWidget::displayColumnHeaderMenu);
 102     connect(header(), &QHeaderView::sectionMoved, this, &TrackerListWidget::saveSettings);
 103     connect(header(), &QHeaderView::sectionResized, this, &TrackerListWidget::saveSettings);
 104     connect(header(), &QHeaderView::sortIndicatorChanged, this, &TrackerListWidget::saveSettings);
 105
 106     // Set hotkeys
 107     const auto *editHotkey = new QShortcut(Qt::Key_F2, this, nullptr, nullptr, Qt::WidgetShortcut);
 108     connect(editHotkey, &QShortcut::activated, this, &TrackerListWidget::editSelectedTracker);
 109     const auto *deleteHotkey = new QShortcut(QKeySequence::Delete, this, nullptr, nullptr, Qt::WidgetShortcut);
 110     connect(deleteHotkey, &QShortcut::activated, this, &TrackerListWidget::deleteSelectedTrackers);
 111     const auto *copyHotkey = new QShortcut(QKeySequence::Copy, this, nullptr, nullptr, Qt::WidgetShortcut);
 112     connect(copyHotkey, &QShortcut::activated, this, &TrackerListWidget::copyTrackerUrl);
 113
 114     connect(this, &QAbstractItemView::doubleClicked, this, &TrackerListWidget::editSelectedTracker);
 115 }
 116
 117 TrackerListWidget::~TrackerListWidget()
 118 {
 119     saveSettings();
 120 }
 121
 122 void TrackerListWidget::setTorrent(BitTorrent::Torrent *torrent)
 123 {
 124     m_model->setTorrent(torrent);
 125 }
 126
 127 BitTorrent::Torrent *TrackerListWidget::torrent() const
 128 {
 129     return m_model->torrent();
 130 }
 131
 132 QModelIndexList TrackerListWidget::getSelectedTrackerRows() const
 133 {
 134     QModelIndexList selectedItemIndexes = selectionModel()->selectedRows();
 135     selectedItemIndexes.removeIf([](const QModelIndex &index)
 136     {
 137         return (index.parent().isValid() || (index.row() < TrackerListModel::STICKY_ROW_COUNT));
 138     });
 139
 140     return selectedItemIndexes;
 141 }
 142
 143 void TrackerListWidget::decreaseSelectedTrackerTiers()
 144 {
 145     const QModelIndexList trackerIndexes = getSelectedTrackerRows();
 146     if (trackerIndexes.isEmpty())
 147         return;
 148
 149     QSet<QString> trackerURLs;
 150     trackerURLs.reserve(trackerIndexes.size());
 151     for (const QModelIndex &index : trackerIndexes)
 152         trackerURLs.insert(index.siblingAtColumn(TrackerListModel::COL_URL).data().toString());
 153
 154     const QList<BitTorrent::TrackerEntryStatus> trackers = m_model->torrent()->trackers();
 155     QList<BitTorrent::TrackerEntry> adjustedTrackers;
 156     adjustedTrackers.reserve(trackers.size());
 157
 158     for (const BitTorrent::TrackerEntryStatus &status : trackers)
 159     {
 160         BitTorrent::TrackerEntry entry
 161         {
 162             .url = status.url,
 163             .tier = status.tier
 164         };
 165         if (trackerURLs.contains(entry.url))
 166         {
 167             if (entry.tier > 0)
 168                 --entry.tier;
 169         }
 170         adjustedTrackers.append(entry);
 171     }
 172
 173     m_model->torrent()->replaceTrackers(adjustedTrackers);
 174 }
 175
 176 void TrackerListWidget::increaseSelectedTrackerTiers()
 177 {
 178     const QModelIndexList trackerIndexes = getSelectedTrackerRows();
 179     if (trackerIndexes.isEmpty())
 180         return;
 181
 182     QSet<QString> trackerURLs;
 183     trackerURLs.reserve(trackerIndexes.size());
 184     for (const QModelIndex &index : trackerIndexes)
 185         trackerURLs.insert(index.siblingAtColumn(TrackerListModel::COL_URL).data().toString());
 186
 187     const QList<BitTorrent::TrackerEntryStatus> trackers = m_model->torrent()->trackers();
 188     QList<BitTorrent::TrackerEntry> adjustedTrackers;
 189     adjustedTrackers.reserve(trackers.size());
 190
 191     for (const BitTorrent::TrackerEntryStatus &status : trackers)
 192     {
 193         BitTorrent::TrackerEntry entry
 194         {
 195             .url = status.url,
 196             .tier = status.tier
 197         };
 198         if (trackerURLs.contains(entry.url))
 199         {
 200             if (entry.tier < std::numeric_limits<decltype(entry.tier)>::max())
 201                 ++entry.tier;
 202         }
 203         adjustedTrackers.append(entry);
 204     }
 205
 206     m_model->torrent()->replaceTrackers(adjustedTrackers);
 207 }
 208
 209 void TrackerListWidget::openAddTrackersDialog()
 210 {
 211     if (!torrent())
 212         return;
 213
 214     auto *dialog = new TrackersAdditionDialog(this, torrent());
 215     dialog->setAttribute(Qt::WA_DeleteOnClose);
 216     dialog->open();
 217 }
 218
 219 void TrackerListWidget::copyTrackerUrl()
 220 {
 221     if (!torrent())
 222         return;
 223
 224     const QModelIndexList selectedTrackerIndexes = getSelectedTrackerRows();
 225     if (selectedTrackerIndexes.isEmpty())
 226         return;
 227
 228     QStringList urlsToCopy;
 229     for (const QModelIndex &index : selectedTrackerIndexes)
 230     {
 231         const QString &trackerURL = index.siblingAtColumn(TrackerListModel::COL_URL).data().toString();
 232         qDebug() << "Copy:" << qUtf8Printable(trackerURL);
 233         urlsToCopy.append(trackerURL);
 234     }
 235
 236     QApplication::clipboard()->setText(urlsToCopy.join(u'\n'));
 237 }
 238
 239
 240 void TrackerListWidget::deleteSelectedTrackers()
 241 {
 242     if (!torrent())
 243         return;
 244
 245     const QModelIndexList selectedTrackerIndexes = getSelectedTrackerRows();
 246     if (selectedTrackerIndexes.isEmpty())
 247         return;
 248
 249     QStringList urlsToRemove;
 250     for (const QModelIndex &index : selectedTrackerIndexes)
 251     {
 252         const QString trackerURL = index.siblingAtColumn(TrackerListModel::COL_URL).data().toString();
 253         urlsToRemove.append(trackerURL);
 254     }
 255
 256     torrent()->removeTrackers(urlsToRemove);
 257 }
 258
 259 void TrackerListWidget::editSelectedTracker()
 260 {
 261     if (!torrent())
 262         return;
 263
 264     const QModelIndexList selectedTrackerIndexes = getSelectedTrackerRows();
 265     if (selectedTrackerIndexes.isEmpty())
 266         return;
 267
 268     // During multi-select only process item selected last
 269     const QUrl trackerURL = selectedTrackerIndexes.last().siblingAtColumn(TrackerListModel::COL_URL).data().toString();
 270
 271     bool ok = false;
 272     const QUrl newTrackerURL = AutoExpandableDialog::getText(this
 273             , tr("Tracker editing"), tr("Tracker URL:")
 274             , QLineEdit::Normal, trackerURL.toString(), &ok).trimmed();
 275     if (!ok)
 276         return;
 277
 278     if (!newTrackerURL.isValid())
 279     {
 280         QMessageBox::warning(this, tr("Tracker editing failed"), tr("The tracker URL entered is invalid."));
 281         return;
 282     }
 283
 284     if (newTrackerURL == trackerURL)
 285         return;
 286
 287     const QList<BitTorrent::TrackerEntryStatus> trackers = torrent()->trackers();
 288     QList<BitTorrent::TrackerEntry> entries;
 289     entries.reserve(trackers.size());
 290
 291     bool match = false;
 292     for (const BitTorrent::TrackerEntryStatus &status : trackers)
 293     {
 294         const QUrl url {status.url};
 295
 296         if (newTrackerURL == url)
 297         {
 298             QMessageBox::warning(this, tr("Tracker editing failed"), tr("The tracker URL already exists."));
 299             return;
 300         }
 301
 302         BitTorrent::TrackerEntry entry
 303         {
 304             .url = status.url,
 305             .tier = status.tier
 306         };
 307
 308         if (!match && (trackerURL == url))
 309         {
 310             match = true;
 311             entry.url = newTrackerURL.toString();
 312         }
 313         entries.append(entry);
 314     }
 315
 316     torrent()->replaceTrackers(entries);
 317 }
 318
 319 void TrackerListWidget::reannounceSelected()
 320 {
 321     if (!torrent())
 322         return;
 323
 324     const auto &selectedItemIndexes = selectedIndexes();
 325     if (selectedItemIndexes.isEmpty())
 326         return;
 327
 328     QSet<QString> trackerURLs;
 329     for (const QModelIndex &index : selectedItemIndexes)
 330     {
 331         if (index.parent().isValid())
 332             continue;
 333
 334         if ((index.row() < TrackerListModel::STICKY_ROW_COUNT))
 335         {
 336             // DHT case
 337             if (index.row() == TrackerListModel::ROW_DHT)
 338                 torrent()->forceDHTAnnounce();
 339
 340             continue;
 341         }
 342
 343         trackerURLs.insert(index.siblingAtColumn(TrackerListModel::COL_URL).data().toString());
 344     }
 345
 346     const QList<BitTorrent::TrackerEntryStatus> &trackers = m_model->torrent()->trackers();
 347     for (qsizetype i = 0; i < trackers.size(); ++i)
 348     {
 349         const BitTorrent::TrackerEntryStatus &status = trackers.at(i);
 350         if (trackerURLs.contains(status.url))
 351             torrent()->forceReannounce(i);
 352     }
 353 }
 354
 355 void TrackerListWidget::showTrackerListMenu()
 356 {
 357     if (!torrent())
 358         return;
 359
 360     QMenu *menu = new QMenu(this);
 361     menu->setAttribute(Qt::WA_DeleteOnClose);
 362
 363     // Add actions
 364     menu->addAction(UIThemeManager::instance()->getIcon(u"list-add"_s), tr("Add trackers...")
 365             , this, &TrackerListWidget::openAddTrackersDialog);
 366
 367     if (!getSelectedTrackerRows().isEmpty())
 368     {
 369         menu->addAction(UIThemeManager::instance()->getIcon(u"edit-rename"_s),tr("Edit tracker URL...")
 370                 , this, &TrackerListWidget::editSelectedTracker);
 371         menu->addAction(UIThemeManager::instance()->getIcon(u"edit-clear"_s, u"list-remove"_s), tr("Remove tracker")
 372                 , this, &TrackerListWidget::deleteSelectedTrackers);
 373         menu->addAction(UIThemeManager::instance()->getIcon(u"edit-copy"_s), tr("Copy tracker URL")
 374                 , this, &TrackerListWidget::copyTrackerUrl);
 375         if (!torrent()->isStopped())
 376         {
 377             menu->addAction(UIThemeManager::instance()->getIcon(u"reannounce"_s, u"view-refresh"_s), tr("Force reannounce to selected trackers")
 378                     , this, &TrackerListWidget::reannounceSelected);
 379         }
 380     }
 381
 382     if (!torrent()->isStopped())
 383     {
 384         menu->addSeparator();
 385         menu->addAction(UIThemeManager::instance()->getIcon(u"reannounce"_s, u"view-refresh"_s), tr("Force reannounce to all trackers")
 386                 , this, [this]()
 387         {
 388             torrent()->forceReannounce();
 389             torrent()->forceDHTAnnounce();
 390         });
 391     }
 392
 393     menu->popup(QCursor::pos());
 394 }
 395
 396 void TrackerListWidget::setModel([[maybe_unused]] QAbstractItemModel *model)
 397 {
 398     Q_ASSERT_X(false, Q_FUNC_INFO, "Changing the model of TrackerListWidget is not allowed.");
 399 }
 400
 401 void TrackerListWidget::loadSettings()
 402 {
 403     header()->restoreState(Preferences::instance()->getTrackerListState());
 404 }
 405
 406 void TrackerListWidget::saveSettings() const
 407 {
 408     Preferences::instance()->setTrackerListState(header()->saveState());
 409 }
 410
 411 int TrackerListWidget::visibleColumnsCount() const
 412 {
 413     int count = 0;
 414     for (int i = 0, iMax = header()->count(); i < iMax; ++i)
 415     {
 416         if (!isColumnHidden(i))
 417             ++count;
 418     }
 419
 420     return count;
 421 }
 422
 423 void TrackerListWidget::displayColumnHeaderMenu()
 424 {
 425     QMenu *menu = new QMenu(this);
 426     menu->setAttribute(Qt::WA_DeleteOnClose);
 427     menu->setTitle(tr("Column visibility"));
 428     menu->setToolTipsVisible(true);
 429
 430     for (int i = 0; i < TrackerListModel::COL_COUNT; ++i)
 431     {
 432         QAction *action = menu->addAction(model()->headerData(i, Qt::Horizontal).toString(), this
 433                 , [this, i](const bool checked)
 434         {
 435             if (!checked && (visibleColumnsCount() <= 1))
 436                 return;
 437
 438             setColumnHidden(i, !checked);
 439
 440             if (checked && (columnWidth(i) <= 5))
 441                 resizeColumnToContents(i);
 442
 443             saveSettings();
 444         });
 445         action->setCheckable(true);
 446         action->setChecked(!isColumnHidden(i));
 447     }
 448
 449     menu->addSeparator();
 450     QAction *resizeAction = menu->addAction(tr("Resize columns"), this, [this]()
 451     {
 452         for (int i = 0, count = header()->count(); i < count; ++i)
 453         {
 454             if (!isColumnHidden(i))
 455                 resizeColumnToContents(i);
 456         }
 457         saveSettings();
 458     });
 459     resizeAction->setToolTip(tr("Resize all non-hidden columns to the size of their contents"));
 460
 461     menu->popup(QCursor::pos());
 462 }
 463
 464 void TrackerListWidget::wheelEvent(QWheelEvent *event)
 465 {
 466     if (event->modifiers() & Qt::ShiftModifier)
 467     {
 468         // Shift + scroll = horizontal scroll
 469         event->accept();
 470         QWheelEvent scrollHEvent {event->position(), event->globalPosition()
 471                 , event->pixelDelta(), event->angleDelta().transposed(), event->buttons()
 472                 , event->modifiers(), event->phase(), event->inverted(), event->source()};
 473         QTreeView::wheelEvent(&scrollHEvent);
 474         return;
 475     }
 476
 477     QTreeView::wheelEvent(event);  // event delegated to base class
 478 }