src/base/search/searchhandler.cpp

   1 /*
   2  * Bittorrent Client using Qt and libtorrent.
   3  * Copyright (C) 2015, 2018  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 "searchhandler.h"
  31
  32 #include <QProcess>
  33 #include <QTimer>
  34 #include <QVector>
  35
  36 #include "base/global.h"
  37 #include "base/path.h"
  38 #include "base/utils/foreignapps.h"
  39 #include "base/utils/fs.h"
  40 #include "searchpluginmanager.h"
  41
  42 namespace
  43 {
  44     enum SearchResultColumn
  45     {
  46         PL_DL_LINK,
  47         PL_NAME,
  48         PL_SIZE,
  49         PL_SEEDS,
  50         PL_LEECHS,
  51         PL_ENGINE_URL,
  52         PL_DESC_LINK,
  53         NB_PLUGIN_COLUMNS
  54     };
  55 }
  56
  57 SearchHandler::SearchHandler(const QString &pattern, const QString &category, const QStringList &usedPlugins, SearchPluginManager *manager)
  58     : QObject {manager}
  59     , m_pattern {pattern}
  60     , m_category {category}
  61     , m_usedPlugins {usedPlugins}
  62     , m_manager {manager}
  63     , m_searchProcess {new QProcess {this}}
  64     , m_searchTimeout {new QTimer {this}}
  65 {
  66     // Load environment variables (proxy)
  67     m_searchProcess->setEnvironment(QProcess::systemEnvironment());
  68
  69     const QStringList params
  70     {
  71         (m_manager->engineLocation() / Path(u"nova2.py"_qs)).toString(),
  72         m_usedPlugins.join(u','),
  73         m_category
  74     };
  75
  76     // Launch search
  77     m_searchProcess->setProgram(Utils::ForeignApps::pythonInfo().executableName);
  78     m_searchProcess->setArguments(params + m_pattern.split(u' '));
  79
  80     connect(m_searchProcess, &QProcess::errorOccurred, this, &SearchHandler::processFailed);
  81     connect(m_searchProcess, &QProcess::readyReadStandardOutput, this, &SearchHandler::readSearchOutput);
  82     connect(m_searchProcess, qOverload<int, QProcess::ExitStatus>(&QProcess::finished)
  83             , this, &SearchHandler::processFinished);
  84
  85     m_searchTimeout->setSingleShot(true);
  86     connect(m_searchTimeout, &QTimer::timeout, this, &SearchHandler::cancelSearch);
  87     m_searchTimeout->start(180000); // 3 min
  88
  89     // deferred start allows clients to handle starting-related signals
  90     QTimer::singleShot(0, this, [this]() { m_searchProcess->start(QIODevice::ReadOnly); });
  91 }
  92
  93 bool SearchHandler::isActive() const
  94 {
  95     return (m_searchProcess->state() != QProcess::NotRunning);
  96 }
  97
  98 void SearchHandler::cancelSearch()
  99 {
 100     if ((m_searchProcess->state() == QProcess::NotRunning) || m_searchCancelled)
 101         return;
 102
 103 #ifdef Q_OS_WIN
 104     m_searchProcess->kill();
 105 #else
 106     m_searchProcess->terminate();
 107 #endif
 108     m_searchCancelled = true;
 109     m_searchTimeout->stop();
 110 }
 111
 112 // Slot called when QProcess is Finished
 113 // QProcess can be finished for 3 reasons:
 114 // Error | Stopped by user | Finished normally
 115 void SearchHandler::processFinished(const int exitcode)
 116 {
 117     m_searchTimeout->stop();
 118
 119     if (m_searchCancelled)
 120         emit searchFinished(true);
 121     else if ((m_searchProcess->exitStatus() == QProcess::NormalExit) && (exitcode == 0))
 122         emit searchFinished(false);
 123     else
 124         emit searchFailed();
 125 }
 126
 127 // search QProcess return output as soon as it gets new
 128 // stuff to read. We split it into lines and parse each
 129 // line to SearchResult calling parseSearchResult().
 130 void SearchHandler::readSearchOutput()
 131 {
 132     QByteArray output = m_searchProcess->readAllStandardOutput();
 133     output.replace('\r', "");
 134
 135     QList<QByteArray> lines = output.split('\n');
 136     if (!m_searchResultLineTruncated.isEmpty())
 137         lines.prepend(m_searchResultLineTruncated + lines.takeFirst());
 138     m_searchResultLineTruncated = lines.takeLast().trimmed();
 139
 140     QVector<SearchResult> searchResultList;
 141     searchResultList.reserve(lines.size());
 142
 143     for (const QByteArray &line : asConst(lines))
 144     {
 145         SearchResult searchResult;
 146         if (parseSearchResult(QString::fromUtf8(line), searchResult))
 147             searchResultList << searchResult;
 148     }
 149
 150     if (!searchResultList.isEmpty())
 151     {
 152         for (const SearchResult &result : searchResultList)
 153             m_results.append(result);
 154         emit newSearchResults(searchResultList);
 155     }
 156 }
 157
 158 void SearchHandler::processFailed()
 159 {
 160     if (!m_searchCancelled)
 161         emit searchFailed();
 162 }
 163
 164 // Parse one line of search results list
 165 // Line is in the following form:
 166 // file url | file name | file size | nb seeds | nb leechers | Search engine url
 167 bool SearchHandler::parseSearchResult(const QStringView line, SearchResult &searchResult)
 168 {
 169     const QList<QStringView> parts = line.split(u'|');
 170     const int nbFields = parts.size();
 171
 172     if (nbFields < (NB_PLUGIN_COLUMNS - 1)) return false; // -1 because desc_link is optional
 173
 174     searchResult = SearchResult();
 175     searchResult.fileUrl = parts.at(PL_DL_LINK).trimmed().toString(); // download URL
 176     searchResult.fileName = parts.at(PL_NAME).trimmed().toString(); // Name
 177     searchResult.fileSize = parts.at(PL_SIZE).trimmed().toLongLong(); // Size
 178
 179     bool ok = false;
 180
 181     searchResult.nbSeeders = parts.at(PL_SEEDS).trimmed().toLongLong(&ok); // Seeders
 182     if (!ok || (searchResult.nbSeeders < 0))
 183         searchResult.nbSeeders = -1;
 184
 185     searchResult.nbLeechers = parts.at(PL_LEECHS).trimmed().toLongLong(&ok); // Leechers
 186     if (!ok || (searchResult.nbLeechers < 0))
 187         searchResult.nbLeechers = -1;
 188
 189     searchResult.siteUrl = parts.at(PL_ENGINE_URL).trimmed().toString(); // Search site URL
 190     if (nbFields == NB_PLUGIN_COLUMNS)
 191         searchResult.descrLink = parts.at(PL_DESC_LINK).trimmed().toString(); // Description Link
 192
 193     return true;
 194 }
 195
 196 SearchPluginManager *SearchHandler::manager() const
 197 {
 198     return m_manager;
 199 }
 200
 201 QList<SearchResult> SearchHandler::results() const
 202 {
 203     return m_results;
 204 }
 205
 206 QString SearchHandler::pattern() const
 207 {
 208     return m_pattern;
 209 }