Initial commit
Publish Release / publish (push) Failing after 2m2s
Details
Publish Release / publish (push) Failing after 2m2s
Details
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
commit
3cff856fce
|
|
@ -0,0 +1,75 @@
|
||||||
|
name: Publish Release
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags:
|
||||||
|
- 'v*'
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
publish:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- uses: actions/setup-dotnet@v4
|
||||||
|
with:
|
||||||
|
dotnet-version: |
|
||||||
|
9.x
|
||||||
|
10.x
|
||||||
|
|
||||||
|
- name: Extract version
|
||||||
|
id: ver
|
||||||
|
run: |
|
||||||
|
RAW="${GITHUB_REF_NAME#v}"
|
||||||
|
PARTS=$(echo "$RAW" | tr '.' '\n' | wc -l)
|
||||||
|
if [ "$PARTS" -eq 3 ]; then RAW="${RAW}.0"; fi
|
||||||
|
echo "ver=$RAW" >> $GITHUB_OUTPUT
|
||||||
|
|
||||||
|
- name: Build net9.0
|
||||||
|
run: dotnet publish AutoBackup.csproj -c Release -f net9.0 --nologo
|
||||||
|
|
||||||
|
- name: Build net10.0
|
||||||
|
run: dotnet publish AutoBackup.csproj -c Release -f net10.0 --nologo
|
||||||
|
|
||||||
|
- name: Install jprm
|
||||||
|
run: pip install jprm
|
||||||
|
|
||||||
|
- name: Package artifacts
|
||||||
|
run: |
|
||||||
|
mkdir -p artifacts
|
||||||
|
VER="${{ steps.ver.outputs.ver }}"
|
||||||
|
|
||||||
|
cd publish/net9.0
|
||||||
|
zip -j "${GITHUB_WORKSPACE}/artifacts/autobackup_${VER}_net9.zip" \
|
||||||
|
Jellyfin.Plugin.AutoBackup.dll
|
||||||
|
cd "${GITHUB_WORKSPACE}"
|
||||||
|
|
||||||
|
cd publish/net10.0
|
||||||
|
zip -j "${GITHUB_WORKSPACE}/artifacts/autobackup_${VER}_net10.zip" \
|
||||||
|
Jellyfin.Plugin.AutoBackup.dll
|
||||||
|
cd "${GITHUB_WORKSPACE}"
|
||||||
|
|
||||||
|
- name: Update manifest.json
|
||||||
|
run: |
|
||||||
|
jprm repo add \
|
||||||
|
--url="${{ github.server_url }}/${{ github.repository }}/releases/download/${{ github.ref_name }}/" \
|
||||||
|
manifest.json \
|
||||||
|
artifacts/*.zip
|
||||||
|
|
||||||
|
- name: Commit manifest.json
|
||||||
|
run: |
|
||||||
|
git config user.name "gitea-actions"
|
||||||
|
git config user.email "actions@noreply.local"
|
||||||
|
git add manifest.json
|
||||||
|
git diff --staged --quiet || git commit -m "chore: update manifest for ${{ github.ref_name }}"
|
||||||
|
git push origin HEAD:${{ github.event.repository.default_branch }}
|
||||||
|
|
||||||
|
- name: Create release
|
||||||
|
uses: softprops/action-gh-release@v2
|
||||||
|
with:
|
||||||
|
files: artifacts/*.zip
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
|
@ -0,0 +1,5 @@
|
||||||
|
bin/
|
||||||
|
obj/
|
||||||
|
publish/
|
||||||
|
.vs/
|
||||||
|
*.user
|
||||||
|
|
@ -0,0 +1,40 @@
|
||||||
|
<Project Sdk="Microsoft.NET.Sdk">
|
||||||
|
|
||||||
|
<PropertyGroup>
|
||||||
|
<TargetFrameworks>net9.0;net10.0</TargetFrameworks>
|
||||||
|
<Nullable>enable</Nullable>
|
||||||
|
<ImplicitUsings>enable</ImplicitUsings>
|
||||||
|
<AssemblyName>Jellyfin.Plugin.AutoBackup</AssemblyName>
|
||||||
|
<RootNamespace>Jellyfin.Plugin.AutoBackup</RootNamespace>
|
||||||
|
<GenerateDocumentationFile>false</GenerateDocumentationFile>
|
||||||
|
<CopyLocalLockFileAssemblies>false</CopyLocalLockFileAssemblies>
|
||||||
|
<PublishDir>$(MSBuildProjectDirectory)\publish\$(TargetFramework)</PublishDir>
|
||||||
|
</PropertyGroup>
|
||||||
|
|
||||||
|
<ItemGroup>
|
||||||
|
<FrameworkReference Include="Microsoft.AspNetCore.App" />
|
||||||
|
</ItemGroup>
|
||||||
|
|
||||||
|
<!-- Jellyfin v10 (net9.0) -->
|
||||||
|
<ItemGroup Condition="'$(TargetFramework)' == 'net9.0'">
|
||||||
|
<PackageReference Include="Jellyfin.Common" Version="10.11.*" ExcludeAssets="runtime" />
|
||||||
|
<PackageReference Include="Jellyfin.Controller" Version="10.11.*" ExcludeAssets="runtime" />
|
||||||
|
<PackageReference Include="Jellyfin.Model" Version="10.11.*" ExcludeAssets="runtime" />
|
||||||
|
<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="9.*" ExcludeAssets="runtime" />
|
||||||
|
</ItemGroup>
|
||||||
|
|
||||||
|
<!-- Jellyfin v12 (net10.0) -->
|
||||||
|
<ItemGroup Condition="'$(TargetFramework)' == 'net10.0'">
|
||||||
|
<PackageReference Include="Jellyfin.Common" Version="12.*-*" ExcludeAssets="runtime" />
|
||||||
|
<PackageReference Include="Jellyfin.Controller" Version="12.*-*" ExcludeAssets="runtime" />
|
||||||
|
<PackageReference Include="Jellyfin.Model" Version="12.*-*" ExcludeAssets="runtime" />
|
||||||
|
<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="10.*" ExcludeAssets="runtime" />
|
||||||
|
</ItemGroup>
|
||||||
|
|
||||||
|
<ItemGroup>
|
||||||
|
<EmbeddedResource Include="Pages\config.html" />
|
||||||
|
<EmbeddedResource Include="Localization\en-US.json" />
|
||||||
|
<EmbeddedResource Include="Localization\de-DE.json" />
|
||||||
|
</ItemGroup>
|
||||||
|
|
||||||
|
</Project>
|
||||||
|
|
@ -0,0 +1,3 @@
|
||||||
|
<Solution>
|
||||||
|
<Project Path="AutoBackup.csproj" />
|
||||||
|
</Solution>
|
||||||
|
|
@ -0,0 +1,39 @@
|
||||||
|
namespace Jellyfin.Plugin.AutoBackup.Configuration;
|
||||||
|
|
||||||
|
public class BackupScheduleConfig
|
||||||
|
{
|
||||||
|
public Guid Id { get; set; } = Guid.NewGuid();
|
||||||
|
public string Label { get; set; } = "Schedule";
|
||||||
|
public bool IsEnabled { get; set; } = true;
|
||||||
|
|
||||||
|
public bool BackupDatabase { get; set; } = true;
|
||||||
|
public bool BackupMetadata { get; set; } = false;
|
||||||
|
public bool BackupSubtitles { get; set; } = false;
|
||||||
|
public bool BackupTrickplay { get; set; } = false;
|
||||||
|
|
||||||
|
public ScheduleType ScheduleType { get; set; } = ScheduleType.Daily;
|
||||||
|
|
||||||
|
/// <summary>Used when ScheduleType is EveryNHours.</summary>
|
||||||
|
public int IntervalHours { get; set; } = 24;
|
||||||
|
|
||||||
|
/// <summary>Used when ScheduleType is EveryNWeeks.</summary>
|
||||||
|
public int IntervalWeeks { get; set; } = 1;
|
||||||
|
|
||||||
|
/// <summary>Used when ScheduleType is Weekly, EveryNWeeks, or MonthlyOnWeekday.</summary>
|
||||||
|
public DayOfWeek WeekDay { get; set; } = DayOfWeek.Sunday;
|
||||||
|
|
||||||
|
/// <summary>Used when ScheduleType is MonthlyOnDay (1–28).</summary>
|
||||||
|
public int DayOfMonth { get; set; } = 1;
|
||||||
|
|
||||||
|
/// <summary>Used when ScheduleType is MonthlyOnWeekday.</summary>
|
||||||
|
public WeekOfMonth WeekOfMonth { get; set; } = WeekOfMonth.First;
|
||||||
|
|
||||||
|
/// <summary>Hour of day (0–23) for the trigger.</summary>
|
||||||
|
public int TriggerHour { get; set; } = 2;
|
||||||
|
|
||||||
|
/// <summary>Minute of hour — only 0, 15, 30 or 45 are valid (matches 15-min master task tick).</summary>
|
||||||
|
public int TriggerMinute { get; set; } = 0;
|
||||||
|
|
||||||
|
/// <summary>Persisted after each successful run to calculate next due time.</summary>
|
||||||
|
public DateTime LastRunUtc { get; set; } = DateTime.MinValue;
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,10 @@
|
||||||
|
using MediaBrowser.Model.Plugins;
|
||||||
|
|
||||||
|
namespace Jellyfin.Plugin.AutoBackup.Configuration;
|
||||||
|
|
||||||
|
public class PluginConfiguration : BasePluginConfiguration
|
||||||
|
{
|
||||||
|
public bool IsInitialized { get; set; } = false;
|
||||||
|
public List<BackupScheduleConfig> Schedules { get; set; } = [];
|
||||||
|
public List<RetentionRule> RetentionRules { get; set; } = [];
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,10 @@
|
||||||
|
namespace Jellyfin.Plugin.AutoBackup.Configuration;
|
||||||
|
|
||||||
|
public class RetentionRule
|
||||||
|
{
|
||||||
|
public bool BackupDatabase { get; set; } = true;
|
||||||
|
public bool BackupMetadata { get; set; } = false;
|
||||||
|
public bool BackupSubtitles { get; set; } = false;
|
||||||
|
public bool BackupTrickplay { get; set; } = false;
|
||||||
|
public int KeepLastN { get; set; } = 7;
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,20 @@
|
||||||
|
namespace Jellyfin.Plugin.AutoBackup.Configuration;
|
||||||
|
|
||||||
|
public enum ScheduleType
|
||||||
|
{
|
||||||
|
EveryNHours,
|
||||||
|
Daily,
|
||||||
|
Weekly,
|
||||||
|
EveryNWeeks,
|
||||||
|
MonthlyOnDay,
|
||||||
|
MonthlyOnWeekday,
|
||||||
|
}
|
||||||
|
|
||||||
|
public enum WeekOfMonth
|
||||||
|
{
|
||||||
|
First = 1,
|
||||||
|
Second = 2,
|
||||||
|
Third = 3,
|
||||||
|
Fourth = 4,
|
||||||
|
Last = -1,
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,37 @@
|
||||||
|
using MediaBrowser.Common.Configuration;
|
||||||
|
using Microsoft.AspNetCore.Authorization;
|
||||||
|
using Microsoft.AspNetCore.Mvc;
|
||||||
|
using Microsoft.Extensions.Logging;
|
||||||
|
|
||||||
|
namespace Jellyfin.Plugin.AutoBackup.Controllers;
|
||||||
|
|
||||||
|
[ApiController]
|
||||||
|
[Authorize(Policy = "RequiresElevation")]
|
||||||
|
[Route("AutoBackup")]
|
||||||
|
public class BackupManagementController : ControllerBase
|
||||||
|
{
|
||||||
|
private readonly IApplicationPaths _appPaths;
|
||||||
|
private readonly ILogger<BackupManagementController> _logger;
|
||||||
|
|
||||||
|
public BackupManagementController(IApplicationPaths appPaths, ILoggerFactory loggerFactory)
|
||||||
|
{
|
||||||
|
_appPaths = appPaths;
|
||||||
|
_logger = loggerFactory.CreateLogger<BackupManagementController>();
|
||||||
|
}
|
||||||
|
|
||||||
|
[HttpDelete("Backup/{filename}")]
|
||||||
|
public IActionResult DeleteBackup([FromRoute] string filename)
|
||||||
|
{
|
||||||
|
// Only allow jellyfin-backup-*.zip filenames — no path traversal
|
||||||
|
if (!System.Text.RegularExpressions.Regex.IsMatch(filename, @"^jellyfin-backup-[\w\-]+\.zip$"))
|
||||||
|
return BadRequest("Invalid filename.");
|
||||||
|
|
||||||
|
var path = Path.Combine(_appPaths.DataPath, "backups", filename);
|
||||||
|
if (!System.IO.File.Exists(path))
|
||||||
|
return NotFound();
|
||||||
|
|
||||||
|
System.IO.File.Delete(path);
|
||||||
|
_logger.LogInformation("[AutoBackup] Deleted backup: {File}", path);
|
||||||
|
return NoContent();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,674 @@
|
||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||||
|
|
@ -0,0 +1,36 @@
|
||||||
|
{
|
||||||
|
"ScheduledBackup.Title": "Geplante Sicherung",
|
||||||
|
"ScheduledBackup.AddSchedule": "Zeitplan hinzufügen",
|
||||||
|
"ScheduledBackup.Save": "Einstellungen speichern",
|
||||||
|
"ScheduledBackup.Remove": "Entfernen",
|
||||||
|
"ScheduledBackup.Enabled": "Aktiviert",
|
||||||
|
"ScheduledBackup.Label": "Bezeichnung",
|
||||||
|
"ScheduledBackup.BackupOptions": "Was sichern",
|
||||||
|
"ScheduledBackup.Database": "Datenbank (library.db)",
|
||||||
|
"ScheduledBackup.Metadata": "Metadaten",
|
||||||
|
"ScheduledBackup.Subtitles": "Untertitel",
|
||||||
|
"ScheduledBackup.Trickplay": "Trickplay",
|
||||||
|
"ScheduledBackup.ScheduleType": "Zeitplantyp",
|
||||||
|
"ScheduledBackup.ScheduleType.EveryNHours": "Alle N Stunden",
|
||||||
|
"ScheduledBackup.ScheduleType.Daily": "Täglich",
|
||||||
|
"ScheduledBackup.ScheduleType.Weekly": "Wöchentlich",
|
||||||
|
"ScheduledBackup.ScheduleType.EveryNWeeks": "Alle N Wochen",
|
||||||
|
"ScheduledBackup.ScheduleType.MonthlyOnDay": "Monatlich (fester Tag)",
|
||||||
|
"ScheduledBackup.ScheduleType.MonthlyOnWeekday": "Monatlich (Wochentag)",
|
||||||
|
"ScheduledBackup.IntervalHours": "Alle (Stunden)",
|
||||||
|
"ScheduledBackup.IntervalWeeks": "Alle (Wochen)",
|
||||||
|
"ScheduledBackup.WeekDay": "Wochentag",
|
||||||
|
"ScheduledBackup.DayOfMonth": "Tag des Monats (1–28)",
|
||||||
|
"ScheduledBackup.WeekOfMonth": "Welcher Wochentag",
|
||||||
|
"ScheduledBackup.WeekOfMonth.First": "1.",
|
||||||
|
"ScheduledBackup.WeekOfMonth.Second": "2.",
|
||||||
|
"ScheduledBackup.WeekOfMonth.Third": "3.",
|
||||||
|
"ScheduledBackup.WeekOfMonth.Fourth": "4.",
|
||||||
|
"ScheduledBackup.WeekOfMonth.Last": "Letzter",
|
||||||
|
"ScheduledBackup.TriggerHour": "Um Stunde (0–23)",
|
||||||
|
"ScheduledBackup.TriggerMinute": "Um Minute",
|
||||||
|
"ScheduledBackup.BackupDirectory": "Sicherungsverzeichnis (leer = Standard)",
|
||||||
|
"ScheduledBackup.KeepLastN": "Letzte N Sicherungen behalten (0 = unbegrenzt)",
|
||||||
|
"ScheduledBackup.Saved": "Einstellungen gespeichert.",
|
||||||
|
"ScheduledBackup.Note.TriggerWarning": "Hinweis: Nach Änderungen an den Zeiteinstellungen bitte Jellyfin neu starten oder den Task einmal manuell auslösen."
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,36 @@
|
||||||
|
{
|
||||||
|
"ScheduledBackup.Title": "Scheduled Backup",
|
||||||
|
"ScheduledBackup.AddSchedule": "Add Schedule",
|
||||||
|
"ScheduledBackup.Save": "Save Settings",
|
||||||
|
"ScheduledBackup.Remove": "Remove",
|
||||||
|
"ScheduledBackup.Enabled": "Enabled",
|
||||||
|
"ScheduledBackup.Label": "Label",
|
||||||
|
"ScheduledBackup.BackupOptions": "What to back up",
|
||||||
|
"ScheduledBackup.Database": "Database (library.db)",
|
||||||
|
"ScheduledBackup.Metadata": "Metadata",
|
||||||
|
"ScheduledBackup.Subtitles": "Subtitles",
|
||||||
|
"ScheduledBackup.Trickplay": "Trickplay",
|
||||||
|
"ScheduledBackup.ScheduleType": "Schedule type",
|
||||||
|
"ScheduledBackup.ScheduleType.EveryNHours": "Every N hours",
|
||||||
|
"ScheduledBackup.ScheduleType.Daily": "Daily",
|
||||||
|
"ScheduledBackup.ScheduleType.Weekly": "Weekly",
|
||||||
|
"ScheduledBackup.ScheduleType.EveryNWeeks": "Every N weeks",
|
||||||
|
"ScheduledBackup.ScheduleType.MonthlyOnDay": "Monthly (fixed day)",
|
||||||
|
"ScheduledBackup.ScheduleType.MonthlyOnWeekday": "Monthly (weekday)",
|
||||||
|
"ScheduledBackup.IntervalHours": "Every (hours)",
|
||||||
|
"ScheduledBackup.IntervalWeeks": "Every (weeks)",
|
||||||
|
"ScheduledBackup.WeekDay": "Day of week",
|
||||||
|
"ScheduledBackup.DayOfMonth": "Day of month (1–28)",
|
||||||
|
"ScheduledBackup.WeekOfMonth": "Which occurrence",
|
||||||
|
"ScheduledBackup.WeekOfMonth.First": "1st",
|
||||||
|
"ScheduledBackup.WeekOfMonth.Second": "2nd",
|
||||||
|
"ScheduledBackup.WeekOfMonth.Third": "3rd",
|
||||||
|
"ScheduledBackup.WeekOfMonth.Fourth": "4th",
|
||||||
|
"ScheduledBackup.WeekOfMonth.Last": "Last",
|
||||||
|
"ScheduledBackup.TriggerHour": "At hour (0–23)",
|
||||||
|
"ScheduledBackup.TriggerMinute": "At minute",
|
||||||
|
"ScheduledBackup.BackupDirectory": "Backup directory (blank = default)",
|
||||||
|
"ScheduledBackup.KeepLastN": "Keep last N backups (0 = unlimited)",
|
||||||
|
"ScheduledBackup.Saved": "Settings saved.",
|
||||||
|
"ScheduledBackup.Note.TriggerWarning": "Note: After changing timing settings, restart Jellyfin or manually trigger the task once to reset the schedule."
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,565 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
<head><meta charset="utf-8"><title>Auto Backup</title></head>
|
||||||
|
<body>
|
||||||
|
<div data-role="page" class="page type-interior pluginConfigurationPage" data-url="AutoBackupConfigPage">
|
||||||
|
<div data-role="content">
|
||||||
|
<div class="content-primary">
|
||||||
|
|
||||||
|
<div class="verticalSection">
|
||||||
|
<h2 class="sectionTitle">Auto Backup</h2>
|
||||||
|
<p id="pg-desc" class="fieldDescription"></p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div style="display:flex;gap:4px;border-bottom:2px solid rgba(255,255,255,0.2);margin-bottom:16px;">
|
||||||
|
<button is="emby-button" type="button" id="tab-settings"></button>
|
||||||
|
<button is="emby-button" type="button" id="tab-retention"></button>
|
||||||
|
<button is="emby-button" type="button" id="tab-backups"></button>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="section-settings">
|
||||||
|
<div id="scheduleList"></div>
|
||||||
|
<div class="verticalSection" style="display:flex;gap:10px;flex-wrap:wrap;margin-top:8px;">
|
||||||
|
<button is="emby-button" type="button" id="btnAdd" class="raised emby-button"></button>
|
||||||
|
<button is="emby-button" type="submit" id="btnSave" class="raised button-submit emby-button"><span></span></button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="section-retention" style="display:none;">
|
||||||
|
<div id="retentionList" style="margin-top:4px;"></div>
|
||||||
|
<div style="display:flex;gap:10px;flex-wrap:wrap;margin-top:12px;">
|
||||||
|
<button is="emby-button" type="button" id="btnAddRetention" class="raised emby-button"></button>
|
||||||
|
<button is="emby-button" type="submit" id="btnSaveRetention" class="raised button-submit emby-button"><span></span></button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="section-backups" style="display:none;">
|
||||||
|
<div id="backupList" style="margin-top:12px;"></div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<script type="text/javascript">
|
||||||
|
(function () {
|
||||||
|
|
||||||
|
var PLUGIN_ID = '1175543c-6d20-4cfa-93a6-1476836df34c';
|
||||||
|
var _n = 0;
|
||||||
|
|
||||||
|
var TRANSLATIONS = {
|
||||||
|
en: {
|
||||||
|
desc: 'Backups are automatically executed at the configured times.',
|
||||||
|
enabled: 'Enabled',
|
||||||
|
labelField: 'Label',
|
||||||
|
database: 'Database',
|
||||||
|
metadata: 'Metadata',
|
||||||
|
subtitles: 'Subtitles',
|
||||||
|
trickplay: 'Trickplay',
|
||||||
|
scheduleType: 'Schedule type',
|
||||||
|
typeEveryNHours: 'Every N hours',
|
||||||
|
typeDaily: 'Daily',
|
||||||
|
typeWeekly: 'Weekly',
|
||||||
|
typeEveryNWeeks: 'Every N weeks',
|
||||||
|
typeMonthlyDay: 'Monthly (fixed day)',
|
||||||
|
typeMonthlyWeekday: 'Monthly (weekday)',
|
||||||
|
intervalHours: 'Every (hours)',
|
||||||
|
intervalWeeks: 'Every (weeks)',
|
||||||
|
dayOfMonth: 'Day of month (1–28)',
|
||||||
|
occurrence: 'Occurrence',
|
||||||
|
womFirst: '1st', womSecond: '2nd', womThird: '3rd', womFourth: '4th', womLast: 'Last',
|
||||||
|
dayOfWeek: 'Day of week',
|
||||||
|
atHour: 'At hour (0–23)',
|
||||||
|
atMinute: 'At minute',
|
||||||
|
keepLastN: 'Keep last N (0 = all)',
|
||||||
|
remove: 'Remove',
|
||||||
|
addSchedule: '+ Add Schedule',
|
||||||
|
save: 'Save Settings',
|
||||||
|
saved: 'Settings saved.',
|
||||||
|
errorSave: 'Error: ',
|
||||||
|
defaultLabel: 'New',
|
||||||
|
tabSettings: 'Settings',
|
||||||
|
tabRetention: 'Retention',
|
||||||
|
tabBackups: 'Backups',
|
||||||
|
retentionDesc: 'Define how many backups to keep per backup type combination.',
|
||||||
|
addRetention: '+ Add Rule',
|
||||||
|
noBackups: 'No backups found.',
|
||||||
|
backupCreated: 'Created',
|
||||||
|
deleteBackup: 'Delete',
|
||||||
|
confirmDelete: 'Delete this backup?',
|
||||||
|
badgeDatabase: 'Database', badgeMetadata: 'Metadata', badgeSubtitles: 'Subtitles', badgeTrickplay: 'Trickplay',
|
||||||
|
days: ['Sunday','Monday','Tuesday','Wednesday','Thursday','Friday','Saturday'],
|
||||||
|
daysShort: ['Sun','Mon','Tue','Wed','Thu','Fri','Sat'],
|
||||||
|
badgeEvery: 'Every', badgeDaily: 'Daily', badgeWeekly: 'Weekly', badgeMonthly: 'Monthly'
|
||||||
|
},
|
||||||
|
de: {
|
||||||
|
desc: 'Sicherungen werden automatisch zur gewünschten Zeit ausgeführt.',
|
||||||
|
enabled: 'Aktiviert',
|
||||||
|
labelField: 'Bezeichnung',
|
||||||
|
database: 'Datenbank',
|
||||||
|
metadata: 'Metadaten',
|
||||||
|
subtitles: 'Untertitel',
|
||||||
|
trickplay: 'Trickplay',
|
||||||
|
scheduleType: 'Zeitplantyp',
|
||||||
|
typeEveryNHours: 'Alle N Stunden',
|
||||||
|
typeDaily: 'Täglich',
|
||||||
|
typeWeekly: 'Wöchentlich',
|
||||||
|
typeEveryNWeeks: 'Alle N Wochen',
|
||||||
|
typeMonthlyDay: 'Monatlich (fester Tag)',
|
||||||
|
typeMonthlyWeekday: 'Monatlich (Wochentag)',
|
||||||
|
intervalHours: 'Alle (Stunden)',
|
||||||
|
intervalWeeks: 'Alle (Wochen)',
|
||||||
|
dayOfMonth: 'Tag des Monats (1–28)',
|
||||||
|
occurrence: 'Häufigkeit',
|
||||||
|
womFirst: '1.', womSecond: '2.', womThird: '3.', womFourth: '4.', womLast: 'Letzter',
|
||||||
|
dayOfWeek: 'Wochentag',
|
||||||
|
atHour: 'Um Stunde (0–23)',
|
||||||
|
atMinute: 'Um Minute',
|
||||||
|
keepLastN: 'Letzte N behalten (0 = alle)',
|
||||||
|
remove: 'Entfernen',
|
||||||
|
addSchedule: '+ Zeitplan hinzufügen',
|
||||||
|
save: 'Einstellungen speichern',
|
||||||
|
saved: 'Einstellungen gespeichert.',
|
||||||
|
errorSave: 'Fehler: ',
|
||||||
|
defaultLabel: 'Neu',
|
||||||
|
tabSettings: 'Einstellungen',
|
||||||
|
tabRetention: 'Aufbewahrung',
|
||||||
|
tabBackups: 'Sicherungen',
|
||||||
|
retentionDesc: 'Lege fest, wie viele Sicherungen pro Optionskombination behalten werden.',
|
||||||
|
addRetention: '+ Regel hinzufügen',
|
||||||
|
noBackups: 'Keine Sicherungen gefunden.',
|
||||||
|
backupCreated: 'Erstellt',
|
||||||
|
deleteBackup: 'Löschen',
|
||||||
|
confirmDelete: 'Diese Sicherung löschen?',
|
||||||
|
badgeDatabase: 'Datenbank', badgeMetadata: 'Metadaten', badgeSubtitles: 'Untertitel', badgeTrickplay: 'Trickplay',
|
||||||
|
days: ['Sonntag','Montag','Dienstag','Mittwoch','Donnerstag','Freitag','Samstag'],
|
||||||
|
daysShort: ['So','Mo','Di','Mi','Do','Fr','Sa'],
|
||||||
|
badgeEvery: 'Alle', badgeDaily: 'Täglich', badgeWeekly: 'Wöchentlich', badgeMonthly: 'Monatlich'
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
var T = TRANSLATIONS.en;
|
||||||
|
|
||||||
|
var TYPE_NAMES = ['EveryNHours','Daily','Weekly','EveryNWeeks','MonthlyOnDay','MonthlyOnWeekday'];
|
||||||
|
var MINS = [0,15,30,45];
|
||||||
|
|
||||||
|
// Jellyfin serializes enums as name strings — map back to numbers
|
||||||
|
var STYPE_MAP = {EveryNHours:0,Daily:1,Weekly:2,EveryNWeeks:3,MonthlyOnDay:4,MonthlyOnWeekday:5};
|
||||||
|
var WDAY_MAP = {Sunday:0,Monday:1,Tuesday:2,Wednesday:3,Thursday:4,Friday:5,Saturday:6};
|
||||||
|
var WOM_MAP = {First:1,Second:2,Third:3,Fourth:4,Last:-1};
|
||||||
|
|
||||||
|
function getTypes(){ return [{v:0,l:T.typeEveryNHours},{v:1,l:T.typeDaily},{v:2,l:T.typeWeekly},{v:3,l:T.typeEveryNWeeks},{v:4,l:T.typeMonthlyDay},{v:5,l:T.typeMonthlyWeekday}]; }
|
||||||
|
function getWOM() { return [{v:1,l:T.womFirst},{v:2,l:T.womSecond},{v:3,l:T.womThird},{v:4,l:T.womFourth},{v:-1,l:T.womLast}]; }
|
||||||
|
|
||||||
|
function applyStaticTranslations(){
|
||||||
|
document.getElementById('pg-desc').textContent = T.desc;
|
||||||
|
document.getElementById('btnAdd').textContent = T.addSchedule;
|
||||||
|
document.getElementById('btnAddRetention').textContent = T.addRetention;
|
||||||
|
document.getElementById('tab-settings').textContent = T.tabSettings;
|
||||||
|
document.getElementById('tab-retention').textContent = T.tabRetention;
|
||||||
|
document.getElementById('tab-backups').textContent = T.tabBackups;
|
||||||
|
var s = document.querySelector('#btnSave span'); if(s) s.textContent = T.save;
|
||||||
|
var r = document.querySelector('#btnSaveRetention span'); if(r) r.textContent = T.save;
|
||||||
|
}
|
||||||
|
|
||||||
|
var ACTIVE_STYLE = 'border:1px solid rgba(255,255,255,0.2);border-bottom:2px solid #101010;border-radius:4px 4px 0 0;margin-bottom:-2px;background:rgba(255,255,255,0.07);padding:6px 18px;font-weight:600;color:inherit;';
|
||||||
|
var INACTIVE_STYLE = 'border:1px solid transparent;border-radius:4px 4px 0 0;margin-bottom:-2px;background:transparent;padding:6px 18px;opacity:0.55;color:inherit;';
|
||||||
|
|
||||||
|
function switchTab(tab){
|
||||||
|
var tabs = ['settings','retention','backups'];
|
||||||
|
tabs.forEach(function(t){
|
||||||
|
document.getElementById('tab-'+t).style.cssText = t === tab ? ACTIVE_STYLE : INACTIVE_STYLE;
|
||||||
|
document.getElementById('section-'+t).style.display = t === tab ? '' : 'none';
|
||||||
|
});
|
||||||
|
if (tab === 'backups') loadBackups();
|
||||||
|
if (tab === 'retention') loadRetentionUi();
|
||||||
|
}
|
||||||
|
|
||||||
|
function loadBackups(){
|
||||||
|
var list = document.getElementById('backupList');
|
||||||
|
list.textContent = '';
|
||||||
|
ApiClient.getJSON(ApiClient.getUrl('/Backup')).then(function(backups){
|
||||||
|
if (!backups || backups.length === 0){
|
||||||
|
list.textContent = T.noBackups;
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
backups.sort(function(a,b){ return new Date(b.DateCreated) - new Date(a.DateCreated); });
|
||||||
|
backups.forEach(function(b){
|
||||||
|
var date = new Date(b.DateCreated).toLocaleString();
|
||||||
|
var name = (b.Path || '').replace(/\\/g,'/').split('/').pop();
|
||||||
|
var opts = b.Options || {};
|
||||||
|
var tags = [];
|
||||||
|
if(opts.Database) tags.push(T.badgeDatabase);
|
||||||
|
if(opts.Metadata) tags.push(T.badgeMetadata);
|
||||||
|
if(opts.Subtitles) tags.push(T.badgeSubtitles);
|
||||||
|
if(opts.Trickplay) tags.push(T.badgeTrickplay);
|
||||||
|
var tagsHtml = tags.map(function(t){
|
||||||
|
return '<span style="display:inline-block;padding:1px 8px;border-radius:3px;font-size:.75em;background:rgba(255,255,255,.12);margin-right:4px;">'+esc(t)+'</span>';
|
||||||
|
}).join('');
|
||||||
|
var row = document.createElement('div');
|
||||||
|
row.style.cssText = 'display:flex;align-items:center;gap:12px;padding:12px 16px;margin-bottom:8px;border:1px solid rgba(255,255,255,.15);border-radius:4px;';
|
||||||
|
row.innerHTML = '<div style="flex:1;min-width:0;">'
|
||||||
|
+'<div style="font-weight:600;">'+esc(date)+'</div>'
|
||||||
|
+'<div style="font-size:.8em;opacity:.6;margin-top:2px;overflow:hidden;text-overflow:ellipsis;white-space:nowrap;">'+esc(name)+'</div>'
|
||||||
|
+(tagsHtml ? '<div style="margin-top:5px;">'+tagsHtml+'</div>' : '')
|
||||||
|
+'</div>'
|
||||||
|
+'<button is="emby-button" type="button" style="flex-shrink:0;background:#e74c3c;color:#fff;border-radius:4px;padding:4px 14px;">'+esc(T.deleteBackup)+'</button>';
|
||||||
|
var btn = row.querySelector('button');
|
||||||
|
(function(r, n){
|
||||||
|
btn.addEventListener('click', function(){
|
||||||
|
if (!confirm(T.confirmDelete)) return;
|
||||||
|
ApiClient.ajax({ type: 'DELETE', url: ApiClient.getUrl('/AutoBackup/Backup/' + encodeURIComponent(n)) })
|
||||||
|
.then(function(){ r.parentNode && r.parentNode.removeChild(r); })
|
||||||
|
.catch(function(e){ Dashboard.alert(T.errorSave + e); });
|
||||||
|
});
|
||||||
|
})(row, name);
|
||||||
|
list.appendChild(row);
|
||||||
|
});
|
||||||
|
}).catch(function(){
|
||||||
|
list.textContent = T.noBackups;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// ── Retention tab ────────────────────────────────────────────────
|
||||||
|
var _retentionRules = [];
|
||||||
|
|
||||||
|
function defaultRetentionRule(){
|
||||||
|
return {BackupDatabase:true,BackupMetadata:false,BackupSubtitles:false,BackupTrickplay:false,KeepLastN:7};
|
||||||
|
}
|
||||||
|
|
||||||
|
function buildRetentionRow(rule){
|
||||||
|
var row = document.createElement('div');
|
||||||
|
row.style.cssText = 'padding:12px 16px;margin-bottom:8px;border:1px solid rgba(255,255,255,.15);border-radius:4px;';
|
||||||
|
|
||||||
|
function chkHtml(field, label, disabled){
|
||||||
|
var uid = 'ret-'+field+'-'+Math.random().toString(36).slice(2);
|
||||||
|
var chkd = (disabled || !!rule[field]) ? ' checked' : '';
|
||||||
|
var dis = disabled ? ' disabled style="opacity:0.4;"' : '';
|
||||||
|
return '<div class="checkboxContainer"><label class="emby-checkbox-label"'+(disabled?' style="opacity:0.4;cursor:not-allowed;"':'')+'>'+
|
||||||
|
'<input type="checkbox" is="emby-checkbox" id="'+uid+'" data-field="'+field+'"'+chkd+(disabled?' disabled':'')+'>'+
|
||||||
|
'<span>'+esc(label)+'</span></label></div>';
|
||||||
|
}
|
||||||
|
|
||||||
|
row.innerHTML =
|
||||||
|
'<div style="display:flex;gap:8px 24px;flex-wrap:wrap;align-items:center;margin-bottom:4px;">'
|
||||||
|
+ chkHtml('BackupDatabase', T.badgeDatabase, true)
|
||||||
|
+ chkHtml('BackupMetadata', T.badgeMetadata, false)
|
||||||
|
+ chkHtml('BackupSubtitles', T.badgeSubtitles, false)
|
||||||
|
+ chkHtml('BackupTrickplay', T.badgeTrickplay, false)
|
||||||
|
+'<div style="margin-left:auto;display:flex;align-items:center;gap:8px;">'
|
||||||
|
+'<span>'+esc(T.keepLastN)+'</span>'
|
||||||
|
+'<input is="emby-input" type="number" min="1" data-field="KeepLastN" value="'+(rule.KeepLastN||7)+'" style="width:70px;">'
|
||||||
|
+'<button is="emby-button" type="button" class="raised emby-button" style="background-color:#c00;color:#fff;"><span>'+esc(T.remove)+'</span></button>'
|
||||||
|
+'</div>'
|
||||||
|
+'</div>';
|
||||||
|
|
||||||
|
row.querySelector('button').addEventListener('click', function(){ row.parentNode && row.parentNode.removeChild(row); });
|
||||||
|
return row;
|
||||||
|
}
|
||||||
|
|
||||||
|
function readRetentionRow(row){
|
||||||
|
function chkVal(field){
|
||||||
|
var cb = row.querySelector('[data-field="'+field+'"]');
|
||||||
|
return cb ? cb.checked : false;
|
||||||
|
}
|
||||||
|
var inp = row.querySelector('[data-field="KeepLastN"]');
|
||||||
|
return {
|
||||||
|
BackupDatabase: true, // always forced
|
||||||
|
BackupMetadata: chkVal('BackupMetadata'),
|
||||||
|
BackupSubtitles: chkVal('BackupSubtitles'),
|
||||||
|
BackupTrickplay: chkVal('BackupTrickplay'),
|
||||||
|
KeepLastN: inp ? Math.max(1, parseInt(inp.value,10)||1) : 7
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function loadRetentionUi(){
|
||||||
|
var list = document.getElementById('retentionList');
|
||||||
|
list.innerHTML = '';
|
||||||
|
var p = document.createElement('p');
|
||||||
|
p.style.cssText = 'opacity:.7;margin-bottom:12px;';
|
||||||
|
p.textContent = T.retentionDesc;
|
||||||
|
list.appendChild(p);
|
||||||
|
_retentionRules.forEach(function(rule){ list.appendChild(buildRetentionRow(rule)); });
|
||||||
|
}
|
||||||
|
|
||||||
|
// ── Helpers ──────────────────────────────────────────────────────
|
||||||
|
function esc(v){ return String(v==null?'':v).replace(/&/g,'&').replace(/</g,'<').replace(/>/g,'>').replace(/"/g,'"'); }
|
||||||
|
function get(s,k,d){ var v=s[k]; if(v==null) v=s[k[0].toLowerCase()+k.slice(1)]; return v==null?d:v; }
|
||||||
|
function pad(n){ return n<10?'0'+n:''+n; }
|
||||||
|
function toInt(v,map,def){ if(v==null) return def; if(typeof v==='number') return v; if(!isNaN(v)) return parseInt(v,10); return map[v]!=null?map[v]:def; }
|
||||||
|
|
||||||
|
function mkOpts(arr, cur){
|
||||||
|
return arr.map(function(it){
|
||||||
|
return '<option value="'+it.v+'"'+(String(it.v)===String(cur)?' selected':'')+'>'+esc(it.l)+'</option>';
|
||||||
|
}).join('');
|
||||||
|
}
|
||||||
|
function mkDayOpts(cur){
|
||||||
|
return T.days.map(function(d,i){
|
||||||
|
return '<option value="'+i+'"'+(i===cur?' selected':'')+'>'+d+'</option>';
|
||||||
|
}).join('');
|
||||||
|
}
|
||||||
|
function mkMinOpts(cur){
|
||||||
|
return MINS.map(function(m){
|
||||||
|
return '<option value="'+m+'"'+(m===cur?' selected':'')+'>'+pad(m)+'</option>';
|
||||||
|
}).join('');
|
||||||
|
}
|
||||||
|
|
||||||
|
function makeBadge(s){
|
||||||
|
var p=[];
|
||||||
|
if(get(s,'BackupDatabase',true)) p.push('DB');
|
||||||
|
if(get(s,'BackupMetadata',false)) p.push('Meta');
|
||||||
|
if(get(s,'BackupSubtitles',false)) p.push('Subs');
|
||||||
|
if(get(s,'BackupTrickplay',false)) p.push('TP');
|
||||||
|
var st=toInt(get(s,'ScheduleType',1),STYPE_MAP,1),h=get(s,'TriggerHour',2),m=get(s,'TriggerMinute',0),t=pad(h)+':'+pad(m),sc='';
|
||||||
|
var wd=toInt(get(s,'WeekDay',0),WDAY_MAP,0);
|
||||||
|
if(st===0) sc=T.badgeEvery+' '+get(s,'IntervalHours',24)+'h';
|
||||||
|
else if(st===1) sc=T.badgeDaily+' '+t;
|
||||||
|
else if(st===2) sc=T.badgeWeekly+' '+T.daysShort[wd]+' '+t;
|
||||||
|
else if(st===3) sc=T.badgeEvery+' '+get(s,'IntervalWeeks',1)+'w '+T.daysShort[wd]+' '+t;
|
||||||
|
else if(st===4) sc=T.badgeMonthly+' '+get(s,'DayOfMonth',1)+' '+t;
|
||||||
|
else if(st===5){var wom=toInt(get(s,'WeekOfMonth',1),WOM_MAP,1),wl='';getWOM().forEach(function(w){if(w.v===wom)wl=w.l;});sc=T.badgeMonthly+' '+wl+' '+T.daysShort[wd]+' '+t;}
|
||||||
|
var d=p.join('+')+( p.length&&sc?' • ':'')+sc;
|
||||||
|
return d?'('+d+')':'';
|
||||||
|
}
|
||||||
|
|
||||||
|
function sel(id, key, label, opts, extraId){
|
||||||
|
var wrap = extraId ? ' id="'+extraId+'"' : '';
|
||||||
|
return '<div class="selectContainer"'+wrap+'>'
|
||||||
|
+'<label class="inputLabel inputLabelUnfocused" for="'+key+'-'+id+'">'+label+'</label>'
|
||||||
|
+'<select is="emby-select" id="'+key+'-'+id+'">'+opts+'</select>'
|
||||||
|
+'</div>';
|
||||||
|
}
|
||||||
|
function inp(id, key, label, type, min, max, val, extraId, flexStyle){
|
||||||
|
var wrap = (extraId ? ' id="'+extraId+'"' : '')+(flexStyle ? ' style="'+flexStyle+'"' : '');
|
||||||
|
return '<div class="inputContainer"'+wrap+'>'
|
||||||
|
+'<label class="inputLabel inputLabelUnfocused" for="'+key+'-'+id+'">'+label+'</label>'
|
||||||
|
+'<input type="'+(type||'text')+'" is="emby-input" id="'+key+'-'+id+'"'
|
||||||
|
+(min!=null?' min="'+min+'"':'')+(max!=null?' max="'+max+'"':'')
|
||||||
|
+' value="'+val+'">'
|
||||||
|
+'</div>';
|
||||||
|
}
|
||||||
|
|
||||||
|
function buildCardInner(s, id){
|
||||||
|
var label = get(s,'Label',T.defaultLabel);
|
||||||
|
var stype = toInt(get(s,'ScheduleType',1), STYPE_MAP, 1);
|
||||||
|
var wday = toInt(get(s,'WeekDay',0), WDAY_MAP, 0);
|
||||||
|
var wom = toInt(get(s,'WeekOfMonth',1), WOM_MAP, 1);
|
||||||
|
|
||||||
|
return '<summary style="cursor:pointer;padding:10px 0;display:flex;align-items:center;gap:8px;list-style:none;-webkit-appearance:none;">'
|
||||||
|
+'<span id="sb-arrow-'+id+'" style="font-size:.7em;transition:transform .15s;display:inline-block;">▶</span>'
|
||||||
|
+'<span id="sb-title-'+id+'" style="flex:1;font-weight:600;">'+esc(label)+'</span>'
|
||||||
|
+'<span id="sb-badge-'+id+'" style="font-size:.8em;opacity:.7;">'+esc(makeBadge(s))+'</span>'
|
||||||
|
+'</summary>'
|
||||||
|
|
||||||
|
+'<div style="padding:4px 0 14px;">'
|
||||||
|
|
||||||
|
+'<div style="display:flex;gap:12px;flex-wrap:wrap;align-items:center;margin-bottom:4px;">'
|
||||||
|
+'<div class="checkboxContainer">'
|
||||||
|
+'<label class="emby-checkbox-label">'
|
||||||
|
+'<input type="checkbox" is="emby-checkbox" name="sb-enabled-'+id+'" id="sb-enabled-'+id+'">'
|
||||||
|
+'<span>'+T.enabled+'</span>'
|
||||||
|
+'</label>'
|
||||||
|
+'</div>'
|
||||||
|
+inp(id,'sb-label',T.labelField,'text',null,null,esc(label),null,'flex:1;min-width:160px;')
|
||||||
|
+'</div>'
|
||||||
|
|
||||||
|
+'<div style="display:flex;gap:8px 24px;flex-wrap:wrap;align-items:center;margin-bottom:8px;">'
|
||||||
|
+'<div class="checkboxContainer" style="opacity:0.4;cursor:not-allowed;"><label class="emby-checkbox-label" style="cursor:not-allowed;"><input type="checkbox" is="emby-checkbox" name="sb-db-'+id+'" id="sb-db-'+id+'" checked disabled><span>'+T.database+'</span></label></div>'
|
||||||
|
+'<div class="checkboxContainer"><label class="emby-checkbox-label"><input type="checkbox" is="emby-checkbox" name="sb-meta-'+id+'" id="sb-meta-'+id+'"><span>'+T.metadata+'</span></label></div>'
|
||||||
|
+'<div class="checkboxContainer"><label class="emby-checkbox-label"><input type="checkbox" is="emby-checkbox" name="sb-subs-'+id+'" id="sb-subs-'+id+'"><span>'+T.subtitles+'</span></label></div>'
|
||||||
|
+'<div class="checkboxContainer"><label class="emby-checkbox-label"><input type="checkbox" is="emby-checkbox" name="sb-tp-'+id+'" id="sb-tp-'+id+'"><span>'+T.trickplay+'</span></label></div>'
|
||||||
|
+'</div>'
|
||||||
|
|
||||||
|
+'<div style="display:flex;gap:12px;flex-wrap:wrap;align-items:flex-end;">'
|
||||||
|
+sel(id,'sb-type',T.scheduleType,mkOpts(getTypes(),stype),null)
|
||||||
|
+inp(id,'sb-ihours',T.intervalHours,'number',1,8760,get(s,'IntervalHours',24),'sb-f-ihours-'+id,null)
|
||||||
|
+inp(id,'sb-iweeks',T.intervalWeeks,'number',1,52,get(s,'IntervalWeeks',1),'sb-f-iweeks-'+id,null)
|
||||||
|
+inp(id,'sb-dom',T.dayOfMonth,'number',1,28,get(s,'DayOfMonth',1),'sb-f-dom-'+id,null)
|
||||||
|
+sel(id,'sb-wom',T.occurrence,mkOpts(getWOM(),wom),'sb-f-wom-'+id)
|
||||||
|
+sel(id,'sb-wday',T.dayOfWeek,mkDayOpts(wday),'sb-f-wday-'+id)
|
||||||
|
+inp(id,'sb-hour',T.atHour,'number',0,23,get(s,'TriggerHour',2),'sb-f-hour-'+id,null)
|
||||||
|
+sel(id,'sb-min',T.atMinute,mkMinOpts(get(s,'TriggerMinute',0)),'sb-f-min-'+id)
|
||||||
|
+'<button is="emby-button" type="button" class="raised emby-button" id="sb-remove-'+id+'" style="background-color:#c00;color:#fff;margin-left:auto;align-self:flex-end;"><span>'+T.remove+'</span></button>'
|
||||||
|
+'</div>'
|
||||||
|
|
||||||
|
+'</div>';
|
||||||
|
}
|
||||||
|
|
||||||
|
function q(id, suffix){ return document.getElementById('sb-'+suffix+'-'+id); }
|
||||||
|
function getCardId(card){ return card.id.replace('sbcard-',''); }
|
||||||
|
|
||||||
|
function updateVis(card){
|
||||||
|
var id = getCardId(card);
|
||||||
|
var stype = parseInt(q(id,'type').value, 10);
|
||||||
|
var tn = TYPE_NAMES[stype]||'';
|
||||||
|
var show = {
|
||||||
|
ihours: tn==='EveryNHours',
|
||||||
|
iweeks: tn==='EveryNWeeks',
|
||||||
|
dom: tn==='MonthlyOnDay',
|
||||||
|
wom: tn==='MonthlyOnWeekday',
|
||||||
|
wday: tn==='Weekly'||tn==='EveryNWeeks'||tn==='MonthlyOnWeekday',
|
||||||
|
hour: tn!=='EveryNHours',
|
||||||
|
min: tn!=='EveryNHours'
|
||||||
|
};
|
||||||
|
var keys = Object.keys(show);
|
||||||
|
for(var i=0;i<keys.length;i++){
|
||||||
|
var el = q(id,'f-'+keys[i]);
|
||||||
|
if(el) el.style.display = show[keys[i]] ? '' : 'none';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function updateBadge(card){
|
||||||
|
var id = getCardId(card);
|
||||||
|
var s = readCard(card);
|
||||||
|
q(id,'title').textContent = s.Label||T.defaultLabel;
|
||||||
|
q(id,'badge').textContent = makeBadge(s);
|
||||||
|
}
|
||||||
|
|
||||||
|
function readCard(card){
|
||||||
|
var id = getCardId(card);
|
||||||
|
return {
|
||||||
|
IsEnabled: q(id,'enabled').checked,
|
||||||
|
Label: q(id,'label').value,
|
||||||
|
BackupDatabase: true,
|
||||||
|
BackupMetadata: q(id,'meta').checked,
|
||||||
|
BackupSubtitles: q(id,'subs').checked,
|
||||||
|
BackupTrickplay: q(id,'tp').checked,
|
||||||
|
ScheduleType: parseInt(q(id,'type').value, 10),
|
||||||
|
IntervalHours: parseInt(q(id,'ihours').value, 10)||24,
|
||||||
|
IntervalWeeks: parseInt(q(id,'iweeks').value, 10)||1,
|
||||||
|
WeekDay: parseInt(q(id,'wday').value, 10),
|
||||||
|
DayOfMonth: parseInt(q(id,'dom').value, 10)||1,
|
||||||
|
WeekOfMonth: parseInt(q(id,'wom').value, 10),
|
||||||
|
TriggerHour: parseInt(q(id,'hour').value, 10),
|
||||||
|
TriggerMinute: parseInt(q(id,'min').value, 10)
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function wireCard(card, s){
|
||||||
|
var id = getCardId(card);
|
||||||
|
|
||||||
|
function applyChecked(){
|
||||||
|
var e;
|
||||||
|
e=q(id,'enabled'); if(e) e.checked=get(s,'IsEnabled',false);
|
||||||
|
e=q(id,'db'); if(e) e.checked=get(s,'BackupDatabase',true);
|
||||||
|
e=q(id,'meta'); if(e) e.checked=get(s,'BackupMetadata',false);
|
||||||
|
e=q(id,'subs'); if(e) e.checked=get(s,'BackupSubtitles',false);
|
||||||
|
e=q(id,'tp'); if(e) e.checked=get(s,'BackupTrickplay',false);
|
||||||
|
}
|
||||||
|
applyChecked();
|
||||||
|
setTimeout(applyChecked, 150);
|
||||||
|
|
||||||
|
updateVis(card);
|
||||||
|
updateBadge(card);
|
||||||
|
|
||||||
|
var arrow = q(id,'arrow');
|
||||||
|
card.addEventListener('toggle', function(){
|
||||||
|
if (arrow) arrow.style.transform = card.hasAttribute('open') ? 'rotate(90deg)' : 'rotate(0deg)';
|
||||||
|
});
|
||||||
|
if (arrow) arrow.style.transform = 'rotate(90deg)';
|
||||||
|
|
||||||
|
var rebadge = function(){ updateBadge(card); };
|
||||||
|
var inputs = card.querySelectorAll('input, select');
|
||||||
|
for(var i=0;i<inputs.length;i++){
|
||||||
|
inputs[i].addEventListener('change', rebadge);
|
||||||
|
inputs[i].addEventListener('input', rebadge);
|
||||||
|
}
|
||||||
|
q(id,'type').addEventListener('change', function(){ updateVis(card); updateBadge(card); });
|
||||||
|
q(id,'remove').addEventListener('click', function(){ card.parentNode.removeChild(card); });
|
||||||
|
}
|
||||||
|
|
||||||
|
function addCard(s){
|
||||||
|
var id = ++_n;
|
||||||
|
var list = document.getElementById('scheduleList');
|
||||||
|
var card = document.createElement('details');
|
||||||
|
card.id = 'sbcard-' + id;
|
||||||
|
card.setAttribute('open', '');
|
||||||
|
card.style.border = '1px solid rgba(255,255,255,0.15)';
|
||||||
|
card.style.borderRadius = '4px';
|
||||||
|
card.style.marginBottom = '12px';
|
||||||
|
card.style.padding = '2px 16px 0';
|
||||||
|
card.style.background = 'transparent';
|
||||||
|
list.appendChild(card);
|
||||||
|
card.innerHTML = buildCardInner(s, id);
|
||||||
|
wireCard(card, s);
|
||||||
|
return card;
|
||||||
|
}
|
||||||
|
|
||||||
|
function defaultSchedule(){
|
||||||
|
return {Label:T.defaultLabel,IsEnabled:false,BackupDatabase:true,BackupMetadata:false,
|
||||||
|
BackupSubtitles:false,BackupTrickplay:false,ScheduleType:1,
|
||||||
|
IntervalHours:24,IntervalWeeks:1,WeekDay:0,DayOfMonth:1,WeekOfMonth:1,
|
||||||
|
TriggerHour:2,TriggerMinute:0,
|
||||||
|
LastRunUtc:'0001-01-01T00:00:00Z'};
|
||||||
|
}
|
||||||
|
|
||||||
|
document.getElementById('tab-settings').addEventListener('click', function(){ switchTab('settings'); });
|
||||||
|
document.getElementById('tab-retention').addEventListener('click', function(){ switchTab('retention'); });
|
||||||
|
document.getElementById('tab-backups').addEventListener('click', function(){ switchTab('backups'); });
|
||||||
|
|
||||||
|
document.getElementById('btnAdd').addEventListener('click', function(){
|
||||||
|
var card = addCard(defaultSchedule());
|
||||||
|
card.scrollIntoView({behavior:'smooth', block:'nearest'});
|
||||||
|
});
|
||||||
|
|
||||||
|
document.getElementById('btnAddRetention').addEventListener('click', function(){
|
||||||
|
var list = document.getElementById('retentionList');
|
||||||
|
list.appendChild(buildRetentionRow(defaultRetentionRule()));
|
||||||
|
});
|
||||||
|
|
||||||
|
document.getElementById('btnSave').addEventListener('click', function(){
|
||||||
|
ApiClient.getPluginConfiguration(PLUGIN_ID).then(function(config){
|
||||||
|
config.IsInitialized = true;
|
||||||
|
config.Schedules = Array.prototype.map.call(
|
||||||
|
document.querySelectorAll('details[id^="sbcard-"]'), readCard);
|
||||||
|
return ApiClient.updatePluginConfiguration(PLUGIN_ID, config);
|
||||||
|
}).then(function(){
|
||||||
|
Dashboard.alert(T.saved);
|
||||||
|
}).catch(function(e){
|
||||||
|
Dashboard.alert(T.errorSave + e);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
document.getElementById('btnSaveRetention').addEventListener('click', function(){
|
||||||
|
ApiClient.getPluginConfiguration(PLUGIN_ID).then(function(config){
|
||||||
|
config.RetentionRules = Array.prototype.map.call(
|
||||||
|
document.querySelectorAll('#retentionList > div'), readRetentionRow);
|
||||||
|
return ApiClient.updatePluginConfiguration(PLUGIN_ID, config);
|
||||||
|
}).then(function(){
|
||||||
|
Dashboard.alert(T.saved);
|
||||||
|
}).catch(function(e){
|
||||||
|
Dashboard.alert(T.errorSave + e);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
document.querySelector('.page').addEventListener('pageshow', function(){
|
||||||
|
ApiClient.getCurrentUser().then(function(user){
|
||||||
|
var userId = (user.Id || '').replace(/-/g, '').toLowerCase();
|
||||||
|
var culture = localStorage.getItem(userId + '-language') || navigator.language || 'en';
|
||||||
|
T = TRANSLATIONS[culture.toLowerCase().startsWith('de') ? 'de' : 'en'];
|
||||||
|
applyStaticTranslations();
|
||||||
|
return ApiClient.getPluginConfiguration(PLUGIN_ID);
|
||||||
|
}).then(function(config){
|
||||||
|
var list = document.getElementById('scheduleList');
|
||||||
|
list.innerHTML = '';
|
||||||
|
_n = 0;
|
||||||
|
var schedules = config.Schedules || config.schedules || [];
|
||||||
|
var initialized = config.IsInitialized || config.isInitialized || false;
|
||||||
|
if (!initialized && schedules.length === 0) {
|
||||||
|
schedules = [{ Label:'Daily', IsEnabled:true, BackupDatabase:true,
|
||||||
|
BackupMetadata:false, BackupSubtitles:false, BackupTrickplay:false,
|
||||||
|
ScheduleType:1, TriggerHour:8, TriggerMinute:0 }];
|
||||||
|
}
|
||||||
|
schedules.forEach(function(s){ addCard(s); });
|
||||||
|
_retentionRules = config.RetentionRules || config.retentionRules || [];
|
||||||
|
// Apply initial tab styles
|
||||||
|
document.getElementById('tab-settings').style.cssText = ACTIVE_STYLE;
|
||||||
|
document.getElementById('tab-retention').style.cssText = INACTIVE_STYLE;
|
||||||
|
document.getElementById('tab-backups').style.cssText = INACTIVE_STYLE;
|
||||||
|
}).catch(function(e){ console.error('[AutoBackup]', e); });
|
||||||
|
});
|
||||||
|
|
||||||
|
}());
|
||||||
|
</script>
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
@ -0,0 +1,35 @@
|
||||||
|
using Jellyfin.Plugin.AutoBackup.Configuration;
|
||||||
|
using MediaBrowser.Common.Configuration;
|
||||||
|
using MediaBrowser.Common.Plugins;
|
||||||
|
using MediaBrowser.Model.Plugins;
|
||||||
|
using MediaBrowser.Model.Serialization;
|
||||||
|
|
||||||
|
namespace Jellyfin.Plugin.AutoBackup;
|
||||||
|
|
||||||
|
public class Plugin : BasePlugin<PluginConfiguration>, IHasWebPages
|
||||||
|
{
|
||||||
|
public static Plugin? Instance { get; private set; }
|
||||||
|
|
||||||
|
public Plugin(IApplicationPaths applicationPaths, IXmlSerializer xmlSerializer)
|
||||||
|
: base(applicationPaths, xmlSerializer)
|
||||||
|
{
|
||||||
|
Instance = this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public override string Name => "Auto Backup";
|
||||||
|
public override Guid Id => new Guid("1175543c-6d20-4cfa-93a6-1476836df34c");
|
||||||
|
public override string Description => "Automated scheduled ZIP backups of Jellyfin data.";
|
||||||
|
|
||||||
|
public IEnumerable<PluginPageInfo> GetPages()
|
||||||
|
{
|
||||||
|
yield return new PluginPageInfo
|
||||||
|
{
|
||||||
|
Name = "AutoBackup",
|
||||||
|
DisplayName = "Auto Backup",
|
||||||
|
EmbeddedResourcePath = $"{GetType().Namespace}.Pages.config.html",
|
||||||
|
EnableInMainMenu = true,
|
||||||
|
MenuSection = "plugins",
|
||||||
|
MenuIcon = "folder",
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,14 @@
|
||||||
|
using Jellyfin.Plugin.AutoBackup.Services;
|
||||||
|
using MediaBrowser.Controller;
|
||||||
|
using MediaBrowser.Controller.Plugins;
|
||||||
|
using Microsoft.Extensions.DependencyInjection;
|
||||||
|
|
||||||
|
namespace Jellyfin.Plugin.AutoBackup;
|
||||||
|
|
||||||
|
public class PluginServiceRegistrar : IPluginServiceRegistrator
|
||||||
|
{
|
||||||
|
public void RegisterServices(IServiceCollection serviceCollection, IServerApplicationHost applicationHost)
|
||||||
|
{
|
||||||
|
serviceCollection.AddHostedService<BackupBackgroundService>();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,47 @@
|
||||||
|
# Auto Backup
|
||||||
|
|
||||||
|
A Jellyfin plugin that automatically creates scheduled backups of your Jellyfin data at the times you define.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- **Multiple schedules** — create as many independent backup schedules as you need
|
||||||
|
- **Flexible recurrence** — daily, weekly, every N hours/weeks, or monthly (fixed day or weekday)
|
||||||
|
- **Backup content selection** — choose what to include: Database, Metadata, Subtitles, Trickplay
|
||||||
|
- **Retention rules** — keep the last N backups per backup type combination, older ones are deleted automatically
|
||||||
|
- **Local server time** — schedule times are interpreted in the server's local timezone
|
||||||
|
- **Multilingual UI** — configuration page in English and German
|
||||||
|
- **Sidebar integration** — accessible directly from the Jellyfin sidebar under Plugins
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
| Plugin version | Jellyfin version | .NET |
|
||||||
|
|---|---|---|
|
||||||
|
| Built for `net9.0` | 10.x | .NET 9 |
|
||||||
|
| Built for `net10.0` | 12.x | .NET 10 |
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
1. Download the `Jellyfin.Plugin.AutoBackup.dll` for your Jellyfin version from the [Releases](../../releases) page
|
||||||
|
2. Place the DLL in your Jellyfin plugins folder (e.g. `/config/plugins/AutoBackup/`)
|
||||||
|
3. Restart Jellyfin
|
||||||
|
4. Open **Dashboard → Plugins → Auto Backup** to configure your schedules
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
### Schedules tab
|
||||||
|
Each schedule has:
|
||||||
|
- **Label** — a name for the schedule
|
||||||
|
- **Enabled** toggle
|
||||||
|
- **Backup content** — Database (always included), Metadata, Subtitles, Trickplay
|
||||||
|
- **Schedule type** — Every N hours / Daily / Weekly / Every N weeks / Monthly (fixed day) / Monthly (weekday)
|
||||||
|
- **Time** — hour and minute (in 15-minute steps) at which the backup runs
|
||||||
|
|
||||||
|
### Retention tab
|
||||||
|
Define how many backups to keep per backup content combination. When a backup run finishes, older matching backups are deleted automatically. Leave a combination without a rule to keep all backups of that type.
|
||||||
|
|
||||||
|
### Backups tab
|
||||||
|
Lists all existing backups with their creation date, filename, and content badges. Backups can be deleted directly from this tab.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
This project is licensed under the [GNU General Public License v3.0](LICENSE).
|
||||||
|
|
@ -0,0 +1,228 @@
|
||||||
|
using System.IO.Compression;
|
||||||
|
using System.Text.Json;
|
||||||
|
using Jellyfin.Plugin.AutoBackup.Configuration;
|
||||||
|
using Jellyfin.Server.Implementations.SystemBackupService;
|
||||||
|
using MediaBrowser.Common.Configuration;
|
||||||
|
using MediaBrowser.Controller.SystemBackupService;
|
||||||
|
using Microsoft.Extensions.Hosting;
|
||||||
|
using Microsoft.Extensions.Logging;
|
||||||
|
|
||||||
|
namespace Jellyfin.Plugin.AutoBackup.Services;
|
||||||
|
|
||||||
|
public class BackupBackgroundService : BackgroundService
|
||||||
|
{
|
||||||
|
private readonly IBackupService _backupService;
|
||||||
|
private readonly IApplicationPaths _appPaths;
|
||||||
|
private readonly ILogger<BackupBackgroundService> _logger;
|
||||||
|
|
||||||
|
public BackupBackgroundService(
|
||||||
|
IBackupService backupService,
|
||||||
|
IApplicationPaths appPaths,
|
||||||
|
ILoggerFactory loggerFactory)
|
||||||
|
{
|
||||||
|
_backupService = backupService;
|
||||||
|
_appPaths = appPaths;
|
||||||
|
_logger = loggerFactory.CreateLogger<BackupBackgroundService>();
|
||||||
|
}
|
||||||
|
|
||||||
|
protected override async Task ExecuteAsync(CancellationToken stoppingToken)
|
||||||
|
{
|
||||||
|
_logger.LogInformation("[AutoBackup] Background service started.");
|
||||||
|
await RunLoopAsync(stoppingToken).ConfigureAwait(false);
|
||||||
|
_logger.LogInformation("[AutoBackup] Background service stopped.");
|
||||||
|
}
|
||||||
|
|
||||||
|
private async Task RunLoopAsync(CancellationToken cancellationToken)
|
||||||
|
{
|
||||||
|
while (!cancellationToken.IsCancellationRequested)
|
||||||
|
{
|
||||||
|
var now = DateTime.UtcNow;
|
||||||
|
var secondsUntilNext = (15 - now.Minute % 15) * 60 - now.Second;
|
||||||
|
|
||||||
|
try
|
||||||
|
{
|
||||||
|
await Task.Delay(TimeSpan.FromSeconds(secondsUntilNext), cancellationToken);
|
||||||
|
}
|
||||||
|
catch (OperationCanceledException)
|
||||||
|
{
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
await RunDueSchedulesAsync(cancellationToken);
|
||||||
|
}
|
||||||
|
|
||||||
|
_logger.LogInformation("[AutoBackup] Background service stopped.");
|
||||||
|
}
|
||||||
|
|
||||||
|
private async Task RunDueSchedulesAsync(CancellationToken cancellationToken)
|
||||||
|
{
|
||||||
|
var config = Plugin.Instance?.Configuration;
|
||||||
|
if (config is null)
|
||||||
|
return;
|
||||||
|
|
||||||
|
var now = DateTime.UtcNow;
|
||||||
|
var slot = new DateTime(now.Year, now.Month, now.Day, now.Hour,
|
||||||
|
now.Minute / 15 * 15, 0, DateTimeKind.Utc);
|
||||||
|
var localSlot = TimeZoneInfo.ConvertTimeFromUtc(slot, TimeZoneInfo.Local);
|
||||||
|
|
||||||
|
var due = config.Schedules
|
||||||
|
.Where(s => s.IsEnabled && IsDue(s, slot, localSlot))
|
||||||
|
.ToList();
|
||||||
|
|
||||||
|
if (due.Count == 0)
|
||||||
|
{
|
||||||
|
_logger.LogDebug("[AutoBackup] No schedules due at {Slot}.", slot);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
_logger.LogInformation("[AutoBackup] {Count} schedule(s) due at {Slot}.", due.Count, slot);
|
||||||
|
|
||||||
|
foreach (var schedule in due)
|
||||||
|
{
|
||||||
|
cancellationToken.ThrowIfCancellationRequested();
|
||||||
|
_logger.LogInformation("[AutoBackup] Running schedule '{Label}'.", schedule.Label);
|
||||||
|
|
||||||
|
try
|
||||||
|
{
|
||||||
|
var options = new BackupOptionsDto
|
||||||
|
{
|
||||||
|
Database = schedule.BackupDatabase,
|
||||||
|
Metadata = schedule.BackupMetadata,
|
||||||
|
Subtitles = schedule.BackupSubtitles,
|
||||||
|
Trickplay = schedule.BackupTrickplay,
|
||||||
|
};
|
||||||
|
|
||||||
|
var result = await _backupService.CreateBackupAsync(options).ConfigureAwait(false);
|
||||||
|
_logger.LogInformation("[AutoBackup] Backup complete: {Path}", result.Path);
|
||||||
|
|
||||||
|
schedule.LastRunUtc = slot;
|
||||||
|
}
|
||||||
|
catch (OperationCanceledException)
|
||||||
|
{
|
||||||
|
throw;
|
||||||
|
}
|
||||||
|
catch (Exception ex)
|
||||||
|
{
|
||||||
|
_logger.LogError(ex, "[AutoBackup] Schedule '{Label}' failed.", schedule.Label);
|
||||||
|
}
|
||||||
|
finally
|
||||||
|
{
|
||||||
|
Plugin.Instance?.SaveConfiguration();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
ApplyRetentionPolicies(config.RetentionRules);
|
||||||
|
}
|
||||||
|
|
||||||
|
private void ApplyRetentionPolicies(List<RetentionRule> rules)
|
||||||
|
{
|
||||||
|
if (rules.Count == 0)
|
||||||
|
return;
|
||||||
|
|
||||||
|
var backupDir = Path.Combine(_appPaths.DataPath, "backups");
|
||||||
|
if (!Directory.Exists(backupDir))
|
||||||
|
return;
|
||||||
|
|
||||||
|
var files = Directory.GetFiles(backupDir, "jellyfin-backup-*.zip");
|
||||||
|
|
||||||
|
// Read options from manifest.json inside each zip
|
||||||
|
var manifests = new List<(string Path, DateTime Created, bool Db, bool Meta, bool Subs, bool Tp)>();
|
||||||
|
foreach (var file in files)
|
||||||
|
{
|
||||||
|
try
|
||||||
|
{
|
||||||
|
using var zip = ZipFile.OpenRead(file);
|
||||||
|
var entry = zip.GetEntry("manifest.json");
|
||||||
|
if (entry is null) continue;
|
||||||
|
|
||||||
|
using var stream = entry.Open();
|
||||||
|
var doc = JsonDocument.Parse(stream);
|
||||||
|
var opts = doc.RootElement.GetProperty("Options");
|
||||||
|
|
||||||
|
manifests.Add((
|
||||||
|
file,
|
||||||
|
File.GetCreationTimeUtc(file),
|
||||||
|
opts.GetProperty("Database").GetBoolean(),
|
||||||
|
opts.GetProperty("Metadata").GetBoolean(),
|
||||||
|
opts.GetProperty("Subtitles").GetBoolean(),
|
||||||
|
opts.GetProperty("Trickplay").GetBoolean()
|
||||||
|
));
|
||||||
|
}
|
||||||
|
catch (Exception ex)
|
||||||
|
{
|
||||||
|
_logger.LogWarning(ex, "[AutoBackup] Could not read manifest from {File}", file);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
foreach (var rule in rules)
|
||||||
|
{
|
||||||
|
if (rule.KeepLastN <= 0)
|
||||||
|
continue;
|
||||||
|
|
||||||
|
var matching = manifests
|
||||||
|
.Where(m => m.Db == rule.BackupDatabase
|
||||||
|
&& m.Meta == rule.BackupMetadata
|
||||||
|
&& m.Subs == rule.BackupSubtitles
|
||||||
|
&& m.Tp == rule.BackupTrickplay)
|
||||||
|
.OrderByDescending(m => m.Created)
|
||||||
|
.ToList();
|
||||||
|
|
||||||
|
foreach (var old in matching.Skip(rule.KeepLastN))
|
||||||
|
{
|
||||||
|
try
|
||||||
|
{
|
||||||
|
File.Delete(old.Path);
|
||||||
|
_logger.LogInformation("[AutoBackup] Retention: deleted {File}", old.Path);
|
||||||
|
manifests.Remove(old);
|
||||||
|
}
|
||||||
|
catch (Exception ex)
|
||||||
|
{
|
||||||
|
_logger.LogError(ex, "[AutoBackup] Retention: failed to delete {File}", old.Path);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private static bool IsDue(BackupScheduleConfig s, DateTime slot, DateTime local)
|
||||||
|
{
|
||||||
|
var last = s.LastRunUtc;
|
||||||
|
var lastLocal = last.ToLocalTime();
|
||||||
|
var triggerTime = new TimeSpan(s.TriggerHour, s.TriggerMinute, 0);
|
||||||
|
|
||||||
|
return s.ScheduleType switch
|
||||||
|
{
|
||||||
|
// Interval-based: compare elapsed UTC time, no clock-time involved
|
||||||
|
ScheduleType.EveryNHours => slot >= last.AddHours(s.IntervalHours),
|
||||||
|
|
||||||
|
// Clock-based: use local time for time-of-day and date comparisons
|
||||||
|
ScheduleType.Daily => lastLocal.Date < local.Date
|
||||||
|
&& local.TimeOfDay >= triggerTime,
|
||||||
|
|
||||||
|
ScheduleType.Weekly => slot >= last.AddDays(7)
|
||||||
|
&& local.DayOfWeek == s.WeekDay
|
||||||
|
&& local.TimeOfDay >= triggerTime,
|
||||||
|
|
||||||
|
ScheduleType.EveryNWeeks => slot >= last.AddDays(7 * s.IntervalWeeks)
|
||||||
|
&& local.DayOfWeek == s.WeekDay
|
||||||
|
&& local.TimeOfDay >= triggerTime,
|
||||||
|
|
||||||
|
ScheduleType.MonthlyOnDay => slot >= last.AddMonths(1)
|
||||||
|
&& local.Day == s.DayOfMonth
|
||||||
|
&& local.TimeOfDay >= triggerTime,
|
||||||
|
|
||||||
|
ScheduleType.MonthlyOnWeekday => slot >= last.AddMonths(1)
|
||||||
|
&& local.DayOfWeek == s.WeekDay
|
||||||
|
&& IsCorrectWeekOfMonth(local, s.WeekOfMonth)
|
||||||
|
&& local.TimeOfDay >= triggerTime,
|
||||||
|
_ => false
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
private static bool IsCorrectWeekOfMonth(DateTime date, WeekOfMonth target)
|
||||||
|
{
|
||||||
|
if (target == WeekOfMonth.Last)
|
||||||
|
return date.AddDays(7).Month != date.Month;
|
||||||
|
|
||||||
|
return (date.Day - 1) / 7 + 1 == (int)target;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,10 @@
|
||||||
|
---
|
||||||
|
version: 1
|
||||||
|
guid: "1175543c-6d20-4cfa-93a6-1476836df34c"
|
||||||
|
name: "Auto Backup"
|
||||||
|
description: "Automated scheduled ZIP backups of Jellyfin data."
|
||||||
|
overview: "Automated scheduled ZIP backups of Jellyfin data."
|
||||||
|
owner: "Filtik"
|
||||||
|
category: "General"
|
||||||
|
artifacts:
|
||||||
|
- "Jellyfin.Plugin.AutoBackup.dll"
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 199 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 136 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 133 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 81 KiB |
Binary file not shown.
|
|
@ -0,0 +1 @@
|
||||||
|
[]
|
||||||
|
|
@ -0,0 +1,20 @@
|
||||||
|
{
|
||||||
|
"guid": "1175543c-6d20-4cfa-93a6-1476836df34c",
|
||||||
|
"name": "Auto Backup",
|
||||||
|
"overview": "Automated scheduled ZIP backups for Jellyfin data.",
|
||||||
|
"description": "Creates configurable scheduled backups of your Jellyfin database, metadata, subtitles, and trickplay files. Supports unlimited independent timer schedules with flexible recurrence options (hourly, daily, weekly, bi-weekly, monthly) and automatic retention cleanup.",
|
||||||
|
"owner": "Filtik",
|
||||||
|
"category": "General",
|
||||||
|
"imageUrl": "",
|
||||||
|
"versions": [
|
||||||
|
{
|
||||||
|
"version": "1.0.0.0",
|
||||||
|
"changelog": "Initial release.",
|
||||||
|
"targetAbi": "10.9.0.0",
|
||||||
|
"sourceUrl": "",
|
||||||
|
"checksum": "",
|
||||||
|
"timestamp": "2026-06-29T00:00:00Z",
|
||||||
|
"dependencies": []
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
Loading…
Reference in New Issue