url.hpp

Go to the documentation of this file.

// Copyright (c) Microsoft Corporation. All rights reserved.
// SPDX-License-Identifier: MIT
 
#pragma once
 
#include "azure/core/case_insensitive_containers.hpp"
 
#include <cstdint>
#include <map>
#include <memory>
#include <string>
#include <unordered_set>
 
namespace Azure { namespace Core {
  namespace _detail {
    inline std::string FormatEncodedUrlQueryParameters(
        std::map<std::string, std::string> const& encodedQueryParameters)
    {
      {
        std::string queryStr;
        if (!encodedQueryParameters.empty())
        {
          auto separator = '?';
          for (const auto& q : encodedQueryParameters)
          {
            queryStr += separator + q.first + '=' + q.second;
            separator = '&';
          }
        }
 
        return queryStr;
      }
    }
  } // namespace _detail
 
  class Url final {
  private:
    std::string m_scheme;
    std::string m_host;
    uint16_t m_port{0};
    std::string m_encodedPath;
    // query parameters are all encoded
    std::map<std::string, std::string> m_encodedQueryParameters;
 
    // List of default non-URL-encode chars. While URL encoding a string, do not escape any chars in
    // this set.
    const static std::unordered_set<unsigned char> defaultNonUrlEncodeChars;
 
    std::string GetUrlWithoutQuery(bool relative) const;
 
    void AppendQueryParameters(const std::string& encodedQueryParameters);
 
  public:
    static std::string Decode(const std::string& value);
 
    static std::string Encode(const std::string& value, const std::string& doNotEncodeSymbols = "");
 
    Url() {}
 
    explicit Url(const std::string& encodedUrl);
 
    /************* Builder Url functions ****************/
    /******** API for building Url from scratch. Override state ********/
 
    void SetScheme(const std::string& scheme) { m_scheme = scheme; }
 
    void SetHost(const std::string& encodedHost) { m_host = encodedHost; }
 
    void SetPort(uint16_t port) { m_port = port; }
 
    void SetPath(const std::string& encodedPath) { m_encodedPath = encodedPath; }
 
    void SetQueryParameters(std::map<std::string, std::string> queryParameters)
    {
      // creates a copy and discard previous
      m_encodedQueryParameters = std::move(queryParameters);
    }
 
    // ===== APIs for mutating URL state: ======
 
    void AppendPath(const std::string& encodedPath)
    {
      if (!m_encodedPath.empty() && m_encodedPath.back() != '/')
      {
        m_encodedPath += '/';
      }
      m_encodedPath += encodedPath;
    }
 
    void AppendQueryParameter(const std::string& encodedKey, const std::string& encodedValue)
    {
      m_encodedQueryParameters[encodedKey] = encodedValue;
    }
 
    void RemoveQueryParameter(const std::string& encodedKey)
    {
      m_encodedQueryParameters.erase(encodedKey);
    }
 
    /************** API to read values from Url ***************/
    const std::string& GetHost() const { return m_host; }
 
    const std::string& GetPath() const { return m_encodedPath; }
 
    uint16_t GetPort() const { return m_port; }
 
    std::map<std::string, std::string> GetQueryParameters() const
    {
      return m_encodedQueryParameters;
    }
 
    const std::string& GetScheme() const { return m_scheme; }
 
    std::string GetRelativeUrl() const;
 
    std::string GetAbsoluteUrl() const;
  };
}} // namespace Azure::Core