Bump to 4.6.7
[qBittorrent.git] / src / gui / search / searchjobwidget.cpp
blobbddaefa217cdaa185372b768ca85cec6c428d1af
1 /*
2 * Bittorrent Client using Qt and libtorrent.
3 * Copyright (C) 2018 Vladimir Golovnev <glassez@yandex.ru>
4 * Copyright (C) 2006 Christophe Dumez <chris@qbittorrent.org>
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.
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.
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.
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.
30 #include "searchjobwidget.h"
32 #include <QApplication>
33 #include <QClipboard>
34 #include <QDesktopServices>
35 #include <QHeaderView>
36 #include <QKeyEvent>
37 #include <QMenu>
38 #include <QPalette>
39 #include <QStandardItemModel>
40 #include <QUrl>
42 #include "base/bittorrent/session.h"
43 #include "base/preferences.h"
44 #include "base/search/searchdownloadhandler.h"
45 #include "base/search/searchhandler.h"
46 #include "base/search/searchpluginmanager.h"
47 #include "base/utils/misc.h"
48 #include "gui/addnewtorrentdialog.h"
49 #include "gui/lineedit.h"
50 #include "gui/uithememanager.h"
51 #include "gui/utils.h"
52 #include "searchsortmodel.h"
53 #include "ui_searchjobwidget.h"
55 SearchJobWidget::SearchJobWidget(SearchHandler *searchHandler, QWidget *parent)
56 : QWidget(parent)
57 , m_ui(new Ui::SearchJobWidget)
58 , m_searchHandler(searchHandler)
59 , m_nameFilteringMode(u"Search/FilteringMode"_s)
61 m_ui->setupUi(this);
63 loadSettings();
65 header()->setFirstSectionMovable(true);
66 header()->setStretchLastSection(false);
67 header()->setTextElideMode(Qt::ElideRight);
69 // Set Search results list model
70 m_searchListModel = new QStandardItemModel(0, SearchSortModel::NB_SEARCH_COLUMNS, this);
71 m_searchListModel->setHeaderData(SearchSortModel::NAME, Qt::Horizontal, tr("Name", "i.e: file name"));
72 m_searchListModel->setHeaderData(SearchSortModel::SIZE, Qt::Horizontal, tr("Size", "i.e: file size"));
73 m_searchListModel->setHeaderData(SearchSortModel::SEEDS, Qt::Horizontal, tr("Seeders", "i.e: Number of full sources"));
74 m_searchListModel->setHeaderData(SearchSortModel::LEECHES, Qt::Horizontal, tr("Leechers", "i.e: Number of partial sources"));
75 m_searchListModel->setHeaderData(SearchSortModel::ENGINE_URL, Qt::Horizontal, tr("Search engine"));
76 // Set columns text alignment
77 m_searchListModel->setHeaderData(SearchSortModel::SIZE, Qt::Horizontal, QVariant(Qt::AlignRight | Qt::AlignVCenter), Qt::TextAlignmentRole);
78 m_searchListModel->setHeaderData(SearchSortModel::SEEDS, Qt::Horizontal, QVariant(Qt::AlignRight | Qt::AlignVCenter), Qt::TextAlignmentRole);
79 m_searchListModel->setHeaderData(SearchSortModel::LEECHES, Qt::Horizontal, QVariant(Qt::AlignRight | Qt::AlignVCenter), Qt::TextAlignmentRole);
81 m_proxyModel = new SearchSortModel(this);
82 m_proxyModel->setDynamicSortFilter(true);
83 m_proxyModel->setSourceModel(m_searchListModel);
84 m_proxyModel->setNameFilter(searchHandler->pattern());
85 m_ui->resultsBrowser->setModel(m_proxyModel);
87 m_ui->resultsBrowser->hideColumn(SearchSortModel::DL_LINK); // Hide url column
88 m_ui->resultsBrowser->hideColumn(SearchSortModel::DESC_LINK);
90 m_ui->resultsBrowser->setSelectionMode(QAbstractItemView::ExtendedSelection);
91 m_ui->resultsBrowser->setRootIsDecorated(false);
92 m_ui->resultsBrowser->setAllColumnsShowFocus(true);
93 m_ui->resultsBrowser->setSortingEnabled(true);
94 m_ui->resultsBrowser->setEditTriggers(QAbstractItemView::NoEditTriggers);
96 // Ensure that at least one column is visible at all times
97 bool atLeastOne = false;
98 for (int i = 0; i < SearchSortModel::DL_LINK; ++i)
100 if (!m_ui->resultsBrowser->isColumnHidden(i))
102 atLeastOne = true;
103 break;
106 if (!atLeastOne)
107 m_ui->resultsBrowser->setColumnHidden(SearchSortModel::NAME, false);
108 // To also mitigate the above issue, we have to resize each column when
109 // its size is 0, because explicitly 'showing' the column isn't enough
110 // in the above scenario.
111 for (int i = 0; i < SearchSortModel::DL_LINK; ++i)
113 if ((m_ui->resultsBrowser->columnWidth(i) <= 0) && !m_ui->resultsBrowser->isColumnHidden(i))
114 m_ui->resultsBrowser->resizeColumnToContents(i);
117 header()->setContextMenuPolicy(Qt::CustomContextMenu);
118 connect(header(), &QWidget::customContextMenuRequested, this, &SearchJobWidget::displayColumnHeaderMenu);
119 connect(header(), &QHeaderView::sectionResized, this, &SearchJobWidget::saveSettings);
120 connect(header(), &QHeaderView::sectionMoved, this, &SearchJobWidget::saveSettings);
121 connect(header(), &QHeaderView::sortIndicatorChanged, this, &SearchJobWidget::saveSettings);
123 fillFilterComboBoxes();
125 updateFilter();
127 m_lineEditSearchResultsFilter = new LineEdit(this);
128 m_lineEditSearchResultsFilter->setPlaceholderText(tr("Filter search results..."));
129 m_lineEditSearchResultsFilter->setContextMenuPolicy(Qt::CustomContextMenu);
130 connect(m_lineEditSearchResultsFilter, &QWidget::customContextMenuRequested, this, &SearchJobWidget::showFilterContextMenu);
131 connect(m_lineEditSearchResultsFilter, &LineEdit::textChanged, this, &SearchJobWidget::filterSearchResults);
132 m_ui->horizontalLayout->insertWidget(0, m_lineEditSearchResultsFilter);
134 connect(m_ui->filterMode, qOverload<int>(&QComboBox::currentIndexChanged)
135 , this, &SearchJobWidget::updateFilter);
136 connect(m_ui->minSeeds, &QAbstractSpinBox::editingFinished, this, &SearchJobWidget::updateFilter);
137 connect(m_ui->minSeeds, qOverload<int>(&QSpinBox::valueChanged)
138 , this, &SearchJobWidget::updateFilter);
139 connect(m_ui->maxSeeds, &QAbstractSpinBox::editingFinished, this, &SearchJobWidget::updateFilter);
140 connect(m_ui->maxSeeds, qOverload<int>(&QSpinBox::valueChanged)
141 , this, &SearchJobWidget::updateFilter);
142 connect(m_ui->minSize, &QAbstractSpinBox::editingFinished, this, &SearchJobWidget::updateFilter);
143 connect(m_ui->minSize, qOverload<double>(&QDoubleSpinBox::valueChanged)
144 , this, &SearchJobWidget::updateFilter);
145 connect(m_ui->maxSize, &QAbstractSpinBox::editingFinished, this, &SearchJobWidget::updateFilter);
146 connect(m_ui->maxSize, qOverload<double>(&QDoubleSpinBox::valueChanged)
147 , this, &SearchJobWidget::updateFilter);
148 connect(m_ui->minSizeUnit, qOverload<int>(&QComboBox::currentIndexChanged)
149 , this, &SearchJobWidget::updateFilter);
150 connect(m_ui->maxSizeUnit, qOverload<int>(&QComboBox::currentIndexChanged)
151 , this, &SearchJobWidget::updateFilter);
153 connect(m_ui->resultsBrowser, &QAbstractItemView::doubleClicked, this, &SearchJobWidget::onItemDoubleClicked);
155 connect(searchHandler, &SearchHandler::newSearchResults, this, &SearchJobWidget::appendSearchResults);
156 connect(searchHandler, &SearchHandler::searchFinished, this, &SearchJobWidget::searchFinished);
157 connect(searchHandler, &SearchHandler::searchFailed, this, &SearchJobWidget::searchFailed);
158 connect(this, &QObject::destroyed, searchHandler, &QObject::deleteLater);
160 setStatusTip(statusText(m_status));
163 SearchJobWidget::~SearchJobWidget()
165 saveSettings();
166 delete m_ui;
169 void SearchJobWidget::onItemDoubleClicked(const QModelIndex &index)
171 downloadTorrent(index);
174 QHeaderView *SearchJobWidget::header() const
176 return m_ui->resultsBrowser->header();
179 // Set the color of a row in data model
180 void SearchJobWidget::setRowColor(int row, const QColor &color)
182 m_proxyModel->setDynamicSortFilter(false);
183 for (int i = 0; i < m_proxyModel->columnCount(); ++i)
184 m_proxyModel->setData(m_proxyModel->index(row, i), color, Qt::ForegroundRole);
186 m_proxyModel->setDynamicSortFilter(true);
189 SearchJobWidget::Status SearchJobWidget::status() const
191 return m_status;
194 int SearchJobWidget::visibleResultsCount() const
196 return m_proxyModel->rowCount();
199 LineEdit *SearchJobWidget::lineEditSearchResultsFilter() const
201 return m_lineEditSearchResultsFilter;
204 void SearchJobWidget::cancelSearch()
206 m_searchHandler->cancelSearch();
209 void SearchJobWidget::downloadTorrents(const AddTorrentOption option)
211 const QModelIndexList rows = m_ui->resultsBrowser->selectionModel()->selectedRows();
212 for (const QModelIndex &rowIndex : rows)
213 downloadTorrent(rowIndex, option);
216 void SearchJobWidget::openTorrentPages() const
218 const QModelIndexList rows {m_ui->resultsBrowser->selectionModel()->selectedRows()};
219 for (const QModelIndex &rowIndex : rows)
221 const QString descrLink = m_proxyModel->data(
222 m_proxyModel->index(rowIndex.row(), SearchSortModel::DESC_LINK)).toString();
223 if (!descrLink.isEmpty())
224 QDesktopServices::openUrl(QUrl::fromEncoded(descrLink.toUtf8()));
228 void SearchJobWidget::copyTorrentURLs() const
230 copyField(SearchSortModel::DESC_LINK);
233 void SearchJobWidget::copyTorrentDownloadLinks() const
235 copyField(SearchSortModel::DL_LINK);
238 void SearchJobWidget::copyTorrentNames() const
240 copyField(SearchSortModel::NAME);
243 void SearchJobWidget::copyField(const int column) const
245 const QModelIndexList rows {m_ui->resultsBrowser->selectionModel()->selectedRows()};
246 QStringList list;
248 for (const QModelIndex &rowIndex : rows)
250 const QString field = m_proxyModel->data(
251 m_proxyModel->index(rowIndex.row(), column)).toString();
252 if (!field.isEmpty())
253 list << field;
256 if (!list.empty())
257 QApplication::clipboard()->setText(list.join(u'\n'));
260 void SearchJobWidget::setStatus(Status value)
262 if (m_status == value) return;
264 m_status = value;
265 setStatusTip(statusText(value));
266 emit statusChanged();
269 void SearchJobWidget::downloadTorrent(const QModelIndex &rowIndex, const AddTorrentOption option)
271 const QString torrentUrl = m_proxyModel->data(
272 m_proxyModel->index(rowIndex.row(), SearchSortModel::DL_LINK)).toString();
273 const QString siteUrl = m_proxyModel->data(
274 m_proxyModel->index(rowIndex.row(), SearchSortModel::ENGINE_URL)).toString();
276 if (torrentUrl.startsWith(u"magnet:", Qt::CaseInsensitive))
278 addTorrentToSession(torrentUrl, option);
280 else
282 SearchDownloadHandler *downloadHandler = m_searchHandler->manager()->downloadTorrent(siteUrl, torrentUrl);
283 connect(downloadHandler, &SearchDownloadHandler::downloadFinished
284 , this, [this, option](const QString &source) { addTorrentToSession(source, option); });
285 connect(downloadHandler, &SearchDownloadHandler::downloadFinished, downloadHandler, &SearchDownloadHandler::deleteLater);
287 setRowColor(rowIndex.row(), QApplication::palette().color(QPalette::LinkVisited));
290 void SearchJobWidget::addTorrentToSession(const QString &source, const AddTorrentOption option)
292 if (source.isEmpty()) return;
294 if ((option == AddTorrentOption::ShowDialog) || ((option == AddTorrentOption::Default) && AddNewTorrentDialog::isEnabled()))
295 AddNewTorrentDialog::show(source, window());
296 else
297 BitTorrent::Session::instance()->addTorrent(source);
300 void SearchJobWidget::updateResultsCount()
302 const int totalResults = m_searchListModel->rowCount();
303 const int filteredResults = m_proxyModel->rowCount();
304 m_ui->resultsLbl->setText(tr("Results (showing <i>%1</i> out of <i>%2</i>):", "i.e: Search results")
305 .arg(filteredResults).arg(totalResults));
307 m_noSearchResults = (totalResults == 0);
308 emit resultsCountUpdated();
311 void SearchJobWidget::updateFilter()
313 using Utils::Misc::SizeUnit;
315 m_proxyModel->enableNameFilter(filteringMode() == NameFilteringMode::OnlyNames);
316 // we update size and seeds filter parameters in the model even if they are disabled
317 m_proxyModel->setSeedsFilter(m_ui->minSeeds->value(), m_ui->maxSeeds->value());
318 m_proxyModel->setSizeFilter(
319 sizeInBytes(m_ui->minSize->value(), static_cast<SizeUnit>(m_ui->minSizeUnit->currentIndex())),
320 sizeInBytes(m_ui->maxSize->value(), static_cast<SizeUnit>(m_ui->maxSizeUnit->currentIndex())));
322 m_nameFilteringMode = filteringMode();
324 m_proxyModel->invalidate();
325 updateResultsCount();
328 void SearchJobWidget::fillFilterComboBoxes()
330 using Utils::Misc::SizeUnit;
331 using Utils::Misc::unitString;
333 QStringList unitStrings;
334 unitStrings.append(unitString(SizeUnit::Byte));
335 unitStrings.append(unitString(SizeUnit::KibiByte));
336 unitStrings.append(unitString(SizeUnit::MebiByte));
337 unitStrings.append(unitString(SizeUnit::GibiByte));
338 unitStrings.append(unitString(SizeUnit::TebiByte));
339 unitStrings.append(unitString(SizeUnit::PebiByte));
340 unitStrings.append(unitString(SizeUnit::ExbiByte));
342 m_ui->minSizeUnit->clear();
343 m_ui->maxSizeUnit->clear();
344 m_ui->minSizeUnit->addItems(unitStrings);
345 m_ui->maxSizeUnit->addItems(unitStrings);
347 m_ui->minSize->setValue(0);
348 m_ui->minSizeUnit->setCurrentIndex(static_cast<int>(SizeUnit::MebiByte));
350 m_ui->maxSize->setValue(-1);
351 m_ui->maxSizeUnit->setCurrentIndex(static_cast<int>(SizeUnit::GibiByte));
353 m_ui->filterMode->clear();
355 m_ui->filterMode->addItem(tr("Torrent names only"), static_cast<int>(NameFilteringMode::OnlyNames));
356 m_ui->filterMode->addItem(tr("Everywhere"), static_cast<int>(NameFilteringMode::Everywhere));
358 const QVariant selectedMode = static_cast<int>(m_nameFilteringMode.get(NameFilteringMode::OnlyNames));
359 const int index = m_ui->filterMode->findData(selectedMode);
360 m_ui->filterMode->setCurrentIndex((index == -1) ? 0 : index);
363 void SearchJobWidget::filterSearchResults(const QString &name)
365 const QString pattern = (Preferences::instance()->getRegexAsFilteringPatternForSearchJob()
366 ? name : Utils::String::wildcardToRegexPattern(name));
367 m_proxyModel->setFilterRegularExpression(QRegularExpression(pattern, QRegularExpression::CaseInsensitiveOption));
368 updateResultsCount();
371 void SearchJobWidget::showFilterContextMenu()
373 const Preferences *pref = Preferences::instance();
375 QMenu *menu = m_lineEditSearchResultsFilter->createStandardContextMenu();
376 menu->setAttribute(Qt::WA_DeleteOnClose);
377 menu->addSeparator();
379 QAction *useRegexAct = menu->addAction(tr("Use regular expressions"));
380 useRegexAct->setCheckable(true);
381 useRegexAct->setChecked(pref->getRegexAsFilteringPatternForSearchJob());
382 connect(useRegexAct, &QAction::toggled, pref, &Preferences::setRegexAsFilteringPatternForSearchJob);
383 connect(useRegexAct, &QAction::toggled, this, [this]() { filterSearchResults(m_lineEditSearchResultsFilter->text()); });
385 menu->popup(QCursor::pos());
388 void SearchJobWidget::contextMenuEvent(QContextMenuEvent *event)
390 auto *menu = new QMenu(this);
391 menu->setAttribute(Qt::WA_DeleteOnClose);
393 menu->addAction(UIThemeManager::instance()->getIcon(u"download"_s)
394 , tr("Open download window"), this, [this]() { downloadTorrents(AddTorrentOption::ShowDialog); });
395 menu->addAction(UIThemeManager::instance()->getIcon(u"downloading"_s, u"download"_s)
396 , tr("Download"), this, [this]() { downloadTorrents(AddTorrentOption::SkipDialog); });
397 menu->addSeparator();
398 menu->addAction(UIThemeManager::instance()->getIcon(u"application-url"_s), tr("Open description page")
399 , this, &SearchJobWidget::openTorrentPages);
401 QMenu *copySubMenu = menu->addMenu(
402 UIThemeManager::instance()->getIcon(u"edit-copy"_s), tr("Copy"));
404 copySubMenu->addAction(UIThemeManager::instance()->getIcon(u"name"_s, u"edit-copy"_s), tr("Name")
405 , this, &SearchJobWidget::copyTorrentNames);
406 copySubMenu->addAction(UIThemeManager::instance()->getIcon(u"insert-link"_s, u"edit-copy"_s), tr("Download link")
407 , this, &SearchJobWidget::copyTorrentDownloadLinks);
408 copySubMenu->addAction(UIThemeManager::instance()->getIcon(u"application-url"_s, u"edit-copy"_s), tr("Description page URL")
409 , this, &SearchJobWidget::copyTorrentURLs);
411 menu->popup(event->globalPos());
414 QString SearchJobWidget::statusText(SearchJobWidget::Status st)
416 switch (st)
418 case Status::Ongoing:
419 return tr("Searching...");
420 case Status::Finished:
421 return tr("Search has finished");
422 case Status::Aborted:
423 return tr("Search aborted");
424 case Status::Error:
425 return tr("An error occurred during search...");
426 case Status::NoResults:
427 return tr("Search returned no results");
428 default:
429 return {};
433 SearchJobWidget::NameFilteringMode SearchJobWidget::filteringMode() const
435 return static_cast<NameFilteringMode>(m_ui->filterMode->itemData(m_ui->filterMode->currentIndex()).toInt());
438 void SearchJobWidget::loadSettings()
440 header()->restoreState(Preferences::instance()->getSearchTabHeaderState());
443 void SearchJobWidget::saveSettings() const
445 Preferences::instance()->setSearchTabHeaderState(header()->saveState());
448 int SearchJobWidget::visibleColumnsCount() const
450 int count = 0;
451 for (int i = 0, iMax = m_ui->resultsBrowser->header()->count(); i < iMax; ++i)
453 if (!m_ui->resultsBrowser->isColumnHidden(i))
454 ++count;
457 return count;
460 void SearchJobWidget::displayColumnHeaderMenu()
462 auto *menu = new QMenu(this);
463 menu->setAttribute(Qt::WA_DeleteOnClose);
464 menu->setTitle(tr("Column visibility"));
465 menu->setToolTipsVisible(true);
467 for (int i = 0; i < SearchSortModel::DL_LINK; ++i)
469 const auto columnName = m_searchListModel->headerData(i, Qt::Horizontal, Qt::DisplayRole).toString();
470 QAction *action = menu->addAction(columnName, this, [this, i](const bool checked)
472 if (!checked && (visibleColumnsCount() <= 1))
473 return;
475 m_ui->resultsBrowser->setColumnHidden(i, !checked);
477 if (checked && (m_ui->resultsBrowser->columnWidth(i) <= 5))
478 m_ui->resultsBrowser->resizeColumnToContents(i);
480 saveSettings();
482 action->setCheckable(true);
483 action->setChecked(!m_ui->resultsBrowser->isColumnHidden(i));
486 menu->addSeparator();
487 QAction *resizeAction = menu->addAction(tr("Resize columns"), this, [this]()
489 for (int i = 0, count = m_ui->resultsBrowser->header()->count(); i < count; ++i)
491 if (!m_ui->resultsBrowser->isColumnHidden(i))
492 m_ui->resultsBrowser->resizeColumnToContents(i);
494 saveSettings();
496 resizeAction->setToolTip(tr("Resize all non-hidden columns to the size of their contents"));
498 menu->popup(QCursor::pos());
501 void SearchJobWidget::searchFinished(bool cancelled)
503 if (cancelled)
504 setStatus(Status::Aborted);
505 else if (m_noSearchResults)
506 setStatus(Status::NoResults);
507 else
508 setStatus(Status::Finished);
511 void SearchJobWidget::searchFailed()
513 setStatus(Status::Error);
516 void SearchJobWidget::appendSearchResults(const QVector<SearchResult> &results)
518 for (const SearchResult &result : results)
520 // Add item to search result list
521 int row = m_searchListModel->rowCount();
522 m_searchListModel->insertRow(row);
524 const auto setModelData = [this, row] (const int column, const QString &displayData
525 , const QVariant &underlyingData, const Qt::Alignment textAlignmentData = {})
527 const QMap<int, QVariant> data =
529 {Qt::DisplayRole, displayData},
530 {SearchSortModel::UnderlyingDataRole, underlyingData},
531 {Qt::TextAlignmentRole, QVariant {textAlignmentData}}
533 m_searchListModel->setItemData(m_searchListModel->index(row, column), data);
536 setModelData(SearchSortModel::NAME, result.fileName, result.fileName);
537 setModelData(SearchSortModel::DL_LINK, result.fileUrl, result.fileUrl);
538 setModelData(SearchSortModel::ENGINE_URL, result.siteUrl, result.siteUrl);
539 setModelData(SearchSortModel::DESC_LINK, result.descrLink, result.descrLink);
540 setModelData(SearchSortModel::SIZE, Utils::Misc::friendlyUnit(result.fileSize), result.fileSize, (Qt::AlignRight | Qt::AlignVCenter));
541 setModelData(SearchSortModel::SEEDS, QString::number(result.nbSeeders), result.nbSeeders, (Qt::AlignRight | Qt::AlignVCenter));
542 setModelData(SearchSortModel::LEECHES, QString::number(result.nbLeechers), result.nbLeechers, (Qt::AlignRight | Qt::AlignVCenter));
545 updateResultsCount();
548 void SearchJobWidget::keyPressEvent(QKeyEvent *event)
550 switch (event->key())
552 case Qt::Key_Enter:
553 case Qt::Key_Return:
554 downloadTorrents();
555 break;
556 default:
557 QWidget::keyPressEvent(event);