1 /***************************************************************************
2 * Copyright (C) 2007 by Peter Penz <peter.penz19@gmail.com> *
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. *
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. *
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 ***************************************************************************/
20 #include "dolphinviewcontainer.h"
22 #include "dolphin_generalsettings.h"
23 #include "dolphindebug.h"
24 #include "filterbar/filterbar.h"
26 #include "search/dolphinsearchbox.h"
27 #include "statusbar/dolphinstatusbar.h"
28 #include "views/viewmodecontroller.h"
29 #include "views/viewproperties.h"
31 #include <KFileItemActions>
32 #include <KFilePlacesModel>
33 #include <KIO/PreviewJob>
34 #include <KLocalizedString>
35 #include <KMessageWidget>
36 #include <KProtocolManager>
39 #include <KUrlComboBox>
40 #include <KUrlNavigator>
41 #include <kio_version.h>
44 #include <QLoggingCategory>
48 #include <QVBoxLayout>
50 DolphinViewContainer::DolphinViewContainer(const QUrl
& url
, QWidget
* parent
) :
53 m_urlNavigator(nullptr),
55 m_messageWidget(nullptr),
59 m_statusBarTimer(nullptr),
60 m_statusBarTimestamp(),
62 #ifdef KActivities_FOUND
63 , m_activityResourceInstance(0)
68 m_topLayout
= new QVBoxLayout(this);
69 m_topLayout
->setSpacing(0);
70 m_topLayout
->setMargin(0);
72 m_urlNavigator
= new KUrlNavigator(new KFilePlacesModel(this), url
, this);
73 connect(m_urlNavigator
, &KUrlNavigator::activated
,
74 this, &DolphinViewContainer::activate
);
75 connect(m_urlNavigator
->editor(), &KUrlComboBox::completionModeChanged
,
76 this, &DolphinViewContainer::saveUrlCompletionMode
);
78 const GeneralSettings
* settings
= GeneralSettings::self();
79 m_urlNavigator
->setUrlEditable(settings
->editableUrl());
80 m_urlNavigator
->setShowFullPath(settings
->showFullPath());
81 m_urlNavigator
->setHomeUrl(Dolphin::homeUrl());
82 KUrlComboBox
* editor
= m_urlNavigator
->editor();
83 editor
->setCompletionMode(KCompletion::CompletionMode(settings
->urlCompletionMode()));
85 m_searchBox
= new DolphinSearchBox(this);
87 connect(m_searchBox
, &DolphinSearchBox::activated
, this, &DolphinViewContainer::activate
);
88 connect(m_searchBox
, &DolphinSearchBox::closeRequest
, this, &DolphinViewContainer::closeSearchBox
);
89 connect(m_searchBox
, &DolphinSearchBox::searchRequest
, this, &DolphinViewContainer::startSearching
);
90 connect(m_searchBox
, &DolphinSearchBox::returnPressed
, this, &DolphinViewContainer::requestFocus
);
92 m_messageWidget
= new KMessageWidget(this);
93 m_messageWidget
->setCloseButtonVisible(true);
94 m_messageWidget
->hide();
96 m_view
= new DolphinView(url
, this);
97 connect(m_view
, &DolphinView::urlChanged
,
98 m_urlNavigator
, &KUrlNavigator::setLocationUrl
);
99 connect(m_view
, &DolphinView::urlChanged
,
100 m_messageWidget
, &KMessageWidget::hide
);
101 connect(m_view
, &DolphinView::writeStateChanged
,
102 this, &DolphinViewContainer::writeStateChanged
);
103 connect(m_view
, &DolphinView::requestItemInfo
,
104 this, &DolphinViewContainer::showItemInfo
);
105 connect(m_view
, &DolphinView::itemActivated
,
106 this, &DolphinViewContainer::slotItemActivated
);
107 connect(m_view
, &DolphinView::itemsActivated
,
108 this, &DolphinViewContainer::slotItemsActivated
);
109 connect(m_view
, &DolphinView::redirection
,
110 this, &DolphinViewContainer::redirect
);
111 connect(m_view
, &DolphinView::directoryLoadingStarted
,
112 this, &DolphinViewContainer::slotDirectoryLoadingStarted
);
113 connect(m_view
, &DolphinView::directoryLoadingCompleted
,
114 this, &DolphinViewContainer::slotDirectoryLoadingCompleted
);
115 connect(m_view
, &DolphinView::directoryLoadingCanceled
,
116 this, &DolphinViewContainer::slotDirectoryLoadingCanceled
);
117 connect(m_view
, &DolphinView::itemCountChanged
,
118 this, &DolphinViewContainer::delayedStatusBarUpdate
);
119 connect(m_view
, &DolphinView::directoryLoadingProgress
,
120 this, &DolphinViewContainer::updateDirectoryLoadingProgress
);
121 connect(m_view
, &DolphinView::directorySortingProgress
,
122 this, &DolphinViewContainer::updateDirectorySortingProgress
);
123 connect(m_view
, &DolphinView::selectionChanged
,
124 this, &DolphinViewContainer::delayedStatusBarUpdate
);
125 connect(m_view
, &DolphinView::errorMessage
,
126 this, &DolphinViewContainer::showErrorMessage
);
127 connect(m_view
, &DolphinView::urlIsFileError
,
128 this, &DolphinViewContainer::slotUrlIsFileError
);
129 connect(m_view
, &DolphinView::activated
,
130 this, &DolphinViewContainer::activate
);
132 connect(m_urlNavigator
, &KUrlNavigator::urlAboutToBeChanged
,
133 this, &DolphinViewContainer::slotUrlNavigatorLocationAboutToBeChanged
);
134 connect(m_urlNavigator
, &KUrlNavigator::urlChanged
,
135 this, &DolphinViewContainer::slotUrlNavigatorLocationChanged
);
136 connect(m_urlNavigator
, &KUrlNavigator::urlSelectionRequested
,
137 this, &DolphinViewContainer::slotUrlSelectionRequested
);
138 connect(m_urlNavigator
, &KUrlNavigator::returnPressed
,
139 this, &DolphinViewContainer::slotReturnPressed
);
140 connect(m_urlNavigator
, &KUrlNavigator::urlsDropped
, this, [=](const QUrl
&destination
, QDropEvent
*event
) {
141 #if KIO_VERSION >= QT_VERSION_CHECK(5, 37, 0)
142 m_view
->dropUrls(destination
, event
, m_urlNavigator
->dropWidget());
144 // TODO: remove as soon as we can hard-depend of KF5 >= 5.37
145 m_view
->dropUrls(destination
, event
, m_view
);
149 // Initialize status bar
150 m_statusBar
= new DolphinStatusBar(this);
151 m_statusBar
->setUrl(m_view
->url());
152 m_statusBar
->setZoomLevel(m_view
->zoomLevel());
153 connect(m_view
, &DolphinView::urlChanged
,
154 m_statusBar
, &DolphinStatusBar::setUrl
);
155 connect(m_view
, &DolphinView::zoomLevelChanged
,
156 m_statusBar
, &DolphinStatusBar::setZoomLevel
);
157 connect(m_view
, &DolphinView::infoMessage
,
158 m_statusBar
, &DolphinStatusBar::setText
);
159 connect(m_view
, &DolphinView::operationCompletedMessage
,
160 m_statusBar
, &DolphinStatusBar::setText
);
161 connect(m_statusBar
, &DolphinStatusBar::stopPressed
,
162 this, &DolphinViewContainer::stopDirectoryLoading
);
163 connect(m_statusBar
, &DolphinStatusBar::zoomLevelChanged
,
164 this, &DolphinViewContainer::slotStatusBarZoomLevelChanged
);
166 m_statusBarTimer
= new QTimer(this);
167 m_statusBarTimer
->setSingleShot(true);
168 m_statusBarTimer
->setInterval(300);
169 connect(m_statusBarTimer
, &QTimer::timeout
, this, &DolphinViewContainer::updateStatusBar
);
171 KIO::FileUndoManager
* undoManager
= KIO::FileUndoManager::self();
172 connect(undoManager
, &KIO::FileUndoManager::jobRecordingFinished
,
173 this, &DolphinViewContainer::delayedStatusBarUpdate
);
175 // Initialize filter bar
176 m_filterBar
= new FilterBar(this);
177 m_filterBar
->setVisible(settings
->filterBar());
178 connect(m_filterBar
, &FilterBar::filterChanged
,
179 this, &DolphinViewContainer::setNameFilter
);
180 connect(m_filterBar
, &FilterBar::closeRequest
,
181 this, &DolphinViewContainer::closeFilterBar
);
182 connect(m_filterBar
, &FilterBar::focusViewRequest
,
183 this, &DolphinViewContainer::requestFocus
);
184 connect(m_view
, &DolphinView::urlChanged
,
185 m_filterBar
, &FilterBar::slotUrlChanged
);
187 m_topLayout
->addWidget(m_urlNavigator
);
188 m_topLayout
->addWidget(m_searchBox
);
189 m_topLayout
->addWidget(m_messageWidget
);
190 m_topLayout
->addWidget(m_view
);
191 m_topLayout
->addWidget(m_filterBar
);
192 m_topLayout
->addWidget(m_statusBar
);
194 setSearchModeEnabled(isSearchUrl(url
));
196 // Initialize kactivities resource instance
198 #ifdef KActivities_FOUND
199 m_activityResourceInstance
= new KActivities::ResourceInstance(
200 window()->winId(), url
);
201 m_activityResourceInstance
->setParent(this);
205 DolphinViewContainer::~DolphinViewContainer()
209 QUrl
DolphinViewContainer::url() const
211 return m_view
->url();
214 void DolphinViewContainer::setActive(bool active
)
216 m_searchBox
->setActive(active
);
217 m_urlNavigator
->setActive(active
);
218 m_view
->setActive(active
);
220 #ifdef KActivities_FOUND
222 m_activityResourceInstance
->notifyFocusedIn();
224 m_activityResourceInstance
->notifyFocusedOut();
229 bool DolphinViewContainer::isActive() const
231 Q_ASSERT(m_view
->isActive() == m_urlNavigator
->isActive());
232 return m_view
->isActive();
235 void DolphinViewContainer::setAutoGrabFocus(bool grab
)
237 m_autoGrabFocus
= grab
;
240 bool DolphinViewContainer::autoGrabFocus() const
242 return m_autoGrabFocus
;
245 QString
DolphinViewContainer::currentSearchText() const
247 return m_searchBox
->text();
250 const DolphinStatusBar
* DolphinViewContainer::statusBar() const
255 DolphinStatusBar
* DolphinViewContainer::statusBar()
260 const KUrlNavigator
* DolphinViewContainer::urlNavigator() const
262 return m_urlNavigator
;
265 KUrlNavigator
* DolphinViewContainer::urlNavigator()
267 return m_urlNavigator
;
270 const DolphinView
* DolphinViewContainer::view() const
275 DolphinView
* DolphinViewContainer::view()
280 void DolphinViewContainer::showMessage(const QString
& msg
, MessageType type
)
286 m_messageWidget
->setText(msg
);
289 case Information
: m_messageWidget
->setMessageType(KMessageWidget::Information
); break;
290 case Warning
: m_messageWidget
->setMessageType(KMessageWidget::Warning
); break;
291 case Error
: m_messageWidget
->setMessageType(KMessageWidget::Error
); break;
297 m_messageWidget
->setWordWrap(false);
298 const int unwrappedWidth
= m_messageWidget
->sizeHint().width();
299 m_messageWidget
->setWordWrap(unwrappedWidth
> size().width());
301 if (m_messageWidget
->isVisible()) {
302 m_messageWidget
->hide();
304 m_messageWidget
->animatedShow();
307 void DolphinViewContainer::readSettings()
309 if (GeneralSettings::modifiedStartupSettings()) {
310 // The startup settings should only get applied if they have been
311 // modified by the user. Otherwise keep the (possibly) different current
312 // settings of the URL navigator and the filterbar.
313 m_urlNavigator
->setUrlEditable(GeneralSettings::editableUrl());
314 m_urlNavigator
->setShowFullPath(GeneralSettings::showFullPath());
315 m_urlNavigator
->setHomeUrl(Dolphin::homeUrl());
316 setFilterBarVisible(GeneralSettings::filterBar());
319 m_view
->readSettings();
320 m_statusBar
->readSettings();
323 bool DolphinViewContainer::isFilterBarVisible() const
325 return m_filterBar
->isVisible();
328 void DolphinViewContainer::setSearchModeEnabled(bool enabled
)
330 if (enabled
== isSearchModeEnabled()) {
331 if (enabled
&& !m_searchBox
->hasFocus()) {
332 m_searchBox
->setFocus();
333 m_searchBox
->selectAll();
338 m_searchBox
->setVisible(enabled
);
339 m_urlNavigator
->setVisible(!enabled
);
342 const QUrl
& locationUrl
= m_urlNavigator
->locationUrl();
343 m_searchBox
->fromSearchUrl(locationUrl
);
345 m_view
->setViewPropertiesContext(QString());
347 // Restore the URL for the URL navigator. If Dolphin has been
348 // started with a search-URL, the home URL is used as fallback.
349 QUrl url
= m_searchBox
->searchPath();
350 if (url
.isEmpty() || !url
.isValid() || isSearchUrl(url
)) {
351 url
= Dolphin::homeUrl();
353 m_urlNavigator
->setLocationUrl(url
);
357 bool DolphinViewContainer::isSearchModeEnabled() const
359 return m_searchBox
->isVisible();
362 QString
DolphinViewContainer::placesText() const
366 if (isSearchModeEnabled()) {
367 text
= i18n("Search for %1 in %2", m_searchBox
->text(), m_searchBox
->searchPath().fileName());
369 text
= url().fileName();
370 if (text
.isEmpty()) {
373 if (text
.isEmpty()) {
374 text
= url().scheme();
381 void DolphinViewContainer::reload()
384 m_messageWidget
->hide();
387 void DolphinViewContainer::setUrl(const QUrl
& newUrl
)
389 if (newUrl
!= m_urlNavigator
->locationUrl()) {
390 m_urlNavigator
->setLocationUrl(newUrl
);
393 #ifdef KActivities_FOUND
394 m_activityResourceInstance
->setUri(newUrl
);
398 void DolphinViewContainer::setFilterBarVisible(bool visible
)
400 Q_ASSERT(m_filterBar
);
403 m_filterBar
->setFocus();
404 m_filterBar
->selectAll();
410 void DolphinViewContainer::delayedStatusBarUpdate()
412 if (m_statusBarTimer
->isActive() && (m_statusBarTimestamp
.elapsed() > 2000)) {
413 // No update of the statusbar has been done during the last 2 seconds,
414 // although an update has been requested. Trigger an immediate update.
415 m_statusBarTimer
->stop();
418 // Invoke updateStatusBar() with a small delay. This assures that
419 // when a lot of delayedStatusBarUpdates() are done in a short time,
420 // no bottleneck is given.
421 m_statusBarTimer
->start();
425 void DolphinViewContainer::updateStatusBar()
427 m_statusBarTimestamp
.start();
429 const QString text
= m_view
->statusBarText();
430 m_statusBar
->setDefaultText(text
);
431 m_statusBar
->resetToDefaultText();
434 void DolphinViewContainer::updateDirectoryLoadingProgress(int percent
)
436 if (m_statusBar
->progressText().isEmpty()) {
437 m_statusBar
->setProgressText(i18nc("@info:progress", "Loading folder..."));
439 m_statusBar
->setProgress(percent
);
442 void DolphinViewContainer::updateDirectorySortingProgress(int percent
)
444 if (m_statusBar
->progressText().isEmpty()) {
445 m_statusBar
->setProgressText(i18nc("@info:progress", "Sorting..."));
447 m_statusBar
->setProgress(percent
);
450 void DolphinViewContainer::slotDirectoryLoadingStarted()
452 if (isSearchUrl(url())) {
453 // Search KIO-slaves usually don't provide any progress information. Give
454 // a hint to the user that a searching is done:
456 m_statusBar
->setProgressText(i18nc("@info", "Searching..."));
457 m_statusBar
->setProgress(-1);
459 // Trigger an undetermined progress indication. The progress
460 // information in percent will be triggered by the percent() signal
461 // of the directory lister later.
462 updateDirectoryLoadingProgress(-1);
466 void DolphinViewContainer::slotDirectoryLoadingCompleted()
468 if (!m_statusBar
->progressText().isEmpty()) {
469 m_statusBar
->setProgressText(QString());
470 m_statusBar
->setProgress(100);
473 if (isSearchUrl(url()) && m_view
->itemsCount() == 0) {
474 // The dir lister has been completed on a Baloo-URI and no items have been found. Instead
475 // of showing the default status bar information ("0 items") a more helpful information is given:
476 m_statusBar
->setText(i18nc("@info:status", "No items found."));
482 void DolphinViewContainer::slotDirectoryLoadingCanceled()
484 if (!m_statusBar
->progressText().isEmpty()) {
485 m_statusBar
->setProgressText(QString());
486 m_statusBar
->setProgress(100);
489 m_statusBar
->setText(QString());
492 void DolphinViewContainer::slotUrlIsFileError(const QUrl
& url
)
494 const KFileItem
item(url
);
496 // Find out if the file can be opened in the view (for example, this is the
497 // case if the file is an archive). The mime type must be known for that.
498 item
.determineMimeType();
499 const QUrl
& folderUrl
= DolphinView::openItemAsFolderUrl(item
, true);
500 if (!folderUrl
.isEmpty()) {
503 slotItemActivated(item
);
507 void DolphinViewContainer::slotItemActivated(const KFileItem
& item
)
509 // It is possible to activate items on inactive views by
510 // drag & drop operations. Assure that activating an item always
511 // results in an active view.
512 m_view
->setActive(true);
514 const QUrl
& url
= DolphinView::openItemAsFolderUrl(item
, GeneralSettings::browseThroughArchives());
515 if (!url
.isEmpty()) {
520 KRun
*run
= new KRun(item
.targetUrl(), this);
521 run
->setShowScriptExecutionPrompt(true);
524 void DolphinViewContainer::slotItemsActivated(const KFileItemList
& items
)
526 Q_ASSERT(items
.count() >= 2);
528 KFileItemActions
fileItemActions(this);
529 fileItemActions
.runPreferredApplications(items
, QString());
532 void DolphinViewContainer::showItemInfo(const KFileItem
& item
)
535 m_statusBar
->resetToDefaultText();
537 m_statusBar
->setText(item
.getStatusBarInfo());
541 void DolphinViewContainer::closeFilterBar()
543 m_filterBar
->closeFilterBar();
545 emit
showFilterBarChanged(false);
548 void DolphinViewContainer::setNameFilter(const QString
& nameFilter
)
550 m_view
->setNameFilter(nameFilter
);
551 delayedStatusBarUpdate();
554 void DolphinViewContainer::activate()
559 void DolphinViewContainer::slotUrlNavigatorLocationAboutToBeChanged(const QUrl
&)
564 void DolphinViewContainer::slotUrlNavigatorLocationChanged(const QUrl
& url
)
568 if (KProtocolManager::supportsListing(url
)) {
569 setSearchModeEnabled(isSearchUrl(url
));
571 tryRestoreViewState();
573 if (m_autoGrabFocus
&& isActive() && !isSearchUrl(url
)) {
574 // When an URL has been entered, the view should get the focus.
575 // The focus must be requested asynchronously, as changing the URL might create
576 // a new view widget.
577 QTimer::singleShot(0, this, &DolphinViewContainer::requestFocus
);
579 } else if (KProtocolManager::isSourceProtocol(url
)) {
580 QString app
= QStringLiteral("konqueror");
581 if (url
.scheme().startsWith(QLatin1String("http"))) {
582 showMessage(i18nc("@info:status", // krazy:exclude=qmethods
583 "Dolphin does not support web pages, the web browser has been launched"),
586 const KConfigGroup
config(KSharedConfig::openConfig(QStringLiteral("kdeglobals")), "General");
587 const QString browser
= config
.readEntry("BrowserApplication");
588 if (!browser
.isEmpty()) {
590 if (app
.startsWith('!')) {
591 // a literal command has been configured, remove the '!' prefix
596 showMessage(i18nc("@info:status",
597 "Protocol not supported by Dolphin, Konqueror has been launched"),
601 const QString secureUrl
= KShell::quoteArg(url
.toDisplayString(QUrl::PreferLocalFile
));
602 const QString command
= app
+ ' ' + secureUrl
;
603 KRun::runCommand(command
, app
, app
, this);
605 showMessage(i18nc("@info:status", "Invalid protocol"), Error
);
609 void DolphinViewContainer::slotUrlSelectionRequested(const QUrl
& url
)
611 qCDebug(DolphinDebug
) << "slotUrlSelectionRequested: " << url
;
612 m_view
->markUrlsAsSelected({url
});
613 m_view
->markUrlAsCurrent(url
); // makes the item scroll into view
616 void DolphinViewContainer::redirect(const QUrl
& oldUrl
, const QUrl
& newUrl
)
619 const bool block
= m_urlNavigator
->signalsBlocked();
620 m_urlNavigator
->blockSignals(true);
622 // Assure that the location state is reset for redirection URLs. This
623 // allows to skip redirection URLs when going back or forward in the
625 m_urlNavigator
->saveLocationState(QByteArray());
626 m_urlNavigator
->setLocationUrl(newUrl
);
627 setSearchModeEnabled(isSearchUrl(newUrl
));
629 m_urlNavigator
->blockSignals(block
);
632 void DolphinViewContainer::requestFocus()
637 void DolphinViewContainer::saveUrlCompletionMode(KCompletion::CompletionMode completion
)
639 GeneralSettings::setUrlCompletionMode(completion
);
642 void DolphinViewContainer::slotReturnPressed()
644 if (!GeneralSettings::editableUrl()) {
645 m_urlNavigator
->setUrlEditable(false);
649 void DolphinViewContainer::startSearching()
651 const QUrl url
= m_searchBox
->urlForSearching();
652 if (url
.isValid() && !url
.isEmpty()) {
653 m_view
->setViewPropertiesContext(QStringLiteral("search"));
654 m_urlNavigator
->setLocationUrl(url
);
658 void DolphinViewContainer::closeSearchBox()
660 setSearchModeEnabled(false);
663 void DolphinViewContainer::stopDirectoryLoading()
665 m_view
->stopLoading();
666 m_statusBar
->setProgress(100);
669 void DolphinViewContainer::slotStatusBarZoomLevelChanged(int zoomLevel
)
671 m_view
->setZoomLevel(zoomLevel
);
674 void DolphinViewContainer::showErrorMessage(const QString
& msg
)
676 showMessage(msg
, Error
);
679 bool DolphinViewContainer::isSearchUrl(const QUrl
& url
) const
681 return url
.scheme().contains(QStringLiteral("search"));
684 void DolphinViewContainer::saveViewState()
686 QByteArray locationState
;
687 QDataStream
stream(&locationState
, QIODevice::WriteOnly
);
688 m_view
->saveState(stream
);
689 m_urlNavigator
->saveLocationState(locationState
);
692 void DolphinViewContainer::tryRestoreViewState()
694 QByteArray locationState
= m_urlNavigator
->locationState();
695 if (!locationState
.isEmpty()) {
696 QDataStream
stream(&locationState
, QIODevice::ReadOnly
);
697 m_view
->restoreState(stream
);