TerminalPanel: rename currentWorkingDirectoryIsParentOf to currentWorkingDirectoryIsC...

[dolphin.git] / src / panels / terminal / terminalpanel.cpp

diff --git a/src/panels/terminal/terminalpanel.cpp b/src/panels/terminal/terminalpanel.cpp
index 131d166304a01fe08160e7c43f42629afa905b3e..9e0391c41335aa3b9b83d8efd9ed7e7bb0346f65 100644 (file)
--- a/src/panels/terminal/terminalpanel.cpp
+++ b/src/panels/terminal/terminalpanel.cpp
@@ -5,44 +5,41 @@
  */
 
 #include "terminalpanel.h"
  */
 
 #include "terminalpanel.h"

-#include "kiofuse_interface.h"

 
 

+#include <KActionCollection>

 #include <KIO/DesktopExecParser>
 #include <KIO/Job>
 #include <KIO/DesktopExecParser>
 #include <KIO/Job>

-#include <KIO/JobUiDelegate>

 #include <KJobWidgets>
 #include <KLocalizedString>
 #include <KMessageWidget>
 #include <KMountPoint>
 #include <KParts/ReadOnlyPart>
 #include <KPluginFactory>
 #include <KJobWidgets>
 #include <KLocalizedString>
 #include <KMessageWidget>
 #include <KMountPoint>
 #include <KParts/ReadOnlyPart>
 #include <KPluginFactory>

-#include <KPluginLoader>
-#include <KService>
+#include <KProtocolInfo>

 #include <KShell>
 #include <KShell>

+#include <KXMLGUIBuilder>
+#include <KXMLGUIFactory>

 #include <kde_terminal_interface.h>
 
 #include <QAction>
 #include <QDesktopServices>
 #include <QDir>
 #include <kde_terminal_interface.h>
 
 #include <QAction>
 #include <QDesktopServices>
 #include <QDir>

-#include <QLabel>

 #include <QShowEvent>
 #include <QTimer>
 #include <QVBoxLayout>
 
 #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);
 {
     m_layout = new QVBoxLayout(this);
     m_layout->setContentsMargins(0, 0, 0, 0);


@@ -57,24 +54,23 @@ void TerminalPanel::goHome()
     sendCdToTerminal(QDir::homePath(), HistoryPolicy::SkipHistory);
 }
 
     sendCdToTerminal(QDir::homePath(), HistoryPolicy::SkipHistory);
 }
 

-QString TerminalPanel::currentWorkingDirectory()
+bool TerminalPanel::currentWorkingDirectoryIsChildOf(const QString &path) const

 {
     if (m_terminal) {
 {
     if (m_terminal) {

-        return m_terminal->currentWorkingDirectory();
+        return m_terminal->currentWorkingDirectory().startsWith(path);

     }
     }

-    return QString();
+    return false;

 }
 
 void TerminalPanel::terminalExited()
 {
     m_terminal = nullptr;
 }
 
 void TerminalPanel::terminalExited()
 {
     m_terminal = nullptr;

-    emit hideTerminalPanel();
+    Q_EMIT hideTerminalPanel();

 }
 
 bool TerminalPanel::isHiddenInVisibleWindow() const
 {
 }
 
 bool TerminalPanel::isHiddenInVisibleWindow() const
 {

-    return parentWidget()
-        && parentWidget()->isHidden();
+    return parentWidget() && parentWidget()->isHidden();

 }
 
 void TerminalPanel::dockVisibilityChanged()
 }
 
 void TerminalPanel::dockVisibilityChanged()


@@ -83,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.
     // 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("/")));
 
         // Make sure this terminal does not prevent unmounting any removable drives
         changeDir(QUrl::fromLocalFile(QStringLiteral("/")));


@@ -102,6 +97,21 @@ QString TerminalPanel::runningProgramName() const
     return m_terminal ? m_terminal->foregroundProcessName() : QString();
 }
 
     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);
 bool TerminalPanel::hasProgramRunning() const
 {
     return m_terminal && (m_terminal->foregroundProcessId() != -1);


@@ -121,7 +131,7 @@ bool TerminalPanel::urlChanged()
     return true;
 }
 
     return true;
 }
 

