Skip to content

A self-hosted media server and file management system

feat: Move job functionality to service and serviceProvider

aminnausinfd7a61bfae6d
diff --git a/app/Console/Commands/IndexFilesCommand.php b/app/Console/Commands/IndexFilesCommand.php
index 3d76d819..464f9ce8 100644
--- a/app/Console/Commands/IndexFilesCommand.php
+++ b/app/Console/Commands/IndexFilesCommand.php
@@ -2,13 +2,10 @@
namespace App\Console\Commands;
-use App\Enums\TaskStatus;
-use App\Http\Controllers\DirectoryController;
use App\Jobs\IndexFiles;
use App\Jobs\SyncFiles;
-use App\Services\TaskService;
+use App\Services\FileJobService;
use Illuminate\Console\Command;
-use Illuminate\Support\Facades\Log;
class IndexFilesCommand extends Command {
/**
@@ -25,38 +22,33 @@ class IndexFilesCommand extends Command {
*/
protected $description = 'Index Media Files';
- protected $controller;
-
- /**
- * Execute the console command.
- */
- public function handle() {
- $taskService = new TaskService;
- $this->controller = new DirectoryController($taskService);
-
- return $this->handleTask();
+ public function __construct(
+ protected FileJobService $fileJobService
+ ) {
+ parent::__construct();
}
- public function handleTask() {
+ public function handle() {
$name = 'Console Index Files';
$description = 'Looks for folder and video changes in in all Libraries.';
$this->info('Starting Index Files');
+
try {
- $task = $this->controller->setupTask(null, $name, $description, 2);
- $chain = [
- new SyncFiles($task->id),
- new IndexFiles($task->id),
- ];
- $batch = $this->controller->setupBatch($chain, $task);
- $task->update(['batch_id' => $batch->id]);
$this->info('Index Files Queued!');
+ $this->fileJobService->executeBatchOperation(
+ userId: null,
+ name: $name,
+ description: $description,
+ chain: function ($task) {
+ return [
+ new SyncFiles($task->id),
+ new IndexFiles($task->id),
+ ];
+ },
+ );
return true;
} catch (\Throwable $th) {
- if ($task) {
- $task->update(['status' => TaskStatus::FAILED, 'ended_at' => now(), 'summary' => $th->getMessage()]);
- }
- Log::error($th->getMessage());
$this->error($th->getMessage());
return false;
diff --git a/app/Http/Controllers/Api/V1/JobController.php b/app/Http/Controllers/Api/V1/JobController.php
new file mode 100644
index 00000000..33874332
--- /dev/null
+++ b/app/Http/Controllers/Api/V1/JobController.php
@@ -0,0 +1,101 @@
+<?php
+
+namespace App\Http\Controllers\Api\V1;
+
+use App\Http\Controllers\Controller;
+use App\Models\Category;
+use App\Services\FileJobService;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Http\Request;
+
+class JobController extends Controller {
+ private const DEFAULT_ERROR_PREFIX = 'Error cannot ';
+
+ public function __construct(protected FileJobService $fileJobService) {}
+
+ public function scanFiles(Request $request, ?Category $category = null) {
+ return $this->handleJobRequest(
+ request: $request,
+ method: 'scanFiles',
+ jobName: 'SCAN FILES',
+ category: $category,
+ );
+ }
+
+ public function indexFiles(Request $request) {
+ return $this->handleJobRequest(
+ request: $request,
+ method: 'indexFiles',
+ jobName: 'INDEX FILES',
+ );
+ }
+
+ public function syncFiles(Request $request) {
+ return $this->handleJobRequest(
+ request: $request,
+ method: 'syncFiles',
+ jobName: 'SYNC FILES',
+ );
+ }
+
+ public function verifyFiles(Request $request, ?Category $category = null) {
+ return $this->handleJobRequest(
+ request: $request,
+ method: 'verifyFiles',
+ jobName: 'VERIFY FILES',
+ category: $category,
+ );
+ }
+
+ public function verifyFolders(Request $request, ?Category $category = null) {
+ return $this->handleJobRequest(
+ request: $request,
+ method: 'verifyFolders',
+ jobName: 'VERIFY FOLDERS',
+ category: $category,
+ );
+ }
+
+ public function cleanPaths(Request $request): JsonResponse {
+ return $this->handleJobRequest(
+ request: $request,
+ method: 'cleanPaths',
+ jobName: 'CLEAN PATHS',
+ );
+ }
+
+ /**
+ * @param 'scanFiles'|'indexFiles'|'syncFiles'|'verifyFiles'|'verifyFolders'|'cleanPaths' $method
+ */
+ protected function handleJobRequest(
+ Request $request,
+ string $method,
+ string $jobName,
+ ?Category $category = null,
+ ?string $errorMessage = null,
+ ): JsonResponse {
+ try {
+ if (! method_exists($this->fileJobService, $method)) {
+ return response()->json([
+ 'error' => 'Invalid job method',
+ 'details' => "Method $method not available",
+ ], 400);
+ }
+
+ $data = ['userId' => $request->user()?->id];
+ $task = $category
+ ? $this->fileJobService->$method($data, $category)
+ : $this->fileJobService->$method($data);
+
+ return response()->json([
+ 'task_id' => $task->id,
+ 'message' => "Async Task \"$jobName\" was started.",
+ ]);
+ } catch (\Throwable $th) {
+ return response()->json([
+ 'error' => $errorMessage ?? self::DEFAULT_ERROR_PREFIX . strtolower($jobName),
+ 'details' => $th->getMessage(),
+ ], 500);
+ }
+ }
+}
diff --git a/app/Http/Controllers/DirectoryController.php b/app/Http/Controllers/DirectoryController.php
index 9e29b343..7256561b 100755
--- a/app/Http/Controllers/DirectoryController.php
+++ b/app/Http/Controllers/DirectoryController.php
@@ -2,441 +2,188 @@
namespace App\Http\Controllers;
-use App\Enums\TaskStatus;
use App\Http\Resources\FolderResource;
use App\Http\Resources\VideoResource;
-use App\Jobs\CleanFolderPaths;
-use App\Jobs\CleanVideoPaths;
-use App\Jobs\EmbedUidInMetadata;
-use App\Jobs\IndexFiles;
-use App\Jobs\SyncFiles;
-use App\Jobs\VerifyFiles;
-use App\Jobs\VerifyFolders;
use App\Models\Category;
use App\Models\Folder;
-use App\Models\Task;
-use App\Models\Video;
+use App\Services\PathResolverService;
use App\Services\TaskService;
use App\Traits\HttpResponses;
-use Illuminate\Bus\Batch;
+use Exception;
+use Illuminate\Database\Eloquent\Collection;
+use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;
-use Illuminate\Support\Facades\Bus;
-use Illuminate\Support\Facades\Log;
-use Illuminate\Support\Str;
class DirectoryController extends Controller {
use HttpResponses;
protected $taskService;
+ protected $privateCategories = ['legacy' => 1];
+
public function __construct(TaskService $taskService) {
$this->taskService = $taskService;
}
- public function showDirectoryAPI(Request $request) {
+ public function showDirectoryAPI(Request $request, PathResolverService $resolver) {
// All this does is convert url to ids and names
// IDEALLY it should also load data to prevent requiring more api requests
// It does exactly that now it feels fast
try {
- $privateCategories = ['legacy' => 1];
- $dir = trim(strtolower($request?->dir ?? ''));
- $folderName = trim(strtolower($request?->folderName ?? ''));
-
- $dirRaw = Category::select('id', 'default_folder_id')->firstWhere('name', 'ilike', '%' . $dir . '%');
-
- if (! isset($dirRaw->id)) { // Cannot find category so return default nulls
- return $this->error(['categoryName' => $dir], 'Cannot find specified category', 404);
- }
-
- if ((isset($privateCategories[$dir]) || $dirRaw?->is_private) && (! $request->user('sanctum') || (Auth::user() && Auth::user()->id !== 1))) {
- return $this->error(null, 'Access to this folder is forbidden', 403);
- }
-
- $data = ['dir' => ['id' => null, 'name' => $dir, 'folders' => null], 'folder' => ['id' => null, 'name' => $folderName ?? null, 'videos' => null]]; // Default null values
-
- $folderList = Folder::with('series')->where('category_id', $dirRaw->id)->orderBy('name')->get(); // Folders in category
- $data['dir'] = ['id' => $dirRaw->id, 'name' => $dir, 'folders' => FolderResource::collection($folderList)]; // Full category data
-
- // TODO: Use extracted folder parsing
- $folderRaw = isset($request->folderName)
- ? (
- $data['dir']['folders']->first(function ($folder) use ($folderName) {
- return Str::lower($folder->name) === Str::lower($folderName);
- })
- ?: $data['dir']['folders']->first(function ($folder) use ($folderName) {
- return Str::contains(Str::lower($folder->name), Str::lower($folderName));
- })
- )
- : (
- isset($dirRaw->default_folder_id)
- ? $folderList->firstWhere('id', $dirRaw->default_folder_id)
- : $folderList->first()); // Folder in request ? search by name else select first in category
-
- if (! isset($folderRaw->id)) { // no folder found
- return $this->error(['categoryName' => $dir, 'folderName' => $folderName], 'Cannot find folder in specified category', 404);
- }
-
- $folderRaw->load(['videos.metadata.videoTags.tag']);
-
- $videoList = VideoResource::collection($folderRaw->videos); // VideoResource::collection(Video::where('folder_id', $folderRaw->id)->get());
- $data['folder'] = ['id' => $folderRaw->id, 'name' => $folderRaw->name, 'videos' => $videoList, 'series' => $data['dir']['folders']->first(function ($folder) use ($folderRaw) {
- return $folder->id === $folderRaw->id;
- })->series];
-
- return $this->success($data, '', 200);
- } catch (\Throwable $th) {
- return $this->error(null, 'Unable to parse URL ' . $th->getMessage(), 500);
- }
- }
-
- private function parseCategory() {
- // TODO: Extract category parsing and add support for id to name conversion
- }
-
- private function parseFolder() {
- // TODO: Extract folder parsing and add support for id to name conversion
- }
-
- // TODO: Generate the verify jobs after the indexing job has completed with a callback in setup batch
- public function scanFiles(Request $request, ?Category $category = null) {
- $name = 'Scan Files';
- $description = 'Scans for file changes and loads metadata from all Libraries.';
-
- if (isset($category)) {
- $name .= " from the Library \"$category->name\"";
- $description = "Scans for file changes and loads metadata from the specified Library \"$category->name\"";
- }
-
- try {
- $userId = $request->user() ? $request->user()->id : null;
- $task = $this->setupTask($userId, $name, $description);
-
- $chain = [
- new SyncFiles($task->id),
- new IndexFiles($task->id),
- ];
-
- $videoQuery = Video::orderBy('id');
- $folderQuery = Folder::orderBy('id');
+ $dir = $this->sanitizeInput($request->dir);
+ $folderIdentifier = $this->sanitizeInput($request->folderName);
- if ($category) {
- $videoQuery = $videoQuery->whereHas('folder.category', function ($query) use ($category) {
- $query->where('id', $category->id);
- })->with('folder.category');
+ $category = $resolver->resolveCategory($dir); // Load Category
+ $this->validateCategoryAccess($category);
- $folderQuery = $folderQuery->whereHas('category', function ($query) use ($category) {
- $query->where('id', $category->id);
- })->with('category');
- }
+ $data = $this->buildBaseResponse($category, $folderIdentifier); // Default null values
- $videos = $videoQuery->get();
- $folders = $folderQuery->get();
+ $folderList = $this->loadCategoryFolders($category->id);
+ $data['dir']['folders'] = FolderResource::collection($folderList); // Full category data as http resources
- $videos->chunk(100)->each(function ($chunk) use (&$chain, $task) {
- $chain[] = new VerifyFiles($chunk, $task->id);
- });
+ $folder = $resolver->resolveFolder($folderIdentifier, $folderList, $category); // Load folder
+ $data = $this->loadFolderData($data, new FolderResource($folder));
- $folders->chunk(100)->each(function ($chunk) use (&$chain, $task) {
- $chain[] = new VerifyFolders($chunk, $task->id);
- });
-
- $batch = $this->setupBatch($chain, $task);
- $task->update(['batch_id' => $batch->id, 'sub_tasks_total' => count($chain), 'sub_tasks_pending' => count($chain)]);
-
- return response()->json(['task_id' => $task->id, 'message' => 'Async Task "SCAN FILES" was started.']);
+ return $this->success($data, '', 200);
+ } catch (ModelNotFoundException $e) {
+ return $this->error([
+ 'categoryName' => $request->dir ?? '',
+ 'folderName' => $request->folderIdentifier ?? '',
+ ], $e->getMessage(), 404);
+ } catch (ForbiddenException $e) {
+ return $this->error(null, $e->getMessage(), 403);
} catch (\Throwable $th) {
- if ($task) {
- $task->update(['status' => TaskStatus::FAILED, 'ended_at' => now()]);
- }
-
- return response()->json(['error' => 'Error cannot scan files', 'details' => $th->getMessage()], 500);
+ return $this->error(null, 'Unable to parse URL: ' . $th->getMessage(), 500);
}
}
- public function indexFiles(Request $request, ?Category $category = null) {
- $name = 'Index Files';
- $description = 'Looks for folder and video changes in in all Libraries.';
-
- if (isset($category)) {
- $name .= " for Library $category->name";
- $description = "Looks for folder and video changes in the specified Library $category->name";
- }
-
- $userId = $request->user() ? $request->user()->id : null;
- $task = $this->setupTask($userId, $name, $description, 2);
-
- try {
- $chain = [
- new SyncFiles($task->id),
- new IndexFiles($task->id),
- ];
-
- $batch = $this->setupBatch($chain, $task);
- $task->update(['batch_id' => $batch->id]);
-
- return response()->json(['task_id' => $task->id, 'message' => 'Async Task "INDEX FILES" was started.']);
- } catch (\Throwable $th) {
- if ($task) {
- $task->update(['status' => TaskStatus::FAILED, 'ended_at' => now()]);
- }
-
- return response()->json(['error' => 'Error cannot index files', 'details' => $th->getMessage()], 500);
- // dump($th);
- }
+ private function sanitizeInput(?string $input): string {
+ return trim(strtolower($input ?? ''));
}
- public function syncFiles(Request $request) {
- $userId = $request->user() ? $request->user()->id : null;
- $task = $this->setupTask($userId, 'Sync Files', 'Syncs local file structure with database.', 1);
-
- try {
- $chain = [
- new SyncFiles($task->id),
- ];
-
- $batch = $this->setupBatch($chain, $task);
- $task->update(['batch_id' => $batch->id]);
-
- return response()->json(['task_id' => $task->id, 'message' => 'Async Task "SYNC FILES" was started.']);
- } catch (\Throwable $th) {
- if ($task) {
- $task->update(['status' => TaskStatus::FAILED, 'ended_at' => now()]);
- }
-
- return response()->json(['error' => 'Error cannot sync files', 'details' => $th->getMessage()], 500);
- }
+ private function buildBaseResponse(Category $category, string $folderName): array {
+ return [
+ 'dir' => [
+ 'id' => $category->id,
+ 'name' => $category->name,
+ 'folders' => null,
+ ],
+ 'folder' => [
+ 'id' => null,
+ 'name' => $folderName,
+ 'videos' => null,
+ 'series' => null,
+ ],
+ ];
}
- public function verifyFiles(Request $request, ?Category $category = null) {
- $name = 'Verify Files';
- $description = 'Verifies folder and video metadata for all Libraries.';
+ private function validateCategoryAccess(Category $category): void {
+ $dirName = strtolower($category->name);
- if (isset($category)) {
- $name .= " for Library \"$category->name\"";
- $description = "Verifies folder and video metadata for the specified Library \"$category->name\"";
- }
-
- try {
- $userId = $request->user() ? $request->user()->id : null;
- $task = $this->setupTask($userId, $name, $description);
-
- $chain = [];
-
- $videoQuery = Video::orderBy('id');
- $folderQuery = Folder::orderBy('id');
-
- if ($category) {
- $videoQuery = $videoQuery->whereHas('folder.category', function ($query) use ($category) {
- $query->where('id', $category->id);
- })->with('folder.category');
-
- $folderQuery = $folderQuery->whereHas('category', function ($query) use ($category) {
- $query->where('id', $category->id);
- })->with('category');
- }
-
- $videos = $videoQuery->get();
- $folders = $folderQuery->get();
-
- $videos->chunk(100)->each(function ($chunk) use (&$chain, $task) {
- $chain[] = new VerifyFiles($chunk, $task->id);
- });
-
- $folders->chunk(100)->each(function ($chunk) use (&$chain, $task) {
- $chain[] = new VerifyFolders($chunk, $task->id);
- });
-
- $batch = $this->setupBatch($chain, $task);
- $task->update(['batch_id' => $batch->id, 'sub_tasks_total' => count($chain), 'sub_tasks_pending' => count($chain)]);
-
- return response()->json(['task_id' => $task->id, 'message' => 'Async Task "VERIFY FILES" was started.']);
- } catch (\Throwable $th) {
- if ($task) {
- $task->update(['status' => TaskStatus::FAILED, 'ended_at' => now()]);
- }
-
- return response()->json(['error' => 'Error cannot verify files', 'details' => $th->getMessage()], 500);
- // dump('Error cannot verify file metadata');
- // dump($th);
+ if ((isset($privateCategories[$dirName]) || $category->is_private) && (! auth('sanctum')->check() || (Auth::user() && Auth::user()->id !== 1))) {
+ throw new ForbiddenException('Access to this folder is forbidden');
}
}
- public function verifyFolders(Request $request, ?Category $category = null) {
- $name = 'Verify Folders';
- $description = 'Verifies folder metadata for all Libraries.';
-
- if (isset($category)) {
- $name .= " for Library \"$category->name\"";
- $description = "Verifies folder metadata for the specified Library \"$category->name\"";
- }
-
- try {
- $userId = $request->user() ? $request->user()->id : null;
- $task = $this->setupTask($userId, $name, $description);
-
- $chain = [];
-
- $folderQuery = Folder::orderBy('id');
-
- if ($category) {
- $folderQuery = $folderQuery->whereHas('category', function ($query) use ($category) {
- $query->where('id', $category->id);
- })->with('category');
- }
-
- $folders = $folderQuery->get();
-
- $folders->chunk(100)->each(function ($chunk) use (&$chain, $task) {
- $chain[] = new VerifyFolders($chunk, $task->id);
- });
-
- $batch = $this->setupBatch($chain, $task);
- $task->update(['batch_id' => $batch->id, 'sub_tasks_total' => count($chain), 'sub_tasks_pending' => count($chain)]);
-
- return response()->json(['task_id' => $task->id, 'message' => 'Async Task "VERIFY FOLDERS" was started.']);
- } catch (\Throwable $th) {
- if ($task) {
- $task->update(['status' => TaskStatus::FAILED, 'ended_at' => now()]);
- }
-
- return response()->json(['error' => 'Error cannot verify folders', 'details' => $th->getMessage()], 500);
- // dump('Error cannot verify file metadata');
- // dump($th);
- }
+ private function loadCategoryFolders(int $categoryId): Collection {
+ return Folder::with('series')
+ ->where('category_id', $categoryId)
+ ->orderBy('name')
+ ->get();
}
- public function cleanPaths(Request $request) {
- $name = 'Clean Paths';
- $description = 'Cleans file and folder paths for all Libraries.';
+ private function loadFolderData(array $data, FolderResource $folder): array {
+ $folder->load(['videos.metadata.videoTags.tag']);
- try {
- $userId = $request->user() ? $request->user()->id : null;
- $task = $this->setupTask($userId, $name, $description);
-
- $chain = [];
-
- Video::orderBy('id')->chunk(20)->each(function ($chunk) use (&$chain, $task) {
- $chain[] = new CleanVideoPaths($chunk, $task->id);
- });
+ $data['folder'] = [
+ 'id' => $folder->id,
+ 'name' => $folder->name,
+ 'videos' => VideoResource::collection($folder->videos), // VideoResource::collection(Video::where('folder_id', $folderRaw->id)->get());
+ 'series' => $data['dir']['folders']
+ ->firstWhere('id', $folder->id)
+ ->series,
+ ];
- Folder::orderBy('id')->chunk(20)->each(function ($chunk) use (&$chain, $task) {
- $chain[] = new CleanFolderPaths($chunk, $task->id);
- });
-
- $batch = $this->setupBatch($chain, $task);
- $task->update(['batch_id' => $batch->id, 'sub_tasks_total' => count($chain), 'sub_tasks_pending' => count($chain)]);
-
- return response()->json(['task_id' => $task->id, 'message' => 'Async Task "CLEAN PATHS" was started.']);
- } catch (\Throwable $th) {
- if (isset($task)) {
- $task->update(['status' => TaskStatus::FAILED, 'ended_at' => now()]);
- }
-
- return response()->json(['error' => 'Error cannot clean folder or video paths', 'details' => $th->getMessage()], 500);
- }
+ return $data;
}
- /**
- * Embed UIDs in file metadata
- * Unused?
- *
- * @param array<array{path: string, uuid: string}> $files
- * @return \Illuminate\Http\JsonResponse
- */
- public function embedUIDs(int $taskId, string $name, array $files) {
- $description = 'Embeds UIDs in file metadata.';
- $lastTask = Task::find($taskId);
- try {
- $userId = $lastTask ? $lastTask->user_id : null;
- $task = $this->setupTask($userId, $name, $description);
-
- $chain = [];
- foreach ($files as $file) {
- $chain[] = new EmbedUidInMetadata($file['path'], $file['uuid'], $task->id);
- }
-
- $batch = $this->setupBatch($chain, $task);
- $task->update(['batch_id' => $batch->id, 'sub_tasks_total' => count($chain), 'sub_tasks_pending' => count($chain)]);
-
- return response()->json(['task_id' => $task->id, 'message' => 'Async Task "EMBED UIDS" was started.']);
- } catch (\Throwable $th) {
- if ($task) {
- $task->update(['status' => TaskStatus::FAILED, 'ended_at' => now()]);
- }
-
- return response()->json(['error' => 'Error cannot embed UIDs', 'details' => $th->getMessage()], 500);
- // dump($th);
- }
- }
-
- public function setupTask($userId, $name, $description = '', $taskCount = 0) {
- return $this->taskService->createTask([
- 'user_id' => $userId,
- 'name' => $name,
- 'description' => $description,
- 'sub_tasks_total' => $taskCount,
- 'sub_tasks_pending' => $taskCount,
- ]);
- }
-
- // TODO: Add a callback feature to allow new jobs after the primary jobs have completed (verify after index)
- public function setupBatch($chain, Task $task) {
- return Bus::batch($chain)->progress(function (Batch $batch) {
- // $task->refresh();
- // $task->update([
- // 'sub_tasks_pending' => $batch->pendingJobs,
- // 'sub_tasks_failed' => $batch->failedJobs,
- // 'sub_tasks_complete' => $task->sub_tasks_total - $batch->pendingJobs - $batch->failedJobs,
- // ]);
- })->catch(function (Batch $batch, \Throwable $e) use ($task) {
- $task->update([
- 'status' => TaskStatus::FAILED,
- ]);
-
- Log::error('Batch failed', ['task_id' => $task->id, 'error' => $e->getMessage()]);
- })->finally(function (Batch $batch) use ($task) {
- $task->refresh();
- // if task is not still processing, don't change what the current status is
- // otherwise base status on batch info
- $status = $task->status !== TaskStatus::PROCESSING || $task->sub_tasks_total !== $batch->totalJobs ?
- $task->status : ($batch->cancelled() ?
- TaskStatus::CANCELLED : ($batch->processedJobs() > $task->sub_tasks_total ?
- TaskStatus::INCOMPLETE :
- TaskStatus::COMPLETED
- ));
-
- if ($task->status == TaskStatus::PROCESSING && $task->sub_tasks_total !== $batch->totalJobs) {
- return;
- }
-
- $ended_at = now();
-
- try {
- $started_at = $task->started_at ? \Carbon\Carbon::parse($task->started_at) : null;
- $duration = $started_at ? (int) $ended_at->diffInSeconds($started_at) : 0;
- } catch (\Throwable $th) {
- Log::error('Batch Error on Completion', ['task_id' => $task->id, 'error' => $th->getMessage()]);
- $duration = 0;
- }
-
- try {
- $this->taskService->updateTask($task->id, [
- 'status' => $status,
- // 'sub_tasks_pending' => $batch->pendingJobs,
- // 'sub_tasks_failed' => $batch->failedJobs,
- // 'sub_tasks_complete' => $task->sub_tasks_total - $batch->pendingJobs - $batch->failedJobs,
- 'ended_at' => $ended_at,
- 'duration' => $duration < 0 ? $duration * -1 : $duration,
- ], $status === TaskStatus::COMPLETED);
- } catch (\Throwable $th) {
- Log::error('Error when completing task', $th->getMessage());
- }
- })->before(function (Batch $batch) use ($task) {
- $this->taskService->updateTask($task->id, [
- 'status' => TaskStatus::PROCESSING,
- 'started_at' => now(),
- ]);
- })->name($task->name)->dispatch();
- }
+ // private function parseCategory(string $dirName, ?array $selectQuery = ['id', 'name', 'default_folder_id', 'is_private']): Category {
+ // //TODO: Use Path Resolver to support name or id
+
+ // $query = Category::select(...$selectQuery);
+
+ // $category = Category::select(...$selectQuery)
+ // ->firstWhere('name', 'like', '%' . $dirName . '%');
+
+ // if ($category) {
+ // return $category;
+ // }
+
+ // if (!ctype_digit($dirName) || (int)$dirName <= 0) {
+ // throw new ModelNotFoundException("No category found with name matching '{$dirName}'");
+ // }
+
+ // try {
+ // return $query->findOrFail((int)$dirName);
+ // } catch (ModelNotFoundException $e) {
+ // throw new ModelNotFoundException(
+ // "No category found with name or ID matching '{$dirName}'",
+ // 0,
+ // $e
+ // );
+ // }
+ // }
+
+ // private function parseFolder(array $data, Category $category): FolderResource {
+ // $folderIdentifier = trim($data['folder']['name'] ?? '');
+ // $folder = empty($folderIdentifier) ? $this->getDefaultFolder($data['dir']['folders'], $category) : $this->getFolderByName($data['dir']['folders'], $folderIdentifier);
+
+ // if (!empty($folderIdentifier)) {
+ // $folder = $this->getFolderByName($data['dir']['folders'], $folderIdentifier);
+ // if ($folder) {
+ // return $folder;
+ // }
+ // } else {
+ // return $this->getDefaultFolder($data['dir']['folders'], $category);
+ // }
+
+ // if ($folder) {
+ // return $folder;
+ // }
+
+ // if (!ctype_digit($folderIdentifier) || (int)$folderIdentifier <= 0) {
+ // throw new ModelNotFoundException("No folder found in category '{$category->name}' with name matching '{$folderIdentifier}'");
+ // }
+
+ // try {
+ // return Folder::where('category_id', $category->id)
+ // ->findOrFail($folderIdentifier);
+ // } catch (ModelNotFoundException $e) {
+ // throw new ModelNotFoundException(
+ // "No folder found in category '{$category->name}' with name or ID matching '{$folderIdentifier}'",
+ // 0,
+ // $e
+ // );
+ // }
+ // }
+
+ // private function getDefaultFolder(ResourceCollection $folders, Category $category): FolderResource {
+ // return $category->default_folder_id
+ // ? $folders->firstWhere('id', $category->default_folder_id)
+ // : $folders->first();
+ // }
+
+ // private function getFolderByName(ResourceCollection $folders, string $folderName): ?FolderResource {
+ // //TODO: Use Path Resolver to support name or id
+ // $folderName = strtolower($folderName);
+
+ // return $folders->first(function ($folder) use ($folderName) {
+ // return strtolower($folder->name) === $folderName;
+ // }) ?? $folders->first(function ($folder) use ($folderName) {
+ // return str_contains(strtolower($folder->name), $folderName);
+ // });
+ // }
}
+
+class ForbiddenException extends Exception {}
diff --git a/app/Jobs/IndexFiles.php b/app/Jobs/IndexFiles.php
index 2d152bab..a9badc84 100755
--- a/app/Jobs/IndexFiles.php
+++ b/app/Jobs/IndexFiles.php
@@ -77,7 +77,7 @@ class IndexFiles implements ShouldBeUnique, ShouldQueue {
foreach ($this->embedChain as $embedTask) {
Bus::dispatch($embedTask);
}
- // $controller = new DirectoryController($this->taskService);
+ // $controller = new JobController($this->taskService);
// $controller->embedUIDs($this->taskId, "Embed UIDs for task $this->taskId via Index Files", $this->embedChain);
} else {
$this->taskService->updateTaskCounts($this->taskId, ['sub_tasks_complete' => '++'], false);
diff --git a/app/Jobs/ScheduledIndexFiles.php b/app/Jobs/ScheduledIndexFiles.php
index f514a042..abd78860 100644
--- a/app/Jobs/ScheduledIndexFiles.php
+++ b/app/Jobs/ScheduledIndexFiles.php
@@ -3,7 +3,7 @@
namespace App\Jobs;
use App\Enums\TaskStatus;
-use App\Http\Controllers\DirectoryController;
+use App\Services\FileJobService;
use App\Services\TaskService;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
@@ -19,7 +19,7 @@ class ScheduledIndexFiles implements ShouldQueue {
public function __construct() {
$taskService = new TaskService;
- $this->controller = new DirectoryController($taskService);
+ $this->controller = new FileJobService($taskService);
}
/**
diff --git a/app/Jobs/VerifyFiles.php b/app/Jobs/VerifyFiles.php
index 569e0b8a..e063c4b9 100755
--- a/app/Jobs/VerifyFiles.php
+++ b/app/Jobs/VerifyFiles.php
@@ -94,7 +94,7 @@ class VerifyFiles implements ShouldQueue {
foreach ($this->embedChain as $embedTask) {
Bus::dispatch($embedTask);
}
- // $controller = new DirectoryController($this->taskService);
+ // $controller = new JobController($this->taskService);
// $controller->embedUIDs($this->taskId, "Embed UIDs for task $this->taskId via Verify Files", $this->embedChain);
} else {
$this->taskService->updateTaskCounts($this->taskId, ['sub_tasks_complete' => '++'], false);
diff --git a/app/Models/Task.php b/app/Models/Task.php
index 78e68350..6d2999c9 100644
--- a/app/Models/Task.php
+++ b/app/Models/Task.php
@@ -18,6 +18,7 @@ class Task extends Model {
'sub_tasks_pending',
'sub_tasks_complete',
'sub_tasks_failed',
+ 'sub_tasks_current',
'duration',
'started_at',
'ended_at',
diff --git a/app/Providers/PathResolverServiceProvider.php b/app/Providers/PathResolverServiceProvider.php
new file mode 100644
index 00000000..834c4131
--- /dev/null
+++ b/app/Providers/PathResolverServiceProvider.php
@@ -0,0 +1,18 @@
+<?php
+
+namespace App\Providers;
+
+use App\Services\PathResolverService;
+use Illuminate\Support\ServiceProvider;
+
+class PathResolverServiceProvider extends ServiceProvider {
+ public function register(): void {
+ $this->app->singleton(PathResolverService::class, function ($app) {
+ return new PathResolverService;
+ });
+ }
+
+ public function boot(): void {
+ //
+ }
+}
diff --git a/app/Services/FileJobService.php b/app/Services/FileJobService.php
new file mode 100644
index 00000000..8d08a9b7
--- /dev/null
+++ b/app/Services/FileJobService.php
@@ -0,0 +1,339 @@
+<?php
+
+namespace App\Services;
+
+use App\Enums\TaskStatus;
+use App\Jobs\CleanFolderPaths;
+use App\Jobs\CleanVideoPaths;
+use App\Jobs\EmbedUidInMetadata;
+use App\Jobs\IndexFiles;
+use App\Jobs\SyncFiles;
+use App\Jobs\VerifyFiles;
+use App\Jobs\VerifyFolders;
+use App\Models\Category;
+use App\Models\Folder;
+use App\Models\Task;
+use App\Models\Video;
+use Illuminate\Bus\Batch;
+use Illuminate\Support\Facades\Bus;
+use Illuminate\Support\Facades\Log;
+
+class FileJobService {
+ public function __construct(protected TaskService $taskService) {}
+
+ public function scanFiles(array $data, ?Category $category = null) {
+ $name = 'Scan Files';
+ $description = 'Scans for file changes and loads metadata from all Libraries.';
+ $categoryId = null;
+
+ if (isset($category)) {
+ $name .= " from the Library \"$category->name\"";
+ $description = "Scans for file changes and loads metadata from the specified Library \"$category->name\"";
+ $categoryId = $category->id;
+ }
+
+ return $this->executeBatchOperation(
+ userId: $data['userId'] ?? null,
+ name: $name,
+ description: $description,
+ chain: function ($task) {
+ return [
+ new SyncFiles($task->id),
+ new IndexFiles($task->id),
+ ];
+ },
+ callback: function ($task) use ($data, $categoryId) {
+ $category = $categoryId ? Category::findOrFail($categoryId) : null;
+ $this->verifyFiles($data, $category, $task->id);
+ }
+ );
+ }
+
+ public function indexFiles(array $data, ?Category $category = null) {
+ $name = 'Index Files';
+ $description = 'Looks for folder and video changes in in all Libraries.';
+
+ if (isset($category)) {
+ $name .= " for Library $category->name";
+ $description = "Looks for folder and video changes in the specified Library $category->name";
+ }
+
+ return $this->executeBatchOperation(
+ userId: $data['userId'] ?? null,
+ name: $name,
+ description: $description,
+ chain: function ($task) {
+ return [
+ new SyncFiles($task->id),
+ new IndexFiles($task->id),
+ ];
+ },
+ );
+ }
+
+ public function syncFiles(array $data) {
+ return $this->executeBatchOperation(
+ userId: $data['userId'] ?? null,
+ name: 'Sync Files',
+ description: 'Syncs local file structure with database.',
+ chain: function ($task) {
+ return [
+ new SyncFiles($task->id),
+ ];
+ },
+ );
+ }
+
+ public function verifyFiles(array $data, ?Category $category = null, ?int $taskId = null) {
+ $name = 'Verify Files';
+ $description = 'Verifies folder and video metadata for all Libraries.';
+
+ if (isset($category)) {
+ $name .= " for Library \"$category->name\"";
+ $description = "Verifies folder and video metadata for the specified Library \"$category->name\"";
+ }
+
+ return $this->executeBatchOperation(
+ userId: $data['userId'] ?? null,
+ name: $name,
+ description: $description,
+ chain: function ($task) use ($category) {
+ $chain = [];
+
+ $videoQuery = Video::orderBy('id');
+ $folderQuery = Folder::orderBy('id');
+
+ if ($category) {
+ $videoQuery = $videoQuery->whereHas('folder.category', function ($query) use ($category) {
+ $query->where('id', $category->id);
+ })->with('folder.category');
+
+ $folderQuery = $folderQuery->whereHas('category', function ($query) use ($category) {
+ $query->where('id', $category->id);
+ })->with('category');
+ }
+
+ $videoQuery->chunk(100, function ($chunk) use (&$chain, $task) {
+ $chain[] = new VerifyFiles($chunk, $task->id);
+ });
+
+ $folderQuery->chunk(100, function ($chunk) use (&$chain, $task) {
+ $chain[] = new VerifyFolders($chunk, $task->id);
+ });
+
+ return $chain;
+ },
+ initialTaskId: $taskId,
+ );
+ }
+
+ public function verifyFolders(array $data, ?Category $category = null) {
+ $name = 'Verify Folders';
+ $description = 'Verifies folder metadata for all Libraries.';
+
+ if (isset($category)) {
+ $name .= " for Library \"$category->name\"";
+ $description = "Verifies folder metadata for the specified Library \"$category->name\"";
+ }
+
+ return $this->executeBatchOperation(
+ userId: $data['userId'] ?? null,
+ name: $name,
+ description: $description,
+ chain: function ($task) use ($category) {
+ $chain = [];
+ $query = Folder::orderBy('id');
+
+ if ($category) {
+ $query->whereHas('category', fn ($q) => $q->where('id', $category->id))
+ ->with('category');
+ }
+
+ $query->chunk(100, function ($chunk) use (&$chain, $task) {
+ $chain[] = new VerifyFolders($chunk, $task->id);
+ });
+
+ return $chain;
+ },
+ );
+ }
+
+ public function cleanPaths(array $data) {
+ $name = 'Clean Paths';
+ $description = 'Cleans file and folder paths for all Libraries.';
+
+ return $this->executeBatchOperation(
+ userId: $data['userId'] ?? null,
+ name: $name,
+ description: $description,
+ chain: function ($task) {
+ $chain = [];
+
+ Video::orderBy('id')->chunk(20)->each(function ($chunk) use (&$chain, $task) {
+ $chain[] = new CleanVideoPaths($chunk, $task->id);
+ });
+
+ Folder::orderBy('id')->chunk(20)->each(function ($chunk) use (&$chain, $task) {
+ $chain[] = new CleanFolderPaths($chunk, $task->id);
+ });
+
+ return $chain;
+ },
+ );
+ }
+
+ /**
+ * Embed UIDs in file metadata
+ * Unused?
+ *
+ * @param array<array{path: string, uuid: string}> $files
+ * @return \Illuminate\Http\JsonResponse
+ */
+ public function embedUIDs(int $taskId, string $name, array $files) {
+ $description = 'Embeds UIDs in file metadata.';
+ $lastTask = Task::find($taskId);
+
+ return $this->executeBatchOperation(
+ userId: $lastTask ? $lastTask->user_id : null,
+ name: $name,
+ description: $description,
+ chain: function ($task) use ($files) {
+ $chain = [];
+
+ foreach ($files as $file) {
+ $chain[] = new EmbedUidInMetadata($file['path'], $file['uuid'], $task->id);
+ }
+
+ return $chain;
+ },
+ );
+ }
+
+ public function executeBatchOperation(
+ ?int $userId,
+ string $name,
+ string $description,
+ array|callable $chain,
+ ?callable $callback = null,
+ array $initialTaskData = [],
+ ?int $initialTaskId = null,
+ ) {
+ $task = $initialTaskId ? Task::findOrFail($initialTaskId) : $this->setupTask($userId, $name, $description);
+
+ try {
+ $finalChain = is_callable($chain) ? $chain($task) : $chain;
+ $chainLength = count($finalChain);
+
+ $taskData = array_merge([
+ 'sub_tasks_total' => $chainLength + $task->sub_tasks_total,
+ 'sub_tasks_pending' => $chainLength,
+ 'sub_tasks_current' => $chainLength,
+ ], $initialTaskData);
+
+ $this->setupBatch(
+ $finalChain,
+ $task,
+ $callback,
+ $taskData
+ );
+
+ return $task;
+ } catch (\Throwable $th) {
+ $this->handleOperationFailure($task, $th);
+ throw $th;
+ }
+ }
+
+ public function setupTask($userId, $name, $description = '', $taskCount = 0) {
+ return $this->taskService->createTask([
+ 'user_id' => $userId,
+ 'name' => $name,
+ 'description' => $description,
+ 'sub_tasks_total' => $taskCount,
+ 'sub_tasks_pending' => $taskCount,
+ ]);
+ }
+
+ public function setupBatch(array $chain, Task $task, ?callable $callback = null, ?array $taskData = []) {
+ return Bus::batch($chain)
+ ->catch(fn (Batch $batch, \Throwable $e) => $this->handleOperationFailure($task, $e))
+ ->finally(fn (Batch $batch) => $this->finalizeBatch($batch, $task, $callback))
+ ->before(fn (Batch $batch) => $this->taskService->updateTask($task->id, array_merge([
+ 'status' => TaskStatus::PROCESSING,
+ 'started_at' => $task->started_at ?? now(),
+ 'batch_id' => $batch->id,
+ ], $taskData)))
+ ->name($task->name)
+ ->dispatch();
+ }
+
+ protected function finalizeBatch(Batch $batch, Task $task, ?callable $callback) {
+ $task->refresh();
+ // if task is not still processing, don't change what the current status is
+ // otherwise base status on batch info
+
+ // if not processing or numbers dont match, task was ended elsewhere or has not started ?
+ if ($task->status !== TaskStatus::PROCESSING || $task->sub_tasks_current !== $batch->totalJobs) {
+ Log::warning('Early finalize batch return', [$task->sub_tasks_current, $batch->totalJobs]);
+
+ return;
+ // Might be incorrect
+ // The idea is if the status was updated elsewhere, let them finish the job.
+ // Same goes for total tasks being different from the batch, meaning tasks were added externally.
+ }
+
+ $status = $batch->cancelled()
+ ? TaskStatus::CANCELLED
+ : ($batch->processedJobs() > $task->sub_tasks_total
+ ? TaskStatus::INCOMPLETE
+ : TaskStatus::COMPLETED);
+
+ try {
+ if ($callback) {
+ $callback($task);
+
+ return;
+ }
+
+ $duration = $task->started_at
+ ? (int) now()->diffInSeconds($task->started_at)
+ : 0;
+
+ $this->taskService->updateTask($task->id, [
+ 'status' => $status,
+ 'ended_at' => now(),
+ 'duration' => abs($duration),
+ ], $status === TaskStatus::COMPLETED);
+ } catch (\Throwable $th) {
+ Log::error('Error finalizing batch', [
+ 'task_id' => $task->id,
+ 'error' => $th->getMessage(),
+ ]);
+ throw $th;
+ }
+ }
+
+ protected function handleOperationFailure(?Task $task, \Throwable $exception) {
+ if (! $task) {
+ return;
+ }
+
+ try {
+ $this->taskService->updateTask($task->id, [
+ 'status' => TaskStatus::FAILED,
+ 'ended_at' => now(),
+ ]);
+
+ Log::error('Batch operation failed', [
+ 'task_id' => $task->id,
+ 'error' => $exception->getMessage(),
+ ]);
+ } catch (\Throwable $updateError) {
+ Log::error('Failed to update task status', [
+ 'task_id' => $task->id,
+ 'original_error' => $exception->getMessage(),
+ 'update_error' => $updateError->getMessage(),
+ ]);
+ }
+ }
+}
diff --git a/app/Services/PathResolverService.php b/app/Services/PathResolverService.php
new file mode 100644
index 00000000..d09f170c
--- /dev/null
+++ b/app/Services/PathResolverService.php
@@ -0,0 +1,79 @@
+<?php
+
+namespace App\Services;
+
+use App\Models\Category;
+use App\Models\Folder;
+use Illuminate\Database\Eloquent\Collection;
+use Illuminate\Database\Eloquent\ModelNotFoundException;
+
+// TODO: Finish this. Unused for now.
+
+class PathResolverService {
+ public function resolveCategory(string $identifier, array $select = ['id', 'name', 'default_folder_id', 'is_private']): Category {
+ return $this->firstSuccessful([
+ fn () => $this->resolveCategoryByName($identifier, $select),
+ fn () => $this->resolveCategoryById($identifier, $select),
+ ], "No category found matching '{$identifier}'");
+ }
+
+ private function resolveCategoryByName(string $identifier, array $select): ?Category {
+ return Category::select(...$select)
+ ->whereRaw('LOWER(name) = ?', [strtolower($identifier)])
+ ->first();
+ }
+
+ private function resolveCategoryById(string $identifier, array $select): ?Category {
+ if (! ctype_digit($identifier) || (int) $identifier <= 0) {
+ return null;
+ }
+
+ return Category::select(...$select)->find((int) $identifier);
+ }
+
+ public function resolveFolder(string $identifier, Collection $folders, Category $category): Folder {
+ return $this->firstSuccessful([
+ fn () => $this->resolveFolderByName($identifier, $folders, $category),
+ fn () => $this->resolveFolderById($identifier, $folders, $category),
+ ], "No folder found in category '{$category->name}' matching '{$identifier}'");
+ }
+
+ private function resolveFolderById(string $identifier, Collection $folders, Category $category): ?Folder {
+ if (! ctype_digit($identifier) || (int) $identifier <= 0) {
+ return null;
+ }
+
+ return $folders->where('category_id', $category->id)->find((int) $identifier);
+ }
+
+ private function resolveDefaultFolder(Collection $folders, Category $category): Folder {
+ return $category->default_folder_id
+ ? $folders->firstWhere('id', $category->default_folder_id)
+ : $folders->first();
+ }
+
+ private function resolveFolderByName(string $identifier, Collection $folders, Category $category): ?Folder {
+ if (! $identifier) {
+ return $this->resolveDefaultFolder($folders, $category);
+ }
+
+ $identifier = strtolower($identifier);
+
+ return $folders->first(function ($folder) use ($identifier) {
+ return strtolower($folder->name) === $identifier;
+ }) ?? $folders->first(function ($folder) use ($identifier) {
+ return str_contains(strtolower($folder->name), $identifier);
+ });
+ }
+
+ private function firstSuccessful(array $resolvers, string $errorMessage) {
+ foreach ($resolvers as $resolver) {
+ $result = $resolver();
+ if ($result) {
+ return $result;
+ }
+ }
+
+ throw new ModelNotFoundException($errorMessage);
+ }
+}
diff --git a/bootstrap/cache/services.php b/bootstrap/cache/services.php
index d7268f25..6f9c6c4a 100755
--- a/bootstrap/cache/services.php
+++ b/bootstrap/cache/services.php
@@ -44,6 +44,7 @@
40 => 'Robertogallea\\PulseApi\\PulseAPIServiceProvider',
41 => 'App\\Providers\\AppServiceProvider',
42 => 'App\\Providers\\AppServiceProvider',
+ 43 => 'App\\Providers\\PathResolverServiceProvider',
),
'eager' =>
array (
@@ -73,6 +74,7 @@
23 => 'Robertogallea\\PulseApi\\PulseAPIServiceProvider',
24 => 'App\\Providers\\AppServiceProvider',
25 => 'App\\Providers\\AppServiceProvider',
+ 26 => 'App\\Providers\\PathResolverServiceProvider',
),
'deferred' =>
array (
diff --git a/bootstrap/providers.php b/bootstrap/providers.php
index 38b258d1..33f1d990 100644
--- a/bootstrap/providers.php
+++ b/bootstrap/providers.php
@@ -2,4 +2,5 @@
return [
App\Providers\AppServiceProvider::class,
+ App\Providers\PathResolverServiceProvider::class,
];
diff --git a/database/migrations/2025_04_20_182652_add_current_jobs_to_task.php b/database/migrations/2025_04_20_182652_add_current_jobs_to_task.php
new file mode 100644
index 00000000..8decfca8
--- /dev/null
+++ b/database/migrations/2025_04_20_182652_add_current_jobs_to_task.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('tasks', function (Blueprint $table) {
+ $table->unsignedSmallInteger('sub_tasks_current')->default(0);
+ });
+ }
+
+ /**
+ * Reverse the migrations.
+ */
+ public function down(): void {
+ Schema::table('tasks', function (Blueprint $table) {
+ $table->dropColumn('sub_tasks_current');
+ });
+ }
+};
diff --git a/routes/api.php b/routes/api.php
index 5b123033..d35fe7e0 100755
--- a/routes/api.php
+++ b/routes/api.php
@@ -4,6 +4,7 @@ use App\Http\Controllers\Api\V1\AnalyticsController;
use App\Http\Controllers\Api\V1\AuthController;
use App\Http\Controllers\Api\V1\CategoryController;
use App\Http\Controllers\Api\V1\FolderController;
+use App\Http\Controllers\Api\V1\JobController;
use App\Http\Controllers\Api\V1\MetadataController;
use App\Http\Controllers\Api\V1\PlaybackController;
use App\Http\Controllers\Api\V1\ProfileController;
@@ -47,12 +48,12 @@ Route::group(['middleware' => ['auth:sanctum']], function () {
Route::prefix('tasks')->group(function () {
Route::get('/stats', [TaskController::class, 'stats']);
- Route::post('/sync', [DirectoryController::class, 'syncFiles']);
- Route::post('/index/{category?}', [DirectoryController::class, 'indexFiles']);
- Route::post('/verify/{category?}', [DirectoryController::class, 'verifyFiles']);
- Route::post('/verify-folders/{category?}', [DirectoryController::class, 'verifyFolders']);
- Route::post('/scan/{category?}', [DirectoryController::class, 'scanFiles']);
- Route::post('/clean', [DirectoryController::class, 'cleanPaths']);
+ Route::post('/sync', [JobController::class, 'syncFiles']);
+ Route::post('/index/{category?}', [JobController::class, 'indexFiles']);
+ Route::post('/verify/{category?}', [JobController::class, 'verifyFiles']);
+ Route::post('/verify-folders/{category?}', [JobController::class, 'verifyFolders']);
+ Route::post('/scan/{category?}', [JobController::class, 'scanFiles']);
+ Route::post('/clean', [JobController::class, 'cleanPaths']);
Route::post('/cancel/{task}', [TaskController::class, 'cancel']);
});
});