More relevant diagnostic data, less privacy invasive. (#2362)

LycheeOrg · Apr 9, 2024 · 7529a66 · 7529a66
1 parent b23304b
commit 7529a66
Show file tree

Hide file tree

Showing 19 changed files with 294 additions and 32 deletions.
diff --git a/app/Actions/Diagnostics/Configuration.php b/app/Actions/Diagnostics/Configuration.php
@@ -4,6 +4,7 @@
 
 use App\Exceptions\Internal\QueryBuilderException;
 use App\Models\Configs;
+use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Support\Facades\Schema;
 
 class Configuration
@@ -25,11 +26,7 @@ public function get(): array
 		}
 
 		// Load settings
-		$settings = Configs::query()
-			->where('confidentiality', '<=', 2)
-			->select(['key', 'value'])
-			->orderBy('id', 'ASC')
-			->get();
+		$settings = Schema::hasColumn('configs', 'is_secret') ? $this->withIsSecret() : $this->withConfidentiality();
 
 		return $settings->map(function (Configs $setting) {
 			if (is_null($setting->value)) {
@@ -39,4 +36,36 @@ public function get(): array
 			}
 		})->all();
 	}
+
+	/**
+	 * This is a fail safe (legacy) in case the migration 2024_04_09_121410 has not been applied.
+	 *
+	 * @return Collection<int,Configs>
+	 *
+	 * @throws QueryBuilderException
+	 */
+	private function withConfidentiality()
+	{
+		return Configs::query()
+			->where('confidentiality', '<=', 2)
+			->select(['key', 'value'])
+			->orderBy('id', 'ASC')
+			->get();
+	}
+
+	/**
+	 * Normal code path.
+	 *
+	 * @return Collection<int,Configs>
+	 *
+	 * @throws QueryBuilderException
+	 */
+	private function withIsSecret()
+	{
+		return Configs::query()
+			->where('is_secret', '=', false)
+			->select(['key', 'value'])
+			->orderBy('id', 'ASC')
+			->get();
+	}
 }
diff --git a/app/Legacy/BaseConfigMigration.php b/app/Legacy/BaseConfigMigration.php
@@ -0,0 +1,34 @@
+<?php
+
+namespace App\Legacy;
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Support\Facades\DB;
+
+/**
+ * Used in migrations prior 2024_04_09_121410.
+ */
+abstract class BaseConfigMigration extends Migration
+{
+	/**
+	 * @return array<int,array{key:string,value:string,confidentiality:string,cat:string,type_range:string,description:string}>
+	 */
+	abstract public function getConfigs(): array;
+
+	/**
+	 * Run the migrations.
+	 */
+	final public function up(): void
+	{
+		DB::table('configs')->insert($this->getConfigs());
+	}
+
+	/**
+	 * Reverse the migrations.
+	 */
+	final public function down(): void
+	{
+		$keys = collect($this->getConfigs())->map(fn ($v) => $v['key'])->all();
+		DB::table('configs')->whereIn('key', $keys)->delete();
+	}
+}
diff --git a/app/Models/Configs.php b/app/Models/Configs.php
@@ -26,7 +26,7 @@
  * @property string|null $value
  * @property string      $cat
  * @property string      $type_range
- * @property int         $confidentiality
+ * @property bool        $is_secret
  * @property string      $description
  *
  * @method static ConfigsBuilder|Configs addSelect($column)
@@ -71,7 +71,7 @@ class Configs extends Model
 	 *
 	 * @var array<int,string>
 	 */
-	protected $fillable = ['key', 'value', 'cat', 'type_range', 'confidentiality', 'description'];
+	protected $fillable = ['key', 'value', 'cat', 'type_range', 'is_secret', 'description'];
 
 	/**
 	 *  this is a parameter for Laravel to indicate that there is no created_at, updated_at columns.

diff --git a/app/Models/Extensions/BaseConfigMigration.php b/app/Models/Extensions/BaseConfigMigration.php
@@ -8,7 +8,7 @@
 abstract class BaseConfigMigration extends Migration
 {
 	/**
-	 * @return array<int,array{key:string,value:string,confidentiality:string,cat:string,type_range:string,description:string}>
+	 * @return array<int,array{key:string,value:string,is_secret:bool,cat:string,type_range:string,description:string}>
 	 */
 	abstract public function getConfigs(): array;
 

diff --git a/database/migrations/2019_09_28_171753_config_fix.php b/database/migrations/2019_09_28_171753_config_fix.php
@@ -2,9 +2,9 @@
 
 /** @noinspection PhpUndefinedClassInspection */
 
-use App\Models\Configs;
 use Illuminate\Database\Migrations\Migration;
 use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Facades\Log;
 use Illuminate\Support\Facades\Schema;
 
@@ -95,18 +95,11 @@ private function missing_columns(): void
 	private function update_missing_fields(array &$default_values): void
 	{
 		foreach ($default_values as $value) {
-			$c = Configs::where('key', $value['key'])->count();
-			$config = Configs::updateOrCreate(
-				['key' => $value['key']],
-				[
-					'cat' => $value['cat'],
-					'type_range' => $value['type_range'],
-					'confidentiality' => $value['confidentiality'],
-				]
-			);
+			$c = DB::table('configs')->where('key', '=', $value['key'])->count();
 			if ($c === 0) {
-				$config->value = $value['value'];
-				$config->save();
+				DB::table('configs')->insert($value);
+			} else { // $c === 1
+				DB::table('configs')->where('key', '=', $value['key'])->update($value);
 			}
 		}
 	}

