defprotocol Ecto.DevLogger.PrintableParameter do @moduledoc """ A protocol to print various data structures as valid SQL expressions. `to_expression/1` is the main function and `to_string_literal/1` is an optional helper for it. `Ecto.DevLogger` tries to represent complex terms, like arrays (lists) and composite types (tuples) as string literal first. Not all terms are easy/efficient/whatever to represent as strings, so if `to_string_literal/1` returns a string for all elements inside the array, then array will be represented as string as well. Otherwise, array will be represented using `ARRAY` constructor: iex> Ecto.DevLogger.PrintableParameter.to_expression(["Elixir", "Ecto"]) "'{Elixir,Ecto}'" iex> Ecto.DevLogger.PrintableParameter.to_expression(["Elixir", "Ecto", <<153>>]) "ARRAY['Elixir','Ecto',DECODE('mQ==','BASE64')]" The same is true for composite types (tuples): iex> Ecto.DevLogger.PrintableParameter.to_expression({"Elixir", "Ecto"}) "'(Elixir,Ecto)'" iex> Ecto.DevLogger.PrintableParameter.to_expression({"Elixir", "Ecto", <<153>>}) "ROW('Elixir','Ecto',DECODE('mQ==','BASE64'))" """ @doc """ Converts term to a valid SQL expression. """ @spec to_expression(any()) :: String.t() def to_expression(term) @doc """ Converts term to a string literal. """ @spec to_string_literal(any()) :: String.t() | nil def to_string_literal(term) end defmodule Ecto.DevLogger.Utils do @moduledoc false def in_string_quotes(string) do "'#{String.replace(string, "'", "''")}'" end def all_to_string_literal(list) do result = Enum.reduce_while(list, {:ok, []}, fn element, {:ok, acc} -> case Ecto.DevLogger.PrintableParameter.to_string_literal(element) do nil -> {:halt, :error} string_literal -> {:cont, {:ok, [{element, string_literal} | acc]}} end end) with {:ok, list} <- result do {:ok, Enum.reverse(list)} end end end defimpl Ecto.DevLogger.PrintableParameter, for: Atom do def to_expression(nil), do: "NULL" def to_expression(true), do: "true" def to_expression(false), do: "false" def to_expression(atom), do: atom |> Atom.to_string() |> Ecto.DevLogger.Utils.in_string_quotes() def to_string_literal(nil), do: "NULL" def to_string_literal(true), do: "true" def to_string_literal(false), do: "false" def to_string_literal(atom), do: Atom.to_string(atom) end defimpl Ecto.DevLogger.PrintableParameter, for: Map do def to_expression(map), do: to_string_literal(map) def to_string_literal(map), do: Jason.encode!(map) end defimpl Ecto.DevLogger.PrintableParameter, for: Tuple do def to_expression(tuple) do case to_string_literal(tuple) do nil -> "ROW(" <> Enum.map_join( Tuple.to_list(tuple), ",", &Ecto.DevLogger.PrintableParameter.to_expression/1 ) <> ")" value -> Ecto.DevLogger.Utils.in_string_quotes(value) end end def to_string_literal(tuple) do case Ecto.DevLogger.Utils.all_to_string_literal(Tuple.to_list(tuple)) do :error -> nil {:ok, list} -> body = Enum.map_join(list, ",", fn {element, string_literal} -> case element do nil -> "" "" -> ~s|""| _ -> string = String.replace(string_literal, "\"", "\\\"") if String.contains?(string, [",", "(", ")"]) do ~s|"#{string}"| else string end end end) "(" <> body <> ")" end end end defimpl Ecto.DevLogger.PrintableParameter, for: Decimal do def to_expression(decimal), do: to_string_literal(decimal) def to_string_literal(decimal), do: Decimal.to_string(decimal) end defimpl Ecto.DevLogger.PrintableParameter, for: Integer do def to_expression(integer), do: to_string_literal(integer) def to_string_literal(integer), do: Integer.to_string(integer) end defimpl Ecto.DevLogger.PrintableParameter, for: Float do def to_expression(float), do: to_string_literal(float) def to_string_literal(float), do: Float.to_string(float) end defimpl Ecto.DevLogger.PrintableParameter, for: Date do def to_expression(date) do date |> to_string_literal() |> Ecto.DevLogger.Utils.in_string_quotes() end def to_string_literal(date), do: Date.to_string(date) end defimpl Ecto.DevLogger.PrintableParameter, for: DateTime do def to_expression(date_time) do date_time |> to_string_literal() |> Ecto.DevLogger.Utils.in_string_quotes() end def to_string_literal(date_time), do: DateTime.to_string(date_time) end defimpl Ecto.DevLogger.PrintableParameter, for: NaiveDateTime do def to_expression(naive_date_time) do naive_date_time |> to_string_literal() |> Ecto.DevLogger.Utils.in_string_quotes() end def to_string_literal(naive_date_time), do: NaiveDateTime.to_string(naive_date_time) end defimpl Ecto.DevLogger.PrintableParameter, for: Time do def to_expression(time) do time |> to_string_literal() |> Ecto.DevLogger.Utils.in_string_quotes() end def to_string_literal(time), do: Time.to_string(time) end defimpl Ecto.DevLogger.PrintableParameter, for: BitString do def to_expression(binary) do binary = maybe_convert_binary_uuid_to_string(binary) if String.valid?(binary) do Ecto.DevLogger.Utils.in_string_quotes(binary) else "DECODE('#{Base.encode64(binary)}','BASE64')" end end def to_string_literal(binary) do binary = maybe_convert_binary_uuid_to_string(binary) if String.valid?(binary) do binary end end defp maybe_convert_binary_uuid_to_string(binary) do with <<_::128>> <- binary, {:ok, string} <- Ecto.UUID.load(binary) do string else _ -> binary end end end defimpl Ecto.DevLogger.PrintableParameter, for: List do def to_expression(list) do case to_string_literal(list) do nil -> "ARRAY[" <> Enum.map_join(list, ",", &Ecto.DevLogger.PrintableParameter.to_expression/1) <> "]" value -> Ecto.DevLogger.Utils.in_string_quotes(value) end end def to_string_literal(list) do case Ecto.DevLogger.Utils.all_to_string_literal(list) do :error -> nil {:ok, list} -> body = Enum.map_join(list, ",", fn {element, string_literal} -> cond do is_list(element) or is_nil(element) -> string_literal element == "" -> ~s|""| true -> string = String.replace(string_literal, "\"", "\\\"") if String.downcase(string) == "null" or String.contains?(string, [",", "{", "}"]) do ~s|"#{string}"| else string end end end) "{" <> body <> "}" end end end if Code.ensure_loaded?(Postgrex.MACADDR) do defimpl Ecto.DevLogger.PrintableParameter, for: Postgrex.MACADDR do def to_expression(macaddr) do macaddr |> to_string_literal() |> Ecto.DevLogger.Utils.in_string_quotes() end def to_string_literal(macaddr) do macaddr.address |> Tuple.to_list() |> Enum.map_join(":", fn value -> value |> Integer.to_string(16) |> String.pad_leading(2, "0") end) end end end if Code.ensure_loaded?(Postgrex.INET) do defimpl Ecto.DevLogger.PrintableParameter, for: Postgrex.INET do def to_expression(inet) do inet |> to_string_literal() |> Ecto.DevLogger.Utils.in_string_quotes() end def to_string_literal(inet) do netmask = case inet.netmask do nil -> "" netmask -> "/#{netmask}" end "#{:inet.ntoa(inet.address)}#{netmask}" end end end