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