Add UrlFromPieces helper function
This commit attempts to improve our ability to encode URIs from pieces
of a string. In the past, we've used std::string::operator+= for this,
which has problems in that bad characters are not encoded correctly into
a URI. As an example, if we got a dbus path with _2F (ascii /) in it,
our current code would push that directly into the uri and break the
redfish tree.
Examples of use are provided in the unit tests.
Tested:
Unit tests pass, no functional changes yet.
Signed-off-by: Ed Tanous <edtanous@google.com>
Change-Id: I5801d2146a5c948396d4766ac96f1f2b25205a0f
diff --git a/http/ut/utility_test.cpp b/http/ut/utility_test.cpp
index 5dafdce..eecd1f6 100644
--- a/http/ut/utility_test.cpp
+++ b/http/ut/utility_test.cpp
@@ -107,5 +107,21 @@
EXPECT_EQ(getDateTimeUintMs(std::numeric_limits<uint64_t>::min()),
"1970-01-01T00:00:00+00:00");
}
+
+TEST(Utility, UrlFromPieces)
+{
+ using crow::utility::urlFromPieces;
+ boost::urls::url url = urlFromPieces("redfish", "v1", "foo");
+ EXPECT_EQ(std::string_view(url.data(), url.size()), "/redfish/v1/foo");
+
+ url = urlFromPieces("/", "badString");
+ EXPECT_EQ(std::string_view(url.data(), url.size()), "/%2f/badString");
+
+ url = urlFromPieces("bad?tring");
+ EXPECT_EQ(std::string_view(url.data(), url.size()), "/bad%3ftring");
+
+ url = urlFromPieces("/", "bad&tring");
+ EXPECT_EQ(std::string_view(url.data(), url.size()), "/%2f/bad&tring");
+}
} // namespace
} // namespace crow::utility
diff --git a/http/utility.hpp b/http/utility.hpp
index 749da9b..873cfe4 100644
--- a/http/utility.hpp
+++ b/http/utility.hpp
@@ -3,6 +3,7 @@
#include <openssl/crypto.h>
#include <boost/date_time/posix_time/posix_time.hpp>
+#include <boost/url/url.hpp>
#include <array>
#include <chrono>
@@ -671,5 +672,25 @@
}
};
+namespace details
+{
+inline boost::urls::url
+ urlFromPiecesDetail(const std::initializer_list<std::string_view> args)
+{
+ boost::urls::url url("/");
+ for (const std::string_view& arg : args)
+ {
+ url.segments().push_back(arg);
+ }
+ return url;
+}
+} // namespace details
+
+template <typename... AV>
+inline boost::urls::url urlFromPieces(const AV... args)
+{
+ return details::urlFromPiecesDetail({args...});
+}
+
} // namespace utility
} // namespace crow