Added: Transform PDF's on upload setting

bymayo · Dec 5, 2022 · 6bc9572 · 6bc9572
1 parent 9def66f
commit 6bc9572
Show file tree

Hide file tree

Showing 7 changed files with 109 additions and 66 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,16 @@
 # PDF Transform Changelog
 
+## 1.0.9 - 2022-12-05
+
+> **Note**
+> After upgrading ensure you switch on the "Transform PDF's on upload" setting in the plugin settings. Previously this was automatically on, but now defaults to false.
+
+### Added
+- Setting to optionally turn on PDF transforms on asset upload
+
+### Fixed
+- Added human friendly exception if volume is not set in the plugin settings
+
 ## 1.0.8 - 2022-11-14
 ### Added
 - Amazon S3 Compatability

diff --git a/README.md b/README.md
@@ -16,7 +16,7 @@ A use case for this is to show the preview of a PDF before a user downloads that
 
 -  Install with Composer via `composer require bymayo/pdf-transform` from your project directory
 -  Enable / Install the plugin in the Craft Control Panel under `Settings > Plugins`
--  Customise the plugin settings, _*especially*_ the `Image Volume` option.
+-  Customise the plugin settings, _*especially*_ the `Output Image Volume` option.
 
 You can also install the plugin via the Plugin Store in the Craft Admin CP by searching for `PDF Transform`.
 
@@ -34,30 +34,35 @@ You can also install the plugin via the Plugin Store in the Craft Admin CP by se
     <td><strong>Default</strong></td>
 		<td><strong>Description</strong></td>
 	</tr>
-	<tr>
-		<td>Page Number</td>
-    <td>1</td>
-    <td>Set with page should in the PDF should be converted to an image.</td>
+  <tr>
+		<td>Transform PDF's on upload</td>
+    <td>false</td>
+    <td>Automatically transform any PDF file uploaded to output image volume via Assets.</td>
 	</tr>
   <tr>
-		<td>Image Volume</td>
+		<td>Output Image Volume</td>
     <td>null</td>
-    <td>Choose where converted images should be stored.</td>
+    <td>The volume you want to output transformed PDF's to.</td>
+	</tr>
+	<tr>
+		<td>Page Number</td>
+    <td>1</td>
+    <td>Set which page in the PDF should be transformed to an image.</td>
 	</tr>
   <tr>
 		<td>Image Resolution</td>
     <td>72</td>
-    <td>Set the resolution of the converted image.</td>
+    <td>Set the resolution of the transformed image.</td>
 	</tr>
   <tr>
 		<td>Image Format</td>
     <td>jpg</td>
-    <td>Set the file format of the converted image.</td>
+    <td>Set the file format of the transformed image.</td>
 	</tr>
   <tr>
 		<td>Image Quality</td>
     <td>100</td>
-    <td>Set the image quality of the converted image.</td>
+    <td>Set the image quality of the transformed image.</td>
 	</tr>
 </table>
 
@@ -70,10 +75,10 @@ To transform a PDF to an image use the following Twig tag:
 
 {% set transformedPdf = craft.pdfTransform.render(pdfToTransform) %}
 
