src/infosidebarpage.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2006 by Peter Penz <peter.penz@gmx.at>                  *
   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 "infosidebarpage.h"
  21
  22 #include <config-nepomuk.h>
  23
  24 #include <kfileplacesmodel.h>
  25 #include <klocale.h>
  26 #include <kstandarddirs.h>
  27 #include <kio/previewjob.h>
  28 #include <kfileitem.h>
  29 #include <kdialog.h>
  30 #include <kglobalsettings.h>
  31 #include <kfilemetainfo.h>
  32 #include <kiconeffect.h>
  33 #include <kseparator.h>
  34 #include <kiconloader.h>
  35
  36 #include <QEvent>
  37 #include <QInputDialog>
  38 #include <QLabel>
  39 #include <QPainter>
  40 #include <QPixmap>
  41 #include <QResizeEvent>
  42 #include <QTimer>
  43 #include <QVBoxLayout>
  44
  45 #include "dolphinsettings.h"
  46 #include "metadatawidget.h"
  47 #include "metatextlabel.h"
  48 #include "pixmapviewer.h"
  49
  50 InfoSidebarPage::InfoSidebarPage(QWidget* parent) :
  51     SidebarPage(parent),
  52     m_pendingPreview(false),
  53     m_shownUrl(),
  54     m_urlCandidate(),
  55     m_fileItem(),
  56     m_selection(),
  57     m_nameLabel(0),
  58     m_preview(0),
  59     m_metaDataWidget(0),
  60     m_metaTextLabel(0)
  61 {
  62     const int spacing = KDialog::spacingHint();
  63
  64     m_timer = new QTimer(this);
  65     m_timer->setSingleShot(true);
  66     connect(m_timer, SIGNAL(timeout()),
  67             this, SLOT(slotTimeout()));
  68
  69     QVBoxLayout* layout = new QVBoxLayout;
  70     layout->setSpacing(spacing);
  71
  72     // name
  73     m_nameLabel = new QLabel(this);
  74     QFont font = m_nameLabel->font();
  75     font.setBold(true);
  76     m_nameLabel->setFont(font);
  77     m_nameLabel->setAlignment(Qt::AlignHCenter);
  78     m_nameLabel->setWordWrap(true);
  79
  80     // preview
  81     m_preview = new PixmapViewer(this);
  82     m_preview->setMinimumWidth(KIconLoader::SizeEnormous + KIconLoader::SizeMedium);
  83     m_preview->setMinimumHeight(KIconLoader::SizeEnormous);
  84
  85     if (MetaDataWidget::metaDataAvailable()) {
  86         // rating, comment and tags
  87         m_metaDataWidget = new MetaDataWidget(this);
  88     }
  89
  90     // general meta text information
  91     m_metaTextLabel = new MetaTextLabel(this);
  92     m_metaTextLabel->setMinimumWidth(spacing);
  93
  94     layout->addWidget(m_nameLabel);
  95     layout->addWidget(new KSeparator(this));
  96     layout->addWidget(m_preview);
  97     layout->addWidget(new KSeparator(this));
  98     if (m_metaDataWidget != 0) {
  99         layout->addWidget(m_metaDataWidget);
 100         layout->addWidget(new KSeparator(this));
 101     }
 102     layout->addWidget(m_metaTextLabel);
 103
 104     // ensure that widgets in the information side bar are aligned towards the top
 105     layout->addStretch(1);
 106     setLayout(layout);
 107 }
 108
 109 InfoSidebarPage::~InfoSidebarPage()
 110 {
 111 }
 112
 113 QSize InfoSidebarPage::sizeHint() const
 114 {
 115     QSize size = SidebarPage::sizeHint();
 116     size.setWidth(minimumSizeHint().width());
 117     return size;
 118 }
 119
 120 void InfoSidebarPage::setUrl(const KUrl& url)
 121 {
 122     SidebarPage::setUrl(url);
 123     if (url.isValid() && !m_shownUrl.equals(url, KUrl::CompareWithoutTrailingSlash)) {
 124         cancelRequest();
 125         m_shownUrl = url;
 126         showItemInfo();
 127     }
 128 }
 129
 130 void InfoSidebarPage::setSelection(const KFileItemList& selection)
 131 {
 132     m_selection = selection;
 133
 134     const int count = selection.count();
 135     if (count == 0) {
 136         m_shownUrl = url();
 137         showItemInfo();
 138     } else {
 139         if ((count == 1) && !selection.first().url().isEmpty()) {
 140             m_urlCandidate = selection.first().url();
 141         }
 142         m_timer->start(TimerDelay);
 143     }
 144 }
 145
 146 void InfoSidebarPage::requestDelayedItemInfo(const KFileItem& item)
 147 {
 148     cancelRequest();
 149
 150     m_fileItem = KFileItem();
 151     if (item.isNull()) {
 152         // The cursor is above the viewport. If files are selected,
 153         // show information regarding the selection.
 154         if (m_selection.size() > 0) {
 155             m_timer->start(TimerDelay);
 156         }
 157     } else if (!item.url().isEmpty()) {
 158         m_urlCandidate = item.url();
 159         m_fileItem = item;
 160         m_timer->start(TimerDelay);
 161     }
 162 }
 163
 164 void InfoSidebarPage::showEvent(QShowEvent* event)
 165 {
 166     SidebarPage::showEvent(event);
 167     if (!event->spontaneous()) {
 168         showItemInfo();
 169     }
 170 }
 171
 172 void InfoSidebarPage::resizeEvent(QResizeEvent* event)
 173 {
 174     // If the text inside the name label or the info label cannot
 175     // get wrapped, then the maximum width of the label is increased
 176     // so that the width of the information sidebar gets increased.
 177     // To prevent this, the maximum width is adjusted to
 178     // the current width of the sidebar.
 179     const int maxWidth = event->size().width() - KDialog::spacingHint() * 4;
 180     m_nameLabel->setMaximumWidth(maxWidth);
 181
 182     // try to increase the preview as large as possible
 183     m_preview->setSizeHint(QSize(maxWidth, maxWidth));
 184     m_urlCandidate = m_shownUrl; // reset the URL candidate if a resizing is done
 185     m_timer->start(TimerDelay);
 186
 187     SidebarPage::resizeEvent(event);
 188 }
 189
 190 void InfoSidebarPage::showItemInfo()
 191 {
 192     if (!isVisible()) {
 193         return;
 194     }
 195
 196     cancelRequest();
 197
 198     const KUrl file = (!m_fileItem.isNull() || m_selection.isEmpty()) ? m_shownUrl : m_selection[0].url();
 199     if (!file.isValid()) {
 200         return;
 201     }
 202
 203     const int selectionCount = m_selection.count();
 204     if (m_fileItem.isNull() && (selectionCount > 1)) {
 205         KIconLoader iconLoader;
 206         QPixmap icon = iconLoader.loadIcon("dialog-information",
 207                                            KIconLoader::NoGroup,
 208                                            KIconLoader::SizeEnormous);
 209         m_preview->setPixmap(icon);
 210         m_nameLabel->setText(i18ncp("@info", "%1 item selected", "%1 items selected", selectionCount));
 211     } else if (!applyPlace(file)) {
 212         // try to get a preview pixmap from the item...
 213         KUrl::List list;
 214         list.append(file);
 215
 216         m_pendingPreview = true;
 217
 218         KIconEffect iconEffect;
 219         QPixmap disabledPixmap = iconEffect.apply(m_preview->pixmap(), KIconLoader::Desktop, KIconLoader::DisabledState);
 220         m_preview->setPixmap(disabledPixmap);
 221
 222         KIO::PreviewJob* job = KIO::filePreview(list,
 223                                                 m_preview->width(),
 224                                                 m_preview->height(),
 225                                                 0,
 226                                                 0,
 227                                                 true,
 228                                                 false);
 229         job->setIgnoreMaximumSize(true);
 230
 231         connect(job, SIGNAL(gotPreview(const KFileItem&, const QPixmap&)),
 232                 this, SLOT(showPreview(const KFileItem&, const QPixmap&)));
 233         connect(job, SIGNAL(failed(const KFileItem&)),
 234                 this, SLOT(showIcon(const KFileItem&)));
 235
 236         m_nameLabel->setText(file.fileName());
 237     }
 238
 239     showMetaInfo();
 240 }
 241
 242 void InfoSidebarPage::slotTimeout()
 243 {
 244     m_shownUrl = m_urlCandidate;
 245     showItemInfo();
 246 }
 247
 248 void InfoSidebarPage::showIcon(const KFileItem& item)
 249 {
 250     m_pendingPreview = false;
 251     if (!applyPlace(item.url())) {
 252         m_preview->setPixmap(item.pixmap(KIconLoader::SizeEnormous));
 253     }
 254 }
 255
 256 void InfoSidebarPage::showPreview(const KFileItem& item,
 257                                   const QPixmap& pixmap)
 258 {
 259     Q_UNUSED(item);
 260     if (m_pendingPreview) {
 261         m_preview->setPixmap(pixmap);
 262         m_pendingPreview = false;
 263     }
 264 }
 265
 266 bool InfoSidebarPage::applyPlace(const KUrl& url)
 267 {
 268     KFilePlacesModel* placesModel = DolphinSettings::instance().placesModel();
 269     int count = placesModel->rowCount();
 270
 271     for (int i = 0; i < count; ++i) {
 272         QModelIndex index = placesModel->index(i, 0);
 273
 274         if (url.equals(placesModel->url(index), KUrl::CompareWithoutTrailingSlash)) {
 275             m_nameLabel->setText(placesModel->text(index));
 276             m_preview->setPixmap(placesModel->icon(index).pixmap(128, 128));
 277             return true;
 278         }
 279     }
 280
 281     return false;
 282 }
 283
 284 void InfoSidebarPage::cancelRequest()
 285 {
 286     m_timer->stop();
 287 }
 288
 289 void InfoSidebarPage::showMetaInfo()
 290 {
 291     m_metaTextLabel->clear();
 292
 293     if ((m_selection.size() <= 1) || !m_fileItem.isNull()) {
 294         KFileItem fileItem;
 295         if (m_fileItem.isNull()) {
 296             // no pending request is ongoing
 297             const KUrl url = (m_selection.size() == 1) ? m_selection.first().url() : m_shownUrl;
 298             fileItem = KFileItem(KFileItem::Unknown, KFileItem::Unknown, url);
 299             fileItem.refresh();
 300         } else {
 301             fileItem = m_fileItem;
 302         }
 303
 304         if (fileItem.isDir()) {
 305             m_metaTextLabel->add(i18nc("@label", "Type:"), i18nc("@label", "Folder"));
 306             m_metaTextLabel->add(i18nc("@label", "Modified:"), fileItem.timeString());
 307         } else {
 308             m_metaTextLabel->add(i18nc("@label", "Type:"), fileItem.mimeComment());
 309
 310             m_metaTextLabel->add(i18nc("@label", "Size:"), KIO::convertSize(fileItem.size()));
 311             m_metaTextLabel->add(i18nc("@label", "Modified:"), fileItem.timeString());
 312
 313             // TODO: See convertMetaInfo below, find a way to display only interesting information
 314             // in a readable way
 315             const KFileMetaInfo::WhatFlags flags = KFileMetaInfo::Fastest |
 316                                                    KFileMetaInfo::TechnicalInfo |
 317                                                    KFileMetaInfo::ContentInfo |
 318                                                    KFileMetaInfo::Thumbnail;
 319             const QString path = fileItem.url().url();
 320             const KFileMetaInfo fileMetaInfo(path, QString(), flags);
 321             if (fileMetaInfo.isValid()) {
 322                 const QHash<QString, KFileMetaInfoItem>& items = fileMetaInfo.items();
 323                 QHash<QString, KFileMetaInfoItem>::const_iterator it = items.constBegin();
 324                 const QHash<QString, KFileMetaInfoItem>::const_iterator end = items.constEnd();
 325                 QString labelText;
 326                 while (it != end) {
 327                     const KFileMetaInfoItem& metaInfoItem = it.value();
 328                     const QVariant& value = metaInfoItem.value();
 329                     if (value.isValid() && convertMetaInfo(metaInfoItem.name(), labelText)) {
 330                         m_metaTextLabel->add(labelText, value.toString());
 331                     }
 332                     ++it;
 333                 }
 334             }
 335         }
 336
 337         if (m_metaDataWidget != 0) {
 338             m_metaDataWidget->setFile(fileItem.targetUrl());
 339         }
 340     } else {
 341         if (m_metaDataWidget != 0) {
 342             KUrl::List urls;
 343             foreach (const KFileItem& item, m_selection) {
 344                 urls.append(item.targetUrl());
 345             }
 346             m_metaDataWidget->setFiles(urls);
 347         }
 348
 349         unsigned long int totalSize = 0;
 350         foreach (const KFileItem& item, m_selection) {
 351             // Only count the size of files, not dirs to match what
 352             // DolphinViewContainer::selectionStatusBarText() does.
 353             if (!item.isDir() && !item.isLink()) {
 354                 totalSize += item.size();
 355             }
 356         }
 357         m_metaTextLabel->add(i18nc("@label", "Total size:"), KIO::convertSize(totalSize));
 358     }
 359 }
 360
 361 bool InfoSidebarPage::convertMetaInfo(const QString& key, QString& text) const
 362 {
 363     // TODO: This code prevents that interesting meta information might be hidden
 364     // and only bypasses the current problem that not all the meta information should
 365     // be shown to the user. Check whether it's possible with Nepomuk to show
 366     // all "user relevant" information in a readable way...
 367
 368     struct MetaKey {
 369         const char* key;
 370         const char* text;
 371     };
 372
 373     // sorted list of keys, where its data should be shown
 374     static const MetaKey keys[] = {
 375         { "audio.album", "Album:" },
 376         { "audio.artist", "Artist:" },
 377         { "audio.title", "Title:" },
 378     };
 379
 380     // do a binary search for the key...
 381     int top = 0;
 382     int bottom = sizeof(keys) / sizeof(MetaKey) - 1;
 383     while (top <= bottom) {
 384         const int middle = (top + bottom) / 2;
 385         const int result = key.compare(keys[middle].key);
 386         if (result < 0) {
 387             bottom = middle - 1;
 388         } else if (result > 0) {
 389             top = middle + 1;
 390         } else {
 391             text = keys[middle].text;
 392             return true;
 393         }
 394     }
 395
 396     return false;
 397 }
 398
 399 #include "infosidebarpage.moc"