Adding copyright to albums #1838

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

@@ -78,4 +78,6 @@ class RequestAttribute
 	public const RESYNC_METADATA_ATTRIBUTE = 'resync_metadata';
 
 	public const FILE_LAST_MODIFIED_TIME = 'fileLastModifiedTime';
+
+	public const COPYRIGHT_ATTRIBUTE = 'copyright';
 }

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\SetAlbumLicenseRequest;
@@ -186,6 +187,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->findBaseAlbumsOrFail(
+			$values[RequestAttribute::ALBUM_IDS_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

@@ -36,6 +36,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/Rules/CopyrightRule.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace App\Rules;
+
+class CopyrightRule extends StringRule
+{
+	public function __construct()
+	{
+		parent::__construct(false, 300);
+	}
+}

database/migrations/2021_12_04_181200_refactor_models.php

@@ -515,6 +515,7 @@ private function createBaseAlbumTable(): void
 			$table->string('password', 100)->nullable()->default(null);
 			$table->string('sorting_col', 30)->nullable()->default(null);
 			$table->string('sorting_order', 4)->nullable()->default(null);
+			$table->string('copyright', 300)->nullable()->default(null);
 			// Indices and constraint definitions
 			$table->primary('id');
 			$table->unique('legacy_id');

routes/api.php

@@ -38,6 +38,7 @@
 Route::post('/Album::setTitle', [AlbumController::class, 'setTitle']);
 Route::post('/Album::setNSFW', [AlbumController::class, 'setNSFW']);
 Route::post('/Album::setDescription', [AlbumController::class, 'setDescription']);
+Route::post('/Album::setCopyright', [AlbumController::class, 'setCopyright']);
 Route::post('/Album::setCover', [AlbumController::class, 'setCover']);
 Route::post('/Album::setShowTags', [AlbumController::class, 'setShowTags']);
 Route::post('/Album::setProtectionPolicy', [AlbumController::class, 'setProtectionPolicy']);