path: root/src/include/maildirmessage.h

/**
 *  @file  maildirmessage.h
 *  @brief  Declaration of the MaildirMessage class.
 *  @author Andreas Aardal Hanssen
 *  @date 2002-2005
 */

#ifndef maildirmessage_h_included
#define maildirmessage_h_included

#include "address.h"
#include "message.h"
#include "mime.h"

#include <deque>
#include <exception>
#include <iostream>
#include <map>
#include <string>
#include <vector>

#include <stdio.h>
#include <string.h>
#include <time.h>

namespace Binc {

  class Maildir;

  /*!
    \class MaildirMessage
    \brief The MaildirMessage class provides an interface for
    IMAP messages.

    Mailbox independent operations and properties are available
    through this interface.

    \sa Message
  */
  class MaildirMessage : public Message {
  public:
    /*!
      Sets the UID of a message.
      \param uid The UID that will be set.
    */
    void setUID(unsigned int uid);

    /*!
      Returns the UID of a message.
    */
    unsigned int getUID() const;

    /*!
      Sets the size of the message. This size must be consistent with
      the size reported when fetching the full message.

      \param size The size of the message in characters, after
      any conversion to CRLF.
    */
    void setSize(unsigned int size);

    /*!
      Returns the size of the message, optionally determining the size
      if it is not yet known.

      \param determine If render is true and the size is unknown, the
      size will be calculated and stored implicitly. Otherwise if the
      size is unknown, 0 is returned.
    */
    unsigned int getSize(bool determine = false) const;

    /*!
      Adds one or more flags to a message.

      \param flags This is a bitmask of flags from the Flags enum.
    */
    void setStdFlag(unsigned char flags);

    /*!
      Resets all flags on a message.
    */
    void resetStdFlags();

    /*!
      Returns the flags that are set on a message.
    */
    unsigned char getStdFlags() const;

    /*
     */
    void setCustomFlag(const std::string &flag);
    void removeCustomFlag(const std::string &flag);
    void resetCustomFlags();
    std::vector<std::string> getCustomFlags() const;

    /*!
      Sets the internal flags.

      \param flags a bitmask of the Flags enum.
     */
    void setInternalFlag(unsigned char flags);

    /*!
      Removes the internal flags.

      \param flags a bitmask of the Flags enum.
    */
    void clearInternalFlag(unsigned char flags);

    /*!
      Returns the internal flags.
    */
    unsigned char getInternalFlags() const;

    /*!
      Sets a state in a message that indicates that no flags have been
      changed. Used together with hasFlagsChanged() to check if the
      flags in this message have been changed.
    */
    void setFlagsUnchanged();

    /*!
      Returns true if flags have been added or reset since the last
      call to setFlagsUnchanged(), otherwise returns false.
    */
    bool hasFlagsChanged() const;

    /*!
      Sets the internal date of a message. This is usually the date in
      which the message arrived in the mailbox.

      \param internaldate The internal date of the message in seconds
      since the epoch.
    */
    void setInternalDate(time_t internaldate);

    /*!
      Returns the internal date of the message in seconds since the
      epoch.
    */
    time_t getInternalDate() const;

    /*!
      Reads a chunk of up to 4096 bytes from a message.  Call close()
      before readChunk() to read the first chunk from a message.

      readChunk() is used for copying or appending a message to a
      mailbox.

      \param chunk The characters are stored in this string.
    */
    int readChunk(std::string &chunk);

    /*!
      Appends a chunk of bytes to a message. appendChunk() is used for
      copying or appending a message to a mailbox.

      \param chunk The content of this string is appended to the
      message.
    */
    bool appendChunk(const std::string &chunk);

    /*!
      Resets a message and frees all allocated resources.
    */
    void close();

    /*!
      Marks the message as expunged. Equivalent to calling
      setStdFlag() with F_EXPUNGED.
    */
    void setExpunged();

    /*!
      Removes the F_EXPUNGED flag from the message.
    */
    void setUnExpunged();

    /*!
      Returns true if the message is marked as expunged, otherwise
      returns false.
    */
    bool isExpunged() const;

    /*!
      Returns the first occurrance of a MIME header in a message,
      counting from the top of the message and downwards, or "" if no
      such header is found.
      \param header The name of the header to be fetched.
    */
    const std::string &getHeader(const std::string &header);

    bool headerContains(const std::string &header, const std::string &text);

    bool bodyContains(const std::string &text);
    bool textContains(const std::string &text);

    bool printBodyStructure(bool extended = true) const;

    bool printEnvelope() const;

    bool printHeader(const std::string &section,
                     std::vector<std::string> headers,
                     bool includeHeaders = false,
                     unsigned int startOffset = 0,
                     unsigned int length = UINTMAX,
                     bool mime = false) const;

    unsigned int getHeaderSize(const std::string &section,
                               std::vector<std::string> headers,
                               bool includeHeaders = false,
                               unsigned int startOffset = 0,
                               unsigned int length = UINTMAX,
                               bool mime = false) const;

    bool printBody(const std::string &section = "",
                   unsigned int startOffset = 0,
                   unsigned int length = UINTMAX) const;
    unsigned int getBodySize(const std::string &section,
                             unsigned int startOffset = 0,
                             unsigned int length = UINTMAX) const;

    bool printDoc(unsigned int startOffset = 0,
                  unsigned int length = UINTMAX,
                  bool onlyText = false) const;

    unsigned int getDocSize(unsigned int startOffset = 0,
                            unsigned int length = UINTMAX,
                            bool onlyText = false) const;

    void setUnique(const std::string &s_in);
    const std::string &getUnique() const;

    //--
    MaildirMessage(Maildir &home);
    ~MaildirMessage();

    friend class Maildir;

    bool operator<(const MaildirMessage &a) const;

    MaildirMessage(const MaildirMessage &copy);
    MaildirMessage &operator=(const MaildirMessage &copy);

    enum Flags {
      None = 0x00,
      Expunged = 0x01,
      FlagsChanged = 0x02,
      JustArrived = 0x04,
      WasWrittenTo = 0x08,
      Committed = 0x10,
      CustomFlagsChanged = 0x20
    };

  protected:
    bool parseFull() const;
    bool parseHeaders() const;

    std::string getFixedFilename() const;
    std::string getFileName() const;

    void setFile(int fd);
    int getFile() const;

    void setSafeName(const std::string &name);
    const std::string &getSafeName() const;

  private:
    mutable int fd;
    mutable MimeDocument *doc;
    mutable unsigned char internalFlags;
    mutable unsigned char stdflags;
    mutable unsigned int uid;
    mutable unsigned int size;
    mutable std::string unique;
    mutable std::string safeName;
    time_t internaldate;

    Maildir &home;
    static std::string storage;
    std::vector<std::string> *customFlags;
  };

  class MaildirMessageCache {
  public:
    ~MaildirMessageCache();

    enum ParseStatus { NotParsed, HeaderParsed, AllParsed };

    static MaildirMessageCache &getInstance();

    void removeStatus(const MaildirMessage *);
    void addStatus(const MaildirMessage *, ParseStatus pstat);
    ParseStatus getStatus(const MaildirMessage *) const;
    void clear();

  private:
    MaildirMessageCache();

    mutable std::map<const MaildirMessage *, ParseStatus> statuses;
    mutable std::deque<const MaildirMessage *> parsed;
  };
}

#endif