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