1 /*****************************************************************************
2 * Copyright (C) 2008 by Sebastian Trueg <trueg@kde.org> *
3 * Copyright (C) 2009 by Peter Penz <peter.penz@gmx.at> *
5 * This library is free software; you can redistribute it and/or *
6 * modify it under the terms of the GNU Library General Public *
7 * License version 2 as published by the Free Software Foundation. *
9 * This library 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 GNU *
12 * Library General Public License for more details. *
14 * You should have received a copy of the GNU Library General Public License *
15 * along with this library; see the file COPYING.LIB. If not, write to *
16 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, *
17 * Boston, MA 02110-1301, USA. *
18 *****************************************************************************/
20 #include "kmetadatawidget.h"
23 #include <kconfiggroup.h>
24 #include <kfileitem.h>
25 #include <kglobalsettings.h>
29 #include <QFontMetrics>
30 #include <QGridLayout>
35 #include <config-nepomuk.h>
37 #define DISABLE_NEPOMUK_LEGACY
39 #include "kcommentwidget_p.h"
40 #include "kloadmetadatathread_p.h"
41 #include "ktaggingwidget_p.h"
43 #include <nepomuk/kratingwidget.h>
44 #include <nepomuk/resource.h>
45 #include <nepomuk/resourcemanager.h>
46 #include <nepomuk/property.h>
47 #include <nepomuk/tag.h>
48 #include <nepomuk/variant.h>
49 #include "nepomukmassupdatejob_p.h"
52 #include <QSpacerItem>
61 class KMetaDataWidget::Private
70 Private(KMetaDataWidget
* parent
);
73 void addRow(QLabel
* label
, QWidget
* infoWidget
);
74 void removeMetaInfoRows();
75 void setRowVisible(QWidget
* infoWidget
, bool visible
);
78 * Initializes the configuration file "kmetainformationrc"
79 * with proper default settings for the first start in
80 * an uninitialized environment.
82 void initMetaInfoSettings();
85 * Parses the configuration file "kmetainformationrc" and
86 * updates the visibility of all rows.
88 void updateRowsVisibility();
90 void slotLoadingFinished();
92 void slotRatingChanged(unsigned int rating
);
93 void slotTagsChanged(const QList
<Nepomuk::Tag
>& tags
);
94 void slotCommentChanged(const QString
& comment
);
96 void slotMetaDataUpdateDone();
97 void slotLinkActivated(const QString
& link
);
101 * Disables the metadata widget and starts the job that
102 * changes the meta data asynchronously. After the job
103 * has been finished, the metadata widget gets enabled again.
105 void startChangeDataJob(KJob
* job
);
108 * Merges items like 'width' and 'height' as one item.
110 QList
<KLoadMetaDataThread::Item
> mergedItems(const QList
<KLoadMetaDataThread::Item
>& items
);
115 bool m_nepomukActivated
;
116 MetaDataTypes m_visibleDataTypes
;
117 QList
<KFileItem
> m_fileItems
;
120 QGridLayout
* m_gridLayout
;
125 QLabel
* m_modifiedInfo
;
127 QLabel
* m_permissionsInfo
;
130 KRatingWidget
* m_ratingWidget
;
131 KTaggingWidget
* m_taggingWidget
;
132 KCommentWidget
* m_commentWidget
;
134 QMap
<KUrl
, Nepomuk::Resource
> m_files
;
136 KLoadMetaDataThread
* m_loadMetaDataThread
;
140 KMetaDataWidget
* const q
;
143 KMetaDataWidget::Private::Private(KMetaDataWidget
* parent
) :
146 m_nepomukActivated(false),
147 m_visibleDataTypes(TypeData
| SizeData
| ModifiedData
| OwnerData
|
148 PermissionsData
| RatingData
| TagsData
| CommentData
),
157 m_permissionsInfo(0),
163 m_loadMetaDataThread(0),
167 const QFontMetrics
fontMetrics(KGlobalSettings::smallestReadableFont());
169 m_gridLayout
= new QGridLayout(parent
);
170 m_gridLayout
->setMargin(0);
171 m_gridLayout
->setSpacing(fontMetrics
.height() / 4);
173 m_typeInfo
= new QLabel(parent
);
174 m_sizeLabel
= new QLabel(parent
);
175 m_sizeInfo
= new QLabel(parent
);
176 m_modifiedInfo
= new QLabel(parent
);
177 m_ownerInfo
= new QLabel(parent
);
178 m_permissionsInfo
= new QLabel(parent
);
180 addRow(new QLabel(i18nc("@label", "Type:"), parent
), m_typeInfo
);
181 addRow(m_sizeLabel
, m_sizeInfo
);
182 addRow(new QLabel(i18nc("@label", "Modified:"), parent
), m_modifiedInfo
);
183 addRow(new QLabel(i18nc("@label", "Owner:"), parent
), m_ownerInfo
);
184 addRow(new QLabel(i18nc("@label", "Permissions:"), parent
), m_permissionsInfo
);
187 m_nepomukActivated
= (Nepomuk::ResourceManager::instance()->init() == 0);
188 if (m_nepomukActivated
) {
189 m_ratingWidget
= new KRatingWidget(parent
);
190 m_ratingWidget
->setFixedHeight(fontMetrics
.height());
191 connect(m_ratingWidget
, SIGNAL(ratingChanged(unsigned int)),
192 q
, SLOT(slotRatingChanged(unsigned int)));
194 m_taggingWidget
= new KTaggingWidget(parent
);
195 connect(m_taggingWidget
, SIGNAL(tagsChanged(const QList
<Nepomuk::Tag
>&)),
196 q
, SLOT(slotTagsChanged(const QList
<Nepomuk::Tag
>&)));
198 m_commentWidget
= new KCommentWidget(parent
);
199 connect(m_commentWidget
, SIGNAL(commentChanged(const QString
&)),
200 q
, SLOT(slotCommentChanged(const QString
&)));
202 addRow(new QLabel(i18nc("@label", "Rating:"), parent
), m_ratingWidget
);
203 addRow(new QLabel(i18nc("@label", "Tags:"), parent
), m_taggingWidget
);
204 addRow(new QLabel(i18nc("@label", "Comment:"), parent
), m_commentWidget
);
208 initMetaInfoSettings();
209 updateRowsVisibility();
212 KMetaDataWidget::Private::~Private()
215 if (m_loadMetaDataThread
!= 0) {
216 disconnect(m_loadMetaDataThread
, SIGNAL(finished()), q
, SLOT(slotLoadingFinished()));
217 m_loadMetaDataThread
->cancelAndDelete();
218 m_loadMetaDataThread
= 0;
223 void KMetaDataWidget::Private::addRow(QLabel
* label
, QWidget
* infoWidget
)
227 row
.infoWidget
= infoWidget
;
230 const QFont smallFont
= KGlobalSettings::smallestReadableFont();
231 // use a brighter color for the label and a small font size
232 QPalette palette
= label
->palette();
233 QColor textColor
= palette
.color(QPalette::Text
);
234 textColor
.setAlpha(128);
235 palette
.setColor(QPalette::WindowText
, textColor
);
236 label
->setPalette(palette
);
237 label
->setFont(smallFont
);
238 label
->setWordWrap(true);
239 label
->setAlignment(Qt::AlignTop
| Qt::AlignRight
);
241 QLabel
* infoLabel
= qobject_cast
<QLabel
*>(infoWidget
);
242 if (infoLabel
!= 0) {
243 infoLabel
->setFont(smallFont
);
244 infoLabel
->setWordWrap(true);
245 infoLabel
->setAlignment(Qt::AlignTop
| Qt::AlignLeft
);
248 // add the row to grid layout
249 const int rowIndex
= m_rows
.count();
250 m_gridLayout
->addWidget(label
, rowIndex
, 0, Qt::AlignRight
);
251 const int spacerWidth
= QFontMetrics(smallFont
).size(Qt::TextSingleLine
, " ").width();
252 m_gridLayout
->addItem(new QSpacerItem(spacerWidth
, 1), rowIndex
, 1);
253 m_gridLayout
->addWidget(infoWidget
, rowIndex
, 2, Qt::AlignLeft
);
256 void KMetaDataWidget::Private::setRowVisible(QWidget
* infoWidget
, bool visible
)
258 foreach (const Row
& row
, m_rows
) {
259 if (row
.infoWidget
== infoWidget
) {
260 row
.label
->setVisible(visible
);
261 row
.infoWidget
->setVisible(visible
);
268 void KMetaDataWidget::Private::initMetaInfoSettings()
270 KConfig
config("kmetainformationrc", KConfig::NoGlobals
);
271 KConfigGroup settings
= config
.group("Show");
272 if (!settings
.readEntry("initialized", false)) {
273 // The resource file is read the first time. Assure
274 // that some meta information is disabled per default.
276 static const char* disabledProperties
[] = {
277 "asText", "contentSize", "created", "depth", "description", "fileExtension",
278 "fileName", "fileSize", "hasTag", "isPartOf", "lastModified", "mimeType", "name",
279 "numericRating", "parentUrl", "permissions", "plainTextContent", "owner",
280 "sourceModified", "url",
281 0 // mandatory last entry
285 while (disabledProperties
[i
] != 0) {
286 settings
.writeEntry(disabledProperties
[i
], false);
290 // mark the group as initialized
291 settings
.writeEntry("initialized", true);
295 void KMetaDataWidget::Private::updateRowsVisibility()
297 KConfig
config("kmetainformationrc", KConfig::NoGlobals
);
298 KConfigGroup settings
= config
.group("Show");
300 setRowVisible(m_typeInfo
,
301 (m_visibleDataTypes
& KMetaDataWidget::TypeData
) &&
302 settings
.readEntry("type", true));
304 // Cache in m_sizeVisible whether the size should be shown. This
305 // is necessary as the size is temporary hidden when the target
306 // file item is a directory.
307 m_sizeVisible
= (m_visibleDataTypes
& KMetaDataWidget::SizeData
) &&
308 settings
.readEntry("size", true);
309 setRowVisible(m_sizeInfo
, m_sizeVisible
);
311 setRowVisible(m_modifiedInfo
,
312 (m_visibleDataTypes
& KMetaDataWidget::ModifiedData
) &&
313 settings
.readEntry("modified", true));
315 setRowVisible(m_ownerInfo
,
316 (m_visibleDataTypes
& KMetaDataWidget::OwnerData
) &&
317 settings
.readEntry("owner", true));
319 setRowVisible(m_permissionsInfo
,
320 (m_visibleDataTypes
& KMetaDataWidget::PermissionsData
) &&
321 settings
.readEntry("permissions", true));
324 if (m_nepomukActivated
) {
325 setRowVisible(m_ratingWidget
,
326 (m_visibleDataTypes
& KMetaDataWidget::RatingData
) &&
327 settings
.readEntry("rating", true));
329 setRowVisible(m_taggingWidget
,
330 (m_visibleDataTypes
& KMetaDataWidget::TagsData
) &&
331 settings
.readEntry("tags", true));
333 setRowVisible(m_commentWidget
,
334 (m_visibleDataTypes
& KMetaDataWidget::CommentData
) &&
335 settings
.readEntry("comment", true));
340 void KMetaDataWidget::Private::slotLoadingFinished()
343 Q_ASSERT(m_loadMetaDataThread
!= 0);
344 Q_ASSERT(m_ratingWidget
!= 0);
345 Q_ASSERT(m_commentWidget
!= 0);
346 Q_ASSERT(m_taggingWidget
!= 0);
347 m_ratingWidget
->setRating(m_loadMetaDataThread
->rating());
348 m_commentWidget
->setText(m_loadMetaDataThread
->comment());
349 m_taggingWidget
->setTags(m_loadMetaDataThread
->tags());
351 // Show the remaining meta information as text. The number
352 // of required rows may very. Existing rows are reused to
353 // prevent flickering.
354 int index
= 8; // TODO: don't hardcode this value here
355 const int rowCount
= m_rows
.count();
356 Q_ASSERT(rowCount
>= index
);
358 const QList
<KLoadMetaDataThread::Item
> items
= mergedItems(m_loadMetaDataThread
->items());
359 foreach (const KLoadMetaDataThread::Item
& item
, items
) {
360 if (index
< rowCount
) {
361 // adjust texts of the current row
362 m_rows
[index
].label
->setText(item
.label
);
363 QLabel
* infoValueLabel
= qobject_cast
<QLabel
*>(m_rows
[index
].infoWidget
);
364 Q_ASSERT(infoValueLabel
!= 0);
365 infoValueLabel
->setText(item
.value
);
368 QLabel
* infoLabel
= new QLabel(item
.label
, q
);
369 QLabel
* infoValue
= new QLabel(item
.value
, q
);
370 connect(infoValue
, SIGNAL(linkActivated(QString
)),
371 q
, SLOT(slotLinkActivated(QString
)));
372 addRow(infoLabel
, infoValue
);
376 if (items
.count() > 0) {
380 // remove rows that are not needed anymore
381 for (int i
= m_rows
.count() - 1; i
>= index
; --i
) {
382 delete m_rows
[i
].label
;
383 delete m_rows
[i
].infoWidget
;
387 m_files
= m_loadMetaDataThread
->files();
389 delete m_loadMetaDataThread
;
390 m_loadMetaDataThread
= 0;
396 void KMetaDataWidget::Private::slotRatingChanged(unsigned int rating
)
399 Nepomuk::MassUpdateJob
* job
=
400 Nepomuk::MassUpdateJob::rateResources(m_files
.values(), rating
);
401 startChangeDataJob(job
);
407 void KMetaDataWidget::Private::slotTagsChanged(const QList
<Nepomuk::Tag
>& tags
)
410 m_taggingWidget
->setTags(tags
);
412 Nepomuk::MassUpdateJob
* job
=
413 Nepomuk::MassUpdateJob::tagResources(m_files
.values(), tags
);
414 startChangeDataJob(job
);
420 void KMetaDataWidget::Private::slotCommentChanged(const QString
& comment
)
423 Nepomuk::MassUpdateJob
* job
=
424 Nepomuk::MassUpdateJob::commentResources(m_files
.values(), comment
);
425 startChangeDataJob(job
);
431 void KMetaDataWidget::Private::slotMetaDataUpdateDone()
438 void KMetaDataWidget::Private::slotLinkActivated(const QString
& link
)
440 emit q
->urlActivated(KUrl(link
));
444 void KMetaDataWidget::Private::startChangeDataJob(KJob
* job
)
446 connect(job
, SIGNAL(result(KJob
*)),
447 q
, SLOT(slotMetaDataUpdateDone()));
448 q
->setEnabled(false); // no updates during execution
452 QList
<KLoadMetaDataThread::Item
>
453 KMetaDataWidget::Private::mergedItems(const QList
<KLoadMetaDataThread::Item
>& items
)
455 // TODO: Currently only "width" and "height" are merged as "width x height". If
456 // other kind of merges should be done too, a more general approach is required.
457 QList
<KLoadMetaDataThread::Item
> mergedItems
;
459 KLoadMetaDataThread::Item width
;
460 KLoadMetaDataThread::Item height
;
462 foreach (const KLoadMetaDataThread::Item
& item
, items
) {
463 if (item
.name
== "width") {
465 } else if (item
.name
== "height") {
468 // insert the item sorted by the label
469 bool inserted
= false;
471 const int count
= mergedItems
.count();
472 while (!inserted
&& (i
< count
)) {
473 if (item
.label
< mergedItems
[i
].label
) {
474 mergedItems
.insert(i
, item
);
480 mergedItems
.append(item
);
485 const bool foundWidth
= !width
.name
.isEmpty();
486 const bool foundHeight
= !height
.name
.isEmpty();
487 if (foundWidth
&& !foundHeight
) {
488 mergedItems
.insert(0, width
);
489 } else if (foundHeight
&& !foundWidth
) {
490 mergedItems
.insert(0, height
);
491 } else if (foundWidth
&& foundHeight
) {
492 KLoadMetaDataThread::Item size
;
493 size
.label
= i18nc("@label", "Width x Height:");
494 size
.value
= width
.value
+ " x " + height
.value
;
495 mergedItems
.insert(0, size
);
502 KMetaDataWidget::KMetaDataWidget(QWidget
* parent
) :
508 KMetaDataWidget::~KMetaDataWidget()
513 void KMetaDataWidget::setItem(const KFileItem
& item
)
515 // update values for "type", "size", "modified",
516 // "owner" and "permissions" synchronously
517 d
->m_sizeLabel
->setText(i18nc("@label", "Size:"));
519 d
->m_typeInfo
->setText(i18nc("@label", "Folder"));
520 d
->setRowVisible(d
->m_sizeInfo
, false);
522 d
->m_typeInfo
->setText(item
.mimeComment());
523 d
->m_sizeInfo
->setText(KIO::convertSize(item
.size()));
524 d
->setRowVisible(d
->m_sizeInfo
, d
->m_sizeVisible
);
526 d
->m_modifiedInfo
->setText(KGlobal::locale()->formatDateTime(item
.time(KFileItem::ModificationTime
), KLocale::FancyLongDate
));
527 d
->m_ownerInfo
->setText(item
.user());
528 d
->m_permissionsInfo
->setText(item
.permissionsString());
530 setItems(KFileItemList() << item
);
533 void KMetaDataWidget::setItems(const KFileItemList
& items
)
535 d
->m_fileItems
= items
;
537 if (items
.count() > 1) {
538 // calculate the size of all items and show this
539 // information to the user
540 d
->m_sizeLabel
->setText(i18nc("@label", "Total Size:"));
541 d
->setRowVisible(d
->m_sizeInfo
, d
->m_sizeVisible
);
543 quint64 totalSize
= 0;
544 foreach (const KFileItem
& item
, items
) {
545 if (!item
.isDir() && !item
.isLink()) {
546 totalSize
+= item
.size();
549 d
->m_sizeInfo
->setText(KIO::convertSize(totalSize
));
553 if (d
->m_nepomukActivated
) {
555 foreach (const KFileItem
& item
, items
) {
556 const KUrl url
= item
.nepomukUri();
562 if (d
->m_loadMetaDataThread
!= 0) {
563 disconnect(d
->m_loadMetaDataThread
, SIGNAL(finished()), this, SLOT(slotLoadingFinished()));
564 d
->m_loadMetaDataThread
->cancelAndDelete();
567 d
->m_loadMetaDataThread
= new KLoadMetaDataThread();
568 connect(d
->m_loadMetaDataThread
, SIGNAL(finished()), this, SLOT(slotLoadingFinished()));
569 d
->m_loadMetaDataThread
->load(urls
);
574 void KMetaDataWidget::setItem(const KUrl
& url
)
576 KFileItem
item(KFileItem::Unknown
, KFileItem::Unknown
, url
);
581 void KMetaDataWidget::setItems(const QList
<KUrl
>& urls
)
584 foreach (const KUrl
& url
, urls
) {
585 KFileItem
item(KFileItem::Unknown
, KFileItem::Unknown
, url
);
592 KFileItemList
KMetaDataWidget::items() const
594 return d
->m_fileItems
;
597 void KMetaDataWidget::setReadOnly(bool readOnly
)
599 d
->m_readOnly
= readOnly
;
601 // TODO: encapsulate this code as part of a metadata-model for KDE 4.5
602 if (d
->m_taggingWidget
)
603 d
->m_taggingWidget
->setReadOnly(readOnly
);
604 if (d
->m_commentWidget
)
605 d
->m_commentWidget
->setReadOnly(readOnly
);
609 bool KMetaDataWidget::isReadOnly() const
611 return d
->m_readOnly
;
614 void KMetaDataWidget::setVisibleDataTypes(MetaDataTypes data
)
616 d
->m_visibleDataTypes
= data
;
617 d
->updateRowsVisibility();
620 KMetaDataWidget::MetaDataTypes
KMetaDataWidget::visibleDataTypes() const
622 return d
->m_visibleDataTypes
;
625 QSize
KMetaDataWidget::sizeHint() const
627 const int fixedWidth
= 200;
629 int height
= d
->m_gridLayout
->margin() * 2 +
630 d
->m_gridLayout
->spacing() * (d
->m_rows
.count() - 1);
632 foreach (const Private::Row
& row
, d
->m_rows
) {
633 if (row
.infoWidget
!= 0) {
634 int rowHeight
= row
.infoWidget
->heightForWidth(fixedWidth
/ 2);
635 if (rowHeight
<= 0) {
636 rowHeight
= row
.infoWidget
->sizeHint().height();
642 return QSize(fixedWidth
, height
);
645 #include "kmetadatawidget.moc"