Compare commits
129 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 0eca0acbe8 | |||
| 89f4634d1f | |||
| 32ac51d7b0 | |||
| 198bef71bc | |||
| 54ea8a373a | |||
| 0722f43727 | |||
| 9dd64f3a2d | |||
| fae7ba3304 | |||
| bdd97bde01 | |||
| edb12b088f | |||
| 964ab2f89b | |||
| 216e05567f | |||
| 2d8b985f13 | |||
| d1fe87bdf3 | |||
| 23d65eaf5f | |||
| 4d6a93d16c | |||
| 9985aeca86 | |||
| f38d793f4e | |||
| 2006f33792 | |||
| 320b25f5b6 | |||
| d043e5574b | |||
| af86fede6c | |||
| 7411177e7d | |||
| 42a418f79e | |||
| c45c030c00 | |||
| c08654714a | |||
| 5c5e7a8a91 | |||
| 1b0d71ea48 | |||
| af803b7081 | |||
| fe641cfc49 | |||
| 65533b82da | |||
| 1923098427 | |||
| 6ad9e68682 | |||
| 9baaa65c1e | |||
| bd6ea15118 | |||
| e92e2001bf | |||
| a3d0927dfb | |||
| 54eacf52b3 | |||
| d0f7338f42 | |||
| ecc73d25a5 | |||
| b18c305957 | |||
| ccae3366a5 | |||
| 182ba7abe7 | |||
| f06c02bf62 | |||
| 37eb745d03 | |||
| 66b14c3d8f | |||
| d9b63875ab | |||
| aed2322c63 | |||
| 723cf2a7e9 | |||
| b4cdca5206 | |||
| 9310b5e26e | |||
| 3c522d8d6b | |||
| 1328dff7d6 | |||
| e2385eccd6 | |||
| 565a1d4972 | |||
| 05f3deebfa | |||
| f91c707c7c | |||
| 6e7e8dc96c | |||
| b633d0f75c | |||
| a135746c97 | |||
| c67278ab5c | |||
| 5bde1205cc | |||
| c1e3ed2128 | |||
| 1cc8731914 | |||
| abe99ce6f0 | |||
| f506b9bc28 | |||
| 5b2d6b094d | |||
| 33baa99aae | |||
| 7fa5c4da63 | |||
| 993865909c | |||
| f156fec4b7 | |||
| e1fc361e98 | |||
| 2267b47de8 | |||
| e6b04bd675 | |||
| ea4d689fea | |||
| 2f6a19f0e7 | |||
| f60ec4f49d | |||
| c0a11e98d9 | |||
| 19ec13e64c | |||
| e1f8e94686 | |||
| 128485c30a | |||
| b7beeaf9eb | |||
| 36daeff48c | |||
| 0948bebb9d | |||
| ef4a5cc99f | |||
| 82eb12b983 | |||
| a4f4afeac9 | |||
| 90a0022d85 | |||
| f55cdc80dd | |||
| b370c97bfb | |||
| 0f40dcf5dd | |||
| c37157d644 | |||
| 09448e3fcc | |||
| 9e75092876 | |||
| 36f27c76e8 | |||
| be8bcf0eb2 | |||
| 7809a25f2d | |||
| d2c2cda479 | |||
| 1f4823bda9 | |||
| 0020e5083b | |||
| c77047951f | |||
| 4094da9e03 | |||
| 3b94b269d9 | |||
| 927560beb6 | |||
| ab9b657394 | |||
| 610acb15f1 | |||
| 3efc533fb7 | |||
| e3f1b409b9 | |||
| 01042ebd1b | |||
| 1ec1a48235 | |||
| af7e76c1d1 | |||
| 69c47c2c65 | |||
| 1f56db01a5 | |||
| b81c8d64b3 | |||
| 53bd8681c3 | |||
| c5fcb8fe12 | |||
| 58771ee37b | |||
| 850cf2db73 | |||
| 77f06bfbc8 | |||
| e0637331bb | |||
| e1565ad22f | |||
| 9e4fbfa35d | |||
| b19c01e3ed | |||
| 366fd80213 | |||
| 977b69b7c3 | |||
| 4dd9d837a3 | |||
| 44bec0a127 | |||
| 89b1640eb6 | |||
| c03fd837ea |
+3
-6
@@ -9,18 +9,15 @@
|
|||||||
fix: true,
|
fix: true,
|
||||||
|
|
||||||
## don't retry automatically even if last run resulted in failures
|
## don't retry automatically even if last run resulted in failures
|
||||||
# retry: false,
|
retry: false,
|
||||||
|
|
||||||
## list of tools (see `mix check` docs for a list of default curated tools)
|
## list of tools (see `mix check` docs for a list of default curated tools)
|
||||||
tools: [
|
tools: [
|
||||||
{:compiler, env: %{"MIX_ENV" => "test"}},
|
{:compiler, env: %{"MIX_ENV" => "test"}},
|
||||||
{:formatter, env: %{"MIX_ENV" => "test"}},
|
{:formatter, env: %{"MIX_ENV" => "test"}},
|
||||||
{:sobelow, "mix sobelow --config"},
|
{:sobelow, "mix sobelow --config"},
|
||||||
# TODO: delete these and replace them with builtin ex_unit and formatter tools
|
{:prettier_formatting, "yarn run prettier . --check", fix: "yarn run prettier . --write"},
|
||||||
# once Elixir 1.16.2 is released (see: https://github.com/karolsluszniak/ex_check/issues/41#issuecomment-1921390413)
|
{:npm_test, false}
|
||||||
{:elixir_tests, "mix test"},
|
|
||||||
{:elixir_formatting, "mix format --check-formatted", fix: "mix format"},
|
|
||||||
{:prettier_formatting, "yarn run prettier . --check", fix: "yarn run prettier . --write"}
|
|
||||||
|
|
||||||
## curated tools may be disabled (e.g. the check for compilation warnings)
|
## curated tools may be disabled (e.g. the check for compilation warnings)
|
||||||
# {:compiler, false},
|
# {:compiler, false},
|
||||||
|
|||||||
+11
-2
@@ -128,7 +128,7 @@
|
|||||||
{Credo.Check.Refactor.MatchInCondition, []},
|
{Credo.Check.Refactor.MatchInCondition, []},
|
||||||
{Credo.Check.Refactor.NegatedConditionsInUnless, []},
|
{Credo.Check.Refactor.NegatedConditionsInUnless, []},
|
||||||
{Credo.Check.Refactor.NegatedConditionsWithElse, []},
|
{Credo.Check.Refactor.NegatedConditionsWithElse, []},
|
||||||
{Credo.Check.Refactor.Nesting, []},
|
{Credo.Check.Refactor.Nesting, [max_nesting: 4]},
|
||||||
{Credo.Check.Refactor.RedundantWithClauseResult, []},
|
{Credo.Check.Refactor.RedundantWithClauseResult, []},
|
||||||
{Credo.Check.Refactor.RejectReject, []},
|
{Credo.Check.Refactor.RejectReject, []},
|
||||||
{Credo.Check.Refactor.UnlessWithElse, []},
|
{Credo.Check.Refactor.UnlessWithElse, []},
|
||||||
@@ -157,7 +157,16 @@
|
|||||||
{Credo.Check.Warning.UnusedRegexOperation, []},
|
{Credo.Check.Warning.UnusedRegexOperation, []},
|
||||||
{Credo.Check.Warning.UnusedStringOperation, []},
|
{Credo.Check.Warning.UnusedStringOperation, []},
|
||||||
{Credo.Check.Warning.UnusedTupleOperation, []},
|
{Credo.Check.Warning.UnusedTupleOperation, []},
|
||||||
{Credo.Check.Warning.WrongTestFileExtension, []}
|
{Credo.Check.Warning.WrongTestFileExtension, []},
|
||||||
|
|
||||||
|
#
|
||||||
|
## Naming Checks
|
||||||
|
#
|
||||||
|
{CredoNaming.Check.Consistency.ModuleFilename,
|
||||||
|
[
|
||||||
|
priority: :normal,
|
||||||
|
excluded_paths: [~r/test\/support/, ~r/priv/, ~r/lib\/pinchflat_web/, ~r/test\/pinchflat_web/]
|
||||||
|
]}
|
||||||
],
|
],
|
||||||
disabled: [
|
disabled: [
|
||||||
#
|
#
|
||||||
|
|||||||
@@ -13,3 +13,5 @@ N/A
|
|||||||
## Any other comments?
|
## Any other comments?
|
||||||
|
|
||||||
N/A
|
N/A
|
||||||
|
|
||||||
|
- [ ] I am the original author of this code and I am giving it freely to the community and Pinchflat project maintainers
|
||||||
|
|||||||
@@ -1,32 +0,0 @@
|
|||||||
name: Build and Push Docker Image
|
|
||||||
|
|
||||||
on:
|
|
||||||
workflow_dispatch:
|
|
||||||
inputs:
|
|
||||||
image_tag:
|
|
||||||
description: 'Docker Image Tag'
|
|
||||||
required: true
|
|
||||||
default: 'dev'
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
docker:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Set up QEMU
|
|
||||||
uses: docker/setup-qemu-action@v3
|
|
||||||
|
|
||||||
- name: Set up Docker Buildx
|
|
||||||
uses: docker/setup-buildx-action@v3
|
|
||||||
|
|
||||||
- name: Login to Docker Hub
|
|
||||||
uses: docker/login-action@v3
|
|
||||||
with:
|
|
||||||
username: ${{ secrets.DOCKERHUB_USERNAME }}
|
|
||||||
password: ${{ secrets.DOCKERHUB_TOKEN }}
|
|
||||||
|
|
||||||
- name: Build and push
|
|
||||||
uses: docker/build-push-action@v5
|
|
||||||
with:
|
|
||||||
push: true
|
|
||||||
file: ./selfhosted.Dockerfile
|
|
||||||
tags: 'keglin/pinchflat:${{ github.event.inputs.image_tag }}'
|
|
||||||
@@ -0,0 +1,79 @@
|
|||||||
|
name: Docker Release
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_dispatch:
|
||||||
|
inputs:
|
||||||
|
platforms:
|
||||||
|
type: choice
|
||||||
|
description: 'Build Platforms'
|
||||||
|
required: true
|
||||||
|
default: 'linux/amd64'
|
||||||
|
options:
|
||||||
|
- 'linux/amd64'
|
||||||
|
- 'linux/amd64,linux/arm64'
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
release:
|
||||||
|
types:
|
||||||
|
- published
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build_and_push_docker:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
env:
|
||||||
|
dev_arch: 'linux/amd64'
|
||||||
|
release_arch: 'linux/amd64,linux/arm64'
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
packages: write
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Docker meta
|
||||||
|
id: meta
|
||||||
|
uses: docker/metadata-action@v5
|
||||||
|
with:
|
||||||
|
images: |
|
||||||
|
docker.io/keglin/pinchflat
|
||||||
|
ghcr.io/${{ github.repository }}
|
||||||
|
# All non-release actions will be tagged as `dev` (ie: push, workflow_dispatch)
|
||||||
|
tags: |
|
||||||
|
type=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 }}
|
||||||
@@ -4,8 +4,7 @@ alias Pinchflat.Repo
|
|||||||
alias Pinchflat.Tasks.Task
|
alias Pinchflat.Tasks.Task
|
||||||
alias Pinchflat.Sources.Source
|
alias Pinchflat.Sources.Source
|
||||||
alias Pinchflat.Media.MediaItem
|
alias Pinchflat.Media.MediaItem
|
||||||
alias Pinchflat.Tasks.SourceTasks
|
alias Pinchflat.Metadata.MediaMetadata
|
||||||
alias Pinchflat.Media.MediaMetadata
|
|
||||||
alias Pinchflat.Profiles.MediaProfile
|
alias Pinchflat.Profiles.MediaProfile
|
||||||
|
|
||||||
alias Pinchflat.Tasks
|
alias Pinchflat.Tasks
|
||||||
@@ -14,51 +13,13 @@ alias Pinchflat.Profiles
|
|||||||
alias Pinchflat.Sources
|
alias Pinchflat.Sources
|
||||||
alias Pinchflat.Settings
|
alias Pinchflat.Settings
|
||||||
|
|
||||||
alias Pinchflat.MediaClient.MediaDownloader
|
alias Pinchflat.Downloading.MediaDownloader
|
||||||
alias Pinchflat.YtDlp.Backend.Media, as: YtDlpMedia
|
alias Pinchflat.YtDlp.Media, as: YtDlpMedia
|
||||||
alias Pinchflat.YtDlp.Backend.MediaCollection, as: YtDlpCollection
|
alias Pinchflat.YtDlp.MediaCollection, as: YtDlpCollection
|
||||||
|
|
||||||
alias Pinchflat.Api.YoutubeRss
|
alias Pinchflat.FastIndexing.YoutubeRss
|
||||||
alias Pinchflat.Metadata.MetadataFileHelpers
|
alias Pinchflat.Metadata.MetadataFileHelpers
|
||||||
|
|
||||||
alias Pinchflat.Utils.FilesystemUtils.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,128 @@
|
|||||||
# Pinchflat (Alpha)
|
<p align="center">
|
||||||
|
<img
|
||||||
|
src="priv/static/images/originals/logo-white-wordmark-with-background.png"
|
||||||
|
alt="Pinchflat Logo by @hernandito"
|
||||||
|
width="700"
|
||||||
|
/>
|
||||||
|
</p>
|
||||||
|
|
||||||
This is alpha software and anything can break at any time. I make not guarantees about the stability of this software, forward-compatibility of updates, or integrity (both related to and independent of Pinchflat). Essentially, use at your own risk and expect there will be rough edges.
|
<p align="center">
|
||||||
|
<sup>
|
||||||
|
<em>logo by <a href="https://github.com/hernandito" target="_blank">@hernandito</a></em>
|
||||||
|
</sup>
|
||||||
|
</p>
|
||||||
|
|
||||||
## What is Pinchflat?
|
# Your next YouTube media manager
|
||||||
|
|
||||||
TODO: expand on this.
|
## Table of contents:
|
||||||
|
|
||||||
Pinchflat is a lightweight self-contained app for downloading YouTube content. For now, it is not intended as a way to consume content, but instead as a way to download content to disk using specified rules and schedules.
|
- [What it does](#what-it-does)
|
||||||
|
- [Features](#features)
|
||||||
|
- [Screenshots](#screenshots)
|
||||||
|
- [Installation](#installation)
|
||||||
|
- [Unraid](#unraid)
|
||||||
|
- [Docker](#docker)
|
||||||
|
- [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)
|
||||||
|
|
||||||
I have plans for more to come, but for now this is the focus. Think of Pinchflat as nothing more than an automated way to get content from YouTube to your disk.
|
## What it does
|
||||||
|
|
||||||
|
Pinchflat is a self-hosted app for downloading YouTube content built using [yt-dlp](https://github.com/yt-dlp/yt-dlp). It's designed to be lightweight, self-contained, and easy to use. You set up rules for how to download content from YouTube channels or playlists and it'll do the rest, checking periodically for new content. It's perfect for people who want to download content for use in with a media center app (Plex, Jellyfin, Kodi) or for those who want to archive media!
|
||||||
|
|
||||||
|
It's _not_ great for downloading one-off videos - it's built to download large amounts of content and keep it up to date. It's also not meant for consuming content in-app - Pinchflat downloads content to disk where you can then watch it with a media center app or VLC.
|
||||||
|
|
||||||
|
If it doesn't work for your use case, please make a feature request! You can also check out these great alternatives: [Tube Archivist](https://github.com/tubearchivist/tubearchivist), [ytdl-sub](https://github.com/jmbannon/ytdl-sub), and [TubeSync](https://github.com/meeb/tubesync)
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- Self-contained - just one Docker container with no external dependencies
|
||||||
|
- Powerful naming system so content is stored where and how you want it
|
||||||
|
- Easy-to-use web interface with presets to get you started right away
|
||||||
|
- First-class support for media center apps like Plex, Jellyfin, and Kodi
|
||||||
|
- Supports serving RSS feeds to your favourite podcast app (beta - [docs](<https://github.com/kieraneglin/pinchflat/wiki/Podcast-RSS-Feeds-(beta)>))
|
||||||
|
- Automatically downloads new content from channels and playlists
|
||||||
|
- Uses a novel approach to download new content more quickly than other apps
|
||||||
|
- Supports downloading audio content
|
||||||
|
- Custom rules for handling YouTube Shorts and livestreams
|
||||||
|
- Advanced options like setting cutoff dates and filtering by title
|
||||||
|
- Reliable hands-off operation
|
||||||
|
- Can pass cookies to YouTube to download your private playlists ([docs](https://github.com/kieraneglin/pinchflat/wiki/YouTube-Cookies))
|
||||||
|
- Sponsorblock integration
|
||||||
|
|
||||||
|
## 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: 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.
|
||||||
-p 8945:8945 \
|
|
||||||
-v /Users/work/Desktop/test_volumes/config:/config \
|
Docker Compose file:
|
||||||
-v /Users/work/Desktop/test_volumes/downloads:/downloads \
|
|
||||||
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.
|
||||||
|
|
||||||
|
It's recommended to not run the container as root. Doing so can create permission issues if other apps need to work with the downloaded media. If you need to run any command as root, you can run `su` from the container's shell as there is no password set for the root user.
|
||||||
|
|
||||||
|
### Advanced: storing Pinchflat config directory on a network share
|
||||||
|
|
||||||
|
README: This is currently in the testing phase and not a recommended option (yet). The implications of changing this setting isn't clear and this 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. This may become the default in the future once it's been tested more thoroughly.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|||||||
@@ -38,6 +38,30 @@ let liveSocket = new LiveSocket('/live', Socket, {
|
|||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
|
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))
|
||||||
|
|||||||
+11
-4
@@ -12,17 +12,23 @@ config :pinchflat,
|
|||||||
generators: [timestamp_type: :utc_datetime],
|
generators: [timestamp_type: :utc_datetime],
|
||||||
# Specifying backend data here makes mocking and local testing SUPER easy
|
# Specifying backend data here makes mocking and local testing SUPER easy
|
||||||
yt_dlp_executable: System.find_executable("yt-dlp"),
|
yt_dlp_executable: System.find_executable("yt-dlp"),
|
||||||
yt_dlp_runner: Pinchflat.YtDlp.Backend.CommandRunner,
|
yt_dlp_runner: Pinchflat.YtDlp.CommandRunner,
|
||||||
media_directory: "/downloads",
|
media_directory: "/downloads",
|
||||||
# The user may or may not store metadata for their needs, but the app will always store its copy
|
# The user may or may not store metadata for their needs, but the app will always store its copy
|
||||||
metadata_directory: "/config/metadata",
|
metadata_directory: "/config/metadata",
|
||||||
|
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],
|
||||||
@@ -48,7 +54,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
|
||||||
|
|||||||
@@ -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
|
||||||
|
|||||||
+30
-69
@@ -25,37 +25,48 @@ 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"),
|
||||||
|
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 +100,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 +119,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
|
||||||
|
|||||||
+1
-3
@@ -17,7 +17,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 +32,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
|
||||||
|
|||||||
+13
-3
@@ -1,9 +1,18 @@
|
|||||||
# Extend from the official Elixir image.
|
ARG ELIXIR_VERSION=1.16.2
|
||||||
FROM elixir:latest
|
ARG OTP_VERSION=26.2.2
|
||||||
|
ARG DEBIAN_VERSION=bookworm-20240130
|
||||||
|
ARG DEV_IMAGE="hexpm/elixir:${ELIXIR_VERSION}-erlang-${OTP_VERSION}-debian-${DEBIAN_VERSION}"
|
||||||
|
|
||||||
|
FROM ${DEV_IMAGE}
|
||||||
|
|
||||||
|
# Set the locale deets
|
||||||
|
ENV LANG en_US.UTF-8
|
||||||
|
ENV LANGUAGE en_US:en
|
||||||
|
ENV LC_ALL en_US.UTF-8
|
||||||
|
|
||||||
# Install debian packages
|
# Install debian packages
|
||||||
RUN apt-get update -qq
|
RUN apt-get update -qq
|
||||||
RUN apt-get install -y inotify-tools ffmpeg \
|
RUN apt-get install -y inotify-tools ffmpeg curl git openssh-client \
|
||||||
python3 python3-pip python3-setuptools python3-wheel python3-dev
|
python3 python3-pip python3-setuptools python3-wheel python3-dev
|
||||||
|
|
||||||
# Install nodejs
|
# Install nodejs
|
||||||
@@ -28,6 +37,7 @@ COPY . ./
|
|||||||
RUN chmod +x ./docker-run.dev.sh
|
RUN chmod +x ./docker-run.dev.sh
|
||||||
|
|
||||||
# Install Elixir deps
|
# Install Elixir deps
|
||||||
|
# RUN mix archive.install github hexpm/hex branch latest
|
||||||
RUN mix deps.get
|
RUN mix deps.get
|
||||||
# Gives us iex shell history
|
# Gives us iex shell history
|
||||||
ENV ERL_AFLAGS="-kernel shell_history enabled"
|
ENV ERL_AFLAGS="-kernel shell_history enabled"
|
||||||
|
|||||||
@@ -2,5 +2,3 @@
|
|||||||
- Use a UUID for the media database ID (or at least alongside it)
|
- Use a UUID for the media database ID (or at least alongside it)
|
||||||
- Look into this and its recommended plugins https://hexdocs.pm/ex_check/readme.html
|
- Look into this and its recommended plugins https://hexdocs.pm/ex_check/readme.html
|
||||||
- Add output template option for the source's friendly name
|
- Add output template option for the source's friendly name
|
||||||
- TODO: Install Elixir 1.16.2 when available to fix bug with `ex_check` https://github.com/karolsluszniak/ex_check/issues/41#issuecomment-1921390413
|
|
||||||
- delete `{:elixir_tests, "mix test"}` and formatting check
|
|
||||||
|
|||||||
@@ -11,8 +11,9 @@ defmodule Pinchflat.Application do
|
|||||||
PinchflatWeb.Telemetry,
|
PinchflatWeb.Telemetry,
|
||||||
Pinchflat.Repo,
|
Pinchflat.Repo,
|
||||||
# Must be before startup tasks
|
# Must be before startup tasks
|
||||||
|
Pinchflat.Boot.PreJobStartupTasks,
|
||||||
{Oban, Application.fetch_env!(:pinchflat, Oban)},
|
{Oban, Application.fetch_env!(:pinchflat, Oban)},
|
||||||
Pinchflat.StartupTasks,
|
Pinchflat.Boot.PostJobStartupTasks,
|
||||||
{DNSCluster, query: Application.get_env(:pinchflat, :dns_cluster_query) || :ignore},
|
{DNSCluster, query: Application.get_env(:pinchflat, :dns_cluster_query) || :ignore},
|
||||||
{Phoenix.PubSub, name: Pinchflat.PubSub},
|
{Phoenix.PubSub, name: Pinchflat.PubSub},
|
||||||
# Start the Finch HTTP client for sending emails
|
# Start the Finch HTTP client for sending emails
|
||||||
|
|||||||
+5
-18
@@ -1,8 +1,8 @@
|
|||||||
defmodule Pinchflat.Workers.DataBackfillWorker do
|
defmodule Pinchflat.Boot.DataBackfillWorker do
|
||||||
@moduledoc false
|
@moduledoc false
|
||||||
|
|
||||||
use Oban.Worker,
|
use Oban.Worker,
|
||||||
queue: :media_local_metadata,
|
queue: :local_metadata,
|
||||||
unique: [period: :infinity, states: [:available, :scheduled, :retryable]],
|
unique: [period: :infinity, states: [:available, :scheduled, :retryable]],
|
||||||
tags: ["media_item", "media_metadata", "local_metadata", "data_backfill"]
|
tags: ["media_item", "media_metadata", "local_metadata", "data_backfill"]
|
||||||
|
|
||||||
@@ -18,7 +18,6 @@ defmodule Pinchflat.Workers.DataBackfillWorker do
|
|||||||
|
|
||||||
alias __MODULE__
|
alias __MODULE__
|
||||||
alias Pinchflat.Repo
|
alias Pinchflat.Repo
|
||||||
alias Pinchflat.Media.MediaItem
|
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Cancels all pending backfill jobs. Useful for ensuring worker runs immediately
|
Cancels all pending backfill jobs. Useful for ensuring worker runs immediately
|
||||||
@@ -28,7 +27,7 @@ defmodule Pinchflat.Workers.DataBackfillWorker do
|
|||||||
"""
|
"""
|
||||||
def cancel_pending_backfill_jobs do
|
def cancel_pending_backfill_jobs do
|
||||||
Oban.Job
|
Oban.Job
|
||||||
|> where(worker: "Pinchflat.Workers.DataBackfillWorker")
|
|> where(worker: "Pinchflat.Boot.DataBackfillWorker")
|
||||||
|> Oban.cancel_all_jobs()
|
|> Oban.cancel_all_jobs()
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -44,26 +43,14 @@ defmodule Pinchflat.Workers.DataBackfillWorker do
|
|||||||
"""
|
"""
|
||||||
def perform(%Oban.Job{}) do
|
def perform(%Oban.Job{}) do
|
||||||
Logger.info("Running data backfill worker")
|
Logger.info("Running data backfill worker")
|
||||||
backfill_shorts_data()
|
# Nothing to do for now - just reschedule
|
||||||
|
# Keeping in-place because we _will_ need it in the future
|
||||||
|
|
||||||
reschedule_backfill()
|
reschedule_backfill()
|
||||||
|
|
||||||
:ok
|
:ok
|
||||||
end
|
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
|
defp reschedule_backfill do
|
||||||
# Run hourly
|
# Run hourly
|
||||||
next_run_in = 60 * 60
|
next_run_in = 60 * 60
|
||||||
@@ -1,6 +1,7 @@
|
|||||||
defmodule Pinchflat.StartupTasks do
|
defmodule Pinchflat.Boot.PostJobStartupTasks do
|
||||||
@moduledoc """
|
@moduledoc """
|
||||||
This module is responsible for running startup tasks on app boot.
|
This module is responsible for running startup tasks on app boot
|
||||||
|
AFTER the job runner has initiallized.
|
||||||
|
|
||||||
It's a GenServer because that plays REALLY nicely with the existing
|
It's a GenServer because that plays REALLY nicely with the existing
|
||||||
Phoenix supervision tree.
|
Phoenix supervision tree.
|
||||||
@@ -11,8 +12,7 @@ defmodule Pinchflat.StartupTasks do
|
|||||||
import Ecto.Query, warn: false
|
import Ecto.Query, warn: false
|
||||||
|
|
||||||
alias Pinchflat.Repo
|
alias Pinchflat.Repo
|
||||||
alias Pinchflat.Settings
|
alias Pinchflat.Boot.DataBackfillWorker
|
||||||
alias Pinchflat.Workers.DataBackfillWorker
|
|
||||||
|
|
||||||
def start_link(opts \\ []) do
|
def start_link(opts \\ []) do
|
||||||
GenServer.start_link(__MODULE__, %{}, opts)
|
GenServer.start_link(__MODULE__, %{}, opts)
|
||||||
@@ -29,17 +29,11 @@ defmodule Pinchflat.StartupTasks do
|
|||||||
"""
|
"""
|
||||||
@impl true
|
@impl true
|
||||||
def init(state) do
|
def init(state) do
|
||||||
apply_default_settings()
|
|
||||||
enqueue_backfill_worker()
|
enqueue_backfill_worker()
|
||||||
|
|
||||||
{:ok, state}
|
{:ok, state}
|
||||||
end
|
end
|
||||||
|
|
||||||
defp apply_default_settings do
|
|
||||||
Settings.fetch!(:onboarding, true)
|
|
||||||
Settings.fetch!(:pro_enabled, false)
|
|
||||||
end
|
|
||||||
|
|
||||||
defp enqueue_backfill_worker do
|
defp enqueue_backfill_worker do
|
||||||
DataBackfillWorker.cancel_pending_backfill_jobs()
|
DataBackfillWorker.cancel_pending_backfill_jobs()
|
||||||
|
|
||||||
@@ -0,0 +1,68 @@
|
|||||||
|
defmodule Pinchflat.Boot.PreJobStartupTasks do
|
||||||
|
@moduledoc """
|
||||||
|
This module is responsible for running startup tasks on app boot
|
||||||
|
BEFORE the job runner has initiallized.
|
||||||
|
|
||||||
|
It's a GenServer because that plays REALLY nicely with the existing
|
||||||
|
Phoenix supervision tree.
|
||||||
|
"""
|
||||||
|
|
||||||
|
# restart: :temporary means that this process will never be restarted (ie: will run once and then die)
|
||||||
|
use GenServer, restart: :temporary
|
||||||
|
import Ecto.Query, warn: false
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias Pinchflat.Repo
|
||||||
|
alias Pinchflat.Settings
|
||||||
|
alias Pinchflat.Filesystem.FilesystemHelpers
|
||||||
|
|
||||||
|
def start_link(opts \\ []) do
|
||||||
|
GenServer.start_link(__MODULE__, %{}, opts)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Runs application startup tasks.
|
||||||
|
|
||||||
|
Any code defined here will run every time the application starts. You must
|
||||||
|
make sure that the code is idempotent and safe to run multiple times.
|
||||||
|
|
||||||
|
This is a good place to set up default settings, create initial records, stuff like that.
|
||||||
|
Should be fast - anything with the potential to be slow should be kicked off as a job instead.
|
||||||
|
"""
|
||||||
|
@impl true
|
||||||
|
def init(state) do
|
||||||
|
reset_executing_jobs()
|
||||||
|
create_blank_cookie_file()
|
||||||
|
apply_default_settings()
|
||||||
|
|
||||||
|
{:ok, state}
|
||||||
|
end
|
||||||
|
|
||||||
|
# If a node cannot gracefully shut down, the currently executing jobs get stuck
|
||||||
|
# in the "executing" state. This is a problem because the job runner will not
|
||||||
|
# pick them up again
|
||||||
|
defp reset_executing_jobs do
|
||||||
|
{count, _} =
|
||||||
|
Oban.Job
|
||||||
|
|> where(state: "executing")
|
||||||
|
|> Repo.update_all(set: [state: "retryable"])
|
||||||
|
|
||||||
|
Logger.info("Reset #{count} executing jobs")
|
||||||
|
end
|
||||||
|
|
||||||
|
defp create_blank_cookie_file do
|
||||||
|
base_dir = Application.get_env(:pinchflat, :extras_directory)
|
||||||
|
filepath = Path.join(base_dir, "cookies.txt")
|
||||||
|
|
||||||
|
if !File.exists?(filepath) do
|
||||||
|
Logger.info("Cookies does not exist - creating it")
|
||||||
|
|
||||||
|
FilesystemHelpers.write_p!(filepath, "")
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp apply_default_settings do
|
||||||
|
Settings.fetch!(:onboarding, true)
|
||||||
|
Settings.fetch!(:pro_enabled, false)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,167 @@
|
|||||||
|
defmodule Pinchflat.Downloading.DownloadOptionBuilder do
|
||||||
|
@moduledoc """
|
||||||
|
Builds the options for yt-dlp to download media based on the given media profile.
|
||||||
|
"""
|
||||||
|
|
||||||
|
alias Pinchflat.Sources.Source
|
||||||
|
alias Pinchflat.Media.MediaItem
|
||||||
|
alias Pinchflat.Downloading.OutputPathBuilder
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Builds the options for yt-dlp to download media based on the given media's profile.
|
||||||
|
|
||||||
|
IDEA: consider adding the ability to pass in a second argument to override
|
||||||
|
these options
|
||||||
|
"""
|
||||||
|
def build(%MediaItem{} = media_item_with_preloads) do
|
||||||
|
media_profile = media_item_with_preloads.source.media_profile
|
||||||
|
|
||||||
|
built_options =
|
||||||
|
default_options() ++
|
||||||
|
subtitle_options(media_profile) ++
|
||||||
|
thumbnail_options(media_item_with_preloads) ++
|
||||||
|
metadata_options(media_profile) ++
|
||||||
|
quality_options(media_profile) ++
|
||||||
|
sponsorblock_options(media_profile) ++
|
||||||
|
output_options(media_item_with_preloads)
|
||||||
|
|
||||||
|
{:ok, built_options}
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Builds the output path for yt-dlp to download media based on the given source's
|
||||||
|
media profile.
|
||||||
|
|
||||||
|
Returns binary()
|
||||||
|
"""
|
||||||
|
def build_output_path_for(%Source{} = source_with_preloads) do
|
||||||
|
output_path_template = source_with_preloads.media_profile.output_path_template
|
||||||
|
|
||||||
|
build_output_path(output_path_template, source_with_preloads)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp default_options do
|
||||||
|
[:no_progress, :windows_filenames]
|
||||||
|
end
|
||||||
|
|
||||||
|
defp subtitle_options(media_profile) do
|
||||||
|
mapped_struct = Map.from_struct(media_profile)
|
||||||
|
|
||||||
|
Enum.reduce(mapped_struct, [], fn attr, acc ->
|
||||||
|
case {attr, media_profile} do
|
||||||
|
{{:download_subs, true}, _} ->
|
||||||
|
# Force SRT for now - MAY provide as an option in the future
|
||||||
|
acc ++ [:write_subs, convert_subs: "srt"]
|
||||||
|
|
||||||
|
{{:download_auto_subs, true}, %{download_subs: true}} ->
|
||||||
|
acc ++ [:write_auto_subs]
|
||||||
|
|
||||||
|
{{:embed_subs, true}, %{preferred_resolution: pr}} when pr != :audio ->
|
||||||
|
acc ++ [:embed_subs]
|
||||||
|
|
||||||
|
{{:sub_langs, sub_langs}, %{download_subs: true}} ->
|
||||||
|
acc ++ [sub_langs: sub_langs]
|
||||||
|
|
||||||
|
{{:sub_langs, sub_langs}, %{embed_subs: true}} ->
|
||||||
|
acc ++ [sub_langs: sub_langs]
|
||||||
|
|
||||||
|
_ ->
|
||||||
|
acc
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp thumbnail_options(media_item_with_preloads) do
|
||||||
|
media_profile = media_item_with_preloads.source.media_profile
|
||||||
|
mapped_struct = Map.from_struct(media_profile)
|
||||||
|
|
||||||
|
Enum.reduce(mapped_struct, [], fn attr, acc ->
|
||||||
|
case attr do
|
||||||
|
{:download_thumbnail, true} ->
|
||||||
|
thumbnail_save_location = determine_thumbnail_location(media_item_with_preloads)
|
||||||
|
|
||||||
|
acc ++ [:write_thumbnail, convert_thumbnail: "jpg", output: "thumbnail:#{thumbnail_save_location}"]
|
||||||
|
|
||||||
|
{:embed_thumbnail, true} ->
|
||||||
|
acc ++ [:embed_thumbnail, convert_thumbnail: "jpg"]
|
||||||
|
|
||||||
|
_ ->
|
||||||
|
acc
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp metadata_options(media_profile) do
|
||||||
|
mapped_struct = Map.from_struct(media_profile)
|
||||||
|
|
||||||
|
Enum.reduce(mapped_struct, [], fn attr, acc ->
|
||||||
|
case attr do
|
||||||
|
{:download_metadata, true} -> acc ++ [:write_info_json, :clean_info_json]
|
||||||
|
{:embed_metadata, true} -> acc ++ [:embed_metadata]
|
||||||
|
_ -> acc
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp quality_options(media_profile) do
|
||||||
|
video_codec_options = "+codec:avc:m4a"
|
||||||
|
|
||||||
|
case media_profile.preferred_resolution do
|
||||||
|
# Also be aware that :audio disabled all embedding options for subtitles
|
||||||
|
:audio -> [:extract_audio, format: "bestaudio[ext=m4a]"]
|
||||||
|
:"360p" -> [format_sort: "res:360,#{video_codec_options}"]
|
||||||
|
:"480p" -> [format_sort: "res:480,#{video_codec_options}"]
|
||||||
|
:"720p" -> [format_sort: "res:720,#{video_codec_options}"]
|
||||||
|
:"1080p" -> [format_sort: "res:1080,#{video_codec_options}"]
|
||||||
|
:"2160p" -> [format_sort: "res:2160,#{video_codec_options}"]
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp sponsorblock_options(media_profile) do
|
||||||
|
categories = media_profile.sponsorblock_categories
|
||||||
|
behaviour = media_profile.sponsorblock_behaviour
|
||||||
|
|
||||||
|
case {behaviour, categories} do
|
||||||
|
{_, []} -> []
|
||||||
|
{:remove, _} -> [sponsorblock_remove: Enum.join(categories, ",")]
|
||||||
|
{:disabled, _} -> []
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp output_options(media_item_with_preloads) do
|
||||||
|
[
|
||||||
|
output: build_output_path_for(media_item_with_preloads.source)
|
||||||
|
]
|
||||||
|
end
|
||||||
|
|
||||||
|
defp build_output_path(string, source) do
|
||||||
|
additional_options_map = output_options_map(source)
|
||||||
|
{:ok, output_path} = OutputPathBuilder.build(string, additional_options_map)
|
||||||
|
|
||||||
|
Path.join(base_directory(), output_path)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp output_options_map(source) do
|
||||||
|
%{
|
||||||
|
"source_custom_name" => source.custom_name,
|
||||||
|
"source_collection_type" => source.collection_type
|
||||||
|
}
|
||||||
|
end
|
||||||
|
|
||||||
|
# I don't love the string manipulation here, but what can ya' do.
|
||||||
|
# It's dependent on the output_path_template being a string ending `.{{ ext }}`
|
||||||
|
# (or equivalent), but that's validated by the MediaProfile schema.
|
||||||
|
defp determine_thumbnail_location(media_item_with_preloads) do
|
||||||
|
output_path_template = media_item_with_preloads.source.media_profile.output_path_template
|
||||||
|
|
||||||
|
output_path_template
|
||||||
|
|> String.split(~r{\.}, include_captures: true)
|
||||||
|
|> List.insert_at(-3, "-thumb")
|
||||||
|
|> Enum.join()
|
||||||
|
|> build_output_path(media_item_with_preloads.source)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp base_directory do
|
||||||
|
Application.get_env(:pinchflat, :media_directory)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,46 @@
|
|||||||
|
defmodule Pinchflat.Downloading.DownloadingHelpers do
|
||||||
|
@moduledoc """
|
||||||
|
Methods for helping download media
|
||||||
|
|
||||||
|
Many of these methods are made to be kickoff or be consumed by workers.
|
||||||
|
"""
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias Pinchflat.Media
|
||||||
|
alias Pinchflat.Tasks
|
||||||
|
alias Pinchflat.Sources.Source
|
||||||
|
alias Pinchflat.Downloading.MediaDownloadWorker
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Starts tasks for downloading media for any of a sources _pending_ media items.
|
||||||
|
Jobs are not enqueued if the source is set to not download media. This will return :ok.
|
||||||
|
|
||||||
|
NOTE: this starts a download for each media item that is pending,
|
||||||
|
not just the ones that were indexed in this job run. This should ensure
|
||||||
|
that any stragglers are caught if, for some reason, they weren't enqueued
|
||||||
|
or somehow got de-queued.
|
||||||
|
|
||||||
|
Returns :ok
|
||||||
|
"""
|
||||||
|
def enqueue_pending_download_tasks(%Source{download_media: true} = source) do
|
||||||
|
source
|
||||||
|
|> Media.list_pending_media_items_for()
|
||||||
|
|> Enum.each(&MediaDownloadWorker.kickoff_with_task/1)
|
||||||
|
end
|
||||||
|
|
||||||
|
def enqueue_pending_download_tasks(%Source{download_media: false}) do
|
||||||
|
:ok
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Deletes ALL pending tasks for a source's media items.
|
||||||
|
|
||||||
|
Returns :ok
|
||||||
|
"""
|
||||||
|
def dequeue_pending_download_tasks(%Source{} = source) do
|
||||||
|
source
|
||||||
|
|> Media.list_pending_media_items_for()
|
||||||
|
|> Enum.each(&Tasks.delete_pending_tasks_for/1)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,75 @@
|
|||||||
|
defmodule Pinchflat.Downloading.MediaDownloadWorker do
|
||||||
|
@moduledoc false
|
||||||
|
|
||||||
|
use Oban.Worker,
|
||||||
|
queue: :media_fetching,
|
||||||
|
unique: [period: :infinity, states: [:available, :scheduled, :retryable, :executing]],
|
||||||
|
tags: ["media_item", "media_fetching"]
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias __MODULE__
|
||||||
|
alias Pinchflat.Tasks
|
||||||
|
alias Pinchflat.Repo
|
||||||
|
alias Pinchflat.Media
|
||||||
|
alias Pinchflat.Downloading.MediaDownloader
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Starts the media_item media download worker and creates a task for the media_item.
|
||||||
|
|
||||||
|
Returns {:ok, %Task{}} | {:error, :duplicate_job} | {:error, %Ecto.Changeset{}}
|
||||||
|
"""
|
||||||
|
def kickoff_with_task(media_item, opts \\ []) do
|
||||||
|
%{id: media_item.id}
|
||||||
|
|> MediaDownloadWorker.new(opts)
|
||||||
|
|> Tasks.create_job_with_task(media_item)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
For a given media item, download the media alongside any options.
|
||||||
|
Does not download media if its source is set to not download media.
|
||||||
|
|
||||||
|
Returns :ok | {:ok, %MediaItem{}} | {:error, any, ...any}
|
||||||
|
"""
|
||||||
|
@impl Oban.Worker
|
||||||
|
def perform(%Oban.Job{args: %{"id" => media_item_id}}) do
|
||||||
|
media_item =
|
||||||
|
media_item_id
|
||||||
|
|> Media.get_media_item!()
|
||||||
|
|> Repo.preload(:source)
|
||||||
|
|
||||||
|
# If the source is set to not download media, perform a no-op
|
||||||
|
if media_item.source.download_media do
|
||||||
|
download_media_and_schedule_jobs(media_item)
|
||||||
|
else
|
||||||
|
:ok
|
||||||
|
end
|
||||||
|
rescue
|
||||||
|
Ecto.NoResultsError -> Logger.info("#{__MODULE__} discarded: media item #{media_item_id} not found")
|
||||||
|
Ecto.StaleEntryError -> Logger.info("#{__MODULE__} discarded: media item #{media_item_id} stale")
|
||||||
|
end
|
||||||
|
|
||||||
|
defp download_media_and_schedule_jobs(media_item) do
|
||||||
|
case MediaDownloader.download_for_media_item(media_item) do
|
||||||
|
{:ok, updated_media_item} ->
|
||||||
|
compute_and_save_media_filesize(updated_media_item)
|
||||||
|
|
||||||
|
{:ok, updated_media_item}
|
||||||
|
|
||||||
|
err ->
|
||||||
|
Logger.error("Failed to download media for media item #{media_item.id}: #{inspect(err)}")
|
||||||
|
|
||||||
|
{:error, :download_failed}
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp 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})
|
||||||
|
|
||||||
|
_ ->
|
||||||
|
:ok
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
+22
-15
@@ -1,4 +1,4 @@
|
|||||||
defmodule Pinchflat.MediaClient.MediaDownloader do
|
defmodule Pinchflat.Downloading.MediaDownloader do
|
||||||
@moduledoc """
|
@moduledoc """
|
||||||
This is the integration layer for actually downloading media.
|
This is the integration layer for actually downloading media.
|
||||||
It takes into account the media profile's settings in order
|
It takes into account the media profile's settings in order
|
||||||
@@ -8,11 +8,12 @@ defmodule Pinchflat.MediaClient.MediaDownloader do
|
|||||||
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.Downloading.DownloadOptionBuilder
|
||||||
|
|
||||||
alias Pinchflat.YtDlp.Backend.Media, as: YtDlpMedia
|
alias Pinchflat.YtDlp.Media, as: YtDlpMedia
|
||||||
alias Pinchflat.YtDlp.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
|
||||||
@@ -30,16 +31,17 @@ defmodule Pinchflat.MediaClient.MediaDownloader do
|
|||||||
|
|
||||||
case download_with_options(media_item.original_url, item_with_preloads) do
|
case download_with_options(media_item.original_url, item_with_preloads) do
|
||||||
{:ok, parsed_json} ->
|
{:ok, parsed_json} ->
|
||||||
{parser, helpers} = {YtDlpMetadataParser, YtDlpMetadataHelpers}
|
|
||||||
|
|
||||||
parsed_attrs =
|
parsed_attrs =
|
||||||
parsed_json
|
parsed_json
|
||||||
|> parser.parse_for_media_item()
|
|> MetadataParser.parse_for_media_item()
|
||||||
|> Map.merge(%{
|
|> Map.merge(%{
|
||||||
media_downloaded_at: DateTime.utc_now(),
|
media_downloaded_at: DateTime.utc_now(),
|
||||||
|
nfo_filepath: determine_nfo_filepath(item_with_preloads, parsed_json),
|
||||||
metadata: %{
|
metadata: %{
|
||||||
metadata_filepath: helpers.compress_and_store_metadata_for(media_item, parsed_json),
|
# IDEA: might be worth kicking off a job for this since thumbnail fetching
|
||||||
thumbnail_filepath: helpers.download_and_store_thumbnail_for(media_item, parsed_json)
|
# could fail and I want to handle that in isolation
|
||||||
|
metadata_filepath: MetadataFileHelpers.compress_and_store_metadata_for(media_item, parsed_json),
|
||||||
|
thumbnail_filepath: MetadataFileHelpers.download_and_store_thumbnail_for(media_item, parsed_json)
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
@@ -52,13 +54,18 @@ defmodule Pinchflat.MediaClient.MediaDownloader do
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# def download_for_source(source, url) do
|
defp determine_nfo_filepath(media_item, parsed_json) do
|
||||||
# # Create MI from source and URL
|
if media_item.source.media_profile.download_nfo do
|
||||||
# media_item = nil
|
filepath = Path.rootname(parsed_json["filepath"]) <> ".nfo"
|
||||||
# end
|
|
||||||
|
NfoBuilder.build_and_store_for_media_item(filepath, parsed_json)
|
||||||
|
else
|
||||||
|
nil
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
defp download_with_options(url, item_with_preloads) do
|
defp download_with_options(url, item_with_preloads) do
|
||||||
{:ok, options} = YtDlpDownloadOptionBuilder.build(item_with_preloads)
|
{:ok, options} = DownloadOptionBuilder.build(item_with_preloads)
|
||||||
|
|
||||||
YtDlpMedia.download(url, options)
|
YtDlpMedia.download(url, options)
|
||||||
end
|
end
|
||||||
+2
-2
@@ -1,4 +1,4 @@
|
|||||||
defmodule Pinchflat.RenderedString.Base do
|
defmodule Pinchflat.Downloading.OutputPath.Base do
|
||||||
@moduledoc """
|
@moduledoc """
|
||||||
A base module for parsing rendered strings, designed as a macro to be used
|
A base module for parsing rendered strings, designed as a macro to be used
|
||||||
in other modules. See https://elixirforum.com/t/help-to-parse-a-template-with-nimbleparsec/47980
|
in other modules. See https://elixirforum.com/t/help-to-parse-a-template-with-nimbleparsec/47980
|
||||||
@@ -6,7 +6,7 @@ defmodule Pinchflat.RenderedString.Base do
|
|||||||
NOTE: if the needs here get any more complicated, look into using a Liquid
|
NOTE: if the needs here get any more complicated, look into using a Liquid
|
||||||
template parser. No need to reinvent the wheel any more than I already have.
|
template parser. No need to reinvent the wheel any more than I already have.
|
||||||
|
|
||||||
NOTE: this is effectively tested by the `Pinchflat.RenderedString.Parser`'s tests
|
NOTE: this is effectively tested by the `Pinchflat.Downloading.OutputPath.Parser`'s tests
|
||||||
"""
|
"""
|
||||||
|
|
||||||
defmacro __using__(_opts) do
|
defmacro __using__(_opts) do
|
||||||
+2
-2
@@ -1,11 +1,11 @@
|
|||||||
defmodule Pinchflat.RenderedString.Parser do
|
defmodule Pinchflat.Downloading.OutputPath.Parser do
|
||||||
@moduledoc """
|
@moduledoc """
|
||||||
Parses liquid-ish-style strings into a rendered string
|
Parses liquid-ish-style strings into a rendered string
|
||||||
|
|
||||||
Used for turning filepath templates into real filepaths
|
Used for turning filepath templates into real filepaths
|
||||||
"""
|
"""
|
||||||
|
|
||||||
use Pinchflat.RenderedString.Base
|
use Pinchflat.Downloading.OutputPath.Base
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Parses a string into a rendered string, using the provided variables. Optionally
|
Parses a string into a rendered string, using the provided variables. Optionally
|
||||||
+7
-3
@@ -1,9 +1,9 @@
|
|||||||
defmodule Pinchflat.Profiles.OutputPathBuilder do
|
defmodule Pinchflat.Downloading.OutputPathBuilder do
|
||||||
@moduledoc """
|
@moduledoc """
|
||||||
Builds yt-dlp-friendly output paths for downloaded media
|
Builds yt-dlp-friendly output paths for downloaded media
|
||||||
"""
|
"""
|
||||||
|
|
||||||
alias Pinchflat.RenderedString.Parser, as: TemplateParser
|
alias Pinchflat.Downloading.OutputPath.Parser, as: TemplateParser
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Builds the actual final filepath from a given template. Optionally, you can pass in
|
Builds the actual final filepath from a given template. Optionally, you can pass in
|
||||||
@@ -39,7 +39,11 @@ defmodule Pinchflat.Profiles.OutputPathBuilder do
|
|||||||
# Individual parts of the upload date
|
# Individual parts of the upload date
|
||||||
"upload_year" => "%(upload_date>%Y)S",
|
"upload_year" => "%(upload_date>%Y)S",
|
||||||
"upload_month" => "%(upload_date>%m)S",
|
"upload_month" => "%(upload_date>%m)S",
|
||||||
"upload_day" => "%(upload_date>%d)S"
|
"upload_day" => "%(upload_date>%d)S",
|
||||||
|
"upload_yyyy_mm_dd" => "%(upload_date>%Y-%m-%d)S",
|
||||||
|
"season_from_date" => "%(upload_date>%Y)S",
|
||||||
|
"season_episode_from_date" => "s%(upload_date>%Y)Se%(upload_date>%m%d)S",
|
||||||
|
"artist_name" => "%(artist,creator,uploader,uploader_id)S"
|
||||||
}
|
}
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -0,0 +1,78 @@
|
|||||||
|
defmodule Pinchflat.FastIndexing.FastIndexingHelpers do
|
||||||
|
@moduledoc """
|
||||||
|
Methods for performing fast indexing tasks and managing the fast indexing process.
|
||||||
|
|
||||||
|
Many of these methods are made to be kickoff or be consumed by workers.
|
||||||
|
"""
|
||||||
|
|
||||||
|
alias Pinchflat.Repo
|
||||||
|
alias Pinchflat.Media
|
||||||
|
alias Pinchflat.Sources.Source
|
||||||
|
alias Pinchflat.Media.MediaQuery
|
||||||
|
alias Pinchflat.FastIndexing.YoutubeRss
|
||||||
|
alias Pinchflat.Downloading.MediaDownloadWorker
|
||||||
|
alias Pinchflat.FastIndexing.MediaIndexingWorker
|
||||||
|
|
||||||
|
alias Pinchflat.YtDlp.Media, as: YtDlpMedia
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Fetches new media IDs from a source's YouTube RSS feed and kicks off indexing tasks
|
||||||
|
for any new media items. See comments in `MediaIndexingWorker` for more info on the
|
||||||
|
order of operations and how this fits into the indexing process.
|
||||||
|
|
||||||
|
Despite the similar name to `kickoff_fast_indexing_task`, this does work differently.
|
||||||
|
`kickoff_fast_indexing_task` starts a task that _calls_ this function whereas this
|
||||||
|
function starts individual indexing tasks for each new media item. I think it does
|
||||||
|
make sense grammatically, but I could see how that's confusing.
|
||||||
|
|
||||||
|
Returns :ok
|
||||||
|
"""
|
||||||
|
def kickoff_indexing_tasks_from_youtube_rss_feed(%Source{} = source) do
|
||||||
|
{:ok, media_ids} = YoutubeRss.get_recent_media_ids_from_rss(source)
|
||||||
|
existing_media_items = list_media_items_by_media_id_for(source, media_ids)
|
||||||
|
new_media_ids = media_ids -- Enum.map(existing_media_items, & &1.media_id)
|
||||||
|
|
||||||
|
Enum.each(new_media_ids, fn media_id ->
|
||||||
|
url = "https://www.youtube.com/watch?v=#{media_id}"
|
||||||
|
|
||||||
|
MediaIndexingWorker.kickoff_with_task(source, url)
|
||||||
|
end)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Indexes a single media item for a source and enqueues a download job if the
|
||||||
|
media should be downloaded. This method creates the media item record so it's
|
||||||
|
the one-stop-shop for adding a media item (and possibly downloading it) just
|
||||||
|
by a URL and source.
|
||||||
|
|
||||||
|
Returns {:ok, media_item} | {:error, any()}
|
||||||
|
"""
|
||||||
|
def index_and_enqueue_download_for_media_item(%Source{} = source, url) do
|
||||||
|
maybe_media_item = create_media_item_from_url(source, url)
|
||||||
|
|
||||||
|
case maybe_media_item do
|
||||||
|
{:ok, media_item} ->
|
||||||
|
if source.download_media && Media.pending_download?(media_item) do
|
||||||
|
MediaDownloadWorker.kickoff_with_task(media_item)
|
||||||
|
end
|
||||||
|
|
||||||
|
{:ok, media_item}
|
||||||
|
|
||||||
|
err ->
|
||||||
|
err
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp list_media_items_by_media_id_for(source, media_ids) do
|
||||||
|
MediaQuery.new()
|
||||||
|
|> MediaQuery.for_source(source)
|
||||||
|
|> MediaQuery.with_media_ids(media_ids)
|
||||||
|
|> Repo.all()
|
||||||
|
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
|
||||||
+21
-8
@@ -1,4 +1,4 @@
|
|||||||
defmodule Pinchflat.Workers.FastIndexingWorker do
|
defmodule Pinchflat.FastIndexing.FastIndexingWorker do
|
||||||
@moduledoc false
|
@moduledoc false
|
||||||
|
|
||||||
use Oban.Worker,
|
use Oban.Worker,
|
||||||
@@ -6,13 +6,25 @@ defmodule Pinchflat.Workers.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.Sources
|
alias Pinchflat.Sources
|
||||||
alias Pinchflat.Sources.Source
|
alias Pinchflat.Sources.Source
|
||||||
alias Pinchflat.Tasks.SourceTasks
|
alias Pinchflat.FastIndexing.FastIndexingHelpers
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Starts the source fast indexing worker and creates a task for the source.
|
||||||
|
|
||||||
|
Returns {:ok, %Task{}} | {:error, :duplicate_job} | {:error, %Ecto.Changeset{}}
|
||||||
|
"""
|
||||||
|
def kickoff_with_task(source, opts \\ []) do
|
||||||
|
%{id: source.id}
|
||||||
|
|> FastIndexingWorker.new(opts)
|
||||||
|
|> Tasks.create_job_with_task(source)
|
||||||
|
end
|
||||||
|
|
||||||
@impl Oban.Worker
|
|
||||||
@doc """
|
@doc """
|
||||||
Kicks off the fast indexing process for a source, reschedules the job to run again
|
Kicks off the fast indexing process for a source, reschedules the job to run again
|
||||||
once complete. See `MediaCollectionIndexingWorker` and `MediaIndexingWorker` comments
|
once complete. See `MediaCollectionIndexingWorker` and `MediaIndexingWorker` comments
|
||||||
@@ -20,25 +32,26 @@ defmodule Pinchflat.Workers.FastIndexingWorker do
|
|||||||
|
|
||||||
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
|
||||||
SourceTasks.kickoff_indexing_tasks_from_youtube_rss_feed(source)
|
FastIndexingHelpers.kickoff_indexing_tasks_from_youtube_rss_feed(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
|
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
|
||||||
+21
-5
@@ -1,4 +1,4 @@
|
|||||||
defmodule Pinchflat.Workers.MediaIndexingWorker do
|
defmodule Pinchflat.FastIndexing.MediaIndexingWorker do
|
||||||
@moduledoc false
|
@moduledoc false
|
||||||
|
|
||||||
use Oban.Worker,
|
use Oban.Worker,
|
||||||
@@ -8,10 +8,22 @@ defmodule Pinchflat.Workers.MediaIndexingWorker do
|
|||||||
|
|
||||||
require Logger
|
require Logger
|
||||||
|
|
||||||
|
alias __MODULE__
|
||||||
|
alias Pinchflat.Tasks
|
||||||
alias Pinchflat.Sources
|
alias Pinchflat.Sources
|
||||||
alias Pinchflat.Tasks.MediaItemTasks
|
alias Pinchflat.FastIndexing.FastIndexingHelpers
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Starts the fast media indexing worker and creates a task for the source.
|
||||||
|
|
||||||
|
Returns {:ok, %Task{}} | {:error, :duplicate_job} | {:error, %Ecto.Changeset{}}
|
||||||
|
"""
|
||||||
|
def kickoff_with_task(source, media_url, opts \\ []) do
|
||||||
|
%{id: source.id, media_url: media_url}
|
||||||
|
|> MediaIndexingWorker.new(opts)
|
||||||
|
|> Tasks.create_job_with_task(source)
|
||||||
|
end
|
||||||
|
|
||||||
@impl Oban.Worker
|
|
||||||
@doc """
|
@doc """
|
||||||
Similar to `MediaCollectionIndexingWorker`, but for individual media items.
|
Similar to `MediaCollectionIndexingWorker`, but for individual media items.
|
||||||
Does not reschedule or check anything to do with a source's indexing
|
Does not reschedule or check anything to do with a source's indexing
|
||||||
@@ -23,7 +35,7 @@ defmodule Pinchflat.Workers.MediaIndexingWorker do
|
|||||||
and the media matches the profile's format preferences)
|
and the media matches the profile's format preferences)
|
||||||
|
|
||||||
Order of operations:
|
Order of operations:
|
||||||
1. SourceTasks.kickoff_indexing_tasks_from_youtube_rss_feed/1 (which is running
|
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
|
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
|
2. If new media is found, it enqueues a MediaIndexingWorker (this module) for each new media
|
||||||
item
|
item
|
||||||
@@ -37,10 +49,11 @@ defmodule Pinchflat.Workers.MediaIndexingWorker do
|
|||||||
|
|
||||||
Returns :ok
|
Returns :ok
|
||||||
"""
|
"""
|
||||||
|
@impl Oban.Worker
|
||||||
def perform(%Oban.Job{args: %{"id" => source_id, "media_url" => media_url}}) do
|
def perform(%Oban.Job{args: %{"id" => source_id, "media_url" => media_url}}) do
|
||||||
source = Sources.get_source!(source_id)
|
source = Sources.get_source!(source_id)
|
||||||
|
|
||||||
case MediaItemTasks.index_and_enqueue_download_for_media_item(source, media_url) do
|
case FastIndexingHelpers.index_and_enqueue_download_for_media_item(source, media_url) do
|
||||||
{:ok, media_item} ->
|
{:ok, media_item} ->
|
||||||
Logger.debug("Indexed and enqueued download for url: #{media_url} (media item: #{media_item.id})")
|
Logger.debug("Indexed and enqueued download for url: #{media_url} (media item: #{media_item.id})")
|
||||||
|
|
||||||
@@ -49,5 +62,8 @@ defmodule Pinchflat.Workers.MediaIndexingWorker do
|
|||||||
end
|
end
|
||||||
|
|
||||||
:ok
|
:ok
|
||||||
|
rescue
|
||||||
|
Ecto.NoResultsError -> Logger.info("#{__MODULE__} discarded: source #{source_id} not found")
|
||||||
|
Ecto.StaleEntryError -> Logger.info("#{__MODULE__} discarded: source #{source_id} stale")
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
defmodule Pinchflat.Api.YoutubeRss do
|
defmodule Pinchflat.FastIndexing.YoutubeRss do
|
||||||
@moduledoc """
|
@moduledoc """
|
||||||
Methods for interacting with YouTube RSS feeds
|
Methods for interacting with YouTube RSS feeds
|
||||||
"""
|
"""
|
||||||
@@ -0,0 +1,107 @@
|
|||||||
|
defmodule Pinchflat.Filesystem.FilesystemHelpers do
|
||||||
|
@moduledoc """
|
||||||
|
Utility methods for working with the filesystem
|
||||||
|
"""
|
||||||
|
alias Pinchflat.Media
|
||||||
|
alias Pinchflat.Utils.StringUtils
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Generates a temporary file and returns its path. The file is empty and has the given type.
|
||||||
|
Generates all the directories in the path if they don't exist.
|
||||||
|
|
||||||
|
Returns binary()
|
||||||
|
"""
|
||||||
|
def generate_metadata_tmpfile(type) do
|
||||||
|
tmpfile_directory = Application.get_env(:pinchflat, :tmpfile_directory)
|
||||||
|
filepath = Path.join([tmpfile_directory, "#{StringUtils.random_string(64)}.#{type}"])
|
||||||
|
|
||||||
|
:ok = write_p!(filepath, "")
|
||||||
|
|
||||||
|
filepath
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Writes content to a file, creating directories as needed.
|
||||||
|
Takes the same args as File.write/3.
|
||||||
|
|
||||||
|
Returns :ok | {:error, any()}
|
||||||
|
"""
|
||||||
|
def write_p(file, content, modes \\ []) do
|
||||||
|
dirname = Path.dirname(file)
|
||||||
|
|
||||||
|
case File.mkdir_p(dirname) do
|
||||||
|
:ok -> File.write(file, content, modes)
|
||||||
|
err -> err
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Writes content to a file, creating directories as needed.
|
||||||
|
Takes the same args as File.write!/3.
|
||||||
|
|
||||||
|
Returns :ok | raises on error
|
||||||
|
"""
|
||||||
|
def write_p!(filepath, content, modes \\ []) do
|
||||||
|
:ok = write_p(filepath, content, modes)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Copies a file from source to destination, creating directories as needed.
|
||||||
|
|
||||||
|
Returns :ok | raises on error
|
||||||
|
"""
|
||||||
|
def cp_p!(source, destination) do
|
||||||
|
destination
|
||||||
|
|> Path.dirname()
|
||||||
|
|> File.mkdir_p!()
|
||||||
|
|
||||||
|
File.cp!(source, destination)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Fetches the file size of a media item and saves it to the database.
|
||||||
|
|
||||||
|
Returns {:ok, media_item} | {:error, any()}
|
||||||
|
"""
|
||||||
|
def compute_and_save_media_filesize(media_item) do
|
||||||
|
case File.stat(media_item.media_filepath) do
|
||||||
|
{:ok, %{size: size}} ->
|
||||||
|
Media.update_media_item(media_item, %{media_size_bytes: size})
|
||||||
|
|
||||||
|
err ->
|
||||||
|
err
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Deletes a file and removes any empty directories in the path.
|
||||||
|
Does NOT remove any directories that are not empty.
|
||||||
|
|
||||||
|
Returns :ok | {:error, any()}
|
||||||
|
"""
|
||||||
|
def delete_file_and_remove_empty_directories(filepath) do
|
||||||
|
case File.rm(filepath) do
|
||||||
|
:ok ->
|
||||||
|
filepath
|
||||||
|
|> Path.dirname()
|
||||||
|
|> recursively_delete_empty_directories()
|
||||||
|
|
||||||
|
err ->
|
||||||
|
err
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp recursively_delete_empty_directories(directory) do
|
||||||
|
case File.rmdir(directory) do
|
||||||
|
:ok ->
|
||||||
|
directory
|
||||||
|
|> Path.dirname()
|
||||||
|
|> recursively_delete_empty_directories()
|
||||||
|
|
||||||
|
err ->
|
||||||
|
err
|
||||||
|
end
|
||||||
|
|
||||||
|
:ok
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -1,307 +0,0 @@
|
|||||||
defmodule Pinchflat.Media do
|
|
||||||
@moduledoc """
|
|
||||||
The Media context.
|
|
||||||
"""
|
|
||||||
|
|
||||||
import Ecto.Query, warn: false
|
|
||||||
|
|
||||||
alias Pinchflat.Repo
|
|
||||||
alias Pinchflat.Tasks
|
|
||||||
alias Pinchflat.Media.MediaItem
|
|
||||||
alias Pinchflat.Sources.Source
|
|
||||||
alias Pinchflat.Media.MediaMetadata
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Returns the list of media_items.
|
|
||||||
|
|
||||||
Returns [%MediaItem{}, ...].
|
|
||||||
"""
|
|
||||||
def list_media_items do
|
|
||||||
Repo.all(MediaItem)
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Returns a list of media_items for a given source.
|
|
||||||
|
|
||||||
Returns [%MediaItem{}, ...].
|
|
||||||
"""
|
|
||||||
def list_media_items_for(%Source{} = source) do
|
|
||||||
MediaItem
|
|
||||||
|> where([mi], mi.source_id == ^source.id)
|
|
||||||
|> Repo.all()
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Fetches all media items belonging to a given source that have a media_id in the given list.
|
|
||||||
Useful for determining the what media items we DON'T already have for fast indexing.
|
|
||||||
|
|
||||||
NOTE: These queries are getting a little tedious. When I have the time, I should see about
|
|
||||||
implementing a query pattern and having these compose queries from a common base. This would
|
|
||||||
also let me compose simple queries in the module using them for one-off methods
|
|
||||||
|
|
||||||
Returns [%MediaItem{}, ...].
|
|
||||||
"""
|
|
||||||
def list_media_items_by_media_id_for(%Source{} = source, media_ids) do
|
|
||||||
MediaItem
|
|
||||||
|> where([mi], mi.source_id == ^source.id and mi.media_id in ^media_ids)
|
|
||||||
|> Repo.all()
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Returns a list of pending media_items for a given source, where
|
|
||||||
pending means the `media_filepath` is `nil` AND the media_item
|
|
||||||
matches the format selection rules of the parent media_profile.
|
|
||||||
|
|
||||||
See `build_format_clauses` but tl;dr is it _may_ filter based
|
|
||||||
on shorts or livestreams depending on the media_profile settings.
|
|
||||||
|
|
||||||
Returns [%MediaItem{}, ...].
|
|
||||||
"""
|
|
||||||
def list_pending_media_items_for(%Source{} = source, opts \\ []) do
|
|
||||||
limit = Keyword.get(opts, :limit, nil)
|
|
||||||
media_profile = Repo.preload(source, :media_profile).media_profile
|
|
||||||
|
|
||||||
MediaItem
|
|
||||||
|> where([mi], mi.source_id == ^source.id and is_nil(mi.media_filepath))
|
|
||||||
|> where(^build_format_clauses(media_profile))
|
|
||||||
|> 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()
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
For a given media_item, tells you if it is pending download. This is defined as
|
|
||||||
the media_item having a `media_filepath` of `nil` and matching the format selection
|
|
||||||
rules of the parent media_profile.
|
|
||||||
|
|
||||||
Intentionally does not take the `download_media` setting of the source into account.
|
|
||||||
|
|
||||||
Returns boolean()
|
|
||||||
"""
|
|
||||||
def pending_download?(%MediaItem{} = media_item) do
|
|
||||||
media_item = Repo.preload(media_item, source: :media_profile)
|
|
||||||
|
|
||||||
MediaItem
|
|
||||||
|> where([mi], mi.id == ^media_item.id and is_nil(mi.media_filepath))
|
|
||||||
|> where(^build_format_clauses(media_item.source.media_profile))
|
|
||||||
|> where(^maybe_apply_cutoff_date(media_item.source))
|
|
||||||
|> Repo.exists?()
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Returns a list of media_items that match the search term. Adds a `matching_search_term`
|
|
||||||
virtual field to the result set.
|
|
||||||
|
|
||||||
Has explit handling for blank search terms because SQLite doesn't like empty MATCH clauses.
|
|
||||||
|
|
||||||
Returns [%MediaItem{}, ...].
|
|
||||||
"""
|
|
||||||
def search(_search_term, _opts \\ [])
|
|
||||||
def search("", _opts), do: []
|
|
||||||
def search(nil, _opts), do: []
|
|
||||||
|
|
||||||
def search(search_term, opts) do
|
|
||||||
limit = Keyword.get(opts, :limit, 50)
|
|
||||||
|
|
||||||
from(mi in MediaItem,
|
|
||||||
join: mi_search_index in assoc(mi, :media_items_search_index),
|
|
||||||
where: fragment("media_items_search_index MATCH ?", ^search_term),
|
|
||||||
select_merge: %{
|
|
||||||
matching_search_term:
|
|
||||||
fragment("""
|
|
||||||
coalesce(snippet(media_items_search_index, 0, '[PF_HIGHLIGHT]', '[/PF_HIGHLIGHT]', '...', 20), '') ||
|
|
||||||
' ' ||
|
|
||||||
coalesce(snippet(media_items_search_index, 1, '[PF_HIGHLIGHT]', '[/PF_HIGHLIGHT]', '...', 20), '')
|
|
||||||
""")
|
|
||||||
},
|
|
||||||
order_by: [desc: fragment("rank")],
|
|
||||||
limit: ^limit
|
|
||||||
)
|
|
||||||
|> Repo.all()
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Gets a single media_item.
|
|
||||||
|
|
||||||
Returns %MediaItem{}. Raises `Ecto.NoResultsError` if the Media item does not exist.
|
|
||||||
"""
|
|
||||||
def get_media_item!(id), do: Repo.get!(MediaItem, id)
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Produces a flat list of the filesystem paths for a media_item's downloaded files
|
|
||||||
|
|
||||||
Returns [binary()]
|
|
||||||
"""
|
|
||||||
def media_filepaths(media_item) do
|
|
||||||
mapped_struct = Map.from_struct(media_item)
|
|
||||||
|
|
||||||
MediaItem.filepath_attributes()
|
|
||||||
|> Enum.map(fn
|
|
||||||
:subtitle_filepaths = field -> Enum.map(mapped_struct[field], fn [_, filepath] -> filepath end)
|
|
||||||
field -> List.wrap(mapped_struct[field])
|
|
||||||
end)
|
|
||||||
|> List.flatten()
|
|
||||||
|> Enum.filter(&is_binary/1)
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Produces a flat list of the filesystem paths for a media_item's metadata files.
|
|
||||||
Returns an empty list if the media_item has no metadata.
|
|
||||||
|
|
||||||
Returns [binary()] | []
|
|
||||||
"""
|
|
||||||
def metadata_filepaths(media_item) do
|
|
||||||
metadata = Repo.preload(media_item, :metadata).metadata || %MediaMetadata{}
|
|
||||||
mapped_struct = Map.from_struct(metadata)
|
|
||||||
|
|
||||||
MediaMetadata.filepath_attributes()
|
|
||||||
|> Enum.map(fn field -> mapped_struct[field] end)
|
|
||||||
|> Enum.filter(&is_binary/1)
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Creates a media_item.
|
|
||||||
|
|
||||||
Returns {:ok, %MediaItem{}} | {:error, %Ecto.Changeset{}}
|
|
||||||
"""
|
|
||||||
def create_media_item(attrs) do
|
|
||||||
%MediaItem{}
|
|
||||||
|> MediaItem.changeset(attrs)
|
|
||||||
|> Repo.insert()
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Creates a media item from the attributes returned by the video backend
|
|
||||||
(read: yt-dlp).
|
|
||||||
|
|
||||||
Unlike `create_media_item`, this will attempt an update if the media_item
|
|
||||||
already exists. This is so that future indexing can pick up attributes that
|
|
||||||
we may not have asked for in the past (eg: upload_date)
|
|
||||||
|
|
||||||
Returns {:ok, %MediaItem{}} | {:error, %Ecto.Changeset{}}
|
|
||||||
"""
|
|
||||||
def create_media_item_from_backend_attrs(source, media_attrs_struct) do
|
|
||||||
attrs = Map.merge(%{source_id: source.id}, Map.from_struct(media_attrs_struct))
|
|
||||||
|
|
||||||
%MediaItem{}
|
|
||||||
|> MediaItem.changeset(attrs)
|
|
||||||
|> Repo.insert(
|
|
||||||
on_conflict: [
|
|
||||||
set: Map.to_list(attrs)
|
|
||||||
],
|
|
||||||
conflict_target: [:source_id, :media_id]
|
|
||||||
)
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Updates a media_item.
|
|
||||||
|
|
||||||
Returns {:ok, %MediaItem{}} | {:error, %Ecto.Changeset{}}
|
|
||||||
"""
|
|
||||||
def update_media_item(%MediaItem{} = media_item, attrs) do
|
|
||||||
media_item
|
|
||||||
|> MediaItem.changeset(attrs)
|
|
||||||
|> Repo.update()
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Deletes a media_item and its associated tasks.
|
|
||||||
Can optionally delete the media_item's files.
|
|
||||||
|
|
||||||
Returns {:ok, %MediaItem{}} | {:error, %Ecto.Changeset{}}
|
|
||||||
"""
|
|
||||||
def delete_media_item(%MediaItem{} = media_item, opts \\ []) do
|
|
||||||
delete_files = Keyword.get(opts, :delete_files, false)
|
|
||||||
|
|
||||||
if delete_files do
|
|
||||||
{:ok, _} = delete_all_attachments(media_item)
|
|
||||||
end
|
|
||||||
|
|
||||||
Tasks.delete_tasks_for(media_item)
|
|
||||||
Repo.delete(media_item)
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Returns an `%Ecto.Changeset{}` for tracking media_item changes.
|
|
||||||
"""
|
|
||||||
def change_media_item(%MediaItem{} = media_item, attrs \\ %{}) do
|
|
||||||
MediaItem.changeset(media_item, attrs)
|
|
||||||
end
|
|
||||||
|
|
||||||
defp delete_all_attachments(media_item) do
|
|
||||||
media_item = Repo.preload(media_item, :metadata)
|
|
||||||
|
|
||||||
media_item
|
|
||||||
|> media_filepaths()
|
|
||||||
|> Enum.concat(metadata_filepaths(media_item))
|
|
||||||
|> Enum.each(&File.rm/1)
|
|
||||||
|
|
||||||
# rmdir will attempt to delete the directory, but only if it is empty
|
|
||||||
if media_item.media_filepath do
|
|
||||||
File.rmdir(Path.dirname(media_item.media_filepath))
|
|
||||||
end
|
|
||||||
|
|
||||||
if media_item.metadata && media_item.metadata.metadata_filepath do
|
|
||||||
File.rmdir(Path.dirname(media_item.metadata.metadata_filepath))
|
|
||||||
end
|
|
||||||
|
|
||||||
{:ok, media_item}
|
|
||||||
end
|
|
||||||
|
|
||||||
defp maybe_apply_cutoff_date(source) do
|
|
||||||
if source.download_cutoff_date do
|
|
||||||
dynamic([mi], mi.upload_date >= ^source.download_cutoff_date)
|
|
||||||
else
|
|
||||||
dynamic(true)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
defp build_format_clauses(media_profile) do
|
|
||||||
mapped_struct = Map.from_struct(media_profile)
|
|
||||||
|
|
||||||
Enum.reduce(mapped_struct, dynamic(true), fn attr, dynamic ->
|
|
||||||
case {attr, media_profile} do
|
|
||||||
{{:shorts_behaviour, :only}, %{livestream_behaviour: :only}} ->
|
|
||||||
dynamic(
|
|
||||||
[mi],
|
|
||||||
^dynamic and (mi.livestream == true or mi.short_form_content == true)
|
|
||||||
)
|
|
||||||
|
|
||||||
# Technically redundant, but makes the other clauses easier to parse
|
|
||||||
# (redundant because this condition is the same as the condition above, just flipped)
|
|
||||||
{{:livestream_behaviour, :only}, %{shorts_behaviour: :only}} ->
|
|
||||||
dynamic
|
|
||||||
|
|
||||||
{{:shorts_behaviour, :only}, _} ->
|
|
||||||
dynamic([mi], ^dynamic and mi.short_form_content == true)
|
|
||||||
|
|
||||||
{{:livestream_behaviour, :only}, _} ->
|
|
||||||
dynamic([mi], ^dynamic and mi.livestream == true)
|
|
||||||
|
|
||||||
{{:shorts_behaviour, :exclude}, %{livestream_behaviour: lb}} when lb != :only ->
|
|
||||||
dynamic([mi], ^dynamic and mi.short_form_content == false)
|
|
||||||
|
|
||||||
{{:livestream_behaviour, :exclude}, %{shorts_behaviour: sb}} when sb != :only ->
|
|
||||||
# return records with livestream: false
|
|
||||||
dynamic([mi], ^dynamic and mi.livestream == false)
|
|
||||||
|
|
||||||
_ ->
|
|
||||||
dynamic
|
|
||||||
end
|
|
||||||
end)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -0,0 +1,211 @@
|
|||||||
|
defmodule Pinchflat.Media do
|
||||||
|
@moduledoc """
|
||||||
|
The Media context.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import Ecto.Query, warn: false
|
||||||
|
|
||||||
|
alias Pinchflat.Repo
|
||||||
|
alias Pinchflat.Tasks
|
||||||
|
alias Pinchflat.Sources.Source
|
||||||
|
alias Pinchflat.Media.MediaItem
|
||||||
|
alias Pinchflat.Media.MediaQuery
|
||||||
|
alias Pinchflat.Metadata.MediaMetadata
|
||||||
|
alias Pinchflat.Filesystem.FilesystemHelpers
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Returns the list of media_items.
|
||||||
|
|
||||||
|
Returns [%MediaItem{}, ...].
|
||||||
|
"""
|
||||||
|
def list_media_items do
|
||||||
|
Repo.all(MediaItem)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Returns a list of pending media_items for a given source, where
|
||||||
|
pending means the `media_filepath` is `nil` AND the media_item
|
||||||
|
matches the format selection rules of the parent media_profile.
|
||||||
|
|
||||||
|
See `build_format_clauses` but tl;dr is it _may_ filter based
|
||||||
|
on shorts or livestreams depending on the media_profile settings.
|
||||||
|
|
||||||
|
Returns [%MediaItem{}, ...].
|
||||||
|
"""
|
||||||
|
def list_pending_media_items_for(%Source{} = source, opts \\ []) do
|
||||||
|
limit = Keyword.get(opts, :limit, nil)
|
||||||
|
source = Repo.preload(source, :media_profile)
|
||||||
|
|
||||||
|
MediaQuery.new()
|
||||||
|
|> MediaQuery.for_source(source)
|
||||||
|
|> matching_download_criteria_for(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)
|
||||||
|
|
||||||
|
MediaQuery.new()
|
||||||
|
|> MediaQuery.for_source(source)
|
||||||
|
|> MediaQuery.with_media_filepath()
|
||||||
|
|> Repo.maybe_limit(limit)
|
||||||
|
|> Repo.all()
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
For a given media_item, tells you if it is pending download. This is defined as
|
||||||
|
the media_item having a `media_filepath` of `nil` and matching the format selection
|
||||||
|
rules of the parent media_profile.
|
||||||
|
|
||||||
|
Intentionally does not take the `download_media` setting of the source into account.
|
||||||
|
|
||||||
|
Returns boolean()
|
||||||
|
"""
|
||||||
|
def pending_download?(%MediaItem{} = media_item) do
|
||||||
|
media_item = Repo.preload(media_item, source: :media_profile)
|
||||||
|
|
||||||
|
MediaQuery.new()
|
||||||
|
|> MediaQuery.with_id(media_item.id)
|
||||||
|
|> matching_download_criteria_for(media_item.source)
|
||||||
|
|> Repo.exists?()
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Returns a list of media_items that match the search term. Adds a `matching_search_term`
|
||||||
|
virtual field to the result set.
|
||||||
|
|
||||||
|
Has explit handling for blank search terms because SQLite doesn't like empty MATCH clauses.
|
||||||
|
|
||||||
|
Returns [%MediaItem{}, ...].
|
||||||
|
"""
|
||||||
|
def search(_search_term, _opts \\ [])
|
||||||
|
def search("", _opts), do: []
|
||||||
|
def search(nil, _opts), do: []
|
||||||
|
|
||||||
|
def search(search_term, opts) do
|
||||||
|
limit = Keyword.get(opts, :limit, 50)
|
||||||
|
|
||||||
|
MediaQuery.new()
|
||||||
|
|> MediaQuery.matching_search_term(search_term)
|
||||||
|
|> Repo.maybe_limit(limit)
|
||||||
|
|> Repo.all()
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Gets a single media_item.
|
||||||
|
|
||||||
|
Returns %MediaItem{}. Raises `Ecto.NoResultsError` if the Media item does not exist.
|
||||||
|
"""
|
||||||
|
def get_media_item!(id), do: Repo.get!(MediaItem, id)
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Creates a media_item.
|
||||||
|
|
||||||
|
Returns {:ok, %MediaItem{}} | {:error, %Ecto.Changeset{}}
|
||||||
|
"""
|
||||||
|
def create_media_item(attrs) do
|
||||||
|
%MediaItem{}
|
||||||
|
|> MediaItem.changeset(attrs)
|
||||||
|
|> Repo.insert()
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Creates a media item from the attributes returned by the video backend
|
||||||
|
(read: yt-dlp).
|
||||||
|
|
||||||
|
Unlike `create_media_item`, this will attempt an update if the media_item
|
||||||
|
already exists. This is so that future indexing can pick up attributes that
|
||||||
|
we may not have asked for in the past (eg: upload_date)
|
||||||
|
|
||||||
|
Returns {:ok, %MediaItem{}} | {:error, %Ecto.Changeset{}}
|
||||||
|
"""
|
||||||
|
def create_media_item_from_backend_attrs(source, media_attrs_struct) do
|
||||||
|
attrs = Map.merge(%{source_id: source.id}, Map.from_struct(media_attrs_struct))
|
||||||
|
|
||||||
|
%MediaItem{}
|
||||||
|
|> MediaItem.changeset(attrs)
|
||||||
|
|> Repo.insert(
|
||||||
|
on_conflict: [
|
||||||
|
set: Map.to_list(attrs)
|
||||||
|
],
|
||||||
|
conflict_target: [:source_id, :media_id]
|
||||||
|
)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Updates a media_item.
|
||||||
|
|
||||||
|
Returns {:ok, %MediaItem{}} | {:error, %Ecto.Changeset{}}
|
||||||
|
"""
|
||||||
|
def update_media_item(%MediaItem{} = media_item, attrs) do
|
||||||
|
media_item
|
||||||
|
|> MediaItem.changeset(attrs)
|
||||||
|
|> Repo.update()
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Deletes a media_item, its associated tasks, and our internal metadata files.
|
||||||
|
Can optionally delete the media_item's media files (media, thumbnail, subtitles, etc).
|
||||||
|
|
||||||
|
Returns {:ok, %MediaItem{}} | {:error, %Ecto.Changeset{}}
|
||||||
|
"""
|
||||||
|
def delete_media_item(%MediaItem{} = media_item, opts \\ []) do
|
||||||
|
delete_files = Keyword.get(opts, :delete_files, false)
|
||||||
|
|
||||||
|
Tasks.delete_tasks_for(media_item)
|
||||||
|
|
||||||
|
if delete_files do
|
||||||
|
{:ok, _} = delete_media_files(media_item)
|
||||||
|
end
|
||||||
|
|
||||||
|
# Should delete these no matter what
|
||||||
|
delete_internal_metadata_files(media_item)
|
||||||
|
Repo.delete(media_item)
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Returns an `%Ecto.Changeset{}` for tracking media_item changes.
|
||||||
|
"""
|
||||||
|
def change_media_item(%MediaItem{} = media_item, attrs \\ %{}) do
|
||||||
|
MediaItem.changeset(media_item, attrs)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp delete_media_files(media_item) do
|
||||||
|
mapped_struct = Map.from_struct(media_item)
|
||||||
|
|
||||||
|
MediaItem.filepath_attributes()
|
||||||
|
|> Enum.map(fn
|
||||||
|
:subtitle_filepaths = field -> Enum.map(mapped_struct[field], fn [_, filepath] -> filepath end)
|
||||||
|
field -> List.wrap(mapped_struct[field])
|
||||||
|
end)
|
||||||
|
|> List.flatten()
|
||||||
|
|> Enum.filter(&is_binary/1)
|
||||||
|
|> Enum.each(&FilesystemHelpers.delete_file_and_remove_empty_directories/1)
|
||||||
|
|
||||||
|
{:ok, media_item}
|
||||||
|
end
|
||||||
|
|
||||||
|
defp delete_internal_metadata_files(media_item) do
|
||||||
|
metadata = Repo.preload(media_item, :metadata).metadata || %MediaMetadata{}
|
||||||
|
mapped_struct = Map.from_struct(metadata)
|
||||||
|
|
||||||
|
MediaMetadata.filepath_attributes()
|
||||||
|
|> Enum.map(fn field -> mapped_struct[field] end)
|
||||||
|
|> Enum.filter(&is_binary/1)
|
||||||
|
|> Enum.each(&FilesystemHelpers.delete_file_and_remove_empty_directories/1)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp matching_download_criteria_for(query, source_with_preloads) do
|
||||||
|
query
|
||||||
|
|> MediaQuery.with_no_media_filepath()
|
||||||
|
|> MediaQuery.with_upload_date_after(source_with_preloads.download_cutoff_date)
|
||||||
|
|> MediaQuery.with_format_preference(source_with_preloads.media_profile)
|
||||||
|
|> MediaQuery.matching_title_regex(source_with_preloads.title_filter_regex)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -5,11 +5,12 @@ 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
|
||||||
alias Pinchflat.Media.MediaMetadata
|
alias Pinchflat.Metadata.MediaMetadata
|
||||||
alias Pinchflat.Media.MediaItemSearchIndex
|
alias Pinchflat.Media.MediaItemsSearchIndex
|
||||||
|
|
||||||
@allowed_fields [
|
@allowed_fields [
|
||||||
# these fields are captured on indexing (and again on download)
|
# these fields are captured on indexing (and again on download)
|
||||||
@@ -21,16 +22,19 @@ 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
|
||||||
]
|
]
|
||||||
# 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
|
||||||
@@ -41,6 +45,11 @@ defmodule Pinchflat.Media.MediaItem do
|
|||||||
)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
|
||||||
@@ -49,11 +58,13 @@ defmodule Pinchflat.Media.MediaItem do
|
|||||||
field :short_form_content, :boolean, default: false
|
field :short_form_content, :boolean, default: false
|
||||||
field :media_downloaded_at, :utc_datetime
|
field :media_downloaded_at, :utc_datetime
|
||||||
field :upload_date, :date
|
field :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.
|
||||||
@@ -64,7 +75,7 @@ defmodule Pinchflat.Media.MediaItem do
|
|||||||
belongs_to :source, Source
|
belongs_to :source, Source
|
||||||
|
|
||||||
has_one :metadata, MediaMetadata, on_replace: :update
|
has_one :metadata, MediaMetadata, on_replace: :update
|
||||||
has_one :media_items_search_index, MediaItemSearchIndex, foreign_key: :id
|
has_one :media_items_search_index, MediaItemsSearchIndex, foreign_key: :id
|
||||||
|
|
||||||
has_many :tasks, Task
|
has_many :tasks, Task
|
||||||
|
|
||||||
@@ -76,12 +87,13 @@ 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
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
defmodule Pinchflat.Media.MediaItemSearchIndex do
|
defmodule Pinchflat.Media.MediaItemsSearchIndex do
|
||||||
@moduledoc """
|
@moduledoc """
|
||||||
The MediaItem fts5 search index. Not made to be directly interacted with,
|
The MediaItem fts5 search index. Not made to be directly interacted with,
|
||||||
but I figured it'd be better to have it in-app so it's not a mystery.
|
but I figured it'd be better to have it in-app so it's not a mystery.
|
||||||
|
|||||||
@@ -0,0 +1,120 @@
|
|||||||
|
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 for media items. 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.
|
||||||
|
|
||||||
|
ALSO, this is me trying something new. If I like it,
|
||||||
|
I'll refactor other contexts to use this pattern.
|
||||||
|
"""
|
||||||
|
import Ecto.Query, warn: false
|
||||||
|
|
||||||
|
alias Pinchflat.Media.MediaItem
|
||||||
|
|
||||||
|
# Prefixes:
|
||||||
|
# - for_* - belonging to 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
|
||||||
|
MediaItem
|
||||||
|
end
|
||||||
|
|
||||||
|
def for_source(query, source) do
|
||||||
|
where(query, [mi], mi.source_id == ^source.id)
|
||||||
|
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_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(query, nil), do: query
|
||||||
|
|
||||||
|
def with_upload_date_after(query, date) do
|
||||||
|
where(query, [mi], mi.upload_date >= ^date)
|
||||||
|
end
|
||||||
|
|
||||||
|
def matching_title_regex(query, nil), do: query
|
||||||
|
|
||||||
|
def matching_title_regex(query, regex) do
|
||||||
|
where(query, [mi], fragment("regexp_like(?, ?)", mi.title, ^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
|
||||||
|
|
||||||
|
# NOTE: this method breaks the contract set by other methods in that it
|
||||||
|
# takes a media_profile struct instead of taking just the attributes it
|
||||||
|
# cares about. Consider refactoring but low priority.
|
||||||
|
def with_format_preference(query, media_profile) do
|
||||||
|
mapped_struct = Map.from_struct(media_profile)
|
||||||
|
|
||||||
|
finders =
|
||||||
|
Enum.reduce(mapped_struct, dynamic(true), fn attr, dynamic ->
|
||||||
|
case {attr, media_profile} do
|
||||||
|
{{:shorts_behaviour, :only}, %{livestream_behaviour: :only}} ->
|
||||||
|
dynamic(
|
||||||
|
[mi],
|
||||||
|
^dynamic and (mi.livestream == true or mi.short_form_content == true)
|
||||||
|
)
|
||||||
|
|
||||||
|
# Technically redundant, but makes the other clauses easier to parse
|
||||||
|
# (redundant because this condition is the same as the condition above, just flipped)
|
||||||
|
{{:livestream_behaviour, :only}, %{shorts_behaviour: :only}} ->
|
||||||
|
dynamic
|
||||||
|
|
||||||
|
{{:shorts_behaviour, :only}, _} ->
|
||||||
|
dynamic([mi], ^dynamic and mi.short_form_content == true)
|
||||||
|
|
||||||
|
{{:livestream_behaviour, :only}, _} ->
|
||||||
|
dynamic([mi], ^dynamic and mi.livestream == true)
|
||||||
|
|
||||||
|
{{:shorts_behaviour, :exclude}, %{livestream_behaviour: lb}} when lb != :only ->
|
||||||
|
dynamic([mi], ^dynamic and mi.short_form_content == false)
|
||||||
|
|
||||||
|
{{:livestream_behaviour, :exclude}, %{shorts_behaviour: sb}} when sb != :only ->
|
||||||
|
# return records with livestream: false
|
||||||
|
dynamic([mi], ^dynamic and mi.livestream == false)
|
||||||
|
|
||||||
|
_ ->
|
||||||
|
dynamic
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
|
||||||
|
where(query, ^finders)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
defmodule Pinchflat.Media.MediaMetadata do
|
defmodule Pinchflat.Metadata.MediaMetadata do
|
||||||
@moduledoc """
|
@moduledoc """
|
||||||
The MediaMetadata schema.
|
The MediaMetadata schema.
|
||||||
|
|
||||||
@@ -9,6 +9,24 @@ defmodule Pinchflat.Metadata.MetadataFileHelpers do
|
|||||||
needed
|
needed
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
alias Pinchflat.Filesystem.FilesystemHelpers
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Returns the directory where metadata for a database record should be stored.
|
||||||
|
|
||||||
|
Returns binary()
|
||||||
|
"""
|
||||||
|
def metadata_directory_for(database_record) do
|
||||||
|
metadata_directory = Application.get_env(:pinchflat, :metadata_directory)
|
||||||
|
record_table_name = database_record.__meta__.source
|
||||||
|
|
||||||
|
Path.join([
|
||||||
|
metadata_directory,
|
||||||
|
record_table_name,
|
||||||
|
to_string(database_record.id)
|
||||||
|
])
|
||||||
|
end
|
||||||
|
|
||||||
@doc """
|
@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 = FilesystemHelpers.write_p!(filepath, json, [:compressed])
|
||||||
:ok = File.write(filepath, json, [:compressed])
|
|
||||||
|
|
||||||
filepath
|
filepath
|
||||||
end
|
end
|
||||||
@@ -45,12 +62,60 @@ defmodule Pinchflat.Metadata.MetadataFileHelpers do
|
|||||||
filepath = generate_filepath_for(database_record, Path.basename(thumbnail_url))
|
filepath = generate_filepath_for(database_record, Path.basename(thumbnail_url))
|
||||||
thumbnail_blob = fetch_thumbnail_from_url(thumbnail_url)
|
thumbnail_blob = fetch_thumbnail_from_url(thumbnail_url)
|
||||||
|
|
||||||
File.mkdir_p!(Path.dirname(filepath))
|
:ok = FilesystemHelpers.write_p!(filepath, thumbnail_blob)
|
||||||
:ok = File.write(filepath, thumbnail_blob)
|
|
||||||
|
|
||||||
filepath
|
filepath
|
||||||
end
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Parses an upload date from the YYYYMMDD string returned in yt-dlp metadata
|
||||||
|
and returns a Date struct.
|
||||||
|
|
||||||
|
Returns Date.t()
|
||||||
|
"""
|
||||||
|
def parse_upload_date(upload_date) do
|
||||||
|
<<year::binary-size(4)>> <> <<month::binary-size(2)>> <> <<day::binary-size(2)>> = upload_date
|
||||||
|
|
||||||
|
Date.from_iso8601!("#{year}-#{month}-#{day}")
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Attempts to determine the series directory from a media filepath.
|
||||||
|
The series directory is the "root" directory for a given source
|
||||||
|
which should contain all the season-level folders of that source.
|
||||||
|
|
||||||
|
Used for determining where to store things like NFO data and banners
|
||||||
|
for media center apps. Not useful without a media center app.
|
||||||
|
|
||||||
|
Returns {:ok, binary()} | {:error, :indeterminable}
|
||||||
|
"""
|
||||||
|
def series_directory_from_media_filepath(media_filepath) do
|
||||||
|
# Matches "s" or "season" (case-insensitive)
|
||||||
|
# followed by an optional non-word character (. or _ or <space>, etc)
|
||||||
|
# followed by at least one digit
|
||||||
|
# followed immediately by the end of the string
|
||||||
|
# Example matches: s1, s.1, s01 season 1, Season.01, Season_1, Season 1, Season1
|
||||||
|
# Example non-matches: s01e01, season, series 1,
|
||||||
|
season_regex = ~r/^s(eason)?(\W|_)?\d{1,}$/i
|
||||||
|
|
||||||
|
{series_directory, found_series_directory} =
|
||||||
|
media_filepath
|
||||||
|
|> Path.split()
|
||||||
|
|> Enum.reduce_while({[], false}, fn part, {directory_acc, _} ->
|
||||||
|
if String.match?(part, season_regex) do
|
||||||
|
{:halt, {directory_acc, true}}
|
||||||
|
else
|
||||||
|
{:cont, {directory_acc ++ [part], false}}
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
|
||||||
|
if found_series_directory do
|
||||||
|
{:ok, Path.join(series_directory)}
|
||||||
|
else
|
||||||
|
{:error, :indeterminable}
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
defp fetch_thumbnail_from_url(url) do
|
defp fetch_thumbnail_from_url(url) do
|
||||||
http_client = Application.get_env(:pinchflat, :http_client, Pinchflat.HTTP.HTTPClient)
|
http_client = Application.get_env(:pinchflat, :http_client, Pinchflat.HTTP.HTTPClient)
|
||||||
{:ok, body} = http_client.get(url, [], body_format: :binary)
|
{:ok, body} = http_client.get(url, [], body_format: :binary)
|
||||||
@@ -59,13 +124,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,68 @@
|
|||||||
|
defmodule Pinchflat.Metadata.NfoBuilder do
|
||||||
|
@moduledoc """
|
||||||
|
Provides methods for building and storing NFO files for
|
||||||
|
use by Kodi/Jellyfin and other media center software.
|
||||||
|
"""
|
||||||
|
|
||||||
|
alias Pinchflat.Metadata.MetadataFileHelpers
|
||||||
|
alias Pinchflat.Filesystem.FilesystemHelpers
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Builds an NFO file for a media item (read: single "episode") and
|
||||||
|
stores it at the specified location.
|
||||||
|
|
||||||
|
Returns the filepath of the NFO file.
|
||||||
|
"""
|
||||||
|
def build_and_store_for_media_item(filepath, metadata) do
|
||||||
|
nfo = build_for_media_item(metadata)
|
||||||
|
|
||||||
|
FilesystemHelpers.write_p!(filepath, nfo)
|
||||||
|
|
||||||
|
filepath
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Builds an NFO file for a souce and stores it at the specified location.
|
||||||
|
Technically works for playlists, but it's really made for channels.
|
||||||
|
|
||||||
|
Returns the filepath of the NFO file.
|
||||||
|
"""
|
||||||
|
def build_and_store_for_source(filepath, metadata) do
|
||||||
|
nfo = build_for_source(metadata)
|
||||||
|
|
||||||
|
FilesystemHelpers.write_p!(filepath, nfo)
|
||||||
|
|
||||||
|
filepath
|
||||||
|
end
|
||||||
|
|
||||||
|
defp build_for_media_item(metadata) do
|
||||||
|
upload_date = MetadataFileHelpers.parse_upload_date(metadata["upload_date"])
|
||||||
|
# Cribbed from a combination of the Kodi wiki, ytdl-nfo, and ytdl-sub.
|
||||||
|
# WHO NEEDS A FANCY XML PARSER ANYWAY?!
|
||||||
|
"""
|
||||||
|
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
|
||||||
|
<episodedetails>
|
||||||
|
<title>#{metadata["title"]}</title>
|
||||||
|
<showtitle>#{metadata["uploader"]}</showtitle>
|
||||||
|
<uniqueid type="youtube" default="true">#{metadata["id"]}</uniqueid>
|
||||||
|
<plot>#{metadata["description"]}</plot>
|
||||||
|
<aired>#{upload_date}</aired>
|
||||||
|
<season>#{upload_date.year}</season>
|
||||||
|
<episode>#{Calendar.strftime(upload_date, "%m%d")}</episode>
|
||||||
|
<genre>YouTube</genre>
|
||||||
|
</episodedetails>
|
||||||
|
"""
|
||||||
|
end
|
||||||
|
|
||||||
|
defp build_for_source(metadata) do
|
||||||
|
"""
|
||||||
|
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
|
||||||
|
<tvshow>
|
||||||
|
<title>#{metadata["title"]}</title>
|
||||||
|
<plot>#{metadata["description"]}</plot>
|
||||||
|
<uniqueid type="youtube" default="true">#{metadata["id"]}</uniqueid>
|
||||||
|
<genre>YouTube</genre>
|
||||||
|
</tvshow>
|
||||||
|
"""
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,69 @@
|
|||||||
|
defmodule Pinchflat.Metadata.SourceImageParser do
|
||||||
|
@moduledoc """
|
||||||
|
Functions for parsing and storing source images.
|
||||||
|
"""
|
||||||
|
alias Pinchflat.Filesystem.FilesystemHelpers
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Given a base directory and source metadata, look for the appropriate images
|
||||||
|
and move them to the base directory. Returns a map of image types and their
|
||||||
|
filepaths (specifically for a source). If a given image type is not found,
|
||||||
|
the key will not be present in the map.
|
||||||
|
|
||||||
|
The metadata is expected to contain the `filepath` key for images, implying
|
||||||
|
that the images have already been downloaded by yt-dlp. This method will NOT
|
||||||
|
download images from the internet - it just copys them around.
|
||||||
|
|
||||||
|
Returns a map with the possible keys :poster_filepath, :fanart_filepath, and
|
||||||
|
:banner_filepath.
|
||||||
|
"""
|
||||||
|
def store_source_images(base_directory, source_metadata) do
|
||||||
|
(source_metadata["thumbnails"] || [])
|
||||||
|
|> Enum.filter(&(&1["filepath"] != nil))
|
||||||
|
|> select_useful_images()
|
||||||
|
|> Enum.map(&move_image(&1, base_directory))
|
||||||
|
|> Enum.into(%{})
|
||||||
|
end
|
||||||
|
|
||||||
|
defp select_useful_images(images) do
|
||||||
|
labelled_images =
|
||||||
|
Enum.reduce(images, [], fn image_map, acc ->
|
||||||
|
case image_map do
|
||||||
|
%{"id" => "avatar_uncropped"} ->
|
||||||
|
acc ++ [{:poster, :poster_filepath, image_map["filepath"]}]
|
||||||
|
|
||||||
|
%{"id" => "banner_uncropped"} ->
|
||||||
|
acc ++ [{:fanart, :fanart_filepath, image_map["filepath"]}]
|
||||||
|
|
||||||
|
_ ->
|
||||||
|
acc
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
|
||||||
|
labelled_images
|
||||||
|
|> Enum.concat([{:banner, :banner_filepath, determine_best_banner(images)}])
|
||||||
|
|> Enum.filter(fn {_, _, tmp_filepath} -> tmp_filepath end)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp determine_best_banner(images) do
|
||||||
|
best_candidate =
|
||||||
|
images
|
||||||
|
# Filter out images that don't have a width and height attribute
|
||||||
|
|> Enum.filter(&(&1["width"] && &1["height"]))
|
||||||
|
# Sort images with the highest width first
|
||||||
|
|> Enum.sort(&(&1["width"] >= &2["width"]))
|
||||||
|
# Find the first image where the ratio of width to height is greater than 3
|
||||||
|
|> Enum.find(&(&1["width"] / &1["height"] > 3))
|
||||||
|
|
||||||
|
Map.get(best_candidate || %{}, "filepath")
|
||||||
|
end
|
||||||
|
|
||||||
|
defp move_image({filename, source_attr_name, tmp_filepath}, base_directory) do
|
||||||
|
extension = Path.extname(tmp_filepath)
|
||||||
|
final_filepath = Path.join([base_directory, "#{filename}#{extension}"])
|
||||||
|
|
||||||
|
FilesystemHelpers.cp_p!(tmp_filepath, final_filepath)
|
||||||
|
|
||||||
|
{source_attr_name, final_filepath}
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,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/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,75 @@
|
|||||||
|
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
|
||||||
|
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)
|
||||||
|
|
||||||
|
source
|
||||||
|
|> Media.list_downloaded_media_items_for(limit: limit)
|
||||||
|
|> 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,139 @@
|
|||||||
|
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"
|
||||||
|
|
||||||
|
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 safe(nil), do: ""
|
||||||
|
|
||||||
|
defp safe(value) do
|
||||||
|
value
|
||||||
|
|> Phoenix.HTML.html_escape()
|
||||||
|
|> Phoenix.HTML.safe_to_string()
|
||||||
|
end
|
||||||
|
|
||||||
|
defp generate_self_link(url_base, source) do
|
||||||
|
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,8 +17,12 @@ 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
|
||||||
@@ -30,19 +34,23 @@ defmodule Pinchflat.Profiles.MediaProfile do
|
|||||||
field :name, :string
|
field :name, :string
|
||||||
|
|
||||||
field :output_path_template, :string,
|
field :output_path_template, :string,
|
||||||
default: "/{{ source_custom_name }}/{{ title }}/{{ title }} [{{ id }}].{{ ext }}"
|
default: "/{{ source_custom_name }}/{{ upload_yyyy_mm_dd }} {{ title }}/{{ title }} [{{ id }}].{{ ext }}"
|
||||||
|
|
||||||
field :download_subs, :boolean, default: true
|
field :download_subs, :boolean, default: false
|
||||||
field :download_auto_subs, :boolean, default: true
|
field :download_auto_subs, :boolean, default: false
|
||||||
field :embed_subs, :boolean, default: true
|
field :embed_subs, :boolean, default: false
|
||||||
field :sub_langs, :string, default: "en"
|
field :sub_langs, :string, default: "en"
|
||||||
|
|
||||||
field :download_thumbnail, :boolean, default: true
|
field :download_thumbnail, :boolean, default: false
|
||||||
field :embed_thumbnail, :boolean, default: true
|
field :embed_thumbnail, :boolean, default: false
|
||||||
|
field :download_source_images, :boolean, default: false
|
||||||
|
|
||||||
field :download_metadata, :boolean, default: true
|
field :download_metadata, :boolean, default: false
|
||||||
field :embed_metadata, :boolean, default: true
|
field :embed_metadata, :boolean, default: false
|
||||||
|
|
||||||
|
field :download_nfo, :boolean, default: false
|
||||||
|
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.
|
||||||
@@ -65,6 +73,12 @@ defmodule Pinchflat.Profiles.MediaProfile do
|
|||||||
media_profile
|
media_profile
|
||||||
|> cast(attrs, @allowed_fields)
|
|> cast(attrs, @allowed_fields)
|
||||||
|> validate_required(@required_fields)
|
|> validate_required(@required_fields)
|
||||||
|
# Ensures it ends with `.{{ ext }}` or `.%(ext)s` or similar (with a little wiggle room)
|
||||||
|
|> validate_format(:output_path_template, ext_regex(), message: "must end with .{{ ext }}")
|
||||||
|> unique_constraint(:name)
|
|> unique_constraint(:name)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
defp ext_regex do
|
||||||
|
~r/\.({{ ?ext ?}}|%\( ?ext ?\)[sS])$/
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -5,6 +5,10 @@ defmodule Pinchflat.Release do
|
|||||||
"""
|
"""
|
||||||
@app :pinchflat
|
@app :pinchflat
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias Pinchflat.Filesystem.FilesystemHelpers
|
||||||
|
|
||||||
def migrate do
|
def migrate do
|
||||||
load_app()
|
load_app()
|
||||||
|
|
||||||
@@ -18,6 +22,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 FilesystemHelpers.write_p(filepath, "") do
|
||||||
|
:ok ->
|
||||||
|
Logger.info("Permissions OK")
|
||||||
|
|
||||||
|
{:error, :eacces} ->
|
||||||
|
Logger.error(permission_denied_screed(dir))
|
||||||
|
raise "Permission denied"
|
||||||
|
|
||||||
|
err ->
|
||||||
|
Logger.error("Permissions check failed: #{inspect(err)}")
|
||||||
|
raise "Unknown error"
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
end
|
||||||
|
|
||||||
defp repos do
|
defp repos do
|
||||||
Application.fetch_env!(@app, :ecto_repos)
|
Application.fetch_env!(@app, :ecto_repos)
|
||||||
end
|
end
|
||||||
@@ -25,4 +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
|
||||||
|
|||||||
+2
-2
@@ -1,4 +1,4 @@
|
|||||||
defmodule Pinchflat.Utils.FilesystemUtils.FileFollowerServer do
|
defmodule Pinchflat.SlowIndexing.FileFollowerServer do
|
||||||
@moduledoc """
|
@moduledoc """
|
||||||
A GenServer that watches a file for new lines and processes them as they come in.
|
A GenServer that watches a file for new lines and processes them as they come in.
|
||||||
This is useful for tailing log files and other similar tasks. If there's no activity
|
This is useful for tailing log files and other similar tasks. If there's no activity
|
||||||
@@ -9,7 +9,7 @@ defmodule Pinchflat.Utils.FilesystemUtils.FileFollowerServer do
|
|||||||
require Logger
|
require Logger
|
||||||
|
|
||||||
@poll_interval_ms Application.compile_env(:pinchflat, :file_watcher_poll_interval)
|
@poll_interval_ms Application.compile_env(:pinchflat, :file_watcher_poll_interval)
|
||||||
@activity_timeout_ms 60_000
|
@activity_timeout_ms 600_000
|
||||||
|
|
||||||
# Client API
|
# Client API
|
||||||
@doc """
|
@doc """
|
||||||
+23
-9
@@ -1,4 +1,4 @@
|
|||||||
defmodule Pinchflat.Workers.MediaCollectionIndexingWorker do
|
defmodule Pinchflat.SlowIndexing.MediaCollectionIndexingWorker do
|
||||||
@moduledoc false
|
@moduledoc false
|
||||||
|
|
||||||
use Oban.Worker,
|
use Oban.Worker,
|
||||||
@@ -6,14 +6,26 @@ defmodule Pinchflat.Workers.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.Sources.Source
|
alias Pinchflat.Sources.Source
|
||||||
alias Pinchflat.Tasks.SourceTasks
|
alias Pinchflat.FastIndexing.FastIndexingWorker
|
||||||
alias Pinchflat.Workers.FastIndexingWorker
|
alias Pinchflat.SlowIndexing.SlowIndexingHelpers
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Starts the source slow indexing worker and creates a task for the source.
|
||||||
|
|
||||||
|
Returns {:ok, %Task{}} | {:error, :duplicate_job} | {:error, %Ecto.Changeset{}}
|
||||||
|
"""
|
||||||
|
def kickoff_with_task(source, opts \\ []) do
|
||||||
|
%{id: source.id}
|
||||||
|
|> MediaCollectionIndexingWorker.new(opts)
|
||||||
|
|> Tasks.create_job_with_task(source)
|
||||||
|
end
|
||||||
|
|
||||||
@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
|
||||||
@@ -40,7 +52,7 @@ defmodule Pinchflat.Workers.MediaCollectionIndexingWorker do
|
|||||||
by the `download_media` field on the source as well as the profile's
|
by the `download_media` field on the source as well as the profile's
|
||||||
shorts/livestream behaviour. At this step we also attach a file reader
|
shorts/livestream behaviour. At this step we also attach a file reader
|
||||||
to the `yt-dlp` output file so we can create media items as they come in
|
to the `yt-dlp` output file so we can create media items as they come in
|
||||||
for a little speedup (see SourceTasks comments for more)
|
for a little speedup (see {Fast,Slow}IndexingHelpers comments for more)
|
||||||
4. If this job is meant to reschedule (ie: has an index frequency > 0),
|
4. If this job is meant to reschedule (ie: has an index frequency > 0),
|
||||||
it reschedules itself. If not, it runs once and does not reschedule
|
it reschedules itself. If not, it runs once and does not reschedule
|
||||||
5. If the source uses fast indexing, that job is kicked off as well. It
|
5. If the source uses fast indexing, that job is kicked off as well. It
|
||||||
@@ -56,24 +68,23 @@ defmodule Pinchflat.Workers.MediaCollectionIndexingWorker do
|
|||||||
NOTE: Since indexing can take a LONG time, I should check what happens if an
|
NOTE: Since indexing can take a LONG time, I should check what happens if an
|
||||||
application restart occurs while a job is running. Will the job be lost?
|
application restart occurs while a job is running. Will the job be lost?
|
||||||
|
|
||||||
IDEA: Should I use paging and do indexing in chunks? Is that even faster?
|
|
||||||
|
|
||||||
Returns :ok | {:ok, %Task{}}
|
Returns :ok | {: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)
|
||||||
|
|
||||||
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
|
||||||
SourceTasks.index_and_enqueue_download_for_media_items(source)
|
SlowIndexingHelpers.index_and_enqueue_download_for_media_items(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
|
||||||
SourceTasks.index_and_enqueue_download_for_media_items(source)
|
SlowIndexingHelpers.index_and_enqueue_download_for_media_items(source)
|
||||||
:ok
|
:ok
|
||||||
|
|
||||||
_ ->
|
_ ->
|
||||||
@@ -81,6 +92,9 @@ defmodule Pinchflat.Workers.MediaCollectionIndexingWorker do
|
|||||||
# perform a no-op
|
# perform a no-op
|
||||||
: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
|
end
|
||||||
|
|
||||||
defp reschedule_indexing(source) do
|
defp reschedule_indexing(source) do
|
||||||
+32
-109
@@ -1,27 +1,25 @@
|
|||||||
defmodule Pinchflat.Tasks.SourceTasks do
|
defmodule Pinchflat.SlowIndexing.SlowIndexingHelpers do
|
||||||
@moduledoc """
|
@moduledoc """
|
||||||
Contains methods used by OR used to create/manage tasks for sources.
|
Methods for performing slow indexing tasks and managing the indexing process.
|
||||||
|
|
||||||
Tasks/workers are meant to be thin wrappers so most of the actual work they
|
Many of these methods are made to be kickoff or be consumed by workers.
|
||||||
do is also defined here. Essentially, a one-stop-shop for source-related tasks/workers.
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
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
|
||||||
alias Pinchflat.Sources.Source
|
alias Pinchflat.Sources.Source
|
||||||
alias Pinchflat.Api.YoutubeRss
|
|
||||||
alias Pinchflat.Media.MediaItem
|
alias Pinchflat.Media.MediaItem
|
||||||
alias Pinchflat.Workers.FastIndexingWorker
|
alias Pinchflat.YtDlp.MediaCollection
|
||||||
alias Pinchflat.Workers.MediaDownloadWorker
|
alias Pinchflat.Downloading.DownloadingHelpers
|
||||||
alias Pinchflat.Workers.MediaIndexingWorker
|
alias Pinchflat.SlowIndexing.FileFollowerServer
|
||||||
alias Pinchflat.YtDlp.Backend.MediaCollection
|
alias Pinchflat.Downloading.MediaDownloadWorker
|
||||||
alias Pinchflat.Workers.MediaCollectionIndexingWorker
|
alias Pinchflat.SlowIndexing.MediaCollectionIndexingWorker
|
||||||
alias Pinchflat.Utils.FilesystemUtils.FileFollowerServer
|
|
||||||
|
|
||||||
alias Pinchflat.YtDlp.Backend.Media, as: YtDlpMedia
|
alias Pinchflat.YtDlp.Media, as: YtDlpMedia
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Starts tasks for indexing a source's media regardless of the source's indexing
|
Starts tasks for indexing a source's media regardless of the source's indexing
|
||||||
@@ -34,56 +32,14 @@ defmodule Pinchflat.Tasks.SourceTasks do
|
|||||||
Tasks.delete_pending_tasks_for(source, "MediaIndexingWorker")
|
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)
|
||||||
# Schedule this one immediately, but future ones will be on an interval
|
|
||||||
|> MediaCollectionIndexingWorker.new()
|
|
||||||
|> Tasks.create_job_with_task(source)
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Starts tasks for running a fast indexing task for a source's media
|
|
||||||
regardless of the source's fast_index state. It's assumed 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.
|
|
||||||
|
|
||||||
Returns :ok
|
|
||||||
"""
|
|
||||||
def kickoff_indexing_tasks_from_youtube_rss_feed(%Source{} = source) do
|
|
||||||
{:ok, media_ids} = YoutubeRss.get_recent_media_ids_from_rss(source)
|
|
||||||
existing_media_items = Media.list_media_items_by_media_id_for(source, media_ids)
|
|
||||||
new_media_ids = media_ids -- Enum.map(existing_media_items, & &1.media_id)
|
|
||||||
|
|
||||||
Enum.each(new_media_ids, fn media_id ->
|
|
||||||
url = "https://www.youtube.com/watch?v=#{media_id}"
|
|
||||||
|
|
||||||
%{id: source.id, media_url: url}
|
|
||||||
|> MediaIndexingWorker.new()
|
|
||||||
|> Tasks.create_job_with_task(source)
|
|
||||||
end)
|
|
||||||
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
|
||||||
@@ -99,56 +55,30 @@ defmodule Pinchflat.Tasks.SourceTasks 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} = get_media_attributes_for_collection_and_setup_file_watcher(source)
|
||||||
result = Enum.map(media_attributes, fn media_attrs -> create_media_item_from_attributes(source, media_attrs) end)
|
# Reload because the source may have been updated during the (long-running) indexing process
|
||||||
|
# and important settings like `download_media` may have changed.
|
||||||
|
source = Repo.reload!(source)
|
||||||
|
|
||||||
|
result =
|
||||||
|
Enum.map(media_attributes, fn media_attrs ->
|
||||||
|
case Media.create_media_item_from_backend_attrs(source, media_attrs) do
|
||||||
|
{:ok, media_item} -> media_item
|
||||||
|
{:error, changeset} -> changeset
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
|
||||||
Sources.update_source(source, %{last_indexed_at: DateTime.utc_now()})
|
Sources.update_source(source, %{last_indexed_at: DateTime.utc_now()})
|
||||||
enqueue_pending_media_tasks(source)
|
DownloadingHelpers.enqueue_pending_download_tasks(source)
|
||||||
|
|
||||||
result
|
result
|
||||||
end
|
end
|
||||||
|
|
||||||
@doc """
|
|
||||||
Starts tasks for downloading media for any of a sources _pending_ media items.
|
|
||||||
Jobs are not enqueued if the source is set to not download media. This will return :ok.
|
|
||||||
|
|
||||||
NOTE: this starts a download for each media item that is pending,
|
|
||||||
not just the ones that were indexed in this job run. This should ensure
|
|
||||||
that any stragglers are caught if, for some reason, they weren't enqueued
|
|
||||||
or somehow got de-queued.
|
|
||||||
|
|
||||||
Returns :ok
|
|
||||||
"""
|
|
||||||
def enqueue_pending_media_tasks(%Source{download_media: true} = source) do
|
|
||||||
source
|
|
||||||
|> Media.list_pending_media_items_for()
|
|
||||||
|> Enum.each(fn media_item ->
|
|
||||||
%{id: media_item.id}
|
|
||||||
|> MediaDownloadWorker.new()
|
|
||||||
|> Tasks.create_job_with_task(media_item)
|
|
||||||
end)
|
|
||||||
end
|
|
||||||
|
|
||||||
def enqueue_pending_media_tasks(%Source{download_media: false} = _source) do
|
|
||||||
:ok
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Deletes ALL pending tasks for a source's media items.
|
|
||||||
|
|
||||||
Returns :ok
|
|
||||||
"""
|
|
||||||
def dequeue_pending_media_tasks(%Source{} = source) do
|
|
||||||
source
|
|
||||||
|> Media.list_pending_media_items_for()
|
|
||||||
|> Enum.each(&Tasks.delete_pending_tasks_for/1)
|
|
||||||
end
|
|
||||||
|
|
||||||
# The file follower is a GenServer that watches a file for new lines and
|
# The file follower is a GenServer that watches a file for new lines and
|
||||||
# processes them. This works well, but we have to be resilliant to partially-written
|
# processes them. This works well, but we have to be resilliant to partially-written
|
||||||
# lines (ie: you should gracefully fail if you can't parse a line).
|
# lines (ie: you should gracefully fail if you can't parse a line).
|
||||||
@@ -191,27 +121,20 @@ defmodule Pinchflat.Tasks.SourceTasks 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
|
||||||
maybe_media_item = create_media_item_from_attributes(source, media_attrs)
|
# 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 maybe_media_item do
|
case Media.create_media_item_from_backend_attrs(source, media_attrs) do
|
||||||
%MediaItem{} = media_item ->
|
{:ok, %MediaItem{} = media_item} ->
|
||||||
if source.download_media && Media.pending_download?(media_item) do
|
if source.download_media && Media.pending_download?(media_item) do
|
||||||
Logger.debug("FileFollowerServer Handler: Enqueuing download task for #{inspect(media_attrs)}")
|
Logger.debug("FileFollowerServer Handler: Enqueuing download task for #{inspect(media_attrs)}")
|
||||||
|
|
||||||
%{id: media_item.id}
|
MediaDownloadWorker.kickoff_with_task(media_item)
|
||||||
|> MediaDownloadWorker.new()
|
|
||||||
|> Tasks.create_job_with_task(media_item)
|
|
||||||
end
|
end
|
||||||
|
|
||||||
changeset ->
|
{:error, changeset} ->
|
||||||
changeset
|
changeset
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
defp create_media_item_from_attributes(source, media_attrs) do
|
|
||||||
case Media.create_media_item_from_backend_attrs(source, media_attrs) do
|
|
||||||
{:ok, media_item} -> media_item
|
|
||||||
{:error, changeset} -> changeset
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
@@ -10,25 +10,34 @@ 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
|
||||||
|
title_filter_regex
|
||||||
media_profile_id
|
media_profile_id
|
||||||
)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 +48,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 +56,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]
|
||||||
@@ -57,9 +73,18 @@ defmodule Pinchflat.Sources.Source do
|
|||||||
# 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 :original_url, :string
|
field :original_url, :string
|
||||||
|
field :title_filter_regex, :string
|
||||||
|
|
||||||
|
field :series_directory, :string
|
||||||
|
field :nfo_filepath, :string
|
||||||
|
field :poster_filepath, :string
|
||||||
|
field :fanart_filepath, :string
|
||||||
|
field :banner_filepath, :string
|
||||||
|
|
||||||
belongs_to :media_profile, MediaProfile
|
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 +104,9 @@ 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])
|
|> cast_assoc(:metadata, with: &SourceMetadata.changeset/2, required: false)
|
||||||
end
|
end
|
||||||
|
|
||||||
@doc false
|
@doc false
|
||||||
@@ -94,4 +120,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,9 +9,15 @@ 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.Tasks.SourceTasks
|
alias Pinchflat.Media.MediaQuery
|
||||||
alias Pinchflat.Profiles.MediaProfile
|
alias Pinchflat.Profiles.MediaProfile
|
||||||
alias Pinchflat.YtDlp.Backend.MediaCollection
|
alias Pinchflat.YtDlp.MediaCollection
|
||||||
|
alias Pinchflat.Metadata.SourceMetadata
|
||||||
|
alias Pinchflat.Filesystem.FilesystemHelpers
|
||||||
|
alias Pinchflat.Downloading.DownloadingHelpers
|
||||||
|
alias Pinchflat.FastIndexing.FastIndexingWorker
|
||||||
|
alias Pinchflat.SlowIndexing.SlowIndexingHelpers
|
||||||
|
alias Pinchflat.Metadata.SourceMetadataStorageWorker
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Returns the list of sources. Returns [%Source{}, ...]
|
Returns the list of sources. Returns [%Source{}, ...]
|
||||||
@@ -46,15 +52,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)
|
||||||
@@ -67,22 +77,26 @@ defmodule Pinchflat.Sources do
|
|||||||
media if the indexing frequency has been changed.
|
media if the indexing frequency has been changed.
|
||||||
|
|
||||||
Existing indexing tasks will be cancelled if the indexing frequency has been
|
Existing indexing tasks will be cancelled if the indexing frequency has been
|
||||||
changed (logic in `SourceTasks.kickoff_indexing_task`)
|
changed (logic in `SlowIndexingHelpers.kickoff_indexing_task`)
|
||||||
|
|
||||||
Runs an initial `change_source` check to ensure most of the source is valid
|
Runs an initial `change_source` check to ensure most of the source is valid
|
||||||
before making an expensive API call. Runs it through `Repo.update` even
|
before making an expensive API call. Runs it through `Repo.update` even
|
||||||
though we know it's going to fail so it picks up any addl. database errors
|
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)
|
||||||
@@ -97,14 +111,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
|
||||||
|
|
||||||
@@ -115,19 +135,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)
|
||||||
@@ -137,10 +147,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(&FilesystemHelpers.delete_file_and_remove_empty_directories/1)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp delete_internal_metadata_files(source) do
|
||||||
|
metadata = Repo.preload(source, :metadata).metadata || %SourceMetadata{}
|
||||||
|
mapped_struct = Map.from_struct(metadata)
|
||||||
|
|
||||||
|
SourceMetadata.filepath_attributes()
|
||||||
|
|> Enum.map(fn field -> mapped_struct[field] end)
|
||||||
|
|> Enum.filter(&is_binary/1)
|
||||||
|
|> Enum.each(&FilesystemHelpers.delete_file_and_remove_empty_directories/1)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp add_source_details_to_changeset(source, changeset) do
|
||||||
|
case MediaCollection.get_source_details(changeset.changes.original_url) do
|
||||||
{:ok, source_details} ->
|
{:ok, source_details} ->
|
||||||
add_source_details_by_collection_type(source, changeset, source_details)
|
add_source_details_by_collection_type(source, changeset, source_details)
|
||||||
|
|
||||||
@@ -189,11 +216,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)
|
||||||
|
run_metadata_storage_task(source)
|
||||||
|
end
|
||||||
|
|
||||||
|
{:ok, source}
|
||||||
|
|
||||||
err ->
|
err ->
|
||||||
err
|
err
|
||||||
@@ -205,23 +239,21 @@ defmodule Pinchflat.Sources do
|
|||||||
defp maybe_handle_media_tasks(changeset, source) do
|
defp maybe_handle_media_tasks(changeset, source) do
|
||||||
case {changeset.data, changeset.changes} do
|
case {changeset.data, changeset.changes} do
|
||||||
{%{__meta__: %{state: :loaded}}, %{download_media: true}} ->
|
{%{__meta__: %{state: :loaded}}, %{download_media: true}} ->
|
||||||
SourceTasks.enqueue_pending_media_tasks(source)
|
DownloadingHelpers.enqueue_pending_download_tasks(source)
|
||||||
|
|
||||||
{%{__meta__: %{state: :loaded}}, %{download_media: false}} ->
|
{%{__meta__: %{state: :loaded}}, %{download_media: false}} ->
|
||||||
SourceTasks.dequeue_pending_media_tasks(source)
|
DownloadingHelpers.dequeue_pending_download_tasks(source)
|
||||||
|
|
||||||
_ ->
|
_ ->
|
||||||
:ok
|
:ok
|
||||||
end
|
end
|
||||||
|
|
||||||
{:ok, source}
|
|
||||||
end
|
end
|
||||||
|
|
||||||
defp maybe_run_indexing_task(changeset, source) do
|
defp maybe_run_indexing_task(changeset, source) do
|
||||||
case changeset.data do
|
case changeset.data do
|
||||||
# If the changeset is new (not persisted), attempt indexing no matter what
|
# If the changeset is new (not persisted), attempt indexing no matter what
|
||||||
%{__meta__: %{state: :built}} ->
|
%{__meta__: %{state: :built}} ->
|
||||||
SourceTasks.kickoff_indexing_task(source)
|
SlowIndexingHelpers.kickoff_indexing_task(source)
|
||||||
|
|
||||||
# If the record has been persisted, only run indexing if the
|
# If the record has been persisted, only run indexing if the
|
||||||
# indexing frequency has been changed and is now greater than 0
|
# indexing frequency has been changed and is now greater than 0
|
||||||
@@ -229,14 +261,17 @@ 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}
|
# This runs every time to pick up any changes to the metadata
|
||||||
|
defp run_metadata_storage_task(source) do
|
||||||
|
SourceMetadataStorageWorker.kickoff_with_task(source)
|
||||||
end
|
end
|
||||||
|
|
||||||
defp maybe_update_slow_indexing_task(changeset, source) do
|
defp maybe_update_slow_indexing_task(changeset, source) do
|
||||||
case changeset.changes do
|
case changeset.changes do
|
||||||
%{index_frequency_minutes: mins} when mins > 0 ->
|
%{index_frequency_minutes: mins} when mins > 0 ->
|
||||||
SourceTasks.kickoff_indexing_task(source)
|
SlowIndexingHelpers.kickoff_indexing_task(source)
|
||||||
|
|
||||||
%{index_frequency_minutes: _} ->
|
%{index_frequency_minutes: _} ->
|
||||||
Tasks.delete_pending_tasks_for(source, "FastIndexingWorker")
|
Tasks.delete_pending_tasks_for(source, "FastIndexingWorker")
|
||||||
@@ -251,7 +286,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} ->
|
||||||
SourceTasks.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")
|
||||||
@@ -1,61 +0,0 @@
|
|||||||
defmodule Pinchflat.Tasks.MediaItemTasks do
|
|
||||||
@moduledoc """
|
|
||||||
Contains methods used by OR used to create/manage tasks for media items.
|
|
||||||
|
|
||||||
Tasks/workers are meant to be thin wrappers so most of the actual work they
|
|
||||||
do is also defined here. Essentially, a one-stop-shop for media-related tasks/workers.
|
|
||||||
"""
|
|
||||||
alias Pinchflat.Media
|
|
||||||
alias Pinchflat.Tasks
|
|
||||||
alias Pinchflat.Sources.Source
|
|
||||||
alias Pinchflat.Workers.MediaDownloadWorker
|
|
||||||
|
|
||||||
alias Pinchflat.YtDlp.Backend.Media, as: YtDlpMedia
|
|
||||||
|
|
||||||
@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 """
|
|
||||||
Indexes a single media item for a source and enqueues a download job if the
|
|
||||||
media should be downloaded. This method creates the media item record so it's
|
|
||||||
the one-stop-shop for adding a media item (and possibly downloading it) just
|
|
||||||
by a URL and source.
|
|
||||||
|
|
||||||
Returns {:ok, media_item} | {:error, any()}
|
|
||||||
"""
|
|
||||||
def index_and_enqueue_download_for_media_item(%Source{} = source, url) do
|
|
||||||
maybe_media_item = create_media_item_from_url(source, url)
|
|
||||||
|
|
||||||
case maybe_media_item do
|
|
||||||
{:ok, media_item} ->
|
|
||||||
if source.download_media && Media.pending_download?(media_item) do
|
|
||||||
%{id: media_item.id}
|
|
||||||
|> MediaDownloadWorker.new()
|
|
||||||
|> Tasks.create_job_with_task(media_item)
|
|
||||||
end
|
|
||||||
|
|
||||||
{:ok, media_item}
|
|
||||||
|
|
||||||
err ->
|
|
||||||
err
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
defp create_media_item_from_url(source, url) do
|
|
||||||
{:ok, media_attrs} = YtDlpMedia.get_media_attributes(url)
|
|
||||||
|
|
||||||
Media.create_media_item_from_backend_attrs(source, media_attrs)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -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,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
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
defmodule Pinchflat.Utils.FilesystemUtils do
|
|
||||||
@moduledoc """
|
|
||||||
Utility methods for working with the filesystem
|
|
||||||
"""
|
|
||||||
|
|
||||||
alias Pinchflat.Utils.StringUtils
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Generates a temporary file and returns its path. The file is empty and has the given type.
|
|
||||||
Generates all the directories in the path if they don't exist.
|
|
||||||
|
|
||||||
Returns binary()
|
|
||||||
"""
|
|
||||||
def generate_metadata_tmpfile(type) do
|
|
||||||
tmpfile_directory = Application.get_env(:pinchflat, :tmpfile_directory)
|
|
||||||
filepath = Path.join([tmpfile_directory, "#{StringUtils.random_string(64)}.#{type}"])
|
|
||||||
|
|
||||||
:ok = File.mkdir_p!(Path.dirname(filepath))
|
|
||||||
:ok = File.write(filepath, "")
|
|
||||||
|
|
||||||
filepath
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
defmodule Pinchflat.Workers.FilesystemDataWorker do
|
|
||||||
@moduledoc false
|
|
||||||
|
|
||||||
use Oban.Worker,
|
|
||||||
queue: :media_local_metadata,
|
|
||||||
tags: ["media_item", "media_metadata", "local_metadata"],
|
|
||||||
max_attempts: 1
|
|
||||||
|
|
||||||
alias Pinchflat.Media
|
|
||||||
alias Pinchflat.Tasks.MediaItemTasks
|
|
||||||
|
|
||||||
@impl Oban.Worker
|
|
||||||
@doc """
|
|
||||||
For a given media item, compute and save metadata about the file on-disk.
|
|
||||||
|
|
||||||
Returns :ok
|
|
||||||
"""
|
|
||||||
def perform(%Oban.Job{args: %{"id" => media_item_id}}) do
|
|
||||||
media_item = Media.get_media_item!(media_item_id)
|
|
||||||
|
|
||||||
MediaItemTasks.compute_and_save_media_filesize(media_item)
|
|
||||||
|
|
||||||
# Don't retry on failure - if it didn't work immediately there's no
|
|
||||||
# reason to believe it will work later.
|
|
||||||
:ok
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,56 +0,0 @@
|
|||||||
defmodule Pinchflat.Workers.MediaDownloadWorker do
|
|
||||||
@moduledoc false
|
|
||||||
|
|
||||||
use Oban.Worker,
|
|
||||||
queue: :media_fetching,
|
|
||||||
unique: [period: :infinity, states: [:available, :scheduled, :retryable, :executing]],
|
|
||||||
tags: ["media_item", "media_fetching"]
|
|
||||||
|
|
||||||
alias Pinchflat.Repo
|
|
||||||
alias Pinchflat.Media
|
|
||||||
alias Pinchflat.Tasks
|
|
||||||
alias Pinchflat.MediaClient.MediaDownloader
|
|
||||||
alias Pinchflat.Workers.FilesystemDataWorker
|
|
||||||
|
|
||||||
@impl Oban.Worker
|
|
||||||
@doc """
|
|
||||||
For a given media item, download the media alongside any options.
|
|
||||||
Does not download media if its source is set to not download media.
|
|
||||||
|
|
||||||
Returns :ok | {:ok, %MediaItem{}} | {:error, any, ...any}
|
|
||||||
"""
|
|
||||||
def perform(%Oban.Job{args: %{"id" => media_item_id}}) do
|
|
||||||
media_item =
|
|
||||||
media_item_id
|
|
||||||
|> Media.get_media_item!()
|
|
||||||
|> Repo.preload(:source)
|
|
||||||
|
|
||||||
# If the source is set to not download media, perform a no-op
|
|
||||||
if media_item.source.download_media do
|
|
||||||
download_media_and_schedule_jobs(media_item)
|
|
||||||
else
|
|
||||||
:ok
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
defp download_media_and_schedule_jobs(media_item) do
|
|
||||||
case MediaDownloader.download_for_media_item(media_item) do
|
|
||||||
{:ok, _} ->
|
|
||||||
schedule_filesystem_data_worker(media_item)
|
|
||||||
{:ok, media_item}
|
|
||||||
|
|
||||||
err ->
|
|
||||||
err
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
defp schedule_filesystem_data_worker(media_item) do
|
|
||||||
%{id: media_item.id}
|
|
||||||
|> FilesystemDataWorker.new()
|
|
||||||
|> Tasks.create_job_with_task(media_item)
|
|
||||||
|> case do
|
|
||||||
{:ok, task} -> {:ok, task}
|
|
||||||
{:error, :duplicate_job} -> {:ok, :job_exists}
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,81 +0,0 @@
|
|||||||
defmodule Pinchflat.YtDlp.Backend.MediaCollection do
|
|
||||||
@moduledoc """
|
|
||||||
Contains utilities for working with collections of
|
|
||||||
media (aka: a source [ie: channels, playlists]).
|
|
||||||
"""
|
|
||||||
|
|
||||||
require Logger
|
|
||||||
|
|
||||||
alias Pinchflat.Utils.FunctionUtils
|
|
||||||
alias Pinchflat.Utils.FilesystemUtils
|
|
||||||
alias Pinchflat.YtDlp.Backend.Media, as: YtDlpMedia
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Returns a list of maps representing the media in the collection.
|
|
||||||
|
|
||||||
Options:
|
|
||||||
- :file_listener_handler - a function that will be called with the path to the
|
|
||||||
file that will be written to when yt-dlp is done. This is useful for
|
|
||||||
setting up a file watcher to know when the file is ready to be read.
|
|
||||||
|
|
||||||
Returns {:ok, [map()]} | {:error, any, ...}.
|
|
||||||
"""
|
|
||||||
def get_media_attributes_for_collection(url, addl_opts \\ []) do
|
|
||||||
runner = Application.get_env(:pinchflat, :yt_dlp_runner)
|
|
||||||
command_opts = [:simulate, :skip_download]
|
|
||||||
output_template = YtDlpMedia.indexing_output_template()
|
|
||||||
output_filepath = FilesystemUtils.generate_metadata_tmpfile(:json)
|
|
||||||
file_listener_handler = Keyword.get(addl_opts, :file_listener_handler, false)
|
|
||||||
|
|
||||||
if file_listener_handler do
|
|
||||||
file_listener_handler.(output_filepath)
|
|
||||||
end
|
|
||||||
|
|
||||||
case runner.run(url, command_opts, output_template, output_filepath: output_filepath) do
|
|
||||||
{:ok, output} ->
|
|
||||||
output
|
|
||||||
|> String.split("\n", trim: true)
|
|
||||||
|> Enum.map(&Phoenix.json_library().decode!/1)
|
|
||||||
|> Enum.map(&YtDlpMedia.response_to_struct/1)
|
|
||||||
|> FunctionUtils.wrap_ok()
|
|
||||||
|
|
||||||
res ->
|
|
||||||
res
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Gets a source's ID and name from its URL.
|
|
||||||
|
|
||||||
yt-dlp does not _really_ have source-specific functions, so
|
|
||||||
instead we're fetching just the first video (using playlist_end: 1)
|
|
||||||
and parsing the source ID and name from _its_ metadata
|
|
||||||
|
|
||||||
Returns {:ok, map()} | {:error, any, ...}.
|
|
||||||
"""
|
|
||||||
def get_source_details(source_url) do
|
|
||||||
opts = [:simulate, :skip_download, playlist_end: 1]
|
|
||||||
output_template = "%(.{channel,channel_id,playlist_id,playlist_title})j"
|
|
||||||
|
|
||||||
with {:ok, output} <- backend_runner().run(source_url, opts, output_template),
|
|
||||||
{:ok, parsed_json} <- Phoenix.json_library().decode(output) do
|
|
||||||
{:ok, format_source_details(parsed_json)}
|
|
||||||
else
|
|
||||||
err -> err
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
defp format_source_details(response) do
|
|
||||||
%{
|
|
||||||
channel_id: response["channel_id"],
|
|
||||||
channel_name: response["channel"],
|
|
||||||
playlist_id: response["playlist_id"],
|
|
||||||
playlist_name: response["playlist_title"]
|
|
||||||
}
|
|
||||||
end
|
|
||||||
|
|
||||||
defp backend_runner do
|
|
||||||
# This approach lets us mock the command for testing
|
|
||||||
Application.get_env(:pinchflat, :yt_dlp_runner)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
+1
-1
@@ -1,4 +1,4 @@
|
|||||||
defmodule Pinchflat.YtDlp.Backend.BackendCommandRunner do
|
defmodule Pinchflat.YtDlp.BackendCommandRunner 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).
|
||||||
|
|
||||||
+20
-5
@@ -1,4 +1,4 @@
|
|||||||
defmodule Pinchflat.YtDlp.Backend.CommandRunner do
|
defmodule Pinchflat.YtDlp.CommandRunner do
|
||||||
@moduledoc """
|
@moduledoc """
|
||||||
Runs yt-dlp commands using the `System.cmd/3` function
|
Runs yt-dlp commands using the `System.cmd/3` function
|
||||||
"""
|
"""
|
||||||
@@ -6,8 +6,8 @@ defmodule Pinchflat.YtDlp.Backend.CommandRunner do
|
|||||||
require Logger
|
require Logger
|
||||||
|
|
||||||
alias Pinchflat.Utils.StringUtils
|
alias Pinchflat.Utils.StringUtils
|
||||||
alias Pinchflat.Utils.FilesystemUtils, as: FSUtils
|
alias Pinchflat.Filesystem.FilesystemHelpers, as: FSUtils
|
||||||
alias Pinchflat.YtDlp.Backend.BackendCommandRunner
|
alias Pinchflat.YtDlp.BackendCommandRunner
|
||||||
|
|
||||||
@behaviour BackendCommandRunner
|
@behaviour BackendCommandRunner
|
||||||
|
|
||||||
@@ -31,13 +31,15 @@ defmodule Pinchflat.YtDlp.Backend.CommandRunner do
|
|||||||
# Also, can't use RAM file since yt-dlp needs a concrete filepath.
|
# Also, can't use RAM file since yt-dlp needs a concrete filepath.
|
||||||
output_filepath = Keyword.get(addl_opts, :output_filepath, FSUtils.generate_metadata_tmpfile(:json))
|
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)
|
cookie_opts = build_cookie_options()
|
||||||
|
formatted_command_opts = [url] ++ parse_options(command_opts ++ print_to_file_opts ++ cookie_opts)
|
||||||
|
|
||||||
Logger.info("[yt-dlp] called with: #{Enum.join(formatted_command_opts, " ")}")
|
Logger.info("[yt-dlp] called with: #{Enum.join(formatted_command_opts, " ")}")
|
||||||
|
|
||||||
case System.cmd(command, formatted_command_opts, stderr_to_stdout: true) do
|
case System.cmd(command, formatted_command_opts, stderr_to_stdout: true) do
|
||||||
{_, 0} ->
|
{_, 0} ->
|
||||||
# IDEA: consider deleting the file after reading it
|
# IDEA: consider deleting the file after reading it. It's in the tmp dir, so it's not
|
||||||
|
# a huge deal, but it's still a good idea to clean up after ourselves.
|
||||||
# (even on error? especially on error?)
|
# (even on error? especially on error?)
|
||||||
File.read(output_filepath)
|
File.read(output_filepath)
|
||||||
|
|
||||||
@@ -46,6 +48,19 @@ defmodule Pinchflat.YtDlp.Backend.CommandRunner do
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
defp build_cookie_options do
|
||||||
|
base_dir = Application.get_env(:pinchflat, :extras_directory)
|
||||||
|
cookie_file = Path.join(base_dir, "cookies.txt")
|
||||||
|
|
||||||
|
case File.read(cookie_file) do
|
||||||
|
{:ok, cookie_data} ->
|
||||||
|
if String.trim(cookie_data) != "", do: [cookies: cookie_file], else: []
|
||||||
|
|
||||||
|
{:error, _} ->
|
||||||
|
[]
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
# We want to satisfy the following behaviours:
|
# 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)
|
# 1. If the key is an atom, convert it to a string and convert it to kebab case (for convenience)
|
||||||
@@ -1,131 +0,0 @@
|
|||||||
defmodule Pinchflat.YtDlp.DownloadOptionBuilder do
|
|
||||||
@moduledoc """
|
|
||||||
Builds the options for yt-dlp to download media based on the given media profile.
|
|
||||||
"""
|
|
||||||
|
|
||||||
alias Pinchflat.Media.MediaItem
|
|
||||||
alias Pinchflat.Profiles.OutputPathBuilder
|
|
||||||
|
|
||||||
@doc """
|
|
||||||
Builds the options for yt-dlp to download media based on the given media's profile.
|
|
||||||
|
|
||||||
IDEA: consider adding the ability to pass in a second argument to override
|
|
||||||
these options
|
|
||||||
"""
|
|
||||||
def build(%MediaItem{} = media_item_with_preloads) do
|
|
||||||
media_profile = media_item_with_preloads.source.media_profile
|
|
||||||
|
|
||||||
built_options =
|
|
||||||
default_options() ++
|
|
||||||
subtitle_options(media_profile) ++
|
|
||||||
thumbnail_options(media_profile) ++
|
|
||||||
metadata_options(media_profile) ++
|
|
||||||
quality_options(media_profile) ++
|
|
||||||
output_options(media_item_with_preloads)
|
|
||||||
|
|
||||||
{:ok, built_options}
|
|
||||||
end
|
|
||||||
|
|
||||||
defp default_options do
|
|
||||||
[:no_progress, :windows_filenames]
|
|
||||||
end
|
|
||||||
|
|
||||||
defp subtitle_options(media_profile) do
|
|
||||||
mapped_struct = Map.from_struct(media_profile)
|
|
||||||
|
|
||||||
Enum.reduce(mapped_struct, [], fn attr, acc ->
|
|
||||||
case {attr, media_profile} do
|
|
||||||
{{:download_subs, true}, _} ->
|
|
||||||
# Force SRT for now - MAY provide as an option in the future
|
|
||||||
acc ++ [:write_subs, convert_subs: "srt"]
|
|
||||||
|
|
||||||
{{:download_auto_subs, true}, %{download_subs: true}} ->
|
|
||||||
acc ++ [:write_auto_subs]
|
|
||||||
|
|
||||||
{{:embed_subs, true}, %{preferred_resolution: pr}} when pr != :audio ->
|
|
||||||
acc ++ [:embed_subs]
|
|
||||||
|
|
||||||
{{:sub_langs, sub_langs}, %{download_subs: true}} ->
|
|
||||||
acc ++ [sub_langs: sub_langs]
|
|
||||||
|
|
||||||
{{:sub_langs, sub_langs}, %{embed_subs: true}} ->
|
|
||||||
acc ++ [sub_langs: sub_langs]
|
|
||||||
|
|
||||||
_ ->
|
|
||||||
acc
|
|
||||||
end
|
|
||||||
end)
|
|
||||||
end
|
|
||||||
|
|
||||||
defp thumbnail_options(media_profile) do
|
|
||||||
mapped_struct = Map.from_struct(media_profile)
|
|
||||||
|
|
||||||
Enum.reduce(mapped_struct, [], fn attr, acc ->
|
|
||||||
case {attr, media_profile} do
|
|
||||||
{{:download_thumbnail, true}, _} ->
|
|
||||||
acc ++ [:write_thumbnail]
|
|
||||||
|
|
||||||
{{:embed_thumbnail, true}, %{preferred_resolution: pr}} when pr != :audio ->
|
|
||||||
acc ++ [:embed_thumbnail]
|
|
||||||
|
|
||||||
_ ->
|
|
||||||
acc
|
|
||||||
end
|
|
||||||
end)
|
|
||||||
end
|
|
||||||
|
|
||||||
defp metadata_options(media_profile) do
|
|
||||||
mapped_struct = Map.from_struct(media_profile)
|
|
||||||
|
|
||||||
Enum.reduce(mapped_struct, [], fn attr, acc ->
|
|
||||||
case {attr, media_profile} do
|
|
||||||
{{:download_metadata, true}, _} ->
|
|
||||||
acc ++ [:write_info_json, :clean_info_json]
|
|
||||||
|
|
||||||
{{:embed_metadata, true}, %{preferred_resolution: pr}} when pr != :audio ->
|
|
||||||
acc ++ [:embed_metadata]
|
|
||||||
|
|
||||||
_ ->
|
|
||||||
acc
|
|
||||||
end
|
|
||||||
end)
|
|
||||||
end
|
|
||||||
|
|
||||||
defp quality_options(media_profile) do
|
|
||||||
codec_options = "+codec:avc:m4a"
|
|
||||||
|
|
||||||
case media_profile.preferred_resolution do
|
|
||||||
# Also be aware that :audio disabled all embedding options for thumbnails, subtitles, and metadata
|
|
||||||
:audio -> [format_sort: "ext", format: "bestaudio"]
|
|
||||||
:"360p" -> [format_sort: "res:360,#{codec_options}"]
|
|
||||||
:"480p" -> [format_sort: "res:480,#{codec_options}"]
|
|
||||||
:"720p" -> [format_sort: "res:720,#{codec_options}"]
|
|
||||||
:"1080p" -> [format_sort: "res:1080,#{codec_options}"]
|
|
||||||
:"1440p" -> [format_sort: "res:1440,#{codec_options}"]
|
|
||||||
:"2160p" -> [format_sort: "res:2160,#{codec_options}"]
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
defp output_options(media_item_with_preloads) do
|
|
||||||
media_profile = media_item_with_preloads.source.media_profile
|
|
||||||
additional_options_map = output_options_map(media_item_with_preloads)
|
|
||||||
{:ok, output_path} = OutputPathBuilder.build(media_profile.output_path_template, additional_options_map)
|
|
||||||
|
|
||||||
[
|
|
||||||
output: Path.join(base_directory(), output_path)
|
|
||||||
]
|
|
||||||
end
|
|
||||||
|
|
||||||
defp output_options_map(media_item_with_preloads) do
|
|
||||||
source = media_item_with_preloads.source
|
|
||||||
|
|
||||||
%{
|
|
||||||
"source_custom_name" => source.custom_name,
|
|
||||||
"source_collection_type" => source.collection_type
|
|
||||||
}
|
|
||||||
end
|
|
||||||
|
|
||||||
defp base_directory do
|
|
||||||
Application.get_env(:pinchflat, :media_directory)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
defmodule Pinchflat.YtDlp.Backend.Media do
|
defmodule Pinchflat.YtDlp.Media do
|
||||||
@moduledoc """
|
@moduledoc """
|
||||||
Contains utilities for working with singular pieces of media
|
Contains utilities for working with singular pieces of media
|
||||||
"""
|
"""
|
||||||
@@ -10,7 +10,8 @@ defmodule Pinchflat.YtDlp.Backend.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.Backend.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
|
||||||
@@ -85,8 +88,9 @@ defmodule Pinchflat.YtDlp.Backend.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.Backend.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)
|
||||||
@@ -0,0 +1,127 @@
|
|||||||
|
defmodule Pinchflat.YtDlp.MediaCollection do
|
||||||
|
@moduledoc """
|
||||||
|
Contains utilities for working with collections of
|
||||||
|
media (aka: a source [ie: channels, playlists]).
|
||||||
|
"""
|
||||||
|
|
||||||
|
require Logger
|
||||||
|
|
||||||
|
alias Pinchflat.Filesystem.FilesystemHelpers
|
||||||
|
alias Pinchflat.YtDlp.Media, as: YtDlpMedia
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Returns a list of maps representing the media in the collection.
|
||||||
|
|
||||||
|
Options:
|
||||||
|
- :file_listener_handler - a function that will be called with the path to the
|
||||||
|
file that will be written to when yt-dlp is done. This is useful for
|
||||||
|
setting up a file watcher to know when the file is ready to be read.
|
||||||
|
|
||||||
|
Returns {:ok, [map()]} | {:error, any, ...}.
|
||||||
|
"""
|
||||||
|
def get_media_attributes_for_collection(url, addl_opts \\ []) do
|
||||||
|
runner = Application.get_env(:pinchflat, :yt_dlp_runner)
|
||||||
|
# `ignore_no_formats_error` is necessary because yt-dlp will error out if
|
||||||
|
# the first video has not released yet (ie: is a premier). We don't care about
|
||||||
|
# available formats since we're just getting the media details
|
||||||
|
command_opts = [:simulate, :skip_download, :ignore_no_formats_error]
|
||||||
|
output_template = YtDlpMedia.indexing_output_template()
|
||||||
|
output_filepath = FilesystemHelpers.generate_metadata_tmpfile(:json)
|
||||||
|
file_listener_handler = Keyword.get(addl_opts, :file_listener_handler, false)
|
||||||
|
|
||||||
|
if file_listener_handler do
|
||||||
|
file_listener_handler.(output_filepath)
|
||||||
|
end
|
||||||
|
|
||||||
|
case runner.run(url, command_opts, output_template, output_filepath: output_filepath) do
|
||||||
|
{:ok, output} ->
|
||||||
|
parsed_lines =
|
||||||
|
output
|
||||||
|
|> String.split("\n", trim: true)
|
||||||
|
|> Enum.map(fn line ->
|
||||||
|
case Phoenix.json_library().decode(line) do
|
||||||
|
{:ok, parsed_json} ->
|
||||||
|
YtDlpMedia.response_to_struct(parsed_json)
|
||||||
|
|
||||||
|
_ ->
|
||||||
|
nil
|
||||||
|
end
|
||||||
|
end)
|
||||||
|
|
||||||
|
{:ok, Enum.filter(parsed_lines, &(&1 != nil))}
|
||||||
|
|
||||||
|
res ->
|
||||||
|
res
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Gets a source's ID and name from its URL.
|
||||||
|
|
||||||
|
yt-dlp does not _really_ have source-specific functions that return what
|
||||||
|
we need, so instead we're fetching just the first video (using playlist_end: 1)
|
||||||
|
and parsing the source ID and name from _its_ metadata
|
||||||
|
|
||||||
|
Returns {:ok, map()} | {:error, any, ...}.
|
||||||
|
"""
|
||||||
|
def get_source_details(source_url, addl_opts \\ []) do
|
||||||
|
# `ignore_no_formats_error` is necessary because yt-dlp will error out if
|
||||||
|
# the first video has not released yet (ie: is a premier). We don't care about
|
||||||
|
# available formats since we're just getting the source details
|
||||||
|
command_opts = [:simulate, :skip_download, :ignore_no_formats_error, playlist_end: 1] ++ addl_opts
|
||||||
|
output_template = "%(.{channel,channel_id,playlist_id,playlist_title,filename})j"
|
||||||
|
|
||||||
|
with {:ok, output} <- backend_runner().run(source_url, command_opts, output_template),
|
||||||
|
{:ok, parsed_json} <- Phoenix.json_library().decode(output) do
|
||||||
|
{:ok, format_source_details(parsed_json)}
|
||||||
|
else
|
||||||
|
err -> err
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Gets a source's metadata from its URL.
|
||||||
|
|
||||||
|
This is mostly for things like getting the source's avatar and banner image
|
||||||
|
(if applicable). However, this yt-dlp call doesn't have enough overlap with
|
||||||
|
`get_source_details/1` to allow combining them - this one has _almost_ everything
|
||||||
|
we need, but it doesn't contain enough information to tell 100% if the url is a channel
|
||||||
|
or a playlist.
|
||||||
|
|
||||||
|
The main purpose of this (past using as a fetcher for _other_ metadata) is to live
|
||||||
|
as a compressed blob for possible future use. That's why it's not getting formatted like
|
||||||
|
`get_source_details/1`
|
||||||
|
|
||||||
|
Returns {:ok, map()} | {:error, any, ...}.
|
||||||
|
"""
|
||||||
|
def get_source_metadata(source_url, addl_opts \\ []) do
|
||||||
|
opts = [playlist_items: 0] ++ addl_opts
|
||||||
|
output_template = "playlist:%()j"
|
||||||
|
|
||||||
|
with {:ok, output} <- backend_runner().run(source_url, opts, output_template),
|
||||||
|
{:ok, parsed_json} <- Phoenix.json_library().decode(output) do
|
||||||
|
{:ok, parsed_json}
|
||||||
|
else
|
||||||
|
err -> err
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
defp format_source_details(response) do
|
||||||
|
# NOTE: I should probably make this a struct some day
|
||||||
|
%{
|
||||||
|
channel_id: response["channel_id"],
|
||||||
|
channel_name: response["channel"],
|
||||||
|
playlist_id: response["playlist_id"],
|
||||||
|
playlist_name: response["playlist_title"],
|
||||||
|
# It's not a name, it's a path dammit!
|
||||||
|
# This actually isn't used for the inital response - it's
|
||||||
|
# used later to update a source's metadata
|
||||||
|
filepath: response["filename"]
|
||||||
|
}
|
||||||
|
end
|
||||||
|
|
||||||
|
defp backend_runner do
|
||||||
|
# This approach lets us mock the command for testing
|
||||||
|
Application.get_env(:pinchflat, :yt_dlp_runner)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -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,7 +14,7 @@ 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
|
||||||
|
|
||||||
@@ -251,7 +251,7 @@ defmodule PinchflatWeb.CoreComponents do
|
|||||||
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]"
|
||||||
|
|
||||||
@@ -304,6 +304,33 @@ defmodule PinchflatWeb.CoreComponents do
|
|||||||
"""
|
"""
|
||||||
end
|
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}><%= @help %></.help>
|
||||||
|
<.error :for={msg <- @errors}><%= msg %></.error>
|
||||||
|
</div>
|
||||||
|
"""
|
||||||
|
end
|
||||||
|
|
||||||
def input(%{type: "toggle"} = assigns) do
|
def input(%{type: "toggle"} = assigns) do
|
||||||
assigns =
|
assigns =
|
||||||
assign_new(assigns, :checked, fn ->
|
assign_new(assigns, :checked, fn ->
|
||||||
@@ -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
|
||||||
@@ -349,23 +366,27 @@ 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>
|
||||||
|
<%= Phoenix.HTML.Form.options_for_select(@options, @value) %>
|
||||||
|
</select>
|
||||||
|
<%= render_slot(@inner_block) %>
|
||||||
|
</div>
|
||||||
<.help :if={@help}><%= @help %></.help>
|
<.help :if={@help}><%= @help %></.help>
|
||||||
<.error :for={msg <- @errors}><%= msg %></.error>
|
<.error :for={msg <- @errors}><%= msg %></.error>
|
||||||
</div>
|
</div>
|
||||||
@@ -607,6 +628,10 @@ 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)
|
||||||
|
|
||||||
@@ -661,10 +686,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,31 @@ 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: 0, activeClasses: 'text-meta-5 border-meta-5', inactiveClasses: 'border-transparent' }"
|
||||||
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 = #{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">
|
||||||
<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>
|
||||||
|
|||||||
@@ -31,6 +31,20 @@ defmodule PinchflatWeb.CustomComponents.TextComponents do
|
|||||||
"""
|
"""
|
||||||
end
|
end
|
||||||
|
|
||||||
|
@doc """
|
||||||
|
Renders a subtle link with the given href and content.
|
||||||
|
"""
|
||||||
|
attr :href, :string, required: true
|
||||||
|
slot :inner_block
|
||||||
|
|
||||||
|
def subtle_link(assigns) do
|
||||||
|
~H"""
|
||||||
|
<.link href={@href} class="underline decoration-bodydark decoration-1 hover:decoration-white">
|
||||||
|
<%= render_slot(@inner_block) %>
|
||||||
|
</.link>
|
||||||
|
"""
|
||||||
|
end
|
||||||
|
|
||||||
@doc """
|
@doc """
|
||||||
Renders an icon as a link with the given href.
|
Renders an icon as a link with the given href.
|
||||||
"""
|
"""
|
||||||
|
|||||||
@@ -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,24 +1,23 @@
|
|||||||
<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">
|
||||||
@@ -31,8 +30,14 @@
|
|||||||
</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
|
||||||
|
icon="hero-book-open"
|
||||||
|
text="Docs"
|
||||||
|
target="_blank"
|
||||||
|
href="https://github.com/kieraneglin/pinchflat/wiki"
|
||||||
|
/>
|
||||||
<.sidebar_item
|
<.sidebar_item
|
||||||
icon="hero-code-bracket"
|
icon="hero-code-bracket"
|
||||||
text="Github"
|
text="Github"
|
||||||
@@ -52,6 +57,11 @@
|
|||||||
<.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 py-2 text-sm">
|
||||||
|
v<%= Application.spec(:pinchflat)[:vsn] %>
|
||||||
|
</span>
|
||||||
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</nav>
|
</nav>
|
||||||
</section>
|
</section>
|
||||||
|
|||||||
@@ -8,18 +8,22 @@
|
|||||||
<%= assigns[:page_title] || "Pinchflat" %>
|
<%= assigns[:page_title] || "Pinchflat" %>
|
||||||
</.live_title>
|
</.live_title>
|
||||||
<link phx-track-static rel="stylesheet" href={~p"/assets/app.css"} />
|
<link phx-track-static rel="stylesheet" href={~p"/assets/app.css"} />
|
||||||
<link rel="icon" type="image/x-icon" href={~p"/favicon.ico?cachebust=2024-02-29"} />
|
<link rel="icon" type="image/x-icon" href={~p"/favicon.ico?cachebust=2024-03-20"} />
|
||||||
<script defer phx-track-static type="text/javascript" src={~p"/assets/app.js"}>
|
<script defer phx-track-static type="text/javascript" src={~p"/assets/app.js"}>
|
||||||
</script>
|
</script>
|
||||||
</head>
|
</head>
|
||||||
<body
|
<body
|
||||||
x-data={"{ sidebarVisible: false, proEnabled: #{Settings.get!(:pro_enabled)} }"}
|
x-data={"{
|
||||||
|
sidebarVisible: false,
|
||||||
|
proEnabled: #{Settings.get!(:pro_enabled)},
|
||||||
|
onboarding: #{Settings.get!(:onboarding)}
|
||||||
|
}"}
|
||||||
class="dark text-bodydark bg-boxdark-2"
|
class="dark text-bodydark bg-boxdark-2"
|
||||||
>
|
>
|
||||||
<%= @inner_content %>
|
<%= @inner_content %>
|
||||||
|
|
||||||
<.donate_modal conn={@conn} />
|
<.donate_modal conn={@conn} />
|
||||||
<template x-if="!proEnabled">
|
<template x-if="!proEnabled && !onboarding">
|
||||||
<.upgrade_modal conn={@conn} />
|
<.upgrade_modal conn={@conn} />
|
||||||
</template>
|
</template>
|
||||||
</body>
|
</body>
|
||||||
|
|||||||
@@ -1,8 +1,11 @@
|
|||||||
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
|
||||||
|
|
||||||
def show(conn, %{"id" => id}) do
|
def show(conn, %{"id" => id}) do
|
||||||
media_item =
|
media_item =
|
||||||
@@ -29,4 +32,69 @@ defmodule PinchflatWeb.MediaItems.MediaItemController do
|
|||||||
|> put_flash(:info, flash_message)
|
|> put_flash(:info, flash_message)
|
||||||
|> redirect(to: ~p"/sources/#{media_item.source_id}")
|
|> redirect(to: ~p"/sources/#{media_item.source_id}")
|
||||||
end
|
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
|
||||||
|
|||||||
@@ -2,4 +2,16 @@ defmodule PinchflatWeb.MediaItems.MediaItemHTML do
|
|||||||
use PinchflatWeb, :html
|
use PinchflatWeb, :html
|
||||||
|
|
||||||
embed_templates "media_item_html/*"
|
embed_templates "media_item_html/*"
|
||||||
|
|
||||||
|
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,13 @@
|
|||||||
|
<%= if media_type(@media_item) == :video do %>
|
||||||
|
<video controls class="max-h-96 w-full lg:w-2/3 xl:w-1/2">
|
||||||
|
<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 lg:w-2/3 xl:w-1/2">
|
||||||
|
<source src={~p"/media/#{@media_item.uuid}/stream"} type="audio/mpeg" />
|
||||||
|
Your browser does not support the audio element.
|
||||||
|
</audio>
|
||||||
|
<% end %>
|
||||||
@@ -8,11 +8,30 @@
|
|||||||
</h2>
|
</h2>
|
||||||
</div>
|
</div>
|
||||||
</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_append>
|
||||||
|
<.button_dropdown text="Actions" class="justify-center w-full sm:w-50">
|
||||||
|
<:option>
|
||||||
|
<.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."
|
||||||
|
>
|
||||||
|
Delete Files
|
||||||
|
</.link>
|
||||||
|
</:option>
|
||||||
|
</.button_dropdown>
|
||||||
|
</:tab_append>
|
||||||
|
|
||||||
<:tab title="Attributes">
|
<:tab title="Attributes">
|
||||||
<div class="flex flex-col gap-10 dark:text-white">
|
<div class="flex flex-col gap-10 dark:text-white">
|
||||||
|
<%= if media_file_exists?(@media_item) do %>
|
||||||
|
<h3 class="font-bold text-xl">Preview</h3>
|
||||||
|
<.media_preview media_item={@media_item} />
|
||||||
|
<% end %>
|
||||||
|
|
||||||
<h3 class="font-bold text-xl">Attributes</h3>
|
<h3 class="font-bold text-xl">Attributes</h3>
|
||||||
<section>
|
<section>
|
||||||
<strong>Source:</strong>
|
<strong>Source:</strong>
|
||||||
@@ -23,18 +42,6 @@
|
|||||||
|
|
||||||
<.list_items_from_map map={Map.from_struct(@media_item)} />
|
<.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,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,13 +32,35 @@ 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,
|
||||||
upload_month: nil,
|
upload_month: nil,
|
||||||
upload_year: nil,
|
upload_year: nil,
|
||||||
|
upload_yyyy_mm_dd: "the upload date in the format YYYY-MM-DD",
|
||||||
source_custom_name: "the name of the sources that use this profile",
|
source_custom_name: "the name of the sources that use this profile",
|
||||||
source_collection_type: "the collection type of the sources that use this profile. Either 'channel' or 'playlist'"
|
source_collection_type: "the collection type of the sources using this profile. Either 'channel' or 'playlist'",
|
||||||
|
artist_name: "the name of the artist with fallbacks to other uploader fields"
|
||||||
}
|
}
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -52,4 +76,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 %>
|
||||||
|
|||||||
+258
-101
@@ -3,116 +3,273 @@
|
|||||||
Oops, something went wrong! Please check the errors below.
|
Oops, something went wrong! Please check the errors below.
|
||||||
</.error>
|
</.error>
|
||||||
|
|
||||||
<h3 class="my-4 text-2xl text-black dark:text-white">
|
<section x-data="{ selectedPreset: null }">
|
||||||
General Options
|
<h3 class="my-4 text-2xl text-black dark:text-white">
|
||||||
</h3>
|
Use a Preset
|
||||||
<.input
|
</h3>
|
||||||
field={f[:name]}
|
<section x-data="{ selection: null }">
|
||||||
type="text"
|
<.input
|
||||||
label="Name"
|
prompt="Select preset"
|
||||||
placeholder="New Profile"
|
name="media_profile_preset"
|
||||||
help="Something descriptive. Does not impact indexing or downloading (required)"
|
value=""
|
||||||
/>
|
options={preset_options()}
|
||||||
|
type="select"
|
||||||
|
x-model="selection"
|
||||||
|
inputclass="w-full"
|
||||||
|
help="You can further customize the settings after selecting a preset. This is just a starting point"
|
||||||
|
>
|
||||||
|
<.button
|
||||||
|
class="h-13 w-2/5 lg:w-1/5 ml-2 md:ml-4"
|
||||||
|
rounding="rounded"
|
||||||
|
type="button"
|
||||||
|
x-on:click="selectedPreset = selection; selection = null"
|
||||||
|
x-bind:disabled="!selection"
|
||||||
|
>
|
||||||
|
<span x-text="selection ? 'Load' : 'Select'">Select</span><span class="hidden lg:inline ml-1">Preset</span>
|
||||||
|
</.button>
|
||||||
|
</.input>
|
||||||
|
</section>
|
||||||
|
|
||||||
<.input
|
<h3 class="mt-8 text-2xl text-black dark:text-white">
|
||||||
field={f[:output_path_template]}
|
General Options
|
||||||
type="text"
|
</h3>
|
||||||
inputclass="font-mono"
|
|
||||||
label="Output path template"
|
|
||||||
help="Must end with .{{ ext }}. See below for more details. I promise the default is good for most cases (required)"
|
|
||||||
/>
|
|
||||||
|
|
||||||
<h3 class="mt-8 text-2xl text-black dark:text-white">
|
<section x-data="{
|
||||||
Subtitle Options
|
presets: {
|
||||||
</h3>
|
default: 'Default',
|
||||||
<.input
|
media_center: 'TV Shows',
|
||||||
field={f[:download_subs]}
|
audio: '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. Setting to 'Audio Only' negates embedding options."
|
help="Use commas for multiple languages (eg: en,de)"
|
||||||
/>
|
x-init="$watch('selectedPreset', p => p && ($el.value = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
<.button class="my-10 sm:mb-7.5 w-full sm:w-auto">Save Media profile</.button>
|
<h3 class="mt-10 text-2xl text-black dark:text-white">
|
||||||
|
Thumbnail Options
|
||||||
|
</h3>
|
||||||
|
|
||||||
|
<section x-data="{ presets: { default: true, media_center: true, audio: false, archiving: true } }">
|
||||||
|
<.input
|
||||||
|
field={f[:download_thumbnail]}
|
||||||
|
type="toggle"
|
||||||
|
label="Download Thumbnail"
|
||||||
|
help="Downloads thumbnail alongside media file"
|
||||||
|
x-init="$watch('selectedPreset', p => p && (enabled = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section x-data="{ presets: { default: true, media_center: true, audio: true, archiving: true } }">
|
||||||
|
<.input
|
||||||
|
field={f[:embed_thumbnail]}
|
||||||
|
type="toggle"
|
||||||
|
label="Embed Thumbnail"
|
||||||
|
help="Downloads and embeds thumbnail in the media file itself, if supported. Uneffected by 'Download Thumbnail' (recommended)"
|
||||||
|
x-init="$watch('selectedPreset', p => p && (enabled = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<h3 class="mt-10 text-2xl text-black dark:text-white">
|
||||||
|
Metadata Options
|
||||||
|
</h3>
|
||||||
|
|
||||||
|
<section x-data="{ presets: { default: false, media_center: false, audio: false, archiving: true } }">
|
||||||
|
<.input
|
||||||
|
field={f[:download_metadata]}
|
||||||
|
type="toggle"
|
||||||
|
label="Download Metadata"
|
||||||
|
help="Downloads metadata file alongside media file"
|
||||||
|
x-init="$watch('selectedPreset', p => p && (enabled = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section x-data="{ presets: { default: true, media_center: true, audio: true, archiving: true } }">
|
||||||
|
<.input
|
||||||
|
field={f[:embed_metadata]}
|
||||||
|
type="toggle"
|
||||||
|
label="Embed Metadata"
|
||||||
|
help="Downloads and embeds metadata in the media file itself, if supported. Uneffected by 'Download Metadata' (recommended)"
|
||||||
|
x-init="$watch('selectedPreset', p => p && (enabled = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<h3 class="mt-10 text-2xl text-black dark:text-white">
|
||||||
|
Release Format Options
|
||||||
|
</h3>
|
||||||
|
|
||||||
|
<section x-data="{ presets: { default: 'include', media_center: 'exclude', audio: 'exclude', archiving: 'include' } }">
|
||||||
|
<.input
|
||||||
|
field={f[:shorts_behaviour]}
|
||||||
|
options={friendly_format_type_options()}
|
||||||
|
type="select"
|
||||||
|
label="Include Shorts"
|
||||||
|
help="Experimental. Please report any issues on GitHub"
|
||||||
|
x-init="$watch('selectedPreset', p => p && ($el.value = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section x-data="{ presets: { default: 'exclude', media_center: 'exclude', audio: 'exclude', archiving: 'include' } }">
|
||||||
|
<.input
|
||||||
|
field={f[:livestream_behaviour]}
|
||||||
|
options={friendly_format_type_options()}
|
||||||
|
type="select"
|
||||||
|
label="Include Livestreams"
|
||||||
|
help="Excludes media that comes from a past livestream"
|
||||||
|
x-init="$watch('selectedPreset', p => p && ($el.value = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<h3 class="mt-10 text-2xl text-black dark:text-white">
|
||||||
|
Quality Options
|
||||||
|
</h3>
|
||||||
|
|
||||||
|
<section x-data="{ presets: { default: '1080p', media_center: '1080p', audio: 'audio', archiving: '2160p' } }">
|
||||||
|
<.input
|
||||||
|
field={f[:preferred_resolution]}
|
||||||
|
options={friendly_resolution_options()}
|
||||||
|
type="select"
|
||||||
|
label="Preferred Resolution"
|
||||||
|
help="Will grab the closest available resolution if your preferred is not available. 'Audio Only' grabs the highest quality m4a"
|
||||||
|
x-init="$watch('selectedPreset', p => p && ($el.value = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<h3 class="mt-8 text-2xl text-black dark:text-white">
|
||||||
|
Media Center Options
|
||||||
|
</h3>
|
||||||
|
<p class="text-sm mt-2 max-w-prose">
|
||||||
|
Everything in this section is experimental - please open a GitHub issue if you see something odd.
|
||||||
|
<strong>
|
||||||
|
These options only work if this Media Profile's output template is set to split media into seasons.
|
||||||
|
</strong>
|
||||||
|
Try the "Media Center" preset if you're not sure.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<section
|
||||||
|
phx-click={show_modal("upgrade-modal")}
|
||||||
|
x-data="{ presets: { default: false, media_center: true, audio: false, archiving: false } }"
|
||||||
|
>
|
||||||
|
<.input
|
||||||
|
field={f[:download_nfo]}
|
||||||
|
type="toggle"
|
||||||
|
label="Download NFO data"
|
||||||
|
label_suffix="(pro)"
|
||||||
|
help="Downloads NFO data alongside media file for use with Jellyfin, Kodi, etc."
|
||||||
|
x-init="$watch('selectedPreset', p => p && (enabled = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section x-data="{ presets: { default: false, media_center: true, audio: false, archiving: true } }">
|
||||||
|
<.input
|
||||||
|
field={f[:download_source_images]}
|
||||||
|
type="toggle"
|
||||||
|
label="Download Series Images"
|
||||||
|
help="Downloads poster and banner images for use with Plex, Jellyfin, Kodi, etc. Only works for full channels (not playlists)"
|
||||||
|
x-init="$watch('selectedPreset', p => p && (enabled = presets[p]))"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<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,33 +19,35 @@
|
|||||||
<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_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="Attributes">
|
<:tab title="Attributes">
|
||||||
<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">Attributes for "<%= @media_profile.name %>"</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={@media_profile.sources} table_class="text-black dark:text-white">
|
||||||
|
|||||||
@@ -8,38 +8,34 @@ defmodule PinchflatWeb.Pages.PageController do
|
|||||||
alias Pinchflat.Profiles.MediaProfile
|
alias Pinchflat.Profiles.MediaProfile
|
||||||
|
|
||||||
def home(conn, params) do
|
def home(conn, params) do
|
||||||
force_onboarding = params["onboarding"]
|
done_onboarding = params["onboarding"] == "0"
|
||||||
media_profiles_exist = Repo.exists?(MediaProfile)
|
force_onboarding = params["onboarding"] == "1"
|
||||||
sources_exist = Repo.exists?(Source)
|
|
||||||
|
|
||||||
if !force_onboarding && media_profiles_exist && sources_exist do
|
if done_onboarding, do: Settings.set!(:onboarding, false)
|
||||||
render_home_page(conn)
|
|
||||||
|
if force_onboarding || Settings.get!(:onboarding) do
|
||||||
|
render_onboarding_page(conn)
|
||||||
else
|
else
|
||||||
render_onboarding_page(conn, media_profiles_exist, sources_exist)
|
render_home_page(conn)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
defp render_home_page(conn) do
|
defp render_home_page(conn) do
|
||||||
Settings.set!(:onboarding, false)
|
|
||||||
media_profile_count = Repo.aggregate(MediaProfile, :count, :id)
|
|
||||||
source_count = Repo.aggregate(Source, :count, :id)
|
|
||||||
media_item_count = Repo.aggregate(MediaItem, :count, :id)
|
|
||||||
|
|
||||||
conn
|
conn
|
||||||
|> render(:home,
|
|> render(:home,
|
||||||
media_profile_count: media_profile_count,
|
media_profile_count: Repo.aggregate(MediaProfile, :count, :id),
|
||||||
source_count: source_count,
|
source_count: Repo.aggregate(Source, :count, :id),
|
||||||
media_item_count: media_item_count
|
media_item_count: Repo.aggregate(MediaItem, :count, :id)
|
||||||
)
|
)
|
||||||
end
|
end
|
||||||
|
|
||||||
defp render_onboarding_page(conn, media_profiles_exist, sources_exist) do
|
defp render_onboarding_page(conn) do
|
||||||
Settings.set!(:onboarding, true)
|
Settings.set!(:onboarding, true)
|
||||||
|
|
||||||
conn
|
conn
|
||||||
|> render(:onboarding_checklist,
|
|> render(:onboarding_checklist,
|
||||||
media_profiles_exist: media_profiles_exist,
|
media_profiles_exist: Repo.exists?(MediaProfile),
|
||||||
sources_exist: sources_exist,
|
sources_exist: Repo.exists?(Source),
|
||||||
layout: {Layouts, :onboarding}
|
layout: {Layouts, :onboarding}
|
||||||
)
|
)
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -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">
|
<a href="#" 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>
|
</a>
|
||||||
</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>
|
||||||
@@ -39,8 +39,8 @@
|
|||||||
</p>
|
</p>
|
||||||
<p class="text-md text-bodydark">Feel free to add more Media Profiles or Sources in the meantime!</p>
|
<p class="text-md text-bodydark">Feel free to add more Media Profiles or Sources in the meantime!</p>
|
||||||
<div class="mt-8">
|
<div class="mt-8">
|
||||||
<.link href={~p"/"}>
|
<.link href={~p"/?onboarding=0"}>
|
||||||
<.button color="bg-primary" rounding="rounded-full" disabled={not @sources_exist}>
|
<.button color="bg-primary" rounding="rounded-lg" disabled={not @sources_exist}>
|
||||||
Let's Go <span class="font-bold mx-2">🚀</span>
|
Let's Go <span class="font-bold mx-2">🚀</span>
|
||||||
</.button>
|
</.button>
|
||||||
</.link>
|
</.link>
|
||||||
|
|||||||
@@ -0,0 +1,38 @@
|
|||||||
|
defmodule PinchflatWeb.Podcasts.PodcastController do
|
||||||
|
use PinchflatWeb, :controller
|
||||||
|
|
||||||
|
alias Pinchflat.Repo
|
||||||
|
alias Pinchflat.Media
|
||||||
|
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 provides a fallback image if the source has none.
|
||||||
|
# We only need one since we're using the internal metadata image which
|
||||||
|
# we know exists.
|
||||||
|
media_items = Media.list_downloaded_media_items_for(source, limit: 1)
|
||||||
|
|
||||||
|
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} />
|
||||||
|
|||||||
@@ -1,12 +1,15 @@
|
|||||||
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.Media
|
||||||
alias Pinchflat.Tasks
|
alias Pinchflat.Tasks
|
||||||
alias Pinchflat.Sources
|
alias Pinchflat.Sources
|
||||||
alias Pinchflat.Profiles
|
alias Pinchflat.Profiles
|
||||||
alias Pinchflat.Sources.Source
|
alias Pinchflat.Sources.Source
|
||||||
|
alias Pinchflat.Media.MediaQuery
|
||||||
|
|
||||||
def index(conn, _params) do
|
def index(conn, _params) do
|
||||||
sources = Repo.preload(Sources.list_sources(), :media_profile)
|
sources = Repo.preload(Sources.list_sources(), :media_profile)
|
||||||
@@ -46,7 +49,7 @@ 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 = Repo.preload(Tasks.list_pending_tasks_for(source), :job)
|
||||||
pending_media = Media.list_pending_media_items_for(source, limit: 100)
|
pending_media = Media.list_pending_media_items_for(source, limit: 100)
|
||||||
downloaded_media = Media.list_downloaded_media_items_for(source, limit: 100)
|
downloaded_media = Media.list_downloaded_media_items_for(source, limit: 100)
|
||||||
|
|
||||||
@@ -54,7 +57,8 @@ defmodule PinchflatWeb.Sources.SourceController do
|
|||||||
source: source,
|
source: source,
|
||||||
pending_tasks: pending_tasks,
|
pending_tasks: pending_tasks,
|
||||||
pending_media: pending_media,
|
pending_media: pending_media,
|
||||||
downloaded_media: downloaded_media
|
downloaded_media: downloaded_media,
|
||||||
|
total_downloaded: total_downloaded_for(source)
|
||||||
)
|
)
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -104,6 +108,15 @@ defmodule PinchflatWeb.Sources.SourceController do
|
|||||||
Profiles.list_media_profiles()
|
Profiles.list_media_profiles()
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# NOTE: should move this out of the controller
|
||||||
|
# once I finally add some query fragment layer
|
||||||
|
defp total_downloaded_for(source) do
|
||||||
|
MediaQuery.new()
|
||||||
|
|> MediaQuery.for_source(source)
|
||||||
|
|> MediaQuery.with_media_filepath()
|
||||||
|
|> Repo.aggregate(:count, :id)
|
||||||
|
end
|
||||||
|
|
||||||
defp get_onboarding_layout do
|
defp get_onboarding_layout do
|
||||||
if Settings.get!(:onboarding) do
|
if Settings.get!(:onboarding) do
|
||||||
{Layouts, :onboarding}
|
{Layouts, :onboarding}
|
||||||
|
|||||||
@@ -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,8 @@ 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
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -2,7 +2,9 @@
|
|||||||
<.link href={~p"/sources"}>
|
<.link href={~p"/sources"}>
|
||||||
<.icon name="hero-arrow-left" class="w-10 h-10 hover:dark:text-white" />
|
<.icon name="hero-arrow-left" class="w-10 h-10 hover:dark:text-white" />
|
||||||
</.link>
|
</.link>
|
||||||
<h2 class="text-title-md2 font-bold text-black dark:text-white ml-4">Edit Source</h2>
|
<h2 class="text-title-md2 font-bold text-black dark:text-white ml-4">
|
||||||
|
Editing "<%= @source.custom_name %>"
|
||||||
|
</h2>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="rounded-sm border border-stroke bg-white px-5 pb-2.5 pt-6 shadow-default dark:border-strokedark dark:bg-boxdark sm:px-7.5 xl:pb-1">
|
<div class="rounded-sm border border-stroke bg-white px-5 pb-2.5 pt-6 shadow-default dark:border-strokedark dark:bg-boxdark sm:px-7.5 xl:pb-1">
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
<h2 class="text-title-md2 font-bold text-black dark:text-white">Sources</h2>
|
<h2 class="text-title-md2 font-bold text-black dark:text-white">Sources</h2>
|
||||||
<nav>
|
<nav>
|
||||||
<.link href={~p"/sources/new"}>
|
<.link href={~p"/sources/new"}>
|
||||||
<.button color="bg-primary" rounding="rounded-full">
|
<.button color="bg-primary" rounding="rounded-lg">
|
||||||
<span class="font-bold mx-2">+</span> New <span class="hidden sm:inline pl-1">Source</span>
|
<span class="font-bold mx-2">+</span> New <span class="hidden sm:inline pl-1">Source</span>
|
||||||
</.button>
|
</.button>
|
||||||
</.link>
|
</.link>
|
||||||
@@ -14,19 +14,18 @@
|
|||||||
<div class="flex flex-col gap-10 min-w-max">
|
<div class="flex flex-col gap-10 min-w-max">
|
||||||
<.table rows={@sources} table_class="text-black dark:text-white">
|
<.table rows={@sources} table_class="text-black dark:text-white">
|
||||||
<:col :let={source} label="Name">
|
<:col :let={source} label="Name">
|
||||||
<%= source.custom_name || source.collection_name %>
|
<.subtle_link href={~p"/sources/#{source.id}"}>
|
||||||
|
<%= source.custom_name || source.collection_name %>
|
||||||
|
</.subtle_link>
|
||||||
</:col>
|
</:col>
|
||||||
<:col :let={source} label="Type"><%= source.collection_type %></:col>
|
<:col :let={source} label="Type"><%= source.collection_type %></:col>
|
||||||
<:col :let={source} label="Should Download?">
|
<:col :let={source} label="Should Download?">
|
||||||
<.icon name={if source.download_media, do: "hero-check", else: "hero-x-mark"} />
|
<.icon name={if source.download_media, do: "hero-check", else: "hero-x-mark"} />
|
||||||
</:col>
|
</:col>
|
||||||
<:col :let={source} label="Media Profile">
|
<:col :let={source} label="Media Profile">
|
||||||
<.link
|
<.subtle_link href={~p"/media_profiles/#{source.media_profile_id}"}>
|
||||||
href={~p"/media_profiles/#{source.media_profile_id}"}
|
|
||||||
class="hover:text-secondary duration-200 ease-in-out"
|
|
||||||
>
|
|
||||||
<%= source.media_profile.name %>
|
<%= source.media_profile.name %>
|
||||||
</.link>
|
</.subtle_link>
|
||||||
</:col>
|
</:col>
|
||||||
<:col :let={source} label="" class="flex place-content-evenly">
|
<:col :let={source} label="" class="flex place-content-evenly">
|
||||||
<.icon_link href={~p"/sources/#{source.id}"} icon="hero-eye" class="mx-1" />
|
<.icon_link href={~p"/sources/#{source.id}"} icon="hero-eye" class="mx-1" />
|
||||||
|
|||||||
@@ -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-4">
|
<h2 class="text-title-md2 font-bold text-black dark:text-white ml-4">
|
||||||
Source <span class="hidden sm:inline">#<%= @source.id %></span>
|
<%= @source.custom_name %>
|
||||||
</h2>
|
</h2>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav>
|
<nav>
|
||||||
<.link href={~p"/sources/#{@source}/edit"}>
|
<.link href={~p"/sources/#{@source}/edit"}>
|
||||||
<.button color="bg-primary" rounding="rounded-full">
|
<.button color="bg-primary" rounding="rounded-lg">
|
||||||
<.icon name="hero-pencil-square" class="mr-2" /> Edit <span class="hidden sm:inline pl-1">Source</span>
|
<.icon name="hero-pencil-square" class="mr-2" /> Edit <span class="hidden sm:inline pl-1">Source</span>
|
||||||
</.button>
|
</.button>
|
||||||
</.link>
|
</.link>
|
||||||
@@ -19,6 +19,46 @@
|
|||||||
<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="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">
|
<div class="max-w-full overflow-x-auto">
|
||||||
<.tabbed_layout>
|
<.tabbed_layout>
|
||||||
|
<:tab_append>
|
||||||
|
<.button_dropdown text="Actions" class="justify-center w-full sm:w-50">
|
||||||
|
<:option>
|
||||||
|
<span
|
||||||
|
x-data="{ copied: false }"
|
||||||
|
x-on:click={"
|
||||||
|
window.copyTextToClipboard('#{rss_feed_url(@conn, @source)}')
|
||||||
|
copied = true
|
||||||
|
setTimeout(() => copied = false, 4000)
|
||||||
|
"}
|
||||||
|
>
|
||||||
|
Copy RSS Feed
|
||||||
|
<span x-show="copied" x-transition.duration.150ms><.icon name="hero-check" class="ml-2 h-4 w-4" /></span>
|
||||||
|
</span>
|
||||||
|
</:option>
|
||||||
|
<:option>
|
||||||
|
<div class="h-px w-full bg-bodydark2"></div>
|
||||||
|
</:option>
|
||||||
|
<:option>
|
||||||
|
<.link
|
||||||
|
href={~p"/sources/#{@source}"}
|
||||||
|
method="delete"
|
||||||
|
data-confirm="Are you sure you want to delete this source (leaving files in place)? This cannot be undone."
|
||||||
|
>
|
||||||
|
Delete Source
|
||||||
|
</.link>
|
||||||
|
</:option>
|
||||||
|
<:option>
|
||||||
|
<.link
|
||||||
|
href={~p"/sources/#{@source}?delete_files=true"}
|
||||||
|
method="delete"
|
||||||
|
data-confirm="Are you sure you want to delete this source and it's files on disk? This cannot be undone."
|
||||||
|
class="mt-5 md:mt-0"
|
||||||
|
>
|
||||||
|
Delete Source + Files
|
||||||
|
</.link>
|
||||||
|
</:option>
|
||||||
|
</.button_dropdown>
|
||||||
|
</:tab_append>
|
||||||
|
|
||||||
<:tab title="Attributes">
|
<:tab title="Attributes">
|
||||||
<div class="flex flex-col gap-10 text-white">
|
<div class="flex flex-col gap-10 text-white">
|
||||||
<h3 class="font-bold text-lg">Attributes</h3>
|
<h3 class="font-bold text-lg">Attributes</h3>
|
||||||
@@ -31,28 +71,6 @@
|
|||||||
|
|
||||||
<.list_items_from_map map={Map.from_struct(@source)} />
|
<.list_items_from_map map={Map.from_struct(@source)} />
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<section class="flex flex-col md:flex-row items-center md:justify-around mt-10">
|
|
||||||
<.link
|
|
||||||
href={~p"/sources/#{@source}"}
|
|
||||||
method="delete"
|
|
||||||
data-confirm="Are you sure you want to delete this source (leaving files in place)? This cannot be undone."
|
|
||||||
>
|
|
||||||
<.button color="bg-meta-1" rounding="rounded-full">
|
|
||||||
Delete Source
|
|
||||||
</.button>
|
|
||||||
</.link>
|
|
||||||
<.link
|
|
||||||
href={~p"/sources/#{@source}?delete_files=true"}
|
|
||||||
method="delete"
|
|
||||||
data-confirm="Are you sure you want to delete this source and it's files on disk? This cannot be undone."
|
|
||||||
class="mt-5 md:mt-0"
|
|
||||||
>
|
|
||||||
<.button color="bg-meta-1" rounding="rounded-full">
|
|
||||||
Delete Source and Files
|
|
||||||
</.button>
|
|
||||||
</.link>
|
|
||||||
</section>
|
|
||||||
</:tab>
|
</:tab>
|
||||||
<:tab title="Pending Media">
|
<:tab title="Pending Media">
|
||||||
<%= if match?([_|_], @pending_media) do %>
|
<%= if match?([_|_], @pending_media) do %>
|
||||||
@@ -71,7 +89,7 @@
|
|||||||
</:tab>
|
</:tab>
|
||||||
<:tab title="Downloaded Media">
|
<:tab title="Downloaded Media">
|
||||||
<%= if match?([_|_], @downloaded_media) do %>
|
<%= if match?([_|_], @downloaded_media) do %>
|
||||||
<h4 class="text-white text-lg mb-6">Shows a maximum of 100 media items</h4>
|
<h4 class="text-white text-lg mb-6">Shows a maximum of 100 media items (<%= @total_downloaded %> total)</h4>
|
||||||
<.table rows={@downloaded_media} table_class="text-black dark:text-white">
|
<.table rows={@downloaded_media} table_class="text-black dark:text-white">
|
||||||
<:col :let={media_item} label="Title">
|
<:col :let={media_item} label="Title">
|
||||||
<%= StringUtils.truncate(media_item.title, 50) %>
|
<%= StringUtils.truncate(media_item.title, 50) %>
|
||||||
|
|||||||
@@ -1,11 +1,22 @@
|
|||||||
<.simple_form :let={f} for={@changeset} action={@action}>
|
<.simple_form
|
||||||
|
:let={f}
|
||||||
|
for={@changeset}
|
||||||
|
action={@action}
|
||||||
|
x-data="{ advancedMode: !!JSON.parse(localStorage.getItem('advancedMode')) }"
|
||||||
|
x-init="$watch('advancedMode', value => localStorage.setItem('advancedMode', JSON.stringify(value)))"
|
||||||
|
>
|
||||||
<.error :if={@changeset.action}>
|
<.error :if={@changeset.action}>
|
||||||
Oops, something went wrong! Please check the errors below.
|
Oops, something went wrong! Please check the errors below.
|
||||||
</.error>
|
</.error>
|
||||||
|
|
||||||
<h3 class="mt-8 text-2xl text-black dark:text-white">
|
<section class="flex justify-between items-center mt-8">
|
||||||
General Options
|
<h3 class=" text-2xl text-black dark:text-white">
|
||||||
</h3>
|
General Options
|
||||||
|
</h3>
|
||||||
|
<span class="cursor-pointer hover:underline" x-on:click="advancedMode = !advancedMode">
|
||||||
|
Editing Mode: <span x-text="advancedMode ? 'Advanced' : 'Basic'"></span>
|
||||||
|
</span>
|
||||||
|
</section>
|
||||||
|
|
||||||
<.input
|
<.input
|
||||||
field={f[:custom_name]}
|
field={f[:custom_name]}
|
||||||
@@ -21,30 +32,39 @@
|
|||||||
options={Enum.map(@media_profiles, &{&1.name, &1.id})}
|
options={Enum.map(@media_profiles, &{&1.name, &1.id})}
|
||||||
type="select"
|
type="select"
|
||||||
label="Media Profile"
|
label="Media Profile"
|
||||||
|
help="Sets your preferences for what media to look for and how to store it"
|
||||||
/>
|
/>
|
||||||
|
|
||||||
<h3 class="mt-8 text-2xl text-black dark:text-white">
|
<h3 class="mt-8 text-2xl text-black dark:text-white">
|
||||||
Indexing Options
|
Indexing Options
|
||||||
</h3>
|
</h3>
|
||||||
|
|
||||||
<.input
|
<section x-data="{ fastIndexingEnabled: null }">
|
||||||
field={f[:index_frequency_minutes]}
|
|
||||||
options={friendly_index_frequencies()}
|
|
||||||
type="select"
|
|
||||||
label="Index Frequency"
|
|
||||||
help="Time between one index of this source finishing and the next one starting. Setting to 'On Create' will still run an initial index but no subsequent ones"
|
|
||||||
/>
|
|
||||||
|
|
||||||
<%!-- TODO: use Alpine to disable the index frequency when fast indexing is enabled --%>
|
|
||||||
<div phx-click={show_modal("upgrade-modal")}>
|
|
||||||
<.input
|
<.input
|
||||||
field={f[:fast_index]}
|
field={f[:index_frequency_minutes]}
|
||||||
type="toggle"
|
options={friendly_index_frequencies()}
|
||||||
label="Use Fast Indexing?"
|
type="select"
|
||||||
label_suffix="(pro)"
|
label="Index Frequency"
|
||||||
help="Experimental. Ignores 'Index Frequency'. Recommended for large channels that upload frequently. See below for more info"
|
x-bind:disabled="fastIndexingEnabled == true"
|
||||||
|
x-init="$watch('fastIndexingEnabled', v => v && ($el.value = 30 * 24 * 60))"
|
||||||
|
help="Indexing is the process of checking for media to download. Sets the time between one index of this source finishing and the next one starting"
|
||||||
/>
|
/>
|
||||||
</div>
|
|
||||||
|
<div phx-click={show_modal("upgrade-modal")}>
|
||||||
|
<.input
|
||||||
|
field={f[:fast_index]}
|
||||||
|
type="toggle"
|
||||||
|
label="Use Fast Indexing"
|
||||||
|
label_suffix="(pro)"
|
||||||
|
help="Experimental. Overrides 'Index Frequency'. Recommended for large channels that upload frequently. See below for more info"
|
||||||
|
x-init="
|
||||||
|
// `enabled` is the data attribute that the toggle uses internally
|
||||||
|
fastIndexingEnabled = enabled
|
||||||
|
$watch('enabled', value => fastIndexingEnabled = !!value)
|
||||||
|
"
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
|
||||||
<h3 class="mt-8 text-2xl text-black dark:text-white">
|
<h3 class="mt-8 text-2xl text-black dark:text-white">
|
||||||
Downloading Options
|
Downloading Options
|
||||||
@@ -53,7 +73,7 @@
|
|||||||
<.input
|
<.input
|
||||||
field={f[:download_media]}
|
field={f[:download_media]}
|
||||||
type="toggle"
|
type="toggle"
|
||||||
label="Download Media?"
|
label="Download Media"
|
||||||
help="Unchecking still indexes media but it won't be downloaded until you enable this option"
|
help="Unchecking still indexes media but it won't be downloaded until you enable this option"
|
||||||
/>
|
/>
|
||||||
|
|
||||||
@@ -62,10 +82,30 @@
|
|||||||
type="text"
|
type="text"
|
||||||
label="Download Cutoff Date"
|
label="Download Cutoff Date"
|
||||||
placeholder="YYYY-MM-DD"
|
placeholder="YYYY-MM-DD"
|
||||||
|
maxlength="10"
|
||||||
|
pattern="((?:19|20)[0-9][0-9])-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])"
|
||||||
|
title="YYYY-MM-DD"
|
||||||
help="Only download media uploaded after this date. Leave blank to download all media. Must be in YYYY-MM-DD format"
|
help="Only download media uploaded after this date. Leave blank to download all media. Must be in YYYY-MM-DD format"
|
||||||
/>
|
/>
|
||||||
|
|
||||||
<.button class="my-10 sm:mb-7.5 w-full sm:w-auto">Save Source</.button>
|
<section x-show="advancedMode">
|
||||||
|
<h3 class="mt-8 text-2xl text-black dark:text-white">
|
||||||
|
Advanced Options
|
||||||
|
</h3>
|
||||||
|
<p class="text-sm mt-2">
|
||||||
|
Tread carefully
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<.input
|
||||||
|
field={f[:title_filter_regex]}
|
||||||
|
type="text"
|
||||||
|
label="Title Filter Regex"
|
||||||
|
placeholder="(?i)^How to Bike$"
|
||||||
|
help="A PCRE-compatible regex. Only media with titles that match this regex will be downloaded. Look up 'SQLean Regex docs' for more"
|
||||||
|
/>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<.button class="my-10 sm:mb-7.5 w-full sm:w-auto" rounding="rounded-lg">Save Source</.button>
|
||||||
|
|
||||||
<div class="rounded-sm dark:bg-meta-4 p-4 md:p-6 mb-5">
|
<div class="rounded-sm dark:bg-meta-4 p-4 md:p-6 mb-5">
|
||||||
<.fast_indexing_help />
|
<.fast_indexing_help />
|
||||||
|
|||||||
@@ -47,5 +47,54 @@ defmodule PinchflatWeb.Endpoint do
|
|||||||
plug Plug.MethodOverride
|
plug Plug.MethodOverride
|
||||||
plug Plug.Head
|
plug Plug.Head
|
||||||
plug Plug.Session, @session_options
|
plug Plug.Session, @session_options
|
||||||
|
|
||||||
|
plug :override_base_url
|
||||||
|
plug :strip_trailing_extension
|
||||||
|
|
||||||
plug PinchflatWeb.Router
|
plug PinchflatWeb.Router
|
||||||
|
|
||||||
|
# URLs need to be generated using the host of the current page being accessed
|
||||||
|
# for things like Podcast RSS feeds to contain links to the right location.
|
||||||
|
#
|
||||||
|
# Normally you'd set the `url` option in the Endpoint configuration, but
|
||||||
|
# since this is self-hosted and often accessed at multiple different URLs,
|
||||||
|
# that would probably be more difficult for end-users to set up than just
|
||||||
|
# having the application figure it out.
|
||||||
|
defp override_base_url(conn, _opts) do
|
||||||
|
new_scheme =
|
||||||
|
case get_req_header(conn, "x-forwarded-proto") do
|
||||||
|
[scheme] -> scheme
|
||||||
|
_ -> to_string(conn.scheme)
|
||||||
|
end
|
||||||
|
|
||||||
|
new_port = if conn.port in [80, 443], do: "", else: ":#{conn.port}"
|
||||||
|
new_base_url = "#{new_scheme}://#{conn.host}#{new_port}"
|
||||||
|
|
||||||
|
Phoenix.Controller.put_router_url(conn, new_base_url)
|
||||||
|
end
|
||||||
|
|
||||||
|
defp strip_trailing_extension(%{path_info: []} = conn, _opts), do: conn
|
||||||
|
|
||||||
|
defp strip_trailing_extension(conn, _opts) do
|
||||||
|
path =
|
||||||
|
conn.path_info
|
||||||
|
|> List.last()
|
||||||
|
|> String.split(".")
|
||||||
|
|> Enum.reverse()
|
||||||
|
|
||||||
|
case path do
|
||||||
|
[_] ->
|
||||||
|
conn
|
||||||
|
|
||||||
|
[_format | fragments] ->
|
||||||
|
new_path =
|
||||||
|
fragments
|
||||||
|
|> Enum.reverse()
|
||||||
|
|> Enum.join(".")
|
||||||
|
|
||||||
|
path_fragments = List.replace_at(conn.path_info, -1, new_path)
|
||||||
|
|
||||||
|
%{conn | path_info: path_fragments}
|
||||||
|
end
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
+33
-16
@@ -1,6 +1,9 @@
|
|||||||
defmodule PinchflatWeb.Router do
|
defmodule PinchflatWeb.Router do
|
||||||
use PinchflatWeb, :router
|
use PinchflatWeb, :router
|
||||||
|
import Phoenix.LiveDashboard.Router
|
||||||
|
|
||||||
|
# IMPORTANT: `strip_trailing_extension` in endpoint.ex removes
|
||||||
|
# the extension from the path
|
||||||
pipeline :browser do
|
pipeline :browser do
|
||||||
plug :basic_auth
|
plug :basic_auth
|
||||||
plug :accepts, ["html"]
|
plug :accepts, ["html"]
|
||||||
@@ -9,12 +12,17 @@ defmodule PinchflatWeb.Router do
|
|||||||
plug :put_root_layout, html: {PinchflatWeb.Layouts, :root}
|
plug :put_root_layout, html: {PinchflatWeb.Layouts, :root}
|
||||||
plug :protect_from_forgery
|
plug :protect_from_forgery
|
||||||
plug :put_secure_browser_headers
|
plug :put_secure_browser_headers
|
||||||
|
plug :allow_iframe_embed
|
||||||
end
|
end
|
||||||
|
|
||||||
pipeline :api do
|
pipeline :api do
|
||||||
plug :accepts, ["json"]
|
plug :accepts, ["json"]
|
||||||
end
|
end
|
||||||
|
|
||||||
|
pipeline :feeds do
|
||||||
|
plug :maybe_basic_auth
|
||||||
|
end
|
||||||
|
|
||||||
scope "/", PinchflatWeb do
|
scope "/", PinchflatWeb do
|
||||||
pipe_through :browser
|
pipe_through :browser
|
||||||
|
|
||||||
@@ -28,25 +36,30 @@ defmodule PinchflatWeb.Router do
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Other scopes may use custom stacks.
|
# Routes in here _may not be_ protected by basic auth. This is necessary for
|
||||||
# scope "/api", PinchflatWeb do
|
# media streaming to work for RSS podcast feeds.
|
||||||
# pipe_through :api
|
scope "/", PinchflatWeb do
|
||||||
# end
|
pipe_through :feeds
|
||||||
|
|
||||||
# Enable LiveDashboard and Swoosh mailbox preview in development
|
get "/sources/:uuid/feed", Podcasts.PodcastController, :rss_feed
|
||||||
if Application.compile_env(:pinchflat, :dev_routes) do
|
get "/sources/:uuid/feed_image", Podcasts.PodcastController, :feed_image
|
||||||
# If you want to use the LiveDashboard in production, you should put
|
|
||||||
# it behind authentication and allow only admins to access it.
|
|
||||||
# If your application does not have an admins-only section yet,
|
|
||||||
# you can use Plug.BasicAuth to set up some basic authentication
|
|
||||||
# as long as you are also using SSL (which you should anyway).
|
|
||||||
import Phoenix.LiveDashboard.Router
|
|
||||||
|
|
||||||
scope "/dev" do
|
get "/media/:uuid/stream", MediaItems.MediaItemController, :stream
|
||||||
pipe_through :browser
|
end
|
||||||
|
|
||||||
live_dashboard "/dashboard", metrics: PinchflatWeb.Telemetry
|
scope "/dev" do
|
||||||
forward "/mailbox", Plug.Swoosh.MailboxPreview
|
pipe_through :browser
|
||||||
|
|
||||||
|
live_dashboard "/dashboard",
|
||||||
|
metrics: PinchflatWeb.Telemetry,
|
||||||
|
ecto_repos: [Pinchflat.Repo]
|
||||||
|
end
|
||||||
|
|
||||||
|
defp maybe_basic_auth(conn, opts) do
|
||||||
|
if Application.get_env(:pinchflat, :expose_feed_endpoints) do
|
||||||
|
conn
|
||||||
|
else
|
||||||
|
basic_auth(conn, opts)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -64,4 +77,8 @@ defmodule PinchflatWeb.Router do
|
|||||||
defp credential_set?(credential) do
|
defp credential_set?(credential) do
|
||||||
credential && credential != ""
|
credential && credential != ""
|
||||||
end
|
end
|
||||||
|
|
||||||
|
defp allow_iframe_embed(conn, _opts) do
|
||||||
|
delete_resp_header(conn, "x-frame-options")
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ defmodule Pinchflat.MixProject do
|
|||||||
def project do
|
def project do
|
||||||
[
|
[
|
||||||
app: :pinchflat,
|
app: :pinchflat,
|
||||||
version: "0.1.0-alpha.1",
|
version: "0.1.6",
|
||||||
elixir: "~> 1.16",
|
elixir: "~> 1.16",
|
||||||
elixirc_paths: elixirc_paths(Mix.env()),
|
elixirc_paths: elixirc_paths(Mix.env()),
|
||||||
start_permanent: Mix.env() == :prod,
|
start_permanent: Mix.env() == :prod,
|
||||||
@@ -13,6 +13,16 @@ defmodule Pinchflat.MixProject do
|
|||||||
preferred_cli_env: [
|
preferred_cli_env: [
|
||||||
check: :test,
|
check: :test,
|
||||||
credo: :test
|
credo: :test
|
||||||
|
],
|
||||||
|
test_coverage: [
|
||||||
|
ignore_modules: [
|
||||||
|
Pinchflat.HTTP.HTTPClient,
|
||||||
|
PinchflatWeb.Layouts,
|
||||||
|
Pinchflat.DataCase,
|
||||||
|
Pinchflat.Release,
|
||||||
|
~r/Fixtures/,
|
||||||
|
~r/HTML$/
|
||||||
|
]
|
||||||
]
|
]
|
||||||
]
|
]
|
||||||
end
|
end
|
||||||
@@ -23,7 +33,7 @@ defmodule Pinchflat.MixProject do
|
|||||||
def application do
|
def application do
|
||||||
[
|
[
|
||||||
mod: {Pinchflat.Application, []},
|
mod: {Pinchflat.Application, []},
|
||||||
extra_applications: [:logger, :runtime_tools, :inets]
|
extra_applications: [:logger, :runtime_tools, :inets, :os_mon]
|
||||||
]
|
]
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -40,6 +50,7 @@ defmodule Pinchflat.MixProject do
|
|||||||
{:phoenix_ecto, "~> 4.4"},
|
{:phoenix_ecto, "~> 4.4"},
|
||||||
{:ecto_sql, "~> 3.10"},
|
{:ecto_sql, "~> 3.10"},
|
||||||
{:ecto_sqlite3, ">= 0.0.0"},
|
{:ecto_sqlite3, ">= 0.0.0"},
|
||||||
|
{:ecto_sqlite3_extras, "~> 1.2.0"},
|
||||||
{:phoenix_html, "~> 3.3"},
|
{:phoenix_html, "~> 3.3"},
|
||||||
{:phoenix_live_reload, "~> 1.2", only: :dev},
|
{:phoenix_live_reload, "~> 1.2", only: :dev},
|
||||||
{:phoenix_live_view, "~> 0.20.1"},
|
{:phoenix_live_view, "~> 0.20.1"},
|
||||||
@@ -59,6 +70,7 @@ defmodule Pinchflat.MixProject do
|
|||||||
{:nimble_parsec, "~> 1.4"},
|
{:nimble_parsec, "~> 1.4"},
|
||||||
{:mox, "~> 1.0", only: :test},
|
{:mox, "~> 1.0", only: :test},
|
||||||
{:credo, "~> 1.7", only: [:dev, :test], runtime: false},
|
{:credo, "~> 1.7", only: [:dev, :test], runtime: false},
|
||||||
|
{:credo_naming, "~> 2.1", only: [:dev, :test], runtime: false},
|
||||||
{:ex_check, "~> 0.14.0", only: [:dev, :test], runtime: false},
|
{:ex_check, "~> 0.14.0", only: [:dev, :test], runtime: false},
|
||||||
{:faker, "~> 0.17", only: :test},
|
{:faker, "~> 0.17", only: :test},
|
||||||
{:sobelow, "~> 0.13", only: [:dev, :test], runtime: false}
|
{:sobelow, "~> 0.13", only: [:dev, :test], runtime: false}
|
||||||
|
|||||||
@@ -6,12 +6,14 @@
|
|||||||
"cowboy_telemetry": {:hex, :cowboy_telemetry, "0.4.0", "f239f68b588efa7707abce16a84d0d2acf3a0f50571f8bb7f56a15865aae820c", [:rebar3], [{:cowboy, "~> 2.7", [hex: :cowboy, repo: "hexpm", optional: false]}, {:telemetry, "~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "7d98bac1ee4565d31b62d59f8823dfd8356a169e7fcbb83831b8a5397404c9de"},
|
"cowboy_telemetry": {:hex, :cowboy_telemetry, "0.4.0", "f239f68b588efa7707abce16a84d0d2acf3a0f50571f8bb7f56a15865aae820c", [:rebar3], [{:cowboy, "~> 2.7", [hex: :cowboy, repo: "hexpm", optional: false]}, {:telemetry, "~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "7d98bac1ee4565d31b62d59f8823dfd8356a169e7fcbb83831b8a5397404c9de"},
|
||||||
"cowlib": {:hex, :cowlib, "2.12.1", "a9fa9a625f1d2025fe6b462cb865881329b5caff8f1854d1cbc9f9533f00e1e1", [:make, :rebar3], [], "hexpm", "163b73f6367a7341b33c794c4e88e7dbfe6498ac42dcd69ef44c5bc5507c8db0"},
|
"cowlib": {:hex, :cowlib, "2.12.1", "a9fa9a625f1d2025fe6b462cb865881329b5caff8f1854d1cbc9f9533f00e1e1", [:make, :rebar3], [], "hexpm", "163b73f6367a7341b33c794c4e88e7dbfe6498ac42dcd69ef44c5bc5507c8db0"},
|
||||||
"credo": {:hex, :credo, "1.7.3", "05bb11eaf2f2b8db370ecaa6a6bda2ec49b2acd5e0418bc106b73b07128c0436", [:mix], [{:bunt, "~> 0.2.1 or ~> 1.0", [hex: :bunt, repo: "hexpm", optional: false]}, {:file_system, "~> 0.2 or ~> 1.0", [hex: :file_system, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "35ea675a094c934c22fb1dca3696f3c31f2728ae6ef5a53b5d648c11180a4535"},
|
"credo": {:hex, :credo, "1.7.3", "05bb11eaf2f2b8db370ecaa6a6bda2ec49b2acd5e0418bc106b73b07128c0436", [:mix], [{:bunt, "~> 0.2.1 or ~> 1.0", [hex: :bunt, repo: "hexpm", optional: false]}, {:file_system, "~> 0.2 or ~> 1.0", [hex: :file_system, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "35ea675a094c934c22fb1dca3696f3c31f2728ae6ef5a53b5d648c11180a4535"},
|
||||||
|
"credo_naming": {:hex, :credo_naming, "2.1.0", "d44ad58890d4db552e141ce64756a74ac1573665af766d1ac64931aa90d47744", [:make, :mix], [{:credo, "~> 1.6", [hex: :credo, repo: "hexpm", optional: false]}], "hexpm", "830e23b3fba972e2fccec49c0c089fe78c1e64bc16782a2682d78082351a2909"},
|
||||||
"db_connection": {:hex, :db_connection, "2.6.0", "77d835c472b5b67fc4f29556dee74bf511bbafecdcaf98c27d27fa5918152086", [:mix], [{:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "c2f992d15725e721ec7fbc1189d4ecdb8afef76648c746a8e1cad35e3b8a35f3"},
|
"db_connection": {:hex, :db_connection, "2.6.0", "77d835c472b5b67fc4f29556dee74bf511bbafecdcaf98c27d27fa5918152086", [:mix], [{:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "c2f992d15725e721ec7fbc1189d4ecdb8afef76648c746a8e1cad35e3b8a35f3"},
|
||||||
"decimal": {:hex, :decimal, "2.1.1", "5611dca5d4b2c3dd497dec8f68751f1f1a54755e8ed2a966c2633cf885973ad6", [:mix], [], "hexpm", "53cfe5f497ed0e7771ae1a475575603d77425099ba5faef9394932b35020ffcc"},
|
"decimal": {:hex, :decimal, "2.1.1", "5611dca5d4b2c3dd497dec8f68751f1f1a54755e8ed2a966c2633cf885973ad6", [:mix], [], "hexpm", "53cfe5f497ed0e7771ae1a475575603d77425099ba5faef9394932b35020ffcc"},
|
||||||
"dns_cluster": {:hex, :dns_cluster, "0.1.2", "3eb5be824c7888dadf9781018e1a5f1d3d1113b333c50bce90fb1b83df1015f2", [:mix], [], "hexpm", "7494272040f847637bbdb01bcdf4b871e82daf09b813e7d3cb3b84f112c6f2f8"},
|
"dns_cluster": {:hex, :dns_cluster, "0.1.2", "3eb5be824c7888dadf9781018e1a5f1d3d1113b333c50bce90fb1b83df1015f2", [:mix], [], "hexpm", "7494272040f847637bbdb01bcdf4b871e82daf09b813e7d3cb3b84f112c6f2f8"},
|
||||||
"ecto": {:hex, :ecto, "3.11.1", "4b4972b717e7ca83d30121b12998f5fcdc62ba0ed4f20fd390f16f3270d85c3e", [:mix], [{:decimal, "~> 2.0", [hex: :decimal, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}, {:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "ebd3d3772cd0dfcd8d772659e41ed527c28b2a8bde4b00fe03e0463da0f1983b"},
|
"ecto": {:hex, :ecto, "3.11.1", "4b4972b717e7ca83d30121b12998f5fcdc62ba0ed4f20fd390f16f3270d85c3e", [:mix], [{:decimal, "~> 2.0", [hex: :decimal, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}, {:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "ebd3d3772cd0dfcd8d772659e41ed527c28b2a8bde4b00fe03e0463da0f1983b"},
|
||||||
"ecto_sql": {:hex, :ecto_sql, "3.11.1", "e9abf28ae27ef3916b43545f9578b4750956ccea444853606472089e7d169470", [:mix], [{:db_connection, "~> 2.4.1 or ~> 2.5", [hex: :db_connection, repo: "hexpm", optional: false]}, {:ecto, "~> 3.11.0", [hex: :ecto, repo: "hexpm", optional: false]}, {:myxql, "~> 0.6.0", [hex: :myxql, repo: "hexpm", optional: true]}, {:postgrex, "~> 0.16.0 or ~> 0.17.0 or ~> 1.0", [hex: :postgrex, repo: "hexpm", optional: true]}, {:tds, "~> 2.1.1 or ~> 2.2", [hex: :tds, repo: "hexpm", optional: true]}, {:telemetry, "~> 0.4.0 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "ce14063ab3514424276e7e360108ad6c2308f6d88164a076aac8a387e1fea634"},
|
"ecto_sql": {:hex, :ecto_sql, "3.11.1", "e9abf28ae27ef3916b43545f9578b4750956ccea444853606472089e7d169470", [:mix], [{:db_connection, "~> 2.4.1 or ~> 2.5", [hex: :db_connection, repo: "hexpm", optional: false]}, {:ecto, "~> 3.11.0", [hex: :ecto, repo: "hexpm", optional: false]}, {:myxql, "~> 0.6.0", [hex: :myxql, repo: "hexpm", optional: true]}, {:postgrex, "~> 0.16.0 or ~> 0.17.0 or ~> 1.0", [hex: :postgrex, repo: "hexpm", optional: true]}, {:tds, "~> 2.1.1 or ~> 2.2", [hex: :tds, repo: "hexpm", optional: true]}, {:telemetry, "~> 0.4.0 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "ce14063ab3514424276e7e360108ad6c2308f6d88164a076aac8a387e1fea634"},
|
||||||
"ecto_sqlite3": {:hex, :ecto_sqlite3, "0.15.1", "40f2fbd9e246455f8c42e7e0a77009ef806caa1b3ce6f717b2a0a80e8432fcfd", [:mix], [{:decimal, "~> 1.6 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: false]}, {:ecto, "~> 3.11", [hex: :ecto, repo: "hexpm", optional: false]}, {:ecto_sql, "~> 3.11", [hex: :ecto_sql, repo: "hexpm", optional: false]}, {:exqlite, "~> 0.19", [hex: :exqlite, repo: "hexpm", optional: false]}], "hexpm", "28b16e177123c688948357176662bf9ff9084daddf950ef5b6baf3ee93707064"},
|
"ecto_sqlite3": {:hex, :ecto_sqlite3, "0.15.1", "40f2fbd9e246455f8c42e7e0a77009ef806caa1b3ce6f717b2a0a80e8432fcfd", [:mix], [{:decimal, "~> 1.6 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: false]}, {:ecto, "~> 3.11", [hex: :ecto, repo: "hexpm", optional: false]}, {:ecto_sql, "~> 3.11", [hex: :ecto_sql, repo: "hexpm", optional: false]}, {:exqlite, "~> 0.19", [hex: :exqlite, repo: "hexpm", optional: false]}], "hexpm", "28b16e177123c688948357176662bf9ff9084daddf950ef5b6baf3ee93707064"},
|
||||||
|
"ecto_sqlite3_extras": {:hex, :ecto_sqlite3_extras, "1.2.2", "36e60b561a11441d15f26c791817999269fb578b985162207ebb08b04ca71e40", [:mix], [{:exqlite, ">= 0.13.2", [hex: :exqlite, repo: "hexpm", optional: false]}, {:table_rex, "~> 4.0", [hex: :table_rex, repo: "hexpm", optional: false]}], "hexpm", "2b66ba7246bb4f7e39e2578acd4a0e4e4be54f60ff52d450a01be95eeb78ff1e"},
|
||||||
"elixir_make": {:hex, :elixir_make, "0.7.8", "505026f266552ee5aabca0b9f9c229cbb496c689537c9f922f3eb5431157efc7", [:mix], [{:castore, "~> 0.1 or ~> 1.0", [hex: :castore, repo: "hexpm", optional: true]}, {:certifi, "~> 2.0", [hex: :certifi, repo: "hexpm", optional: true]}], "hexpm", "7a71945b913d37ea89b06966e1342c85cfe549b15e6d6d081e8081c493062c07"},
|
"elixir_make": {:hex, :elixir_make, "0.7.8", "505026f266552ee5aabca0b9f9c229cbb496c689537c9f922f3eb5431157efc7", [:mix], [{:castore, "~> 0.1 or ~> 1.0", [hex: :castore, repo: "hexpm", optional: true]}, {:certifi, "~> 2.0", [hex: :certifi, repo: "hexpm", optional: true]}], "hexpm", "7a71945b913d37ea89b06966e1342c85cfe549b15e6d6d081e8081c493062c07"},
|
||||||
"esbuild": {:hex, :esbuild, "0.8.1", "0cbf919f0eccb136d2eeef0df49c4acf55336de864e63594adcea3814f3edf41", [:mix], [{:castore, ">= 0.0.0", [hex: :castore, repo: "hexpm", optional: false]}, {:jason, "~> 1.4", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "25fc876a67c13cb0a776e7b5d7974851556baeda2085296c14ab48555ea7560f"},
|
"esbuild": {:hex, :esbuild, "0.8.1", "0cbf919f0eccb136d2eeef0df49c4acf55336de864e63594adcea3814f3edf41", [:mix], [{:castore, ">= 0.0.0", [hex: :castore, repo: "hexpm", optional: false]}, {:jason, "~> 1.4", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "25fc876a67c13cb0a776e7b5d7974851556baeda2085296c14ab48555ea7560f"},
|
||||||
"ex_check": {:hex, :ex_check, "0.14.0", "d6fbe0bcc51cf38fea276f5bc2af0c9ae0a2bb059f602f8de88709421dae4f0e", [:mix], [], "hexpm", "8a602e98c66e6a4be3a639321f1f545292042f290f91fa942a285888c6868af0"},
|
"ex_check": {:hex, :ex_check, "0.14.0", "d6fbe0bcc51cf38fea276f5bc2af0c9ae0a2bb059f602f8de88709421dae4f0e", [:mix], [], "hexpm", "8a602e98c66e6a4be3a639321f1f545292042f290f91fa942a285888c6868af0"},
|
||||||
@@ -45,6 +47,7 @@
|
|||||||
"ranch": {:hex, :ranch, "1.8.0", "8c7a100a139fd57f17327b6413e4167ac559fbc04ca7448e9be9057311597a1d", [:make, :rebar3], [], "hexpm", "49fbcfd3682fab1f5d109351b61257676da1a2fdbe295904176d5e521a2ddfe5"},
|
"ranch": {:hex, :ranch, "1.8.0", "8c7a100a139fd57f17327b6413e4167ac559fbc04ca7448e9be9057311597a1d", [:make, :rebar3], [], "hexpm", "49fbcfd3682fab1f5d109351b61257676da1a2fdbe295904176d5e521a2ddfe5"},
|
||||||
"sobelow": {:hex, :sobelow, "0.13.0", "218afe9075904793f5c64b8837cc356e493d88fddde126a463839351870b8d1e", [:mix], [{:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "cd6e9026b85fc35d7529da14f95e85a078d9dd1907a9097b3ba6ac7ebbe34a0d"},
|
"sobelow": {:hex, :sobelow, "0.13.0", "218afe9075904793f5c64b8837cc356e493d88fddde126a463839351870b8d1e", [:mix], [{:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "cd6e9026b85fc35d7529da14f95e85a078d9dd1907a9097b3ba6ac7ebbe34a0d"},
|
||||||
"swoosh": {:hex, :swoosh, "1.14.4", "94e9dba91f7695a10f49b0172c4a4cb658ef24abef7e8140394521b7f3bbb2d4", [:mix], [{:cowboy, "~> 1.1 or ~> 2.4", [hex: :cowboy, repo: "hexpm", optional: true]}, {:ex_aws, "~> 2.1", [hex: :ex_aws, repo: "hexpm", optional: true]}, {:finch, "~> 0.6", [hex: :finch, repo: "hexpm", optional: true]}, {:gen_smtp, "~> 0.13 or ~> 1.0", [hex: :gen_smtp, repo: "hexpm", optional: true]}, {:hackney, "~> 1.9", [hex: :hackney, repo: "hexpm", optional: true]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}, {:mail, "~> 0.2", [hex: :mail, repo: "hexpm", optional: true]}, {:mime, "~> 1.1 or ~> 2.0", [hex: :mime, repo: "hexpm", optional: false]}, {:plug, "~> 1.9", [hex: :plug, repo: "hexpm", optional: true]}, {:plug_cowboy, ">= 1.0.0", [hex: :plug_cowboy, repo: "hexpm", optional: true]}, {:req, "~> 0.4 or ~> 1.0", [hex: :req, repo: "hexpm", optional: true]}, {:telemetry, "~> 0.4.2 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "081c5a590e4ba85cc89baddf7b2beecf6c13f7f84a958f1cd969290815f0f026"},
|
"swoosh": {:hex, :swoosh, "1.14.4", "94e9dba91f7695a10f49b0172c4a4cb658ef24abef7e8140394521b7f3bbb2d4", [:mix], [{:cowboy, "~> 1.1 or ~> 2.4", [hex: :cowboy, repo: "hexpm", optional: true]}, {:ex_aws, "~> 2.1", [hex: :ex_aws, repo: "hexpm", optional: true]}, {:finch, "~> 0.6", [hex: :finch, repo: "hexpm", optional: true]}, {:gen_smtp, "~> 0.13 or ~> 1.0", [hex: :gen_smtp, repo: "hexpm", optional: true]}, {:hackney, "~> 1.9", [hex: :hackney, repo: "hexpm", optional: true]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}, {:mail, "~> 0.2", [hex: :mail, repo: "hexpm", optional: true]}, {:mime, "~> 1.1 or ~> 2.0", [hex: :mime, repo: "hexpm", optional: false]}, {:plug, "~> 1.9", [hex: :plug, repo: "hexpm", optional: true]}, {:plug_cowboy, ">= 1.0.0", [hex: :plug_cowboy, repo: "hexpm", optional: true]}, {:req, "~> 0.4 or ~> 1.0", [hex: :req, repo: "hexpm", optional: true]}, {:telemetry, "~> 0.4.2 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "081c5a590e4ba85cc89baddf7b2beecf6c13f7f84a958f1cd969290815f0f026"},
|
||||||
|
"table_rex": {:hex, :table_rex, "4.0.0", "3c613a68ebdc6d4d1e731bc973c233500974ec3993c99fcdabb210407b90959b", [:mix], [], "hexpm", "c35c4d5612ca49ebb0344ea10387da4d2afe278387d4019e4d8111e815df8f55"},
|
||||||
"tailwind": {:hex, :tailwind, "0.2.2", "9e27288b568ede1d88517e8c61259bc214a12d7eed271e102db4c93fcca9b2cd", [:mix], [{:castore, ">= 0.0.0", [hex: :castore, repo: "hexpm", optional: false]}], "hexpm", "ccfb5025179ea307f7f899d1bb3905cd0ac9f687ed77feebc8f67bdca78565c4"},
|
"tailwind": {:hex, :tailwind, "0.2.2", "9e27288b568ede1d88517e8c61259bc214a12d7eed271e102db4c93fcca9b2cd", [:mix], [{:castore, ">= 0.0.0", [hex: :castore, repo: "hexpm", optional: false]}], "hexpm", "ccfb5025179ea307f7f899d1bb3905cd0ac9f687ed77feebc8f67bdca78565c4"},
|
||||||
"telemetry": {:hex, :telemetry, "1.2.1", "68fdfe8d8f05a8428483a97d7aab2f268aaff24b49e0f599faa091f1d4e7f61c", [:rebar3], [], "hexpm", "dad9ce9d8effc621708f99eac538ef1cbe05d6a874dd741de2e689c47feafed5"},
|
"telemetry": {:hex, :telemetry, "1.2.1", "68fdfe8d8f05a8428483a97d7aab2f268aaff24b49e0f599faa091f1d4e7f61c", [:rebar3], [], "hexpm", "dad9ce9d8effc621708f99eac538ef1cbe05d6a874dd741de2e689c47feafed5"},
|
||||||
"telemetry_metrics": {:hex, :telemetry_metrics, "0.6.2", "2caabe9344ec17eafe5403304771c3539f3b6e2f7fb6a6f602558c825d0d0bfb", [:mix], [{:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "9b43db0dc33863930b9ef9d27137e78974756f5f198cae18409970ed6fa5b561"},
|
"telemetry_metrics": {:hex, :telemetry_metrics, "0.6.2", "2caabe9344ec17eafe5403304771c3539f3b6e2f7fb6a6f602558c825d0d0bfb", [:mix], [{:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "9b43db0dc33863930b9ef9d27137e78974756f5f198cae18409970ed6fa5b561"},
|
||||||
|
|||||||
BIN
Binary file not shown.
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user