Add new dashboard widget and fix '' context error

Author: Bradie Tilley

Plugin.php

@@ -6,6 +6,7 @@
 use ABWebDevelopers\ImageResize\Classes\Resizer;
 use ABWebDevelopers\ImageResize\Commands\ImageResizeClear;
 use ABWebDevelopers\ImageResize\Commands\ImageResizeGc;
+use ABWebDevelopers\ImageResize\ReportWidgets\ImageResizeClearWidget;
 use Event;
 
 class Plugin extends PluginBase
@@ -104,6 +105,17 @@ public function register()
      */
     public function registerSchedule($schedule)
     {
-        $schedule->command('imageresize:gc')->daily();
+        // This is throttled by your settings, it won't necessarily clear all images every 5 minutes
+        $schedule->command('imageresize:gc')->everyFiveMinutes();
+    }
+
+    public function registerReportWidgets()
+    {
+        return [
+            ImageResizeClearWidget::class => [
+                'label' => 'Clear Image Resizer Cache',
+                'context' => 'dashboard',
+            ],
+        ];
     }
 }

lang/en/lang.php

@@ -143,4 +143,10 @@
             ]
         ],
     ],
+    'widgets' => [
+        'clear' => [
+            'cleared' => 'Successfully cleared all resized cached images (:size)',
+            'showGcInterval' => 'Show Garbage Collection Interval',
+        ]
+    ],
 ];

models/Settings.php

@@ -266,8 +266,10 @@ public static function getBasePath(string $subdirectoryPath = null, bool $absolu
      */
     public static function getAgeToDelete(): string
     {
-        if (!empty($this->cache_clear_interval)) {
-            return $this->cache_clear_interval;
+        $that = static::instance();
+
+        if (!empty($that->cache_clear_interval)) {
+            return $that->cache_clear_interval;
         }
 
         return static::DEFAULT_CACHE_CLEAR_AGE;

reportwidgets/ImageResizeClearWidget.php

@@ -0,0 +1,131 @@
+<?php
+
+namespace ABWebDevelopers\ImageResize\ReportWidgets;
+
+use ABWebDevelopers\ImageResize\Models\Settings;
+use Backend\Classes\ReportWidgetBase;
+use Illuminate\Support\Facades\Artisan;
+use Illuminate\Support\Facades\File;
+use Illuminate\Support\Facades\Lang;
+use October\Rain\Support\Facades\Flash;
+
+class ImageResizeClearWidget extends ReportWidgetBase
+{
+    public function defineProperties()
+    {
+        return [
+            'showGcInterval' => [
+                'title' => 'abwebdevelopers.imageresize::lang.widgets.clear.showGcInterval',
+                'default' => true,
+                'type' => 'checkbox',
+            ]
+        ];
+    }
+
+    /**
+     * Default handler: Render the widget
+     *
+     * @return void
+     */
+    public function render()
+    {
+        return $this->makePartial('default');
+    }
+
+    /**
+     * AJAX callback: Clear the cache
+     *
+     * @return void
+     */
+    public function onClear()
+    {
+        $from = $this->directorySize();
+        Artisan::call('imageresize:clear');
+        $to = $this->directorySize();
+
+        $size = $this->formatSize($from - $to);
+        Flash::success(Lang::get('abwebdevelopers.imageresize::lang.widgets.clear.cleared', [
+            'size' => $size
+        ]));
+
+        return [
+            'partial' => $this->render(),
+        ];
+    }
+
+    /**
+     * Get the total size (in bytes) of all resized images
+     *
+     * @return int
+     */
+    protected function directorySize(): int
+    {
+        $size = 0;
+        $path = Settings::getBasePath();
+
+        foreach (File::allFiles($path) as $file) {
+            $size += $file->getSize();
+        }
+
+        return $size;
+    }
+
+    /**
+     * Format the bytes to human readable form
+     *
+     * @param int $size
+     * @param int $precision
+     * @return string
+     */
+    protected function formatSize(int $size, int $precision = 2): string
+    {
+        if (empty($size)) {
+            return '0B';
+        }
+
+        $base = log($size, 1024);
+        $suffixes = ['B', 'KB', 'MB', 'GB', 'TB'];
+
+        return round(pow(1024, $base - floor($base)), $precision) . $suffixes[floor($base)];
+    }
+
+    /**
+     * Get the title of the widget
+     *
+     * @return string
+     */
+    public function title(): string
+    {
+        return 'Image Resize Cache';
+    }
+
+    /**
+     * Get the size of all cached images (formatted)
+     *
+     * @return string
+     */
+    public function size(): string
+    {
+        return $this->formatSize($this->directorySize());
+    }
+
+    /**
+     * Get the configured cache clear interval
+     *
+     * @return string|null
+     */
+    public function garbageCollectionInterval(): ?string
+    {
+        return Settings::getAgeToDelete();
+    }
+
+    /**
+     * Should the garbage collection interval be displayed in this widget?
+     *
+     * @return boolean
+     */
+    public function showGarbageCollectionInterval(): bool
+    {
+        return (bool) $this->property('showGcInterval', false);
+    }
+}

reportwidgets/imageresizeclearwidget/partials/_default.htm

@@ -0,0 +1,12 @@
+<div id="imageresizeclearwidget" class="report-widget">
+    <h3><?= e(trans($this->title())) ?></h3>
+    <?php if ($this->garbageCollectionInterval() && $this->showGarbageCollectionInterval()): ?>
+        <p style="color: #999;">Garbage collection interval: <?= e($this->garbageCollectionInterval()) ?></p>
+    <?php endif; ?>
+    <button type="button" class="btn btn-success"
+            title="Clearing the cache will NOT remove the original images, it will only remove the cached resized copies"
+            data-request="<?= $this->getEventHandler('onClear') ?>"
+            data-request-success="$('#imageresizeclearwidget').replaceWith(data.partial)">
+        Clear all resized images (<?= $this->size() ?>) | <span class="fa icon-trash"></span>
+    </button>
+</div>

updates/version.yaml

@@ -30,4 +30,6 @@
   - Clear old images (for the v2.1.0 directory change)
   - clear_old_cache_dir.php
 2.1.3:
-  - Fix - Generate absolute URLs instead of domain-relative URLs
+  - Fix - Generate absolute URLs instead of domain-relative URLs
+2.1.4:
+  - Add new Dashboard Widget as an alternative method of clearing the image resize cache