Compare commits
301 Commits
v0.1.4
..
v2024.10.2
| Author | SHA1 | Date | |
|---|---|---|---|
| 85feb67299 | |||
| 4843d7d6c2 | |||
| a0b9e49486 | |||
| 0163e85e76 | |||
| 7fb6fa3af4 | |||
| bb8788f03d | |||
| ed4434512b | |||
| f6344d43d2 | |||
| e0745bdfbe | |||
| a0a02cb4be | |||
| 7866f7258a | |||
| 5cd82f9dd5 | |||
| c85e9cb5f1 | |||
| 4837dd44c9 | |||
| e3f42c28d0 | |||
| 4a11d47692 | |||
| 612c760755 | |||
| 14b8ecbe44 | |||
| a6c61ccd0d | |||
| 80209240d2 | |||
| 1d5b62ccf9 | |||
| af8235c6b3 | |||
| 8e9f02c807 | |||
| fd20ac5d84 | |||
| 23492961d5 | |||
| 2326775d78 | |||
| e0a84a521b | |||
| d217ad5744 | |||
| d5ae41cdab | |||
| 7a01db05dd | |||
| d392fc3818 | |||
| 47596d5f72 | |||
| dbc25e5730 | |||
| a3ebf59b29 | |||
| 8dd8e49051 | |||
| 029981b7ee | |||
| d423e4486f | |||
| 4c7a63c970 | |||
| 4822127e3f | |||
| 4f25878f2f | |||
| aec56e3a03 | |||
| e06e050f95 | |||
| 5a10015634 | |||
| 0d5a41fd35 | |||
| 8f91c4e6a2 | |||
| 7f1daf90ca | |||
| bb0e104b7e | |||
| c0b8dec520 | |||
| b8da973a81 | |||
| a46cfd1888 | |||
| f08768b887 | |||
| 199d0065e1 | |||
| 781061b483 | |||
| 132f8e8da6 | |||
| 9daef8b3b8 | |||
| f6708a327c | |||
| 582eb53698 | |||
| a20d06072f | |||
| 6d18130351 | |||
| af86ca1e0e | |||
| 4994e70652 | |||
| 1c9f8f6abc | |||
| 2ae1ee1c99 | |||
| b73a9a4a67 | |||
| 3dd901ff3e | |||
| e751c65424 | |||
| 22439e0273 | |||
| 7603ba017f | |||
| 10880e9699 | |||
| b2e16d50cd | |||
| 3a5c06fe64 | |||
| 99fc2eb8f8 | |||
| e824b1a9f5 | |||
| 95a0c29358 | |||
| 8b0b41186a | |||
| d2f91a8253 | |||
| 776b84c585 | |||
| 29803c9b26 | |||
| 85be8744d4 | |||
| 1cbc62dc27 | |||
| 5af22d3a2f | |||
| 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 |
@@ -0,0 +1,12 @@
|
|||||||
|
{
|
||||||
|
"name": "Pinchflat Dev",
|
||||||
|
"dockerComposeFile": "../docker-compose.yml",
|
||||||
|
"service": "phx",
|
||||||
|
"workspaceFolder": "/app",
|
||||||
|
"shutdownAction": "stopCompose",
|
||||||
|
"customizations": {
|
||||||
|
"vscode": {
|
||||||
|
"extensions": ["phoenixframework.phoenix", "JakeBecker.elixir-ls", "esbenp.prettier-vscode"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,3 +1,5 @@
|
|||||||
|
# TODO: figure out why my vscode extension doesn't respect the formatter.exs file
|
||||||
|
# if it's in a subdirectory
|
||||||
[
|
[
|
||||||
import_deps: [:ecto, :ecto_sql, :phoenix],
|
import_deps: [:ecto, :ecto_sql, :phoenix],
|
||||||
subdirectories: ["priv/*/migrations"],
|
subdirectories: ["priv/*/migrations"],
|
||||||
|
|||||||
@@ -0,0 +1,34 @@
|
|||||||
|
---
|
||||||
|
name: Bug report
|
||||||
|
about: Create a report to help us improve
|
||||||
|
title: '[Triage] <your title here> '
|
||||||
|
labels: triage
|
||||||
|
assignees: kieraneglin
|
||||||
|
---
|
||||||
|
|
||||||
|
**Describe the bug**
|
||||||
|
A clear and concise description of what the bug is.
|
||||||
|
|
||||||
|
**To Reproduce**
|
||||||
|
Steps to reproduce the behavior:
|
||||||
|
|
||||||
|
1. Go to '...'
|
||||||
|
2. Click on '....'
|
||||||
|
3. Scroll down to '....'
|
||||||
|
4. See error
|
||||||
|
|
||||||
|
**Expected behavior**
|
||||||
|
A clear and concise description of what you expected to happen.
|
||||||
|
|
||||||
|
**Screenshots**
|
||||||
|
If applicable, add screenshots to help explain your problem.
|
||||||
|
|
||||||
|
**Diagnostic info**
|
||||||
|
|
||||||
|
<!-- Go to Config > App Info > Copy Diagnostic Info and paste that here -->
|
||||||
|
|
||||||
|
**Additional context**
|
||||||
|
|
||||||
|
<!-- Go to Config > App Info > Download Logs and attach them, if applicable -->
|
||||||
|
|
||||||
|
Add any other context about the problem here.
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
---
|
||||||
|
name: Feature request
|
||||||
|
about: Suggest an idea for this project
|
||||||
|
title: '[FR] <your title here>'
|
||||||
|
labels: feature request
|
||||||
|
assignees: kieraneglin
|
||||||
|
---
|
||||||
|
|
||||||
|
**Is your feature request related to a problem? Please describe.**
|
||||||
|
A clear and concise description of what the problem is. Ex. It's too complicated to [...]
|
||||||
|
|
||||||
|
**Describe the solution you'd like**
|
||||||
|
A clear and concise description of what you want to happen.
|
||||||
|
|
||||||
|
**Describe alternatives you've considered**
|
||||||
|
A clear and concise description of any alternative solutions or features you've considered.
|
||||||
|
|
||||||
|
**Additional context**
|
||||||
|
Add any other context or screenshots about the feature request here.
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
name: Other
|
||||||
|
about: For everything else
|
||||||
|
title: ''
|
||||||
|
labels: ''
|
||||||
|
assignees: kieraneglin
|
||||||
|
---
|
||||||
@@ -1,54 +0,0 @@
|
|||||||
name: Build and Push Docker Image
|
|
||||||
|
|
||||||
on:
|
|
||||||
workflow_dispatch:
|
|
||||||
inputs:
|
|
||||||
image_tag:
|
|
||||||
type: choice
|
|
||||||
description: 'Docker Image Tag'
|
|
||||||
required: true
|
|
||||||
default: 'dev'
|
|
||||||
options:
|
|
||||||
- 'dev'
|
|
||||||
- 'latest'
|
|
||||||
platforms:
|
|
||||||
type: choice
|
|
||||||
description: 'Build Platforms'
|
|
||||||
required: true
|
|
||||||
default: 'linux/amd64,linux/arm64'
|
|
||||||
options:
|
|
||||||
- 'linux/amd64,linux/arm64'
|
|
||||||
- 'linux/amd64'
|
|
||||||
|
|
||||||
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: Login to GHCR
|
|
||||||
uses: docker/login-action@v3
|
|
||||||
with:
|
|
||||||
registry: ghcr.io
|
|
||||||
username: ${{ github.repository_owner }}
|
|
||||||
password: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
|
|
||||||
- name: Build and push
|
|
||||||
uses: docker/build-push-action@v5
|
|
||||||
with:
|
|
||||||
platforms: ${{ github.event.inputs.platforms }}
|
|
||||||
push: true
|
|
||||||
file: ./selfhosted.Dockerfile
|
|
||||||
tags: |
|
|
||||||
keglin/pinchflat:${{ github.event.inputs.image_tag }}
|
|
||||||
ghcr.io/${{ github.repository_owner }}/pinchflat:${{ github.event.inputs.image_tag }}
|
|
||||||
@@ -0,0 +1,86 @@
|
|||||||
|
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'
|
||||||
|
docker_tags:
|
||||||
|
type: string
|
||||||
|
description: 'Docker Tags'
|
||||||
|
required: true
|
||||||
|
default: 'dev'
|
||||||
|
|
||||||
|
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' && github.event_name != 'workflow_dispatch' }}
|
||||||
|
type=raw,value=${{ inputs.docker_tags }},enable=${{ github.event_name == 'workflow_dispatch' }}
|
||||||
|
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@v6
|
||||||
|
with:
|
||||||
|
context: .
|
||||||
|
file: ./docker/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
|
||||||
@@ -16,24 +16,28 @@ jobs:
|
|||||||
if: "! contains(toJSON(github.event.commits.*.message), '[skip ci]')"
|
if: "! contains(toJSON(github.event.commits.*.message), '[skip ci]')"
|
||||||
env:
|
env:
|
||||||
COMPOSE_FILE: ./docker-compose.ci.yml
|
COMPOSE_FILE: ./docker-compose.ci.yml
|
||||||
|
MIX_ENV: test
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout code
|
- name: Checkout code
|
||||||
uses: actions/checkout@v3
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Pull prebuilt images
|
- name: Pull prebuilt images
|
||||||
run: docker compose pull
|
run: docker compose pull
|
||||||
|
|
||||||
- name: Setup Docker layer caching
|
- name: Set up Docker Buildx
|
||||||
uses: jpribyl/action-docker-layer-caching@v0.1.1
|
uses: docker/setup-buildx-action@v3
|
||||||
continue-on-error: true
|
|
||||||
with:
|
|
||||||
key: ci-docker-cache-{hash}
|
|
||||||
restore-keys: |
|
|
||||||
ci-docker-cache-
|
|
||||||
layer-ci-docker-cache-
|
|
||||||
|
|
||||||
- name: Build and Run Docker image
|
- name: Build docker image
|
||||||
|
uses: docker/build-push-action@v6
|
||||||
|
with:
|
||||||
|
context: .
|
||||||
|
file: ./docker/dev.Dockerfile
|
||||||
|
load: true
|
||||||
|
cache-from: type=gha
|
||||||
|
cache-to: type=gha,mode=max
|
||||||
|
|
||||||
|
- name: Run Docker image
|
||||||
run: docker compose up --detach
|
run: docker compose up --detach
|
||||||
|
|
||||||
# NOTE: All exec commands use the -T flag to compensate for
|
# NOTE: All exec commands use the -T flag to compensate for
|
||||||
@@ -43,8 +47,7 @@ jobs:
|
|||||||
# See https://github.com/actions/runner/issues/241 and https://github.com/docker/compose/issues/8537
|
# See https://github.com/actions/runner/issues/241 and https://github.com/docker/compose/issues/8537
|
||||||
- name: Install Elixir and JS deps
|
- name: Install Elixir and JS deps
|
||||||
run: |
|
run: |
|
||||||
docker compose exec -T phx yarn install && cd assets && yarn install && cd ..
|
docker compose exec -T phx mix deps.get && yarn install && cd assets && yarn install && cd ..
|
||||||
docker compose exec -T phx mix deps.get
|
|
||||||
|
|
||||||
- name: Create and Migrate database
|
- name: Create and Migrate database
|
||||||
run: |
|
run: |
|
||||||
|
|||||||
@@ -23,3 +23,11 @@ alias Pinchflat.Metadata.MetadataFileHelpers
|
|||||||
alias Pinchflat.SlowIndexing.FileFollowerServer
|
alias Pinchflat.SlowIndexing.FileFollowerServer
|
||||||
|
|
||||||
Pinchflat.Release.check_file_permissions()
|
Pinchflat.Release.check_file_permissions()
|
||||||
|
|
||||||
|
defmodule IexHelpers do
|
||||||
|
def restart do
|
||||||
|
:init.restart()
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
import IexHelpers
|
||||||
|
|||||||
@@ -1,3 +1 @@
|
|||||||
assets/vendor/
|
assets/vendor/
|
||||||
deps/
|
|
||||||
_build/
|
|
||||||
|
|||||||
+2
-1
@@ -16,7 +16,8 @@
|
|||||||
"Config.HTTPS",
|
"Config.HTTPS",
|
||||||
"Config.CSP",
|
"Config.CSP",
|
||||||
"XSS.ContentType",
|
"XSS.ContentType",
|
||||||
"Traversal.SendFile"
|
"Traversal.SendFile",
|
||||||
|
"Traversal.SendDownload"
|
||||||
],
|
],
|
||||||
ignore_files: [],
|
ignore_files: [],
|
||||||
version: false
|
version: false
|
||||||
|
|||||||
@@ -12,6 +12,15 @@
|
|||||||
</sup>
|
</sup>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
|
||||||
|
[](LICENSE)
|
||||||
|
[](https://github.com/kieraneglin/pinchflat/releases)
|
||||||
|
[](#)
|
||||||
|
[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/kieraneglin/pinchflat)
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
# Your next YouTube media manager
|
# Your next YouTube media manager
|
||||||
|
|
||||||
## Table of contents:
|
## Table of contents:
|
||||||
@@ -21,7 +30,9 @@
|
|||||||
- [Screenshots](#screenshots)
|
- [Screenshots](#screenshots)
|
||||||
- [Installation](#installation)
|
- [Installation](#installation)
|
||||||
- [Unraid](#unraid)
|
- [Unraid](#unraid)
|
||||||
|
- [Portainer](#portainer)
|
||||||
- [Docker](#docker)
|
- [Docker](#docker)
|
||||||
|
- [Environment Variables](#environment-variables)
|
||||||
- [Username and Password (authentication)](https://github.com/kieraneglin/pinchflat/wiki/Username-and-Password)
|
- [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)
|
- [Frequently asked questions](https://github.com/kieraneglin/pinchflat/wiki/Frequently-Asked-Questions)
|
||||||
- [Documentation](https://github.com/kieraneglin/pinchflat/wiki)
|
- [Documentation](https://github.com/kieraneglin/pinchflat/wiki)
|
||||||
@@ -31,9 +42,9 @@
|
|||||||
|
|
||||||
## What it does
|
## What it does
|
||||||
|
|
||||||
Pinchflat is a self-hosted app for downloading YouTube content built using [yt-dlp](https://github.com/yt-dlp/yt-dlp). It's designed to be lightweight, self-contained, and easy to use. You set up rules for how to download content from YouTube channels or playlists and it'll do the rest, checking periodically for new content. It's perfect for people who want to download content for use in with a media center app (Plex, Jellyfin, Kodi) or for those who want to archive media!
|
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!
|
||||||
|
|
||||||
It's _not_ great for downloading one-off videos - it's built to download large amounts of content and keep it up to date. It's also not meant for consuming content in-app - Pinchflat downloads content to disk where you can then watch it with a media center app or VLC.
|
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)
|
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)
|
||||||
|
|
||||||
@@ -43,19 +54,26 @@ If it doesn't work for your use case, please make a feature request! You can als
|
|||||||
- Powerful naming system so content is stored where and how you want it
|
- 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
|
- 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
|
- First-class support for media center apps like Plex, Jellyfin, and Kodi
|
||||||
- Supports serving RSS feeds to your favourite podcast app (beta - [docs](<https://github.com/kieraneglin/pinchflat/wiki/Podcast-RSS-Feeds-(beta)>))
|
- 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
|
- Automatically downloads new content from channels and playlists
|
||||||
- Uses a novel approach to download new content more quickly than other apps
|
- Uses a novel approach to download new content more quickly than other apps
|
||||||
- Supports downloading audio content
|
- Supports downloading audio content
|
||||||
- Custom rules for handling YouTube Shorts and livestreams
|
- 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
|
- Advanced options like setting cutoff dates and filtering by title
|
||||||
- Reliable hands-off operation
|
- Reliable hands-off operation
|
||||||
- Can pass cookies to YouTube to download your private playlists ([docs](https://github.com/kieraneglin/pinchflat/wiki/YouTube-Cookies))
|
- 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
|
## Screenshots
|
||||||
|
|
||||||
<img src="priv/static/images/app-form-screenshot.png" alt="Pinchflat screenshot" width="700" />
|
<img src="priv/static/images/app-form-screenshot.jpg" alt="Pinchflat screenshot" width="700" />
|
||||||
<img src="priv/static/images/app-screenshot.png" alt="Pinchflat screenshot" width="700" />
|
<img src="priv/static/images/app-screenshot.jpg" alt="Pinchflat screenshot" width="700" />
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
@@ -65,13 +83,19 @@ Simply search for Pinchflat in the Community Apps store!
|
|||||||
|
|
||||||
### Portainer
|
### Portainer
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> 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.
|
||||||
|
|
||||||
Docker Compose file:
|
Docker Compose file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
version: '3'
|
version: '3'
|
||||||
services:
|
services:
|
||||||
pinchflat:
|
pinchflat:
|
||||||
image: keglin/pinchflat:latest
|
image: ghcr.io/kieraneglin/pinchflat:latest
|
||||||
|
environment:
|
||||||
|
# Set the timezone to your local timezone
|
||||||
|
- TZ=America/New_York
|
||||||
ports:
|
ports:
|
||||||
- '8945:8945'
|
- '8945:8945'
|
||||||
volumes:
|
volumes:
|
||||||
@@ -85,13 +109,15 @@ services:
|
|||||||
2. Prepare the docker image in one of the two ways below:
|
2. Prepare the docker image in one of the two ways below:
|
||||||
- **From GHCR:** `docker pull ghcr.io/kieraneglin/pinchflat:latest`
|
- **From GHCR:** `docker pull ghcr.io/kieraneglin/pinchflat:latest`
|
||||||
- NOTE: also available on Docker Hub at `keglin/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`
|
- **Building locally:** `docker build . --file docker/selfhosted.Dockerfile -t ghcr.io/kieraneglin/pinchflat:latest`
|
||||||
3. Run the container:
|
3. Run the container:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Be sure to replace /host/path/to/config and /host/path/to/downloads below with
|
# 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
|
# the paths to the directories you created in step 1
|
||||||
|
# Be sure to replace America/New_York with your local timezone
|
||||||
docker run \
|
docker run \
|
||||||
|
-e TZ=America/New_York \
|
||||||
-p 8945:8945 \
|
-p 8945:8945 \
|
||||||
-v /host/path/to/config:/config \
|
-v /host/path/to/config:/config \
|
||||||
-v /host/path/to/downloads:/downloads \
|
-v /host/path/to/downloads:/downloads \
|
||||||
@@ -102,11 +128,41 @@ docker run \
|
|||||||
|
|
||||||
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.
|
You _must_ ensure the host directories you've mounted are writable by the user running the Docker container. If you get a permission error follow the steps it suggests. See [#106](https://github.com/kieraneglin/pinchflat/issues/106) for more.
|
||||||
|
|
||||||
It's recommended to not run the container as root. Doing so can create permission issues if other apps need to work with the downloaded media. If you need to run any command as root, you can run `su` from the container's shell as there is no password set for the root user.
|
> [!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` but `debug` is strongly recommended |
|
||||||
|
| `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 | `false` | See [RSS feed docs](https://github.com/kieraneglin/pinchflat/wiki/Podcast-RSS-Feeds) |
|
||||||
|
| `ENABLE_IPV6` | No | `false` | Setting to _any_ non-blank value will enable IPv6 |
|
||||||
|
| `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 |
|
||||||
|
| `BASE_ROUTE_PATH` | No | `/` | The base path for route generation. Useful when running behind certain reverse proxies |
|
||||||
|
| `YT_DLP_WORKER_CONCURRENCY` | No | `2` | The number of concurrent workers that use `yt-dlp` _per queue_. Set to 1 if you're getting IP limited, otherwise don't touch it |
|
||||||
|
|
||||||
## EFF donations
|
## EFF donations
|
||||||
|
|
||||||
A portion of all donations to Pinchflat will be donated to the [Electronic Frontier Foundation](https://www.eff.org/). The EFF defends your online liberties and [backed](https://github.com/github/dmca/blob/9a85e0f021f7967af80e186b890776a50443f06c/2020/11/2020-11-16-RIAA-reversal-effletter.pdf) `youtube-dl` when Google took them down. [See here](https://github.com/kieraneglin/pinchflat/wiki/EFF-Donation-Receipts) for a list of donation receipts.
|
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
|
## Pre-release disclaimer
|
||||||
|
|
||||||
@@ -115,3 +171,8 @@ This is pre-release software and anything can break at any time. I make not guar
|
|||||||
## 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
|
||||||
|
|||||||
+21
-18
@@ -22,8 +22,8 @@
|
|||||||
|
|
||||||
@font-face {
|
@font-face {
|
||||||
font-family: 'Satoshi';
|
font-family: 'Satoshi';
|
||||||
src: url('/fonts/satoshi/Satoshi-Light.woff2'), url('/fonts/satoshi/Satoshi-Light.woff'),
|
src: url('../fonts/satoshi/Satoshi-Light.woff2'), url('../fonts/satoshi/Satoshi-Light.woff'),
|
||||||
url('/fonts/satoshi/Satoshi-Light.ttf');
|
url('../fonts/satoshi/Satoshi-Light.ttf');
|
||||||
font-weight: 300;
|
font-weight: 300;
|
||||||
font-display: swap;
|
font-display: swap;
|
||||||
font-style: normal;
|
font-style: normal;
|
||||||
@@ -31,8 +31,9 @@
|
|||||||
|
|
||||||
@font-face {
|
@font-face {
|
||||||
font-family: 'Satoshi';
|
font-family: 'Satoshi';
|
||||||
src: url('/fonts/satoshi/Satoshi-LightItalic.woff2'),
|
src: url('../fonts/satoshi/Satoshi-LightItalic.woff2'),
|
||||||
url('/fonts/satoshi/Satoshi-LightItalic.woff'), url('/fonts/satoshi/Satoshi-LightItalic.ttf');
|
url('../fonts/satoshi/Satoshi-LightItalic.woff'),
|
||||||
|
url('../fonts/satoshi/Satoshi-LightItalic.ttf');
|
||||||
font-weight: 300;
|
font-weight: 300;
|
||||||
font-display: swap;
|
font-display: swap;
|
||||||
font-style: italic;
|
font-style: italic;
|
||||||
@@ -40,8 +41,8 @@
|
|||||||
|
|
||||||
@font-face {
|
@font-face {
|
||||||
font-family: 'Satoshi';
|
font-family: 'Satoshi';
|
||||||
src: url('/fonts/satoshi/Satoshi-Regular.woff2'), url('/fonts/satoshi/Satoshi-Regular.woff'),
|
src: url('../fonts/satoshi/Satoshi-Regular.woff2'), url('../fonts/satoshi/Satoshi-Regular.woff'),
|
||||||
url('/fonts/satoshi/Satoshi-Regular.ttf');
|
url('../fonts/satoshi/Satoshi-Regular.ttf');
|
||||||
font-weight: 400;
|
font-weight: 400;
|
||||||
font-display: swap;
|
font-display: swap;
|
||||||
font-style: normal;
|
font-style: normal;
|
||||||
@@ -49,8 +50,8 @@
|
|||||||
|
|
||||||
@font-face {
|
@font-face {
|
||||||
font-family: 'Satoshi';
|
font-family: 'Satoshi';
|
||||||
src: url('/fonts/satoshi/Satoshi-Italic.woff2'), url('/fonts/satoshi/Satoshi-Italic.woff'),
|
src: url('../fonts/satoshi/Satoshi-Italic.woff2'), url('../fonts/satoshi/Satoshi-Italic.woff'),
|
||||||
url('/fonts/satoshi/Satoshi-Italic.ttf');
|
url('../fonts/satoshi/Satoshi-Italic.ttf');
|
||||||
font-weight: 400;
|
font-weight: 400;
|
||||||
font-display: swap;
|
font-display: swap;
|
||||||
font-style: italic;
|
font-style: italic;
|
||||||
@@ -58,8 +59,8 @@
|
|||||||
|
|
||||||
@font-face {
|
@font-face {
|
||||||
font-family: 'Satoshi';
|
font-family: 'Satoshi';
|
||||||
src: url('/fonts/satoshi/Satoshi-Medium.woff2'), url('/fonts/satoshi/Satoshi-Medium.woff'),
|
src: url('../fonts/satoshi/Satoshi-Medium.woff2'), url('../fonts/satoshi/Satoshi-Medium.woff'),
|
||||||
url('/fonts/satoshi/Satoshi-Medium.ttf');
|
url('../fonts/satoshi/Satoshi-Medium.ttf');
|
||||||
font-weight: 500;
|
font-weight: 500;
|
||||||
font-display: swap;
|
font-display: swap;
|
||||||
font-style: normal;
|
font-style: normal;
|
||||||
@@ -67,8 +68,9 @@
|
|||||||
|
|
||||||
@font-face {
|
@font-face {
|
||||||
font-family: 'Satoshi';
|
font-family: 'Satoshi';
|
||||||
src: url('/fonts/satoshi/Satoshi-MediumItalic.woff2'),
|
src: url('../fonts/satoshi/Satoshi-MediumItalic.woff2'),
|
||||||
url('/fonts/satoshi/Satoshi-MediumItalic.woff'), url('/fonts/satoshi/Satoshi-MediumItalic.ttf');
|
url('../fonts/satoshi/Satoshi-MediumItalic.woff'),
|
||||||
|
url('../fonts/satoshi/Satoshi-MediumItalic.ttf');
|
||||||
font-weight: 500;
|
font-weight: 500;
|
||||||
font-display: swap;
|
font-display: swap;
|
||||||
font-style: italic;
|
font-style: italic;
|
||||||
@@ -76,8 +78,8 @@
|
|||||||
|
|
||||||
@font-face {
|
@font-face {
|
||||||
font-family: 'Satoshi';
|
font-family: 'Satoshi';
|
||||||
src: url('/fonts/satoshi/Satoshi-Bold.woff2'), url('/fonts/satoshi/Satoshi-Bold.woff'),
|
src: url('../fonts/satoshi/Satoshi-Bold.woff2'), url('../fonts/satoshi/Satoshi-Bold.woff'),
|
||||||
url('/fonts/satoshi/Satoshi-Bold.ttf');
|
url('../fonts/satoshi/Satoshi-Bold.ttf');
|
||||||
font-weight: 700;
|
font-weight: 700;
|
||||||
font-display: swap;
|
font-display: swap;
|
||||||
font-style: normal;
|
font-style: normal;
|
||||||
@@ -85,8 +87,8 @@
|
|||||||
|
|
||||||
@font-face {
|
@font-face {
|
||||||
font-family: 'Satoshi';
|
font-family: 'Satoshi';
|
||||||
src: url('/fonts/satoshi/Satoshi-BoldItalic.woff2'), url('/fonts/satoshi/Satoshi-BoldItalic.woff'),
|
src: url('../fonts/satoshi/Satoshi-BoldItalic.woff2'),
|
||||||
url('/fonts/satoshi/Satoshi-BoldItalic.ttf');
|
url('../fonts/satoshi/Satoshi-BoldItalic.woff'), url('../fonts/satoshi/Satoshi-BoldItalic.ttf');
|
||||||
font-weight: 700;
|
font-weight: 700;
|
||||||
font-display: swap;
|
font-display: swap;
|
||||||
font-style: italic;
|
font-style: italic;
|
||||||
@@ -94,8 +96,9 @@
|
|||||||
|
|
||||||
@font-face {
|
@font-face {
|
||||||
font-family: 'Satoshi';
|
font-family: 'Satoshi';
|
||||||
src: url('/fonts/satoshi/Satoshi-BlackItalic.woff2'),
|
src: url('../fonts/satoshi/Satoshi-BlackItalic.woff2'),
|
||||||
url('/fonts/satoshi/Satoshi-BlackItalic.woff'), url('/fonts/satoshi/Satoshi-BlackItalic.ttf');
|
url('../fonts/satoshi/Satoshi-BlackItalic.woff'),
|
||||||
|
url('../fonts/satoshi/Satoshi-BlackItalic.ttf');
|
||||||
font-weight: 900;
|
font-weight: 900;
|
||||||
font-display: swap;
|
font-display: swap;
|
||||||
font-style: italic;
|
font-style: italic;
|
||||||
|
|||||||
@@ -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
|
||||||
|
}
|
||||||
+11
-22
@@ -22,12 +22,14 @@ 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()
|
||||||
|
|
||||||
let csrfToken = document.querySelector("meta[name='csrf-token']").getAttribute('content')
|
let csrfToken = document.querySelector("meta[name='csrf-token']").getAttribute('content')
|
||||||
let liveSocket = new LiveSocket('/live', Socket, {
|
let liveSocket = new LiveSocket(document.body.dataset.socketPath, Socket, {
|
||||||
params: { _csrf_token: csrfToken },
|
params: { _csrf_token: csrfToken },
|
||||||
dom: {
|
dom: {
|
||||||
onBeforeElUpdated(from, to) {
|
onBeforeElUpdated(from, to) {
|
||||||
@@ -35,32 +37,19 @@ 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()
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
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()
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
})
|
||||||
|
|
||||||
// Show progress bar on live navigation and form submits
|
// Show progress bar on live navigation and form submits
|
||||||
topbar.config({ barColors: { 0: '#29d' }, shadowColor: 'rgba(0, 0, 0, .3)' })
|
topbar.config({ barColors: { 0: '#29d' }, shadowColor: 'rgba(0, 0, 0, .3)' })
|
||||||
|
|||||||
@@ -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
|
||||||
|
}
|
||||||
+21
-15
@@ -12,7 +12,9 @@ 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"),
|
||||||
|
apprise_executable: System.find_executable("apprise"),
|
||||||
yt_dlp_runner: Pinchflat.YtDlp.CommandRunner,
|
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",
|
||||||
@@ -23,7 +25,13 @@ config :pinchflat,
|
|||||||
basic_auth_username: "",
|
basic_auth_username: "",
|
||||||
basic_auth_password: "",
|
basic_auth_password: "",
|
||||||
expose_feed_endpoints: false,
|
expose_feed_endpoints: false,
|
||||||
file_watcher_poll_interval: 1000
|
file_watcher_poll_interval: 1000,
|
||||||
|
timezone: "UTC",
|
||||||
|
base_route_path: "/"
|
||||||
|
|
||||||
|
config :pinchflat, Pinchflat.Repo,
|
||||||
|
journal_mode: :wal,
|
||||||
|
pool_size: 5
|
||||||
|
|
||||||
# Configures the endpoint
|
# Configures the endpoint
|
||||||
config :pinchflat, PinchflatWeb.Endpoint,
|
config :pinchflat, PinchflatWeb.Endpoint,
|
||||||
@@ -33,7 +41,8 @@ config :pinchflat, PinchflatWeb.Endpoint,
|
|||||||
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],
|
||||||
layout: false
|
root_layout: {PinchflatWeb.Layouts, :root},
|
||||||
|
layout: {PinchflatWeb.Layouts, :app}
|
||||||
],
|
],
|
||||||
pubsub_server: Pinchflat.PubSub,
|
pubsub_server: Pinchflat.PubSub,
|
||||||
live_view: [signing_salt: "/t5878kO"]
|
live_view: [signing_salt: "/t5878kO"]
|
||||||
@@ -42,16 +51,13 @@ 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: [
|
||||||
# TODO: consider making this an env var or something?
|
{Oban.Plugins.Pruner, max_age: 30 * 24 * 60 * 60},
|
||||||
queues: [
|
{Oban.Plugins.Cron,
|
||||||
default: 10,
|
crontab: [
|
||||||
fast_indexing: 6,
|
{"0 1 * * *", Pinchflat.Downloading.MediaRetentionWorker},
|
||||||
media_indexing: 2,
|
{"0 2 * * *", Pinchflat.Downloading.MediaQualityUpgradeWorker}
|
||||||
media_collection_indexing: 2,
|
]}
|
||||||
media_fetching: 2,
|
|
||||||
local_metadata: 8,
|
|
||||||
remote_metadata: 4
|
|
||||||
]
|
]
|
||||||
|
|
||||||
# Configures the mailer
|
# Configures the mailer
|
||||||
@@ -75,7 +81,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
|
||||||
@@ -86,8 +92,8 @@ config :tailwind,
|
|||||||
]
|
]
|
||||||
|
|
||||||
# Configures Elixir's Logger
|
# Configures Elixir's Logger
|
||||||
config :logger, :console,
|
config :logger, :default_formatter,
|
||||||
format: "$time $metadata[$level] $message\n",
|
format: "$date $time $metadata[$level] | $message\n",
|
||||||
metadata: [:request_id]
|
metadata: [:request_id]
|
||||||
|
|
||||||
# Use Jason for JSON parsing in Phoenix
|
# Use Jason for JSON parsing in Phoenix
|
||||||
|
|||||||
+1
-1
@@ -67,7 +67,7 @@ config :pinchflat, PinchflatWeb.Endpoint,
|
|||||||
config :pinchflat, dev_routes: true
|
config :pinchflat, dev_routes: true
|
||||||
|
|
||||||
# Do not include metadata nor timestamps in development logs
|
# Do not include metadata nor timestamps in development logs
|
||||||
config :logger, :console, format: "[$level] $message\n"
|
config :logger, :default_formatter, format: "[$level] $message\n"
|
||||||
|
|
||||||
# Set a higher stacktrace during development. Avoid configuring such
|
# Set a higher stacktrace during development. Avoid configuring such
|
||||||
# in production as building large stacktraces may be expensive.
|
# in production as building large stacktraces may be expensive.
|
||||||
|
|||||||
+30
-14
@@ -40,39 +40,54 @@ config :pinchflat, Pinchflat.Repo,
|
|||||||
Path.join([:code.priv_dir(:pinchflat), "repo", "extensions", "sqlean-linux-#{system_arch}", "sqlean"])
|
Path.join([:code.priv_dir(:pinchflat), "repo", "extensions", "sqlean-linux-#{system_arch}", "sqlean"])
|
||||||
]
|
]
|
||||||
|
|
||||||
|
# Some users may want to increase the number of workers that use yt-dlp to improve speeds
|
||||||
|
# Others may want to decrease the number of these workers to lessen the chance of an IP ban
|
||||||
|
{yt_dlp_worker_count, _} = Integer.parse(System.get_env("YT_DLP_WORKER_CONCURRENCY", "2"))
|
||||||
|
|
||||||
|
config :pinchflat, Oban,
|
||||||
|
queues: [
|
||||||
|
default: 10,
|
||||||
|
fast_indexing: 6,
|
||||||
|
media_collection_indexing: yt_dlp_worker_count,
|
||||||
|
media_fetching: yt_dlp_worker_count,
|
||||||
|
remote_metadata: yt_dlp_worker_count,
|
||||||
|
local_data: 8
|
||||||
|
]
|
||||||
|
|
||||||
if config_env() == :prod do
|
if config_env() == :prod do
|
||||||
config_path = "/config"
|
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"]))
|
extras_path = System.get_env("EXTRAS_PATH", Path.join([config_path, "extras"]))
|
||||||
|
|
||||||
# For running PF as a podcast host on self-hosted environments
|
# For running PF as a podcast host on self-hosted environments
|
||||||
expose_feed_endpoints = String.length(System.get_env("EXPOSE_FEED_ENDPOINTS", "")) > 0
|
expose_feed_endpoints = String.length(System.get_env("EXPOSE_FEED_ENDPOINTS", "")) > 0
|
||||||
|
# For testing alternate journal modes (see issue #137)
|
||||||
|
journal_mode = String.to_existing_atom(System.get_env("JOURNAL_MODE", "wal"))
|
||||||
|
# For running PF in a subdirectory via a reverse proxy
|
||||||
|
base_route_path = System.get_env("BASE_ROUTE_PATH", "/")
|
||||||
|
enable_ipv6 = String.length(System.get_env("ENABLE_IPV6", "")) > 0
|
||||||
|
|
||||||
# We want to force _some_ level of useful logging in production
|
config :logger, level: String.to_existing_atom(System.get_env("LOG_LEVEL", "debug"))
|
||||||
acceptable_log_levels = ~w(debug info)a
|
|
||||||
log_level = String.to_existing_atom(System.get_env("LOG_LEVEL", "info"))
|
|
||||||
|
|
||||||
if log_level in acceptable_log_levels do
|
|
||||||
config :logger, level: log_level
|
|
||||||
else
|
|
||||||
Logger.error("Invalid log level: #{log_level}. Defaulting to info.")
|
|
||||||
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",
|
media_directory: "/downloads",
|
||||||
metadata_directory: metadata_path,
|
metadata_directory: metadata_path,
|
||||||
extras_directory: extras_path,
|
extras_directory: extras_path,
|
||||||
tmpfile_directory: Path.join([System.tmp_dir!(), "pinchflat", "data"]),
|
tmpfile_directory: Path.join([System.tmp_dir!(), "pinchflat", "data"]),
|
||||||
dns_cluster_query: System.get_env("DNS_CLUSTER_QUERY"),
|
dns_cluster_query: System.get_env("DNS_CLUSTER_QUERY"),
|
||||||
expose_feed_endpoints: expose_feed_endpoints
|
expose_feed_endpoints: expose_feed_endpoints,
|
||||||
|
timezone: System.get_env("TIMEZONE") || System.get_env("TZ") || "UTC",
|
||||||
|
log_path: log_path,
|
||||||
|
base_route_path: base_route_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
|
||||||
@@ -106,9 +121,10 @@ 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},
|
ip: if(enable_ipv6, do: {0, 0, 0, 0, 0, 0, 0, 0}, else: {0, 0, 0, 0}),
|
||||||
port: String.to_integer(System.get_env("PORT") || "4000")
|
port: String.to_integer(System.get_env("PORT") || "4000")
|
||||||
],
|
],
|
||||||
|
url: [path: base_route_path],
|
||||||
secret_key_base: secret_key_base
|
secret_key_base: secret_key_base
|
||||||
|
|
||||||
config :pinchflat, :logger, [
|
config :pinchflat, :logger, [
|
||||||
|
|||||||
+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
|
||||||
|
|||||||
@@ -1,45 +0,0 @@
|
|||||||
ARG ELIXIR_VERSION=1.16.2
|
|
||||||
ARG OTP_VERSION=26.2.2
|
|
||||||
ARG DEBIAN_VERSION=bookworm-20240130
|
|
||||||
ARG DEV_IMAGE="hexpm/elixir:${ELIXIR_VERSION}-erlang-${OTP_VERSION}-debian-${DEBIAN_VERSION}"
|
|
||||||
|
|
||||||
FROM ${DEV_IMAGE}
|
|
||||||
|
|
||||||
# Set the locale deets
|
|
||||||
ENV LANG en_US.UTF-8
|
|
||||||
ENV LANGUAGE en_US:en
|
|
||||||
ENV LC_ALL en_US.UTF-8
|
|
||||||
|
|
||||||
# Install debian packages
|
|
||||||
RUN apt-get update -qq
|
|
||||||
RUN apt-get install -y inotify-tools ffmpeg curl git openssh-client \
|
|
||||||
python3 python3-pip python3-setuptools python3-wheel python3-dev
|
|
||||||
|
|
||||||
# Install nodejs
|
|
||||||
RUN curl -sL https://deb.nodesource.com/setup_20.x -o nodesource_setup.sh
|
|
||||||
RUN bash nodesource_setup.sh
|
|
||||||
RUN apt-get install nodejs
|
|
||||||
RUN npm install -g yarn
|
|
||||||
|
|
||||||
# Install baseline Elixir packages
|
|
||||||
RUN mix local.hex --force
|
|
||||||
RUN mix local.rebar --force
|
|
||||||
|
|
||||||
# Download YT-DLP
|
|
||||||
# NOTE: If you're seeing weird issues, consider using the FFMPEG released by yt-dlp
|
|
||||||
RUN python3 -m pip install -U --pre yt-dlp --break-system-packages
|
|
||||||
|
|
||||||
# Create app directory and copy the Elixir projects into it.
|
|
||||||
WORKDIR /app
|
|
||||||
COPY . ./
|
|
||||||
|
|
||||||
# Needs permissions to be updated AFTER the copy step
|
|
||||||
RUN chmod +x ./docker-run.dev.sh
|
|
||||||
|
|
||||||
# Install Elixir deps
|
|
||||||
# RUN mix archive.install github hexpm/hex branch latest
|
|
||||||
RUN mix deps.get
|
|
||||||
# Gives us iex shell history
|
|
||||||
ENV ERL_AFLAGS="-kernel shell_history enabled"
|
|
||||||
|
|
||||||
EXPOSE 4008
|
|
||||||
@@ -1,13 +1,15 @@
|
|||||||
version: '3'
|
|
||||||
services:
|
services:
|
||||||
phx:
|
phx:
|
||||||
build:
|
build:
|
||||||
context: .
|
context: .
|
||||||
dockerfile: dev.Dockerfile
|
dockerfile: ./docker/dev.Dockerfile
|
||||||
environment:
|
environment:
|
||||||
- MIX_ENV=test
|
- MIX_ENV=test
|
||||||
volumes:
|
volumes:
|
||||||
- '.:/app'
|
- '.:/app'
|
||||||
|
# These lines ensure the deps can be saved as build artifacts for caching
|
||||||
|
- '/app/deps'
|
||||||
|
- '/app/_build'
|
||||||
ports:
|
ports:
|
||||||
- '4008:4008'
|
- '4008:4008'
|
||||||
command: tail -F /dev/null
|
command: tail -F /dev/null
|
||||||
|
|||||||
+2
-4
@@ -1,14 +1,12 @@
|
|||||||
version: '3'
|
|
||||||
services:
|
services:
|
||||||
phx:
|
phx:
|
||||||
build:
|
build:
|
||||||
context: .
|
context: .
|
||||||
dockerfile: dev.Dockerfile
|
dockerfile: ./docker/dev.Dockerfile
|
||||||
volumes:
|
volumes:
|
||||||
- '.:/app'
|
- '.:/app'
|
||||||
ports:
|
ports:
|
||||||
- '4008:4008'
|
- '4008:4008'
|
||||||
command:
|
command: bash -c "chmod +x docker/docker-run.dev.sh && docker/docker-run.dev.sh"
|
||||||
- ./docker-run.dev.sh
|
|
||||||
stdin_open: true
|
stdin_open: true
|
||||||
tty: true
|
tty: true
|
||||||
|
|||||||
@@ -0,0 +1,65 @@
|
|||||||
|
ARG ELIXIR_VERSION=1.17.0
|
||||||
|
ARG OTP_VERSION=26.2.5
|
||||||
|
ARG DEBIAN_VERSION=bookworm-20240612-slim
|
||||||
|
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
|
||||||
|
RUN apt-get update -qq && \
|
||||||
|
apt-get install -y inotify-tools curl git openssh-client jq \
|
||||||
|
python3 python3-setuptools python3-wheel python3-dev pipx \
|
||||||
|
python3-mutagen locales procps build-essential graphviz zsh
|
||||||
|
|
||||||
|
# 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 and Yarn
|
||||||
|
RUN curl -sL https://deb.nodesource.com/setup_20.x -o nodesource_setup.sh && \
|
||||||
|
bash nodesource_setup.sh && \
|
||||||
|
apt-get install -y nodejs && \
|
||||||
|
npm install -g yarn && \
|
||||||
|
# Install baseline Elixir packages
|
||||||
|
mix local.hex --force && \
|
||||||
|
mix local.rebar --force && \
|
||||||
|
# Download and update YT-DLP
|
||||||
|
curl -L https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -o /usr/local/bin/yt-dlp && \
|
||||||
|
chmod a+rx /usr/local/bin/yt-dlp && \
|
||||||
|
yt-dlp -U && \
|
||||||
|
# Install Apprise
|
||||||
|
export PIPX_HOME=/opt/pipx && \
|
||||||
|
export PIPX_BIN_DIR=/usr/local/bin && \
|
||||||
|
pipx install apprise && \
|
||||||
|
# Set up ZSH tools
|
||||||
|
chsh -s $(which zsh) && \
|
||||||
|
sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"
|
||||||
|
|
||||||
|
# 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
|
||||||
|
|
||||||
|
WORKDIR /app
|
||||||
|
|
||||||
|
COPY mix.exs mix.lock ./
|
||||||
|
# Install Elixir deps
|
||||||
|
# NOTE: this has to be before the bulk copy to ensure that deps are cached
|
||||||
|
RUN MIX_ENV=dev mix deps.get && MIX_ENV=dev mix deps.compile
|
||||||
|
RUN MIX_ENV=test mix deps.get && MIX_ENV=test mix deps.compile
|
||||||
|
|
||||||
|
COPY . ./
|
||||||
|
|
||||||
|
# Gives us iex shell history
|
||||||
|
ENV ERL_AFLAGS="-kernel shell_history enabled"
|
||||||
|
|
||||||
|
EXPOSE 4008
|
||||||
@@ -2,12 +2,12 @@
|
|||||||
|
|
||||||
set -e
|
set -e
|
||||||
|
|
||||||
# Ensure the app's deps are installed
|
echo "\nInstalling Elixir deps..."
|
||||||
mix deps.get
|
mix deps.get
|
||||||
|
|
||||||
# Install JS deps
|
# Install both project-level and assets-level JS dependencies
|
||||||
echo "\nInstalling JS..."
|
echo "\nInstalling JS deps..."
|
||||||
cd assets && yarn install
|
yarn install && cd assets && yarn install
|
||||||
cd ..
|
cd ..
|
||||||
|
|
||||||
# Potentially Set up the database
|
# Potentially Set up the database
|
||||||
@@ -0,0 +1,145 @@
|
|||||||
|
# Find eligible builder and runner images on Docker Hub. We use Ubuntu/Debian
|
||||||
|
# instead of Alpine to avoid DNS resolution issues in production.
|
||||||
|
ARG ELIXIR_VERSION=1.17.0
|
||||||
|
ARG OTP_VERSION=26.2.5
|
||||||
|
ARG DEBIAN_VERSION=bookworm-20240612-slim
|
||||||
|
|
||||||
|
ARG BUILDER_IMAGE="hexpm/elixir:${ELIXIR_VERSION}-erlang-${OTP_VERSION}-debian-${DEBIAN_VERSION}"
|
||||||
|
ARG RUNNER_IMAGE="debian:${DEBIAN_VERSION}"
|
||||||
|
|
||||||
|
FROM ${BUILDER_IMAGE} as builder
|
||||||
|
|
||||||
|
ARG TARGETPLATFORM
|
||||||
|
RUN echo "Building for ${TARGETPLATFORM:?}"
|
||||||
|
|
||||||
|
# install build dependencies
|
||||||
|
RUN apt-get update -y && \
|
||||||
|
# System packages
|
||||||
|
apt-get install -y \
|
||||||
|
build-essential \
|
||||||
|
git \
|
||||||
|
curl && \
|
||||||
|
# Node.js and Yarn
|
||||||
|
curl -sL https://deb.nodesource.com/setup_20.x -o nodesource_setup.sh && \
|
||||||
|
bash nodesource_setup.sh && \
|
||||||
|
apt-get install -y nodejs && \
|
||||||
|
npm install -g yarn && \
|
||||||
|
# Hex and Rebar
|
||||||
|
mix local.hex --force && \
|
||||||
|
mix local.rebar --force && \
|
||||||
|
# FFmpeg (latest build that doesn't cause an illegal instruction error for some users - see #347)
|
||||||
|
export FFMPEG_DOWNLOAD=$(case ${TARGETPLATFORM:-linux/amd64} in \
|
||||||
|
"linux/amd64") echo "https://github.com/yt-dlp/FFmpeg-Builds/releases/download/autobuild-2024-07-30-14-10/ffmpeg-N-116468-g0e09f6d690-linux64-gpl.tar.xz" ;; \
|
||||||
|
"linux/arm64") echo "https://github.com/yt-dlp/FFmpeg-Builds/releases/download/autobuild-2024-07-30-14-10/ffmpeg-N-116468-g0e09f6d690-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/local/bin/ "ffmpeg" && \
|
||||||
|
tar -xf /tmp/ffmpeg.tar.xz --strip-components=2 --no-anchored -C /usr/local/bin/ "ffprobe" && \
|
||||||
|
# Cleanup
|
||||||
|
apt-get clean && \
|
||||||
|
rm -f /var/lib/apt/lists/*_*
|
||||||
|
|
||||||
|
# prepare build dir
|
||||||
|
WORKDIR /app
|
||||||
|
|
||||||
|
# set build ENV
|
||||||
|
ENV MIX_ENV="prod"
|
||||||
|
ENV ERL_FLAGS="+JPperf true"
|
||||||
|
|
||||||
|
# install mix dependencies
|
||||||
|
COPY mix.exs mix.lock ./
|
||||||
|
RUN mix deps.get --only $MIX_ENV && mkdir config
|
||||||
|
|
||||||
|
# copy compile-time config files before we compile dependencies
|
||||||
|
# to ensure any relevant config change will trigger the dependencies
|
||||||
|
# to be re-compiled.
|
||||||
|
COPY config/config.exs config/${MIX_ENV}.exs config/
|
||||||
|
RUN mix deps.compile
|
||||||
|
|
||||||
|
COPY priv priv
|
||||||
|
COPY lib lib
|
||||||
|
COPY assets assets
|
||||||
|
|
||||||
|
# Compile assets
|
||||||
|
RUN yarn --cwd assets install && mix assets.deploy && mix compile
|
||||||
|
|
||||||
|
# Changes to config/runtime.exs don't require recompiling the code
|
||||||
|
COPY config/runtime.exs config/
|
||||||
|
|
||||||
|
COPY rel rel
|
||||||
|
RUN mix release
|
||||||
|
|
||||||
|
## -- Release Stage --
|
||||||
|
|
||||||
|
FROM ${RUNNER_IMAGE}
|
||||||
|
|
||||||
|
ARG PORT=8945
|
||||||
|
|
||||||
|
COPY --from=builder ./usr/local/bin/ffmpeg /usr/bin/ffmpeg
|
||||||
|
COPY --from=builder ./usr/local/bin/ffprobe /usr/bin/ffprobe
|
||||||
|
|
||||||
|
RUN apt-get update -y && \
|
||||||
|
# System packages
|
||||||
|
apt-get install -y \
|
||||||
|
libstdc++6 \
|
||||||
|
openssl \
|
||||||
|
libncurses5 \
|
||||||
|
locales \
|
||||||
|
ca-certificates \
|
||||||
|
python3-mutagen \
|
||||||
|
curl \
|
||||||
|
openssh-client \
|
||||||
|
nano \
|
||||||
|
python3 \
|
||||||
|
pipx \
|
||||||
|
jq \
|
||||||
|
procps && \
|
||||||
|
# Apprise
|
||||||
|
export PIPX_HOME=/opt/pipx && \
|
||||||
|
export PIPX_BIN_DIR=/usr/local/bin && \
|
||||||
|
pipx install apprise && \
|
||||||
|
# yt-dlp
|
||||||
|
curl -L https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -o /usr/local/bin/yt-dlp && \
|
||||||
|
chmod a+rx /usr/local/bin/yt-dlp && \
|
||||||
|
yt-dlp -U && \
|
||||||
|
# Set the locale
|
||||||
|
sed -i '/en_US.UTF-8/s/^# //g' /etc/locale.gen && locale-gen && \
|
||||||
|
# Clean up
|
||||||
|
apt-get clean && \
|
||||||
|
rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
|
# More locale setup
|
||||||
|
ENV LANG en_US.UTF-8
|
||||||
|
ENV LANGUAGE en_US:en
|
||||||
|
ENV LC_ALL en_US.UTF-8
|
||||||
|
|
||||||
|
WORKDIR "/app"
|
||||||
|
|
||||||
|
# Set up data volumes
|
||||||
|
RUN mkdir /config /downloads /etc/elixir_tzdata_data && chmod ugo+rw /etc/elixir_tzdata_data
|
||||||
|
|
||||||
|
# set runner ENV
|
||||||
|
ENV MIX_ENV="prod"
|
||||||
|
ENV PORT=${PORT}
|
||||||
|
ENV RUN_CONTEXT="selfhosted"
|
||||||
|
EXPOSE ${PORT}
|
||||||
|
|
||||||
|
# Only copy the final release from the build stage
|
||||||
|
COPY --from=builder /app/_build/${MIX_ENV}/rel/pinchflat ./
|
||||||
|
|
||||||
|
# NEVER do this if you're running in an environment where you don't trust the user
|
||||||
|
# (ie: most environments). This is only acceptable in a self-hosted environment.
|
||||||
|
# The user could just run the whole container as root and bypass this anyway so
|
||||||
|
# it's not a huge deal.
|
||||||
|
# This removes the root password to allow users to assume root if needed. This is
|
||||||
|
# preferrable to running the whole container as root so that the files/directories
|
||||||
|
# created by the app aren't owned by root and are therefore easier for other users
|
||||||
|
# and processes to interact with. If you want to just run the whole container as
|
||||||
|
# root, use --user 0:0 or something.
|
||||||
|
RUN passwd -d root
|
||||||
|
|
||||||
|
HEALTHCHECK --interval=120s --start-period=10s \
|
||||||
|
CMD curl --fail http://localhost:${PORT}/healthcheck || exit 1
|
||||||
|
|
||||||
|
# Start the app
|
||||||
|
CMD ["/app/bin/docker_start"]
|
||||||
@@ -1,4 +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
|
|
||||||
@@ -24,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
|
||||||
@@ -40,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,62 +0,0 @@
|
|||||||
defmodule Pinchflat.Boot.DataBackfillWorker do
|
|
||||||
@moduledoc false
|
|
||||||
|
|
||||||
use Oban.Worker,
|
|
||||||
queue: :local_metadata,
|
|
||||||
unique: [period: :infinity, states: [:available, :scheduled, :retryable]],
|
|
||||||
tags: ["media_item", "media_metadata", "local_metadata", "data_backfill"]
|
|
||||||
|
|
||||||
# This one is going to be a little more self-contained
|
|
||||||
# instead of relying on outside modules for the methods.
|
|
||||||
# That's because, for now, these methods are not intended
|
|
||||||
# to be used elsewhere.
|
|
||||||
#
|
|
||||||
# I'm just trying out that pattern and seeing if I like it better
|
|
||||||
# so this may change.
|
|
||||||
import Ecto.Query, warn: false
|
|
||||||
require Logger
|
|
||||||
|
|
||||||
alias __MODULE__
|
|
||||||
alias Pinchflat.Repo
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Cancels all pending backfill jobs. Useful for ensuring worker runs immediately
|
|
||||||
on app boot.
|
|
||||||
|
|
||||||
Returns {:ok, integer()}
|
|
||||||
"""
|
|
||||||
def cancel_pending_backfill_jobs do
|
|
||||||
Oban.Job
|
|
||||||
|> where(worker: "Pinchflat.Boot.DataBackfillWorker")
|
|
||||||
|> Oban.cancel_all_jobs()
|
|
||||||
end
|
|
||||||
|
|
||||||
@impl Oban.Worker
|
|
||||||
@doc """
|
|
||||||
Performs one-off tasks to get data in the right shape.
|
|
||||||
This can be needed when we add new features or change the way
|
|
||||||
we store data. Must be idempotent. All new data should already
|
|
||||||
conform to the expected schema so this should only be needed
|
|
||||||
for existing data. Still runs periodically to be safe.
|
|
||||||
|
|
||||||
Returns :ok
|
|
||||||
"""
|
|
||||||
def perform(%Oban.Job{}) do
|
|
||||||
Logger.info("Running data backfill worker")
|
|
||||||
# Nothing to do for now - just reschedule
|
|
||||||
# Keeping in-place because we _will_ need it in the future
|
|
||||||
|
|
||||||
reschedule_backfill()
|
|
||||||
|
|
||||||
:ok
|
|
||||||
end
|
|
||||||
|
|
||||||
defp reschedule_backfill do
|
|
||||||
# Run hourly
|
|
||||||
next_run_in = 60 * 60
|
|
||||||
|
|
||||||
%{}
|
|
||||||
|> DataBackfillWorker.new(schedule_in: next_run_in)
|
|
||||||
|> Repo.insert_unique_job()
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -11,9 +11,6 @@ defmodule Pinchflat.Boot.PostJobStartupTasks do
|
|||||||
use GenServer, restart: :temporary
|
use GenServer, restart: :temporary
|
||||||
import Ecto.Query, warn: false
|
import Ecto.Query, warn: false
|
||||||
|
|
||||||
alias Pinchflat.Repo
|
|
||||||
alias Pinchflat.Boot.DataBackfillWorker
|
|
||||||
|
|
||||||
def start_link(opts \\ []) do
|
def start_link(opts \\ []) do
|
||||||
GenServer.start_link(__MODULE__, %{}, opts)
|
GenServer.start_link(__MODULE__, %{}, opts)
|
||||||
end
|
end
|
||||||
@@ -29,16 +26,8 @@ defmodule Pinchflat.Boot.PostJobStartupTasks do
|
|||||||
"""
|
"""
|
||||||
@impl true
|
@impl true
|
||||||
def init(state) do
|
def init(state) do
|
||||||
enqueue_backfill_worker()
|
# Nothing at the moment!
|
||||||
|
|
||||||
{:ok, state}
|
{:ok, state}
|
||||||
end
|
end
|
||||||
|
|
||||||
defp enqueue_backfill_worker do
|
|
||||||
DataBackfillWorker.cancel_pending_backfill_jobs()
|
|
||||||
|
|
||||||
%{}
|
|
||||||
|> DataBackfillWorker.new()
|
|
||||||
|> Repo.insert_unique_job()
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ defmodule Pinchflat.Boot.PreJobStartupTasks do
|
|||||||
|
|
||||||
alias Pinchflat.Repo
|
alias Pinchflat.Repo
|
||||||
alias Pinchflat.Settings
|
alias Pinchflat.Settings
|
||||||
alias Pinchflat.Filesystem.FilesystemHelpers
|
alias Pinchflat.Utils.FilesystemUtils
|
||||||
|
|
||||||
def start_link(opts \\ []) do
|
def start_link(opts \\ []) do
|
||||||
GenServer.start_link(__MODULE__, %{}, opts)
|
GenServer.start_link(__MODULE__, %{}, opts)
|
||||||
@@ -31,13 +31,23 @@ defmodule Pinchflat.Boot.PreJobStartupTasks do
|
|||||||
"""
|
"""
|
||||||
@impl true
|
@impl true
|
||||||
def init(state) do
|
def init(state) do
|
||||||
|
ensure_tmpfile_directory()
|
||||||
reset_executing_jobs()
|
reset_executing_jobs()
|
||||||
create_blank_cookie_file()
|
create_blank_yt_dlp_files()
|
||||||
|
create_blank_user_script_file()
|
||||||
apply_default_settings()
|
apply_default_settings()
|
||||||
|
|
||||||
{:ok, state}
|
{:ok, state}
|
||||||
end
|
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
|
# 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
|
# in the "executing" state. This is a problem because the job runner will not
|
||||||
# pick them up again
|
# pick them up again
|
||||||
@@ -50,19 +60,46 @@ defmodule Pinchflat.Boot.PreJobStartupTasks do
|
|||||||
Logger.info("Reset #{count} executing jobs")
|
Logger.info("Reset #{count} executing jobs")
|
||||||
end
|
end
|
||||||
|
|
||||||
defp create_blank_cookie_file do
|
defp create_blank_yt_dlp_files do
|
||||||
|
files = ["cookies.txt", "yt-dlp-configs/base-config.txt"]
|
||||||
base_dir = Application.get_env(:pinchflat, :extras_directory)
|
base_dir = Application.get_env(:pinchflat, :extras_directory)
|
||||||
filepath = Path.join(base_dir, "cookies.txt")
|
|
||||||
|
Enum.each(files, fn file ->
|
||||||
|
filepath = Path.join(base_dir, file)
|
||||||
|
|
||||||
if !File.exists?(filepath) do
|
if !File.exists?(filepath) do
|
||||||
Logger.info("Cookies does not exist - creating it")
|
Logger.info("Creating blank file: #{filepath}")
|
||||||
|
|
||||||
FilesystemHelpers.write_p!(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
|
||||||
end
|
end
|
||||||
|
|
||||||
defp apply_default_settings do
|
defp apply_default_settings do
|
||||||
Settings.fetch!(:onboarding, true)
|
{:ok, yt_dlp_version} = yt_dlp_runner().version()
|
||||||
Settings.fetch!(:pro_enabled, false)
|
{: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
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -3,44 +3,63 @@ defmodule Pinchflat.Downloading.DownloadOptionBuilder do
|
|||||||
Builds the options for yt-dlp to download media based on the given media profile.
|
Builds the options for yt-dlp to download media based on the given media profile.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
alias Pinchflat.Sources
|
||||||
|
alias Pinchflat.Settings
|
||||||
alias Pinchflat.Sources.Source
|
alias Pinchflat.Sources.Source
|
||||||
alias Pinchflat.Media.MediaItem
|
alias Pinchflat.Media.MediaItem
|
||||||
alias Pinchflat.Downloading.OutputPathBuilder
|
alias Pinchflat.Downloading.OutputPathBuilder
|
||||||
|
|
||||||
|
alias Pinchflat.Utils.FilesystemUtils, as: FSUtils
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Builds the options for yt-dlp to download media based on the given media's profile.
|
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
|
Returns {:ok, [Keyword.t()]}
|
||||||
these options
|
|
||||||
"""
|
"""
|
||||||
def build(%MediaItem{} = media_item_with_preloads) do
|
def build(%MediaItem{} = media_item_with_preloads, override_opts \\ []) do
|
||||||
media_profile = media_item_with_preloads.source.media_profile
|
media_profile = media_item_with_preloads.source.media_profile
|
||||||
|
|
||||||
built_options =
|
built_options =
|
||||||
default_options() ++
|
default_options(override_opts) ++
|
||||||
subtitle_options(media_profile) ++
|
subtitle_options(media_profile) ++
|
||||||
thumbnail_options(media_item_with_preloads) ++
|
thumbnail_options(media_item_with_preloads) ++
|
||||||
metadata_options(media_profile) ++
|
metadata_options(media_profile) ++
|
||||||
quality_options(media_profile) ++
|
quality_options(media_profile) ++
|
||||||
output_options(media_item_with_preloads)
|
sponsorblock_options(media_profile) ++
|
||||||
|
output_options(media_item_with_preloads) ++
|
||||||
|
config_file_options(media_item_with_preloads)
|
||||||
|
|
||||||
{:ok, built_options}
|
{:ok, built_options}
|
||||||
end
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Builds the output path for yt-dlp to download media based on the given source's
|
Builds the output path for yt-dlp to download media based on the given source's
|
||||||
media profile.
|
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()
|
Returns binary()
|
||||||
"""
|
"""
|
||||||
def build_output_path_for(%Source{} = source_with_preloads) do
|
def build_output_path_for(%MediaItem{} = media_item_with_preloads) do
|
||||||
output_path_template = source_with_preloads.media_profile.output_path_template
|
output_path_template = Sources.output_path_template(media_item_with_preloads.source)
|
||||||
|
|
||||||
build_output_path(output_path_template, source_with_preloads)
|
build_output_path(output_path_template, media_item_with_preloads)
|
||||||
end
|
end
|
||||||
|
|
||||||
defp default_options do
|
def build_output_path_for(%Source{} = source_with_preloads) do
|
||||||
[:no_progress, :windows_filenames]
|
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
|
end
|
||||||
|
|
||||||
defp subtitle_options(media_profile) do
|
defp subtitle_options(media_profile) do
|
||||||
@@ -55,6 +74,9 @@ defmodule Pinchflat.Downloading.DownloadOptionBuilder do
|
|||||||
{{:download_auto_subs, true}, %{download_subs: true}} ->
|
{{:download_auto_subs, true}, %{download_subs: true}} ->
|
||||||
acc ++ [:write_auto_subs]
|
acc ++ [:write_auto_subs]
|
||||||
|
|
||||||
|
{{:download_auto_subs, true}, %{embed_subs: true}} ->
|
||||||
|
acc ++ [:write_auto_subs]
|
||||||
|
|
||||||
{{:embed_subs, true}, %{preferred_resolution: pr}} when pr != :audio ->
|
{{:embed_subs, true}, %{preferred_resolution: pr}} when pr != :audio ->
|
||||||
acc ++ [:embed_subs]
|
acc ++ [:embed_subs]
|
||||||
|
|
||||||
@@ -103,36 +125,90 @@ defmodule Pinchflat.Downloading.DownloadOptionBuilder do
|
|||||||
end
|
end
|
||||||
|
|
||||||
defp quality_options(media_profile) do
|
defp quality_options(media_profile) do
|
||||||
video_codec_options = "+codec:avc:m4a"
|
vcodec = Settings.get!(:video_codec_preference)
|
||||||
|
acodec = Settings.get!(:audio_codec_preference)
|
||||||
|
container = media_profile.media_container
|
||||||
|
|
||||||
case media_profile.preferred_resolution do
|
case media_profile.preferred_resolution do
|
||||||
# Also be aware that :audio disabled all embedding options for subtitles
|
# Also be aware that :audio disabled all embedding options for subtitles
|
||||||
:audio -> [:extract_audio, format: "bestaudio[ext=m4a]"]
|
:audio ->
|
||||||
:"360p" -> [format_sort: "res:360,#{video_codec_options}"]
|
[:extract_audio, format_sort: "+acodec:#{acodec}", audio_format: container || "best"]
|
||||||
:"480p" -> [format_sort: "res:480,#{video_codec_options}"]
|
|
||||||
:"720p" -> [format_sort: "res:720,#{video_codec_options}"]
|
resolution_atom ->
|
||||||
:"1080p" -> [format_sort: "res:1080,#{video_codec_options}"]
|
{resolution_string, _} =
|
||||||
:"2160p" -> [format_sort: "res:2160,#{video_codec_options}"]
|
resolution_atom
|
||||||
|
|> Atom.to_string()
|
||||||
|
|> Integer.parse()
|
||||||
|
|
||||||
|
[
|
||||||
|
# Since Plex doesn't support reading metadata from MKV
|
||||||
|
remux_video: container || "mp4",
|
||||||
|
format_sort: "res:#{resolution_string},+codec:#{vcodec}:#{acodec}"
|
||||||
|
]
|
||||||
end
|
end
|
||||||
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
|
defp output_options(media_item_with_preloads) do
|
||||||
[
|
[
|
||||||
output: build_output_path_for(media_item_with_preloads.source)
|
output: build_output_path_for(media_item_with_preloads)
|
||||||
]
|
]
|
||||||
end
|
end
|
||||||
|
|
||||||
defp build_output_path(string, source) do
|
defp build_output_path(string, media_item_with_preloads) do
|
||||||
additional_options_map = output_options_map(source)
|
additional_options_map = output_options_map(media_item_with_preloads)
|
||||||
{:ok, output_path} = OutputPathBuilder.build(string, additional_options_map)
|
{:ok, output_path} = OutputPathBuilder.build(string, additional_options_map)
|
||||||
|
|
||||||
Path.join(base_directory(), output_path)
|
Path.join(base_directory(), output_path)
|
||||||
end
|
end
|
||||||
|
|
||||||
defp output_options_map(source) do
|
defp output_options_map(media_item_with_preloads) do
|
||||||
|
source = media_item_with_preloads.source
|
||||||
|
|
||||||
%{
|
%{
|
||||||
"source_custom_name" => source.custom_name,
|
"source_custom_name" => source.custom_name,
|
||||||
"source_collection_type" => source.collection_type
|
"source_collection_id" => source.collection_id,
|
||||||
|
"source_collection_name" => source.collection_name,
|
||||||
|
"source_collection_type" => to_string(source.collection_type),
|
||||||
|
"media_playlist_index" => pad_int(media_item_with_preloads.playlist_index),
|
||||||
|
"media_upload_date_index" => pad_int(media_item_with_preloads.upload_date_index)
|
||||||
}
|
}
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -140,13 +216,19 @@ defmodule Pinchflat.Downloading.DownloadOptionBuilder do
|
|||||||
# It's dependent on the output_path_template being a string ending `.{{ ext }}`
|
# It's dependent on the output_path_template being a string ending `.{{ ext }}`
|
||||||
# (or equivalent), but that's validated by the MediaProfile schema.
|
# (or equivalent), but that's validated by the MediaProfile schema.
|
||||||
defp determine_thumbnail_location(media_item_with_preloads) do
|
defp determine_thumbnail_location(media_item_with_preloads) do
|
||||||
output_path_template = media_item_with_preloads.source.media_profile.output_path_template
|
output_path_template = Sources.output_path_template(media_item_with_preloads.source)
|
||||||
|
|
||||||
output_path_template
|
output_path_template
|
||||||
|> String.split(~r{\.}, include_captures: true)
|
|> String.split(~r{\.}, include_captures: true)
|
||||||
|> List.insert_at(-3, "-thumb")
|
|> List.insert_at(-3, "-thumb")
|
||||||
|> Enum.join()
|
|> Enum.join()
|
||||||
|> build_output_path(media_item_with_preloads.source)
|
|> build_output_path(media_item_with_preloads)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp pad_int(integer, count \\ 2, padding \\ "0") do
|
||||||
|
integer
|
||||||
|
|> to_string()
|
||||||
|
|> String.pad_leading(count, padding)
|
||||||
end
|
end
|
||||||
|
|
||||||
defp base_directory do
|
defp base_directory do
|
||||||
|
|||||||
@@ -7,9 +7,13 @@ defmodule Pinchflat.Downloading.DownloadingHelpers do
|
|||||||
|
|
||||||
require Logger
|
require Logger
|
||||||
|
|
||||||
|
use Pinchflat.Media.MediaQuery
|
||||||
|
|
||||||
|
alias Pinchflat.Repo
|
||||||
alias Pinchflat.Media
|
alias Pinchflat.Media
|
||||||
alias Pinchflat.Tasks
|
alias Pinchflat.Tasks
|
||||||
alias Pinchflat.Sources.Source
|
alias Pinchflat.Sources.Source
|
||||||
|
alias Pinchflat.Media.MediaItem
|
||||||
alias Pinchflat.Downloading.MediaDownloadWorker
|
alias Pinchflat.Downloading.MediaDownloadWorker
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
@@ -43,4 +47,54 @@ defmodule Pinchflat.Downloading.DownloadingHelpers do
|
|||||||
|> Media.list_pending_media_items_for()
|
|> Media.list_pending_media_items_for()
|
||||||
|> Enum.each(&Tasks.delete_pending_tasks_for/1)
|
|> Enum.each(&Tasks.delete_pending_tasks_for/1)
|
||||||
end
|
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())
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|> Repo.all()
|
||||||
|
|> Enum.map(&MediaDownloadWorker.kickoff_with_task/1)
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ defmodule Pinchflat.Downloading.MediaDownloadWorker do
|
|||||||
use Oban.Worker,
|
use Oban.Worker,
|
||||||
queue: :media_fetching,
|
queue: :media_fetching,
|
||||||
unique: [period: :infinity, states: [:available, :scheduled, :retryable, :executing]],
|
unique: [period: :infinity, states: [:available, :scheduled, :retryable, :executing]],
|
||||||
tags: ["media_item", "media_fetching"]
|
tags: ["media_item", "media_fetching", "show_in_dashboard"]
|
||||||
|
|
||||||
require Logger
|
require Logger
|
||||||
|
|
||||||
@@ -12,35 +12,46 @@ defmodule Pinchflat.Downloading.MediaDownloadWorker do
|
|||||||
alias Pinchflat.Tasks
|
alias Pinchflat.Tasks
|
||||||
alias Pinchflat.Repo
|
alias Pinchflat.Repo
|
||||||
alias Pinchflat.Media
|
alias Pinchflat.Media
|
||||||
|
alias Pinchflat.Media.FileSyncing
|
||||||
alias Pinchflat.Downloading.MediaDownloader
|
alias Pinchflat.Downloading.MediaDownloader
|
||||||
|
|
||||||
|
alias Pinchflat.Lifecycle.UserScripts.CommandRunner, as: UserScriptRunner
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Starts the media_item media download worker and creates a task for the media_item.
|
Starts the media_item media download worker and creates a task for the media_item.
|
||||||
|
|
||||||
Returns {:ok, %Task{}} | {:error, :duplicate_job} | {:error, %Ecto.Changeset{}}
|
Returns {:ok, %Task{}} | {:error, :duplicate_job} | {:error, %Ecto.Changeset{}}
|
||||||
"""
|
"""
|
||||||
def kickoff_with_task(media_item, opts \\ []) do
|
def kickoff_with_task(media_item, job_args \\ %{}, job_opts \\ []) do
|
||||||
%{id: media_item.id}
|
%{id: media_item.id}
|
||||||
|> MediaDownloadWorker.new(opts)
|
|> Map.merge(job_args)
|
||||||
|
|> MediaDownloadWorker.new(job_opts)
|
||||||
|> Tasks.create_job_with_task(media_item)
|
|> Tasks.create_job_with_task(media_item)
|
||||||
end
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
For a given media item, download the media alongside any options.
|
For a given media item, download the media alongside any options.
|
||||||
Does not download media if its source is set to not download media.
|
Does not download media if its source is set to not download media
|
||||||
|
(unless forced).
|
||||||
|
|
||||||
Returns :ok | {:ok, %MediaItem{}} | {:error, any, ...any}
|
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 | {:error, any, ...any}
|
||||||
"""
|
"""
|
||||||
@impl Oban.Worker
|
@impl Oban.Worker
|
||||||
def perform(%Oban.Job{args: %{"id" => media_item_id}}) do
|
def perform(%Oban.Job{args: %{"id" => media_item_id} = args}) do
|
||||||
media_item =
|
should_force = Map.get(args, "force", false)
|
||||||
media_item_id
|
is_quality_upgrade = Map.get(args, "quality_upgrade?", false)
|
||||||
|> Media.get_media_item!()
|
|
||||||
|> Repo.preload(:source)
|
|
||||||
|
|
||||||
# If the source is set to not download media, perform a no-op
|
media_item = fetch_and_run_prevent_download_user_script(media_item_id)
|
||||||
if media_item.source.download_media do
|
|
||||||
download_media_and_schedule_jobs(media_item)
|
# 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
|
else
|
||||||
:ok
|
:ok
|
||||||
end
|
end
|
||||||
@@ -49,25 +60,74 @@ defmodule Pinchflat.Downloading.MediaDownloadWorker do
|
|||||||
Ecto.StaleEntryError -> Logger.info("#{__MODULE__} discarded: media item #{media_item_id} stale")
|
Ecto.StaleEntryError -> Logger.info("#{__MODULE__} discarded: media item #{media_item_id} stale")
|
||||||
end
|
end
|
||||||
|
|
||||||
defp download_media_and_schedule_jobs(media_item) do
|
# If a user script exists and, when run, returns a non-zero exit code, prevent this and all future downloads
|
||||||
case MediaDownloader.download_for_media_item(media_item) do
|
# of the media item.
|
||||||
{:ok, updated_media_item} ->
|
defp fetch_and_run_prevent_download_user_script(media_item_id) do
|
||||||
compute_and_save_media_filesize(updated_media_item)
|
media_item = Media.get_media_item!(media_item_id)
|
||||||
|
|
||||||
{:ok, updated_media_item}
|
{:ok, media_item} =
|
||||||
|
case run_user_script(:media_pre_download, media_item) do
|
||||||
err ->
|
{:ok, _, exit_code} when exit_code != 0 -> Media.update_media_item(media_item, %{prevent_download: true})
|
||||||
err
|
_ -> {:ok, media_item}
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
defp compute_and_save_media_filesize(media_item) do
|
Repo.preload(media_item, :source)
|
||||||
case File.stat(media_item.media_filepath) do
|
end
|
||||||
{:ok, %{size: size}} ->
|
|
||||||
Media.update_media_item(media_item, %{media_size_bytes: size})
|
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 = FileSyncing.delete_outdated_files(media_item, updated_media_item)
|
||||||
|
run_user_script(:media_downloaded, updated_media_item)
|
||||||
|
|
||||||
_ ->
|
|
||||||
:ok
|
:ok
|
||||||
|
|
||||||
|
{:recovered, _} ->
|
||||||
|
{:error, :retry}
|
||||||
|
|
||||||
|
{:error, message} ->
|
||||||
|
action_on_error(message)
|
||||||
end
|
end
|
||||||
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(event, media_item) do
|
||||||
|
runner = Application.get_env(:pinchflat, :user_script_runner, UserScriptRunner)
|
||||||
|
|
||||||
|
runner.run(event, media_item)
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -5,12 +5,15 @@ defmodule Pinchflat.Downloading.MediaDownloader do
|
|||||||
to download the media with the desired options.
|
to download the media with the desired options.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
alias Pinchflat.Repo
|
alias Pinchflat.Repo
|
||||||
alias Pinchflat.Media
|
alias Pinchflat.Media
|
||||||
alias Pinchflat.Media.MediaItem
|
alias Pinchflat.Media.MediaItem
|
||||||
alias Pinchflat.Metadata.NfoBuilder
|
alias Pinchflat.Metadata.NfoBuilder
|
||||||
alias Pinchflat.Metadata.MetadataParser
|
alias Pinchflat.Metadata.MetadataParser
|
||||||
alias Pinchflat.Metadata.MetadataFileHelpers
|
alias Pinchflat.Metadata.MetadataFileHelpers
|
||||||
|
alias Pinchflat.Utils.FilesystemUtils
|
||||||
alias Pinchflat.Downloading.DownloadOptionBuilder
|
alias Pinchflat.Downloading.DownloadOptionBuilder
|
||||||
|
|
||||||
alias Pinchflat.YtDlp.Media, as: YtDlpMedia
|
alias Pinchflat.YtDlp.Media, as: YtDlpMedia
|
||||||
@@ -26,32 +29,69 @@ defmodule Pinchflat.Downloading.MediaDownloader do
|
|||||||
|
|
||||||
Returns {:ok, %MediaItem{}} | {:error, any, ...any}
|
Returns {:ok, %MediaItem{}} | {:error, any, ...any}
|
||||||
"""
|
"""
|
||||||
def download_for_media_item(%MediaItem{} = media_item) do
|
def download_for_media_item(%MediaItem{} = media_item, override_opts \\ []) do
|
||||||
item_with_preloads = Repo.preload(media_item, [:metadata, source: :media_profile])
|
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, item_with_preloads) do
|
case download_with_options(media_item.original_url, media_with_preloads, output_filepath, override_opts) do
|
||||||
{:ok, parsed_json} ->
|
{: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_attrs =
|
||||||
parsed_json
|
parsed_json
|
||||||
|> MetadataParser.parse_for_media_item()
|
|> MetadataParser.parse_for_media_item()
|
||||||
|> Map.merge(%{
|
|> Map.merge(%{
|
||||||
media_downloaded_at: DateTime.utc_now(),
|
media_downloaded_at: DateTime.utc_now(),
|
||||||
nfo_filepath: determine_nfo_filepath(item_with_preloads, parsed_json),
|
culled_at: nil,
|
||||||
|
nfo_filepath: determine_nfo_filepath(media_with_preloads, parsed_json),
|
||||||
metadata: %{
|
metadata: %{
|
||||||
# IDEA: might be worth kicking off a job for this since thumbnail fetching
|
# IDEA: might be worth kicking off a job for this since thumbnail fetching
|
||||||
# could fail and I want to handle that in isolation
|
# could fail and I want to handle that in isolation
|
||||||
metadata_filepath: MetadataFileHelpers.compress_and_store_metadata_for(media_item, parsed_json),
|
metadata_filepath: MetadataFileHelpers.compress_and_store_metadata_for(media_with_preloads, parsed_json),
|
||||||
thumbnail_filepath: MetadataFileHelpers.download_and_store_thumbnail_for(media_item, parsed_json)
|
thumbnail_filepath: MetadataFileHelpers.download_and_store_thumbnail_for(media_with_preloads)
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
# Don't forgor to use preloaded associations or updates to
|
# Don't forgor to use preloaded associations or updates to
|
||||||
# associations won't work!
|
# associations won't work!
|
||||||
Media.update_media_item(item_with_preloads, parsed_attrs)
|
Media.update_media_item(media_with_preloads, parsed_attrs)
|
||||||
|
|
||||||
err ->
|
|
||||||
err
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
defp determine_nfo_filepath(media_item, parsed_json) do
|
defp determine_nfo_filepath(media_item, parsed_json) do
|
||||||
@@ -64,9 +104,16 @@ defmodule Pinchflat.Downloading.MediaDownloader do
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
defp download_with_options(url, item_with_preloads) do
|
defp download_with_options(url, item_with_preloads, output_filepath, override_opts) do
|
||||||
{:ok, options} = DownloadOptionBuilder.build(item_with_preloads)
|
{:ok, options} = DownloadOptionBuilder.build(item_with_preloads, override_opts)
|
||||||
|
runner_opts = [output_filepath: output_filepath, use_cookies: item_with_preloads.source.use_cookies]
|
||||||
|
|
||||||
YtDlpMedia.download(url, options)
|
YtDlpMedia.download(url, options, runner_opts)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp recoverable_errors do
|
||||||
|
[
|
||||||
|
"Unable to communicate with SponsorBlock"
|
||||||
|
]
|
||||||
end
|
end
|
||||||
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
|
||||||
|
upgradable_media = Media.list_upgradeable_media_items()
|
||||||
|
Logger.info("Redownloading #{length(upgradable_media)} media items")
|
||||||
|
|
||||||
|
Enum.each(upgradable_media, fn media_item ->
|
||||||
|
MediaDownloadWorker.kickoff_with_task(media_item, %{quality_upgrade?: true})
|
||||||
|
end)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,73 @@
|
|||||||
|
defmodule Pinchflat.Downloading.MediaRetentionWorker do
|
||||||
|
@moduledoc false
|
||||||
|
|
||||||
|
use Oban.Worker,
|
||||||
|
queue: :local_data,
|
||||||
|
unique: [period: :infinity, states: [:available, :scheduled, :retryable, :executing]],
|
||||||
|
tags: ["media_item", "local_data"]
|
||||||
|
|
||||||
|
use Pinchflat.Media.MediaQuery
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias Pinchflat.Repo
|
||||||
|
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
|
||||||
|
cull_cullable_media_items()
|
||||||
|
delete_media_items_from_before_cutoff()
|
||||||
|
|
||||||
|
:ok
|
||||||
|
end
|
||||||
|
|
||||||
|
defp cull_cullable_media_items do
|
||||||
|
cullable_media =
|
||||||
|
MediaQuery.new()
|
||||||
|
|> MediaQuery.require_assoc(:source)
|
||||||
|
|> where(^MediaQuery.cullable())
|
||||||
|
|> Repo.all()
|
||||||
|
|
||||||
|
Logger.info("Culling #{length(cullable_media)} media items past their retention date")
|
||||||
|
|
||||||
|
Enum.each(cullable_media, fn media_item ->
|
||||||
|
# Setting `prevent_download` does what it says on the tin, but `culled_at` is purely informational.
|
||||||
|
# We don't actually do anything with that in terms of queries and it gets set to nil if the media item
|
||||||
|
# gets re-downloaded.
|
||||||
|
Media.delete_media_files(media_item, %{
|
||||||
|
prevent_download: true,
|
||||||
|
culled_at: DateTime.utc_now()
|
||||||
|
})
|
||||||
|
end)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp delete_media_items_from_before_cutoff do
|
||||||
|
deletable_media =
|
||||||
|
MediaQuery.new()
|
||||||
|
|> MediaQuery.require_assoc(:source)
|
||||||
|
|> where(^MediaQuery.deletable_based_on_source_cutoff())
|
||||||
|
|> Repo.all()
|
||||||
|
|
||||||
|
Logger.info("Deleting #{length(deletable_media)} media items that are from before the source cutoff")
|
||||||
|
|
||||||
|
Enum.each(deletable_media, fn media_item ->
|
||||||
|
# Note that I'm not setting `prevent_download` on the media_item here.
|
||||||
|
# That's because cutoff_date can easily change and it's a valid behavior to re-download older
|
||||||
|
# media items if the cutoff_date changes.
|
||||||
|
# Download is ultimately prevented because `MediaQuery.pending()` only returns media items
|
||||||
|
# from after the cutoff date (among other things), so it's not like the media will just immediately
|
||||||
|
# be re-downloaded.
|
||||||
|
Media.delete_media_files(media_item, %{
|
||||||
|
culled_at: DateTime.utc_now()
|
||||||
|
})
|
||||||
|
end)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -9,13 +9,23 @@ defmodule Pinchflat.Downloading.OutputPathBuilder do
|
|||||||
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
|
||||||
@@ -43,7 +53,13 @@ defmodule Pinchflat.Downloading.OutputPathBuilder do
|
|||||||
"upload_yyyy_mm_dd" => "%(upload_date>%Y-%m-%d)S",
|
"upload_yyyy_mm_dd" => "%(upload_date>%Y-%m-%d)S",
|
||||||
"season_from_date" => "%(upload_date>%Y)S",
|
"season_from_date" => "%(upload_date>%Y)S",
|
||||||
"season_episode_from_date" => "s%(upload_date>%Y)Se%(upload_date>%m%d)S",
|
"season_episode_from_date" => "s%(upload_date>%Y)Se%(upload_date>%m%d)S",
|
||||||
"artist_name" => "%(artist,creator,uploader,uploader_id)S"
|
"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",
|
||||||
|
"static_season__episode_by_index" => "Season 1/s01e{{ media_playlist_index }}",
|
||||||
|
"static_season__episode_by_date" => "Season 1/s01e%(upload_date>%y%m%d)S",
|
||||||
|
"season_by_year__episode_by_date" => "Season %(upload_date>%Y)S/s%(upload_date>%Y)Se%(upload_date>%m%d)S",
|
||||||
|
"season_by_year__episode_by_date_and_index" =>
|
||||||
|
"Season %(upload_date>%Y)S/s%(upload_date>%Y)Se%(upload_date>%m%d)S{{ media_upload_date_index }}"
|
||||||
}
|
}
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -5,65 +5,75 @@ defmodule Pinchflat.FastIndexing.FastIndexingHelpers do
|
|||||||
Many of these methods are made to be kickoff or be consumed by workers.
|
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.Media
|
||||||
alias Pinchflat.Sources.Source
|
alias Pinchflat.Sources.Source
|
||||||
alias Pinchflat.FastIndexing.YoutubeRss
|
alias Pinchflat.FastIndexing.YoutubeRss
|
||||||
alias Pinchflat.Downloading.MediaDownloadWorker
|
alias Pinchflat.FastIndexing.YoutubeApi
|
||||||
alias Pinchflat.FastIndexing.MediaIndexingWorker
|
alias Pinchflat.Downloading.DownloadingHelpers
|
||||||
|
|
||||||
alias Pinchflat.YtDlp.Media, as: YtDlpMedia
|
alias Pinchflat.YtDlp.Media, as: YtDlpMedia
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Fetches new media IDs from a source's YouTube RSS feed and kicks off indexing tasks
|
Fetches new media IDs for a source from YT's API or RSS, indexes them, and kicks off downloading
|
||||||
for any new media items. See comments in `MediaIndexingWorker` for more info on the
|
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.
|
order of operations and how this fits into the indexing process.
|
||||||
|
|
||||||
Despite the similar name to `kickoff_fast_indexing_task`, this does work differently.
|
Returns [%MediaItem{}] where each item is a new media item that was created _but not necessarily
|
||||||
`kickoff_fast_indexing_task` starts a task that _calls_ this function whereas this
|
downloaded_.
|
||||||
function starts individual indexing tasks for each new media item. I think it does
|
|
||||||
make sense grammatically, but I could see how that's confusing.
|
|
||||||
|
|
||||||
Returns :ok
|
|
||||||
"""
|
"""
|
||||||
def kickoff_indexing_tasks_from_youtube_rss_feed(%Source{} = source) do
|
def kickoff_download_tasks_from_youtube_rss_feed(%Source{} = source) do
|
||||||
{:ok, media_ids} = YoutubeRss.get_recent_media_ids_from_rss(source)
|
{:ok, media_ids} = get_recent_media_ids(source)
|
||||||
existing_media_items = Media.list_media_items_by_media_id_for(source, media_ids)
|
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)
|
new_media_ids = media_ids -- Enum.map(existing_media_items, & &1.media_id)
|
||||||
|
|
||||||
Enum.each(new_media_ids, fn 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
|
||||||
|
|
||||||
|
# If possible, use the YouTube API to fetch media IDs. If that fails, fall back to the RSS feed.
|
||||||
|
# If the YouTube API isn't set up, just use the RSS feed.
|
||||||
|
defp get_recent_media_ids(source) do
|
||||||
|
with true <- YoutubeApi.enabled?(),
|
||||||
|
{:ok, media_ids} <- YoutubeApi.get_recent_media_ids(source) do
|
||||||
|
{:ok, media_ids}
|
||||||
|
else
|
||||||
|
_ -> YoutubeRss.get_recent_media_ids(source)
|
||||||
|
end
|
||||||
|
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}"
|
url = "https://www.youtube.com/watch?v=#{media_id}"
|
||||||
|
|
||||||
MediaIndexingWorker.kickoff_with_task(source, url)
|
case YtDlpMedia.get_media_attributes(url, use_cookies: source.use_cookies) do
|
||||||
end)
|
{:ok, media_attrs} ->
|
||||||
end
|
Media.create_media_item_from_backend_attrs(source, media_attrs)
|
||||||
|
|
||||||
@doc """
|
|
||||||
Indexes a single media item for a source and enqueues a download job if the
|
|
||||||
media should be downloaded. This method creates the media item record so it's
|
|
||||||
the one-stop-shop for adding a media item (and possibly downloading it) just
|
|
||||||
by a URL and source.
|
|
||||||
|
|
||||||
Returns {:ok, media_item} | {:error, any()}
|
|
||||||
"""
|
|
||||||
def index_and_enqueue_download_for_media_item(%Source{} = source, url) do
|
|
||||||
maybe_media_item = create_media_item_from_url(source, url)
|
|
||||||
|
|
||||||
case maybe_media_item do
|
|
||||||
{:ok, media_item} ->
|
|
||||||
if source.download_media && Media.pending_download?(media_item) do
|
|
||||||
MediaDownloadWorker.kickoff_with_task(media_item)
|
|
||||||
end
|
|
||||||
|
|
||||||
{:ok, media_item}
|
|
||||||
|
|
||||||
err ->
|
err ->
|
||||||
err
|
err
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
defp create_media_item_from_url(source, url) do
|
|
||||||
{:ok, media_attrs} = YtDlpMedia.get_media_attributes(url)
|
|
||||||
|
|
||||||
Media.create_media_item_from_backend_attrs(source, media_attrs)
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -4,15 +4,18 @@ defmodule Pinchflat.FastIndexing.FastIndexingWorker do
|
|||||||
use Oban.Worker,
|
use Oban.Worker,
|
||||||
queue: :fast_indexing,
|
queue: :fast_indexing,
|
||||||
unique: [period: :infinity, states: [:available, :scheduled, :retryable]],
|
unique: [period: :infinity, states: [:available, :scheduled, :retryable]],
|
||||||
tags: ["media_source", "fast_indexing"]
|
tags: ["media_source", "fast_indexing", "show_in_dashboard"]
|
||||||
|
|
||||||
require Logger
|
require Logger
|
||||||
|
|
||||||
alias __MODULE__
|
alias __MODULE__
|
||||||
alias Pinchflat.Tasks
|
alias Pinchflat.Tasks
|
||||||
|
alias Pinchflat.Media
|
||||||
alias Pinchflat.Sources
|
alias Pinchflat.Sources
|
||||||
|
alias Pinchflat.Settings
|
||||||
alias Pinchflat.Sources.Source
|
alias Pinchflat.Sources.Source
|
||||||
alias Pinchflat.FastIndexing.FastIndexingHelpers
|
alias Pinchflat.FastIndexing.FastIndexingHelpers
|
||||||
|
alias Pinchflat.Lifecycle.Notifications.SourceNotifications
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Starts the source fast indexing worker and creates a task for the source.
|
Starts the source fast indexing worker and creates a task for the source.
|
||||||
@@ -26,9 +29,21 @@ defmodule Pinchflat.FastIndexing.FastIndexingWorker do
|
|||||||
end
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Kicks off the fast indexing process for a source, reschedules the job to run again
|
Similar to `MediaCollectionIndexingWorker`, but for working with RSS feeds.
|
||||||
once complete. See `MediaCollectionIndexingWorker` and `MediaIndexingWorker` comments
|
`MediaCollectionIndexingWorker` should be preferred in general, but this is
|
||||||
for more
|
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{}}
|
Returns :ok | {:ok, :job_exists} | {:ok, %Task{}}
|
||||||
"""
|
"""
|
||||||
@@ -37,8 +52,7 @@ defmodule Pinchflat.FastIndexing.FastIndexingWorker do
|
|||||||
source = Sources.get_source!(source_id)
|
source = Sources.get_source!(source_id)
|
||||||
|
|
||||||
if source.fast_index do
|
if source.fast_index do
|
||||||
FastIndexingHelpers.kickoff_indexing_tasks_from_youtube_rss_feed(source)
|
perform_indexing_and_send_notification(source)
|
||||||
|
|
||||||
reschedule_indexing(source)
|
reschedule_indexing(source)
|
||||||
else
|
else
|
||||||
:ok
|
:ok
|
||||||
@@ -48,6 +62,19 @@ defmodule Pinchflat.FastIndexing.FastIndexingWorker do
|
|||||||
Ecto.StaleEntryError -> Logger.info("#{__MODULE__} discarded: source #{source_id} stale")
|
Ecto.StaleEntryError -> Logger.info("#{__MODULE__} discarded: source #{source_id} stale")
|
||||||
end
|
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
|
defp reschedule_indexing(source) do
|
||||||
next_run_in = Source.fast_index_frequency() * 60
|
next_run_in = Source.fast_index_frequency() * 60
|
||||||
|
|
||||||
|
|||||||
@@ -1,69 +0,0 @@
|
|||||||
defmodule Pinchflat.FastIndexing.MediaIndexingWorker do
|
|
||||||
@moduledoc false
|
|
||||||
|
|
||||||
use Oban.Worker,
|
|
||||||
queue: :media_indexing,
|
|
||||||
unique: [period: :infinity, states: [:available, :scheduled, :retryable]],
|
|
||||||
tags: ["media_source", "media_indexing"]
|
|
||||||
|
|
||||||
require Logger
|
|
||||||
|
|
||||||
alias __MODULE__
|
|
||||||
alias Pinchflat.Tasks
|
|
||||||
alias Pinchflat.Sources
|
|
||||||
alias Pinchflat.FastIndexing.FastIndexingHelpers
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Starts the fast media indexing worker and creates a task for the source.
|
|
||||||
|
|
||||||
Returns {:ok, %Task{}} | {:error, :duplicate_job} | {:error, %Ecto.Changeset{}}
|
|
||||||
"""
|
|
||||||
def kickoff_with_task(source, media_url, opts \\ []) do
|
|
||||||
%{id: source.id, media_url: media_url}
|
|
||||||
|> MediaIndexingWorker.new(opts)
|
|
||||||
|> Tasks.create_job_with_task(source)
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Similar to `MediaCollectionIndexingWorker`, but for individual media items.
|
|
||||||
Does not reschedule or check anything to do with a source's indexing
|
|
||||||
frequency - only collects initial metadata then kicks off a download.
|
|
||||||
`MediaCollectionIndexingWorker` should be preferred in general, but this is
|
|
||||||
useful for downloading one-off media items based on a URL (like for fast indexing).
|
|
||||||
|
|
||||||
Only downloads media that _should_ be downloaded (ie: the source is set to download
|
|
||||||
and the media matches the profile's format preferences)
|
|
||||||
|
|
||||||
Order of operations:
|
|
||||||
1. FastIndexingHelpers.kickoff_indexing_tasks_from_youtube_rss_feed/1 (which is running
|
|
||||||
in its own worker) periodically checks the YouTube RSS feed for new media
|
|
||||||
2. If new media is found, it enqueues a MediaIndexingWorker (this module) for each new media
|
|
||||||
item
|
|
||||||
3. This worker fetches the media metadata and uses that to determine if it should be
|
|
||||||
downloaded. If so, it enqueues a MediaDownloadWorker
|
|
||||||
|
|
||||||
Each is a worker because they all either need to be scheduled periodically or call out to
|
|
||||||
an external service and will be long-running. They're split into different jobs to separate
|
|
||||||
retry logic for each step and allow us to better optimize various queues (eg: the indexing
|
|
||||||
steps can keep running while the slow download steps are worked through).
|
|
||||||
|
|
||||||
Returns :ok
|
|
||||||
"""
|
|
||||||
@impl Oban.Worker
|
|
||||||
def perform(%Oban.Job{args: %{"id" => source_id, "media_url" => media_url}}) do
|
|
||||||
source = Sources.get_source!(source_id)
|
|
||||||
|
|
||||||
case FastIndexingHelpers.index_and_enqueue_download_for_media_item(source, media_url) do
|
|
||||||
{:ok, media_item} ->
|
|
||||||
Logger.debug("Indexed and enqueued download for url: #{media_url} (media item: #{media_item.id})")
|
|
||||||
|
|
||||||
{:error, reason} ->
|
|
||||||
Logger.debug("Failed to index and enqueue download for url: #{media_url} (reason: #{inspect(reason)})")
|
|
||||||
end
|
|
||||||
|
|
||||||
:ok
|
|
||||||
rescue
|
|
||||||
Ecto.NoResultsError -> Logger.info("#{__MODULE__} discarded: source #{source_id} not found")
|
|
||||||
Ecto.StaleEntryError -> Logger.info("#{__MODULE__} discarded: source #{source_id} stale")
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -0,0 +1,92 @@
|
|||||||
|
defmodule Pinchflat.FastIndexing.YoutubeApi do
|
||||||
|
@moduledoc """
|
||||||
|
Methods for interacting with the YouTube API for fast indexing
|
||||||
|
"""
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias Pinchflat.Settings
|
||||||
|
alias Pinchflat.Sources.Source
|
||||||
|
alias Pinchflat.Utils.FunctionUtils
|
||||||
|
alias Pinchflat.FastIndexing.YoutubeBehaviour
|
||||||
|
|
||||||
|
@behaviour YoutubeBehaviour
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Determines if the YouTube API is enabled for fast indexing by checking
|
||||||
|
if the user has an API key set
|
||||||
|
|
||||||
|
Returns boolean()
|
||||||
|
"""
|
||||||
|
@impl YoutubeBehaviour
|
||||||
|
def enabled?(), do: is_binary(api_key())
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Fetches the recent media IDs from the YouTube API for a given source.
|
||||||
|
|
||||||
|
Returns {:ok, [binary()]} | {:error, binary()}
|
||||||
|
"""
|
||||||
|
@impl YoutubeBehaviour
|
||||||
|
def get_recent_media_ids(%Source{} = source) do
|
||||||
|
api_response =
|
||||||
|
source
|
||||||
|
|> determine_playlist_id()
|
||||||
|
|> do_api_request()
|
||||||
|
|
||||||
|
case api_response do
|
||||||
|
{:ok, parsed_json} -> get_media_ids_from_response(parsed_json)
|
||||||
|
{:error, reason} -> {:error, reason}
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# The UC prefix is for channels which won't work with this API endpoint. Swapping
|
||||||
|
# the prefix to UU will get us the playlist that represents the channel's uploads
|
||||||
|
defp determine_playlist_id(%{collection_id: c_id}) do
|
||||||
|
String.replace_prefix(c_id, "UC", "UU")
|
||||||
|
end
|
||||||
|
|
||||||
|
defp do_api_request(playlist_id) do
|
||||||
|
Logger.debug("Fetching recent media IDs from YouTube API for playlist: #{playlist_id}")
|
||||||
|
|
||||||
|
playlist_id
|
||||||
|
|> construct_api_endpoint()
|
||||||
|
|> http_client().get(accept: "application/json")
|
||||||
|
|> case do
|
||||||
|
{:ok, response} ->
|
||||||
|
Phoenix.json_library().decode(response)
|
||||||
|
|
||||||
|
{:error, reason} ->
|
||||||
|
Logger.error("Failed to fetch YouTube API: #{inspect(reason)}")
|
||||||
|
{:error, reason}
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp get_media_ids_from_response(parsed_json) do
|
||||||
|
parsed_json
|
||||||
|
|> Map.get("items", [])
|
||||||
|
|> Enum.map(fn item ->
|
||||||
|
item
|
||||||
|
|> Map.get("contentDetails", %{})
|
||||||
|
|> Map.get("videoId", nil)
|
||||||
|
end)
|
||||||
|
|> Enum.reject(&is_nil/1)
|
||||||
|
|> Enum.uniq()
|
||||||
|
|> FunctionUtils.wrap_ok()
|
||||||
|
end
|
||||||
|
|
||||||
|
defp api_key do
|
||||||
|
Settings.get!(:youtube_api_key)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp construct_api_endpoint(playlist_id) do
|
||||||
|
api_base = "https://youtube.googleapis.com/youtube/v3/playlistItems"
|
||||||
|
property_type = "contentDetails"
|
||||||
|
max_results = 50
|
||||||
|
|
||||||
|
"#{api_base}?part=#{property_type}&maxResults=#{max_results}&playlistId=#{playlist_id}&key=#{api_key()}"
|
||||||
|
end
|
||||||
|
|
||||||
|
defp http_client do
|
||||||
|
Application.get_env(:pinchflat, :http_client, Pinchflat.HTTP.HTTPClient)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
defmodule Pinchflat.FastIndexing.YoutubeBehaviour do
|
||||||
|
@moduledoc """
|
||||||
|
This module defines the behaviour for clients that interface with YouTube
|
||||||
|
for the purpose of fast indexing.
|
||||||
|
"""
|
||||||
|
|
||||||
|
alias Pinchflat.Sources.Source
|
||||||
|
|
||||||
|
@callback enabled?() :: boolean()
|
||||||
|
@callback get_recent_media_ids(%Source{}) :: {:ok, [String.t()]} | {:error, String.t()}
|
||||||
|
end
|
||||||
@@ -1,18 +1,31 @@
|
|||||||
defmodule Pinchflat.FastIndexing.YoutubeRss do
|
defmodule Pinchflat.FastIndexing.YoutubeRss do
|
||||||
@moduledoc """
|
@moduledoc """
|
||||||
Methods for interacting with YouTube RSS feeds
|
Methods for interacting with YouTube RSS feeds for fast indexing
|
||||||
"""
|
"""
|
||||||
|
|
||||||
require Logger
|
require Logger
|
||||||
|
|
||||||
alias Pinchflat.Sources.Source
|
alias Pinchflat.Sources.Source
|
||||||
|
alias Pinchflat.FastIndexing.YoutubeBehaviour
|
||||||
|
|
||||||
|
@behaviour YoutubeBehaviour
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Determines if the YouTube RSS feed is enabled for fast indexing. Used to satisfy
|
||||||
|
the `YoutubeBehaviour` behaviour.
|
||||||
|
|
||||||
|
Returns true
|
||||||
|
"""
|
||||||
|
@impl YoutubeBehaviour
|
||||||
|
def enabled?(), do: true
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Fetches the recent media IDs from a YouTube RSS feed for a given source.
|
Fetches the recent media IDs from a YouTube RSS feed for a given source.
|
||||||
|
|
||||||
Returns {:ok, [binary()]} | {:error, binary()}
|
Returns {:ok, [binary()]} | {:error, binary()}
|
||||||
"""
|
"""
|
||||||
def get_recent_media_ids_from_rss(%Source{} = source) do
|
@impl YoutubeBehaviour
|
||||||
|
def get_recent_media_ids(%Source{} = source) do
|
||||||
Logger.debug("Fetching recent media IDs from YouTube RSS feed for source: #{source.collection_id}")
|
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
|
case http_client().get(rss_url_for_source(source)) do
|
||||||
|
|||||||
@@ -21,9 +21,11 @@ defmodule Pinchflat.HTTP.HTTPClient do
|
|||||||
"""
|
"""
|
||||||
@impl HTTPBehaviour
|
@impl HTTPBehaviour
|
||||||
def get(url, headers \\ [], opts \\ []) do
|
def get(url, headers \\ [], opts \\ []) do
|
||||||
|
headers = parse_headers(headers)
|
||||||
|
|
||||||
case :httpc.request(:get, {url, headers}, [], opts) do
|
case :httpc.request(:get, {url, headers}, [], opts) do
|
||||||
{:ok, {{_version, 200, _reason_phrase}, _headers, body}} ->
|
{:ok, {{_version, 200, _reason_phrase}, _headers, body}} ->
|
||||||
{:ok, body}
|
{:ok, to_string(body)}
|
||||||
|
|
||||||
{:ok, {{_version, status_code, reason_phrase}, _headers, _body}} ->
|
{:ok, {{_version, status_code, reason_phrase}, _headers, _body}} ->
|
||||||
{:error, "HTTP request failed with status code #{status_code}: #{reason_phrase}"}
|
{:error, "HTTP request failed with status code #{status_code}: #{reason_phrase}"}
|
||||||
@@ -32,4 +34,8 @@ defmodule Pinchflat.HTTP.HTTPClient do
|
|||||||
{:error, "HTTP request failed: #{reason}"}
|
{:error, "HTTP request failed: #{reason}"}
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
defp parse_headers(headers) do
|
||||||
|
Enum.map(headers, fn {k, v} -> {to_charlist(k), to_charlist(v)} end)
|
||||||
|
end
|
||||||
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,72 @@
|
|||||||
|
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_pre_download,
|
||||||
|
: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 and returned BUT the tuple will always
|
||||||
|
start with {:ok, ...}.
|
||||||
|
|
||||||
|
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, :no_executable} | {:ok, output, exit_code}
|
||||||
|
"""
|
||||||
|
@impl UserScriptCommandRunner
|
||||||
|
def run(event_type, encodable_data) when event_type in @event_types do
|
||||||
|
case backend_executable() do
|
||||||
|
{:ok, :no_executable} ->
|
||||||
|
{:ok, :no_executable}
|
||||||
|
|
||||||
|
{: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, output, exit_code}
|
||||||
|
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.info("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
|
||||||
@@ -0,0 +1,93 @@
|
|||||||
|
defmodule Pinchflat.Media.FileSyncing do
|
||||||
|
@moduledoc """
|
||||||
|
Functions for ensuring file state is accurately reflected in the database.
|
||||||
|
"""
|
||||||
|
|
||||||
|
alias Pinchflat.Media
|
||||||
|
alias Pinchflat.Utils.MapUtils
|
||||||
|
alias Pinchflat.Media.MediaItem
|
||||||
|
alias Pinchflat.Utils.FilesystemUtils, as: FSUtils
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Deletes files that are no longer needed by a media item.
|
||||||
|
|
||||||
|
This means that if a media item has been updated, the old and new versions
|
||||||
|
can be passed and any files that are no longer needed will be deleted.
|
||||||
|
|
||||||
|
An example is a video that gets its quality upgraded and its name changes
|
||||||
|
between original download and re-download. The old file will exist on-disk
|
||||||
|
with the old name but the database entry will point to the new file. This
|
||||||
|
function can be used to delete the old file in this case.
|
||||||
|
|
||||||
|
Returns :ok
|
||||||
|
"""
|
||||||
|
def delete_outdated_files(old_media_item, new_media_item) do
|
||||||
|
non_subtitle_keys = MediaItem.filepath_attributes() -- [:subtitle_filepaths]
|
||||||
|
|
||||||
|
old_non_subtitles = Map.take(old_media_item, non_subtitle_keys)
|
||||||
|
old_subtitles = MapUtils.from_nested_list(old_media_item.subtitle_filepaths)
|
||||||
|
new_non_subtitles = Map.take(new_media_item, non_subtitle_keys)
|
||||||
|
new_subtitles = MapUtils.from_nested_list(new_media_item.subtitle_filepaths)
|
||||||
|
|
||||||
|
handle_file_deletion(old_non_subtitles, new_non_subtitles)
|
||||||
|
handle_file_deletion(old_subtitles, new_subtitles)
|
||||||
|
|
||||||
|
:ok
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Nillifies any media item filepaths that don't exist on disk for a list of media items
|
||||||
|
|
||||||
|
returns [%MediaItem{}]
|
||||||
|
"""
|
||||||
|
def sync_file_presence_on_disk(media_items) do
|
||||||
|
Enum.map(media_items, fn media_item ->
|
||||||
|
new_attributes = sync_media_item_files(media_item)
|
||||||
|
# Doing this one-by-one instead of batching since this process
|
||||||
|
# can take time and a batch could let MediaItem state get out of sync
|
||||||
|
{:ok, updated_media_item} = Media.update_media_item(media_item, new_attributes)
|
||||||
|
|
||||||
|
updated_media_item
|
||||||
|
end)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp handle_file_deletion(old_attributes, new_attributes) do
|
||||||
|
# The logic:
|
||||||
|
# - A file should only be deleted if it exists and the new file is different
|
||||||
|
# - The new attributes are the ones we're interested in keeping
|
||||||
|
# - If the old attributes have a key that doesn't exist in the new attributes, don't touch it.
|
||||||
|
# This is good for archiving but may be unpopular for other users so this may change.
|
||||||
|
|
||||||
|
Enum.each(new_attributes, fn {key, new_filepath} ->
|
||||||
|
old_filepath = Map.get(old_attributes, key)
|
||||||
|
files_have_changed = old_filepath && new_filepath && old_filepath != new_filepath
|
||||||
|
files_exist_on_disk = files_have_changed && File.exists?(old_filepath) && File.exists?(new_filepath)
|
||||||
|
|
||||||
|
if files_exist_on_disk && !FSUtils.filepaths_reference_same_file?(old_filepath, new_filepath) do
|
||||||
|
FSUtils.delete_file_and_remove_empty_directories(old_filepath)
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp sync_media_item_files(media_item) do
|
||||||
|
non_subtitle_keys = MediaItem.filepath_attributes() -- [:subtitle_filepaths]
|
||||||
|
subtitle_keys = MapUtils.from_nested_list(media_item.subtitle_filepaths)
|
||||||
|
non_subtitles = Map.take(media_item, non_subtitle_keys)
|
||||||
|
|
||||||
|
# This one is checking for the negative (ie: only update if the file doesn't exist)
|
||||||
|
new_non_subtitle_attrs =
|
||||||
|
Enum.reduce(non_subtitles, %{}, fn {key, filepath}, acc ->
|
||||||
|
if filepath && File.exists?(filepath), do: acc, else: Map.put(acc, key, nil)
|
||||||
|
end)
|
||||||
|
|
||||||
|
# This one is checking for the positive (ie: only update if the file exists)
|
||||||
|
# This is because subtitles, being an array type in the DB, are most easily updated
|
||||||
|
# by a full replacement rather than finding the actual diff
|
||||||
|
new_subtitle_attrs =
|
||||||
|
Enum.reduce(subtitle_keys, [], fn {key, filepath}, acc ->
|
||||||
|
if filepath && File.exists?(filepath), do: acc ++ [[key, filepath]], else: acc
|
||||||
|
end)
|
||||||
|
|
||||||
|
Map.put(new_non_subtitle_attrs, :subtitle_filepaths, new_subtitle_attrs)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,38 @@
|
|||||||
|
defmodule Pinchflat.Media.FileSyncingWorker do
|
||||||
|
@moduledoc false
|
||||||
|
|
||||||
|
use Oban.Worker,
|
||||||
|
queue: :local_data,
|
||||||
|
tags: ["sources", "local_data"]
|
||||||
|
|
||||||
|
alias __MODULE__
|
||||||
|
alias Pinchflat.Repo
|
||||||
|
alias Pinchflat.Tasks
|
||||||
|
alias Pinchflat.Sources
|
||||||
|
alias Pinchflat.Media.FileSyncing
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Starts the source file syncing worker.
|
||||||
|
|
||||||
|
Returns {:ok, %Task{}} | {:error, %Ecto.Changeset{}}
|
||||||
|
"""
|
||||||
|
def kickoff_with_task(source, opts \\ []) do
|
||||||
|
%{id: source.id}
|
||||||
|
|> FileSyncingWorker.new(opts)
|
||||||
|
|> Tasks.create_job_with_task(source)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Deletes a profile and optionally deletes its files
|
||||||
|
|
||||||
|
Returns :ok
|
||||||
|
"""
|
||||||
|
@impl Oban.Worker
|
||||||
|
def perform(%Oban.Job{args: %{"id" => source_id}}) do
|
||||||
|
source = Repo.preload(Sources.get_source!(source_id), :media_items)
|
||||||
|
|
||||||
|
FileSyncing.sync_file_presence_on_disk(source.media_items)
|
||||||
|
|
||||||
|
:ok
|
||||||
|
end
|
||||||
|
end
|
||||||
+71
-126
@@ -4,13 +4,16 @@ defmodule Pinchflat.Media do
|
|||||||
"""
|
"""
|
||||||
|
|
||||||
import Ecto.Query, warn: false
|
import Ecto.Query, warn: false
|
||||||
|
use Pinchflat.Media.MediaQuery
|
||||||
|
|
||||||
alias Pinchflat.Repo
|
alias Pinchflat.Repo
|
||||||
alias Pinchflat.Tasks
|
alias Pinchflat.Tasks
|
||||||
alias Pinchflat.Sources.Source
|
alias Pinchflat.Sources.Source
|
||||||
alias Pinchflat.Media.MediaItem
|
alias Pinchflat.Media.MediaItem
|
||||||
|
alias Pinchflat.Utils.FilesystemUtils
|
||||||
alias Pinchflat.Metadata.MediaMetadata
|
alias Pinchflat.Metadata.MediaMetadata
|
||||||
alias Pinchflat.Filesystem.FilesystemHelpers
|
|
||||||
|
alias Pinchflat.Lifecycle.UserScripts.CommandRunner, as: UserScriptRunner
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Returns the list of media_items.
|
Returns the list of media_items.
|
||||||
@@ -22,73 +25,47 @@ defmodule Pinchflat.Media do
|
|||||||
end
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Returns a list of media_items for a given source.
|
Returns a list of media_items that are upgradeable based on the redownload delay
|
||||||
|
of the media_profile their source belongs to. In this context, upgradeable means
|
||||||
|
that it's been long enough since upload that the video may be in a higher quality
|
||||||
|
or have better sponsorblock segments (or similar).
|
||||||
|
|
||||||
Returns [%MediaItem{}, ...].
|
The logic is that a media_item is past_redownload_delay if the media_item's uploaded_at is
|
||||||
|
at least redownload_delay_days ago AND `media_downloaded_at` - `redownload_delay_days`
|
||||||
|
is before the media_item's `uploaded_at`.
|
||||||
|
|
||||||
|
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_media_items_for(%Source{} = source) do
|
def list_upgradeable_media_items do
|
||||||
MediaItem
|
MediaQuery.new()
|
||||||
|> where([mi], mi.source_id == ^source.id)
|
|> MediaQuery.require_assoc(:media_profile)
|
||||||
|> Repo.all()
|
|> where(^MediaQuery.upgradeable())
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Fetches all media items belonging to a given source that have a media_id in the given list.
|
|
||||||
Useful for determining the what media items we DON'T already have for fast indexing.
|
|
||||||
|
|
||||||
NOTE: These queries are getting a little tedious. When I have the time, I should see about
|
|
||||||
implementing a query pattern and having these compose queries from a common base. This would
|
|
||||||
also let me compose simple queries in the module using them for one-off methods
|
|
||||||
|
|
||||||
Returns [%MediaItem{}, ...].
|
|
||||||
"""
|
|
||||||
def list_media_items_by_media_id_for(%Source{} = source, media_ids) do
|
|
||||||
MediaItem
|
|
||||||
|> where([mi], mi.source_id == ^source.id and mi.media_id in ^media_ids)
|
|
||||||
|> Repo.all()
|
|> Repo.all()
|
||||||
end
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Returns a list of pending media_items for a given source, where
|
Returns a list of pending media_items for a given source, where
|
||||||
pending means the `media_filepath` is `nil` AND the media_item
|
pending means the media_item satisfies `MediaQuery.pending`. You
|
||||||
matches the format selection rules of the parent media_profile.
|
should really check out that function if you need to know more
|
||||||
|
because it has a lot going on.
|
||||||
See `build_format_clauses` but tl;dr is it _may_ filter based
|
|
||||||
on shorts or livestreams depending on the media_profile settings.
|
|
||||||
|
|
||||||
Returns [%MediaItem{}, ...].
|
Returns [%MediaItem{}, ...].
|
||||||
"""
|
"""
|
||||||
def list_pending_media_items_for(%Source{} = source, opts \\ []) do
|
def list_pending_media_items_for(%Source{} = source) do
|
||||||
limit = Keyword.get(opts, :limit, nil)
|
MediaQuery.new()
|
||||||
media_profile = Repo.preload(source, :media_profile).media_profile
|
|> MediaQuery.require_assoc(:media_profile)
|
||||||
|
|> where(^dynamic(^MediaQuery.for_source(source) and ^MediaQuery.pending()))
|
||||||
MediaItem
|
|
||||||
|> where([mi], mi.source_id == ^source.id and is_nil(mi.media_filepath))
|
|
||||||
|> where(^build_format_clauses(media_profile))
|
|
||||||
|> where(^maybe_apply_cutoff_date(source))
|
|
||||||
|> where(^maybe_apply_title_regex(source))
|
|
||||||
|> Repo.maybe_limit(limit)
|
|
||||||
|> Repo.all()
|
|
||||||
end
|
|
||||||
|
|
||||||
@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()
|
|> Repo.all()
|
||||||
end
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
For a given media_item, tells you if it is pending download. This is defined as
|
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
|
the media_item satisfying `MediaQuery.pending` which you should really check out.
|
||||||
rules of the parent media_profile.
|
|
||||||
|
|
||||||
Intentionally does not take the `download_media` setting of the source into account.
|
Intentionally does not take the `download_media` setting of the source into account.
|
||||||
|
|
||||||
@@ -97,11 +74,9 @@ defmodule Pinchflat.Media do
|
|||||||
def pending_download?(%MediaItem{} = media_item) do
|
def pending_download?(%MediaItem{} = media_item) do
|
||||||
media_item = Repo.preload(media_item, source: :media_profile)
|
media_item = Repo.preload(media_item, source: :media_profile)
|
||||||
|
|
||||||
MediaItem
|
MediaQuery.new()
|
||||||
|> where([mi], mi.id == ^media_item.id and is_nil(mi.media_filepath))
|
|> MediaQuery.require_assoc(:media_profile)
|
||||||
|> where(^build_format_clauses(media_item.source.media_profile))
|
|> where(^dynamic([m, s, mp], m.id == ^media_item.id and ^MediaQuery.pending()))
|
||||||
|> where(^maybe_apply_cutoff_date(media_item.source))
|
|
||||||
|> where(^maybe_apply_title_regex(media_item.source))
|
|
||||||
|> Repo.exists?()
|
|> Repo.exists?()
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -120,20 +95,9 @@ defmodule Pinchflat.Media do
|
|||||||
def search(search_term, opts) do
|
def search(search_term, opts) do
|
||||||
limit = Keyword.get(opts, :limit, 50)
|
limit = Keyword.get(opts, :limit, 50)
|
||||||
|
|
||||||
from(mi in MediaItem,
|
MediaQuery.new()
|
||||||
join: mi_search_index in assoc(mi, :media_items_search_index),
|
|> MediaQuery.matching_search_term(search_term)
|
||||||
where: fragment("media_items_search_index MATCH ?", ^search_term),
|
|> Repo.maybe_limit(limit)
|
||||||
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()
|
|> Repo.all()
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -161,18 +125,23 @@ defmodule Pinchflat.Media do
|
|||||||
|
|
||||||
Unlike `create_media_item`, this will attempt an update if the media_item
|
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
|
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)
|
we may not have asked for in the past (eg: uploaded_at)
|
||||||
|
|
||||||
Returns {:ok, %MediaItem{}} | {:error, %Ecto.Changeset{}}
|
Returns {:ok, %MediaItem{}} | {:error, %Ecto.Changeset{}}
|
||||||
"""
|
"""
|
||||||
def create_media_item_from_backend_attrs(source, media_attrs_struct) do
|
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))
|
attrs = Map.merge(%{source_id: source.id}, Map.from_struct(media_attrs_struct))
|
||||||
|
# Some fields should only be set on insert and not on update.
|
||||||
|
fields_to_drop_on_update = [:playlist_index]
|
||||||
|
|
||||||
%MediaItem{}
|
%MediaItem{}
|
||||||
|> MediaItem.changeset(attrs)
|
|> MediaItem.changeset(attrs)
|
||||||
|> Repo.insert(
|
|> Repo.insert(
|
||||||
on_conflict: [
|
on_conflict: [
|
||||||
set: Map.to_list(attrs)
|
set:
|
||||||
|
attrs
|
||||||
|
|> Map.drop(fields_to_drop_on_update)
|
||||||
|
|> Map.to_list()
|
||||||
],
|
],
|
||||||
conflict_target: [:source_id, :media_id]
|
conflict_target: [:source_id, :media_id]
|
||||||
)
|
)
|
||||||
@@ -201,7 +170,8 @@ defmodule Pinchflat.Media do
|
|||||||
Tasks.delete_tasks_for(media_item)
|
Tasks.delete_tasks_for(media_item)
|
||||||
|
|
||||||
if delete_files do
|
if delete_files do
|
||||||
{:ok, _} = delete_media_files(media_item)
|
{:ok, _} = do_delete_media_files(media_item)
|
||||||
|
run_user_script(:media_deleted, media_item)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Should delete these no matter what
|
# Should delete these no matter what
|
||||||
@@ -209,6 +179,26 @@ defmodule Pinchflat.Media do
|
|||||||
Repo.delete(media_item)
|
Repo.delete(media_item)
|
||||||
end
|
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)
|
||||||
|
run_user_script(:media_deleted, media_item)
|
||||||
|
|
||||||
|
update_media_item(media_item, Map.merge(filepath_attrs, addl_attrs))
|
||||||
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Returns an `%Ecto.Changeset{}` for tracking media_item changes.
|
Returns an `%Ecto.Changeset{}` for tracking media_item changes.
|
||||||
"""
|
"""
|
||||||
@@ -216,7 +206,7 @@ defmodule Pinchflat.Media do
|
|||||||
MediaItem.changeset(media_item, attrs)
|
MediaItem.changeset(media_item, attrs)
|
||||||
end
|
end
|
||||||
|
|
||||||
defp delete_media_files(media_item) do
|
defp do_delete_media_files(media_item) do
|
||||||
mapped_struct = Map.from_struct(media_item)
|
mapped_struct = Map.from_struct(media_item)
|
||||||
|
|
||||||
MediaItem.filepath_attributes()
|
MediaItem.filepath_attributes()
|
||||||
@@ -226,7 +216,7 @@ defmodule Pinchflat.Media do
|
|||||||
end)
|
end)
|
||||||
|> List.flatten()
|
|> List.flatten()
|
||||||
|> Enum.filter(&is_binary/1)
|
|> Enum.filter(&is_binary/1)
|
||||||
|> Enum.each(&FilesystemHelpers.delete_file_and_remove_empty_directories/1)
|
|> Enum.each(&FilesystemUtils.delete_file_and_remove_empty_directories/1)
|
||||||
|
|
||||||
{:ok, media_item}
|
{:ok, media_item}
|
||||||
end
|
end
|
||||||
@@ -238,57 +228,12 @@ defmodule Pinchflat.Media do
|
|||||||
MediaMetadata.filepath_attributes()
|
MediaMetadata.filepath_attributes()
|
||||||
|> Enum.map(fn field -> mapped_struct[field] end)
|
|> Enum.map(fn field -> mapped_struct[field] end)
|
||||||
|> Enum.filter(&is_binary/1)
|
|> Enum.filter(&is_binary/1)
|
||||||
|> Enum.each(&FilesystemHelpers.delete_file_and_remove_empty_directories/1)
|
|> Enum.each(&FilesystemUtils.delete_file_and_remove_empty_directories/1)
|
||||||
end
|
end
|
||||||
|
|
||||||
defp maybe_apply_cutoff_date(source) do
|
defp run_user_script(event, media_item) do
|
||||||
if source.download_cutoff_date do
|
runner = Application.get_env(:pinchflat, :user_script_runner, UserScriptRunner)
|
||||||
dynamic([mi], mi.upload_date >= ^source.download_cutoff_date)
|
|
||||||
else
|
|
||||||
dynamic(true)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
defp maybe_apply_title_regex(source) do
|
runner.run(event, media_item)
|
||||||
if source.title_filter_regex do
|
|
||||||
dynamic([mi], fragment("regexp_like(?, ?)", mi.title, ^source.title_filter_regex))
|
|
||||||
else
|
|
||||||
dynamic(true)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
defp build_format_clauses(media_profile) do
|
|
||||||
mapped_struct = Map.from_struct(media_profile)
|
|
||||||
|
|
||||||
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 mi.short_form_content == true)
|
|
||||||
)
|
|
||||||
|
|
||||||
# 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}, _} ->
|
|
||||||
dynamic([mi], ^dynamic and mi.short_form_content == true)
|
|
||||||
|
|
||||||
{{:livestream_behaviour, :only}, _} ->
|
|
||||||
dynamic([mi], ^dynamic and mi.livestream == true)
|
|
||||||
|
|
||||||
{{:shorts_behaviour, :exclude}, %{livestream_behaviour: lb}} when lb != :only ->
|
|
||||||
dynamic([mi], ^dynamic and mi.short_form_content == false)
|
|
||||||
|
|
||||||
{{: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
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -4,15 +4,22 @@ defmodule Pinchflat.Media.MediaItem do
|
|||||||
"""
|
"""
|
||||||
|
|
||||||
use Ecto.Schema
|
use Ecto.Schema
|
||||||
|
use Pinchflat.Media.MediaQuery
|
||||||
|
|
||||||
import Ecto.Changeset
|
import Ecto.Changeset
|
||||||
import Pinchflat.Utils.ChangesetUtils
|
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.Metadata.MediaMetadata
|
alias Pinchflat.Metadata.MediaMetadata
|
||||||
alias Pinchflat.Media.MediaItemsSearchIndex
|
alias Pinchflat.Media.MediaItemsSearchIndex
|
||||||
|
|
||||||
@allowed_fields [
|
@allowed_fields [
|
||||||
|
# these fields are only captured on index
|
||||||
|
:playlist_index,
|
||||||
# these fields are captured on indexing (and again on download)
|
# these fields are captured on indexing (and again on download)
|
||||||
:title,
|
:title,
|
||||||
:media_id,
|
:media_id,
|
||||||
@@ -21,7 +28,9 @@ defmodule Pinchflat.Media.MediaItem do
|
|||||||
:livestream,
|
:livestream,
|
||||||
:source_id,
|
:source_id,
|
||||||
:short_form_content,
|
:short_form_content,
|
||||||
:upload_date,
|
:uploaded_at,
|
||||||
|
:upload_date_index,
|
||||||
|
:duration_seconds,
|
||||||
# these fields are captured only on download
|
# these fields are captured only on download
|
||||||
:media_downloaded_at,
|
:media_downloaded_at,
|
||||||
:media_filepath,
|
:media_filepath,
|
||||||
@@ -29,7 +38,12 @@ defmodule Pinchflat.Media.MediaItem do
|
|||||||
:subtitle_filepaths,
|
:subtitle_filepaths,
|
||||||
:thumbnail_filepath,
|
:thumbnail_filepath,
|
||||||
:metadata_filepath,
|
:metadata_filepath,
|
||||||
:nfo_filepath
|
:nfo_filepath,
|
||||||
|
# These are user or system controlled fields
|
||||||
|
:prevent_download,
|
||||||
|
:prevent_culling,
|
||||||
|
:culled_at,
|
||||||
|
:media_redownloaded_at
|
||||||
]
|
]
|
||||||
# Pretty much all the fields captured at index are required.
|
# Pretty much all the fields captured at index are required.
|
||||||
@required_fields ~w(
|
@required_fields ~w(
|
||||||
@@ -39,7 +53,7 @@ defmodule Pinchflat.Media.MediaItem do
|
|||||||
livestream
|
livestream
|
||||||
media_id
|
media_id
|
||||||
source_id
|
source_id
|
||||||
upload_date
|
uploaded_at
|
||||||
short_form_content
|
short_form_content
|
||||||
)a
|
)a
|
||||||
|
|
||||||
@@ -56,7 +70,11 @@ defmodule Pinchflat.Media.MediaItem do
|
|||||||
field :livestream, :boolean, default: false
|
field :livestream, :boolean, default: false
|
||||||
field :short_form_content, :boolean, default: false
|
field :short_form_content, :boolean, default: false
|
||||||
field :media_downloaded_at, :utc_datetime
|
field :media_downloaded_at, :utc_datetime
|
||||||
field :upload_date, :date
|
field :media_redownloaded_at, :utc_datetime
|
||||||
|
field :uploaded_at, :utc_datetime
|
||||||
|
field :upload_date_index, :integer, default: 0
|
||||||
|
field :duration_seconds, :integer
|
||||||
|
field :playlist_index, :integer, default: 0
|
||||||
|
|
||||||
field :media_filepath, :string
|
field :media_filepath, :string
|
||||||
field :media_size_bytes, :integer
|
field :media_size_bytes, :integer
|
||||||
@@ -68,6 +86,10 @@ defmodule Pinchflat.Media.MediaItem do
|
|||||||
# 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
|
||||||
@@ -86,6 +108,7 @@ defmodule Pinchflat.Media.MediaItem do
|
|||||||
|> 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)
|
|> 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
|
||||||
@@ -94,4 +117,75 @@ defmodule Pinchflat.Media.MediaItem do
|
|||||||
def filepath_attributes do
|
def filepath_attributes do
|
||||||
~w(media_filepath thumbnail_filepath metadata_filepath subtitle_filepaths nfo_filepath)a
|
~w(media_filepath thumbnail_filepath metadata_filepath subtitle_filepaths nfo_filepath)a
|
||||||
end
|
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
|
||||||
|
|
||||||
|
# Run it on new records no matter what. The method we delegate to
|
||||||
|
# will handle the case where `uploaded_at` is `nil`
|
||||||
|
defp update_upload_date_index(%{data: %{id: nil}} = changeset) do
|
||||||
|
do_update_upload_date_index(changeset)
|
||||||
|
end
|
||||||
|
|
||||||
|
# For the update case, we only want to recalculate if the day itself has changed.
|
||||||
|
# For instance, this is useful in the migration from `upload_date` to `uploaded_at`
|
||||||
|
defp update_upload_date_index(%{changes: changes} = changeset) when is_map_key(changes, :uploaded_at) do
|
||||||
|
old_uploaded_at = changeset.data.uploaded_at
|
||||||
|
new_uploaded_at = get_change(changeset, :uploaded_at)
|
||||||
|
upload_dates_match = DateTime.to_date(old_uploaded_at) == DateTime.to_date(new_uploaded_at)
|
||||||
|
|
||||||
|
if upload_dates_match do
|
||||||
|
changeset
|
||||||
|
else
|
||||||
|
do_update_upload_date_index(changeset)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# If the record is persisted and the `uploaded_at` field is not being changed,
|
||||||
|
# we don't need to recalculate the index.
|
||||||
|
defp update_upload_date_index(changeset), do: changeset
|
||||||
|
|
||||||
|
defp do_update_upload_date_index(%{changes: changes} = changeset) when is_map_key(changes, :uploaded_at) 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], ^MediaQuery.upload_date_matches(changes.uploaded_at) 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 do_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
|
||||||
|
|||||||
@@ -0,0 +1,226 @@
|
|||||||
|
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 redownloaded, do: dynamic([mi], not is_nil(mi.media_redownloaded_at))
|
||||||
|
def upload_date_matches(other_date), do: dynamic([mi], fragment("date(?) = date(?)", mi.uploaded_at, ^other_date))
|
||||||
|
|
||||||
|
def upload_date_after_source_cutoff do
|
||||||
|
dynamic(
|
||||||
|
[mi, source],
|
||||||
|
is_nil(source.download_cutoff_date) or
|
||||||
|
fragment("date(?) >= ?", mi.uploaded_at, 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 meets_min_and_max_duration do
|
||||||
|
dynamic(
|
||||||
|
[mi, source],
|
||||||
|
(is_nil(source.min_duration_seconds) or fragment("duration_seconds >= ?", source.min_duration_seconds)) and
|
||||||
|
(is_nil(source.max_duration_seconds) or fragment("duration_seconds <= ?", source.max_duration_seconds))
|
||||||
|
)
|
||||||
|
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 uploaded_at 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') > uploaded_at AND
|
||||||
|
DATETIME(media_downloaded_at, '-' || redownload_delay_days || ' day') < uploaded_at
|
||||||
|
""")
|
||||||
|
)
|
||||||
|
end
|
||||||
|
|
||||||
|
def cullable do
|
||||||
|
dynamic(
|
||||||
|
[mi, source],
|
||||||
|
^downloaded() and
|
||||||
|
^past_retention_period() and
|
||||||
|
not (^culling_prevented())
|
||||||
|
)
|
||||||
|
end
|
||||||
|
|
||||||
|
def deletable_based_on_source_cutoff do
|
||||||
|
dynamic(
|
||||||
|
[mi, source],
|
||||||
|
^downloaded() and
|
||||||
|
not (^upload_date_after_source_cutoff()) 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() and
|
||||||
|
^meets_min_and_max_duration()
|
||||||
|
)
|
||||||
|
end
|
||||||
|
|
||||||
|
def upgradeable do
|
||||||
|
dynamic(
|
||||||
|
[mi, source],
|
||||||
|
^downloaded() and
|
||||||
|
not (^download_prevented()) and
|
||||||
|
not (^redownloaded()) and
|
||||||
|
^past_redownload_delay()
|
||||||
|
)
|
||||||
|
end
|
||||||
|
|
||||||
|
def matches_search_term(nil), do: dynamic([mi], true)
|
||||||
|
|
||||||
|
def matches_search_term(term) do
|
||||||
|
escaped_term = clean_search_term(term)
|
||||||
|
|
||||||
|
# Matching on `term` instead of `escaped_term` because the latter can mangle empty strings
|
||||||
|
case String.trim(term) do
|
||||||
|
"" -> dynamic([mi], true)
|
||||||
|
_ -> dynamic([mi], fragment("media_items_search_index MATCH ?", ^escaped_term))
|
||||||
|
end
|
||||||
|
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, :media_items_search_index) do
|
||||||
|
from(mi in query, join: s in assoc(mi, :media_items_search_index), as: :media_items_search_index)
|
||||||
|
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
|
||||||
|
escaped_term = clean_search_term(term)
|
||||||
|
|
||||||
|
from(mi in query,
|
||||||
|
join: mi_search_index in assoc(mi, :media_items_search_index),
|
||||||
|
where: fragment("media_items_search_index MATCH ?", ^escaped_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
|
||||||
|
|
||||||
|
# SQLite's FTS5 is very picky about what it will accept as a search term.
|
||||||
|
# To that end, we need to clean up the search term before passing it to the
|
||||||
|
# MATCH clause.
|
||||||
|
# This method:
|
||||||
|
# - Trims leading and trailing whitespace
|
||||||
|
# - Collapses multiple spaces into a single space
|
||||||
|
# - Removes quote characters
|
||||||
|
# - Wraps any word in quotes (must happen after the double quote replacement)
|
||||||
|
#
|
||||||
|
# This allows for works with apostrophes and quotes to be searched for correctly
|
||||||
|
defp clean_search_term(nil), do: ""
|
||||||
|
defp clean_search_term(""), do: ""
|
||||||
|
|
||||||
|
defp clean_search_term(term) do
|
||||||
|
term
|
||||||
|
|> String.trim()
|
||||||
|
|> String.replace(~r/\s+/, " ")
|
||||||
|
|> String.split(~r/\s+/)
|
||||||
|
|> Enum.map(fn str -> String.replace(str, ~s("), "") end)
|
||||||
|
|> Enum.map_join(" ", fn str -> ~s("#{str}") end)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -9,7 +9,9 @@ defmodule Pinchflat.Metadata.MetadataFileHelpers do
|
|||||||
needed
|
needed
|
||||||
"""
|
"""
|
||||||
|
|
||||||
alias Pinchflat.Filesystem.FilesystemHelpers
|
alias Pinchflat.Utils.FilesystemUtils
|
||||||
|
|
||||||
|
alias Pinchflat.YtDlp.Media, as: YtDlpMedia
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Returns the directory where metadata for a database record should be stored.
|
Returns the directory where metadata for a database record should be stored.
|
||||||
@@ -36,7 +38,7 @@ defmodule Pinchflat.Metadata.MetadataFileHelpers do
|
|||||||
filepath = generate_filepath_for(database_record, "metadata.json.gz")
|
filepath = generate_filepath_for(database_record, "metadata.json.gz")
|
||||||
{:ok, json} = Phoenix.json_library().encode(metadata_map)
|
{:ok, json} = Phoenix.json_library().encode(metadata_map)
|
||||||
|
|
||||||
:ok = FilesystemHelpers.write_p!(filepath, json, [:compressed])
|
:ok = FilesystemUtils.write_p!(filepath, json, [:compressed])
|
||||||
|
|
||||||
filepath
|
filepath
|
||||||
end
|
end
|
||||||
@@ -47,36 +49,44 @@ defmodule Pinchflat.Metadata.MetadataFileHelpers do
|
|||||||
Returns {:ok, map()} | {:error, any}
|
Returns {:ok, map()} | {:error, any}
|
||||||
"""
|
"""
|
||||||
def read_compressed_metadata(filepath) do
|
def read_compressed_metadata(filepath) do
|
||||||
{:ok, json} = File.open(filepath, [:read, :compressed], &IO.read(&1, :all))
|
{:ok, json} = File.open(filepath, [:read, :compressed], &IO.read(&1, :eof))
|
||||||
|
|
||||||
Phoenix.json_library().decode(json)
|
Phoenix.json_library().decode(json)
|
||||||
end
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Downloads and stores a thumbnail for a media item, returning the filepath.
|
Downloads and stores a thumbnail for a media item, returning the filepath.
|
||||||
|
Chooses the highest quality thumbnail available and converts it to a JPG
|
||||||
|
|
||||||
Returns binary()
|
Returns nil if no thumbnail is available or if yt-dlp encounters an error
|
||||||
|
|
||||||
|
Returns binary() | nil
|
||||||
"""
|
"""
|
||||||
def download_and_store_thumbnail_for(database_record, metadata_map) do
|
def download_and_store_thumbnail_for(media_item_with_preloads) do
|
||||||
thumbnail_url = metadata_map["thumbnail"]
|
yt_dlp_filepath = generate_filepath_for(media_item_with_preloads, "thumbnail.%(ext)s")
|
||||||
filepath = generate_filepath_for(database_record, Path.basename(thumbnail_url))
|
real_filepath = generate_filepath_for(media_item_with_preloads, "thumbnail.jpg")
|
||||||
thumbnail_blob = fetch_thumbnail_from_url(thumbnail_url)
|
command_opts = [output: yt_dlp_filepath]
|
||||||
|
addl_opts = [use_cookies: media_item_with_preloads.source.use_cookies]
|
||||||
|
|
||||||
:ok = FilesystemHelpers.write_p!(filepath, thumbnail_blob)
|
case YtDlpMedia.download_thumbnail(media_item_with_preloads.original_url, command_opts, addl_opts) do
|
||||||
|
{:ok, _} -> real_filepath
|
||||||
filepath
|
_ -> nil
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Parses an upload date from the YYYYMMDD string returned in yt-dlp metadata
|
Parses an upload date from the YYYYMMDD string returned in yt-dlp metadata
|
||||||
and returns a Date struct.
|
and returns a DateTime struct, appending a time of 00:00:00Z.
|
||||||
|
|
||||||
Returns Date.t()
|
Returns DateTime.t()
|
||||||
"""
|
"""
|
||||||
def parse_upload_date(upload_date) do
|
def parse_upload_date(upload_date) do
|
||||||
<<year::binary-size(4)>> <> <<month::binary-size(2)>> <> <<day::binary-size(2)>> = upload_date
|
<<year::binary-size(4)>> <> <<month::binary-size(2)>> <> <<day::binary-size(2)>> = upload_date
|
||||||
|
|
||||||
Date.from_iso8601!("#{year}-#{month}-#{day}")
|
case DateTime.from_iso8601("#{year}-#{month}-#{day}T00:00:00Z") do
|
||||||
|
{:ok, datetime, _} -> datetime
|
||||||
|
_ -> raise "Invalid upload date: #{upload_date}"
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
@@ -116,11 +126,19 @@ defmodule Pinchflat.Metadata.MetadataFileHelpers do
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
defp fetch_thumbnail_from_url(url) do
|
@doc """
|
||||||
http_client = Application.get_env(:pinchflat, :http_client, Pinchflat.HTTP.HTTPClient)
|
Attempts to determine the season and episode number from a media filepath.
|
||||||
{:ok, body} = http_client.get(url, [], body_format: :binary)
|
|
||||||
|
|
||||||
body
|
Returns {:ok, {binary(), binary()}} | {:error, :indeterminable}
|
||||||
|
"""
|
||||||
|
def season_and_episode_from_media_filepath(media_filepath) do
|
||||||
|
# matches s + 1 or more digits + e + 1 or more digits (case-insensitive)
|
||||||
|
season_episode_regex = ~r/s(\d+)e(\d+)/i
|
||||||
|
|
||||||
|
case Regex.scan(season_episode_regex, media_filepath) do
|
||||||
|
[[_, season, episode] | _] -> {:ok, {season, episode}}
|
||||||
|
_ -> {:error, :indeterminable}
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
defp generate_filepath_for(database_record, filename) do
|
defp generate_filepath_for(database_record, filename) do
|
||||||
|
|||||||
@@ -8,6 +8,8 @@ defmodule Pinchflat.Metadata.MetadataParser do
|
|||||||
and not have it, ya know?
|
and not have it, ya know?
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
alias Pinchflat.YtDlp.Media, as: YtDlpMedia
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Parses the given JSON response from yt-dlp and returns a map of
|
Parses the given JSON response from yt-dlp and returns a map of
|
||||||
the needful media_item attributes, along with anything needed for
|
the needful media_item attributes, along with anything needed for
|
||||||
@@ -24,14 +26,12 @@ defmodule Pinchflat.Metadata.MetadataParser do
|
|||||||
end
|
end
|
||||||
|
|
||||||
defp parse_media_metadata(metadata) do
|
defp parse_media_metadata(metadata) do
|
||||||
|
Map.merge(
|
||||||
|
Map.from_struct(YtDlpMedia.response_to_struct(metadata)),
|
||||||
%{
|
%{
|
||||||
media_id: metadata["id"],
|
media_filepath: metadata["filepath"]
|
||||||
title: metadata["title"],
|
|
||||||
original_url: metadata["original_url"],
|
|
||||||
description: metadata["description"],
|
|
||||||
media_filepath: metadata["filepath"],
|
|
||||||
livestream: metadata["was_live"]
|
|
||||||
}
|
}
|
||||||
|
)
|
||||||
end
|
end
|
||||||
|
|
||||||
defp parse_subtitle_metadata(metadata) do
|
defp parse_subtitle_metadata(metadata) do
|
||||||
|
|||||||
@@ -4,8 +4,10 @@ defmodule Pinchflat.Metadata.NfoBuilder do
|
|||||||
use by Kodi/Jellyfin and other media center software.
|
use by Kodi/Jellyfin and other media center software.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
import Pinchflat.Utils.XmlUtils, only: [safe: 1]
|
||||||
|
|
||||||
|
alias Pinchflat.Utils.FilesystemUtils
|
||||||
alias Pinchflat.Metadata.MetadataFileHelpers
|
alias Pinchflat.Metadata.MetadataFileHelpers
|
||||||
alias Pinchflat.Filesystem.FilesystemHelpers
|
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Builds an NFO file for a media item (read: single "episode") and
|
Builds an NFO file for a media item (read: single "episode") and
|
||||||
@@ -13,12 +15,12 @@ defmodule Pinchflat.Metadata.NfoBuilder do
|
|||||||
|
|
||||||
Returns the filepath of the NFO file.
|
Returns the filepath of the NFO file.
|
||||||
"""
|
"""
|
||||||
def build_and_store_for_media_item(filepath, metadata) do
|
def build_and_store_for_media_item(nfo_filepath, metadata) do
|
||||||
nfo = build_for_media_item(metadata)
|
nfo = build_for_media_item(nfo_filepath, metadata)
|
||||||
|
|
||||||
FilesystemHelpers.write_p!(filepath, nfo)
|
FilesystemUtils.write_p!(nfo_filepath, nfo)
|
||||||
|
|
||||||
filepath
|
nfo_filepath
|
||||||
end
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
@@ -30,25 +32,30 @@ defmodule Pinchflat.Metadata.NfoBuilder do
|
|||||||
def build_and_store_for_source(filepath, metadata) do
|
def build_and_store_for_source(filepath, metadata) do
|
||||||
nfo = build_for_source(metadata)
|
nfo = build_for_source(metadata)
|
||||||
|
|
||||||
FilesystemHelpers.write_p!(filepath, nfo)
|
FilesystemUtils.write_p!(filepath, nfo)
|
||||||
|
|
||||||
filepath
|
filepath
|
||||||
end
|
end
|
||||||
|
|
||||||
defp build_for_media_item(metadata) do
|
defp build_for_media_item(nfo_filepath, metadata) do
|
||||||
upload_date = MetadataFileHelpers.parse_upload_date(metadata["upload_date"])
|
upload_date = MetadataFileHelpers.parse_upload_date(metadata["upload_date"])
|
||||||
|
# NOTE: the filepath here isn't the path of the media item, it's the path that
|
||||||
|
# the NFO should be saved to. This works because the NFO's path is the same as
|
||||||
|
# the media's path, just with a different extension. If this ever changes I'll
|
||||||
|
# need to pass in the media item's path as well.
|
||||||
|
{season, episode} = determine_season_and_episode_number(nfo_filepath, upload_date)
|
||||||
|
|
||||||
# Cribbed from a combination of the Kodi wiki, ytdl-nfo, and ytdl-sub.
|
# 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" ?>
|
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
|
||||||
<episodedetails>
|
<episodedetails>
|
||||||
<title>#{metadata["title"]}</title>
|
<title>#{safe(metadata["title"])}</title>
|
||||||
<showtitle>#{metadata["uploader"]}</showtitle>
|
<showtitle>#{safe(metadata["uploader"])}</showtitle>
|
||||||
<uniqueid type="youtube" default="true">#{metadata["id"]}</uniqueid>
|
<uniqueid type="youtube" default="true">#{safe(metadata["id"])}</uniqueid>
|
||||||
<plot>#{metadata["description"]}</plot>
|
<plot>#{safe(metadata["description"])}</plot>
|
||||||
<aired>#{upload_date}</aired>
|
<aired>#{safe(upload_date)}</aired>
|
||||||
<season>#{upload_date.year}</season>
|
<season>#{safe(season)}</season>
|
||||||
<episode>#{Calendar.strftime(upload_date, "%m%d")}</episode>
|
<episode>#{episode}</episode>
|
||||||
<genre>YouTube</genre>
|
<genre>YouTube</genre>
|
||||||
</episodedetails>
|
</episodedetails>
|
||||||
"""
|
"""
|
||||||
@@ -58,11 +65,18 @@ defmodule Pinchflat.Metadata.NfoBuilder do
|
|||||||
"""
|
"""
|
||||||
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
|
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
|
||||||
<tvshow>
|
<tvshow>
|
||||||
<title>#{metadata["title"]}</title>
|
<title>#{safe(metadata["title"])}</title>
|
||||||
<plot>#{metadata["description"]}</plot>
|
<plot>#{safe(metadata["description"])}</plot>
|
||||||
<uniqueid type="youtube" default="true">#{metadata["id"]}</uniqueid>
|
<uniqueid type="youtube" default="true">#{safe(metadata["id"])}</uniqueid>
|
||||||
<genre>YouTube</genre>
|
<genre>YouTube</genre>
|
||||||
</tvshow>
|
</tvshow>
|
||||||
"""
|
"""
|
||||||
end
|
end
|
||||||
|
|
||||||
|
defp determine_season_and_episode_number(filepath, upload_date) do
|
||||||
|
case MetadataFileHelpers.season_and_episode_from_media_filepath(filepath) do
|
||||||
|
{:ok, {season, episode}} -> {season, episode}
|
||||||
|
{:error, _} -> {upload_date.year, Calendar.strftime(upload_date, "%m%d")}
|
||||||
|
end
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -2,7 +2,7 @@ defmodule Pinchflat.Metadata.SourceImageParser do
|
|||||||
@moduledoc """
|
@moduledoc """
|
||||||
Functions for parsing and storing source images.
|
Functions for parsing and storing source images.
|
||||||
"""
|
"""
|
||||||
alias Pinchflat.Filesystem.FilesystemHelpers
|
alias Pinchflat.Utils.FilesystemUtils
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Given a base directory and source metadata, look for the appropriate images
|
Given a base directory and source metadata, look for the appropriate images
|
||||||
@@ -20,29 +20,49 @@ defmodule Pinchflat.Metadata.SourceImageParser do
|
|||||||
def store_source_images(base_directory, source_metadata) do
|
def store_source_images(base_directory, source_metadata) do
|
||||||
(source_metadata["thumbnails"] || [])
|
(source_metadata["thumbnails"] || [])
|
||||||
|> Enum.filter(&(&1["filepath"] != nil))
|
|> Enum.filter(&(&1["filepath"] != nil))
|
||||||
|> select_useful_images()
|
|> select_useful_images(source_metadata)
|
||||||
|> Enum.map(&move_image(&1, base_directory))
|
|> Enum.map(&move_image(&1, base_directory))
|
||||||
|> Enum.into(%{})
|
|> Enum.into(%{})
|
||||||
end
|
end
|
||||||
|
|
||||||
defp select_useful_images(images) do
|
defp select_useful_images(images, source_metadata) do
|
||||||
labelled_images =
|
labelled_images =
|
||||||
Enum.reduce(images, [], fn image_map, acc ->
|
Enum.reduce(images, %{}, fn image_map, acc ->
|
||||||
case image_map do
|
case image_map do
|
||||||
%{"id" => "avatar_uncropped"} ->
|
%{"id" => "avatar_uncropped"} -> put_image_key(acc, :poster, image_map["filepath"])
|
||||||
acc ++ [{:poster, :poster_filepath, image_map["filepath"]}]
|
%{"id" => "banner_uncropped"} -> put_image_key(acc, :fanart, image_map["filepath"])
|
||||||
|
_ -> acc
|
||||||
%{"id" => "banner_uncropped"} ->
|
|
||||||
acc ++ [{:fanart, :fanart_filepath, image_map["filepath"]}]
|
|
||||||
|
|
||||||
_ ->
|
|
||||||
acc
|
|
||||||
end
|
end
|
||||||
end)
|
end)
|
||||||
|
|
||||||
labelled_images
|
labelled_images
|
||||||
|> Enum.concat([{:banner, :banner_filepath, determine_best_banner(images)}])
|
|> add_fallback_poster(source_metadata)
|
||||||
|> Enum.filter(fn {_, _, tmp_filepath} -> tmp_filepath end)
|
|> put_image_key(:banner, determine_best_banner(images))
|
||||||
|
|> Enum.filter(fn {_key, attrs} -> attrs.current_filepath end)
|
||||||
|
end
|
||||||
|
|
||||||
|
# If a poster is set, short-circuit and return the images as-is
|
||||||
|
defp add_fallback_poster(%{poster: _} = images, _), do: images
|
||||||
|
|
||||||
|
# If a poster is NOT set, see if we can find a suitable image to use as a fallback
|
||||||
|
defp add_fallback_poster(images, source_metadata) do
|
||||||
|
case source_metadata["entries"] do
|
||||||
|
nil -> images
|
||||||
|
[] -> images
|
||||||
|
[first_entry | _] -> add_poster_from_entry_thumbnail(images, first_entry)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp add_poster_from_entry_thumbnail(images, entry) do
|
||||||
|
thumbnail =
|
||||||
|
(entry["thumbnails"] || [])
|
||||||
|
|> Enum.reverse()
|
||||||
|
|> Enum.find(& &1["filepath"])
|
||||||
|
|
||||||
|
case thumbnail do
|
||||||
|
nil -> images
|
||||||
|
_ -> put_image_key(images, :poster, thumbnail["filepath"])
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
defp determine_best_banner(images) do
|
defp determine_best_banner(images) do
|
||||||
@@ -58,12 +78,22 @@ defmodule Pinchflat.Metadata.SourceImageParser do
|
|||||||
Map.get(best_candidate || %{}, "filepath")
|
Map.get(best_candidate || %{}, "filepath")
|
||||||
end
|
end
|
||||||
|
|
||||||
defp move_image({filename, source_attr_name, tmp_filepath}, base_directory) do
|
defp move_image({_key, attrs}, base_directory) do
|
||||||
extension = Path.extname(tmp_filepath)
|
extension = Path.extname(attrs.current_filepath)
|
||||||
final_filepath = Path.join([base_directory, "#{filename}#{extension}"])
|
final_filepath = Path.join([base_directory, "#{attrs.final_filename}#{extension}"])
|
||||||
|
|
||||||
FilesystemHelpers.cp_p!(tmp_filepath, final_filepath)
|
FilesystemUtils.cp_p!(attrs.current_filepath, final_filepath)
|
||||||
|
|
||||||
{source_attr_name, final_filepath}
|
{attrs.attribute_name, final_filepath}
|
||||||
|
end
|
||||||
|
|
||||||
|
defp put_image_key(map, key, image) do
|
||||||
|
attribute_atom = String.to_existing_atom("#{key}_filepath")
|
||||||
|
|
||||||
|
Map.put(map, key, %{
|
||||||
|
attribute_name: attribute_atom,
|
||||||
|
final_filename: to_string(key),
|
||||||
|
current_filepath: image
|
||||||
|
})
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ defmodule Pinchflat.Metadata.SourceMetadataStorageWorker do
|
|||||||
|
|
||||||
use Oban.Worker,
|
use Oban.Worker,
|
||||||
queue: :remote_metadata,
|
queue: :remote_metadata,
|
||||||
tags: ["media_source", "source_metadata", "remote_metadata"],
|
tags: ["media_source", "source_metadata", "remote_metadata", "show_in_dashboard"],
|
||||||
max_attempts: 3
|
max_attempts: 3
|
||||||
|
|
||||||
require Logger
|
require Logger
|
||||||
@@ -38,9 +38,9 @@ defmodule Pinchflat.Metadata.SourceMetadataStorageWorker do
|
|||||||
- The NFO file for the source (if specified)
|
- The NFO file for the source (if specified)
|
||||||
- Downloads and stores source images (if specified)
|
- Downloads and stores source images (if specified)
|
||||||
|
|
||||||
The worker is kicked off after a source is inserted/updated - this can
|
The worker is kicked off after a source is inserted or it's original_url
|
||||||
take an unknown amount of time so don't rely on this data being here
|
is updated - this can take an unknown amount of time so don't rely on this
|
||||||
before, say, the first indexing or downloading task is complete.
|
data being here before, say, the first indexing or downloading task is complete.
|
||||||
|
|
||||||
Returns :ok
|
Returns :ok
|
||||||
"""
|
"""
|
||||||
@@ -77,10 +77,8 @@ defmodule Pinchflat.Metadata.SourceMetadataStorageWorker do
|
|||||||
|
|
||||||
defp fetch_source_metadata_and_images(series_directory, source) do
|
defp fetch_source_metadata_and_images(series_directory, source) do
|
||||||
metadata_directory = MetadataFileHelpers.metadata_directory_for(source)
|
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)
|
{:ok, metadata} = fetch_metadata_for_source(source)
|
||||||
metadata_image_attrs = SourceImageParser.store_source_images(metadata_directory, metadata)
|
metadata_image_attrs = SourceImageParser.store_source_images(metadata_directory, metadata)
|
||||||
|
|
||||||
if source.media_profile.download_source_images && series_directory do
|
if source.media_profile.download_source_images && series_directory do
|
||||||
@@ -94,7 +92,9 @@ defmodule Pinchflat.Metadata.SourceMetadataStorageWorker do
|
|||||||
|
|
||||||
defp determine_series_directory(source) do
|
defp determine_series_directory(source) do
|
||||||
output_path = DownloadOptionBuilder.build_output_path_for(source)
|
output_path = DownloadOptionBuilder.build_output_path_for(source)
|
||||||
{:ok, %{filepath: filepath}} = MediaCollection.get_source_details(source.original_url, output: output_path)
|
runner_opts = [output: output_path]
|
||||||
|
addl_opts = [use_cookies: source.use_cookies]
|
||||||
|
{:ok, %{filepath: filepath}} = MediaCollection.get_source_details(source.original_url, runner_opts, addl_opts)
|
||||||
|
|
||||||
case MetadataFileHelpers.series_directory_from_media_filepath(filepath) do
|
case MetadataFileHelpers.series_directory_from_media_filepath(filepath) do
|
||||||
{:ok, series_directory} -> series_directory
|
{:ok, series_directory} -> series_directory
|
||||||
@@ -110,6 +110,20 @@ defmodule Pinchflat.Metadata.SourceMetadataStorageWorker do
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
defp fetch_metadata_for_source(source) do
|
||||||
|
tmp_output_path = "#{tmp_directory()}/#{StringUtils.random_string(16)}/source_image.%(ext)S"
|
||||||
|
base_opts = [convert_thumbnails: "jpg", output: tmp_output_path]
|
||||||
|
|
||||||
|
opts =
|
||||||
|
if source.collection_type == :channel do
|
||||||
|
base_opts ++ [:write_all_thumbnails, playlist_items: 0]
|
||||||
|
else
|
||||||
|
base_opts ++ [:write_thumbnail, playlist_items: 1]
|
||||||
|
end
|
||||||
|
|
||||||
|
MediaCollection.get_source_metadata(source.original_url, opts, use_cookies: source.use_cookies)
|
||||||
|
end
|
||||||
|
|
||||||
defp tmp_directory do
|
defp tmp_directory do
|
||||||
Application.get_env(:pinchflat, :tmpfile_directory)
|
Application.get_env(:pinchflat, :tmpfile_directory)
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -4,8 +4,9 @@ defmodule Pinchflat.Podcasts.PodcastHelpers do
|
|||||||
or its media items
|
or its media items
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
use Pinchflat.Media.MediaQuery
|
||||||
|
|
||||||
alias Pinchflat.Repo
|
alias Pinchflat.Repo
|
||||||
alias Pinchflat.Media
|
|
||||||
alias Pinchflat.Metadata.MediaMetadata
|
alias Pinchflat.Metadata.MediaMetadata
|
||||||
alias Pinchflat.Metadata.SourceMetadata
|
alias Pinchflat.Metadata.SourceMetadata
|
||||||
|
|
||||||
@@ -23,10 +24,13 @@ defmodule Pinchflat.Podcasts.PodcastHelpers do
|
|||||||
Returns: [%MediaItem{}]
|
Returns: [%MediaItem{}]
|
||||||
"""
|
"""
|
||||||
def persisted_media_items_for(source, opts \\ []) do
|
def persisted_media_items_for(source, opts \\ []) do
|
||||||
limit = Keyword.get(opts, :limit, 500)
|
limit = Keyword.get(opts, :limit, 1_000)
|
||||||
|
|
||||||
source
|
MediaQuery.new()
|
||||||
|> Media.list_downloaded_media_items_for(limit: limit)
|
|> where(^dynamic(^MediaQuery.for_source(source) and ^MediaQuery.downloaded()))
|
||||||
|
|> order_by(desc: :uploaded_at)
|
||||||
|
|> Repo.maybe_limit(limit)
|
||||||
|
|> Repo.all()
|
||||||
|> Enum.filter(fn media_item -> File.exists?(media_item.media_filepath) end)
|
|> Enum.filter(fn media_item -> File.exists?(media_item.media_filepath) end)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,8 @@ defmodule Pinchflat.Podcasts.RssFeedBuilder do
|
|||||||
|
|
||||||
@datetime_format "%a, %d %b %Y %H:%M:%S %z"
|
@datetime_format "%a, %d %b %Y %H:%M:%S %z"
|
||||||
|
|
||||||
alias Pinchflat.Utils.DatetimeUtils
|
import Pinchflat.Utils.XmlUtils, only: [safe: 1]
|
||||||
|
|
||||||
alias Pinchflat.Podcasts.PodcastHelpers
|
alias Pinchflat.Podcasts.PodcastHelpers
|
||||||
alias PinchflatWeb.Router.Helpers, as: Routes
|
alias PinchflatWeb.Router.Helpers, as: Routes
|
||||||
|
|
||||||
@@ -14,12 +15,12 @@ defmodule Pinchflat.Podcasts.RssFeedBuilder do
|
|||||||
Only MediaItems that have been persisted will be included in the feed.
|
Only MediaItems that have been persisted will be included in the feed.
|
||||||
|
|
||||||
## Options:
|
## Options:
|
||||||
- `:limit` - The maximum number of media items to include in the feed. Defaults to 300.
|
- `:limit` - The maximum number of media items to include in the feed. Defaults to 2,000.
|
||||||
|
|
||||||
Returns an XML document as a string.
|
Returns an XML document as a string.
|
||||||
"""
|
"""
|
||||||
def build(source, opts \\ []) do
|
def build(source, opts \\ []) do
|
||||||
limit = Keyword.get(opts, :limit, 300)
|
limit = Keyword.get(opts, :limit, 2_000)
|
||||||
url_base = Keyword.get(opts, :url_base, PinchflatWeb.Endpoint.url())
|
url_base = Keyword.get(opts, :url_base, PinchflatWeb.Endpoint.url())
|
||||||
|
|
||||||
media_items = PodcastHelpers.persisted_media_items_for(source, limit: limit)
|
media_items = PodcastHelpers.persisted_media_items_for(source, limit: limit)
|
||||||
@@ -43,25 +44,25 @@ defmodule Pinchflat.Podcasts.RssFeedBuilder do
|
|||||||
xmlns:atom="http://www.w3.org/2005/Atom">
|
xmlns:atom="http://www.w3.org/2005/Atom">
|
||||||
<channel>
|
<channel>
|
||||||
<title>#{safe(source.custom_name)}</title>
|
<title>#{safe(source.custom_name)}</title>
|
||||||
<link>#{source.original_url}</link>
|
<link>#{safe(source.original_url)}</link>
|
||||||
<description>#{safe(source.description)}</description>
|
<description>#{safe(source.description)}</description>
|
||||||
<category>TV & Film</category>
|
<category>TV & Film</category>
|
||||||
<generator>Generated by Pinchflat</generator>
|
<generator>Generated by Pinchflat</generator>
|
||||||
<language>en-us</language>
|
<language>en-us</language>
|
||||||
<lastBuildDate>#{Calendar.strftime(source.updated_at, @datetime_format)}</lastBuildDate>
|
<lastBuildDate>#{Calendar.strftime(source.updated_at, @datetime_format)}</lastBuildDate>
|
||||||
<pubDate>#{Calendar.strftime(source.inserted_at, @datetime_format)}</pubDate>
|
<pubDate>#{Calendar.strftime(source.inserted_at, @datetime_format)}</pubDate>
|
||||||
<atom:link href="#{generate_self_link(url_base, source)}" rel="self" type="application/rss+xml" />
|
<atom:link href="#{safe(generate_self_link(url_base, source))}" rel="self" type="application/rss+xml" />
|
||||||
<podcast:locked>yes</podcast:locked>
|
<podcast:locked>yes</podcast:locked>
|
||||||
<podcast:guid>#{source.uuid}</podcast:guid>
|
<podcast:guid>#{source.uuid}</podcast:guid>
|
||||||
<image>
|
<image>
|
||||||
<url>#{feed_image_path}</url>
|
<url>#{safe(feed_image_path)}</url>
|
||||||
<title>#{safe(source.custom_name)}</title>
|
<title>#{safe(source.custom_name)}</title>
|
||||||
<link>#{source.original_url}</link>
|
<link>#{safe(source.original_url)}</link>
|
||||||
</image>
|
</image>
|
||||||
<itunes:author>#{safe(source.custom_name)}</itunes:author>
|
<itunes:author>#{safe(source.custom_name)}</itunes:author>
|
||||||
<itunes:subtitle>#{safe(source.custom_name)}</itunes:subtitle>
|
<itunes:subtitle>#{safe(source.custom_name)}</itunes:subtitle>
|
||||||
<itunes:block>yes</itunes:block>
|
<itunes:block>yes</itunes:block>
|
||||||
<itunes:image href="#{feed_image_path}"></itunes:image>
|
<itunes:image href="#{safe(feed_image_path)}"></itunes:image>
|
||||||
<itunes:explicit>false</itunes:explicit>
|
<itunes:explicit>false</itunes:explicit>
|
||||||
<itunes:category text="TV & Film"></itunes:category>
|
<itunes:category text="TV & Film"></itunes:category>
|
||||||
|
|
||||||
@@ -73,13 +74,16 @@ defmodule Pinchflat.Podcasts.RssFeedBuilder do
|
|||||||
end
|
end
|
||||||
|
|
||||||
defp build_media_item_xml(source, media_item, url_base) do
|
defp build_media_item_xml(source, media_item, url_base) do
|
||||||
|
item_image_path = item_image_path(url_base, media_item)
|
||||||
|
|
||||||
"""
|
"""
|
||||||
<item>
|
<item>
|
||||||
<guid isPermaLink="false">#{media_item.uuid}</guid>
|
<guid isPermaLink="false">#{media_item.uuid}</guid>
|
||||||
<title>#{safe(media_item.title)}</title>
|
<title>#{safe(media_item.title)}</title>
|
||||||
<link>#{media_item.original_url}</link>
|
<link>#{safe(media_item.original_url)}</link>
|
||||||
<description>#{safe(media_item.description)}</description>
|
<description>#{safe(media_item.description)}</description>
|
||||||
<pubDate>#{generate_upload_date(media_item)}</pubDate>
|
<pubDate>#{Calendar.strftime(media_item.uploaded_at, @datetime_format)}</pubDate>
|
||||||
|
<itunes:duration>#{media_item.duration_seconds}</itunes:duration>
|
||||||
<enclosure
|
<enclosure
|
||||||
url="#{media_stream_path(url_base, media_item)}"
|
url="#{media_stream_path(url_base, media_item)}"
|
||||||
length="#{media_item.media_size_bytes}"
|
length="#{media_item.media_size_bytes}"
|
||||||
@@ -88,19 +92,15 @@ defmodule Pinchflat.Podcasts.RssFeedBuilder do
|
|||||||
<itunes:author>#{safe(source.custom_name)}</itunes:author>
|
<itunes:author>#{safe(source.custom_name)}</itunes:author>
|
||||||
<itunes:subtitle>#{safe(media_item.title)}</itunes:subtitle>
|
<itunes:subtitle>#{safe(media_item.title)}</itunes:subtitle>
|
||||||
<itunes:summary><![CDATA[#{media_item.description}]]></itunes:summary>
|
<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>
|
<itunes:explicit>false</itunes:explicit>
|
||||||
</item>
|
</item>
|
||||||
"""
|
"""
|
||||||
end
|
end
|
||||||
|
|
||||||
defp safe(nil), do: ""
|
|
||||||
|
|
||||||
defp safe(value) do
|
|
||||||
value
|
|
||||||
|> Phoenix.HTML.html_escape()
|
|
||||||
|> Phoenix.HTML.safe_to_string()
|
|
||||||
end
|
|
||||||
|
|
||||||
defp generate_self_link(url_base, source) do
|
defp generate_self_link(url_base, source) do
|
||||||
Path.join(url_base, "#{podcast_route(:rss_feed, source.uuid)}.xml")
|
Path.join(url_base, "#{podcast_route(:rss_feed, source.uuid)}.xml")
|
||||||
end
|
end
|
||||||
@@ -122,10 +122,14 @@ defmodule Pinchflat.Podcasts.RssFeedBuilder do
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
defp generate_upload_date(media_item) do
|
def item_image_path(url_base, media_item) do
|
||||||
media_item.upload_date
|
if media_item.thumbnail_filepath && File.exists?(media_item.thumbnail_filepath) do
|
||||||
|> DatetimeUtils.date_to_datetime()
|
extension = Path.extname(media_item.thumbnail_filepath)
|
||||||
|> Calendar.strftime(@datetime_format)
|
|
||||||
|
Path.join(url_base, "#{podcast_route(:episode_image, media_item.uuid)}#{extension}")
|
||||||
|
else
|
||||||
|
nil
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
defp podcast_route(action, params) do
|
defp podcast_route(action, params) do
|
||||||
|
|||||||
@@ -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(
|
||||||
@@ -21,15 +22,21 @@ defmodule Pinchflat.Profiles.MediaProfile do
|
|||||||
download_metadata
|
download_metadata
|
||||||
embed_metadata
|
embed_metadata
|
||||||
download_nfo
|
download_nfo
|
||||||
|
sponsorblock_behaviour
|
||||||
|
sponsorblock_categories
|
||||||
shorts_behaviour
|
shorts_behaviour
|
||||||
livestream_behaviour
|
livestream_behaviour
|
||||||
preferred_resolution
|
preferred_resolution
|
||||||
|
media_container
|
||||||
|
redownload_delay_days
|
||||||
|
marked_for_deletion_at
|
||||||
)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 }}/{{ upload_yyyy_mm_dd }} {{ title }}/{{ title }} [{{ id }}].{{ ext }}"
|
default: "/{{ source_custom_name }}/{{ upload_yyyy_mm_dd }} {{ title }}/{{ title }} [{{ id }}].{{ ext }}"
|
||||||
@@ -47,6 +54,8 @@ defmodule Pinchflat.Profiles.MediaProfile do
|
|||||||
field :embed_metadata, :boolean, default: false
|
field :embed_metadata, :boolean, default: false
|
||||||
|
|
||||||
field :download_nfo, :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.
|
||||||
@@ -56,8 +65,10 @@ 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 :media_container, :string, default: nil
|
||||||
|
|
||||||
field :preferred_resolution, Ecto.Enum, values: ~w(2160p 1080p 720p 480p 360p audio)a, default: :"1080p"
|
field :marked_for_deletion_at, :utc_datetime
|
||||||
|
|
||||||
has_many :sources, Source
|
has_many :sources, Source
|
||||||
|
|
||||||
@@ -71,10 +82,25 @@ defmodule Pinchflat.Profiles.MediaProfile do
|
|||||||
|> validate_required(@required_fields)
|
|> validate_required(@required_fields)
|
||||||
# Ensures it ends with `.{{ ext }}` or `.%(ext)s` or similar (with a little wiggle room)
|
# 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_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
|
||||||
|
|
||||||
defp ext_regex do
|
@doc false
|
||||||
|
def ext_regex do
|
||||||
~r/\.({{ ?ext ?}}|%\( ?ext ?\)[sS])$/
|
~r/\.({{ ?ext ?}}|%\( ?ext ?\)[sS])$/
|
||||||
end
|
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
|
||||||
|
|||||||
@@ -0,0 +1,38 @@
|
|||||||
|
defmodule Pinchflat.Profiles.MediaProfileDeletionWorker do
|
||||||
|
@moduledoc false
|
||||||
|
|
||||||
|
use Oban.Worker,
|
||||||
|
queue: :local_data,
|
||||||
|
tags: ["media_profiles", "local_data"]
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias __MODULE__
|
||||||
|
alias Pinchflat.Profiles
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Starts the profile deletion worker. Does not attach it to a task like `kickoff_with_task/2`
|
||||||
|
since deletion also cancels all tasks for the profile
|
||||||
|
|
||||||
|
Returns {:ok, %Task{}} | {:error, %Ecto.Changeset{}}
|
||||||
|
"""
|
||||||
|
def kickoff(profile, job_args \\ %{}, job_opts \\ []) do
|
||||||
|
%{id: profile.id}
|
||||||
|
|> Map.merge(job_args)
|
||||||
|
|> MediaProfileDeletionWorker.new(job_opts)
|
||||||
|
|> Oban.insert()
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Deletes a profile and optionally deletes its files
|
||||||
|
|
||||||
|
Returns :ok
|
||||||
|
"""
|
||||||
|
@impl Oban.Worker
|
||||||
|
def perform(%Oban.Job{args: %{"id" => profile_id} = args}) do
|
||||||
|
delete_files = Map.get(args, "delete_files", false)
|
||||||
|
profile = Profiles.get_media_profile!(profile_id)
|
||||||
|
|
||||||
|
Profiles.delete_media_profile(profile, delete_files: delete_files)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -7,7 +7,7 @@ defmodule Pinchflat.Release do
|
|||||||
|
|
||||||
require Logger
|
require Logger
|
||||||
|
|
||||||
alias Pinchflat.Filesystem.FilesystemHelpers
|
alias Pinchflat.Utils.FilesystemUtils
|
||||||
|
|
||||||
def migrate do
|
def migrate do
|
||||||
load_app()
|
load_app()
|
||||||
@@ -25,20 +25,24 @@ defmodule Pinchflat.Release do
|
|||||||
def check_file_permissions do
|
def check_file_permissions do
|
||||||
load_app()
|
load_app()
|
||||||
|
|
||||||
directories = [
|
directories =
|
||||||
|
[
|
||||||
"/config",
|
"/config",
|
||||||
"/downloads",
|
"/downloads",
|
||||||
Application.get_env(:pinchflat, :media_directory),
|
Application.get_env(:pinchflat, :media_directory),
|
||||||
Application.get_env(:pinchflat, :tmpfile_directory),
|
Application.get_env(:pinchflat, :tmpfile_directory),
|
||||||
Application.get_env(:pinchflat, :extras_directory),
|
Application.get_env(:pinchflat, :extras_directory),
|
||||||
Application.get_env(:pinchflat, :metadata_directory)
|
Application.get_env(:pinchflat, :metadata_directory),
|
||||||
|
Application.get_env(:tzdata, :data_dir)
|
||||||
]
|
]
|
||||||
|
|> Enum.uniq()
|
||||||
|
|> Enum.filter(&(&1 != nil))
|
||||||
|
|
||||||
Enum.each(directories, fn dir ->
|
Enum.each(directories, fn dir ->
|
||||||
Logger.info("Checking permissions for #{dir}")
|
Logger.info("Checking permissions for #{dir}")
|
||||||
filepath = Path.join([dir, ".keep"])
|
filepath = Path.join([dir, ".keep"])
|
||||||
|
|
||||||
case FilesystemHelpers.write_p(filepath, "") do
|
case FilesystemUtils.write_p(filepath, "") do
|
||||||
:ok ->
|
:ok ->
|
||||||
Logger.info("Permissions OK")
|
Logger.info("Permissions OK")
|
||||||
|
|
||||||
|
|||||||
@@ -1,24 +1,45 @@
|
|||||||
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,
|
||||||
|
:youtube_api_key
|
||||||
|
]
|
||||||
|
|
||||||
timestamps(type: :utc_datetime)
|
@required_fields ~w(
|
||||||
|
onboarding
|
||||||
|
pro_enabled
|
||||||
|
video_codec_preference
|
||||||
|
audio_codec_preference
|
||||||
|
)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 :youtube_api_key, :string
|
||||||
|
|
||||||
|
field :video_codec_preference, :string
|
||||||
|
field :audio_codec_preference, :string
|
||||||
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])
|
|> validate_required(@required_fields)
|
||||||
|> unique_constraint([:name])
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -2,94 +2,80 @@ defmodule Pinchflat.Settings do
|
|||||||
@moduledoc """
|
@moduledoc """
|
||||||
The Settings context.
|
The Settings context.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import Ecto.Query, warn: false
|
import Ecto.Query, warn: false
|
||||||
alias Pinchflat.Repo
|
|
||||||
|
|
||||||
|
alias Pinchflat.Repo
|
||||||
alias Pinchflat.Settings.Setting
|
alias Pinchflat.Settings.Setting
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Returns the list of settings.
|
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{}, ...]
|
Returns %Setting{}
|
||||||
"""
|
"""
|
||||||
def list_settings do
|
def record do
|
||||||
Repo.all(Setting)
|
Setting
|
||||||
|
|> limit(1)
|
||||||
|
|> Repo.one()
|
||||||
end
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Creates or updates a setting, returning the parsed value.
|
Updates the setting record.
|
||||||
Raises if an unsupported datatype is used. Optionally allows
|
|
||||||
specifying the datatype.
|
|
||||||
|
|
||||||
Returns value in type of `Ecto.Enum.mappings(Setting, :datatype)`
|
Returns {:ok, %Setting{}} | {:error, %Ecto.Changeset{}}
|
||||||
"""
|
"""
|
||||||
def set!(name, value) do
|
def update_setting(%Setting{} = setting, attrs) do
|
||||||
set!(name, value, infer_datatype(value))
|
setting
|
||||||
|
|> Setting.changeset(attrs)
|
||||||
|
|> Repo.update()
|
||||||
end
|
end
|
||||||
|
|
||||||
def set!(name, value, datatype) do
|
@doc """
|
||||||
# Only create if doesn't exist
|
Updates a setting, returning the new value.
|
||||||
case Repo.get_by(Setting, name: to_string(name)) do
|
Is setup to take a keyword list argument so you
|
||||||
nil -> create_setting!(name, value, datatype)
|
can call it like `Settings.set(onboarding: true)`
|
||||||
setting -> update_setting!(setting, value, datatype)
|
|
||||||
|
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
|
||||||
end
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Gets the parsed value of a setting. Raises if the setting does not exist.
|
Gets the value of a setting.
|
||||||
|
|
||||||
Returns value in type of `Ecto.Enum.mappings(Setting, :datatype)`
|
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
|
def get!(name) do
|
||||||
Setting
|
case get(name) do
|
||||||
|> Repo.get_by!(name: to_string(name))
|
{:ok, value} -> value
|
||||||
|> read_setting()
|
{:error, _} -> raise "Setting `#{name}` not found"
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Attempts to find a setting by name or creates a setting with value
|
Returns `%Ecto.Changeset{}`
|
||||||
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
|
def change_setting(%Setting{} = setting, attrs \\ %{}) 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)
|
Setting.changeset(setting, attrs)
|
||||||
end
|
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
|
end
|
||||||
|
|||||||
@@ -4,25 +4,28 @@ defmodule Pinchflat.SlowIndexing.MediaCollectionIndexingWorker do
|
|||||||
use Oban.Worker,
|
use Oban.Worker,
|
||||||
queue: :media_collection_indexing,
|
queue: :media_collection_indexing,
|
||||||
unique: [period: :infinity, states: [:available, :scheduled, :retryable]],
|
unique: [period: :infinity, states: [:available, :scheduled, :retryable]],
|
||||||
tags: ["media_source", "media_collection_indexing"]
|
tags: ["media_source", "media_collection_indexing", "show_in_dashboard"]
|
||||||
|
|
||||||
require Logger
|
require Logger
|
||||||
|
|
||||||
alias __MODULE__
|
alias __MODULE__
|
||||||
alias Pinchflat.Tasks
|
alias Pinchflat.Tasks
|
||||||
alias Pinchflat.Sources
|
alias Pinchflat.Sources
|
||||||
|
alias Pinchflat.Settings
|
||||||
alias Pinchflat.Sources.Source
|
alias Pinchflat.Sources.Source
|
||||||
alias Pinchflat.FastIndexing.FastIndexingWorker
|
alias Pinchflat.FastIndexing.FastIndexingWorker
|
||||||
alias Pinchflat.SlowIndexing.SlowIndexingHelpers
|
alias Pinchflat.SlowIndexing.SlowIndexingHelpers
|
||||||
|
alias Pinchflat.Lifecycle.Notifications.SourceNotifications
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Starts the source slow indexing worker and creates a task for the source.
|
Starts the source slow indexing worker and creates a task for the source.
|
||||||
|
|
||||||
Returns {:ok, %Task{}} | {:error, :duplicate_job} | {:error, %Ecto.Changeset{}}
|
Returns {:ok, %Task{}} | {:error, :duplicate_job} | {:error, %Ecto.Changeset{}}
|
||||||
"""
|
"""
|
||||||
def kickoff_with_task(source, opts \\ []) do
|
def kickoff_with_task(source, job_args \\ %{}, job_opts \\ []) do
|
||||||
%{id: source.id}
|
%{id: source.id}
|
||||||
|> MediaCollectionIndexingWorker.new(opts)
|
|> Map.merge(job_args)
|
||||||
|
|> MediaCollectionIndexingWorker.new(job_opts)
|
||||||
|> Tasks.create_job_with_task(source)
|
|> Tasks.create_job_with_task(source)
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -30,8 +33,8 @@ defmodule Pinchflat.SlowIndexing.MediaCollectionIndexingWorker do
|
|||||||
The ID is that of a source _record_, not a YouTube channel/playlist ID. Indexes
|
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
|
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
|
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
|
if it's never been indexed before or if `force` is set to `true`, but rescheduling
|
||||||
`index_frequency_minutes` field.
|
is determined by the `index_frequency_minutes` field.
|
||||||
|
|
||||||
README: Re-scheduling here works a little different than you may expect.
|
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_.
|
The reschedule time is relative to the time the job has actually _completed_.
|
||||||
@@ -58,9 +61,8 @@ defmodule Pinchflat.SlowIndexing.MediaCollectionIndexingWorker do
|
|||||||
5. If the source uses fast indexing, that job is kicked off as well. It
|
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
|
uses RSS to run a smaller, faster, and more frequent index. That job
|
||||||
handles rescheduling itself but largely has a similar behaviour to this
|
handles rescheduling itself but largely has a similar behaviour to this
|
||||||
job in that it kicks off index and maybe download jobs. The biggest difference
|
job in that it runs and index and maybe kicks off media download jobs.
|
||||||
is that an index job is kicked off _for each new media item_ as opposed
|
Check out `FastIndexingWorker` comments for more.
|
||||||
to one larger index job. Check out `MediaIndexingWorker` comments for more.
|
|
||||||
6. If the job reschedules, the cycle from step 3 repeats until the heat death
|
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
|
of the universe. The user changing things like the index frequency can
|
||||||
dequeue or reschedule jobs as well
|
dequeue or reschedule jobs as well
|
||||||
@@ -71,25 +73,29 @@ defmodule Pinchflat.SlowIndexing.MediaCollectionIndexingWorker do
|
|||||||
Returns :ok | {:ok, %Task{}}
|
Returns :ok | {:ok, %Task{}}
|
||||||
"""
|
"""
|
||||||
@impl Oban.Worker
|
@impl Oban.Worker
|
||||||
def perform(%Oban.Job{args: %{"id" => source_id}}) do
|
def perform(%Oban.Job{args: %{"id" => source_id} = args}) do
|
||||||
source = Sources.get_source!(source_id)
|
source = Sources.get_source!(source_id)
|
||||||
|
|
||||||
case {source.index_frequency_minutes, source.last_indexed_at} do
|
case {source.index_frequency_minutes, source.last_indexed_at} do
|
||||||
{index_freq, _} when index_freq > 0 ->
|
{index_freq, _} when index_freq > 0 ->
|
||||||
# If the indexing is on a schedule simply run indexing and reschedule
|
# If the indexing is on a schedule simply run indexing and reschedule
|
||||||
SlowIndexingHelpers.index_and_enqueue_download_for_media_items(source)
|
perform_indexing_and_notification(source)
|
||||||
maybe_enqueue_fast_indexing_task(source)
|
maybe_enqueue_fast_indexing_task(source)
|
||||||
reschedule_indexing(source)
|
reschedule_indexing(source)
|
||||||
|
|
||||||
{_, nil} ->
|
{_, nil} ->
|
||||||
# If the source has never been indexed, index it once
|
# If the source has never been indexed, index it once
|
||||||
# even if it's not meant to reschedule
|
# even if it's not meant to reschedule
|
||||||
SlowIndexingHelpers.index_and_enqueue_download_for_media_items(source)
|
perform_indexing_and_notification(source)
|
||||||
:ok
|
:ok
|
||||||
|
|
||||||
_ ->
|
_ ->
|
||||||
# If the source HAS been indexed and is not meant to reschedule,
|
# If the source HAS been indexed and is not meant to reschedule,
|
||||||
# perform a no-op
|
# perform a no-op (unless forced)
|
||||||
|
if args["force"] do
|
||||||
|
perform_indexing_and_notification(source)
|
||||||
|
end
|
||||||
|
|
||||||
:ok
|
:ok
|
||||||
end
|
end
|
||||||
rescue
|
rescue
|
||||||
@@ -97,6 +103,14 @@ defmodule Pinchflat.SlowIndexing.MediaCollectionIndexingWorker do
|
|||||||
Ecto.StaleEntryError -> Logger.info("#{__MODULE__} discarded: source #{source_id} stale")
|
Ecto.StaleEntryError -> Logger.info("#{__MODULE__} discarded: source #{source_id} stale")
|
||||||
end
|
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
|
defp reschedule_indexing(source) do
|
||||||
next_run_in = source.index_frequency_minutes * 60
|
next_run_in = source.index_frequency_minutes * 60
|
||||||
|
|
||||||
|
|||||||
@@ -16,7 +16,6 @@ defmodule Pinchflat.SlowIndexing.SlowIndexingHelpers do
|
|||||||
alias Pinchflat.YtDlp.MediaCollection
|
alias Pinchflat.YtDlp.MediaCollection
|
||||||
alias Pinchflat.Downloading.DownloadingHelpers
|
alias Pinchflat.Downloading.DownloadingHelpers
|
||||||
alias Pinchflat.SlowIndexing.FileFollowerServer
|
alias Pinchflat.SlowIndexing.FileFollowerServer
|
||||||
alias Pinchflat.Downloading.MediaDownloadWorker
|
|
||||||
alias Pinchflat.SlowIndexing.MediaCollectionIndexingWorker
|
alias Pinchflat.SlowIndexing.MediaCollectionIndexingWorker
|
||||||
|
|
||||||
alias Pinchflat.YtDlp.Media, as: YtDlpMedia
|
alias Pinchflat.YtDlp.Media, as: YtDlpMedia
|
||||||
@@ -27,12 +26,11 @@ defmodule Pinchflat.SlowIndexing.SlowIndexingHelpers do
|
|||||||
|
|
||||||
Returns {:ok, %Task{}}.
|
Returns {:ok, %Task{}}.
|
||||||
"""
|
"""
|
||||||
def kickoff_indexing_task(%Source{} = source) do
|
def kickoff_indexing_task(%Source{} = source, job_args \\ %{}, job_opts \\ []) do
|
||||||
Tasks.delete_pending_tasks_for(source, "FastIndexingWorker")
|
Tasks.delete_pending_tasks_for(source, "FastIndexingWorker")
|
||||||
Tasks.delete_pending_tasks_for(source, "MediaIndexingWorker")
|
Tasks.delete_pending_tasks_for(source, "MediaCollectionIndexingWorker", include_executing: true)
|
||||||
Tasks.delete_pending_tasks_for(source, "MediaCollectionIndexingWorker")
|
|
||||||
|
|
||||||
MediaCollectionIndexingWorker.kickoff_with_task(source)
|
MediaCollectionIndexingWorker.kickoff_with_task(source, job_args, job_opts)
|
||||||
end
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
@@ -60,7 +58,7 @@ defmodule Pinchflat.SlowIndexing.SlowIndexingHelpers do
|
|||||||
def index_and_enqueue_download_for_media_items(%Source{} = source) do
|
def index_and_enqueue_download_for_media_items(%Source{} = source) do
|
||||||
# See the method definition below for more info on how file watchers work
|
# See the method definition below for more info on how file watchers work
|
||||||
# (important reading if you're not familiar with it)
|
# (important reading if you're not familiar with it)
|
||||||
{:ok, media_attributes} = get_media_attributes_for_collection_and_setup_file_watcher(source)
|
{:ok, media_attributes} = setup_file_watcher_and_kickoff_indexing(source)
|
||||||
# Reload because the source may have been updated during the (long-running) indexing process
|
# Reload because the source may have been updated during the (long-running) indexing process
|
||||||
# and important settings like `download_media` may have changed.
|
# and important settings like `download_media` may have changed.
|
||||||
source = Repo.reload!(source)
|
source = Repo.reload!(source)
|
||||||
@@ -84,19 +82,20 @@ defmodule Pinchflat.SlowIndexing.SlowIndexingHelpers do
|
|||||||
# lines (ie: you should gracefully fail if you can't parse a line).
|
# 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
|
# This works in-tandem with the normal (blocking) media indexing behaviour. When
|
||||||
# the `get_media_attributes_for_collection` method completes it'll return the FULL result to
|
# the `setup_file_watcher_and_kickoff_indexing` method completes it'll return the
|
||||||
# the caller for parsing. Ideally, every item in the list will have already
|
# 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
|
# been processed by the file follower, but if not, the caller handles creation
|
||||||
# of any media items that were missed/initially failed.
|
# of any media items that were missed/initially failed.
|
||||||
#
|
#
|
||||||
# It attempts a graceful shutdown of the file follower after the indexing is done,
|
# 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
|
# but the FileFollowerServer will also stop itself if it doesn't see any activity
|
||||||
# for a sufficiently long time.
|
# for a sufficiently long time.
|
||||||
defp get_media_attributes_for_collection_and_setup_file_watcher(source) do
|
defp setup_file_watcher_and_kickoff_indexing(source) do
|
||||||
{:ok, pid} = FileFollowerServer.start_link()
|
{:ok, pid} = FileFollowerServer.start_link()
|
||||||
|
|
||||||
handler = fn filepath -> setup_file_follower_watcher(pid, filepath, source) end
|
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)
|
runner_opts = [file_listener_handler: handler, use_cookies: source.use_cookies]
|
||||||
|
result = MediaCollection.get_media_attributes_for_collection(source.original_url, runner_opts)
|
||||||
|
|
||||||
FileFollowerServer.stop(pid)
|
FileFollowerServer.stop(pid)
|
||||||
|
|
||||||
@@ -127,11 +126,7 @@ defmodule Pinchflat.SlowIndexing.SlowIndexingHelpers do
|
|||||||
|
|
||||||
case Media.create_media_item_from_backend_attrs(source, media_attrs) do
|
case Media.create_media_item_from_backend_attrs(source, media_attrs) do
|
||||||
{:ok, %MediaItem{} = media_item} ->
|
{:ok, %MediaItem{} = media_item} ->
|
||||||
if source.download_media && Media.pending_download?(media_item) do
|
DownloadingHelpers.kickoff_download_if_pending(media_item)
|
||||||
Logger.debug("FileFollowerServer Handler: Enqueuing download task for #{inspect(media_attrs)}")
|
|
||||||
|
|
||||||
MediaDownloadWorker.kickoff_with_task(media_item)
|
|
||||||
end
|
|
||||||
|
|
||||||
{:error, changeset} ->
|
{:error, changeset} ->
|
||||||
changeset
|
changeset
|
||||||
|
|||||||
@@ -7,6 +7,8 @@ defmodule Pinchflat.Sources.Source do
|
|||||||
import Ecto.Changeset
|
import Ecto.Changeset
|
||||||
import Pinchflat.Utils.ChangesetUtils
|
import Pinchflat.Utils.ChangesetUtils
|
||||||
|
|
||||||
|
alias __MODULE__
|
||||||
|
alias Pinchflat.Repo
|
||||||
alias Pinchflat.Tasks.Task
|
alias Pinchflat.Tasks.Task
|
||||||
alias Pinchflat.Media.MediaItem
|
alias Pinchflat.Media.MediaItem
|
||||||
alias Pinchflat.Profiles.MediaProfile
|
alias Pinchflat.Profiles.MediaProfile
|
||||||
@@ -25,12 +27,18 @@ defmodule Pinchflat.Sources.Source do
|
|||||||
series_directory
|
series_directory
|
||||||
index_frequency_minutes
|
index_frequency_minutes
|
||||||
fast_index
|
fast_index
|
||||||
|
use_cookies
|
||||||
download_media
|
download_media
|
||||||
last_indexed_at
|
last_indexed_at
|
||||||
original_url
|
original_url
|
||||||
download_cutoff_date
|
download_cutoff_date
|
||||||
|
retention_period_days
|
||||||
title_filter_regex
|
title_filter_regex
|
||||||
media_profile_id
|
media_profile_id
|
||||||
|
output_path_template_override
|
||||||
|
marked_for_deletion_at
|
||||||
|
min_duration_seconds
|
||||||
|
max_duration_seconds
|
||||||
)a
|
)a
|
||||||
|
|
||||||
# Expensive API calls are made when a source is inserted/updated so
|
# Expensive API calls are made when a source is inserted/updated so
|
||||||
@@ -68,12 +76,18 @@ defmodule Pinchflat.Sources.Source do
|
|||||||
field :collection_type, Ecto.Enum, values: [:channel, :playlist]
|
field :collection_type, Ecto.Enum, values: [:channel, :playlist]
|
||||||
field :index_frequency_minutes, :integer, default: 60 * 24
|
field :index_frequency_minutes, :integer, default: 60 * 24
|
||||||
field :fast_index, :boolean, default: false
|
field :fast_index, :boolean, default: false
|
||||||
|
field :use_cookies, :boolean, default: false
|
||||||
field :download_media, :boolean, default: true
|
field :download_media, :boolean, default: true
|
||||||
field :last_indexed_at, :utc_datetime
|
field :last_indexed_at, :utc_datetime
|
||||||
# Only download media items that were published after this date
|
# Only download media items that were published after this date
|
||||||
field :download_cutoff_date, :date
|
field :download_cutoff_date, :date
|
||||||
|
field :retention_period_days, :integer
|
||||||
field :original_url, :string
|
field :original_url, :string
|
||||||
field :title_filter_regex, :string
|
field :title_filter_regex, :string
|
||||||
|
field :output_path_template_override, :string
|
||||||
|
|
||||||
|
field :min_duration_seconds, :integer
|
||||||
|
field :max_duration_seconds, :integer
|
||||||
|
|
||||||
field :series_directory, :string
|
field :series_directory, :string
|
||||||
field :nfo_filepath, :string
|
field :nfo_filepath, :string
|
||||||
@@ -81,6 +95,8 @@ defmodule Pinchflat.Sources.Source do
|
|||||||
field :fanart_filepath, :string
|
field :fanart_filepath, :string
|
||||||
field :banner_filepath, :string
|
field :banner_filepath, :string
|
||||||
|
|
||||||
|
field :marked_for_deletion_at, :utc_datetime
|
||||||
|
|
||||||
belongs_to :media_profile, MediaProfile
|
belongs_to :media_profile, MediaProfile
|
||||||
|
|
||||||
has_one :metadata, SourceMetadata, on_replace: :update
|
has_one :metadata, SourceMetadata, on_replace: :update
|
||||||
@@ -106,7 +122,14 @@ defmodule Pinchflat.Sources.Source do
|
|||||||
|> dynamic_default(:custom_name, fn cs -> get_field(cs, :collection_name) end)
|
|> dynamic_default(:custom_name, fn cs -> get_field(cs, :collection_name) end)
|
||||||
|> dynamic_default(:uuid, fn _ -> Ecto.UUID.generate() end)
|
|> dynamic_default(:uuid, fn _ -> Ecto.UUID.generate() end)
|
||||||
|> validate_required(required_fields)
|
|> validate_required(required_fields)
|
||||||
|
|> validate_title_regex()
|
||||||
|
|> validate_min_and_max_durations()
|
||||||
|
|> 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 }}")
|
||||||
|
|> validate_format(:original_url, youtube_channel_or_playlist_regex(), message: "must be a channel or playlist URL")
|
||||||
|> cast_assoc(:metadata, with: &SourceMetadata.changeset/2, required: false)
|
|> cast_assoc(:metadata, with: &SourceMetadata.changeset/2, required: false)
|
||||||
|
|> unique_constraint([:collection_id, :media_profile_id, :title_filter_regex], error_key: :original_url)
|
||||||
end
|
end
|
||||||
|
|
||||||
@doc false
|
@doc false
|
||||||
@@ -118,11 +141,52 @@ defmodule Pinchflat.Sources.Source do
|
|||||||
@doc false
|
@doc false
|
||||||
def fast_index_frequency do
|
def fast_index_frequency do
|
||||||
# minutes
|
# minutes
|
||||||
15
|
10
|
||||||
end
|
end
|
||||||
|
|
||||||
@doc false
|
@doc false
|
||||||
def filepath_attributes do
|
def filepath_attributes do
|
||||||
~w(nfo_filepath fanart_filepath poster_filepath banner_filepath)a
|
~w(nfo_filepath fanart_filepath poster_filepath banner_filepath)a
|
||||||
end
|
end
|
||||||
|
|
||||||
|
@doc false
|
||||||
|
def json_exluded_fields do
|
||||||
|
~w(__meta__ __struct__ metadata tasks media_items)a
|
||||||
|
end
|
||||||
|
|
||||||
|
def youtube_channel_or_playlist_regex do
|
||||||
|
# Validate that the original URL is not a video URL
|
||||||
|
# Also matches if the string does NOT contain youtube.com or youtu.be. This preserves my tenuous support
|
||||||
|
# for non-youtube sources.
|
||||||
|
~r<^(?:(?!youtube\.com/(watch|shorts|embed)|youtu\.be).)*$>
|
||||||
|
end
|
||||||
|
|
||||||
|
defp validate_title_regex(%{changes: %{title_filter_regex: regex}} = changeset) when is_binary(regex) do
|
||||||
|
case Ecto.Adapters.SQL.query(Repo, "SELECT regexp_like('', ?)", [regex]) do
|
||||||
|
{:ok, _} -> changeset
|
||||||
|
_ -> add_error(changeset, :title_filter_regex, "is invalid")
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp validate_title_regex(changeset), do: changeset
|
||||||
|
|
||||||
|
defp validate_min_and_max_durations(changeset) do
|
||||||
|
min_duration = get_change(changeset, :min_duration_seconds)
|
||||||
|
max_duration = get_change(changeset, :max_duration_seconds)
|
||||||
|
|
||||||
|
case {min_duration, max_duration} do
|
||||||
|
{min, max} when is_nil(min) or is_nil(max) -> changeset
|
||||||
|
{min, max} when min >= max -> add_error(changeset, :max_duration_seconds, "must be greater than minumum duration")
|
||||||
|
_ -> changeset
|
||||||
|
end
|
||||||
|
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
|
end
|
||||||
|
|||||||
@@ -0,0 +1,38 @@
|
|||||||
|
defmodule Pinchflat.Sources.SourceDeletionWorker do
|
||||||
|
@moduledoc false
|
||||||
|
|
||||||
|
use Oban.Worker,
|
||||||
|
queue: :local_data,
|
||||||
|
tags: ["sources", "local_data"]
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias __MODULE__
|
||||||
|
alias Pinchflat.Sources
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Starts the source deletion worker. Does not attach it to a task like `kickoff_with_task/2`
|
||||||
|
since deletion also cancels all tasks for the source
|
||||||
|
|
||||||
|
Returns {:ok, %Task{}} | {:error, %Ecto.Changeset{}}
|
||||||
|
"""
|
||||||
|
def kickoff(source, job_args \\ %{}, job_opts \\ []) do
|
||||||
|
%{id: source.id}
|
||||||
|
|> Map.merge(job_args)
|
||||||
|
|> SourceDeletionWorker.new(job_opts)
|
||||||
|
|> Oban.insert()
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Deletes a source and optionally deletes its files
|
||||||
|
|
||||||
|
Returns :ok
|
||||||
|
"""
|
||||||
|
@impl Oban.Worker
|
||||||
|
def perform(%Oban.Job{args: %{"id" => source_id} = args}) do
|
||||||
|
delete_files = Map.get(args, "delete_files", false)
|
||||||
|
source = Sources.get_source!(source_id)
|
||||||
|
|
||||||
|
Sources.delete_source(source, delete_files: delete_files)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -4,20 +4,34 @@ defmodule Pinchflat.Sources do
|
|||||||
"""
|
"""
|
||||||
|
|
||||||
import Ecto.Query, warn: false
|
import Ecto.Query, warn: false
|
||||||
alias Pinchflat.Repo
|
use Pinchflat.Media.MediaQuery
|
||||||
|
|
||||||
|
alias Pinchflat.Repo
|
||||||
alias Pinchflat.Media
|
alias Pinchflat.Media
|
||||||
alias Pinchflat.Tasks
|
alias Pinchflat.Tasks
|
||||||
alias Pinchflat.Sources.Source
|
alias Pinchflat.Sources.Source
|
||||||
alias Pinchflat.Profiles.MediaProfile
|
alias Pinchflat.Profiles.MediaProfile
|
||||||
alias Pinchflat.YtDlp.MediaCollection
|
alias Pinchflat.YtDlp.MediaCollection
|
||||||
alias Pinchflat.Metadata.SourceMetadata
|
alias Pinchflat.Metadata.SourceMetadata
|
||||||
alias Pinchflat.Filesystem.FilesystemHelpers
|
alias Pinchflat.Utils.FilesystemUtils
|
||||||
alias Pinchflat.Downloading.DownloadingHelpers
|
alias Pinchflat.Downloading.DownloadingHelpers
|
||||||
alias Pinchflat.FastIndexing.FastIndexingWorker
|
alias Pinchflat.FastIndexing.FastIndexingWorker
|
||||||
alias Pinchflat.SlowIndexing.SlowIndexingHelpers
|
alias Pinchflat.SlowIndexing.SlowIndexingHelpers
|
||||||
alias Pinchflat.Metadata.SourceMetadataStorageWorker
|
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 """
|
@doc """
|
||||||
Returns the list of sources. Returns [%Source{}, ...]
|
Returns the list of sources. Returns [%Source{}, ...]
|
||||||
"""
|
"""
|
||||||
@@ -112,8 +126,9 @@ defmodule Pinchflat.Sources do
|
|||||||
delete_files = Keyword.get(opts, :delete_files, false)
|
delete_files = Keyword.get(opts, :delete_files, false)
|
||||||
Tasks.delete_tasks_for(source)
|
Tasks.delete_tasks_for(source)
|
||||||
|
|
||||||
source
|
MediaQuery.new()
|
||||||
|> Media.list_media_items_for()
|
|> where(^MediaQuery.for_source(source))
|
||||||
|
|> Repo.all()
|
||||||
|> Enum.each(fn media_item ->
|
|> Enum.each(fn media_item ->
|
||||||
Media.delete_media_item(media_item, delete_files: delete_files)
|
Media.delete_media_item(media_item, delete_files: delete_files)
|
||||||
end)
|
end)
|
||||||
@@ -151,7 +166,7 @@ defmodule Pinchflat.Sources do
|
|||||||
Source.filepath_attributes()
|
Source.filepath_attributes()
|
||||||
|> Enum.map(fn field -> mapped_struct[field] end)
|
|> Enum.map(fn field -> mapped_struct[field] end)
|
||||||
|> Enum.filter(&is_binary/1)
|
|> Enum.filter(&is_binary/1)
|
||||||
|> Enum.each(&FilesystemHelpers.delete_file_and_remove_empty_directories/1)
|
|> Enum.each(&FilesystemUtils.delete_file_and_remove_empty_directories/1)
|
||||||
end
|
end
|
||||||
|
|
||||||
defp delete_internal_metadata_files(source) do
|
defp delete_internal_metadata_files(source) do
|
||||||
@@ -161,11 +176,13 @@ defmodule Pinchflat.Sources do
|
|||||||
SourceMetadata.filepath_attributes()
|
SourceMetadata.filepath_attributes()
|
||||||
|> Enum.map(fn field -> mapped_struct[field] end)
|
|> Enum.map(fn field -> mapped_struct[field] end)
|
||||||
|> Enum.filter(&is_binary/1)
|
|> Enum.filter(&is_binary/1)
|
||||||
|> Enum.each(&FilesystemHelpers.delete_file_and_remove_empty_directories/1)
|
|> Enum.each(&FilesystemUtils.delete_file_and_remove_empty_directories/1)
|
||||||
end
|
end
|
||||||
|
|
||||||
defp add_source_details_to_changeset(source, changeset) do
|
defp add_source_details_to_changeset(source, changeset) do
|
||||||
case MediaCollection.get_source_details(changeset.changes.original_url) do
|
use_cookies = Ecto.Changeset.get_field(changeset, :use_cookies)
|
||||||
|
|
||||||
|
case MediaCollection.get_source_details(changeset.changes.original_url, [], use_cookies: use_cookies) do
|
||||||
{:ok, source_details} ->
|
{:ok, source_details} ->
|
||||||
add_source_details_by_collection_type(source, changeset, source_details)
|
add_source_details_by_collection_type(source, changeset, source_details)
|
||||||
|
|
||||||
@@ -222,7 +239,7 @@ defmodule Pinchflat.Sources do
|
|||||||
if run_post_commit_tasks do
|
if run_post_commit_tasks do
|
||||||
maybe_handle_media_tasks(changeset, source)
|
maybe_handle_media_tasks(changeset, source)
|
||||||
maybe_run_indexing_task(changeset, source)
|
maybe_run_indexing_task(changeset, source)
|
||||||
run_metadata_storage_task(source)
|
maybe_run_metadata_storage_task(changeset, source)
|
||||||
end
|
end
|
||||||
|
|
||||||
{:ok, source}
|
{:ok, source}
|
||||||
@@ -261,9 +278,20 @@ defmodule Pinchflat.Sources do
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# This runs every time to pick up any changes to the metadata
|
defp maybe_run_metadata_storage_task(changeset, source) do
|
||||||
defp run_metadata_storage_task(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)
|
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
|
end
|
||||||
|
|
||||||
defp maybe_update_slow_indexing_task(changeset, source) do
|
defp maybe_update_slow_indexing_task(changeset, source) do
|
||||||
@@ -273,7 +301,6 @@ defmodule Pinchflat.Sources do
|
|||||||
|
|
||||||
%{index_frequency_minutes: _} ->
|
%{index_frequency_minutes: _} ->
|
||||||
Tasks.delete_pending_tasks_for(source, "FastIndexingWorker")
|
Tasks.delete_pending_tasks_for(source, "FastIndexingWorker")
|
||||||
Tasks.delete_pending_tasks_for(source, "MediaIndexingWorker")
|
|
||||||
Tasks.delete_pending_tasks_for(source, "MediaCollectionIndexingWorker")
|
Tasks.delete_pending_tasks_for(source, "MediaCollectionIndexingWorker")
|
||||||
|
|
||||||
_ ->
|
_ ->
|
||||||
|
|||||||
@@ -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
|
||||||
@@ -53,20 +53,6 @@ defmodule Pinchflat.Tasks do
|
|||||||
)
|
)
|
||||||
end
|
end
|
||||||
|
|
||||||
@doc """
|
|
||||||
Returns the list of pending tasks for a given record type and ID. Optionally allows you to specify
|
|
||||||
which worker to include.
|
|
||||||
|
|
||||||
Returns [%Task{}, ...]
|
|
||||||
"""
|
|
||||||
def list_pending_tasks_for(record, worker_name \\ nil) do
|
|
||||||
list_tasks_for(
|
|
||||||
record,
|
|
||||||
worker_name,
|
|
||||||
[:available, :scheduled, :retryable]
|
|
||||||
)
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Gets a single task.
|
Gets a single task.
|
||||||
|
|
||||||
@@ -127,13 +113,13 @@ defmodule Pinchflat.Tasks do
|
|||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Deletes all tasks attached to a given record, cancelling any attached jobs.
|
Deletes all tasks attached to a given record, cancelling any attached jobs.
|
||||||
Optionally allows you to specify which worker to include.
|
Optionally allows you to specify which worker and job states to include.
|
||||||
|
|
||||||
Returns :ok
|
Returns :ok
|
||||||
"""
|
"""
|
||||||
def delete_tasks_for(record, worker_name \\ nil) do
|
def delete_tasks_for(record, worker_name \\ nil, job_states \\ Oban.Job.states()) do
|
||||||
record
|
record
|
||||||
|> list_tasks_for(worker_name)
|
|> list_tasks_for(worker_name, job_states)
|
||||||
|> Enum.each(&delete_task/1)
|
|> Enum.each(&delete_task/1)
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -143,10 +129,12 @@ defmodule Pinchflat.Tasks do
|
|||||||
|
|
||||||
Returns :ok
|
Returns :ok
|
||||||
"""
|
"""
|
||||||
def delete_pending_tasks_for(record, worker_name \\ nil) do
|
def delete_pending_tasks_for(record, worker_name \\ nil, opts \\ []) do
|
||||||
record
|
include_executing = Keyword.get(opts, :include_executing, false)
|
||||||
|> list_pending_tasks_for(worker_name)
|
base_job_states = [:available, :scheduled, :retryable]
|
||||||
|> Enum.each(&delete_task/1)
|
job_states = if include_executing, do: base_job_states ++ [:executing], else: base_job_states
|
||||||
|
|
||||||
|
delete_tasks_for(record, worker_name, job_states)
|
||||||
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
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
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
|
|
||||||
+34
-1
@@ -1,10 +1,43 @@
|
|||||||
defmodule Pinchflat.Filesystem.FilesystemHelpers do
|
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.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 """
|
||||||
|
Checks if two filepaths reference the same file.
|
||||||
|
|
||||||
|
Useful if you have a relative and absolute filepath and want to be sure they're the same file.
|
||||||
|
Also works with symlinks.
|
||||||
|
|
||||||
|
Returns boolean()
|
||||||
|
"""
|
||||||
|
def filepaths_reference_same_file?(filepath_1, filepath_2) do
|
||||||
|
{:ok, stat_1} = File.stat(filepath_1)
|
||||||
|
{:ok, stat_2} = File.stat(filepath_2)
|
||||||
|
|
||||||
|
identifier_1 = "#{stat_1.major_device}:#{stat_1.minor_device}:#{stat_1.inode}"
|
||||||
|
identifier_2 = "#{stat_2.major_device}:#{stat_2.minor_device}:#{stat_2.inode}"
|
||||||
|
|
||||||
|
identifier_1 == identifier_2
|
||||||
|
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.
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
defmodule Pinchflat.Utils.MapUtils do
|
||||||
|
@moduledoc """
|
||||||
|
Utility methods for working with maps
|
||||||
|
"""
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Converts a nested list of 2-element tuples or lists into a map.
|
||||||
|
|
||||||
|
Returns map()
|
||||||
|
"""
|
||||||
|
def from_nested_list(list) do
|
||||||
|
Enum.reduce(list, %{}, fn
|
||||||
|
[key, value], acc -> Map.put(acc, key, value)
|
||||||
|
{key, value}, acc -> Map.put(acc, key, value)
|
||||||
|
end)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,39 @@
|
|||||||
|
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
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Converts a number to a human readable byte size. Can take a precision
|
||||||
|
option to specify the number of decimal places to round to.
|
||||||
|
|
||||||
|
Returns {integer(), String.t()}
|
||||||
|
"""
|
||||||
|
def human_byte_size(number, opts \\ [])
|
||||||
|
def human_byte_size(nil, opts), do: human_byte_size(0, opts)
|
||||||
|
|
||||||
|
def human_byte_size(number, opts) do
|
||||||
|
precision = Keyword.get(opts, :precision, 2)
|
||||||
|
suffixes = ["B", "KB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB"]
|
||||||
|
base = 1024
|
||||||
|
|
||||||
|
Enum.reduce_while(suffixes, {number / 1.0, "B"}, fn suffix, {value, _} ->
|
||||||
|
if value < base do
|
||||||
|
{:halt, {Float.round(value, precision), suffix}}
|
||||||
|
else
|
||||||
|
{:cont, {value / base, suffix}}
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
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
|
||||||
@@ -3,13 +3,11 @@ defmodule Pinchflat.YtDlp.CommandRunner do
|
|||||||
Runs yt-dlp commands using the `System.cmd/3` function
|
Runs yt-dlp commands using the `System.cmd/3` function
|
||||||
"""
|
"""
|
||||||
|
|
||||||
require Logger
|
alias Pinchflat.Utils.CliUtils
|
||||||
|
alias Pinchflat.YtDlp.YtDlpCommandRunner
|
||||||
|
alias Pinchflat.Utils.FilesystemUtils, as: FSUtils
|
||||||
|
|
||||||
alias Pinchflat.Utils.StringUtils
|
@behaviour YtDlpCommandRunner
|
||||||
alias Pinchflat.Filesystem.FilesystemHelpers, as: FSUtils
|
|
||||||
alias Pinchflat.YtDlp.BackendCommandRunner
|
|
||||||
|
|
||||||
@behaviour BackendCommandRunner
|
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Runs a yt-dlp command and returns the string output. Saves the output to
|
Runs a yt-dlp command and returns the string output. Saves the output to
|
||||||
@@ -20,23 +18,24 @@ defmodule Pinchflat.YtDlp.CommandRunner do
|
|||||||
- :output_filepath - the path to save the output to. If not provided, a temporary
|
- :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
|
file will be created and used. Useful for if you need a reference to the file
|
||||||
for a file watcher.
|
for a file watcher.
|
||||||
|
- :use_cookies - if true, will add a cookie file to the command options. Will not
|
||||||
|
attach a cookie file if the user hasn't set one up.
|
||||||
|
|
||||||
Returns {:ok, binary()} | {:error, output, status}.
|
Returns {:ok, binary()} | {:error, output, status}.
|
||||||
"""
|
"""
|
||||||
@impl BackendCommandRunner
|
@impl YtDlpCommandRunner
|
||||||
def run(url, command_opts, output_template, addl_opts \\ []) do
|
def run(url, command_opts, output_template, addl_opts \\ []) do
|
||||||
# This approach lets us mock the command for testing
|
# This approach lets us mock the command for testing
|
||||||
command = backend_executable()
|
command = backend_executable()
|
||||||
# These must stay in exactly this order, hence why I'm giving it its own variable.
|
|
||||||
# Also, can't use RAM file since yt-dlp needs a concrete filepath.
|
output_filepath = generate_output_filepath(addl_opts)
|
||||||
output_filepath = Keyword.get(addl_opts, :output_filepath, FSUtils.generate_metadata_tmpfile(:json))
|
|
||||||
print_to_file_opts = [{:print_to_file, output_template}, output_filepath]
|
print_to_file_opts = [{:print_to_file, output_template}, output_filepath]
|
||||||
cookie_opts = build_cookie_options()
|
user_configured_opts = cookie_file_options(addl_opts)
|
||||||
formatted_command_opts = [url] ++ parse_options(command_opts ++ print_to_file_opts ++ cookie_opts)
|
# 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)
|
||||||
|
|
||||||
Logger.info("[yt-dlp] called with: #{Enum.join(formatted_command_opts, " ")}")
|
case CliUtils.wrap_cmd(command, formatted_command_opts, stderr_to_stdout: true) do
|
||||||
|
|
||||||
case System.cmd(command, formatted_command_opts, stderr_to_stdout: true) do
|
|
||||||
{_, 0} ->
|
{_, 0} ->
|
||||||
# IDEA: consider deleting the file after reading it. It's in the tmp dir, so it's not
|
# 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.
|
# a huge deal, but it's still a good idea to clean up after ourselves.
|
||||||
@@ -48,47 +47,59 @@ defmodule Pinchflat.YtDlp.CommandRunner do
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
defp build_cookie_options do
|
@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(addl_opts) do
|
||||||
|
case Keyword.get(addl_opts, :use_cookies) do
|
||||||
|
true -> add_cookie_file()
|
||||||
|
_ -> []
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp add_cookie_file do
|
||||||
base_dir = Application.get_env(:pinchflat, :extras_directory)
|
base_dir = Application.get_env(:pinchflat, :extras_directory)
|
||||||
cookie_file = Path.join(base_dir, "cookies.txt")
|
filename_options_map = %{cookies: "cookies.txt"}
|
||||||
|
|
||||||
case File.read(cookie_file) do
|
Enum.reduce(filename_options_map, [], fn {opt_name, filename}, acc ->
|
||||||
{:ok, cookie_data} ->
|
filepath = Path.join(base_dir, filename)
|
||||||
if String.trim(cookie_data) != "", do: [cookies: cookie_file], else: []
|
|
||||||
|
|
||||||
{:error, _} ->
|
if FSUtils.exists_and_nonempty?(filepath) do
|
||||||
[]
|
[{opt_name, filepath} | acc]
|
||||||
|
else
|
||||||
|
acc
|
||||||
end
|
end
|
||||||
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
|
end
|
||||||
|
|
||||||
defp backend_executable do
|
defp backend_executable do
|
||||||
|
|||||||
@@ -10,7 +10,8 @@ defmodule Pinchflat.YtDlp.Media do
|
|||||||
:original_url,
|
:original_url,
|
||||||
:livestream,
|
:livestream,
|
||||||
:short_form_content,
|
:short_form_content,
|
||||||
:upload_date
|
:uploaded_at,
|
||||||
|
:duration_seconds
|
||||||
]
|
]
|
||||||
|
|
||||||
defstruct [
|
defstruct [
|
||||||
@@ -20,7 +21,9 @@ defmodule Pinchflat.YtDlp.Media do
|
|||||||
:original_url,
|
:original_url,
|
||||||
:livestream,
|
:livestream,
|
||||||
:short_form_content,
|
:short_form_content,
|
||||||
:upload_date
|
:uploaded_at,
|
||||||
|
:duration_seconds,
|
||||||
|
:playlist_index
|
||||||
]
|
]
|
||||||
|
|
||||||
alias __MODULE__
|
alias __MODULE__
|
||||||
@@ -33,10 +36,10 @@ defmodule Pinchflat.YtDlp.Media do
|
|||||||
|
|
||||||
Returns {:ok, map()} | {:error, any, ...}.
|
Returns {:ok, map()} | {:error, any, ...}.
|
||||||
"""
|
"""
|
||||||
def download(url, command_opts \\ []) do
|
def download(url, command_opts \\ [], addl_opts \\ []) do
|
||||||
opts = [:no_simulate] ++ command_opts
|
all_command_opts = [:no_simulate] ++ command_opts
|
||||||
|
|
||||||
with {:ok, output} <- backend_runner().run(url, opts, "after_move:%()j"),
|
with {:ok, output} <- backend_runner().run(url, all_command_opts, "after_move:%()j", addl_opts),
|
||||||
{:ok, parsed_json} <- Phoenix.json_library().decode(output) do
|
{:ok, parsed_json} <- Phoenix.json_library().decode(output) do
|
||||||
{:ok, parsed_json}
|
{:ok, parsed_json}
|
||||||
else
|
else
|
||||||
@@ -44,33 +47,49 @@ defmodule Pinchflat.YtDlp.Media do
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Downloads a thumbnail for a single piece of media. Usually used for
|
||||||
|
downloading thumbnails for internal use
|
||||||
|
|
||||||
|
Returns {:ok, ""} | {:error, any, ...}.
|
||||||
|
"""
|
||||||
|
def download_thumbnail(url, command_opts \\ [], addl_opts \\ []) do
|
||||||
|
all_command_opts = [:no_simulate, :skip_download, :write_thumbnail, convert_thumbnail: "jpg"] ++ command_opts
|
||||||
|
|
||||||
|
# NOTE: it doesn't seem like this command actually returns anything in `after_move` since
|
||||||
|
# we aren't downloading the main media file
|
||||||
|
backend_runner().run(url, all_command_opts, "after_move:%()j", addl_opts)
|
||||||
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Returns a map representing the media at the given URL.
|
Returns a map representing the media at the given URL.
|
||||||
|
|
||||||
Returns {:ok, [map()]} | {:error, any, ...}.
|
Returns {:ok, %Media{}} | {:error, any, ...}.
|
||||||
"""
|
"""
|
||||||
def get_media_attributes(url) do
|
def get_media_attributes(url, addl_opts \\ []) do
|
||||||
runner = Application.get_env(:pinchflat, :yt_dlp_runner)
|
runner = Application.get_env(:pinchflat, :yt_dlp_runner)
|
||||||
command_opts = [:simulate, :skip_download]
|
command_opts = [:simulate, :skip_download]
|
||||||
output_template = indexing_output_template()
|
output_template = indexing_output_template()
|
||||||
|
|
||||||
case runner.run(url, command_opts, output_template) do
|
case runner.run(url, command_opts, output_template, addl_opts) do
|
||||||
{:ok, output} ->
|
{:ok, output} ->
|
||||||
output
|
output
|
||||||
|> Phoenix.json_library().decode!()
|
|> Phoenix.json_library().decode!()
|
||||||
|> response_to_struct()
|
|> response_to_struct()
|
||||||
|> FunctionUtils.wrap_ok()
|
|> FunctionUtils.wrap_ok()
|
||||||
|
|
||||||
res ->
|
err ->
|
||||||
res
|
err
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Returns the output template for yt-dlp's indexing command.
|
Returns the output template for yt-dlp's indexing command.
|
||||||
|
|
||||||
|
NOTE: playlist_index is really only useful for playlists that will never change their order.
|
||||||
"""
|
"""
|
||||||
def indexing_output_template do
|
def indexing_output_template do
|
||||||
"%(.{id,title,was_live,webpage_url,description,aspect_ratio,duration,upload_date})j"
|
"%(.{id,title,live_status,webpage_url,description,aspect_ratio,duration,upload_date,timestamp,playlist_index})j"
|
||||||
end
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
@@ -85,9 +104,11 @@ defmodule Pinchflat.YtDlp.Media do
|
|||||||
title: response["title"],
|
title: response["title"],
|
||||||
description: response["description"],
|
description: response["description"],
|
||||||
original_url: response["webpage_url"],
|
original_url: response["webpage_url"],
|
||||||
livestream: response["was_live"],
|
livestream: !!response["live_status"] && response["live_status"] != "not_live",
|
||||||
|
duration_seconds: response["duration"] && round(response["duration"]),
|
||||||
short_form_content: response["webpage_url"] && short_form_content?(response),
|
short_form_content: response["webpage_url"] && short_form_content?(response),
|
||||||
upload_date: response["upload_date"] && MetadataFileHelpers.parse_upload_date(response["upload_date"])
|
uploaded_at: response["upload_date"] && parse_uploaded_at(response),
|
||||||
|
playlist_index: response["playlist_index"] || 0
|
||||||
}
|
}
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -103,10 +124,22 @@ defmodule Pinchflat.YtDlp.Media do
|
|||||||
#
|
#
|
||||||
# These don't fail if duration or aspect_ratio are missing
|
# These don't fail if duration or aspect_ratio are missing
|
||||||
# due to Elixir's comparison semantics
|
# due to Elixir's comparison semantics
|
||||||
response["duration"] <= 60 && response["aspect_ratio"] < 0.8
|
response["duration"] <= 60 && response["aspect_ratio"] <= 0.85
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
defp parse_uploaded_at(%{"timestamp" => ts} = response) when is_number(ts) do
|
||||||
|
case DateTime.from_unix(ts) do
|
||||||
|
{:ok, datetime} -> datetime
|
||||||
|
_ -> MetadataFileHelpers.parse_upload_date(response["upload_date"])
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# This field is needed before inserting into the database, but absence
|
||||||
|
# of this field should fail at insert-time rather than here
|
||||||
|
defp parse_uploaded_at(%{"upload_date" => nil}), do: nil
|
||||||
|
defp parse_uploaded_at(response), do: MetadataFileHelpers.parse_upload_date(response["upload_date"])
|
||||||
|
|
||||||
defp backend_runner do
|
defp backend_runner do
|
||||||
# This approach lets us mock the command for testing
|
# This approach lets us mock the command for testing
|
||||||
Application.get_env(:pinchflat, :yt_dlp_runner)
|
Application.get_env(:pinchflat, :yt_dlp_runner)
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ defmodule Pinchflat.YtDlp.MediaCollection do
|
|||||||
|
|
||||||
require Logger
|
require Logger
|
||||||
|
|
||||||
alias Pinchflat.Filesystem.FilesystemHelpers
|
alias Pinchflat.Utils.FilesystemUtils
|
||||||
alias Pinchflat.YtDlp.Media, as: YtDlpMedia
|
alias Pinchflat.YtDlp.Media, as: YtDlpMedia
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
@@ -24,16 +24,18 @@ defmodule Pinchflat.YtDlp.MediaCollection do
|
|||||||
# `ignore_no_formats_error` is necessary because yt-dlp will error out if
|
# `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
|
# 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
|
# available formats since we're just getting the media details
|
||||||
command_opts = [:simulate, :skip_download, :ignore_no_formats_error]
|
command_opts = [:simulate, :skip_download, :ignore_no_formats_error, :no_warnings]
|
||||||
|
use_cookies = Keyword.get(addl_opts, :use_cookies, false)
|
||||||
output_template = YtDlpMedia.indexing_output_template()
|
output_template = YtDlpMedia.indexing_output_template()
|
||||||
output_filepath = FilesystemHelpers.generate_metadata_tmpfile(:json)
|
output_filepath = FilesystemUtils.generate_metadata_tmpfile(:json)
|
||||||
file_listener_handler = Keyword.get(addl_opts, :file_listener_handler, false)
|
file_listener_handler = Keyword.get(addl_opts, :file_listener_handler, false)
|
||||||
|
runner_opts = [output_filepath: output_filepath, use_cookies: use_cookies]
|
||||||
|
|
||||||
if file_listener_handler do
|
if file_listener_handler do
|
||||||
file_listener_handler.(output_filepath)
|
file_listener_handler.(output_filepath)
|
||||||
end
|
end
|
||||||
|
|
||||||
case runner.run(url, command_opts, output_template, output_filepath: output_filepath) do
|
case runner.run(url, command_opts, output_template, runner_opts) do
|
||||||
{:ok, output} ->
|
{:ok, output} ->
|
||||||
parsed_lines =
|
parsed_lines =
|
||||||
output
|
output
|
||||||
@@ -50,8 +52,8 @@ defmodule Pinchflat.YtDlp.MediaCollection do
|
|||||||
|
|
||||||
{:ok, Enum.filter(parsed_lines, &(&1 != nil))}
|
{:ok, Enum.filter(parsed_lines, &(&1 != nil))}
|
||||||
|
|
||||||
res ->
|
err ->
|
||||||
res
|
err
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -64,14 +66,21 @@ defmodule Pinchflat.YtDlp.MediaCollection do
|
|||||||
|
|
||||||
Returns {:ok, map()} | {:error, any, ...}.
|
Returns {:ok, map()} | {:error, any, ...}.
|
||||||
"""
|
"""
|
||||||
def get_source_details(source_url, addl_opts \\ []) do
|
def get_source_details(source_url, command_opts \\ [], addl_opts \\ []) do
|
||||||
# `ignore_no_formats_error` is necessary because yt-dlp will error out if
|
# `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
|
# 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
|
# available formats since we're just getting the source details
|
||||||
command_opts = [:simulate, :skip_download, :ignore_no_formats_error, playlist_end: 1] ++ addl_opts
|
default_opts = [
|
||||||
|
:simulate,
|
||||||
|
:skip_download,
|
||||||
|
:ignore_no_formats_error,
|
||||||
|
playlist_end: 1
|
||||||
|
]
|
||||||
|
|
||||||
|
all_command_opts = default_opts ++ command_opts
|
||||||
output_template = "%(.{channel,channel_id,playlist_id,playlist_title,filename})j"
|
output_template = "%(.{channel,channel_id,playlist_id,playlist_title,filename})j"
|
||||||
|
|
||||||
with {:ok, output} <- backend_runner().run(source_url, command_opts, output_template),
|
with {:ok, output} <- backend_runner().run(source_url, all_command_opts, output_template, addl_opts),
|
||||||
{:ok, parsed_json} <- Phoenix.json_library().decode(output) do
|
{:ok, parsed_json} <- Phoenix.json_library().decode(output) do
|
||||||
{:ok, format_source_details(parsed_json)}
|
{:ok, format_source_details(parsed_json)}
|
||||||
else
|
else
|
||||||
@@ -92,13 +101,24 @@ defmodule Pinchflat.YtDlp.MediaCollection do
|
|||||||
as a compressed blob for possible future use. That's why it's not getting formatted like
|
as a compressed blob for possible future use. That's why it's not getting formatted like
|
||||||
`get_source_details/1`
|
`get_source_details/1`
|
||||||
|
|
||||||
|
! IMPORTANT ! - you'll always want to set `playlist_items: int` in `addl_opts.
|
||||||
|
This is great if you want to also return details about the videos in the playlists,
|
||||||
|
but it should be set in all cases to not over-fetch data.
|
||||||
|
For channels you should usually set this to 0 since channels return all the
|
||||||
|
metadata we need without needing to fetch the videos. On the other hand, playlists
|
||||||
|
don't return very useful images so you can set this to 1 to get the first video's
|
||||||
|
images, for instance.
|
||||||
|
|
||||||
Returns {:ok, map()} | {:error, any, ...}.
|
Returns {:ok, map()} | {:error, any, ...}.
|
||||||
"""
|
"""
|
||||||
def get_source_metadata(source_url, addl_opts \\ []) do
|
def get_source_metadata(source_url, command_opts, addl_opts \\ []) do
|
||||||
opts = [playlist_items: 0] ++ addl_opts
|
# This only validates that the `playlist_items` key is present. It's otherwise unused
|
||||||
|
_playlist_items = Keyword.fetch!(command_opts, :playlist_items)
|
||||||
|
|
||||||
|
all_command_opts = [:skip_download] ++ command_opts
|
||||||
output_template = "playlist:%()j"
|
output_template = "playlist:%()j"
|
||||||
|
|
||||||
with {:ok, output} <- backend_runner().run(source_url, opts, output_template),
|
with {:ok, output} <- backend_runner().run(source_url, all_command_opts, output_template, addl_opts),
|
||||||
{:ok, parsed_json} <- Phoenix.json_library().decode(output) do
|
{:ok, parsed_json} <- Phoenix.json_library().decode(output) do
|
||||||
{:ok, parsed_json}
|
{:ok, parsed_json}
|
||||||
else
|
else
|
||||||
|
|||||||
+2
-1
@@ -1,4 +1,4 @@
|
|||||||
defmodule Pinchflat.YtDlp.BackendCommandRunner do
|
defmodule Pinchflat.YtDlp.YtDlpCommandRunner do
|
||||||
@moduledoc """
|
@moduledoc """
|
||||||
A behaviour for running CLI commands against a downloader backend (yt-dlp).
|
A behaviour for running CLI commands against a downloader backend (yt-dlp).
|
||||||
|
|
||||||
@@ -8,4 +8,5 @@ defmodule Pinchflat.YtDlp.BackendCommandRunner do
|
|||||||
|
|
||||||
@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
|
||||||
@@ -247,11 +247,12 @@ defmodule PinchflatWeb.CoreComponents do
|
|||||||
attr :label_suffix, :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]"
|
||||||
|
|
||||||
@@ -266,6 +267,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
|
||||||
@@ -298,7 +300,34 @@ defmodule PinchflatWeb.CoreComponents do
|
|||||||
<%= @label %>
|
<%= @label %>
|
||||||
<span :if={@label_suffix} class="text-xs text-bodydark"><%= @label_suffix %></span>
|
<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>
|
||||||
"""
|
"""
|
||||||
@@ -329,7 +358,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>
|
||||||
@@ -360,7 +389,7 @@ defmodule PinchflatWeb.CoreComponents do
|
|||||||
</select>
|
</select>
|
||||||
<%= render_slot(@inner_block) %>
|
<%= render_slot(@inner_block) %>
|
||||||
</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>
|
||||||
"""
|
"""
|
||||||
@@ -384,7 +413,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>
|
||||||
"""
|
"""
|
||||||
@@ -397,21 +426,24 @@ defmodule PinchflatWeb.CoreComponents do
|
|||||||
<.label for={@id}>
|
<.label for={@id}>
|
||||||
<%= @label %><span :if={@label_suffix} class="text-xs text-bodydark"><%= @label_suffix %></span>
|
<%= @label %><span :if={@label_suffix} class="text-xs text-bodydark"><%= @label_suffix %></span>
|
||||||
</.label>
|
</.label>
|
||||||
|
<div class="flex items-center">
|
||||||
<input
|
<input
|
||||||
type={@type}
|
type={@type}
|
||||||
name={@name}
|
name={@name}
|
||||||
id={@id}
|
id={@id}
|
||||||
value={Phoenix.HTML.Form.normalize_value(@type, @value)}
|
value={Phoenix.HTML.Form.normalize_value(@type, @value)}
|
||||||
class={[
|
class={[
|
||||||
"w-full rounded-lg border-[1.5px] border-stroke bg-transparent px-5 py-3 font-normal text-black",
|
"w-full rounded-lg border-[1.5px] px-5 py-3 font-normal border-form-strokedark bg-form-input",
|
||||||
"outline-none transition focus:border-primary active:border-primary disabled:cursor-default disabled:bg-whiter",
|
"outline-none transition active:border-primary disabled:cursor-default disabled:bg-whiter",
|
||||||
"dark:border-form-strokedark dark:bg-form-input dark:text-white dark:focus:border-primary",
|
"text-white focus:border-primary",
|
||||||
@inputclass,
|
@inputclass,
|
||||||
@errors != [] && "border-rose-400 focus:border-rose-400"
|
@errors != [] && "border-rose-400 focus:border-rose-400"
|
||||||
]}
|
]}
|
||||||
{@rest}
|
{@rest}
|
||||||
/>
|
/>
|
||||||
<.help :if={@help}><%= @help %></.help>
|
<%= 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>
|
||||||
"""
|
"""
|
||||||
@@ -601,14 +633,24 @@ defmodule PinchflatWeb.CoreComponents do
|
|||||||
_ ->
|
_ ->
|
||||||
true
|
true
|
||||||
end)
|
end)
|
||||||
|
|> Enum.map(fn
|
||||||
|
{k, v} when is_list(v) -> {k, Enum.join(v, ", ")}
|
||||||
|
rest -> rest
|
||||||
|
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">
|
||||||
|
<%= if is_binary(v) && URI.parse(v).scheme && URI.parse(v).scheme =~ "http" do %>
|
||||||
|
<TextComponents.inline_link href={v}><%= v %></TextComponents.inline_link>
|
||||||
|
<% else %>
|
||||||
|
<%= v %>
|
||||||
|
<% end %>
|
||||||
|
</code>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
"""
|
"""
|
||||||
|
|||||||
@@ -89,4 +89,46 @@ defmodule PinchflatWeb.CustomComponents.ButtonComponents do
|
|||||||
</div>
|
</div>
|
||||||
"""
|
"""
|
||||||
end
|
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,24 +6,32 @@ 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
|
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"
|
||||||
>
|
>
|
||||||
<header class="flex flex-col md:flex-row md:justify-between border-b border-strokedark">
|
<header class="flex flex-col md:flex-row md:justify-between border-b border-strokedark">
|
||||||
<div class="flex flex-wrap gap-5 sm:gap-10">
|
<div class="flex flex-wrap gap-5 sm:gap-10">
|
||||||
<a
|
<a
|
||||||
:for={{tab, idx} <- Enum.with_index(@tab)}
|
:for={tab <- @tab}
|
||||||
href="#"
|
href="#"
|
||||||
@click.prevent={"openTab = #{idx}"}
|
@click.prevent={"openTab = setTabByName('#{tab.id}')"}
|
||||||
x-bind:class={"openTab === #{idx} ? activeClasses : inactiveClasses"}
|
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"
|
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>
|
<span class="text-xl"><%= tab.title %></span>
|
||||||
@@ -33,8 +41,8 @@ defmodule PinchflatWeb.CustomComponents.TabComponents do
|
|||||||
<%= render_slot(@tab_append) %>
|
<%= render_slot(@tab_append) %>
|
||||||
</div>
|
</div>
|
||||||
</header>
|
</header>
|
||||||
<div class="mt-4">
|
<div class="mt-4 min-h-60">
|
||||||
<div :for={{tab, idx} <- Enum.with_index(@tab)} x-show={"openTab === #{idx}"} class="font-medium leading-relaxed">
|
<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,9 @@ defmodule PinchflatWeb.CustomComponents.TableComponents do
|
|||||||
@moduledoc false
|
@moduledoc false
|
||||||
use Phoenix.Component
|
use Phoenix.Component
|
||||||
|
|
||||||
|
import PinchflatWeb.CoreComponents
|
||||||
|
import PinchflatWeb.CustomComponents.TextComponents
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Renders a table component with the given rows and columns.
|
Renders a table component with the given rows and columns.
|
||||||
|
|
||||||
@@ -25,21 +28,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 +52,54 @@ 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"
|
||||||
|
>
|
||||||
|
<.icon name="hero-chevron-left" />
|
||||||
|
</span>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<span class="mx-2">
|
||||||
|
Page <.localized_number number={@page_number} /> of <.localized_number number={@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"
|
||||||
|
>
|
||||||
|
<.icon name="hero-chevron-right" />
|
||||||
|
</span>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
"""
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -35,11 +35,12 @@ defmodule PinchflatWeb.CustomComponents.TextComponents do
|
|||||||
Renders a subtle link with the given href and content.
|
Renders a subtle link with the given href and content.
|
||||||
"""
|
"""
|
||||||
attr :href, :string, required: true
|
attr :href, :string, required: true
|
||||||
|
attr :target, :string, default: "_self"
|
||||||
slot :inner_block
|
slot :inner_block
|
||||||
|
|
||||||
def subtle_link(assigns) do
|
def subtle_link(assigns) do
|
||||||
~H"""
|
~H"""
|
||||||
<.link href={@href} class="underline decoration-bodydark decoration-1 hover:decoration-white">
|
<.link href={@href} target={@target} class="underline decoration-bodydark decoration-1 hover:decoration-white">
|
||||||
<%= render_slot(@inner_block) %>
|
<%= render_slot(@inner_block) %>
|
||||||
</.link>
|
</.link>
|
||||||
"""
|
"""
|
||||||
@@ -59,4 +60,62 @@ 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
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Renders a localized number using the Intl.NumberFormat API, falling back to the raw number if needed
|
||||||
|
"""
|
||||||
|
attr :number, :any, required: true
|
||||||
|
|
||||||
|
def localized_number(assigns) do
|
||||||
|
~H"""
|
||||||
|
<span x-data x-text={"Intl.NumberFormat().format(#{@number})"}><%= @number %></span>
|
||||||
|
"""
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Renders a word with a suffix if the count is not 1
|
||||||
|
"""
|
||||||
|
attr :word, :string, required: true
|
||||||
|
attr :count, :integer, required: true
|
||||||
|
attr :suffix, :string, default: "s"
|
||||||
|
|
||||||
|
def pluralize(assigns) do
|
||||||
|
~H"""
|
||||||
|
<%= @word %><%= if @count == 1, do: "", else: @suffix %>
|
||||||
|
"""
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -4,28 +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 :href, :any, required: true
|
attr :href, :any, required: true
|
||||||
attr :target, :any, default: "_self"
|
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">
|
||||||
|
<.sidebar_link icon={@icon} text={@text} href={@href} target={@target} />
|
||||||
|
</li>
|
||||||
|
"""
|
||||||
|
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-cloak x-show="selected">
|
||||||
|
<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
|
<.link
|
||||||
href={@href}
|
href={@href}
|
||||||
target={@target}
|
target={@target}
|
||||||
class={[
|
class={[
|
||||||
"font-medium text-bodydark1",
|
"font-medium",
|
||||||
"group relative flex items-center gap-2.5 rounded-sm px-4 py-2 duration-300 ease-in-out",
|
"group relative flex items-center gap-2.5 rounded-sm px-4 py-2 duration-300 ease-in-out",
|
||||||
"duration-300 ease-in-out",
|
"duration-300 ease-in-out",
|
||||||
"hover:bg-graydark dark:hover:bg-meta-4"
|
"hover:bg-meta-4",
|
||||||
|
@class
|
||||||
]}
|
]}
|
||||||
>
|
>
|
||||||
<.icon name={@icon} /> <%= @text %>
|
<.icon :if={@icon} name={@icon} /> <%= @text %>
|
||||||
</.link>
|
</.link>
|
||||||
</li>
|
|
||||||
"""
|
"""
|
||||||
end
|
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} />
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
<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="w-65 px-4 py-2 shadow-2 md:px-6">
|
<div class="w-65 px-4 py-2 shadow-2 md:px-6">
|
||||||
<div class="flex items-center gap-2 py-2">
|
<div class="flex items-center gap-2 py-2">
|
||||||
<img src={~p"/images/logo.png?cachebust=2024-03-20"} alt="Pinchflat" class="w-auto" />
|
<img src={~p"/images/logo-2024-03-20.png"} alt="Pinchflat" class="w-auto" />
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</header>
|
</header>
|
||||||
|
|||||||
@@ -3,21 +3,22 @@
|
|||||||
<h3 class="text-2xl text-white">Donate</h3>
|
<h3 class="text-2xl text-white">Donate</h3>
|
||||||
<p class="text-sm">Thank you for your support :)</p>
|
<p class="text-sm">Thank you for your support :)</p>
|
||||||
<p class="mt-4">
|
<p class="mt-4">
|
||||||
If you find the project valuable and want to support its development, a
|
If you find the project valuable and want to say thanks, a
|
||||||
<.inline_link href="https://www.paypal.me/kieraneglin">donation</.inline_link>
|
<.inline_link href="https://supporters.eff.org/donate">
|
||||||
would be greatly appreciated.
|
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>
|
||||||
<p class="mt-4">
|
<p class="mt-4">
|
||||||
Plus, $5 USD from any donation over $10 USD will be donated to
|
The Electronic Frontier Foundation is a nonprofit organization who defend your online liberties and backed
|
||||||
<.inline_link href="https://www.eff.org/">The Electronic Frontier Foundation</.inline_link>
|
|
||||||
who defend your online liberties and backed
|
|
||||||
<.inline_code>youtube-dl</.inline_code>
|
<.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">
|
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" />
|
<.icon name="hero-arrow-top-right-on-square" class="h-3 w-3" />
|
||||||
</.inline_link>.
|
</.inline_link>
|
||||||
</p>
|
</p>
|
||||||
|
<.link href="https://supporters.eff.org/donate" target="_blank">
|
||||||
<.link href="https://www.paypal.me/kieraneglin" target="_blank">
|
|
||||||
<.button color="bg-primary" class="w-full mt-8">
|
<.button color="bg-primary" class="w-full mt-8">
|
||||||
Donate
|
Donate
|
||||||
</.button>
|
</.button>
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
<header class="sticky top-0 z-999 flex h-20 w-full bg-white drop-shadow-1 dark:bg-boxdark dark:drop-shadow-none">
|
<header class="sticky top-0 z-999 flex min-h-20 w-full bg-white drop-shadow-1 dark:bg-boxdark dark:drop-shadow-none">
|
||||||
<div class="flex flex-grow items-center justify-between lg:justify-end px-4 py-4 shadow-2 md:px-6 2xl:px-11">
|
<div class="flex flex-grow items-center justify-between lg:justify-end px-4 py-4 shadow-2 md:px-6 2xl:px-11">
|
||||||
<div class="flex items-center gap-2 sm:gap-4 lg:hidden w-2/6">
|
<div class="flex items-center gap-2 sm:gap-4 lg:hidden w-2/6">
|
||||||
<section class="pr-1">
|
<section class="pr-1">
|
||||||
<img src={~p"/images/icon.png?cachebust=2024-03-20"} alt="Pinchflat" class="w-10" />
|
<img src={~p"/images/icon-2024-03-20.png"} alt="Pinchflat" class="w-10" />
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
<button
|
<button
|
||||||
@@ -22,7 +22,7 @@
|
|||||||
type="text"
|
type="text"
|
||||||
name="q"
|
name="q"
|
||||||
value={@params["q"]}
|
value={@params["q"]}
|
||||||
placeholder="Type to search..."
|
placeholder="Search all media..."
|
||||||
class="w-full bg-transparent pl-9 pr-4 border-0 focus:ring-0 focus:outline-none"
|
class="w-full bg-transparent pl-9 pr-4 border-0 focus:ring-0 focus:outline-none"
|
||||||
/>
|
/>
|
||||||
</form>
|
</form>
|
||||||
|
|||||||
@@ -9,7 +9,7 @@
|
|||||||
<section>
|
<section>
|
||||||
<div class="flex items-center justify-between gap-2 px-6 py-4">
|
<div class="flex items-center justify-between gap-2 px-6 py-4">
|
||||||
<a href="/" class="flex items-center">
|
<a href="/" class="flex items-center">
|
||||||
<img src={~p"/images/logo.png?cachebust=2024-03-20"} alt="Pinchflat" class="w-auto" />
|
<img src={~p"/images/logo-2024-03-20.png"} alt="Pinchflat" class="w-auto" />
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
<button class="block mt-3 lg:hidden" @click.stop="sidebarVisible = !sidebarVisible">
|
<button class="block mt-3 lg:hidden" @click.stop="sidebarVisible = !sidebarVisible">
|
||||||
@@ -18,12 +18,22 @@
|
|||||||
</div>
|
</div>
|
||||||
<div class="no-scrollbar flex flex-col overflow-y-auto duration-300 ease-linear">
|
<div class="no-scrollbar flex flex-col overflow-y-auto duration-300 ease-linear">
|
||||||
<nav class="mt-3 px-4 py-4 lg:px-6">
|
<nav class="mt-3 px-4 py-4 lg:px-6">
|
||||||
<h3 class="mb-4 ml-4 text-sm font-medium text-bodydark2">MENU</h3>
|
<h3 class="mb-4 ml-4 text-sm font-medium text-bodydark2">
|
||||||
|
<span>MENU</span>
|
||||||
|
</h3>
|
||||||
<div class="flex flex-col justify-between">
|
<div class="flex flex-col justify-between">
|
||||||
<ul class="mb-6 flex flex-col gap-1.5">
|
<ul class="mb-6 flex flex-col gap-1.5">
|
||||||
<.sidebar_item icon="hero-home" text="Home" href={~p"/"} />
|
<.sidebar_item icon="hero-home" text="Home" href={~p"/"} />
|
||||||
<.sidebar_item icon="hero-tv" text="Sources" href={~p"/sources"} />
|
<.sidebar_item icon="hero-tv" text="Sources" href={~p"/sources"} />
|
||||||
<.sidebar_item icon="hero-adjustments-vertical" text="Media Profiles" href={~p"/media_profiles"} />
|
<.sidebar_item icon="hero-adjustments-vertical" text="Media Profiles" href={~p"/media_profiles"} />
|
||||||
|
<.sidebar_submenu
|
||||||
|
icon="hero-cog-6-tooth"
|
||||||
|
text="Config"
|
||||||
|
current_path={Phoenix.Controller.current_path(@conn)}
|
||||||
|
>
|
||||||
|
<:submenu text="Settings" href={~p"/settings"} />
|
||||||
|
<:submenu text="App Info" href={~p"/app_info"} />
|
||||||
|
</.sidebar_submenu>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
</nav>
|
</nav>
|
||||||
@@ -38,12 +48,7 @@
|
|||||||
target="_blank"
|
target="_blank"
|
||||||
href="https://github.com/kieraneglin/pinchflat/wiki"
|
href="https://github.com/kieraneglin/pinchflat/wiki"
|
||||||
/>
|
/>
|
||||||
<.sidebar_item
|
<.sidebar_item icon="hero-cog" text="Github" target="_blank" href="https://github.com/kieraneglin/pinchflat" />
|
||||||
icon="hero-code-bracket"
|
|
||||||
text="Github"
|
|
||||||
target="_blank"
|
|
||||||
href="https://github.com/kieraneglin/pinchflat"
|
|
||||||
/>
|
|
||||||
<li>
|
<li>
|
||||||
<span
|
<span
|
||||||
class={[
|
class={[
|
||||||
@@ -58,8 +63,23 @@
|
|||||||
</span>
|
</span>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
<li>
|
||||||
<span class="group relative flex items-center gap-2.5 px-4 py-2 text-sm">
|
<span
|
||||||
v<%= Application.spec(:pinchflat)[:vsn] %>
|
class="group relative flex items-center gap-2.5 px-4 pt-2 text-sm"
|
||||||
|
x-on:click={"markVersionAsSeen('#{Application.spec(:pinchflat)[:vsn]}')"}
|
||||||
|
>
|
||||||
|
<span>Pinchflat <%= Application.spec(:pinchflat)[:vsn] %></span>
|
||||||
|
<a
|
||||||
|
href="https://github.com/kieraneglin/pinchflat/releases"
|
||||||
|
target="_blank"
|
||||||
|
class="bg-meta-2 text-boxdark px-1.5 rounded-full text-xs"
|
||||||
|
x-cloak
|
||||||
|
x-show={"!isVersionSeen('#{Application.spec(:pinchflat)[:vsn]}')"}
|
||||||
|
>
|
||||||
|
NEW
|
||||||
|
</a>
|
||||||
|
</span>
|
||||||
|
<span class="group relative flex items-center gap-2.5 px-4 pt-2 text-sm">
|
||||||
|
yt-dlp <%= Settings.get!(:yt_dlp_version) %>
|
||||||
</span>
|
</span>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|||||||
@@ -3,10 +3,11 @@ defmodule Pinchflat.UpgradeButtonLive do
|
|||||||
|
|
||||||
def render(assigns) do
|
def render(assigns) do
|
||||||
~H"""
|
~H"""
|
||||||
<form phx-change="check_matching_text">
|
<form id="upgradeForm" phx-change="check_matching_text" phx-hook="supressEnterSubmission">
|
||||||
<.input type="text" name="unlock-pro-textbox" value="" />
|
<.input type="text" name="unlock-pro-textbox" value="" />
|
||||||
</form>
|
</form>
|
||||||
|
|
||||||
|
<%!-- The setTimeout is so the modal has time to disappear before it's removed --%>
|
||||||
<.button
|
<.button
|
||||||
class="w-full mt-4"
|
class="w-full mt-4"
|
||||||
type="button"
|
type="button"
|
||||||
@@ -29,8 +30,8 @@ defmodule Pinchflat.UpgradeButtonLive do
|
|||||||
|> String.trim()
|
|> String.trim()
|
||||||
|> String.downcase()
|
|> String.downcase()
|
||||||
|
|
||||||
if normalized_text == "got it!" do
|
if normalized_text == "got it" do
|
||||||
Settings.set!(:pro_enabled, true)
|
Settings.set(pro_enabled: true)
|
||||||
|
|
||||||
{:noreply, update(socket, :button_disabled, fn _ -> false end)}
|
{:noreply, update(socket, :button_disabled, fn _ -> false end)}
|
||||||
else
|
else
|
||||||
|
|||||||
@@ -3,23 +3,25 @@
|
|||||||
<h3 class="text-2xl text-white">Pro Mode</h3>
|
<h3 class="text-2xl text-white">Pro Mode</h3>
|
||||||
<p class="text-sm">Don't worry - Pinchflat is completely free :)</p>
|
<p class="text-sm">Don't worry - Pinchflat is completely free :)</p>
|
||||||
<p class="mt-4">
|
<p class="mt-4">
|
||||||
If you find the project valuable and want to support its development, a
|
If you find the project valuable and want to say thanks, a
|
||||||
<.inline_link href="https://www.paypal.me/kieraneglin">donation</.inline_link>
|
<.inline_link href="https://supporters.eff.org/donate">
|
||||||
would be greatly appreciated.
|
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>
|
||||||
<p class="mt-4">
|
<p class="mt-4">
|
||||||
Plus, $5 USD from any donation over $10 USD will be donated to
|
The Electronic Frontier Foundation is a nonprofit organization who defend your online liberties and backed
|
||||||
<.inline_link href="https://www.eff.org/">The Electronic Frontier Foundation</.inline_link>
|
|
||||||
who defend your online liberties and backed
|
|
||||||
<.inline_code>youtube-dl</.inline_code>
|
<.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">
|
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" />
|
<.icon name="hero-arrow-top-right-on-square" class="h-3 w-3" />
|
||||||
</.inline_link>. <strong>You do not need to donate to unlock Pro</strong>. It's just a way to say thanks!
|
</.inline_link>. <strong>You do not need to donate to unlock Pro</strong>. It's just a way to show support!
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<p class="mt-4">
|
<p class="mt-4">
|
||||||
To unlock Pro, simply type
|
To unlock Pro, simply type
|
||||||
<.inline_code>got it!</.inline_code>
|
<.inline_code>got it</.inline_code>
|
||||||
into the text box and press the button.
|
into the text box and press the button.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
|||||||
@@ -19,6 +19,7 @@
|
|||||||
onboarding: #{Settings.get!(:onboarding)}
|
onboarding: #{Settings.get!(:onboarding)}
|
||||||
}"}
|
}"}
|
||||||
class="dark text-bodydark bg-boxdark-2"
|
class="dark text-bodydark bg-boxdark-2"
|
||||||
|
data-socket-path={Path.join(Application.get_env(:pinchflat, :base_route_path), "/live")}
|
||||||
>
|
>
|
||||||
<%= @inner_content %>
|
<%= @inner_content %>
|
||||||
|
|
||||||
|
|||||||
@@ -1,14 +1,7 @@
|
|||||||
defmodule PinchflatWeb.ErrorHTML do
|
defmodule PinchflatWeb.ErrorHTML do
|
||||||
use PinchflatWeb, :html
|
use PinchflatWeb, :html
|
||||||
|
|
||||||
# If you want to customize your error pages,
|
embed_templates "error_html/*"
|
||||||
# uncomment the embed_templates/1 call below
|
|
||||||
# and add pages to the error directory:
|
|
||||||
#
|
|
||||||
# * lib/pinchflat_web/controllers/error_html/404.html.heex
|
|
||||||
# * lib/pinchflat_web/controllers/error_html/500.html.heex
|
|
||||||
#
|
|
||||||
# embed_templates "error_html/*"
|
|
||||||
|
|
||||||
# The default is to render a plain text page based on
|
# The default is to render a plain text page based on
|
||||||
# the template name. For example, "404.html" becomes
|
# the template name. For example, "404.html" becomes
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user