Back to index

lightning-sunbird  0.9+nobinonly
nsImapOfflineSync.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1999
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef _nsImapOfflineSync_H_
00039 #define _nsImapOfflineSync_H_
00040 
00041 
00042 #include "nsIMsgDatabase.h"
00043 #include "nsIUrlListener.h"
00044 #include "nsIMsgOfflineImapOperation.h"
00045 #include "nsIMsgWindow.h"
00046 #include "nsIMsgFolder.h"
00047 #include "nsIFileSpec.h"
00048 
00049 class nsImapOfflineSync : public nsIUrlListener, public nsIMsgCopyServiceListener {
00050 public:                                                                                    // set to one folder to playback one folder only
00051   nsImapOfflineSync(nsIMsgWindow *window, nsIUrlListener *listener, nsIMsgFolder *singleFolderOnly = nsnull);
00052   virtual ~nsImapOfflineSync();
00053   
00054   NS_DECL_ISUPPORTS
00055   NS_DECL_NSIURLLISTENER
00056   NS_DECL_NSIMSGCOPYSERVICELISTENER
00057   virtual nsresult  ProcessNextOperation(); // this kicks off playback
00058   
00059   PRInt32   GetCurrentUIDValidity();
00060   void     SetCurrentUIDValidity(PRInt32 uidvalidity) { mCurrentUIDValidity = uidvalidity; }
00061   
00062   void     SetPseudoOffline(PRBool pseudoOffline) {m_pseudoOffline = pseudoOffline;}
00063   PRBool    ProcessingStaleFolderUpdate() { return m_singleFolderToUpdate != nsnull; }
00064   
00065   PRBool    CreateOfflineFolder(nsIMsgFolder *folder);
00066   void      SetWindow(nsIMsgWindow *window);
00067 protected:
00068   PRBool    CreateOfflineFolders();
00069   PRBool    DestFolderOnSameServer(nsIMsgFolder *destFolder);
00070   nsresult  AdvanceToNextServer();
00071   nsresult  AdvanceToNextFolder();
00072   void     AdvanceToFirstIMAPFolder();
00073   void            DeleteAllOfflineOpsForCurrentDB();
00074   
00075   void      ProcessFlagOperation(nsIMsgOfflineImapOperation *currentOp);
00076   void      ProcessKeywordOperation(nsIMsgOfflineImapOperation *op);
00077   void     ProcessMoveOperation(nsIMsgOfflineImapOperation *currentOp);
00078   void     ProcessCopyOperation(nsIMsgOfflineImapOperation *currentOp);
00079   void     ProcessEmptyTrash(nsIMsgOfflineImapOperation *currentOp);
00080   void     ProcessAppendMsgOperation(nsIMsgOfflineImapOperation *currentOp,
00081                                       nsOfflineImapOperationType opType);
00082   
00083   nsCOMPtr <nsIMsgFolder> m_currentFolder;
00084   nsCOMPtr <nsIMsgFolder> m_singleFolderToUpdate;
00085   nsCOMPtr <nsIMsgWindow> m_window;
00086   nsCOMPtr <nsISupportsArray> m_allServers;
00087   nsCOMPtr <nsISupportsArray> m_allFolders;
00088   nsCOMPtr <nsIMsgIncomingServer> m_currentServer;
00089   nsCOMPtr <nsIEnumerator> m_serverEnumerator;
00090   nsCOMPtr <nsIFileSpec> m_curTempFile;
00091   
00092   nsMsgKeyArray      m_CurrentKeys;
00093   PRUint32      m_KeyIndex;
00094   nsCOMPtr <nsIMsgDatabase> m_currentDB;
00095   nsCOMPtr <nsIUrlListener> m_listener;
00096   PRInt32     mCurrentUIDValidity;
00097   PRInt32     mCurrentPlaybackOpType;     // kFlagsChanged -> kMsgCopy -> kMsgMoved
00098   PRBool      m_mailboxupdatesStarted;
00099   PRBool        m_mailboxupdatesFinished;
00100   PRBool      m_pseudoOffline;            // for queueing online events in offline db
00101   PRBool      m_createdOfflineFolders;
00102   
00103 };
00104 
00105 class nsImapOfflineDownloader : public nsImapOfflineSync
00106 {
00107 public:
00108   nsImapOfflineDownloader(nsIMsgWindow *window, nsIUrlListener *listener);
00109   virtual ~nsImapOfflineDownloader();
00110   virtual nsresult  ProcessNextOperation(); // this kicks off download
00111 };
00112 
00113 #endif