pauloamgomes · Raruto · Feb 2, 2021 · Feb 6, 2021
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,6 @@
+composer.phar
+# /vendor/
+
+# Commit your application's lock file https://getcomposer.org/doc/01-basic-usage.md#commit-your-composer-lock-file-to-version-control
+# You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
+# composer.lock
diff --git a/README.md b/README.md
@@ -5,11 +5,58 @@ The image optimization is performed using the Spatie library - https://github.co
 
 ## Installation
 
-Download and unpack add-on to `<cockpit-folder>/addons/ImageOptimizer` folder.
-By default the Spatie library will detect any optimization binaries on your system and use them, more details about that on https://github.com/spatie/image-optimizer#optimization-tools.
+### Manual
+
+Download [latest release](https://github.com/pauloamgomes/CockpitCMS-ImageOptimizer) and extract to `COCKPIT_PATH/addons/ImageOptimizer` directory
+
+### Git
+
+```sh
+git clone https://github.com/pauloamgomes/CockpitCMS-ImageOptimizer.git ./addons/ImageOptimizer
+```
+
+### Cockpit CLI
+
+```sh
+php ./cp install/addon --name ImageOptimizer --url https://github.com/pauloamgomes/CockpitCMS-ImageOptimizer.git
+```
+
+### Composer
+
+1. Make sure path to cockpit addons is defined in your projects' _composer.json_ file:
+
+  ```json
+  {
+      "name": "MY_PROJECT",
+      "extra": {
+          "installer-paths": {
+              "cockpit/addons/{$name}": ["type:cockpit-module"]
+          }
+      }
+  }
+  ```
+
+2. In your project root run:
+
+  ```sh
+  composer require pauloamgomes/cockpitcms-imageoptimizer
+  ```
+
+---
 
 ## Configuration
 
+By default the Spatie library will use these optimization binaries if they are present on your system:
+
+- [JpegOptim](http://freecode.com/projects/jpegoptim)
+- [Optipng](http://optipng.sourceforge.net/)
+- [Pngquant 2](https://pngquant.org/)
+- [SVGO](https://github.com/svg/svgo)
+- [Gifsicle](http://www.lcdf.org/gifsicle/)
+- [cwebp](https://developers.google.com/speed/webp/docs/precompiled)
+
+More details about that on https://github.com/spatie/image-optimizer#optimization-tools.
+
 No additional configuration is required.
 
 ## Usage

diff --git a/actions.php b/actions.php
@@ -1,11 +1,81 @@
 <?php
 
+use Spatie\ImageOptimizer\OptimizerChain;
+
+use Spatie\ImageOptimizer\Optimizers\Cwebp;
+use Spatie\ImageOptimizer\Optimizers\Gifsicle;
+use Spatie\ImageOptimizer\Optimizers\Jpegoptim;
+use Spatie\ImageOptimizer\Optimizers\Optipng;
+use Spatie\ImageOptimizer\Optimizers\Pngquant;
+use Spatie\ImageOptimizer\Optimizers\Svgo;
+
+$BIN_PATH      = str_replace(DIRECTORY_SEPARATOR, '/', __DIR__).'/binaries';
+
+$jpegQuality   = '--max=85';
+$pngQuality    = '--quality=85';
+
+/**
+ * Create custom optimization chain
+ *
+ * @see https://github.com/spatie/image-optimizer#creating-your-own-optimization-chains
+ */
+$spatie        = new OptimizerChain();
+$jpegoptim     = new Jpegoptim([ $jpegQuality, '--strip-all', '--all-progressive']);
+$pngquant      = new Pngquant([ $pngQuality, '--force' ]);
+$optipng       = new Optipng([ '-i0', '-o2', '-quiet' ]);
+$svgo          = new Svgo([ '--disable={cleanupIDs,removeViewBox}' ]);
+$gifsicle      = new Gifsicle([ '-b', '-O3', ]);
+$cwebp         = new Cwebp([ '-m 6', '-pass 10', '-mt', '-q 80' ]);
+
+// helper function to detect necessary executables
+$where         = function ($command) {
+  return is_executable(shell_exec((strpos(PHP_OS, 'WIN') === 0 ? 'where ' : 'command -v ').$command));
+};
+
+switch(PHP_OS) {
+    case 'Darwin':
+    case 'FreeBSD':
+    case 'Linux':
+    case 'SunOS':
+    case 'WINNT':
+
+        // path to precompiled binaries
+        $BIN_PATH .= '/'.PHP_OS;
+
+        // append ".exe" for windows binaries
+        if (PHP_OS === 'WINNT') {
+            $jpegoptim->binaryName .= '.exe';
+            $pngquant ->binaryName .= '.exe';
+            $optipng  ->binaryName .= '.exe';
+            $svgo     ->binaryName .= '.exe';
+            $gifsicle ->binaryName .= '.exe';
+            $cwebp    ->binaryName .= '.exe';
+        }
+
+        foreach ([$jpegoptim, $pngquant, $optipng, $svgo, $gifsicle, $cwebp] as $optimizer) {
+
+          // if installed, use system binaries
+          if ($where($optimizer->binaryName)) {
+            $spatie   ->addOptimizer($optimizer);
+          }
+
+          // if bundled, use precompiled binaries
+          else if (is_executable("$BIN_PATH/$optimizer->binaryName")) {
+            $optimizer->setBinaryPath($BIN_PATH);
+            $spatie   ->addOptimizer($optimizer);
+          }
+
+        }
+
+        break;
+
+}
 
 /**
  * Implements cockpit.asset.upload event.
  */
-$app->on('cockpit.asset.upload', function(&$asset, &$_meta, &$opts) {
+$app->on('cockpit.asset.upload', function(&$asset, &$_meta, &$opts) use($spatie) {
   $file = $this->path("#tmp:") . '/' . $asset['title'];
-  \Spatie\ImageOptimizer\OptimizerChainFactory::create()->optimize($file);
+  $spatie->optimize($file);
   $asset['size'] = filesize($file);
 });
diff --git a/binaries/Darwin/cwebp b/binaries/Darwin/cwebp
diff --git a/binaries/Darwin/gifsicle b/binaries/Darwin/gifsicle
diff --git a/binaries/Darwin/jpegoptim b/binaries/Darwin/jpegoptim
diff --git a/binaries/Darwin/optipng b/binaries/Darwin/optipng
diff --git a/binaries/Darwin/pngquant b/binaries/Darwin/pngquant
diff --git a/binaries/Darwin/svgo b/binaries/Darwin/svgo
diff --git a/binaries/FreeBSD/cwebp b/binaries/FreeBSD/cwebp
diff --git a/binaries/FreeBSD/gifsicle b/binaries/FreeBSD/gifsicle
diff --git a/binaries/FreeBSD/optipng b/binaries/FreeBSD/optipng
diff --git a/binaries/FreeBSD/pngquant b/binaries/FreeBSD/pngquant
diff --git a/binaries/Linux/cwebp b/binaries/Linux/cwebp
diff --git a/binaries/Linux/gifsicle b/binaries/Linux/gifsicle
diff --git a/binaries/Linux/jpegoptim b/binaries/Linux/jpegoptim
diff --git a/binaries/Linux/optipng b/binaries/Linux/optipng
diff --git a/binaries/Linux/pngquant b/binaries/Linux/pngquant
diff --git a/binaries/Linux/svgo b/binaries/Linux/svgo
diff --git a/binaries/SunOS/cwebp b/binaries/SunOS/cwebp
diff --git a/binaries/SunOS/gifsicle b/binaries/SunOS/gifsicle
diff --git a/binaries/SunOS/optipng b/binaries/SunOS/optipng
diff --git a/binaries/SunOS/pngquant b/binaries/SunOS/pngquant
diff --git a/binaries/WINNT/cwebp.exe b/binaries/WINNT/cwebp.exe
diff --git a/binaries/WINNT/gifsicle.exe b/binaries/WINNT/gifsicle.exe
diff --git a/binaries/WINNT/jpegoptim.exe b/binaries/WINNT/jpegoptim.exe
diff --git a/binaries/WINNT/optipng.exe b/binaries/WINNT/optipng.exe
diff --git a/binaries/WINNT/pngquant.exe b/binaries/WINNT/pngquant.exe
diff --git a/binaries/WINNT/svgo.exe b/binaries/WINNT/svgo.exe
diff --git a/bootstrap.php b/bootstrap.php
@@ -1,4 +1,14 @@
 <?php
+/**
+ * Cockpit image optimizer addon
+ *
+ * @author  Paulo Gomes
+ * @package CockpitCMS-ImageOptimizer
+ * @license MIT
+ *
+ * @source  https://github.com/pauloamgomes/CockpitCMS-ImageOptimizer
+ * @see     { README.md } for usage info.
+ */
 
 require __DIR__ . '/vendor/autoload.php';
 

diff --git a/composer.json b/composer.json
@@ -1,10 +1,10 @@
 {
-    "name": "pauloamgomes/CockpitCMS-ImageOptimizer",
-    "type": "project",
+    "name": "pauloamgomes/cockpitcms-imageoptimizer",
     "description": "Simple Cockpit CMS addon that integrates with Spatie image optimization library.",
     "keywords": ["cms", "headless", "api", "cockpit", "images", "media"],
     "homepage": "https://github.com/pauloamgomes/CockpitCMS-ImageOptimizer",
     "license": "MIT",
+    "type": "cockpit-module",
     "authors": [
         {
             "name": "Paulo Gomes",
@@ -13,6 +13,14 @@
         }
     ],
     "require": {
-        "spatie/image-optimizer": "^1.2"
+        "php": ">= 7.3",
+        "spatie/image-optimizer": "^1.2",
+        "composer/installers": "^1.10"
+    },
+    "suggest": {
+        "aheinze/cockpit": "Please install Cockpit before installing this addon"
+    },
+    "extra": {
+        "installer-name": "ImageOptimizer"
     }
 }