gecko-dev/lib/libmsg/listngst.cpp

/* -*- 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) 1998 Netscape Communications Corporation.  All Rights
 * Reserved.
 */
#include "msg.h"
#include "listngst.h"
#include "dberror.h"
#include "newsdb.h"
#include "msgdbvw.h"
#include "newsset.h"
#include "msgpane.h"
#include "xpgetstr.h"
#include "grpinfo.h"
#include "prefapi.h"
#include "msgprefs.h"
#include "msgstrob.h"

extern "C"
{
	extern int MK_OUT_OF_MEMORY;
	extern int MK_HDR_DOWNLOAD_COUNT;
	extern int MK_NO_NEW_DISC_MSGS;
}

ListNewsGroupState::ListNewsGroupState(const char *url, const char *groupName, MSG_Pane *pane)
{
	m_newsDB = NULL;
	m_msgDBView = NULL;
	m_groupName = XP_STRDUP(groupName);
	m_host = NULL;
	m_url = XP_STRDUP(url);
	m_lastProcessedNumber = 0;
	m_lastMsgNumber = 0;
	m_set = NULL;
	XP_ASSERT(pane);
	m_pane = pane;
	m_master = pane->GetMaster();

	m_startedUpdate = FALSE;
	XP_MEMSET(&m_knownArts, 0, sizeof(m_knownArts));
	m_knownArts.group_name = m_groupName;
	char* host_and_port = NET_ParseURL(url, GET_HOST_PART);
	m_host = m_master->FindHost(host_and_port,
								(url[0] == 's' || url[0] == 'S'),
								-1);
	FREEIF(host_and_port);
	m_knownArts.host = m_host;
	m_getOldMessages = FALSE;
	m_promptedAlready = FALSE;
	m_downloadAll = FALSE;
	m_maxArticles = 0;
}

ListNewsGroupState::~ListNewsGroupState()
{
	XP_FREE(m_url);
	XP_FREE(m_groupName);
	if (m_msgDBView != NULL)
		m_msgDBView->Remove(this);

	if (m_newsDB)
		m_newsDB->Close();
	delete m_knownArts.set;
}

void ListNewsGroupState::SetView(MessageDBView *view) 
{
	m_msgDBView = view;
	if (view)
		view->Add(this);
}

void	ListNewsGroupState::OnAnnouncerGoingAway (ChangeAnnouncer *instigator)
{
	if (m_msgDBView != NULL)
	{
		m_msgDBView->Remove(this);
		m_msgDBView->NotifyAnnouncerGoingAway(instigator);	// shout it to the world!
		m_msgDBView = NULL;
	}
}

extern "C" XP_Bool FE_NewsDownloadPrompt(MWContext *context,
                                         int32 numMessagesToDownload,
                                         XP_Bool *downloadAll);

