aboutsummaryrefslogtreecommitdiffstats
path: root/src/libs/utils/terminalhooks.cpp
blob: b6faae765d5fc814807c02e9c1d8684ece01fe2b (plain)
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
// Copyright (C) 2022 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0+ OR GPL-3.0 WITH Qt-GPL-exception-1.0

#include "terminalhooks.h"

#include "filepath.h"
#include "process.h"
#include "terminalcommand.h"
#include "terminalinterface.h"

#include <QMutex>
#include <QTemporaryFile>

namespace Utils::Terminal {

FilePath defaultShellForDevice(const FilePath &deviceRoot)
{
    if (deviceRoot.osType() == OsTypeWindows)
        return deviceRoot.withNewPath("cmd.exe").searchInPath();

    const Environment env = deviceRoot.deviceEnvironment();
    FilePath shell = FilePath::fromUserInput(env.value_or("SHELL", "/bin/sh"));

    if (!shell.isAbsolutePath())
        shell = env.searchInPath(shell.nativePath());

    if (shell.isEmpty())
        return shell;

    return deviceRoot.withNewMappedPath(shell);
}

class ExternalTerminalProcessImpl final : public TerminalInterface
{
    class ProcessStubCreator : public StubCreator
    {
    public:
        ProcessStubCreator(ExternalTerminalProcessImpl *interface)
            : m_interface(interface)
        {}

        void startStubProcess(const CommandLine &cmd, const ProcessSetupData &) override
        {
            const TerminalCommand terminal = TerminalCommand::terminalEmulator();

            if (HostOsInfo::isWindowsHost()) {
                m_terminalProcess.setCommand(cmd);
                QObject::connect(&m_terminalProcess, &Process::done, this, [this] {
                    m_interface->onStubExited();
                });
                m_terminalProcess.setCreateConsoleOnWindows(true);
                m_terminalProcess.setProcessMode(ProcessMode::Writer);
                m_terminalProcess.start();
            } else if (HostOsInfo::isMacHost() && terminal.command == "Terminal.app") {
                QTemporaryFile f;
                f.setAutoRemove(false);
                f.open();
                f.setPermissions(QFile::ExeUser | QFile::ReadUser | QFile::WriteUser);
                f.write("#!/bin/sh\n");
                f.write("clear\n");
                f.write(QString("exec '%1' %2\n")
                            .arg(cmd.executable().nativePath())
                            .arg(cmd.arguments())
                            .toUtf8());
                f.close();

                const QString path = f.fileName();
                const QString exe
                    = QString("tell app \"Terminal\" to do script \"'%1'; rm -f '%1'; exit\"")
                          .arg(path);

                m_terminalProcess.setCommand(
                    {"osascript", {"-e", "tell app \"Terminal\" to activate", "-e", exe}});
                m_terminalProcess.runBlocking();
            } else {
                CommandLine cmdLine = {terminal.command, {terminal.executeArgs}};
                cmdLine.addCommandLineAsArgs(cmd, CommandLine::Raw);

                m_terminalProcess.setCommand(cmdLine);
                m_terminalProcess.start();
            }
        }

        ExternalTerminalProcessImpl *m_interface;
        Process m_terminalProcess;
    };

public:
    ExternalTerminalProcessImpl() { setStubCreator(new ProcessStubCreator(this)); }
};

class HooksPrivate
{
public:
    HooksPrivate()
        : m_getTerminalCommandsForDevicesHook([] { return QList<NameAndCommandLine>{}; })
    {
        auto openTerminal = [](const OpenTerminalParameters &parameters) {
            DeviceFileHooks::instance().openTerminal(parameters.workingDirectory.value_or(
                                                         FilePath{}),
                                                     parameters.environment.value_or(Environment{}));
        };
        auto createProcessInterface = []() { return new ExternalTerminalProcessImpl(); };

        addCallbackSet("External", {openTerminal, createProcessInterface});
    }

    void addCallbackSet(const QString &name, const Hooks::CallbackSet &callbackSet)
    {
        QMutexLocker lk(&m_mutex);
        m_callbackSets.push_back(qMakePair(name, callbackSet));

        m_createTerminalProcessInterface
            = m_callbackSets.back().second.createTerminalProcessInterface;
        m_openTerminal = m_callbackSets.back().second.openTerminal;
    }

    void removeCallbackSet(const QString &name)
    {
        if (name == "External")
            return;

        QMutexLocker lk(&m_mutex);
        m_callbackSets.removeIf([name](const auto &pair) { return pair.first == name; });

        m_createTerminalProcessInterface
            = m_callbackSets.back().second.createTerminalProcessInterface;
        m_openTerminal = m_callbackSets.back().second.openTerminal;
    }

    Hooks::CreateTerminalProcessInterface createTerminalProcessInterface()
    {
        QMutexLocker lk(&m_mutex);
        return m_createTerminalProcessInterface;
    }

    Hooks::OpenTerminal openTerminal()
    {
        QMutexLocker lk(&m_mutex);
        return m_openTerminal;
    }

    Hooks::GetTerminalCommandsForDevicesHook m_getTerminalCommandsForDevicesHook;

private:
    Hooks::OpenTerminal m_openTerminal;
    Hooks::CreateTerminalProcessInterface m_createTerminalProcessInterface;

    QMutex m_mutex;
    QList<QPair<QString, Hooks::CallbackSet>> m_callbackSets;
};

Hooks &Hooks::instance()
{
    static Hooks manager;
    return manager;
}

Hooks::Hooks()
    : d(new HooksPrivate())
{}

Hooks::~Hooks() = default;

void Hooks::openTerminal(const OpenTerminalParameters &parameters) const
{
    d->openTerminal()(parameters);
}

ProcessInterface *Hooks::createTerminalProcessInterface() const
{
    return d->createTerminalProcessInterface()();
}

Hooks::GetTerminalCommandsForDevicesHook &Hooks::getTerminalCommandsForDevicesHook()
{
    return d->m_getTerminalCommandsForDevicesHook;
}

void Hooks::addCallbackSet(const QString &name, const CallbackSet &callbackSet)
{
    d->addCallbackSet(name, callbackSet);
}

void Hooks::removeCallbackSet(const QString &name)
{
    d->removeCallbackSet(name);
}

} // namespace Utils::Terminal