bodypartformatter.cpp

Go to the documentation of this file.

/*  -*- c++ -*-
    bodypartformatter.cpp

    This file is part of KMail, the KDE mail client.
    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 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.
*/




#include "bodypartformatter.h"
#include "viewer/bodypartformatterfactory_p.h"
#include "interfaces/bodypartformatter.h"

#include "viewer/objecttreeparser.h"

#include <kmime/kmime_content.h>

#include <kdebug.h>
#include <kascii.h>

using namespace MessageViewer;

namespace {
class AnyTypeBodyPartFormatter
        : public BodyPartFormatter,
        public MessageViewer::Interface::BodyPartFormatter {
    static const AnyTypeBodyPartFormatter * self;
public:
    Result format( Interface::BodyPart *, HtmlWriter * ) const {
        kDebug() << "Acting as a Interface::BodyPartFormatter!";
        return AsIcon;
    }

    // unhide the overload with three arguments
    using MessageViewer::Interface::BodyPartFormatter::format;

    bool process( ObjectTreeParser *, KMime::Content *, ProcessResult & result ) const {
        result.setNeverDisplayInline( true );
        return false;
    }
    static const ::BodyPartFormatter * create() {
        if ( !self )
            self = new AnyTypeBodyPartFormatter();
        return self;
    }
};

const AnyTypeBodyPartFormatter * AnyTypeBodyPartFormatter::self = 0;


class ImageTypeBodyPartFormatter : public BodyPartFormatter {
    static const ImageTypeBodyPartFormatter * self;
public:
    bool process( ObjectTreeParser *, KMime::Content *, ProcessResult & result ) const {
        result.setIsImage( true );
        return false;
    }
    static const BodyPartFormatter * create() {
        if ( !self )
            self = new ImageTypeBodyPartFormatter();
        return self;
    }
};

const ImageTypeBodyPartFormatter * ImageTypeBodyPartFormatter::self = 0;

#define CREATE_BODY_PART_FORMATTER(subtype) \
    class subtype##BodyPartFormatter : public BodyPartFormatter { \
    static const subtype##BodyPartFormatter * self; \
    public: \
    bool process( ObjectTreeParser *, KMime::Content *, ProcessResult & ) const; \
    static const BodyPartFormatter * create() { \
    if ( !self ) \
    self = new subtype##BodyPartFormatter(); \
    return self; \
} \
}; \
    \
    const subtype##BodyPartFormatter * subtype##BodyPartFormatter::self; \
    \
    bool subtype##BodyPartFormatter::process( ObjectTreeParser * otp, KMime::Content * node, ProcessResult & result ) const { \
    return otp->process##subtype##Subtype( node, result ); \
}


CREATE_BODY_PART_FORMATTER(TextPlain)
CREATE_BODY_PART_FORMATTER(TextHtml)
//CREATE_BODY_PART_FORMATTER(TextEnriched)

CREATE_BODY_PART_FORMATTER(ApplicationOctetStream)
CREATE_BODY_PART_FORMATTER(ApplicationPkcs7Mime)
CREATE_BODY_PART_FORMATTER(ApplicationChiasmusText)
//CREATE_BODY_PART_FORMATTER(ApplicationPgp)

CREATE_BODY_PART_FORMATTER(MessageRfc822)

CREATE_BODY_PART_FORMATTER(MultiPartMixed)
CREATE_BODY_PART_FORMATTER(MultiPartAlternative)
CREATE_BODY_PART_FORMATTER(MultiPartSigned)
CREATE_BODY_PART_FORMATTER(MultiPartEncrypted)

typedef TextPlainBodyPartFormatter ApplicationPgpBodyPartFormatter;


#undef CREATE_BODY_PART_FORMATTER
} // anon namespace

// FIXME: port some more BodyPartFormatters to Interface::BodyPartFormatters
void BodyPartFormatterFactoryPrivate::messageviewer_create_builtin_bodypart_formatters( BodyPartFormatterFactoryPrivate::TypeRegistry * reg ) {
    if ( !reg ) return;
    (*reg)["application"]["octet-stream"] = new AnyTypeBodyPartFormatter();
}

typedef const BodyPartFormatter * (*BodyPartFormatterCreator)();

struct SubtypeBuiltin {
    const char * subtype;
    BodyPartFormatterCreator create;
};

static const SubtypeBuiltin applicationSubtypeBuiltins[] = {
    { "octet-stream", &ApplicationOctetStreamBodyPartFormatter::create },
    { "pkcs7-mime", &ApplicationPkcs7MimeBodyPartFormatter::create },
    { "x-pkcs7-mime", &ApplicationPkcs7MimeBodyPartFormatter::create },
    { "vnd.de.bund.bsi.chiasmus-text", &ApplicationChiasmusTextBodyPartFormatter::create },
    { "pgp", &ApplicationPgpBodyPartFormatter::create },
};

static const SubtypeBuiltin textSubtypeBuiltins[] = {
    { "html", &TextHtmlBodyPartFormatter::create },
    //{ "enriched", &TextEnrichedBodyPartFormatter::create },
    { "x-vcard", &AnyTypeBodyPartFormatter::create },
    { "vcard", &AnyTypeBodyPartFormatter::create },
    { "rtf", &AnyTypeBodyPartFormatter::create },
    { "*", &TextPlainBodyPartFormatter::create },
};

static const SubtypeBuiltin multipartSubtypeBuiltins[] = {
    { "mixed", &MultiPartMixedBodyPartFormatter::create },
    { "alternative", &MultiPartAlternativeBodyPartFormatter::create },
    //{ "digest", &MultiPartDigestFormatter::create },
    //{ "parallel", &MultiPartParallelFormatter::create },
    //{ "related", &MultiPartRelatedFormatter::create },
    { "signed", &MultiPartSignedBodyPartFormatter::create },
    { "encrypted", &MultiPartEncryptedBodyPartFormatter::create },
    //{ "report", &MultiPartReportFormatter::create },
};

