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_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(i18nc("@action:inmenu", "Restore"), m_mainWindow);
 166     restoreAction->setShortcut(Qt::CTRL + Qt::Key_R);
 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     addOpenWithActions(fileItemActions);
 356
 357     // Insert 'New Window' and 'New Tab' entries. Don't use "open_in_new_window" and
 358     // "open_in_new_tab" here, as the current selection should get ignored.
 359     addAction(m_mainWindow->actionCollection()->action(QStringLiteral("file_new")));
 360     addAction(m_mainWindow->actionCollection()->action(QStringLiteral("new_tab")));
 361
 362     // Insert 'Add to Places' entry if exactly one item is selected
 363     QAction* addToPlacesAction = nullptr;
 364     if (!placeExists(m_mainWindow->activeViewContainer()->url())) {
 365         addToPlacesAction = addAction(QIcon::fromTheme(QStringLiteral("bookmark-new")),
 366                                              i18nc("@action:inmenu Add current folder to places", "Add to Places"));
 367     }
 368
 369     addSeparator();
 370
 371     QAction* pasteAction = createPasteAction();
 372     addAction(pasteAction);
 373     addSeparator();
 374
 375     // Insert 'Sort By' and 'View Mode'
 376     addAction(m_mainWindow->actionCollection()->action(QStringLiteral("sort")));
 377     addAction(m_mainWindow->actionCollection()->action(QStringLiteral("view_mode")));
 378
 379     addSeparator();
 380
 381     // Insert service actions
 382     fileItemActions.addServiceActionsTo(this);
 383     fileItemActions.addPluginActionsTo(this);
 384
 385     addVersionControlPluginActions();
 386
 387     addCustomActions();
 388
 389     QAction* propertiesAction = m_mainWindow->actionCollection()->action(QStringLiteral("properties"));
 390     addAction(propertiesAction);
 391
 392     addShowMenuBarAction();
 393
 394     QAction* action = exec(m_pos);
 395     if (addToPlacesAction && (action == addToPlacesAction)) {
 396         const DolphinViewContainer* container =  m_mainWindow->activeViewContainer();
 397         const QUrl url = container->url();
 398         if (url.isValid()) {
 399             PlacesItemModel model;
 400             QString icon;
 401             if (container->isSearchModeEnabled()) {
 402                 icon = QStringLiteral("folder-saved-search-symbolic");
 403             } else {
 404                 icon = KIO::iconNameForUrl(url);
 405             }
 406             model.createPlacesItem(container->placesText(), url, icon);
 407         }
 408     }
 409 }
 410
 411 void DolphinContextMenu::insertDefaultItemActions(const KFileItemListProperties& properties)
 412 {
 413     const KActionCollection* collection = m_mainWindow->actionCollection();
 414
 415     // Insert 'Cut', 'Copy' and 'Paste'
 416     addAction(collection->action(KStandardAction::name(KStandardAction::Cut)));
 417     addAction(collection->action(KStandardAction::name(KStandardAction::Copy)));
 418     addAction(createPasteAction());
 419
 420     addSeparator();
 421
 422     // Insert 'Rename'
 423     addAction(collection->action(KStandardAction::name(KStandardAction::RenameFile)));
 424
 425     // Insert 'Move to Trash' and/or 'Delete'
 426     const bool showDeleteAction = (KSharedConfig::openConfig()->group("KDE").readEntry("ShowDeleteCommand", false) ||
 427                                     !properties.isLocal());
 428     const bool showMoveToTrashAction = (properties.isLocal() &&
 429                                         properties.supportsMoving());
 430
 431     if (showDeleteAction && showMoveToTrashAction) {
 432         delete m_removeAction;
 433         m_removeAction = nullptr;
 434         addAction(m_mainWindow->actionCollection()->action(KStandardAction::name(KStandardAction::MoveToTrash)));
 435         addAction(m_mainWindow->actionCollection()->action(KStandardAction::name(KStandardAction::DeleteFile)));
 436     } else if (showDeleteAction && !showMoveToTrashAction) {
 437         addAction(m_mainWindow->actionCollection()->action(KStandardAction::name(KStandardAction::DeleteFile)));
 438     } else {
 439         if (!m_removeAction) {
 440             m_removeAction = new DolphinRemoveAction(this, m_mainWindow->actionCollection());
 441         }
 442         addAction(m_removeAction);
 443         m_removeAction->update();
 444     }
 445 }
 446
 447 void DolphinContextMenu::addShowMenuBarAction()
 448 {
 449     const KActionCollection* ac = m_mainWindow->actionCollection();
 450     QAction* showMenuBar = ac->action(KStandardAction::name(KStandardAction::ShowMenubar));
 451     if (!m_mainWindow->menuBar()->isVisible() && !m_mainWindow->toolBar()->isVisible()) {
 452         addSeparator();
 453         addAction(showMenuBar);
 454     }
 455 }
 456
 457 bool DolphinContextMenu::placeExists(const QUrl& url) const
 458 {
 459     Q_UNUSED(url)
 460     // Creating up a PlacesItemModel to find out if 'url' is one of the Places
 461     // can be expensive because the model asks Solid for the devices which are
 462     // available, which can take some time.
 463     // TODO: Consider restoring this check if the handling of Places and devices
 464     // will be decoupled in the future.
 465     return false;
 466 }
 467
 468 QAction* DolphinContextMenu::createPasteAction()
 469 {
 470     QAction* action = nullptr;
 471     const bool isDir = !m_fileInfo.isNull() && m_fileInfo.isDir();
 472     if (isDir && (m_selectedItems.count() == 1)) {
 473         const QMimeData *mimeData = QApplication::clipboard()->mimeData();
 474         bool canPaste;
 475         const QString text = KIO::pasteActionText(mimeData, &canPaste, m_fileInfo);
 476         action = new QAction(QIcon::fromTheme(QStringLiteral("edit-paste")), text, this);
 477         action->setEnabled(canPaste);
 478         connect(action, &QAction::triggered, m_mainWindow, &DolphinMainWindow::pasteIntoFolder);
 479     } else {
 480         action = m_mainWindow->actionCollection()->action(KStandardAction::name(KStandardAction::Paste));
 481     }
 482
 483     return action;
 484 }
 485
 486 KFileItemListProperties& DolphinContextMenu::selectedItemsProperties() const
 487 {
 488     if (!m_selectedItemsProperties) {
 489         m_selectedItemsProperties = new KFileItemListProperties(m_selectedItems);
 490     }
 491     return *m_selectedItemsProperties;
 492 }
 493
 494 KFileItem DolphinContextMenu::baseFileItem()
 495 {
 496     if (!m_baseFileItem) {
 497         m_baseFileItem = new KFileItem(m_baseUrl);
 498     }
 499     return *m_baseFileItem;
 500 }
 501
 502 void DolphinContextMenu::addOpenWithActions(KFileItemActions& fileItemActions)
 503 {
 504     // insert 'Open With...' action or sub menu
 505     fileItemActions.addOpenWithActionsTo(this, QStringLiteral("DesktopEntryName != '%1'").arg(qApp->desktopFileName()));
 506 }
 507
 508 void DolphinContextMenu::addVersionControlPluginActions()
 509 {
 510     const DolphinView* view = m_mainWindow->activeViewContainer()->view();
 511     const QList<QAction*> versionControlActions = view->versionControlActions(m_selectedItems);
 512     if (!versionControlActions.isEmpty()) {
 513         addActions(versionControlActions);
 514         addSeparator();
 515     }
 516 }
 517
 518 void DolphinContextMenu::addCustomActions()
 519 {
 520     addActions(m_customActions);
 521 }
 522