-/***************************************************************************
- * Copyright (C) 2007-2010 by Peter Penz <peter.penz19@gmail.com> *
- * *
- * This program is free software; you can redistribute it and/or modify *
- * it under the terms of the GNU General Public License as published by *
- * the Free Software Foundation; either version 2 of the License, or *
- * (at your option) any later version. *
- * *
- * This program is distributed in the hope that it will be useful, *
- * but WITHOUT ANY WARRANTY; without even the implied warranty of *
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
- * GNU General Public License for more details. *
- * *
- * You should have received a copy of the GNU General Public License *
- * along with this program; if not, write to the *
- * Free Software Foundation, Inc., *
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
- ***************************************************************************/
+/*
+ * SPDX-FileCopyrightText: 2007-2010 Peter Penz <peter.penz19@gmail.com>
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
#include "terminalpanel.h"
-#include <signal.h>
-
-#include <KPluginLoader>
+#include <KIO/DesktopExecParser>
+#include <KIO/Job>
+#include <KIO/JobUiDelegate>
+#include <KJobWidgets>
+#include <KLocalizedString>
+#include <KMessageWidget>
+#include <KMountPoint>
+#include <KParts/ReadOnlyPart>
#include <KPluginFactory>
+#include <KPluginLoader>
+#include <KProtocolInfo>
#include <KService>
-#include <kde_terminal_interface_v2.h>
-#include <KParts/Part>
#include <KShell>
-#include <KIO/Job>
-#include <KIO/JobUiDelegate>
+#include <kde_terminal_interface.h>
-#include <QBoxLayout>
+#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(0),
- m_layout(0),
- m_terminal(0),
- m_terminalWidget(0),
- m_konsolePart(0),
- m_konsolePartCurrentDirectory()
+ 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->setMargin(0);
+ m_layout->setContentsMargins(0, 0, 0, 0);
}
TerminalPanel::~TerminalPanel()
{
}
+void TerminalPanel::goHome()
+{
+ sendCdToTerminal(QDir::homePath(), HistoryPolicy::SkipHistory);
+}
+
+QString TerminalPanel::currentWorkingDirectory()
+{
+ if (m_terminal) {
+ return m_terminal->currentWorkingDirectory();
+ }
+ return QString();
+}
+
void TerminalPanel::terminalExited()
{
- m_terminal = 0;
- emit hideTerminalPanel();
+ m_terminal = nullptr;
+ Q_EMIT hideTerminalPanel();
+}
+
+bool TerminalPanel::isHiddenInVisibleWindow() const
+{
+ return parentWidget()
+ && parentWidget()->isHidden();
}
void TerminalPanel::dockVisibilityChanged()
{
// Only react when the DockWidget itself (not some parent) is hidden. This way we don't
// respond when e.g. Dolphin is minimized.
- if (parentWidget() && parentWidget()->isHidden() &&
- m_terminal && (m_terminal->foregroundProcessId() == -1)) {
+ 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)));
// Make sure this terminal does not prevent unmounting any removable drives
- changeDir(KUrl::fromPath("/"));
+ changeDir(QUrl::fromLocalFile(QStringLiteral("/")));
// Because we have disconnected from the part's currentDirectoryChanged()
// signal, we have to update m_konsolePartCurrentDirectory manually. If this
}
}
+QString TerminalPanel::runningProgramName() const
+{
+ return m_terminal ? m_terminal->foregroundProcessName() : QString();
+}
+
+bool TerminalPanel::hasProgramRunning() const
+{
+ return m_terminal && (m_terminal->foregroundProcessId() != -1);
+}
+
bool TerminalPanel::urlChanged()
{
if (!url().isValid()) {
return false;
}
- const bool sendInput = m_terminal && (m_terminal->foregroundProcessId() == -1) && isVisible();
+ const bool sendInput = m_terminal && !hasProgramRunning() && isVisible();
if (sendInput) {
changeDir(url());
}
if (!m_terminal) {
m_clearTerminal = true;
- KPluginFactory* factory = 0;
- KService::Ptr service = KService::serviceByDesktopName("konsolepart");
+ KPluginFactory* factory = nullptr;
+ KService::Ptr service = KService::serviceByDesktopName(QStringLiteral("konsolepart"));
if (service) {
factory = KPluginLoader(service->library()).factory();
}
- m_konsolePart = factory ? (factory->create<KParts::ReadOnlyPart>(this)) : 0;
+ m_konsolePart = factory ? (factory->create<KParts::ReadOnlyPart>(this)) : nullptr;
if (m_konsolePart) {
- connect(m_konsolePart, SIGNAL(destroyed(QObject*)), this, SLOT(terminalExited()));
+ connect(m_konsolePart, &KParts::ReadOnlyPart::destroyed, this, &TerminalPanel::terminalExited);
m_terminalWidget = m_konsolePart->widget();
+ setFocusProxy(m_terminalWidget);
m_layout->addWidget(m_terminalWidget);
- m_terminal = qobject_cast<TerminalInterfaceV2 *>(m_konsolePart);
+ if (m_konsolePartMissingMessage) {
+ m_layout->removeWidget(m_konsolePartMissingMessage);
+ }
+ m_terminal = qobject_cast<TerminalInterface*>(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.");
+ m_konsolePartMissingMessage = new KMessageWidget(konsoleNotInstalledText, this);
+ m_konsolePartMissingMessage->setCloseButtonVisible(false);
+ m_konsolePartMissingMessage->hide();
+ if (KIO::DesktopExecParser::hasSchemeHandler(konsoleInstallUrl)) {
+ auto installKonsoleAction = new QAction(i18n("Install Konsole"), this);
+ connect(installKonsoleAction, &QAction::triggered, [konsoleInstallUrl]() {
+ QDesktopServices::openUrl(konsoleInstallUrl);
+ });
+ m_konsolePartMissingMessage->addAction(installKonsoleAction);
+ }
+ m_layout->addWidget(m_konsolePartMissingMessage);
+ m_layout->addStretch();
+ QTimer::singleShot(0, m_konsolePartMissingMessage, &KMessageWidget::animatedShow);
+ } else {
+ m_konsolePartMissingMessage->animatedShow();
}
}
if (m_terminal) {
m_terminal->showShellInDir(url().toLocalFile());
- changeDir(url());
+ if(!hasProgramRunning()) {
+ changeDir(url());
+ }
m_terminalWidget->setFocus();
connect(m_konsolePart, SIGNAL(currentDirectoryChanged(QString)),
this, SLOT(slotKonsolePartCurrentDirectoryChanged(QString)));
Panel::showEvent(event);
}
-void TerminalPanel::changeDir(const KUrl& url)
+void TerminalPanel::changeDir(const QUrl& url)
{
delete m_mostLocalUrlJob;
- m_mostLocalUrlJob = 0;
+ 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->ui()) {
- m_mostLocalUrlJob->ui()->setWindow(this);
+ if (m_mostLocalUrlJob->uiDelegate()) {
+ KJobWidgets::setWindow(m_mostLocalUrlJob, this);
}
- connect(m_mostLocalUrlJob, SIGNAL(result(KJob*)), this, SLOT(slotMostLocalUrlResult(KJob*)));
+ connect(m_mostLocalUrlJob, &KIO::StatJob::result, this, &TerminalPanel::slotMostLocalUrlResult);
+ return;
}
+
+ // Last chance, try KIOFuse
+ sendCdToTerminalKIOFuse(url);
}
-void TerminalPanel::sendCdToTerminal(const QString& dir)
+void TerminalPanel::sendCdToTerminal(const QString& dir, HistoryPolicy addToHistory)
{
if (dir == m_konsolePartCurrentDirectory) {
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 send.
+ // 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');
- m_konsolePartCurrentDirectory = dir;
+
+ // 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
+ // user entered in the panel. Therefore, we have to remember 'dir'. Note that it could also be
+ // a symbolic link -> remember the 'canonical' path.
+ if (addToHistory == HistoryPolicy::AddToHistory)
+ m_sendCdToTerminalHistory.enqueue(QDir(dir).canonicalPath());
if (m_clearTerminal) {
- m_terminal->sendInput(" clear\n");
+ m_terminal->sendInput(QStringLiteral(" clear\n"));
m_clearTerminal = false;
}
}
+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) {
+ 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 KUrl url = statJob->mostLocalUrl();
+ const QUrl url = statJob->mostLocalUrl();
if (url.isLocalFile()) {
sendCdToTerminal(url.toLocalFile());
+ } else {
+ sendCdToTerminalKIOFuse(url);
}
- m_mostLocalUrlJob = 0;
+ m_mostLocalUrlJob = nullptr;
}
void TerminalPanel::slotKonsolePartCurrentDirectoryChanged(const QString& dir)
{
- m_konsolePartCurrentDirectory = dir;
+ m_konsolePartCurrentDirectory = QDir(dir).canonicalPath();
+
+ // Only emit a changeUrl signal if the directory change was caused by the user inside the
+ // terminal, and not by sendCdToTerminal(QString).
+ while (!m_sendCdToTerminalHistory.empty()) {
+ if (m_konsolePartCurrentDirectory == m_sendCdToTerminalHistory.dequeue()) {
+ return;
+ }
+ }
+
+ // User may potentially be browsing inside a KIOFuse mount.
+ // If so lets try and change the DolphinView to point to the remote URL equivalent.
+ // instead of into the KIOFuse mount itself (which can cause performance issues!)
+ const QUrl url(QUrl::fromLocalFile(dir));
- // Only change the view URL if 'dir' is different from the current view URL.
- // Note that the current view URL could also be a symbolic link to 'dir'
- // -> use QDir::canonicalPath() to check that.
- const KUrl oldUrl(url());
- const KUrl newUrl(dir);
- if (newUrl != oldUrl && dir != QDir(oldUrl.path()).canonicalPath()) {
- emit changeUrl(newUrl);
+ 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.
+ Q_EMIT changeUrl(url);
+ return;
}
+
+ auto reply = m_kiofuseInterface.remoteUrl(m_konsolePartCurrentDirectory);
+ 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
+ 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.
+ Q_EMIT changeUrl(QUrl::fromUserInput(reply.value()));
+ }
+ });
}
-#include "terminalpanel.moc"
+bool TerminalPanel::terminalHasFocus() const
+{
+ if (m_terminalWidget) {
+ return m_terminalWidget->hasFocus();
+ }
+
+ return hasFocus();
+}