int ListNewsGroupState::GetRangeOfArtsToDownload(MSG_NewsHost* host,
							 const char* group_name,
							 int32 first_possible,
							 int32 last_possible,
							 int32 maxextra,
							 int32* first,
							 int32* last)
{
	int status = 0;
	XP_Bool emptyGroup_p = FALSE;
	MsgERR		err;

	XP_ASSERT(first && last);
	if (!first || !last) return -1;

	*first = 0;
	*last = 0;

	if (m_pane != NULL && !m_startedUpdate)
	{
		m_startedUpdate = TRUE;
		m_pane->StartingUpdate(MSG_NotifyNone, 0, 0);
	}

	if (!m_newsDB)
	{
		if ((err = NewsGroupDB::Open(m_url, m_master, &m_newsDB)) != eSUCCESS)
			return ConvertMsgErrToMKErr(err);	
		else
		{
			m_set = m_newsDB->GetNewsArtSet();
			m_set->SetLastMember(last_possible);	// make sure highwater mark is valid.
			NewsFolderInfo *newsGroupInfo = m_newsDB->GetNewsFolderInfo();
			if (newsGroupInfo)
			{
				XPStringObj knownArtsString;
				newsGroupInfo->GetKnownArtsSet(knownArtsString);
				m_knownArts.set = msg_NewsArtSet::Create(knownArtsString);
			}
			else
			{
				m_knownArts.set = msg_NewsArtSet::Create();
				m_knownArts.set->AddRange(m_newsDB->GetLowWaterArticleNum(), m_newsDB->GetHighwaterArticleNum());
			}
			m_pane->StartingUpdate(MSG_NotifyNone, 0, 0);
			m_newsDB->ExpireUpTo(first_possible, m_pane->GetContext());
			m_pane->EndingUpdate(MSG_NotifyNone, 0, 0);
			if (m_knownArts.set->IsMember(last_possible))	// will this be progress pane?
			{
				char *noNewMsgs = XP_GetString(MK_NO_NEW_DISC_MSGS);
				MWContext *context = m_pane->GetContext();
				MSG_Pane* parentpane = m_pane->GetParentPane();
				// send progress to parent pane, if any, because progress pane is going down.
				if (parentpane)
					context = parentpane->GetContext();
				FE_Progress (context, noNewMsgs);	
			}
		}
	}

	if (maxextra <= 0 || last_possible < first_possible || last_possible < 1) 
	{
		emptyGroup_p = TRUE;
	}

	if (m_knownArts.host != host ||
	  m_knownArts.group_name == NULL ||
	  XP_STRCMP(m_knownArts.group_name, group_name) != 0 ||
	  !m_knownArts.set) 
	{
	/* We're displaying some other group.  Clear out that display, and set up
	   everything to return the proper first chunk. */
		XP_ASSERT(FALSE);	// ### dmb todo - need nwo way of doing this
		if (emptyGroup_p)
		  return 0;
	}
	else
	{
	if (emptyGroup_p)
	  return 0;
	}

	m_knownArts.first_possible = first_possible;
	m_knownArts.last_possible = last_possible;

	/* Determine if we only want to get just new articles or more messages.
	If there are new articles at the end we haven't seen, we always want to get those first.  
	Otherwise, we get the newest articles we haven't gotten, if we're getting more. 
	My thought for now is that opening a newsgroup should only try to get new articles.
	Selecting "More Messages" will first try to get unseen messages, then old messages. */

	if (m_getOldMessages || !m_knownArts.set->IsMember(last_possible)) 
	{
		XP_Bool notifyMaxExceededOn = (m_pane && m_pane->GetPrefs() && m_pane->GetPrefs()->GetNewsNotifyOn());
		// if the preference to notify when downloading more than x headers is not on,
		// and we're downloading new headers, set maxextra to a very large number.
		if (!m_getOldMessages && !notifyMaxExceededOn)
			maxextra = 0x7FFFFFFFL;

		status = m_knownArts.set->LastMissingRange(first_possible, last_possible,
								  first, last);
		if (status < 0) 
			return status;
		if (*first > 0 && *last - *first >= maxextra) 
		{
			if (!m_getOldMessages && !m_promptedAlready && notifyMaxExceededOn)
			{
				XP_Bool result = FE_NewsDownloadPrompt(m_pane->GetContext(),
													*last - *first + 1,
													&m_downloadAll);
				if (result)
				{
					m_maxArticles = 0;

					PREF_GetIntPref("news.max_articles", &m_maxArticles);
					NET_SetNumberOfNewsArticlesInListing(m_maxArticles);
					maxextra = m_maxArticles;
					if (!m_downloadAll)
					{
						XP_Bool markOldRead = FALSE;
						PREF_GetBoolPref("news.mark_old_read", &markOldRead);
						if (markOldRead && m_set)
							m_set->AddRange(*first, *last - maxextra); 
						*first = *last - maxextra + 1;
					}
				}
				else
					*first = *last = 0;
				m_promptedAlready = TRUE;
			}
			else if (m_promptedAlready && !m_downloadAll)
				*first = *last - m_maxArticles + 1;
			else if (!m_downloadAll)
				*first = *last - maxextra + 1;
		}
	}
#ifdef DEBUG_bienvenu
	XP_Trace("GetRangeOfArtsToDownload(first possible = %ld, last possible = %ld, first = %ld, last = %ld maxextra = %ld\n",
			first_possible, last_possible, *first, *last, maxextra);
#endif
	return 0;
}

int ListNewsGroupState::AddToKnownArticles(MSG_NewsHost* host,
					   const char* group_name,
					   int32 first, int32 last)
{
	int		status;
	if (m_knownArts.host != host ||
	  m_knownArts.group_name == NULL ||
	  XP_STRCMP(m_knownArts.group_name, group_name) != 0 ||
	  !m_knownArts.set) 
	{
		m_knownArts.host = host;
		FREEIF(m_knownArts.group_name);
		m_knownArts.group_name = XP_STRDUP(group_name);
		delete m_knownArts.set;
		m_knownArts.set = msg_NewsArtSet::Create();

		if (!m_knownArts.group_name || !m_knownArts.set) {
		  return MK_OUT_OF_MEMORY;
		}

	}

	status = m_knownArts.set->AddRange(first, last);
	if (m_newsDB)
	{
		NewsFolderInfo *newsGroupInfo = m_newsDB->GetNewsFolderInfo();
		if (newsGroupInfo)
		{
			char *output = m_knownArts.set->Output();
			if (output)
				newsGroupInfo->SetKnownArtsSet(output);
			delete[] output;
		}
	}
	return status;
}

