Files
Libation/Source/LibationCli/Options/_ProcessableOptionsBase.cs
T
Cursor Agentandrmcrackan 562b563477 feat(cli): stop a liberate run at a per-run download limit
Adds three mutually exclusive options to `liberate`: --limit-books,
--limit-mb and --limit-gb. Each stops the run once it has downloaded that
much, leaving the rest of the library un-liberated for the next run.

Requested in #1920: a scripted or scheduled run has no way to take only a
slice of a large library, so users resort to feeding the CLI a handful of
ASINs at a time. The GUI needs no equivalent, where selecting rows already
says exactly which titles to download.

Counting reuses the daily limit's history rows rather than a private tally,
so a book and a byte mean the same thing to both limits, and failed,
cancelled and pdf-only work is never counted. Only titles this run attempted
are counted, so a Libation window or a second container downloading at the
same time does not consume this run's allowance.

The limit is checked before each title rather than at the top of the run, so
a run whose books happen to end exactly at the limit reports nothing: nothing
was cut short. The daily download limit keeps applying on top, unchanged.

Co-authored-by: rmcrackan <rmcrackan@gmail.com>
2026-08-14 19:46:47 +00:00

237 lines
8.0 KiB
C#

using ApplicationServices;
using AudibleApi;
using CommandLine;
using DataLayer;
using FileLiberator;
using LibationFileManager;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
namespace LibationCli;
public abstract class ProcessableOptionsBase : OptionsBase
{
[Value(0, MetaName = "[asins]", HelpText = "Optional product IDs (ASINs) of books to process.")]
public IEnumerable<string>? Asins { get; set; }
[Option('i', "id", Required = false, HelpText = "Product ID (ASIN) of a book to process. Repeatable. Same as positional [asins].")]
public IEnumerable<string>? Ids { get; set; }
protected IEnumerable<string> GetProductIds()
=> (Asins ?? []).Concat(Ids ?? []).Select(NormalizeProductId).Where(id => !string.IsNullOrWhiteSpace(id)).Distinct(StringComparer.OrdinalIgnoreCase);
private static string NormalizeProductId(string id) => id.Trim().TrimStart('[').TrimEnd(']');
protected static TProcessable CreateProcessable<TProcessable>(EventHandler<LibraryBook>? completedAction = null)
where TProcessable : Processable, IProcessable<TProcessable>
{
var strProc = TProcessable.Create(Configuration.Instance);
LibraryBook? currentLibraryBook = null;
if (Environment.UserInteractive && !Console.IsOutputRedirected && !Console.IsErrorRedirected)
{
var progressBar = new ConsoleProgressBar(Console.Out);
strProc.Completed += (_, e) => progressBar.Clear();
strProc.StreamingTimeRemaining += (_, e) => progressBar.RemainingTime = e;
strProc.StreamingProgressChanged += (_, e) => progressBar.Progress = e.ProgressPercentage;
}
strProc.Begin += (o, e) =>
{
currentLibraryBook = e;
Console.WriteLine($"{typeof(TProcessable).Name} Begin: {e}");
};
strProc.Completed += (o, e) =>
{
Console.WriteLine($"{typeof(TProcessable).Name} Completed: {e}");
};
strProc.Completed += (s, e) =>
{
try
{
completedAction?.Invoke(s, e);
}
catch (Exception ex)
{
Console.Error.WriteLine("CLI error. See log for more details.");
Serilog.Log.Logger.Error(ex, "CLI error");
}
};
if (strProc is AudioDecodable audDec)
{
audDec.RequestCoverArt += (_, _) =>
{
if (currentLibraryBook is null)
return null;
var pictureId = Configuration.Instance.FileDownloadQuality == Configuration.DownloadQuality.High
? currentLibraryBook.Book.PictureLarge ?? currentLibraryBook.Book.PictureId
: currentLibraryBook.Book.PictureId;
return pictureId is null ? null : PictureStorage.GetPictureSynchronously(new PictureDefinition(pictureId, PictureSize.Native));
};
}
return strProc;
}
/// <summary>How much this run may download before it stops, or null for a verb without a per-run limit.</summary>
protected virtual RunDownloadLimit? RunLimit => null;
protected async Task RunAsync(Processable Processable, Action<LibraryBook>? config = null, Action<string>? notFound = null)
{
var skippedForDailyLimit = 0;
var runLimitReached = false;
// Needs no guard against pdf or convert runs, unlike the daily limit below: the tracker counts only
// audiobook downloads this run recorded, and those verbs record none.
var runLimit = RunLimit is RunDownloadLimit limit ? new RunLimitTracker(limit, DateTimeOffset.Now) : null;
var productIds = GetProductIds().ToArray();
if (productIds.Length > 0)
{
foreach (var asin in productIds)
{
if (DbContexts.GetLibraryBook_Flat_NoTracking(asin, caseSensative: false) is LibraryBook lb)
{
if (!await TryProcessAsync(lb, true))
break;
}
else
{
var msg = $"Book with ASIN '{asin}' not found in library. Skipping.";
Console.Error.WriteLine(msg);
Serilog.Log.Logger.Error(msg);
notFound?.Invoke(asin);
}
}
}
else
{
var libraryBooks = DbContexts.GetLibrary_Flat_NoTracking();
foreach (var lb in Processable.GetValidLibraryBooks(libraryBooks))
{
if (!await TryProcessAsync(lb, false))
break;
}
}
if (skippedForDailyLimit > 0)
{
var summary = DailyDownloadLimitUserMessage.BuildCliSkippedSummary(skippedForDailyLimit);
Console.WriteLine(summary);
Serilog.Log.Logger.Information(summary);
}
var done = runLimitReached
? "Done. Stopped early: this run's download limit was reached."
: "Done. All books have been processed";
Console.WriteLine(done);
Serilog.Log.Logger.Information(done);
// False ends the run. The limit is checked here rather than at the top of the run so that a run whose
// books happen to end exactly at the limit says nothing: nothing was cut short.
async Task<bool> TryProcessAsync(LibraryBook libraryBook, bool validate)
{
if (runLimit is not null && runLimit.TryStop(out var stopMessage))
{
runLimitReached = true;
Console.WriteLine(stopMessage);
Serilog.Log.Logger.Information(stopMessage);
return false;
}
config?.Invoke(libraryBook);
if (IsSkippedByDailyLimit(Processable, libraryBook))
{
skippedForDailyLimit++;
return true;
}
runLimit?.Attempting(libraryBook.Book.AudibleProductId);
await ProcessOneAsync(Processable, libraryBook, validate);
return true;
}
}
protected bool announcedDailyLimit;
/// <summary>
/// True when the user's daily download limit covers this title and has been reached. Unlike the GUI queue the
/// CLI never waits: a command-line run must not sit idle for hours, and in Docker the entrypoint has to return
/// so its own sleep loop keeps working. Skipped titles stay un-liberated and are retried on the next run.
/// </summary>
protected bool IsSkippedByDailyLimit(Processable processable, LibraryBook libraryBook)
{
// Only audiobook downloads are limited, and only titles the configured scope covers, so the common
// case of no limit (or a Plus-only limit against an owned title) costs nothing.
if (processable is not DownloadDecryptBook
|| !DailyDownloadLimit.AppliesTo(libraryBook.IsAudiblePlus, Configuration.Instance))
return false;
var now = DateTimeOffset.Now;
var allowance = DailyDownloadLimit.Evaluate(Configuration.Instance, DownloadHistoryStore.GetCurrentWindow(now), now);
if (!allowance.Blocks(libraryBook.IsAudiblePlus))
return false;
if (!announcedDailyLimit)
{
announcedDailyLimit = true;
foreach (var line in DailyDownloadLimitUserMessage.BuildCliSkippedLines(allowance))
{
Console.Error.WriteLine(line);
Serilog.Log.Logger.Information(line);
}
}
Serilog.Log.Logger.Information(
"Daily download limit reached; skipping {libraryBook}. {@DebugInfo}",
libraryBook.LogFriendly(),
new { allowance.Scope, allowance.Unit, allowance.Quantity, allowance.UsedBooks, allowance.UsedBytes, allowance.NextCapacityAt });
return true;
}
protected async Task ProcessOneAsync(Processable Processable, LibraryBook libraryBook, bool validate)
{
try
{
var statusHandler = await Processable.ProcessSingleAsync(libraryBook, validate);
if (statusHandler.IsSuccess)
return;
foreach (var errorMessage in statusHandler.Errors)
{
Console.Error.WriteLine(errorMessage);
Serilog.Log.Logger.Error(errorMessage);
}
}
catch (ApiErrorException ex) when (WidevineRecommendation.ShouldRecommendWidevine(ex, Configuration.Instance))
{
Console.Error.WriteLine(WidevineRecommendation.BuildLogSummary(libraryBook.Book.TitleWithSubtitle));
Serilog.Log.Logger.Error(ex, "ADRM license unavailable (Sable acr:null) {@DebugInfo}", new { Book = libraryBook.LogFriendly() });
}
catch (ContentLicenseDeniedException clEx)
{
foreach (var line in ContentLicenseDeniedCliSummary.Lines(clEx))
Console.Error.WriteLine(line);
Serilog.Log.Logger.Error(clEx, "Content license denied {@DebugInfo}", new { Book = libraryBook.LogFriendly() });
}
catch (Exception ex)
{
var msg = "Error processing book. Skipping. This book will be tried again on next attempt. For options of skipping or marking as error, retry with main Libation app.";
Console.Error.WriteLine(msg + ". See log for more details.");
Serilog.Log.Logger.Error(ex, $"{msg} {{@DebugInfo}}", new { Book = libraryBook.LogFriendly() });
}
}
}