Back to index

lightning-sunbird  0.9+nobinonly
nsOEScanBoxes.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) 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 nsOEScanBoxes_h___
00039 #define nsOEScanBoxes_h___
00040 
00041 #include "prtypes.h"
00042 #include "nsString.h"
00043 #include "nsIImportModule.h"
00044 #include "nsVoidArray.h"
00045 #include "nsISupportsArray.h"
00046 #include "nsIFileSpec.h"
00047 #include "nsIImportService.h"
00048        
00049 class nsOEScanBoxes {
00050 public:
00051        nsOEScanBoxes();
00052        ~nsOEScanBoxes();
00053 
00054        static PRBool FindMail( nsIFileSpec *pWhere);
00055        
00056        PRBool GetMailboxes( nsIFileSpec *pWhere, nsISupportsArray **pArray);
00057               
00058 
00059 private:
00060        typedef struct {
00061               PRUint32      index;
00062               PRUint32      parent;
00063               PRInt32              child;
00064               PRInt32              sibling;
00065               PRInt32              type;
00066               nsString      mailName;
00067               nsCString     fileName;
00068     PRBool    processed; // used by entries on m_pendingChildArray list
00069        } MailboxEntry;
00070 
00071        static PRBool Find50Mail( nsIFileSpec *pWhere);
00072 
00073        void   Reset( void);
00074        PRBool FindMailBoxes( nsIFileSpec * descFile);
00075        PRBool Find50MailBoxes( nsIFileSpec * descFile);
00076 
00077        // If find mailboxes fails you can use this routine to get the raw mailbox file names
00078        void   ScanMailboxDir( nsIFileSpec * srcDir);
00079        PRBool Scan50MailboxDir( nsIFileSpec * srcDir);
00080 
00081        MailboxEntry *       GetIndexEntry( PRUint32 index);
00082        void                 AddChildEntry( MailboxEntry *pEntry, PRUint32 rootIndex);
00083   MailboxEntry *  NewMailboxEntry(PRUint32 id, PRUint32 parent, const char *prettyName, char *pFileName);
00084   void        ProcessPendingChildEntries(PRUint32 parent, PRUint32 rootIndex, nsVoidArray &childArray);
00085   void        RemoveProcessedChildEntries();
00086 
00087 
00088        PRBool               ReadLong( nsIFileSpec * stream, PRInt32& val, PRUint32 offset);
00089        PRBool               ReadLong( nsIFileSpec * stream, PRUint32& val, PRUint32 offset);
00090        PRBool               ReadString( nsIFileSpec * stream, nsString& str, PRUint32 offset);
00091        PRBool               ReadString( nsIFileSpec * stream, nsCString& str, PRUint32 offset);
00092        PRUint32             CountMailboxes( MailboxEntry *pBox);
00093 
00094        void                 BuildMailboxList( MailboxEntry *pBox, nsIFileSpec * root, PRInt32 depth, nsISupportsArray *pArray);
00095        PRBool                      GetMailboxList( nsIFileSpec * root, nsISupportsArray **pArray);
00096        
00097 private:
00098        MailboxEntry *                            m_pFirst;
00099        nsVoidArray                               m_entryArray;
00100   nsVoidArray                             m_pendingChildArray; // contains child folders whose parent folders have not showed up.
00101 
00102        nsCOMPtr<nsIImportService>  mService;
00103 };
00104 
00105 #endif // nsOEScanBoxes_h__