src/panels/folders/folderspanel.cpp

   1 /*
   2  * SPDX-FileCopyrightText: 2006-2010 Peter Penz <peter.penz19@gmail.com>
   3  *
   4  * SPDX-License-Identifier: GPL-2.0-or-later
   5  */
   6
   7 #include "folderspanel.h"
   8
   9 #include "dolphin_folderspanelsettings.h"
  10 #include "dolphin_generalsettings.h"
  11 #include "foldersitemlistwidget.h"
  12 #include "global.h"
  13 #include "kitemviews/kfileitemlistview.h"
  14 #include "kitemviews/kfileitemmodel.h"
  15 #include "kitemviews/kitemlistcontainer.h"
  16 #include "kitemviews/kitemlistcontroller.h"
  17 #include "kitemviews/kitemlistselectionmanager.h"
  18 #include "kitemviews/private/kitemlistroleeditor.h"
  19 #include "treeviewcontextmenu.h"
  20 #include "views/draganddrophelper.h"
  21
  22 #include <KIO/CopyJob>
  23 #include <KIO/DropJob>
  24 #include <KIO/FileUndoManager>
  25 #include <KIO/RenameFileDialog>
  26 #include <KJobUiDelegate>
  27 #include <KJobWidgets>
  28
  29 #include <QApplication>
  30 #include <QBoxLayout>
  31 #include <QGraphicsSceneDragDropEvent>
  32 #include <QGraphicsView>
  33 #include <QPropertyAnimation>
  34 #include <QTimer>
  35
  36 FoldersPanel::FoldersPanel(QWidget *parent)
  37     : Panel(parent)
  38     , m_updateCurrentItem(false)
  39     , m_controller(nullptr)
  40     , m_model(nullptr)
  41 {
  42     setLayoutDirection(Qt::LeftToRight);
  43 }
  44
  45 FoldersPanel::~FoldersPanel()
  46 {
  47     FoldersPanelSettings::self()->save();
  48
  49     if (m_controller) {
  50         KItemListView *view = m_controller->view();
  51         m_controller->setView(nullptr);
  52         delete view;
  53     }
  54 }
  55
  56 void FoldersPanel::setShowHiddenFiles(bool show)
  57 {
  58     FoldersPanelSettings::setHiddenFilesShown(show);
  59     m_model->setShowHiddenFiles(show);
  60 }
  61
  62 bool FoldersPanel::showHiddenFiles() const
  63 {
  64     return FoldersPanelSettings::hiddenFilesShown();
  65 }
  66
  67 void FoldersPanel::setLimitFoldersPanelToHome(bool enable)
  68 {
  69     FoldersPanelSettings::setLimitFoldersPanelToHome(enable);
  70     reloadTree();
  71 }
  72
  73 bool FoldersPanel::limitFoldersPanelToHome() const
  74 {
  75     return FoldersPanelSettings::limitFoldersPanelToHome();
  76 }
  77
  78 void FoldersPanel::setAutoScrolling(bool enable)
  79 {
  80     // TODO: Not supported yet in Dolphin 2.0
  81     FoldersPanelSettings::setAutoScrolling(enable);
  82 }
  83
  84 bool FoldersPanel::autoScrolling() const
  85 {
  86     return FoldersPanelSettings::autoScrolling();
  87 }
  88
  89 void FoldersPanel::rename(const KFileItem &item)
  90 {
  91     if (GeneralSettings::renameInline()) {
  92         const int index = m_model->index(item);
  93         m_controller->view()->editRole(index, "text");
  94     } else {
  95         KIO::RenameFileDialog *dialog = new KIO::RenameFileDialog(KFileItemList({item}), this);
  96         dialog->open();
  97     }
  98 }
  99
 100 bool FoldersPanel::urlChanged()
 101 {
 102     if (!url().isValid() || url().scheme().contains(QLatin1String("search"))) {
 103         // Skip results shown by a search, as possible identical
 104         // directory names are useless without parent-path information.
 105         return false;
 106     }
 107
 108     if (m_controller) {
 109         loadTree(url());
 110     }
 111
 112     return true;
 113 }
 114
 115 void FoldersPanel::reloadTree()
 116 {
 117     if (m_controller) {
 118         loadTree(url(), AllowJumpHome);
 119     }
 120 }
 121
 122 void FoldersPanel::showEvent(QShowEvent *event)
 123 {
 124     if (event->spontaneous()) {
 125         Panel::showEvent(event);
 126         return;
 127     }
 128
 129     if (!m_controller) {
 130         // Postpone the creating of the controller to the first show event.
 131         // This assures that no performance and memory overhead is given when the folders panel is not
 132         // used at all and stays invisible.
 133         KFileItemListView *view = new KFileItemListView();
 134         view->setScanDirectories(false);
 135         view->setWidgetCreator(new KItemListWidgetCreator<FoldersItemListWidget>());
 136         view->setSupportsItemExpanding(true);
 137         // Set the opacity to 0 initially. The opacity will be increased after the loading of the initial tree
 138         // has been finished in slotLoadingCompleted(). This prevents an unnecessary animation-mess when
 139         // opening the folders panel.
 140         view->setOpacity(0);
 141
 142         connect(view, &KFileItemListView::roleEditingFinished, this, &FoldersPanel::slotRoleEditingFinished);
 143
 144         m_model = new KFileItemModel(this);
 145         m_model->setShowDirectoriesOnly(true);
 146         m_model->setShowHiddenFiles(FoldersPanelSettings::hiddenFilesShown());
 147         // Use a QueuedConnection to give the view the possibility to react first on the
 148         // finished loading.
 149         connect(m_model, &KFileItemModel::directoryLoadingCompleted, this, &FoldersPanel::slotLoadingCompleted, Qt::QueuedConnection);
 150
 151         m_controller = new KItemListController(m_model, view, this);
 152         m_controller->setSelectionBehavior(KItemListController::SingleSelection);
 153         m_controller->setAutoActivationBehavior(KItemListController::ExpansionOnly);
 154         m_controller->setMouseDoubleClickAction(KItemListController::ActivateAndExpandItem);
 155         m_controller->setAutoActivationDelay(750);
 156         m_controller->setSingleClickActivationEnforced(true);
 157
 158         connect(m_controller, &KItemListController::itemActivated, this, &FoldersPanel::slotItemActivated);
 159         connect(m_controller, &KItemListController::itemMiddleClicked, this, &FoldersPanel::slotItemMiddleClicked);
 160         connect(m_controller, &KItemListController::itemContextMenuRequested, this, &FoldersPanel::slotItemContextMenuRequested);
 161         connect(m_controller, &KItemListController::viewContextMenuRequested, this, &FoldersPanel::slotViewContextMenuRequested);
 162         connect(m_controller, &KItemListController::itemDropEvent, this, &FoldersPanel::slotItemDropEvent);
 163
 164         KItemListContainer *container = new KItemListContainer(m_controller, this);
 165         container->setEnabledFrame(false);
 166
 167         QVBoxLayout *layout = new QVBoxLayout(this);
 168         layout->setContentsMargins(0, 0, 0, 0);
 169         layout->addWidget(container);
 170     }
 171
 172     loadTree(url());
 173     Panel::showEvent(event);
 174 }
 175
 176 void FoldersPanel::keyPressEvent(QKeyEvent *event)
 177 {
 178     const int key = event->key();
 179     if ((key == Qt::Key_Enter) || (key == Qt::Key_Return)) {
 180         event->accept();
 181     } else {
 182         Panel::keyPressEvent(event);
 183     }
 184 }
 185
 186 void FoldersPanel::slotItemActivated(int index)
 187 {
 188     const KFileItem item = m_model->fileItem(index);
 189     if (!item.isNull()) {
 190         const auto modifiers = QGuiApplication::keyboardModifiers();
 191         // keep in sync with KUrlNavigator::slotNavigatorButtonClicked
 192         if (modifiers & Qt::ControlModifier && modifiers & Qt::ShiftModifier) {
 193             Q_EMIT folderInNewActiveTab(item.url());
 194         } else if (modifiers & Qt::ControlModifier) {
 195             Q_EMIT folderInNewTab(item.url());
 196         } else if (modifiers & Qt::ShiftModifier) {
 197             // The shift modifier is not considered because it is used to expand the tree view without actually
 198             // opening the folder
 199             return;
 200         } else {
 201             Q_EMIT folderActivated(item.url());
 202         }
 203     }
 204 }
 205
 206 void FoldersPanel::slotItemMiddleClicked(int index)
 207 {
 208     const KFileItem item = m_model->fileItem(index);
 209     if (!item.isNull()) {
 210         const auto modifiers = QGuiApplication::keyboardModifiers();
 211         // keep in sync with KUrlNavigator::slotNavigatorButtonClicked
 212         if (modifiers & Qt::ShiftModifier) {
 213             Q_EMIT folderInNewActiveTab(item.url());
 214         } else {
 215             Q_EMIT folderInNewTab(item.url());
 216         }
 217     }
 218 }
 219
 220 void FoldersPanel::slotItemContextMenuRequested(int index, const QPointF &pos)
 221 {
 222     const KFileItem fileItem = m_model->fileItem(index);
 223
 224     QPointer<TreeViewContextMenu> contextMenu = new TreeViewContextMenu(this, fileItem);
 225     contextMenu.data()->open(pos.toPoint());
 226     if (contextMenu.data()) {
 227         delete contextMenu.data();
 228     }
 229 }
 230
 231 void FoldersPanel::slotViewContextMenuRequested(const QPointF &pos)
 232 {
 233     QPointer<TreeViewContextMenu> contextMenu = new TreeViewContextMenu(this, KFileItem());
 234     contextMenu.data()->open(pos.toPoint());
 235     if (contextMenu.data()) {
 236         delete contextMenu.data();
 237     }
 238 }
 239
 240 void FoldersPanel::slotItemDropEvent(int index, QGraphicsSceneDragDropEvent *event)
 241 {
 242     if (index >= 0) {
 243         KFileItem destItem = m_model->fileItem(index);
 244         if (destItem.isNull()) {
 245             return;
 246         }
 247
 248         QDropEvent dropEvent(event->pos().toPoint(), event->possibleActions(), event->mimeData(), event->buttons(), event->modifiers());
 249
 250         KIO::DropJob *job = DragAndDropHelper::dropUrls(destItem.mostLocalUrl(), &dropEvent, this);
 251         if (job) {
 252             connect(job, &KIO::DropJob::result, this, [this](KJob *job) {
 253                 if (job->error() && job->error() != KIO::ERR_USER_CANCELED) {
 254                     Q_EMIT errorMessage(job->errorString());
 255                 }
 256             });
 257         }
 258     }
 259 }
 260
 261 void FoldersPanel::slotRoleEditingFinished(int index, const QByteArray &role, const QVariant &value)
 262 {
 263     if (role == "text") {
 264         const KFileItem item = m_model->fileItem(index);
 265         const EditResult retVal = value.value<EditResult>();
 266         const QString newName = retVal.newName;
 267         if (!newName.isEmpty() && newName != item.text() && newName != QLatin1Char('.') && 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         Q_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 }