Adding copyright to albums #1838 (#1880)

--------- Co-authored-by: ildyria <[email protected]>
LycheeOrg · Apr 28, 2024 · 01ca75b · 01ca75b
1 parent ffcb72d
commit 01ca75b
Show file tree

Hide file tree

Showing 38 changed files with 277 additions and 0 deletions.
diff --git a/app/Contracts/Http/Requests/HasCopyright.php b/app/Contracts/Http/Requests/HasCopyright.php
@@ -0,0 +1,11 @@
+<?php
+
+namespace App\Contracts\Http\Requests;
+
+interface HasCopyright
+{
+	/**
+	 * @return string|null
+	 */
+	public function copyright(): ?string;
+}
diff --git a/app/Contracts/Http/Requests/RequestAttribute.php b/app/Contracts/Http/Requests/RequestAttribute.php
@@ -84,5 +84,7 @@ class RequestAttribute
 	public const RESYNC_METADATA_ATTRIBUTE = 'resync_metadata';
 
 	public const FILE_LAST_MODIFIED_TIME = 'fileLastModifiedTime';
+
+	public const COPYRIGHT_ATTRIBUTE = 'copyright';
 	public const URLS_ATTRIBUTE = 'urls';
 }
diff --git a/app/Http/Controllers/AlbumController.php b/app/Http/Controllers/AlbumController.php
@@ -25,6 +25,7 @@
 use App\Http\Requests\Album\GetAlbumRequest;
 use App\Http\Requests\Album\MergeAlbumsRequest;
 use App\Http\Requests\Album\MoveAlbumsRequest;
+use App\Http\Requests\Album\SetAlbumCopyrightRequest;
 use App\Http\Requests\Album\SetAlbumCoverRequest;
 use App\Http\Requests\Album\SetAlbumDescriptionRequest;
 use App\Http\Requests\Album\SetAlbumHeaderRequest;
@@ -187,6 +188,21 @@ public function setDescription(SetAlbumDescriptionRequest $request): void
 		$request->album()->save();
 	}
 
+	/**
+	 * Change the copyright of the album.
+	 *
+	 * @param SetAlbumCopyrightRequest $request
+	 *
+	 * @return void
+	 *
+	 * @throws ModelDBException
+	 */
+	public function setCopyright(SetAlbumCopyrightRequest $request): void
+	{
+		$request->album()->copyright = $request->copyright();
+		$request->album()->save();
+	}
+
 	/**
 	 * Change show tags of the tag album.
 	 *

diff --git a/app/Http/Requests/Album/SetAlbumCopyrightRequest.php b/app/Http/Requests/Album/SetAlbumCopyrightRequest.php
@@ -0,0 +1,38 @@
+<?php
+
+namespace App\Http\Requests\Album;
+
+use App\Contracts\Http\Requests\HasBaseAlbum;
+use App\Contracts\Http\Requests\HasCopyright;
+use App\Contracts\Http\Requests\RequestAttribute;
+use App\Http\Requests\BaseApiRequest;
+use App\Http\Requests\Traits\Authorize\AuthorizeCanEditAlbumTrait;
+use App\Http\Requests\Traits\HasBaseAlbumTrait;
+use App\Http\Requests\Traits\HasCopyrightTrait;
+use App\Http\RuleSets\Album\SetAlbumCopyrightRuleSet;
+
+class SetAlbumCopyrightRequest extends BaseApiRequest implements HasBaseAlbum, HasCopyright
+{
+	use HasBaseAlbumTrait;
+	use HasCopyrightTrait;
+	use AuthorizeCanEditAlbumTrait;
+
+	/**
+	 * {@inheritDoc}
+	 */
+	public function rules(): array
+	{
+		return SetAlbumCopyrightRuleSet::rules();
+	}
+
+	/**
+	 * {@inheritDoc}
+	 */
+	protected function processValidatedValues(array $values, array $files): void
+	{
+		$this->album = $this->albumFactory->findBaseAlbumOrFail(
+			$values[RequestAttribute::ALBUM_ID_ATTRIBUTE], false
+		);
+		$this->copyright = $values[RequestAttribute::COPYRIGHT_ATTRIBUTE];
+	}
+}
diff --git a/app/Http/Requests/Traits/HasCopyrightTrait.php b/app/Http/Requests/Traits/HasCopyrightTrait.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace App\Http\Requests\Traits;
+
+trait HasCopyrightTrait
+{
+	protected ?string $copyright = null;
+
+	/**
+	 * @return string|null
+	 */
+	public function copyright(): ?string
+	{
+		return $this->copyright;
+	}
+}
diff --git a/app/Http/Resources/Models/AlbumResource.php b/app/Http/Resources/Models/AlbumResource.php
@@ -37,6 +37,7 @@ public function toArray($request)
 			'id' => $this->resource->id,
 			'title' => $this->resource->title,
 			'owner_name' => $this->when(Auth::check(), $this->resource->owner->name),