-void TerminalPanel::showEvent(QShowEvent* event)
+void TerminalPanel::showEvent(QShowEvent *event)

 {
     if (event->spontaneous()) {
         Panel::showEvent(event);
 {
     if (event->spontaneous()) {
         Panel::showEvent(event);


@@ -130,11 +140,7 @@ void TerminalPanel::showEvent(QShowEvent* event)
 
     if (!m_terminal) {
         m_clearTerminal = true;
 
     if (!m_terminal) {
         m_clearTerminal = true;

-        KPluginFactory* factory = nullptr;
-        KService::Ptr service = KService::serviceByDesktopName(QStringLiteral("konsolepart"));
-        if (service) {
-            factory = KPluginLoader(service->library()).factory();
-        }
+        KPluginFactory *factory = KPluginFactory::loadFactory(KPluginMetaData(QStringLiteral("konsolepart"))).plugin;

         m_konsolePart = factory ? (factory->create<KParts::ReadOnlyPart>(this)) : nullptr;
         if (m_konsolePart) {
             connect(m_konsolePart, &KParts::ReadOnlyPart::destroyed, this, &TerminalPanel::terminalExited);
         m_konsolePart = factory ? (factory->create<KParts::ReadOnlyPart>(this)) : nullptr;
         if (m_konsolePart) {
             connect(m_konsolePart, &KParts::ReadOnlyPart::destroyed, this, &TerminalPanel::terminalExited);


@@ -144,11 +150,29 @@ void TerminalPanel::showEvent(QShowEvent* event)
             if (m_konsolePartMissingMessage) {
                 m_layout->removeWidget(m_konsolePartMissingMessage);
             }
             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");
         } 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();
             m_konsolePartMissingMessage = new KMessageWidget(konsoleNotInstalledText, this);
             m_konsolePartMissingMessage->setCloseButtonVisible(false);
             m_konsolePartMissingMessage->hide();


@@ -168,54 +192,53 @@ void TerminalPanel::showEvent(QShowEvent* event)
     }
     if (m_terminal) {
         m_terminal->showShellInDir(url().toLocalFile());
     }
     if (m_terminal) {
         m_terminal->showShellInDir(url().toLocalFile());

-        if(!hasProgramRunning()) {
+        if (!hasProgramRunning()) {

             changeDir(url());
         }
         m_terminalWidget->setFocus();
             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);
 }
 
     }
 
     Panel::showEvent(event);
 }
 

-void TerminalPanel::changeDir(const QUrl& url)
+void TerminalPanel::changeDir(const QUrl &url)

 {
     delete m_mostLocalUrlJob;
     m_mostLocalUrlJob = nullptr;
 
     if (url.isLocalFile()) {
         sendCdToTerminal(url.toLocalFile());
 {
     delete m_mostLocalUrlJob;
     m_mostLocalUrlJob = nullptr;
 
     if (url.isLocalFile()) {
         sendCdToTerminal(url.toLocalFile());

-    } else {
+        return;
+    }
+
+    // Try stat'ing the url; note that mostLocalUrl only works with ":local" protocols
+    if (KProtocolInfo::protocolClass(url.scheme()) == QLatin1String(":local")) {

         m_mostLocalUrlJob = KIO::mostLocalUrl(url, KIO::HideProgressInfo);
         if (m_mostLocalUrlJob->uiDelegate()) {
             KJobWidgets::setWindow(m_mostLocalUrlJob, this);
         }
         connect(m_mostLocalUrlJob, &KIO::StatJob::result, this, &TerminalPanel::slotMostLocalUrlResult);
         m_mostLocalUrlJob = KIO::mostLocalUrl(url, KIO::HideProgressInfo);
         if (m_mostLocalUrlJob->uiDelegate()) {
             KJobWidgets::setWindow(m_mostLocalUrlJob, this);
         }
         connect(m_mostLocalUrlJob, &KIO::StatJob::result, this, &TerminalPanel::slotMostLocalUrlResult);

+        return;

     }
     }

+
+    // Last chance, try KIOFuse
+    sendCdToTerminalKIOFuse(url);

 }
 
 }
 

-void TerminalPanel::sendCdToTerminal(const QString& dir, 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;
     }
 
         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
 
     // 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


@@ -224,37 +247,44 @@ void TerminalPanel::sendCdToTerminal(const QString& dir, HistoryPolicy addToHist
     if (addToHistory == HistoryPolicy::AddToHistory)
         m_sendCdToTerminalHistory.enqueue(QDir(dir).canonicalPath());
 
     if (addToHistory == HistoryPolicy::AddToHistory)
         m_sendCdToTerminalHistory.enqueue(QDir(dir).canonicalPath());
 

+    m_terminal->sendInput(" cd " + KShell::quoteArg(dir) + '\r');
+

     if (m_clearTerminal) {
     if (m_clearTerminal) {

-        m_terminal->sendInput(QStringLiteral(" clear\n"));
+        m_terminal->sendInput(QStringLiteral(" clear\r"));

         m_clearTerminal = false;
     }
 }
 
         m_clearTerminal = false;
     }
 }
 

-void TerminalPanel::slotMostLocalUrlResult(KJob* job)
+void TerminalPanel::sendCdToTerminalKIOFuse(const QUrl &url)

 {
 {

-    KIO::StatJob* statJob = static_cast<KIO::StatJob *>(job);
+    // 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) {
+        watcher->deleteLater();
+        if (!reply.isError()) {
+            // Successfully mounted, point to the KIOFuse equivalent path.
+            sendCdToTerminal(reply.value());
+        }
+    });
+}
+
+void TerminalPanel::slotMostLocalUrlResult(KJob *job)
+{
+    KIO::StatJob *statJob = static_cast<KIO::StatJob *>(job);

     const QUrl url = statJob->mostLocalUrl();
     if (url.isLocalFile()) {
         sendCdToTerminal(url.toLocalFile());
     } else {
     const QUrl url = statJob->mostLocalUrl();
     if (url.isLocalFile()) {
         sendCdToTerminal(url.toLocalFile());
     } else {

-        // 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) {
-            watcher->deleteLater();
-            if (!reply.isError()) {
-                // Successfully mounted, point to the KIOFuse equivalent path.
-                sendCdToTerminal(reply.value());
-            }
-        });
+        sendCdToTerminalKIOFuse(url);

     }
 
     m_mostLocalUrlJob = nullptr;
 }
 
     }
 
     m_mostLocalUrlJob = nullptr;
 }
 

