A self-hosted media server and file management system
Vue ffmpegfile-serverjellyfinlaravelmediamedia-playermedia-servermediabrowsermediaservermusicmusic-librarymusic-playermusicplayerself-hostedvuejs
feat: add storyboard generation job trigger to library cards
aminnausinc2f574e8e230
diff --git a/app/Http/Controllers/Api/V1/JobController.php b/app/Http/Controllers/Api/V1/JobController.phpindex 33874332..58b968e1 100644--- a/app/Http/Controllers/Api/V1/JobController.php+++ b/app/Http/Controllers/Api/V1/JobController.php@@ -56,6 +56,20 @@ class JobController extends Controller {);}+ public function generateStoryboards(Request $request, Category $category) {+ $this->authorize('admin');+ if (! $category->storyboardEnabled()) {+ abort(403, 'Storyboards are disabled for this library');+ }++ return $this->handleJobRequest(+ request: $request,+ method: 'generateStoryboards',+ jobName: 'GENERATE STORYBOARDS',+ category: $category,+ );+ }+public function cleanPaths(Request $request): JsonResponse {return $this->handleJobRequest(request: $request,@@ -65,7 +79,7 @@ class JobController extends Controller {}/**- * @param 'scanFiles'|'indexFiles'|'syncFiles'|'verifyFiles'|'verifyFolders'|'cleanPaths' $method+ * @param 'scanFiles'|'indexFiles'|'syncFiles'|'verifyFiles'|'verifyFolders'|'generateStoryboards'|'cleanPaths' $method*/protected function handleJobRequest(Request $request,diff --git a/resources/js/components/cards/data/LibraryCard.vue b/resources/js/components/cards/data/LibraryCard.vueindex c574eacd..87af115e 100644--- a/resources/js/components/cards/data/LibraryCard.vue+++ b/resources/js/components/cards/data/LibraryCard.vue@@ -1,9 +1,9 @@<script setup lang="ts">import type { CategoryResource, FolderResource } from '@/types/resources';+import { startGenerateStoryboardsTask, startScanFilesTask, startVerifyFilesTask } 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 { BasePopover } from '@/components/cedar-ui/popover';@@ -66,6 +66,23 @@ const handleStartScan = async (verifyOnly: boolean = false) => {}};+const handleGenerateStoryboards = async () => {+ if (!props.data?.id) {+ toast('Error', { description: 'Invalid Category ID!', type: 'danger' });+ popover.value?.handleClose();+ return;+ }++ try {+ await startGenerateStoryboardsTask(props.data.id);+ toast.add('Success', { type: 'success', description: `Submitted generate storyboards request!` });+ popover.value?.handleClose();+ } catch (error) {+ toast('Failure', { type: 'danger', description: `Unable to generate storyboards.` });+ console.error(error);+ }+};+const handleToggleSetting = async (setting: keyof Pick<CategoryResource, 'is_private' | 'downloads_enabled' | 'downloads_require_auth' | 'storyboard_enabled'>,currentValue: boolean,@@ -167,6 +184,7 @@ watch(:handle-set-default-folder="handleSetDefaultFolder":handle-start-scan="handleStartScan":handle-toggle-setting="handleToggleSetting"+ :handle-start-generate-storyboards="handleGenerateStoryboards"/></template></BasePopover>diff --git a/resources/js/components/menus/LibraryCardMenu.vue b/resources/js/components/menus/LibraryCardMenu.vueindex 8379ec8c..94601fb2 100644--- a/resources/js/components/menus/LibraryCardMenu.vue+++ b/resources/js/components/menus/LibraryCardMenu.vue@@ -27,6 +27,7 @@ const props = withDefaults(processing: boolean;handleSetDefaultFolder: (newFolder: { value: number }) => Promise<void>;handleStartScan: (verifyOnly?: boolean) => Promise<void>;+ handleStartGenerateStoryboards: () => Promise<void>;handleToggleSetting: (setting: keyof Pick<CategoryResource, 'is_private' | 'downloads_enabled' | 'downloads_require_auth' | 'storyboard_enabled'>,currentValue: boolean,@@ -91,7 +92,7 @@ const { isAdmin } = useAuth();<template v-if="isAdmin"><SectionLabel class="-mb-1 hidden h-auto! bg-transparent!"> Access Control </SectionLabel><ButtonText- :title="'Toggle Storyboard'"+ :title="'Toggle Storyboards'"@click="handleToggleSetting('storyboard_enabled', data.storyboard_enabled, (v) => `${v ? 'Enabled' : 'Disabled'} Storyboard Generation`)":disabled="processing">@@ -99,6 +100,11 @@ const { isAdmin } = useAuth();<template #icon> <ProIconsPhotoOff v-if="!data.storyboard_enabled" class="size-4" /> <ProIconsPhoto v-else class="size-4" /></template></ButtonText>+ <ButtonText :title="'Generate Storyboards'" @click="handleStartGenerateStoryboards()" :disabled="processing" v-if="data.storyboard_enabled">+ <p class="flex-1 text-start">Build Storyboards</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`)"diff --git a/resources/js/service/siteAPI.ts b/resources/js/service/siteAPI.tsindex d7c47c97..5e0bf9b5 100644--- a/resources/js/service/siteAPI.ts+++ b/resources/js/service/siteAPI.ts@@ -68,6 +68,10 @@ export function startScanFilesTask(category?: number) {return API.post(`/tasks/scan/${category ?? ''}`);}+export function startGenerateStoryboardsTask(category: number) {+ return API.post(`/tasks/storyboards/${category}`);+}+export function deleteTask(taskId: number) {return API.delete(`/tasks/${taskId}`);}diff --git a/routes/api.php b/routes/api.phpindex cf1c7f13..9aeb1d7a 100755--- a/routes/api.php+++ b/routes/api.php@@ -123,6 +123,7 @@ Route::group(['middleware' => ['auth:sanctum']], function () {Route::post('/verify/{category?}', [JobController::class, 'verifyFiles']);Route::post('/verify-folders/{category?}', [JobController::class, 'verifyFolders']);Route::post('/scan/{category?}', [JobController::class, 'scanFiles']);+ Route::post('/storyboards/{category}', [JobController::class, 'generateStoryboards']);Route::post('/clean', [JobController::class, 'cleanPaths']); // OLDRoute::post('/cancel/{task}', [TaskController::class, 'cancel']);});