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