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