iptools

defmodule Iptools do
  @external_resource "README.md"
  @moduledoc "README.md"
             |> File.read!()
             |> String.split("<!-- MDOC !-->")
             |> Enum.fetch!(1)

  @rfc1918_ranges [
    {"10.0.0.0", "10.255.255.255"},
    {"192.168.0.0", "192.168.255.255"},
    {"172.16.0.0", "172.31.255.255"}
  ]

  @other_reserved_ranges [
    {"0.0.0.0", "0.255.255.255"},
    {"100.64.0.0", "100.127.255.255"},
    {"127.0.0.0", "127.255.255.255"},
    {"169.254.0.0", "169.254.255.255"},
    {"192.0.0.0", "192.0.0.255"},
    {"192.0.2.0", "192.0.2.255"},
    {"192.88.99.0", "192.88.99.255"},
    {"198.18.0.0", "198.19.255.255"},
    {"198.51.100.0", "198.51.100.255"},
    {"203.0.113.0", "203.0.113.255"},
    {"224.0.0.0", "255.255.255.255"}
  ]

  @ipv4_regex ~r/^([1-2]?[0-9]{1,2}\.){3}([1-2]?[0-9]{1,2})$/

  @doc """
  Converts a dotted-decimal notation IPv4 string to a list of strings.

  Example input: `"10.0.0.1"`
  Example output: `["10", "0", "0", "1"]`
  """
  @spec to_str_list(String.t()) :: [String.t()]
  def to_str_list(ip) do
    String.split(ip, ".") # ["10", "0", "0", "1"]
  end

  @doc """
  Converts a dotted-decimal notation IPv4 string to a list of integers.

  Example input: `"10.0.0.1"`
  Example output: `[10, 0, 0, 1]`
  """
  @spec to_int_list(String.t()) :: [integer()]
  def to_int_list(ip) do
    ip
    |> to_str_list()
    |> Enum.map(fn s -> String.to_integer(s) end)
  end

  @doc deprecated: "Replaced by `to_int_list/1`"
  @spec to_list(String.t()) :: [integer()]
  def to_list(ip), do: to_int_list(ip)

  @doc """
  Checks if the given string is an IPv4 address in dotted-decimal notation.
  """
  @spec is_ipv4?(String.t() | nil) :: boolean()
  def is_ipv4?(nil), do: false
  def is_ipv4?(ip) do
    case Regex.match?(@ipv4_regex, ip) do
      false ->
        false

      true ->
        ip
        |> to_str_list()
        |> Enum.all?(fn s -> between?(s, 0, 255) && no_leading_zero?(s) end)
    end
  end

  @doc """
  You probably want to use `is_reserved?/1`.

  Determine if an IP address is an RFC1918 address. Reserved for local
  communications within a private network as specified by RFC 1918.

  Returns true if it is an RFC1918 address.
  """
  @spec is_rfc1918?(String.t() | nil) :: boolean()
  def is_rfc1918?(nil), do: false
  def is_rfc1918?(ip) do
    @rfc1918_ranges
    |> Enum.any?(fn {low, high} -> is_between?(ip, low, high) end)
  end

  @doc """
  Checks to see if an IP address is reserved for special purposes.

  This includes all of the RFC 1918 addresses as well as other blocks that are
  reserved by IETF, and IANA for various reasons.

  See https://en.wikipedia.org/wiki/Reserved_IP_addresses
  """
  @spec is_reserved?(String.t() | nil) :: boolean()
  def is_reserved?(nil), do: false
  def is_reserved?(ip) do
    case is_rfc1918?(ip) do
      true ->
        true

      false ->
        @other_reserved_ranges |> Enum.any?(fn {low, high} -> is_between?(ip, low, high) end)
    end
  end

  @doc """
  Convert an IP address represented as a dotted-decimal string to an integer.
  """
  @spec to_integer(String.t()) :: integer()
  def to_integer(ip) do
    # Example input "10.0.0.1"
    ip
    |> to_int_list() # [10,0,0,1]
    |> Enum.zip([3, 2, 1, 0]) #[{10,3}, {0,2}, {0,1}, {1,0}]
    |> Enum.reduce(0, fn({value, exponent}, acc) -> acc + (value * :math.pow(256, exponent)) end) # 167772161.0
    |> round #167772161
  end

  @doc """
  Checks if a given IP address is between two other IP addresses (inclusive).

  If the given ip equals either of the other two IP addresses then it returns
  true.
  """
  @spec is_between?(String.t(), String.t(), String.t()) :: boolean()
  def is_between?(ip, low, high) do
    ip_int = to_integer(ip)
    low_int = to_integer(low)
    high_int = to_integer(high)
    min(low_int, high_int) <= ip_int && ip_int <= max(low_int, high_int)
  end

  @doc """
  Changes a subnet mask to a binary representation. E.g. `255.0.0.0`
  becomes `11111111000000000000000000000000`.
  """
  @spec subnet_bit_string(String.t()) :: String.t()
  def subnet_bit_string(mask) do
    # Example input "255.255.0.0"
    mask
    |> to_integer # 4294901760
    |> Integer.to_string(2) # "11111111111111110000000000000000"

  end

  @doc """
  Counts the bits in a subnet mask. E.g. `255.0.0.0` becomes `8`.
  """
  @spec subnet_bit_count(String.t()) :: integer()
  def subnet_bit_count(mask) do
    # Example input "255.255.0.0"
    mask
    |> subnet_bit_string # "11111111111111110000000000000000"
    |> String.split("") # ["1", "1", "1", "1", "1", "1", etc ...
    |> Enum.count(fn x -> x == "1" end) #16
  end

  @doc """
  Returns an IP address as a tuple of integers. Useful for passing to Erlang
  functions like :gen_tcp

  ## Examples

      iex> Iptools.parse_ipv4_address("127.0.0.1")
      {127.0.0.1}

      iex> Iptools.parse_ipv4_address("invalid")
      {:error, :einval}

  """
  @spec parse_ipv4_address(String.t()) :: ({integer(), integer(), integer(), integer()} | {:error, :einval})
  def parse_ipv4_address(ip) do
    case :inet.parse_ipv4_address(:erlang.binary_to_list(ip)) do
      {:ok, result} -> result
      some_error -> some_error
    end
  end

  @spec between?(String.t(), integer(), integer()) :: boolean()
  defp between?(num, first, last) do
    n = String.to_integer(num)
    n >= first && n <= last
  end

  @spec leading_zero?(String.t()) :: boolean()
  defp leading_zero?(num), do: not canonical?(num)

  @spec to_canonical(String.t()) :: String.t()
  defp to_canonical(int) do
    int |> String.to_integer() |> Integer.to_string()
  end

  @spec canonical?(String.t()) :: boolean()
  defp canonical?(int), do: int == to_canonical(int)

  @spec no_leading_zero?(String.t()) :: boolean()
  defp no_leading_zero?(str), do: not leading_zero?(str)
end