Bumped version

* Exposes port on built image

* Forced IPv4

* Added current version to sidebar

.github/pull_request_template.md

@@ -13,3 +13,5 @@ N/A
 ## Any other comments?
 
 N/A
+
+- [ ] I am the original author of this code and I am giving it freely to the community and Pinchflat project maintainers

.github/workflows/build_and_push_docker.yml

@@ -7,6 +7,10 @@ on:
         description: 'Docker Image Tag'
         required: true
         default: 'dev'
+      platforms:
+        description: 'Build Platforms'
+        required: true
+        default: 'linux/amd64,linux/arm64'
 
 jobs:
   docker:
@@ -24,9 +28,19 @@ jobs:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
 
+      - name: Login to GHCR
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
       - name: Build and push
         uses: docker/build-push-action@v5
         with:
+          platforms: ${{ github.event.inputs.platforms }}
           push: true
           file: ./selfhosted.Dockerfile
-          tags: 'keglin/pinchflat:${{ github.event.inputs.image_tag }}'
+          tags: |
+            keglin/pinchflat:${{ github.event.inputs.image_tag }}
+            ghcr.io/${{ github.repository_owner }}/pinchflat:${{ github.event.inputs.image_tag }}

.iex.exs

@@ -22,42 +22,4 @@ alias Pinchflat.Metadata.MetadataFileHelpers
 
 alias Pinchflat.SlowIndexing.FileFollowerServer
 
-defmodule IexHelpers do
+Pinchflat.Release.check_file_permissions()
-  def playlist_url do
-    "https://www.youtube.com/playlist?list=PLmqC3wPkeL8kSlTCcSMDD63gmSi7evcXS"
-  end
-
-  def channel_url do
-    "https://www.youtube.com/c/TheUselessTrials"
-  end
-
-  def video_url do
-    "https://www.youtube.com/watch?v=bR52O78ZIUw"
-  end
-
-  def last_media_item do
-    Repo.one(from m in MediaItem, limit: 1)
-  end
-
-  def details(type) do
-    source =
-      case type do
-        :playlist -> playlist_url()
-        :channel -> channel_url()
-      end
-
-    YtDlpCollection.get_source_details(source)
-  end
-
-  def ids(type) do
-    source =
-      case type do
-        :playlist -> playlist_url()
-        :channel -> channel_url()
-      end
-
-    YtDlpCollection.get_media_attributes_for_collection(source)
-  end
-end
-
-import IexHelpers

README.md

@@ -1,43 +1,144 @@
-# Pinchflat (Alpha)
+<p align="center">  
+  <img 
+    src="priv/static/images/originals/logo-white-wordmark-with-background.png" 
+    alt="Pinchflat Logo by @hernandito"
+    width="700" 
+  />
+</p>
 
-This is alpha software and anything can break at any time. I make not guarantees about the stability of this software, forward-compatibility of updates, or integrity (both related to and independent of Pinchflat). Essentially, use at your own risk and expect there will be rough edges.
+<p align="center">  
+  <sup>
+    <em>logo by <a href="https://github.com/hernandito" target="_blank">@hernandito</a></em>
+  </sup>
+</p>
 
-## EFF Donation Receipts
+# Your next YouTube media manager
 
