Skip to content

A self-hosted media server and file management system

feat: clear subtitle cache

aminnausin2e5c9c16f4ae
diff --git a/app/Http/Controllers/Api/V1/Metadata/SubtitleController.php b/app/Http/Controllers/Api/V1/Metadata/SubtitleController.php
index 74085d46..b303eda0 100644
--- a/app/Http/Controllers/Api/V1/Metadata/SubtitleController.php
+++ b/app/Http/Controllers/Api/V1/Metadata/SubtitleController.php
@@ -4,11 +4,12 @@ namespace App\Http\Controllers\Api\V1\Metadata;
use App\Http\Controllers\Controller;
use App\Models\Metadata;
+use App\Services\Subtitles\SubtitleManager;
use App\Services\Subtitles\SubtitleResolver;
use Illuminate\Http\Request;
class SubtitleController extends Controller {
- public function __construct(protected SubtitleResolver $subtitleResolver) {}
+ public function __construct(protected SubtitleResolver $subtitleResolver, protected SubtitleManager $subtitleManager) {}
/**
* Look for a specified subtitle resource.
@@ -40,5 +41,14 @@ class SubtitleController extends Controller {
return $this->subtitleResolver->resolveSubtitles($metadata, 0, $format, $language);
}
+ public function reset(
+ Request $request,
+ Metadata $metadata
+ ) {
+ $this->subtitleManager->reset($metadata);
+
+ return response(null, 204);
+ }
+
// TODO: Add an API route that gets subtitles for a specific metadata or video row and cache the results. These are only used to determine the filepath used in the <track/>
}
diff --git a/app/Services/Subtitles/SubtitleManager.php b/app/Services/Subtitles/SubtitleManager.php
new file mode 100644
index 00000000..2e0310f0
--- /dev/null
+++ b/app/Services/Subtitles/SubtitleManager.php
@@ -0,0 +1,23 @@
+<?php
+
+namespace App\Services\Subtitles;
+
+use App\Models\Metadata;
+use Illuminate\Support\Facades\Log;
+use Illuminate\Support\Facades\Storage;
+
+class SubtitleManager {
+ public function reset(Metadata $metadata): void {
+ $this->deleteSubtitleFiles($metadata);
+
+ $metadata->subtitles()->update([
+ 'path' => null,
+ ]);
+ }
+
+ private function deleteSubtitleFiles(Metadata $metadata): void {
+ $directory = SubtitlePath::buildDirectory($metadata->uuid);
+ Log::info('Cleared Subtitle Directory', ['uuid' => $metadata->uuid, 'title' => $metadata->title, 'dir' => $directory]);
+ Storage::disk('local')->deleteDirectory($directory);
+ }
+}
diff --git a/resources/js/components/video/VideoInfoPanel.vue b/resources/js/components/video/VideoInfoPanel.vue
index 5b4694b8..73ff9947 100755
--- a/resources/js/components/video/VideoInfoPanel.vue
+++ b/resources/js/components/video/VideoInfoPanel.vue
@@ -6,6 +6,7 @@ import { ButtonIcon, ButtonText } from '@/components/cedar-ui/button';
import { getUserViewCount } from '@/service/mediaAPI';
import { ContextMenuItem } from '@/components/cedar-ui/context-menu';
import { useContentStore } from '@/stores/ContentStore';
+import { resetSubtitles } from '@/service/media/subtitles';
import { useModalStore } from '@/stores/ModalStore';
import { useAuthStore } from '@/stores/AuthStore';
import { BasePopover } from '@/components/cedar-ui/popover';
@@ -46,6 +47,39 @@ const personalViewCount = ref<number | null>(null);
const isOverflowing = ref(false);
const isExpanded = ref(false);
+const popoverItems = computed(() => {
+ return [
+ {
+ icon: CircumEdit,
+ text: 'Edit',
+ action: () => {
+ handleEdit();
+ },
+ },
+ {
+ icon: CircumShare1,
+ text: 'Share',
+ action: () => {
+ handleShare();
+ },
+ },
+ {
+ icon: ProiconsArrowDownload,
+ text: 'Download',
+ action: () => {},
+ disabled: true,
+ },
+ {
+ icon: LucideCaptions,
+ text: 'Reset Subtitles',
+ hidden: stateVideo.value.metadata?.media_type === 1 || stateVideo.value.subtitles.length == 0,
+ action: () => {
+ handleResetSubtitles();
+ },
+ },
+ ];
+});
+
const mediaTypeDescription = computed(() => {
return stateVideo.value?.metadata?.media_type === MediaType.AUDIO || stateFolder.value?.is_majority_audio ? 'Track' : 'Video';
});
@@ -75,6 +109,16 @@ const handleEdit = () => {
});
};
+const handleResetSubtitles = () => {
+ if (!stateVideo.value.metadata?.id) return;
+ toast.promise(resetSubtitles(stateVideo.value.metadata.id), {
+ loading: 'Resetting Subtitles',
+ loadingDescription: `Clearing subtitle cache`,
+ success: 'Subtitles Reset!',
+ error: 'Failed to reset subtitles',
+ });
+};
+
function handleSeek(seconds: number) {
emitSeek(seconds);
}
@@ -155,43 +199,18 @@ onMounted(() => {
</template>
<template #content>
<ContextMenuItem
- :icon="CircumEdit"
- :text="'Edit'"
- :action="
- () => {
- mobilePopover?.handleClose();
- handleEdit();
- }
- "
- />
- <ContextMenuItem
- :icon="CircumShare1"
- :text="'Share'"
- :action="
- () => {
- mobilePopover?.handleClose();
- handleShare();
- }
- "
- />
- <ContextMenuItem
- disabled
- :icon="ProiconsArrowDownload"
- :text="'Download'"
- :action="
- () => {
- mobilePopover?.handleClose();
- }
- "
- />
- <ContextMenuItem
- :icon="LucideCaptions"
- :text="'Rescan Subtitles'"
+ v-for="popoverItem in popoverItems"
+ :key="popoverItem.text"
+ :icon="popoverItem.icon"
+ :text="popoverItem.text"
+ :disabled="popoverItem.disabled"
:action="
() => {
mobilePopover?.handleClose();
+ popoverItem.action();
}
"
+ v-show="!popoverItem.hidden"
/>
</template>
</BasePopover>
@@ -291,31 +310,15 @@ onMounted(() => {
</template>
<template #content>
<ContextMenuItem
- :icon="CircumShare1"
- :text="'Share'"
- :action="
- () => {
- popover?.handleClose();
- handleShare();
- }
- "
- />
- <ContextMenuItem
- disabled
- :icon="ProiconsArrowDownload"
- :text="'Download'"
- :action="
- () => {
- popover?.handleClose();
- }
- "
- />
- <ContextMenuItem
- :icon="LucideCaptions"
- :text="'Rescan Subtitles'"
+ v-for="popoverItem in popoverItems.filter((itm) => itm.text !== 'Edit')"
+ :key="popoverItem.text"
+ :icon="popoverItem.icon"
+ :text="popoverItem.text"
+ v-show="!popoverItem.hidden"
:action="
() => {
popover?.handleClose();
+ popoverItem.action();
}
"
/>
diff --git a/resources/js/service/media/subtitles.ts b/resources/js/service/media/subtitles.ts
new file mode 100644
index 00000000..0b12fbe3
--- /dev/null
+++ b/resources/js/service/media/subtitles.ts
@@ -0,0 +1,5 @@
+import { API } from '../api';
+
+export const resetSubtitles = (metadataId: number) => {
+ return API.delete(`/metadata/${metadataId}/subtitles`);
+};
diff --git a/routes/api.php b/routes/api.php
index 74a58661..14655061 100755
--- a/routes/api.php
+++ b/routes/api.php
@@ -8,6 +8,7 @@ use App\Http\Controllers\Api\V1\EmailController;
use App\Http\Controllers\Api\V1\ExternalMetadataController;
use App\Http\Controllers\Api\V1\FolderController;
use App\Http\Controllers\Api\V1\JobController;
+use App\Http\Controllers\Api\V1\Metadata\SubtitleController;
use App\Http\Controllers\Api\V1\MetadataController;
use App\Http\Controllers\Api\V1\PasswordController;
use App\Http\Controllers\Api\V1\PlaybackController;
@@ -64,6 +65,11 @@ Route::group(['middleware' => ['auth:sanctum']], function () {
Route::resource('/tags', TagController::class)->only(['index', 'store']);
Route::patch('/metadata/{metadata}/lyrics', [MetadataController::class, 'updateLyrics']);
+ // Subtitles
+ Route::prefix('/metadata/{metadata}')->group(function () {
+ Route::delete('/subtitles', [SubtitleController::class, 'reset']); // clear cache
+ });
+
// Users and Profiles
Route::get('/profiles/search/{username?}', [ProfileController::class, 'findUser']);
Route::resource('/users', UserController::class)->only(['index', 'destroy']);