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