Issue #1258 - Part 1: Import mailnews, ldap, and mork from comm-esr52.9.1

mailnews/base/search/public/nsMsgBodyHandler.h

@@ -0,0 +1,112 @@
+/* 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 __nsMsgBodyHandler_h
+#define __nsMsgBodyHandler_h
+
+#include "nsIMsgSearchScopeTerm.h"
+#include "nsILineInputStream.h"
+#include "nsIMsgDatabase.h"
+
+//---------------------------------------------------------------------------
+// nsMsgBodyHandler: used to retrieve lines from POP and IMAP offline messages.
+// This is a helper class used by nsMsgSearchTerm::MatchBody
+//---------------------------------------------------------------------------
+class nsMsgBodyHandler
+{
+public:
+  nsMsgBodyHandler (nsIMsgSearchScopeTerm *,
+    uint32_t length,
+    nsIMsgDBHdr * msg,
+    nsIMsgDatabase * db);
+
+  // we can also create a body handler when doing arbitrary header
+  // filtering...we need the list of headers and the header size as well
+  // if we are doing filtering...if ForFilters is false, headers and
+  // headersSize is ignored!!!
+  nsMsgBodyHandler (nsIMsgSearchScopeTerm *,
+    uint32_t length, nsIMsgDBHdr * msg, nsIMsgDatabase * db,
+    const char * headers /* NULL terminated list of headers */,
+    uint32_t headersSize, bool ForFilters);
+
+  virtual ~nsMsgBodyHandler();
+
+  // Returns next message line in buf and the applicable charset, if found.
+  // The return value is the length of 'buf' or -1 for EOF.
+  int32_t GetNextLine(nsCString &buf, nsCString &charset);
+
+  // Transformations
+  void SetStripHtml (bool strip) { m_stripHtml = strip; }
+  void SetStripHeaders (bool strip) { m_stripHeaders = strip; }
+
+protected:
+  void Initialize();  // common initialization code
+
+  // filter related methods. For filtering we always use the headers
+  // list instead of the database...
+  bool m_Filtering;
+  int32_t GetNextFilterLine(nsCString &buf);
+  // pointer into the headers list in the original message hdr db...
+  const char * m_headers;
+  uint32_t m_headersSize;
+  uint32_t m_headerBytesRead;
+
+  // local / POP related methods
+  void OpenLocalFolder();
+
+  // goes through the mail folder
+  int32_t GetNextLocalLine(nsCString &buf);
+
+  nsIMsgSearchScopeTerm *m_scope;
+  nsCOMPtr <nsILineInputStream> m_fileLineStream;
+  nsCOMPtr <nsIFile> m_localFile;
+
+  /**
+   * The number of lines in the message.  If |m_lineCountInBodyLines| then this
+   * is the number of body lines, otherwise this is the entire number of lines
+   * in the message.  This is important so we know when to stop reading the file
+   * without accidentally reading part of the next message.
+   */
+  uint32_t m_numLocalLines;
+  /**
+   * When true, |m_numLocalLines| is the number of body lines in the message,
+   * when false it is the entire number of lines in the message.
+   *
+   * When a message is an offline IMAP or news message, then the number of lines
+   * will be the entire number of lines, so this should be false.  When the
+   * message is a local message, the number of lines will be the number of body
+   * lines.
+   */
+  bool m_lineCountInBodyLines;
+
+  // Offline IMAP related methods & state
+
+
+  nsCOMPtr<nsIMsgDBHdr> m_msgHdr;
+  nsCOMPtr<nsIMsgDatabase> m_db;
+
+  // Transformations
+  // With the exception of m_isMultipart, these all apply to the various parts
+  bool m_stripHeaders;    // true if we're supposed to strip of message headers
+  bool m_stripHtml;       // true if we're supposed to strip off HTML tags
+  bool m_pastMsgHeaders;  // true if we've already skipped over the message headers
+  bool m_pastPartHeaders; // true if we've already skipped over the part headers
+  bool m_partIsHtml;      // true if the Content-type header claims text/html
+  bool m_base64part;      // true if the current part is in base64
+  bool m_isMultipart;     // true if the message is a multipart/* message
+  bool m_partIsText;      // true if the current part is text/*
+  bool m_inMessageAttachment; // true if current part is message/*
+
+  nsTArray<nsCString> m_boundaries;  // The boundary strings to look for
+  nsCString m_partCharset; // The charset found in the part
+
+  // See implementation for comments
+  int32_t ApplyTransformations (const nsCString &line, int32_t length,
+                                bool &returnThisLine, nsCString &buf);
+  void SniffPossibleMIMEHeader (const nsCString &line);
+  static void StripHtml (nsCString &buf);
+  static void Base64Decode (nsCString &buf);
+};
+#endif