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     QAction *propertiesAction = m_mainWindow->actionCollection()->action(QStringLiteral("properties"));
 170     addAction(propertiesAction);
 171
 172     addSeparator();
 173
 174     addAction(m_mainWindow->actionCollection()->action(KStandardAction::name(KStandardAction::Cut)));
 175     addAction(m_mainWindow->actionCollection()->action(KStandardAction::name(KStandardAction::Copy)));
 176
 177     addSeparator();
 178
 179     QAction *deleteAction = m_mainWindow->actionCollection()->action(KStandardAction::name(KStandardAction::DeleteFile));
 180     addAction(deleteAction);
 181 }
 182
 183 void DolphinContextMenu::addDirectoryItemContextMenu()
 184 {
 185     // insert 'Open in new window' and 'Open in new tab' entries
 186     const KFileItemListProperties &selectedItemsProps = selectedItemsProperties();
 187     if (ContextMenuSettings::showOpenInNewTab()) {
 188         addAction(m_mainWindow->actionCollection()->action(QStringLiteral("open_in_new_tab")));
 189     }
 190     if (ContextMenuSettings::showOpenInNewWindow()) {
 191         addAction(m_mainWindow->actionCollection()->action(QStringLiteral("open_in_new_window")));
 192     }
 193
 194     if (ContextMenuSettings::showOpenInSplitView()) {
 195         addAction(m_mainWindow->actionCollection()->action(QStringLiteral("open_in_split_view")));
 196     }
 197
 198     // Insert 'Open With' entries
 199     addOpenWithActions();
 200
 201     // set up 'Create New' menu
 202     QAction *newDirAction = m_mainWindow->actionCollection()->action(QStringLiteral("create_dir"));
 203     QAction *newFileAction = m_mainWindow->actionCollection()->action(QStringLiteral("create_file"));
 204     DolphinNewFileMenu *newFileMenu = new DolphinNewFileMenu(newDirAction, newFileAction, m_mainWindow);
 205     newFileMenu->checkUpToDate();
 206     newFileMenu->setWorkingDirectory(m_fileInfo.url());
 207     newFileMenu->setEnabled(selectedItemsProps.supportsWriting());
 208     connect(newFileMenu, &DolphinNewFileMenu::fileCreated, newFileMenu, &DolphinNewFileMenu::deleteLater);
 209     connect(newFileMenu, &DolphinNewFileMenu::directoryCreated, newFileMenu, &DolphinNewFileMenu::deleteLater);
 210
 211     QMenu *menu = newFileMenu->menu();
 212     menu->setTitle(i18nc("@title:menu Create new folder, file, link, etc.", "Create New"));
 213     menu->setIcon(QIcon::fromTheme(QStringLiteral("list-add")));
 214     addMenu(menu);
 215
 216     addSeparator();
 217 }
 218
 219 void DolphinContextMenu::addOpenParentFolderActions()
 220 {
 221     addAction(QIcon::fromTheme(QStringLiteral("document-open-folder")), i18nc("@action:inmenu", "Open Path"), [this]() {
 222         const QUrl url = m_fileInfo.targetUrl();
 223         const QUrl parentUrl = KIO::upUrl(url);
 224         m_mainWindow->changeUrl(parentUrl);
 225         m_mainWindow->activeViewContainer()->view()->markUrlsAsSelected({url});
 226         m_mainWindow->activeViewContainer()->view()->markUrlAsCurrent(url);
 227     });
 228
 229     addAction(QIcon::fromTheme(QStringLiteral("tab-new")), i18nc("@action:inmenu", "Open Path in New Tab"), [this]() {
 230         const QUrl url = m_fileInfo.targetUrl();
 231         const QUrl parentUrl = KIO::upUrl(url);
 232         DolphinTabPage *tabPage = m_mainWindow->openNewTab(parentUrl);
 233         tabPage->activeViewContainer()->view()->markUrlsAsSelected({url});
 234         tabPage->activeViewContainer()->view()->markUrlAsCurrent(url);
 235     });
 236
 237     addAction(QIcon::fromTheme(QStringLiteral("window-new")), i18nc("@action:inmenu", "Open Path in New Window"), [this]() {
 238         Dolphin::openNewWindow({m_fileInfo.targetUrl()}, m_mainWindow, Dolphin::OpenNewWindowFlag::Select);
 239     });
 240 }
 241
 242 void DolphinContextMenu::addItemContextMenu()
 243 {
 244     Q_ASSERT(!m_fileInfo.isNull());
 245
 246     const KFileItemListProperties &selectedItemsProps = selectedItemsProperties();
 247
 248     m_fileItemActions->setItemListProperties(selectedItemsProps);
 249
 250     if (m_selectedItems.count() == 1) {
 251         // single files
 252         if (m_fileInfo.isDir()) {
 253             addDirectoryItemContextMenu();
 254         } else if (m_context & TimelineContext || m_context & SearchContext || m_context & RecentlyUsedContext) {
 255             addOpenWithActions();
 256
 257             addOpenParentFolderActions();
 258
 259             addSeparator();
 260         } else {
 261             // Insert 'Open With" entries
 262             addOpenWithActions();
 263         }
 264         if (m_fileInfo.isLink()) {
 265             addAction(m_mainWindow->actionCollection()->action(QStringLiteral("show_target")));
 266             addSeparator();
 267         }
 268     } else {
 269         // multiple files
 270         bool selectionHasOnlyDirs = true;
 271         for (const auto &item : std::as_const(m_selectedItems)) {
 272             const QUrl &url = DolphinView::openItemAsFolderUrl(item);
 273             if (url.isEmpty()) {
 274                 selectionHasOnlyDirs = false;
 275                 break;
 276             }
 277         }
 278
 279         if (selectionHasOnlyDirs && ContextMenuSettings::showOpenInNewTab()) {
 280             // insert 'Open in new tab' entry
 281             addAction(m_mainWindow->actionCollection()->action(QStringLiteral("open_in_new_tabs")));
 282         }
 283         // Insert 'Open With" entries
 284         addOpenWithActions();
 285     }
 286
 287     insertDefaultItemActions(selectedItemsProps);
 288
 289     addAdditionalActions(selectedItemsProps);
 290
 291     // insert 'Copy To' and 'Move To' sub menus
 292     if (ContextMenuSettings::showCopyMoveMenu()) {
 293         m_copyToMenu.setUrls(m_selectedItems.urlList());
 294         m_copyToMenu.setReadOnly(!selectedItemsProps.supportsWriting());
 295         m_copyToMenu.setAutoErrorHandlingEnabled(true);
 296         m_copyToMenu.addActionsTo(this);
 297     }
 298
 299     if (m_mainWindow->isSplitViewEnabledInCurrentTab()) {
 300         if (ContextMenuSettings::showCopyToOtherSplitView()) {
 301             addAction(m_mainWindow->actionCollection()->action(QStringLiteral("copy_to_inactive_split_view")));
 302         }
 303
 304         if (ContextMenuSettings::showMoveToOtherSplitView()) {
 305             addAction(m_mainWindow->actionCollection()->action(QStringLiteral("move_to_inactive_split_view")));
 306         }
 307     }
 308
 309     // insert 'Properties...' entry
 310     addSeparator();
 311     QAction *propertiesAction = m_mainWindow->actionCollection()->action(QStringLiteral("properties"));
 312     addAction(propertiesAction);
 313 }
 314
 315 void DolphinContextMenu::addViewportContextMenu()
 316 {
 317     const KFileItemListProperties baseUrlProperties(KFileItemList() << baseFileItem());
 318     m_fileItemActions->setItemListProperties(baseUrlProperties);
 319
 320     // Set up and insert 'Create New' menu
 321     KNewFileMenu *newFileMenu = m_mainWindow->newFileMenu();
 322     newFileMenu->checkUpToDate();
 323     newFileMenu->setWorkingDirectory(m_baseUrl);
 324     addMenu(newFileMenu->menu());
 325
 326     // Show "open with" menu items even if the dir is empty, because there are legitimate
 327     // use cases for this, such as opening an empty dir in Kate or VSCode or something
 328     addOpenWithActions();
 329
 330     QAction *pasteAction = createPasteAction();
 331     if (pasteAction) {
 332         addAction(pasteAction);
 333     }
 334
 335     // Insert 'Add to Places' entry if it's not already in the places panel
 336     if (ContextMenuSettings::showAddToPlaces() && !placeExists(m_mainWindow->activeViewContainer()->url())) {
 337         addAction(m_mainWindow->actionCollection()->action(QStringLiteral("add_to_places")));
 338     }
 339     addSeparator();
 340
 341     // Insert 'Sort By' and 'View Mode'
 342     if (ContextMenuSettings::showSortBy()) {
 343         addAction(m_mainWindow->actionCollection()->action(QStringLiteral("sort")));
 344     }
 345     if (ContextMenuSettings::showViewMode()) {
 346         addAction(m_mainWindow->actionCollection()->action(QStringLiteral("view_mode")));
 347     }
 348     if (ContextMenuSettings::showSortBy() || ContextMenuSettings::showViewMode()) {
 349         addSeparator();
 350     }
 351
 352     addAdditionalActions(baseUrlProperties);
 353
 354     addSeparator();
 355
 356     QAction *propertiesAction = m_mainWindow->actionCollection()->action(QStringLiteral("properties"));
 357     addAction(propertiesAction);
 358 }
 359
 360 void DolphinContextMenu::insertDefaultItemActions(const KFileItemListProperties &properties)
 361 {
 362     const KActionCollection *collection = m_mainWindow->actionCollection();
 363
 364     // Insert 'Cut', 'Copy', 'Copy Location' and 'Paste'
 365     addAction(collection->action(KStandardAction::name(KStandardAction::Cut)));
 366     addAction(collection->action(KStandardAction::name(KStandardAction::Copy)));
 367     if (ContextMenuSettings::showCopyLocation()) {
 368         QAction *copyPathAction = collection->action(QStringLiteral("copy_location"));
 369         copyPathAction->setEnabled(m_selectedItems.size() == 1);
 370         addAction(copyPathAction);
 371     }
 372     QAction *pasteAction = createPasteAction();
 373     if (pasteAction) {
 374         addAction(pasteAction);
 375     }
 376
 377     // Insert 'Duplicate Here'
 378     if (ContextMenuSettings::showDuplicateHere()) {
 379         addAction(m_mainWindow->actionCollection()->action(QStringLiteral("duplicate")));
 380     }
 381
 382     // Insert 'Rename'
 383     addAction(collection->action(KStandardAction::name(KStandardAction::RenameFile)));
 384
 385     // Insert 'Add to Places' entry if appropriate
 386     if (ContextMenuSettings::showAddToPlaces() && m_selectedItems.count() == 1 && m_fileInfo.isDir() && !placeExists(m_fileInfo.url())) {
 387         addAction(m_mainWindow->actionCollection()->action(QStringLiteral("add_to_places")));
 388     }
 389
 390     addSeparator();
 391
 392     // Insert 'Move to Trash' and/or 'Delete'
 393     const bool showDeleteAction = (KSharedConfig::openConfig()->group(QStringLiteral("KDE")).readEntry("ShowDeleteCommand", false) || !properties.isLocal());
 394     const bool showMoveToTrashAction = (properties.isLocal() && properties.supportsMoving());
 395
 396     if (showDeleteAction && showMoveToTrashAction) {
 397         delete m_removeAction;
 398         m_removeAction = nullptr;
 399         addAction(m_mainWindow->actionCollection()->action(KStandardAction::name(KStandardAction::MoveToTrash)));
 400         addAction(m_mainWindow->actionCollection()->action(KStandardAction::name(KStandardAction::DeleteFile)));
 401     } else if (showDeleteAction && !showMoveToTrashAction) {
 402         addAction(m_mainWindow->actionCollection()->action(KStandardAction::name(KStandardAction::DeleteFile)));
 403     } else {
 404         if (!m_removeAction) {
 405             m_removeAction = new DolphinRemoveAction(this, m_mainWindow->actionCollection());
 406         }
 407         addAction(m_removeAction);
 408         m_removeAction->update();
 409     }
 410 }
 411
 412 bool DolphinContextMenu::placeExists(const QUrl &url) const
 413 {
 414     const KFilePlacesModel *placesModel = DolphinPlacesModelSingleton::instance().placesModel();
 415
 416     QModelIndex url_index = placesModel->closestItem(url);
 417     return url_index.isValid() && placesModel->url(url_index).matches(url, QUrl::StripTrailingSlash);
 418 }
 419
 420 QAction *DolphinContextMenu::createPasteAction()
 421 {
 422     QAction *action = nullptr;
 423     KFileItem destItem;
 424     if (!m_fileInfo.isNull() && m_selectedItems.count() <= 1) {
 425         destItem = m_fileInfo;
 426     } else {
 427         destItem = baseFileItem();
 428     }
 429
 430     if (!destItem.isNull() && destItem.isDir()) {
 431         const QMimeData *mimeData = QApplication::clipboard()->mimeData();
 432         bool canPaste;
 433         const QString text = KIO::pasteActionText(mimeData, &canPaste, destItem);
 434         if (canPaste) {
 435             if (destItem == m_fileInfo) {
 436                 // if paste destination is a selected folder
 437                 action = new QAction(QIcon::fromTheme(QStringLiteral("edit-paste")), text, this);
 438                 connect(action, &QAction::triggered, m_mainWindow, &DolphinMainWindow::pasteIntoFolder);
 439             } else {
 440                 action = m_mainWindow->actionCollection()->action(KStandardAction::name(KStandardAction::Paste));
 441             }
 442         }
 443     }
 444
 445     return action;
 446 }
 447
 448 KFileItemListProperties &DolphinContextMenu::selectedItemsProperties() const
 449 {
 450     if (!m_selectedItemsProperties) {
 451         m_selectedItemsProperties = new KFileItemListProperties(m_selectedItems);
 452     }
 453     return *m_selectedItemsProperties;
 454 }
 455
 456 KFileItem DolphinContextMenu::baseFileItem()
 457 {
 458     if (!m_baseFileItem) {
 459         const DolphinView *view = m_mainWindow->activeViewContainer()->view();
 460         KFileItem baseItem = view->rootItem();
 461         if (baseItem.isNull() || baseItem.url() != m_baseUrl) {
 462             m_baseFileItem = new KFileItem(m_baseUrl);
 463         } else {
 464             m_baseFileItem = new KFileItem(baseItem);
 465         }
 466     }
 467     return *m_baseFileItem;
 468 }
 469
 470 void DolphinContextMenu::addOpenWithActions()
 471 {
 472     // insert 'Open With...' action or sub menu
 473     m_fileItemActions->insertOpenWithActionsTo(nullptr, this, QStringList{qApp->desktopFileName()});
 474
 475     // For a single file, hint in "Open with" menu that middle-clicking would open it in the secondary app.
 476     // (Unless middle-clicking would open it as a folder in a new tab (e.g. archives).)
 477     const QUrl &url = DolphinView::openItemAsFolderUrl(m_fileInfo, GeneralSettings::browseThroughArchives());
 478     if (m_selectedItems.count() == 1 && url.isEmpty()) {
 479         if (QAction *openWithSubMenu = findChild<QAction *>(QStringLiteral("openWith_submenu"))) {
 480             Q_ASSERT(openWithSubMenu->menu());
 481             Q_ASSERT(!openWithSubMenu->menu()->isEmpty());
 482
 483             auto *secondaryApp = openWithSubMenu->menu()->actions().first();
 484             // Add it like a keyboard shortcut, Qt uses \t as a separator.
 485             if (!secondaryApp->text().contains(QLatin1Char('\t'))) {
 486                 secondaryApp->setText(secondaryApp->text() + QLatin1Char('\t')
 487                                       + i18nc("@action:inmenu Shortcut, middle click to trigger menu item, keep short", "Middle Click"));
 488             }
 489         }
 490     }
 491 }
 492
 493 void DolphinContextMenu::addAdditionalActions(const KFileItemListProperties &props)
 494 {
 495     addSeparator();
 496
 497     QList<QAction *> additionalActions;
 498     if (props.isLocal() && ContextMenuSettings::showOpenTerminal()) {
 499         additionalActions << m_mainWindow->actionCollection()->action(QStringLiteral("open_terminal_here"));
 500     }
 501     m_fileItemActions->addActionsTo(this, KFileItemActions::MenuActionSource::All, additionalActions);
 502
 503     const DolphinView *view = m_mainWindow->activeViewContainer()->view();
 504     const QList<QAction *> versionControlActions = view->versionControlActions(m_selectedItems);
 505     if (!versionControlActions.isEmpty()) {
 506         addSeparator();
 507         addActions(versionControlActions);
 508         addSeparator();
 509     }
 510 }
 511
 512 #include "moc_dolphincontextmenu.cpp"