src/panels/places/placespanel.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2008-2012 by Peter Penz <peter.penz19@gmail.com>        *
   3  *                                                                         *
   4  *   Based on KFilePlacesView from kdelibs:                                *
   5  *   Copyright (C) 2007 Kevin Ottens <ervin@kde.org>                       *
   6  *   Copyright (C) 2007 David Faure <faure@kde.org>                        *
   7  *                                                                         *
   8  *   This program is free software; you can redistribute it and/or modify  *
   9  *   it under the terms of the GNU General Public License as published by  *
  10  *   the Free Software Foundation; either version 2 of the License, or     *
  11  *   (at your option) any later version.                                   *
  12  *                                                                         *
  13  *   This program is distributed in the hope that it will be useful,       *
  14  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  15  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  16  *   GNU General Public License for more details.                          *
  17  *                                                                         *
  18  *   You should have received a copy of the GNU General Public License     *
  19  *   along with this program; if not, write to the                         *
  20  *   Free Software Foundation, Inc.,                                       *
  21  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  22  ***************************************************************************/
  23
  24 #include "placespanel.h"
  25
  26 #include "dolphin_generalsettings.h"
  27
  28 #include <KDebug>
  29 #include <KDirNotify>
  30 #include <KIcon>
  31 #include <KIO/Job>
  32 #include <KIO/JobUiDelegate>
  33 #include <KLocale>
  34 #include <kitemviews/kitemlistcontainer.h>
  35 #include <kitemviews/kitemlistcontroller.h>
  36 #include <kitemviews/kitemlistselectionmanager.h>
  37 #include <kitemviews/kstandarditem.h>
  38 #include <KMenu>
  39 #include <KMessageBox>
  40 #include <KNotification>
  41 #include "placesitem.h"
  42 #include "placesitemeditdialog.h"
  43 #include "placesitemlistgroupheader.h"
  44 #include "placesitemlistwidget.h"
  45 #include "placesitemmodel.h"
  46 #include "placesview.h"
  47 #include <views/draganddrophelper.h>
  48 #include <QGraphicsSceneDragDropEvent>
  49 #include <QVBoxLayout>
  50 #include <QShowEvent>
  51
  52 PlacesPanel::PlacesPanel(QWidget* parent) :
  53     Panel(parent),
  54     m_controller(0),
  55     m_model(0),
  56     m_storageSetupFailedUrl(),
  57     m_triggerStorageSetupButton(),
  58     m_itemDropEventIndex(-1),
  59     m_itemDropEventMimeData(0),
  60     m_itemDropEvent(0)
  61 {
  62 }
  63
  64 PlacesPanel::~PlacesPanel()
  65 {
  66 }
  67
  68 bool PlacesPanel::urlChanged()
  69 {
  70     if (!url().isValid() || url().protocol().contains("search")) {
  71         // Skip results shown by a search, as possible identical
  72         // directory names are useless without parent-path information.
  73         return false;
  74     }
  75
  76     if (m_controller) {
  77         selectClosestItem();
  78     }
  79
  80     return true;
  81 }
  82
  83 void PlacesPanel::readSettings()
  84 {
  85     if (m_controller) {
  86         const int delay = GeneralSettings::autoExpandFolders() ? 750 : -1;
  87         m_controller->setAutoActivationDelay(delay);
  88     }
  89 }
  90
  91 void PlacesPanel::showEvent(QShowEvent* event)
  92 {
  93     if (event->spontaneous()) {
  94         Panel::showEvent(event);
  95         return;
  96     }
  97
  98     if (!m_controller) {
  99         // Postpone the creating of the controller to the first show event.
 100         // This assures that no performance and memory overhead is given when the folders panel is not
 101         // used at all and stays invisible.
 102         m_model = new PlacesItemModel(this);
 103         m_model->setGroupedSorting(true);
 104         connect(m_model, SIGNAL(errorMessage(QString)),
 105                 this, SIGNAL(errorMessage(QString)));
 106
 107         PlacesView* view = new PlacesView();
 108         view->setWidgetCreator(new KItemListWidgetCreator<PlacesItemListWidget>());
 109         view->setGroupHeaderCreator(new KItemListGroupHeaderCreator<PlacesItemListGroupHeader>());
 110
 111         m_controller = new KItemListController(m_model, view, this);
 112         m_controller->setSelectionBehavior(KItemListController::SingleSelection);
 113         m_controller->setSingleClickActivation(true);
 114
 115         readSettings();
 116
 117         connect(m_controller, SIGNAL(itemActivated(int)), this, SLOT(slotItemActivated(int)));
 118         connect(m_controller, SIGNAL(itemMiddleClicked(int)), this, SLOT(slotItemMiddleClicked(int)));
 119         connect(m_controller, SIGNAL(itemContextMenuRequested(int,QPointF)), this, SLOT(slotItemContextMenuRequested(int,QPointF)));
 120         connect(m_controller, SIGNAL(viewContextMenuRequested(QPointF)), this, SLOT(slotViewContextMenuRequested(QPointF)));
 121         connect(m_controller, SIGNAL(itemDropEvent(int,QGraphicsSceneDragDropEvent*)), this, SLOT(slotItemDropEvent(int,QGraphicsSceneDragDropEvent*)));
 122         connect(m_controller, SIGNAL(aboveItemDropEvent(int,QGraphicsSceneDragDropEvent*)), this, SLOT(slotAboveItemDropEvent(int,QGraphicsSceneDragDropEvent*)));
 123
 124         KItemListContainer* container = new KItemListContainer(m_controller, this);
 125         container->setEnabledFrame(false);
 126
 127         QVBoxLayout* layout = new QVBoxLayout(this);
 128         layout->setMargin(0);
 129         layout->addWidget(container);
 130
 131         selectClosestItem();
 132     }
 133
 134     Panel::showEvent(event);
 135 }
 136
 137 void PlacesPanel::slotItemActivated(int index)
 138 {
 139     triggerItem(index, Qt::LeftButton);
 140 }
 141
 142 void PlacesPanel::slotItemMiddleClicked(int index)
 143 {
 144     triggerItem(index, Qt::MiddleButton);
 145 }
 146
 147 void PlacesPanel::slotItemContextMenuRequested(int index, const QPointF& pos)
 148 {
 149     PlacesItem* item = m_model->placesItem(index);
 150     if (!item) {
 151         return;
 152     }
 153
 154     KMenu menu(this);
 155
 156     QAction* emptyTrashAction = 0;
 157     QAction* addAction = 0;
 158     QAction* mainSeparator = 0;
 159     QAction* editAction = 0;
 160     QAction* teardownAction = 0;
 161     QAction* ejectAction = 0;
 162
 163     const QString label = item->text();
 164
 165     const bool isDevice = !item->udi().isEmpty();
 166     if (isDevice) {
 167         ejectAction = m_model->ejectAction(index);
 168         if (ejectAction) {
 169             ejectAction->setParent(&menu);
 170             menu.addAction(ejectAction);
 171         }
 172
 173         teardownAction = m_model->teardownAction(index);
 174         if (teardownAction) {
 175             teardownAction->setParent(&menu);
 176             menu.addAction(teardownAction);
 177         }
 178
 179         if (teardownAction || ejectAction) {
 180             mainSeparator = menu.addSeparator();
 181         }
 182     } else {
 183         if (item->url() == KUrl("trash:/")) {
 184             emptyTrashAction = menu.addAction(KIcon("trash-empty"), i18nc("@action:inmenu", "Empty Trash"));
 185             emptyTrashAction->setEnabled(item->icon() == "user-trash-full");
 186             menu.addSeparator();
 187         }
 188         addAction = menu.addAction(KIcon("document-new"), i18nc("@item:inmenu", "Add Entry..."));
 189         mainSeparator = menu.addSeparator();
 190         editAction = menu.addAction(KIcon("document-properties"), i18nc("@item:inmenu", "Edit '%1'...", label));
 191     }
 192
 193     if (!addAction) {
 194         addAction = menu.addAction(KIcon("document-new"), i18nc("@item:inmenu", "Add Entry..."));
 195     }
 196
 197     QAction* openInNewTabAction = menu.addAction(i18nc("@item:inmenu", "Open '%1' in New Tab", label));
 198     openInNewTabAction->setIcon(KIcon("tab-new"));
 199
 200     QAction* removeAction = 0;
 201     if (!isDevice && !item->isSystemItem()) {
 202         removeAction = menu.addAction(KIcon("edit-delete"), i18nc("@item:inmenu", "Remove '%1'", label));
 203     }
 204
 205     QAction* hideAction = menu.addAction(i18nc("@item:inmenu", "Hide '%1'", label));
 206     hideAction->setCheckable(true);
 207     hideAction->setChecked(item->isHidden());
 208
 209     QAction* showAllAction = 0;
 210     if (m_model->hiddenCount() > 0) {
 211         if (!mainSeparator) {
 212             mainSeparator = menu.addSeparator();
 213         }
 214         showAllAction = menu.addAction(i18nc("@item:inmenu", "Show All Entries"));
 215         showAllAction->setCheckable(true);
 216         showAllAction->setChecked(m_model->hiddenItemsShown());
 217     }
 218
 219     menu.addSeparator();
 220     foreach (QAction* action, customContextMenuActions()) {
 221         menu.addAction(action);
 222     }
 223
 224     QAction* action = menu.exec(pos.toPoint());
 225     if (action) {
 226         if (action == emptyTrashAction) {
 227             emptyTrash();
 228         } else if (action == addAction) {
 229             addEntry();
 230         } else if (action == editAction) {
 231             editEntry(index);
 232         } else if (action == removeAction) {
 233             m_model->removeItem(index);
 234         } else if (action == hideAction) {
 235             item->setHidden(hideAction->isChecked());
 236         } else if (action == openInNewTabAction) {
 237             const KUrl url = m_model->item(index)->dataValue("url").value<KUrl>();
 238             emit placeMiddleClicked(url);
 239         } else if (action == showAllAction) {
 240             m_model->setHiddenItemsShown(showAllAction->isChecked());
 241         } else if (action == teardownAction) {
 242             m_model->requestTeardown(index);
 243         } else if (action == ejectAction) {
 244             m_model->requestEject(index);
 245         }
 246     }
 247
 248     selectClosestItem();
 249 }
 250
 251 void PlacesPanel::slotViewContextMenuRequested(const QPointF& pos)
 252 {
 253     KMenu menu(this);
 254
 255     QAction* addAction = menu.addAction(KIcon("document-new"), i18nc("@item:inmenu", "Add Entry..."));
 256
 257     QAction* showAllAction = 0;
 258     if (m_model->hiddenCount() > 0) {
 259         showAllAction = menu.addAction(i18nc("@item:inmenu", "Show All Entries"));
 260         showAllAction->setCheckable(true);
 261         showAllAction->setChecked(m_model->hiddenItemsShown());
 262     }
 263
 264     menu.addSeparator();
 265     foreach (QAction* action, customContextMenuActions()) {
 266         menu.addAction(action);
 267     }
 268
 269     QAction* action = menu.exec(pos.toPoint());
 270     if (action) {
 271         if (action == addAction) {
 272             addEntry();
 273         } else if (action == showAllAction) {
 274             m_model->setHiddenItemsShown(showAllAction->isChecked());
 275         }
 276     }
 277
 278     selectClosestItem();
 279 }
 280
 281 void PlacesPanel::slotItemDropEvent(int index, QGraphicsSceneDragDropEvent* event)
 282 {
 283     if (index < 0) {
 284         return;
 285     }
 286
 287     if (m_model->storageSetupNeeded(index)) {
 288         connect(m_model, SIGNAL(storageSetupDone(int,bool)),
 289                 this, SLOT(slotItemDropEventStorageSetupDone(int,bool)));
 290
 291         m_itemDropEventIndex = index;
 292
 293         // Make a full copy of the Mime-Data
 294         m_itemDropEventMimeData = new QMimeData;
 295         m_itemDropEventMimeData->setText(event->mimeData()->text());
 296         m_itemDropEventMimeData->setHtml(event->mimeData()->html());
 297         m_itemDropEventMimeData->setUrls(event->mimeData()->urls());
 298         m_itemDropEventMimeData->setImageData(event->mimeData()->imageData());
 299         m_itemDropEventMimeData->setColorData(event->mimeData()->colorData());
 300
 301         m_itemDropEvent = new QDropEvent(event->pos().toPoint(),
 302                                          event->possibleActions(),
 303                                          m_itemDropEventMimeData,
 304                                          event->buttons(),
 305                                          event->modifiers());
 306
 307         m_model->requestStorageSetup(index);
 308         return;
 309     }
 310
 311     KUrl destUrl = m_model->placesItem(index)->url();
 312     QDropEvent dropEvent(event->pos().toPoint(),
 313                          event->possibleActions(),
 314                          event->mimeData(),
 315                          event->buttons(),
 316                          event->modifiers());
 317
 318     DragAndDropHelper::dropUrls(KFileItem(), destUrl, &dropEvent);
 319 }
 320
 321 void PlacesPanel::slotItemDropEventStorageSetupDone(int index, bool success)
 322 {
 323     disconnect(m_model, SIGNAL(storageSetupDone(int,bool)),
 324                this, SLOT(slotItemDropEventStorageSetupDone(int,bool)));
 325
 326     if ((index == m_itemDropEventIndex) && m_itemDropEvent && m_itemDropEventMimeData) {
 327         if (success) {
 328             KUrl destUrl = m_model->placesItem(index)->url();
 329
 330             DragAndDropHelper::dropUrls(KFileItem(), destUrl, m_itemDropEvent);
 331         }
 332
 333         delete m_itemDropEventMimeData;
 334         delete m_itemDropEvent;
 335
 336         m_itemDropEventIndex = -1;
 337         m_itemDropEventMimeData = 0;
 338         m_itemDropEvent = 0;
 339     }
 340 }
 341
 342 void PlacesPanel::slotAboveItemDropEvent(int index, QGraphicsSceneDragDropEvent* event)
 343 {
 344     m_model->dropMimeDataBefore(index, event->mimeData());
 345 }
 346
 347 void PlacesPanel::slotUrlsDropped(const KUrl& dest, QDropEvent* event, QWidget* parent)
 348 {
 349     Q_UNUSED(parent);
 350     const QString error = DragAndDropHelper::dropUrls(KFileItem(), dest, event);
 351     if (!error.isEmpty()) {
 352         emit errorMessage(error);
 353     }
 354
 355 }
 356
 357 void PlacesPanel::slotTrashUpdated(KJob* job)
 358 {
 359     if (job->error()) {
 360         emit errorMessage(job->errorString());
 361     }
 362     org::kde::KDirNotify::emitFilesAdded("trash:/");
 363 }
 364
 365 void PlacesPanel::slotStorageSetupDone(int index, bool success)
 366 {
 367     disconnect(m_model, SIGNAL(storageSetupDone(int,bool)),
 368                this, SLOT(slotStorageSetupDone(int,bool)));
 369
 370     if (m_triggerStorageSetupButton == Qt::NoButton) {
 371         return;
 372     }
 373
 374     if (success) {
 375         Q_ASSERT(!m_model->storageSetupNeeded(index));
 376         triggerItem(index, m_triggerStorageSetupButton);
 377         m_triggerStorageSetupButton = Qt::NoButton;
 378     } else {
 379         setUrl(m_storageSetupFailedUrl);
 380         m_storageSetupFailedUrl = KUrl();
 381     }
 382 }
 383
 384 void PlacesPanel::emptyTrash()
 385 {
 386     const QString text = i18nc("@info", "Do you really want to empty the Trash? All items will be deleted.");
 387     const bool del = KMessageBox::warningContinueCancel(window(),
 388                                                         text,
 389                                                         QString(),
 390                                                         KGuiItem(i18nc("@action:button", "Empty Trash"),
 391                                                                  KIcon("user-trash"))
 392                                                        ) == KMessageBox::Continue;
 393     if (del) {
 394         QByteArray packedArgs;
 395         QDataStream stream(&packedArgs, QIODevice::WriteOnly);
 396         stream << int(1);
 397         KIO::Job *job = KIO::special(KUrl("trash:/"), packedArgs);
 398         KNotification::event("Trash: emptied", QString() , QPixmap() , 0, KNotification::DefaultEvent);
 399         job->ui()->setWindow(parentWidget());
 400         connect(job, SIGNAL(result(KJob*)), SLOT(slotTrashUpdated(KJob*)));
 401     }
 402 }
 403
 404 void PlacesPanel::addEntry()
 405 {
 406     const int index = m_controller->selectionManager()->currentItem();
 407     const KUrl url = m_model->data(index).value("url").value<KUrl>();
 408
 409     QPointer<PlacesItemEditDialog> dialog = new PlacesItemEditDialog(this);
 410     dialog->setCaption(i18nc("@title:window", "Add Places Entry"));
 411     dialog->setAllowGlobal(true);
 412     dialog->setUrl(url);
 413     if (dialog->exec() == QDialog::Accepted) {
 414         PlacesItem* item = m_model->createPlacesItem(dialog->text(), dialog->url(), dialog->icon());
 415         m_model->appendItemToGroup(item);
 416     }
 417
 418     delete dialog;
 419 }
 420
 421 void PlacesPanel::editEntry(int index)
 422 {
 423     QHash<QByteArray, QVariant> data = m_model->data(index);
 424
 425     QPointer<PlacesItemEditDialog> dialog = new PlacesItemEditDialog(this);
 426     dialog->setCaption(i18nc("@title:window", "Edit Places Entry"));
 427     dialog->setIcon(data.value("iconName").toString());
 428     dialog->setText(data.value("text").toString());
 429     dialog->setUrl(data.value("url").value<KUrl>());
 430     dialog->setAllowGlobal(true);
 431     if (dialog->exec() == QDialog::Accepted) {
 432         PlacesItem* oldItem = m_model->placesItem(index);
 433         if (oldItem) {
 434             oldItem->setText(dialog->text());
 435             oldItem->setUrl(dialog->url());
 436             oldItem->setIcon(dialog->icon());
 437         }
 438     }
 439
 440     delete dialog;
 441 }
 442
 443 void PlacesPanel::selectClosestItem()
 444 {
 445     const int index = m_model->closestItem(url());
 446     KItemListSelectionManager* selectionManager = m_controller->selectionManager();
 447     selectionManager->setCurrentItem(index);
 448     selectionManager->clearSelection();
 449     selectionManager->setSelected(index);
 450 }
 451
 452 void PlacesPanel::triggerItem(int index, Qt::MouseButton button)
 453 {
 454     const PlacesItem* item = m_model->placesItem(index);
 455     if (!item) {
 456         return;
 457     }
 458
 459     if (m_model->storageSetupNeeded(index)) {
 460         m_triggerStorageSetupButton = button;
 461         m_storageSetupFailedUrl = url();
 462
 463         connect(m_model, SIGNAL(storageSetupDone(int,bool)),
 464                 this, SLOT(slotStorageSetupDone(int,bool)));
 465
 466         m_model->requestStorageSetup(index);
 467     } else {
 468         m_triggerStorageSetupButton = Qt::NoButton;
 469
 470         const KUrl url = m_model->data(index).value("url").value<KUrl>();
 471         if (!url.isEmpty()) {
 472             if (button == Qt::MiddleButton) {
 473                 emit placeMiddleClicked(PlacesItemModel::convertedUrl(url));
 474             } else {
 475                 emit placeActivated(PlacesItemModel::convertedUrl(url));
 476             }
 477         }
 478     }
 479 }
 480
 481
 482 #include "placespanel.moc"