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