src/dolphinviewcontainer.cpp

   1 /*
   2  * SPDX-FileCopyrightText: 2007 Peter Penz <peter.penz19@gmail.com>
   3  *
   4  * SPDX-License-Identifier: GPL-2.0-or-later
   5  */
   6
   7 #include "dolphinviewcontainer.h"
   8
   9 #include "dolphin_compactmodesettings.h"
  10 #include "dolphin_contentdisplaysettings.h"
  11 #include "dolphin_detailsmodesettings.h"
  12 #include "dolphin_generalsettings.h"
  13 #include "dolphin_iconsmodesettings.h"
  14 #include "dolphindebug.h"
  15 #include "dolphinplacesmodelsingleton.h"
  16 #include "filterbar/filterbar.h"
  17 #include "global.h"
  18 #include "search/dolphinsearchbox.h"
  19 #include "selectionmode/topbar.h"
  20 #include "statusbar/dolphinstatusbar.h"
  21
  22 #include <KActionCollection>
  23 #if HAVE_PLASMA_ACTIVITIES
  24 #include <PlasmaActivities/ResourceInstance>
  25 #endif
  26 #include <KApplicationTrader>
  27 #include <KFileItemActions>
  28 #include <KFilePlacesModel>
  29 #include <KIO/JobUiDelegateFactory>
  30 #include <KIO/OpenUrlJob>
  31 #include <KLocalizedString>
  32 #include <KMessageWidget>
  33 #include <KProtocolManager>
  34 #include <KShell>
  35 #include <kio_version.h>
  36
  37 #include <QApplication>
  38 #include <QDesktopServices>
  39 #include <QDropEvent>
  40 #include <QGridLayout>
  41 #include <QGuiApplication>
  42 #include <QRegularExpression>
  43 #include <QTimer>
  44 #include <QUrl>
  45
  46 // An overview of the widgets contained by this ViewContainer
  47 struct LayoutStructure {
  48     int searchBox = 0;
  49     int messageWidget = 1;
  50     int selectionModeTopBar = 2;
  51     int view = 3;
  52     int selectionModeBottomBar = 4;
  53     int filterBar = 5;
  54     int statusBar = 6;
  55 };
  56 constexpr LayoutStructure positionFor;
  57
  58 DolphinViewContainer::DolphinViewContainer(const QUrl &url, QWidget *parent)
  59     : QWidget(parent)
  60     , m_topLayout(nullptr)
  61     , m_urlNavigator{new DolphinUrlNavigator(url)}
  62     , m_urlNavigatorConnected{nullptr}
  63     , m_searchBox(nullptr)
  64     , m_searchModeEnabled(false)
  65     , m_messageWidget(nullptr)
  66     , m_selectionModeTopBar{nullptr}
  67     , m_view(nullptr)
  68     , m_filterBar(nullptr)
  69     , m_selectionModeBottomBar{nullptr}
  70     , m_statusBar(nullptr)
  71     , m_statusBarTimer(nullptr)
  72     , m_statusBarTimestamp()
  73     , m_autoGrabFocus(true)
  74 {
  75     hide();
  76
  77     m_topLayout = new QGridLayout(this);
  78     m_topLayout->setSpacing(0);
  79     m_topLayout->setContentsMargins(0, 0, 0, 0);
  80
  81     m_searchBox = new DolphinSearchBox(this);
  82     m_searchBox->setVisible(false, WithoutAnimation);
  83     connect(m_searchBox, &DolphinSearchBox::activated, this, &DolphinViewContainer::activate);
  84     connect(m_searchBox, &DolphinSearchBox::openRequest, this, &DolphinViewContainer::openSearchBox);
  85     connect(m_searchBox, &DolphinSearchBox::closeRequest, this, &DolphinViewContainer::closeSearchBox);
  86     connect(m_searchBox, &DolphinSearchBox::searchRequest, this, &DolphinViewContainer::startSearching);
  87     connect(m_searchBox, &DolphinSearchBox::focusViewRequest, this, &DolphinViewContainer::requestFocus);
  88     m_searchBox->setWhatsThis(xi18nc("@info:whatsthis findbar",
  89                                      "<para>This helps you find files and folders. Enter a <emphasis>"
  90                                      "search term</emphasis> and specify search settings with the "
  91                                      "buttons at the bottom:<list><item>Filename/Content: "
  92                                      "Does the item you are looking for contain the search terms "
  93                                      "within its filename or its contents?<nl/>The contents of images, "
  94                                      "audio files and videos will not be searched.</item><item>"
  95                                      "From Here/Everywhere: Do you want to search in this "
  96                                      "folder and its sub-folders or everywhere?</item><item>"
  97                                      "More Options: Click this to search by media type, access "
  98                                      "time or rating.</item><item>More Search Tools: Install other "
  99                                      "means to find an item.</item></list></para>"));
 100
 101     m_messageWidget = new KMessageWidget(this);
 102     m_messageWidget->setCloseButtonVisible(true);
 103     m_messageWidget->setPosition(KMessageWidget::Header);
 104     m_messageWidget->hide();
 105
 106 #ifndef Q_OS_WIN
 107     if (getuid() == 0) {
 108         // We must be logged in as the root user; show a big scary warning
 109         showMessage(i18n("Running Dolphin as root can be dangerous. Please be careful."), Warning);
 110     }
 111 #endif
 112
 113     // Initialize filter bar
 114     m_filterBar = new FilterBar(this);
 115     m_filterBar->setVisible(GeneralSettings::filterBar(), WithoutAnimation);
 116
 117     connect(m_filterBar, &FilterBar::filterChanged, this, &DolphinViewContainer::setNameFilter);
 118     connect(m_filterBar, &FilterBar::closeRequest, this, &DolphinViewContainer::closeFilterBar);
 119     connect(m_filterBar, &FilterBar::focusViewRequest, this, &DolphinViewContainer::requestFocus);
 120
 121     // Initialize the main view
 122     m_view = new DolphinView(url, this);
 123     connect(m_view, &DolphinView::urlChanged, m_filterBar, &FilterBar::clearIfUnlocked);
 124     connect(m_view, &DolphinView::urlChanged, m_messageWidget, &KMessageWidget::hide);
 125     // m_urlNavigator stays in sync with m_view's location changes and
 126     // keeps track of them so going back and forth in the history works.
 127     connect(m_view, &DolphinView::urlChanged, m_urlNavigator.get(), &DolphinUrlNavigator::setLocationUrl);
 128     connect(m_urlNavigator.get(), &DolphinUrlNavigator::urlChanged, this, &DolphinViewContainer::slotUrlNavigatorLocationChanged);
 129     connect(m_urlNavigator.get(), &DolphinUrlNavigator::urlAboutToBeChanged, this, &DolphinViewContainer::slotUrlNavigatorLocationAboutToBeChanged);
 130     connect(m_urlNavigator.get(), &DolphinUrlNavigator::urlSelectionRequested, this, &DolphinViewContainer::slotUrlSelectionRequested);
 131     connect(m_view, &DolphinView::writeStateChanged, this, &DolphinViewContainer::writeStateChanged);
 132     connect(m_view, &DolphinView::requestItemInfo, this, &DolphinViewContainer::showItemInfo);
 133     connect(m_view, &DolphinView::itemActivated, this, &DolphinViewContainer::slotItemActivated);
 134     connect(m_view, &DolphinView::fileMiddleClickActivated, this, &DolphinViewContainer::slotfileMiddleClickActivated);
 135     connect(m_view, &DolphinView::itemsActivated, this, &DolphinViewContainer::slotItemsActivated);
 136     connect(m_view, &DolphinView::redirection, this, &DolphinViewContainer::redirect);
 137     connect(m_view, &DolphinView::directoryLoadingStarted, this, &DolphinViewContainer::slotDirectoryLoadingStarted);
 138     connect(m_view, &DolphinView::directoryLoadingCompleted, this, &DolphinViewContainer::slotDirectoryLoadingCompleted);
 139     connect(m_view, &DolphinView::directoryLoadingCanceled, this, &DolphinViewContainer::slotDirectoryLoadingCanceled);
 140     connect(m_view, &DolphinView::itemCountChanged, this, &DolphinViewContainer::delayedStatusBarUpdate);
 141     connect(m_view, &DolphinView::directoryLoadingProgress, this, &DolphinViewContainer::updateDirectoryLoadingProgress);
 142     connect(m_view, &DolphinView::directorySortingProgress, this, &DolphinViewContainer::updateDirectorySortingProgress);
 143     connect(m_view, &DolphinView::selectionChanged, this, &DolphinViewContainer::delayedStatusBarUpdate);
 144     connect(m_view, &DolphinView::errorMessage, this, &DolphinViewContainer::showErrorMessage);
 145     connect(m_view, &DolphinView::urlIsFileError, this, &DolphinViewContainer::slotUrlIsFileError);
 146     connect(m_view, &DolphinView::activated, this, &DolphinViewContainer::activate);
 147     connect(m_view, &DolphinView::hiddenFilesShownChanged, this, &DolphinViewContainer::slotHiddenFilesShownChanged);
 148     connect(m_view, &DolphinView::sortHiddenLastChanged, this, &DolphinViewContainer::slotSortHiddenLastChanged);
 149     connect(m_view, &DolphinView::currentDirectoryRemoved, this, &DolphinViewContainer::slotCurrentDirectoryRemoved);
 150
 151     // Initialize status bar
 152     m_statusBar = new DolphinStatusBar(this);
 153     m_statusBar->setUrl(m_view->url());
 154     m_statusBar->setZoomLevel(m_view->zoomLevel());
 155     connect(m_view, &DolphinView::urlChanged, m_statusBar, &DolphinStatusBar::setUrl);
 156     connect(m_view, &DolphinView::zoomLevelChanged, m_statusBar, &DolphinStatusBar::setZoomLevel);
 157     connect(m_view, &DolphinView::infoMessage, m_statusBar, &DolphinStatusBar::setText);
 158     connect(m_view, &DolphinView::operationCompletedMessage, m_statusBar, &DolphinStatusBar::setText);
 159     connect(m_view, &DolphinView::statusBarTextChanged, m_statusBar, &DolphinStatusBar::setDefaultText);
 160     connect(m_view, &DolphinView::statusBarTextChanged, m_statusBar, &DolphinStatusBar::resetToDefaultText);
 161     connect(m_statusBar, &DolphinStatusBar::stopPressed, this, &DolphinViewContainer::stopDirectoryLoading);
 162     connect(m_statusBar, &DolphinStatusBar::zoomLevelChanged, this, &DolphinViewContainer::slotStatusBarZoomLevelChanged);
 163
 164     m_statusBarTimer = new QTimer(this);
 165     m_statusBarTimer->setSingleShot(true);
 166     m_statusBarTimer->setInterval(300);
 167     connect(m_statusBarTimer, &QTimer::timeout, this, &DolphinViewContainer::updateStatusBar);
 168
 169     KIO::FileUndoManager *undoManager = KIO::FileUndoManager::self();
 170     connect(undoManager, &KIO::FileUndoManager::jobRecordingFinished, this, &DolphinViewContainer::delayedStatusBarUpdate);
 171
 172     m_topLayout->addWidget(m_searchBox, positionFor.searchBox, 0);
 173     m_topLayout->addWidget(m_messageWidget, positionFor.messageWidget, 0);
 174     m_topLayout->addWidget(m_view, positionFor.view, 0);
 175     m_topLayout->addWidget(m_filterBar, positionFor.filterBar, 0);
 176     m_topLayout->addWidget(m_statusBar, positionFor.statusBar, 0);
 177
 178     setSearchModeEnabled(isSearchUrl(url));
 179
 180     // Update view as the ContentDisplaySettings change
 181     // this happens here and not in DolphinView as DolphinviewContainer and DolphinView are not in the same build target ATM
 182     connect(ContentDisplaySettings::self(), &KCoreConfigSkeleton::configChanged, m_view, &DolphinView::reload);
 183
 184     KFilePlacesModel *placesModel = DolphinPlacesModelSingleton::instance().placesModel();
 185     connect(placesModel, &KFilePlacesModel::dataChanged, this, &DolphinViewContainer::slotPlacesModelChanged);
 186     connect(placesModel, &KFilePlacesModel::rowsInserted, this, &DolphinViewContainer::slotPlacesModelChanged);
 187     connect(placesModel, &KFilePlacesModel::rowsRemoved, this, &DolphinViewContainer::slotPlacesModelChanged);
 188
 189     connect(this, &DolphinViewContainer::searchModeEnabledChanged, this, &DolphinViewContainer::captionChanged);
 190 }
 191
 192 DolphinViewContainer::~DolphinViewContainer()
 193 {
 194 }
 195
 196 QUrl DolphinViewContainer::url() const
 197 {
 198     return m_view->url();
 199 }
 200
 201 KFileItem DolphinViewContainer::rootItem() const
 202 {
 203     return m_view->rootItem();
 204 }
 205
 206 void DolphinViewContainer::setActive(bool active)
 207 {
 208     m_searchBox->setActive(active);
 209     if (m_urlNavigatorConnected) {
 210         m_urlNavigatorConnected->setActive(active);
 211     }
 212     m_view->setActive(active);
 213 }
 214
 215 bool DolphinViewContainer::isActive() const
 216 {
 217     return m_view->isActive();
 218 }
 219
 220 void DolphinViewContainer::setAutoGrabFocus(bool grab)
 221 {
 222     m_autoGrabFocus = grab;
 223 }
 224
 225 bool DolphinViewContainer::autoGrabFocus() const
 226 {
 227     return m_autoGrabFocus;
 228 }
 229
 230 QString DolphinViewContainer::currentSearchText() const
 231 {
 232     return m_searchBox->text();
 233 }
 234
 235 const DolphinStatusBar *DolphinViewContainer::statusBar() const
 236 {
 237     return m_statusBar;
 238 }
 239
 240 DolphinStatusBar *DolphinViewContainer::statusBar()
 241 {
 242     return m_statusBar;
 243 }
 244
 245 const DolphinUrlNavigator *DolphinViewContainer::urlNavigator() const
 246 {
 247     return m_urlNavigatorConnected;
 248 }
 249
 250 DolphinUrlNavigator *DolphinViewContainer::urlNavigator()
 251 {
 252     return m_urlNavigatorConnected;
 253 }
 254
 255 const DolphinUrlNavigator *DolphinViewContainer::urlNavigatorInternalWithHistory() const
 256 {
 257     return m_urlNavigator.get();
 258 }
 259
 260 DolphinUrlNavigator *DolphinViewContainer::urlNavigatorInternalWithHistory()
 261 {
 262     return m_urlNavigator.get();
 263 }
 264
 265 const DolphinView *DolphinViewContainer::view() const
 266 {
 267     return m_view;
 268 }
 269
 270 DolphinView *DolphinViewContainer::view()
 271 {
 272     return m_view;
 273 }
 274
 275 void DolphinViewContainer::connectUrlNavigator(DolphinUrlNavigator *urlNavigator)
 276 {
 277     Q_CHECK_PTR(urlNavigator);
 278     Q_ASSERT(!m_urlNavigatorConnected);
 279     Q_ASSERT(m_urlNavigator.get() != urlNavigator);
 280     Q_CHECK_PTR(m_view);
 281
 282     urlNavigator->setLocationUrl(m_view->url());
 283     urlNavigator->setShowHiddenFolders(m_view->hiddenFilesShown());
 284     urlNavigator->setSortHiddenFoldersLast(m_view->sortHiddenLast());
 285     if (m_urlNavigatorVisualState) {
 286         urlNavigator->setVisualState(*m_urlNavigatorVisualState.get());
 287         m_urlNavigatorVisualState.reset();
 288     }
 289     urlNavigator->setActive(isActive());
 290
 291     // Url changes are still done via m_urlNavigator.
 292     connect(urlNavigator, &DolphinUrlNavigator::urlChanged, m_urlNavigator.get(), &DolphinUrlNavigator::setLocationUrl);
 293     connect(urlNavigator, &DolphinUrlNavigator::urlsDropped, this, [=](const QUrl &destination, QDropEvent *event) {
 294         m_view->dropUrls(destination, event, urlNavigator->dropWidget());
 295     });
 296     // Aside from these, only visual things need to be connected.
 297     connect(m_view, &DolphinView::urlChanged, urlNavigator, &DolphinUrlNavigator::setLocationUrl);
 298     connect(urlNavigator, &DolphinUrlNavigator::activated, this, &DolphinViewContainer::activate);
 299
 300     m_urlNavigatorConnected = urlNavigator;
 301 }
 302
 303 void DolphinViewContainer::disconnectUrlNavigator()
 304 {
 305     if (!m_urlNavigatorConnected) {
 306         return;
 307     }
 308
 309     disconnect(m_urlNavigatorConnected, &DolphinUrlNavigator::urlChanged, m_urlNavigator.get(), &DolphinUrlNavigator::setLocationUrl);
 310     disconnect(m_urlNavigatorConnected, &DolphinUrlNavigator::urlsDropped, this, nullptr);
 311     disconnect(m_view, &DolphinView::urlChanged, m_urlNavigatorConnected, &DolphinUrlNavigator::setLocationUrl);
 312     disconnect(m_urlNavigatorConnected, &DolphinUrlNavigator::activated, this, &DolphinViewContainer::activate);
 313
 314     m_urlNavigatorVisualState = m_urlNavigatorConnected->visualState();
 315     m_urlNavigatorConnected = nullptr;
 316 }
 317
 318 void DolphinViewContainer::setSelectionModeEnabled(bool enabled, KActionCollection *actionCollection, SelectionMode::BottomBar::Contents bottomBarContents)
 319 {
 320     const bool wasEnabled = m_view->selectionMode();
 321     m_view->setSelectionModeEnabled(enabled);
 322
 323     if (!enabled) {
 324         if (!wasEnabled) {
 325             return; // nothing to do here
 326         }
 327         Q_CHECK_PTR(m_selectionModeTopBar); // there is no point in disabling selectionMode when it wasn't even enabled once.
 328         Q_CHECK_PTR(m_selectionModeBottomBar);
 329         m_selectionModeTopBar->setVisible(false, WithAnimation);
 330         m_selectionModeBottomBar->setVisible(false, WithAnimation);
 331         Q_EMIT selectionModeChanged(false);
 332
 333         if (!QApplication::focusWidget() || m_selectionModeTopBar->isAncestorOf(QApplication::focusWidget())
 334             || m_selectionModeBottomBar->isAncestorOf(QApplication::focusWidget())) {
 335             m_view->setFocus();
 336         }
 337         return;
 338     }
 339
 340     if (!m_selectionModeTopBar) {
 341         // Changing the location will disable selection mode.
 342         connect(m_urlNavigator.get(), &DolphinUrlNavigator::urlChanged, this, [this]() {
 343             setSelectionModeEnabled(false);
 344         });
 345
 346         m_selectionModeTopBar = new SelectionMode::TopBar(this); // will be created hidden
 347         connect(m_selectionModeTopBar, &SelectionMode::TopBar::selectionModeLeavingRequested, this, [this]() {
 348             setSelectionModeEnabled(false);
 349         });
 350         m_topLayout->addWidget(m_selectionModeTopBar, positionFor.selectionModeTopBar, 0);
 351     }
 352
 353     if (!m_selectionModeBottomBar) {
 354         m_selectionModeBottomBar = new SelectionMode::BottomBar(actionCollection, this);
 355         connect(m_view, &DolphinView::selectionChanged, this, [this](const KFileItemList &selection) {
 356             m_selectionModeBottomBar->slotSelectionChanged(selection, m_view->url());
 357         });
 358         connect(m_selectionModeBottomBar, &SelectionMode::BottomBar::error, this, [this](const QString &errorMessage) {
 359             showErrorMessage(errorMessage);
 360         });
 361         connect(m_selectionModeBottomBar, &SelectionMode::BottomBar::selectionModeLeavingRequested, this, [this]() {
 362             setSelectionModeEnabled(false);
 363         });
 364         m_topLayout->addWidget(m_selectionModeBottomBar, positionFor.selectionModeBottomBar, 0);
 365     }
 366     m_selectionModeBottomBar->resetContents(bottomBarContents);
 367     if (bottomBarContents == SelectionMode::BottomBar::GeneralContents) {
 368         m_selectionModeBottomBar->slotSelectionChanged(m_view->selectedItems(), m_view->url());
 369     }
 370
 371     if (!wasEnabled) {
 372         m_selectionModeTopBar->setVisible(true, WithAnimation);
 373         m_selectionModeBottomBar->setVisible(true, WithAnimation);
 374         Q_EMIT selectionModeChanged(true);
 375     }
 376 }
 377
 378 bool DolphinViewContainer::isSelectionModeEnabled() const
 379 {
 380     const bool isEnabled = m_view->selectionMode();
 381     Q_ASSERT((!isEnabled
 382               // We can't assert that the bars are invisible only because the selection mode is disabled because the hide animation might still be playing.
 383               && (!m_selectionModeBottomBar || !m_selectionModeBottomBar->isEnabled() || !m_selectionModeBottomBar->isVisible()
 384                   || m_selectionModeBottomBar->contents() == SelectionMode::BottomBar::PasteContents))
 385              || (isEnabled && m_selectionModeTopBar
 386                  && m_selectionModeTopBar->isVisible()
 387                  // The bottom bar is either visible or was hidden because it has nothing to show in GeneralContents mode e.g. because no items are selected.
 388                  && m_selectionModeBottomBar
 389                  && (m_selectionModeBottomBar->isVisible() || m_selectionModeBottomBar->contents() == SelectionMode::BottomBar::GeneralContents)));
 390     return isEnabled;
 391 }
 392
 393 void DolphinViewContainer::slotSplitTabDisabled()
 394 {
 395     if (m_selectionModeBottomBar) {
 396         m_selectionModeBottomBar->slotSplitTabDisabled();
 397     }
 398 }
 399
 400 void DolphinViewContainer::showMessage(const QString &msg, MessageType type)
 401 {
 402     if (msg.isEmpty()) {
 403         return;
 404     }
 405
 406     m_messageWidget->setText(msg);
 407
 408     // TODO: wrap at arbitrary character positions once QLabel can do this
 409     // https://bugreports.qt.io/browse/QTBUG-1276
 410     m_messageWidget->setWordWrap(true);
 411
 412     switch (type) {
 413     case Information:
 414         m_messageWidget->setMessageType(KMessageWidget::Information);
 415         break;
 416     case Warning:
 417         m_messageWidget->setMessageType(KMessageWidget::Warning);
 418         break;
 419     case Error:
 420         m_messageWidget->setMessageType(KMessageWidget::Error);
 421         break;
 422     default:
 423         Q_ASSERT(false);
 424         break;
 425     }
 426
 427     m_messageWidget->setWordWrap(false);
 428     const int unwrappedWidth = m_messageWidget->sizeHint().width();
 429     m_messageWidget->setWordWrap(unwrappedWidth > size().width());
 430
 431     if (m_messageWidget->isVisible()) {
 432         m_messageWidget->hide();
 433     }
 434     m_messageWidget->animatedShow();
 435 }
 436
 437 void DolphinViewContainer::readSettings()
 438 {
 439     // The startup settings should (only) get applied if they have been
 440     // modified by the user. Otherwise keep the (possibly) different current
 441     // setting of the filterbar.
 442     if (GeneralSettings::modifiedStartupSettings()) {
 443         setFilterBarVisible(GeneralSettings::filterBar());
 444     }
 445
 446     m_view->readSettings();
 447     m_statusBar->readSettings();
 448 }
 449
 450 bool DolphinViewContainer::isFilterBarVisible() const
 451 {
 452     return m_filterBar->isEnabled(); // Gets disabled in AnimatedHeightWidget while animating towards a hidden state.
 453 }
 454
 455 void DolphinViewContainer::setSearchModeEnabled(bool enabled)
 456 {
 457     m_searchBox->setVisible(enabled, WithAnimation);
 458
 459     if (enabled) {
 460         const QUrl &locationUrl = m_urlNavigator->locationUrl();
 461         m_searchBox->fromSearchUrl(locationUrl);
 462     }
 463
 464     if (enabled == isSearchModeEnabled()) {
 465         if (enabled && !m_searchBox->hasFocus()) {
 466             m_searchBox->setFocus();
 467             m_searchBox->selectAll();
 468         }
 469         return;
 470     }
 471
 472     if (!enabled) {
 473         m_view->setViewPropertiesContext(QString());
 474
 475         // Restore the URL for the URL navigator. If Dolphin has been
 476         // started with a search-URL, the home URL is used as fallback.
 477         QUrl url = m_searchBox->searchPath();
 478         if (url.isEmpty() || !url.isValid() || isSearchUrl(url)) {
 479             url = Dolphin::homeUrl();
 480         }
 481         m_urlNavigatorConnected->setLocationUrl(url);
 482     }
 483
 484     m_searchModeEnabled = enabled;
 485
 486     Q_EMIT searchModeEnabledChanged(enabled);
 487 }
 488
 489 bool DolphinViewContainer::isSearchModeEnabled() const
 490 {
 491     return m_searchModeEnabled;
 492 }
 493
 494 QString DolphinViewContainer::placesText() const
 495 {
 496     QString text;
 497
 498     if (isSearchModeEnabled()) {
 499         text = i18n("Search for %1 in %2", m_searchBox->text(), m_searchBox->searchPath().fileName());
 500     } else {
 501         text = url().adjusted(QUrl::StripTrailingSlash).fileName();
 502         if (text.isEmpty()) {
 503             text = url().host();
 504         }
 505         if (text.isEmpty()) {
 506             text = url().scheme();
 507         }
 508     }
 509
 510     return text;
 511 }
 512
 513 void DolphinViewContainer::reload()
 514 {
 515     view()->reload();
 516     m_messageWidget->hide();
 517 }
 518
 519 QString DolphinViewContainer::captionWindowTitle() const
 520 {
 521     if (GeneralSettings::showFullPathInTitlebar() && !isSearchModeEnabled()) {
 522         if (!url().isLocalFile()) {
 523             return url().adjusted(QUrl::StripTrailingSlash).toString();
 524         }
 525         return url().adjusted(QUrl::StripTrailingSlash).path();
 526     } else {
 527         return DolphinViewContainer::caption();
 528     }
 529 }
 530
 531 QString DolphinViewContainer::caption() const
 532 {
 533     if (isSearchModeEnabled()) {
 534         if (currentSearchText().isEmpty()) {
 535             return i18n("Search");
 536         } else {
 537             return i18n("Search for %1", currentSearchText());
 538         }
 539     }
 540
 541     KFilePlacesModel *placesModel = DolphinPlacesModelSingleton::instance().placesModel();
 542     const QString pattern = url().adjusted(QUrl::StripTrailingSlash).toString(QUrl::FullyEncoded).append("/?");
 543     const auto &matchedPlaces =
 544         placesModel->match(placesModel->index(0, 0), KFilePlacesModel::UrlRole, QRegularExpression::anchoredPattern(pattern), 1, Qt::MatchRegularExpression);
 545
 546     if (!matchedPlaces.isEmpty()) {
 547         return placesModel->text(matchedPlaces.first());
 548     }
 549
 550     if (!url().isLocalFile()) {
 551         QUrl adjustedUrl = url().adjusted(QUrl::StripTrailingSlash);
 552         QString caption;
 553         if (!adjustedUrl.fileName().isEmpty()) {
 554             caption = adjustedUrl.fileName();
 555         } else if (!adjustedUrl.path().isEmpty() && adjustedUrl.path() != "/") {
 556             caption = adjustedUrl.path();
 557         } else if (!adjustedUrl.host().isEmpty()) {
 558             caption = adjustedUrl.host();
 559         } else {
 560             caption = adjustedUrl.toString();
 561         }
 562         return caption;
 563     }
 564
 565     QString fileName = url().adjusted(QUrl::StripTrailingSlash).fileName();
 566     if (fileName.isEmpty()) {
 567         fileName = '/';
 568     }
 569
 570     return fileName;
 571 }
 572
 573 void DolphinViewContainer::setUrl(const QUrl &newUrl)
 574 {
 575     if (newUrl != m_urlNavigator->locationUrl()) {
 576         m_urlNavigator->setLocationUrl(newUrl);
 577     }
 578
 579 #if HAVE_PLASMA_ACTIVITIES
 580     KActivities::ResourceInstance::notifyAccessed(newUrl);
 581 #endif
 582 }
 583
 584 void DolphinViewContainer::setFilterBarVisible(bool visible)
 585 {
 586     Q_ASSERT(m_filterBar);
 587     if (visible) {
 588         m_view->hideToolTip(ToolTipManager::HideBehavior::Instantly);
 589         m_filterBar->setVisible(true, WithAnimation);
 590         m_filterBar->setFocus();
 591         m_filterBar->selectAll();
 592     } else {
 593         closeFilterBar();
 594     }
 595 }
 596
 597 void DolphinViewContainer::delayedStatusBarUpdate()
 598 {
 599     if (m_statusBarTimer->isActive() && (m_statusBarTimestamp.elapsed() > 2000)) {
 600         // No update of the statusbar has been done during the last 2 seconds,
 601         // although an update has been requested. Trigger an immediate update.
 602         m_statusBarTimer->stop();
 603         updateStatusBar();
 604     } else {
 605         // Invoke updateStatusBar() with a small delay. This assures that
 606         // when a lot of delayedStatusBarUpdates() are done in a short time,
 607         // no bottleneck is given.
 608         m_statusBarTimer->start();
 609     }
 610 }
 611
 612 void DolphinViewContainer::updateStatusBar()
 613 {
 614     m_statusBarTimestamp.start();
 615     m_view->requestStatusBarText();
 616 }
 617
 618 void DolphinViewContainer::updateDirectoryLoadingProgress(int percent)
 619 {
 620     if (m_statusBar->progressText().isEmpty()) {
 621         m_statusBar->setProgressText(i18nc("@info:progress", "Loading folder…"));
 622     }
 623     m_statusBar->setProgress(percent);
 624 }
 625
 626 void DolphinViewContainer::updateDirectorySortingProgress(int percent)
 627 {
 628     if (m_statusBar->progressText().isEmpty()) {
 629         m_statusBar->setProgressText(i18nc("@info:progress", "Sorting…"));
 630     }
 631     m_statusBar->setProgress(percent);
 632 }
 633
 634 void DolphinViewContainer::slotDirectoryLoadingStarted()
 635 {
 636     if (isSearchUrl(url())) {
 637         // Search KIO-slaves usually don't provide any progress information. Give
 638         // a hint to the user that a searching is done:
 639         updateStatusBar();
 640         m_statusBar->setProgressText(i18nc("@info", "Searching…"));
 641         m_statusBar->setProgress(-1);
 642     } else {
 643         // Trigger an undetermined progress indication. The progress
 644         // information in percent will be triggered by the percent() signal
 645         // of the directory lister later.
 646         m_statusBar->setProgressText(QString());
 647         updateDirectoryLoadingProgress(-1);
 648     }
 649 }
 650
 651 void DolphinViewContainer::slotDirectoryLoadingCompleted()
 652 {
 653     if (!m_statusBar->progressText().isEmpty()) {
 654         m_statusBar->setProgressText(QString());
 655         m_statusBar->setProgress(100);
 656     }
 657
 658     if (isSearchUrl(url()) && m_view->itemsCount() == 0) {
 659         // The dir lister has been completed on a Baloo-URI and no items have been found. Instead
 660         // of showing the default status bar information ("0 items") a more helpful information is given:
 661         m_statusBar->setText(i18nc("@info:status", "No items found."));
 662     } else {
 663         updateStatusBar();
 664     }
 665 }
 666
 667 void DolphinViewContainer::slotDirectoryLoadingCanceled()
 668 {
 669     if (!m_statusBar->progressText().isEmpty()) {
 670         m_statusBar->setProgressText(QString());
 671         m_statusBar->setProgress(100);
 672     }
 673
 674     m_statusBar->setText(QString());
 675 }
 676
 677 void DolphinViewContainer::slotUrlIsFileError(const QUrl &url)
 678 {
 679     const KFileItem item(url);
 680
 681     // Find out if the file can be opened in the view (for example, this is the
 682     // case if the file is an archive). The mime type must be known for that.
 683     item.determineMimeType();
 684     const QUrl &folderUrl = DolphinView::openItemAsFolderUrl(item, true);
 685     if (!folderUrl.isEmpty()) {
 686         setUrl(folderUrl);
 687     } else {
 688         slotItemActivated(item);
 689     }
 690 }
 691
 692 void DolphinViewContainer::slotItemActivated(const KFileItem &item)
 693 {
 694     // It is possible to activate items on inactive views by
 695     // drag & drop operations. Assure that activating an item always
 696     // results in an active view.
 697     m_view->setActive(true);
 698
 699     const QUrl &url = DolphinView::openItemAsFolderUrl(item, GeneralSettings::browseThroughArchives());
 700     if (!url.isEmpty()) {
 701         const auto modifiers = QGuiApplication::keyboardModifiers();
 702         // keep in sync with KUrlNavigator::slotNavigatorButtonClicked
 703         if (modifiers & Qt::ControlModifier && modifiers & Qt::ShiftModifier) {
 704             Q_EMIT activeTabRequested(url);
 705         } else if (modifiers & Qt::ControlModifier) {
 706             Q_EMIT tabRequested(url);
 707         } else if (modifiers & Qt::ShiftModifier) {
 708             Dolphin::openNewWindow({KFilePlacesModel::convertedUrl(url)}, this);
 709         } else {
 710             setUrl(url);
 711         }
 712         return;
 713     }
 714
 715     KIO::OpenUrlJob *job = new KIO::OpenUrlJob(item.targetUrl(), item.mimetype());
 716     // Auto*Warning*Handling, errors are put in a KMessageWidget by us in slotOpenUrlFinished.
 717     job->setUiDelegate(KIO::createDefaultJobUiDelegate(KJobUiDelegate::AutoWarningHandlingEnabled, this));
 718     job->setShowOpenOrExecuteDialog(true);
 719     connect(job, &KIO::OpenUrlJob::finished, this, &DolphinViewContainer::slotOpenUrlFinished);
 720     job->start();
 721 }
 722
 723 void DolphinViewContainer::slotfileMiddleClickActivated(const KFileItem &item)
 724 {
 725     KService::List services = KApplicationTrader::queryByMimeType(item.mimetype());
 726
 727     int indexOfAppToOpenFileWith = 1;
 728
 729     // executable scripts
 730     auto mimeType = item.currentMimeType();
 731     if (item.isLocalFile() && mimeType.inherits(QStringLiteral("application/x-executable")) && mimeType.inherits(QStringLiteral("text/plain"))
 732         && QFileInfo(item.localPath()).isExecutable()) {
 733         KConfigGroup cfgGroup(KSharedConfig::openConfig(QStringLiteral("kiorc")), QStringLiteral("Executable scripts"));
 734         const QString value = cfgGroup.readEntry("behaviourOnLaunch", "alwaysAsk");
 735
 736         // in case KIO::WidgetsOpenOrExecuteFileHandler::promptUserOpenOrExecute would not open the file
 737         if (value != QLatin1String("open")) {
 738             indexOfAppToOpenFileWith = 0;
 739         }
 740     }
 741
 742     if (services.length() >= indexOfAppToOpenFileWith + 1) {
 743         auto service = services.at(indexOfAppToOpenFileWith);
 744
 745         KIO::ApplicationLauncherJob *job = new KIO::ApplicationLauncherJob(service, this);
 746         job->setUrls({item.url()});
 747
 748         job->setUiDelegate(KIO::createDefaultJobUiDelegate(KJobUiDelegate::AutoHandlingEnabled, this));
 749         connect(job, &KIO::OpenUrlJob::finished, this, &DolphinViewContainer::slotOpenUrlFinished);
 750         job->start();
 751     }
 752 }
 753
 754 void DolphinViewContainer::slotItemsActivated(const KFileItemList &items)
 755 {
 756     Q_ASSERT(items.count() >= 2);
 757
 758     KFileItemActions fileItemActions(this);
 759     fileItemActions.runPreferredApplications(items);
 760 }
 761
 762 void DolphinViewContainer::showItemInfo(const KFileItem &item)
 763 {
 764     if (item.isNull()) {
 765         m_statusBar->resetToDefaultText();
 766     } else {
 767         m_statusBar->setText(item.getStatusBarInfo());
 768     }
 769 }
 770
 771 void DolphinViewContainer::closeFilterBar()
 772 {
 773     m_filterBar->closeFilterBar();
 774     m_view->setFocus();
 775     Q_EMIT showFilterBarChanged(false);
 776 }
 777
 778 void DolphinViewContainer::clearFilterBar()
 779 {
 780     m_filterBar->clearIfUnlocked();
 781 }
 782
 783 void DolphinViewContainer::setNameFilter(const QString &nameFilter)
 784 {
 785     m_view->hideToolTip(ToolTipManager::HideBehavior::Instantly);
 786     m_view->setNameFilter(nameFilter);
 787     delayedStatusBarUpdate();
 788 }
 789
 790 void DolphinViewContainer::activate()
 791 {
 792     setActive(true);
 793 }
 794
 795 void DolphinViewContainer::slotUrlNavigatorLocationAboutToBeChanged(const QUrl &)
 796 {
 797     saveViewState();
 798 }
 799
 800 void DolphinViewContainer::slotUrlNavigatorLocationChanged(const QUrl &url)
 801 {
 802     if (m_urlNavigatorConnected) {
 803         m_urlNavigatorConnected->slotReturnPressed();
 804     }
 805
 806     if (KProtocolManager::supportsListing(url)) {
 807         const bool searchBoxInitialized = isSearchModeEnabled() && m_searchBox->text().isEmpty();
 808         setSearchModeEnabled(isSearchUrl(url) || searchBoxInitialized);
 809
 810         m_view->setUrl(url);
 811         tryRestoreViewState();
 812
 813         if (m_autoGrabFocus && isActive() && !isSearchModeEnabled()) {
 814             // When an URL has been entered, the view should get the focus.
 815             // The focus must be requested asynchronously, as changing the URL might create
 816             // a new view widget.
 817             QTimer::singleShot(0, this, &DolphinViewContainer::requestFocus);
 818         }
 819     } else if (KProtocolManager::isSourceProtocol(url)) {
 820         if (url.scheme().startsWith(QLatin1String("http"))) {
 821             showMessage(i18nc("@info:status", // krazy:exclude=qmethods
 822                               "Dolphin does not support web pages, the web browser has been launched"),
 823                         Information);
 824         } else {
 825             showMessage(i18nc("@info:status", "Protocol not supported by Dolphin, default application has been launched"), Information);
 826         }
 827
 828         QDesktopServices::openUrl(url);
 829         redirect(QUrl(), m_urlNavigator->locationUrl(1));
 830     } else {
 831         if (!url.scheme().isEmpty()) {
 832             showMessage(i18nc("@info:status", "Invalid protocol '%1'", url.scheme()), Error);
 833         } else {
 834             showMessage(i18nc("@info:status", "Invalid protocol"), Error);
 835         }
 836         m_urlNavigator->goBack();
 837     }
 838 }
 839
 840 void DolphinViewContainer::slotUrlSelectionRequested(const QUrl &url)
 841 {
 842     m_view->markUrlsAsSelected({url});
 843     m_view->markUrlAsCurrent(url); // makes the item scroll into view
 844 }
 845
 846 void DolphinViewContainer::disableUrlNavigatorSelectionRequests()
 847 {
 848     disconnect(m_urlNavigator.get(), &KUrlNavigator::urlSelectionRequested, this, &DolphinViewContainer::slotUrlSelectionRequested);
 849 }
 850
 851 void DolphinViewContainer::enableUrlNavigatorSelectionRequests()
 852 {
 853     connect(m_urlNavigator.get(), &KUrlNavigator::urlSelectionRequested, this, &DolphinViewContainer::slotUrlSelectionRequested);
 854 }
 855
 856 void DolphinViewContainer::redirect(const QUrl &oldUrl, const QUrl &newUrl)
 857 {
 858     Q_UNUSED(oldUrl)
 859     const bool block = m_urlNavigator->signalsBlocked();
 860     m_urlNavigator->blockSignals(true);
 861
 862     // Assure that the location state is reset for redirection URLs. This
 863     // allows to skip redirection URLs when going back or forward in the
 864     // URL history.
 865     m_urlNavigator->saveLocationState(QByteArray());
 866     m_urlNavigator->setLocationUrl(newUrl);
 867     setSearchModeEnabled(isSearchUrl(newUrl));
 868
 869     m_urlNavigator->blockSignals(block);
 870 }
 871
 872 void DolphinViewContainer::requestFocus()
 873 {
 874     m_view->setFocus();
 875 }
 876
 877 void DolphinViewContainer::startSearching()
 878 {
 879     Q_CHECK_PTR(m_urlNavigatorConnected);
 880     const QUrl url = m_searchBox->urlForSearching();
 881     if (url.isValid() && !url.isEmpty()) {
 882         m_view->setViewPropertiesContext(QStringLiteral("search"));
 883         m_urlNavigatorConnected->setLocationUrl(url);
 884     }
 885 }
 886
 887 void DolphinViewContainer::openSearchBox()
 888 {
 889     setSearchModeEnabled(true);
 890 }
 891
 892 void DolphinViewContainer::closeSearchBox()
 893 {
 894     setSearchModeEnabled(false);
 895 }
 896
 897 void DolphinViewContainer::stopDirectoryLoading()
 898 {
 899     m_view->stopLoading();
 900     m_statusBar->setProgress(100);
 901 }
 902
 903 void DolphinViewContainer::slotStatusBarZoomLevelChanged(int zoomLevel)
 904 {
 905     m_view->setZoomLevel(zoomLevel);
 906 }
 907
 908 void DolphinViewContainer::showErrorMessage(const QString &msg)
 909 {
 910     showMessage(msg, Error);
 911 }
 912
 913 void DolphinViewContainer::slotPlacesModelChanged()
 914 {
 915     if (!GeneralSettings::showFullPathInTitlebar() && !isSearchModeEnabled()) {
 916         Q_EMIT captionChanged();
 917     }
 918 }
 919
 920 void DolphinViewContainer::slotHiddenFilesShownChanged(bool showHiddenFiles)
 921 {
 922     if (m_urlNavigatorConnected) {
 923         m_urlNavigatorConnected->setShowHiddenFolders(showHiddenFiles);
 924     }
 925 }
 926
 927 void DolphinViewContainer::slotSortHiddenLastChanged(bool hiddenLast)
 928 {
 929     if (m_urlNavigatorConnected) {
 930         m_urlNavigatorConnected->setSortHiddenFoldersLast(hiddenLast);
 931     }
 932 }
 933
 934 void DolphinViewContainer::slotCurrentDirectoryRemoved()
 935 {
 936     const QString location(url().toDisplayString(QUrl::PreferLocalFile));
 937     if (url().isLocalFile()) {
 938         const QString dirPath = url().toLocalFile();
 939         const QString newPath = getNearestExistingAncestorOfPath(dirPath);
 940         const QUrl newUrl = QUrl::fromLocalFile(newPath);
 941         setUrl(newUrl);
 942     }
 943
 944     showMessage(xi18n("Current location changed, <filename>%1</filename> is no longer accessible.", location), Warning);
 945 }
 946
 947 void DolphinViewContainer::slotOpenUrlFinished(KJob *job)
 948 {
 949     if (job->error() && job->error() != KIO::ERR_USER_CANCELED) {
 950         showErrorMessage(job->errorString());
 951     }
 952 }
 953
 954 bool DolphinViewContainer::isSearchUrl(const QUrl &url) const
 955 {
 956     return url.scheme().contains(QLatin1String("search"));
 957 }
 958
 959 void DolphinViewContainer::saveViewState()
 960 {
 961     QByteArray locationState;
 962     QDataStream stream(&locationState, QIODevice::WriteOnly);
 963     m_view->saveState(stream);
 964     m_urlNavigator->saveLocationState(locationState);
 965 }
 966
 967 void DolphinViewContainer::tryRestoreViewState()
 968 {
 969     QByteArray locationState = m_urlNavigator->locationState();
 970     if (!locationState.isEmpty()) {
 971         QDataStream stream(&locationState, QIODevice::ReadOnly);
 972         m_view->restoreState(stream);
 973     }
 974 }
 975
 976 QString DolphinViewContainer::getNearestExistingAncestorOfPath(const QString &path) const
 977 {
 978     QDir dir(path);
 979     do {
 980         dir.setPath(QDir::cleanPath(dir.filePath(QStringLiteral(".."))));
 981     } while (!dir.exists() && !dir.isRoot());
 982
 983     return dir.exists() ? dir.path() : QString{};
 984 }
 985
 986 #include "moc_dolphinviewcontainer.cpp"