Add .txt endpoint - /a/<id>.txt

.env.production.sample

@@ -46,3 +46,11 @@ MAILNAME=localhost
 # AWS_SECRET_ACCESS_KEY=
 # S3_BUCKET=my-asciinema-bucket
 # S3_REGION=us-east-1
+
+### File cache
+
+## Location of local cache directory used for storing .txt versions of the
+## recordings, local copy of .cast files when S3 file store is used above,
+## and other cached items.
+#Default: /var/cache/asciinema
+#FILE_CACHE_PATH=

.gitignore

@@ -53,4 +53,5 @@ npm-debug.log
 /config/custom.exs
 /priv/native
 /uploads/*
+/cache
 /volumes

config/config.exs

@@ -43,6 +43,8 @@ config :sentry,
 config :asciinema, :file_store, Asciinema.FileStore.Local
 config :asciinema, Asciinema.FileStore.Local, path: "uploads/"
 
+config :asciinema, Asciinema.FileCache, path: "cache/"
+
 config :asciinema, :png_generator, Asciinema.PngGenerator.Rsvg
 
 config :asciinema, Asciinema.PngGenerator.Rsvg,

config/prod.exs

@@ -31,3 +31,5 @@ config :asciinema, Asciinema.Emails.Mailer,
   adapter: Bamboo.SMTPAdapter,
   server: "smtp",
   port: 25
+
+config :asciinema, Asciinema.FileCache, path: "/var/cache/asciinema"

config/runtime.exs

@@ -58,6 +58,12 @@ if config_env() in [:prod, :dev] do
 
   config :ex_aws, region: {:system, "AWS_REGION"}
 
+  file_cache_path = env.("FILE_CACHE_PATH")
+
+  if file_cache_path do
+    config :asciinema, Asciinema.FileCache, path: file_cache_path
+  end
+
   if env.("S3_BUCKET") do
     config :asciinema, :file_store, Asciinema.FileStore.Cached
 
@@ -75,7 +81,8 @@ if config_env() in [:prod, :dev] do
       access_key_id: [{:system, "AWS_ACCESS_KEY_ID"}, :instance_role],
       secret_access_key: [{:system, "AWS_SECRET_ACCESS_KEY"}, :instance_role]
 
-    config :asciinema, Asciinema.FileStore.Local, path: "cache/uploads/"
+    config :asciinema, Asciinema.FileStore.Local,
+      path: Path.join(file_cache_path || "/var/cache/asciinema", "uploads")
   end
 
   if db_pool_size = env.("DB_POOL_SIZE") do

config/test.exs

@@ -31,6 +31,8 @@ config :asciinema, Asciinema.Accounts,
 
 config :asciinema, Asciinema.FileStore.Local, path: "uploads/test/"
 
+config :asciinema, Asciinema.FileCache, path: "/tmp/asciinema/"
+
 config :asciinema, :snapshot_updater, Asciinema.Recordings.SnapshotUpdater.Noop
 
 config :asciinema, Oban, testing: :manual

lib/asciinema/file_cache.ex

@@ -0,0 +1,24 @@
+defmodule Asciinema.FileCache do
+  def full_path(namespace, path, generator) do
+    path = full_path(namespace, path)
+
+    case File.stat(path) do
+      {:ok, _} ->
+        path
+
+      {:error, :enoent} ->
+        content = generator.()
+        parent_dir = Path.dirname(path)
+        :ok = File.mkdir_p(parent_dir)
+        File.write!(path, content)
+
+        path
+    end
+  end
+
+  defp full_path(namespace, path), do: Path.join([base_path(), to_string(namespace), path])
+
+  defp base_path do
+    Keyword.get(Application.get_env(:asciinema, __MODULE__), :path)
+  end
+end

lib/asciinema/file_store/local.ex

@@ -9,7 +9,7 @@ defmodule Asciinema.FileStore.Local do
 
   @impl true
   def put_file(dst_path, src_local_path, _content_type) do
-    full_dst_path = base_path() <> dst_path
+    full_dst_path = full_path(dst_path)
     parent_dir = Path.dirname(full_dst_path)
 
     with :ok <- File.mkdir_p(parent_dir),
@@ -20,8 +20,8 @@ defmodule Asciinema.FileStore.Local do
 
   @impl true
   def move_file(from_path, to_path) do
-    full_from_path = base_path() <> from_path
-    full_to_path = base_path() <> to_path
+    full_from_path = full_path(from_path)
+    full_to_path = full_path(to_path)
     parent_dir = Path.dirname(full_to_path)
     :ok = File.mkdir_p(parent_dir)
     File.rename(full_from_path, full_to_path)
@@ -41,13 +41,13 @@ defmodule Asciinema.FileStore.Local do
   defp do_serve_file(conn, path) do
     conn
     |> put_resp_header("content-type", MIME.from_path(path))
-    |> send_file(200, base_path() <> path)
+    |> send_file(200, full_path(path))
     |> halt
   end
 
   @impl true
   def open_file(path) do
-    File.open(base_path() <> path, [:binary, :read])
+    File.open(full_path(path), [:binary, :read])
   end
 
   @impl true
@@ -56,19 +56,21 @@ defmodule Asciinema.FileStore.Local do
   end
 
   def open_file(path, function) do
-    File.open(base_path() <> path, [:binary, :read], function)
+    File.open(full_path(path), [:binary, :read], function)
   end
 
   @impl true
   def delete_file(path) do
-    File.rm(base_path() <> path)
+    File.rm(full_path(path))
   end
 
-  defp config do
-    Application.get_env(:asciinema, __MODULE__)
-  end
+  defp full_path(path), do: Path.join(base_path(), path)
 
   defp base_path do
     Keyword.get(config(), :path)
   end
+
+  defp config do
+    Application.get_env(:asciinema, __MODULE__)
+  end
 end

lib/asciinema/recordings.ex

@@ -2,7 +2,7 @@ defmodule Asciinema.Recordings do
   require Logger
   import Ecto.Query, warn: false
   alias Asciinema.{FileStore, Media, Repo, Vt}
-  alias Asciinema.Recordings.{Asciicast, Output, Paths, SnapshotUpdater}
+  alias Asciinema.Recordings.{Asciicast, Output, Paths, SnapshotUpdater, Text}
   alias Ecto.Changeset
 
   def fetch_asciicast(id) do
@@ -413,6 +413,9 @@ defmodule Asciinema.Recordings do
     end)
   end
 
+  defdelegate text(asciicast), to: Text
+  defdelegate text_file_path(asciicast), to: Text
+
   defp frame_before_or_at?({time, _}, secs) do
     time <= secs
   end

lib/asciinema/recordings/paths.ex

@@ -2,8 +2,8 @@ defmodule Asciinema.Recordings.Paths do
   def sharded_path(asciicast, ext \\ nil) do
     ext =
       case {ext, asciicast.version} do
-        {nil, 1} -> "json"
-        {nil, 2} -> "cast"
+        {nil, 1} -> ".json"
+        {nil, 2} -> ".cast"
         {ext, _} when is_binary(ext) -> ext
       end
 
@@ -14,6 +14,6 @@ defmodule Asciinema.Recordings.Paths do
       |> String.reverse()
       |> String.slice(0, 4)
 
-    "asciicasts/#{a}/#{b}/#{asciicast.id}.#{ext}"
+    "asciicasts/#{a}/#{b}/#{asciicast.id}#{ext}"
   end
 end

lib/asciinema/recordings/text.ex

@@ -0,0 +1,22 @@
+defmodule Asciinema.Recordings.Text do
+  alias Asciinema.Recordings.{Asciicast, Output, Paths}
+  alias Asciinema.{FileCache, Vt}
+
+  def text(%Asciicast{cols: cols, rows: rows} = asciicast) do
+    output = Output.stream(asciicast)
+
+    Vt.with_vt(cols, rows, [resizable: true, scrollback_limit: nil], fn vt ->
+      Enum.each(output, fn {_, text} -> Vt.feed(vt, text) end)
+
+      Vt.text(vt)
+    end)
+  end
+
+  def text_file_path(asciicast) do
+    FileCache.full_path(
+      :txt,
+      Paths.sharded_path(asciicast, ".txt"),
+      fn -> text(asciicast) end
+    )
+  end
+end

lib/asciinema/vt.ex

@@ -23,6 +23,6 @@ defmodule Asciinema.Vt do
   @spec dump_screen(reference) :: {:ok, {list(list({binary, map})), {integer, integer} | nil}}
   def dump_screen(_vt), do: :erlang.nif_error(:nif_not_loaded)
 
-  @spec text(reference) :: list(binary)
+  @spec text(reference) :: binary
   def text(_vt), do: :erlang.nif_error(:nif_not_loaded)
 end

lib/asciinema_web/controllers/recording_controller.ex

@@ -91,6 +91,18 @@ defmodule AsciinemaWeb.RecordingController do
     |> send_file(200, path)
   end
 
+  def do_show(conn, "txt", asciicast) do
+    if asciicast.archived_at do
+      conn
+      |> put_status(410)
+      |> text("This recording has been archived\n")
+    else
+      send_download(conn, {:file, Recordings.text_file_path(asciicast)},
+        filename: "#{asciicast.id}.txt"
+      )
+    end
+  end
+
   def do_show(conn, "svg", asciicast) do
     if asciicast.archived_at do
       path = Application.app_dir(:asciinema, "priv/static/images/archived.png")

lib/asciinema_web/router.ex

@@ -14,7 +14,7 @@ defmodule AsciinemaWeb.Router do
 
   pipeline :asciicast do
     plug AsciinemaWeb.TrailingFormat
-    plug :accepts, ["html", "js", "json", "cast", "svg", "png", "gif"]
+    plug :accepts, ["html", "js", "json", "cast", "txt", "svg", "png", "gif"]
     plug :format_specific_plugs
     plug :put_secure_browser_headers
   end

lib/asciinema_web/trailing_format.ex

@@ -1,5 +1,5 @@
 defmodule AsciinemaWeb.TrailingFormat do
-  @known_exts ["js", "json", "cast", "svg", "png", "gif", "xml"]
+  @known_exts ["js", "json", "cast", "txt", "svg", "png", "gif", "xml"]
 
   def init(opts), do: opts
 

native/vt_nif/src/lib.rs

@@ -86,15 +86,19 @@ fn dump_screen(env: Env, resource: ResourceArc<VtResource>) -> NifResult<(Atom,
 }
 
 #[rustler::nif]
-fn text(resource: ResourceArc<VtResource>) -> NifResult<Vec<String>> {
+fn text(resource: ResourceArc<VtResource>) -> NifResult<String> {
     let vt = convert_err(resource.vt.read(), "rw_lock")?;
     let mut text = vt.text();
 
     while !text.is_empty() && text[text.len() - 1].is_empty() {
         text.truncate(text.len() - 1);
     }
 
-    Ok(text)
+    for line in &mut text.iter_mut() {
+        line.push('\n');
+    }
+
+    Ok(text.join(""))
 }
 
 fn segment_to_term(segment: avt::Segment, env: Env) -> Term {

test/controllers/recording_controller_test.exs

@@ -76,6 +76,19 @@ defmodule Asciinema.RecordingControllerTest do
       assert response(conn, 200)
     end
 
+    test "TXT", %{conn: conn} do
+      asciicast = insert(:asciicast) |> with_file()
+      url = Routes.recording_path(conn, :show, asciicast)
+
+      conn_2 = get(conn, url <> ".txt")
+      assert response(conn_2, 200)
+      assert response_content_type(conn_2, :txt)
+
+      conn_2 = conn |> put_req_header("accept", "text/plain") |> get(url)
+      assert response(conn_2, 200)
+      assert response_content_type(conn_2, :txt)
+    end
+
     @tag :rsvg
     test "PNG", %{conn: conn} do
       asciicast = insert(:asciicast)