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 <KJobWidgets>
  23 #include <KJobUiDelegate>
  24 #include <KIO/CopyJob>
  25 #include <KIO/DropJob>
  26 #include <KIO/FileUndoManager>
  27 #include <KIO/RenameFileDialog>
  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
 123 void FoldersPanel::showEvent(QShowEvent* event)
 124 {
 125     if (event->spontaneous()) {
 126         Panel::showEvent(event);
 127         return;
 128     }
 129
 130     if (!m_controller) {
 131         // Postpone the creating of the controller to the first show event.
 132         // This assures that no performance and memory overhead is given when the folders panel is not
 133         // used at all and stays invisible.
 134         KFileItemListView* view  = new KFileItemListView();
 135         view->setScanDirectories(false);
 136         view->setWidgetCreator(new KItemListWidgetCreator<FoldersItemListWidget>());
 137         view->setSupportsItemExpanding(true);
 138         // Set the opacity to 0 initially. The opacity will be increased after the loading of the initial tree
 139         // has been finished in slotLoadingCompleted(). This prevents an unnecessary animation-mess when
 140         // opening the folders panel.
 141         view->setOpacity(0);
 142
 143         connect(view, &KFileItemListView::roleEditingFinished,
 144                 this, &FoldersPanel::slotRoleEditingFinished);
 145
 146         m_model = new KFileItemModel(this);
 147         m_model->setShowDirectoriesOnly(true);
 148         m_model->setShowHiddenFiles(FoldersPanelSettings::hiddenFilesShown());
 149         // Use a QueuedConnection to give the view the possibility to react first on the
 150         // finished loading.
 151         connect(m_model, &KFileItemModel::directoryLoadingCompleted, this, &FoldersPanel::slotLoadingCompleted, Qt::QueuedConnection);
 152
 153         m_controller = new KItemListController(m_model, view, this);
 154         m_controller->setSelectionBehavior(KItemListController::SingleSelection);
 155         m_controller->setAutoActivationBehavior(KItemListController::ExpansionOnly);
 156         m_controller->setMouseDoubleClickAction(KItemListController::ActivateAndExpandItem);
 157         m_controller->setAutoActivationDelay(750);
 158         m_controller->setSingleClickActivationEnforced(true);
 159
 160         connect(m_controller, &KItemListController::itemActivated, this, &FoldersPanel::slotItemActivated);
 161         connect(m_controller, &KItemListController::itemMiddleClicked, this, &FoldersPanel::slotItemMiddleClicked);
 162         connect(m_controller, &KItemListController::itemContextMenuRequested, this, &FoldersPanel::slotItemContextMenuRequested);
 163         connect(m_controller, &KItemListController::viewContextMenuRequested, this, &FoldersPanel::slotViewContextMenuRequested);
 164         connect(m_controller, &KItemListController::itemDropEvent, this, &FoldersPanel::slotItemDropEvent);
 165
 166         KItemListContainer* container = new KItemListContainer(m_controller, this);
 167         container->setEnabledFrame(false);
 168
 169         QVBoxLayout* layout = new QVBoxLayout(this);
 170         layout->setContentsMargins(0, 0, 0, 0);
 171         layout->addWidget(container);
 172     }
 173
 174     loadTree(url());
 175     Panel::showEvent(event);
 176 }
 177
 178 void FoldersPanel::keyPressEvent(QKeyEvent* event)
 179 {
 180     const int key = event->key();
 181     if ((key == Qt::Key_Enter) || (key == Qt::Key_Return)) {
 182         event->accept();
 183     } else {
 184         Panel::keyPressEvent(event);
 185     }
 186 }
 187
 188 void FoldersPanel::slotItemActivated(int index)
 189 {
 190     const KFileItem item = m_model->fileItem(index);
 191     if (!item.isNull()) {
 192         Q_EMIT folderActivated(item.url());
 193     }
 194 }
 195
 196 void FoldersPanel::slotItemMiddleClicked(int index)
 197 {
 198     const KFileItem item = m_model->fileItem(index);
 199     if (!item.isNull()) {
 200         Q_EMIT folderMiddleClicked(item.url());
 201     }
 202 }
 203
 204 void FoldersPanel::slotItemContextMenuRequested(int index, const QPointF& pos)
 205 {
 206     const KFileItem fileItem = m_model->fileItem(index);
 207
 208     QPointer<TreeViewContextMenu> contextMenu = new TreeViewContextMenu(this, fileItem);
 209     contextMenu.data()->open(pos.toPoint());
 210     if (contextMenu.data()) {
 211         delete contextMenu.data();
 212     }
 213 }
 214
 215 void FoldersPanel::slotViewContextMenuRequested(const QPointF& pos)
 216 {
 217     QPointer<TreeViewContextMenu> contextMenu = new TreeViewContextMenu(this, KFileItem());
 218     contextMenu.data()->open(pos.toPoint());
 219     if (contextMenu.data()) {
 220         delete contextMenu.data();
 221     }
 222 }
 223
 224 void FoldersPanel::slotItemDropEvent(int index, QGraphicsSceneDragDropEvent* event)
 225 {
 226     if (index >= 0) {
 227         KFileItem destItem = m_model->fileItem(index);
 228         if (destItem.isNull()) {
 229             return;
 230         }
 231
 232         QDropEvent dropEvent(event->pos().toPoint(),
 233                              event->possibleActions(),
 234                              event->mimeData(),
 235                              event->buttons(),
 236                              event->modifiers());
 237
 238         KIO::DropJob *job = DragAndDropHelper::dropUrls(destItem.mostLocalUrl(), &dropEvent, this);
 239         if (job) {
 240             connect(job, &KIO::DropJob::result, this, [this](KJob *job) { if (job->error()) Q_EMIT errorMessage(job->errorString()); });
 241         }
 242     }
 243 }
 244
 245 void FoldersPanel::slotRoleEditingFinished(int index, const QByteArray& role, const QVariant& value)
 246 {
 247     if (role == "text") {
 248         const KFileItem item = m_model->fileItem(index);
 249         const EditResult retVal = value.value<EditResult>();
 250         const QString newName = retVal.newName;
 251         if (!newName.isEmpty() && newName != item.text() && newName != QLatin1Char('.') && newName != QLatin1String("..")) {
 252             const QUrl oldUrl = item.url();
 253             QUrl newUrl = oldUrl.adjusted(QUrl::RemoveFilename);
 254             newUrl.setPath(newUrl.path() + KIO::encodeFileName(newName));
 255
 256             KIO::Job* job = KIO::moveAs(oldUrl, newUrl);
 257             KJobWidgets::setWindow(job, this);
 258             KIO::FileUndoManager::self()->recordJob(KIO::FileUndoManager::Rename, {oldUrl}, newUrl, job);
 259             job->uiDelegate()->setAutoErrorHandlingEnabled(true);
 260         }
 261     }
 262 }
 263
 264 void FoldersPanel::slotLoadingCompleted()
 265 {
 266     if (m_controller->view()->opacity() == 0) {
 267         // The loading of the initial tree after opening the Folders panel
 268         // has been finished. Trigger the increasing of the opacity after
 269         // a short delay to give the view the chance to finish its internal
 270         // animations.
 271         // TODO: Check whether it makes sense to allow accessing the
 272         // view-internal delay for usecases like this.
 273         QTimer::singleShot(250, this, &FoldersPanel::startFadeInAnimation);
 274     }
 275
 276     if (!m_updateCurrentItem) {
 277         return;
 278     }
 279
 280     const int index = m_model->index(url());
 281     updateCurrentItem(index);
 282     m_updateCurrentItem = false;
 283 }
 284
 285 void FoldersPanel::startFadeInAnimation()
 286 {
 287     QPropertyAnimation* anim = new QPropertyAnimation(m_controller->view(), "opacity", this);
 288     anim->setStartValue(0);
 289     anim->setEndValue(1);
 290     anim->setEasingCurve(QEasingCurve::InOutQuad);
 291     anim->start(QAbstractAnimation::DeleteWhenStopped);
 292     anim->setDuration(200);
 293 }
 294
 295 void FoldersPanel::loadTree(const QUrl& url, FoldersPanel::NavigationBehaviour navigationBehaviour)
 296 {
 297     Q_ASSERT(m_controller);
 298
 299     m_updateCurrentItem = false;
 300     bool jumpHome = false;
 301
 302     QUrl baseUrl;
 303     if (!url.isLocalFile()) {
 304         // Clear the path for non-local URLs and use it as base
 305         baseUrl = url;
 306         baseUrl.setPath(QStringLiteral("/"));
 307     } else if (Dolphin::homeUrl().isParentOf(url) || (Dolphin::homeUrl() == url)) {
 308         if (FoldersPanelSettings::limitFoldersPanelToHome() ) {
 309             baseUrl = Dolphin::homeUrl();
 310         } else {
 311             // Use the root directory as base for local URLs (#150941)
 312             baseUrl = QUrl::fromLocalFile(QDir::rootPath());
 313         }
 314     } else if (FoldersPanelSettings::limitFoldersPanelToHome() && navigationBehaviour == AllowJumpHome) {
 315         baseUrl = Dolphin::homeUrl();
 316         jumpHome = true;
 317     } else {
 318         // Use the root directory as base for local URLs (#150941)
 319         baseUrl = QUrl::fromLocalFile(QDir::rootPath());
 320     }
 321
 322     if (m_model->directory() != baseUrl && !jumpHome) {
 323         m_updateCurrentItem = true;
 324         m_model->refreshDirectory(baseUrl);
 325     }
 326
 327     const int index = m_model->index(url);
 328     if (jumpHome) {
 329       Q_EMIT folderActivated(baseUrl);
 330     } else if (index >= 0) {
 331         updateCurrentItem(index);
 332     } else if (url == baseUrl) {
 333         // clear the selection when visiting the base url
 334         updateCurrentItem(-1);
 335     } else {
 336         m_updateCurrentItem = true;
 337         m_model->expandParentDirectories(url);
 338
 339         // slotLoadingCompleted() will be invoked after the model has
 340         // expanded the url
 341     }
 342 }
 343
 344 void FoldersPanel::updateCurrentItem(int index)
 345 {
 346     KItemListSelectionManager* selectionManager = m_controller->selectionManager();
 347     selectionManager->setCurrentItem(index);
 348     selectionManager->clearSelection();
 349     selectionManager->setSelected(index);
 350
 351     m_controller->view()->scrollToItem(index);
 352 }
 353