]> cloud.milkyroute.net Git - dolphin.git/blobdiff - src/panels/terminal/terminalpanel.cpp
Add clang-format and format code as in Frameworks
[dolphin.git] / src / panels / terminal / terminalpanel.cpp
index 9d30dcd62be640c4e6acbebf01f944ec2a3f7f5a..53464e620aa0f45c0e962d7cac57e30ff80a612e 100644 (file)
@@ -6,9 +6,9 @@
 
 #include "terminalpanel.h"
 
+#include <KActionCollection>
 #include <KIO/DesktopExecParser>
 #include <KIO/Job>
-#include <KIO/JobUiDelegate>
 #include <KJobWidgets>
 #include <KLocalizedString>
 #include <KMessageWidget>
 #include <KPluginFactory>
 #include <KProtocolInfo>
 #include <KShell>
+#include <KXMLGUIBuilder>
+#include <KXMLGUIFactory>
 #include <kde_terminal_interface.h>
 
 #include <QAction>
 #include <QDesktopServices>
 #include <QDir>
-#include <QLabel>
 #include <QShowEvent>
 #include <QTimer>
 #include <QVBoxLayout>
 
-TerminalPanel::TerminalPanel(QWidget* parent) :
-    Panel(parent),
-    m_clearTerminal(true),
-    m_mostLocalUrlJob(nullptr),
-    m_layout(nullptr),
-    m_terminal(nullptr),
-    m_terminalWidget(nullptr),
-    m_konsolePartMissingMessage(nullptr),
-    m_konsolePart(nullptr),
-    m_konsolePartCurrentDirectory(),
-    m_sendCdToTerminalHistory(),
-    m_kiofuseInterface(QStringLiteral("org.kde.KIOFuse"),
-                       QStringLiteral("/org/kde/KIOFuse"),
-                       QDBusConnection::sessionBus())
+TerminalPanel::TerminalPanel(QWidget *parent)
+    : Panel(parent)
+    , m_clearTerminal(true)
+    , m_mostLocalUrlJob(nullptr)
+    , m_layout(nullptr)
+    , m_terminal(nullptr)
+    , m_terminalWidget(nullptr)
+    , m_konsolePartMissingMessage(nullptr)
+    , m_konsolePart(nullptr)
+    , m_konsolePartCurrentDirectory()
+    , m_sendCdToTerminalHistory()
+    , m_kiofuseInterface(QStringLiteral("org.kde.KIOFuse"), QStringLiteral("/org/kde/KIOFuse"), QDBusConnection::sessionBus())
 {
     m_layout = new QVBoxLayout(this);
     m_layout->setContentsMargins(0, 0, 0, 0);
@@ -71,8 +70,7 @@ void TerminalPanel::terminalExited()
 
 bool TerminalPanel::isHiddenInVisibleWindow() const
 {
-    return parentWidget()
-        && parentWidget()->isHidden();
+    return parentWidget() && parentWidget()->isHidden();
 }
 
 void TerminalPanel::dockVisibilityChanged()
@@ -81,8 +79,7 @@ void TerminalPanel::dockVisibilityChanged()
     // respond when e.g. Dolphin is minimized.
     if (isHiddenInVisibleWindow() && m_terminal && !hasProgramRunning()) {
         // Make sure that the following "cd /" command will not affect the view.
-        disconnect(m_konsolePart, SIGNAL(currentDirectoryChanged(QString)),
-                   this, SLOT(slotKonsolePartCurrentDirectoryChanged(QString)));
+        disconnect(m_konsolePart, SIGNAL(currentDirectoryChanged(QString)), this, SLOT(slotKonsolePartCurrentDirectoryChanged(QString)));
 
         // Make sure this terminal does not prevent unmounting any removable drives
         changeDir(QUrl::fromLocalFile(QStringLiteral("/")));
@@ -100,6 +97,21 @@ QString TerminalPanel::runningProgramName() const
     return m_terminal ? m_terminal->foregroundProcessName() : QString();
 }
 
+KActionCollection *TerminalPanel::actionCollection()
+{
+    // m_terminal is the only reference reset to nullptr in case the terminal is
+    // closed again
+    if (m_terminal && m_konsolePart && m_terminalWidget) {
+        const auto guiClients = m_konsolePart->childClients();
+        for (auto *client : guiClients) {
+            if (client->actionCollection()->associatedWidgets().contains(m_terminalWidget)) {
+                return client->actionCollection();
+            }
+        }
+    }
+    return nullptr;
+}
+
 bool TerminalPanel::hasProgramRunning() const
 {
     return m_terminal && (m_terminal->foregroundProcessId() != -1);
@@ -119,7 +131,7 @@ bool TerminalPanel::urlChanged()
     return true;
 }
 
-void TerminalPanel::showEvent(QShowEventevent)
+void TerminalPanel::showEvent(QShowEvent *event)
 {
     if (event->spontaneous()) {
         Panel::showEvent(event);
@@ -138,11 +150,29 @@ void TerminalPanel::showEvent(QShowEvent* event)
             if (m_konsolePartMissingMessage) {
                 m_layout->removeWidget(m_konsolePartMissingMessage);
             }
-            m_terminal = qobject_cast<TerminalInterface*>(m_konsolePart);
+            m_terminal = qobject_cast<TerminalInterface *>(m_konsolePart);
+
+            // needed to collect the correct KonsolePart actionCollection
+            // namely the one of the single inner terminal and not the outer KonsolePart
+            if (!m_konsolePart->factory() && m_terminalWidget) {
+                if (!m_konsolePart->clientBuilder()) {
+                    m_konsolePart->setClientBuilder(new KXMLGUIBuilder(m_terminalWidget));
+                }
+
+                auto factory = new KXMLGUIFactory(m_konsolePart->clientBuilder(), this);
+                factory->addClient(m_konsolePart);
+
+                // Prevents the KXMLGui warning about removing the client
+                connect(m_terminalWidget, &QObject::destroyed, this, [factory, this] {
+                    factory->removeClient(m_konsolePart);
+                });
+            }
+
         } else if (!m_konsolePartMissingMessage) {
             const auto konsoleInstallUrl = QUrl("appstream://org.kde.konsole.desktop");
-            const auto konsoleNotInstalledText = i18n("Terminal cannot be shown because Konsole is not installed. "
-                                                      "Please install it and then reopen the panel.");
+            const auto konsoleNotInstalledText = i18n(
+                "Terminal cannot be shown because Konsole is not installed. "
+                "Please install it and then reopen the panel.");
             m_konsolePartMissingMessage = new KMessageWidget(konsoleNotInstalledText, this);
             m_konsolePartMissingMessage->setCloseButtonVisible(false);
             m_konsolePartMissingMessage->hide();
@@ -162,18 +192,17 @@ void TerminalPanel::showEvent(QShowEvent* event)
     }
     if (m_terminal) {
         m_terminal->showShellInDir(url().toLocalFile());
-        if(!hasProgramRunning()) {
+        if (!hasProgramRunning()) {
             changeDir(url());
         }
         m_terminalWidget->setFocus();
-        connect(m_konsolePart, SIGNAL(currentDirectoryChanged(QString)),
-                this, SLOT(slotKonsolePartCurrentDirectoryChanged(QString)));
+        connect(m_konsolePart, SIGNAL(currentDirectoryChanged(QString)), this, SLOT(slotKonsolePartCurrentDirectoryChanged(QString)));
     }
 
     Panel::showEvent(event);
 }
 
-void TerminalPanel::changeDir(const QUrlurl)
+void TerminalPanel::changeDir(const QUrl &url)
 {
     delete m_mostLocalUrlJob;
     m_mostLocalUrlJob = nullptr;
@@ -197,27 +226,19 @@ void TerminalPanel::changeDir(const QUrl& url)
     sendCdToTerminalKIOFuse(url);
 }
 
-void TerminalPanel::sendCdToTerminal(const QStringdir, HistoryPolicy addToHistory)
+void TerminalPanel::sendCdToTerminal(const QString &dir, HistoryPolicy addToHistory)
 {
-    if (dir == m_konsolePartCurrentDirectory) {
+    if (dir == m_konsolePartCurrentDirectory // We are already there
+        && m_sendCdToTerminalHistory.isEmpty() // â€¦and that is not because the terminal couldn't keep up
+    ) {
         m_clearTerminal = false;
         return;
     }
 
-#ifndef Q_OS_WIN
-    if (!m_clearTerminal) {
-        // The TerminalV2 interface does not provide a way to delete the
-        // current line before sending a new input. This is mandatory,
-        // otherwise sending a 'cd x' to a existing 'rm -rf *' might
-        // result in data loss. As workaround SIGINT is sent.
-        const int processId = m_terminal->terminalProcessId();
-        if (processId > 0) {
-            kill(processId, SIGINT);
-        }
-    }
-#endif
-
-    m_terminal->sendInput(" cd " + KShell::quoteArg(dir) + '\n');
+    // Send prior Ctrl-E, Ctrl-U to ensure the line is empty. This is
+    // mandatory, otherwise sending a 'cd x\n' to a prompt with 'rm -rf *'
+    // would result in data loss.
+    m_terminal->sendInput(QStringLiteral("\x05\x15"));
 
     // We want to ignore the currentDirectoryChanged(QString) signal, which we will receive after
     // the directory change, because this directory change is not caused by a "cd" command that the
@@ -226,19 +247,22 @@ void TerminalPanel::sendCdToTerminal(const QString& dir, HistoryPolicy addToHist
     if (addToHistory == HistoryPolicy::AddToHistory)
         m_sendCdToTerminalHistory.enqueue(QDir(dir).canonicalPath());
 
+    m_terminal->sendInput(" cd " + KShell::quoteArg(dir) + '\r');
+
     if (m_clearTerminal) {
-        m_terminal->sendInput(QStringLiteral(" clear\n"));
+        m_terminal->sendInput(QStringLiteral(" clear\r"));
         m_clearTerminal = false;
     }
 }
 
-void TerminalPanel::sendCdToTerminalKIOFuse(const QUrl &url) {
+void TerminalPanel::sendCdToTerminalKIOFuse(const QUrl &url)
+{
     // URL isn't local, only hope for the terminal to be in sync with the
     // DolphinView is to mount the remote URL in KIOFuse and point to it.
     // If we can't do that for any reason, silently fail.
     auto reply = m_kiofuseInterface.mountUrl(url.toString());
-    QDBusPendingCallWatcher * watcher = new QDBusPendingCallWatcher(reply, this);
-    QObject::connect(watcher, &QDBusPendingCallWatcher::finished, this, [=] (QDBusPendingCallWatcher* watcher) {
+    QDBusPendingCallWatcher *watcher = new QDBusPendingCallWatcher(reply, this);
+    QObject::connect(watcher, &QDBusPendingCallWatcher::finished, this, [=](QDBusPendingCallWatcher *watcher) {
         watcher->deleteLater();
         if (!reply.isError()) {
             // Successfully mounted, point to the KIOFuse equivalent path.
@@ -247,9 +271,9 @@ void TerminalPanel::sendCdToTerminalKIOFuse(const QUrl &url) {
     });
 }
 
-void TerminalPanel::slotMostLocalUrlResult(KJobjob)
+void TerminalPanel::slotMostLocalUrlResult(KJob *job)
 {
-    KIO::StatJobstatJob = static_cast<KIO::StatJob *>(job);
+    KIO::StatJob *statJob = static_cast<KIO::StatJob *>(job);
     const QUrl url = statJob->mostLocalUrl();
     if (url.isLocalFile()) {
         sendCdToTerminal(url.toLocalFile());
@@ -260,7 +284,7 @@ void TerminalPanel::slotMostLocalUrlResult(KJob* job)
     m_mostLocalUrlJob = nullptr;
 }
 
-void TerminalPanel::slotKonsolePartCurrentDirectoryChanged(const QStringdir)
+void TerminalPanel::slotKonsolePartCurrentDirectoryChanged(const QString &dir)
 {
     m_konsolePartCurrentDirectory = QDir(dir).canonicalPath();
 
@@ -285,8 +309,8 @@ void TerminalPanel::slotKonsolePartCurrentDirectoryChanged(const QString& dir)
     }
 
     auto reply = m_kiofuseInterface.remoteUrl(m_konsolePartCurrentDirectory);
-    QDBusPendingCallWatcher * watcher = new QDBusPendingCallWatcher(reply, this);
-    QObject::connect(watcher, &QDBusPendingCallWatcher::finished, this, [=] (QDBusPendingCallWatcher* watcher) {
+    QDBusPendingCallWatcher *watcher = new QDBusPendingCallWatcher(reply, this);
+    QObject::connect(watcher, &QDBusPendingCallWatcher::finished, this, [=](QDBusPendingCallWatcher *watcher) {
         watcher->deleteLater();
         if (reply.isError()) {
             // KIOFuse errored out... just show the normal URL