src/panels/information/metadatawidget.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2007 by Sebastian Trueg <trueg@kde.org>                 *
   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 "metadatawidget.h"
  21
  22 #include "commentwidget.h"
  23
  24 #include <config-nepomuk.h>
  25
  26 #include <klocale.h>
  27 #include <KDebug>
  28 #include <KMessageBox>
  29
  30 #include <QtCore/QEvent>
  31 #include <QtCore/QMutex>
  32 #include <QtCore/QMutexLocker>
  33 #include <QtCore/QThread>
  34 #include <QtGui/QLabel>
  35 #include <QtGui/QGridLayout>
  36 #include <QtGui/QTextEdit>
  37
  38 #ifdef HAVE_NEPOMUK
  39 #include "nepomukmassupdatejob.h"
  40 #include <nepomuk/kmetadatatagwidget.h>
  41 #include <nepomuk/resourcemanager.h>
  42 #include <nepomuk/resource.h>
  43 #include <nepomuk/variant.h>
  44 #include <nepomuk/kratingwidget.h>
  45 #include <Soprano/Vocabulary/Xesam>
  46 #include "resourcetaggingwidget.h"
  47 #endif
  48
  49
  50 bool MetaDataWidget::metaDataAvailable()
  51 {
  52 #ifdef HAVE_NEPOMUK
  53     return !Nepomuk::ResourceManager::instance()->init();
  54 #else
  55     return false;
  56 #endif
  57 }
  58
  59
  60 class MetaDataWidget::Private
  61 {
  62 public:
  63 #ifdef HAVE_NEPOMUK
  64     void loadComment(const QString& comment);
  65
  66     CommentWidget* editComment;
  67     KRatingWidget* ratingWidget;
  68     Nepomuk::ResourceTaggingWidget* tagWidget;
  69
  70     // shared data between the GUI-thread and
  71     // the loader-thread (see LoadFilesThread):
  72     QMutex mutex;
  73     struct SharedData
  74     {
  75         int rating;
  76         QString comment;
  77         QList<Nepomuk::Resource> fileRes;
  78         QMap<KUrl, Nepomuk::Resource> files;
  79     } sharedData;
  80
  81     /**
  82      * Loads the meta data of files and writes
  83      * the result into a shared data pool that
  84      * can be used by the widgets in the GUI thread.
  85      */
  86     class LoadFilesThread : public QThread
  87     {
  88     public:
  89         LoadFilesThread(SharedData* sharedData, QMutex* mutex);
  90         ~LoadFilesThread();
  91         void loadFiles(const KUrl::List& urls);
  92         virtual void run();
  93
  94     private:
  95         SharedData* m_sharedData;
  96         QMutex* m_mutex;
  97         KUrl::List m_urls;
  98         bool m_canceled;
  99     };
 100
 101     LoadFilesThread* loadFilesThread;
 102 #endif
 103 };
 104
 105 #ifdef HAVE_NEPOMUK
 106 void MetaDataWidget::Private::loadComment(const QString& comment)
 107 {
 108     editComment->setComment( comment );
 109 }
 110
 111 MetaDataWidget::Private::LoadFilesThread::LoadFilesThread(
 112     MetaDataWidget::Private::SharedData* sharedData,
 113     QMutex* mutex) :
 114     m_sharedData(sharedData),
 115     m_mutex(mutex),
 116     m_urls(),
 117     m_canceled(false)
 118 {
 119 }
 120
 121 MetaDataWidget::Private::LoadFilesThread::~LoadFilesThread()
 122 {
 123     // this thread may very well be deleted during execution. We need
 124     // to protect it from crashes here
 125     m_canceled = true;
 126     wait();
 127 }
 128
 129 void MetaDataWidget::Private::LoadFilesThread::loadFiles(const KUrl::List& urls)
 130 {
 131     QMutexLocker locker( m_mutex );
 132     m_urls = urls;
 133     m_canceled = false;
 134     start();
 135 }
 136
 137 void MetaDataWidget::Private::LoadFilesThread::run()
 138 {
 139     QMutexLocker locker( m_mutex );
 140     const KUrl::List urls = m_urls;
 141     locker.unlock();
 142
 143     bool first = true;
 144     QList<Nepomuk::Resource> fileRes;
 145     QMap<KUrl, Nepomuk::Resource> files;
 146     unsigned int rating = 0;
 147     QString comment;
 148     Q_FOREACH( const KUrl &url, urls ) {
 149         if ( m_canceled )
 150             return;
 151         Nepomuk::Resource file( url, Soprano::Vocabulary::Xesam::File() );
 152         files.insert( url, file );
 153         fileRes.append( file );
 154
 155         if ( !first && rating != file.rating() ) {
 156             rating = 0; // reset rating
 157         }
 158         else if ( first ) {
 159             rating = file.rating();
 160         }
 161
 162         if ( !first && comment != file.description() ) {
 163             comment.clear();
 164         }
 165         else if ( first ) {
 166             comment = file.description();
 167         }
 168         first = false;
 169     }
 170
 171     locker.relock();
 172     m_sharedData->rating = rating;
 173     m_sharedData->comment = comment;
 174     m_sharedData->fileRes = fileRes;
 175     m_sharedData->files = files;
 176 }
 177 #endif
 178
 179 MetaDataWidget::MetaDataWidget(QWidget* parent) :
 180     QWidget(parent)
 181 {
 182 #ifdef HAVE_NEPOMUK
 183     d = new Private;
 184     d->editComment = new CommentWidget(this);
 185     d->editComment->setFocusPolicy(Qt::ClickFocus);
 186     d->ratingWidget = new KRatingWidget(this);
 187     d->ratingWidget->setAlignment( Qt::AlignCenter );
 188     d->tagWidget = new Nepomuk::ResourceTaggingWidget(this);
 189     connect(d->ratingWidget, SIGNAL(ratingChanged(unsigned int)), this, SLOT(slotRatingChanged(unsigned int)));
 190     connect(d->editComment, SIGNAL(commentChanged(const QString&)), this, SLOT(slotCommentChanged(const QString&)));
 191     connect( d->tagWidget, SIGNAL( tagClicked( const Nepomuk::Tag& ) ), this, SLOT( slotTagClicked( const Nepomuk::Tag& ) ) );
 192
 193     d->sharedData.rating = 0;
 194     d->loadFilesThread = new Private::LoadFilesThread(&d->sharedData, &d->mutex);
 195     connect(d->loadFilesThread, SIGNAL(finished()), this, SLOT(slotLoadingFinished()));
 196
 197     QVBoxLayout* lay = new QVBoxLayout(this);
 198     lay->setMargin(0);
 199     lay->addWidget(d->ratingWidget);
 200     lay->addWidget(d->editComment);
 201     lay->addWidget( d->tagWidget );
 202 #else
 203     d = 0;
 204 #endif
 205 }
 206
 207
 208 MetaDataWidget::~MetaDataWidget()
 209 {
 210 #ifdef HAVE_NEPOMUK
 211     delete d->loadFilesThread;
 212 #endif
 213     delete d;
 214 }
 215
 216 void MetaDataWidget::setRatingVisible(bool visible)
 217 {
 218 #ifdef HAVE_NEPOMUK
 219     d->ratingWidget->setVisible(visible);
 220 #else
 221     Q_UNUSED(visible);
 222 #endif
 223 }
 224
 225
 226 bool MetaDataWidget::isRatingVisible() const
 227 {
 228 #ifdef HAVE_NEPOMUK
 229     return d->ratingWidget->isVisible();
 230 #else
 231     return false;
 232 #endif
 233 }
 234
 235
 236 void MetaDataWidget::setCommentVisible(bool visible)
 237 {
 238 #ifdef HAVE_NEPOMUK
 239     d->editComment->setVisible(visible);
 240 #else
 241     Q_UNUSED(visible);
 242 #endif
 243 }
 244
 245
 246 bool MetaDataWidget::isCommentVisible() const
 247 {
 248 #ifdef HAVE_NEPOMUK
 249     return d->editComment->isVisible();
 250 #else
 251     return false;
 252 #endif
 253 }
 254
 255
 256 void MetaDataWidget::setTagsVisible(bool visible)
 257 {
 258 #ifdef HAVE_NEPOMUK
 259     d->tagWidget->setVisible(visible);
 260 #else
 261     Q_UNUSED(visible);
 262 #endif
 263 }
 264
 265
 266 bool MetaDataWidget::areTagsVisible() const
 267 {
 268 #ifdef HAVE_NEPOMUK
 269     return d->tagWidget->isVisible();
 270 #else
 271     return false;
 272 #endif
 273 }
 274
 275
 276 void MetaDataWidget::setFile(const KUrl& url)
 277 {
 278     kDebug() << url;
 279     KUrl::List urls;
 280     urls.append( url );
 281     setFiles( urls );
 282 }
 283
 284 void MetaDataWidget::setFiles(const KUrl::List& urls)
 285 {
 286 #ifdef HAVE_NEPOMUK
 287     d->loadFilesThread->loadFiles( urls );
 288 #else
 289     Q_UNUSED( urls );
 290 #endif
 291 }
 292
 293
 294 void MetaDataWidget::slotCommentChanged( const QString& s )
 295 {
 296 #ifdef HAVE_NEPOMUK
 297     QMutexLocker locker( &d->mutex );
 298     Nepomuk::MassUpdateJob* job = Nepomuk::MassUpdateJob::commentResources( d->sharedData.files.values(), s );
 299     connect( job, SIGNAL( result( KJob* ) ),
 300              this, SLOT( metadataUpdateDone() ) );
 301     setEnabled( false ); // no updates during execution
 302     job->start();
 303 #else
 304     Q_UNUSED( s );
 305 #endif
 306 }
 307
 308
 309 void MetaDataWidget::slotRatingChanged(unsigned int rating)
 310 {
 311 #ifdef HAVE_NEPOMUK
 312     QMutexLocker locker( &d->mutex );
 313     Nepomuk::MassUpdateJob* job = Nepomuk::MassUpdateJob::rateResources( d->sharedData.files.values(), rating );
 314     connect( job, SIGNAL( result( KJob* ) ),
 315              this, SLOT( metadataUpdateDone() ) );
 316     setEnabled( false ); // no updates during execution
 317     job->start();
 318 #else
 319     Q_UNUSED( rating );
 320 #endif
 321 }
 322
 323
 324 void MetaDataWidget::metadataUpdateDone()
 325 {
 326     setEnabled( true );
 327 }
 328
 329
 330 bool MetaDataWidget::eventFilter(QObject* obj, QEvent* event)
 331 {
 332     return QWidget::eventFilter(obj, event);
 333 }
 334
 335
 336 void MetaDataWidget::slotTagClicked( const Nepomuk::Tag& tag )
 337 {
 338     Q_UNUSED( tag );
 339 #ifdef HAVE_NEPOMUK
 340     d->tagWidget->showTagPopup( QCursor::pos() );
 341 #endif
 342 }
 343
 344 void MetaDataWidget::slotLoadingFinished()
 345 {
 346 #ifdef HAVE_NEPOMUK
 347     QMutexLocker locker( &d->mutex );
 348     d->ratingWidget->setRating( d->sharedData.rating );
 349     d->loadComment( d->sharedData.comment );
 350     d->tagWidget->setResources( d->sharedData.fileRes );
 351 #endif
 352 }
 353
 354 #include "metadatawidget.moc"