Skip to content

A self-hosted media server and file management system

feat: toggle storyboard flag on library

aminnausin5741674617ef
diff --git a/app/Http/Controllers/Api/V1/CategoryController.php b/app/Http/Controllers/Api/V1/CategoryController.php
index 063113f9..620c766d 100755
--- a/app/Http/Controllers/Api/V1/CategoryController.php
+++ b/app/Http/Controllers/Api/V1/CategoryController.php
@@ -3,7 +3,6 @@
namespace App\Http\Controllers\Api\V1;
use App\Http\Controllers\Controller;
-use App\Http\Requests\CategoryPrivacyUpdateRequest;
use App\Http\Requests\CategoryUpdateRequest;
use App\Http\Resources\CategoryResource;
use App\Models\Category;
@@ -45,7 +44,6 @@ class CategoryController extends Controller {
* Display the specified resource.
* Get Category with count of folders with the category id
*
- * @param int $category_id
* @return \Illuminate\Http\Response
*/
public function show(Category $category) {
@@ -56,10 +54,8 @@ class CategoryController extends Controller {
/**
* Update the specified resource in storage.
- *
- * @param int $category_id
*/
- public function update(CategoryUpdateRequest $request, Category $category) {
+ public function setDefaultFolder(CategoryUpdateRequest $request, Category $category) {
if (Auth::id() !== 1) {
return $this->forbidden();
}
@@ -78,40 +74,18 @@ class CategoryController extends Controller {
return $this->success($validated);
}
- /**
- * Update the specified resource in storage.
- *
- * @param int $category_id
- */
- public function updatePrivacySettings(CategoryPrivacyUpdateRequest $request, Category $category) {
- if (Auth::id() !== 1) {
- return $this->forbidden();
- }
-
- $validated = $request->validated();
- $category->is_private = $validated['is_private'] ?? $category->is_private;
- $category->editor_id = Auth::id();
- $category->save();
-
- return $this->success($validated);
- }
-
- /**
- * Update the specified resource in storage.
- *
- * @param int $category_id
- */
- public function updateDownloadSettings(Request $request, Category $category) {
- if (Auth::id() !== 1) {
- return $this->forbidden();
- }
+ public function updateSettings(Request $request, Category $category) {
+ $this->authorize('admin');
$validated = $request->validate([
+ 'is_private' => 'sometimes|boolean',
'downloads_enabled' => 'sometimes|boolean',
'downloads_require_auth' => 'sometimes|boolean',
+ 'storyboard_enabled' => 'sometimes|boolean',
]);
- $category->update($validated);
- return response($category->only(['downloads_enabled', 'downloads_require_auth']));
+ $category->update(array_merge($validated, ['editor_id' => Auth::id()]));
+
+ return response($category->only(array_keys($validated)));
}
}
diff --git a/app/Http/Resources/CategoryResource.php b/app/Http/Resources/CategoryResource.php
index 5ee0e750..e5e5ef8b 100755
--- a/app/Http/Resources/CategoryResource.php
+++ b/app/Http/Resources/CategoryResource.php
@@ -4,7 +4,7 @@ namespace App\Http\Resources;
use Illuminate\Http\Request;
use Illuminate\Http\Resources\Json\JsonResource;
-use Illuminate\Support\Facades\Auth;
+use Illuminate\Support\Facades\Gate;
class CategoryResource extends JsonResource {
/**
@@ -27,7 +27,7 @@ class CategoryResource extends JsonResource {
return $folder->series->total_size;
});
- $authenticatedRequest = Auth::id() === 1;
+ $authenticatedRequest = Gate::allows('admin');
return [
'id' => $this->id,
@@ -42,6 +42,7 @@ class CategoryResource extends JsonResource {
'is_private' => $authenticatedRequest ? $this->is_private : false,
'downloads_enabled' => $authenticatedRequest ? $this->downloads_enabled : false,
'downloads_require_auth' => $authenticatedRequest ? $this->downloads_require_auth : true,
+ 'storyboard_enabled' => $this->storyboard_enabled,
];
}
}
diff --git a/app/Jobs/VerifyFiles.php b/app/Jobs/VerifyFiles.php
index 7bfc4f1e..38d1660c 100755
--- a/app/Jobs/VerifyFiles.php
+++ b/app/Jobs/VerifyFiles.php
@@ -345,7 +345,7 @@ class VerifyFiles extends ManagedSubTask {
// If no storyboard and storyboard_scanned_at is null OR storyboard was scanned before file was last modified or file was just updated
$needsStoryboard = $fileUpdated || (! $metadata->storyboard_scanned_at && ! $metadata->storyboard) || $metadata->storyboard_scanned_at?->lt($metadata->file_modified_at);
- if ($this->generateImageTasks && ! $is_audio && ($needsStoryboard)) {
+ if ($this->generateImageTasks && ! $is_audio && $video->folder->category->storyboard_enabled && ($needsStoryboard)) {
$this->storyboardChain[] = new GenerateStoryboard(
filePath: $filePath,
uuid: $uuid,
diff --git a/app/Models/Category.php b/app/Models/Category.php
index 81674b24..1afbfa32 100755
--- a/app/Models/Category.php
+++ b/app/Models/Category.php
@@ -13,11 +13,21 @@ class Category extends Model {
public $timestamps = false;
- protected $fillable = ['name', 'default_folder_id', 'editor_id', 'downloads_enabled', 'downloads_require_auth'];
+ protected $fillable = [
+ 'name',
+ 'default_folder_id',
+ 'editor_id',
+ 'downloads_enabled',
+ 'downloads_require_auth',
+ 'storyboard_enabled',
+ 'is_private',
+ ];
protected $casts = [
+ 'is_private' => 'boolean',
'downloads_enabled' => 'boolean',
'downloads_require_auth' => 'boolean',
+ 'storyboard_enabled' => 'boolean',
];
public function folders(): HasMany {
@@ -39,4 +49,8 @@ class Category extends Model {
public function downloadsEnabled(): bool {
return $this->downloads_enabled;
}
+
+ public function storyboardEnabled(): bool {
+ return $this->storyboard_enabled;
+ }
}
diff --git a/app/Services/FileJobService.php b/app/Services/FileJobService.php
index c310d1b9..c18a1e55 100644
--- a/app/Services/FileJobService.php
+++ b/app/Services/FileJobService.php
@@ -104,7 +104,7 @@ class FileJobService {
chain: function ($task) use ($category) {
$chain = [];
- $videoQuery = Video::orderBy('id')->with(['metadata.storyboard']);
+ $videoQuery = Video::orderBy('id')->with(['metadata.storyboard', 'folder.category']);
$folderQuery = Folder::orderBy('id');
if ($category) {
@@ -277,15 +277,16 @@ class FileJobService {
$query = Metadata::query()
->select('metadata.*', 'videos.path as video_path')
->join('videos', 'videos.id', '=', 'metadata.video_id')
+ ->join('folders', 'folders.id', '=', 'videos.folder_id')
+ ->join('categories', 'categories.id', '=', 'folders.category_id')
->where('metadata.media_type', MediaType::VIDEO)
->whereNotNull('metadata.uuid')
->whereDoesntHave('storyboard')
+ ->where('categories.storyboard_enabled', true)
->latest('metadata.updated_at');
if ($category) {
- $query->join('folders', 'folders.id', '=', 'videos.folder_id')
- ->join('categories', 'categories.id', '=', 'folders.category_id')
- ->where('categories.id', $category->id);
+ $query->where('categories.id', $category->id);
}
$limit = config('media.storyboard.daily_limit', 200);
diff --git a/database/migrations/2026_05_24_221149_add_storyboard_flag_to_categories.php b/database/migrations/2026_05_24_221149_add_storyboard_flag_to_categories.php
new file mode 100644
index 00000000..d79ae041
--- /dev/null
+++ b/database/migrations/2026_05_24_221149_add_storyboard_flag_to_categories.php
@@ -0,0 +1,25 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration {
+ /**
+ * Run the migrations.
+ */
+ public function up(): void {
+ Schema::table('categories', function (Blueprint $table) {
+ $table->boolean('storyboard_enabled')->default(false);
+ });
+ }
+
+ /**
+ * Reverse the migrations.
+ */
+ public function down(): void {
+ Schema::table('categories', function (Blueprint $table) {
+ $table->dropColumn(['storyboard_enabled']);
+ });
+ }
+};
diff --git a/resources/js/components/cards/data/LibraryCard.vue b/resources/js/components/cards/data/LibraryCard.vue
index 21a5883b..2ba2b2da 100644
--- a/resources/js/components/cards/data/LibraryCard.vue
+++ b/resources/js/components/cards/data/LibraryCard.vue
@@ -1,11 +1,11 @@
<script setup lang="ts">
import type { CategoryResource, FolderResource } from '@/types/resources';
-import { setLibraryDownloadSettings, startScanFilesTask, startVerifyFilesTask, toggleCategoryPrivacy } from '@/service/siteAPI';
+import { updateLibrarySettings, updateLibraryDefaultFolder } from '@/service/mediaAPI';
import { formatFileSize, handleStorageURL, toFormattedDate } from '@/service/util';
+import { startScanFilesTask, startVerifyFilesTask } from '@/service/siteAPI';
import { computed, ref, useTemplateRef, watch } from 'vue';
import { useQueryClient } from '@tanstack/vue-query';
-import { updateCategory } from '@/service/mediaAPI.ts';
import { BasePopover } from '@/components/cedar-ui/popover';
import { ButtonIcon } from '@/components/cedar-ui/button';
import { HoverCard } from '@/components/cedar-ui/hover-card';
@@ -36,20 +36,13 @@ const handleSetDefaultFolder = async (newFolder: { value: number }) => {
try {
processing.value = true;
-
- await updateCategory(props.data.id, { default_folder_id: newFolder.value });
-
- await queryClient.invalidateQueries({
- queryKey: ['categories'],
- });
-
- toast.success(`Default folder set to ${defaultFolder.value?.title}.`);
-
- processing.value = false;
+ await updateLibraryDefaultFolder(props.data.id, { default_folder_id: newFolder.value });
+ await queryClient.invalidateQueries({ queryKey: ['categories'] });
+ toast.success(`Default folder set to ${defaultFolder.value?.title}`);
} catch (error) {
- console.log(error);
toast('Unable to set Default Folder', { type: 'danger', description: `${error}` });
-
+ console.error(error);
+ } finally {
processing.value = false;
}
};
@@ -72,56 +65,22 @@ const handleStartScan = async (verifyOnly: boolean = false) => {
}
};
-const handleTogglePrivacy = async (id: number, currentValue: boolean) => {
- if (processing.value || !props.data?.id || currentValue !== props.data.is_private) return;
+const handleToggleSetting = async (
+ setting: keyof Pick<CategoryResource, 'is_private' | 'downloads_enabled' | 'downloads_require_auth' | 'storyboard_enabled'>,
+ currentValue: boolean,
+ successMessage: (newValue: boolean) => string,
+) => {
+ if (processing.value || !props.data?.id || currentValue !== props.data[setting]) return;
try {
processing.value = true;
-
- await toggleCategoryPrivacy(id, !currentValue);
+ await updateLibrarySettings(props.data.id, { [setting]: !currentValue });
await queryClient.invalidateQueries({ queryKey: ['categories'] });
-
- toast.success(`Library set to ${currentValue ? 'Public' : 'Private'}.`);
- processing.value = false;
- } catch (error) {
- toast('Failure', { type: 'danger', description: 'Unable to set privacy. You may not have permission to set the privacy of libraries.' });
- console.error(error);
- processing.value = false;
- }
-};
-
-const handleToggleDownloads = async (id: number, currentValue: boolean) => {
- if (processing.value || !props.data?.id || currentValue !== props.data.downloads_enabled) return;
-
- try {
- processing.value = true;
-
- await setLibraryDownloadSettings(id, { downloads_enabled: !currentValue });
- await queryClient.invalidateQueries({ queryKey: ['categories'] });
-
- toast.success(`${currentValue ? 'Disabled' : 'Enabled'} Library Downloads.`);
- processing.value = false;
- } catch (error) {
- toast('Failure', { type: 'danger', description: 'Unable to set download settings.' });
- console.error(error);
- processing.value = false;
- }
-};
-
-const handleToggleDownloadPrivacy = async (id: number, currentValue: boolean) => {
- if (processing.value || !props.data?.id || currentValue !== props.data.downloads_require_auth) return;
-
- try {
- processing.value = true;
-
- await setLibraryDownloadSettings(id, { downloads_require_auth: !currentValue });
- await queryClient.invalidateQueries({ queryKey: ['categories'] });
-
- toast.success(`${currentValue ? 'Disabled' : 'Enabled'} Library Downloads for Guest Users.`);
- processing.value = false;
+ toast.success(successMessage(!currentValue));
} catch (error) {
- toast('Failure', { type: 'danger', description: 'Unable to set download settings.' });
+ toast('Failure', { type: 'danger', description: 'Unable to update library settings.' });
console.error(error);
+ } finally {
processing.value = false;
}
};
@@ -195,9 +154,7 @@ watch(
:processing="processing"
:handle-set-default-folder="handleSetDefaultFolder"
:handle-start-scan="handleStartScan"
- :handle-toggle-privacy="handleTogglePrivacy"
- :handle-toggle-downloads="handleToggleDownloads"
- :handle-toggle-download-privacy="handleToggleDownloadPrivacy"
+ :handle-toggle-setting="handleToggleSetting"
/>
</template>
</BasePopover>
diff --git a/resources/js/components/menus/LibraryCardMenu.vue b/resources/js/components/menus/LibraryCardMenu.vue
index 8c01b878..8379ec8c 100644
--- a/resources/js/components/menus/LibraryCardMenu.vue
+++ b/resources/js/components/menus/LibraryCardMenu.vue
@@ -16,6 +16,8 @@ import ProiconsArrowSync from '~icons/proicons/arrow-sync';
import ProiconsLockOpen from '~icons/proicons/lock-open';
import ProiconsDelete from '~icons/proicons/delete';
import ProiconsLock from '~icons/proicons/lock';
+import ProIconsPhotoOff from '../icons/ProIconsPhotoOff.vue';
+import ProIconsPhoto from '../icons/ProIconsPhoto.vue';
const props = withDefaults(
defineProps<{
@@ -25,9 +27,11 @@ const props = withDefaults(
processing: boolean;
handleSetDefaultFolder: (newFolder: { value: number }) => Promise<void>;
handleStartScan: (verifyOnly?: boolean) => Promise<void>;
- handleTogglePrivacy: (id: number, currentValue: boolean) => Promise<void>;
- handleToggleDownloads: (id: number, currentValue: boolean) => Promise<void>;
- handleToggleDownloadPrivacy: (id: number, currentValue: boolean) => Promise<void>;
+ handleToggleSetting: (
+ setting: keyof Pick<CategoryResource, 'is_private' | 'downloads_enabled' | 'downloads_require_auth' | 'storyboard_enabled'>,
+ currentValue: boolean,
+ successMessage: (newValue: boolean) => string,
+ ) => Promise<void>;
}>(),
{},
);
@@ -86,7 +90,20 @@ const { isAdmin } = useAuth();
<template v-if="isAdmin">
<SectionLabel class="-mb-1 hidden h-auto! bg-transparent!"> Access Control </SectionLabel>
- <ButtonText :title="'Toggle Downloads'" @click="handleToggleDownloads(data.id, data.downloads_enabled)" :disabled="processing">
+ <ButtonText
+ :title="'Toggle Storyboard'"
+ @click="handleToggleSetting('storyboard_enabled', data.storyboard_enabled, (v) => `${v ? 'Enabled' : 'Disabled'} Storyboard Generation`)"
+ :disabled="processing"
+ >
+ <p class="flex-1 text-start">{{ data.storyboard_enabled ? 'Disable Storyboard' : 'Enable Storyboard' }}</p>
+ <template #icon> <ProIconsPhotoOff v-if="!data.storyboard_enabled" class="size-4" /> <ProIconsPhoto v-else class="size-4" /></template>
+ </ButtonText>
+
+ <ButtonText
+ :title="'Toggle Downloads'"
+ @click="handleToggleSetting('downloads_enabled', data.downloads_enabled, (v) => `${v ? 'Enabled' : 'Disabled'} Library Downloads`)"
+ :disabled="processing"
+ >
<p class="flex-1 text-start">{{ data.downloads_enabled ? 'Disable Downloads' : 'Enable Downloads' }}</p>
<template #icon> <TablerDownloadOff v-if="!data.downloads_enabled" class="size-4" /> <TablerDownload v-else class="size-4" /></template>
</ButtonText>
@@ -95,7 +112,7 @@ const { isAdmin } = useAuth();
v-if="data.downloads_enabled"
:title="`${data.downloads_require_auth ? 'Enable' : 'Disable'} Guest Downloads`"
:disabled="processing"
- @click="handleToggleDownloadPrivacy(data.id, data.downloads_require_auth)"
+ @click="handleToggleSetting('downloads_require_auth', data.downloads_require_auth, (v) => `${v ? 'Disabled' : 'Enabled'} Guest Downloads`)"
>
<p class="flex-1 text-start">{{ data.downloads_require_auth ? 'Guest Downloads' : 'Private Downloads' }}</p>
<template #icon> <TablerDownloadOff v-if="!data.downloads_require_auth" class="size-4" /> <TablerDownload v-else class="size-4" /></template>
@@ -103,7 +120,7 @@ const { isAdmin } = useAuth();
<ButtonText
:title="'Toggle Privacy'"
- @click="handleTogglePrivacy(data.id, data.is_private ?? false)"
+ @click="handleToggleSetting('is_private', data.is_private ?? false, (v) => `Library set to ${v ? 'Private' : 'Public'}`)"
:disabled="processing"
:class="[{ 'text-danger dark:text-foreground-0 dark:bg-danger-3! dark:hocus:bg-danger!': data.is_private }]"
>
diff --git a/resources/js/contracts/media.ts b/resources/js/contracts/media.ts
index 01415e63..435bc2ce 100644
--- a/resources/js/contracts/media.ts
+++ b/resources/js/contracts/media.ts
@@ -14,6 +14,7 @@ export interface CategoryResource {
is_private?: boolean;
downloads_enabled: boolean;
downloads_require_auth: boolean;
+ storyboard_enabled: boolean;
}
//#region Folders
diff --git a/resources/js/service/mediaAPI.ts b/resources/js/service/mediaAPI.ts
index c6d27243..afcec9a2 100644
--- a/resources/js/service/mediaAPI.ts
+++ b/resources/js/service/mediaAPI.ts
@@ -57,10 +57,6 @@ export function getFolders(category_id: number) {
return API.get(`/folders/?category_id=${category_id}`);
}
-export function updateCategory(id: number, data: { default_folder_id: number }) {
- return API.patch(`/categories/${id}`, data);
-}
-
export function getUserViewCount(id: number) {
return API.get(`/user-view-count/${id}`);
}
@@ -79,3 +75,11 @@ export function getSetupStatus(): Promise<
> {
return API.get(`/setup-status`);
}
+
+export function updateLibrarySettings(id: number, data: { is_private?: boolean; downloads_enabled?: boolean; downloads_require_auth?: boolean; storyboard_enabled?: boolean }) {
+ return API.patch(`/categories/${id}/settings`, data);
+}
+
+export function updateLibraryDefaultFolder(id: number, data: { default_folder_id: number }) {
+ return API.patch(`/categories/${id}/default-folder`, data);
+}
diff --git a/resources/js/service/siteAPI.ts b/resources/js/service/siteAPI.ts
index 0957152d..d7c47c97 100644
--- a/resources/js/service/siteAPI.ts
+++ b/resources/js/service/siteAPI.ts
@@ -41,14 +41,6 @@ export function getTaskWaitTimes() {
return API.get('/tasks/wait-times');
}
-export function toggleCategoryPrivacy(id: number, value: boolean) {
- return API.post(`/categories/${id}/privacy/`, { is_private: value });
-}
-
-export function setLibraryDownloadSettings(id: number, data: { downloads_enabled?: boolean; downloads_require_auth?: boolean }) {
- return API.put(`/categories/${id}/downloads`, data);
-}
-
export function setSeriesDownloadSettings(id: number, data: { downloads_enabled?: boolean }) {
return API.put(`/series/${id}/downloads`, data);
}
diff --git a/routes/api.php b/routes/api.php
index ab854637..cf1c7f13 100755
--- a/routes/api.php
+++ b/routes/api.php
@@ -75,7 +75,6 @@ Route::group(['middleware' => ['auth:sanctum']], function () {
Route::get('/active-sessions', [UserController::class, 'sessionCount']);
// Media and Metadata
- Route::resource('/categories', CategoryController::class)->only(['update']);
Route::resource('/metadata', MetadataController::class)->only(['show', 'store', 'update']);
Route::resource('/series', SeriesController::class)->only(['index', 'store', 'update']);
Route::resource('/tags', TagController::class)->only(['index', 'store']);
@@ -91,10 +90,8 @@ Route::group(['middleware' => ['auth:sanctum']], function () {
});
Route::prefix('/categories/{category}')->group(function () {
- // Access Control
- Route::post('/privacy', [CategoryController::class, 'updatePrivacySettings']);
- // Download Access Control
- Route::put('/downloads', [CategoryController::class, 'updateDownloadSettings']);
+ Route::patch('/default-folder', [CategoryController::class, 'setDefaultFolder']);
+ Route::patch('/settings', [CategoryController::class, 'updateSettings']);
});
Route::prefix('/series/{series}')->group(function () {