[4.2] Local adapter thumbnails

administrator/language/en-GB/plg_filesystem_local.ini

@@ -6,5 +6,6 @@
 PLG_FILESYSTEM_LOCAL="FileSystem - Local"
 PLG_FILESYSTEM_LOCAL_DEFAULT_NAME="Local"
 PLG_FILESYSTEM_LOCAL_DIRECTORIES_DIRECTORY_LABEL="Select directories"
+PLG_FILESYSTEM_LOCAL_DIRECTORIES_DIRECTORY_THUMBS_LABEL="Create thumbnails"
 PLG_FILESYSTEM_LOCAL_DIRECTORIES_LABEL="Directories"
 PLG_FILESYSTEM_LOCAL_XML_DESCRIPTION="Filesystem plugin to define one or multiple local directories to store your media files."

plugins/filesystem/local/local.php

@@ -79,7 +79,7 @@ public function getDisplayName()
 	public function getAdapters()
 	{
 		$adapters = [];
-		$directories = $this->params->get('directories', '[{"directory": "images"}]');
+		$directories = $this->params->get('directories', '[{"directory": "images", "thumbs": 1}]');
 
 		// Do a check if default settings are not saved by user
 		// If not initialize them manually
@@ -95,8 +95,15 @@ public function getAdapters()
 				$directoryPath = JPATH_ROOT . '/' . $directoryEntity->directory;
 				$directoryPath = rtrim($directoryPath) . '/';
 
+				if (!isset($directoryEntity->thumbs))
+				{
+					$directoryEntity->thumbs = 1;
+				}
+
 				$adapter = new \Joomla\Plugin\Filesystem\Local\Adapter\LocalAdapter(
-					$directoryPath, $directoryEntity->directory
+					$directoryPath,
+					$directoryEntity->directory,
+					$directoryEntity->thumbs
 				);
 
 				$adapters[$adapter->getAdapterName()] = $adapter;

plugins/filesystem/local/local.xml

@@ -44,6 +44,17 @@
 							hide_none="true"
 							validate="options"
 						/>
+						<field
+							name="thumbs"
+							type="radio"
+							label="PLG_FILESYSTEM_LOCAL_DIRECTORIES_DIRECTORY_THUMBS_LABEL"
+							layout="joomla.form.field.radio.switcher"
+							default="1"
+							filter="integer"
+							>
+							<option value="0">JNO</option>
+							<option value="1">JYES</option>
+						</field>
 					</form>
 				</field>
 			</fieldset>

plugins/filesystem/local/src/Adapter/LocalAdapter.php

@@ -52,15 +52,25 @@ class LocalAdapter implements AdapterInterface
 	 */
 	private $filePath = null;
 
+	/**
+	 * Should the adapter create a thumbnail for the image?
+	 *
+	 * @var boolean
+	 *
+	 * @since  __DEPLOY_VERSION__
+	 */
+	private $thumbs = false;
+
 	/**
 	 * The absolute root path in the local file system.
 	 *
-	 * @param   string  $rootPath  The root path
-	 * @param   string  $filePath  The file path of media folder
+	 * @param   string   $rootPath  The root path
+	 * @param   string   $filePath  The file path of media folder
+	 * @param   boolean  $thumbs    The thumbs option
 	 *
 	 * @since   4.0.0
 	 */
-	public function __construct(string $rootPath, string $filePath)
+	public function __construct(string $rootPath, string $filePath, bool $thumbs = false)
 	{
 		if (!file_exists($rootPath))
 		{
@@ -69,6 +79,17 @@ public function __construct(string $rootPath, string $filePath)
 
 		$this->rootPath = Path::clean(realpath($rootPath), '/');
 		$this->filePath = $filePath;
+		$this->thumbs   = $thumbs;
+
+		if ($this->thumbs)
+		{
+			$dir = JPATH_ROOT . '/media/cache/com_media/thumbs/' . $this->filePath;
+
+			if (!is_dir($dir))
+			{
+				mkdir($dir, 0755, true);
+			}
+		}
 	}
 
 	/**
@@ -224,14 +245,30 @@ public function createFolder(string $name, string $path): string
 	 */
 	public function createFile(string $name, string $path, $data): string
 	{
-		$name = $this->getSafeName($name);
-
+		$name      = $this->getSafeName($name);
 		$localPath = $this->getLocalPath($path . '/' . $name);
 
 		$this->checkContent($localPath, $data);
 
 		File::write($localPath, $data);
 
+		if ($this->thumbs)
+		{
+			$thumbPath = str_replace(
+				$this->rootPath,
+				JPATH_ROOT . '/media/cache/com_media/thumbs/' . $this->filePath,
+				$localPath
+			);
+
+			if (!is_dir(\dirname($thumbPath)))
+			{
+				mkdir(\dirname($thumbPath), 0755, true);
+			}
+
+			// Create the thumbnail
+			(new Image($localPath))->resize(300, 300, true)->toFile($thumbPath);
+		}
+
 		return $name;
 	}
 
@@ -259,6 +296,23 @@ public function updateFile(string $name, string $path, $data)
 		$this->checkContent($localPath, $data);
 
 		File::write($localPath, $data);
+
+		if ($this->thumbs)
+		{
+			$thumbPath = str_replace(
+				$this->rootPath,
+				JPATH_ROOT . '/media/cache/com_media/thumbs/' . $this->filePath,
+				$localPath
+			);
+
+			if (!is_dir(\dirname($thumbPath)))
+			{
+				mkdir(\dirname($thumbPath), 0755, true);
+			}
+
+			// Create the thumbnail
+			(new Image($localPath))->resize(300, 300, true)->toFile($thumbPath);
+		}
 	}
 
 	/**
@@ -271,9 +325,14 @@ public function updateFile(string $name, string $path, $data)
 	 * @since   4.0.0
 	 * @throws  \Exception
 	 */
-	public function delete(string $path)
+	public function delete(string $path): void
 	{
 		$localPath = $this->getLocalPath($path);
+		$thumbPath = str_replace(
+			$this->rootPath,
+			JPATH_ROOT . '/media/cache/com_media/thumbs/' . $this->filePath,
+			$localPath
+		);
 
 		if (is_file($localPath))
 		{
@@ -282,6 +341,11 @@ public function delete(string $path)
 				throw new FileNotFoundException;
 			}
 
+			if ($this->thumbs && is_file($thumbPath))
+			{
+				File::delete($thumbPath);
+			}
+
 			$success = File::delete($localPath);
 		}
 		else
@@ -291,6 +355,11 @@ public function delete(string $path)
 				throw new FileNotFoundException;
 			}
 
