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