kmfolder.h

/*
 * kmail: KDE mail client
 * Copyright (c) 1996-1998 Stefan Taferner <taferner@kde.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */
#ifndef kmfolder_h
#define kmfolder_h
 
// for large file support
#include <config.h>
 
#include "kmfoldernode.h"
#include "kmfoldertype.h"
#include "kmmsginfo.h"
#include "kmglobal.h"
#include "kmkernel.h"
#include "folderjob.h"
using KMail::FolderJob;
#include "mailinglist-magic.h"
using KMail::MailingList;
#include "kmaccount.h" // for AccountList
 
#include "mimelib/string.h"
 
#include <tqptrvector.h>
#include <sys/types.h>
#include <stdio.h>
#include <tdeshortcut.h>
 
class KMMessage;
class KMFolderDir;
class TQTimer;
class FolderStorage;
class KMFolderTreeItem;
class KMFolderJob;
 
namespace KMail {
   class AttachmentStrategy;
}
using KMail::AttachmentStrategy;
 
typedef TQValueList<TQ_UINT32> SerNumList;
 
class KMFolder: public KMFolderNode
{
  TQ_OBJECT
  
  friend class ::KMFolderJob;
public:
 
  KMFolder( KMFolderDir* parent, const TQString& name,
                KMFolderType aFolderType, bool withIndex = true,
                bool exportedSernums = true );
  ~KMFolder();
 
  bool isMainInbox() {
    return this == KMKernel::self()->inboxFolder();
  }
  bool isOutbox() {
    return this == KMKernel::self()->outboxFolder();
  }
  bool isSent() {
    return KMKernel::self()->folderIsSentMailFolder( this );
  }
  bool isTrash() {
    return KMKernel::self()->folderIsTrash( this );
  }
  bool isDrafts() {
    return KMKernel::self()->folderIsDrafts( this );
  }
  bool isTemplates() {
    return KMKernel::self()->folderIsTemplates( this );
  }
 
  void setAcctList( AccountList* list ) { mAcctList = list; }
  AccountList* acctList() { return mAcctList; }
 
  bool hasAccounts() const { return (mAcctList != 0); }
 
  void readConfig( TDEConfig* config );
 
  void writeConfig( TDEConfig* config ) const;
 
  FolderStorage* storage() { return mStorage; }
  const FolderStorage* storage() const { return mStorage; }
 
  KMFolderType folderType() const;
 
  TQString fileName() const;
 
  TQString location() const;
 
  TQString indexLocation() const;
 
  TQString subdirLocation() const;
 
  KMFolderDir* child() const
    { return mChild; }
 
  KMFolderDir* createChildFolder();
 
  void setChild( KMFolderDir* aChild );
 
  bool noContent() const;
 
  void setNoContent(bool aNoContent);
 
  bool noChildren() const;
 
  void setNoChildren(bool aNoChildren);
 
  KMMessage* getMsg(int idx);
 
  KMMsgInfo* unGetMsg(int idx);
 
  bool isMessage(int idx);
 
  DwString getDwString(int idx);
 
  void ignoreJobsForMessage( KMMessage* );
 
  FolderJob* createJob( KMMessage *msg, FolderJob::JobType jt = FolderJob::tGetMessage,
                        KMFolder *folder = 0, TQString partSpecifier = TQString(),
                        const AttachmentStrategy *as = 0 ) const;
  FolderJob* createJob( TQPtrList<KMMessage>& msgList, const TQString& sets,
                        FolderJob::JobType jt = FolderJob::tGetMessage,
                        KMFolder *folder = 0 ) const;
 
  const KMMsgBase* getMsgBase(int idx) const;
  KMMsgBase* getMsgBase(int idx);
 
  const KMMsgBase* operator[](int idx) const;
 
  KMMsgBase* operator[](int idx);
 
  KMMessage* take(int idx);
  void take(TQPtrList<KMMessage> msgList);
 
  int addMsg(KMMessage* msg, int* index_return = 0);
 
  int addMsgKeepUID(KMMessage* msg, int* index_return = 0);
 
  int addMsg(TQPtrList<KMMessage>&, TQValueList<int>& index_return);
 
