@@ -15,13 +23,22 @@
<.button_dropdown text="Actions" class="justify-center w-full sm:w-50">
<:option>
<.link
- href={~p"/sources/#{@media_item.source_id}/media/#{@media_item}?delete_files=true"}
+ href={~p"/sources/#{@media_item.source_id}/media/#{@media_item}"}
method="delete"
- data-confirm="Are you sure you want to delete this record and all associated files on disk? This cannot be undone."
+ data-confirm="Are you sure you want to delete all files for this media item? This cannot be undone."
>
Delete Files
+ <:option>
+ <.link
+ href={~p"/sources/#{@media_item.source_id}/media/#{@media_item}?prevent_download=true"}
+ method="delete"
+ data-confirm="Are you sure you want to delete all files for this media item and prevent it from re-downloading in the future? This cannot be undone."
+ >
+ Delete and Ignore
+
+
@@ -32,6 +49,7 @@
<.media_preview media_item={@media_item} />
<% end %>
+
<%= @media_item.title %>
Attributes
Source:
diff --git a/lib/pinchflat_web/controllers/sources/source_html/index.html.heex b/lib/pinchflat_web/controllers/sources/source_html/index.html.heex
index 3f66720..c912cfb 100644
--- a/lib/pinchflat_web/controllers/sources/source_html/index.html.heex
+++ b/lib/pinchflat_web/controllers/sources/source_html/index.html.heex
@@ -22,6 +22,13 @@
<:col :let={source} label="Should Download?">
<.icon name={if source.download_media, do: "hero-check", else: "hero-x-mark"} />
+ <:col :let={source} label="Retention">
+ <%= if source.retention_period_days && source.retention_period_days > 0 do %>
+ <%= source.retention_period_days %> day(s)
+ <% else %>
+ ∞
+ <% end %>
+
<:col :let={source} label="Media Profile">
<.subtle_link href={~p"/media_profiles/#{source.media_profile_id}"}>
<%= source.media_profile.name %>
diff --git a/lib/pinchflat_web/controllers/sources/source_html/show.html.heex b/lib/pinchflat_web/controllers/sources/source_html/show.html.heex
index 8572f22..9a2e678 100644
--- a/lib/pinchflat_web/controllers/sources/source_html/show.html.heex
+++ b/lib/pinchflat_web/controllers/sources/source_html/show.html.heex
@@ -77,10 +77,17 @@
Shows a maximum of 100 media items
<.table rows={@pending_media} table_class="text-black dark:text-white">
<:col :let={media_item} label="Title">
- <%= StringUtils.truncate(media_item.title, 50) %>
+ <.subtle_link href={~p"/sources/#{@source.id}/media/#{media_item.id}"}>
+ <%= StringUtils.truncate(media_item.title, 50) %>
+
<:col :let={media_item} label="" class="flex place-content-evenly">
- <.icon_link href={~p"/sources/#{@source.id}/media/#{media_item.id}"} icon="hero-eye" />
+ <.icon_link href={~p"/sources/#{@source.id}/media/#{media_item.id}"} icon="hero-eye" class="mx-1" />
+ <.icon_link
+ href={~p"/sources/#{@source.id}/media/#{media_item.id}/edit"}
+ icon="hero-pencil-square"
+ class="mx-1"
+ />
<% else %>
@@ -92,10 +99,17 @@
Shows a maximum of 100 media items (<%= @total_downloaded %> total)
<.table rows={@downloaded_media} table_class="text-black dark:text-white">
<:col :let={media_item} label="Title">
- <%= StringUtils.truncate(media_item.title, 50) %>
+ <.subtle_link href={~p"/sources/#{@source.id}/media/#{media_item.id}"}>
+ <%= StringUtils.truncate(media_item.title, 50) %>
+
<:col :let={media_item} label="" class="flex place-content-evenly">
- <.icon_link href={~p"/sources/#{@source.id}/media/#{media_item.id}"} icon="hero-eye" />
+ <.icon_link href={~p"/sources/#{@source.id}/media/#{media_item.id}"} icon="hero-eye" class="mx-1" />
+ <.icon_link
+ href={~p"/sources/#{@source.id}/media/#{media_item.id}/edit"}
+ icon="hero-pencil-square"
+ class="mx-1"
+ />
<% else %>
diff --git a/lib/pinchflat_web/controllers/sources/source_html/source_form.html.heex b/lib/pinchflat_web/controllers/sources/source_html/source_form.html.heex
index f430cf2..e94ebe6 100644
--- a/lib/pinchflat_web/controllers/sources/source_html/source_form.html.heex
+++ b/lib/pinchflat_web/controllers/sources/source_html/source_form.html.heex
@@ -88,6 +88,14 @@
help="Only download media uploaded after this date. Leave blank to download all media. Must be in YYYY-MM-DD format"
/>
+ <.input
+ field={f[:retention_period_days]}
+ type="number"
+ label="Retention Period (days)"
+ min="0"
+ help="Days between when media is *downloaded* and when it's deleted. Leave blank to keep media indefinitely"
+ />
+
Advanced Options
diff --git a/lib/pinchflat_web/router.ex b/lib/pinchflat_web/router.ex
index 202f460..e56a4f2 100644
--- a/lib/pinchflat_web/router.ex
+++ b/lib/pinchflat_web/router.ex
@@ -32,7 +32,7 @@ defmodule PinchflatWeb.Router do
resources "/search", Searches.SearchController, only: [:show], singleton: true
resources "/sources", Sources.SourceController do
- resources "/media", MediaItems.MediaItemController, only: [:show, :delete]
+ resources "/media", MediaItems.MediaItemController, only: [:show, :edit, :update, :delete]
end
end
diff --git a/priv/repo/migrations/20240402192417_add_prevent_download_to_media_items.exs b/priv/repo/migrations/20240402192417_add_prevent_download_to_media_items.exs
new file mode 100644
index 0000000..c43f91f
--- /dev/null
+++ b/priv/repo/migrations/20240402192417_add_prevent_download_to_media_items.exs
@@ -0,0 +1,9 @@
+defmodule Pinchflat.Repo.Migrations.AddPreventDownloadToMediaItems do
+ use Ecto.Migration
+
+ def change do
+ alter table(:media_items) do
+ add :prevent_download, :boolean, default: false, null: false
+ end
+ end
+end
diff --git a/priv/repo/migrations/20240402221638_add_retention_period_to_sources.exs b/priv/repo/migrations/20240402221638_add_retention_period_to_sources.exs
new file mode 100644
index 0000000..a738678
--- /dev/null
+++ b/priv/repo/migrations/20240402221638_add_retention_period_to_sources.exs
@@ -0,0 +1,9 @@
+defmodule Pinchflat.Repo.Migrations.AddRetentionPeriodToSources do
+ use Ecto.Migration
+
+ def change do
+ alter table(:sources) do
+ add :retention_period_days, :integer
+ end
+ end
+end
diff --git a/priv/repo/migrations/20240403164943_add_culled_at_to_media_items.exs b/priv/repo/migrations/20240403164943_add_culled_at_to_media_items.exs
new file mode 100644
index 0000000..284dc40
--- /dev/null
+++ b/priv/repo/migrations/20240403164943_add_culled_at_to_media_items.exs
@@ -0,0 +1,10 @@
+defmodule Pinchflat.Repo.Migrations.AddCulledAtToMediaItems do
+ use Ecto.Migration
+
+ def change do
+ alter table(:media_items) do
+ add :culled_at, :utc_datetime
+ add :prevent_culling, :boolean, default: false
+ end
+ end
+end
diff --git a/test/pinchflat/boot/data_backfill_worker_test.exs b/test/pinchflat/boot/data_backfill_worker_test.exs
deleted file mode 100644
index 485f281..0000000
--- a/test/pinchflat/boot/data_backfill_worker_test.exs
+++ /dev/null
@@ -1,46 +0,0 @@
-defmodule Pinchflat.Boot.DataBackfillWorkerTest do
- use Pinchflat.DataCase
-
- alias Pinchflat.Boot.DataBackfillWorker
- alias Pinchflat.JobFixtures.TestJobWorker
-
- describe "cancel_pending_backfill_jobs/0" do
- test "cancels all pending backfill jobs" do
- %{}
- |> DataBackfillWorker.new()
- |> Repo.insert_unique_job()
-
- assert_enqueued(worker: DataBackfillWorker)
-
- DataBackfillWorker.cancel_pending_backfill_jobs()
-
- refute_enqueued(worker: DataBackfillWorker)
- end
-
- test "does not cancel jobs for other workers" do
- %{id: 0}
- |> TestJobWorker.new()
- |> Repo.insert_unique_job()
-
- assert_enqueued(worker: TestJobWorker)
-
- DataBackfillWorker.cancel_pending_backfill_jobs()
-
- assert_enqueued(worker: TestJobWorker)
- end
- end
-
- describe "perform/1" do
- setup do
- DataBackfillWorker.cancel_pending_backfill_jobs()
-
- :ok
- end
-
- test "reschedules itself once complete" do
- perform_job(DataBackfillWorker, %{})
-
- assert_enqueued(worker: DataBackfillWorker, scheduled_at: now_plus(60, :minutes))
- end
- end
-end
diff --git a/test/pinchflat/downloading/media_retention_worker_test.exs b/test/pinchflat/downloading/media_retention_worker_test.exs
new file mode 100644
index 0000000..a77fd76
--- /dev/null
+++ b/test/pinchflat/downloading/media_retention_worker_test.exs
@@ -0,0 +1,70 @@
+defmodule Pinchflat.Downloading.MediaRetentionWorkerTest do
+ use Pinchflat.DataCase
+
+ import Pinchflat.MediaFixtures
+ import Pinchflat.SourcesFixtures
+
+ alias Pinchflat.Media
+ alias Pinchflat.Downloading.MediaRetentionWorker
+
+ describe "perform/1" do
+ test "deletes media files that are past their retention date" do
+ {_source, old_media_item, new_media_item} = prepare_records()
+
+ 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 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()
+
+ 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
+
+ test "doesn't cull media items that have prevent_culling set" do
+ {_source, old_media_item, _new_media_item} = prepare_records()
+
+ 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
+ end
+ end
+
+ defp prepare_records do
+ source = source_fixture(%{retention_period_days: 2})
+
+ old_media_item =
+ media_item_with_attachments(%{
+ source_id: source.id,
+ media_downloaded_at: now_minus(3, :days)
+ })
+
+ new_media_item =
+ media_item_with_attachments(%{
+ source_id: source.id,
+ media_downloaded_at: now_minus(1, :day)
+ })
+
+ {source, old_media_item, new_media_item}
+ end
+end
diff --git a/test/pinchflat/media_test.exs b/test/pinchflat/media_test.exs
index c73c421..3d46571 100644
--- a/test/pinchflat/media_test.exs
+++ b/test/pinchflat/media_test.exs
@@ -38,6 +38,98 @@ 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_pending_media_items_for/1" do
test "it returns pending without a filepath for a given source" do
source = source_fixture()
@@ -233,6 +325,16 @@ defmodule Pinchflat.MediaTest do
end
end
+ describe "list_pending_media_items_for/1 when testing download prevention" do
+ test "returns only media items that are not prevented from downloading" do
+ source = source_fixture()
+ _prevented_media_item = media_item_fixture(%{source_id: source.id, media_filepath: nil, prevent_download: true})
+ media_item = media_item_fixture(%{source_id: source.id, media_filepath: nil, prevent_download: false})
+
+ assert Media.list_pending_media_items_for(source) == [media_item]
+ end
+ end
+
describe "list_downloaded_media_items_for/1" do
test "returns only media items with a media_filepath" do
source = source_fixture()
@@ -320,6 +422,18 @@ defmodule Pinchflat.MediaTest do
assert Media.pending_download?(media_item)
end
+
+ test "returns true if the media item is not prevented from downloading" do
+ media_item = media_item_fixture(%{media_filepath: nil, prevent_download: false})
+
+ assert Media.pending_download?(media_item)
+ end
+
+ test "returns false if the media item is prevented from downloading" do
+ media_item = media_item_fixture(%{media_filepath: nil, prevent_download: true})
+
+ refute Media.pending_download?(media_item)
+ end
end
describe "search/1" do
@@ -587,6 +701,63 @@ defmodule Pinchflat.MediaTest do
end
end
+ describe "delete_media_files/2" do
+ test "does not delete the media_item" do
+ media_item = media_item_fixture()
+
+ assert {:ok, %MediaItem{}} = Media.delete_media_files(media_item)
+ assert Repo.reload!(media_item)
+ end
+
+ test "deletes attached tasks" do
+ media_item = media_item_fixture()
+ task = task_fixture(%{media_item_id: media_item.id})
+
+ assert {:ok, %MediaItem{}} = Media.delete_media_files(media_item)
+ assert_raise Ecto.NoResultsError, fn -> Repo.reload!(task) end
+ end
+
+ test "deletes the media_item's files" do
+ media_item = media_item_with_attachments()
+
+ assert File.exists?(media_item.media_filepath)
+ assert {:ok, _} = Media.delete_media_files(media_item)
+ refute File.exists?(media_item.media_filepath)
+ end
+
+ test "does not delete the media item's metadata files" do
+ stub(HTTPClientMock, :get, fn _url, _headers, _opts -> {: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, %{
+ "thumbnail" => "https://example.com/thumbnail.jpg"
+ })
+ }
+ }
+
+ {:ok, updated_media_item} = Media.update_media_item(media_item, update_attrs)
+ metadata = Repo.preload(updated_media_item, :metadata).metadata
+
+ assert {:ok, _} = Media.delete_media_files(updated_media_item)
+ assert Repo.reload(metadata)
+ assert File.exists?(updated_media_item.metadata.metadata_filepath)
+
+ # cleanup
+ Media.delete_media_item(updated_media_item, delete_files: true)
+ end
+
+ test "can take additional attributes update media item" do
+ media_item = media_item_with_attachments()
+
+ assert {:ok, updated_media_item} = Media.delete_media_files(media_item, %{prevent_download: true})
+ assert updated_media_item.prevent_download
+ end
+ end
+
describe "change_media_item/1" do
test "change_media_item/1 returns a media_item changeset" do
media_item = media_item_fixture()
diff --git a/test/pinchflat_web/controllers/media_item_controller_test.exs b/test/pinchflat_web/controllers/media_item_controller_test.exs
index 428d337..e8e035a 100644
--- a/test/pinchflat_web/controllers/media_item_controller_test.exs
+++ b/test/pinchflat_web/controllers/media_item_controller_test.exs
@@ -10,27 +10,58 @@ defmodule PinchflatWeb.MediaItemControllerTest do
test "renders the page", %{conn: conn, media_item: media_item} do
conn = get(conn, ~p"/sources/#{media_item.source_id}/media/#{media_item}")
- assert html_response(conn, 200) =~ "Media Item ##{media_item.id}"
+
+ assert html_response(conn, 200) =~ "#{media_item.title}"
end
end
- describe "delete media when just deleting the records" do
+ describe "edit media" do
+ setup [:create_media_item]
+
+ test "renders form for editing chosen media_item", %{conn: conn, media_item: media_item} do
+ conn = get(conn, ~p"/sources/#{media_item.source_id}/media/#{media_item}/edit")
+
+ assert html_response(conn, 200) =~ "Editing"
+ end
+ end
+
+ describe "update media" do
+ setup [:create_media_item]
+
+ test "redirects when data is valid", %{conn: conn, media_item: media_item} do
+ update_attrs = %{title: "New Title"}
+
+ conn = put(conn, ~p"/sources/#{media_item.source_id}/media/#{media_item}", media_item: update_attrs)
+ assert redirected_to(conn) == ~p"/sources/#{media_item.source_id}/media/#{media_item}"
+
+ conn = get(conn, ~p"/sources/#{media_item.source_id}/media/#{media_item}")
+ assert html_response(conn, 200) =~ update_attrs[:title]
+ end
+
+ test "renders errors when data is invalid", %{conn: conn, media_item: media_item} do
+ conn = put(conn, ~p"/sources/#{media_item.source_id}/media/#{media_item}", media_item: %{title: nil})
+
+ assert html_response(conn, 200) =~ "Editing"
+ end
+ end
+
+ describe "delete media" do
setup do
media_item = media_item_with_attachments()
%{media_item: media_item}
end
- test "the media item is deleted", %{conn: conn, media_item: media_item} do
+ test "the media item not is deleted", %{conn: conn, media_item: media_item} do
delete(conn, ~p"/sources/#{media_item.source_id}/media/#{media_item.id}")
- assert_raise Ecto.NoResultsError, fn -> Repo.reload!(media_item) end
+ assert Repo.reload!(media_item)
end
- test "the files are not deleted", %{conn: conn, media_item: media_item} do
+ test "the files are deleted", %{conn: conn, media_item: media_item} do
delete(conn, ~p"/sources/#{media_item.source_id}/media/#{media_item.id}")
- assert File.exists?(media_item.media_filepath)
+ refute File.exists?(media_item.media_filepath)
end
test "redirects to the source page", %{conn: conn, media_item: media_item} do
@@ -38,31 +69,21 @@ defmodule PinchflatWeb.MediaItemControllerTest do
assert redirected_to(conn) == ~p"/sources/#{media_item.source_id}"
end
- end
- describe "delete media when deleting the records and files" do
- setup do
- media_item = media_item_with_attachments()
+ test "doesn't prevent re-download by default", %{conn: conn, media_item: media_item} do
+ delete(conn, ~p"/sources/#{media_item.source_id}/media/#{media_item.id}")
- %{media_item: media_item}
+ media_item = Repo.reload(media_item)
+
+ refute media_item.prevent_download
end
- test "the media item is deleted", %{conn: conn, media_item: media_item} do
- delete(conn, ~p"/sources/#{media_item.source_id}/media/#{media_item.id}?delete_files=true")
+ test "can optionally prevent re-download", %{conn: conn, media_item: media_item} do
+ delete(conn, ~p"/sources/#{media_item.source_id}/media/#{media_item.id}?prevent_download=true")
- assert_raise Ecto.NoResultsError, fn -> Repo.reload!(media_item) end
- end
+ media_item = Repo.reload(media_item)
- test "the files are deleted", %{conn: conn, media_item: media_item} do
- delete(conn, ~p"/sources/#{media_item.source_id}/media/#{media_item.id}?delete_files=true")
-
- refute File.exists?(media_item.media_filepath)
- end
-
- test "redirects to the source page", %{conn: conn, media_item: media_item} do
- conn = delete(conn, ~p"/sources/#{media_item.source_id}/media/#{media_item.id}?delete_files=true")
-
- assert redirected_to(conn) == ~p"/sources/#{media_item.source_id}"
+ assert media_item.prevent_download
end
end