/**
 * @file src/network.h
 * @brief Declarations for networking related functions.
 */
#pragma once

// standard includes
#include <tuple>
#include <utility>

// lib includes
#include <boost/asio.hpp>
#include <enet/enet.h>

// local includes
#include "utility.h"

namespace net {
  /**
   * @brief Destroy an ENet host allocated by host_create().
   *
   * @param host Host name or address to resolve.
   */
  void free_host(ENetHost *host);

  /**
   * @brief Map a specified port based on the base port.
   * @param port The port to map as a difference from the base port.
   * @return The mapped port number.
   * @examples
   * std::uint16_t mapped_port = net::map_port(1);
   * @examples_end
   * @todo Ensure port is not already in use by another application.
   */
  std::uint16_t map_port(int port);

  /**
   * @brief Owning ENet host pointer released with `enet_host_destroy`.
   */
  using host_t = util::safe_ptr<ENetHost, free_host>;
  /**
   * @brief Raw ENet peer handle owned by an ENet host.
   */
  using peer_t = ENetPeer *;
  /**
   * @brief Owning ENet packet pointer released with `enet_packet_destroy`.
   */
  using packet_t = util::safe_ptr<ENetPacket, enet_packet_destroy>;

  /**
   * @brief Enumerates supported net options.
   */
  enum net_e : int {
    PC,  ///< PC
    LAN,  ///< LAN
    WAN  ///< WAN
  };

  /**
   * @brief Enumerates supported af options.
   */
  enum af_e : int {
    IPV4,  ///< IPv4 only
    BOTH  ///< IPv4 and IPv6
  };

  /**
   * @brief Convert configuration text to a network enum value.
   *
   * @param view Boost.Log record view being formatted.
   * @return Value converted from enum string.
   */
  net_e from_enum_string(const std::string_view &view);
  /**
   * @brief Convert a network enum value to configuration text.
   *
   * @param net Network scope to convert or format.
   * @return Value converted to enum string.
   */
  std::string_view to_enum_string(net_e net);

  /**
   * @brief Convert a Boost address family to Sunshine network enum value.
   *
   * @param view Boost.Log record view being formatted.
   * @return Value converted from address.
   */
  net_e from_address(const std::string_view &view);

  /**
   * @brief Create an ENet host with the requested address family.
   *
   * @param af Address family used for socket creation or binding.
   * @param addr Network address to bind, parse, or format.
   * @param port TCP or UDP port number.
   * @return ENet host bound to the requested address and port, or an empty handle on failure.
   */
  host_t host_create(af_e af, ENetAddress &addr, std::uint16_t port);

  /**
   * @brief Convert a config address-family string to the matching enum.
   * @param view The config option value.
   * @return Address-family enum represented by the string.
   */
  af_e af_from_enum_string(const std::string_view &view);

  /**
   * @brief Get the wildcard binding address for a given address family.
   * @param af Address family.
   * @return Normalized address.
   */
  std::string_view af_to_any_address_string(af_e af);

  /**
   * @brief Get the binding address to use based on config.
   * @param af Address family.
   * @return The configured bind address or wildcard if not configured.
   */
  std::string get_bind_address(af_e af);

  /**
   * @brief Convert an address to a normalized form.
   * @details Normalization converts IPv4-mapped IPv6 addresses into IPv4 addresses.
   * @param address The address to normalize.
   * @return Normalized address.
   */
  boost::asio::ip::address normalize_address(boost::asio::ip::address address);

  /**
   * @brief Get the given address in normalized string form.
   * @details Normalization converts IPv4-mapped IPv6 addresses into IPv4 addresses.
   * @param address The address to normalize.
   * @return Normalized address in string form.
   */
  std::string addr_to_normalized_string(boost::asio::ip::address address);

  /**
   * @brief Get the given address in a normalized form for the host portion of a URL.
   * @details Normalization converts IPv4-mapped IPv6 addresses into IPv4 addresses.
   * @param address The address to normalize and escape.
   * @return Normalized address in URL-escaped string.
   */
  std::string addr_to_url_escaped_string(boost::asio::ip::address address);

  /**
   * @brief Get the encryption mode for the given remote endpoint address.
   * @param address The address used to look up the desired encryption mode.
   * @return The WAN or LAN encryption mode, based on the provided address.
   */
  int encryption_mode_for_address(boost::asio::ip::address address);

  /**
   * @brief Returns a string for use as the instance name for mDNS.
   * @param hostname The hostname to use for instance name generation.
   * @return Hostname-based instance name or "Sunshine" if hostname is invalid.
   */
  std::string mdns_instance_name(const std::string_view &hostname);
}  // namespace net