feature: refactoring the tag system

Author: ildyria

app/Actions/Album/CreateTagAlbum.php

@@ -10,6 +10,7 @@
 
 use App\Exceptions\ModelDBException;
 use App\Exceptions\UnauthenticatedException;
+use App\Models\Tag;
 use App\Models\TagAlbum;
 use Illuminate\Support\Facades\Auth;
 
@@ -33,7 +34,7 @@ public function create(string $title, array $show_tags): TagAlbum
 
 		$album = new TagAlbum();
 		$album->title = $title;
-		$album->show_tags = $show_tags;
+		$album->show_tags = Tag::from($show_tags)->all();
 		$album->owner_id = $user_id;
 		$album->save();
 		$this->setStatistics($album);

app/Actions/Album/PositionData.php

@@ -35,6 +35,7 @@ public function get(AbstractAlbum $album, bool $include_sub_albums = false): Pos
 					$r->whereBetween('type', [SizeVariantType::SMALL2X, SizeVariantType::THUMB]);
 				},
 				'palette',
+				'tags',
 			])
 			->whereNotNull('latitude')
 			->whereNotNull('longitude');

app/Actions/Albums/PositionData.php

@@ -49,6 +49,7 @@ public function do(): PositionDataResource
 						$r->whereBetween('type', [SizeVariantType::SMALL2X, SizeVariantType::THUMB]);
 					},
 					'palette',
+					'tags',
 				])
 				->whereNotNull('latitude')
 				->whereNotNull('longitude'),

app/Actions/Photo/Pipes/Shared/HydrateMetadata.php