-A portion of all donations to Pinchflat will be donated to the Electronic Frontier Foundation. [See here](https://github.com/kieraneglin/pinchflat/wiki/EFF-Donation-Receipts) for a list of donation receipts.
+## Table of contents:
 
-## What is Pinchflat?
+- [What it does](#what-it-does)
+- [Features](#features)
+- [Screenshots](#screenshots)
+- [Installation](#installation)
+  - [Unraid](#unraid)
+  - [Docker](#docker)
+- [Authentication](#authentication)
+- [Frequently asked questions](https://github.com/kieraneglin/pinchflat/wiki/Frequently-Asked-Questions)
+- [Documentation](https://github.com/kieraneglin/pinchflat/wiki)
+- [EFF donations](#eff-donations)
+- [Pre-release disclaimer](#pre-release-disclaimer)
+- [Development](#development)
 
-TODO: expand on this.
+## What it does
 
-Pinchflat is a lightweight self-contained app for downloading YouTube content. For now, it is not intended as a way to consume content, but instead as a way to download content to disk using specified rules and schedules.
+Pinchflat is a self-hosted app for downloading YouTube content built using [yt-dlp](https://github.com/yt-dlp/yt-dlp). It's designed to be lightweight, self-contained, and easy to use. You set up rules for how to download content from YouTube channels or playlists and it'll do the rest, checking periodically for new content. It's perfect for people who want to download content for use in with a media center app (Plex, Jellyfin, Kodi) or for those who want to archive media!
 
-I have plans for more to come, but for now this is the focus. Think of Pinchflat as nothing more than an automated way to get content from YouTube to your disk.
+It's _not_ great for downloading one-off videos - it's built to download large amounts of content and keep it up to date. It's also not meant for consuming content in-app - Pinchflat downloads content to disk where you can then watch it with a media center app or VLC.
+
+If it doesn't work for your use case, please make a feature request! You can also check out these great alternatives: [Tube Archivist](https://github.com/tubearchivist/tubearchivist), [ytdl-sub](https://github.com/jmbannon/ytdl-sub), and [TubeSync](https://github.com/meeb/tubesync)
+
+## Features
+
+- Self-contained - just one Docker container with no external dependencies
+- Powerful naming system so content is stored where and how you want it
+- Easy-to-use web interface with presets to get you started right away
+- First-class support for media center apps like Plex, Jellyfin, and Kodi
+- Automatically downloads new content from channels and playlists
+  - Uses a novel approach to download new content more quickly than other apps
+- Supports downloading audio content
+- Custom rules for handling YouTube Shorts and livestreams
+- Advanced options like setting cutoff dates and filtering by title
+- Reliable hands-off operation
+- Can pass cookies to YouTube to download your private playlists ([docs](https://github.com/kieraneglin/pinchflat/wiki/YouTube-Cookies))
+
+## Screenshots
+
+<img src="priv/static/images/app-form-screenshot.png" alt="Pinchflat screenshot" width="700" />
+<img src="priv/static/images/app-screenshot.png" alt="Pinchflat screenshot" width="700" />
 
 ## Installation
 
-Pinchflat is designed to be self-hosted. I'm building it for my own needs which means it's designed to work well with Unraid, but it should work on any computer/server that can run Docker images.
+### Unraid
 
-I'll update with Unraid instructions once I get something in the Community Apps store. Until then, here's how you build it with Docker:
+Simply search for Pinchflat in the Community Apps store!
 
-```bash
+### Portainer
-docker build . --file selfhosted.Dockerfile -t pinchflat:dev
 
-docker run \
+Docker Compose file:
-  -p 8945:8945 \
+
-  -v /Users/work/Desktop/test_volumes/config:/config \
+```yaml
-  -v /Users/work/Desktop/test_volumes/downloads:/downloads \
+version: '3'
-  pinchflat:dev
+services:
+  pinchflat:
+    image: keglin/pinchflat:latest
+    ports:
+      - '8945:8945'
+    volumes:
+      - /host/path/to/config:/config
+      - /host/path/to/downloads:/downloads
 ```
 
-## Authentication
+### Docker
 
-Currently HTTP basic auth is optionally supported. To use it, set the `BASIC_AUTH_USERNAME` and `BASIC_AUTH_PASSWORD` environment variables when starting the container. If you don't set both of these, no authentication will be required.
+1. Create two directories on your host machine: one for storing config and one for storing downloaded media. Make sure they're both writable by the user running the Docker container.
+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`
+3. Run the container:
+
+```bash
+# Be sure to replace /host/path/to/config and /host/path/to/downloads below with
+# the paths to the directories you created in step 1
+docker run \
+  -p 8945:8945 \
+  -v /host/path/to/config:/config \
+  -v /host/path/to/downloads:/downloads \
+  ghcr.io/kieraneglin/pinchflat:latest
+```
+
+### IMPORTANT: File permissions
+
+You _must_ ensure the host directories you've mounted are writable by the user running the Docker container. If you get a permission error follow the steps it suggests. See [#106](https://github.com/kieraneglin/pinchflat/issues/106) for more.
+
+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.
+
+## 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.
+
+## EFF donations
+
+A portion of all donations to Pinchflat will be donated to the [Electronic Frontier Foundation](https://www.eff.org/). The EFF defends your online liberties and [backed](https://github.com/github/dmca/blob/9a85e0f021f7967af80e186b890776a50443f06c/2020/11/2020-11-16-RIAA-reversal-effletter.pdf) `youtube-dl` when Google took them down. [See here](https://github.com/kieraneglin/pinchflat/wiki/EFF-Donation-Receipts) for a list of donation receipts.
+
+## Pre-release disclaimer
+
+This is pre-release software and anything can break at any time. I make not guarantees about the stability of this software, forward-compatibility of updates, or integrity (both related to and independent of Pinchflat). Essentially, use at your own risk and expect there will be rough edges for now.
+
+## Development
+
+Pinchflat is written in Elixir - a functional programming language that runs on the Erlang VM. It uses the Phoenix web framework and SQLite for the database. The frontend is mostly normal server-rendered HTML with a little Alpine.js as-needed.
+
+Elixir is a personal favourite of mine and is ideal for building fault-tolerant systems. It's also a joy to work with and has a great community. If you're interested in contributing, I'd be happy to help you get started with Elixir - just open an issue with some questions and we can chat!
+
+### Local setup
+
+- `docker compose build --no-cache`
+- `docker compose up -d && docker attach pinchflat-phx-1`
+- After a few minutes the app should be accessible at `localhost:4008`
+  - Please let me know if you run into any hiccups here - I haven't had to bootstrap the app from scratch in a long time and I might have forgotten something
+- Media downloads and config will be stored in the `tmp` directory. Not the OS's `/tmp` directory, but the one in the root of the project
+
+### Running tests and linting
+
+- Open a shell with `docker compose exec phx bash`
+- Run `mix test` to run the tests
+- Run `mix check` to do a full testing, linting, and static analysis pass
+
+### Top tips
+
+- Look for any module that ends in `*_worker.ex` - these are where the interesting stuff happens and you can trace back from there to see how the app works. `lib/pinchflat/slow_indexing/media_collection_indexing_worker.ex` is a good place to start
 
 ## License
 
 See `LICENSE` file
-
-```
-
-```

config/config.exs

@@ -16,6 +16,7 @@ config :pinchflat,
   media_directory: "/downloads",
   # The user may or may not store metadata for their needs, but the app will always store its copy
   metadata_directory: "/config/metadata",
+  extras_directory: "/config/extras",
   tmpfile_directory: Path.join([System.tmp_dir!(), "pinchflat", "data"]),
   # 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.

config/dev.exs

@@ -3,6 +3,7 @@ import Config
 config :pinchflat,
   media_directory: Path.join([File.cwd!(), "tmp", "media"]),
   metadata_directory: Path.join([File.cwd!(), "tmp", "metadata"]),
+  extras_directory: Path.join([File.cwd!(), "tmp", "extras"]),
   tmpfile_directory: Path.join([File.cwd!(), "tmp", "tmpfiles"])
 
 # Configure your database

config/runtime.exs

@@ -25,17 +25,27 @@ config :pinchflat,
   basic_auth_username: System.get_env("BASIC_AUTH_USERNAME"),
   basic_auth_password: System.get_env("BASIC_AUTH_PASSWORD")
 
-if config_env() == :prod do
+arch_string = to_string(:erlang.system_info(:system_architecture))
-  config_path =
-    System.get_env("CONFIG_PATH") ||
-      raise """
-      environment variable CONFIG_PATH is missing.
-      For example: /etc/pinchflat/config
-      """
 
+system_arch =
+  cond do
+    String.contains?(arch_string, "arm") -> "arm"
+    String.contains?(arch_string, "aarch") -> "arm"
+    String.contains?(arch_string, "x86") -> "x86"
+    true -> "unknown"
+  end
+
+config :pinchflat, Pinchflat.Repo,
+  load_extensions: [
+    Path.join([:code.priv_dir(:pinchflat), "repo", "extensions", "sqlean-linux-#{system_arch}", "sqlean"])
+  ]
+
+if config_env() == :prod do
+  config_path = "/config"
   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"]))
   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
   acceptable_log_levels = ~w(debug info)a
@@ -50,7 +60,10 @@ if config_env() == :prod do
 
   config :pinchflat,
     yt_dlp_executable: System.find_executable("yt-dlp"),
+    media_directory: "/downloads",
     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")
 
   config :pinchflat, Pinchflat.Repo,
@@ -89,7 +102,7 @@ if config_env() == :prod do
       # 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
       # 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")
     ],
     secret_key_base: secret_key_base

lib/pinchflat/boot/data_backfill_worker.ex

@@ -18,7 +18,6 @@ defmodule Pinchflat.Boot.DataBackfillWorker do
 
   alias __MODULE__
   alias Pinchflat.Repo
-  alias Pinchflat.Media.MediaItem
 
   @doc """
   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
     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()
 
     :ok
   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
     # Run hourly
     next_run_in = 60 * 60

lib/pinchflat/boot/pre_job_startup_tasks.ex

@@ -31,59 +31,38 @@ defmodule Pinchflat.Boot.PreJobStartupTasks do
   """
   @impl true
   def init(state) do
+    reset_executing_jobs()
+    create_blank_cookie_file()
     apply_default_settings()
-    ensure_directories_are_writeable()
-    rename_old_job_workers()
 
     {:ok, state}
   end
 
+  # If a node cannot gracefully shut down, the currently executing jobs get stuck
+  # in the "executing" state. This is a problem because the job runner will not
+  # pick them up again
+  defp reset_executing_jobs do
+    {count, _} =
+      Oban.Job
+      |> where(state: "executing")
+      |> Repo.update_all(set: [state: "retryable"])
+
+    Logger.info("Reset #{count} executing jobs")
+  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
     Settings.fetch!(:onboarding, true)
     Settings.fetch!(:pro_enabled, false)
   end
-
-  defp ensure_directories_are_writeable do
-    directories = [
-      Application.get_env(:pinchflat, :media_directory),
-      Application.get_env(:pinchflat, :tmpfile_directory),
-      Application.get_env(:pinchflat, :metadata_directory)
-    ]
-
-    Enum.each(directories, fn dir ->
-      file = Path.join([dir, ".keep"])
-
-      # This will fail if the directory is not writeable, stopping boot
-      FilesystemHelpers.write_p!(file, "")
-    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

lib/pinchflat/downloading/output_path_builder.ex

@@ -42,7 +42,8 @@ defmodule Pinchflat.Downloading.OutputPathBuilder do
       "upload_day" => "%(upload_date>%d)S",
       "upload_yyyy_mm_dd" => "%(upload_date>%Y-%m-%d)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

lib/pinchflat/filesystem/filesystem_helpers.ex

@@ -20,6 +20,21 @@ defmodule Pinchflat.Filesystem.FilesystemHelpers do
     filepath
   end
 
+  @doc """
+  Writes content to a file, creating directories as needed.
+  Takes the same args as File.write/3.
+
+  Returns :ok | {:error, any()}
+  """
+  def write_p(file, content, modes \\ []) do
+    dirname = Path.dirname(file)
+
+    case File.mkdir_p(dirname) do
+      :ok -> File.write(file, content, modes)
+      err -> err
+    end
+  end
+
   @doc """
   Writes content to a file, creating directories as needed.
   Takes the same args as File.write!/3.
@@ -27,11 +42,7 @@ defmodule Pinchflat.Filesystem.FilesystemHelpers do
   Returns :ok | raises on error
   """
   def write_p!(filepath, content, modes \\ []) do
-    filepath
+    :ok = write_p(filepath, content, modes)
-    |> Path.dirname()
-    |> File.mkdir_p!()
-
-    File.write!(filepath, content, modes)
   end
 
   @doc """

lib/pinchflat/media/media.ex

@@ -66,6 +66,7 @@ defmodule Pinchflat.Media do
     |> where([mi], mi.source_id == ^source.id and is_nil(mi.media_filepath))
     |> where(^build_format_clauses(media_profile))
     |> where(^maybe_apply_cutoff_date(source))
+    |> where(^maybe_apply_title_regex(source))
     |> Repo.maybe_limit(limit)
     |> Repo.all()
   end
@@ -247,6 +248,14 @@ defmodule Pinchflat.Media do
     end
   end
 
+  defp maybe_apply_title_regex(source) do
+    if source.title_filter_regex do
+      dynamic([mi], fragment("regexp_like(?, ?)", mi.title, ^source.title_filter_regex))
+    else
+      dynamic(true)
+    end
+  end
+
   defp build_format_clauses(media_profile) do
     mapped_struct = Map.from_struct(media_profile)
 

lib/pinchflat/metadata/metadata_file_helpers.ex

@@ -11,6 +11,22 @@ defmodule Pinchflat.Metadata.MetadataFileHelpers do
 
   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 """
   Compresses and stores metadata for a media item, returning the filepath.
 
@@ -108,13 +124,8 @@ defmodule Pinchflat.Metadata.MetadataFileHelpers do
   end
 
   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([
-      metadata_directory,
+      metadata_directory_for(database_record),
-      record_table_name,
-      to_string(database_record.id),
       filename
     ])
   end

lib/pinchflat/metadata/metadata_parser.ex

@@ -58,23 +58,38 @@ defmodule Pinchflat.Metadata.MetadataParser do
       # NOTE: whole ordeal needed due to a bug I found in yt-dlp
       # https://github.com/yt-dlp/yt-dlp/issues/9445
       # Can be reverted to remove this entire conditional once fixed
+      filepath =
+        thumbnail_filepath
+        |> String.split(~r{\.}, include_captures: true)
+        |> List.insert_at(-3, "-thumb")
+        |> Enum.join()
+
       %{
-        thumbnail_filepath:
+        thumbnail_filepath: filepath_if_exists(filepath)
-          thumbnail_filepath
-          |> String.split(~r{\.}, include_captures: true)
-          |> List.insert_at(-3, "-thumb")
-          |> Enum.join()
       }
     else
       %{
-        thumbnail_filepath: thumbnail_filepath
+        thumbnail_filepath: nil
       }
     end
   end
 
   defp parse_infojson_metadata(metadata) do
     %{
-      metadata_filepath: metadata["infojson_filename"]
+      metadata_filepath: filepath_if_exists(metadata["infojson_filename"])
     }
   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

lib/pinchflat/metadata/source_metadata.ex

@@ -10,11 +10,20 @@ defmodule Pinchflat.Metadata.SourceMetadata do
 
   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
 
   schema "source_metadata" do
     field :metadata_filepath, :string
+    field :fanart_filepath, :string
+    field :poster_filepath, :string
+    field :banner_filepath, :string
 
     belongs_to :source, Source
 
@@ -31,6 +40,11 @@ defmodule Pinchflat.Metadata.SourceMetadata do
 
   @doc false
   def filepath_attributes do
-    ~w(metadata_filepath)a
+    ~w(
+      metadata_filepath
+      fanart_filepath
+      poster_filepath
+      banner_filepath
+    )a
   end
 end

lib/pinchflat/metadata/source_metadata_storage_worker.ex

@@ -32,6 +32,7 @@ defmodule Pinchflat.Metadata.SourceMetadataStorageWorker do
 
   @doc """
   Fetches and stores various forms of metadata for a source:
+    - Attributes like `description`
     - JSON metadata for internal use
     - The series directory for the source
     - 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
     source = Repo.preload(Sources.get_source!(source_id), [:metadata, :media_profile])
     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(
       source,
       Map.merge(
         %{
           series_directory: series_directory,
           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
     )
 
@@ -72,18 +76,19 @@ defmodule Pinchflat.Metadata.SourceMetadataStorageWorker do
   end
 
   defp fetch_source_metadata_and_images(series_directory, source) do
+    metadata_directory = MetadataFileHelpers.metadata_directory_for(source)
+    tmp_output_path = "#{tmp_directory()}/#{StringUtils.random_string(16)}/source_image.%(ext)S"
+    opts = [:write_all_thumbnails, convert_thumbnails: "jpg", output: tmp_output_path]
+
+    {:ok, metadata} = MediaCollection.get_source_metadata(source.original_url, opts)
+    metadata_image_attrs = SourceImageParser.store_source_images(metadata_directory, metadata)
+
     if source.media_profile.download_source_images && series_directory do
-      output_path = "#{tmp_directory()}/#{StringUtils.random_string(16)}/source_image.%(ext)S"
+      source_image_attrs = SourceImageParser.store_source_images(series_directory, metadata)
-      opts = [:write_all_thumbnails, convert_thumbnails: "jpg", output: output_path]
 
-      {:ok, metadata} = MediaCollection.get_source_metadata(source.original_url, opts)
+      {metadata, source_image_attrs, metadata_image_attrs}
-      image_attrs = SourceImageParser.store_source_images(series_directory, metadata)
-
-      {metadata, image_attrs}
     else
-      {:ok, metadata} = MediaCollection.get_source_metadata(source.original_url, [])
+      {metadata, %{}, metadata_image_attrs}
-
-      {metadata, %{}}
     end
   end
 

lib/pinchflat/release.ex

@@ -5,6 +5,10 @@ defmodule Pinchflat.Release do
   """
   @app :pinchflat
 
+  require Logger
+
+  alias Pinchflat.Filesystem.FilesystemHelpers
+
   def migrate do
     load_app()
 
@@ -18,6 +22,37 @@ defmodule Pinchflat.Release do
     {:ok, _, _} = Ecto.Migrator.with_repo(repo, &Ecto.Migrator.run(&1, :down, to: version))
   end
 
+  def check_file_permissions do
+    load_app()
+
+    directories = [
+      "/config",
+      "/downloads",
+      Application.get_env(:pinchflat, :media_directory),
+      Application.get_env(:pinchflat, :tmpfile_directory),
+      Application.get_env(:pinchflat, :extras_directory),
+      Application.get_env(:pinchflat, :metadata_directory)
+    ]
+
+    Enum.each(directories, fn dir ->
+      Logger.info("Checking permissions for #{dir}")
+      filepath = Path.join([dir, ".keep"])
+
+      case FilesystemHelpers.write_p(filepath, "") do
+        :ok ->
+          Logger.info("Permissions OK")
+
+        {:error, :eacces} ->
+          Logger.error(permission_denied_screed(dir))
+          raise "Permission denied"
+
+        err ->
+          Logger.error("Permissions check failed: #{inspect(err)}")
+          raise "Unknown error"
+      end
+    end)
+  end
+
   defp repos do
     Application.fetch_env!(@app, :ecto_repos)
   end
@@ -25,4 +60,31 @@ defmodule Pinchflat.Release do
   defp load_app do
     Application.load(@app)
   end
+
+  defp permission_denied_screed(dir) do
+    """
+    The directory "#{dir}" is not writeable by the Docker container.
+
+    Please ensure that the directory exists and is writeable by the Docker
+    container. All setups are different, but you may be able to run something
+    like this on the *host*:
+
+      chown nobody -R <host path that maps to #{dir}>
+      chmod 755 -R <host path that maps to #{dir}>
+
+    Swapping in your real host path. Then, you should set the user running
+    this container by editing your `docker run` command like so:
+
+        docker run --user 99:100 <rest of the command>
+
+    Or adding `user: '99:100'` to the Pinchflat service of your Docker Compose
+    file. Again, there are many ways to do this depending on your setup and
+    this is just one example. See issue #106 in the Pinchflat Github for more.
+
+    No matter the case, this _is_ a permissions error and allowing the container
+    to write to the directory is the only way to fix it. It is not recommended
+    to run the container as `root` because files created by Pinchflat may not
+    be accessible to other apps that want to modify them.
+    """
+  end
 end

lib/pinchflat/slow_indexing/file_follower_server.ex

@@ -9,7 +9,7 @@ defmodule Pinchflat.SlowIndexing.FileFollowerServer do
   require Logger
 
   @poll_interval_ms Application.compile_env(:pinchflat, :file_watcher_poll_interval)
-  @activity_timeout_ms 60_000
+  @activity_timeout_ms 600_000
 
   # Client API
   @doc """

lib/pinchflat/slow_indexing/slow_indexing_helpers.ex

@@ -7,6 +7,7 @@ defmodule Pinchflat.SlowIndexing.SlowIndexingHelpers do
 
   require Logger
 
+  alias Pinchflat.Repo
   alias Pinchflat.Media
   alias Pinchflat.Tasks
   alias Pinchflat.Sources
@@ -60,6 +61,9 @@ defmodule Pinchflat.SlowIndexing.SlowIndexingHelpers do
     # See the method definition below for more info on how file watchers work
     # (important reading if you're not familiar with it)
     {:ok, media_attributes} = get_media_attributes_for_collection_and_setup_file_watcher(source)
+    # Reload because the source may have been updated during the (long-running) indexing process
+    # and important settings like `download_media` may have changed.
+    source = Repo.reload!(source)
 
     result =
       Enum.map(media_attributes, fn media_attrs ->
@@ -117,6 +121,10 @@ defmodule Pinchflat.SlowIndexing.SlowIndexingHelpers do
   end
 
   defp create_media_item_and_enqueue_download(source, media_attrs) do
+    # Reload because the source may have been updated during the (long-running) indexing process
+    # and important settings like `download_media` may have changed.
+    source = Repo.reload!(source)
+
     case Media.create_media_item_from_backend_attrs(source, media_attrs) do
       {:ok, %MediaItem{} = media_item} ->
         if source.download_media && Media.pending_download?(media_item) do

lib/pinchflat/sources/source.ex

@@ -17,6 +17,7 @@ defmodule Pinchflat.Sources.Source do
     collection_id
     collection_type
     custom_name
+    description
     nfo_filepath
     poster_filepath
     fanart_filepath
@@ -28,6 +29,7 @@ defmodule Pinchflat.Sources.Source do
     last_indexed_at
     original_url
     download_cutoff_date
+    title_filter_regex
     media_profile_id
   )a
 
@@ -54,14 +56,10 @@ defmodule Pinchflat.Sources.Source do
 
   schema "sources" do
     field :custom_name, :string
+    field :description, :string
     field :collection_name, :string
     field :collection_id, :string
     field :collection_type, Ecto.Enum, values: [:channel, :playlist]
-    field :nfo_filepath, :string
-    field :poster_filepath, :string
-    field :fanart_filepath, :string
-    field :banner_filepath, :string
-    field :series_directory, :string
     field :index_frequency_minutes, :integer, default: 60 * 24
     field :fast_index, :boolean, default: false
     field :download_media, :boolean, default: true
@@ -69,6 +67,13 @@ defmodule Pinchflat.Sources.Source do
     # Only download media items that were published after this date
     field :download_cutoff_date, :date
     field :original_url, :string
+    field :title_filter_regex, :string
+
+    field :series_directory, :string
+    field :nfo_filepath, :string
+    field :poster_filepath, :string
+    field :fanart_filepath, :string
+    field :banner_filepath, :string
 
     belongs_to :media_profile, MediaProfile
 
@@ -95,7 +100,6 @@ defmodule Pinchflat.Sources.Source do
     |> dynamic_default(:custom_name, fn cs -> get_field(cs, :collection_name) end)
     |> validate_required(required_fields)
     |> cast_assoc(:metadata, with: &SourceMetadata.changeset/2, required: false)
-    |> unique_constraint([:collection_id, :media_profile_id])
   end
 
   @doc false

lib/pinchflat/yt_dlp/command_runner.ex

@@ -31,7 +31,8 @@ defmodule Pinchflat.YtDlp.CommandRunner do
     # 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))
     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, " ")}")
 
@@ -47,6 +48,19 @@ defmodule Pinchflat.YtDlp.CommandRunner do
     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:
   #
   # 1. If the key is an atom, convert it to a string and convert it to kebab case (for convenience)

lib/pinchflat_web/components/layouts/onboarding.html.heex

@@ -1,10 +1,9 @@
 <div class="flex h-screen overflow-hidden">
   <div class="relative flex flex-1 flex-col overflow-y-auto overflow-x-hidden">
     <header class="sticky top-0 z-999 flex w-full bg-white drop-shadow-1 dark:bg-boxdark dark:drop-shadow-none">
-      <div class="flex flex-grow items-center px-4 py-4 shadow-2 md:px-6 2xl:px-11">
+      <div class="w-65 px-4 py-2 shadow-2 md:px-6">
-        <div class="flex items-center">
+        <div class="flex items-center gap-2 py-2">
-          <img src={~p"/images/logo.png?cachebust=2024-02-29"} alt="Pinchflat" class="w-9 h-9" />
+          <img src={~p"/images/logo.png?cachebust=2024-03-20"} alt="Pinchflat" class="w-auto" />
-          <h2 class="text-xl font-bold text-white pl-2">Pinchflat</h2>
         </div>
       </div>
     </header>

lib/pinchflat_web/components/layouts/partials/header.html.heex

@@ -1,18 +1,18 @@
-<header class="sticky top-0 z-999 flex w-full bg-white drop-shadow-1 dark:bg-boxdark dark:drop-shadow-none">
+<header class="sticky top-0 z-999 flex h-20 w-full bg-white drop-shadow-1 dark:bg-boxdark dark:drop-shadow-none">
   <div class="flex flex-grow items-center justify-between lg:justify-end px-4 py-4 shadow-2 md:px-6 2xl:px-11">
-    <div class="flex items-center gap-2 sm:gap-4 lg:hidden">
+    <div class="flex items-center gap-2 sm:gap-4 lg:hidden w-2/6">
+      <section class="pr-1">
+        <img src={~p"/images/icon.png?cachebust=2024-03-20"} alt="Pinchflat" class="w-10" />
+      </section>
+
       <button
-        class="z-99999 block rounded-sm border border-stroke bg-white p-1.5 shadow-sm dark:border-strokedark dark:bg-boxdark lg:hidden"
+        class="z-99999 block mx-2 rounded-sm border border-stroke bg-white p-1.5 shadow-sm dark:border-strokedark dark:bg-boxdark lg:hidden"
         @click.stop="sidebarVisible = !sidebarVisible"
       >
         <.icon name="hero-bars-3" />
       </button>
-      <a class="hidden sm:flex items-center lg:hidden" href="/">
-        <img src={~p"/images/logo.png?cachebust=2024-02-29"} alt="Pinchflat" class="w-9 h-9" />
-        <h2 class="text-xl font-bold text-white pl-2">Pinchflat</h2>
-      </a>
     </div>
-    <div class="bg-meta-4 rounded-md">
+    <div class="bg-meta-4 rounded-md w-4/6 lg:w-3/6 xl:w-2/6">
       <div class="relative">
         <span class="absolute left-2 top-1/2 -translate-y-1/2 flex">
           <.icon name="hero-magnifying-glass" />
@@ -23,7 +23,7 @@
             name="q"
             value={@params["q"]}
             placeholder="Type to search..."
-            class="w-full bg-transparent pl-9 pr-4 border-0 focus:ring-0 focus:outline-none lg:w-125"
+            class="w-full bg-transparent pl-9 pr-4 border-0 focus:ring-0 focus:outline-none"
           />
         </form>
       </div>

lib/pinchflat_web/components/layouts/partials/sidebar.html.heex

@@ -1,24 +1,23 @@
 <aside
   x-bind:class="sidebarVisible ? 'translate-x-0' : '-translate-x-full'"
   class={[
-    "-translate-x-full absolute left-0 top-0 z-9999 flex h-screen w-60 flex-col overflow-y-hidden justify-between",
+    "-translate-x-full absolute left-0 top-0 z-9999 flex h-screen w-65 flex-col overflow-y-hidden justify-between",
     "bg-black duration-300 ease-linear shadow-lg sm:shadow-none dark:bg-boxdark lg:static lg:translate-x-0"
   ]}
   @click.outside="sidebarVisible = false"
 >
   <section>
-    <div class="flex items-center justify-between gap-2 px-6 py-5.5 lg:py-6.5">
+    <div class="flex items-center justify-between gap-2 px-6 py-4">
       <a href="/" class="flex items-center">
-        <img src={~p"/images/logo.png?cachebust=2024-02-29"} alt="Pinchflat" class="w-9 h-9" />
+        <img src={~p"/images/logo.png?cachebust=2024-03-20"} alt="Pinchflat" class="w-auto" />
-        <h2 class="text-xl font-bold text-white pl-2">Pinchflat</h2>
       </a>
 
-      <button class="block lg:hidden" @click.stop="sidebarVisible = !sidebarVisible">
+      <button class="block mt-3 lg:hidden" @click.stop="sidebarVisible = !sidebarVisible">
         <.icon name="hero-arrow-left" class="fill-current" />
       </button>
     </div>
     <div class="no-scrollbar flex flex-col overflow-y-auto duration-300 ease-linear">
-      <nav class="mt-5 px-4 py-4 lg:mt-9 lg:px-6">
+      <nav class="mt-3 px-4 py-4 lg:px-6">
         <h3 class="mb-4 ml-4 text-sm font-medium text-bodydark2">MENU</h3>
         <div class="flex flex-col justify-between">
           <ul class="mb-6 flex flex-col gap-1.5">
@@ -31,8 +30,14 @@
     </div>
   </section>
   <section>
-    <nav class="mt-5 px-4 py-4 lg:mt-9 lg:px-6">
+    <nav class="px-4 py-4 lg:px-6">
       <ul class="mb-6 flex flex-col gap-1.5">
+        <.sidebar_item
+          icon="hero-book-open"
+          text="Docs"
+          target="_blank"
+          href="https://github.com/kieraneglin/pinchflat/wiki"
+        />
         <.sidebar_item
           icon="hero-code-bracket"
           text="Github"
@@ -52,6 +57,11 @@
             <.icon name="hero-currency-dollar" /> Donate
           </span>
         </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>
     </nav>
   </section>

lib/pinchflat_web/components/layouts/root.html.heex

@@ -8,7 +8,7 @@
       <%= assigns[:page_title] || "Pinchflat" %>
     </.live_title>
     <link phx-track-static rel="stylesheet" href={~p"/assets/app.css"} />
-    <link rel="icon" type="image/x-icon" href={~p"/favicon.ico?cachebust=2024-02-29"} />
+    <link rel="icon" type="image/x-icon" href={~p"/favicon.ico?cachebust=2024-03-20"} />
     <script defer phx-track-static type="text/javascript" src={~p"/assets/app.js"}>
     </script>
   </head>

lib/pinchflat_web/controllers/media_profiles/media_profile_html.ex

@@ -39,7 +39,8 @@ defmodule PinchflatWeb.MediaProfiles.MediaProfileHTML do
       upload_year: nil,
       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_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
 
@@ -74,6 +75,6 @@ defmodule PinchflatWeb.MediaProfiles.MediaProfileHTML do
   end
 
   defp audio_output_template do
-    "/music/{{ source_custom_name }}/{{ title }}.{{ ext }}"
+    "/music/{{ artist_name }}/{{ title }}.{{ ext }}"
   end
 end

lib/pinchflat_web/controllers/media_profiles/media_profile_html/media_profile_form.html.heex

@@ -233,12 +233,12 @@
         field={f[:download_source_images]}
         type="toggle"
         label="Download Series Images"
-        help="Downloads poster and banner images for use with Jellyfin, Kodi, etc. Only works for full channels (not playlists)"
+        help="Downloads poster and banner images for use with Plex, Jellyfin, Kodi, etc. Only works for full channels (not playlists)"
         x-init="$watch('selectedPreset', p => p && (enabled = presets[p]))"
       />
     </section>
 
-    <.button class="my-10 sm:mb-7.5 w-full sm:w-auto">Save Media profile</.button>
+    <.button class="my-10 sm:mb-7.5 w-full sm:w-auto" rounding="rounded-lg">Save Media profile</.button>
   </section>
 
   <div class="rounded-sm dark:bg-meta-4 p-4 md:p-6 mb-5">

lib/pinchflat_web/controllers/sources/source_html/source_form.html.heex

@@ -1,11 +1,22 @@
-<.simple_form :let={f} for={@changeset} action={@action}>
+<.simple_form
+  :let={f}
+  for={@changeset}
+  action={@action}
+  x-data="{ advancedMode: !!JSON.parse(localStorage.getItem('advancedMode')) }"
+  x-init="$watch('advancedMode', value => localStorage.setItem('advancedMode', JSON.stringify(value)))"
+>
   <.error :if={@changeset.action}>
     Oops, something went wrong! Please check the errors below.
   </.error>
 
-  <h3 class="mt-8 text-2xl text-black dark:text-white">
+  <section class="flex justify-between items-center mt-8">
-    General Options
+    <h3 class=" text-2xl text-black dark:text-white">
-  </h3>
+      General Options
+    </h3>
+    <span class="cursor-pointer hover:underline" x-on:click="advancedMode = !advancedMode">
+      Editing Mode: <span x-text="advancedMode ? 'Advanced' : 'Basic'"></span>
+    </span>
+  </section>
 
   <.input
     field={f[:custom_name]}
@@ -69,7 +80,24 @@
     help="Only download media uploaded after this date. Leave blank to download all media. Must be in YYYY-MM-DD format"
   />
 
-  <.button class="my-10 sm:mb-7.5 w-full sm:w-auto">Save Source</.button>
+  <section x-show="advancedMode">
+    <h3 class="mt-8 text-2xl text-black dark:text-white">
+      Advanced Options
+    </h3>
+    <p class="text-sm mt-2">
+      Tread carefully
+    </p>
+
+    <.input
+      field={f[:title_filter_regex]}
+      type="text"
+      label="Title Filter Regex"
+      placeholder="(?i)^How to Bike$"
+      help="A PCRE-compatible regex. Only media with titles that match this regex will be downloaded. Look up 'SQLean Regex docs' for more"
+    />
+  </section>
+
+  <.button class="my-10 sm:mb-7.5 w-full sm:w-auto" rounding="rounded-lg">Save Source</.button>
 
   <div class="rounded-sm dark:bg-meta-4 p-4 md:p-6 mb-5">
     <.fast_indexing_help />

mix.exs

@@ -4,7 +4,7 @@ defmodule Pinchflat.MixProject do
   def project do
     [
       app: :pinchflat,
-      version: "0.1.0-alpha.6",
+      version: "0.1.3",
       elixir: "~> 1.16",
       elixirc_paths: elixirc_paths(Mix.env()),
       start_permanent: Mix.env() == :prod,

priv/repo/migrations/20240320153902_add_title_regex_to_source.exs

@@ -0,0 +1,9 @@
+defmodule Pinchflat.Repo.Migrations.AddTitleRegexToSource do
+  use Ecto.Migration
+
+  def change do
+    alter table(:sources) do
+      add :title_filter_regex, :string
+    end
+  end
+end

priv/repo/migrations/20240320181210_remove_unique_index_from_sources.exs

@@ -0,0 +1,7 @@
+defmodule Pinchflat.Repo.Migrations.RemoveUniqueIndexFromSources do
+  use Ecto.Migration
+
+  def change do
+    drop unique_index(:sources, [:collection_id, :media_profile_id])
+  end
+end

priv/repo/migrations/20240325174728_add_image_attrs_to_source_metadata.exs

@@ -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

priv/repo/migrations/20240325222846_add_description_to_source.exs

@@ -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

rel/overlays/bin/check_file_permissions

@@ -0,0 +1,3 @@
+#!/bin/sh
+cd -P -- "$(dirname -- "$0")"
+exec ./pinchflat eval Pinchflat.Release.check_file_permissions

rel/overlays/bin/docker_start

@@ -1,4 +1,11 @@
 #!/bin/sh
+/app/bin/check_file_permissions
+
+if [ $? -ne 0 ]; then
+  echo "Filesystem error. Exiting."
+  exit 1
+fi
+
 /app/bin/migrate
 
 cd -P -- "$(dirname -- "$0")"

selfhosted.Dockerfile

@@ -39,6 +39,7 @@ RUN mix local.hex --force && \
 
 # set build ENV
 ENV MIX_ENV="prod"
+ENV ERL_FLAGS="+JPperf true"
 
 # install mix dependencies
 COPY mix.exs mix.lock ./
@@ -74,9 +75,11 @@ RUN mix release
 # the compiled release and other runtime necessities
 FROM ${RUNNER_IMAGE}
 
+ARG PORT=8945
+
 RUN apt-get update -y
 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/*_*
 
 # Download and update YT-DLP
@@ -100,9 +103,9 @@ RUN chown nobody /config /downloads
 
 # set runner ENV
 ENV MIX_ENV="prod"
-ENV CONFIG_PATH="/config"
+ENV PORT=${PORT}
-ENV PORT=8945
 ENV RUN_CONTEXT="selfhosted"
+EXPOSE ${PORT}
 
 # Only copy the final release from the build stage
 COPY --from=builder --chown=nobody:root /app/_build/${MIX_ENV}/rel/pinchflat ./

test/pinchflat/boot/data_backfill_worker_test.exs

@@ -1,8 +1,6 @@
 defmodule Pinchflat.Boot.DataBackfillWorkerTest do
   use Pinchflat.DataCase
 
-  import Pinchflat.MediaFixtures
-
   alias Pinchflat.Boot.DataBackfillWorker
   alias Pinchflat.JobFixtures.TestJobWorker
 
@@ -45,26 +43,4 @@ defmodule Pinchflat.Boot.DataBackfillWorkerTest do
       assert_enqueued(worker: DataBackfillWorker, scheduled_at: now_plus(60, :minutes))
     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

test/pinchflat/downloading/download_option_builder_test.exs

@@ -1,8 +1,8 @@
 defmodule Pinchflat.Downloading.DownloadOptionBuilderTest do
   use Pinchflat.DataCase
   import Pinchflat.MediaFixtures
-  import Pinchflat.ProfilesFixtures
   import Pinchflat.SourcesFixtures
+  import Pinchflat.ProfilesFixtures
 
   alias Pinchflat.Profiles
   alias Pinchflat.Downloading.DownloadOptionBuilder

test/pinchflat/downloading/media_downloader_test.exs

@@ -58,7 +58,7 @@ defmodule Pinchflat.Downloading.MediaDownloaderTest do
 
   describe "download_for_media_item/3 when testing media_item attributes" do
     setup do
-      expect(YtDlpRunnerMock, :run, fn _url, _opts, _ot ->
+      stub(YtDlpRunnerMock, :run, fn _url, _opts, _ot ->
         {:ok, render_metadata(:media_metadata)}
       end)
 
@@ -73,7 +73,7 @@ defmodule Pinchflat.Downloading.MediaDownloaderTest do
 
     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 == "Trying to Wheelie Without the Rear Brake"
+      assert updated_media_item.title == "Pinchflat Example Video"
     end
 
     test "it extracts the description", %{media_item: media_item} do
@@ -94,15 +94,44 @@ defmodule Pinchflat.Downloading.MediaDownloaderTest do
     end
 
     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 {:ok, updated_media_item} = MediaDownloader.download_for_media_item(media_item)
       assert String.ends_with?(updated_media_item.thumbnail_filepath, ".webp")
+
+      File.rm(updated_media_item.thumbnail_filepath)
     end
 
     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 {:ok, updated_media_item} = MediaDownloader.download_for_media_item(media_item)
       assert String.ends_with?(updated_media_item.metadata_filepath, ".info.json")
+
+      File.rm(updated_media_item.metadata_filepath)
     end
   end
 

test/pinchflat/filesystem/filesystem_helpers_test.exs

@@ -34,6 +34,29 @@ defmodule Pinchflat.Filesystem.FilesystemHelpersTest do
     end
   end
 
+  describe "write_p/3" do
+    test "writes content to a file" do
+      filepath = FilesystemHelpers.generate_metadata_tmpfile(:json)
+      content = "{}"
+
+      assert :ok = FilesystemHelpers.write_p(filepath, content)
+      assert File.read!(filepath) == content
+
+      File.rm!(filepath)
+    end
+
+    test "creates directories as needed" do
+      tmpfile_directory = Application.get_env(:pinchflat, :tmpfile_directory)
+      filepath = Path.join([tmpfile_directory, "foo", "bar", "file.json"])
+      content = "{}"
+
+      assert :ok = FilesystemHelpers.write_p(filepath, content)
+      assert File.read!(filepath) == content
+
+      File.rm!(filepath)
+    end
+  end
+
   describe "write_p!/3" do
     test "writes content to a file" do
       filepath = FilesystemHelpers.generate_metadata_tmpfile(:json)

test/pinchflat/media_test.exs

@@ -239,6 +239,26 @@ defmodule Pinchflat.MediaTest do
     end
   end
 
+  describe "list_pending_media_items_for/1 when testing title regex" do
+    test "returns only media items that match the title regex" do
+      source = source_fixture(%{title_filter_regex: "(?i)^FOO$"})
+
+      matching_media_item = media_item_fixture(%{source_id: source.id, media_filepath: nil, title: "foo"})
+      _non_matching_media_item = media_item_fixture(%{source_id: source.id, media_filepath: nil, title: "bar"})
+
+      assert Media.list_pending_media_items_for(source) == [matching_media_item]
+    end
+
+    test "does not apply a regex if none is specified" do
+      source = source_fixture(%{title_filter_regex: nil})
+
+      media_item_one = media_item_fixture(%{source_id: source.id, media_filepath: nil, title: "foo"})
+      media_item_two = media_item_fixture(%{source_id: source.id, media_filepath: nil, title: "bar"})
+
+      assert Media.list_pending_media_items_for(source) == [media_item_one, media_item_two]
+    end
+  end
+
   describe "list_downloaded_media_items_for/1" do
     test "returns only media items with a media_filepath" do
       source = source_fixture()

test/pinchflat/metadata/metadata_file_helpers_test.exs

@@ -140,4 +140,14 @@ defmodule Pinchflat.Metadata.MetadataFileHelpersTest do
       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

test/pinchflat/metadata/metadata_parser_test.exs

@@ -1,5 +1,6 @@
 defmodule Pinchflat.Metadata.MetadataParserTest do
   use Pinchflat.DataCase
+  import Pinchflat.MediaFixtures
 
   alias Pinchflat.Metadata.MetadataParser, as: Parser
 
@@ -11,7 +12,7 @@ defmodule Pinchflat.Metadata.MetadataParserTest do
     test "it extracts the media filepath", %{metadata: metadata} do
       result = Parser.parse_for_media_item(metadata)
 
-      assert String.contains?(result.media_filepath, "bwRHIkYqYJo")
+      assert String.contains?(result.media_filepath, "Pinchflat Example Video-ABC123")
       assert String.ends_with?(result.media_filepath, ".mkv")
     end
 
@@ -88,6 +89,22 @@ defmodule Pinchflat.Metadata.MetadataParserTest do
   end
 
   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
       result = Parser.parse_for_media_item(metadata)
 
@@ -103,6 +120,14 @@ defmodule Pinchflat.Metadata.MetadataParserTest do
       assert String.contains?(result.thumbnail_filepath, "-thumb.webp")
     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
       metadata = Map.put(metadata, "thumbnails", %{})
 
@@ -121,12 +146,29 @@ defmodule Pinchflat.Metadata.MetadataParserTest do
   end
 
   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
       result = Parser.parse_for_media_item(metadata)
 
       assert String.ends_with?(result.metadata_filepath, ".info.json")
     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
       metadata = Map.put(metadata, "infojson_filename", nil)
 

test/pinchflat/metadata/source_metadata_storage_worker_test.exs

@@ -50,6 +50,23 @@ defmodule Pinchflat.Metadata.SourceMetadataStorageWorkerTest do
     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
     test "sets metadata location for source" do
       stub(YtDlpRunnerMock, :run, fn
@@ -59,7 +76,6 @@ defmodule Pinchflat.Metadata.SourceMetadataStorageWorkerTest do
 
       source = Repo.preload(source_fixture(), :metadata)
 
-      refute source.metadata
       perform_job(SourceMetadataStorageWorker, %{id: source.id})
       source = Repo.preload(Repo.reload(source), :metadata)
 
@@ -83,6 +99,42 @@ defmodule Pinchflat.Metadata.SourceMetadataStorageWorkerTest do
 
       assert metadata == %{"title" => "test"}
     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
 
   describe "perform/1 when testing source image downloading" do

test/pinchflat/sources_test.exs

@@ -138,49 +138,6 @@ defmodule Pinchflat.SourcesTest do
       assert {:error, %Ecto.Changeset{}} = Sources.create_source(@invalid_source_attrs)
     end
 
-    test "creation enforces uniqueness of collection_id scoped to the media_profile" do
-      expect(YtDlpRunnerMock, :run, 2, fn _url, _opts, _ot ->
-        {:ok,
-         Phoenix.json_library().encode!(%{
-           channel: "some channel name",
-           channel_id: "some_channel_id_12345678",
-           playlist_id: "some_channel_id_12345678",
-           playlist_title: "some channel name - videos"
-         })}
-      end)
-
-      valid_once_attrs = %{
-        media_profile_id: media_profile_fixture().id,
-        original_url: "https://www.youtube.com/channel/abc123"
-      }
-
-      assert {:ok, %Source{}} = Sources.create_source(valid_once_attrs)
-      assert {:error, %Ecto.Changeset{}} = Sources.create_source(valid_once_attrs)
-    end
-
-    test "creation lets you duplicate collection_ids as long as the media profile is different" do
-      expect(YtDlpRunnerMock, :run, 2, fn _url, _opts, _ot ->
-        {:ok,
-         Phoenix.json_library().encode!(%{
-           channel: "some channel name",
-           channel_id: "some_channel_id_12345678",
-           playlist_id: "some_channel_id_12345678",
-           playlist_title: "some channel name - videos"
-         })}
-      end)
-
-      valid_attrs = %{
-        name: "some name",
-        original_url: "https://www.youtube.com/channel/abc123"
-      }
-
-      source_1_attrs = Map.merge(valid_attrs, %{media_profile_id: media_profile_fixture().id})
-      source_2_attrs = Map.merge(valid_attrs, %{media_profile_id: media_profile_fixture().id})
-
-      assert {:ok, %Source{}} = Sources.create_source(source_1_attrs)
-      assert {:ok, %Source{}} = Sources.create_source(source_2_attrs)
-    end
-
     test "creation will schedule the indexing task" do
       expect(YtDlpRunnerMock, :run, &channel_mock/3)
 

test/pinchflat/yt_dlp/command_runner_test.exs

@@ -1,6 +1,8 @@
 defmodule Pinchflat.YtDlp.CommandRunnerTest do
   use ExUnit.Case, async: true
 
+  alias Pinchflat.Filesystem.FilesystemHelpers
+
   alias Pinchflat.YtDlp.CommandRunner, as: Runner
 
   @original_executable Application.compile_env(:pinchflat, :yt_dlp_executable)
@@ -65,6 +67,41 @@ defmodule Pinchflat.YtDlp.CommandRunnerTest do
     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
     Application.put_env(:pinchflat, :yt_dlp_executable, new_executable)
     fun.()

test/pinchflat/yt_dlp/media_collection_test.exs

@@ -6,7 +6,7 @@ defmodule Pinchflat.YtDlp.MediaCollectionTest do
   alias Pinchflat.YtDlp.Media
   alias Pinchflat.YtDlp.MediaCollection
 
-  @channel_url "https://www.youtube.com/c/TheUselessTrials"
+  @channel_url "https://www.youtube.com/c/PinchflatTestChannel"
 
   setup :verify_on_exit!
 
@@ -77,10 +77,10 @@ defmodule Pinchflat.YtDlp.MediaCollectionTest do
     test "it returns a map with data on success" do
       expect(YtDlpRunnerMock, :run, fn _url, _opts, _ot ->
         Phoenix.json_library().encode(%{
-          channel: "TheUselessTrials",
+          channel: "PinchflatTestChannel",
           channel_id: "UCQH2",
           playlist_id: "PLQH2",
-          playlist_title: "TheUselessTrials - Videos"
+          playlist_title: "PinchflatTestChannel - Videos"
         })
       end)
 
@@ -88,9 +88,9 @@ defmodule Pinchflat.YtDlp.MediaCollectionTest do
 
       assert %{
                channel_id: "UCQH2",
-               channel_name: "TheUselessTrials",
+               channel_name: "PinchflatTestChannel",
                playlist_id: "PLQH2",
-               playlist_name: "TheUselessTrials - Videos"
+               playlist_name: "PinchflatTestChannel - Videos"
              } = res
     end
 
@@ -121,12 +121,12 @@ defmodule Pinchflat.YtDlp.MediaCollectionTest do
   describe "get_source_metadata/1" do
     test "it returns a map with data on success" do
       expect(YtDlpRunnerMock, :run, fn _url, _opts, _ot ->
-        Phoenix.json_library().encode(%{channel: "TheUselessTrials"})
+        Phoenix.json_library().encode(%{channel: "PinchflatTestChannel"})
       end)
 
       assert {:ok, res} = MediaCollection.get_source_metadata(@channel_url)
 
-      assert %{"channel" => "TheUselessTrials"} = res
+      assert %{"channel" => "PinchflatTestChannel"} = res
     end
 
     test "it passes the expected args to the backend runner" do

test/pinchflat/yt_dlp/media_test.exs

@@ -36,7 +36,7 @@ defmodule Pinchflat.YtDlp.MediaTest do
         {:ok, render_metadata(:media_metadata)}
       end)
 
-      assert {:ok, %{"title" => "Trying to Wheelie Without the Rear Brake"}} =
+      assert {:ok, %{"title" => "Pinchflat Example Video"}} =
                Media.download(@media_url)
     end