Add basic support for CHATHISTORY LATEST

Just enough for Goguma to work

Author: progval

lib/irc/handler.ex

@@ -931,14 +931,28 @@ defmodule M51.IrcConn.Handler do
           ]
         })
 
-      {"CHATHISTORY", ["LATEST", _target, _anchor | _]} ->
+      {"CHATHISTORY", ["LATEST", target, "*", limit | _]} ->
+        limit = String.to_integer(limit)
+
+        case M51.MatrixClient.ChatHistory.latest(sup_pid, target, limit) do
+          {:ok, messages} ->
+            send_batch.(messages, "chathistory")
+
+          {:error, message} ->
+            send.(%M51.Irc.Command{
+              command: "FAIL",
+              params: ["CHATHISTORY", "MESSAGE_ERROR", "LATEST", message]
+            })
+        end
+
+      {"CHATHISTORY", ["LATEST", _target, _anchor, _limit | _]} ->
         send.(%M51.Irc.Command{
           command: "FAIL",
           params: [
             "CHATHISTORY",
             "INVALID_PARAMS",
             "LATEST",
-            "CHATHISTORY LATEST is not supported yet."
+            "CHATHISTORY LATEST with anchor is not supported yet."
           ]
         })
 

lib/irc_server.ex

@@ -40,7 +40,7 @@ defmodule M51.IrcServer do
   end
 
   defp accept(port, retries_left \\ 10) do
-    case :gen_tcp.listen(port, [:binary, packet: :line, active: false, reuseaddr: true]) do
+    case :gen_tcp.listen(port, [:binary, :inet6, packet: :line, active: false, reuseaddr: true]) do
       {:ok, server_sock} ->
         Logger.info("Listening on port #{port}")
         loop_accept(server_sock)

lib/matrix_client/chat_history.ex

@@ -89,6 +89,22 @@ defmodule M51.MatrixClient.ChatHistory do
     end
   end
 
+  def latest(sup_pid, room_id, limit) do
+    client = M51.IrcConn.Supervisor.matrix_client(sup_pid)
+
+    case M51.MatrixClient.Client.get_latest_events(
+           client,
+           room_id,
+           limit
+         ) do
+      {:ok, events} ->
+        {:ok, process_events(sup_pid, room_id, Enum.reverse(events["chunk"]))}
+
+      {:error, message} ->
+        {:error, Kernel.inspect(message)}
+    end
+  end
+
   defp parse_anchor(anchor) do
     case String.split(anchor, "=", parts: 2) do
       ["msgid", msgid] ->

lib/matrix_client/client.ex

@@ -327,6 +327,35 @@ defmodule M51.MatrixClient.Client do
     {:reply, reply, state}
   end
 
+  @impl true
+  def handle_call({:get_latest_events, channel, limit}, _from, state) do
+    %M51.MatrixClient.Client{
+      state: :connected,
+      irc_pid: irc_pid,
+      raw_client: raw_client
+    } = state
+
+    matrix_state = M51.IrcConn.Supervisor.matrix_state(irc_pid)
+
+    reply =
+      case M51.MatrixClient.State.room_from_irc_channel(matrix_state, channel) do
+        nil ->
+          {:error, {:room_not_found, channel}}
+
+        {room_id, _room} ->
+          path =
+            "/_matrix/client/v3/rooms/#{urlquote(room_id)}/messages?" <>
+              URI.encode_query(%{"limit" => limit, "dir" => "b"})
+
+          case M51.Matrix.RawClient.get(raw_client, path) do
+            {:ok, events} -> {:ok, events}
+            {:error, error} -> {:error, error}
+          end
+      end
+
+    {:reply, reply, state}
+  end
+
   @impl true
   def handle_call({:is_valid_alias, room_id, room_alias}, _from, state) do
     %M51.MatrixClient.Client{
@@ -521,6 +550,15 @@ defmodule M51.MatrixClient.Client do
     GenServer.call(pid, {:get_event_context, channel, event_id, limit}, @timeout)
   end
 
+  @doc """
+    Returns latest events of a room
+
+    https://matrix.org/docs/spec/client_server/r0.6.1#id131
+  """
+  def get_latest_events(pid, channel, limit) do
+    GenServer.call(pid, {:get_latest_events, channel, limit}, @timeout)
+  end
+
   defp urlquote(s) do
     M51.Matrix.Utils.urlquote(s)
   end

test/irc/handler_test.exs

@@ -933,6 +933,35 @@ defmodule M51.IrcConn.HandlerTest do
     assert_line("BATCH :-#{batch_id}\r\n")
   end
 
+  test "CHATHISTORY LATEST", %{handler: handler} do
+    do_connection_registration(handler, ["message-tags"])
+
+    send(handler, cmd("@label=l2 CHATHISTORY LATEST #chan * 1"))
+    {batch_id, line} = assert_open_batch()
+    assert line == "@label=l2 BATCH +#{batch_id} :chathistory\r\n"
+
+    assert_line(
+      "@batch=#{batch_id};msgid=$event5 :nick:[email protected] PRIVMSG #chan :fifth message\r\n"
+    )
+
+    assert_line("BATCH :-#{batch_id}\r\n")
+
+
+    send(handler, cmd("@label=l1 CHATHISTORY LATEST #chan * 2"))
+    {batch_id, line} = assert_open_batch()
+    assert line == "@label=l1 BATCH +#{batch_id} :chathistory\r\n"
+
+    assert_line(
+      "@batch=#{batch_id};msgid=$event4 :nick:[email protected] PRIVMSG #chan :fourth message\r\n"
+    )
+
+    assert_line(
+      "@batch=#{batch_id};msgid=$event5 :nick:[email protected] PRIVMSG #chan :fifth message\r\n"
+    )
+
+    assert_line("BATCH :-#{batch_id}\r\n")
+  end
+
   test "CHATHISTORY AFTER", %{handler: handler} do
     do_connection_registration(handler, ["message-tags"])
 

test/matrix_client/client_test.exs

@@ -500,6 +500,50 @@ defmodule M51.MatrixClient.ClientTest do
            ) == {:ok, %{"event" => "foo", "events_after" => [], "events_before" => []}}
   end
 
