Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CondaURL::pretty_str #2830

Merged
merged 3 commits into from
Sep 15, 2023
Merged

Add CondaURL::pretty_str #2830

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6f8c384
Add CondaURL::pretty_str
AntoinePrv Sep 13, 2023
588dc1c
Please our MSVC overlords
AntoinePrv Sep 13, 2023
0d4c975
Add missing functions to CondaURL
AntoinePrv Sep 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 35 additions & 7 deletions libmamba/include/mamba/specs/conda_url.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,19 @@ namespace mamba::specs

public:

using Base::StripScheme;
using Base::HidePassword;
using Base::Encode;
using Base::Decode;
using StripScheme = util::detail::StripScheme;
using HideConfidential = util::detail::HideConfidential;
using Encode = util::detail::Encode;
using Decode = util::detail::Decode;

using Base::https;
using Base::localhost;
inline static constexpr std::string_view token_prefix = "/t/";

[[nodiscard]] static auto parse(std::string_view url) -> CondaURL;

/** Create a local URL. */
CondaURL() = default;
explicit CondaURL(util::URL&& url);
explicit CondaURL(const util::URL& url);

using Base::scheme;
using Base::set_scheme;
Expand All @@ -51,6 +51,7 @@ namespace mamba::specs
using Base::clear_port;
using Base::authority;
using Base::path;
using Base::pretty_path;
using Base::set_path;
using Base::clear_path;
using Base::append_path;
Expand Down Expand Up @@ -132,10 +133,37 @@ namespace mamba::specs
/** Clear the package and return true if it exists, otherwise return ``false``. */
auto clear_package() -> bool;

using Base::str;

/**
* Return the full decoded url.
*
* Due to decoding, the outcome may not be understood by parser and usable to reach an
* asset.
* @param strip_scheme If true, remove the scheme and "localhost" on file URI.
* @param rstrip_path If non-null, remove the given charaters at the end of the path.
* @param hide_confidential If true, hide password and tokens in the decoded string.
*/
[[nodiscard]] auto pretty_str(
StripScheme strip_scheme = StripScheme::no,
char rstrip_path = 0,
HideConfidential hide_confidential = HideConfidential::no
) const -> std::string;


private:

explicit CondaURL(URL&& url);
void set_platform_no_check_input(std::string_view platform);

friend auto operator==(const CondaURL&, const CondaURL&) -> bool;
};

/** Compare two CondaURL. */
auto operator==(const CondaURL& a, const CondaURL& b) -> bool;
auto operator!=(const CondaURL& a, const CondaURL& b) -> bool;

/** A functional equivalent to ``CondaURL::append_path``. */
auto operator/(const CondaURL& url, std::string_view subpath) -> CondaURL;
auto operator/(CondaURL&& url, std::string_view subpath) -> CondaURL;
}
#endif
65 changes: 49 additions & 16 deletions libmamba/include/mamba/util/url.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,43 @@

namespace mamba::util
{
namespace detail
{
// Working around MSVC limitation on private inheritance + using directive
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you detail the limitations? I never had any issue with using private inheritance + using directive on Windows, so this must be specific to some uses.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It works for methods but not dependent types.

class URL {
public:
    enum class StripScheme : bool { no, yes };
};

class CondaURL : private URL {
public:
    using URL::StripScheme;
};

void f() {
    CondaURL::StripScheme strip = {};  // Compile error: private field of URL
}

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or maybe I missed somthing...


enum class StripScheme : bool
{
no,
yes
};

enum class HideConfidential : bool
{
no,
yes
};

struct Encode
{
inline static constexpr struct yes_type
{
} yes = {};
inline static constexpr struct no_type
{
} no = {};
};

struct Decode
{
inline static constexpr struct yes_type
{
} yes = {};
inline static constexpr struct no_type
{
} no = {};
};
}

/**
* Class representing a URL.
*
Expand All @@ -21,20 +58,10 @@ namespace mamba::util
{
public:

// clang-format off
enum class StripScheme : bool { no, yes };
enum class HidePassword : bool { no, yes };
struct Encode
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are the limitations mentionned above due to inner types?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes

{
inline static constexpr struct yes_type {} yes = {};
inline static constexpr struct no_type {} no = {};
};
struct Decode
{
inline static constexpr struct yes_type {} yes = {};
inline static constexpr struct no_type {} no = {};
};
// clang-format on
using StripScheme = detail::StripScheme;
using HideConfidential = detail::HideConfidential;
using Encode = detail::Encode;
using Decode = detail::Decode;

inline static constexpr std::string_view https = "https";
inline static constexpr std::string_view localhost = "localhost";
Expand Down Expand Up @@ -197,14 +224,20 @@ namespace mamba::util
* asset.
* @param strip_scheme If true, remove the scheme and "localhost" on file URI.
* @param rstrip_path If non-null, remove the given charaters at the end of the path.
* @param hide_password If true, hide password in the decoded string.
* @param hide_confidential If true, hide password in the decoded string.
*/
[[nodiscard]] auto pretty_str(
StripScheme strip_scheme = StripScheme::no,
char rstrip_path = 0,
HidePassword hide_password = HidePassword::no
HideConfidential hide_confidential = HideConfidential::no
) const -> std::string;

protected:

[[nodiscard]] auto
pretty_str_path(StripScheme strip_scheme = StripScheme::no, char rstrip_path = 0) const
-> std::string;

private:

std::string m_scheme = std::string(https);
Expand Down
80 changes: 77 additions & 3 deletions libmamba/src/specs/conda_url.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,11 @@ namespace mamba::specs
{
}

CondaURL::CondaURL(const util::URL& url)
: CondaURL(URL(url))
{
}

auto CondaURL::parse(std::string_view url) -> CondaURL
{
return CondaURL(URL::parse(url));
Expand All @@ -98,6 +103,23 @@ namespace mamba::specs
return std::string_view(l_path).substr(pos + token_prefix.size(), token_len);
}

namespace
{
void set_token_no_check_input_impl(
std::string& path,
std::size_t pos,
std::size_t len,
std::string_view token
)
{
static constexpr auto npos = std::string_view::npos;

assert(CondaURL::token_prefix.size() < len);
const auto token_len = (len != npos) ? len - CondaURL::token_prefix.size() : npos;
path.replace(pos + CondaURL::token_prefix.size(), token_len, token);
}
}

void CondaURL::set_token(std::string_view token)
{
static constexpr auto npos = std::string_view::npos;
Expand All @@ -113,10 +135,8 @@ namespace mamba::specs
fmt::format(R"(No token template in orignial path "{}")", path(Decode::no))
);
}
assert(token_prefix.size() < len);
std::string l_path = clear_path(); // percent encoded
const auto token_len = (len != npos) ? len - token_prefix.size() : npos;
l_path.replace(pos + token_prefix.size(), token_len, token);
set_token_no_check_input_impl(l_path, pos, len, token);
set_path(std::move(l_path), Encode::no);
}

