Merge pull request #762 from capnproto/url-allow-empty

Extend kj::Url with option to not collapse empty path/query components.

c++/src/kj/compat/url-test.c++

@@ -39,6 +39,12 @@ Url parseAndCheck(kj::StringPtr originalText, kj::StringPtr expectedRestringifie
 
 static constexpr Url::Options NO_DECODE {
   false,  // percentDecode
+  false,  // allowEmpty
+};
+
+static constexpr Url::Options ALLOW_EMPTY {
+  true,    // percentDecode
+  true,    // allowEmpty
 };
 
 KJ_TEST("parse / stringify URL") {
@@ -281,6 +287,25 @@ KJ_TEST("parse / stringify URL") {
   parseAndCheck("https://capnproto.org/foo%25bar");
   parseAndCheck("https://capnproto.org/?foo%25bar=baz%25qux");
   parseAndCheck("https://capnproto.org/#foo%25bar");
+
+  // Make sure redundant /'s and &'s aren't collapsed when options.removeEmpty is false.
+  parseAndCheck("https://capnproto.org/foo//bar///test//?foo=bar&&baz=qux&", nullptr, ALLOW_EMPTY);
+
+  // "." and ".." are still processed, though.
+  parseAndCheck("https://capnproto.org/foo//../bar/.",
+                "https://capnproto.org/foo/bar/", ALLOW_EMPTY);
+
+  {
+    auto url = parseAndCheck("https://foo/", nullptr, ALLOW_EMPTY);
+    KJ_EXPECT(url.path.size() == 0);
+    KJ_EXPECT(url.hasTrailingSlash);
+  }
+
+  {
+    auto url = parseAndCheck("https://foo/bar/", nullptr, ALLOW_EMPTY);
+    KJ_EXPECT(url.path.size() == 1);
+    KJ_EXPECT(url.hasTrailingSlash);
+  }
 }
 
 KJ_TEST("URL percent encoding") {

c++/src/kj/compat/url.c++

@@ -233,7 +233,8 @@ Maybe<Url> Url::tryParse(StringPtr text, Context context, Options options) {
         result.path.removeLast();
       }
       result.hasTrailingSlash = true;
-    } else if (part.size() == 0 || (part.size() == 1 && part[0] == '.')) {
+    } else if ((part.size() == 0 && (!options.allowEmpty || text.size() == 0)) ||
+               (part.size() == 1 && part[0] == '.')) {
       // Collapse consecutive slashes and "/./".
       result.hasTrailingSlash = true;
     } else {
@@ -247,7 +248,7 @@ Maybe<Url> Url::tryParse(StringPtr text, Context context, Options options) {
       text = text.slice(1);
       auto part = split(text, END_QUERY_PART);
 
-      if (part.size() > 0) {
+      if (part.size() > 0 || options.allowEmpty) {
         KJ_IF_MAYBE(key, trySplit(part, '=')) {
           result.query.add(QueryParam { percentDecodeQuery(*key, err, options),
                                         percentDecodeQuery(part, err, options) });
@@ -458,8 +459,8 @@ String Url::toString(Context context) const {
 
   for (auto& pathPart: path) {
     // Protect against path injection.
-    KJ_REQUIRE(pathPart != "" && pathPart != "." && pathPart != "..",
-               "invalid name in URL path", *this) {
+    KJ_REQUIRE((pathPart != "" || options.allowEmpty) && pathPart != "." && pathPart != "..",
+               "invalid name in URL path", path) {
       continue;
     }
     chars.add('/');

c++/src/kj/compat/url.h

@@ -37,6 +37,12 @@ struct UrlOptions {
   bool percentDecode = true;
   // True if URL components should be automatically percent-decoded during parsing, and
   // percent-encoded during serialization.
+
+  bool allowEmpty = false;
+  // Whether or not to allow empty path and query components when parsing; otherwise, they are
+  // silently removed. In other words, setting this false causes consecutive slashes in the path or
+  // consecutive ampersands in the query to be collapsed into one, whereas if true then they
+  // produce empty components.
 };
 
 struct Url {