Skip to content

A self-hosted media server and file management system

feat: api and ui for file scanner config

aminnausin4a8a37374bc6
diff --git a/app/Casts/ServerConfigValue.php b/app/Casts/ServerConfigValue.php
new file mode 100644
index 00000000..970a6f90
--- /dev/null
+++ b/app/Casts/ServerConfigValue.php
@@ -0,0 +1,24 @@
+<?php
+
+namespace App\Casts;
+
+use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
+
+class ServerConfigValue implements CastsAttributes {
+ public function get($model, string $key, mixed $value, array $attributes): mixed {
+ return match ($attributes['type']) {
+ 'bool' => (bool) $value,
+ 'integer' => (int) $value,
+ 'float' => (float) $value,
+ 'array' => json_decode($value, true),
+ default => $value,
+ };
+ }
+
+ public function set($model, string $key, mixed $value, array $attributes): mixed {
+ return match ($attributes['type']) {
+ 'array' => json_encode($value),
+ default => $value,
+ };
+ }
+}
diff --git a/app/Http/Resources/Server/ServerConfigResource.php b/app/Http/Resources/Server/ServerConfigResource.php
index b4bc3fb9..43655656 100644
--- a/app/Http/Resources/Server/ServerConfigResource.php
+++ b/app/Http/Resources/Server/ServerConfigResource.php
@@ -13,9 +13,8 @@ class ServerConfigResource extends JsonResource {
*/
public function toArray(Request $request): array {
return [
- 'key' => $this->key,
- 'value' => json_decode($this->value, true),
- 'default_value' => json_decode($this->default_value, true),
+ 'value' => $this->value,
+ 'default_value' => $this->default_value,
'type' => $this->type,
'group' => $this->group,
];
diff --git a/resources/js/components/settings/SettingToggleRow.vue b/resources/js/components/settings/SettingToggleRow.vue
index 1637df77..7a7efe46 100644
--- a/resources/js/components/settings/SettingToggleRow.vue
+++ b/resources/js/components/settings/SettingToggleRow.vue
@@ -1,4 +1,6 @@
<script setup lang="ts">
+import { FormErrorList } from '@/components/cedar-ui/form';
+
import SettingsFormLabel from '@/components/settings/SettingsFormLabel.vue';
import ToggleBase from '@/components/inputs/ToggleBase.vue';
@@ -7,6 +9,7 @@ defineProps<{
label: string;
description?: string;
disabled?: boolean;
+ errors: Record<string, any>;
}>();
const model = defineModel<boolean>();
@@ -17,9 +20,10 @@ const model = defineModel<boolean>();
<SettingsFormLabel :for="id" :text="label" :subtext="description" class="my-auto cursor-pointer" />
<div :class="['flex shrink-0 items-center gap-2', { 'pt-0.5': description }]">
<ToggleBase v-model="model" :name="id" class="h-6 w-12 shrink-0 rounded-full dark:border-neutral-700/70 dark:has-checked:border-neutral-700" />
- <p class="text-foreground-1 w-7 shrink-0 text-end text-xs font-medium uppercase">
+ <p :class="['text-foreground-1 w-7 shrink-0 text-end text-xs font-medium uppercase']">
{{ model ? 'On' : 'Off' }}
</p>
</div>
</div>
+ <FormErrorList :errors="errors" :field-name="id" />
</template>
diff --git a/resources/js/components/settings/server/SettingsServerIndexing.vue b/resources/js/components/settings/server/SettingsServerIndexing.vue
index 445c15ae..3e15395f 100644
--- a/resources/js/components/settings/server/SettingsServerIndexing.vue
+++ b/resources/js/components/settings/server/SettingsServerIndexing.vue
@@ -1,87 +1,127 @@
<script setup lang="ts">
+import type { ScannerConfigRequest } from '@/contracts/server';
+
+import { UseUpdateScannerConfig } from '@/service/server/mutations';
import { toast, useForm } from '@aminnausin/cedar-ui';
+import { FormErrorList } from '@/components/cedar-ui/form';
+import { useGetConfig } from '@/service/server/queries';
import { ButtonForm } from '@/components/cedar-ui/button';
+import { watch } from 'vue';
import SettingToggleRow from '@/components/settings/SettingToggleRow.vue';
import SettingsHeader from '@/components/settings/SettingsHeader.vue';
import SettingsCard from '@/components/cards/layout/SettingsCard.vue';
-const mediaAPI = {
- updateServerConfig: async (type: string, data: any) => {},
-};
-
-interface ScannerConfigRequest {
- embed_uuid: boolean;
- embed_uuid_cache: boolean;
- extract_attachments: boolean;
- extract_thumbnails: boolean;
- extract_art: boolean;
-}
+const { data: serverConfig, isLoading } = useGetConfig();
+const saveConfig = UseUpdateScannerConfig();
const form = useForm<ScannerConfigRequest>({
- embed_uuid: false,
- embed_uuid_cache: false,
- extract_attachments: true,
- extract_thumbnails: true,
- extract_art: true,
+ uuid_embed: false,
+ uuid_write_cache: false,
+ attachments_extract: false,
+ thumbnails_generate: false,
+ art_extract: false,
});
const handleSaveScanner = () => {
- form.submit((fields) => mediaAPI.updateServerConfig('scanner', fields), {
+ form.submit((fields) => saveConfig.mutateAsync(fields), {
onSuccess: () => toast.success('Scanner settings saved.'),
onError: () => toast.error('Failed to save scanner settings.'),
});
};
+
+const resetForm = (config?: ScannerConfigRequest) => {
+ if (!config) return;
+ form.fields = { ...config };
+};
+
+watch(
+ serverConfig,
+ (config) => {
+ if (!config?.values.scanner) return;
+ resetForm(config.values.scanner);
+ },
+ { immediate: true },
+);
</script>
<template>
- <SettingsCard class="flex-col gap-6">
- <SettingsHeader>
- <h3 class="text-base font-medium">File Scanner</h3>
- <p class="text-foreground-2">Control what gets extracted when files are indexed.</p>
- </SettingsHeader>
-
- <div class="divide-d space-y-4 divide-y *:pb-4 *:last:pb-0">
- <SettingToggleRow
- id="embed-uuid"
- label="Embed UUID in files"
- description="Links files to persistent metadata in the database. Increases index time and re-writes each file to disk."
- v-model="form.fields.embed_uuid"
- />
-
- <SettingToggleRow
- id="embed-uuid-cache"
- label="Use cache for UUID writes"
- description="Write temporary files to cache. Improves index speed when cache is on an SSD."
- v-model="form.fields.embed_uuid_cache"
- :disabled="!form.fields.embed_uuid"
- />
-
- <SettingToggleRow
- id="extract-attachments"
- label="Extract embedded attachments"
- description="Automatically extract fonts and subtitle files at index time."
- v-model="form.fields.extract_attachments"
- />
-
- <SettingToggleRow
- id="extract-thumbnails"
- label="Generate thumbnails"
- description="Automatically generate thumbnails at index time."
- v-model="form.fields.extract_thumbnails"
- />
-
- <SettingToggleRow
- id="extract-art"
- label="Extract album art"
- description="Automatically extract album art from music at index time."
- v-model="form.fields.extract_art"
- />
- </div>
-
- <div class="flex justify-end gap-2 *:h-8">
- <ButtonForm @click="form.reset(...Object.keys(form.fields))" type="button" variant="reset" :disabled="form.processing"> Reset </ButtonForm>
- <ButtonForm variant="submit" :disabled="form.processing" @click="handleSaveScanner"> Save </ButtonForm>
- </div>
+ <SettingsCard :class="['flex-col gap-6', { 'animate-pulse': isLoading }]">
+ <template v-if="isLoading">
+ <div>
+ <div class="mb-1 h-6 w-32 rounded bg-neutral-200 dark:bg-neutral-700" />
+ <div class="mb-5 h-5 w-72 rounded bg-neutral-200/70 dark:bg-neutral-700/50" />
+ </div>
+
+ <div v-for="i in 5" :key="i" class="divide-d flex items-center justify-between">
+ <div class="space-y-1.5">
+ <div class="h-5 w-96 max-w-2/3 rounded bg-neutral-200 dark:bg-neutral-700" />
+ <div class="h-3 w-4/5 rounded bg-neutral-200/70 dark:bg-neutral-700/50" />
+ </div>
+ <div class="h-5 w-9 rounded-full bg-neutral-300 dark:bg-neutral-600" />
+ </div>
+
+ <div class="mt-4 flex justify-end gap-2">
+ <div class="h-8 w-16 rounded-md bg-neutral-300 dark:bg-neutral-700" />
+ <div class="h-8 w-14 rounded-md bg-neutral-300 dark:bg-neutral-700" />
+ </div>
+ </template>
+
+ <template v-else>
+ <SettingsHeader>
+ <h3 class="text-base font-medium">File Scanner</h3>
+ <p class="text-foreground-2">Control what gets extracted when files are indexed.</p>
+ </SettingsHeader>
+
+ <div class="divide-d space-y-4 divide-y *:pb-4 *:last:pb-0">
+ <SettingToggleRow
+ id="uuid_embed"
+ label="Embed UUID in files"
+ description="Links files to persistent metadata in the database. Increases index time and re-writes each file to disk."
+ v-model="form.fields.uuid_embed"
+ :errors="form.errors"
+ />
+
+ <SettingToggleRow
+ id="uuid_write_cache"
+ label="Use cache for UUID writes"
+ description="Write temporary files to cache. Improves index speed when cache is on an SSD."
+ v-model="form.fields.uuid_write_cache"
+ :disabled="!form.fields.uuid_embed"
+ :errors="form.errors"
+ />
+
+ <SettingToggleRow
+ id="attachments_extract"
+ label="Extract embedded attachments"
+ description="Automatically extract fonts and subtitle files at index time."
+ v-model="form.fields.attachments_extract"
+ :errors="form.errors"
+ />
+
+ <SettingToggleRow
+ id="thumbnails_generate"
+ label="Generate thumbnails"
+ description="Automatically generate thumbnails at index time."
+ v-model="form.fields.thumbnails_generate"
+ :errors="form.errors"
+ />
+
+ <SettingToggleRow
+ id="art_extract"
+ label="Extract album art"
+ description="Automatically extract album art from music at index time."
+ v-model="form.fields.art_extract"
+ :errors="form.errors"
+ />
+ </div>
+
+ <FormErrorList :errors="form.errors" />
+
+ <div class="flex justify-end gap-2 *:h-8">
+ <ButtonForm @click="resetForm(serverConfig?.values.scanner)" type="button" variant="reset" :disabled="form.processing"> Reset </ButtonForm>
+ <ButtonForm variant="submit" :disabled="form.processing" @click="handleSaveScanner"> Save </ButtonForm>
+ </div>
+ </template>
</SettingsCard>
</template>
diff --git a/resources/js/service/server/mutations.ts b/resources/js/service/server/mutations.ts
new file mode 100644
index 00000000..3904d7f4
--- /dev/null
+++ b/resources/js/service/server/mutations.ts
@@ -0,0 +1,50 @@
+import { updateMediaConfig, updatePerformanceConfig, updateScannerConfig, updateStorageConfig } from '@/service/server/serverConfig';
+import { useMutation, useQueryClient } from '@tanstack/vue-query';
+
+export const UseUpdateScannerConfig = () => {
+ const queryClient = useQueryClient();
+ return useMutation({
+ mutationFn: updateScannerConfig,
+ onSettled: async () => {
+ await queryClient.invalidateQueries({
+ queryKey: ['serverConfig'],
+ });
+ },
+ });
+};
+
+export const UseUpdateStorageConfig = () => {
+ const queryClient = useQueryClient();
+ return useMutation({
+ mutationFn: updateStorageConfig,
+ onSettled: async () => {
+ await queryClient.invalidateQueries({
+ queryKey: ['serverConfig'],
+ });
+ },
+ });
+};
+
+export const UseUpdateMediaConfig = () => {
+ const queryClient = useQueryClient();
+ return useMutation({
+ mutationFn: updateMediaConfig,
+ onSettled: async () => {
+ await queryClient.invalidateQueries({
+ queryKey: ['serverConfig'],
+ });
+ },
+ });
+};
+
+export const UseUpdatePerformanceConfig = () => {
+ const queryClient = useQueryClient();
+ return useMutation({
+ mutationFn: updatePerformanceConfig,
+ onSettled: async () => {
+ await queryClient.invalidateQueries({
+ queryKey: ['serverConfig'],
+ });
+ },
+ });
+};
diff --git a/resources/js/service/server/queries.ts b/resources/js/service/server/queries.ts
new file mode 100644
index 00000000..7530679e
--- /dev/null
+++ b/resources/js/service/server/queries.ts
@@ -0,0 +1,15 @@
+import type { ServerConfig } from '@/contracts/server';
+
+import { getServerConfig } from '@/service/server/serverConfig';
+import { useQuery } from '@tanstack/vue-query';
+
+export const useGetConfig = () => {
+ return useQuery<ServerConfig>({
+ queryKey: ['serverConfig'],
+ queryFn: async () => {
+ const { data: response } = await getServerConfig();
+ return response;
+ },
+ retry: false,
+ });
+};
diff --git a/resources/js/service/server/serverConfig.ts b/resources/js/service/server/serverConfig.ts
new file mode 100644
index 00000000..ab7e763b
--- /dev/null
+++ b/resources/js/service/server/serverConfig.ts
@@ -0,0 +1,25 @@
+import type { MediaConfigRequest, PerformanceConfigRequest, ScannerConfigRequest, StorageConfigRequest } from '@/contracts/server';
+
+import { API } from '@/service/api';
+
+export const getServerConfig = () => {
+ return API.get(`/config`);
+};
+
+export const updateScannerConfig = (data: ScannerConfigRequest) => {
+ console.log(data);
+
+ return API.patch('/config/scanner', data);
+};
+
+export const updateStorageConfig = (data: StorageConfigRequest) => {
+ return API.patch('/config/storage', data);
+};
+
+export const updatePerformanceConfig = (data: PerformanceConfigRequest) => {
+ return API.patch('/config/performance', data);
+};
+
+export const updateMediaConfig = (data: MediaConfigRequest) => {
+ return API.patch('/config/media', data);
+};