Compare commits
177 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 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 |
+1
-1
@@ -128,7 +128,7 @@
|
|||||||
{Credo.Check.Refactor.MatchInCondition, []},
|
{Credo.Check.Refactor.MatchInCondition, []},
|
||||||
{Credo.Check.Refactor.NegatedConditionsInUnless, []},
|
{Credo.Check.Refactor.NegatedConditionsInUnless, []},
|
||||||
{Credo.Check.Refactor.NegatedConditionsWithElse, []},
|
{Credo.Check.Refactor.NegatedConditionsWithElse, []},
|
||||||
{Credo.Check.Refactor.Nesting, []},
|
{Credo.Check.Refactor.Nesting, [max_nesting: 4]},
|
||||||
{Credo.Check.Refactor.RedundantWithClauseResult, []},
|
{Credo.Check.Refactor.RedundantWithClauseResult, []},
|
||||||
{Credo.Check.Refactor.RejectReject, []},
|
{Credo.Check.Refactor.RejectReject, []},
|
||||||
{Credo.Check.Refactor.UnlessWithElse, []},
|
{Credo.Check.Refactor.UnlessWithElse, []},
|
||||||
|
|||||||
@@ -13,3 +13,5 @@ N/A
|
|||||||
## Any other comments?
|
## Any other comments?
|
||||||
|
|
||||||
N/A
|
N/A
|
||||||
|
|
||||||
|
- [ ] I am the original author of this code and I am giving it freely to the community and Pinchflat project maintainers
|
||||||
|
|||||||
@@ -1,32 +0,0 @@
|
|||||||
name: Build and Push Docker Image
|
|
||||||
|
|
||||||
on:
|
|
||||||
workflow_dispatch:
|
|
||||||
inputs:
|
|
||||||
image_tag:
|
|
||||||
description: 'Docker Image Tag'
|
|
||||||
required: true
|
|
||||||
default: 'dev'
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
docker:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Set up QEMU
|
|
||||||
uses: docker/setup-qemu-action@v3
|
|
||||||
|
|
||||||
- name: Set up Docker Buildx
|
|
||||||
uses: docker/setup-buildx-action@v3
|
|
||||||
|
|
||||||
- name: Login to Docker Hub
|
|
||||||
uses: docker/login-action@v3
|
|
||||||
with:
|
|
||||||
username: ${{ secrets.DOCKERHUB_USERNAME }}
|
|
||||||
password: ${{ secrets.DOCKERHUB_TOKEN }}
|
|
||||||
|
|
||||||
- name: Build and push
|
|
||||||
uses: docker/build-push-action@v5
|
|
||||||
with:
|
|
||||||
push: true
|
|
||||||
file: ./selfhosted.Dockerfile
|
|
||||||
tags: 'keglin/pinchflat:${{ github.event.inputs.image_tag }}'
|
|
||||||
@@ -0,0 +1,81 @@
|
|||||||
|
name: Docker Release
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_dispatch:
|
||||||
|
inputs:
|
||||||
|
platforms:
|
||||||
|
type: choice
|
||||||
|
description: 'Build Platforms'
|
||||||
|
required: true
|
||||||
|
default: 'linux/amd64'
|
||||||
|
options:
|
||||||
|
- 'linux/amd64'
|
||||||
|
- 'linux/amd64,linux/arm64'
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
release:
|
||||||
|
types:
|
||||||
|
- published
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build_and_push_docker:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
env:
|
||||||
|
dev_arch: 'linux/amd64'
|
||||||
|
release_arch: 'linux/amd64,linux/arm64'
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
packages: write
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Docker meta
|
||||||
|
id: meta
|
||||||
|
uses: docker/metadata-action@v5
|
||||||
|
with:
|
||||||
|
images: |
|
||||||
|
docker.io/keglin/pinchflat
|
||||||
|
ghcr.io/${{ github.repository }}
|
||||||
|
# All non-release actions will be tagged as `dev` (ie: push, workflow_dispatch)
|
||||||
|
tags: |
|
||||||
|
type=semver,pattern={{version}},prefix=v
|
||||||
|
type=semver,pattern={{major}}.{{minor}},prefix=v
|
||||||
|
type=semver,pattern={{major}},prefix=v
|
||||||
|
type=raw,value=dev,enable=${{ github.event_name != 'release' }}
|
||||||
|
flavor: |
|
||||||
|
latest=auto
|
||||||
|
|
||||||
|
- name: Set up QEMU
|
||||||
|
uses: docker/setup-qemu-action@v3
|
||||||
|
|
||||||
|
- name: Set up Docker Buildx
|
||||||
|
uses: docker/setup-buildx-action@v3
|
||||||
|
|
||||||
|
- name: Login to Docker Hub
|
||||||
|
uses: docker/login-action@v3
|
||||||
|
with:
|
||||||
|
username: ${{ secrets.DOCKERHUB_USERNAME }}
|
||||||
|
password: ${{ secrets.DOCKERHUB_TOKEN }}
|
||||||
|
|
||||||
|
- name: Login to GitHub Container Registry
|
||||||
|
uses: docker/login-action@v3
|
||||||
|
with:
|
||||||
|
registry: ghcr.io
|
||||||
|
username: ${{ github.actor }}
|
||||||
|
password: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
|
||||||
|
- name: Build and Push
|
||||||
|
uses: docker/build-push-action@v5
|
||||||
|
with:
|
||||||
|
context: .
|
||||||
|
file: ./selfhosted.Dockerfile
|
||||||
|
# If the event is a release, use the release_arch, otherwise use the
|
||||||
|
# platforms input if present, falling back to dev_arch
|
||||||
|
platforms: ${{ github.event_name == 'release' && env.release_arch || (github.event.inputs.platforms || env.dev_arch) }}
|
||||||
|
push: true
|
||||||
|
tags: ${{ steps.meta.outputs.tags }}
|
||||||
|
labels: ${{ steps.meta.outputs.labels }}
|
||||||
|
cache-from: type=gha
|
||||||
|
cache-to: type=gha,mode=max
|
||||||
@@ -22,42 +22,4 @@ alias Pinchflat.Metadata.MetadataFileHelpers
|
|||||||
|
|
||||||
alias Pinchflat.SlowIndexing.FileFollowerServer
|
alias Pinchflat.SlowIndexing.FileFollowerServer
|
||||||
|
|
||||||
defmodule IexHelpers do
|
Pinchflat.Release.check_file_permissions()
|
||||||
def playlist_url do
|
|
||||||
"https://www.youtube.com/playlist?list=PLmqC3wPkeL8kSlTCcSMDD63gmSi7evcXS"
|
|
||||||
end
|
|
||||||
|
|
||||||
def channel_url do
|
|
||||||
"https://www.youtube.com/c/TheUselessTrials"
|
|
||||||
end
|
|
||||||
|
|
||||||
def video_url do
|
|
||||||
"https://www.youtube.com/watch?v=bR52O78ZIUw"
|
|
||||||
end
|
|
||||||
|
|
||||||
def last_media_item do
|
|
||||||
Repo.one(from m in MediaItem, limit: 1)
|
|
||||||
end
|
|
||||||
|
|
||||||
def details(type) do
|
|
||||||
source =
|
|
||||||
case type do
|
|
||||||
:playlist -> playlist_url()
|
|
||||||
:channel -> channel_url()
|
|
||||||
end
|
|
||||||
|
|
||||||
YtDlpCollection.get_source_details(source)
|
|
||||||
end
|
|
||||||
|
|
||||||
def ids(type) do
|
|
||||||
source =
|
|
||||||
case type do
|
|
||||||
:playlist -> playlist_url()
|
|
||||||
:channel -> channel_url()
|
|
||||||
end
|
|
||||||
|
|
||||||
YtDlpCollection.get_media_attributes_for_collection(source)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
import IexHelpers
|
|
||||||
|
|||||||
+9
-1
@@ -9,7 +9,15 @@
|
|||||||
threshold: :low,
|
threshold: :low,
|
||||||
# All of these are ignorable because this app is intended to be single-user and self-hosted.
|
# All of these are ignorable because this app is intended to be single-user and self-hosted.
|
||||||
# There is an expectation that the user won't intentionally run a FS Traversal on themselves
|
# There is an expectation that the user won't intentionally run a FS Traversal on themselves
|
||||||
ignore: ["CI.System", "Traversal.FileModule", "Config.HTTPS", "Config.CSP"],
|
ignore:
|
||||||
|
[
|
||||||
|
"CI.System",
|
||||||
|
"Traversal.FileModule",
|
||||||
|
"Config.HTTPS",
|
||||||
|
"Config.CSP",
|
||||||
|
"XSS.ContentType",
|
||||||
|
"Traversal.SendFile"
|
||||||
|
],
|
||||||
ignore_files: [],
|
ignore_files: [],
|
||||||
version: false
|
version: false
|
||||||
]
|
]
|
||||||
|
|||||||
@@ -1,39 +1,153 @@
|
|||||||
# Pinchflat (Alpha)
|
<p align="center">
|
||||||
|
<img
|
||||||
|
src="priv/static/images/originals/logo-white-wordmark-with-background.png"
|
||||||
|
alt="Pinchflat Logo by @hernandito"
|
||||||
|
width="700"
|
||||||
|
/>
|
||||||
|
</p>
|
||||||
|
|
||||||
This is alpha software and anything can break at any time. I make not guarantees about the stability of this software, forward-compatibility of updates, or integrity (both related to and independent of Pinchflat). Essentially, use at your own risk and expect there will be rough edges.
|
<p align="center">
|
||||||
|
<sup>
|
||||||
|
<em>logo by <a href="https://github.com/hernandito" target="_blank">@hernandito</a></em>
|
||||||
|
</sup>
|
||||||
|
</p>
|
||||||
|
|
||||||
## What is Pinchflat?
|
<div align="center">
|
||||||
|
|
||||||
TODO: expand on this.
|
[](LICENSE)
|
||||||
|
[](https://github.com/kieraneglin/pinchflat/releases)
|
||||||
|
[](#)
|
||||||
|
|
||||||
Pinchflat is a lightweight self-contained app for downloading YouTube content. For now, it is not intended as a way to consume content, but instead as a way to download content to disk using specified rules and schedules.
|
</div>
|
||||||
|
|
||||||
I have plans for more to come, but for now this is the focus. Think of Pinchflat as nothing more than an automated way to get content from YouTube to your disk.
|
# Your next YouTube media manager
|
||||||
|
|
||||||
|
## Table of contents:
|
||||||
|
|
||||||
|
- [What it does](#what-it-does)
|
||||||
|
- [Features](#features)
|
||||||
|
- [Screenshots](#screenshots)
|
||||||
|
- [Installation](#installation)
|
||||||
|
- [Unraid](#unraid)
|
||||||
|
- [Portainer](#portainer)
|
||||||
|
- [Docker](#docker)
|
||||||
|
- [Username and Password (authentication)](https://github.com/kieraneglin/pinchflat/wiki/Username-and-Password)
|
||||||
|
- [Frequently asked questions](https://github.com/kieraneglin/pinchflat/wiki/Frequently-Asked-Questions)
|
||||||
|
- [Documentation](https://github.com/kieraneglin/pinchflat/wiki)
|
||||||
|
- [EFF donations](#eff-donations)
|
||||||
|
- [Pre-release disclaimer](#pre-release-disclaimer)
|
||||||
|
- [Development and Contributing](https://github.com/kieraneglin/pinchflat/wiki/Development-and-Contributing)
|
||||||
|
|
||||||
|
## What it does
|
||||||
|
|
||||||
|
Pinchflat is a self-hosted app for downloading YouTube content built using [yt-dlp](https://github.com/yt-dlp/yt-dlp). It's designed to be lightweight, self-contained, and easy to use. You set up rules for how to download content from YouTube channels or playlists and it'll do the rest, checking periodically for new content. It's perfect for people who want to download content for use in with a media center app (Plex, Jellyfin, Kodi) or for those who want to archive media!
|
||||||
|
|
||||||
|
It's _not_ great for downloading one-off videos - it's built to download large amounts of content and keep it up to date. It's also not meant for consuming content in-app - Pinchflat downloads content to disk where you can then watch it with a media center app or VLC.
|
||||||
|
|
||||||
|
If it doesn't work for your use case, please make a feature request! You can also check out these great alternatives: [Tube Archivist](https://github.com/tubearchivist/tubearchivist), [ytdl-sub](https://github.com/jmbannon/ytdl-sub), and [TubeSync](https://github.com/meeb/tubesync)
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- Self-contained - just one Docker container with no external dependencies
|
||||||
|
- Powerful naming system so content is stored where and how you want it
|
||||||
|
- Easy-to-use web interface with presets to get you started right away
|
||||||
|
- First-class support for media center apps like Plex, Jellyfin, and Kodi
|
||||||
|
- Supports serving RSS feeds to your favourite podcast app ([docs](https://github.com/kieraneglin/pinchflat/wiki/Podcast-RSS-Feeds))
|
||||||
|
- Automatically downloads new content from channels and playlists
|
||||||
|
- Uses a novel approach to download new content more quickly than other apps
|
||||||
|
- Supports downloading audio content
|
||||||
|
- Custom rules for handling YouTube Shorts and livestreams
|
||||||
|
- Apprise support for notifications
|
||||||
|
- Allows automatically redownloading new media after a set period
|
||||||
|
- This can help improve the download quality of new content or improve SponsorBlock tags
|
||||||
|
- Optionally automatically delete old content ([docs](https://github.com/kieraneglin/pinchflat/wiki/Automatically-Delete-Media))
|
||||||
|
- Advanced options like setting cutoff dates and filtering by title
|
||||||
|
- Reliable hands-off operation
|
||||||
|
- Can pass cookies to YouTube to download your private playlists ([docs](https://github.com/kieraneglin/pinchflat/wiki/YouTube-Cookies))
|
||||||
|
- Sponsorblock integration
|
||||||
|
- \[Advanced\] allows custom `yt-dlp` options ([docs](https://github.com/kieraneglin/pinchflat/wiki/%5BAdvanced%5D-Custom-yt%E2%80%90dlp-options))
|
||||||
|
|
||||||
|
## Screenshots
|
||||||
|
|
||||||
|
<img src="priv/static/images/app-form-screenshot.png" alt="Pinchflat screenshot" width="700" />
|
||||||
|
<img src="priv/static/images/app-screenshot.png" alt="Pinchflat screenshot" width="700" />
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Pinchflat is designed to be self-hosted. I'm building it for my own needs which means it's designed to work well with Unraid, but it should work on any computer/server that can run Docker images.
|
### Unraid
|
||||||
|
|
||||||
I'll update with Unraid instructions once I get something in the Community Apps store. Until then, here's how you build it with Docker:
|
Simply search for Pinchflat in the Community Apps store!
|
||||||
|
|
||||||
```bash
|
### Portainer
|
||||||
docker build . --file selfhosted.Dockerfile -t pinchflat:dev
|
|
||||||
|
|
||||||
docker run \
|
> [!IMPORTANT]
|
||||||
-p 8945:8945 \
|
> See the note below about storing config on a network file share. It's preferred to store the config on a local disk if at all possible.
|
||||||
-v /Users/work/Desktop/test_volumes/config:/config \
|
|
||||||
-v /Users/work/Desktop/test_volumes/downloads:/downloads \
|
Docker Compose file:
|
||||||
pinchflat:dev
|
|
||||||
|
```yaml
|
||||||
|
version: '3'
|
||||||
|
services:
|
||||||
|
pinchflat:
|
||||||
|
image: keglin/pinchflat:latest
|
||||||
|
ports:
|
||||||
|
- '8945:8945'
|
||||||
|
volumes:
|
||||||
|
- /host/path/to/config:/config
|
||||||
|
- /host/path/to/downloads:/downloads
|
||||||
```
|
```
|
||||||
|
|
||||||
## Authentication
|
### Docker
|
||||||
|
|
||||||
Currently HTTP basic auth is optionally supported. To use it, set the `BASIC_AUTH_USERNAME` and `BASIC_AUTH_PASSWORD` environment variables when starting the container. If you don't set both of these, no authentication will be required.
|
1. Create two directories on your host machine: one for storing config and one for storing downloaded media. Make sure they're both writable by the user running the Docker container.
|
||||||
|
2. Prepare the docker image in one of the two ways below:
|
||||||
|
- **From GHCR:** `docker pull ghcr.io/kieraneglin/pinchflat:latest`
|
||||||
|
- NOTE: also available on Docker Hub at `keglin/pinchflat:latest`
|
||||||
|
- **Building locally:** `docker build . --file selfhosted.Dockerfile -t ghcr.io/kieraneglin/pinchflat:latest`
|
||||||
|
3. Run the container:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Be sure to replace /host/path/to/config and /host/path/to/downloads below with
|
||||||
|
# the paths to the directories you created in step 1
|
||||||
|
docker run \
|
||||||
|
-p 8945:8945 \
|
||||||
|
-v /host/path/to/config:/config \
|
||||||
|
-v /host/path/to/downloads:/downloads \
|
||||||
|
ghcr.io/kieraneglin/pinchflat:latest
|
||||||
|
```
|
||||||
|
|
||||||
|
### IMPORTANT: File permissions
|
||||||
|
|
||||||
|
You _must_ ensure the host directories you've mounted are writable by the user running the Docker container. If you get a permission error follow the steps it suggests. See [#106](https://github.com/kieraneglin/pinchflat/issues/106) for more.
|
||||||
|
|
||||||
|
> [!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.
|
||||||
|
|
||||||
|
## EFF donations
|
||||||
|
|
||||||
|
A portion of all donations to Pinchflat will be donated to the [Electronic Frontier Foundation](https://www.eff.org/). The EFF defends your online liberties and [backed](https://github.com/github/dmca/blob/9a85e0f021f7967af80e186b890776a50443f06c/2020/11/2020-11-16-RIAA-reversal-effletter.pdf) `youtube-dl` when Google took them down. [See here](https://github.com/kieraneglin/pinchflat/wiki/EFF-Donation-Receipts) for a list of donation receipts.
|
||||||
|
|
||||||
|
## Pre-release disclaimer
|
||||||
|
|
||||||
|
This is pre-release software and anything can break at any time. I make not guarantees about the stability of this software, forward-compatibility of updates, or integrity (both related to and independent of Pinchflat). Essentially, use at your own risk and expect there will be rough edges for now.
|
||||||
|
|
||||||
## 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
|
||||||
|
|||||||
@@ -22,6 +22,7 @@ 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'
|
||||||
|
|
||||||
window.Alpine = Alpine
|
window.Alpine = Alpine
|
||||||
Alpine.start()
|
Alpine.start()
|
||||||
@@ -35,9 +36,44 @@ 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)' })
|
||||||
window.addEventListener('phx:page-loading-start', (_info) => topbar.show(300))
|
window.addEventListener('phx:page-loading-start', (_info) => topbar.show(300))
|
||||||
|
|||||||
@@ -0,0 +1,20 @@
|
|||||||
|
window.setTabIndex = (index) => {
|
||||||
|
window.location.hash = `tab-${index}`
|
||||||
|
|
||||||
|
return index
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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.getTabIndex = (currIndex) => {
|
||||||
|
if (window.location.hash === '' || window.location.hash === '#') {
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
|
||||||
|
if (window.location.hash.startsWith('#tab-')) {
|
||||||
|
return parseInt(window.location.hash.replace('#tab-', ''))
|
||||||
|
}
|
||||||
|
|
||||||
|
return currIndex
|
||||||
|
}
|
||||||
+21
-5
@@ -12,17 +12,25 @@ 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.Notifications.CommandRunner,
|
||||||
media_directory: "/downloads",
|
media_directory: "/downloads",
|
||||||
# The user may or may not store metadata for their needs, but the app will always store its copy
|
# The user may or may not store metadata for their needs, but the app will always store its copy
|
||||||
metadata_directory: "/config/metadata",
|
metadata_directory: "/config/metadata",
|
||||||
|
extras_directory: "/config/extras",
|
||||||
tmpfile_directory: Path.join([System.tmp_dir!(), "pinchflat", "data"]),
|
tmpfile_directory: Path.join([System.tmp_dir!(), "pinchflat", "data"]),
|
||||||
# Setting BASIC_AUTH_USERNAME and BASIC_AUTH_PASSWORD implies you want to use basic auth.
|
# Setting BASIC_AUTH_USERNAME and BASIC_AUTH_PASSWORD implies you want to use basic auth.
|
||||||
# If either is unset, basic auth will not be used.
|
# If either is unset, basic auth will not be used.
|
||||||
basic_auth_username: System.get_env("BASIC_AUTH_USERNAME"),
|
basic_auth_username: "",
|
||||||
basic_auth_password: System.get_env("BASIC_AUTH_PASSWORD"),
|
basic_auth_password: "",
|
||||||
|
expose_feed_endpoints: false,
|
||||||
file_watcher_poll_interval: 1000
|
file_watcher_poll_interval: 1000
|
||||||
|
|
||||||
|
config :pinchflat, Pinchflat.Repo,
|
||||||
|
journal_mode: :wal,
|
||||||
|
pool_size: 5
|
||||||
|
|
||||||
# Configures the endpoint
|
# Configures the endpoint
|
||||||
config :pinchflat, PinchflatWeb.Endpoint,
|
config :pinchflat, PinchflatWeb.Endpoint,
|
||||||
url: [host: "localhost", port: 8945],
|
url: [host: "localhost", port: 8945],
|
||||||
@@ -40,7 +48,14 @@ config :pinchflat, Oban,
|
|||||||
engine: Oban.Engines.Lite,
|
engine: Oban.Engines.Lite,
|
||||||
repo: Pinchflat.Repo,
|
repo: Pinchflat.Repo,
|
||||||
# Keep old jobs for 30 days for display in the UI
|
# Keep old jobs for 30 days for display in the UI
|
||||||
plugins: [{Oban.Plugins.Pruner, max_age: 30 * 24 * 60 * 60}],
|
plugins: [
|
||||||
|
{Oban.Plugins.Pruner, max_age: 30 * 24 * 60 * 60},
|
||||||
|
{Oban.Plugins.Cron,
|
||||||
|
crontab: [
|
||||||
|
{"0 1 * * *", Pinchflat.Downloading.MediaRetentionWorker},
|
||||||
|
{"0 2 * * *", Pinchflat.Downloading.MediaRedownloadWorker}
|
||||||
|
]}
|
||||||
|
],
|
||||||
# TODO: consider making this an env var or something?
|
# TODO: consider making this an env var or something?
|
||||||
queues: [
|
queues: [
|
||||||
default: 10,
|
default: 10,
|
||||||
@@ -48,7 +63,8 @@ config :pinchflat, Oban,
|
|||||||
media_indexing: 2,
|
media_indexing: 2,
|
||||||
media_collection_indexing: 2,
|
media_collection_indexing: 2,
|
||||||
media_fetching: 2,
|
media_fetching: 2,
|
||||||
media_local_metadata: 8
|
local_metadata: 8,
|
||||||
|
remote_metadata: 4
|
||||||
]
|
]
|
||||||
|
|
||||||
# Configures the mailer
|
# Configures the mailer
|
||||||
@@ -72,7 +88,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
|
||||||
|
|||||||
@@ -3,6 +3,7 @@ import Config
|
|||||||
config :pinchflat,
|
config :pinchflat,
|
||||||
media_directory: Path.join([File.cwd!(), "tmp", "media"]),
|
media_directory: Path.join([File.cwd!(), "tmp", "media"]),
|
||||||
metadata_directory: Path.join([File.cwd!(), "tmp", "metadata"]),
|
metadata_directory: Path.join([File.cwd!(), "tmp", "metadata"]),
|
||||||
|
extras_directory: Path.join([File.cwd!(), "tmp", "extras"]),
|
||||||
tmpfile_directory: Path.join([File.cwd!(), "tmp", "tmpfiles"])
|
tmpfile_directory: Path.join([File.cwd!(), "tmp", "tmpfiles"])
|
||||||
|
|
||||||
# Configure your database
|
# Configure your database
|
||||||
|
|||||||
+31
-69
@@ -25,37 +25,49 @@ config :pinchflat,
|
|||||||
basic_auth_username: System.get_env("BASIC_AUTH_USERNAME"),
|
basic_auth_username: System.get_env("BASIC_AUTH_USERNAME"),
|
||||||
basic_auth_password: System.get_env("BASIC_AUTH_PASSWORD")
|
basic_auth_password: System.get_env("BASIC_AUTH_PASSWORD")
|
||||||
|
|
||||||
if config_env() == :prod do
|
arch_string = to_string(:erlang.system_info(:system_architecture))
|
||||||
config_path =
|
|
||||||
System.get_env("CONFIG_PATH") ||
|
|
||||||
raise """
|
|
||||||
environment variable CONFIG_PATH is missing.
|
|
||||||
For example: /etc/pinchflat/config
|
|
||||||
"""
|
|
||||||
|
|
||||||
|
system_arch =
|
||||||
|
cond do
|
||||||
|
String.contains?(arch_string, "arm") -> "arm"
|
||||||
|
String.contains?(arch_string, "aarch") -> "arm"
|
||||||
|
String.contains?(arch_string, "x86") -> "x86"
|
||||||
|
true -> "unknown"
|
||||||
|
end
|
||||||
|
|
||||||
|
config :pinchflat, Pinchflat.Repo,
|
||||||
|
load_extensions: [
|
||||||
|
Path.join([:code.priv_dir(:pinchflat), "repo", "extensions", "sqlean-linux-#{system_arch}", "sqlean"])
|
||||||
|
]
|
||||||
|
|
||||||
|
if config_env() == :prod do
|
||||||
|
config_path = "/config"
|
||||||
db_path = System.get_env("DATABASE_PATH", Path.join([config_path, "db", "pinchflat.db"]))
|
db_path = System.get_env("DATABASE_PATH", Path.join([config_path, "db", "pinchflat.db"]))
|
||||||
log_path = System.get_env("LOG_PATH", Path.join([config_path, "logs", "pinchflat.log"]))
|
log_path = System.get_env("LOG_PATH", Path.join([config_path, "logs", "pinchflat.log"]))
|
||||||
metadata_path = System.get_env("METADATA_PATH", Path.join([config_path, "metadata"]))
|
metadata_path = System.get_env("METADATA_PATH", Path.join([config_path, "metadata"]))
|
||||||
|
extras_path = System.get_env("EXTRAS_PATH", Path.join([config_path, "extras"]))
|
||||||
|
|
||||||
# We want to force _some_ level of useful logging in production
|
# For running PF as a podcast host on self-hosted environments
|
||||||
acceptable_log_levels = ~w(debug info)a
|
expose_feed_endpoints = String.length(System.get_env("EXPOSE_FEED_ENDPOINTS", "")) > 0
|
||||||
log_level = String.to_existing_atom(System.get_env("LOG_LEVEL", "info"))
|
|
||||||
|
|
||||||
if log_level in acceptable_log_levels do
|
# For testing alternate journal modes (see issue #137)
|
||||||
config :logger, level: log_level
|
journal_mode = String.to_existing_atom(System.get_env("JOURNAL_MODE", "wal"))
|
||||||
else
|
|
||||||
Logger.error("Invalid log level: #{log_level}. Defaulting to info.")
|
config :logger, level: String.to_existing_atom(System.get_env("LOG_LEVEL", "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",
|
||||||
metadata_directory: metadata_path,
|
metadata_directory: metadata_path,
|
||||||
dns_cluster_query: System.get_env("DNS_CLUSTER_QUERY")
|
extras_directory: extras_path,
|
||||||
|
tmpfile_directory: Path.join([System.tmp_dir!(), "pinchflat", "data"]),
|
||||||
|
dns_cluster_query: System.get_env("DNS_CLUSTER_QUERY"),
|
||||||
|
expose_feed_endpoints: expose_feed_endpoints
|
||||||
|
|
||||||
config :pinchflat, Pinchflat.Repo,
|
config :pinchflat, Pinchflat.Repo,
|
||||||
database: db_path,
|
database: db_path,
|
||||||
pool_size: String.to_integer(System.get_env("POOL_SIZE") || "5")
|
journal_mode: journal_mode
|
||||||
|
|
||||||
# The secret key base is used to sign/encrypt cookies and other secrets.
|
# The secret key base is used to sign/encrypt cookies and other secrets.
|
||||||
# A default value is used in config/dev.exs and config/test.exs but you
|
# A default value is used in config/dev.exs and config/test.exs but you
|
||||||
@@ -89,7 +101,7 @@ if config_env() == :prod do
|
|||||||
# Set it to {0, 0, 0, 0, 0, 0, 0, 1} for local network only access.
|
# Set it to {0, 0, 0, 0, 0, 0, 0, 1} for local network only access.
|
||||||
# See the documentation on https://hexdocs.pm/plug_cowboy/Plug.Cowboy.html
|
# See the documentation on https://hexdocs.pm/plug_cowboy/Plug.Cowboy.html
|
||||||
# for details about using IPv6 vs IPv4 and loopback vs public addresses.
|
# for details about using IPv6 vs IPv4 and loopback vs public addresses.
|
||||||
ip: {0, 0, 0, 0, 0, 0, 0, 0},
|
ip: {0, 0, 0, 0},
|
||||||
port: String.to_integer(System.get_env("PORT") || "4000")
|
port: String.to_integer(System.get_env("PORT") || "4000")
|
||||||
],
|
],
|
||||||
secret_key_base: secret_key_base
|
secret_key_base: secret_key_base
|
||||||
@@ -108,54 +120,4 @@ if config_env() == :prod do
|
|||||||
formatter: Logger.Formatter.new()
|
formatter: Logger.Formatter.new()
|
||||||
}}
|
}}
|
||||||
]
|
]
|
||||||
|
|
||||||
# ## SSL Support
|
|
||||||
#
|
|
||||||
# To get SSL working, you will need to add the `https` key
|
|
||||||
# to your endpoint configuration:
|
|
||||||
#
|
|
||||||
# config :pinchflat, PinchflatWeb.Endpoint,
|
|
||||||
# https: [
|
|
||||||
# ...,
|
|
||||||
# port: 443,
|
|
||||||
# cipher_suite: :strong,
|
|
||||||
# keyfile: System.get_env("SOME_APP_SSL_KEY_PATH"),
|
|
||||||
# certfile: System.get_env("SOME_APP_SSL_CERT_PATH")
|
|
||||||
# ]
|
|
||||||
#
|
|
||||||
# The `cipher_suite` is set to `:strong` to support only the
|
|
||||||
# latest and more secure SSL ciphers. This means old browsers
|
|
||||||
# and clients may not be supported. You can set it to
|
|
||||||
# `:compatible` for wider support.
|
|
||||||
#
|
|
||||||
# `:keyfile` and `:certfile` expect an absolute path to the key
|
|
||||||
# and cert in disk or a relative path inside priv, for example
|
|
||||||
# "priv/ssl/server.key". For all supported SSL configuration
|
|
||||||
# options, see https://hexdocs.pm/plug/Plug.SSL.html#configure/1
|
|
||||||
#
|
|
||||||
# We also recommend setting `force_ssl` in your endpoint, ensuring
|
|
||||||
# no data is ever sent via http, always redirecting to https:
|
|
||||||
#
|
|
||||||
# config :pinchflat, PinchflatWeb.Endpoint,
|
|
||||||
# force_ssl: [hsts: true]
|
|
||||||
#
|
|
||||||
# Check `Plug.SSL` for all available options in `force_ssl`.
|
|
||||||
|
|
||||||
# ## Configuring the mailer
|
|
||||||
#
|
|
||||||
# In production you need to configure the mailer to use a different adapter.
|
|
||||||
# Also, you may need to configure the Swoosh API client of your choice if you
|
|
||||||
# are not using SMTP. Here is an example of the configuration:
|
|
||||||
#
|
|
||||||
# config :pinchflat, Pinchflat.Mailer,
|
|
||||||
# adapter: Swoosh.Adapters.Mailgun,
|
|
||||||
# api_key: System.get_env("MAILGUN_API_KEY"),
|
|
||||||
# domain: System.get_env("MAILGUN_DOMAIN")
|
|
||||||
#
|
|
||||||
# For this example you need include a HTTP client required by Swoosh API client.
|
|
||||||
# Swoosh supports Hackney and Finch out of the box:
|
|
||||||
#
|
|
||||||
# config :swoosh, :api_client, Swoosh.ApiClient.Hackney
|
|
||||||
#
|
|
||||||
# See https://hexdocs.pm/swoosh/Swoosh.html#module-installation for details.
|
|
||||||
end
|
end
|
||||||
|
|||||||
+2
-3
@@ -3,6 +3,7 @@ import Config
|
|||||||
config :pinchflat,
|
config :pinchflat,
|
||||||
# Specifying backend data here makes mocking and local testing SUPER easy
|
# Specifying backend data here makes mocking and local testing SUPER easy
|
||||||
yt_dlp_executable: Path.join([File.cwd!(), "/test/support/scripts/yt-dlp-mocks/repeater.sh"]),
|
yt_dlp_executable: Path.join([File.cwd!(), "/test/support/scripts/yt-dlp-mocks/repeater.sh"]),
|
||||||
|
apprise_executable: Path.join([File.cwd!(), "/test/support/scripts/yt-dlp-mocks/repeater.sh"]),
|
||||||
media_directory: Path.join([System.tmp_dir!(), "test", "media"]),
|
media_directory: Path.join([System.tmp_dir!(), "test", "media"]),
|
||||||
metadata_directory: Path.join([System.tmp_dir!(), "test", "metadata"]),
|
metadata_directory: Path.join([System.tmp_dir!(), "test", "metadata"]),
|
||||||
tmpfile_directory: Path.join([System.tmp_dir!(), "test", "tmpfiles"]),
|
tmpfile_directory: Path.join([System.tmp_dir!(), "test", "tmpfiles"]),
|
||||||
@@ -17,7 +18,6 @@ config :pinchflat, Oban, testing: :manual
|
|||||||
# Run `mix help test` for more information.
|
# Run `mix help test` for more information.
|
||||||
config :pinchflat, Pinchflat.Repo,
|
config :pinchflat, Pinchflat.Repo,
|
||||||
database: Path.expand("../priv/repo/pinchflat_test.db", Path.dirname(__ENV__.file)),
|
database: Path.expand("../priv/repo/pinchflat_test.db", Path.dirname(__ENV__.file)),
|
||||||
pool_size: 5,
|
|
||||||
pool: Ecto.Adapters.SQL.Sandbox
|
pool: Ecto.Adapters.SQL.Sandbox
|
||||||
|
|
||||||
# We don't run a server during test. If one is required,
|
# We don't run a server during test. If one is required,
|
||||||
@@ -33,8 +33,7 @@ config :pinchflat, Pinchflat.Mailer, adapter: Swoosh.Adapters.Test
|
|||||||
# Disable swoosh api client as it is only required for production adapters.
|
# Disable swoosh api client as it is only required for production adapters.
|
||||||
config :swoosh, :api_client, false
|
config :swoosh, :api_client, false
|
||||||
|
|
||||||
# Print only warnings and errors during test
|
config :logger, level: :critical
|
||||||
config :logger, level: :warning
|
|
||||||
|
|
||||||
# Initialize plugs at runtime for faster test compilation
|
# Initialize plugs at runtime for faster test compilation
|
||||||
config :phoenix, :plug_init_mode, :runtime
|
config :phoenix, :plug_init_mode, :runtime
|
||||||
|
|||||||
+17
-8
@@ -5,15 +5,10 @@ ARG DEV_IMAGE="hexpm/elixir:${ELIXIR_VERSION}-erlang-${OTP_VERSION}-debian-${DEB
|
|||||||
|
|
||||||
FROM ${DEV_IMAGE}
|
FROM ${DEV_IMAGE}
|
||||||
|
|
||||||
# Set the locale deets
|
|
||||||
ENV LANG en_US.UTF-8
|
|
||||||
ENV LANGUAGE en_US:en
|
|
||||||
ENV LC_ALL en_US.UTF-8
|
|
||||||
|
|
||||||
# Install debian packages
|
# Install debian packages
|
||||||
RUN apt-get update -qq
|
RUN apt-get update -qq
|
||||||
RUN apt-get install -y inotify-tools ffmpeg curl git openssh-client \
|
RUN apt-get install -y inotify-tools ffmpeg curl git openssh-client \
|
||||||
python3 python3-pip python3-setuptools python3-wheel python3-dev
|
python3 python3-pip python3-setuptools python3-wheel python3-dev locales procps
|
||||||
|
|
||||||
# Install nodejs
|
# Install nodejs
|
||||||
RUN curl -sL https://deb.nodesource.com/setup_20.x -o nodesource_setup.sh
|
RUN curl -sL https://deb.nodesource.com/setup_20.x -o nodesource_setup.sh
|
||||||
@@ -25,9 +20,23 @@ RUN npm install -g yarn
|
|||||||
RUN mix local.hex --force
|
RUN mix local.hex --force
|
||||||
RUN mix local.rebar --force
|
RUN mix local.rebar --force
|
||||||
|
|
||||||
# Download YT-DLP
|
# Download and update YT-DLP
|
||||||
# NOTE: If you're seeing weird issues, consider using the FFMPEG released by yt-dlp
|
# 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
|
RUN curl -L https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -o /usr/local/bin/yt-dlp
|
||||||
|
RUN chmod a+rx /usr/local/bin/yt-dlp
|
||||||
|
RUN yt-dlp -U
|
||||||
|
|
||||||
|
# Download Apprise
|
||||||
|
RUN python3 -m pip install -U apprise --break-system-packages
|
||||||
|
|
||||||
|
# Download Mutagen for music thumbnail generation
|
||||||
|
RUN python3 -m pip install -U mutagen --break-system-packages
|
||||||
|
|
||||||
|
# Set the locale
|
||||||
|
RUN sed -i '/en_US.UTF-8/s/^# //g' /etc/locale.gen && locale-gen
|
||||||
|
ENV LANG en_US.UTF-8
|
||||||
|
ENV LANGUAGE en_US:en
|
||||||
|
ENV LC_ALL en_US.UTF-8
|
||||||
|
|
||||||
# Create app directory and copy the Elixir projects into it.
|
# Create app directory and copy the Elixir projects into it.
|
||||||
WORKDIR /app
|
WORKDIR /app
|
||||||
|
|||||||
-401
File diff suppressed because one or more lines are too long
@@ -1,75 +0,0 @@
|
|||||||
defmodule Pinchflat.Boot.DataBackfillWorker do
|
|
||||||
@moduledoc false
|
|
||||||
|
|
||||||
use Oban.Worker,
|
|
||||||
queue: :media_local_metadata,
|
|
||||||
unique: [period: :infinity, states: [:available, :scheduled, :retryable]],
|
|
||||||
tags: ["media_item", "media_metadata", "local_metadata", "data_backfill"]
|
|
||||||
|
|
||||||
# This one is going to be a little more self-contained
|
|
||||||
# instead of relying on outside modules for the methods.
|
|
||||||
# That's because, for now, these methods are not intended
|
|
||||||
# to be used elsewhere.
|
|
||||||
#
|
|
||||||
# I'm just trying out that pattern and seeing if I like it better
|
|
||||||
# so this may change.
|
|
||||||
import Ecto.Query, warn: false
|
|
||||||
require Logger
|
|
||||||
|
|
||||||
alias __MODULE__
|
|
||||||
alias Pinchflat.Repo
|
|
||||||
alias Pinchflat.Media.MediaItem
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Cancels all pending backfill jobs. Useful for ensuring worker runs immediately
|
|
||||||
on app boot.
|
|
||||||
|
|
||||||
Returns {:ok, integer()}
|
|
||||||
"""
|
|
||||||
def cancel_pending_backfill_jobs do
|
|
||||||
Oban.Job
|
|
||||||
|> where(worker: "Pinchflat.Boot.DataBackfillWorker")
|
|
||||||
|> Oban.cancel_all_jobs()
|
|
||||||
end
|
|
||||||
|
|
||||||
@impl Oban.Worker
|
|
||||||
@doc """
|
|
||||||
Performs one-off tasks to get data in the right shape.
|
|
||||||
This can be needed when we add new features or change the way
|
|
||||||
we store data. Must be idempotent. All new data should already
|
|
||||||
conform to the expected schema so this should only be needed
|
|
||||||
for existing data. Still runs periodically to be safe.
|
|
||||||
|
|
||||||
Returns :ok
|
|
||||||
"""
|
|
||||||
def perform(%Oban.Job{}) do
|
|
||||||
Logger.info("Running data backfill worker")
|
|
||||||
backfill_shorts_data()
|
|
||||||
|
|
||||||
reschedule_backfill()
|
|
||||||
|
|
||||||
:ok
|
|
||||||
end
|
|
||||||
|
|
||||||
defp backfill_shorts_data do
|
|
||||||
query =
|
|
||||||
from(
|
|
||||||
m in MediaItem,
|
|
||||||
where: fragment("? like ?", m.original_url, "%/shorts/%"),
|
|
||||||
where: m.short_form_content == false
|
|
||||||
)
|
|
||||||
|
|
||||||
{count, _} = Repo.update_all(query, set: [short_form_content: true])
|
|
||||||
|
|
||||||
Logger.info("Backfill worker set short_form_content to true for #{count} media items.")
|
|
||||||
end
|
|
||||||
|
|
||||||
defp reschedule_backfill do
|
|
||||||
# Run hourly
|
|
||||||
next_run_in = 60 * 60
|
|
||||||
|
|
||||||
%{}
|
|
||||||
|> DataBackfillWorker.new(schedule_in: next_run_in)
|
|
||||||
|> Repo.insert_unique_job()
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -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,6 +14,7 @@ defmodule Pinchflat.Boot.PreJobStartupTasks do
|
|||||||
|
|
||||||
alias Pinchflat.Repo
|
alias Pinchflat.Repo
|
||||||
alias Pinchflat.Settings
|
alias Pinchflat.Settings
|
||||||
|
alias Pinchflat.Utils.FilesystemUtils
|
||||||
|
|
||||||
def start_link(opts \\ []) do
|
def start_link(opts \\ []) do
|
||||||
GenServer.start_link(__MODULE__, %{}, opts)
|
GenServer.start_link(__MODULE__, %{}, opts)
|
||||||
@@ -30,44 +31,53 @@ defmodule Pinchflat.Boot.PreJobStartupTasks do
|
|||||||
"""
|
"""
|
||||||
@impl true
|
@impl true
|
||||||
def init(state) do
|
def init(state) do
|
||||||
|
reset_executing_jobs()
|
||||||
|
create_blank_yt_dlp_files()
|
||||||
apply_default_settings()
|
apply_default_settings()
|
||||||
rename_old_job_workers()
|
|
||||||
|
|
||||||
{:ok, state}
|
{:ok, state}
|
||||||
end
|
end
|
||||||
|
|
||||||
defp apply_default_settings do
|
# If a node cannot gracefully shut down, the currently executing jobs get stuck
|
||||||
Settings.fetch!(:onboarding, true)
|
# in the "executing" state. This is a problem because the job runner will not
|
||||||
Settings.fetch!(:pro_enabled, false)
|
# pick them up again
|
||||||
|
defp reset_executing_jobs do
|
||||||
|
{count, _} =
|
||||||
|
Oban.Job
|
||||||
|
|> where(state: "executing")
|
||||||
|
|> Repo.update_all(set: [state: "retryable"])
|
||||||
|
|
||||||
|
Logger.info("Reset #{count} executing jobs")
|
||||||
end
|
end
|
||||||
|
|
||||||
# As part of a large refactor, I ended up moving a bunch of workers around. This
|
defp create_blank_yt_dlp_files do
|
||||||
# is a problem because the workers are stored in the database and the runner
|
files = ["cookies.txt", "yt-dlp-configs/base-config.txt"]
|
||||||
# will try to run the OLD jobs. This is also why these tasks run before the job
|
base_dir = Application.get_env(:pinchflat, :extras_directory)
|
||||||
# runner starts up.
|
|
||||||
#
|
|
||||||
# Can be removed after a few months (created: 2024-03-12)
|
|
||||||
defp rename_old_job_workers do
|
|
||||||
# [ [old_name, new_name], ...]
|
|
||||||
rename_map = [
|
|
||||||
["Pinchflat.Workers.MediaIndexingWorker", "Pinchflat.FastIndexing.MediaIndexingWorker"],
|
|
||||||
["Pinchflat.Workers.MediaDownloadWorker", "Pinchflat.Downloading.MediaDownloadWorker"],
|
|
||||||
["Pinchflat.Workers.FilesystemDataWorker", "Pinchflat.Filesystem.FilesystemDataWorker"],
|
|
||||||
["Pinchflat.Workers.FastIndexingWorker", "Pinchflat.FastIndexing.FastIndexingWorker"],
|
|
||||||
["Pinchflat.Workers.MediaCollectionIndexingWorker", "Pinchflat.SlowIndexing.MediaCollectionIndexingWorker"],
|
|
||||||
["Pinchflat.Workers.DataBackfillWorker", "Pinchflat.Boot.DataBackfillWorker"]
|
|
||||||
]
|
|
||||||
|
|
||||||
jobs_renamed =
|
Enum.each(files, fn file ->
|
||||||
Enum.reduce(rename_map, 0, fn [old_name, new_name], acc ->
|
filepath = Path.join(base_dir, file)
|
||||||
{count, _} =
|
|
||||||
Oban.Job
|
|
||||||
|> where(worker: ^old_name)
|
|
||||||
|> Repo.update_all(set: [worker: new_name])
|
|
||||||
|
|
||||||
acc + count
|
if !File.exists?(filepath) do
|
||||||
end)
|
Logger.info("Creating blank file: #{filepath}")
|
||||||
|
|
||||||
Logger.info("Renamed #{jobs_renamed} old job workers")
|
FilesystemUtils.write_p!(filepath, "")
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp apply_default_settings do
|
||||||
|
{:ok, yt_dlp_version} = yt_dlp_runner().version()
|
||||||
|
{:ok, apprise_version} = apprise_runner().version()
|
||||||
|
|
||||||
|
Settings.set(yt_dlp_version: yt_dlp_version)
|
||||||
|
Settings.set(apprise_version: apprise_version)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp yt_dlp_runner do
|
||||||
|
Application.get_env(:pinchflat, :yt_dlp_runner)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp apprise_runner do
|
||||||
|
Application.get_env(:pinchflat, :apprise_runner)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -3,14 +3,15 @@ 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.Sources.Source
|
||||||
alias Pinchflat.Media.MediaItem
|
alias Pinchflat.Media.MediaItem
|
||||||
alias Pinchflat.Downloading.OutputPathBuilder
|
alias Pinchflat.Downloading.OutputPathBuilder
|
||||||
|
|
||||||
@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) do
|
||||||
media_profile = media_item_with_preloads.source.media_profile
|
media_profile = media_item_with_preloads.source.media_profile
|
||||||
@@ -18,16 +19,36 @@ defmodule Pinchflat.Downloading.DownloadOptionBuilder do
|
|||||||
built_options =
|
built_options =
|
||||||
default_options() ++
|
default_options() ++
|
||||||
subtitle_options(media_profile) ++
|
subtitle_options(media_profile) ++
|
||||||
thumbnail_options(media_profile) ++
|
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 """
|
||||||
|
Builds the output path for yt-dlp to download media based on the given source's
|
||||||
|
media profile. Uses the source's override output path template if it exists.
|
||||||
|
|
||||||
|
Returns binary()
|
||||||
|
"""
|
||||||
|
def build_output_path_for(%Source{} = source_with_preloads) do
|
||||||
|
output_path_template = Sources.output_path_template(source_with_preloads)
|
||||||
|
|
||||||
|
build_output_path(output_path_template, source_with_preloads)
|
||||||
|
end
|
||||||
|
|
||||||
defp default_options do
|
defp default_options do
|
||||||
[:no_progress, :windows_filenames]
|
[
|
||||||
|
:no_progress,
|
||||||
|
# Add force-overwrites to make sure redownloading works
|
||||||
|
:force_overwrites,
|
||||||
|
# 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
|
||||||
@@ -57,16 +78,19 @@ defmodule Pinchflat.Downloading.DownloadOptionBuilder do
|
|||||||
end)
|
end)
|
||||||
end
|
end
|
||||||
|
|
||||||
defp thumbnail_options(media_profile) do
|
defp thumbnail_options(media_item_with_preloads) do
|
||||||
|
media_profile = media_item_with_preloads.source.media_profile
|
||||||
mapped_struct = Map.from_struct(media_profile)
|
mapped_struct = Map.from_struct(media_profile)
|
||||||
|
|
||||||
Enum.reduce(mapped_struct, [], fn attr, acc ->
|
Enum.reduce(mapped_struct, [], fn attr, acc ->
|
||||||
case attr do
|
case attr do
|
||||||
{:download_thumbnail, true} ->
|
{:download_thumbnail, true} ->
|
||||||
acc ++ [:write_thumbnail, convert_thumbnail: "jpg"]
|
thumbnail_save_location = determine_thumbnail_location(media_item_with_preloads)
|
||||||
|
|
||||||
|
acc ++ [:write_thumbnail, convert_thumbnail: "jpg", output: "thumbnail:#{thumbnail_save_location}"]
|
||||||
|
|
||||||
{:embed_thumbnail, true} ->
|
{:embed_thumbnail, true} ->
|
||||||
acc ++ [:embed_thumbnail]
|
acc ++ [:embed_thumbnail, convert_thumbnail: "jpg"]
|
||||||
|
|
||||||
_ ->
|
_ ->
|
||||||
acc
|
acc
|
||||||
@@ -87,39 +111,96 @@ 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"
|
video_codec_option = fn res ->
|
||||||
|
[format_sort: "res:#{res},+codec:avc:m4a", remux_video: "mp4"]
|
||||||
|
end
|
||||||
|
|
||||||
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 -> [:extract_audio, format: "bestaudio[ext=m4a]"]
|
||||||
:"360p" -> [format_sort: "res:360,#{video_codec_options}"]
|
:"360p" -> video_codec_option.("360")
|
||||||
:"480p" -> [format_sort: "res:480,#{video_codec_options}"]
|
:"480p" -> video_codec_option.("480")
|
||||||
:"720p" -> [format_sort: "res:720,#{video_codec_options}"]
|
:"720p" -> video_codec_option.("720")
|
||||||
:"1080p" -> [format_sort: "res:1080,#{video_codec_options}"]
|
:"1080p" -> video_codec_option.("1080")
|
||||||
:"1440p" -> [format_sort: "res:1440,#{video_codec_options}"]
|
:"2160p" -> video_codec_option.("2160")
|
||||||
:"2160p" -> [format_sort: "res:2160,#{video_codec_options}"]
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
defp output_options(media_item_with_preloads) do
|
defp sponsorblock_options(media_profile) do
|
||||||
media_profile = media_item_with_preloads.source.media_profile
|
categories = media_profile.sponsorblock_categories
|
||||||
additional_options_map = output_options_map(media_item_with_preloads)
|
behaviour = media_profile.sponsorblock_behaviour
|
||||||
{:ok, output_path} = OutputPathBuilder.build(media_profile.output_path_template, additional_options_map)
|
|
||||||
|
|
||||||
|
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)
|
||||||
|
|
||||||
|
case File.read(filepath) do
|
||||||
|
{:ok, file_data} ->
|
||||||
|
if String.trim(file_data) != "", do: [filepath | acc], else: acc
|
||||||
|
|
||||||
|
{:error, _} ->
|
||||||
|
acc
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
|
||||||
|
Enum.map(config_filepaths, fn filepath -> {:config_locations, filepath} end)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp output_options(media_item_with_preloads) do
|
||||||
[
|
[
|
||||||
output: Path.join(base_directory(), output_path)
|
output: build_output_path_for(media_item_with_preloads.source)
|
||||||
]
|
]
|
||||||
end
|
end
|
||||||
|
|
||||||
defp output_options_map(media_item_with_preloads) do
|
defp build_output_path(string, source) do
|
||||||
source = media_item_with_preloads.source
|
additional_options_map = output_options_map(source)
|
||||||
|
{:ok, output_path} = OutputPathBuilder.build(string, additional_options_map)
|
||||||
|
|
||||||
|
Path.join(base_directory(), output_path)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp output_options_map(source) do
|
||||||
%{
|
%{
|
||||||
"source_custom_name" => source.custom_name,
|
"source_custom_name" => source.custom_name,
|
||||||
|
"source_collection_id" => source.collection_id,
|
||||||
|
"source_collection_name" => source.collection_name,
|
||||||
"source_collection_type" => source.collection_type
|
"source_collection_type" => source.collection_type
|
||||||
}
|
}
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# I don't love the string manipulation here, but what can ya' do.
|
||||||
|
# It's dependent on the output_path_template being a string ending `.{{ ext }}`
|
||||||
|
# (or equivalent), but that's validated by the MediaProfile schema.
|
||||||
|
defp determine_thumbnail_location(media_item_with_preloads) do
|
||||||
|
output_path_template = Sources.output_path_template(media_item_with_preloads.source)
|
||||||
|
|
||||||
|
output_path_template
|
||||||
|
|> String.split(~r{\.}, include_captures: true)
|
||||||
|
|> List.insert_at(-3, "-thumb")
|
||||||
|
|> Enum.join()
|
||||||
|
|> build_output_path(media_item_with_preloads.source)
|
||||||
|
end
|
||||||
|
|
||||||
defp base_directory do
|
defp base_directory do
|
||||||
Application.get_env(:pinchflat, :media_directory)
|
Application.get_env(:pinchflat, :media_directory)
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -7,9 +7,11 @@ defmodule Pinchflat.Downloading.DownloadingHelpers do
|
|||||||
|
|
||||||
require Logger
|
require Logger
|
||||||
|
|
||||||
|
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 """
|
||||||
@@ -26,11 +28,7 @@ defmodule Pinchflat.Downloading.DownloadingHelpers do
|
|||||||
def enqueue_pending_download_tasks(%Source{download_media: true} = source) do
|
def enqueue_pending_download_tasks(%Source{download_media: true} = source) do
|
||||||
source
|
source
|
||||||
|> Media.list_pending_media_items_for()
|
|> Media.list_pending_media_items_for()
|
||||||
|> Enum.each(fn media_item ->
|
|> Enum.each(&MediaDownloadWorker.kickoff_with_task/1)
|
||||||
%{id: media_item.id}
|
|
||||||
|> MediaDownloadWorker.new()
|
|
||||||
|> Tasks.create_job_with_task(media_item)
|
|
||||||
end)
|
|
||||||
end
|
end
|
||||||
|
|
||||||
def enqueue_pending_download_tasks(%Source{download_media: false}) do
|
def enqueue_pending_download_tasks(%Source{download_media: false}) do
|
||||||
@@ -47,4 +45,23 @@ 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
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -6,51 +6,87 @@ defmodule Pinchflat.Downloading.MediaDownloadWorker do
|
|||||||
unique: [period: :infinity, states: [:available, :scheduled, :retryable, :executing]],
|
unique: [period: :infinity, states: [:available, :scheduled, :retryable, :executing]],
|
||||||
tags: ["media_item", "media_fetching"]
|
tags: ["media_item", "media_fetching"]
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias __MODULE__
|
||||||
|
alias Pinchflat.Tasks
|
||||||
alias Pinchflat.Repo
|
alias Pinchflat.Repo
|
||||||
alias Pinchflat.Media
|
alias Pinchflat.Media
|
||||||
alias Pinchflat.Tasks
|
|
||||||
alias Pinchflat.Downloading.MediaDownloader
|
alias Pinchflat.Downloading.MediaDownloader
|
||||||
alias Pinchflat.Filesystem.FilesystemDataWorker
|
|
||||||
|
|
||||||
@impl Oban.Worker
|
@doc """
|
||||||
|
Starts the media_item media download worker and creates a task for the media_item.
|
||||||
|
|
||||||
|
Returns {:ok, %Task{}} | {:error, :duplicate_job} | {:error, %Ecto.Changeset{}}
|
||||||
|
"""
|
||||||
|
def kickoff_with_task(media_item, job_args \\ %{}, job_opts \\ []) do
|
||||||
|
%{id: media_item.id}
|
||||||
|
|> Map.merge(job_args)
|
||||||
|
|> MediaDownloadWorker.new(job_opts)
|
||||||
|
|> Tasks.create_job_with_task(media_item)
|
||||||
|
end
|
||||||
|
|
||||||
@doc """
|
@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}
|
Returns :ok | {:ok, %MediaItem{}} | {:error, any, ...any}
|
||||||
"""
|
"""
|
||||||
def perform(%Oban.Job{args: %{"id" => media_item_id}}) do
|
@impl Oban.Worker
|
||||||
|
def perform(%Oban.Job{args: %{"id" => media_item_id} = args}) do
|
||||||
|
should_force = Map.get(args, "force", false)
|
||||||
|
is_redownload = Map.get(args, "redownload?", false)
|
||||||
|
|
||||||
media_item =
|
media_item =
|
||||||
media_item_id
|
media_item_id
|
||||||
|> Media.get_media_item!()
|
|> Media.get_media_item!()
|
||||||
|> Repo.preload(:source)
|
|> Repo.preload(:source)
|
||||||
|
|
||||||
# If the source is set to not download media, perform a no-op
|
# If the source or media item is set to not download media, perform a no-op unless forced
|
||||||
if media_item.source.download_media do
|
if (media_item.source.download_media && !media_item.prevent_download) || should_force do
|
||||||
download_media_and_schedule_jobs(media_item)
|
download_media_and_schedule_jobs(media_item, is_redownload)
|
||||||
else
|
else
|
||||||
:ok
|
:ok
|
||||||
end
|
end
|
||||||
|
rescue
|
||||||
|
Ecto.NoResultsError -> Logger.info("#{__MODULE__} discarded: media item #{media_item_id} not found")
|
||||||
|
Ecto.StaleEntryError -> Logger.info("#{__MODULE__} discarded: media item #{media_item_id} stale")
|
||||||
end
|
end
|
||||||
|
|
||||||
defp download_media_and_schedule_jobs(media_item) do
|
defp download_media_and_schedule_jobs(media_item, is_redownload) do
|
||||||
case MediaDownloader.download_for_media_item(media_item) do
|
case MediaDownloader.download_for_media_item(media_item) do
|
||||||
{:ok, _} ->
|
{:ok, updated_media_item} ->
|
||||||
schedule_filesystem_data_worker(media_item)
|
Media.update_media_item(updated_media_item, %{
|
||||||
{:ok, media_item}
|
media_size_bytes: compute_media_filesize(updated_media_item),
|
||||||
|
media_redownloaded_at: get_redownloaded_at(is_redownload)
|
||||||
|
})
|
||||||
|
|
||||||
err ->
|
{:ok, updated_media_item}
|
||||||
err
|
|
||||||
|
{:recovered, _} ->
|
||||||
|
{:error, :retry}
|
||||||
|
|
||||||
|
{:error, _message} ->
|
||||||
|
{:error, :download_failed}
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
defp schedule_filesystem_data_worker(media_item) do
|
defp compute_media_filesize(media_item) do
|
||||||
%{id: media_item.id}
|
case File.stat(media_item.media_filepath) do
|
||||||
|> FilesystemDataWorker.new()
|
{:ok, %{size: size}} ->
|
||||||
|> Tasks.create_job_with_task(media_item)
|
size
|
||||||
|> case do
|
|
||||||
{:ok, task} -> {:ok, task}
|
_ ->
|
||||||
{:error, :duplicate_job} -> {:ok, :job_exists}
|
nil
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp get_redownloaded_at(is_redownload) do
|
||||||
|
if is_redownload do
|
||||||
|
DateTime.utc_now()
|
||||||
|
else
|
||||||
|
nil
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -5,14 +5,18 @@ 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.MetadataParser
|
||||||
|
alias Pinchflat.Metadata.MetadataFileHelpers
|
||||||
|
alias Pinchflat.Utils.FilesystemUtils
|
||||||
|
alias Pinchflat.Downloading.DownloadOptionBuilder
|
||||||
|
|
||||||
alias Pinchflat.YtDlp.Media, as: YtDlpMedia
|
alias Pinchflat.YtDlp.Media, as: YtDlpMedia
|
||||||
alias Pinchflat.Downloading.DownloadOptionBuilder, as: YtDlpDownloadOptionBuilder
|
|
||||||
alias Pinchflat.Metadata.MetadataParser, as: YtDlpMetadataParser
|
|
||||||
alias Pinchflat.Metadata.MetadataFileHelpers, as: YtDlpMetadataHelpers
|
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Downloads media for a media item, updating the media item based on the metadata
|
Downloads media for a media item, updating the media item based on the metadata
|
||||||
@@ -26,40 +30,88 @@ 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) 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) do
|
||||||
{:ok, parsed_json} ->
|
{:ok, parsed_json} ->
|
||||||
{parser, helpers} = {YtDlpMetadataParser, YtDlpMetadataHelpers}
|
update_media_item_from_parsed_json(media_with_preloads, parsed_json)
|
||||||
|
|
||||||
parsed_attrs =
|
{:error, message, _exit_code} ->
|
||||||
parsed_json
|
Logger.error("yt-dlp download error for media item ##{media_with_preloads.id}: #{inspect(message)}")
|
||||||
|> parser.parse_for_media_item()
|
|
||||||
|> Map.merge(%{
|
|
||||||
media_downloaded_at: DateTime.utc_now(),
|
|
||||||
metadata: %{
|
|
||||||
metadata_filepath: helpers.compress_and_store_metadata_for(media_item, parsed_json),
|
|
||||||
thumbnail_filepath: helpers.download_and_store_thumbnail_for(media_item, parsed_json)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
# Don't forgor to use preloaded associations or updates to
|
if String.contains?(to_string(message), recoverable_errors()) do
|
||||||
# associations won't work!
|
attempt_update_media_item(media_with_preloads, output_filepath)
|
||||||
Media.update_media_item(item_with_preloads, parsed_attrs)
|
|
||||||
|
{:recovered, message}
|
||||||
|
else
|
||||||
|
{:error, message}
|
||||||
|
end
|
||||||
|
|
||||||
err ->
|
err ->
|
||||||
err
|
Logger.error("Unknown error downloading media item ##{media_with_preloads.id}: #{inspect(err)}")
|
||||||
|
|
||||||
|
{:error, "Unknown error: #{inspect(err)}"}
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# def download_for_source(source, url) do
|
defp attempt_update_media_item(media_with_preloads, output_filepath) do
|
||||||
# # Create MI from source and URL
|
with {:ok, contents} <- File.read(output_filepath),
|
||||||
# media_item = nil
|
{:ok, parsed_json} <- Phoenix.json_library().decode(contents) do
|
||||||
# end
|
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
|
||||||
|
""")
|
||||||
|
|
||||||
defp download_with_options(url, item_with_preloads) do
|
update_media_item_from_parsed_json(media_with_preloads, parsed_json)
|
||||||
{:ok, options} = YtDlpDownloadOptionBuilder.build(item_with_preloads)
|
else
|
||||||
|
err ->
|
||||||
|
Logger.error("Unable to recover error for media item ##{media_with_preloads.id}: #{inspect(err)}")
|
||||||
|
|
||||||
YtDlpMedia.download(url, options)
|
{:error, :retry_failed}
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp update_media_item_from_parsed_json(media_with_preloads, parsed_json) do
|
||||||
|
parsed_attrs =
|
||||||
|
parsed_json
|
||||||
|
|> MetadataParser.parse_for_media_item()
|
||||||
|
|> Map.merge(%{
|
||||||
|
media_downloaded_at: DateTime.utc_now(),
|
||||||
|
nfo_filepath: determine_nfo_filepath(media_with_preloads, parsed_json),
|
||||||
|
metadata: %{
|
||||||
|
# IDEA: might be worth kicking off a job for this since thumbnail fetching
|
||||||
|
# could fail and I want to handle that in isolation
|
||||||
|
metadata_filepath: MetadataFileHelpers.compress_and_store_metadata_for(media_with_preloads, parsed_json),
|
||||||
|
thumbnail_filepath: MetadataFileHelpers.download_and_store_thumbnail_for(media_with_preloads, parsed_json)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
# Don't forgor to use preloaded associations or updates to
|
||||||
|
# associations won't work!
|
||||||
|
Media.update_media_item(media_with_preloads, parsed_attrs)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp determine_nfo_filepath(media_item, parsed_json) do
|
||||||
|
if media_item.source.media_profile.download_nfo do
|
||||||
|
filepath = Path.rootname(parsed_json["filepath"]) <> ".nfo"
|
||||||
|
|
||||||
|
NfoBuilder.build_and_store_for_media_item(filepath, parsed_json)
|
||||||
|
else
|
||||||
|
nil
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp download_with_options(url, item_with_preloads, output_filepath) do
|
||||||
|
{:ok, options} = DownloadOptionBuilder.build(item_with_preloads)
|
||||||
|
|
||||||
|
YtDlpMedia.download(url, options, output_filepath: output_filepath)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp recoverable_errors do
|
||||||
|
[
|
||||||
|
"Unable to communicate with SponsorBlock"
|
||||||
|
]
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -0,0 +1,31 @@
|
|||||||
|
defmodule Pinchflat.Downloading.MediaRedownloadWorker do
|
||||||
|
@moduledoc false
|
||||||
|
|
||||||
|
use Oban.Worker,
|
||||||
|
queue: :media_fetching,
|
||||||
|
unique: [period: :infinity, states: [:available, :scheduled, :retryable, :executing]],
|
||||||
|
tags: ["media_item", "media_fetching"]
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias Pinchflat.Media
|
||||||
|
alias Pinchflat.Downloading.MediaDownloadWorker
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Redownloads media items that are eligible for redownload.
|
||||||
|
|
||||||
|
This worker is scheduled to run daily via the Oban Cron plugin
|
||||||
|
and it should run _after_ the retention worker.
|
||||||
|
|
||||||
|
Returns :ok
|
||||||
|
"""
|
||||||
|
@impl Oban.Worker
|
||||||
|
def perform(%Oban.Job{}) do
|
||||||
|
redownloadable_media = Media.list_redownloadable_media_items()
|
||||||
|
Logger.info("Redownloading #{length(redownloadable_media)} media items")
|
||||||
|
|
||||||
|
Enum.each(redownloadable_media, fn media_item ->
|
||||||
|
MediaDownloadWorker.kickoff_with_task(media_item, %{redownload?: true})
|
||||||
|
end)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,33 @@
|
|||||||
|
defmodule Pinchflat.Downloading.MediaRetentionWorker do
|
||||||
|
@moduledoc false
|
||||||
|
|
||||||
|
use Oban.Worker,
|
||||||
|
queue: :local_metadata,
|
||||||
|
unique: [period: :infinity, states: [:available, :scheduled, :retryable, :executing]],
|
||||||
|
tags: ["media_item", "local_metadata"]
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias Pinchflat.Media
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Deletes media items that are past their retention date and prevents
|
||||||
|
them from being re-downloaded.
|
||||||
|
|
||||||
|
This worker is scheduled to run daily via the Oban Cron plugin.
|
||||||
|
|
||||||
|
Returns :ok
|
||||||
|
"""
|
||||||
|
@impl Oban.Worker
|
||||||
|
def perform(%Oban.Job{}) do
|
||||||
|
cullable_media = Media.list_cullable_media_items()
|
||||||
|
Logger.info("Culling #{length(cullable_media)} media items past their retention date")
|
||||||
|
|
||||||
|
Enum.each(cullable_media, fn media_item ->
|
||||||
|
Media.delete_media_files(media_item, %{
|
||||||
|
prevent_download: true,
|
||||||
|
culled_at: DateTime.utc_now()
|
||||||
|
})
|
||||||
|
end)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -40,7 +40,10 @@ defmodule Pinchflat.Downloading.OutputPathBuilder do
|
|||||||
"upload_year" => "%(upload_date>%Y)S",
|
"upload_year" => "%(upload_date>%Y)S",
|
||||||
"upload_month" => "%(upload_date>%m)S",
|
"upload_month" => "%(upload_date>%m)S",
|
||||||
"upload_day" => "%(upload_date>%d)S",
|
"upload_day" => "%(upload_date>%d)S",
|
||||||
"upload_yyyy_mm_dd" => "%(upload_date>%Y)S-%(upload_date>%m)S-%(upload_date>%d)S"
|
"upload_yyyy_mm_dd" => "%(upload_date>%Y-%m-%d)S",
|
||||||
|
"season_from_date" => "%(upload_date>%Y)S",
|
||||||
|
"season_episode_from_date" => "s%(upload_date>%Y)Se%(upload_date>%m%d)S",
|
||||||
|
"artist_name" => "%(artist,creator,uploader,uploader_id)S"
|
||||||
}
|
}
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -5,90 +5,63 @@ 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
|
||||||
|
|
||||||
|
alias Pinchflat.Repo
|
||||||
alias Pinchflat.Media
|
alias Pinchflat.Media
|
||||||
alias Pinchflat.Tasks
|
|
||||||
alias Pinchflat.Sources.Source
|
alias Pinchflat.Sources.Source
|
||||||
|
alias Pinchflat.Media.MediaQuery
|
||||||
alias Pinchflat.FastIndexing.YoutubeRss
|
alias Pinchflat.FastIndexing.YoutubeRss
|
||||||
alias Pinchflat.FastIndexing.FastIndexingWorker
|
alias Pinchflat.Downloading.DownloadingHelpers
|
||||||
alias Pinchflat.Downloading.MediaDownloadWorker
|
|
||||||
alias Pinchflat.FastIndexing.MediaIndexingWorker
|
|
||||||
|
|
||||||
alias Pinchflat.YtDlp.Media, as: YtDlpMedia
|
alias Pinchflat.YtDlp.Media, as: YtDlpMedia
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Starts tasks for running a fast indexing task for a source's media
|
Fetches new media IDs from a source's YouTube RSS feed, indexes them, and kicks off downloading
|
||||||
regardless of the source's fast_index state. It's assumed the
|
tasks for any pending media items. See comments in `FastIndexingWorker` for more info on the
|
||||||
caller will check for fast_index.
|
|
||||||
|
|
||||||
This is used for running fast index tasks on update. On creation, the
|
|
||||||
fast index is enqueued after the slow index is complete.
|
|
||||||
|
|
||||||
Returns {:ok, %Task{}}.
|
|
||||||
"""
|
|
||||||
def kickoff_fast_indexing_task(%Source{} = source) do
|
|
||||||
Tasks.delete_pending_tasks_for(source, "FastIndexingWorker")
|
|
||||||
|
|
||||||
%{id: source.id}
|
|
||||||
# Schedule this one immediately, but future ones will be on an interval
|
|
||||||
|> FastIndexingWorker.new()
|
|
||||||
|> Tasks.create_job_with_task(source)
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Fetches new media IDs from a source's YouTube RSS feed and kicks off indexing tasks
|
|
||||||
for any new media items. See comments in `MediaIndexingWorker` for more info on the
|
|
||||||
order of operations and how this fits into the indexing process.
|
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} = YoutubeRss.get_recent_media_ids_from_rss(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 =
|
||||||
url = "https://www.youtube.com/watch?v=#{media_id}"
|
Enum.map(new_media_ids, fn media_id ->
|
||||||
|
case create_media_item_from_media_id(source, media_id) do
|
||||||
|
{:ok, media_item} ->
|
||||||
|
media_item
|
||||||
|
|
||||||
%{id: source.id, media_url: url}
|
err ->
|
||||||
|> MediaIndexingWorker.new()
|
Logger.error("Error creating media item '#{media_id}' from URL: #{inspect(err)}")
|
||||||
|> Tasks.create_job_with_task(source)
|
nil
|
||||||
end)
|
end
|
||||||
|
end)
|
||||||
|
|
||||||
|
DownloadingHelpers.enqueue_pending_download_tasks(source)
|
||||||
|
|
||||||
|
Enum.filter(maybe_new_media_items, & &1)
|
||||||
end
|
end
|
||||||
|
|
||||||
@doc """
|
defp list_media_items_by_media_id_for(source, media_ids) do
|
||||||
Indexes a single media item for a source and enqueues a download job if the
|
MediaQuery.new()
|
||||||
media should be downloaded. This method creates the media item record so it's
|
|> MediaQuery.for_source(source)
|
||||||
the one-stop-shop for adding a media item (and possibly downloading it) just
|
|> MediaQuery.with_media_ids(media_ids)
|
||||||
by a URL and source.
|
|> Repo.all()
|
||||||
|
end
|
||||||
|
|
||||||
Returns {:ok, media_item} | {:error, any()}
|
defp create_media_item_from_media_id(source, media_id) do
|
||||||
"""
|
url = "https://www.youtube.com/watch?v=#{media_id}"
|
||||||
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
|
case YtDlpMedia.get_media_attributes(url) do
|
||||||
{:ok, media_item} ->
|
{:ok, media_attrs} ->
|
||||||
if source.download_media && Media.pending_download?(media_item) do
|
Media.create_media_item_from_backend_attrs(source, media_attrs)
|
||||||
%{id: media_item.id}
|
|
||||||
|> MediaDownloadWorker.new()
|
|
||||||
|> Tasks.create_job_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
|
||||||
|
|||||||
@@ -6,39 +6,79 @@ defmodule Pinchflat.FastIndexing.FastIndexingWorker do
|
|||||||
unique: [period: :infinity, states: [:available, :scheduled, :retryable]],
|
unique: [period: :infinity, states: [:available, :scheduled, :retryable]],
|
||||||
tags: ["media_source", "fast_indexing"]
|
tags: ["media_source", "fast_indexing"]
|
||||||
|
|
||||||
|
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.Notifications.SourceNotifications
|
||||||
|
|
||||||
@impl Oban.Worker
|
|
||||||
@doc """
|
@doc """
|
||||||
Kicks off the fast indexing process for a source, reschedules the job to run again
|
Starts the source fast indexing worker and creates a task for the source.
|
||||||
once complete. See `MediaCollectionIndexingWorker` and `MediaIndexingWorker` comments
|
|
||||||
for more
|
Returns {:ok, %Task{}} | {:error, :duplicate_job} | {:error, %Ecto.Changeset{}}
|
||||||
|
"""
|
||||||
|
def kickoff_with_task(source, opts \\ []) do
|
||||||
|
%{id: source.id}
|
||||||
|
|> FastIndexingWorker.new(opts)
|
||||||
|
|> Tasks.create_job_with_task(source)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Similar to `MediaCollectionIndexingWorker`, but for working with RSS feeds.
|
||||||
|
`MediaCollectionIndexingWorker` should be preferred in general, but this is
|
||||||
|
useful for downloading small batches of media items via fast indexing.
|
||||||
|
|
||||||
|
Only kicks off downloads for media that _should_ be downloaded
|
||||||
|
(ie: the source is set to download and the media matches the profile's format preferences)
|
||||||
|
|
||||||
|
Order of operations:
|
||||||
|
1. FastIndexingWorker (this module) periodically checks the YouTube RSS feed for new media.
|
||||||
|
with `FastIndexingHelpers.kickoff_download_tasks_from_youtube_rss_feed`
|
||||||
|
2. If the above `kickoff_download_tasks_from_youtube_rss_feed` finds new media items in the RSS feed,
|
||||||
|
it indexes them with a yt-dlp call to create the media item records then kicks off downloading
|
||||||
|
tasks (MediaDownloadWorker) for any new media items _that should be downloaded_.
|
||||||
|
3. Once downloads are kicked off, this worker sends a notification to the apprise server if applicable
|
||||||
|
then reschedules itself to run again in the future.
|
||||||
|
|
||||||
Returns :ok | {:ok, :job_exists} | {:ok, %Task{}}
|
Returns :ok | {:ok, :job_exists} | {:ok, %Task{}}
|
||||||
"""
|
"""
|
||||||
|
@impl Oban.Worker
|
||||||
def perform(%Oban.Job{args: %{"id" => source_id}}) do
|
def perform(%Oban.Job{args: %{"id" => source_id}}) 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
|
||||||
end
|
end
|
||||||
|
rescue
|
||||||
|
Ecto.NoResultsError -> Logger.info("#{__MODULE__} discarded: source #{source_id} not found")
|
||||||
|
Ecto.StaleEntryError -> Logger.info("#{__MODULE__} discarded: source #{source_id} stale")
|
||||||
|
end
|
||||||
|
|
||||||
|
defp perform_indexing_and_send_notification(source) do
|
||||||
|
apprise_server = Settings.get!(:apprise_server)
|
||||||
|
|
||||||
|
new_media_items =
|
||||||
|
source
|
||||||
|
|> FastIndexingHelpers.kickoff_download_tasks_from_youtube_rss_feed()
|
||||||
|
|> Enum.filter(&Media.pending_download?(&1))
|
||||||
|
|
||||||
|
if source.download_media do
|
||||||
|
SourceNotifications.send_new_media_notification(apprise_server, source, length(new_media_items))
|
||||||
|
end
|
||||||
end
|
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
|
||||||
|
|
||||||
%{id: source.id}
|
case kickoff_with_task(source, schedule_in: next_run_in) do
|
||||||
|> FastIndexingWorker.new(schedule_in: next_run_in)
|
|
||||||
|> Tasks.create_job_with_task(source)
|
|
||||||
|> case do
|
|
||||||
{:ok, task} -> {:ok, task}
|
{:ok, task} -> {:ok, task}
|
||||||
{:error, :duplicate_job} -> {:ok, :job_exists}
|
{:error, :duplicate_job} -> {:ok, :job_exists}
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,53 +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 Pinchflat.Sources
|
|
||||||
alias Pinchflat.FastIndexing.FastIndexingHelpers
|
|
||||||
|
|
||||||
@impl Oban.Worker
|
|
||||||
@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
|
|
||||||
"""
|
|
||||||
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
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
defmodule Pinchflat.Filesystem.FilesystemDataWorker do
|
|
||||||
@moduledoc false
|
|
||||||
|
|
||||||
use Oban.Worker,
|
|
||||||
queue: :media_local_metadata,
|
|
||||||
tags: ["media_item", "media_metadata", "local_metadata"],
|
|
||||||
max_attempts: 1
|
|
||||||
|
|
||||||
alias Pinchflat.Media
|
|
||||||
alias Pinchflat.Filesystem.FilesystemHelpers
|
|
||||||
|
|
||||||
@impl Oban.Worker
|
|
||||||
@doc """
|
|
||||||
For a given media item, compute and save metadata about the file on-disk.
|
|
||||||
|
|
||||||
Returns :ok
|
|
||||||
"""
|
|
||||||
def perform(%Oban.Job{args: %{"id" => media_item_id}}) do
|
|
||||||
media_item = Media.get_media_item!(media_item_id)
|
|
||||||
|
|
||||||
FilesystemHelpers.compute_and_save_media_filesize(media_item)
|
|
||||||
|
|
||||||
# Don't retry on failure - if it didn't work immediately there's no
|
|
||||||
# reason to believe it will work later.
|
|
||||||
:ok
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,38 +0,0 @@
|
|||||||
defmodule Pinchflat.Filesystem.FilesystemHelpers do
|
|
||||||
@moduledoc """
|
|
||||||
Utility methods for working with the filesystem
|
|
||||||
"""
|
|
||||||
alias Pinchflat.Media
|
|
||||||
alias Pinchflat.Utils.StringUtils
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Generates a temporary file and returns its path. The file is empty and has the given type.
|
|
||||||
Generates all the directories in the path if they don't exist.
|
|
||||||
|
|
||||||
Returns binary()
|
|
||||||
"""
|
|
||||||
def generate_metadata_tmpfile(type) do
|
|
||||||
tmpfile_directory = Application.get_env(:pinchflat, :tmpfile_directory)
|
|
||||||
filepath = Path.join([tmpfile_directory, "#{StringUtils.random_string(64)}.#{type}"])
|
|
||||||
|
|
||||||
:ok = File.mkdir_p!(Path.dirname(filepath))
|
|
||||||
:ok = File.write(filepath, "")
|
|
||||||
|
|
||||||
filepath
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Fetches the file size of a media item and saves it to the database.
|
|
||||||
|
|
||||||
Returns {:ok, media_item} | {:error, any()}
|
|
||||||
"""
|
|
||||||
def compute_and_save_media_filesize(media_item) do
|
|
||||||
case File.stat(media_item.media_filepath) do
|
|
||||||
{:ok, %{size: size}} ->
|
|
||||||
Media.update_media_item(media_item, %{media_size_bytes: size})
|
|
||||||
|
|
||||||
err ->
|
|
||||||
err
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
+84
-151
@@ -7,9 +7,11 @@ defmodule Pinchflat.Media do
|
|||||||
|
|
||||||
alias Pinchflat.Repo
|
alias Pinchflat.Repo
|
||||||
alias Pinchflat.Tasks
|
alias Pinchflat.Tasks
|
||||||
alias Pinchflat.Media.MediaItem
|
|
||||||
alias Pinchflat.Sources.Source
|
alias Pinchflat.Sources.Source
|
||||||
|
alias Pinchflat.Media.MediaItem
|
||||||
|
alias Pinchflat.Media.MediaQuery
|
||||||
alias Pinchflat.Metadata.MediaMetadata
|
alias Pinchflat.Metadata.MediaMetadata
|
||||||
|
alias Pinchflat.Utils.FilesystemUtils
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Returns the list of media_items.
|
Returns the list of media_items.
|
||||||
@@ -21,65 +23,56 @@ 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 cullable based on the retention period
|
||||||
|
of the source they belong to.
|
||||||
|
|
||||||
Returns [%MediaItem{}, ...].
|
Returns [%MediaItem{}, ...]
|
||||||
"""
|
"""
|
||||||
def list_media_items_for(%Source{} = source) do
|
def list_cullable_media_items do
|
||||||
MediaItem
|
MediaQuery.new()
|
||||||
|> where([mi], mi.source_id == ^source.id)
|
|> MediaQuery.with_media_filepath()
|
||||||
|
|> MediaQuery.where_past_retention_period()
|
||||||
|
|> MediaQuery.where_culling_not_prevented()
|
||||||
|> Repo.all()
|
|> Repo.all()
|
||||||
end
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Fetches all media items belonging to a given source that have a media_id in the given list.
|
Returns a list of media_items that are redownloadable based on the redownload delay
|
||||||
Useful for determining the what media items we DON'T already have for fast indexing.
|
of the media_profile their source belongs to.
|
||||||
|
|
||||||
NOTE: These queries are getting a little tedious. When I have the time, I should see about
|
The logic is that a media_item is past_redownload_delay if the media_item's
|
||||||
implementing a query pattern and having these compose queries from a common base. This would
|
upload_date is at least redownload_delay_days ago AND
|
||||||
also let me compose simple queries in the module using them for one-off methods
|
`media_downloaded_at` - `redownload_delay_days` is before the media_item's `upload_date`.
|
||||||
|
This logic grabs media that we've recently downloaded AND is recently uploaded, but
|
||||||
|
doesn't grab media that we've recently downloaded and was uploaded a long time ago.
|
||||||
|
This also makes things work as expected when downloading media from a source for the
|
||||||
|
first time.
|
||||||
|
|
||||||
Returns [%MediaItem{}, ...].
|
Returns [%MediaItem{}, ...]
|
||||||
"""
|
"""
|
||||||
def list_media_items_by_media_id_for(%Source{} = source, media_ids) do
|
def list_redownloadable_media_items do
|
||||||
MediaItem
|
MediaQuery.new()
|
||||||
|> where([mi], mi.source_id == ^source.id and mi.media_id in ^media_ids)
|
|> MediaQuery.with_media_downloaded_at()
|
||||||
|
|> MediaQuery.where_download_not_prevented()
|
||||||
|
|> MediaQuery.where_not_culled()
|
||||||
|
|> MediaQuery.where_media_not_redownloaded()
|
||||||
|
|> MediaQuery.where_past_redownload_delay()
|
||||||
|> 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_filepath` is `nil` AND the media_item
|
||||||
matches the format selection rules of the parent media_profile.
|
matches satisfies `MediaQuery.where_pending_download`. You
|
||||||
|
should really check out that function if you need to know more
|
||||||
See `build_format_clauses` but tl;dr is it _may_ filter based
|
because it has a lot going on.
|
||||||
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.for_source(source)
|
||||||
|
|> MediaQuery.where_pending_download()
|
||||||
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))
|
|
||||||
|> 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
|
||||||
|
|
||||||
@@ -95,10 +88,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.with_id(media_item.id)
|
||||||
|> where(^build_format_clauses(media_item.source.media_profile))
|
|> MediaQuery.where_pending_download()
|
||||||
|> where(^maybe_apply_cutoff_date(media_item.source))
|
|
||||||
|> Repo.exists?()
|
|> Repo.exists?()
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -117,20 +109,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
|
||||||
|
|
||||||
@@ -141,38 +122,6 @@ defmodule Pinchflat.Media do
|
|||||||
"""
|
"""
|
||||||
def get_media_item!(id), do: Repo.get!(MediaItem, id)
|
def get_media_item!(id), do: Repo.get!(MediaItem, id)
|
||||||
|
|
||||||
@doc """
|
|
||||||
Produces a flat list of the filesystem paths for a media_item's downloaded files
|
|
||||||
|
|
||||||
Returns [binary()]
|
|
||||||
"""
|
|
||||||
def media_filepaths(media_item) do
|
|
||||||
mapped_struct = Map.from_struct(media_item)
|
|
||||||
|
|
||||||
MediaItem.filepath_attributes()
|
|
||||||
|> Enum.map(fn
|
|
||||||
:subtitle_filepaths = field -> Enum.map(mapped_struct[field], fn [_, filepath] -> filepath end)
|
|
||||||
field -> List.wrap(mapped_struct[field])
|
|
||||||
end)
|
|
||||||
|> List.flatten()
|
|
||||||
|> Enum.filter(&is_binary/1)
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Produces a flat list of the filesystem paths for a media_item's metadata files.
|
|
||||||
Returns an empty list if the media_item has no metadata.
|
|
||||||
|
|
||||||
Returns [binary()] | []
|
|
||||||
"""
|
|
||||||
def metadata_filepaths(media_item) do
|
|
||||||
metadata = Repo.preload(media_item, :metadata).metadata || %MediaMetadata{}
|
|
||||||
mapped_struct = Map.from_struct(metadata)
|
|
||||||
|
|
||||||
MediaMetadata.filepath_attributes()
|
|
||||||
|> Enum.map(fn field -> mapped_struct[field] end)
|
|
||||||
|> Enum.filter(&is_binary/1)
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Creates a media_item.
|
Creates a media_item.
|
||||||
|
|
||||||
@@ -219,22 +168,44 @@ defmodule Pinchflat.Media do
|
|||||||
end
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Deletes a media_item and its associated tasks.
|
Deletes a media_item, its associated tasks, and our internal metadata files.
|
||||||
Can optionally delete the media_item's files.
|
Can optionally delete the media_item's media files (media, thumbnail, subtitles, etc).
|
||||||
|
|
||||||
Returns {:ok, %MediaItem{}} | {:error, %Ecto.Changeset{}}
|
Returns {:ok, %MediaItem{}} | {:error, %Ecto.Changeset{}}
|
||||||
"""
|
"""
|
||||||
def delete_media_item(%MediaItem{} = media_item, opts \\ []) do
|
def delete_media_item(%MediaItem{} = media_item, opts \\ []) do
|
||||||
delete_files = Keyword.get(opts, :delete_files, false)
|
delete_files = Keyword.get(opts, :delete_files, false)
|
||||||
|
|
||||||
|
Tasks.delete_tasks_for(media_item)
|
||||||
|
|
||||||
if delete_files do
|
if delete_files do
|
||||||
{:ok, _} = delete_all_attachments(media_item)
|
{:ok, _} = do_delete_media_files(media_item)
|
||||||
end
|
end
|
||||||
|
|
||||||
Tasks.delete_tasks_for(media_item)
|
# Should delete these no matter what
|
||||||
|
delete_internal_metadata_files(media_item)
|
||||||
Repo.delete(media_item)
|
Repo.delete(media_item)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
@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)
|
||||||
|
|
||||||
|
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.
|
||||||
"""
|
"""
|
||||||
@@ -242,66 +213,28 @@ defmodule Pinchflat.Media do
|
|||||||
MediaItem.changeset(media_item, attrs)
|
MediaItem.changeset(media_item, attrs)
|
||||||
end
|
end
|
||||||
|
|
||||||
defp delete_all_attachments(media_item) do
|
defp do_delete_media_files(media_item) do
|
||||||
media_item = Repo.preload(media_item, :metadata)
|
mapped_struct = Map.from_struct(media_item)
|
||||||
|
|
||||||
media_item
|
MediaItem.filepath_attributes()
|
||||||
|> media_filepaths()
|
|> Enum.map(fn
|
||||||
|> Enum.concat(metadata_filepaths(media_item))
|
:subtitle_filepaths = field -> Enum.map(mapped_struct[field], fn [_, filepath] -> filepath end)
|
||||||
|> Enum.each(&File.rm/1)
|
field -> List.wrap(mapped_struct[field])
|
||||||
|
end)
|
||||||
# rmdir will attempt to delete the directory, but only if it is empty
|
|> List.flatten()
|
||||||
if media_item.media_filepath do
|
|> Enum.filter(&is_binary/1)
|
||||||
File.rmdir(Path.dirname(media_item.media_filepath))
|
|> Enum.each(&FilesystemUtils.delete_file_and_remove_empty_directories/1)
|
||||||
end
|
|
||||||
|
|
||||||
if media_item.metadata && media_item.metadata.metadata_filepath do
|
|
||||||
File.rmdir(Path.dirname(media_item.metadata.metadata_filepath))
|
|
||||||
end
|
|
||||||
|
|
||||||
{:ok, media_item}
|
{:ok, media_item}
|
||||||
end
|
end
|
||||||
|
|
||||||
defp maybe_apply_cutoff_date(source) do
|
defp delete_internal_metadata_files(media_item) do
|
||||||
if source.download_cutoff_date do
|
metadata = Repo.preload(media_item, :metadata).metadata || %MediaMetadata{}
|
||||||
dynamic([mi], mi.upload_date >= ^source.download_cutoff_date)
|
mapped_struct = Map.from_struct(metadata)
|
||||||
else
|
|
||||||
dynamic(true)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
defp build_format_clauses(media_profile) do
|
MediaMetadata.filepath_attributes()
|
||||||
mapped_struct = Map.from_struct(media_profile)
|
|> Enum.map(fn field -> mapped_struct[field] end)
|
||||||
|
|> Enum.filter(&is_binary/1)
|
||||||
Enum.reduce(mapped_struct, dynamic(true), fn attr, dynamic ->
|
|> Enum.each(&FilesystemUtils.delete_file_and_remove_empty_directories/1)
|
||||||
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
|
||||||
|
|||||||
@@ -5,6 +5,7 @@ defmodule Pinchflat.Media.MediaItem do
|
|||||||
|
|
||||||
use Ecto.Schema
|
use Ecto.Schema
|
||||||
import Ecto.Changeset
|
import Ecto.Changeset
|
||||||
|
import Pinchflat.Utils.ChangesetUtils
|
||||||
|
|
||||||
alias Pinchflat.Tasks.Task
|
alias Pinchflat.Tasks.Task
|
||||||
alias Pinchflat.Sources.Source
|
alias Pinchflat.Sources.Source
|
||||||
@@ -21,16 +22,24 @@ defmodule Pinchflat.Media.MediaItem do
|
|||||||
:source_id,
|
:source_id,
|
||||||
:short_form_content,
|
:short_form_content,
|
||||||
:upload_date,
|
:upload_date,
|
||||||
|
: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,
|
||||||
:media_size_bytes,
|
:media_size_bytes,
|
||||||
:subtitle_filepaths,
|
:subtitle_filepaths,
|
||||||
:thumbnail_filepath,
|
:thumbnail_filepath,
|
||||||
:metadata_filepath
|
:metadata_filepath,
|
||||||
|
:nfo_filepath,
|
||||||
|
# These are user or system controlled fields
|
||||||
|
:prevent_download,
|
||||||
|
:prevent_culling,
|
||||||
|
:culled_at,
|
||||||
|
:media_redownloaded_at
|
||||||
]
|
]
|
||||||
# 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(
|
||||||
|
uuid
|
||||||
title
|
title
|
||||||
original_url
|
original_url
|
||||||
livestream
|
livestream
|
||||||
@@ -38,9 +47,14 @@ defmodule Pinchflat.Media.MediaItem do
|
|||||||
source_id
|
source_id
|
||||||
upload_date
|
upload_date
|
||||||
short_form_content
|
short_form_content
|
||||||
)a
|
)a
|
||||||
|
|
||||||
schema "media_items" do
|
schema "media_items" do
|
||||||
|
# This is _not_ used as the primary key or internally in the database
|
||||||
|
# relations. This is only used to prevent an enumeration attack on the streaming
|
||||||
|
# and RSS feed endpoints since those _must_ be public (ie: no basic auth)
|
||||||
|
field :uuid, Ecto.UUID
|
||||||
|
|
||||||
field :title, :string
|
field :title, :string
|
||||||
field :media_id, :string
|
field :media_id, :string
|
||||||
field :description, :string
|
field :description, :string
|
||||||
@@ -48,17 +62,24 @@ 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 :media_redownloaded_at, :utc_datetime
|
||||||
field :upload_date, :date
|
field :upload_date, :date
|
||||||
|
field :duration_seconds, :integer
|
||||||
|
|
||||||
field :media_filepath, :string
|
field :media_filepath, :string
|
||||||
field :media_size_bytes, :integer
|
field :media_size_bytes, :integer
|
||||||
field :thumbnail_filepath, :string
|
field :thumbnail_filepath, :string
|
||||||
field :metadata_filepath, :string
|
field :metadata_filepath, :string
|
||||||
|
field :nfo_filepath, :string
|
||||||
# This is an array of [iso-2 language, filepath] pairs. Probably could
|
# This is an array of [iso-2 language, filepath] pairs. Probably could
|
||||||
# be an associated record, but I don't see the benefit right now.
|
# be an associated record, but I don't see the benefit right now.
|
||||||
# Will very likely revisit because I can't leave well-enough alone.
|
# Will very likely revisit because I can't leave well-enough alone.
|
||||||
field :subtitle_filepaths, {:array, {:array, :string}}, default: []
|
field :subtitle_filepaths, {:array, {:array, :string}}, default: []
|
||||||
|
|
||||||
|
field :prevent_download, :boolean, default: false
|
||||||
|
field :prevent_culling, :boolean, default: false
|
||||||
|
field :culled_at, :utc_datetime
|
||||||
|
|
||||||
field :matching_search_term, :string, virtual: true
|
field :matching_search_term, :string, virtual: true
|
||||||
|
|
||||||
belongs_to :source, Source
|
belongs_to :source, Source
|
||||||
@@ -76,12 +97,23 @@ defmodule Pinchflat.Media.MediaItem do
|
|||||||
media_item
|
media_item
|
||||||
|> cast(attrs, @allowed_fields)
|
|> cast(attrs, @allowed_fields)
|
||||||
|> cast_assoc(:metadata, with: &MediaMetadata.changeset/2, required: false)
|
|> cast_assoc(:metadata, with: &MediaMetadata.changeset/2, required: false)
|
||||||
|
|> dynamic_default(:uuid, fn _ -> Ecto.UUID.generate() end)
|
||||||
|> validate_required(@required_fields)
|
|> validate_required(@required_fields)
|
||||||
|> unique_constraint([:media_id, :source_id])
|
|> unique_constraint([:media_id, :source_id])
|
||||||
end
|
end
|
||||||
|
|
||||||
@doc false
|
@doc false
|
||||||
def filepath_attributes do
|
def filepath_attributes do
|
||||||
~w(media_filepath thumbnail_filepath metadata_filepath subtitle_filepaths)a
|
~w(media_filepath thumbnail_filepath metadata_filepath subtitle_filepaths nfo_filepath)a
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc false
|
||||||
|
def filepath_attribute_defaults do
|
||||||
|
filepath_attributes()
|
||||||
|
|> Enum.map(fn
|
||||||
|
:subtitle_filepaths -> {:subtitle_filepaths, []}
|
||||||
|
field -> {field, nil}
|
||||||
|
end)
|
||||||
|
|> Enum.into(%{})
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -0,0 +1,184 @@
|
|||||||
|
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
|
||||||
|
|
||||||
|
# Prefixes:
|
||||||
|
# - for_* - belonging to a certain record
|
||||||
|
# - join_* - for joining on a certain record
|
||||||
|
# - with_*, where_* - for filtering based on full, concrete attributes
|
||||||
|
# - matching_* - for filtering based on partial attributes (e.g. LIKE, regex, full-text search)
|
||||||
|
#
|
||||||
|
# Suffixes:
|
||||||
|
# - _for - the arg passed is an association record
|
||||||
|
|
||||||
|
def new do
|
||||||
|
MediaItem
|
||||||
|
end
|
||||||
|
|
||||||
|
def for_source(query, source) do
|
||||||
|
where(query, [mi], mi.source_id == ^source.id)
|
||||||
|
end
|
||||||
|
|
||||||
|
def join_sources(query) do
|
||||||
|
from(mi in query, join: s in assoc(mi, :source), as: :sources)
|
||||||
|
end
|
||||||
|
|
||||||
|
def where_past_retention_period(query) do
|
||||||
|
query
|
||||||
|
|> require_assoc(:source)
|
||||||
|
|> where(
|
||||||
|
[mi, source],
|
||||||
|
fragment("""
|
||||||
|
IFNULL(retention_period_days, 0) > 0 AND
|
||||||
|
DATETIME('now', '-' || retention_period_days || ' day') > media_downloaded_at
|
||||||
|
""")
|
||||||
|
)
|
||||||
|
end
|
||||||
|
|
||||||
|
def where_past_redownload_delay(query) do
|
||||||
|
query
|
||||||
|
|> require_assoc(:source)
|
||||||
|
|> require_assoc(:media_profile)
|
||||||
|
|> where(
|
||||||
|
[_mi, _source, _media_profile],
|
||||||
|
# Returns media items where the upload_date is at least redownload_delay_days ago AND
|
||||||
|
# downloaded_at minus the redownload_delay_days is before the upload date
|
||||||
|
fragment("""
|
||||||
|
IFNULL(redownload_delay_days, 0) > 0 AND
|
||||||
|
DATETIME('now', '-' || redownload_delay_days || ' day') > upload_date AND
|
||||||
|
DATETIME(media_downloaded_at, '-' || redownload_delay_days || ' day') < upload_date
|
||||||
|
""")
|
||||||
|
)
|
||||||
|
end
|
||||||
|
|
||||||
|
def where_culling_not_prevented(query) do
|
||||||
|
where(query, [mi], mi.prevent_culling == false)
|
||||||
|
end
|
||||||
|
|
||||||
|
def where_not_culled(query) do
|
||||||
|
where(query, [mi], is_nil(mi.culled_at))
|
||||||
|
end
|
||||||
|
|
||||||
|
def where_media_not_redownloaded(query) do
|
||||||
|
where(query, [mi], is_nil(mi.media_redownloaded_at))
|
||||||
|
end
|
||||||
|
|
||||||
|
def with_id(query, id) do
|
||||||
|
where(query, [mi], mi.id == ^id)
|
||||||
|
end
|
||||||
|
|
||||||
|
def with_media_ids(query, media_ids) do
|
||||||
|
where(query, [mi], mi.media_id in ^media_ids)
|
||||||
|
end
|
||||||
|
|
||||||
|
def with_media_downloaded_at(query) do
|
||||||
|
where(query, [mi], not is_nil(mi.media_downloaded_at))
|
||||||
|
end
|
||||||
|
|
||||||
|
def with_media_filepath(query) do
|
||||||
|
where(query, [mi], not is_nil(mi.media_filepath))
|
||||||
|
end
|
||||||
|
|
||||||
|
def with_no_media_filepath(query) do
|
||||||
|
where(query, [mi], is_nil(mi.media_filepath))
|
||||||
|
end
|
||||||
|
|
||||||
|
def with_upload_date_after_source_cutoff(query) do
|
||||||
|
query
|
||||||
|
|> require_assoc(:source)
|
||||||
|
|> where([mi, source], is_nil(source.download_cutoff_date) or mi.upload_date >= source.download_cutoff_date)
|
||||||
|
end
|
||||||
|
|
||||||
|
def where_download_not_prevented(query) do
|
||||||
|
where(query, [mi], mi.prevent_download == false)
|
||||||
|
end
|
||||||
|
|
||||||
|
def matching_source_title_regex(query) do
|
||||||
|
query
|
||||||
|
|> require_assoc(:source)
|
||||||
|
|> where(
|
||||||
|
[mi, source],
|
||||||
|
is_nil(source.title_filter_regex) or fragment("regexp_like(?, ?)", mi.title, source.title_filter_regex)
|
||||||
|
)
|
||||||
|
end
|
||||||
|
|
||||||
|
def matching_search_term(query, nil), do: query
|
||||||
|
|
||||||
|
def matching_search_term(query, term) do
|
||||||
|
from(mi in query,
|
||||||
|
join: mi_search_index in assoc(mi, :media_items_search_index),
|
||||||
|
where: fragment("media_items_search_index MATCH ?", ^term),
|
||||||
|
select_merge: %{
|
||||||
|
matching_search_term:
|
||||||
|
fragment("""
|
||||||
|
coalesce(snippet(media_items_search_index, 0, '[PF_HIGHLIGHT]', '[/PF_HIGHLIGHT]', '...', 20), '') ||
|
||||||
|
' ' ||
|
||||||
|
coalesce(snippet(media_items_search_index, 1, '[PF_HIGHLIGHT]', '[/PF_HIGHLIGHT]', '...', 20), '')
|
||||||
|
""")
|
||||||
|
},
|
||||||
|
order_by: [desc: fragment("rank")]
|
||||||
|
)
|
||||||
|
end
|
||||||
|
|
||||||
|
def with_format_matching_profile_preference(query) do
|
||||||
|
query
|
||||||
|
|> require_assoc(:media_profile)
|
||||||
|
|> where(
|
||||||
|
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 where_pending_download(query) do
|
||||||
|
query
|
||||||
|
|> where_download_not_prevented()
|
||||||
|
|> with_no_media_filepath()
|
||||||
|
|> with_upload_date_after_source_cutoff()
|
||||||
|
|> with_format_matching_profile_preference()
|
||||||
|
|> matching_source_title_regex()
|
||||||
|
end
|
||||||
|
|
||||||
|
defp require_assoc(query, identifier) do
|
||||||
|
if has_named_binding?(query, identifier) do
|
||||||
|
query
|
||||||
|
else
|
||||||
|
do_require_assoc(query, identifier)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp do_require_assoc(query, :source) do
|
||||||
|
from(mi in query, join: s in assoc(mi, :source), as: :source)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp do_require_assoc(query, :media_profile) do
|
||||||
|
query
|
||||||
|
|> require_assoc(:source)
|
||||||
|
|> join(:inner, [mi, source], mp in assoc(source, :media_profile), as: :media_profile)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -9,6 +9,24 @@ defmodule Pinchflat.Metadata.MetadataFileHelpers do
|
|||||||
needed
|
needed
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
alias Pinchflat.Utils.FilesystemUtils
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Returns the directory where metadata for a database record should be stored.
|
||||||
|
|
||||||
|
Returns binary()
|
||||||
|
"""
|
||||||
|
def metadata_directory_for(database_record) do
|
||||||
|
metadata_directory = Application.get_env(:pinchflat, :metadata_directory)
|
||||||
|
record_table_name = database_record.__meta__.source
|
||||||
|
|
||||||
|
Path.join([
|
||||||
|
metadata_directory,
|
||||||
|
record_table_name,
|
||||||
|
to_string(database_record.id)
|
||||||
|
])
|
||||||
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Compresses and stores metadata for a media item, returning the filepath.
|
Compresses and stores metadata for a media item, returning the filepath.
|
||||||
|
|
||||||
@@ -18,8 +36,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)
|
||||||
|
|
||||||
File.mkdir_p!(Path.dirname(filepath))
|
:ok = FilesystemUtils.write_p!(filepath, json, [:compressed])
|
||||||
:ok = File.write(filepath, json, [:compressed])
|
|
||||||
|
|
||||||
filepath
|
filepath
|
||||||
end
|
end
|
||||||
@@ -37,20 +54,75 @@ defmodule Pinchflat.Metadata.MetadataFileHelpers do
|
|||||||
|
|
||||||
@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 jpg thumbnail available.
|
||||||
|
|
||||||
Returns binary()
|
Returns binary()
|
||||||
"""
|
"""
|
||||||
def download_and_store_thumbnail_for(database_record, metadata_map) do
|
def download_and_store_thumbnail_for(database_record, metadata_map) do
|
||||||
thumbnail_url = metadata_map["thumbnail"]
|
thumbnail_url =
|
||||||
|
metadata_map["thumbnails"]
|
||||||
|
|> Enum.filter(&(&1["preference"] && String.ends_with?(&1["url"], ".jpg")))
|
||||||
|
|> Enum.sort(&(&1["preference"] >= &2["preference"]))
|
||||||
|
|> List.first()
|
||||||
|
|> Map.get("url")
|
||||||
|
|
||||||
filepath = generate_filepath_for(database_record, Path.basename(thumbnail_url))
|
filepath = generate_filepath_for(database_record, Path.basename(thumbnail_url))
|
||||||
thumbnail_blob = fetch_thumbnail_from_url(thumbnail_url)
|
thumbnail_blob = fetch_thumbnail_from_url(thumbnail_url)
|
||||||
|
|
||||||
File.mkdir_p!(Path.dirname(filepath))
|
:ok = FilesystemUtils.write_p!(filepath, thumbnail_blob)
|
||||||
:ok = File.write(filepath, thumbnail_blob)
|
|
||||||
|
|
||||||
filepath
|
filepath
|
||||||
end
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Parses an upload date from the YYYYMMDD string returned in yt-dlp metadata
|
||||||
|
and returns a Date struct.
|
||||||
|
|
||||||
|
Returns Date.t()
|
||||||
|
"""
|
||||||
|
def parse_upload_date(upload_date) do
|
||||||
|
<<year::binary-size(4)>> <> <<month::binary-size(2)>> <> <<day::binary-size(2)>> = upload_date
|
||||||
|
|
||||||
|
Date.from_iso8601!("#{year}-#{month}-#{day}")
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Attempts to determine the series directory from a media filepath.
|
||||||
|
The series directory is the "root" directory for a given source
|
||||||
|
which should contain all the season-level folders of that source.
|
||||||
|
|
||||||
|
Used for determining where to store things like NFO data and banners
|
||||||
|
for media center apps. Not useful without a media center app.
|
||||||
|
|
||||||
|
Returns {:ok, binary()} | {:error, :indeterminable}
|
||||||
|
"""
|
||||||
|
def series_directory_from_media_filepath(media_filepath) do
|
||||||
|
# Matches "s" or "season" (case-insensitive)
|
||||||
|
# followed by an optional non-word character (. or _ or <space>, etc)
|
||||||
|
# followed by at least one digit
|
||||||
|
# followed immediately by the end of the string
|
||||||
|
# Example matches: s1, s.1, s01 season 1, Season.01, Season_1, Season 1, Season1
|
||||||
|
# Example non-matches: s01e01, season, series 1,
|
||||||
|
season_regex = ~r/^s(eason)?(\W|_)?\d{1,}$/i
|
||||||
|
|
||||||
|
{series_directory, found_series_directory} =
|
||||||
|
media_filepath
|
||||||
|
|> Path.split()
|
||||||
|
|> Enum.reduce_while({[], false}, fn part, {directory_acc, _} ->
|
||||||
|
if String.match?(part, season_regex) do
|
||||||
|
{:halt, {directory_acc, true}}
|
||||||
|
else
|
||||||
|
{:cont, {directory_acc ++ [part], false}}
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
|
||||||
|
if found_series_directory do
|
||||||
|
{:ok, Path.join(series_directory)}
|
||||||
|
else
|
||||||
|
{:error, :indeterminable}
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
defp fetch_thumbnail_from_url(url) do
|
defp fetch_thumbnail_from_url(url) do
|
||||||
http_client = Application.get_env(:pinchflat, :http_client, Pinchflat.HTTP.HTTPClient)
|
http_client = Application.get_env(:pinchflat, :http_client, Pinchflat.HTTP.HTTPClient)
|
||||||
{:ok, body} = http_client.get(url, [], body_format: :binary)
|
{:ok, body} = http_client.get(url, [], body_format: :binary)
|
||||||
@@ -59,13 +131,8 @@ defmodule Pinchflat.Metadata.MetadataFileHelpers do
|
|||||||
end
|
end
|
||||||
|
|
||||||
defp generate_filepath_for(database_record, filename) do
|
defp generate_filepath_for(database_record, filename) do
|
||||||
metadata_directory = Application.get_env(:pinchflat, :metadata_directory)
|
|
||||||
record_table_name = database_record.__meta__.source
|
|
||||||
|
|
||||||
Path.join([
|
Path.join([
|
||||||
metadata_directory,
|
metadata_directory_for(database_record),
|
||||||
record_table_name,
|
|
||||||
to_string(database_record.id),
|
|
||||||
filename
|
filename
|
||||||
])
|
])
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -30,7 +30,8 @@ defmodule Pinchflat.Metadata.MetadataParser do
|
|||||||
original_url: metadata["original_url"],
|
original_url: metadata["original_url"],
|
||||||
description: metadata["description"],
|
description: metadata["description"],
|
||||||
media_filepath: metadata["filepath"],
|
media_filepath: metadata["filepath"],
|
||||||
livestream: metadata["was_live"]
|
livestream: metadata["was_live"],
|
||||||
|
duration_seconds: metadata["duration"] && round(metadata["duration"])
|
||||||
}
|
}
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -54,14 +55,42 @@ defmodule Pinchflat.Metadata.MetadataParser do
|
|||||||
|> Enum.reverse()
|
|> Enum.reverse()
|
||||||
|> Enum.find_value(fn attrs -> attrs["filepath"] end)
|
|> Enum.find_value(fn attrs -> attrs["filepath"] end)
|
||||||
|
|
||||||
%{
|
if thumbnail_filepath do
|
||||||
thumbnail_filepath: thumbnail_filepath
|
# NOTE: whole ordeal needed due to a bug I found in yt-dlp
|
||||||
}
|
# https://github.com/yt-dlp/yt-dlp/issues/9445
|
||||||
|
# Can be reverted to remove this entire conditional once fixed
|
||||||
|
filepath =
|
||||||
|
thumbnail_filepath
|
||||||
|
|> String.split(~r{\.}, include_captures: true)
|
||||||
|
|> List.insert_at(-3, "-thumb")
|
||||||
|
|> Enum.join()
|
||||||
|
|
||||||
|
%{
|
||||||
|
thumbnail_filepath: filepath_if_exists(filepath)
|
||||||
|
}
|
||||||
|
else
|
||||||
|
%{
|
||||||
|
thumbnail_filepath: nil
|
||||||
|
}
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
defp parse_infojson_metadata(metadata) do
|
defp parse_infojson_metadata(metadata) do
|
||||||
%{
|
%{
|
||||||
metadata_filepath: metadata["infojson_filename"]
|
metadata_filepath: filepath_if_exists(metadata["infojson_filename"])
|
||||||
}
|
}
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# NOTE: this should not be needed, but it is due to a bug in yt-dlp.
|
||||||
|
# Can remove once this is resolved:
|
||||||
|
# https://github.com/yt-dlp/yt-dlp/issues/9445#issuecomment-2018724344
|
||||||
|
defp filepath_if_exists(nil), do: nil
|
||||||
|
|
||||||
|
defp filepath_if_exists(filepath) do
|
||||||
|
if File.exists?(filepath) do
|
||||||
|
filepath
|
||||||
|
else
|
||||||
|
nil
|
||||||
|
end
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -0,0 +1,70 @@
|
|||||||
|
defmodule Pinchflat.Metadata.NfoBuilder do
|
||||||
|
@moduledoc """
|
||||||
|
Provides methods for building and storing NFO files for
|
||||||
|
use by Kodi/Jellyfin and other media center software.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import Pinchflat.Utils.XmlUtils, only: [safe: 1]
|
||||||
|
|
||||||
|
alias Pinchflat.Metadata.MetadataFileHelpers
|
||||||
|
alias Pinchflat.Utils.FilesystemUtils
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Builds an NFO file for a media item (read: single "episode") and
|
||||||
|
stores it at the specified location.
|
||||||
|
|
||||||
|
Returns the filepath of the NFO file.
|
||||||
|
"""
|
||||||
|
def build_and_store_for_media_item(filepath, metadata) do
|
||||||
|
nfo = build_for_media_item(metadata)
|
||||||
|
|
||||||
|
FilesystemUtils.write_p!(filepath, nfo)
|
||||||
|
|
||||||
|
filepath
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Builds an NFO file for a souce and stores it at the specified location.
|
||||||
|
Technically works for playlists, but it's really made for channels.
|
||||||
|
|
||||||
|
Returns the filepath of the NFO file.
|
||||||
|
"""
|
||||||
|
def build_and_store_for_source(filepath, metadata) do
|
||||||
|
nfo = build_for_source(metadata)
|
||||||
|
|
||||||
|
FilesystemUtils.write_p!(filepath, nfo)
|
||||||
|
|
||||||
|
filepath
|
||||||
|
end
|
||||||
|
|
||||||
|
defp build_for_media_item(metadata) do
|
||||||
|
upload_date = MetadataFileHelpers.parse_upload_date(metadata["upload_date"])
|
||||||
|
# Cribbed from a combination of the Kodi wiki, ytdl-nfo, and ytdl-sub.
|
||||||
|
# WHO NEEDS A FANCY XML PARSER ANYWAY?!
|
||||||
|
"""
|
||||||
|
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
|
||||||
|
<episodedetails>
|
||||||
|
<title>#{safe(metadata["title"])}</title>
|
||||||
|
<showtitle>#{safe(metadata["uploader"])}</showtitle>
|
||||||
|
<uniqueid type="youtube" default="true">#{safe(metadata["id"])}</uniqueid>
|
||||||
|
<plot>#{safe(metadata["description"])}</plot>
|
||||||
|
<aired>#{safe(upload_date)}</aired>
|
||||||
|
<season>#{safe(upload_date.year)}</season>
|
||||||
|
<episode>#{Calendar.strftime(upload_date, "%m%d")}</episode>
|
||||||
|
<genre>YouTube</genre>
|
||||||
|
</episodedetails>
|
||||||
|
"""
|
||||||
|
end
|
||||||
|
|
||||||
|
defp build_for_source(metadata) do
|
||||||
|
"""
|
||||||
|
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
|
||||||
|
<tvshow>
|
||||||
|
<title>#{safe(metadata["title"])}</title>
|
||||||
|
<plot>#{safe(metadata["description"])}</plot>
|
||||||
|
<uniqueid type="youtube" default="true">#{safe(metadata["id"])}</uniqueid>
|
||||||
|
<genre>YouTube</genre>
|
||||||
|
</tvshow>
|
||||||
|
"""
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,69 @@
|
|||||||
|
defmodule Pinchflat.Metadata.SourceImageParser do
|
||||||
|
@moduledoc """
|
||||||
|
Functions for parsing and storing source images.
|
||||||
|
"""
|
||||||
|
alias Pinchflat.Utils.FilesystemUtils
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Given a base directory and source metadata, look for the appropriate images
|
||||||
|
and move them to the base directory. Returns a map of image types and their
|
||||||
|
filepaths (specifically for a source). If a given image type is not found,
|
||||||
|
the key will not be present in the map.
|
||||||
|
|
||||||
|
The metadata is expected to contain the `filepath` key for images, implying
|
||||||
|
that the images have already been downloaded by yt-dlp. This method will NOT
|
||||||
|
download images from the internet - it just copys them around.
|
||||||
|
|
||||||
|
Returns a map with the possible keys :poster_filepath, :fanart_filepath, and
|
||||||
|
:banner_filepath.
|
||||||
|
"""
|
||||||
|
def store_source_images(base_directory, source_metadata) do
|
||||||
|
(source_metadata["thumbnails"] || [])
|
||||||
|
|> Enum.filter(&(&1["filepath"] != nil))
|
||||||
|
|> select_useful_images()
|
||||||
|
|> Enum.map(&move_image(&1, base_directory))
|
||||||
|
|> Enum.into(%{})
|
||||||
|
end
|
||||||
|
|
||||||
|
defp select_useful_images(images) do
|
||||||
|
labelled_images =
|
||||||
|
Enum.reduce(images, [], fn image_map, acc ->
|
||||||
|
case image_map do
|
||||||
|
%{"id" => "avatar_uncropped"} ->
|
||||||
|
acc ++ [{:poster, :poster_filepath, image_map["filepath"]}]
|
||||||
|
|
||||||
|
%{"id" => "banner_uncropped"} ->
|
||||||
|
acc ++ [{:fanart, :fanart_filepath, image_map["filepath"]}]
|
||||||
|
|
||||||
|
_ ->
|
||||||
|
acc
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
|
||||||
|
labelled_images
|
||||||
|
|> Enum.concat([{:banner, :banner_filepath, determine_best_banner(images)}])
|
||||||
|
|> Enum.filter(fn {_, _, tmp_filepath} -> tmp_filepath end)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp determine_best_banner(images) do
|
||||||
|
best_candidate =
|
||||||
|
images
|
||||||
|
# Filter out images that don't have a width and height attribute
|
||||||
|
|> Enum.filter(&(&1["width"] && &1["height"]))
|
||||||
|
# Sort images with the highest width first
|
||||||
|
|> Enum.sort(&(&1["width"] >= &2["width"]))
|
||||||
|
# Find the first image where the ratio of width to height is greater than 3
|
||||||
|
|> Enum.find(&(&1["width"] / &1["height"] > 3))
|
||||||
|
|
||||||
|
Map.get(best_candidate || %{}, "filepath")
|
||||||
|
end
|
||||||
|
|
||||||
|
defp move_image({filename, source_attr_name, tmp_filepath}, base_directory) do
|
||||||
|
extension = Path.extname(tmp_filepath)
|
||||||
|
final_filepath = Path.join([base_directory, "#{filename}#{extension}"])
|
||||||
|
|
||||||
|
FilesystemUtils.cp_p!(tmp_filepath, final_filepath)
|
||||||
|
|
||||||
|
{source_attr_name, final_filepath}
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,50 @@
|
|||||||
|
defmodule Pinchflat.Metadata.SourceMetadata do
|
||||||
|
@moduledoc """
|
||||||
|
The SourceMetadata schema.
|
||||||
|
|
||||||
|
Look. Don't @ me about Metadata vs. Metadatum. I'm very sensitive.
|
||||||
|
"""
|
||||||
|
|
||||||
|
use Ecto.Schema
|
||||||
|
import Ecto.Changeset
|
||||||
|
|
||||||
|
alias Pinchflat.Sources.Source
|
||||||
|
|
||||||
|
@allowed_fields ~w(
|
||||||
|
metadata_filepath
|
||||||
|
fanart_filepath
|
||||||
|
poster_filepath
|
||||||
|
banner_filepath
|
||||||
|
)a
|
||||||
|
|
||||||
|
@required_fields ~w(metadata_filepath)a
|
||||||
|
|
||||||
|
schema "source_metadata" do
|
||||||
|
field :metadata_filepath, :string
|
||||||
|
field :fanart_filepath, :string
|
||||||
|
field :poster_filepath, :string
|
||||||
|
field :banner_filepath, :string
|
||||||
|
|
||||||
|
belongs_to :source, Source
|
||||||
|
|
||||||
|
timestamps(type: :utc_datetime)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc false
|
||||||
|
def changeset(source_metadata, attrs) do
|
||||||
|
source_metadata
|
||||||
|
|> cast(attrs, @allowed_fields)
|
||||||
|
|> validate_required(@required_fields)
|
||||||
|
|> unique_constraint([:source_id])
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc false
|
||||||
|
def filepath_attributes do
|
||||||
|
~w(
|
||||||
|
metadata_filepath
|
||||||
|
fanart_filepath
|
||||||
|
poster_filepath
|
||||||
|
banner_filepath
|
||||||
|
)a
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,116 @@
|
|||||||
|
defmodule Pinchflat.Metadata.SourceMetadataStorageWorker do
|
||||||
|
@moduledoc false
|
||||||
|
|
||||||
|
use Oban.Worker,
|
||||||
|
queue: :remote_metadata,
|
||||||
|
tags: ["media_source", "source_metadata", "remote_metadata"],
|
||||||
|
max_attempts: 3
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias __MODULE__
|
||||||
|
alias Pinchflat.Repo
|
||||||
|
alias Pinchflat.Tasks
|
||||||
|
alias Pinchflat.Sources
|
||||||
|
alias Pinchflat.Utils.StringUtils
|
||||||
|
alias Pinchflat.Metadata.NfoBuilder
|
||||||
|
alias Pinchflat.YtDlp.MediaCollection
|
||||||
|
alias Pinchflat.Metadata.SourceImageParser
|
||||||
|
alias Pinchflat.Metadata.MetadataFileHelpers
|
||||||
|
alias Pinchflat.Downloading.DownloadOptionBuilder
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Starts the source metadata storage worker and creates a task for the source.
|
||||||
|
|
||||||
|
Returns {:ok, %Task{}} | {:error, :duplicate_job} | {:error, %Ecto.Changeset{}}
|
||||||
|
"""
|
||||||
|
def kickoff_with_task(source, opts \\ []) do
|
||||||
|
%{id: source.id}
|
||||||
|
|> SourceMetadataStorageWorker.new(opts)
|
||||||
|
|> Tasks.create_job_with_task(source)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Fetches and stores various forms of metadata for a source:
|
||||||
|
- Attributes like `description`
|
||||||
|
- JSON metadata for internal use
|
||||||
|
- The series directory for the source
|
||||||
|
- The NFO file for the source (if specified)
|
||||||
|
- Downloads and stores source images (if specified)
|
||||||
|
|
||||||
|
The worker is kicked off after a source is inserted or it's original_url
|
||||||
|
is updated - this can take an unknown amount of time so don't rely on this
|
||||||
|
data being here before, say, the first indexing or downloading task is complete.
|
||||||
|
|
||||||
|
Returns :ok
|
||||||
|
"""
|
||||||
|
@impl Oban.Worker
|
||||||
|
def perform(%Oban.Job{args: %{"id" => source_id}}) do
|
||||||
|
source = Repo.preload(Sources.get_source!(source_id), [:metadata, :media_profile])
|
||||||
|
series_directory = determine_series_directory(source)
|
||||||
|
|
||||||
|
{source_metadata, source_image_attrs, metadata_image_attrs} =
|
||||||
|
fetch_source_metadata_and_images(series_directory, source)
|
||||||
|
|
||||||
|
source_metadata_filepath = MetadataFileHelpers.compress_and_store_metadata_for(source, source_metadata)
|
||||||
|
|
||||||
|
Sources.update_source(
|
||||||
|
source,
|
||||||
|
Map.merge(
|
||||||
|
%{
|
||||||
|
series_directory: series_directory,
|
||||||
|
nfo_filepath: store_source_nfo(source, series_directory, source_metadata),
|
||||||
|
description: source_metadata["description"],
|
||||||
|
metadata: Map.merge(%{metadata_filepath: source_metadata_filepath}, metadata_image_attrs)
|
||||||
|
},
|
||||||
|
source_image_attrs
|
||||||
|
),
|
||||||
|
# `run_post_commit_tasks: false` prevents this from running in an infinite loop
|
||||||
|
run_post_commit_tasks: false
|
||||||
|
)
|
||||||
|
|
||||||
|
:ok
|
||||||
|
rescue
|
||||||
|
Ecto.NoResultsError -> Logger.info("#{__MODULE__} discarded: source #{source_id} not found")
|
||||||
|
Ecto.StaleEntryError -> Logger.info("#{__MODULE__} discarded: source #{source_id} stale")
|
||||||
|
end
|
||||||
|
|
||||||
|
defp fetch_source_metadata_and_images(series_directory, source) do
|
||||||
|
metadata_directory = MetadataFileHelpers.metadata_directory_for(source)
|
||||||
|
tmp_output_path = "#{tmp_directory()}/#{StringUtils.random_string(16)}/source_image.%(ext)S"
|
||||||
|
opts = [:write_all_thumbnails, convert_thumbnails: "jpg", output: tmp_output_path]
|
||||||
|
|
||||||
|
{:ok, metadata} = MediaCollection.get_source_metadata(source.original_url, opts)
|
||||||
|
metadata_image_attrs = SourceImageParser.store_source_images(metadata_directory, metadata)
|
||||||
|
|
||||||
|
if source.media_profile.download_source_images && series_directory do
|
||||||
|
source_image_attrs = SourceImageParser.store_source_images(series_directory, metadata)
|
||||||
|
|
||||||
|
{metadata, source_image_attrs, metadata_image_attrs}
|
||||||
|
else
|
||||||
|
{metadata, %{}, metadata_image_attrs}
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp determine_series_directory(source) do
|
||||||
|
output_path = DownloadOptionBuilder.build_output_path_for(source)
|
||||||
|
{:ok, %{filepath: filepath}} = MediaCollection.get_source_details(source.original_url, output: output_path)
|
||||||
|
|
||||||
|
case MetadataFileHelpers.series_directory_from_media_filepath(filepath) do
|
||||||
|
{:ok, series_directory} -> series_directory
|
||||||
|
{:error, _} -> nil
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp store_source_nfo(source, series_directory, metadata) do
|
||||||
|
if source.media_profile.download_nfo && series_directory do
|
||||||
|
nfo_filepath = Path.join(series_directory, "tvshow.nfo")
|
||||||
|
|
||||||
|
NfoBuilder.build_and_store_for_source(nfo_filepath, metadata)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp tmp_directory do
|
||||||
|
Application.get_env(:pinchflat, :tmpfile_directory)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
defmodule Pinchflat.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,64 @@
|
|||||||
|
defmodule Pinchflat.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.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, return_code} = CliUtils.wrap_cmd(backend_executable(), parsed_opts ++ endpoints)
|
||||||
|
Logger.info("[apprise] response: #{output}")
|
||||||
|
|
||||||
|
case return_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,77 @@
|
|||||||
|
defmodule Pinchflat.Notifications.SourceNotifications do
|
||||||
|
@moduledoc """
|
||||||
|
Contains utilities for sending notifications about sources
|
||||||
|
"""
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias Pinchflat.Repo
|
||||||
|
alias Pinchflat.Media.MediaQuery
|
||||||
|
|
||||||
|
@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
|
||||||
|
pending_media_item_count(source) + downloaded_media_item_count(source)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp pending_media_item_count(source) do
|
||||||
|
MediaQuery.new()
|
||||||
|
|> MediaQuery.for_source(source)
|
||||||
|
|> MediaQuery.where_pending_download()
|
||||||
|
|> Repo.aggregate(:count)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp downloaded_media_item_count(source) do
|
||||||
|
MediaQuery.new()
|
||||||
|
|> MediaQuery.for_source(source)
|
||||||
|
|> MediaQuery.with_media_filepath()
|
||||||
|
|> 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,78 @@
|
|||||||
|
defmodule Pinchflat.Podcasts.PodcastHelpers do
|
||||||
|
@moduledoc """
|
||||||
|
Methods for fetching postcast-related data from a source
|
||||||
|
or its media items
|
||||||
|
"""
|
||||||
|
|
||||||
|
alias Pinchflat.Repo
|
||||||
|
alias Pinchflat.Media.MediaQuery
|
||||||
|
alias Pinchflat.Metadata.MediaMetadata
|
||||||
|
alias Pinchflat.Metadata.SourceMetadata
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Returns a list of media items that have been downloaded to disk
|
||||||
|
and have been proven to still exist there.
|
||||||
|
|
||||||
|
Useful for podcasts since we don't want to serve media that
|
||||||
|
has been deleted or moved, but it's also fairly generally useful
|
||||||
|
so I could see this being moved in the future.
|
||||||
|
|
||||||
|
Options:
|
||||||
|
- limit: integer - the maximum number of media items to return
|
||||||
|
|
||||||
|
Returns: [%MediaItem{}]
|
||||||
|
"""
|
||||||
|
def persisted_media_items_for(source, opts \\ []) do
|
||||||
|
limit = Keyword.get(opts, :limit, 500)
|
||||||
|
|
||||||
|
MediaQuery.new()
|
||||||
|
|> MediaQuery.for_source(source)
|
||||||
|
|> MediaQuery.with_media_filepath()
|
||||||
|
|> Repo.maybe_limit(limit)
|
||||||
|
|> Repo.all()
|
||||||
|
|> Enum.filter(fn media_item -> File.exists?(media_item.media_filepath) end)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Selects a cover image for a source based on the source's metadata
|
||||||
|
and the metadata of the media items associated with the source. Also
|
||||||
|
ensures images exist on disk.
|
||||||
|
|
||||||
|
Only one media item should need to be returned since this is using the
|
||||||
|
internal metadata which, so long as the media_item was _downloaded_, should
|
||||||
|
be guaranteed to exist.
|
||||||
|
|
||||||
|
Prefers the source's poster, then fanart, then the media item's thumbnail.
|
||||||
|
|
||||||
|
Returns: {:ok, filepath} | {:error, :no_suitable_image}
|
||||||
|
"""
|
||||||
|
def select_cover_image(source, media_items) do
|
||||||
|
source_with_preloads = Repo.preload(source, :metadata)
|
||||||
|
|
||||||
|
source_with_preloads
|
||||||
|
|> get_images_by_preference(media_items)
|
||||||
|
|> Enum.reject(&is_nil(&1))
|
||||||
|
|> Enum.find(&File.exists?/1)
|
||||||
|
|> case do
|
||||||
|
nil -> {:error, :no_suitable_image}
|
||||||
|
filepath -> {:ok, filepath}
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp get_images_by_preference(source_with_preloads, []) do
|
||||||
|
source_metadata = source_with_preloads.metadata || %SourceMetadata{}
|
||||||
|
|
||||||
|
[
|
||||||
|
source_metadata.poster_filepath,
|
||||||
|
source_metadata.fanart_filepath
|
||||||
|
]
|
||||||
|
end
|
||||||
|
|
||||||
|
defp get_images_by_preference(source_with_preloads, [media_item | _]) do
|
||||||
|
media_item_with_preloads = Repo.preload(media_item, :metadata)
|
||||||
|
media_item_metadata = media_item_with_preloads.metadata || %MediaMetadata{}
|
||||||
|
source_images = get_images_by_preference(source_with_preloads, [])
|
||||||
|
|
||||||
|
source_images ++ [media_item_metadata.thumbnail_filepath]
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,133 @@
|
|||||||
|
defmodule Pinchflat.Podcasts.RssFeedBuilder do
|
||||||
|
@moduledoc """
|
||||||
|
Methods for building an RSS feed for a source and its media items.
|
||||||
|
"""
|
||||||
|
|
||||||
|
@datetime_format "%a, %d %b %Y %H:%M:%S %z"
|
||||||
|
|
||||||
|
import Pinchflat.Utils.XmlUtils, only: [safe: 1]
|
||||||
|
|
||||||
|
alias Pinchflat.Utils.DatetimeUtils
|
||||||
|
alias Pinchflat.Podcasts.PodcastHelpers
|
||||||
|
alias PinchflatWeb.Router.Helpers, as: Routes
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Builds an RSS feed for a given source and its media items.
|
||||||
|
Only MediaItems that have been persisted will be included in the feed.
|
||||||
|
|
||||||
|
## Options:
|
||||||
|
- `:limit` - The maximum number of media items to include in the feed. Defaults to 300.
|
||||||
|
|
||||||
|
Returns an XML document as a string.
|
||||||
|
"""
|
||||||
|
def build(source, opts \\ []) do
|
||||||
|
limit = Keyword.get(opts, :limit, 300)
|
||||||
|
url_base = Keyword.get(opts, :url_base, PinchflatWeb.Endpoint.url())
|
||||||
|
|
||||||
|
media_items = PodcastHelpers.persisted_media_items_for(source, limit: limit)
|
||||||
|
build_source_xml(source, media_items, url_base)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp build_source_xml(source, media_items, url_base) do
|
||||||
|
media_item_xml = Enum.map(media_items, &build_media_item_xml(source, &1, url_base))
|
||||||
|
# "caching" the image path since it requires some DB calls and is used twice
|
||||||
|
feed_image_path = feed_image_path(url_base, source, media_items)
|
||||||
|
|
||||||
|
# Useful: resources:
|
||||||
|
# - https://validator.w3.org/feed/#validate_by_input
|
||||||
|
# - https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md
|
||||||
|
# - https://podba.se/validate
|
||||||
|
"""
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<rss version="2.0"
|
||||||
|
xmlns:itunes="http://www.itunes.com/dtds/podcast-1.0.dtd"
|
||||||
|
xmlns:podcast="https://podcastindex.org/namespace/1.0"
|
||||||
|
xmlns:atom="http://www.w3.org/2005/Atom">
|
||||||
|
<channel>
|
||||||
|
<title>#{safe(source.custom_name)}</title>
|
||||||
|
<link>#{safe(source.original_url)}</link>
|
||||||
|
<description>#{safe(source.description)}</description>
|
||||||
|
<category>TV & Film</category>
|
||||||
|
<generator>Generated by Pinchflat</generator>
|
||||||
|
<language>en-us</language>
|
||||||
|
<lastBuildDate>#{Calendar.strftime(source.updated_at, @datetime_format)}</lastBuildDate>
|
||||||
|
<pubDate>#{Calendar.strftime(source.inserted_at, @datetime_format)}</pubDate>
|
||||||
|
<atom:link href="#{safe(generate_self_link(url_base, source))}" rel="self" type="application/rss+xml" />
|
||||||
|
<podcast:locked>yes</podcast:locked>
|
||||||
|
<podcast:guid>#{source.uuid}</podcast:guid>
|
||||||
|
<image>
|
||||||
|
<url>#{safe(feed_image_path)}</url>
|
||||||
|
<title>#{safe(source.custom_name)}</title>
|
||||||
|
<link>#{safe(source.original_url)}</link>
|
||||||
|
</image>
|
||||||
|
<itunes:author>#{safe(source.custom_name)}</itunes:author>
|
||||||
|
<itunes:subtitle>#{safe(source.custom_name)}</itunes:subtitle>
|
||||||
|
<itunes:block>yes</itunes:block>
|
||||||
|
<itunes:image href="#{safe(feed_image_path)}"></itunes:image>
|
||||||
|
<itunes:explicit>false</itunes:explicit>
|
||||||
|
<itunes:category text="TV & Film"></itunes:category>
|
||||||
|
|
||||||
|
#{Enum.join(media_item_xml, "\n")}
|
||||||
|
|
||||||
|
</channel>
|
||||||
|
</rss>
|
||||||
|
"""
|
||||||
|
end
|
||||||
|
|
||||||
|
defp build_media_item_xml(source, media_item, url_base) do
|
||||||
|
"""
|
||||||
|
<item>
|
||||||
|
<guid isPermaLink="false">#{media_item.uuid}</guid>
|
||||||
|
<title>#{safe(media_item.title)}</title>
|
||||||
|
<link>#{safe(media_item.original_url)}</link>
|
||||||
|
<description>#{safe(media_item.description)}</description>
|
||||||
|
<pubDate>#{generate_upload_date(media_item)}</pubDate>
|
||||||
|
<itunes:duration>#{media_item.duration_seconds}</itunes:duration>
|
||||||
|
<enclosure
|
||||||
|
url="#{media_stream_path(url_base, media_item)}"
|
||||||
|
length="#{media_item.media_size_bytes}"
|
||||||
|
type="#{MIME.from_path(media_item.media_filepath)}"
|
||||||
|
/>
|
||||||
|
<itunes:author>#{safe(source.custom_name)}</itunes:author>
|
||||||
|
<itunes:subtitle>#{safe(media_item.title)}</itunes:subtitle>
|
||||||
|
<itunes:summary><![CDATA[#{media_item.description}]]></itunes:summary>
|
||||||
|
<itunes:explicit>false</itunes:explicit>
|
||||||
|
</item>
|
||||||
|
"""
|
||||||
|
end
|
||||||
|
|
||||||
|
defp generate_self_link(url_base, source) do
|
||||||
|
Path.join(url_base, "#{podcast_route(:rss_feed, source.uuid)}.xml")
|
||||||
|
end
|
||||||
|
|
||||||
|
defp media_stream_path(url_base, media_item) do
|
||||||
|
extension = Path.extname(media_item.media_filepath)
|
||||||
|
|
||||||
|
Path.join(url_base, "#{media_route(:stream, media_item.uuid)}#{extension}")
|
||||||
|
end
|
||||||
|
|
||||||
|
defp feed_image_path(url_base, source, media_items) do
|
||||||
|
case PodcastHelpers.select_cover_image(source, media_items) do
|
||||||
|
{:error, _} ->
|
||||||
|
""
|
||||||
|
|
||||||
|
{:ok, filepath} ->
|
||||||
|
extension = Path.extname(filepath)
|
||||||
|
Path.join(url_base, "#{podcast_route(:feed_image, source.uuid)}#{extension}")
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp generate_upload_date(media_item) do
|
||||||
|
media_item.upload_date
|
||||||
|
|> DatetimeUtils.date_to_datetime()
|
||||||
|
|> Calendar.strftime(@datetime_format)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp podcast_route(action, params) do
|
||||||
|
Routes.podcast_path(PinchflatWeb.Endpoint, action, params)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp media_route(action, params) do
|
||||||
|
Routes.media_item_path(PinchflatWeb.Endpoint, action, params)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -17,32 +17,42 @@ defmodule Pinchflat.Profiles.MediaProfile do
|
|||||||
sub_langs
|
sub_langs
|
||||||
download_thumbnail
|
download_thumbnail
|
||||||
embed_thumbnail
|
embed_thumbnail
|
||||||
|
download_source_images
|
||||||
download_metadata
|
download_metadata
|
||||||
embed_metadata
|
embed_metadata
|
||||||
|
download_nfo
|
||||||
|
sponsorblock_behaviour
|
||||||
|
sponsorblock_categories
|
||||||
shorts_behaviour
|
shorts_behaviour
|
||||||
livestream_behaviour
|
livestream_behaviour
|
||||||
preferred_resolution
|
preferred_resolution
|
||||||
|
redownload_delay_days
|
||||||
)a
|
)a
|
||||||
|
|
||||||
@required_fields ~w(name output_path_template)a
|
@required_fields ~w(name output_path_template)a
|
||||||
|
|
||||||
schema "media_profiles" do
|
schema "media_profiles" do
|
||||||
field :name, :string
|
field :name, :string
|
||||||
|
field :redownload_delay_days, :integer
|
||||||
|
|
||||||
field :output_path_template, :string,
|
field :output_path_template, :string,
|
||||||
default: "/{{ source_custom_name }}/{{ upload_yyyy_mm_dd }} {{ title }}/{{ title }} [{{ id }}].{{ ext }}"
|
default: "/{{ source_custom_name }}/{{ upload_yyyy_mm_dd }} {{ title }}/{{ title }} [{{ id }}].{{ ext }}"
|
||||||
|
|
||||||
field :download_subs, :boolean, default: true
|
field :download_subs, :boolean, default: false
|
||||||
field :download_auto_subs, :boolean, default: true
|
field :download_auto_subs, :boolean, default: false
|
||||||
field :embed_subs, :boolean, default: true
|
field :embed_subs, :boolean, default: false
|
||||||
field :sub_langs, :string, default: "en"
|
field :sub_langs, :string, default: "en"
|
||||||
|
|
||||||
field :download_thumbnail, :boolean, default: true
|
field :download_thumbnail, :boolean, default: false
|
||||||
field :embed_thumbnail, :boolean, default: true
|
field :embed_thumbnail, :boolean, default: false
|
||||||
|
field :download_source_images, :boolean, default: false
|
||||||
|
|
||||||
field :download_metadata, :boolean, default: true
|
field :download_metadata, :boolean, default: false
|
||||||
field :embed_metadata, :boolean, default: true
|
field :embed_metadata, :boolean, default: false
|
||||||
|
|
||||||
|
field :download_nfo, :boolean, default: false
|
||||||
|
field :sponsorblock_behaviour, Ecto.Enum, values: [:disabled, :remove], default: :disabled
|
||||||
|
field :sponsorblock_categories, {:array, :string}, default: []
|
||||||
# NOTE: these do NOT speed up indexing - the indexer still has to go
|
# NOTE: these do NOT speed up indexing - the indexer still has to go
|
||||||
# through the entire collection to determine if a media is a short or
|
# through the entire collection to determine if a media is a short or
|
||||||
# a livestream.
|
# a livestream.
|
||||||
@@ -52,7 +62,6 @@ 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(2160p 1080p 720p 480p 360p audio)a, default: :"1080p"
|
field :preferred_resolution, Ecto.Enum, values: ~w(2160p 1080p 720p 480p 360p audio)a, default: :"1080p"
|
||||||
|
|
||||||
has_many :sources, Source
|
has_many :sources, Source
|
||||||
@@ -65,6 +74,14 @@ defmodule Pinchflat.Profiles.MediaProfile do
|
|||||||
media_profile
|
media_profile
|
||||||
|> cast(attrs, @allowed_fields)
|
|> cast(attrs, @allowed_fields)
|
||||||
|> validate_required(@required_fields)
|
|> validate_required(@required_fields)
|
||||||
|
# Ensures it ends with `.{{ ext }}` or `.%(ext)s` or similar (with a little wiggle room)
|
||||||
|
|> validate_format(:output_path_template, ext_regex(), message: "must end with .{{ ext }}")
|
||||||
|
|> validate_number(:redownload_delay_days, greater_than_or_equal_to: 0)
|
||||||
|> unique_constraint(:name)
|
|> unique_constraint(:name)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
@doc false
|
||||||
|
def ext_regex do
|
||||||
|
~r/\.({{ ?ext ?}}|%\( ?ext ?\)[sS])$/
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -5,6 +5,10 @@ defmodule Pinchflat.Release do
|
|||||||
"""
|
"""
|
||||||
@app :pinchflat
|
@app :pinchflat
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias Pinchflat.Utils.FilesystemUtils
|
||||||
|
|
||||||
def migrate do
|
def migrate do
|
||||||
load_app()
|
load_app()
|
||||||
|
|
||||||
@@ -18,6 +22,38 @@ defmodule Pinchflat.Release do
|
|||||||
{:ok, _, _} = Ecto.Migrator.with_repo(repo, &Ecto.Migrator.run(&1, :down, to: version))
|
{:ok, _, _} = Ecto.Migrator.with_repo(repo, &Ecto.Migrator.run(&1, :down, to: version))
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def check_file_permissions do
|
||||||
|
load_app()
|
||||||
|
|
||||||
|
directories =
|
||||||
|
Enum.uniq([
|
||||||
|
"/config",
|
||||||
|
"/downloads",
|
||||||
|
Application.get_env(:pinchflat, :media_directory),
|
||||||
|
Application.get_env(:pinchflat, :tmpfile_directory),
|
||||||
|
Application.get_env(:pinchflat, :extras_directory),
|
||||||
|
Application.get_env(:pinchflat, :metadata_directory)
|
||||||
|
])
|
||||||
|
|
||||||
|
Enum.each(directories, fn dir ->
|
||||||
|
Logger.info("Checking permissions for #{dir}")
|
||||||
|
filepath = Path.join([dir, ".keep"])
|
||||||
|
|
||||||
|
case FilesystemUtils.write_p(filepath, "") do
|
||||||
|
:ok ->
|
||||||
|
Logger.info("Permissions OK")
|
||||||
|
|
||||||
|
{:error, :eacces} ->
|
||||||
|
Logger.error(permission_denied_screed(dir))
|
||||||
|
raise "Permission denied"
|
||||||
|
|
||||||
|
err ->
|
||||||
|
Logger.error("Permissions check failed: #{inspect(err)}")
|
||||||
|
raise "Unknown error"
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
end
|
||||||
|
|
||||||
defp repos do
|
defp repos do
|
||||||
Application.fetch_env!(@app, :ecto_repos)
|
Application.fetch_env!(@app, :ecto_repos)
|
||||||
end
|
end
|
||||||
@@ -25,4 +61,31 @@ defmodule Pinchflat.Release do
|
|||||||
defp load_app do
|
defp load_app do
|
||||||
Application.load(@app)
|
Application.load(@app)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
defp permission_denied_screed(dir) do
|
||||||
|
"""
|
||||||
|
The directory "#{dir}" is not writeable by the Docker container.
|
||||||
|
|
||||||
|
Please ensure that the directory exists and is writeable by the Docker
|
||||||
|
container. All setups are different, but you may be able to run something
|
||||||
|
like this on the *host*:
|
||||||
|
|
||||||
|
chown nobody -R <host path that maps to #{dir}>
|
||||||
|
chmod 755 -R <host path that maps to #{dir}>
|
||||||
|
|
||||||
|
Swapping in your real host path. Then, you should set the user running
|
||||||
|
this container by editing your `docker run` command like so:
|
||||||
|
|
||||||
|
docker run --user 99:100 <rest of the command>
|
||||||
|
|
||||||
|
Or adding `user: '99:100'` to the Pinchflat service of your Docker Compose
|
||||||
|
file. Again, there are many ways to do this depending on your setup and
|
||||||
|
this is just one example. See issue #106 in the Pinchflat Github for more.
|
||||||
|
|
||||||
|
No matter the case, this _is_ a permissions error and allowing the container
|
||||||
|
to write to the directory is the only way to fix it. It is not recommended
|
||||||
|
to run the container as `root` because files created by Pinchflat may not
|
||||||
|
be accessible to other apps that want to modify them.
|
||||||
|
"""
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,24 +1,36 @@
|
|||||||
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
|
||||||
|
]
|
||||||
|
|
||||||
timestamps(type: :utc_datetime)
|
@required_fields ~w(
|
||||||
|
onboarding
|
||||||
|
pro_enabled
|
||||||
|
)a
|
||||||
|
|
||||||
|
schema "settings" do
|
||||||
|
field :onboarding, :boolean, default: true
|
||||||
|
field :pro_enabled, :boolean, default: false
|
||||||
|
field :yt_dlp_version, :string
|
||||||
|
field :apprise_version, :string
|
||||||
|
field :apprise_server, :string
|
||||||
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
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Attempts to find a setting by name or creates a setting with value
|
|
||||||
if one doesn't exist, returning the parsed value. Optionally allows
|
|
||||||
specifying the datatype.
|
|
||||||
|
|
||||||
Returns value in type of `Ecto.Enum.mappings(Setting, :datatype)`
|
|
||||||
"""
|
|
||||||
def fetch!(name, value) do
|
|
||||||
fetch!(name, value, infer_datatype(value))
|
|
||||||
end
|
|
||||||
|
|
||||||
def fetch!(name, value, datatype) do
|
|
||||||
case Repo.get_by(Setting, name: to_string(name)) do
|
|
||||||
nil -> create_setting!(name, value, datatype)
|
|
||||||
setting -> read_setting(setting)
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
defp change_setting(setting, attrs) do
|
@doc """
|
||||||
|
Returns `%Ecto.Changeset{}`
|
||||||
|
"""
|
||||||
|
def change_setting(%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
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ defmodule Pinchflat.SlowIndexing.FileFollowerServer do
|
|||||||
require Logger
|
require Logger
|
||||||
|
|
||||||
@poll_interval_ms Application.compile_env(:pinchflat, :file_watcher_poll_interval)
|
@poll_interval_ms Application.compile_env(:pinchflat, :file_watcher_poll_interval)
|
||||||
@activity_timeout_ms 60_000
|
@activity_timeout_ms 600_000
|
||||||
|
|
||||||
# Client API
|
# Client API
|
||||||
@doc """
|
@doc """
|
||||||
|
|||||||
@@ -6,20 +6,35 @@ defmodule Pinchflat.SlowIndexing.MediaCollectionIndexingWorker do
|
|||||||
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"]
|
||||||
|
|
||||||
|
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.Notifications.SourceNotifications
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Starts the source slow indexing worker and creates a task for the source.
|
||||||
|
|
||||||
|
Returns {:ok, %Task{}} | {:error, :duplicate_job} | {:error, %Ecto.Changeset{}}
|
||||||
|
"""
|
||||||
|
def kickoff_with_task(source, job_args \\ %{}, job_opts \\ []) do
|
||||||
|
%{id: source.id}
|
||||||
|
|> Map.merge(job_args)
|
||||||
|
|> MediaCollectionIndexingWorker.new(job_opts)
|
||||||
|
|> Tasks.create_job_with_task(source)
|
||||||
|
end
|
||||||
|
|
||||||
@impl Oban.Worker
|
|
||||||
@doc """
|
@doc """
|
||||||
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_.
|
||||||
@@ -46,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
|
||||||
@@ -58,27 +72,43 @@ defmodule Pinchflat.SlowIndexing.MediaCollectionIndexingWorker do
|
|||||||
|
|
||||||
Returns :ok | {:ok, %Task{}}
|
Returns :ok | {:ok, %Task{}}
|
||||||
"""
|
"""
|
||||||
def perform(%Oban.Job{args: %{"id" => source_id}}) do
|
@impl Oban.Worker
|
||||||
|
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
|
||||||
|
Ecto.NoResultsError -> Logger.info("#{__MODULE__} discarded: source #{source_id} not found")
|
||||||
|
Ecto.StaleEntryError -> Logger.info("#{__MODULE__} discarded: source #{source_id} stale")
|
||||||
|
end
|
||||||
|
|
||||||
|
defp perform_indexing_and_notification(source) do
|
||||||
|
apprise_server = Settings.get!(:apprise_server)
|
||||||
|
|
||||||
|
SourceNotifications.wrap_new_media_notification(apprise_server, source, fn ->
|
||||||
|
SlowIndexingHelpers.index_and_enqueue_download_for_media_items(source)
|
||||||
|
end)
|
||||||
end
|
end
|
||||||
|
|
||||||
defp reschedule_indexing(source) do
|
defp reschedule_indexing(source) do
|
||||||
|
|||||||
@@ -7,6 +7,7 @@ defmodule Pinchflat.SlowIndexing.SlowIndexingHelpers do
|
|||||||
|
|
||||||
require Logger
|
require Logger
|
||||||
|
|
||||||
|
alias Pinchflat.Repo
|
||||||
alias Pinchflat.Media
|
alias Pinchflat.Media
|
||||||
alias Pinchflat.Tasks
|
alias Pinchflat.Tasks
|
||||||
alias Pinchflat.Sources
|
alias Pinchflat.Sources
|
||||||
@@ -15,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
|
||||||
@@ -26,21 +26,18 @@ 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")
|
Tasks.delete_pending_tasks_for(source, "MediaCollectionIndexingWorker")
|
||||||
|
|
||||||
%{id: source.id}
|
MediaCollectionIndexingWorker.kickoff_with_task(source, job_args, job_opts)
|
||||||
# Schedule this one immediately, but future ones will be on an interval
|
|
||||||
|> MediaCollectionIndexingWorker.new()
|
|
||||||
|> Tasks.create_job_with_task(source)
|
|
||||||
end
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Given a media source, creates (indexes) the media by creating media_items for each
|
Given a media source, creates (indexes) the media by creating media_items for each
|
||||||
media ID in the source. Afterward, kicks off a download task for each pending media
|
media ID in the source. Afterward, kicks off a download task for each pending media
|
||||||
item belonging to the source. You can't tell me the method name isn't descriptive!
|
item belonging to the source. You can't tell me the method name isn't descriptive!
|
||||||
|
Returns a list of media items or changesets (if the media item couldn't be created).
|
||||||
|
|
||||||
Indexing is slow and usually returns a list of all media data at once for record creation.
|
Indexing is slow and usually returns a list of all media data at once for record creation.
|
||||||
To help with this, we use a file follower to watch the file that yt-dlp writes to
|
To help with this, we use a file follower to watch the file that yt-dlp writes to
|
||||||
@@ -56,12 +53,15 @@ defmodule Pinchflat.SlowIndexing.SlowIndexingHelpers do
|
|||||||
Since indexing returns all media data EVERY TIME, we that that opportunity to update
|
Since indexing returns all media data EVERY TIME, we that that opportunity to update
|
||||||
indexing metadata for media items that have already been created.
|
indexing metadata for media items that have already been created.
|
||||||
|
|
||||||
Returns [%MediaItem{}, ...]
|
Returns [%MediaItem{} | %Ecto.Changeset{}]
|
||||||
"""
|
"""
|
||||||
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
|
||||||
|
# and important settings like `download_media` may have changed.
|
||||||
|
source = Repo.reload!(source)
|
||||||
|
|
||||||
result =
|
result =
|
||||||
Enum.map(media_attributes, fn media_attrs ->
|
Enum.map(media_attributes, fn media_attrs ->
|
||||||
@@ -82,15 +82,15 @@ 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
|
||||||
@@ -119,15 +119,13 @@ defmodule Pinchflat.SlowIndexing.SlowIndexingHelpers do
|
|||||||
end
|
end
|
||||||
|
|
||||||
defp create_media_item_and_enqueue_download(source, media_attrs) do
|
defp create_media_item_and_enqueue_download(source, media_attrs) do
|
||||||
|
# Reload because the source may have been updated during the (long-running) indexing process
|
||||||
|
# and important settings like `download_media` may have changed.
|
||||||
|
source = Repo.reload!(source)
|
||||||
|
|
||||||
case Media.create_media_item_from_backend_attrs(source, media_attrs) do
|
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)}")
|
|
||||||
|
|
||||||
%{id: media_item.id}
|
|
||||||
|> MediaDownloadWorker.new()
|
|
||||||
|> Tasks.create_job_with_task(media_item)
|
|
||||||
end
|
|
||||||
|
|
||||||
{:error, changeset} ->
|
{:error, changeset} ->
|
||||||
changeset
|
changeset
|
||||||
|
|||||||
@@ -10,25 +10,36 @@ defmodule Pinchflat.Sources.Source do
|
|||||||
alias Pinchflat.Tasks.Task
|
alias Pinchflat.Tasks.Task
|
||||||
alias Pinchflat.Media.MediaItem
|
alias Pinchflat.Media.MediaItem
|
||||||
alias Pinchflat.Profiles.MediaProfile
|
alias Pinchflat.Profiles.MediaProfile
|
||||||
|
alias Pinchflat.Metadata.SourceMetadata
|
||||||
|
|
||||||
@allowed_fields ~w(
|
@allowed_fields ~w(
|
||||||
collection_name
|
collection_name
|
||||||
collection_id
|
collection_id
|
||||||
collection_type
|
collection_type
|
||||||
custom_name
|
custom_name
|
||||||
|
description
|
||||||
|
nfo_filepath
|
||||||
|
poster_filepath
|
||||||
|
fanart_filepath
|
||||||
|
banner_filepath
|
||||||
|
series_directory
|
||||||
index_frequency_minutes
|
index_frequency_minutes
|
||||||
fast_index
|
fast_index
|
||||||
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
|
||||||
media_profile_id
|
media_profile_id
|
||||||
|
output_path_template_override
|
||||||
)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
|
||||||
# we want to ensure that the source is valid before making the call.
|
# we want to ensure that the source is valid before making the call.
|
||||||
# This way, we check that the other attributes are valid before ensuring
|
# This way, we check that the other attributes are valid before ensuring
|
||||||
# that all fields are valid.
|
# that all fields are valid. This is still only one DB insert but it's
|
||||||
|
# a two-stage validation process to fail fast before the API call.
|
||||||
@initially_required_fields ~w(
|
@initially_required_fields ~w(
|
||||||
index_frequency_minutes
|
index_frequency_minutes
|
||||||
fast_index
|
fast_index
|
||||||
@@ -39,6 +50,7 @@ defmodule Pinchflat.Sources.Source do
|
|||||||
|
|
||||||
@pre_insert_required_fields @initially_required_fields ++
|
@pre_insert_required_fields @initially_required_fields ++
|
||||||
~w(
|
~w(
|
||||||
|
uuid
|
||||||
custom_name
|
custom_name
|
||||||
collection_name
|
collection_name
|
||||||
collection_id
|
collection_id
|
||||||
@@ -46,7 +58,13 @@ defmodule Pinchflat.Sources.Source do
|
|||||||
)a
|
)a
|
||||||
|
|
||||||
schema "sources" do
|
schema "sources" do
|
||||||
|
# This is _not_ used as the primary key or internally in the database
|
||||||
|
# relations. This is only used to prevent an enumeration attack on the streaming
|
||||||
|
# and RSS feed endpoints since those _must_ be public (ie: no basic auth)
|
||||||
|
field :uuid, Ecto.UUID
|
||||||
|
|
||||||
field :custom_name, :string
|
field :custom_name, :string
|
||||||
|
field :description, :string
|
||||||
field :collection_name, :string
|
field :collection_name, :string
|
||||||
field :collection_id, :string
|
field :collection_id, :string
|
||||||
field :collection_type, Ecto.Enum, values: [:channel, :playlist]
|
field :collection_type, Ecto.Enum, values: [:channel, :playlist]
|
||||||
@@ -56,10 +74,21 @@ defmodule Pinchflat.Sources.Source do
|
|||||||
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 :output_path_template_override, :string
|
||||||
|
|
||||||
|
field :series_directory, :string
|
||||||
|
field :nfo_filepath, :string
|
||||||
|
field :poster_filepath, :string
|
||||||
|
field :fanart_filepath, :string
|
||||||
|
field :banner_filepath, :string
|
||||||
|
|
||||||
belongs_to :media_profile, MediaProfile
|
belongs_to :media_profile, MediaProfile
|
||||||
|
|
||||||
|
has_one :metadata, SourceMetadata, on_replace: :update
|
||||||
|
|
||||||
has_many :tasks, Task
|
has_many :tasks, Task
|
||||||
has_many :media_items, MediaItem, foreign_key: :source_id
|
has_many :media_items, MediaItem, foreign_key: :source_id
|
||||||
|
|
||||||
@@ -79,8 +108,13 @@ defmodule Pinchflat.Sources.Source do
|
|||||||
source
|
source
|
||||||
|> cast(attrs, @allowed_fields)
|
|> cast(attrs, @allowed_fields)
|
||||||
|> 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)
|
||||||
|> validate_required(required_fields)
|
|> validate_required(required_fields)
|
||||||
|> unique_constraint([:collection_id, :media_profile_id])
|
|> validate_number(:retention_period_days, greater_than_or_equal_to: 0)
|
||||||
|
# Ensures it ends with `.{{ ext }}` or `.%(ext)s` or similar (with a little wiggle room)
|
||||||
|
|> validate_format(:output_path_template_override, MediaProfile.ext_regex(), message: "must end with .{{ ext }}")
|
||||||
|
|> cast_assoc(:metadata, with: &SourceMetadata.changeset/2, required: false)
|
||||||
|
|> unique_constraint([:collection_id, :media_profile_id, :title_filter_regex], error_key: :original_url)
|
||||||
end
|
end
|
||||||
|
|
||||||
@doc false
|
@doc false
|
||||||
@@ -94,4 +128,9 @@ defmodule Pinchflat.Sources.Source do
|
|||||||
# minutes
|
# minutes
|
||||||
15
|
15
|
||||||
end
|
end
|
||||||
|
|
||||||
|
@doc false
|
||||||
|
def filepath_attributes do
|
||||||
|
~w(nfo_filepath fanart_filepath poster_filepath banner_filepath)a
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -9,11 +9,28 @@ defmodule Pinchflat.Sources do
|
|||||||
alias Pinchflat.Media
|
alias Pinchflat.Media
|
||||||
alias Pinchflat.Tasks
|
alias Pinchflat.Tasks
|
||||||
alias Pinchflat.Sources.Source
|
alias Pinchflat.Sources.Source
|
||||||
|
alias Pinchflat.Media.MediaQuery
|
||||||
alias Pinchflat.Profiles.MediaProfile
|
alias Pinchflat.Profiles.MediaProfile
|
||||||
alias Pinchflat.YtDlp.MediaCollection
|
alias Pinchflat.YtDlp.MediaCollection
|
||||||
|
alias Pinchflat.Metadata.SourceMetadata
|
||||||
|
alias Pinchflat.Utils.FilesystemUtils
|
||||||
alias Pinchflat.Downloading.DownloadingHelpers
|
alias Pinchflat.Downloading.DownloadingHelpers
|
||||||
alias Pinchflat.FastIndexing.FastIndexingHelpers
|
alias Pinchflat.FastIndexing.FastIndexingWorker
|
||||||
alias Pinchflat.SlowIndexing.SlowIndexingHelpers
|
alias Pinchflat.SlowIndexing.SlowIndexingHelpers
|
||||||
|
alias Pinchflat.Metadata.SourceMetadataStorageWorker
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Returns the relevant output path template for a source.
|
||||||
|
Pulls from the source's override if present, otherwise uses the media profile's.
|
||||||
|
|
||||||
|
Returns binary()
|
||||||
|
"""
|
||||||
|
def output_path_template(source) do
|
||||||
|
source = Repo.preload(source, :media_profile)
|
||||||
|
media_profile = source.media_profile
|
||||||
|
|
||||||
|
source.output_path_template_override || media_profile.output_path_template
|
||||||
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Returns the list of sources. Returns [%Source{}, ...]
|
Returns the list of sources. Returns [%Source{}, ...]
|
||||||
@@ -48,15 +65,19 @@ defmodule Pinchflat.Sources do
|
|||||||
though we know it's going to fail so it picks up any addl. database errors
|
though we know it's going to fail so it picks up any addl. database errors
|
||||||
and fulfills our return contract.
|
and fulfills our return contract.
|
||||||
|
|
||||||
|
You can pass options to control the behavior of the function:
|
||||||
|
- `run_post_commit_tasks` (default: true) - If false, the function will not
|
||||||
|
enqueue any tasks in `commit_and_handle_tasks`.
|
||||||
|
|
||||||
Returns {:ok, %Source{}} | {:error, %Ecto.Changeset{}}
|
Returns {:ok, %Source{}} | {:error, %Ecto.Changeset{}}
|
||||||
"""
|
"""
|
||||||
def create_source(attrs) do
|
def create_source(attrs, opts \\ []) do
|
||||||
case change_source(%Source{}, attrs, :initial) do
|
case change_source(%Source{}, attrs, :initial) do
|
||||||
%Ecto.Changeset{valid?: true} ->
|
%Ecto.Changeset{valid?: true} ->
|
||||||
%Source{}
|
%Source{}
|
||||||
|> change_source_from_url(attrs)
|
|> maybe_change_source_from_url(attrs)
|
||||||
|> maybe_change_indexing_frequency()
|
|> maybe_change_indexing_frequency()
|
||||||
|> commit_and_handle_tasks()
|
|> commit_and_handle_tasks(opts)
|
||||||
|
|
||||||
changeset ->
|
changeset ->
|
||||||
Repo.insert(changeset)
|
Repo.insert(changeset)
|
||||||
@@ -76,15 +97,19 @@ defmodule Pinchflat.Sources do
|
|||||||
though we know it's going to fail so it picks up any addl. database errors
|
though we know it's going to fail so it picks up any addl. database errors
|
||||||
and fulfills our return contract.
|
and fulfills our return contract.
|
||||||
|
|
||||||
|
You can pass options to control the behavior of the function:
|
||||||
|
- `run_post_commit_tasks` (default: true) - If false, the function will not
|
||||||
|
enqueue any tasks in `commit_and_handle_tasks`.
|
||||||
|
|
||||||
Returns {:ok, %Source{}} | {:error, %Ecto.Changeset{}}
|
Returns {:ok, %Source{}} | {:error, %Ecto.Changeset{}}
|
||||||
"""
|
"""
|
||||||
def update_source(%Source{} = source, attrs) do
|
def update_source(%Source{} = source, attrs, opts \\ []) do
|
||||||
case change_source(source, attrs, :initial) do
|
case change_source(source, attrs, :initial) do
|
||||||
%Ecto.Changeset{valid?: true} ->
|
%Ecto.Changeset{valid?: true} ->
|
||||||
source
|
source
|
||||||
|> change_source_from_url(attrs)
|
|> maybe_change_source_from_url(attrs)
|
||||||
|> maybe_change_indexing_frequency()
|
|> maybe_change_indexing_frequency()
|
||||||
|> commit_and_handle_tasks()
|
|> commit_and_handle_tasks(opts)
|
||||||
|
|
||||||
changeset ->
|
changeset ->
|
||||||
Repo.update(changeset)
|
Repo.update(changeset)
|
||||||
@@ -99,14 +124,20 @@ defmodule Pinchflat.Sources do
|
|||||||
"""
|
"""
|
||||||
def delete_source(%Source{} = source, opts \\ []) do
|
def delete_source(%Source{} = source, opts \\ []) do
|
||||||
delete_files = Keyword.get(opts, :delete_files, false)
|
delete_files = Keyword.get(opts, :delete_files, false)
|
||||||
|
Tasks.delete_tasks_for(source)
|
||||||
|
|
||||||
source
|
MediaQuery.new()
|
||||||
|> Media.list_media_items_for()
|
|> 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)
|
||||||
|
|
||||||
Tasks.delete_tasks_for(source)
|
if delete_files do
|
||||||
|
delete_source_files(source)
|
||||||
|
end
|
||||||
|
|
||||||
|
delete_internal_metadata_files(source)
|
||||||
Repo.delete(source)
|
Repo.delete(source)
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -117,19 +148,9 @@ defmodule Pinchflat.Sources do
|
|||||||
Source.changeset(source, attrs, validation_stage)
|
Source.changeset(source, attrs, validation_stage)
|
||||||
end
|
end
|
||||||
|
|
||||||
@doc """
|
# NOTE: When operating in the ideal path, this effectively adds an API call
|
||||||
Returns an `%Ecto.Changeset{}` for tracking source changes and additionally
|
# to the source creation/update process. Should be used only when needed.
|
||||||
fetches source details from the original_url (if provided). If the source
|
defp maybe_change_source_from_url(%Source{} = source, attrs) do
|
||||||
details cannot be fetched, an error is added to the changeset.
|
|
||||||
|
|
||||||
Note that this fetches source details as long as the `original_url` is present.
|
|
||||||
This means that it'll go for it even if a changeset is otherwise invalid. This
|
|
||||||
is pretty easy to change, but for MVP I'm not concerned.
|
|
||||||
|
|
||||||
NOTE: When operating in the ideal path, this effectively adds an API call
|
|
||||||
to the source creation/update process. Should be used only when needed.
|
|
||||||
"""
|
|
||||||
def change_source_from_url(%Source{} = source, attrs) do
|
|
||||||
case change_source(source, attrs) do
|
case change_source(source, attrs) do
|
||||||
%Ecto.Changeset{changes: %{original_url: _}} = changeset ->
|
%Ecto.Changeset{changes: %{original_url: _}} = changeset ->
|
||||||
add_source_details_to_changeset(source, changeset)
|
add_source_details_to_changeset(source, changeset)
|
||||||
@@ -139,10 +160,27 @@ defmodule Pinchflat.Sources do
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
defp add_source_details_to_changeset(source, changeset) do
|
defp delete_source_files(source) do
|
||||||
%Ecto.Changeset{changes: changes} = changeset
|
mapped_struct = Map.from_struct(source)
|
||||||
|
|
||||||
case MediaCollection.get_source_details(changes.original_url) do
|
Source.filepath_attributes()
|
||||||
|
|> Enum.map(fn field -> mapped_struct[field] end)
|
||||||
|
|> Enum.filter(&is_binary/1)
|
||||||
|
|> Enum.each(&FilesystemUtils.delete_file_and_remove_empty_directories/1)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp delete_internal_metadata_files(source) do
|
||||||
|
metadata = Repo.preload(source, :metadata).metadata || %SourceMetadata{}
|
||||||
|
mapped_struct = Map.from_struct(metadata)
|
||||||
|
|
||||||
|
SourceMetadata.filepath_attributes()
|
||||||
|
|> Enum.map(fn field -> mapped_struct[field] end)
|
||||||
|
|> Enum.filter(&is_binary/1)
|
||||||
|
|> Enum.each(&FilesystemUtils.delete_file_and_remove_empty_directories/1)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp add_source_details_to_changeset(source, changeset) do
|
||||||
|
case MediaCollection.get_source_details(changeset.changes.original_url) do
|
||||||
{:ok, source_details} ->
|
{:ok, source_details} ->
|
||||||
add_source_details_by_collection_type(source, changeset, source_details)
|
add_source_details_by_collection_type(source, changeset, source_details)
|
||||||
|
|
||||||
@@ -191,11 +229,18 @@ defmodule Pinchflat.Sources do
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
defp commit_and_handle_tasks(changeset) do
|
defp commit_and_handle_tasks(changeset, opts) do
|
||||||
|
run_post_commit_tasks = Keyword.get(opts, :run_post_commit_tasks, true)
|
||||||
|
|
||||||
case Repo.insert_or_update(changeset) do
|
case Repo.insert_or_update(changeset) do
|
||||||
{:ok, %Source{} = source} ->
|
{:ok, %Source{} = source} ->
|
||||||
maybe_handle_media_tasks(changeset, source)
|
if run_post_commit_tasks do
|
||||||
maybe_run_indexing_task(changeset, source)
|
maybe_handle_media_tasks(changeset, source)
|
||||||
|
maybe_run_indexing_task(changeset, source)
|
||||||
|
maybe_run_metadata_storage_task(changeset, source)
|
||||||
|
end
|
||||||
|
|
||||||
|
{:ok, source}
|
||||||
|
|
||||||
err ->
|
err ->
|
||||||
err
|
err
|
||||||
@@ -215,8 +260,6 @@ defmodule Pinchflat.Sources do
|
|||||||
_ ->
|
_ ->
|
||||||
:ok
|
:ok
|
||||||
end
|
end
|
||||||
|
|
||||||
{:ok, source}
|
|
||||||
end
|
end
|
||||||
|
|
||||||
defp maybe_run_indexing_task(changeset, source) do
|
defp maybe_run_indexing_task(changeset, source) do
|
||||||
@@ -231,8 +274,22 @@ defmodule Pinchflat.Sources do
|
|||||||
maybe_update_slow_indexing_task(changeset, source)
|
maybe_update_slow_indexing_task(changeset, source)
|
||||||
maybe_update_fast_indexing_task(changeset, source)
|
maybe_update_fast_indexing_task(changeset, source)
|
||||||
end
|
end
|
||||||
|
end
|
||||||
|
|
||||||
{:ok, source}
|
defp maybe_run_metadata_storage_task(changeset, source) do
|
||||||
|
case {changeset.data, changeset.changes} do
|
||||||
|
# If the changeset is new (not persisted), fetch metadata no matter what
|
||||||
|
{%{__meta__: %{state: :built}}, _} ->
|
||||||
|
SourceMetadataStorageWorker.kickoff_with_task(source)
|
||||||
|
|
||||||
|
# If the record has been persisted, only fetch metadata if the
|
||||||
|
# original_url has changed
|
||||||
|
{_, %{original_url: _}} ->
|
||||||
|
SourceMetadataStorageWorker.kickoff_with_task(source)
|
||||||
|
|
||||||
|
_ ->
|
||||||
|
:ok
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
defp maybe_update_slow_indexing_task(changeset, source) do
|
defp maybe_update_slow_indexing_task(changeset, source) do
|
||||||
@@ -242,7 +299,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")
|
||||||
|
|
||||||
_ ->
|
_ ->
|
||||||
@@ -253,7 +309,8 @@ defmodule Pinchflat.Sources do
|
|||||||
defp maybe_update_fast_indexing_task(changeset, source) do
|
defp maybe_update_fast_indexing_task(changeset, source) do
|
||||||
case changeset.changes do
|
case changeset.changes do
|
||||||
%{fast_index: true} ->
|
%{fast_index: true} ->
|
||||||
FastIndexingHelpers.kickoff_fast_indexing_task(source)
|
Tasks.delete_pending_tasks_for(source, "FastIndexingWorker")
|
||||||
|
FastIndexingWorker.kickoff_with_task(source)
|
||||||
|
|
||||||
%{fast_index: false} ->
|
%{fast_index: false} ->
|
||||||
Tasks.delete_pending_tasks_for(source, "FastIndexingWorker")
|
Tasks.delete_pending_tasks_for(source, "FastIndexingWorker")
|
||||||
|
|||||||
@@ -0,0 +1,31 @@
|
|||||||
|
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
|
||||||
|
|
||||||
|
# Prefixes:
|
||||||
|
# - for_* - belonging to a certain record
|
||||||
|
# - join_* - for joining on a certain record
|
||||||
|
# - with_* - for filtering based on full, concrete attributes
|
||||||
|
# - matching_* - for filtering based on partial attributes (e.g. LIKE, regex, full-text search)
|
||||||
|
#
|
||||||
|
# Suffixes:
|
||||||
|
# - _for - the arg passed is an association record
|
||||||
|
|
||||||
|
def new do
|
||||||
|
Source
|
||||||
|
end
|
||||||
|
|
||||||
|
def for_media_profile(query, media_profile) do
|
||||||
|
where(query, [s], s.media_profile_id == ^media_profile.id)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -22,9 +22,15 @@ defmodule Pinchflat.Tasks do
|
|||||||
|
|
||||||
Returns [%Task{}, ...]
|
Returns [%Task{}, ...]
|
||||||
"""
|
"""
|
||||||
def list_tasks_for(attached_record_type, attached_record_id, worker_name \\ nil, job_states \\ Oban.Job.states()) do
|
def list_tasks_for(record, worker_name \\ nil, job_states \\ Oban.Job.states()) do
|
||||||
stringified_states = Enum.map(job_states, &to_string/1)
|
stringified_states = Enum.map(job_states, &to_string/1)
|
||||||
|
|
||||||
|
record_type =
|
||||||
|
case record do
|
||||||
|
%Source{} -> :source_id
|
||||||
|
%MediaItem{} -> :media_item_id
|
||||||
|
end
|
||||||
|
|
||||||
worker_name_finder =
|
worker_name_finder =
|
||||||
if worker_name do
|
if worker_name do
|
||||||
# Workers are the full module name - we want to match on the string ENDING with
|
# Workers are the full module name - we want to match on the string ENDING with
|
||||||
@@ -41,7 +47,7 @@ defmodule Pinchflat.Tasks do
|
|||||||
Repo.all(
|
Repo.all(
|
||||||
from t in Task,
|
from t in Task,
|
||||||
join: j in assoc(t, :job),
|
join: j in assoc(t, :job),
|
||||||
where: field(t, ^attached_record_type) == ^attached_record_id,
|
where: field(t, ^record_type) == ^record.id,
|
||||||
where: ^worker_name_finder,
|
where: ^worker_name_finder,
|
||||||
where: j.state in ^stringified_states
|
where: j.state in ^stringified_states
|
||||||
)
|
)
|
||||||
@@ -53,10 +59,9 @@ defmodule Pinchflat.Tasks do
|
|||||||
|
|
||||||
Returns [%Task{}, ...]
|
Returns [%Task{}, ...]
|
||||||
"""
|
"""
|
||||||
def list_pending_tasks_for(attached_record_type, attached_record_id, worker_name \\ nil) do
|
def list_pending_tasks_for(record, worker_name \\ nil) do
|
||||||
list_tasks_for(
|
list_tasks_for(
|
||||||
attached_record_type,
|
record,
|
||||||
attached_record_id,
|
|
||||||
worker_name,
|
worker_name,
|
||||||
[:available, :scheduled, :retryable]
|
[:available, :scheduled, :retryable]
|
||||||
)
|
)
|
||||||
@@ -126,14 +131,10 @@ defmodule Pinchflat.Tasks do
|
|||||||
|
|
||||||
Returns :ok
|
Returns :ok
|
||||||
"""
|
"""
|
||||||
def delete_tasks_for(attached_record, worker_name \\ nil) do
|
def delete_tasks_for(record, worker_name \\ nil) do
|
||||||
tasks =
|
record
|
||||||
case attached_record do
|
|> list_tasks_for(worker_name)
|
||||||
%Source{} = source -> list_tasks_for(:source_id, source.id, worker_name)
|
|> Enum.each(&delete_task/1)
|
||||||
%MediaItem{} = media_item -> list_tasks_for(:media_item_id, media_item.id, worker_name)
|
|
||||||
end
|
|
||||||
|
|
||||||
Enum.each(tasks, &delete_task/1)
|
|
||||||
end
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
@@ -142,14 +143,10 @@ defmodule Pinchflat.Tasks do
|
|||||||
|
|
||||||
Returns :ok
|
Returns :ok
|
||||||
"""
|
"""
|
||||||
def delete_pending_tasks_for(attached_record, worker_name \\ nil) do
|
def delete_pending_tasks_for(record, worker_name \\ nil) do
|
||||||
tasks =
|
record
|
||||||
case attached_record do
|
|> list_pending_tasks_for(worker_name)
|
||||||
%Source{} = source -> list_pending_tasks_for(:source_id, source.id, worker_name)
|
|> Enum.each(&delete_task/1)
|
||||||
%MediaItem{} = media_item -> list_pending_tasks_for(:media_item_id, media_item.id, worker_name)
|
|
||||||
end
|
|
||||||
|
|
||||||
Enum.each(tasks, &delete_task/1)
|
|
||||||
end
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
|
|||||||
@@ -0,0 +1,69 @@
|
|||||||
|
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.
|
||||||
|
|
||||||
|
Returns {binary(), integer()}
|
||||||
|
"""
|
||||||
|
def wrap_cmd(command, args, opts \\ []) do
|
||||||
|
wrapper_command = Path.join(:code.priv_dir(:pinchflat), "cmd_wrapper.sh")
|
||||||
|
actual_command = [command] ++ args
|
||||||
|
|
||||||
|
Logger.info("[command_wrapper]: #{command} called with: #{Enum.join(args, " ")}")
|
||||||
|
|
||||||
|
System.cmd(wrapper_command, actual_command, opts)
|
||||||
|
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
|
||||||
|
end
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
defmodule Pinchflat.Utils.DatetimeUtils do
|
||||||
|
@moduledoc """
|
||||||
|
Utility methods for working with dates and datetimes
|
||||||
|
"""
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Converts a Date to a DateTime
|
||||||
|
|
||||||
|
Returns %DateTime{}
|
||||||
|
"""
|
||||||
|
def date_to_datetime(date) do
|
||||||
|
date
|
||||||
|
|> Date.to_gregorian_days()
|
||||||
|
|> Kernel.*(86_400)
|
||||||
|
|> DateTime.from_gregorian_seconds()
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,107 @@
|
|||||||
|
defmodule Pinchflat.Utils.FilesystemUtils do
|
||||||
|
@moduledoc """
|
||||||
|
Utility methods for working with the filesystem
|
||||||
|
"""
|
||||||
|
alias Pinchflat.Media
|
||||||
|
alias Pinchflat.Utils.StringUtils
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Generates a temporary file and returns its path. The file is empty and has the given type.
|
||||||
|
Generates all the directories in the path if they don't exist.
|
||||||
|
|
||||||
|
Returns binary()
|
||||||
|
"""
|
||||||
|
def generate_metadata_tmpfile(type) do
|
||||||
|
tmpfile_directory = Application.get_env(:pinchflat, :tmpfile_directory)
|
||||||
|
filepath = Path.join([tmpfile_directory, "#{StringUtils.random_string(64)}.#{type}"])
|
||||||
|
|
||||||
|
:ok = write_p!(filepath, "")
|
||||||
|
|
||||||
|
filepath
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Writes content to a file, creating directories as needed.
|
||||||
|
Takes the same args as File.write/3.
|
||||||
|
|
||||||
|
Returns :ok | {:error, any()}
|
||||||
|
"""
|
||||||
|
def write_p(file, content, modes \\ []) do
|
||||||
|
dirname = Path.dirname(file)
|
||||||
|
|
||||||
|
case File.mkdir_p(dirname) do
|
||||||
|
:ok -> File.write(file, content, modes)
|
||||||
|
err -> err
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Writes content to a file, creating directories as needed.
|
||||||
|
Takes the same args as File.write!/3.
|
||||||
|
|
||||||
|
Returns :ok | raises on error
|
||||||
|
"""
|
||||||
|
def write_p!(filepath, content, modes \\ []) do
|
||||||
|
:ok = write_p(filepath, content, modes)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Copies a file from source to destination, creating directories as needed.
|
||||||
|
|
||||||
|
Returns :ok | raises on error
|
||||||
|
"""
|
||||||
|
def cp_p!(source, destination) do
|
||||||
|
destination
|
||||||
|
|> Path.dirname()
|
||||||
|
|> File.mkdir_p!()
|
||||||
|
|
||||||
|
File.cp!(source, destination)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Fetches the file size of a media item and saves it to the database.
|
||||||
|
|
||||||
|
Returns {:ok, media_item} | {:error, any()}
|
||||||
|
"""
|
||||||
|
def compute_and_save_media_filesize(media_item) do
|
||||||
|
case File.stat(media_item.media_filepath) do
|
||||||
|
{:ok, %{size: size}} ->
|
||||||
|
Media.update_media_item(media_item, %{media_size_bytes: size})
|
||||||
|
|
||||||
|
err ->
|
||||||
|
err
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Deletes a file and removes any empty directories in the path.
|
||||||
|
Does NOT remove any directories that are not empty.
|
||||||
|
|
||||||
|
Returns :ok | {:error, any()}
|
||||||
|
"""
|
||||||
|
def delete_file_and_remove_empty_directories(filepath) do
|
||||||
|
case File.rm(filepath) do
|
||||||
|
:ok ->
|
||||||
|
filepath
|
||||||
|
|> Path.dirname()
|
||||||
|
|> recursively_delete_empty_directories()
|
||||||
|
|
||||||
|
err ->
|
||||||
|
err
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp recursively_delete_empty_directories(directory) do
|
||||||
|
case File.rmdir(directory) do
|
||||||
|
:ok ->
|
||||||
|
directory
|
||||||
|
|> Path.dirname()
|
||||||
|
|> recursively_delete_empty_directories()
|
||||||
|
|
||||||
|
err ->
|
||||||
|
err
|
||||||
|
end
|
||||||
|
|
||||||
|
:ok
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
defmodule Pinchflat.Utils.NumberUtils do
|
||||||
|
@moduledoc """
|
||||||
|
Utility methods for working with numbers
|
||||||
|
"""
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Clamps a number between a minimum and maximum value
|
||||||
|
|
||||||
|
Returns integer() | float()
|
||||||
|
"""
|
||||||
|
def clamp(num, minimum, maximum) do
|
||||||
|
num
|
||||||
|
|> max(minimum)
|
||||||
|
|> min(maximum)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
defmodule Pinchflat.Utils.XmlUtils do
|
||||||
|
@moduledoc """
|
||||||
|
Utility methods for working with XML documents
|
||||||
|
"""
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Escapes invalid XML characters in a string
|
||||||
|
|
||||||
|
Returns binary()
|
||||||
|
"""
|
||||||
|
def safe(value) do
|
||||||
|
value
|
||||||
|
|> to_string()
|
||||||
|
|> Phoenix.HTML.html_escape()
|
||||||
|
|> Phoenix.HTML.safe_to_string()
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -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
|
||||||
@@ -23,21 +21,22 @@ defmodule Pinchflat.YtDlp.CommandRunner do
|
|||||||
|
|
||||||
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]
|
||||||
formatted_command_opts = [url] ++ parse_options(command_opts ++ print_to_file_opts)
|
user_configured_opts = cookie_file_options() ++ global_options()
|
||||||
|
# These must stay in exactly this order, hence why I'm giving it its own variable.
|
||||||
|
all_opts = command_opts ++ print_to_file_opts ++ user_configured_opts
|
||||||
|
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
|
# IDEA: consider deleting the file after reading it. It's in the tmp dir, so it's not
|
||||||
|
# a huge deal, but it's still a good idea to clean up after ourselves.
|
||||||
# (even on error? especially on error?)
|
# (even on error? especially on error?)
|
||||||
File.read(output_filepath)
|
File.read(output_filepath)
|
||||||
|
|
||||||
@@ -46,34 +45,54 @@ defmodule Pinchflat.YtDlp.CommandRunner do
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# We want to satisfy the following behaviours:
|
@doc """
|
||||||
#
|
Returns the version of yt-dlp as a string
|
||||||
# 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
|
Returns {:ok, binary()} | {:error, binary()}
|
||||||
# 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
|
@impl YtDlpCommandRunner
|
||||||
defp parse_options(command_opts) do
|
def version do
|
||||||
Enum.reduce(command_opts, [], &parse_option/2)
|
command = backend_executable()
|
||||||
|
|
||||||
|
case CliUtils.wrap_cmd(command, ["--version"]) do
|
||||||
|
{output, 0} ->
|
||||||
|
{:ok, String.trim(output)}
|
||||||
|
|
||||||
|
{output, _} ->
|
||||||
|
{:error, output}
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
defp parse_option({k, v}, acc) when is_atom(k) do
|
defp generate_output_filepath(addl_opts) do
|
||||||
stringified_key = StringUtils.to_kebab_case(Atom.to_string(k))
|
case Keyword.get(addl_opts, :output_filepath) do
|
||||||
|
nil -> FSUtils.generate_metadata_tmpfile(:json)
|
||||||
parse_option({"--#{stringified_key}", v}, acc)
|
path -> path
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
defp parse_option({k, v}, acc) when is_binary(k) do
|
defp global_options do
|
||||||
acc ++ [k, to_string(v)]
|
[:windows_filenames]
|
||||||
end
|
end
|
||||||
|
|
||||||
defp parse_option(arg, acc) when is_atom(arg) do
|
defp cookie_file_options do
|
||||||
stringified_arg = StringUtils.to_kebab_case(Atom.to_string(arg))
|
base_dir = Application.get_env(:pinchflat, :extras_directory)
|
||||||
|
filename_options_map = %{cookies: "cookies.txt"}
|
||||||
|
|
||||||
parse_option("--#{stringified_arg}", acc)
|
Enum.reduce(filename_options_map, [], fn {opt_name, filename}, acc ->
|
||||||
end
|
filepath = Path.join(base_dir, filename)
|
||||||
|
|
||||||
defp parse_option(arg, acc) when is_binary(arg) do
|
case File.read(filepath) do
|
||||||
acc ++ [arg]
|
{:ok, file_data} ->
|
||||||
|
if String.trim(file_data) != "" do
|
||||||
|
[{opt_name, filepath} | acc]
|
||||||
|
else
|
||||||
|
acc
|
||||||
|
end
|
||||||
|
|
||||||
|
{:error, _} ->
|
||||||
|
acc
|
||||||
|
end
|
||||||
|
end)
|
||||||
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
|
:upload_date,
|
||||||
|
:duration_seconds
|
||||||
]
|
]
|
||||||
|
|
||||||
defstruct [
|
defstruct [
|
||||||
@@ -20,11 +21,13 @@ defmodule Pinchflat.YtDlp.Media do
|
|||||||
:original_url,
|
:original_url,
|
||||||
:livestream,
|
:livestream,
|
||||||
:short_form_content,
|
:short_form_content,
|
||||||
:upload_date
|
:upload_date,
|
||||||
|
:duration_seconds
|
||||||
]
|
]
|
||||||
|
|
||||||
alias __MODULE__
|
alias __MODULE__
|
||||||
alias Pinchflat.Utils.FunctionUtils
|
alias Pinchflat.Utils.FunctionUtils
|
||||||
|
alias Pinchflat.Metadata.MetadataFileHelpers
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Downloads a single piece of media (and possibly its metadata) directly to its
|
Downloads a single piece of media (and possibly its metadata) directly to its
|
||||||
@@ -32,10 +35,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
|
opts = [:no_simulate] ++ command_opts
|
||||||
|
|
||||||
with {:ok, output} <- backend_runner().run(url, opts, "after_move:%()j"),
|
with {:ok, output} <- backend_runner().run(url, opts, "after_move:%()j", addl_opts),
|
||||||
{:ok, parsed_json} <- Phoenix.json_library().decode(output) do
|
{:ok, parsed_json} <- Phoenix.json_library().decode(output) do
|
||||||
{:ok, parsed_json}
|
{:ok, parsed_json}
|
||||||
else
|
else
|
||||||
@@ -60,8 +63,8 @@ defmodule Pinchflat.YtDlp.Media do
|
|||||||
|> response_to_struct()
|
|> response_to_struct()
|
||||||
|> FunctionUtils.wrap_ok()
|
|> FunctionUtils.wrap_ok()
|
||||||
|
|
||||||
res ->
|
err ->
|
||||||
res
|
err
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -85,8 +88,9 @@ defmodule Pinchflat.YtDlp.Media do
|
|||||||
description: response["description"],
|
description: response["description"],
|
||||||
original_url: response["webpage_url"],
|
original_url: response["webpage_url"],
|
||||||
livestream: response["was_live"],
|
livestream: response["was_live"],
|
||||||
short_form_content: short_form_content?(response),
|
duration_seconds: response["duration"] && round(response["duration"]),
|
||||||
upload_date: parse_upload_date(response["upload_date"])
|
short_form_content: response["webpage_url"] && short_form_content?(response),
|
||||||
|
upload_date: response["upload_date"] && MetadataFileHelpers.parse_upload_date(response["upload_date"])
|
||||||
}
|
}
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -99,16 +103,13 @@ defmodule Pinchflat.YtDlp.Media do
|
|||||||
# WILL returns false positives, but it's a best-effort approach
|
# WILL returns false positives, but it's a best-effort approach
|
||||||
# that should work for most cases. The aspect_ratio check is
|
# that should work for most cases. The aspect_ratio check is
|
||||||
# based on a gut feeling and may need to be tweaked.
|
# based on a gut feeling and may need to be tweaked.
|
||||||
|
#
|
||||||
|
# These don't fail if duration or aspect_ratio are missing
|
||||||
|
# due to Elixir's comparison semantics
|
||||||
response["duration"] <= 60 && response["aspect_ratio"] < 0.8
|
response["duration"] <= 60 && response["aspect_ratio"] < 0.8
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
defp parse_upload_date(upload_date) do
|
|
||||||
<<year::binary-size(4)>> <> <<month::binary-size(2)>> <> <<day::binary-size(2)>> = upload_date
|
|
||||||
|
|
||||||
Date.from_iso8601!("#{year}-#{month}-#{day}")
|
|
||||||
end
|
|
||||||
|
|
||||||
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,8 +6,7 @@ defmodule Pinchflat.YtDlp.MediaCollection do
|
|||||||
|
|
||||||
require Logger
|
require Logger
|
||||||
|
|
||||||
alias Pinchflat.Utils.FunctionUtils
|
alias Pinchflat.Utils.FilesystemUtils
|
||||||
alias Pinchflat.Filesystem.FilesystemHelpers
|
|
||||||
alias Pinchflat.YtDlp.Media, as: YtDlpMedia
|
alias Pinchflat.YtDlp.Media, as: YtDlpMedia
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
@@ -27,7 +26,7 @@ defmodule Pinchflat.YtDlp.MediaCollection do
|
|||||||
# 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]
|
||||||
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)
|
||||||
|
|
||||||
if file_listener_handler do
|
if file_listener_handler do
|
||||||
@@ -36,34 +35,50 @@ defmodule Pinchflat.YtDlp.MediaCollection do
|
|||||||
|
|
||||||
case runner.run(url, command_opts, output_template, output_filepath: output_filepath) do
|
case runner.run(url, command_opts, output_template, output_filepath: output_filepath) do
|
||||||
{:ok, output} ->
|
{:ok, output} ->
|
||||||
output
|
parsed_lines =
|
||||||
|> String.split("\n", trim: true)
|
output
|
||||||
|> Enum.map(&Phoenix.json_library().decode!/1)
|
|> String.split("\n", trim: true)
|
||||||
|> Enum.map(&YtDlpMedia.response_to_struct/1)
|
|> Enum.map(fn line ->
|
||||||
|> FunctionUtils.wrap_ok()
|
case Phoenix.json_library().decode(line) do
|
||||||
|
{:ok, parsed_json} ->
|
||||||
|
YtDlpMedia.response_to_struct(parsed_json)
|
||||||
|
|
||||||
res ->
|
_ ->
|
||||||
res
|
nil
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
|
||||||
|
{:ok, Enum.filter(parsed_lines, &(&1 != nil))}
|
||||||
|
|
||||||
|
err ->
|
||||||
|
err
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Gets a source's ID and name from its URL.
|
Gets a source's ID and name from its URL.
|
||||||
|
|
||||||
yt-dlp does not _really_ have source-specific functions, so
|
yt-dlp does not _really_ have source-specific functions that return what
|
||||||
instead we're fetching just the first video (using playlist_end: 1)
|
we need, so instead we're fetching just the first video (using playlist_end: 1)
|
||||||
and parsing the source ID and name from _its_ metadata
|
and parsing the source ID and name from _its_ metadata
|
||||||
|
|
||||||
Returns {:ok, map()} | {:error, any, ...}.
|
Returns {:ok, map()} | {:error, any, ...}.
|
||||||
"""
|
"""
|
||||||
def get_source_details(source_url) do
|
def get_source_details(source_url, 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
|
||||||
opts = [:simulate, :skip_download, :ignore_no_formats_error, playlist_end: 1]
|
default_opts = [
|
||||||
output_template = "%(.{channel,channel_id,playlist_id,playlist_title})j"
|
:simulate,
|
||||||
|
:skip_download,
|
||||||
|
:ignore_no_formats_error,
|
||||||
|
playlist_end: 1
|
||||||
|
]
|
||||||
|
|
||||||
with {:ok, output} <- backend_runner().run(source_url, opts, output_template),
|
command_opts = default_opts ++ addl_opts
|
||||||
|
output_template = "%(.{channel,channel_id,playlist_id,playlist_title,filename})j"
|
||||||
|
|
||||||
|
with {:ok, output} <- backend_runner().run(source_url, command_opts, output_template),
|
||||||
{:ok, parsed_json} <- Phoenix.json_library().decode(output) do
|
{:ok, parsed_json} <- Phoenix.json_library().decode(output) do
|
||||||
{:ok, format_source_details(parsed_json)}
|
{:ok, format_source_details(parsed_json)}
|
||||||
else
|
else
|
||||||
@@ -71,12 +86,44 @@ defmodule Pinchflat.YtDlp.MediaCollection do
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Gets a source's metadata from its URL.
|
||||||
|
|
||||||
|
This is mostly for things like getting the source's avatar and banner image
|
||||||
|
(if applicable). However, this yt-dlp call doesn't have enough overlap with
|
||||||
|
`get_source_details/1` to allow combining them - this one has _almost_ everything
|
||||||
|
we need, but it doesn't contain enough information to tell 100% if the url is a channel
|
||||||
|
or a playlist.
|
||||||
|
|
||||||
|
The main purpose of this (past using as a fetcher for _other_ metadata) is to live
|
||||||
|
as a compressed blob for possible future use. That's why it's not getting formatted like
|
||||||
|
`get_source_details/1`
|
||||||
|
|
||||||
|
Returns {:ok, map()} | {:error, any, ...}.
|
||||||
|
"""
|
||||||
|
def get_source_metadata(source_url, addl_opts \\ []) do
|
||||||
|
opts = [playlist_items: 0] ++ addl_opts
|
||||||
|
output_template = "playlist:%()j"
|
||||||
|
|
||||||
|
with {:ok, output} <- backend_runner().run(source_url, opts, output_template),
|
||||||
|
{:ok, parsed_json} <- Phoenix.json_library().decode(output) do
|
||||||
|
{:ok, parsed_json}
|
||||||
|
else
|
||||||
|
err -> err
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
defp format_source_details(response) do
|
defp format_source_details(response) do
|
||||||
|
# NOTE: I should probably make this a struct some day
|
||||||
%{
|
%{
|
||||||
channel_id: response["channel_id"],
|
channel_id: response["channel_id"],
|
||||||
channel_name: response["channel"],
|
channel_name: response["channel"],
|
||||||
playlist_id: response["playlist_id"],
|
playlist_id: response["playlist_id"],
|
||||||
playlist_name: response["playlist_title"]
|
playlist_name: response["playlist_title"],
|
||||||
|
# It's not a name, it's a path dammit!
|
||||||
|
# This actually isn't used for the inital response - it's
|
||||||
|
# used later to update a source's metadata
|
||||||
|
filepath: response["filename"]
|
||||||
}
|
}
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|||||||
+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
|
||||||
@@ -21,7 +21,7 @@ defmodule PinchflatWeb do
|
|||||||
|
|
||||||
def router do
|
def router do
|
||||||
quote do
|
quote do
|
||||||
use Phoenix.Router, helpers: false
|
use Phoenix.Router, helpers: true
|
||||||
|
|
||||||
# Import common connection and controller functions to use in pipelines
|
# Import common connection and controller functions to use in pipelines
|
||||||
import Plug.Conn
|
import Plug.Conn
|
||||||
|
|||||||
@@ -14,12 +14,11 @@ defmodule PinchflatWeb.CoreComponents do
|
|||||||
|
|
||||||
Icons are provided by [heroicons](https://heroicons.com). See `icon/1` for usage.
|
Icons are provided by [heroicons](https://heroicons.com). See `icon/1` for usage.
|
||||||
"""
|
"""
|
||||||
use Phoenix.Component
|
use Phoenix.Component, global_prefixes: ~w(x-)
|
||||||
|
|
||||||
import PinchflatWeb.Gettext
|
import PinchflatWeb.Gettext
|
||||||
|
|
||||||
alias Phoenix.LiveView.JS
|
alias Phoenix.LiveView.JS
|
||||||
alias PinchflatWeb.CustomComponents.TextComponents
|
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Renders a modal.
|
Renders a modal.
|
||||||
@@ -247,11 +246,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]"
|
||||||
|
|
||||||
@@ -298,7 +298,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>
|
||||||
"""
|
"""
|
||||||
@@ -317,17 +344,7 @@ defmodule PinchflatWeb.CoreComponents do
|
|||||||
<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>
|
||||||
<div class="relative">
|
<div class="relative">
|
||||||
<input type="hidden" name={@name} value="false" />
|
<input type="hidden" id={@id} name={@name} x-bind:value="enabled" {@rest} />
|
||||||
<input
|
|
||||||
type="checkbox"
|
|
||||||
id={@id}
|
|
||||||
name={@name}
|
|
||||||
value="true"
|
|
||||||
x-bind:checked="enabled"
|
|
||||||
class="sr-only"
|
|
||||||
@change="enabled = !enabled"
|
|
||||||
{@rest}
|
|
||||||
/>
|
|
||||||
<div class="inline-block cursor-pointer" @click="enabled = !enabled">
|
<div class="inline-block cursor-pointer" @click="enabled = !enabled">
|
||||||
<div x-bind:class="enabled && '!bg-primary'" class="block h-8 w-14 rounded-full bg-black"></div>
|
<div x-bind:class="enabled && '!bg-primary'" class="block h-8 w-14 rounded-full bg-black"></div>
|
||||||
<div
|
<div
|
||||||
@@ -339,7 +356,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>
|
||||||
@@ -349,24 +366,28 @@ defmodule PinchflatWeb.CoreComponents do
|
|||||||
def input(%{type: "select"} = assigns) do
|
def input(%{type: "select"} = assigns) do
|
||||||
~H"""
|
~H"""
|
||||||
<div phx-feedback-for={@name}>
|
<div phx-feedback-for={@name}>
|
||||||
<.label for={@id}>
|
<.label :if={@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>
|
||||||
<select
|
<div class="flex">
|
||||||
id={@id}
|
<select
|
||||||
name={@name}
|
id={@id}
|
||||||
class={[
|
name={@name}
|
||||||
"relative z-20 w-full appearance-none rounded border border-stroke bg-transparent py-3 pl-5 pr-12 outline-none transition",
|
class={[
|
||||||
"focus:border-primary active:border-primary dark:border-form-strokedark dark:bg-form-input text-black dark:text-white",
|
"relative z-20 w-full appearance-none rounded border border-form-strokedark py-3 pl-5 pr-12 outline-none transition",
|
||||||
@inputclass
|
"focus:border-primary active:border-primary bg-form-input text-black text-white",
|
||||||
]}
|
"disabled:text-opacity-50 disabled:cursor-not-allowed disabled:border-black",
|
||||||
multiple={@multiple}
|
@inputclass
|
||||||
{@rest}
|
]}
|
||||||
>
|
multiple={@multiple}
|
||||||
<option :if={@prompt} value=""><%= @prompt %></option>
|
{@rest}
|
||||||
<%= Phoenix.HTML.Form.options_for_select(@options, @value) %>
|
>
|
||||||
</select>
|
<option :if={@prompt} value=""><%= @prompt %></option>
|
||||||
<.help :if={@help}><%= @help %></.help>
|
<%= Phoenix.HTML.Form.options_for_select(@options, @value) %>
|
||||||
|
</select>
|
||||||
|
<%= render_slot(@inner_block) %>
|
||||||
|
</div>
|
||||||
|
<.help :if={@help}><%= if @html_help, do: Phoenix.HTML.raw(@help), else: @help %></.help>
|
||||||
<.error :for={msg <- @errors}><%= msg %></.error>
|
<.error :for={msg <- @errors}><%= msg %></.error>
|
||||||
</div>
|
</div>
|
||||||
"""
|
"""
|
||||||
@@ -390,7 +411,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>
|
||||||
"""
|
"""
|
||||||
@@ -417,7 +438,7 @@ defmodule PinchflatWeb.CoreComponents do
|
|||||||
]}
|
]}
|
||||||
{@rest}
|
{@rest}
|
||||||
/>
|
/>
|
||||||
<.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>
|
||||||
"""
|
"""
|
||||||
@@ -607,14 +628,20 @@ 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">
|
||||||
|
<%= v %>
|
||||||
|
</code>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
"""
|
"""
|
||||||
@@ -661,10 +688,11 @@ defmodule PinchflatWeb.CoreComponents do
|
|||||||
"""
|
"""
|
||||||
attr :name, :string, required: true
|
attr :name, :string, required: true
|
||||||
attr :class, :string, default: nil
|
attr :class, :string, default: nil
|
||||||
|
attr :rest, :global
|
||||||
|
|
||||||
def icon(%{name: "hero-" <> _} = assigns) do
|
def icon(%{name: "hero-" <> _} = assigns) do
|
||||||
~H"""
|
~H"""
|
||||||
<span class={[@name, @class]} />
|
<span class={[@name, @class]} {@rest} />
|
||||||
"""
|
"""
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,8 @@
|
|||||||
defmodule PinchflatWeb.CustomComponents.ButtonComponents do
|
defmodule PinchflatWeb.CustomComponents.ButtonComponents do
|
||||||
@moduledoc false
|
@moduledoc false
|
||||||
use Phoenix.Component
|
use Phoenix.Component, global_prefixes: ~w(x-)
|
||||||
|
|
||||||
|
alias PinchflatWeb.CoreComponents
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Render a button
|
Render a button
|
||||||
@@ -28,9 +30,10 @@ defmodule PinchflatWeb.CustomComponents.ButtonComponents do
|
|||||||
"#{@rounding} inline-flex items-center justify-center px-8 py-4",
|
"#{@rounding} inline-flex items-center justify-center px-8 py-4",
|
||||||
"#{@color}",
|
"#{@color}",
|
||||||
"hover:bg-opacity-90 lg:px-8 xl:px-10",
|
"hover:bg-opacity-90 lg:px-8 xl:px-10",
|
||||||
"disabled:bg-opacity-50 disabled:cursor-not-allowed disabled:text-gray-2",
|
"disabled:bg-opacity-50 disabled:cursor-not-allowed disabled:text-grey-5",
|
||||||
@class
|
@class
|
||||||
]}
|
]}
|
||||||
|
type={@type}
|
||||||
disabled={@disabled}
|
disabled={@disabled}
|
||||||
{@rest}
|
{@rest}
|
||||||
>
|
>
|
||||||
@@ -38,4 +41,52 @@ defmodule PinchflatWeb.CustomComponents.ButtonComponents do
|
|||||||
</button>
|
</button>
|
||||||
"""
|
"""
|
||||||
end
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Render a dropdown based off a button
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
<.button_dropdown text="Actions">
|
||||||
|
<:option>TEST</:option>
|
||||||
|
</.button_dropdown>
|
||||||
|
"""
|
||||||
|
attr :text, :string, required: true
|
||||||
|
attr :class, :string, default: ""
|
||||||
|
|
||||||
|
slot :option, required: true
|
||||||
|
|
||||||
|
def button_dropdown(assigns) do
|
||||||
|
~H"""
|
||||||
|
<div x-data="{ dropdownOpen: false }" class={["relative flex", @class]}>
|
||||||
|
<span
|
||||||
|
x-on:click.prevent="dropdownOpen = !dropdownOpen"
|
||||||
|
class={[
|
||||||
|
"cursor-pointer inline-flex gap-2.5 rounded-md bg-primary px-5.5 py-3",
|
||||||
|
"font-medium text-white hover:bg-opacity-95"
|
||||||
|
]}
|
||||||
|
>
|
||||||
|
<%= @text %>
|
||||||
|
<CoreComponents.icon
|
||||||
|
name="hero-chevron-down"
|
||||||
|
class="fill-current duration-200 ease-linear mt-1"
|
||||||
|
x-bind:class="dropdownOpen && 'rotate-180'"
|
||||||
|
/>
|
||||||
|
</span>
|
||||||
|
<div
|
||||||
|
x-show="dropdownOpen"
|
||||||
|
x-on:click.outside="dropdownOpen = false"
|
||||||
|
class="absolute left-0 top-full z-40 mt-2 w-full rounded-md bg-black py-3 shadow-card"
|
||||||
|
>
|
||||||
|
<ul class="flex flex-col">
|
||||||
|
<li :for={option <- @option}>
|
||||||
|
<span class="flex px-5 py-2 font-medium text-bodydark2 hover:text-white cursor-pointer">
|
||||||
|
<%= render_slot(option) %>
|
||||||
|
</span>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
"""
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -9,24 +9,32 @@ defmodule PinchflatWeb.CustomComponents.TabComponents do
|
|||||||
attr :title, :string, required: true
|
attr :title, :string, required: true
|
||||||
end
|
end
|
||||||
|
|
||||||
|
slot :tab_append, required: false
|
||||||
|
|
||||||
def tabbed_layout(assigns) do
|
def tabbed_layout(assigns) do
|
||||||
~H"""
|
~H"""
|
||||||
<div
|
<div
|
||||||
x-data="{ openTab: 0, activeClasses: 'text-meta-5 border-meta-5', inactiveClasses: 'border-transparent' }"
|
x-data="{ openTab: getTabIndex(0), activeClasses: 'text-meta-5 border-meta-5', inactiveClasses: 'border-transparent' }"
|
||||||
|
@hashchange.window="openTab = getTabIndex(openTab)"
|
||||||
class="w-full"
|
class="w-full"
|
||||||
>
|
>
|
||||||
<div class="mb-6 flex flex-wrap gap-5 border-b border-strokedark sm:gap-10">
|
<header class="flex flex-col md:flex-row md:justify-between border-b border-strokedark">
|
||||||
<a
|
<div class="flex flex-wrap gap-5 sm:gap-10">
|
||||||
:for={{tab, idx} <- Enum.with_index(@tab)}
|
<a
|
||||||
href="#"
|
:for={{tab, idx} <- Enum.with_index(@tab)}
|
||||||
@click.prevent={"openTab = #{idx}"}
|
href="#"
|
||||||
x-bind:class={"openTab === #{idx} ? activeClasses : inactiveClasses"}
|
@click.prevent={"openTab = setTabIndex(#{idx})"}
|
||||||
class="border-b-2 py-4 text-sm font-medium hover:text-meta-5 md:text-base"
|
x-bind:class={"openTab === #{idx} ? activeClasses : inactiveClasses"}
|
||||||
>
|
class="border-b-2 py-4 w-full sm:w-fit text-sm font-medium hover:text-meta-5 md:text-base"
|
||||||
<span class="text-xl"><%= tab.title %></span>
|
>
|
||||||
</a>
|
<span class="text-xl"><%= tab.title %></span>
|
||||||
</div>
|
</a>
|
||||||
<div>
|
</div>
|
||||||
|
<div class="mx-4 my-4 lg:my-0 flex gap-5 sm:gap-10 items-center">
|
||||||
|
<%= render_slot(@tab_append) %>
|
||||||
|
</div>
|
||||||
|
</header>
|
||||||
|
<div class="mt-4 min-h-60">
|
||||||
<div :for={{tab, idx} <- Enum.with_index(@tab)} x-show={"openTab === #{idx}"} class="font-medium leading-relaxed">
|
<div :for={{tab, idx} <- Enum.with_index(@tab)} x-show={"openTab === #{idx}"} class="font-medium leading-relaxed">
|
||||||
<%= render_slot(tab) %>
|
<%= render_slot(tab) %>
|
||||||
</div>
|
</div>
|
||||||
|
|||||||
@@ -2,6 +2,8 @@ defmodule PinchflatWeb.CustomComponents.TableComponents do
|
|||||||
@moduledoc false
|
@moduledoc false
|
||||||
use Phoenix.Component
|
use Phoenix.Component
|
||||||
|
|
||||||
|
alias PinchflatWeb.CoreComponents
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Renders a table component with the given rows and columns.
|
Renders a table component with the given rows and columns.
|
||||||
|
|
||||||
@@ -50,4 +52,52 @@ defmodule PinchflatWeb.CustomComponents.TableComponents do
|
|||||||
</table>
|
</table>
|
||||||
"""
|
"""
|
||||||
end
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Renders simple pagination controls for a table in a liveview.
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
<.live_pagination_controls page_number={@page} total_pages={@total_pages} />
|
||||||
|
"""
|
||||||
|
attr :page_number, :integer, default: 1
|
||||||
|
attr :total_pages, :integer, default: 1
|
||||||
|
|
||||||
|
def live_pagination_controls(assigns) do
|
||||||
|
~H"""
|
||||||
|
<nav>
|
||||||
|
<ul class="flex flex-wrap items-center">
|
||||||
|
<li>
|
||||||
|
<span
|
||||||
|
class={[
|
||||||
|
"flex h-8 w-8 items-center justify-center rounded",
|
||||||
|
@page_number != 1 && "cursor-pointer hover:bg-primary hover:text-white",
|
||||||
|
@page_number == 1 && "cursor-not-allowed"
|
||||||
|
]}
|
||||||
|
phx-click={@page_number != 1 && "page_change"}
|
||||||
|
phx-value-direction="dec"
|
||||||
|
>
|
||||||
|
<CoreComponents.icon name="hero-chevron-left" />
|
||||||
|
</span>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<span class="mx-2">Page <%= @page_number %> of <%= @total_pages %></span>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<span
|
||||||
|
class={[
|
||||||
|
"flex h-8 w-8 items-center justify-center rounded",
|
||||||
|
@page_number != @total_pages && "cursor-pointer hover:bg-primary hover:text-white",
|
||||||
|
@page_number == @total_pages && "cursor-not-allowed"
|
||||||
|
]}
|
||||||
|
phx-click={@page_number != @total_pages && "page_change"}
|
||||||
|
phx-value-direction="inc"
|
||||||
|
>
|
||||||
|
<CoreComponents.icon name="hero-chevron-right" />
|
||||||
|
</span>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
"""
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -31,6 +31,21 @@ defmodule PinchflatWeb.CustomComponents.TextComponents do
|
|||||||
"""
|
"""
|
||||||
end
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Renders a subtle link with the given href and content.
|
||||||
|
"""
|
||||||
|
attr :href, :string, required: true
|
||||||
|
attr :target, :string, default: "_self"
|
||||||
|
slot :inner_block
|
||||||
|
|
||||||
|
def subtle_link(assigns) do
|
||||||
|
~H"""
|
||||||
|
<.link href={@href} target={@target} class="underline decoration-bodydark decoration-1 hover:decoration-white">
|
||||||
|
<%= render_slot(@inner_block) %>
|
||||||
|
</.link>
|
||||||
|
"""
|
||||||
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Renders an icon as a link with the given href.
|
Renders an icon as a link with the given href.
|
||||||
"""
|
"""
|
||||||
@@ -45,4 +60,22 @@ 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
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,10 +1,9 @@
|
|||||||
<div class="flex h-screen overflow-hidden">
|
<div class="flex h-screen overflow-hidden">
|
||||||
<div class="relative flex flex-1 flex-col overflow-y-auto overflow-x-hidden">
|
<div class="relative flex flex-1 flex-col overflow-y-auto overflow-x-hidden">
|
||||||
<header class="sticky top-0 z-999 flex w-full bg-white drop-shadow-1 dark:bg-boxdark dark:drop-shadow-none">
|
<header class="sticky top-0 z-999 flex w-full bg-white drop-shadow-1 dark:bg-boxdark dark:drop-shadow-none">
|
||||||
<div class="flex flex-grow items-center px-4 py-4 shadow-2 md:px-6 2xl:px-11">
|
<div class="w-65 px-4 py-2 shadow-2 md:px-6">
|
||||||
<div class="flex items-center">
|
<div class="flex items-center gap-2 py-2">
|
||||||
<img src={~p"/images/logo.png?cachebust=2024-02-29"} alt="Pinchflat" class="w-9 h-9" />
|
<img src={~p"/images/logo.png?cachebust=2024-03-20"} alt="Pinchflat" class="w-auto" />
|
||||||
<h2 class="text-xl font-bold text-white pl-2">Pinchflat</h2>
|
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</header>
|
</header>
|
||||||
|
|||||||
@@ -1,18 +1,18 @@
|
|||||||
<header class="sticky top-0 z-999 flex w-full bg-white drop-shadow-1 dark:bg-boxdark dark:drop-shadow-none">
|
<header class="sticky top-0 z-999 flex h-20 w-full bg-white drop-shadow-1 dark:bg-boxdark dark:drop-shadow-none">
|
||||||
<div class="flex flex-grow items-center justify-between lg:justify-end px-4 py-4 shadow-2 md:px-6 2xl:px-11">
|
<div class="flex flex-grow items-center justify-between lg:justify-end px-4 py-4 shadow-2 md:px-6 2xl:px-11">
|
||||||
<div class="flex items-center gap-2 sm:gap-4 lg:hidden">
|
<div class="flex items-center gap-2 sm:gap-4 lg:hidden w-2/6">
|
||||||
|
<section class="pr-1">
|
||||||
|
<img src={~p"/images/icon.png?cachebust=2024-03-20"} alt="Pinchflat" class="w-10" />
|
||||||
|
</section>
|
||||||
|
|
||||||
<button
|
<button
|
||||||
class="z-99999 block rounded-sm border border-stroke bg-white p-1.5 shadow-sm dark:border-strokedark dark:bg-boxdark lg:hidden"
|
class="z-99999 block mx-2 rounded-sm border border-stroke bg-white p-1.5 shadow-sm dark:border-strokedark dark:bg-boxdark lg:hidden"
|
||||||
@click.stop="sidebarVisible = !sidebarVisible"
|
@click.stop="sidebarVisible = !sidebarVisible"
|
||||||
>
|
>
|
||||||
<.icon name="hero-bars-3" />
|
<.icon name="hero-bars-3" />
|
||||||
</button>
|
</button>
|
||||||
<a class="hidden sm:flex items-center lg:hidden" href="/">
|
|
||||||
<img src={~p"/images/logo.png?cachebust=2024-02-29"} alt="Pinchflat" class="w-9 h-9" />
|
|
||||||
<h2 class="text-xl font-bold text-white pl-2">Pinchflat</h2>
|
|
||||||
</a>
|
|
||||||
</div>
|
</div>
|
||||||
<div class="bg-meta-4 rounded-md">
|
<div class="bg-meta-4 rounded-md w-4/6 lg:w-3/6 xl:w-2/6">
|
||||||
<div class="relative">
|
<div class="relative">
|
||||||
<span class="absolute left-2 top-1/2 -translate-y-1/2 flex">
|
<span class="absolute left-2 top-1/2 -translate-y-1/2 flex">
|
||||||
<.icon name="hero-magnifying-glass" />
|
<.icon name="hero-magnifying-glass" />
|
||||||
@@ -23,7 +23,7 @@
|
|||||||
name="q"
|
name="q"
|
||||||
value={@params["q"]}
|
value={@params["q"]}
|
||||||
placeholder="Type to search..."
|
placeholder="Type to search..."
|
||||||
class="w-full bg-transparent pl-9 pr-4 border-0 focus:ring-0 focus:outline-none lg:w-125"
|
class="w-full bg-transparent pl-9 pr-4 border-0 focus:ring-0 focus:outline-none"
|
||||||
/>
|
/>
|
||||||
</form>
|
</form>
|
||||||
</div>
|
</div>
|
||||||
|
|||||||
@@ -1,44 +1,45 @@
|
|||||||
<aside
|
<aside
|
||||||
x-bind:class="sidebarVisible ? 'translate-x-0' : '-translate-x-full'"
|
x-bind:class="sidebarVisible ? 'translate-x-0' : '-translate-x-full'"
|
||||||
class={[
|
class={[
|
||||||
"-translate-x-full absolute left-0 top-0 z-9999 flex h-screen w-60 flex-col overflow-y-hidden justify-between",
|
"-translate-x-full absolute left-0 top-0 z-9999 flex h-screen w-65 flex-col overflow-y-hidden justify-between",
|
||||||
"bg-black duration-300 ease-linear shadow-lg sm:shadow-none dark:bg-boxdark lg:static lg:translate-x-0"
|
"bg-black duration-300 ease-linear shadow-lg sm:shadow-none dark:bg-boxdark lg:static lg:translate-x-0"
|
||||||
]}
|
]}
|
||||||
@click.outside="sidebarVisible = false"
|
@click.outside="sidebarVisible = false"
|
||||||
>
|
>
|
||||||
<section>
|
<section>
|
||||||
<div class="flex items-center justify-between gap-2 px-6 py-5.5 lg:py-6.5">
|
<div class="flex items-center justify-between gap-2 px-6 py-4">
|
||||||
<a href="/" class="flex items-center">
|
<a href="/" class="flex items-center">
|
||||||
<img src={~p"/images/logo.png?cachebust=2024-02-29"} alt="Pinchflat" class="w-9 h-9" />
|
<img src={~p"/images/logo.png?cachebust=2024-03-20"} alt="Pinchflat" class="w-auto" />
|
||||||
<h2 class="text-xl font-bold text-white pl-2">Pinchflat</h2>
|
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
<button class="block lg:hidden" @click.stop="sidebarVisible = !sidebarVisible">
|
<button class="block mt-3 lg:hidden" @click.stop="sidebarVisible = !sidebarVisible">
|
||||||
<.icon name="hero-arrow-left" class="fill-current" />
|
<.icon name="hero-arrow-left" class="fill-current" />
|
||||||
</button>
|
</button>
|
||||||
</div>
|
</div>
|
||||||
<div class="no-scrollbar flex flex-col overflow-y-auto duration-300 ease-linear">
|
<div class="no-scrollbar flex flex-col overflow-y-auto duration-300 ease-linear">
|
||||||
<nav class="mt-5 px-4 py-4 lg:mt-9 lg:px-6">
|
<nav class="mt-3 px-4 py-4 lg:px-6">
|
||||||
<h3 class="mb-4 ml-4 text-sm font-medium text-bodydark2">MENU</h3>
|
<h3 class="mb-4 ml-4 text-sm font-medium text-bodydark2">MENU</h3>
|
||||||
<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_item icon="hero-cog-6-tooth" text="Settings" href={~p"/settings"} />
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
</nav>
|
</nav>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<nav class="mt-5 px-4 py-4 lg:mt-9 lg:px-6">
|
<nav class="px-4 py-4 lg:px-6">
|
||||||
<ul class="mb-6 flex flex-col gap-1.5">
|
<ul class="mb-6 flex flex-col gap-1.5">
|
||||||
<.sidebar_item
|
<.sidebar_item
|
||||||
icon="hero-code-bracket"
|
icon="hero-book-open"
|
||||||
text="Github"
|
text="Docs"
|
||||||
target="_blank"
|
target="_blank"
|
||||||
href="https://github.com/kieraneglin/pinchflat"
|
href="https://github.com/kieraneglin/pinchflat/wiki"
|
||||||
/>
|
/>
|
||||||
|
<.sidebar_item icon="hero-cog" text="Github" target="_blank" href="https://github.com/kieraneglin/pinchflat" />
|
||||||
<li>
|
<li>
|
||||||
<span
|
<span
|
||||||
class={[
|
class={[
|
||||||
@@ -52,6 +53,14 @@
|
|||||||
<.icon name="hero-currency-dollar" /> Donate
|
<.icon name="hero-currency-dollar" /> Donate
|
||||||
</span>
|
</span>
|
||||||
</li>
|
</li>
|
||||||
|
<li>
|
||||||
|
<span class="group relative flex items-center gap-2.5 px-4 pt-2 text-sm">
|
||||||
|
Pinchflat v<%= Application.spec(:pinchflat)[:vsn] %>
|
||||||
|
</span>
|
||||||
|
<span class="group relative flex items-center gap-2.5 px-4 text-sm">
|
||||||
|
yt-dlp <%= Settings.get!(:yt_dlp_version) %>
|
||||||
|
</span>
|
||||||
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</nav>
|
</nav>
|
||||||
</section>
|
</section>
|
||||||
|
|||||||
@@ -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"
|
||||||
@@ -30,7 +31,7 @@ defmodule Pinchflat.UpgradeButtonLive do
|
|||||||
|> 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
|
||||||
|
|||||||
@@ -8,7 +8,7 @@
|
|||||||
<%= assigns[:page_title] || "Pinchflat" %>
|
<%= assigns[:page_title] || "Pinchflat" %>
|
||||||
</.live_title>
|
</.live_title>
|
||||||
<link phx-track-static rel="stylesheet" href={~p"/assets/app.css"} />
|
<link phx-track-static rel="stylesheet" href={~p"/assets/app.css"} />
|
||||||
<link rel="icon" type="image/x-icon" href={~p"/favicon.ico?cachebust=2024-02-29"} />
|
<link rel="icon" type="image/x-icon" href={~p"/favicon.ico?cachebust=2024-03-20"} />
|
||||||
<script defer phx-track-static type="text/javascript" src={~p"/assets/app.js"}>
|
<script defer phx-track-static type="text/javascript" src={~p"/assets/app.js"}>
|
||||||
</script>
|
</script>
|
||||||
</head>
|
</head>
|
||||||
|
|||||||
@@ -0,0 +1,9 @@
|
|||||||
|
defmodule PinchflatWeb.HealthController do
|
||||||
|
use PinchflatWeb, :controller
|
||||||
|
|
||||||
|
def check(conn, _params) do
|
||||||
|
conn
|
||||||
|
|> put_status(:ok)
|
||||||
|
|> json(%{status: "ok"})
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -1,8 +1,12 @@
|
|||||||
defmodule PinchflatWeb.MediaItems.MediaItemController do
|
defmodule PinchflatWeb.MediaItems.MediaItemController do
|
||||||
use PinchflatWeb, :controller
|
use PinchflatWeb, :controller
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
alias Pinchflat.Repo
|
alias Pinchflat.Repo
|
||||||
alias Pinchflat.Media
|
alias Pinchflat.Media
|
||||||
|
alias Pinchflat.Media.MediaItem
|
||||||
|
alias Pinchflat.Downloading.MediaDownloadWorker
|
||||||
|
|
||||||
def show(conn, %{"id" => id}) do
|
def show(conn, %{"id" => id}) do
|
||||||
media_item =
|
media_item =
|
||||||
@@ -13,20 +17,114 @@ defmodule PinchflatWeb.MediaItems.MediaItemController do
|
|||||||
render(conn, :show, media_item: media_item)
|
render(conn, :show, media_item: media_item)
|
||||||
end
|
end
|
||||||
|
|
||||||
def delete(conn, %{"id" => id} = params) do
|
def edit(conn, %{"id" => id}) do
|
||||||
delete_files = Map.get(params, "delete_files", false)
|
|
||||||
media_item = Media.get_media_item!(id)
|
media_item = Media.get_media_item!(id)
|
||||||
{:ok, _} = Media.delete_media_item(media_item, delete_files: delete_files)
|
changeset = Media.change_media_item(media_item)
|
||||||
|
|
||||||
flash_message =
|
render(conn, :edit, media_item: media_item, changeset: changeset)
|
||||||
if delete_files do
|
end
|
||||||
"Record and files deleted successfully."
|
|
||||||
else
|
def update(conn, %{"id" => id, "media_item" => params}) do
|
||||||
"Record deleted successfully. Files were not deleted."
|
media_item = Media.get_media_item!(id)
|
||||||
|
|
||||||
|
case Media.update_media_item(media_item, params) do
|
||||||
|
{:ok, media_item} ->
|
||||||
|
conn
|
||||||
|
|> put_flash(:info, "Media Item updated successfully.")
|
||||||
|
|> redirect(to: ~p"/sources/#{media_item.source_id}/media/#{media_item}")
|
||||||
|
|
||||||
|
{:error, %Ecto.Changeset{} = changeset} ->
|
||||||
|
render(conn, :edit, media_item: media_item, changeset: changeset)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def delete(conn, %{"id" => id} = params) do
|
||||||
|
prevent_download = Map.get(params, "prevent_download", false)
|
||||||
|
media_item = Media.get_media_item!(id)
|
||||||
|
{:ok, _} = Media.delete_media_files(media_item, %{prevent_download: prevent_download})
|
||||||
|
|
||||||
|
conn
|
||||||
|
|> put_flash(:info, "Files deleted successfully.")
|
||||||
|
|> redirect(to: ~p"/sources/#{media_item.source_id}")
|
||||||
|
end
|
||||||
|
|
||||||
|
def force_download(conn, %{"media_item_id" => id}) do
|
||||||
|
media_item = Media.get_media_item!(id)
|
||||||
|
|
||||||
|
:ok =
|
||||||
|
case MediaDownloadWorker.kickoff_with_task(media_item, %{force: true}) do
|
||||||
|
{:ok, _} -> :ok
|
||||||
|
{:error, :duplicate_job} -> :ok
|
||||||
|
err -> err
|
||||||
end
|
end
|
||||||
|
|
||||||
conn
|
conn
|
||||||
|> put_flash(:info, flash_message)
|
|> put_flash(:info, "Download task enqueued.")
|
||||||
|> redirect(to: ~p"/sources/#{media_item.source_id}")
|
|> redirect(to: ~p"/sources/#{media_item.source_id}/media/#{media_item}")
|
||||||
|
end
|
||||||
|
|
||||||
|
# See here for details on streaming files and range requests:
|
||||||
|
# https://www.zeng.dev/post/2023-http-range-and-play-mp4-in-browser/
|
||||||
|
#
|
||||||
|
# Uses the UUID instead of the ID to avoid enumeration attacks
|
||||||
|
# since streaming is a public endpoint (ie: no auth required)
|
||||||
|
def stream(conn, %{"uuid" => uuid}) do
|
||||||
|
media_item = Repo.get_by!(MediaItem, uuid: uuid)
|
||||||
|
|
||||||
|
if File.exists?(media_item.media_filepath) do
|
||||||
|
file_size = File.stat!(media_item.media_filepath).size
|
||||||
|
mime_type = MIME.from_path(media_item.media_filepath)
|
||||||
|
|
||||||
|
case parse_range(conn, file_size) do
|
||||||
|
{:ok, {start_pos, end_pos}} ->
|
||||||
|
Logger.debug("Streaming media item: #{media_item.uuid} from #{start_pos} to #{end_pos}")
|
||||||
|
length = end_pos - start_pos + 1
|
||||||
|
|
||||||
|
conn
|
||||||
|
|> put_resp_content_type(mime_type)
|
||||||
|
|> put_resp_header("accept-ranges", "bytes")
|
||||||
|
|> put_resp_header("content-range", "bytes #{start_pos}-#{end_pos}/#{file_size}")
|
||||||
|
|> put_resp_header("content-length", to_string(length))
|
||||||
|
|> send_file(206, media_item.media_filepath, start_pos, length)
|
||||||
|
|
||||||
|
{:error, :invalid_range} ->
|
||||||
|
Logger.debug("Invalid range request for media item: #{media_item.uuid} - serving full file")
|
||||||
|
|
||||||
|
conn
|
||||||
|
|> put_resp_content_type(mime_type)
|
||||||
|
|> put_resp_header("content-length", to_string(file_size))
|
||||||
|
|> put_resp_header("accept-ranges", "bytes")
|
||||||
|
|> send_file(200, media_item.media_filepath)
|
||||||
|
end
|
||||||
|
else
|
||||||
|
send_resp(conn, 404, "File not found")
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp parse_range(conn, file_size) do
|
||||||
|
with [range_header | _] <- get_req_header(conn, "range"),
|
||||||
|
["bytes", range] <- String.split(range_header, "="),
|
||||||
|
[start_pos, end_pos] <- String.split(range, "-") do
|
||||||
|
validate_range(start_pos, end_pos, file_size)
|
||||||
|
else
|
||||||
|
_ -> {:error, :invalid_range}
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp validate_range(start_pos, end_pos, file_size) do
|
||||||
|
case {Integer.parse(start_pos), Integer.parse(end_pos)} do
|
||||||
|
{:error, :error} ->
|
||||||
|
{:error, :invalid_range}
|
||||||
|
|
||||||
|
{{start_pos, _}, :error} ->
|
||||||
|
{:ok, {start_pos, file_size - 1}}
|
||||||
|
|
||||||
|
# See RFC7233
|
||||||
|
{{start_pos, _}, {end_pos, _}} when end_pos >= file_size ->
|
||||||
|
{:ok, {start_pos, file_size - 1}}
|
||||||
|
|
||||||
|
{{start_pos, _}, {end_pos, _}} ->
|
||||||
|
{:ok, {start_pos, end_pos}}
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -2,4 +2,24 @@ defmodule PinchflatWeb.MediaItems.MediaItemHTML do
|
|||||||
use PinchflatWeb, :html
|
use PinchflatWeb, :html
|
||||||
|
|
||||||
embed_templates "media_item_html/*"
|
embed_templates "media_item_html/*"
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Renders a media item form.
|
||||||
|
"""
|
||||||
|
attr :changeset, Ecto.Changeset, required: true
|
||||||
|
attr :action, :string, required: true
|
||||||
|
|
||||||
|
def media_item_form(assigns)
|
||||||
|
|
||||||
|
def media_file_exists?(media_item) do
|
||||||
|
!!media_item.media_filepath and File.exists?(media_item.media_filepath)
|
||||||
|
end
|
||||||
|
|
||||||
|
def media_type(media_item) do
|
||||||
|
case Path.extname(media_item.media_filepath) do
|
||||||
|
ext when ext in [".mp4", ".webm", ".mkv"] -> :video
|
||||||
|
ext when ext in [".mp3", ".m4a"] -> :audio
|
||||||
|
_ -> :unknown
|
||||||
|
end
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -0,0 +1,32 @@
|
|||||||
|
<.button_dropdown text="Actions" class="justify-center w-full sm:w-50">
|
||||||
|
<:option>
|
||||||
|
<.link
|
||||||
|
href={~p"/sources/#{@media_item.source_id}/media/#{@media_item}/force_download"}
|
||||||
|
method="post"
|
||||||
|
data-confirm="Are you sure you force a download of this media?"
|
||||||
|
>
|
||||||
|
Force Download
|
||||||
|
</.link>
|
||||||
|
</:option>
|
||||||
|
<:option>
|
||||||
|
<div class="h-px w-full bg-bodydark2"></div>
|
||||||
|
</:option>
|
||||||
|
<:option>
|
||||||
|
<.link
|
||||||
|
href={~p"/sources/#{@media_item.source_id}/media/#{@media_item}"}
|
||||||
|
method="delete"
|
||||||
|
data-confirm="Are you sure you want to delete all files for this media item? This cannot be undone."
|
||||||
|
>
|
||||||
|
Delete Files
|
||||||
|
</.link>
|
||||||
|
</:option>
|
||||||
|
<:option>
|
||||||
|
<.link
|
||||||
|
href={~p"/sources/#{@media_item.source_id}/media/#{@media_item}?prevent_download=true"}
|
||||||
|
method="delete"
|
||||||
|
data-confirm="Are you sure you want to delete all files for this media item and prevent it from re-downloading in the future? This cannot be undone."
|
||||||
|
>
|
||||||
|
Delete and Ignore
|
||||||
|
</.link>
|
||||||
|
</:option>
|
||||||
|
</.button_dropdown>
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
<div class="mb-6 flex gap-3 flex-row items-center">
|
||||||
|
<h2 class="text-title-md2 font-bold text-black dark:text-white ml-4">
|
||||||
|
Editing "<%= StringUtils.truncate(@media_item.title, 35) %>"
|
||||||
|
</h2>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="rounded-sm border border-stroke bg-white px-5 pb-2.5 pt-6 shadow-default dark:border-strokedark dark:bg-boxdark sm:px-7.5 xl:pb-1">
|
||||||
|
<div class="max-w-full overflow-x-auto">
|
||||||
|
<div class="flex flex-col gap-10">
|
||||||
|
<.media_item_form changeset={@changeset} action={~p"/sources/#{@media_item.source_id}/media/#{@media_item}"} />
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
<.simple_form
|
||||||
|
:let={f}
|
||||||
|
for={@changeset}
|
||||||
|
action={@action}
|
||||||
|
x-data="{ advancedMode: !!JSON.parse(localStorage.getItem('advancedMode')) }"
|
||||||
|
x-init="$watch('advancedMode', value => localStorage.setItem('advancedMode', JSON.stringify(value)))"
|
||||||
|
>
|
||||||
|
<.error :if={@changeset.action}>
|
||||||
|
Oops, something went wrong! Please check the errors below.
|
||||||
|
</.error>
|
||||||
|
|
||||||
|
<h3 class=" text-2xl text-black dark:text-white">
|
||||||
|
General Options
|
||||||
|
</h3>
|
||||||
|
|
||||||
|
<.input
|
||||||
|
field={f[:prevent_download]}
|
||||||
|
type="toggle"
|
||||||
|
label="Prevent Download"
|
||||||
|
help="Checking excludes this media item from automatic download. Download can still be manually forced"
|
||||||
|
/>
|
||||||
|
|
||||||
|
<.input
|
||||||
|
field={f[:prevent_culling]}
|
||||||
|
type="toggle"
|
||||||
|
label="Prevent Automatic Deletion"
|
||||||
|
help="Checking excludes media from being automatically deleted based on media retention rules"
|
||||||
|
/>
|
||||||
|
|
||||||
|
<.button class="my-10 sm:mb-7.5 w-full sm:w-auto" rounding="rounded-lg">Save Media Item</.button>
|
||||||
|
</.simple_form>
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
<%= if media_type(@media_item) == :video do %>
|
||||||
|
<video controls class="max-h-96 w-full">
|
||||||
|
<source src={~p"/media/#{@media_item.uuid}/stream"} type="video/mp4" />
|
||||||
|
Your browser does not support the video element.
|
||||||
|
</video>
|
||||||
|
<% end %>
|
||||||
|
|
||||||
|
<%= if media_type(@media_item) == :audio do %>
|
||||||
|
<audio controls class="w-full">
|
||||||
|
<source src={~p"/media/#{@media_item.uuid}/stream"} type="audio/mpeg" />
|
||||||
|
Your browser does not support the audio element.
|
||||||
|
</audio>
|
||||||
|
<% end %>
|
||||||
@@ -4,37 +4,53 @@
|
|||||||
<.icon name="hero-arrow-left" class="w-10 h-10 hover:dark:text-white" />
|
<.icon name="hero-arrow-left" class="w-10 h-10 hover:dark:text-white" />
|
||||||
</.link>
|
</.link>
|
||||||
<h2 class="text-title-md2 font-bold text-black dark:text-white ml-4">
|
<h2 class="text-title-md2 font-bold text-black dark:text-white ml-4">
|
||||||
Media Item #<%= @media_item.id %>
|
<%= StringUtils.truncate(@media_item.title, 35) %>
|
||||||
</h2>
|
</h2>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<nav>
|
||||||
|
<.link href={~p"/sources/#{@media_item.source_id}/media/#{@media_item}/edit"}>
|
||||||
|
<.button color="bg-primary" rounding="rounded-lg">
|
||||||
|
<.icon name="hero-pencil-square" class="mr-2" /> Edit
|
||||||
|
</.button>
|
||||||
|
</.link>
|
||||||
|
</nav>
|
||||||
</div>
|
</div>
|
||||||
<div class="rounded-sm border border-stroke bg-white py-5 pt-6 shadow-default dark:border-strokedark dark:bg-boxdark sm:px-7.5">
|
<div class="rounded-sm border border-stroke bg-white py-5 pt-6 shadow-default dark:border-strokedark dark:bg-boxdark px-7.5">
|
||||||
<div class="max-w-full overflow-x-auto">
|
<div class="max-w-full overflow-x-auto">
|
||||||
<.tabbed_layout>
|
<.tabbed_layout>
|
||||||
<:tab title="Attributes">
|
<:tab_append>
|
||||||
|
<.actions_dropdown media_item={@media_item} />
|
||||||
|
</:tab_append>
|
||||||
|
|
||||||
|
<:tab title="Media">
|
||||||
<div class="flex flex-col gap-10 dark:text-white">
|
<div class="flex flex-col gap-10 dark:text-white">
|
||||||
<h3 class="font-bold text-xl">Attributes</h3>
|
<%= if media_file_exists?(@media_item) do %>
|
||||||
|
<section class="grid grid-cols-1 xl:grid-cols-2 xl:gap-6 mt-6">
|
||||||
|
<div>
|
||||||
|
<.media_preview media_item={@media_item} />
|
||||||
|
</div>
|
||||||
|
<aside class="mt-4 xl:mt-0">
|
||||||
|
<div>Uploaded: <%= @media_item.upload_date %></div>
|
||||||
|
<div>
|
||||||
|
<.subtle_link href={@media_item.original_url} target="_blank">Open Original</.subtle_link>
|
||||||
|
</div>
|
||||||
|
<div class="mt-4 text-bodydark">
|
||||||
|
<.break_on_newline text={@media_item.description} />
|
||||||
|
</div>
|
||||||
|
</aside>
|
||||||
|
</section>
|
||||||
|
<% end %>
|
||||||
|
|
||||||
|
<h3 class="font-bold text-xl mt-6">Raw Attributes</h3>
|
||||||
<section>
|
<section>
|
||||||
<strong>Source:</strong>
|
<strong>Source:</strong>
|
||||||
<.inline_link href={~p"/sources/#{@media_item.source_id}"}>
|
<.subtle_link href={~p"/sources/#{@media_item.source_id}"}>
|
||||||
<%= @media_item.source.custom_name %>
|
<%= @media_item.source.custom_name %>
|
||||||
</.inline_link>
|
</.subtle_link>
|
||||||
|
<.list_items_from_map map={Map.from_struct(@media_item)} />
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
<.list_items_from_map map={Map.from_struct(@media_item)} />
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<section class="flex justify-center my-10">
|
|
||||||
<.link
|
|
||||||
href={~p"/sources/#{@media_item.source_id}/media/#{@media_item}?delete_files=true"}
|
|
||||||
method="delete"
|
|
||||||
data-confirm="Are you sure you want to delete this record and all associated files on disk? This cannot be undone."
|
|
||||||
>
|
|
||||||
<.button color="bg-meta-1" rounding="rounded-full">
|
|
||||||
Delete Files
|
|
||||||
</.button>
|
|
||||||
</.link>
|
|
||||||
</section>
|
|
||||||
</:tab>
|
</:tab>
|
||||||
<:tab title="Tasks">
|
<:tab title="Tasks">
|
||||||
<%= if match?([_|_], @media_item.tasks) do %>
|
<%= if match?([_|_], @media_item.tasks) do %>
|
||||||
|
|||||||
@@ -1,12 +1,19 @@
|
|||||||
defmodule PinchflatWeb.MediaProfiles.MediaProfileController do
|
defmodule PinchflatWeb.MediaProfiles.MediaProfileController do
|
||||||
use PinchflatWeb, :controller
|
use PinchflatWeb, :controller
|
||||||
|
|
||||||
|
import Ecto.Query, warn: false
|
||||||
|
|
||||||
alias Pinchflat.Repo
|
alias Pinchflat.Repo
|
||||||
alias Pinchflat.Profiles
|
alias Pinchflat.Profiles
|
||||||
|
alias Pinchflat.Sources.SourcesQuery
|
||||||
alias Pinchflat.Profiles.MediaProfile
|
alias Pinchflat.Profiles.MediaProfile
|
||||||
|
|
||||||
def index(conn, _params) do
|
def index(conn, _params) do
|
||||||
media_profiles = Profiles.list_media_profiles()
|
media_profiles =
|
||||||
|
MediaProfile
|
||||||
|
|> order_by(asc: :name)
|
||||||
|
|> Repo.all()
|
||||||
|
|
||||||
render(conn, :index, media_profiles: media_profiles)
|
render(conn, :index, media_profiles: media_profiles)
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -32,12 +39,15 @@ defmodule PinchflatWeb.MediaProfiles.MediaProfileController do
|
|||||||
end
|
end
|
||||||
|
|
||||||
def show(conn, %{"id" => id}) do
|
def show(conn, %{"id" => id}) do
|
||||||
media_profile =
|
media_profile = Profiles.get_media_profile!(id)
|
||||||
id
|
|
||||||
|> Profiles.get_media_profile!()
|
|
||||||
|> Repo.preload(:sources)
|
|
||||||
|
|
||||||
render(conn, :show, media_profile: media_profile)
|
sources =
|
||||||
|
SourcesQuery.new()
|
||||||
|
|> SourcesQuery.for_media_profile(media_profile)
|
||||||
|
|> order_by(asc: :custom_name)
|
||||||
|
|> Repo.all()
|
||||||
|
|
||||||
|
render(conn, :show, media_profile: media_profile, sources: sources)
|
||||||
end
|
end
|
||||||
|
|
||||||
def edit(conn, %{"id" => id}) do
|
def edit(conn, %{"id" => id}) do
|
||||||
|
|||||||
@@ -1,6 +1,8 @@
|
|||||||
defmodule PinchflatWeb.MediaProfiles.MediaProfileHTML do
|
defmodule PinchflatWeb.MediaProfiles.MediaProfileHTML do
|
||||||
use PinchflatWeb, :html
|
use PinchflatWeb, :html
|
||||||
|
|
||||||
|
alias Pinchflat.Profiles.MediaProfile
|
||||||
|
|
||||||
embed_templates "media_profile_html/*"
|
embed_templates "media_profile_html/*"
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
@@ -30,6 +32,26 @@ defmodule PinchflatWeb.MediaProfiles.MediaProfileHTML do
|
|||||||
]
|
]
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def friendly_sponsorblock_options do
|
||||||
|
[
|
||||||
|
{"Disabled (default)", "disabled"},
|
||||||
|
{"Remove Segments", "remove"}
|
||||||
|
]
|
||||||
|
end
|
||||||
|
|
||||||
|
def frieldly_sponsorblock_categories do
|
||||||
|
[
|
||||||
|
{"Sponsor", "sponsor"},
|
||||||
|
{"Intro/Intermission", "intro"},
|
||||||
|
{"Outro/Credits", "outro"},
|
||||||
|
{"Self Promotion", "selfpromo"},
|
||||||
|
{"Preview/Recap", "preview"},
|
||||||
|
{"Filler Tangent", "filler"},
|
||||||
|
{"Interaction Reminder", "interaction"},
|
||||||
|
{"Non-music Section", "music_offtopic"}
|
||||||
|
]
|
||||||
|
end
|
||||||
|
|
||||||
def custom_output_template_options do
|
def custom_output_template_options do
|
||||||
%{
|
%{
|
||||||
upload_day: nil,
|
upload_day: nil,
|
||||||
@@ -37,7 +59,11 @@ defmodule PinchflatWeb.MediaProfiles.MediaProfileHTML do
|
|||||||
upload_year: nil,
|
upload_year: nil,
|
||||||
upload_yyyy_mm_dd: "the upload date in the format YYYY-MM-DD",
|
upload_yyyy_mm_dd: "the upload date in the format YYYY-MM-DD",
|
||||||
source_custom_name: "the name of the sources that use this profile",
|
source_custom_name: "the name of the sources that use this profile",
|
||||||
source_collection_type: "the collection type of the sources that use this profile. Either 'channel' or 'playlist'"
|
source_collection_id: "the YouTube ID of the sources that use this profile",
|
||||||
|
source_collection_name:
|
||||||
|
"the YouTube name of the sources that use this profile (often the same as source_custom_name)",
|
||||||
|
source_collection_type: "the collection type of the sources using this profile. Either 'channel' or 'playlist'",
|
||||||
|
artist_name: "the name of the artist with fallbacks to other uploader fields"
|
||||||
}
|
}
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -53,4 +79,25 @@ defmodule PinchflatWeb.MediaProfiles.MediaProfileHTML do
|
|||||||
duration_string
|
duration_string
|
||||||
)a
|
)a
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def preset_options do
|
||||||
|
[
|
||||||
|
{"Default", "default"},
|
||||||
|
{"Media Center (Plex, Jellyfin, Kodi, etc.)", "media_center"},
|
||||||
|
{"Music", "audio"},
|
||||||
|
{"Archiving", "archiving"}
|
||||||
|
]
|
||||||
|
end
|
||||||
|
|
||||||
|
defp default_output_template do
|
||||||
|
%MediaProfile{}.output_path_template
|
||||||
|
end
|
||||||
|
|
||||||
|
defp media_center_output_template do
|
||||||
|
"/shows/{{ source_custom_name }}/Season {{ season_from_date }}/{{ season_episode_from_date }} - {{ title }}.{{ ext }}"
|
||||||
|
end
|
||||||
|
|
||||||
|
defp audio_output_template do
|
||||||
|
"/music/{{ artist_name }}/{{ title }}.{{ ext }}"
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -2,7 +2,9 @@
|
|||||||
<.link href={~p"/media_profiles"}>
|
<.link href={~p"/media_profiles"}>
|
||||||
<.icon name="hero-arrow-left" class="w-10 h-10 hover:dark:text-white" />
|
<.icon name="hero-arrow-left" class="w-10 h-10 hover:dark:text-white" />
|
||||||
</.link>
|
</.link>
|
||||||
<h2 class="text-title-md2 font-bold text-black dark:text-white ml-4">Edit Media Profile</h2>
|
<h2 class="text-title-md2 font-bold text-black dark:text-white ml-4">
|
||||||
|
Editing "<%= @media_profile.name %>"
|
||||||
|
</h2>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="rounded-sm border border-stroke bg-white px-5 pb-2.5 pt-6 shadow-default dark:border-strokedark dark:bg-boxdark sm:px-7.5 xl:pb-1">
|
<div class="rounded-sm border border-stroke bg-white px-5 pb-2.5 pt-6 shadow-default dark:border-strokedark dark:bg-boxdark sm:px-7.5 xl:pb-1">
|
||||||
|
|||||||
@@ -4,7 +4,7 @@
|
|||||||
</h2>
|
</h2>
|
||||||
<nav>
|
<nav>
|
||||||
<.link href={~p"/media_profiles/new"}>
|
<.link href={~p"/media_profiles/new"}>
|
||||||
<.button color="bg-primary" rounding="rounded-full">
|
<.button color="bg-primary" rounding="rounded-lg">
|
||||||
<span class="font-bold text-xl mx-2">+</span> New <span class="hidden sm:inline pl-1">Media Profile</span>
|
<span class="font-bold text-xl mx-2">+</span> New <span class="hidden sm:inline pl-1">Media Profile</span>
|
||||||
</.button>
|
</.button>
|
||||||
</.link>
|
</.link>
|
||||||
@@ -16,10 +16,9 @@
|
|||||||
<div class="flex flex-col gap-10 min-w-max">
|
<div class="flex flex-col gap-10 min-w-max">
|
||||||
<.table rows={@media_profiles} table_class="text-black dark:text-white">
|
<.table rows={@media_profiles} table_class="text-black dark:text-white">
|
||||||
<:col :let={media_profile} label="Name">
|
<:col :let={media_profile} label="Name">
|
||||||
<%= media_profile.name %>
|
<.subtle_link href={~p"/media_profiles/#{media_profile.id}"}>
|
||||||
</:col>
|
<%= media_profile.name %>
|
||||||
<:col :let={media_profile} label="Output Template">
|
</.subtle_link>
|
||||||
<code class="text-sm"><%= media_profile.output_path_template %></code>
|
|
||||||
</:col>
|
</:col>
|
||||||
<:col :let={media_profile} label="Preferred Resolution">
|
<:col :let={media_profile} label="Preferred Resolution">
|
||||||
<%= media_profile.preferred_resolution %>
|
<%= media_profile.preferred_resolution %>
|
||||||
|
|||||||
+269
-101
@@ -3,116 +3,284 @@
|
|||||||
Oops, something went wrong! Please check the errors below.
|
Oops, something went wrong! Please check the errors below.
|
||||||
</.error>
|
</.error>
|
||||||
|
|
||||||
<h3 class="my-4 text-2xl text-black dark:text-white">
|
<section x-data="{ selectedPreset: null }">
|
||||||
General Options
|
<h3 class="my-4 text-2xl text-black dark:text-white">
|
||||||
</h3>
|
Use a Preset
|
||||||
<.input
|
</h3>
|
||||||
field={f[:name]}
|
<section x-data="{ selection: null }">
|
||||||
type="text"
|
<.input
|
||||||
label="Name"
|
prompt="Select preset"
|
||||||
placeholder="New Profile"
|
name="media_profile_preset"
|
||||||
help="Something descriptive. Does not impact indexing or downloading (required)"
|
value=""
|
||||||
/>
|
options={preset_options()}
|
||||||
|
type="select"
|
||||||
|
x-model="selection"
|
||||||
|
inputclass="w-full"
|
||||||
|
help="You can further customize the settings after selecting a preset. This is just a starting point"
|
||||||
|
>
|
||||||
|
<.button
|
||||||
|
class="h-13 w-2/5 lg:w-1/5 ml-2 md:ml-4"
|
||||||
|
rounding="rounded"
|
||||||
|
type="button"
|
||||||
|
x-on:click="selectedPreset = selection; selection = null"
|
||||||
|
x-bind:disabled="!selection"
|
||||||
|
>
|
||||||
|
<span x-text="selection ? 'Load' : 'Select'">Select</span><span class="hidden lg:inline ml-1">Preset</span>
|
||||||
|
</.button>
|
||||||
|
</.input>
|
||||||
|
</section>
|
||||||
|
|
||||||
<.input
|
<h3 class="mt-8 text-2xl text-black dark:text-white">
|
||||||
field={f[:output_path_template]}
|
General Options
|
||||||
type="text"
|
</h3>
|
||||||
inputclass="font-mono"
|
|
||||||
label="Output path template"
|
|
||||||
help="Must end with .{{ ext }}. See below for more details. The default is good for most cases (required)"
|
|
||||||
/>
|
|
||||||
|
|
||||||
<h3 class="mt-8 text-2xl text-black dark:text-white">
|
<section x-data="{
|
||||||
Subtitle Options
|
presets: {
|
||||||
</h3>
|
default: 'Default',
|
||||||
<.input
|
media_center: 'TV Shows',
|
||||||
field={f[:download_subs]}
|
audio: 'Music',
|
||||||
type="toggle"
|
archiving: 'Archiving'
|
||||||
label="Download Subtitles"
|
}
|
||||||
help="Downloads subtitle files alongside media file"
|
}">
|
||||||
/>
|
<.input
|
||||||
<.input
|
field={f[:name]}
|
||||||
field={f[:download_auto_subs]}
|
type="text"
|
||||||
type="toggle"
|
label="Name"
|
||||||
label="Download Autogenerated Subtitles"
|
placeholder="New Profile"
|
||||||
help="Prefers normal subs but will download autogenerated if needed"
|
help="Something descriptive. Does not impact indexing or downloading (required)"
|
||||||
/>
|
x-init="$watch('selectedPreset', p => p && ($el.value = presets[p]))"
|
||||||
<.input
|
/>
|
||||||
field={f[:embed_subs]}
|
</section>
|
||||||
type="toggle"
|
|
||||||
label="Embed Subtitles"
|
|
||||||
help="Embeds subtitles in the video file itself, if supported (recommended)"
|
|
||||||
/>
|
|
||||||
<.input
|
|
||||||
field={f[:sub_langs]}
|
|
||||||
type="text"
|
|
||||||
label="Subtitle Languages"
|
|
||||||
help="Use commas for multiple languages (eg: en,de)"
|
|
||||||
/>
|
|
||||||
|
|
||||||
<h3 class="mt-8 text-2xl text-black dark:text-white">
|
<section x-data={"{
|
||||||
Thumbnail Options
|
presets: {
|
||||||
</h3>
|
default: '#{default_output_template()}',
|
||||||
<.input
|
media_center: '#{media_center_output_template()}',
|
||||||
field={f[:download_thumbnail]}
|
audio: '#{audio_output_template()}',
|
||||||
type="toggle"
|
archiving: '#{default_output_template()}'
|
||||||
label="Download Thumbnail"
|
}
|
||||||
help="Downloads thumbnail alongside media file"
|
}"}>
|
||||||
/>
|
<.input
|
||||||
<.input
|
field={f[:output_path_template]}
|
||||||
field={f[:embed_thumbnail]}
|
type="text"
|
||||||
type="toggle"
|
inputclass="font-mono"
|
||||||
label="Embed Thumbnail"
|
label="Output path template"
|
||||||
help="Embeds thumbnail in the video file itself, if supported (recommended)"
|
help="Must end with .{{ ext }}. See below for more details. The default is good for most cases (required)"
|
||||||
/>
|
x-init="$watch('selectedPreset', p => p && ($el.value = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
<h3 class="mt-8 text-2xl text-black dark:text-white">
|
<h3 class="mt-10 text-2xl text-black dark:text-white">
|
||||||
Metadata Options
|
Subtitle Options
|
||||||
</h3>
|
</h3>
|
||||||
<.input
|
|
||||||
field={f[:download_metadata]}
|
|
||||||
type="toggle"
|
|
||||||
label="Download Metadata"
|
|
||||||
help="Downloads metadata file alongside media file"
|
|
||||||
/>
|
|
||||||
<.input
|
|
||||||
field={f[:embed_metadata]}
|
|
||||||
type="toggle"
|
|
||||||
label="Embed Metadata"
|
|
||||||
help="Embeds metadata in the video file itself, if supported (recommended)"
|
|
||||||
/>
|
|
||||||
|
|
||||||
<h3 class="mt-8 text-2xl text-black dark:text-white">
|
<section x-data="{ presets: { default: true, media_center: true, audio: false, archiving: true } }">
|
||||||
Release Format Options
|
<.input
|
||||||
</h3>
|
field={f[:download_subs]}
|
||||||
|
type="toggle"
|
||||||
|
label="Download Subtitles"
|
||||||
|
help="Downloads subtitle files alongside media file"
|
||||||
|
x-init="$watch('selectedPreset', p => p && (enabled = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
<.input
|
<section x-data="{ presets: { default: false, media_center: false, audio: false, archiving: false } }">
|
||||||
field={f[:shorts_behaviour]}
|
<.input
|
||||||
options={friendly_format_type_options()}
|
field={f[:download_auto_subs]}
|
||||||
type="select"
|
type="toggle"
|
||||||
label="Include Shorts?"
|
label="Download Autogenerated Subtitles"
|
||||||
help="Experimental. Please report any issues on GitHub"
|
help="Prefers normal subs but will download autogenerated if needed. Requires 'Download Subtitles' to be enabled"
|
||||||
/>
|
x-init="$watch('selectedPreset', p => p && (enabled = presets[p]))"
|
||||||
<.input
|
/>
|
||||||
field={f[:livestream_behaviour]}
|
</section>
|
||||||
options={friendly_format_type_options()}
|
|
||||||
type="select"
|
|
||||||
label="Include Livestreams?"
|
|
||||||
/>
|
|
||||||
|
|
||||||
<h3 class="mt-8 text-2xl text-black dark:text-white">
|
<section x-data="{ presets: { default: true, media_center: true, audio: false, archiving: true } }">
|
||||||
Quality Options
|
<.input
|
||||||
</h3>
|
field={f[:embed_subs]}
|
||||||
|
type="toggle"
|
||||||
|
label="Embed Subtitles"
|
||||||
|
help="Downloads and embeds subtitles in the media file itself, if supported. Uneffected by 'Download Subtitles' (recommended)"
|
||||||
|
x-init="$watch('selectedPreset', p => p && (enabled = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
<.input
|
<section x-data="{ presets: { default: 'en', media_center: 'en', audio: '', archiving: 'all' } }">
|
||||||
field={f[:preferred_resolution]}
|
<.input
|
||||||
options={friendly_resolution_options()}
|
field={f[:sub_langs]}
|
||||||
type="select"
|
type="text"
|
||||||
label="Preferred Resolution"
|
label="Subtitle Languages"
|
||||||
help="Will grab the closest available resolution if your preferred is not available"
|
help="Use commas for multiple languages (eg: en,de)"
|
||||||
/>
|
x-init="$watch('selectedPreset', p => p && ($el.value = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
<.button class="my-10 sm:mb-7.5 w-full sm:w-auto">Save Media profile</.button>
|
<h3 class="mt-10 text-2xl text-black dark:text-white">
|
||||||
|
Thumbnail Options
|
||||||
|
</h3>
|
||||||
|
|
||||||
|
<section x-data="{ presets: { default: true, media_center: true, audio: false, archiving: true } }">
|
||||||
|
<.input
|
||||||
|
field={f[:download_thumbnail]}
|
||||||
|
type="toggle"
|
||||||
|
label="Download Thumbnail"
|
||||||
|
help="Downloads thumbnail alongside media file"
|
||||||
|
x-init="$watch('selectedPreset', p => p && (enabled = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section x-data="{ presets: { default: true, media_center: true, audio: true, archiving: true } }">
|
||||||
|
<.input
|
||||||
|
field={f[:embed_thumbnail]}
|
||||||
|
type="toggle"
|
||||||
|
label="Embed Thumbnail"
|
||||||
|
help="Downloads and embeds thumbnail in the media file itself, if supported. Uneffected by 'Download Thumbnail' (recommended)"
|
||||||
|
x-init="$watch('selectedPreset', p => p && (enabled = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<h3 class="mt-10 text-2xl text-black dark:text-white">
|
||||||
|
Metadata Options
|
||||||
|
</h3>
|
||||||
|
|
||||||
|
<section x-data="{ presets: { default: false, media_center: false, audio: false, archiving: true } }">
|
||||||
|
<.input
|
||||||
|
field={f[:download_metadata]}
|
||||||
|
type="toggle"
|
||||||
|
label="Download Metadata"
|
||||||
|
help="Downloads metadata file alongside media file"
|
||||||
|
x-init="$watch('selectedPreset', p => p && (enabled = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section x-data="{ presets: { default: true, media_center: true, audio: true, archiving: true } }">
|
||||||
|
<.input
|
||||||
|
field={f[:embed_metadata]}
|
||||||
|
type="toggle"
|
||||||
|
label="Embed Metadata"
|
||||||
|
help="Downloads and embeds metadata in the media file itself, if supported. Uneffected by 'Download Metadata' (recommended)"
|
||||||
|
x-init="$watch('selectedPreset', p => p && (enabled = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<h3 class="mt-10 text-2xl text-black dark:text-white">
|
||||||
|
Release Format Options
|
||||||
|
</h3>
|
||||||
|
|
||||||
|
<section x-data="{ presets: { default: 'include', media_center: 'exclude', audio: 'exclude', archiving: 'include' } }">
|
||||||
|
<.input
|
||||||
|
field={f[:shorts_behaviour]}
|
||||||
|
options={friendly_format_type_options()}
|
||||||
|
type="select"
|
||||||
|
label="Include Shorts"
|
||||||
|
help="Experimental. Please report any issues on GitHub"
|
||||||
|
x-init="$watch('selectedPreset', p => p && ($el.value = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section x-data="{ presets: { default: 'exclude', media_center: 'exclude', audio: 'exclude', archiving: 'include' } }">
|
||||||
|
<.input
|
||||||
|
field={f[:livestream_behaviour]}
|
||||||
|
options={friendly_format_type_options()}
|
||||||
|
type="select"
|
||||||
|
label="Include Livestreams"
|
||||||
|
help="Excludes media that comes from a past livestream"
|
||||||
|
x-init="$watch('selectedPreset', p => p && ($el.value = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<h3 class="mt-10 text-2xl text-black dark:text-white">
|
||||||
|
Quality Options
|
||||||
|
</h3>
|
||||||
|
|
||||||
|
<section x-data="{ presets: { default: '1080p', media_center: '1080p', audio: 'audio', archiving: '2160p' } }">
|
||||||
|
<.input
|
||||||
|
field={f[:preferred_resolution]}
|
||||||
|
options={friendly_resolution_options()}
|
||||||
|
type="select"
|
||||||
|
label="Preferred Resolution"
|
||||||
|
help="Will grab the closest available resolution if your preferred is not available. 'Audio Only' grabs the highest quality m4a"
|
||||||
|
x-init="$watch('selectedPreset', p => p && ($el.value = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section x-data="{ presets: { default: null, media_center: 1, audio: null, archiving: 1 } }">
|
||||||
|
<.input
|
||||||
|
field={f[:redownload_delay_days]}
|
||||||
|
type="number"
|
||||||
|
label="Redownload Delay (days)"
|
||||||
|
min="0"
|
||||||
|
help="Delay in days until new media is redownloaded. Redownloading new media can improve its quality or SponsorBlock tags. Leave blank to not redownload"
|
||||||
|
x-init="$watch('selectedPreset', p => p && ($el.value = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<h3 class="mt-8 text-2xl text-black dark:text-white">
|
||||||
|
Media Center Options
|
||||||
|
</h3>
|
||||||
|
<p class="text-sm mt-2 max-w-prose">
|
||||||
|
Everything in this section is experimental - please open a GitHub issue if you see something odd.
|
||||||
|
<strong>
|
||||||
|
These options only work if this Media Profile's output template is set to split media into seasons.
|
||||||
|
</strong>
|
||||||
|
Try the "Media Center" preset if you're not sure.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<section
|
||||||
|
phx-click={show_modal("upgrade-modal")}
|
||||||
|
x-data="{ presets: { default: false, media_center: true, audio: false, archiving: false } }"
|
||||||
|
>
|
||||||
|
<.input
|
||||||
|
field={f[:download_nfo]}
|
||||||
|
type="toggle"
|
||||||
|
label="Download NFO data"
|
||||||
|
label_suffix="(pro)"
|
||||||
|
help="Downloads NFO data alongside media file for use with Jellyfin, Kodi, etc."
|
||||||
|
x-init="$watch('selectedPreset', p => p && (enabled = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section x-data="{ presets: { default: false, media_center: true, audio: false, archiving: true } }">
|
||||||
|
<.input
|
||||||
|
field={f[:download_source_images]}
|
||||||
|
type="toggle"
|
||||||
|
label="Download Series Images"
|
||||||
|
help="Downloads poster and banner images for use with Plex, Jellyfin, Kodi, etc. Only works for full channels (not playlists)"
|
||||||
|
x-init="$watch('selectedPreset', p => p && (enabled = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<h3 class="mt-10 text-2xl text-black dark:text-white">
|
||||||
|
SponsorBlock Options
|
||||||
|
</h3>
|
||||||
|
|
||||||
|
<section x-data="{ sponsorblockBehaviour: null }">
|
||||||
|
<section x-data="{ presets: { default: 'disabled', media_center: 'disabled', audio: 'disabled', archiving: 'disabled' } }">
|
||||||
|
<.input
|
||||||
|
field={f[:sponsorblock_behaviour]}
|
||||||
|
options={friendly_sponsorblock_options()}
|
||||||
|
type="select"
|
||||||
|
label="SponsorBlock Behaviour"
|
||||||
|
help="Action to take when SponsorBlock segments are found. 'Disabled' won't take any action"
|
||||||
|
x-model="sponsorblockBehaviour"
|
||||||
|
x-init="
|
||||||
|
sponsorblockBehaviour = $el.value
|
||||||
|
$watch('selectedPreset', p => p && ($el.value = presets[p]))
|
||||||
|
"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section x-show="sponsorblockBehaviour !== 'disabled'" x-transition>
|
||||||
|
<.input
|
||||||
|
field={f[:sponsorblock_categories]}
|
||||||
|
options={frieldly_sponsorblock_categories()}
|
||||||
|
type="checkbox_group"
|
||||||
|
label="SponsorBlock Categories"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<.button class="my-10 sm:mb-7.5 w-full sm:w-auto" rounding="rounded-lg">Save Media profile</.button>
|
||||||
|
</section>
|
||||||
|
|
||||||
<div class="rounded-sm dark:bg-meta-4 p-4 md:p-6 mb-5">
|
<div class="rounded-sm dark:bg-meta-4 p-4 md:p-6 mb-5">
|
||||||
<.output_template_help />
|
<.output_template_help />
|
||||||
|
|||||||
@@ -4,13 +4,13 @@
|
|||||||
<.icon name="hero-arrow-left" class="w-10 h-10 hover:dark:text-white" />
|
<.icon name="hero-arrow-left" class="w-10 h-10 hover:dark:text-white" />
|
||||||
</.link>
|
</.link>
|
||||||
<h2 class="text-title-md2 font-bold text-black dark:text-white ml-2">
|
<h2 class="text-title-md2 font-bold text-black dark:text-white ml-2">
|
||||||
Media Profile <span class="hidden sm:inline">#<%= @media_profile.id %></span>
|
<%= @media_profile.name %>
|
||||||
</h2>
|
</h2>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav>
|
<nav>
|
||||||
<.link href={~p"/media_profiles/#{@media_profile}/edit"}>
|
<.link href={~p"/media_profiles/#{@media_profile}/edit"}>
|
||||||
<.button color="bg-primary" rounding="rounded-full">
|
<.button color="bg-primary" rounding="rounded-lg">
|
||||||
<.icon name="hero-pencil-square" class="mr-2" />Edit <span class="hidden sm:inline pl-1">Media Profile</span>
|
<.icon name="hero-pencil-square" class="mr-2" />Edit <span class="hidden sm:inline pl-1">Media Profile</span>
|
||||||
</.button>
|
</.button>
|
||||||
</.link>
|
</.link>
|
||||||
@@ -19,38 +19,42 @@
|
|||||||
<div class="rounded-sm border border-stroke bg-white px-5 pb-2.5 pt-6 shadow-default dark:border-strokedark dark:bg-boxdark sm:px-7.5 xl:pb-1">
|
<div class="rounded-sm border border-stroke bg-white px-5 pb-2.5 pt-6 shadow-default dark:border-strokedark dark:bg-boxdark sm:px-7.5 xl:pb-1">
|
||||||
<div class="max-w-full overflow-x-auto">
|
<div class="max-w-full overflow-x-auto">
|
||||||
<.tabbed_layout>
|
<.tabbed_layout>
|
||||||
<:tab title="Attributes">
|
<:tab_append>
|
||||||
|
<.button_dropdown text="Actions" class="justify-center w-full sm:w-50">
|
||||||
|
<:option>
|
||||||
|
<.link
|
||||||
|
href={~p"/media_profiles/#{@media_profile}"}
|
||||||
|
method="delete"
|
||||||
|
data-confirm="Are you sure you want to delete this profile and all its sources (leaving files in place)? This cannot be undone."
|
||||||
|
>
|
||||||
|
Delete Profile
|
||||||
|
</.link>
|
||||||
|
</:option>
|
||||||
|
<:option>
|
||||||
|
<.link
|
||||||
|
href={~p"/media_profiles/#{@media_profile}?delete_files=true"}
|
||||||
|
method="delete"
|
||||||
|
data-confirm="Are you sure you want to delete this profile, all its sources, and its files on disk? This cannot be undone."
|
||||||
|
class="mt-5 md:mt-0"
|
||||||
|
>
|
||||||
|
Delete Profile + Files
|
||||||
|
</.link>
|
||||||
|
</:option>
|
||||||
|
</.button_dropdown>
|
||||||
|
</:tab_append>
|
||||||
|
|
||||||
|
<:tab title="Media Profile">
|
||||||
<div class="flex flex-col gap-10 text-white">
|
<div class="flex flex-col gap-10 text-white">
|
||||||
<h3 class="font-bold text-xl">Attributes for "<%= @media_profile.name %>"</h3>
|
<h3 class="font-bold text-xl mt-6">Raw Attributes</h3>
|
||||||
<.list_items_from_map map={Map.from_struct(@media_profile)} />
|
<.list_items_from_map map={Map.from_struct(@media_profile)} />
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<section class="flex flex-col md:flex-row items-center md:justify-around my-10">
|
|
||||||
<.link
|
|
||||||
href={~p"/media_profiles/#{@media_profile}"}
|
|
||||||
method="delete"
|
|
||||||
data-confirm="Are you sure you want to delete this profile and all its sources (leaving files in place)? This cannot be undone."
|
|
||||||
>
|
|
||||||
<.button color="bg-meta-1" rounding="rounded-full">
|
|
||||||
Delete Profile and its Sources
|
|
||||||
</.button>
|
|
||||||
</.link>
|
|
||||||
<.link
|
|
||||||
href={~p"/media_profiles/#{@media_profile}?delete_files=true"}
|
|
||||||
method="delete"
|
|
||||||
data-confirm="Are you sure you want to delete this profile, all its sources, and its files on disk? This cannot be undone."
|
|
||||||
class="mt-5 md:mt-0"
|
|
||||||
>
|
|
||||||
<.button color="bg-meta-1" rounding="rounded-full">
|
|
||||||
Delete Profile, Sources, and Files
|
|
||||||
</.button>
|
|
||||||
</.link>
|
|
||||||
</section>
|
|
||||||
</:tab>
|
</:tab>
|
||||||
<:tab title="Sources">
|
<:tab title="Sources">
|
||||||
<.table rows={@media_profile.sources} table_class="text-black dark:text-white">
|
<.table rows={@sources} table_class="text-black dark:text-white">
|
||||||
<:col :let={source} label="Name">
|
<:col :let={source} label="Name">
|
||||||
<%= source.custom_name || source.collection_name %>
|
<.subtle_link href={~p"/sources/#{source.id}"}>
|
||||||
|
<%= source.custom_name || source.collection_name %>
|
||||||
|
</.subtle_link>
|
||||||
</:col>
|
</:col>
|
||||||
<:col :let={source} label="Type"><%= source.collection_type %></:col>
|
<:col :let={source} label="Type"><%= source.collection_type %></:col>
|
||||||
<:col :let={source} label="Should Download?">
|
<:col :let={source} label="Should Download?">
|
||||||
|
|||||||
@@ -11,7 +11,7 @@ defmodule PinchflatWeb.Pages.PageController do
|
|||||||
done_onboarding = params["onboarding"] == "0"
|
done_onboarding = params["onboarding"] == "0"
|
||||||
force_onboarding = params["onboarding"] == "1"
|
force_onboarding = params["onboarding"] == "1"
|
||||||
|
|
||||||
if done_onboarding, do: Settings.set!(:onboarding, false)
|
if done_onboarding, do: Settings.set(onboarding: false)
|
||||||
|
|
||||||
if force_onboarding || Settings.get!(:onboarding) do
|
if force_onboarding || Settings.get!(:onboarding) do
|
||||||
render_onboarding_page(conn)
|
render_onboarding_page(conn)
|
||||||
@@ -30,7 +30,7 @@ defmodule PinchflatWeb.Pages.PageController do
|
|||||||
end
|
end
|
||||||
|
|
||||||
defp render_onboarding_page(conn) do
|
defp render_onboarding_page(conn) do
|
||||||
Settings.set!(:onboarding, true)
|
Settings.set(onboarding: true)
|
||||||
|
|
||||||
conn
|
conn
|
||||||
|> render(:onboarding_checklist,
|
|> render(:onboarding_checklist,
|
||||||
|
|||||||
@@ -1,27 +1,27 @@
|
|||||||
<div class="grid grid-cols-1 gap-4 md:grid-cols-3">
|
<div class="grid grid-cols-1 gap-4 md:grid-cols-3">
|
||||||
<div class="rounded-sm border px-7.5 py-6 shadow-default border-strokedark bg-boxdark">
|
<div class="rounded-sm border px-7.5 py-6 shadow-default border-strokedark bg-boxdark">
|
||||||
<div class="mt-4 flex flex-col items-center justify-center">
|
<a href={~p"/media_profiles"} class="mt-4 flex flex-col items-center justify-center">
|
||||||
<span class="text-md font-medium">Media Profile(s)</span>
|
<span class="text-md font-medium">Media Profile(s)</span>
|
||||||
<h4 class="text-title-md font-bold text-white">
|
<h4 class="text-title-md font-bold text-white">
|
||||||
<%= @media_profile_count %>
|
<%= @media_profile_count %>
|
||||||
</h4>
|
</h4>
|
||||||
</div>
|
</a>
|
||||||
</div>
|
</div>
|
||||||
<div class="rounded-sm border px-7.5 py-6 shadow-default border-strokedark bg-boxdark">
|
<div class="rounded-sm border px-7.5 py-6 shadow-default border-strokedark bg-boxdark">
|
||||||
<div class="mt-4 flex flex-col items-center justify-center">
|
<a href={~p"/sources"} class="mt-4 flex flex-col items-center justify-center">
|
||||||
<span class="text-md font-medium">Source(s)</span>
|
<span class="text-md font-medium">Source(s)</span>
|
||||||
<h4 class="text-title-md font-bold text-white">
|
<h4 class="text-title-md font-bold text-white">
|
||||||
<%= @source_count %>
|
<%= @source_count %>
|
||||||
</h4>
|
</h4>
|
||||||
</div>
|
</a>
|
||||||
</div>
|
</div>
|
||||||
<div class="rounded-sm border px-7.5 py-6 shadow-default border-strokedark bg-boxdark">
|
<div class="rounded-sm border px-7.5 py-6 shadow-default border-strokedark bg-boxdark">
|
||||||
<div class="mt-4 flex flex-col items-center justify-center">
|
<span class="mt-4 flex flex-col items-center justify-center">
|
||||||
<span class="text-md font-medium">Media Item(s)</span>
|
<span class="text-md font-medium">Media Item(s)</span>
|
||||||
<h4 class="text-title-md font-bold text-white">
|
<h4 class="text-title-md font-bold text-white">
|
||||||
<%= @media_item_count %>
|
<%= @media_item_count %>
|
||||||
</h4>
|
</h4>
|
||||||
</div>
|
</span>
|
||||||
</div>
|
</div>
|
||||||
<span class="text-strokedark">I know this page isn't super useful yet, but give it time :)</span>
|
<span class="text-strokedark">I know this page isn't super useful yet, but give it time :)</span>
|
||||||
</div>
|
</div>
|
||||||
|
|||||||
@@ -11,7 +11,7 @@
|
|||||||
<p class="text-md text-bodydark">Don't worry, you can create more Media Profiles later!</p>
|
<p class="text-md text-bodydark">Don't worry, you can create more Media Profiles later!</p>
|
||||||
<div class="mt-8">
|
<div class="mt-8">
|
||||||
<.link href={~p"/media_profiles/new"}>
|
<.link href={~p"/media_profiles/new"}>
|
||||||
<.button color="bg-primary" rounding="rounded-full" disabled={@media_profiles_exist}>
|
<.button color="bg-primary" rounding="rounded-lg" disabled={@media_profiles_exist}>
|
||||||
<span class="font-bold mx-2">+</span> New Media Profile
|
<span class="font-bold mx-2">+</span> New Media Profile
|
||||||
</.button>
|
</.button>
|
||||||
</.link>
|
</.link>
|
||||||
@@ -25,7 +25,7 @@
|
|||||||
</p>
|
</p>
|
||||||
<div class="mt-8">
|
<div class="mt-8">
|
||||||
<.link href={~p"/sources/new"}>
|
<.link href={~p"/sources/new"}>
|
||||||
<.button color="bg-primary" rounding="rounded-full" disabled={not @media_profiles_exist}>
|
<.button color="bg-primary" rounding="rounded-lg" disabled={not @media_profiles_exist}>
|
||||||
<span class="font-bold mx-2">+</span> New Source
|
<span class="font-bold mx-2">+</span> New Source
|
||||||
</.button>
|
</.button>
|
||||||
</.link>
|
</.link>
|
||||||
@@ -40,7 +40,7 @@
|
|||||||
<p class="text-md text-bodydark">Feel free to add more Media Profiles or Sources in the meantime!</p>
|
<p class="text-md text-bodydark">Feel free to add more Media Profiles or Sources in the meantime!</p>
|
||||||
<div class="mt-8">
|
<div class="mt-8">
|
||||||
<.link href={~p"/?onboarding=0"}>
|
<.link href={~p"/?onboarding=0"}>
|
||||||
<.button color="bg-primary" rounding="rounded-full" disabled={not @sources_exist}>
|
<.button color="bg-primary" rounding="rounded-lg" disabled={not @sources_exist}>
|
||||||
Let's Go <span class="font-bold mx-2">🚀</span>
|
Let's Go <span class="font-bold mx-2">🚀</span>
|
||||||
</.button>
|
</.button>
|
||||||
</.link>
|
</.link>
|
||||||
|
|||||||
@@ -0,0 +1,43 @@
|
|||||||
|
defmodule PinchflatWeb.Podcasts.PodcastController do
|
||||||
|
use PinchflatWeb, :controller
|
||||||
|
|
||||||
|
alias Pinchflat.Repo
|
||||||
|
alias Pinchflat.Media.MediaQuery
|
||||||
|
alias Pinchflat.Sources.Source
|
||||||
|
alias Pinchflat.Podcasts.RssFeedBuilder
|
||||||
|
alias Pinchflat.Podcasts.PodcastHelpers
|
||||||
|
|
||||||
|
def rss_feed(conn, %{"uuid" => uuid}) do
|
||||||
|
source = Repo.get_by!(Source, uuid: uuid)
|
||||||
|
url_base = url(conn, ~p"/")
|
||||||
|
xml = RssFeedBuilder.build(source, limit: 300, url_base: url_base)
|
||||||
|
|
||||||
|
conn
|
||||||
|
|> put_resp_content_type("application/rss+xml")
|
||||||
|
|> put_resp_header("content-disposition", "inline")
|
||||||
|
|> send_resp(200, xml)
|
||||||
|
end
|
||||||
|
|
||||||
|
def feed_image(conn, %{"uuid" => uuid}) do
|
||||||
|
source = Repo.get_by!(Source, uuid: uuid)
|
||||||
|
|
||||||
|
# This is used to fetch a fallback cover image
|
||||||
|
# if the source doesn't have any usable images
|
||||||
|
media_items =
|
||||||
|
MediaQuery.new()
|
||||||
|
|> MediaQuery.for_source(source)
|
||||||
|
|> MediaQuery.with_media_filepath()
|
||||||
|
|> Repo.maybe_limit(1)
|
||||||
|
|> Repo.all()
|
||||||
|
|
||||||
|
case PodcastHelpers.select_cover_image(source, media_items) do
|
||||||
|
{:error, _} ->
|
||||||
|
send_resp(conn, 404, "Image not found")
|
||||||
|
|
||||||
|
{:ok, filepath} ->
|
||||||
|
conn
|
||||||
|
|> put_resp_content_type(MIME.from_path(filepath))
|
||||||
|
|> send_file(200, filepath)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
<div class="mb-6 flex gap-3 flex-row items-center justify-between">
|
<div class="mb-6 flex gap-3 flex-row items-center justify-between">
|
||||||
<h2 class="text-title-md2 font-bold text-black dark:text-white">
|
<h2 class="text-title-md2 font-bold text-black dark:text-white">
|
||||||
<span class="hidden sm:inline">Search </span>Results for "<%= StringUtils.truncate(@search_term, 50) %>"
|
Results for "<%= StringUtils.truncate(@search_term, 50) %>"
|
||||||
</h2>
|
</h2>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@@ -10,7 +10,7 @@
|
|||||||
<%= if match?([_|_], @search_results) do %>
|
<%= if match?([_|_], @search_results) do %>
|
||||||
<.table rows={@search_results} table_class="text-black dark:text-white">
|
<.table rows={@search_results} table_class="text-black dark:text-white">
|
||||||
<:col :let={result} label="Title">
|
<:col :let={result} label="Title">
|
||||||
<%= StringUtils.truncate(result.title, 40) %>
|
<%= result.title %>
|
||||||
</:col>
|
</:col>
|
||||||
<:col :let={result} label="Excerpt">
|
<:col :let={result} label="Excerpt">
|
||||||
<.highlight_search_terms text={result.matching_search_term} />
|
<.highlight_search_terms text={result.matching_search_term} />
|
||||||
|
|||||||
@@ -0,0 +1,26 @@
|
|||||||
|
defmodule PinchflatWeb.Settings.SettingController do
|
||||||
|
use PinchflatWeb, :controller
|
||||||
|
|
||||||
|
alias Pinchflat.Settings
|
||||||
|
|
||||||
|
def show(conn, _params) do
|
||||||
|
setting = Settings.record()
|
||||||
|
changeset = Settings.change_setting(setting)
|
||||||
|
|
||||||
|
render(conn, "show.html", changeset: changeset)
|
||||||
|
end
|
||||||
|
|
||||||
|
def update(conn, %{"setting" => setting_params}) do
|
||||||
|
setting = Settings.record()
|
||||||
|
|
||||||
|
case Settings.update_setting(setting, setting_params) do
|
||||||
|
{:ok, _} ->
|
||||||
|
conn
|
||||||
|
|> put_flash(:info, "Settings updated successfully.")
|
||||||
|
|> redirect(to: ~p"/settings")
|
||||||
|
|
||||||
|
{:error, %Ecto.Changeset{} = changeset} ->
|
||||||
|
render(conn, "show.html", changeset: changeset)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,20 @@
|
|||||||
|
defmodule PinchflatWeb.Settings.SettingHTML do
|
||||||
|
use PinchflatWeb, :html
|
||||||
|
|
||||||
|
embed_templates "setting_html/*"
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Renders a setting form.
|
||||||
|
"""
|
||||||
|
attr :changeset, Ecto.Changeset, required: true
|
||||||
|
attr :action, :string, required: true
|
||||||
|
|
||||||
|
def setting_form(assigns)
|
||||||
|
|
||||||
|
def apprise_server_help do
|
||||||
|
url = "https://github.com/caronc/apprise/wiki/URLBasics"
|
||||||
|
classes = "underline decoration-bodydark decoration-1 hover:decoration-white"
|
||||||
|
|
||||||
|
~s(Server endpoint for Apprise notifications when new media is found. See <a href="#{url}" class="#{classes}" target="_blank">Apprise docs</a> for more information)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
<.simple_form :let={f} for={@changeset} action={@action}>
|
||||||
|
<.error :if={@changeset.action}>
|
||||||
|
Oops, something went wrong! Please check the errors below.
|
||||||
|
</.error>
|
||||||
|
|
||||||
|
<h3 class="mt-8 text-2xl text-black dark:text-white">
|
||||||
|
Notification Settings
|
||||||
|
</h3>
|
||||||
|
|
||||||
|
<.input
|
||||||
|
field={f[:apprise_server]}
|
||||||
|
type="text"
|
||||||
|
label="Apprise Server"
|
||||||
|
help={apprise_server_help()}
|
||||||
|
html_help={true}
|
||||||
|
inputclass="font-mono text-sm"
|
||||||
|
placeholder="https://discordapp.com/api/webhooks/{WebhookID}/{WebhookToken}"
|
||||||
|
/>
|
||||||
|
|
||||||
|
<.button class="my-10 sm:mb-7.5 w-full sm:w-auto" rounding="rounded-lg">Save Settings</.button>
|
||||||
|
</.simple_form>
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
<div class="mb-6 flex gap-3 flex-row items-center justify-between">
|
||||||
|
<div class="flex gap-3 items-center">
|
||||||
|
<h2 class="text-title-md2 font-bold text-black dark:text-white ml-4">
|
||||||
|
Settings
|
||||||
|
</h2>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="rounded-sm border border-stroke bg-white px-5 py-5 shadow-default dark:border-strokedark dark:bg-boxdark sm:px-7.5">
|
||||||
|
<div class="max-w-full overflow-x-auto">
|
||||||
|
<.setting_form changeset={@changeset} action={~p"/settings"} />
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
@@ -1,15 +1,23 @@
|
|||||||
defmodule PinchflatWeb.Sources.SourceController do
|
defmodule PinchflatWeb.Sources.SourceController do
|
||||||
use PinchflatWeb, :controller
|
use PinchflatWeb, :controller
|
||||||
|
|
||||||
|
import Ecto.Query, warn: false
|
||||||
|
|
||||||
alias Pinchflat.Repo
|
alias Pinchflat.Repo
|
||||||
alias Pinchflat.Media
|
|
||||||
alias Pinchflat.Tasks
|
alias Pinchflat.Tasks
|
||||||
alias Pinchflat.Sources
|
alias Pinchflat.Sources
|
||||||
alias Pinchflat.Profiles
|
|
||||||
alias Pinchflat.Sources.Source
|
alias Pinchflat.Sources.Source
|
||||||
|
alias Pinchflat.Profiles.MediaProfile
|
||||||
|
alias Pinchflat.Downloading.DownloadingHelpers
|
||||||
|
alias Pinchflat.SlowIndexing.SlowIndexingHelpers
|
||||||
|
alias Pinchflat.Metadata.SourceMetadataStorageWorker
|
||||||
|
|
||||||
def index(conn, _params) do
|
def index(conn, _params) do
|
||||||
sources = Repo.preload(Sources.list_sources(), :media_profile)
|
sources =
|
||||||
|
Source
|
||||||
|
|> order_by(asc: :custom_name)
|
||||||
|
|> Repo.all()
|
||||||
|
|> Repo.preload(:media_profile)
|
||||||
|
|
||||||
render(conn, :index, sources: sources)
|
render(conn, :index, sources: sources)
|
||||||
end
|
end
|
||||||
@@ -46,16 +54,12 @@ defmodule PinchflatWeb.Sources.SourceController do
|
|||||||
def show(conn, %{"id" => id}) do
|
def show(conn, %{"id" => id}) do
|
||||||
source = Repo.preload(Sources.get_source!(id), :media_profile)
|
source = Repo.preload(Sources.get_source!(id), :media_profile)
|
||||||
|
|
||||||
pending_tasks = Repo.preload(Tasks.list_pending_tasks_for(:source_id, source.id), :job)
|
pending_tasks =
|
||||||
pending_media = Media.list_pending_media_items_for(source, limit: 100)
|
source
|
||||||
downloaded_media = Media.list_downloaded_media_items_for(source, limit: 100)
|
|> Tasks.list_tasks_for(nil, [:executing, :available, :scheduled, :retryable])
|
||||||
|
|> Repo.preload(:job)
|
||||||
|
|
||||||
render(conn, :show,
|
render(conn, :show, source: source, pending_tasks: pending_tasks)
|
||||||
source: source,
|
|
||||||
pending_tasks: pending_tasks,
|
|
||||||
pending_media: pending_media,
|
|
||||||
downloaded_media: downloaded_media
|
|
||||||
)
|
|
||||||
end
|
end
|
||||||
|
|
||||||
def edit(conn, %{"id" => id}) do
|
def edit(conn, %{"id" => id}) do
|
||||||
@@ -100,8 +104,46 @@ defmodule PinchflatWeb.Sources.SourceController do
|
|||||||
|> redirect(to: ~p"/sources")
|
|> redirect(to: ~p"/sources")
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def force_download(conn, %{"source_id" => id}) do
|
||||||
|
wrap_forced_action(
|
||||||
|
conn,
|
||||||
|
id,
|
||||||
|
"Forcing download of pending media items.",
|
||||||
|
&DownloadingHelpers.enqueue_pending_download_tasks/1
|
||||||
|
)
|
||||||
|
end
|
||||||
|
|
||||||
|
def force_index(conn, %{"source_id" => id}) do
|
||||||
|
wrap_forced_action(
|
||||||
|
conn,
|
||||||
|
id,
|
||||||
|
"Index enqueued.",
|
||||||
|
&SlowIndexingHelpers.kickoff_indexing_task(&1, %{force: true})
|
||||||
|
)
|
||||||
|
end
|
||||||
|
|
||||||
|
def force_metadata_refresh(conn, %{"source_id" => id}) do
|
||||||
|
wrap_forced_action(
|
||||||
|
conn,
|
||||||
|
id,
|
||||||
|
"Metadata refresh enqueued.",
|
||||||
|
&SourceMetadataStorageWorker.kickoff_with_task/1
|
||||||
|
)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp wrap_forced_action(conn, source_id, message, fun) do
|
||||||
|
source = Sources.get_source!(source_id)
|
||||||
|
fun.(source)
|
||||||
|
|
||||||
|
conn
|
||||||
|
|> put_flash(:info, message)
|
||||||
|
|> redirect(to: ~p"/sources/#{source}")
|
||||||
|
end
|
||||||
|
|
||||||
defp media_profiles do
|
defp media_profiles do
|
||||||
Profiles.list_media_profiles()
|
MediaProfile
|
||||||
|
|> order_by(asc: :name)
|
||||||
|
|> Repo.all()
|
||||||
end
|
end
|
||||||
|
|
||||||
defp get_onboarding_layout do
|
defp get_onboarding_layout do
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ defmodule PinchflatWeb.Sources.SourceHTML do
|
|||||||
|
|
||||||
def friendly_index_frequencies do
|
def friendly_index_frequencies do
|
||||||
[
|
[
|
||||||
{"On Create", -1},
|
{"Only once when first created", -1},
|
||||||
{"1 Hour", 60},
|
{"1 Hour", 60},
|
||||||
{"3 Hours", 3 * 60},
|
{"3 Hours", 3 * 60},
|
||||||
{"6 Hours", 6 * 60},
|
{"6 Hours", 6 * 60},
|
||||||
@@ -24,4 +24,33 @@ defmodule PinchflatWeb.Sources.SourceHTML do
|
|||||||
{"Monthly", 30 * 24 * 60}
|
{"Monthly", 30 * 24 * 60}
|
||||||
]
|
]
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def rss_feed_url(conn, source) do
|
||||||
|
url(conn, ~p"/sources/#{source.uuid}/feed") <> ".xml"
|
||||||
|
end
|
||||||
|
|
||||||
|
def output_path_template_override_placeholders(media_profiles) do
|
||||||
|
media_profiles
|
||||||
|
|> Enum.map(&{&1.id, &1.output_path_template})
|
||||||
|
|> Map.new()
|
||||||
|
|> Phoenix.json_library().encode!()
|
||||||
|
end
|
||||||
|
|
||||||
|
def title_filter_regex_help do
|
||||||
|
url = "https://github.com/nalgeon/sqlean/blob/main/docs/regexp.md#supported-syntax"
|
||||||
|
classes = "underline decoration-bodydark decoration-1 hover:decoration-white"
|
||||||
|
|
||||||
|
"""
|
||||||
|
A PCRE-compatible regex. Only media with titles that match this regex will be downloaded. <a href="#{url}" class="#{classes}" target="_blank">See here</a> for syntax
|
||||||
|
"""
|
||||||
|
end
|
||||||
|
|
||||||
|
def output_path_template_override_help do
|
||||||
|
help_button_classes = "underline decoration-bodydark decoration-1 hover:decoration-white cursor-pointer"
|
||||||
|
help_button = ~s{<span class="#{help_button_classes}" x-on:click="$dispatch('load-template')">Click here</span>}
|
||||||
|
|
||||||
|
"""
|
||||||
|
Must end with .{{ ext }}. Same rules as Media Profile output path templates. #{help_button} to load your media profile's output template
|
||||||
|
"""
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user