path: root/tests/url/driver.cxx

// file      : tests/url/driver.cxx -*- C++ -*-
// license   : MIT; see accompanying LICENSE file

#ifndef __cpp_lib_modules_ts
#include <string>
#include <utility>   // move()
#include <iostream>
#include <iterator>  // back_inserter
#include <stdexcept> // invalid_argument
#endif

// Other includes.

#ifdef __cpp_modules_ts
#ifdef __cpp_lib_modules_ts
import std.core;
import std.io;
#endif
import butl.url;
import butl.utility; // operator<<(ostream, exception)
#else
#include <libbutl/url.mxx>
#include <libbutl/utility.mxx>
#endif

#undef NDEBUG
#include <cassert>

using namespace std;
using namespace butl;

enum class scheme
{
  http,
  https,
  file,
  pkcs11
};

namespace butl
{
  template <>
  struct url_traits<scheme>
  {
    using string_type = wstring;
    using path_type   = wstring;

    using scheme_type    = scheme;
    using authority_type = basic_url_authority<string_type>;

    static optional<scheme_type>
    translate_scheme (const string_type&         url,
                      string_type&&              scheme,
                      optional<authority_type>&  authority,
                      optional<path_type>&       path,
                      optional<string_type>&     query,
                      optional<string_type>&     /*fragment*/,
                      bool&                      rootless)
    {
      if (scheme.empty ())
      {
        // If the URL looks like an absolute filesystem path, then translate it
        // to the file URL. If it is not, then return nullopt to fail with a
        // proper exception description.
        //
        wchar_t c;
        if ((c = url[0]) == '/' ||
            (url.size () > 2 && alpha (c) && url[1] == ':' && url[2] == '/'))
        {
          path = url;
          rootless = false;
          return scheme_type::file;
        }

        return nullopt;
      }

      scheme_type t;

      // Note that we must compare case-insensitive in the real program.
      //
      if (scheme == L"http")
        t = scheme_type::http;
      else if (scheme == L"https")
        t = scheme_type::https;
      else if (scheme == L"file")
        t = scheme_type::file;
      else if (scheme == L"pkcs11")
        t = scheme_type::pkcs11;
      else
        throw invalid_argument ("unknown scheme");

      if (t != scheme_type::pkcs11 && !authority && !path && !query)
        throw invalid_argument ("no authority, path or query");

      if (path)
      {
        if (t == scheme_type::pkcs11)
        {
          if (!rootless || path->find (L'/') != string_type::npos)
            throw invalid_argument ("unexpected slash");
        }
        else if (rootless)
          throw invalid_argument ("rootless path");
      }

      return t;
    }

    // Translate scheme type back to its string representation.
    //
    static string_type
    translate_scheme (string_type&,                    /*url*/
                      const scheme_type& scheme,
                      const optional<authority_type>&  /*authority*/,
                      const optional<path_type>&       /*path*/,
                      const optional<string_type>&     /*query*/,
                      const optional<string_type>&     /*fragment*/,
                      bool                             /*rootless*/)
    {
      switch (scheme)
      {
      case scheme_type::http:   return L"http";
      case scheme_type::https:  return L"https";
      case scheme_type::file:   return L"file";
      case scheme_type::pkcs11: return L"pkcs11";
      }

      assert (false); // Can't be here.
      return L"";
    }

    static path_type
    translate_path (string_type&& path)
    {
      // Note that a real pkcs11-supporting URL most likely would keep the
      // path URL-encoded as its components can contain binary data. Or, it
      // would split the path into components before decoding them.
      //
      return path_type (basic_url<string_type>::decode (path));
    }

    static string_type
    translate_path (const path_type& path)
    {
      using url = basic_url<string_type>;
      return url::encode (path, [] (wchar_t& c) {return !url::path_char (c);});
    }
  };
}

