1a7ee5eddc
creating URI. git-svn-id: svn://10.0.0.236/trunk@23906 18797224-902f-48f8-a5cc-f745e15eee43
257 lines
10 KiB
C++
257 lines
10 KiB
C++
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
|
*
|
|
* The contents of this file are subject to the Netscape Public License
|
|
* Version 1.0 (the "NPL"); you may not use this file except in
|
|
* compliance with the NPL. You may obtain a copy of the NPL at
|
|
* http://www.mozilla.org/NPL/
|
|
*
|
|
* Software distributed under the NPL is distributed on an "AS IS" basis,
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
|
|
* for the specific language governing rights and limitations under the
|
|
* NPL.
|
|
*
|
|
* The Initial Developer of this code under the NPL is Netscape
|
|
* Communications Corporation. Portions created by Netscape are
|
|
* Copyright (C) 1999 Netscape Communications Corporation. All Rights
|
|
* Reserved.
|
|
*/
|
|
|
|
#ifndef _nsMsgDatabase_H_
|
|
#define _nsMsgDatabase_H_
|
|
|
|
#include "nsIMsgDatabase.h"
|
|
#include "nsMsgHdr.h"
|
|
#include "nsVoidArray.h"
|
|
#include "nsString.h"
|
|
#include "nsFileSpec.h"
|
|
#include "nsIDBChangeListener.h"
|
|
#include "nsMsgMessageFlags.h"
|
|
#include "nsISupportsArray.h"
|
|
|
|
class nsThreadMessageHdr;
|
|
class ListContext;
|
|
class nsDBFolderInfo;
|
|
class nsMsgKeyArray;
|
|
class nsNewsSet;
|
|
|
|
class nsMsgDatabase : public nsIMsgDatabase {
|
|
public:
|
|
NS_DECL_ISUPPORTS
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
// nsIDBChangeAnnouncer methods:
|
|
NS_IMETHOD AddListener(nsIDBChangeListener *listener);
|
|
NS_IMETHOD RemoveListener(nsIDBChangeListener *listener);
|
|
|
|
NS_IMETHOD NotifyKeyChangeAll(nsMsgKey keyChanged, PRInt32 flags,
|
|
nsIDBChangeListener *instigator);
|
|
NS_IMETHOD NotifyKeyAddedAll(nsMsgKey keyAdded, PRInt32 flags,
|
|
nsIDBChangeListener *instigator);
|
|
NS_IMETHOD NotifyKeyDeletedAll(nsMsgKey keyDeleted, PRInt32 flags,
|
|
nsIDBChangeListener *instigator);
|
|
NS_IMETHOD NotifyAnnouncerGoingAway(void);
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
// nsIMsgDatabase methods:
|
|
NS_IMETHOD Close(PRBool forceCommit);
|
|
NS_IMETHOD OpenMDB(const char *dbName, PRBool create);
|
|
NS_IMETHOD CloseMDB(PRBool commit);
|
|
NS_IMETHOD Commit(nsMsgDBCommitType commitType);
|
|
// Force closed is evil, and we should see if we can do without it.
|
|
// In 4.x, it was mainly used to remove corrupted databases.
|
|
NS_IMETHOD ForceClosed(void);
|
|
// get a message header for the given key. Caller must release()!
|
|
NS_IMETHOD GetMsgHdrForKey(nsMsgKey key, nsIMessage **msg);
|
|
// create a new message header from a hdrStruct. Caller must release resulting header,
|
|
// after adding any extra properties they want.
|
|
NS_IMETHOD CreateNewHdrAndAddToDB(PRBool *newThread,
|
|
nsMsgHdrStruct *hdrStruct,
|
|
nsIMessage **newHdr,
|
|
PRBool notify);
|
|
|
|
// Must call AddNewHdrToDB after creating. The idea is that you create
|
|
// a new header, fill in its properties, and then call AddNewHdrToDB.
|
|
// AddNewHdrToDB will send notifications to any listeners.
|
|
NS_IMETHOD CreateNewHdr(nsMsgKey key, nsIMessage **newHdr);
|
|
NS_IMETHOD AddNewHdrToDB(nsIMessage *newHdr, PRBool notify);
|
|
// extract info from an nsIMessage into a nsMsgHdrStruct
|
|
NS_IMETHOD GetMsgHdrStructFromnsMsgHdr(nsIMessage *msgHdr,
|
|
nsMsgHdrStruct *hdrStruct);
|
|
|
|
#if HAVE_INT_ENUMERATORS
|
|
NS_IMETHOD EnumerateKeys(nsIEnumerator* *outputKeys);
|
|
#else
|
|
NS_IMETHOD ListAllKeys(nsMsgKeyArray &outputKeys);
|
|
#endif
|
|
NS_IMETHOD EnumerateMessages(nsIEnumerator* *result);
|
|
NS_IMETHOD EnumerateUnreadMessages(nsIEnumerator* *result);
|
|
|
|
// helpers for user command functions like delete, mark read, etc.
|
|
|
|
NS_IMETHOD MarkHdrRead(nsIMessage *msgHdr, PRBool bRead,
|
|
nsIDBChangeListener *instigator);
|
|
|
|
// MDN support
|
|
NS_IMETHOD MarkMDNNeeded(nsMsgKey key, PRBool bNeeded,
|
|
nsIDBChangeListener *instigator);
|
|
|
|
// MarkMDNneeded only used when mail server is a POP3 server
|
|
// or when the IMAP server does not support user defined
|
|
// PERMANENTFLAGS
|
|
NS_IMETHOD IsMDNNeeded(nsMsgKey key, PRBool *isNeeded);
|
|
|
|
NS_IMETHOD MarkMDNSent(nsMsgKey key, PRBool bNeeded,
|
|
nsIDBChangeListener *instigator);
|
|
NS_IMETHOD IsMDNSent(nsMsgKey key, PRBool *isSent);
|
|
|
|
// methods to get and set docsets for ids.
|
|
NS_IMETHOD MarkRead(nsMsgKey key, PRBool bRead,
|
|
nsIDBChangeListener *instigator);
|
|
|
|
NS_IMETHOD MarkReplied(nsMsgKey key, PRBool bReplied,
|
|
nsIDBChangeListener *instigator);
|
|
|
|
NS_IMETHOD MarkForwarded(nsMsgKey key, PRBool bForwarded,
|
|
nsIDBChangeListener *instigator);
|
|
|
|
NS_IMETHOD MarkHasAttachments(nsMsgKey key, PRBool bHasAttachments,
|
|
nsIDBChangeListener *instigator);
|
|
|
|
NS_IMETHOD MarkThreadIgnored(nsThreadMessageHdr *thread, nsMsgKey threadKey, PRBool bIgnored,
|
|
nsIDBChangeListener *instigator);
|
|
NS_IMETHOD MarkThreadWatched(nsThreadMessageHdr *thread, nsMsgKey threadKey, PRBool bWatched,
|
|
nsIDBChangeListener *instigator);
|
|
|
|
NS_IMETHOD IsRead(nsMsgKey key, PRBool *pRead);
|
|
NS_IMETHOD IsIgnored(nsMsgKey key, PRBool *pIgnored);
|
|
NS_IMETHOD IsMarked(nsMsgKey key, PRBool *pMarked);
|
|
NS_IMETHOD HasAttachments(nsMsgKey key, PRBool *pHasThem);
|
|
|
|
NS_IMETHOD MarkAllRead(nsMsgKeyArray *thoseMarked);
|
|
NS_IMETHOD MarkReadByDate (time_t te, time_t endDate, nsMsgKeyArray *markedIds);
|
|
|
|
NS_IMETHOD DeleteMessages(nsMsgKeyArray* nsMsgKeys, nsIDBChangeListener *instigator);
|
|
NS_IMETHOD DeleteMessage(nsMsgKey key,
|
|
nsIDBChangeListener *instigator,
|
|
PRBool commit);
|
|
NS_IMETHOD DeleteHeader(nsIMessage *msgHdr, nsIDBChangeListener *instigator,
|
|
PRBool commit, PRBool notify);
|
|
|
|
NS_IMETHOD UndoDelete(nsIMessage *msgHdr);
|
|
|
|
NS_IMETHOD MarkLater(nsMsgKey key, time_t *until);
|
|
NS_IMETHOD MarkMarked(nsMsgKey key, PRBool mark,
|
|
nsIDBChangeListener *instigator);
|
|
NS_IMETHOD MarkOffline(nsMsgKey key, PRBool offline,
|
|
nsIDBChangeListener *instigator);
|
|
|
|
// returns NS_OK on success, NS_COMFALSE on failure
|
|
NS_IMETHOD AllMsgKeysImapDeleted(const nsMsgKeyArray *keys);
|
|
|
|
NS_IMETHOD MarkImapDeleted(nsMsgKey key, PRBool deleted,
|
|
nsIDBChangeListener *instigator);
|
|
|
|
NS_IMETHOD GetFirstNew(nsMsgKey *result);
|
|
NS_IMETHOD HasNew(void); // returns NS_OK if true, NS_COMFALSE if false
|
|
NS_IMETHOD ClearNewList(PRBool notify);
|
|
|
|
// used mainly to force the timestamp of a local mail folder db to
|
|
// match the time stamp of the corresponding berkeley mail folder,
|
|
// but also useful to tell the summary to mark itself invalid
|
|
NS_IMETHOD SetSummaryValid(PRBool valid);
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
// nsMsgDatabase methods:
|
|
nsMsgDatabase();
|
|
virtual ~nsMsgDatabase();
|
|
|
|
NS_IMETHOD IsHeaderRead(nsIMessage *hdr, PRBool *pRead);
|
|
|
|
static nsIMdbFactory *GetMDBFactory();
|
|
nsDBFolderInfo *GetDBFolderInfo() {return m_dbFolderInfo;}
|
|
nsIMdbEnv *GetEnv() {return m_mdbEnv;}
|
|
nsIMdbStore *GetStore() {return m_mdbStore;}
|
|
virtual PRUint32 GetCurVersion();
|
|
|
|
static nsMsgDatabase* FindInCache(nsFileSpec &dbName);
|
|
|
|
//helper function to fill in nsStrings from hdr row cell contents.
|
|
nsresult RowCellColumnTonsString(nsIMdbRow *row, mdb_token columnToken, nsString &resultStr);
|
|
nsresult RowCellColumnToUInt32(nsIMdbRow *row, mdb_token columnToken, PRUint32 *uint32Result);
|
|
nsresult RowCellColumnToUInt32(nsIMdbRow *row, mdb_token columnToken, PRUint32 &uint32Result);
|
|
|
|
// helper functions to copy an nsString to a yarn, int32 to yarn, and vice versa.
|
|
static struct mdbYarn *nsStringToYarn(struct mdbYarn *yarn, nsString *str);
|
|
static struct mdbYarn *UInt32ToYarn(struct mdbYarn *yarn, PRUint32 i);
|
|
static void YarnTonsString(struct mdbYarn *yarn, nsString *str);
|
|
static void YarnToUInt32(struct mdbYarn *yarn, PRUint32 *i);
|
|
|
|
static void CleanupCache();
|
|
#ifdef DEBUG
|
|
static int GetNumInCache(void) {return(GetDBCache()->Count());}
|
|
static void DumpCache();
|
|
virtual nsresult DumpContents();
|
|
#endif
|
|
|
|
friend class nsMsgHdr; // use this to get access to cached tokens for hdr fields
|
|
friend class nsMsgDBEnumerator;
|
|
|
|
protected:
|
|
nsISupportsArray/*<nsIDBChangeListener>*/* m_ChangeListeners;
|
|
nsDBFolderInfo *m_dbFolderInfo;
|
|
nsIMdbEnv *m_mdbEnv; // to be used in all the db calls.
|
|
nsIMdbStore *m_mdbStore;
|
|
nsIMdbTable *m_mdbAllMsgHeadersTable;
|
|
nsFileSpec m_dbName;
|
|
|
|
nsNewsSet *m_newSet; // new messages since last open.
|
|
|
|
nsresult CreateMsgHdr(nsIMdbRow* hdrRow, nsFileSpec& path, nsMsgKey key, nsIMessage* *result,
|
|
PRBool createKeyFromHeader = PR_FALSE);
|
|
static void AddToCache(nsMsgDatabase* pMessageDB)
|
|
{GetDBCache()->AppendElement(pMessageDB);}
|
|
static void RemoveFromCache(nsMsgDatabase* pMessageDB);
|
|
static int FindInCache(nsMsgDatabase* pMessageDB);
|
|
PRBool MatchDbName(nsFileSpec &dbName); // returns TRUE if they match
|
|
|
|
#ifdef XP_PC // this should go away when we can provide our own file stream to MDB/Mork
|
|
static void UnixToNative(char*& ioPath);
|
|
#endif
|
|
virtual nsresult SetKeyFlag(nsMsgKey key, PRBool set, PRInt32 flag,
|
|
nsIDBChangeListener *instigator = NULL);
|
|
virtual PRBool SetHdrFlag(nsIMessage *, PRBool bSet, MsgFlags flag);
|
|
virtual PRUint32 GetStatusFlags(nsIMessage *msgHdr);
|
|
// helper function which doesn't involve thread object
|
|
NS_IMETHOD MarkHdrReadInDB(nsIMessage *msgHdr, PRBool bRead,
|
|
nsIDBChangeListener *instigator);
|
|
|
|
virtual nsresult RemoveHeaderFromDB(nsMsgHdr *msgHdr);
|
|
|
|
|
|
static nsISupportsArray/*<nsMsgDatabase>*/* GetDBCache();
|
|
static nsISupportsArray/*<nsMsgDatabase>*/* m_dbCache;
|
|
|
|
// mdb bookkeeping stuff
|
|
nsresult InitExistingDB();
|
|
nsresult InitNewDB();
|
|
nsresult InitMDBInfo();
|
|
PRBool m_mdbTokensInitialized;
|
|
|
|
mdb_token m_hdrRowScopeToken;
|
|
mdb_token m_hdrTableKindToken;
|
|
mdb_token m_subjectColumnToken;
|
|
mdb_token m_senderColumnToken;
|
|
mdb_token m_messageIdColumnToken;
|
|
mdb_token m_referencesColumnToken;
|
|
mdb_token m_recipientsColumnToken;
|
|
mdb_token m_dateColumnToken;
|
|
mdb_token m_messageSizeColumnToken;
|
|
mdb_token m_flagsColumnToken;
|
|
mdb_token m_priorityColumnToken;
|
|
mdb_token m_statusOffsetColumnToken;
|
|
mdb_token m_numLinesColumnToken;
|
|
mdb_token m_ccListColumnToken;
|
|
};
|
|
|
|
#endif
|