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