Skip to content

A self-hosted media server and file management system

fix: code duplication

aminnausina7c703b6d1c2
diff --git a/app/Data/Access/RateLimitData.php b/app/Data/Access/RateLimitData.php
new file mode 100644
index 00000000..674eeb7a
--- /dev/null
+++ b/app/Data/Access/RateLimitData.php
@@ -0,0 +1,12 @@
+<?php
+
+namespace App\Data\Access;
+
+final readonly class RateLimitData {
+ public function __construct(
+ public string $key,
+ public int $maxAttempts,
+ public int $decaySeconds,
+ public string $message,
+ ) {}
+}
diff --git a/app/Http/Controllers/Api/V1/Metadata/FontController.php b/app/Http/Controllers/Api/V1/Metadata/FontController.php
index 743919f1..9e3838e2 100644
--- a/app/Http/Controllers/Api/V1/Metadata/FontController.php
+++ b/app/Http/Controllers/Api/V1/Metadata/FontController.php
@@ -2,6 +2,7 @@
namespace App\Http\Controllers\Api\V1\Metadata;
+use App\Data\Access\RateLimitData;
use App\Enums\TaskStatus;
use App\Http\Controllers\Controller;
use App\Http\Resources\Metadata\FontResource;
@@ -9,14 +10,13 @@ use App\Models\Font;
use App\Models\Metadata;
use App\Models\SubTask;
use App\Services\FileJobService;
-use Illuminate\Http\JsonResponse;
+use App\Services\RateLimitService;
use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\Gate;
-use Illuminate\Support\Facades\RateLimiter;
use Illuminate\Support\Facades\Storage;
class FontController extends Controller {
- public function __construct(protected FileJobService $fileJobService) {}
+ public function __construct(protected FileJobService $fileJobService, protected RateLimitService $rateLimiter) {}
/**
* List storyboard details for metadata.
@@ -29,15 +29,17 @@ class FontController extends Controller {
}
public function regenerate(Metadata $metadata) {
+ $limits = $this->getRateLimits();
+
$isAdmin = Gate::allows('admin');
- $rateLimitError = ! $isAdmin ? $this->getRateLimitError() : null;
+ $rateLimitError = ! $isAdmin ? $this->rateLimiter->getRateLimitError($limits) : null;
if ($rateLimitError) {
return $rateLimitError;
}
if (! $isAdmin) {
- $this->hitRateLimits();
+ $this->rateLimiter->hitRateLimits($limits);
}
$alreadyRunning = SubTask::where('reference_uuid', $metadata->uuid)
@@ -50,41 +52,33 @@ class FontController extends Controller {
return response()->json(['message' => 'Font extraction already in progress', 'task_id' => $alreadyRunning->task_id], 409);
}
- $FontDir = 'metadata/' . substr($metadata->uuid, 0, 2) . "/{$metadata->uuid}/fonts";
+ $fontDir = 'metadata/' . substr($metadata->uuid, 0, 2) . "/{$metadata->uuid}/fonts";
$metadata->fonts()->update([
'path' => null,
]);
- Storage::disk('public')->deleteDirectory($FontDir);
+ Storage::disk('public')->deleteDirectory($fontDir);
$task = $this->fileJobService->regenerateFonts(Auth::id(), $metadata);
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);
+ private function getRateLimits(): array {
+ $userId = Auth::id();
+
+ return [
+ new RateLimitData(
+ key: "font-regenerate:minute:{$userId}",
+ maxAttempts: 1,
+ decaySeconds: 60,
+ message: 'Too many requests.',
+ ),
+ new RateLimitData(
+ key: "font-regenerate:hour:{$userId}",
+ maxAttempts: 15,
+ decaySeconds: 3600,
+ message: 'Hourly limit reached.',
+ ),
+ ];
}
}
diff --git a/app/Http/Controllers/Api/V1/Metadata/StoryboardController.php b/app/Http/Controllers/Api/V1/Metadata/StoryboardController.php
index 51d7b34a..6b880b64 100644
--- a/app/Http/Controllers/Api/V1/Metadata/StoryboardController.php
+++ b/app/Http/Controllers/Api/V1/Metadata/StoryboardController.php
@@ -2,6 +2,7 @@
namespace App\Http\Controllers\Api\V1\Metadata;
+use App\Data\Access\RateLimitData;
use App\Enums\TaskStatus;
use App\Http\Controllers\Controller;
use App\Http\Resources\Metadata\StoryboardResource;
@@ -9,14 +10,13 @@ use App\Models\Metadata;
use App\Models\Storyboard;
use App\Models\SubTask;
use App\Services\FileJobService;
-use Illuminate\Http\JsonResponse;
+use App\Services\RateLimitService;
use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\Gate;
-use Illuminate\Support\Facades\RateLimiter;
use Illuminate\Support\Facades\Storage;
class StoryboardController extends Controller {
- public function __construct(protected FileJobService $fileJobService) {}
+ public function __construct(protected FileJobService $fileJobService, protected RateLimitService $rateLimiter) {}
/**
* List storyboard details for metadata.
@@ -26,15 +26,16 @@ class StoryboardController extends Controller {
}
public function regenerate(Metadata $metadata) {
+ $limits = $this->getRateLimits();
$isAdmin = Gate::allows('admin');
- $rateLimitError = ! $isAdmin ? $this->getRateLimitError() : null;
+ $rateLimitError = ! $isAdmin ? $this->rateLimiter->getRateLimitError($limits) : null;
if ($rateLimitError) {
return $rateLimitError;
}
if (! $isAdmin) {
- $this->hitRateLimits();
+ $this->rateLimiter->hitRateLimits($limits);
}
$alreadyRunning = SubTask::where('reference_uuid', $metadata->uuid)
@@ -56,30 +57,22 @@ class StoryboardController extends Controller {
return response()->json(['task_id' => $task->id], 202);
}
- private function getRateLimitError(): ?JsonResponse {
- $perMinuteKey = 'storyboard-regenerate:minute:' . Auth::id();
- $perHourKey = 'storyboard-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 = 'storyboard-regenerate:minute:' . Auth::id();
- $perHourKey = 'storyboard-regenerate:hour:' . Auth::id();
-
- RateLimiter::hit($perMinuteKey, 60);
- RateLimiter::hit($perHourKey, 3600);
+ private function getRateLimits(): array {
+ $userId = Auth::id();
+
+ return [
+ new RateLimitData(
+ key: "storyboard-regenerate:minute:{$userId}",
+ maxAttempts: 1,
+ decaySeconds: 60,
+ message: 'Too many requests.',
+ ),
+ new RateLimitData(
+ key: "storyboard-regenerate:hour:{$userId}",
+ maxAttempts: 15,
+ decaySeconds: 3600,
+ message: 'Hourly limit reached.',
+ ),
+ ];
}
}
diff --git a/app/Services/RateLimitService.php b/app/Services/RateLimitService.php
new file mode 100644
index 00000000..17afccc4
--- /dev/null
+++ b/app/Services/RateLimitService.php
@@ -0,0 +1,33 @@
+<?php
+
+namespace App\Services;
+
+use App\Data\Access\RateLimitData;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Support\Facades\RateLimiter;
+
+class RateLimitService {
+ /**
+ * @param RateLimitData[] $limits
+ */
+ public function getRateLimitError(array $limits): ?JsonResponse {
+ foreach ($limits as $limit) {
+ if (RateLimiter::tooManyAttempts($limit->key, $limit->maxAttempts)) {
+ return response()->json([
+ 'message' => "{$limit->message} Try again in " . ceil(RateLimiter::availableIn($limit->key) / 60) . ' minutes.',
+ ], 429);
+ }
+ }
+
+ return null;
+ }
+
+ /**
+ * @param RateLimitData[] $limits
+ */
+ public function hitRateLimits(array $limits): void {
+ foreach ($limits as $limit) {
+ RateLimiter::hit($limit->key, $limit->decaySeconds);
+ }
+ }
+}