src/settings/contextmenu/contextmenusettingspage.cpp

   1 /*
   2  * SPDX-FileCopyrightText: 2009-2010 Peter Penz <peter.penz19@gmail.com>
   3  *
   4  * SPDX-License-Identifier: GPL-2.0-or-later
   5  */
   6
   7 #include "contextmenusettingspage.h"
   8
   9 #include "dolphin_contextmenusettings.h"
  10 #include "dolphin_generalsettings.h"
  11 #include "dolphin_versioncontrolsettings.h"
  12 #include "global.h"
  13 #include "settings/serviceitemdelegate.h"
  14 #include "settings/servicemodel.h"
  15
  16 #include <KDesktopFile>
  17 #include <KDesktopFileActions>
  18 #include <KFileUtils>
  19 #include <KLocalizedString>
  20 #include <KMessageBox>
  21 #include <KPluginMetaData>
  22 #include <KService>
  23 #include <kio_version.h>
  24 #include <kiocore_export.h>
  25 #include <kservice_export.h>
  26 #include <kwidgetsaddons_version.h>
  27
  28 #include <KNSWidgets/Button>
  29 #include <QtGlobal>
  30
  31 #include <QApplication>
  32 #include <QGridLayout>
  33 #include <QLabel>
  34 #include <QLineEdit>
  35 #include <QListWidget>
  36 #include <QScroller>
  37 #include <QShowEvent>
  38 #include <QSortFilterProxyModel>
  39
  40 namespace
  41 {
  42 const bool ShowDeleteDefault = false;
  43 const char VersionControlServicePrefix[] = "_version_control_";
  44 const char DeleteService[] = "_delete";
  45 const char CopyToMoveToService[] = "_copy_to_move_to";
  46
  47 bool laterSelected = false;
  48 }
  49
  50 ContextMenuSettingsPage::ContextMenuSettingsPage(QWidget *parent, const KActionCollection *actions, const QStringList &actionIds)
  51     : SettingsPageBase(parent)
  52     , m_initialized(false)
  53     , m_serviceModel(nullptr)
  54     , m_sortModel(nullptr)
  55     , m_listView(nullptr)
  56     , m_enabledVcsPlugins()
  57     , m_actions(actions)
  58     , m_actionIds(actionIds)
  59 {
  60     QVBoxLayout *topLayout = new QVBoxLayout(this);
  61
  62     QLabel *label = new QLabel(i18nc("@label:textbox",
  63                                      "Select which services should "
  64                                      "be shown in the context menu:"),
  65                                this);
  66     label->setWordWrap(true);
  67     m_searchLineEdit = new QLineEdit(this);
  68     m_searchLineEdit->setPlaceholderText(i18nc("@label:textbox", "Search..."));
  69     connect(m_searchLineEdit, &QLineEdit::textChanged, this, [this](const QString &filter) {
  70         m_sortModel->setFilterFixedString(filter);
  71     });
  72
  73     m_listView = new QListView(this);
  74     QScroller::grabGesture(m_listView->viewport(), QScroller::TouchGesture);
  75
  76     auto *delegate = new ServiceItemDelegate(m_listView, m_listView);
  77     m_serviceModel = new ServiceModel(this);
  78     m_sortModel = new QSortFilterProxyModel(this);
  79     m_sortModel->setSourceModel(m_serviceModel);
  80     m_sortModel->setSortRole(Qt::DisplayRole);
  81     m_sortModel->setSortLocaleAware(true);
  82     m_sortModel->setFilterRole(Qt::DisplayRole);
  83     m_sortModel->setFilterCaseSensitivity(Qt::CaseInsensitive);
  84     m_listView->setModel(m_sortModel);
  85     m_listView->setItemDelegate(delegate);
  86     m_listView->setVerticalScrollMode(QListView::ScrollPerPixel);
  87     connect(m_listView, &QListView::clicked, this, &ContextMenuSettingsPage::changed);
  88
  89     topLayout->addWidget(label);
  90     topLayout->addWidget(m_searchLineEdit);
  91     topLayout->addWidget(m_listView);
  92
  93 #ifndef Q_OS_WIN
  94     using NewStuffButton = KNSWidgets::Button;
  95     auto *downloadButton = new NewStuffButton(i18nc("@action:button", "Download New Services..."), QStringLiteral("servicemenu.knsrc"), this);
  96     connect(downloadButton, &NewStuffButton::dialogFinished, this, [this](const auto &changedEntries) {
  97         if (!changedEntries.isEmpty()) {
  98             m_serviceModel->clear();
  99             loadServices();
 100         }
 101     });
 102     topLayout->addWidget(downloadButton);
 103 #endif // Q_OS_WIN
 104
 105     m_enabledVcsPlugins = VersionControlSettings::enabledPlugins();
 106     std::sort(m_enabledVcsPlugins.begin(), m_enabledVcsPlugins.end());
 107 }
 108
 109 ContextMenuSettingsPage::~ContextMenuSettingsPage()
 110 {
 111 }
 112
 113 bool ContextMenuSettingsPage::entryVisible(const QString &id)
 114 {
 115     if (id == "add_to_places") {
 116         return ContextMenuSettings::showAddToPlaces();
 117     } else if (id == "sort") {
 118         return ContextMenuSettings::showSortBy();
 119     } else if (id == "view_mode") {
 120         return ContextMenuSettings::showViewMode();
 121     } else if (id == "open_in_new_tab") {
 122         return ContextMenuSettings::showOpenInNewTab();
 123     } else if (id == "open_in_new_window") {
 124         return ContextMenuSettings::showOpenInNewWindow();
 125     } else if (id == "copy_location") {
 126         return ContextMenuSettings::showCopyLocation();
 127     } else if (id == "duplicate") {
 128         return ContextMenuSettings::showDuplicateHere();
 129     } else if (id == "open_terminal_here") {
 130         return ContextMenuSettings::showOpenTerminal();
 131     }
 132     return false;
 133 }
 134
 135 void ContextMenuSettingsPage::setEntryVisible(const QString &id, bool visible)
 136 {
 137     if (id == "add_to_places") {
 138         ContextMenuSettings::setShowAddToPlaces(visible);
 139     } else if (id == "sort") {
 140         ContextMenuSettings::setShowSortBy(visible);
 141     } else if (id == "view_mode") {
 142         ContextMenuSettings::setShowViewMode(visible);
 143     } else if (id == "open_in_new_tab") {
 144         ContextMenuSettings::setShowOpenInNewTab(visible);
 145     } else if (id == "open_in_new_window") {
 146         ContextMenuSettings::setShowOpenInNewWindow(visible);
 147     } else if (id == "copy_location") {
 148         ContextMenuSettings::setShowCopyLocation(visible);
 149     } else if (id == "duplicate") {
 150         ContextMenuSettings::setShowDuplicateHere(visible);
 151     } else if (id == "open_terminal_here") {
 152         ContextMenuSettings::setShowOpenTerminal(visible);
 153     }
 154 }
 155
 156 void ContextMenuSettingsPage::applySettings()
 157 {
 158     if (!m_initialized) {
 159         return;
 160     }
 161
 162     KConfig config(QStringLiteral("kservicemenurc"), KConfig::NoGlobals);
 163     KConfigGroup showGroup = config.group("Show");
 164
 165     QStringList enabledPlugins;
 166
 167     const QAbstractItemModel *model = m_listView->model();
 168     for (int i = 0; i < model->rowCount(); ++i) {
 169         const QModelIndex index = model->index(i, 0);
 170         const QString service = model->data(index, ServiceModel::DesktopEntryNameRole).toString();
 171         const bool checked = model->data(index, Qt::CheckStateRole).toBool();
 172
 173         if (service.startsWith(VersionControlServicePrefix)) {
 174             if (checked) {
 175                 enabledPlugins.append(model->data(index, Qt::DisplayRole).toString());
 176             }
 177         } else if (service == QLatin1String(DeleteService)) {
 178             KSharedConfig::Ptr globalConfig = KSharedConfig::openConfig(QStringLiteral("kdeglobals"), KConfig::NoGlobals);
 179             KConfigGroup configGroup(globalConfig, "KDE");
 180             configGroup.writeEntry("ShowDeleteCommand", checked);
 181             configGroup.sync();
 182         } else if (service == QLatin1String(CopyToMoveToService)) {
 183             ContextMenuSettings::setShowCopyMoveMenu(checked);
 184             ContextMenuSettings::self()->save();
 185         } else if (m_actionIds.contains(service)) {
 186             setEntryVisible(service, checked);
 187             ContextMenuSettings::self()->save();
 188         } else {
 189             showGroup.writeEntry(service, checked);
 190         }
 191     }
 192
 193     showGroup.sync();
 194
 195     if (m_enabledVcsPlugins != enabledPlugins) {
 196         VersionControlSettings::setEnabledPlugins(enabledPlugins);
 197         VersionControlSettings::self()->save();
 198
 199         if (!laterSelected) {
 200 #if KWIDGETSADDONS_VERSION >= QT_VERSION_CHECK(5, 100, 0)
 201             KMessageBox::ButtonCode promptRestart =
 202                 KMessageBox::questionTwoActions(window(),
 203 #else
 204             KMessageBox::ButtonCode promptRestart =
 205                 KMessageBox::questionYesNo(window(),
 206 #endif
 207                                                 i18nc("@info",
 208                                                       "Dolphin must be restarted to apply the "
 209                                                       "updated version control system settings."),
 210                                                 i18nc("@info", "Restart now?"),
 211                                                 KGuiItem(QApplication::translate("KStandardGuiItem", "&Restart"), QStringLiteral("dialog-restart")),
 212                                                 KGuiItem(QApplication::translate("KStandardGuiItem", "&Later"), QStringLiteral("dialog-later")));
 213 #if KWIDGETSADDONS_VERSION >= QT_VERSION_CHECK(5, 100, 0)
 214             if (promptRestart == KMessageBox::ButtonCode::PrimaryAction) {
 215 #else
 216             if (promptRestart == KMessageBox::ButtonCode::Yes) {
 217 #endif
 218                 Dolphin::openNewWindow();
 219                 qApp->quit();
 220             } else {
 221                 laterSelected = true;
 222             }
 223         }
 224     }
 225 }
 226
 227 void ContextMenuSettingsPage::restoreDefaults()
 228 {
 229     QAbstractItemModel *model = m_listView->model();
 230     for (int i = 0; i < model->rowCount(); ++i) {
 231         const QModelIndex index = model->index(i, 0);
 232         const QString service = model->data(index, ServiceModel::DesktopEntryNameRole).toString();
 233
 234         const bool checked =
 235             !service.startsWith(VersionControlServicePrefix) && service != QLatin1String(DeleteService) && service != QLatin1String(CopyToMoveToService);
 236         model->setData(index, checked, Qt::CheckStateRole);
 237     }
 238 }
 239
 240 void ContextMenuSettingsPage::showEvent(QShowEvent *event)
 241 {
 242     if (!event->spontaneous() && !m_initialized) {
 243         loadServices();
 244
 245         loadVersionControlSystems();
 246
 247         // Add "Show 'Delete' command" as service
 248         KSharedConfig::Ptr globalConfig = KSharedConfig::openConfig(QStringLiteral("kdeglobals"), KConfig::IncludeGlobals);
 249         KConfigGroup configGroup(globalConfig, "KDE");
 250         addRow(QStringLiteral("edit-delete"), i18nc("@option:check", "Delete"), DeleteService, configGroup.readEntry("ShowDeleteCommand", ShowDeleteDefault));
 251
 252         // Add "Show 'Copy To' and 'Move To' commands" as service
 253         addRow(QStringLiteral("edit-copy"),
 254                i18nc("@option:check", "'Copy To' and 'Move To' commands"),
 255                CopyToMoveToService,
 256                ContextMenuSettings::showCopyMoveMenu());
 257
 258         if (m_actions) {
 259             // Add other built-in actions
 260             for (const QString &id : m_actionIds) {
 261                 const QAction *action = m_actions->action(id);
 262                 if (action) {
 263                     addRow(action->icon().name(), action->text(), id, entryVisible(id));
 264                 }
 265             }
 266         }
 267
 268         m_sortModel->sort(Qt::DisplayRole);
 269
 270         m_initialized = true;
 271     }
 272     SettingsPageBase::showEvent(event);
 273 }
 274
 275 void ContextMenuSettingsPage::loadServices()
 276 {
 277     const KConfig config(QStringLiteral("kservicemenurc"), KConfig::NoGlobals);
 278     const KConfigGroup showGroup = config.group("Show");
 279
 280     // Load generic services
 281     const auto locations = QStandardPaths::locateAll(QStandardPaths::GenericDataLocation, QStringLiteral("kio/servicemenus"), QStandardPaths::LocateDirectory);
 282     QStringList files = KFileUtils::findAllUniqueFiles(locations);
 283
 284     for (const auto &file : qAsConst(files)) {
 285         const QList<KServiceAction> serviceActions = KDesktopFileActions::userDefinedServices(KService(file), true);
 286
 287         const KDesktopFile desktopFile(file);
 288         const QString subMenuName = desktopFile.desktopGroup().readEntry("X-KDE-Submenu");
 289
 290         for (const KServiceAction &action : serviceActions) {
 291             const QString serviceName = action.name();
 292             const bool addService = !action.noDisplay() && !action.isSeparator() && !isInServicesList(serviceName);
 293
 294             if (addService) {
 295                 const QString itemName = subMenuName.isEmpty() ? action.text() : i18nc("@item:inmenu", "%1: %2", subMenuName, action.text());
 296                 const bool checked = showGroup.readEntry(serviceName, true);
 297                 addRow(action.icon(), itemName, serviceName, checked);
 298             }
 299         }
 300     }
 301
 302     // Load JSON-based plugins that implement the KFileItemActionPlugin interface
 303     const auto jsonPlugins = KPluginMetaData::findPlugins(QStringLiteral("kf" QT_STRINGIFY(QT_VERSION_MAJOR)) + QStringLiteral("/kfileitemaction"));
 304
 305     for (const auto &jsonMetadata : jsonPlugins) {
 306         const QString desktopEntryName = jsonMetadata.pluginId();
 307         if (!isInServicesList(desktopEntryName)) {
 308             const bool checked = showGroup.readEntry(desktopEntryName, true);
 309             addRow(jsonMetadata.iconName(), jsonMetadata.name(), desktopEntryName, checked);
 310         }
 311     }
 312
 313     m_sortModel->sort(Qt::DisplayRole);
 314     m_searchLineEdit->setFocus(Qt::OtherFocusReason);
 315 }
 316
 317 void ContextMenuSettingsPage::loadVersionControlSystems()
 318 {
 319     const QStringList enabledPlugins = VersionControlSettings::enabledPlugins();
 320
 321     // Create a checkbox for each available version control plugin
 322     QSet<QString> loadedPlugins;
 323
 324     const QVector<KPluginMetaData> plugins = KPluginMetaData::findPlugins(QStringLiteral("dolphin/vcs"));
 325     for (const auto &plugin : plugins) {
 326         const QString pluginName = plugin.name();
 327         addRow(QStringLiteral("code-class"), pluginName, VersionControlServicePrefix + pluginName, enabledPlugins.contains(pluginName));
 328         loadedPlugins += pluginName;
 329     }
 330
 331     m_sortModel->sort(Qt::DisplayRole);
 332 }
 333
 334 bool ContextMenuSettingsPage::isInServicesList(const QString &service) const
 335 {
 336     for (int i = 0; i < m_serviceModel->rowCount(); ++i) {
 337         const QModelIndex index = m_serviceModel->index(i, 0);
 338         if (m_serviceModel->data(index, ServiceModel::DesktopEntryNameRole).toString() == service) {
 339             return true;
 340         }
 341     }
 342     return false;
 343 }
 344
 345 void ContextMenuSettingsPage::addRow(const QString &icon, const QString &text, const QString &value, bool checked)
 346 {
 347     m_serviceModel->insertRow(0);
 348
 349     const QModelIndex index = m_serviceModel->index(0, 0);
 350     m_serviceModel->setData(index, icon, Qt::DecorationRole);
 351     m_serviceModel->setData(index, text, Qt::DisplayRole);
 352     m_serviceModel->setData(index, value, ServiceModel::DesktopEntryNameRole);
 353     m_serviceModel->setData(index, checked, Qt::CheckStateRole);
 354 }