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
  36 DolphinContextMenu::DolphinContextMenu(DolphinMainWindow *parent,
  37                                        const KFileItem &fileInfo,
  38                                        const KFileItemList &selectedItems,
  39                                        const QUrl &baseUrl,
  40                                        KFileItemActions *fileItemActions)
  41     : QMenu(parent)
  42     , m_mainWindow(parent)
  43     , m_fileInfo(fileInfo)
  44     , m_baseUrl(baseUrl)
  45     , m_baseFileItem(nullptr)
  46     , m_selectedItems(selectedItems)
  47     , m_selectedItemsProperties(nullptr)
  48     , m_context(NoContext)
  49     , m_copyToMenu(parent)
  50     , m_removeAction(nullptr)
  51     , m_fileItemActions(fileItemActions)
  52 {
  53     QApplication::instance()->installEventFilter(this);
  54
  55     addAllActions();
  56 }
  57
  58 DolphinContextMenu::~DolphinContextMenu()
  59 {
  60     delete m_baseFileItem;
  61     m_baseFileItem = nullptr;
  62     delete m_selectedItemsProperties;
  63     m_selectedItemsProperties = nullptr;
  64 }
  65
  66 void DolphinContextMenu::addAllActions()
  67 {
  68     static_cast<KHamburgerMenu *>(m_mainWindow->actionCollection()->action(QStringLiteral("hamburger_menu")))->addToMenu(this);
  69
  70     // get the context information
  71     const auto scheme = m_baseUrl.scheme();
  72     if (scheme == QLatin1String("trash")) {
  73         m_context |= TrashContext;
  74     } else if (scheme.contains(QLatin1String("search"))) {
  75         m_context |= SearchContext;
  76     } else if (scheme.contains(QLatin1String("timeline"))) {
  77         m_context |= TimelineContext;
  78     } else if (scheme == QStringLiteral("recentlyused")) {
  79         m_context |= RecentlyUsedContext;
  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 : std::as_const(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     if (ContextMenuSettings::showOpenInSplitView()) {
 169         addAction(m_mainWindow->actionCollection()->action(QStringLiteral("open_in_split_view")));
 170     }
 171
 172     // Insert 'Open With' entries
 173     addOpenWithActions();
 174
 175     // set up 'Create New' menu
 176     DolphinNewFileMenu *newFileMenu = new DolphinNewFileMenu(m_mainWindow->actionCollection()->action(QStringLiteral("create_dir")), m_mainWindow);
 177     newFileMenu->checkUpToDate();
 178     newFileMenu->setWorkingDirectory(m_fileInfo.url());
 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::addOpenParentFolderActions()
 192 {
 193     addAction(QIcon::fromTheme(QStringLiteral("document-open-folder")), i18nc("@action:inmenu", "Open Path"), [this]() {
 194         const QUrl url = m_fileInfo.targetUrl();
 195         const QUrl parentUrl = KIO::upUrl(url);
 196         m_mainWindow->changeUrl(parentUrl);
 197         m_mainWindow->activeViewContainer()->view()->markUrlsAsSelected({url});
 198         m_mainWindow->activeViewContainer()->view()->markUrlAsCurrent(url);
 199     });
 200
 201     addAction(QIcon::fromTheme(QStringLiteral("tab-new")), i18nc("@action:inmenu", "Open Path in New Tab"), [this]() {
 202         m_mainWindow->openNewTab(KIO::upUrl(m_fileInfo.targetUrl()));
 203     });
 204
 205     addAction(QIcon::fromTheme(QStringLiteral("window-new")), i18nc("@action:inmenu", "Open Path in New Window"), [this]() {
 206         Dolphin::openNewWindow({m_fileInfo.targetUrl()}, m_mainWindow, Dolphin::OpenNewWindowFlag::Select);
 207     });
 208 }
 209
 210 void DolphinContextMenu::addItemContextMenu()
 211 {
 212     Q_ASSERT(!m_fileInfo.isNull());
 213
 214     const KFileItemListProperties &selectedItemsProps = selectedItemsProperties();
 215
 216     m_fileItemActions->setItemListProperties(selectedItemsProps);
 217
 218     if (m_selectedItems.count() == 1) {
 219         // single files
 220         if (m_fileInfo.isDir()) {
 221             addDirectoryItemContextMenu();
 222         } else if (m_context & TimelineContext || m_context & SearchContext || m_context & RecentlyUsedContext) {
 223             addOpenWithActions();
 224
 225             addOpenParentFolderActions();
 226
 227             addSeparator();
 228         } else {
 229             // Insert 'Open With" entries
 230             addOpenWithActions();
 231         }
 232         if (m_fileInfo.isLink()) {
 233             addAction(m_mainWindow->actionCollection()->action(QStringLiteral("show_target")));
 234             addSeparator();
 235         }
 236     } else {
 237         // multiple files
 238         bool selectionHasOnlyDirs = true;
 239         for (const auto &item : std::as_const(m_selectedItems)) {
 240             const QUrl &url = DolphinView::openItemAsFolderUrl(item);
 241             if (url.isEmpty()) {
 242                 selectionHasOnlyDirs = false;
 243                 break;
 244             }
 245         }
 246
 247         if (selectionHasOnlyDirs && ContextMenuSettings::showOpenInNewTab()) {
 248             // insert 'Open in new tab' entry
 249             addAction(m_mainWindow->actionCollection()->action(QStringLiteral("open_in_new_tabs")));
 250         }
 251         // Insert 'Open With" entries
 252         addOpenWithActions();
 253     }
 254
 255     insertDefaultItemActions(selectedItemsProps);
 256
 257     addAdditionalActions(selectedItemsProps);
 258
 259     // insert 'Copy To' and 'Move To' sub menus
 260     if (ContextMenuSettings::showCopyMoveMenu()) {
 261         m_copyToMenu.setUrls(m_selectedItems.urlList());
 262         m_copyToMenu.setReadOnly(!selectedItemsProps.supportsWriting());
 263         m_copyToMenu.setAutoErrorHandlingEnabled(true);
 264         m_copyToMenu.addActionsTo(this);
 265     }
 266
 267     if (m_mainWindow->isSplitViewEnabledInCurrentTab()) {
 268         if (ContextMenuSettings::showCopyToOtherSplitView()) {
 269             addAction(m_mainWindow->actionCollection()->action(QStringLiteral("copy_to_inactive_split_view")));
 270         }
 271
 272         if (ContextMenuSettings::showMoveToOtherSplitView()) {
 273             addAction(m_mainWindow->actionCollection()->action(QStringLiteral("move_to_inactive_split_view")));
 274         }
 275     }
 276
 277     // insert 'Properties...' entry
 278     addSeparator();
 279     QAction *propertiesAction = m_mainWindow->actionCollection()->action(QStringLiteral("properties"));
 280     addAction(propertiesAction);
 281 }
 282
 283 void DolphinContextMenu::addViewportContextMenu()
 284 {
 285     const KFileItemListProperties baseUrlProperties(KFileItemList() << baseFileItem());
 286     m_fileItemActions->setItemListProperties(baseUrlProperties);
 287
 288     // Set up and insert 'Create New' menu
 289     KNewFileMenu *newFileMenu = m_mainWindow->newFileMenu();
 290     newFileMenu->checkUpToDate();
 291     newFileMenu->setWorkingDirectory(m_baseUrl);
 292     addMenu(newFileMenu->menu());
 293
 294     // Show "open with" menu items even if the dir is empty, because there are legitimate
 295     // use cases for this, such as opening an empty dir in Kate or VSCode or something
 296     addOpenWithActions();
 297
 298     QAction *pasteAction = createPasteAction();
 299     if (pasteAction) {
 300         addAction(pasteAction);
 301     }
 302
 303     // Insert 'Add to Places' entry if it's not already in the places panel
 304     if (ContextMenuSettings::showAddToPlaces() && !placeExists(m_mainWindow->activeViewContainer()->url())) {
 305         addAction(m_mainWindow->actionCollection()->action(QStringLiteral("add_to_places")));
 306     }
 307     addSeparator();
 308
 309     // Insert 'Sort By', 'Group By' and 'View Mode'
 310     if (ContextMenuSettings::showSortBy()) {
 311         addAction(m_mainWindow->actionCollection()->action(QStringLiteral("sort")));
 312     }
 313     if (ContextMenuSettings::showGroupBy()) {
 314         addAction(m_mainWindow->actionCollection()->action(QStringLiteral("group")));
 315     }
 316     if (ContextMenuSettings::showViewMode()) {
 317         addAction(m_mainWindow->actionCollection()->action(QStringLiteral("view_mode")));
 318     }
 319     if (ContextMenuSettings::showSortBy() || ContextMenuSettings::showViewMode()) {
 320         addSeparator();
 321     }
 322
 323     addAdditionalActions(baseUrlProperties);
 324
 325     addSeparator();
 326
 327     QAction *propertiesAction = m_mainWindow->actionCollection()->action(QStringLiteral("properties"));
 328     addAction(propertiesAction);
 329 }
 330
 331 void DolphinContextMenu::insertDefaultItemActions(const KFileItemListProperties &properties)
 332 {
 333     const KActionCollection *collection = m_mainWindow->actionCollection();
 334
 335     // Insert 'Cut', 'Copy', 'Copy Location' and 'Paste'
 336     addAction(collection->action(KStandardAction::name(KStandardAction::Cut)));
 337     addAction(collection->action(KStandardAction::name(KStandardAction::Copy)));
 338     if (ContextMenuSettings::showCopyLocation()) {
 339         QAction *copyPathAction = collection->action(QString("copy_location"));
 340         copyPathAction->setEnabled(m_selectedItems.size() == 1);
 341         addAction(copyPathAction);
 342     }
 343     QAction *pasteAction = createPasteAction();
 344     if (pasteAction) {
 345         addAction(pasteAction);
 346     }
 347
 348     // Insert 'Duplicate Here'
 349     if (ContextMenuSettings::showDuplicateHere()) {
 350         addAction(m_mainWindow->actionCollection()->action(QStringLiteral("duplicate")));
 351     }
 352
 353     // Insert 'Rename'
 354     addAction(collection->action(KStandardAction::name(KStandardAction::RenameFile)));
 355
 356     // Insert 'Add to Places' entry if appropriate
 357     if (ContextMenuSettings::showAddToPlaces() && m_selectedItems.count() == 1 && m_fileInfo.isDir() && !placeExists(m_fileInfo.url())) {
 358         addAction(m_mainWindow->actionCollection()->action(QStringLiteral("add_to_places")));
 359     }
 360
 361     addSeparator();
 362
 363     // Insert 'Move to Trash' and/or 'Delete'
 364     const bool showDeleteAction = (KSharedConfig::openConfig()->group(QStringLiteral("KDE")).readEntry("ShowDeleteCommand", false) || !properties.isLocal());
 365     const bool showMoveToTrashAction = (properties.isLocal() && properties.supportsMoving());
 366
 367     if (showDeleteAction && showMoveToTrashAction) {
 368         delete m_removeAction;
 369         m_removeAction = nullptr;
 370         addAction(m_mainWindow->actionCollection()->action(KStandardAction::name(KStandardAction::MoveToTrash)));
 371         addAction(m_mainWindow->actionCollection()->action(KStandardAction::name(KStandardAction::DeleteFile)));
 372     } else if (showDeleteAction && !showMoveToTrashAction) {
 373         addAction(m_mainWindow->actionCollection()->action(KStandardAction::name(KStandardAction::DeleteFile)));
 374     } else {
 375         if (!m_removeAction) {
 376             m_removeAction = new DolphinRemoveAction(this, m_mainWindow->actionCollection());
 377         }
 378         addAction(m_removeAction);
 379         m_removeAction->update();
 380     }
 381 }
 382
 383 bool DolphinContextMenu::placeExists(const QUrl &url) const
 384 {
 385     const KFilePlacesModel *placesModel = DolphinPlacesModelSingleton::instance().placesModel();
 386
 387     QModelIndex url_index = placesModel->closestItem(url);
 388     return url_index.isValid() && placesModel->url(url_index).matches(url, QUrl::StripTrailingSlash);
 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     // (Unless middle-clicking would open it as a folder in a new tab (e.g. archives).)
 448     const QUrl &url = DolphinView::openItemAsFolderUrl(m_fileInfo, GeneralSettings::browseThroughArchives());
 449     if (m_selectedItems.count() == 1 && url.isEmpty()) {
 450         if (QAction *openWithSubMenu = findChild<QAction *>(QStringLiteral("openWith_submenu"))) {
 451             Q_ASSERT(openWithSubMenu->menu());
 452             Q_ASSERT(!openWithSubMenu->menu()->isEmpty());
 453
 454             auto *secondaryApp = openWithSubMenu->menu()->actions().first();
 455             // Add it like a keyboard shortcut, Qt uses \t as a separator.
 456             if (!secondaryApp->text().contains(QLatin1Char('\t'))) {
 457                 secondaryApp->setText(secondaryApp->text() + QLatin1Char('\t')
 458                                       + i18nc("@action:inmenu Shortcut, middle click to trigger menu item, keep short", "Middle Click"));
 459             }
 460         }
 461     }
 462 }
 463
 464 void DolphinContextMenu::addAdditionalActions(const KFileItemListProperties &props)
 465 {
 466     addSeparator();
 467
 468     QList<QAction *> additionalActions;
 469     if (props.isLocal() && ContextMenuSettings::showOpenTerminal()) {
 470         additionalActions << m_mainWindow->actionCollection()->action(QStringLiteral("open_terminal_here"));
 471     }
 472     m_fileItemActions->addActionsTo(this, KFileItemActions::MenuActionSource::All, additionalActions);
 473
 474     const DolphinView *view = m_mainWindow->activeViewContainer()->view();
 475     const QList<QAction *> versionControlActions = view->versionControlActions(m_selectedItems);
 476     if (!versionControlActions.isEmpty()) {
 477         addSeparator();
 478         addActions(versionControlActions);
 479         addSeparator();
 480     }
 481 }
 482
 483 #include "moc_dolphincontextmenu.cpp"