src/dolphincontextmenu.cpp

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