commit 3cff856fce26bc5f30789b94316c57fc03119de1 Author: Filtik Date: Thu Jul 2 19:57:01 2026 +0200 Initial commit Co-Authored-By: Claude Sonnet 4.6 diff --git a/.gitea/workflows/publish.yml b/.gitea/workflows/publish.yml new file mode 100644 index 0000000..82330b5 --- /dev/null +++ b/.gitea/workflows/publish.yml @@ -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 }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0e1f3ce --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +bin/ +obj/ +publish/ +.vs/ +*.user diff --git a/AutoBackup.csproj b/AutoBackup.csproj new file mode 100644 index 0000000..a138e88 --- /dev/null +++ b/AutoBackup.csproj @@ -0,0 +1,40 @@ + + + + net9.0;net10.0 + enable + enable + Jellyfin.Plugin.AutoBackup + Jellyfin.Plugin.AutoBackup + false + false + $(MSBuildProjectDirectory)\publish\$(TargetFramework) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/AutoBackup.slnx b/AutoBackup.slnx new file mode 100644 index 0000000..723ab38 --- /dev/null +++ b/AutoBackup.slnx @@ -0,0 +1,3 @@ + + + diff --git a/Configuration/BackupScheduleConfig.cs b/Configuration/BackupScheduleConfig.cs new file mode 100644 index 0000000..c19e6e1 --- /dev/null +++ b/Configuration/BackupScheduleConfig.cs @@ -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; + + /// Used when ScheduleType is EveryNHours. + public int IntervalHours { get; set; } = 24; + + /// Used when ScheduleType is EveryNWeeks. + public int IntervalWeeks { get; set; } = 1; + + /// Used when ScheduleType is Weekly, EveryNWeeks, or MonthlyOnWeekday. + public DayOfWeek WeekDay { get; set; } = DayOfWeek.Sunday; + + /// Used when ScheduleType is MonthlyOnDay (1–28). + public int DayOfMonth { get; set; } = 1; + + /// Used when ScheduleType is MonthlyOnWeekday. + public WeekOfMonth WeekOfMonth { get; set; } = WeekOfMonth.First; + + /// Hour of day (0–23) for the trigger. + public int TriggerHour { get; set; } = 2; + + /// Minute of hour — only 0, 15, 30 or 45 are valid (matches 15-min master task tick). + public int TriggerMinute { get; set; } = 0; + + /// Persisted after each successful run to calculate next due time. + public DateTime LastRunUtc { get; set; } = DateTime.MinValue; +} diff --git a/Configuration/PluginConfiguration.cs b/Configuration/PluginConfiguration.cs new file mode 100644 index 0000000..55d690f --- /dev/null +++ b/Configuration/PluginConfiguration.cs @@ -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 Schedules { get; set; } = []; + public List RetentionRules { get; set; } = []; +} diff --git a/Configuration/RetentionRule.cs b/Configuration/RetentionRule.cs new file mode 100644 index 0000000..50f3060 --- /dev/null +++ b/Configuration/RetentionRule.cs @@ -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; +} diff --git a/Configuration/ScheduleType.cs b/Configuration/ScheduleType.cs new file mode 100644 index 0000000..ad7bd68 --- /dev/null +++ b/Configuration/ScheduleType.cs @@ -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, +} diff --git a/Controllers/BackupManagementController.cs b/Controllers/BackupManagementController.cs new file mode 100644 index 0000000..651089d --- /dev/null +++ b/Controllers/BackupManagementController.cs @@ -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 _logger; + + public BackupManagementController(IApplicationPaths appPaths, ILoggerFactory loggerFactory) + { + _appPaths = appPaths; + _logger = loggerFactory.CreateLogger(); + } + + [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(); + } +} diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + 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. + + + Copyright (C) + + 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 . + +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: + + Copyright (C) + 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 +. + + 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 +. diff --git a/Localization/de-DE.json b/Localization/de-DE.json new file mode 100644 index 0000000..9be8af4 --- /dev/null +++ b/Localization/de-DE.json @@ -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." +} diff --git a/Localization/en-US.json b/Localization/en-US.json new file mode 100644 index 0000000..bbf3ca2 --- /dev/null +++ b/Localization/en-US.json @@ -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." +} diff --git a/Pages/config.html b/Pages/config.html new file mode 100644 index 0000000..24232de --- /dev/null +++ b/Pages/config.html @@ -0,0 +1,565 @@ + + +Auto Backup + +
+
+
+ +
+

Auto Backup

+

+
+ +
+ + + +
+ +
+
+
+ + +
+
+ + + + + +
+
+ + +
+ + diff --git a/Plugin.cs b/Plugin.cs new file mode 100644 index 0000000..c5f6b02 --- /dev/null +++ b/Plugin.cs @@ -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, 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 GetPages() + { + yield return new PluginPageInfo + { + Name = "AutoBackup", + DisplayName = "Auto Backup", + EmbeddedResourcePath = $"{GetType().Namespace}.Pages.config.html", + EnableInMainMenu = true, + MenuSection = "plugins", + MenuIcon = "folder", + }; + } +} diff --git a/PluginServiceRegistrar.cs b/PluginServiceRegistrar.cs new file mode 100644 index 0000000..1e60d5b --- /dev/null +++ b/PluginServiceRegistrar.cs @@ -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(); + } +} diff --git a/README.md b/README.md new file mode 100644 index 0000000..0e51143 --- /dev/null +++ b/README.md @@ -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). diff --git a/Services/BackupBackgroundService.cs b/Services/BackupBackgroundService.cs new file mode 100644 index 0000000..1bdd381 --- /dev/null +++ b/Services/BackupBackgroundService.cs @@ -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 _logger; + + public BackupBackgroundService( + IBackupService backupService, + IApplicationPaths appPaths, + ILoggerFactory loggerFactory) + { + _backupService = backupService; + _appPaths = appPaths; + _logger = loggerFactory.CreateLogger(); + } + + 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 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; + } +} diff --git a/build.yaml b/build.yaml new file mode 100644 index 0000000..55cf1aa --- /dev/null +++ b/build.yaml @@ -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" diff --git a/images/Backups.png b/images/Backups.png new file mode 100644 index 0000000..330e371 Binary files /dev/null and b/images/Backups.png differ diff --git a/images/Retention.png b/images/Retention.png new file mode 100644 index 0000000..7ba3ef6 Binary files /dev/null and b/images/Retention.png differ diff --git a/images/Settings.png b/images/Settings.png new file mode 100644 index 0000000..8a1300d Binary files /dev/null and b/images/Settings.png differ diff --git a/images/logo.png b/images/logo.png new file mode 100644 index 0000000..0bbf573 Binary files /dev/null and b/images/logo.png differ diff --git a/images/logo.psd b/images/logo.psd new file mode 100644 index 0000000..a9baedb Binary files /dev/null and b/images/logo.psd differ diff --git a/manifest.json b/manifest.json new file mode 100644 index 0000000..fe51488 --- /dev/null +++ b/manifest.json @@ -0,0 +1 @@ +[] diff --git a/plugin-info.json b/plugin-info.json new file mode 100644 index 0000000..f1983f3 --- /dev/null +++ b/plugin-info.json @@ -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": [] + } + ] +}