messagepart.h 11.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
/*
   Copyright (c) 2015 Sandro Knauß <sknauss@kde.org>

   This library is free software; you can redistribute it and/or modify it
   under the terms of the GNU Library General Public License as published by
   the Free Software Foundation; either version 2 of the License, or (at your
   option) any later version.

   This library 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 Library General Public
   License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to the
   Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
   02110-1301, USA.
*/

20 21
#ifndef __MIMETREEPARSER_MESSAGEPART_H__
#define __MIMETREEPARSER_MESSAGEPART_H__
22 23 24

#include "partmetadata.h"
#include "nodehelper.h"
Sandro Knauß's avatar
Sandro Knauß committed
25
#include "mimetreeparser/bodypartformatter.h"
26 27 28 29 30 31 32 33 34 35 36
#include <KMime/Message>

#include <Libkleo/CryptoBackend>
#include <gpgme++/verificationresult.h>
#include <importresult.h>

#include <QString>
#include <QSharedPointer>

class QTextCodec;

Sandro Knauß's avatar
Sandro Knauß committed
37 38
namespace GpgME
{
Laurent Montel's avatar
Laurent Montel committed
39
class ImportResult;
Sandro Knauß's avatar
Sandro Knauß committed
40 41
}

42 43 44 45 46 47 48 49
namespace KMime
{
class Content;
}

namespace MessageViewer
{
class ObjectTreeParser;
50
class ObjectTreeSourceIf;
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
class HtmlWriter;
class NodeHelper;

class HTMLBlock
{
public:
    typedef QSharedPointer<HTMLBlock> Ptr;

    HTMLBlock()
        : entered(false)
    { }

    virtual ~HTMLBlock() { }

protected:
66
    QString dir() const;
67 68 69
    bool entered;
};

70 71 72
class EncapsulatedRFC822Block : public HTMLBlock
{
public:
Laurent Montel's avatar
Laurent Montel committed
73
    EncapsulatedRFC822Block(MessageViewer::HtmlWriter *writer, MessageViewer::NodeHelper *nodeHelper, KMime::Content *node);
74 75 76 77 78 79
    virtual ~EncapsulatedRFC822Block();

private:
    void internalEnter();
    void internalExit();

Laurent Montel's avatar
Laurent Montel committed
80
    HtmlWriter *mWriter;
81
    NodeHelper *mNodeHelper;
Laurent Montel's avatar
Laurent Montel committed
82
    KMime::Content *mNode;
83 84 85 86 87 88 89 90 91 92 93 94
};

class EncryptedBlock : public HTMLBlock
{
public:
    EncryptedBlock(MessageViewer::HtmlWriter *writer, const PartMetaData &block);
    virtual ~EncryptedBlock();

private:
    void internalEnter();
    void internalExit();

Laurent Montel's avatar
Laurent Montel committed
95
    HtmlWriter *mWriter;
96 97 98
    const PartMetaData &mBlock;
};

99
class SignedBlock : public HTMLBlock
100 101
{
public:
102
    SignedBlock(MessageViewer::HtmlWriter *writer, const PartMetaData &block,
103
                const Kleo::CryptoBackend::Protocol *cryptoProto,
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
                ObjectTreeSourceIf *source,
                QString fromAddress, bool printing);
    virtual ~SignedBlock();

private:
    QString simpleHeader();
    void internalEnter();
    void internalExit();

    const PartMetaData &mBlock;
    HtmlWriter *mWriter;
    const Kleo::CryptoBackend::Protocol *mCryptoProto;
    ObjectTreeSourceIf *mSource;
    QString mClass;
    QString mFromAddress;
    bool mPrinting;
};

class CryptoBlock: public HTMLBlock
{
public:
Laurent Montel's avatar
Laurent Montel committed
125
    CryptoBlock(MessageViewer::ObjectTreeParser *otp, MessageViewer::PartMetaData *block, const Kleo::CryptoBackend::Protocol *cryptoProto, MessageViewer::ObjectTreeSourceIf *source, const QString &fromAddress, KMime::Content *node);
126 127 128 129 130 131 132 133 134
    virtual ~CryptoBlock();

private:
    void internalEnter();
    void internalExit();

