Merge branch 'release/1.1.0' into v1

Author: khalwat

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Transcoder Changelog
 
+## 1.1.0 - 2018.02.02
+### Added
+* Transcoder now supports the transcoding of remote video & audio files
+* Added the ability to generate a thumbnail for videos in the AdminCP Assets index
+
+### Changed
+* Cleaned up the exception handling
+
 ## 1.0.11 - 2018.02.01
 ### Added
 * Renamed the composer package name to `craft-transcoder`

README.md

@@ -32,11 +32,11 @@ If you have managed hosting, contact your sysadmin to get `ffmpeg` installed.
 
 ## Transcoder Overview
 
-The Transcoder allows you to take any locally stored video, and transcode it into any size, bitrate, framerate, and save it out as a web-ready video in a variety of file formats.
+The Transcoder plugin allows you to take any video (local or remote), and transcode it into any size, bitrate, framerate, and save it out as a web-ready video in a variety of file formats.
 
 It can also transcode audio files to any bitrate & sample rate, to a variety of file formats. It can even extract audio tracks from video files.
 
-It also allows you to get a thumbnail of a video in any size and at any timecode, and can extract information about audio/video files such.
+Transcoder also allows you to get a thumbnail of a video in any size and at any timecode, and can extract information about audio/video files such.
 
 Finally, it lets you download an arbitrary file (such as the transcoded video) via a special download link.
 
@@ -59,6 +59,15 @@ To generate a transcoded video, do the following:
         "height": 480
     }) %}
 
+You can also pass in an URL:
+
+    {% set transVideoUrl = craft.transcoder.getVideoUrl('http://vjs.zencdn.net/v/oceans.mp4', {
+        "videoFrameRate": 20,
+        "videoBitRate": "500k",
+        "width": 720,
+        "height": 480
+    }) %}
+
 You can also pass in an `Asset`:
 
     {% set myAsset = entry.someAsset.first() %}
@@ -122,6 +131,14 @@ To generate a transcoded audio File, do the following:
         "audioChannels": 1
     }) %}
 
+You can also pass in a URL:
+
+    {% set transAudioUrl = craft.transcoder.getAudioUrl('http://www.noiseaddicts.com/samples_1w72b820/2514.mp3', {
+        "audioBitRate": "64k",
+        "audioSampleRate": 22050,
+        "audioChannels": 1
+    }) %}
+
 You can also pass in an `Asset`:
 
     {% set myAsset = entry.someAsset.first() %}
@@ -197,6 +214,14 @@ To generate a thumbnail from a video, do the following:
         "timeInSecs": 20,
     }) %}
 
+You can also pass in a URL:
+
+    {% set transVideoUrl = craft.transcoder.getVideoUrl('http://vjs.zencdn.net/v/oceans.mp4', {
+        "width": 300,
+        "height": 200,
+        "timeInSecs": 20,
+    }) %}
+
 You can also pass in an `Asset`:
 
     {% set myAsset = entry.someAsset.first() %}
