src/dolphincontextmenu.cpp

   1 /*
   2  * SPDX-FileCopyrightText: 2006 Peter Penz (peter.penz@gmx.at) and Cvetoslav Ludmiloff
   3  *
   4  * SPDX-License-Identifier: GPL-2.0-or-later
   5  */
   6
   7 #include "dolphincontextmenu.h"
   8
   9 #include "dolphin_contextmenusettings.h"
  10 #include "dolphin_generalsettings.h"
  11 #include "dolphinmainwindow.h"
  12 #include "dolphinnewfilemenu.h"
  13 #include "dolphinplacesmodelsingleton.h"
  14 #include "dolphinremoveaction.h"
  15 #include "dolphinviewcontainer.h"
  16 #include "global.h"
  17 #include "trash/dolphintrash.h"
  18 #include "views/dolphinview.h"
  19 #include "views/viewmodecontroller.h"
  20
  21 #include <KActionCollection>
  22 #include <KFileItemListProperties>
  23 #include <KHamburgerMenu>
  24 #include <KIO/EmptyTrashJob>
  25 #include <KIO/JobUiDelegate>
  26 #include <KIO/Paste>
  27 #include <KIO/RestoreJob>
  28 #include <KJobWidgets>
  29 #include <KLocalizedString>
  30 #include <KNewFileMenu>
  31 #include <KStandardAction>
  32 #include <kio_version.h>
  33
  34 #include <QApplication>
  35 #include <QClipboard>
  36 #include <QKeyEvent>
  37
  38 DolphinContextMenu::DolphinContextMenu(DolphinMainWindow *parent,
  39                                        const KFileItem &fileInfo,
  40                                        const KFileItemList &selectedItems,
  41                                        const QUrl &baseUrl,
  42                                        KFileItemActions *fileItemActions)
  43     : QMenu(parent)
  44     , m_mainWindow(parent)
  45     , m_fileInfo(fileInfo)
  46     , m_baseUrl(baseUrl)
  47     , m_baseFileItem(nullptr)
  48     , m_selectedItems(selectedItems)
  49     , m_selectedItemsProperties(nullptr)
  50     , m_context(NoContext)
  51     , m_copyToMenu(parent)
  52     , m_removeAction(nullptr)
  53     , m_fileItemActions(fileItemActions)
  54 {
  55     QApplication::instance()->installEventFilter(this);
  56
  57     addAllActions();
  58 }
  59
  60 DolphinContextMenu::~DolphinContextMenu()
  61 {
  62     delete m_baseFileItem;
  63     m_baseFileItem = nullptr;
  64     delete m_selectedItemsProperties;
  65     m_selectedItemsProperties = nullptr;
  66 }
  67
  68 void DolphinContextMenu::addAllActions()
  69 {
  70     static_cast<KHamburgerMenu *>(m_mainWindow->actionCollection()->action(QStringLiteral("hamburger_menu")))->addToMenu(this);
  71
  72     // get the context information
  73     const auto scheme = m_baseUrl.scheme();
  74     if (scheme == QLatin1String("trash")) {
  75         m_context |= TrashContext;
  76     } else if (scheme.contains(QLatin1String("search"))) {
  77         m_context |= SearchContext;
  78     } else if (scheme.contains(QLatin1String("timeline"))) {
  79         m_context |= TimelineContext;
  80     }
  81
  82     if (!m_fileInfo.isNull() && !m_selectedItems.isEmpty()) {
  83         m_context |= ItemContext;
  84         // TODO: handle other use cases like devices + desktop files
  85     }
  86
  87     // open the corresponding popup for the context
  88     if (m_context & TrashContext) {
  89         if (m_context & ItemContext) {
  90             addTrashItemContextMenu();
  91         } else {
  92             addTrashContextMenu();
  93         }
  94     } else if (m_context & ItemContext) {
  95         addItemContextMenu();
  96     } else {
  97         addViewportContextMenu();
  98     }
  99 }
 100
 101 bool DolphinContextMenu::eventFilter(QObject *object, QEvent *event)
 102 {
 103     Q_UNUSED(object)
 104
 105     if (event->type() == QEvent::KeyPress || event->type() == QEvent::KeyRelease) {
 106         QKeyEvent *keyEvent = static_cast<QKeyEvent *>(event);
 107
 108         if (m_removeAction && keyEvent->key() == Qt::Key_Shift) {
 109             if (event->type() == QEvent::KeyPress) {
 110                 m_removeAction->update(DolphinRemoveAction::ShiftState::Pressed);
 111             } else {
 112                 m_removeAction->update(DolphinRemoveAction::ShiftState::Released);
 113             }
 114         }
 115     }
 116
 117     return false;
 118 }
 119
 120 void DolphinContextMenu::addTrashContextMenu()
 121 {
 122     Q_ASSERT(m_context & TrashContext);
 123
 124     QAction *emptyTrashAction = addAction(QIcon::fromTheme(QStringLiteral("trash-empty")), i18nc("@action:inmenu", "Empty Trash"), [this]() {
 125         Trash::empty(m_mainWindow);
 126     });
 127     emptyTrashAction->setEnabled(!Trash::isEmpty());
 128
 129     QAction *propertiesAction = m_mainWindow->actionCollection()->action(QStringLiteral("properties"));
 130     addAction(propertiesAction);
 131 }
 132
 133 void DolphinContextMenu::addTrashItemContextMenu()
 134 {
 135     Q_ASSERT(m_context & TrashContext);
 136     Q_ASSERT(m_context & ItemContext);
 137
 138     addAction(QIcon::fromTheme("restoration"), i18nc("@action:inmenu", "Restore"), [this]() {
 139         QList<QUrl> selectedUrls;
 140         selectedUrls.reserve(m_selectedItems.count());
 141         for (const KFileItem &item : qAsConst(m_selectedItems)) {
 142             selectedUrls.append(item.url());
 143         }
 144
 145         KIO::RestoreJob *job = KIO::restoreFromTrash(selectedUrls);
 146         KJobWidgets::setWindow(job, m_mainWindow);
 147         job->uiDelegate()->setAutoErrorHandlingEnabled(true);
 148     });
 149
 150     QAction *deleteAction = m_mainWindow->actionCollection()->action(KStandardAction::name(KStandardAction::DeleteFile));
 151     addAction(deleteAction);
 152
 153     QAction *propertiesAction = m_mainWindow->actionCollection()->action(QStringLiteral("properties"));
 154     addAction(propertiesAction);
 155 }
 156
 157 void DolphinContextMenu::addDirectoryItemContextMenu()
 158 {
 159     // insert 'Open in new window' and 'Open in new tab' entries
 160     const KFileItemListProperties &selectedItemsProps = selectedItemsProperties();
 161     if (ContextMenuSettings::showOpenInNewTab()) {
 162         addAction(m_mainWindow->actionCollection()->action(QStringLiteral("open_in_new_tab")));
 163     }
 164     if (ContextMenuSettings::showOpenInNewWindow()) {
 165         addAction(m_mainWindow->actionCollection()->action(QStringLiteral("open_in_new_window")));
 166     }
 167
 168     // Insert 'Open With' entries
 169     addOpenWithActions();
 170
 171     // set up 'Create New' menu
 172     DolphinNewFileMenu *newFileMenu = new DolphinNewFileMenu(m_mainWindow->actionCollection(), m_mainWindow);
 173     newFileMenu->checkUpToDate();
 174 #if KIO_VERSION >= QT_VERSION_CHECK(5, 97, 0)
 175     newFileMenu->setWorkingDirectory(m_fileInfo.url());
 176 #else
 177     newFileMenu->setPopupFiles(QList<QUrl>() << m_fileInfo.url());
 178 #endif
 179     newFileMenu->setEnabled(selectedItemsProps.supportsWriting());
 180     connect(newFileMenu, &DolphinNewFileMenu::fileCreated, newFileMenu, &DolphinNewFileMenu::deleteLater);
 181     connect(newFileMenu, &DolphinNewFileMenu::directoryCreated, newFileMenu, &DolphinNewFileMenu::deleteLater);
 182
 183     QMenu *menu = newFileMenu->menu();
 184     menu->setTitle(i18nc("@title:menu Create new folder, file, link, etc.", "Create New"));
 185     menu->setIcon(QIcon::fromTheme(QStringLiteral("list-add")));
 186     addMenu(menu);
 187
 188     addSeparator();
 189 }
 190
 191 void DolphinContextMenu::addItemContextMenu()
 192 {
 193     Q_ASSERT(!m_fileInfo.isNull());
 194
 195     const KFileItemListProperties &selectedItemsProps = selectedItemsProperties();
 196
 197     m_fileItemActions->setItemListProperties(selectedItemsProps);
 198
 199     if (m_selectedItems.count() == 1) {
 200         // single files
 201         if (m_fileInfo.isDir()) {
 202             addDirectoryItemContextMenu();
 203         } else if (m_context & TimelineContext || m_context & SearchContext) {
 204             addOpenWithActions();
 205
 206             addAction(QIcon::fromTheme(QStringLiteral("document-open-folder")), i18nc("@action:inmenu", "Open Path"), [this]() {
 207                 m_mainWindow->changeUrl(KIO::upUrl(m_fileInfo.url()));
 208                 m_mainWindow->activeViewContainer()->view()->markUrlsAsSelected({m_fileInfo.url()});
 209                 m_mainWindow->activeViewContainer()->view()->markUrlAsCurrent(m_fileInfo.url());
 210             });
 211
 212             addAction(QIcon::fromTheme(QStringLiteral("window-new")), i18nc("@action:inmenu", "Open Path in New Window"), [this]() {
 213                 Dolphin::openNewWindow({m_fileInfo.url()}, m_mainWindow, Dolphin::OpenNewWindowFlag::Select);
 214             });
 215
 216             addAction(QIcon::fromTheme(QStringLiteral("tab-new")), i18nc("@action:inmenu", "Open Path in New Tab"), [this]() {
 217                 m_mainWindow->openNewTab(KIO::upUrl(m_fileInfo.url()));
 218             });
 219
 220             addSeparator();
 221         } else {
 222             // Insert 'Open With" entries
 223             addOpenWithActions();
 224         }
 225         if (m_fileInfo.isLink()) {
 226             addAction(m_mainWindow->actionCollection()->action(QStringLiteral("show_target")));
 227             addSeparator();
 228         }
 229     } else {
 230         // multiple files
 231         bool selectionHasOnlyDirs = true;
 232         for (const auto &item : qAsConst(m_selectedItems)) {
 233             const QUrl &url = DolphinView::openItemAsFolderUrl(item);
 234             if (url.isEmpty()) {
 235                 selectionHasOnlyDirs = false;
 236                 break;
 237             }
 238         }
 239
 240         if (selectionHasOnlyDirs && ContextMenuSettings::showOpenInNewTab()) {
 241             // insert 'Open in new tab' entry
 242             addAction(m_mainWindow->actionCollection()->action(QStringLiteral("open_in_new_tabs")));
 243         }
 244         // Insert 'Open With" entries
 245         addOpenWithActions();
 246     }
 247
 248     insertDefaultItemActions(selectedItemsProps);
 249
 250     addAdditionalActions(selectedItemsProps);
 251
 252     // insert 'Copy To' and 'Move To' sub menus
 253     if (ContextMenuSettings::showCopyMoveMenu()) {
 254         m_copyToMenu.setUrls(m_selectedItems.urlList());
 255         m_copyToMenu.setReadOnly(!selectedItemsProps.supportsWriting());
 256         m_copyToMenu.setAutoErrorHandlingEnabled(true);
 257         m_copyToMenu.addActionsTo(this);
 258     }
 259
 260     // insert 'Properties...' entry
 261     addSeparator();
 262     QAction *propertiesAction = m_mainWindow->actionCollection()->action(QStringLiteral("properties"));
 263     addAction(propertiesAction);
 264 }
 265
 266 void DolphinContextMenu::addViewportContextMenu()
 267 {
 268     const KFileItemListProperties baseUrlProperties(KFileItemList() << baseFileItem());
 269     m_fileItemActions->setItemListProperties(baseUrlProperties);
 270
 271     // Set up and insert 'Create New' menu
 272     KNewFileMenu *newFileMenu = m_mainWindow->newFileMenu();
 273     newFileMenu->checkUpToDate();
 274 #if KIO_VERSION >= QT_VERSION_CHECK(5, 97, 0)
 275     newFileMenu->setWorkingDirectory(m_baseUrl);
 276 #else
 277     newFileMenu->setPopupFiles(QList<QUrl>() << m_baseUrl);
 278 #endif
 279     addMenu(newFileMenu->menu());
 280
 281     // Show "open with" menu items even if the dir is empty, because there are legitimate
 282     // use cases for this, such as opening an empty dir in Kate or VSCode or something
 283     addOpenWithActions();
 284
 285     QAction *pasteAction = createPasteAction();
 286     if (pasteAction) {
 287         addAction(pasteAction);
 288     }
 289
 290     // Insert 'Add to Places' entry if it's not already in the places panel
 291     if (ContextMenuSettings::showAddToPlaces() && !placeExists(m_mainWindow->activeViewContainer()->url())) {
 292         addAction(m_mainWindow->actionCollection()->action(QStringLiteral("add_to_places")));
 293     }
 294     addSeparator();
 295
 296     // Insert 'Sort By' and 'View Mode'
 297     if (ContextMenuSettings::showSortBy()) {
 298         addAction(m_mainWindow->actionCollection()->action(QStringLiteral("sort")));
 299     }
 300     if (ContextMenuSettings::showViewMode()) {
 301         addAction(m_mainWindow->actionCollection()->action(QStringLiteral("view_mode")));
 302     }
 303     if (ContextMenuSettings::showSortBy() || ContextMenuSettings::showViewMode()) {
 304         addSeparator();
 305     }
 306
 307     addAdditionalActions(baseUrlProperties);
 308
 309     addSeparator();
 310
 311     QAction *propertiesAction = m_mainWindow->actionCollection()->action(QStringLiteral("properties"));
 312     addAction(propertiesAction);
 313 }
 314
 315 void DolphinContextMenu::insertDefaultItemActions(const KFileItemListProperties &properties)
 316 {
 317     const KActionCollection *collection = m_mainWindow->actionCollection();
 318
 319     // Insert 'Cut', 'Copy', 'Copy Location' and 'Paste'
 320     addAction(collection->action(KStandardAction::name(KStandardAction::Cut)));
 321     addAction(collection->action(KStandardAction::name(KStandardAction::Copy)));
 322     if (ContextMenuSettings::showCopyLocation()) {
 323         QAction *copyPathAction = collection->action(QString("copy_location"));
 324         copyPathAction->setEnabled(m_selectedItems.size() == 1);
 325         addAction(copyPathAction);
 326     }
 327     QAction *pasteAction = createPasteAction();
 328     if (pasteAction) {
 329         addAction(pasteAction);
 330     }
 331
 332     // Insert 'Duplicate Here'
 333     if (ContextMenuSettings::showDuplicateHere()) {
 334         addAction(m_mainWindow->actionCollection()->action(QStringLiteral("duplicate")));
 335     }
 336
 337     // Insert 'Rename'
 338     addAction(collection->action(KStandardAction::name(KStandardAction::RenameFile)));
 339
 340     // Insert 'Add to Places' entry if appropriate
 341     if (ContextMenuSettings::showAddToPlaces() && m_selectedItems.count() == 1 && m_fileInfo.isDir() && !placeExists(m_fileInfo.url())) {
 342         addAction(m_mainWindow->actionCollection()->action(QStringLiteral("add_to_places")));
 343     }
 344
 345     addSeparator();
 346
 347     // Insert 'Move to Trash' and/or 'Delete'
 348     const bool showDeleteAction = (KSharedConfig::openConfig()->group("KDE").readEntry("ShowDeleteCommand", false) || !properties.isLocal());
 349     const bool showMoveToTrashAction = (properties.isLocal() && properties.supportsMoving());
 350
 351     if (showDeleteAction && showMoveToTrashAction) {
 352         delete m_removeAction;
 353         m_removeAction = nullptr;
 354         addAction(m_mainWindow->actionCollection()->action(KStandardAction::name(KStandardAction::MoveToTrash)));
 355         addAction(m_mainWindow->actionCollection()->action(KStandardAction::name(KStandardAction::DeleteFile)));
 356     } else if (showDeleteAction && !showMoveToTrashAction) {
 357         addAction(m_mainWindow->actionCollection()->action(KStandardAction::name(KStandardAction::DeleteFile)));
 358     } else {
 359         if (!m_removeAction) {
 360             m_removeAction = new DolphinRemoveAction(this, m_mainWindow->actionCollection());
 361         }
 362         addAction(m_removeAction);
 363         m_removeAction->update();
 364     }
 365 }
 366
 367 bool DolphinContextMenu::placeExists(const QUrl &url) const
 368 {
 369     const KFilePlacesModel *placesModel = DolphinPlacesModelSingleton::instance().placesModel();
 370
 371     const auto &matchedPlaces = placesModel->match(placesModel->index(0, 0), KFilePlacesModel::UrlRole, url, 1, Qt::MatchExactly);
 372
 373     return !matchedPlaces.isEmpty();
 374 }
 375
 376 QAction *DolphinContextMenu::createPasteAction()
 377 {
 378     QAction *action = nullptr;
 379     KFileItem destItem;
 380     if (!m_fileInfo.isNull() && m_selectedItems.count() <= 1) {
 381         destItem = m_fileInfo;
 382     } else {
 383         destItem = baseFileItem();
 384     }
 385
 386     if (!destItem.isNull() && destItem.isDir()) {
 387         const QMimeData *mimeData = QApplication::clipboard()->mimeData();
 388         bool canPaste;
 389         const QString text = KIO::pasteActionText(mimeData, &canPaste, destItem);
 390         if (canPaste) {
 391             if (destItem == m_fileInfo) {
 392                 // if paste destination is a selected folder
 393                 action = new QAction(QIcon::fromTheme(QStringLiteral("edit-paste")), text, this);
 394                 connect(action, &QAction::triggered, m_mainWindow, &DolphinMainWindow::pasteIntoFolder);
 395             } else {
 396                 action = m_mainWindow->actionCollection()->action(KStandardAction::name(KStandardAction::Paste));
 397             }
 398         }
 399     }
 400
 401     return action;
 402 }
 403
 404 KFileItemListProperties &DolphinContextMenu::selectedItemsProperties() const
 405 {
 406     if (!m_selectedItemsProperties) {
 407         m_selectedItemsProperties = new KFileItemListProperties(m_selectedItems);
 408     }
 409     return *m_selectedItemsProperties;
 410 }
 411
 412 KFileItem DolphinContextMenu::baseFileItem()
 413 {
 414     if (!m_baseFileItem) {
 415         const DolphinView *view = m_mainWindow->activeViewContainer()->view();
 416         KFileItem baseItem = view->rootItem();
 417         if (baseItem.isNull() || baseItem.url() != m_baseUrl) {
 418             m_baseFileItem = new KFileItem(m_baseUrl);
 419         } else {
 420             m_baseFileItem = new KFileItem(baseItem);
 421         }
 422     }
 423     return *m_baseFileItem;
 424 }
 425
 426 void DolphinContextMenu::addOpenWithActions()
 427 {
 428     // insert 'Open With...' action or sub menu
 429     m_fileItemActions->insertOpenWithActionsTo(nullptr, this, QStringList{qApp->desktopFileName()});
 430 }
 431
 432 void DolphinContextMenu::addAdditionalActions(const KFileItemListProperties &props)
 433 {
 434     addSeparator();
 435
 436     QList<QAction *> additionalActions;
 437     if (props.isLocal() && ContextMenuSettings::showOpenTerminal()) {
 438         additionalActions << m_mainWindow->actionCollection()->action(QStringLiteral("open_terminal_here"));
 439     }
 440     m_fileItemActions->addActionsTo(this, KFileItemActions::MenuActionSource::All, additionalActions);
 441
 442     const DolphinView *view = m_mainWindow->activeViewContainer()->view();
 443     const QList<QAction *> versionControlActions = view->versionControlActions(m_selectedItems);
 444     if (!versionControlActions.isEmpty()) {
 445         addActions(versionControlActions);
 446         addSeparator();
 447     }
 448 }