    ObjectTreeParser *mOtp;
    PartMetaData *mMetaData;
    const Kleo::CryptoBackend::Protocol *mCryptoProto;
Laurent Montel's avatar
Laurent Montel committed
135
    ObjectTreeSourceIf *mSource;
136 137
    QString mFromAddress;
    KMime::Content *mNode;
138
    QVector<HTMLBlock::Ptr> mInteralBlocks;
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
};

// 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().
class AttachmentMarkBlock : public HTMLBlock
{
public:
    AttachmentMarkBlock(MessageViewer::HtmlWriter *writer, KMime::Content *node);
    virtual ~AttachmentMarkBlock();

private:
    void internalEnter();
    void internalExit();

    KMime::Content *mNode;
    HtmlWriter *mWriter;
};

class TextBlock : public HTMLBlock
{
public:
    TextBlock(MessageViewer::HtmlWriter *writer, MessageViewer::NodeHelper *nodeHelper, KMime::Content *node, bool link);
    virtual ~TextBlock();
private:
    void internalEnter();
    void internalExit();
private:
    HtmlWriter *mWriter;
    NodeHelper *mNodeHelper;
    KMime::Content *mNode;
    QString mFileName;
    bool mLink;
};

174 175 176
class HTMLWarnBlock : public HTMLBlock
{
public:
Laurent Montel's avatar
Laurent Montel committed
177
    HTMLWarnBlock(MessageViewer::HtmlWriter *writer, const QString &msg);
178 179 180 181 182
    virtual ~HTMLWarnBlock();
private:
    void internalEnter();
    void internalExit();
private:
Laurent Montel's avatar
Laurent Montel committed
183
    HtmlWriter *mWriter;
184 185 186
    const QString &mMsg;
};

187 188 189 190 191 192 193 194 195 196 197 198 199
// Make sure the whole content is relative, so that nothing is painted over the header
// if a malicious message uses absolute positioning.
// Also force word wrapping, which is useful for printing, see https://issues.kolab.org/issue3992.
class RootBlock : public HTMLBlock
{
public:
    RootBlock(MessageViewer::HtmlWriter *writer);
    virtual ~RootBlock();

private:
    void internalEnter();
    void internalExit();

Laurent Montel's avatar
Laurent Montel committed
200
    HtmlWriter *mWriter;
201 202
};

203
class MessagePart : public Interface::MessagePart
204 205 206 207 208 209 210 211
{
public:
    typedef QSharedPointer<MessagePart> Ptr;
    MessagePart(ObjectTreeParser *otp,
                const QString &text);

    virtual ~MessagePart();

212
    virtual QString text() const Q_DECL_OVERRIDE;
213
    void setText(const QString &text);
214
    virtual void html(bool decorate) Q_DECL_OVERRIDE;
215 216
    void setAttachmentFlag(KMime::Content *node);
    bool isAttachment() const;
217 218 219

    PartMetaData *partMetaData();

220 221 222 223
    /* only a function that should be removed if the refactoring is over */
    virtual void fix() const;
    virtual void copyContentFrom() const;

224 225
protected:
    void parseInternal(KMime::Content *node, bool onlyOneMimePart);
Laurent Montel's avatar
Laurent Montel committed
226
    void renderInternalHtml(bool decorate) const;
227
    QString renderInternalText() const;
228 229
    HTMLBlock::Ptr attachmentBlock() const;

230 231 232
    QString mText;
    ObjectTreeParser *mOtp;
    ObjectTreeParser *mSubOtp;
233
    MessagePart::Ptr mSubMessagePart;
234
    PartMetaData mMetaData;
235
    KMime::Content *mAttachmentNode;
236 237
};

238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
class MimeMessagePart : public MessagePart
{
public:
    typedef QSharedPointer<MimeMessagePart> Ptr;
    MimeMessagePart(MessageViewer::ObjectTreeParser *otp, KMime::Content *node, bool onlyOneMimePart);
    virtual ~MimeMessagePart();

