Compare commits
50 Commits
v0.1.0-alpha
...
v0.1.1
| Author | SHA1 | Date | |
|---|---|---|---|
| a9d5407071 | |||
| 37c1da8014 | |||
| 937a14985f | |||
| a6a20c111f | |||
| 2bb96edc00 | |||
| 87f07ff634 | |||
| dd60cb5419 | |||
| 610b00566b | |||
| aba15ed886 | |||
| 87da716fdf | |||
| 45f056c6e0 | |||
| 11d160008c | |||
| ba0a1ba100 | |||
| 8c51a286c9 | |||
| 46c27e4875 | |||
| b639918555 | |||
| 5596351f58 | |||
| ad150b6f16 | |||
| f6d8e15670 | |||
| 2906ff1b30 | |||
| 0582a7bfd5 | |||
| 3db2e8190f | |||
| 087c9c2d0f | |||
| c046abf36f | |||
| 70dd95211f | |||
| 8491f8b317 | |||
| d0cb782082 | |||
| 7a7e8080cd | |||
| fbe21cb304 | |||
| 0f3329e97d | |||
| 25eb772896 | |||
| cf59bf99cd | |||
| 47e96e3780 | |||
| a7af6a9125 | |||
| 8f9d18dc71 | |||
| 513212faf2 | |||
| 5ec2c92a0c | |||
| 3c897e96e6 | |||
| c0885cfaf2 | |||
| b2f39a7b7f | |||
| bada14625b | |||
| 7e4f1a8412 | |||
| 0e537d8f57 | |||
| afe41d2e36 | |||
| f36bd5abab | |||
| b3f094fa69 | |||
| ccdcf8eec5 | |||
| 67d7f397d1 | |||
| 09a4bcb36b | |||
| dc0313d875 |
+3
-6
@@ -9,18 +9,15 @@
|
|||||||
fix: true,
|
fix: true,
|
||||||
|
|
||||||
## don't retry automatically even if last run resulted in failures
|
## don't retry automatically even if last run resulted in failures
|
||||||
# retry: false,
|
retry: false,
|
||||||
|
|
||||||
## list of tools (see `mix check` docs for a list of default curated tools)
|
## list of tools (see `mix check` docs for a list of default curated tools)
|
||||||
tools: [
|
tools: [
|
||||||
{:compiler, env: %{"MIX_ENV" => "test"}},
|
{:compiler, env: %{"MIX_ENV" => "test"}},
|
||||||
{:formatter, env: %{"MIX_ENV" => "test"}},
|
{:formatter, env: %{"MIX_ENV" => "test"}},
|
||||||
{:sobelow, "mix sobelow --config"},
|
{:sobelow, "mix sobelow --config"},
|
||||||
# TODO: delete these and replace them with builtin ex_unit and formatter tools
|
{:prettier_formatting, "yarn run prettier . --check", fix: "yarn run prettier . --write"},
|
||||||
# once Elixir 1.16.2 is released (see: https://github.com/karolsluszniak/ex_check/issues/41#issuecomment-1921390413)
|
{:npm_test, false}
|
||||||
{:elixir_tests, "mix test"},
|
|
||||||
{:elixir_formatting, "mix format --check-formatted", fix: "mix format"},
|
|
||||||
{:prettier_formatting, "yarn run prettier . --check", fix: "yarn run prettier . --write"}
|
|
||||||
|
|
||||||
## curated tools may be disabled (e.g. the check for compilation warnings)
|
## curated tools may be disabled (e.g. the check for compilation warnings)
|
||||||
# {:compiler, false},
|
# {:compiler, false},
|
||||||
|
|||||||
+11
-2
@@ -128,7 +128,7 @@
|
|||||||
{Credo.Check.Refactor.MatchInCondition, []},
|
{Credo.Check.Refactor.MatchInCondition, []},
|
||||||
{Credo.Check.Refactor.NegatedConditionsInUnless, []},
|
{Credo.Check.Refactor.NegatedConditionsInUnless, []},
|
||||||
{Credo.Check.Refactor.NegatedConditionsWithElse, []},
|
{Credo.Check.Refactor.NegatedConditionsWithElse, []},
|
||||||
{Credo.Check.Refactor.Nesting, []},
|
{Credo.Check.Refactor.Nesting, [max_nesting: 4]},
|
||||||
{Credo.Check.Refactor.RedundantWithClauseResult, []},
|
{Credo.Check.Refactor.RedundantWithClauseResult, []},
|
||||||
{Credo.Check.Refactor.RejectReject, []},
|
{Credo.Check.Refactor.RejectReject, []},
|
||||||
{Credo.Check.Refactor.UnlessWithElse, []},
|
{Credo.Check.Refactor.UnlessWithElse, []},
|
||||||
@@ -157,7 +157,16 @@
|
|||||||
{Credo.Check.Warning.UnusedRegexOperation, []},
|
{Credo.Check.Warning.UnusedRegexOperation, []},
|
||||||
{Credo.Check.Warning.UnusedStringOperation, []},
|
{Credo.Check.Warning.UnusedStringOperation, []},
|
||||||
{Credo.Check.Warning.UnusedTupleOperation, []},
|
{Credo.Check.Warning.UnusedTupleOperation, []},
|
||||||
{Credo.Check.Warning.WrongTestFileExtension, []}
|
{Credo.Check.Warning.WrongTestFileExtension, []},
|
||||||
|
|
||||||
|
#
|
||||||
|
## Naming Checks
|
||||||
|
#
|
||||||
|
{CredoNaming.Check.Consistency.ModuleFilename,
|
||||||
|
[
|
||||||
|
priority: :normal,
|
||||||
|
excluded_paths: [~r/test\/support/, ~r/priv/, ~r/lib\/pinchflat_web/, ~r/test\/pinchflat_web/]
|
||||||
|
]}
|
||||||
],
|
],
|
||||||
disabled: [
|
disabled: [
|
||||||
#
|
#
|
||||||
|
|||||||
@@ -13,3 +13,5 @@ N/A
|
|||||||
## Any other comments?
|
## Any other comments?
|
||||||
|
|
||||||
N/A
|
N/A
|
||||||
|
|
||||||
|
- [ ] I am the original author of this code and I am giving it freely to the community and Pinchflat project maintainers
|
||||||
|
|||||||
@@ -7,6 +7,10 @@ on:
|
|||||||
description: 'Docker Image Tag'
|
description: 'Docker Image Tag'
|
||||||
required: true
|
required: true
|
||||||
default: 'dev'
|
default: 'dev'
|
||||||
|
platforms:
|
||||||
|
description: 'Build Platforms'
|
||||||
|
required: true
|
||||||
|
default: 'linux/amd64,linux/arm64'
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
docker:
|
docker:
|
||||||
@@ -24,9 +28,19 @@ jobs:
|
|||||||
username: ${{ secrets.DOCKERHUB_USERNAME }}
|
username: ${{ secrets.DOCKERHUB_USERNAME }}
|
||||||
password: ${{ secrets.DOCKERHUB_TOKEN }}
|
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
|
- name: Build and push
|
||||||
uses: docker/build-push-action@v5
|
uses: docker/build-push-action@v5
|
||||||
with:
|
with:
|
||||||
|
platforms: ${{ github.event.inputs.platforms }}
|
||||||
push: true
|
push: true
|
||||||
file: ./selfhosted.Dockerfile
|
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 }}
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
|
import Ecto.Query, warn: false
|
||||||
alias Pinchflat.Repo
|
alias Pinchflat.Repo
|
||||||
|
|
||||||
alias Pinchflat.Tasks.Task
|
alias Pinchflat.Tasks.Task
|
||||||
alias Pinchflat.Media.MediaItem
|
|
||||||
alias Pinchflat.Tasks.SourceTasks
|
|
||||||
alias Pinchflat.Media.MediaMetadata
|
|
||||||
alias Pinchflat.Sources.Source
|
alias Pinchflat.Sources.Source
|
||||||
|
alias Pinchflat.Media.MediaItem
|
||||||
|
alias Pinchflat.Metadata.MediaMetadata
|
||||||
alias Pinchflat.Profiles.MediaProfile
|
alias Pinchflat.Profiles.MediaProfile
|
||||||
|
|
||||||
alias Pinchflat.Tasks
|
alias Pinchflat.Tasks
|
||||||
@@ -13,43 +13,11 @@ alias Pinchflat.Profiles
|
|||||||
alias Pinchflat.Sources
|
alias Pinchflat.Sources
|
||||||
alias Pinchflat.Settings
|
alias Pinchflat.Settings
|
||||||
|
|
||||||
alias Pinchflat.MediaClient.{SourceDetails, MediaDownloader}
|
alias Pinchflat.Downloading.MediaDownloader
|
||||||
alias Pinchflat.Metadata.{Zipper, ThumbnailFetcher}
|
alias Pinchflat.YtDlp.Media, as: YtDlpMedia
|
||||||
|
alias Pinchflat.YtDlp.MediaCollection, as: YtDlpCollection
|
||||||
|
|
||||||
alias Pinchflat.Utils.FilesystemUtils.FileFollowerServer
|
alias Pinchflat.FastIndexing.YoutubeRss
|
||||||
|
alias Pinchflat.Metadata.MetadataFileHelpers
|
||||||
|
|
||||||
defmodule IexHelpers do
|
alias Pinchflat.SlowIndexing.FileFollowerServer
|
||||||
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 details(type) do
|
|
||||||
source =
|
|
||||||
case type do
|
|
||||||
:playlist -> playlist_url()
|
|
||||||
:channel -> channel_url()
|
|
||||||
end
|
|
||||||
|
|
||||||
SourceDetails.get_source_details(source)
|
|
||||||
end
|
|
||||||
|
|
||||||
def ids(type) do
|
|
||||||
source =
|
|
||||||
case type do
|
|
||||||
:playlist -> playlist_url()
|
|
||||||
:channel -> channel_url()
|
|
||||||
end
|
|
||||||
|
|
||||||
SourceDetails.get_media_attributes(source)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
import IexHelpers
|
|
||||||
|
|||||||
@@ -1,39 +1,143 @@
|
|||||||
# 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>
|
||||||
|
|
||||||
## What is Pinchflat?
|
# Your next YouTube media manager
|
||||||
|
|
||||||
TODO: expand on this.
|
## Table of contents:
|
||||||
|
|
||||||
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.
|
- [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)
|
||||||
|
|
||||||
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.
|
## What it does
|
||||||
|
|
||||||
|
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!
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
## 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
|
## 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!
|
||||||
|
|
||||||
|
### Portainer
|
||||||
|
|
||||||
|
Docker Compose file:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
version: '3'
|
||||||
|
services:
|
||||||
|
pinchflat:
|
||||||
|
image: keglin/pinchflat:latest
|
||||||
|
ports:
|
||||||
|
- '8945:8945'
|
||||||
|
volumes:
|
||||||
|
- /host/path/to/config:/config
|
||||||
|
- /host/path/to/downloads:/downloads
|
||||||
|
```
|
||||||
|
|
||||||
|
### Docker
|
||||||
|
|
||||||
|
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
|
```bash
|
||||||
docker build . --file selfhosted.Dockerfile -t pinchflat:dev
|
# 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 \
|
docker run \
|
||||||
-p 8945:8945 \
|
-p 8945:8945 \
|
||||||
-v /Users/work/Desktop/test_volumes/config:/config \
|
-v /host/path/to/config:/config \
|
||||||
-v /Users/work/Desktop/test_volumes/downloads:/downloads \
|
-v /host/path/to/downloads:/downloads \
|
||||||
pinchflat:dev
|
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.
|
||||||
|
|
||||||
## Authentication
|
## Authentication
|
||||||
|
|
||||||
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.
|
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
|
## License
|
||||||
|
|
||||||
See `LICENSE` file
|
See `LICENSE` file
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|||||||
+12
-2
@@ -12,7 +12,7 @@ config :pinchflat,
|
|||||||
generators: [timestamp_type: :utc_datetime],
|
generators: [timestamp_type: :utc_datetime],
|
||||||
# Specifying backend data here makes mocking and local testing SUPER easy
|
# Specifying backend data here makes mocking and local testing SUPER easy
|
||||||
yt_dlp_executable: System.find_executable("yt-dlp"),
|
yt_dlp_executable: System.find_executable("yt-dlp"),
|
||||||
yt_dlp_runner: Pinchflat.MediaClient.Backends.YtDlp.CommandRunner,
|
yt_dlp_runner: Pinchflat.YtDlp.CommandRunner,
|
||||||
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",
|
||||||
@@ -26,6 +26,8 @@ config :pinchflat,
|
|||||||
# Configures the endpoint
|
# Configures the endpoint
|
||||||
config :pinchflat, PinchflatWeb.Endpoint,
|
config :pinchflat, PinchflatWeb.Endpoint,
|
||||||
url: [host: "localhost", port: 8945],
|
url: [host: "localhost", port: 8945],
|
||||||
|
# NOTE: this must be updated if ever deployed traditionally (ie: not self-hosted)
|
||||||
|
check_origin: false,
|
||||||
adapter: Phoenix.Endpoint.Cowboy2Adapter,
|
adapter: Phoenix.Endpoint.Cowboy2Adapter,
|
||||||
render_errors: [
|
render_errors: [
|
||||||
formats: [html: PinchflatWeb.ErrorHTML, json: PinchflatWeb.ErrorJSON],
|
formats: [html: PinchflatWeb.ErrorHTML, json: PinchflatWeb.ErrorJSON],
|
||||||
@@ -40,7 +42,15 @@ config :pinchflat, Oban,
|
|||||||
# Keep old jobs for 30 days for display in the UI
|
# Keep old jobs for 30 days for display in the UI
|
||||||
plugins: [{Oban.Plugins.Pruner, max_age: 30 * 24 * 60 * 60}],
|
plugins: [{Oban.Plugins.Pruner, max_age: 30 * 24 * 60 * 60}],
|
||||||
# TODO: consider making this an env var or something?
|
# TODO: consider making this an env var or something?
|
||||||
queues: [default: 10, media_indexing: 2, media_fetching: 2, media_local_metadata: 8]
|
queues: [
|
||||||
|
default: 10,
|
||||||
|
fast_indexing: 6,
|
||||||
|
media_indexing: 2,
|
||||||
|
media_collection_indexing: 2,
|
||||||
|
media_fetching: 2,
|
||||||
|
local_metadata: 8,
|
||||||
|
remote_metadata: 4
|
||||||
|
]
|
||||||
|
|
||||||
# Configures the mailer
|
# Configures the mailer
|
||||||
#
|
#
|
||||||
|
|||||||
@@ -21,7 +21,6 @@ config :pinchflat, PinchflatWeb.Endpoint,
|
|||||||
# Binding to loopback ipv4 address prevents access from other machines.
|
# Binding to loopback ipv4 address prevents access from other machines.
|
||||||
# Change to `ip: {0, 0, 0, 0}` to allow access from other machines.
|
# Change to `ip: {0, 0, 0, 0}` to allow access from other machines.
|
||||||
http: [port: 4008],
|
http: [port: 4008],
|
||||||
check_origin: false,
|
|
||||||
code_reloader: true,
|
code_reloader: true,
|
||||||
debug_errors: true,
|
debug_errors: true,
|
||||||
secret_key_base: "QLKKs3ypkUgJ/fMnWZaIYqpMbnA4IlPVEm3tvezsblhFDv4b67rdp+AmTpAFFURK",
|
secret_key_base: "QLKKs3ypkUgJ/fMnWZaIYqpMbnA4IlPVEm3tvezsblhFDv4b67rdp+AmTpAFFURK",
|
||||||
|
|||||||
@@ -25,6 +25,21 @@ config :pinchflat,
|
|||||||
basic_auth_username: System.get_env("BASIC_AUTH_USERNAME"),
|
basic_auth_username: System.get_env("BASIC_AUTH_USERNAME"),
|
||||||
basic_auth_password: System.get_env("BASIC_AUTH_PASSWORD")
|
basic_auth_password: System.get_env("BASIC_AUTH_PASSWORD")
|
||||||
|
|
||||||
|
arch_string = to_string(:erlang.system_info(:system_architecture))
|
||||||
|
|
||||||
|
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
|
if config_env() == :prod do
|
||||||
config_path =
|
config_path =
|
||||||
System.get_env("CONFIG_PATH") ||
|
System.get_env("CONFIG_PATH") ||
|
||||||
|
|||||||
+13
-3
@@ -1,9 +1,18 @@
|
|||||||
# Extend from the official Elixir image.
|
ARG ELIXIR_VERSION=1.16.2
|
||||||
FROM elixir:latest
|
ARG OTP_VERSION=26.2.2
|
||||||
|
ARG DEBIAN_VERSION=bookworm-20240130
|
||||||
|
ARG DEV_IMAGE="hexpm/elixir:${ELIXIR_VERSION}-erlang-${OTP_VERSION}-debian-${DEBIAN_VERSION}"
|
||||||
|
|
||||||
|
FROM ${DEV_IMAGE}
|
||||||
|
|
||||||
|
# Set the locale deets
|
||||||
|
ENV LANG en_US.UTF-8
|
||||||
|
ENV LANGUAGE en_US:en
|
||||||
|
ENV LC_ALL en_US.UTF-8
|
||||||
|
|
||||||
# Install debian packages
|
# Install debian packages
|
||||||
RUN apt-get update -qq
|
RUN apt-get update -qq
|
||||||
RUN apt-get install -y inotify-tools ffmpeg \
|
RUN apt-get install -y inotify-tools ffmpeg curl git openssh-client \
|
||||||
python3 python3-pip python3-setuptools python3-wheel python3-dev
|
python3 python3-pip python3-setuptools python3-wheel python3-dev
|
||||||
|
|
||||||
# Install nodejs
|
# Install nodejs
|
||||||
@@ -28,6 +37,7 @@ COPY . ./
|
|||||||
RUN chmod +x ./docker-run.dev.sh
|
RUN chmod +x ./docker-run.dev.sh
|
||||||
|
|
||||||
# Install Elixir deps
|
# Install Elixir deps
|
||||||
|
# RUN mix archive.install github hexpm/hex branch latest
|
||||||
RUN mix deps.get
|
RUN mix deps.get
|
||||||
# Gives us iex shell history
|
# Gives us iex shell history
|
||||||
ENV ERL_AFLAGS="-kernel shell_history enabled"
|
ENV ERL_AFLAGS="-kernel shell_history enabled"
|
||||||
|
|||||||
@@ -2,5 +2,3 @@
|
|||||||
- Use a UUID for the media database ID (or at least alongside it)
|
- Use a UUID for the media database ID (or at least alongside it)
|
||||||
- Look into this and its recommended plugins https://hexdocs.pm/ex_check/readme.html
|
- Look into this and its recommended plugins https://hexdocs.pm/ex_check/readme.html
|
||||||
- Add output template option for the source's friendly name
|
- Add output template option for the source's friendly name
|
||||||
- TODO: Install Elixir 1.16.2 when available to fix bug with `ex_check` https://github.com/karolsluszniak/ex_check/issues/41#issuecomment-1921390413
|
|
||||||
- delete `{:elixir_tests, "mix test"}` and formatting check
|
|
||||||
|
|||||||
@@ -10,9 +10,10 @@ defmodule Pinchflat.Application do
|
|||||||
children = [
|
children = [
|
||||||
PinchflatWeb.Telemetry,
|
PinchflatWeb.Telemetry,
|
||||||
Pinchflat.Repo,
|
Pinchflat.Repo,
|
||||||
# {Task, &run_startup_tasks/0},
|
# Must be before startup tasks
|
||||||
Pinchflat.StartupTasks,
|
Pinchflat.Boot.PreJobStartupTasks,
|
||||||
{Oban, Application.fetch_env!(:pinchflat, Oban)},
|
{Oban, Application.fetch_env!(:pinchflat, Oban)},
|
||||||
|
Pinchflat.Boot.PostJobStartupTasks,
|
||||||
{DNSCluster, query: Application.get_env(:pinchflat, :dns_cluster_query) || :ignore},
|
{DNSCluster, query: Application.get_env(:pinchflat, :dns_cluster_query) || :ignore},
|
||||||
{Phoenix.PubSub, name: Pinchflat.PubSub},
|
{Phoenix.PubSub, name: Pinchflat.PubSub},
|
||||||
# Start the Finch HTTP client for sending emails
|
# Start the Finch HTTP client for sending emails
|
||||||
|
|||||||
@@ -0,0 +1,75 @@
|
|||||||
|
defmodule Pinchflat.Boot.DataBackfillWorker do
|
||||||
|
@moduledoc false
|
||||||
|
|
||||||
|
use Oban.Worker,
|
||||||
|
queue: :local_metadata,
|
||||||
|
unique: [period: :infinity, states: [:available, :scheduled, :retryable]],
|
||||||
|
tags: ["media_item", "media_metadata", "local_metadata", "data_backfill"]
|
||||||
|
|
||||||
|
# This one is going to be a little more self-contained
|
||||||
|
# instead of relying on outside modules for the methods.
|
||||||
|
# That's because, for now, these methods are not intended
|
||||||
|
# to be used elsewhere.
|
||||||
|
#
|
||||||
|
# I'm just trying out that pattern and seeing if I like it better
|
||||||
|
# so this may change.
|
||||||
|
import Ecto.Query, warn: false
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias __MODULE__
|
||||||
|
alias Pinchflat.Repo
|
||||||
|
alias Pinchflat.Media.MediaItem
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Cancels all pending backfill jobs. Useful for ensuring worker runs immediately
|
||||||
|
on app boot.
|
||||||
|
|
||||||
|
Returns {:ok, integer()}
|
||||||
|
"""
|
||||||
|
def cancel_pending_backfill_jobs do
|
||||||
|
Oban.Job
|
||||||
|
|> where(worker: "Pinchflat.Boot.DataBackfillWorker")
|
||||||
|
|> Oban.cancel_all_jobs()
|
||||||
|
end
|
||||||
|
|
||||||
|
@impl Oban.Worker
|
||||||
|
@doc """
|
||||||
|
Performs one-off tasks to get data in the right shape.
|
||||||
|
This can be needed when we add new features or change the way
|
||||||
|
we store data. Must be idempotent. All new data should already
|
||||||
|
conform to the expected schema so this should only be needed
|
||||||
|
for existing data. Still runs periodically to be safe.
|
||||||
|
|
||||||
|
Returns :ok
|
||||||
|
"""
|
||||||
|
def perform(%Oban.Job{}) do
|
||||||
|
Logger.info("Running data backfill worker")
|
||||||
|
backfill_shorts_data()
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
%{}
|
||||||
|
|> DataBackfillWorker.new(schedule_in: next_run_in)
|
||||||
|
|> Repo.insert_unique_job()
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -1,6 +1,7 @@
|
|||||||
defmodule Pinchflat.StartupTasks do
|
defmodule Pinchflat.Boot.PostJobStartupTasks do
|
||||||
@moduledoc """
|
@moduledoc """
|
||||||
This module is responsible for running startup tasks on app boot.
|
This module is responsible for running startup tasks on app boot
|
||||||
|
AFTER the job runner has initiallized.
|
||||||
|
|
||||||
It's a GenServer because that plays REALLY nicely with the existing
|
It's a GenServer because that plays REALLY nicely with the existing
|
||||||
Phoenix supervision tree.
|
Phoenix supervision tree.
|
||||||
@@ -8,8 +9,10 @@ defmodule Pinchflat.StartupTasks do
|
|||||||
|
|
||||||
# restart: :temporary means that this process will never be restarted (ie: will run once and then die)
|
# restart: :temporary means that this process will never be restarted (ie: will run once and then die)
|
||||||
use GenServer, restart: :temporary
|
use GenServer, restart: :temporary
|
||||||
|
import Ecto.Query, warn: false
|
||||||
|
|
||||||
alias Pinchflat.Settings
|
alias Pinchflat.Repo
|
||||||
|
alias Pinchflat.Boot.DataBackfillWorker
|
||||||
|
|
||||||
def start_link(opts \\ []) do
|
def start_link(opts \\ []) do
|
||||||
GenServer.start_link(__MODULE__, %{}, opts)
|
GenServer.start_link(__MODULE__, %{}, opts)
|
||||||
@@ -21,16 +24,21 @@ defmodule Pinchflat.StartupTasks do
|
|||||||
Any code defined here will run every time the application starts. You must
|
Any code defined here will run every time the application starts. You must
|
||||||
make sure that the code is idempotent and safe to run multiple times.
|
make sure that the code is idempotent and safe to run multiple times.
|
||||||
|
|
||||||
This is a good place to set up default settings, create initial records, stuff like that
|
This is a good place to set up default settings, create initial records, stuff like that.
|
||||||
|
Should be fast - anything with the potential to be slow should be kicked off as a job instead.
|
||||||
"""
|
"""
|
||||||
@impl true
|
@impl true
|
||||||
def init(state) do
|
def init(state) do
|
||||||
apply_default_settings()
|
enqueue_backfill_worker()
|
||||||
|
|
||||||
{:ok, state}
|
{:ok, state}
|
||||||
end
|
end
|
||||||
|
|
||||||
defp apply_default_settings do
|
defp enqueue_backfill_worker do
|
||||||
Settings.fetch!(:onboarding, true)
|
DataBackfillWorker.cancel_pending_backfill_jobs()
|
||||||
|
|
||||||
|
%{}
|
||||||
|
|> DataBackfillWorker.new()
|
||||||
|
|> Repo.insert_unique_job()
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -0,0 +1,85 @@
|
|||||||
|
defmodule Pinchflat.Boot.PreJobStartupTasks do
|
||||||
|
@moduledoc """
|
||||||
|
This module is responsible for running startup tasks on app boot
|
||||||
|
BEFORE the job runner has initiallized.
|
||||||
|
|
||||||
|
It's a GenServer because that plays REALLY nicely with the existing
|
||||||
|
Phoenix supervision tree.
|
||||||
|
"""
|
||||||
|
|
||||||
|
# restart: :temporary means that this process will never be restarted (ie: will run once and then die)
|
||||||
|
use GenServer, restart: :temporary
|
||||||
|
import Ecto.Query, warn: false
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias Pinchflat.Repo
|
||||||
|
alias Pinchflat.Settings
|
||||||
|
|
||||||
|
def start_link(opts \\ []) do
|
||||||
|
GenServer.start_link(__MODULE__, %{}, opts)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Runs application startup tasks.
|
||||||
|
|
||||||
|
Any code defined here will run every time the application starts. You must
|
||||||
|
make sure that the code is idempotent and safe to run multiple times.
|
||||||
|
|
||||||
|
This is a good place to set up default settings, create initial records, stuff like that.
|
||||||
|
Should be fast - anything with the potential to be slow should be kicked off as a job instead.
|
||||||
|
"""
|
||||||
|
@impl true
|
||||||
|
def init(state) do
|
||||||
|
reset_executing_jobs()
|
||||||
|
apply_default_settings()
|
||||||
|
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 apply_default_settings do
|
||||||
|
Settings.fetch!(:onboarding, true)
|
||||||
|
Settings.fetch!(:pro_enabled, false)
|
||||||
|
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
|
||||||
@@ -0,0 +1,155 @@
|
|||||||
|
defmodule Pinchflat.Downloading.DownloadOptionBuilder do
|
||||||
|
@moduledoc """
|
||||||
|
Builds the options for yt-dlp to download media based on the given media profile.
|
||||||
|
"""
|
||||||
|
|
||||||
|
alias Pinchflat.Sources.Source
|
||||||
|
alias Pinchflat.Media.MediaItem
|
||||||
|
alias Pinchflat.Downloading.OutputPathBuilder
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Builds the options for yt-dlp to download media based on the given media's profile.
|
||||||
|
|
||||||
|
IDEA: consider adding the ability to pass in a second argument to override
|
||||||
|
these options
|
||||||
|
"""
|
||||||
|
def build(%MediaItem{} = media_item_with_preloads) do
|
||||||
|
media_profile = media_item_with_preloads.source.media_profile
|
||||||
|
|
||||||
|
built_options =
|
||||||
|
default_options() ++
|
||||||
|
subtitle_options(media_profile) ++
|
||||||
|
thumbnail_options(media_item_with_preloads) ++
|
||||||
|
metadata_options(media_profile) ++
|
||||||
|
quality_options(media_profile) ++
|
||||||
|
output_options(media_item_with_preloads)
|
||||||
|
|
||||||
|
{:ok, built_options}
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Builds the output path for yt-dlp to download media based on the given source's
|
||||||
|
media profile.
|
||||||
|
|
||||||
|
Returns binary()
|
||||||
|
"""
|
||||||
|
def build_output_path_for(%Source{} = source_with_preloads) do
|
||||||
|
output_path_template = source_with_preloads.media_profile.output_path_template
|
||||||
|
|
||||||
|
build_output_path(output_path_template, source_with_preloads)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp default_options do
|
||||||
|
[:no_progress, :windows_filenames]
|
||||||
|
end
|
||||||
|
|
||||||
|
defp subtitle_options(media_profile) do
|
||||||
|
mapped_struct = Map.from_struct(media_profile)
|
||||||
|
|
||||||
|
Enum.reduce(mapped_struct, [], fn attr, acc ->
|
||||||
|
case {attr, media_profile} do
|
||||||
|
{{:download_subs, true}, _} ->
|
||||||
|
# Force SRT for now - MAY provide as an option in the future
|
||||||
|
acc ++ [:write_subs, convert_subs: "srt"]
|
||||||
|
|
||||||
|
{{:download_auto_subs, true}, %{download_subs: true}} ->
|
||||||
|
acc ++ [:write_auto_subs]
|
||||||
|
|
||||||
|
{{:embed_subs, true}, %{preferred_resolution: pr}} when pr != :audio ->
|
||||||
|
acc ++ [:embed_subs]
|
||||||
|
|
||||||
|
{{:sub_langs, sub_langs}, %{download_subs: true}} ->
|
||||||
|
acc ++ [sub_langs: sub_langs]
|
||||||
|
|
||||||
|
{{:sub_langs, sub_langs}, %{embed_subs: true}} ->
|
||||||
|
acc ++ [sub_langs: sub_langs]
|
||||||
|
|
||||||
|
_ ->
|
||||||
|
acc
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp thumbnail_options(media_item_with_preloads) do
|
||||||
|
media_profile = media_item_with_preloads.source.media_profile
|
||||||
|
mapped_struct = Map.from_struct(media_profile)
|
||||||
|
|
||||||
|
Enum.reduce(mapped_struct, [], fn attr, acc ->
|
||||||
|
case attr do
|
||||||
|
{:download_thumbnail, true} ->
|
||||||
|
thumbnail_save_location = determine_thumbnail_location(media_item_with_preloads)
|
||||||
|
|
||||||
|
acc ++ [:write_thumbnail, convert_thumbnail: "jpg", output: "thumbnail:#{thumbnail_save_location}"]
|
||||||
|
|
||||||
|
{:embed_thumbnail, true} ->
|
||||||
|
acc ++ [:embed_thumbnail, convert_thumbnail: "jpg"]
|
||||||
|
|
||||||
|
_ ->
|
||||||
|
acc
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp metadata_options(media_profile) do
|
||||||
|
mapped_struct = Map.from_struct(media_profile)
|
||||||
|
|
||||||
|
Enum.reduce(mapped_struct, [], fn attr, acc ->
|
||||||
|
case attr do
|
||||||
|
{:download_metadata, true} -> acc ++ [:write_info_json, :clean_info_json]
|
||||||
|
{:embed_metadata, true} -> acc ++ [:embed_metadata]
|
||||||
|
_ -> acc
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp quality_options(media_profile) do
|
||||||
|
video_codec_options = "+codec:avc:m4a"
|
||||||
|
|
||||||
|
case media_profile.preferred_resolution do
|
||||||
|
# Also be aware that :audio disabled all embedding options for subtitles
|
||||||
|
:audio -> [:extract_audio, format: "bestaudio[ext=m4a]"]
|
||||||
|
:"360p" -> [format_sort: "res:360,#{video_codec_options}"]
|
||||||
|
:"480p" -> [format_sort: "res:480,#{video_codec_options}"]
|
||||||
|
:"720p" -> [format_sort: "res:720,#{video_codec_options}"]
|
||||||
|
:"1080p" -> [format_sort: "res:1080,#{video_codec_options}"]
|
||||||
|
:"2160p" -> [format_sort: "res:2160,#{video_codec_options}"]
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp output_options(media_item_with_preloads) do
|
||||||
|
[
|
||||||
|
output: build_output_path_for(media_item_with_preloads.source)
|
||||||
|
]
|
||||||
|
end
|
||||||
|
|
||||||
|
defp build_output_path(string, source) do
|
||||||
|
additional_options_map = output_options_map(source)
|
||||||
|
{:ok, output_path} = OutputPathBuilder.build(string, additional_options_map)
|
||||||
|
|
||||||
|
Path.join(base_directory(), output_path)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp output_options_map(source) do
|
||||||
|
%{
|
||||||
|
"source_custom_name" => source.custom_name,
|
||||||
|
"source_collection_type" => source.collection_type
|
||||||
|
}
|
||||||
|
end
|
||||||
|
|
||||||
|
# I don't love the string manipulation here, but what can ya' do.
|
||||||
|
# It's dependent on the output_path_template being a string ending `.{{ ext }}`
|
||||||
|
# (or equivalent), but that's validated by the MediaProfile schema.
|
||||||
|
defp determine_thumbnail_location(media_item_with_preloads) do
|
||||||
|
output_path_template = media_item_with_preloads.source.media_profile.output_path_template
|
||||||
|
|
||||||
|
output_path_template
|
||||||
|
|> String.split(~r{\.}, include_captures: true)
|
||||||
|
|> List.insert_at(-3, "-thumb")
|
||||||
|
|> Enum.join()
|
||||||
|
|> build_output_path(media_item_with_preloads.source)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp base_directory do
|
||||||
|
Application.get_env(:pinchflat, :media_directory)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,46 @@
|
|||||||
|
defmodule Pinchflat.Downloading.DownloadingHelpers do
|
||||||
|
@moduledoc """
|
||||||
|
Methods for helping download media
|
||||||
|
|
||||||
|
Many of these methods are made to be kickoff or be consumed by workers.
|
||||||
|
"""
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias Pinchflat.Media
|
||||||
|
alias Pinchflat.Tasks
|
||||||
|
alias Pinchflat.Sources.Source
|
||||||
|
alias Pinchflat.Downloading.MediaDownloadWorker
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Starts tasks for downloading media for any of a sources _pending_ media items.
|
||||||
|
Jobs are not enqueued if the source is set to not download media. This will return :ok.
|
||||||
|
|
||||||
|
NOTE: this starts a download for each media item that is pending,
|
||||||
|
not just the ones that were indexed in this job run. This should ensure
|
||||||
|
that any stragglers are caught if, for some reason, they weren't enqueued
|
||||||
|
or somehow got de-queued.
|
||||||
|
|
||||||
|
Returns :ok
|
||||||
|
"""
|
||||||
|
def enqueue_pending_download_tasks(%Source{download_media: true} = source) do
|
||||||
|
source
|
||||||
|
|> Media.list_pending_media_items_for()
|
||||||
|
|> Enum.each(&MediaDownloadWorker.kickoff_with_task/1)
|
||||||
|
end
|
||||||
|
|
||||||
|
def enqueue_pending_download_tasks(%Source{download_media: false}) do
|
||||||
|
:ok
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Deletes ALL pending tasks for a source's media items.
|
||||||
|
|
||||||
|
Returns :ok
|
||||||
|
"""
|
||||||
|
def dequeue_pending_download_tasks(%Source{} = source) do
|
||||||
|
source
|
||||||
|
|> Media.list_pending_media_items_for()
|
||||||
|
|> Enum.each(&Tasks.delete_pending_tasks_for/1)
|
||||||
|
end
|
||||||
|
end
|
||||||
+32
-16
@@ -1,4 +1,4 @@
|
|||||||
defmodule Pinchflat.Workers.MediaDownloadWorker do
|
defmodule Pinchflat.Downloading.MediaDownloadWorker do
|
||||||
@moduledoc false
|
@moduledoc false
|
||||||
|
|
||||||
use Oban.Worker,
|
use Oban.Worker,
|
||||||
@@ -6,19 +6,32 @@ defmodule Pinchflat.Workers.MediaDownloadWorker do
|
|||||||
unique: [period: :infinity, states: [:available, :scheduled, :retryable, :executing]],
|
unique: [period: :infinity, states: [:available, :scheduled, :retryable, :executing]],
|
||||||
tags: ["media_item", "media_fetching"]
|
tags: ["media_item", "media_fetching"]
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias __MODULE__
|
||||||
|
alias Pinchflat.Tasks
|
||||||
alias Pinchflat.Repo
|
alias Pinchflat.Repo
|
||||||
alias Pinchflat.Media
|
alias Pinchflat.Media
|
||||||
alias Pinchflat.Tasks
|
alias Pinchflat.Downloading.MediaDownloader
|
||||||
alias Pinchflat.MediaClient.MediaDownloader
|
|
||||||
alias Pinchflat.Workers.FilesystemDataWorker
|
@doc """
|
||||||
|
Starts the media_item media download worker and creates a task for the media_item.
|
||||||
|
|
||||||
|
Returns {:ok, %Task{}} | {:error, :duplicate_job} | {:error, %Ecto.Changeset{}}
|
||||||
|
"""
|
||||||
|
def kickoff_with_task(media_item, opts \\ []) do
|
||||||
|
%{id: media_item.id}
|
||||||
|
|> MediaDownloadWorker.new(opts)
|
||||||
|
|> Tasks.create_job_with_task(media_item)
|
||||||
|
end
|
||||||
|
|
||||||
@impl Oban.Worker
|
|
||||||
@doc """
|
@doc """
|
||||||
For a given media item, download the media alongside any options.
|
For a given media item, download the media alongside any options.
|
||||||
Does not download media if its source is set to not download media.
|
Does not download media if its source is set to not download media.
|
||||||
|
|
||||||
Returns :ok | {:ok, %MediaItem{}} | {:error, any, ...any}
|
Returns :ok | {:ok, %MediaItem{}} | {:error, any, ...any}
|
||||||
"""
|
"""
|
||||||
|
@impl Oban.Worker
|
||||||
def perform(%Oban.Job{args: %{"id" => media_item_id}}) do
|
def perform(%Oban.Job{args: %{"id" => media_item_id}}) do
|
||||||
media_item =
|
media_item =
|
||||||
media_item_id
|
media_item_id
|
||||||
@@ -31,27 +44,30 @@ defmodule Pinchflat.Workers.MediaDownloadWorker do
|
|||||||
else
|
else
|
||||||
:ok
|
:ok
|
||||||
end
|
end
|
||||||
|
rescue
|
||||||
|
Ecto.NoResultsError -> Logger.info("#{__MODULE__} discarded: media item #{media_item_id} not found")
|
||||||
|
Ecto.StaleEntryError -> Logger.info("#{__MODULE__} discarded: media item #{media_item_id} stale")
|
||||||
end
|
end
|
||||||
|
|
||||||
defp download_media_and_schedule_jobs(media_item) do
|
defp download_media_and_schedule_jobs(media_item) do
|
||||||
case MediaDownloader.download_for_media_item(media_item) do
|
case MediaDownloader.download_for_media_item(media_item) do
|
||||||
{:ok, _} ->
|
{:ok, updated_media_item} ->
|
||||||
schedule_filesystem_data_worker(media_item)
|
compute_and_save_media_filesize(updated_media_item)
|
||||||
{:ok, media_item}
|
|
||||||
|
{:ok, updated_media_item}
|
||||||
|
|
||||||
err ->
|
err ->
|
||||||
err
|
err
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
defp schedule_filesystem_data_worker(media_item) do
|
defp compute_and_save_media_filesize(media_item) do
|
||||||
media_item
|
case File.stat(media_item.media_filepath) do
|
||||||
|> Map.take([:id])
|
{:ok, %{size: size}} ->
|
||||||
|> FilesystemDataWorker.new()
|
Media.update_media_item(media_item, %{media_size_bytes: size})
|
||||||
|> Tasks.create_job_with_task(media_item)
|
|
||||||
|> case do
|
_ ->
|
||||||
{:ok, task} -> {:ok, task}
|
:ok
|
||||||
{:error, :duplicate_job} -> {:ok, :job_exists}
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -0,0 +1,72 @@
|
|||||||
|
defmodule Pinchflat.Downloading.MediaDownloader do
|
||||||
|
@moduledoc """
|
||||||
|
This is the integration layer for actually downloading media.
|
||||||
|
It takes into account the media profile's settings in order
|
||||||
|
to download the media with the desired options.
|
||||||
|
"""
|
||||||
|
|
||||||
|
alias Pinchflat.Repo
|
||||||
|
alias Pinchflat.Media
|
||||||
|
alias Pinchflat.Media.MediaItem
|
||||||
|
alias Pinchflat.Metadata.NfoBuilder
|
||||||
|
alias Pinchflat.Metadata.MetadataParser
|
||||||
|
alias Pinchflat.Metadata.MetadataFileHelpers
|
||||||
|
alias Pinchflat.Downloading.DownloadOptionBuilder
|
||||||
|
|
||||||
|
alias Pinchflat.YtDlp.Media, as: YtDlpMedia
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Downloads media for a media item, updating the media item based on the metadata
|
||||||
|
returned by yt-dlp. Also saves the entire metadata response to the associated
|
||||||
|
media_metadata record.
|
||||||
|
|
||||||
|
NOTE: related methods (like the download worker) won't download if the media item's source
|
||||||
|
is set to not download media. However, I'm not enforcing that here since I need this for testing.
|
||||||
|
This may change in the future but I'm not stressed.
|
||||||
|
|
||||||
|
Returns {:ok, %MediaItem{}} | {:error, any, ...any}
|
||||||
|
"""
|
||||||
|
def download_for_media_item(%MediaItem{} = media_item) do
|
||||||
|
item_with_preloads = Repo.preload(media_item, [:metadata, source: :media_profile])
|
||||||
|
|
||||||
|
case download_with_options(media_item.original_url, item_with_preloads) do
|
||||||
|
{:ok, parsed_json} ->
|
||||||
|
parsed_attrs =
|
||||||
|
parsed_json
|
||||||
|
|> MetadataParser.parse_for_media_item()
|
||||||
|
|> Map.merge(%{
|
||||||
|
media_downloaded_at: DateTime.utc_now(),
|
||||||
|
nfo_filepath: determine_nfo_filepath(item_with_preloads, parsed_json),
|
||||||
|
metadata: %{
|
||||||
|
# IDEA: might be worth kicking off a job for this since thumbnail fetching
|
||||||
|
# could fail and I want to handle that in isolation
|
||||||
|
metadata_filepath: MetadataFileHelpers.compress_and_store_metadata_for(media_item, parsed_json),
|
||||||
|
thumbnail_filepath: MetadataFileHelpers.download_and_store_thumbnail_for(media_item, parsed_json)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
# Don't forgor to use preloaded associations or updates to
|
||||||
|
# associations won't work!
|
||||||
|
Media.update_media_item(item_with_preloads, parsed_attrs)
|
||||||
|
|
||||||
|
err ->
|
||||||
|
err
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp determine_nfo_filepath(media_item, parsed_json) do
|
||||||
|
if media_item.source.media_profile.download_nfo do
|
||||||
|
filepath = Path.rootname(parsed_json["filepath"]) <> ".nfo"
|
||||||
|
|
||||||
|
NfoBuilder.build_and_store_for_media_item(filepath, parsed_json)
|
||||||
|
else
|
||||||
|
nil
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp download_with_options(url, item_with_preloads) do
|
||||||
|
{:ok, options} = DownloadOptionBuilder.build(item_with_preloads)
|
||||||
|
|
||||||
|
YtDlpMedia.download(url, options)
|
||||||
|
end
|
||||||
|
end
|
||||||
+2
-2
@@ -1,4 +1,4 @@
|
|||||||
defmodule Pinchflat.RenderedString.Base do
|
defmodule Pinchflat.Downloading.OutputPath.Base do
|
||||||
@moduledoc """
|
@moduledoc """
|
||||||
A base module for parsing rendered strings, designed as a macro to be used
|
A base module for parsing rendered strings, designed as a macro to be used
|
||||||
in other modules. See https://elixirforum.com/t/help-to-parse-a-template-with-nimbleparsec/47980
|
in other modules. See https://elixirforum.com/t/help-to-parse-a-template-with-nimbleparsec/47980
|
||||||
@@ -6,7 +6,7 @@ defmodule Pinchflat.RenderedString.Base do
|
|||||||
NOTE: if the needs here get any more complicated, look into using a Liquid
|
NOTE: if the needs here get any more complicated, look into using a Liquid
|
||||||
template parser. No need to reinvent the wheel any more than I already have.
|
template parser. No need to reinvent the wheel any more than I already have.
|
||||||
|
|
||||||
NOTE: this is effectively tested by the `Pinchflat.RenderedString.Parser`'s tests
|
NOTE: this is effectively tested by the `Pinchflat.Downloading.OutputPath.Parser`'s tests
|
||||||
"""
|
"""
|
||||||
|
|
||||||
defmacro __using__(_opts) do
|
defmacro __using__(_opts) do
|
||||||
+2
-2
@@ -1,11 +1,11 @@
|
|||||||
defmodule Pinchflat.RenderedString.Parser do
|
defmodule Pinchflat.Downloading.OutputPath.Parser do
|
||||||
@moduledoc """
|
@moduledoc """
|
||||||
Parses liquid-ish-style strings into a rendered string
|
Parses liquid-ish-style strings into a rendered string
|
||||||
|
|
||||||
Used for turning filepath templates into real filepaths
|
Used for turning filepath templates into real filepaths
|
||||||
"""
|
"""
|
||||||
|
|
||||||
use Pinchflat.RenderedString.Base
|
use Pinchflat.Downloading.OutputPath.Base
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Parses a string into a rendered string, using the provided variables. Optionally
|
Parses a string into a rendered string, using the provided variables. Optionally
|
||||||
+6
-5
@@ -1,11 +1,9 @@
|
|||||||
defmodule Pinchflat.Profiles.Options.YtDlp.OutputPathBuilder do
|
defmodule Pinchflat.Downloading.OutputPathBuilder do
|
||||||
@moduledoc """
|
@moduledoc """
|
||||||
Builds yt-dlp-friendly output paths for downloaded media
|
Builds yt-dlp-friendly output paths for downloaded media
|
||||||
|
|
||||||
IDEA: consider making this a behaviour so I can add other backends later
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
alias Pinchflat.RenderedString.Parser, as: TemplateParser
|
alias Pinchflat.Downloading.OutputPath.Parser, as: TemplateParser
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Builds the actual final filepath from a given template. Optionally, you can pass in
|
Builds the actual final filepath from a given template. Optionally, you can pass in
|
||||||
@@ -41,7 +39,10 @@ defmodule Pinchflat.Profiles.Options.YtDlp.OutputPathBuilder do
|
|||||||
# Individual parts of the upload date
|
# Individual parts of the upload date
|
||||||
"upload_year" => "%(upload_date>%Y)S",
|
"upload_year" => "%(upload_date>%Y)S",
|
||||||
"upload_month" => "%(upload_date>%m)S",
|
"upload_month" => "%(upload_date>%m)S",
|
||||||
"upload_day" => "%(upload_date>%d)S"
|
"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"
|
||||||
}
|
}
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -0,0 +1,69 @@
|
|||||||
|
defmodule Pinchflat.FastIndexing.FastIndexingHelpers do
|
||||||
|
@moduledoc """
|
||||||
|
Methods for performing fast indexing tasks and managing the fast indexing process.
|
||||||
|
|
||||||
|
Many of these methods are made to be kickoff or be consumed by workers.
|
||||||
|
"""
|
||||||
|
|
||||||
|
alias Pinchflat.Media
|
||||||
|
alias Pinchflat.Sources.Source
|
||||||
|
alias Pinchflat.FastIndexing.YoutubeRss
|
||||||
|
alias Pinchflat.Downloading.MediaDownloadWorker
|
||||||
|
alias Pinchflat.FastIndexing.MediaIndexingWorker
|
||||||
|
|
||||||
|
alias Pinchflat.YtDlp.Media, as: YtDlpMedia
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Fetches new media IDs from a source's YouTube RSS feed and kicks off indexing tasks
|
||||||
|
for any new media items. See comments in `MediaIndexingWorker` for more info on the
|
||||||
|
order of operations and how this fits into the indexing process.
|
||||||
|
|
||||||
|
Despite the similar name to `kickoff_fast_indexing_task`, this does work differently.
|
||||||
|
`kickoff_fast_indexing_task` starts a task that _calls_ this function whereas this
|
||||||
|
function starts individual indexing tasks for each new media item. I think it does
|
||||||
|
make sense grammatically, but I could see how that's confusing.
|
||||||
|
|
||||||
|
Returns :ok
|
||||||
|
"""
|
||||||
|
def kickoff_indexing_tasks_from_youtube_rss_feed(%Source{} = source) do
|
||||||
|
{:ok, media_ids} = YoutubeRss.get_recent_media_ids_from_rss(source)
|
||||||
|
existing_media_items = Media.list_media_items_by_media_id_for(source, media_ids)
|
||||||
|
new_media_ids = media_ids -- Enum.map(existing_media_items, & &1.media_id)
|
||||||
|
|
||||||
|
Enum.each(new_media_ids, fn media_id ->
|
||||||
|
url = "https://www.youtube.com/watch?v=#{media_id}"
|
||||||
|
|
||||||
|
MediaIndexingWorker.kickoff_with_task(source, url)
|
||||||
|
end)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Indexes a single media item for a source and enqueues a download job if the
|
||||||
|
media should be downloaded. This method creates the media item record so it's
|
||||||
|
the one-stop-shop for adding a media item (and possibly downloading it) just
|
||||||
|
by a URL and source.
|
||||||
|
|
||||||
|
Returns {:ok, media_item} | {:error, any()}
|
||||||
|
"""
|
||||||
|
def index_and_enqueue_download_for_media_item(%Source{} = source, url) do
|
||||||
|
maybe_media_item = create_media_item_from_url(source, url)
|
||||||
|
|
||||||
|
case maybe_media_item do
|
||||||
|
{:ok, media_item} ->
|
||||||
|
if source.download_media && Media.pending_download?(media_item) do
|
||||||
|
MediaDownloadWorker.kickoff_with_task(media_item)
|
||||||
|
end
|
||||||
|
|
||||||
|
{:ok, media_item}
|
||||||
|
|
||||||
|
err ->
|
||||||
|
err
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp create_media_item_from_url(source, url) do
|
||||||
|
{:ok, media_attrs} = YtDlpMedia.get_media_attributes(url)
|
||||||
|
|
||||||
|
Media.create_media_item_from_backend_attrs(source, media_attrs)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,59 @@
|
|||||||
|
defmodule Pinchflat.FastIndexing.FastIndexingWorker do
|
||||||
|
@moduledoc false
|
||||||
|
|
||||||
|
use Oban.Worker,
|
||||||
|
queue: :fast_indexing,
|
||||||
|
unique: [period: :infinity, states: [:available, :scheduled, :retryable]],
|
||||||
|
tags: ["media_source", "fast_indexing"]
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias __MODULE__
|
||||||
|
alias Pinchflat.Tasks
|
||||||
|
alias Pinchflat.Sources
|
||||||
|
alias Pinchflat.Sources.Source
|
||||||
|
alias Pinchflat.FastIndexing.FastIndexingHelpers
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Starts the source fast indexing worker and creates a task for the source.
|
||||||
|
|
||||||
|
Returns {:ok, %Task{}} | {:error, :duplicate_job} | {:error, %Ecto.Changeset{}}
|
||||||
|
"""
|
||||||
|
def kickoff_with_task(source, opts \\ []) do
|
||||||
|
%{id: source.id}
|
||||||
|
|> FastIndexingWorker.new(opts)
|
||||||
|
|> Tasks.create_job_with_task(source)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Kicks off the fast indexing process for a source, reschedules the job to run again
|
||||||
|
once complete. See `MediaCollectionIndexingWorker` and `MediaIndexingWorker` comments
|
||||||
|
for more
|
||||||
|
|
||||||
|
Returns :ok | {:ok, :job_exists} | {:ok, %Task{}}
|
||||||
|
"""
|
||||||
|
@impl Oban.Worker
|
||||||
|
def perform(%Oban.Job{args: %{"id" => source_id}}) do
|
||||||
|
source = Sources.get_source!(source_id)
|
||||||
|
|
||||||
|
if source.fast_index do
|
||||||
|
FastIndexingHelpers.kickoff_indexing_tasks_from_youtube_rss_feed(source)
|
||||||
|
|
||||||
|
reschedule_indexing(source)
|
||||||
|
else
|
||||||
|
:ok
|
||||||
|
end
|
||||||
|
rescue
|
||||||
|
Ecto.NoResultsError -> Logger.info("#{__MODULE__} discarded: source #{source_id} not found")
|
||||||
|
Ecto.StaleEntryError -> Logger.info("#{__MODULE__} discarded: source #{source_id} stale")
|
||||||
|
end
|
||||||
|
|
||||||
|
defp reschedule_indexing(source) do
|
||||||
|
next_run_in = Source.fast_index_frequency() * 60
|
||||||
|
|
||||||
|
case kickoff_with_task(source, schedule_in: next_run_in) do
|
||||||
|
{:ok, task} -> {:ok, task}
|
||||||
|
{:error, :duplicate_job} -> {:ok, :job_exists}
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,69 @@
|
|||||||
|
defmodule Pinchflat.FastIndexing.MediaIndexingWorker do
|
||||||
|
@moduledoc false
|
||||||
|
|
||||||
|
use Oban.Worker,
|
||||||
|
queue: :media_indexing,
|
||||||
|
unique: [period: :infinity, states: [:available, :scheduled, :retryable]],
|
||||||
|
tags: ["media_source", "media_indexing"]
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias __MODULE__
|
||||||
|
alias Pinchflat.Tasks
|
||||||
|
alias Pinchflat.Sources
|
||||||
|
alias Pinchflat.FastIndexing.FastIndexingHelpers
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Starts the fast media indexing worker and creates a task for the source.
|
||||||
|
|
||||||
|
Returns {:ok, %Task{}} | {:error, :duplicate_job} | {:error, %Ecto.Changeset{}}
|
||||||
|
"""
|
||||||
|
def kickoff_with_task(source, media_url, opts \\ []) do
|
||||||
|
%{id: source.id, media_url: media_url}
|
||||||
|
|> MediaIndexingWorker.new(opts)
|
||||||
|
|> Tasks.create_job_with_task(source)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Similar to `MediaCollectionIndexingWorker`, but for individual media items.
|
||||||
|
Does not reschedule or check anything to do with a source's indexing
|
||||||
|
frequency - only collects initial metadata then kicks off a download.
|
||||||
|
`MediaCollectionIndexingWorker` should be preferred in general, but this is
|
||||||
|
useful for downloading one-off media items based on a URL (like for fast indexing).
|
||||||
|
|
||||||
|
Only downloads media that _should_ be downloaded (ie: the source is set to download
|
||||||
|
and the media matches the profile's format preferences)
|
||||||
|
|
||||||
|
Order of operations:
|
||||||
|
1. FastIndexingHelpers.kickoff_indexing_tasks_from_youtube_rss_feed/1 (which is running
|
||||||
|
in its own worker) periodically checks the YouTube RSS feed for new media
|
||||||
|
2. If new media is found, it enqueues a MediaIndexingWorker (this module) for each new media
|
||||||
|
item
|
||||||
|
3. This worker fetches the media metadata and uses that to determine if it should be
|
||||||
|
downloaded. If so, it enqueues a MediaDownloadWorker
|
||||||
|
|
||||||
|
Each is a worker because they all either need to be scheduled periodically or call out to
|
||||||
|
an external service and will be long-running. They're split into different jobs to separate
|
||||||
|
retry logic for each step and allow us to better optimize various queues (eg: the indexing
|
||||||
|
steps can keep running while the slow download steps are worked through).
|
||||||
|
|
||||||
|
Returns :ok
|
||||||
|
"""
|
||||||
|
@impl Oban.Worker
|
||||||
|
def perform(%Oban.Job{args: %{"id" => source_id, "media_url" => media_url}}) do
|
||||||
|
source = Sources.get_source!(source_id)
|
||||||
|
|
||||||
|
case FastIndexingHelpers.index_and_enqueue_download_for_media_item(source, media_url) do
|
||||||
|
{:ok, media_item} ->
|
||||||
|
Logger.debug("Indexed and enqueued download for url: #{media_url} (media item: #{media_item.id})")
|
||||||
|
|
||||||
|
{:error, reason} ->
|
||||||
|
Logger.debug("Failed to index and enqueue download for url: #{media_url} (reason: #{inspect(reason)})")
|
||||||
|
end
|
||||||
|
|
||||||
|
:ok
|
||||||
|
rescue
|
||||||
|
Ecto.NoResultsError -> Logger.info("#{__MODULE__} discarded: source #{source_id} not found")
|
||||||
|
Ecto.StaleEntryError -> Logger.info("#{__MODULE__} discarded: source #{source_id} stale")
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,51 @@
|
|||||||
|
defmodule Pinchflat.FastIndexing.YoutubeRss do
|
||||||
|
@moduledoc """
|
||||||
|
Methods for interacting with YouTube RSS feeds
|
||||||
|
"""
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias Pinchflat.Sources.Source
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Fetches the recent media IDs from a YouTube RSS feed for a given source.
|
||||||
|
|
||||||
|
Returns {:ok, [binary()]} | {:error, binary()}
|
||||||
|
"""
|
||||||
|
def get_recent_media_ids_from_rss(%Source{} = source) do
|
||||||
|
Logger.debug("Fetching recent media IDs from YouTube RSS feed for source: #{source.collection_id}")
|
||||||
|
|
||||||
|
case http_client().get(rss_url_for_source(source)) do
|
||||||
|
{:ok, response} ->
|
||||||
|
response = to_string(response)
|
||||||
|
media_id_regex = ~r/<yt:videoId>(.*?)<\/yt:videoId>/
|
||||||
|
|
||||||
|
# Don't get on me about using regex to search XML.
|
||||||
|
# The content is known, well-formed, and simple.
|
||||||
|
media_ids =
|
||||||
|
media_id_regex
|
||||||
|
|> Regex.scan(response)
|
||||||
|
|> Enum.map(fn [_, id] -> String.trim(id) end)
|
||||||
|
|> Enum.filter(&(String.length(&1) > 0))
|
||||||
|
|> Enum.uniq()
|
||||||
|
|
||||||
|
Logger.debug("Media ids fetched from RSS: #{inspect(media_ids)}")
|
||||||
|
|
||||||
|
{:ok, media_ids}
|
||||||
|
|
||||||
|
{:error, _reason} ->
|
||||||
|
{:error, "Failed to fetch RSS feed"}
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp rss_url_for_source(source) do
|
||||||
|
case source.collection_type do
|
||||||
|
:channel -> "https://www.youtube.com/feeds/videos.xml?channel_id=#{source.collection_id}"
|
||||||
|
:playlist -> "https://www.youtube.com/feeds/videos.xml?playlist_id=#{source.collection_id}"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp http_client do
|
||||||
|
Application.get_env(:pinchflat, :http_client, Pinchflat.HTTP.HTTPClient)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,107 @@
|
|||||||
|
defmodule Pinchflat.Filesystem.FilesystemHelpers do
|
||||||
|
@moduledoc """
|
||||||
|
Utility methods for working with the filesystem
|
||||||
|
"""
|
||||||
|
alias Pinchflat.Media
|
||||||
|
alias Pinchflat.Utils.StringUtils
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Generates a temporary file and returns its path. The file is empty and has the given type.
|
||||||
|
Generates all the directories in the path if they don't exist.
|
||||||
|
|
||||||
|
Returns binary()
|
||||||
|
"""
|
||||||
|
def generate_metadata_tmpfile(type) do
|
||||||
|
tmpfile_directory = Application.get_env(:pinchflat, :tmpfile_directory)
|
||||||
|
filepath = Path.join([tmpfile_directory, "#{StringUtils.random_string(64)}.#{type}"])
|
||||||
|
|
||||||
|
:ok = write_p!(filepath, "")
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
Returns :ok | raises on error
|
||||||
|
"""
|
||||||
|
def write_p!(filepath, content, modes \\ []) do
|
||||||
|
:ok = write_p(filepath, content, modes)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Copies a file from source to destination, creating directories as needed.
|
||||||
|
|
||||||
|
Returns :ok | raises on error
|
||||||
|
"""
|
||||||
|
def cp_p!(source, destination) do
|
||||||
|
destination
|
||||||
|
|> Path.dirname()
|
||||||
|
|> File.mkdir_p!()
|
||||||
|
|
||||||
|
File.cp!(source, destination)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Fetches the file size of a media item and saves it to the database.
|
||||||
|
|
||||||
|
Returns {:ok, media_item} | {:error, any()}
|
||||||
|
"""
|
||||||
|
def compute_and_save_media_filesize(media_item) do
|
||||||
|
case File.stat(media_item.media_filepath) do
|
||||||
|
{:ok, %{size: size}} ->
|
||||||
|
Media.update_media_item(media_item, %{media_size_bytes: size})
|
||||||
|
|
||||||
|
err ->
|
||||||
|
err
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Deletes a file and removes any empty directories in the path.
|
||||||
|
Does NOT remove any directories that are not empty.
|
||||||
|
|
||||||
|
Returns :ok | {:error, any()}
|
||||||
|
"""
|
||||||
|
def delete_file_and_remove_empty_directories(filepath) do
|
||||||
|
case File.rm(filepath) do
|
||||||
|
:ok ->
|
||||||
|
filepath
|
||||||
|
|> Path.dirname()
|
||||||
|
|> recursively_delete_empty_directories()
|
||||||
|
|
||||||
|
err ->
|
||||||
|
err
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp recursively_delete_empty_directories(directory) do
|
||||||
|
case File.rmdir(directory) do
|
||||||
|
:ok ->
|
||||||
|
directory
|
||||||
|
|> Path.dirname()
|
||||||
|
|> recursively_delete_empty_directories()
|
||||||
|
|
||||||
|
err ->
|
||||||
|
err
|
||||||
|
end
|
||||||
|
|
||||||
|
:ok
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -4,5 +4,7 @@ defmodule Pinchflat.HTTP.HTTPBehaviour do
|
|||||||
so I can use Mox to create an HTTP mock
|
so I can use Mox to create an HTTP mock
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
@callback get(String.t()) :: {:ok, String.t()} | {:error, String.t()}
|
||||||
|
@callback get(String.t(), Keyword.t()) :: {:ok, String.t()} | {:error, String.t()}
|
||||||
@callback get(String.t(), Keyword.t(), Keyword.t()) :: {:ok, String.t()} | {:error, String.t()}
|
@callback get(String.t(), Keyword.t(), Keyword.t()) :: {:ok, String.t()} | {:error, String.t()}
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -7,9 +7,10 @@ defmodule Pinchflat.Media do
|
|||||||
|
|
||||||
alias Pinchflat.Repo
|
alias Pinchflat.Repo
|
||||||
alias Pinchflat.Tasks
|
alias Pinchflat.Tasks
|
||||||
alias Pinchflat.Media.MediaItem
|
|
||||||
alias Pinchflat.Sources.Source
|
alias Pinchflat.Sources.Source
|
||||||
alias Pinchflat.Media.MediaMetadata
|
alias Pinchflat.Media.MediaItem
|
||||||
|
alias Pinchflat.Metadata.MediaMetadata
|
||||||
|
alias Pinchflat.Filesystem.FilesystemHelpers
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Returns the list of media_items.
|
Returns the list of media_items.
|
||||||
@@ -31,6 +32,22 @@ defmodule Pinchflat.Media do
|
|||||||
|> Repo.all()
|
|> Repo.all()
|
||||||
end
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Fetches all media items belonging to a given source that have a media_id in the given list.
|
||||||
|
Useful for determining the what media items we DON'T already have for fast indexing.
|
||||||
|
|
||||||
|
NOTE: These queries are getting a little tedious. When I have the time, I should see about
|
||||||
|
implementing a query pattern and having these compose queries from a common base. This would
|
||||||
|
also let me compose simple queries in the module using them for one-off methods
|
||||||
|
|
||||||
|
Returns [%MediaItem{}, ...].
|
||||||
|
"""
|
||||||
|
def list_media_items_by_media_id_for(%Source{} = source, media_ids) do
|
||||||
|
MediaItem
|
||||||
|
|> where([mi], mi.source_id == ^source.id and mi.media_id in ^media_ids)
|
||||||
|
|> Repo.all()
|
||||||
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Returns a list of pending media_items for a given source, where
|
Returns a list of pending media_items for a given source, where
|
||||||
pending means the `media_filepath` is `nil` AND the media_item
|
pending means the `media_filepath` is `nil` AND the media_item
|
||||||
@@ -48,6 +65,8 @@ defmodule Pinchflat.Media do
|
|||||||
MediaItem
|
MediaItem
|
||||||
|> where([mi], mi.source_id == ^source.id and is_nil(mi.media_filepath))
|
|> where([mi], mi.source_id == ^source.id and is_nil(mi.media_filepath))
|
||||||
|> where(^build_format_clauses(media_profile))
|
|> where(^build_format_clauses(media_profile))
|
||||||
|
|> where(^maybe_apply_cutoff_date(source))
|
||||||
|
|> where(^maybe_apply_title_regex(source))
|
||||||
|> Repo.maybe_limit(limit)
|
|> Repo.maybe_limit(limit)
|
||||||
|> Repo.all()
|
|> Repo.all()
|
||||||
end
|
end
|
||||||
@@ -76,11 +95,12 @@ defmodule Pinchflat.Media do
|
|||||||
Returns boolean()
|
Returns boolean()
|
||||||
"""
|
"""
|
||||||
def pending_download?(%MediaItem{} = media_item) do
|
def pending_download?(%MediaItem{} = media_item) do
|
||||||
media_profile = Repo.preload(media_item, source: :media_profile).source.media_profile
|
media_item = Repo.preload(media_item, source: :media_profile)
|
||||||
|
|
||||||
MediaItem
|
MediaItem
|
||||||
|> where([mi], mi.id == ^media_item.id and is_nil(mi.media_filepath))
|
|> where([mi], mi.id == ^media_item.id and is_nil(mi.media_filepath))
|
||||||
|> where(^build_format_clauses(media_profile))
|
|> where(^build_format_clauses(media_item.source.media_profile))
|
||||||
|
|> where(^maybe_apply_cutoff_date(media_item.source))
|
||||||
|> Repo.exists?()
|
|> Repo.exists?()
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -124,39 +144,9 @@ defmodule Pinchflat.Media do
|
|||||||
def get_media_item!(id), do: Repo.get!(MediaItem, id)
|
def get_media_item!(id), do: Repo.get!(MediaItem, id)
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Produces a flat list of the filesystem paths for a media_item's downloaded files
|
Creates a media_item.
|
||||||
|
|
||||||
Returns [binary()]
|
Returns {:ok, %MediaItem{}} | {:error, %Ecto.Changeset{}}
|
||||||
"""
|
|
||||||
def media_filepaths(media_item) do
|
|
||||||
mapped_struct = Map.from_struct(media_item)
|
|
||||||
|
|
||||||
MediaItem.filepath_attributes()
|
|
||||||
|> Enum.map(fn
|
|
||||||
:subtitle_filepaths = field -> Enum.map(mapped_struct[field], fn [_, filepath] -> filepath end)
|
|
||||||
field -> List.wrap(mapped_struct[field])
|
|
||||||
end)
|
|
||||||
|> List.flatten()
|
|
||||||
|> Enum.filter(&is_binary/1)
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Produces a flat list of the filesystem paths for a media_item's metadata files.
|
|
||||||
Returns an empty list if the media_item has no metadata.
|
|
||||||
|
|
||||||
Returns [binary()] | []
|
|
||||||
"""
|
|
||||||
def metadata_filepaths(media_item) do
|
|
||||||
metadata = Repo.preload(media_item, :metadata).metadata || %MediaMetadata{}
|
|
||||||
mapped_struct = Map.from_struct(metadata)
|
|
||||||
|
|
||||||
MediaMetadata.filepath_attributes()
|
|
||||||
|> Enum.map(fn field -> mapped_struct[field] end)
|
|
||||||
|> Enum.filter(&is_binary/1)
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Creates a media_item. Returns {:ok, %MediaItem{}} | {:error, %Ecto.Changeset{}}.
|
|
||||||
"""
|
"""
|
||||||
def create_media_item(attrs) do
|
def create_media_item(attrs) do
|
||||||
%MediaItem{}
|
%MediaItem{}
|
||||||
@@ -165,7 +155,32 @@ defmodule Pinchflat.Media do
|
|||||||
end
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Updates a media_item. Returns {:ok, %MediaItem{}} | {:error, %Ecto.Changeset{}}.
|
Creates a media item from the attributes returned by the video backend
|
||||||
|
(read: yt-dlp).
|
||||||
|
|
||||||
|
Unlike `create_media_item`, this will attempt an update if the media_item
|
||||||
|
already exists. This is so that future indexing can pick up attributes that
|
||||||
|
we may not have asked for in the past (eg: upload_date)
|
||||||
|
|
||||||
|
Returns {:ok, %MediaItem{}} | {:error, %Ecto.Changeset{}}
|
||||||
|
"""
|
||||||
|
def create_media_item_from_backend_attrs(source, media_attrs_struct) do
|
||||||
|
attrs = Map.merge(%{source_id: source.id}, Map.from_struct(media_attrs_struct))
|
||||||
|
|
||||||
|
%MediaItem{}
|
||||||
|
|> MediaItem.changeset(attrs)
|
||||||
|
|> Repo.insert(
|
||||||
|
on_conflict: [
|
||||||
|
set: Map.to_list(attrs)
|
||||||
|
],
|
||||||
|
conflict_target: [:source_id, :media_id]
|
||||||
|
)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Updates a media_item.
|
||||||
|
|
||||||
|
Returns {:ok, %MediaItem{}} | {:error, %Ecto.Changeset{}}
|
||||||
"""
|
"""
|
||||||
def update_media_item(%MediaItem{} = media_item, attrs) do
|
def update_media_item(%MediaItem{} = media_item, attrs) do
|
||||||
media_item
|
media_item
|
||||||
@@ -174,19 +189,22 @@ defmodule Pinchflat.Media do
|
|||||||
end
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Deletes a media_item and its associated tasks.
|
Deletes a media_item, its associated tasks, and our internal metadata files.
|
||||||
Can optionally delete the media_item's files.
|
Can optionally delete the media_item's media files (media, thumbnail, subtitles, etc).
|
||||||
|
|
||||||
Returns {:ok, %MediaItem{}} | {:error, %Ecto.Changeset{}}.
|
Returns {:ok, %MediaItem{}} | {:error, %Ecto.Changeset{}}
|
||||||
"""
|
"""
|
||||||
def delete_media_item(%MediaItem{} = media_item, opts \\ []) do
|
def delete_media_item(%MediaItem{} = media_item, opts \\ []) do
|
||||||
delete_files = Keyword.get(opts, :delete_files, false)
|
delete_files = Keyword.get(opts, :delete_files, false)
|
||||||
|
|
||||||
|
Tasks.delete_tasks_for(media_item)
|
||||||
|
|
||||||
if delete_files do
|
if delete_files do
|
||||||
{:ok, _} = delete_all_attachments(media_item)
|
{:ok, _} = delete_media_files(media_item)
|
||||||
end
|
end
|
||||||
|
|
||||||
Tasks.delete_tasks_for(media_item)
|
# Should delete these no matter what
|
||||||
|
delete_internal_metadata_files(media_item)
|
||||||
Repo.delete(media_item)
|
Repo.delete(media_item)
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -197,26 +215,47 @@ defmodule Pinchflat.Media do
|
|||||||
MediaItem.changeset(media_item, attrs)
|
MediaItem.changeset(media_item, attrs)
|
||||||
end
|
end
|
||||||
|
|
||||||
defp delete_all_attachments(media_item) do
|
defp delete_media_files(media_item) do
|
||||||
media_item = Repo.preload(media_item, :metadata)
|
mapped_struct = Map.from_struct(media_item)
|
||||||
|
|
||||||
media_item
|
MediaItem.filepath_attributes()
|
||||||
|> media_filepaths()
|
|> Enum.map(fn
|
||||||
|> Enum.concat(metadata_filepaths(media_item))
|
:subtitle_filepaths = field -> Enum.map(mapped_struct[field], fn [_, filepath] -> filepath end)
|
||||||
|> Enum.each(&File.rm/1)
|
field -> List.wrap(mapped_struct[field])
|
||||||
|
end)
|
||||||
# rmdir will attempt to delete the directory, but only if it is empty
|
|> List.flatten()
|
||||||
if media_item.media_filepath do
|
|> Enum.filter(&is_binary/1)
|
||||||
File.rmdir(Path.dirname(media_item.media_filepath))
|
|> Enum.each(&FilesystemHelpers.delete_file_and_remove_empty_directories/1)
|
||||||
end
|
|
||||||
|
|
||||||
if media_item.metadata && media_item.metadata.metadata_filepath do
|
|
||||||
File.rmdir(Path.dirname(media_item.metadata.metadata_filepath))
|
|
||||||
end
|
|
||||||
|
|
||||||
{:ok, media_item}
|
{:ok, media_item}
|
||||||
end
|
end
|
||||||
|
|
||||||
|
defp delete_internal_metadata_files(media_item) do
|
||||||
|
metadata = Repo.preload(media_item, :metadata).metadata || %MediaMetadata{}
|
||||||
|
mapped_struct = Map.from_struct(metadata)
|
||||||
|
|
||||||
|
MediaMetadata.filepath_attributes()
|
||||||
|
|> Enum.map(fn field -> mapped_struct[field] end)
|
||||||
|
|> Enum.filter(&is_binary/1)
|
||||||
|
|> Enum.each(&FilesystemHelpers.delete_file_and_remove_empty_directories/1)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp maybe_apply_cutoff_date(source) do
|
||||||
|
if source.download_cutoff_date do
|
||||||
|
dynamic([mi], mi.upload_date >= ^source.download_cutoff_date)
|
||||||
|
else
|
||||||
|
dynamic(true)
|
||||||
|
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
|
defp build_format_clauses(media_profile) do
|
||||||
mapped_struct = Map.from_struct(media_profile)
|
mapped_struct = Map.from_struct(media_profile)
|
||||||
|
|
||||||
@@ -225,7 +264,7 @@ defmodule Pinchflat.Media do
|
|||||||
{{:shorts_behaviour, :only}, %{livestream_behaviour: :only}} ->
|
{{:shorts_behaviour, :only}, %{livestream_behaviour: :only}} ->
|
||||||
dynamic(
|
dynamic(
|
||||||
[mi],
|
[mi],
|
||||||
^dynamic and (mi.livestream == true or fragment("LOWER(?) LIKE LOWER(?)", mi.original_url, "%/shorts/%"))
|
^dynamic and (mi.livestream == true or mi.short_form_content == true)
|
||||||
)
|
)
|
||||||
|
|
||||||
# Technically redundant, but makes the other clauses easier to parse
|
# Technically redundant, but makes the other clauses easier to parse
|
||||||
@@ -234,16 +273,13 @@ defmodule Pinchflat.Media do
|
|||||||
dynamic
|
dynamic
|
||||||
|
|
||||||
{{:shorts_behaviour, :only}, _} ->
|
{{:shorts_behaviour, :only}, _} ->
|
||||||
# return records with /shorts/ in the original_url
|
dynamic([mi], ^dynamic and mi.short_form_content == true)
|
||||||
dynamic([mi], ^dynamic and fragment("LOWER(?) LIKE LOWER(?)", mi.original_url, "%/shorts/%"))
|
|
||||||
|
|
||||||
{{:livestream_behaviour, :only}, _} ->
|
{{:livestream_behaviour, :only}, _} ->
|
||||||
# return records with livestream: true
|
|
||||||
dynamic([mi], ^dynamic and mi.livestream == true)
|
dynamic([mi], ^dynamic and mi.livestream == true)
|
||||||
|
|
||||||
{{:shorts_behaviour, :exclude}, %{livestream_behaviour: lb}} when lb != :only ->
|
{{:shorts_behaviour, :exclude}, %{livestream_behaviour: lb}} when lb != :only ->
|
||||||
# return records without /shorts/ in the original_url
|
dynamic([mi], ^dynamic and mi.short_form_content == false)
|
||||||
dynamic([mi], ^dynamic and fragment("LOWER(?) NOT LIKE LOWER(?)", mi.original_url, "%/shorts/%"))
|
|
||||||
|
|
||||||
{{:livestream_behaviour, :exclude}, %{shorts_behaviour: sb}} when sb != :only ->
|
{{:livestream_behaviour, :exclude}, %{shorts_behaviour: sb}} when sb != :only ->
|
||||||
# return records with livestream: false
|
# return records with livestream: false
|
||||||
@@ -8,26 +8,38 @@ defmodule Pinchflat.Media.MediaItem do
|
|||||||
|
|
||||||
alias Pinchflat.Tasks.Task
|
alias Pinchflat.Tasks.Task
|
||||||
alias Pinchflat.Sources.Source
|
alias Pinchflat.Sources.Source
|
||||||
alias Pinchflat.Media.MediaMetadata
|
alias Pinchflat.Metadata.MediaMetadata
|
||||||
alias Pinchflat.Media.MediaItemSearchIndex
|
alias Pinchflat.Media.MediaItemsSearchIndex
|
||||||
|
|
||||||
@allowed_fields [
|
@allowed_fields [
|
||||||
# these fields are captured on indexing
|
# these fields are captured on indexing (and again on download)
|
||||||
:title,
|
:title,
|
||||||
:media_id,
|
:media_id,
|
||||||
:description,
|
:description,
|
||||||
:original_url,
|
:original_url,
|
||||||
:livestream,
|
:livestream,
|
||||||
:source_id,
|
:source_id,
|
||||||
# these fields are captured on download
|
:short_form_content,
|
||||||
|
:upload_date,
|
||||||
|
# these fields are captured only on download
|
||||||
:media_downloaded_at,
|
:media_downloaded_at,
|
||||||
:media_filepath,
|
:media_filepath,
|
||||||
:media_size_bytes,
|
:media_size_bytes,
|
||||||
:subtitle_filepaths,
|
:subtitle_filepaths,
|
||||||
:thumbnail_filepath,
|
:thumbnail_filepath,
|
||||||
:metadata_filepath
|
:metadata_filepath,
|
||||||
|
:nfo_filepath
|
||||||
]
|
]
|
||||||
@required_fields ~w(title original_url livestream media_id source_id)a
|
# Pretty much all the fields captured at index are required.
|
||||||
|
@required_fields ~w(
|
||||||
|
title
|
||||||
|
original_url
|
||||||
|
livestream
|
||||||
|
media_id
|
||||||
|
source_id
|
||||||
|
upload_date
|
||||||
|
short_form_content
|
||||||
|
)a
|
||||||
|
|
||||||
schema "media_items" do
|
schema "media_items" do
|
||||||
field :title, :string
|
field :title, :string
|
||||||
@@ -35,12 +47,15 @@ defmodule Pinchflat.Media.MediaItem do
|
|||||||
field :description, :string
|
field :description, :string
|
||||||
field :original_url, :string
|
field :original_url, :string
|
||||||
field :livestream, :boolean, default: false
|
field :livestream, :boolean, default: false
|
||||||
|
field :short_form_content, :boolean, default: false
|
||||||
field :media_downloaded_at, :utc_datetime
|
field :media_downloaded_at, :utc_datetime
|
||||||
|
field :upload_date, :date
|
||||||
|
|
||||||
field :media_filepath, :string
|
field :media_filepath, :string
|
||||||
field :media_size_bytes, :integer
|
field :media_size_bytes, :integer
|
||||||
field :thumbnail_filepath, :string
|
field :thumbnail_filepath, :string
|
||||||
field :metadata_filepath, :string
|
field :metadata_filepath, :string
|
||||||
|
field :nfo_filepath, :string
|
||||||
# This is an array of [iso-2 language, filepath] pairs. Probably could
|
# This is an array of [iso-2 language, filepath] pairs. Probably could
|
||||||
# be an associated record, but I don't see the benefit right now.
|
# be an associated record, but I don't see the benefit right now.
|
||||||
# Will very likely revisit because I can't leave well-enough alone.
|
# Will very likely revisit because I can't leave well-enough alone.
|
||||||
@@ -51,7 +66,7 @@ defmodule Pinchflat.Media.MediaItem do
|
|||||||
belongs_to :source, Source
|
belongs_to :source, Source
|
||||||
|
|
||||||
has_one :metadata, MediaMetadata, on_replace: :update
|
has_one :metadata, MediaMetadata, on_replace: :update
|
||||||
has_one :media_items_search_index, MediaItemSearchIndex, foreign_key: :id
|
has_one :media_items_search_index, MediaItemsSearchIndex, foreign_key: :id
|
||||||
|
|
||||||
has_many :tasks, Task
|
has_many :tasks, Task
|
||||||
|
|
||||||
@@ -69,6 +84,6 @@ defmodule Pinchflat.Media.MediaItem do
|
|||||||
|
|
||||||
@doc false
|
@doc false
|
||||||
def filepath_attributes do
|
def filepath_attributes do
|
||||||
~w(media_filepath thumbnail_filepath metadata_filepath subtitle_filepaths)a
|
~w(media_filepath thumbnail_filepath metadata_filepath subtitle_filepaths nfo_filepath)a
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
defmodule Pinchflat.Media.MediaItemSearchIndex do
|
defmodule Pinchflat.Media.MediaItemsSearchIndex do
|
||||||
@moduledoc """
|
@moduledoc """
|
||||||
The MediaItem fts5 search index. Not made to be directly interacted with,
|
The MediaItem fts5 search index. Not made to be directly interacted with,
|
||||||
but I figured it'd be better to have it in-app so it's not a mystery.
|
but I figured it'd be better to have it in-app so it's not a mystery.
|
||||||
|
|||||||
@@ -1,26 +0,0 @@
|
|||||||
defmodule Pinchflat.MediaClient.Backends.YtDlp.Media do
|
|
||||||
@moduledoc """
|
|
||||||
Contains utilities for working with singular pieces of media
|
|
||||||
"""
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Downloads a single piece of media (and possibly its metadata) directly to its
|
|
||||||
final destination. Returns the parsed JSON output from yt-dlp.
|
|
||||||
|
|
||||||
Returns {:ok, map()} | {:error, any, ...}.
|
|
||||||
"""
|
|
||||||
def download(url, command_opts \\ []) do
|
|
||||||
opts = [:no_simulate] ++ command_opts
|
|
||||||
|
|
||||||
with {:ok, output} <- backend_runner().run(url, opts, "after_move:%()j"),
|
|
||||||
{:ok, parsed_json} <- Phoenix.json_library().decode(output) do
|
|
||||||
{:ok, parsed_json}
|
|
||||||
else
|
|
||||||
err -> err
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
defp backend_runner do
|
|
||||||
Application.get_env(:pinchflat, :yt_dlp_runner)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,78 +0,0 @@
|
|||||||
defmodule Pinchflat.MediaClient.Backends.YtDlp.MediaCollection do
|
|
||||||
@moduledoc """
|
|
||||||
Contains utilities for working with collections of
|
|
||||||
media (aka: a source [ie: channels, playlists]).
|
|
||||||
"""
|
|
||||||
|
|
||||||
require Logger
|
|
||||||
|
|
||||||
alias Pinchflat.Utils.FunctionUtils
|
|
||||||
alias Pinchflat.Utils.FilesystemUtils
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Returns a list of maps representing the media in the collection.
|
|
||||||
|
|
||||||
Options:
|
|
||||||
- :file_listener_handler - a function that will be called with the path to the
|
|
||||||
file that will be written to when yt-dlp is done. This is useful for
|
|
||||||
setting up a file watcher to know when the file is ready to be read.
|
|
||||||
|
|
||||||
Returns {:ok, [map()]} | {:error, any, ...}.
|
|
||||||
"""
|
|
||||||
def get_media_attributes(url, addl_opts \\ []) do
|
|
||||||
runner = Application.get_env(:pinchflat, :yt_dlp_runner)
|
|
||||||
command_opts = [:simulate, :skip_download]
|
|
||||||
output_template = "%(.{id,title,was_live,original_url,description})j"
|
|
||||||
output_filepath = FilesystemUtils.generate_metadata_tmpfile(:json)
|
|
||||||
file_listener_handler = Keyword.get(addl_opts, :file_listener_handler, false)
|
|
||||||
|
|
||||||
if file_listener_handler do
|
|
||||||
file_listener_handler.(output_filepath)
|
|
||||||
end
|
|
||||||
|
|
||||||
case runner.run(url, command_opts, output_template, output_filepath: output_filepath) do
|
|
||||||
{:ok, output} ->
|
|
||||||
output
|
|
||||||
|> String.split("\n", trim: true)
|
|
||||||
|> Enum.map(&Phoenix.json_library().decode!/1)
|
|
||||||
|> FunctionUtils.wrap_ok()
|
|
||||||
|
|
||||||
res ->
|
|
||||||
res
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Gets a source's ID and name from its URL.
|
|
||||||
|
|
||||||
yt-dlp does not _really_ have source-specific functions, so
|
|
||||||
instead we're fetching just the first video (using playlist_end: 1)
|
|
||||||
and parsing the source ID and name from _its_ metadata
|
|
||||||
|
|
||||||
Returns {:ok, map()} | {:error, any, ...}.
|
|
||||||
"""
|
|
||||||
def get_source_details(source_url) do
|
|
||||||
opts = [:simulate, :skip_download, playlist_end: 1]
|
|
||||||
output_template = "%(.{channel,channel_id,playlist_id,playlist_title})j"
|
|
||||||
|
|
||||||
with {:ok, output} <- backend_runner().run(source_url, opts, output_template),
|
|
||||||
{:ok, parsed_json} <- Phoenix.json_library().decode(output) do
|
|
||||||
{:ok, format_source_details(parsed_json)}
|
|
||||||
else
|
|
||||||
err -> err
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
defp format_source_details(response) do
|
|
||||||
%{
|
|
||||||
channel_id: response["channel_id"],
|
|
||||||
channel_name: response["channel"],
|
|
||||||
playlist_id: response["playlist_id"],
|
|
||||||
playlist_name: response["playlist_title"]
|
|
||||||
}
|
|
||||||
end
|
|
||||||
|
|
||||||
defp backend_runner do
|
|
||||||
Application.get_env(:pinchflat, :yt_dlp_runner)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,83 +0,0 @@
|
|||||||
defmodule Pinchflat.MediaClient.MediaDownloader do
|
|
||||||
@moduledoc """
|
|
||||||
This is the integration layer for actually downloading medias.
|
|
||||||
It takes into account the media profile's settings in order
|
|
||||||
to download the media with the desired options.
|
|
||||||
|
|
||||||
Technically hardcodes the yt-dlp backend for now, but should leave
|
|
||||||
it open-ish for future expansion (just in case).
|
|
||||||
"""
|
|
||||||
|
|
||||||
alias Pinchflat.Repo
|
|
||||||
alias Pinchflat.Media
|
|
||||||
alias Pinchflat.Media.MediaItem
|
|
||||||
|
|
||||||
alias Pinchflat.MediaClient.Backends.YtDlp.Media, as: YtDlpMedia
|
|
||||||
alias Pinchflat.Profiles.Options.YtDlp.DownloadOptionBuilder, as: YtDlpDownloadOptionBuilder
|
|
||||||
alias Pinchflat.MediaClient.Backends.YtDlp.MetadataParser, as: YtDlpMetadataParser
|
|
||||||
alias Pinchflat.MediaClient.Backends.YtDlp.MetadataFileHelpers, as: YtDlpMetadataHelpers
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Downloads media for a media item, updating the media item based on the metadata
|
|
||||||
returned by the backend. Also saves the entire metadata response to the associated
|
|
||||||
media_metadata record.
|
|
||||||
|
|
||||||
NOTE: related methods (like the download worker) won't download if the media item's source
|
|
||||||
is set to not download media. However, I'm not enforcing that here since I need this for testing.
|
|
||||||
This may change in the future but I'm not stressed.
|
|
||||||
|
|
||||||
Returns {:ok, %MediaItem{}} | {:error, any, ...any}
|
|
||||||
"""
|
|
||||||
def download_for_media_item(%MediaItem{} = media_item, backend \\ :yt_dlp) do
|
|
||||||
item_with_preloads = Repo.preload(media_item, [:metadata, source: :media_profile])
|
|
||||||
|
|
||||||
case download_with_options(media_item.original_url, item_with_preloads, backend) do
|
|
||||||
{:ok, parsed_json} ->
|
|
||||||
{parser, helpers} = metadata_parsers(backend)
|
|
||||||
|
|
||||||
parsed_attrs =
|
|
||||||
parsed_json
|
|
||||||
|> parser.parse_for_media_item()
|
|
||||||
|> Map.merge(%{
|
|
||||||
media_downloaded_at: DateTime.utc_now(),
|
|
||||||
metadata: %{
|
|
||||||
metadata_filepath: helpers.compress_and_store_metadata_for(media_item, parsed_json),
|
|
||||||
thumbnail_filepath: helpers.download_and_store_thumbnail_for(media_item, parsed_json)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
# Don't forgor to use preloaded associations or updates to
|
|
||||||
# associations won't work!
|
|
||||||
Media.update_media_item(item_with_preloads, parsed_attrs)
|
|
||||||
|
|
||||||
err ->
|
|
||||||
err
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
defp download_with_options(url, item_with_preloads, backend) do
|
|
||||||
option_builder = option_builder(backend)
|
|
||||||
media_backend = media_backend(backend)
|
|
||||||
{:ok, options} = option_builder.build(item_with_preloads)
|
|
||||||
|
|
||||||
media_backend.download(url, options)
|
|
||||||
end
|
|
||||||
|
|
||||||
defp option_builder(backend) do
|
|
||||||
case backend do
|
|
||||||
:yt_dlp -> YtDlpDownloadOptionBuilder
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
defp media_backend(backend) do
|
|
||||||
case backend do
|
|
||||||
:yt_dlp -> YtDlpMedia
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
defp metadata_parsers(backend) do
|
|
||||||
case backend do
|
|
||||||
:yt_dlp -> {YtDlpMetadataParser, YtDlpMetadataHelpers}
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,47 +0,0 @@
|
|||||||
defmodule Pinchflat.MediaClient.SourceDetails do
|
|
||||||
@moduledoc """
|
|
||||||
This is the integration layer for actually working with sources.
|
|
||||||
|
|
||||||
Technically hardcodes the yt-dlp backend for now, but should leave
|
|
||||||
it open-ish for future expansion (just in case).
|
|
||||||
"""
|
|
||||||
|
|
||||||
alias Pinchflat.Sources.Source
|
|
||||||
alias Pinchflat.MediaClient.Backends.YtDlp.MediaCollection, as: YtDlpSource
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Gets a source's ID and name from its URL using the given backend.
|
|
||||||
|
|
||||||
Returns {:ok, map()} | {:error, any, ...}.
|
|
||||||
"""
|
|
||||||
def get_source_details(source_url, backend \\ :yt_dlp) do
|
|
||||||
source_module(backend).get_source_details(source_url)
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Returns a list of basic media data maps for the given source URL OR
|
|
||||||
source record using the given backend.
|
|
||||||
|
|
||||||
Options:
|
|
||||||
- :file_listener_handler - a function that will be called with the path to the
|
|
||||||
file that will be written to by yt-dlp. This is useful for
|
|
||||||
setting up a file watcher to read the file as it gets written to.
|
|
||||||
|
|
||||||
Returns {:ok, [map()]} | {:error, any, ...}.
|
|
||||||
"""
|
|
||||||
def get_media_attributes(sourceable, opts \\ [], backend \\ :yt_dlp)
|
|
||||||
|
|
||||||
def get_media_attributes(%Source{} = source, opts, backend) do
|
|
||||||
get_media_attributes(source.collection_id, opts, backend)
|
|
||||||
end
|
|
||||||
|
|
||||||
def get_media_attributes(source_url, opts, backend) when is_binary(source_url) do
|
|
||||||
source_module(backend).get_media_attributes(source_url, opts)
|
|
||||||
end
|
|
||||||
|
|
||||||
defp source_module(backend) do
|
|
||||||
case backend do
|
|
||||||
:yt_dlp -> YtDlpSource
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,65 +0,0 @@
|
|||||||
defmodule Pinchflat.Sources.Source do
|
|
||||||
@moduledoc """
|
|
||||||
The Source schema.
|
|
||||||
"""
|
|
||||||
|
|
||||||
use Ecto.Schema
|
|
||||||
import Ecto.Changeset
|
|
||||||
import Pinchflat.Utils.ChangesetUtils
|
|
||||||
|
|
||||||
alias Pinchflat.Tasks.Task
|
|
||||||
alias Pinchflat.Media.MediaItem
|
|
||||||
alias Pinchflat.Profiles.MediaProfile
|
|
||||||
|
|
||||||
@allowed_fields ~w(
|
|
||||||
collection_name
|
|
||||||
collection_id
|
|
||||||
collection_type
|
|
||||||
custom_name
|
|
||||||
index_frequency_minutes
|
|
||||||
download_media
|
|
||||||
last_indexed_at
|
|
||||||
original_url
|
|
||||||
media_profile_id
|
|
||||||
)a
|
|
||||||
|
|
||||||
@required_fields ~w(
|
|
||||||
collection_name
|
|
||||||
collection_id
|
|
||||||
collection_type
|
|
||||||
custom_name
|
|
||||||
index_frequency_minutes
|
|
||||||
download_media
|
|
||||||
original_url
|
|
||||||
media_profile_id
|
|
||||||
)a
|
|
||||||
|
|
||||||
schema "sources" do
|
|
||||||
field :custom_name, :string
|
|
||||||
field :collection_name, :string
|
|
||||||
field :collection_id, :string
|
|
||||||
field :collection_type, Ecto.Enum, values: [:channel, :playlist]
|
|
||||||
field :index_frequency_minutes, :integer, default: 60 * 24
|
|
||||||
field :download_media, :boolean, default: true
|
|
||||||
field :last_indexed_at, :utc_datetime
|
|
||||||
# This should only be used for user reference going forward
|
|
||||||
# as the collection_id should be used for all API calls
|
|
||||||
field :original_url, :string
|
|
||||||
|
|
||||||
belongs_to :media_profile, MediaProfile
|
|
||||||
|
|
||||||
has_many :tasks, Task
|
|
||||||
has_many :media_items, MediaItem, foreign_key: :source_id
|
|
||||||
|
|
||||||
timestamps(type: :utc_datetime)
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc false
|
|
||||||
def changeset(source, attrs) do
|
|
||||||
source
|
|
||||||
|> cast(attrs, @allowed_fields)
|
|
||||||
|> dynamic_default(:custom_name, fn cs -> get_field(cs, :collection_name) end)
|
|
||||||
|> validate_required(@required_fields)
|
|
||||||
|> unique_constraint([:collection_id, :media_profile_id])
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
defmodule Pinchflat.Media.MediaMetadata do
|
defmodule Pinchflat.Metadata.MediaMetadata do
|
||||||
@moduledoc """
|
@moduledoc """
|
||||||
The MediaMetadata schema.
|
The MediaMetadata schema.
|
||||||
|
|
||||||
+54
-5
@@ -1,4 +1,4 @@
|
|||||||
defmodule Pinchflat.MediaClient.Backends.YtDlp.MetadataFileHelpers do
|
defmodule Pinchflat.Metadata.MetadataFileHelpers do
|
||||||
@moduledoc """
|
@moduledoc """
|
||||||
Provides methods for creating/downloading/storing related metadata
|
Provides methods for creating/downloading/storing related metadata
|
||||||
out-of-band of the normal yt-dlp backend process.
|
out-of-band of the normal yt-dlp backend process.
|
||||||
@@ -9,6 +9,8 @@ defmodule Pinchflat.MediaClient.Backends.YtDlp.MetadataFileHelpers do
|
|||||||
needed
|
needed
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
alias Pinchflat.Filesystem.FilesystemHelpers
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Compresses and stores metadata for a media item, returning the filepath.
|
Compresses and stores metadata for a media item, returning the filepath.
|
||||||
|
|
||||||
@@ -18,8 +20,7 @@ defmodule Pinchflat.MediaClient.Backends.YtDlp.MetadataFileHelpers do
|
|||||||
filepath = generate_filepath_for(database_record, "metadata.json.gz")
|
filepath = generate_filepath_for(database_record, "metadata.json.gz")
|
||||||
{:ok, json} = Phoenix.json_library().encode(metadata_map)
|
{:ok, json} = Phoenix.json_library().encode(metadata_map)
|
||||||
|
|
||||||
File.mkdir_p!(Path.dirname(filepath))
|
:ok = FilesystemHelpers.write_p!(filepath, json, [:compressed])
|
||||||
:ok = File.write(filepath, json, [:compressed])
|
|
||||||
|
|
||||||
filepath
|
filepath
|
||||||
end
|
end
|
||||||
@@ -45,12 +46,60 @@ defmodule Pinchflat.MediaClient.Backends.YtDlp.MetadataFileHelpers do
|
|||||||
filepath = generate_filepath_for(database_record, Path.basename(thumbnail_url))
|
filepath = generate_filepath_for(database_record, Path.basename(thumbnail_url))
|
||||||
thumbnail_blob = fetch_thumbnail_from_url(thumbnail_url)
|
thumbnail_blob = fetch_thumbnail_from_url(thumbnail_url)
|
||||||
|
|
||||||
File.mkdir_p!(Path.dirname(filepath))
|
:ok = FilesystemHelpers.write_p!(filepath, thumbnail_blob)
|
||||||
:ok = File.write(filepath, thumbnail_blob)
|
|
||||||
|
|
||||||
filepath
|
filepath
|
||||||
end
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Parses an upload date from the YYYYMMDD string returned in yt-dlp metadata
|
||||||
|
and returns a Date struct.
|
||||||
|
|
||||||
|
Returns Date.t()
|
||||||
|
"""
|
||||||
|
def parse_upload_date(upload_date) do
|
||||||
|
<<year::binary-size(4)>> <> <<month::binary-size(2)>> <> <<day::binary-size(2)>> = upload_date
|
||||||
|
|
||||||
|
Date.from_iso8601!("#{year}-#{month}-#{day}")
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Attempts to determine the series directory from a media filepath.
|
||||||
|
The series directory is the "root" directory for a given source
|
||||||
|
which should contain all the season-level folders of that source.
|
||||||
|
|
||||||
|
Used for determining where to store things like NFO data and banners
|
||||||
|
for media center apps. Not useful without a media center app.
|
||||||
|
|
||||||
|
Returns {:ok, binary()} | {:error, :indeterminable}
|
||||||
|
"""
|
||||||
|
def series_directory_from_media_filepath(media_filepath) do
|
||||||
|
# Matches "s" or "season" (case-insensitive)
|
||||||
|
# followed by an optional non-word character (. or _ or <space>, etc)
|
||||||
|
# followed by at least one digit
|
||||||
|
# followed immediately by the end of the string
|
||||||
|
# Example matches: s1, s.1, s01 season 1, Season.01, Season_1, Season 1, Season1
|
||||||
|
# Example non-matches: s01e01, season, series 1,
|
||||||
|
season_regex = ~r/^s(eason)?(\W|_)?\d{1,}$/i
|
||||||
|
|
||||||
|
{series_directory, found_series_directory} =
|
||||||
|
media_filepath
|
||||||
|
|> Path.split()
|
||||||
|
|> Enum.reduce_while({[], false}, fn part, {directory_acc, _} ->
|
||||||
|
if String.match?(part, season_regex) do
|
||||||
|
{:halt, {directory_acc, true}}
|
||||||
|
else
|
||||||
|
{:cont, {directory_acc ++ [part], false}}
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
|
||||||
|
if found_series_directory do
|
||||||
|
{:ok, Path.join(series_directory)}
|
||||||
|
else
|
||||||
|
{:error, :indeterminable}
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
defp fetch_thumbnail_from_url(url) do
|
defp fetch_thumbnail_from_url(url) do
|
||||||
http_client = Application.get_env(:pinchflat, :http_client, Pinchflat.HTTP.HTTPClient)
|
http_client = Application.get_env(:pinchflat, :http_client, Pinchflat.HTTP.HTTPClient)
|
||||||
{:ok, body} = http_client.get(url, [], body_format: :binary)
|
{:ok, body} = http_client.get(url, [], body_format: :binary)
|
||||||
+21
-5
@@ -1,4 +1,4 @@
|
|||||||
defmodule Pinchflat.MediaClient.Backends.YtDlp.MetadataParser do
|
defmodule Pinchflat.Metadata.MetadataParser do
|
||||||
@moduledoc """
|
@moduledoc """
|
||||||
yt-dlp offers a LOT of metadata in its JSON response, some of which
|
yt-dlp offers a LOT of metadata in its JSON response, some of which
|
||||||
needs to be extracted and included in various models.
|
needs to be extracted and included in various models.
|
||||||
@@ -25,9 +25,12 @@ defmodule Pinchflat.MediaClient.Backends.YtDlp.MetadataParser do
|
|||||||
|
|
||||||
defp parse_media_metadata(metadata) do
|
defp parse_media_metadata(metadata) do
|
||||||
%{
|
%{
|
||||||
|
media_id: metadata["id"],
|
||||||
title: metadata["title"],
|
title: metadata["title"],
|
||||||
|
original_url: metadata["original_url"],
|
||||||
description: metadata["description"],
|
description: metadata["description"],
|
||||||
media_filepath: metadata["filepath"]
|
media_filepath: metadata["filepath"],
|
||||||
|
livestream: metadata["was_live"]
|
||||||
}
|
}
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -51,9 +54,22 @@ defmodule Pinchflat.MediaClient.Backends.YtDlp.MetadataParser do
|
|||||||
|> Enum.reverse()
|
|> Enum.reverse()
|
||||||
|> Enum.find_value(fn attrs -> attrs["filepath"] end)
|
|> Enum.find_value(fn attrs -> attrs["filepath"] end)
|
||||||
|
|
||||||
%{
|
if thumbnail_filepath do
|
||||||
thumbnail_filepath: thumbnail_filepath
|
# 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
|
||||||
|
%{
|
||||||
|
thumbnail_filepath:
|
||||||
|
thumbnail_filepath
|
||||||
|
|> String.split(~r{\.}, include_captures: true)
|
||||||
|
|> List.insert_at(-3, "-thumb")
|
||||||
|
|> Enum.join()
|
||||||
|
}
|
||||||
|
else
|
||||||
|
%{
|
||||||
|
thumbnail_filepath: thumbnail_filepath
|
||||||
|
}
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
defp parse_infojson_metadata(metadata) do
|
defp parse_infojson_metadata(metadata) do
|
||||||
@@ -0,0 +1,68 @@
|
|||||||
|
defmodule Pinchflat.Metadata.NfoBuilder do
|
||||||
|
@moduledoc """
|
||||||
|
Provides methods for building and storing NFO files for
|
||||||
|
use by Kodi/Jellyfin and other media center software.
|
||||||
|
"""
|
||||||
|
|
||||||
|
alias Pinchflat.Metadata.MetadataFileHelpers
|
||||||
|
alias Pinchflat.Filesystem.FilesystemHelpers
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Builds an NFO file for a media item (read: single "episode") and
|
||||||
|
stores it at the specified location.
|
||||||
|
|
||||||
|
Returns the filepath of the NFO file.
|
||||||
|
"""
|
||||||
|
def build_and_store_for_media_item(filepath, metadata) do
|
||||||
|
nfo = build_for_media_item(metadata)
|
||||||
|
|
||||||
|
FilesystemHelpers.write_p!(filepath, nfo)
|
||||||
|
|
||||||
|
filepath
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Builds an NFO file for a souce and stores it at the specified location.
|
||||||
|
Technically works for playlists, but it's really made for channels.
|
||||||
|
|
||||||
|
Returns the filepath of the NFO file.
|
||||||
|
"""
|
||||||
|
def build_and_store_for_source(filepath, metadata) do
|
||||||
|
nfo = build_for_source(metadata)
|
||||||
|
|
||||||
|
FilesystemHelpers.write_p!(filepath, nfo)
|
||||||
|
|
||||||
|
filepath
|
||||||
|
end
|
||||||
|
|
||||||
|
defp build_for_media_item(metadata) do
|
||||||
|
upload_date = MetadataFileHelpers.parse_upload_date(metadata["upload_date"])
|
||||||
|
# Cribbed from a combination of the Kodi wiki, ytdl-nfo, and ytdl-sub.
|
||||||
|
# WHO NEEDS A FANCY XML PARSER ANYWAY?!
|
||||||
|
"""
|
||||||
|
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
|
||||||
|
<episodedetails>
|
||||||
|
<title>#{metadata["title"]}</title>
|
||||||
|
<showtitle>#{metadata["uploader"]}</showtitle>
|
||||||
|
<uniqueid type="youtube" default="true">#{metadata["id"]}</uniqueid>
|
||||||
|
<plot>#{metadata["description"]}</plot>
|
||||||
|
<aired>#{upload_date}</aired>
|
||||||
|
<season>#{upload_date.year}</season>
|
||||||
|
<episode>#{Calendar.strftime(upload_date, "%m%d")}</episode>
|
||||||
|
<genre>YouTube</genre>
|
||||||
|
</episodedetails>
|
||||||
|
"""
|
||||||
|
end
|
||||||
|
|
||||||
|
defp build_for_source(metadata) do
|
||||||
|
"""
|
||||||
|
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
|
||||||
|
<tvshow>
|
||||||
|
<title>#{metadata["title"]}</title>
|
||||||
|
<plot>#{metadata["description"]}</plot>
|
||||||
|
<uniqueid type="youtube" default="true">#{metadata["id"]}</uniqueid>
|
||||||
|
<genre>YouTube</genre>
|
||||||
|
</tvshow>
|
||||||
|
"""
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,69 @@
|
|||||||
|
defmodule Pinchflat.Metadata.SourceImageParser do
|
||||||
|
@moduledoc """
|
||||||
|
Functions for parsing and storing source images.
|
||||||
|
"""
|
||||||
|
alias Pinchflat.Filesystem.FilesystemHelpers
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Given a base directory and source metadata, look for the appropriate images
|
||||||
|
and move them to the base directory. Returns a map of image types and their
|
||||||
|
filepaths (specifically for a source). If a given image type is not found,
|
||||||
|
the key will not be present in the map.
|
||||||
|
|
||||||
|
The metadata is expected to contain the `filepath` key for images, implying
|
||||||
|
that the images have already been downloaded by yt-dlp. This method will NOT
|
||||||
|
download images from the internet - it just copys them around.
|
||||||
|
|
||||||
|
Returns a map with the possible keys :poster_filepath, :fanart_filepath, and
|
||||||
|
:banner_filepath.
|
||||||
|
"""
|
||||||
|
def store_source_images(base_directory, source_metadata) do
|
||||||
|
(source_metadata["thumbnails"] || [])
|
||||||
|
|> Enum.filter(&(&1["filepath"] != nil))
|
||||||
|
|> select_useful_images()
|
||||||
|
|> Enum.map(&move_image(&1, base_directory))
|
||||||
|
|> Enum.into(%{})
|
||||||
|
end
|
||||||
|
|
||||||
|
defp select_useful_images(images) do
|
||||||
|
labelled_images =
|
||||||
|
Enum.reduce(images, [], fn image_map, acc ->
|
||||||
|
case image_map do
|
||||||
|
%{"id" => "avatar_uncropped"} ->
|
||||||
|
acc ++ [{:poster, :poster_filepath, image_map["filepath"]}]
|
||||||
|
|
||||||
|
%{"id" => "banner_uncropped"} ->
|
||||||
|
acc ++ [{:fanart, :fanart_filepath, image_map["filepath"]}]
|
||||||
|
|
||||||
|
_ ->
|
||||||
|
acc
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
|
||||||
|
labelled_images
|
||||||
|
|> Enum.concat([{:banner, :banner_filepath, determine_best_banner(images)}])
|
||||||
|
|> Enum.filter(fn {_, _, tmp_filepath} -> tmp_filepath end)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp determine_best_banner(images) do
|
||||||
|
best_candidate =
|
||||||
|
images
|
||||||
|
# Filter out images that don't have a width and height attribute
|
||||||
|
|> Enum.filter(&(&1["width"] && &1["height"]))
|
||||||
|
# Sort images with the highest width first
|
||||||
|
|> Enum.sort(&(&1["width"] >= &2["width"]))
|
||||||
|
# Find the first image where the ratio of width to height is greater than 3
|
||||||
|
|> Enum.find(&(&1["width"] / &1["height"] > 3))
|
||||||
|
|
||||||
|
Map.get(best_candidate || %{}, "filepath")
|
||||||
|
end
|
||||||
|
|
||||||
|
defp move_image({filename, source_attr_name, tmp_filepath}, base_directory) do
|
||||||
|
extension = Path.extname(tmp_filepath)
|
||||||
|
final_filepath = Path.join([base_directory, "#{filename}#{extension}"])
|
||||||
|
|
||||||
|
FilesystemHelpers.cp_p!(tmp_filepath, final_filepath)
|
||||||
|
|
||||||
|
{source_attr_name, final_filepath}
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,36 @@
|
|||||||
|
defmodule Pinchflat.Metadata.SourceMetadata do
|
||||||
|
@moduledoc """
|
||||||
|
The SourceMetadata schema.
|
||||||
|
|
||||||
|
Look. Don't @ me about Metadata vs. Metadatum. I'm very sensitive.
|
||||||
|
"""
|
||||||
|
|
||||||
|
use Ecto.Schema
|
||||||
|
import Ecto.Changeset
|
||||||
|
|
||||||
|
alias Pinchflat.Sources.Source
|
||||||
|
|
||||||
|
@allowed_fields ~w(metadata_filepath)a
|
||||||
|
@required_fields ~w(metadata_filepath)a
|
||||||
|
|
||||||
|
schema "source_metadata" do
|
||||||
|
field :metadata_filepath, :string
|
||||||
|
|
||||||
|
belongs_to :source, Source
|
||||||
|
|
||||||
|
timestamps(type: :utc_datetime)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc false
|
||||||
|
def changeset(source_metadata, attrs) do
|
||||||
|
source_metadata
|
||||||
|
|> cast(attrs, @allowed_fields)
|
||||||
|
|> validate_required(@required_fields)
|
||||||
|
|> unique_constraint([:source_id])
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc false
|
||||||
|
def filepath_attributes do
|
||||||
|
~w(metadata_filepath)a
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,111 @@
|
|||||||
|
defmodule Pinchflat.Metadata.SourceMetadataStorageWorker do
|
||||||
|
@moduledoc false
|
||||||
|
|
||||||
|
use Oban.Worker,
|
||||||
|
queue: :remote_metadata,
|
||||||
|
tags: ["media_source", "source_metadata", "remote_metadata"],
|
||||||
|
max_attempts: 3
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias __MODULE__
|
||||||
|
alias Pinchflat.Repo
|
||||||
|
alias Pinchflat.Tasks
|
||||||
|
alias Pinchflat.Sources
|
||||||
|
alias Pinchflat.Utils.StringUtils
|
||||||
|
alias Pinchflat.Metadata.NfoBuilder
|
||||||
|
alias Pinchflat.YtDlp.MediaCollection
|
||||||
|
alias Pinchflat.Metadata.SourceImageParser
|
||||||
|
alias Pinchflat.Metadata.MetadataFileHelpers
|
||||||
|
alias Pinchflat.Downloading.DownloadOptionBuilder
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Starts the source metadata storage worker and creates a task for the source.
|
||||||
|
|
||||||
|
Returns {:ok, %Task{}} | {:error, :duplicate_job} | {:error, %Ecto.Changeset{}}
|
||||||
|
"""
|
||||||
|
def kickoff_with_task(source, opts \\ []) do
|
||||||
|
%{id: source.id}
|
||||||
|
|> SourceMetadataStorageWorker.new(opts)
|
||||||
|
|> Tasks.create_job_with_task(source)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Fetches and stores various forms of metadata for a source:
|
||||||
|
- JSON metadata for internal use
|
||||||
|
- The series directory for the source
|
||||||
|
- The NFO file for the source (if specified)
|
||||||
|
- Downloads and stores source images (if specified)
|
||||||
|
|
||||||
|
The worker is kicked off after a source is inserted/updated - this can
|
||||||
|
take an unknown amount of time so don't rely on this data being here
|
||||||
|
before, say, the first indexing or downloading task is complete.
|
||||||
|
|
||||||
|
Returns :ok
|
||||||
|
"""
|
||||||
|
@impl Oban.Worker
|
||||||
|
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
|
||||||
|
Sources.update_source(
|
||||||
|
source,
|
||||||
|
Map.merge(
|
||||||
|
%{
|
||||||
|
series_directory: series_directory,
|
||||||
|
nfo_filepath: store_source_nfo(source, series_directory, source_metadata),
|
||||||
|
metadata: %{
|
||||||
|
metadata_filepath: MetadataFileHelpers.compress_and_store_metadata_for(source, source_metadata)
|
||||||
|
}
|
||||||
|
},
|
||||||
|
image_filepath_attrs
|
||||||
|
),
|
||||||
|
run_post_commit_tasks: false
|
||||||
|
)
|
||||||
|
|
||||||
|
:ok
|
||||||
|
rescue
|
||||||
|
Ecto.NoResultsError -> Logger.info("#{__MODULE__} discarded: source #{source_id} not found")
|
||||||
|
Ecto.StaleEntryError -> Logger.info("#{__MODULE__} discarded: source #{source_id} stale")
|
||||||
|
end
|
||||||
|
|
||||||
|
defp fetch_source_metadata_and_images(series_directory, source) do
|
||||||
|
if source.media_profile.download_source_images && series_directory do
|
||||||
|
output_path = "#{tmp_directory()}/#{StringUtils.random_string(16)}/source_image.%(ext)S"
|
||||||
|
opts = [:write_all_thumbnails, convert_thumbnails: "jpg", output: output_path]
|
||||||
|
|
||||||
|
{:ok, metadata} = MediaCollection.get_source_metadata(source.original_url, opts)
|
||||||
|
image_attrs = SourceImageParser.store_source_images(series_directory, metadata)
|
||||||
|
|
||||||
|
{metadata, image_attrs}
|
||||||
|
else
|
||||||
|
{:ok, metadata} = MediaCollection.get_source_metadata(source.original_url, [])
|
||||||
|
|
||||||
|
{metadata, %{}}
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp determine_series_directory(source) do
|
||||||
|
output_path = DownloadOptionBuilder.build_output_path_for(source)
|
||||||
|
{:ok, %{filepath: filepath}} = MediaCollection.get_source_details(source.original_url, output: output_path)
|
||||||
|
|
||||||
|
case MetadataFileHelpers.series_directory_from_media_filepath(filepath) do
|
||||||
|
{:ok, series_directory} -> series_directory
|
||||||
|
{:error, _} -> nil
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp store_source_nfo(source, series_directory, metadata) do
|
||||||
|
if source.media_profile.download_nfo && series_directory do
|
||||||
|
nfo_filepath = Path.join(series_directory, "tvshow.nfo")
|
||||||
|
|
||||||
|
NfoBuilder.build_and_store_for_source(nfo_filepath, metadata)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp tmp_directory do
|
||||||
|
Application.get_env(:pinchflat, :tmpfile_directory)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -17,8 +17,10 @@ defmodule Pinchflat.Profiles.MediaProfile do
|
|||||||
sub_langs
|
sub_langs
|
||||||
download_thumbnail
|
download_thumbnail
|
||||||
embed_thumbnail
|
embed_thumbnail
|
||||||
|
download_source_images
|
||||||
download_metadata
|
download_metadata
|
||||||
embed_metadata
|
embed_metadata
|
||||||
|
download_nfo
|
||||||
shorts_behaviour
|
shorts_behaviour
|
||||||
livestream_behaviour
|
livestream_behaviour
|
||||||
preferred_resolution
|
preferred_resolution
|
||||||
@@ -30,19 +32,21 @@ defmodule Pinchflat.Profiles.MediaProfile do
|
|||||||
field :name, :string
|
field :name, :string
|
||||||
|
|
||||||
field :output_path_template, :string,
|
field :output_path_template, :string,
|
||||||
default: "/{{ source_custom_name }}/{{ title }}/{{ title }} [{{ id }}].{{ ext }}"
|
default: "/{{ source_custom_name }}/{{ upload_yyyy_mm_dd }} {{ title }}/{{ title }} [{{ id }}].{{ ext }}"
|
||||||
|
|
||||||
field :download_subs, :boolean, default: true
|
field :download_subs, :boolean, default: false
|
||||||
field :download_auto_subs, :boolean, default: true
|
field :download_auto_subs, :boolean, default: false
|
||||||
field :embed_subs, :boolean, default: true
|
field :embed_subs, :boolean, default: false
|
||||||
field :sub_langs, :string, default: "en"
|
field :sub_langs, :string, default: "en"
|
||||||
|
|
||||||
field :download_thumbnail, :boolean, default: true
|
field :download_thumbnail, :boolean, default: false
|
||||||
field :embed_thumbnail, :boolean, default: true
|
field :embed_thumbnail, :boolean, default: false
|
||||||
|
field :download_source_images, :boolean, default: false
|
||||||
|
|
||||||
field :download_metadata, :boolean, default: true
|
field :download_metadata, :boolean, default: false
|
||||||
field :embed_metadata, :boolean, default: true
|
field :embed_metadata, :boolean, default: false
|
||||||
|
|
||||||
|
field :download_nfo, :boolean, default: false
|
||||||
# NOTE: these do NOT speed up indexing - the indexer still has to go
|
# NOTE: these do NOT speed up indexing - the indexer still has to go
|
||||||
# through the entire collection to determine if a media is a short or
|
# through the entire collection to determine if a media is a short or
|
||||||
# a livestream.
|
# a livestream.
|
||||||
@@ -65,6 +69,12 @@ defmodule Pinchflat.Profiles.MediaProfile do
|
|||||||
media_profile
|
media_profile
|
||||||
|> cast(attrs, @allowed_fields)
|
|> cast(attrs, @allowed_fields)
|
||||||
|> validate_required(@required_fields)
|
|> validate_required(@required_fields)
|
||||||
|
# Ensures it ends with `.{{ ext }}` or `.%(ext)s` or similar (with a little wiggle room)
|
||||||
|
|> validate_format(:output_path_template, ext_regex(), message: "must end with .{{ ext }}")
|
||||||
|> unique_constraint(:name)
|
|> unique_constraint(:name)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
defp ext_regex do
|
||||||
|
~r/\.({{ ?ext ?}}|%\( ?ext ?\)[sS])$/
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,133 +0,0 @@
|
|||||||
defmodule Pinchflat.Profiles.Options.YtDlp.DownloadOptionBuilder do
|
|
||||||
@moduledoc """
|
|
||||||
Builds the options for yt-dlp to download media based on the given media profile.
|
|
||||||
|
|
||||||
IDEA: consider making this a behaviour so I can add other backends later
|
|
||||||
"""
|
|
||||||
|
|
||||||
alias Pinchflat.Media.MediaItem
|
|
||||||
alias Pinchflat.Profiles.Options.YtDlp.OutputPathBuilder
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Builds the options for yt-dlp to download media based on the given media's profile.
|
|
||||||
|
|
||||||
IDEA: consider adding the ability to pass in a second argument to override
|
|
||||||
these options
|
|
||||||
"""
|
|
||||||
def build(%MediaItem{} = media_item_with_preloads) do
|
|
||||||
media_profile = media_item_with_preloads.source.media_profile
|
|
||||||
|
|
||||||
built_options =
|
|
||||||
default_options() ++
|
|
||||||
subtitle_options(media_profile) ++
|
|
||||||
thumbnail_options(media_profile) ++
|
|
||||||
metadata_options(media_profile) ++
|
|
||||||
quality_options(media_profile) ++
|
|
||||||
output_options(media_item_with_preloads)
|
|
||||||
|
|
||||||
{:ok, built_options}
|
|
||||||
end
|
|
||||||
|
|
||||||
defp default_options do
|
|
||||||
[:no_progress, :windows_filenames]
|
|
||||||
end
|
|
||||||
|
|
||||||
defp subtitle_options(media_profile) do
|
|
||||||
mapped_struct = Map.from_struct(media_profile)
|
|
||||||
|
|
||||||
Enum.reduce(mapped_struct, [], fn attr, acc ->
|
|
||||||
case {attr, media_profile} do
|
|
||||||
{{:download_subs, true}, _} ->
|
|
||||||
# Force SRT for now - MAY provide as an option in the future
|
|
||||||
acc ++ [:write_subs, convert_subs: "srt"]
|
|
||||||
|
|
||||||
{{:download_auto_subs, true}, %{download_subs: true}} ->
|
|
||||||
acc ++ [:write_auto_subs]
|
|
||||||
|
|
||||||
{{:embed_subs, true}, %{preferred_resolution: pr}} when pr != :audio ->
|
|
||||||
acc ++ [:embed_subs]
|
|
||||||
|
|
||||||
{{:sub_langs, sub_langs}, %{download_subs: true}} ->
|
|
||||||
acc ++ [sub_langs: sub_langs]
|
|
||||||
|
|
||||||
{{:sub_langs, sub_langs}, %{embed_subs: true}} ->
|
|
||||||
acc ++ [sub_langs: sub_langs]
|
|
||||||
|
|
||||||
_ ->
|
|
||||||
acc
|
|
||||||
end
|
|
||||||
end)
|
|
||||||
end
|
|
||||||
|
|
||||||
defp thumbnail_options(media_profile) do
|
|
||||||
mapped_struct = Map.from_struct(media_profile)
|
|
||||||
|
|
||||||
Enum.reduce(mapped_struct, [], fn attr, acc ->
|
|
||||||
case {attr, media_profile} do
|
|
||||||
{{:download_thumbnail, true}, _} ->
|
|
||||||
acc ++ [:write_thumbnail]
|
|
||||||
|
|
||||||
{{:embed_thumbnail, true}, %{preferred_resolution: pr}} when pr != :audio ->
|
|
||||||
acc ++ [:embed_thumbnail]
|
|
||||||
|
|
||||||
_ ->
|
|
||||||
acc
|
|
||||||
end
|
|
||||||
end)
|
|
||||||
end
|
|
||||||
|
|
||||||
defp metadata_options(media_profile) do
|
|
||||||
mapped_struct = Map.from_struct(media_profile)
|
|
||||||
|
|
||||||
Enum.reduce(mapped_struct, [], fn attr, acc ->
|
|
||||||
case {attr, media_profile} do
|
|
||||||
{{:download_metadata, true}, _} ->
|
|
||||||
acc ++ [:write_info_json, :clean_info_json]
|
|
||||||
|
|
||||||
{{:embed_metadata, true}, %{preferred_resolution: pr}} when pr != :audio ->
|
|
||||||
acc ++ [:embed_metadata]
|
|
||||||
|
|
||||||
_ ->
|
|
||||||
acc
|
|
||||||
end
|
|
||||||
end)
|
|
||||||
end
|
|
||||||
|
|
||||||
defp quality_options(media_profile) do
|
|
||||||
codec_options = "+codec:avc:m4a"
|
|
||||||
|
|
||||||
case media_profile.preferred_resolution do
|
|
||||||
# Also be aware that :audio disabled all embedding options for thumbnails, subtitles, and metadata
|
|
||||||
:audio -> [format_sort: "ext", format: "bestaudio"]
|
|
||||||
:"360p" -> [format_sort: "res:360,#{codec_options}"]
|
|
||||||
:"480p" -> [format_sort: "res:480,#{codec_options}"]
|
|
||||||
:"720p" -> [format_sort: "res:720,#{codec_options}"]
|
|
||||||
:"1080p" -> [format_sort: "res:1080,#{codec_options}"]
|
|
||||||
:"1440p" -> [format_sort: "res:1440,#{codec_options}"]
|
|
||||||
:"2160p" -> [format_sort: "res:2160,#{codec_options}"]
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
defp output_options(media_item_with_preloads) do
|
|
||||||
media_profile = media_item_with_preloads.source.media_profile
|
|
||||||
additional_options_map = output_options_map(media_item_with_preloads)
|
|
||||||
{:ok, output_path} = OutputPathBuilder.build(media_profile.output_path_template, additional_options_map)
|
|
||||||
|
|
||||||
[
|
|
||||||
output: Path.join(base_directory(), output_path)
|
|
||||||
]
|
|
||||||
end
|
|
||||||
|
|
||||||
defp output_options_map(media_item_with_preloads) do
|
|
||||||
source = media_item_with_preloads.source
|
|
||||||
|
|
||||||
%{
|
|
||||||
"source_custom_name" => source.custom_name,
|
|
||||||
"source_collection_type" => source.collection_type
|
|
||||||
}
|
|
||||||
end
|
|
||||||
|
|
||||||
defp base_directory do
|
|
||||||
Application.get_env(:pinchflat, :media_directory)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -5,6 +5,10 @@ defmodule Pinchflat.Release do
|
|||||||
"""
|
"""
|
||||||
@app :pinchflat
|
@app :pinchflat
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias Pinchflat.Filesystem.FilesystemHelpers
|
||||||
|
|
||||||
def migrate do
|
def migrate do
|
||||||
load_app()
|
load_app()
|
||||||
|
|
||||||
@@ -18,6 +22,36 @@ defmodule Pinchflat.Release do
|
|||||||
{:ok, _, _} = Ecto.Migrator.with_repo(repo, &Ecto.Migrator.run(&1, :down, to: version))
|
{:ok, _, _} = Ecto.Migrator.with_repo(repo, &Ecto.Migrator.run(&1, :down, to: version))
|
||||||
end
|
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, :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
|
defp repos do
|
||||||
Application.fetch_env!(@app, :ecto_repos)
|
Application.fetch_env!(@app, :ecto_repos)
|
||||||
end
|
end
|
||||||
@@ -25,4 +59,31 @@ defmodule Pinchflat.Release do
|
|||||||
defp load_app do
|
defp load_app do
|
||||||
Application.load(@app)
|
Application.load(@app)
|
||||||
end
|
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
|
end
|
||||||
|
|||||||
+2
-2
@@ -1,4 +1,4 @@
|
|||||||
defmodule Pinchflat.Utils.FilesystemUtils.FileFollowerServer do
|
defmodule Pinchflat.SlowIndexing.FileFollowerServer do
|
||||||
@moduledoc """
|
@moduledoc """
|
||||||
A GenServer that watches a file for new lines and processes them as they come in.
|
A GenServer that watches a file for new lines and processes them as they come in.
|
||||||
This is useful for tailing log files and other similar tasks. If there's no activity
|
This is useful for tailing log files and other similar tasks. If there's no activity
|
||||||
@@ -9,7 +9,7 @@ defmodule Pinchflat.Utils.FilesystemUtils.FileFollowerServer do
|
|||||||
require Logger
|
require Logger
|
||||||
|
|
||||||
@poll_interval_ms Application.compile_env(:pinchflat, :file_watcher_poll_interval)
|
@poll_interval_ms Application.compile_env(:pinchflat, :file_watcher_poll_interval)
|
||||||
@activity_timeout_ms 60_000
|
@activity_timeout_ms 600_000
|
||||||
|
|
||||||
# Client API
|
# Client API
|
||||||
@doc """
|
@doc """
|
||||||
@@ -0,0 +1,123 @@
|
|||||||
|
defmodule Pinchflat.SlowIndexing.MediaCollectionIndexingWorker do
|
||||||
|
@moduledoc false
|
||||||
|
|
||||||
|
use Oban.Worker,
|
||||||
|
queue: :media_collection_indexing,
|
||||||
|
unique: [period: :infinity, states: [:available, :scheduled, :retryable]],
|
||||||
|
tags: ["media_source", "media_collection_indexing"]
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias __MODULE__
|
||||||
|
alias Pinchflat.Tasks
|
||||||
|
alias Pinchflat.Sources
|
||||||
|
alias Pinchflat.Sources.Source
|
||||||
|
alias Pinchflat.FastIndexing.FastIndexingWorker
|
||||||
|
alias Pinchflat.SlowIndexing.SlowIndexingHelpers
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Starts the source slow indexing worker and creates a task for the source.
|
||||||
|
|
||||||
|
Returns {:ok, %Task{}} | {:error, :duplicate_job} | {:error, %Ecto.Changeset{}}
|
||||||
|
"""
|
||||||
|
def kickoff_with_task(source, opts \\ []) do
|
||||||
|
%{id: source.id}
|
||||||
|
|> MediaCollectionIndexingWorker.new(opts)
|
||||||
|
|> Tasks.create_job_with_task(source)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
The ID is that of a source _record_, not a YouTube channel/playlist ID. Indexes
|
||||||
|
the provided source, kicks off downloads for each new MediaItem, and
|
||||||
|
reschedules the job to run again in the future. It will ALWAYS index a source
|
||||||
|
if it's never been indexed before, but rescheduling is determined by the
|
||||||
|
`index_frequency_minutes` field.
|
||||||
|
|
||||||
|
README: Re-scheduling here works a little different than you may expect.
|
||||||
|
The reschedule time is relative to the time the job has actually _completed_.
|
||||||
|
This has some benefits but also side effects to be aware of:
|
||||||
|
|
||||||
|
- Benefit: No chance for jobs to overlap if a job takes longer than the
|
||||||
|
scheduled interval. Less likely to hit API rate limits.
|
||||||
|
- Side effect: Intervals are "soft" and _always_ walk forward. This may cause
|
||||||
|
user confusion since a 30-minute job scheduled for every hour will
|
||||||
|
actually run every 1 hour and 30 minutes. The tradeoff of not inundating
|
||||||
|
the API with requests and also not overlapping jobs is worth it, IMO.
|
||||||
|
|
||||||
|
Order of operations:
|
||||||
|
1. The user saves a source
|
||||||
|
2. This job is automatically scheduled immediately. This happens in all cases.
|
||||||
|
3. This job indexes all content for the given source. A download job is
|
||||||
|
enqueued for each media item that should be downloaded. This can be impacted
|
||||||
|
by the `download_media` field on the source as well as the profile's
|
||||||
|
shorts/livestream behaviour. At this step we also attach a file reader
|
||||||
|
to the `yt-dlp` output file so we can create media items as they come in
|
||||||
|
for a little speedup (see {Fast,Slow}IndexingHelpers comments for more)
|
||||||
|
4. If this job is meant to reschedule (ie: has an index frequency > 0),
|
||||||
|
it reschedules itself. If not, it runs once and does not reschedule
|
||||||
|
5. If the source uses fast indexing, that job is kicked off as well. It
|
||||||
|
uses RSS to run a smaller, faster, and more frequent index. That job
|
||||||
|
handles rescheduling itself but largely has a similar behaviour to this
|
||||||
|
job in that it kicks off index and maybe download jobs. The biggest difference
|
||||||
|
is that an index job is kicked off _for each new media item_ as opposed
|
||||||
|
to one larger index job. Check out `MediaIndexingWorker` comments for more.
|
||||||
|
6. If the job reschedules, the cycle from step 3 repeats until the heat death
|
||||||
|
of the universe. The user changing things like the index frequency can
|
||||||
|
dequeue or reschedule jobs as well
|
||||||
|
|
||||||
|
NOTE: Since indexing can take a LONG time, I should check what happens if an
|
||||||
|
application restart occurs while a job is running. Will the job be lost?
|
||||||
|
|
||||||
|
Returns :ok | {:ok, %Task{}}
|
||||||
|
"""
|
||||||
|
@impl Oban.Worker
|
||||||
|
def perform(%Oban.Job{args: %{"id" => source_id}}) do
|
||||||
|
source = Sources.get_source!(source_id)
|
||||||
|
|
||||||
|
case {source.index_frequency_minutes, source.last_indexed_at} do
|
||||||
|
{index_freq, _} when index_freq > 0 ->
|
||||||
|
# If the indexing is on a schedule simply run indexing and reschedule
|
||||||
|
SlowIndexingHelpers.index_and_enqueue_download_for_media_items(source)
|
||||||
|
maybe_enqueue_fast_indexing_task(source)
|
||||||
|
reschedule_indexing(source)
|
||||||
|
|
||||||
|
{_, nil} ->
|
||||||
|
# If the source has never been indexed, index it once
|
||||||
|
# even if it's not meant to reschedule
|
||||||
|
SlowIndexingHelpers.index_and_enqueue_download_for_media_items(source)
|
||||||
|
:ok
|
||||||
|
|
||||||
|
_ ->
|
||||||
|
# If the source HAS been indexed and is not meant to reschedule,
|
||||||
|
# perform a no-op
|
||||||
|
:ok
|
||||||
|
end
|
||||||
|
rescue
|
||||||
|
Ecto.NoResultsError -> Logger.info("#{__MODULE__} discarded: source #{source_id} not found")
|
||||||
|
Ecto.StaleEntryError -> Logger.info("#{__MODULE__} discarded: source #{source_id} stale")
|
||||||
|
end
|
||||||
|
|
||||||
|
defp reschedule_indexing(source) do
|
||||||
|
next_run_in = source.index_frequency_minutes * 60
|
||||||
|
|
||||||
|
%{id: source.id}
|
||||||
|
|> MediaCollectionIndexingWorker.new(schedule_in: next_run_in)
|
||||||
|
|> Tasks.create_job_with_task(source)
|
||||||
|
|> case do
|
||||||
|
{:ok, task} -> {:ok, task}
|
||||||
|
{:error, :duplicate_job} -> {:ok, :job_exists}
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp maybe_enqueue_fast_indexing_task(source) do
|
||||||
|
if source.fast_index do
|
||||||
|
Tasks.delete_pending_tasks_for(source, "FastIndexingWorker")
|
||||||
|
|
||||||
|
next_run_in = Source.fast_index_frequency() * 60
|
||||||
|
|
||||||
|
%{id: source.id}
|
||||||
|
|> FastIndexingWorker.new(schedule_in: next_run_in)
|
||||||
|
|> Tasks.create_job_with_task(source)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,140 @@
|
|||||||
|
defmodule Pinchflat.SlowIndexing.SlowIndexingHelpers do
|
||||||
|
@moduledoc """
|
||||||
|
Methods for performing slow indexing tasks and managing the indexing process.
|
||||||
|
|
||||||
|
Many of these methods are made to be kickoff or be consumed by workers.
|
||||||
|
"""
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias Pinchflat.Repo
|
||||||
|
alias Pinchflat.Media
|
||||||
|
alias Pinchflat.Tasks
|
||||||
|
alias Pinchflat.Sources
|
||||||
|
alias Pinchflat.Sources.Source
|
||||||
|
alias Pinchflat.Media.MediaItem
|
||||||
|
alias Pinchflat.YtDlp.MediaCollection
|
||||||
|
alias Pinchflat.Downloading.DownloadingHelpers
|
||||||
|
alias Pinchflat.SlowIndexing.FileFollowerServer
|
||||||
|
alias Pinchflat.Downloading.MediaDownloadWorker
|
||||||
|
alias Pinchflat.SlowIndexing.MediaCollectionIndexingWorker
|
||||||
|
|
||||||
|
alias Pinchflat.YtDlp.Media, as: YtDlpMedia
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Starts tasks for indexing a source's media regardless of the source's indexing
|
||||||
|
frequency. It's assumed the caller will check for indexing frequency.
|
||||||
|
|
||||||
|
Returns {:ok, %Task{}}.
|
||||||
|
"""
|
||||||
|
def kickoff_indexing_task(%Source{} = source) do
|
||||||
|
Tasks.delete_pending_tasks_for(source, "FastIndexingWorker")
|
||||||
|
Tasks.delete_pending_tasks_for(source, "MediaIndexingWorker")
|
||||||
|
Tasks.delete_pending_tasks_for(source, "MediaCollectionIndexingWorker")
|
||||||
|
|
||||||
|
MediaCollectionIndexingWorker.kickoff_with_task(source)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Given a media source, creates (indexes) the media by creating media_items for each
|
||||||
|
media ID in the source. Afterward, kicks off a download task for each pending media
|
||||||
|
item belonging to the source. You can't tell me the method name isn't descriptive!
|
||||||
|
Returns a list of media items or changesets (if the media item couldn't be created).
|
||||||
|
|
||||||
|
Indexing is slow and usually returns a list of all media data at once for record creation.
|
||||||
|
To help with this, we use a file follower to watch the file that yt-dlp writes to
|
||||||
|
so we can create media items as they come in. This parallelizes the process and adds
|
||||||
|
clarity to the user experience. This has a few things to be aware of which are documented
|
||||||
|
below in the file watcher setup method.
|
||||||
|
|
||||||
|
NOTE: downloads are only enqueued if the source is set to download media. Downloads are
|
||||||
|
also enqueued for ALL pending media items, not just the ones that were indexed in this
|
||||||
|
job run. This should ensure that any stragglers are caught if, for some reason, they
|
||||||
|
weren't enqueued or somehow got de-queued.
|
||||||
|
|
||||||
|
Since indexing returns all media data EVERY TIME, we that that opportunity to update
|
||||||
|
indexing metadata for media items that have already been created.
|
||||||
|
|
||||||
|
Returns [%MediaItem{} | %Ecto.Changeset{}]
|
||||||
|
"""
|
||||||
|
def index_and_enqueue_download_for_media_items(%Source{} = source) 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 ->
|
||||||
|
case Media.create_media_item_from_backend_attrs(source, media_attrs) do
|
||||||
|
{:ok, media_item} -> media_item
|
||||||
|
{:error, changeset} -> changeset
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
|
||||||
|
Sources.update_source(source, %{last_indexed_at: DateTime.utc_now()})
|
||||||
|
DownloadingHelpers.enqueue_pending_download_tasks(source)
|
||||||
|
|
||||||
|
result
|
||||||
|
end
|
||||||
|
|
||||||
|
# The file follower is a GenServer that watches a file for new lines and
|
||||||
|
# processes them. This works well, but we have to be resilliant to partially-written
|
||||||
|
# lines (ie: you should gracefully fail if you can't parse a line).
|
||||||
|
#
|
||||||
|
# This works in-tandem with the normal (blocking) media indexing behaviour. When
|
||||||
|
# the `get_media_attributes_for_collection` method completes it'll return the FULL result to
|
||||||
|
# the caller for parsing. Ideally, every item in the list will have already
|
||||||
|
# been processed by the file follower, but if not, the caller handles creation
|
||||||
|
# of any media items that were missed/initially failed.
|
||||||
|
#
|
||||||
|
# It attempts a graceful shutdown of the file follower after the indexing is done,
|
||||||
|
# but the FileFollowerServer will also stop itself if it doesn't see any activity
|
||||||
|
# for a sufficiently long time.
|
||||||
|
defp get_media_attributes_for_collection_and_setup_file_watcher(source) do
|
||||||
|
{:ok, pid} = FileFollowerServer.start_link()
|
||||||
|
|
||||||
|
handler = fn filepath -> setup_file_follower_watcher(pid, filepath, source) end
|
||||||
|
result = MediaCollection.get_media_attributes_for_collection(source.original_url, file_listener_handler: handler)
|
||||||
|
|
||||||
|
FileFollowerServer.stop(pid)
|
||||||
|
|
||||||
|
result
|
||||||
|
end
|
||||||
|
|
||||||
|
defp setup_file_follower_watcher(pid, filepath, source) do
|
||||||
|
FileFollowerServer.watch_file(pid, filepath, fn line ->
|
||||||
|
case Phoenix.json_library().decode(line) do
|
||||||
|
{:ok, media_attrs} ->
|
||||||
|
Logger.debug("FileFollowerServer Handler: Got media attributes: #{inspect(media_attrs)}")
|
||||||
|
|
||||||
|
media_struct = YtDlpMedia.response_to_struct(media_attrs)
|
||||||
|
create_media_item_and_enqueue_download(source, media_struct)
|
||||||
|
|
||||||
|
err ->
|
||||||
|
Logger.debug("FileFollowerServer Handler: Error decoding JSON: #{inspect(err)}")
|
||||||
|
|
||||||
|
err
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
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
|
||||||
|
Logger.debug("FileFollowerServer Handler: Enqueuing download task for #{inspect(media_attrs)}")
|
||||||
|
|
||||||
|
MediaDownloadWorker.kickoff_with_task(media_item)
|
||||||
|
end
|
||||||
|
|
||||||
|
{:error, changeset} ->
|
||||||
|
changeset
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -1,200 +0,0 @@
|
|||||||
defmodule Pinchflat.Sources do
|
|
||||||
@moduledoc """
|
|
||||||
The Sources context.
|
|
||||||
"""
|
|
||||||
|
|
||||||
import Ecto.Query, warn: false
|
|
||||||
alias Pinchflat.Repo
|
|
||||||
|
|
||||||
alias Pinchflat.Media
|
|
||||||
alias Pinchflat.Tasks
|
|
||||||
alias Pinchflat.Sources.Source
|
|
||||||
alias Pinchflat.Tasks.SourceTasks
|
|
||||||
alias Pinchflat.Profiles.MediaProfile
|
|
||||||
alias Pinchflat.MediaClient.SourceDetails
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Returns the list of sources. Returns [%Source{}, ...]
|
|
||||||
"""
|
|
||||||
def list_sources do
|
|
||||||
Repo.all(Source)
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Returns the list of sources for a media_profile.
|
|
||||||
|
|
||||||
Returns [%Source{}, ...]
|
|
||||||
"""
|
|
||||||
def list_sources_for(%MediaProfile{} = media_profile) do
|
|
||||||
Repo.all(from s in Source, where: s.media_profile_id == ^media_profile.id)
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Gets a single source.
|
|
||||||
|
|
||||||
Returns %Source{}. Raises `Ecto.NoResultsError` if the Source does not exist.
|
|
||||||
"""
|
|
||||||
def get_source!(id), do: Repo.get!(Source, id)
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Creates a source. May attempt to pull additional source details from the
|
|
||||||
original_url (if provided). Will attempt to start indexing the source's
|
|
||||||
media if successfully inserted.
|
|
||||||
|
|
||||||
Returns {:ok, %Source{}} | {:error, %Ecto.Changeset{}}
|
|
||||||
"""
|
|
||||||
def create_source(attrs) do
|
|
||||||
%Source{}
|
|
||||||
|> change_source_from_url(attrs)
|
|
||||||
|> commit_and_handle_tasks()
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Updates a source. May attempt to pull additional source details from the
|
|
||||||
original_url (if changed). May attempt to start indexing the source's
|
|
||||||
media if the indexing frequency has been changed.
|
|
||||||
|
|
||||||
Existing indexing tasks will be cancelled if the indexing frequency has been
|
|
||||||
changed (logic in `SourceTasks.kickoff_indexing_task`)
|
|
||||||
|
|
||||||
Returns {:ok, %Source{}} | {:error, %Ecto.Changeset{}}
|
|
||||||
"""
|
|
||||||
def update_source(%Source{} = source, attrs) do
|
|
||||||
source
|
|
||||||
|> change_source_from_url(attrs)
|
|
||||||
|> commit_and_handle_tasks()
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Deletes a source, its media items, and its associated tasks (of any state).
|
|
||||||
Can optionally delete the source's media files.
|
|
||||||
|
|
||||||
Returns {:ok, %Source{}} | {:error, %Ecto.Changeset{}}
|
|
||||||
"""
|
|
||||||
def delete_source(%Source{} = source, opts \\ []) do
|
|
||||||
delete_files = Keyword.get(opts, :delete_files, false)
|
|
||||||
|
|
||||||
source
|
|
||||||
|> Media.list_media_items_for()
|
|
||||||
|> Enum.each(fn media_item ->
|
|
||||||
Media.delete_media_item(media_item, delete_files: delete_files)
|
|
||||||
end)
|
|
||||||
|
|
||||||
Tasks.delete_tasks_for(source)
|
|
||||||
Repo.delete(source)
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Returns an `%Ecto.Changeset{}` for tracking source changes.
|
|
||||||
"""
|
|
||||||
def change_source(%Source{} = source, attrs \\ %{}) do
|
|
||||||
Source.changeset(source, attrs)
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Returns an `%Ecto.Changeset{}` for tracking source changes and additionally
|
|
||||||
fetches source details from the original_url (if provided). If the source
|
|
||||||
details cannot be fetched, an error is added to the changeset.
|
|
||||||
|
|
||||||
Note that this fetches source details as long as the `original_url` is present.
|
|
||||||
This means that it'll go for it even if a changeset is otherwise invalid. This
|
|
||||||
is pretty easy to change, but for MVP I'm not concerned.
|
|
||||||
|
|
||||||
NOTE: When operating in the ideal path, this effectively adds an API call
|
|
||||||
to the source creation/update process. Should be used only when needed.
|
|
||||||
"""
|
|
||||||
def change_source_from_url(%Source{} = source, attrs) do
|
|
||||||
case change_source(source, attrs) do
|
|
||||||
%Ecto.Changeset{changes: %{original_url: _}} = changeset ->
|
|
||||||
add_source_details_to_changeset(source, changeset)
|
|
||||||
|
|
||||||
changeset ->
|
|
||||||
changeset
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
defp add_source_details_to_changeset(source, changeset) do
|
|
||||||
%Ecto.Changeset{changes: changes} = changeset
|
|
||||||
|
|
||||||
case SourceDetails.get_source_details(changes.original_url) do
|
|
||||||
{:ok, source_details} ->
|
|
||||||
add_source_details_by_collection_type(source, changeset, source_details)
|
|
||||||
|
|
||||||
{:error, runner_error, _status_code} ->
|
|
||||||
Ecto.Changeset.add_error(
|
|
||||||
changeset,
|
|
||||||
:original_url,
|
|
||||||
"could not fetch source details from URL",
|
|
||||||
error: runner_error
|
|
||||||
)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
defp add_source_details_by_collection_type(source, changeset, source_details) do
|
|
||||||
%Ecto.Changeset{changes: changes} = changeset
|
|
||||||
|
|
||||||
collection_changes =
|
|
||||||
if source_details.playlist_id == source_details.channel_id do
|
|
||||||
%{
|
|
||||||
collection_type: :channel,
|
|
||||||
collection_id: source_details.channel_id,
|
|
||||||
collection_name: source_details.channel_name
|
|
||||||
}
|
|
||||||
else
|
|
||||||
%{
|
|
||||||
collection_type: :playlist,
|
|
||||||
collection_id: source_details.playlist_id,
|
|
||||||
collection_name: source_details.playlist_name
|
|
||||||
}
|
|
||||||
end
|
|
||||||
|
|
||||||
change_source(source, Map.merge(changes, collection_changes))
|
|
||||||
end
|
|
||||||
|
|
||||||
defp commit_and_handle_tasks(changeset) do
|
|
||||||
case Repo.insert_or_update(changeset) do
|
|
||||||
{:ok, %Source{} = source} ->
|
|
||||||
maybe_handle_media_tasks(changeset, source)
|
|
||||||
maybe_run_indexing_task(changeset, source)
|
|
||||||
|
|
||||||
err ->
|
|
||||||
err
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# If the source is NOT new (ie: updated) and the download_media flag has changed,
|
|
||||||
# enqueue or dequeue media download tasks as necessary.
|
|
||||||
defp maybe_handle_media_tasks(changeset, source) do
|
|
||||||
case {changeset.data, changeset.changes} do
|
|
||||||
{%{__meta__: %{state: :loaded}}, %{download_media: true}} ->
|
|
||||||
SourceTasks.enqueue_pending_media_tasks(source)
|
|
||||||
|
|
||||||
{%{__meta__: %{state: :loaded}}, %{download_media: false}} ->
|
|
||||||
SourceTasks.dequeue_pending_media_tasks(source)
|
|
||||||
|
|
||||||
_ ->
|
|
||||||
:ok
|
|
||||||
end
|
|
||||||
|
|
||||||
{:ok, source}
|
|
||||||
end
|
|
||||||
|
|
||||||
defp maybe_run_indexing_task(changeset, source) do
|
|
||||||
case changeset.data do
|
|
||||||
# If the changeset is new (not persisted), attempt indexing no matter what
|
|
||||||
%{__meta__: %{state: :built}} ->
|
|
||||||
SourceTasks.kickoff_indexing_task(source)
|
|
||||||
|
|
||||||
# If the record has been persisted, only run indexing if the
|
|
||||||
# indexing frequency has been changed and is now greater than 0
|
|
||||||
%{__meta__: %{state: :loaded}} ->
|
|
||||||
case changeset.changes do
|
|
||||||
%{index_frequency_minutes: mins} when mins > 0 -> SourceTasks.kickoff_indexing_task(source)
|
|
||||||
%{index_frequency_minutes: _} -> Tasks.delete_pending_tasks_for(source, "MediaIndexingWorker")
|
|
||||||
_ -> :ok
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
{:ok, source}
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -0,0 +1,119 @@
|
|||||||
|
defmodule Pinchflat.Sources.Source do
|
||||||
|
@moduledoc """
|
||||||
|
The Source schema.
|
||||||
|
"""
|
||||||
|
|
||||||
|
use Ecto.Schema
|
||||||
|
import Ecto.Changeset
|
||||||
|
import Pinchflat.Utils.ChangesetUtils
|
||||||
|
|
||||||
|
alias Pinchflat.Tasks.Task
|
||||||
|
alias Pinchflat.Media.MediaItem
|
||||||
|
alias Pinchflat.Profiles.MediaProfile
|
||||||
|
alias Pinchflat.Metadata.SourceMetadata
|
||||||
|
|
||||||
|
@allowed_fields ~w(
|
||||||
|
collection_name
|
||||||
|
collection_id
|
||||||
|
collection_type
|
||||||
|
custom_name
|
||||||
|
nfo_filepath
|
||||||
|
poster_filepath
|
||||||
|
fanart_filepath
|
||||||
|
banner_filepath
|
||||||
|
series_directory
|
||||||
|
index_frequency_minutes
|
||||||
|
fast_index
|
||||||
|
download_media
|
||||||
|
last_indexed_at
|
||||||
|
original_url
|
||||||
|
download_cutoff_date
|
||||||
|
title_filter_regex
|
||||||
|
media_profile_id
|
||||||
|
)a
|
||||||
|
|
||||||
|
# Expensive API calls are made when a source is inserted/updated so
|
||||||
|
# we want to ensure that the source is valid before making the call.
|
||||||
|
# This way, we check that the other attributes are valid before ensuring
|
||||||
|
# that all fields are valid. This is still only one DB insert but it's
|
||||||
|
# a two-stage validation process to fail fast before the API call.
|
||||||
|
@initially_required_fields ~w(
|
||||||
|
index_frequency_minutes
|
||||||
|
fast_index
|
||||||
|
download_media
|
||||||
|
original_url
|
||||||
|
media_profile_id
|
||||||
|
)a
|
||||||
|
|
||||||
|
@pre_insert_required_fields @initially_required_fields ++
|
||||||
|
~w(
|
||||||
|
custom_name
|
||||||
|
collection_name
|
||||||
|
collection_id
|
||||||
|
collection_type
|
||||||
|
)a
|
||||||
|
|
||||||
|
schema "sources" do
|
||||||
|
field :custom_name, :string
|
||||||
|
field :collection_name, :string
|
||||||
|
field :collection_id, :string
|
||||||
|
field :collection_type, Ecto.Enum, values: [:channel, :playlist]
|
||||||
|
field :index_frequency_minutes, :integer, default: 60 * 24
|
||||||
|
field :fast_index, :boolean, default: false
|
||||||
|
field :download_media, :boolean, default: true
|
||||||
|
field :last_indexed_at, :utc_datetime
|
||||||
|
# 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
|
||||||
|
|
||||||
|
has_one :metadata, SourceMetadata, on_replace: :update
|
||||||
|
|
||||||
|
has_many :tasks, Task
|
||||||
|
has_many :media_items, MediaItem, foreign_key: :source_id
|
||||||
|
|
||||||
|
timestamps(type: :utc_datetime)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc false
|
||||||
|
def changeset(source, attrs, validation_stage) do
|
||||||
|
# See above for rationale
|
||||||
|
required_fields =
|
||||||
|
if validation_stage == :initial do
|
||||||
|
@initially_required_fields
|
||||||
|
else
|
||||||
|
@pre_insert_required_fields
|
||||||
|
end
|
||||||
|
|
||||||
|
source
|
||||||
|
|> cast(attrs, @allowed_fields)
|
||||||
|
|> 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)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc false
|
||||||
|
def index_frequency_when_fast_indexing do
|
||||||
|
# 30 days in minutes
|
||||||
|
60 * 24 * 30
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc false
|
||||||
|
def fast_index_frequency do
|
||||||
|
# minutes
|
||||||
|
15
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc false
|
||||||
|
def filepath_attributes do
|
||||||
|
~w(nfo_filepath fanart_filepath poster_filepath banner_filepath)a
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,297 @@
|
|||||||
|
defmodule Pinchflat.Sources do
|
||||||
|
@moduledoc """
|
||||||
|
The Sources context.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import Ecto.Query, warn: false
|
||||||
|
alias Pinchflat.Repo
|
||||||
|
|
||||||
|
alias Pinchflat.Media
|
||||||
|
alias Pinchflat.Tasks
|
||||||
|
alias Pinchflat.Sources.Source
|
||||||
|
alias Pinchflat.Profiles.MediaProfile
|
||||||
|
alias Pinchflat.YtDlp.MediaCollection
|
||||||
|
alias Pinchflat.Metadata.SourceMetadata
|
||||||
|
alias Pinchflat.Filesystem.FilesystemHelpers
|
||||||
|
alias Pinchflat.Downloading.DownloadingHelpers
|
||||||
|
alias Pinchflat.FastIndexing.FastIndexingWorker
|
||||||
|
alias Pinchflat.SlowIndexing.SlowIndexingHelpers
|
||||||
|
alias Pinchflat.Metadata.SourceMetadataStorageWorker
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Returns the list of sources. Returns [%Source{}, ...]
|
||||||
|
"""
|
||||||
|
def list_sources do
|
||||||
|
Repo.all(Source)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Returns the list of sources for a media_profile.
|
||||||
|
|
||||||
|
Returns [%Source{}, ...]
|
||||||
|
"""
|
||||||
|
def list_sources_for(%MediaProfile{} = media_profile) do
|
||||||
|
Repo.all(from s in Source, where: s.media_profile_id == ^media_profile.id)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Gets a single source.
|
||||||
|
|
||||||
|
Returns %Source{}. Raises `Ecto.NoResultsError` if the Source does not exist.
|
||||||
|
"""
|
||||||
|
def get_source!(id), do: Repo.get!(Source, id)
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Creates a source. May attempt to pull additional source details from the
|
||||||
|
original_url (if provided). Will attempt to start indexing the source's
|
||||||
|
media if successfully inserted.
|
||||||
|
|
||||||
|
Runs an initial `change_source` check to ensure most of the source is valid
|
||||||
|
before making an expensive API call. Runs it through `Repo.insert` even
|
||||||
|
though we know it's going to fail so it picks up any addl. database errors
|
||||||
|
and fulfills our return contract.
|
||||||
|
|
||||||
|
You can pass options to control the behavior of the function:
|
||||||
|
- `run_post_commit_tasks` (default: true) - If false, the function will not
|
||||||
|
enqueue any tasks in `commit_and_handle_tasks`.
|
||||||
|
|
||||||
|
Returns {:ok, %Source{}} | {:error, %Ecto.Changeset{}}
|
||||||
|
"""
|
||||||
|
def create_source(attrs, opts \\ []) do
|
||||||
|
case change_source(%Source{}, attrs, :initial) do
|
||||||
|
%Ecto.Changeset{valid?: true} ->
|
||||||
|
%Source{}
|
||||||
|
|> maybe_change_source_from_url(attrs)
|
||||||
|
|> maybe_change_indexing_frequency()
|
||||||
|
|> commit_and_handle_tasks(opts)
|
||||||
|
|
||||||
|
changeset ->
|
||||||
|
Repo.insert(changeset)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Updates a source. May attempt to pull additional source details from the
|
||||||
|
original_url (if changed). May attempt to start indexing the source's
|
||||||
|
media if the indexing frequency has been changed.
|
||||||
|
|
||||||
|
Existing indexing tasks will be cancelled if the indexing frequency has been
|
||||||
|
changed (logic in `SlowIndexingHelpers.kickoff_indexing_task`)
|
||||||
|
|
||||||
|
Runs an initial `change_source` check to ensure most of the source is valid
|
||||||
|
before making an expensive API call. Runs it through `Repo.update` even
|
||||||
|
though we know it's going to fail so it picks up any addl. database errors
|
||||||
|
and fulfills our return contract.
|
||||||
|
|
||||||
|
You can pass options to control the behavior of the function:
|
||||||
|
- `run_post_commit_tasks` (default: true) - If false, the function will not
|
||||||
|
enqueue any tasks in `commit_and_handle_tasks`.
|
||||||
|
|
||||||
|
Returns {:ok, %Source{}} | {:error, %Ecto.Changeset{}}
|
||||||
|
"""
|
||||||
|
def update_source(%Source{} = source, attrs, opts \\ []) do
|
||||||
|
case change_source(source, attrs, :initial) do
|
||||||
|
%Ecto.Changeset{valid?: true} ->
|
||||||
|
source
|
||||||
|
|> maybe_change_source_from_url(attrs)
|
||||||
|
|> maybe_change_indexing_frequency()
|
||||||
|
|> commit_and_handle_tasks(opts)
|
||||||
|
|
||||||
|
changeset ->
|
||||||
|
Repo.update(changeset)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Deletes a source, its media items, and its associated tasks (of any state).
|
||||||
|
Can optionally delete the source's media files.
|
||||||
|
|
||||||
|
Returns {:ok, %Source{}} | {:error, %Ecto.Changeset{}}
|
||||||
|
"""
|
||||||
|
def delete_source(%Source{} = source, opts \\ []) do
|
||||||
|
delete_files = Keyword.get(opts, :delete_files, false)
|
||||||
|
Tasks.delete_tasks_for(source)
|
||||||
|
|
||||||
|
source
|
||||||
|
|> Media.list_media_items_for()
|
||||||
|
|> Enum.each(fn media_item ->
|
||||||
|
Media.delete_media_item(media_item, delete_files: delete_files)
|
||||||
|
end)
|
||||||
|
|
||||||
|
if delete_files do
|
||||||
|
delete_source_files(source)
|
||||||
|
end
|
||||||
|
|
||||||
|
delete_internal_metadata_files(source)
|
||||||
|
Repo.delete(source)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Returns an `%Ecto.Changeset{}` for tracking source changes.
|
||||||
|
"""
|
||||||
|
def change_source(%Source{} = source, attrs \\ %{}, validation_stage \\ :pre_insert) do
|
||||||
|
Source.changeset(source, attrs, validation_stage)
|
||||||
|
end
|
||||||
|
|
||||||
|
# NOTE: When operating in the ideal path, this effectively adds an API call
|
||||||
|
# to the source creation/update process. Should be used only when needed.
|
||||||
|
defp maybe_change_source_from_url(%Source{} = source, attrs) do
|
||||||
|
case change_source(source, attrs) do
|
||||||
|
%Ecto.Changeset{changes: %{original_url: _}} = changeset ->
|
||||||
|
add_source_details_to_changeset(source, changeset)
|
||||||
|
|
||||||
|
changeset ->
|
||||||
|
changeset
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp delete_source_files(source) do
|
||||||
|
mapped_struct = Map.from_struct(source)
|
||||||
|
|
||||||
|
Source.filepath_attributes()
|
||||||
|
|> Enum.map(fn field -> mapped_struct[field] end)
|
||||||
|
|> Enum.filter(&is_binary/1)
|
||||||
|
|> Enum.each(&FilesystemHelpers.delete_file_and_remove_empty_directories/1)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp delete_internal_metadata_files(source) do
|
||||||
|
metadata = Repo.preload(source, :metadata).metadata || %SourceMetadata{}
|
||||||
|
mapped_struct = Map.from_struct(metadata)
|
||||||
|
|
||||||
|
SourceMetadata.filepath_attributes()
|
||||||
|
|> Enum.map(fn field -> mapped_struct[field] end)
|
||||||
|
|> Enum.filter(&is_binary/1)
|
||||||
|
|> Enum.each(&FilesystemHelpers.delete_file_and_remove_empty_directories/1)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp add_source_details_to_changeset(source, changeset) do
|
||||||
|
case MediaCollection.get_source_details(changeset.changes.original_url) do
|
||||||
|
{:ok, source_details} ->
|
||||||
|
add_source_details_by_collection_type(source, changeset, source_details)
|
||||||
|
|
||||||
|
{:error, runner_error, _status_code} ->
|
||||||
|
Ecto.Changeset.add_error(
|
||||||
|
changeset,
|
||||||
|
:original_url,
|
||||||
|
"could not fetch source details from URL",
|
||||||
|
error: runner_error
|
||||||
|
)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp add_source_details_by_collection_type(source, changeset, source_details) do
|
||||||
|
%Ecto.Changeset{changes: changes} = changeset
|
||||||
|
|
||||||
|
collection_changes =
|
||||||
|
if source_details.playlist_id == source_details.channel_id do
|
||||||
|
%{
|
||||||
|
collection_type: :channel,
|
||||||
|
collection_id: source_details.channel_id,
|
||||||
|
collection_name: source_details.channel_name
|
||||||
|
}
|
||||||
|
else
|
||||||
|
%{
|
||||||
|
collection_type: :playlist,
|
||||||
|
collection_id: source_details.playlist_id,
|
||||||
|
collection_name: source_details.playlist_name
|
||||||
|
}
|
||||||
|
end
|
||||||
|
|
||||||
|
change_source(source, Map.merge(changes, collection_changes))
|
||||||
|
end
|
||||||
|
|
||||||
|
defp maybe_change_indexing_frequency(changeset) do
|
||||||
|
fast_index = Ecto.Changeset.get_field(changeset, :fast_index)
|
||||||
|
|
||||||
|
if fast_index do
|
||||||
|
Ecto.Changeset.put_change(
|
||||||
|
changeset,
|
||||||
|
:index_frequency_minutes,
|
||||||
|
Source.index_frequency_when_fast_indexing()
|
||||||
|
)
|
||||||
|
else
|
||||||
|
changeset
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp commit_and_handle_tasks(changeset, opts) do
|
||||||
|
run_post_commit_tasks = Keyword.get(opts, :run_post_commit_tasks, true)
|
||||||
|
|
||||||
|
case Repo.insert_or_update(changeset) do
|
||||||
|
{:ok, %Source{} = source} ->
|
||||||
|
if run_post_commit_tasks do
|
||||||
|
maybe_handle_media_tasks(changeset, source)
|
||||||
|
maybe_run_indexing_task(changeset, source)
|
||||||
|
run_metadata_storage_task(source)
|
||||||
|
end
|
||||||
|
|
||||||
|
{:ok, source}
|
||||||
|
|
||||||
|
err ->
|
||||||
|
err
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# If the source is NOT new (ie: updated) and the download_media flag has changed,
|
||||||
|
# enqueue or dequeue media download tasks as necessary.
|
||||||
|
defp maybe_handle_media_tasks(changeset, source) do
|
||||||
|
case {changeset.data, changeset.changes} do
|
||||||
|
{%{__meta__: %{state: :loaded}}, %{download_media: true}} ->
|
||||||
|
DownloadingHelpers.enqueue_pending_download_tasks(source)
|
||||||
|
|
||||||
|
{%{__meta__: %{state: :loaded}}, %{download_media: false}} ->
|
||||||
|
DownloadingHelpers.dequeue_pending_download_tasks(source)
|
||||||
|
|
||||||
|
_ ->
|
||||||
|
:ok
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp maybe_run_indexing_task(changeset, source) do
|
||||||
|
case changeset.data do
|
||||||
|
# If the changeset is new (not persisted), attempt indexing no matter what
|
||||||
|
%{__meta__: %{state: :built}} ->
|
||||||
|
SlowIndexingHelpers.kickoff_indexing_task(source)
|
||||||
|
|
||||||
|
# If the record has been persisted, only run indexing if the
|
||||||
|
# indexing frequency has been changed and is now greater than 0
|
||||||
|
%{__meta__: %{state: :loaded}} ->
|
||||||
|
maybe_update_slow_indexing_task(changeset, source)
|
||||||
|
maybe_update_fast_indexing_task(changeset, source)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# This runs every time to pick up any changes to the metadata
|
||||||
|
defp run_metadata_storage_task(source) do
|
||||||
|
SourceMetadataStorageWorker.kickoff_with_task(source)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp maybe_update_slow_indexing_task(changeset, source) do
|
||||||
|
case changeset.changes do
|
||||||
|
%{index_frequency_minutes: mins} when mins > 0 ->
|
||||||
|
SlowIndexingHelpers.kickoff_indexing_task(source)
|
||||||
|
|
||||||
|
%{index_frequency_minutes: _} ->
|
||||||
|
Tasks.delete_pending_tasks_for(source, "FastIndexingWorker")
|
||||||
|
Tasks.delete_pending_tasks_for(source, "MediaIndexingWorker")
|
||||||
|
Tasks.delete_pending_tasks_for(source, "MediaCollectionIndexingWorker")
|
||||||
|
|
||||||
|
_ ->
|
||||||
|
:ok
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp maybe_update_fast_indexing_task(changeset, source) do
|
||||||
|
case changeset.changes do
|
||||||
|
%{fast_index: true} ->
|
||||||
|
Tasks.delete_pending_tasks_for(source, "FastIndexingWorker")
|
||||||
|
FastIndexingWorker.kickoff_with_task(source)
|
||||||
|
|
||||||
|
%{fast_index: false} ->
|
||||||
|
Tasks.delete_pending_tasks_for(source, "FastIndexingWorker")
|
||||||
|
|
||||||
|
_ ->
|
||||||
|
:ok
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -1,24 +0,0 @@
|
|||||||
defmodule Pinchflat.Tasks.MediaItemTasks do
|
|
||||||
@moduledoc """
|
|
||||||
Contains methods used by OR used to create/manage tasks for media items.
|
|
||||||
|
|
||||||
Tasks/workers are meant to be thin wrappers so most of the actual work they
|
|
||||||
do is also defined here. Essentially, a one-stop-shop for media-related tasks/workers.
|
|
||||||
"""
|
|
||||||
alias Pinchflat.Media
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Fetches the file size of a media item and saves it to the database.
|
|
||||||
|
|
||||||
Returns {:ok, media_item} | {:error, any()}
|
|
||||||
"""
|
|
||||||
def compute_and_save_media_filesize(media_item) do
|
|
||||||
case File.stat(media_item.media_filepath) do
|
|
||||||
{:ok, %{size: size}} ->
|
|
||||||
Media.update_media_item(media_item, %{media_size_bytes: size})
|
|
||||||
|
|
||||||
err ->
|
|
||||||
err
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,188 +0,0 @@
|
|||||||
defmodule Pinchflat.Tasks.SourceTasks do
|
|
||||||
@moduledoc """
|
|
||||||
Contains methods used by OR used to create/manage tasks for sources.
|
|
||||||
|
|
||||||
Tasks/workers are meant to be thin wrappers so most of the actual work they
|
|
||||||
do is also defined here. Essentially, a one-stop-shop for source-related tasks/workers.
|
|
||||||
"""
|
|
||||||
|
|
||||||
require Logger
|
|
||||||
|
|
||||||
alias Pinchflat.Media
|
|
||||||
alias Pinchflat.Tasks
|
|
||||||
alias Pinchflat.Sources
|
|
||||||
alias Pinchflat.Sources.Source
|
|
||||||
alias Pinchflat.Media.MediaItem
|
|
||||||
alias Pinchflat.MediaClient.SourceDetails
|
|
||||||
alias Pinchflat.Workers.MediaIndexingWorker
|
|
||||||
alias Pinchflat.Workers.MediaDownloadWorker
|
|
||||||
alias Pinchflat.Utils.FilesystemUtils.FileFollowerServer
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Starts tasks for indexing a source's media regardless of the source's indexing
|
|
||||||
frequency. It's assumed the caller will check for that.
|
|
||||||
|
|
||||||
Returns {:ok, %Task{}}.
|
|
||||||
"""
|
|
||||||
def kickoff_indexing_task(%Source{} = source) do
|
|
||||||
Tasks.delete_pending_tasks_for(source, "MediaIndexingWorker")
|
|
||||||
|
|
||||||
source
|
|
||||||
|> Map.take([:id])
|
|
||||||
# Schedule this one immediately, but future ones will be on an interval
|
|
||||||
|> MediaIndexingWorker.new()
|
|
||||||
|> Tasks.create_job_with_task(source)
|
|
||||||
|> case do
|
|
||||||
# This should never return {:error, :duplicate_job} since we just deleted
|
|
||||||
# any pending tasks. I'm being assertive about it so it's obvious if I'm wrong
|
|
||||||
{:ok, task} -> {:ok, task}
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Given a media source, creates (indexes) the media by creating media_items for each
|
|
||||||
media ID in the source. Afterward, kicks off a download task for each pending media
|
|
||||||
item belonging to the source. You can't tell me the method name isn't descriptive!
|
|
||||||
|
|
||||||
Indexing is slow and usually returns a list of all media data at once for record creation.
|
|
||||||
To help with this, we use a file follower to watch the file that yt-dlp writes to
|
|
||||||
so we can create media items as they come in. This parallelizes the process and adds
|
|
||||||
clarity to the user experience. This has a few things to be aware of which are documented
|
|
||||||
below in the file watcher setup method.
|
|
||||||
|
|
||||||
NOTE: downloads are only enqueued if the source is set to download media. Downloads are
|
|
||||||
also enqueued for ALL pending media items, not just the ones that were indexed in this
|
|
||||||
job run. This should ensure that any stragglers are caught if, for some reason, they
|
|
||||||
weren't enqueued or somehow got de-queued.
|
|
||||||
|
|
||||||
Since indexing returns all media data EVERY TIME, we rely on the unique index of the
|
|
||||||
media_id to prevent duplicates. Due to both the file follower and the fact that future
|
|
||||||
indexing will index a lot of existing data, this method will MOSTLY return error
|
|
||||||
changesets (from the unique index violation) and not media items. This is intended.
|
|
||||||
|
|
||||||
Returns [%MediaItem{}, ...] | [%Ecto.Changeset{}, ...]
|
|
||||||
"""
|
|
||||||
def index_and_enqueue_download_for_media_items(%Source{} = source) 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_and_setup_file_watcher(source)
|
|
||||||
|
|
||||||
result = Enum.map(media_attributes, fn media_attrs -> create_media_item_from_attributes(source, media_attrs) end)
|
|
||||||
Sources.update_source(source, %{last_indexed_at: DateTime.utc_now()})
|
|
||||||
enqueue_pending_media_tasks(source)
|
|
||||||
|
|
||||||
result
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Starts tasks for downloading media for any of a sources _pending_ media items.
|
|
||||||
Jobs are not enqueued if the source is set to not download media. This will return :ok.
|
|
||||||
|
|
||||||
NOTE: this starts a download for each media item that is pending,
|
|
||||||
not just the ones that were indexed in this job run. This should ensure
|
|
||||||
that any stragglers are caught if, for some reason, they weren't enqueued
|
|
||||||
or somehow got de-queued.
|
|
||||||
|
|
||||||
Returns :ok
|
|
||||||
"""
|
|
||||||
def enqueue_pending_media_tasks(%Source{download_media: true} = source) do
|
|
||||||
source
|
|
||||||
|> Media.list_pending_media_items_for()
|
|
||||||
|> Enum.each(fn media_item ->
|
|
||||||
media_item
|
|
||||||
|> Map.take([:id])
|
|
||||||
|> MediaDownloadWorker.new()
|
|
||||||
|> Tasks.create_job_with_task(media_item)
|
|
||||||
end)
|
|
||||||
end
|
|
||||||
|
|
||||||
def enqueue_pending_media_tasks(%Source{download_media: false} = _source) do
|
|
||||||
:ok
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Deletes ALL pending tasks for a source's media items.
|
|
||||||
|
|
||||||
Returns :ok
|
|
||||||
"""
|
|
||||||
def dequeue_pending_media_tasks(%Source{} = source) do
|
|
||||||
source
|
|
||||||
|> Media.list_pending_media_items_for()
|
|
||||||
|> Enum.each(&Tasks.delete_pending_tasks_for/1)
|
|
||||||
end
|
|
||||||
|
|
||||||
# The file follower is a GenServer that watches a file for new lines and
|
|
||||||
# processes them. This works well, but we have to be resilliant to partially-written
|
|
||||||
# lines (ie: you should gracefully fail if you can't parse a line).
|
|
||||||
#
|
|
||||||
# This works in-tandem with the normal (blocking) media indexing behaviour. When
|
|
||||||
# the `get_media_attributes` method completes it'll return the FULL result to
|
|
||||||
# the caller for parsing. Ideally, every item in the list will have already
|
|
||||||
# been processed by the file follower, but if not, the caller handles creation
|
|
||||||
# of any media items that were missed/initially failed.
|
|
||||||
#
|
|
||||||
# It attempts a graceful shutdown of the file follower after the indexing is done,
|
|
||||||
# but the FileFollowerServer will also stop itself if it doesn't see any activity
|
|
||||||
# for a sufficiently long time.
|
|
||||||
defp get_media_attributes_and_setup_file_watcher(source) do
|
|
||||||
{:ok, pid} = FileFollowerServer.start_link()
|
|
||||||
|
|
||||||
handler = fn filepath -> setup_file_follower_watcher(pid, filepath, source) end
|
|
||||||
result = SourceDetails.get_media_attributes(source.original_url, file_listener_handler: handler)
|
|
||||||
|
|
||||||
FileFollowerServer.stop(pid)
|
|
||||||
|
|
||||||
result
|
|
||||||
end
|
|
||||||
|
|
||||||
defp setup_file_follower_watcher(pid, filepath, source) do
|
|
||||||
FileFollowerServer.watch_file(pid, filepath, fn line ->
|
|
||||||
case Phoenix.json_library().decode(line) do
|
|
||||||
{:ok, media_attrs} ->
|
|
||||||
Logger.debug("FileFollowerServer Handler: Got media attributes: #{inspect(media_attrs)}")
|
|
||||||
|
|
||||||
create_media_item_and_enqueue_download(source, media_attrs)
|
|
||||||
|
|
||||||
err ->
|
|
||||||
Logger.debug("FileFollowerServer Handler: Error decoding JSON: #{inspect(err)}")
|
|
||||||
|
|
||||||
err
|
|
||||||
end
|
|
||||||
end)
|
|
||||||
end
|
|
||||||
|
|
||||||
defp create_media_item_and_enqueue_download(source, media_attrs) do
|
|
||||||
maybe_media_item = create_media_item_from_attributes(source, media_attrs)
|
|
||||||
|
|
||||||
case maybe_media_item do
|
|
||||||
%MediaItem{} = media_item ->
|
|
||||||
if source.download_media && Media.pending_download?(media_item) do
|
|
||||||
Logger.debug("FileFollowerServer Handler: Enqueuing download task for #{inspect(media_attrs)}")
|
|
||||||
|
|
||||||
media_item
|
|
||||||
|> Map.take([:id])
|
|
||||||
|> MediaDownloadWorker.new()
|
|
||||||
|> Tasks.create_job_with_task(media_item)
|
|
||||||
end
|
|
||||||
|
|
||||||
changeset ->
|
|
||||||
changeset
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
defp create_media_item_from_attributes(source, media_attrs) do
|
|
||||||
attrs = %{
|
|
||||||
source_id: source.id,
|
|
||||||
title: media_attrs["title"],
|
|
||||||
media_id: media_attrs["id"],
|
|
||||||
original_url: media_attrs["original_url"],
|
|
||||||
livestream: media_attrs["was_live"],
|
|
||||||
description: media_attrs["description"]
|
|
||||||
}
|
|
||||||
|
|
||||||
case Media.create_media_item(attrs) do
|
|
||||||
{:ok, media_item} -> media_item
|
|
||||||
{:error, changeset} -> changeset
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -22,9 +22,15 @@ defmodule Pinchflat.Tasks do
|
|||||||
|
|
||||||
Returns [%Task{}, ...]
|
Returns [%Task{}, ...]
|
||||||
"""
|
"""
|
||||||
def list_tasks_for(attached_record_type, attached_record_id, worker_name \\ nil, job_states \\ Oban.Job.states()) do
|
def list_tasks_for(record, worker_name \\ nil, job_states \\ Oban.Job.states()) do
|
||||||
stringified_states = Enum.map(job_states, &to_string/1)
|
stringified_states = Enum.map(job_states, &to_string/1)
|
||||||
|
|
||||||
|
record_type =
|
||||||
|
case record do
|
||||||
|
%Source{} -> :source_id
|
||||||
|
%MediaItem{} -> :media_item_id
|
||||||
|
end
|
||||||
|
|
||||||
worker_name_finder =
|
worker_name_finder =
|
||||||
if worker_name do
|
if worker_name do
|
||||||
# Workers are the full module name - we want to match on the string ENDING with
|
# Workers are the full module name - we want to match on the string ENDING with
|
||||||
@@ -41,7 +47,7 @@ defmodule Pinchflat.Tasks do
|
|||||||
Repo.all(
|
Repo.all(
|
||||||
from t in Task,
|
from t in Task,
|
||||||
join: j in assoc(t, :job),
|
join: j in assoc(t, :job),
|
||||||
where: field(t, ^attached_record_type) == ^attached_record_id,
|
where: field(t, ^record_type) == ^record.id,
|
||||||
where: ^worker_name_finder,
|
where: ^worker_name_finder,
|
||||||
where: j.state in ^stringified_states
|
where: j.state in ^stringified_states
|
||||||
)
|
)
|
||||||
@@ -53,10 +59,9 @@ defmodule Pinchflat.Tasks do
|
|||||||
|
|
||||||
Returns [%Task{}, ...]
|
Returns [%Task{}, ...]
|
||||||
"""
|
"""
|
||||||
def list_pending_tasks_for(attached_record_type, attached_record_id, worker_name \\ nil) do
|
def list_pending_tasks_for(record, worker_name \\ nil) do
|
||||||
list_tasks_for(
|
list_tasks_for(
|
||||||
attached_record_type,
|
record,
|
||||||
attached_record_id,
|
|
||||||
worker_name,
|
worker_name,
|
||||||
[:available, :scheduled, :retryable]
|
[:available, :scheduled, :retryable]
|
||||||
)
|
)
|
||||||
@@ -126,14 +131,10 @@ defmodule Pinchflat.Tasks do
|
|||||||
|
|
||||||
Returns :ok
|
Returns :ok
|
||||||
"""
|
"""
|
||||||
def delete_tasks_for(attached_record, worker_name \\ nil) do
|
def delete_tasks_for(record, worker_name \\ nil) do
|
||||||
tasks =
|
record
|
||||||
case attached_record do
|
|> list_tasks_for(worker_name)
|
||||||
%Source{} = source -> list_tasks_for(:source_id, source.id, worker_name)
|
|> Enum.each(&delete_task/1)
|
||||||
%MediaItem{} = media_item -> list_tasks_for(:media_item_id, media_item.id, worker_name)
|
|
||||||
end
|
|
||||||
|
|
||||||
Enum.each(tasks, &delete_task/1)
|
|
||||||
end
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
@@ -142,14 +143,10 @@ defmodule Pinchflat.Tasks do
|
|||||||
|
|
||||||
Returns :ok
|
Returns :ok
|
||||||
"""
|
"""
|
||||||
def delete_pending_tasks_for(attached_record, worker_name \\ nil) do
|
def delete_pending_tasks_for(record, worker_name \\ nil) do
|
||||||
tasks =
|
record
|
||||||
case attached_record do
|
|> list_pending_tasks_for(worker_name)
|
||||||
%Source{} = source -> list_pending_tasks_for(:source_id, source.id, worker_name)
|
|> Enum.each(&delete_task/1)
|
||||||
%MediaItem{} = media_item -> list_pending_tasks_for(:media_item_id, media_item.id, worker_name)
|
|
||||||
end
|
|
||||||
|
|
||||||
Enum.each(tasks, &delete_task/1)
|
|
||||||
end
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
defmodule Pinchflat.Utils.FilesystemUtils do
|
|
||||||
@moduledoc """
|
|
||||||
Utility methods for working with the filesystem
|
|
||||||
"""
|
|
||||||
|
|
||||||
alias Pinchflat.Utils.StringUtils
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Generates a temporary file and returns its path. The file is empty and has the given type.
|
|
||||||
Generates all the directories in the path if they don't exist.
|
|
||||||
|
|
||||||
Returns binary()
|
|
||||||
"""
|
|
||||||
def generate_metadata_tmpfile(type) do
|
|
||||||
tmpfile_directory = Application.get_env(:pinchflat, :tmpfile_directory)
|
|
||||||
filepath = Path.join([tmpfile_directory, "#{StringUtils.random_string(64)}.#{type}"])
|
|
||||||
|
|
||||||
:ok = File.mkdir_p!(Path.dirname(filepath))
|
|
||||||
:ok = File.write(filepath, "")
|
|
||||||
|
|
||||||
filepath
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
defmodule Pinchflat.Workers.FilesystemDataWorker do
|
|
||||||
@moduledoc false
|
|
||||||
|
|
||||||
use Oban.Worker,
|
|
||||||
queue: :media_local_metadata,
|
|
||||||
tags: ["media_item", "media_metadata", "local_metadata"],
|
|
||||||
max_attempts: 1
|
|
||||||
|
|
||||||
alias Pinchflat.Media
|
|
||||||
alias Pinchflat.Tasks.MediaItemTasks
|
|
||||||
|
|
||||||
@impl Oban.Worker
|
|
||||||
@doc """
|
|
||||||
For a given media item, compute and save metadata about the file on-disk.
|
|
||||||
|
|
||||||
Returns :ok
|
|
||||||
"""
|
|
||||||
def perform(%Oban.Job{args: %{"id" => media_item_id}}) do
|
|
||||||
media_item = Media.get_media_item!(media_item_id)
|
|
||||||
|
|
||||||
MediaItemTasks.compute_and_save_media_filesize(media_item)
|
|
||||||
|
|
||||||
# Don't retry on failure - if it didn't work immediately there's no
|
|
||||||
# reason to believe it will work later.
|
|
||||||
:ok
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,72 +0,0 @@
|
|||||||
defmodule Pinchflat.Workers.MediaIndexingWorker do
|
|
||||||
@moduledoc false
|
|
||||||
|
|
||||||
use Oban.Worker,
|
|
||||||
queue: :media_indexing,
|
|
||||||
unique: [period: :infinity, states: [:available, :scheduled, :retryable]],
|
|
||||||
tags: ["media_source", "media_indexing"]
|
|
||||||
|
|
||||||
alias __MODULE__
|
|
||||||
alias Pinchflat.Tasks
|
|
||||||
alias Pinchflat.Sources
|
|
||||||
alias Pinchflat.Tasks.SourceTasks
|
|
||||||
|
|
||||||
@impl Oban.Worker
|
|
||||||
@doc """
|
|
||||||
The ID is that of a source _record_, not a YouTube channel/playlist ID. Indexes
|
|
||||||
the provided source, kicks off downloads for each new MediaItem, and
|
|
||||||
reschedules the job to run again in the future. It will ALWAYS index a source
|
|
||||||
if it's never been indexed before, but rescheduling is determined by the
|
|
||||||
`index_frequency_minutes` field.
|
|
||||||
|
|
||||||
README: Re-scheduling here works a little different than you may expect.
|
|
||||||
The reschedule time is relative to the time the job has actually _completed_.
|
|
||||||
This has some benefits but also side effects to be aware of:
|
|
||||||
|
|
||||||
- Benefit: No chance for jobs to overlap if a job takes longer than the
|
|
||||||
scheduled interval. Less likely to hit API rate limits.
|
|
||||||
- Side effect: Intervals are "soft" and _always_ walk forward. This may cause
|
|
||||||
user confusion since a 30-minute job scheduled for every hour will
|
|
||||||
actually run every 1 hour and 30 minutes. The tradeoff of not inundating
|
|
||||||
the API with requests and also not overlapping jobs is worth it, IMO.
|
|
||||||
|
|
||||||
NOTE: Since indexing can take a LONG time, I should check what happens if an
|
|
||||||
application restart occurs while a job is running. Will the job be lost?
|
|
||||||
|
|
||||||
IDEA: Should I use paging and do indexing in chunks? Is that even faster?
|
|
||||||
|
|
||||||
Returns :ok | {:ok, %Task{}}
|
|
||||||
"""
|
|
||||||
def perform(%Oban.Job{args: %{"id" => source_id}}) do
|
|
||||||
source = Sources.get_source!(source_id)
|
|
||||||
|
|
||||||
case {source.index_frequency_minutes, source.last_indexed_at} do
|
|
||||||
{index_freq, _} when index_freq > 0 ->
|
|
||||||
# If the indexing is on a schedule simply run indexing and reschedule
|
|
||||||
SourceTasks.index_and_enqueue_download_for_media_items(source)
|
|
||||||
reschedule_indexing(source)
|
|
||||||
|
|
||||||
{_, nil} ->
|
|
||||||
# If the source has never been indexed, index it once
|
|
||||||
# even if it's not meant to reschedule
|
|
||||||
SourceTasks.index_and_enqueue_download_for_media_items(source)
|
|
||||||
:ok
|
|
||||||
|
|
||||||
_ ->
|
|
||||||
# If the source HAS been indexed and is not meant to reschedule,
|
|
||||||
# perform a no-op
|
|
||||||
:ok
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
defp reschedule_indexing(source) do
|
|
||||||
source
|
|
||||||
|> Map.take([:id])
|
|
||||||
|> MediaIndexingWorker.new(schedule_in: source.index_frequency_minutes * 60)
|
|
||||||
|> Tasks.create_job_with_task(source)
|
|
||||||
|> case do
|
|
||||||
{:ok, task} -> {:ok, task}
|
|
||||||
{:error, :duplicate_job} -> {:ok, :job_exists}
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
+5
-2
@@ -1,6 +1,9 @@
|
|||||||
defmodule Pinchflat.MediaClient.Backends.BackendCommandRunner do
|
defmodule Pinchflat.YtDlp.BackendCommandRunner do
|
||||||
@moduledoc """
|
@moduledoc """
|
||||||
A behaviour for running CLI commands against a downloader backend
|
A behaviour for running CLI commands against a downloader backend (yt-dlp).
|
||||||
|
|
||||||
|
Used so we can implement Mox for testing without actually running the
|
||||||
|
yt-dlp command.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
@callback run(binary(), keyword(), binary()) :: {:ok, binary()} | {:error, binary(), integer()}
|
@callback run(binary(), keyword(), binary()) :: {:ok, binary()} | {:error, binary(), integer()}
|
||||||
+6
-4
@@ -1,4 +1,4 @@
|
|||||||
defmodule Pinchflat.MediaClient.Backends.YtDlp.CommandRunner do
|
defmodule Pinchflat.YtDlp.CommandRunner do
|
||||||
@moduledoc """
|
@moduledoc """
|
||||||
Runs yt-dlp commands using the `System.cmd/3` function
|
Runs yt-dlp commands using the `System.cmd/3` function
|
||||||
"""
|
"""
|
||||||
@@ -6,8 +6,8 @@ defmodule Pinchflat.MediaClient.Backends.YtDlp.CommandRunner do
|
|||||||
require Logger
|
require Logger
|
||||||
|
|
||||||
alias Pinchflat.Utils.StringUtils
|
alias Pinchflat.Utils.StringUtils
|
||||||
alias Pinchflat.Utils.FilesystemUtils, as: FSUtils
|
alias Pinchflat.Filesystem.FilesystemHelpers, as: FSUtils
|
||||||
alias Pinchflat.MediaClient.Backends.BackendCommandRunner
|
alias Pinchflat.YtDlp.BackendCommandRunner
|
||||||
|
|
||||||
@behaviour BackendCommandRunner
|
@behaviour BackendCommandRunner
|
||||||
|
|
||||||
@@ -25,6 +25,7 @@ defmodule Pinchflat.MediaClient.Backends.YtDlp.CommandRunner do
|
|||||||
"""
|
"""
|
||||||
@impl BackendCommandRunner
|
@impl BackendCommandRunner
|
||||||
def run(url, command_opts, output_template, addl_opts \\ []) do
|
def run(url, command_opts, output_template, addl_opts \\ []) do
|
||||||
|
# This approach lets us mock the command for testing
|
||||||
command = backend_executable()
|
command = backend_executable()
|
||||||
# These must stay in exactly this order, hence why I'm giving it its own variable.
|
# These must stay in exactly this order, hence why I'm giving it its own variable.
|
||||||
# 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.
|
||||||
@@ -36,7 +37,8 @@ defmodule Pinchflat.MediaClient.Backends.YtDlp.CommandRunner do
|
|||||||
|
|
||||||
case System.cmd(command, formatted_command_opts, stderr_to_stdout: true) do
|
case System.cmd(command, formatted_command_opts, stderr_to_stdout: true) do
|
||||||
{_, 0} ->
|
{_, 0} ->
|
||||||
# IDEA: consider deleting the file after reading it
|
# IDEA: consider deleting the file after reading it. It's in the tmp dir, so it's not
|
||||||
|
# a huge deal, but it's still a good idea to clean up after ourselves.
|
||||||
# (even on error? especially on error?)
|
# (even on error? especially on error?)
|
||||||
File.read(output_filepath)
|
File.read(output_filepath)
|
||||||
|
|
||||||
@@ -0,0 +1,114 @@
|
|||||||
|
defmodule Pinchflat.YtDlp.Media do
|
||||||
|
@moduledoc """
|
||||||
|
Contains utilities for working with singular pieces of media
|
||||||
|
"""
|
||||||
|
|
||||||
|
@enforce_keys [
|
||||||
|
:media_id,
|
||||||
|
:title,
|
||||||
|
:description,
|
||||||
|
:original_url,
|
||||||
|
:livestream,
|
||||||
|
:short_form_content,
|
||||||
|
:upload_date
|
||||||
|
]
|
||||||
|
|
||||||
|
defstruct [
|
||||||
|
:media_id,
|
||||||
|
:title,
|
||||||
|
:description,
|
||||||
|
:original_url,
|
||||||
|
:livestream,
|
||||||
|
:short_form_content,
|
||||||
|
:upload_date
|
||||||
|
]
|
||||||
|
|
||||||
|
alias __MODULE__
|
||||||
|
alias Pinchflat.Utils.FunctionUtils
|
||||||
|
alias Pinchflat.Metadata.MetadataFileHelpers
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Downloads a single piece of media (and possibly its metadata) directly to its
|
||||||
|
final destination. Returns the parsed JSON output from yt-dlp.
|
||||||
|
|
||||||
|
Returns {:ok, map()} | {:error, any, ...}.
|
||||||
|
"""
|
||||||
|
def download(url, command_opts \\ []) do
|
||||||
|
opts = [:no_simulate] ++ command_opts
|
||||||
|
|
||||||
|
with {:ok, output} <- backend_runner().run(url, opts, "after_move:%()j"),
|
||||||
|
{:ok, parsed_json} <- Phoenix.json_library().decode(output) do
|
||||||
|
{:ok, parsed_json}
|
||||||
|
else
|
||||||
|
err -> err
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Returns a map representing the media at the given URL.
|
||||||
|
|
||||||
|
Returns {:ok, [map()]} | {:error, any, ...}.
|
||||||
|
"""
|
||||||
|
def get_media_attributes(url) do
|
||||||
|
runner = Application.get_env(:pinchflat, :yt_dlp_runner)
|
||||||
|
command_opts = [:simulate, :skip_download]
|
||||||
|
output_template = indexing_output_template()
|
||||||
|
|
||||||
|
case runner.run(url, command_opts, output_template) do
|
||||||
|
{:ok, output} ->
|
||||||
|
output
|
||||||
|
|> Phoenix.json_library().decode!()
|
||||||
|
|> response_to_struct()
|
||||||
|
|> FunctionUtils.wrap_ok()
|
||||||
|
|
||||||
|
res ->
|
||||||
|
res
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Returns the output template for yt-dlp's indexing command.
|
||||||
|
"""
|
||||||
|
def indexing_output_template do
|
||||||
|
"%(.{id,title,was_live,webpage_url,description,aspect_ratio,duration,upload_date})j"
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Transforms a response from yt-dlp into a struct. Interprets the response to
|
||||||
|
determine if the media is short-form content.
|
||||||
|
|
||||||
|
Returns %Media{}.
|
||||||
|
"""
|
||||||
|
def response_to_struct(response) do
|
||||||
|
%Media{
|
||||||
|
media_id: response["id"],
|
||||||
|
title: response["title"],
|
||||||
|
description: response["description"],
|
||||||
|
original_url: response["webpage_url"],
|
||||||
|
livestream: response["was_live"],
|
||||||
|
short_form_content: response["webpage_url"] && short_form_content?(response),
|
||||||
|
upload_date: response["upload_date"] && MetadataFileHelpers.parse_upload_date(response["upload_date"])
|
||||||
|
}
|
||||||
|
end
|
||||||
|
|
||||||
|
defp short_form_content?(response) do
|
||||||
|
if String.contains?(response["webpage_url"], "/shorts/") do
|
||||||
|
true
|
||||||
|
else
|
||||||
|
# Sometimes shorts are returned without /shorts/ in the URL,
|
||||||
|
# so we need to do our best to determine if it's a short. This
|
||||||
|
# WILL returns false positives, but it's a best-effort approach
|
||||||
|
# that should work for most cases. The aspect_ratio check is
|
||||||
|
# based on a gut feeling and may need to be tweaked.
|
||||||
|
#
|
||||||
|
# These don't fail if duration or aspect_ratio are missing
|
||||||
|
# due to Elixir's comparison semantics
|
||||||
|
response["duration"] <= 60 && response["aspect_ratio"] < 0.8
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp backend_runner do
|
||||||
|
# This approach lets us mock the command for testing
|
||||||
|
Application.get_env(:pinchflat, :yt_dlp_runner)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,127 @@
|
|||||||
|
defmodule Pinchflat.YtDlp.MediaCollection do
|
||||||
|
@moduledoc """
|
||||||
|
Contains utilities for working with collections of
|
||||||
|
media (aka: a source [ie: channels, playlists]).
|
||||||
|
"""
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias Pinchflat.Filesystem.FilesystemHelpers
|
||||||
|
alias Pinchflat.YtDlp.Media, as: YtDlpMedia
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Returns a list of maps representing the media in the collection.
|
||||||
|
|
||||||
|
Options:
|
||||||
|
- :file_listener_handler - a function that will be called with the path to the
|
||||||
|
file that will be written to when yt-dlp is done. This is useful for
|
||||||
|
setting up a file watcher to know when the file is ready to be read.
|
||||||
|
|
||||||
|
Returns {:ok, [map()]} | {:error, any, ...}.
|
||||||
|
"""
|
||||||
|
def get_media_attributes_for_collection(url, addl_opts \\ []) do
|
||||||
|
runner = Application.get_env(:pinchflat, :yt_dlp_runner)
|
||||||
|
# `ignore_no_formats_error` is necessary because yt-dlp will error out if
|
||||||
|
# the first video has not released yet (ie: is a premier). We don't care about
|
||||||
|
# available formats since we're just getting the media details
|
||||||
|
command_opts = [:simulate, :skip_download, :ignore_no_formats_error]
|
||||||
|
output_template = YtDlpMedia.indexing_output_template()
|
||||||
|
output_filepath = FilesystemHelpers.generate_metadata_tmpfile(:json)
|
||||||
|
file_listener_handler = Keyword.get(addl_opts, :file_listener_handler, false)
|
||||||
|
|
||||||
|
if file_listener_handler do
|
||||||
|
file_listener_handler.(output_filepath)
|
||||||
|
end
|
||||||
|
|
||||||
|
case runner.run(url, command_opts, output_template, output_filepath: output_filepath) do
|
||||||
|
{:ok, output} ->
|
||||||
|
parsed_lines =
|
||||||
|
output
|
||||||
|
|> String.split("\n", trim: true)
|
||||||
|
|> Enum.map(fn line ->
|
||||||
|
case Phoenix.json_library().decode(line) do
|
||||||
|
{:ok, parsed_json} ->
|
||||||
|
YtDlpMedia.response_to_struct(parsed_json)
|
||||||
|
|
||||||
|
_ ->
|
||||||
|
nil
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
|
||||||
|
{:ok, Enum.filter(parsed_lines, &(&1 != nil))}
|
||||||
|
|
||||||
|
res ->
|
||||||
|
res
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Gets a source's ID and name from its URL.
|
||||||
|
|
||||||
|
yt-dlp does not _really_ have source-specific functions that return what
|
||||||
|
we need, so instead we're fetching just the first video (using playlist_end: 1)
|
||||||
|
and parsing the source ID and name from _its_ metadata
|
||||||
|
|
||||||
|
Returns {:ok, map()} | {:error, any, ...}.
|
||||||
|
"""
|
||||||
|
def get_source_details(source_url, addl_opts \\ []) do
|
||||||
|
# `ignore_no_formats_error` is necessary because yt-dlp will error out if
|
||||||
|
# the first video has not released yet (ie: is a premier). We don't care about
|
||||||
|
# available formats since we're just getting the source details
|
||||||
|
command_opts = [:simulate, :skip_download, :ignore_no_formats_error, playlist_end: 1] ++ addl_opts
|
||||||
|
output_template = "%(.{channel,channel_id,playlist_id,playlist_title,filename})j"
|
||||||
|
|
||||||
|
with {:ok, output} <- backend_runner().run(source_url, command_opts, output_template),
|
||||||
|
{:ok, parsed_json} <- Phoenix.json_library().decode(output) do
|
||||||
|
{:ok, format_source_details(parsed_json)}
|
||||||
|
else
|
||||||
|
err -> err
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Gets a source's metadata from its URL.
|
||||||
|
|
||||||
|
This is mostly for things like getting the source's avatar and banner image
|
||||||
|
(if applicable). However, this yt-dlp call doesn't have enough overlap with
|
||||||
|
`get_source_details/1` to allow combining them - this one has _almost_ everything
|
||||||
|
we need, but it doesn't contain enough information to tell 100% if the url is a channel
|
||||||
|
or a playlist.
|
||||||
|
|
||||||
|
The main purpose of this (past using as a fetcher for _other_ metadata) is to live
|
||||||
|
as a compressed blob for possible future use. That's why it's not getting formatted like
|
||||||
|
`get_source_details/1`
|
||||||
|
|
||||||
|
Returns {:ok, map()} | {:error, any, ...}.
|
||||||
|
"""
|
||||||
|
def get_source_metadata(source_url, addl_opts \\ []) do
|
||||||
|
opts = [playlist_items: 0] ++ addl_opts
|
||||||
|
output_template = "playlist:%()j"
|
||||||
|
|
||||||
|
with {:ok, output} <- backend_runner().run(source_url, opts, output_template),
|
||||||
|
{:ok, parsed_json} <- Phoenix.json_library().decode(output) do
|
||||||
|
{:ok, parsed_json}
|
||||||
|
else
|
||||||
|
err -> err
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp format_source_details(response) do
|
||||||
|
# NOTE: I should probably make this a struct some day
|
||||||
|
%{
|
||||||
|
channel_id: response["channel_id"],
|
||||||
|
channel_name: response["channel"],
|
||||||
|
playlist_id: response["playlist_id"],
|
||||||
|
playlist_name: response["playlist_title"],
|
||||||
|
# It's not a name, it's a path dammit!
|
||||||
|
# This actually isn't used for the inital response - it's
|
||||||
|
# used later to update a source's metadata
|
||||||
|
filepath: response["filename"]
|
||||||
|
}
|
||||||
|
end
|
||||||
|
|
||||||
|
defp backend_runner do
|
||||||
|
# This approach lets us mock the command for testing
|
||||||
|
Application.get_env(:pinchflat, :yt_dlp_runner)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -54,8 +54,9 @@ defmodule PinchflatWeb do
|
|||||||
|
|
||||||
def live_view do
|
def live_view do
|
||||||
quote do
|
quote do
|
||||||
use Phoenix.LiveView,
|
use Phoenix.Component, global_prefixes: ~w(x-)
|
||||||
layout: {PinchflatWeb.Layouts, :app}
|
|
||||||
|
use Phoenix.LiveView
|
||||||
|
|
||||||
alias Pinchflat.Settings
|
alias Pinchflat.Settings
|
||||||
|
|
||||||
@@ -75,7 +76,7 @@ defmodule PinchflatWeb do
|
|||||||
|
|
||||||
def html do
|
def html do
|
||||||
quote do
|
quote do
|
||||||
use Phoenix.Component
|
use Phoenix.Component, global_prefixes: ~w(x-)
|
||||||
|
|
||||||
# Import convenience functions from controllers
|
# Import convenience functions from controllers
|
||||||
import Phoenix.Controller,
|
import Phoenix.Controller,
|
||||||
|
|||||||
@@ -40,6 +40,7 @@ defmodule PinchflatWeb.CoreComponents do
|
|||||||
"""
|
"""
|
||||||
attr :id, :string, required: true
|
attr :id, :string, required: true
|
||||||
attr :show, :boolean, default: false
|
attr :show, :boolean, default: false
|
||||||
|
attr :allow_close, :boolean, default: true
|
||||||
attr :on_cancel, JS, default: %JS{}
|
attr :on_cancel, JS, default: %JS{}
|
||||||
slot :inner_block, required: true
|
slot :inner_block, required: true
|
||||||
|
|
||||||
@@ -50,9 +51,9 @@ defmodule PinchflatWeb.CoreComponents do
|
|||||||
phx-mounted={@show && show_modal(@id)}
|
phx-mounted={@show && show_modal(@id)}
|
||||||
phx-remove={hide_modal(@id)}
|
phx-remove={hide_modal(@id)}
|
||||||
data-cancel={JS.exec(@on_cancel, "phx-remove")}
|
data-cancel={JS.exec(@on_cancel, "phx-remove")}
|
||||||
class="relative z-50 hidden"
|
class="relative z-99999 hidden"
|
||||||
>
|
>
|
||||||
<div id={"#{@id}-bg"} class="bg-zinc-50/90 fixed inset-0 transition-opacity" aria-hidden="true" />
|
<div id={"#{@id}-bg"} class="bg-black-2/80 fixed inset-0 transition-opacity" aria-hidden="true" />
|
||||||
<div
|
<div
|
||||||
class="fixed inset-0 overflow-y-auto"
|
class="fixed inset-0 overflow-y-auto"
|
||||||
aria-labelledby={"#{@id}-title"}
|
aria-labelledby={"#{@id}-title"}
|
||||||
@@ -62,28 +63,28 @@ defmodule PinchflatWeb.CoreComponents do
|
|||||||
tabindex="0"
|
tabindex="0"
|
||||||
>
|
>
|
||||||
<div class="flex min-h-full items-center justify-center">
|
<div class="flex min-h-full items-center justify-center">
|
||||||
<div class="w-full max-w-3xl p-4 sm:p-6 lg:py-8">
|
<div class="w-full max-w-3xl p-2 sm:p-6 lg:py-8">
|
||||||
<.focus_wrap
|
<div
|
||||||
id={"#{@id}-container"}
|
id={"#{@id}-container"}
|
||||||
phx-window-keydown={JS.exec("data-cancel", to: "##{@id}")}
|
phx-window-keydown={@allow_close && JS.exec("data-cancel", to: "##{@id}")}
|
||||||
phx-key="escape"
|
phx-key="escape"
|
||||||
phx-click-away={JS.exec("data-cancel", to: "##{@id}")}
|
phx-click-away={@allow_close && JS.exec("data-cancel", to: "##{@id}")}
|
||||||
class="shadow-zinc-700/10 ring-zinc-700/10 relative hidden rounded-2xl bg-white p-14 shadow-lg ring-1 transition"
|
class="shadow-zinc-700/10 ring-zinc-700/10 relative hidden rounded-2xl bg-graydark p-8 sm:p-14 shadow-lg ring-1 transition"
|
||||||
>
|
>
|
||||||
<div class="absolute top-6 right-5">
|
<div :if={@allow_close} class="absolute top-6 right-5">
|
||||||
<button
|
<button
|
||||||
phx-click={JS.exec("data-cancel", to: "##{@id}")}
|
phx-click={JS.exec("data-cancel", to: "##{@id}")}
|
||||||
type="button"
|
type="button"
|
||||||
class="-m-3 flex-none p-3 opacity-20 hover:opacity-40"
|
class="-m-3 flex-none p-3 opacity-60 hover:opacity-80"
|
||||||
aria-label={gettext("close")}
|
aria-label={gettext("close")}
|
||||||
>
|
>
|
||||||
<.icon name="hero-x-mark-solid" class="h-5 w-5" />
|
<.icon name="hero-x-mark-solid" class="h-5 w-5 text-white" />
|
||||||
</button>
|
</button>
|
||||||
</div>
|
</div>
|
||||||
<div id={"#{@id}-content"}>
|
<div id={"#{@id}-content"}>
|
||||||
<%= render_slot(@inner_block) %>
|
<%= render_slot(@inner_block) %>
|
||||||
</div>
|
</div>
|
||||||
</.focus_wrap>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
@@ -243,6 +244,7 @@ defmodule PinchflatWeb.CoreComponents do
|
|||||||
attr :id, :any, default: nil
|
attr :id, :any, default: nil
|
||||||
attr :name, :any
|
attr :name, :any
|
||||||
attr :label, :string, default: nil
|
attr :label, :string, default: nil
|
||||||
|
attr :label_suffix, :string, default: nil
|
||||||
attr :value, :any
|
attr :value, :any
|
||||||
attr :help, :string, default: nil
|
attr :help, :string, default: nil
|
||||||
|
|
||||||
@@ -294,6 +296,7 @@ defmodule PinchflatWeb.CoreComponents do
|
|||||||
{@rest}
|
{@rest}
|
||||||
/>
|
/>
|
||||||
<%= @label %>
|
<%= @label %>
|
||||||
|
<span :if={@label_suffix} class="text-xs text-bodydark"><%= @label_suffix %></span>
|
||||||
</label>
|
</label>
|
||||||
<.help :if={@help}><%= @help %></.help>
|
<.help :if={@help}><%= @help %></.help>
|
||||||
<.error :for={msg <- @errors}><%= msg %></.error>
|
<.error :for={msg <- @errors}><%= msg %></.error>
|
||||||
@@ -309,19 +312,12 @@ defmodule PinchflatWeb.CoreComponents do
|
|||||||
|
|
||||||
~H"""
|
~H"""
|
||||||
<div x-data={"{ enabled: #{@checked}}"}>
|
<div x-data={"{ enabled: #{@checked}}"}>
|
||||||
<.label for={@id}><%= @label %></.label>
|
<.label for={@id}>
|
||||||
|
<%= @label %>
|
||||||
|
<span :if={@label_suffix} class="text-xs text-bodydark"><%= @label_suffix %></span>
|
||||||
|
</.label>
|
||||||
<div class="relative">
|
<div class="relative">
|
||||||
<input type="hidden" name={@name} value="false" />
|
<input type="hidden" id={@id} name={@name} x-bind:value="enabled" {@rest} />
|
||||||
<input
|
|
||||||
type="checkbox"
|
|
||||||
id={@id}
|
|
||||||
name={@name}
|
|
||||||
value="true"
|
|
||||||
x-bind:checked="enabled"
|
|
||||||
class="sr-only"
|
|
||||||
@change="enabled = !enabled"
|
|
||||||
{@rest}
|
|
||||||
/>
|
|
||||||
<div class="inline-block cursor-pointer" @click="enabled = !enabled">
|
<div class="inline-block cursor-pointer" @click="enabled = !enabled">
|
||||||
<div x-bind:class="enabled && '!bg-primary'" class="block h-8 w-14 rounded-full bg-black"></div>
|
<div x-bind:class="enabled && '!bg-primary'" class="block h-8 w-14 rounded-full bg-black"></div>
|
||||||
<div
|
<div
|
||||||
@@ -343,21 +339,26 @@ defmodule PinchflatWeb.CoreComponents do
|
|||||||
def input(%{type: "select"} = assigns) do
|
def input(%{type: "select"} = assigns) do
|
||||||
~H"""
|
~H"""
|
||||||
<div phx-feedback-for={@name}>
|
<div phx-feedback-for={@name}>
|
||||||
<.label for={@id}><%= @label %></.label>
|
<.label :if={@label} for={@id}>
|
||||||
<select
|
<%= @label %><span :if={@label_suffix} class="text-xs text-bodydark"><%= @label_suffix %></span>
|
||||||
id={@id}
|
</.label>
|
||||||
name={@name}
|
<div class="flex">
|
||||||
class={[
|
<select
|
||||||
"relative z-20 w-full appearance-none rounded border border-stroke bg-transparent py-3 pl-5 pr-12 outline-none transition",
|
id={@id}
|
||||||
"focus:border-primary active:border-primary dark:border-form-strokedark dark:bg-form-input text-black dark:text-white",
|
name={@name}
|
||||||
@inputclass
|
class={[
|
||||||
]}
|
"relative z-20 w-full appearance-none rounded border border-stroke bg-transparent py-3 pl-5 pr-12 outline-none transition",
|
||||||
multiple={@multiple}
|
"focus:border-primary active:border-primary dark:border-form-strokedark dark:bg-form-input text-black dark:text-white",
|
||||||
{@rest}
|
@inputclass
|
||||||
>
|
]}
|
||||||
<option :if={@prompt} value=""><%= @prompt %></option>
|
multiple={@multiple}
|
||||||
<%= Phoenix.HTML.Form.options_for_select(@options, @value) %>
|
{@rest}
|
||||||
</select>
|
>
|
||||||
|
<option :if={@prompt} value=""><%= @prompt %></option>
|
||||||
|
<%= Phoenix.HTML.Form.options_for_select(@options, @value) %>
|
||||||
|
</select>
|
||||||
|
<%= render_slot(@inner_block) %>
|
||||||
|
</div>
|
||||||
<.help :if={@help}><%= @help %></.help>
|
<.help :if={@help}><%= @help %></.help>
|
||||||
<.error :for={msg <- @errors}><%= msg %></.error>
|
<.error :for={msg <- @errors}><%= msg %></.error>
|
||||||
</div>
|
</div>
|
||||||
@@ -367,7 +368,9 @@ defmodule PinchflatWeb.CoreComponents do
|
|||||||
def input(%{type: "textarea"} = assigns) do
|
def input(%{type: "textarea"} = assigns) do
|
||||||
~H"""
|
~H"""
|
||||||
<div phx-feedback-for={@name}>
|
<div phx-feedback-for={@name}>
|
||||||
<.label for={@id}><%= @label %></.label>
|
<.label for={@id}>
|
||||||
|
<%= @label %><span :if={@label_suffix} class="text-xs text-bodydark"><%= @label_suffix %></span>
|
||||||
|
</.label>
|
||||||
<textarea
|
<textarea
|
||||||
id={@id}
|
id={@id}
|
||||||
name={@name}
|
name={@name}
|
||||||
@@ -390,7 +393,9 @@ defmodule PinchflatWeb.CoreComponents do
|
|||||||
def input(assigns) do
|
def input(assigns) do
|
||||||
~H"""
|
~H"""
|
||||||
<div phx-feedback-for={@name}>
|
<div phx-feedback-for={@name}>
|
||||||
<.label for={@id}><%= @label %></.label>
|
<.label for={@id}>
|
||||||
|
<%= @label %><span :if={@label_suffix} class="text-xs text-bodydark"><%= @label_suffix %></span>
|
||||||
|
</.label>
|
||||||
<input
|
<input
|
||||||
type={@type}
|
type={@type}
|
||||||
name={@name}
|
name={@name}
|
||||||
@@ -586,9 +591,14 @@ defmodule PinchflatWeb.CoreComponents do
|
|||||||
def list_items_from_map(assigns) do
|
def list_items_from_map(assigns) do
|
||||||
attrs =
|
attrs =
|
||||||
Enum.filter(assigns.map, fn
|
Enum.filter(assigns.map, fn
|
||||||
{_, %{__struct__: _}} -> false
|
{_, %{__struct__: s}} when s not in [Date, DateTime] ->
|
||||||
{_, [%{__meta__: _} | _]} -> false
|
false
|
||||||
_ -> true
|
|
||||||
|
{_, [%{__meta__: _} | _]} ->
|
||||||
|
false
|
||||||
|
|
||||||
|
_ ->
|
||||||
|
true
|
||||||
end)
|
end)
|
||||||
|
|
||||||
assigns = assign(assigns, iterable_attributes: attrs)
|
assigns = assign(assigns, iterable_attributes: attrs)
|
||||||
@@ -608,15 +618,15 @@ defmodule PinchflatWeb.CoreComponents do
|
|||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
<.back navigate={~p"/posts"}>Back to posts</.back>
|
<.back href={~p"/posts"}>Back to posts</.back>
|
||||||
"""
|
"""
|
||||||
attr :navigate, :any, required: true
|
attr :href, :any, required: true
|
||||||
slot :inner_block, required: true
|
slot :inner_block, required: true
|
||||||
|
|
||||||
def back(assigns) do
|
def back(assigns) do
|
||||||
~H"""
|
~H"""
|
||||||
<div class="mt-16">
|
<div class="mt-16">
|
||||||
<.link navigate={@navigate} class="text-sm font-semibold leading-6 text-zinc-900 hover:text-zinc-700">
|
<.link href={@href} class="text-sm font-semibold leading-6 text-zinc-900 hover:text-zinc-700">
|
||||||
<.icon name="hero-arrow-left-solid" class="h-3 w-3" />
|
<.icon name="hero-arrow-left-solid" class="h-3 w-3" />
|
||||||
<%= render_slot(@inner_block) %>
|
<%= render_slot(@inner_block) %>
|
||||||
</.link>
|
</.link>
|
||||||
@@ -685,7 +695,6 @@ defmodule PinchflatWeb.CoreComponents do
|
|||||||
)
|
)
|
||||||
|> show("##{id}-container")
|
|> show("##{id}-container")
|
||||||
|> JS.add_class("overflow-hidden", to: "body")
|
|> JS.add_class("overflow-hidden", to: "body")
|
||||||
|> JS.focus_first(to: "##{id}-content")
|
|
||||||
end
|
end
|
||||||
|
|
||||||
def hide_modal(js \\ %JS{}, id) do
|
def hide_modal(js \\ %JS{}, id) do
|
||||||
@@ -697,7 +706,6 @@ defmodule PinchflatWeb.CoreComponents do
|
|||||||
|> hide("##{id}-container")
|
|> hide("##{id}-container")
|
||||||
|> JS.hide(to: "##{id}", transition: {"block", "block", "hidden"})
|
|> JS.hide(to: "##{id}", transition: {"block", "block", "hidden"})
|
||||||
|> JS.remove_class("overflow-hidden", to: "body")
|
|> JS.remove_class("overflow-hidden", to: "body")
|
||||||
|> JS.pop_focus()
|
|
||||||
end
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
|
|||||||
@@ -14,7 +14,9 @@ defmodule PinchflatWeb.CustomComponents.ButtonComponents do
|
|||||||
attr :color, :string, default: "bg-primary"
|
attr :color, :string, default: "bg-primary"
|
||||||
attr :rounding, :string, default: "rounded-sm"
|
attr :rounding, :string, default: "rounded-sm"
|
||||||
attr :class, :string, default: ""
|
attr :class, :string, default: ""
|
||||||
|
attr :type, :string, default: "submit"
|
||||||
attr :disabled, :boolean, default: false
|
attr :disabled, :boolean, default: false
|
||||||
|
attr :rest, :global
|
||||||
|
|
||||||
slot :inner_block, required: true
|
slot :inner_block, required: true
|
||||||
|
|
||||||
@@ -26,9 +28,12 @@ defmodule PinchflatWeb.CustomComponents.ButtonComponents do
|
|||||||
"#{@rounding} inline-flex items-center justify-center px-8 py-4",
|
"#{@rounding} inline-flex items-center justify-center px-8 py-4",
|
||||||
"#{@color}",
|
"#{@color}",
|
||||||
"hover:bg-opacity-90 lg:px-8 xl:px-10",
|
"hover:bg-opacity-90 lg:px-8 xl:px-10",
|
||||||
|
"disabled:bg-opacity-50 disabled:cursor-not-allowed disabled:text-grey-5",
|
||||||
@class
|
@class
|
||||||
]}
|
]}
|
||||||
|
type={@type}
|
||||||
disabled={@disabled}
|
disabled={@disabled}
|
||||||
|
{@rest}
|
||||||
>
|
>
|
||||||
<%= render_slot(@inner_block) %>
|
<%= render_slot(@inner_block) %>
|
||||||
</button>
|
</button>
|
||||||
|
|||||||
@@ -31,6 +31,20 @@ defmodule PinchflatWeb.CustomComponents.TextComponents do
|
|||||||
"""
|
"""
|
||||||
end
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Renders a subtle link with the given href and content.
|
||||||
|
"""
|
||||||
|
attr :href, :string, required: true
|
||||||
|
slot :inner_block
|
||||||
|
|
||||||
|
def subtle_link(assigns) do
|
||||||
|
~H"""
|
||||||
|
<.link href={@href} class="underline decoration-bodydark decoration-1 hover:decoration-white">
|
||||||
|
<%= render_slot(@inner_block) %>
|
||||||
|
</.link>
|
||||||
|
"""
|
||||||
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Renders an icon as a link with the given href.
|
Renders an icon as a link with the given href.
|
||||||
"""
|
"""
|
||||||
|
|||||||
@@ -6,14 +6,16 @@ defmodule PinchflatWeb.Layouts do
|
|||||||
|
|
||||||
attr :icon, :string, required: true
|
attr :icon, :string, required: true
|
||||||
attr :text, :string, required: true
|
attr :text, :string, required: true
|
||||||
attr :navigate, :any, required: true
|
attr :href, :any, required: true
|
||||||
|
attr :target, :any, default: "_self"
|
||||||
|
|
||||||
def sidebar_item(assigns) do
|
def sidebar_item(assigns) do
|
||||||
# I'm testing out grouping classes here. Tentative order: font, layout, color, animation, state-modifiers
|
# I'm testing out grouping classes here. Tentative order: font, layout, color, animation, state-modifiers
|
||||||
~H"""
|
~H"""
|
||||||
<li>
|
<li>
|
||||||
<.link
|
<.link
|
||||||
navigate={@navigate}
|
href={@href}
|
||||||
|
target={@target}
|
||||||
class={[
|
class={[
|
||||||
"font-medium text-bodydark1",
|
"font-medium text-bodydark1",
|
||||||
"group relative flex items-center gap-2.5 rounded-sm px-4 py-2 duration-300 ease-in-out",
|
"group relative flex items-center gap-2.5 rounded-sm px-4 py-2 duration-300 ease-in-out",
|
||||||
|
|||||||
@@ -1,10 +1,9 @@
|
|||||||
<div class="flex h-screen overflow-hidden">
|
<div class="flex h-screen overflow-hidden">
|
||||||
<div class="relative flex flex-1 flex-col overflow-y-auto overflow-x-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">
|
<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>
|
||||||
</div>
|
</div>
|
||||||
</header>
|
</header>
|
||||||
|
|||||||
@@ -0,0 +1,26 @@
|
|||||||
|
<.modal id="donate-modal" allow_close={true}>
|
||||||
|
<section x-data="{ inputValue: '' }">
|
||||||
|
<h3 class="text-2xl text-white">Donate</h3>
|
||||||
|
<p class="text-sm">Thank you for your support :)</p>
|
||||||
|
<p class="mt-4">
|
||||||
|
If you find the project valuable and want to support its development, a
|
||||||
|
<.inline_link href="https://www.paypal.me/kieraneglin">donation</.inline_link>
|
||||||
|
would be greatly appreciated.
|
||||||
|
</p>
|
||||||
|
<p class="mt-4">
|
||||||
|
Plus, $5 USD from any donation over $10 USD will be donated to
|
||||||
|
<.inline_link href="https://www.eff.org/">The Electronic Frontier Foundation</.inline_link>
|
||||||
|
who defend your online liberties and backed
|
||||||
|
<.inline_code>youtube-dl</.inline_code>
|
||||||
|
when Google took them down<.inline_link href="https://github.com/github/dmca/blob/9a85e0f021f7967af80e186b890776a50443f06c/2020/11/2020-11-16-RIAA-reversal-effletter.pdf">
|
||||||
|
<.icon name="hero-arrow-top-right-on-square" class="h-3 w-3" />
|
||||||
|
</.inline_link>.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<.link href="https://www.paypal.me/kieraneglin" target="_blank">
|
||||||
|
<.button color="bg-primary" class="w-full mt-8">
|
||||||
|
Donate
|
||||||
|
</.button>
|
||||||
|
</.link>
|
||||||
|
</section>
|
||||||
|
</.modal>
|
||||||
@@ -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 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
|
<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"
|
@click.stop="sidebarVisible = !sidebarVisible"
|
||||||
>
|
>
|
||||||
<.icon name="hero-bars-3" />
|
<.icon name="hero-bars-3" />
|
||||||
</button>
|
</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>
|
||||||
<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">
|
<div class="relative">
|
||||||
<span class="absolute left-2 top-1/2 -translate-y-1/2 flex">
|
<span class="absolute left-2 top-1/2 -translate-y-1/2 flex">
|
||||||
<.icon name="hero-magnifying-glass" />
|
<.icon name="hero-magnifying-glass" />
|
||||||
@@ -23,7 +23,7 @@
|
|||||||
name="q"
|
name="q"
|
||||||
value={@params["q"]}
|
value={@params["q"]}
|
||||||
placeholder="Type to search..."
|
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>
|
</form>
|
||||||
</div>
|
</div>
|
||||||
|
|||||||
@@ -1,31 +1,63 @@
|
|||||||
<aside
|
<aside
|
||||||
x-bind:class="sidebarVisible ? 'translate-x-0' : '-translate-x-full'"
|
x-bind:class="sidebarVisible ? 'translate-x-0' : '-translate-x-full'"
|
||||||
class={[
|
class={[
|
||||||
"-translate-x-full absolute left-0 top-0 z-9999 flex h-screen w-60 flex-col overflow-y-hidden",
|
"-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"
|
"bg-black duration-300 ease-linear shadow-lg sm:shadow-none dark:bg-boxdark lg:static lg:translate-x-0"
|
||||||
]}
|
]}
|
||||||
@click.outside="sidebarVisible = false"
|
@click.outside="sidebarVisible = false"
|
||||||
>
|
>
|
||||||
<div class="flex items-center justify-between gap-2 px-6 py-5.5 lg:py-6.5">
|
<section>
|
||||||
<a href="/" class="flex items-center">
|
<div class="flex items-center justify-between gap-2 px-6 py-4">
|
||||||
<img src={~p"/images/logo.png?cachebust=2024-02-29"} alt="Pinchflat" class="w-9 h-9" />
|
<a href="/" class="flex items-center">
|
||||||
<h2 class="text-xl font-bold text-white pl-2">Pinchflat</h2>
|
<img src={~p"/images/logo.png?cachebust=2024-03-20"} alt="Pinchflat" class="w-auto" />
|
||||||
</a>
|
</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" />
|
<.icon name="hero-arrow-left" class="fill-current" />
|
||||||
</button>
|
</button>
|
||||||
</div>
|
</div>
|
||||||
<div class="no-scrollbar flex flex-col overflow-y-auto duration-300 ease-linear">
|
<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">
|
||||||
<div>
|
|
||||||
<h3 class="mb-4 ml-4 text-sm font-medium text-bodydark2">MENU</h3>
|
<h3 class="mb-4 ml-4 text-sm font-medium text-bodydark2">MENU</h3>
|
||||||
<ul class="mb-6 flex flex-col gap-1.5">
|
<div class="flex flex-col justify-between">
|
||||||
<.sidebar_item icon="hero-home" text="Home" navigate={~p"/"} />
|
<ul class="mb-6 flex flex-col gap-1.5">
|
||||||
<.sidebar_item icon="hero-tv" text="Sources" navigate={~p"/sources"} />
|
<.sidebar_item icon="hero-home" text="Home" href={~p"/"} />
|
||||||
<.sidebar_item icon="hero-adjustments-vertical" text="Media Profiles" navigate={~p"/media_profiles"} />
|
<.sidebar_item icon="hero-tv" text="Sources" href={~p"/sources"} />
|
||||||
</ul>
|
<.sidebar_item icon="hero-adjustments-vertical" text="Media Profiles" href={~p"/media_profiles"} />
|
||||||
</div>
|
</ul>
|
||||||
|
</div>
|
||||||
|
</nav>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
<section>
|
||||||
|
<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"
|
||||||
|
target="_blank"
|
||||||
|
href="https://github.com/kieraneglin/pinchflat"
|
||||||
|
/>
|
||||||
|
<li>
|
||||||
|
<span
|
||||||
|
class={[
|
||||||
|
"font-medium text-bodydark1",
|
||||||
|
"group relative flex items-center gap-2.5 rounded-sm px-4 py-2 duration-300 ease-in-out",
|
||||||
|
"duration-300 ease-in-out cursor-pointer",
|
||||||
|
"hover:bg-graydark dark:hover:bg-meta-4"
|
||||||
|
]}
|
||||||
|
phx-click={show_modal("donate-modal")}
|
||||||
|
>
|
||||||
|
<.icon name="hero-currency-dollar" /> Donate
|
||||||
|
</span>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
</nav>
|
</nav>
|
||||||
</div>
|
</section>
|
||||||
</aside>
|
</aside>
|
||||||
|
|||||||
@@ -0,0 +1,40 @@
|
|||||||
|
defmodule Pinchflat.UpgradeButtonLive do
|
||||||
|
use PinchflatWeb, :live_view
|
||||||
|
|
||||||
|
def render(assigns) do
|
||||||
|
~H"""
|
||||||
|
<form phx-change="check_matching_text">
|
||||||
|
<.input type="text" name="unlock-pro-textbox" value="" />
|
||||||
|
</form>
|
||||||
|
|
||||||
|
<.button
|
||||||
|
class="w-full mt-4"
|
||||||
|
type="button"
|
||||||
|
disabled={@button_disabled}
|
||||||
|
phx-click={hide_modal("upgrade-modal")}
|
||||||
|
x-on:click="setTimeout(() => { proEnabled = true }, 200)"
|
||||||
|
>
|
||||||
|
Unlock Pro
|
||||||
|
</.button>
|
||||||
|
"""
|
||||||
|
end
|
||||||
|
|
||||||
|
def mount(_params, _session, socket) do
|
||||||
|
{:ok, assign(socket, :button_disabled, true)}
|
||||||
|
end
|
||||||
|
|
||||||
|
def handle_event("check_matching_text", %{"unlock-pro-textbox" => text}, socket) do
|
||||||
|
normalized_text =
|
||||||
|
text
|
||||||
|
|> String.trim()
|
||||||
|
|> String.downcase()
|
||||||
|
|
||||||
|
if normalized_text == "got it!" do
|
||||||
|
Settings.set!(:pro_enabled, true)
|
||||||
|
|
||||||
|
{:noreply, update(socket, :button_disabled, fn _ -> false end)}
|
||||||
|
else
|
||||||
|
{:noreply, update(socket, :button_disabled, fn _ -> true end)}
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,28 @@
|
|||||||
|
<.modal id="upgrade-modal" allow_close={false}>
|
||||||
|
<section>
|
||||||
|
<h3 class="text-2xl text-white">Pro Mode</h3>
|
||||||
|
<p class="text-sm">Don't worry - Pinchflat is completely free :)</p>
|
||||||
|
<p class="mt-4">
|
||||||
|
If you find the project valuable and want to support its development, a
|
||||||
|
<.inline_link href="https://www.paypal.me/kieraneglin">donation</.inline_link>
|
||||||
|
would be greatly appreciated.
|
||||||
|
</p>
|
||||||
|
<p class="mt-4">
|
||||||
|
Plus, $5 USD from any donation over $10 USD will be donated to
|
||||||
|
<.inline_link href="https://www.eff.org/">The Electronic Frontier Foundation</.inline_link>
|
||||||
|
who defend your online liberties and backed
|
||||||
|
<.inline_code>youtube-dl</.inline_code>
|
||||||
|
when Google took them down<.inline_link href="https://github.com/github/dmca/blob/9a85e0f021f7967af80e186b890776a50443f06c/2020/11/2020-11-16-RIAA-reversal-effletter.pdf">
|
||||||
|
<.icon name="hero-arrow-top-right-on-square" class="h-3 w-3" />
|
||||||
|
</.inline_link>. <strong>You do not need to donate to unlock Pro</strong>. It's just a way to say thanks!
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<p class="mt-4">
|
||||||
|
To unlock Pro, simply type
|
||||||
|
<.inline_code>got it!</.inline_code>
|
||||||
|
into the text box and press the button.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<%= live_render(@conn, Pinchflat.UpgradeButtonLive) %>
|
||||||
|
</section>
|
||||||
|
</.modal>
|
||||||
@@ -8,11 +8,23 @@
|
|||||||
<%= assigns[:page_title] || "Pinchflat" %>
|
<%= assigns[:page_title] || "Pinchflat" %>
|
||||||
</.live_title>
|
</.live_title>
|
||||||
<link phx-track-static rel="stylesheet" href={~p"/assets/app.css"} />
|
<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 defer phx-track-static type="text/javascript" src={~p"/assets/app.js"}>
|
||||||
</script>
|
</script>
|
||||||
</head>
|
</head>
|
||||||
<body x-data="{ sidebarVisible: false }" class="dark text-bodydark bg-boxdark-2">
|
<body
|
||||||
|
x-data={"{
|
||||||
|
sidebarVisible: false,
|
||||||
|
proEnabled: #{Settings.get!(:pro_enabled)},
|
||||||
|
onboarding: #{Settings.get!(:onboarding)}
|
||||||
|
}"}
|
||||||
|
class="dark text-bodydark bg-boxdark-2"
|
||||||
|
>
|
||||||
<%= @inner_content %>
|
<%= @inner_content %>
|
||||||
|
|
||||||
|
<.donate_modal conn={@conn} />
|
||||||
|
<template x-if="!proEnabled && !onboarding">
|
||||||
|
<.upgrade_modal conn={@conn} />
|
||||||
|
</template>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
<div class="mb-6 flex gap-3 flex-row items-center justify-between">
|
<div class="mb-6 flex gap-3 flex-row items-center justify-between">
|
||||||
<div class="flex gap-3 items-center">
|
<div class="flex gap-3 items-center">
|
||||||
<.link navigate={~p"/sources/#{@media_item.source_id}"}>
|
<.link href={~p"/sources/#{@media_item.source_id}"}>
|
||||||
<.icon name="hero-arrow-left" class="w-10 h-10 hover:dark:text-white" />
|
<.icon name="hero-arrow-left" class="w-10 h-10 hover:dark:text-white" />
|
||||||
</.link>
|
</.link>
|
||||||
<h2 class="text-title-md2 font-bold text-black dark:text-white ml-4">
|
<h2 class="text-title-md2 font-bold text-black dark:text-white ml-4">
|
||||||
@@ -30,7 +30,7 @@
|
|||||||
method="delete"
|
method="delete"
|
||||||
data-confirm="Are you sure you want to delete this record and all associated files on disk? This cannot be undone."
|
data-confirm="Are you sure you want to delete this record and all associated files on disk? This cannot be undone."
|
||||||
>
|
>
|
||||||
<.button color="bg-meta-1" rounding="rounded-full">
|
<.button color="bg-meta-1" rounding="rounded-lg">
|
||||||
Delete Files
|
Delete Files
|
||||||
</.button>
|
</.button>
|
||||||
</.link>
|
</.link>
|
||||||
|
|||||||
@@ -1,6 +1,8 @@
|
|||||||
defmodule PinchflatWeb.MediaProfiles.MediaProfileHTML do
|
defmodule PinchflatWeb.MediaProfiles.MediaProfileHTML do
|
||||||
use PinchflatWeb, :html
|
use PinchflatWeb, :html
|
||||||
|
|
||||||
|
alias Pinchflat.Profiles.MediaProfile
|
||||||
|
|
||||||
embed_templates "media_profile_html/*"
|
embed_templates "media_profile_html/*"
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
@@ -35,6 +37,7 @@ defmodule PinchflatWeb.MediaProfiles.MediaProfileHTML do
|
|||||||
upload_day: nil,
|
upload_day: nil,
|
||||||
upload_month: nil,
|
upload_month: nil,
|
||||||
upload_year: nil,
|
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_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 that use this profile. Either 'channel' or 'playlist'"
|
||||||
}
|
}
|
||||||
@@ -52,4 +55,25 @@ defmodule PinchflatWeb.MediaProfiles.MediaProfileHTML do
|
|||||||
duration_string
|
duration_string
|
||||||
)a
|
)a
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def preset_options do
|
||||||
|
[
|
||||||
|
{"Default", "default"},
|
||||||
|
{"Media Center (Plex, Jellyfin, Kodi, etc.)", "media_center"},
|
||||||
|
{"Music", "audio"},
|
||||||
|
{"Archiving", "archiving"}
|
||||||
|
]
|
||||||
|
end
|
||||||
|
|
||||||
|
defp default_output_template do
|
||||||
|
%MediaProfile{}.output_path_template
|
||||||
|
end
|
||||||
|
|
||||||
|
defp media_center_output_template do
|
||||||
|
"/shows/{{ source_custom_name }}/Season {{ season_from_date }}/{{ season_episode_from_date }} - {{ title }}.{{ ext }}"
|
||||||
|
end
|
||||||
|
|
||||||
|
defp audio_output_template do
|
||||||
|
"/music/{{ source_custom_name }}/{{ title }}.{{ ext }}"
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,8 +1,10 @@
|
|||||||
<div class="mb-6 flex gap-3 flex-row items-center">
|
<div class="mb-6 flex gap-3 flex-row items-center">
|
||||||
<.link navigate={~p"/media_profiles"}>
|
<.link href={~p"/media_profiles"}>
|
||||||
<.icon name="hero-arrow-left" class="w-10 h-10 hover:dark:text-white" />
|
<.icon name="hero-arrow-left" class="w-10 h-10 hover:dark:text-white" />
|
||||||
</.link>
|
</.link>
|
||||||
<h2 class="text-title-md2 font-bold text-black dark:text-white ml-4">Edit Media Profile</h2>
|
<h2 class="text-title-md2 font-bold text-black dark:text-white ml-4">
|
||||||
|
Editing "<%= @media_profile.name %>"
|
||||||
|
</h2>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="rounded-sm border border-stroke bg-white px-5 pb-2.5 pt-6 shadow-default dark:border-strokedark dark:bg-boxdark sm:px-7.5 xl:pb-1">
|
<div class="rounded-sm border border-stroke bg-white px-5 pb-2.5 pt-6 shadow-default dark:border-strokedark dark:bg-boxdark sm:px-7.5 xl:pb-1">
|
||||||
|
|||||||
@@ -3,8 +3,8 @@
|
|||||||
Media Profiles
|
Media Profiles
|
||||||
</h2>
|
</h2>
|
||||||
<nav>
|
<nav>
|
||||||
<.link navigate={~p"/media_profiles/new"}>
|
<.link href={~p"/media_profiles/new"}>
|
||||||
<.button color="bg-primary" rounding="rounded-full">
|
<.button color="bg-primary" rounding="rounded-lg">
|
||||||
<span class="font-bold text-xl mx-2">+</span> New <span class="hidden sm:inline pl-1">Media Profile</span>
|
<span class="font-bold text-xl mx-2">+</span> New <span class="hidden sm:inline pl-1">Media Profile</span>
|
||||||
</.button>
|
</.button>
|
||||||
</.link>
|
</.link>
|
||||||
@@ -16,10 +16,9 @@
|
|||||||
<div class="flex flex-col gap-10 min-w-max">
|
<div class="flex flex-col gap-10 min-w-max">
|
||||||
<.table rows={@media_profiles} table_class="text-black dark:text-white">
|
<.table rows={@media_profiles} table_class="text-black dark:text-white">
|
||||||
<:col :let={media_profile} label="Name">
|
<:col :let={media_profile} label="Name">
|
||||||
<%= media_profile.name %>
|
<.subtle_link href={~p"/media_profiles/#{media_profile.id}"}>
|
||||||
</:col>
|
<%= media_profile.name %>
|
||||||
<:col :let={media_profile} label="Output Template">
|
</.subtle_link>
|
||||||
<code class="text-sm"><%= media_profile.output_path_template %></code>
|
|
||||||
</:col>
|
</:col>
|
||||||
<:col :let={media_profile} label="Preferred Resolution">
|
<:col :let={media_profile} label="Preferred Resolution">
|
||||||
<%= media_profile.preferred_resolution %>
|
<%= media_profile.preferred_resolution %>
|
||||||
|
|||||||
+228
-101
@@ -3,116 +3,243 @@
|
|||||||
Oops, something went wrong! Please check the errors below.
|
Oops, something went wrong! Please check the errors below.
|
||||||
</.error>
|
</.error>
|
||||||
|
|
||||||
<h3 class="my-4 text-2xl text-black dark:text-white">
|
<section x-data="{ selectedPreset: null }">
|
||||||
General Options
|
<h3 class="my-4 text-2xl text-black dark:text-white">
|
||||||
</h3>
|
Use a Preset
|
||||||
<.input
|
</h3>
|
||||||
field={f[:name]}
|
<section x-data="{ selection: null }">
|
||||||
type="text"
|
<.input
|
||||||
label="Name"
|
prompt="Select preset"
|
||||||
placeholder="New Profile"
|
name="media_profile_preset"
|
||||||
help="Something descriptive. Does not impact indexing or downloading (required)"
|
value=""
|
||||||
/>
|
options={preset_options()}
|
||||||
|
type="select"
|
||||||
|
x-model="selection"
|
||||||
|
inputclass="w-full"
|
||||||
|
help="You can further customize the settings after selecting a preset. This is just a starting point"
|
||||||
|
>
|
||||||
|
<.button
|
||||||
|
class="h-13 w-2/5 lg:w-1/5 ml-2 md:ml-4"
|
||||||
|
rounding="rounded"
|
||||||
|
type="button"
|
||||||
|
x-on:click="selectedPreset = selection; selection = null"
|
||||||
|
x-bind:disabled="!selection"
|
||||||
|
>
|
||||||
|
<span x-text="selection ? 'Load' : 'Select'">Select</span><span class="hidden lg:inline ml-1">Preset</span>
|
||||||
|
</.button>
|
||||||
|
</.input>
|
||||||
|
</section>
|
||||||
|
|
||||||
<.input
|
<h3 class="mt-8 text-2xl text-black dark:text-white">
|
||||||
field={f[:output_path_template]}
|
General Options
|
||||||
type="text"
|
</h3>
|
||||||
inputclass="font-mono"
|
|
||||||
label="Output path template"
|
|
||||||
help="Must end with .{{ ext }}. See below for more details. I promise the default is good for most cases (required)"
|
|
||||||
/>
|
|
||||||
|
|
||||||
<h3 class="mt-8 text-2xl text-black dark:text-white">
|
<section x-data="{
|
||||||
Subtitle Options
|
presets: {
|
||||||
</h3>
|
default: 'Default',
|
||||||
<.input
|
media_center: 'TV Shows',
|
||||||
field={f[:download_subs]}
|
audio: 'Audio',
|
||||||
type="toggle"
|
archiving: 'Archiving'
|
||||||
label="Download Subtitles"
|
}
|
||||||
help="Downloads subtitle files alongside media file"
|
}">
|
||||||
/>
|
<.input
|
||||||
<.input
|
field={f[:name]}
|
||||||
field={f[:download_auto_subs]}
|
type="text"
|
||||||
type="toggle"
|
label="Name"
|
||||||
label="Download Autogenerated Subtitles"
|
placeholder="New Profile"
|
||||||
help="Prefers normal subs but will download autogenerated if needed"
|
help="Something descriptive. Does not impact indexing or downloading (required)"
|
||||||
/>
|
x-init="$watch('selectedPreset', p => p && ($el.value = presets[p]))"
|
||||||
<.input
|
/>
|
||||||
field={f[:embed_subs]}
|
</section>
|
||||||
type="toggle"
|
|
||||||
label="Embed Subtitles"
|
|
||||||
help="Embeds subtitles in the video file itself, if supported (recommended)"
|
|
||||||
/>
|
|
||||||
<.input
|
|
||||||
field={f[:sub_langs]}
|
|
||||||
type="text"
|
|
||||||
label="Subtitle Languages"
|
|
||||||
help="Use commas for multiple languages (eg: en,de)"
|
|
||||||
/>
|
|
||||||
|
|
||||||
<h3 class="mt-8 text-2xl text-black dark:text-white">
|
<section x-data={"{
|
||||||
Thumbnail Options
|
presets: {
|
||||||
</h3>
|
default: '#{default_output_template()}',
|
||||||
<.input
|
media_center: '#{media_center_output_template()}',
|
||||||
field={f[:download_thumbnail]}
|
audio: '#{audio_output_template()}',
|
||||||
type="toggle"
|
archiving: '#{default_output_template()}'
|
||||||
label="Download Thumbnail"
|
}
|
||||||
help="Downloads thumbnail alongside media file"
|
}"}>
|
||||||
/>
|
<.input
|
||||||
<.input
|
field={f[:output_path_template]}
|
||||||
field={f[:embed_thumbnail]}
|
type="text"
|
||||||
type="toggle"
|
inputclass="font-mono"
|
||||||
label="Embed Thumbnail"
|
label="Output path template"
|
||||||
help="Embeds thumbnail in the video file itself, if supported (recommended)"
|
help="Must end with .{{ ext }}. See below for more details. The default is good for most cases (required)"
|
||||||
/>
|
x-init="$watch('selectedPreset', p => p && ($el.value = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
<h3 class="mt-8 text-2xl text-black dark:text-white">
|
<h3 class="mt-10 text-2xl text-black dark:text-white">
|
||||||
Metadata Options
|
Subtitle Options
|
||||||
</h3>
|
</h3>
|
||||||
<.input
|
|
||||||
field={f[:download_metadata]}
|
|
||||||
type="toggle"
|
|
||||||
label="Download Metadata"
|
|
||||||
help="Downloads metadata file alongside media file"
|
|
||||||
/>
|
|
||||||
<.input
|
|
||||||
field={f[:embed_metadata]}
|
|
||||||
type="toggle"
|
|
||||||
label="Embed Metadata"
|
|
||||||
help="Embeds metadata in the video file itself, if supported (recommended)"
|
|
||||||
/>
|
|
||||||
|
|
||||||
<h3 class="mt-8 text-2xl text-black dark:text-white">
|
<section x-data="{ presets: { default: true, media_center: true, audio: false, archiving: true } }">
|
||||||
Release Format Options
|
<.input
|
||||||
</h3>
|
field={f[:download_subs]}
|
||||||
|
type="toggle"
|
||||||
|
label="Download Subtitles"
|
||||||
|
help="Downloads subtitle files alongside media file"
|
||||||
|
x-init="$watch('selectedPreset', p => p && (enabled = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
<.input
|
<section x-data="{ presets: { default: false, media_center: false, audio: false, archiving: false } }">
|
||||||
field={f[:shorts_behaviour]}
|
<.input
|
||||||
options={friendly_format_type_options()}
|
field={f[:download_auto_subs]}
|
||||||
type="select"
|
type="toggle"
|
||||||
label="Include Shorts?"
|
label="Download Autogenerated Subtitles"
|
||||||
help="Experimental. Please report any issues on GitHub"
|
help="Prefers normal subs but will download autogenerated if needed. Requires 'Download Subtitles' to be enabled"
|
||||||
/>
|
x-init="$watch('selectedPreset', p => p && (enabled = presets[p]))"
|
||||||
<.input
|
/>
|
||||||
field={f[:livestream_behaviour]}
|
</section>
|
||||||
options={friendly_format_type_options()}
|
|
||||||
type="select"
|
|
||||||
label="Include Livestreams?"
|
|
||||||
/>
|
|
||||||
|
|
||||||
<h3 class="mt-8 text-2xl text-black dark:text-white">
|
<section x-data="{ presets: { default: true, media_center: true, audio: false, archiving: true } }">
|
||||||
Quality Options
|
<.input
|
||||||
</h3>
|
field={f[:embed_subs]}
|
||||||
|
type="toggle"
|
||||||
|
label="Embed Subtitles"
|
||||||
|
help="Downloads and embeds subtitles in the media file itself, if supported. Uneffected by 'Download Subtitles' (recommended)"
|
||||||
|
x-init="$watch('selectedPreset', p => p && (enabled = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
<.input
|
<section x-data="{ presets: { default: 'en', media_center: 'en', audio: '', archiving: 'all' } }">
|
||||||
field={f[:preferred_resolution]}
|
<.input
|
||||||
options={friendly_resolution_options()}
|
field={f[:sub_langs]}
|
||||||
type="select"
|
type="text"
|
||||||
label="Preferred Resolution"
|
label="Subtitle Languages"
|
||||||
help="Will grab the closest available resolution if your preferred is not available. Setting to 'Audio Only' negates embedding options."
|
help="Use commas for multiple languages (eg: en,de)"
|
||||||
/>
|
x-init="$watch('selectedPreset', p => p && ($el.value = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
<.button class="my-10 sm:mb-7.5 w-full sm:w-auto">Save Media profile</.button>
|
<h3 class="mt-10 text-2xl text-black dark:text-white">
|
||||||
|
Thumbnail Options
|
||||||
|
</h3>
|
||||||
|
|
||||||
|
<section x-data="{ presets: { default: true, media_center: true, audio: false, archiving: true } }">
|
||||||
|
<.input
|
||||||
|
field={f[:download_thumbnail]}
|
||||||
|
type="toggle"
|
||||||
|
label="Download Thumbnail"
|
||||||
|
help="Downloads thumbnail alongside media file"
|
||||||
|
x-init="$watch('selectedPreset', p => p && (enabled = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section x-data="{ presets: { default: true, media_center: true, audio: true, archiving: true } }">
|
||||||
|
<.input
|
||||||
|
field={f[:embed_thumbnail]}
|
||||||
|
type="toggle"
|
||||||
|
label="Embed Thumbnail"
|
||||||
|
help="Downloads and embeds thumbnail in the media file itself, if supported. Uneffected by 'Download Thumbnail' (recommended)"
|
||||||
|
x-init="$watch('selectedPreset', p => p && (enabled = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<h3 class="mt-10 text-2xl text-black dark:text-white">
|
||||||
|
Metadata Options
|
||||||
|
</h3>
|
||||||
|
|
||||||
|
<section x-data="{ presets: { default: false, media_center: false, audio: false, archiving: true } }">
|
||||||
|
<.input
|
||||||
|
field={f[:download_metadata]}
|
||||||
|
type="toggle"
|
||||||
|
label="Download Metadata"
|
||||||
|
help="Downloads metadata file alongside media file"
|
||||||
|
x-init="$watch('selectedPreset', p => p && (enabled = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section x-data="{ presets: { default: true, media_center: true, audio: true, archiving: true } }">
|
||||||
|
<.input
|
||||||
|
field={f[:embed_metadata]}
|
||||||
|
type="toggle"
|
||||||
|
label="Embed Metadata"
|
||||||
|
help="Downloads and embeds metadata in the media file itself, if supported. Uneffected by 'Download Metadata' (recommended)"
|
||||||
|
x-init="$watch('selectedPreset', p => p && (enabled = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<h3 class="mt-10 text-2xl text-black dark:text-white">
|
||||||
|
Release Format Options
|
||||||
|
</h3>
|
||||||
|
|
||||||
|
<section x-data="{ presets: { default: 'include', media_center: 'exclude', audio: 'exclude', archiving: 'include' } }">
|
||||||
|
<.input
|
||||||
|
field={f[:shorts_behaviour]}
|
||||||
|
options={friendly_format_type_options()}
|
||||||
|
type="select"
|
||||||
|
label="Include Shorts"
|
||||||
|
help="Experimental. Please report any issues on GitHub"
|
||||||
|
x-init="$watch('selectedPreset', p => p && ($el.value = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section x-data="{ presets: { default: 'exclude', media_center: 'exclude', audio: 'exclude', archiving: 'include' } }">
|
||||||
|
<.input
|
||||||
|
field={f[:livestream_behaviour]}
|
||||||
|
options={friendly_format_type_options()}
|
||||||
|
type="select"
|
||||||
|
label="Include Livestreams"
|
||||||
|
help="Excludes media that comes from a past livestream"
|
||||||
|
x-init="$watch('selectedPreset', p => p && ($el.value = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<h3 class="mt-10 text-2xl text-black dark:text-white">
|
||||||
|
Quality Options
|
||||||
|
</h3>
|
||||||
|
|
||||||
|
<section x-data="{ presets: { default: '1080p', media_center: '1080p', audio: 'audio', archiving: '2160p' } }">
|
||||||
|
<.input
|
||||||
|
field={f[:preferred_resolution]}
|
||||||
|
options={friendly_resolution_options()}
|
||||||
|
type="select"
|
||||||
|
label="Preferred Resolution"
|
||||||
|
help="Will grab the closest available resolution if your preferred is not available. 'Audio Only' grabs the highest quality m4a"
|
||||||
|
x-init="$watch('selectedPreset', p => p && ($el.value = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<h3 class="mt-8 text-2xl text-black dark:text-white">
|
||||||
|
Media Center Options
|
||||||
|
</h3>
|
||||||
|
<p class="text-sm mt-2 max-w-prose">
|
||||||
|
Everything in this section is experimental - please open a GitHub issue if you see something odd.
|
||||||
|
<strong>
|
||||||
|
These options only work if this Media Profile's output template is set to split media into seasons.
|
||||||
|
</strong>
|
||||||
|
Try the "Media Center" preset if you're not sure.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<section
|
||||||
|
phx-click={show_modal("upgrade-modal")}
|
||||||
|
x-data="{ presets: { default: false, media_center: true, audio: false, archiving: false } }"
|
||||||
|
>
|
||||||
|
<.input
|
||||||
|
field={f[:download_nfo]}
|
||||||
|
type="toggle"
|
||||||
|
label="Download NFO data"
|
||||||
|
label_suffix="(pro)"
|
||||||
|
help="Downloads NFO data alongside media file for use with Jellyfin, Kodi, etc."
|
||||||
|
x-init="$watch('selectedPreset', p => p && (enabled = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section x-data="{ presets: { default: false, media_center: true, audio: false, archiving: true } }">
|
||||||
|
<.input
|
||||||
|
field={f[:download_source_images]}
|
||||||
|
type="toggle"
|
||||||
|
label="Download Series Images"
|
||||||
|
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" rounding="rounded-lg">Save Media profile</.button>
|
||||||
|
</section>
|
||||||
|
|
||||||
<div class="rounded-sm dark:bg-meta-4 p-4 md:p-6 mb-5">
|
<div class="rounded-sm dark:bg-meta-4 p-4 md:p-6 mb-5">
|
||||||
<.output_template_help />
|
<.output_template_help />
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
<div class="mb-6 flex gap-3 flex-row items-center">
|
<div class="mb-6 flex gap-3 flex-row items-center">
|
||||||
<.link :if={!Settings.get!(:onboarding)} navigate={~p"/media_profiles"}>
|
<.link :if={!Settings.get!(:onboarding)} href={~p"/media_profiles"}>
|
||||||
<.icon name="hero-arrow-left" class="w-10 h-10 hover:dark:text-white" />
|
<.icon name="hero-arrow-left" class="w-10 h-10 hover:dark:text-white" />
|
||||||
</.link>
|
</.link>
|
||||||
<h2 class="text-title-md2 font-bold text-black dark:text-white ml-4">New Media Profile</h2>
|
<h2 class="text-title-md2 font-bold text-black dark:text-white ml-4">New Media Profile</h2>
|
||||||
|
|||||||
@@ -1,16 +1,16 @@
|
|||||||
<div class="mb-6 flex gap-3 flex-row items-center justify-between">
|
<div class="mb-6 flex gap-3 flex-row items-center justify-between">
|
||||||
<div class="flex items-center">
|
<div class="flex items-center">
|
||||||
<.link navigate={~p"/media_profiles"}>
|
<.link href={~p"/media_profiles"}>
|
||||||
<.icon name="hero-arrow-left" class="w-10 h-10 hover:dark:text-white" />
|
<.icon name="hero-arrow-left" class="w-10 h-10 hover:dark:text-white" />
|
||||||
</.link>
|
</.link>
|
||||||
<h2 class="text-title-md2 font-bold text-black dark:text-white ml-2">
|
<h2 class="text-title-md2 font-bold text-black dark:text-white ml-2">
|
||||||
Media Profile <span class="hidden sm:inline">#<%= @media_profile.id %></span>
|
<%= @media_profile.name %>
|
||||||
</h2>
|
</h2>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav>
|
<nav>
|
||||||
<.link navigate={~p"/media_profiles/#{@media_profile}/edit"}>
|
<.link href={~p"/media_profiles/#{@media_profile}/edit"}>
|
||||||
<.button color="bg-primary" rounding="rounded-full">
|
<.button color="bg-primary" rounding="rounded-lg">
|
||||||
<.icon name="hero-pencil-square" class="mr-2" />Edit <span class="hidden sm:inline pl-1">Media Profile</span>
|
<.icon name="hero-pencil-square" class="mr-2" />Edit <span class="hidden sm:inline pl-1">Media Profile</span>
|
||||||
</.button>
|
</.button>
|
||||||
</.link>
|
</.link>
|
||||||
@@ -31,7 +31,7 @@
|
|||||||
method="delete"
|
method="delete"
|
||||||
data-confirm="Are you sure you want to delete this profile and all its sources (leaving files in place)? This cannot be undone."
|
data-confirm="Are you sure you want to delete this profile and all its sources (leaving files in place)? This cannot be undone."
|
||||||
>
|
>
|
||||||
<.button color="bg-meta-1" rounding="rounded-full">
|
<.button color="bg-meta-1" rounding="rounded-lg">
|
||||||
Delete Profile and its Sources
|
Delete Profile and its Sources
|
||||||
</.button>
|
</.button>
|
||||||
</.link>
|
</.link>
|
||||||
@@ -41,7 +41,7 @@
|
|||||||
data-confirm="Are you sure you want to delete this profile, all its sources, and its files on disk? This cannot be undone."
|
data-confirm="Are you sure you want to delete this profile, all its sources, and its files on disk? This cannot be undone."
|
||||||
class="mt-5 md:mt-0"
|
class="mt-5 md:mt-0"
|
||||||
>
|
>
|
||||||
<.button color="bg-meta-1" rounding="rounded-full">
|
<.button color="bg-meta-1" rounding="rounded-lg">
|
||||||
Delete Profile, Sources, and Files
|
Delete Profile, Sources, and Files
|
||||||
</.button>
|
</.button>
|
||||||
</.link>
|
</.link>
|
||||||
|
|||||||
@@ -8,38 +8,34 @@ defmodule PinchflatWeb.Pages.PageController do
|
|||||||
alias Pinchflat.Profiles.MediaProfile
|
alias Pinchflat.Profiles.MediaProfile
|
||||||
|
|
||||||
def home(conn, params) do
|
def home(conn, params) do
|
||||||
force_onboarding = params["onboarding"]
|
done_onboarding = params["onboarding"] == "0"
|
||||||
media_profiles_exist = Repo.exists?(MediaProfile)
|
force_onboarding = params["onboarding"] == "1"
|
||||||
sources_exist = Repo.exists?(Source)
|
|
||||||
|
|
||||||
if !force_onboarding && media_profiles_exist && sources_exist do
|
if done_onboarding, do: Settings.set!(:onboarding, false)
|
||||||
render_home_page(conn)
|
|
||||||
|
if force_onboarding || Settings.get!(:onboarding) do
|
||||||
|
render_onboarding_page(conn)
|
||||||
else
|
else
|
||||||
render_onboarding_page(conn, media_profiles_exist, sources_exist)
|
render_home_page(conn)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
defp render_home_page(conn) do
|
defp render_home_page(conn) do
|
||||||
Settings.set!(:onboarding, false)
|
|
||||||
media_profile_count = Repo.aggregate(MediaProfile, :count, :id)
|
|
||||||
source_count = Repo.aggregate(Source, :count, :id)
|
|
||||||
media_item_count = Repo.aggregate(MediaItem, :count, :id)
|
|
||||||
|
|
||||||
conn
|
conn
|
||||||
|> render(:home,
|
|> render(:home,
|
||||||
media_profile_count: media_profile_count,
|
media_profile_count: Repo.aggregate(MediaProfile, :count, :id),
|
||||||
source_count: source_count,
|
source_count: Repo.aggregate(Source, :count, :id),
|
||||||
media_item_count: media_item_count
|
media_item_count: Repo.aggregate(MediaItem, :count, :id)
|
||||||
)
|
)
|
||||||
end
|
end
|
||||||
|
|
||||||
defp render_onboarding_page(conn, media_profiles_exist, sources_exist) do
|
defp render_onboarding_page(conn) do
|
||||||
Settings.set!(:onboarding, true)
|
Settings.set!(:onboarding, true)
|
||||||
|
|
||||||
conn
|
conn
|
||||||
|> render(:onboarding_checklist,
|
|> render(:onboarding_checklist,
|
||||||
media_profiles_exist: media_profiles_exist,
|
media_profiles_exist: Repo.exists?(MediaProfile),
|
||||||
sources_exist: sources_exist,
|
sources_exist: Repo.exists?(Source),
|
||||||
layout: {Layouts, :onboarding}
|
layout: {Layouts, :onboarding}
|
||||||
)
|
)
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -10,8 +10,8 @@
|
|||||||
<p class="text-md text-bodydark">Media Profiles set your preferences for fetching and downloading media.</p>
|
<p class="text-md text-bodydark">Media Profiles set your preferences for fetching and downloading media.</p>
|
||||||
<p class="text-md text-bodydark">Don't worry, you can create more Media Profiles later!</p>
|
<p class="text-md text-bodydark">Don't worry, you can create more Media Profiles later!</p>
|
||||||
<div class="mt-8">
|
<div class="mt-8">
|
||||||
<.link navigate={~p"/media_profiles/new"}>
|
<.link href={~p"/media_profiles/new"}>
|
||||||
<.button color="bg-primary" rounding="rounded-full" disabled={@media_profiles_exist}>
|
<.button color="bg-primary" rounding="rounded-lg" disabled={@media_profiles_exist}>
|
||||||
<span class="font-bold mx-2">+</span> New Media Profile
|
<span class="font-bold mx-2">+</span> New Media Profile
|
||||||
</.button>
|
</.button>
|
||||||
</.link>
|
</.link>
|
||||||
@@ -24,8 +24,8 @@
|
|||||||
Each Media Profile can control many Sources so it's easy to add more content!
|
Each Media Profile can control many Sources so it's easy to add more content!
|
||||||
</p>
|
</p>
|
||||||
<div class="mt-8">
|
<div class="mt-8">
|
||||||
<.link navigate={~p"/sources/new"}>
|
<.link href={~p"/sources/new"}>
|
||||||
<.button color="bg-primary" rounding="rounded-full" disabled={not @media_profiles_exist}>
|
<.button color="bg-primary" rounding="rounded-lg" disabled={not @media_profiles_exist}>
|
||||||
<span class="font-bold mx-2">+</span> New Source
|
<span class="font-bold mx-2">+</span> New Source
|
||||||
</.button>
|
</.button>
|
||||||
</.link>
|
</.link>
|
||||||
@@ -39,8 +39,8 @@
|
|||||||
</p>
|
</p>
|
||||||
<p class="text-md text-bodydark">Feel free to add more Media Profiles or Sources in the meantime!</p>
|
<p class="text-md text-bodydark">Feel free to add more Media Profiles or Sources in the meantime!</p>
|
||||||
<div class="mt-8">
|
<div class="mt-8">
|
||||||
<.link navigate={~p"/"}>
|
<.link href={~p"/?onboarding=0"}>
|
||||||
<.button color="bg-primary" rounding="rounded-full" disabled={not @sources_exist}>
|
<.button color="bg-primary" rounding="rounded-lg" disabled={not @sources_exist}>
|
||||||
Let's Go <span class="font-bold mx-2">🚀</span>
|
Let's Go <span class="font-bold mx-2">🚀</span>
|
||||||
</.button>
|
</.button>
|
||||||
</.link>
|
</.link>
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
<div class="mb-6 flex gap-3 flex-row items-center justify-between">
|
<div class="mb-6 flex gap-3 flex-row items-center justify-between">
|
||||||
<h2 class="text-title-md2 font-bold text-black dark:text-white">
|
<h2 class="text-title-md2 font-bold text-black dark:text-white">
|
||||||
<span class="hidden sm:inline">Search </span>Results for "<%= StringUtils.truncate(@search_term, 50) %>"
|
Results for "<%= StringUtils.truncate(@search_term, 50) %>"
|
||||||
</h2>
|
</h2>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@@ -10,14 +10,14 @@
|
|||||||
<%= if match?([_|_], @search_results) do %>
|
<%= if match?([_|_], @search_results) do %>
|
||||||
<.table rows={@search_results} table_class="text-black dark:text-white">
|
<.table rows={@search_results} table_class="text-black dark:text-white">
|
||||||
<:col :let={result} label="Title">
|
<:col :let={result} label="Title">
|
||||||
<%= StringUtils.truncate(result.title, 40) %>
|
<%= result.title %>
|
||||||
</:col>
|
</:col>
|
||||||
<:col :let={result} label="Excerpt">
|
<:col :let={result} label="Excerpt">
|
||||||
<.highlight_search_terms text={result.matching_search_term} />
|
<.highlight_search_terms text={result.matching_search_term} />
|
||||||
</:col>
|
</:col>
|
||||||
<:col :let={result} label="" class="flex place-content-evenly">
|
<:col :let={result} label="" class="flex place-content-evenly">
|
||||||
<.link
|
<.link
|
||||||
navigate={~p"/sources/#{result.source_id}/media/#{result.id}"}
|
href={~p"/sources/#{result.source_id}/media/#{result.id}"}
|
||||||
class="hover:text-secondary duration-200 ease-in-out mx-0.5"
|
class="hover:text-secondary duration-200 ease-in-out mx-0.5"
|
||||||
>
|
>
|
||||||
<.icon name="hero-eye" />
|
<.icon name="hero-eye" />
|
||||||
|
|||||||
@@ -3,8 +3,9 @@ defmodule PinchflatWeb.Sources.SourceController do
|
|||||||
|
|
||||||
alias Pinchflat.Repo
|
alias Pinchflat.Repo
|
||||||
alias Pinchflat.Media
|
alias Pinchflat.Media
|
||||||
alias Pinchflat.Profiles
|
alias Pinchflat.Tasks
|
||||||
alias Pinchflat.Sources
|
alias Pinchflat.Sources
|
||||||
|
alias Pinchflat.Profiles
|
||||||
alias Pinchflat.Sources.Source
|
alias Pinchflat.Sources.Source
|
||||||
|
|
||||||
def index(conn, _params) do
|
def index(conn, _params) do
|
||||||
@@ -43,15 +44,18 @@ defmodule PinchflatWeb.Sources.SourceController do
|
|||||||
end
|
end
|
||||||
|
|
||||||
def show(conn, %{"id" => id}) do
|
def show(conn, %{"id" => id}) do
|
||||||
source =
|
source = Repo.preload(Sources.get_source!(id), :media_profile)
|
||||||
id
|
|
||||||
|> Sources.get_source!()
|
|
||||||
|> Repo.preload([:media_profile, tasks: [:job]])
|
|
||||||
|
|
||||||
|
pending_tasks = Repo.preload(Tasks.list_pending_tasks_for(source), :job)
|
||||||
pending_media = Media.list_pending_media_items_for(source, limit: 100)
|
pending_media = Media.list_pending_media_items_for(source, limit: 100)
|
||||||
downloaded_media = Media.list_downloaded_media_items_for(source, limit: 100)
|
downloaded_media = Media.list_downloaded_media_items_for(source, limit: 100)
|
||||||
|
|
||||||
render(conn, :show, source: source, pending_media: pending_media, downloaded_media: downloaded_media)
|
render(conn, :show,
|
||||||
|
source: source,
|
||||||
|
pending_tasks: pending_tasks,
|
||||||
|
pending_media: pending_media,
|
||||||
|
downloaded_media: downloaded_media
|
||||||
|
)
|
||||||
end
|
end
|
||||||
|
|
||||||
def edit(conn, %{"id" => id}) do
|
def edit(conn, %{"id" => id}) do
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ defmodule PinchflatWeb.Sources.SourceHTML do
|
|||||||
|
|
||||||
def friendly_index_frequencies do
|
def friendly_index_frequencies do
|
||||||
[
|
[
|
||||||
{"On Create", -1},
|
{"Only once when first created", -1},
|
||||||
{"1 Hour", 60},
|
{"1 Hour", 60},
|
||||||
{"3 Hours", 3 * 60},
|
{"3 Hours", 3 * 60},
|
||||||
{"6 Hours", 6 * 60},
|
{"6 Hours", 6 * 60},
|
||||||
|
|||||||
@@ -1,8 +1,10 @@
|
|||||||
<div class="mb-6 flex gap-3 flex-row items-center">
|
<div class="mb-6 flex gap-3 flex-row items-center">
|
||||||
<.link navigate={~p"/sources"}>
|
<.link href={~p"/sources"}>
|
||||||
<.icon name="hero-arrow-left" class="w-10 h-10 hover:dark:text-white" />
|
<.icon name="hero-arrow-left" class="w-10 h-10 hover:dark:text-white" />
|
||||||
</.link>
|
</.link>
|
||||||
<h2 class="text-title-md2 font-bold text-black dark:text-white ml-4">Edit Source</h2>
|
<h2 class="text-title-md2 font-bold text-black dark:text-white ml-4">
|
||||||
|
Editing "<%= @source.custom_name %>"
|
||||||
|
</h2>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="rounded-sm border border-stroke bg-white px-5 pb-2.5 pt-6 shadow-default dark:border-strokedark dark:bg-boxdark sm:px-7.5 xl:pb-1">
|
<div class="rounded-sm border border-stroke bg-white px-5 pb-2.5 pt-6 shadow-default dark:border-strokedark dark:bg-boxdark sm:px-7.5 xl:pb-1">
|
||||||
|
|||||||
@@ -0,0 +1,21 @@
|
|||||||
|
<aside>
|
||||||
|
<h2 class="text-xl font-bold mb-2">What is fast indexing (experimental)?</h2>
|
||||||
|
<section class="ml-2 md:ml-4 mb-4 max-w-prose">
|
||||||
|
<p>
|
||||||
|
Indexing is the act of scanning a channel or playlist (aka: source) for new media.
|
||||||
|
</p>
|
||||||
|
<p class="mt-2">
|
||||||
|
Normal indexing uses <code class="text-sm">yt-dlp</code>
|
||||||
|
to scan the entire source on your specified frequency, but it's very slow for large sources. This is the most accurate way to find uploaded media with the tradeoff being that pairing a large source with a low index frequency will result in you spending most of your time indexing. Only so many indexing operations can be running at the same time, so this can impact your other source's ability to index.
|
||||||
|
</p>
|
||||||
|
<p class="mt-2">
|
||||||
|
Fast indexing takes a different approach. It still does an initial scan the slow way but after that it uses an RSS feed to frequently check for new videos. This has the potential to be hundreds of times faster, but it can miss videos if the uploader un-privates an old video or uploads dozens of videos in the space of a few minutes. It works well for most channels or playlists but it's not perfect.
|
||||||
|
</p>
|
||||||
|
<p class="mt-2">
|
||||||
|
To make up for this limitation, a normal index is still run monthly to catch any videos that were missed by fast indexing. Fast indexing overrides the normal index frequency.
|
||||||
|
</p>
|
||||||
|
<p class="mt-2">
|
||||||
|
Fast indexing is experimental so please report any issues on GitHub. It's only recommended for sources with over 200-ish videos and that upload frequently. Not recommended for small or inactive sources.
|
||||||
|
</p>
|
||||||
|
</section>
|
||||||
|
</aside>
|
||||||
@@ -1,8 +1,8 @@
|
|||||||
<div class="mb-6 flex gap-3 flex-row items-center justify-between">
|
<div class="mb-6 flex gap-3 flex-row items-center justify-between">
|
||||||
<h2 class="text-title-md2 font-bold text-black dark:text-white">Sources</h2>
|
<h2 class="text-title-md2 font-bold text-black dark:text-white">Sources</h2>
|
||||||
<nav>
|
<nav>
|
||||||
<.link navigate={~p"/sources/new"}>
|
<.link href={~p"/sources/new"}>
|
||||||
<.button color="bg-primary" rounding="rounded-full">
|
<.button color="bg-primary" rounding="rounded-lg">
|
||||||
<span class="font-bold mx-2">+</span> New <span class="hidden sm:inline pl-1">Source</span>
|
<span class="font-bold mx-2">+</span> New <span class="hidden sm:inline pl-1">Source</span>
|
||||||
</.button>
|
</.button>
|
||||||
</.link>
|
</.link>
|
||||||
@@ -14,19 +14,18 @@
|
|||||||
<div class="flex flex-col gap-10 min-w-max">
|
<div class="flex flex-col gap-10 min-w-max">
|
||||||
<.table rows={@sources} table_class="text-black dark:text-white">
|
<.table rows={@sources} table_class="text-black dark:text-white">
|
||||||
<:col :let={source} label="Name">
|
<:col :let={source} label="Name">
|
||||||
<%= source.custom_name || source.collection_name %>
|
<.subtle_link href={~p"/sources/#{source.id}"}>
|
||||||
|
<%= source.custom_name || source.collection_name %>
|
||||||
|
</.subtle_link>
|
||||||
</:col>
|
</:col>
|
||||||
<:col :let={source} label="Type"><%= source.collection_type %></:col>
|
<:col :let={source} label="Type"><%= source.collection_type %></:col>
|
||||||
<:col :let={source} label="Should Download?">
|
<:col :let={source} label="Should Download?">
|
||||||
<.icon name={if source.download_media, do: "hero-check", else: "hero-x-mark"} />
|
<.icon name={if source.download_media, do: "hero-check", else: "hero-x-mark"} />
|
||||||
</:col>
|
</:col>
|
||||||
<:col :let={source} label="Media Profile">
|
<:col :let={source} label="Media Profile">
|
||||||
<.link
|
<.subtle_link href={~p"/media_profiles/#{source.media_profile_id}"}>
|
||||||
navigate={~p"/media_profiles/#{source.media_profile_id}"}
|
|
||||||
class="hover:text-secondary duration-200 ease-in-out"
|
|
||||||
>
|
|
||||||
<%= source.media_profile.name %>
|
<%= source.media_profile.name %>
|
||||||
</.link>
|
</.subtle_link>
|
||||||
</:col>
|
</:col>
|
||||||
<:col :let={source} label="" class="flex place-content-evenly">
|
<:col :let={source} label="" class="flex place-content-evenly">
|
||||||
<.icon_link href={~p"/sources/#{source.id}"} icon="hero-eye" class="mx-1" />
|
<.icon_link href={~p"/sources/#{source.id}"} icon="hero-eye" class="mx-1" />
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
<div class="mb-6 flex gap-3 flex-row items-center">
|
<div class="mb-6 flex gap-3 flex-row items-center">
|
||||||
<.link :if={!Settings.get!(:onboarding)} navigate={~p"/sources"}>
|
<.link :if={!Settings.get!(:onboarding)} href={~p"/sources"}>
|
||||||
<.icon name="hero-arrow-left" class="w-10 h-10 hover:dark:text-white" />
|
<.icon name="hero-arrow-left" class="w-10 h-10 hover:dark:text-white" />
|
||||||
</.link>
|
</.link>
|
||||||
<h2 class="text-title-md2 font-bold text-black dark:text-white ml-4">New Source</h2>
|
<h2 class="text-title-md2 font-bold text-black dark:text-white ml-4">New Source</h2>
|
||||||
|
|||||||
@@ -1,16 +1,16 @@
|
|||||||
<div class="mb-6 flex gap-3 flex-row items-center justify-between">
|
<div class="mb-6 flex gap-3 flex-row items-center justify-between">
|
||||||
<div class="flex gap-3 items-center">
|
<div class="flex gap-3 items-center">
|
||||||
<.link navigate={~p"/sources"}>
|
<.link href={~p"/sources"}>
|
||||||
<.icon name="hero-arrow-left" class="w-10 h-10 hover:dark:text-white" />
|
<.icon name="hero-arrow-left" class="w-10 h-10 hover:dark:text-white" />
|
||||||
</.link>
|
</.link>
|
||||||
<h2 class="text-title-md2 font-bold text-black dark:text-white ml-4">
|
<h2 class="text-title-md2 font-bold text-black dark:text-white ml-4">
|
||||||
Source <span class="hidden sm:inline">#<%= @source.id %></span>
|
<%= @source.custom_name %>
|
||||||
</h2>
|
</h2>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav>
|
<nav>
|
||||||
<.link navigate={~p"/sources/#{@source}/edit"}>
|
<.link href={~p"/sources/#{@source}/edit"}>
|
||||||
<.button color="bg-primary" rounding="rounded-full">
|
<.button color="bg-primary" rounding="rounded-lg">
|
||||||
<.icon name="hero-pencil-square" class="mr-2" /> Edit <span class="hidden sm:inline pl-1">Source</span>
|
<.icon name="hero-pencil-square" class="mr-2" /> Edit <span class="hidden sm:inline pl-1">Source</span>
|
||||||
</.button>
|
</.button>
|
||||||
</.link>
|
</.link>
|
||||||
@@ -38,7 +38,7 @@
|
|||||||
method="delete"
|
method="delete"
|
||||||
data-confirm="Are you sure you want to delete this source (leaving files in place)? This cannot be undone."
|
data-confirm="Are you sure you want to delete this source (leaving files in place)? This cannot be undone."
|
||||||
>
|
>
|
||||||
<.button color="bg-meta-1" rounding="rounded-full">
|
<.button color="bg-meta-1" rounding="rounded-lg">
|
||||||
Delete Source
|
Delete Source
|
||||||
</.button>
|
</.button>
|
||||||
</.link>
|
</.link>
|
||||||
@@ -48,7 +48,7 @@
|
|||||||
data-confirm="Are you sure you want to delete this source and it's files on disk? This cannot be undone."
|
data-confirm="Are you sure you want to delete this source and it's files on disk? This cannot be undone."
|
||||||
class="mt-5 md:mt-0"
|
class="mt-5 md:mt-0"
|
||||||
>
|
>
|
||||||
<.button color="bg-meta-1" rounding="rounded-full">
|
<.button color="bg-meta-1" rounding="rounded-lg">
|
||||||
Delete Source and Files
|
Delete Source and Files
|
||||||
</.button>
|
</.button>
|
||||||
</.link>
|
</.link>
|
||||||
@@ -84,9 +84,9 @@
|
|||||||
<p class="text-black dark:text-white">Nothing Here!</p>
|
<p class="text-black dark:text-white">Nothing Here!</p>
|
||||||
<% end %>
|
<% end %>
|
||||||
</:tab>
|
</:tab>
|
||||||
<:tab title="Tasks">
|
<:tab title="Pending Tasks">
|
||||||
<%= if match?([_|_], @source.tasks) do %>
|
<%= if match?([_|_], @pending_tasks) do %>
|
||||||
<.table rows={@source.tasks} table_class="text-black dark:text-white">
|
<.table rows={@pending_tasks} table_class="text-black dark:text-white">
|
||||||
<:col :let={task} label="Worker">
|
<:col :let={task} label="Worker">
|
||||||
<%= task.job.worker %>
|
<%= task.job.worker %>
|
||||||
</:col>
|
</:col>
|
||||||
|
|||||||
@@ -1,8 +1,23 @@
|
|||||||
<.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}>
|
<.error :if={@changeset.action}>
|
||||||
Oops, something went wrong! Please check the errors below.
|
Oops, something went wrong! Please check the errors below.
|
||||||
</.error>
|
</.error>
|
||||||
|
|
||||||
|
<section class="flex justify-between items-center mt-8">
|
||||||
|
<h3 class=" text-2xl text-black dark:text-white">
|
||||||
|
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
|
<.input
|
||||||
field={f[:custom_name]}
|
field={f[:custom_name]}
|
||||||
type="text"
|
type="text"
|
||||||
@@ -17,24 +32,74 @@
|
|||||||
options={Enum.map(@media_profiles, &{&1.name, &1.id})}
|
options={Enum.map(@media_profiles, &{&1.name, &1.id})}
|
||||||
type="select"
|
type="select"
|
||||||
label="Media Profile"
|
label="Media Profile"
|
||||||
|
help="Sets your preferences for what media to look for and how to store it"
|
||||||
/>
|
/>
|
||||||
|
|
||||||
|
<h3 class="mt-8 text-2xl text-black dark:text-white">
|
||||||
|
Indexing Options
|
||||||
|
</h3>
|
||||||
|
|
||||||
<.input
|
<.input
|
||||||
field={f[:index_frequency_minutes]}
|
field={f[:index_frequency_minutes]}
|
||||||
options={friendly_index_frequencies()}
|
options={friendly_index_frequencies()}
|
||||||
type="select"
|
type="select"
|
||||||
label="Index Frequency"
|
label="Index Frequency"
|
||||||
help="Time between one index of this source finishing and the next one starting. Setting to 'On Create' will still run an initial index but no subsequent ones"
|
help="Indexing is the process of checking for media to download. Sets the time between one index of this source finishing and the next one starting"
|
||||||
/>
|
/>
|
||||||
|
|
||||||
|
<%!-- TODO: use Alpine to disable the index frequency when fast indexing is enabled --%>
|
||||||
|
<div phx-click={show_modal("upgrade-modal")}>
|
||||||
|
<.input
|
||||||
|
field={f[:fast_index]}
|
||||||
|
type="toggle"
|
||||||
|
label="Use Fast Indexing"
|
||||||
|
label_suffix="(pro)"
|
||||||
|
help="Experimental. Ignores 'Index Frequency'. Recommended for large channels that upload frequently. See below for more info"
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<h3 class="mt-8 text-2xl text-black dark:text-white">
|
||||||
|
Downloading Options
|
||||||
|
</h3>
|
||||||
|
|
||||||
<.input
|
<.input
|
||||||
field={f[:download_media]}
|
field={f[:download_media]}
|
||||||
type="toggle"
|
type="toggle"
|
||||||
label="Download Media?"
|
label="Download Media"
|
||||||
help="Unchecking still indexes media but it won't be downloaded until you enable this option"
|
help="Unchecking still indexes media but it won't be downloaded until you enable this option"
|
||||||
/>
|
/>
|
||||||
|
|
||||||
<:actions>
|
<.input
|
||||||
<.button class="my-10 sm:mb-7.5 w-full sm:w-auto">Save Source</.button>
|
field={f[:download_cutoff_date]}
|
||||||
</:actions>
|
type="text"
|
||||||
|
label="Download Cutoff Date"
|
||||||
|
placeholder="YYYY-MM-DD"
|
||||||
|
maxlength="10"
|
||||||
|
pattern="((?:19|20)[0-9][0-9])-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])"
|
||||||
|
title="YYYY-MM-DD"
|
||||||
|
help="Only download media uploaded after this date. Leave blank to download all media. Must be in YYYY-MM-DD format"
|
||||||
|
/>
|
||||||
|
|
||||||
|
<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 />
|
||||||
|
</div>
|
||||||
</.simple_form>
|
</.simple_form>
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ defmodule Pinchflat.MixProject do
|
|||||||
def project do
|
def project do
|
||||||
[
|
[
|
||||||
app: :pinchflat,
|
app: :pinchflat,
|
||||||
version: "0.1.0-alpha",
|
version: "0.1.1",
|
||||||
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,
|
||||||
@@ -13,6 +13,16 @@ defmodule Pinchflat.MixProject do
|
|||||||
preferred_cli_env: [
|
preferred_cli_env: [
|
||||||
check: :test,
|
check: :test,
|
||||||
credo: :test
|
credo: :test
|
||||||
|
],
|
||||||
|
test_coverage: [
|
||||||
|
ignore_modules: [
|
||||||
|
Pinchflat.HTTP.HTTPClient,
|
||||||
|
PinchflatWeb.Layouts,
|
||||||
|
Pinchflat.DataCase,
|
||||||
|
Pinchflat.Release,
|
||||||
|
~r/Fixtures/,
|
||||||
|
~r/HTML$/
|
||||||
|
]
|
||||||
]
|
]
|
||||||
]
|
]
|
||||||
end
|
end
|
||||||
@@ -59,6 +69,7 @@ defmodule Pinchflat.MixProject do
|
|||||||
{:nimble_parsec, "~> 1.4"},
|
{:nimble_parsec, "~> 1.4"},
|
||||||
{:mox, "~> 1.0", only: :test},
|
{:mox, "~> 1.0", only: :test},
|
||||||
{:credo, "~> 1.7", only: [:dev, :test], runtime: false},
|
{:credo, "~> 1.7", only: [:dev, :test], runtime: false},
|
||||||
|
{:credo_naming, "~> 2.1", only: [:dev, :test], runtime: false},
|
||||||
{:ex_check, "~> 0.14.0", only: [:dev, :test], runtime: false},
|
{:ex_check, "~> 0.14.0", only: [:dev, :test], runtime: false},
|
||||||
{:faker, "~> 0.17", only: :test},
|
{:faker, "~> 0.17", only: :test},
|
||||||
{:sobelow, "~> 0.13", only: [:dev, :test], runtime: false}
|
{:sobelow, "~> 0.13", only: [:dev, :test], runtime: false}
|
||||||
|
|||||||
@@ -6,6 +6,7 @@
|
|||||||
"cowboy_telemetry": {:hex, :cowboy_telemetry, "0.4.0", "f239f68b588efa7707abce16a84d0d2acf3a0f50571f8bb7f56a15865aae820c", [:rebar3], [{:cowboy, "~> 2.7", [hex: :cowboy, repo: "hexpm", optional: false]}, {:telemetry, "~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "7d98bac1ee4565d31b62d59f8823dfd8356a169e7fcbb83831b8a5397404c9de"},
|
"cowboy_telemetry": {:hex, :cowboy_telemetry, "0.4.0", "f239f68b588efa7707abce16a84d0d2acf3a0f50571f8bb7f56a15865aae820c", [:rebar3], [{:cowboy, "~> 2.7", [hex: :cowboy, repo: "hexpm", optional: false]}, {:telemetry, "~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "7d98bac1ee4565d31b62d59f8823dfd8356a169e7fcbb83831b8a5397404c9de"},
|
||||||
"cowlib": {:hex, :cowlib, "2.12.1", "a9fa9a625f1d2025fe6b462cb865881329b5caff8f1854d1cbc9f9533f00e1e1", [:make, :rebar3], [], "hexpm", "163b73f6367a7341b33c794c4e88e7dbfe6498ac42dcd69ef44c5bc5507c8db0"},
|
"cowlib": {:hex, :cowlib, "2.12.1", "a9fa9a625f1d2025fe6b462cb865881329b5caff8f1854d1cbc9f9533f00e1e1", [:make, :rebar3], [], "hexpm", "163b73f6367a7341b33c794c4e88e7dbfe6498ac42dcd69ef44c5bc5507c8db0"},
|
||||||
"credo": {:hex, :credo, "1.7.3", "05bb11eaf2f2b8db370ecaa6a6bda2ec49b2acd5e0418bc106b73b07128c0436", [:mix], [{:bunt, "~> 0.2.1 or ~> 1.0", [hex: :bunt, repo: "hexpm", optional: false]}, {:file_system, "~> 0.2 or ~> 1.0", [hex: :file_system, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "35ea675a094c934c22fb1dca3696f3c31f2728ae6ef5a53b5d648c11180a4535"},
|
"credo": {:hex, :credo, "1.7.3", "05bb11eaf2f2b8db370ecaa6a6bda2ec49b2acd5e0418bc106b73b07128c0436", [:mix], [{:bunt, "~> 0.2.1 or ~> 1.0", [hex: :bunt, repo: "hexpm", optional: false]}, {:file_system, "~> 0.2 or ~> 1.0", [hex: :file_system, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "35ea675a094c934c22fb1dca3696f3c31f2728ae6ef5a53b5d648c11180a4535"},
|
||||||
|
"credo_naming": {:hex, :credo_naming, "2.1.0", "d44ad58890d4db552e141ce64756a74ac1573665af766d1ac64931aa90d47744", [:make, :mix], [{:credo, "~> 1.6", [hex: :credo, repo: "hexpm", optional: false]}], "hexpm", "830e23b3fba972e2fccec49c0c089fe78c1e64bc16782a2682d78082351a2909"},
|
||||||
"db_connection": {:hex, :db_connection, "2.6.0", "77d835c472b5b67fc4f29556dee74bf511bbafecdcaf98c27d27fa5918152086", [:mix], [{:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "c2f992d15725e721ec7fbc1189d4ecdb8afef76648c746a8e1cad35e3b8a35f3"},
|
"db_connection": {:hex, :db_connection, "2.6.0", "77d835c472b5b67fc4f29556dee74bf511bbafecdcaf98c27d27fa5918152086", [:mix], [{:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "c2f992d15725e721ec7fbc1189d4ecdb8afef76648c746a8e1cad35e3b8a35f3"},
|
||||||
"decimal": {:hex, :decimal, "2.1.1", "5611dca5d4b2c3dd497dec8f68751f1f1a54755e8ed2a966c2633cf885973ad6", [:mix], [], "hexpm", "53cfe5f497ed0e7771ae1a475575603d77425099ba5faef9394932b35020ffcc"},
|
"decimal": {:hex, :decimal, "2.1.1", "5611dca5d4b2c3dd497dec8f68751f1f1a54755e8ed2a966c2633cf885973ad6", [:mix], [], "hexpm", "53cfe5f497ed0e7771ae1a475575603d77425099ba5faef9394932b35020ffcc"},
|
||||||
"dns_cluster": {:hex, :dns_cluster, "0.1.2", "3eb5be824c7888dadf9781018e1a5f1d3d1113b333c50bce90fb1b83df1015f2", [:mix], [], "hexpm", "7494272040f847637bbdb01bcdf4b871e82daf09b813e7d3cb3b84f112c6f2f8"},
|
"dns_cluster": {:hex, :dns_cluster, "0.1.2", "3eb5be824c7888dadf9781018e1a5f1d3d1113b333c50bce90fb1b83df1015f2", [:mix], [], "hexpm", "7494272040f847637bbdb01bcdf4b871e82daf09b813e7d3cb3b84f112c6f2f8"},
|
||||||
|
|||||||
BIN
Binary file not shown.
BIN
Binary file not shown.
BIN
Binary file not shown.
BIN
Binary file not shown.
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user