Skip to content

A self-hosted media server and file management system

feat: guest progress tracking

aminnausin945023ea4a06
diff --git a/app/Http/Controllers/Api/V1/PlaybackProgressController.php b/app/Http/Controllers/Api/V1/PlaybackProgressController.php
index 46f5a981..823cc3de 100644
--- a/app/Http/Controllers/Api/V1/PlaybackProgressController.php
+++ b/app/Http/Controllers/Api/V1/PlaybackProgressController.php
@@ -6,17 +6,19 @@ use App\Http\Controllers\Controller;
use App\Http\Requests\PlaybackProgressStoreRequest;
use App\Models\Metadata;
use App\Models\PlaybackProgress;
+use App\Services\Auth\GuestIdentity;
use App\Traits\HttpResponses;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Response;
-use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\Log;
class PlaybackProgressController extends Controller {
use HttpResponses;
public function show(Metadata $metadata) {
- $progress = PlaybackProgress::where('user_id', Auth::id())->where('metadata_id', $metadata->id)->first(['progress_offset', 'progress_percentage']);
+ $progress = GuestIdentity::scope(PlaybackProgress::query())
+ ->where('metadata_id', $metadata->id)
+ ->first(['progress_offset', 'progress_percentage']);
return response()->json(['progress_offset' => $progress?->progress_offset ?? 0, 'progress_percentage' => $progress?->progress_percentage ?? 0]);
}
@@ -26,8 +28,8 @@ class PlaybackProgressController extends Controller {
*/
public function upsert(PlaybackProgressStoreRequest $request, Metadata $metadata): Response|JsonResponse {
try {
- $user_id = Auth::id();
$validated = $request->validated();
+ $identity = GuestIdentity::identity(); // user_id or guest_token
$duration = $metadata->duration ?? 0;
$progressOffset = min($validated['progress_offset'], $duration);
@@ -35,7 +37,7 @@ class PlaybackProgressController extends Controller {
$threshold = config('playback.completion_percentage_threshold', 95);
if ($progressPct >= $threshold) {
- $progress = PlaybackProgress::firstOrNew(['user_id' => $user_id, 'metadata_id' => $metadata->id]);
+ $progress = PlaybackProgress::firstOrNew([...$identity, 'metadata_id' => $metadata->id]);
if ($progress->progress_percentage < $threshold) {
$progress->last_completed_at = now();
@@ -48,18 +50,32 @@ class PlaybackProgressController extends Controller {
$progress->save();
} else {
- PlaybackProgress::upsert(
+ GuestIdentity::upsert(
+ 'playback_progress',
[
- 'user_id' => $user_id,
+ ...$identity,
'metadata_id' => $metadata->id,
'progress_offset' => $progressOffset,
'progress_percentage' => $progressPct,
- 'record_id' => $validated['record_id'] ?? null, // Overwrites existing
+ 'record_id' => $validated['record_id'] ?? null,
+ 'created_at' => now(),
'updated_at' => now(),
],
- ['user_id', 'metadata_id'],
['progress_offset', 'progress_percentage', 'record_id', 'updated_at']
);
+
+ // PlaybackProgress::upsert(
+ // [
+ // ...$identity,
+ // 'metadata_id' => $metadata->id,
+ // 'progress_offset' => $progressOffset,
+ // 'progress_percentage' => $progressPct,
+ // 'record_id' => $validated['record_id'] ?? null, // Overwrites existing
+ // 'updated_at' => now(),
+ // ],
+ // GuestIdentity::uniqueKey(),
+ // ['progress_offset', 'progress_percentage', 'record_id', 'updated_at']
+ // );
}
return response()->noContent();
diff --git a/app/Http/Controllers/DirectoryController.php b/app/Http/Controllers/DirectoryController.php
index 331be0c2..150daa97 100755
--- a/app/Http/Controllers/DirectoryController.php
+++ b/app/Http/Controllers/DirectoryController.php
@@ -7,6 +7,7 @@ use App\Http\Resources\FolderResource;
use App\Models\Category;
use App\Models\Folder;
use App\Models\Subtitle;
+use App\Services\Auth\GuestIdentity;
use App\Services\PathResolverService;
use App\Services\TaskService;
use App\Traits\HttpResponses;
@@ -102,7 +103,7 @@ class DirectoryController extends Controller {
$folder->load([
'series.folderTags.tag',
'videos.metadata.videoTags.tag',
- 'videos.metadata.playbackProgress' => fn ($q) => $q->where('user_id', Auth::id())->limit(1),
+ 'videos.metadata.playbackProgress' => fn ($q) => GuestIdentity::scope($q)->limit(1),
'videos.metadata.subtitles' => function ($q) {
$q->select(Subtitle::getVisibleFields());
},
diff --git a/app/Http/Requests/PlaybackProgressStoreRequest.php b/app/Http/Requests/PlaybackProgressStoreRequest.php
index bd3dbdfc..5674340f 100644
--- a/app/Http/Requests/PlaybackProgressStoreRequest.php
+++ b/app/Http/Requests/PlaybackProgressStoreRequest.php
@@ -2,6 +2,7 @@
namespace App\Http\Requests;
+use App\Services\Auth\GuestIdentity;
use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Support\Facades\Auth;
@@ -10,7 +11,7 @@ class PlaybackProgressStoreRequest extends FormRequest {
* Determine if the user is authorized to make this request.
*/
public function authorize(): bool {
- return Auth::check();
+ return Auth::check() || GuestIdentity::guestToken();
}
/**
diff --git a/app/Services/Auth/GuestIdentity.php b/app/Services/Auth/GuestIdentity.php
new file mode 100644
index 00000000..77069fcc
--- /dev/null
+++ b/app/Services/Auth/GuestIdentity.php
@@ -0,0 +1,53 @@
+<?php
+
+namespace App\Services\Auth;
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Relations\Relation;
+use Illuminate\Support\Facades\Auth;
+use Illuminate\Support\Facades\DB;
+
+class GuestIdentity {
+ public static function isGuest(): bool {
+ return ! Auth::check();
+ }
+
+ public static function guestToken(): ?string {
+ return request()->header('X-Guest-Token');
+ }
+
+ public static function scope(Builder|Relation $query): Builder|Relation {
+ return Auth::check()
+ ? $query->where('user_id', Auth::id())
+ : $query->where('guest_token', self::guestToken());
+ }
+
+ public static function identity(): array {
+ return Auth::check()
+ ? ['user_id' => Auth::id(), 'guest_token' => null]
+ : ['user_id' => null, 'guest_token' => self::guestToken()];
+ }
+
+ public static function uniqueKey($fk = 'metadata_id'): array {
+ return Auth::check()
+ ? ['user_id', $fk]
+ : ['guest_token', $fk];
+ }
+
+ public static function upsert(string $table, array $data, array $updateColumns): void {
+ $conflictTarget = Auth::check()
+ ? '(user_id, metadata_id) WHERE user_id IS NOT NULL'
+ : '(guest_token, metadata_id) WHERE guest_token IS NOT NULL';
+
+ $columns = implode(', ', array_keys($data));
+ $placeholders = implode(', ', array_fill(0, count($data), '?'));
+ $updates = implode(', ', array_map(fn ($col) => "{$col} = EXCLUDED.{$col}", $updateColumns));
+
+ DB::statement("
+ INSERT INTO {$table} ({$columns})
+ VALUES ({$placeholders})
+ ON CONFLICT {$conflictTarget}
+ DO UPDATE SET {$updates}
+ ", array_values($data));
+ }
+}
diff --git a/database/migrations/2026_04_18_203027_add_guest_id_to_playback_progress.php b/database/migrations/2026_04_18_203027_add_guest_id_to_playback_progress.php
new file mode 100644
index 00000000..74c94751
--- /dev/null
+++ b/database/migrations/2026_04_18_203027_add_guest_id_to_playback_progress.php
@@ -0,0 +1,36 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\DB;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration {
+ /**
+ * Run the migrations.
+ */
+ public function up(): void {
+ Schema::table('playback_progress', function (Blueprint $table) {
+ $table->dropUnique(['metadata_id', 'user_id']);
+
+ $table->foreignId('user_id')->nullable()->change();
+ $table->uuid('guest_token')->nullable()->index();
+ });
+
+ DB::statement('CREATE UNIQUE INDEX progress_user_unique ON playback_progress (user_id, metadata_id) WHERE user_id IS NOT NULL');
+ DB::statement('CREATE UNIQUE INDEX progress_guest_unique ON playback_progress (guest_token, metadata_id) WHERE guest_token IS NOT NULL');
+ }
+
+ /**
+ * Reverse the migrations.
+ */
+ public function down(): void {
+ Schema::table('playback_progress', function (Blueprint $table) {
+ $table->dropIndex('progress_guest_unique');
+ $table->dropIndex('progress_user_unique');
+ $table->dropColumn('guest_token');
+ $table->foreignId('user_id')->nullable(false)->change();
+ $table->unique(['metadata_id', 'user_id']);
+ });
+ }
+};
diff --git a/routes/api.php b/routes/api.php
index afc27c95..699c48fa 100755
--- a/routes/api.php
+++ b/routes/api.php
@@ -72,9 +72,6 @@ Route::group(['middleware' => ['auth:sanctum']], function () {
Route::patch('/lyrics', [MetadataController::class, 'updateLyrics']);
// Subtitles
Route::delete('/subtitles', [SubtitleController::class, 'reset']); // clear cache
- // Progress
- Route::get('/progress', [PlaybackProgressController::class, 'show']);
- Route::put('/progress', [PlaybackProgressController::class, 'upsert']);
});
Route::prefix('/categories/{category}')->group(function () {
@@ -154,6 +151,13 @@ Route::prefix('/media/{video}')->group(function () {
Route::get('/download', [MediaController::class, 'download']);
});
+// Public Metadata
+Route::prefix('/metadata/{metadata}')->group(function () {
+ // Progress
+ Route::get('/progress', [PlaybackProgressController::class, 'show']);
+ Route::put('/progress', [PlaybackProgressController::class, 'upsert']);
+});
+
// Lyrics Service
Route::get('/metadata/{id}/lyrics/import', [ExternalMetadataController::class, 'importLyrics']);
Route::get('/metadata/{id}/lyrics/search', [ExternalMetadataController::class, 'searchLyrics']);