Expand Down Expand Up @@ -284,4 +304,58 @@ namespace mamba::specs
}
return false;
}

auto
CondaURL::pretty_str(StripScheme strip_scheme, char rstrip_path, HideConfidential hide_confifential) const
-> std::string
{
std::string computed_path = pretty_str_path(strip_scheme, rstrip_path);

if (hide_confifential == HideConfidential::yes)
{
const auto [pos, len] = find_token_and_prefix(computed_path);
if ((pos < std::string::npos) && (len > 0))
{
set_token_no_check_input_impl(computed_path, pos, len, "*****");
}
}

return util::concat(
(strip_scheme == StripScheme::no) ? scheme() : "",
(strip_scheme == StripScheme::no) ? "://" : "",
user(Decode::yes),
password(Decode::no).empty() ? "" : ":",
(hide_confifential == HideConfidential::no) ? password(Decode::yes) : "*****",
user(Decode::no).empty() ? "" : "@",
host(Decode::yes),
port().empty() ? "" : ":",
port(),
computed_path,
query().empty() ? "" : "?",
query(),
fragment().empty() ? "" : "#",
fragment()
);
}

auto operator==(const CondaURL& a, const CondaURL& b) -> bool
{
return static_cast<const util::URL&>(a) == static_cast<const util::URL&>(b);
}

auto operator!=(const CondaURL& a, const CondaURL& b) -> bool
{
return !(a == b);
}

auto operator/(const CondaURL& url, std::string_view subpath) -> CondaURL
{
return CondaURL(url) / subpath;
}

auto operator/(CondaURL&& url, std::string_view subpath) -> CondaURL
{
url.append_path(subpath);
return std::move(url);
}
}
13 changes: 9 additions & 4 deletions libmamba/src/util/url.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -484,8 +484,7 @@ namespace mamba::util
);
}

auto URL::pretty_str(StripScheme strip_scheme, char rstrip_path, HidePassword hide_password) const
-> std::string
auto URL::pretty_str_path(StripScheme strip_scheme, char rstrip_path) const -> std::string
{
std::string computed_path = {};
// When stripping file scheme, not showing leading '/' for Windows path with drive
Expand All @@ -498,18 +497,24 @@ namespace mamba::util
computed_path = path(Decode::yes);
}
computed_path = util::rstrip(computed_path, rstrip_path);
return computed_path;
}

auto
URL::pretty_str(StripScheme strip_scheme, char rstrip_path, HideConfidential hide_confidential) const
-> std::string
{
return util::concat(
(strip_scheme == StripScheme::no) ? m_scheme : "",
(strip_scheme == StripScheme::no) ? "://" : "",
user(Decode::yes),
m_password.empty() ? "" : ":",
(hide_password == HidePassword::no) ? password(Decode::yes) : "*****",
(hide_confidential == HideConfidential::no) ? password(Decode::yes) : "*****",
m_user.empty() ? "" : "@",
host(Decode::yes),
m_port.empty() ? "" : ":",
m_port,
computed_path,
pretty_str_path(strip_scheme, rstrip_path),
m_query.empty() ? "" : "?",
m_query,
m_fragment.empty() ? "" : "#",
Expand Down
Loading