File indexing completed on 2024-05-12 17:18:50

 /*
  * SPDX-FileCopyrightText: 2009 Peter Penz <peter.penz19@gmail.com>
  *
  * SPDX-License-Identifier: GPL-2.0-or-later
  */
 
 #include "informationpanelcontent.h"
 
 #include <KConfigGroup>
 #include <KIO/PreviewJob>
 #include <KIconEffect>
 #include <KIconLoader>
 #include <KJobWidgets>
 #include <KLocalizedString>
 #include <KSeparator>
 #include <KSharedConfig>
 #include <KStringHandler>
 #include <QPainterPath>
 
 #include <QIcon>
 #include <QStyle>
 #include <QTextDocument>
 
 #include <Baloo/FileMetaDataWidget>
 
 #include <phonon/BackendCapabilities>
 #include <phonon/MediaObject>
 
 #include <QDialogButtonBox>
 #include <QGesture>
 #include <QLabel>
 #include <QLinearGradient>
 #include <QPainter>
 #include <QPolygon>
 #include <QScrollArea>
 #include <QScroller>
 #include <QTextLayout>
 #include <QTimer>
 #include <QVBoxLayout>
 
 #include "dolphin_informationpanelsettings.h"
 #include "phononwidget.h"
 #include "pixmapviewer.h"
 
 const int PLAY_ARROW_SIZE = 24;
 const int PLAY_ARROW_BORDER_SIZE = 2;
 
 InformationPanelContent::InformationPanelContent(QWidget *parent)
     : QWidget(parent)
     , m_item()
     , m_previewJob(nullptr)
     , m_outdatedPreviewTimer(nullptr)
     , m_preview(nullptr)
     , m_phononWidget(nullptr)
     , m_nameLabel(nullptr)
     , m_metaDataWidget(nullptr)
     , m_metaDataArea(nullptr)
     , m_isVideo(false)
 {
     parent->installEventFilter(this);
 
     // Initialize timer for disabling an outdated preview with a small
     // delay. This prevents flickering if the new preview can be generated
     // within a very small timeframe.
     m_outdatedPreviewTimer = new QTimer(this);
     m_outdatedPreviewTimer->setInterval(100);
     m_outdatedPreviewTimer->setSingleShot(true);
     connect(m_outdatedPreviewTimer, &QTimer::timeout, this, &InformationPanelContent::markOutdatedPreview);
 
     QVBoxLayout *layout = new QVBoxLayout(this);
 
     // preview
     const int minPreviewWidth = KIconLoader::SizeEnormous + KIconLoader::SizeMedium;
 
     m_preview = new PixmapViewer(parent);
     m_preview->setMinimumWidth(minPreviewWidth);
     m_preview->setMinimumHeight(KIconLoader::SizeEnormous);
 
     m_phononWidget = new PhononWidget(parent);
     m_phononWidget->hide();
     m_phononWidget->setMinimumWidth(minPreviewWidth);
     m_phononWidget->setAutoPlay(InformationPanelSettings::previewsAutoPlay());
     connect(m_phononWidget, &PhononWidget::hasVideoChanged, this, &InformationPanelContent::slotHasVideoChanged);
 
     // name
     m_nameLabel = new QLabel(parent);
     QFont font = m_nameLabel->font();
     font.setBold(true);
     m_nameLabel->setFont(font);
     m_nameLabel->setTextFormat(Qt::PlainText);
     m_nameLabel->setAlignment(Qt::AlignHCenter);
     m_nameLabel->setSizePolicy(QSizePolicy::Ignored, QSizePolicy::Fixed);
     m_nameLabel->setTextInteractionFlags(Qt::TextSelectableByMouse);
 
     const bool previewsShown = InformationPanelSettings::previewsShown();
     m_preview->setVisible(previewsShown);
 
     m_metaDataWidget = new Baloo::FileMetaDataWidget(parent);
     m_metaDataWidget->setDateFormat(static_cast<Baloo::DateFormats>(InformationPanelSettings::dateFormat()));
     connect(m_metaDataWidget, &Baloo::FileMetaDataWidget::urlActivated, this, &InformationPanelContent::urlActivated);
     m_metaDataWidget->setFont(QFontDatabase::systemFont(QFontDatabase::SmallestReadableFont));
     m_metaDataWidget->setSizePolicy(QSizePolicy::Preferred, QSizePolicy::Minimum);
 
     // Configuration
     m_configureLabel = new QLabel(i18nc("@label::textbox", "Select which data should be shown:"), this);
     m_configureLabel->setWordWrap(true);
     m_configureLabel->setVisible(false);
 
     m_configureButtons = new QDialogButtonBox(QDialogButtonBox::Save | QDialogButtonBox::Cancel);
     m_configureButtons->setVisible(false);
     connect(m_configureButtons, &QDialogButtonBox::accepted, this, [this]() {
         m_metaDataWidget->setConfigurationMode(Baloo::ConfigurationMode::Accept);
         m_configureButtons->setVisible(false);
         m_configureLabel->setVisible(false);
         Q_EMIT configurationFinished();
     });
     connect(m_configureButtons, &QDialogButtonBox::rejected, this, [this]() {
         m_metaDataWidget->setConfigurationMode(Baloo::ConfigurationMode::Cancel);
         m_configureButtons->setVisible(false);
         m_configureLabel->setVisible(false);
         Q_EMIT configurationFinished();
     });
 
     m_metaDataArea = new QScrollArea(parent);
     m_metaDataArea->setWidget(m_metaDataWidget);
     m_metaDataArea->setWidgetResizable(true);
     m_metaDataArea->setFrameShape(QFrame::NoFrame);
 
     QWidget *viewport = m_metaDataArea->viewport();
     QScroller::grabGesture(viewport, QScroller::TouchGesture);
     viewport->installEventFilter(this);
 
     layout->addWidget(m_preview);
     layout->addWidget(m_phononWidget);
     layout->addWidget(m_nameLabel);
     layout->addWidget(new KSeparator());
     layout->addWidget(m_configureLabel);
     layout->addWidget(m_metaDataArea);
     layout->addWidget(m_configureButtons);
 
     grabGesture(Qt::TapAndHoldGesture);
 }
 
 InformationPanelContent::~InformationPanelContent()
 {
     InformationPanelSettings::self()->save();
 }
 
 void InformationPanelContent::showItem(const KFileItem &item)
 {
     // compares item entries, comparing items only compares urls
     if (m_item.entry() != item.entry()) {
         m_item = item;
         m_preview->stopAnimatedImage();
         refreshMetaData();
     }
 
     refreshPreview();
 }
 
 void InformationPanelContent::refreshPixmapView()
 {
     // If there is a preview job, kill it to prevent that we have jobs for
     // multiple items running, and thus a race condition (bug 250787).
     if (m_previewJob) {
         m_previewJob->kill();
     }
 
     // try to get a preview pixmap from the item...
 
     // Mark the currently shown preview as outdated. This is done
     // with a small delay to prevent a flickering when the next preview
     // can be shown within a short timeframe.
     m_outdatedPreviewTimer->start();
 
     const KConfigGroup globalConfig(KSharedConfig::openConfig(), "PreviewSettings");
     const QStringList plugins = globalConfig.readEntry("Plugins", KIO::PreviewJob::defaultPlugins());
     m_previewJob = new KIO::PreviewJob(KFileItemList() << m_item, QSize(m_preview->width(), m_preview->height()), &plugins);
     m_previewJob->setScaleType(KIO::PreviewJob::Unscaled);
     m_previewJob->setIgnoreMaximumSize(m_item.isLocalFile() && !m_item.isSlow());
     m_previewJob->setDevicePixelRatio(devicePixelRatioF());
     if (m_previewJob->uiDelegate()) {
         KJobWidgets::setWindow(m_previewJob, this);
     }
 
     connect(m_previewJob.data(), &KIO::PreviewJob::gotPreview, this, &InformationPanelContent::showPreview);
     connect(m_previewJob.data(), &KIO::PreviewJob::failed, this, &InformationPanelContent::showIcon);
 }
 
 void InformationPanelContent::refreshPreview()
 {
     // If there is a preview job, kill it to prevent that we have jobs for
     // multiple items running, and thus a race condition (bug 250787).
     if (m_previewJob) {
         m_previewJob->kill();
     }
 
     m_preview->setCursor(Qt::ArrowCursor);
     setNameLabelText(m_item.text());
     if (InformationPanelSettings::previewsShown()) {
         const QUrl itemUrl = m_item.url();
         const bool isSearchUrl = itemUrl.scheme().contains(QLatin1String("search")) && m_item.localPath().isEmpty();
         if (isSearchUrl) {
             m_preview->show();
             m_phononWidget->hide();
 
             // in the case of a search-URL the URL is not readable for humans
             // (at least not useful to show in the Information Panel)
             m_preview->setPixmap(QIcon::fromTheme(QStringLiteral("baloo")).pixmap(m_preview->height(), m_preview->width()));
         } else {
             refreshPixmapView();
 
             const QString mimeType = m_item.mimetype();
             const bool isAnimatedImage = m_preview->isAnimatedMimeType(mimeType);
             m_isVideo = !isAnimatedImage && mimeType.startsWith(QLatin1String("video/"));
             bool usePhonon = m_isVideo || mimeType.startsWith(QLatin1String("audio/"));
 
             if (usePhonon) {
                 // change the cursor of the preview
                 m_preview->setCursor(Qt::PointingHandCursor);
                 m_preview->installEventFilter(m_phononWidget);
                 m_phononWidget->show();
 
                 // if the video is playing, has been paused or stopped
                 // we don't need to update the preview/phonon widget states
                 // unless the previewed file has changed,
                 // or the setting previewshown has changed
                 if ((m_phononWidget->state() != Phonon::State::PlayingState && m_phononWidget->state() != Phonon::State::PausedState
                      && m_phononWidget->state() != Phonon::State::StoppedState)
                     || m_item.targetUrl() != m_phononWidget->url() || (!m_preview->isVisible() && !m_phononWidget->isVisible())) {
                     if (InformationPanelSettings::previewsAutoPlay() && m_isVideo) {
                         // hides the preview now to avoid flickering when the autoplay video starts
                         m_preview->hide();
                     } else {
                         // the video won't play before the preview is displayed
                         m_preview->show();
                     }
 
                     m_phononWidget->setUrl(m_item.targetUrl(), m_isVideo ? PhononWidget::MediaKind::Video : PhononWidget::MediaKind::Audio);
                     adjustWidgetSizes(parentWidget()->width());
                 }
             } else {
                 if (isAnimatedImage) {
                     m_preview->setAnimatedImageFileName(itemUrl.toLocalFile());
                 }
                 // When we don't need it, hide the phonon widget first to avoid flickering
                 m_phononWidget->hide();
                 m_preview->show();
                 m_preview->removeEventFilter(m_phononWidget);
                 m_phononWidget->clearUrl();
             }
         }
     } else {
         m_preview->stopAnimatedImage();
         m_preview->hide();
         m_phononWidget->hide();
     }
 }
 
 void InformationPanelContent::configureShownProperties()
 {
     m_configureLabel->setVisible(true);
     m_configureButtons->setVisible(true);
     m_metaDataWidget->setConfigurationMode(Baloo::ConfigurationMode::ReStart);
 }
 
 void InformationPanelContent::refreshMetaData()
 {
     m_metaDataWidget->setDateFormat(static_cast<Baloo::DateFormats>(InformationPanelSettings::dateFormat()));
     m_metaDataWidget->show();
     m_metaDataWidget->setItems(KFileItemList() << m_item);
 }
 
 void InformationPanelContent::showItems(const KFileItemList &items)
 {
     // If there is a preview job, kill it to prevent that we have jobs for
     // multiple items running, and thus a race condition (bug 250787).
     if (m_previewJob) {
         m_previewJob->kill();
     }
 
     m_preview->stopAnimatedImage();
 
     m_preview->setPixmap(QIcon::fromTheme(QStringLiteral("dialog-information")).pixmap(m_preview->height(), m_preview->width()));
     setNameLabelText(i18ncp("@label", "%1 item selected", "%1 items selected", items.count()));
 
     m_metaDataWidget->setItems(items);
 
     m_phononWidget->hide();
 
     m_item = KFileItem();
 }
 
 bool InformationPanelContent::eventFilter(QObject *obj, QEvent *event)
 {
     switch (event->type()) {
     case QEvent::Resize: {
         QResizeEvent *resizeEvent = static_cast<QResizeEvent *>(event);
         if (obj == m_metaDataArea->viewport()) {
             // The size of the meta text area has changed. Adjust the fixed
             // width in a way that no horizontal scrollbar needs to be shown.
             m_metaDataWidget->setFixedWidth(resizeEvent->size().width());
         } else if (obj == parent()) {
             adjustWidgetSizes(resizeEvent->size().width());
         }
         break;
     }
 
     case QEvent::Polish:
         adjustWidgetSizes(parentWidget()->width());
         break;
 
     case QEvent::FontChange:
         m_metaDataWidget->setFont(QFontDatabase::systemFont(QFontDatabase::SmallestReadableFont));
         break;
 
     default:
         break;
     }
 
     return QWidget::eventFilter(obj, event);
 }
 
 bool InformationPanelContent::event(QEvent *event)
 {
     if (event->type() == QEvent::Gesture) {
         gestureEvent(static_cast<QGestureEvent *>(event));
         return true;
     }
     return QWidget::event(event);
 }
 
 bool InformationPanelContent::gestureEvent(QGestureEvent *event)
 {
     if (!underMouse()) {
         return false;
     }
 
     QTapAndHoldGesture *tap = static_cast<QTapAndHoldGesture *>(event->gesture(Qt::TapAndHoldGesture));
 
     if (tap) {
         if (tap->state() == Qt::GestureFinished) {
             Q_EMIT contextMenuRequested(tap->position().toPoint());
         }
         event->accept();
         return true;
     }
     return false;
 }
 
 void InformationPanelContent::showIcon(const KFileItem &item)
 {
     m_outdatedPreviewTimer->stop();
     QPixmap pixmap = QIcon::fromTheme(item.iconName()).pixmap(m_preview->size(), devicePixelRatioF());
     KIconLoader::global()->drawOverlays(item.overlays(), pixmap, KIconLoader::Desktop);
     m_preview->setPixmap(pixmap);
 }
 
 void InformationPanelContent::showPreview(const KFileItem &item, const QPixmap &pixmap)
 {
     m_outdatedPreviewTimer->stop();
 
     QPixmap p = pixmap;
     KIconLoader::global()->drawOverlays(item.overlays(), p, KIconLoader::Desktop);
 
     if (m_isVideo) {
         // adds a play arrow overlay
 
         auto maxDim = qMax(p.width(), p.height());
         auto arrowSize = qMax(PLAY_ARROW_SIZE, maxDim / 8);
 
         // compute relative pixel positions
         const int zeroX = static_cast<int>((p.width() / 2 - arrowSize / 2) / pixmap.devicePixelRatio());
         const int zeroY = static_cast<int>((p.height() / 2 - arrowSize / 2) / pixmap.devicePixelRatio());
 
         QPolygon arrow;
         arrow << QPoint(zeroX, zeroY);
         arrow << QPoint(zeroX, zeroY + arrowSize);
         arrow << QPoint(zeroX + arrowSize, zeroY + arrowSize / 2);
 
         QPainterPath path;
         path.addPolygon(arrow);
 
         QLinearGradient gradient(QPointF(zeroX, zeroY + arrowSize / 2), QPointF(zeroX + arrowSize, zeroY + arrowSize / 2));
 
         QColor whiteColor = Qt::white;
         QColor blackColor = Qt::black;
         gradient.setColorAt(0, whiteColor);
         gradient.setColorAt(1, blackColor);
 
         QBrush brush(gradient);
 
         QPainter painter(&p);
 
         QPen pen(blackColor, PLAY_ARROW_BORDER_SIZE, Qt::SolidLine, Qt::RoundCap, Qt::RoundJoin);
         painter.setPen(pen);
 
         painter.setRenderHint(QPainter::Antialiasing);
         painter.drawPolygon(arrow);
         painter.fillPath(path, brush);
     }
 
     m_preview->setPixmap(p);
 }
 
 void InformationPanelContent::markOutdatedPreview()
 {
     if (m_item.isDir()) {
         // directory preview can be long
         // but since we always have icons to display
         // use it until the preview is done
         showIcon(m_item);
     } else {
         KIconEffect *iconEffect = KIconLoader::global()->iconEffect();
         QPixmap disabledPixmap = iconEffect->apply(m_preview->pixmap(), KIconLoader::Desktop, KIconLoader::DisabledState);
         m_preview->setPixmap(disabledPixmap);
     }
 }
 
 KFileItemList InformationPanelContent::items()
 {
     return m_metaDataWidget->items();
 }
 
 void InformationPanelContent::slotHasVideoChanged(bool hasVideo)
 {
     m_preview->setVisible(InformationPanelSettings::previewsShown() && !hasVideo);
     if (m_preview->isVisible() && m_preview->size().width() != m_preview->pixmap().size().width()) {
         // in case the information panel has been resized when the preview was not displayed
         // we need to refresh its content
         refreshPixmapView();
     }
 }
 
 void InformationPanelContent::setPreviewAutoPlay(bool autoPlay)
 {
     m_phononWidget->setAutoPlay(autoPlay);
 }
 
 void InformationPanelContent::setNameLabelText(const QString &text)
 {
     QTextOption textOption;
     textOption.setWrapMode(QTextOption::WrapAtWordBoundaryOrAnywhere);
 
     const QString processedText = Qt::mightBeRichText(text) ? text : KStringHandler::preProcessWrap(text);
 
     QTextLayout textLayout(processedText);
     textLayout.setFont(m_nameLabel->font());
     textLayout.setTextOption(textOption);
 
     QString wrappedText;
     wrappedText.reserve(processedText.length());
 
     // wrap the text to fit into the width of m_nameLabel
     textLayout.beginLayout();
     QTextLine line = textLayout.createLine();
     while (line.isValid()) {
         line.setLineWidth(m_nameLabel->width());
         wrappedText += QStringView(processedText).mid(line.textStart(), line.textLength());
 
         line = textLayout.createLine();
         if (line.isValid()) {
             wrappedText += QChar::LineSeparator;
         }
     }
     textLayout.endLayout();
 
     m_nameLabel->setText(wrappedText);
 }
 
 void InformationPanelContent::adjustWidgetSizes(int width)
 {
     // If the text inside the name label or the info label cannot
     // get wrapped, then the maximum width of the label is increased
     // so that the width of the information panel gets increased.
     // To prevent this, the maximum width is adjusted to
     // the current width of the panel.
     const int maxWidth = width - style()->layoutSpacing(QSizePolicy::DefaultType, QSizePolicy::DefaultType, Qt::Horizontal) * 4;
     m_nameLabel->setMaximumWidth(maxWidth);
 
     // The metadata widget also contains a text widget which may return
     // a large preferred width.
     m_metaDataWidget->setMaximumWidth(maxWidth);
 
     // try to increase the preview as large as possible
     m_preview->setSizeHint(QSize(maxWidth, maxWidth));
 
     if (m_phononWidget->isVisible()) {
         // assure that the size of the video player is the same as the preview size
         m_phononWidget->setVideoSize(QSize(maxWidth, maxWidth));
     }
 }
 
 #include "moc_informationpanelcontent.cpp"