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