File: craftruntime.cpp

package info (click to toggle)
kdevelop 4%3A25.04.0-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 73,508 kB
  • sloc: cpp: 291,803; python: 4,322; javascript: 3,518; sh: 1,316; ansic: 703; xml: 414; php: 95; lisp: 66; makefile: 31; sed: 12
file content (184 lines) | stat: -rw-r--r-- 5,597 bytes parent folder | download | duplicates (2)
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
// SPDX-FileCopyrightText: 2022 Gleb Popov <arrowd@FreeBSD.org>
// SPDX-License-Identifier: BSD-3-Clause

#include "craftruntime.h"
#include "debug_craft.h"

#include <QFileInfo>
#include <QStandardPaths>
#include <QProcess>
#include <KProcess>

using namespace KDevelop;

namespace {
auto craftSetupHelperRelativePath()
{
    return QLatin1String{"/craft/bin/CraftSetupHelper.py"};
}
}

CraftRuntime::CraftRuntime(const QString& craftRoot, const QString& pythonExecutable)
    : m_craftRoot(craftRoot)
    , m_pythonExecutable(pythonExecutable)
{
    Q_ASSERT(!pythonExecutable.isEmpty());

    m_watcher.addPath(craftRoot + craftSetupHelperRelativePath());

    connect(&m_watcher, &QFileSystemWatcher::fileChanged, this, [this](const QString& path) {
        if (QFileInfo::exists(path)) {
            refreshEnvCache();
            if (!m_watcher.files().contains(path)) {
                m_watcher.addPath(path);
            }
        }
    });
    refreshEnvCache();
}

QString CraftRuntime::name() const
{
    return QStringLiteral("Craft [%1]").arg(m_craftRoot);
}

QString CraftRuntime::findCraftRoot(Path startingPoint)
{
    // CraftRuntime doesn't handle remote directories, because it needs
    // to check file existence in the findCraftRoot() function
    if (startingPoint.isRemote())
        return QString();

    QString craftRoot;
    while (true) {
        bool craftSettingsIniExists = QFileInfo::exists(startingPoint.path() + QLatin1String("/etc/CraftSettings.ini"));
        bool craftSetupHelperExists = QFileInfo::exists(startingPoint.path() + craftSetupHelperRelativePath());
        if (craftSettingsIniExists && craftSetupHelperExists) {
            craftRoot = startingPoint.path();
            break;
        }

        if (!startingPoint.hasParent())
            break;
        startingPoint = startingPoint.parent();
    }

    return QFileInfo(craftRoot).canonicalFilePath();
}

QString CraftRuntime::findPython()
{
    // Craft requires Python 3.6+, not any "python3", but
    // - If the user set up Craft already, there is a high probability that
    //   "python3" is a correct one
    // - We are running only CraftSetupHelper.py, not the whole Craft, so
    //   the 3.6+ requirement might be not relevant for this case.
    // So just search for "python3" and hope for the best.
    return QStandardPaths::findExecutable(QStringLiteral("python3"));
}

void CraftRuntime::setEnabled(bool enabled)
{
    if (enabled)
        qCDebug(CRAFT) << "Enabling Craft runtime at" << m_craftRoot << "with" << m_pythonExecutable;
}

void CraftRuntime::refreshEnvCache()
{
    QProcess python;
    python.start(m_pythonExecutable,
                 QStringList{m_craftRoot + craftSetupHelperRelativePath(), QStringLiteral("--getenv")});
    python.waitForFinished(5000);

    if (python.error() != QProcess::UnknownError) {
        if (python.error() == QProcess::Timedout)
            qCWarning(CRAFT) << "CraftSetupHelper.py execution timed out";
        else
            qCWarning(CRAFT) << "CraftSetupHelper.py execution failed:" << python.error() << python.errorString();
        return;
    }

    if (python.exitCode()) {
        qCWarning(CRAFT) << "CraftSetupHelper.py execution failed with code" << python.exitCode();
        return;
    }

    m_envCache.clear();

    const QList<QByteArray> output = python.readAllStandardOutput().split('\n');
    for (const auto& line : output) {
        // line contains things like "VAR=VALUE"
        int equalsSignIndex = line.indexOf('=');
        if (equalsSignIndex == -1)
            continue;

        QByteArray varName = line.left(equalsSignIndex);
        QByteArray value = line.mid(equalsSignIndex + 1);
        m_envCache.emplace_back(varName, value);
    }
}

QByteArray CraftRuntime::getenv(const QByteArray& varname) const
{
    auto it = std::find_if(m_envCache.begin(), m_envCache.end(), [&varname](const EnvironmentVariable& envVar) {
        return envVar.name == varname;
    });

    return it != m_envCache.end() ? it->value : QByteArray();
}

QString CraftRuntime::findExecutable(const QString& executableName) const
{
    auto runtimePaths = QString::fromLocal8Bit(getenv(QByteArrayLiteral("PATH"))).split(QLatin1Char(':'));

    return QStandardPaths::findExecutable(executableName, runtimePaths);
}

Path CraftRuntime::pathInHost(const Path& runtimePath) const
{
    return runtimePath;
}

Path CraftRuntime::pathInRuntime(const Path& localPath) const
{
    return localPath;
}

void CraftRuntime::startProcess(KProcess* process) const
{
    QStringList program = process->program();
    QString executableInRuntime = findExecutable(program.constFirst());
    if (executableInRuntime != program.constFirst()) {
        program.first() = std::move(executableInRuntime);
        process->setProgram(program);
    }
    setEnvironmentVariables(process);
    process->start();
}

void CraftRuntime::startProcess(QProcess* process) const
{
    QString executableInRuntime = findExecutable(process->program());
    process->setProgram(executableInRuntime);
    setEnvironmentVariables(process);
    process->start();
}

void CraftRuntime::setEnvironmentVariables(QProcess* process) const
{
    auto env = process->processEnvironment();

    for (const auto& envVar : m_envCache) {
        env.insert(QString::fromLocal8Bit(envVar.name), QString::fromLocal8Bit(envVar.value));
    }

    process->setProcessEnvironment(env);
}

EnvironmentVariable::EnvironmentVariable(const QByteArray& name, const QByteArray& value)
    : name(name.trimmed())
    , value(value)
{
}

#include "moc_craftruntime.cpp"