src/panels/information/informationpanelcontent.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2009 by Peter Penz <peter.penz19@gmail.com>             *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  18  ***************************************************************************/
  19
  20 #include "informationpanelcontent.h"
  21
  22 #include <KIO/JobUiDelegate>
  23 #include <KIO/PreviewJob>
  24 #include <KIconEffect>
  25 #include <KIconLoader>
  26 #include <KJobWidgets>
  27 #include <KLocalizedString>
  28 #include <KSeparator>
  29 #include <KStringHandler>
  30
  31 #include <QIcon>
  32 #include <QTextDocument>
  33
  34 #include <Baloo/FileMetaDataWidget>
  35
  36 #include <panels/places/placesitem.h>
  37 #include <panels/places/placesitemmodel.h>
  38
  39 #include <Phonon/BackendCapabilities>
  40 #include <Phonon/MediaObject>
  41
  42 #include <QLabel>
  43 #include <QDialogButtonBox>
  44 #include <QScrollArea>
  45 #include <QTextLayout>
  46 #include <QTimer>
  47 #include <QVBoxLayout>
  48 #include <QStyle>
  49 #include <QPainter>
  50 #include <QBitmap>
  51 #include <QLinearGradient>
  52 #include <QPolygon>
  53
  54 #include "dolphin_informationpanelsettings.h"
  55 #include "phononwidget.h"
  56 #include "pixmapviewer.h"
  57
  58 const int PLAY_ARROW_SIZE = 24;
  59 const int PLAY_ARROW_BORDER_SIZE = 2;
  60
  61 InformationPanelContent::InformationPanelContent(QWidget* parent) :
  62     QWidget(parent),
  63     m_item(),
  64     m_previewJob(nullptr),
  65     m_outdatedPreviewTimer(nullptr),
  66     m_preview(nullptr),
  67     m_phononWidget(nullptr),
  68     m_nameLabel(nullptr),
  69     m_metaDataWidget(nullptr),
  70     m_metaDataArea(nullptr),
  71     m_placesItemModel(nullptr),
  72     m_isVideo(false)
  73 {
  74     parent->installEventFilter(this);
  75
  76     // Initialize timer for disabling an outdated preview with a small
  77     // delay. This prevents flickering if the new preview can be generated
  78     // within a very small timeframe.
  79     m_outdatedPreviewTimer = new QTimer(this);
  80     m_outdatedPreviewTimer->setInterval(300);
  81     m_outdatedPreviewTimer->setSingleShot(true);
  82     connect(m_outdatedPreviewTimer, &QTimer::timeout,
  83             this, &InformationPanelContent::markOutdatedPreview);
  84
  85     QVBoxLayout* layout = new QVBoxLayout(this);
  86
  87     // preview
  88     const int minPreviewWidth = KIconLoader::SizeEnormous + KIconLoader::SizeMedium;
  89
  90     m_preview = new PixmapViewer(parent);
  91     m_preview->setMinimumWidth(minPreviewWidth);
  92     m_preview->setMinimumHeight(KIconLoader::SizeEnormous);
  93
  94     m_phononWidget = new PhononWidget(parent);
  95     m_phononWidget->hide();
  96     m_phononWidget->setMinimumWidth(minPreviewWidth);
  97     m_phononWidget->setAutoPlay(InformationPanelSettings::previewsAutoPlay());
  98     connect(m_phononWidget, &PhononWidget::hasVideoChanged,
  99             this, &InformationPanelContent::slotHasVideoChanged);
 100
 101     // name
 102     m_nameLabel = new QLabel(parent);
 103     QFont font = m_nameLabel->font();
 104     font.setBold(true);
 105     m_nameLabel->setFont(font);
 106     m_nameLabel->setTextFormat(Qt::PlainText);
 107     m_nameLabel->setAlignment(Qt::AlignHCenter);
 108     m_nameLabel->setSizePolicy(QSizePolicy::Ignored, QSizePolicy::Fixed);
 109
 110     const bool previewsShown = InformationPanelSettings::previewsShown();
 111     m_preview->setVisible(previewsShown);
 112
 113     m_metaDataWidget = new Baloo::FileMetaDataWidget(parent);
 114     m_metaDataWidget->setDateFormat(static_cast<Baloo::DateFormats>(InformationPanelSettings::dateFormat()));
 115     connect(m_metaDataWidget, &Baloo::FileMetaDataWidget::urlActivated,
 116             this, &InformationPanelContent::urlActivated);
 117     m_metaDataWidget->setFont(QFontDatabase::systemFont(QFontDatabase::SmallestReadableFont));
 118     m_metaDataWidget->setSizePolicy(QSizePolicy::Preferred, QSizePolicy::Minimum);
 119
 120     // Configuration
 121     m_configureLabel = new QLabel(i18nc("@label::textbox",
 122                                         "Select which data should be shown:"), this);
 123     m_configureLabel->setWordWrap(true);
 124     m_configureLabel->setVisible(false);
 125
 126     m_configureButtons = new QDialogButtonBox(QDialogButtonBox::Save | QDialogButtonBox::Cancel);
 127     m_configureButtons->setVisible(false);
 128     connect(m_configureButtons, &QDialogButtonBox::accepted, this, [this]() {
 129                 m_metaDataWidget->setConfigurationMode(Baloo::ConfigurationMode::Accept);
 130                 m_configureButtons->setVisible(false);
 131                 m_configureLabel->setVisible(false);
 132                 emit configurationFinished();
 133             }
 134     );
 135     connect(m_configureButtons, &QDialogButtonBox::rejected, this, [this]() {
 136                 m_metaDataWidget->setConfigurationMode(Baloo::ConfigurationMode::Cancel);
 137                 m_configureButtons->setVisible(false);
 138                 m_configureLabel->setVisible(false);
 139                 emit configurationFinished();
 140             }
 141     );
 142
 143     m_metaDataArea = new QScrollArea(parent);
 144     m_metaDataArea->setWidget(m_metaDataWidget);
 145     m_metaDataArea->setWidgetResizable(true);
 146     m_metaDataArea->setFrameShape(QFrame::NoFrame);
 147
 148     QWidget* viewport = m_metaDataArea->viewport();
 149     viewport->installEventFilter(this);
 150
 151     layout->addWidget(m_preview);
 152     layout->addWidget(m_phononWidget);
 153     layout->addWidget(m_nameLabel);
 154     layout->addWidget(new KSeparator());
 155     layout->addWidget(m_configureLabel);
 156     layout->addWidget(m_metaDataArea);
 157     layout->addWidget(m_configureButtons);
 158
 159     m_placesItemModel = new PlacesItemModel(this);
 160 }
 161
 162 InformationPanelContent::~InformationPanelContent()
 163 {
 164     InformationPanelSettings::self()->save();
 165 }
 166
 167 void InformationPanelContent::showItem(const KFileItem& item)
 168 {
 169     if (item != m_item) {
 170         m_item = item;
 171
 172         refreshMetaData();
 173     }
 174     refreshPreview();
 175 }
 176
 177 void InformationPanelContent::refreshPixmapView()
 178 {
 179     // If there is a preview job, kill it to prevent that we have jobs for
 180     // multiple items running, and thus a race condition (bug 250787).
 181     if (m_previewJob) {
 182         m_previewJob->kill();
 183     }
 184
 185     // try to get a preview pixmap from the item...
 186
 187     // Mark the currently shown preview as outdated. This is done
 188     // with a small delay to prevent a flickering when the next preview
 189     // can be shown within a short timeframe. This timer is not started
 190     // for directories, as directory previews might fail and return the
 191     // same icon.
 192     if (!m_item.isDir()) {
 193         m_outdatedPreviewTimer->start();
 194     }
 195
 196     QStringList plugins = KIO::PreviewJob::availablePlugins();
 197     m_previewJob = new KIO::PreviewJob(KFileItemList() << m_item,
 198                                        QSize(m_preview->width(), m_preview->height()),
 199                                        &plugins);
 200     m_previewJob->setScaleType(KIO::PreviewJob::Unscaled);
 201     m_previewJob->setIgnoreMaximumSize(m_item.isLocalFile());
 202     if (m_previewJob->uiDelegate()) {
 203         KJobWidgets::setWindow(m_previewJob, this);
 204     }
 205
 206     connect(m_previewJob.data(), &KIO::PreviewJob::gotPreview,
 207             this, &InformationPanelContent::showPreview);
 208     connect(m_previewJob.data(), &KIO::PreviewJob::failed,
 209             this, &InformationPanelContent::showIcon);
 210 }
 211
 212 void InformationPanelContent::refreshPreview()
 213 {
 214     // If there is a preview job, kill it to prevent that we have jobs for
 215     // multiple items running, and thus a race condition (bug 250787).
 216     if (m_previewJob) {
 217         m_previewJob->kill();
 218     }
 219
 220     m_preview->setCursor(Qt::ArrowCursor);
 221     bool usePhonon = false;
 222     setNameLabelText(m_item.text());
 223     if (InformationPanelSettings::previewsShown()) {
 224
 225         const QUrl itemUrl = m_item.url();
 226         const bool isSearchUrl = itemUrl.scheme().contains(QLatin1String("search")) && m_item.localPath().isEmpty();
 227         if (isSearchUrl) {
 228             m_preview->show();
 229
 230             // in the case of a search-URL the URL is not readable for humans
 231             // (at least not useful to show in the Information Panel)
 232             m_preview->setPixmap(
 233                 QIcon::fromTheme(QStringLiteral("nepomuk")).pixmap(KIconLoader::SizeEnormous, KIconLoader::SizeEnormous)
 234             );
 235         } else {
 236
 237             refreshPixmapView();
 238
 239             const QString mimeType = m_item.mimetype();
 240             m_isVideo = mimeType.startsWith(QLatin1String("video/"));
 241             usePhonon = m_isVideo || mimeType.startsWith(QLatin1String("audio/"));
 242
 243             if (usePhonon) {
 244                 // change the cursor of the preview
 245                 m_preview->setCursor(Qt::PointingHandCursor);
 246                 m_preview->installEventFilter(m_phononWidget);
 247
 248                 // if the video is playing, has been paused or stopped
 249                 // we don't need to update the preview/phonon widget states
 250                 // unless the previewed file has changed,
 251                 // or the setting previewshown has changed
 252                 if ((m_phononWidget->state() != Phonon::State::PlayingState &&
 253                      m_phononWidget->state() != Phonon::State::PausedState &&
 254                      m_phononWidget->state() != Phonon::State::StoppedState) ||
 255                         m_item.targetUrl() != m_phononWidget->url() ||
 256                         (!m_preview->isVisible() &&! m_phononWidget->isVisible())) {
 257
 258                     if (InformationPanelSettings::previewsAutoPlay() && m_isVideo) {
 259                         // hides the preview now to avoid flickering when the autoplay video starts
 260                         m_preview->hide();
 261                     } else {
 262                         // the video won't play before the preview is displayed
 263                         m_preview->show();
 264                     }
 265
 266                     m_phononWidget->show();
 267                     m_phononWidget->setUrl(m_item.targetUrl(), m_isVideo ? PhononWidget::MediaKind::Video : PhononWidget::MediaKind::Audio);
 268                     adjustWidgetSizes(parentWidget()->width());
 269                 }
 270             } else {
 271                 // When we don't need it, hide the phonon widget first to avoid flickering
 272                 m_phononWidget->hide();
 273                 m_preview->show();
 274                 m_preview->removeEventFilter(m_phononWidget);
 275                 m_phononWidget->clearUrl();
 276             }
 277         }
 278     } else {
 279         m_preview->hide();
 280         m_phononWidget->hide();
 281     }
 282 }
 283
 284 void InformationPanelContent::configureShownProperties()
 285 {
 286     m_configureLabel->setVisible(true);
 287     m_configureButtons->setVisible(true);
 288     m_metaDataWidget->setConfigurationMode(Baloo::ConfigurationMode::ReStart);
 289 }
 290
 291 void InformationPanelContent::refreshMetaData()
 292 {
 293     m_metaDataWidget->setDateFormat(static_cast<Baloo::DateFormats>(InformationPanelSettings::dateFormat()));
 294     m_metaDataWidget->show();
 295     m_metaDataWidget->setItems(KFileItemList() << m_item);
 296 }
 297
 298 void InformationPanelContent::showItems(const KFileItemList& items)
 299 {
 300     // If there is a preview job, kill it to prevent that we have jobs for
 301     // multiple items running, and thus a race condition (bug 250787).
 302     if (m_previewJob) {
 303         m_previewJob->kill();
 304     }
 305
 306     m_preview->setPixmap(
 307         QIcon::fromTheme(QStringLiteral("dialog-information")).pixmap(KIconLoader::SizeEnormous, KIconLoader::SizeEnormous)
 308     );
 309     setNameLabelText(i18ncp("@label", "%1 item selected", "%1 items selected", items.count()));
 310
 311     m_metaDataWidget->setItems(items);
 312
 313     m_phononWidget->hide();
 314
 315     m_item = KFileItem();
 316 }
 317
 318 bool InformationPanelContent::eventFilter(QObject* obj, QEvent* event)
 319 {
 320     switch (event->type()) {
 321     case QEvent::Resize: {
 322         QResizeEvent* resizeEvent = static_cast<QResizeEvent*>(event);
 323         if (obj == m_metaDataArea->viewport()) {
 324             // The size of the meta text area has changed. Adjust the fixed
 325             // width in a way that no horizontal scrollbar needs to be shown.
 326             m_metaDataWidget->setFixedWidth(resizeEvent->size().width());
 327         } else if (obj == parent()) {
 328             adjustWidgetSizes(resizeEvent->size().width());
 329         }
 330         break;
 331     }
 332
 333     case QEvent::Polish:
 334         adjustWidgetSizes(parentWidget()->width());
 335         break;
 336
 337     case QEvent::FontChange:
 338         m_metaDataWidget->setFont(QFontDatabase::systemFont(QFontDatabase::SmallestReadableFont));
 339         break;
 340
 341     default:
 342         break;
 343     }
 344
 345     return QWidget::eventFilter(obj, event);
 346 }
 347
 348 void InformationPanelContent::showIcon(const KFileItem& item)
 349 {
 350     m_outdatedPreviewTimer->stop();
 351     QPixmap pixmap = QIcon::fromTheme(item.iconName()).pixmap(KIconLoader::SizeEnormous, KIconLoader::SizeEnormous);
 352     KIconLoader::global()->drawOverlays(item.overlays(), pixmap, KIconLoader::Desktop);
 353     m_preview->setPixmap(pixmap);
 354 }
 355
 356 void InformationPanelContent::showPreview(const KFileItem& item,
 357                                           const QPixmap& pixmap)
 358 {
 359     m_outdatedPreviewTimer->stop();
 360
 361     QPixmap p = pixmap;
 362     KIconLoader::global()->drawOverlays(item.overlays(), p, KIconLoader::Desktop);
 363
 364     if (m_isVideo) {
 365         // adds a play arrow
 366
 367         // compute relative pixel positions
 368         const int zeroX = static_cast<int>(p.width() / 2 - PLAY_ARROW_SIZE / 2 / devicePixelRatio());
 369         const int zeroY = static_cast<int>(p.height() / 2 - PLAY_ARROW_SIZE / 2 / devicePixelRatio());
 370
 371         QPolygon arrow;
 372         arrow << QPoint(zeroX, zeroY);
 373         arrow << QPoint(zeroX, zeroY + PLAY_ARROW_SIZE);
 374         arrow << QPoint(zeroX + PLAY_ARROW_SIZE, zeroY + PLAY_ARROW_SIZE / 2);
 375
 376         QPainterPath path;
 377         path.addPolygon(arrow);
 378
 379         QLinearGradient gradient(QPointF(zeroX, zeroY),
 380                                  QPointF(zeroX + PLAY_ARROW_SIZE,zeroY + PLAY_ARROW_SIZE));
 381
 382         QColor whiteColor = Qt::white;
 383         QColor blackColor = Qt::black;
 384         gradient.setColorAt(0, whiteColor);
 385         gradient.setColorAt(1, blackColor);
 386
 387         QBrush brush(gradient);
 388
 389         QPainter painter(&p);
 390
 391         QPen pen(blackColor, PLAY_ARROW_BORDER_SIZE, Qt::SolidLine, Qt::RoundCap, Qt::RoundJoin);
 392         painter.setPen(pen);
 393
 394         painter.setRenderHint(QPainter::Antialiasing);
 395         painter.drawPolygon(arrow);
 396         painter.fillPath(path, brush);
 397     }
 398
 399     m_preview->setPixmap(p);
 400 }
 401
 402 void InformationPanelContent::markOutdatedPreview()
 403 {
 404     KIconEffect *iconEffect = KIconLoader::global()->iconEffect();
 405     QPixmap disabledPixmap = iconEffect->apply(m_preview->pixmap(),
 406                                                KIconLoader::Desktop,
 407                                                KIconLoader::DisabledState);
 408     m_preview->setPixmap(disabledPixmap);
 409 }
 410
 411 KFileItemList InformationPanelContent::items()
 412 {
 413     return m_metaDataWidget->items();
 414 }
 415
 416 void InformationPanelContent::slotHasVideoChanged(bool hasVideo)
 417 {
 418     m_preview->setVisible(InformationPanelSettings::previewsShown() && !hasVideo);
 419     if (m_preview->isVisible() && m_preview->size().width() != m_preview->pixmap().size().width()) {
 420         // in case the information panel has been resized when the preview was not displayed
 421         // we need to refresh its content
 422         refreshPixmapView();
 423     }
 424 }
 425
 426 void InformationPanelContent::setPreviewAutoPlay(bool autoPlay) {
 427     m_phononWidget->setAutoPlay(autoPlay);
 428 }
 429
 430 void InformationPanelContent::setNameLabelText(const QString& text)
 431 {
 432     QTextOption textOption;
 433     textOption.setWrapMode(QTextOption::WrapAtWordBoundaryOrAnywhere);
 434
 435     const QString processedText = Qt::mightBeRichText(text) ? text : KStringHandler::preProcessWrap(text);
 436
 437     QTextLayout textLayout(processedText);
 438     textLayout.setFont(m_nameLabel->font());
 439     textLayout.setTextOption(textOption);
 440
 441     QString wrappedText;
 442     wrappedText.reserve(processedText.length());
 443
 444     // wrap the text to fit into the width of m_nameLabel
 445     textLayout.beginLayout();
 446     QTextLine line = textLayout.createLine();
 447     while (line.isValid()) {
 448         line.setLineWidth(m_nameLabel->width());
 449         wrappedText += processedText.midRef(line.textStart(), line.textLength());
 450
 451         line = textLayout.createLine();
 452         if (line.isValid()) {
 453             wrappedText += QChar::LineSeparator;
 454         }
 455     }
 456     textLayout.endLayout();
 457
 458     m_nameLabel->setText(wrappedText);
 459 }
 460
 461 void InformationPanelContent::adjustWidgetSizes(int width)
 462 {
 463     // If the text inside the name label or the info label cannot
 464     // get wrapped, then the maximum width of the label is increased
 465     // so that the width of the information panel gets increased.
 466     // To prevent this, the maximum width is adjusted to
 467     // the current width of the panel.
 468     const int maxWidth = width - style()->layoutSpacing(QSizePolicy::DefaultType, QSizePolicy::DefaultType, Qt::Horizontal) * 4;
 469     m_nameLabel->setMaximumWidth(maxWidth);
 470
 471     // The metadata widget also contains a text widget which may return
 472     // a large preferred width.
 473     m_metaDataWidget->setMaximumWidth(maxWidth);
 474
 475     // try to increase the preview as large as possible
 476     m_preview->setSizeHint(QSize(maxWidth, maxWidth));
 477
 478     if (m_phononWidget->isVisible()) {
 479         // assure that the size of the video player is the same as the preview size
 480         m_phononWidget->setVideoSize(QSize(maxWidth, maxWidth));
 481     }
 482 }
 483