gecko-dev/mailnews/db/msgdb/public/nsNewsDatabase.h
1999-09-17 20:13:22 +00:00

99 lines
3.7 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 _nsNewsDatabase_H_
#define _nsNewsDatabase_H_
#include "nsMsgDatabase.h"
#include "nsINewsDatabase.h"
class nsIDBChangeListener;
class nsMsgKeyArray;
class MSG_RetrieveArtInfo;
class MSG_PurgeInfo;
// news group database
class nsNewsDatabase : public nsMsgDatabase , public nsINewsDatabase
{
public:
nsNewsDatabase();
virtual ~nsNewsDatabase();
NS_DECL_ISUPPORTS_INHERITED
virtual nsresult MessageDBOpenUsingURL(const char * groupURL);
char *GetGroupURL() { return m_groupURL; }
NS_IMETHOD Open(nsIFileSpec *newsgroupName, PRBool create, PRBool upgrading, nsIMsgDatabase** pMessageDB);
NS_IMETHOD Close(PRBool forceCommit);
NS_IMETHOD ForceClosed();
NS_IMETHOD Commit(nsMsgDBCommit commitType);
virtual PRUint32 GetCurVersion();
// methods to get and set docsets for ids.
NS_IMETHOD MarkHdrRead(nsIMsgDBHdr *msgHdr, PRBool bRead,
nsIDBChangeListener *instigator = NULL);
NS_IMETHOD IsRead(nsMsgKey key, PRBool *pRead);
virtual PRBool IsArticleOffline(nsMsgKey key);
virtual nsresult AddHdrFromXOver(const char * line, nsMsgKey *msgId);
NS_IMETHOD AddHdrToDB(nsMsgHdr *newHdr, PRBool *newThread, PRBool notify = PR_FALSE);
NS_IMETHOD ListNextUnread(ListContext **pContext, nsMsgHdr **pResult);
NS_IMETHOD GetHighWaterArticleNum(nsMsgKey *key);
NS_IMETHOD GetLowWaterArticleNum(nsMsgKey *key);
// for nsINewsDatabase
NS_IMETHOD GetUnreadSet(nsMsgKeySet **pSet);
NS_IMETHOD SetUnreadSet(const char * setStr);
virtual nsresult ExpireUpTo(nsMsgKey expireKey);
virtual nsresult ExpireRange(nsMsgKey startRange, nsMsgKey endRange);
virtual nsNewsDatabase *GetNewsDB() ;
virtual PRBool PurgeNeeded(MSG_PurgeInfo *hdrPurgeInfo, MSG_PurgeInfo *artPurgeInfo);
PRBool IsCategory();
nsresult SetOfflineRetrievalInfo(MSG_RetrieveArtInfo *);
nsresult SetPurgeHeaderInfo(MSG_PurgeInfo *purgeInfo);
nsresult SetPurgeArticleInfo(MSG_PurgeInfo *purgeInfo);
nsresult GetOfflineRetrievalInfo(MSG_RetrieveArtInfo *info);
nsresult GetPurgeHeaderInfo(MSG_PurgeInfo *purgeInfo);
nsresult GetPurgeArticleInfo(MSG_PurgeInfo *purgeInfo);
// used to handle filters editing on open news groups.
//static void NotifyOpenDBsOfFilterChange(MSG_FolderInfo *folder);
void ClearFilterList(); // filter was changed by user.
void OpenFilterList();
// void OnFolderFilterListChanged(MSG_FolderInfo *folder);
// caller needs to free
static char *GetGroupNameFromURL(const char *url);
protected:
virtual PRBool ThreadBySubjectWithoutRe() ;
nsFileSpec *m_newsgroupSpec;
char *m_groupURL;
// MSG_FilterList* m_filterList;
PRUint32 m_headerIndex; // index of unthreaded headers
// at a specified entry.
nsMsgKeySet *m_unreadSet;
};
#endif