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