Fixed mailbox and mailbox group parsing. Added unit tests.

SConstruct

@@ -363,6 +363,7 @@ libvmimetest_sources = [
 	'tests/parser/headerTest.cpp',
 	'tests/parser/headerFieldTest.cpp',
 	'tests/parser/htmlTextPartTest.cpp',
+	'tests/parser/mailboxGroupTest.cpp',
 	'tests/parser/mailboxTest.cpp',
 	'tests/parser/mediaTypeTest.cpp',
 	'tests/parser/messageIdTest.cpp',

src/address.cpp

@@ -68,7 +68,7 @@ address-list    =       (address *("," address)) / obs-addr-list
 
 ref <address> address::parseNext
 	(const parsingContext& ctx, const string& buffer, const string::size_type position,
-	 const string::size_type end, string::size_type* newPosition)
+	 const string::size_type end, string::size_type* newPosition, bool *isLastAddressOfGroup)
 {
 	bool escaped = false;
 	bool quoted = false;
@@ -76,6 +76,10 @@ ref <address> address::parseNext
 	bool inRouteAddr = false;
 	bool isGroup = false;
 	bool stop = false;
+	int commentLevel = 0;
+
+	if (isLastAddressOfGroup)
+		*isLastAddressOfGroup = false;
 
 	string::size_type pos = position;
 
@@ -106,9 +110,22 @@ ref <address> address::parseNext
 			case '>':
 				inRouteAddr = false;
 				break;
+
+			case '(':
+
+				++commentLevel;
+				break;
+
+			case ')':
+
+				if (commentLevel > 0)
+					--commentLevel;
+
+				break;
+
 			case '=':
 
-				if (!quoted && !quotedRFC2047 && pos + 1 < end && buffer[pos + 1] == '?')
+				if (commentLevel == 0 && !quoted && !quotedRFC2047 && pos + 1 < end && buffer[pos + 1] == '?')
 				{
 					++pos;
 					quotedRFC2047 = true;
@@ -118,7 +135,7 @@ ref <address> address::parseNext
 
 			case '?':
 
-				if (quotedRFC2047 && pos + 1 < end && buffer[pos + 1] == '=')
+				if (commentLevel == 0 && quotedRFC2047 && pos + 1 < end && buffer[pos + 1] == '=')
 				{
 					++pos;
 					quotedRFC2047 = false;
@@ -128,7 +145,7 @@ ref <address> address::parseNext
 
 			default:
 			{
-				if (!quoted && !quotedRFC2047 && !inRouteAddr)
+				if (commentLevel == 0 && !quoted && !quotedRFC2047 && !inRouteAddr)
 				{
 					switch (buffer[pos])
 					{
@@ -140,6 +157,9 @@ ref <address> address::parseNext
 								++pos;
 						}
 
+						if (isLastAddressOfGroup)
+							*isLastAddressOfGroup = true;
+
 						stop = true;
 						break;
 

src/addressList.cpp

@@ -60,7 +60,7 @@ void addressList::parseImpl
 
 	while (pos < end)
 	{
-		ref <address> parsedAddress = address::parseNext(ctx, buffer, pos, end, &pos);
+		ref <address> parsedAddress = address::parseNext(ctx, buffer, pos, end, &pos, NULL);
 
 		if (parsedAddress != NULL)
 			m_list.push_back(parsedAddress);

src/mailboxField.cpp

@@ -52,7 +52,7 @@ void mailboxField::parse
 	// Here, we cannot simply call "m_mailbox.parse()" because it
 	// may have more than one address specified (even if this field
 	// should contain only one). We are never too much careful...
-	ref <address> parsedAddress = address::parseNext(ctx, buffer, position, end, newPosition);
+	ref <address> parsedAddress = address::parseNext(ctx, buffer, position, end, newPosition, NULL);
 
 	if (parsedAddress)
 	{

src/mailboxGroup.cpp

@@ -78,10 +78,11 @@ void mailboxGroup::parseImpl
 
 
 	string::size_type pos = position + (p - pstart);
+	bool isLastAddressOfGroup = false;
 
-	while (pos < end)
+	while (pos < end && !isLastAddressOfGroup)
 	{
-		ref <address> parsedAddress = address::parseNext(ctx, buffer, pos, end, &pos);
+		ref <address> parsedAddress = address::parseNext(ctx, buffer, pos, end, &pos, &isLastAddressOfGroup);
 
 		if (parsedAddress)
 		{
@@ -103,7 +104,7 @@ void mailboxGroup::parseImpl
 		}
 	}
 
-	text::decodeAndUnfold(ctx, name, &m_name);
+	text::decodeAndUnfold(ctx, utility::stringUtils::trim(name), &m_name);
 
 	setParsedBounds(position, end);
 

tests/parser/mailboxGroupTest.cpp

@@ -0,0 +1,97 @@
+//
+// VMime library (http://www.vmime.org)
+// Copyright (C) 2002-2013 Vincent Richard <vincent@vmime.org>
+//
+// This program is free software; you can redistribute it and/or
+// modify it under the terms of the GNU General Public License as
+// published by the Free Software Foundation; either version 3 of
+// the License, or (at your option) any later version.
+//
+// This program 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.
+//
+// Linking this library statically or dynamically with other modules is making
+// a combined work based on this library.  Thus, the terms and conditions of
+// the GNU General Public License cover the whole combination.
+//
+
+#include "tests/testUtils.hpp"
+
+
+VMIME_TEST_SUITE_BEGIN(mailboxGroupTest)
+
+	VMIME_TEST_LIST_BEGIN
+		VMIME_TEST(testParseExtraWhitespaces)
+		VMIME_TEST(testParseNoEndDelimiter)
+		VMIME_TEST(testParseExtraChars)
+		VMIME_TEST(testEmptyGroup)
+	VMIME_TEST_LIST_END
+
+
+	void testParseExtraWhitespaces()
+	{
+		vmime::mailboxGroup mgrp;
+		mgrp.parse(" \t group  : aaa <aaa@vmime.org>, bbb <bbb@vmime.org>");
+
+		VASSERT_EQ("name", "group", mgrp.getName().getWholeBuffer());
+		VASSERT_EQ("count", 2, mgrp.getMailboxCount());
+
+		VASSERT_EQ("mbox1.email", "aaa@vmime.org", mgrp.getMailboxAt(0)->getEmail());
+		VASSERT_EQ("mbox1.name", "aaa", mgrp.getMailboxAt(0)->getName());
+
+		VASSERT_EQ("mbox2.email", "bbb@vmime.org", mgrp.getMailboxAt(1)->getEmail());
+		VASSERT_EQ("mbox2.name", "bbb", mgrp.getMailboxAt(1)->getName());
+	}
+
+	void testParseNoEndDelimiter()
+	{
+		vmime::addressList addrs;
+		addrs.parse("group: aaa <aaa@vmime.org>, bbb <bbb@vmime.org>");
+
+		VASSERT_EQ("count", 1, addrs.getAddressCount());
+		VASSERT_TRUE("is group", addrs.getAddressAt(0)->isGroup());
+
+		vmime::ref <vmime::mailboxGroup> mgrp =
+			addrs.getAddressAt(0).dynamicCast <vmime::mailboxGroup>();
+
+		VASSERT_EQ("name", "group", mgrp->getName().getWholeBuffer());
+		VASSERT_EQ("count", 2, mgrp->getMailboxCount());
+
+		VASSERT_EQ("mbox1.email", "aaa@vmime.org", mgrp->getMailboxAt(0)->getEmail());
+		VASSERT_EQ("mbox1.name", "aaa", mgrp->getMailboxAt(0)->getName());
+
+		VASSERT_EQ("mbox2.email", "bbb@vmime.org", mgrp->getMailboxAt(1)->getEmail());
+		VASSERT_EQ("mbox2.name", "bbb", mgrp->getMailboxAt(1)->getName());
+	}
+
+	void testParseExtraChars()
+	{
+		vmime::mailboxGroup mgrp;
+		mgrp.parse("group: aaa <aaa@vmime.org>, bbb <bbb@vmime.org>; extra chars here...");
+
+		VASSERT_EQ("name", "group", mgrp.getName().getWholeBuffer());
+		VASSERT_EQ("count", 2, mgrp.getMailboxCount());
+
+		VASSERT_EQ("mbox1.email", "aaa@vmime.org", mgrp.getMailboxAt(0)->getEmail());
+		VASSERT_EQ("mbox1.name", "aaa", mgrp.getMailboxAt(0)->getName());
+
+		VASSERT_EQ("mbox2.email", "bbb@vmime.org", mgrp.getMailboxAt(1)->getEmail());
+		VASSERT_EQ("mbox2.name", "bbb", mgrp.getMailboxAt(1)->getName());
+	}
+
+	void testEmptyGroup()
+	{
+		vmime::mailboxGroup mgrp;
+		mgrp.parse("Undisclosed recipients:;");
+
+		VASSERT_EQ("name", "Undisclosed recipients", mgrp.getName().getWholeBuffer());
+		VASSERT_EQ("count", 0, mgrp.getMailboxCount());
+	}
+
+VMIME_TEST_SUITE_END

tests/parser/mailboxTest.cpp

@@ -29,6 +29,7 @@ VMIME_TEST_SUITE_BEGIN(mailboxTest)
 	VMIME_TEST_LIST_BEGIN
 		VMIME_TEST(testParse)
 		VMIME_TEST(testEmptyEmailAddress)
+		VMIME_TEST(testSeparatorInComment)
 	VMIME_TEST_LIST_END
 
 
@@ -124,5 +125,22 @@ VMIME_TEST_SUITE_BEGIN(mailboxTest)
 		VASSERT_EQ("email", "", mbox->getEmail());
 	}
 
+	void testSeparatorInComment()
+	{
+		vmime::addressList addrList;
+		addrList.parse("aaa(comment,comment)@vmime.org, bbb@vmime.org");
+
+		VASSERT_EQ("count", 2, addrList.getAddressCount());
+
+		vmime::ref <vmime::mailbox> mbox1 = addrList.getAddressAt(0).dynamicCast <vmime::mailbox>();
+		vmime::ref <vmime::mailbox> mbox2 = addrList.getAddressAt(1).dynamicCast <vmime::mailbox>();
+
+		VASSERT_EQ("name1", vmime::text(), mbox1->getName());
+		VASSERT_EQ("email1", "aaa@vmime.org", mbox1->getEmail());
+
+		VASSERT_EQ("name2", vmime::text(), mbox2->getName());
+		VASSERT_EQ("email2", "bbb@vmime.org", mbox2->getEmail());
+	}
+
 VMIME_TEST_SUITE_END
 

vmime/address.hpp

@@ -70,12 +70,14 @@ public:
 	  * @param position position in the input buffer
 	  * @param end end position in the input buffer
 	  * @param newPosition will receive the new position in the input buffer
+	  * @param isLastAddressOfGroup will be set to true if this is the last address
+	  * of a group (end delimiter was found), or false otherwise (may be set to NULL)
 	  * @return a new address object, or null if no more address is available in the input buffer
 	  */
 	static ref <address> parseNext
 		(const parsingContext& ctx, const string& buffer,
 		 const string::size_type position, const string::size_type end,
-		 string::size_type* newPosition);
+		 string::size_type* newPosition, bool *isLastAddressOfGroup);
 };