diff --git a/database/migrations/2020_11_19_231553_bump_version040008.php b/database/migrations/2020_11_19_231553_bump_version040008.php
@@ -1,6 +1,7 @@
 <?php
 
 use Illuminate\Database\Migrations\Migration;
+use Illuminate\Support\Facades\DB;
 
 return new class() extends Migration {
 	/**

diff --git a/...ase/migrations/2023_05_04_193000_add_use_last_modified_date_when_no_exit_date_setting.php b/...ase/migrations/2023_05_04_193000_add_use_last_modified_date_when_no_exit_date_setting.php
@@ -1,6 +1,6 @@
 <?php
 
-use App\Models\Extensions\BaseConfigMigration;
+use App\Legacy\BaseConfigMigration;
 
 return new class() extends BaseConfigMigration {
 	public function getConfigs(): array

diff --git a/database/migrations/2023_09_24_110932_add_date_display_configurations.php b/database/migrations/2023_09_24_110932_add_date_display_configurations.php
@@ -1,6 +1,6 @@
 <?php
 
-use App\Models\Extensions\BaseConfigMigration;
+use App\Legacy\BaseConfigMigration;
 
 return new class() extends BaseConfigMigration {
 	public const GALLERY = 'Gallery';

diff --git a/database/migrations/2023_09_24_223901_add_config_livewire_chunk_size.php b/database/migrations/2023_09_24_223901_add_config_livewire_chunk_size.php
@@ -1,6 +1,6 @@
 <?php
 
-use App\Models\Extensions\BaseConfigMigration;
+use App\Legacy\BaseConfigMigration;
 
 return new class() extends BaseConfigMigration {
 	public const IMAGE_PROCESSING = 'Image Processing';

diff --git a/database/migrations/2023_09_25_123925_config_blur_nsfw.php b/database/migrations/2023_09_25_123925_config_blur_nsfw.php
@@ -1,6 +1,6 @@
 <?php
 
-use App\Models\Extensions\BaseConfigMigration;
+use App\Legacy\BaseConfigMigration;
 
 return new class() extends BaseConfigMigration {
 	public const MOD_NSFW = 'Mod NSFW';

diff --git a/database/migrations/2023_12_18_232500_config_pagination_search_limit.php b/database/migrations/2023_12_18_232500_config_pagination_search_limit.php
@@ -1,6 +1,6 @@
 <?php
 
-use App\Models\Extensions\BaseConfigMigration;
+use App\Legacy\BaseConfigMigration;
 
 return new class() extends BaseConfigMigration {
 	public const MOD_SEARCH = 'Mod Search';

diff --git a/database/migrations/2023_12_19_115547_search_characters_limit.php b/database/migrations/2023_12_19_115547_search_characters_limit.php
@@ -1,6 +1,6 @@
 <?php
 
-use App\Models\Extensions\BaseConfigMigration;
+use App\Legacy\BaseConfigMigration;
 
 return new class() extends BaseConfigMigration {
 	public const MOD_SEARCH = 'Mod Search';

diff --git a/database/migrations/2023_12_20_180854_add_setting_height_width_gallery.php b/database/migrations/2023_12_20_180854_add_setting_height_width_gallery.php
@@ -1,6 +1,6 @@
 <?php
 
-use App\Models\Extensions\BaseConfigMigration;
+use App\Legacy\BaseConfigMigration;
 
 return new class() extends BaseConfigMigration {
 	public const GALLERY = 'Gallery';

diff --git a/database/migrations/2023_12_25_115454_add_setting_display_thumb_overlay.php b/database/migrations/2023_12_25_115454_add_setting_display_thumb_overlay.php
@@ -1,6 +1,6 @@
 <?php
 
-use App\Models\Extensions\BaseConfigMigration;
+use App\Legacy\BaseConfigMigration;
 
 return new class() extends BaseConfigMigration {
 	public const GALLERY = 'Gallery';

diff --git a/database/migrations/2023_12_30_220515_add_thumbs_albums_aspect_ratio.php b/database/migrations/2023_12_30_220515_add_thumbs_albums_aspect_ratio.php
@@ -1,6 +1,6 @@
 <?php
 
-use App\Models\Extensions\BaseConfigMigration;
+use App\Legacy\BaseConfigMigration;
 
 return new class() extends BaseConfigMigration {
 	public const GALLERY = 'Gallery';

diff --git a/database/migrations/2024_01_03_154055_add_album_no_header_setting.php b/database/migrations/2024_01_03_154055_add_album_no_header_setting.php
@@ -1,6 +1,6 @@
 <?php
 
-use App\Models\Extensions\BaseConfigMigration;
+use App\Legacy\BaseConfigMigration;
 
 return new class() extends BaseConfigMigration {
 	public const GALLERY = 'Gallery';

diff --git a/database/migrations/2024_01_08_163328_left_right_login_and_back.php b/database/migrations/2024_01_08_163328_left_right_login_and_back.php
@@ -1,6 +1,6 @@
 <?php
 
-use App\Models\Extensions\BaseConfigMigration;
+use App\Legacy\BaseConfigMigration;
 
 return new class() extends BaseConfigMigration {
 	public const CONFIG = 'config';

diff --git a/database/migrations/2024_01_24_063519_job_feedback_options.php b/database/migrations/2024_01_24_063519_job_feedback_options.php
@@ -1,6 +1,6 @@
 <?php
 
-use App\Models\Extensions\BaseConfigMigration;
+use App\Legacy\BaseConfigMigration;
 
 return new class() extends BaseConfigMigration {
 	public const PROCESSING = 'Image Processing';