src/dolphinviewcontainer.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2007 by Peter Penz <peter.penz@gmx.at>                  *
   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 "dolphinviewcontainer.h"
  21 #include <kprotocolmanager.h>
  22
  23 #include <QtGui/QApplication>
  24 #include <QtGui/QKeyEvent>
  25 #include <QtGui/QItemSelection>
  26 #include <QtGui/QBoxLayout>
  27 #include <QtCore/QTimer>
  28 #include <QtGui/QScrollBar>
  29
  30 #include <kdesktopfile.h>
  31 #include <kfileitemdelegate.h>
  32 #include <kfileplacesmodel.h>
  33 #include <kglobalsettings.h>
  34 #include <klocale.h>
  35 #include <kiconeffect.h>
  36 #include <kio/netaccess.h>
  37 #include <kio/previewjob.h>
  38 #include <kmenu.h>
  39 #include <kmimetyperesolver.h>
  40 #include <knewmenu.h>
  41 #include <konqmimedata.h>
  42 #include <kfileitemlistproperties.h>
  43 #include <konq_operations.h>
  44 #include <kshell.h>
  45 #include <kurl.h>
  46 #include <kurlcombobox.h>
  47 #include <kurlnavigator.h>
  48 #include <krun.h>
  49
  50 #include "dolphin_generalsettings.h"
  51 #include "dolphinmainwindow.h"
  52 #include "filterbar/filterbar.h"
  53 #include "search/dolphinsearchbox.h"
  54 #include "settings/dolphinsettings.h"
  55 #include "statusbar/dolphinstatusbar.h"
  56 #include "views/dolphincolumnview.h"
  57 #include "views/dolphindetailsview.h"
  58 #include "views/dolphindirlister.h"
  59 #include "views/dolphinsortfilterproxymodel.h"
  60 #include "views/draganddrophelper.h"
  61 #include "views/dolphiniconsview.h"
  62 #include "views/dolphinmodel.h"
  63 #include "views/dolphinviewcontroller.h"
  64 #include "views/viewmodecontroller.h"
  65 #include "views/viewproperties.h"
  66
  67 DolphinViewContainer::DolphinViewContainer(const KUrl& url, QWidget* parent) :
  68     QWidget(parent),
  69     m_isFolderWritable(false),
  70     m_topLayout(0),
  71     m_urlNavigator(0),
  72     m_searchBox(0),
  73     m_view(0),
  74     m_filterBar(0),
  75     m_statusBar(0),
  76     m_statusBarTimer(0),
  77     m_statusBarTimestamp(),
  78     m_dirLister(0),
  79     m_proxyModel(0)
  80 {
  81     hide();
  82
  83     m_topLayout = new QVBoxLayout(this);
  84     m_topLayout->setSpacing(0);
  85     m_topLayout->setMargin(0);
  86
  87     m_urlNavigator = new KUrlNavigator(DolphinSettings::instance().placesModel(), url, this);
  88     connect(m_urlNavigator, SIGNAL(urlsDropped(const KUrl&, QDropEvent*)),
  89             this, SLOT(dropUrls(const KUrl&, QDropEvent*)));
  90     connect(m_urlNavigator, SIGNAL(activated()),
  91             this, SLOT(activate()));
  92     connect(m_urlNavigator->editor(), SIGNAL(completionModeChanged(KGlobalSettings::Completion)),
  93             this, SLOT(saveUrlCompletionMode(KGlobalSettings::Completion)));
  94
  95     const GeneralSettings* settings = DolphinSettings::instance().generalSettings();
  96     m_urlNavigator->setUrlEditable(settings->editableUrl());
  97     m_urlNavigator->setShowFullPath(settings->showFullPath());
  98     m_urlNavigator->setHomeUrl(KUrl(settings->homeUrl()));
  99     KUrlComboBox* editor = m_urlNavigator->editor();
 100     editor->setCompletionMode(KGlobalSettings::Completion(settings->urlCompletionMode()));
 101
 102     m_searchBox = new DolphinSearchBox(this);
 103     m_searchBox->hide();
 104     connect(m_searchBox, SIGNAL(closeRequest()), this, SLOT(closeSearchBox()));
 105     connect(m_searchBox, SIGNAL(search(QString)), this, SLOT(startSearching(QString)));
 106     connect(m_searchBox, SIGNAL(returnPressed(QString)), this, SLOT(requestFocus()));
 107
 108     m_dirLister = new DolphinDirLister();
 109     m_dirLister->setAutoUpdate(true);
 110     m_dirLister->setMainWindow(window());
 111     m_dirLister->setDelayedMimeTypes(true);
 112
 113     m_dolphinModel = new DolphinModel(this);
 114     m_dolphinModel->setDirLister(m_dirLister);  // m_dolphinModel takes ownership of m_dirLister
 115     m_dolphinModel->setDropsAllowed(DolphinModel::DropOnDirectory);
 116
 117     m_proxyModel = new DolphinSortFilterProxyModel(this);
 118     m_proxyModel->setSourceModel(m_dolphinModel);
 119     m_proxyModel->setFilterCaseSensitivity(Qt::CaseInsensitive);
 120
 121     connect(m_dirLister, SIGNAL(started(KUrl)),
 122             this, SLOT(initializeProgress()));
 123     connect(m_dirLister, SIGNAL(clear()),
 124             this, SLOT(delayedStatusBarUpdate()));
 125     connect(m_dirLister, SIGNAL(percent(int)),
 126             this, SLOT(updateProgress(int)));
 127     connect(m_dirLister, SIGNAL(itemsDeleted(const KFileItemList&)),
 128             this, SLOT(delayedStatusBarUpdate()));
 129     connect(m_dirLister, SIGNAL(newItems(KFileItemList)),
 130             this, SLOT(delayedStatusBarUpdate()));
 131     connect(m_dirLister, SIGNAL(completed()),
 132             this, SLOT(slotDirListerCompleted()));
 133     connect(m_dirLister, SIGNAL(infoMessage(const QString&)),
 134             this, SLOT(showInfoMessage(const QString&)));
 135     connect(m_dirLister, SIGNAL(errorMessage(const QString&)),
 136             this, SLOT(showErrorMessage(const QString&)));
 137     connect(m_dirLister, SIGNAL(urlIsFileError(const KUrl&)),
 138             this, SLOT(openFile(const KUrl&)));
 139
 140     m_view = new DolphinView(this, url, m_proxyModel);
 141     connect(m_view, SIGNAL(urlChanged(const KUrl&)),
 142             m_urlNavigator, SLOT(setUrl(const KUrl&)));
 143     connect(m_view, SIGNAL(requestItemInfo(KFileItem)),
 144             this, SLOT(showItemInfo(KFileItem)));
 145     connect(m_view, SIGNAL(errorMessage(const QString&)),
 146             this, SLOT(showErrorMessage(const QString&)));
 147     connect(m_view, SIGNAL(infoMessage(const QString&)),
 148             this, SLOT(showInfoMessage(const QString&)));
 149     connect(m_view, SIGNAL(operationCompletedMessage(const QString&)),
 150             this, SLOT(showOperationCompletedMessage(const QString&)));
 151     connect(m_view, SIGNAL(itemTriggered(KFileItem)),
 152             this, SLOT(slotItemTriggered(KFileItem)));
 153     connect(m_view, SIGNAL(redirection(KUrl, KUrl)),
 154             this, SLOT(redirect(KUrl, KUrl)));
 155     connect(m_view, SIGNAL(selectionChanged(const KFileItemList&)),
 156             this, SLOT(delayedStatusBarUpdate()));
 157
 158     connect(m_urlNavigator, SIGNAL(urlChanged(const KUrl&)),
 159             this, SLOT(slotUrlNavigatorLocationChanged(const KUrl&)));
 160     connect(m_urlNavigator, SIGNAL(urlAboutToBeChanged(const KUrl&)),
 161             this, SLOT(saveViewState()));
 162     connect(m_urlNavigator, SIGNAL(historyChanged()),
 163             this, SLOT(slotHistoryChanged()));
 164
 165     // initialize status bar
 166     m_statusBar = new DolphinStatusBar(this, m_view);
 167     m_statusBarTimer = new QTimer(this);
 168     m_statusBarTimer->setSingleShot(true);
 169     m_statusBarTimer->setInterval(300);
 170     connect(m_statusBarTimer, SIGNAL(timeout()),
 171             this, SLOT(updateStatusBar()));
 172
 173     KIO::FileUndoManager* undoManager = KIO::FileUndoManager::self();
 174     connect(undoManager, SIGNAL(jobRecordingFinished(CommandType)),
 175             this, SLOT(delayedStatusBarUpdate()));
 176
 177     // initialize filter bar
 178     m_filterBar = new FilterBar(this);
 179     m_filterBar->setVisible(settings->filterBar());
 180     connect(m_filterBar, SIGNAL(filterChanged(const QString&)),
 181             this, SLOT(setNameFilter(const QString&)));
 182     connect(m_filterBar, SIGNAL(closeRequest()),
 183             this, SLOT(closeFilterBar()));
 184     connect(m_view, SIGNAL(urlChanged(const KUrl&)),
 185             m_filterBar, SLOT(clear()));
 186
 187     m_topLayout->addWidget(m_urlNavigator);
 188     m_topLayout->addWidget(m_searchBox);
 189     m_topLayout->addWidget(m_view);
 190     m_topLayout->addWidget(m_filterBar);
 191     m_topLayout->addWidget(m_statusBar);
 192
 193     setSearchModeEnabled(isSearchUrl(url));
 194 }
 195
 196 DolphinViewContainer::~DolphinViewContainer()
 197 {
 198 }
 199
 200 KUrl DolphinViewContainer::url() const
 201 {
 202     return m_urlNavigator->locationUrl();
 203 }
 204
 205 void DolphinViewContainer::setActive(bool active)
 206 {
 207     m_urlNavigator->setActive(active);
 208     m_view->setActive(active);
 209     if (active) {
 210         emit writeStateChanged(m_isFolderWritable);
 211     }
 212 }
 213
 214 bool DolphinViewContainer::isActive() const
 215 {
 216     Q_ASSERT(m_view->isActive() == m_urlNavigator->isActive());
 217     return m_view->isActive();
 218 }
 219
 220 void DolphinViewContainer::refresh()
 221 {
 222     m_view->refresh();
 223     m_statusBar->refresh();
 224 }
 225
 226 bool DolphinViewContainer::isFilterBarVisible() const
 227 {
 228     return m_filterBar->isVisible();
 229 }
 230
 231 void DolphinViewContainer::setSearchModeEnabled(bool enabled)
 232 {
 233     m_searchBox->setVisible(enabled);
 234     m_urlNavigator->setVisible(!enabled);
 235
 236     if (enabled) {
 237         // Remember the current URL, so that it can be restored
 238         // when switching back to the URL navigator
 239         const KUrl url = m_urlNavigator->locationUrl();
 240         m_searchBox->setSearchPath(url);
 241     } else {
 242         // Restore the URL for the URL navigator. If Dolphin has been
 243         // started with a search-URL, the home URL is used as fallback.
 244         const KUrl url = m_searchBox->searchPath();
 245         if (url.isValid() && !url.isEmpty()) {
 246             if (isSearchUrl(url)) {
 247                 m_urlNavigator->goHome();
 248             } else {
 249                 m_urlNavigator->setLocationUrl(url);
 250             }
 251         }
 252     }
 253 }
 254
 255 bool DolphinViewContainer::isSearchModeEnabled() const
 256 {
 257     return m_searchBox->isVisible();
 258 }
 259
 260 void DolphinViewContainer::setUrl(const KUrl& newUrl)
 261 {
 262     if (newUrl != m_urlNavigator->locationUrl()) {
 263         m_urlNavigator->setLocationUrl(newUrl);
 264         // Temporary disable the 'File'->'Create New...' menu until
 265         // the write permissions can be checked in a fast way at
 266         // DolphinViewContainer::slotDirListerCompleted().
 267         m_isFolderWritable = false;
 268         if (isActive()) {
 269             emit writeStateChanged(false);
 270         }
 271     }
 272 }
 273
 274 void DolphinViewContainer::showFilterBar(bool show)
 275 {
 276     Q_ASSERT(m_filterBar != 0);
 277     if (show) {
 278         m_filterBar->show();
 279     } else {
 280         closeFilterBar();
 281     }
 282 }
 283
 284 void DolphinViewContainer::delayedStatusBarUpdate()
 285 {
 286     if (m_statusBarTimer->isActive() && (m_statusBarTimestamp.elapsed() > 2000)) {
 287         // No update of the statusbar has been done during the last 2 seconds,
 288         // although an update has been requested. Trigger an immediate update.
 289         m_statusBarTimer->stop();
 290         updateStatusBar();
 291     } else {
 292         // Invoke updateStatusBar() with a small delay. This assures that
 293         // when a lot of delayedStatusBarUpdates() are done in a short time,
 294         // no bottleneck is given.
 295         m_statusBarTimer->start();
 296     }
 297 }
 298
 299 void DolphinViewContainer::updateStatusBar()
 300 {
 301     m_statusBarTimestamp.start();
 302
 303     // As the item count information is less important
 304     // in comparison with other messages, it should only
 305     // be shown if:
 306     // - the status bar is empty or
 307     // - shows already the item count information or
 308     // - shows only a not very important information
 309     const QString newMessage = m_view->statusBarText();
 310     const QString currentMessage = m_statusBar->message();
 311     const bool updateStatusBarMsg = currentMessage.isEmpty()
 312                                     || (currentMessage == m_statusBar->defaultText())
 313                                     || (m_statusBar->type() == DolphinStatusBar::Information);
 314
 315     m_statusBar->setDefaultText(newMessage);
 316
 317     if (updateStatusBarMsg) {
 318         m_statusBar->setMessage(newMessage, DolphinStatusBar::Default);
 319     }
 320 }
 321
 322 void DolphinViewContainer::initializeProgress()
 323 {
 324     if (isSearchUrl(url())) {
 325         // Search KIO-slaves usually don't provide any progress information. Give
 326         // an immediate hint to the user that a searching is done:
 327         updateStatusBar();
 328         m_statusBar->setProgressText(i18nc("@info", "Searching..."));
 329         m_statusBar->setProgress(-1);
 330     }
 331  }
 332
 333 void DolphinViewContainer::updateProgress(int percent)
 334 {
 335     if (m_statusBar->progressText().isEmpty()) {
 336         m_statusBar->setProgressText(i18nc("@info:progress", "Loading folder..."));
 337     }
 338     m_statusBar->setProgress(percent);
 339 }
 340
 341 void DolphinViewContainer::slotDirListerCompleted()
 342 {
 343     if (!m_statusBar->progressText().isEmpty()) {
 344         m_statusBar->setProgressText(QString());
 345         m_statusBar->setProgress(100);
 346     }
 347
 348     if (isSearchUrl(url()) && (m_dirLister->items().count() == 0)) {
 349         // The dir lister has been completed on a Nepomuk-URI and no items have been found. Instead
 350         // of showing the default status bar information ("0 items") a more helpful information is given:
 351         m_statusBar->setMessage(i18nc("@info:status", "No items found."), DolphinStatusBar::Information);
 352     } else {
 353         updateStatusBar();
 354     }
 355
 356     // Enable the 'File'->'Create New...' menu only if the directory
 357     // supports writing.
 358     KFileItem item = m_dirLister->rootItem();
 359     if (item.isNull()) {
 360         // it is unclear whether writing is supported
 361         m_isFolderWritable = true;
 362     } else {
 363         KFileItemListProperties capabilities(KFileItemList() << item);
 364         m_isFolderWritable = capabilities.supportsWriting();
 365     }
 366
 367     if (isActive()) {
 368         emit writeStateChanged(m_isFolderWritable);
 369     }
 370 }
 371
 372 void DolphinViewContainer::showItemInfo(const KFileItem& item)
 373 {
 374     if (item.isNull()) {
 375         // Only clear the status bar if unimportant messages are shown.
 376         // This prevents that information- or error-messages get hidden
 377         // by moving the mouse above the viewport or when closing the
 378         // context menu.
 379         if (m_statusBar->type() == DolphinStatusBar::Default) {
 380             m_statusBar->clear();
 381         }
 382     } else {
 383         m_statusBar->setMessage(item.getStatusBarInfo(), DolphinStatusBar::Default);
 384     }
 385 }
 386
 387 void DolphinViewContainer::showInfoMessage(const QString& msg)
 388 {
 389     m_statusBar->setMessage(msg, DolphinStatusBar::Information);
 390 }
 391
 392 void DolphinViewContainer::showErrorMessage(const QString& msg)
 393 {
 394     m_statusBar->setMessage(msg, DolphinStatusBar::Error);
 395 }
 396
 397 void DolphinViewContainer::showOperationCompletedMessage(const QString& msg)
 398 {
 399     m_statusBar->setMessage(msg, DolphinStatusBar::OperationCompleted);
 400 }
 401
 402 void DolphinViewContainer::closeFilterBar()
 403 {
 404     m_filterBar->hide();
 405     m_filterBar->clear();
 406     m_view->setFocus();
 407     emit showFilterBarChanged(false);
 408 }
 409
 410 void DolphinViewContainer::setNameFilter(const QString& nameFilter)
 411 {
 412     m_view->setNameFilter(nameFilter);
 413     delayedStatusBarUpdate();
 414 }
 415
 416 void DolphinViewContainer::activate()
 417 {
 418     setActive(true);
 419 }
 420
 421 void DolphinViewContainer::saveViewState()
 422 {
 423     QByteArray locationState;
 424     QDataStream stream(&locationState, QIODevice::WriteOnly);
 425     m_view->saveState(stream);
 426     m_urlNavigator->saveLocationState(locationState);
 427 }
 428
 429 void DolphinViewContainer::slotUrlNavigatorLocationChanged(const KUrl& url)
 430 {
 431     if (KProtocolManager::supportsListing(url)) {
 432          // Assure that the search box is shown instead of the URL navigator in case
 433          // that the URL \p url is a search URL (e. g. nepomuksearch:// or filenamesearch://).
 434         if (isSearchUrl(url)) {
 435             if (!m_searchBox->isVisible()) {
 436                 m_searchBox->setVisible(true);
 437                 m_urlNavigator->setVisible(false);
 438             }
 439         } else if (!m_urlNavigator->isVisible()) {
 440             m_urlNavigator->setVisible(true);
 441             m_searchBox->setVisible(false);
 442         }
 443
 444         m_view->setUrl(url);
 445         if (isActive() && !isSearchUrl(url)) {
 446             // When an URL has been entered, the view should get the focus.
 447             // The focus must be requested asynchronously, as changing the URL might create
 448             // a new view widget.
 449             QTimer::singleShot(0, this, SLOT(requestFocus()));
 450         }
 451     } else if (KProtocolManager::isSourceProtocol(url)) {
 452         QString app = "konqueror";
 453         if (url.protocol().startsWith(QLatin1String("http"))) {
 454             showErrorMessage(i18nc("@info:status",
 455                                    "Dolphin does not support web pages, the web browser has been launched"));
 456             const KConfigGroup config(KSharedConfig::openConfig("kdeglobals"), "General");
 457             const QString browser = config.readEntry("BrowserApplication");
 458             if (!browser.isEmpty()) {
 459                 app = browser;
 460                 if (app.startsWith('!')) {
 461                     // a literal command has been configured, remove the '!' prefix
 462                     app = app.mid(1);
 463                 }
 464             }
 465         } else {
 466             showErrorMessage(i18nc("@info:status",
 467                                    "Protocol not supported by Dolphin, Konqueror has been launched"));
 468         }
 469
 470         const QString secureUrl = KShell::quoteArg(url.pathOrUrl());
 471         const QString command = app + ' ' + secureUrl;
 472         KRun::runCommand(command, app, app, this);
 473     } else {
 474         showErrorMessage(i18nc("@info:status", "Invalid protocol"));
 475     }
 476 }
 477
 478 void DolphinViewContainer::dropUrls(const KUrl& destination, QDropEvent* event)
 479 {
 480     DragAndDropHelper::instance().dropUrls(KFileItem(), destination, event, this);
 481 }
 482
 483 void DolphinViewContainer::redirect(const KUrl& oldUrl, const KUrl& newUrl)
 484 {
 485     Q_UNUSED(oldUrl);
 486     const bool block = m_urlNavigator->signalsBlocked();
 487     m_urlNavigator->blockSignals(true);
 488
 489     // Assure that the location state is reset for redirection URLs. This
 490     // allows to skip redirection URLs when going back or forward in the
 491     // URL history.
 492     m_urlNavigator->saveLocationState(QByteArray());
 493     m_urlNavigator->setLocationUrl(newUrl);
 494
 495     m_urlNavigator->blockSignals(block);
 496 }
 497
 498 void DolphinViewContainer::requestFocus()
 499 {
 500     m_view->setFocus();
 501 }
 502
 503 void DolphinViewContainer::saveUrlCompletionMode(KGlobalSettings::Completion completion)
 504 {
 505     DolphinSettings& settings = DolphinSettings::instance();
 506     settings.generalSettings()->setUrlCompletionMode(completion);
 507     settings.save();
 508 }
 509
 510 void DolphinViewContainer::slotHistoryChanged()
 511 {
 512     QByteArray locationState = m_urlNavigator->locationState();
 513
 514     if (!locationState.isEmpty()) {
 515         QDataStream stream(&locationState, QIODevice::ReadOnly);
 516         m_view->restoreState(stream);
 517     }
 518 }
 519
 520 void DolphinViewContainer::startSearching(const QString &text)
 521 {
 522     Q_UNUSED(text);
 523     const KUrl url = m_searchBox->urlForSearching();
 524     if (url.isValid() && !url.isEmpty()) {
 525         m_urlNavigator->setLocationUrl(url);
 526     }
 527 }
 528
 529 void DolphinViewContainer::closeSearchBox()
 530 {
 531     setSearchModeEnabled(false);
 532 }
 533
 534 bool DolphinViewContainer::isSearchUrl(const KUrl& url) const
 535 {
 536     return url.protocol().contains("search");
 537 }
 538
 539 void DolphinViewContainer::slotItemTriggered(const KFileItem& item)
 540 {
 541     KUrl url = item.targetUrl();
 542
 543     if (item.isDir()) {
 544         m_view->setUrl(url);
 545         return;
 546     }
 547
 548     const GeneralSettings* settings = DolphinSettings::instance().generalSettings();
 549     const bool browseThroughArchives = settings->browseThroughArchives();
 550     if (browseThroughArchives && item.isFile() && url.isLocalFile()) {
 551         // Generic mechanism for redirecting to tar:/<path>/ when clicking on a tar file,
 552         // zip:/<path>/ when clicking on a zip file, etc.
 553         // The .protocol file specifies the mimetype that the kioslave handles.
 554         // Note that we don't use mimetype inheritance since we don't want to
 555         // open OpenDocument files as zip folders...
 556         const QString protocol = KProtocolManager::protocolForArchiveMimetype(item.mimetype());
 557         if (!protocol.isEmpty()) {
 558             url.setProtocol(protocol);
 559             m_view->setUrl(url);
 560             return;
 561         }
 562     }
 563
 564     if (item.mimetype() == "application/x-desktop") {
 565         // redirect to the url in Type=Link desktop files
 566         KDesktopFile desktopFile(url.toLocalFile());
 567         if (desktopFile.hasLinkType()) {
 568             url = desktopFile.readUrl();
 569             m_view->setUrl(url);
 570             return;
 571         }
 572     }
 573
 574     item.run();
 575 }
 576
 577 void DolphinViewContainer::openFile(const KUrl& url)
 578 {
 579     // Using m_dolphinModel for getting the file item instance is not possible
 580     // here: openFile() is triggered by an error of the directory lister
 581     // job, so the file item must be received "manually".
 582     const KFileItem item(KFileItem::Unknown, KFileItem::Unknown, url);
 583     slotItemTriggered(item);
 584 }
 585
 586 #include "dolphinviewcontainer.moc"