Back to index

lightning-sunbird  0.9+nobinonly
nsImapMoveCoalescer.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
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) 1998
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 _nsImapMoveCoalescer_H
00039 #define _nsImapMoveCoalescer_H
00040 
00041 #include "msgCore.h"
00042 #include "nsISupportsArray.h"
00043 #include "nsIMsgWindow.h"
00044 #include "nsCOMPtr.h"
00045 
00046 // imap move coalescer class - in order to keep nsImapMailFolder from growing like Topsy
00047 // Logically, we want to keep track of an nsMsgKeyArray per nsIMsgFolder, and then
00048 // be able to retrieve them one by one and play back the moves.
00049 // This utility class will be used by both the filter code and the offline playback code,
00050 // to avoid multiple moves to the same folder.
00051 
00052 class NS_MSG_BASE nsImapMoveCoalescer : public nsIUrlListener
00053 {
00054 public:
00055   friend class nsMoveCoalescerCopyListener;
00056 
00057   NS_DECL_ISUPPORTS
00058   NS_DECL_NSIURLLISTENER
00059 
00060   nsImapMoveCoalescer(nsIMsgFolder *sourceFolder, nsIMsgWindow *msgWindow);
00061   virtual ~nsImapMoveCoalescer();
00062 
00063   nsresult AddMove(nsIMsgFolder *folder, nsMsgKey key);
00064   nsresult PlaybackMoves(PRBool doNewMailNotification = PR_FALSE);
00065   // this lets the caller store keys in an arbitrary number of buckets. If the bucket
00066   // for the passed in index doesn't exist, it will get created.
00067   nsMsgKeyArray *GetKeyBucket(PRInt32 keyArrayIndex);
00068   nsIMsgWindow *GetMsgWindow() {return m_msgWindow;}
00069   PRBool HasPendingMoves() {return m_hasPendingMoves;}
00070 protected:
00071   // m_sourceKeyArrays and m_destFolders are parallel arrays.
00072   nsVoidArray m_sourceKeyArrays;
00073   nsCOMPtr <nsISupportsArray> m_destFolders;
00074   nsCOMPtr <nsIMsgWindow> m_msgWindow;
00075   nsCOMPtr <nsIMsgFolder> m_sourceFolder;
00076   PRBool m_doNewMailNotification;
00077   PRBool m_hasPendingMoves;
00078   nsVoidArray m_keyBuckets;
00079   PRInt32 m_outstandingMoves;
00080 };
00081 
00082 class nsMoveCoalescerCopyListener : public nsIMsgCopyServiceListener
00083 {
00084 public:
00085     nsMoveCoalescerCopyListener(nsImapMoveCoalescer * coalescer, nsIMsgFolder *destFolder);
00086     ~nsMoveCoalescerCopyListener();
00087     NS_DECL_ISUPPORTS
00088     NS_DECL_NSIMSGCOPYSERVICELISTENER
00089 
00090     nsCOMPtr <nsIMsgFolder> m_destFolder;
00091 
00092       nsImapMoveCoalescer *m_coalescer;
00093     // when we get OnStopCopy, update the folder. When we've finished all the copies,
00094     // send the biff notification.
00095 };
00096 
00097 
00098 #endif // _nsImapMoveCoalescer_H
00099