3 Commits
Author SHA1 Message Date
dtourolle 9ac32e11b5 Added a post-download hook for applying processing of downloaded audio before adding to library.
🏗️ Build Plugin / build (push) Successful in 2m4s
🧪 Test Plugin / test (push) Successful in 58s
🚀 Release Plugin / build-and-release (push) Successful in 2m1s
2025-12-21 13:59:42 +01:00
Gitea Actions bc24b40bf2 Update manifest.json for version 1.0.0 2025-12-20 13:00:27 +00:00
dtourolle 4537613ed7 Added manifest and pipelines to allow install via web ui.
🏗️ Build Plugin / build (push) Successful in 2m10s
🧪 Test Plugin / test (push) Successful in 1m0s
🚀 Release Plugin / build-and-release (push) Successful in 2m2s
2025-12-20 13:55:06 +01:00
6 changed files with 405 additions and 12 deletions
+54 -1
View File
@@ -70,7 +70,15 @@ jobs:
echo "artifact_name=${ARTIFACT_NAME}" >> $GITHUB_OUTPUT echo "artifact_name=${ARTIFACT_NAME}" >> $GITHUB_OUTPUT
echo "Found artifact: ${ARTIFACT}" echo "Found artifact: ${ARTIFACT}"
- name: Calculate checksum
id: checksum
run: |
CHECKSUM=$(md5sum "${{ steps.jprm.outputs.artifact }}" | awk '{print $1}')
echo "checksum=${CHECKSUM}" >> $GITHUB_OUTPUT
echo "MD5 Checksum: ${CHECKSUM}"
- name: Create Release - name: Create Release
id: create_release
env: env:
GITEA_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITEA_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: | run: |
@@ -80,7 +88,7 @@ jobs:
GITEA_URL="${{ github.server_url }}" GITEA_URL="${{ github.server_url }}"
# Prepare release body # Prepare release body
RELEASE_BODY="Jellypod Jellyfin Plugin ${{ steps.get_version.outputs.version }}\n\nSee attached files for plugin installation." RELEASE_BODY="Jellypod Jellyfin Plugin ${{ steps.get_version.outputs.version }}\n\nSee attached files for plugin installation.\n\nTo install, add this repository URL to Jellyfin:\n\`${GITEA_URL}/${REPO_OWNER}/${REPO_NAME}/raw/branch/master/manifest.json\`"
RELEASE_BODY_JSON=$(echo -n "${RELEASE_BODY}" | jq -Rs .) RELEASE_BODY_JSON=$(echo -n "${RELEASE_BODY}" | jq -Rs .)
# Create release using Gitea API # Create release using Gitea API
@@ -101,6 +109,7 @@ jobs:
if [ "$HTTP_CODE" -ge 200 ] && [ "$HTTP_CODE" -lt 300 ]; then if [ "$HTTP_CODE" -ge 200 ] && [ "$HTTP_CODE" -lt 300 ]; then
RELEASE_ID=$(echo "$BODY" | jq -r '.id') RELEASE_ID=$(echo "$BODY" | jq -r '.id')
echo "release_id=${RELEASE_ID}" >> $GITHUB_OUTPUT
echo "Created release with ID: ${RELEASE_ID}" echo "Created release with ID: ${RELEASE_ID}"
else else
echo "Failed to create release. HTTP ${HTTP_CODE}" echo "Failed to create release. HTTP ${HTTP_CODE}"
@@ -126,3 +135,47 @@ jobs:
echo "Release created successfully!" echo "Release created successfully!"
echo "View at: ${GITEA_URL}/${REPO_OWNER}/${REPO_NAME}/releases/tag/${{ steps.get_version.outputs.version }}" echo "View at: ${GITEA_URL}/${REPO_OWNER}/${REPO_NAME}/releases/tag/${{ steps.get_version.outputs.version }}"
- name: Update manifest.json
env:
GITEA_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
REPO_OWNER="${{ github.repository_owner }}"
REPO_NAME="${{ github.event.repository.name }}"
GITEA_URL="${{ github.server_url }}"
VERSION="${{ steps.get_version.outputs.version_number }}"
CHECKSUM="${{ steps.checksum.outputs.checksum }}"
ARTIFACT_NAME="${{ steps.jprm.outputs.artifact_name }}"
TIMESTAMP=$(date -u +"%Y-%m-%dT%H:%M:%SZ")
DOWNLOAD_URL="${GITEA_URL}/${REPO_OWNER}/${REPO_NAME}/releases/download/${{ steps.get_version.outputs.version }}/${ARTIFACT_NAME}"
# Configure git
git config user.name "Gitea Actions"
git config user.email "actions@gitea.tourolle.paris"
# Fetch and checkout master branch
git fetch origin master
git checkout master
# Create new version entry
NEW_VERSION=$(cat <<EOF
{
"version": "${VERSION}",
"changelog": "Release ${VERSION}",
"targetAbi": "10.9.0.0",
"sourceUrl": "${DOWNLOAD_URL}",
"checksum": "${CHECKSUM}",
"timestamp": "${TIMESTAMP}"
}
EOF
)
# Update manifest.json - prepend new version to versions array
jq --argjson newver "${NEW_VERSION}" '.[0].versions = [$newver] + .[0].versions' manifest.json > manifest.tmp && mv manifest.tmp manifest.json
# Commit and push
git add manifest.json
git commit -m "Update manifest.json for version ${VERSION}"
git push origin master
echo "Manifest updated successfully!"
@@ -19,6 +19,8 @@ public class PluginConfiguration : BasePluginConfiguration
MaxEpisodesPerPodcast = 50; MaxEpisodesPerPodcast = 50;
CreatePodcastFolders = true; CreatePodcastFolders = true;
DownloadNewEpisodesOnly = true; DownloadNewEpisodesOnly = true;
PostDownloadScriptPath = string.Empty;
PostDownloadScriptTimeout = 60;
} }
/// <summary> /// <summary>
@@ -56,4 +58,15 @@ public class PluginConfiguration : BasePluginConfiguration
/// Gets or sets a value indicating whether to only download new episodes after subscription. /// Gets or sets a value indicating whether to only download new episodes after subscription.
/// </summary> /// </summary>
public bool DownloadNewEpisodesOnly { get; set; } public bool DownloadNewEpisodesOnly { get; set; }
/// <summary>
/// Gets or sets the path to post-download processing script.
/// Script is called with: script input_file output_file.
/// </summary>
public string PostDownloadScriptPath { get; set; }
/// <summary>
/// Gets or sets the timeout in seconds for post-download script execution.
/// </summary>
public int PostDownloadScriptTimeout { get; set; }
} }
@@ -166,6 +166,29 @@
</div> </div>
</div> </div>
<!-- Post-Download Processing -->
<div class="verticalSection">
<h3 class="sectionTitle">Post-Download Processing</h3>
<div class="inputContainer">
<label class="inputLabel inputLabelUnfocused" for="PostDownloadScriptPath">
Post-Download Script Path
</label>
<input id="PostDownloadScriptPath" name="PostDownloadScriptPath" type="text" is="emby-input" />
<div class="fieldDescription">
Optional script to process episodes after download. Called as: script input_file output_file
</div>
</div>
<div class="inputContainer">
<label class="inputLabel inputLabelUnfocused" for="PostDownloadScriptTimeout">
Script Timeout (seconds)
</label>
<input id="PostDownloadScriptTimeout" name="PostDownloadScriptTimeout" type="number" is="emby-input" min="1" max="3600" />
<div class="fieldDescription">
Maximum time to wait for script completion (default: 60 seconds)
</div>
</div>
</div>
<div> <div>
<button is="emby-button" type="submit" class="raised button-submit block emby-button"> <button is="emby-button" type="submit" class="raised button-submit block emby-button">
<span>Save Settings</span> <span>Save Settings</span>
@@ -229,6 +252,8 @@
document.querySelector('#MaxConcurrentDownloads').value = config.MaxConcurrentDownloads; document.querySelector('#MaxConcurrentDownloads').value = config.MaxConcurrentDownloads;
document.querySelector('#MaxEpisodesPerPodcast').value = config.MaxEpisodesPerPodcast; document.querySelector('#MaxEpisodesPerPodcast').value = config.MaxEpisodesPerPodcast;
document.querySelector('#CreatePodcastFolders').checked = config.CreatePodcastFolders; document.querySelector('#CreatePodcastFolders').checked = config.CreatePodcastFolders;
document.querySelector('#PostDownloadScriptPath').value = config.PostDownloadScriptPath || '';
document.querySelector('#PostDownloadScriptTimeout').value = config.PostDownloadScriptTimeout || 60;
Dashboard.hideLoadingMsg(); Dashboard.hideLoadingMsg();
}); });
} }
@@ -408,6 +433,8 @@
config.MaxConcurrentDownloads = parseInt(document.querySelector('#MaxConcurrentDownloads').value, 10); config.MaxConcurrentDownloads = parseInt(document.querySelector('#MaxConcurrentDownloads').value, 10);
config.MaxEpisodesPerPodcast = parseInt(document.querySelector('#MaxEpisodesPerPodcast').value, 10); config.MaxEpisodesPerPodcast = parseInt(document.querySelector('#MaxEpisodesPerPodcast').value, 10);
config.CreatePodcastFolders = document.querySelector('#CreatePodcastFolders').checked; config.CreatePodcastFolders = document.querySelector('#CreatePodcastFolders').checked;
config.PostDownloadScriptPath = document.querySelector('#PostDownloadScriptPath').value;
config.PostDownloadScriptTimeout = parseInt(document.querySelector('#PostDownloadScriptTimeout').value, 10);
ApiClient.updatePluginConfiguration(JellypodConfig.pluginUniqueId, config).then(function (result) { ApiClient.updatePluginConfiguration(JellypodConfig.pluginUniqueId, config).then(function (result) {
Dashboard.processPluginConfigurationUpdateResult(result); Dashboard.processPluginConfigurationUpdateResult(result);
}); });
@@ -1,8 +1,10 @@
using System; using System;
using System.Collections.Concurrent; using System.Collections.Concurrent;
using System.Diagnostics;
using System.IO; using System.IO;
using System.Linq; using System.Linq;
using System.Net.Http; using System.Net.Http;
using System.Text;
using System.Threading; using System.Threading;
using System.Threading.Tasks; using System.Threading.Tasks;
using Jellyfin.Plugin.Jellypod.Models; using Jellyfin.Plugin.Jellypod.Models;
@@ -63,15 +65,27 @@ public sealed class PodcastDownloadService : IPodcastDownloadService, IDisposabl
IProgress<double>? progress = null, IProgress<double>? progress = null,
CancellationToken cancellationToken = default) CancellationToken cancellationToken = default)
{ {
var filePath = _storageService.GetEpisodeFilePath(podcast, episode); var finalPath = _storageService.GetEpisodeFilePath(podcast, episode);
var directory = Path.GetDirectoryName(filePath); var finalDirectory = Path.GetDirectoryName(finalPath);
if (!string.IsNullOrEmpty(directory)) if (!string.IsNullOrEmpty(finalDirectory))
{ {
Directory.CreateDirectory(directory); Directory.CreateDirectory(finalDirectory);
} }
_logger.LogInformation("Downloading episode: {Title} to {Path}", episode.Title, filePath); // Determine if we should use temp directory for post-processing
var config = Plugin.Instance?.Configuration;
var usePostProcessing = !string.IsNullOrWhiteSpace(config?.PostDownloadScriptPath);
// Use temp directory if post-processing is enabled, otherwise download directly to final location
var downloadPath = usePostProcessing
? Path.Combine(Path.GetTempPath(), "jellypod-" + Path.GetRandomFileName() + Path.GetExtension(finalPath))
: finalPath;
_logger.LogInformation("Downloading episode: {Title} to {Path}", episode.Title, downloadPath);
string? tempInputFile = null;
string? tempOutputFile = null;
try try
{ {
@@ -91,7 +105,7 @@ public sealed class PodcastDownloadService : IPodcastDownloadService, IDisposabl
long totalRead; long totalRead;
try try
{ {
var fileStream = new FileStream(filePath, FileMode.Create, FileAccess.Write, FileShare.None, 81920, true); var fileStream = new FileStream(downloadPath, FileMode.Create, FileAccess.Write, FileShare.None, 81920, true);
try try
{ {
var buffer = new byte[81920]; var buffer = new byte[81920];
@@ -119,17 +133,51 @@ public sealed class PodcastDownloadService : IPodcastDownloadService, IDisposabl
await contentStream.DisposeAsync().ConfigureAwait(false); await contentStream.DisposeAsync().ConfigureAwait(false);
} }
episode.LocalFilePath = filePath; _logger.LogInformation("Downloaded episode: {Title} ({Size} bytes)", episode.Title, totalRead);
// Post-processing if configured
string sourceFile = downloadPath;
if (usePostProcessing)
{
tempInputFile = downloadPath;
tempOutputFile = Path.Combine(
Path.GetTempPath(),
"jellypod-output-" + Path.GetRandomFileName() + Path.GetExtension(finalPath));
var scriptTimeout = config?.PostDownloadScriptTimeout ?? 60;
var processedFile = await ExecutePostDownloadScriptAsync(
tempInputFile,
tempOutputFile,
scriptTimeout,
cancellationToken).ConfigureAwait(false);
if (processedFile != null)
{
_logger.LogInformation("Using processed file from post-download script");
sourceFile = processedFile;
}
else
{
_logger.LogInformation("Using original file (script failed, timed out, or not configured)");
sourceFile = tempInputFile;
}
// Copy the selected file to final destination
File.Copy(sourceFile, finalPath, overwrite: true);
_logger.LogInformation("Copied episode to final location: {Path}", finalPath);
}
// Get final file size
var finalFileInfo = new FileInfo(finalPath);
episode.LocalFilePath = finalPath;
episode.Status = EpisodeStatus.Downloaded; episode.Status = EpisodeStatus.Downloaded;
episode.DownloadedDate = DateTime.UtcNow; episode.DownloadedDate = DateTime.UtcNow;
episode.FileSizeBytes = totalRead; episode.FileSizeBytes = finalFileInfo.Length;
_logger.LogInformation("Downloaded episode: {Title} ({Size} bytes)", episode.Title, totalRead);
// Update the podcast in storage // Update the podcast in storage
await _storageService.UpdatePodcastAsync(podcast).ConfigureAwait(false); await _storageService.UpdatePodcastAsync(podcast).ConfigureAwait(false);
return filePath; return finalPath;
} }
catch (Exception ex) catch (Exception ex)
{ {
@@ -137,6 +185,35 @@ public sealed class PodcastDownloadService : IPodcastDownloadService, IDisposabl
_logger.LogError(ex, "Failed to download episode: {Title}", episode.Title); _logger.LogError(ex, "Failed to download episode: {Title}", episode.Title);
throw; throw;
} }
finally
{
// Clean up temp files
if (tempInputFile != null && File.Exists(tempInputFile))
{
try
{
File.Delete(tempInputFile);
_logger.LogDebug("Cleaned up temp input file: {Path}", tempInputFile);
}
catch (Exception ex)
{
_logger.LogWarning(ex, "Failed to delete temp input file: {Path}", tempInputFile);
}
}
if (tempOutputFile != null && File.Exists(tempOutputFile))
{
try
{
File.Delete(tempOutputFile);
_logger.LogDebug("Cleaned up temp output file: {Path}", tempOutputFile);
}
catch (Exception ex)
{
_logger.LogWarning(ex, "Failed to delete temp output file: {Path}", tempOutputFile);
}
}
}
} }
/// <inheritdoc /> /// <inheritdoc />
@@ -240,6 +317,136 @@ public sealed class PodcastDownloadService : IPodcastDownloadService, IDisposabl
return result.Length > 100 ? result.Substring(0, 100).Trim() : result.Trim(); return result.Length > 100 ? result.Substring(0, 100).Trim() : result.Trim();
} }
/// <summary>
/// Executes the post-download script if configured.
/// </summary>
/// <param name="inputFilePath">Path to the downloaded file.</param>
/// <param name="outputFilePath">Path where the script should write the processed file.</param>
/// <param name="timeoutSeconds">Timeout in seconds.</param>
/// <param name="cancellationToken">Cancellation token.</param>
/// <returns>The output file path if successful, null if failed/timeout.</returns>
private async Task<string?> ExecutePostDownloadScriptAsync(
string inputFilePath,
string outputFilePath,
int timeoutSeconds,
CancellationToken cancellationToken)
{
var config = Plugin.Instance?.Configuration;
var scriptPath = config?.PostDownloadScriptPath;
if (string.IsNullOrWhiteSpace(scriptPath))
{
return null;
}
if (!File.Exists(scriptPath))
{
_logger.LogError("Post-download script not found at path: {ScriptPath}", scriptPath);
return null;
}
try
{
_logger.LogDebug(
"Executing post-download script: {ScriptPath} {InputFile} {OutputFile}",
scriptPath,
inputFilePath,
outputFilePath);
var processStartInfo = new ProcessStartInfo
{
FileName = scriptPath,
Arguments = $"\"{inputFilePath}\" \"{outputFilePath}\"",
RedirectStandardOutput = true,
RedirectStandardError = true,
UseShellExecute = false,
CreateNoWindow = true
};
using var process = new Process { StartInfo = processStartInfo };
var stdoutBuilder = new StringBuilder();
var stderrBuilder = new StringBuilder();
process.OutputDataReceived += (sender, e) =>
{
if (e.Data != null)
{
stdoutBuilder.AppendLine(e.Data);
}
};
process.ErrorDataReceived += (sender, e) =>
{
if (e.Data != null)
{
stderrBuilder.AppendLine(e.Data);
}
};
process.Start();
process.BeginOutputReadLine();
process.BeginErrorReadLine();
// Create a timeout cancellation token
using var timeoutCts = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken);
timeoutCts.CancelAfter(TimeSpan.FromSeconds(timeoutSeconds));
try
{
await process.WaitForExitAsync(timeoutCts.Token).ConfigureAwait(false);
}
catch (OperationCanceledException)
{
if (!process.HasExited)
{
_logger.LogWarning(
"Post-download script timed out after {Timeout} seconds, killing process",
timeoutSeconds);
process.Kill(entireProcessTree: true);
}
return null;
}
var stdout = stdoutBuilder.ToString();
var stderr = stderrBuilder.ToString();
if (!string.IsNullOrWhiteSpace(stdout))
{
_logger.LogDebug("Script stdout: {Stdout}", stdout.Trim());
}
if (!string.IsNullOrWhiteSpace(stderr))
{
_logger.LogDebug("Script stderr: {Stderr}", stderr.Trim());
}
if (process.ExitCode != 0)
{
_logger.LogError(
"Post-download script failed with exit code {ExitCode}",
process.ExitCode);
return null;
}
if (!File.Exists(outputFilePath))
{
_logger.LogWarning(
"Post-download script succeeded but output file was not created: {OutputFile}",
outputFilePath);
return null;
}
_logger.LogInformation("Post-download script executed successfully");
return outputFilePath;
}
catch (Exception ex)
{
_logger.LogError(ex, "Failed to execute post-download script");
return null;
}
}
/// <inheritdoc /> /// <inheritdoc />
public void Dispose() public void Dispose()
{ {
+72
View File
@@ -2,11 +2,72 @@
A Jellyfin plugin that adds podcast support to your media server. A Jellyfin plugin that adds podcast support to your media server.
## Quick Install
Add this repository URL in Jellyfin (Dashboard → Plugins → Repositories):
```
https://gitea.tourolle.paris/dtourolle/jellypod/raw/branch/master/manifest.json
```
## Features ## Features
- Browse and subscribe to podcasts - Browse and subscribe to podcasts
- Automatic episode downloads - Automatic episode downloads
- Integration with Jellyfin's library system - Integration with Jellyfin's library system
- Post-download script hook for audio processing
## Post-Download Script Hook
Jellypod supports running a custom script on each downloaded episode before it's added to your library. This is useful for:
- Audio normalization (e.g., using ffmpeg-normalize)
- Format conversion
- Metadata enhancement
- Custom processing workflows
### Configuration
In the plugin settings (Dashboard → Plugins → Jellypod):
1. **Post-Download Script Path**: Full path to your script or executable
2. **Script Timeout**: Maximum execution time in seconds (default: 60)
### Script API
Your script will be called with two arguments:
```bash
script <input_file> <output_file>
```
- `input_file`: Path to the downloaded episode (read-only)
- `output_file`: Path where your script should write the processed file
### Example Scripts
**Audio normalization (bash + ffmpeg):**
```bash
#!/bin/bash
INPUT="$1"
OUTPUT="$2"
ffmpeg-normalize "$INPUT" -o "$OUTPUT" -c:a libmp3lame -b:a 128k
```
**Format conversion (bash + ffmpeg):**
```bash
#!/bin/bash
INPUT="$1"
OUTPUT="$2"
ffmpeg -i "$INPUT" -c:a aac -b:a 128k "$OUTPUT"
```
### Behavior
- If the script succeeds (exit code 0) and creates the output file, the processed file is added to your library
- If the script fails, times out, or doesn't create an output file, the original downloaded file is used instead
- All script output (stdout/stderr) is logged for debugging
- Leave the script path empty to disable post-processing
## Screenshots ## Screenshots
@@ -18,6 +79,17 @@ A Jellyfin plugin that adds podcast support to your media server.
## Installation ## Installation
### From Plugin Repository (Recommended)
1. In Jellyfin, go to **Dashboard****Plugins****Repositories**
2. Click the **+** button to add a new repository
3. Enter:
- **Repository Name**: `Jellypod`
- **Repository URL**: `https://gitea.tourolle.paris/dtourolle/jellypod/raw/branch/master/manifest.json`
4. Click **Save**
5. Go to **Catalog** tab and find **Jellypod**
6. Click **Install** and restart Jellyfin
### Manual Installation ### Manual Installation
1. Download the latest release from [Releases](https://gitea.tourolle.paris/dtourolle/jellypod/releases) 1. Download the latest release from [Releases](https://gitea.tourolle.paris/dtourolle/jellypod/releases)
+21
View File
@@ -0,0 +1,21 @@
[
{
"guid": "c713faf4-4e50-4e87-941a-1200178ed605",
"name": "Jellypod",
"description": "Jellypod allows you to subscribe to podcast RSS feeds, automatically download episodes, and manage your podcast library within Jellyfin. Episodes are stored as standard audio files and integrate with Jellyfin's built-in audio player.",
"overview": "Podcast management plugin for Jellyfin",
"owner": "dtourolle",
"category": "General",
"imageUrl": "https://gitea.tourolle.paris/dtourolle/jellypod/raw/branch/master/Jellyfin.Plugin.Jellypod/Images/channel-icon.jpg",
"versions": [
{
"version": "1.0.0",
"changelog": "Release 1.0.0",
"targetAbi": "10.9.0.0",
"sourceUrl": "https://gitea.tourolle.paris/dtourolle/jellypod/releases/download/v1.0.0/jellypod_1.0.0.0.zip",
"checksum": "3267fa2bee3661f9a85c959497fe20dd",
"timestamp": "2025-12-20T13:00:27Z"
}
]
}
]