/****************************************************************************

**

** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the Qt Mobility Components.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#ifndef QMAILMESSAGE_H

#define QMAILMESSAGE_H

#include "qmailmessagefwd.h"

#include "qmailaddress.h"

#include "qmailid.h"

#include "qmailtimestamp.h"

#include "qprivateimplementation.h"

#include <QByteArray>

#include <QFlags>

#include <QList>

#include <QPair>

#include <QString>

#include <QStringList>

class QMailMessagePart;

class QMailMessagePartContainerPrivate;

class QDataStream;

class QTextStream;

class QFile;

class QMailMessageHeaderFieldPrivate;

class QTOPIAMAIL_EXPORT QMailMessageHeaderField : public QPrivatelyImplemented<QMailMessageHeaderFieldPrivate>, public QMailMessageHeaderFieldFwd

{

public:

    typedef QMailMessageHeaderFieldPrivate ImplementationType;

    typedef QPair<QByteArray, QByteArray> ParameterType;

    QMailMessageHeaderField();

    QMailMessageHeaderField(const QByteArray& text, FieldType fieldType = StructuredField);

    QMailMessageHeaderField(const QByteArray& name, const QByteArray& text, FieldType fieldType = StructuredField);

    bool isNull() const;

    QByteArray id() const;

    void setId(const QByteArray& text);

    QByteArray content() const;

    void setContent(const QByteArray& text);

    QByteArray parameter(const QByteArray& name) const;

    void setParameter(const QByteArray& name, const QByteArray& value);

    bool isParameterEncoded(const QByteArray& name) const;

    void setParameterEncoded(const QByteArray& name);

    QList<ParameterType> parameters() const;

    virtual QByteArray toString(bool includeName = true, bool presentable = true) const;

    virtual QString decodedContent() const;

    bool operator== (const QMailMessageHeaderField& other) const;

    static QByteArray encodeWord(const QString& input, const QByteArray& charset = "");

    static QString decodeWord(const QByteArray& input);

    static QByteArray encodeParameter(const QString& input, const QByteArray& charset = "", const QByteArray& language = "");

    static QString decodeParameter(const QByteArray& input);

    static QByteArray encodeContent(const QString& input, const QByteArray& charset = "");

    static QString decodeContent(const QByteArray& input);

    static QByteArray removeComments(const QByteArray& input);

    static QByteArray removeWhitespace(const QByteArray& input);

    template <typename Stream> void serialize(Stream &stream) const;

    template <typename Stream> void deserialize(Stream &stream);

protected:

    void parse(const QByteArray& text, FieldType fieldType);

private:

    friend class QMailMessageHeaderFieldPrivate;

    friend class QMailMessageHeaderPrivate;

    void output(QDataStream& out) const;

};

template <typename Stream>

Stream& operator<<(Stream &stream, const QMailMessageHeaderField& field) { field.serialize(stream); return stream; }

template <typename Stream>

Stream& operator>>(Stream &stream, QMailMessageHeaderField& field) { field.deserialize(stream); return stream; }

class QTOPIAMAIL_EXPORT QMailMessageContentType : public QMailMessageHeaderField

{

public:

    QMailMessageContentType();

    QMailMessageContentType(const QByteArray& type);

    QMailMessageContentType(const QMailMessageHeaderField& field);

    QByteArray type() const;

    void setType(const QByteArray& type);

    QByteArray subType() const;

    void setSubType(const QByteArray& subType);

    QByteArray name() const;

    void setName(const QByteArray& name);

    QByteArray boundary() const;

    void setBoundary(const QByteArray& boundary);

    QByteArray charset() const;

    void setCharset(const QByteArray& charset);

private:

    // Don't allow the Id to be changed

    void setId(const QByteArray& text);

};

class QTOPIAMAIL_EXPORT QMailMessageContentDisposition : public QMailMessageHeaderField, public QMailMessageContentDispositionFwd

{

public:

    QMailMessageContentDisposition();

    QMailMessageContentDisposition(const QByteArray& type);

    QMailMessageContentDisposition(DispositionType disposition);

    QMailMessageContentDisposition(const QMailMessageHeaderField& field);

    DispositionType type() const;

    void setType(DispositionType disposition);

    QByteArray filename() const;

    void setFilename(const QByteArray& filename);

    QMailTimeStamp creationDate() const;

    void setCreationDate(const QMailTimeStamp& timeStamp);

    QMailTimeStamp modificationDate() const;

    void setModificationDate(const QMailTimeStamp& timeStamp);

    QMailTimeStamp readDate() const;

    void setReadDate(const QMailTimeStamp& timeStamp);

    int size() const;

    void setSize(int size);

private:

    // Don't allow the Id to be changed

    void setId(const QByteArray& text);

};

class QMailMessageHeaderPrivate;

// This class is not exposed to clients:

class QMailMessageHeader : public QPrivatelyImplemented<QMailMessageHeaderPrivate>

{

public:

    typedef QMailMessageHeaderPrivate ImplementationType;

    QMailMessageHeader();

    QMailMessageHeader(const QByteArray& input);

    void update(const QByteArray& id, const QByteArray& content);

    void append(const QByteArray& id, const QByteArray& content);

    void remove(const QByteArray& id);

    QMailMessageHeaderField field(const QByteArray& id) const;

    QList<QMailMessageHeaderField> fields(const QByteArray& id) const;

    QList<const QByteArray*> fieldList() const;

    template <typename Stream> void serialize(Stream &stream) const;

    template <typename Stream> void deserialize(Stream &stream);

private:

    friend class QMailMessageHeaderPrivate;

    friend class QMailMessagePartContainerPrivate;

    friend class QMailMessagePartPrivate;

    friend class QMailMessagePrivate;

    void output(QDataStream& out, const QList<QByteArray>& exclusions, bool stripInternal) const;

};

template <typename Stream> 

Stream& operator<<(Stream &stream, const QMailMessageHeader& header) { header.serialize(stream); return stream; }

template <typename Stream> 

Stream& operator>>(Stream &stream, QMailMessageHeader& header) { header.deserialize(stream); return stream; }

class QMailMessageBodyPrivate;

class LongString;

class QTOPIAMAIL_EXPORT QMailMessageBody : public QPrivatelyImplemented<QMailMessageBodyPrivate>, public QMailMessageBodyFwd

{

public:

    typedef QMailMessageBodyPrivate ImplementationType;

    // Construction functions

    static QMailMessageBody fromFile(const QString& filename, const QMailMessageContentType& type, TransferEncoding encoding, EncodingStatus status);

    static QMailMessageBody fromStream(QDataStream& in, const QMailMessageContentType& type, TransferEncoding encoding, EncodingStatus status);

    static QMailMessageBody fromData(const QByteArray& input, const QMailMessageContentType& type, TransferEncoding encoding, EncodingStatus status);

    static QMailMessageBody fromStream(QTextStream& in, const QMailMessageContentType& type, TransferEncoding encoding);

    static QMailMessageBody fromData(const QString& input, const QMailMessageContentType& type, TransferEncoding encoding);

    // Output functions

    bool toFile(const QString& filename, EncodingFormat format) const;

    QByteArray data(EncodingFormat format) const;

    bool toStream(QDataStream& out, EncodingFormat format) const;

    QString data() const;

    bool toStream(QTextStream& out) const;

    // Property accessors

    TransferEncoding transferEncoding() const;

    QMailMessageContentType contentType() const;

    bool isEmpty() const;

    int length() const;

    template <typename Stream> void serialize(Stream &stream) const;

    template <typename Stream> void deserialize(Stream &stream);

private:

    friend class QMailMessagePartContainerPrivate;

    QMailMessageBody();

    uint indicativeSize() const;

    void output(QDataStream& out, bool includeAttachments) const;

    static QMailMessageBody fromLongString(LongString& ls, const QMailMessageContentType& type, TransferEncoding encoding, EncodingStatus status);

};

template <typename Stream> 

Stream& operator<<(Stream &stream, const QMailMessageBody& body) { body.serialize(stream); return stream; }

template <typename Stream> 

Stream& operator>>(Stream &stream, QMailMessageBody& body) { body.deserialize(stream); return stream; }

class QTOPIAMAIL_EXPORT QMailMessagePartContainer : public QPrivatelyImplemented<QMailMessagePartContainerPrivate>, public QMailMessagePartContainerFwd

{

public:

    typedef QMailMessagePartContainerPrivate ImplementationType;

    // Parts management interface:

    MultipartType multipartType() const;

    void setMultipartType(MultipartType type);

    uint partCount() const;

    void appendPart(const QMailMessagePart &part);

    void prependPart(const QMailMessagePart &part);

    void removePartAt(uint pos);

    const QMailMessagePart& partAt(uint pos) const;

    QMailMessagePart& partAt(uint pos);

    void clearParts();

    QByteArray boundary() const;

    void setBoundary(const QByteArray& text);

    // Body management interface:

    void setBody(const QMailMessageBody& body);

    QMailMessageBody body() const;

    bool hasBody() const;

    // Property accessors

    QMailMessageBody::TransferEncoding transferEncoding() const;

    QMailMessageContentType contentType() const;

    // Header fields describing this part container

    QString headerFieldText( const QString &id ) const;

    QMailMessageHeaderField headerField( const QString &id, QMailMessageHeaderField::FieldType fieldType = QMailMessageHeaderField::StructuredField ) const;

    QStringList headerFieldsText( const QString &id ) const;

    QList<QMailMessageHeaderField> headerFields( const QString &id, QMailMessageHeaderField::FieldType fieldType = QMailMessageHeaderField::StructuredField ) const;

    QList<QMailMessageHeaderField> headerFields() const;

    virtual void setHeaderField( const QString &id, const QString& content );

    virtual void setHeaderField( const QMailMessageHeaderField &field );

    virtual void appendHeaderField( const QString &id, const QString& content );

    virtual void appendHeaderField( const QMailMessageHeaderField &field );

    virtual void removeHeaderField( const QString &id );

    virtual bool contentAvailable() const = 0;

    virtual bool partialContentAvailable() const = 0;

    template <typename F>

    bool foreachPart(F func);

    template <typename F>

    bool foreachPart(F func) const;

    static MultipartType multipartTypeForName(const QByteArray &name);

    static QByteArray nameForMultipartType(MultipartType type);

protected:

    template<typename Subclass>

    QMailMessagePartContainer(Subclass* p);

    virtual void setHeader(const QMailMessageHeader& header, const QMailMessagePartContainerPrivate* parent = 0);

private:

    friend class QMailMessagePartContainerPrivate;

    uint indicativeSize() const;

    void outputParts(QDataStream& out, bool includePreamble, bool includeAttachments, bool stripInternal) const;

    void outputBody(QDataStream& out, bool includeAttachments) const;

};

class QMailMessagePartPrivate;

class QTOPIAMAIL_EXPORT QMailMessagePart : public QMailMessagePartContainer, public QMailMessagePartFwd

{

public:

    typedef QMailMessagePartPrivate ImplementationType;

    class LocationPrivate;

    class QTOPIAMAIL_EXPORT Location

    {

    public:

        Location();

        Location(const QString& description);

        Location(const Location& other);

        ~Location();

        const QMailMessagePart::Location &operator=(const QMailMessagePart::Location &other);

        bool isValid(bool extended = true) const;

        QMailMessageId containingMessageId() const;

        void setContainingMessageId(const QMailMessageId &id);

        QString toString(bool extended) const;

        template <typename Stream> void serialize(Stream &stream) const;

        template <typename Stream> void deserialize(Stream &stream);

    private:

        friend class QMailMessagePartContainerPrivate;

        friend class QMailMessagePart;

        Location(const QMailMessagePart& part);

        LocationPrivate *d;

    };

    QMailMessagePart();

    // Construction functions

    static QMailMessagePart fromFile(const QString& filename, const QMailMessageContentDisposition& disposition, 

                                     const QMailMessageContentType& type, QMailMessageBody::TransferEncoding encoding, 

                                     QMailMessageBody::EncodingStatus status = QMailMessageBody::RequiresEncoding);

    static QMailMessagePart fromStream(QDataStream& in, const QMailMessageContentDisposition& disposition, 

                                       const QMailMessageContentType& type, QMailMessageBody::TransferEncoding encoding, 

                                       QMailMessageBody::EncodingStatus status = QMailMessageBody::RequiresEncoding);

    static QMailMessagePart fromData(const QByteArray& input, const QMailMessageContentDisposition& disposition, 

                                     const QMailMessageContentType& type, QMailMessageBody::TransferEncoding encoding, 

                                     QMailMessageBody::EncodingStatus status = QMailMessageBody::RequiresEncoding);

    static QMailMessagePart fromStream(QTextStream& in, const QMailMessageContentDisposition& disposition, 

                                       const QMailMessageContentType& type, QMailMessageBody::TransferEncoding encoding);

    static QMailMessagePart fromData(const QString& input, const QMailMessageContentDisposition& disposition, 

                                     const QMailMessageContentType& type, QMailMessageBody::TransferEncoding encoding);

    static QMailMessagePart fromMessageReference(const QMailMessageId &id, const QMailMessageContentDisposition& disposition, 

                                                 const QMailMessageContentType& type, QMailMessageBody::TransferEncoding encoding);

    static QMailMessagePart fromPartReference(const QMailMessagePart::Location &partLocation, const QMailMessageContentDisposition& disposition, 

                                              const QMailMessageContentType& type, QMailMessageBody::TransferEncoding encoding);

    void setReference(const QMailMessageId &id, const QMailMessageContentType& type, QMailMessageBody::TransferEncoding encoding);

    void setReference(const QMailMessagePart::Location &location, const QMailMessageContentType& type, QMailMessageBody::TransferEncoding encoding);

    QString contentID() const;

    void setContentID(const QString &s);

    QString contentLocation() const;

    void setContentLocation(const QString &s);

    QString contentDescription() const;

    void setContentDescription(const QString &s);

    QMailMessageContentDisposition contentDisposition() const;

    void setContentDisposition(const QMailMessageContentDisposition& disposition);

    QString contentLanguage() const;

    void setContentLanguage(const QString &s);

    int partNumber() const;

    Location location() const;

    QString displayName() const;

    QString identifier() const;

    ReferenceType referenceType() const;

    QMailMessageId messageReference() const;

    QMailMessagePart::Location partReference() const;

    QString referenceResolution() const;

    void setReferenceResolution(const QString &uri);

    virtual uint indicativeSize() const;

    virtual bool contentAvailable() const;

    virtual bool partialContentAvailable() const;

    QString writeBodyTo(const QString &path) const;

    virtual bool contentModified() const;

    template <typename Stream> void serialize(Stream &stream) const;

    template <typename Stream> void deserialize(Stream &stream);

private:

    friend class QMailMessagePrivate;

    friend class QMailMessagePartContainerPrivate;

    virtual void setUnmodified();

    void output(QDataStream& out, bool includeAttachments, bool stripInternal) const;

};

template <typename Stream> 

Stream& operator<<(Stream &stream, const QMailMessagePart& part) { part.serialize(stream); return stream; }

template <typename Stream> 

Stream& operator>>(Stream &stream, QMailMessagePart& part) { part.deserialize(stream); return stream; }

template <typename F>

bool QMailMessagePartContainer::foreachPart(F func)

{

    for (uint i = 0; i < partCount(); ++i) {

        QMailMessagePart &part(partAt(i));

        if (!func(part)) {

            return false;

        } else if (part.multipartType() != QMailMessagePartContainer::MultipartNone) {

            if (!part.foreachPart(func)) {

                return false;

            }

        }

    }

    return true;

}

template <typename F>

bool QMailMessagePartContainer::foreachPart(F func) const

{

    for (uint i = 0; i < partCount(); ++i) {

        const QMailMessagePart &part(partAt(i));

        if (!func(part)) {

            return false;

        } else if (part.multipartType() != QMailMessagePartContainer::MultipartNone) {

            if (!part.foreachPart(func)) {

                return false;

            }

        }

    }

    return true;

}

class QMailMessageMetaDataPrivate;

class QTOPIAMAIL_EXPORT QMailMessageMetaData : public QPrivatelyImplemented<QMailMessageMetaDataPrivate>, public QMailMessageMetaDataFwd

{

public:

    typedef QMailMessageMetaDataPrivate ImplementationType;

    static const quint64 &Incoming;

    static const quint64 &Outgoing;

    static const quint64 &Sent;

    static const quint64 &Replied;