[3.5] Add feature to fetch placeholder images from remote URLs

src/Storage/Database/Prefill/ApiClient.php

@@ -3,6 +3,7 @@
 namespace Bolt\Storage\Database\Prefill;
 
 use GuzzleHttp\Client;
+use Psr\Http\Message\StreamInterface;
 
 /**
  * Handles fetching prefill text content from an API service.
@@ -36,4 +37,18 @@ public function get($request, $base = 'http://loripsum.net/api/')
 
         return $this->client->get($uri, ['timeout' => 10])->getBody();
     }
+
+    /**
+     * Fetches an image from a remote source.
+     *
+     * @param string $url URL of the remote image to fetch
+     *
+     * @return StreamInterface
+     */
+    public function getImage($url)
+    {
+        $url = str_replace('__random__', rand(100000, 999999), $url);
+
+        return $this->client->get($url, ['timeout' => 10])->getBody();
+    }
 }

src/Storage/Database/Prefill/RecordContentGenerator.php

@@ -3,11 +3,13 @@
 namespace Bolt\Storage\Database\Prefill;
 
 use Bolt\Collection\ImmutableBag;
+use Bolt\Filesystem\Exception\IOException;
 use Bolt\Filesystem\FilesystemInterface;
 use Bolt\Storage\Collection;
 use Bolt\Storage\Entity;
 use Bolt\Storage\Repository\ContentRepository;
 use Cocur\Slugify\Slugify;
+use GuzzleHttp\Exception\RequestException;
 
 /**
  * Create a generated set of pre-filled records for a ContentType.
@@ -278,12 +280,14 @@ private function addText(Entity\Content $contentEntity, $fieldName, $type, array
      */
     private function addJson(Entity\Content $contentEntity, $fieldName, $type)
     {
+        $contentType = $this->repository->getEntityManager()->getContentType($contentEntity->getContenttype());
+        $placeholder = isset($contentType['fields'][$fieldName]['placeholder']) ? $contentType['fields'][$fieldName]['placeholder'] : null;
         $value = null;
         if ($type === 'image') {
-            $value = $this->getRandomImage($type);
+            $value = $this->getRandomImage($type, $placeholder);
         } elseif ($type === 'imagelist') {
             for ($i = 1; $i <= 3; $i++) {
-                $value[] = $this->getRandomImage($type);
+                $value[] = $this->getRandomImage($type, $placeholder);
             }
         } elseif ($type === 'filelist' || $type === 'templatefields') {
             $value = [];
@@ -449,13 +453,19 @@ private function getRandomTags($count = 5)
     /**
      * Get a random image.
      *
-     * @param string $type
+     * @param string      $type
+     * @param string|null $placeholder
      *
      * @return array|null
      */
-    private function getRandomImage($type)
+    private function getRandomImage($type, $placeholder)
     {
         $pathKey = $type === 'image' ? 'file' : 'filename';
+
+        if ($placeholder && ($filename = $this->fetchPlaceholder($placeholder))) {
+            return [$pathKey => $filename, 'title' => 'placeholder', 'alt' => 'placeholder'];
+        }
+
         $images = $this->getImageFiles();
         if (empty($images)) {
             return null;
@@ -467,4 +477,32 @@ private function getRandomImage($type)
 
         return [$pathKey => $image->getPath(), 'title' => $title, 'alt' => $title];
     }
+
+    /**
+     * Attempt to fetch a placeholder image from a remote URL.
+     *
+     * @param string $placeholder
+     *
+     * @return array|bool
+     */
+    private function fetchPlaceholder($placeholder)
+    {
+        try {
+            $image = $this->apiClient->getImage($placeholder);
+        } catch (RequestException $e) {
+            // We couldn't fetch the file, fall back to default behaviour
+            return false;
+        }
+
+        $filename = sprintf('placeholder_%s.jpg', substr(md5(microtime()), 0, 12));
+
+        try {
+            $this->filesystem->put('files://' . $filename, $image);
+        } catch (IOException $e) {
+            // We couldn't save the file, fall back to default behaviour
+            return false;
+        }
+
+        return $filename;
+    }
 }