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