diff options
| -rw-r--r-- | src/body.cpp | 98 | ||||
| -rw-r--r-- | src/charset.cpp | 50 | ||||
| -rw-r--r-- | src/emptyContentHandler.cpp | 6 | ||||
| -rw-r--r-- | src/encoding.cpp | 38 | ||||
| -rw-r--r-- | src/htmlTextPart.cpp | 19 | ||||
| -rw-r--r-- | src/net/imap/IMAPMessagePartContentHandler.cpp | 6 | ||||
| -rw-r--r-- | src/plainTextPart.cpp | 9 | ||||
| -rw-r--r-- | src/streamContentHandler.cpp | 7 | ||||
| -rw-r--r-- | src/stringContentHandler.cpp | 6 | ||||
| -rw-r--r-- | src/wordEncoder.cpp | 58 | ||||
| -rw-r--r-- | vmime/body.hpp | 53 | ||||
| -rw-r--r-- | vmime/charset.hpp | 13 | ||||
| -rw-r--r-- | vmime/contentHandler.hpp | 7 | ||||
| -rw-r--r-- | vmime/emptyContentHandler.hpp | 2 | ||||
| -rw-r--r-- | vmime/encoding.hpp | 35 | ||||
| -rw-r--r-- | vmime/net/imap/IMAPMessagePartContentHandler.hpp | 2 | ||||
| -rw-r--r-- | vmime/streamContentHandler.hpp | 2 | ||||
| -rw-r--r-- | vmime/stringContentHandler.hpp | 2 |
18 files changed, 334 insertions, 79 deletions
diff --git a/src/body.cpp b/src/body.cpp index 3f5ff0f6..13dff6b4 100644 --- a/src/body.cpp +++ b/src/body.cpp @@ -213,8 +213,26 @@ void body::parse(const string& buffer, const string::size_type position, // Treat the contents as 'simple' data else { + encoding enc; + + try + { + const ref <const headerField> cef = + m_header.acquire()->findField(fields::CONTENT_TRANSFER_ENCODING); + + enc = *cef->getValue().dynamicCast <const encoding>(); + } + catch (exceptions::no_such_field&) + { + // Defaults to "7bit" (RFC-1521) + enc = vmime::encoding(encodingTypes::SEVEN_BIT); + + // Set header field + m_header.acquire()->ContentTransferEncoding()->setValue(enc); + } + // Extract the (encoded) contents - m_contents = vmime::create <stringContentHandler>(buffer, position, end, getEncoding()); + m_contents = vmime::create <stringContentHandler>(buffer, position, end, enc); } setParsedBounds(position, end); @@ -406,6 +424,22 @@ bool body::isValidBoundary(const string& boundary) // Quick-access functions // + +void body::setContentType(const mediaType& type, const charset& chset) +{ + ref <contentTypeField> ctf = m_header.acquire()->ContentType().dynamicCast <contentTypeField>(); + + ctf->setValue(type); + ctf->setCharset(chset); +} + + +void body::setContentType(const mediaType& type) +{ + m_header.acquire()->ContentType()->setValue(type); +} + + const mediaType body::getContentType() const { try @@ -423,6 +457,25 @@ const mediaType body::getContentType() const } +void body::setCharset(const charset& chset) +{ + // If a Content-Type field exists, set charset + try + { + ref <contentTypeField> ctf = + m_header.acquire()->findField(fields::CONTENT_TYPE).dynamicCast <contentTypeField>(); + + ctf->setCharset(chset); + } + // Else, create a new Content-Type field of default type "text/plain" + // and set charset on it + catch (exceptions::no_such_field&) + { + setContentType(mediaType(mediaTypes::TEXT, mediaTypes::TEXT_PLAIN), chset); + } +} + + const charset body::getCharset() const { try @@ -445,6 +498,12 @@ const charset body::getCharset() const } +void body::setEncoding(const encoding& enc) +{ + m_header.acquire()->ContentTransferEncoding()->setValue(enc); +} + + const encoding body::getEncoding() const { try @@ -456,8 +515,15 @@ const encoding body::getEncoding() const } catch (exceptions::no_such_field&) { - // Defaults to "7bit" (RFC-1521) - return (vmime::encoding(encodingTypes::SEVEN_BIT)); + if (m_contents->isEncoded()) + { + return m_contents->getEncoding(); + } + else + { + // Defaults to "7bit" (RFC-1521) + return vmime::encoding(encodingTypes::SEVEN_BIT); + } } } @@ -551,6 +617,32 @@ void body::setContents(ref <const contentHandler> contents) } +void body::setContents(ref <const contentHandler> contents, const mediaType& type) +{ + m_contents = contents; + + setContentType(type); +} + + +void body::setContents(ref <const contentHandler> contents, const mediaType& type, const charset& chset) +{ + m_contents = contents; + + setContentType(type, chset); +} + + +void body::setContents(ref <const contentHandler> contents, const mediaType& type, + const charset& chset, const encoding& enc) +{ + m_contents = contents; + + setContentType(type, chset); + setEncoding(enc); +} + + void body::initNewPart(ref <bodyPart> part) { part->m_parent = m_part; diff --git a/src/charset.cpp b/src/charset.cpp index e3c11daa..e0431860 100644 --- a/src/charset.cpp +++ b/src/charset.cpp @@ -24,6 +24,7 @@ #include "vmime/charset.hpp" #include "vmime/exception.hpp" #include "vmime/platform.hpp" +#include "vmime/encoding.hpp" #include "vmime/utility/stringUtils.hpp" @@ -140,4 +141,53 @@ const std::vector <ref <const component> > charset::getChildComponents() const } + +// Explicitly force encoding for some charsets +struct CharsetEncodingEntry +{ + CharsetEncodingEntry(const string& charset_, const string& encoding_) + : charset(charset_), encoding(encoding_) + { + } + + const string charset; + const string encoding; +}; + +CharsetEncodingEntry g_charsetEncodingMap[] = +{ + // Use QP encoding for ISO-8859-x charsets + CharsetEncodingEntry("iso-8859", encodingTypes::QUOTED_PRINTABLE), + CharsetEncodingEntry("iso8859", encodingTypes::QUOTED_PRINTABLE), + + // RFC-1468 states: + // " ISO-2022-JP may also be used in MIME Part 2 headers. The "B" + // encoding should be used with ISO-2022-JP text. " + // Use Base64 encoding for all ISO-2022 charsets. + CharsetEncodingEntry("iso-2022", encodingTypes::BASE64), + CharsetEncodingEntry("iso2022", encodingTypes::BASE64), + + // Last entry is not used + CharsetEncodingEntry("", "") +}; + + +bool charset::getRecommendedEncoding(encoding& enc) const +{ + // Special treatment for some charsets + const string cset = utility::stringUtils::toLower(getName()); + + for (unsigned int i = 0 ; i < (sizeof(g_charsetEncodingMap) / sizeof(g_charsetEncodingMap[0])) - 1 ; ++i) + { + if (cset.find(g_charsetEncodingMap[i].charset) != string::npos) + { + enc = g_charsetEncodingMap[i].encoding; + return true; + } + } + + return false; +} + + } // vmime diff --git a/src/emptyContentHandler.cpp b/src/emptyContentHandler.cpp index 5245341a..48dc3511 100644 --- a/src/emptyContentHandler.cpp +++ b/src/emptyContentHandler.cpp @@ -96,4 +96,10 @@ const vmime::encoding& emptyContentHandler::getEncoding() const } +bool emptyContentHandler::isBuffered() const +{ + return true; +} + + } // vmime diff --git a/src/encoding.cpp b/src/encoding.cpp index 58ce71de..0919d44c 100644 --- a/src/encoding.cpp +++ b/src/encoding.cpp @@ -110,7 +110,7 @@ bool encoding::operator!=(const encoding& value) const } -const encoding encoding::decide +const encoding encoding::decideImpl (const string::const_iterator begin, const string::const_iterator end) { const string::difference_type length = end - begin; @@ -164,10 +164,40 @@ const encoding encoding::decide } -const encoding encoding::decide(ref <const contentHandler> /* data */) +const encoding encoding::decide + (ref <const contentHandler> data, const EncodingUsage usage) { - // TODO: a better solution to do that? - return (encoding(encodingTypes::BASE64)); + if (usage == USAGE_TEXT && data->isBuffered() && + data->getLength() > 0 && data->getLength() < 32768) + { + // Extract data into temporary buffer + string buffer; + utility::outputStreamStringAdapter os(buffer); + + data->extract(os); + os.flush(); + + return decideImpl(buffer.begin(), buffer.end()); + } + else + { + return encoding(encodingTypes::BASE64); + } +} + + +const encoding encoding::decide(ref <const contentHandler> data, + const charset& chset, const EncodingUsage usage) +{ + if (usage == USAGE_TEXT) + { + encoding recEncoding; + + if (chset.getRecommendedEncoding(recEncoding)) + return recEncoding; + } + + return decide(data, usage); } diff --git a/src/htmlTextPart.cpp b/src/htmlTextPart.cpp index 7713034f..c845b576 100644 --- a/src/htmlTextPart.cpp +++ b/src/htmlTextPart.cpp @@ -69,27 +69,20 @@ void htmlTextPart::generateIn(ref <bodyPart> /* message */, ref <bodyPart> paren ref <bodyPart> part = vmime::create <bodyPart>(); parent->getBody()->appendPart(part); - // -- Set header fields - part->getHeader()->ContentType()->setValue - (mediaType(mediaTypes::TEXT, mediaTypes::TEXT_PLAIN)); - part->getHeader()->ContentType().dynamicCast <contentTypeField>()->setCharset(m_charset); - part->getHeader()->ContentTransferEncoding()->setValue(encoding(encodingTypes::QUOTED_PRINTABLE)); - // -- Set contents - part->getBody()->setContents(m_plainText); + part->getBody()->setContents(m_plainText, + mediaType(mediaTypes::TEXT, mediaTypes::TEXT_PLAIN), m_charset, + encoding::decide(m_plainText, m_charset, encoding::USAGE_TEXT)); } // HTML text // -- Create a new part ref <bodyPart> htmlPart = vmime::create <bodyPart>(); - // -- Set header fields - htmlPart->getHeader()->ContentType()->setValue(mediaType(mediaTypes::TEXT, mediaTypes::TEXT_HTML)); - htmlPart->getHeader()->ContentType().dynamicCast <contentTypeField>()->setCharset(m_charset); - htmlPart->getHeader()->ContentTransferEncoding()->setValue(encoding(encodingTypes::QUOTED_PRINTABLE)); - // -- Set contents - htmlPart->getBody()->setContents(m_text); + htmlPart->getBody()->setContents(m_text, + mediaType(mediaTypes::TEXT, mediaTypes::TEXT_HTML), m_charset, + encoding::decide(m_text, m_charset, encoding::USAGE_TEXT)); // Handle the case we have embedded objects if (!m_objects.empty()) diff --git a/src/net/imap/IMAPMessagePartContentHandler.cpp b/src/net/imap/IMAPMessagePartContentHandler.cpp index a226b680..4e6ba97a 100644 --- a/src/net/imap/IMAPMessagePartContentHandler.cpp +++ b/src/net/imap/IMAPMessagePartContentHandler.cpp @@ -173,6 +173,12 @@ bool IMAPMessagePartContentHandler::isEmpty() const } +bool IMAPMessagePartContentHandler::isBuffered() const +{ + return true; +} + + } // imap } // net } // vmime diff --git a/src/plainTextPart.cpp b/src/plainTextPart.cpp index 7a674e79..15bcb5eb 100644 --- a/src/plainTextPart.cpp +++ b/src/plainTextPart.cpp @@ -63,13 +63,10 @@ void plainTextPart::generateIn(ref <bodyPart> /* message */, ref <bodyPart> pare ref <bodyPart> part = vmime::create <bodyPart>(); parent->getBody()->appendPart(part); - // Set header fields - part->getHeader()->ContentType()->setValue(mediaType(mediaTypes::TEXT, mediaTypes::TEXT_PLAIN)); - part->getHeader()->ContentType().dynamicCast <contentTypeField>()->setCharset(m_charset); - part->getHeader()->ContentTransferEncoding()->setValue(encoding(encodingTypes::QUOTED_PRINTABLE)); - // Set contents - part->getBody()->setContents(m_text); + part->getBody()->setContents(m_text, + mediaType(mediaTypes::TEXT, mediaTypes::TEXT_PLAIN), m_charset, + encoding::decide(m_text, m_charset, encoding::USAGE_TEXT)); } diff --git a/src/streamContentHandler.cpp b/src/streamContentHandler.cpp index 9edf4aa6..2ebd073a 100644 --- a/src/streamContentHandler.cpp +++ b/src/streamContentHandler.cpp @@ -201,4 +201,11 @@ const vmime::encoding& streamContentHandler::getEncoding() const } +bool streamContentHandler::isBuffered() const +{ + // FIXME: some streams can be resetted + return false; +} + + } // vmime diff --git a/src/stringContentHandler.cpp b/src/stringContentHandler.cpp index 248fca47..4e85a6ce 100644 --- a/src/stringContentHandler.cpp +++ b/src/stringContentHandler.cpp @@ -202,4 +202,10 @@ const vmime::encoding& stringContentHandler::getEncoding() const } +bool stringContentHandler::isBuffered() const +{ + return true; +} + + } // vmime diff --git a/src/wordEncoder.cpp b/src/wordEncoder.cpp index cc8292f8..22994edf 100644 --- a/src/wordEncoder.cpp +++ b/src/wordEncoder.cpp @@ -26,6 +26,8 @@ #include "vmime/exception.hpp" #include "vmime/charsetConverter.hpp" +#include "vmime/encoding.hpp" + #include "vmime/utility/encoder/b64Encoder.hpp" #include "vmime/utility/encoder/qpEncoder.hpp" @@ -260,50 +262,14 @@ wordEncoder::Encoding wordEncoder::getEncoding() const } -// Explicitly force encoding for some charsets -struct CharsetEncodingEntry -{ - CharsetEncodingEntry(const std::string& charset_, const wordEncoder::Encoding encoding_) - : charset(charset_), encoding(encoding_) - { - } - - std::string charset; - wordEncoder::Encoding encoding; -}; - -CharsetEncodingEntry g_charsetEncodingMap[] = -{ - // Use QP encoding for ISO-8859-x charsets - CharsetEncodingEntry("iso-8859", wordEncoder::ENCODING_QP), - CharsetEncodingEntry("iso8859", wordEncoder::ENCODING_QP), - - // RFC-1468 states: - // " ISO-2022-JP may also be used in MIME Part 2 headers. The "B" - // encoding should be used with ISO-2022-JP text. " - // Use Base64 encoding for all ISO-2022 charsets. - CharsetEncodingEntry("iso-2022", wordEncoder::ENCODING_B64), - CharsetEncodingEntry("iso2022", wordEncoder::ENCODING_B64), - - // Last entry is not used - CharsetEncodingEntry("", wordEncoder::ENCODING_AUTO) -}; - - // static bool wordEncoder::isEncodingNeeded(const string& buffer, const charset& charset) { - // Special treatment for some charsets - const string cset = utility::stringUtils::toLower(charset.getName()); + // Charset-specific encoding + encoding recEncoding; - for (unsigned int i = 0 ; i < (sizeof(g_charsetEncodingMap) / sizeof(g_charsetEncodingMap[0])) - 1 ; ++i) - { - if (cset.find(g_charsetEncodingMap[i].charset) != string::npos) - { - if (g_charsetEncodingMap[i].encoding != wordEncoder::ENCODING_AUTO) - return true; - } - } + if (charset.getRecommendedEncoding(recEncoding)) + return true; // No encoding is needed if the buffer only contains ASCII chars if (utility::stringUtils::findFirstNonASCIIchar(buffer.begin(), buffer.end()) != string::npos) @@ -322,13 +288,15 @@ bool wordEncoder::isEncodingNeeded(const string& buffer, const charset& charset) wordEncoder::Encoding wordEncoder::guessBestEncoding (const string& buffer, const charset& charset) { - // Special treatment for some charsets - const string cset = utility::stringUtils::toLower(charset.getName()); + // Charset-specific encoding + encoding recEncoding; - for (unsigned int i = 0 ; i < (sizeof(g_charsetEncodingMap) / sizeof(g_charsetEncodingMap[0])) - 1 ; ++i) + if (charset.getRecommendedEncoding(recEncoding)) { - if (cset.find(g_charsetEncodingMap[i].charset) != string::npos) - return g_charsetEncodingMap[i].encoding; + if (recEncoding == encoding(encodingTypes::QUOTED_PRINTABLE)) + return ENCODING_QP; + else + return ENCODING_B64; } // Use Base64 if more than 40% non-ASCII, or Quoted-Printable else (default) diff --git a/vmime/body.hpp b/vmime/body.hpp index 80c1bb5d..9e83d6b5 100644 --- a/vmime/body.hpp +++ b/vmime/body.hpp @@ -184,6 +184,45 @@ public: */ void setContents(ref <const contentHandler> contents); + /** Set the body contents and type. + * + * @param contents new body contents + * @param type type of contents + */ + void setContents(ref <const contentHandler> contents, const mediaType& type); + + /** Set the body contents, type and charset. + * + * @param contents new body contents + * @param type type of contents + * @param charset charset of contents + */ + void setContents(ref <const contentHandler> contents, const mediaType& type, const charset& chset); + + /** Set the body contents, type, charset and encoding. + * + * @param contents new body contents + * @param type type of contents + * @param charset charset of contents + * @param encoding contents encoding + */ + void setContents(ref <const contentHandler> contents, const mediaType& type, + const charset& chset, const encoding& enc); + + /** Set the MIME type and charset of contents. + * If a charset is defined, it will not be modified. + * + * @param type MIME media type of contents + * @param chset charset of contents + */ + void setContentType(const mediaType& type, const charset& chset); + + /** Set the MIME type of contents. + * + * @param type MIME media type of contents + */ + void setContentType(const mediaType& type); + /** Return the media type of the data contained in the body contents. * This is a shortcut for getHeader()->ContentType()->getValue() * on the parent part. @@ -192,6 +231,13 @@ public: */ const mediaType getContentType() const; + /** Set the charset of contents. + * If the type is not set, it will be set to default "text/plain" type. + * + * @param chset charset of contents + */ + void setCharset(const charset& chset); + /** Return the charset of the data contained in the body contents. * This is a shortcut for getHeader()->ContentType()->getCharset() * on the parent part. @@ -200,6 +246,13 @@ public: */ const charset getCharset() const; + /** Set the output encoding of contents. + * Contents will be encoded (or re-encoded) when this node is being generated. + * + * @param enc encoding of contents + */ + void setEncoding(const encoding& enc); + /** Return the encoding used to encode the body contents. * This is a shortcut for getHeader()->ContentTransferEncoding()->getValue() * on the parent part. diff --git a/vmime/charset.hpp b/vmime/charset.hpp index 1d25b748..b2e241cc 100644 --- a/vmime/charset.hpp +++ b/vmime/charset.hpp @@ -33,6 +33,9 @@ namespace vmime { +class encoding; // forward reference + + /** Charset description (basic type). */ @@ -59,6 +62,16 @@ public: const std::vector <ref <const component> > getChildComponents() const; + /** Gets the recommended encoding for this charset. + * Note: there may be no recommended encoding. + * + * @param enc output parameter that will hold recommended encoding + * @return true if an encoding is recommended (the encoding is stored + * in the enc parameter), false otherwise (in this case, the enc + * parameter is not modified) + */ + bool getRecommendedEncoding(encoding& enc) const; + /** Returns the default charset used on the system. * * This function simply calls <code>platformHandler::getLocaleCharset()</code> diff --git a/vmime/contentHandler.hpp b/vmime/contentHandler.hpp index 38e4e245..0374cbea 100644 --- a/vmime/contentHandler.hpp +++ b/vmime/contentHandler.hpp @@ -111,6 +111,13 @@ public: * @return true if no data is managed by this object, false otherwise */ virtual bool isEmpty() const = 0; + + /** Indicates whether the extract() method can be called multiple times. + * + * @return true if the data can be extracted multiple times, or false + * if not (ie. streamed data from socket) + */ + virtual bool isBuffered() const = 0; }; diff --git a/vmime/emptyContentHandler.hpp b/vmime/emptyContentHandler.hpp index 727c065c..7b1e7eb9 100644 --- a/vmime/emptyContentHandler.hpp +++ b/vmime/emptyContentHandler.hpp @@ -52,6 +52,8 @@ public: const vmime::encoding& getEncoding() const; bool isEmpty() const; + + bool isBuffered() const; }; diff --git a/vmime/encoding.hpp b/vmime/encoding.hpp index fa72dfb1..ba78081a 100644 --- a/vmime/encoding.hpp +++ b/vmime/encoding.hpp @@ -45,6 +45,13 @@ class encoding : public headerFieldValue { public: + enum EncodingUsage + { + USAGE_TEXT, /**< Use for body text. */ + USAGE_BINARY_DATA /**< Use for attachment, image... */ + }; + + encoding(); explicit encoding(const string& name); encoding(const encoding& enc); @@ -75,20 +82,21 @@ public: /** Decide which encoding to use based on the specified data. * - * \deprecated Use the new decide() method which takes a contentHandler parameter. - * - * @param begin start iterator in buffer - * @param end end iterator in buffer + * @param data data used to determine encoding + * @param usage context of use of data * @return suitable encoding for specified data */ - static const encoding decide(const string::const_iterator begin, const string::const_iterator end); + static const encoding decide(ref <const contentHandler> data, const EncodingUsage usage = USAGE_BINARY_DATA); - /** Decide which encoding to use based on the specified data. + /** Decide which encoding to use based on the specified data and charset. * * @param data data used to determine encoding - * @return suitable encoding for specified data + * @param charset charset of data + * @param usage context of use of data + * @return suitable encoding for specified data and charset */ - static const encoding decide(ref <const contentHandler> data); + static const encoding decide(ref <const contentHandler> data, const charset& chset, const EncodingUsage usage = USAGE_BINARY_DATA); + ref <component> clone() const; void copyFrom(const component& other); @@ -106,6 +114,17 @@ private: string m_name; + /** Decide which encoding to use based on the specified data. + * + * Please note: this will read the whole buffer, so it should be used only + * for small amount of data (eg. text), and not large binary attachments. + * + * @param begin start iterator in buffer + * @param end end iterator in buffer + * @return suitable encoding for specified data + */ + static const encoding decideImpl(const string::const_iterator begin, const string::const_iterator end); + public: using component::parse; diff --git a/vmime/net/imap/IMAPMessagePartContentHandler.hpp b/vmime/net/imap/IMAPMessagePartContentHandler.hpp index 0c4641e9..75a03afd 100644 --- a/vmime/net/imap/IMAPMessagePartContentHandler.hpp +++ b/vmime/net/imap/IMAPMessagePartContentHandler.hpp @@ -55,6 +55,8 @@ public: bool isEmpty() const; + bool isBuffered() const; + private: weak_ref <IMAPMessage> m_message; diff --git a/vmime/streamContentHandler.hpp b/vmime/streamContentHandler.hpp index aa62b2fc..703fb72c 100644 --- a/vmime/streamContentHandler.hpp +++ b/vmime/streamContentHandler.hpp @@ -62,6 +62,8 @@ public: bool isEmpty() const; + bool isBuffered() const; + private: // Equals to NO_ENCODING if data is not encoded, otherwise this diff --git a/vmime/stringContentHandler.hpp b/vmime/stringContentHandler.hpp index 8d368890..a73ae67d 100644 --- a/vmime/stringContentHandler.hpp +++ b/vmime/stringContentHandler.hpp @@ -80,6 +80,8 @@ public: bool isEmpty() const; + bool isBuffered() const; + private: // Equals to NO_ENCODING if data is not encoded, otherwise this |