+			'copyright' => $this->resource->copyright,
 
 			// attributes
 			'description' => $this->resource->description,

diff --git a/app/Http/RuleSets/Album/SetAlbumCopyrightRuleSet.php b/app/Http/RuleSets/Album/SetAlbumCopyrightRuleSet.php
@@ -0,0 +1,25 @@
+<?php
+
+namespace App\Http\RuleSets\Album;
+
+use App\Contracts\Http\Requests\RequestAttribute;
+use App\Contracts\Http\RuleSet;
+use App\Rules\CopyrightRule;
+use App\Rules\RandomIDRule;
+
+/**
+ * Rules applied when updating the copyright of an album.
+ */
+class SetAlbumCopyrightRuleSet implements RuleSet
+{
+	/**
+	 * {@inheritDoc}
+	 */
+	public static function rules(): array
+	{
+		return [
+			RequestAttribute::ALBUM_ID_ATTRIBUTE => ['required', new RandomIDRule(false)],
+			RequestAttribute::COPYRIGHT_ATTRIBUTE => ['required', new CopyrightRule()],
+		];
+	}
+}
diff --git a/app/Livewire/Components/Forms/Album/Properties.php b/app/Livewire/Components/Forms/Album/Properties.php
@@ -20,6 +20,7 @@
 use App\Models\Album as ModelsAlbum;
 use App\Models\Extensions\BaseAlbum;
 use App\Policies\AlbumPolicy;
+use App\Rules\CopyrightRule;
 use App\Rules\TitleRule;
 use Illuminate\Contracts\View\View;
 use Illuminate\Foundation\Auth\Access\AuthorizesRequests;
@@ -44,6 +45,7 @@ class Properties extends Component
 	public string $album_sorting_order = ''; // ! wired
 	public string $album_aspect_ratio = ''; // ! wired
 	public string $license = 'none'; // ! wired
+	public string $copyright = ''; // ! wired
 
 	/**
 	 * This is the equivalent of the constructor for Livewire Components.
@@ -63,6 +65,7 @@ public function mount(BaseAlbum $album): void
 		$this->description = $album->description ?? '';
 		$this->photo_sorting_column = $album->photo_sorting?->column->value ?? '';
 		$this->photo_sorting_order = $album->photo_sorting?->order->value ?? '';
+		$this->copyright = $album->copyright ?? '';
 		if ($this->is_model_album) {
 			/** @var ModelsAlbum $album */
 			$this->license = $album->license->value;
@@ -94,6 +97,7 @@ public function submit(AlbumFactory $albumFactory): void
 			...SetPhotoSortingRuleSet::rules(),
 			...SetAlbumSortingRuleSet::rules(),
 			RequestAttribute::ALBUM_ASPECT_RATIO_ATTRIBUTE => ['present', 'nullable', new Enum(AspectRatioType::class)],
