src/panels/terminal/terminalpanel.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2007-2010 by Peter Penz <peter.penz19@gmail.com>        *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  18  ***************************************************************************/
  19
  20 #include "terminalpanel.h"
  21
  22 #include <KIO/DesktopExecParser>
  23 #include <KIO/Job>
  24 #include <KIO/JobUiDelegate>
  25 #include <KJobWidgets>
  26 #include <KLocalizedString>
  27 #include <KMessageWidget>
  28 #include <KParts/ReadOnlyPart>
  29 #include <KPluginFactory>
  30 #include <KPluginLoader>
  31 #include <KService>
  32 #include <KShell>
  33 #include <kde_terminal_interface.h>
  34
  35 #include <QAction>
  36 #include <QDesktopServices>
  37 #include <QDir>
  38 #include <QLabel>
  39 #include <QShowEvent>
  40 #include <QTimer>
  41 #include <QVBoxLayout>
  42
  43 TerminalPanel::TerminalPanel(QWidget* parent) :
  44     Panel(parent),
  45     m_clearTerminal(true),
  46     m_mostLocalUrlJob(nullptr),
  47     m_layout(nullptr),
  48     m_terminal(nullptr),
  49     m_terminalWidget(nullptr),
  50     m_konsolePartMissingMessage(nullptr),
  51     m_konsolePart(nullptr),
  52     m_konsolePartCurrentDirectory(),
  53     m_sendCdToTerminalHistory()
  54 {
  55     m_layout = new QVBoxLayout(this);
  56     m_layout->setMargin(0);
  57 }
  58
  59 TerminalPanel::~TerminalPanel()
  60 {
  61 }
  62
  63 void TerminalPanel::goHome()
  64 {
  65     sendCdToTerminal(QDir::homePath(), HistoryPolicy::SkipHistory);
  66 }
  67
  68 QString TerminalPanel::currentWorkingDirectory()
  69 {
  70     if (m_terminal) {
  71         return m_terminal->currentWorkingDirectory();
  72     }
  73     return QString();
  74 }
  75
  76 void TerminalPanel::terminalExited()
  77 {
  78     m_terminal = nullptr;
  79     emit hideTerminalPanel();
  80 }
  81
  82 bool TerminalPanel::isHiddenInVisibleWindow() const
  83 {
  84     return parentWidget()
  85         && parentWidget()->isHidden()
  86         && m_terminal
  87         && !hasProgramRunning();
  88 }
  89
  90 void TerminalPanel::dockVisibilityChanged()
  91 {
  92     // Only react when the DockWidget itself (not some parent) is hidden. This way we don't
  93     // respond when e.g. Dolphin is minimized.
  94     if (isHiddenInVisibleWindow()) {
  95         // Make sure that the following "cd /" command will not affect the view.
  96         disconnect(m_konsolePart, SIGNAL(currentDirectoryChanged(QString)),
  97                    this, SLOT(slotKonsolePartCurrentDirectoryChanged(QString)));
  98
  99         // Make sure this terminal does not prevent unmounting any removable drives
 100         changeDir(QUrl::fromLocalFile(QStringLiteral("/")));
 101
 102         // Because we have disconnected from the part's currentDirectoryChanged()
 103         // signal, we have to update m_konsolePartCurrentDirectory manually. If this
 104         // was not done, showing the panel again might not set the part's working
 105         // directory correctly.
 106         m_konsolePartCurrentDirectory = '/';
 107     }
 108 }
 109
 110 QString TerminalPanel::runningProgramName() const
 111 {
 112     return m_terminal ? m_terminal->foregroundProcessName() : QString();
 113 }
 114
 115 bool TerminalPanel::hasProgramRunning() const
 116 {
 117     return m_terminal && (m_terminal->foregroundProcessId() != -1);
 118 }
 119
 120 bool TerminalPanel::urlChanged()
 121 {
 122     if (!url().isValid()) {
 123         return false;
 124     }
 125
 126     const bool sendInput = m_terminal && !hasProgramRunning() && isVisible();
 127     if (sendInput) {
 128         changeDir(url());
 129     }
 130
 131     return true;
 132 }
 133
 134 void TerminalPanel::showEvent(QShowEvent* event)
 135 {
 136     if (event->spontaneous()) {
 137         Panel::showEvent(event);
 138         return;
 139     }
 140
 141     if (!m_terminal) {
 142         m_clearTerminal = true;
 143         KPluginFactory* factory = nullptr;
 144         KService::Ptr service = KService::serviceByDesktopName(QStringLiteral("konsolepart"));
 145         if (service) {
 146             factory = KPluginLoader(service->library()).factory();
 147         }
 148         m_konsolePart = factory ? (factory->create<KParts::ReadOnlyPart>(this)) : nullptr;
 149         if (m_konsolePart) {
 150             connect(m_konsolePart, &KParts::ReadOnlyPart::destroyed, this, &TerminalPanel::terminalExited);
 151             m_terminalWidget = m_konsolePart->widget();
 152             m_layout->addWidget(m_terminalWidget);
 153             if (m_konsolePartMissingMessage) {
 154                 m_layout->removeWidget(m_konsolePartMissingMessage);
 155             }
 156             m_terminal = qobject_cast<TerminalInterface*>(m_konsolePart);
 157         } else if (!m_konsolePartMissingMessage) {
 158             const auto konsoleInstallUrl = QUrl("appstream://org.kde.konsole.desktop");
 159             const auto konsoleNotInstalledText = i18n("Terminal cannot be shown because Konsole is not installed. "
 160                                                       "Please install it and then reopen the panel.");
 161             m_konsolePartMissingMessage = new KMessageWidget(konsoleNotInstalledText, this);
 162             m_konsolePartMissingMessage->setCloseButtonVisible(false);
 163             m_konsolePartMissingMessage->hide();
 164             if (KIO::DesktopExecParser::hasSchemeHandler(konsoleInstallUrl)) {
 165                 auto installKonsoleAction = new QAction(i18n("Install Konsole"), this);
 166                 connect(installKonsoleAction, &QAction::triggered, [konsoleInstallUrl]() {
 167                     QDesktopServices::openUrl(konsoleInstallUrl);
 168                 });
 169                 m_konsolePartMissingMessage->addAction(installKonsoleAction);
 170             }
 171             m_layout->addWidget(m_konsolePartMissingMessage);
 172             m_layout->addStretch();
 173             QTimer::singleShot(0, m_konsolePartMissingMessage, &KMessageWidget::animatedShow);
 174         } else {
 175             m_konsolePartMissingMessage->animatedShow();
 176         }
 177     }
 178     if (m_terminal) {
 179         m_terminal->showShellInDir(url().toLocalFile());
 180         changeDir(url());
 181         m_terminalWidget->setFocus();
 182         connect(m_konsolePart, SIGNAL(currentDirectoryChanged(QString)),
 183                 this, SLOT(slotKonsolePartCurrentDirectoryChanged(QString)));
 184     }
 185
 186     Panel::showEvent(event);
 187 }
 188
 189 void TerminalPanel::changeDir(const QUrl& url)
 190 {
 191     delete m_mostLocalUrlJob;
 192     m_mostLocalUrlJob = nullptr;
 193
 194     if (url.isLocalFile()) {
 195         sendCdToTerminal(url.toLocalFile());
 196     } else {
 197         m_mostLocalUrlJob = KIO::mostLocalUrl(url, KIO::HideProgressInfo);
 198         if (m_mostLocalUrlJob->uiDelegate()) {
 199             KJobWidgets::setWindow(m_mostLocalUrlJob, this);
 200         }
 201         connect(m_mostLocalUrlJob, &KIO::StatJob::result, this, &TerminalPanel::slotMostLocalUrlResult);
 202     }
 203 }
 204
 205 void TerminalPanel::sendCdToTerminal(const QString& dir, HistoryPolicy addToHistory)
 206 {
 207     if (dir == m_konsolePartCurrentDirectory) {
 208         m_clearTerminal = false;
 209         return;
 210     }
 211
 212 #ifndef Q_OS_WIN
 213     if (!m_clearTerminal) {
 214         // The TerminalV2 interface does not provide a way to delete the
 215         // current line before sending a new input. This is mandatory,
 216         // otherwise sending a 'cd x' to a existing 'rm -rf *' might
 217         // result in data loss. As workaround SIGINT is sent.
 218         const int processId = m_terminal->terminalProcessId();
 219         if (processId > 0) {
 220             kill(processId, SIGINT);
 221         }
 222     }
 223 #endif
 224
 225     m_terminal->sendInput(" cd " + KShell::quoteArg(dir) + '\n');
 226
 227     // We want to ignore the currentDirectoryChanged(QString) signal, which we will receive after
 228     // the directory change, because this directory change is not caused by a "cd" command that the
 229     // user entered in the panel. Therefore, we have to remember 'dir'. Note that it could also be
 230     // a symbolic link -> remember the 'canonical' path.
 231     if (addToHistory == HistoryPolicy::AddToHistory)
 232         m_sendCdToTerminalHistory.enqueue(QDir(dir).canonicalPath());
 233
 234     if (m_clearTerminal) {
 235         m_terminal->sendInput(QStringLiteral(" clear\n"));
 236         m_clearTerminal = false;
 237     }
 238 }
 239
 240 void TerminalPanel::slotMostLocalUrlResult(KJob* job)
 241 {
 242     KIO::StatJob* statJob = static_cast<KIO::StatJob *>(job);
 243     const QUrl url = statJob->mostLocalUrl();
 244     if (url.isLocalFile()) {
 245         sendCdToTerminal(url.toLocalFile());
 246     }
 247
 248     m_mostLocalUrlJob = nullptr;
 249 }
 250
 251 void TerminalPanel::slotKonsolePartCurrentDirectoryChanged(const QString& dir)
 252 {
 253     m_konsolePartCurrentDirectory = QDir(dir).canonicalPath();
 254
 255     // Only emit a changeUrl signal if the directory change was caused by the user inside the
 256     // terminal, and not by sendCdToTerminal(QString).
 257     while (!m_sendCdToTerminalHistory.empty()) {
 258         if (m_konsolePartCurrentDirectory == m_sendCdToTerminalHistory.dequeue()) {
 259             return;
 260         }
 261     }
 262
 263     const QUrl url(QUrl::fromLocalFile(dir));
 264     emit changeUrl(url);
 265 }