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 "dolphinmainwindow.h"
  11 #include "dolphinnewfilemenu.h"
  12 #include "dolphinplacesmodelsingleton.h"
  13 #include "dolphinremoveaction.h"
  14 #include "dolphinviewcontainer.h"
  15 #include "global.h"
  16 #include "trash/dolphintrash.h"
  17 #include "views/dolphinview.h"
  18
  19 #include <KActionCollection>
  20 #include <KFileItemListProperties>
  21 #include <KHamburgerMenu>
  22 #include <KIO/EmptyTrashJob>
  23 #include <KIO/JobUiDelegate>
  24 #include <KIO/Paste>
  25 #include <KIO/RestoreJob>
  26 #include <KJobWidgets>
  27 #include <KLocalizedString>
  28 #include <KNewFileMenu>
  29 #include <KStandardAction>
  30 #include <kio_version.h>
  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 : qAsConst(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     // Insert 'Open With' entries
 169     addOpenWithActions();
 170
 171     // set up 'Create New' menu
 172     DolphinNewFileMenu *newFileMenu = new DolphinNewFileMenu(m_mainWindow->actionCollection(), m_mainWindow);
 173     newFileMenu->checkUpToDate();
 174     newFileMenu->setWorkingDirectory(m_fileInfo.url());
 175     newFileMenu->setEnabled(selectedItemsProps.supportsWriting());
 176     connect(newFileMenu, &DolphinNewFileMenu::fileCreated, newFileMenu, &DolphinNewFileMenu::deleteLater);
 177     connect(newFileMenu, &DolphinNewFileMenu::directoryCreated, newFileMenu, &DolphinNewFileMenu::deleteLater);
 178
 179     QMenu *menu = newFileMenu->menu();
 180     menu->setTitle(i18nc("@title:menu Create new folder, file, link, etc.", "Create New"));
 181     menu->setIcon(QIcon::fromTheme(QStringLiteral("list-add")));
 182     addMenu(menu);
 183
 184     addSeparator();
 185 }
 186
 187 void DolphinContextMenu::addOpenParentFolderActions()
 188 {
 189     addAction(QIcon::fromTheme(QStringLiteral("document-open-folder")), i18nc("@action:inmenu", "Open Path"), [this]() {
 190         m_mainWindow->changeUrl(KIO::upUrl(m_fileInfo.url()));
 191         m_mainWindow->activeViewContainer()->view()->markUrlsAsSelected({m_fileInfo.url()});
 192         m_mainWindow->activeViewContainer()->view()->markUrlAsCurrent(m_fileInfo.url());
 193     });
 194
 195     addAction(QIcon::fromTheme(QStringLiteral("tab-new")), i18nc("@action:inmenu", "Open Path in New Tab"), [this]() {
 196         m_mainWindow->openNewTab(KIO::upUrl(m_fileInfo.url()));
 197     });
 198
 199     addAction(QIcon::fromTheme(QStringLiteral("window-new")), i18nc("@action:inmenu", "Open Path in New Window"), [this]() {
 200         Dolphin::openNewWindow({m_fileInfo.url()}, m_mainWindow, Dolphin::OpenNewWindowFlag::Select);
 201     });
 202 }
 203
 204 void DolphinContextMenu::addItemContextMenu()
 205 {
 206     Q_ASSERT(!m_fileInfo.isNull());
 207
 208     const KFileItemListProperties &selectedItemsProps = selectedItemsProperties();
 209
 210     m_fileItemActions->setItemListProperties(selectedItemsProps);
 211
 212     if (m_selectedItems.count() == 1) {
 213         // single files
 214         if (m_fileInfo.isDir()) {
 215             addDirectoryItemContextMenu();
 216         } else if (m_context & TimelineContext || m_context & SearchContext || m_context & RecentlyUsedContext) {
 217             addOpenWithActions();
 218
 219             addOpenParentFolderActions();
 220
 221             addSeparator();
 222         } else {
 223             // Insert 'Open With" entries
 224             addOpenWithActions();
 225         }
 226         if (m_fileInfo.isLink()) {
 227             addAction(m_mainWindow->actionCollection()->action(QStringLiteral("show_target")));
 228             addSeparator();
 229         }
 230     } else {
 231         // multiple files
 232         bool selectionHasOnlyDirs = true;
 233         for (const auto &item : qAsConst(m_selectedItems)) {
 234             const QUrl &url = DolphinView::openItemAsFolderUrl(item);
 235             if (url.isEmpty()) {
 236                 selectionHasOnlyDirs = false;
 237                 break;
 238             }
 239         }
 240
 241         if (selectionHasOnlyDirs && ContextMenuSettings::showOpenInNewTab()) {
 242             // insert 'Open in new tab' entry
 243             addAction(m_mainWindow->actionCollection()->action(QStringLiteral("open_in_new_tabs")));
 244         }
 245         // Insert 'Open With" entries
 246         addOpenWithActions();
 247     }
 248
 249     insertDefaultItemActions(selectedItemsProps);
 250
 251     addAdditionalActions(selectedItemsProps);
 252
 253     // insert 'Copy To' and 'Move To' sub menus
 254     if (ContextMenuSettings::showCopyMoveMenu()) {
 255         m_copyToMenu.setUrls(m_selectedItems.urlList());
 256         m_copyToMenu.setReadOnly(!selectedItemsProps.supportsWriting());
 257         m_copyToMenu.setAutoErrorHandlingEnabled(true);
 258         m_copyToMenu.addActionsTo(this);
 259     }
 260
 261     if (m_mainWindow->isSplitViewEnabledInCurrentTab()) {
 262         if (ContextMenuSettings::showCopyToOtherSplitView()) {
 263             addAction(m_mainWindow->actionCollection()->action(QStringLiteral("copy_to_inactive_split_view")));
 264         }
 265
 266         if (ContextMenuSettings::showMoveToOtherSplitView()) {
 267             addAction(m_mainWindow->actionCollection()->action(QStringLiteral("move_to_inactive_split_view")));
 268         }
 269     }
 270
 271     // insert 'Properties...' entry
 272     addSeparator();
 273     QAction *propertiesAction = m_mainWindow->actionCollection()->action(QStringLiteral("properties"));
 274     addAction(propertiesAction);
 275 }
 276
 277 void DolphinContextMenu::addViewportContextMenu()
 278 {
 279     const KFileItemListProperties baseUrlProperties(KFileItemList() << baseFileItem());
 280     m_fileItemActions->setItemListProperties(baseUrlProperties);
 281
 282     // Set up and insert 'Create New' menu
 283     KNewFileMenu *newFileMenu = m_mainWindow->newFileMenu();
 284     newFileMenu->checkUpToDate();
 285     newFileMenu->setWorkingDirectory(m_baseUrl);
 286     addMenu(newFileMenu->menu());
 287
 288     // Show "open with" menu items even if the dir is empty, because there are legitimate
 289     // use cases for this, such as opening an empty dir in Kate or VSCode or something
 290     addOpenWithActions();
 291
 292     QAction *pasteAction = createPasteAction();
 293     if (pasteAction) {
 294         addAction(pasteAction);
 295     }
 296
 297     // Insert 'Add to Places' entry if it's not already in the places panel
 298     if (ContextMenuSettings::showAddToPlaces() && !placeExists(m_mainWindow->activeViewContainer()->url())) {
 299         addAction(m_mainWindow->actionCollection()->action(QStringLiteral("add_to_places")));
 300     }
 301     addSeparator();
 302
 303     // Insert 'Sort By' and 'View Mode'
 304     if (ContextMenuSettings::showSortBy()) {
 305         addAction(m_mainWindow->actionCollection()->action(QStringLiteral("sort")));
 306     }
 307     if (ContextMenuSettings::showViewMode()) {
 308         addAction(m_mainWindow->actionCollection()->action(QStringLiteral("view_mode")));
 309     }
 310     if (ContextMenuSettings::showSortBy() || ContextMenuSettings::showViewMode()) {
 311         addSeparator();
 312     }
 313
 314     addAdditionalActions(baseUrlProperties);
 315
 316     addSeparator();
 317
 318     QAction *propertiesAction = m_mainWindow->actionCollection()->action(QStringLiteral("properties"));
 319     addAction(propertiesAction);
 320 }
 321
 322 void DolphinContextMenu::insertDefaultItemActions(const KFileItemListProperties &properties)
 323 {
 324     const KActionCollection *collection = m_mainWindow->actionCollection();
 325
 326     // Insert 'Cut', 'Copy', 'Copy Location' and 'Paste'
 327     addAction(collection->action(KStandardAction::name(KStandardAction::Cut)));
 328     addAction(collection->action(KStandardAction::name(KStandardAction::Copy)));
 329     if (ContextMenuSettings::showCopyLocation()) {
 330         QAction *copyPathAction = collection->action(QString("copy_location"));
 331         copyPathAction->setEnabled(m_selectedItems.size() == 1);
 332         addAction(copyPathAction);
 333     }
 334     QAction *pasteAction = createPasteAction();
 335     if (pasteAction) {
 336         addAction(pasteAction);
 337     }
 338
 339     // Insert 'Duplicate Here'
 340     if (ContextMenuSettings::showDuplicateHere()) {
 341         addAction(m_mainWindow->actionCollection()->action(QStringLiteral("duplicate")));
 342     }
 343
 344     // Insert 'Rename'
 345     addAction(collection->action(KStandardAction::name(KStandardAction::RenameFile)));
 346
 347     // Insert 'Add to Places' entry if appropriate
 348     if (ContextMenuSettings::showAddToPlaces() && m_selectedItems.count() == 1 && m_fileInfo.isDir() && !placeExists(m_fileInfo.url())) {
 349         addAction(m_mainWindow->actionCollection()->action(QStringLiteral("add_to_places")));
 350     }
 351
 352     addSeparator();
 353
 354     // Insert 'Move to Trash' and/or 'Delete'
 355     const bool showDeleteAction = (KSharedConfig::openConfig()->group("KDE").readEntry("ShowDeleteCommand", false) || !properties.isLocal());
 356     const bool showMoveToTrashAction = (properties.isLocal() && properties.supportsMoving());
 357
 358     if (showDeleteAction && showMoveToTrashAction) {
 359         delete m_removeAction;
 360         m_removeAction = nullptr;
 361         addAction(m_mainWindow->actionCollection()->action(KStandardAction::name(KStandardAction::MoveToTrash)));
 362         addAction(m_mainWindow->actionCollection()->action(KStandardAction::name(KStandardAction::DeleteFile)));
 363     } else if (showDeleteAction && !showMoveToTrashAction) {
 364         addAction(m_mainWindow->actionCollection()->action(KStandardAction::name(KStandardAction::DeleteFile)));
 365     } else {
 366         if (!m_removeAction) {
 367             m_removeAction = new DolphinRemoveAction(this, m_mainWindow->actionCollection());
 368         }
 369         addAction(m_removeAction);
 370         m_removeAction->update();
 371     }
 372 }
 373
 374 bool DolphinContextMenu::placeExists(const QUrl &url) const
 375 {
 376     const KFilePlacesModel *placesModel = DolphinPlacesModelSingleton::instance().placesModel();
 377
 378     const auto &matchedPlaces = placesModel->match(placesModel->index(0, 0), KFilePlacesModel::UrlRole, url, 1, Qt::MatchExactly);
 379
 380     return !matchedPlaces.isEmpty();
 381 }
 382
 383 QAction *DolphinContextMenu::createPasteAction()
 384 {
 385     QAction *action = nullptr;
 386     KFileItem destItem;
 387     if (!m_fileInfo.isNull() && m_selectedItems.count() <= 1) {
 388         destItem = m_fileInfo;
 389     } else {
 390         destItem = baseFileItem();
 391     }
 392
 393     if (!destItem.isNull() && destItem.isDir()) {
 394         const QMimeData *mimeData = QApplication::clipboard()->mimeData();
 395         bool canPaste;
 396         const QString text = KIO::pasteActionText(mimeData, &canPaste, destItem);
 397         if (canPaste) {
 398             if (destItem == m_fileInfo) {
 399                 // if paste destination is a selected folder
 400                 action = new QAction(QIcon::fromTheme(QStringLiteral("edit-paste")), text, this);
 401                 connect(action, &QAction::triggered, m_mainWindow, &DolphinMainWindow::pasteIntoFolder);
 402             } else {
 403                 action = m_mainWindow->actionCollection()->action(KStandardAction::name(KStandardAction::Paste));
 404             }
 405         }
 406     }
 407
 408     return action;
 409 }
 410
 411 KFileItemListProperties &DolphinContextMenu::selectedItemsProperties() const
 412 {
 413     if (!m_selectedItemsProperties) {
 414         m_selectedItemsProperties = new KFileItemListProperties(m_selectedItems);
 415     }
 416     return *m_selectedItemsProperties;
 417 }
 418
 419 KFileItem DolphinContextMenu::baseFileItem()
 420 {
 421     if (!m_baseFileItem) {
 422         const DolphinView *view = m_mainWindow->activeViewContainer()->view();
 423         KFileItem baseItem = view->rootItem();
 424         if (baseItem.isNull() || baseItem.url() != m_baseUrl) {
 425             m_baseFileItem = new KFileItem(m_baseUrl);
 426         } else {
 427             m_baseFileItem = new KFileItem(baseItem);
 428         }
 429     }
 430     return *m_baseFileItem;
 431 }
 432
 433 void DolphinContextMenu::addOpenWithActions()
 434 {
 435     // insert 'Open With...' action or sub menu
 436     m_fileItemActions->insertOpenWithActionsTo(nullptr, this, QStringList{qApp->desktopFileName()});
 437 }
 438
 439 void DolphinContextMenu::addAdditionalActions(const KFileItemListProperties &props)
 440 {
 441     addSeparator();
 442
 443     QList<QAction *> additionalActions;
 444     if (props.isLocal() && ContextMenuSettings::showOpenTerminal()) {
 445         additionalActions << m_mainWindow->actionCollection()->action(QStringLiteral("open_terminal_here"));
 446     }
 447     m_fileItemActions->addActionsTo(this, KFileItemActions::MenuActionSource::All, additionalActions);
 448
 449     const DolphinView *view = m_mainWindow->activeViewContainer()->view();
 450     const QList<QAction *> versionControlActions = view->versionControlActions(m_selectedItems);
 451     if (!versionControlActions.isEmpty()) {
 452         addActions(versionControlActions);
 453         addSeparator();
 454     }
 455 }
 456
 457 #include "moc_dolphincontextmenu.cpp"