+			RequestAttribute::COPYRIGHT_ATTRIBUTE => ['present', 'nullable', new CopyrightRule()],
 		];
 
 		if (!$this->areValid($rules)) {
@@ -106,12 +110,17 @@ public function submit(AlbumFactory $albumFactory): void
 		$baseAlbum->title = $this->title;
 		$baseAlbum->description = $this->description;
 
+		$this->copyright = trim($this->copyright);
+
 		// Not super pretty but whatever.
 		$column = ColumnSortingPhotoType::tryFrom($this->photo_sorting_column);
 		$order = OrderSortingType::tryFrom($this->photo_sorting_order);
 		$photoSortingCriterion = $column === null ? null : new PhotoSortingCriterion($column->toColumnSortingType(), $order);
 		$baseAlbum->photo_sorting = $photoSortingCriterion;
 
+		// If left empty, we set to null
+		$baseAlbum->copyright = $this->copyright === '' ? null : $this->copyright;
+
 		if ($this->is_model_album) {
 			/** @var ModelsAlbum $baseAlbum */
 			$baseAlbum->license = LicenseType::from($this->license);

diff --git a/app/Livewire/DTO/AlbumFormatted.php b/app/Livewire/DTO/AlbumFormatted.php
@@ -21,6 +21,7 @@ class AlbumFormatted
 	public bool $can_download;
 	public ?string $created_at = null;
 	public ?string $description = null;
+	public ?string $copyright = null;
 
 	public function __construct(AbstractAlbum $album, ?string $url)
 	{
@@ -33,6 +34,7 @@ public function __construct(AbstractAlbum $album, ?string $url)
 			$this->max_taken_at = $album->max_taken_at?->format($min_max_date_format);
 			$this->created_at = $album->created_at->format($create_date_format);
 			$this->description = trim($album->description ?? '');
+			$this->copyright = $album->copyright;
 		}
 		if ($album instanceof Album) {
 			$this->num_children = $album->num_children;

diff --git a/app/Models/BaseAlbumImpl.php b/app/Models/BaseAlbumImpl.php
@@ -104,6 +104,7 @@
  * @property string|null                      $sorting_order
  * @property Collection<int,AccessPermission> $access_permissions
  * @property int|null                         $access_permissions_count
+ * @property string|null                      $copyright
  *
  * @method static BaseAlbumImplBuilder|BaseAlbumImpl addSelect($column)
  * @method static BaseAlbumImplBuilder|BaseAlbumImpl join(string $table, string $first, string $operator = null, string $second = null, string $type = 'inner', string $where = false)
@@ -173,6 +174,7 @@ class BaseAlbumImpl extends Model implements HasRandomID
 		'owner_id' => 0,
 		'sorting_col' => null,
 		'sorting_order' => null,
+		'copyright' => null,
 		// Special visibility attributes
 		'is_nsfw' => false,
 	];

diff --git a/app/Models/Extensions/BaseAlbum.php b/app/Models/Extensions/BaseAlbum.php
@@ -29,6 +29,7 @@
  * @property Carbon                           $updated_at
  * @property string|null                      $description
  * @property bool                             $is_nsfw
+ * @property string|null                      $copyright
  * @property int                              $owner_id
  * @property User                             $owner
  * @property Collection<int,AccessPermission> $access_permissions

diff --git a/app/Rules/CopyrightRule.php b/app/Rules/CopyrightRule.php
@@ -0,0 +1,11 @@
+<?php
+
+namespace App\Rules;
+
+class CopyrightRule extends StringRule
+{
+	public function __construct()
+	{
+		parent::__construct(true, 300);
+	}
+}
diff --git a/database/migrations/2024_04_28_172241_add_album_copyright.php b/database/migrations/2024_04_28_172241_add_album_copyright.php
@@ -0,0 +1,30 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class() extends Migration {
+	public const TABLE = 'base_albums';
+	public const COLUMN = 'copyright';
+
+	/**
+	 * Run the migrations.
+	 */
+	public function up(): void
+	{
+		Schema::table(self::TABLE, function (Blueprint $table) {
+			$table->string(self::COLUMN, 300)->nullable()->default(null);
+		});
+	}
+
+	/**
+	 * Reverse the migrations.
+	 */
+	public function down(): void
+	{
+		Schema::table(self::TABLE, function (Blueprint $table) {
+			$table->dropColumn(self::COLUMN);
+		});
+	}
+};
diff --git a/lang/cz/lychee.php b/lang/cz/lychee.php
@@ -157,6 +157,8 @@
 	'ALBUM_ABOUT' => 'O albu',
 	'ALBUM_BASICS' => 'Základní informace',
 	'ALBUM_TITLE' => 'Název',
+	'ALBUM_COPYRIGHT' => 'Copyright',
+	'ALBUM_SET_COPYRIGHT' => 'Set copyright',
 	'ALBUM_NEW_TITLE' => 'Zadat nový název alba:',
 	'ALBUMS_NEW_TITLE' => 'Zadat nový název pro %d vybraná alba:',
 	'ALBUM_SET_TITLE' => 'Uložit název',

diff --git a/lang/de/lychee.php b/lang/de/lychee.php
@@ -157,6 +157,8 @@
 	'ALBUM_ABOUT' => 'Über',
 	'ALBUM_BASICS' => 'Grundlegende Informationen',
 	'ALBUM_TITLE' => 'Titel',
+	'ALBUM_COPYRIGHT' => 'Copyright',
+	'ALBUM_SET_COPYRIGHT' => 'Set copyright',
 	'ALBUM_NEW_TITLE' => 'Geben Sie einen neuen Titel für dieses Album ein:',
 	'ALBUMS_NEW_TITLE' => 'Geben Sie einen Titel für alle %d ausgewählten Alben ein:',
 	'ALBUM_SET_TITLE' => 'Titel speichern',

diff --git a/lang/el/lychee.php b/lang/el/lychee.php
@@ -157,6 +157,8 @@
 	'ALBUM_ABOUT' => 'Περί',
 	'ALBUM_BASICS' => 'Βασικές Πληροφορίες',
 	'ALBUM_TITLE' => 'Τίτλος',
+	'ALBUM_COPYRIGHT' => 'Πνευματική ιδιοκτησία',
+	'ALBUM_SET_COPYRIGHT' => 'Δήλωσε πνευματική ιδιοκτησία',
 	'ALBUM_NEW_TITLE' => 'Εισάγετε έναν νέο τίτλο για αυτό το Λεύκωμα:',
 	'ALBUMS_NEW_TITLE' => 'Εισάγετε νέο τίτλο για όλα %d τα επιλεγμένα λευκώματα:',
 	'ALBUM_SET_TITLE' => 'Ορίστε Τίτλο',

diff --git a/lang/en/lychee.php b/lang/en/lychee.php
@@ -157,6 +157,8 @@
 	'ALBUM_ABOUT' => 'About',
 	'ALBUM_BASICS' => 'Basics',
 	'ALBUM_TITLE' => 'Title',
+	'ALBUM_COPYRIGHT' => 'Copyright',
+	'ALBUM_SET_COPYRIGHT' => 'Set copyright',
 	'ALBUM_NEW_TITLE' => 'Enter a new title for this album:',
 	'ALBUMS_NEW_TITLE' => 'Enter a title for all %d selected albums:',
 	'ALBUM_SET_TITLE' => 'Set Title',

diff --git a/lang/es/lychee.php b/lang/es/lychee.php
@@ -157,6 +157,8 @@
 	'ALBUM_ABOUT' => 'Acerca de',
 	'ALBUM_BASICS' => 'Básico',
 	'ALBUM_TITLE' => 'Título',
+	'ALBUM_COPYRIGHT' => 'Copyright',
+	'ALBUM_SET_COPYRIGHT' => 'Set copyright',
 	'ALBUM_NEW_TITLE' => 'Ingrese un nuevo título para este álbum:',
 	'ALBUMS_NEW_TITLE' => 'Ingrese un título para todos %d álbumes seleccionados:',
 	'ALBUM_SET_TITLE' => 'Establecer Título',

diff --git a/lang/fr/lychee.php b/lang/fr/lychee.php
@@ -157,6 +157,8 @@
 	'ALBUM_ABOUT' => 'À propos',
 	'ALBUM_BASICS' => 'Informations de base',
 	'ALBUM_TITLE' => 'Titre',
+	'ALBUM_COPYRIGHT' => 'Droits d’auteur',
+	'ALBUM_SET_COPYRIGHT' => 'Définir les droits d’auteur',
 	'ALBUM_NEW_TITLE' => 'Entrez un nouveau titre pour cet album :',
 	'ALBUMS_NEW_TITLE' => 'Entrez un titre pour les %d albums sélectionnés :',
 	'ALBUM_SET_TITLE' => 'Enregistrer le titre',

diff --git a/lang/hu/lychee.php b/lang/hu/lychee.php
@@ -155,6 +155,8 @@
 	'ALBUM_ABOUT' => 'Névjegy',
 	'ALBUM_BASICS' => 'Alapok',
 	'ALBUM_TITLE' => 'Cím',
+	'ALBUM_COPYRIGHT' => 'Copyright',
+	'ALBUM_SET_COPYRIGHT' => 'Set copyright',
 	'ALBUM_NEW_TITLE' => 'Adjon meg egy új címet ennek az albumnak:',
 	'ALBUMS_NEW_TITLE' => 'Adjon meg címet az összes %d kiválasztott albumnak:',
 	'ALBUM_SET_TITLE' => 'Cím beállítása',

diff --git a/lang/it/lychee.php b/lang/it/lychee.php
@@ -157,6 +157,8 @@
 	'ALBUM_ABOUT' => 'Informazioni',
 	'ALBUM_BASICS' => 'Base',
 	'ALBUM_TITLE' => 'Titolo',
+	'ALBUM_COPYRIGHT' => 'Copyright',
+	'ALBUM_SET_COPYRIGHT' => 'Set copyright',
 	'ALBUM_NEW_TITLE' => 'Inserire un nuovo titolo per questo album:',
 	'ALBUMS_NEW_TITLE' => 'Inserire un nuovo titolo per %d gli album selezionati:',
 	'ALBUM_SET_TITLE' => 'Imposta Titolo',

diff --git a/lang/nl/lychee.php b/lang/nl/lychee.php
@@ -157,6 +157,8 @@
 	'ALBUM_ABOUT' => 'Over',
 	'ALBUM_BASICS' => 'Basics',
 	'ALBUM_TITLE' => 'Titel',
+	'ALBUM_COPYRIGHT' => 'Copyright',
+	'ALBUM_SET_COPYRIGHT' => 'Set copyright',
 	'ALBUM_NEW_TITLE' => 'Geef dit album een nieuwe titel:',
 	'ALBUMS_NEW_TITLE' => 'Geef alle geselecteerde %d albums een nieuwe titel:',
 	'ALBUM_SET_TITLE' => 'Sla Titel op',

diff --git a/lang/no/lychee.php b/lang/no/lychee.php
@@ -157,6 +157,8 @@
 	'ALBUM_ABOUT' => 'Om',
 	'ALBUM_BASICS' => 'Grunnleggende',
 	'ALBUM_TITLE' => 'Tittel',
+	'ALBUM_COPYRIGHT' => 'Copyright',
+	'ALBUM_SET_COPYRIGHT' => 'Set copyright',
 	'ALBUM_NEW_TITLE' => 'Legg inn en ny tittel for Albumet:',
 	'ALBUMS_NEW_TITLE' => 'Legg inn en ny tittel for %d valgte album:',
 	'ALBUM_SET_TITLE' => 'Lagre Tittel',

diff --git a/lang/pl/lychee.php b/lang/pl/lychee.php
@@ -157,6 +157,8 @@
 	'ALBUM_ABOUT' => 'Informacje o albumie',
 	'ALBUM_BASICS' => 'Informacje podstawowe',
 	'ALBUM_TITLE' => 'Tytuł',
+	'ALBUM_COPYRIGHT' => 'Copyright',
+	'ALBUM_SET_COPYRIGHT' => 'Set copyright',
 	'ALBUM_NEW_TITLE' => 'Edytuj tytuł albumu:',
 	'ALBUMS_NEW_TITLE' => 'Wpisz tytuł dla %d wybranych albumów:',
 	'ALBUM_SET_TITLE' => 'Zapisz',

diff --git a/lang/pt/lychee.php b/lang/pt/lychee.php
@@ -157,6 +157,8 @@
 	'ALBUM_ABOUT' => 'Acerca de',
 	'ALBUM_BASICS' => 'Básicos',
 	'ALBUM_TITLE' => 'Título',
+	'ALBUM_COPYRIGHT' => 'Copyright',
+	'ALBUM_SET_COPYRIGHT' => 'Set copyright',
 	'ALBUM_NEW_TITLE' => 'Inserir novo título para este álbum:',
 	'ALBUMS_NEW_TITLE' => 'Inserir um título para todos %d álbums selecionados:',
 	'ALBUM_SET_TITLE' => 'Escolher Título',

diff --git a/lang/ru/lychee.php b/lang/ru/lychee.php
@@ -157,6 +157,8 @@
 	'ALBUM_ABOUT' => 'Об альбоме',
 	'ALBUM_BASICS' => 'Основное',
 	'ALBUM_TITLE' => 'Заголовок',
+	'ALBUM_COPYRIGHT' => 'Copyright',
+	'ALBUM_SET_COPYRIGHT' => 'Set copyright',
 	'ALBUM_NEW_TITLE' => 'Новый заголовок альбома:',
 	'ALBUMS_NEW_TITLE' => 'Введите заголовок для всех %d выбранных альбомов:',
 	'ALBUM_SET_TITLE' => 'Сохранить заголовок',

diff --git a/lang/sk/lychee.php b/lang/sk/lychee.php
@@ -157,6 +157,8 @@
 	'ALBUM_ABOUT' => 'O albume',
 	'ALBUM_BASICS' => 'Základné informácie',
 	'ALBUM_TITLE' => 'Názov',
+	'ALBUM_COPYRIGHT' => 'Copyright',
+	'ALBUM_SET_COPYRIGHT' => 'Set copyright',
 	'ALBUM_NEW_TITLE' => 'Zadajte nový názov pre tento album:',
 	'ALBUMS_NEW_TITLE' => 'Zadajte názov pre všetky %d vybrané albumy:',
 	'ALBUM_SET_TITLE' => 'Názov uložiť',