objecttreeparser.h

Go to the documentation of this file.

/*  -*- mode: C++; c-file-style: "gnu" -*-
    objecttreeparser.h

    This file is part of KMail, the KDE mail client.
    Copyright (c) 2003      Marc Mutz <mutz@kde.org>
    Copyright (C) 2002-2003, 2009 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.net
    Copyright (c) 2009 Andras Mantia <andras@kdab.net>

    KMail is free software; you can redistribute it and/or modify it
    under the terms of the GNU General Public License, version 2, as
    published by the Free Software Foundation.

    KMail is distributed in the hope that it will be useful, but
    WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA

    In addition, as a special exception, the copyright holders give
    permission to link the code of this program with any edition of
    the Qt library by Trolltech AS, Norway (or with modified versions
    of Qt that use the same license as Qt), and distribute linked
    combinations including the two.  You must obey the GNU General
    Public License in all respects for all of the code used other than
    Qt.  If you modify this file, you may extend this exception to
    your version of the file, but you are not obligated to do so.  If
    you do not wish to do so, delete this exception statement from
    your version.
*/

#ifndef _MESSAGEVIEWER_OBJECTTREEPARSER_H_
#define _MESSAGEVIEWER_OBJECTTREEPARSER_H_

#include "messageviewer_export.h"

#include "viewer/nodehelper.h"
#include "objecttreesourceif.h"

#include <libkleo/kleo/cryptobackend.h>
#include <gpgme++/verificationresult.h>

#include <QList>
#include "objecttreeemptysource.h"

class QString;

namespace KMime {
  class Content;
}

namespace GpgME {
  class Error;
  class ImportResult;
}


namespace MessageViewer {

class PartMetaData;
class ViewerPrivate;
class HtmlWriter;
class CSSHelper;
class AttachmentStrategy;
class NodeHelper;

class ProcessResult {
public:
  explicit ProcessResult( NodeHelper *nodeHelper, KMMsgSignatureState  inlineSignatureState  = KMMsgNotSigned,
                  KMMsgEncryptionState inlineEncryptionState = KMMsgNotEncrypted,
            bool neverDisplayInline = false,
            bool isImage = false )
    : mInlineSignatureState( inlineSignatureState ),
      mInlineEncryptionState( inlineEncryptionState ),
      mNeverDisplayInline( neverDisplayInline ),
      mIsImage( isImage ),
      mNodeHelper( nodeHelper ) {}

  KMMsgSignatureState inlineSignatureState() const {
    return mInlineSignatureState;
  }
  void setInlineSignatureState( KMMsgSignatureState state ) {
    mInlineSignatureState = state;
  }

  KMMsgEncryptionState inlineEncryptionState() const {
    return mInlineEncryptionState;
  }
  void setInlineEncryptionState( KMMsgEncryptionState state ) {
    mInlineEncryptionState = state;
  }

  bool neverDisplayInline() const { return mNeverDisplayInline; }
  void setNeverDisplayInline( bool display ) {
    mNeverDisplayInline = display;
  }

  bool isImage() const { return mIsImage; }
  void setIsImage( bool image ) {
    mIsImage = image;
  }

  void adjustCryptoStatesOfNode( KMime::Content * node ) const;

private:
  KMMsgSignatureState mInlineSignatureState;
  KMMsgEncryptionState mInlineEncryptionState;
  bool mNeverDisplayInline : 1;
  bool mIsImage : 1;
  NodeHelper* mNodeHelper;
};

class MESSAGEVIEWER_EXPORT ObjectTreeParser {
  class CryptoProtocolSaver;
  ObjectTreeParser( const ObjectTreeParser & other );

public:
  explicit ObjectTreeParser( ObjectTreeSourceIf * source,
                             NodeHelper *nodeHelper = 0,
                             const Kleo::CryptoBackend::Protocol * protocol=0,
                             bool showOneMimePart=false, bool keepEncryptions=false,
                             bool includeSignatures=true,
                             const AttachmentStrategy * attachmentStrategy=0 );

  explicit ObjectTreeParser( const ObjectTreeParser *topLevelParser,
                             bool showOneMimePart=false, bool keepEncryptions=false,
                             bool includeSignatures=true,
                             const AttachmentStrategy * attachmentStrategy=0 );
  virtual ~ObjectTreeParser();

