vmime/tests/utility/urlTest.cpp

//
// VMime library (http://www.vmime.org)
// Copyright (C) 2002 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"

#include "vmime/utility/url.hpp"
#include "vmime/utility/urlUtils.hpp"


VMIME_TEST_SUITE_BEGIN(urlTest)

	VMIME_TEST_LIST_BEGIN
		VMIME_TEST(testParse1)
		VMIME_TEST(testParse2)
		VMIME_TEST(testParse3)
		VMIME_TEST(testParse4)
		VMIME_TEST(testParse5)
		VMIME_TEST(testParseIPv6Full)
		VMIME_TEST(testParseIPv6NoPort)
		VMIME_TEST(testGenerate)
		VMIME_TEST(testUtilsEncode)
		VMIME_TEST(testUtilsDecode)
		VMIME_TEST(testUtilsDecodeSpecialCases)
		VMIME_TEST(testUtilsEncodeReservedChars)
		VMIME_TEST(testUtilsEncodeUnsafeChars)
	VMIME_TEST_LIST_END


	static bool parseHelper(vmime::utility::url& u, const vmime::string& str) {

		try {

			u = vmime::utility::url(str);

		} catch (vmime::exceptions::malformed_url&) {

			return false;
		}

		return true;
	}


	void testParse1() {

		// Test some valid constructions
		vmime::utility::url u1("", "");

		VASSERT_EQ("1.1", true, parseHelper(u1, "protocol://user:password@host:12345/path/"));
		VASSERT_EQ("1.2", "protocol", u1.getProtocol());
		VASSERT_EQ("1.3", "user", u1.getUsername());
		VASSERT_EQ("1.4", "password", u1.getPassword());
		VASSERT_EQ("1.5", "host", u1.getHost());
		VASSERT_EQ("1.6", 12345, u1.getPort());
		VASSERT_EQ("1.7", "path/", u1.getPath());

		vmime::utility::url u2("", "");

		VASSERT_EQ("2.1", true, parseHelper(u2, "protocol://user@host:12345/path/"));
		VASSERT_EQ("2.2", "protocol", u2.getProtocol());
		VASSERT_EQ("2.3", "user", u2.getUsername());
		VASSERT_EQ("2.4", "", u2.getPassword());
		VASSERT_EQ("2.5", "host", u2.getHost());
		VASSERT_EQ("2.6", 12345, u2.getPort());
		VASSERT_EQ("2.7", "path/", u2.getPath());

		vmime::utility::url u3("", "");

		VASSERT_EQ("3.1", true, parseHelper(u3, "protocol://host:12345/path/"));
		VASSERT_EQ("3.2", "protocol", u3.getProtocol());
		VASSERT_EQ("3.3", "", u3.getUsername());
		VASSERT_EQ("3.4", "", u3.getPassword());
		VASSERT_EQ("3.5", "host", u3.getHost());
		VASSERT_EQ("3.6", 12345, u3.getPort());
		VASSERT_EQ("3.7", "path/", u3.getPath());

		vmime::utility::url u4("", "");

		VASSERT_EQ("4.1", true, parseHelper(u4, "protocol://host/path/"));
		VASSERT_EQ("4.2", "protocol", u4.getProtocol());
		VASSERT_EQ("4.3", "", u4.getUsername());
		VASSERT_EQ("4.4", "", u4.getPassword());
		VASSERT_EQ("4.5", "host", u4.getHost());
		VASSERT_EQ("4.6", vmime::utility::url::UNSPECIFIED_PORT, u4.getPort());
		VASSERT_EQ("4.7", "path/", u4.getPath());

		vmime::utility::url u5("", "");

		VASSERT_EQ("5.1", true, parseHelper(u5, "protocol://host/"));
		VASSERT_EQ("5.2", "protocol", u5.getProtocol());
		VASSERT_EQ("5.3", "", u5.getUsername());
		VASSERT_EQ("5.4", "", u5.getPassword());
		VASSERT_EQ("5.5", "host", u5.getHost());
		VASSERT_EQ("5.6", vmime::utility::url::UNSPECIFIED_PORT, u4.getPort());
		VASSERT_EQ("5.7", "", u5.getPath());

		vmime::utility::url u6("", "");

		VASSERT_EQ("6.1", true, parseHelper(u4, "protocol://host/path/file"));
		VASSERT_EQ("6.2", "protocol", u4.getProtocol());
		VASSERT_EQ("6.3", "", u4.getUsername());
		VASSERT_EQ("6.4", "", u4.getPassword());
		VASSERT_EQ("6.5", "host", u4.getHost());
		VASSERT_EQ("6.6", vmime::utility::url::UNSPECIFIED_PORT, u4.getPort());
		VASSERT_EQ("6.7", "path/file", u4.getPath());
	}

	void testParse2() {

		// Now, test some ill-formed URLs

		// -- missing protocol
		vmime::utility::url u1("", "");
		VASSERT_EQ("1", false, parseHelper(u1, "://host"));

		// -- port can contain only digits
		vmime::utility::url u2("", "");
		VASSERT_EQ("2", false, parseHelper(u2, "proto://host:abc123"));

		// -- no host specified
		vmime::utility::url u3("", "");
		VASSERT_EQ("3", false, parseHelper(u3, "proto:///path"));

		// -- no protocol separator (://)
		vmime::utility::url u4("", "");
		VASSERT_EQ("4", false, parseHelper(u4, "protohost/path"));
	}

	void testParse3() {

		// Test decoding
		vmime::utility::url u1("", "");

		VASSERT_EQ("1.1", true, parseHelper(u1, "pro%12to://user%34:pass%56word@ho%78st:12345/pa%abth/"));
		VASSERT_EQ("1.2", "pro%12to", u1.getProtocol());  // protocol should not be decoded
		VASSERT_EQ("1.3", "user\x34", u1.getUsername());
		VASSERT_EQ("1.4", "pass\x56word", u1.getPassword());
		VASSERT_EQ("1.5", "ho\x78st", u1.getHost());
		VASSERT_EQ("1.6", 12345, u1.getPort());
		VASSERT_EQ("1.7", "pa\xabth/", u1.getPath());
	}

	void testParse4() {

		// Test parameters
		vmime::utility::url u1("", "");

		VASSERT_EQ("1.1", true, parseHelper(u1, "proto://host/path?p1=v1&p2=v2"));
		VASSERT_EQ("1.2", "v1", u1.getParams()["p1"]);
		VASSERT_EQ("1.3", "v2", u1.getParams()["p2"]);
		VASSERT_EQ("1.4", "path", u1.getPath());

		vmime::utility::url u2("", "");

		VASSERT_EQ("2.1", true, parseHelper(u2, "proto://host/path?p1=v1&p2"));
		VASSERT_EQ("2.2", "v1", u2.getParams()["p1"]);
		VASSERT_EQ("2.3", "p2", u2.getParams()["p2"]);
		VASSERT_EQ("2.4", "path", u2.getPath());

		vmime::utility::url u3("", "");

		VASSERT_EQ("3.1", true, parseHelper(u3, "proto://host/?p1=v1&p2=v2"));
		VASSERT_EQ("3.2", "v1", u3.getParams()["p1"]);
		VASSERT_EQ("3.3", "v2", u3.getParams()["p2"]);
		VASSERT_EQ("3.4", "", u3.getPath());

		vmime::utility::url u4("", "");

		VASSERT_EQ("4.1", true, parseHelper(u4, "proto://host/path?p1=%3D&%3D=v2"));
		VASSERT_EQ("4.2", "=", u4.getParams()["p1"]);
		VASSERT_EQ("4.3", "v2", u4.getParams()["="]);
		VASSERT_EQ("4.4", "path", u4.getPath());
	}

	// '@' symbol in the username part
	void testParse5() {

		vmime::utility::url u1("", "");

		VASSERT_EQ("1", true, parseHelper(u1, "imap://account@myserver.com:password@myserver.com"));
		VASSERT_EQ("2", "account@myserver.com", u1.getUsername());
		VASSERT_EQ("3", "password", u1.getPassword());
		VASSERT_EQ("4", "myserver.com", u1.getHost());
	}

	void testParseIPv6Full() {

		vmime::utility::url u1("", "");

		VASSERT_EQ("1", true, parseHelper(u1, "http://a:b@[::1]:80/p"));
		VASSERT_EQ("2", "a", u1.getUsername());
		VASSERT_EQ("3", "b", u1.getPassword());
		VASSERT_EQ("4", "::1", u1.getHost());
		VASSERT_EQ("5", 80, u1.getPort());
		VASSERT_EQ("6", "p", u1.getPath());
	}

	void testParseIPv6NoPort() {

		vmime::utility::url u1("", "");

		VASSERT_EQ("1", true, parseHelper(u1, "http://[::1]/"));
		VASSERT_EQ("2", "::1", u1.getHost());
	}

	void testGenerate() {

		vmime::utility::url u1("proto", "host", 12345, "path", "user", "password");
		VASSERT_EQ(
			"1",
			"proto://user:password@host:12345/path",
			static_cast <vmime::string>(u1)
		);

		vmime::utility::url u2("proto", "host");
		VASSERT_EQ("2", "proto://host", static_cast <vmime::string>(u2));

		vmime::utility::url u3("proto", "host");
		u3.getParams()["p1"] = "v1";
		VASSERT_EQ(
			"3.1",
			"proto://host/?p1=v1",
			static_cast <vmime::string>(u3)
		);
		u3.getParams()["p2"] = "v2";
		VASSERT_EQ(
			"3.2",
			"proto://host/?p1=v1&p2=v2",
			static_cast <vmime::string>(u3)
		);

		// Test special characters
		u3.getParams().clear();
		u3.getParams()["&"] = "=";
		VASSERT_EQ(
			"3.3",
			"proto://host/?%26=%3D",
			static_cast <vmime::string>(u3)
		);

		vmime::utility::url u5("http", "::1", 80, "p");
		VASSERT_EQ(
			"4",
			"http://[::1]:80/p",
			static_cast <vmime::string>(u5)
		);
	}

	void testUtilsEncode() {

		VASSERT_EQ("1", "%01", vmime::utility::urlUtils::encode("\x01"));
		VASSERT_EQ("2", "%20", vmime::utility::urlUtils::encode(" "));
		VASSERT_EQ("3", "%FF", vmime::utility::urlUtils::encode("\xff"));
		VASSERT_EQ("4", "a", vmime::utility::urlUtils::encode("a"));
	}

	void testUtilsDecode() {

		for (int i = 0 ; i < 255 ; ++i) {

			std::ostringstream ossTest;
			ossTest << "%" << "0123456789ABCDEF"[i / 16]
			               << "0123456789ABCDEF"[i % 16];

			std::ostringstream ossNum;
			ossNum << i;

			vmime::string res;
			res += static_cast <unsigned char>(i);

			VASSERT_EQ(
				ossNum.str(),
				res,
				vmime::utility::urlUtils::decode(ossTest.str())
			);
		}

	}

	void testUtilsDecodeSpecialCases() {

		// Bug #1656547: segfault with '%' at the end of the string
		VASSERT_EQ("1.1", "sadfsda%", vmime::utility::urlUtils::decode("sadfsda%"));
		VASSERT_EQ("1.2", "sadfsda\x05", vmime::utility::urlUtils::decode("sadfsda%5"));
		VASSERT_EQ("1.3", "sadfsda\x42", vmime::utility::urlUtils::decode("sadfsda%42"));
	}

	void testUtilsEncodeReservedChars() {

		VASSERT_EQ("1",  "%24", vmime::utility::urlUtils::encode("$"));
		VASSERT_EQ("2",  "%26", vmime::utility::urlUtils::encode("&"));
		VASSERT_EQ("3",  "%2B", vmime::utility::urlUtils::encode("+"));
		VASSERT_EQ("4",  "%2C", vmime::utility::urlUtils::encode(","));
		VASSERT_EQ("5",  "%2F", vmime::utility::urlUtils::encode("/"));
		VASSERT_EQ("6",  "%3A", vmime::utility::urlUtils::encode(":"));
		VASSERT_EQ("7",  "%3B", vmime::utility::urlUtils::encode(";"));
		VASSERT_EQ("8",  "%3D", vmime::utility::urlUtils::encode("="));
		VASSERT_EQ("9",  "%3F", vmime::utility::urlUtils::encode("?"));
		VASSERT_EQ("10", "%40", vmime::utility::urlUtils::encode("@"));
	}

	void testUtilsEncodeUnsafeChars() {

		VASSERT_EQ("1",  "%20", vmime::utility::urlUtils::encode(" "));
		VASSERT_EQ("2",  "%22", vmime::utility::urlUtils::encode("\""));
		VASSERT_EQ("3",  "%3C", vmime::utility::urlUtils::encode("<"));
		VASSERT_EQ("4",  "%3E", vmime::utility::urlUtils::encode(">"));
		VASSERT_EQ("5",  "%23", vmime::utility::urlUtils::encode("#"));
		VASSERT_EQ("6",  "%25", vmime::utility::urlUtils::encode("%"));
		VASSERT_EQ("7",  "%7B", vmime::utility::urlUtils::encode("{"));
		VASSERT_EQ("8",  "%7D", vmime::utility::urlUtils::encode("}"));
		VASSERT_EQ("9",  "%7C", vmime::utility::urlUtils::encode("|"));
		VASSERT_EQ("10", "%5C", vmime::utility::urlUtils::encode("\\"));
		VASSERT_EQ("11", "%5E", vmime::utility::urlUtils::encode("^"));
		VASSERT_EQ("12", "%7E", vmime::utility::urlUtils::encode("~"));
		VASSERT_EQ("13", "%5B", vmime::utility::urlUtils::encode("["));
		VASSERT_EQ("14", "%5D", vmime::utility::urlUtils::encode("]"));
		VASSERT_EQ("15", "%60", vmime::utility::urlUtils::encode("`"));
	}

VMIME_TEST_SUITE_END