@@ -38,7 +38,8 @@ public function handle(DuplicateDTO|StandaloneDTO $state, \Closure $next): Dupli
 			$state->photo->description = $state->exif_info->description;
 		}
 		if (count($state->photo->tags) === 0) {
-			$state->photo->tags = $state->exif_info->tags;
+			// TODO FIX ME.
+			// $state->photo->tags = $state->exif_info->tags;
 		}
 		if ($state->photo->type === null) {
 			$state->photo->type = $state->exif_info->type;

app/Actions/Search/PhotoSearch.php

@@ -57,7 +57,7 @@ public function query(array $terms): Collection
 	public function sqlQuery(array $terms, ?Album $album = null): Builder
 	{
 		$query = $this->photoQueryPolicy->applySearchabilityFilter(
-			query: Photo::query()->with(['albums', 'statistics', 'size_variants', 'palette']),
+			query: Photo::query()->with(['albums', 'statistics', 'size_variants', 'palette', 'tags']),
 			origin: $album,
 			include_nsfw: !Configs::getValueAsBool('hide_nsfw_in_search')
 		);
@@ -67,7 +67,7 @@ public function sqlQuery(array $terms, ?Album $album = null): Builder
 				fn (FixedQueryBuilder $query) => $query
 					->where('title', 'like', '%' . $term . '%')
 					->orWhere('description', 'like', '%' . $term . '%')
-					->orWhere('tags', 'like', '%' . $term . '%')
+					// ->orWhere('tags', 'like', '%' . $term . '%')
 					->orWhere('location', 'like', '%' . $term . '%')
 					->orWhere('model', 'like', '%' . $term . '%')
 					->orWhere('taken_at', 'like', '%' . $term . '%')

app/Casts/ArrayCast.php app/Casts/TagArrayCast.phpapp/Casts/ArrayCast.php renamed to app/Casts/TagArrayCast.php

@@ -8,48 +8,53 @@
 
 namespace App\Casts;
 
+use App\Models\Tag;
 use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
 use Illuminate\Database\Eloquent\Model;
 
 /**
- * @implements CastsAttributes<array,(string|null)[]>
+ * @implements CastsAttributes<array,(Tag|null)[]>
  */
-class ArrayCast implements CastsAttributes
+class TagArrayCast implements CastsAttributes
 {
 	/**
 	 * @param Model               $model      the associated model class
 	 * @param string              $key        the name of the SQL column holding the stringified array
 	 * @param mixed               $value      the stringified array
 	 * @param array<string,mixed> $attributes all SQL attributes of the entity
 	 *
-	 * @return array<int,string> the array
+	 * @return array<int,Tag> the array
 	 */
 	public function get(Model $model, string $key, mixed $value, array $attributes): array
 	{
-		return ($value === null || $value === '') ? [] : explode(',', strval($value));
+		if ($value === null || $value === '') {
+			return [];
+		}
+
+		// Split the string by ' OR ' and return an array of Tag objects
+		return Tag::whereIn('id', explode(' OR ', strval($value)))->get()->all();
 	}
 
 	/**
-	 * @param Model                $model      the associated model class
-	 * @param string               $key        the name of the SQL column holding the stringified array
-	 * @param (string|null)[]|null $value      the array
-	 * @param array<string,mixed>  $attributes
+	 * @param Model               $model      the associated model class
+	 * @param string              $key        the name of the SQL column holding the stringified array
+	 * @param (Tag|null)[]|null   $value      the array
+	 * @param array<string,mixed> $attributes
 	 *
 	 * @return array<string,mixed> An associative map of SQL columns and their values
 	 */
 	public function set(Model $model, string $key, mixed $value, array $attributes): array
 	{
 		// Normalize the input value
-		// The array must not contain empty tags and tags which contain a comma
 		// TODO: Either use a separate table to store the tags or another encoding (e.g. JSON) which also allows commas in tags
 
 		$arr = !is_array($value) ? [] : array_values(array_filter(
 			$value,
-			fn ($elem) => ($elem !== null && $elem !== '' && !str_contains($elem, ',')),
+			fn ($elem) => ($elem !== null && $elem !== '' && $elem instanceof Tag && $elem->name !== ''),
 		));
 
 		return [
-			$key => count($arr) === 0 ? null : implode(',', $arr),
+			$key => count($arr) === 0 ? null : implode(' OR ', array_map(fn ($t) => $t->id, $arr)),
 		];
 	}
 }

app/Factories/AlbumFactory.php

@@ -96,8 +96,8 @@ public function findBaseAlbumOrFail(string $album_id, bool $with_relations = tru
 		$tag_album_query = TagAlbum::query();
 
 		if ($with_relations) {
-			$album_query->with(['access_permissions', 'photos', 'children', 'children.owner', 'photos.size_variants', 'photos.statistics', 'photos.palette']);
-			$tag_album_query->with(['photos', 'photos.size_variants', 'photos.statistics', 'photos.palette']);
+			$album_query->with(['access_permissions', 'photos', 'children', 'children.owner', 'photos.size_variants', 'photos.statistics', 'photos.palette', 'photos.tags']);
+			$tag_album_query->with(['photos', 'photos.size_variants', 'photos.statistics', 'photos.palette', 'photos.tags']);
 		}
 
 		$ret = $album_query->find($album_id) ?? $tag_album_query->find($album_id);

app/Http/Controllers/Gallery/AlbumController.php

@@ -57,6 +57,7 @@
 use App\Http\Resources\Models\Utils\AlbumProtectionPolicy;
 use App\Models\Album;
 use App\Models\Extensions\BaseAlbum;
+use App\Models\Tag;
 use App\Models\TagAlbum;
 use App\SmartAlbums\BaseSmartAlbum;
 use Illuminate\Routing\Controller;
@@ -165,7 +166,7 @@ public function updateTagAlbum(UpdateTagAlbumRequest $request): EditableBaseAlbu
 		}
 		$album->title = $request->title();
 		$album->description = $request->description();
-		$album->show_tags = $request->tags();
+		$album->show_tags = Tag::from($request->tags())->all();
 		$album->copyright = $request->copyright();
 		$album->photo_sorting = $request->photoSortingCriterion();
 		$album->photo_layout = $request->photoLayout();

app/Http/Controllers/Gallery/FrameController.php

@@ -86,12 +86,12 @@ private function loadPhoto(AbstractAlbum|null $album, int $retries = 5): ?Photo
 		// default query
 		if ($album === null) {
 			$query = $this->photo_query_policy->applySearchabilityFilter(
-				query: Photo::query()->with(['albums', 'size_variants', 'palette']),
+				query: Photo::query()->with(['albums', 'size_variants', 'palette', 'tags']),
 				origin: null,
 				include_nsfw: !Configs::getValueAsBool('hide_nsfw_in_frame')
 			);
 		} else {
-			$query = $album->photos()->with(['albums', 'size_variants', 'palette']);
+			$query = $album->photos()->with(['albums', 'size_variants', 'palette', 'tags']);
 		}
 
 		/** @var ?Photo $photo */

app/Http/Controllers/Gallery/PhotoController.php

@@ -35,9 +35,11 @@
 use App\Jobs\ProcessImageJob;
 use App\Models\Configs;
 use App\Models\Photo;
+use App\Models\Tag;
 use Illuminate\Routing\Controller;
 use Illuminate\Support\Facades\App;
 use Illuminate\Support\Facades\Auth;
+use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Facades\Storage;
 
 /**
@@ -122,7 +124,10 @@ public function update(EditPhotoRequest $request): PhotoResource
 		$photo->title = $request->title();
 		$photo->description = $request->description();
 		$photo->created_at = $request->uploadDate();
-		$photo->tags = $request->tags();
+
+		$existing_tags = Tag::from($request->tags());
+		$photo->tags()->sync($existing_tags->pluck('id'));
+		$photo->load('tags');
 		$photo->license = $request->license()->value;
 
 		// if the request takenAt is null, then we set the initial value back.
@@ -205,15 +210,21 @@ public function rename(RenamePhotoRequest $request): void
 	public function tags(SetPhotosTagsRequest $request): void
 	{
 		$tags = $request->tags();
+		$photos = $request->photos();
 
-		/** @var Photo $photo */
-		foreach ($request->photos() as $photo) {
-			if ($request->shall_override) {
-				$photo->tags = $tags;
-			} else {
-				$photo->tags = array_unique(array_merge($photo->tags, $tags));
-			}
-			$photo->save();
+		// Fetch existing tags
+		$existing_tags = Tag::from($tags);
+
+		if ($request->shall_override) {
+			// Delete existing associations for those photos ids if we override the tags
+			DB::table('photos_tags')
+				->whereIn('photo_id', $photos->pluck('id'))
+				->delete();
 		}
+
+		// Associate the existing tags with the photos
+		$existing_tags->each(function (Tag $tag) use ($photos): void {
+			$tag->photos()->syncWithoutDetaching($photos->pluck('id'));
+		});
 	}
 }