Clean up command

Author: gabsource

README.md

@@ -84,6 +84,24 @@ $attachmentByKey = $user->attachment('myKey');
 $publicUrl = $attachmentByKey->url;
 ```
 
+## Delete an attachment
+
+Calling the `delete()` method on an attachment model instance will
+ delete the database row and the file. The deletion of the file can
+ be disabled by setting the `behaviors.cascade_delete` to `false` in
+ the configuration.
+
+> Not that calling `delete()` on a `query()` like statement will not
+ cascade to the filesystem because it will not call the `delete()`
+ method of the `Attachment` model class.
+
+```php
+$user = App\User::first();
+$attachmentByKey = $user->attachment('myKey');
+$attachmentByKey->delete(); // Will also delete the file on the storage by default
+```
+
+
 ## Hooking the file output
 
 The `Bnb\Laravel\Attachments\Attachment` model class provides
@@ -197,4 +215,15 @@ Route::post('/upload', function () {
 
     return redirect('/dropzone');
 });
-```
+```
+
+## Cleanup commands
+
+A command is provided to cleanup the attachments not bound to a model
+ (when `model_type` and `model_id` are `null`).
+
+    php artisan attachment:cleanup
+
+The `-s` (or `--since=[timeInMinutes]`) option can be set to specify
+ another time limit in minutes : only unbound files older than the
+ specified age will be deleted. This value is set to **1440** by default.

src/AttachmentsServiceProvider.php

@@ -2,6 +2,7 @@
 
 namespace Bnb\Laravel\Attachments;
 
+use Bnb\Laravel\Attachments\Console\Commands\CleanupAttachments;
 use Illuminate\Routing\Router;
 use Illuminate\Support\ServiceProvider;
 
@@ -29,6 +30,12 @@ public function boot(Router $router)
         if (config('attachments.routes.publish')) {
             $this->loadRoutesFrom(__DIR__ . '/../routes/web.php');
         }
+
+        if ($this->app->runningInConsole()) {
+            $this->commands([
+                CleanupAttachments::class,
+            ]);
+        }
     }
 
 

src/Console/Commands/CleanupAttachments.php

@@ -0,0 +1,62 @@
+<?php
+/**
+ * laravel
+ *
+ * @author    Jérémy GAULIN <[email protected]>
+ * @copyright 2017 - B&B Web Expertise
+ */
+
+namespace Bnb\Laravel\Attachments\Console\Commands;
+
+use Bnb\Laravel\Attachments\Attachment;
+use Carbon\Carbon;
+use Illuminate\Console\Command;
+use Illuminate\Support\Collection;
+use Lang;
+use Symfony\Component\Console\Input\InputOption;
+
+class CleanupAttachments extends Command
+{
+
+    protected $signature = 'attachments:cleanup';
+
+
+    public function __construct()
+    {
+        $this->description = Lang::get('attachments::messages.console.cleanup_description');
+
+        parent::__construct();
+
+        $this->getDefinition()->addOption(new InputOption('since', '-s', InputOption::VALUE_OPTIONAL,
+            Lang::get('attachments::messages.console.cleanup_option_since'), 1440));
+    }
+
+
+    public function handle()
+    {
+        if ($this->confirm(Lang::get('attachments::messages.console.cleanup_confirm'))) {
+            $query = Attachment::query()
+                ->whereNull('model_type')
+                ->whereNull('model_id')
+                ->where('updated_at', '<=', Carbon::now()->addMinutes(-1 * $this->option('since')));
+
+            $progress = $this->output->createProgressBar($count = $query->count());
+
+            if ($count) {
+                $query->chunk(100, function ($attachements) use ($progress) {
+                    /** @var Collection $attachements */
+                    $attachements->each(function ($attachement) use ($progress) {
+                        /** @var Attachment $attachement */
+                        $attachement->delete();
+
+                        $progress->advance();
+                    });
+                });
+
+                $this->info(Lang::get('attachments::messages.console.done'));
+            } else {
+                $this->comment(Lang::get('attachments::messages.console.cleanup_no_data'));
+            }
+        }
+    }
+}

translations/en/messages.php

@@ -5,5 +5,12 @@
         'access_denied' => 'Access denied.',
         'not_found' => 'Not found.',
         'upload_failed' => 'Upload has failed.'
-    ]
+    ],
+    'console' => [
+        'done' => 'Done!',
+        'cleanup_description' => 'Cleanup attachments not bound to a model instance.',
+        'cleanup_confirm' => 'Do you confirm the deletion of unbound attachments ?',
+        'cleanup_option_since' => 'Minimum age (in minutes) of the attachment to delete (based on modification date).',
+        'cleanup_no_data' => 'No attachment to handle.',
+    ],
 ];

translations/fr/messages.php

@@ -5,5 +5,12 @@
         'access_denied' => 'Vous n’êtes pas autorisé à accéder à la ressource demandée.',
         'not_found' => 'La ressource demandé est introuvable.',
         'upload_failed' => 'L’envoi de la ressource a échoué.'
-    ]
+    ],
+    'console' => [
+        'done' => 'Terminé !',
+        'cleanup_description' => 'Nettoie les pièces jointes non liées à un modèle.',
+        'cleanup_confirm' => 'Confirmez-vous vouloir supprimer les pièces jointes non liées à un modèle ?',
+        'cleanup_option_since' => 'Âge minimum (en minutes) des données à supprimer (se base sur la date de modification).',
+        'cleanup_no_data' => 'Aucune pièce jointe à traiter.',
+    ],
 ];