// Usages:
//
// argv[0]
// argv[0] [-c|-s|-w] [-n] <url>
//
// Perform some basic tests if no URL is provided. Otherwise round-trip the URL
// to STDOUT. URL must contain only ASCII characters. Exit with zero code on
// success. Exit with code one on parsing failure, printing error description
// to STDERR.
//
// -c
//    Print the URL components one per line. Print the special '<null>' string
//    for an absent components. This is the default option if URL is provided.
//
// -s
//    Print stringified url object representation.
//
// -w
//    Same as above, but use the custom wstring-based url_traits
//    implementation for the basic_url template.
//
// -n
//    Normalize the URL.
//
int
main (int argc, const char* argv[])
try
{
  using butl::nullopt; // Disambiguate with std::nullopt.

  using wurl           = basic_url<scheme>;
  using wurl_authority = wurl::authority_type;
  using wurl_host      = wurl::host_type;

  enum class print_mode
  {
    str,
    wstr,
    comp
  } mode (print_mode::comp);

  bool norm (false);

  int i (1);
  for (; i != argc; ++i)
  {
    string o (argv[i]);
    if (o == "-s")
      mode = print_mode::str;
    else if (o == "-w")
      mode = print_mode::wstr;
    else if (o == "-c")
      mode = print_mode::comp;
    else if (o == "-n")
      norm = true;
    else
      break; // End of options.
  }

  if (i == argc)
  {
    // Test ctors and operators.
    //
    {
      wurl u0;
      assert (u0.empty ());

      wurl u1 (scheme::http,
               wurl_authority {wstring (), wurl_host (L"[::123]"), 0},
               wstring (L"login"),
               wstring (L"q="),
               wstring (L"f"));

      u1.normalize ();

      assert (!u1.empty ());
      assert (u1 != u0);

      wurl u2 (scheme::http,
               wurl_host (L"::123", url_host_kind::ipv6),
               wstring (L"login"),
               wstring (L"q="),
               wstring (L"f"));

      assert (u2 == u1);

      wurl u3 (scheme::http,
               wurl_host (L"::123", url_host_kind::ipv6),
               0,
               wstring (L"login"),
               wstring (L"q="),
               wstring (L"f"));

      u3.normalize ();

      assert (u3 == u2);

      wurl u4 (scheme::http,
               L"[::123]",
               wstring (L"login"),
               wstring (L"q="),
               wstring (L"f"));

      assert (u4 == u3);

      wurl u5 (scheme::http,
               L"[::123]",
               0,
               wstring (L"login"),
               wstring (L"q="),
               wstring (L"f"));

      assert (u5 == u4);
    }

    // Test encode and decode.
    //
    {
      const char* s ("ABC +");
      string es (url::encode (s));

      assert (es == "ABC%20%2B");
      string ds (url::decode (es));

      assert (ds == s);
    }

    {
      const char* s ("ABC +");

      string es (url::encode (s,
                              [] (char& c) -> bool
                              {
                                if (c == ' ')
                                {
                                  c = '+';
                                  return false;
                                }
                                return !url::unreserved (c);
                              }));

      assert (es == "ABC+%2B");

      string ds (url::decode (es.c_str (),
                              [] (char& c)
                              {
                                if (c == '+')
                                  c = ' ';
                              }));
      assert (ds == s);
    }
    {
      const wchar_t s[] = L"ABC ";

      wstring es;
      wurl::encode (s, s + 4,
                    back_inserter (es),
                    [] (wchar_t& c) -> bool
                    {
                      if (!alnum (c))
                        return true;

                      ++c;
                      return false;
                    });
      assert (es == L"BCD%20");

      wstring ds (wurl::decode (es,
                                [] (wchar_t& c)
                                {
                                  if (alnum (c))
                                    --c;
                                }));
      assert (ds == s);
    }
  }
  else // Round-trip the URL.
  {
    assert (i + 1 == argc);

    const char* ua (argv[i]);

    switch (mode)
    {
    case print_mode::str:
      {
        url u;
        if (*ua != '\0')
          u = url (ua);

        if (norm)
          u.normalize ();

        cout << u << endl;
        break;
      }
    case print_mode::wstr:
      {
        wurl u;

        // Convert ASCII string to wstring.
        //
        wstring s (ua, ua + strlen (ua));

        if (!s.empty ())
          u = wurl (s);

        if (norm)
          u.normalize ();

        wcout << u << endl;
        break;
      }
    case print_mode::comp:
      {
        // Convert ASCII string to wstring.
        //
        wstring s (ua, ua + strlen (ua));

        wurl u;
        if (!s.empty ())
          u = wurl (s);

        if (norm)
          u.normalize ();

        if (!u.empty ())
        {
          wstring s;
          wcout << wurl::traits_type::translate_scheme (s,
                                                        u.scheme,
                                                        nullopt,
                                                        nullopt,
                                                        nullopt,
                                                        nullopt,
                                                        false) << endl;
        }
        else
          wcout << L"<null>" << endl;

        if (u.authority)
        {
          const wchar_t* kinds[] = {L"ipv4", L"ipv6", L"name"};
          const wurl_authority& a (*u.authority);

          wcout << a.user << L'@' << a.host.value << L':' << a.port
                << " " << kinds[static_cast<size_t> (a.host.kind)] << endl;
        }
        else
          wcout << L"<null>" << endl;

        wcout << (u.path     ? *u.path     : L"<null>") << endl
              << (u.query    ? *u.query    : L"<null>") << endl
              << (u.fragment ? *u.fragment : L"<null>") << endl;
        break;
      }
    }
  }

  return 0;
}
catch (const invalid_argument& e)
{
  cerr << e << endl;
  return 1;
}