Compare commits

...

10 Commits

Author SHA1 Message Date
Kieran Eglin fc8eed8b50 Bumped version 2024-03-26 08:55:04 -07:00
Kieran f42aab286a [Bugfix] Expose port in Dockerfile and force IPv4 (#129)
* Exposes port on built image

* Forced IPv4

* Added current version to sidebar
2024-03-26 08:54:20 -07:00
Kieran bf11cd0dd9 Added description to source (#124) 2024-03-25 15:40:09 -07:00
Kieran Eglin e051a37f0d Pushed bug comment 2024-03-25 12:15:21 -07:00
Kieran Eglin 64ebf756ab Bumped version 2024-03-25 11:56:31 -07:00
Kieran 377bc617ea Removed unneeded startup tasks (#121) 2024-03-25 11:52:02 -07:00
Kieran a03f69a8d4 Started storing source images in internal metadata folder (#120) 2024-03-25 11:36:03 -07:00
Kieran d39ebe7ac1 Improve default recommendation for artist placeholder (#119)
* Improved default recommendation for audio artist placeholder

* Updated docs
2024-03-25 10:34:22 -07:00
Kieran 8b5dcc15d6 Fixed filepath bug when parsing metadata (#118) 2024-03-25 10:20:29 -07:00
Kieran 5e58dcd879 Cookie auth (#116)
* Added new extras directory

* Automatically create cookie file on boot

* Added cookie file option to DL option builder

* Put cookie auth in correct spot

* Updated Docs

* Removed useless setter for config path
2024-03-24 20:23:25 -07:00
33 changed files with 10152 additions and 129 deletions
+2
View File
@@ -21,3 +21,5 @@ alias Pinchflat.FastIndexing.YoutubeRss
alias Pinchflat.Metadata.MetadataFileHelpers alias Pinchflat.Metadata.MetadataFileHelpers
alias Pinchflat.SlowIndexing.FileFollowerServer alias Pinchflat.SlowIndexing.FileFollowerServer
Pinchflat.Release.check_file_permissions()
+2 -1
View File
@@ -49,6 +49,7 @@ If it doesn't work for your use case, please make a feature request! You can als
- Custom rules for handling YouTube Shorts and livestreams - Custom rules for handling YouTube Shorts and livestreams
- Advanced options like setting cutoff dates and filtering by title - Advanced options like setting cutoff dates and filtering by title
- Reliable hands-off operation - Reliable hands-off operation
- Can pass cookies to YouTube to download your private playlists ([docs](https://github.com/kieraneglin/pinchflat/wiki/YouTube-Cookies))
## Screenshots ## Screenshots
@@ -102,7 +103,7 @@ You _must_ ensure the host directories you've mounted are writable by the user r
It's recommended to not run the container as root. Doing so can create permission issues if other apps need to work with the downloaded media. If you need to run any command as root, you can run `su` from the container's shell as there is no password set for the root user. It's recommended to not run the container as root. Doing so can create permission issues if other apps need to work with the downloaded media. If you need to run any command as root, you can run `su` from the container's shell as there is no password set for the root user.
## Authentication ## Username and Password
HTTP basic authentication is optionally supported. To use it, set the `BASIC_AUTH_USERNAME` and `BASIC_AUTH_PASSWORD` environment variables when starting the container. No authentication will be required unless you set _both_ of these. HTTP basic authentication is optionally supported. To use it, set the `BASIC_AUTH_USERNAME` and `BASIC_AUTH_PASSWORD` environment variables when starting the container. No authentication will be required unless you set _both_ of these.
+1
View File
@@ -16,6 +16,7 @@ config :pinchflat,
media_directory: "/downloads", media_directory: "/downloads",
# The user may or may not store metadata for their needs, but the app will always store its copy # The user may or may not store metadata for their needs, but the app will always store its copy
metadata_directory: "/config/metadata", metadata_directory: "/config/metadata",
extras_directory: "/config/extras",
tmpfile_directory: Path.join([System.tmp_dir!(), "pinchflat", "data"]), tmpfile_directory: Path.join([System.tmp_dir!(), "pinchflat", "data"]),
# Setting BASIC_AUTH_USERNAME and BASIC_AUTH_PASSWORD implies you want to use basic auth. # Setting BASIC_AUTH_USERNAME and BASIC_AUTH_PASSWORD implies you want to use basic auth.
# If either is unset, basic auth will not be used. # If either is unset, basic auth will not be used.
+1
View File
@@ -3,6 +3,7 @@ import Config
config :pinchflat, config :pinchflat,
media_directory: Path.join([File.cwd!(), "tmp", "media"]), media_directory: Path.join([File.cwd!(), "tmp", "media"]),
metadata_directory: Path.join([File.cwd!(), "tmp", "metadata"]), metadata_directory: Path.join([File.cwd!(), "tmp", "metadata"]),
extras_directory: Path.join([File.cwd!(), "tmp", "extras"]),
tmpfile_directory: Path.join([File.cwd!(), "tmp", "tmpfiles"]) tmpfile_directory: Path.join([File.cwd!(), "tmp", "tmpfiles"])
# Configure your database # Configure your database
+6 -8
View File
@@ -41,16 +41,11 @@ config :pinchflat, Pinchflat.Repo,
] ]
if config_env() == :prod do if config_env() == :prod do
config_path = config_path = "/config"
System.get_env("CONFIG_PATH") ||
raise """
environment variable CONFIG_PATH is missing.
For example: /etc/pinchflat/config
"""
db_path = System.get_env("DATABASE_PATH", Path.join([config_path, "db", "pinchflat.db"])) db_path = System.get_env("DATABASE_PATH", Path.join([config_path, "db", "pinchflat.db"]))
log_path = System.get_env("LOG_PATH", Path.join([config_path, "logs", "pinchflat.log"])) 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"])) metadata_path = System.get_env("METADATA_PATH", Path.join([config_path, "metadata"]))
extras_path = System.get_env("EXTRAS_PATH", Path.join([config_path, "extras"]))
# We want to force _some_ level of useful logging in production # We want to force _some_ level of useful logging in production
acceptable_log_levels = ~w(debug info)a acceptable_log_levels = ~w(debug info)a
@@ -65,7 +60,10 @@ if config_env() == :prod do
config :pinchflat, config :pinchflat,
yt_dlp_executable: System.find_executable("yt-dlp"), yt_dlp_executable: System.find_executable("yt-dlp"),
media_directory: "/downloads",
metadata_directory: metadata_path, metadata_directory: metadata_path,
extras_directory: extras_path,
tmpfile_directory: Path.join([System.tmp_dir!(), "pinchflat", "data"]),
dns_cluster_query: System.get_env("DNS_CLUSTER_QUERY") dns_cluster_query: System.get_env("DNS_CLUSTER_QUERY")
config :pinchflat, Pinchflat.Repo, config :pinchflat, Pinchflat.Repo,
@@ -104,7 +102,7 @@ if config_env() == :prod do
# Set it to {0, 0, 0, 0, 0, 0, 0, 1} for local network only access. # Set it to {0, 0, 0, 0, 0, 0, 0, 1} for local network only access.
# See the documentation on https://hexdocs.pm/plug_cowboy/Plug.Cowboy.html # See the documentation on https://hexdocs.pm/plug_cowboy/Plug.Cowboy.html
# for details about using IPv6 vs IPv4 and loopback vs public addresses. # for details about using IPv6 vs IPv4 and loopback vs public addresses.
ip: {0, 0, 0, 0, 0, 0, 0, 0}, ip: {0, 0, 0, 0},
port: String.to_integer(System.get_env("PORT") || "4000") port: String.to_integer(System.get_env("PORT") || "4000")
], ],
secret_key_base: secret_key_base secret_key_base: secret_key_base
+2 -15
View File
@@ -18,7 +18,6 @@ defmodule Pinchflat.Boot.DataBackfillWorker do
alias __MODULE__ alias __MODULE__
alias Pinchflat.Repo alias Pinchflat.Repo
alias Pinchflat.Media.MediaItem
@doc """ @doc """
Cancels all pending backfill jobs. Useful for ensuring worker runs immediately Cancels all pending backfill jobs. Useful for ensuring worker runs immediately
@@ -44,26 +43,14 @@ defmodule Pinchflat.Boot.DataBackfillWorker do
""" """
def perform(%Oban.Job{}) do def perform(%Oban.Job{}) do
Logger.info("Running data backfill worker") Logger.info("Running data backfill worker")
backfill_shorts_data() # Nothing to do for now - just reschedule
# Keeping in-place because we _will_ need it in the future
reschedule_backfill() reschedule_backfill()
:ok :ok
end end
defp backfill_shorts_data do
query =
from(
m in MediaItem,
where: fragment("? like ?", m.original_url, "%/shorts/%"),
where: m.short_form_content == false
)
{count, _} = Repo.update_all(query, set: [short_form_content: true])
Logger.info("Backfill worker set short_form_content to true for #{count} media items.")
end
defp reschedule_backfill do defp reschedule_backfill do
# Run hourly # Run hourly
next_run_in = 60 * 60 next_run_in = 60 * 60
+13 -30
View File
@@ -14,6 +14,7 @@ defmodule Pinchflat.Boot.PreJobStartupTasks do
alias Pinchflat.Repo alias Pinchflat.Repo
alias Pinchflat.Settings alias Pinchflat.Settings
alias Pinchflat.Filesystem.FilesystemHelpers
def start_link(opts \\ []) do def start_link(opts \\ []) do
GenServer.start_link(__MODULE__, %{}, opts) GenServer.start_link(__MODULE__, %{}, opts)
@@ -31,8 +32,8 @@ defmodule Pinchflat.Boot.PreJobStartupTasks do
@impl true @impl true
def init(state) do def init(state) do
reset_executing_jobs() reset_executing_jobs()
create_blank_cookie_file()
apply_default_settings() apply_default_settings()
rename_old_job_workers()
{:ok, state} {:ok, state}
end end
@@ -49,37 +50,19 @@ defmodule Pinchflat.Boot.PreJobStartupTasks do
Logger.info("Reset #{count} executing jobs") Logger.info("Reset #{count} executing jobs")
end end
defp create_blank_cookie_file do
base_dir = Application.get_env(:pinchflat, :extras_directory)
filepath = Path.join(base_dir, "cookies.txt")
if !File.exists?(filepath) do
Logger.info("Cookies does not exist - creating it")
FilesystemHelpers.write_p!(filepath, "")
end
end
defp apply_default_settings do defp apply_default_settings do
Settings.fetch!(:onboarding, true) Settings.fetch!(:onboarding, true)
Settings.fetch!(:pro_enabled, false) Settings.fetch!(:pro_enabled, false)
end end
# As part of a large refactor, I ended up moving a bunch of workers around. This
# is a problem because the workers are stored in the database and the runner
# will try to run the OLD jobs. This is also why these tasks run before the job
# runner starts up.
#
# Can be removed after a few months (created: 2024-03-12)
defp rename_old_job_workers do
# [ [old_name, new_name], ...]
rename_map = [
["Pinchflat.Workers.MediaIndexingWorker", "Pinchflat.FastIndexing.MediaIndexingWorker"],
["Pinchflat.Workers.MediaDownloadWorker", "Pinchflat.Downloading.MediaDownloadWorker"],
["Pinchflat.Workers.FastIndexingWorker", "Pinchflat.FastIndexing.FastIndexingWorker"],
["Pinchflat.Workers.MediaCollectionIndexingWorker", "Pinchflat.SlowIndexing.MediaCollectionIndexingWorker"],
["Pinchflat.Workers.DataBackfillWorker", "Pinchflat.Boot.DataBackfillWorker"]
]
jobs_renamed =
Enum.reduce(rename_map, 0, fn [old_name, new_name], acc ->
{count, _} =
Oban.Job
|> where(worker: ^old_name)
|> Repo.update_all(set: [worker: new_name])
acc + count
end)
Logger.info("Renamed #{jobs_renamed} old job workers")
end
end end
@@ -42,7 +42,8 @@ defmodule Pinchflat.Downloading.OutputPathBuilder do
"upload_day" => "%(upload_date>%d)S", "upload_day" => "%(upload_date>%d)S",
"upload_yyyy_mm_dd" => "%(upload_date>%Y-%m-%d)S", "upload_yyyy_mm_dd" => "%(upload_date>%Y-%m-%d)S",
"season_from_date" => "%(upload_date>%Y)S", "season_from_date" => "%(upload_date>%Y)S",
"season_episode_from_date" => "s%(upload_date>%Y)Se%(upload_date>%m%d)S" "season_episode_from_date" => "s%(upload_date>%Y)Se%(upload_date>%m%d)S",
"artist_name" => "%(artist,creator,uploader,uploader_id)S"
} }
end end
end end
@@ -11,6 +11,22 @@ defmodule Pinchflat.Metadata.MetadataFileHelpers do
alias Pinchflat.Filesystem.FilesystemHelpers alias Pinchflat.Filesystem.FilesystemHelpers
@doc """
Returns the directory where metadata for a database record should be stored.
Returns binary()
"""
def metadata_directory_for(database_record) do
metadata_directory = Application.get_env(:pinchflat, :metadata_directory)
record_table_name = database_record.__meta__.source
Path.join([
metadata_directory,
record_table_name,
to_string(database_record.id)
])
end
@doc """ @doc """
Compresses and stores metadata for a media item, returning the filepath. Compresses and stores metadata for a media item, returning the filepath.
@@ -108,13 +124,8 @@ defmodule Pinchflat.Metadata.MetadataFileHelpers do
end end
defp generate_filepath_for(database_record, filename) do defp generate_filepath_for(database_record, filename) do
metadata_directory = Application.get_env(:pinchflat, :metadata_directory)
record_table_name = database_record.__meta__.source
Path.join([ Path.join([
metadata_directory, metadata_directory_for(database_record),
record_table_name,
to_string(database_record.id),
filename filename
]) ])
end end
+19 -4
View File
@@ -58,23 +58,38 @@ defmodule Pinchflat.Metadata.MetadataParser do
# NOTE: whole ordeal needed due to a bug I found in yt-dlp # NOTE: whole ordeal needed due to a bug I found in yt-dlp
# https://github.com/yt-dlp/yt-dlp/issues/9445 # https://github.com/yt-dlp/yt-dlp/issues/9445
# Can be reverted to remove this entire conditional once fixed # Can be reverted to remove this entire conditional once fixed
%{ filepath =
thumbnail_filepath:
thumbnail_filepath thumbnail_filepath
|> String.split(~r{\.}, include_captures: true) |> String.split(~r{\.}, include_captures: true)
|> List.insert_at(-3, "-thumb") |> List.insert_at(-3, "-thumb")
|> Enum.join() |> Enum.join()
%{
thumbnail_filepath: filepath_if_exists(filepath)
} }
else else
%{ %{
thumbnail_filepath: thumbnail_filepath thumbnail_filepath: nil
} }
end end
end end
defp parse_infojson_metadata(metadata) do defp parse_infojson_metadata(metadata) do
%{ %{
metadata_filepath: metadata["infojson_filename"] metadata_filepath: filepath_if_exists(metadata["infojson_filename"])
} }
end end
# NOTE: this should not be needed, but it is due to a bug in yt-dlp.
# Can remove once this is resolved:
# https://github.com/yt-dlp/yt-dlp/issues/9445#issuecomment-2018724344
defp filepath_if_exists(nil), do: nil
defp filepath_if_exists(filepath) do
if File.exists?(filepath) do
filepath
else
nil
end
end
end end
+16 -2
View File
@@ -10,11 +10,20 @@ defmodule Pinchflat.Metadata.SourceMetadata do
alias Pinchflat.Sources.Source alias Pinchflat.Sources.Source
@allowed_fields ~w(metadata_filepath)a @allowed_fields ~w(
metadata_filepath
fanart_filepath
poster_filepath
banner_filepath
)a
@required_fields ~w(metadata_filepath)a @required_fields ~w(metadata_filepath)a
schema "source_metadata" do schema "source_metadata" do
field :metadata_filepath, :string field :metadata_filepath, :string
field :fanart_filepath, :string
field :poster_filepath, :string
field :banner_filepath, :string
belongs_to :source, Source belongs_to :source, Source
@@ -31,6 +40,11 @@ defmodule Pinchflat.Metadata.SourceMetadata do
@doc false @doc false
def filepath_attributes do def filepath_attributes do
~w(metadata_filepath)a ~w(
metadata_filepath
fanart_filepath
poster_filepath
banner_filepath
)a
end end
end end
@@ -32,6 +32,7 @@ defmodule Pinchflat.Metadata.SourceMetadataStorageWorker do
@doc """ @doc """
Fetches and stores various forms of metadata for a source: Fetches and stores various forms of metadata for a source:
- Attributes like `description`
- JSON metadata for internal use - JSON metadata for internal use
- The series directory for the source - The series directory for the source
- The NFO file for the source (if specified) - The NFO file for the source (if specified)
@@ -47,21 +48,24 @@ defmodule Pinchflat.Metadata.SourceMetadataStorageWorker do
def perform(%Oban.Job{args: %{"id" => source_id}}) do def perform(%Oban.Job{args: %{"id" => source_id}}) do
source = Repo.preload(Sources.get_source!(source_id), [:metadata, :media_profile]) source = Repo.preload(Sources.get_source!(source_id), [:metadata, :media_profile])
series_directory = determine_series_directory(source) series_directory = determine_series_directory(source)
{source_metadata, image_filepath_attrs} = fetch_source_metadata_and_images(series_directory, source)
# `run_post_commit_tasks: false` prevents this from running in an infinite loop {source_metadata, source_image_attrs, metadata_image_attrs} =
fetch_source_metadata_and_images(series_directory, source)
source_metadata_filepath = MetadataFileHelpers.compress_and_store_metadata_for(source, source_metadata)
Sources.update_source( Sources.update_source(
source, source,
Map.merge( Map.merge(
%{ %{
series_directory: series_directory, series_directory: series_directory,
nfo_filepath: store_source_nfo(source, series_directory, source_metadata), nfo_filepath: store_source_nfo(source, series_directory, source_metadata),
metadata: %{ description: source_metadata["description"],
metadata_filepath: MetadataFileHelpers.compress_and_store_metadata_for(source, source_metadata) metadata: Map.merge(%{metadata_filepath: source_metadata_filepath}, metadata_image_attrs)
}
}, },
image_filepath_attrs source_image_attrs
), ),
# `run_post_commit_tasks: false` prevents this from running in an infinite loop
run_post_commit_tasks: false run_post_commit_tasks: false
) )
@@ -72,18 +76,19 @@ defmodule Pinchflat.Metadata.SourceMetadataStorageWorker do
end end
defp fetch_source_metadata_and_images(series_directory, source) do defp fetch_source_metadata_and_images(series_directory, source) do
if source.media_profile.download_source_images && series_directory do metadata_directory = MetadataFileHelpers.metadata_directory_for(source)
output_path = "#{tmp_directory()}/#{StringUtils.random_string(16)}/source_image.%(ext)S" tmp_output_path = "#{tmp_directory()}/#{StringUtils.random_string(16)}/source_image.%(ext)S"
opts = [:write_all_thumbnails, convert_thumbnails: "jpg", output: output_path] opts = [:write_all_thumbnails, convert_thumbnails: "jpg", output: tmp_output_path]
{:ok, metadata} = MediaCollection.get_source_metadata(source.original_url, opts) {:ok, metadata} = MediaCollection.get_source_metadata(source.original_url, opts)
image_attrs = SourceImageParser.store_source_images(series_directory, metadata) metadata_image_attrs = SourceImageParser.store_source_images(metadata_directory, metadata)
{metadata, image_attrs} if source.media_profile.download_source_images && series_directory do
source_image_attrs = SourceImageParser.store_source_images(series_directory, metadata)
{metadata, source_image_attrs, metadata_image_attrs}
else else
{:ok, metadata} = MediaCollection.get_source_metadata(source.original_url, []) {metadata, %{}, metadata_image_attrs}
{metadata, %{}}
end end
end end
+1
View File
@@ -30,6 +30,7 @@ defmodule Pinchflat.Release do
"/downloads", "/downloads",
Application.get_env(:pinchflat, :media_directory), Application.get_env(:pinchflat, :media_directory),
Application.get_env(:pinchflat, :tmpfile_directory), Application.get_env(:pinchflat, :tmpfile_directory),
Application.get_env(:pinchflat, :extras_directory),
Application.get_env(:pinchflat, :metadata_directory) Application.get_env(:pinchflat, :metadata_directory)
] ]
+2
View File
@@ -17,6 +17,7 @@ defmodule Pinchflat.Sources.Source do
collection_id collection_id
collection_type collection_type
custom_name custom_name
description
nfo_filepath nfo_filepath
poster_filepath poster_filepath
fanart_filepath fanart_filepath
@@ -55,6 +56,7 @@ defmodule Pinchflat.Sources.Source do
schema "sources" do schema "sources" do
field :custom_name, :string field :custom_name, :string
field :description, :string
field :collection_name, :string field :collection_name, :string
field :collection_id, :string field :collection_id, :string
field :collection_type, Ecto.Enum, values: [:channel, :playlist] field :collection_type, Ecto.Enum, values: [:channel, :playlist]
+15 -1
View File
@@ -31,7 +31,8 @@ defmodule Pinchflat.YtDlp.CommandRunner do
# Also, can't use RAM file since yt-dlp needs a concrete filepath. # Also, can't use RAM file since yt-dlp needs a concrete filepath.
output_filepath = Keyword.get(addl_opts, :output_filepath, FSUtils.generate_metadata_tmpfile(:json)) output_filepath = Keyword.get(addl_opts, :output_filepath, FSUtils.generate_metadata_tmpfile(:json))
print_to_file_opts = [{:print_to_file, output_template}, output_filepath] print_to_file_opts = [{:print_to_file, output_template}, output_filepath]
formatted_command_opts = [url] ++ parse_options(command_opts ++ print_to_file_opts) cookie_opts = build_cookie_options()
formatted_command_opts = [url] ++ parse_options(command_opts ++ print_to_file_opts ++ cookie_opts)
Logger.info("[yt-dlp] called with: #{Enum.join(formatted_command_opts, " ")}") Logger.info("[yt-dlp] called with: #{Enum.join(formatted_command_opts, " ")}")
@@ -47,6 +48,19 @@ defmodule Pinchflat.YtDlp.CommandRunner do
end end
end end
defp build_cookie_options do
base_dir = Application.get_env(:pinchflat, :extras_directory)
cookie_file = Path.join(base_dir, "cookies.txt")
case File.read(cookie_file) do
{:ok, cookie_data} ->
if String.trim(cookie_data) != "", do: [cookies: cookie_file], else: []
{:error, _} ->
[]
end
end
# We want to satisfy the following behaviours: # We want to satisfy the following behaviours:
# #
# 1. If the key is an atom, convert it to a string and convert it to kebab case (for convenience) # 1. If the key is an atom, convert it to a string and convert it to kebab case (for convenience)
@@ -57,6 +57,11 @@
<.icon name="hero-currency-dollar" /> Donate <.icon name="hero-currency-dollar" /> Donate
</span> </span>
</li> </li>
<li>
<span class="group relative flex items-center gap-2.5 px-4 py-2 text-sm">
v<%= Application.spec(:pinchflat)[:vsn] %>
</span>
</li>
</ul> </ul>
</nav> </nav>
</section> </section>
@@ -39,7 +39,8 @@ defmodule PinchflatWeb.MediaProfiles.MediaProfileHTML do
upload_year: nil, upload_year: nil,
upload_yyyy_mm_dd: "the upload date in the format YYYY-MM-DD", upload_yyyy_mm_dd: "the upload date in the format YYYY-MM-DD",
source_custom_name: "the name of the sources that use this profile", source_custom_name: "the name of the sources that use this profile",
source_collection_type: "the collection type of the sources that use this profile. Either 'channel' or 'playlist'" source_collection_type: "the collection type of the sources using this profile. Either 'channel' or 'playlist'",
artist_name: "the name of the artist with fallbacks to other uploader fields"
} }
end end
@@ -74,6 +75,6 @@ defmodule PinchflatWeb.MediaProfiles.MediaProfileHTML do
end end
defp audio_output_template do defp audio_output_template do
"/music/{{ source_custom_name }}/{{ title }}.{{ ext }}" "/music/{{ artist_name }}/{{ title }}.{{ ext }}"
end end
end end
+1 -1
View File
@@ -4,7 +4,7 @@ defmodule Pinchflat.MixProject do
def project do def project do
[ [
app: :pinchflat, app: :pinchflat,
version: "0.1.1", version: "0.1.3",
elixir: "~> 1.16", elixir: "~> 1.16",
elixirc_paths: elixirc_paths(Mix.env()), elixirc_paths: elixirc_paths(Mix.env()),
start_permanent: Mix.env() == :prod, start_permanent: Mix.env() == :prod,
@@ -0,0 +1,11 @@
defmodule Pinchflat.Repo.Migrations.AddImageAttrsToSourceMetadata do
use Ecto.Migration
def change do
alter table(:source_metadata) do
add :fanart_filepath, :string
add :poster_filepath, :string
add :banner_filepath, :string
end
end
end
@@ -0,0 +1,9 @@
defmodule Pinchflat.Repo.Migrations.AddDescriptionToSource do
use Ecto.Migration
def change do
alter table(:sources) do
add :description, :string
end
end
end
+5 -3
View File
@@ -75,9 +75,11 @@ RUN mix release
# the compiled release and other runtime necessities # the compiled release and other runtime necessities
FROM ${RUNNER_IMAGE} FROM ${RUNNER_IMAGE}
ARG PORT=8945
RUN apt-get update -y RUN apt-get update -y
RUN apt-get install -y libstdc++6 openssl libncurses5 locales ca-certificates \ RUN apt-get install -y libstdc++6 openssl libncurses5 locales ca-certificates \
ffmpeg curl git openssh-client ffmpeg curl git openssh-client nano
RUN apt-get clean && rm -f /var/lib/apt/lists/*_* RUN apt-get clean && rm -f /var/lib/apt/lists/*_*
# Download and update YT-DLP # Download and update YT-DLP
@@ -101,9 +103,9 @@ RUN chown nobody /config /downloads
# set runner ENV # set runner ENV
ENV MIX_ENV="prod" ENV MIX_ENV="prod"
ENV CONFIG_PATH="/config" ENV PORT=${PORT}
ENV PORT=8945
ENV RUN_CONTEXT="selfhosted" ENV RUN_CONTEXT="selfhosted"
EXPOSE ${PORT}
# Only copy the final release from the build stage # Only copy the final release from the build stage
COPY --from=builder --chown=nobody:root /app/_build/${MIX_ENV}/rel/pinchflat ./ COPY --from=builder --chown=nobody:root /app/_build/${MIX_ENV}/rel/pinchflat ./
@@ -1,8 +1,6 @@
defmodule Pinchflat.Boot.DataBackfillWorkerTest do defmodule Pinchflat.Boot.DataBackfillWorkerTest do
use Pinchflat.DataCase use Pinchflat.DataCase
import Pinchflat.MediaFixtures
alias Pinchflat.Boot.DataBackfillWorker alias Pinchflat.Boot.DataBackfillWorker
alias Pinchflat.JobFixtures.TestJobWorker alias Pinchflat.JobFixtures.TestJobWorker
@@ -45,26 +43,4 @@ defmodule Pinchflat.Boot.DataBackfillWorkerTest do
assert_enqueued(worker: DataBackfillWorker, scheduled_at: now_plus(60, :minutes)) assert_enqueued(worker: DataBackfillWorker, scheduled_at: now_plus(60, :minutes))
end end
end end
describe "perform/1 when testing backfill_shorts_data" do
test "sets short_form_content to true for media items with shorts in the URL" do
media_item = media_item_with_attachments(%{original_url: "https://example.com/shorts/123"})
refute media_item.short_form_content
perform_job(DataBackfillWorker, %{})
assert Repo.reload!(media_item).short_form_content
end
test "does not set short_form_content to true for media items without shorts in the URL" do
media_item = media_item_with_attachments(%{original_url: "https://example.com/longs/123"})
refute media_item.short_form_content
perform_job(DataBackfillWorker, %{})
refute Repo.reload!(media_item).short_form_content
end
end
end end
@@ -1,8 +1,8 @@
defmodule Pinchflat.Downloading.DownloadOptionBuilderTest do defmodule Pinchflat.Downloading.DownloadOptionBuilderTest do
use Pinchflat.DataCase use Pinchflat.DataCase
import Pinchflat.MediaFixtures import Pinchflat.MediaFixtures
import Pinchflat.ProfilesFixtures
import Pinchflat.SourcesFixtures import Pinchflat.SourcesFixtures
import Pinchflat.ProfilesFixtures
alias Pinchflat.Profiles alias Pinchflat.Profiles
alias Pinchflat.Downloading.DownloadOptionBuilder alias Pinchflat.Downloading.DownloadOptionBuilder
@@ -58,7 +58,7 @@ defmodule Pinchflat.Downloading.MediaDownloaderTest do
describe "download_for_media_item/3 when testing media_item attributes" do describe "download_for_media_item/3 when testing media_item attributes" do
setup do setup do
expect(YtDlpRunnerMock, :run, fn _url, _opts, _ot -> stub(YtDlpRunnerMock, :run, fn _url, _opts, _ot ->
{:ok, render_metadata(:media_metadata)} {:ok, render_metadata(:media_metadata)}
end) end)
@@ -94,15 +94,44 @@ defmodule Pinchflat.Downloading.MediaDownloaderTest do
end end
test "it extracts the thumbnail_filepath", %{media_item: media_item} do test "it extracts the thumbnail_filepath", %{media_item: media_item} do
expect(YtDlpRunnerMock, :run, fn _url, _opts, _ot ->
metadata = render_parsed_metadata(:media_metadata)
thumbnail_filepath =
metadata["thumbnails"]
|> Enum.reverse()
|> Enum.find_value(fn attrs -> attrs["filepath"] end)
|> String.split(~r{\.}, include_captures: true)
|> List.insert_at(-3, "-thumb")
|> Enum.join()
:ok = File.cp(thumbnail_filepath_fixture(), thumbnail_filepath)
{:ok, Phoenix.json_library().encode!(metadata)}
end)
assert media_item.thumbnail_filepath == nil assert media_item.thumbnail_filepath == nil
assert {:ok, updated_media_item} = MediaDownloader.download_for_media_item(media_item) assert {:ok, updated_media_item} = MediaDownloader.download_for_media_item(media_item)
assert String.ends_with?(updated_media_item.thumbnail_filepath, ".webp") assert String.ends_with?(updated_media_item.thumbnail_filepath, ".webp")
File.rm(updated_media_item.thumbnail_filepath)
end end
test "it extracts the metadata_filepath", %{media_item: media_item} do test "it extracts the metadata_filepath", %{media_item: media_item} do
expect(YtDlpRunnerMock, :run, fn _url, _opts, _ot ->
metadata = render_parsed_metadata(:media_metadata)
infojson_filepath = metadata["infojson_filename"]
:ok = File.cp(infojson_filepath_fixture(), infojson_filepath)
{:ok, Phoenix.json_library().encode!(metadata)}
end)
assert media_item.metadata_filepath == nil assert media_item.metadata_filepath == nil
assert {:ok, updated_media_item} = MediaDownloader.download_for_media_item(media_item) assert {:ok, updated_media_item} = MediaDownloader.download_for_media_item(media_item)
assert String.ends_with?(updated_media_item.metadata_filepath, ".info.json") assert String.ends_with?(updated_media_item.metadata_filepath, ".info.json")
File.rm(updated_media_item.metadata_filepath)
end end
end end
@@ -140,4 +140,14 @@ defmodule Pinchflat.Metadata.MetadataFileHelpersTest do
end end
end end
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)
metadata_directory = Helpers.metadata_directory_for(media_item)
assert metadata_directory == Path.join([base_metadata_directory, "media_items", "#{media_item.id}"])
end
end
end end
@@ -1,5 +1,6 @@
defmodule Pinchflat.Metadata.MetadataParserTest do defmodule Pinchflat.Metadata.MetadataParserTest do
use Pinchflat.DataCase use Pinchflat.DataCase
import Pinchflat.MediaFixtures
alias Pinchflat.Metadata.MetadataParser, as: Parser alias Pinchflat.Metadata.MetadataParser, as: Parser
@@ -88,6 +89,22 @@ defmodule Pinchflat.Metadata.MetadataParserTest do
end end
describe "parse_for_media_item/1 when testing thumbnail metadata" do describe "parse_for_media_item/1 when testing thumbnail metadata" do
setup %{metadata: metadata} do
thumbnail_filepath =
metadata["thumbnails"]
|> Enum.reverse()
|> Enum.find_value(fn attrs -> attrs["filepath"] end)
|> String.split(~r{\.}, include_captures: true)
|> List.insert_at(-3, "-thumb")
|> Enum.join()
:ok = File.cp(thumbnail_filepath_fixture(), thumbnail_filepath)
on_exit(fn -> File.rm(thumbnail_filepath) end)
{:ok, filepath: thumbnail_filepath}
end
test "extracts the thumbnail filepath", %{metadata: metadata} do test "extracts the thumbnail filepath", %{metadata: metadata} do
result = Parser.parse_for_media_item(metadata) result = Parser.parse_for_media_item(metadata)
@@ -103,6 +120,14 @@ defmodule Pinchflat.Metadata.MetadataParserTest do
assert String.contains?(result.thumbnail_filepath, "-thumb.webp") assert String.contains?(result.thumbnail_filepath, "-thumb.webp")
end end
test "doesn't include thumbnail if the file doesn't exist on-disk", %{metadata: metadata, filepath: filepath} do
File.rm(filepath)
result = Parser.parse_for_media_item(metadata)
assert result.thumbnail_filepath == nil
end
test "doesn't freak out if the media has no thumbnails", %{metadata: metadata} do test "doesn't freak out if the media has no thumbnails", %{metadata: metadata} do
metadata = Map.put(metadata, "thumbnails", %{}) metadata = Map.put(metadata, "thumbnails", %{})
@@ -121,12 +146,29 @@ defmodule Pinchflat.Metadata.MetadataParserTest do
end end
describe "parse_for_media_item/1 when testing infojson metadata" do describe "parse_for_media_item/1 when testing infojson metadata" do
setup %{metadata: metadata} do
infojson_filepath = metadata["infojson_filename"]
:ok = File.cp(infojson_filepath_fixture(), infojson_filepath)
on_exit(fn -> File.rm(infojson_filepath) end)
{:ok, filepath: infojson_filepath}
end
test "extracts the metadata filepath", %{metadata: metadata} do test "extracts the metadata filepath", %{metadata: metadata} do
result = Parser.parse_for_media_item(metadata) result = Parser.parse_for_media_item(metadata)
assert String.ends_with?(result.metadata_filepath, ".info.json") assert String.ends_with?(result.metadata_filepath, ".info.json")
end end
test "doesn't include metadata if the file doesn't exist on-disk", %{metadata: metadata, filepath: filepath} do
File.rm(filepath)
result = Parser.parse_for_media_item(metadata)
assert result.metadata_filepath == nil
end
test "doesn't freak out if the media has no infojson", %{metadata: metadata} do test "doesn't freak out if the media has no infojson", %{metadata: metadata} do
metadata = Map.put(metadata, "infojson_filename", nil) metadata = Map.put(metadata, "infojson_filename", nil)
@@ -50,6 +50,23 @@ defmodule Pinchflat.Metadata.SourceMetadataStorageWorkerTest do
end end
end end
describe "perform/1 when testing attribute updates" do
test "the source description is saved" 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 -> {:ok, render_metadata(:channel_source_metadata)}
end)
source = source_fixture()
refute source.description
perform_job(SourceMetadataStorageWorker, %{id: source.id})
source = Repo.preload(Repo.reload(source), :metadata)
assert source.description == "This is a test file for Pinchflat"
end
end
describe "perform/1 when testing metadata storage" do describe "perform/1 when testing metadata storage" do
test "sets metadata location for source" do test "sets metadata location for source" do
stub(YtDlpRunnerMock, :run, fn stub(YtDlpRunnerMock, :run, fn
@@ -59,7 +76,6 @@ defmodule Pinchflat.Metadata.SourceMetadataStorageWorkerTest do
source = Repo.preload(source_fixture(), :metadata) source = Repo.preload(source_fixture(), :metadata)
refute source.metadata
perform_job(SourceMetadataStorageWorker, %{id: source.id}) perform_job(SourceMetadataStorageWorker, %{id: source.id})
source = Repo.preload(Repo.reload(source), :metadata) source = Repo.preload(Repo.reload(source), :metadata)
@@ -83,6 +99,42 @@ defmodule Pinchflat.Metadata.SourceMetadataStorageWorkerTest do
assert metadata == %{"title" => "test"} assert metadata == %{"title" => "test"}
end end
test "sets metadata image location for source" 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 -> {:ok, render_metadata(:channel_source_metadata)}
end)
source = source_fixture()
perform_job(SourceMetadataStorageWorker, %{id: source.id})
source = Repo.preload(Repo.reload(source), :metadata)
assert source.metadata.fanart_filepath
assert source.metadata.poster_filepath
assert source.metadata.banner_filepath
Sources.delete_source(source, delete_files: true)
end
test "stores metadata images for source" 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 -> {:ok, render_metadata(:channel_source_metadata)}
end)
source = source_fixture()
perform_job(SourceMetadataStorageWorker, %{id: source.id})
source = Repo.preload(Repo.reload(source), :metadata)
assert File.exists?(source.metadata.fanart_filepath)
assert File.exists?(source.metadata.poster_filepath)
assert File.exists?(source.metadata.banner_filepath)
Sources.delete_source(source, delete_files: true)
end
end end
describe "perform/1 when testing source image downloading" do describe "perform/1 when testing source image downloading" do
@@ -1,6 +1,8 @@
defmodule Pinchflat.YtDlp.CommandRunnerTest do defmodule Pinchflat.YtDlp.CommandRunnerTest do
use ExUnit.Case, async: true use ExUnit.Case, async: true
alias Pinchflat.Filesystem.FilesystemHelpers
alias Pinchflat.YtDlp.CommandRunner, as: Runner alias Pinchflat.YtDlp.CommandRunner, as: Runner
@original_executable Application.compile_env(:pinchflat, :yt_dlp_executable) @original_executable Application.compile_env(:pinchflat, :yt_dlp_executable)
@@ -65,6 +67,41 @@ defmodule Pinchflat.YtDlp.CommandRunnerTest do
end end
end end
describe "run/4 when testing cookie options" do
setup do
base_dir = Application.get_env(:pinchflat, :extras_directory)
cookie_file = Path.join(base_dir, "cookies.txt")
{:ok, cookie_file: cookie_file}
end
test "includes cookie options when cookies.txt exists", %{cookie_file: cookie_file} do
FilesystemHelpers.write_p!(cookie_file, "cookie data")
assert {:ok, output} = Runner.run(@media_url, [], "")
assert String.contains?(output, "--cookies #{cookie_file}")
end
test "doesn't include cookie options when cookies.txt blank", %{cookie_file: cookie_file} do
FilesystemHelpers.write_p!(cookie_file, " \n \n ")
assert {:ok, output} = Runner.run(@media_url, [], "")
refute String.contains?(output, "--cookies")
refute String.contains?(output, cookie_file)
end
test "doesn't include cookie options when cookies.txt doesn't exist", %{cookie_file: cookie_file} do
File.rm(cookie_file)
assert {:ok, output} = Runner.run(@media_url, [], "")
refute String.contains?(output, "--cookies")
refute String.contains?(output, cookie_file)
end
end
defp wrap_executable(new_executable, fun) do defp wrap_executable(new_executable, fun) do
Application.put_env(:pinchflat, :yt_dlp_executable, new_executable) Application.put_env(:pinchflat, :yt_dlp_executable, new_executable)
fun.() fun.()
File diff suppressed because one or more lines are too long
+2 -2
View File
@@ -1513,7 +1513,7 @@
"url": "https://i.ytimg.com/vi_webp/ABC123/maxresdefault.webp", "url": "https://i.ytimg.com/vi_webp/ABC123/maxresdefault.webp",
"preference": 0, "preference": 0,
"id": "41", "id": "41",
"filepath": "/app/tmp/videos/ABC123/Pinchflat Example Video-ABC123.webp" "filepath": "/tmp/test/tmpfiles/Pinchflat Example Video-ABC123.webp"
} }
], ],
"thumbnail": "https://i.ytimg.com/vi/ABC123/maxresdefault.jpg", "thumbnail": "https://i.ytimg.com/vi/ABC123/maxresdefault.jpg",
@@ -9769,7 +9769,7 @@
"release_git_head": "5498729c59b03a9511c64552da3ba2f802166f8d", "release_git_head": "5498729c59b03a9511c64552da3ba2f802166f8d",
"repository": "yt-dlp/yt-dlp-nightly-builds" "repository": "yt-dlp/yt-dlp-nightly-builds"
}, },
"infojson_filename": "/app/tmp/videos/ABC123/Pinchflat Example Video-ABC123.info.json", "infojson_filename": "/tmp/test/tmpfiles/Pinchflat Example Video-ABC123.info.json",
"__infojson_filename": "/app/tmp/videos/ABC123/Pinchflat Example Video-ABC123.info.json", "__infojson_filename": "/app/tmp/videos/ABC123/Pinchflat Example Video-ABC123.info.json",
"__real_download": true, "__real_download": true,
"__files_to_merge": [ "__files_to_merge": [
Binary file not shown.

After

Width:  |  Height:  |  Size: 824 B

+31 -8
View File
@@ -52,14 +52,7 @@ defmodule Pinchflat.MediaFixtures do
"#{:rand.uniform(1_000_000)}_media.mkv" "#{:rand.uniform(1_000_000)}_media.mkv"
]) ])
fixture_media_filepath = fixture_media_filepath = media_filepath_fixture()
Path.join([
File.cwd!(),
"test",
"support",
"files",
"media.mkv"
])
:ok = File.mkdir_p(Path.dirname(stored_media_filepath)) :ok = File.mkdir_p(Path.dirname(stored_media_filepath))
:ok = File.cp(fixture_media_filepath, stored_media_filepath) :ok = File.cp(fixture_media_filepath, stored_media_filepath)
@@ -82,4 +75,34 @@ defmodule Pinchflat.MediaFixtures do
Phoenix.json_library().encode!(media_attributes) Phoenix.json_library().encode!(media_attributes)
end end
def media_filepath_fixture do
Path.join([
File.cwd!(),
"test",
"support",
"files",
"media.mkv"
])
end
def thumbnail_filepath_fixture do
Path.join([
File.cwd!(),
"test",
"support",
"files",
"thumbnail.jpg"
])
end
def infojson_filepath_fixture do
Path.join([
File.cwd!(),
"test",
"support",
"files",
"example.info.json"
])
end
end end
+2
View File
@@ -11,9 +11,11 @@ Faker.start()
ExUnit.after_suite(fn _ -> ExUnit.after_suite(fn _ ->
File.rm_rf!(Application.get_env(:pinchflat, :media_directory)) File.rm_rf!(Application.get_env(:pinchflat, :media_directory))
File.rm_rf!(Application.get_env(:pinchflat, :metadata_directory)) File.rm_rf!(Application.get_env(:pinchflat, :metadata_directory))
File.rm_rf!(Application.get_env(:pinchflat, :extras_directory))
File.rm_rf!(Application.get_env(:pinchflat, :tmpfile_directory)) File.rm_rf!(Application.get_env(:pinchflat, :tmpfile_directory))
File.mkdir_p!(Application.get_env(:pinchflat, :media_directory)) File.mkdir_p!(Application.get_env(:pinchflat, :media_directory))
File.mkdir_p!(Application.get_env(:pinchflat, :metadata_directory)) File.mkdir_p!(Application.get_env(:pinchflat, :metadata_directory))
File.mkdir_p!(Application.get_env(:pinchflat, :extras_directory))
File.mkdir_p!(Application.get_env(:pinchflat, :tmpfile_directory)) File.mkdir_p!(Application.get_env(:pinchflat, :tmpfile_directory))
end) end)