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