+
General Options
- Editing Mode:
+ Editing Mode:
+ <.input
+ field={f[:original_url]}
+ type="text"
+ label="Source URL"
+ help="URL of a channel or playlist (required)"
+ x-init="$el.focus()"
+ />
+
<.input
field={f[:custom_name]}
type="text"
@@ -26,8 +35,6 @@
help="Does not impact indexing or downloading. Will be inferred from the source if left blank"
/>
- <.input field={f[:original_url]} type="text" label="Source URL" help="URL of a channel or playlist (required)" />
-
<.input
field={f[:media_profile_id]}
options={Enum.map(@media_profiles, &{&1.name, &1.id})}
@@ -49,7 +56,7 @@
label="Index Frequency"
x-bind:disabled="fastIndexingEnabled == true"
x-init="$watch('fastIndexingEnabled', v => v && ($el.value = 30 * 24 * 60))"
- help="Indexing is the process of checking for media to download. Sets the time between one index of this source finishing and the next one starting"
+ help="Indexing is the process of checking for media to download. For best results, set this to the longest delay you can tolerate for this source"
/>
@@ -58,7 +65,7 @@
type="toggle"
label="Use Fast Indexing"
label_suffix="(pro)"
- help="Experimental. Overrides 'Index Frequency'. Recommended for large channels that upload frequently. Does not work with private playlists. See below for more info"
+ help="Not recommended for playlists. Overrides 'Index Frequency'. See below for more details (seriously, there's a TL;DR that's worth reading)"
x-init="
// `enabled` is the data attribute that the toggle uses internally
fastIndexingEnabled = enabled
@@ -87,7 +94,7 @@
maxlength="10"
pattern="((?:19|20)[0-9][0-9])-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])"
title="YYYY-MM-DD"
- help="Only download media uploaded after this date. Leave blank to download all media. Must be in YYYY-MM-DD format"
+ help="Only download media uploaded after this date. Leave blank to download all media. Must be in YYYY-MM-DD format. Old media may be deleted or downloaded if you change this date"
/>
<.input
diff --git a/mix.exs b/mix.exs
index 9f8be03..b2d82a5 100644
--- a/mix.exs
+++ b/mix.exs
@@ -4,8 +4,8 @@ defmodule Pinchflat.MixProject do
def project do
[
app: :pinchflat,
- version: "2024.5.24",
- elixir: "~> 1.16",
+ version: "2024.7.18",
+ elixir: "~> 1.17",
elixirc_paths: elixirc_paths(Mix.env()),
start_permanent: Mix.env() == :prod,
aliases: aliases(),
@@ -71,7 +71,7 @@ defmodule Pinchflat.MixProject do
{:nimble_parsec, "~> 1.4"},
{:timex, "~> 3.0"},
{:mox, "~> 1.0", only: :test},
- {:credo, "~> 1.7", only: [:dev, :test], runtime: false},
+ {:credo, "~> 1.7.7", only: [:dev, :test], runtime: false},
{:credo_naming, "~> 2.1", only: [:dev, :test], runtime: false},
{:ex_check, "~> 0.14.0", only: [:dev, :test], runtime: false},
{:faker, "~> 0.17", only: :test},
@@ -87,6 +87,8 @@ defmodule Pinchflat.MixProject do
# See the documentation for `Mix` for more info on aliases.
defp aliases do
[
+ check: "check --config=tooling/.check.exs",
+ credo: "credo --config-file=tooling/.credo.exs",
setup: ["deps.get", "ecto.setup", "assets.setup", "assets.build"],
"ecto.setup": ["ecto.create", "ecto.migrate", "run priv/repo/seeds.exs"],
"ecto.reset": ["ecto.drop", "ecto.setup"],
@@ -101,7 +103,8 @@ defmodule Pinchflat.MixProject do
"ecto.rollback": [
"ecto.rollback",
~s(cmd [ -z "$MIX_ENV" ] && yarn run create-erd || echo "No ERD generated")
- ]
+ ],
+ "version.bump": "cmd ./tooling/version_bump.sh"
]
end
end
diff --git a/mix.lock b/mix.lock
index e986d1b..180ba25 100644
--- a/mix.lock
+++ b/mix.lock
@@ -7,7 +7,7 @@
"cowboy": {:hex, :cowboy, "2.10.0", "ff9ffeff91dae4ae270dd975642997afe2a1179d94b1887863e43f681a203e26", [:make, :rebar3], [{:cowlib, "2.12.1", [hex: :cowlib, repo: "hexpm", optional: false]}, {:ranch, "1.8.0", [hex: :ranch, repo: "hexpm", optional: false]}], "hexpm", "3afdccb7183cc6f143cb14d3cf51fa00e53db9ec80cdcd525482f5e99bc41d6b"},
"cowboy_telemetry": {:hex, :cowboy_telemetry, "0.4.0", "f239f68b588efa7707abce16a84d0d2acf3a0f50571f8bb7f56a15865aae820c", [:rebar3], [{:cowboy, "~> 2.7", [hex: :cowboy, repo: "hexpm", optional: false]}, {:telemetry, "~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "7d98bac1ee4565d31b62d59f8823dfd8356a169e7fcbb83831b8a5397404c9de"},
"cowlib": {:hex, :cowlib, "2.12.1", "a9fa9a625f1d2025fe6b462cb865881329b5caff8f1854d1cbc9f9533f00e1e1", [:make, :rebar3], [], "hexpm", "163b73f6367a7341b33c794c4e88e7dbfe6498ac42dcd69ef44c5bc5507c8db0"},
- "credo": {:hex, :credo, "1.7.3", "05bb11eaf2f2b8db370ecaa6a6bda2ec49b2acd5e0418bc106b73b07128c0436", [:mix], [{:bunt, "~> 0.2.1 or ~> 1.0", [hex: :bunt, repo: "hexpm", optional: false]}, {:file_system, "~> 0.2 or ~> 1.0", [hex: :file_system, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "35ea675a094c934c22fb1dca3696f3c31f2728ae6ef5a53b5d648c11180a4535"},
+ "credo": {:hex, :credo, "1.7.7", "771445037228f763f9b2afd612b6aa2fd8e28432a95dbbc60d8e03ce71ba4446", [:mix], [{:bunt, "~> 0.2.1 or ~> 1.0", [hex: :bunt, repo: "hexpm", optional: false]}, {:file_system, "~> 0.2 or ~> 1.0", [hex: :file_system, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "8bc87496c9aaacdc3f90f01b7b0582467b69b4bd2441fe8aae3109d843cc2f2e"},
"credo_naming": {:hex, :credo_naming, "2.1.0", "d44ad58890d4db552e141ce64756a74ac1573665af766d1ac64931aa90d47744", [:make, :mix], [{:credo, "~> 1.6", [hex: :credo, repo: "hexpm", optional: false]}], "hexpm", "830e23b3fba972e2fccec49c0c089fe78c1e64bc16782a2682d78082351a2909"},
"db_connection": {:hex, :db_connection, "2.6.0", "77d835c472b5b67fc4f29556dee74bf511bbafecdcaf98c27d27fa5918152086", [:mix], [{:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "c2f992d15725e721ec7fbc1189d4ecdb8afef76648c746a8e1cad35e3b8a35f3"},
"decimal": {:hex, :decimal, "2.1.1", "5611dca5d4b2c3dd497dec8f68751f1f1a54755e8ed2a966c2633cf885973ad6", [:mix], [], "hexpm", "53cfe5f497ed0e7771ae1a475575603d77425099ba5faef9394932b35020ffcc"},
diff --git a/package.json b/package.json
index a9a1b23..fab6aa5 100644
--- a/package.json
+++ b/package.json
@@ -5,7 +5,9 @@
"sqleton": "^2.2.0"
},
"scripts": {
- "create-erd": "sqleton -o priv/repo/erd.png priv/repo/pinchflat_dev.db"
+ "create-erd": "sqleton -o priv/repo/erd.png priv/repo/pinchflat_dev.db",
+ "lint:check": "prettier . --check --config=tooling/.prettierrc.js --ignore-path=tooling/.prettierignore --ignore-path=.gitignore",
+ "lint:fix": "prettier . --write --config=tooling/.prettierrc.js --ignore-path=tooling/.prettierignore --ignore-path=.gitignore"
},
"private": true
}
diff --git a/priv/repo/erd.png b/priv/repo/erd.png
index 30d3e8a..50e0ec4 100644
Binary files a/priv/repo/erd.png and b/priv/repo/erd.png differ
diff --git a/priv/repo/migrations/20240603230512_refactor_codec_preferences.exs b/priv/repo/migrations/20240603230512_refactor_codec_preferences.exs
new file mode 100644
index 0000000..0b00830
--- /dev/null
+++ b/priv/repo/migrations/20240603230512_refactor_codec_preferences.exs
@@ -0,0 +1,15 @@
+defmodule Pinchflat.Repo.Migrations.RefactorCodecPreferences do
+ use Ecto.Migration
+
+ def change do
+ alter table(:settings) do
+ remove :video_codec_preference, {:array, :string}, default: []
+ remove :audio_codec_preference, {:array, :string}, default: []
+ end
+
+ alter table(:settings) do
+ add :video_codec_preference, :string, default: "avc", null: false
+ add :audio_codec_preference, :string, default: "m4a", null: false
+ end
+ end
+end
diff --git a/priv/repo/migrations/20240604221531_add_youtube_api_key_setting.exs b/priv/repo/migrations/20240604221531_add_youtube_api_key_setting.exs
new file mode 100644
index 0000000..cbb81c7
--- /dev/null
+++ b/priv/repo/migrations/20240604221531_add_youtube_api_key_setting.exs
@@ -0,0 +1,9 @@
+defmodule Pinchflat.Repo.Migrations.AddYoutubeApiKeySetting do
+ use Ecto.Migration
+
+ def change do
+ alter table(:settings) do
+ add :youtube_api_key, :string
+ end
+ end
+end
diff --git a/priv/repo/migrations/20240715212133_add_playlist_index_to_media_items.exs b/priv/repo/migrations/20240715212133_add_playlist_index_to_media_items.exs
new file mode 100644
index 0000000..e629efd
--- /dev/null
+++ b/priv/repo/migrations/20240715212133_add_playlist_index_to_media_items.exs
@@ -0,0 +1,9 @@
+defmodule Pinchflat.Repo.Migrations.AddPlaylistIndexToMediaItems do
+ use Ecto.Migration
+
+ def change do
+ alter table(:media_items) do
+ add :playlist_index, :integer, null: false, default: 0
+ end
+ end
+end
diff --git a/priv/static/images/app-form-screenshot.jpg b/priv/static/images/app-form-screenshot.jpg
new file mode 100644
index 0000000..dea5906
Binary files /dev/null and b/priv/static/images/app-form-screenshot.jpg differ
diff --git a/priv/static/images/app-form-screenshot.png b/priv/static/images/app-form-screenshot.png
deleted file mode 100644
index f63de7a..0000000
Binary files a/priv/static/images/app-form-screenshot.png and /dev/null differ
diff --git a/priv/static/images/app-screenshot.jpg b/priv/static/images/app-screenshot.jpg
new file mode 100644
index 0000000..608d161
Binary files /dev/null and b/priv/static/images/app-screenshot.jpg differ
diff --git a/priv/static/images/app-screenshot.png b/priv/static/images/app-screenshot.png
deleted file mode 100644
index 9875abe..0000000
Binary files a/priv/static/images/app-screenshot.png and /dev/null differ
diff --git a/test/pinchflat/downloading/codec_parser_test.exs b/test/pinchflat/downloading/codec_parser_test.exs
deleted file mode 100644
index c7b856a..0000000
--- a/test/pinchflat/downloading/codec_parser_test.exs
+++ /dev/null
@@ -1,70 +0,0 @@
-defmodule Pinchflat.Downloading.CodecParserTest do
- use Pinchflat.DataCase
-
- alias Pinchflat.Settings
- alias Pinchflat.Downloading.CodecParser
-
- describe "generate_vcodec_string_from_settings/1" do
- test "returns a default vcodec string when setting isn't set" do
- Settings.set(video_codec_preference: [])
-
- assert "bestvideo[vcodec~='^avc']/bestvideo" == CodecParser.generate_vcodec_string_from_settings()
- end
-
- test "generates a vcodec string" do
- Settings.set(video_codec_preference: ["av01"])
-
- assert "bestvideo[vcodec~='^av01']/bestvideo" == CodecParser.generate_vcodec_string_from_settings()
- end
- end
-
- describe "generate_acodec_string_from_settings/1" do
- test "returns a default acodec string when setting isn't set" do
- Settings.set(audio_codec_preference: [])
-
- assert "bestaudio[acodec~='^mp4a']/bestaudio" == CodecParser.generate_acodec_string_from_settings()
- end
-
- test "generates an acodec string" do
- Settings.set(audio_codec_preference: ["mp3"])
-
- assert "bestaudio[acodec~='^mp3']/bestaudio" == CodecParser.generate_acodec_string_from_settings()
- end
- end
-
- describe "generate_vcodec_string/1" do
- test "returns a default vcodec string when nil" do
- assert "bestvideo[vcodec~='^avc']/bestvideo" == CodecParser.generate_vcodec_string(nil)
- end
-
- test "returns a default vcodec string when empty" do
- assert "bestvideo[vcodec~='^avc']/bestvideo" == CodecParser.generate_vcodec_string([])
- end
-
- test "generates a vcodec string" do
- assert "bestvideo[vcodec~='^av01']/bestvideo" == CodecParser.generate_vcodec_string(["av01"])
- end
-
- test "ignores options that don't exist" do
- assert "bestvideo[vcodec~='^av01']/bestvideo" == CodecParser.generate_vcodec_string(["av01", "foo"])
- end
- end
-
- describe "generate_acodec_string/1" do
- test "returns a default acodec string when nil" do
- assert "bestaudio[acodec~='^mp4a']/bestaudio" == CodecParser.generate_acodec_string(nil)
- end
-
- test "returns a default acodec string when empty" do
- assert "bestaudio[acodec~='^mp4a']/bestaudio" == CodecParser.generate_acodec_string([])
- end
-
- test "generates an acodec string" do
- assert "bestaudio[acodec~='^mp3']/bestaudio" == CodecParser.generate_acodec_string(["mp3"])
- end
-
- test "ignores options that don't exist" do
- assert "bestaudio[acodec~='^mp3']/bestaudio" == CodecParser.generate_acodec_string(["mp3", "foo"])
- end
- end
-end
diff --git a/test/pinchflat/downloading/download_option_builder_test.exs b/test/pinchflat/downloading/download_option_builder_test.exs
index a22e11c..5670c38 100644
--- a/test/pinchflat/downloading/download_option_builder_test.exs
+++ b/test/pinchflat/downloading/download_option_builder_test.exs
@@ -93,15 +93,23 @@ defmodule Pinchflat.Downloading.DownloadOptionBuilderTest do
end
test "includes :write_auto_subs option when specified", %{media_item: media_item} do
- media_item = update_media_profile_attribute(media_item, %{download_subs: true, download_auto_subs: true})
+ media_item_1 = update_media_profile_attribute(media_item, %{download_subs: true, download_auto_subs: true})
+ media_item_2 = update_media_profile_attribute(media_item, %{embed_subs: true, download_auto_subs: true})
- assert {:ok, res} = DownloadOptionBuilder.build(media_item)
+ assert {:ok, res_1} = DownloadOptionBuilder.build(media_item_1)
+ assert {:ok, res_2} = DownloadOptionBuilder.build(media_item_2)
- assert :write_auto_subs in res
+ assert :write_auto_subs in res_1
+ assert :write_auto_subs in res_2
end
- test "doesn't include :write_auto_subs option when download_subs is false", %{media_item: media_item} do
- media_item = update_media_profile_attribute(media_item, %{download_subs: false, download_auto_subs: true})
+ test "doesn't include :write_auto_subs option when download_subs and embed_subs is false", %{media_item: media_item} do
+ media_item =
+ update_media_profile_attribute(media_item, %{
+ download_subs: false,
+ embed_subs: false,
+ download_auto_subs: true
+ })
assert {:ok, res} = DownloadOptionBuilder.build(media_item)
@@ -256,10 +264,8 @@ defmodule Pinchflat.Downloading.DownloadOptionBuilderTest do
media_item = Repo.preload(media_item_fixture(source_id: source.id), source: :media_profile)
assert {:ok, res} = DownloadOptionBuilder.build(media_item)
- assert {:format_sort, "res:#{resolution}"} in res
-
- assert {:format, "((bestvideo[vcodec~='^avc']/bestvideo)+(bestaudio[acodec~='^mp4a']/bestaudio))/best"} in res
+ assert {:format_sort, "res:#{resolution},+codec:avc:m4a"} in res
assert {:remux_video, "mp4"} in res
end)
end
@@ -270,20 +276,20 @@ defmodule Pinchflat.Downloading.DownloadOptionBuilderTest do
assert {:ok, res} = DownloadOptionBuilder.build(media_item)
assert :extract_audio in res
- assert {:format, "bestaudio[acodec~='^mp4a']/bestaudio/best"} in res
+ assert {:format_sort, "+acodec:m4a"} in res
refute {:remux_video, "mp4"} in res
end
test "includes custom quality options if specified", %{media_item: media_item} do
- Settings.set(video_codec_preference: ["av01"])
- Settings.set(audio_codec_preference: ["aac"])
+ Settings.set(video_codec_preference: "av01")
+ Settings.set(audio_codec_preference: "aac")
media_item = update_media_profile_attribute(media_item, %{preferred_resolution: :"1080p"})
assert {:ok, res} = DownloadOptionBuilder.build(media_item)
- assert {:format, "((bestvideo[vcodec~='^av01']/bestvideo)+(bestaudio[acodec~='^aac']/bestaudio))/best"} in res
+ assert {:format_sort, "res:1080,+codec:av01:aac"} in res
end
end
diff --git a/test/pinchflat/downloading/downloading_helpers_test.exs b/test/pinchflat/downloading/downloading_helpers_test.exs
index 01b0518..5ab4f40 100644
--- a/test/pinchflat/downloading/downloading_helpers_test.exs
+++ b/test/pinchflat/downloading/downloading_helpers_test.exs
@@ -130,9 +130,6 @@ defmodule Pinchflat.Downloading.DownloadingHelpersTest do
_download_prevented =
media_item_fixture(source_id: source.id, media_filepath: "some/filepath.mp4", prevent_download: true)
- _culled =
- media_item_fixture(source_id: source.id, media_filepath: "some/filepath.mp4", culled_at: now())
-
assert [] = DownloadingHelpers.kickoff_redownload_for_existing_media(source)
refute_enqueued(worker: MediaDownloadWorker)
diff --git a/test/pinchflat/downloading/media_download_worker_test.exs b/test/pinchflat/downloading/media_download_worker_test.exs
index e82b0b1..35eabeb 100644
--- a/test/pinchflat/downloading/media_download_worker_test.exs
+++ b/test/pinchflat/downloading/media_download_worker_test.exs
@@ -9,7 +9,8 @@ defmodule Pinchflat.Downloading.MediaDownloadWorkerTest do
alias Pinchflat.Downloading.MediaDownloadWorker
setup do
- stub(UserScriptRunnerMock, :run, fn _event_type, _data -> :ok end)
+ stub(YtDlpRunnerMock, :run, fn _url, _opts, _ot -> {:ok, ""} end)
+ stub(UserScriptRunnerMock, :run, fn _event_type, _data -> {:ok, "", 0} end)
stub(HTTPClientMock, :get, fn _url, _headers, _opts -> {:ok, ""} end)
media_item =
@@ -161,20 +162,6 @@ defmodule Pinchflat.Downloading.MediaDownloadWorkerTest do
assert media_item.media_redownloaded_at == nil
end
- test "calls the user script runner", %{media_item: media_item} do
- expect(YtDlpRunnerMock, :run, fn _url, _opts, _ot, _addl ->
- {:ok, render_metadata(:media_metadata)}
- end)
-
- expect(UserScriptRunnerMock, :run, fn :media_downloaded, data ->
- assert data.id == media_item.id
-
- :ok
- end)
-
- perform_job(MediaDownloadWorker, %{id: media_item.id})
- end
-
test "does not blow up if the record doesn't exist" do
assert :ok = perform_job(MediaDownloadWorker, %{id: 0})
end
@@ -236,4 +223,59 @@ defmodule Pinchflat.Downloading.MediaDownloadWorkerTest do
perform_job(MediaDownloadWorker, %{id: media_item.id, force: true})
end
end
+
+ describe "perform/1 when testing user script callbacks" do
+ setup do
+ stub(YtDlpRunnerMock, :run, fn _url, _opts, _ot, _addl ->
+ {:ok, render_metadata(:media_metadata)}
+ end)
+
+ :ok
+ end
+
+ test "calls the media_pre_download user script runner", %{media_item: media_item} do
+ expect(UserScriptRunnerMock, :run, fn :media_pre_download, data ->
+ assert data.id == media_item.id
+
+ {:ok, "", 0}
+ end)
+
+ expect(UserScriptRunnerMock, :run, fn :media_downloaded, _ -> {:ok, "", 0} end)
+
+ perform_job(MediaDownloadWorker, %{id: media_item.id})
+ end
+
+ test "does not download the media if the pre-download script returns an error", %{media_item: media_item} do
+ expect(UserScriptRunnerMock, :run, fn :media_pre_download, _ -> {:ok, "", 1} end)
+
+ assert :ok = perform_job(MediaDownloadWorker, %{id: media_item.id})
+ media_item = Repo.reload!(media_item)
+
+ refute media_item.media_filepath
+ assert media_item.prevent_download
+ end
+
+ test "downloads media if the pre-download script is not present", %{media_item: media_item} do
+ expect(UserScriptRunnerMock, :run, fn :media_pre_download, _ -> {:ok, :no_executable} end)
+ expect(UserScriptRunnerMock, :run, fn :media_downloaded, _ -> {:ok, :no_executable} end)
+
+ assert :ok = perform_job(MediaDownloadWorker, %{id: media_item.id})
+ media_item = Repo.reload!(media_item)
+
+ assert media_item.media_filepath
+ refute media_item.prevent_download
+ end
+
+ test "calls the media_downloaded user script runner", %{media_item: media_item} do
+ expect(UserScriptRunnerMock, :run, fn :media_pre_download, _ -> {:ok, "", 0} end)
+
+ expect(UserScriptRunnerMock, :run, fn :media_downloaded, data ->
+ assert data.id == media_item.id
+
+ {:ok, "", 0}
+ end)
+
+ perform_job(MediaDownloadWorker, %{id: media_item.id})
+ end
+ end
end
diff --git a/test/pinchflat/downloading/media_downloader_test.exs b/test/pinchflat/downloading/media_downloader_test.exs
index 463b7b8..be5f10e 100644
--- a/test/pinchflat/downloading/media_downloader_test.exs
+++ b/test/pinchflat/downloading/media_downloader_test.exs
@@ -5,6 +5,7 @@ defmodule Pinchflat.Downloading.MediaDownloaderTest do
import Pinchflat.SourcesFixtures
import Pinchflat.ProfilesFixtures
+ alias Pinchflat.Media
alias Pinchflat.Downloading.MediaDownloader
setup do
@@ -14,9 +15,8 @@ defmodule Pinchflat.Downloading.MediaDownloaderTest do
[:metadata, source: :media_profile]
)
- stub(HTTPClientMock, :get, fn _url, _headers, _opts ->
- {:ok, ""}
- end)
+ stub(HTTPClientMock, :get, fn _url, _headers, _opts -> {:ok, ""} end)
+ stub(YtDlpRunnerMock, :run, fn _url, _opts, _ot -> {:ok, ""} end)
{:ok, %{media_item: media_item}}
end
@@ -44,7 +44,7 @@ defmodule Pinchflat.Downloading.MediaDownloaderTest do
assert {:ok, updated_media_item} = MediaDownloader.download_for_media_item(media_item)
assert updated_media_item.metadata.metadata_filepath =~ "media_items/#{media_item.id}/metadata.json.gz"
- assert updated_media_item.metadata.thumbnail_filepath =~ "media_items/#{media_item.id}/maxresdefault.jpg"
+ assert updated_media_item.metadata.thumbnail_filepath =~ "media_items/#{media_item.id}/thumbnail.jpg"
end
test "non-recoverable errors are passed through", %{media_item: media_item} do
@@ -124,6 +124,12 @@ defmodule Pinchflat.Downloading.MediaDownloaderTest do
assert DateTime.diff(DateTime.utc_now(), updated_media_item.media_downloaded_at) < 2
end
+ test "it sets the culled_at to nil", %{media_item: media_item} do
+ Media.update_media_item(media_item, %{culled_at: DateTime.utc_now()})
+ assert {:ok, updated_media_item} = MediaDownloader.download_for_media_item(media_item)
+ assert updated_media_item.culled_at == nil
+ end
+
test "it extracts the title", %{media_item: media_item} do
assert {:ok, updated_media_item} = MediaDownloader.download_for_media_item(media_item)
assert updated_media_item.title == "Pinchflat Example Video"
diff --git a/test/pinchflat/downloading/media_retention_worker_test.exs b/test/pinchflat/downloading/media_retention_worker_test.exs
index 85ffdd9..f0a59ce 100644
--- a/test/pinchflat/downloading/media_retention_worker_test.exs
+++ b/test/pinchflat/downloading/media_retention_worker_test.exs
@@ -7,15 +7,36 @@ defmodule Pinchflat.Downloading.MediaRetentionWorkerTest do
alias Pinchflat.Media
alias Pinchflat.Downloading.MediaRetentionWorker
- describe "perform/1" do
- setup do
- stub(UserScriptRunnerMock, :run, fn _event_type, _data -> :ok end)
+ setup do
+ stub(UserScriptRunnerMock, :run, fn _event_type, _data -> {:ok, "", 0} end)
- :ok
+ :ok
+ end
+
+ describe "perform/1" do
+ test "sets deleted media to not re-download" do
+ {_source, old_media_item, new_media_item} = prepare_records_for_retention_date()
+
+ perform_job(MediaRetentionWorker, %{})
+
+ refute Repo.reload!(new_media_item).prevent_download
+ assert Repo.reload!(old_media_item).prevent_download
end
+ test "sets culled_at timestamp on deleted media" do
+ {_source, old_media_item, new_media_item} = prepare_records_for_retention_date()
+
+ perform_job(MediaRetentionWorker, %{})
+
+ refute Repo.reload!(new_media_item).culled_at
+ assert Repo.reload!(old_media_item).culled_at
+ assert DateTime.diff(now(), Repo.reload!(old_media_item).culled_at) < 1
+ end
+ end
+
+ describe "perform/1 when testing retention_period-based culling" do
test "deletes media files that are past their retention date" do
- {_source, old_media_item, new_media_item} = prepare_records()
+ {_source, old_media_item, new_media_item} = prepare_records_for_retention_date()
perform_job(MediaRetentionWorker, %{})
@@ -25,27 +46,33 @@ defmodule Pinchflat.Downloading.MediaRetentionWorkerTest do
refute Repo.reload!(old_media_item).media_filepath
end
- test "sets deleted media to not re-download" do
- {_source, old_media_item, new_media_item} = prepare_records()
-
- perform_job(MediaRetentionWorker, %{})
-
- refute Repo.reload!(new_media_item).prevent_download
- assert Repo.reload!(old_media_item).prevent_download
- end
-
- test "sets culled_at timestamp on deleted media" do
- {_source, old_media_item, new_media_item} = prepare_records()
+ test "sets culled_at and prevent_download" do
+ {_source, old_media_item, new_media_item} = prepare_records_for_retention_date()
perform_job(MediaRetentionWorker, %{})
refute Repo.reload!(new_media_item).culled_at
assert Repo.reload!(old_media_item).culled_at
- assert DateTime.diff(now(), Repo.reload!(old_media_item).culled_at) < 1
+ refute Repo.reload!(new_media_item).prevent_download
+ assert Repo.reload!(old_media_item).prevent_download
+ end
+
+ test "doesn't cull if the source doesn't have a retention period" do
+ {_source, old_media_item, new_media_item} = prepare_records_for_retention_date(nil)
+
+ perform_job(MediaRetentionWorker, %{})
+
+ assert File.exists?(new_media_item.media_filepath)
+ assert File.exists?(old_media_item.media_filepath)
+ assert Repo.reload!(new_media_item).media_filepath
+ assert Repo.reload!(old_media_item).media_filepath
+
+ refute Repo.reload!(new_media_item).culled_at
+ refute Repo.reload!(old_media_item).culled_at
end
test "doesn't cull media items that have prevent_culling set" do
- {_source, old_media_item, _new_media_item} = prepare_records()
+ {_source, old_media_item, _new_media_item} = prepare_records_for_retention_date()
Media.update_media_item(old_media_item, %{prevent_culling: true})
@@ -53,11 +80,99 @@ defmodule Pinchflat.Downloading.MediaRetentionWorkerTest do
assert File.exists?(old_media_item.media_filepath)
assert Repo.reload!(old_media_item).media_filepath
+ refute Repo.reload!(old_media_item).culled_at
+ end
+
+ test "doesn't cull if the media item has no media_filepath" do
+ {_source, old_media_item, _new_media_item} = prepare_records_for_retention_date()
+
+ Media.update_media_item(old_media_item, %{media_filepath: nil})
+
+ perform_job(MediaRetentionWorker, %{})
+
+ refute Repo.reload!(old_media_item).culled_at
end
end
- defp prepare_records do
- source = source_fixture(%{retention_period_days: 2})
+ describe "perform/1 when testing source cutoff-based culling" do
+ test "culls media from before the cutoff date" do
+ {_source, old_media_item, new_media_item} = prepare_records_for_source_cutoff_date()
+
+ perform_job(MediaRetentionWorker, %{})
+
+ assert File.exists?(new_media_item.media_filepath)
+ refute File.exists?(old_media_item.media_filepath)
+ assert Repo.reload!(new_media_item).media_filepath
+ refute Repo.reload!(old_media_item).media_filepath
+ end
+
+ test "sets culled_at but not prevent_download" do
+ {_source, old_media_item, new_media_item} = prepare_records_for_source_cutoff_date()
+
+ perform_job(MediaRetentionWorker, %{})
+
+ refute Repo.reload!(new_media_item).culled_at
+ assert Repo.reload!(old_media_item).culled_at
+ refute Repo.reload!(new_media_item).prevent_download
+ refute Repo.reload!(old_media_item).prevent_download
+ end
+
+ test "doesn't cull media if the source doesn't have a cutoff date" do
+ {_source, old_media_item, new_media_item} = prepare_records_for_source_cutoff_date(nil)
+
+ perform_job(MediaRetentionWorker, %{})
+
+ assert File.exists?(new_media_item.media_filepath)
+ assert File.exists?(old_media_item.media_filepath)
+ assert Repo.reload!(new_media_item).media_filepath
+ assert Repo.reload!(old_media_item).media_filepath
+
+ refute Repo.reload!(new_media_item).culled_at
+ refute Repo.reload!(old_media_item).culled_at
+ end
+
+ test "doesn't cull media from on or after the cutoff date" do
+ {_source, old_media_item, new_media_item} = prepare_records_for_source_cutoff_date(2)
+
+ Media.update_media_item(old_media_item, %{uploaded_at: now_minus(2, :days)})
+ Media.update_media_item(new_media_item, %{uploaded_at: now_minus(1, :day)})
+
+ perform_job(MediaRetentionWorker, %{})
+
+ assert File.exists?(new_media_item.media_filepath)
+ assert File.exists?(old_media_item.media_filepath)
+ assert Repo.reload!(new_media_item).media_filepath
+ assert Repo.reload!(old_media_item).media_filepath
+
+ refute Repo.reload!(new_media_item).culled_at
+ refute Repo.reload!(old_media_item).culled_at
+ end
+
+ test "doesn't cull media items that have prevent_culling set" do
+ {_source, old_media_item, _new_media_item} = prepare_records_for_source_cutoff_date()
+
+ Media.update_media_item(old_media_item, %{prevent_culling: true})
+
+ perform_job(MediaRetentionWorker, %{})
+
+ assert File.exists?(old_media_item.media_filepath)
+ assert Repo.reload!(old_media_item).media_filepath
+ refute Repo.reload!(old_media_item).culled_at
+ end
+
+ test "doesn't cull if the media item has no media_filepath" do
+ {_source, old_media_item, _new_media_item} = prepare_records_for_source_cutoff_date()
+
+ Media.update_media_item(old_media_item, %{media_filepath: nil})
+
+ perform_job(MediaRetentionWorker, %{})
+
+ refute Repo.reload!(old_media_item).culled_at
+ end
+ end
+
+ defp prepare_records_for_retention_date(retention_period_days \\ 2) do
+ source = source_fixture(%{retention_period_days: retention_period_days})
old_media_item =
media_item_with_attachments(%{
@@ -73,4 +188,23 @@ defmodule Pinchflat.Downloading.MediaRetentionWorkerTest do
{source, old_media_item, new_media_item}
end
+
+ defp prepare_records_for_source_cutoff_date(download_cutoff_date_days_ago \\ 2) do
+ cutoff_date = if download_cutoff_date_days_ago, do: now_minus(download_cutoff_date_days_ago, :days), else: nil
+ source = source_fixture(%{download_cutoff_date: cutoff_date})
+
+ old_media_item =
+ media_item_with_attachments(%{
+ source_id: source.id,
+ uploaded_at: now_minus(3, :days)
+ })
+
+ new_media_item =
+ media_item_with_attachments(%{
+ source_id: source.id,
+ uploaded_at: now_minus(1, :day)
+ })
+
+ {source, old_media_item, new_media_item}
+ end
end
diff --git a/test/pinchflat/fast_indexing/fast_indexing_helpers_test.exs b/test/pinchflat/fast_indexing/fast_indexing_helpers_test.exs
index 94d12aa..46f4226 100644
--- a/test/pinchflat/fast_indexing/fast_indexing_helpers_test.exs
+++ b/test/pinchflat/fast_indexing/fast_indexing_helpers_test.exs
@@ -6,19 +6,20 @@ defmodule Pinchflat.FastIndexing.FastIndexingHelpersTest do
import Pinchflat.ProfilesFixtures
alias Pinchflat.Tasks
+ alias Pinchflat.Settings
alias Pinchflat.Media.MediaItem
alias Pinchflat.Downloading.MediaDownloadWorker
alias Pinchflat.FastIndexing.FastIndexingHelpers
+ setup do
+ stub(YtDlpRunnerMock, :run, fn _url, _opts, _ot ->
+ {:ok, media_attributes_return_fixture()}
+ end)
+
+ {:ok, [source: source_fixture()]}
+ end
+
describe "kickoff_download_tasks_from_youtube_rss_feed/1" do
- setup do
- stub(YtDlpRunnerMock, :run, fn _url, _opts, _ot ->
- {:ok, media_attributes_return_fixture()}
- end)
-
- {:ok, [source: source_fixture()]}
- end
-
test "enqueues a new worker for each new media_id in the source's RSS feed", %{source: source} do
expect(HTTPClientMock, :get, fn _url -> {:ok, "test_1"} end)
@@ -107,4 +108,49 @@ defmodule Pinchflat.FastIndexing.FastIndexingHelpersTest do
assert [] = FastIndexingHelpers.kickoff_download_tasks_from_youtube_rss_feed(source)
end
end
+
+ describe "kickoff_download_tasks_from_youtube_rss_feed/1 when testing backends" do
+ test "uses the YouTube API if it is enabled", %{source: source} do
+ expect(HTTPClientMock, :get, fn url, _headers ->
+ assert url =~ "https://youtube.googleapis.com/youtube/v3/playlistItems"
+
+ {:ok, "{}"}
+ end)
+
+ Settings.set(youtube_api_key: "test_key")
+
+ assert [] = FastIndexingHelpers.kickoff_download_tasks_from_youtube_rss_feed(source)
+ end
+
+ test "the YouTube API creates records as expected", %{source: source} do
+ expect(HTTPClientMock, :get, fn _url, _headers ->
+ {:ok, ~s({ "items": [ {"contentDetails": {"videoId": "test_1"}} ] })}
+ end)
+
+ Settings.set(youtube_api_key: "test_key")
+
+ assert [%MediaItem{}] = FastIndexingHelpers.kickoff_download_tasks_from_youtube_rss_feed(source)
+ end
+
+ test "RSS is used as a backup if the API fails", %{source: source} do
+ expect(HTTPClientMock, :get, fn _url, _headers -> {:error, ""} end)
+ expect(HTTPClientMock, :get, fn _url -> {:ok, "test_1"} end)
+
+ Settings.set(youtube_api_key: "test_key")
+
+ assert [%MediaItem{}] = FastIndexingHelpers.kickoff_download_tasks_from_youtube_rss_feed(source)
+ end
+
+ test "RSS is used if the API is not enabled", %{source: source} do
+ expect(HTTPClientMock, :get, fn url ->
+ assert url =~ "https://www.youtube.com/feeds/videos.xml"
+
+ {:ok, "test_1"}
+ end)
+
+ Settings.set(youtube_api_key: nil)
+
+ assert [%MediaItem{}] = FastIndexingHelpers.kickoff_download_tasks_from_youtube_rss_feed(source)
+ end
+ end
end
diff --git a/test/pinchflat/fast_indexing/youtube_api_test.exs b/test/pinchflat/fast_indexing/youtube_api_test.exs
new file mode 100644
index 0000000..cc310d6
--- /dev/null
+++ b/test/pinchflat/fast_indexing/youtube_api_test.exs
@@ -0,0 +1,85 @@
+defmodule Pinchflat.FastIndexing.YoutubeApiTest do
+ use Pinchflat.DataCase
+
+ import Pinchflat.SourcesFixtures
+
+ alias Pinchflat.Settings
+ alias Pinchflat.FastIndexing.YoutubeApi
+
+ describe "enabled?/0" do
+ test "returns true if the user has set a YouTube API key" do
+ Settings.set(youtube_api_key: "test_key")
+
+ assert YoutubeApi.enabled?()
+ end
+
+ test "returns false if the user has not set an API key" do
+ Settings.set(youtube_api_key: nil)
+
+ refute YoutubeApi.enabled?()
+ end
+ end
+
+ describe "get_recent_media_ids/1" do
+ setup do
+ source = source_fixture()
+ Settings.set(youtube_api_key: "test_key")
+
+ {:ok, source: source}
+ end
+
+ test "calls the expected URL", %{source: source} do
+ expect(HTTPClientMock, :get, fn url, headers ->
+ api_base = "https://youtube.googleapis.com/youtube/v3/playlistItems"
+ request_url = "#{api_base}?part=contentDetails&maxResults=50&playlistId=#{source.collection_id}&key=test_key"
+
+ assert url == request_url
+ assert headers == [accept: "application/json"]
+
+ {:ok, "{}"}
+ end)
+
+ assert {:ok, _} = YoutubeApi.get_recent_media_ids(source)
+ end
+
+ test "replaces channel IDs with playlist IDs if needed" do
+ source = source_fixture(collection_id: "UC_ABC123")
+
+ expect(HTTPClientMock, :get, fn url, _headers ->
+ assert url =~ "playlistId=UU_ABC123&"
+
+ {:ok, "{}"}
+ end)
+
+ assert {:ok, _} = YoutubeApi.get_recent_media_ids(source)
+ end
+
+ test "returns an empty list if no media is returned", %{source: source} do
+ expect(HTTPClientMock, :get, fn _url, _headers -> {:ok, "{}"} end)
+
+ assert {:ok, []} = YoutubeApi.get_recent_media_ids(source)
+ end
+
+ test "returns media IDs if present", %{source: source} do
+ expect(HTTPClientMock, :get, fn _url, _headers ->
+ {:ok,
+ """
+ {
+ "items": [
+ {"contentDetails": {"videoId": "test_1"}},
+ {"contentDetails": {"videoId": "test_2"}}
+ ]
+ }
+ """}
+ end)
+
+ assert {:ok, ["test_1", "test_2"]} = YoutubeApi.get_recent_media_ids(source)
+ end
+
+ test "returns an error if the HTTP request fails", %{source: source} do
+ expect(HTTPClientMock, :get, fn _url, _headers -> {:error, "error"} end)
+
+ assert {:error, "error"} = YoutubeApi.get_recent_media_ids(source)
+ end
+ end
+end
diff --git a/test/pinchflat/fast_indexing/youtube_rss_test.exs b/test/pinchflat/fast_indexing/youtube_rss_test.exs
index a769498..20f9a4d 100644
--- a/test/pinchflat/fast_indexing/youtube_rss_test.exs
+++ b/test/pinchflat/fast_indexing/youtube_rss_test.exs
@@ -11,7 +11,13 @@ defmodule Pinchflat.FastIndexing.YoutubeRssTest do
{:ok, source: source}
end
- describe "get_recent_media_ids_from_rss/1" do
+ describe "enabled?/0" do
+ test "returns true" do
+ assert YoutubeRss.enabled?()
+ end
+ end
+
+ describe "get_recent_media_ids/1" do
test "calls the expected URL for channel sources" do
source = source_fixture(collection_type: :channel, collection_id: "channel_id")
@@ -21,7 +27,7 @@ defmodule Pinchflat.FastIndexing.YoutubeRssTest do
{:ok, ""}
end)
- assert {:ok, _} = YoutubeRss.get_recent_media_ids_from_rss(source)
+ assert {:ok, _} = YoutubeRss.get_recent_media_ids(source)
end
test "calls the expected URL for playlist sources" do
@@ -33,13 +39,13 @@ defmodule Pinchflat.FastIndexing.YoutubeRssTest do
{:ok, ""}
end)
- assert {:ok, _} = YoutubeRss.get_recent_media_ids_from_rss(source)
+ assert {:ok, _} = YoutubeRss.get_recent_media_ids(source)
end
test "returns an error if the HTTP request fails", %{source: source} do
expect(HTTPClientMock, :get, fn _url -> {:error, ""} end)
- assert {:error, "Failed to fetch RSS feed"} = YoutubeRss.get_recent_media_ids_from_rss(source)
+ assert {:error, "Failed to fetch RSS feed"} = YoutubeRss.get_recent_media_ids(source)
end
test "returns the media IDs from the RSS feed", %{source: source} do
@@ -47,7 +53,7 @@ defmodule Pinchflat.FastIndexing.YoutubeRssTest do
{:ok, "test_1test_2"}
end)
- assert {:ok, ["test_1", "test_2"]} = YoutubeRss.get_recent_media_ids_from_rss(source)
+ assert {:ok, ["test_1", "test_2"]} = YoutubeRss.get_recent_media_ids(source)
end
test "strips whitespace from media IDs", %{source: source} do
@@ -55,7 +61,7 @@ defmodule Pinchflat.FastIndexing.YoutubeRssTest do
{:ok, " test_1 test_2 "}
end)
- assert {:ok, ["test_1", "test_2"]} = YoutubeRss.get_recent_media_ids_from_rss(source)
+ assert {:ok, ["test_1", "test_2"]} = YoutubeRss.get_recent_media_ids(source)
end
test "removes empty media IDs", %{source: source} do
@@ -63,7 +69,7 @@ defmodule Pinchflat.FastIndexing.YoutubeRssTest do
{:ok, "test_1"}
end)
- assert {:ok, ["test_1"]} = YoutubeRss.get_recent_media_ids_from_rss(source)
+ assert {:ok, ["test_1"]} = YoutubeRss.get_recent_media_ids(source)
end
test "removes duplicate media IDs", %{source: source} do
@@ -71,7 +77,7 @@ defmodule Pinchflat.FastIndexing.YoutubeRssTest do
{:ok, "test_1test_1"}
end)
- assert {:ok, ["test_1"]} = YoutubeRss.get_recent_media_ids_from_rss(source)
+ assert {:ok, ["test_1"]} = YoutubeRss.get_recent_media_ids(source)
end
end
end
diff --git a/test/pinchflat/lifecycle/user_scripts/command_runner_test.exs b/test/pinchflat/lifecycle/user_scripts/command_runner_test.exs
index 351f4c4..5a35faf 100644
--- a/test/pinchflat/lifecycle/user_scripts/command_runner_test.exs
+++ b/test/pinchflat/lifecycle/user_scripts/command_runner_test.exs
@@ -19,7 +19,7 @@ defmodule Pinchflat.Lifecycle.UserScripts.CommandRunnerTest do
File.write(filepath(), "#!/bin/bash\ntouch #{filename}\n")
refute File.exists?(filename)
- assert :ok = Runner.run(:media_downloaded, %{})
+ assert {:ok, _, _} = Runner.run(:media_downloaded, %{})
assert File.exists?(filename)
end
@@ -27,7 +27,7 @@ defmodule Pinchflat.Lifecycle.UserScripts.CommandRunnerTest do
tmp_dir = Application.get_env(:pinchflat, :tmpfile_directory)
File.write(filepath(), "#!/bin/bash\necho $1 > #{tmp_dir}/event_name\n")
- assert :ok = Runner.run(:media_downloaded, %{})
+ assert {:ok, _, _} = Runner.run(:media_downloaded, %{})
assert File.read!("#{tmp_dir}/event_name") == "media_downloaded\n"
end
@@ -35,26 +35,32 @@ defmodule Pinchflat.Lifecycle.UserScripts.CommandRunnerTest do
tmp_dir = Application.get_env(:pinchflat, :tmpfile_directory)
File.write(filepath(), "#!/bin/bash\necho $2 > #{tmp_dir}/encoded_data\n")
- assert :ok = Runner.run(:media_downloaded, %{foo: "bar"})
+ assert {:ok, _, _} = Runner.run(:media_downloaded, %{foo: "bar"})
assert File.read!("#{tmp_dir}/encoded_data") == "{\"foo\":\"bar\"}\n"
end
test "does nothing if the lifecycle file is not present" do
:ok = File.rm(filepath())
- assert :ok = Runner.run(:media_downloaded, %{})
+ assert {:ok, :no_executable} = Runner.run(:media_downloaded, %{})
end
test "does nothing if the lifecycle file is empty" do
File.write(filepath(), "")
- assert :ok = Runner.run(:media_downloaded, %{})
+ assert {:ok, :no_executable} = Runner.run(:media_downloaded, %{})
end
test "returns :ok if the command exits with a non-zero status" do
File.write(filepath(), "#!/bin/bash\nexit 1\n")
- assert :ok = Runner.run(:media_downloaded, %{})
+ assert {:ok, _, 1} = Runner.run(:media_downloaded, %{})
+ end
+
+ test "returns the output of the command" do
+ File.write(filepath(), "#!/bin/bash\necho 'hello'\n")
+
+ assert {:ok, "hello\n", 0} = Runner.run(:media_downloaded, %{})
end
test "gets upset if you pass an invalid event type" do
diff --git a/test/pinchflat/media_test.exs b/test/pinchflat/media_test.exs
index b3c9aa0..597309f 100644
--- a/test/pinchflat/media_test.exs
+++ b/test/pinchflat/media_test.exs
@@ -41,99 +41,7 @@ defmodule Pinchflat.MediaTest do
end
end
- describe "list_cullable_media_items/0" do
- test "returns media items where the source has a retention period" do
- source_one = source_fixture(%{retention_period_days: 2})
- source_two = source_fixture(%{retention_period_days: 0})
- source_three = source_fixture(%{retention_period_days: nil})
-
- _media_item =
- media_item_fixture(%{
- source_id: source_two.id,
- media_filepath: "/video/#{Faker.File.file_name(:video)}",
- media_downloaded_at: now_minus(3, :days)
- })
-
- _media_item =
- media_item_fixture(%{
- source_id: source_three.id,
- media_filepath: "/video/#{Faker.File.file_name(:video)}",
- media_downloaded_at: now_minus(3, :days)
- })
-
- expected_media_item =
- media_item_fixture(%{
- source_id: source_one.id,
- media_filepath: "/video/#{Faker.File.file_name(:video)}",
- media_downloaded_at: now_minus(3, :days)
- })
-
- assert Media.list_cullable_media_items() == [expected_media_item]
- end
-
- test "returns media_items with a media_filepath" do
- source = source_fixture(%{retention_period_days: 2})
-
- _media_item =
- media_item_fixture(%{
- source_id: source.id,
- media_filepath: nil,
- media_downloaded_at: now_minus(3, :days)
- })
-
- expected_media_item =
- media_item_fixture(%{
- source_id: source.id,
- media_filepath: "/video/#{Faker.File.file_name(:video)}",
- media_downloaded_at: now_minus(3, :days)
- })
-
- assert Media.list_cullable_media_items() == [expected_media_item]
- end
-
- test "returns items that have passed their retention period" do
- source = source_fixture(%{retention_period_days: 2})
-
- _media_item =
- media_item_fixture(%{
- source_id: source.id,
- media_filepath: "/video/#{Faker.File.file_name(:video)}",
- media_downloaded_at: now_minus(2, :days)
- })
-
- expected_media_item =
- media_item_fixture(%{
- source_id: source.id,
- media_filepath: "/video/#{Faker.File.file_name(:video)}",
- media_downloaded_at: now_minus(3, :days)
- })
-
- assert Media.list_cullable_media_items() == [expected_media_item]
- end
-
- test "doesn't return items that are set to prevent culling" do
- source = source_fixture(%{retention_period_days: 2})
-
- _media_item =
- media_item_fixture(%{
- source_id: source.id,
- media_filepath: "/video/#{Faker.File.file_name(:video)}",
- media_downloaded_at: now_minus(3, :days),
- prevent_culling: true
- })
-
- expected_media_item =
- media_item_fixture(%{
- source_id: source.id,
- media_filepath: "/video/#{Faker.File.file_name(:video)}",
- media_downloaded_at: now_minus(3, :days)
- })
-
- assert Media.list_cullable_media_items() == [expected_media_item]
- end
- end
-
- describe "list_redownloadable_media_items/0" do
+ describe "list_upgradeable_media_items/0" do
setup do
media_profile = media_profile_fixture(%{redownload_delay_days: 4})
source = source_fixture(%{media_profile_id: media_profile.id, inserted_at: now_minus(10, :days)})
@@ -149,7 +57,7 @@ defmodule Pinchflat.MediaTest do
media_downloaded_at: now_minus(5, :days)
})
- assert Media.list_redownloadable_media_items() == [media_item]
+ assert Media.list_upgradeable_media_items() == [media_item]
end
test "returns media items that were downloaded in past but still meet redownload delay", %{source: source} do
@@ -160,7 +68,7 @@ defmodule Pinchflat.MediaTest do
media_downloaded_at: now_minus(19, :days)
})
- assert Media.list_redownloadable_media_items() == [media_item]
+ assert Media.list_upgradeable_media_items() == [media_item]
end
test "does not return media items without a media_downloaded_at", %{source: source} do
@@ -171,7 +79,7 @@ defmodule Pinchflat.MediaTest do
media_downloaded_at: nil
})
- assert Media.list_redownloadable_media_items() == []
+ assert Media.list_upgradeable_media_items() == []
end
test "does not return media items that are set to prevent download", %{source: source} do
@@ -183,7 +91,7 @@ defmodule Pinchflat.MediaTest do
prevent_download: true
})
- assert Media.list_redownloadable_media_items() == []
+ assert Media.list_upgradeable_media_items() == []
end
test "does not return media items that have been culled", %{source: source} do
@@ -195,7 +103,7 @@ defmodule Pinchflat.MediaTest do
culled_at: now()
})
- assert Media.list_redownloadable_media_items() == []
+ assert Media.list_upgradeable_media_items() == []
end
test "does not return media items before the download delay", %{source: source} do
@@ -206,7 +114,7 @@ defmodule Pinchflat.MediaTest do
media_downloaded_at: now_minus(3, :days)
})
- assert Media.list_redownloadable_media_items() == []
+ assert Media.list_upgradeable_media_items() == []
end
test "does not return media items that have already been redownloaded", %{source: source} do
@@ -218,7 +126,7 @@ defmodule Pinchflat.MediaTest do
media_redownloaded_at: now()
})
- assert Media.list_redownloadable_media_items() == []
+ assert Media.list_upgradeable_media_items() == []
end
test "does not return media items that were first downloaded well after the uploaded_at", %{source: source} do
@@ -229,7 +137,7 @@ defmodule Pinchflat.MediaTest do
uploaded_at: now_minus(20, :days)
})
- assert Media.list_redownloadable_media_items() == []
+ assert Media.list_upgradeable_media_items() == []
end
test "does not return media items that were recently uploaded", %{source: source} do
@@ -240,7 +148,7 @@ defmodule Pinchflat.MediaTest do
uploaded_at: now_minus(2, :days)
})
- assert Media.list_redownloadable_media_items() == []
+ assert Media.list_upgradeable_media_items() == []
end
test "does not return media items without a redownload delay" do
@@ -254,7 +162,7 @@ defmodule Pinchflat.MediaTest do
media_downloaded_at: now_minus(5, :days)
})
- assert Media.list_redownloadable_media_items() == []
+ assert Media.list_upgradeable_media_items() == []
end
end
@@ -689,7 +597,24 @@ defmodule Pinchflat.MediaTest do
assert {:ok, %MediaItem{} = media_item_2} = Media.create_media_item_from_backend_attrs(source, different_attrs)
assert media_item_1.id == media_item_2.id
- assert media_item_2.title == different_attrs.title
+ assert Repo.reload(media_item_2).title == different_attrs.title
+ end
+
+ test "doesn't update fields like playlist_index" do
+ source = source_fixture()
+
+ media_attrs =
+ media_attributes_return_fixture()
+ |> Phoenix.json_library().decode!()
+ |> Map.put("playlist_index", 1)
+ |> YtDlpMedia.response_to_struct()
+
+ different_attrs = %YtDlpMedia{media_attrs | playlist_index: 9999}
+
+ assert {:ok, %MediaItem{} = _media_item_1} = Media.create_media_item_from_backend_attrs(source, media_attrs)
+ assert {:ok, %MediaItem{} = media_item_2} = Media.create_media_item_from_backend_attrs(source, different_attrs)
+
+ assert Repo.reload(media_item_2).playlist_index == media_attrs.playlist_index
end
end
@@ -740,14 +665,13 @@ defmodule Pinchflat.MediaTest do
end
test "does delete the media item's metadata files" do
- stub(HTTPClientMock, :get, fn _url, _headers, _opts -> {:ok, ""} end)
+ stub(YtDlpRunnerMock, :run, fn _url, _opts, _ot -> {:ok, ""} end)
media_item = Repo.preload(media_item_with_attachments(), :metadata)
update_attrs = %{
metadata: %{
metadata_filepath: MetadataFileHelpers.compress_and_store_metadata_for(media_item, %{}),
- thumbnail_filepath:
- MetadataFileHelpers.download_and_store_thumbnail_for(media_item, render_parsed_metadata(:media_metadata))
+ thumbnail_filepath: MetadataFileHelpers.download_and_store_thumbnail_for(media_item)
}
}
@@ -760,7 +684,7 @@ defmodule Pinchflat.MediaTest do
describe "delete_media_item/2 when testing file deletion" do
setup do
- stub(UserScriptRunnerMock, :run, fn _event_type, _data -> :ok end)
+ stub(UserScriptRunnerMock, :run, fn _event_type, _data -> {:ok, "", 0} end)
:ok
end
@@ -773,14 +697,13 @@ defmodule Pinchflat.MediaTest do
end
test "deletes the media item's metadata files" do
- stub(HTTPClientMock, :get, fn _url, _headers, _opts -> {:ok, ""} end)
+ stub(YtDlpRunnerMock, :run, fn _url, _opts, _ot -> {:ok, ""} end)
media_item = Repo.preload(media_item_with_attachments(), :metadata)
update_attrs = %{
metadata: %{
metadata_filepath: MetadataFileHelpers.compress_and_store_metadata_for(media_item, %{}),
- thumbnail_filepath:
- MetadataFileHelpers.download_and_store_thumbnail_for(media_item, render_parsed_metadata(:media_metadata))
+ thumbnail_filepath: MetadataFileHelpers.download_and_store_thumbnail_for(media_item)
}
}
@@ -822,7 +745,7 @@ defmodule Pinchflat.MediaTest do
expect(UserScriptRunnerMock, :run, fn :media_deleted, data ->
assert data.id == media_item.id
- :ok
+ {:ok, "", 0}
end)
assert {:ok, _} = Media.delete_media_item(media_item, delete_files: true)
@@ -831,7 +754,7 @@ defmodule Pinchflat.MediaTest do
describe "delete_media_files/2" do
setup do
- stub(UserScriptRunnerMock, :run, fn _event_type, _data -> :ok end)
+ stub(UserScriptRunnerMock, :run, fn _event_type, _data -> {:ok, "", 0} end)
:ok
end
@@ -860,14 +783,13 @@ defmodule Pinchflat.MediaTest do
end
test "does not delete the media item's metadata files" do
- stub(HTTPClientMock, :get, fn _url, _headers, _opts -> {:ok, ""} end)
+ stub(YtDlpRunnerMock, :run, fn _url, _opts, _ot -> {:ok, ""} end)
media_item = Repo.preload(media_item_with_attachments(), :metadata)
update_attrs = %{
metadata: %{
metadata_filepath: MetadataFileHelpers.compress_and_store_metadata_for(media_item, %{}),
- thumbnail_filepath:
- MetadataFileHelpers.download_and_store_thumbnail_for(media_item, render_parsed_metadata(:media_metadata))
+ thumbnail_filepath: MetadataFileHelpers.download_and_store_thumbnail_for(media_item)
}
}
@@ -895,7 +817,7 @@ defmodule Pinchflat.MediaTest do
expect(UserScriptRunnerMock, :run, fn :media_deleted, data ->
assert data.id == media_item.id
- :ok
+ {:ok, "", 0}
end)
assert {:ok, _} = Media.delete_media_files(media_item)
@@ -970,6 +892,18 @@ defmodule Pinchflat.MediaTest do
assert updated_media_item.upload_date_index == 99
end
+
+ test "upload_date_index doesn't increment if the a video's upload_date is changed to the same day" do
+ source = source_fixture(%{collection_type: :channel})
+
+ media_item_one = media_item_fixture(%{source_id: source.id, uploaded_at: now()})
+ _media_item_two = media_item_fixture(%{source_id: source.id, uploaded_at: now()})
+
+ {:ok, updated_media_item} =
+ Media.update_media_item(media_item_one, %{uploaded_at: now_plus(1, :minute), title: "New title"})
+
+ assert updated_media_item.upload_date_index == 99
+ end
end
describe "change_media_item/1 when testing upload_date_index and source is a playlist" do
@@ -1033,5 +967,17 @@ defmodule Pinchflat.MediaTest do
assert updated_media_item.upload_date_index == 0
end
+
+ test "upload_date_index doesn't increment if the a video's upload_date is changed to the same day" do
+ source = source_fixture(%{collection_type: :playlist})
+
+ media_item_one = media_item_fixture(%{source_id: source.id, uploaded_at: now()})
+ _media_item_two = media_item_fixture(%{source_id: source.id, uploaded_at: now()})
+
+ {:ok, updated_media_item} =
+ Media.update_media_item(media_item_one, %{uploaded_at: now_plus(1, :minute), title: "New title"})
+
+ assert updated_media_item.upload_date_index == 0
+ end
end
end
diff --git a/test/pinchflat/metadata/metadata_file_helpers_test.exs b/test/pinchflat/metadata/metadata_file_helpers_test.exs
index 4052703..b1b8b2b 100644
--- a/test/pinchflat/metadata/metadata_file_helpers_test.exs
+++ b/test/pinchflat/metadata/metadata_file_helpers_test.exs
@@ -11,6 +11,16 @@ defmodule Pinchflat.Metadata.MetadataFileHelpersTest do
{:ok, %{media_item: media_item}}
end
+ describe "metadata_directory_for/1" do
+ test "returns the metadata directory for the given record", %{media_item: media_item} do
+ base_metadata_directory = Application.get_env(:pinchflat, :metadata_directory)
+
+ metadata_directory = Helpers.metadata_directory_for(media_item)
+
+ assert metadata_directory == Path.join([base_metadata_directory, "media_items", "#{media_item.id}"])
+ end
+ end
+
describe "compress_and_store_metadata_for/2" do
test "returns the filepath", %{media_item: media_item} do
metadata_map = %{"foo" => "bar"}
@@ -32,7 +42,7 @@ defmodule Pinchflat.Metadata.MetadataFileHelpersTest do
metadata_map = %{"foo" => "bar"}
filepath = Helpers.compress_and_store_metadata_for(media_item, metadata_map)
- {:ok, json} = File.open(filepath, [:read, :compressed], &IO.read(&1, :all))
+ {:ok, json} = File.open(filepath, [:read, :compressed], &IO.read(&1, :eof))
assert json == Phoenix.json_library().encode!(metadata_map)
end
@@ -50,82 +60,37 @@ defmodule Pinchflat.Metadata.MetadataFileHelpersTest do
end
describe "download_and_store_thumbnail_for/2" do
- setup do
- # This tests that the HTTP endpoint is being called with every test
- expect(HTTPClientMock, :get, fn _url, _headers, _opts ->
- {:ok, "thumbnail data"}
+ test "returns the filepath", %{media_item: media_item} do
+ stub(YtDlpRunnerMock, :run, fn _url, _opts, _ot -> {:ok, ""} end)
+
+ filepath = Helpers.download_and_store_thumbnail_for(media_item)
+
+ assert filepath =~ ~r{/media_items/#{media_item.id}/thumbnail.jpg}
+ end
+
+ test "calls yt-dlp with the expected options", %{media_item: media_item} do
+ expect(YtDlpRunnerMock, :run, fn url, opts, ot ->
+ assert url == media_item.original_url
+ assert ot == "after_move:%()j"
+
+ assert opts == [
+ :no_simulate,
+ :skip_download,
+ :write_thumbnail,
+ convert_thumbnail: "jpg",
+ output: "/tmp/test/metadata/media_items/1/thumbnail.%(ext)s"
+ ]
+
+ {:ok, ""}
end)
- metadata = render_parsed_metadata(:media_metadata)
-
- {:ok, %{metadata: metadata}}
+ Helpers.download_and_store_thumbnail_for(media_item)
end
- test "returns the filepath", %{media_item: media_item, metadata: metadata} do
- filepath = Helpers.download_and_store_thumbnail_for(media_item, metadata)
+ test "returns nil if yt-dlp fails", %{media_item: media_item} do
+ stub(YtDlpRunnerMock, :run, fn _url, _opts, _ot -> {:error, "error"} end)
- assert filepath =~ ~r{/media_items/#{media_item.id}/maxresdefault.jpg}
- end
-
- test "creates folder structure based on passed record", %{media_item: media_item, metadata: metadata} do
- filepath = Helpers.download_and_store_thumbnail_for(media_item, metadata)
-
- assert File.exists?(Path.dirname(filepath))
- end
-
- test "chooses the highest preference jpg thumbnail available", %{media_item: media_item} do
- metadata = %{
- "thumbnails" => [
- %{"url" => "https://i.ytimg.com/vi/ABC123/img_1.jpg", "preference" => -1},
- %{"url" => "https://i.ytimg.com/vi/ABC123/img_2.jpg", "preference" => 1},
- %{"url" => "https://i.ytimg.com/vi/ABC123/img_3.jpg", "preference" => -10},
- %{"url" => "https://i.ytimg.com/vi/ABC123/img_4.webp", "preference" => 10}
- ]
- }
-
- filepath = Helpers.download_and_store_thumbnail_for(media_item, metadata)
-
- assert filepath =~ ~r{/media_items/#{media_item.id}/img_2.jpg}
- end
-
- test "will fall back to a non-jpg if it has to", %{media_item: media_item} do
- metadata = %{
- "thumbnails" => [
- %{"url" => "https://i.ytimg.com/vi/ABC123/img_1.webp", "preference" => -1}
- ]
- }
-
- filepath = Helpers.download_and_store_thumbnail_for(media_item, metadata)
-
- assert filepath =~ ~r{/media_items/#{media_item.id}/img_1.webp}
- end
-
- test "does not require a preference field", %{media_item: media_item} do
- metadata = %{
- "thumbnails" => [
- %{"url" => "https://i.ytimg.com/vi/ABC123/img_1.webp"}
- ]
- }
-
- filepath = Helpers.download_and_store_thumbnail_for(media_item, metadata)
-
- assert filepath =~ ~r{/media_items/#{media_item.id}/img_1.webp}
- end
- end
-
- describe "download_and_store_thumbnail_for/2 when not downloading thumbnails" do
- test "returns nil if there are no thumbnails", %{media_item: media_item} do
- metadata = %{"thumbnails" => []}
-
- filepath = Helpers.download_and_store_thumbnail_for(media_item, metadata)
-
- assert filepath == nil
- end
-
- test "returns nil if there is no thumbnail field", %{media_item: media_item} do
- metadata = %{}
-
- filepath = Helpers.download_and_store_thumbnail_for(media_item, metadata)
+ filepath = Helpers.download_and_store_thumbnail_for(media_item)
assert filepath == nil
end
@@ -187,13 +152,20 @@ defmodule Pinchflat.Metadata.MetadataFileHelpersTest do
end
end
- describe "metadata_directory_for/1" do
- test "returns the metadata directory for the given record", %{media_item: media_item} do
- base_metadata_directory = Application.get_env(:pinchflat, :metadata_directory)
+ describe "season_and_episode_from_media_filepath/1" do
+ test "returns a season and episode if one can be determined" do
+ assert {:ok, {"1", "2"}} = Helpers.season_and_episode_from_media_filepath("/foo/s1e2 - test.mp4")
+ assert {:ok, {"1", "2"}} = Helpers.season_and_episode_from_media_filepath("/foo/S1E2 - test.mp4")
+ assert {:ok, {"001", "002"}} = Helpers.season_and_episode_from_media_filepath("/foo/s001e002 - test.mp4")
+ assert {:ok, {"1", "2"}} = Helpers.season_and_episode_from_media_filepath("/foo/s1e2bar - test.mp4")
+ assert {:ok, {"1", "2"}} = Helpers.season_and_episode_from_media_filepath("/foo/bar s1e2 - test.mp4")
+ end
- metadata_directory = Helpers.metadata_directory_for(media_item)
-
- assert metadata_directory == Path.join([base_metadata_directory, "media_items", "#{media_item.id}"])
+ test "returns an error if a season and episode can't be determined" do
+ assert {:error, :indeterminable} = Helpers.season_and_episode_from_media_filepath("/foo/test.mp4")
+ assert {:error, :indeterminable} = Helpers.season_and_episode_from_media_filepath("/foo/s1 - test.mp4")
+ assert {:error, :indeterminable} = Helpers.season_and_episode_from_media_filepath("/foo/s1e - test.mp4")
+ assert {:error, :indeterminable} = Helpers.season_and_episode_from_media_filepath("/foo/s1etest.mp4")
end
end
end
diff --git a/test/pinchflat/metadata/nfo_builder_test.exs b/test/pinchflat/metadata/nfo_builder_test.exs
index c8b032a..47217c7 100644
--- a/test/pinchflat/metadata/nfo_builder_test.exs
+++ b/test/pinchflat/metadata/nfo_builder_test.exs
@@ -5,7 +5,7 @@ defmodule Pinchflat.Metadata.NfoBuilderTest do
alias Pinchflat.Utils.FilesystemUtils
setup do
- filepath = FilesystemUtils.generate_metadata_tmpfile(:json)
+ filepath = FilesystemUtils.generate_metadata_tmpfile(:nfo)
on_exit(fn -> File.rm!(filepath) end)
@@ -45,6 +45,43 @@ defmodule Pinchflat.Metadata.NfoBuilderTest do
assert String.contains?(nfo, "hello' & <world>")
end
+
+ test "uses the season and episode number from the filepath if it can be determined" do
+ metadata = %{
+ "title" => "title",
+ "uploader" => "uploader",
+ "id" => "id",
+ "description" => "description",
+ "upload_date" => "20210101"
+ }
+
+ tmpfile_directory = Application.get_env(:pinchflat, :tmpfile_directory)
+ filepath = Path.join([tmpfile_directory, "foo/s0123e456.nfo"])
+
+ result = NfoBuilder.build_and_store_for_media_item(filepath, metadata)
+ nfo = File.read!(result)
+
+ assert String.contains?(nfo, "0123")
+ assert String.contains?(nfo, "456")
+
+ File.rm!(filepath)
+ end
+
+ test "uses the upload date if the season and episode number can't be determined", %{filepath: filepath} do
+ metadata = %{
+ "title" => "title",
+ "uploader" => "uploader",
+ "id" => "id",
+ "description" => "description",
+ "upload_date" => "20210101"
+ }
+
+ result = NfoBuilder.build_and_store_for_media_item(filepath, metadata)
+ nfo = File.read!(result)
+
+ assert String.contains?(nfo, "2021")
+ assert String.contains?(nfo, "0101")
+ end
end
describe "build_and_store_for_source/2" do
diff --git a/test/pinchflat/metadata/source_image_parser_test.exs b/test/pinchflat/metadata/source_image_parser_test.exs
index 8ec3c6c..3f815ae 100644
--- a/test/pinchflat/metadata/source_image_parser_test.exs
+++ b/test/pinchflat/metadata/source_image_parser_test.exs
@@ -75,4 +75,51 @@ defmodule Pinchflat.Metadata.SourceImageParserTest do
assert SourceImageParser.store_source_images(@base_dir, metadata) == %{}
end
end
+
+ describe "store_source_images/2 when testing fallbacks" do
+ test "uses the entries list for a fallback poster if needed" do
+ metadata = %{
+ "thumbnails" => [],
+ "entries" => [
+ %{
+ "thumbnails" => [%{"filepath" => "/app/test/support/files/channel_photos/a.0.jpg"}]
+ }
+ ]
+ }
+
+ expected = %{
+ poster_filepath: "#{@base_dir}/poster.jpg"
+ }
+
+ assert SourceImageParser.store_source_images(@base_dir, metadata) == expected
+ end
+
+ test "doesn't blow up if the entries list doesn't have any suitable thumbnails" do
+ metadata = %{
+ "thumbnails" => [],
+ "entries" => [
+ %{"thumbnails" => [%{"id" => "1"}]}
+ ]
+ }
+
+ assert SourceImageParser.store_source_images(@base_dir, metadata) == %{}
+ end
+
+ test "doesn't use the entries list if it's empty" do
+ metadata = %{
+ "thumbnails" => [],
+ "entries" => []
+ }
+
+ assert SourceImageParser.store_source_images(@base_dir, metadata) == %{}
+ end
+
+ test "doesn't use the entries list if it's not present" do
+ metadata = %{
+ "thumbnails" => []
+ }
+
+ assert SourceImageParser.store_source_images(@base_dir, metadata) == %{}
+ end
+ end
end
diff --git a/test/pinchflat/metadata/source_metadata_storage_worker_test.exs b/test/pinchflat/metadata/source_metadata_storage_worker_test.exs
index 503d0f3..d8b0324 100644
--- a/test/pinchflat/metadata/source_metadata_storage_worker_test.exs
+++ b/test/pinchflat/metadata/source_metadata_storage_worker_test.exs
@@ -143,7 +143,9 @@ defmodule Pinchflat.Metadata.SourceMetadataStorageWorkerTest do
{:ok, source_details_return_fixture(%{filename: filename})}
- _url, _opts, ot when ot == @metadata_ot ->
+ _url, opts, ot when ot == @metadata_ot ->
+ assert {:convert_thumbnails, "jpg"} in opts
+
{:ok, render_metadata(:channel_source_metadata)}
end)
@@ -164,6 +166,42 @@ defmodule Pinchflat.Metadata.SourceMetadataStorageWorkerTest do
Sources.delete_source(source, delete_files: true)
end
+ test "calls one set of yt-dlp metadata opts for channels" do
+ stub(YtDlpRunnerMock, :run, fn
+ _url, _opts, ot when ot == @source_details_ot ->
+ {:ok, source_details_return_fixture()}
+
+ _url, opts, ot when ot == @metadata_ot ->
+ assert {:playlist_items, 0} in opts
+ assert :write_all_thumbnails in opts
+
+ {:ok, render_metadata(:channel_source_metadata)}
+ end)
+
+ profile = media_profile_fixture(%{download_source_images: true})
+ source = source_fixture(media_profile_id: profile.id, collection_type: :channel)
+
+ perform_job(SourceMetadataStorageWorker, %{id: source.id})
+ end
+
+ test "calls another set of yt-dlp metadata opts for playlists" do
+ stub(YtDlpRunnerMock, :run, fn
+ _url, _opts, ot when ot == @source_details_ot ->
+ {:ok, source_details_return_fixture()}
+
+ _url, opts, ot when ot == @metadata_ot ->
+ assert {:playlist_items, 1} in opts
+ assert :write_thumbnail in opts
+
+ {:ok, render_metadata(:channel_source_metadata)}
+ end)
+
+ profile = media_profile_fixture(%{download_source_images: true})
+ source = source_fixture(media_profile_id: profile.id, collection_type: :playlist)
+
+ perform_job(SourceMetadataStorageWorker, %{id: source.id})
+ end
+
test "does not store source images if the profile is not set to" do
stub(YtDlpRunnerMock, :run, fn
_url, _opts, ot when ot == @source_details_ot ->
diff --git a/test/pinchflat/profiles_test.exs b/test/pinchflat/profiles_test.exs
index 4cf6437..6f78e7f 100644
--- a/test/pinchflat/profiles_test.exs
+++ b/test/pinchflat/profiles_test.exs
@@ -113,7 +113,7 @@ defmodule Pinchflat.ProfilesTest do
describe "delete_media_profile/2 when deleting files" do
setup do
- stub(UserScriptRunnerMock, :run, fn _event_type, _data -> :ok end)
+ stub(UserScriptRunnerMock, :run, fn _event_type, _data -> {:ok, "", 0} end)
:ok
end
diff --git a/test/pinchflat/settings_test.exs b/test/pinchflat/settings_test.exs
index 3c4d653..944eaf1 100644
--- a/test/pinchflat/settings_test.exs
+++ b/test/pinchflat/settings_test.exs
@@ -78,64 +78,4 @@ defmodule Pinchflat.SettingsTest do
assert %Ecto.Changeset{} = Settings.change_setting(setting, %{onboarding: true})
end
end
-
- describe "change_setting/2 when testing codec preferences" do
- test "converts (video|audio)_codec_preference_string to an array" do
- setting = Settings.record()
-
- new_setting = %{
- video_codec_preference_string: "avc>vp9",
- audio_codec_preference_string: "aac>opus"
- }
-
- changeset = Settings.change_setting(setting, new_setting)
-
- assert ["avc", "vp9"] = changeset.changes.video_codec_preference
- assert ["aac", "opus"] = changeset.changes.audio_codec_preference
- end
-
- test "removes whitespace from (video|audio)_codec_preference" do
- setting = Settings.record()
-
- new_setting = %{
- video_codec_preference_string: " avc > > vp9 ",
- audio_codec_preference_string: "aac> opus "
- }
-
- changeset = Settings.change_setting(setting, new_setting)
-
- assert ["avc", "vp9"] = changeset.changes.video_codec_preference
- assert ["aac", "opus"] = changeset.changes.audio_codec_preference
- end
-
- test "downcases (video|audio)_codec_preference" do
- setting = Settings.record()
-
- new_setting = %{
- video_codec_preference_string: "AVC>VP9",
- audio_codec_preference_string: "AAC>OPUS"
- }
-
- changeset = Settings.change_setting(setting, new_setting)
-
- assert ["avc", "vp9"] = changeset.changes.video_codec_preference
- assert ["aac", "opus"] = changeset.changes.audio_codec_preference
- end
-
- test "an empty value will remove the codec settings" do
- Settings.set(video_codec_preference: ["avc", "vp9"])
- Settings.set(audio_codec_preference: ["aac", "opus"])
- setting = Settings.record()
-
- new_setting = %{
- video_codec_preference_string: "",
- audio_codec_preference_string: ""
- }
-
- changeset = Settings.change_setting(setting, new_setting)
-
- assert [] = changeset.changes.video_codec_preference
- assert [] = changeset.changes.audio_codec_preference
- end
- end
end
diff --git a/test/pinchflat/sources_test.exs b/test/pinchflat/sources_test.exs
index a63c049..59e004b 100644
--- a/test/pinchflat/sources_test.exs
+++ b/test/pinchflat/sources_test.exs
@@ -617,7 +617,7 @@ defmodule Pinchflat.SourcesTest do
describe "delete_source/2 when deleting files" do
setup do
- stub(UserScriptRunnerMock, :run, fn _event_type, _data -> :ok end)
+ stub(UserScriptRunnerMock, :run, fn _event_type, _data -> {:ok, "", 0} end)
:ok
end
@@ -659,6 +659,83 @@ defmodule Pinchflat.SourcesTest do
end
end
+ describe "change_source/3 when testing regex validation" do
+ test "succeeds when a valid regex is provided" do
+ source = source_fixture()
+
+ assert %{errors: []} = Sources.change_source(source, %{title_filter_regex: "(?i)^How to Bike$"})
+ end
+
+ test "succeeds when a regex is set back to nil" do
+ source = source_fixture(%{title_filter_regex: "(?i)^How to Bike$"})
+
+ assert %{errors: []} = Sources.change_source(source, %{title_filter_regex: nil})
+ end
+
+ test "fails when an invalid regex is provided" do
+ source = source_fixture()
+
+ changeset = Sources.change_source(source, %{title_filter_regex: "*FOO"})
+
+ assert "is invalid" in errors_on(changeset).title_filter_regex
+ end
+ end
+
+ describe "change_source/3 when testing original_url validation" do
+ test "succeeds when an original URL is valid" do
+ source = source_fixture()
+
+ valid_urls = [
+ "https://www.youtube.com/channel/UCkRfArvrzheW2E7b6SVT7vQ",
+ "https://www.youtube.com/channel/UCkRfArvrzheW2E7b6SVT7vQ/videos",
+ "https://www.youtube.com/@youtubecreators/featured",
+ "https://www.youtube.com/@youtubecreators",
+ "https://www.youtube.com/c/YouTubeCreators",
+ "https://www.youtube.com/user/YouTubeCreators",
+ "https://www.youtube.com/YouTubeCreators",
+ "https://www.youtube.com/playlist?list=PLpjK416fmKwRtq-9-O_NbZlkW0k6zu2Wn",
+ "https://www.youtube.com/playlist?list=UUkRfArvrzheW2E7b6SVT7vQ"
+ ]
+
+ Enum.each(valid_urls, fn url ->
+ assert %{errors: []} = Sources.change_source(source, %{original_url: url})
+ end)
+ end
+
+ test "fails when an original URL points to a video" do
+ source = source_fixture()
+
+ invalid_urls = [
+ "https://www.youtube.com/watch?v=72maj9FLQZI",
+ "https://youtu.be/72maj9FLQZI",
+ "https://www.youtube.com/watch?v=1FwGFhMAmBo&list=PLpjK416fmKwRtq-9-O_NbZlkW0k6zu2Wn",
+ "https://www.youtube.com/shorts/Dq0eH-ZhQTU",
+ "https://www.youtube.com/embed/X64LHlfx4qg"
+ ]
+
+ Enum.each(invalid_urls, fn url ->
+ assert %{errors: [_]} = Sources.change_source(source, %{original_url: url})
+ end)
+ end
+
+ test "passes when a non-youtube link is provided" do
+ source = source_fixture()
+
+ valid_urls = [
+ "https://www.example.com",
+ "https://www.example.com/playlist",
+ "https://www.example.com/channel",
+ "https://www.example.com/user",
+ "https://www.example.com/watch?v=72maj9FLQZI",
+ "https://www.example.com/embed/X64LHlfx4qg"
+ ]
+
+ Enum.each(valid_urls, fn url ->
+ assert %{errors: []} = Sources.change_source(source, %{original_url: url})
+ end)
+ end
+ end
+
defp playlist_mock(_url, _opts, _ot) do
{
:ok,
diff --git a/test/pinchflat/yt_dlp/media_collection_test.exs b/test/pinchflat/yt_dlp/media_collection_test.exs
index fa69e58..f08c649 100644
--- a/test/pinchflat/yt_dlp/media_collection_test.exs
+++ b/test/pinchflat/yt_dlp/media_collection_test.exs
@@ -129,7 +129,7 @@ defmodule Pinchflat.YtDlp.MediaCollectionTest do
test "it passes the expected args to the backend runner" do
expect(YtDlpRunnerMock, :run, fn @channel_url, opts, ot ->
- assert opts == [playlist_items: 0]
+ assert opts == [:skip_download, playlist_items: 0]
assert ot == "playlist:%()j"
{:ok, "{}"}
@@ -152,12 +152,18 @@ defmodule Pinchflat.YtDlp.MediaCollectionTest do
test "allows you to pass additional opts" do
expect(YtDlpRunnerMock, :run, fn _url, opts, _ot ->
- assert opts == [playlist_items: 0, real_opt: :yup]
+ assert opts == [:skip_download, playlist_items: 1, real_opt: :yup]
{:ok, "{}"}
end)
- assert {:ok, _} = MediaCollection.get_source_metadata(@channel_url, real_opt: :yup)
+ assert {:ok, _} = MediaCollection.get_source_metadata(@channel_url, playlist_items: 1, real_opt: :yup)
+ end
+
+ test "blows up if you pass addl opts but don't pass playlist items" do
+ assert_raise KeyError, fn ->
+ MediaCollection.get_source_metadata(@channel_url, real_opt: :yup)
+ end
end
end
end
diff --git a/test/pinchflat/yt_dlp/media_test.exs b/test/pinchflat/yt_dlp/media_test.exs
index ee22974..1e8b110 100644
--- a/test/pinchflat/yt_dlp/media_test.exs
+++ b/test/pinchflat/yt_dlp/media_test.exs
@@ -7,8 +7,8 @@ defmodule Pinchflat.YtDlp.MediaTest do
@media_url "https://www.youtube.com/watch?v=TiZPUDkDYbk"
- describe "download/2" do
- test "it calls the backend runner with the expected arguments" do
+ describe "download/3" do
+ test "calls the backend runner with the expected arguments" do
expect(YtDlpRunnerMock, :run, fn @media_url, opts, ot, addl ->
assert [:no_simulate] = opts
assert "after_move:%()j" = ot
@@ -20,7 +20,7 @@ defmodule Pinchflat.YtDlp.MediaTest do
assert {:ok, _} = Media.download(@media_url)
end
- test "it passes along additional options" do
+ test "passes along additional options" do
expect(YtDlpRunnerMock, :run, fn _url, opts, _ot, addl ->
assert [:no_simulate, :custom_arg] = opts
assert [addl_arg: true] = addl
@@ -31,7 +31,7 @@ defmodule Pinchflat.YtDlp.MediaTest do
assert {:ok, _} = Media.download(@media_url, [:custom_arg], addl_arg: true)
end
- test "it parses and returns the generated file as JSON" do
+ test "parses and returns the generated file as JSON" do
expect(YtDlpRunnerMock, :run, fn _url, _opts, _ot, _addl ->
{:ok, render_metadata(:media_metadata)}
end)
@@ -40,7 +40,7 @@ defmodule Pinchflat.YtDlp.MediaTest do
Media.download(@media_url)
end
- test "it returns errors" do
+ test "returns errors" do
expect(YtDlpRunnerMock, :run, fn _url, _opt, _ot, _addl ->
{:error, "something"}
end)
@@ -49,6 +49,37 @@ defmodule Pinchflat.YtDlp.MediaTest do
end
end
+ describe "download_thumbnail/2" do
+ test "calls the backend runner with the expected arguments" do
+ expect(YtDlpRunnerMock, :run, fn @media_url, opts, ot ->
+ assert opts == [:no_simulate, :skip_download, :write_thumbnail, {:convert_thumbnail, "jpg"}]
+ assert ot == "after_move:%()j"
+
+ {:ok, ""}
+ end)
+
+ assert {:ok, _} = Media.download_thumbnail(@media_url)
+ end
+
+ test "passes along additional options" do
+ expect(YtDlpRunnerMock, :run, fn _url, opts, _ot ->
+ assert :custom_arg in opts
+
+ {:ok, "{}"}
+ end)
+
+ assert {:ok, _} = Media.download_thumbnail(@media_url, [:custom_arg])
+ end
+
+ test "returns errors" do
+ expect(YtDlpRunnerMock, :run, fn _url, _opt, _ot ->
+ {:error, "something"}
+ end)
+
+ assert {:error, "something"} = Media.download_thumbnail(@media_url)
+ end
+ end
+
describe "get_media_attributes/1" do
test "returns a list of video attributes" do
expect(YtDlpRunnerMock, :run, fn _url, _opts, _ot ->
@@ -79,8 +110,10 @@ defmodule Pinchflat.YtDlp.MediaTest do
describe "indexing_output_template/0" do
test "contains all the greatest hits" do
- assert "%(.{id,title,was_live,webpage_url,description,aspect_ratio,duration,upload_date,timestamp})j" ==
- Media.indexing_output_template()
+ attrs = ~w(id title was_live webpage_url description aspect_ratio duration upload_date timestamp playlist_index)a
+ formatted_attrs = "%(.{#{Enum.join(attrs, ",")}})j"
+
+ assert formatted_attrs == Media.indexing_output_template()
end
end
@@ -95,7 +128,8 @@ defmodule Pinchflat.YtDlp.MediaTest do
"aspect_ratio" => 1.0,
"duration" => 60,
"upload_date" => "20210101",
- "timestamp" => 1_600_000_000
+ "timestamp" => 1_600_000_000,
+ "playlist_index" => 1
}
assert %Media{
@@ -106,7 +140,8 @@ defmodule Pinchflat.YtDlp.MediaTest do
livestream: false,
short_form_content: false,
uploaded_at: ~U[2020-09-13 12:26:40Z],
- duration_seconds: 60
+ duration_seconds: 60,
+ playlist_index: 1
} == Media.response_to_struct(response)
end
@@ -186,6 +221,17 @@ defmodule Pinchflat.YtDlp.MediaTest do
assert %Media{livestream: false} = Media.response_to_struct(response)
end
+
+ test "doesn't blow up if playlist_index is missing" do
+ response = %{
+ "webpage_url" => "https://www.youtube.com/watch?v=TiZPUDkDYbk",
+ "aspect_ratio" => 1.0,
+ "duration" => nil,
+ "upload_date" => "20210101"
+ }
+
+ assert %Media{playlist_index: 0} = Media.response_to_struct(response)
+ end
end
describe "response_to_struct/1 when testing uploaded_at" do
diff --git a/test/pinchflat_web/controllers/media_item_controller_test.exs b/test/pinchflat_web/controllers/media_item_controller_test.exs
index 4070938..34457d5 100644
--- a/test/pinchflat_web/controllers/media_item_controller_test.exs
+++ b/test/pinchflat_web/controllers/media_item_controller_test.exs
@@ -56,7 +56,7 @@ defmodule PinchflatWeb.MediaItemControllerTest do
describe "delete media" do
setup do
media_item = media_item_with_attachments()
- stub(UserScriptRunnerMock, :run, fn _event_type, _data -> :ok end)
+ stub(UserScriptRunnerMock, :run, fn _event_type, _data -> {:ok, "", 0} end)
%{media_item: media_item}
end
diff --git a/test/pinchflat_web/controllers/media_profile_controller_test.exs b/test/pinchflat_web/controllers/media_profile_controller_test.exs
index af174ca..03e9a8f 100644
--- a/test/pinchflat_web/controllers/media_profile_controller_test.exs
+++ b/test/pinchflat_web/controllers/media_profile_controller_test.exs
@@ -137,7 +137,7 @@ defmodule PinchflatWeb.MediaProfileControllerTest do
setup [:create_media_profile]
setup do
- stub(UserScriptRunnerMock, :run, fn _event_type, _data -> :ok end)
+ stub(UserScriptRunnerMock, :run, fn _event_type, _data -> {:ok, "", 0} end)
:ok
end
diff --git a/test/pinchflat_web/controllers/source_controller_test.exs b/test/pinchflat_web/controllers/source_controller_test.exs
index d24791f..047ef85 100644
--- a/test/pinchflat_web/controllers/source_controller_test.exs
+++ b/test/pinchflat_web/controllers/source_controller_test.exs
@@ -50,6 +50,15 @@ defmodule PinchflatWeb.SourceControllerTest do
refute html_response(conn, 200) =~ "MENU"
end
+
+ test "preloads some attributes when using a template", %{conn: conn} do
+ source = source_fixture(custom_name: "My first source", download_cutoff_date: "2021-01-01")
+
+ conn = get(conn, ~p"/sources/new", %{"template_id" => source.id})
+ assert html_response(conn, 200) =~ "New Source"
+ assert html_response(conn, 200) =~ "2021-01-01"
+ refute html_response(conn, 200) =~ source.custom_name
+ end
end
describe "create source" do
@@ -143,6 +152,16 @@ defmodule PinchflatWeb.SourceControllerTest do
delete(conn, ~p"/sources/#{source}")
assert File.exists?(media_item.media_filepath)
end
+ end
+
+ describe "delete source when deleting the records and files" do
+ setup [:create_source]
+
+ setup do
+ stub(UserScriptRunnerMock, :run, fn _event_type, _data -> {:ok, "", 0} end)
+
+ :ok
+ end
test "deletes chosen source and media_items", %{conn: conn, source: source, media_item: media_item} do
delete(conn, ~p"/sources/#{source}?delete_files=true")
diff --git a/test/support/fixtures/sources_fixtures.ex b/test/support/fixtures/sources_fixtures.ex
index bb768db..a06329a 100644
--- a/test/support/fixtures/sources_fixtures.ex
+++ b/test/support/fixtures/sources_fixtures.ex
@@ -25,7 +25,7 @@ defmodule Pinchflat.SourcesFixtures do
collection_type: "channel",
custom_name: "Cool and good internal name!",
description: "This is a description",
- original_url: "https://www.youtube.com/channel/#{Faker.String.base64(12)}",
+ original_url: "https://www.youtube.com/@#{Faker.String.base64(12)}",
media_profile_id: ProfilesFixtures.media_profile_fixture().id,
index_frequency_minutes: 60
}
diff --git a/.check.exs b/tooling/.check.exs
similarity index 92%
rename from .check.exs
rename to tooling/.check.exs
index da0bf22..98ca0e2 100644
--- a/.check.exs
+++ b/tooling/.check.exs
@@ -16,7 +16,7 @@
{:compiler, env: %{"MIX_ENV" => "test"}},
{:formatter, env: %{"MIX_ENV" => "test"}},
{:sobelow, "mix sobelow --config"},
- {:prettier_formatting, "yarn run prettier . --check", fix: "yarn run prettier . --write"},
+ {:prettier_formatting, "yarn run lint:check", fix: "yarn run lint:fix"},
{:npm_test, false}
## curated tools may be disabled (e.g. the check for compilation warnings)
diff --git a/.credo.exs b/tooling/.credo.exs
similarity index 100%
rename from .credo.exs
rename to tooling/.credo.exs
diff --git a/tooling/.prettierignore b/tooling/.prettierignore
new file mode 100644
index 0000000..937ae7c
--- /dev/null
+++ b/tooling/.prettierignore
@@ -0,0 +1 @@
+../assets/vendor/
diff --git a/.prettierrc.js b/tooling/.prettierrc.js
similarity index 100%
rename from .prettierrc.js
rename to tooling/.prettierrc.js
diff --git a/tooling/version_bump.sh b/tooling/version_bump.sh
new file mode 100755
index 0000000..09a3c41
--- /dev/null
+++ b/tooling/version_bump.sh
@@ -0,0 +1,14 @@
+#!/bin/bash
+
+# Get the current date in the format YYYY.MM.DD (stripping leading zeros)
+DATE=$(date +"%Y.%-m.%-d")
+
+# Get the current version from mix.exs
+VERSION=$(grep "version: " mix.exs | cut -d '"' -f2)
+
+echo "Bumping version from $VERSION to $DATE"
+# Replace the version in mix.exs with the new version
+sed -i "s/version: \"$VERSION\"/version: \"$DATE\"/g" mix.exs
+
+# Run checks to ensure it's a valid mix.exs file
+mix check
-
+
+
## Installation
@@ -91,7 +91,7 @@ Docker Compose file:
version: '3'
services:
pinchflat:
- image: keglin/pinchflat:latest
+ image: ghcr.io/kieraneglin/pinchflat:latest
environment:
# Set the timezone to your local timezone
- TZ=America/New_York
@@ -108,7 +108,7 @@ services:
2. Prepare the docker image in one of the two ways below:
- **From GHCR:** `docker pull ghcr.io/kieraneglin/pinchflat:latest`
- NOTE: also available on Docker Hub at `keglin/pinchflat:latest`
- - **Building locally:** `docker build . --file selfhosted.Dockerfile -t ghcr.io/kieraneglin/pinchflat:latest`
+ - **Building locally:** `docker build . --file docker/selfhosted.Dockerfile -t ghcr.io/kieraneglin/pinchflat:latest`
3. Run the container:
```bash
@@ -153,6 +153,7 @@ If you change this setting and it works well for you, please leave a comment on
| EXPOSE_FEED_ENDPOINTS | No | | See [RSS feed docs](https://github.com/kieraneglin/pinchflat/wiki/Podcast-RSS-Feeds) |
| JOURNAL_MODE | No | `wal` | Set to `delete` if your config directory is stored on a network share (not recommended) |
| TZ_DATA_DIR | No | `/etc/elixir_tzdata_data` | The container path where the timezone database is stored |
+| BASE_ROUTE_PATH | No | `/` | The base path for route generation. Useful when running behind certain reverse proxies |
## EFF donations
diff --git a/assets/css/satoshi.css b/assets/css/satoshi.css
index 272640a..bd622f8 100644
--- a/assets/css/satoshi.css
+++ b/assets/css/satoshi.css
@@ -22,8 +22,8 @@
@font-face {
font-family: 'Satoshi';
- src: url('/fonts/satoshi/Satoshi-Light.woff2'), url('/fonts/satoshi/Satoshi-Light.woff'),
- url('/fonts/satoshi/Satoshi-Light.ttf');
+ src: url('../fonts/satoshi/Satoshi-Light.woff2'), url('../fonts/satoshi/Satoshi-Light.woff'),
+ url('../fonts/satoshi/Satoshi-Light.ttf');
font-weight: 300;
font-display: swap;
font-style: normal;
@@ -31,8 +31,9 @@
@font-face {
font-family: 'Satoshi';
- src: url('/fonts/satoshi/Satoshi-LightItalic.woff2'),
- url('/fonts/satoshi/Satoshi-LightItalic.woff'), url('/fonts/satoshi/Satoshi-LightItalic.ttf');
+ src: url('../fonts/satoshi/Satoshi-LightItalic.woff2'),
+ url('../fonts/satoshi/Satoshi-LightItalic.woff'),
+ url('../fonts/satoshi/Satoshi-LightItalic.ttf');
font-weight: 300;
font-display: swap;
font-style: italic;
@@ -40,8 +41,8 @@
@font-face {
font-family: 'Satoshi';
- src: url('/fonts/satoshi/Satoshi-Regular.woff2'), url('/fonts/satoshi/Satoshi-Regular.woff'),
- url('/fonts/satoshi/Satoshi-Regular.ttf');
+ src: url('../fonts/satoshi/Satoshi-Regular.woff2'), url('../fonts/satoshi/Satoshi-Regular.woff'),
+ url('../fonts/satoshi/Satoshi-Regular.ttf');
font-weight: 400;
font-display: swap;
font-style: normal;
@@ -49,8 +50,8 @@
@font-face {
font-family: 'Satoshi';
- src: url('/fonts/satoshi/Satoshi-Italic.woff2'), url('/fonts/satoshi/Satoshi-Italic.woff'),
- url('/fonts/satoshi/Satoshi-Italic.ttf');
+ src: url('../fonts/satoshi/Satoshi-Italic.woff2'), url('../fonts/satoshi/Satoshi-Italic.woff'),
+ url('../fonts/satoshi/Satoshi-Italic.ttf');
font-weight: 400;
font-display: swap;
font-style: italic;
@@ -58,8 +59,8 @@
@font-face {
font-family: 'Satoshi';
- src: url('/fonts/satoshi/Satoshi-Medium.woff2'), url('/fonts/satoshi/Satoshi-Medium.woff'),
- url('/fonts/satoshi/Satoshi-Medium.ttf');
+ src: url('../fonts/satoshi/Satoshi-Medium.woff2'), url('../fonts/satoshi/Satoshi-Medium.woff'),
+ url('../fonts/satoshi/Satoshi-Medium.ttf');
font-weight: 500;
font-display: swap;
font-style: normal;
@@ -67,8 +68,9 @@
@font-face {
font-family: 'Satoshi';
- src: url('/fonts/satoshi/Satoshi-MediumItalic.woff2'),
- url('/fonts/satoshi/Satoshi-MediumItalic.woff'), url('/fonts/satoshi/Satoshi-MediumItalic.ttf');
+ src: url('../fonts/satoshi/Satoshi-MediumItalic.woff2'),
+ url('../fonts/satoshi/Satoshi-MediumItalic.woff'),
+ url('../fonts/satoshi/Satoshi-MediumItalic.ttf');
font-weight: 500;
font-display: swap;
font-style: italic;
@@ -76,8 +78,8 @@
@font-face {
font-family: 'Satoshi';
- src: url('/fonts/satoshi/Satoshi-Bold.woff2'), url('/fonts/satoshi/Satoshi-Bold.woff'),
- url('/fonts/satoshi/Satoshi-Bold.ttf');
+ src: url('../fonts/satoshi/Satoshi-Bold.woff2'), url('../fonts/satoshi/Satoshi-Bold.woff'),
+ url('../fonts/satoshi/Satoshi-Bold.ttf');
font-weight: 700;
font-display: swap;
font-style: normal;
@@ -85,8 +87,8 @@
@font-face {
font-family: 'Satoshi';
- src: url('/fonts/satoshi/Satoshi-BoldItalic.woff2'), url('/fonts/satoshi/Satoshi-BoldItalic.woff'),
- url('/fonts/satoshi/Satoshi-BoldItalic.ttf');
+ src: url('../fonts/satoshi/Satoshi-BoldItalic.woff2'),
+ url('../fonts/satoshi/Satoshi-BoldItalic.woff'), url('../fonts/satoshi/Satoshi-BoldItalic.ttf');
font-weight: 700;
font-display: swap;
font-style: italic;
@@ -94,8 +96,9 @@
@font-face {
font-family: 'Satoshi';
- src: url('/fonts/satoshi/Satoshi-BlackItalic.woff2'),
- url('/fonts/satoshi/Satoshi-BlackItalic.woff'), url('/fonts/satoshi/Satoshi-BlackItalic.ttf');
+ src: url('../fonts/satoshi/Satoshi-BlackItalic.woff2'),
+ url('../fonts/satoshi/Satoshi-BlackItalic.woff'),
+ url('../fonts/satoshi/Satoshi-BlackItalic.ttf');
font-weight: 900;
font-display: swap;
font-style: italic;
diff --git a/assets/js/app.js b/assets/js/app.js
index de05354..2be596d 100644
--- a/assets/js/app.js
+++ b/assets/js/app.js
@@ -29,7 +29,7 @@ window.Alpine = Alpine
Alpine.start()
let csrfToken = document.querySelector("meta[name='csrf-token']").getAttribute('content')
-let liveSocket = new LiveSocket('/live', Socket, {
+let liveSocket = new LiveSocket(document.body.dataset.socketPath, Socket, {
params: { _csrf_token: csrfToken },
dom: {
onBeforeElUpdated(from, to) {
diff --git a/config/config.exs b/config/config.exs
index 2407975..aab4d10 100644
--- a/config/config.exs
+++ b/config/config.exs
@@ -26,7 +26,8 @@ config :pinchflat,
basic_auth_password: "",
expose_feed_endpoints: false,
file_watcher_poll_interval: 1000,
- timezone: "UTC"
+ timezone: "UTC",
+ base_route_path: "/"
config :pinchflat, Pinchflat.Repo,
journal_mode: :wal,
@@ -101,7 +102,7 @@ config :tailwind,
# Configures Elixir's Logger
config :logger, :console,
- format: "$time $metadata[$level] $message\n",
+ format: "$date $time $metadata[$level] | $message\n",
metadata: [:request_id]
# Use Jason for JSON parsing in Phoenix
diff --git a/config/runtime.exs b/config/runtime.exs
index 8e47790..06aa731 100644
--- a/config/runtime.exs
+++ b/config/runtime.exs
@@ -46,12 +46,12 @@ if config_env() == :prod do
log_path = System.get_env("LOG_PATH", Path.join([config_path, "logs", "pinchflat.log"]))
metadata_path = System.get_env("METADATA_PATH", Path.join([config_path, "metadata"]))
extras_path = System.get_env("EXTRAS_PATH", Path.join([config_path, "extras"]))
-
# For running PF as a podcast host on self-hosted environments
expose_feed_endpoints = String.length(System.get_env("EXPOSE_FEED_ENDPOINTS", "")) > 0
-
# For testing alternate journal modes (see issue #137)
journal_mode = String.to_existing_atom(System.get_env("JOURNAL_MODE", "wal"))
+ # For running PF in a subdirectory via a reverse proxy
+ base_route_path = System.get_env("BASE_ROUTE_PATH", "/")
config :logger, level: String.to_existing_atom(System.get_env("LOG_LEVEL", "debug"))
@@ -65,7 +65,8 @@ if config_env() == :prod do
dns_cluster_query: System.get_env("DNS_CLUSTER_QUERY"),
expose_feed_endpoints: expose_feed_endpoints,
timezone: System.get_env("TIMEZONE") || System.get_env("TZ") || "UTC",
- log_path: log_path
+ log_path: log_path,
+ base_route_path: base_route_path
config :tzdata, :data_dir, System.get_env("TZ_DATA_DIR", "/etc/elixir_tzdata_data")
@@ -108,6 +109,7 @@ if config_env() == :prod do
ip: {0, 0, 0, 0},
port: String.to_integer(System.get_env("PORT") || "4000")
],
+ url: [path: base_route_path],
secret_key_base: secret_key_base
config :pinchflat, :logger, [
diff --git a/docker-compose.ci.yml b/docker-compose.ci.yml
index d4f4d6f..bf26c4b 100644
--- a/docker-compose.ci.yml
+++ b/docker-compose.ci.yml
@@ -1,13 +1,15 @@
-version: '3'
services:
phx:
build:
context: .
- dockerfile: dev.Dockerfile
+ dockerfile: ./docker/dev.Dockerfile
environment:
- MIX_ENV=test
volumes:
- '.:/app'
+ # These lines ensure the deps can be saved as build artifacts for caching
+ - '/app/deps'
+ - '/app/_build'
ports:
- '4008:4008'
command: tail -F /dev/null
diff --git a/docker-compose.yml b/docker-compose.yml
index 23cde70..aad86e8 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -1,14 +1,14 @@
-version: '3'
services:
phx:
build:
context: .
- dockerfile: dev.Dockerfile
+ dockerfile: ./docker/dev.Dockerfile
volumes:
- '.:/app'
ports:
- '4008:4008'
- command:
- - ./docker-run.dev.sh
+ command: bash -c "chmod +x docker/docker-run.dev.sh && docker/docker-run.dev.sh"
stdin_open: true
tty: true
+ env_file:
+ - .env
diff --git a/dev.Dockerfile b/docker/dev.Dockerfile
similarity index 55%
rename from dev.Dockerfile
rename to docker/dev.Dockerfile
index 648aa55..3ebddd3 100644
--- a/dev.Dockerfile
+++ b/docker/dev.Dockerfile
@@ -1,6 +1,6 @@
-ARG ELIXIR_VERSION=1.16.2
-ARG OTP_VERSION=26.2.2
-ARG DEBIAN_VERSION=bookworm-20240130
+ARG ELIXIR_VERSION=1.17.0
+ARG OTP_VERSION=26.2.5
+ARG DEBIAN_VERSION=bookworm-20240612-slim
ARG DEV_IMAGE="hexpm/elixir:${ELIXIR_VERSION}-erlang-${OTP_VERSION}-debian-${DEBIAN_VERSION}"
FROM ${DEV_IMAGE}
@@ -9,10 +9,10 @@ ARG TARGETPLATFORM
RUN echo "Building for ${TARGETPLATFORM:?}"
# Install debian packages
-RUN apt-get update -qq
-RUN apt-get install -y inotify-tools curl git openssh-client jq \
- python3 python3-setuptools python3-wheel python3-dev pipx \
- python3-mutagen locales procps build-essential graphviz
+RUN apt-get update -qq && \
+ apt-get install -y inotify-tools curl git openssh-client jq \
+ python3 python3-setuptools python3-wheel python3-dev pipx \
+ python3-mutagen locales procps build-essential graphviz
# Install ffmpeg
RUN export FFMPEG_DOWNLOAD=$(case ${TARGETPLATFORM:-linux/amd64} in \
@@ -23,42 +23,37 @@ RUN export FFMPEG_DOWNLOAD=$(case ${TARGETPLATFORM:-linux/amd64} in \
tar -xf /tmp/ffmpeg.tar.xz --strip-components=2 --no-anchored -C /usr/bin/ "ffmpeg" && \
tar -xf /tmp/ffmpeg.tar.xz --strip-components=2 --no-anchored -C /usr/bin/ "ffprobe"
-# Install nodejs
-RUN curl -sL https://deb.nodesource.com/setup_20.x -o nodesource_setup.sh
-RUN bash nodesource_setup.sh
-RUN apt-get install nodejs
-RUN npm install -g yarn
-
-# Install baseline Elixir packages
-RUN mix local.hex --force
-RUN mix local.rebar --force
-
-# Download and update YT-DLP
-RUN curl -L https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -o /usr/local/bin/yt-dlp
-RUN chmod a+rx /usr/local/bin/yt-dlp
-RUN yt-dlp -U
-
-# Install Apprise
-RUN export PIPX_HOME=/opt/pipx && \
- export PIPX_BIN_DIR=/usr/local/bin && \
- pipx install apprise
+# Install nodejs and Yarn
+RUN curl -sL https://deb.nodesource.com/setup_20.x -o nodesource_setup.sh && \
+ bash nodesource_setup.sh && \
+ apt-get install -y nodejs && \
+ npm install -g yarn && \
+ # Install baseline Elixir packages
+ mix local.hex --force && \
+ mix local.rebar --force && \
+ # Download and update YT-DLP
+ curl -L https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -o /usr/local/bin/yt-dlp && \
+ chmod a+rx /usr/local/bin/yt-dlp && \
+ yt-dlp -U && \
+ # Install Apprise
+ export PIPX_HOME=/opt/pipx && \
+ export PIPX_BIN_DIR=/usr/local/bin && \
+ pipx install apprise
# Set the locale
RUN sed -i '/en_US.UTF-8/s/^# //g' /etc/locale.gen && locale-gen
-ENV LANG en_US.UTF-8
-ENV LANGUAGE en_US:en
-ENV LC_ALL en_US.UTF-8
+ENV LANG=en_US.UTF-8
+ENV LANGUAGE=en_US:en
+ENV LC_ALL=en_US.UTF-8
# Create app directory and copy the Elixir projects into it.
WORKDIR /app
COPY . ./
-# Needs permissions to be updated AFTER the copy step
-RUN chmod +x ./docker-run.dev.sh
-
# Install Elixir deps
# RUN mix archive.install github hexpm/hex branch latest
-RUN mix deps.get
+RUN MIX_ENV=dev mix deps.get && MIX_ENV=dev mix deps.compile
+RUN MIX_ENV=test mix deps.get && MIX_ENV=test mix deps.compile
# Gives us iex shell history
ENV ERL_AFLAGS="-kernel shell_history enabled"
diff --git a/docker-run.dev.sh b/docker/docker-run.dev.sh
similarity index 56%
rename from docker-run.dev.sh
rename to docker/docker-run.dev.sh
index ddae66f..8ebb1a8 100755
--- a/docker-run.dev.sh
+++ b/docker/docker-run.dev.sh
@@ -2,12 +2,12 @@
set -e
-# Ensure the app's deps are installed
+echo "\nInstalling Elixir deps..."
mix deps.get
-# Install JS deps
-echo "\nInstalling JS..."
-cd assets && yarn install
+# Install both project-level and assets-level JS dependencies
+echo "\nInstalling JS deps..."
+yarn install && cd assets && yarn install
cd ..
# Potentially Set up the database
diff --git a/selfhosted.Dockerfile b/docker/selfhosted.Dockerfile
similarity index 97%
rename from selfhosted.Dockerfile
rename to docker/selfhosted.Dockerfile
index 1101fc8..0449c88 100644
--- a/selfhosted.Dockerfile
+++ b/docker/selfhosted.Dockerfile
@@ -1,8 +1,8 @@
# Find eligible builder and runner images on Docker Hub. We use Ubuntu/Debian
# instead of Alpine to avoid DNS resolution issues in production.
-ARG ELIXIR_VERSION=1.16.2
-ARG OTP_VERSION=26.2.2
-ARG DEBIAN_VERSION=bookworm-20240130-slim
+ARG ELIXIR_VERSION=1.17.0
+ARG OTP_VERSION=26.2.5
+ARG DEBIAN_VERSION=bookworm-20240612-slim
ARG BUILDER_IMAGE="hexpm/elixir:${ELIXIR_VERSION}-erlang-${OTP_VERSION}-debian-${DEBIAN_VERSION}"
ARG RUNNER_IMAGE="debian:${DEBIAN_VERSION}"
diff --git a/lib/pinchflat/downloading/codec_parser.ex b/lib/pinchflat/downloading/codec_parser.ex
deleted file mode 100644
index 6953cf4..0000000
--- a/lib/pinchflat/downloading/codec_parser.ex
+++ /dev/null
@@ -1,82 +0,0 @@
-defmodule Pinchflat.Downloading.CodecParser do
- @moduledoc """
- Functions for generating yt-dlp codec strings
- """
-
- alias Pinchflat.Settings
-
- @doc """
- Generate a video codec string based on the value of the video_codec_preference setting.
-
- Returns binary()
- """
- def generate_vcodec_string_from_settings do
- generate_vcodec_string(Settings.get!(:video_codec_preference))
- end
-
- @doc """
- Generate an audio codec string based on the value of the audio_codec_preference setting.
-
- Returns binary()
- """
- def generate_acodec_string_from_settings do
- generate_acodec_string(Settings.get!(:audio_codec_preference))
- end
-
- @doc """
- Generate a video codec string from a list of video codecs.
-
- If the list is nil or empty, the default video codec is AVC.
-
- Returns binary()
- """
- def generate_vcodec_string(nil), do: "bestvideo[vcodec~='^avc']/bestvideo"
- def generate_vcodec_string([]), do: generate_vcodec_string(nil)
-
- def generate_vcodec_string(video_codecs) do
- video_codecs
- |> Enum.map(&video_codec_map()[&1])
- |> Enum.reject(&is_nil/1)
- |> Enum.map(&"bestvideo[vcodec~='^#{&1}']")
- |> Enum.concat(["bestvideo"])
- |> Enum.join("/")
- end
-
- @doc """
- Generate an audio codec string from a list of audio codecs.
-
- If the list is nil or empty, the default audio codec is MP4A.
-
- Returns binary()
- """
- def generate_acodec_string(nil), do: "bestaudio[acodec~='^mp4a']/bestaudio"
- def generate_acodec_string([]), do: generate_acodec_string(nil)
-
- def generate_acodec_string(audio_codecs) do
- audio_codecs
- |> Enum.map(&audio_codec_map()[&1])
- |> Enum.reject(&is_nil/1)
- |> Enum.map(&"bestaudio[acodec~='^#{&1}']")
- |> Enum.concat(["bestaudio"])
- |> Enum.join("/")
- end
-
- @doc false
- def video_codec_map do
- %{
- "av01" => "av01",
- "avc" => "avc",
- "vp9" => "vp0?9"
- }
- end
-
- @doc false
- def audio_codec_map do
- %{
- "aac" => "aac",
- "mp4a" => "mp4a",
- "mp3" => "mp3",
- "opus" => "opus"
- }
- end
-end
diff --git a/lib/pinchflat/downloading/download_option_builder.ex b/lib/pinchflat/downloading/download_option_builder.ex
index d508b26..3e04472 100644
--- a/lib/pinchflat/downloading/download_option_builder.ex
+++ b/lib/pinchflat/downloading/download_option_builder.ex
@@ -4,9 +4,9 @@ defmodule Pinchflat.Downloading.DownloadOptionBuilder do
"""
alias Pinchflat.Sources
+ alias Pinchflat.Settings
alias Pinchflat.Sources.Source
alias Pinchflat.Media.MediaItem
- alias Pinchflat.Downloading.CodecParser
alias Pinchflat.Downloading.OutputPathBuilder
alias Pinchflat.Utils.FilesystemUtils, as: FSUtils
@@ -74,6 +74,9 @@ defmodule Pinchflat.Downloading.DownloadOptionBuilder do
{{:download_auto_subs, true}, %{download_subs: true}} ->
acc ++ [:write_auto_subs]
+ {{:download_auto_subs, true}, %{embed_subs: true}} ->
+ acc ++ [:write_auto_subs]
+
{{:embed_subs, true}, %{preferred_resolution: pr}} when pr != :audio ->
acc ++ [:embed_subs]
@@ -122,13 +125,13 @@ defmodule Pinchflat.Downloading.DownloadOptionBuilder do
end
defp quality_options(media_profile) do
- vcodec_string = CodecParser.generate_vcodec_string_from_settings()
- acodec_string = CodecParser.generate_acodec_string_from_settings()
+ vcodec = Settings.get!(:video_codec_preference)
+ acodec = Settings.get!(:audio_codec_preference)
case media_profile.preferred_resolution do
# Also be aware that :audio disabled all embedding options for subtitles
:audio ->
- [:extract_audio, format: "#{acodec_string}/best"]
+ [:extract_audio, format_sort: "+acodec:#{acodec}"]
resolution_atom ->
{resolution_string, _} =
@@ -137,10 +140,9 @@ defmodule Pinchflat.Downloading.DownloadOptionBuilder do
|> Integer.parse()
[
- format_sort: "res:#{resolution_string}",
# Since Plex doesn't support reading metadata from MKV
remux_video: "mp4",
- format: "((#{vcodec_string})+(#{acodec_string}))/best"
+ format_sort: "res:#{resolution_string},+codec:#{vcodec}:#{acodec}"
]
end
end
@@ -204,10 +206,8 @@ defmodule Pinchflat.Downloading.DownloadOptionBuilder do
"source_collection_id" => source.collection_id,
"source_collection_name" => source.collection_name,
"source_collection_type" => to_string(source.collection_type),
- "media_upload_date_index" =>
- media_item_with_preloads.upload_date_index
- |> to_string()
- |> String.pad_leading(2, "0")
+ "media_playlist_index" => pad_int(media_item_with_preloads.playlist_index),
+ "media_upload_date_index" => pad_int(media_item_with_preloads.upload_date_index)
}
end
@@ -224,6 +224,12 @@ defmodule Pinchflat.Downloading.DownloadOptionBuilder do
|> build_output_path(media_item_with_preloads)
end
+ defp pad_int(integer, count \\ 2, padding \\ "0") do
+ integer
+ |> to_string()
+ |> String.pad_leading(count, padding)
+ end
+
defp base_directory do
Application.get_env(:pinchflat, :media_directory)
end
diff --git a/lib/pinchflat/downloading/downloading_helpers.ex b/lib/pinchflat/downloading/downloading_helpers.ex
index cb679a8..5898533 100644
--- a/lib/pinchflat/downloading/downloading_helpers.ex
+++ b/lib/pinchflat/downloading/downloading_helpers.ex
@@ -91,8 +91,7 @@ defmodule Pinchflat.Downloading.DownloadingHelpers do
[m, s, mp],
^MediaQuery.for_source(source) and
^MediaQuery.downloaded() and
- not (^MediaQuery.download_prevented()) and
- not (^MediaQuery.culled())
+ not (^MediaQuery.download_prevented())
)
)
|> Repo.all()
diff --git a/lib/pinchflat/downloading/media_download_worker.ex b/lib/pinchflat/downloading/media_download_worker.ex
index 42c5ca4..c7ea232 100644
--- a/lib/pinchflat/downloading/media_download_worker.ex
+++ b/lib/pinchflat/downloading/media_download_worker.ex
@@ -39,17 +39,14 @@ defmodule Pinchflat.Downloading.MediaDownloadWorker do
- `quality_upgrade?`: re-downloads media, including the video. Does not force download
if the source is set to not download media
- Returns :ok | {:ok, %MediaItem{}} | {:error, any, ...any}
+ Returns :ok | {:error, any, ...any}
"""
@impl Oban.Worker
def perform(%Oban.Job{args: %{"id" => media_item_id} = args}) do
should_force = Map.get(args, "force", false)
is_quality_upgrade = Map.get(args, "quality_upgrade?", false)
- media_item =
- media_item_id
- |> Media.get_media_item!()
- |> Repo.preload(:source)
+ media_item = fetch_and_run_prevent_download_user_script(media_item_id)
# If the source or media item is set to not download media, perform a no-op unless forced
if (media_item.source.download_media && !media_item.prevent_download) || should_force do
@@ -62,6 +59,20 @@ defmodule Pinchflat.Downloading.MediaDownloadWorker do
Ecto.StaleEntryError -> Logger.info("#{__MODULE__} discarded: media item #{media_item_id} stale")
end
+ # If a user script exists and, when run, returns a non-zero exit code, prevent this and all future downloads
+ # of the media item.
+ defp fetch_and_run_prevent_download_user_script(media_item_id) do
+ media_item = Media.get_media_item!(media_item_id)
+
+ {:ok, media_item} =
+ case run_user_script(:media_pre_download, media_item) do
+ {:ok, _, exit_code} when exit_code != 0 -> Media.update_media_item(media_item, %{prevent_download: true})
+ _ -> {:ok, media_item}
+ end
+
+ Repo.preload(media_item, :source)
+ end
+
defp download_media_and_schedule_jobs(media_item, is_quality_upgrade, should_force) do
overwrite_behaviour = if should_force || is_quality_upgrade, do: :force_overwrites, else: :no_force_overwrites
override_opts = [overwrite_behaviour: overwrite_behaviour]
@@ -74,9 +85,9 @@ defmodule Pinchflat.Downloading.MediaDownloadWorker do
media_redownloaded_at: get_redownloaded_at(is_quality_upgrade)
})
- :ok = run_user_script(updated_media_item)
+ run_user_script(:media_downloaded, updated_media_item)
- {:ok, updated_media_item}
+ :ok
{:recovered, _} ->
{:error, :retry}
@@ -112,9 +123,9 @@ defmodule Pinchflat.Downloading.MediaDownloadWorker do
# NOTE: I like this pattern of using the default value so that I don't have to
# define it in config.exs (and friends). Consider using this elsewhere.
- defp run_user_script(media_item) do
+ defp run_user_script(event, media_item) do
runner = Application.get_env(:pinchflat, :user_script_runner, UserScriptRunner)
- runner.run(:media_downloaded, media_item)
+ runner.run(event, media_item)
end
end
diff --git a/lib/pinchflat/downloading/media_downloader.ex b/lib/pinchflat/downloading/media_downloader.ex
index 7d4ab06..a10e6b9 100644
--- a/lib/pinchflat/downloading/media_downloader.ex
+++ b/lib/pinchflat/downloading/media_downloader.ex
@@ -79,12 +79,13 @@ defmodule Pinchflat.Downloading.MediaDownloader do
|> MetadataParser.parse_for_media_item()
|> Map.merge(%{
media_downloaded_at: DateTime.utc_now(),
+ culled_at: nil,
nfo_filepath: determine_nfo_filepath(media_with_preloads, parsed_json),
metadata: %{
# IDEA: might be worth kicking off a job for this since thumbnail fetching
# could fail and I want to handle that in isolation
metadata_filepath: MetadataFileHelpers.compress_and_store_metadata_for(media_with_preloads, parsed_json),
- thumbnail_filepath: MetadataFileHelpers.download_and_store_thumbnail_for(media_with_preloads, parsed_json)
+ thumbnail_filepath: MetadataFileHelpers.download_and_store_thumbnail_for(media_with_preloads)
}
})
diff --git a/lib/pinchflat/downloading/media_quality_upgrade_worker.ex b/lib/pinchflat/downloading/media_quality_upgrade_worker.ex
index 4f554fa..8fcfb22 100644
--- a/lib/pinchflat/downloading/media_quality_upgrade_worker.ex
+++ b/lib/pinchflat/downloading/media_quality_upgrade_worker.ex
@@ -23,10 +23,10 @@ defmodule Pinchflat.Downloading.MediaQualityUpgradeWorker do
"""
@impl Oban.Worker
def perform(%Oban.Job{}) do
- redownloadable_media = Media.list_redownloadable_media_items()
- Logger.info("Redownloading #{length(redownloadable_media)} media items")
+ upgradable_media = Media.list_upgradeable_media_items()
+ Logger.info("Redownloading #{length(upgradable_media)} media items")
- Enum.each(redownloadable_media, fn media_item ->
+ Enum.each(upgradable_media, fn media_item ->
MediaDownloadWorker.kickoff_with_task(media_item, %{quality_upgrade?: true})
end)
end
diff --git a/lib/pinchflat/downloading/media_retention_worker.ex b/lib/pinchflat/downloading/media_retention_worker.ex
index 354be2b..3a36100 100644
--- a/lib/pinchflat/downloading/media_retention_worker.ex
+++ b/lib/pinchflat/downloading/media_retention_worker.ex
@@ -6,8 +6,11 @@ defmodule Pinchflat.Downloading.MediaRetentionWorker do
unique: [period: :infinity, states: [:available, :scheduled, :retryable, :executing]],
tags: ["media_item", "local_data"]
+ use Pinchflat.Media.MediaQuery
+
require Logger
+ alias Pinchflat.Repo
alias Pinchflat.Media
@doc """
@@ -20,14 +23,51 @@ defmodule Pinchflat.Downloading.MediaRetentionWorker do
"""
@impl Oban.Worker
def perform(%Oban.Job{}) do
- cullable_media = Media.list_cullable_media_items()
+ cull_cullable_media_items()
+ delete_media_items_from_before_cutoff()
+
+ :ok
+ end
+
+ defp cull_cullable_media_items do
+ cullable_media =
+ MediaQuery.new()
+ |> MediaQuery.require_assoc(:source)
+ |> where(^MediaQuery.cullable())
+ |> Repo.all()
+
Logger.info("Culling #{length(cullable_media)} media items past their retention date")
Enum.each(cullable_media, fn media_item ->
+ # Setting `prevent_download` does what it says on the tin, but `culled_at` is purely informational.
+ # We don't actually do anything with that in terms of queries and it gets set to nil if the media item
+ # gets re-downloaded.
Media.delete_media_files(media_item, %{
prevent_download: true,
culled_at: DateTime.utc_now()
})
end)
end
+
+ defp delete_media_items_from_before_cutoff do
+ deletable_media =
+ MediaQuery.new()
+ |> MediaQuery.require_assoc(:source)
+ |> where(^MediaQuery.deletable_based_on_source_cutoff())
+ |> Repo.all()
+
+ Logger.info("Deleting #{length(deletable_media)} media items that are from before the source cutoff")
+
+ Enum.each(deletable_media, fn media_item ->
+ # Note that I'm not setting `prevent_download` on the media_item here.
+ # That's because cutoff_date can easily change and it's a valid behavior to re-download older
+ # media items if the cutoff_date changes.
+ # Download is ultimately prevented because `MediaQuery.pending()` only returns media items
+ # from after the cutoff date (among other things), so it's not like the media will just immediately
+ # be re-downloaded.
+ Media.delete_media_files(media_item, %{
+ culled_at: DateTime.utc_now()
+ })
+ end)
+ end
end
diff --git a/lib/pinchflat/downloading/output_path_builder.ex b/lib/pinchflat/downloading/output_path_builder.ex
index d4f6e27..1c1392f 100644
--- a/lib/pinchflat/downloading/output_path_builder.ex
+++ b/lib/pinchflat/downloading/output_path_builder.ex
@@ -54,7 +54,12 @@ defmodule Pinchflat.Downloading.OutputPathBuilder do
"season_from_date" => "%(upload_date>%Y)S",
"season_episode_from_date" => "s%(upload_date>%Y)Se%(upload_date>%m%d)S",
"season_episode_index_from_date" => "s%(upload_date>%Y)Se%(upload_date>%m%d)S{{ media_upload_date_index }}",
- "artist_name" => "%(artist,creator,uploader,uploader_id)S"
+ "artist_name" => "%(artist,creator,uploader,uploader_id)S",
+ "static_season__episode_by_index" => "Season 1/s01e{{ media_playlist_index }}",
+ "static_season__episode_by_date" => "Season 1/s01e%(upload_date>%y%m%d)S",
+ "season_by_year__episode_by_date" => "Season %(upload_date>%Y)S/s%(upload_date>%Y)Se%(upload_date>%m%d)S",
+ "season_by_year__episode_by_date_and_index" =>
+ "Season %(upload_date>%Y)S/s%(upload_date>%Y)Se%(upload_date>%m%d)S{{ media_upload_date_index }}"
}
end
end
diff --git a/lib/pinchflat/fast_indexing/fast_indexing_helpers.ex b/lib/pinchflat/fast_indexing/fast_indexing_helpers.ex
index 684ef49..02fc00f 100644
--- a/lib/pinchflat/fast_indexing/fast_indexing_helpers.ex
+++ b/lib/pinchflat/fast_indexing/fast_indexing_helpers.ex
@@ -13,12 +13,13 @@ defmodule Pinchflat.FastIndexing.FastIndexingHelpers do
alias Pinchflat.Media
alias Pinchflat.Sources.Source
alias Pinchflat.FastIndexing.YoutubeRss
+ alias Pinchflat.FastIndexing.YoutubeApi
alias Pinchflat.Downloading.DownloadingHelpers
alias Pinchflat.YtDlp.Media, as: YtDlpMedia
@doc """
- Fetches new media IDs from a source's YouTube RSS feed, indexes them, and kicks off downloading
+ Fetches new media IDs for a source from YT's API or RSS, indexes them, and kicks off downloading
tasks for any pending media items. See comments in `FastIndexingWorker` for more info on the
order of operations and how this fits into the indexing process.
@@ -26,7 +27,7 @@ defmodule Pinchflat.FastIndexing.FastIndexingHelpers do
downloaded_.
"""
def kickoff_download_tasks_from_youtube_rss_feed(%Source{} = source) do
- {:ok, media_ids} = YoutubeRss.get_recent_media_ids_from_rss(source)
+ {:ok, media_ids} = get_recent_media_ids(source)
existing_media_items = list_media_items_by_media_id_for(source, media_ids)
new_media_ids = media_ids -- Enum.map(existing_media_items, & &1.media_id)
@@ -47,6 +48,17 @@ defmodule Pinchflat.FastIndexing.FastIndexingHelpers do
Enum.filter(maybe_new_media_items, & &1)
end
+ # If possible, use the YouTube API to fetch media IDs. If that fails, fall back to the RSS feed.
+ # If the YouTube API isn't set up, just use the RSS feed.
+ defp get_recent_media_ids(source) do
+ with true <- YoutubeApi.enabled?(),
+ {:ok, media_ids} <- YoutubeApi.get_recent_media_ids(source) do
+ {:ok, media_ids}
+ else
+ _ -> YoutubeRss.get_recent_media_ids(source)
+ end
+ end
+
defp list_media_items_by_media_id_for(source, media_ids) do
MediaQuery.new()
|> where(^dynamic([mi], ^MediaQuery.for_source(source) and mi.media_id in ^media_ids))
diff --git a/lib/pinchflat/fast_indexing/youtube_api.ex b/lib/pinchflat/fast_indexing/youtube_api.ex
new file mode 100644
index 0000000..95e6b39
--- /dev/null
+++ b/lib/pinchflat/fast_indexing/youtube_api.ex
@@ -0,0 +1,92 @@
+defmodule Pinchflat.FastIndexing.YoutubeApi do
+ @moduledoc """
+ Methods for interacting with the YouTube API for fast indexing
+ """
+
+ require Logger
+
+ alias Pinchflat.Settings
+ alias Pinchflat.Sources.Source
+ alias Pinchflat.Utils.FunctionUtils
+ alias Pinchflat.FastIndexing.YoutubeBehaviour
+
+ @behaviour YoutubeBehaviour
+
+ @doc """
+ Determines if the YouTube API is enabled for fast indexing by checking
+ if the user has an API key set
+
+ Returns boolean()
+ """
+ @impl YoutubeBehaviour
+ def enabled?(), do: is_binary(api_key())
+
+ @doc """
+ Fetches the recent media IDs from the YouTube API for a given source.
+
+ Returns {:ok, [binary()]} | {:error, binary()}
+ """
+ @impl YoutubeBehaviour
+ def get_recent_media_ids(%Source{} = source) do
+ api_response =
+ source
+ |> determine_playlist_id()
+ |> do_api_request()
+
+ case api_response do
+ {:ok, parsed_json} -> get_media_ids_from_response(parsed_json)
+ {:error, reason} -> {:error, reason}
+ end
+ end
+
+ # The UC prefix is for channels which won't work with this API endpoint. Swapping
+ # the prefix to UU will get us the playlist that represents the channel's uploads
+ defp determine_playlist_id(%{collection_id: c_id}) do
+ String.replace_prefix(c_id, "UC", "UU")
+ end
+
+ defp do_api_request(playlist_id) do
+ Logger.debug("Fetching recent media IDs from YouTube API for playlist: #{playlist_id}")
+
+ playlist_id
+ |> construct_api_endpoint()
+ |> http_client().get(accept: "application/json")
+ |> case do
+ {:ok, response} ->
+ Phoenix.json_library().decode(response)
+
+ {:error, reason} ->
+ Logger.error("Failed to fetch YouTube API: #{inspect(reason)}")
+ {:error, reason}
+ end
+ end
+
+ defp get_media_ids_from_response(parsed_json) do
+ parsed_json
+ |> Map.get("items", [])
+ |> Enum.map(fn item ->
+ item
+ |> Map.get("contentDetails", %{})
+ |> Map.get("videoId", nil)
+ end)
+ |> Enum.reject(&is_nil/1)
+ |> Enum.uniq()
+ |> FunctionUtils.wrap_ok()
+ end
+
+ defp api_key do
+ Settings.get!(:youtube_api_key)
+ end
+
+ defp construct_api_endpoint(playlist_id) do
+ api_base = "https://youtube.googleapis.com/youtube/v3/playlistItems"
+ property_type = "contentDetails"
+ max_results = 50
+
+ "#{api_base}?part=#{property_type}&maxResults=#{max_results}&playlistId=#{playlist_id}&key=#{api_key()}"
+ end
+
+ defp http_client do
+ Application.get_env(:pinchflat, :http_client, Pinchflat.HTTP.HTTPClient)
+ end
+end
diff --git a/lib/pinchflat/fast_indexing/youtube_behaviour.ex b/lib/pinchflat/fast_indexing/youtube_behaviour.ex
new file mode 100644
index 0000000..8a6c390
--- /dev/null
+++ b/lib/pinchflat/fast_indexing/youtube_behaviour.ex
@@ -0,0 +1,11 @@
+defmodule Pinchflat.FastIndexing.YoutubeBehaviour do
+ @moduledoc """
+ This module defines the behaviour for clients that interface with YouTube
+ for the purpose of fast indexing.
+ """
+
+ alias Pinchflat.Sources.Source
+
+ @callback enabled?() :: boolean()
+ @callback get_recent_media_ids(%Source{}) :: {:ok, [String.t()]} | {:error, String.t()}
+end
diff --git a/lib/pinchflat/fast_indexing/youtube_rss.ex b/lib/pinchflat/fast_indexing/youtube_rss.ex
index 5caaab8..cb83fa9 100644
--- a/lib/pinchflat/fast_indexing/youtube_rss.ex
+++ b/lib/pinchflat/fast_indexing/youtube_rss.ex
@@ -1,18 +1,31 @@
defmodule Pinchflat.FastIndexing.YoutubeRss do
@moduledoc """
- Methods for interacting with YouTube RSS feeds
+ Methods for interacting with YouTube RSS feeds for fast indexing
"""
require Logger
alias Pinchflat.Sources.Source
+ alias Pinchflat.FastIndexing.YoutubeBehaviour
+
+ @behaviour YoutubeBehaviour
+
+ @doc """
+ Determines if the YouTube RSS feed is enabled for fast indexing. Used to satisfy
+ the `YoutubeBehaviour` behaviour.
+
+ Returns true
+ """
+ @impl YoutubeBehaviour
+ def enabled?(), do: true
@doc """
Fetches the recent media IDs from a YouTube RSS feed for a given source.
Returns {:ok, [binary()]} | {:error, binary()}
"""
- def get_recent_media_ids_from_rss(%Source{} = source) do
+ @impl YoutubeBehaviour
+ def get_recent_media_ids(%Source{} = source) do
Logger.debug("Fetching recent media IDs from YouTube RSS feed for source: #{source.collection_id}")
case http_client().get(rss_url_for_source(source)) do
diff --git a/lib/pinchflat/http/http_client.ex b/lib/pinchflat/http/http_client.ex
index 45abda4..c7d4550 100644
--- a/lib/pinchflat/http/http_client.ex
+++ b/lib/pinchflat/http/http_client.ex
@@ -21,9 +21,11 @@ defmodule Pinchflat.HTTP.HTTPClient do
"""
@impl HTTPBehaviour
def get(url, headers \\ [], opts \\ []) do
+ headers = parse_headers(headers)
+
case :httpc.request(:get, {url, headers}, [], opts) do
{:ok, {{_version, 200, _reason_phrase}, _headers, body}} ->
- {:ok, body}
+ {:ok, to_string(body)}
{:ok, {{_version, status_code, reason_phrase}, _headers, _body}} ->
{:error, "HTTP request failed with status code #{status_code}: #{reason_phrase}"}
@@ -32,4 +34,8 @@ defmodule Pinchflat.HTTP.HTTPClient do
{:error, "HTTP request failed: #{reason}"}
end
end
+
+ defp parse_headers(headers) do
+ Enum.map(headers, fn {k, v} -> {to_charlist(k), to_charlist(v)} end)
+ end
end
diff --git a/lib/pinchflat/lifecycle/user_scripts/command_runner.ex b/lib/pinchflat/lifecycle/user_scripts/command_runner.ex
index 8436c05..54aa38c 100644
--- a/lib/pinchflat/lifecycle/user_scripts/command_runner.ex
+++ b/lib/pinchflat/lifecycle/user_scripts/command_runner.ex
@@ -12,6 +12,7 @@ defmodule Pinchflat.Lifecycle.UserScripts.CommandRunner do
@behaviour UserScriptCommandRunner
@event_types [
+ :media_pre_download,
:media_downloaded,
:media_deleted
]
@@ -22,24 +23,25 @@ defmodule Pinchflat.Lifecycle.UserScripts.CommandRunner do
This function will succeed in almost all cases, even if the user script command
failed - this is because I don't want bad scripts to stop the whole process.
- If something fails, it'll be logged.
+ If something fails, it'll be logged and returned BUT the tuple will always
+ start with {:ok, ...}.
The only things that can cause a true failure are passing in an invalid event
type or if the passed data cannot be encoded into JSON - both indicative of
failures in the development process.
- Returns :ok
+ Returns {:ok, :no_executable} | {:ok, output, exit_code}
"""
@impl UserScriptCommandRunner
def run(event_type, encodable_data) when event_type in @event_types do
case backend_executable() do
{:ok, :no_executable} ->
- :ok
+ {:ok, :no_executable}
{:ok, executable_path} ->
{:ok, encoded_data} = Phoenix.json_library().encode(encodable_data)
- {_output, _exit_code} =
+ {output, exit_code} =
CliUtils.wrap_cmd(
executable_path,
[to_string(event_type), encoded_data],
@@ -47,7 +49,7 @@ defmodule Pinchflat.Lifecycle.UserScripts.CommandRunner do
logging_arg_override: "[suppressed]"
)
- :ok
+ {:ok, output, exit_code}
end
end
@@ -62,7 +64,7 @@ defmodule Pinchflat.Lifecycle.UserScripts.CommandRunner do
if FilesystemUtils.exists_and_nonempty?(filepath) do
{:ok, filepath}
else
- Logger.warning("User scripts lifecyle file either not present or is empty. Skipping.")
+ Logger.info("User scripts lifecyle file either not present or is empty. Skipping.")
{:ok, :no_executable}
end
diff --git a/lib/pinchflat/media/media.ex b/lib/pinchflat/media/media.ex
index 191b28f..013bf09 100644
--- a/lib/pinchflat/media/media.ex
+++ b/lib/pinchflat/media/media.ex
@@ -25,21 +25,10 @@ defmodule Pinchflat.Media do
end
@doc """
- Returns a list of media_items that are cullable based on the retention period
- of the source they belong to.
-
- Returns [%MediaItem{}, ...]
- """
- def list_cullable_media_items do
- MediaQuery.new()
- |> MediaQuery.require_assoc(:source)
- |> where(^MediaQuery.cullable())
- |> Repo.all()
- end
-
- @doc """
- Returns a list of media_items that are redownloadable based on the redownload delay
- of the media_profile their source belongs to.
+ Returns a list of media_items that are upgradeable based on the redownload delay
+ of the media_profile their source belongs to. In this context, upgradeable means
+ that it's been long enough since upload that the video may be in a higher quality
+ or have better sponsorblock segments (or similar).
The logic is that a media_item is past_redownload_delay if the media_item's uploaded_at is
at least redownload_delay_days ago AND `media_downloaded_at` - `redownload_delay_days`
@@ -52,10 +41,10 @@ defmodule Pinchflat.Media do
Returns [%MediaItem{}, ...]
"""
- def list_redownloadable_media_items do
+ def list_upgradeable_media_items do
MediaQuery.new()
|> MediaQuery.require_assoc(:media_profile)
- |> where(^MediaQuery.redownloadable())
+ |> where(^MediaQuery.upgradeable())
|> Repo.all()
end
@@ -142,12 +131,17 @@ defmodule Pinchflat.Media do
"""
def create_media_item_from_backend_attrs(source, media_attrs_struct) do
attrs = Map.merge(%{source_id: source.id}, Map.from_struct(media_attrs_struct))
+ # Some fields should only be set on insert and not on update.
+ fields_to_drop_on_update = [:playlist_index]
%MediaItem{}
|> MediaItem.changeset(attrs)
|> Repo.insert(
on_conflict: [
- set: Map.to_list(attrs)
+ set:
+ attrs
+ |> Map.drop(fields_to_drop_on_update)
+ |> Map.to_list()
],
conflict_target: [:source_id, :media_id]
)
@@ -177,7 +171,7 @@ defmodule Pinchflat.Media do
if delete_files do
{:ok, _} = do_delete_media_files(media_item)
- :ok = run_user_script(:media_deleted, media_item)
+ run_user_script(:media_deleted, media_item)
end
# Should delete these no matter what
@@ -200,7 +194,7 @@ defmodule Pinchflat.Media do
Tasks.delete_tasks_for(media_item)
{:ok, _} = do_delete_media_files(media_item)
- :ok = run_user_script(:media_deleted, media_item)
+ run_user_script(:media_deleted, media_item)
update_media_item(media_item, Map.merge(filepath_attrs, addl_attrs))
end
diff --git a/lib/pinchflat/media/media_item.ex b/lib/pinchflat/media/media_item.ex
index bc4ec74..f85fcfb 100644
--- a/lib/pinchflat/media/media_item.ex
+++ b/lib/pinchflat/media/media_item.ex
@@ -18,6 +18,8 @@ defmodule Pinchflat.Media.MediaItem do
alias Pinchflat.Media.MediaItemsSearchIndex
@allowed_fields [
+ # these fields are only captured on index
+ :playlist_index,
# these fields are captured on indexing (and again on download)
:title,
:media_id,
@@ -72,6 +74,7 @@ defmodule Pinchflat.Media.MediaItem do
field :uploaded_at, :utc_datetime
field :upload_date_index, :integer, default: 0
field :duration_seconds, :integer
+ field :playlist_index, :integer, default: 0
field :media_filepath, :string
field :media_size_bytes, :integer
@@ -130,7 +133,31 @@ defmodule Pinchflat.Media.MediaItem do
~w(__meta__ __struct__ metadata tasks media_items_search_index)a
end
+ # Run it on new records no matter what. The method we delegate to
+ # will handle the case where `uploaded_at` is `nil`
+ defp update_upload_date_index(%{data: %{id: nil}} = changeset) do
+ do_update_upload_date_index(changeset)
+ end
+
+ # For the update case, we only want to recalculate if the day itself has changed.
+ # For instance, this is useful in the migration from `upload_date` to `uploaded_at`
defp update_upload_date_index(%{changes: changes} = changeset) when is_map_key(changes, :uploaded_at) do
+ old_uploaded_at = changeset.data.uploaded_at
+ new_uploaded_at = get_change(changeset, :uploaded_at)
+ upload_dates_match = DateTime.to_date(old_uploaded_at) == DateTime.to_date(new_uploaded_at)
+
+ if upload_dates_match do
+ changeset
+ else
+ do_update_upload_date_index(changeset)
+ end
+ end
+
+ # If the record is persisted and the `uploaded_at` field is not being changed,
+ # we don't need to recalculate the index.
+ defp update_upload_date_index(changeset), do: changeset
+
+ defp do_update_upload_date_index(%{changes: changes} = changeset) when is_map_key(changes, :uploaded_at) do
source_id = get_field(changeset, :source_id)
source = Sources.get_source!(source_id)
# Channels should count down from 99, playlists should count up from 0
@@ -151,7 +178,7 @@ defmodule Pinchflat.Media.MediaItem do
end
end
- defp update_upload_date_index(changeset), do: changeset
+ defp do_update_upload_date_index(changeset), do: changeset
defimpl Jason.Encoder, for: MediaItem do
def encode(value, opts) do
diff --git a/lib/pinchflat/media/media_query.ex b/lib/pinchflat/media/media_query.ex
index 2adb0ce..e038683 100644
--- a/lib/pinchflat/media/media_query.ex
+++ b/lib/pinchflat/media/media_query.ex
@@ -33,7 +33,6 @@ defmodule Pinchflat.Media.MediaQuery do
def downloaded, do: dynamic([mi], not is_nil(mi.media_filepath))
def download_prevented, do: dynamic([mi], mi.prevent_download == true)
def culling_prevented, do: dynamic([mi], mi.prevent_culling == true)
- def culled, do: dynamic([mi], not is_nil(mi.culled_at))
def redownloaded, do: dynamic([mi], not is_nil(mi.media_redownloaded_at))
def upload_date_matches(other_date), do: dynamic([mi], fragment("date(?) = date(?)", mi.uploaded_at, ^other_date))
@@ -108,6 +107,15 @@ defmodule Pinchflat.Media.MediaQuery do
)
end
+ def deletable_based_on_source_cutoff do
+ dynamic(
+ [mi, source],
+ ^downloaded() and
+ not (^upload_date_after_source_cutoff()) and
+ not (^culling_prevented())
+ )
+ end
+
def pending do
dynamic(
[mi],
@@ -119,12 +127,11 @@ defmodule Pinchflat.Media.MediaQuery do
)
end
- def redownloadable do
+ def upgradeable do
dynamic(
[mi, source],
^downloaded() and
not (^download_prevented()) and
- not (^culled()) and
not (^redownloaded()) and
^past_redownload_delay()
)
diff --git a/lib/pinchflat/metadata/metadata_file_helpers.ex b/lib/pinchflat/metadata/metadata_file_helpers.ex
index d54c803..b728f47 100644
--- a/lib/pinchflat/metadata/metadata_file_helpers.ex
+++ b/lib/pinchflat/metadata/metadata_file_helpers.ex
@@ -11,6 +11,8 @@ defmodule Pinchflat.Metadata.MetadataFileHelpers do
alias Pinchflat.Utils.FilesystemUtils
+ alias Pinchflat.YtDlp.Media, as: YtDlpMedia
+
@doc """
Returns the directory where metadata for a database record should be stored.
@@ -47,42 +49,26 @@ defmodule Pinchflat.Metadata.MetadataFileHelpers do
Returns {:ok, map()} | {:error, any}
"""
def read_compressed_metadata(filepath) do
- {:ok, json} = File.open(filepath, [:read, :compressed], &IO.read(&1, :all))
+ {:ok, json} = File.open(filepath, [:read, :compressed], &IO.read(&1, :eof))
Phoenix.json_library().decode(json)
end
@doc """
Downloads and stores a thumbnail for a media item, returning the filepath.
- Chooses the highest quality thumbnail available (preferring jpg). Returns
- nil if no thumbnails are available.
+ Chooses the highest quality thumbnail available and converts it to a JPG
+
+ Returns nil if no thumbnail is available or if yt-dlp encounters an error
Returns binary() | nil
"""
- def download_and_store_thumbnail_for(database_record, metadata_map) do
- thumbnails =
- (metadata_map["thumbnails"] || [])
- # Give it a low preference if the `preference` key doesn't exist
- |> Enum.map(&Map.put_new(&1, "preference", -1000))
- # Give it a low preference if image isn't a jpg
- |> Enum.map(fn t ->
- preference_weight = if String.ends_with?(t["url"], ".jpg"), do: t["preference"], else: t["preference"] - 1000
+ def download_and_store_thumbnail_for(database_record) do
+ yt_dlp_filepath = generate_filepath_for(database_record, "thumbnail.%(ext)s")
+ real_filepath = generate_filepath_for(database_record, "thumbnail.jpg")
- Map.put(t, "preference", preference_weight)
- end)
-
- case Enum.sort_by(thumbnails, & &1["preference"], :desc) do
- [thumbnail_map | _] ->
- thumbnail_url = thumbnail_map["url"]
- filepath = generate_filepath_for(database_record, Path.basename(thumbnail_url))
- thumbnail_blob = fetch_thumbnail_from_url(thumbnail_url)
-
- :ok = FilesystemUtils.write_p!(filepath, thumbnail_blob)
-
- filepath
-
- _ ->
- nil
+ case YtDlpMedia.download_thumbnail(database_record.original_url, output: yt_dlp_filepath) do
+ {:ok, _} -> real_filepath
+ _ -> nil
end
end
@@ -138,11 +124,19 @@ defmodule Pinchflat.Metadata.MetadataFileHelpers do
end
end
- defp fetch_thumbnail_from_url(url) do
- http_client = Application.get_env(:pinchflat, :http_client, Pinchflat.HTTP.HTTPClient)
- {:ok, body} = http_client.get(url, [], body_format: :binary)
+ @doc """
+ Attempts to determine the season and episode number from a media filepath.
- body
+ Returns {:ok, {binary(), binary()}} | {:error, :indeterminable}
+ """
+ def season_and_episode_from_media_filepath(media_filepath) do
+ # matches s + 1 or more digits + e + 1 or more digits (case-insensitive)
+ season_episode_regex = ~r/s(\d+)e(\d+)/i
+
+ case Regex.scan(season_episode_regex, media_filepath) do
+ [[_, season, episode] | _] -> {:ok, {season, episode}}
+ _ -> {:error, :indeterminable}
+ end
end
defp generate_filepath_for(database_record, filename) do
diff --git a/lib/pinchflat/metadata/nfo_builder.ex b/lib/pinchflat/metadata/nfo_builder.ex
index 3db237f..38a26dd 100644
--- a/lib/pinchflat/metadata/nfo_builder.ex
+++ b/lib/pinchflat/metadata/nfo_builder.ex
@@ -6,8 +6,8 @@ defmodule Pinchflat.Metadata.NfoBuilder do
import Pinchflat.Utils.XmlUtils, only: [safe: 1]
- alias Pinchflat.Metadata.MetadataFileHelpers
alias Pinchflat.Utils.FilesystemUtils
+ alias Pinchflat.Metadata.MetadataFileHelpers
@doc """
Builds an NFO file for a media item (read: single "episode") and
@@ -15,12 +15,12 @@ defmodule Pinchflat.Metadata.NfoBuilder do
Returns the filepath of the NFO file.
"""
- def build_and_store_for_media_item(filepath, metadata) do
- nfo = build_for_media_item(metadata)
+ def build_and_store_for_media_item(nfo_filepath, metadata) do
+ nfo = build_for_media_item(nfo_filepath, metadata)
- FilesystemUtils.write_p!(filepath, nfo)
+ FilesystemUtils.write_p!(nfo_filepath, nfo)
- filepath
+ nfo_filepath
end
@doc """
@@ -37,10 +37,15 @@ defmodule Pinchflat.Metadata.NfoBuilder do
filepath
end
- defp build_for_media_item(metadata) do
+ defp build_for_media_item(nfo_filepath, metadata) do
upload_date = MetadataFileHelpers.parse_upload_date(metadata["upload_date"])
+ # NOTE: the filepath here isn't the path of the media item, it's the path that
+ # the NFO should be saved to. This works because the NFO's path is the same as
+ # the media's path, just with a different extension. If this ever changes I'll
+ # need to pass in the media item's path as well.
+ {season, episode} = determine_season_and_episode_number(nfo_filepath, upload_date)
+
# Cribbed from a combination of the Kodi wiki, ytdl-nfo, and ytdl-sub.
- # WHO NEEDS A FANCY XML PARSER ANYWAY?!
"""