/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef COMM_MAILNEWS_LOCAL_SRC_NSPARSEMAILBOX_H_
#define COMM_MAILNEWS_LOCAL_SRC_NSPARSEMAILBOX_H_

#include "ImapTypes.h"
#include "nsIMsgParseMailMsgState.h"
#include "nsMsgLineBuffer.h"
#include "nsIMsgDatabase.h"
#include "nsIMsgHdr.h"
#include "nsCOMPtr.h"
#include "nsCOMArray.h"
#include "nsIDBChangeListener.h"
#include "nsIMsgWindow.h"
#include "nsImapMoveCoalescer.h"
#include "nsIMsgFilterList.h"
#include "nsIMsgFilter.h"
#include "nsIMsgFilterHitNotify.h"
#include "nsTArray.h"
#include "nsTHashMap.h"
#include "mozilla/UniquePtr.h"
#include "mozilla/Vector.h"

class nsOutputFileStream;
class nsIMsgFolder;

// Used for the various things that parse RFC822 headers...
struct HeaderData {
  const char* value = nullptr;  // The contents of a header (after ": ")
  size_t length = 0;  // The length of the data (it is not NULL-terminated.)
};

// This object maintains the parse state for a single mail message.
class nsParseMailMessageState : public nsIMsgParseMailMsgState,
                                public nsIDBChangeListener {
 public:
  NS_DECL_ISUPPORTS
  NS_DECL_NSIMSGPARSEMAILMSGSTATE
  NS_DECL_NSIDBCHANGELISTENER

  nsParseMailMessageState();

  // A way to pass in 'out-of-band' envelope sender/timestamp data.
  // Totally optional, but envDate is used to fill in on malformed messages
  // without a "Date:" header.
  void SetEnvDetails(nsACString const& envAddr, PRTime envDate) {
    m_EnvAddr = envAddr;
    m_EnvDate = envDate;
  }

  nsCOMPtr<nsIMsgDatabase> m_mailDB;
  nsCOMPtr<nsIMsgDatabase> m_backupMailDB;
  int64_t m_position;
  // The start of the "From " line (the line before the start of the message).
  uint64_t m_envelope_pos;
  uint16_t m_body_lines;

 protected:
  nsresult ParseFolderLine(const char* line, uint32_t lineLength);
  nsresult ParseHeaders();
  nsresult FinalizeHeaders();
  nsresult InternSubject(HeaderData* header);

  nsMailboxParseState m_state;
  nsCOMPtr<nsIMsgDBHdr> m_newMsgHdr; /* current message header we're building */
  // These two aren't part of the message, but may be provided 'out-of-band',
  // via SetEnvDetails();
  // Traditionally they are parsed from the "From " lines in
  // mbox files.
  nsAutoCString m_EnvAddr;  // "" if missing.
  PRTime m_EnvDate;         // 0 if missing.

  ImapUid m_msgUid;  // IMAP UID for the new header.

  // The raw header data.
  mozilla::Vector<char> m_headers;

  // These all point into the m_headers buffer.
  HeaderData m_message_id;
  HeaderData m_references;
  HeaderData m_date;
  HeaderData m_delivery_date;
  HeaderData m_from;
  HeaderData m_sender;
  HeaderData m_newsgroups;
  HeaderData m_subject;
  HeaderData m_status;
  HeaderData m_mozstatus;
  HeaderData m_mozstatus2;
  HeaderData m_in_reply_to;
  HeaderData m_replyTo;
  HeaderData m_content_type;
  HeaderData m_bccList;

  // Support for having multiple To or Cc header lines in a message
  AutoTArray<HeaderData, 1> m_toList;
  AutoTArray<HeaderData, 1> m_ccList;

  HeaderData m_priority;
  HeaderData m_account_key;
  HeaderData m_keywords;

  // Mdn support
  HeaderData m_mdn_original_recipient;
  HeaderData m_return_path;
  HeaderData m_mdn_dnt; /* MDN Disposition-Notification-To: header */

  PRTime m_receivedTime;

  // this enables extensions to add the values of particular headers to
  // the .msf file as properties of nsIMsgHdr. It is initialized from a
  // pref, mailnews.customDBHeaders
  nsTArray<nsCString> m_customDBHeaders;
  nsTArray<HeaderData> m_customDBHeaderData;
  nsCString m_receivedValue;  // accumulated received header
  virtual ~nsParseMailMessageState() {};
};

