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 <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_baseFileItem;
  85     m_baseFileItem = nullptr;
  86     delete m_selectedItemsProperties;
  87     m_selectedItemsProperties = nullptr;
  88 }
  89
  90 void DolphinContextMenu::setCustomActions(const QList<QAction*>& actions)
  91 {
  92     m_customActions = actions;
  93 }
  94
  95 DolphinContextMenu::Command DolphinContextMenu::open()
  96 {
  97     // get the context information
  98     if (m_baseUrl.scheme() == QLatin1String("trash")) {
  99         m_context |= TrashContext;
 100     }
 101
 102     if (!m_fileInfo.isNull() && !m_selectedItems.isEmpty()) {
 103         m_context |= ItemContext;
 104         // TODO: handle other use cases like devices + desktop files
 105     }
 106
 107     // open the corresponding popup for the context
 108     if (m_context & TrashContext) {
 109         if (m_context & ItemContext) {
 110             openTrashItemContextMenu();
 111         } else {
 112             openTrashContextMenu();
 113         }
 114     } else if (m_context & ItemContext) {
 115         openItemContextMenu();
 116     } else {
 117         Q_ASSERT(m_context == NoContext);
 118         openViewportContextMenu();
 119     }
 120
 121     return m_command;
 122 }
 123
 124 void DolphinContextMenu::keyPressEvent(QKeyEvent *ev)
 125 {
 126     if (m_removeAction && ev->key() == Qt::Key_Shift) {
 127         m_removeAction->update(DolphinRemoveAction::ShiftState::Pressed);
 128     }
 129     QMenu::keyPressEvent(ev);
 130 }
 131
 132 void DolphinContextMenu::keyReleaseEvent(QKeyEvent *ev)
 133 {
 134     if (m_removeAction && ev->key() == Qt::Key_Shift) {
 135         m_removeAction->update(DolphinRemoveAction::ShiftState::Released);
 136     }
 137     QMenu::keyReleaseEvent(ev);
 138 }
 139
 140 void DolphinContextMenu::openTrashContextMenu()
 141 {
 142     Q_ASSERT(m_context & TrashContext);
 143
 144     QAction* emptyTrashAction = new QAction(QIcon::fromTheme(QStringLiteral("trash-empty")), i18nc("@action:inmenu", "Empty Trash"), this);
 145     emptyTrashAction->setEnabled(!Trash::isEmpty());
 146     addAction(emptyTrashAction);
 147
 148     addCustomActions();
 149
 150     QAction* propertiesAction = m_mainWindow->actionCollection()->action(QStringLiteral("properties"));
 151     addAction(propertiesAction);
 152
 153     addShowMenuBarAction();
 154
 155     if (exec(m_pos) == emptyTrashAction) {
 156         Trash::empty(m_mainWindow);
 157     }
 158 }
 159
 160 void DolphinContextMenu::openTrashItemContextMenu()
 161 {
 162     Q_ASSERT(m_context & TrashContext);
 163     Q_ASSERT(m_context & ItemContext);
 164
 165     QAction* restoreAction = new QAction(QIcon::fromTheme("restoration"), i18nc("@action:inmenu", "Restore"), m_mainWindow);
 166     addAction(restoreAction);
 167
 168     QAction* deleteAction = m_mainWindow->actionCollection()->action(KStandardAction::name(KStandardAction::DeleteFile));
 169     addAction(deleteAction);
 170
 171     QAction* propertiesAction = m_mainWindow->actionCollection()->action(QStringLiteral("properties"));
 172     addAction(propertiesAction);
 173
 174     if (exec(m_pos) == restoreAction) {
 175         QList<QUrl> selectedUrls;
 176         selectedUrls.reserve(m_selectedItems.count());
 177         foreach (const KFileItem &item, m_selectedItems) {
 178             selectedUrls.append(item.url());
 179         }
 180
 181         KIO::RestoreJob *job = KIO::restoreFromTrash(selectedUrls);
 182         KJobWidgets::setWindow(job, m_mainWindow);
 183         job->uiDelegate()->setAutoErrorHandlingEnabled(true);
 184     }
 185 }
 186
 187 void DolphinContextMenu::openItemContextMenu()
 188 {
 189     Q_ASSERT(!m_fileInfo.isNull());
 190
 191     QAction* openParentAction = nullptr;
 192     QAction* openParentInNewWindowAction = nullptr;
 193     QAction* openParentInNewTabAction = nullptr;
 194     const KFileItemListProperties& selectedItemsProps = selectedItemsProperties();
 195
 196     KFileItemActions fileItemActions;
 197     fileItemActions.setParentWidget(m_mainWindow);
 198     fileItemActions.setItemListProperties(selectedItemsProps);
 199
 200     if (m_selectedItems.count() == 1) {
 201         if (m_fileInfo.isDir()) {
 202             // insert 'Open in new window' and 'Open in new tab' entries
 203             addAction(m_mainWindow->actionCollection()->action(QStringLiteral("open_in_new_window")));
 204             addAction(m_mainWindow->actionCollection()->action(QStringLiteral("open_in_new_tab")));
 205
 206             // Insert 'Open With' entries
 207             addOpenWithActions(fileItemActions);
 208
 209             // set up 'Create New' menu
 210              DolphinNewFileMenu* newFileMenu = new DolphinNewFileMenu(m_mainWindow->actionCollection(), m_mainWindow);
 211              const DolphinView* view = m_mainWindow->activeViewContainer()->view();
 212              newFileMenu->setViewShowsHiddenFiles(view->hiddenFilesShown());
 213              newFileMenu->checkUpToDate();
 214              newFileMenu->setPopupFiles(m_fileInfo.url());
 215              newFileMenu->setEnabled(selectedItemsProps.supportsWriting());
 216              connect(newFileMenu, &DolphinNewFileMenu::fileCreated, newFileMenu, &DolphinNewFileMenu::deleteLater);
 217              connect(newFileMenu, &DolphinNewFileMenu::directoryCreated, newFileMenu, &DolphinNewFileMenu::deleteLater);
 218
 219              QMenu* menu = newFileMenu->menu();
 220              menu->setTitle(i18nc("@title:menu Create new folder, file, link, etc.", "Create New"));
 221              menu->setIcon(QIcon::fromTheme(QStringLiteral("document-new")));
 222              addMenu(menu);
 223
 224              addSeparator();
 225         } else if (m_baseUrl.scheme().contains(QLatin1String("search")) || m_baseUrl.scheme().contains(QLatin1String("timeline"))) {
 226             addOpenWithActions(fileItemActions);
 227
 228             openParentAction = new QAction(QIcon::fromTheme(QStringLiteral("document-open-folder")),
 229                                            i18nc("@action:inmenu",
 230                                                  "Open Path"),
 231                                            this);
 232             addAction(openParentAction);
 233
 234             openParentInNewWindowAction = new QAction(QIcon::fromTheme(QStringLiteral("window-new")),
 235                                                     i18nc("@action:inmenu",
 236                                                           "Open Path in New Window"),
 237                                                     this);
 238             addAction(openParentInNewWindowAction);
 239
 240             openParentInNewTabAction = new QAction(QIcon::fromTheme(QStringLiteral("tab-new")),
 241                                                    i18nc("@action:inmenu",
 242                                                          "Open Path in New Tab"),
 243                                                    this);
 244             addAction(openParentInNewTabAction);
 245
 246             addSeparator();
 247         } else {
 248             // Insert 'Open With" entries
 249             addOpenWithActions(fileItemActions);
 250         }
 251         if (m_fileInfo.isLink()) {
 252             addAction(m_mainWindow->actionCollection()->action(QStringLiteral("show_target")));
 253             addSeparator();
 254         }
 255     } else {
 256         bool selectionHasOnlyDirs = true;
 257         foreach (const KFileItem& item, 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     // Don't show "Open With" menu items if the current dir is empty, because there's
 332     // generally no app that can do anything interesting with an empty directory
 333     if (view->itemsCount() != 0) {
 334         addOpenWithActions(fileItemActions);
 335     }
 336
 337     // Set up and insert 'Create New' menu
 338     KNewFileMenu* newFileMenu = m_mainWindow->newFileMenu();
 339     newFileMenu->setViewShowsHiddenFiles(view->hiddenFilesShown());
 340     newFileMenu->checkUpToDate();
 341     newFileMenu->setPopupFiles(m_baseUrl);
 342     addMenu(newFileMenu->menu());
 343
 344     QAction* pasteAction = createPasteAction();
 345     addAction(pasteAction);
 346
 347     // Insert 'Add to Places' entry if it's not already in the places panel
 348     if (!placeExists(m_mainWindow->activeViewContainer()->url())) {
 349         addAction(m_mainWindow->actionCollection()->action(QStringLiteral("add_to_places")));
 350     }
 351     addSeparator();
 352
 353     // Insert 'Sort By' and 'View Mode'
 354     addAction(m_mainWindow->actionCollection()->action(QStringLiteral("sort")));
 355     addAction(m_mainWindow->actionCollection()->action(QStringLiteral("view_mode")));
 356
 357     addSeparator();
 358
 359     // Insert service actions
 360     fileItemActions.addServiceActionsTo(this);
 361     fileItemActions.addPluginActionsTo(this);
 362
 363     addVersionControlPluginActions();
 364
 365     addCustomActions();
 366
 367     addSeparator();
 368
 369     QAction* propertiesAction = m_mainWindow->actionCollection()->action(QStringLiteral("properties"));
 370     addAction(propertiesAction);
 371
 372     addShowMenuBarAction();
 373
 374     exec(m_pos);
 375 }
 376
 377 void DolphinContextMenu::insertDefaultItemActions(const KFileItemListProperties& properties)
 378 {
 379     const KActionCollection* collection = m_mainWindow->actionCollection();
 380
 381     // Insert 'Cut', 'Copy' and 'Paste'
 382     addAction(collection->action(KStandardAction::name(KStandardAction::Cut)));
 383     addAction(collection->action(KStandardAction::name(KStandardAction::Copy)));
 384     addAction(createPasteAction());
 385
 386     addSeparator();
 387
 388     // Insert 'Rename'
 389     addAction(collection->action(KStandardAction::name(KStandardAction::RenameFile)));
 390
 391     // Insert 'Move to Trash' and/or 'Delete'
 392     const bool showDeleteAction = (KSharedConfig::openConfig()->group("KDE").readEntry("ShowDeleteCommand", false) ||
 393                                     !properties.isLocal());
 394     const bool showMoveToTrashAction = (properties.isLocal() &&
 395                                         properties.supportsMoving());
 396
 397     if (showDeleteAction && showMoveToTrashAction) {
 398         delete m_removeAction;
 399         m_removeAction = nullptr;
 400         addAction(m_mainWindow->actionCollection()->action(KStandardAction::name(KStandardAction::MoveToTrash)));
 401         addAction(m_mainWindow->actionCollection()->action(KStandardAction::name(KStandardAction::DeleteFile)));
 402     } else if (showDeleteAction && !showMoveToTrashAction) {
 403         addAction(m_mainWindow->actionCollection()->action(KStandardAction::name(KStandardAction::DeleteFile)));
 404     } else {
 405         if (!m_removeAction) {
 406             m_removeAction = new DolphinRemoveAction(this, m_mainWindow->actionCollection());
 407         }
 408         addAction(m_removeAction);
 409         m_removeAction->update();
 410     }
 411 }
 412
 413 void DolphinContextMenu::addShowMenuBarAction()
 414 {
 415     const KActionCollection* ac = m_mainWindow->actionCollection();
 416     QAction* showMenuBar = ac->action(KStandardAction::name(KStandardAction::ShowMenubar));
 417     if (!m_mainWindow->menuBar()->isVisible() && !m_mainWindow->toolBar()->isVisible()) {
 418         addSeparator();
 419         addAction(showMenuBar);
 420     }
 421 }
 422
 423 bool DolphinContextMenu::placeExists(const QUrl& url) const
 424 {
 425     const KFilePlacesModel* placesModel = DolphinPlacesModelSingleton::instance().placesModel();
 426
 427     const auto& matchedPlaces = placesModel->match(placesModel->index(0,0), KFilePlacesModel::UrlRole, url, 1, Qt::MatchExactly);
 428
 429     return !matchedPlaces.isEmpty();
 430 }
 431
 432 QAction* DolphinContextMenu::createPasteAction()
 433 {
 434     QAction* action = nullptr;
 435     const bool isDir = !m_fileInfo.isNull() && m_fileInfo.isDir();
 436     if (isDir && (m_selectedItems.count() == 1)) {
 437         const QMimeData *mimeData = QApplication::clipboard()->mimeData();
 438         bool canPaste;
 439         const QString text = KIO::pasteActionText(mimeData, &canPaste, m_fileInfo);
 440         action = new QAction(QIcon::fromTheme(QStringLiteral("edit-paste")), text, this);
 441         action->setEnabled(canPaste);
 442         connect(action, &QAction::triggered, m_mainWindow, &DolphinMainWindow::pasteIntoFolder);
 443     } else {
 444         action = m_mainWindow->actionCollection()->action(KStandardAction::name(KStandardAction::Paste));
 445     }
 446
 447     return action;
 448 }
 449
 450 KFileItemListProperties& DolphinContextMenu::selectedItemsProperties() const
 451 {
 452     if (!m_selectedItemsProperties) {
 453         m_selectedItemsProperties = new KFileItemListProperties(m_selectedItems);
 454     }
 455     return *m_selectedItemsProperties;
 456 }
 457
 458 KFileItem DolphinContextMenu::baseFileItem()
 459 {
 460     if (!m_baseFileItem) {
 461         m_baseFileItem = new KFileItem(m_baseUrl);
 462     }
 463     return *m_baseFileItem;
 464 }
 465
 466 void DolphinContextMenu::addOpenWithActions(KFileItemActions& fileItemActions)
 467 {
 468     // insert 'Open With...' action or sub menu
 469     fileItemActions.addOpenWithActionsTo(this, QStringLiteral("DesktopEntryName != '%1'").arg(qApp->desktopFileName()));
 470 }
 471
 472 void DolphinContextMenu::addVersionControlPluginActions()
 473 {
 474     const DolphinView* view = m_mainWindow->activeViewContainer()->view();
 475     const QList<QAction*> versionControlActions = view->versionControlActions(m_selectedItems);
 476     if (!versionControlActions.isEmpty()) {
 477         addActions(versionControlActions);
 478         addSeparator();
 479     }
 480 }
 481
 482 void DolphinContextMenu::addCustomActions()
 483 {
 484     addActions(m_customActions);
 485 }
 486