Merge pull request #155

[Update] Improve MAL Import
Kurozora · Jun 14, 2021 · 54658d1 · 54658d1
2 parents 6bd72fc + ebf0700
commit 54658d1
Show file tree

Hide file tree

Showing 14 changed files with 407 additions and 36 deletions.
diff --git a/app/Enums/MALImportBehavior.php b/app/Enums/MALImportBehavior.php
@@ -0,0 +1,15 @@
+<?php
+
+namespace App\Enums;
+
+use BenSampo\Enum\Enum;
+
+/**
+ * @method static MALImportBehavior Overwrite()
+ * @method static MALImportBehavior Merge()
+ */
+final class MALImportBehavior extends Enum
+{
+    const Overwrite =   0;
+    const Merge     =   1;
+}
diff --git a/app/Events/MALImportFinished.php b/app/Events/MALImportFinished.php
@@ -2,6 +2,7 @@
 
 namespace App\Events;
 
+use App\Enums\MALImportBehavior;
 use App\Models\User;
 use Illuminate\Foundation\Events\Dispatchable;
 use Illuminate\Queue\SerializesModels;
@@ -27,18 +28,18 @@ class MALImportFinished
     /**
      * The behavior of the import.
      *
-     * @var string
+     * @var MALImportBehavior
      */
-    public string $behavior;
+    public MALImportBehavior $behavior;
 
     /**
      * Create a new event instance.
      *
      * @param User $user
      * @param array $results
-     * @param string $behavior
+     * @param MALImportBehavior $behavior
      */
-    public function __construct(User $user, array $results, string $behavior)
+    public function __construct(User $user, array $results, MALImportBehavior $behavior)
     {
         $this->user = $user;
         $this->results = $results;

diff --git a/app/Http/Controllers/LibraryController.php b/app/Http/Controllers/LibraryController.php
@@ -2,6 +2,7 @@
 
 namespace App\Http\Controllers;
 
+use App\Enums\MALImportBehavior;
 use App\Models\Anime;
 use App\Enums\UserLibraryStatus;
 use App\Helpers\JSONResult;
@@ -153,8 +154,11 @@ function malImport(MALImportRequest $request): JsonResponse
         // Read XML file
         $xmlContent = File::get($data['file']->getRealPath());
 
+        // Get import behavior
+        $behavior = MALImportBehavior::fromValue((int) $data['behavior']);
+
         // Dispatch job
-        dispatch(new ProcessMALImport($user, $xmlContent, $data['behavior']));
+        dispatch(new ProcessMALImport($user, $xmlContent, $behavior));
 
         // Update last MAL import date for user
         $user->last_mal_import_at = now();

diff --git a/app/Http/Requests/MALImportRequest.php b/app/Http/Requests/MALImportRequest.php
@@ -2,6 +2,7 @@
 
 namespace App\Http\Requests;
 
+use App\Enums\MALImportBehavior;
 use Illuminate\Foundation\Http\FormRequest;
 
 class MALImportRequest extends FormRequest
@@ -25,7 +26,7 @@ public function rules(): array
     {
         return [
             'file'      => ['required', 'file', 'mimes:xml', 'max:' . config('mal-import.max_xml_file_size')],
-            'behavior'  => ['required', 'string', 'in:overwrite']
+            'behavior'  => ['required', 'integer', 'in:' . implode(',', MALImportBehavior::getValues())]
         ];
     }
 }
diff --git a/app/Jobs/ProcessMALImport.php b/app/Jobs/ProcessMALImport.php
@@ -2,8 +2,11 @@
 
 namespace App\Jobs;
 
+use App\Enums\MALImportBehavior;
 use App\Models\Anime;
 use App\Enums\UserLibraryStatus;
+use App\Models\AnimeRating;
+use App\Models\UserLibrary;
 use App\Notifications\MALImportFinished;
 use App\Models\User;
 use Illuminate\Bus\Queueable;
@@ -40,9 +43,9 @@ class ProcessMALImport implements ShouldQueue
     /**
      * The behavior of the import action.
      *
-     * @var string
+     * @var MALImportBehavior
      */
