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 "dolphinmainwindow.h"
  24 #include "dolphinnewfilemenu.h"
  25 #include "settings/dolphinsettings.h"
  26 #include "dolphinviewcontainer.h"
  27 #include "dolphin_generalsettings.h"
  28
  29 #include <KActionCollection>
  30 #include <KDesktopFile>
  31 #include <kfileitemactionplugin.h>
  32 #include <kabstractfileitemactionplugin.h>
  33 #include <KFileItemActions>
  34 #include <KFileItemListProperties>
  35 #include <KFilePlacesModel>
  36 #include <KGlobal>
  37 #include <KIconLoader>
  38 #include <KIO/NetAccess>
  39 #include <KMenu>
  40 #include <KMenuBar>
  41 #include <KMessageBox>
  42 #include <KMimeTypeTrader>
  43 #include <KModifierKeyInfo>
  44 #include <KNewFileMenu>
  45 #include <konqmimedata.h>
  46 #include <konq_operations.h>
  47 #include <KService>
  48 #include <KLocale>
  49 #include <KPropertiesDialog>
  50 #include <KStandardAction>
  51 #include <KStandardDirs>
  52 #include <KToolBar>
  53
  54 #include <QApplication>
  55 #include <QClipboard>
  56 #include <QDir>
  57
  58 #include "views/dolphinview.h"
  59 #include "views/viewmodecontroller.h"
  60
  61 K_GLOBAL_STATIC(KModifierKeyInfo, m_keyInfo)
  62
  63 DolphinContextMenu::DolphinContextMenu(DolphinMainWindow* parent,
  64                                        const KFileItem& fileInfo,
  65                                        const KUrl& baseUrl) :
  66     m_mainWindow(parent),
  67     m_fileInfo(fileInfo),
  68     m_baseUrl(baseUrl),
  69     m_baseFileItem(0),
  70     m_selectedItems(),
  71     m_selectedItemsProperties(0),
  72     m_context(NoContext),
  73     m_copyToMenu(parent),
  74     m_customActions(),
  75     m_popup(0),
  76     m_command(None),
  77     m_shiftPressed(false),
  78     m_removeAction(0)
  79 {
  80     // The context menu either accesses the URLs of the selected items
  81     // or the items itself. To increase the performance both lists are cached.
  82     const DolphinView* view = m_mainWindow->activeViewContainer()->view();
  83     m_selectedItems = view->selectedItems();
  84
  85     if (m_keyInfo) {
  86         if (m_keyInfo->isKeyPressed(Qt::Key_Shift) || m_keyInfo->isKeyLatched(Qt::Key_Shift)) {
  87             m_shiftPressed = true;
  88         }
  89         connect(m_keyInfo, SIGNAL(keyPressed(Qt::Key, bool)),
  90                 this, SLOT(slotKeyModifierPressed(Qt::Key, bool)));
  91     }
  92
  93     m_removeAction = new QAction(this);
  94     connect(m_removeAction, SIGNAL(triggered()), this, SLOT(slotRemoveActionTriggered()));
  95
  96     m_popup = new KMenu(m_mainWindow);
  97 }
  98
  99 DolphinContextMenu::~DolphinContextMenu()
 100 {
 101     delete m_selectedItemsProperties;
 102     m_selectedItemsProperties = 0;
 103
 104     delete m_popup;
 105     m_popup = 0;
 106 }
 107
 108 void DolphinContextMenu::setCustomActions(const QList<QAction*>& actions)
 109 {
 110     m_customActions = actions;
 111 }
 112
 113 DolphinContextMenu::Command DolphinContextMenu::open()
 114 {
 115     // get the context information
 116     if (m_baseUrl.protocol() == QLatin1String("trash")) {
 117         m_context |= TrashContext;
 118     }
 119
 120     if (!m_fileInfo.isNull() && !m_selectedItems.isEmpty()) {
 121         m_context |= ItemContext;
 122         // TODO: handle other use cases like devices + desktop files
 123     }
 124
 125     // open the corresponding popup for the context
 126     if (m_context & TrashContext) {
 127         if (m_context & ItemContext) {
 128             openTrashItemContextMenu();
 129         } else {
 130             openTrashContextMenu();
 131         }
 132     } else if (m_context & ItemContext) {
 133         openItemContextMenu();
 134     } else {
 135         Q_ASSERT(m_context == NoContext);
 136         openViewportContextMenu();
 137     }
 138
 139     return m_command;
 140 }
 141
 142 void DolphinContextMenu::initializeModifierKeyInfo()
 143 {
 144     // Access m_keyInfo, so that it gets instantiated by
 145     // K_GLOBAL_STATIC
 146     KModifierKeyInfo* keyInfo = m_keyInfo;
 147     Q_UNUSED(keyInfo);
 148 }
 149
 150 void DolphinContextMenu::slotKeyModifierPressed(Qt::Key key, bool pressed)
 151 {
 152     m_shiftPressed = (key == Qt::Key_Shift) && pressed;
 153     updateRemoveAction();
 154 }
 155
 156 void DolphinContextMenu::slotRemoveActionTriggered()
 157 {
 158     const KActionCollection* collection = m_mainWindow->actionCollection();
 159     if (m_shiftPressed) {
 160         collection->action("delete")->trigger();
 161     } else {
 162         collection->action("move_to_trash")->trigger();
 163     }
 164 }
 165
 166 void DolphinContextMenu::openTrashContextMenu()
 167 {
 168     Q_ASSERT(m_context & TrashContext);
 169
 170     QAction* emptyTrashAction = new QAction(KIcon("trash-empty"), i18nc("@action:inmenu", "Empty Trash"), m_popup);
 171     KConfig trashConfig("trashrc", KConfig::SimpleConfig);
 172     emptyTrashAction->setEnabled(!trashConfig.group("Status").readEntry("Empty", true));
 173     m_popup->addAction(emptyTrashAction);
 174
 175     QAction* addToPlacesAction = m_popup->addAction(KIcon("bookmark-new"),
 176                                                   i18nc("@action:inmenu Add current folder to places", "Add to Places"));
 177
 178     // Don't show if url is already in places
 179     if (placeExists(m_mainWindow->activeViewContainer()->url())) {
 180         addToPlacesAction->setVisible(false);
 181     }
 182
 183     addCustomActions();
 184
 185     QAction* propertiesAction = m_mainWindow->actionCollection()->action("properties");
 186     m_popup->addAction(propertiesAction);
 187
 188     addShowMenuBarAction();
 189
 190     QAction *action = m_popup->exec(QCursor::pos());
 191     if (action == emptyTrashAction) {
 192         KonqOperations::emptyTrash(m_mainWindow);
 193     } else if (action == addToPlacesAction) {
 194         const KUrl& url = m_mainWindow->activeViewContainer()->url();
 195         if (url.isValid()) {
 196             DolphinSettings::instance().placesModel()->addPlace(i18nc("@label", "Trash"), url);
 197         }
 198     }
 199 }
 200
 201 void DolphinContextMenu::openTrashItemContextMenu()
 202 {
 203     Q_ASSERT(m_context & TrashContext);
 204     Q_ASSERT(m_context & ItemContext);
 205
 206     QAction* restoreAction = new QAction(i18nc("@action:inmenu", "Restore"), m_mainWindow);
 207     m_popup->addAction(restoreAction);
 208
 209     QAction* deleteAction = m_mainWindow->actionCollection()->action("delete");
 210     m_popup->addAction(deleteAction);
 211
 212     QAction* propertiesAction = m_mainWindow->actionCollection()->action("properties");
 213     m_popup->addAction(propertiesAction);
 214
 215     if (m_popup->exec(QCursor::pos()) == restoreAction) {
 216         KUrl::List selectedUrls;
 217         foreach (const KFileItem &item, m_selectedItems) {
 218             selectedUrls.append(item.url());
 219         }
 220
 221         KonqOperations::restoreTrashedItems(selectedUrls, m_mainWindow);
 222     }
 223 }
 224
 225 void DolphinContextMenu::openItemContextMenu()
 226 {
 227     Q_ASSERT(!m_fileInfo.isNull());
 228
 229     QAction* openParentInNewWindowAction = 0;
 230     QAction* openParentInNewTabAction = 0;
 231     QAction* addToPlacesAction = 0;
 232     if (m_selectedItems.count() == 1) {
 233         if (m_fileInfo.isDir()) {
 234             // setup 'Create New' menu
 235             DolphinNewFileMenu* newFileMenu = new DolphinNewFileMenu(m_mainWindow);
 236             const DolphinView* view = m_mainWindow->activeViewContainer()->view();
 237             newFileMenu->setViewShowsHiddenFiles(view->showHiddenFiles());
 238             newFileMenu->checkUpToDate();
 239             newFileMenu->setPopupFiles(m_fileInfo.url());
 240             newFileMenu->setEnabled(selectedItemsProperties().supportsWriting());
 241             connect(newFileMenu, SIGNAL(fileCreated(KUrl)), newFileMenu, SLOT(deleteLater()));
 242             connect(newFileMenu, SIGNAL(directoryCreated(KUrl)), newFileMenu, SLOT(deleteLater()));
 243
 244             KMenu* menu = newFileMenu->menu();
 245             menu->setTitle(i18nc("@title:menu Create new folder, file, link, etc.", "Create New"));
 246             menu->setIcon(KIcon("document-new"));
 247             m_popup->addMenu(menu);
 248             m_popup->addSeparator();
 249
 250             // insert 'Open in new window' and 'Open in new tab' entries
 251             m_popup->addAction(m_mainWindow->actionCollection()->action("open_in_new_window"));
 252             m_popup->addAction(m_mainWindow->actionCollection()->action("open_in_new_tab"));
 253
 254             // insert 'Add to Places' entry
 255             if (!placeExists(m_fileInfo.url())) {
 256                 addToPlacesAction = m_popup->addAction(KIcon("bookmark-new"),
 257                                                        i18nc("@action:inmenu Add selected folder to places",
 258                                                              "Add to Places"));
 259             }
 260
 261             m_popup->addSeparator();
 262         } else if (m_baseUrl.protocol().contains("search")) {
 263             openParentInNewWindowAction = new QAction(KIcon("window-new"),
 264                                                     i18nc("@action:inmenu",
 265                                                           "Open Path in New Window"),
 266                                                     this);
 267             m_popup->addAction(openParentInNewWindowAction);
 268
 269             openParentInNewTabAction = new QAction(KIcon("tab-new"),
 270                                                    i18nc("@action:inmenu",
 271                                                          "Open Path in New Tab"),
 272                                                    this);
 273             m_popup->addAction(openParentInNewTabAction);
 274
 275             m_popup->addSeparator();
 276         }
 277     }
 278
 279     insertDefaultItemActions();
 280
 281     m_popup->addSeparator();
 282
 283     KFileItemActions fileItemActions;
 284     fileItemActions.setItemListProperties(selectedItemsProperties());
 285     addServiceActions(fileItemActions);
 286
 287     addFileItemPluginActions();
 288
 289     addVersionControlPluginActions();
 290
 291     // insert 'Copy To' and 'Move To' sub menus
 292     if (DolphinSettings::instance().generalSettings()->showCopyMoveMenu()) {
 293         m_copyToMenu.setItems(m_selectedItems);
 294         m_copyToMenu.setReadOnly(!selectedItemsProperties().supportsWriting());
 295         m_copyToMenu.addActionsTo(m_popup);
 296     }
 297
 298     // insert 'Properties...' entry
 299     QAction* propertiesAction = m_mainWindow->actionCollection()->action("properties");
 300     m_popup->addAction(propertiesAction);
 301
 302     QAction* activatedAction = m_popup->exec(QCursor::pos());
 303     if (activatedAction) {
 304         if (activatedAction == addToPlacesAction) {
 305             const KUrl selectedUrl(m_fileInfo.url());
 306             if (selectedUrl.isValid()) {
 307                 DolphinSettings::instance().placesModel()->addPlace(placesName(selectedUrl),
 308                                                                     selectedUrl);
 309             }
 310         } else if (activatedAction == openParentInNewWindowAction) {
 311             m_command = OpenParentFolderInNewWindow;
 312         } else if (activatedAction == openParentInNewTabAction) {
 313             m_command = OpenParentFolderInNewTab;
 314         }
 315     }
 316 }
 317
 318 void DolphinContextMenu::openViewportContextMenu()
 319 {
 320     // setup 'Create New' menu
 321     KNewFileMenu* newFileMenu = m_mainWindow->newFileMenu();
 322     const DolphinView* view = m_mainWindow->activeViewContainer()->view();
 323     newFileMenu->setViewShowsHiddenFiles(view->showHiddenFiles());
 324     newFileMenu->checkUpToDate();
 325     newFileMenu->setPopupFiles(m_baseUrl);
 326     m_popup->addMenu(newFileMenu->menu());
 327     m_popup->addSeparator();
 328
 329     // Insert 'New Window' and 'New Tab' entries. Don't use "open_in_new_window" and
 330     // "open_in_new_tab" here, as the current selection should get ignored.
 331     m_popup->addAction(m_mainWindow->actionCollection()->action("new_window"));
 332     m_popup->addAction(m_mainWindow->actionCollection()->action("new_tab"));
 333
 334     // Insert 'Add to Places' entry if exactly one item is selected
 335     QAction* addToPlacesAction = 0;
 336     if (!placeExists(m_mainWindow->activeViewContainer()->url())) {
 337         addToPlacesAction = m_popup->addAction(KIcon("bookmark-new"),
 338                                              i18nc("@action:inmenu Add current folder to places", "Add to Places"));
 339     }
 340
 341     m_popup->addSeparator();
 342
 343     QAction* pasteAction = createPasteAction();
 344     m_popup->addAction(pasteAction);
 345     m_popup->addSeparator();
 346
 347     // Insert service actions
 348     const KFileItemListProperties baseUrlProperties(KFileItemList() << baseFileItem());
 349     KFileItemActions fileItemActions;
 350     fileItemActions.setItemListProperties(baseUrlProperties);
 351     addServiceActions(fileItemActions);
 352
 353     addFileItemPluginActions();
 354
 355     addVersionControlPluginActions();
 356
 357     addCustomActions();
 358
 359     QAction* propertiesAction = m_mainWindow->actionCollection()->action("properties");
 360     m_popup->addAction(propertiesAction);
 361
 362     addShowMenuBarAction();
 363
 364     QAction* action = m_popup->exec(QCursor::pos());
 365     if (addToPlacesAction && (action == addToPlacesAction)) {
 366         const KUrl url = m_mainWindow->activeViewContainer()->url();
 367         if (url.isValid()) {
 368             DolphinSettings::instance().placesModel()->addPlace(placesName(url), url);
 369         }
 370     }
 371 }
 372
 373 void DolphinContextMenu::insertDefaultItemActions()
 374 {
 375     const KActionCollection* collection = m_mainWindow->actionCollection();
 376
 377     // Insert 'Cut', 'Copy' and 'Paste'
 378     m_popup->addAction(collection->action(KStandardAction::name(KStandardAction::Cut)));
 379     m_popup->addAction(collection->action(KStandardAction::name(KStandardAction::Copy)));
 380     m_popup->addAction(createPasteAction());
 381
 382     m_popup->addSeparator();
 383
 384     // Insert 'Rename'
 385     QAction* renameAction = collection->action("rename");
 386     m_popup->addAction(renameAction);
 387
 388     // Insert 'Move to Trash' and/or 'Delete'
 389     if (KGlobal::config()->group("KDE").readEntry("ShowDeleteCommand", false)) {
 390         m_popup->addAction(collection->action("move_to_trash"));
 391         m_popup->addAction(collection->action("delete"));
 392     } else {
 393         m_popup->addAction(m_removeAction);
 394         updateRemoveAction();
 395     }
 396 }
 397
 398 void DolphinContextMenu::addShowMenuBarAction()
 399 {
 400     const KActionCollection* ac = m_mainWindow->actionCollection();
 401     QAction* showMenuBar = ac->action(KStandardAction::name(KStandardAction::ShowMenubar));
 402     if (!m_mainWindow->menuBar()->isVisible() && !m_mainWindow->toolBar()->isVisible()) {
 403         m_popup->addSeparator();
 404         m_popup->addAction(showMenuBar);
 405     }
 406 }
 407
 408 QString DolphinContextMenu::placesName(const KUrl& url) const
 409 {
 410     QString name = url.fileName();
 411     if (name.isEmpty()) {
 412         name = url.host();
 413     }
 414     return name;
 415 }
 416
 417 bool DolphinContextMenu::placeExists(const KUrl& url) const
 418 {
 419     const KFilePlacesModel* placesModel = DolphinSettings::instance().placesModel();
 420     const int count = placesModel->rowCount();
 421
 422     for (int i = 0; i < count; ++i) {
 423         const QModelIndex index = placesModel->index(i, 0);
 424
 425         if (url.equals(placesModel->url(index), KUrl::CompareWithoutTrailingSlash)) {
 426             return true;
 427         }
 428     }
 429     return false;
 430 }
 431
 432 QAction* DolphinContextMenu::createPasteAction()
 433 {
 434     QAction* action = 0;
 435     const bool isDir = !m_fileInfo.isNull() && m_fileInfo.isDir();
 436     if (isDir && (m_selectedItems.count() == 1)) {
 437         action = new QAction(KIcon("edit-paste"), i18nc("@action:inmenu", "Paste Into Folder"), this);
 438         const QMimeData* mimeData = QApplication::clipboard()->mimeData();
 439         const KUrl::List pasteData = KUrl::List::fromMimeData(mimeData);
 440         action->setEnabled(!pasteData.isEmpty() && selectedItemsProperties().supportsWriting());
 441         connect(action, SIGNAL(triggered()), m_mainWindow, SLOT(pasteIntoFolder()));
 442     } else {
 443         action = m_mainWindow->actionCollection()->action(KStandardAction::name(KStandardAction::Paste));
 444     }
 445
 446     return action;
 447 }
 448
 449 KFileItemListProperties& DolphinContextMenu::selectedItemsProperties()
 450 {
 451     if (!m_selectedItemsProperties) {
 452         m_selectedItemsProperties = new KFileItemListProperties(m_selectedItems);
 453     }
 454     return *m_selectedItemsProperties;
 455 }
 456
 457 KFileItem DolphinContextMenu::baseFileItem()
 458 {
 459     if (!m_baseFileItem) {
 460         m_baseFileItem = new KFileItem(KFileItem::Unknown, KFileItem::Unknown, m_baseUrl);
 461     }
 462     return *m_baseFileItem;
 463 }
 464
 465 void DolphinContextMenu::addServiceActions(KFileItemActions& fileItemActions)
 466 {
 467     fileItemActions.setParentWidget(m_mainWindow);
 468
 469     // insert 'Open With...' action or sub menu
 470     fileItemActions.addOpenWithActionsTo(m_popup, "DesktopEntryName != 'dolphin'");
 471
 472     // insert 'Actions' sub menu
 473     fileItemActions.addServiceActionsTo(m_popup);
 474 }
 475
 476 void DolphinContextMenu::addFileItemPluginActions()
 477 {
 478     KFileItemListProperties props;
 479     if (m_selectedItems.isEmpty()) {
 480         props.setItems(KFileItemList() << baseFileItem());
 481     } else {
 482         props = selectedItemsProperties();
 483     }
 484
 485     QString commonMimeType = props.mimeType();
 486     if (commonMimeType.isEmpty()) {
 487         commonMimeType = QLatin1String("application/octet-stream");
 488     }
 489
 490     const KService::List pluginServices = KMimeTypeTrader::self()->query(commonMimeType, "KFileItemAction/Plugin", "exist Library");
 491     if (pluginServices.isEmpty()) {
 492         return;
 493     }
 494
 495     const KConfig config("kservicemenurc", KConfig::NoGlobals);
 496     const KConfigGroup showGroup = config.group("Show");
 497
 498     foreach (const KSharedPtr<KService>& service, pluginServices) {
 499         if (!showGroup.readEntry(service->desktopEntryName(), true)) {
 500             // The plugin has been disabled
 501             continue;
 502         }
 503
 504         // Old API (kdelibs-4.6.0 only)
 505         KFileItemActionPlugin* plugin = service->createInstance<KFileItemActionPlugin>();
 506         if (plugin) {
 507             plugin->setParent(m_popup);
 508             m_popup->addActions(plugin->actions(props, m_mainWindow));
 509         }
 510         // New API (kdelibs >= 4.6.1)
 511         KAbstractFileItemActionPlugin* abstractPlugin = service->createInstance<KAbstractFileItemActionPlugin>();
 512         if (abstractPlugin) {
 513             abstractPlugin->setParent(m_popup);
 514             m_popup->addActions(abstractPlugin->actions(props, m_mainWindow));
 515         }
 516     }
 517 }
 518
 519 void DolphinContextMenu::addVersionControlPluginActions()
 520 {
 521     const DolphinView* view = m_mainWindow->activeViewContainer()->view();
 522     const QList<QAction*> versionControlActions = view->versionControlActions(m_selectedItems);
 523     if (!versionControlActions.isEmpty()) {
 524         foreach (QAction* action, versionControlActions) {
 525             m_popup->addAction(action);
 526         }
 527         m_popup->addSeparator();
 528     }
 529 }
 530
 531 void DolphinContextMenu::addCustomActions()
 532 {
 533     foreach (QAction* action, m_customActions) {
 534         m_popup->addAction(action);
 535     }
 536 }
 537
 538 void DolphinContextMenu::updateRemoveAction()
 539 {
 540     const KActionCollection* collection = m_mainWindow->actionCollection();
 541     const bool moveToTrash = selectedItemsProperties().isLocal() && !m_shiftPressed;
 542
 543     // Using m_removeAction->setText(action->text()) does not apply the &-shortcut.
 544     // This is only done until the original action has been shown at least once. To
 545     // bypass this issue, the text and &-shortcut is applied manually.
 546     const QAction* action = 0;
 547     if (moveToTrash) {
 548         action = collection->action("move_to_trash");
 549         m_removeAction->setText(i18nc("@action:inmenu", "&Move to Trash"));
 550     } else {
 551         action = collection->action("delete");
 552         m_removeAction->setText(i18nc("@action:inmenu", "&Delete"));
 553     }
 554     m_removeAction->setIcon(action->icon());
 555     m_removeAction->setShortcuts(action->shortcuts());
 556 }
 557
 558 #include "dolphincontextmenu.moc"