Merge branch 'release/1.1.2' into v1

Author: khalwat

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Transcoder Changelog
 
+## 1.1.2 - 2018.02.06
+### Changed
+* Switched video thumbnail generation to use `EVENT_GET_THUMB_PATH`
+* Transcoder now requires Craft CMS 3 RC 9 or later
+
 ## 1.1.1 - 2018.02.03
 ### Changed
 * Only generate a thumbnail when we're actually asked to do so via `$generate1`

composer.json

@@ -2,7 +2,7 @@
     "name": "nystudio107/craft-transcoder",
     "description": "Transcode video & audio files to various formats, and provide video thumbnails",
     "type": "craft-plugin",
-    "version": "1.1.1",
+    "version": "1.1.2",
     "keywords": [
         "craft",
         "cms",
@@ -22,7 +22,7 @@
         }
     ],
     "require": {
-        "craftcms/cms": "^3.0.0-RC1",
+        "craftcms/cms": "^3.0.0-RC9",
         "mikehaertl/php-shellcommand": "~1.2"
     },
     "autoload": {

src/Transcoder.php

@@ -18,8 +18,8 @@
 use craft\base\Plugin;
 use craft\console\Application as ConsoleApplication;
 use craft\elements\Asset;
+use craft\events\AssetThumbEvent;
 use craft\events\RegisterCacheOptionsEvent;
-use craft\events\GetAssetThumbUrlEvent;
 use craft\helpers\Assets as AssetsHelper;
 use craft\services\Assets;
 use craft\utilities\ClearCaches;
@@ -68,19 +68,19 @@ function (Event $event) {
             }
         );
 
-        // Handler: Elements::EVENT_AFTER_SAVE_ELEMENT
+        // Handler: Assets::EVENT_GET_THUMB_PATH
         Event::on(
             Assets::class,
-            Assets::EVENT_GET_ASSET_THUMB_URL,
-            function (GetAssetThumbUrlEvent $event) {
+            Assets::EVENT_GET_THUMB_PATH,
+            function (AssetThumbEvent $event) {
                 Craft::trace(
-                    'Assets::EVENT_GET_ASSET_THUMB_URL',
+                    'Assets::EVENT_GET_THUMB_PATH',
                     __METHOD__
                 );
                 /** @var Asset $asset */
                 $asset = $event->asset;
                 if (AssetsHelper::getFileKindByExtension($asset->filename) == Asset::KIND_VIDEO) {
-                    $event->url = Transcoder::$plugin->transcode->handleGetAssetThumbUrl($event);
+                    $event->path = Transcoder::$plugin->transcode->handleGetAssetThumbPath($event);
                 }
             }
         );

src/services/Transcode.php

@@ -15,7 +15,7 @@
 use Craft;
 use craft\base\Component;
 use craft\elements\Asset;
-use craft\events\GetAssetThumbUrlEvent;
+use craft\events\AssetThumbEvent;
 use craft\volumes\Local;
 
 use yii\base\Exception;
@@ -204,13 +204,14 @@ public function getVideoUrl($filePath, $videoOptions): string
      * @param array  $thumbnailOptions of options for the thumbnail
      * @param bool   $generate         whether the thumbnail should be
      *                                 generated if it doesn't exists
+     * @param bool   $asPath           Whether we should return a path or not
      *
-     * @return string URL of the video thumbnail
+     * @return string|false|null URL or path of the video thumbnail
      */
-    public function getVideoThumbnailUrl($filePath, $thumbnailOptions, $generate = true): string
+    public function getVideoThumbnailUrl($filePath, $thumbnailOptions, $generate = true, $asPath = false)
     {
 
-        $result = "";
+        $result = null;
         $settings = Transcoder::$plugin->getSettings();
         $filePath = $this->getAssetPath($filePath);
 
@@ -256,10 +257,15 @@ public function getVideoThumbnailUrl($filePath, $thumbnailOptions, $generate = t
                 } else {
                     Craft::info('Thumbnail does not exist, but not asked to generate it: ' . $filePath, __METHOD__);
                     // The file doesn't exist, and we weren't asked to generate it
-                    return '';
+                    return false;
                 }
             }
-            $result = Craft::getAlias($settings['transcoderUrl']) . $destThumbnailFile;
+            // Return either a path or a URL
+            if ($asPath) {
+                $result = $destThumbnailPath;
+            } else {
+                $result = Craft::getAlias($settings['transcoderUrl']) . $destThumbnailFile;
+            }
         }
 
         return $result;
@@ -482,19 +488,19 @@ public function getAudioFilename($filePath, $audioOptions): string
     /**
      * Handle generated a thumbnail for the AdminCP
      *
-     * @param GetAssetThumbUrlEvent $event
+     * @param AssetThumbEvent $event
      *
-     * @return null|string
+     * @return null|false|string
      */
-    public function handleGetAssetThumbUrl(GetAssetThumbUrlEvent $event)
+    public function handleGetAssetThumbPath(AssetThumbEvent $event)
     {
         $options = [
             "width"  => $event->width,
             "height" => $event->height,
         ];
-        $thumbUrl = $this->getVideoThumbnailUrl($event->asset, $options, $event->generate);
+        $thumbPath = $this->getVideoThumbnailUrl($event->asset, $options, $event->generate, true);
 
-        return empty($thumbUrl) ? null : $thumbUrl;
+        return $thumbPath;
     }
 
     // Protected Methods