Skip to content

Usenet streaming with a WebDAV server and a SABnzbd-compatible API

C#

Added setting to perform a database vacuum on nzbdav startup.

nzbdav-dev22976c417ebe
diff --git a/backend/Config/ConfigManager.cs b/backend/Config/ConfigManager.cs
index e4ffde36..fd98775c 100644
--- a/backend/Config/ConfigManager.cs
+++ b/backend/Config/ConfigManager.cs
@@ -269,6 +269,13 @@ public class ConfigManager
?? defaultValue;
}
+ public bool IsDatabaseStartupVacuumEnabled()
+ {
+ var defaultValue = false;
+ var configValue = StringUtil.EmptyToNull(GetConfigValue("db.is-startup-vacuum-enabled"));
+ return (configValue != null ? bool.Parse(configValue) : defaultValue);
+ }
+
public class ConfigEventArgs : EventArgs
{
public required Dictionary<string, string> ChangedConfig { get; init; }
diff --git a/backend/Program.cs b/backend/Program.cs
index f510676b..cca7b0bf 100644
--- a/backend/Program.cs
+++ b/backend/Program.cs
@@ -64,6 +64,7 @@ class Program
await databaseContext.Database
.MigrateAsync(targetMigration, SigtermUtil.GetCancellationToken())
.ConfigureAwait(false);
+ await PerformDatabaseVacuumIfEnabled();
return;
}
@@ -134,7 +135,7 @@ class Program
// If there are no pending database migrations,
// Then the user has already upgraded.
// Do nothing.
- var databaseContext = new DavDatabaseContext();
+ using var databaseContext = new DavDatabaseContext();
var hasPendingMigrations = databaseContext.Database.GetPendingMigrations().Any();
if (!hasPendingMigrations) return;
@@ -156,4 +157,17 @@ class Program
);
Environment.Exit(1);
}
+
+ private static async Task PerformDatabaseVacuumIfEnabled()
+ {
+ var configManager = new ConfigManager();
+ await configManager.LoadConfig().ConfigureAwait(false);
+ if (configManager.IsDatabaseStartupVacuumEnabled())
+ {
+ Console.Write("Performing database vacuum...");
+ await using var databaseContext = new DavDatabaseContext();
+ await databaseContext.Database.ExecuteSqlRawAsync("VACUUM;");
+ Console.WriteLine("Done.");
+ }
+ }
}
\ No newline at end of file
diff --git a/backend/Tasks/RemoveUnlinkedFilesTask.cs b/backend/Tasks/RemoveUnlinkedFilesTask.cs
index 384ab9b2..2516e4ba 100644
--- a/backend/Tasks/RemoveUnlinkedFilesTask.cs
+++ b/backend/Tasks/RemoveUnlinkedFilesTask.cs
@@ -65,7 +65,7 @@ public class RemoveUnlinkedFilesTask(
private async Task<int> WriteLinkedIdsToTable()
{
- var dbContext = new DavDatabaseContext();
+ await using var dbContext = new DavDatabaseContext();
// Create a new table "TMP_LINKED_FILES", dropping old one if it already exists.
// No index initially for fast writes.
@@ -119,7 +119,7 @@ public class RemoveUnlinkedFilesTask(
private async Task<int> CountUnlinkedItems(DateTime createdBefore)
{
- var dbContext = new DavDatabaseContext();
+ await using var dbContext = new DavDatabaseContext();
var createdBeforeStr = createdBefore.ToString("yyyy-MM-dd HH:mm:ss");
var usenetFileType = (int)DavItem.ItemType.UsenetFile;
@@ -142,7 +142,7 @@ public class RemoveUnlinkedFilesTask(
{
Report("Removing unlinked items...");
_allRemovedPaths.Clear();
- var dbContext = new DavDatabaseContext();
+ await using var dbContext = new DavDatabaseContext();
var removed = 0;
while (true)
@@ -189,7 +189,7 @@ public class RemoveUnlinkedFilesTask(
private async Task RemoveEmptyDirectories(DateTime createdBefore)
{
Report($"Removing empty directories...");
- var dbContext = new DavDatabaseContext();
+ await using var dbContext = new DavDatabaseContext();
var removed = 0;
while (true)
@@ -230,7 +230,7 @@ public class RemoveUnlinkedFilesTask(
private async Task DryRunIdentifyUnlinkedFiles(DateTime createdBefore)
{
- var dbContext = new DavDatabaseContext();
+ await using var dbContext = new DavDatabaseContext();
var unlinkedFiles = await dbContext.Database
.SqlQueryRaw<UnlinkedItemInfo>(
$"""
diff --git a/frontend/app/routes/settings/maintenance/maintenance.module.css b/frontend/app/routes/settings/maintenance/maintenance.module.css
index 072ebbcf..f32ad295 100644
--- a/frontend/app/routes/settings/maintenance/maintenance.module.css
+++ b/frontend/app/routes/settings/maintenance/maintenance.module.css
@@ -1,7 +1,15 @@
-.container {
+.tasksContainer {
max-width: 600px;
}
+.settingsContainer {
+ max-width: 400px;
+}
+
+.input {
+ margin-bottom: 8px;
+}
+
.accordionItem {
border: 1px solid rgba(255, 255, 255, 0.01);
overflow: hidden;
diff --git a/frontend/app/routes/settings/maintenance/maintenance.module.css.d.ts b/frontend/app/routes/settings/maintenance/maintenance.module.css.d.ts
index f8a24096..18c32f9e 100644
--- a/frontend/app/routes/settings/maintenance/maintenance.module.css.d.ts
+++ b/frontend/app/routes/settings/maintenance/maintenance.module.css.d.ts
@@ -1,6 +1,7 @@
declare const styles: {
- readonly "container": string;
- readonly "accordion": string;
+ readonly "tasksContainer": string;
+ readonly "settingsContainer": string;
+ readonly "input": string;
readonly "accordionItem": string;
readonly "accordionHeader": string;
readonly "accordionBody": string;
diff --git a/frontend/app/routes/settings/maintenance/maintenance.tsx b/frontend/app/routes/settings/maintenance/maintenance.tsx
index f0050266..3f3ec813 100644
--- a/frontend/app/routes/settings/maintenance/maintenance.tsx
+++ b/frontend/app/routes/settings/maintenance/maintenance.tsx
@@ -1,48 +1,67 @@
-import { Accordion } from "react-bootstrap";
+import { Accordion, Form } from "react-bootstrap";
import styles from "./maintenance.module.css"
import { RemoveUnlinkedFiles } from "./remove-unlinked-files/remove-unlinked-files";
import { ConvertStrmToSymlinks } from "./strm-to-symlinks/strm-to-symlinks";
import { MigrateDatabaseFilesToBlobstore } from "./migrate-database-files-to-blobstore/migrate-database-files-to-blobstore";
+import type { Dispatch, SetStateAction } from "react";
type MaintenanceProps = {
- savedConfig: Record<string, string>
+ savedConfig: Record<string, string>,
+ config: Record<string, string>,
+ setNewConfig: Dispatch<SetStateAction<Record<string, string>>>,
};
-export function Maintenance({ savedConfig }: MaintenanceProps) {
+export function Maintenance({ savedConfig, config, setNewConfig }: MaintenanceProps) {
return (
- <div className={styles.container}>
- <Accordion className={styles.accordion}>
-
- <Accordion.Item className={styles.accordionItem} eventKey="remove-unlinked-files">
- <Accordion.Header className={styles.accordionHeader}>
- Remove Orphaned Files
- </Accordion.Header>
- <Accordion.Body className={styles.accordionBody}>
- <RemoveUnlinkedFiles savedConfig={savedConfig} />
- </Accordion.Body>
- </Accordion.Item>
-
-
- <Accordion.Item className={styles.accordionItem} eventKey="strm-to-symlinks">
- <Accordion.Header className={styles.accordionHeader}>
- Convert Strm Files to Symlnks
- </Accordion.Header>
- <Accordion.Body className={styles.accordionBody}>
- <ConvertStrmToSymlinks savedConfig={savedConfig} />
- </Accordion.Body>
- </Accordion.Item>
-
-
- <Accordion.Item className={styles.accordionItem} eventKey="migrate-database-files-to-blobstore">
- <Accordion.Header className={styles.accordionHeader}>
- Migrate Large Database Blobs to Blobstore
- </Accordion.Header>
- <Accordion.Body className={styles.accordionBody}>
- <MigrateDatabaseFilesToBlobstore savedConfig={savedConfig} />
- </Accordion.Body>
- </Accordion.Item>
-
- </Accordion>
+ <div>
+ <div className={styles.settingsContainer}>
+ <Form.Group>
+ <Form.Check
+ className={styles.input}
+ type="checkbox"
+ id="db-startup-vacuum-enabled-checkbox"
+ aria-describedby="db-startup-vacuum-enabled-help"
+ label="Perform Database Vacuum on Start"
+ checked={config["db.is-startup-vacuum-enabled"] === "true"}
+ onChange={e => setNewConfig({ ...config, "db.is-startup-vacuum-enabled": "" + e.target.checked })} />
+ <Form.Text id="db-startup-vacuum-enabled-help" muted>
+ When enabled, nzbdav will run a SQLite VACUUM on the database at every startup. This reclaims unused disk space and can improve query performance over time, but may increase startup time for large databases.
+ </Form.Text>
+ </Form.Group>
+ </div>
+ <div className={styles.tasksContainer}>
+ <hr />
+ <Accordion>
+ <Accordion.Item className={styles.accordionItem} eventKey="remove-unlinked-files">
+ <Accordion.Header className={styles.accordionHeader}>
+ Remove Orphaned Files
+ </Accordion.Header>
+ <Accordion.Body className={styles.accordionBody}>
+ <RemoveUnlinkedFiles savedConfig={savedConfig} />
+ </Accordion.Body>
+ </Accordion.Item>
+ <Accordion.Item className={styles.accordionItem} eventKey="strm-to-symlinks">
+ <Accordion.Header className={styles.accordionHeader}>
+ Convert Strm Files to Symlnks
+ </Accordion.Header>
+ <Accordion.Body className={styles.accordionBody}>
+ <ConvertStrmToSymlinks savedConfig={savedConfig} />
+ </Accordion.Body>
+ </Accordion.Item>
+ <Accordion.Item className={styles.accordionItem} eventKey="migrate-database-files-to-blobstore">
+ <Accordion.Header className={styles.accordionHeader}>
+ Migrate Large Database Blobs to Blobstore
+ </Accordion.Header>
+ <Accordion.Body className={styles.accordionBody}>
+ <MigrateDatabaseFilesToBlobstore savedConfig={savedConfig} />
+ </Accordion.Body>
+ </Accordion.Item>
+ </Accordion>
+ </div>
</div>
);
+}
+
+export function isMaintenanceSettingsUpdated(config: Record<string, string>, newConfig: Record<string, string>) {
+ return config["db.is-startup-vacuum-enabled"] !== newConfig["db.is-startup-vacuum-enabled"];
}
\ No newline at end of file
diff --git a/frontend/app/routes/settings/route.tsx b/frontend/app/routes/settings/route.tsx
index ef4295e7..e11c581e 100644
--- a/frontend/app/routes/settings/route.tsx
+++ b/frontend/app/routes/settings/route.tsx
@@ -6,7 +6,7 @@ import { isUsenetSettingsUpdated, UsenetSettings } from "./usenet/usenet";
import { isSabnzbdSettingsUpdated, isSabnzbdSettingsValid, SabnzbdSettings } from "./sabnzbd/sabnzbd";
import { isWebdavSettingsUpdated, isWebdavSettingsValid, WebdavSettings } from "./webdav/webdav";
import { isArrsSettingsUpdated, isArrsSettingsValid, ArrsSettings } from "./arrs/arrs";
-import { Maintenance } from "./maintenance/maintenance";
+import { isMaintenanceSettingsUpdated, Maintenance } from "./maintenance/maintenance";
import { isRepairsSettingsUpdated, RepairsSettings } from "./repairs/repairs";
import { isRcloneSettingsUpdated, RcloneSettings } from "./rclone/rclone";
import { useCallback, useState } from "react";
@@ -43,6 +43,7 @@ const defaultConfig = {
"media.library-dir": "",
"arr.instances": "{\"RadarrInstances\":[],\"SonarrInstances\":[],\"QueueRules\":[]}",
"repair.enable": "false",
+ "db.is-startup-vacuum-enabled": "false",
}
export async function loader({ request }: Route.LoaderArgs) {
@@ -87,7 +88,8 @@ function Body(props: BodyProps) {
const isArrsUpdated = isArrsSettingsUpdated(config, newConfig);
const isRepairsUpdated = isRepairsSettingsUpdated(config, newConfig);
const isRcloneUpdated = isRcloneSettingsUpdated(config, newConfig);
- const isUpdated = iseUsenetUpdated || isSabnzbdUpdated || isWebdavUpdated || isArrsUpdated || isRepairsUpdated || isRcloneUpdated;
+ const isMaintenanceUpdated = isMaintenanceSettingsUpdated(config, newConfig);
+ const isUpdated = iseUsenetUpdated || isSabnzbdUpdated || isWebdavUpdated || isArrsUpdated || isRepairsUpdated || isRcloneUpdated || isMaintenanceUpdated;
const navigationBlocker = useNavigationBlocker(isUpdated);
const usenetTitle = iseUsenetUpdated ? "✏️ Usenet" : "Usenet";
@@ -96,6 +98,7 @@ function Body(props: BodyProps) {
const arrsTitle = isArrsUpdated ? "✏️ Radarr/Sonarr" : "Radarr/Sonarr";
const repairsTitle = isRepairsUpdated ? "✏️ Repairs" : "Repairs";
const rcloneTitle = isRcloneUpdated ? "✏️ Rclone Server" : "Rclone Server";
+ const maintenanceTitle = isMaintenanceUpdated ? "✏️ Maintenance" : "Maintenance";
const saveButtonLabel = isSaving ? "Saving..."
: !isUpdated && isSaved ? "Saved ✅"
@@ -159,8 +162,8 @@ function Body(props: BodyProps) {
<Tab eventKey="rclone" title={rcloneTitle}>
<RcloneSettings config={newConfig} setNewConfig={setNewConfig} />
</Tab>
- <Tab eventKey="maintenance" title="Maintenance">
- <Maintenance savedConfig={config} />
+ <Tab eventKey="maintenance" title={maintenanceTitle}>
+ <Maintenance savedConfig={config} config={newConfig} setNewConfig={setNewConfig} />
</Tab>
</Tabs>
<hr />