defmodule Chesstrainer.Endgames.Endgame do @moduledoc """ A singular endgame entry """ use Ecto.Schema import Ecto.Changeset alias Chesstrainer.Key @public_code_alphabet ~c"0123456789abcdefghjkmnpqrstvwxyz" @public_code_length 10 @primary_key {:id, :binary_id, autogenerate: true} @foreign_key_type :binary_id schema "endgames" do field :public_code, :string field :fen, :string field :color, Ecto.Enum, values: [:white, :black] field :key, :string field :message, :string field :notes, :string field :result, Ecto.Enum, values: [:win, :loss, :draw] field :rating, :float, default: 1500.0 field :rating_deviation, :float, default: 350.0 field :times_attempted, :integer field :times_solved, :integer many_to_many :themes, Chesstrainer.Themes.Theme, join_through: "endgames_themes", on_replace: :delete timestamps(type: :utc_datetime) end @doc false def changeset(endgame, attrs) do endgame |> cast(normalize_attrs(attrs), [:fen, :message, :notes, :result, :rating, :color]) |> validate_required([:fen, :color], message: "Invalid FEN") |> validate_required([:result, :rating]) |> validate_change(:fen, fn :fen, fen -> case fen_issues(fen) do [] -> [] issues -> [fen: "is not a valid FEN: #{Enum.join(issues, "; ")}"] end end) |> unique_constraint(:fen, message: "FEN already exists") |> unique_constraint(:public_code) |> put_key() |> put_public_code() end @doc """ Generates a public code: a short, random identifier for player-facing URLs. 10 characters of Crockford base32 (no `i`, `l`, `o` or `u`) give roughly 50 bits, so collisions are vanishingly rare; the unique index is the backstop. """ @spec generate_public_code() :: String.t() def generate_public_code do @public_code_length |> :crypto.strong_rand_bytes() |> :binary.bin_to_list() |> Enum.map(fn byte -> Enum.at(@public_code_alphabet, rem(byte, length(@public_code_alphabet))) end) |> List.to_string() end defp put_public_code(changeset) do case get_field(changeset, :public_code) do nil -> put_change(changeset, :public_code, generate_public_code()) _ -> changeset end end defp put_key(changeset) do case Key.from_fen(get_field(changeset, :fen)) do {:ok, key} -> put_change(changeset, :key, key) {:error, :invalid_fen} -> changeset end end defp normalize_attrs(%{"fen" => fen} = attrs) when is_binary(fen), do: Map.put(attrs, "fen", Chesstrainer.FEN.normalize(fen)) defp normalize_attrs(%{fen: fen} = attrs) when is_binary(fen), do: Map.put(attrs, :fen, Chesstrainer.FEN.normalize(fen)) defp normalize_attrs(attrs), do: attrs @doc """ Returns the structural problems with a FEN, or `[]` when it is well formed. Strict structural validation. Mirrors chess.js rules so the FEN survives both the server-side parser (Chex, permissive) and the client-side parser (chess.js, strict). Used by the admin bulk importer to explain why a line was rejected. """ def fen_issues(fen) do case String.split(fen, " ") do [board, active, _castling, _en_passant, halfmove, fullmove] -> board_valid? = valid_board?(board) pieces = Chesstrainer.FEN.piece_count(fen) issues = [] issues = if board_valid?, do: issues, else: issues ++ ["board must be 8 ranks of 8 squares each"] issues = if active in ["w", "b"], do: issues, else: issues ++ ["active color must be 'w' or 'b'"] issues = if non_negative_integer?(halfmove), do: issues, else: issues ++ ["halfmove clock must be a non-negative integer"] issues = if positive_integer?(fullmove), do: issues, else: issues ++ ["fullmove number must be a positive integer"] issues = if board_valid? and is_integer(pieces) and pieces > 7, do: issues ++ ["positions with more than 7 pieces are not covered by tablebases"], else: issues issues _ -> ["must have 6 space-separated fields"] end end defp valid_board?(board) do ranks = String.split(board, "/") length(ranks) == 8 and Enum.all?(ranks, &valid_rank?/1) end defp valid_rank?(rank) do squares = rank |> String.graphemes() |> Enum.reduce(0, fn g, acc when byte_size(g) == 1 -> c = :binary.first(g) if c >= ?1 and c <= ?8 do acc + (c - ?0) else acc + 1 end end) squares == 8 end defp non_negative_integer?(str), do: integer_string?(str) and String.to_integer(str) >= 0 defp positive_integer?(str), do: integer_string?(str) and String.to_integer(str) >= 1 defp integer_string?(str) do Regex.match?(~r/^[0-9]+$/, str) end end