X-Git-Url: https://cloud.milkyroute.net/gitweb/dolphin.git/blobdiff_plain/007907be20cc63e4c12320b0406cc255286e7792..dd07a327:/src/panels/places/placespanel.cpp

diff --git a/src/panels/places/placespanel.cpp b/src/panels/places/placespanel.cpp
index 5ea4b971c..cb3f3183b 100644
--- a/src/panels/places/placespanel.cpp
+++ b/src/panels/places/placespanel.cpp
@@ -1,147 +1,292 @@
-/***************************************************************************
- *   Copyright (C) 2008-2012 by Peter Penz <peter.penz19@gmail.com>        *
- *                                                                         *
- *   Based on KFilePlacesModel from kdelibs:                               *
- *   Copyright (C) 2007 Kevin Ottens <ervin@kde.org>                       *
- *   Copyright (C) 2007 David Faure <faure@kde.org>                        *
- *                                                                         *
- *   This program is free software; you can redistribute it and/or modify  *
- *   it under the terms of the GNU General Public License as published by  *
- *   the Free Software Foundation; either version 2 of the License, or     *
- *   (at your option) any later version.                                   *
- *                                                                         *
- *   This program is distributed in the hope that it will be useful,       *
- *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
- *   GNU General Public License for more details.                          *
- *                                                                         *
- *   You should have received a copy of the GNU General Public License     *
- *   along with this program; if not, write to the                         *
- *   Free Software Foundation, Inc.,                                       *
- *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
- ***************************************************************************/
+/*
+ * SPDX-FileCopyrightText: 2008-2012 Peter Penz <peter.penz19@gmail.com>
+ * SPDX-FileCopyrightText: 2021 Kai Uwe Broulik <kde@broulik.de>
+ *
+ * Based on KFilePlacesView from kdelibs:
+ * SPDX-FileCopyrightText: 2007 Kevin Ottens <ervin@kde.org>
+ * SPDX-FileCopyrightText: 2007 David Faure <faure@kde.org>
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
 
 #include "placespanel.h"
 
-#include <KBookmark>
-#include <KBookmarkGroup>
-#include <KBookmarkManager>
-#include <KComponentData>
-#include <KDebug>
-#include <KIcon>
-#include <kitemviews/kitemlistcontainer.h>
-#include <kitemviews/kitemlistcontroller.h>
-#include <kitemviews/kstandarditem.h>
-#include <kitemviews/kstandarditemlistview.h>
-#include <kitemviews/kstandarditemmodel.h>
-#include <KStandardDirs>
-#include <views/draganddrophelper.h>
-#include <QVBoxLayout>
+#include "dolphin_generalsettings.h"
+#include "dolphin_placespanelsettings.h"
+#include "dolphinplacesmodelsingleton.h"
+#include "settings/dolphinsettingsdialog.h"
+#include "views/draganddrophelper.h"
+
+#include <KFilePlacesModel>
+#include <KIO/DropJob>
+#include <KIO/Job>
+#include <KLocalizedString>
+#include <KProtocolManager>
+
+#include <QIcon>
+#include <QMenu>
+#include <QMimeData>
 #include <QShowEvent>
 
-PlacesPanel::PlacesPanel(QWidget* parent) :
-    Panel(parent),
-    m_controller(0),
-    m_model(0),
-    m_availableDevices(),
-    m_bookmarkManager(0)
+#include <Solid/StorageAccess>
+
+PlacesPanel::PlacesPanel(QWidget *parent)
+    : KFilePlacesView(parent)
+{
+    setDropOnPlaceEnabled(true);
+    connect(this, &PlacesPanel::urlsDropped, this, &PlacesPanel::slotUrlsDropped);
+
+    setAutoResizeItemsEnabled(false);
+
+    setTeardownFunction([this](const QModelIndex &index) {
+        slotTearDownRequested(index);
+    });
+
+    m_openInSplitView = new QAction(QIcon::fromTheme(QStringLiteral("view-split-left-right")), i18nc("@action:inmenu", "Open in Split View"));
+    m_openInSplitView->setPriority(QAction::HighPriority);
+    connect(m_openInSplitView, &QAction::triggered, this, [this]() {
+        const QUrl url = currentIndex().data(KFilePlacesModel::UrlRole).toUrl();
+        Q_EMIT openInSplitViewRequested(url);
+    });
+    addAction(m_openInSplitView);
+
+    m_configureTrashAction = new QAction(QIcon::fromTheme(QStringLiteral("configure")), i18nc("@action:inmenu", "Configure Trash…"));
+    m_configureTrashAction->setPriority(QAction::HighPriority);
+    connect(m_configureTrashAction, &QAction::triggered, this, &PlacesPanel::slotConfigureTrash);
+    addAction(m_configureTrashAction);
+
+    connect(this, &PlacesPanel::contextMenuAboutToShow, this, &PlacesPanel::slotContextMenuAboutToShow);
+
+    connect(this, &PlacesPanel::iconSizeChanged, this, [](const QSize &newSize) {
+        int iconSize = qMin(newSize.width(), newSize.height());
+        if (iconSize == 0) {
+            // Don't store 0 size, let's keep -1 for default/small/automatic
+            iconSize = -1;
+        }
+        PlacesPanelSettings *settings = PlacesPanelSettings::self();
+        settings->setIconSize(iconSize);
+        settings->save();
+    });
+}
+
+PlacesPanel::~PlacesPanel() = default;
+
+void PlacesPanel::setUrl(const QUrl &url)
 {
+    // KFilePlacesView::setUrl no-ops when no model is set but we only set it in showEvent()
+    // Remember the URL and set it in showEvent
+    m_url = url;
+    KFilePlacesView::setUrl(url);
 }
 
-PlacesPanel::~PlacesPanel()
+QList<QAction *> PlacesPanel::customContextMenuActions() const
 {
+    return m_customContextMenuActions;
 }
 
-bool PlacesPanel::urlChanged()
+void PlacesPanel::setCustomContextMenuActions(const QList<QAction *> &actions)
 {
-    return true;
+    m_customContextMenuActions = actions;
 }
 
-void PlacesPanel::showEvent(QShowEvent* event)
+void PlacesPanel::proceedWithTearDown()
 {
-    if (event->spontaneous()) {
-        Panel::showEvent(event);
-        return;
+    if (m_indexToTearDown.isValid()) {
+        auto *placesModel = static_cast<KFilePlacesModel *>(model());
+        placesModel->requestTeardown(m_indexToTearDown);
+    } else {
+        qWarning() << "Places entry to tear down is no longer valid";
+    }
+}
+
+void PlacesPanel::readSettings()
+{
+    if (GeneralSettings::autoExpandFolders()) {
+        setDragAutoActivationDelay(750);
+    } else {
+        setDragAutoActivationDelay(0);
     }
 
-    if (!m_controller) {
-        // Postpone the creating of the controller to the first show event.
-        // This assures that no performance and memory overhead is given when the folders panel is not
-        // used at all and stays invisible.
-        const QString file = KStandardDirs::locateLocal("data", "kfileplaces/bookmarks.xml");
-        m_bookmarkManager = KBookmarkManager::managerForFile(file, "kfileplaces");
-        m_model = new KStandardItemModel(this);
-        loadBookmarks();
+    const int iconSize = qMax(0, PlacesPanelSettings::iconSize());
+    setIconSize(QSize(iconSize, iconSize));
+}
 
-        KStandardItemListView* view = new KStandardItemListView();
+void PlacesPanel::showEvent(QShowEvent *event)
+{
+    if (!event->spontaneous() && !model()) {
+        readSettings();
 
-        m_controller = new KItemListController(m_model, view, this);
-        m_controller->setSelectionBehavior(KItemListController::SingleSelection);
-        connect(m_controller, SIGNAL(itemActivated(int)), this, SLOT(slotItemActivated(int)));
-        connect(m_controller, SIGNAL(itemMiddleClicked(int)), this, SLOT(slotItemMiddleClicked(int)));
+        auto *placesModel = DolphinPlacesModelSingleton::instance().placesModel();
+        setModel(placesModel);
 
-        KItemListContainer* container = new KItemListContainer(m_controller, this);
-        container->setEnabledFrame(false);
+        connect(placesModel, &KFilePlacesModel::errorMessage, this, &PlacesPanel::errorMessage);
+        connect(placesModel, &KFilePlacesModel::teardownDone, this, &PlacesPanel::slotTearDownDone);
 
-        QVBoxLayout* layout = new QVBoxLayout(this);
-        layout->setMargin(0);
-        layout->addWidget(container);
+        connect(placesModel, &QAbstractItemModel::rowsInserted, this, &PlacesPanel::slotRowsInserted);
+        connect(placesModel, &QAbstractItemModel::rowsAboutToBeRemoved, this, &PlacesPanel::slotRowsAboutToBeRemoved);
+
+        for (int i = 0; i < model()->rowCount(); ++i) {
+            connectDeviceSignals(model()->index(i, 0, QModelIndex()));
+        }
+
+        setUrl(m_url);
     }
 
-    Panel::showEvent(event);
+    KFilePlacesView::showEvent(event);
 }
 
-void PlacesPanel::slotItemActivated(int index)
+static bool isInternalDrag(const QMimeData *mimeData)
 {
-    const KStandardItem* item = m_model->item(index);
-    if (item) {
-        const KUrl url = item->dataValue("url").value<KUrl>();
-        emit placeActivated(url);
+    const auto formats = mimeData->formats();
+    for (const auto &format : formats) {
+        // from KFilePlacesModel::_k_internalMimetype
+        if (format.startsWith(QLatin1String("application/x-kfileplacesmodel-"))) {
+            return true;
+        }
     }
+    return false;
 }
 
-void PlacesPanel::slotItemMiddleClicked(int index)
+void PlacesPanel::dragMoveEvent(QDragMoveEvent *event)
 {
-    const KStandardItem* item = m_model->item(index);
-    if (item) {
-        const KUrl url = item->dataValue("url").value<KUrl>();
-        emit placeMiddleClicked(url);
+    const QModelIndex index = indexAt(event->position().toPoint());
+    if (index.isValid()) {
+        auto *placesModel = static_cast<KFilePlacesModel *>(model());
+
+        // Reject drag ontop of a non-writable protocol
+        // We don't know whether we're dropping inbetween or ontop of a place
+        // so still allow internal drag events so that re-arranging still works.
+        if (!isInternalDrag(event->mimeData())) {
+            const QUrl url = placesModel->url(index);
+            if (!url.isValid() || !KProtocolManager::supportsWriting(url)) {
+                event->setDropAction(Qt::IgnoreAction);
+            } else {
+                DragAndDropHelper::updateDropAction(event, url);
+            }
+        }
     }
+
+    KFilePlacesView::dragMoveEvent(event);
 }
 
-void PlacesPanel::slotUrlsDropped(const KUrl& dest, QDropEvent* event, QWidget* parent)
+void PlacesPanel::slotConfigureTrash()
 {
-    Q_UNUSED(parent);
-    DragAndDropHelper::dropUrls(KFileItem(), dest, event);
+    const QUrl url = currentIndex().data(KFilePlacesModel::UrlRole).toUrl();
+
+    DolphinSettingsDialog *settingsDialog = new DolphinSettingsDialog(url, this);
+    settingsDialog->setCurrentPage(settingsDialog->trashSettings);
+    settingsDialog->setAttribute(Qt::WA_DeleteOnClose);
+    settingsDialog->show();
 }
 
-void PlacesPanel::loadBookmarks()
+void PlacesPanel::slotUrlsDropped(const QUrl &dest, QDropEvent *event, QWidget *parent)
 {
-    KBookmarkGroup root = m_bookmarkManager->root();
-    KBookmark bookmark = root.first();
-    QSet<QString> devices = m_availableDevices;
+    KIO::DropJob *job = DragAndDropHelper::dropUrls(dest, event, parent);
+    if (job) {
+        connect(job, &KIO::DropJob::result, this, [this](KJob *job) {
+            if (job->error() && job->error() != KIO::ERR_USER_CANCELED) {
+                Q_EMIT errorMessage(job->errorString());
+            }
+        });
+    }
+}
+
+void PlacesPanel::slotContextMenuAboutToShow(const QModelIndex &index, QMenu *menu)
+{
+    Q_UNUSED(menu);
 
-    while (!bookmark.isNull()) {
-        const QString udi = bookmark.metaDataItem("UDI");
-        const QString appName = bookmark.metaDataItem("OnlyInApp");
-        const bool deviceAvailable = devices.remove(udi);
+    auto *placesModel = static_cast<KFilePlacesModel *>(model());
+    const QUrl url = placesModel->url(index);
+    const Solid::Device device = placesModel->deviceForIndex(index);
 
-        const bool allowedHere = appName.isEmpty() || (appName == KGlobal::mainComponent().componentName());
+    m_configureTrashAction->setVisible(url.scheme() == QLatin1String("trash"));
+    m_openInSplitView->setVisible(url.isValid());
 
-        if ((udi.isEmpty() && allowedHere) || deviceAvailable) {
-            KStandardItem* item = new KStandardItem();
-            item->setIcon(KIcon(bookmark.icon()));
-            item->setText(bookmark.text());
-            item->setDataValue("address", bookmark.address());
-            item->setDataValue("url", bookmark.url());
-            if (deviceAvailable) {
-                item->setDataValue("udi", udi);
+    // show customContextMenuActions only on the view's context menu
+    if (!url.isValid() && !device.isValid()) {
+        addActions(m_customContextMenuActions);
+    } else {
+        const auto actions = this->actions();
+        for (QAction *action : actions) {
+            if (m_customContextMenuActions.contains(action)) {
+                removeAction(action);
             }
-            m_model->appendItem(item);
         }
+    }
+}
+
+void PlacesPanel::slotTearDownRequested(const QModelIndex &index)
+{
+    auto *placesModel = static_cast<KFilePlacesModel *>(model());
+
+    Solid::StorageAccess *storageAccess = placesModel->deviceForIndex(index).as<Solid::StorageAccess>();
+    if (!storageAccess) {
+        return;
+    }
+
+    m_indexToTearDown = QPersistentModelIndex(index);
+
+    // disconnect the Solid::StorageAccess::teardownRequested
+    // to prevent emitting PlacesPanel::storageTearDownExternallyRequested
+    // after we have emitted PlacesPanel::storageTearDownRequested
+    disconnect(storageAccess, &Solid::StorageAccess::teardownRequested, this, &PlacesPanel::slotTearDownRequestedExternally);
+    Q_EMIT storageTearDownRequested(storageAccess->filePath());
+}
 
-        bookmark = root.next(bookmark);
+void PlacesPanel::slotTearDownRequestedExternally(const QString &udi)
+{
+    Q_UNUSED(udi);
+    auto *storageAccess = static_cast<Solid::StorageAccess *>(sender());
+
+    Q_EMIT storageTearDownExternallyRequested(storageAccess->filePath());
+}
+
+void PlacesPanel::slotTearDownDone(const QModelIndex &index, Solid::ErrorType error, const QVariant &errorData)
+{
+    Q_UNUSED(errorData); // All error handling is currently done in frameworks.
+
+    if (index == m_indexToTearDown) {
+        if (error == Solid::ErrorType::NoError) {
+            // No error; it must have been unmounted successfully
+            Q_EMIT storageTearDownSuccessful();
+        }
+        m_indexToTearDown = QPersistentModelIndex();
     }
 }
 
-#include "placespanel.moc"
+void PlacesPanel::slotRowsInserted(const QModelIndex &parent, int first, int last)
+{
+    for (int i = first; i <= last; ++i) {
+        connectDeviceSignals(model()->index(i, 0, parent));
+    }
+}
+
+void PlacesPanel::slotRowsAboutToBeRemoved(const QModelIndex &parent, int first, int last)
+{
+    auto *placesModel = static_cast<KFilePlacesModel *>(model());
+
+    for (int i = first; i <= last; ++i) {
+        const QModelIndex index = placesModel->index(i, 0, parent);
+
+        Solid::StorageAccess *storageAccess = placesModel->deviceForIndex(index).as<Solid::StorageAccess>();
+        if (!storageAccess) {
+            continue;
+        }
+
+        disconnect(storageAccess, &Solid::StorageAccess::teardownRequested, this, nullptr);
+    }
+}
+
+void PlacesPanel::connectDeviceSignals(const QModelIndex &index)
+{
+    auto *placesModel = static_cast<KFilePlacesModel *>(model());
+
+    Solid::StorageAccess *storageAccess = placesModel->deviceForIndex(index).as<Solid::StorageAccess>();
+    if (!storageAccess) {
+        return;
+    }
+
+    connect(storageAccess, &Solid::StorageAccess::teardownRequested, this, &PlacesPanel::slotTearDownRequestedExternally);
+}
+
+#include "moc_placespanel.cpp"