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