1 /***************************************************************************
2 * Copyright (C) 2008 by Sebastian Trueg <trueg@kde.org> *
3 * Copyright (C) 2009 by Peter Penz <peter.penz@gmx.at> *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) any later version. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
19 ***************************************************************************/
21 #include "metadatawidget.h"
24 #include <kconfiggroup.h>
25 #include <kfileitem.h>
26 #include <kglobalsettings.h>
29 #include <QFontMetrics>
30 #include <QGridLayout>
35 #include <config-nepomuk.h>
37 #define DISABLE_NEPOMUK_LEGACY
39 #include "commentwidget_p.h"
40 #include "nepomukmassupdatejob_p.h"
41 #include "taggingwidget_p.h"
43 #include <Nepomuk/KRatingWidget>
44 #include <Nepomuk/Resource>
45 #include <Nepomuk/ResourceManager>
46 #include <Nepomuk/Types/Property>
47 #include <Nepomuk/Variant>
50 #include <QSpacerItem>
56 class MetaDataWidget::Private
65 Private(MetaDataWidget
* parent
);
68 void addRow(QLabel
* label
, QWidget
* infoWidget
);
69 void removeMetaInfoRows();
70 void setRowVisible(QWidget
* infoWidget
, bool visible
);
73 * Initializes the configuration file "kmetainformationrc"
74 * with proper default settings for the first start in
75 * an uninitialized environment.
77 void initMetaInfoSettings();
80 * Parses the configuration file "kmetainformationrc" and
81 * updates the visibility of all rows.
83 void updateRowsVisibility();
85 void slotLoadingFinished();
86 void slotRatingChanged(unsigned int rating
);
87 void slotTagsChanged(const QList
<Nepomuk::Tag
>& tags
);
88 void slotCommentChanged(const QString
& comment
);
89 void slotMetaDataUpdateDone();
92 * Disables the metadata widget and starts the job that
93 * changes the meta data asynchronously. After the job
94 * has been finished, the metadata widget gets enabled again.
96 void startChangeDataJob(KJob
* job
);
98 MetaDataTypes m_hiddenData
;
99 QList
<KFileItem
> m_fileItems
;
102 QGridLayout
* m_gridLayout
;
107 QLabel
* m_modifiedInfo
;
109 QLabel
* m_permissionsInfo
;
112 KRatingWidget
* m_ratingWidget
;
113 TaggingWidget
* m_taggingWidget
;
114 CommentWidget
* m_commentWidget
;
116 // shared data between the GUI-thread and
117 // the loader-thread (see LoadFilesThread):
123 QList
<Nepomuk::Tag
> tags
;
124 QList
<QString
> metaInfoLabels
;
125 QList
<QString
> metaInfoValues
;
126 QMap
<KUrl
, Nepomuk::Resource
> files
;
130 * Loads the meta data of files and writes
131 * the result into a shared data pool that
132 * can be used by the widgets in the GUI thread.
134 class LoadFilesThread
: public QThread
137 LoadFilesThread(SharedData
* m_sharedData
, QMutex
* m_mutex
);
138 virtual ~LoadFilesThread();
139 void loadFiles(const KUrl::List
& urls
);
144 * Assures that the settings for the meta information
145 * are initialized with proper default values.
147 void initMetaInfoSettings(KConfigGroup
& group
);
150 * Temporary helper method for KDE 4.3 as we currently don't get
151 * translated labels for Nepmok literals: Replaces camelcase labels
152 * like "fileLocation" by "File Location:".
154 QString
tunedLabel(const QString
& label
) const;
157 SharedData
* m_sharedData
;
163 LoadFilesThread
* m_loadFilesThread
;
167 MetaDataWidget
* const q
;
170 MetaDataWidget::Private::Private(MetaDataWidget
* parent
) :
180 m_permissionsInfo(0),
185 m_loadFilesThread(0),
189 m_gridLayout
= new QGridLayout(parent
);
190 m_gridLayout
->setMargin(0);
192 m_typeInfo
= new QLabel(parent
);
193 m_sizeLabel
= new QLabel(parent
);
194 m_sizeInfo
= new QLabel(parent
);
195 m_modifiedInfo
= new QLabel(parent
);
196 m_ownerInfo
= new QLabel(parent
);
197 m_permissionsInfo
= new QLabel(parent
);
199 addRow(new QLabel(i18nc("@label", "Type:"), parent
), m_typeInfo
);
200 addRow(m_sizeLabel
, m_sizeInfo
);
201 addRow(new QLabel(i18nc("@label", "Modified:"), parent
), m_modifiedInfo
);
202 addRow(new QLabel(i18nc("@label", "Owner:"), parent
), m_ownerInfo
);
203 addRow(new QLabel(i18nc("@label", "Permissions:"), parent
), m_permissionsInfo
);
206 if (Nepomuk::ResourceManager::instance()->init() == 0) {
207 const QFontMetrics
fontMetrics(KGlobalSettings::smallestReadableFont());
208 m_ratingWidget
= new KRatingWidget(parent
);
209 m_ratingWidget
->setFixedHeight(fontMetrics
.height());
210 connect(m_ratingWidget
, SIGNAL(ratingChanged(unsigned int)),
211 q
, SLOT(slotRatingChanged(unsigned int)));
213 m_taggingWidget
= new TaggingWidget(parent
);
214 connect(m_taggingWidget
, SIGNAL(tagsChanged(const QList
<Nepomuk::Tag
>&)),
215 q
, SLOT(slotTagsChanged(const QList
<Nepomuk::Tag
>&)));
217 m_commentWidget
= new CommentWidget(parent
);
218 connect(m_commentWidget
, SIGNAL(commentChanged(const QString
&)),
219 q
, SLOT(slotCommentChanged(const QString
&)));
221 addRow(new QLabel(i18nc("@label", "Rating:"), parent
), m_ratingWidget
);
222 addRow(new QLabel(i18nc("@label", "Tags:"), parent
), m_taggingWidget
);
223 addRow(new QLabel(i18nc("@label", "Comment:"), parent
), m_commentWidget
);
225 m_loadFilesThread
= new LoadFilesThread(&m_sharedData
, &m_mutex
);
226 connect(m_loadFilesThread
, SIGNAL(finished()), q
, SLOT(slotLoadingFinished()));
229 m_sharedData
.rating
= 0;
232 initMetaInfoSettings();
233 updateRowsVisibility();
236 MetaDataWidget::Private::~Private()
239 delete m_loadFilesThread
;
243 void MetaDataWidget::Private::addRow(QLabel
* label
, QWidget
* infoWidget
)
247 row
.infoWidget
= infoWidget
;
250 const QFont smallFont
= KGlobalSettings::smallestReadableFont();
251 // use a brighter color for the label and a small font size
252 QPalette palette
= label
->palette();
253 QColor textColor
= palette
.color(QPalette::Text
);
254 textColor
.setAlpha(128);
255 palette
.setColor(QPalette::WindowText
, textColor
);
256 label
->setPalette(palette
);
257 label
->setFont(smallFont
);
258 label
->setWordWrap(true);
259 label
->setAlignment(Qt::AlignTop
| Qt::AlignRight
);
261 QLabel
* infoLabel
= qobject_cast
<QLabel
*>(infoWidget
);
262 if (infoLabel
!= 0) {
263 infoLabel
->setFont(smallFont
);
264 infoLabel
->setWordWrap(true);
265 infoLabel
->setAlignment(Qt::AlignTop
| Qt::AlignLeft
);
268 // add the row to grid layout
269 const int rowIndex
= m_rows
.count();
270 m_gridLayout
->addWidget(label
, rowIndex
, 0, Qt::AlignRight
);
271 const int spacerWidth
= QFontMetrics(smallFont
).size(Qt::TextSingleLine
, " ").width();
272 m_gridLayout
->addItem(new QSpacerItem(spacerWidth
, 1), rowIndex
, 1);
273 m_gridLayout
->addWidget(infoWidget
, rowIndex
, 2, Qt::AlignLeft
);
276 void MetaDataWidget::Private::setRowVisible(QWidget
* infoWidget
, bool visible
)
278 foreach (const Row
& row
, m_rows
) {
279 if (row
.infoWidget
== infoWidget
) {
280 row
.label
->setVisible(visible
);
281 row
.infoWidget
->setVisible(visible
);
288 void MetaDataWidget::Private::initMetaInfoSettings()
290 KConfig
config("kmetainformationrc", KConfig::NoGlobals
);
291 KConfigGroup settings
= config
.group("Show");
292 if (!settings
.readEntry("initialized", false)) {
293 // The resource file is read the first time. Assure
294 // that some meta information is disabled per default.
296 static const char* disabledProperties
[] = {
297 "asText", "contentSize", "created", "depth", "description", "fileExtension",
298 "fileName", "fileSize", "hasTag", "isPartOf", "lastModified", "mimeType", "name",
299 "numericRating", "parentUrl", "permissions", "plainTextContent", "owner",
300 "sourceModified", "url",
301 0 // mandatory last entry
305 while (disabledProperties
[i
] != 0) {
306 settings
.writeEntry(disabledProperties
[i
], false);
310 // mark the group as initialized
311 settings
.writeEntry("initialized", true);
315 void MetaDataWidget::Private::updateRowsVisibility()
317 KConfig
config("kmetainformationrc", KConfig::NoGlobals
);
318 KConfigGroup settings
= config
.group("Show");
319 setRowVisible(m_typeInfo
,
320 !(m_hiddenData
& MetaDataWidget::TypeData
) &&
321 settings
.readEntry("type", true));
322 setRowVisible(m_sizeInfo
,
323 !(m_hiddenData
& MetaDataWidget::SizeData
) &&
324 settings
.readEntry("size", true));
325 setRowVisible(m_modifiedInfo
,
326 !(m_hiddenData
& MetaDataWidget::ModifiedData
) &&
327 settings
.readEntry("modified", true));
328 setRowVisible(m_ownerInfo
,
329 !(m_hiddenData
& MetaDataWidget::OwnerData
) &&
330 settings
.readEntry("owner", true));
331 setRowVisible(m_permissionsInfo
,
332 !(m_hiddenData
& MetaDataWidget::PermissionsData
) &&
333 settings
.readEntry("permissions", true));
335 if (Nepomuk::ResourceManager::instance()->init() == 0) {
336 setRowVisible(m_ratingWidget
,
337 !(m_hiddenData
& MetaDataWidget::RatingData
) &&
338 settings
.readEntry("rating", true));
339 setRowVisible(m_taggingWidget
,
340 !(m_hiddenData
& MetaDataWidget::TagsData
) &&
341 settings
.readEntry("tagging", true));
342 setRowVisible(m_commentWidget
,
343 !(m_hiddenData
& MetaDataWidget::CommentData
) &&
344 settings
.readEntry("comment", true));
349 void MetaDataWidget::Private::slotLoadingFinished()
352 QMutexLocker
locker(&m_mutex
);
353 m_ratingWidget
->setRating(m_sharedData
.rating
);
354 m_commentWidget
->setText(m_sharedData
.comment
);
355 m_taggingWidget
->setTags(m_sharedData
.tags
);
357 // Show the remaining meta information as text. The number
358 // of required rows may very. Existing rows are reused to
359 // prevent flickering.
360 int index
= 8; // TODO: don't hardcode this value here
361 const int rowCount
= m_rows
.count();
362 Q_ASSERT(rowCount
>= index
);
364 Q_ASSERT(m_sharedData
.metaInfoLabels
.count() == m_sharedData
.metaInfoValues
.count());
365 const int metaInfoCount
= m_sharedData
.metaInfoLabels
.count();
366 for (int i
= 0; i
< metaInfoCount
; ++i
) {
367 if (index
< rowCount
) {
368 // adjust texts of the current row
369 m_rows
[index
].label
->setText(m_sharedData
.metaInfoLabels
[i
]);
370 QLabel
* infoValueLabel
= qobject_cast
<QLabel
*>(m_rows
[index
].infoWidget
);
371 Q_ASSERT(infoValueLabel
!= 0);
372 infoValueLabel
->setText(m_sharedData
.metaInfoValues
[i
]);
375 QLabel
* infoLabel
= new QLabel(m_sharedData
.metaInfoLabels
[i
], q
);
376 QLabel
* infoValue
= new QLabel(m_sharedData
.metaInfoValues
[i
], q
);
377 addRow(infoLabel
, infoValue
);
381 if (metaInfoCount
> 0) {
385 // remove rows that are not needed anymore
386 for (int i
= rowCount
- 1; i
> index
; --i
) {
387 delete m_rows
[i
].label
;
388 delete m_rows
[i
].infoWidget
;
392 emit q
->loadingFinished();
396 void MetaDataWidget::Private::slotRatingChanged(unsigned int rating
)
399 QMutexLocker
locker(&m_mutex
);
400 Nepomuk::MassUpdateJob
* job
=
401 Nepomuk::MassUpdateJob::rateResources(m_sharedData
.files
.values(), rating
);
403 startChangeDataJob(job
);
405 emit q
->ratingChanged(rating
);
408 void MetaDataWidget::Private::slotTagsChanged(const QList
<Nepomuk::Tag
>& tags
)
411 m_taggingWidget
->setTags(tags
);
413 QMutexLocker
locker(&m_mutex
);
414 Nepomuk::MassUpdateJob
* job
=
415 Nepomuk::MassUpdateJob::tagResources(m_sharedData
.files
.values(), tags
);
417 startChangeDataJob(job
);
419 emit q
->tagsChanged(tags
);
422 void MetaDataWidget::Private::slotCommentChanged(const QString
& comment
)
425 QMutexLocker
locker(&m_mutex
);
426 Nepomuk::MassUpdateJob
* job
=
427 Nepomuk::MassUpdateJob::commentResources(m_sharedData
.files
.values(), comment
);
429 startChangeDataJob(job
);
431 emit q
->commentChanged(comment
);
434 void MetaDataWidget::Private::slotMetaDataUpdateDone()
439 void MetaDataWidget::Private::startChangeDataJob(KJob
* job
)
441 connect(job
, SIGNAL(result(KJob
*)),
442 q
, SLOT(slotMetaDataUpdateDone()));
443 q
->setEnabled(false); // no updates during execution
448 MetaDataWidget::Private::LoadFilesThread::LoadFilesThread(
449 MetaDataWidget::Private::SharedData
* m_sharedData
,
451 m_sharedData(m_sharedData
),
458 MetaDataWidget::Private::LoadFilesThread::~LoadFilesThread()
460 // This thread may very well be deleted during execution. We need
461 // to protect it from crashes here.
466 void MetaDataWidget::Private::LoadFilesThread::loadFiles(const KUrl::List
& urls
)
468 QMutexLocker
locker(m_mutex
);
474 void MetaDataWidget::Private::LoadFilesThread::run()
476 QMutexLocker
locker(m_mutex
);
477 const KUrl::List urls
= m_urls
;
480 KConfig
config("kmetainformationrc", KConfig::NoGlobals
);
481 KConfigGroup settings
= config
.group("Show");
484 unsigned int rating
= 0;
486 QList
<Nepomuk::Tag
> tags
;
487 QList
<QString
> metaInfoLabels
;
488 QList
<QString
> metaInfoValues
;
489 QMap
<KUrl
, Nepomuk::Resource
> files
;
490 foreach (const KUrl
& url
, urls
) {
495 Nepomuk::Resource
file(url
);
496 files
.insert(url
, file
);
498 if (!first
&& (rating
!= file
.rating())) {
499 rating
= 0; // reset rating
501 rating
= file
.rating();
504 if (!first
&& (comment
!= file
.description())) {
505 comment
.clear(); // reset comment
507 comment
= file
.description();
510 if (!first
&& (tags
!= file
.tags())) {
511 tags
.clear(); // reset tags
516 if (first
&& (urls
.count() == 1)) {
517 // TODO: show shared meta informations instead
518 // of not showing anything on multiple selections
519 QHash
<QUrl
, Nepomuk::Variant
> properties
= file
.properties();
520 QHash
<QUrl
, Nepomuk::Variant
>::const_iterator it
= properties
.constBegin();
521 while (it
!= properties
.constEnd()) {
522 Nepomuk::Types::Property
prop(it
.key());
523 if (settings
.readEntry(prop
.name(), true)) {
524 // TODO #1: use Nepomuk::formatValue(res, prop) if available
525 // instead of it.value().toString()
526 // TODO #2: using tunedLabel() is a workaround for KDE 4.3 (4.4?) until
527 // we get translated labels
528 metaInfoLabels
.append(tunedLabel(prop
.label()));
529 metaInfoValues
.append(it
.value().toString());
539 m_sharedData
->rating
= rating
;
540 m_sharedData
->comment
= comment
;
541 m_sharedData
->tags
= tags
;
542 m_sharedData
->metaInfoLabels
= metaInfoLabels
;
543 m_sharedData
->metaInfoValues
= metaInfoValues
;
544 m_sharedData
->files
= files
;
547 QString
MetaDataWidget::Private::LoadFilesThread::tunedLabel(const QString
& label
) const
550 const int labelLength
= label
.length();
551 if (labelLength
> 0) {
552 tunedLabel
.reserve(labelLength
);
553 tunedLabel
= label
[0].toUpper();
554 for (int i
= 1; i
< labelLength
; ++i
) {
555 if (label
[i
].isUpper() && !label
[i
- 1].isSpace() && !label
[i
- 1].isUpper()) {
557 tunedLabel
+= label
[i
].toLower();
559 tunedLabel
+= label
[i
];
563 return tunedLabel
+ ':';
566 #endif // HAVE_NEPOMUK
568 MetaDataWidget::MetaDataWidget(QWidget
* parent
) :
574 MetaDataWidget::~MetaDataWidget()
579 void MetaDataWidget::setItem(const KFileItem
& item
)
581 // update values for "type", "size", "modified",
582 // "owner" and "permissions" synchronously
583 d
->m_sizeLabel
->setText(i18nc("@label", "Size:"));
585 d
->m_typeInfo
->setText(i18nc("@label", "Folder"));
586 d
->setRowVisible(d
->m_sizeInfo
, false);
588 d
->m_typeInfo
->setText(item
.mimeComment());
589 d
->m_sizeInfo
->setText(KIO::convertSize(item
.size()));
590 d
->setRowVisible(d
->m_sizeInfo
, true);
592 d
->m_modifiedInfo
->setText(item
.timeString());
593 d
->m_ownerInfo
->setText(item
.user());
594 d
->m_permissionsInfo
->setText(item
.permissionsString());
596 setItems(KFileItemList() << item
);
599 void MetaDataWidget::setItems(const KFileItemList
& items
)
601 d
->m_fileItems
= items
;
603 if (items
.count() > 1) {
604 // calculate the size of all items and show this
605 // information to the user
606 d
->m_sizeLabel
->setText(i18nc("@label", "Total Size:"));
607 d
->setRowVisible(d
->m_sizeInfo
, true);
609 quint64 totalSize
= 0;
610 foreach (const KFileItem
& item
, items
) {
611 if (!item
.isDir() && !item
.isLink()) {
612 totalSize
+= item
.size();
615 d
->m_sizeInfo
->setText(KIO::convertSize(totalSize
));
619 if (Nepomuk::ResourceManager::instance()->init() == 0) {
621 foreach (const KFileItem
& item
, items
) {
622 const KUrl url
= item
.nepomukUri();
627 d
->m_loadFilesThread
->loadFiles(urls
);
632 void MetaDataWidget::setItem(const KUrl
& url
)
634 KFileItem
item(KFileItem::Unknown
, KFileItem::Unknown
, url
);
639 void MetaDataWidget::setItems(const QList
<KUrl
>& urls
)
642 foreach (const KUrl
& url
, urls
) {
643 KFileItem
item(KFileItem::Unknown
, KFileItem::Unknown
, url
);
650 KFileItemList
MetaDataWidget::items() const
652 return d
->m_fileItems
;
655 void MetaDataWidget::setHiddenData(MetaDataTypes data
)
657 d
->m_hiddenData
= data
;
658 d
->updateRowsVisibility();
661 MetaDataWidget::MetaDataTypes
MetaDataWidget::hiddenData() const
663 return d
->m_hiddenData
;
666 unsigned int MetaDataWidget::rating() const
669 QMutexLocker
locker(&d
->m_mutex
);
670 return d
->m_sharedData
.rating
;
676 QList
<Nepomuk::Tag
> MetaDataWidget::tags() const
679 QMutexLocker
locker(&d
->m_mutex
);
680 return d
->m_sharedData
.tags
;
682 return QList
<Nepomuk::Tag
>();
686 QString
MetaDataWidget::comment() const
689 QMutexLocker
locker(&d
->m_mutex
);
690 return d
->m_sharedData
.comment
;
696 #include "metadatawidget.moc"