Compare commits
220 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| bf917febe8 | |||
| 8189dcce71 | |||
| 4e4092c792 | |||
| 0cd6ac797b | |||
| 81d5efd4c1 | |||
| dec3938780 | |||
| a2a0f48065 | |||
| 94c0cf9970 | |||
| bbdc56c656 | |||
| 7bf74a04e7 | |||
| 33040bba34 | |||
| b1a6a6a81f | |||
| a7b0af65e2 | |||
| dcf033f10a | |||
| 8d9bd11882 | |||
| bdcb49185a | |||
| 1f1cd1cb63 | |||
| d575548226 | |||
| 2dfdb31aa4 | |||
| c27e1dba96 | |||
| 65b8790a35 | |||
| b7c6f272a2 | |||
| a38ffbc55b | |||
| 5c86e7192e | |||
| 77a9ff4d9f | |||
| d093799801 | |||
| 90f709dbc8 | |||
| c5975e08da | |||
| 933daf8c78 | |||
| b5d2ba4191 | |||
| a1a568b7f7 | |||
| 1b7fb6d14b | |||
| 944d26b57d | |||
| 5427c6247f | |||
| f655a8ae01 | |||
| 7090349abd | |||
| f2c9c10437 | |||
| ff188f9351 | |||
| 04b14719ee | |||
| 112c6a4f14 | |||
| 8051107d32 | |||
| 3f74f199dc | |||
| 09cac46e14 | |||
| f65ebea738 | |||
| edb48b3989 | |||
| 98c2812ee8 | |||
| 526bc0c2e3 | |||
| 5a5448b87a | |||
| 88569640c9 | |||
| 6f78ec40d7 | |||
| aea40a3f92 | |||
| a4d5f45edc | |||
| 618711691b | |||
| 4721957875 | |||
| b2e5e9b880 | |||
| 8ca19ba076 | |||
| f2a7463ff3 | |||
| c36e33e1fd | |||
| e984c05298 | |||
| 96c65012ca | |||
| 25aaef7da4 | |||
| 1a699223fe | |||
| 2a9677df51 | |||
| 8fbcc8b289 | |||
| 0fcdd1df84 | |||
| e841f39cf2 | |||
| a2bcd454c7 | |||
| cec9e3c7ff | |||
| b0c2a33644 | |||
| 318d6a7594 | |||
| 26d457e656 | |||
| a9f40ed843 | |||
| f27323ffa3 | |||
| 81b49f55bf | |||
| 24875eaeac | |||
| d9053fff0c | |||
| 70c1f97625 | |||
| 332485cdaf | |||
| e55bcaddd0 | |||
| 4b12764f45 | |||
| b872c5c20b | |||
| 9381c80aac | |||
| ce35130a93 | |||
| 3b1c1692fb | |||
| 79c61bca4f | |||
| f9c2f7b8f2 | |||
| 2f9abe86b4 | |||
| 22fbb4b930 | |||
| 3daf72a161 | |||
| 4e26253b33 | |||
| c58e176619 | |||
| 0eca0acbe8 | |||
| 89f4634d1f | |||
| 32ac51d7b0 | |||
| 198bef71bc | |||
| 54ea8a373a | |||
| 0722f43727 | |||
| 9dd64f3a2d | |||
| fae7ba3304 | |||
| bdd97bde01 | |||
| edb12b088f | |||
| 964ab2f89b | |||
| 216e05567f | |||
| 2d8b985f13 | |||
| d1fe87bdf3 | |||
| 23d65eaf5f | |||
| 4d6a93d16c | |||
| 9985aeca86 | |||
| f38d793f4e | |||
| 2006f33792 | |||
| 320b25f5b6 | |||
| d043e5574b | |||
| af86fede6c | |||
| 7411177e7d | |||
| 42a418f79e | |||
| c45c030c00 | |||
| c08654714a | |||
| 5c5e7a8a91 | |||
| 1b0d71ea48 | |||
| af803b7081 | |||
| fe641cfc49 | |||
| 65533b82da | |||
| 1923098427 | |||
| 6ad9e68682 | |||
| 9baaa65c1e | |||
| bd6ea15118 | |||
| e92e2001bf | |||
| a3d0927dfb | |||
| 54eacf52b3 | |||
| d0f7338f42 | |||
| ecc73d25a5 | |||
| b18c305957 | |||
| ccae3366a5 | |||
| 182ba7abe7 | |||
| f06c02bf62 | |||
| 37eb745d03 | |||
| 66b14c3d8f | |||
| d9b63875ab | |||
| aed2322c63 | |||
| 723cf2a7e9 | |||
| b4cdca5206 | |||
| 9310b5e26e | |||
| 3c522d8d6b | |||
| 1328dff7d6 | |||
| e2385eccd6 | |||
| 565a1d4972 | |||
| 05f3deebfa | |||
| f91c707c7c | |||
| 6e7e8dc96c | |||
| b633d0f75c | |||
| a135746c97 | |||
| c67278ab5c | |||
| 5bde1205cc | |||
| c1e3ed2128 | |||
| 1cc8731914 | |||
| abe99ce6f0 | |||
| f506b9bc28 | |||
| 5b2d6b094d | |||
| 33baa99aae | |||
| 7fa5c4da63 | |||
| 993865909c | |||
| f156fec4b7 | |||
| e1fc361e98 | |||
| 2267b47de8 | |||
| e6b04bd675 | |||
| ea4d689fea | |||
| 2f6a19f0e7 | |||
| f60ec4f49d | |||
| c0a11e98d9 | |||
| 19ec13e64c | |||
| e1f8e94686 | |||
| 128485c30a | |||
| b7beeaf9eb | |||
| 36daeff48c | |||
| 0948bebb9d | |||
| ef4a5cc99f | |||
| 82eb12b983 | |||
| a4f4afeac9 | |||
| 90a0022d85 | |||
| f55cdc80dd | |||
| b370c97bfb | |||
| 0f40dcf5dd | |||
| c37157d644 | |||
| 09448e3fcc | |||
| 9e75092876 | |||
| 36f27c76e8 | |||
| be8bcf0eb2 | |||
| 7809a25f2d | |||
| d2c2cda479 | |||
| 1f4823bda9 | |||
| 0020e5083b | |||
| c77047951f | |||
| 4094da9e03 | |||
| 3b94b269d9 | |||
| 927560beb6 | |||
| ab9b657394 | |||
| 610acb15f1 | |||
| 3efc533fb7 | |||
| e3f1b409b9 | |||
| 01042ebd1b | |||
| 1ec1a48235 | |||
| af7e76c1d1 | |||
| 69c47c2c65 | |||
| 1f56db01a5 | |||
| b81c8d64b3 | |||
| 53bd8681c3 | |||
| c5fcb8fe12 | |||
| 58771ee37b | |||
| 850cf2db73 | |||
| 77f06bfbc8 | |||
| e0637331bb | |||
| e1565ad22f | |||
| 9e4fbfa35d | |||
| b19c01e3ed | |||
| 366fd80213 | |||
| 977b69b7c3 | |||
| 4dd9d837a3 | |||
| 44bec0a127 | |||
| 89b1640eb6 | |||
| c03fd837ea |
+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
|
||||||
|
|||||||
@@ -1,32 +0,0 @@
|
|||||||
name: Build and Push Docker Image
|
|
||||||
|
|
||||||
on:
|
|
||||||
workflow_dispatch:
|
|
||||||
inputs:
|
|
||||||
image_tag:
|
|
||||||
description: 'Docker Image Tag'
|
|
||||||
required: true
|
|
||||||
default: 'dev'
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
docker:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Set up QEMU
|
|
||||||
uses: docker/setup-qemu-action@v3
|
|
||||||
|
|
||||||
- name: Set up Docker Buildx
|
|
||||||
uses: docker/setup-buildx-action@v3
|
|
||||||
|
|
||||||
- name: Login to Docker Hub
|
|
||||||
uses: docker/login-action@v3
|
|
||||||
with:
|
|
||||||
username: ${{ secrets.DOCKERHUB_USERNAME }}
|
|
||||||
password: ${{ secrets.DOCKERHUB_TOKEN }}
|
|
||||||
|
|
||||||
- name: Build and push
|
|
||||||
uses: docker/build-push-action@v5
|
|
||||||
with:
|
|
||||||
push: true
|
|
||||||
file: ./selfhosted.Dockerfile
|
|
||||||
tags: 'keglin/pinchflat:${{ github.event.inputs.image_tag }}'
|
|
||||||
@@ -0,0 +1,79 @@
|
|||||||
|
name: Docker Release
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_dispatch:
|
||||||
|
inputs:
|
||||||
|
platforms:
|
||||||
|
type: choice
|
||||||
|
description: 'Build Platforms'
|
||||||
|
required: true
|
||||||
|
default: 'linux/amd64'
|
||||||
|
options:
|
||||||
|
- 'linux/amd64'
|
||||||
|
- 'linux/amd64,linux/arm64'
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
release:
|
||||||
|
types:
|
||||||
|
- published
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build_and_push_docker:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
env:
|
||||||
|
dev_arch: 'linux/amd64'
|
||||||
|
release_arch: 'linux/amd64,linux/arm64'
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
packages: write
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Docker meta
|
||||||
|
id: meta
|
||||||
|
uses: docker/metadata-action@v5
|
||||||
|
with:
|
||||||
|
images: |
|
||||||
|
docker.io/keglin/pinchflat
|
||||||
|
ghcr.io/${{ github.repository }}
|
||||||
|
# All non-release actions will be tagged as `dev` (ie: push, workflow_dispatch)
|
||||||
|
tags: |
|
||||||
|
type=ref,event=tag
|
||||||
|
type=raw,value=dev,enable=${{ github.event_name != 'release' }}
|
||||||
|
flavor: |
|
||||||
|
latest=auto
|
||||||
|
|
||||||
|
- name: Set up QEMU
|
||||||
|
uses: docker/setup-qemu-action@v3
|
||||||
|
|
||||||
|
- name: Set up Docker Buildx
|
||||||
|
uses: docker/setup-buildx-action@v3
|
||||||
|
|
||||||
|
- name: Login to Docker Hub
|
||||||
|
uses: docker/login-action@v3
|
||||||
|
with:
|
||||||
|
username: ${{ secrets.DOCKERHUB_USERNAME }}
|
||||||
|
password: ${{ secrets.DOCKERHUB_TOKEN }}
|
||||||
|
|
||||||
|
- name: Login to GitHub Container Registry
|
||||||
|
uses: docker/login-action@v3
|
||||||
|
with:
|
||||||
|
registry: ghcr.io
|
||||||
|
username: ${{ github.actor }}
|
||||||
|
password: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
|
||||||
|
- name: Build and Push
|
||||||
|
uses: docker/build-push-action@v5
|
||||||
|
with:
|
||||||
|
context: .
|
||||||
|
file: ./selfhosted.Dockerfile
|
||||||
|
# If the event is a release, use the release_arch, otherwise use the
|
||||||
|
# platforms input if present, falling back to dev_arch
|
||||||
|
platforms: ${{ github.event_name == 'release' && env.release_arch || (github.event.inputs.platforms || env.dev_arch) }}
|
||||||
|
push: true
|
||||||
|
tags: ${{ steps.meta.outputs.tags }}
|
||||||
|
labels: ${{ steps.meta.outputs.labels }}
|
||||||
|
cache-from: type=gha
|
||||||
|
cache-to: type=gha,mode=max
|
||||||
@@ -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,13 @@ 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
|
Pinchflat.Release.check_file_permissions()
|
||||||
"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
|
|
||||||
|
|||||||
+10
-1
@@ -9,7 +9,16 @@
|
|||||||
threshold: :low,
|
threshold: :low,
|
||||||
# All of these are ignorable because this app is intended to be single-user and self-hosted.
|
# All of these are ignorable because this app is intended to be single-user and self-hosted.
|
||||||
# There is an expectation that the user won't intentionally run a FS Traversal on themselves
|
# There is an expectation that the user won't intentionally run a FS Traversal on themselves
|
||||||
ignore: ["CI.System", "Traversal.FileModule", "Config.HTTPS", "Config.CSP"],
|
ignore:
|
||||||
|
[
|
||||||
|
"CI.System",
|
||||||
|
"Traversal.FileModule",
|
||||||
|
"Config.HTTPS",
|
||||||
|
"Config.CSP",
|
||||||
|
"XSS.ContentType",
|
||||||
|
"Traversal.SendFile",
|
||||||
|
"Traversal.SendDownload"
|
||||||
|
],
|
||||||
ignore_files: [],
|
ignore_files: [],
|
||||||
version: false
|
version: false
|
||||||
]
|
]
|
||||||
|
|||||||
@@ -1,39 +1,174 @@
|
|||||||
# 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?
|
<div align="center">
|
||||||
|
|
||||||
TODO: expand on this.
|
[](LICENSE)
|
||||||
|
[](https://github.com/kieraneglin/pinchflat/releases)
|
||||||
|
[](#)
|
||||||
|
|
||||||
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.
|
</div>
|
||||||
|
|
||||||
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.
|
# Your next YouTube media manager
|
||||||
|
|
||||||
|
## Table of contents:
|
||||||
|
|
||||||
|
- [What it does](#what-it-does)
|
||||||
|
- [Features](#features)
|
||||||
|
- [Screenshots](#screenshots)
|
||||||
|
- [Installation](#installation)
|
||||||
|
- [Unraid](#unraid)
|
||||||
|
- [Portainer](#portainer)
|
||||||
|
- [Docker](#docker)
|
||||||
|
- [Environment Variables](#environment-variables)
|
||||||
|
- [Username and Password (authentication)](https://github.com/kieraneglin/pinchflat/wiki/Username-and-Password)
|
||||||
|
- [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 and Contributing](https://github.com/kieraneglin/pinchflat/wiki/Development-and-Contributing)
|
||||||
|
|
||||||
|
## 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, periodically checking 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!
|
||||||
|
|
||||||
|
While you can [download individual videos](https://github.com/kieraneglin/pinchflat/wiki/Frequently-Asked-Questions#how-do-i-download-one-off-videos), Pinchflat is best suited for downloading content from channels or playlists. 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
|
||||||
|
- Supports serving RSS feeds to your favourite podcast app ([docs](https://github.com/kieraneglin/pinchflat/wiki/Podcast-RSS-Feeds))
|
||||||
|
- 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
|
||||||
|
- Apprise support for notifications
|
||||||
|
- Allows automatically redownloading new media after a set period
|
||||||
|
- This can help improve the download quality of new content or improve SponsorBlock tags
|
||||||
|
- Optionally automatically delete old content ([docs](https://github.com/kieraneglin/pinchflat/wiki/Automatically-Delete-Media))
|
||||||
|
- Advanced options like setting cutoff dates and filtering by title
|
||||||
|
- Reliable hands-off operation
|
||||||
|
- Can pass cookies to YouTube to download your private playlists ([docs](https://github.com/kieraneglin/pinchflat/wiki/YouTube-Cookies))
|
||||||
|
- Sponsorblock integration
|
||||||
|
- \[Advanced\] allows custom `yt-dlp` options ([docs](https://github.com/kieraneglin/pinchflat/wiki/%5BAdvanced%5D-Custom-yt%E2%80%90dlp-options))
|
||||||
|
- \[Advanced\] supports running custom scripts when after downloading/deleting media (alpha - [docs](https://github.com/kieraneglin/pinchflat/wiki/%5BAdvanced%5D-Custom-lifecycle-scripts))
|
||||||
|
|
||||||
|
## 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!
|
||||||
|
|
||||||
```bash
|
### Portainer
|
||||||
docker build . --file selfhosted.Dockerfile -t pinchflat:dev
|
|
||||||
|
|
||||||
docker run \
|
> [!IMPORTANT]
|
||||||
-p 8945:8945 \
|
> See the note below about storing config on a network file share. It's preferred to store the config on a local disk if at all possible.
|
||||||
-v /Users/work/Desktop/test_volumes/config:/config \
|
|
||||||
-v /Users/work/Desktop/test_volumes/downloads:/downloads \
|
Docker Compose file:
|
||||||
pinchflat:dev
|
|
||||||
|
```yaml
|
||||||
|
version: '3'
|
||||||
|
services:
|
||||||
|
pinchflat:
|
||||||
|
image: keglin/pinchflat:latest
|
||||||
|
environment:
|
||||||
|
# Set the timezone to your local timezone
|
||||||
|
- TZ=America/New_York
|
||||||
|
ports:
|
||||||
|
- '8945:8945'
|
||||||
|
volumes:
|
||||||
|
- /host/path/to/config:/config
|
||||||
|
- /host/path/to/downloads:/downloads
|
||||||
```
|
```
|
||||||
|
|
||||||
## Authentication
|
### Docker
|
||||||
|
|
||||||
Currently HTTP basic auth is optionally supported. To use it, set the `BASIC_AUTH_USERNAME` and `BASIC_AUTH_PASSWORD` environment variables when starting the container. If you don't set both of these, no authentication will be required.
|
1. Create two directories on your host machine: one for storing config and one for storing downloaded media. Make sure they're both writable by the user running the Docker container.
|
||||||
|
2. Prepare the docker image in one of the two ways below:
|
||||||
|
- **From GHCR:** `docker pull ghcr.io/kieraneglin/pinchflat:latest`
|
||||||
|
- NOTE: also available on Docker Hub at `keglin/pinchflat:latest`
|
||||||
|
- **Building locally:** `docker build . --file selfhosted.Dockerfile -t ghcr.io/kieraneglin/pinchflat:latest`
|
||||||
|
3. Run the container:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Be sure to replace /host/path/to/config and /host/path/to/downloads below with
|
||||||
|
# the paths to the directories you created in step 1
|
||||||
|
# Be sure to replace America/New_York with your local timezone
|
||||||
|
docker run \
|
||||||
|
-e TZ=America/New_York \
|
||||||
|
-p 8945:8945 \
|
||||||
|
-v /host/path/to/config:/config \
|
||||||
|
-v /host/path/to/downloads:/downloads \
|
||||||
|
ghcr.io/kieraneglin/pinchflat:latest
|
||||||
|
```
|
||||||
|
|
||||||
|
### IMPORTANT: File permissions
|
||||||
|
|
||||||
|
You _must_ ensure the host directories you've mounted are writable by the user running the Docker container. If you get a permission error follow the steps it suggests. See [#106](https://github.com/kieraneglin/pinchflat/issues/106) for more.
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> It's not recommended to run the container as root. Doing so can create permission issues if other apps need to work with the downloaded media.
|
||||||
|
|
||||||
|
> [!TIP]
|
||||||
|
> 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.
|
||||||
|
|
||||||
|
### ADVANCED: Storing Pinchflat config directory on a network share
|
||||||
|
|
||||||
|
As pointed out in [#137](https://github.com/kieraneglin/pinchflat/issues/137), SQLite doesn't like being run in WAL mode on network shares. If you're running Pinchflat on a network share, you can disable WAL mode by setting the `JOURNAL_MODE` environment variable to `delete`. This will make Pinchflat run in rollback journal mode which is less performant but should work on network shares.
|
||||||
|
|
||||||
|
> [!CAUTION]
|
||||||
|
> Changing this setting from WAL to `delete` on an existing Pinchflat instance could, conceivably, result in data loss. Only change this setting if you know what you're doing, why this is important, and are okay with possible data loss or DB corruption. Backup your database first!
|
||||||
|
|
||||||
|
If you change this setting and it works well for you, please leave a comment on [#137](https://github.com/kieraneglin/pinchflat/issues/137)! Doubly so if it does _not_ work well.
|
||||||
|
|
||||||
|
### Environment variables
|
||||||
|
|
||||||
|
| Name | Required? | Default | Notes |
|
||||||
|
| --------------------- | --------- | ------------------------- | ---------------------------------------------------------------------------------------------- |
|
||||||
|
| TZ | No | `UTC` | Must follow IANA TZ format |
|
||||||
|
| LOG_LEVEL | No | `debug` | Can be set to `info` |
|
||||||
|
| BASIC_AUTH_USERNAME | No | | See [authentication docs](https://github.com/kieraneglin/pinchflat/wiki/Username-and-Password) |
|
||||||
|
| BASIC_AUTH_PASSWORD | No | | See [authentication docs](https://github.com/kieraneglin/pinchflat/wiki/Username-and-Password) |
|
||||||
|
| EXPOSE_FEED_ENDPOINTS | No | | See [RSS feed docs](https://github.com/kieraneglin/pinchflat/wiki/Podcast-RSS-Feeds) |
|
||||||
|
| JOURNAL_MODE | No | `wal` | Set to `delete` if your config directory is stored on a network share (not recommended) |
|
||||||
|
| TZ_DATA_DIR | No | `/etc/elixir_tzdata_data` | The container path where the timezone database is stored |
|
||||||
|
|
||||||
|
## EFF donations
|
||||||
|
|
||||||
|
Prior to 2024-05-10, a portion of all donations were given to the [Electronic Frontier Foundation](https://www.eff.org/). Now, the app doesn't accept donations that go to me personally and instead directs you straight to the EFF. [Here](https://github.com/kieraneglin/pinchflat/issues/234) are some people that have generously donated.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
## 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.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
See `LICENSE` file
|
See `LICENSE` file
|
||||||
|
|
||||||
```
|
<!-- Images and links -->
|
||||||
|
|
||||||
```
|
[license-badge]: https://img.shields.io/github/license/kieraneglin/pinchflat?style=for-the-badge&color=ee512b
|
||||||
|
[license-badge-url]: LICENSE
|
||||||
|
|||||||
@@ -0,0 +1,37 @@
|
|||||||
|
window.copyTextToClipboard = async (text) => {
|
||||||
|
// Navigator clipboard api needs a secure context (https)
|
||||||
|
if (navigator.clipboard && window.isSecureContext) {
|
||||||
|
await navigator.clipboard.writeText(text)
|
||||||
|
} else {
|
||||||
|
const textArea = document.createElement('textarea')
|
||||||
|
textArea.value = text
|
||||||
|
// Move textarea out of the viewport so it's not visible
|
||||||
|
textArea.style.position = 'absolute'
|
||||||
|
textArea.style.left = '-999999px'
|
||||||
|
|
||||||
|
document.body.prepend(textArea)
|
||||||
|
textArea.select()
|
||||||
|
|
||||||
|
try {
|
||||||
|
document.execCommand('copy')
|
||||||
|
} catch (error) {
|
||||||
|
console.error(error)
|
||||||
|
} finally {
|
||||||
|
textArea.remove()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
window.copyWithCallbacks = async (text, onCopy, onAfterDelay, delay = 4000) => {
|
||||||
|
await window.copyTextToClipboard(text)
|
||||||
|
onCopy()
|
||||||
|
setTimeout(onAfterDelay, delay)
|
||||||
|
}
|
||||||
|
|
||||||
|
window.markVersionAsSeen = (versionString) => {
|
||||||
|
localStorage.setItem('seenVersion', versionString)
|
||||||
|
}
|
||||||
|
|
||||||
|
window.isVersionSeen = (versionString) => {
|
||||||
|
return localStorage.getItem('seenVersion') === versionString
|
||||||
|
}
|
||||||
@@ -22,6 +22,8 @@ import { Socket } from 'phoenix'
|
|||||||
import { LiveSocket } from 'phoenix_live_view'
|
import { LiveSocket } from 'phoenix_live_view'
|
||||||
import topbar from '../vendor/topbar'
|
import topbar from '../vendor/topbar'
|
||||||
import Alpine from 'alpinejs'
|
import Alpine from 'alpinejs'
|
||||||
|
import './tabs'
|
||||||
|
import './alpine_helpers'
|
||||||
|
|
||||||
window.Alpine = Alpine
|
window.Alpine = Alpine
|
||||||
Alpine.start()
|
Alpine.start()
|
||||||
@@ -35,6 +37,17 @@ let liveSocket = new LiveSocket('/live', Socket, {
|
|||||||
window.Alpine.clone(from, to)
|
window.Alpine.clone(from, to)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
},
|
||||||
|
hooks: {
|
||||||
|
supressEnterSubmission: {
|
||||||
|
mounted() {
|
||||||
|
this.el.addEventListener('keypress', (event) => {
|
||||||
|
if (event.key === 'Enter') {
|
||||||
|
event.preventDefault()
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,20 @@
|
|||||||
|
window.setTabByName = (tabName) => {
|
||||||
|
window.location.hash = `tab-${tabName}`
|
||||||
|
|
||||||
|
return tabName
|
||||||
|
}
|
||||||
|
|
||||||
|
// The conditionals and currIndex stuff ensures that
|
||||||
|
// the tab index is always set to 0 if the hash is empty
|
||||||
|
// AND other hash values are ignored
|
||||||
|
window.getTabFromHash = (currentTabName, defaultTabName) => {
|
||||||
|
if (window.location.hash === '' || window.location.hash === '#') {
|
||||||
|
return defaultTabName
|
||||||
|
}
|
||||||
|
|
||||||
|
if (window.location.hash.startsWith('#tab-')) {
|
||||||
|
return window.location.hash.replace('#tab-', '')
|
||||||
|
}
|
||||||
|
|
||||||
|
return currentTabName
|
||||||
|
}
|
||||||
+33
-7
@@ -12,20 +12,31 @@ 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,
|
apprise_executable: System.find_executable("apprise"),
|
||||||
|
yt_dlp_runner: Pinchflat.YtDlp.CommandRunner,
|
||||||
|
apprise_runner: Pinchflat.Lifecycle.Notifications.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",
|
||||||
|
extras_directory: "/config/extras",
|
||||||
tmpfile_directory: Path.join([System.tmp_dir!(), "pinchflat", "data"]),
|
tmpfile_directory: Path.join([System.tmp_dir!(), "pinchflat", "data"]),
|
||||||
# Setting BASIC_AUTH_USERNAME and BASIC_AUTH_PASSWORD implies you want to use basic auth.
|
# Setting BASIC_AUTH_USERNAME and BASIC_AUTH_PASSWORD implies you want to use basic auth.
|
||||||
# If either is unset, basic auth will not be used.
|
# If either is unset, basic auth will not be used.
|
||||||
basic_auth_username: System.get_env("BASIC_AUTH_USERNAME"),
|
basic_auth_username: "",
|
||||||
basic_auth_password: System.get_env("BASIC_AUTH_PASSWORD"),
|
basic_auth_password: "",
|
||||||
file_watcher_poll_interval: 1000
|
expose_feed_endpoints: false,
|
||||||
|
file_watcher_poll_interval: 1000,
|
||||||
|
timezone: "UTC"
|
||||||
|
|
||||||
|
config :pinchflat, Pinchflat.Repo,
|
||||||
|
journal_mode: :wal,
|
||||||
|
pool_size: 5
|
||||||
|
|
||||||
# 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],
|
||||||
@@ -38,9 +49,24 @@ config :pinchflat, Oban,
|
|||||||
engine: Oban.Engines.Lite,
|
engine: Oban.Engines.Lite,
|
||||||
repo: Pinchflat.Repo,
|
repo: Pinchflat.Repo,
|
||||||
# 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},
|
||||||
|
{Oban.Plugins.Cron,
|
||||||
|
crontab: [
|
||||||
|
{"0 1 * * *", Pinchflat.Downloading.MediaRetentionWorker},
|
||||||
|
{"0 2 * * *", Pinchflat.Downloading.MediaQualityUpgradeWorker}
|
||||||
|
]}
|
||||||
|
],
|
||||||
# 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
|
||||||
#
|
#
|
||||||
@@ -63,7 +89,7 @@ config :esbuild,
|
|||||||
|
|
||||||
# Configure tailwind (the version is required)
|
# Configure tailwind (the version is required)
|
||||||
config :tailwind,
|
config :tailwind,
|
||||||
version: "3.3.2",
|
version: "3.4.3",
|
||||||
default: [
|
default: [
|
||||||
args: ~w(
|
args: ~w(
|
||||||
--config=tailwind.config.js
|
--config=tailwind.config.js
|
||||||
|
|||||||
+1
-1
@@ -3,6 +3,7 @@ import Config
|
|||||||
config :pinchflat,
|
config :pinchflat,
|
||||||
media_directory: Path.join([File.cwd!(), "tmp", "media"]),
|
media_directory: Path.join([File.cwd!(), "tmp", "media"]),
|
||||||
metadata_directory: Path.join([File.cwd!(), "tmp", "metadata"]),
|
metadata_directory: Path.join([File.cwd!(), "tmp", "metadata"]),
|
||||||
|
extras_directory: Path.join([File.cwd!(), "tmp", "extras"]),
|
||||||
tmpfile_directory: Path.join([File.cwd!(), "tmp", "tmpfiles"])
|
tmpfile_directory: Path.join([File.cwd!(), "tmp", "tmpfiles"])
|
||||||
|
|
||||||
# Configure your database
|
# Configure your database
|
||||||
@@ -21,7 +22,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",
|
||||||
|
|||||||
+35
-69
@@ -25,37 +25,53 @@ 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")
|
||||||
|
|
||||||
if config_env() == :prod do
|
arch_string = to_string(:erlang.system_info(:system_architecture))
|
||||||
config_path =
|
|
||||||
System.get_env("CONFIG_PATH") ||
|
|
||||||
raise """
|
|
||||||
environment variable CONFIG_PATH is missing.
|
|
||||||
For example: /etc/pinchflat/config
|
|
||||||
"""
|
|
||||||
|
|
||||||
|
system_arch =
|
||||||
|
cond do
|
||||||
|
String.contains?(arch_string, "arm") -> "arm"
|
||||||
|
String.contains?(arch_string, "aarch") -> "arm"
|
||||||
|
String.contains?(arch_string, "x86") -> "x86"
|
||||||
|
true -> "unknown"
|
||||||
|
end
|
||||||
|
|
||||||
|
config :pinchflat, Pinchflat.Repo,
|
||||||
|
load_extensions: [
|
||||||
|
Path.join([:code.priv_dir(:pinchflat), "repo", "extensions", "sqlean-linux-#{system_arch}", "sqlean"])
|
||||||
|
]
|
||||||
|
|
||||||
|
if config_env() == :prod do
|
||||||
|
config_path = "/config"
|
||||||
db_path = System.get_env("DATABASE_PATH", Path.join([config_path, "db", "pinchflat.db"]))
|
db_path = System.get_env("DATABASE_PATH", Path.join([config_path, "db", "pinchflat.db"]))
|
||||||
log_path = System.get_env("LOG_PATH", Path.join([config_path, "logs", "pinchflat.log"]))
|
log_path = System.get_env("LOG_PATH", Path.join([config_path, "logs", "pinchflat.log"]))
|
||||||
metadata_path = System.get_env("METADATA_PATH", Path.join([config_path, "metadata"]))
|
metadata_path = System.get_env("METADATA_PATH", Path.join([config_path, "metadata"]))
|
||||||
|
extras_path = System.get_env("EXTRAS_PATH", Path.join([config_path, "extras"]))
|
||||||
|
|
||||||
# We want to force _some_ level of useful logging in production
|
# For running PF as a podcast host on self-hosted environments
|
||||||
acceptable_log_levels = ~w(debug info)a
|
expose_feed_endpoints = String.length(System.get_env("EXPOSE_FEED_ENDPOINTS", "")) > 0
|
||||||
log_level = String.to_existing_atom(System.get_env("LOG_LEVEL", "info"))
|
|
||||||
|
|
||||||
if log_level in acceptable_log_levels do
|
# For testing alternate journal modes (see issue #137)
|
||||||
config :logger, level: log_level
|
journal_mode = String.to_existing_atom(System.get_env("JOURNAL_MODE", "wal"))
|
||||||
else
|
|
||||||
Logger.error("Invalid log level: #{log_level}. Defaulting to info.")
|
config :logger, level: String.to_existing_atom(System.get_env("LOG_LEVEL", "debug"))
|
||||||
config :logger, level: :info
|
|
||||||
end
|
|
||||||
|
|
||||||
config :pinchflat,
|
config :pinchflat,
|
||||||
yt_dlp_executable: System.find_executable("yt-dlp"),
|
yt_dlp_executable: System.find_executable("yt-dlp"),
|
||||||
|
apprise_executable: System.find_executable("apprise"),
|
||||||
|
media_directory: "/downloads",
|
||||||
metadata_directory: metadata_path,
|
metadata_directory: metadata_path,
|
||||||
dns_cluster_query: System.get_env("DNS_CLUSTER_QUERY")
|
extras_directory: extras_path,
|
||||||
|
tmpfile_directory: Path.join([System.tmp_dir!(), "pinchflat", "data"]),
|
||||||
|
dns_cluster_query: System.get_env("DNS_CLUSTER_QUERY"),
|
||||||
|
expose_feed_endpoints: expose_feed_endpoints,
|
||||||
|
timezone: System.get_env("TIMEZONE") || System.get_env("TZ") || "UTC",
|
||||||
|
log_path: log_path
|
||||||
|
|
||||||
|
config :tzdata, :data_dir, System.get_env("TZ_DATA_DIR", "/etc/elixir_tzdata_data")
|
||||||
|
|
||||||
config :pinchflat, Pinchflat.Repo,
|
config :pinchflat, Pinchflat.Repo,
|
||||||
database: db_path,
|
database: db_path,
|
||||||
pool_size: String.to_integer(System.get_env("POOL_SIZE") || "5")
|
journal_mode: journal_mode
|
||||||
|
|
||||||
# The secret key base is used to sign/encrypt cookies and other secrets.
|
# The secret key base is used to sign/encrypt cookies and other secrets.
|
||||||
# A default value is used in config/dev.exs and config/test.exs but you
|
# A default value is used in config/dev.exs and config/test.exs but you
|
||||||
@@ -89,7 +105,7 @@ if config_env() == :prod do
|
|||||||
# Set it to {0, 0, 0, 0, 0, 0, 0, 1} for local network only access.
|
# Set it to {0, 0, 0, 0, 0, 0, 0, 1} for local network only access.
|
||||||
# See the documentation on https://hexdocs.pm/plug_cowboy/Plug.Cowboy.html
|
# See the documentation on https://hexdocs.pm/plug_cowboy/Plug.Cowboy.html
|
||||||
# for details about using IPv6 vs IPv4 and loopback vs public addresses.
|
# for details about using IPv6 vs IPv4 and loopback vs public addresses.
|
||||||
ip: {0, 0, 0, 0, 0, 0, 0, 0},
|
ip: {0, 0, 0, 0},
|
||||||
port: String.to_integer(System.get_env("PORT") || "4000")
|
port: String.to_integer(System.get_env("PORT") || "4000")
|
||||||
],
|
],
|
||||||
secret_key_base: secret_key_base
|
secret_key_base: secret_key_base
|
||||||
@@ -108,54 +124,4 @@ if config_env() == :prod do
|
|||||||
formatter: Logger.Formatter.new()
|
formatter: Logger.Formatter.new()
|
||||||
}}
|
}}
|
||||||
]
|
]
|
||||||
|
|
||||||
# ## SSL Support
|
|
||||||
#
|
|
||||||
# To get SSL working, you will need to add the `https` key
|
|
||||||
# to your endpoint configuration:
|
|
||||||
#
|
|
||||||
# config :pinchflat, PinchflatWeb.Endpoint,
|
|
||||||
# https: [
|
|
||||||
# ...,
|
|
||||||
# port: 443,
|
|
||||||
# cipher_suite: :strong,
|
|
||||||
# keyfile: System.get_env("SOME_APP_SSL_KEY_PATH"),
|
|
||||||
# certfile: System.get_env("SOME_APP_SSL_CERT_PATH")
|
|
||||||
# ]
|
|
||||||
#
|
|
||||||
# The `cipher_suite` is set to `:strong` to support only the
|
|
||||||
# latest and more secure SSL ciphers. This means old browsers
|
|
||||||
# and clients may not be supported. You can set it to
|
|
||||||
# `:compatible` for wider support.
|
|
||||||
#
|
|
||||||
# `:keyfile` and `:certfile` expect an absolute path to the key
|
|
||||||
# and cert in disk or a relative path inside priv, for example
|
|
||||||
# "priv/ssl/server.key". For all supported SSL configuration
|
|
||||||
# options, see https://hexdocs.pm/plug/Plug.SSL.html#configure/1
|
|
||||||
#
|
|
||||||
# We also recommend setting `force_ssl` in your endpoint, ensuring
|
|
||||||
# no data is ever sent via http, always redirecting to https:
|
|
||||||
#
|
|
||||||
# config :pinchflat, PinchflatWeb.Endpoint,
|
|
||||||
# force_ssl: [hsts: true]
|
|
||||||
#
|
|
||||||
# Check `Plug.SSL` for all available options in `force_ssl`.
|
|
||||||
|
|
||||||
# ## Configuring the mailer
|
|
||||||
#
|
|
||||||
# In production you need to configure the mailer to use a different adapter.
|
|
||||||
# Also, you may need to configure the Swoosh API client of your choice if you
|
|
||||||
# are not using SMTP. Here is an example of the configuration:
|
|
||||||
#
|
|
||||||
# config :pinchflat, Pinchflat.Mailer,
|
|
||||||
# adapter: Swoosh.Adapters.Mailgun,
|
|
||||||
# api_key: System.get_env("MAILGUN_API_KEY"),
|
|
||||||
# domain: System.get_env("MAILGUN_DOMAIN")
|
|
||||||
#
|
|
||||||
# For this example you need include a HTTP client required by Swoosh API client.
|
|
||||||
# Swoosh supports Hackney and Finch out of the box:
|
|
||||||
#
|
|
||||||
# config :swoosh, :api_client, Swoosh.ApiClient.Hackney
|
|
||||||
#
|
|
||||||
# See https://hexdocs.pm/swoosh/Swoosh.html#module-installation for details.
|
|
||||||
end
|
end
|
||||||
|
|||||||
+2
-3
@@ -3,6 +3,7 @@ import Config
|
|||||||
config :pinchflat,
|
config :pinchflat,
|
||||||
# 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: Path.join([File.cwd!(), "/test/support/scripts/yt-dlp-mocks/repeater.sh"]),
|
yt_dlp_executable: Path.join([File.cwd!(), "/test/support/scripts/yt-dlp-mocks/repeater.sh"]),
|
||||||
|
apprise_executable: Path.join([File.cwd!(), "/test/support/scripts/yt-dlp-mocks/repeater.sh"]),
|
||||||
media_directory: Path.join([System.tmp_dir!(), "test", "media"]),
|
media_directory: Path.join([System.tmp_dir!(), "test", "media"]),
|
||||||
metadata_directory: Path.join([System.tmp_dir!(), "test", "metadata"]),
|
metadata_directory: Path.join([System.tmp_dir!(), "test", "metadata"]),
|
||||||
tmpfile_directory: Path.join([System.tmp_dir!(), "test", "tmpfiles"]),
|
tmpfile_directory: Path.join([System.tmp_dir!(), "test", "tmpfiles"]),
|
||||||
@@ -17,7 +18,6 @@ config :pinchflat, Oban, testing: :manual
|
|||||||
# Run `mix help test` for more information.
|
# Run `mix help test` for more information.
|
||||||
config :pinchflat, Pinchflat.Repo,
|
config :pinchflat, Pinchflat.Repo,
|
||||||
database: Path.expand("../priv/repo/pinchflat_test.db", Path.dirname(__ENV__.file)),
|
database: Path.expand("../priv/repo/pinchflat_test.db", Path.dirname(__ENV__.file)),
|
||||||
pool_size: 5,
|
|
||||||
pool: Ecto.Adapters.SQL.Sandbox
|
pool: Ecto.Adapters.SQL.Sandbox
|
||||||
|
|
||||||
# We don't run a server during test. If one is required,
|
# We don't run a server during test. If one is required,
|
||||||
@@ -33,8 +33,7 @@ config :pinchflat, Pinchflat.Mailer, adapter: Swoosh.Adapters.Test
|
|||||||
# Disable swoosh api client as it is only required for production adapters.
|
# Disable swoosh api client as it is only required for production adapters.
|
||||||
config :swoosh, :api_client, false
|
config :swoosh, :api_client, false
|
||||||
|
|
||||||
# Print only warnings and errors during test
|
config :logger, level: :critical
|
||||||
config :logger, level: :warning
|
|
||||||
|
|
||||||
# Initialize plugs at runtime for faster test compilation
|
# Initialize plugs at runtime for faster test compilation
|
||||||
config :phoenix, :plug_init_mode, :runtime
|
config :phoenix, :plug_init_mode, :runtime
|
||||||
|
|||||||
+37
-7
@@ -1,10 +1,27 @@
|
|||||||
# 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}
|
||||||
|
|
||||||
|
ARG TARGETPLATFORM
|
||||||
|
RUN echo "Building for ${TARGETPLATFORM:?}"
|
||||||
|
|
||||||
# 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 curl git openssh-client jq \
|
||||||
python3 python3-pip python3-setuptools python3-wheel python3-dev
|
python3 python3-setuptools python3-wheel python3-dev pipx \
|
||||||
|
python3-mutagen locales procps build-essential graphviz
|
||||||
|
|
||||||
|
# Install ffmpeg
|
||||||
|
RUN export FFMPEG_DOWNLOAD=$(case ${TARGETPLATFORM:-linux/amd64} in \
|
||||||
|
"linux/amd64") echo "https://github.com/yt-dlp/FFmpeg-Builds/releases/download/latest/ffmpeg-master-latest-linux64-gpl.tar.xz" ;; \
|
||||||
|
"linux/arm64") echo "https://github.com/yt-dlp/FFmpeg-Builds/releases/download/latest/ffmpeg-master-latest-linuxarm64-gpl.tar.xz" ;; \
|
||||||
|
*) echo "" ;; esac) && \
|
||||||
|
curl -L ${FFMPEG_DOWNLOAD} --output /tmp/ffmpeg.tar.xz && \
|
||||||
|
tar -xf /tmp/ffmpeg.tar.xz --strip-components=2 --no-anchored -C /usr/bin/ "ffmpeg" && \
|
||||||
|
tar -xf /tmp/ffmpeg.tar.xz --strip-components=2 --no-anchored -C /usr/bin/ "ffprobe"
|
||||||
|
|
||||||
# Install nodejs
|
# Install nodejs
|
||||||
RUN curl -sL https://deb.nodesource.com/setup_20.x -o nodesource_setup.sh
|
RUN curl -sL https://deb.nodesource.com/setup_20.x -o nodesource_setup.sh
|
||||||
@@ -16,9 +33,21 @@ RUN npm install -g yarn
|
|||||||
RUN mix local.hex --force
|
RUN mix local.hex --force
|
||||||
RUN mix local.rebar --force
|
RUN mix local.rebar --force
|
||||||
|
|
||||||
# Download YT-DLP
|
# Download and update YT-DLP
|
||||||
# NOTE: If you're seeing weird issues, consider using the FFMPEG released by yt-dlp
|
RUN curl -L https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -o /usr/local/bin/yt-dlp
|
||||||
RUN python3 -m pip install -U --pre yt-dlp --break-system-packages
|
RUN chmod a+rx /usr/local/bin/yt-dlp
|
||||||
|
RUN yt-dlp -U
|
||||||
|
|
||||||
|
# Install Apprise
|
||||||
|
RUN export PIPX_HOME=/opt/pipx && \
|
||||||
|
export PIPX_BIN_DIR=/usr/local/bin && \
|
||||||
|
pipx install apprise
|
||||||
|
|
||||||
|
# Set the locale
|
||||||
|
RUN sed -i '/en_US.UTF-8/s/^# //g' /etc/locale.gen && locale-gen
|
||||||
|
ENV LANG en_US.UTF-8
|
||||||
|
ENV LANGUAGE en_US:en
|
||||||
|
ENV LC_ALL en_US.UTF-8
|
||||||
|
|
||||||
# Create app directory and copy the Elixir projects into it.
|
# Create app directory and copy the Elixir projects into it.
|
||||||
WORKDIR /app
|
WORKDIR /app
|
||||||
@@ -28,6 +57,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"
|
||||||
|
|||||||
@@ -1,6 +0,0 @@
|
|||||||
- Write media datbase ID as metadata/to file/whatever so it gives us an option to retroactively match media to the DB down the line. Useful if someone moves the media without informing the UI
|
|
||||||
- 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
|
|
||||||
- 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
|
||||||
@@ -23,7 +24,7 @@ defmodule Pinchflat.Application do
|
|||||||
PinchflatWeb.Endpoint
|
PinchflatWeb.Endpoint
|
||||||
]
|
]
|
||||||
|
|
||||||
:ok = Oban.Telemetry.attach_default_logger()
|
attach_oban_telemetry()
|
||||||
Logger.add_handlers(:pinchflat)
|
Logger.add_handlers(:pinchflat)
|
||||||
|
|
||||||
# See https://hexdocs.pm/elixir/Supervisor.html
|
# See https://hexdocs.pm/elixir/Supervisor.html
|
||||||
@@ -39,4 +40,11 @@ defmodule Pinchflat.Application do
|
|||||||
PinchflatWeb.Endpoint.config_change(changed, removed)
|
PinchflatWeb.Endpoint.config_change(changed, removed)
|
||||||
:ok
|
:ok
|
||||||
end
|
end
|
||||||
|
|
||||||
|
defp attach_oban_telemetry do
|
||||||
|
events = [[:oban, :job, :start], [:oban, :job, :stop], [:oban, :job, :exception]]
|
||||||
|
|
||||||
|
:ok = Oban.Telemetry.attach_default_logger()
|
||||||
|
:telemetry.attach_many("job-telemetry-broadcast", events, &PinchflatWeb.Telemetry.job_state_change_broadcast/4, [])
|
||||||
|
end
|
||||||
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,7 @@ 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
|
|
||||||
|
|
||||||
def start_link(opts \\ []) do
|
def start_link(opts \\ []) do
|
||||||
GenServer.start_link(__MODULE__, %{}, opts)
|
GenServer.start_link(__MODULE__, %{}, opts)
|
||||||
@@ -21,16 +21,13 @@ 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()
|
# Nothing at the moment!
|
||||||
|
|
||||||
{:ok, state}
|
{:ok, state}
|
||||||
end
|
end
|
||||||
|
|
||||||
defp apply_default_settings do
|
|
||||||
Settings.fetch!(:onboarding, true)
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
@@ -0,0 +1,105 @@
|
|||||||
|
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
|
||||||
|
alias Pinchflat.Utils.FilesystemUtils
|
||||||
|
|
||||||
|
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
|
||||||
|
ensure_tmpfile_directory()
|
||||||
|
reset_executing_jobs()
|
||||||
|
create_blank_yt_dlp_files()
|
||||||
|
create_blank_user_script_file()
|
||||||
|
apply_default_settings()
|
||||||
|
|
||||||
|
{:ok, state}
|
||||||
|
end
|
||||||
|
|
||||||
|
defp ensure_tmpfile_directory do
|
||||||
|
tmpfile_dir = Application.get_env(:pinchflat, :tmpfile_directory)
|
||||||
|
|
||||||
|
if !File.exists?(tmpfile_dir) do
|
||||||
|
File.mkdir_p!(tmpfile_dir)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# If a node cannot gracefully shut down, the currently executing jobs get stuck
|
||||||
|
# in the "executing" state. This is a problem because the job runner will not
|
||||||
|
# pick them up again
|
||||||
|
defp reset_executing_jobs do
|
||||||
|
{count, _} =
|
||||||
|
Oban.Job
|
||||||
|
|> where(state: "executing")
|
||||||
|
|> Repo.update_all(set: [state: "retryable"])
|
||||||
|
|
||||||
|
Logger.info("Reset #{count} executing jobs")
|
||||||
|
end
|
||||||
|
|
||||||
|
defp create_blank_yt_dlp_files do
|
||||||
|
files = ["cookies.txt", "yt-dlp-configs/base-config.txt"]
|
||||||
|
base_dir = Application.get_env(:pinchflat, :extras_directory)
|
||||||
|
|
||||||
|
Enum.each(files, fn file ->
|
||||||
|
filepath = Path.join(base_dir, file)
|
||||||
|
|
||||||
|
if !File.exists?(filepath) do
|
||||||
|
Logger.info("Creating blank file: #{filepath}")
|
||||||
|
|
||||||
|
FilesystemUtils.write_p!(filepath, "")
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp create_blank_user_script_file do
|
||||||
|
base_dir = Application.get_env(:pinchflat, :extras_directory)
|
||||||
|
filepath = Path.join([base_dir, "user-scripts", "lifecycle"])
|
||||||
|
|
||||||
|
if !File.exists?(filepath) do
|
||||||
|
Logger.info("Creating blank file and making it executable: #{filepath}")
|
||||||
|
|
||||||
|
FilesystemUtils.write_p!(filepath, "")
|
||||||
|
File.chmod(filepath, 0o755)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp apply_default_settings do
|
||||||
|
{:ok, yt_dlp_version} = yt_dlp_runner().version()
|
||||||
|
{:ok, apprise_version} = apprise_runner().version()
|
||||||
|
|
||||||
|
Settings.set(yt_dlp_version: yt_dlp_version)
|
||||||
|
Settings.set(apprise_version: apprise_version)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp yt_dlp_runner do
|
||||||
|
Application.get_env(:pinchflat, :yt_dlp_runner)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp apprise_runner do
|
||||||
|
Application.get_env(:pinchflat, :apprise_runner)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,82 @@
|
|||||||
|
defmodule Pinchflat.Downloading.CodecParser do
|
||||||
|
@moduledoc """
|
||||||
|
Functions for generating yt-dlp codec strings
|
||||||
|
"""
|
||||||
|
|
||||||
|
alias Pinchflat.Settings
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Generate a video codec string based on the value of the video_codec_preference setting.
|
||||||
|
|
||||||
|
Returns binary()
|
||||||
|
"""
|
||||||
|
def generate_vcodec_string_from_settings do
|
||||||
|
generate_vcodec_string(Settings.get!(:video_codec_preference))
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Generate an audio codec string based on the value of the audio_codec_preference setting.
|
||||||
|
|
||||||
|
Returns binary()
|
||||||
|
"""
|
||||||
|
def generate_acodec_string_from_settings do
|
||||||
|
generate_acodec_string(Settings.get!(:audio_codec_preference))
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Generate a video codec string from a list of video codecs.
|
||||||
|
|
||||||
|
If the list is nil or empty, the default video codec is AVC.
|
||||||
|
|
||||||
|
Returns binary()
|
||||||
|
"""
|
||||||
|
def generate_vcodec_string(nil), do: "bestvideo[vcodec~='^avc']/bestvideo"
|
||||||
|
def generate_vcodec_string([]), do: generate_vcodec_string(nil)
|
||||||
|
|
||||||
|
def generate_vcodec_string(video_codecs) do
|
||||||
|
video_codecs
|
||||||
|
|> Enum.map(&video_codec_map()[&1])
|
||||||
|
|> Enum.reject(&is_nil/1)
|
||||||
|
|> Enum.map(&"bestvideo[vcodec~='^#{&1}']")
|
||||||
|
|> Enum.concat(["bestvideo"])
|
||||||
|
|> Enum.join("/")
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Generate an audio codec string from a list of audio codecs.
|
||||||
|
|
||||||
|
If the list is nil or empty, the default audio codec is MP4A.
|
||||||
|
|
||||||
|
Returns binary()
|
||||||
|
"""
|
||||||
|
def generate_acodec_string(nil), do: "bestaudio[acodec~='^mp4a']/bestaudio"
|
||||||
|
def generate_acodec_string([]), do: generate_acodec_string(nil)
|
||||||
|
|
||||||
|
def generate_acodec_string(audio_codecs) do
|
||||||
|
audio_codecs
|
||||||
|
|> Enum.map(&audio_codec_map()[&1])
|
||||||
|
|> Enum.reject(&is_nil/1)
|
||||||
|
|> Enum.map(&"bestaudio[acodec~='^#{&1}']")
|
||||||
|
|> Enum.concat(["bestaudio"])
|
||||||
|
|> Enum.join("/")
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc false
|
||||||
|
def video_codec_map do
|
||||||
|
%{
|
||||||
|
"av01" => "av01",
|
||||||
|
"avc" => "avc",
|
||||||
|
"vp9" => "vp0?9"
|
||||||
|
}
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc false
|
||||||
|
def audio_codec_map do
|
||||||
|
%{
|
||||||
|
"aac" => "aac",
|
||||||
|
"mp4a" => "mp4a",
|
||||||
|
"mp3" => "mp3",
|
||||||
|
"opus" => "opus"
|
||||||
|
}
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,230 @@
|
|||||||
|
defmodule Pinchflat.Downloading.DownloadOptionBuilder do
|
||||||
|
@moduledoc """
|
||||||
|
Builds the options for yt-dlp to download media based on the given media profile.
|
||||||
|
"""
|
||||||
|
|
||||||
|
alias Pinchflat.Sources
|
||||||
|
alias Pinchflat.Sources.Source
|
||||||
|
alias Pinchflat.Media.MediaItem
|
||||||
|
alias Pinchflat.Downloading.CodecParser
|
||||||
|
alias Pinchflat.Downloading.OutputPathBuilder
|
||||||
|
|
||||||
|
alias Pinchflat.Utils.FilesystemUtils, as: FSUtils
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Builds the options for yt-dlp to download media based on the given media's profile.
|
||||||
|
|
||||||
|
Returns {:ok, [Keyword.t()]}
|
||||||
|
"""
|
||||||
|
def build(%MediaItem{} = media_item_with_preloads, override_opts \\ []) do
|
||||||
|
media_profile = media_item_with_preloads.source.media_profile
|
||||||
|
|
||||||
|
built_options =
|
||||||
|
default_options(override_opts) ++
|
||||||
|
subtitle_options(media_profile) ++
|
||||||
|
thumbnail_options(media_item_with_preloads) ++
|
||||||
|
metadata_options(media_profile) ++
|
||||||
|
quality_options(media_profile) ++
|
||||||
|
sponsorblock_options(media_profile) ++
|
||||||
|
output_options(media_item_with_preloads) ++
|
||||||
|
config_file_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. Uses the source's override output path template if it exists.
|
||||||
|
|
||||||
|
Accepts a %MediaItem{} or %Source{} struct. If a %Source{} struct is passed, it
|
||||||
|
will use a default %MediaItem{} struct with the given source.
|
||||||
|
|
||||||
|
Returns binary()
|
||||||
|
"""
|
||||||
|
def build_output_path_for(%MediaItem{} = media_item_with_preloads) do
|
||||||
|
output_path_template = Sources.output_path_template(media_item_with_preloads.source)
|
||||||
|
|
||||||
|
build_output_path(output_path_template, media_item_with_preloads)
|
||||||
|
end
|
||||||
|
|
||||||
|
def build_output_path_for(%Source{} = source_with_preloads) do
|
||||||
|
build_output_path_for(%MediaItem{source: source_with_preloads})
|
||||||
|
end
|
||||||
|
|
||||||
|
defp default_options(override_opts) do
|
||||||
|
overwrite_behaviour = Keyword.get(override_opts, :overwrite_behaviour, :force_overwrites)
|
||||||
|
|
||||||
|
[
|
||||||
|
:no_progress,
|
||||||
|
overwrite_behaviour,
|
||||||
|
# This makes the date metadata conform to what jellyfin expects
|
||||||
|
parse_metadata: "%(upload_date>%Y-%m-%d)s:(?P<meta_date>.+)"
|
||||||
|
]
|
||||||
|
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
|
||||||
|
vcodec_string = CodecParser.generate_vcodec_string_from_settings()
|
||||||
|
acodec_string = CodecParser.generate_acodec_string_from_settings()
|
||||||
|
|
||||||
|
case media_profile.preferred_resolution do
|
||||||
|
# Also be aware that :audio disabled all embedding options for subtitles
|
||||||
|
:audio ->
|
||||||
|
[:extract_audio, format: "#{acodec_string}/best"]
|
||||||
|
|
||||||
|
resolution_atom ->
|
||||||
|
{resolution_string, _} =
|
||||||
|
resolution_atom
|
||||||
|
|> Atom.to_string()
|
||||||
|
|> Integer.parse()
|
||||||
|
|
||||||
|
[
|
||||||
|
format_sort: "res:#{resolution_string}",
|
||||||
|
# Since Plex doesn't support reading metadata from MKV
|
||||||
|
remux_video: "mp4",
|
||||||
|
format: "((#{vcodec_string})+(#{acodec_string}))/best"
|
||||||
|
]
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp sponsorblock_options(media_profile) do
|
||||||
|
categories = media_profile.sponsorblock_categories
|
||||||
|
behaviour = media_profile.sponsorblock_behaviour
|
||||||
|
|
||||||
|
case {behaviour, categories} do
|
||||||
|
{_, []} -> []
|
||||||
|
{:remove, _} -> [sponsorblock_remove: Enum.join(categories, ",")]
|
||||||
|
{:disabled, _} -> []
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# This is put here instead of the CommandRunner module because it should only
|
||||||
|
# be applied to downloading - if it were in CommandRunner it would apply to
|
||||||
|
# all yt-dlp commands (like indexing)
|
||||||
|
defp config_file_options(media_item) do
|
||||||
|
base_dir = Path.join(Application.get_env(:pinchflat, :extras_directory), "yt-dlp-configs")
|
||||||
|
# Ordered by priority - the first file has the highest priority
|
||||||
|
filenames = [
|
||||||
|
"media-item-#{media_item.id}-config.txt",
|
||||||
|
"source-#{media_item.source_id}-config.txt",
|
||||||
|
"media-profile-#{media_item.source.media_profile_id}-config.txt",
|
||||||
|
"base-config.txt"
|
||||||
|
]
|
||||||
|
|
||||||
|
config_filepaths =
|
||||||
|
Enum.reduce(filenames, [], fn filename, acc ->
|
||||||
|
filepath = Path.join(base_dir, filename)
|
||||||
|
|
||||||
|
if FSUtils.exists_and_nonempty?(filepath) do
|
||||||
|
[filepath | acc]
|
||||||
|
else
|
||||||
|
acc
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
|
||||||
|
Enum.map(config_filepaths, fn filepath -> {:config_locations, filepath} end)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp output_options(media_item_with_preloads) do
|
||||||
|
[
|
||||||
|
output: build_output_path_for(media_item_with_preloads)
|
||||||
|
]
|
||||||
|
end
|
||||||
|
|
||||||
|
defp build_output_path(string, media_item_with_preloads) do
|
||||||
|
additional_options_map = output_options_map(media_item_with_preloads)
|
||||||
|
{:ok, output_path} = OutputPathBuilder.build(string, additional_options_map)
|
||||||
|
|
||||||
|
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_id" => source.collection_id,
|
||||||
|
"source_collection_name" => source.collection_name,
|
||||||
|
"source_collection_type" => to_string(source.collection_type),
|
||||||
|
"media_upload_date_index" =>
|
||||||
|
media_item_with_preloads.upload_date_index
|
||||||
|
|> to_string()
|
||||||
|
|> String.pad_leading(2, "0")
|
||||||
|
}
|
||||||
|
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 = Sources.output_path_template(media_item_with_preloads.source)
|
||||||
|
|
||||||
|
output_path_template
|
||||||
|
|> String.split(~r{\.}, include_captures: true)
|
||||||
|
|> List.insert_at(-3, "-thumb")
|
||||||
|
|> Enum.join()
|
||||||
|
|> build_output_path(media_item_with_preloads)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp base_directory do
|
||||||
|
Application.get_env(:pinchflat, :media_directory)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,101 @@
|
|||||||
|
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
|
||||||
|
|
||||||
|
use Pinchflat.Media.MediaQuery
|
||||||
|
|
||||||
|
alias Pinchflat.Repo
|
||||||
|
alias Pinchflat.Media
|
||||||
|
alias Pinchflat.Tasks
|
||||||
|
alias Pinchflat.Sources.Source
|
||||||
|
alias Pinchflat.Media.MediaItem
|
||||||
|
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
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Takes a single media item and enqueues a download job if the media should be
|
||||||
|
downloaded, based on the source's download settings and whether media is
|
||||||
|
considered pending.
|
||||||
|
|
||||||
|
Returns {:ok, %Task{}} | {:error, :should_not_download} | {:error, any()}
|
||||||
|
"""
|
||||||
|
def kickoff_download_if_pending(%MediaItem{} = media_item) do
|
||||||
|
media_item = Repo.preload(media_item, :source)
|
||||||
|
|
||||||
|
if media_item.source.download_media && Media.pending_download?(media_item) do
|
||||||
|
Logger.info("Kicking off download for media item ##{media_item.id} (#{media_item.media_id})")
|
||||||
|
|
||||||
|
MediaDownloadWorker.kickoff_with_task(media_item)
|
||||||
|
else
|
||||||
|
{:error, :should_not_download}
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
For a given source, enqueues download jobs for all media items _that have already been downloaded_.
|
||||||
|
|
||||||
|
This is useful for when a source's download settings have changed and you want to run through all
|
||||||
|
existing media and retry the download. For instance, if the source didn't originally download thumbnails
|
||||||
|
and you've changed the source to download them, you can use this to download all the thumbnails for
|
||||||
|
existing media items.
|
||||||
|
|
||||||
|
NOTE: does not delete existing files whatsoever. Does not overwrite the existing media file if it exists
|
||||||
|
at the location it expects. Will cause a full redownload of everything if the output template has changed
|
||||||
|
|
||||||
|
NOTE: unrelated to the MediaQualityUpgradeWorker, which is for redownloading media items for quality upgrades
|
||||||
|
or improved sponsorblock segments
|
||||||
|
|
||||||
|
Returns [{:ok, %Task{}} | {:error, any()}]
|
||||||
|
"""
|
||||||
|
def kickoff_redownload_for_existing_media(%Source{} = source) do
|
||||||
|
MediaQuery.new()
|
||||||
|
|> MediaQuery.require_assoc(:media_profile)
|
||||||
|
|> where(
|
||||||
|
^dynamic(
|
||||||
|
[m, s, mp],
|
||||||
|
^MediaQuery.for_source(source) and
|
||||||
|
^MediaQuery.downloaded() and
|
||||||
|
not (^MediaQuery.download_prevented()) and
|
||||||
|
not (^MediaQuery.culled())
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|> Repo.all()
|
||||||
|
|> Enum.map(&MediaDownloadWorker.kickoff_with_task/1)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,120 @@
|
|||||||
|
defmodule Pinchflat.Downloading.MediaDownloadWorker do
|
||||||
|
@moduledoc false
|
||||||
|
|
||||||
|
use Oban.Worker,
|
||||||
|
queue: :media_fetching,
|
||||||
|
unique: [period: :infinity, states: [:available, :scheduled, :retryable, :executing]],
|
||||||
|
tags: ["media_item", "media_fetching", "show_in_dashboard"]
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias __MODULE__
|
||||||
|
alias Pinchflat.Tasks
|
||||||
|
alias Pinchflat.Repo
|
||||||
|
alias Pinchflat.Media
|
||||||
|
alias Pinchflat.Downloading.MediaDownloader
|
||||||
|
|
||||||
|
alias Pinchflat.Lifecycle.UserScripts.CommandRunner, as: UserScriptRunner
|
||||||
|
|
||||||
|
@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, job_args \\ %{}, job_opts \\ []) do
|
||||||
|
%{id: media_item.id}
|
||||||
|
|> Map.merge(job_args)
|
||||||
|
|> MediaDownloadWorker.new(job_opts)
|
||||||
|
|> Tasks.create_job_with_task(media_item)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
For a given media item, download the media alongside any options.
|
||||||
|
Does not download media if its source is set to not download media
|
||||||
|
(unless forced).
|
||||||
|
|
||||||
|
Options:
|
||||||
|
- `force`: force download even if the source is set to not download media. Fully
|
||||||
|
re-downloads media, including the video
|
||||||
|
- `quality_upgrade?`: re-downloads media, including the video. Does not force download
|
||||||
|
if the source is set to not download media
|
||||||
|
|
||||||
|
Returns :ok | {:ok, %MediaItem{}} | {:error, any, ...any}
|
||||||
|
"""
|
||||||
|
@impl Oban.Worker
|
||||||
|
def perform(%Oban.Job{args: %{"id" => media_item_id} = args}) do
|
||||||
|
should_force = Map.get(args, "force", false)
|
||||||
|
is_quality_upgrade = Map.get(args, "quality_upgrade?", false)
|
||||||
|
|
||||||
|
media_item =
|
||||||
|
media_item_id
|
||||||
|
|> Media.get_media_item!()
|
||||||
|
|> Repo.preload(:source)
|
||||||
|
|
||||||
|
# If the source or media item is set to not download media, perform a no-op unless forced
|
||||||
|
if (media_item.source.download_media && !media_item.prevent_download) || should_force do
|
||||||
|
download_media_and_schedule_jobs(media_item, is_quality_upgrade, should_force)
|
||||||
|
else
|
||||||
|
:ok
|
||||||
|
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
|
||||||
|
|
||||||
|
defp download_media_and_schedule_jobs(media_item, is_quality_upgrade, should_force) do
|
||||||
|
overwrite_behaviour = if should_force || is_quality_upgrade, do: :force_overwrites, else: :no_force_overwrites
|
||||||
|
override_opts = [overwrite_behaviour: overwrite_behaviour]
|
||||||
|
|
||||||
|
case MediaDownloader.download_for_media_item(media_item, override_opts) do
|
||||||
|
{:ok, downloaded_media_item} ->
|
||||||
|
{:ok, updated_media_item} =
|
||||||
|
Media.update_media_item(downloaded_media_item, %{
|
||||||
|
media_size_bytes: compute_media_filesize(downloaded_media_item),
|
||||||
|
media_redownloaded_at: get_redownloaded_at(is_quality_upgrade)
|
||||||
|
})
|
||||||
|
|
||||||
|
:ok = run_user_script(updated_media_item)
|
||||||
|
|
||||||
|
{:ok, updated_media_item}
|
||||||
|
|
||||||
|
{:recovered, _} ->
|
||||||
|
{:error, :retry}
|
||||||
|
|
||||||
|
{:error, message} ->
|
||||||
|
action_on_error(message)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp compute_media_filesize(media_item) do
|
||||||
|
case File.stat(media_item.media_filepath) do
|
||||||
|
{:ok, %{size: size}} -> size
|
||||||
|
_ -> nil
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp get_redownloaded_at(true), do: DateTime.utc_now()
|
||||||
|
defp get_redownloaded_at(_), do: nil
|
||||||
|
|
||||||
|
defp action_on_error(message) do
|
||||||
|
# This will attempt re-download at the next indexing, but it won't be retried
|
||||||
|
# immediately as part of job failure logic
|
||||||
|
non_retryable_errors = ["Video unavailable"]
|
||||||
|
|
||||||
|
if String.contains?(to_string(message), non_retryable_errors) do
|
||||||
|
Logger.error("yt-dlp download will not be retried: #{inspect(message)}")
|
||||||
|
|
||||||
|
{:ok, :non_retry}
|
||||||
|
else
|
||||||
|
{:error, :download_failed}
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# NOTE: I like this pattern of using the default value so that I don't have to
|
||||||
|
# define it in config.exs (and friends). Consider using this elsewhere.
|
||||||
|
defp run_user_script(media_item) do
|
||||||
|
runner = Application.get_env(:pinchflat, :user_script_runner, UserScriptRunner)
|
||||||
|
|
||||||
|
runner.run(:media_downloaded, media_item)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,117 @@
|
|||||||
|
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.
|
||||||
|
"""
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias Pinchflat.Repo
|
||||||
|
alias Pinchflat.Media
|
||||||
|
alias Pinchflat.Media.MediaItem
|
||||||
|
alias Pinchflat.Metadata.NfoBuilder
|
||||||
|
alias Pinchflat.Metadata.MetadataParser
|
||||||
|
alias Pinchflat.Metadata.MetadataFileHelpers
|
||||||
|
alias Pinchflat.Utils.FilesystemUtils
|
||||||
|
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, override_opts \\ []) do
|
||||||
|
output_filepath = FilesystemUtils.generate_metadata_tmpfile(:json)
|
||||||
|
media_with_preloads = Repo.preload(media_item, [:metadata, source: :media_profile])
|
||||||
|
|
||||||
|
case download_with_options(media_item.original_url, media_with_preloads, output_filepath, override_opts) do
|
||||||
|
{:ok, parsed_json} ->
|
||||||
|
update_media_item_from_parsed_json(media_with_preloads, parsed_json)
|
||||||
|
|
||||||
|
{:error, message, _exit_code} ->
|
||||||
|
Logger.error("yt-dlp download error for media item ##{media_with_preloads.id}: #{inspect(message)}")
|
||||||
|
|
||||||
|
if String.contains?(to_string(message), recoverable_errors()) do
|
||||||
|
attempt_update_media_item(media_with_preloads, output_filepath)
|
||||||
|
|
||||||
|
{:recovered, message}
|
||||||
|
else
|
||||||
|
{:error, message}
|
||||||
|
end
|
||||||
|
|
||||||
|
err ->
|
||||||
|
Logger.error("Unknown error downloading media item ##{media_with_preloads.id}: #{inspect(err)}")
|
||||||
|
|
||||||
|
{:error, "Unknown error: #{inspect(err)}"}
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp attempt_update_media_item(media_with_preloads, output_filepath) do
|
||||||
|
with {:ok, contents} <- File.read(output_filepath),
|
||||||
|
{:ok, parsed_json} <- Phoenix.json_library().decode(contents) do
|
||||||
|
Logger.info("""
|
||||||
|
Recovery from yt-dlp error seems possible. Updating media item ##{media_with_preloads.id}
|
||||||
|
with parsed JSON from partial download attempt. Full download will be re-attemted in future
|
||||||
|
anyway
|
||||||
|
""")
|
||||||
|
|
||||||
|
update_media_item_from_parsed_json(media_with_preloads, parsed_json)
|
||||||
|
else
|
||||||
|
err ->
|
||||||
|
Logger.error("Unable to recover error for media item ##{media_with_preloads.id}: #{inspect(err)}")
|
||||||
|
|
||||||
|
{:error, :retry_failed}
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp update_media_item_from_parsed_json(media_with_preloads, parsed_json) do
|
||||||
|
parsed_attrs =
|
||||||
|
parsed_json
|
||||||
|
|> MetadataParser.parse_for_media_item()
|
||||||
|
|> Map.merge(%{
|
||||||
|
media_downloaded_at: DateTime.utc_now(),
|
||||||
|
nfo_filepath: determine_nfo_filepath(media_with_preloads, parsed_json),
|
||||||
|
metadata: %{
|
||||||
|
# IDEA: might be worth kicking off a job for this since thumbnail fetching
|
||||||
|
# could fail and I want to handle that in isolation
|
||||||
|
metadata_filepath: MetadataFileHelpers.compress_and_store_metadata_for(media_with_preloads, parsed_json),
|
||||||
|
thumbnail_filepath: MetadataFileHelpers.download_and_store_thumbnail_for(media_with_preloads, parsed_json)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
# Don't forgor to use preloaded associations or updates to
|
||||||
|
# associations won't work!
|
||||||
|
Media.update_media_item(media_with_preloads, parsed_attrs)
|
||||||
|
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, output_filepath, override_opts) do
|
||||||
|
{:ok, options} = DownloadOptionBuilder.build(item_with_preloads, override_opts)
|
||||||
|
|
||||||
|
YtDlpMedia.download(url, options, output_filepath: output_filepath)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp recoverable_errors do
|
||||||
|
[
|
||||||
|
"Unable to communicate with SponsorBlock"
|
||||||
|
]
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,33 @@
|
|||||||
|
defmodule Pinchflat.Downloading.MediaQualityUpgradeWorker do
|
||||||
|
@moduledoc false
|
||||||
|
|
||||||
|
use Oban.Worker,
|
||||||
|
queue: :media_fetching,
|
||||||
|
unique: [period: :infinity, states: [:available, :scheduled, :retryable, :executing]],
|
||||||
|
tags: ["media_item", "media_fetching", "show_in_dashboard"]
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias Pinchflat.Media
|
||||||
|
alias Pinchflat.Downloading.MediaDownloadWorker
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Redownloads media items that are eligible for redownload for the purpose
|
||||||
|
of upgrading the quality of the media or improving things like sponsorblock
|
||||||
|
segments.
|
||||||
|
|
||||||
|
This worker is scheduled to run daily via the Oban Cron plugin
|
||||||
|
and it should run _after_ the retention worker.
|
||||||
|
|
||||||
|
Returns :ok
|
||||||
|
"""
|
||||||
|
@impl Oban.Worker
|
||||||
|
def perform(%Oban.Job{}) do
|
||||||
|
redownloadable_media = Media.list_redownloadable_media_items()
|
||||||
|
Logger.info("Redownloading #{length(redownloadable_media)} media items")
|
||||||
|
|
||||||
|
Enum.each(redownloadable_media, fn media_item ->
|
||||||
|
MediaDownloadWorker.kickoff_with_task(media_item, %{quality_upgrade?: true})
|
||||||
|
end)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,33 @@
|
|||||||
|
defmodule Pinchflat.Downloading.MediaRetentionWorker do
|
||||||
|
@moduledoc false
|
||||||
|
|
||||||
|
use Oban.Worker,
|
||||||
|
queue: :local_metadata,
|
||||||
|
unique: [period: :infinity, states: [:available, :scheduled, :retryable, :executing]],
|
||||||
|
tags: ["media_item", "local_metadata"]
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias Pinchflat.Media
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Deletes media items that are past their retention date and prevents
|
||||||
|
them from being re-downloaded.
|
||||||
|
|
||||||
|
This worker is scheduled to run daily via the Oban Cron plugin.
|
||||||
|
|
||||||
|
Returns :ok
|
||||||
|
"""
|
||||||
|
@impl Oban.Worker
|
||||||
|
def perform(%Oban.Job{}) do
|
||||||
|
cullable_media = Media.list_cullable_media_items()
|
||||||
|
Logger.info("Culling #{length(cullable_media)} media items past their retention date")
|
||||||
|
|
||||||
|
Enum.each(cullable_media, fn media_item ->
|
||||||
|
Media.delete_media_files(media_item, %{
|
||||||
|
prevent_download: true,
|
||||||
|
culled_at: DateTime.utc_now()
|
||||||
|
})
|
||||||
|
end)
|
||||||
|
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
|
||||||
+19
-6
@@ -1,23 +1,31 @@
|
|||||||
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
|
||||||
a map of additional options to be used in the template.
|
a map of additional options to be used in the template.
|
||||||
|
|
||||||
|
Custom options are recursively expanded _once_ so you can nest custom options
|
||||||
|
one-deep if needed.
|
||||||
|
|
||||||
Translates liquid-style templates into yt-dlp-style templates,
|
Translates liquid-style templates into yt-dlp-style templates,
|
||||||
leaving yt-dlp syntax intact.
|
leaving yt-dlp syntax intact.
|
||||||
"""
|
"""
|
||||||
def build(template_string, additional_template_options \\ %{}) do
|
def build(template_string, additional_template_options \\ %{}) do
|
||||||
combined_options = Map.merge(custom_yt_dlp_option_map(), additional_template_options)
|
combined_options = Map.merge(custom_yt_dlp_option_map(), additional_template_options)
|
||||||
|
|
||||||
TemplateParser.parse(template_string, combined_options, &identifier_fn/2)
|
expanded_options =
|
||||||
|
Enum.map(combined_options, fn {key, value} ->
|
||||||
|
{:ok, parse_result} = TemplateParser.parse(value, combined_options, &identifier_fn/2)
|
||||||
|
|
||||||
|
{key, parse_result}
|
||||||
|
end)
|
||||||
|
|
||||||
|
TemplateParser.parse(template_string, Map.new(expanded_options), &identifier_fn/2)
|
||||||
end
|
end
|
||||||
|
|
||||||
# The `nil` case simply wraps the identifier in yt-dlp-style syntax. This assumes that
|
# The `nil` case simply wraps the identifier in yt-dlp-style syntax. This assumes that
|
||||||
@@ -41,7 +49,12 @@ 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",
|
||||||
|
"season_episode_index_from_date" => "s%(upload_date>%Y)Se%(upload_date>%m%d)S{{ media_upload_date_index }}",
|
||||||
|
"artist_name" => "%(artist,creator,uploader,uploader_id)S"
|
||||||
}
|
}
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -0,0 +1,67 @@
|
|||||||
|
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.
|
||||||
|
"""
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
use Pinchflat.Media.MediaQuery
|
||||||
|
|
||||||
|
alias Pinchflat.Repo
|
||||||
|
alias Pinchflat.Media
|
||||||
|
alias Pinchflat.Sources.Source
|
||||||
|
alias Pinchflat.FastIndexing.YoutubeRss
|
||||||
|
alias Pinchflat.Downloading.DownloadingHelpers
|
||||||
|
|
||||||
|
alias Pinchflat.YtDlp.Media, as: YtDlpMedia
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Fetches new media IDs from a source's YouTube RSS feed, indexes them, and kicks off downloading
|
||||||
|
tasks for any pending media items. See comments in `FastIndexingWorker` for more info on the
|
||||||
|
order of operations and how this fits into the indexing process.
|
||||||
|
|
||||||
|
Returns [%MediaItem{}] where each item is a new media item that was created _but not necessarily
|
||||||
|
downloaded_.
|
||||||
|
"""
|
||||||
|
def kickoff_download_tasks_from_youtube_rss_feed(%Source{} = source) do
|
||||||
|
{:ok, media_ids} = YoutubeRss.get_recent_media_ids_from_rss(source)
|
||||||
|
existing_media_items = list_media_items_by_media_id_for(source, media_ids)
|
||||||
|
new_media_ids = media_ids -- Enum.map(existing_media_items, & &1.media_id)
|
||||||
|
|
||||||
|
maybe_new_media_items =
|
||||||
|
Enum.map(new_media_ids, fn media_id ->
|
||||||
|
case create_media_item_from_media_id(source, media_id) do
|
||||||
|
{:ok, media_item} ->
|
||||||
|
media_item
|
||||||
|
|
||||||
|
err ->
|
||||||
|
Logger.error("Error creating media item '#{media_id}' from URL: #{inspect(err)}")
|
||||||
|
nil
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
|
||||||
|
DownloadingHelpers.enqueue_pending_download_tasks(source)
|
||||||
|
|
||||||
|
Enum.filter(maybe_new_media_items, & &1)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp list_media_items_by_media_id_for(source, media_ids) do
|
||||||
|
MediaQuery.new()
|
||||||
|
|> where(^dynamic([mi], ^MediaQuery.for_source(source) and mi.media_id in ^media_ids))
|
||||||
|
|> Repo.all()
|
||||||
|
end
|
||||||
|
|
||||||
|
defp create_media_item_from_media_id(source, media_id) do
|
||||||
|
url = "https://www.youtube.com/watch?v=#{media_id}"
|
||||||
|
|
||||||
|
case YtDlpMedia.get_media_attributes(url) do
|
||||||
|
{:ok, media_attrs} ->
|
||||||
|
Media.create_media_item_from_backend_attrs(source, media_attrs)
|
||||||
|
|
||||||
|
err ->
|
||||||
|
err
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,86 @@
|
|||||||
|
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", "show_in_dashboard"]
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias __MODULE__
|
||||||
|
alias Pinchflat.Tasks
|
||||||
|
alias Pinchflat.Media
|
||||||
|
alias Pinchflat.Sources
|
||||||
|
alias Pinchflat.Settings
|
||||||
|
alias Pinchflat.Sources.Source
|
||||||
|
alias Pinchflat.FastIndexing.FastIndexingHelpers
|
||||||
|
alias Pinchflat.Lifecycle.Notifications.SourceNotifications
|
||||||
|
|
||||||
|
@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 """
|
||||||
|
Similar to `MediaCollectionIndexingWorker`, but for working with RSS feeds.
|
||||||
|
`MediaCollectionIndexingWorker` should be preferred in general, but this is
|
||||||
|
useful for downloading small batches of media items via fast indexing.
|
||||||
|
|
||||||
|
Only kicks off downloads for 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. FastIndexingWorker (this module) periodically checks the YouTube RSS feed for new media.
|
||||||
|
with `FastIndexingHelpers.kickoff_download_tasks_from_youtube_rss_feed`
|
||||||
|
2. If the above `kickoff_download_tasks_from_youtube_rss_feed` finds new media items in the RSS feed,
|
||||||
|
it indexes them with a yt-dlp call to create the media item records then kicks off downloading
|
||||||
|
tasks (MediaDownloadWorker) for any new media items _that should be downloaded_.
|
||||||
|
3. Once downloads are kicked off, this worker sends a notification to the apprise server if applicable
|
||||||
|
then reschedules itself to run again in the future.
|
||||||
|
|
||||||
|
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
|
||||||
|
perform_indexing_and_send_notification(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 perform_indexing_and_send_notification(source) do
|
||||||
|
apprise_server = Settings.get!(:apprise_server)
|
||||||
|
|
||||||
|
new_media_items =
|
||||||
|
source
|
||||||
|
|> FastIndexingHelpers.kickoff_download_tasks_from_youtube_rss_feed()
|
||||||
|
|> Enum.filter(&Media.pending_download?(&1))
|
||||||
|
|
||||||
|
if source.download_media do
|
||||||
|
SourceNotifications.send_new_media_notification(apprise_server, source, length(new_media_items))
|
||||||
|
end
|
||||||
|
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,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
|
||||||
@@ -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
|
||||||
|
|||||||
@@ -0,0 +1,12 @@
|
|||||||
|
defmodule Pinchflat.Lifecycle.Notifications.AppriseCommandRunner do
|
||||||
|
@moduledoc """
|
||||||
|
A behaviour for running CLI commands against a notification backend (apprise).
|
||||||
|
|
||||||
|
Used so we can implement Mox for testing without actually running the
|
||||||
|
apprise command.
|
||||||
|
"""
|
||||||
|
|
||||||
|
@callback run(binary(), keyword()) :: :ok | {:error, binary()}
|
||||||
|
@callback run(List.t(), keyword()) :: :ok | {:error, binary()}
|
||||||
|
@callback version() :: {:ok, binary()} | {:error, binary()}
|
||||||
|
end
|
||||||
@@ -0,0 +1,63 @@
|
|||||||
|
defmodule Pinchflat.Lifecycle.Notifications.CommandRunner do
|
||||||
|
@moduledoc """
|
||||||
|
Runs apprise commands using the `System.cmd/3` function
|
||||||
|
"""
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias Pinchflat.Utils.CliUtils
|
||||||
|
alias Pinchflat.Utils.FunctionUtils
|
||||||
|
alias Pinchflat.Lifecycle.Notifications.AppriseCommandRunner
|
||||||
|
|
||||||
|
@behaviour AppriseCommandRunner
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Runs an apprise command and returns the string output.
|
||||||
|
Can take a single server string or a list of servers as well as additional
|
||||||
|
arguments to pass to the command.
|
||||||
|
|
||||||
|
Returns {:ok, binary()} | {:error, :no_servers} | {:error, binary()}
|
||||||
|
"""
|
||||||
|
@impl AppriseCommandRunner
|
||||||
|
def run(nil, _), do: {:error, :no_servers}
|
||||||
|
def run("", _), do: {:error, :no_servers}
|
||||||
|
def run([], _), do: {:error, :no_servers}
|
||||||
|
|
||||||
|
def run(endpoints, command_opts) do
|
||||||
|
endpoints = List.wrap(endpoints)
|
||||||
|
default_opts = [:verbose]
|
||||||
|
parsed_opts = CliUtils.parse_options(default_opts ++ command_opts)
|
||||||
|
|
||||||
|
{output, exit_code} = CliUtils.wrap_cmd(backend_executable(), parsed_opts ++ endpoints)
|
||||||
|
|
||||||
|
case exit_code do
|
||||||
|
0 -> {:ok, String.trim(output)}
|
||||||
|
_ -> {:error, String.trim(output)}
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Returns the version of apprise as a string.
|
||||||
|
|
||||||
|
Returns {:ok, binary()} | {:error, binary()}
|
||||||
|
"""
|
||||||
|
@impl AppriseCommandRunner
|
||||||
|
def version do
|
||||||
|
case CliUtils.wrap_cmd(backend_executable(), ["--version"]) do
|
||||||
|
{output, 0} ->
|
||||||
|
output
|
||||||
|
|> String.split(~r{\r?\n})
|
||||||
|
|> List.first()
|
||||||
|
|> String.replace("Apprise", "")
|
||||||
|
|> String.trim()
|
||||||
|
|> FunctionUtils.wrap_ok()
|
||||||
|
|
||||||
|
{output, _} ->
|
||||||
|
{:error, output}
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp backend_executable do
|
||||||
|
Application.get_env(:pinchflat, :apprise_executable)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,81 @@
|
|||||||
|
defmodule Pinchflat.Lifecycle.Notifications.SourceNotifications do
|
||||||
|
@moduledoc """
|
||||||
|
Contains utilities for sending notifications about sources
|
||||||
|
"""
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
use Pinchflat.Media.MediaQuery
|
||||||
|
|
||||||
|
alias Pinchflat.Repo
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Wraps a function that may change the number of pending or downloaded
|
||||||
|
media items for a source, sending an apprise notification if
|
||||||
|
the count changes.
|
||||||
|
|
||||||
|
Returns the return value of the provided function
|
||||||
|
"""
|
||||||
|
def wrap_new_media_notification(servers, source, func) do
|
||||||
|
before_count = relevant_media_item_count(source)
|
||||||
|
retval = func.()
|
||||||
|
after_count = relevant_media_item_count(source)
|
||||||
|
|
||||||
|
send_new_media_notification(servers, source, after_count - before_count)
|
||||||
|
|
||||||
|
retval
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Sends a notification if the count of new media items has changed
|
||||||
|
|
||||||
|
Returns :ok
|
||||||
|
"""
|
||||||
|
def send_new_media_notification(_, _, count) when count <= 0, do: :ok
|
||||||
|
|
||||||
|
def send_new_media_notification(servers, source, changed_count) do
|
||||||
|
opts = [
|
||||||
|
title: "[Pinchflat] New media found",
|
||||||
|
body: "Found #{changed_count} new media item(s) for #{source.custom_name}. Downloading them now"
|
||||||
|
]
|
||||||
|
|
||||||
|
case backend_runner().run(servers, opts) do
|
||||||
|
{:ok, _} ->
|
||||||
|
Logger.info("Sent new media notification for source #{source.id}")
|
||||||
|
|
||||||
|
{:error, :no_servers} ->
|
||||||
|
Logger.info("No notification servers provided for source #{source.id}")
|
||||||
|
|
||||||
|
{:error, err} ->
|
||||||
|
Logger.error("Failed to send new media notification for source #{source.id}: #{err}")
|
||||||
|
end
|
||||||
|
|
||||||
|
:ok
|
||||||
|
end
|
||||||
|
|
||||||
|
defp relevant_media_item_count(source) do
|
||||||
|
if source.download_media do
|
||||||
|
pending_media_item_count(source) + downloaded_media_item_count(source)
|
||||||
|
else
|
||||||
|
0
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp pending_media_item_count(source) do
|
||||||
|
MediaQuery.new()
|
||||||
|
|> MediaQuery.require_assoc(:media_profile)
|
||||||
|
|> where(^dynamic(^MediaQuery.for_source(source) and ^MediaQuery.pending()))
|
||||||
|
|> Repo.aggregate(:count)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp downloaded_media_item_count(source) do
|
||||||
|
MediaQuery.new()
|
||||||
|
|> where(^dynamic(^MediaQuery.for_source(source) and ^MediaQuery.downloaded()))
|
||||||
|
|> Repo.aggregate(:count)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp backend_runner do
|
||||||
|
# This approach lets us mock the command for testing
|
||||||
|
Application.get_env(:pinchflat, :apprise_runner)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,70 @@
|
|||||||
|
defmodule Pinchflat.Lifecycle.UserScripts.CommandRunner do
|
||||||
|
@moduledoc """
|
||||||
|
Runs custom user commands commands using the `System.cmd/3` function
|
||||||
|
"""
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias Pinchflat.Utils.CliUtils
|
||||||
|
alias Pinchflat.Utils.FilesystemUtils
|
||||||
|
alias Pinchflat.Lifecycle.UserScripts.UserScriptCommandRunner
|
||||||
|
|
||||||
|
@behaviour UserScriptCommandRunner
|
||||||
|
|
||||||
|
@event_types [
|
||||||
|
:media_downloaded,
|
||||||
|
:media_deleted
|
||||||
|
]
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Runs the user script command for the given event type. Passes the event
|
||||||
|
and the encoded data to the user script command.
|
||||||
|
|
||||||
|
This function will succeed in almost all cases, even if the user script command
|
||||||
|
failed - this is because I don't want bad scripts to stop the whole process.
|
||||||
|
If something fails, it'll be logged.
|
||||||
|
|
||||||
|
The only things that can cause a true failure are passing in an invalid event
|
||||||
|
type or if the passed data cannot be encoded into JSON - both indicative of
|
||||||
|
failures in the development process.
|
||||||
|
|
||||||
|
Returns :ok
|
||||||
|
"""
|
||||||
|
@impl UserScriptCommandRunner
|
||||||
|
def run(event_type, encodable_data) when event_type in @event_types do
|
||||||
|
case backend_executable() do
|
||||||
|
{:ok, :no_executable} ->
|
||||||
|
:ok
|
||||||
|
|
||||||
|
{:ok, executable_path} ->
|
||||||
|
{:ok, encoded_data} = Phoenix.json_library().encode(encodable_data)
|
||||||
|
|
||||||
|
{_output, _exit_code} =
|
||||||
|
CliUtils.wrap_cmd(
|
||||||
|
executable_path,
|
||||||
|
[to_string(event_type), encoded_data],
|
||||||
|
[],
|
||||||
|
logging_arg_override: "[suppressed]"
|
||||||
|
)
|
||||||
|
|
||||||
|
:ok
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def run(event_type, _encodable_data) do
|
||||||
|
raise ArgumentError, "Invalid event type: #{inspect(event_type)}"
|
||||||
|
end
|
||||||
|
|
||||||
|
defp backend_executable do
|
||||||
|
base_dir = Application.get_env(:pinchflat, :extras_directory)
|
||||||
|
filepath = Path.join([base_dir, "user-scripts", "lifecycle"])
|
||||||
|
|
||||||
|
if FilesystemUtils.exists_and_nonempty?(filepath) do
|
||||||
|
{:ok, filepath}
|
||||||
|
else
|
||||||
|
Logger.warning("User scripts lifecyle file either not present or is empty. Skipping.")
|
||||||
|
|
||||||
|
{:ok, :no_executable}
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
defmodule Pinchflat.Lifecycle.UserScripts.UserScriptCommandRunner do
|
||||||
|
@moduledoc """
|
||||||
|
A behaviour for running custom user scripts on certain events.
|
||||||
|
|
||||||
|
Used so we can implement Mox for testing without actually running the
|
||||||
|
user's command.
|
||||||
|
"""
|
||||||
|
|
||||||
|
@callback run(atom(), map()) :: :ok | {:error, binary()}
|
||||||
|
end
|
||||||
@@ -1,257 +0,0 @@
|
|||||||
defmodule Pinchflat.Media do
|
|
||||||
@moduledoc """
|
|
||||||
The Media context.
|
|
||||||
"""
|
|
||||||
|
|
||||||
import Ecto.Query, warn: false
|
|
||||||
|
|
||||||
alias Pinchflat.Repo
|
|
||||||
alias Pinchflat.Tasks
|
|
||||||
alias Pinchflat.Media.MediaItem
|
|
||||||
alias Pinchflat.Sources.Source
|
|
||||||
alias Pinchflat.Media.MediaMetadata
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Returns the list of media_items.
|
|
||||||
|
|
||||||
Returns [%MediaItem{}, ...].
|
|
||||||
"""
|
|
||||||
def list_media_items do
|
|
||||||
Repo.all(MediaItem)
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Returns a list of media_items for a given source.
|
|
||||||
|
|
||||||
Returns [%MediaItem{}, ...].
|
|
||||||
"""
|
|
||||||
def list_media_items_for(%Source{} = source) do
|
|
||||||
MediaItem
|
|
||||||
|> where([mi], mi.source_id == ^source.id)
|
|
||||||
|> Repo.all()
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Returns a list of pending media_items for a given source, where
|
|
||||||
pending means the `media_filepath` is `nil` AND the media_item
|
|
||||||
matches the format selection rules of the parent media_profile.
|
|
||||||
|
|
||||||
See `build_format_clauses` but tl;dr is it _may_ filter based
|
|
||||||
on shorts or livestreams depending on the media_profile settings.
|
|
||||||
|
|
||||||
Returns [%MediaItem{}, ...].
|
|
||||||
"""
|
|
||||||
def list_pending_media_items_for(%Source{} = source, opts \\ []) do
|
|
||||||
limit = Keyword.get(opts, :limit, nil)
|
|
||||||
media_profile = Repo.preload(source, :media_profile).media_profile
|
|
||||||
|
|
||||||
MediaItem
|
|
||||||
|> where([mi], mi.source_id == ^source.id and is_nil(mi.media_filepath))
|
|
||||||
|> where(^build_format_clauses(media_profile))
|
|
||||||
|> Repo.maybe_limit(limit)
|
|
||||||
|> Repo.all()
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Returns a list of downloaded media_items for a given source.
|
|
||||||
|
|
||||||
Returns [%MediaItem{}, ...].
|
|
||||||
"""
|
|
||||||
def list_downloaded_media_items_for(%Source{} = source, opts \\ []) do
|
|
||||||
limit = Keyword.get(opts, :limit, nil)
|
|
||||||
|
|
||||||
MediaItem
|
|
||||||
|> where([mi], mi.source_id == ^source.id and not is_nil(mi.media_filepath))
|
|
||||||
|> Repo.maybe_limit(limit)
|
|
||||||
|> Repo.all()
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
For a given media_item, tells you if it is pending download. This is defined as
|
|
||||||
the media_item having a `media_filepath` of `nil` and matching the format selection
|
|
||||||
rules of the parent media_profile.
|
|
||||||
|
|
||||||
Intentionally does not take the `download_media` setting of the source into account.
|
|
||||||
|
|
||||||
Returns boolean()
|
|
||||||
"""
|
|
||||||
def pending_download?(%MediaItem{} = media_item) do
|
|
||||||
media_profile = Repo.preload(media_item, source: :media_profile).source.media_profile
|
|
||||||
|
|
||||||
MediaItem
|
|
||||||
|> where([mi], mi.id == ^media_item.id and is_nil(mi.media_filepath))
|
|
||||||
|> where(^build_format_clauses(media_profile))
|
|
||||||
|> Repo.exists?()
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Returns a list of media_items that match the search term. Adds a `matching_search_term`
|
|
||||||
virtual field to the result set.
|
|
||||||
|
|
||||||
Has explit handling for blank search terms because SQLite doesn't like empty MATCH clauses.
|
|
||||||
|
|
||||||
Returns [%MediaItem{}, ...].
|
|
||||||
"""
|
|
||||||
def search(_search_term, _opts \\ [])
|
|
||||||
def search("", _opts), do: []
|
|
||||||
def search(nil, _opts), do: []
|
|
||||||
|
|
||||||
def search(search_term, opts) do
|
|
||||||
limit = Keyword.get(opts, :limit, 50)
|
|
||||||
|
|
||||||
from(mi in MediaItem,
|
|
||||||
join: mi_search_index in assoc(mi, :media_items_search_index),
|
|
||||||
where: fragment("media_items_search_index MATCH ?", ^search_term),
|
|
||||||
select_merge: %{
|
|
||||||
matching_search_term:
|
|
||||||
fragment("""
|
|
||||||
coalesce(snippet(media_items_search_index, 0, '[PF_HIGHLIGHT]', '[/PF_HIGHLIGHT]', '...', 20), '') ||
|
|
||||||
' ' ||
|
|
||||||
coalesce(snippet(media_items_search_index, 1, '[PF_HIGHLIGHT]', '[/PF_HIGHLIGHT]', '...', 20), '')
|
|
||||||
""")
|
|
||||||
},
|
|
||||||
order_by: [desc: fragment("rank")],
|
|
||||||
limit: ^limit
|
|
||||||
)
|
|
||||||
|> Repo.all()
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Gets a single media_item.
|
|
||||||
|
|
||||||
Returns %MediaItem{}. Raises `Ecto.NoResultsError` if the Media item does not exist.
|
|
||||||
"""
|
|
||||||
def get_media_item!(id), do: Repo.get!(MediaItem, id)
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Produces a flat list of the filesystem paths for a media_item's downloaded files
|
|
||||||
|
|
||||||
Returns [binary()]
|
|
||||||
"""
|
|
||||||
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
|
|
||||||
%MediaItem{}
|
|
||||||
|> MediaItem.changeset(attrs)
|
|
||||||
|> Repo.insert()
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Updates a media_item. Returns {:ok, %MediaItem{}} | {:error, %Ecto.Changeset{}}.
|
|
||||||
"""
|
|
||||||
def update_media_item(%MediaItem{} = media_item, attrs) do
|
|
||||||
media_item
|
|
||||||
|> MediaItem.changeset(attrs)
|
|
||||||
|> Repo.update()
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Deletes a media_item and its associated tasks.
|
|
||||||
Can optionally delete the media_item's files.
|
|
||||||
|
|
||||||
Returns {:ok, %MediaItem{}} | {:error, %Ecto.Changeset{}}.
|
|
||||||
"""
|
|
||||||
def delete_media_item(%MediaItem{} = media_item, opts \\ []) do
|
|
||||||
delete_files = Keyword.get(opts, :delete_files, false)
|
|
||||||
|
|
||||||
if delete_files do
|
|
||||||
{:ok, _} = delete_all_attachments(media_item)
|
|
||||||
end
|
|
||||||
|
|
||||||
Tasks.delete_tasks_for(media_item)
|
|
||||||
Repo.delete(media_item)
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Returns an `%Ecto.Changeset{}` for tracking media_item changes.
|
|
||||||
"""
|
|
||||||
def change_media_item(%MediaItem{} = media_item, attrs \\ %{}) do
|
|
||||||
MediaItem.changeset(media_item, attrs)
|
|
||||||
end
|
|
||||||
|
|
||||||
defp delete_all_attachments(media_item) do
|
|
||||||
media_item = Repo.preload(media_item, :metadata)
|
|
||||||
|
|
||||||
media_item
|
|
||||||
|> media_filepaths()
|
|
||||||
|> Enum.concat(metadata_filepaths(media_item))
|
|
||||||
|> Enum.each(&File.rm/1)
|
|
||||||
|
|
||||||
# rmdir will attempt to delete the directory, but only if it is empty
|
|
||||||
if media_item.media_filepath do
|
|
||||||
File.rmdir(Path.dirname(media_item.media_filepath))
|
|
||||||
end
|
|
||||||
|
|
||||||
if media_item.metadata && media_item.metadata.metadata_filepath do
|
|
||||||
File.rmdir(Path.dirname(media_item.metadata.metadata_filepath))
|
|
||||||
end
|
|
||||||
|
|
||||||
{:ok, media_item}
|
|
||||||
end
|
|
||||||
|
|
||||||
defp build_format_clauses(media_profile) do
|
|
||||||
mapped_struct = Map.from_struct(media_profile)
|
|
||||||
|
|
||||||
Enum.reduce(mapped_struct, dynamic(true), fn attr, dynamic ->
|
|
||||||
case {attr, media_profile} do
|
|
||||||
{{:shorts_behaviour, :only}, %{livestream_behaviour: :only}} ->
|
|
||||||
dynamic(
|
|
||||||
[mi],
|
|
||||||
^dynamic and (mi.livestream == true or fragment("LOWER(?) LIKE LOWER(?)", mi.original_url, "%/shorts/%"))
|
|
||||||
)
|
|
||||||
|
|
||||||
# Technically redundant, but makes the other clauses easier to parse
|
|
||||||
# (redundant because this condition is the same as the condition above, just flipped)
|
|
||||||
{{:livestream_behaviour, :only}, %{shorts_behaviour: :only}} ->
|
|
||||||
dynamic
|
|
||||||
|
|
||||||
{{:shorts_behaviour, :only}, _} ->
|
|
||||||
# return records with /shorts/ in the original_url
|
|
||||||
dynamic([mi], ^dynamic and fragment("LOWER(?) LIKE LOWER(?)", mi.original_url, "%/shorts/%"))
|
|
||||||
|
|
||||||
{{:livestream_behaviour, :only}, _} ->
|
|
||||||
# return records with livestream: true
|
|
||||||
dynamic([mi], ^dynamic and mi.livestream == true)
|
|
||||||
|
|
||||||
{{:shorts_behaviour, :exclude}, %{livestream_behaviour: lb}} when lb != :only ->
|
|
||||||
# return records without /shorts/ in the original_url
|
|
||||||
dynamic([mi], ^dynamic and fragment("LOWER(?) NOT LIKE LOWER(?)", mi.original_url, "%/shorts/%"))
|
|
||||||
|
|
||||||
{{:livestream_behaviour, :exclude}, %{shorts_behaviour: sb}} when sb != :only ->
|
|
||||||
# return records with livestream: false
|
|
||||||
dynamic([mi], ^dynamic and mi.livestream == false)
|
|
||||||
|
|
||||||
_ ->
|
|
||||||
dynamic
|
|
||||||
end
|
|
||||||
end)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -0,0 +1,244 @@
|
|||||||
|
defmodule Pinchflat.Media do
|
||||||
|
@moduledoc """
|
||||||
|
The Media context.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import Ecto.Query, warn: false
|
||||||
|
use Pinchflat.Media.MediaQuery
|
||||||
|
|
||||||
|
alias Pinchflat.Repo
|
||||||
|
alias Pinchflat.Tasks
|
||||||
|
alias Pinchflat.Sources.Source
|
||||||
|
alias Pinchflat.Media.MediaItem
|
||||||
|
alias Pinchflat.Utils.FilesystemUtils
|
||||||
|
alias Pinchflat.Metadata.MediaMetadata
|
||||||
|
|
||||||
|
alias Pinchflat.Lifecycle.UserScripts.CommandRunner, as: UserScriptRunner
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Returns the list of media_items.
|
||||||
|
|
||||||
|
Returns [%MediaItem{}, ...].
|
||||||
|
"""
|
||||||
|
def list_media_items do
|
||||||
|
Repo.all(MediaItem)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Returns a list of media_items that are cullable based on the retention period
|
||||||
|
of the source they belong to.
|
||||||
|
|
||||||
|
Returns [%MediaItem{}, ...]
|
||||||
|
"""
|
||||||
|
def list_cullable_media_items do
|
||||||
|
MediaQuery.new()
|
||||||
|
|> MediaQuery.require_assoc(:source)
|
||||||
|
|> where(^MediaQuery.cullable())
|
||||||
|
|> Repo.all()
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Returns a list of media_items that are redownloadable based on the redownload delay
|
||||||
|
of the media_profile their source belongs to.
|
||||||
|
|
||||||
|
The logic is that a media_item is past_redownload_delay if the media_item's
|
||||||
|
upload_date is at least redownload_delay_days ago AND
|
||||||
|
`media_downloaded_at` - `redownload_delay_days` is before the media_item's `upload_date`.
|
||||||
|
This logic grabs media that we've recently downloaded AND is recently uploaded, but
|
||||||
|
doesn't grab media that we've recently downloaded and was uploaded a long time ago.
|
||||||
|
This also makes things work as expected when downloading media from a source for the
|
||||||
|
first time.
|
||||||
|
|
||||||
|
Returns [%MediaItem{}, ...]
|
||||||
|
"""
|
||||||
|
def list_redownloadable_media_items do
|
||||||
|
MediaQuery.new()
|
||||||
|
|> MediaQuery.require_assoc(:media_profile)
|
||||||
|
|> where(^MediaQuery.redownloadable())
|
||||||
|
|> Repo.all()
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Returns a list of pending media_items for a given source, where
|
||||||
|
pending means the media_item satisfies `MediaQuery.pending`. You
|
||||||
|
should really check out that function if you need to know more
|
||||||
|
because it has a lot going on.
|
||||||
|
|
||||||
|
Returns [%MediaItem{}, ...].
|
||||||
|
"""
|
||||||
|
def list_pending_media_items_for(%Source{} = source) do
|
||||||
|
MediaQuery.new()
|
||||||
|
|> MediaQuery.require_assoc(:media_profile)
|
||||||
|
|> where(^dynamic(^MediaQuery.for_source(source) and ^MediaQuery.pending()))
|
||||||
|
|> Repo.all()
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
For a given media_item, tells you if it is pending download. This is defined as
|
||||||
|
the media_item satisfying `MediaQuery.pending` which you should really check out.
|
||||||
|
|
||||||
|
Intentionally does not take the `download_media` setting of the source into account.
|
||||||
|
|
||||||
|
Returns boolean()
|
||||||
|
"""
|
||||||
|
def pending_download?(%MediaItem{} = media_item) do
|
||||||
|
media_item = Repo.preload(media_item, source: :media_profile)
|
||||||
|
|
||||||
|
MediaQuery.new()
|
||||||
|
|> MediaQuery.require_assoc(:media_profile)
|
||||||
|
|> where(^dynamic([m, s, mp], m.id == ^media_item.id and ^MediaQuery.pending()))
|
||||||
|
|> Repo.exists?()
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Returns a list of media_items that match the search term. Adds a `matching_search_term`
|
||||||
|
virtual field to the result set.
|
||||||
|
|
||||||
|
Has explit handling for blank search terms because SQLite doesn't like empty MATCH clauses.
|
||||||
|
|
||||||
|
Returns [%MediaItem{}, ...].
|
||||||
|
"""
|
||||||
|
def search(_search_term, _opts \\ [])
|
||||||
|
def search("", _opts), do: []
|
||||||
|
def search(nil, _opts), do: []
|
||||||
|
|
||||||
|
def search(search_term, opts) do
|
||||||
|
limit = Keyword.get(opts, :limit, 50)
|
||||||
|
|
||||||
|
MediaQuery.new()
|
||||||
|
|> MediaQuery.matching_search_term(search_term)
|
||||||
|
|> Repo.maybe_limit(limit)
|
||||||
|
|> Repo.all()
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Gets a single media_item.
|
||||||
|
|
||||||
|
Returns %MediaItem{}. Raises `Ecto.NoResultsError` if the Media item does not exist.
|
||||||
|
"""
|
||||||
|
def get_media_item!(id), do: Repo.get!(MediaItem, id)
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Creates a media_item.
|
||||||
|
|
||||||
|
Returns {:ok, %MediaItem{}} | {:error, %Ecto.Changeset{}}
|
||||||
|
"""
|
||||||
|
def create_media_item(attrs) do
|
||||||
|
%MediaItem{}
|
||||||
|
|> MediaItem.changeset(attrs)
|
||||||
|
|> Repo.insert()
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
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
|
||||||
|
media_item
|
||||||
|
|> MediaItem.changeset(attrs)
|
||||||
|
|> Repo.update()
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Deletes a media_item, its associated tasks, and our internal metadata files.
|
||||||
|
Can optionally delete the media_item's media files (media, thumbnail, subtitles, etc).
|
||||||
|
|
||||||
|
Returns {:ok, %MediaItem{}} | {:error, %Ecto.Changeset{}}
|
||||||
|
"""
|
||||||
|
def delete_media_item(%MediaItem{} = media_item, opts \\ []) do
|
||||||
|
delete_files = Keyword.get(opts, :delete_files, false)
|
||||||
|
|
||||||
|
Tasks.delete_tasks_for(media_item)
|
||||||
|
|
||||||
|
if delete_files do
|
||||||
|
{:ok, _} = do_delete_media_files(media_item)
|
||||||
|
:ok = run_user_script(:media_deleted, media_item)
|
||||||
|
end
|
||||||
|
|
||||||
|
# Should delete these no matter what
|
||||||
|
delete_internal_metadata_files(media_item)
|
||||||
|
Repo.delete(media_item)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Deletes the tasks and media files associated with a media_item but leaves the
|
||||||
|
media_item in the database. Does not delete anything to do with associated metadata.
|
||||||
|
|
||||||
|
Optionally accepts a second argument `addl_attrs` which will be merged into the
|
||||||
|
media_item before it is updated. Useful for setting things like `prevent_download`
|
||||||
|
and `culled_at`, if wanted
|
||||||
|
|
||||||
|
Returns {:ok, %MediaItem{}} | {:error, %Ecto.Changeset{}}
|
||||||
|
"""
|
||||||
|
def delete_media_files(%MediaItem{} = media_item, addl_attrs \\ %{}) do
|
||||||
|
filepath_attrs = MediaItem.filepath_attribute_defaults()
|
||||||
|
|
||||||
|
Tasks.delete_tasks_for(media_item)
|
||||||
|
{:ok, _} = do_delete_media_files(media_item)
|
||||||
|
:ok = run_user_script(:media_deleted, media_item)
|
||||||
|
|
||||||
|
update_media_item(media_item, Map.merge(filepath_attrs, addl_attrs))
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Returns an `%Ecto.Changeset{}` for tracking media_item changes.
|
||||||
|
"""
|
||||||
|
def change_media_item(%MediaItem{} = media_item, attrs \\ %{}) do
|
||||||
|
MediaItem.changeset(media_item, attrs)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp do_delete_media_files(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)
|
||||||
|
|> Enum.each(&FilesystemUtils.delete_file_and_remove_empty_directories/1)
|
||||||
|
|
||||||
|
{:ok, media_item}
|
||||||
|
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(&FilesystemUtils.delete_file_and_remove_empty_directories/1)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp run_user_script(event, media_item) do
|
||||||
|
runner = Application.get_env(:pinchflat, :user_script_runner, UserScriptRunner)
|
||||||
|
|
||||||
|
runner.run(event, media_item)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -4,54 +4,95 @@ defmodule Pinchflat.Media.MediaItem do
|
|||||||
"""
|
"""
|
||||||
|
|
||||||
use Ecto.Schema
|
use Ecto.Schema
|
||||||
import Ecto.Changeset
|
use Pinchflat.Media.MediaQuery
|
||||||
|
|
||||||
|
import Ecto.Changeset
|
||||||
|
import Pinchflat.Utils.ChangesetUtils
|
||||||
|
|
||||||
|
alias __MODULE__
|
||||||
|
alias Pinchflat.Repo
|
||||||
|
alias Pinchflat.Sources
|
||||||
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,
|
||||||
|
:upload_date_index,
|
||||||
|
:duration_seconds,
|
||||||
|
# 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,
|
||||||
|
# These are user or system controlled fields
|
||||||
|
:prevent_download,
|
||||||
|
:prevent_culling,
|
||||||
|
:culled_at,
|
||||||
|
:media_redownloaded_at
|
||||||
]
|
]
|
||||||
@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(
|
||||||
|
uuid
|
||||||
|
title
|
||||||
|
original_url
|
||||||
|
livestream
|
||||||
|
media_id
|
||||||
|
source_id
|
||||||
|
upload_date
|
||||||
|
short_form_content
|
||||||
|
)a
|
||||||
|
|
||||||
schema "media_items" do
|
schema "media_items" do
|
||||||
|
# This is _not_ used as the primary key or internally in the database
|
||||||
|
# relations. This is only used to prevent an enumeration attack on the streaming
|
||||||
|
# and RSS feed endpoints since those _must_ be public (ie: no basic auth)
|
||||||
|
field :uuid, Ecto.UUID
|
||||||
|
|
||||||
field :title, :string
|
field :title, :string
|
||||||
field :media_id, :string
|
field :media_id, :string
|
||||||
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 :media_redownloaded_at, :utc_datetime
|
||||||
|
field :upload_date, :date
|
||||||
|
field :upload_date_index, :integer, default: 0
|
||||||
|
field :duration_seconds, :integer
|
||||||
|
|
||||||
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.
|
||||||
field :subtitle_filepaths, {:array, {:array, :string}}, default: []
|
field :subtitle_filepaths, {:array, {:array, :string}}, default: []
|
||||||
|
|
||||||
|
field :prevent_download, :boolean, default: false
|
||||||
|
field :prevent_culling, :boolean, default: false
|
||||||
|
field :culled_at, :utc_datetime
|
||||||
|
|
||||||
field :matching_search_term, :string, virtual: true
|
field :matching_search_term, :string, virtual: true
|
||||||
|
|
||||||
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
|
||||||
|
|
||||||
@@ -63,12 +104,61 @@ defmodule Pinchflat.Media.MediaItem do
|
|||||||
media_item
|
media_item
|
||||||
|> cast(attrs, @allowed_fields)
|
|> cast(attrs, @allowed_fields)
|
||||||
|> cast_assoc(:metadata, with: &MediaMetadata.changeset/2, required: false)
|
|> cast_assoc(:metadata, with: &MediaMetadata.changeset/2, required: false)
|
||||||
|
|> dynamic_default(:uuid, fn _ -> Ecto.UUID.generate() end)
|
||||||
|
|> update_upload_date_index()
|
||||||
|> validate_required(@required_fields)
|
|> validate_required(@required_fields)
|
||||||
|> unique_constraint([:media_id, :source_id])
|
|> unique_constraint([:media_id, :source_id])
|
||||||
end
|
end
|
||||||
|
|
||||||
@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
|
||||||
|
|
||||||
|
@doc false
|
||||||
|
def filepath_attribute_defaults do
|
||||||
|
filepath_attributes()
|
||||||
|
|> Enum.map(fn
|
||||||
|
:subtitle_filepaths -> {:subtitle_filepaths, []}
|
||||||
|
field -> {field, nil}
|
||||||
|
end)
|
||||||
|
|> Enum.into(%{})
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc false
|
||||||
|
def json_exluded_fields do
|
||||||
|
~w(__meta__ __struct__ metadata tasks media_items_search_index)a
|
||||||
|
end
|
||||||
|
|
||||||
|
defp update_upload_date_index(%{changes: changes} = changeset) when is_map_key(changes, :upload_date) do
|
||||||
|
source_id = get_field(changeset, :source_id)
|
||||||
|
source = Sources.get_source!(source_id)
|
||||||
|
# Channels should count down from 99, playlists should count up from 0
|
||||||
|
# This reflects the fact that channels prepend new videos to the top of the list
|
||||||
|
# and playlists append new videos to the bottom of the list.
|
||||||
|
default_index = if source.collection_type == :channel, do: 99, else: 0
|
||||||
|
aggregator = if source.collection_type == :channel, do: :min, else: :max
|
||||||
|
change_direction = if source.collection_type == :channel, do: -1, else: 1
|
||||||
|
|
||||||
|
current_max =
|
||||||
|
MediaQuery.new()
|
||||||
|
|> where(^dynamic([mi], mi.upload_date == ^changes.upload_date and ^MediaQuery.for_source(source)))
|
||||||
|
|> Repo.aggregate(aggregator, :upload_date_index)
|
||||||
|
|
||||||
|
case current_max do
|
||||||
|
nil -> put_change(changeset, :upload_date_index, default_index)
|
||||||
|
max -> put_change(changeset, :upload_date_index, max + change_direction)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp update_upload_date_index(changeset), do: changeset
|
||||||
|
|
||||||
|
defimpl Jason.Encoder, for: MediaItem do
|
||||||
|
def encode(value, opts) do
|
||||||
|
value
|
||||||
|
|> Repo.preload(:source)
|
||||||
|
|> Map.drop(MediaItem.json_exluded_fields())
|
||||||
|
|> Jason.Encode.map(opts)
|
||||||
|
end
|
||||||
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.
|
||||||
|
|||||||
@@ -0,0 +1,165 @@
|
|||||||
|
defmodule Pinchflat.Media.MediaQuery do
|
||||||
|
@moduledoc """
|
||||||
|
Query helpers for the Media context.
|
||||||
|
|
||||||
|
These methods are made to be one-ish liners used
|
||||||
|
to compose queries. Each method should strive to do
|
||||||
|
_one_ thing. These don't need to be tested as
|
||||||
|
they are just building blocks for other functionality
|
||||||
|
which, itself, will be tested.
|
||||||
|
"""
|
||||||
|
import Ecto.Query, warn: false
|
||||||
|
|
||||||
|
alias Pinchflat.Media.MediaItem
|
||||||
|
|
||||||
|
# This allows the module to be aliased and query methods to be used
|
||||||
|
# all in one go
|
||||||
|
# usage: use Pinchflat.Media.MediaQuery
|
||||||
|
defmacro __using__(_opts) do
|
||||||
|
quote do
|
||||||
|
import Ecto.Query, warn: false
|
||||||
|
|
||||||
|
alias unquote(__MODULE__)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def new do
|
||||||
|
MediaItem
|
||||||
|
end
|
||||||
|
|
||||||
|
def for_source(source_id) when is_integer(source_id), do: dynamic([mi], mi.source_id == ^source_id)
|
||||||
|
def for_source(source), do: dynamic([mi], mi.source_id == ^source.id)
|
||||||
|
|
||||||
|
def downloaded, do: dynamic([mi], not is_nil(mi.media_filepath))
|
||||||
|
def download_prevented, do: dynamic([mi], mi.prevent_download == true)
|
||||||
|
def culling_prevented, do: dynamic([mi], mi.prevent_culling == true)
|
||||||
|
def culled, do: dynamic([mi], not is_nil(mi.culled_at))
|
||||||
|
def redownloaded, do: dynamic([mi], not is_nil(mi.media_redownloaded_at))
|
||||||
|
|
||||||
|
def upload_date_after_source_cutoff do
|
||||||
|
dynamic([mi, source], is_nil(source.download_cutoff_date) or mi.upload_date >= source.download_cutoff_date)
|
||||||
|
end
|
||||||
|
|
||||||
|
def format_matching_profile_preference do
|
||||||
|
dynamic(
|
||||||
|
[mi, source, media_profile],
|
||||||
|
fragment("""
|
||||||
|
CASE
|
||||||
|
WHEN shorts_behaviour = 'only' AND livestream_behaviour = 'only' THEN
|
||||||
|
livestream = true OR short_form_content = true
|
||||||
|
WHEN shorts_behaviour = 'only' THEN
|
||||||
|
short_form_content = true
|
||||||
|
WHEN livestream_behaviour = 'only' THEN
|
||||||
|
livestream = true
|
||||||
|
WHEN shorts_behaviour = 'exclude' AND livestream_behaviour = 'exclude' THEN
|
||||||
|
short_form_content = false AND livestream = false
|
||||||
|
WHEN shorts_behaviour = 'exclude' THEN
|
||||||
|
short_form_content = false
|
||||||
|
WHEN livestream_behaviour = 'exclude' THEN
|
||||||
|
livestream = false
|
||||||
|
ELSE
|
||||||
|
true
|
||||||
|
END
|
||||||
|
""")
|
||||||
|
)
|
||||||
|
end
|
||||||
|
|
||||||
|
def matches_source_title_regex do
|
||||||
|
dynamic(
|
||||||
|
[mi, source],
|
||||||
|
is_nil(source.title_filter_regex) or fragment("regexp_like(?, ?)", mi.title, source.title_filter_regex)
|
||||||
|
)
|
||||||
|
end
|
||||||
|
|
||||||
|
def past_retention_period do
|
||||||
|
dynamic(
|
||||||
|
[mi, source],
|
||||||
|
fragment("""
|
||||||
|
IFNULL(retention_period_days, 0) > 0 AND
|
||||||
|
DATETIME('now', '-' || retention_period_days || ' day') > media_downloaded_at
|
||||||
|
""")
|
||||||
|
)
|
||||||
|
end
|
||||||
|
|
||||||
|
def past_redownload_delay do
|
||||||
|
dynamic(
|
||||||
|
[mi, source, media_profile],
|
||||||
|
# Returns media items where the upload_date is at least redownload_delay_days ago AND
|
||||||
|
# downloaded_at minus the redownload_delay_days is before the upload date
|
||||||
|
fragment("""
|
||||||
|
IFNULL(redownload_delay_days, 0) > 0 AND
|
||||||
|
DATETIME('now', '-' || redownload_delay_days || ' day') > upload_date AND
|
||||||
|
DATETIME(media_downloaded_at, '-' || redownload_delay_days || ' day') < upload_date
|
||||||
|
""")
|
||||||
|
)
|
||||||
|
end
|
||||||
|
|
||||||
|
def cullable do
|
||||||
|
dynamic(
|
||||||
|
[mi, source],
|
||||||
|
^downloaded() and
|
||||||
|
^past_retention_period() and
|
||||||
|
not (^culling_prevented())
|
||||||
|
)
|
||||||
|
end
|
||||||
|
|
||||||
|
def pending do
|
||||||
|
dynamic(
|
||||||
|
[mi],
|
||||||
|
not (^downloaded()) and
|
||||||
|
not (^download_prevented()) and
|
||||||
|
^upload_date_after_source_cutoff() and
|
||||||
|
^format_matching_profile_preference() and
|
||||||
|
^matches_source_title_regex()
|
||||||
|
)
|
||||||
|
end
|
||||||
|
|
||||||
|
def redownloadable do
|
||||||
|
dynamic(
|
||||||
|
[mi, source],
|
||||||
|
^downloaded() and
|
||||||
|
not (^download_prevented()) and
|
||||||
|
not (^culled()) and
|
||||||
|
not (^redownloaded()) and
|
||||||
|
^past_redownload_delay()
|
||||||
|
)
|
||||||
|
end
|
||||||
|
|
||||||
|
def require_assoc(query, identifier) do
|
||||||
|
if has_named_binding?(query, identifier) do
|
||||||
|
query
|
||||||
|
else
|
||||||
|
do_require_assoc(query, identifier)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp do_require_assoc(query, :source) do
|
||||||
|
from(mi in query, join: s in assoc(mi, :source), as: :source)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp do_require_assoc(query, :media_profile) do
|
||||||
|
query
|
||||||
|
|> require_assoc(:source)
|
||||||
|
|> join(:inner, [mi, source], mp in assoc(source, :media_profile), as: :media_profile)
|
||||||
|
end
|
||||||
|
|
||||||
|
# This needs to be a non-dynamic query because it alone should control things like
|
||||||
|
# ordering and `snippets` for full-text search
|
||||||
|
def matching_search_term(query, nil), do: query
|
||||||
|
|
||||||
|
def matching_search_term(query, term) do
|
||||||
|
from(mi in query,
|
||||||
|
join: mi_search_index in assoc(mi, :media_items_search_index),
|
||||||
|
where: fragment("media_items_search_index MATCH ?", ^term),
|
||||||
|
select_merge: %{
|
||||||
|
matching_search_term:
|
||||||
|
fragment("""
|
||||||
|
coalesce(snippet(media_items_search_index, 0, '[PF_HIGHLIGHT]', '[/PF_HIGHLIGHT]', '...', 20), '') ||
|
||||||
|
' ' ||
|
||||||
|
coalesce(snippet(media_items_search_index, 1, '[PF_HIGHLIGHT]', '[/PF_HIGHLIGHT]', '...', 20), '')
|
||||||
|
""")
|
||||||
|
},
|
||||||
|
order_by: [desc: fragment("rank")]
|
||||||
|
)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -1,81 +0,0 @@
|
|||||||
defmodule Pinchflat.MediaClient.Backends.YtDlp.CommandRunner do
|
|
||||||
@moduledoc """
|
|
||||||
Runs yt-dlp commands using the `System.cmd/3` function
|
|
||||||
"""
|
|
||||||
|
|
||||||
require Logger
|
|
||||||
|
|
||||||
alias Pinchflat.Utils.StringUtils
|
|
||||||
alias Pinchflat.Utils.FilesystemUtils, as: FSUtils
|
|
||||||
alias Pinchflat.MediaClient.Backends.BackendCommandRunner
|
|
||||||
|
|
||||||
@behaviour BackendCommandRunner
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Runs a yt-dlp command and returns the string output. Saves the output to
|
|
||||||
a file and then returns its contents because yt-dlp will return warnings
|
|
||||||
to stdout even if the command is successful, but these will break JSON parsing.
|
|
||||||
|
|
||||||
Additional Opts:
|
|
||||||
- :output_filepath - the path to save the output to. If not provided, a temporary
|
|
||||||
file will be created and used. Useful for if you need a reference to the file
|
|
||||||
for a file watcher.
|
|
||||||
|
|
||||||
Returns {:ok, binary()} | {:error, output, status}.
|
|
||||||
"""
|
|
||||||
@impl BackendCommandRunner
|
|
||||||
def run(url, command_opts, output_template, addl_opts \\ []) do
|
|
||||||
command = backend_executable()
|
|
||||||
# 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.
|
|
||||||
output_filepath = Keyword.get(addl_opts, :output_filepath, FSUtils.generate_metadata_tmpfile(:json))
|
|
||||||
print_to_file_opts = [{:print_to_file, output_template}, output_filepath]
|
|
||||||
formatted_command_opts = [url] ++ parse_options(command_opts ++ print_to_file_opts)
|
|
||||||
|
|
||||||
Logger.info("[yt-dlp] called with: #{Enum.join(formatted_command_opts, " ")}")
|
|
||||||
|
|
||||||
case System.cmd(command, formatted_command_opts, stderr_to_stdout: true) do
|
|
||||||
{_, 0} ->
|
|
||||||
# IDEA: consider deleting the file after reading it
|
|
||||||
# (even on error? especially on error?)
|
|
||||||
File.read(output_filepath)
|
|
||||||
|
|
||||||
{output, status} ->
|
|
||||||
{:error, output, status}
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# We want to satisfy the following behaviours:
|
|
||||||
#
|
|
||||||
# 1. If the key is an atom, convert it to a string and convert it to kebab case (for convenience)
|
|
||||||
# 2. If the key is a string, assume we want it as-is and don't convert it
|
|
||||||
# 3. If the key is accompanied by a value, append the value to the list
|
|
||||||
# 4. If the key is not accompanied by a value, assume it's a flag and PREpend it to the list
|
|
||||||
defp parse_options(command_opts) do
|
|
||||||
Enum.reduce(command_opts, [], &parse_option/2)
|
|
||||||
end
|
|
||||||
|
|
||||||
defp parse_option({k, v}, acc) when is_atom(k) do
|
|
||||||
stringified_key = StringUtils.to_kebab_case(Atom.to_string(k))
|
|
||||||
|
|
||||||
parse_option({"--#{stringified_key}", v}, acc)
|
|
||||||
end
|
|
||||||
|
|
||||||
defp parse_option({k, v}, acc) when is_binary(k) do
|
|
||||||
acc ++ [k, to_string(v)]
|
|
||||||
end
|
|
||||||
|
|
||||||
defp parse_option(arg, acc) when is_atom(arg) do
|
|
||||||
stringified_arg = StringUtils.to_kebab_case(Atom.to_string(arg))
|
|
||||||
|
|
||||||
parse_option("--#{stringified_arg}", acc)
|
|
||||||
end
|
|
||||||
|
|
||||||
defp parse_option(arg, acc) when is_binary(arg) do
|
|
||||||
acc ++ [arg]
|
|
||||||
end
|
|
||||||
|
|
||||||
defp backend_executable do
|
|
||||||
Application.get_env(:pinchflat, :yt_dlp_executable)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -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,72 +0,0 @@
|
|||||||
defmodule Pinchflat.MediaClient.Backends.YtDlp.MetadataFileHelpers do
|
|
||||||
@moduledoc """
|
|
||||||
Provides methods for creating/downloading/storing related metadata
|
|
||||||
out-of-band of the normal yt-dlp backend process.
|
|
||||||
|
|
||||||
The idea is that I don't want to craft a complicated yt-dlp command,
|
|
||||||
instead focusing on downloading the media as the user wants it then
|
|
||||||
I can use the result of that here to grab the additional information
|
|
||||||
needed
|
|
||||||
"""
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Compresses and stores metadata for a media item, returning the filepath.
|
|
||||||
|
|
||||||
Returns binary()
|
|
||||||
"""
|
|
||||||
def compress_and_store_metadata_for(database_record, metadata_map) do
|
|
||||||
filepath = generate_filepath_for(database_record, "metadata.json.gz")
|
|
||||||
{:ok, json} = Phoenix.json_library().encode(metadata_map)
|
|
||||||
|
|
||||||
File.mkdir_p!(Path.dirname(filepath))
|
|
||||||
:ok = File.write(filepath, json, [:compressed])
|
|
||||||
|
|
||||||
filepath
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Reads and decodes compressed metadata from a filepath.
|
|
||||||
|
|
||||||
Returns {:ok, map()} | {:error, any}
|
|
||||||
"""
|
|
||||||
def read_compressed_metadata(filepath) do
|
|
||||||
{:ok, json} = File.open(filepath, [:read, :compressed], &IO.read(&1, :all))
|
|
||||||
|
|
||||||
Phoenix.json_library().decode(json)
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Downloads and stores a thumbnail for a media item, returning the filepath.
|
|
||||||
|
|
||||||
Returns binary()
|
|
||||||
"""
|
|
||||||
def download_and_store_thumbnail_for(database_record, metadata_map) do
|
|
||||||
thumbnail_url = metadata_map["thumbnail"]
|
|
||||||
filepath = generate_filepath_for(database_record, Path.basename(thumbnail_url))
|
|
||||||
thumbnail_blob = fetch_thumbnail_from_url(thumbnail_url)
|
|
||||||
|
|
||||||
File.mkdir_p!(Path.dirname(filepath))
|
|
||||||
:ok = File.write(filepath, thumbnail_blob)
|
|
||||||
|
|
||||||
filepath
|
|
||||||
end
|
|
||||||
|
|
||||||
defp fetch_thumbnail_from_url(url) do
|
|
||||||
http_client = Application.get_env(:pinchflat, :http_client, Pinchflat.HTTP.HTTPClient)
|
|
||||||
{:ok, body} = http_client.get(url, [], body_format: :binary)
|
|
||||||
|
|
||||||
body
|
|
||||||
end
|
|
||||||
|
|
||||||
defp generate_filepath_for(database_record, filename) do
|
|
||||||
metadata_directory = Application.get_env(:pinchflat, :metadata_directory)
|
|
||||||
record_table_name = database_record.__meta__.source
|
|
||||||
|
|
||||||
Path.join([
|
|
||||||
metadata_directory,
|
|
||||||
record_table_name,
|
|
||||||
to_string(database_record.id),
|
|
||||||
filename
|
|
||||||
])
|
|
||||||
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.
|
||||||
|
|
||||||
@@ -0,0 +1,151 @@
|
|||||||
|
defmodule Pinchflat.Metadata.MetadataFileHelpers do
|
||||||
|
@moduledoc """
|
||||||
|
Provides methods for creating/downloading/storing related metadata
|
||||||
|
out-of-band of the normal yt-dlp backend process.
|
||||||
|
|
||||||
|
The idea is that I don't want to craft a complicated yt-dlp command,
|
||||||
|
instead focusing on downloading the media as the user wants it then
|
||||||
|
I can use the result of that here to grab the additional information
|
||||||
|
needed
|
||||||
|
"""
|
||||||
|
|
||||||
|
alias Pinchflat.Utils.FilesystemUtils
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Returns the directory where metadata for a database record should be stored.
|
||||||
|
|
||||||
|
Returns binary()
|
||||||
|
"""
|
||||||
|
def metadata_directory_for(database_record) do
|
||||||
|
metadata_directory = Application.get_env(:pinchflat, :metadata_directory)
|
||||||
|
record_table_name = database_record.__meta__.source
|
||||||
|
|
||||||
|
Path.join([
|
||||||
|
metadata_directory,
|
||||||
|
record_table_name,
|
||||||
|
to_string(database_record.id)
|
||||||
|
])
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Compresses and stores metadata for a media item, returning the filepath.
|
||||||
|
|
||||||
|
Returns binary()
|
||||||
|
"""
|
||||||
|
def compress_and_store_metadata_for(database_record, metadata_map) do
|
||||||
|
filepath = generate_filepath_for(database_record, "metadata.json.gz")
|
||||||
|
{:ok, json} = Phoenix.json_library().encode(metadata_map)
|
||||||
|
|
||||||
|
:ok = FilesystemUtils.write_p!(filepath, json, [:compressed])
|
||||||
|
|
||||||
|
filepath
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Reads and decodes compressed metadata from a filepath.
|
||||||
|
|
||||||
|
Returns {:ok, map()} | {:error, any}
|
||||||
|
"""
|
||||||
|
def read_compressed_metadata(filepath) do
|
||||||
|
{:ok, json} = File.open(filepath, [:read, :compressed], &IO.read(&1, :all))
|
||||||
|
|
||||||
|
Phoenix.json_library().decode(json)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Downloads and stores a thumbnail for a media item, returning the filepath.
|
||||||
|
Chooses the highest quality thumbnail available (preferring jpg). Returns
|
||||||
|
nil if no thumbnails are available.
|
||||||
|
|
||||||
|
Returns binary() | nil
|
||||||
|
"""
|
||||||
|
def download_and_store_thumbnail_for(database_record, metadata_map) do
|
||||||
|
thumbnails =
|
||||||
|
(metadata_map["thumbnails"] || [])
|
||||||
|
# Give it a low preference if the `preference` key doesn't exist
|
||||||
|
|> Enum.map(&Map.put_new(&1, "preference", -1000))
|
||||||
|
# Give it a low preference if image isn't a jpg
|
||||||
|
|> Enum.map(fn t ->
|
||||||
|
preference_weight = if String.ends_with?(t["url"], ".jpg"), do: t["preference"], else: t["preference"] - 1000
|
||||||
|
|
||||||
|
Map.put(t, "preference", preference_weight)
|
||||||
|
end)
|
||||||
|
|
||||||
|
case Enum.sort_by(thumbnails, & &1["preference"], :desc) do
|
||||||
|
[thumbnail_map | _] ->
|
||||||
|
thumbnail_url = thumbnail_map["url"]
|
||||||
|
filepath = generate_filepath_for(database_record, Path.basename(thumbnail_url))
|
||||||
|
thumbnail_blob = fetch_thumbnail_from_url(thumbnail_url)
|
||||||
|
|
||||||
|
:ok = FilesystemUtils.write_p!(filepath, thumbnail_blob)
|
||||||
|
|
||||||
|
filepath
|
||||||
|
|
||||||
|
_ ->
|
||||||
|
nil
|
||||||
|
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
|
||||||
|
http_client = Application.get_env(:pinchflat, :http_client, Pinchflat.HTTP.HTTPClient)
|
||||||
|
{:ok, body} = http_client.get(url, [], body_format: :binary)
|
||||||
|
|
||||||
|
body
|
||||||
|
end
|
||||||
|
|
||||||
|
defp generate_filepath_for(database_record, filename) do
|
||||||
|
Path.join([
|
||||||
|
metadata_directory_for(database_record),
|
||||||
|
filename
|
||||||
|
])
|
||||||
|
end
|
||||||
|
end
|
||||||
+38
-6
@@ -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,13 @@ 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"],
|
||||||
|
duration_seconds: metadata["duration"] && round(metadata["duration"])
|
||||||
}
|
}
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -51,14 +55,42 @@ 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
|
||||||
|
filepath =
|
||||||
|
thumbnail_filepath
|
||||||
|
|> String.split(~r{\.}, include_captures: true)
|
||||||
|
|> List.insert_at(-3, "-thumb")
|
||||||
|
|> Enum.join()
|
||||||
|
|
||||||
|
%{
|
||||||
|
thumbnail_filepath: filepath_if_exists(filepath)
|
||||||
|
}
|
||||||
|
else
|
||||||
|
%{
|
||||||
|
thumbnail_filepath: nil
|
||||||
|
}
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
defp parse_infojson_metadata(metadata) do
|
defp parse_infojson_metadata(metadata) do
|
||||||
%{
|
%{
|
||||||
metadata_filepath: metadata["infojson_filename"]
|
metadata_filepath: filepath_if_exists(metadata["infojson_filename"])
|
||||||
}
|
}
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# NOTE: this should not be needed, but it is due to a bug in yt-dlp.
|
||||||
|
# Can remove once this is resolved:
|
||||||
|
# https://github.com/yt-dlp/yt-dlp/issues/9445#issuecomment-2018724344
|
||||||
|
defp filepath_if_exists(nil), do: nil
|
||||||
|
|
||||||
|
defp filepath_if_exists(filepath) do
|
||||||
|
if File.exists?(filepath) do
|
||||||
|
filepath
|
||||||
|
else
|
||||||
|
nil
|
||||||
|
end
|
||||||
|
end
|
||||||
end
|
end
|
||||||
@@ -0,0 +1,70 @@
|
|||||||
|
defmodule Pinchflat.Metadata.NfoBuilder do
|
||||||
|
@moduledoc """
|
||||||
|
Provides methods for building and storing NFO files for
|
||||||
|
use by Kodi/Jellyfin and other media center software.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import Pinchflat.Utils.XmlUtils, only: [safe: 1]
|
||||||
|
|
||||||
|
alias Pinchflat.Metadata.MetadataFileHelpers
|
||||||
|
alias Pinchflat.Utils.FilesystemUtils
|
||||||
|
|
||||||
|
@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)
|
||||||
|
|
||||||
|
FilesystemUtils.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)
|
||||||
|
|
||||||
|
FilesystemUtils.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>#{safe(metadata["title"])}</title>
|
||||||
|
<showtitle>#{safe(metadata["uploader"])}</showtitle>
|
||||||
|
<uniqueid type="youtube" default="true">#{safe(metadata["id"])}</uniqueid>
|
||||||
|
<plot>#{safe(metadata["description"])}</plot>
|
||||||
|
<aired>#{safe(upload_date)}</aired>
|
||||||
|
<season>#{safe(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>#{safe(metadata["title"])}</title>
|
||||||
|
<plot>#{safe(metadata["description"])}</plot>
|
||||||
|
<uniqueid type="youtube" default="true">#{safe(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.Utils.FilesystemUtils
|
||||||
|
|
||||||
|
@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}"])
|
||||||
|
|
||||||
|
FilesystemUtils.cp_p!(tmp_filepath, final_filepath)
|
||||||
|
|
||||||
|
{source_attr_name, final_filepath}
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,50 @@
|
|||||||
|
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
|
||||||
|
fanart_filepath
|
||||||
|
poster_filepath
|
||||||
|
banner_filepath
|
||||||
|
)a
|
||||||
|
|
||||||
|
@required_fields ~w(metadata_filepath)a
|
||||||
|
|
||||||
|
schema "source_metadata" do
|
||||||
|
field :metadata_filepath, :string
|
||||||
|
field :fanart_filepath, :string
|
||||||
|
field :poster_filepath, :string
|
||||||
|
field :banner_filepath, :string
|
||||||
|
|
||||||
|
belongs_to :source, Source
|
||||||
|
|
||||||
|
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
|
||||||
|
fanart_filepath
|
||||||
|
poster_filepath
|
||||||
|
banner_filepath
|
||||||
|
)a
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,116 @@
|
|||||||
|
defmodule Pinchflat.Metadata.SourceMetadataStorageWorker do
|
||||||
|
@moduledoc false
|
||||||
|
|
||||||
|
use Oban.Worker,
|
||||||
|
queue: :remote_metadata,
|
||||||
|
tags: ["media_source", "source_metadata", "remote_metadata", "show_in_dashboard"],
|
||||||
|
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:
|
||||||
|
- Attributes like `description`
|
||||||
|
- 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 or it's original_url
|
||||||
|
is 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, source_image_attrs, metadata_image_attrs} =
|
||||||
|
fetch_source_metadata_and_images(series_directory, source)
|
||||||
|
|
||||||
|
source_metadata_filepath = MetadataFileHelpers.compress_and_store_metadata_for(source, source_metadata)
|
||||||
|
|
||||||
|
Sources.update_source(
|
||||||
|
source,
|
||||||
|
Map.merge(
|
||||||
|
%{
|
||||||
|
series_directory: series_directory,
|
||||||
|
nfo_filepath: store_source_nfo(source, series_directory, source_metadata),
|
||||||
|
description: source_metadata["description"],
|
||||||
|
metadata: Map.merge(%{metadata_filepath: source_metadata_filepath}, metadata_image_attrs)
|
||||||
|
},
|
||||||
|
source_image_attrs
|
||||||
|
),
|
||||||
|
# `run_post_commit_tasks: false` prevents this from running in an infinite loop
|
||||||
|
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
|
||||||
|
metadata_directory = MetadataFileHelpers.metadata_directory_for(source)
|
||||||
|
tmp_output_path = "#{tmp_directory()}/#{StringUtils.random_string(16)}/source_image.%(ext)S"
|
||||||
|
opts = [:write_all_thumbnails, convert_thumbnails: "jpg", output: tmp_output_path]
|
||||||
|
|
||||||
|
{:ok, metadata} = MediaCollection.get_source_metadata(source.original_url, opts)
|
||||||
|
metadata_image_attrs = SourceImageParser.store_source_images(metadata_directory, metadata)
|
||||||
|
|
||||||
|
if source.media_profile.download_source_images && series_directory do
|
||||||
|
source_image_attrs = SourceImageParser.store_source_images(series_directory, metadata)
|
||||||
|
|
||||||
|
{metadata, source_image_attrs, metadata_image_attrs}
|
||||||
|
else
|
||||||
|
{metadata, %{}, metadata_image_attrs}
|
||||||
|
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
|
||||||
@@ -0,0 +1,79 @@
|
|||||||
|
defmodule Pinchflat.Podcasts.PodcastHelpers do
|
||||||
|
@moduledoc """
|
||||||
|
Methods for fetching postcast-related data from a source
|
||||||
|
or its media items
|
||||||
|
"""
|
||||||
|
|
||||||
|
use Pinchflat.Media.MediaQuery
|
||||||
|
|
||||||
|
alias Pinchflat.Repo
|
||||||
|
alias Pinchflat.Metadata.MediaMetadata
|
||||||
|
alias Pinchflat.Metadata.SourceMetadata
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Returns a list of media items that have been downloaded to disk
|
||||||
|
and have been proven to still exist there.
|
||||||
|
|
||||||
|
Useful for podcasts since we don't want to serve media that
|
||||||
|
has been deleted or moved, but it's also fairly generally useful
|
||||||
|
so I could see this being moved in the future.
|
||||||
|
|
||||||
|
Options:
|
||||||
|
- limit: integer - the maximum number of media items to return
|
||||||
|
|
||||||
|
Returns: [%MediaItem{}]
|
||||||
|
"""
|
||||||
|
def persisted_media_items_for(source, opts \\ []) do
|
||||||
|
limit = Keyword.get(opts, :limit, 1_000)
|
||||||
|
|
||||||
|
MediaQuery.new()
|
||||||
|
|> where(^dynamic(^MediaQuery.for_source(source) and ^MediaQuery.downloaded()))
|
||||||
|
|> order_by(desc: :upload_date)
|
||||||
|
|> Repo.maybe_limit(limit)
|
||||||
|
|> Repo.all()
|
||||||
|
|> Enum.filter(fn media_item -> File.exists?(media_item.media_filepath) end)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Selects a cover image for a source based on the source's metadata
|
||||||
|
and the metadata of the media items associated with the source. Also
|
||||||
|
ensures images exist on disk.
|
||||||
|
|
||||||
|
Only one media item should need to be returned since this is using the
|
||||||
|
internal metadata which, so long as the media_item was _downloaded_, should
|
||||||
|
be guaranteed to exist.
|
||||||
|
|
||||||
|
Prefers the source's poster, then fanart, then the media item's thumbnail.
|
||||||
|
|
||||||
|
Returns: {:ok, filepath} | {:error, :no_suitable_image}
|
||||||
|
"""
|
||||||
|
def select_cover_image(source, media_items) do
|
||||||
|
source_with_preloads = Repo.preload(source, :metadata)
|
||||||
|
|
||||||
|
source_with_preloads
|
||||||
|
|> get_images_by_preference(media_items)
|
||||||
|
|> Enum.reject(&is_nil(&1))
|
||||||
|
|> Enum.find(&File.exists?/1)
|
||||||
|
|> case do
|
||||||
|
nil -> {:error, :no_suitable_image}
|
||||||
|
filepath -> {:ok, filepath}
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp get_images_by_preference(source_with_preloads, []) do
|
||||||
|
source_metadata = source_with_preloads.metadata || %SourceMetadata{}
|
||||||
|
|
||||||
|
[
|
||||||
|
source_metadata.poster_filepath,
|
||||||
|
source_metadata.fanart_filepath
|
||||||
|
]
|
||||||
|
end
|
||||||
|
|
||||||
|
defp get_images_by_preference(source_with_preloads, [media_item | _]) do
|
||||||
|
media_item_with_preloads = Repo.preload(media_item, :metadata)
|
||||||
|
media_item_metadata = media_item_with_preloads.metadata || %MediaMetadata{}
|
||||||
|
source_images = get_images_by_preference(source_with_preloads, [])
|
||||||
|
|
||||||
|
source_images ++ [media_item_metadata.thumbnail_filepath]
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,149 @@
|
|||||||
|
defmodule Pinchflat.Podcasts.RssFeedBuilder do
|
||||||
|
@moduledoc """
|
||||||
|
Methods for building an RSS feed for a source and its media items.
|
||||||
|
"""
|
||||||
|
|
||||||
|
@datetime_format "%a, %d %b %Y %H:%M:%S %z"
|
||||||
|
|
||||||
|
import Pinchflat.Utils.XmlUtils, only: [safe: 1]
|
||||||
|
|
||||||
|
alias Pinchflat.Utils.DatetimeUtils
|
||||||
|
alias Pinchflat.Podcasts.PodcastHelpers
|
||||||
|
alias PinchflatWeb.Router.Helpers, as: Routes
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Builds an RSS feed for a given source and its media items.
|
||||||
|
Only MediaItems that have been persisted will be included in the feed.
|
||||||
|
|
||||||
|
## Options:
|
||||||
|
- `:limit` - The maximum number of media items to include in the feed. Defaults to 2,000.
|
||||||
|
|
||||||
|
Returns an XML document as a string.
|
||||||
|
"""
|
||||||
|
def build(source, opts \\ []) do
|
||||||
|
limit = Keyword.get(opts, :limit, 2_000)
|
||||||
|
url_base = Keyword.get(opts, :url_base, PinchflatWeb.Endpoint.url())
|
||||||
|
|
||||||
|
media_items = PodcastHelpers.persisted_media_items_for(source, limit: limit)
|
||||||
|
build_source_xml(source, media_items, url_base)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp build_source_xml(source, media_items, url_base) do
|
||||||
|
media_item_xml = Enum.map(media_items, &build_media_item_xml(source, &1, url_base))
|
||||||
|
# "caching" the image path since it requires some DB calls and is used twice
|
||||||
|
feed_image_path = feed_image_path(url_base, source, media_items)
|
||||||
|
|
||||||
|
# Useful: resources:
|
||||||
|
# - https://validator.w3.org/feed/#validate_by_input
|
||||||
|
# - https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md
|
||||||
|
# - https://podba.se/validate
|
||||||
|
"""
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<rss version="2.0"
|
||||||
|
xmlns:itunes="http://www.itunes.com/dtds/podcast-1.0.dtd"
|
||||||
|
xmlns:podcast="https://podcastindex.org/namespace/1.0"
|
||||||
|
xmlns:atom="http://www.w3.org/2005/Atom">
|
||||||
|
<channel>
|
||||||
|
<title>#{safe(source.custom_name)}</title>
|
||||||
|
<link>#{safe(source.original_url)}</link>
|
||||||
|
<description>#{safe(source.description)}</description>
|
||||||
|
<category>TV & Film</category>
|
||||||
|
<generator>Generated by Pinchflat</generator>
|
||||||
|
<language>en-us</language>
|
||||||
|
<lastBuildDate>#{Calendar.strftime(source.updated_at, @datetime_format)}</lastBuildDate>
|
||||||
|
<pubDate>#{Calendar.strftime(source.inserted_at, @datetime_format)}</pubDate>
|
||||||
|
<atom:link href="#{safe(generate_self_link(url_base, source))}" rel="self" type="application/rss+xml" />
|
||||||
|
<podcast:locked>yes</podcast:locked>
|
||||||
|
<podcast:guid>#{source.uuid}</podcast:guid>
|
||||||
|
<image>
|
||||||
|
<url>#{safe(feed_image_path)}</url>
|
||||||
|
<title>#{safe(source.custom_name)}</title>
|
||||||
|
<link>#{safe(source.original_url)}</link>
|
||||||
|
</image>
|
||||||
|
<itunes:author>#{safe(source.custom_name)}</itunes:author>
|
||||||
|
<itunes:subtitle>#{safe(source.custom_name)}</itunes:subtitle>
|
||||||
|
<itunes:block>yes</itunes:block>
|
||||||
|
<itunes:image href="#{safe(feed_image_path)}"></itunes:image>
|
||||||
|
<itunes:explicit>false</itunes:explicit>
|
||||||
|
<itunes:category text="TV & Film"></itunes:category>
|
||||||
|
|
||||||
|
#{Enum.join(media_item_xml, "\n")}
|
||||||
|
|
||||||
|
</channel>
|
||||||
|
</rss>
|
||||||
|
"""
|
||||||
|
end
|
||||||
|
|
||||||
|
defp build_media_item_xml(source, media_item, url_base) do
|
||||||
|
item_image_path = item_image_path(url_base, media_item)
|
||||||
|
|
||||||
|
"""
|
||||||
|
<item>
|
||||||
|
<guid isPermaLink="false">#{media_item.uuid}</guid>
|
||||||
|
<title>#{safe(media_item.title)}</title>
|
||||||
|
<link>#{safe(media_item.original_url)}</link>
|
||||||
|
<description>#{safe(media_item.description)}</description>
|
||||||
|
<pubDate>#{generate_upload_date(media_item)}</pubDate>
|
||||||
|
<itunes:duration>#{media_item.duration_seconds}</itunes:duration>
|
||||||
|
<enclosure
|
||||||
|
url="#{media_stream_path(url_base, media_item)}"
|
||||||
|
length="#{media_item.media_size_bytes}"
|
||||||
|
type="#{MIME.from_path(media_item.media_filepath)}"
|
||||||
|
/>
|
||||||
|
<itunes:author>#{safe(source.custom_name)}</itunes:author>
|
||||||
|
<itunes:subtitle>#{safe(media_item.title)}</itunes:subtitle>
|
||||||
|
<itunes:summary><![CDATA[#{media_item.description}]]></itunes:summary>
|
||||||
|
|
||||||
|
#{item_image_path && ~s(<itunes:image href="#{safe(item_image_path)}"></itunes:image>)}
|
||||||
|
#{item_image_path && ~s(<podcast:images srcset="#{safe(item_image_path)}" />)}
|
||||||
|
|
||||||
|
<itunes:explicit>false</itunes:explicit>
|
||||||
|
</item>
|
||||||
|
"""
|
||||||
|
end
|
||||||
|
|
||||||
|
defp generate_self_link(url_base, source) do
|
||||||
|
Path.join(url_base, "#{podcast_route(:rss_feed, source.uuid)}.xml")
|
||||||
|
end
|
||||||
|
|
||||||
|
defp media_stream_path(url_base, media_item) do
|
||||||
|
extension = Path.extname(media_item.media_filepath)
|
||||||
|
|
||||||
|
Path.join(url_base, "#{media_route(:stream, media_item.uuid)}#{extension}")
|
||||||
|
end
|
||||||
|
|
||||||
|
defp feed_image_path(url_base, source, media_items) do
|
||||||
|
case PodcastHelpers.select_cover_image(source, media_items) do
|
||||||
|
{:error, _} ->
|
||||||
|
""
|
||||||
|
|
||||||
|
{:ok, filepath} ->
|
||||||
|
extension = Path.extname(filepath)
|
||||||
|
Path.join(url_base, "#{podcast_route(:feed_image, source.uuid)}#{extension}")
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def item_image_path(url_base, media_item) do
|
||||||
|
if media_item.thumbnail_filepath && File.exists?(media_item.thumbnail_filepath) do
|
||||||
|
extension = Path.extname(media_item.thumbnail_filepath)
|
||||||
|
|
||||||
|
Path.join(url_base, "#{podcast_route(:episode_image, media_item.uuid)}#{extension}")
|
||||||
|
else
|
||||||
|
nil
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp generate_upload_date(media_item) do
|
||||||
|
media_item.upload_date
|
||||||
|
|> DatetimeUtils.date_to_datetime()
|
||||||
|
|> Calendar.strftime(@datetime_format)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp podcast_route(action, params) do
|
||||||
|
Routes.podcast_path(PinchflatWeb.Endpoint, action, params)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp media_route(action, params) do
|
||||||
|
Routes.media_item_path(PinchflatWeb.Endpoint, action, params)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -6,6 +6,7 @@ defmodule Pinchflat.Profiles.MediaProfile do
|
|||||||
use Ecto.Schema
|
use Ecto.Schema
|
||||||
import Ecto.Changeset
|
import Ecto.Changeset
|
||||||
|
|
||||||
|
alias __MODULE__
|
||||||
alias Pinchflat.Sources.Source
|
alias Pinchflat.Sources.Source
|
||||||
|
|
||||||
@allowed_fields ~w(
|
@allowed_fields ~w(
|
||||||
@@ -17,32 +18,42 @@ 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
|
||||||
|
sponsorblock_behaviour
|
||||||
|
sponsorblock_categories
|
||||||
shorts_behaviour
|
shorts_behaviour
|
||||||
livestream_behaviour
|
livestream_behaviour
|
||||||
preferred_resolution
|
preferred_resolution
|
||||||
|
redownload_delay_days
|
||||||
)a
|
)a
|
||||||
|
|
||||||
@required_fields ~w(name output_path_template)a
|
@required_fields ~w(name output_path_template)a
|
||||||
|
|
||||||
schema "media_profiles" do
|
schema "media_profiles" do
|
||||||
field :name, :string
|
field :name, :string
|
||||||
|
field :redownload_delay_days, :integer
|
||||||
|
|
||||||
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
|
||||||
|
field :sponsorblock_behaviour, Ecto.Enum, values: [:disabled, :remove], default: :disabled
|
||||||
|
field :sponsorblock_categories, {:array, :string}, default: []
|
||||||
# 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.
|
||||||
@@ -52,8 +63,7 @@ defmodule Pinchflat.Profiles.MediaProfile do
|
|||||||
# See `build_format_clauses` in the Media context for more.
|
# See `build_format_clauses` in the Media context for more.
|
||||||
field :shorts_behaviour, Ecto.Enum, values: ~w(include exclude only)a, default: :include
|
field :shorts_behaviour, Ecto.Enum, values: ~w(include exclude only)a, default: :include
|
||||||
field :livestream_behaviour, Ecto.Enum, values: ~w(include exclude only)a, default: :include
|
field :livestream_behaviour, Ecto.Enum, values: ~w(include exclude only)a, default: :include
|
||||||
|
field :preferred_resolution, Ecto.Enum, values: ~w(4320p 2160p 1080p 720p 480p 360p audio)a, default: :"1080p"
|
||||||
field :preferred_resolution, Ecto.Enum, values: ~w(2160p 1080p 720p 480p 360p audio)a, default: :"1080p"
|
|
||||||
|
|
||||||
has_many :sources, Source
|
has_many :sources, Source
|
||||||
|
|
||||||
@@ -65,6 +75,27 @@ 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 }}")
|
||||||
|
|> validate_number(:redownload_delay_days, greater_than_or_equal_to: 0)
|
||||||
|> unique_constraint(:name)
|
|> unique_constraint(:name)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
@doc false
|
||||||
|
def ext_regex do
|
||||||
|
~r/\.({{ ?ext ?}}|%\( ?ext ?\)[sS])$/
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc false
|
||||||
|
def json_exluded_fields do
|
||||||
|
~w(__meta__ __struct__ sources)a
|
||||||
|
end
|
||||||
|
|
||||||
|
defimpl Jason.Encoder, for: MediaProfile do
|
||||||
|
def encode(value, opts) do
|
||||||
|
value
|
||||||
|
|> Map.drop(MediaProfile.json_exluded_fields())
|
||||||
|
|> Jason.Encode.map(opts)
|
||||||
|
end
|
||||||
|
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.Utils.FilesystemUtils
|
||||||
|
|
||||||
def migrate do
|
def migrate do
|
||||||
load_app()
|
load_app()
|
||||||
|
|
||||||
@@ -18,6 +22,41 @@ 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, :extras_directory),
|
||||||
|
Application.get_env(:pinchflat, :metadata_directory),
|
||||||
|
Application.get_env(:tzdata, :data_dir)
|
||||||
|
]
|
||||||
|
|> Enum.uniq()
|
||||||
|
|> Enum.filter(&(&1 != nil))
|
||||||
|
|
||||||
|
Enum.each(directories, fn dir ->
|
||||||
|
Logger.info("Checking permissions for #{dir}")
|
||||||
|
filepath = Path.join([dir, ".keep"])
|
||||||
|
|
||||||
|
case FilesystemUtils.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 +64,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
|
||||||
|
|||||||
@@ -1,95 +0,0 @@
|
|||||||
defmodule Pinchflat.Settings do
|
|
||||||
@moduledoc """
|
|
||||||
The Settings context.
|
|
||||||
"""
|
|
||||||
|
|
||||||
import Ecto.Query, warn: false
|
|
||||||
alias Pinchflat.Repo
|
|
||||||
|
|
||||||
alias Pinchflat.Settings.Setting
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Returns the list of settings.
|
|
||||||
|
|
||||||
Returns [%Setting{}, ...]
|
|
||||||
"""
|
|
||||||
def list_settings do
|
|
||||||
Repo.all(Setting)
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Creates or updates a setting, returning the parsed value.
|
|
||||||
Raises if an unsupported datatype is used. Optionally allows
|
|
||||||
specifying the datatype.
|
|
||||||
|
|
||||||
Returns value in type of `Ecto.Enum.mappings(Setting, :datatype)`
|
|
||||||
"""
|
|
||||||
def set!(name, value) do
|
|
||||||
set!(name, value, infer_datatype(value))
|
|
||||||
end
|
|
||||||
|
|
||||||
def set!(name, value, datatype) do
|
|
||||||
# Only create if doesn't exist
|
|
||||||
case Repo.get_by(Setting, name: to_string(name)) do
|
|
||||||
nil -> create_setting!(name, value, datatype)
|
|
||||||
setting -> update_setting!(setting, value, datatype)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Gets the parsed value of a setting. Raises if the setting does not exist.
|
|
||||||
|
|
||||||
Returns value in type of `Ecto.Enum.mappings(Setting, :datatype)`
|
|
||||||
"""
|
|
||||||
def get!(name) do
|
|
||||||
Setting
|
|
||||||
|> Repo.get_by!(name: to_string(name))
|
|
||||||
|> read_setting()
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Attempts to find a setting by name or creates a setting with value
|
|
||||||
if one doesn't exist, returning the parsed value. Optionally allows
|
|
||||||
specifying the datatype.
|
|
||||||
|
|
||||||
Returns value in type of `Ecto.Enum.mappings(Setting, :datatype)`
|
|
||||||
"""
|
|
||||||
def fetch!(name, value) do
|
|
||||||
fetch!(name, value, infer_datatype(value))
|
|
||||||
end
|
|
||||||
|
|
||||||
def fetch!(name, value, datatype) do
|
|
||||||
case Repo.get_by(Setting, name: to_string(name)) do
|
|
||||||
nil -> create_setting!(name, value, datatype)
|
|
||||||
setting -> read_setting(setting)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
defp change_setting(setting, attrs) do
|
|
||||||
Setting.changeset(setting, attrs)
|
|
||||||
end
|
|
||||||
|
|
||||||
defp create_setting!(name, value, datatype) do
|
|
||||||
%Setting{}
|
|
||||||
|> change_setting(%{name: to_string(name), value: to_string(value), datatype: datatype})
|
|
||||||
|> Repo.insert!()
|
|
||||||
|> read_setting()
|
|
||||||
end
|
|
||||||
|
|
||||||
defp update_setting!(setting, value, datatype) do
|
|
||||||
setting
|
|
||||||
|> change_setting(%{value: to_string(value), datatype: datatype})
|
|
||||||
|> Repo.update!()
|
|
||||||
|> read_setting()
|
|
||||||
end
|
|
||||||
|
|
||||||
defp read_setting(%{value: value, datatype: :string}), do: value
|
|
||||||
defp read_setting(%{value: value, datatype: :boolean}), do: value in ["true", "t", "1"]
|
|
||||||
defp read_setting(%{value: value, datatype: :integer}), do: String.to_integer(value)
|
|
||||||
defp read_setting(%{value: value, datatype: :float}), do: String.to_float(value)
|
|
||||||
|
|
||||||
defp infer_datatype(value) when is_boolean(value), do: :boolean
|
|
||||||
defp infer_datatype(value) when is_integer(value), do: :integer
|
|
||||||
defp infer_datatype(value) when is_float(value), do: :float
|
|
||||||
defp infer_datatype(value) when is_binary(value), do: :string
|
|
||||||
end
|
|
||||||
@@ -1,24 +1,74 @@
|
|||||||
defmodule Pinchflat.Settings.Setting do
|
defmodule Pinchflat.Settings.Setting do
|
||||||
@moduledoc """
|
@moduledoc """
|
||||||
A Setting is a key-value pair with a datatype used to track user-level settings.
|
The Setting schema.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
use Ecto.Schema
|
use Ecto.Schema
|
||||||
import Ecto.Changeset
|
import Ecto.Changeset
|
||||||
|
|
||||||
schema "settings" do
|
@allowed_fields [
|
||||||
field :name, :string
|
:onboarding,
|
||||||
field :value, :string
|
:pro_enabled,
|
||||||
field :datatype, Ecto.Enum, values: ~w(boolean string integer float)a
|
:yt_dlp_version,
|
||||||
|
:apprise_version,
|
||||||
|
:apprise_server,
|
||||||
|
:video_codec_preference,
|
||||||
|
:audio_codec_preference
|
||||||
|
]
|
||||||
|
|
||||||
timestamps(type: :utc_datetime)
|
@virtual_fields [
|
||||||
|
:video_codec_preference_string,
|
||||||
|
:audio_codec_preference_string
|
||||||
|
]
|
||||||
|
|
||||||
|
@required_fields ~w(
|
||||||
|
onboarding
|
||||||
|
pro_enabled
|
||||||
|
)a
|
||||||
|
|
||||||
|
schema "settings" do
|
||||||
|
field :onboarding, :boolean, default: true
|
||||||
|
field :pro_enabled, :boolean, default: false
|
||||||
|
field :yt_dlp_version, :string
|
||||||
|
field :apprise_version, :string
|
||||||
|
field :apprise_server, :string
|
||||||
|
|
||||||
|
field :video_codec_preference, {:array, :string}, default: []
|
||||||
|
field :audio_codec_preference, {:array, :string}, default: []
|
||||||
|
field :video_codec_preference_string, :string, default: nil, virtual: true
|
||||||
|
field :audio_codec_preference_string, :string, default: nil, virtual: true
|
||||||
end
|
end
|
||||||
|
|
||||||
@doc false
|
@doc false
|
||||||
def changeset(setting, attrs) do
|
def changeset(setting, attrs) do
|
||||||
setting
|
setting
|
||||||
|> cast(attrs, [:name, :value, :datatype])
|
|> cast(attrs, @allowed_fields)
|
||||||
|> validate_required([:name, :value, :datatype])
|
|> cast(attrs, @virtual_fields, empty_values: [])
|
||||||
|> unique_constraint([:name])
|
|> convert_codec_preference_strings()
|
||||||
|
|> validate_required(@required_fields)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp convert_codec_preference_strings(changeset) do
|
||||||
|
fields = [
|
||||||
|
video_codec_preference_string: :video_codec_preference,
|
||||||
|
audio_codec_preference_string: :audio_codec_preference
|
||||||
|
]
|
||||||
|
|
||||||
|
Enum.reduce(fields, changeset, fn {virtual_field, actual_field}, changeset ->
|
||||||
|
case get_change(changeset, virtual_field) do
|
||||||
|
nil ->
|
||||||
|
changeset
|
||||||
|
|
||||||
|
value ->
|
||||||
|
new_value =
|
||||||
|
value
|
||||||
|
|> String.split(">")
|
||||||
|
|> Enum.map(&String.trim/1)
|
||||||
|
|> Enum.reject(&(String.trim(&1) == ""))
|
||||||
|
|> Enum.map(&String.downcase/1)
|
||||||
|
|
||||||
|
put_change(changeset, actual_field, new_value)
|
||||||
|
end
|
||||||
|
end)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -0,0 +1,81 @@
|
|||||||
|
defmodule Pinchflat.Settings do
|
||||||
|
@moduledoc """
|
||||||
|
The Settings context.
|
||||||
|
"""
|
||||||
|
import Ecto.Query, warn: false
|
||||||
|
|
||||||
|
alias Pinchflat.Repo
|
||||||
|
alias Pinchflat.Settings.Setting
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Returns the only setting record. It _should_ be impossible
|
||||||
|
to create or delete this record, so it's assertive about
|
||||||
|
assuming it's the only one.
|
||||||
|
|
||||||
|
Returns %Setting{}
|
||||||
|
"""
|
||||||
|
def record do
|
||||||
|
Setting
|
||||||
|
|> limit(1)
|
||||||
|
|> Repo.one()
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Updates the setting record.
|
||||||
|
|
||||||
|
Returns {:ok, %Setting{}} | {:error, %Ecto.Changeset{}}
|
||||||
|
"""
|
||||||
|
def update_setting(%Setting{} = setting, attrs) do
|
||||||
|
setting
|
||||||
|
|> Setting.changeset(attrs)
|
||||||
|
|> Repo.update()
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Updates a setting, returning the new value.
|
||||||
|
Is setup to take a keyword list argument so you
|
||||||
|
can call it like `Settings.set(onboarding: true)`
|
||||||
|
|
||||||
|
Returns {:ok, value} | {:error, :invalid_key} | {:error, %Ecto.Changeset{}}
|
||||||
|
"""
|
||||||
|
def set([{attr, value}]) do
|
||||||
|
record()
|
||||||
|
|> update_setting(%{attr => value})
|
||||||
|
|> case do
|
||||||
|
{:ok, %{^attr => _}} -> {:ok, value}
|
||||||
|
{:ok, _} -> {:error, :invalid_key}
|
||||||
|
{:error, changeset} -> {:error, changeset}
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Gets the value of a setting.
|
||||||
|
|
||||||
|
Returns {:ok, value} | {:error, :invalid_key}
|
||||||
|
"""
|
||||||
|
def get(name) do
|
||||||
|
case Map.fetch(record(), name) do
|
||||||
|
{:ok, value} -> {:ok, value}
|
||||||
|
:error -> {:error, :invalid_key}
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Gets the value of a setting, raising if it doesn't exist.
|
||||||
|
|
||||||
|
Returns value
|
||||||
|
"""
|
||||||
|
def get!(name) do
|
||||||
|
case get(name) do
|
||||||
|
{:ok, value} -> value
|
||||||
|
{:error, _} -> raise "Setting `#{name}` not found"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Returns `%Ecto.Changeset{}`
|
||||||
|
"""
|
||||||
|
def change_setting(%Setting{} = setting, attrs \\ %{}) do
|
||||||
|
Setting.changeset(setting, attrs)
|
||||||
|
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,137 @@
|
|||||||
|
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", "show_in_dashboard"]
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias __MODULE__
|
||||||
|
alias Pinchflat.Tasks
|
||||||
|
alias Pinchflat.Sources
|
||||||
|
alias Pinchflat.Settings
|
||||||
|
alias Pinchflat.Sources.Source
|
||||||
|
alias Pinchflat.FastIndexing.FastIndexingWorker
|
||||||
|
alias Pinchflat.SlowIndexing.SlowIndexingHelpers
|
||||||
|
alias Pinchflat.Lifecycle.Notifications.SourceNotifications
|
||||||
|
|
||||||
|
@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, job_args \\ %{}, job_opts \\ []) do
|
||||||
|
%{id: source.id}
|
||||||
|
|> Map.merge(job_args)
|
||||||
|
|> MediaCollectionIndexingWorker.new(job_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 or if `force` is set to `true`, 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 runs and index and maybe kicks off media download jobs.
|
||||||
|
Check out `FastIndexingWorker` 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} = args}) 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
|
||||||
|
perform_indexing_and_notification(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
|
||||||
|
perform_indexing_and_notification(source)
|
||||||
|
:ok
|
||||||
|
|
||||||
|
_ ->
|
||||||
|
# If the source HAS been indexed and is not meant to reschedule,
|
||||||
|
# perform a no-op (unless forced)
|
||||||
|
if args["force"] do
|
||||||
|
perform_indexing_and_notification(source)
|
||||||
|
end
|
||||||
|
|
||||||
|
: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 perform_indexing_and_notification(source) do
|
||||||
|
apprise_server = Settings.get!(:apprise_server)
|
||||||
|
|
||||||
|
SourceNotifications.wrap_new_media_notification(apprise_server, source, fn ->
|
||||||
|
SlowIndexingHelpers.index_and_enqueue_download_for_media_items(source)
|
||||||
|
end)
|
||||||
|
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,134 @@
|
|||||||
|
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.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, job_args \\ %{}, job_opts \\ []) do
|
||||||
|
Tasks.delete_pending_tasks_for(source, "FastIndexingWorker")
|
||||||
|
Tasks.delete_pending_tasks_for(source, "MediaCollectionIndexingWorker")
|
||||||
|
|
||||||
|
MediaCollectionIndexingWorker.kickoff_with_task(source, job_args, job_opts)
|
||||||
|
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} = setup_file_watcher_and_kickoff_indexing(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 `setup_file_watcher_and_kickoff_indexing` 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 setup_file_watcher_and_kickoff_indexing(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} ->
|
||||||
|
DownloadingHelpers.kickoff_download_if_pending(media_item)
|
||||||
|
|
||||||
|
{: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,152 @@
|
|||||||
|
defmodule Pinchflat.Sources.Source do
|
||||||
|
@moduledoc """
|
||||||
|
The Source schema.
|
||||||
|
"""
|
||||||
|
|
||||||
|
use Ecto.Schema
|
||||||
|
import Ecto.Changeset
|
||||||
|
import Pinchflat.Utils.ChangesetUtils
|
||||||
|
|
||||||
|
alias __MODULE__
|
||||||
|
alias Pinchflat.Repo
|
||||||
|
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
|
||||||
|
description
|
||||||
|
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
|
||||||
|
retention_period_days
|
||||||
|
title_filter_regex
|
||||||
|
media_profile_id
|
||||||
|
output_path_template_override
|
||||||
|
)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(
|
||||||
|
uuid
|
||||||
|
custom_name
|
||||||
|
collection_name
|
||||||
|
collection_id
|
||||||
|
collection_type
|
||||||
|
)a
|
||||||
|
|
||||||
|
schema "sources" do
|
||||||
|
# This is _not_ used as the primary key or internally in the database
|
||||||
|
# relations. This is only used to prevent an enumeration attack on the streaming
|
||||||
|
# and RSS feed endpoints since those _must_ be public (ie: no basic auth)
|
||||||
|
field :uuid, Ecto.UUID
|
||||||
|
|
||||||
|
field :custom_name, :string
|
||||||
|
field :description, :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 :retention_period_days, :integer
|
||||||
|
field :original_url, :string
|
||||||
|
field :title_filter_regex, :string
|
||||||
|
field :output_path_template_override, :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)
|
||||||
|
|> dynamic_default(:uuid, fn _ -> Ecto.UUID.generate() end)
|
||||||
|
|> validate_required(required_fields)
|
||||||
|
|> validate_number(:retention_period_days, greater_than_or_equal_to: 0)
|
||||||
|
# Ensures it ends with `.{{ ext }}` or `.%(ext)s` or similar (with a little wiggle room)
|
||||||
|
|> validate_format(:output_path_template_override, MediaProfile.ext_regex(), message: "must end with .{{ ext }}")
|
||||||
|
|> cast_assoc(:metadata, with: &SourceMetadata.changeset/2, required: false)
|
||||||
|
|> unique_constraint([:collection_id, :media_profile_id, :title_filter_regex], error_key: :original_url)
|
||||||
|
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
|
||||||
|
|
||||||
|
@doc false
|
||||||
|
def json_exluded_fields do
|
||||||
|
~w(__meta__ __struct__ metadata tasks media_items)a
|
||||||
|
end
|
||||||
|
|
||||||
|
defimpl Jason.Encoder, for: Source do
|
||||||
|
def encode(value, opts) do
|
||||||
|
value
|
||||||
|
|> Repo.preload(:media_profile)
|
||||||
|
|> Map.drop(Source.json_exluded_fields())
|
||||||
|
|> Jason.Encode.map(opts)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,322 @@
|
|||||||
|
defmodule Pinchflat.Sources do
|
||||||
|
@moduledoc """
|
||||||
|
The Sources context.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import Ecto.Query, warn: false
|
||||||
|
use Pinchflat.Media.MediaQuery
|
||||||
|
|
||||||
|
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.Utils.FilesystemUtils
|
||||||
|
alias Pinchflat.Downloading.DownloadingHelpers
|
||||||
|
alias Pinchflat.FastIndexing.FastIndexingWorker
|
||||||
|
alias Pinchflat.SlowIndexing.SlowIndexingHelpers
|
||||||
|
alias Pinchflat.Metadata.SourceMetadataStorageWorker
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Returns the relevant output path template for a source.
|
||||||
|
Pulls from the source's override if present, otherwise uses the media profile's.
|
||||||
|
|
||||||
|
Returns binary()
|
||||||
|
"""
|
||||||
|
def output_path_template(source) do
|
||||||
|
source = Repo.preload(source, :media_profile)
|
||||||
|
media_profile = source.media_profile
|
||||||
|
|
||||||
|
source.output_path_template_override || media_profile.output_path_template
|
||||||
|
end
|
||||||
|
|
||||||
|
@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)
|
||||||
|
|
||||||
|
MediaQuery.new()
|
||||||
|
|> where(^MediaQuery.for_source(source))
|
||||||
|
|> Repo.all()
|
||||||
|
|> 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(&FilesystemUtils.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(&FilesystemUtils.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)
|
||||||
|
maybe_run_metadata_storage_task(changeset, 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
|
||||||
|
|
||||||
|
defp maybe_run_metadata_storage_task(changeset, source) do
|
||||||
|
case {changeset.data, changeset.changes} do
|
||||||
|
# If the changeset is new (not persisted), fetch metadata no matter what
|
||||||
|
{%{__meta__: %{state: :built}}, _} ->
|
||||||
|
SourceMetadataStorageWorker.kickoff_with_task(source)
|
||||||
|
|
||||||
|
# If the record has been persisted, only fetch metadata if the
|
||||||
|
# original_url has changed
|
||||||
|
{_, %{original_url: _}} ->
|
||||||
|
SourceMetadataStorageWorker.kickoff_with_task(source)
|
||||||
|
|
||||||
|
_ ->
|
||||||
|
:ok
|
||||||
|
end
|
||||||
|
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, "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
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
defmodule Pinchflat.Sources.SourcesQuery do
|
||||||
|
@moduledoc """
|
||||||
|
Query helpers for the Sources context.
|
||||||
|
|
||||||
|
These methods are made to be one-ish liners used
|
||||||
|
to compose queries. Each method should strive to do
|
||||||
|
_one_ thing. These don't need to be tested as
|
||||||
|
they are just building blocks for other functionality
|
||||||
|
which, itself, will be tested.
|
||||||
|
"""
|
||||||
|
import Ecto.Query, warn: false
|
||||||
|
|
||||||
|
alias Pinchflat.Sources.Source
|
||||||
|
|
||||||
|
# This allows the module to be aliased and query methods to be used
|
||||||
|
# all in one go
|
||||||
|
# usage: use Pinchflat.Sources.SourcesQuery
|
||||||
|
defmacro __using__(_opts) do
|
||||||
|
quote do
|
||||||
|
import Ecto.Query, warn: false
|
||||||
|
|
||||||
|
alias unquote(__MODULE__)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def new do
|
||||||
|
Source
|
||||||
|
end
|
||||||
|
|
||||||
|
def for_media_profile(media_profile_id) when is_integer(media_profile_id) do
|
||||||
|
dynamic([s], s.media_profile_id == ^media_profile_id)
|
||||||
|
end
|
||||||
|
|
||||||
|
def for_media_profile(media_profile) do
|
||||||
|
dynamic([s], s.media_profile_id == ^media_profile.id)
|
||||||
|
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 """
|
||||||
@@ -0,0 +1,45 @@
|
|||||||
|
defmodule Pinchflat.Tasks.TasksQuery do
|
||||||
|
@moduledoc """
|
||||||
|
Query helpers for the Tasks context.
|
||||||
|
|
||||||
|
These methods are made to be one-ish liners used
|
||||||
|
to compose queries. Each method should strive to do
|
||||||
|
_one_ thing. These don't need to be tested as
|
||||||
|
they are just building blocks for other functionality
|
||||||
|
which, itself, will be tested.
|
||||||
|
"""
|
||||||
|
import Ecto.Query, warn: false
|
||||||
|
|
||||||
|
alias Pinchflat.Tasks.Task
|
||||||
|
|
||||||
|
# This allows the module to be aliased and query methods to be used
|
||||||
|
# all in one go
|
||||||
|
# usage: use Pinchflat.Tasks.TasksQuery
|
||||||
|
defmacro __using__(_opts) do
|
||||||
|
quote do
|
||||||
|
import Ecto.Query, warn: false
|
||||||
|
|
||||||
|
alias unquote(__MODULE__)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def new do
|
||||||
|
Task
|
||||||
|
end
|
||||||
|
|
||||||
|
def join_job(query) do
|
||||||
|
query
|
||||||
|
|> join(:left, [t], j in assoc(t, :job))
|
||||||
|
|> preload([t, j], job: j)
|
||||||
|
end
|
||||||
|
|
||||||
|
def in_state(states) when is_list(states) do
|
||||||
|
dynamic([t, j], j.state in ^states)
|
||||||
|
end
|
||||||
|
|
||||||
|
def in_state(state), do: in_state([state])
|
||||||
|
|
||||||
|
def has_tag(tag) do
|
||||||
|
dynamic([t, j], ^tag in j.tags)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,94 @@
|
|||||||
|
defmodule Pinchflat.Utils.CliUtils do
|
||||||
|
@moduledoc """
|
||||||
|
Utility methods for working with CLI executables
|
||||||
|
"""
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias Pinchflat.Utils.StringUtils
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Wraps a command in a shell script that will terminate
|
||||||
|
the command if stdin is closed. Useful for stopping
|
||||||
|
commands if the job runner is cancelled.
|
||||||
|
|
||||||
|
Delegates to `System.cmd/3` and any options/output
|
||||||
|
are passed through. Custom options can be passed in.
|
||||||
|
|
||||||
|
Custom options:
|
||||||
|
- logging_arg_override: if set, the passed value will be logged in place of
|
||||||
|
the actual arguments passed to the command
|
||||||
|
|
||||||
|
Returns {binary(), integer()}
|
||||||
|
"""
|
||||||
|
def wrap_cmd(command, args, passthrough_opts \\ [], opts \\ []) do
|
||||||
|
wrapper_command = Path.join(:code.priv_dir(:pinchflat), "cmd_wrapper.sh")
|
||||||
|
actual_command = [command] ++ args
|
||||||
|
command_opts = set_command_opts() ++ passthrough_opts
|
||||||
|
logging_arg_override = Keyword.get(opts, :logging_arg_override, Enum.join(args, " "))
|
||||||
|
|
||||||
|
Logger.info("[command_wrapper]: #{command} called with: #{logging_arg_override}")
|
||||||
|
|
||||||
|
{output, status} = System.cmd(wrapper_command, actual_command, command_opts)
|
||||||
|
log_cmd_result(command, logging_arg_override, status, output)
|
||||||
|
|
||||||
|
{output, status}
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Parses a list of command options into a list of strings suitable for passing to
|
||||||
|
`System.cmd/3`.
|
||||||
|
|
||||||
|
We want to satisfy the following behaviours:
|
||||||
|
1. If the key is an atom, convert it to a string and convert it to kebab case (for convenience)
|
||||||
|
2. If the key is a string, assume we want it as-is and don't convert it
|
||||||
|
3. If the key is accompanied by a value, append the value to the list
|
||||||
|
4. If the key is not accompanied by a value, assume it's a flag and PREpend it to the list
|
||||||
|
|
||||||
|
Returns [binary()]
|
||||||
|
"""
|
||||||
|
def parse_options(command_opts) do
|
||||||
|
command_opts
|
||||||
|
|> List.wrap()
|
||||||
|
|> Enum.reduce([], &parse_option/2)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp parse_option({k, v}, acc) when is_atom(k) do
|
||||||
|
stringified_key = StringUtils.to_kebab_case(Atom.to_string(k))
|
||||||
|
|
||||||
|
parse_option({"--#{stringified_key}", v}, acc)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp parse_option({k, v}, acc) when is_binary(k) do
|
||||||
|
acc ++ [k, to_string(v)]
|
||||||
|
end
|
||||||
|
|
||||||
|
defp parse_option(arg, acc) when is_atom(arg) do
|
||||||
|
stringified_arg =
|
||||||
|
arg
|
||||||
|
|> Atom.to_string()
|
||||||
|
|> StringUtils.to_kebab_case()
|
||||||
|
|
||||||
|
parse_option("--#{stringified_arg}", acc)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp parse_option(arg, acc) when is_binary(arg) do
|
||||||
|
acc ++ [arg]
|
||||||
|
end
|
||||||
|
|
||||||
|
defp log_cmd_result(command, logging_arg_override, status, output) do
|
||||||
|
log_message = "[command_wrapper]: #{command} called with: #{logging_arg_override} exited: #{status} with: #{output}"
|
||||||
|
log_level = if status == 0, do: :debug, else: :error
|
||||||
|
|
||||||
|
Logger.log(log_level, log_message)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp set_command_opts do
|
||||||
|
# This resolves an issue where yt-dlp would attempt to write to a read-only directory
|
||||||
|
# if you scanned a new video with `--windows-filenames` enabled. Hopefully can be removed
|
||||||
|
# in the future.
|
||||||
|
[
|
||||||
|
cd: Application.get_env(:pinchflat, :tmpfile_directory)
|
||||||
|
]
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
defmodule Pinchflat.Utils.DatetimeUtils do
|
||||||
|
@moduledoc """
|
||||||
|
Utility methods for working with dates and datetimes
|
||||||
|
"""
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Converts a Date to a DateTime
|
||||||
|
|
||||||
|
Returns %DateTime{}
|
||||||
|
"""
|
||||||
|
def date_to_datetime(date) do
|
||||||
|
date
|
||||||
|
|> Date.to_gregorian_days()
|
||||||
|
|> Kernel.*(86_400)
|
||||||
|
|> DateTime.from_gregorian_seconds()
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -2,9 +2,24 @@ defmodule Pinchflat.Utils.FilesystemUtils do
|
|||||||
@moduledoc """
|
@moduledoc """
|
||||||
Utility methods for working with the filesystem
|
Utility methods for working with the filesystem
|
||||||
"""
|
"""
|
||||||
|
alias Pinchflat.Media
|
||||||
alias Pinchflat.Utils.StringUtils
|
alias Pinchflat.Utils.StringUtils
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Checks if a file exists and has non-whitespace contents.
|
||||||
|
|
||||||
|
Returns boolean()
|
||||||
|
"""
|
||||||
|
def exists_and_nonempty?(filepath) do
|
||||||
|
case File.read(filepath) do
|
||||||
|
{:ok, contents} ->
|
||||||
|
String.trim(contents) != ""
|
||||||
|
|
||||||
|
_ ->
|
||||||
|
false
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Generates a temporary file and returns its path. The file is empty and has the given type.
|
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.
|
Generates all the directories in the path if they don't exist.
|
||||||
@@ -15,9 +30,93 @@ defmodule Pinchflat.Utils.FilesystemUtils do
|
|||||||
tmpfile_directory = Application.get_env(:pinchflat, :tmpfile_directory)
|
tmpfile_directory = Application.get_env(:pinchflat, :tmpfile_directory)
|
||||||
filepath = Path.join([tmpfile_directory, "#{StringUtils.random_string(64)}.#{type}"])
|
filepath = Path.join([tmpfile_directory, "#{StringUtils.random_string(64)}.#{type}"])
|
||||||
|
|
||||||
:ok = File.mkdir_p!(Path.dirname(filepath))
|
:ok = write_p!(filepath, "")
|
||||||
:ok = File.write(filepath, "")
|
|
||||||
|
|
||||||
filepath
|
filepath
|
||||||
end
|
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
|
end
|
||||||
|
|||||||
@@ -0,0 +1,16 @@
|
|||||||
|
defmodule Pinchflat.Utils.NumberUtils do
|
||||||
|
@moduledoc """
|
||||||
|
Utility methods for working with numbers
|
||||||
|
"""
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Clamps a number between a minimum and maximum value
|
||||||
|
|
||||||
|
Returns integer() | float()
|
||||||
|
"""
|
||||||
|
def clamp(num, minimum, maximum) do
|
||||||
|
num
|
||||||
|
|> max(minimum)
|
||||||
|
|> min(maximum)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
defmodule Pinchflat.Utils.XmlUtils do
|
||||||
|
@moduledoc """
|
||||||
|
Utility methods for working with XML documents
|
||||||
|
"""
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Escapes invalid XML characters in a string
|
||||||
|
|
||||||
|
Returns binary()
|
||||||
|
"""
|
||||||
|
def safe(value) do
|
||||||
|
value
|
||||||
|
|> to_string()
|
||||||
|
|> Phoenix.HTML.html_escape()
|
||||||
|
|> Phoenix.HTML.safe_to_string()
|
||||||
|
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,57 +0,0 @@
|
|||||||
defmodule Pinchflat.Workers.MediaDownloadWorker do
|
|
||||||
@moduledoc false
|
|
||||||
|
|
||||||
use Oban.Worker,
|
|
||||||
queue: :media_fetching,
|
|
||||||
unique: [period: :infinity, states: [:available, :scheduled, :retryable, :executing]],
|
|
||||||
tags: ["media_item", "media_fetching"]
|
|
||||||
|
|
||||||
alias Pinchflat.Repo
|
|
||||||
alias Pinchflat.Media
|
|
||||||
alias Pinchflat.Tasks
|
|
||||||
alias Pinchflat.MediaClient.MediaDownloader
|
|
||||||
alias Pinchflat.Workers.FilesystemDataWorker
|
|
||||||
|
|
||||||
@impl Oban.Worker
|
|
||||||
@doc """
|
|
||||||
For a given media item, download the media alongside any options.
|
|
||||||
Does not download media if its source is set to not download media.
|
|
||||||
|
|
||||||
Returns :ok | {:ok, %MediaItem{}} | {:error, any, ...any}
|
|
||||||
"""
|
|
||||||
def perform(%Oban.Job{args: %{"id" => media_item_id}}) do
|
|
||||||
media_item =
|
|
||||||
media_item_id
|
|
||||||
|> Media.get_media_item!()
|
|
||||||
|> Repo.preload(:source)
|
|
||||||
|
|
||||||
# If the source is set to not download media, perform a no-op
|
|
||||||
if media_item.source.download_media do
|
|
||||||
download_media_and_schedule_jobs(media_item)
|
|
||||||
else
|
|
||||||
:ok
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
defp download_media_and_schedule_jobs(media_item) do
|
|
||||||
case MediaDownloader.download_for_media_item(media_item) do
|
|
||||||
{:ok, _} ->
|
|
||||||
schedule_filesystem_data_worker(media_item)
|
|
||||||
{:ok, media_item}
|
|
||||||
|
|
||||||
err ->
|
|
||||||
err
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
defp schedule_filesystem_data_worker(media_item) do
|
|
||||||
media_item
|
|
||||||
|> Map.take([:id])
|
|
||||||
|> FilesystemDataWorker.new()
|
|
||||||
|> Tasks.create_job_with_task(media_item)
|
|
||||||
|> case do
|
|
||||||
{:ok, task} -> {:ok, task}
|
|
||||||
{:error, :duplicate_job} -> {:ok, :job_exists}
|
|
||||||
end
|
|
||||||
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
|
|
||||||
@@ -0,0 +1,99 @@
|
|||||||
|
defmodule Pinchflat.YtDlp.CommandRunner do
|
||||||
|
@moduledoc """
|
||||||
|
Runs yt-dlp commands using the `System.cmd/3` function
|
||||||
|
"""
|
||||||
|
|
||||||
|
alias Pinchflat.Utils.CliUtils
|
||||||
|
alias Pinchflat.YtDlp.YtDlpCommandRunner
|
||||||
|
alias Pinchflat.Utils.FilesystemUtils, as: FSUtils
|
||||||
|
|
||||||
|
@behaviour YtDlpCommandRunner
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Runs a yt-dlp command and returns the string output. Saves the output to
|
||||||
|
a file and then returns its contents because yt-dlp will return warnings
|
||||||
|
to stdout even if the command is successful, but these will break JSON parsing.
|
||||||
|
|
||||||
|
Additional Opts:
|
||||||
|
- :output_filepath - the path to save the output to. If not provided, a temporary
|
||||||
|
file will be created and used. Useful for if you need a reference to the file
|
||||||
|
for a file watcher.
|
||||||
|
|
||||||
|
Returns {:ok, binary()} | {:error, output, status}.
|
||||||
|
"""
|
||||||
|
@impl YtDlpCommandRunner
|
||||||
|
def run(url, command_opts, output_template, addl_opts \\ []) do
|
||||||
|
# This approach lets us mock the command for testing
|
||||||
|
command = backend_executable()
|
||||||
|
|
||||||
|
output_filepath = generate_output_filepath(addl_opts)
|
||||||
|
print_to_file_opts = [{:print_to_file, output_template}, output_filepath]
|
||||||
|
user_configured_opts = cookie_file_options()
|
||||||
|
# These must stay in exactly this order, hence why I'm giving it its own variable.
|
||||||
|
all_opts = command_opts ++ print_to_file_opts ++ user_configured_opts ++ global_options()
|
||||||
|
formatted_command_opts = [url] ++ CliUtils.parse_options(all_opts)
|
||||||
|
|
||||||
|
case CliUtils.wrap_cmd(command, formatted_command_opts, stderr_to_stdout: true) do
|
||||||
|
{_, 0} ->
|
||||||
|
# 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?)
|
||||||
|
File.read(output_filepath)
|
||||||
|
|
||||||
|
{output, status} ->
|
||||||
|
{:error, output, status}
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Returns the version of yt-dlp as a string
|
||||||
|
|
||||||
|
Returns {:ok, binary()} | {:error, binary()}
|
||||||
|
"""
|
||||||
|
@impl YtDlpCommandRunner
|
||||||
|
def version do
|
||||||
|
command = backend_executable()
|
||||||
|
|
||||||
|
case CliUtils.wrap_cmd(command, ["--version"]) do
|
||||||
|
{output, 0} ->
|
||||||
|
{:ok, String.trim(output)}
|
||||||
|
|
||||||
|
{output, _} ->
|
||||||
|
{:error, output}
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp generate_output_filepath(addl_opts) do
|
||||||
|
case Keyword.get(addl_opts, :output_filepath) do
|
||||||
|
nil -> FSUtils.generate_metadata_tmpfile(:json)
|
||||||
|
path -> path
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp global_options do
|
||||||
|
[
|
||||||
|
:windows_filenames,
|
||||||
|
:quiet,
|
||||||
|
cache_dir: Path.join(Application.get_env(:pinchflat, :tmpfile_directory), "yt-dlp-cache")
|
||||||
|
]
|
||||||
|
end
|
||||||
|
|
||||||
|
defp cookie_file_options do
|
||||||
|
base_dir = Application.get_env(:pinchflat, :extras_directory)
|
||||||
|
filename_options_map = %{cookies: "cookies.txt"}
|
||||||
|
|
||||||
|
Enum.reduce(filename_options_map, [], fn {opt_name, filename}, acc ->
|
||||||
|
filepath = Path.join(base_dir, filename)
|
||||||
|
|
||||||
|
if FSUtils.exists_and_nonempty?(filepath) do
|
||||||
|
[{opt_name, filepath} | acc]
|
||||||
|
else
|
||||||
|
acc
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp backend_executable do
|
||||||
|
Application.get_env(:pinchflat, :yt_dlp_executable)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,117 @@
|
|||||||
|
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,
|
||||||
|
:duration_seconds
|
||||||
|
]
|
||||||
|
|
||||||
|
defstruct [
|
||||||
|
:media_id,
|
||||||
|
:title,
|
||||||
|
:description,
|
||||||
|
:original_url,
|
||||||
|
:livestream,
|
||||||
|
:short_form_content,
|
||||||
|
:upload_date,
|
||||||
|
:duration_seconds
|
||||||
|
]
|
||||||
|
|
||||||
|
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 \\ [], addl_opts \\ []) do
|
||||||
|
opts = [:no_simulate] ++ command_opts
|
||||||
|
|
||||||
|
with {:ok, output} <- backend_runner().run(url, opts, "after_move:%()j", addl_opts),
|
||||||
|
{: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()
|
||||||
|
|
||||||
|
err ->
|
||||||
|
err
|
||||||
|
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"],
|
||||||
|
duration_seconds: response["duration"] && round(response["duration"]),
|
||||||
|
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,134 @@
|
|||||||
|
defmodule Pinchflat.YtDlp.MediaCollection do
|
||||||
|
@moduledoc """
|
||||||
|
Contains utilities for working with collections of
|
||||||
|
media (aka: a source [ie: channels, playlists]).
|
||||||
|
"""
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias Pinchflat.Utils.FilesystemUtils
|
||||||
|
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, :no_warnings]
|
||||||
|
output_template = YtDlpMedia.indexing_output_template()
|
||||||
|
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} ->
|
||||||
|
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))}
|
||||||
|
|
||||||
|
err ->
|
||||||
|
err
|
||||||
|
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
|
||||||
|
default_opts = [
|
||||||
|
:simulate,
|
||||||
|
:skip_download,
|
||||||
|
:ignore_no_formats_error,
|
||||||
|
playlist_end: 1
|
||||||
|
]
|
||||||
|
|
||||||
|
command_opts = default_opts ++ 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
|
||||||
+6
-2
@@ -1,8 +1,12 @@
|
|||||||
defmodule Pinchflat.MediaClient.Backends.BackendCommandRunner do
|
defmodule Pinchflat.YtDlp.YtDlpCommandRunner 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()}
|
||||||
@callback run(binary(), keyword(), binary(), keyword()) :: {:ok, binary()} | {:error, binary(), integer()}
|
@callback run(binary(), keyword(), binary(), keyword()) :: {:ok, binary()} | {:error, binary(), integer()}
|
||||||
|
@callback version() :: {:ok, binary()} | {:error, binary()}
|
||||||
end
|
end
|
||||||
@@ -21,7 +21,7 @@ defmodule PinchflatWeb do
|
|||||||
|
|
||||||
def router do
|
def router do
|
||||||
quote do
|
quote do
|
||||||
use Phoenix.Router, helpers: false
|
use Phoenix.Router, helpers: true
|
||||||
|
|
||||||
# Import common connection and controller functions to use in pipelines
|
# Import common connection and controller functions to use in pipelines
|
||||||
import Plug.Conn
|
import Plug.Conn
|
||||||
@@ -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,
|
||||||
|
|||||||
@@ -14,12 +14,11 @@ defmodule PinchflatWeb.CoreComponents do
|
|||||||
|
|
||||||
Icons are provided by [heroicons](https://heroicons.com). See `icon/1` for usage.
|
Icons are provided by [heroicons](https://heroicons.com). See `icon/1` for usage.
|
||||||
"""
|
"""
|
||||||
use Phoenix.Component
|
use Phoenix.Component, global_prefixes: ~w(x-)
|
||||||
|
|
||||||
import PinchflatWeb.Gettext
|
import PinchflatWeb.Gettext
|
||||||
|
|
||||||
alias Phoenix.LiveView.JS
|
alias Phoenix.LiveView.JS
|
||||||
alias PinchflatWeb.CustomComponents.TextComponents
|
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Renders a modal.
|
Renders a modal.
|
||||||
@@ -40,6 +39,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 +50,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 +62,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,13 +243,15 @@ 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
|
||||||
|
attr :html_help, :boolean, default: false
|
||||||
|
|
||||||
attr :type, :string,
|
attr :type, :string,
|
||||||
default: "text",
|
default: "text",
|
||||||
values: ~w(checkbox color date datetime-local email file hidden month number password
|
values: ~w(checkbox color date datetime-local email file hidden month number password
|
||||||
toggle range radio search select tel text textarea time url week)
|
checkbox_group toggle range radio search select tel text textarea time url week)
|
||||||
|
|
||||||
attr :field, Phoenix.HTML.FormField, doc: "a form field struct retrieved from the form, for example: @form[:email]"
|
attr :field, Phoenix.HTML.FormField, doc: "a form field struct retrieved from the form, for example: @form[:email]"
|
||||||
|
|
||||||
@@ -264,6 +266,7 @@ defmodule PinchflatWeb.CoreComponents do
|
|||||||
multiple pattern placeholder readonly required rows size step)
|
multiple pattern placeholder readonly required rows size step)
|
||||||
|
|
||||||
slot :inner_block
|
slot :inner_block
|
||||||
|
slot :input_append
|
||||||
|
|
||||||
def input(%{field: %Phoenix.HTML.FormField{} = field} = assigns) do
|
def input(%{field: %Phoenix.HTML.FormField{} = field} = assigns) do
|
||||||
assigns
|
assigns
|
||||||
@@ -294,8 +297,36 @@ 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}><%= if @html_help, do: Phoenix.HTML.raw(@help), else: @help %></.help>
|
||||||
|
<.error :for={msg <- @errors}><%= msg %></.error>
|
||||||
|
</div>
|
||||||
|
"""
|
||||||
|
end
|
||||||
|
|
||||||
|
def input(%{type: "checkbox_group"} = assigns) do
|
||||||
|
~H"""
|
||||||
|
<div phx-feedback-for={@name}>
|
||||||
|
<.label for={@id}>
|
||||||
|
<%= @label %><span :if={@label_suffix} class="text-xs text-bodydark"><%= @label_suffix %></span>
|
||||||
|
</.label>
|
||||||
|
<section class="grid grid-cols-1 gap-2 md:grid-cols-2 max-w-prose mb-4 ml-1">
|
||||||
|
<div :for={{option_name, option_value} <- @options} class="flex items-center">
|
||||||
|
<input
|
||||||
|
type="checkbox"
|
||||||
|
id={"#{@id}-#{option_value}"}
|
||||||
|
name={"#{@name}[]"}
|
||||||
|
value={option_value}
|
||||||
|
checked={option_value in @value}
|
||||||
|
class={["rounded focus:ring-offset-0 ring-offset-0 focus:ring-0 h-5 w-5 ", @inputclass]}
|
||||||
|
/>
|
||||||
|
<label for={"#{@id}-#{option_value}"} class="ml-2 cursor-pointer select-none">
|
||||||
|
<%= option_name %>
|
||||||
|
</label>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
<.help :if={@help}><%= if @html_help, do: Phoenix.HTML.raw(@help), else: @help %></.help>
|
||||||
<.error :for={msg <- @errors}><%= msg %></.error>
|
<.error :for={msg <- @errors}><%= msg %></.error>
|
||||||
</div>
|
</div>
|
||||||
"""
|
"""
|
||||||
@@ -309,19 +340,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
|
||||||
@@ -333,7 +357,7 @@ defmodule PinchflatWeb.CoreComponents do
|
|||||||
>
|
>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<.help :if={@help}><%= @help %></.help>
|
<.help :if={@help}><%= if @html_help, do: Phoenix.HTML.raw(@help), else: @help %></.help>
|
||||||
<.error :for={msg <- @errors}><%= msg %></.error>
|
<.error :for={msg <- @errors}><%= msg %></.error>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
@@ -343,22 +367,28 @@ 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-form-strokedark py-3 pl-5 pr-12 outline-none transition",
|
||||||
multiple={@multiple}
|
"focus:border-primary active:border-primary bg-form-input text-black text-white",
|
||||||
{@rest}
|
"disabled:text-opacity-50 disabled:cursor-not-allowed disabled:border-black",
|
||||||
>
|
@inputclass
|
||||||
<option :if={@prompt} value=""><%= @prompt %></option>
|
]}
|
||||||
<%= Phoenix.HTML.Form.options_for_select(@options, @value) %>
|
multiple={@multiple}
|
||||||
</select>
|
{@rest}
|
||||||
<.help :if={@help}><%= @help %></.help>
|
>
|
||||||
|
<option :if={@prompt} value=""><%= @prompt %></option>
|
||||||
|
<%= Phoenix.HTML.Form.options_for_select(@options, @value) %>
|
||||||
|
</select>
|
||||||
|
<%= render_slot(@inner_block) %>
|
||||||
|
</div>
|
||||||
|
<.help :if={@help}><%= if @html_help, do: Phoenix.HTML.raw(@help), else: @help %></.help>
|
||||||
<.error :for={msg <- @errors}><%= msg %></.error>
|
<.error :for={msg <- @errors}><%= msg %></.error>
|
||||||
</div>
|
</div>
|
||||||
"""
|
"""
|
||||||
@@ -367,7 +397,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}
|
||||||
@@ -380,7 +412,7 @@ defmodule PinchflatWeb.CoreComponents do
|
|||||||
]}
|
]}
|
||||||
{@rest}
|
{@rest}
|
||||||
><%= Phoenix.HTML.Form.normalize_value("textarea", @value) %></textarea>
|
><%= Phoenix.HTML.Form.normalize_value("textarea", @value) %></textarea>
|
||||||
<.help :if={@help}><%= @help %></.help>
|
<.help :if={@help}><%= if @html_help, do: Phoenix.HTML.raw(@help), else: @help %></.help>
|
||||||
<.error :for={msg <- @errors}><%= msg %></.error>
|
<.error :for={msg <- @errors}><%= msg %></.error>
|
||||||
</div>
|
</div>
|
||||||
"""
|
"""
|
||||||
@@ -390,22 +422,27 @@ 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}>
|
||||||
<input
|
<%= @label %><span :if={@label_suffix} class="text-xs text-bodydark"><%= @label_suffix %></span>
|
||||||
type={@type}
|
</.label>
|
||||||
name={@name}
|
<div class="flex items-center">
|
||||||
id={@id}
|
<input
|
||||||
value={Phoenix.HTML.Form.normalize_value(@type, @value)}
|
type={@type}
|
||||||
class={[
|
name={@name}
|
||||||
"w-full rounded-lg border-[1.5px] border-stroke bg-transparent px-5 py-3 font-normal text-black",
|
id={@id}
|
||||||
"outline-none transition focus:border-primary active:border-primary disabled:cursor-default disabled:bg-whiter",
|
value={Phoenix.HTML.Form.normalize_value(@type, @value)}
|
||||||
"dark:border-form-strokedark dark:bg-form-input dark:text-white dark:focus:border-primary",
|
class={[
|
||||||
@inputclass,
|
"w-full rounded-lg border-[1.5px] px-5 py-3 font-normal border-form-strokedark bg-form-input",
|
||||||
@errors != [] && "border-rose-400 focus:border-rose-400"
|
"outline-none transition active:border-primary disabled:cursor-default disabled:bg-whiter",
|
||||||
]}
|
"text-white focus:border-primary",
|
||||||
{@rest}
|
@inputclass,
|
||||||
/>
|
@errors != [] && "border-rose-400 focus:border-rose-400"
|
||||||
<.help :if={@help}><%= @help %></.help>
|
]}
|
||||||
|
{@rest}
|
||||||
|
/>
|
||||||
|
<%= render_slot(@input_append) %>
|
||||||
|
</div>
|
||||||
|
<.help :if={@help}><%= if @html_help, do: Phoenix.HTML.raw(@help), else: @help %></.help>
|
||||||
<.error :for={msg <- @errors}><%= msg %></.error>
|
<.error :for={msg <- @errors}><%= msg %></.error>
|
||||||
</div>
|
</div>
|
||||||
"""
|
"""
|
||||||
@@ -586,18 +623,29 @@ 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)
|
||||||
|
|> Enum.map(fn
|
||||||
|
{k, v} when is_list(v) -> {k, Enum.join(v, ", ")}
|
||||||
|
rest -> rest
|
||||||
end)
|
end)
|
||||||
|
|
||||||
assigns = assign(assigns, iterable_attributes: attrs)
|
assigns = assign(assigns, iterable_attributes: attrs)
|
||||||
|
|
||||||
~H"""
|
~H"""
|
||||||
<ul>
|
<ul>
|
||||||
<li :for={{k, v} <- @iterable_attributes} class="mb-2">
|
<li :for={{k, v} <- @iterable_attributes} class="mb-2 w-2/3">
|
||||||
<strong><%= k %>:</strong>
|
<strong><%= k %>:</strong>
|
||||||
<TextComponents.inline_code><%= v %></TextComponents.inline_code>
|
<code class="inline-block text-sm font-mono text-gray p-0.5 mx-0.5">
|
||||||
|
<%= v %>
|
||||||
|
</code>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
"""
|
"""
|
||||||
@@ -608,15 +656,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>
|
||||||
@@ -644,10 +692,11 @@ defmodule PinchflatWeb.CoreComponents do
|
|||||||
"""
|
"""
|
||||||
attr :name, :string, required: true
|
attr :name, :string, required: true
|
||||||
attr :class, :string, default: nil
|
attr :class, :string, default: nil
|
||||||
|
attr :rest, :global
|
||||||
|
|
||||||
def icon(%{name: "hero-" <> _} = assigns) do
|
def icon(%{name: "hero-" <> _} = assigns) do
|
||||||
~H"""
|
~H"""
|
||||||
<span class={[@name, @class]} />
|
<span class={[@name, @class]} {@rest} />
|
||||||
"""
|
"""
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -685,7 +734,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 +745,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 """
|
||||||
|
|||||||
@@ -1,6 +1,8 @@
|
|||||||
defmodule PinchflatWeb.CustomComponents.ButtonComponents do
|
defmodule PinchflatWeb.CustomComponents.ButtonComponents do
|
||||||
@moduledoc false
|
@moduledoc false
|
||||||
use Phoenix.Component
|
use Phoenix.Component, global_prefixes: ~w(x-)
|
||||||
|
|
||||||
|
alias PinchflatWeb.CoreComponents
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Render a button
|
Render a button
|
||||||
@@ -14,7 +16,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,12 +30,105 @@ 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>
|
||||||
"""
|
"""
|
||||||
end
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Render a dropdown based off a button
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
<.button_dropdown text="Actions">
|
||||||
|
<:option>TEST</:option>
|
||||||
|
</.button_dropdown>
|
||||||
|
"""
|
||||||
|
attr :text, :string, required: true
|
||||||
|
attr :class, :string, default: ""
|
||||||
|
|
||||||
|
slot :option, required: true
|
||||||
|
|
||||||
|
def button_dropdown(assigns) do
|
||||||
|
~H"""
|
||||||
|
<div x-data="{ dropdownOpen: false }" class={["relative flex", @class]}>
|
||||||
|
<span
|
||||||
|
x-on:click.prevent="dropdownOpen = !dropdownOpen"
|
||||||
|
class={[
|
||||||
|
"cursor-pointer inline-flex gap-2.5 rounded-md bg-primary px-5.5 py-3",
|
||||||
|
"font-medium text-white hover:bg-opacity-95"
|
||||||
|
]}
|
||||||
|
>
|
||||||
|
<%= @text %>
|
||||||
|
<CoreComponents.icon
|
||||||
|
name="hero-chevron-down"
|
||||||
|
class="fill-current duration-200 ease-linear mt-1"
|
||||||
|
x-bind:class="dropdownOpen && 'rotate-180'"
|
||||||
|
/>
|
||||||
|
</span>
|
||||||
|
<div
|
||||||
|
x-show="dropdownOpen"
|
||||||
|
x-on:click.outside="dropdownOpen = false"
|
||||||
|
class="absolute left-0 top-full z-40 mt-2 w-full rounded-md bg-black py-3 shadow-card"
|
||||||
|
>
|
||||||
|
<ul class="flex flex-col">
|
||||||
|
<li :for={option <- @option}>
|
||||||
|
<span class="flex px-5 py-2 font-medium text-bodydark2 hover:text-white cursor-pointer">
|
||||||
|
<%= render_slot(option) %>
|
||||||
|
</span>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
"""
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Render a button with an icon. Optionally include a tooltip.
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
<.icon_button icon_name="hero-check" tooltip="Complete" />
|
||||||
|
"""
|
||||||
|
attr :icon_name, :string, required: true
|
||||||
|
attr :class, :string, default: ""
|
||||||
|
attr :tooltip, :string, default: nil
|
||||||
|
attr :rest, :global
|
||||||
|
|
||||||
|
def icon_button(assigns) do
|
||||||
|
~H"""
|
||||||
|
<div class="group relative inline-block">
|
||||||
|
<button
|
||||||
|
class={[
|
||||||
|
"flex justify-center items-center rounded-lg ",
|
||||||
|
"bg-form-input border-2 border-strokedark",
|
||||||
|
"hover:bg-meta-4 hover:border-form-strokedark",
|
||||||
|
@class
|
||||||
|
]}
|
||||||
|
type="button"
|
||||||
|
{@rest}
|
||||||
|
>
|
||||||
|
<CoreComponents.icon name={@icon_name} class="text-stroke" />
|
||||||
|
</button>
|
||||||
|
<div
|
||||||
|
:if={@tooltip}
|
||||||
|
class={[
|
||||||
|
"hidden absolute left-1/2 top-full z-20 mt-3 -translate-x-1/2 whitespace-nowrap rounded-md",
|
||||||
|
"px-4.5 py-1.5 text-sm font-medium opacity-0 drop-shadow-4 group-hover:opacity-100 group-hover:block bg-meta-4"
|
||||||
|
]}
|
||||||
|
>
|
||||||
|
<span class="border-light absolute -top-1 left-1/2 -z-10 h-2 w-2 -translate-x-1/2 rotate-45 rounded-sm bg-meta-4">
|
||||||
|
</span>
|
||||||
|
<span><%= @tooltip %></span>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
"""
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -6,28 +6,43 @@ defmodule PinchflatWeb.CustomComponents.TabComponents do
|
|||||||
Takes a list of tabs and renders them in a tabbed layout.
|
Takes a list of tabs and renders them in a tabbed layout.
|
||||||
"""
|
"""
|
||||||
slot :tab, required: true do
|
slot :tab, required: true do
|
||||||
|
attr :id, :string, required: true
|
||||||
attr :title, :string, required: true
|
attr :title, :string, required: true
|
||||||
end
|
end
|
||||||
|
|
||||||
|
slot :tab_append, required: false
|
||||||
|
|
||||||
def tabbed_layout(assigns) do
|
def tabbed_layout(assigns) do
|
||||||
|
assigns = Map.put(assigns, :first_tab_id, hd(assigns.tab).id)
|
||||||
|
|
||||||
~H"""
|
~H"""
|
||||||
<div
|
<div
|
||||||
x-data="{ openTab: 0, activeClasses: 'text-meta-5 border-meta-5', inactiveClasses: 'border-transparent' }"
|
x-data={"{
|
||||||
|
openTab: getTabFromHash('#{@first_tab_id}', '#{@first_tab_id}'),
|
||||||
|
activeClasses: 'text-meta-5 border-meta-5',
|
||||||
|
inactiveClasses: 'border-transparent'
|
||||||
|
}"}
|
||||||
|
@hashchange.window={"openTab = getTabFromHash(openTab, '#{@first_tab_id}')"}
|
||||||
class="w-full"
|
class="w-full"
|
||||||
>
|
>
|
||||||
<div class="mb-6 flex flex-wrap gap-5 border-b border-strokedark sm:gap-10">
|
<header class="flex flex-col md:flex-row md:justify-between border-b border-strokedark">
|
||||||
<a
|
<div class="flex flex-wrap gap-5 sm:gap-10">
|
||||||
:for={{tab, idx} <- Enum.with_index(@tab)}
|
<a
|
||||||
href="#"
|
:for={tab <- @tab}
|
||||||
@click.prevent={"openTab = #{idx}"}
|
href="#"
|
||||||
x-bind:class={"openTab === #{idx} ? activeClasses : inactiveClasses"}
|
@click.prevent={"openTab = setTabByName('#{tab.id}')"}
|
||||||
class="border-b-2 py-4 text-sm font-medium hover:text-meta-5 md:text-base"
|
x-bind:class={"openTab === '#{tab.id}' ? activeClasses : inactiveClasses"}
|
||||||
>
|
class="border-b-2 py-4 w-full sm:w-fit text-sm font-medium hover:text-meta-5 md:text-base"
|
||||||
<span class="text-xl"><%= tab.title %></span>
|
>
|
||||||
</a>
|
<span class="text-xl"><%= tab.title %></span>
|
||||||
</div>
|
</a>
|
||||||
<div>
|
</div>
|
||||||
<div :for={{tab, idx} <- Enum.with_index(@tab)} x-show={"openTab === #{idx}"} class="font-medium leading-relaxed">
|
<div class="mx-4 my-4 lg:my-0 flex gap-5 sm:gap-10 items-center">
|
||||||
|
<%= render_slot(@tab_append) %>
|
||||||
|
</div>
|
||||||
|
</header>
|
||||||
|
<div class="mt-4 min-h-60">
|
||||||
|
<div :for={tab <- @tab} x-show={"openTab === '#{tab.id}'"} class="font-medium leading-relaxed">
|
||||||
<%= render_slot(tab) %>
|
<%= render_slot(tab) %>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|||||||
@@ -2,6 +2,8 @@ defmodule PinchflatWeb.CustomComponents.TableComponents do
|
|||||||
@moduledoc false
|
@moduledoc false
|
||||||
use Phoenix.Component
|
use Phoenix.Component
|
||||||
|
|
||||||
|
alias PinchflatWeb.CoreComponents
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Renders a table component with the given rows and columns.
|
Renders a table component with the given rows and columns.
|
||||||
|
|
||||||
@@ -25,21 +27,20 @@ defmodule PinchflatWeb.CustomComponents.TableComponents do
|
|||||||
|
|
||||||
def table(assigns) do
|
def table(assigns) do
|
||||||
~H"""
|
~H"""
|
||||||
<table class={["w-full table-auto", @table_class]}>
|
<table class={["w-full table-auto bg-boxdark", @table_class]}>
|
||||||
<thead>
|
<thead>
|
||||||
<tr class="bg-gray-2 text-left dark:bg-meta-4">
|
<tr class="text-left bg-meta-4">
|
||||||
<th :for={col <- @col} class="px-4 py-4 font-medium text-black dark:text-white xl:pl-11">
|
<th :for={col <- @col} class="px-4 py-4 font-medium text-white xl:pl-11">
|
||||||
<%= col[:label] %>
|
<%= col[:label] %>
|
||||||
</th>
|
</th>
|
||||||
</tr>
|
</tr>
|
||||||
</thead>
|
</thead>
|
||||||
<tbody>
|
<tbody>
|
||||||
<tr :for={{row, i} <- Enum.with_index(@rows)}>
|
<tr :for={row <- @rows} class="hover:bg-strokedark">
|
||||||
<td
|
<td
|
||||||
:for={col <- @col}
|
:for={col <- @col}
|
||||||
class={[
|
class={[
|
||||||
"px-4 py-5 pl-9 dark:border-strokedark xl:pl-11",
|
"px-4 py-5 pl-9 xl:pl-11",
|
||||||
i + 1 > length(@rows) && "border-b border-[#eee] dark:border-π",
|
|
||||||
col[:class]
|
col[:class]
|
||||||
]}
|
]}
|
||||||
>
|
>
|
||||||
@@ -50,4 +51,52 @@ defmodule PinchflatWeb.CustomComponents.TableComponents do
|
|||||||
</table>
|
</table>
|
||||||
"""
|
"""
|
||||||
end
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Renders simple pagination controls for a table in a liveview.
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
<.live_pagination_controls page_number={@page} total_pages={@total_pages} />
|
||||||
|
"""
|
||||||
|
attr :page_number, :integer, default: 1
|
||||||
|
attr :total_pages, :integer, default: 1
|
||||||
|
|
||||||
|
def live_pagination_controls(assigns) do
|
||||||
|
~H"""
|
||||||
|
<nav>
|
||||||
|
<ul class="flex flex-wrap items-center">
|
||||||
|
<li>
|
||||||
|
<span
|
||||||
|
class={[
|
||||||
|
"flex h-8 w-8 items-center justify-center rounded",
|
||||||
|
@page_number != 1 && "cursor-pointer hover:bg-primary hover:text-white",
|
||||||
|
@page_number == 1 && "cursor-not-allowed"
|
||||||
|
]}
|
||||||
|
phx-click={@page_number != 1 && "page_change"}
|
||||||
|
phx-value-direction="dec"
|
||||||
|
>
|
||||||
|
<CoreComponents.icon name="hero-chevron-left" />
|
||||||
|
</span>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<span class="mx-2">Page <%= @page_number %> of <%= @total_pages %></span>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<span
|
||||||
|
class={[
|
||||||
|
"flex h-8 w-8 items-center justify-center rounded",
|
||||||
|
@page_number != @total_pages && "cursor-pointer hover:bg-primary hover:text-white",
|
||||||
|
@page_number == @total_pages && "cursor-not-allowed"
|
||||||
|
]}
|
||||||
|
phx-click={@page_number != @total_pages && "page_change"}
|
||||||
|
phx-value-direction="inc"
|
||||||
|
>
|
||||||
|
<CoreComponents.icon name="hero-chevron-right" />
|
||||||
|
</span>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
"""
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -31,6 +31,21 @@ defmodule PinchflatWeb.CustomComponents.TextComponents do
|
|||||||
"""
|
"""
|
||||||
end
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Renders a subtle link with the given href and content.
|
||||||
|
"""
|
||||||
|
attr :href, :string, required: true
|
||||||
|
attr :target, :string, default: "_self"
|
||||||
|
slot :inner_block
|
||||||
|
|
||||||
|
def subtle_link(assigns) do
|
||||||
|
~H"""
|
||||||
|
<.link href={@href} target={@target} 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.
|
||||||
"""
|
"""
|
||||||
@@ -45,4 +60,38 @@ defmodule PinchflatWeb.CustomComponents.TextComponents do
|
|||||||
</.link>
|
</.link>
|
||||||
"""
|
"""
|
||||||
end
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Renders a block of text with each line broken into a separate span.
|
||||||
|
"""
|
||||||
|
attr :text, :string, required: true
|
||||||
|
|
||||||
|
def break_on_newline(assigns) do
|
||||||
|
broken_text =
|
||||||
|
assigns.text
|
||||||
|
|> String.split("\n", trim: false)
|
||||||
|
|> Enum.intersperse(Phoenix.HTML.Tag.tag(:span, class: "inline-block mt-2"))
|
||||||
|
|
||||||
|
assigns = Map.put(assigns, :text, broken_text)
|
||||||
|
|
||||||
|
~H"""
|
||||||
|
<span><%= @text %></span>
|
||||||
|
"""
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Renders a UTC datetime in the specified format and timezone
|
||||||
|
"""
|
||||||
|
attr :datetime, :any, required: true
|
||||||
|
attr :format, :string, default: "%Y-%m-%d %H:%M:%S"
|
||||||
|
attr :timezone, :string, default: nil
|
||||||
|
|
||||||
|
def datetime_in_zone(assigns) do
|
||||||
|
timezone = assigns.timezone || Application.get_env(:pinchflat, :timezone)
|
||||||
|
assigns = Map.put(assigns, :timezone, timezone)
|
||||||
|
|
||||||
|
~H"""
|
||||||
|
<time><%= Calendar.strftime(Timex.Timezone.convert(@datetime, @timezone), @format) %></time>
|
||||||
|
"""
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -4,26 +4,107 @@ defmodule PinchflatWeb.Layouts do
|
|||||||
embed_templates "layouts/*"
|
embed_templates "layouts/*"
|
||||||
embed_templates "layouts/partials/*"
|
embed_templates "layouts/partials/*"
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Renders a sidebar menu item link
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
<.sidebar_link icon="hero-home" text="Home" href="/" />
|
||||||
|
"""
|
||||||
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
|
|
||||||
~H"""
|
~H"""
|
||||||
<li>
|
<li class="text-bodydark1">
|
||||||
<.link
|
<.sidebar_link icon={@icon} text={@text} href={@href} target={@target} />
|
||||||
navigate={@navigate}
|
|
||||||
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",
|
|
||||||
"hover:bg-graydark dark:hover:bg-meta-4"
|
|
||||||
]}
|
|
||||||
>
|
|
||||||
<.icon name={@icon} /> <%= @text %>
|
|
||||||
</.link>
|
|
||||||
</li>
|
</li>
|
||||||
"""
|
"""
|
||||||
end
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Renders a sidebar menu item with a submenu
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
<.sidebar_submenu icon="hero-home" text="Home" current_path="/">
|
||||||
|
<:submenu icon="hero-home" text="Home" href="/" />
|
||||||
|
</.sidebar_submenu>
|
||||||
|
"""
|
||||||
|
|
||||||
|
attr :icon, :string, required: true
|
||||||
|
attr :text, :string, required: true
|
||||||
|
attr :current_path, :string, required: true
|
||||||
|
|
||||||
|
slot :submenu do
|
||||||
|
attr :icon, :string
|
||||||
|
attr :text, :string
|
||||||
|
attr :href, :any
|
||||||
|
attr :target, :any
|
||||||
|
end
|
||||||
|
|
||||||
|
def sidebar_submenu(assigns) do
|
||||||
|
initially_selected = Enum.any?(assigns[:submenu], &(&1[:href] == assigns[:current_path]))
|
||||||
|
assigns = Map.put(assigns, :initially_selected, initially_selected)
|
||||||
|
|
||||||
|
~H"""
|
||||||
|
<li class="text-bodydark1" x-data={"{ selected: #{@initially_selected} }"}>
|
||||||
|
<span
|
||||||
|
class={[
|
||||||
|
"font-medium cursor-pointer",
|
||||||
|
"group relative flex items-center justify-between rounded-sm px-4 py-2 duration-300 ease-in-out",
|
||||||
|
"duration-300 ease-in-out",
|
||||||
|
"hover:bg-meta-4"
|
||||||
|
]}
|
||||||
|
x-on:click="selected = !selected"
|
||||||
|
>
|
||||||
|
<span class="flex items-center gap-2.5">
|
||||||
|
<.icon name={@icon} /> <%= @text %>
|
||||||
|
</span>
|
||||||
|
<span class="text-bodydark2">
|
||||||
|
<.icon name="hero-chevron-up" x-bind:class="{ 'rotate-180': selected }" />
|
||||||
|
</span>
|
||||||
|
</span>
|
||||||
|
|
||||||
|
<ul x-bind:class="selected ? 'block' :'hidden'">
|
||||||
|
<li :for={menu <- @submenu} class="text-bodydark2">
|
||||||
|
<.sidebar_link icon={menu[:icon]} text={menu[:text]} href={menu[:href]} target={menu[:target]} class="pl-10" />
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
"""
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Renders a sidebar menu item link
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
<.sidebar_link icon="hero-home" text="Home" href="/" />
|
||||||
|
"""
|
||||||
|
attr :icon, :string
|
||||||
|
attr :text, :string, required: true
|
||||||
|
attr :href, :any, required: true
|
||||||
|
attr :target, :any, default: "_self"
|
||||||
|
attr :class, :string, default: ""
|
||||||
|
|
||||||
|
def sidebar_link(assigns) do
|
||||||
|
~H"""
|
||||||
|
<.link
|
||||||
|
href={@href}
|
||||||
|
target={@target}
|
||||||
|
class={[
|
||||||
|
"font-medium",
|
||||||
|
"group relative flex items-center gap-2.5 rounded-sm px-4 py-2 duration-300 ease-in-out",
|
||||||
|
"duration-300 ease-in-out",
|
||||||
|
"hover:bg-meta-4",
|
||||||
|
@class
|
||||||
|
]}
|
||||||
|
>
|
||||||
|
<.icon :if={@icon} name={@icon} /> <%= @text %>
|
||||||
|
</.link>
|
||||||
|
"""
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
<div class="flex h-screen overflow-hidden">
|
<div class="flex h-screen overflow-hidden">
|
||||||
<.sidebar />
|
<.sidebar conn={@conn} />
|
||||||
|
|
||||||
<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 params={@conn.params} />
|
<.header params={@conn.params} />
|
||||||
|
|||||||
@@ -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-2024-03-20.png"} 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,27 @@
|
|||||||
|
<.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 say thanks, a
|
||||||
|
<.inline_link href="https://supporters.eff.org/donate">
|
||||||
|
donation to the Electronic Frontier Foundation
|
||||||
|
</.inline_link>
|
||||||
|
would be greatly appreciated! You can optionally post proof of donation on
|
||||||
|
<.inline_link href="https://github.com/kieraneglin/pinchflat/issues/234">this issue</.inline_link>
|
||||||
|
to hopefully inspire others to donate as well.
|
||||||
|
</p>
|
||||||
|
<p class="mt-4">
|
||||||
|
The Electronic Frontier Foundation is a nonprofit organization 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://supporters.eff.org/donate" target="_blank">
|
||||||
|
<.button color="bg-primary" class="w-full mt-8">
|
||||||
|
Donate
|
||||||
|
</.button>
|
||||||
|
</.link>
|
||||||
|
</section>
|
||||||
|
</.modal>
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user