add database and models for Colour extraction

Author: ildyria

app/Models/Colour.php

@@ -0,0 +1,41 @@
+<?php
+
+/**
+ * SPDX-License-Identifier: MIT
+ * Copyright (c) 2017-2018 Tobias Reich
+ * Copyright (c) 2018-2025 LycheeOrg.
+ */
+
+namespace App\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+/**
+ * App\Models\Colour.
+ *
+ * @property int $id
+ * @property int $R
+ * @property int $G
+ * @property int $B
+ */
+class Colour extends Model
+{
+	public $timestamps = false;
+
+	protected $fillable = [
+		'id',
+		'R',
+		'G',
+		'B',
+	];
+
+	/**
+	 * Convert the colour to a hexadecimal string.
+	 *
+	 * @return string
+	 */
+	public function toHex(): string
+	{
+		return sprintf('#%02x%02x%02x', $this->R, $this->G, $this->B);
+	}
+}

app/Models/Palette.php

@@ -0,0 +1,59 @@
+<?php
+
+/**
+ * SPDX-License-Identifier: MIT
+ * Copyright (c) 2017-2018 Tobias Reich
+ * Copyright (c) 2018-2025 LycheeOrg.
+ */
+
+namespace App\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+/**
+ * App\Models\Palette.
+ *
+ * @property int    $id
+ * @property string $photo_id
+ * @property int    $colour_1
+ * @property int    $colour_2
+ * @property int    $colour_3
+ * @property int    $colour_4
+ * @property int    $colour_5
+ */
+class Palette extends Model
+{
+	public $timestamps = false;
+
+	protected $fillable = [
+		'photo_id',
+		'colour_1',
+		'colour_2',
+		'colour_3',
+		'colour_4',
+		'colour_5',
+	];
+
+	/**
+	 * @return array{colour_1:string,colour_2:string,colour_3:string,colour_4:string,colour_5:string}
+	 */
+	public function toHexColours(): array
+	{
+		return [
+			'colour_1' => self::toHex($this->colour_1),
+			'colour_2' => self::toHex($this->colour_2),
+			'colour_3' => self::toHex($this->colour_3),
+			'colour_4' => self::toHex($this->colour_4),
+			'colour_5' => self::toHex($this->colour_5),
+		];
+	}
+
+	public static function toHex(int $colour)
+	{
+		$b = $colour & 0xFF; // Extract the blue component
+		$g = ($colour >> 8) & 0xFF; // Extract the green component
+		$r = ($colour >> 16) & 0xFF; // Extract the red component
+
+		return sprintf('#%02x%02x%02x', $r, $g, $b);
+	}
+}

app/Models/Photo.php

@@ -78,6 +78,7 @@
  * @property User         $owner
  * @property SizeVariants $size_variants
  * @property int          $filesize
+ * @property Palette|null $palette
  *
  * @method static PhotoBuilder|Photo addSelect($column)
  * @method static PhotoBuilder|Photo join(string $table, string $first, string $operator = null, string $second = null, string $type = 'inner', string $where = false)
@@ -175,10 +176,6 @@ class Photo extends Model implements HasUTCBasedTimes
 		'live_photo_short_path', // serialize live_photo_url instead
 	];
 
-	// protected $with = [
-	// 	'statistics',
-	// ];
-
 	public function newEloquentBuilder($query): PhotoBuilder
 	{
 		return new PhotoBuilder($query);
@@ -219,6 +216,20 @@ public function statistics(): HasOne
 		return $this->hasOne(Statistics::class, 'photo_id', 'id');
 	}
 
+	/**
+	 * Returns the relationship between a photo and its associated color palette.
+	 *
+	 * This is a one-to-one relationship where each photo can have one palette
+	 * associated with it, which contains color information derived from the
+	 * photo.
+	 *
+	 * @return HasOne<Palette,$this>
+	 */
+	public function palette(): HasOne
+	{
+		return $this->hasOne(Palette::class, 'photo_id', 'id');
+	}
+
 	/**
 	 * Accessor for attribute {@link Photo::$shutter}.
 	 *

database/migrations/2025_06_03_201052_create_colours_table.php

@@ -0,0 +1,35 @@
+<?php
+
+/**
+ * SPDX-License-Identifier: MIT
+ * Copyright (c) 2017-2018 Tobias Reich
+ * Copyright (c) 2018-2025 LycheeOrg.
+ */
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class() extends Migration {
+	/**
+	 * Run the migrations.
+	 */
+	public function up(): void
+	{
+		Schema::create('colours', function (Blueprint $table) {
+			$table->unsignedMediumInteger('id')->primary();
+			$table->unsignedTinyInteger('R')->default(0);
+			$table->unsignedTinyInteger('G')->default(0);
+			$table->unsignedTinyInteger('B')->default(0);
+			$table->unique(['R', 'G', 'B']); // Ensure that the combination of R, G, and B is unique
+		});
+	}
+
+	/**
+	 * Reverse the migrations.
+	 */
+	public function down(): void
+	{
+		Schema::dropIfExists('colours');
+	}
+};

database/migrations/2025_06_03_201058_create_palettes_table.php

@@ -0,0 +1,43 @@
+<?php
+
+/**
+ * SPDX-License-Identifier: MIT
+ * Copyright (c) 2017-2018 Tobias Reich
+ * Copyright (c) 2018-2025 LycheeOrg.
+ */
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class() extends Migration {
+	public const PHOTO_ID = 'photo_id';
+	public const RANDOM_ID_LENGTH = 24; // Length of the random ID
+
+	/**
+	 * Run the migrations.
+	 */
+	public function up(): void
+	{
+		Schema::create('palettes', function (Blueprint $table) {
+			$table->id();
+			$table->char(self::PHOTO_ID, self::RANDOM_ID_LENGTH)->nullable(false);
+			$table->unsignedMediumInteger('colour_1')->nullable(false);
+			$table->unsignedMediumInteger('colour_2')->nullable(false);
+			$table->unsignedMediumInteger('colour_3')->nullable(false);
+			$table->unsignedMediumInteger('colour_4')->nullable(false);
+			$table->unsignedMediumInteger('colour_5')->nullable(false);
+
+			$table->index('id');
+			$table->index([self::PHOTO_ID]);
+		});
+	}
+
+	/**
+	 * Reverse the migrations.
+	 */
+	public function down(): void
+	{
+		Schema::dropIfExists('palettes');
+	}
+};