Skip to content

A self-hosted media server and file management system

feat: auto reload fonts when running build job

aminnausind8ba0f4ec1c0
diff --git a/app/Http/Controllers/Api/V1/Metadata/FontController.php b/app/Http/Controllers/Api/V1/Metadata/FontController.php
index 75072ecf..743919f1 100644
--- a/app/Http/Controllers/Api/V1/Metadata/FontController.php
+++ b/app/Http/Controllers/Api/V1/Metadata/FontController.php
@@ -9,8 +9,10 @@ use App\Models\Font;
use App\Models\Metadata;
use App\Models\SubTask;
use App\Services\FileJobService;
+use Illuminate\Http\JsonResponse;
use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\Gate;
+use Illuminate\Support\Facades\RateLimiter;
use Illuminate\Support\Facades\Storage;
class FontController extends Controller {
@@ -20,7 +22,10 @@ class FontController extends Controller {
* List storyboard details for metadata.
*/
public function show(Metadata $metadata) {
- return FontResource::collection($metadata->fonts);
+ return response()->json([
+ 'fonts' => FontResource::collection($metadata->fonts)->resolve(),
+ 'fonts_scanned_at' => $metadata->fonts_scanned_at,
+ ]);
}
public function regenerate(Metadata $metadata) {
@@ -55,4 +60,31 @@ class FontController extends Controller {
return response()->json(['task_id' => $task->id], 202);
}
+
+ private function getRateLimitError(): ?JsonResponse {
+ $perMinuteKey = 'font-regenerate:minute:' . Auth::id();
+ $perHourKey = 'font-regenerate:hour:' . Auth::id();
+
+ if (RateLimiter::tooManyAttempts($perMinuteKey, 1)) {
+ return response()->json([
+ 'message' => 'Too many requests. Try again in ' . RateLimiter::availableIn($perMinuteKey) . ' seconds.',
+ ], 429);
+ }
+
+ if (RateLimiter::tooManyAttempts($perHourKey, 15)) {
+ return response()->json([
+ 'message' => 'Hourly limit reached. Try again in ' . ceil(RateLimiter::availableIn($perHourKey) / 60) . ' minutes.',
+ ], 429);
+ }
+
+ return null;
+ }
+
+ private function hitRateLimits(): void {
+ $perMinuteKey = 'font-regenerate:minute:' . Auth::id();
+ $perHourKey = 'font-regenerate:hour:' . Auth::id();
+
+ RateLimiter::hit($perMinuteKey, 60);
+ RateLimiter::hit($perHourKey, 3600);
+ }
}
diff --git a/app/Http/Resources/MetadataResource.php b/app/Http/Resources/MetadataResource.php
index ea1d341f..1e3fd7cb 100644
--- a/app/Http/Resources/MetadataResource.php
+++ b/app/Http/Resources/MetadataResource.php
@@ -45,6 +45,7 @@ class MetadataResource extends JsonResource {
'file_modified_at' => $this->first_file_modified_at ?: $this->file_modified_at,
'first_file_modified_at' => $this->first_file_modified_at,
'subtitles_scanned_at' => $this->subtitles_scanned_at,
+ 'fonts_scanned_at' => $this->fonts_scanned_at,
];
}
}
diff --git a/resources/js/components/video/VideoInfoPanel.vue b/resources/js/components/video/VideoInfoPanel.vue
index ec18d9f4..5bdca326 100755
--- a/resources/js/components/video/VideoInfoPanel.vue
+++ b/resources/js/components/video/VideoInfoPanel.vue
@@ -3,7 +3,7 @@ import type { AxiosError } from 'axios';
import { computed, onMounted, ref, useTemplateRef, watch, nextTick } from 'vue';
import { handleStorageURL, toTimeSpan, formatFileSize, toPlural } from '@/service/util';
-import { resetFonts, resetSubtitles } from '@/service/media/attachments';
+import { resetSubtitles, runRegenerateFonts } from '@/service/media/attachments';
import { getMediaDateDescription } from '@/service/media/mediaFormatter';
import { runRegenerateStoryboard } from '@/service/media/storyboard';
import { handleEditFolderImages } from '@/service/folder/folderActions';
@@ -105,7 +105,7 @@ const popoverItems = computed(() => {
},
{
icon: ProiconsTextFontSize,
- text: 'Reset Fonts',
+ text: `${stateVideo.value.fonts?.length || stateVideo.value.metadata?.fonts_scanned_at ? 'Reset' : 'Build'} Fonts`,
hidden: stateVideo.value.metadata?.media_type === 1 || !isAuthenticated.value,
action: handleResetFonts,
},
@@ -167,16 +167,8 @@ const handleResetFonts = () => {
toast.error('ID Missing');
return;
}
- toast.promise(resetFonts(stateVideo.value.metadata.id), {
- loading: 'Resetting Fonts',
- loadingDescription: `Clearing custom font cache`,
- success: 'Fonts Reset!',
- error: 'Failed to reset fonts',
- errorDescription: (err) => {
- const axiosErr = err as AxiosError<{ message?: string }>;
- return axiosErr.response?.data?.message ?? axiosErr.message;
- },
- });
+
+ runRegenerateFonts(stateVideo.value.id, stateVideo.value.metadata.id);
};
const handleResetStoryboard = () => {
diff --git a/resources/js/components/video/subtitles/OctopusRenderer.ts b/resources/js/components/video/subtitles/OctopusRenderer.ts
index 6a63345b..5ee7e9a4 100644
--- a/resources/js/components/video/subtitles/OctopusRenderer.ts
+++ b/resources/js/components/video/subtitles/OctopusRenderer.ts
@@ -10,7 +10,14 @@ export default function useOctopusRenderer() {
const assInstance = ref<SubtitlesOctopus | null>(null);
const abortController = ref<AbortController | null>(null);
- const instantiateOctopus = async (nextTrack: SubtitleResource, getCurrentTime: () => number, frameRate?: number, fonts: string[] = []) => {
+ const instantiateOctopus = async (
+ nextTrack: SubtitleResource,
+ getCurrentTime: () => number,
+ frameRate?: number,
+ fonts: string[] = [],
+ extendedDescription?: string,
+ showToast = false,
+ ) => {
const video = document.getElementById('video-source') as HTMLVideoElement;
if (!video) return;
if (assInstance.value) clearOctopus();
@@ -28,14 +35,16 @@ export default function useOctopusRenderer() {
const trackTitle = nextTrack.title ? `Title: ${nextTrack.title}` : `Track: ${nextTrack.track_id}`;
try {
- const response = await toast.promise(fetch(subUrl, { signal }), {
- loading: `Loading track ${nextTrack.track_id}...`,
- loadingDescription: 'Initial load may take a few seconds',
- success: `Loaded subtitles`,
- successDescription: trackTitle,
- error: 'Failed to load subtitles',
- errorDescription: trackTitle,
- });
+ const response = showToast
+ ? await toast.promise(fetch(subUrl, { signal }), {
+ loading: `Loading track ${nextTrack.track_id}...`,
+ loadingDescription: 'Initial load may take a few seconds',
+ success: `Loaded subtitles`,
+ successDescription: [trackTitle, extendedDescription].filter(Boolean).join('\n\n'),
+ error: 'Failed to load subtitles',
+ errorDescription: trackTitle,
+ })
+ : await fetch(subUrl, { signal });
if (!response.ok || signal.aborted) return;
diff --git a/resources/js/components/video/subtitles/PlayerSubtitles.vue b/resources/js/components/video/subtitles/PlayerSubtitles.vue
index 8962cfad..8548747d 100644
--- a/resources/js/components/video/subtitles/PlayerSubtitles.vue
+++ b/resources/js/components/video/subtitles/PlayerSubtitles.vue
@@ -4,6 +4,7 @@ import type { PopoverItem } from '@aminnausin/cedar-ui';
import type { Ref } from 'vue';
import { computed, inject, nextTick, onMounted, onUnmounted, ref, useTemplateRef, watch } from 'vue';
+import { runRegenerateFonts } from '@/service/media/attachments';
import { useContentStore } from '@/stores/ContentStore';
import { useAppStore } from '@/stores/AppStore';
import { storeToRefs } from 'pinia';
@@ -75,16 +76,22 @@ const playerSubtitleItems = computed(() => {
};
});
- const toggleFonts: PopoverItem | undefined = stateVideo.value.fonts?.length
- ? {
- icon: useFonts.value ? ProIconsTextHighlightColor : ProIconsTextHighlightColorOff,
- text: 'Custom Fonts',
- selected: useFonts.value,
- selectedIcon: ProiconsCheckmark,
- selectedIconStyle: 'text-primary',
- action: () => (useFonts.value = !useFonts.value),
- }
- : undefined;
+ const toggleFonts: PopoverItem | undefined =
+ stateVideo.value.fonts?.length || !stateVideo.value.metadata?.fonts_scanned_at
+ ? {
+ icon: useFonts.value ? ProIconsTextHighlightColor : ProIconsTextHighlightColorOff,
+ text: 'Custom Fonts',
+ selected: useFonts.value,
+ selectedIcon: ProiconsCheckmark,
+ selectedIconStyle: 'text-primary',
+ action: () => {
+ useFonts.value = !useFonts.value;
+ if (!stateVideo.value.metadata?.fonts_scanned_at && stateVideo.value.metadata?.id) {
+ runRegenerateFonts(stateVideo.value.id, stateVideo.value.metadata?.id);
+ }
+ },
+ }
+ : undefined;
const subtitlesOff: PopoverItem = {
icon: IconCaptionsOff,
@@ -125,7 +132,7 @@ const handleSizeWheel = (event: WheelEvent) => {
* Handle Subtitles Toggle
* @param track -> Defaults to first available subtitle only if not currently showing anything
*/
-const handleSubtitles = (track?: SubtitleResource, reloadCurrentTrack = false) => {
+const handleSubtitles = (track?: SubtitleResource, reloadCurrentTrack = false, showToast = true) => {
const nextTrack = track ?? (isShowingSubtitles.value ? undefined : defaultSubtitleTrack.value);
isShowingSubtitles.value = !!nextTrack;
@@ -141,14 +148,31 @@ const handleSubtitles = (track?: SubtitleResource, reloadCurrentTrack = false) =
return;
}
- if (nextTrack.codec === 'ass') {
- instantiateOctopus(nextTrack, props.getCurrentTime, stateVideo.value.metadata?.frame_rate, useFonts.value ? stateVideo.value.fonts : []);
- hideNativeTracks();
+ if (nextTrack.codec !== 'ass') {
+ clearOctopus();
+ handleNativeSubtitles(nextTrack);
return;
}
- clearOctopus();
- handleNativeSubtitles(nextTrack);
+ let fontDescription: string | undefined;
+
+ if (useFonts.value && !stateVideo.value.fonts?.length) {
+ switch (stateVideo.value.metadata?.fonts_scanned_at) {
+ case '...scanning':
+ fontDescription = 'Scanning for custom fonts...';
+ break;
+ case null:
+ case undefined:
+ case '':
+ fontDescription = "Custom fonts aren't available yet\nUse “Build Fonts” in the menu to generate them";
+ break;
+ default:
+ fontDescription = 'No custom fonts were found in this file';
+ break;
+ }
+ }
+ instantiateOctopus(nextTrack, props.getCurrentTime, stateVideo.value.metadata?.frame_rate, useFonts.value ? stateVideo.value.fonts : [], fontDescription, showToast);
+ hideNativeTracks();
};
const handleNativeSubtitles = async (nextTrack: SubtitleResource) => {
@@ -220,7 +244,28 @@ const buildSubtitleUrl = (subtitle?: SubtitleResource): string => {
watch(
() => useFonts.value,
- () => handleSubtitles(currentSubtitleTrack.value, true),
+ () => {
+ if (!isShowingSubtitles.value || !currentSubtitleTrack.value) {
+ return;
+ }
+
+ handleSubtitles(currentSubtitleTrack.value, true);
+ },
+);
+
+watch(
+ () => ({
+ id: stateVideo.value.id,
+ fonts: stateVideo.value.fonts,
+ }),
+ (current, previous) => {
+ if (!isShowingSubtitles.value || !currentSubtitleTrack.value || !useFonts.value) {
+ return;
+ }
+
+ if (current.id !== previous.id) return;
+ handleSubtitles(currentSubtitleTrack.value, true, false);
+ },
);
onMounted(() => {
diff --git a/resources/js/contracts/media.ts b/resources/js/contracts/media.ts
index c19aa3d9..7424e56c 100644
--- a/resources/js/contracts/media.ts
+++ b/resources/js/contracts/media.ts
@@ -121,6 +121,7 @@ export interface MetadataResource {
file_modified_at?: string;
first_file_modified_at?: string;
subtitles_scanned_at?: string;
+ fonts_scanned_at?: string;
}
export interface VideoResource {
@@ -176,6 +177,11 @@ export interface SubtitleResource {
is_forced: boolean;
}
+export interface FontResource {
+ file_name: string;
+ path: string;
+}
+
export interface StoryboardResource {
tile_rows: number;
tile_cols: number;
diff --git a/resources/js/service/media/attachments.ts b/resources/js/service/media/attachments.ts
index 36f21261..7fba1e1f 100644
--- a/resources/js/service/media/attachments.ts
+++ b/resources/js/service/media/attachments.ts
@@ -1,9 +1,78 @@
+import type { AxiosError, AxiosResponse } from 'axios';
+import type { FontResource } from '@/contracts/media';
+
+import { useContentStore } from '@/stores/ContentStore';
+import { subscribeToTask } from '@/service/wsService';
+import { useAppStore } from '@/stores/AppStore';
+import { toast } from '@aminnausin/cedar-ui';
import { API } from '@/service/api';
export const resetSubtitles = (metadataId: number) => {
return API.delete(`/metadata/${metadataId}/subtitles`, { headers: { 'X-Skip-Toast': 'true' } });
};
-export const resetFonts = (metadataId: number) => {
- return API.post(`/metadata/${metadataId}/fonts`, { headers: { 'X-Skip-Toast': 'true' } });
+export const getFonts = (metadataId: number): Promise<AxiosResponse<{ fonts: FontResource[]; fonts_scanned_at?: string }>> => {
+ return API.get(`/metadata/${metadataId}/fonts`, { headers: { 'X-Skip-Toast': 'true' } });
+};
+
+export const regenerateFonts = (metadataId: number): Promise<AxiosResponse<{ task_id: number; message?: string }>> => {
+ return API.post(`/metadata/${metadataId}/fonts`, {}, { headers: { 'X-Skip-Toast': 'true' } });
+};
+
+export const runRegenerateFonts = async (videoId: number, metadataId: number) => {
+ const contentStore = useContentStore();
+
+ useAppStore().createEcho();
+
+ const onComplete = async () => {
+ try {
+ const { data } = await getFonts(metadataId);
+
+ const metadata = contentStore.stateVideo.metadata!;
+
+ contentStore.updateVideoData({
+ id: videoId,
+ fonts: data.fonts?.map((font) => font.path) ?? [],
+ metadata: {
+ ...metadata,
+ fonts_scanned_at: data.fonts_scanned_at,
+ },
+ });
+ } catch (error) {
+ toast.error('Failed to load fonts', { description: 'Refresh to see updated fonts' });
+ console.error(error);
+ }
+ };
+
+ try {
+ const metadata = contentStore.stateVideo.metadata!;
+
+ contentStore.updateVideoData({ id: videoId, fonts: [], metadata: { ...metadata, fonts_scanned_at: '...scanning' } });
+
+ const result = await toast.promise(regenerateFonts(metadataId), {
+ loading: 'Resetting Fonts',
+ loadingDescription: `Clearing custom font cache`,
+ success: 'Fonts Reset!',
+ successDescription: 'Fonts reset and regeneration job queued',
+ error: 'Failed to reset fonts',
+ errorDescription: (err) => {
+ const axiosErr = err as AxiosError<{ message?: string }>;
+ return axiosErr.response?.data?.message ?? axiosErr.message;
+ },
+ });
+
+ subscribeToTask(result.data.task_id, { onComplete });
+ } catch (error: any) {
+ const taskId = error?.response?.data?.task_id;
+
+ if (error?.response?.status === 409 && taskId) {
+ subscribeToTask(taskId, { onComplete });
+ return;
+ }
+
+ const metadata = contentStore.stateVideo.metadata!;
+ contentStore.updateVideoData({ id: videoId, fonts: [], metadata: { ...metadata, fonts_scanned_at: undefined } });
+
+ console.error(error);
+ }
};