-void TerminalPanel::slotKonsolePartCurrentDirectoryChanged(const QString& dir)
+void TerminalPanel::slotKonsolePartCurrentDirectoryChanged(const QString &dir)

 {
     m_konsolePartCurrentDirectory = QDir(dir).canonicalPath();
 
 {
     m_konsolePartCurrentDirectory = QDir(dir).canonicalPath();
 


@@ -274,21 +304,21 @@ void TerminalPanel::slotKonsolePartCurrentDirectoryChanged(const QString& dir)
     KMountPoint::Ptr mountPoint = KMountPoint::currentMountPoints().findByPath(m_konsolePartCurrentDirectory);
     if (mountPoint && mountPoint->mountType() != QStringLiteral("fuse.kio-fuse")) {
         // Not in KIOFUse mount, so just switch to the corresponding URL.
     KMountPoint::Ptr mountPoint = KMountPoint::currentMountPoints().findByPath(m_konsolePartCurrentDirectory);
     if (mountPoint && mountPoint->mountType() != QStringLiteral("fuse.kio-fuse")) {
         // Not in KIOFUse mount, so just switch to the corresponding URL.

-        emit changeUrl(url);
+        Q_EMIT changeUrl(url);

         return;
     }
 
     auto reply = m_kiofuseInterface.remoteUrl(m_konsolePartCurrentDirectory);
         return;
     }
 
     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
         watcher->deleteLater();
         if (reply.isError()) {
             // KIOFuse errored out... just show the normal URL

-            emit changeUrl(url);
+            Q_EMIT changeUrl(url);

         } else {
             // Our location happens to be in a KIOFuse mount and is mounted.
             // Let's change the DolphinView to point to the remote URL equivalent.
         } else {
             // Our location happens to be in a KIOFuse mount and is mounted.
             // Let's change the DolphinView to point to the remote URL equivalent.

-            emit changeUrl(QUrl::fromUserInput(reply.value()));
+            Q_EMIT changeUrl(QUrl::fromUserInput(reply.value()));

         }
     });
 }
         }
     });
 }