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