int ListNewsGroupState::InitXOVER(
			MSG_NewsHost* /*host*/,
			const char * /*group_name*/,
			uint32 first_msg, uint32 last_msg,
			uint32 /*oldest_msg*/, uint32 /*youngest_msg*/)
{
	int		status = 0;

	// Tell the FE to show the GetNewMessages progress dialog
	FE_PaneChanged (m_pane, FALSE, MSG_PanePastPasswordCheck, 0);

	/* Consistency checks, not that I know what to do if it fails (it will
	 probably handle it OK...) */
	XP_ASSERT(first_msg <= last_msg);

	/* If any XOVER lines from the last time failed to come in, mark those
	   messages as read. */
	if (m_lastProcessedNumber < m_lastMsgNumber) 
	{
		m_set->AddRange(m_lastProcessedNumber + 1, m_lastMsgNumber);
	}
	m_firstMsgNumber = first_msg;
	m_lastMsgNumber = last_msg;
	m_lastProcessedNumber = first_msg > 1 ? first_msg - 1 : 1;

	return status;
}

int ListNewsGroupState::ProcessXOVER(char *line)
{
	int status = 0;
	char *next;
	uint32 message_number;
	//  int32 lines;
	XP_Bool read_p = FALSE;

	XP_ASSERT (line);
	if (!line)
		return -1;

	if (m_msgDBView != NULL)
	{
		status = ConvertMsgErrToMKErr(m_msgDBView->AddHdrFromServerLine(line, &message_number));
		if (status < 0)
			return status;
	}
	else if (m_newsDB != NULL)
	{
		status = ConvertMsgErrToMKErr(m_newsDB->AddHdrFromXOver(line, &message_number));
	}
	else
		return -1;

	next = line;


	XP_ASSERT(message_number > m_lastProcessedNumber ||
			message_number == 1);
	if (m_set && message_number > m_lastProcessedNumber + 1)
	{
		/* There are some articles that XOVER skipped; they must no longer
		   exist.  Mark them as read in the newsrc, so we don't include them
		   next time in our estimated number of unread messages. */
		if (m_set->AddRange(m_lastProcessedNumber + 1, message_number - 1)) 
		{
		  /* This isn't really an important enough change to warrant causing
			 the newsrc file to be saved; we haven't gathered any information
			 that won't also be gathered for free next time.
		   */
		}
	}

	m_lastProcessedNumber = message_number;
	if (m_knownArts.set) 
	{
		status = m_knownArts.set->Add(message_number);
		if (status < 0) return status;
	}

	if (message_number > m_lastMsgNumber)
	m_lastMsgNumber = message_number;
	else if (message_number < m_firstMsgNumber)
	m_firstMsgNumber = message_number;

	if (m_set) {
		read_p = m_set->IsMember(message_number);
	}

	/* Update the thermometer with a percentage of articles retrieved.
	*/
	if (m_lastMsgNumber > m_firstMsgNumber)
	{
		int32 percent = (int32) (100 * (((double) (m_lastProcessedNumber-
										m_firstMsgNumber + 1)) /
							 ((double) (m_lastMsgNumber -
										m_firstMsgNumber + 1))));
		char *statusTemplate = XP_GetString (MK_HDR_DOWNLOAD_COUNT);
		FE_SetProgressBarPercent (m_pane->GetContext(), percent);
		char *statusString = PR_smprintf (statusTemplate,  m_lastProcessedNumber - m_firstMsgNumber + 1, m_lastMsgNumber - m_firstMsgNumber + 1);

		FE_Progress (m_pane->GetContext(), statusString);
		XP_FREE(statusString);
	}
	return status;
}

int ListNewsGroupState::ResetXOVER()
{
	m_lastMsgNumber = m_firstMsgNumber;
	m_lastProcessedNumber = m_lastMsgNumber;
	return 0;
}

/* When we don't have XOVER, but use HEAD, this is called instead.
   It reads lines until it has a whole header block, then parses the
   headers; then takes selected headers and creates an XOVER line
   from them.  This is more for simplicity and code sharing than
   anything else; it means we end up parsing some things twice.
   But if we don't have XOVER, things are going to be so horribly
   slow anyway that this just doesn't matter.
 */

int ListNewsGroupState::ProcessNonXOVER (char * /*line*/)
{
	// ### dmb write me
  int status = 0;
  return status;
}



