objecttreeparser.h

/*
    objecttreeparser.h
 
    This file is part of KMail, the KDE mail client.
    Copyright (c) 2002-2003 Klarälvdalens Datakonsult AB
    Copyright (c) 2003      Marc Mutz <mutz@kde.org>
 
    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 TQt library by Trolltech AS, Norway (or with modified versions
    of TQt that use the same license as TQt), 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
    TQt.  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 _KMAIL_OBJECTTREEPARSER_H_
#define _KMAIL_OBJECTTREEPARSER_H_
 
#include "kmmsgbase.h"
 
#include <tqcstring.h>
 
#include <kleo/cryptobackend.h>
#include <gpgmepp/verificationresult.h>
#include <gpgmepp/key.h>
 
#include <cassert>
 
class KMReaderWin;
class KMMessagePart;
class TQString;
class TQWidget;
class partNode;
 
namespace GpgME {
  class Error;
}
 
namespace KMail {
 
  class AttachmentStrategy;
  class HtmlWriter;
  class PartMetaData;
  class CSSHelper;
 
  class ProcessResult {
  public:
    ProcessResult( KMMsgSignatureState  inlineSignatureState  = KMMsgNotSigned,
                   KMMsgEncryptionState inlineEncryptionState = KMMsgNotEncrypted,
                   bool neverDisplayInline = false,
                   bool isImage = false )
      : mInlineSignatureState( inlineSignatureState ),
        mInlineEncryptionState( inlineEncryptionState ),
        mNeverDisplayInline( neverDisplayInline ),
        mIsImage( isImage ) {}
 
    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( partNode * node ) const;
 
  private:
    KMMsgSignatureState mInlineSignatureState;
    KMMsgEncryptionState mInlineEncryptionState;
    bool mNeverDisplayInline : 1;
    bool mIsImage : 1;
  };
 
  class ObjectTreeParser {
    class CryptoProtocolSaver;
    ObjectTreeParser( const ObjectTreeParser & other );
  public:
    ObjectTreeParser( KMReaderWin * reader=0, const Kleo::CryptoBackend::Protocol * protocol=0,
                      bool showOneMimePart=false, bool keepEncryptions=false,
                      bool includeSignatures=true,
                      const KMail::AttachmentStrategy * attachmentStrategy=0,
                      KMail::HtmlWriter * htmlWriter=0,
                      KMail::CSSHelper * cssHelper=0 );
    virtual ~ObjectTreeParser();
 
    void setAllowAsync( bool allow ) { assert( !mHasPendingAsyncJobs ); mAllowAsync = allow; }
    bool allowAsync() const { return mAllowAsync; }
 
    bool hasPendingAsyncJobs() const { return mHasPendingAsyncJobs; }
 
    TQCString rawReplyString() const { return mRawReplyString; }
 
    TQString textualContent() const { return mTextualContent; }
 
    TQCString textualContentCharset() const { return mTextualContentCharset; }
 
    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 TQString defaultToltecReplacementText();
 
    const KMail::AttachmentStrategy * attachmentStrategy() const {
      return mAttachmentStrategy;
    }
 
    KMail::HtmlWriter * htmlWriter() const { return mHtmlWriter; }
 
    KMail::CSSHelper * cssHelper() const { return mCSSHelper; }
 
    //  Function is called internally by "parseMsg(KMMessage* msg)"
    //  and it will be replaced once KMime is alive.
    void parseObjectTree( partNode * node );
 
  private:
    void stdChildHandling( partNode * child );
 
    void defaultHandling( partNode * node, ProcessResult & result );
 
    //  Function will be replaced once KMime is alive.
    void insertAndParseNewChildNode( partNode & node,
                                     const char * content,
                                     const char * cntDesc,
                                     bool append=false,
                                     bool addToTextualContent = true );
    bool writeOpaqueOrMultipartSignedData( partNode * data,
                                           partNode & sign,
                                           const TQString & fromAddress,
                                           bool doCheck=true,
                                           bool hideErrors=false,
                                           TQCString * cleartextData=0,
                                           const std::vector<GpgME::Signature> & paramSignatures = std::vector<GpgME::Signature>(),
                                           const GpgME::Key & paramKey = GpgME::Key() );
 
    void writeDeferredDecryptionBlock();
 
    void writeDecryptionInProgressBlock();
 
    bool okDecryptMIME( partNode& data,
                        TQCString& decryptedData,
                        bool& signatureFound,
                        std::vector<GpgME::Signature> &signatures,
                        GpgME::Key &key,
                        bool showWarning,
                        bool& passphraseError,
                        bool& actuallyEncrypted,
                        bool& decryptionStarted,
                        TQString& aErrorText,
                        GpgME::Error & auditLogError,
                        TQString& auditLog );
 
    bool processMailmanMessage( partNode * node );
 
    bool processToltecMail( partNode * node );
 
    static bool containsExternalReferences( const TQCString & str );
 
  public:// (during refactoring)
 
    bool processTextHtmlSubtype( partNode * node, ProcessResult & result );
    bool processTextPlainSubtype( partNode * node, ProcessResult & result );
 
    bool processMultiPartMixedSubtype( partNode * node, ProcessResult & result );
    bool processMultiPartAlternativeSubtype( partNode * node, ProcessResult & result );
    bool processMultiPartDigestSubtype( partNode * node, ProcessResult & result );
    bool processMultiPartParallelSubtype( partNode * node, ProcessResult & result );
    bool processMultiPartSignedSubtype( partNode * node, ProcessResult & result );
    bool processMultiPartEncryptedSubtype( partNode * node, ProcessResult & result );
 
    bool processMessageRfc822Subtype( partNode * node, ProcessResult & result );
 
    bool processApplicationOctetStreamSubtype( partNode * node, ProcessResult & result );
    bool processApplicationPkcs7MimeSubtype( partNode * node, ProcessResult & result );
    bool processApplicationChiasmusTextSubtype( partNode * node, ProcessResult & result );
    bool processApplicationMsTnefSubtype( partNode *node, ProcessResult &result );
 
  private:
    bool decryptChiasmus( const TQByteArray& data, TQByteArray& bodyDecoded, TQString& errorText );
    void writeBodyString( const TQCString & bodyString,
                          const TQString & fromAddress,
                          const TQTextCodec * codec,
                          ProcessResult & result, bool decorate );
 
    void writePartIcon( KMMessagePart * msgPart, int partNumber, bool inlineImage=false );
 
    TQString sigStatusToString( const Kleo::CryptoBackend::Protocol * cryptProto,
                               int status_code,
                               GpgME::Signature::Summary summary,
                               int & frameColor,
                               bool & showKeyInfos );
    TQString writeSigstatHeader( KMail::PartMetaData & part,
                                const Kleo::CryptoBackend::Protocol * cryptProto,
                                const TQString & fromAddress,
                                partNode *node = 0 );
    TQString writeSigstatFooter( KMail::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( partNode *node );
    void writeAttachmentMarkFooter();
 
    void writeBodyStr( const TQCString & bodyString,
                       const TQTextCodec * aCodec,
                       const TQString & fromAddress,
                       KMMsgSignatureState &  inlineSignatureState,
                       KMMsgEncryptionState & inlineEncryptionState,
                       bool decorate );
  public: // KMReaderWin still needs this...
    void writeBodyStr( const TQCString & bodyString,
                       const TQTextCodec * aCodec,
                       const TQString & fromAddress );
 
  private:
    TQString quotedHTML(const TQString& pos, bool decorate);
 
    const TQTextCodec * codecFor( partNode * node ) 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
 
  private:
    KMReaderWin * mReader;
    TQCString mRawReplyString;
    TQCString mTextualContentCharset;
    TQString mTextualContent;
    const Kleo::CryptoBackend::Protocol * mCryptoProtocol;
    bool mShowOnlyOneMimePart;
    bool mKeepEncryptions;
    bool mIncludeSignatures;
    bool mHasPendingAsyncJobs;
    bool mAllowAsync;
    bool mShowRawToltecMail;
    const KMail::AttachmentStrategy * mAttachmentStrategy;
    KMail::HtmlWriter * mHtmlWriter;
    KMail::CSSHelper * mCSSHelper;
    // DataUrl Icons cache
    TQString mCollapseIcon;
    TQString mExpandIcon;
  };
 
} // namespace KMail
 
#endif // _KMAIL_OBJECTTREEPARSER_H_