    QString text() const Q_DECL_OVERRIDE;
    void html(bool decorate) Q_DECL_OVERRIDE;

private:
    KMime::Content *mNode;
    bool mOnlyOneMimePart;

    friend class AlternativeMessagePart;
};

255 256 257 258
class MessagePartList : public MessagePart
{
public:
    typedef QSharedPointer<MessagePartList> Ptr;
Laurent Montel's avatar
Laurent Montel committed
259
    MessagePartList(MessageViewer::ObjectTreeParser *otp);
260 261 262 263 264
    virtual ~MessagePartList();

    QString text() const Q_DECL_OVERRIDE;
    void html(bool decorate) Q_DECL_OVERRIDE;

265 266
    void setIsRoot(bool root);
    bool isRoot() const;
267

268 269 270 271 272 273
    void appendMessagePart(const Interface::MessagePart::Ptr &messagePart);

    const QVector<Interface::MessagePart::Ptr> &messageParts() const;

    void fix() const Q_DECL_OVERRIDE;
    void copyContentFrom() const Q_DECL_OVERRIDE;
274

275
protected:
276 277
    HTMLBlock::Ptr rootBlock() const;
    void htmlInternal(bool decorate);
278

279
private:
280 281
    QVector<Interface::MessagePart::Ptr> mBlocks;
    bool mRoot;
282 283
};

284 285 286 287 288 289
enum IconType {
    NoIcon = 0,
    IconExternal,
    IconInline
};

290
class TextMessagePart : public MessagePartList
291 292 293
{
public:
    typedef QSharedPointer<TextMessagePart> Ptr;
294
    TextMessagePart(MessageViewer::ObjectTreeParser *otp, KMime::Content *node, bool drawFrame, bool showLink, bool decryptMessage, IconType asIcon);
295 296 297 298 299 300 301
    virtual ~TextMessagePart();

    void html(bool decorate) Q_DECL_OVERRIDE;

    KMMsgSignatureState signatureState() const;
    KMMsgEncryptionState encryptionState() const;

302
    bool decryptMessage() const;
303

304
private:
305
    void parseContent();
306 307 308 309 310
    KMime::Content *mNode;
    KMMsgSignatureState mSignatureState;
    KMMsgEncryptionState mEncryptionState;
    bool mDrawFrame;
    bool mShowLink;
311
    bool mDecryptMessage;
312
    IconType mAsIcon;
313 314
};

315 316 317 318
class HtmlMessagePart : public MessagePart
{
public:
    typedef QSharedPointer<HtmlMessagePart> Ptr;
Laurent Montel's avatar
Laurent Montel committed
319
    HtmlMessagePart(MessageViewer::ObjectTreeParser *otp, KMime::Content *node, MessageViewer::ObjectTreeSourceIf *source);
320 321 322 323 324
    virtual ~HtmlMessagePart();