@@ -252,6 +277,10 @@ To get information about an existing video/audio file, you can use `craft.transc
 
     {% set fileInfo = craft.transcoder.getFileInfo('/home/vagrant/sites/nystudio107/public/oceans.mp4', true) %}
 
+You can also pass in a URL:
+
+    {% set fileInfo = craft.transcoder.getFileInfo('http://vjs.zencdn.net/v/oceans.mp4', true) %}
+
 You can also pass in an `Asset`:
 
     {% set myAsset = entry.someAsset.first() %}

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.0.11",
+    "version": "1.1.0",
     "keywords": [
         "craft",
         "cms",

src/Transcoder.php

@@ -17,7 +17,11 @@
 use Craft;
 use craft\base\Plugin;
 use craft\console\Application as ConsoleApplication;
+use craft\elements\Asset;
 use craft\events\RegisterCacheOptionsEvent;
+use craft\events\GetAssetThumbUrlEvent;
+use craft\helpers\Assets as AssetsHelper;
+use craft\services\Assets;
 use craft\utilities\ClearCaches;
 use craft\web\twig\variables\CraftVariable;
 
@@ -64,6 +68,23 @@ function (Event $event) {
             }
         );
 
+        // Handler: Elements::EVENT_AFTER_SAVE_ELEMENT
+        Event::on(
+            Assets::class,
+            Assets::EVENT_GET_ASSET_THUMB_URL,
+            function (GetAssetThumbUrlEvent $event) {
+                Craft::trace(
+                    'Assets::EVENT_GET_ASSET_THUMB_URL',
+                    __METHOD__
+                );
+                /** @var Asset $asset */
+                $asset = $event->asset;
+                if (AssetsHelper::getFileKindByExtension($asset->filename) == Asset::KIND_VIDEO) {
+                    $event->url = Transcoder::$plugin->transcode->handleGetAssetThumbUrl($event);
+                }
+            }
+        );
+
         // Handle console commands
         if (Craft::$app instanceof ConsoleApplication) {
             $this->controllerNamespace = 'nystudio107\transcoder\console\controllers';

src/services/Transcode.php

@@ -15,11 +15,14 @@
 use Craft;
 use craft\base\Component;
 use craft\elements\Asset;
+use craft\events\GetAssetThumbUrlEvent;
 use craft\volumes\Local;
 
 use yii\base\Exception;
+use yii\validators\UrlValidator;
 
 use mikehaertl\shellcommand\Command as ShellCommand;
+use yii\base\InvalidConfigException;
 
 /**
  * @author    nystudio107
@@ -83,7 +86,6 @@ class Transcode extends Component
      * @param $videoOptions array   of options for the video
      *
      * @return string       URL of the transcoded video or ""
-     * @throws Exception
      */
     public function getVideoUrl($filePath, $videoOptions): string
     {
@@ -92,7 +94,7 @@ public function getVideoUrl($filePath, $videoOptions): string
         $settings = Transcoder::$plugin->getSettings();
         $filePath = $this->getAssetPath($filePath);
 
-        if (file_exists($filePath)) {
+        if (!empty($filePath)) {
             $destVideoPath = Craft::getAlias($settings['transcoderPath']);
 
             $videoOptions = $this->coalesceOptions("defaultVideoOptions", $videoOptions);
@@ -202,7 +204,6 @@ public function getVideoUrl($filePath, $videoOptions): string
      * @param $thumbnailOptions array   of options for the thumbnail
      *
      * @return string           URL of the video thumbnail
-     * @throws Exception
      */
     public function getVideoThumbnailUrl($filePath, $thumbnailOptions): string
     {
@@ -211,7 +212,7 @@ public function getVideoThumbnailUrl($filePath, $thumbnailOptions): string
         $settings = Transcoder::$plugin->getSettings();
         $filePath = $this->getAssetPath($filePath);
 
-        if (file_exists($filePath)) {
+        if (!empty($filePath)) {
             $destThumbnailPath = Craft::getAlias($settings['transcoderPath']);
 
             $thumbnailOptions = $this->coalesceOptions("defaultThumbnailOptions", $thumbnailOptions);
@@ -264,7 +265,6 @@ public function getVideoThumbnailUrl($filePath, $thumbnailOptions): string
      * @param $audioOptions array of options for the audio file
      *
      * @return string       URL of the transcoded audio file or ""
-     * @throws Exception
      */
     public function getAudioUrl($filePath, $audioOptions): string
     {
@@ -273,7 +273,7 @@ public function getAudioUrl($filePath, $audioOptions): string
         $settings = Transcoder::$plugin->getSettings();
         $filePath = $this->getAssetPath($filePath);
 
-        if (file_exists($filePath)) {
+        if (!empty($filePath)) {
             $destAudioPath = Craft::getAlias($settings['transcoderPath']);
 
             $audioOptions = $this->coalesceOptions("defaultAudioOptions", $audioOptions);
@@ -360,7 +360,6 @@ public function getAudioUrl($filePath, $audioOptions): string
      * @param bool $summary
      *
      * @return array
-     * @throws Exception
      */
     public function getFileInfo($filePath, $summary = false): array
     {
@@ -369,7 +368,7 @@ public function getFileInfo($filePath, $summary = false): array
         $settings = Transcoder::$plugin->getSettings();
         $filePath = $this->getAssetPath($filePath);
 
-        if (file_exists($filePath)) {
+        if (!empty($filePath)) {
             // Build the basic command for ffprobe
             $ffprobeOptions = $settings['ffprobeOptions'];
             $ffprobeCmd = $settings['ffprobePath']
@@ -431,7 +430,6 @@ public function getFileInfo($filePath, $summary = false): array
      * @param $videoOptions
      *
      * @return string
-     * @throws Exception
      */
     public function getVideoFilename($filePath, $videoOptions): string
     {
@@ -456,7 +454,6 @@ public function getVideoFilename($filePath, $videoOptions): string
      * @param $audioOptions
      *
      * @return string
-     * @throws Exception
      */
     public function getAudioFilename($filePath, $audioOptions): string
     {
@@ -474,6 +471,24 @@ public function getAudioFilename($filePath, $audioOptions): string
         return $result;
     }
 
+    /**
+     * Handle generated a thumbnail for the AdminCP
+     *
+     * @param GetAssetThumbUrlEvent $event
+     *
+     * @return null|string
+     */
+    public function handleGetAssetThumbUrl(GetAssetThumbUrlEvent $event)
+    {
+        $options = [
+            "width" => $event->width,
+            "height" => $event->height,
+        ];
+        $thumbUrl = $this->getVideoThumbnailUrl($event->asset, $options);
+
+        return empty($thumbUrl) ? null : $thumbUrl;
+    }
+
     // Protected Methods
     // =========================================================================
 
@@ -484,13 +499,20 @@ public function getAudioFilename($filePath, $audioOptions): string
      * @param $options
      *
      * @return string
-     * @throws Exception
      */
     protected function getFilename($filePath, $options)
     {
         $settings = Transcoder::$plugin->getSettings();
         $filePath = $this->getAssetPath($filePath);
-        $pathParts = pathinfo($filePath);
+
+        $validator = new UrlValidator();
+        $error = '';
+        if ($validator->validate($filePath, $error)) {
+            $urlParts = parse_url($filePath);
+            $pathParts = pathinfo($urlParts['path']);
+        } else {
+            $pathParts = pathinfo($filePath);
+        }
         $fileName = $pathParts['filename'];
 
         // Add our options to the file name
@@ -523,30 +545,54 @@ protected function getFilename($filePath, $options)
      * @param $filePath
      *
      * @return string
-     * @throws Exception
      */
     protected function getAssetPath($filePath): string
     {
         // If we're passed an Asset, extract the path from it
         if (is_object($filePath) && ($filePath instanceof Asset)) {
+            /** @var Asset $asset */
             $asset = $filePath;
-            $assetVolume = $asset->getVolume();
+            $assetVolume = null;
+            try {
+                $assetVolume = $asset->getVolume();
+            } catch (InvalidConfigException $e) {
+                Craft::error($e->getMessage(), __METHOD__);
+            }
+
+            if ($assetVolume) {
+                // If it's local, get a path to the file
+                if ($assetVolume instanceof Local) {
+                    $sourcePath = rtrim($assetVolume->path, DIRECTORY_SEPARATOR);
+                    $sourcePath .= strlen($sourcePath) ? DIRECTORY_SEPARATOR : '';
+                    $folderPath = '';
+                    try {
+                        $folderPath = rtrim($asset->getFolder()->path, DIRECTORY_SEPARATOR);
+                    } catch (InvalidConfigException $e) {
+                        Craft::error($e->getMessage(), __METHOD__);
+                    }
+                    $folderPath .= strlen($folderPath) ? DIRECTORY_SEPARATOR : '';
 
-            if (!(($assetVolume instanceof Local) || is_subclass_of($assetVolume, Local::class))) {
-                throw new Exception(
-                    Craft::t('transcoder', 'Paths not available for non-local asset sources')
-                );
+                    $filePath = $sourcePath . $folderPath . $asset->filename;
+                } else {
+                    // Otherwise, get a URL
+                    $filePath = $asset->getUrl();
+                }
             }
+        }
 
-            $sourcePath = rtrim($assetVolume->path, DIRECTORY_SEPARATOR);
-            $sourcePath .= strlen($sourcePath) ? DIRECTORY_SEPARATOR : '';
-            $folderPath = rtrim($asset->getFolder()->path, DIRECTORY_SEPARATOR);
-            $folderPath .= strlen($folderPath) ? DIRECTORY_SEPARATOR : '';
+        $filePath = Craft::getAlias($filePath);
 
-            $filePath = $sourcePath . $folderPath . $asset->filename;
+        // Make sure that $filePath is either an existing file, or a valid URL
+        if (!file_exists($filePath)) {
+            $validator = new UrlValidator();
+            $error = '';
+            if (!$validator->validate($filePath, $error)) {
+                Craft::error($error, __METHOD__);
+                $filePath = '';
+            }
         }
 
-        return Craft::getAlias($filePath);
+        return $filePath;
     }
 
     /**