int ListNewsGroupState::FinishXOVER (int status)
{
	struct MSG_NewsKnown* k;

	/* If any XOVER lines from the last time failed to come in, mark those
	 messages as read. */

	if (status >= 0 && m_lastProcessedNumber < m_lastMsgNumber) 
	{
		m_set->AddRange(m_lastProcessedNumber + 1, m_lastMsgNumber);
	}


	if (m_msgDBView != NULL)
	{
		// we should think about not doing this if status != MK_INTERRUPTED, but we'd need to still clean up the view.
		m_msgDBView->AddNewMessages();
		m_msgDBView->Remove(this);
		m_msgDBView = NULL;
	}

	if (m_newsDB)
	{
		m_newsDB->Close();
		m_newsDB = NULL;
	}

	k = &m_knownArts;

	if (k->set) 
	{
		int32 n = k->set->FirstNonMember();
		if (n < k->first_possible || n > k->last_possible) 
		{
		  /* We know we've gotten all there is to know.  Take advantage of that to
			 update our counts... */
			// ### dmb
		}
	}

	if (m_pane != NULL)
	{
		// save the pane and NULL out m_pane - this is a horrible hack to avoid recursive 
		// calls which happen when the fe selects a message as a result of getting EndingUpdate,
		// which interrupts this url right before it was going to finish and causes FinishXOver
		// to get called again.
		MSG_Pane	*savePane = m_pane;
		m_pane = NULL;
		// if we haven't started an update, start one so the fe
		// will know to update the size of the view.
		if (!m_startedUpdate)
		{
			savePane->StartingUpdate(MSG_NotifyNone, 0, 0);
			m_startedUpdate = TRUE;
		}
		savePane->EndingUpdate(MSG_NotifyNone, 0, 0);
		m_startedUpdate = FALSE;

		if (m_lastMsgNumber > 0)
		{
			MWContext *context = savePane->GetContext();
			MSG_Pane* parentpane = savePane->GetParentPane();
			// send progress to parent pane, if any, because progress pane is going down.
			if (parentpane)
				context = parentpane->GetContext();

			char *statusTemplate = XP_GetString (MK_HDR_DOWNLOAD_COUNT);
			char *statusString = PR_smprintf (statusTemplate,  m_lastProcessedNumber - m_firstMsgNumber + 1, m_lastMsgNumber - m_firstMsgNumber + 1);

			if (statusString)
			{
				FE_Progress (context, statusString);
				XP_FREE(statusString);
			}
		}
		MSG_FolderInfoNews *newsFolder = NULL; // This is the way it was.
		// All platforms should probably do this!  But I'm scared to make it so - jrm 98/03/10
		// Be brave, my son! I might as well experience any pane, er, pain, this is going to cause - dmb
		newsFolder = (savePane) ? savePane->GetMaster()->FindNewsFolder(m_host, m_groupName, FALSE) : 0;
		FE_PaneChanged(savePane, FALSE, MSG_PaneNotifyFolderLoaded, (uint32)newsFolder);
	}

	return 0;
	// ListNewsGroupState object gets deleted by the master when a new one is created.
}

ListNewsGroupArticleKeysState::ListNewsGroupArticleKeysState(MSG_NewsHost *host, const char *groupName, MSG_Pane *pane)
{
	m_host = host;
	m_groupName = groupName;
	m_pane = pane;
	m_newsDB = NULL;
	m_idsOnServer.set = msg_NewsArtSet::Create();
	MSG_FolderInfoNews *newsFolder = m_pane->GetMaster()->FindNewsFolder(host, groupName, FALSE);
	if (newsFolder)
	{
		char *url = newsFolder->BuildUrl(NULL, MSG_MESSAGEKEYNONE);
		if (url)
			NewsGroupDB::Open(url, m_pane->GetMaster(), &m_newsDB);
		if (m_newsDB)
			m_newsDB->ListAllIds(m_idsInDB);
		m_dbIndex = 0;

		FREEIF(url);
	}
}

ListNewsGroupArticleKeysState::~ListNewsGroupArticleKeysState()
{
	if (m_newsDB)
		m_newsDB->Close();
}

int ListNewsGroupArticleKeysState::AddArticleKey(int32 key)
{
	m_idsOnServer.set->Add(key);
	if (m_dbIndex < m_idsInDB.GetSize())
	{
		int32 idInDBToCheck = m_idsInDB.GetAt(m_dbIndex);
		// if there are keys in the database that aren't in the newsgroup
		// on the server, remove them. We probably shouldn't do this if
		// we have a copy of the article offline.
		while (idInDBToCheck < key)
		{
			m_newsDB->DeleteMessage(idInDBToCheck, NULL, FALSE);
#ifdef DEBUG_bienvenu
			m_idsDeleted.Add(idInDBToCheck);
#endif
			if (m_dbIndex >= m_idsInDB.GetSize())
				break;
			idInDBToCheck = m_idsInDB.GetAt(++m_dbIndex);
		}
		if (idInDBToCheck == key)
			m_dbIndex++;
	}
	return 0;
}

int ListNewsGroupArticleKeysState::FinishAddingArticleKeys()
{
	// make sure none of the deleted turned up on the idsOnServer list
#ifdef DEBUG_bienvenu
	for (int32 i = 0; i < m_idsDeleted.GetSize(); i++)
		XP_ASSERT (!m_idsOnServer.set->IsMember(m_idsDeleted.GetAt(i)));
#endif
	return 0;
}