  void emitMsgAddedSignals(int idx);
 
  void removeMsg(int i, bool imapQuiet = false);
  void removeMsg(TQPtrList<KMMessage> msgList, bool imapQuiet = false);
 
  int expungeOldMsg(int days);
 
  int moveMsg(KMMessage* msg, int* index_return = 0);
  int moveMsg(TQPtrList<KMMessage>, int* index_return = 0);
 
  int find(const KMMsgBase* msg) const;
  int find( const KMMessage * msg ) const;
 
  int count(bool cache = false) const;
 
  int countUnread();
 
  int countUnreadRecursive();
 
  void msgStatusChanged( const KMMsgStatus oldStatus,
                         const KMMsgStatus newStatus,
                         int idx);
 
  int open(const char *owner);
 
  int canAccess();
 
  void close(const char *owner, bool force=false);
 
  void sync();
 
  bool isOpened() const;
 
  void markNewAsUnread();
 
  void markUnreadAsRead();
 
  void remove();
 
  int expunge();
 
  enum CompactOptions { CompactLater, CompactNow, CompactSilentlyNow };
  void compact( CompactOptions options );
 
  int rename(const TQString& newName, KMFolderDir *aParent = 0);
 
  bool dirty() const;
 
  void setDirty(bool f);
 
  bool needsCompacting() const;
  void setNeedsCompacting(bool f);
 
  void quiet(bool beQuiet);
 
  bool isReadOnly() const;
  bool isWritable() const;
 
  bool mailCheckInProgress() const;
 
  bool canDeleteMessages() const;
 
  bool isSystemFolder() const { return mIsSystemFolder; }
  void setSystemFolder(bool itIs) { mIsSystemFolder=itIs; }
 
  virtual TQString label() const;
  void setLabel( const TQString& l ) { mLabel = l; }
 
  virtual TQString systemLabel() const { return mSystemLabel; }
  void setSystemLabel( const TQString& l ) { mSystemLabel = l; }
 
  virtual TQString prettyURL() const;
 
  void setMailingListEnabled( bool enabled );
  bool isMailingListEnabled() const { return mMailingListEnabled; }
 
  void setMailingList( const MailingList& mlist );
  MailingList mailingList() const
  { return mMailingList; }
  TQString mailingListPostAddress() const;
 
  void setIdentity(uint identity);
  uint identity() const;
 
  TQString whoField() const { return mWhoField; }
  void setWhoField(const TQString& aWhoField);
 
  TQString userWhoField(void) { return mUserWhoField; }
  void setUserWhoField(const TQString &whoField,bool writeConfig=true);
 
  void correctUnreadMsgsCount();
 
  TQString idString() const;
 
  void setAutoExpire(bool enabled);
 
  bool isAutoExpire() const { return mExpireMessages; }
 
  void setUnreadExpireAge(int age);
 
  void setUnreadExpireUnits(ExpireUnits units);
 
  void setReadExpireAge(int age);
 
  void setReadExpireUnits(ExpireUnits units);
 
  int getUnreadExpireAge() const { return mUnreadExpireAge; }
 
  int getReadExpireAge() const { return mReadExpireAge; }
 
  ExpireUnits getUnreadExpireUnits() const { return mUnreadExpireUnits; }
 
  ExpireUnits getReadExpireUnits() const { return mReadExpireUnits; }
 
  enum ExpireAction { ExpireDelete, ExpireMove };
  ExpireAction expireAction() const { return mExpireAction; }
  void setExpireAction( ExpireAction a );
 
  TQString expireToFolderId() const { return mExpireToFolderId; }
  void setExpireToFolderId( const TQString& id );
 
  void expireOldMessages( bool immediate );
 
  int writeIndex( bool createEmptyIndex = false );
 
  void setStatus(int idx, KMMsgStatus status, bool toggle=false);
 
  void setStatus(TQValueList<int>& ids, KMMsgStatus status, bool toggle=false);
 
  bool useCustomIcons() const { return mUseCustomIcons; }
  void setUseCustomIcons(bool useCustomIcons) { mUseCustomIcons = useCustomIcons; }
  TQString normalIconPath() const { return mNormalIconPath; }
  TQString unreadIconPath() const { return mUnreadIconPath; }
  void setIconPaths(const TQString &normalPath, const TQString &unreadPath);
 
