akonadi

specialcollectionsrequestjob.cpp

00001 /*
00002     Copyright (c) 2009 Constantin Berzan <exit3219@gmail.com>
00003 
00004     This library is free software; you can redistribute it and/or modify it
00005     under the terms of the GNU Library General Public License as published by
00006     the Free Software Foundation; either version 2 of the License, or (at your
00007     option) any later version.
00008 
00009     This library is distributed in the hope that it will be useful, but WITHOUT
00010     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00011     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
00012     License for more details.
00013 
00014     You should have received a copy of the GNU Library General Public License
00015     along with this library; see the file COPYING.LIB.  If not, write to the
00016     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
00017     02110-1301, USA.
00018 */
00019 
00020 #include "specialcollectionsrequestjob.h"
00021 
00022 #include "specialcollectionattribute_p.h"
00023 #include "specialcollections.h"
00024 #include "specialcollections_p.h"
00025 #include "specialcollectionshelperjobs_p.h"
00026 
00027 #include "akonadi/agentmanager.h"
00028 #include "akonadi/collectioncreatejob.h"
00029 #include "akonadi/entitydisplayattribute.h"
00030 
00031 #include <KDebug>
00032 
00033 #include <QtCore/QVariant>
00034 
00035 using namespace Akonadi;
00036 
00040 class Akonadi::SpecialCollectionsRequestJobPrivate
00041 {
00042   public:
00043     SpecialCollectionsRequestJobPrivate( SpecialCollections *collections, SpecialCollectionsRequestJob *qq );
00044 
00045     bool isEverythingReady();
00046     void lockResult( KJob *job ); // slot
00047     void releaseLock(); // slot
00048     void nextResource();
00049     void resourceScanResult( KJob *job ); // slot
00050     void createRequestedFolders( ResourceScanJob *job, QHash<QByteArray, bool> &requestedFolders );
00051     void collectionCreateResult( KJob *job ); // slot
00052 
00053     SpecialCollectionsRequestJob *q;
00054     SpecialCollections *mSpecialCollections;
00055     int mPendingCreateJobs;
00056 
00057     QByteArray mRequestedType;
00058     AgentInstance mRequestedResource;
00059 
00060     // Input:
00061     QHash<QByteArray, bool> mDefaultFolders;
00062     bool mRequestingDefaultFolders;
00063     QHash< QString, QHash<QByteArray, bool> > mFoldersForResource;
00064     QString mDefaultResourceType;
00065     QVariantMap mDefaultResourceOptions;
00066     QList<QByteArray> mKnownTypes;
00067     QMap<QByteArray, QString> mNameForTypeMap;
00068     QMap<QByteArray, QString> mIconForTypeMap;
00069 
00070     // Output:
00071     QStringList mToForget;
00072     QVector< QPair<Collection, QByteArray> > mToRegister;
00073 };
00074 
00075 
00076 
00077 SpecialCollectionsRequestJobPrivate::SpecialCollectionsRequestJobPrivate( SpecialCollections *collections,
00078                                                                           SpecialCollectionsRequestJob *qq )
00079   : q( qq ),
00080     mSpecialCollections( collections ),
00081     mPendingCreateJobs( 0 ),
00082     mRequestingDefaultFolders( false )
00083 {
00084 }
00085 
00086 bool SpecialCollectionsRequestJobPrivate::isEverythingReady()
00087 {
00088   // check if all requested folders are known already
00089   if ( mRequestingDefaultFolders ) {
00090     QHashIterator<QByteArray, bool> it( mDefaultFolders );
00091     while ( it.hasNext() ) {
00092       it.next();
00093       if ( it.value() && !mSpecialCollections->hasDefaultCollection( it.key() ) )
00094         return false;
00095     }
00096   }
00097 
00098   const QStringList resourceIds = mFoldersForResource.keys();
00099   QHashIterator< QString, QHash<QByteArray, bool> > resourceIt( mFoldersForResource );
00100   while ( resourceIt.hasNext() ) {
00101     resourceIt.next();
00102 
00103     const QHash<QByteArray, bool> &requested = resourceIt.value();
00104     QHashIterator<QByteArray, bool> it( requested );
00105     while ( it.hasNext() ) {
00106       it.next();
00107       if ( it.value() && !mSpecialCollections->hasCollection( it.key(), AgentManager::self()->instance( resourceIt.key() ) ) )
00108         return false;
00109     }
00110   }
00111 
00112   kDebug() << "All requested folders already known.";
00113   return true;
00114 }
00115 
00116 void SpecialCollectionsRequestJobPrivate::lockResult( KJob *job )
00117 {
00118   if ( job->error() ) {
00119     kWarning() << "Failed to get lock:" << job->errorString();
00120     q->setError( job->error() );
00121     q->setErrorText( job->errorString() );
00122     q->emitResult();
00123     return;
00124   }
00125 
00126   if ( mRequestingDefaultFolders ) {
00127     // If default folders are requested, deal with that first.
00128     DefaultResourceJob *resjob = new DefaultResourceJob( mSpecialCollections->d->mSettings, q );
00129     resjob->setDefaultResourceType( mDefaultResourceType );
00130     resjob->setDefaultResourceOptions( mDefaultResourceOptions );
00131     resjob->setTypes( mKnownTypes );
00132     resjob->setNameForTypeMap( mNameForTypeMap );
00133     resjob->setIconForTypeMap( mIconForTypeMap );
00134     QObject::connect( resjob, SIGNAL( result( KJob* ) ), q, SLOT( resourceScanResult( KJob* ) ) );
00135   } else {
00136     // If no default folders are requested, go straight to the next step.
00137     nextResource();
00138   }
00139 }
00140 
00141 void SpecialCollectionsRequestJobPrivate::releaseLock()
00142 {
00143   const bool ok = Akonadi::releaseLock();
00144   if ( !ok ) {
00145     kWarning() << "WTF, can't release lock.";
00146   }
00147 }
00148 
00149 void SpecialCollectionsRequestJobPrivate::nextResource()
00150 {
00151   if ( mFoldersForResource.isEmpty() ) {
00152     kDebug() << "All done! Comitting.";
00153 
00154     mSpecialCollections->d->beginBatchRegister();
00155 
00156     // Forget everything we knew before about these resources.
00157     foreach ( const QString &resourceId, mToForget ) {
00158       mSpecialCollections->d->forgetFoldersForResource( resourceId );
00159     }
00160 
00161     // Register all the collections that we fetched / created.
00162     typedef QPair<Collection, QByteArray> RegisterPair;
00163     foreach ( const RegisterPair &pair, mToRegister ) {
00164       const bool ok = mSpecialCollections->registerCollection( pair.second, pair.first );
00165       Q_ASSERT( ok );
00166       Q_UNUSED( ok );
00167     }
00168 
00169     mSpecialCollections->d->endBatchRegister();
00170 
00171     // Release the lock once the transaction has been committed.
00172     QObject::connect( q, SIGNAL( result( KJob* ) ), q, SLOT( releaseLock() ) );
00173 
00174     // We are done!
00175     q->commit();
00176 
00177   } else {
00178     const QString resourceId = mFoldersForResource.keys().first();
00179     kDebug() << "A resource is done," << mFoldersForResource.count()
00180              << "more to do. Now doing resource" << resourceId;
00181     ResourceScanJob *resjob = new ResourceScanJob( resourceId, mSpecialCollections->d->mSettings, q );
00182     QObject::connect( resjob, SIGNAL( result( KJob* ) ), q, SLOT( resourceScanResult( KJob* ) ) );
00183   }
00184 }
00185 
00186 void SpecialCollectionsRequestJobPrivate::resourceScanResult( KJob *job )
00187 {
00188   ResourceScanJob *resjob = qobject_cast<ResourceScanJob*>( job );
00189   Q_ASSERT( resjob );
00190 
00191   const QString resourceId = resjob->resourceId();
00192   kDebug() << "resourceId" << resourceId;
00193 
00194   if ( job->error() ) {
00195     kWarning() << "Failed to request resource" << resourceId << ":" << job->errorString();
00196     return;
00197   }
00198 
00199   if ( qobject_cast<DefaultResourceJob*>( job ) ) {
00200     // This is the default resource.
00201     Q_ASSERT( resourceId == mSpecialCollections->d->defaultResourceId() );
00202     //mToForget.append( mSpecialCollections->defaultResourceId() );
00203     createRequestedFolders( resjob, mDefaultFolders );
00204   } else {
00205     // This is not the default resource.
00206     QHash<QByteArray, bool> requestedFolders = mFoldersForResource[ resourceId ];
00207     mFoldersForResource.remove( resourceId );
00208     createRequestedFolders( resjob, requestedFolders );
00209   }
00210 }
00211 
00212 void SpecialCollectionsRequestJobPrivate::createRequestedFolders( ResourceScanJob *scanJob,
00213                                                                   QHash<QByteArray, bool> &requestedFolders )
00214 {
00215   // Remove from the request list the folders which already exist.
00216   foreach ( const Collection &collection, scanJob->specialCollections() ) {
00217     Q_ASSERT( collection.hasAttribute<SpecialCollectionAttribute>() );
00218     const SpecialCollectionAttribute *attr = collection.attribute<SpecialCollectionAttribute>();
00219     const QByteArray type = attr->collectionType();
00220 
00221     if ( !type.isEmpty() ) {
00222       mToRegister.append( qMakePair( collection, type ) );
00223       requestedFolders.insert( type, false );
00224     }
00225   }
00226   mToForget.append( scanJob->resourceId() );
00227 
00228   // Folders left in the request list must be created.
00229   Q_ASSERT( mPendingCreateJobs == 0 );
00230   Q_ASSERT( scanJob->rootResourceCollection().isValid() );
00231 
00232   QHashIterator<QByteArray, bool> it( requestedFolders );
00233   while ( it.hasNext() ) {
00234     it.next();
00235 
00236     if ( it.value() ) {
00237       Collection collection;
00238       collection.setParentCollection( scanJob->rootResourceCollection() );
00239       collection.setName( mNameForTypeMap.value( it.key() ) );
00240 
00241       setCollectionAttributes( collection, it.key(), mNameForTypeMap, mIconForTypeMap );
00242 
00243       CollectionCreateJob *createJob = new CollectionCreateJob( collection, q );
00244       createJob->setProperty( "type", it.key() );
00245       QObject::connect( createJob, SIGNAL( result( KJob* ) ), q, SLOT( collectionCreateResult( KJob* ) ) );
00246 
00247       mPendingCreateJobs++;
00248     }
00249   }
00250 
00251   if ( mPendingCreateJobs == 0 )
00252     nextResource();
00253 }
00254 
00255 void SpecialCollectionsRequestJobPrivate::collectionCreateResult( KJob *job )
00256 {
00257   if ( job->error() ) {
00258     kWarning() << "Failed CollectionCreateJob." << job->errorString();
00259     return;
00260   }
00261 
00262   CollectionCreateJob *createJob = qobject_cast<CollectionCreateJob*>( job );
00263   Q_ASSERT( createJob );
00264 
00265   const Collection collection = createJob->collection();
00266   mToRegister.append( qMakePair( collection, createJob->property( "type" ).toByteArray() ) );
00267 
00268   Q_ASSERT( mPendingCreateJobs > 0 );
00269   mPendingCreateJobs--;
00270   kDebug() << "mPendingCreateJobs now" << mPendingCreateJobs;
00271 
00272   if ( mPendingCreateJobs == 0 )
00273     nextResource();
00274 }
00275 
00276 
00277 
00278 // TODO KDE5: do not inherit from TransactionSequence
00279 SpecialCollectionsRequestJob::SpecialCollectionsRequestJob( SpecialCollections *collections, QObject *parent )
00280   : TransactionSequence( parent ),
00281     d( new SpecialCollectionsRequestJobPrivate( collections, this ) )
00282 {
00283   setProperty( "transactionsDisabled", true );
00284 }
00285 
00286 SpecialCollectionsRequestJob::~SpecialCollectionsRequestJob()
00287 {
00288   delete d;
00289 }
00290 
00291 void SpecialCollectionsRequestJob::requestDefaultCollection( const QByteArray &type )
00292 {
00293   d->mDefaultFolders[ type ] = true;
00294   d->mRequestingDefaultFolders = true;
00295   d->mRequestedType = type;
00296 }
00297 
00298 void SpecialCollectionsRequestJob::requestCollection( const QByteArray &type, const AgentInstance &instance )
00299 {
00300   if ( !d->mFoldersForResource.contains( instance.identifier() ) ) {
00301     // This resource was previously unknown.
00302     d->mFoldersForResource[ instance.identifier() ] = QHash<QByteArray, bool>();
00303   }
00304   d->mFoldersForResource[ instance.identifier() ][ type ] = true;
00305 
00306   d->mRequestedType = type;
00307   d->mRequestedResource = instance;
00308 }
00309 
00310 Collection SpecialCollectionsRequestJob::collection() const
00311 {
00312   if ( d->mRequestedResource.isValid() )
00313     return d->mSpecialCollections->collection( d->mRequestedType, d->mRequestedResource );
00314   else
00315     return d->mSpecialCollections->defaultCollection( d->mRequestedType );
00316 }
00317 
00318 void SpecialCollectionsRequestJob::setDefaultResourceType( const QString &type )
00319 {
00320   d->mDefaultResourceType = type;
00321 }
00322 
00323 void SpecialCollectionsRequestJob::setDefaultResourceOptions( const QVariantMap &options )
00324 {
00325   d->mDefaultResourceOptions = options;
00326 }
00327 
00328 void SpecialCollectionsRequestJob::setTypes( const QList<QByteArray> &types )
00329 {
00330   d->mKnownTypes = types;
00331 }
00332 
00333 void SpecialCollectionsRequestJob::setNameForTypeMap( const QMap<QByteArray, QString> &map )
00334 {
00335   d->mNameForTypeMap = map;
00336 }
00337 
00338 void SpecialCollectionsRequestJob::setIconForTypeMap( const QMap<QByteArray, QString> &map )
00339 {
00340   d->mIconForTypeMap = map;
00341 }
00342 
00343 void SpecialCollectionsRequestJob::doStart()
00344 {
00345   if ( d->isEverythingReady() ) {
00346     emitResult();
00347   } else {
00348     GetLockJob *lockJob = new GetLockJob( this );
00349     connect( lockJob, SIGNAL( result( KJob* ) ), this, SLOT( lockResult( KJob* ) ) );
00350     lockJob->start();
00351   }
00352 }
00353 
00354 void SpecialCollectionsRequestJob::slotResult( KJob *job )
00355 {
00356   if ( job->error() ) {
00357     // If we failed, let others try.
00358     kWarning() << "Failed SpecialCollectionsRequestJob::slotResult" << job->errorString();
00359 
00360     d->releaseLock();
00361   }
00362   TransactionSequence::slotResult( job );
00363 }
00364 
00365 #include "specialcollectionsrequestjob.moc"
akonadi

specialcollectionsrequestjob.cpp

akonadi

KDE-PIM Libraries
