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_pendingPreview = false;
 156             m_timer->start(TimerDelay);
 157         }
 158     } else if (!item.url().isEmpty()) {
 159         m_urlCandidate = item.url();
 160         m_fileItem = item;
 161         m_timer->start(TimerDelay);
 162     }
 163 }
 164
 165 void InfoSidebarPage::showEvent(QShowEvent* event)
 166 {
 167     SidebarPage::showEvent(event);
 168     if (!event->spontaneous()) {
 169         showItemInfo();
 170     }
 171 }
 172
 173 void InfoSidebarPage::resizeEvent(QResizeEvent* event)
 174 {
 175     // If the text inside the name label or the info label cannot
 176     // get wrapped, then the maximum width of the label is increased
 177     // so that the width of the information sidebar gets increased.
 178     // To prevent this, the maximum width is adjusted to
 179     // the current width of the sidebar.
 180     const int maxWidth = event->size().width() - KDialog::spacingHint() * 4;
 181     m_nameLabel->setMaximumWidth(maxWidth);
 182
 183     // try to increase the preview as large as possible
 184     m_preview->setSizeHint(QSize(maxWidth, maxWidth));
 185     m_urlCandidate = m_shownUrl; // reset the URL candidate if a resizing is done
 186     m_timer->start(TimerDelay);
 187
 188     SidebarPage::resizeEvent(event);
 189 }
 190
 191 void InfoSidebarPage::showItemInfo()
 192 {
 193     if (!isVisible()) {
 194         return;
 195     }
 196
 197     cancelRequest();
 198
 199     const KUrl file = (!m_fileItem.isNull() || m_selection.isEmpty()) ? m_shownUrl : m_selection[0].url();
 200     if (!file.isValid()) {
 201         return;
 202     }
 203
 204     const int selectionCount = m_selection.count();
 205     if (m_fileItem.isNull() && (selectionCount > 1)) {
 206         KIconLoader iconLoader;
 207         QPixmap icon = iconLoader.loadIcon("dialog-information",
 208                                            KIconLoader::NoGroup,
 209                                            KIconLoader::SizeEnormous);
 210         m_preview->setPixmap(icon);
 211         m_nameLabel->setText(i18ncp("@info", "%1 item selected", "%1 items selected", selectionCount));
 212     } else if (!applyPlace(file)) {
 213         // try to get a preview pixmap from the item...
 214         KUrl::List list;
 215         list.append(file);
 216
 217         m_pendingPreview = true;
 218
 219         KIconEffect iconEffect;
 220         QPixmap disabledPixmap = iconEffect.apply(m_preview->pixmap(), KIconLoader::Desktop, KIconLoader::DisabledState);
 221         m_preview->setPixmap(disabledPixmap);
 222
 223         KIO::PreviewJob* job = KIO::filePreview(list,
 224                                                 m_preview->width(),
 225                                                 m_preview->height(),
 226                                                 0,
 227                                                 0,
 228                                                 true,
 229                                                 false);
 230         job->setIgnoreMaximumSize(true);
 231
 232         connect(job, SIGNAL(gotPreview(const KFileItem&, const QPixmap&)),
 233                 this, SLOT(showPreview(const KFileItem&, const QPixmap&)));
 234         connect(job, SIGNAL(failed(const KFileItem&)),
 235                 this, SLOT(showIcon(const KFileItem&)));
 236
 237         m_nameLabel->setText(file.fileName());
 238     }
 239
 240     showMetaInfo();
 241 }
 242
 243 void InfoSidebarPage::slotTimeout()
 244 {
 245     m_shownUrl = m_urlCandidate;
 246     showItemInfo();
 247 }
 248
 249 void InfoSidebarPage::showIcon(const KFileItem& item)
 250 {
 251     m_pendingPreview = false;
 252     if (!applyPlace(item.url())) {
 253         m_preview->setPixmap(item.pixmap(KIconLoader::SizeEnormous));
 254     }
 255 }
 256
 257 void InfoSidebarPage::showPreview(const KFileItem& item,
 258                                   const QPixmap& pixmap)
 259 {
 260     Q_UNUSED(item);
 261     if (m_pendingPreview) {
 262         m_preview->setPixmap(pixmap);
 263         m_pendingPreview = false;
 264     }
 265 }
 266
 267 bool InfoSidebarPage::applyPlace(const KUrl& url)
 268 {
 269     KFilePlacesModel* placesModel = DolphinSettings::instance().placesModel();
 270     int count = placesModel->rowCount();
 271
 272     for (int i = 0; i < count; ++i) {
 273         QModelIndex index = placesModel->index(i, 0);
 274
 275         if (url.equals(placesModel->url(index), KUrl::CompareWithoutTrailingSlash)) {
 276             m_nameLabel->setText(placesModel->text(index));
 277             m_preview->setPixmap(placesModel->icon(index).pixmap(128, 128));
 278             return true;
 279         }
 280     }
 281
 282     return false;
 283 }
 284
 285 void InfoSidebarPage::cancelRequest()
 286 {
 287     m_timer->stop();
 288 }
 289
 290 void InfoSidebarPage::showMetaInfo()
 291 {
 292     m_metaTextLabel->clear();
 293
 294     if ((m_selection.size() <= 1) || !m_fileItem.isNull()) {
 295         KFileItem fileItem;
 296         if (m_fileItem.isNull()) {
 297             // no pending request is ongoing
 298             const KUrl url = (m_selection.size() == 1) ? m_selection.first().url() : m_shownUrl;
 299             fileItem = KFileItem(KFileItem::Unknown, KFileItem::Unknown, url);
 300             fileItem.refresh();
 301         } else {
 302             fileItem = m_fileItem;
 303         }
 304
 305         if (fileItem.isDir()) {
 306             m_metaTextLabel->add(i18nc("@label", "Type:"), i18nc("@label", "Folder"));
 307             m_metaTextLabel->add(i18nc("@label", "Modified:"), fileItem.timeString());
 308         } else {
 309             m_metaTextLabel->add(i18nc("@label", "Type:"), fileItem.mimeComment());
 310
 311             m_metaTextLabel->add(i18nc("@label", "Size:"), KIO::convertSize(fileItem.size()));
 312             m_metaTextLabel->add(i18nc("@label", "Modified:"), fileItem.timeString());
 313
 314             // TODO: See convertMetaInfo below, find a way to display only interesting information
 315             // in a readable way
 316             const KFileMetaInfo::WhatFlags flags = KFileMetaInfo::Fastest |
 317                                                    KFileMetaInfo::TechnicalInfo |
 318                                                    KFileMetaInfo::ContentInfo |
 319                                                    KFileMetaInfo::Thumbnail;
 320             const QString path = fileItem.url().url();
 321             const KFileMetaInfo fileMetaInfo(path, QString(), flags);
 322             if (fileMetaInfo.isValid()) {
 323                 const QHash<QString, KFileMetaInfoItem>& items = fileMetaInfo.items();
 324                 QHash<QString, KFileMetaInfoItem>::const_iterator it = items.constBegin();
 325                 const QHash<QString, KFileMetaInfoItem>::const_iterator end = items.constEnd();
 326                 QString labelText;
 327                 while (it != end) {
 328                     const KFileMetaInfoItem& metaInfoItem = it.value();
 329                     const QVariant& value = metaInfoItem.value();
 330                     if (value.isValid() && convertMetaInfo(metaInfoItem.name(), labelText)) {
 331                         m_metaTextLabel->add(labelText, value.toString());
 332                     }
 333                     ++it;
 334                 }
 335             }
 336         }
 337
 338         if (m_metaDataWidget != 0) {
 339             m_metaDataWidget->setFile(fileItem.targetUrl());
 340         }
 341     } else {
 342         if (m_metaDataWidget != 0) {
 343             KUrl::List urls;
 344             foreach (const KFileItem& item, m_selection) {
 345                 urls.append(item.targetUrl());
 346             }
 347             m_metaDataWidget->setFiles(urls);
 348         }
 349
 350         quint64 totalSize = 0;
 351         foreach (const KFileItem& item, m_selection) {
 352             // Only count the size of files, not dirs to match what
 353             // DolphinViewContainer::selectionStatusBarText() does.
 354             if (!item.isDir() && !item.isLink()) {
 355                 totalSize += item.size();
 356             }
 357         }
 358         m_metaTextLabel->add(i18nc("@label", "Total size:"), KIO::convertSize(totalSize));
 359     }
 360 }
 361
 362 bool InfoSidebarPage::convertMetaInfo(const QString& key, QString& text) const
 363 {
 364     // TODO: This code prevents that interesting meta information might be hidden
 365     // and only bypasses the current problem that not all the meta information should
 366     // be shown to the user. Check whether it's possible with Nepomuk to show
 367     // all "user relevant" information in a readable way...
 368
 369     struct MetaKey {
 370         const char* key;
 371         const char* text;
 372     };
 373
 374     // sorted list of keys, where its data should be shown
 375     static const MetaKey keys[] = {
 376         { "audio.album", "Album:" },
 377         { "audio.artist", "Artist:" },
 378         { "audio.title", "Title:" },
 379     };
 380
 381     // do a binary search for the key...
 382     int top = 0;
 383     int bottom = sizeof(keys) / sizeof(MetaKey) - 1;
 384     while (top <= bottom) {
 385         const int middle = (top + bottom) / 2;
 386         const int result = key.compare(keys[middle].key);
 387         if (result < 0) {
 388             bottom = middle - 1;
 389         } else if (result > 0) {
 390             top = middle + 1;
 391         } else {
 392             text = keys[middle].text;
 393             return true;
 394         }
 395     }
 396
 397     return false;
 398 }
 399
 400 #include "infosidebarpage.moc"