Merge pull request #8 from ssddanbrown/pruning

Post pruning

Author: ssddanbrown

README.md

@@ -20,6 +20,7 @@ The following features are built into the application:
 - Post title/description search.
 - Ready-to-use docker image.
 - Mobile screen compatible.
+- Built-in support to prune old post data.
 
 ## Limitations
 
@@ -156,6 +157,13 @@ APP_LOAD_POST_THUMBNAILS=true
 # therefore should be updated upon request.
 # This effectively has a minimum of 5 minutes in the docker setup.
 APP_FEED_UPDATE_FREQUENCY=60
+
+# The number of days to wait before a post should be pruned.
+# Uses the post published_at time to determine lifetime.
+# Setting this to false disables any auto-pruning.
+# If active, pruning will auto-run daily.
+# Defaults to false (No pruning) 
+APP_PRUNE_POSTS_AFTER_DAYS=30
 ```
 
 ## Usage Behind a Reverse Proxy

app/Console/Commands/PrunePostsCommand.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace App\Console\Commands;
+
+use App\Rss\PostPruner;
+use Illuminate\Console\Command;
+
+class PrunePostsCommand extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'rss:prune-posts
+                            {--days= : Number of days\' worth of posts to keep}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Prune old posts, and their thumbnails, from the system';
+
+    /**
+     * Execute the console command.
+     *
+     * @return int
+     */
+    public function handle(PostPruner $pruner)
+    {
+        $days = $this->option('days', null);
+
+        if (!is_null($days)) {
+            $retention = intval($days);
+        } else {
+            $configuredPruneDays = config('app.prune_posts_after_days');
+
+            if (!$configuredPruneDays) {
+                $this->line("No prune retention time set therefore no posts will be pruned.");
+                return 0;
+            }
+
+            $retention = intval($configuredPruneDays);
+        }
+
+        $acceptsRisk = $this->confirm("This will delete all posts older than {$retention} day(s). Do you want to continue?", true);
+
+        if ($acceptsRisk) {
+            $deleteCount = $pruner->prune($retention);
+            $this->line("Deleted {$deleteCount} posts from the system");
+        }
+
+        return 0;
+    }
+}

app/Console/Kernel.php

@@ -2,6 +2,7 @@
 
 namespace App\Console;
 
+use App\Console\Commands\PrunePostsCommand;
 use App\Console\Commands\UpdateFeedsCommand;
 use Illuminate\Console\Scheduling\Schedule;
 use Illuminate\Foundation\Console\Kernel as ConsoleKernel;
@@ -17,6 +18,7 @@ class Kernel extends ConsoleKernel
     protected function schedule(Schedule $schedule)
     {
         $schedule->command(UpdateFeedsCommand::class)->everyFiveMinutes();
+        $schedule->command(PrunePostsCommand::class, ['-n'])->daily();
     }
 
     /**

app/Http/Kernel.php

@@ -40,7 +40,6 @@ class Kernel extends HttpKernel
         ],
 
         'api' => [
-            // \Laravel\Sanctum\Http\Middleware\EnsureFrontendRequestsAreStateful::class,
             'throttle:api',
             \Illuminate\Routing\Middleware\SubstituteBindings::class,
         ],

app/Rss/PostPruner.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace App\Rss;
+
+use App\Models\Post;
+use Illuminate\Database\Eloquent\Collection;
+use Illuminate\Support\Facades\Storage;
+
+class PostPruner
+{
+    /**
+     * Prune all posts older than the given number of days.
+     * Returns the number of posts deleted.
+     */
+    public function prune(int $retentionDays): int
+    {
+        $day = 86400;
+        $oldestAcceptable = time() - ($retentionDays * $day);
+        $ids = [];
+
+        Post::query()
+            ->where('published_at', '<', $oldestAcceptable)
+            ->select(['id', 'thumbnail'])
+            ->chunk(250, function (Collection $posts) use (&$ids) {
+                array_push($ids, ...$posts->pluck('id')->all());
+                $this->deletePostsThumbnails($posts);
+            });
+
+        foreach (array_chunk($ids, 250) as $idChunk) {
+            Post::query()
+                ->whereIn('id', $idChunk)
+                ->delete();
+        }
+
+        return count($ids);
+    }
+
+    /**
+     * @param Collection<Post> $posts
+     */
+    protected function deletePostsThumbnails(Collection $posts)
+    {
+        $storage = Storage::disk('public');
+
+        foreach ($posts as $post) {
+            if ($post->thumbnail && $storage->exists($post->thumbnail)) {
+                $storage->delete($post->thumbnail);
+            }
+        }
+    }
+}

composer.json

@@ -11,7 +11,6 @@
         "guzzlehttp/guzzle": "^7.2",
         "inertiajs/inertia-laravel": "^0.6.2",
         "laravel/framework": "^9.19",
-        "laravel/sanctum": "^2.14.1",
         "laravel/tinker": "^2.7"
     },
     "require-dev": {