src/panels/folders/folderspanel.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2006-2010 by Peter Penz <peter.penz19@gmail.com>        *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  18  ***************************************************************************/
  19
  20 #include "folderspanel.h"
  21
  22 #include "dolphin_folderspanelsettings.h"
  23 #include "dolphin_generalsettings.h"
  24 #include "foldersitemlistwidget.h"
  25 #include "global.h"
  26 #include "kitemviews/kfileitemlistview.h"
  27 #include "kitemviews/kfileitemmodel.h"
  28 #include "kitemviews/kitemlistcontainer.h"
  29 #include "kitemviews/kitemlistcontroller.h"
  30 #include "kitemviews/kitemlistselectionmanager.h"
  31 #include "treeviewcontextmenu.h"
  32 #include "views/draganddrophelper.h"
  33 #include "views/renamedialog.h"
  34
  35 #include <KJobWidgets>
  36 #include <KJobUiDelegate>
  37 #include <KIO/CopyJob>
  38 #include <KIO/DropJob>
  39 #include <KIO/FileUndoManager>
  40
  41 #include <QApplication>
  42 #include <QBoxLayout>
  43 #include <QGraphicsSceneDragDropEvent>
  44 #include <QGraphicsView>
  45 #include <QPropertyAnimation>
  46 #include <QTimer>
  47
  48 FoldersPanel::FoldersPanel(QWidget* parent) :
  49     Panel(parent),
  50     m_updateCurrentItem(false),
  51     m_controller(nullptr),
  52     m_model(nullptr)
  53 {
  54     setLayoutDirection(Qt::LeftToRight);
  55 }
  56
  57 FoldersPanel::~FoldersPanel()
  58 {
  59     FoldersPanelSettings::self()->save();
  60
  61     if (m_controller) {
  62         KItemListView* view = m_controller->view();
  63         m_controller->setView(nullptr);
  64         delete view;
  65     }
  66 }
  67
  68 void FoldersPanel::setShowHiddenFiles(bool show)
  69 {
  70     FoldersPanelSettings::setHiddenFilesShown(show);
  71     m_model->setShowHiddenFiles(show);
  72 }
  73
  74 bool FoldersPanel::showHiddenFiles() const
  75 {
  76     return FoldersPanelSettings::hiddenFilesShown();
  77 }
  78
  79 void FoldersPanel::setLimitFoldersPanelToHome(bool enable)
  80 {
  81     FoldersPanelSettings::setLimitFoldersPanelToHome(enable);
  82     reloadTree();
  83 }
  84
  85 bool FoldersPanel::limitFoldersPanelToHome() const
  86 {
  87     return FoldersPanelSettings::limitFoldersPanelToHome();
  88 }
  89
  90 void FoldersPanel::setAutoScrolling(bool enable)
  91 {
  92     // TODO: Not supported yet in Dolphin 2.0
  93     FoldersPanelSettings::setAutoScrolling(enable);
  94 }
  95
  96 bool FoldersPanel::autoScrolling() const
  97 {
  98     return FoldersPanelSettings::autoScrolling();
  99 }
 100
 101 void FoldersPanel::rename(const KFileItem& item)
 102 {
 103     if (GeneralSettings::renameInline()) {
 104         const int index = m_model->index(item);
 105         m_controller->view()->editRole(index, "text");
 106     } else {
 107         RenameDialog* dialog = new RenameDialog(this, KFileItemList() << item);
 108         dialog->show();
 109         dialog->raise();
 110         dialog->activateWindow();
 111     }
 112 }
 113
 114 bool FoldersPanel::urlChanged()
 115 {
 116     if (!url().isValid() || url().scheme().contains(QStringLiteral("search"))) {
 117         // Skip results shown by a search, as possible identical
 118         // directory names are useless without parent-path information.
 119         return false;
 120     }
 121
 122     if (m_controller) {
 123         loadTree(url());
 124     }
 125
 126     return true;
 127 }
 128
 129 void FoldersPanel::reloadTree()
 130 {
 131     if (m_controller) {
 132         loadTree(url(), AllowJumpHome);
 133     }
 134 }
 135
 136
 137 void FoldersPanel::showEvent(QShowEvent* event)
 138 {
 139     if (event->spontaneous()) {
 140         Panel::showEvent(event);
 141         return;
 142     }
 143
 144     if (!m_controller) {
 145         // Postpone the creating of the controller to the first show event.
 146         // This assures that no performance and memory overhead is given when the folders panel is not
 147         // used at all and stays invisible.
 148         KFileItemListView* view  = new KFileItemListView();
 149         view->setWidgetCreator(new KItemListWidgetCreator<FoldersItemListWidget>());
 150         view->setSupportsItemExpanding(true);
 151         // Set the opacity to 0 initially. The opacity will be increased after the loading of the initial tree
 152         // has been finished in slotLoadingCompleted(). This prevents an unnecessary animation-mess when
 153         // opening the folders panel.
 154         view->setOpacity(0);
 155
 156         connect(view, &KFileItemListView::roleEditingFinished,
 157                 this, &FoldersPanel::slotRoleEditingFinished);
 158
 159         m_model = new KFileItemModel(this);
 160         m_model->setShowDirectoriesOnly(true);
 161         m_model->setShowHiddenFiles(FoldersPanelSettings::hiddenFilesShown());
 162         // Use a QueuedConnection to give the view the possibility to react first on the
 163         // finished loading.
 164         connect(m_model, &KFileItemModel::directoryLoadingCompleted, this, &FoldersPanel::slotLoadingCompleted, Qt::QueuedConnection);
 165
 166         m_controller = new KItemListController(m_model, view, this);
 167         m_controller->setSelectionBehavior(KItemListController::SingleSelection);
 168         m_controller->setAutoActivationBehavior(KItemListController::ExpansionOnly);
 169         m_controller->setMouseDoubleClickAction(KItemListController::ActivateAndExpandItem);
 170         m_controller->setAutoActivationDelay(750);
 171         m_controller->setSingleClickActivationEnforced(true);
 172
 173         connect(m_controller, &KItemListController::itemActivated, this, &FoldersPanel::slotItemActivated);
 174         connect(m_controller, &KItemListController::itemMiddleClicked, this, &FoldersPanel::slotItemMiddleClicked);
 175         connect(m_controller, &KItemListController::itemContextMenuRequested, this, &FoldersPanel::slotItemContextMenuRequested);
 176         connect(m_controller, &KItemListController::viewContextMenuRequested, this, &FoldersPanel::slotViewContextMenuRequested);
 177         connect(m_controller, &KItemListController::itemDropEvent, this, &FoldersPanel::slotItemDropEvent);
 178
 179         KItemListContainer* container = new KItemListContainer(m_controller, this);
 180         container->setEnabledFrame(false);
 181
 182         QVBoxLayout* layout = new QVBoxLayout(this);
 183         layout->setMargin(0);
 184         layout->addWidget(container);
 185     }
 186
 187     loadTree(url());
 188     Panel::showEvent(event);
 189 }
 190
 191 void FoldersPanel::keyPressEvent(QKeyEvent* event)
 192 {
 193     const int key = event->key();
 194     if ((key == Qt::Key_Enter) || (key == Qt::Key_Return)) {
 195         event->accept();
 196     } else {
 197         Panel::keyPressEvent(event);
 198     }
 199 }
 200
 201 void FoldersPanel::slotItemActivated(int index)
 202 {
 203     const KFileItem item = m_model->fileItem(index);
 204     if (!item.isNull()) {
 205         emit folderActivated(item.url());
 206     }
 207 }
 208
 209 void FoldersPanel::slotItemMiddleClicked(int index)
 210 {
 211     const KFileItem item = m_model->fileItem(index);
 212     if (!item.isNull()) {
 213         emit folderMiddleClicked(item.url());
 214     }
 215 }
 216
 217 void FoldersPanel::slotItemContextMenuRequested(int index, const QPointF& pos)
 218 {
 219     Q_UNUSED(pos);
 220
 221     const KFileItem fileItem = m_model->fileItem(index);
 222
 223     QPointer<TreeViewContextMenu> contextMenu = new TreeViewContextMenu(this, fileItem);
 224     contextMenu.data()->open();
 225     if (contextMenu.data()) {
 226         delete contextMenu.data();
 227     }
 228 }
 229
 230 void FoldersPanel::slotViewContextMenuRequested(const QPointF& pos)
 231 {
 232     Q_UNUSED(pos);
 233
 234     QPointer<TreeViewContextMenu> contextMenu = new TreeViewContextMenu(this, KFileItem());
 235     contextMenu.data()->open();
 236     if (contextMenu.data()) {
 237         delete contextMenu.data();
 238     }
 239 }
 240
 241 void FoldersPanel::slotItemDropEvent(int index, QGraphicsSceneDragDropEvent* event)
 242 {
 243     if (index >= 0) {
 244         KFileItem destItem = m_model->fileItem(index);
 245         if (destItem.isNull()) {
 246             return;
 247         }
 248
 249         QDropEvent dropEvent(event->pos().toPoint(),
 250                              event->possibleActions(),
 251                              event->mimeData(),
 252                              event->buttons(),
 253                              event->modifiers());
 254
 255         KIO::DropJob *job = DragAndDropHelper::dropUrls(destItem.mostLocalUrl(), &dropEvent, this);
 256         if (job) {
 257             connect(job, &KIO::DropJob::result, this, [this](KJob *job) { if (job->error()) emit errorMessage(job->errorString()); });
 258         }
 259     }
 260 }
 261
 262 void FoldersPanel::slotRoleEditingFinished(int index, const QByteArray& role, const QVariant& value)
 263 {
 264     if (role == "text") {
 265         const KFileItem item = m_model->fileItem(index);
 266         const QString newName = value.toString();
 267         if (!newName.isEmpty() && newName != item.text() && newName != QLatin1String(".") && newName != QLatin1String("..")) {
 268             const QUrl oldUrl = item.url();
 269             QUrl newUrl = oldUrl.adjusted(QUrl::RemoveFilename);
 270             newUrl.setPath(newUrl.path() + KIO::encodeFileName(newName));
 271
 272             KIO::Job* job = KIO::moveAs(oldUrl, newUrl);
 273             KJobWidgets::setWindow(job, this);
 274             KIO::FileUndoManager::self()->recordJob(KIO::FileUndoManager::Rename, {oldUrl}, newUrl, job);
 275             job->uiDelegate()->setAutoErrorHandlingEnabled(true);
 276         }
 277     }
 278 }
 279
 280 void FoldersPanel::slotLoadingCompleted()
 281 {
 282     if (m_controller->view()->opacity() == 0) {
 283         // The loading of the initial tree after opening the Folders panel
 284         // has been finished. Trigger the increasing of the opacity after
 285         // a short delay to give the view the chance to finish its internal
 286         // animations.
 287         // TODO: Check whether it makes sense to allow accessing the
 288         // view-internal delay for usecases like this.
 289         QTimer::singleShot(250, this, &FoldersPanel::startFadeInAnimation);
 290     }
 291
 292     if (!m_updateCurrentItem) {
 293         return;
 294     }
 295
 296     const int index = m_model->index(url());
 297     updateCurrentItem(index);
 298     m_updateCurrentItem = false;
 299 }
 300
 301 void FoldersPanel::startFadeInAnimation()
 302 {
 303     QPropertyAnimation* anim = new QPropertyAnimation(m_controller->view(), "opacity", this);
 304     anim->setStartValue(0);
 305     anim->setEndValue(1);
 306     anim->setEasingCurve(QEasingCurve::InOutQuad);
 307     anim->start(QAbstractAnimation::DeleteWhenStopped);
 308     anim->setDuration(200);
 309 }
 310
 311 void FoldersPanel::loadTree(const QUrl& url, FoldersPanel::NavigationBehaviour navigationBehaviour)
 312 {
 313     Q_ASSERT(m_controller);
 314
 315     m_updateCurrentItem = false;
 316     bool jumpHome = false;
 317
 318     QUrl baseUrl;
 319     if (!url.isLocalFile()) {
 320         // Clear the path for non-local URLs and use it as base
 321         baseUrl = url;
 322         baseUrl.setPath(QStringLiteral("/"));
 323     } else if (Dolphin::homeUrl().isParentOf(url) || (Dolphin::homeUrl() == url)) {
 324         if (FoldersPanelSettings::limitFoldersPanelToHome() ) {
 325             baseUrl = Dolphin::homeUrl();
 326         } else {
 327             // Use the root directory as base for local URLs (#150941)
 328             baseUrl = QUrl::fromLocalFile(QDir::rootPath());
 329         }
 330     } else if (FoldersPanelSettings::limitFoldersPanelToHome() && navigationBehaviour == AllowJumpHome) {
 331         baseUrl = Dolphin::homeUrl();
 332         jumpHome = true;
 333     } else {
 334         // Use the root directory as base for local URLs (#150941)
 335         baseUrl = QUrl::fromLocalFile(QDir::rootPath());
 336     }
 337
 338     if (m_model->directory() != baseUrl && !jumpHome) {
 339         m_updateCurrentItem = true;
 340         m_model->refreshDirectory(baseUrl);
 341     }
 342
 343     const int index = m_model->index(url);
 344     if (jumpHome) {
 345       emit folderActivated(baseUrl);
 346     } else if (index >= 0) {
 347         updateCurrentItem(index);
 348     } else if (url == baseUrl) {
 349         // clear the selection when visiting the base url
 350         updateCurrentItem(-1);
 351     } else {
 352         m_updateCurrentItem = true;
 353         m_model->expandParentDirectories(url);
 354
 355         // slotLoadingCompleted() will be invoked after the model has
 356         // expanded the url
 357     }
 358 }
 359
 360 void FoldersPanel::updateCurrentItem(int index)
 361 {
 362     KItemListSelectionManager* selectionManager = m_controller->selectionManager();
 363     selectionManager->setCurrentItem(index);
 364     selectionManager->clearSelection();
 365     selectionManager->setSelected(index);
 366
 367     m_controller->view()->scrollToItem(index);
 368 }
 369