Moon Reporter Feature: Moon Notes (#710)

* feature: moon notes when adding moon

* feat: allow editing moon reports

* styleci

* add german translations

I actually speak german :). I just usually don't translate seat stuff because I play EVE in English, so I don't know the game terms in German

Author: recursivetree

src/Http/Controllers/Tools/MoonsController.php

@@ -125,6 +125,7 @@ public function store(ProbeReport $request)
                         $universe_moon = UniverseMoonReport::firstOrNew(['moon_id' => $component->moonID]);
                         $universe_moon->user_id = auth()->user()->getAuthIdentifier();
                         $universe_moon->updated_at = now();
+                        $universe_moon->notes = $request->notes;
                         $universe_moon->save();
 
                         // search for any existing and outdated report regarding current moon
@@ -158,4 +159,19 @@ public function destroy(UniverseMoonReport $report)
 
         return redirect()->back();
     }
+
+    /**
+     * @param  int  $moon
+     * @return \Illuminate\Http\JsonResponse
+     */
+    public function edit(int $moon)
+    {
+        $moon = UniverseMoonReport::with('content')->where('moon_id', $moon)->first();
+        if($moon == null) return response()->json([], 400);
+
+        return response()->json([
+            'report' => $moon->formatReport(),
+            'notes' => $moon->notes,
+        ]);
+    }
 }

src/Http/Routes/Tools/Moons.php

@@ -34,6 +34,10 @@
         ->name('seatcore::tools.moons.show')
         ->uses('MoonsController@show');
 
+    Route::get('/{id}/edit')
+        ->name('seatcore::tools.moons.edit')
+        ->uses('MoonsController@edit');
+
     Route::post('/')
         ->name('seatcore::tools.moons.store')
         ->uses('MoonsController@store')

src/Http/Validation/ProbeReport.php

@@ -46,6 +46,7 @@ public function rules()
     {
         return [
             'moon-report' => 'required',
+            'notes' => 'present|string',
         ];
     }
 }

src/Models/UniverseMoonReport.php

@@ -147,6 +147,29 @@ public function scopeExceptional($query)
         });
     }
 
+    /**
+     * Converts the moon back into a report string.
+     *
+     * @return string
+     */
+    public function formatReport(): string
+    {
+        // header + moon name
+        $report = sprintf("Moon	Moon Product\tQuantity\tOre TypeID\tSolarSystemID\tPlanetID\tMoonID\n%s\n", $this->moon->name);
+
+        foreach ($this->content as $content){
+            $report .= sprintf("\t%s\t%F\t%d\t%d\t%d\t%d\n",
+                $content->typeName,
+                $content->pivot->rate,
+                $content->typeID,
+                $this->moon->system_id,
+                $this->moon->planet_id,
+                $this->moon_id);
+        }
+
+        return $report;
+    }
+
     /**
      * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
      */

src/database/migrations/2025_07_21_000000_add_moon_report_notes.php

@@ -0,0 +1,51 @@
+<?php
+
+/*
+ * This file is part of SeAT
+ *
+ * Copyright (C) 2015 to present Leon Jacobs
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration {
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        Schema::table('universe_moon_reports', function (Blueprint $table) {
+            $table->string('notes')->default('');
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::table('universe_moon_reports', function (Blueprint $table) {
+            $table->dropColumn('notes');
+        });
+    }
+};

src/resources/lang/de/moons.php

@@ -33,4 +33,8 @@
     'uncommon' => 'Ungewöhnlich',
     'rare' => 'Selten',
     'exceptional' => 'Außergewöhnlich',
+
+    'notes' => 'Notizen',
+    'notes_instruction' => 'Du kannst hier Notizen zu den Mond(en) eingeben. Falls du Daten für mehrere Monde gleichzeitig eingibst, wird die Notiz zu allen neuen Monden hinzugefügt.',
+    'notes_placeholder' => 'Gib hier Notizen ein',
 ];

src/resources/lang/en/moons.php

@@ -55,4 +55,7 @@
     'filter_by_constellation' => 'Filter by constellation',
     'filter_by_system' => 'Filter by system',
     'import' => 'Import',
+    'notes' => 'Notes',
+    'notes_instruction' => 'You can enter some notes about the moon(s) here. When adding multiple moons, the note will be added to all of them.',
+    'notes_placeholder' => 'Enter your notes here',
 ];

src/resources/views/tools/moons/buttons/action.blade.php

@@ -1,4 +1,5 @@
 <div class="btn-group btn-group-sm">
     @include('web::tools.moons.buttons.show')
+    @include('web::tools.moons.buttons.edit')
     @include('web::tools.moons.buttons.delete')
 </div>

src/resources/views/tools/moons/buttons/edit.blade.php

@@ -0,0 +1,3 @@
+<button type="button" class="btn btn-sm btn-secondary" data-toggle="modal" data-target="#moon-import" data-url="{{ route('seatcore::tools.moons.edit', $row->moon_id) }}">
+  <i class="fas fa-pen"></i> {{ trans_choice('web::seat.edit', 1) }}
+</button>

src/resources/views/tools/moons/modals/components/content.blade.php

@@ -1,4 +1,7 @@
-<h4>{{ $moon->moon->name }}</h4>
+<h4 class="d-flex">
+  <span class="mr-auto">{{ $moon->moon->name }}</span>
+  @include('web::tools.moons.buttons.edit',['row'=>$moon])
+</h4>
 <p class="lead">
   {{ trans('web::moons.yield_explanation',['volume'=>number_format(Seat\Eveapi\Models\Industry\CorporationIndustryMiningExtraction::BASE_DRILLING_VOLUME, 2),'yield'=>(setting('reprocessing_yield') ?: 0.80) * 100]) }}
 </p>
@@ -16,6 +19,11 @@
   <dt>{{ trans_choice('web::moons.moon', 1) }}</dt>
   <dd>{{ $moon->moon->name }}</dd>
 
+  @if(strip_tags($moon->notes) !== "")
+    <dt>{{ trans('web::moons.notes') }}</dt>
+    <dd>{!! $moon->notes !!}</dd>
+  @endif
+
   <dt>{{trans_choice('web::moons.region', 1)}}</dt>
   <dd>{{ $moon->moon->region->name }}</dd>