static const SubtypeBuiltin messageSubtypeBuiltins[] = {
    { "rfc822", &MessageRfc822BodyPartFormatter::create },
};

static const SubtypeBuiltin imageSubtypeBuiltins[] = {
    { "*", &ImageTypeBodyPartFormatter::create },
};

static const SubtypeBuiltin anySubtypeBuiltins[] = {
    { "*", &AnyTypeBodyPartFormatter::create },
};

#ifdef DIM
#undef DIM
#endif
#define DIM(x) sizeof(x) / sizeof(*x)

static const struct {
    const char * type;
    const SubtypeBuiltin * subtypes;
    unsigned int num_subtypes;
} builtins[] = {
{ "application", applicationSubtypeBuiltins, DIM(applicationSubtypeBuiltins) },
{ "text", textSubtypeBuiltins, DIM(textSubtypeBuiltins) },
{ "multipart", multipartSubtypeBuiltins, DIM(multipartSubtypeBuiltins) },
{ "message", messageSubtypeBuiltins, DIM(messageSubtypeBuiltins) },
{ "image", imageSubtypeBuiltins, DIM(imageSubtypeBuiltins) },
//{ "audio", audioSubtypeBuiltins, DIM(audioSubtypeBuiltins) },
//{ "model", modelSubtypeBuiltins, DIM(modelSubtypeBuiltins) },
//{ "video", videoSubtypeBuiltins, DIM(videoSubtypeBuiltins) },
{ "*", anySubtypeBuiltins, DIM(anySubtypeBuiltins) },
};

#undef DIM

static const BodyPartFormatter * createForText( const char * subtype ) {
    if ( subtype && *subtype )
        switch ( subtype[0] ) {
        case 'h':
        case 'H':
            if ( kasciistricmp( subtype, "html" ) == 0 )
                return TextHtmlBodyPartFormatter::create();
            break;
        case 'r':
        case 'R':
            if ( kasciistricmp( subtype, "rtf" ) == 0 )
                return AnyTypeBodyPartFormatter::create();
            break;
        case 'x':
        case 'X':
        case 'v':
        case 'V':
            if ( kasciistricmp( subtype, "x-vcard" ) == 0 ||
                 kasciistricmp( subtype, "vcard" ) == 0 )
                return AnyTypeBodyPartFormatter::create();
            break;
        }

    return TextPlainBodyPartFormatter::create();
}

static const BodyPartFormatter * createForImage( const char * ) {
    return ImageTypeBodyPartFormatter::create();
}

static const BodyPartFormatter * createForMessage( const char * subtype ) {
    if ( kasciistricmp( subtype, "rfc822" ) == 0 )
        return MessageRfc822BodyPartFormatter::create();
    return AnyTypeBodyPartFormatter::create();
}

static const BodyPartFormatter * createForMultiPart( const char * subtype ) {
    if ( subtype && *subtype )
        switch ( subtype[0] ) {
        case 'a':
        case 'A':
            if ( kasciistricmp( subtype, "alternative" ) == 0 )
                return MultiPartAlternativeBodyPartFormatter::create();
            break;
        case 'e':
        case 'E':
            if ( kasciistricmp( subtype, "encrypted" ) == 0 )
                return MultiPartEncryptedBodyPartFormatter::create();
            break;
        case 's':
        case 'S':
            if ( kasciistricmp( subtype, "signed" ) == 0 )
                return MultiPartSignedBodyPartFormatter::create();
            break;
        }

    return MultiPartMixedBodyPartFormatter::create();
}

static const BodyPartFormatter * createForApplication( const char * subtype ) {
    if ( subtype && *subtype )
        switch ( subtype[0] ) {
        case 'p':
        case 'P':
            if ( kasciistricmp( subtype, "pgp" ) == 0 )
                return ApplicationPgpBodyPartFormatter::create();
            // fall through
        case 'x':
        case 'X':
            if ( kasciistricmp( subtype, "pkcs7-mime" ) == 0 ||
                 kasciistricmp( subtype, "x-pkcs7-mime" ) == 0 )
                return ApplicationPkcs7MimeBodyPartFormatter::create();
            break;
        case 'v':
        case 'V':
            if ( kasciistricmp( subtype, "vnd.de.bund.bsi.chiasmus-text") == 0)
                return ApplicationChiasmusTextBodyPartFormatter::create();
            break;
        }

    return AnyTypeBodyPartFormatter::create();
}

// OK, replace this with a factory with plugin support later on...
const BodyPartFormatter * BodyPartFormatter::createFor( const char * type, const char * subtype ) {
    if ( type && *type )
        switch ( type[0] ) {
        case 'a': // application
        case 'A':
            if ( kasciistricmp( type, "application" ) == 0 )
                return createForApplication( subtype );
            break;
        case 'i': // image
        case 'I':
            if ( kasciistricmp( type, "image" ) == 0 )
                return createForImage( subtype );
            break;
        case 'm': // multipart / message
        case 'M':
            if ( kasciistricmp( type, "multipart" ) == 0 )
                return createForMultiPart( subtype );
            else if ( kasciistricmp( type, "message" ) == 0 )
                return createForMessage( subtype );
            break;
        case 't': // text
        case 'T':
            if ( kasciistricmp( type, "text" ) == 0 )
                return createForText( subtype );
            break;
        }

    return AnyTypeBodyPartFormatter::create();
}