class nsParseNewMailState : public nsParseMailMessageState,
                            public nsMsgLineBuffer,
                            public nsIMsgFilterHitNotify {
 public:
  nsParseNewMailState();
  NS_DECL_ISUPPORTS_INHERITED

  nsresult Init(nsIMsgFolder* rootFolder, nsIMsgFolder* downloadFolder,
                nsIMsgWindow* aMsgWindow, nsIMsgDBHdr* aHdr,
                nsIOutputStream* aOutputStream);

  void DoneParsing();

  void DisableFilters() { m_disableFilters = true; }

  NS_DECL_NSIMSGFILTERHITNOTIFY

  virtual void PublishMsgHeader(nsIMsgWindow* msgWindow);
  void GetMsgWindow(nsIMsgWindow** aMsgWindow);
  nsresult EndMsgDownload();

  void ApplyFilters(bool* pMoved, nsIMsgWindow* msgWindow);
  nsresult ApplyForwardAndReplyFilter(nsIMsgWindow* msgWindow);

  // These three vars are public because they need to be carried between
  // messages.

  // this keeps track of how many messages we downloaded that
  // aren't new - e.g., marked read, or moved to an other server.
  int32_t m_numNotNewMessages;
  // Filter-initiated moves are collected to run all at once.
  RefPtr<nsImapMoveCoalescer> m_moveCoalescer;
  mozilla::UniquePtr<nsTHashMap<nsCStringHashKey, int32_t>>
      m_filterTargetFoldersMsgMovedCount;

  // for nsMsgLineBuffer
  virtual nsresult HandleLine(const char* line, uint32_t line_length) override;

  void UpdateDBFolderInfo();
  void UpdateDBFolderInfo(nsIMsgDatabase* mailDB);

 protected:
  virtual ~nsParseNewMailState();
  virtual nsresult GetTrashFolder(nsIMsgFolder** pTrashFolder);
  virtual nsresult MoveIncorporatedMessage(nsIMsgDBHdr* mailHdr,
                                           nsIMsgDatabase* sourceDB,
                                           nsIMsgFolder* destIFolder,
                                           nsIMsgFilter* filter,
                                           nsIMsgWindow* msgWindow);
  virtual void MarkFilteredMessageRead(nsIMsgDBHdr* msgHdr);
  virtual void MarkFilteredMessageUnread(nsIMsgDBHdr* msgHdr);

  nsCOMPtr<nsIMsgFilterList> m_filterList;
  nsCOMPtr<nsIMsgFilterList> m_deferredToServerFilterList;
  nsCOMPtr<nsIMsgFolder> m_rootFolder;
  nsCOMPtr<nsIMsgWindow> m_msgWindow;
  nsCOMPtr<nsIMsgFolder> m_downloadFolder;
  nsCOMPtr<nsIOutputStream> m_outputStream;
  nsCOMArray<nsIMsgFolder> m_filterTargetFolders;
  nsCString m_inboxUri;

  bool m_msgMovedByFilter;
  bool m_msgCopiedByFilter;
  bool m_disableFilters;

  // we have to apply the reply/forward filters in a second pass, after
  // msg quarantining and moving to other local folders, so we remember the
  // info we'll need to apply them with these vars.
  // these need to be arrays in case we have multiple reply/forward filters.
  nsTArray<nsCString> m_forwardTo;
  nsTArray<nsCString> m_replyTemplateUri;
  nsCOMPtr<nsIMsgDBHdr> m_msgToForwardOrReply;
  nsCOMPtr<nsIMsgFilter> m_filter;
  nsCOMPtr<nsIMsgRuleAction> m_ruleAction;
};

#endif  // COMM_MAILNEWS_LOCAL_SRC_NSPARSEMAILBOX_H_