File: searchhandler.cpp

package info (click to toggle)
khelpcenter 4%3A25.04.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 10,176 kB
  • sloc: cpp: 6,271; xml: 394; python: 51; perl: 25; makefile: 5; sh: 3
file content (211 lines) | stat: -rw-r--r-- 6,374 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
/*
    SPDX-FileCopyrightText: 2005 Cornelius Schumacher <schumacher@kde.org>

    SPDX-License-Identifier: GPL-2.0-or-later
*/

#include "searchhandler.h"

#include "docentry.h"
#include "khc_debug.h"

#include <KConfigGroup>
#include <KDesktopFile>
#include <KIO/TransferJob>
#include <KLocalizedString>
#include <KProcess>
#include <KShell>

#include <prefs.h>

using namespace KHC;

SearchJob::SearchJob(DocEntry *entry)
    : mEntry(entry)
{
}

bool SearchJob::startLocal(const QString &cmdString)
{
    mProcess = new KProcess;
    *mProcess << KShell::splitArgs(cmdString);

    connect(mProcess, QOverload<int, QProcess::ExitStatus>::of(&KProcess::finished), this, &SearchJob::searchExited);

    mProcess->setOutputChannelMode(KProcess::SeparateChannels);
    mProcess->start();
    if (!mProcess->waitForStarted()) {
        const QString txt = i18n("Error executing search command '%1'.", cmdString);
        Q_EMIT searchError(this, mEntry, txt);
        return false;
    }
    return true;
}

bool SearchJob::startRemote(const QString &urlString)
{
    KIO::TransferJob *job = KIO::get(QUrl(urlString));
    connect(job, &KIO::TransferJob::result, this, &SearchJob::slotJobResult);
    connect(job, &KIO::TransferJob::data, this, &SearchJob::slotJobData);

    mKioJob = job;
    return true;
}

SearchJob::~SearchJob()
{
    delete mProcess;
    delete mKioJob;
}

void SearchJob::searchExited(int exitCode, QProcess::ExitStatus exitStatus)
{
    if (exitStatus == QProcess::NormalExit && exitCode == 0) {
        mResult = QString::fromUtf8(mProcess->readAllStandardOutput());
        Q_EMIT searchFinished(this, mEntry, mResult);
    } else {
        mError = QString::fromUtf8(mProcess->readAllStandardError());
        QString error = QLatin1String("<em>") + mCmd + QLatin1String("</em>\n") + mError;
        Q_EMIT searchError(this, mEntry, error);
    }
}

void SearchJob::slotJobResult(KJob *job)
{
    if (job->error()) {
        Q_EMIT searchError(this, mEntry, i18n("Error: %1", job->errorString()));
    } else {
        Q_EMIT searchFinished(this, mEntry, mResult);
    }
}

void SearchJob::slotJobData(KIO::Job *job, const QByteArray &data)
{
    Q_UNUSED(job);
    mResult += QString::fromUtf8(data.data());
}

SearchHandler::SearchHandler(const KConfigGroup &cg)
    : mLang(QLocale().bcp47Name().left(2))
    , mDocumentTypes(cg.readEntry("DocumentTypes", QStringList()))
{
}

SearchHandler::~SearchHandler()
{
}

SearchHandler *SearchHandler::initFromFile(const QString &filename)
{
    KDesktopFile file(filename);
    KConfigGroup dg = file.desktopGroup();

    SearchHandler *handler = nullptr;

    handler = new ExternalProcessSearchHandler(dg);

    return handler;
}

QStringList SearchHandler::documentTypes() const
{
    return mDocumentTypes;
}

ExternalProcessSearchHandler::ExternalProcessSearchHandler(const KConfigGroup &cg)
    : SearchHandler(cg)
    , mSearchCommand(cg.readEntry("SearchCommand"))
    , mSearchUrl(cg.readEntry("SearchUrl"))
    , mSearchBinary(cg.readEntry("SearchBinary"))
    , mIndexCommand(cg.readEntry("IndexCommand"))
    , mTryExec(cg.readEntry("TryExec"))
{
    const QStringList searchBinaryPaths = cg.readEntry("SearchBinaryPaths", QStringList());
    mSearchBinary = QStandardPaths::findExecutable(mSearchBinary, searchBinaryPaths);
}

QString ExternalProcessSearchHandler::indexCommand(const QString &identifier) const
{
    QString cmd = mIndexCommand;
    cmd.replace(QStringLiteral("%i"), identifier);
    cmd.replace(QStringLiteral("%d"), Prefs::indexDirectory());
    cmd.replace(QStringLiteral("%l"), mLang);
    return cmd;
}

bool ExternalProcessSearchHandler::checkPaths(QString *error) const
{
    if (!mSearchCommand.isEmpty() && !checkBinary(mSearchCommand)) {
        *error = i18n("'%1' not found, check your installation", mSearchCommand);
        return false;
    }

    if (!mIndexCommand.isEmpty() && !checkBinary(mIndexCommand)) {
        *error = i18n("'%1' not found, check your installation", mIndexCommand);
        return false;
    }

    if (!mTryExec.isEmpty() && !checkBinary(mTryExec)) {
        *error = i18n("'%1' not found, install the package containing it", mTryExec);
        return false;
    }

    return true;
}

bool ExternalProcessSearchHandler::checkBinary(const QString &cmd) const
{
    QString binary;

    int pos = cmd.indexOf(QLatin1Char(' '));
    if (pos < 0)
        binary = cmd;
    else
        binary = cmd.left(pos);

    return !QStandardPaths::findExecutable(binary).isEmpty();
}

void ExternalProcessSearchHandler::search(DocEntry *entry, const QStringList &words, int maxResults, SearchEngine::Operation operation)
{
    qCDebug(KHC_LOG) << entry->identifier();

    if (!mSearchCommand.isEmpty()) {
        const QString cmdString = SearchEngine::substituteSearchQuery(mSearchCommand, entry->identifier(), words, maxResults, operation, mLang, mSearchBinary);

        qCDebug(KHC_LOG) << "CMD:" << cmdString;

        SearchJob *searchJob = new SearchJob(entry);
        connect(searchJob, &SearchJob::searchFinished, this, &ExternalProcessSearchHandler::slotSearchFinished);
        connect(searchJob, &SearchJob::searchError, this, &ExternalProcessSearchHandler::slotSearchError);
        searchJob->startLocal(cmdString);

    } else if (!mSearchUrl.isEmpty()) {
        const QString urlString = SearchEngine::substituteSearchQuery(mSearchUrl, entry->identifier(), words, maxResults, operation, mLang, mSearchBinary);

        qCDebug(KHC_LOG) << "URL:" << urlString;

        SearchJob *searchJob = new SearchJob(entry);
        connect(searchJob, &SearchJob::searchFinished, this, &ExternalProcessSearchHandler::slotSearchFinished);
        connect(searchJob, &SearchJob::searchError, this, &ExternalProcessSearchHandler::slotSearchError);
        searchJob->startRemote(urlString);

    } else {
        const QString txt = i18n("No search command or URL specified.");
        Q_EMIT searchFinished(this, entry, txt);
    }
}

void ExternalProcessSearchHandler::slotSearchFinished(SearchJob *job, DocEntry *entry, const QString &result)
{
    Q_EMIT searchFinished(this, entry, result);
    job->deleteLater();
}

void ExternalProcessSearchHandler::slotSearchError(SearchJob *job, DocEntry *entry, const QString &error)
{
    Q_EMIT searchError(this, entry, error);
    job->deleteLater();
}

#include "moc_searchhandler.cpp"