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