-{{ transformedPdf.one().url }}
+{{ transformedPdf.url }}
 ```
 
-The transformed PDF (Now an image stored in Assets) can then be output using `{{ transformedPdf.one().url }}`. Or get any Asset property e.g. `title`, `id`, `filename` etc.
+The transformed PDF (Now an image stored in Assets) can then be output using `{{ transformedPdf.url }}`. Or get any Asset property e.g. `title`, `id`, `filename` etc.
 
 If the transformed image doesn't exist then the PDF will be transformed via the template. This may cause the template/page to become slow whilst the PDF is transformed.
 

diff --git a/composer.json b/composer.json
@@ -2,7 +2,7 @@
     "name": "bymayo/pdf-transform",
     "description": "Transform a PDF page to an image (JPEG, PNG)",
     "type": "craft-plugin",
-    "version": "1.0.8",
+    "version": "1.0.9",
     "keywords": [
         "craft",
         "cms",

diff --git a/src/PdfTransform.php b/src/PdfTransform.php
@@ -52,9 +52,9 @@ class PdfTransform extends Plugin
     // =========================================================================
 
     public static function log($message)
-   {
+    {
       Craft::getLogger()->log($message, \yii\log\Logger::LEVEL_INFO, 'pdf-transform');
-   }
+    }
 
     /**
      * @inheritdoc
@@ -71,7 +71,7 @@ public function init()
             ]
          );
 
-      Craft::getLogger()->dispatcher->targets[] = $fileTarget;
+        Craft::getLogger()->dispatcher->targets[] = $fileTarget;
 
         Event::on(
             CraftVariable::class,
@@ -108,12 +108,11 @@ function(Event $event)   {
 
                 $element = $event->element;
 
-               if ($element instanceof \craft\elements\Asset) {
-                  if ($event->isNew && $element->extension === 'pdf') {
-                    // @TODO: trigger the imageToPdf function
-                    PdfTransform::$plugin->pdfTransformService->pdfToImage($element);
-                 }
-               }
+                if ($element instanceof \craft\elements\Asset) {
+                    if ($event->isNew && $element->extension === 'pdf' && $this->getSettings()->transformPdfsOnUpload) {
+                        PdfTransform::$plugin->pdfTransformService->pdfToImage($element);
+                    }
+                }
 
             }
         );

diff --git a/src/models/Settings.php b/src/models/Settings.php
@@ -26,8 +26,9 @@ class Settings extends Model
     /**
      * @var string
      */
-    public $page = 1;
+    public $transformPdfsOnUpload = false;
     public $imageVolume = null;
+    public $page = 1;
     public $imageFormat = 'jpg';
     public $imageResolution = 72;
     public $imageQuality = 100;
@@ -42,6 +43,7 @@ public function rules()
     {
         return [
             [['page', 'imageVolume', 'imageResolution', 'imageQuality'], 'integer'],
+            ['transformPdfsOnUpload', 'boolean'],
             ['imageFormat', 'string']
         ];
     }

diff --git a/src/services/PdfTransformService.php b/src/services/PdfTransformService.php
@@ -14,6 +14,7 @@
 use Craft;
 use craft\base\Component;
 use Yii;
+use yii\base\Exception;
 use craft\services\Volumes;
 use Spatie\PdfToImage\Pdf;
 use craft\elements\Asset;
@@ -27,7 +28,7 @@
 class PdfTransformService extends Component
 {
 
-  private $settings;
+    private $settings;
 
     // Public Methods
     // =========================================================================
@@ -39,7 +40,12 @@ public function __construct() {
     public function getVolumeOptions()
     {
 
-      $volumesArray = array();
+      $volumesArray = array(
+        array(
+            'label' => 'Select a volume',
+            'value' => null
+          )
+      );
       $volumes = new Volumes;
 
       foreach ($volumes->getAllVolumes() as $volume) {
@@ -58,8 +64,13 @@ public function getVolumeOptions()
     public function getImageVolume()
     {
       $imageVolumeId = $this->settings->imageVolume;
-      $volume = Craft::$app->getVolumes()->getVolumeById($imageVolumeId);
-      return $volume;
+
+      if ($imageVolumeId) {
+        $volume = Craft::$app->getVolumes()->getVolumeById($imageVolumeId);
+        return $volume;
+      }
+
+      throw new Exception('PDF Transform: No output image volume selected in settings');
    }
 
    public function getFileName($asset)
@@ -97,40 +108,47 @@ public function pdfToImage($asset)
       $filename = $this->getFileName($asset);
       $volume = $this->getImageVolume();
 
-      $pathService = Craft::$app->getPath();
-      $tempPath = $pathService->getTempPath(true) . '/' . mt_rand(0, 9999999) . '.png';
-      file_put_contents($tempPath, file_get_contents($asset->url));
-
-      $tempPathTransform = $pathService->getTempPath(true) . '/' . $filename;
-
-      $folder = Craft::$app->getAssets()->getRootFolderByVolumeId($volume->id);
-
-      $pdf = new Pdf($tempPath);
-
-      $pdf
-        ->setPage($this->settings->page)
-        ->setResolution($this->settings->imageResolution)
-        ->setCompressionQuality($this->settings->imageQuality)
-        ->saveImage($tempPathTransform);
-
-      $assetTransformed = new Asset();
-      $assetTransformed->tempFilePath = $tempPathTransform;
-      $assetTransformed->filename = $filename;
-      $assetTransformed->folderId = $folder->id;
-      $assetTransformed->newFolderId = $folder->id;
-      $assetTransformed->kind = 'Image';
-      $assetTransformed->title = $asset->title;
-      $assetTransformed->avoidFilenameConflicts = true;
-      $assetTransformed->setVolumeId($volume->id);
-      $assetTransformed->setScenario(Asset::SCENARIO_CREATE);
-
-      $assetTransformed->validate();
-
+      try {
+
+        $pathService = Craft::$app->getPath();
+        $tempPath = $pathService->getTempPath(true) . '/' . mt_rand(0, 9999999) . '.png';
+        file_put_contents($tempPath, file_get_contents($asset->url));
+
+        $tempPathTransform = $pathService->getTempPath(true) . '/' . $filename;
+
+        $folder = Craft::$app->getAssets()->getRootFolderByVolumeId($volume->id);
+
+        $pdf = new Pdf($tempPath);
+
+        $pdf
+          ->setPage($this->settings->page)
+          ->setResolution($this->settings->imageResolution)
+          ->setCompressionQuality($this->settings->imageQuality)
+          ->saveImage($tempPathTransform);
+
+        $assetTransformed = new Asset();
+        $assetTransformed->tempFilePath = $tempPathTransform;
+        $assetTransformed->filename = $filename;
+        $assetTransformed->folderId = $folder->id;
+        $assetTransformed->newFolderId = $folder->id;
+        $assetTransformed->kind = 'Image';
+        $assetTransformed->title = $asset->title;
+        $assetTransformed->avoidFilenameConflicts = true;
+        $assetTransformed->setVolumeId($volume->id);
+        $assetTransformed->setScenario(Asset::SCENARIO_CREATE);
+
+        $assetTransformed->validate();
+
         if (Craft::$app->getElements()->saveElement($assetTransformed, false))
         {
           return $assetTransformed;
         }
 
+      }  
+      catch (Exception $e) {
+        throw new Exception('PDF Transform: Could not transform PDF to image');
+      }
+
 
     }
 

diff --git a/src/templates/settings.twig b/src/templates/settings.twig
@@ -2,19 +2,17 @@
 
 {% do view.registerAssetBundle("bymayo\\pdftransform\\assetbundles\\PdfTransform\\PdfTransformAsset") %}
 
-{{ forms.textField({
-    label: 'Page Number',
-    instructions: 'The page number to render.',
-    id: 'page',
-    name: 'page',
-    value: settings['page'],
-    required: true
-    })
-}}
+{{ forms.lightswitchField({
+    label: 'Transform PDF\'s on upload',
+    instructions: 'Automatically transform any PDF file uploaded to output image volume via Assets.',
+    id: 'transformPdfsOnUpload',
+    name: 'transformPdfsOnUpload',
+    on: settings['transformPdfsOnUpload'],
+  }) }}
 
 {{ forms.selectField({
     label: 'Output Image Volume',
-    instructions: 'The volume you want to output renders to',
+    instructions: 'The volume you want to output transformed PDF\'s to',
     id: 'imageVolume',
     name: 'imageVolume',
     value: settings['imageVolume'],
@@ -23,6 +21,16 @@
     })
 }}
 
+{{ forms.textField({
+    label: 'Page Number',
+    instructions: 'The page number to transform.',
+    id: 'page',
+    name: 'page',
+    value: settings['page'],
+    required: true
+    })
+}}
+
 {{ forms.textField({
     label: 'Image Resolution',
     id: 'imageResolution',