+  test "getting last events", %{sup_pid: sup_pid} do
+    MockHTTPoison
+    |> expect_login
+    |> expect(:get, fn url, headers, _options ->
+      assert headers == [Authorization: "Bearer t0ken"]
+
+      assert url ==
+               "https://matrix.example.org/_matrix/client/v3/rooms/%21roomid%3Aexample.org/messages?dir=b&limit=5"
+
+      {:ok,
+       %HTTPoison.Response{
+         status_code: 200,
+         body: ~s({"state": [], "chunk": []})
+       }}
+    end)
+
+    client = start_supervised!({M51.MatrixClient.Client, {sup_pid, [httpoison: MockHTTPoison]}})
+
+    state = M51.IrcConn.Supervisor.matrix_state(sup_pid)
+
+    M51.MatrixClient.State.set_room_canonical_alias(
+      state,
+      "!roomid:example.org",
+      "#chan:example.org"
+    )
+
+    assert M51.MatrixClient.Client.connect(
+             client,
+             "user",
+             "matrix.example.org",
+             "p4ssw0rd"
+           ) == {:ok}
+
+    receive do
+      msg -> assert msg == :connected
+    end
+
+    assert M51.MatrixClient.Client.get_latest_events(
+             client,
+             "#chan:example.org",
+             5
+           ) == {:ok, %{"state" => [], "chunk" => []}}
+  end
+
   test "checking valid alias", %{sup_pid: sup_pid} do
     MockHTTPoison
     |> expect_login

test/matrix_client/poller_test.exs

@@ -1399,7 +1399,7 @@ defmodule M51.MatrixClient.PollerTest do
         "rooms" => %{
           "join" => %{
             "!testid:example.org" => %{
-              "state" => %{"events" => state_events},
+              "state" => %{"events" => state_events}
             }
           }
         }

test/test_helper.exs

@@ -224,6 +224,61 @@ defmodule MockMatrixClient do
     {:reply, {:ok, reply}, state}
   end
 
+  @impl true
+  def handle_call({:get_latest_events, _channel, limit}, _from, state) do
+    events =
+      [
+        %{
+          "content" => %{"body" => "first message", "msgtype" => "m.text"},
+          "event_id" => "$event1",
+          "origin_server_ts" => 1_632_946_233_579,
+          "sender" => "@nick:example.org",
+          "type" => "m.room.message",
+          "unsigned" => %{}
+        },
+        %{
+          "content" => %{"body" => "second message", "msgtype" => "m.text"},
+          "event_id" => "$event2",
+          "origin_server_ts" => 1_632_946_233_579,
+          "sender" => "@nick:example.org",
+          "type" => "m.room.message",
+          "unsigned" => %{}
+        },
+        %{
+          "content" => %{"body" => "third message", "msgtype" => "m.text"},
+          "event_id" => "$event3",
+          "origin_server_ts" => 1_632_946_233_579,
+          "sender" => "@nick:example.org",
+          "type" => "m.room.message",
+          "unsigned" => %{}
+        },
+        %{
+          "content" => %{"body" => "fourth message", "msgtype" => "m.text"},
+          "event_id" => "$event4",
+          "origin_server_ts" => 1_632_946_233_579,
+          "sender" => "@nick:example.org",
+          "type" => "m.room.message",
+          "unsigned" => %{}
+        },
+        %{
+          "content" => %{"body" => "fifth message", "msgtype" => "m.text"},
+          "event_id" => "$event5",
+          "origin_server_ts" => 1_632_946_233_579,
+          "sender" => "@nick:example.org",
+          "type" => "m.room.message",
+          "unsigned" => %{}
+        }
+      ]
+      # Keep the last ones
+      |> Enum.slice(-limit..-1)
+      # "For dir=b events will be in reverse-chronological order"
+      |> Enum.reverse()
+
+    {:reply, {:ok, %{"state" => [], "chunk" => events}}, state}
+  end
+
+  :w
+
   @impl true
   def handle_call({:is_valid_alias, _room_id, "#invalidalias:example.org"}, _from, state) do
     {:reply, false, state}