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"
21 #include <KProtocolManager>
26 #include <QVBoxLayout>
28 #include <KFileItemActions>
29 #include <KFilePlacesModel>
30 #include <KLocalizedString>
31 #include <KIO/PreviewJob>
32 #include <kio_version.h>
33 #include <KMessageWidget>
36 #include <KUrlComboBox>
37 #include <KUrlNavigator>
40 #ifdef KActivities_FOUND
44 #include "dolphin_generalsettings.h"
45 #include "filterbar/filterbar.h"
46 #include "search/dolphinsearchbox.h"
47 #include "statusbar/dolphinstatusbar.h"
48 #include "views/viewmodecontroller.h"
49 #include "views/viewproperties.h"
51 DolphinViewContainer::DolphinViewContainer(const QUrl
& url
, QWidget
* parent
) :
61 m_statusBarTimestamp(),
63 #ifdef KActivities_FOUND
64 , m_activityResourceInstance(0)
69 m_topLayout
= new QVBoxLayout(this);
70 m_topLayout
->setSpacing(0);
71 m_topLayout
->setMargin(0);
73 m_urlNavigator
= new KUrlNavigator(new KFilePlacesModel(this), url
, this);
74 connect(m_urlNavigator
, &KUrlNavigator::activated
,
75 this, &DolphinViewContainer::activate
);
76 connect(m_urlNavigator
->editor(), &KUrlComboBox::completionModeChanged
,
77 this, &DolphinViewContainer::saveUrlCompletionMode
);
79 const GeneralSettings
* settings
= GeneralSettings::self();
80 m_urlNavigator
->setUrlEditable(settings
->editableUrl());
81 m_urlNavigator
->setShowFullPath(settings
->showFullPath());
82 m_urlNavigator
->setHomeUrl(Dolphin::homeUrl());
83 KUrlComboBox
* editor
= m_urlNavigator
->editor();
84 editor
->setCompletionMode(KCompletion::CompletionMode(settings
->urlCompletionMode()));
86 m_searchBox
= new DolphinSearchBox(this);
88 connect(m_searchBox
, &DolphinSearchBox::activated
, this, &DolphinViewContainer::activate
);
89 connect(m_searchBox
, &DolphinSearchBox::closeRequest
, this, &DolphinViewContainer::closeSearchBox
);
90 connect(m_searchBox
, &DolphinSearchBox::searchRequest
, this, &DolphinViewContainer::startSearching
);
91 connect(m_searchBox
, &DolphinSearchBox::returnPressed
, this, &DolphinViewContainer::requestFocus
);
93 m_messageWidget
= new KMessageWidget(this);
94 m_messageWidget
->setCloseButtonVisible(true);
95 m_messageWidget
->hide();
97 m_view
= new DolphinView(url
, this);
98 connect(m_view
, &DolphinView::urlChanged
,
99 m_urlNavigator
, &KUrlNavigator::setLocationUrl
);
100 connect(m_view
, &DolphinView::urlChanged
,
101 m_messageWidget
, &KMessageWidget::hide
);
102 connect(m_view
, &DolphinView::writeStateChanged
,
103 this, &DolphinViewContainer::writeStateChanged
);
104 connect(m_view
, &DolphinView::requestItemInfo
,
105 this, &DolphinViewContainer::showItemInfo
);
106 connect(m_view
, &DolphinView::itemActivated
,
107 this, &DolphinViewContainer::slotItemActivated
);
108 connect(m_view
, &DolphinView::itemsActivated
,
109 this, &DolphinViewContainer::slotItemsActivated
);
110 connect(m_view
, &DolphinView::redirection
,
111 this, &DolphinViewContainer::redirect
);
112 connect(m_view
, &DolphinView::directoryLoadingStarted
,
113 this, &DolphinViewContainer::slotDirectoryLoadingStarted
);
114 connect(m_view
, &DolphinView::directoryLoadingCompleted
,
115 this, &DolphinViewContainer::slotDirectoryLoadingCompleted
);
116 connect(m_view
, &DolphinView::directoryLoadingCanceled
,
117 this, &DolphinViewContainer::slotDirectoryLoadingCanceled
);
118 connect(m_view
, &DolphinView::itemCountChanged
,
119 this, &DolphinViewContainer::delayedStatusBarUpdate
);
120 connect(m_view
, &DolphinView::directoryLoadingProgress
,
121 this, &DolphinViewContainer::updateDirectoryLoadingProgress
);
122 connect(m_view
, &DolphinView::directorySortingProgress
,
123 this, &DolphinViewContainer::updateDirectorySortingProgress
);
124 connect(m_view
, &DolphinView::selectionChanged
,
125 this, &DolphinViewContainer::delayedStatusBarUpdate
);
126 connect(m_view
, &DolphinView::errorMessage
,
127 this, &DolphinViewContainer::showErrorMessage
);
128 connect(m_view
, &DolphinView::urlIsFileError
,
129 this, &DolphinViewContainer::slotUrlIsFileError
);
130 connect(m_view
, &DolphinView::activated
,
131 this, &DolphinViewContainer::activate
);
133 connect(m_urlNavigator
, &KUrlNavigator::urlAboutToBeChanged
,
134 this, &DolphinViewContainer::slotUrlNavigatorLocationAboutToBeChanged
);
135 connect(m_urlNavigator
, &KUrlNavigator::urlChanged
,
136 this, &DolphinViewContainer::slotUrlNavigatorLocationChanged
);
137 connect(m_urlNavigator
, &KUrlNavigator::returnPressed
,
138 this, &DolphinViewContainer::slotReturnPressed
);
139 connect(m_urlNavigator
, &KUrlNavigator::urlsDropped
, this, [=](const QUrl
&destination
, QDropEvent
*event
) {
140 #if KIO_VERSION >= QT_VERSION_CHECK(5, 37, 0)
141 m_view
->dropUrls(destination
, event
, m_urlNavigator
->dropWidget());
143 // TODO: remove as soon as we can hard-depend of KF5 >= 5.37
144 m_view
->dropUrls(destination
, event
, m_view
);
148 // Initialize status bar
149 m_statusBar
= new DolphinStatusBar(this);
150 m_statusBar
->setUrl(m_view
->url());
151 m_statusBar
->setZoomLevel(m_view
->zoomLevel());
152 connect(m_view
, &DolphinView::urlChanged
,
153 m_statusBar
, &DolphinStatusBar::setUrl
);
154 connect(m_view
, &DolphinView::zoomLevelChanged
,
155 m_statusBar
, &DolphinStatusBar::setZoomLevel
);
156 connect(m_view
, &DolphinView::infoMessage
,
157 m_statusBar
, &DolphinStatusBar::setText
);
158 connect(m_view
, &DolphinView::operationCompletedMessage
,
159 m_statusBar
, &DolphinStatusBar::setText
);
160 connect(m_statusBar
, &DolphinStatusBar::stopPressed
,
161 this, &DolphinViewContainer::stopDirectoryLoading
);
162 connect(m_statusBar
, &DolphinStatusBar::zoomLevelChanged
,
163 this, &DolphinViewContainer::slotStatusBarZoomLevelChanged
);
165 m_statusBarTimer
= new QTimer(this);
166 m_statusBarTimer
->setSingleShot(true);
167 m_statusBarTimer
->setInterval(300);
168 connect(m_statusBarTimer
, &QTimer::timeout
, this, &DolphinViewContainer::updateStatusBar
);
170 KIO::FileUndoManager
* undoManager
= KIO::FileUndoManager::self();
171 connect(undoManager
, &KIO::FileUndoManager::jobRecordingFinished
,
172 this, &DolphinViewContainer::delayedStatusBarUpdate
);
174 // Initialize filter bar
175 m_filterBar
= new FilterBar(this);
176 m_filterBar
->setVisible(settings
->filterBar());
177 connect(m_filterBar
, &FilterBar::filterChanged
,
178 this, &DolphinViewContainer::setNameFilter
);
179 connect(m_filterBar
, &FilterBar::closeRequest
,
180 this, &DolphinViewContainer::closeFilterBar
);
181 connect(m_filterBar
, &FilterBar::focusViewRequest
,
182 this, &DolphinViewContainer::requestFocus
);
183 connect(m_view
, &DolphinView::urlChanged
,
184 m_filterBar
, &FilterBar::slotUrlChanged
);
186 m_topLayout
->addWidget(m_urlNavigator
);
187 m_topLayout
->addWidget(m_searchBox
);
188 m_topLayout
->addWidget(m_messageWidget
);
189 m_topLayout
->addWidget(m_view
);
190 m_topLayout
->addWidget(m_filterBar
);
191 m_topLayout
->addWidget(m_statusBar
);
193 setSearchModeEnabled(isSearchUrl(url
));
195 // Initialize kactivities resource instance
197 #ifdef KActivities_FOUND
198 m_activityResourceInstance
= new KActivities::ResourceInstance(
199 window()->winId(), url
);
200 m_activityResourceInstance
->setParent(this);
204 DolphinViewContainer::~DolphinViewContainer()
208 QUrl
DolphinViewContainer::url() const
210 return m_view
->url();
213 void DolphinViewContainer::setActive(bool active
)
215 m_searchBox
->setActive(active
);
216 m_urlNavigator
->setActive(active
);
217 m_view
->setActive(active
);
219 #ifdef KActivities_FOUND
221 m_activityResourceInstance
->notifyFocusedIn();
223 m_activityResourceInstance
->notifyFocusedOut();
228 bool DolphinViewContainer::isActive() const
230 Q_ASSERT(m_view
->isActive() == m_urlNavigator
->isActive());
231 return m_view
->isActive();
234 void DolphinViewContainer::setAutoGrabFocus(bool grab
)
236 m_autoGrabFocus
= grab
;
239 bool DolphinViewContainer::autoGrabFocus() const
241 return m_autoGrabFocus
;
244 const DolphinStatusBar
* DolphinViewContainer::statusBar() const
249 DolphinStatusBar
* DolphinViewContainer::statusBar()
254 const KUrlNavigator
* DolphinViewContainer::urlNavigator() const
256 return m_urlNavigator
;
259 KUrlNavigator
* DolphinViewContainer::urlNavigator()
261 return m_urlNavigator
;
264 const DolphinView
* DolphinViewContainer::view() const
269 DolphinView
* DolphinViewContainer::view()
274 void DolphinViewContainer::showMessage(const QString
& msg
, MessageType type
)
280 m_messageWidget
->setText(msg
);
283 case Information
: m_messageWidget
->setMessageType(KMessageWidget::Information
); break;
284 case Warning
: m_messageWidget
->setMessageType(KMessageWidget::Warning
); break;
285 case Error
: m_messageWidget
->setMessageType(KMessageWidget::Error
); break;
291 m_messageWidget
->setWordWrap(false);
292 const int unwrappedWidth
= m_messageWidget
->sizeHint().width();
293 m_messageWidget
->setWordWrap(unwrappedWidth
> size().width());
295 if (m_messageWidget
->isVisible()) {
296 m_messageWidget
->hide();
298 m_messageWidget
->animatedShow();
301 void DolphinViewContainer::readSettings()
303 if (GeneralSettings::modifiedStartupSettings()) {
304 // The startup settings should only get applied if they have been
305 // modified by the user. Otherwise keep the (possibly) different current
306 // settings of the URL navigator and the filterbar.
307 m_urlNavigator
->setUrlEditable(GeneralSettings::editableUrl());
308 m_urlNavigator
->setShowFullPath(GeneralSettings::showFullPath());
309 m_urlNavigator
->setHomeUrl(Dolphin::homeUrl());
310 setFilterBarVisible(GeneralSettings::filterBar());
313 m_view
->readSettings();
314 m_statusBar
->readSettings();
317 bool DolphinViewContainer::isFilterBarVisible() const
319 return m_filterBar
->isVisible();
322 void DolphinViewContainer::setSearchModeEnabled(bool enabled
)
324 if (enabled
== isSearchModeEnabled()) {
325 if (enabled
&& !m_searchBox
->hasFocus()) {
326 m_searchBox
->setFocus();
327 m_searchBox
->selectAll();
332 m_searchBox
->setVisible(enabled
);
333 m_urlNavigator
->setVisible(!enabled
);
336 const QUrl
& locationUrl
= m_urlNavigator
->locationUrl();
337 m_searchBox
->fromSearchUrl(locationUrl
);
339 m_view
->setViewPropertiesContext(QString());
341 // Restore the URL for the URL navigator. If Dolphin has been
342 // started with a search-URL, the home URL is used as fallback.
343 QUrl url
= m_searchBox
->searchPath();
344 if (url
.isEmpty() || !url
.isValid() || isSearchUrl(url
)) {
345 url
= Dolphin::homeUrl();
347 m_urlNavigator
->setLocationUrl(url
);
351 bool DolphinViewContainer::isSearchModeEnabled() const
353 return m_searchBox
->isVisible();
356 QString
DolphinViewContainer::placesText() const
360 if (isSearchModeEnabled()) {
361 text
= m_searchBox
->searchPath().fileName() + QLatin1String(": ") + m_searchBox
->text();
363 text
= url().fileName();
364 if (text
.isEmpty()) {
367 if (text
.isEmpty()) {
368 text
= url().scheme();
375 void DolphinViewContainer::reload()
378 m_messageWidget
->hide();
381 void DolphinViewContainer::setUrl(const QUrl
& newUrl
)
383 if (newUrl
!= m_urlNavigator
->locationUrl()) {
384 m_urlNavigator
->setLocationUrl(newUrl
);
387 #ifdef KActivities_FOUND
388 m_activityResourceInstance
->setUri(newUrl
);
392 void DolphinViewContainer::setFilterBarVisible(bool visible
)
394 Q_ASSERT(m_filterBar
);
397 m_filterBar
->setFocus();
398 m_filterBar
->selectAll();
404 void DolphinViewContainer::delayedStatusBarUpdate()
406 if (m_statusBarTimer
->isActive() && (m_statusBarTimestamp
.elapsed() > 2000)) {
407 // No update of the statusbar has been done during the last 2 seconds,
408 // although an update has been requested. Trigger an immediate update.
409 m_statusBarTimer
->stop();
412 // Invoke updateStatusBar() with a small delay. This assures that
413 // when a lot of delayedStatusBarUpdates() are done in a short time,
414 // no bottleneck is given.
415 m_statusBarTimer
->start();
419 void DolphinViewContainer::updateStatusBar()
421 m_statusBarTimestamp
.start();
423 const QString text
= m_view
->statusBarText();
424 m_statusBar
->setDefaultText(text
);
425 m_statusBar
->resetToDefaultText();
428 void DolphinViewContainer::updateDirectoryLoadingProgress(int percent
)
430 if (m_statusBar
->progressText().isEmpty()) {
431 m_statusBar
->setProgressText(i18nc("@info:progress", "Loading folder..."));
433 m_statusBar
->setProgress(percent
);
436 void DolphinViewContainer::updateDirectorySortingProgress(int percent
)
438 if (m_statusBar
->progressText().isEmpty()) {
439 m_statusBar
->setProgressText(i18nc("@info:progress", "Sorting..."));
441 m_statusBar
->setProgress(percent
);
444 void DolphinViewContainer::slotDirectoryLoadingStarted()
446 if (isSearchUrl(url())) {
447 // Search KIO-slaves usually don't provide any progress information. Give
448 // a hint to the user that a searching is done:
450 m_statusBar
->setProgressText(i18nc("@info", "Searching..."));
451 m_statusBar
->setProgress(-1);
453 // Trigger an undetermined progress indication. The progress
454 // information in percent will be triggered by the percent() signal
455 // of the directory lister later.
456 updateDirectoryLoadingProgress(-1);
460 void DolphinViewContainer::slotDirectoryLoadingCompleted()
462 if (!m_statusBar
->progressText().isEmpty()) {
463 m_statusBar
->setProgressText(QString());
464 m_statusBar
->setProgress(100);
467 if (isSearchUrl(url()) && m_view
->itemsCount() == 0) {
468 // The dir lister has been completed on a Baloo-URI and no items have been found. Instead
469 // of showing the default status bar information ("0 items") a more helpful information is given:
470 m_statusBar
->setText(i18nc("@info:status", "No items found."));
476 void DolphinViewContainer::slotDirectoryLoadingCanceled()
478 if (!m_statusBar
->progressText().isEmpty()) {
479 m_statusBar
->setProgressText(QString());
480 m_statusBar
->setProgress(100);
483 m_statusBar
->setText(QString());
486 void DolphinViewContainer::slotUrlIsFileError(const QUrl
& url
)
488 const KFileItem
item(url
);
490 // Find out if the file can be opened in the view (for example, this is the
491 // case if the file is an archive). The mime type must be known for that.
492 item
.determineMimeType();
493 const QUrl
& folderUrl
= DolphinView::openItemAsFolderUrl(item
, true);
494 if (!folderUrl
.isEmpty()) {
497 slotItemActivated(item
);
501 void DolphinViewContainer::slotItemActivated(const KFileItem
& item
)
503 // It is possible to activate items on inactive views by
504 // drag & drop operations. Assure that activating an item always
505 // results in an active view.
506 m_view
->setActive(true);
508 const QUrl
& url
= DolphinView::openItemAsFolderUrl(item
, GeneralSettings::browseThroughArchives());
509 if (!url
.isEmpty()) {
514 KRun
*run
= new KRun(item
.targetUrl(), this);
515 run
->setShowScriptExecutionPrompt(true);
518 void DolphinViewContainer::slotItemsActivated(const KFileItemList
& items
)
520 Q_ASSERT(items
.count() >= 2);
522 KFileItemActions
fileItemActions(this);
523 fileItemActions
.runPreferredApplications(items
, QString());
526 void DolphinViewContainer::showItemInfo(const KFileItem
& item
)
529 m_statusBar
->resetToDefaultText();
531 m_statusBar
->setText(item
.getStatusBarInfo());
535 void DolphinViewContainer::closeFilterBar()
537 m_filterBar
->closeFilterBar();
539 emit
showFilterBarChanged(false);
542 void DolphinViewContainer::setNameFilter(const QString
& nameFilter
)
544 m_view
->setNameFilter(nameFilter
);
545 delayedStatusBarUpdate();
548 void DolphinViewContainer::activate()
553 void DolphinViewContainer::slotUrlNavigatorLocationAboutToBeChanged(const QUrl
&)
558 void DolphinViewContainer::slotUrlNavigatorLocationChanged(const QUrl
& url
)
562 if (KProtocolManager::supportsListing(url
)) {
563 setSearchModeEnabled(isSearchUrl(url
));
565 tryRestoreViewState();
567 if (m_autoGrabFocus
&& isActive() && !isSearchUrl(url
)) {
568 // When an URL has been entered, the view should get the focus.
569 // The focus must be requested asynchronously, as changing the URL might create
570 // a new view widget.
571 QTimer::singleShot(0, this, &DolphinViewContainer::requestFocus
);
573 } else if (KProtocolManager::isSourceProtocol(url
)) {
574 QString app
= QStringLiteral("konqueror");
575 if (url
.scheme().startsWith(QLatin1String("http"))) {
576 showMessage(i18nc("@info:status", // krazy:exclude=qmethods
577 "Dolphin does not support web pages, the web browser has been launched"),
580 const KConfigGroup
config(KSharedConfig::openConfig(QStringLiteral("kdeglobals")), "General");
581 const QString browser
= config
.readEntry("BrowserApplication");
582 if (!browser
.isEmpty()) {
584 if (app
.startsWith('!')) {
585 // a literal command has been configured, remove the '!' prefix
590 showMessage(i18nc("@info:status",
591 "Protocol not supported by Dolphin, Konqueror has been launched"),
595 const QString secureUrl
= KShell::quoteArg(url
.toDisplayString(QUrl::PreferLocalFile
));
596 const QString command
= app
+ ' ' + secureUrl
;
597 KRun::runCommand(command
, app
, app
, this);
599 showMessage(i18nc("@info:status", "Invalid protocol"), Error
);
603 void DolphinViewContainer::redirect(const QUrl
& oldUrl
, const QUrl
& newUrl
)
606 const bool block
= m_urlNavigator
->signalsBlocked();
607 m_urlNavigator
->blockSignals(true);
609 // Assure that the location state is reset for redirection URLs. This
610 // allows to skip redirection URLs when going back or forward in the
612 m_urlNavigator
->saveLocationState(QByteArray());
613 m_urlNavigator
->setLocationUrl(newUrl
);
614 setSearchModeEnabled(isSearchUrl(newUrl
));
616 m_urlNavigator
->blockSignals(block
);
619 void DolphinViewContainer::requestFocus()
624 void DolphinViewContainer::saveUrlCompletionMode(KCompletion::CompletionMode completion
)
626 GeneralSettings::setUrlCompletionMode(completion
);
629 void DolphinViewContainer::slotReturnPressed()
631 if (!GeneralSettings::editableUrl()) {
632 m_urlNavigator
->setUrlEditable(false);
636 void DolphinViewContainer::startSearching()
638 const QUrl url
= m_searchBox
->urlForSearching();
639 if (url
.isValid() && !url
.isEmpty()) {
640 m_view
->setViewPropertiesContext(QStringLiteral("search"));
641 m_urlNavigator
->setLocationUrl(url
);
645 void DolphinViewContainer::closeSearchBox()
647 setSearchModeEnabled(false);
650 void DolphinViewContainer::stopDirectoryLoading()
652 m_view
->stopLoading();
653 m_statusBar
->setProgress(100);
656 void DolphinViewContainer::slotStatusBarZoomLevelChanged(int zoomLevel
)
658 m_view
->setZoomLevel(zoomLevel
);
661 void DolphinViewContainer::showErrorMessage(const QString
& msg
)
663 showMessage(msg
, Error
);
666 bool DolphinViewContainer::isSearchUrl(const QUrl
& url
) const
668 return url
.scheme().contains(QStringLiteral("search"));
671 void DolphinViewContainer::saveViewState()
673 QByteArray locationState
;
674 QDataStream
stream(&locationState
, QIODevice::WriteOnly
);
675 m_view
->saveState(stream
);
676 m_urlNavigator
->saveLocationState(locationState
);
679 void DolphinViewContainer::tryRestoreViewState()
681 QByteArray locationState
= m_urlNavigator
->locationState();
682 if (!locationState
.isEmpty()) {
683 QDataStream
stream(&locationState
, QIODevice::ReadOnly
);
684 m_view
->restoreState(stream
);