Mark star IPs as VPNs

Author: danharrin

.env.example

@@ -57,3 +57,5 @@ ANYSTACK_TOKEN=
 PIRSCH_TOKEN=
 
 TORCHLIGHT_TOKEN=
+
+VPN_API_TOKEN=

app/Actions/GetPluginsListData.php

@@ -22,6 +22,7 @@ function () use ($plugins): array {
                         fn (Builder $query) => $query->whereIn('starrable_id', $plugins),
                     )
                     ->where('starrable_type', 'plugin')
+                    ->whereNot('is_vpn_ip', true)
                     ->groupBy('starrable_id')
                     ->selectRaw('count(id) as count, starrable_id')
                     ->get()

app/Actions/Star.php

@@ -2,21 +2,42 @@
 
 namespace App\Actions;
 
+use App\Jobs\CheckIfIpIsVpn;
 use App\Models\Contracts\Starrable;
+use App\Models\Star as StarModel;
+use Illuminate\Support\Facades\RateLimiter;
 
 class Star
 {
     public function __invoke(Starrable $starrable): void
     {
+        if (RateLimiter::tooManyAttempts('star:' . request()->ip(), 3)) {
+            return;
+        }
+
+        RateLimiter::hit('star:' . request()->ip());
+
         if ($starrable->stars()->where('ip', request()->ip())->exists()) {
             return;
         }
 
+        $existingIpStar = StarModel::query()
+            ->where('ip', request()->ip())
+            ->whereNotNull('is_vpn_ip')
+            ->first();
+
         $starrable->stars()->create([
             'ip' => request()->ip(),
+            'is_vpn_ip' => $existingIpStar?->is_vpn_ip,
         ]);
 
-        $starrable->cacheStarsCount();
-        $starrable->getAuthor()->cacheStarsCount();
+        if ($existingIpStar?->is_vpn_ip !== true) {
+            $starrable->cacheStarsCount();
+            $starrable->getAuthor()->cacheStarsCount();
+        }
+
+        if (! $existingIpStar) {
+            dispatch(new CheckIfIpIsVpn(request()->ip()));
+        }
     }
 }

app/Http/Controllers/Articles/ListArticlesController.php

@@ -31,6 +31,7 @@ function (): array {
                     $stars = Star::query()
                         ->toBase()
                         ->where('starrable_type', 'article')
+                        ->whereNot('is_vpn_ip', true)
                         ->groupBy('starrable_id')
                         ->selectRaw('count(id) as count, starrable_id')
                         ->get()

app/Http/Controllers/Plugins/ListPluginsController.php

@@ -40,6 +40,7 @@ public function __invoke(GetPluginsListData $getPluginsListData)
             ]),
             'starsCount' => Star::query()
                 ->where('starrable_type', 'plugin')
+                ->whereNot('is_vpn_ip', true)
                 ->count(),
         ]);
     }

app/Jobs/CheckIfIpIsVpn.php

@@ -0,0 +1,72 @@
+<?php
+
+namespace App\Jobs;
+
+use App\Models\Star;
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\Middleware\RateLimited;
+use Illuminate\Queue\SerializesModels;
+use Illuminate\Support\Facades\Http;
+
+class CheckIfIpIsVpn implements ShouldQueue
+{
+    use Dispatchable;
+    use InteractsWithQueue;
+    use Queueable;
+    use SerializesModels;
+
+    /**
+     * Create a new job instance.
+     */
+    public function __construct(
+        public string $ip,
+    ) {
+    }
+
+    /**
+     * Execute the job.
+     */
+    public function handle(): void
+    {
+        $existingIpStar = Star::query()
+            ->where('ip', $this->ip)
+            ->whereNotNull('is_vpn_ip')
+            ->first();
+
+        if ($existingIpStar) {
+            Star::query()
+                ->where('ip', $this->ip)
+                ->update(['is_vpn_ip' => $existingIpStar->is_vpn_ip]);
+
+            return;
+        }
+
+        $isVpn = Http::retry(10)
+            ->throw()
+            ->get('https://vpnapi.io/api/' . request()->ip() . '?key=' . config('services.vpn_api.token'))
+            ->json('security.vpn');
+
+        if (blank($isVpn)) {
+            $this->fail("Failed to check if IP is VPN: {$this->ip}");
+
+            return;
+        }
+
+        Star::query()
+            ->where('ip', $this->ip)
+            ->update(['is_vpn_ip' => $isVpn]);
+    }
+
+    /**
+     * Get the middleware the job should pass through.
+     *
+     * @return array<int, object>
+     */
+    public function middleware(): array
+    {
+        return [new RateLimited('vpn_api')];
+    }
+}

app/Livewire/StarRecord.php

@@ -4,10 +4,11 @@
 
 use App\Actions\Star;
 use App\Actions\Unstar;
+use Illuminate\Contracts\View\View;
 use Illuminate\Database\Eloquent\Model;
 use Livewire\Component;
 
-class Starrecord extends Component
+class StarRecord extends Component
 {
     public Model $record;
 
@@ -18,7 +19,7 @@ class Starrecord extends Component
     public function mount()
     {
         $this->isStarred = $this->isStarred();
-        $this->starsCount = $this->record->getStarsCount();
+        $this->starsCount = $this->calculateStarsCount();
     }
 
     public function isStarred(): bool
@@ -31,19 +32,30 @@ public function toggleStar(): void
         if ($this->isStarred()) {
             app(Unstar::class)($this->record);
 
-            $this->starsCount = $this->record->getStarsCount();
+            $this->starsCount = $this->calculateStarsCount();
             $this->isStarred = false;
 
             return;
         }
 
         app(Star::class)($this->record);
 
-        $this->starsCount = $this->record->getStarsCount();
+        $this->starsCount = $this->calculateStarsCount();
         $this->isStarred = true;
     }
 
-    public function render()
+    protected function calculateStarsCount(): int
+    {
+        $count = $this->record->getStarsCount();
+
+        if ($this->record->stars()->where('ip', request()->ip())->where('is_vpn_ip', true)->exists()) {
+            $count++;
+        }
+
+        return $count;
+    }
+
+    public function render(): View
     {
         return view('livewire.star-record');
     }

app/Models/Article.php

@@ -64,7 +64,7 @@ public function getStarsCount(): int
         return cache()->remember(
             $this->getStarsCountCacheKey(),
             now()->addDay(),
-            fn (): int => $this->stars()->count(),
+            fn (): int => $this->stars()->whereNot('is_vpn_ip', true)->count(),
         );
     }
 

app/Models/Author.php

@@ -58,6 +58,7 @@ public function getStarsCount(): int
             $this->getStarsCountCacheKey(),
             now()->addDay(),
             fn (): int => Star::query()
+                ->whereNot('is_vpn_ip', true)
                 ->where(fn (Builder $query) => $query->where('starrable_type', 'article')->whereIn('starrable_id', $this->articles()->pluck('slug')))
                 ->orWhere(fn (Builder $query) => $query->where('starrable_type', 'plugin')->whereIn('starrable_id', $this->plugins()->pluck('slug')))
                 ->count(),

app/Models/Plugin.php

@@ -129,7 +129,7 @@ public function getStarsCount(): int
         return cache()->remember(
             $this->getStarsCountCacheKey(),
             now()->addDay(),
-            fn (): int => $this->stars()->count(),
+            fn (): int => $this->stars()->whereNot('is_vpn_ip', true)->count(),
         );
     }