mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-06 00:55:37 +00:00
256 lines
9.8 KiB
C++
256 lines
9.8 KiB
C++
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* ***** BEGIN LICENSE BLOCK *****
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
*
|
|
* The contents of this file are subject to the Mozilla Public License Version
|
|
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
* the License. You may obtain a copy of the License at
|
|
* http://www.mozilla.org/MPL/
|
|
*
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
* for the specific language governing rights and limitations under the
|
|
* License.
|
|
*
|
|
* The Original Code is mozilla.org code.
|
|
*
|
|
* The Initial Developer of the Original Code is
|
|
* Netscape Communications Corporation.
|
|
* Portions created by the Initial Developer are Copyright (C) 1999
|
|
* the Initial Developer. All Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
*
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
* either of the GNU General Public License Version 2 or later (the "GPL"),
|
|
* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
* use your version of this file under the terms of the MPL, indicate your
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
* the provisions above, a recipient may use your version of this file under
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
|
*
|
|
* ***** END LICENSE BLOCK ***** */
|
|
|
|
#ifndef nsMsgDBFolder_h__
|
|
#define nsMsgDBFolder_h__
|
|
|
|
#include "msgCore.h"
|
|
#include "nsIMsgFolder.h"
|
|
#include "nsRDFResource.h"
|
|
#include "nsIDBFolderInfo.h"
|
|
#include "nsIMsgDatabase.h"
|
|
#include "nsIMsgIncomingServer.h"
|
|
#include "nsCOMPtr.h"
|
|
#include "nsStaticAtom.h"
|
|
#include "nsIDBChangeListener.h"
|
|
#include "nsIURL.h"
|
|
#include "nsWeakReference.h"
|
|
#include "nsIMsgFilterList.h"
|
|
#include "nsIUrlListener.h"
|
|
#include "nsIFileSpec.h"
|
|
#include "nsIMsgHdr.h"
|
|
#include "nsIOutputStream.h"
|
|
#include "nsITransport.h"
|
|
#include "nsIMsgStringService.h"
|
|
class nsIMsgFolderCacheElement;
|
|
class nsIJunkMailPlugin;
|
|
class nsICollation;
|
|
|
|
/*
|
|
* nsMsgDBFolder
|
|
* class derived from nsMsgFolder for those folders that use an nsIMsgDatabase
|
|
*/
|
|
|
|
#undef IMETHOD_VISIBILITY
|
|
#define IMETHOD_VISIBILITY NS_VISIBILITY_DEFAULT
|
|
|
|
class NS_MSG_BASE nsMsgDBFolder: public nsRDFResource,
|
|
public nsSupportsWeakReference,
|
|
public nsIMsgFolder,
|
|
public nsIDBChangeListener,
|
|
public nsIUrlListener
|
|
{
|
|
public:
|
|
nsMsgDBFolder(void);
|
|
virtual ~nsMsgDBFolder(void);
|
|
NS_DECL_ISUPPORTS_INHERITED
|
|
NS_DECL_NSIMSGFOLDER
|
|
NS_DECL_NSICOLLECTION
|
|
NS_DECL_NSISERIALIZABLE
|
|
NS_DECL_NSIDBCHANGELISTENER
|
|
NS_DECL_NSIURLLISTENER
|
|
|
|
NS_IMETHOD WriteToFolderCacheElem(nsIMsgFolderCacheElement *element);
|
|
NS_IMETHOD ReadFromFolderCacheElem(nsIMsgFolderCacheElement *element);
|
|
|
|
// nsRDFResource overrides
|
|
NS_IMETHOD Init(const char* aURI);
|
|
|
|
// These functions are used for tricking the front end into thinking that we have more
|
|
// messages than are really in the DB. This is usually after and IMAP message copy where
|
|
// we don't want to do an expensive select until the user actually opens that folder
|
|
// These functions are called when MSG_Master::GetFolderLineById is populating a MSG_FolderLine
|
|
// struct used by the FE
|
|
PRInt32 GetNumPendingUnread();
|
|
PRInt32 GetNumPendingTotalMessages();
|
|
|
|
void ChangeNumPendingUnread(PRInt32 delta);
|
|
void ChangeNumPendingTotalMessages(PRInt32 delta);
|
|
|
|
NS_IMETHOD MatchName(nsString *name, PRBool *matches);
|
|
|
|
protected:
|
|
|
|
// this is a little helper function that is not part of the public interface.
|
|
// we use it to get the IID of the incoming server for the derived folder.
|
|
// w/out a function like this we would have to implement GetServer in each
|
|
// derived folder class.
|
|
virtual const char* GetIncomingServerType() = 0;
|
|
|
|
virtual nsresult CreateBaseMessageURI(const char *aURI);
|
|
|
|
|
|
// helper routine to parse the URI and update member variables
|
|
nsresult parseURI(PRBool needServer=PR_FALSE);
|
|
nsresult GetBaseStringBundle(nsIStringBundle **aBundle);
|
|
nsresult GetStringFromBundle(const char* msgName, PRUnichar **aResult);
|
|
nsresult ThrowConfirmationPrompt(nsIMsgWindow *msgWindow, const PRUnichar *confirmString, PRBool *confirmed);
|
|
nsresult GetWarnFilterChanged(PRBool *aVal);
|
|
nsresult SetWarnFilterChanged(PRBool aVal);
|
|
nsresult CreateCollationKey(const nsString &aSource, PRUint8 **aKey, PRUint32 *aLength);
|
|
|
|
protected:
|
|
virtual nsresult ReadDBFolderInfo(PRBool force);
|
|
virtual nsresult FlushToFolderCache();
|
|
virtual nsresult GetDatabase(nsIMsgWindow *aMsgWindow) = 0;
|
|
virtual nsresult SendFlagNotifications(nsISupports *item, PRUint32 oldFlags, PRUint32 newFlags);
|
|
nsresult CheckWithNewMessagesStatus(PRBool messageAdded);
|
|
nsresult OnKeyAddedOrDeleted(nsMsgKey aKeyChanged, PRBool added);
|
|
nsresult CreateFileSpecForDB(const char *userLeafName, nsFileSpec &baseDir, nsIFileSpec **dbFileSpec);
|
|
|
|
nsresult GetFolderCacheKey(nsIFileSpec **aFileSpec);
|
|
nsresult GetFolderCacheElemFromFileSpec(nsIFileSpec *fileSpec, nsIMsgFolderCacheElement **cacheElement);
|
|
|
|
nsresult PromptForCachePassword(nsIMsgIncomingServer *server, nsIMsgWindow *aWindow, PRBool &passwordCorrect);
|
|
// offline support methods.
|
|
nsresult StartNewOfflineMessage();
|
|
nsresult WriteStartOfNewLocalMessage();
|
|
nsresult EndNewOfflineMessage();
|
|
nsresult CompactOfflineStore(nsIMsgWindow *inWindow);
|
|
nsresult AutoCompact(nsIMsgWindow *aWindow);
|
|
// this is a helper routine that ignores whether MSG_FLAG_OFFLINE is set for the folder
|
|
nsresult MsgFitsDownloadCriteria(nsMsgKey msgKey, PRBool *result);
|
|
nsresult GetPromptPurgeThreshold(PRBool *aPrompt);
|
|
nsresult GetPurgeThreshold(PRInt32 *aThreshold);
|
|
|
|
nsresult PerformBiffNotifications(void); // if there are new, non spam messages, do biff
|
|
nsresult CloseDBIfFolderNotOpen();
|
|
|
|
virtual nsresult SpamFilterClassifyMessage(const char *aURI, nsIMsgWindow *aMsgWindow, nsIJunkMailPlugin *aJunkMailPlugin);
|
|
virtual nsresult SpamFilterClassifyMessages(const char **aURIArray, PRUint32 aURICount, nsIMsgWindow *aMsgWindow, nsIJunkMailPlugin *aJunkMailPlugin);
|
|
|
|
protected:
|
|
nsCOMPtr<nsIMsgDatabase> mDatabase;
|
|
nsString mCharset;
|
|
PRBool mCharsetOverride;
|
|
PRBool mAddListener;
|
|
PRBool mNewMessages;
|
|
PRBool mGettingNewMessages;
|
|
nsMsgKey mLastMessageLoaded;
|
|
|
|
nsCOMPtr <nsIMsgDBHdr> m_offlineHeader;
|
|
PRInt32 m_numOfflineMsgLines;
|
|
// this is currently used when we do a save as of an imap or news message..
|
|
nsCOMPtr<nsIOutputStream> m_tempMessageStream;
|
|
|
|
nsCOMPtr <nsIMsgRetentionSettings> m_retentionSettings;
|
|
nsCOMPtr <nsIMsgDownloadSettings> m_downloadSettings;
|
|
static nsIAtom* mFolderLoadedAtom;
|
|
static nsIAtom* mDeleteOrMoveMsgCompletedAtom;
|
|
static nsIAtom* mDeleteOrMoveMsgFailedAtom;
|
|
static nsIAtom* mJunkStatusChangedAtom;
|
|
static nsrefcnt mInstanceCount;
|
|
|
|
protected:
|
|
PRUint32 mFlags;
|
|
nsWeakPtr mParent; //This won't be refcounted for ownership reasons.
|
|
PRInt32 mNumUnreadMessages; /* count of unread messages (-1 means
|
|
unknown; -2 means unknown but we already
|
|
tried to find out.) */
|
|
PRInt32 mNumTotalMessages; /* count of existing messages. */
|
|
PRBool mNotifyCountChanges;
|
|
PRUint32 mExpungedBytes;
|
|
nsCOMPtr<nsISupportsArray> mSubFolders;
|
|
nsVoidArray mListeners; //This can't be an nsISupportsArray because due to
|
|
//ownership issues, listeners can't be AddRef'd
|
|
|
|
PRBool mInitializedFromCache;
|
|
nsISupports *mSemaphoreHolder; // set when the folder is being written to
|
|
//Due to ownership issues, this won't be AddRef'd.
|
|
|
|
nsWeakPtr mServer;
|
|
|
|
// These values are used for tricking the front end into thinking that we have more
|
|
// messages than are really in the DB. This is usually after and IMAP message copy where
|
|
// we don't want to do an expensive select until the user actually opens that folder
|
|
PRInt32 mNumPendingUnreadMessages;
|
|
PRInt32 mNumPendingTotalMessages;
|
|
PRUint32 mFolderSize;
|
|
|
|
PRInt32 mNumNewBiffMessages;
|
|
PRBool mIsCachable;
|
|
//
|
|
// stuff from the uri
|
|
//
|
|
PRBool mHaveParsedURI; // is the URI completely parsed?
|
|
PRBool mIsServerIsValid;
|
|
PRBool mIsServer;
|
|
nsString mName;
|
|
nsCOMPtr<nsIFileSpec> mPath;
|
|
char * mBaseMessageURI; //The uri with the message scheme
|
|
|
|
// static stuff for cross-instance objects like atoms
|
|
static nsrefcnt gInstanceCount;
|
|
|
|
static nsresult initializeStrings();
|
|
static nsresult createCollationKeyGenerator();
|
|
|
|
static PRUnichar *kLocalizedInboxName;
|
|
static PRUnichar *kLocalizedTrashName;
|
|
static PRUnichar *kLocalizedSentName;
|
|
static PRUnichar *kLocalizedDraftsName;
|
|
static PRUnichar *kLocalizedTemplatesName;
|
|
static PRUnichar *kLocalizedUnsentName;
|
|
static PRUnichar *kLocalizedJunkName;
|
|
|
|
static nsIAtom* kTotalUnreadMessagesAtom;
|
|
static nsIAtom* kBiffStateAtom;
|
|
static nsIAtom* kNewMessagesAtom;
|
|
static nsIAtom* kNumNewBiffMessagesAtom;
|
|
static nsIAtom* kTotalMessagesAtom;
|
|
static nsIAtom* kFolderSizeAtom;
|
|
static nsIAtom* kStatusAtom;
|
|
static nsIAtom* kFlaggedAtom;
|
|
static nsIAtom* kNameAtom;
|
|
static nsIAtom* kSynchronizeAtom;
|
|
static nsIAtom* kOpenAtom;
|
|
static nsICollation* gCollationKeyGenerator;
|
|
|
|
#ifdef MSG_FASTER_URI_PARSING
|
|
// cached parsing URL object
|
|
static nsCOMPtr<nsIURL> mParsingURL;
|
|
static PRBool mParsingURLInUse;
|
|
#endif
|
|
|
|
static const nsStaticAtom folder_atoms[];
|
|
};
|
|
|
|
#undef IMETHOD_VISIBILITY
|
|
#define IMETHOD_VISIBILITY NS_VISIBILITY_HIDDEN
|
|
|
|
#endif
|