  void removeJobs();
 
  void daysToExpire( int& unreadDays, int& readDays );
 
  KMFolder* trashFolder() const;
 
  bool putRepliesInSameFolder() const { return mPutRepliesInSameFolder; }
  void setPutRepliesInSameFolder( bool b ) { mPutRepliesInSameFolder = b; }
 
  bool ignoreNewMail() const { return mIgnoreNewMail; }
  void setIgnoreNewMail( bool b ) { mIgnoreNewMail = b; }
 
  const TDEShortcut &shortcut() const { return mShortcut; }
  void setShortcut( const TDEShortcut& );
 
  bool isMoveable() const;
 
  bool moveInProgress() const { return mMoveInProgress; }
 
  void setMoveInProgress( bool b ) { mMoveInProgress = b; }
 
  bool isValidName( const TQString &folderName, TQString &message );
 
signals:
  void changed();
 
  void closed();
 
  void cleared();
 
  void expunged( KMFolder* );
 
  void iconsChanged();
 
  void nameChanged();
 
  void shortcutChanged( KMFolder * );
 
  void msgRemoved(KMFolder*, TQ_UINT32 sernum);
 
  void msgRemoved( int idx, TQString msgIdMD5 );
  void msgRemoved(KMFolder*);
 
  void msgAdded(int idx);
  void msgAdded(KMFolder*, TQ_UINT32 sernum);
 
  void msgChanged(KMFolder*, TQ_UINT32 sernum, int delta);
 
  void msgHeaderChanged(KMFolder*, int);
 
  void statusMsg(const TQString&);
 
  void numUnreadMsgsChanged( KMFolder* );
 
  void removed(KMFolder*, bool);
 
  void viewConfigChanged();
 
  void folderSizeChanged( KMFolder * );
 
  void noContentChanged();
 
  void syncStateChanged();
 
public slots:
  int updateIndex();
 
  void reallyAddMsg(KMMessage* aMsg);
 
  void reallyAddCopyOfMsg(KMMessage* aMsg);
 
private slots:
  void slotContentsTypeChanged( KMail::FolderContentsType type );
  void slotFolderSizeChanged();
 
private:
  FolderStorage* mStorage;
  KMFolderDir* mChild;
  bool mIsSystemFolder;
  bool mHasIndex :1;
  bool mExportsSernums :1;
  bool mMoveInProgress :1;
 
  TQString mLabel;
  TQString mSystemLabel;
 
  bool         mExpireMessages;          // true if old messages are expired
  int          mUnreadExpireAge;         // Given in unreadExpireUnits
  int          mReadExpireAge;           // Given in readExpireUnits
  ExpireUnits  mUnreadExpireUnits;
  ExpireUnits  mReadExpireUnits;
  ExpireAction mExpireAction;
  TQString      mExpireToFolderId;
 
  bool mUseCustomIcons;
  TQString mNormalIconPath;
  TQString mUnreadIconPath;
 
  bool                mMailingListEnabled;
  MailingList         mMailingList;
 
  AccountList* mAcctList;
 
  uint mIdentity;
 
  TQString mWhoField, mUserWhoField;
 
  bool mPutRepliesInSameFolder;
 
  bool mIgnoreNewMail;
 
  TDEShortcut mShortcut;
};
 
 
class KMFolderOpener {
  KMFolder* mFolder;
  const char* const mOwner;
  int mOpenRc;
 
public:
  KMFolderOpener( KMFolder* folder, const char* const owner )
   : mFolder( folder )
   , mOwner( owner )
  {
    assert( folder ); //change if that's not what you want
    mOpenRc = folder->open( owner );
  }
 
  ~KMFolderOpener()
  {
    if ( !mOpenRc )
      mFolder->close( mOwner );
  }
 
  KMFolder* folder() const { return mFolder; }
 
  int openResult() const { return mOpenRc; }
 
private:
  //we forbid construction on the heap as good as we can
  void* operator new( size_t size );
};
 
 
#endif /*kmfolder_h*/