  void setAllowAsync( bool allow ) { assert( !mHasPendingAsyncJobs ); mAllowAsync = allow; }
  bool allowAsync() const { return mAllowAsync; }

  bool hasPendingAsyncJobs() const { return mHasPendingAsyncJobs; }

  KDE_DEPRECATED QByteArray rawDecryptedBody() const { return mRawDecryptedBody; }

  QString plainTextContent() const { return mPlainTextContent; }

  QString htmlContent() const { return mHtmlContent; }

  QString convertedTextContent() const;

  QString convertedHtmlContent() const;

  QByteArray plainTextContentCharset() const { return mPlainTextContentCharset; }
  QByteArray htmlContentCharset() const { return mHtmlContentCharset; }

  void setCryptoProtocol( const Kleo::CryptoBackend::Protocol * protocol ) {
    mCryptoProtocol = protocol;
  }
  const Kleo::CryptoBackend::Protocol* cryptoProtocol() const {
    return mCryptoProtocol;
  }

  bool showOnlyOneMimePart() const { return mShowOnlyOneMimePart; }
  void setShowOnlyOneMimePart( bool show ) {
    mShowOnlyOneMimePart = show;
  }

  bool keepEncryptions() const { return mKeepEncryptions; }
  void setKeepEncryptions( bool keep ) {
    mKeepEncryptions = keep;
  }

  bool includeSignatures() const { return mIncludeSignatures; }
  void setIncludeSignatures( bool include ) {
    mIncludeSignatures = include;
  }

  // Controls whether Toltec invitations are displayed in their raw form or as a replacement text,
  // which is used in processToltecMail().
  void setShowRawToltecMail( bool showRawToltecMail ) { mShowRawToltecMail = showRawToltecMail; }
  bool showRawToltecMail() const { return mShowRawToltecMail; }

  static QString defaultToltecReplacementText();

  const AttachmentStrategy * attachmentStrategy() const {
    return mAttachmentStrategy;
  }

  HtmlWriter * htmlWriter() const { return mSource->htmlWriter(); }

  CSSHelper * cssHelper() const { return mSource->cssHelper(); }

  NodeHelper * nodeHelper() const { return mNodeHelper; }

  void parseObjectTree( KMime::Content * node );

private:
  void extractNodeInfos( KMime::Content *curNode, bool isFirstTextPart );

  void parseObjectTreeInternal( KMime::Content * node );

  void stdChildHandling( KMime::Content * child );

  void defaultHandling( KMime::Content * node, ProcessResult & result );

  void createAndParseTempNode( KMime::Content* parentNode, const char * content, const char * cntDesc );

  bool writeOpaqueOrMultipartSignedData( KMime::Content * data,
                                         KMime::Content & sign,
                                         const QString & fromAddress,
                                         bool doCheck=true,
                                         QByteArray * cleartextData=0,
                                         const std::vector<GpgME::Signature> & paramSignatures = std::vector<GpgME::Signature>(),
                                         bool hideErrors=false );

  void writeDeferredDecryptionBlock();

  void writeDecryptionInProgressBlock();

  void writeCertificateImportResult( const GpgME::ImportResult & res );


  bool okDecryptMIME( KMime::Content& data,
                      QByteArray& decryptedData,
                      bool& signatureFound,
                      std::vector<GpgME::Signature> &signatures,
                      bool showWarning,
                      bool& passphraseError,
                      bool& actuallyEncrypted,
                      bool& decryptionStarted,
                      PartMetaData &partMetaData );

  bool processToltecMail( KMime::Content *node );

  bool processMailmanMessage( KMime::Content* node );

  static bool containsExternalReferences(const QString & str , const QString &extraHead);

public:// (during refactoring)

  bool processTextHtmlSubtype( KMime::Content * node, ProcessResult & result );
  bool processTextPlainSubtype( KMime::Content *node, ProcessResult & result );