+			if ($this->thumbs && is_dir($thumbPath))
+			{
+				Folder::delete($thumbPath);
+			}
+
 			$success = Folder::delete($localPath);
 		}
 
@@ -358,8 +427,7 @@ private function getPathInformation(string $path): \stdClass
 				$obj->width  = $props->width;
 				$obj->height = $props->height;
 
-				// Todo : Change this path to an actual thumbnail path
-				$obj->thumb_path = $this->getUrl($obj->path);
+				$obj->thumb_path = $this->thumbs ? $this->getThumb($path) : $this->getUrl($obj->path);
 			}
 			catch (UnparsableImageException $e)
 			{
@@ -869,4 +937,53 @@ private function getLocalPath(string $path): string
 			throw new InvalidPathException($e->getMessage());
 		}
 	}
+
+	/**
+	 * Returns the path for the thumbnail of the given image.
+	 * If the thumbnail does not exist, it will be created.
+	 *
+	 * @param   string  $path  The path of the image
+	 *
+	 * @return  string
+	 *
+	 * @since   __DEPLOY_VERSION__
+	 */
+	private function getThumb($path): string
+	{
+		$dir = \dirname(
+			str_replace(
+				$this->rootPath,
+				JPATH_ROOT . '/media/cache/com_media/thumbs/' . $this->filePath,
+				$path
+			)
+		);
+
+		if (!is_dir($dir))
+		{
+			mkdir($dir, 0755, true);
+		}
+
+		$thumbPath = str_replace(
+			$this->rootPath,
+			JPATH_ROOT . '/media/cache/com_media/thumbs/' . $this->filePath,
+			$path
+		);
+		$thumbURL = Uri::root() . $this->getEncodedPath(
+			str_replace(
+				$this->rootPath,
+				'media/cache/com_media/thumbs/' . $this->filePath,
+				$path
+			)
+		);
+
+		if (file_exists($thumbPath))
+		{
+			return $thumbURL;
+		}
+
+		// Create the thumbnail
+		(new Image($path))->resize(300, 300, true)->toFile($thumbPath);
+
+		return $thumbURL;
+	}
 }