Adding copyright to albums #1838 (#1880)

---------

Co-authored-by: ildyria <beviguier@gmail.com>

Author: ThanasisMpalatsoukas

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;
+}

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';
 }

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.
 	 *

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];
+	}
+}

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;
+	}
+}

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,

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()],
+		];
+	}
+}

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);

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;

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,
 	];