00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00023
00024 #ifndef __KMAIL_IMAPACCOUNTBASE_H__
00025 #define __KMAIL_IMAPACCOUNTBASE_H__
00026
00027 #include <set>
00028
00029 #include "networkaccount.h"
00030
00031 #include <qtimer.h>
00032 #include <qguardedptr.h>
00033 #include <kio/global.h>
00034
00035 class AccountManager;
00036 class KMFolder;
00037 class KConfig;
00038 class KMMessagePart;
00039 class DwBodyPart;
00040 class DwMessage;
00041 class FolderStorage;
00042 template <typename T> class QValueVector;
00043
00044 namespace KIO {
00045 class Job;
00046 }
00047
00048 namespace KPIM {
00049 class ProgressItem;
00050 }
00051
00052 namespace KMail {
00053 struct ACLListEntry;
00054 struct QuotaInfo;
00055 typedef QValueVector<KMail::ACLListEntry> ACLList;
00056
00057 class AttachmentStrategy;
00058
00059 class ImapAccountBase : public KMail::NetworkAccount {
00060 Q_OBJECT
00061 protected:
00062 ImapAccountBase( AccountManager * parent, const QString & name, uint id );
00063 public:
00064 virtual ~ImapAccountBase();
00065
00067 virtual void init();
00068
00070 virtual void pseudoAssign( const KMAccount * a );
00071
00074 bool autoExpunge() const { return mAutoExpunge; }
00075 virtual void setAutoExpunge( bool expunge );
00076
00078 bool hiddenFolders() const { return mHiddenFolders; }
00079 virtual void setHiddenFolders( bool show );
00080
00082 bool onlySubscribedFolders() const { return mOnlySubscribedFolders; }
00083 virtual void setOnlySubscribedFolders( bool show );
00084
00086 bool onlyLocallySubscribedFolders() const { return mOnlyLocallySubscribedFolders; }
00087 virtual void setOnlyLocallySubscribedFolders( bool show );
00088
00089
00091 bool loadOnDemand() const { return mLoadOnDemand; }
00092 virtual void setLoadOnDemand( bool load );
00093
00095 bool listOnlyOpenFolders() const { return mListOnlyOpenFolders; }
00096 virtual void setListOnlyOpenFolders( bool only );
00097
00099 virtual KIO::MetaData slaveConfig() const;
00100
00101 virtual void readConfig( KConfig& config );
00102 virtual void writeConfig( KConfig& config );
00103
00107 enum ConnectionState { Error = 0, Connected, Connecting };
00108
00109
00110 enum ListType {
00111 List,
00112 ListSubscribed,
00113 ListSubscribedNoCheck,
00114 ListFolderOnly,
00115 ListFolderOnlySubscribed
00116 };
00117
00124 ConnectionState makeConnection();
00125
00126
00127 enum imapNamespace { PersonalNS=0, OtherUsersNS=1, SharedNS=2 };
00128
00129
00130 typedef QMap<imapNamespace, QStringList> nsMap;
00131
00132
00133 typedef QMap<QString, QString> namespaceDelim;
00134
00135
00136 typedef QMap<imapNamespace, namespaceDelim> nsDelimMap;
00137
00141 struct jobData
00142 {
00143
00144 jobData() : url(QString::null), parent(0), total(1), done(0), offset(0), progressItem(0),
00145 onlySubscribed(false), quiet(false), cancellable(false) {}
00146
00147 jobData( const QString& _url, KMFolder *_parent = 0,
00148 int _total = 1, int _done = 0, bool _quiet = false,
00149 bool _cancelable = false )
00150 : url(_url), parent(_parent), total(_total), done(_done), offset(0),
00151 progressItem(0), quiet(_quiet), cancellable(_cancelable) {}
00152
00153
00154 QString htmlURL() const;
00155
00156 QString path;
00157 QString url;
00158 QString curNamespace;
00159 QByteArray data;
00160 QCString cdata;
00161 QStringList items;
00162 KMFolder *parent;
00163 QPtrList<KMMessage> msgList;
00164 int total, done, offset;
00165 KPIM::ProgressItem *progressItem;
00166 bool onlySubscribed, quiet, cancellable;
00167 };
00168
00169 typedef QMap<KIO::Job *, jobData>::Iterator JobIterator;
00173 void insertJob( KIO::Job* job, const jobData& data ) {
00174 mapJobData.insert( job, data );
00175 }
00179 JobIterator findJob( KIO::Job* job ) { return mapJobData.find( job ); }
00180 JobIterator jobsEnd() { return mapJobData.end(); }
00185 void removeJob( JobIterator& it );
00186
00187 void removeJob( KIO::Job* job );
00188
00194 void changeSubscription(bool subscribe, const QString& imapPath);
00195
00200 bool locallySubscribedTo( const QString& imapPath );
00201
00206 void changeLocalSubscription( const QString& imapPath, bool subscribe );
00207
00208
00214 void getUserRights( KMFolder* folder, const QString& imapPath );
00215
00221 void getACL( KMFolder* folder, const QString& imapPath );
00222
00228 void getStorageQuotaInfo( KMFolder* folder, const QString& imapPath );
00229
00234 void setImapStatus( KMFolder* folder, const QString& path, const QCString& flags );
00235
00240 void setImapSeenStatus( KMFolder* folder, const QString& path, bool seen );
00241
00245 void slaveDied() { mSlave = 0; killAllJobs(); }
00246
00250 void killAllJobs( bool disconnectSlave=false ) = 0;
00251
00255 virtual void cancelMailCheck();
00256
00260 void processNewMailSingleFolder(KMFolder* folder);
00261
00265 bool checkingSingleFolder() { return mCheckingSingleFolder; }
00266
00271 void postProcessNewMail( bool setStatusMsg = true );
00272
00277 bool checkingMail( KMFolder *folder );
00278
00279 bool checkingMail() { return NetworkAccount::checkingMail(); }
00280
00284 void handleBodyStructure( QDataStream & stream, KMMessage * msg,
00285 const AttachmentStrategy *as );
00286
00290 virtual void setFolder(KMFolder*, bool addAccount = false);
00291
00296 bool hasACLSupport() const { return mACLSupport; }
00297
00302 bool hasAnnotationSupport() const { return mAnnotationSupport; }
00303
00307 void setHasNoAnnotationSupport() { mAnnotationSupport = false; }
00308
00313 bool hasQuotaSupport() const { return mQuotaSupport; }
00314
00318 void setHasNoQuotaSupport() { mQuotaSupport = false; }
00319
00324 bool handleJobError( KIO::Job* job, const QString& context, bool abortSync = false );
00325
00329 virtual FolderStorage* const rootFolder() const = 0;
00330
00334 KPIM::ProgressItem* listDirProgressItem();
00335
00340 virtual unsigned int folderCount() const;
00341
00345 nsMap namespaces() const { return mNamespaces; }
00346
00350 virtual void setNamespaces( nsMap map )
00351 { mNamespaces = map; }
00352
00357 nsDelimMap namespacesWithDelimiter();
00358
00362 QString namespaceForFolder( FolderStorage* );
00363
00367 QString addPathToNamespace( const QString& ns );
00368
00372 QString delimiterForNamespace( const QString& prefix );
00373
00377 QString delimiterForFolder( FolderStorage* );
00378
00382 namespaceDelim namespaceToDelimiter() const
00383 { return mNamespaceToDelimiter; }
00384
00388 void setNamespaceToDelimiter( namespaceDelim map )
00389 { mNamespaceToDelimiter = map; }
00390
00394 bool isNamespaceFolder( QString& name );
00395
00399 bool hasCapability( const QString& capa ) {
00400 return mCapabilities.contains( capa ); }
00401
00407 QString createImapPath( FolderStorage* parent, const QString& folderName );
00408
00412 QString createImapPath( const QString& parent, const QString& folderName );
00413
00414
00415 public slots:
00420 void getNamespaces();
00421
00422 private slots:
00427 void slotSubscriptionResult(KIO::Job * job);
00428
00429 protected slots:
00430 virtual void slotCheckQueuedFolders();
00431
00433 void slotSchedulerSlaveConnected(KIO::Slave *aSlave);
00435 void slotSchedulerSlaveError(KIO::Slave *aSlave, int, const QString &errorMsg);
00436
00440 void slotSetStatusResult(KIO::Job * job);
00441
00443 void slotGetUserRightsResult( KIO::Job* _job );
00444
00446 void slotGetACLResult( KIO::Job* _job );
00447
00449 void slotGetStorageQuotaInfoResult( KIO::Job* _job );
00450
00454 void slotNoopTimeout();
00458 void slotIdleTimeout();
00459
00463 void slotAbortRequested( KPIM::ProgressItem* );
00464
00468 void slotSimpleResult(KIO::Job * job);
00469
00471 void slotNamespaceResult( KIO::Job*, const QString& str );
00472
00476 void slotSaveNamespaces( const ImapAccountBase::nsDelimMap& map );
00477
00481 void slotCapabilitiesResult( KIO::Job*, const QString& result );
00482
00483 protected:
00484
00501 virtual bool handleError( int error, const QString &errorMsg, KIO::Job* job, const QString& context, bool abortSync = false );
00502
00504 bool handlePutError( KIO::Job* job, jobData& jd, KMFolder* folder );
00505
00506 virtual QString protocol() const;
00507 virtual unsigned short int defaultPort() const;
00508
00512 void constructParts( QDataStream & stream, int count, KMMessagePart* parentKMPart,
00513 DwBodyPart * parent, const DwMessage * dwmsg );
00514
00516 void migratePrefix();
00517
00518
00519 QStringList locallyBlacklistedFolders() const;
00520 void localBlacklistFromStringList( const QStringList & );
00521
00522 protected:
00523 QPtrList<QGuardedPtr<KMFolder> > mOpenFolders;
00524 QStringList mSubfolderNames, mSubfolderPaths,
00525 mSubfolderMimeTypes, mSubfolderAttributes;
00526 QMap<KIO::Job *, jobData> mapJobData;
00528 QTimer mIdleTimer;
00530 QTimer mNoopTimer;
00531 int mTotal, mCountUnread, mCountLastUnread;
00532 QMap<QString, int> mUnreadBeforeCheck;
00533 bool mAutoExpunge : 1;
00534 bool mHiddenFolders : 1;
00535 bool mOnlySubscribedFolders : 1;
00536 bool mOnlyLocallySubscribedFolders : 1;
00537 bool mLoadOnDemand : 1;
00538 bool mListOnlyOpenFolders : 1;
00539 bool mProgressEnabled : 1;
00540
00541 bool mErrorDialogIsActive : 1;
00542 bool mPasswordDialogIsActive : 1;
00543 bool mACLSupport : 1;
00544 bool mAnnotationSupport : 1;
00545 bool mQuotaSupport : 1;
00546 bool mSlaveConnected : 1;
00547 bool mSlaveConnectionError : 1;
00548 bool mCheckingSingleFolder : 1;
00549
00550
00551 QValueList<QGuardedPtr<KMFolder> > mMailCheckFolders;
00552
00553 QValueList<QGuardedPtr<KMFolder> > mFoldersQueuedForChecking;
00554
00555 QPtrList<KMMessagePart> mBodyPartList;
00556
00557 KMMessage* mCurrentMsg;
00558
00559 QGuardedPtr<KPIM::ProgressItem> mListDirProgressItem;
00560
00561
00562 nsMap mNamespaces;
00563
00564
00565 namespaceDelim mNamespaceToDelimiter;
00566
00567
00568 QString mOldPrefix;
00569
00570
00571 QStringList mCapabilities;
00572
00573 std::set<QString> mLocalSubscriptionBlackList;
00574
00575 signals:
00582 void connectionResult( int errorCode, const QString& errorMsg );
00583
00588 void subscriptionChanged(const QString& imapPath, bool subscribed);
00589
00595 void imapStatusChanged( KMFolder*, const QString& imapPath, bool cont );
00596
00602 void receivedUserRights( KMFolder* folder );
00603
00611 void receivedACL( KMFolder* folder, KIO::Job* job, const KMail::ACLList& entries );
00612
00621 void receivedStorageQuotaInfo( KMFolder* folder, KIO::Job* job, const KMail::QuotaInfo& entries );
00622
00626 void namespacesFetched( const ImapAccountBase::nsDelimMap& );
00627
00631 void namespacesFetched();
00632 };
00633
00634
00635 }
00636
00637 #endif // __KMAIL_IMAPACCOUNTBASE_H__