    QString text() const Q_DECL_OVERRIDE;
    void html(bool decorate) Q_DECL_OVERRIDE;

325
    void fix() const Q_DECL_OVERRIDE;
326 327

private:
328
    QString processHtml(const QString &htmlSource, QString &extraHead);
Laurent Montel's avatar
Laurent Montel committed
329
    KMime::Content *mNode;
330 331 332 333 334
    ObjectTreeSourceIf *mSource;
    QString mBodyHTML;
    QByteArray mCharset;
};

335
class AlternativeMessagePart : public MessagePart
336 337
{
public:
338
    typedef QSharedPointer<AlternativeMessagePart> Ptr;
Laurent Montel's avatar
Laurent Montel committed
339
    AlternativeMessagePart(MessageViewer::ObjectTreeParser *otp, KMime::Content *textNode, KMime::Content *htmlNode);
340
    virtual ~AlternativeMessagePart();
341 342 343 344

    QString text() const Q_DECL_OVERRIDE;
    void html(bool decorate) Q_DECL_OVERRIDE;

345
    void setViewHtml(bool html);
346 347 348
    bool viewHtml() const;
    void fix() const Q_DECL_OVERRIDE;
    void copyContentFrom() const Q_DECL_OVERRIDE;
349
private:
Laurent Montel's avatar
Laurent Montel committed
350 351
    KMime::Content *mTextNode;
    KMime::Content *mHTMLNode;
352 353 354 355

    MimeMessagePart::Ptr mTextPart;
    MimeMessagePart::Ptr mHTMLPart;
    bool mViewHtml;
356 357
};

Sandro Knauß's avatar
Sandro Knauß committed
358 359 360 361
class CertMessagePart : public MessagePart
{
public:
    typedef QSharedPointer<CertMessagePart> Ptr;
Laurent Montel's avatar
Laurent Montel committed
362
    CertMessagePart(MessageViewer::ObjectTreeParser *otp, KMime::Content *node, const Kleo::CryptoBackend::Protocol *cryptoProto, bool autoImport);
Sandro Knauß's avatar
Sandro Knauß committed
363 364 365 366 367 368
    virtual ~CertMessagePart();

    QString text() const Q_DECL_OVERRIDE;
    void html(bool decorate) Q_DECL_OVERRIDE;

private:
Laurent Montel's avatar
Laurent Montel committed
369
    KMime::Content *mNode;
Sandro Knauß's avatar
Sandro Knauß committed
370 371 372 373 374
    bool mAutoImport;
    GpgME::ImportResult mImportResult;
    const Kleo::CryptoBackend::Protocol *mCryptoProto;
};

375 376 377 378 379 380 381 382 383 384
class EncapsulatedRfc822MessagePart : public MessagePart
{
public:
    typedef QSharedPointer<EncapsulatedRfc822MessagePart> Ptr;
    EncapsulatedRfc822MessagePart(MessageViewer::ObjectTreeParser *otp, KMime::Content *node, const KMime::Message::Ptr &message);
    virtual ~EncapsulatedRfc822MessagePart();

    QString text() const Q_DECL_OVERRIDE;
    void html(bool decorate) Q_DECL_OVERRIDE;

385 386
    void copyContentFrom() const Q_DECL_OVERRIDE;
    void fix() const Q_DECL_OVERRIDE;
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403
private:
    const KMime::Message::Ptr mMessage;
    KMime::Content *mNode;
};

class CryptoMessagePart : public MessagePart
{
public:
    typedef QSharedPointer<CryptoMessagePart> Ptr;
    CryptoMessagePart(ObjectTreeParser *otp,
                      const QString &text,
                      const Kleo::CryptoBackend::Protocol *cryptoProto,
                      const QString &fromAddress,
                      KMime::Content *node);

    virtual ~CryptoMessagePart();

Sandro Knauß's avatar
Sandro Knauß committed
404 405 406 407 408 409
    void setDecryptMessage(bool decrypt);
    bool decryptMessage() const;

    void setIsEncrypted(bool encrypted);
    bool isEncrypted() const;

410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433
    void startDecryption(const QByteArray &text, const QTextCodec *aCodec);
    void startDecryption(KMime::Content *data = 0);
    void startVerification(const QByteArray &text, const QTextCodec *aCodec);
    void startVerificationDetached(const QByteArray &text, KMime::Content *textNode, const QByteArray &signature);
    void html(bool decorate) Q_DECL_OVERRIDE;

    bool mPassphraseError;
    QByteArray mDecryptedData;
    std::vector<GpgME::Signature> mSignatures;

private:
    /** Writes out the block that we use when the node is encrypted,
      but we're deferring decryption for later. */
    void writeDeferredDecryptionBlock() const;

protected:
    const Kleo::CryptoBackend::Protocol *mCryptoProto;
    QString mFromAddress;
    KMime::Content *mNode;
    bool mDecryptMessage;
    QByteArray mVerifiedText;
};

}
434
#endif //__MIMETREEPARSER_MESSAGEPART_H__