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_generalsettings.h"
  10 #include "dolphin_contextmenusettings.h"
  11 #include "dolphinmainwindow.h"
  12 #include "dolphinnewfilemenu.h"
  13 #include "dolphinplacesmodelsingleton.h"
  14 #include "dolphinremoveaction.h"
  15 #include "dolphinviewcontainer.h"
  16 #include "panels/places/placesitem.h"
  17 #include "panels/places/placesitemmodel.h"
  18 #include "trash/dolphintrash.h"
  19 #include "views/dolphinview.h"
  20 #include "views/viewmodecontroller.h"
  21
  22 #include <KActionCollection>
  23 #include <KFileItemActions>
  24 #include <KFileItemListProperties>
  25 #include <KHamburgerMenu>
  26 #include <KIO/EmptyTrashJob>
  27 #include <KIO/JobUiDelegate>
  28 #include <KIO/Paste>
  29 #include <KIO/RestoreJob>
  30 #include <KJobWidgets>
  31 #include <KLocalizedString>
  32 #include <KNewFileMenu>
  33 #include <KPluginMetaData>
  34 #include <KStandardAction>
  35 #include <KToolBar>
  36 #include <kio_version.h>
  37
  38 #include <QApplication>
  39 #include <QClipboard>
  40 #include <QKeyEvent>
  41 #include <QMenuBar>
  42 #include <QMimeDatabase>
  43
  44 DolphinContextMenu::DolphinContextMenu(DolphinMainWindow* parent,
  45                                        const QPoint& pos,
  46                                        const KFileItem& fileInfo,
  47                                        const QUrl& baseUrl) :
  48     QMenu(parent),
  49     m_pos(pos),
  50     m_mainWindow(parent),
  51     m_fileInfo(fileInfo),
  52     m_baseUrl(baseUrl),
  53     m_baseFileItem(nullptr),
  54     m_selectedItems(),
  55     m_selectedItemsProperties(nullptr),
  56     m_context(NoContext),
  57     m_copyToMenu(parent),
  58     m_customActions(),
  59     m_command(None),
  60     m_removeAction(nullptr)
  61 {
  62     // The context menu either accesses the URLs of the selected items
  63     // or the items itself. To increase the performance both lists are cached.
  64     const DolphinView* view = m_mainWindow->activeViewContainer()->view();
  65     m_selectedItems = view->selectedItems();
  66
  67     QApplication::instance()->installEventFilter(this);
  68
  69     static_cast<KHamburgerMenu *>(m_mainWindow->actionCollection()->
  70                 action(QStringLiteral("hamburger_menu")))->addToMenu(this);
  71 }
  72
  73 DolphinContextMenu::~DolphinContextMenu()
  74 {
  75     delete m_baseFileItem;
  76     m_baseFileItem = nullptr;
  77     delete m_selectedItemsProperties;
  78     m_selectedItemsProperties = nullptr;
  79 }
  80
  81 void DolphinContextMenu::setCustomActions(const QList<QAction*>& actions)
  82 {
  83     m_customActions = actions;
  84 }
  85
  86 DolphinContextMenu::Command DolphinContextMenu::open()
  87 {
  88     // get the context information
  89     const auto scheme = m_baseUrl.scheme();
  90     if (scheme == QLatin1String("trash")) {
  91         m_context |= TrashContext;
  92     } else if (scheme.contains(QLatin1String("search"))) {
  93         m_context |= SearchContext;
  94     } else if (scheme.contains(QLatin1String("timeline"))) {
  95         m_context |= TimelineContext;
  96     }
  97
  98     if (!m_fileInfo.isNull() && !m_selectedItems.isEmpty()) {
  99         m_context |= ItemContext;
 100         // TODO: handle other use cases like devices + desktop files
 101     }
 102
 103     // open the corresponding popup for the context
 104     if (m_context & TrashContext) {
 105         if (m_context & ItemContext) {
 106             openTrashItemContextMenu();
 107         } else {
 108             openTrashContextMenu();
 109         }
 110     } else if (m_context & ItemContext) {
 111         openItemContextMenu();
 112     } else {
 113         openViewportContextMenu();
 114     }
 115
 116     return m_command;
 117 }
 118
 119 bool DolphinContextMenu::eventFilter(QObject* object, QEvent* event)
 120 {
 121     Q_UNUSED(object)
 122
 123     if(event->type() == QEvent::KeyPress || event->type() == QEvent::KeyRelease) {
 124         QKeyEvent* keyEvent = static_cast<QKeyEvent*>(event);
 125
 126         if (m_removeAction && keyEvent->key() == Qt::Key_Shift) {
 127             if (event->type() == QEvent::KeyPress) {
 128                 m_removeAction->update(DolphinRemoveAction::ShiftState::Pressed);
 129             } else {
 130                 m_removeAction->update(DolphinRemoveAction::ShiftState::Released);
 131             }
 132         }
 133     }
 134
 135     return false;
 136 }
 137
 138 void DolphinContextMenu::openTrashContextMenu()
 139 {
 140     Q_ASSERT(m_context & TrashContext);
 141
 142     QAction* emptyTrashAction = new QAction(QIcon::fromTheme(QStringLiteral("trash-empty")), i18nc("@action:inmenu", "Empty Trash"), this);
 143     emptyTrashAction->setEnabled(!Trash::isEmpty());
 144     addAction(emptyTrashAction);
 145
 146     addCustomActions();
 147
 148     QAction* propertiesAction = m_mainWindow->actionCollection()->action(QStringLiteral("properties"));
 149     addAction(propertiesAction);
 150
 151     if (exec(m_pos) == emptyTrashAction) {
 152         Trash::empty(m_mainWindow);
 153     }
 154 }
 155
 156 void DolphinContextMenu::openTrashItemContextMenu()
 157 {
 158     Q_ASSERT(m_context & TrashContext);
 159     Q_ASSERT(m_context & ItemContext);
 160
 161     QAction* restoreAction = new QAction(QIcon::fromTheme("restoration"), i18nc("@action:inmenu", "Restore"), m_mainWindow);
 162     addAction(restoreAction);
 163
 164     QAction* deleteAction = m_mainWindow->actionCollection()->action(KStandardAction::name(KStandardAction::DeleteFile));
 165     addAction(deleteAction);
 166
 167     QAction* propertiesAction = m_mainWindow->actionCollection()->action(QStringLiteral("properties"));
 168     addAction(propertiesAction);
 169
 170     if (exec(m_pos) == restoreAction) {
 171         QList<QUrl> selectedUrls;
 172         selectedUrls.reserve(m_selectedItems.count());
 173         for (const KFileItem &item : qAsConst(m_selectedItems)) {
 174             selectedUrls.append(item.url());
 175         }
 176
 177         KIO::RestoreJob *job = KIO::restoreFromTrash(selectedUrls);
 178         KJobWidgets::setWindow(job, m_mainWindow);
 179         job->uiDelegate()->setAutoErrorHandlingEnabled(true);
 180     }
 181 }
 182
 183 void DolphinContextMenu::addDirectoryItemContextMenu(KFileItemActions &fileItemActions)
 184 {
 185     // insert 'Open in new window' and 'Open in new tab' entries
 186     const KFileItemListProperties& selectedItemsProps = selectedItemsProperties();
 187     if (ContextMenuSettings::showOpenInNewTab()) {
 188         addAction(m_mainWindow->actionCollection()->action(QStringLiteral("open_in_new_tab")));
 189     }
 190     if (ContextMenuSettings::showOpenInNewWindow()) {
 191         addAction(m_mainWindow->actionCollection()->action(QStringLiteral("open_in_new_window")));
 192     }
 193
 194     // Insert 'Open With' entries
 195     addOpenWithActions(fileItemActions);
 196
 197     // set up 'Create New' menu
 198     DolphinNewFileMenu* newFileMenu = new DolphinNewFileMenu(m_mainWindow->actionCollection(), m_mainWindow);
 199     const DolphinView* view = m_mainWindow->activeViewContainer()->view();
 200     newFileMenu->setViewShowsHiddenFiles(view->hiddenFilesShown());
 201     newFileMenu->checkUpToDate();
 202     newFileMenu->setPopupFiles(QList<QUrl>() << m_fileInfo.url());
 203     newFileMenu->setEnabled(selectedItemsProps.supportsWriting());
 204     connect(newFileMenu, &DolphinNewFileMenu::fileCreated, newFileMenu, &DolphinNewFileMenu::deleteLater);
 205     connect(newFileMenu, &DolphinNewFileMenu::directoryCreated, newFileMenu, &DolphinNewFileMenu::deleteLater);
 206
 207     QMenu* menu = newFileMenu->menu();
 208     menu->setTitle(i18nc("@title:menu Create new folder, file, link, etc.", "Create New"));
 209     menu->setIcon(QIcon::fromTheme(QStringLiteral("list-add")));
 210     addMenu(menu);
 211
 212     addSeparator();
 213 }
 214
 215 void DolphinContextMenu::openItemContextMenu()
 216 {
 217     Q_ASSERT(!m_fileInfo.isNull());
 218
 219     QAction* openParentAction = nullptr;
 220     QAction* openParentInNewWindowAction = nullptr;
 221     QAction* openParentInNewTabAction = nullptr;
 222     const KFileItemListProperties& selectedItemsProps = selectedItemsProperties();
 223
 224     KFileItemActions fileItemActions;
 225     fileItemActions.setParentWidget(m_mainWindow);
 226 #if KIO_VERSION >= QT_VERSION_CHECK(5, 82, 0)
 227     connect(&fileItemActions, &KFileItemActions::error, this, [this](const QString &errorMessage) {
 228         m_mainWindow->activeViewContainer()->showMessage(errorMessage, DolphinViewContainer::Error);
 229     });
 230 #endif
 231     fileItemActions.setItemListProperties(selectedItemsProps);
 232
 233     if (m_selectedItems.count() == 1) {
 234         // single files
 235         if (m_fileInfo.isDir()) {
 236             addDirectoryItemContextMenu(fileItemActions);
 237         } else if (m_context & TimelineContext || m_context & SearchContext) {
 238             addOpenWithActions(fileItemActions);
 239
 240             openParentAction = new QAction(QIcon::fromTheme(QStringLiteral("document-open-folder")),
 241                                            i18nc("@action:inmenu",
 242                                                  "Open Path"),
 243                                            this);
 244             addAction(openParentAction);
 245
 246             openParentInNewWindowAction = new QAction(QIcon::fromTheme(QStringLiteral("window-new")),
 247                                                     i18nc("@action:inmenu",
 248                                                           "Open Path in New Window"),
 249                                                     this);
 250             addAction(openParentInNewWindowAction);
 251
 252             openParentInNewTabAction = new QAction(QIcon::fromTheme(QStringLiteral("tab-new")),
 253                                                    i18nc("@action:inmenu",
 254                                                          "Open Path in New Tab"),
 255                                                    this);
 256             addAction(openParentInNewTabAction);
 257
 258             addSeparator();
 259         } else {
 260             // Insert 'Open With" entries
 261             addOpenWithActions(fileItemActions);
 262         }
 263         if (m_fileInfo.isLink()) {
 264             addAction(m_mainWindow->actionCollection()->action(QStringLiteral("show_target")));
 265             addSeparator();
 266         }
 267     } else {
 268         // multiple files
 269         bool selectionHasOnlyDirs = true;
 270         for (const auto &item : qAsConst(m_selectedItems)) {
 271             const QUrl& url = DolphinView::openItemAsFolderUrl(item);
 272             if (url.isEmpty()) {
 273                 selectionHasOnlyDirs = false;
 274                 break;
 275             }
 276         }
 277
 278         if (selectionHasOnlyDirs && ContextMenuSettings::showOpenInNewTab()) {
 279             // insert 'Open in new tab' entry
 280             addAction(m_mainWindow->actionCollection()->action(QStringLiteral("open_in_new_tabs")));
 281         }
 282         // Insert 'Open With" entries
 283         addOpenWithActions(fileItemActions);
 284     }
 285
 286     insertDefaultItemActions(selectedItemsProps);
 287
 288     addAdditionalActions(fileItemActions, selectedItemsProps);
 289
 290     // insert 'Copy To' and 'Move To' sub menus
 291     if (ContextMenuSettings::showCopyMoveMenu()) {
 292         m_copyToMenu.setUrls(m_selectedItems.urlList());
 293         m_copyToMenu.setReadOnly(!selectedItemsProps.supportsWriting());
 294         m_copyToMenu.setAutoErrorHandlingEnabled(true);
 295         m_copyToMenu.addActionsTo(this);
 296     }
 297
 298     // insert 'Properties...' entry
 299     addSeparator();
 300     QAction* propertiesAction = m_mainWindow->actionCollection()->action(QStringLiteral("properties"));
 301     addAction(propertiesAction);
 302
 303     QAction* activatedAction = exec(m_pos);
 304     if (activatedAction) {
 305         if (activatedAction == openParentAction) {
 306             m_command = OpenParentFolder;
 307         } else if (activatedAction == openParentInNewWindowAction) {
 308             m_command = OpenParentFolderInNewWindow;
 309         } else if (activatedAction == openParentInNewTabAction) {
 310             m_command = OpenParentFolderInNewTab;
 311         }
 312     }
 313 }
 314
 315 void DolphinContextMenu::openViewportContextMenu()
 316 {
 317     const DolphinView* view = m_mainWindow->activeViewContainer()->view();
 318
 319     const KFileItemListProperties baseUrlProperties(KFileItemList() << baseFileItem());
 320     KFileItemActions fileItemActions;
 321     fileItemActions.setParentWidget(m_mainWindow);
 322 #if KIO_VERSION >= QT_VERSION_CHECK(5, 82, 0)
 323     connect(&fileItemActions, &KFileItemActions::error, this, [this](const QString &errorMessage) {
 324         m_mainWindow->activeViewContainer()->showMessage(errorMessage, DolphinViewContainer::Error);
 325     });
 326 #endif
 327     fileItemActions.setItemListProperties(baseUrlProperties);
 328
 329     // Set up and insert 'Create New' menu
 330     KNewFileMenu* newFileMenu = m_mainWindow->newFileMenu();
 331     newFileMenu->setViewShowsHiddenFiles(view->hiddenFilesShown());
 332     newFileMenu->checkUpToDate();
 333     newFileMenu->setPopupFiles(QList<QUrl>() << m_baseUrl);
 334     addMenu(newFileMenu->menu());
 335
 336     // Show "open with" menu items even if the dir is empty, because there are legitimate
 337     // use cases for this, such as opening an empty dir in Kate or VSCode or something
 338     addOpenWithActions(fileItemActions);
 339
 340     QAction* pasteAction = createPasteAction();
 341     if (pasteAction) {
 342         addAction(pasteAction);
 343     }
 344
 345     // Insert 'Add to Places' entry if it's not already in the places panel
 346     if (ContextMenuSettings::showAddToPlaces() &&
 347             !placeExists(m_mainWindow->activeViewContainer()->url())) {
 348         addAction(m_mainWindow->actionCollection()->action(QStringLiteral("add_to_places")));
 349     }
 350     addSeparator();
 351
 352     // Insert 'Sort By' and 'View Mode'
 353     if (ContextMenuSettings::showSortBy()) {
 354         addAction(m_mainWindow->actionCollection()->action(QStringLiteral("sort")));
 355     }
 356     if (ContextMenuSettings::showViewMode()) {
 357         addAction(m_mainWindow->actionCollection()->action(QStringLiteral("view_mode")));
 358     }
 359     if (ContextMenuSettings::showSortBy() || ContextMenuSettings::showViewMode()) {
 360         addSeparator();
 361     }
 362
 363     addAdditionalActions(fileItemActions, baseUrlProperties);
 364     addCustomActions();
 365
 366     addSeparator();
 367
 368     QAction* propertiesAction = m_mainWindow->actionCollection()->action(QStringLiteral("properties"));
 369     addAction(propertiesAction);
 370
 371     exec(m_pos);
 372 }
 373
 374 void DolphinContextMenu::insertDefaultItemActions(const KFileItemListProperties& properties)
 375 {
 376     const KActionCollection* collection = m_mainWindow->actionCollection();
 377
 378     // Insert 'Cut', 'Copy', 'Copy Location' and 'Paste'
 379     addAction(collection->action(KStandardAction::name(KStandardAction::Cut)));
 380     addAction(collection->action(KStandardAction::name(KStandardAction::Copy)));
 381     if (ContextMenuSettings::showCopyLocation()) {
 382         QAction* copyPathAction = collection->action(QString("copy_location"));
 383         copyPathAction->setEnabled(m_selectedItems.size() == 1);
 384         addAction(copyPathAction);
 385     }
 386     QAction* pasteAction = createPasteAction();
 387     if (pasteAction) {
 388         addAction(pasteAction);
 389     }
 390
 391     // Insert 'Duplicate Here'
 392     if (ContextMenuSettings::showDuplicateHere()) {
 393         addAction(m_mainWindow->actionCollection()->action(QStringLiteral("duplicate")));
 394     }
 395
 396     // Insert 'Rename'
 397     addAction(collection->action(KStandardAction::name(KStandardAction::RenameFile)));
 398
 399     // Insert 'Add to Places' entry if appropriate
 400     if (ContextMenuSettings::showAddToPlaces() &&
 401             m_selectedItems.count() == 1 &&
 402             m_fileInfo.isDir() &&
 403             !placeExists(m_fileInfo.url())) {
 404         addAction(m_mainWindow->actionCollection()->action(QStringLiteral("add_to_places")));
 405     }
 406
 407     addSeparator();
 408
 409     // Insert 'Move to Trash' and/or 'Delete'
 410     const bool showDeleteAction = (KSharedConfig::openConfig()->group("KDE").readEntry("ShowDeleteCommand", false) ||
 411                                     !properties.isLocal());
 412     const bool showMoveToTrashAction = (properties.isLocal() &&
 413                                         properties.supportsMoving());
 414
 415     if (showDeleteAction && showMoveToTrashAction) {
 416         delete m_removeAction;
 417         m_removeAction = nullptr;
 418         addAction(m_mainWindow->actionCollection()->action(KStandardAction::name(KStandardAction::MoveToTrash)));
 419         addAction(m_mainWindow->actionCollection()->action(KStandardAction::name(KStandardAction::DeleteFile)));
 420     } else if (showDeleteAction && !showMoveToTrashAction) {
 421         addAction(m_mainWindow->actionCollection()->action(KStandardAction::name(KStandardAction::DeleteFile)));
 422     } else {
 423         if (!m_removeAction) {
 424             m_removeAction = new DolphinRemoveAction(this, m_mainWindow->actionCollection());
 425         }
 426         addAction(m_removeAction);
 427         m_removeAction->update();
 428     }
 429 }
 430
 431 bool DolphinContextMenu::placeExists(const QUrl& url) const
 432 {
 433     const KFilePlacesModel* placesModel = DolphinPlacesModelSingleton::instance().placesModel();
 434
 435     const auto& matchedPlaces = placesModel->match(placesModel->index(0,0), KFilePlacesModel::UrlRole, url, 1, Qt::MatchExactly);
 436
 437     return !matchedPlaces.isEmpty();
 438 }
 439
 440 QAction* DolphinContextMenu::createPasteAction()
 441 {
 442     QAction* action = nullptr;
 443     KFileItem destItem;
 444     if (!m_fileInfo.isNull() && m_selectedItems.count() <= 1) {
 445         destItem = m_fileInfo;
 446     } else {
 447         destItem = baseFileItem();
 448     }
 449
 450     if (!destItem.isNull() && destItem.isDir()) {
 451         const QMimeData *mimeData = QApplication::clipboard()->mimeData();
 452         bool canPaste;
 453         const QString text = KIO::pasteActionText(mimeData, &canPaste, destItem);
 454         if (canPaste) {
 455             if (destItem == m_fileInfo) {
 456                 // if paste destination is a selected folder
 457                 action = new QAction(QIcon::fromTheme(QStringLiteral("edit-paste")), text, this);
 458                 connect(action, &QAction::triggered, m_mainWindow, &DolphinMainWindow::pasteIntoFolder);
 459             } else {
 460                 action = m_mainWindow->actionCollection()->action(KStandardAction::name(KStandardAction::Paste));
 461             }
 462         }
 463     }
 464
 465     return action;
 466 }
 467
 468 KFileItemListProperties& DolphinContextMenu::selectedItemsProperties() const
 469 {
 470     if (!m_selectedItemsProperties) {
 471         m_selectedItemsProperties = new KFileItemListProperties(m_selectedItems);
 472     }
 473     return *m_selectedItemsProperties;
 474 }
 475
 476 KFileItem DolphinContextMenu::baseFileItem()
 477 {
 478     if (!m_baseFileItem) {
 479         const DolphinView* view = m_mainWindow->activeViewContainer()->view();
 480         KFileItem baseItem = view->rootItem();
 481         if (baseItem.isNull() || baseItem.url() != m_baseUrl) {
 482             m_baseFileItem = new KFileItem(m_baseUrl);
 483         } else {
 484             m_baseFileItem = new KFileItem(baseItem);
 485         }
 486     }
 487     return *m_baseFileItem;
 488 }
 489
 490 void DolphinContextMenu::addOpenWithActions(KFileItemActions& fileItemActions)
 491 {
 492     // insert 'Open With...' action or sub menu
 493     fileItemActions.addOpenWithActionsTo(this, QStringLiteral("DesktopEntryName != '%1'").arg(qApp->desktopFileName()));
 494 }
 495
 496 void DolphinContextMenu::addCustomActions()
 497 {
 498     addActions(m_customActions);
 499 }
 500
 501 void DolphinContextMenu::addAdditionalActions(KFileItemActions &fileItemActions, const KFileItemListProperties &props)
 502 {
 503     addSeparator();
 504
 505     QList<QAction *> additionalActions;
 506     if (props.isDirectory() && props.isLocal() && ContextMenuSettings::showOpenTerminal()) {
 507         additionalActions << m_mainWindow->actionCollection()->action(QStringLiteral("open_terminal"));
 508     }
 509     fileItemActions.addActionsTo(this, KFileItemActions::MenuActionSource::All, additionalActions);
 510
 511     const DolphinView* view = m_mainWindow->activeViewContainer()->view();
 512     const QList<QAction*> versionControlActions = view->versionControlActions(m_selectedItems);
 513     if (!versionControlActions.isEmpty()) {
 514         addActions(versionControlActions);
 515         addSeparator();
 516     }
 517 }
 518