src/panels/places/placespanel.cpp

   1 /*
   2  * SPDX-FileCopyrightText: 2008-2012 Peter Penz <peter.penz19@gmail.com>
   3  * SPDX-FileCopyrightText: 2021 Kai Uwe Broulik <kde@broulik.de>
   4  *
   5  * Based on KFilePlacesView from kdelibs:
   6  * SPDX-FileCopyrightText: 2007 Kevin Ottens <ervin@kde.org>
   7  * SPDX-FileCopyrightText: 2007 David Faure <faure@kde.org>
   8  *
   9  * SPDX-License-Identifier: GPL-2.0-or-later
  10  */
  11
  12 #include "placespanel.h"
  13
  14 #include "dolphinplacesmodelsingleton.h"
  15 #include "dolphin_generalsettings.h"
  16 #include "dolphin_placespanelsettings.h"
  17 #include "global.h"
  18 #include "views/draganddrophelper.h"
  19 #include "settings/dolphinsettingsdialog.h"
  20
  21 #include <KFilePlacesModel>
  22 #include <KIO/DropJob>
  23 #include <KIO/Job>
  24 #include <KListOpenFilesJob>
  25 #include <KLocalizedString>
  26
  27 #include <QIcon>
  28 #include <QMenu>
  29 #include <QShowEvent>
  30 #include <QTimer>
  31
  32 #include <Solid/StorageAccess>
  33
  34 PlacesPanel::PlacesPanel(QWidget* parent)
  35     : KFilePlacesView(parent)
  36 {
  37     setDropOnPlaceEnabled(true);
  38     connect(this, &PlacesPanel::urlsDropped,
  39             this, &PlacesPanel::slotUrlsDropped);
  40
  41     setAutoResizeItemsEnabled(false);
  42
  43     setTeardownFunction([this](const QModelIndex &index) {
  44         slotTearDownRequested(index);
  45     });
  46
  47     m_configureTrashAction = new QAction(QIcon::fromTheme(QStringLiteral("configure")), i18nc("@action:inmenu", "Configure Trash…"));
  48     m_configureTrashAction->setPriority(QAction::HighPriority);
  49     connect(m_configureTrashAction, &QAction::triggered, this, &PlacesPanel::slotConfigureTrash);
  50     addAction(m_configureTrashAction);
  51
  52     connect(this, &PlacesPanel::contextMenuAboutToShow, this, &PlacesPanel::slotContextMenuAboutToShow);
  53
  54     connect(this, &PlacesPanel::iconSizeChanged, this, [this](const QSize &newSize) {
  55         int iconSize = qMin(newSize.width(), newSize.height());
  56         if (iconSize == 0) {
  57             // Don't store 0 size, let's keep -1 for default/small/automatic
  58             iconSize = -1;
  59         }
  60         PlacesPanelSettings* settings = PlacesPanelSettings::self();
  61         settings->setIconSize(iconSize);
  62         settings->save();
  63     });
  64 }
  65
  66 PlacesPanel::~PlacesPanel() = default;
  67
  68 void PlacesPanel::setUrl(const QUrl &url)
  69 {
  70     // KFilePlacesView::setUrl no-ops when no model is set but we only set it in showEvent()
  71     // Remember the URL and set it in showEvent
  72     m_url = url;
  73     KFilePlacesView::setUrl(url);
  74 }
  75
  76 QList<QAction*> PlacesPanel::customContextMenuActions() const
  77 {
  78     return m_customContextMenuActions;
  79 }
  80
  81 void PlacesPanel::setCustomContextMenuActions(const QList<QAction *> &actions)
  82 {
  83     m_customContextMenuActions = actions;
  84 }
  85
  86 void PlacesPanel::proceedWithTearDown()
  87 {
  88     Q_ASSERT(m_deviceToTearDown);
  89
  90     connect(m_deviceToTearDown, &Solid::StorageAccess::teardownDone,
  91             this, &PlacesPanel::slotTearDownDone);
  92     m_deviceToTearDown->teardown();
  93 }
  94
  95 void PlacesPanel::readSettings()
  96 {
  97     if (GeneralSettings::autoExpandFolders()) {
  98         setDragAutoActivationDelay(750);
  99     } else {
 100         setDragAutoActivationDelay(0);
 101     }
 102
 103     const int iconSize = qMax(0, PlacesPanelSettings::iconSize());
 104     setIconSize(QSize(iconSize, iconSize));
 105 }
 106
 107 void PlacesPanel::showEvent(QShowEvent* event)
 108 {
 109     if (!event->spontaneous() && !model()) {
 110         readSettings();
 111
 112         auto *placesModel = DolphinPlacesModelSingleton::instance().placesModel();
 113         setModel(placesModel);
 114
 115         connect(placesModel, &KFilePlacesModel::errorMessage, this, &PlacesPanel::errorMessage);
 116
 117         connect(placesModel, &QAbstractItemModel::rowsInserted, this, &PlacesPanel::slotRowsInserted);
 118         connect(placesModel, &QAbstractItemModel::rowsAboutToBeRemoved, this, &PlacesPanel::slotRowsAboutToBeRemoved);
 119
 120         for (int i = 0; i < model()->rowCount(); ++i) {
 121             connectDeviceSignals(model()->index(i, 0, QModelIndex()));
 122         }
 123
 124         setUrl(m_url);
 125     }
 126
 127     KFilePlacesView::showEvent(event);
 128 }
 129
 130 void PlacesPanel::slotConfigureTrash()
 131 {
 132     const QUrl url = currentIndex().data(KFilePlacesModel::UrlRole).toUrl();
 133
 134     DolphinSettingsDialog* settingsDialog = new DolphinSettingsDialog(url, this);
 135     settingsDialog->setCurrentPage(settingsDialog->trashSettings);
 136     settingsDialog->setAttribute(Qt::WA_DeleteOnClose);
 137     settingsDialog->show();
 138 }
 139
 140 void PlacesPanel::slotUrlsDropped(const QUrl& dest, QDropEvent* event, QWidget* parent)
 141 {
 142     KIO::DropJob *job = DragAndDropHelper::dropUrls(dest, event, parent);
 143     if (job) {
 144         connect(job, &KIO::DropJob::result, this, [this](KJob *job) { if (job->error()) Q_EMIT errorMessage(job->errorString()); });
 145     }
 146 }
 147
 148 void PlacesPanel::slotContextMenuAboutToShow(const QModelIndex &index, QMenu *menu)
 149 {
 150     Q_UNUSED(menu);
 151
 152     auto *placesModel = static_cast<KFilePlacesModel *>(model());
 153     const QUrl url = placesModel->url(index);
 154     const Solid::Device device = placesModel->deviceForIndex(index);
 155
 156     m_configureTrashAction->setVisible(url.scheme() == QLatin1String("trash"));
 157
 158     // show customContextMenuActions only on the view's context menu
 159     if (!url.isValid() && !device.isValid()) {
 160         addActions(m_customContextMenuActions);
 161     } else {
 162         const auto actions = this->actions();
 163         for (QAction *action : actions) {
 164             if (m_customContextMenuActions.contains(action)) {
 165                 removeAction(action);
 166             }
 167         }
 168     }
 169 }
 170
 171 void PlacesPanel::slotTearDownRequested(const QModelIndex &index)
 172 {
 173     auto *placesModel = static_cast<KFilePlacesModel *>(model());
 174
 175     Solid::StorageAccess *storageAccess = placesModel->deviceForIndex(index).as<Solid::StorageAccess>();
 176     if (!storageAccess) {
 177         return;
 178     }
 179
 180     m_deviceToTearDown = storageAccess;
 181
 182     // disconnect the Solid::StorageAccess::teardownRequested
 183     // to prevent emitting PlacesPanel::storageTearDownExternallyRequested
 184     // after we have emitted PlacesPanel::storageTearDownRequested
 185     disconnect(storageAccess, &Solid::StorageAccess::teardownRequested, this, &PlacesPanel::slotTearDownRequestedExternally);
 186     Q_EMIT storageTearDownRequested(storageAccess->filePath());
 187 }
 188
 189 void PlacesPanel::slotTearDownRequestedExternally(const QString &udi)
 190 {
 191     Q_UNUSED(udi);
 192     auto *storageAccess = static_cast<Solid::StorageAccess*>(sender());
 193
 194     Q_EMIT storageTearDownExternallyRequested(storageAccess->filePath());
 195 }
 196
 197 void PlacesPanel::slotTearDownDone(Solid::ErrorType error, const QVariant& errorData)
 198 {
 199     if (error && errorData.isValid()) {
 200         if (error == Solid::ErrorType::DeviceBusy) {
 201             KListOpenFilesJob* listOpenFilesJob = new KListOpenFilesJob(m_deviceToTearDown->filePath());
 202             connect(listOpenFilesJob, &KIO::Job::result, this, [this, listOpenFilesJob](KJob*) {
 203                 const KProcessList::KProcessInfoList blockingProcesses = listOpenFilesJob->processInfoList();
 204                 QString errorString;
 205                 if (blockingProcesses.isEmpty()) {
 206                     errorString = i18n("One or more files on this device are open within an application.");
 207                 } else {
 208                     QStringList blockingApps;
 209                     for (const auto& process : blockingProcesses) {
 210                         blockingApps << process.name();
 211                     }
 212                     blockingApps.removeDuplicates();
 213                     errorString = xi18np("One or more files on this device are opened in application <application>\"%2\"</application>.",
 214                             "One or more files on this device are opened in following applications: <application>%2</application>.",
 215                             blockingApps.count(), blockingApps.join(i18nc("separator in list of apps blocking device unmount", ", ")));
 216                 }
 217                 Q_EMIT errorMessage(errorString);
 218             });
 219             listOpenFilesJob->start();
 220         } else {
 221             Q_EMIT errorMessage(errorData.toString());
 222         }
 223     } else {
 224         // No error; it must have been unmounted successfully
 225         Q_EMIT storageTearDownSuccessful();
 226     }
 227     disconnect(m_deviceToTearDown, &Solid::StorageAccess::teardownDone,
 228                this, &PlacesPanel::slotTearDownDone);
 229     m_deviceToTearDown = nullptr;
 230 }
 231
 232 void PlacesPanel::slotRowsInserted(const QModelIndex &parent, int first, int last)
 233 {
 234     for (int i = first; i <= last; ++i) {
 235         connectDeviceSignals(model()->index(first, 0, parent));
 236     }
 237 }
 238
 239 void PlacesPanel::slotRowsAboutToBeRemoved(const QModelIndex &parent, int first, int last)
 240 {
 241     auto *placesModel = static_cast<KFilePlacesModel *>(model());
 242
 243     for (int i = first; i <= last; ++i) {
 244         const QModelIndex index = placesModel->index(i, 0, parent);
 245
 246         Solid::StorageAccess *storageAccess = placesModel->deviceForIndex(index).as<Solid::StorageAccess>();
 247         if (!storageAccess) {
 248             continue;
 249         }
 250
 251         disconnect(storageAccess, &Solid::StorageAccess::teardownRequested, this, nullptr);
 252     }
 253 }
 254
 255 void PlacesPanel::connectDeviceSignals(const QModelIndex &index)
 256 {
 257     auto *placesModel = static_cast<KFilePlacesModel *>(model());
 258
 259     Solid::StorageAccess *storageAccess = placesModel->deviceForIndex(index).as<Solid::StorageAccess>();
 260     if (!storageAccess) {
 261         return;
 262     }
 263
 264     connect(storageAccess, &Solid::StorageAccess::teardownRequested, this, &PlacesPanel::slotTearDownRequestedExternally);
 265 }