Allow to disable smart albums individually. (#2468)

--------- Co-authored-by: Martin Stone <[email protected]>
LycheeOrg · Jun 18, 2024 · 907a404 · 907a404
1 parent d0f793c
commit 907a404
Show file tree

Hide file tree

Showing 7 changed files with 186 additions and 21 deletions.
diff --git a/app/Actions/Albums/Top.php b/app/Actions/Albums/Top.php
@@ -11,7 +11,6 @@
 use App\Factories\AlbumFactory;
 use App\Http\Resources\Collections\TopAlbumsResource;
 use App\Models\Album;
-use App\Models\Configs;
 use App\Models\Extensions\SortingDecorator;
 use App\Models\TagAlbum;
 use App\Policies\AlbumPolicy;
@@ -59,18 +58,12 @@ public function __construct(AlbumFactory $albumFactory, AlbumQueryPolicy $albumQ
 	 */
 	public function get(): TopAlbumsResource
 	{
-		if (Configs::getValueAsBool('SA_enabled')) {
-			// Do not eagerly load the relation `photos` for each smart album.
-			// On the albums overview, we only need a thumbnail for each album.
-			/** @var BaseCollection<int,BaseSmartAlbum> $smartAlbums */
-			$smartAlbums = $this->albumFactory
-				->getAllBuiltInSmartAlbums(false)
-				->map(
-					fn ($smartAlbum) => Gate::check(AlbumPolicy::CAN_SEE, $smartAlbum) ? $smartAlbum : null
-				)->reject(fn ($smartAlbum) => $smartAlbum === null);
-		} else {
-			$smartAlbums = new BaseCollection();
-		}
+		// Do not eagerly load the relation `photos` for each smart album.
+		// On the albums overview, we only need a thumbnail for each album.
+		/** @var BaseCollection<int,BaseSmartAlbum> $smartAlbums */
+		$smartAlbums = $this->albumFactory
+			->getAllBuiltInSmartAlbums(false)
+			->filter(fn ($smartAlbum) => Gate::check(AlbumPolicy::CAN_SEE, $smartAlbum));
 
 		$tagAlbumQuery = $this->albumQueryPolicy
 			->applyVisibilityFilter(TagAlbum::query()->with(['access_permissions', 'owner']));

diff --git a/app/Enum/SmartAlbumType.php b/app/Enum/SmartAlbumType.php
@@ -3,6 +3,7 @@
 namespace App\Enum;
 
 use App\Enum\Traits\DecorateBackedEnum;
+use App\Models\Configs;
 
 /**
  * Enum SmartAlbumType.
@@ -15,4 +16,19 @@ enum SmartAlbumType: string
 	case STARRED = 'starred';
 	case RECENT = 'recent';
 	case ON_THIS_DAY = 'on_this_day';
+
+	/**
+	 * Return whether the smart album is enabled.
+	 *
+	 * @return bool
+	 */
+	public function is_enabled(): bool
+	{
+		return match ($this) {
+			self::UNSORTED => Configs::getValueAsBool('enable_unsorted'),
+			self::STARRED => Configs::getValueAsBool('enable_starred'),
+			self::RECENT => Configs::getValueAsBool('enable_recent'),
+			self::ON_THIS_DAY => Configs::getValueAsBool('enable_on_this_day'),
+		};
+	}
 }
diff --git a/app/Factories/AlbumFactory.php b/app/Factories/AlbumFactory.php
@@ -183,10 +183,9 @@ public function findBaseAlbumsOrFail(array $albumIDs, bool $withRelations = true
 	public function getAllBuiltInSmartAlbums(bool $withRelations = true): Collection
 	{
 		$smartAlbums = new Collection();
-		/** @var SmartAlbumType $smartAlbumId */
-		foreach (SmartAlbumType::cases() as $smartAlbumId) {
-			$smartAlbums->put($smartAlbumId->value, $this->createSmartAlbum($smartAlbumId, $withRelations));
-		}
+		collect(SmartAlbumType::cases())
+			->filter(fn (SmartAlbumType $s) => $s->is_enabled())
+			->each(fn (SmartAlbumType $s) => $smartAlbums->put($s->value, $this->createSmartAlbum($s, $withRelations)));
 
 		return $smartAlbums;
 	}

diff --git a/app/Http/Resources/ConfigurationResource.php b/app/Http/Resources/ConfigurationResource.php
@@ -11,6 +11,7 @@
 use App\Enum\LicenseType;
 use App\Enum\MapProviders;
 use App\Enum\PhotoLayoutType;
+use App\Enum\SmartAlbumType;
 use App\Enum\ThumbAlbumSubtitleType;
 use App\Exceptions\Handler;
 use App\Metadata\Versions\InstalledVersion;
@@ -80,7 +81,10 @@ public function toArray($request): array
 				'location' => base_path('public/'),
 
 				// from config
-				'SA_enabled' => Configs::getValueAsBool('SA_enabled'),
+				'SA_enabled' => SmartAlbumType::UNSORTED->is_enabled() &&
+					SmartAlbumType::STARRED->is_enabled() &&
+					SmartAlbumType::RECENT->is_enabled() &&
+					SmartAlbumType::ON_THIS_DAY->is_enabled(),
 				'SL_enable' => Configs::getValueAsBool('SL_enable'),
 				'SL_for_admin' => Configs::getValueAsBool('SL_for_admin'),
 				'SL_life_time_days' => Configs::getValueAsInt('SL_life_time_days'),

diff --git a/database/migrations/2024_06_17_171051_disable_per_smart_album_config.php b/database/migrations/2024_06_17_171051_disable_per_smart_album_config.php
@@ -0,0 +1,46 @@
+<?php
+
+use App\Models\Extensions\BaseConfigMigration;
+
+return new class() extends BaseConfigMigration {
+	public const SMART_ALBUMS = 'Smart Albums';
+	public const BOOL = '0|1';
+
+	public function getConfigs(): array
+	{
+		return [
+			[
+				'key' => 'enable_unsorted',
+				'value' => '1',
+				'is_secret' => false,
+				'cat' => self::SMART_ALBUMS,
+				'type_range' => self::BOOL,
+				'description' => 'Enable Unsorted smart album. Warning! Disabling this will make pictures without an album invisible.',
+			],
+			[
+				'key' => 'enable_starred',
+				'value' => '1',
+				'is_secret' => false,
+				'cat' => self::SMART_ALBUMS,
+				'type_range' => self::BOOL,
+				'description' => 'Enable Starred smart album.',
+			],
+			[
+				'key' => 'enable_recent',
+				'value' => '1',
+				'is_secret' => false,
+				'cat' => self::SMART_ALBUMS,
+				'type_range' => self::BOOL,
+				'description' => 'Enable Recent uploads smart album.',
+			],
+			[
+				'key' => 'enable_on_this_day',
+				'value' => '1',
+				'is_secret' => false,
+				'cat' => self::SMART_ALBUMS,
+				'type_range' => self::BOOL,
+				'description' => 'Enable On this day smart album.',
+			],
+		];
+	}
+};
diff --git a/database/migrations/2024_06_17_172448_remove_global_disable_smart_albums.php b/database/migrations/2024_06_17_172448_remove_global_disable_smart_albums.php
@@ -0,0 +1,46 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Support\Facades\DB;
+
+return new class() extends Migration {
+	public const SMART_ALBUMS = 'Smart Albums';
+	public const BOOL = '0|1';
+	public const TABLE = 'configs';
+	public const SA = 'SA_enabled';
+	public const UNSORTED = 'enable_unsorted';
+	public const STARRED = 'enable_starred';
+	public const RECENT = 'enable_recent';
+	public const ON_THIS_DAY = 'enable_on_this_day';
+
+	/**
+	 * Run the migrations.
+	 */
+	public function up(): void
+	{
+		$val = DB::table(self::TABLE)->select('value')->where('key', '=', self::SA)->first()->value;
+		DB::table(self::TABLE)->whereIn('key', [
+			self::UNSORTED,
+			self::STARRED,
+			self::RECENT,
+			self::ON_THIS_DAY, ])->update(['value' => $val]);
+		DB::table(self::TABLE)->where('key', '=', self::SA)->delete();
+	}
+
+	/**
+	 * Reverse the migrations.
+	 */
+	public function down(): void
+	{
+		DB::table(self::TABLE)->insert([
+			[
+				'key' => 'SA_enabled',
+				'value' => '1',
+				'is_secret' => false,
+				'cat' => self::SMART_ALBUMS,
+				'type_range' => self::BOOL,
+				'description' => 'Enable Smart Albums.',
+			],
+		]);
+	}
+};
diff --git a/tests/Feature/AlbumTest.php b/tests/Feature/AlbumTest.php
@@ -41,6 +41,11 @@ class AlbumTest extends AbstractTestCase
 	use RequiresEmptyUsers;
 	use RequiresEmptyPhotos;
 
+	public const ENABLE_UNSORTED = 'enable_unsorted';
+	public const ENABLE_STARRED = 'enable_starred';
+	public const ENABLE_RECENT = 'enable_recent';
+	public const ENABLE_ON_THIS_DAY = 'enable_on_this_day';
+
 	protected AlbumsUnitTest $albums_tests;
 	protected RootAlbumUnitTest $root_album_tests;
 	protected UsersUnitTest $users_tests;
@@ -880,7 +885,10 @@ public function testHiddenSmartAlbums(): void
 		Auth::loginUsingId(1);
 
 		$this->clearCachedSmartAlbums();
-		Configs::set('SA_enabled', true);
+		Configs::set(self::ENABLE_UNSORTED, true);
+		Configs::set(self::ENABLE_STARRED, true);
+		Configs::set(self::ENABLE_RECENT, true);
+		Configs::set(self::ENABLE_ON_THIS_DAY, true);
 		$response = $this->postJson('/api/Albums::get');
 		$this->assertOk($response);
 		$response->assertJson([
@@ -896,7 +904,10 @@ public function testHiddenSmartAlbums(): void
 		]);
 
 		$this->clearCachedSmartAlbums();
-		Configs::set('SA_enabled', false);
+		Configs::set(self::ENABLE_UNSORTED, false);
+		Configs::set(self::ENABLE_STARRED, false);
+		Configs::set(self::ENABLE_RECENT, false);
+		Configs::set(self::ENABLE_ON_THIS_DAY, false);
 		$response = $this->postJson('/api/Albums::get');
 		$this->assertOk($response);
 		$response->assertJson([
@@ -908,8 +919,58 @@ public function testHiddenSmartAlbums(): void
 		$response->assertDontSee('unsorted');
 		$response->assertDontSee('starred');
 		$response->assertDontSee('recent');
+		$response->assertDontSee('on_this_day');
+
+		$this->clearCachedSmartAlbums();
+		Configs::set(self::ENABLE_UNSORTED, true);
+		$response = $this->postJson('/api/Albums::get');
+		$this->assertOk($response);
+		$response->assertJson([
+			'smart_albums' => [
+				'unsorted' => [],
+			],
+			'tag_albums' => [],
+			'albums' => [],
+			'shared_albums' => [],
+		]);
+		$response->assertDontSee('starred');
+		$response->assertDontSee('recent');
+		$response->assertDontSee('on_this_day');
+
+		$this->clearCachedSmartAlbums();
+		Configs::set(self::ENABLE_STARRED, true);
+		$response = $this->postJson('/api/Albums::get');
+		$this->assertOk($response);
+		$response->assertJson([
+			'smart_albums' => [
+				'unsorted' => [],
+				'starred' => [],
+			],
+			'tag_albums' => [],
+			'albums' => [],
+			'shared_albums' => [],
+		]);
+		$response->assertDontSee('recent');
+		$response->assertDontSee('on_this_day');
+
+		$this->clearCachedSmartAlbums();
+		Configs::set(self::ENABLE_RECENT, true);
+		$response = $this->postJson('/api/Albums::get');
+		$this->assertOk($response);
+		$response->assertJson([
+			'smart_albums' => [
+				'unsorted' => [],
+				'starred' => [],
+				'recent' => [],
+			],
+			'tag_albums' => [],
+			'albums' => [],
+			'shared_albums' => [],
+		]);
+		$response->assertDontSee('on_this_day');
+		$this->clearCachedSmartAlbums();
+		Configs::set(self::ENABLE_ON_THIS_DAY, true);
 
-		Configs::set('SA_enabled', true);
 		Auth::logout();
 		Session::flush();
 	}