  bool processMultiPartMixedSubtype( KMime::Content * node, ProcessResult & result );
  bool processMultiPartAlternativeSubtype( KMime::Content * node, ProcessResult & result );
  bool processMultiPartDigestSubtype( KMime::Content * node, ProcessResult & result );
  bool processMultiPartParallelSubtype( KMime::Content * node, ProcessResult & result );
  bool processMultiPartSignedSubtype( KMime::Content * node, ProcessResult & result );
  bool processMultiPartEncryptedSubtype( KMime::Content * node, ProcessResult & result );

  bool processMessageRfc822Subtype( KMime::Content * node, ProcessResult & result );

  bool processApplicationOctetStreamSubtype( KMime::Content * node, ProcessResult & result );
  bool processApplicationPkcs7MimeSubtype( KMime::Content * node, ProcessResult & result );
  bool processApplicationChiasmusTextSubtype( KMime::Content * node, ProcessResult & result );

  bool decryptChiasmus( const QByteArray& data, QByteArray& bodyDecoded, QString& errorText );
  void writeBodyString( const QByteArray & bodyString,
                        const QString & fromAddress,
                        const QTextCodec * codec,
                        ProcessResult & result, bool decorate );

  void writePartIcon( KMime::Content * msgPart, bool inlineImage = false );

  QString sigStatusToString( const Kleo::CryptoBackend::Protocol * cryptProto,
                              int status_code,
                              GpgME::Signature::Summary summary,
                              int & frameColor,
                              bool & showKeyInfos );
  QString writeSigstatHeader( PartMetaData & part,
                              const Kleo::CryptoBackend::Protocol * cryptProto,
                              const QString & fromAddress,
                              KMime::Content *node = 0);
  QString writeSigstatFooter( PartMetaData & part );

  // The attachment mark is a div that is placed around the attchment. It is used for drawing
  // a yellow border around the attachment when scrolling to it. When scrolling to it, the border
  // color of the div is changed, see KMReaderWin::scrollToAttachment().
  void writeAttachmentMarkHeader( KMime::Content *node );
  void writeAttachmentMarkFooter();

  void writeBodyStr( const QByteArray & bodyString,
                      const QTextCodec * aCodec,
                      const QString & fromAddress,
                      KMMsgSignatureState &  inlineSignatureState,
                      KMMsgEncryptionState & inlineEncryptionState,
                      bool decorate );

  bool isMailmanMessage( KMime::Content * curNode );

public: // KMReaderWin still needs this...
  void writeBodyStr( const QByteArray & bodyString,
                      const QTextCodec * aCodec,
                      const QString & fromAddress );
  static KMime::Content* findType( KMime::Content* content, const QByteArray& mimeType, bool deep, bool wide );

  static KMime::Content* findType( KMime::Content* content, const QByteArray& mediaType, const QByteArray& subType, bool deep, bool wide );

  static KMime::Content* findTypeNot( KMime::Content* content, const QByteArray& mediaType, const QByteArray& subType, bool deep=true, bool wide=true );


private:

  void init();

  QString quotedHTML(const QString& pos, bool decorate);

  const QTextCodec * codecFor( KMime::Content * node ) const;
  bool looksLikeParaBreak(const QString& s, unsigned int newLinePos) const;

#ifdef MARCS_DEBUG
  void dumpToFile( const char * filename, const char * dataStart, size_t dataLen );
#else
  void dumpToFile( const char *, const char *, size_t ) {}
#endif

  void copyContentFrom( const ObjectTreeParser *other );

private:
  ObjectTreeSourceIf* mSource;
  NodeHelper* mNodeHelper;
  QByteArray mRawDecryptedBody;
  QByteArray mPlainTextContentCharset;
  QByteArray mHtmlContentCharset;
  QString mPlainTextContent;
  QString mHtmlContent;
  KMime::Content *mTopLevelContent;
  const Kleo::CryptoBackend::Protocol * mCryptoProtocol;

  bool mShowOnlyOneMimePart;

  bool mKeepEncryptions;
  bool mIncludeSignatures;
  bool mHasPendingAsyncJobs;
  bool mAllowAsync;
  bool mShowRawToltecMail;
  const AttachmentStrategy * mAttachmentStrategy;
  // DataUrl Icons cache
  QString mCollapseIcon;
  QString mExpandIcon;
  bool mDeleteNodeHelper;

};

}

#endif // _KMAIL_OBJECTTREEPARSER_H_