kmail Library API Documentation

copyfolderjob.cpp

00001 
00029 #include "copyfolderjob.h"
00030 #include "folderstorage.h"
00031 #include "kmfoldercachedimap.h"
00032 #include "kmfolder.h"
00033 #include "kmfolderdir.h"
00034 #include "kmfoldertype.h"
00035 #include "kmfoldermgr.h"
00036 #include "kmcommands.h"
00037 #include "kmmsgbase.h"
00038 #include "undostack.h"
00039 
00040 #include <kdebug.h>
00041 #include <klocale.h>
00042 #include <config.h>
00043 
00044 using namespace KMail;
00045 
00046 CopyFolderJob::CopyFolderJob( const FolderStorage* const storage, KMFolderDir* const newParent )
00047  : FolderJob( 0, tOther, (storage ? storage->folder() : 0) ),
00048    mStorage( storage ), mNewParent( newParent ),
00049    mNewFolder( 0 ), mChildFolderNodeIterator( *mStorage->folder()->createChildFolder() ), 
00050    mNextChildFolder( 0 )
00051 {
00052 }
00053 
00054 CopyFolderJob::~CopyFolderJob()
00055 {
00056   kdDebug(5006) << k_funcinfo << endl;
00057 }
00058 
00059 /*
00060  * The basic strategy is to first create the target folder, then copy all the mail
00061  * from the source to the target folder, then recurse for each of the folder's children
00062  */
00063 void CopyFolderJob::execute()
00064 {
00065   if ( createTargetDir() ) {
00066     copyMessagesToTargetDir();
00067   }
00068 }
00069 
00070 void CopyFolderJob::copyMessagesToTargetDir()
00071 {
00072   // Hmmmm. Tasty hack. Can I have fries with that?
00073   const_cast<FolderStorage*>( mStorage )->blockSignals( true );
00074   // move all messages to the new folder
00075   QPtrList<KMMsgBase> msgList;
00076   for ( int i = 0; i < mStorage->count(); i++ )
00077   {
00078     const KMMsgBase* msgBase = mStorage->getMsgBase( i );
00079     assert( msgBase );
00080     msgList.append( msgBase );
00081   }
00082   if ( msgList.count() == 0 ) {
00083     slotCopyNextChild(); // no contents, check subfolders
00084     const_cast<FolderStorage*>( mStorage )->blockSignals( false );
00085   } else {
00086     KMCommand *command = new KMCopyCommand( mNewFolder, msgList );
00087     connect( command, SIGNAL( completed( KMCommand * ) ),
00088         this, SLOT( slotCopyCompleted( KMCommand * ) ) );
00089     command->start();
00090   }
00091 }
00092 
00093 void CopyFolderJob::slotCopyCompleted( KMCommand* command )
00094 {
00095   kdDebug(5006) << k_funcinfo << (command?command->result():0) << endl;
00096   disconnect( command, SIGNAL( completed( KMCommand * ) ),
00097       this, SLOT( slotCopyCompleted( KMCommand * ) ) );
00098   
00099   const_cast<FolderStorage*>( mStorage )->blockSignals( false );
00100   
00101   if ( command && command->result() != KMCommand::OK ) {
00102     rollback();
00103   }
00104   // if we have children, recurse
00105   if ( mStorage->folder()->child() ) {
00106     slotCopyNextChild();
00107   } else {
00108     emit folderCopyComplete( true );
00109     deleteLater();
00110   }
00111 }
00112 
00113 void CopyFolderJob::slotCopyNextChild( bool success )
00114 {
00115   //kdDebug(5006) << k_funcinfo << endl;
00116   if ( mNextChildFolder ) 
00117     mNextChildFolder->close(); // refcount
00118   // previous sibling failed
00119   if ( !success ) {
00120     kdDebug(5006) << "Failed to copy one subfolder, let's not continue:  " << mNewFolder->prettyURL() << endl;
00121     rollback();
00122     emit folderCopyComplete( false );
00123     deleteLater();
00124   }
00125 
00126   KMFolderNode* node = mChildFolderNodeIterator.current();
00127   while ( node && node->isDir() ) {
00128     ++mChildFolderNodeIterator;
00129     node = mChildFolderNodeIterator.current();
00130   }
00131   if ( node ) {
00132     mNextChildFolder = static_cast<KMFolder*>(node);
00133     ++mChildFolderNodeIterator;
00134   } else {
00135     // no more children, we are done
00136     emit folderCopyComplete( true );
00137     deleteLater();
00138     return;
00139   }
00140   
00141   KMFolderDir * const dir = mNewFolder->createChildFolder();
00142   if ( !dir ) {
00143     kdDebug(5006) << "Failed to create subfolders of:  " << mNewFolder->prettyURL() << endl;
00144     emit folderCopyComplete( false );
00145     deleteLater();
00146     return;
00147   }
00148   // let it do its thing and report back when we are ready to do the next sibling
00149   mNextChildFolder->open(); // refcount
00150   FolderJob* job = new CopyFolderJob( mNextChildFolder->storage(), dir);
00151   connect( job, SIGNAL( folderCopyComplete( bool ) ),
00152            this, SLOT( slotCopyNextChild( bool ) ) );
00153   job->start();
00154 }
00155 
00156 
00157 // FIXME factor into CreateFolderJob and make async, so it works with online imap
00158 // FIXME this is the same in renamejob. Refactor RenameJob to use a copy job and then delete
00159 bool CopyFolderJob::createTargetDir()
00160 {
00161     KMFolderMgr* folderMgr = kmkernel->folderMgr();
00162     if ( mNewParent->type() == KMImapDir ) {
00163       folderMgr = kmkernel->imapFolderMgr();
00164     } else if ( mNewParent->type() == KMDImapDir ) {
00165       folderMgr = kmkernel->dimapFolderMgr();
00166     }
00167 
00168     // get the default mailbox type
00169     KConfig * const config = KMKernel::config();
00170     KConfigGroupSaver saver(config, "General");
00171     int deftype = config->readNumEntry("default-mailbox-format", 1);
00172     if ( deftype < 0 || deftype > 1 ) deftype = 1;
00173 
00174     // the type of the new folder
00175     KMFolderType typenew = 
00176       ( deftype == 0 ) ? KMFolderTypeMbox : KMFolderTypeMaildir;
00177     if ( mNewParent->owner() )
00178       typenew = mNewParent->owner()->folderType();
00179 
00180     mNewFolder = folderMgr->createFolder( mStorage->folder()->name(), false, typenew, mNewParent );
00181     if ( !mNewFolder )
00182     {
00183       kdWarning(5006) << k_funcinfo << "could not create folder" << endl;
00184       emit folderCopyComplete( false );
00185       deleteLater();
00186       return false;
00187     }
00188     // inherit the folder type
00189     // FIXME we should probably copy over most if not all settings
00190     mNewFolder->storage()->setContentsType( mStorage->contentsType(), true /*quiet*/ );
00191     mNewFolder->storage()->writeConfig();
00192     kdDebug(5006)<< "CopyJob::createTargetDir - " << mStorage->folder()->idString()
00193       << " |=> " << mNewFolder->idString() << endl;
00194     return true;
00195 }
00196 
00197 
00198 void CopyFolderJob::rollback()
00199 {
00200   // FIXME do something
00201   KMFolderMgr * const folderMgr = mNewFolder->createChildFolder()->manager();
00202   folderMgr->remove( mNewFolder );
00203   emit folderCopyComplete( false );
00204   deleteLater();
00205 }
00206 #include "copyfolderjob.moc"
KDE Logo
This file is part of the documentation for kmail Library Version 3.3.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Oct 4 14:42:11 2007 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003