-    protected string $behavior;
+    protected MALImportBehavior $behavior;
 
     /**
      * The results of the import action.
@@ -59,9 +62,9 @@ class ProcessMALImport implements ShouldQueue
      *
      * @param User $user
      * @param string $xmlContent
-     * @param string $behavior
+     * @param MALImportBehavior $behavior
      */
-    public function __construct(User $user, string $xmlContent, string $behavior)
+    public function __construct(User $user, string $xmlContent, MALImportBehavior $behavior)
     {
         $this->user = $user;
         $this->xmlContent = $xmlContent;
@@ -74,8 +77,9 @@ public function __construct(User $user, string $xmlContent, string $behavior)
     public function handle()
     {
         // Wipe current library if behavior is set to overwrite
-        if ($this->behavior === 'overwrite') {
+        if ($this->behavior->value === MALImportBehavior::Overwrite) {
             $this->user->library()->detach();
+            $this->user->animeRating()->delete();
         }
 
         // Create XML object
@@ -87,7 +91,7 @@ public function handle()
 
         // Loop through the anime in the export file
         foreach($json['anime'] as $anime) {
-            $this->handleXMLFileAnime($anime['series_animedb_id'], $anime['my_status']);
+            $this->handleXMLFileAnime($anime['series_animedb_id'], $anime['my_status'], $anime['my_score']);
         }
 
         // Notify the user that the MAL import was finished
@@ -99,16 +103,18 @@ public function handle()
      *
      * @param int $malID
      * @param string $malStatus
+     * @param int $malRating
      */
-    protected function handleXMLFileAnime(int $malID, string $malStatus)
+    protected function handleXMLFileAnime(int $malID, string $malStatus, int $malRating)
     {
         // Try to find the Anime in our DB
-        $animeMatch = Anime::where('mal_id', $malID)->first();
+        $anime = Anime::firstWhere('mal_id', $malID);
 
         // If a match was found
-        if ($animeMatch) {
-            // Convert the MAL status to one of our own
+        if (!empty($anime)) {
+            // Convert the MAL data to our own
             $status = $this->convertMALStatus($malStatus);
+            $rating = $this->convertMALRating($malRating);
 
             // Status not found
             if ($status === null) {
@@ -117,11 +123,25 @@ protected function handleXMLFileAnime(int $malID, string $malStatus)
             }
 
             // Add the anime to their library
-            $this->user->library()->attach($animeMatch, ['status' => $status]);
-
-            $this->registerSuccess($animeMatch->id, $malID, $status);
+            UserLibrary::updateOrCreate([
+                'user_id' => $this->user->id,
+                'anime_id' => $anime->id,
+            ], [
+                'status' => $status
+            ]);
+
+            // Updated their anime score
+            AnimeRating::updateOrCreate([
+                'user_id' => $this->user->id,
+                'anime_id' => $anime->id,
+            ], [
+                'rating' => $rating,
+            ]);
+
+            $this->registerSuccess($anime->id, $malID, $status, $rating);
+        } else {
+            $this->registerFailure($malID, 'MAL ID could not be found.');
         }
-        else $this->registerFailure($malID, 'MAL ID could not be found.');
     }
 
     /**
@@ -142,19 +162,36 @@ protected function convertMALStatus(string $malStatus): ?int
         };
     }
 
+    /**
+     * Converts and returns Kurozora specific rating.
+     *
+     * @param int $malRating
+     * @return int
+     */
+    protected function convertMALRating(int $malRating): int
+    {
+        if ($malRating == 0) {
+            return $malRating;
+        }
+
+        return round($malRating) * 0.5;
+    }
+
     /**
      * Registers a success in the import process.
      *
      * @param int $animeID
      * @param int $malID
      * @param string $status
+     * @param int $rating
      */
-    protected function registerSuccess(int $animeID, int $malID, string $status)
+    protected function registerSuccess(int $animeID, int $malID, string $status, int $rating)
     {
         $this->results['successful'][] = [
             'anime_id'  => $animeID,
             'mal_id'    => $malID,
-            'status'    => $status
+            'status'    => $status,
+            'rating'    => $rating,
         ];
     }
 

diff --git a/app/Models/User.php b/app/Models/User.php
@@ -143,6 +143,16 @@ class User extends Authenticatable implements HasMedia, MustVerifyEmail, Reacter
      */
     protected string $profileImageCollectionName = 'profile';
 
+    /**
+     * Returns the anime ratings the user has.
+     *
+     * @return HasMany
+     */
+    public function animeRating(): HasMany
+    {
+        return $this->hasMany(AnimeRating::class);
+    }
+
     /**
      * Returns the associated feed messages for the user.
      *

diff --git a/app/Notifications/MALImportFinished.php b/app/Notifications/MALImportFinished.php
@@ -2,6 +2,7 @@
 
 namespace App\Notifications;
 
+use App\Enums\MALImportBehavior;
 use App\Models\User;
 use Illuminate\Bus\Queueable;
 use Illuminate\Contracts\Queue\ShouldQueue;
@@ -23,17 +24,17 @@ class MALImportFinished extends Notification implements ShouldQueue
     /**
      * The behavior used when importing.
      *
-     * @var string $behavior
+     * @var MALImportBehavior $behavior
      */
-    private string $behavior;
+    private MALImportBehavior $behavior;
 
     /**
      * Create a new notification instance.
      *
      * @param array $results
-     * @param string $behavior
+     * @param MALImportBehavior $behavior
      */
-    public function __construct(array $results, string $behavior)
+    public function __construct(array $results, MALImportBehavior $behavior)
     {
         $this->results = $results;
         $this->behavior = $behavior;
@@ -61,7 +62,7 @@ public function toDatabase(mixed $notifiable): array
         return [
             'successful_count'  => count($this->results['successful']),
             'failure_count'     => count($this->results['failure']),
-            'behavior'          => $this->behavior
+            'behavior'          => $this->behavior->description
         ];
     }
 

diff --git a/config/app.php b/config/app.php
@@ -38,7 +38,7 @@
     | or any other location as required by the application or its packages.
     */
 
-    'version' => '1.2.0-alpha.89',
+    'version' => '1.2.0-alpha.91',
 
     /*
     |--------------------------------------------------------------------------

diff --git a/config/mal-import.php b/config/mal-import.php
@@ -10,11 +10,11 @@
     | This option controls the cooldown in days for users between importing
     | a MAL export file.
     |
-    | Default: 7
+    | Default: 3
     |
     */
 
-    'cooldown_in_days' => 7,
+    'cooldown_in_days' => 3,
 
     /*
     |--------------------------------------------------------------------------
@@ -24,10 +24,10 @@
     | This option controls the maximum allowed file size for a MAL export file
     | in kilobytes.
     |
-    | Default: 5000
+    | Default: 10000
     |
     */
 
-    'max_xml_file_size' => 5000
+    'max_xml_file_size' => 10000
 
 ];
diff --git a/database/migrations/2018_08_22_154146_create_anime_ratings_table.php b/database/migrations/2018_08_22_154146_create_anime_ratings_table.php
@@ -25,6 +25,9 @@ public function up()
         });
 
         Schema::table(AnimeRating::TABLE_NAME, function(Blueprint $table) {
+            // Set unique key constraints
+            $table->unique(['anime_id', 'user_id']);
+
             // Set foreign key constraints
             $table->foreign('anime_id')->references('id')->on(Anime::TABLE_NAME)->onDelete('cascade');
             $table->foreign('user_id')->references('id')->on(User::TABLE_NAME)->onDelete('cascade');

diff --git a/public/openapi.json b/public/openapi.json
@@ -3491,12 +3491,13 @@
         "description": "The lock status used to lock or unlock a thread.\n- 0 = unlock\n- 1 = lock"
       },
       "MALImportBehavior": {
-        "type": "string",
+        "type": "integer",
         "enum": [
-          "overwrite"
+          0,
+          1
         ],
-        "default": "overwrite",
-        "description": "The set of available MAL import behavior types."
+        "default": 1,
+        "description": "The set of available MAL import behavior types.\n- 0 = overwrite\n- 1 = merge"
       },
       "NotificationReadStatus": {
         "type": "integer",