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