nextcloud / server

lib/private/PreviewManager.php

Spacing +2 added lines, -2 removed lines

@@ -244,7 +244,7 @@ 
 		}
 
 		$mount = $file->getMountPoint();
-		if ($mount and !$mount->getOption('previews', true)){
+		if ($mount and !$mount->getOption('previews', true)) {
 			return false;
 		}
 
@@ -330,7 +330,7 @@ 
 	 */
 	protected function registerCoreProvider($class, $mimeType, $options = []) {
 		if (in_array(trim($class, '\\'), $this->getEnabledDefaultProvider())) {
-			$this->registerProvider($mimeType, function () use ($class, $options) {
+			$this->registerProvider($mimeType, function() use ($class, $options) {
 				return new $class($options);
 			});
 		}

Indentation +387 added lines, -387 removed lines

@@ -39,391 +39,391 @@
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 
 class PreviewManager implements IPreview {
-	/** @var IConfig */
-	protected $config;
-
-	/** @var IRootFolder */
-	protected $rootFolder;
-
-	/** @var IAppData */
-	protected $appData;
-
-	/** @var EventDispatcherInterface */
-	protected $eventDispatcher;
-
-	/** @var Generator */
-	private $generator;
-
-	/** @var bool */
-	protected $providerListDirty = false;
-
-	/** @var bool */
-	protected $registeredCoreProviders = false;
-
-	/** @var array */
-	protected $providers = [];
-
-	/** @var array mime type => support status */
-	protected $mimeTypeSupportMap = [];
-
-	/** @var array */
-	protected $defaultProviders;
-
-	/** @var string */
-	protected $userId;
-
-	/**
-	 * PreviewManager constructor.
-	 *
-	 * @param IConfig $config
-	 * @param IRootFolder $rootFolder
-	 * @param IAppData $appData
-	 * @param EventDispatcherInterface $eventDispatcher
-	 * @param string $userId
-	 */
-	public function __construct(IConfig $config,
-								IRootFolder $rootFolder,
-								IAppData $appData,
-								EventDispatcherInterface $eventDispatcher,
-								$userId) {
-		$this->config = $config;
-		$this->rootFolder = $rootFolder;
-		$this->appData = $appData;
-		$this->eventDispatcher = $eventDispatcher;
-		$this->userId = $userId;
-	}
-
-	/**
-	 * In order to improve lazy loading a closure can be registered which will be
-	 * called in case preview providers are actually requested
-	 *
-	 * $callable has to return an instance of \OCP\Preview\IProvider or \OCP\Preview\IProviderV2
-	 *
-	 * @param string $mimeTypeRegex Regex with the mime types that are supported by this provider
-	 * @param \Closure $callable
-	 * @return void
-	 */
-	public function registerProvider($mimeTypeRegex, \Closure $callable) {
-		if (!$this->config->getSystemValue('enable_previews', true)) {
-			return;
-		}
-
-		if (!isset($this->providers[$mimeTypeRegex])) {
-			$this->providers[$mimeTypeRegex] = [];
-		}
-		$this->providers[$mimeTypeRegex][] = $callable;
-		$this->providerListDirty = true;
-	}
-
-	/**
-	 * Get all providers
-	 * @return array
-	 */
-	public function getProviders() {
-		if (!$this->config->getSystemValue('enable_previews', true)) {
-			return [];
-		}
-
-		$this->registerCoreProviders();
-		if ($this->providerListDirty) {
-			$keys = array_map('strlen', array_keys($this->providers));
-			array_multisort($keys, SORT_DESC, $this->providers);
-			$this->providerListDirty = false;
-		}
-
-		return $this->providers;
-	}
-
-	/**
-	 * Does the manager have any providers
-	 * @return bool
-	 */
-	public function hasProviders() {
-		$this->registerCoreProviders();
-		return !empty($this->providers);
-	}
-
-	/**
-	 * return a preview of a file
-	 *
-	 * @param string $file The path to the file where you want a thumbnail from
-	 * @param int $maxX The maximum X size of the thumbnail. It can be smaller depending on the shape of the image
-	 * @param int $maxY The maximum Y size of the thumbnail. It can be smaller depending on the shape of the image
-	 * @param boolean $scaleUp Scale smaller images up to the thumbnail size or not. Might look ugly
-	 * @return \OCP\IImage
-	 * @deprecated 11 Use getPreview
-	 */
-	public function createPreview($file, $maxX = 100, $maxY = 75, $scaleUp = false) {
-		try {
-			$userRoot = $this->rootFolder->getUserFolder($this->userId)->getParent();
-			$node = $userRoot->get($file);
-			if (!($file instanceof File)) {
-				throw new NotFoundException();
-			}
-
-			$preview = $this->getPreview($node, $maxX, $maxY);
-		} catch (\Exception $e) {
-			return new \OC_Image();
-		}
-
-		$previewImage = new \OC_Image();
-		$previewImage->loadFromData($preview->getContent());
-		return $previewImage;
-	}
-
-	/**
-	 * Returns a preview of a file
-	 *
-	 * The cache is searched first and if nothing usable was found then a preview is
-	 * generated by one of the providers
-	 *
-	 * @param File $file
-	 * @param int $width
-	 * @param int $height
-	 * @param bool $crop
-	 * @param string $mode
-	 * @param string $mimeType
-	 * @return ISimpleFile
-	 * @throws NotFoundException
-	 * @throws \InvalidArgumentException if the preview would be invalid (in case the original image is invalid)
-	 * @since 11.0.0 - \InvalidArgumentException was added in 12.0.0
-	 */
-	public function getPreview(File $file, $width = -1, $height = -1, $crop = false, $mode = IPreview::MODE_FILL, $mimeType = null) {
-		if ($this->generator === null) {
-			$this->generator = new Generator(
-				$this->config,
-				$this,
-				$this->appData,
-				new GeneratorHelper(
-					$this->rootFolder,
-					$this->config
-				),
-				$this->eventDispatcher
-			);
-		}
-
-		return $this->generator->getPreview($file, $width, $height, $crop, $mode, $mimeType);
-	}
-
-	/**
-	 * returns true if the passed mime type is supported
-	 *
-	 * @param string $mimeType
-	 * @return boolean
-	 */
-	public function isMimeSupported($mimeType = '*') {
-		if (!$this->config->getSystemValue('enable_previews', true)) {
-			return false;
-		}
-
-		if (isset($this->mimeTypeSupportMap[$mimeType])) {
-			return $this->mimeTypeSupportMap[$mimeType];
-		}
-
-		$this->registerCoreProviders();
-		$providerMimeTypes = array_keys($this->providers);
-		foreach ($providerMimeTypes as $supportedMimeType) {
-			if (preg_match($supportedMimeType, $mimeType)) {
-				$this->mimeTypeSupportMap[$mimeType] = true;
-				return true;
-			}
-		}
-		$this->mimeTypeSupportMap[$mimeType] = false;
-		return false;
-	}
-
-	/**
-	 * Check if a preview can be generated for a file
-	 *
-	 * @param \OCP\Files\FileInfo $file
-	 * @return bool
-	 */
-	public function isAvailable(\OCP\Files\FileInfo $file) {
-		if (!$this->config->getSystemValue('enable_previews', true)) {
-			return false;
-		}
-
-		$this->registerCoreProviders();
-		if (!$this->isMimeSupported($file->getMimetype())) {
-			return false;
-		}
-
-		$mount = $file->getMountPoint();
-		if ($mount and !$mount->getOption('previews', true)){
-			return false;
-		}
-
-		foreach ($this->providers as $supportedMimeType => $providers) {
-			if (preg_match($supportedMimeType, $file->getMimetype())) {
-				foreach ($providers as $closure) {
-					$provider = $closure();
-					if (!($provider instanceof IProvider)) {
-						continue;
-					}
-
-					/** @var $provider IProvider */
-					if ($provider->isAvailable($file)) {
-						return true;
-					}
-				}
-			}
-		}
-		return false;
-	}
-
-	/**
-	 * List of enabled default providers
-	 *
-	 * The following providers are enabled by default:
-	 *  - OC\Preview\PNG
-	 *  - OC\Preview\JPEG
-	 *  - OC\Preview\GIF
-	 *  - OC\Preview\BMP
-	 *  - OC\Preview\HEIC
-	 *  - OC\Preview\XBitmap
-	 *  - OC\Preview\MarkDown
-	 *  - OC\Preview\MP3
-	 *  - OC\Preview\TXT
-	 *
-	 * The following providers are disabled by default due to performance or privacy concerns:
-	 *  - OC\Preview\Font
-	 *  - OC\Preview\Illustrator
-	 *  - OC\Preview\Movie
-	 *  - OC\Preview\MSOfficeDoc
-	 *  - OC\Preview\MSOffice2003
-	 *  - OC\Preview\MSOffice2007
-	 *  - OC\Preview\OpenDocument
-	 *  - OC\Preview\PDF
-	 *  - OC\Preview\Photoshop
-	 *  - OC\Preview\Postscript
-	 *  - OC\Preview\StarOffice
-	 *  - OC\Preview\SVG
-	 *  - OC\Preview\TIFF
-	 *
-	 * @return array
-	 */
-	protected function getEnabledDefaultProvider() {
-		if ($this->defaultProviders !== null) {
-			return $this->defaultProviders;
-		}
-
-		$imageProviders = [
-			Preview\PNG::class,
-			Preview\JPEG::class,
-			Preview\GIF::class,
-			Preview\BMP::class,
-			Preview\HEIC::class,
-			Preview\XBitmap::class
-		];
-
-		$this->defaultProviders = $this->config->getSystemValue('enabledPreviewProviders', array_merge([
-			Preview\MarkDown::class,
-			Preview\MP3::class,
-			Preview\TXT::class,
-		], $imageProviders));
-
-		if (in_array(Preview\Image::class, $this->defaultProviders)) {
-			$this->defaultProviders = array_merge($this->defaultProviders, $imageProviders);
-		}
-		$this->defaultProviders = array_unique($this->defaultProviders);
-		return $this->defaultProviders;
-	}
-
-	/**
-	 * Register the default providers (if enabled)
-	 *
-	 * @param string $class
-	 * @param string $mimeType
-	 */
-	protected function registerCoreProvider($class, $mimeType, $options = []) {
-		if (in_array(trim($class, '\\'), $this->getEnabledDefaultProvider())) {
-			$this->registerProvider($mimeType, function () use ($class, $options) {
-				return new $class($options);
-			});
-		}
-	}
-
-	/**
-	 * Register the default providers (if enabled)
-	 */
-	protected function registerCoreProviders() {
-		if ($this->registeredCoreProviders) {
-			return;
-		}
-		$this->registeredCoreProviders = true;
-
-		$this->registerCoreProvider(Preview\TXT::class, '/text\/plain/');
-		$this->registerCoreProvider(Preview\MarkDown::class, '/text\/(x-)?markdown/');
-		$this->registerCoreProvider(Preview\PNG::class, '/image\/png/');
-		$this->registerCoreProvider(Preview\JPEG::class, '/image\/jpeg/');
-		$this->registerCoreProvider(Preview\GIF::class, '/image\/gif/');
-		$this->registerCoreProvider(Preview\BMP::class, '/image\/bmp/');
-		$this->registerCoreProvider(Preview\XBitmap::class, '/image\/x-xbitmap/');
-		$this->registerCoreProvider(Preview\MP3::class, '/audio\/mpeg/');
-
-		// SVG, Office and Bitmap require imagick
-		if (extension_loaded('imagick')) {
-			$checkImagick = new \Imagick();
-
-			$imagickProviders = [
-				'SVG'	=> ['mimetype' => '/image\/svg\+xml/', 'class' => Preview\SVG::class],
-				'TIFF'	=> ['mimetype' => '/image\/tiff/', 'class' => Preview\TIFF::class],
-				'PDF'	=> ['mimetype' => '/application\/pdf/', 'class' => Preview\PDF::class],
-				'AI'	=> ['mimetype' => '/application\/illustrator/', 'class' => Preview\Illustrator::class],
-				'PSD'	=> ['mimetype' => '/application\/x-photoshop/', 'class' => Preview\Photoshop::class],
-				'EPS'	=> ['mimetype' => '/application\/postscript/', 'class' => Preview\Postscript::class],
-				'TTF'	=> ['mimetype' => '/application\/(?:font-sfnt|x-font$)/', 'class' => Preview\Font::class],
-				'HEIC'  => ['mimetype' => '/image\/hei(f|c)/', 'class' => Preview\HEIC::class],
-			];
-
-			foreach ($imagickProviders as $queryFormat => $provider) {
-				$class = $provider['class'];
-				if (!in_array(trim($class, '\\'), $this->getEnabledDefaultProvider())) {
-					continue;
-				}
-
-				if (count($checkImagick->queryFormats($queryFormat)) === 1) {
-					$this->registerCoreProvider($class, $provider['mimetype']);
-				}
-			}
-
-			if (count($checkImagick->queryFormats('PDF')) === 1) {
-				if (\OC_Helper::is_function_enabled('shell_exec')) {
-					$officeFound = is_string($this->config->getSystemValue('preview_libreoffice_path', null));
-
-					if (!$officeFound) {
-						//let's see if there is libreoffice or openoffice on this machine
-						$whichLibreOffice = shell_exec('command -v libreoffice');
-						$officeFound = !empty($whichLibreOffice);
-						if (!$officeFound) {
-							$whichOpenOffice = shell_exec('command -v openoffice');
-							$officeFound = !empty($whichOpenOffice);
-						}
-					}
-
-					if ($officeFound) {
-						$this->registerCoreProvider(Preview\MSOfficeDoc::class, '/application\/msword/');
-						$this->registerCoreProvider(Preview\MSOffice2003::class, '/application\/vnd.ms-.*/');
-						$this->registerCoreProvider(Preview\MSOffice2007::class, '/application\/vnd.openxmlformats-officedocument.*/');
-						$this->registerCoreProvider(Preview\OpenDocument::class, '/application\/vnd.oasis.opendocument.*/');
-						$this->registerCoreProvider(Preview\StarOffice::class, '/application\/vnd.sun.xml.*/');
-					}
-				}
-			}
-		}
-
-		// Video requires avconv or ffmpeg
-		if (in_array(Preview\Movie::class, $this->getEnabledDefaultProvider())) {
-			$avconvBinary = \OC_Helper::findBinaryPath('avconv');
-			$ffmpegBinary = $avconvBinary ? null : \OC_Helper::findBinaryPath('ffmpeg');
-
-			if ($avconvBinary || $ffmpegBinary) {
-				// FIXME // a bit hacky but didn't want to use subclasses
-				\OC\Preview\Movie::$avconvBinary = $avconvBinary;
-				\OC\Preview\Movie::$ffmpegBinary = $ffmpegBinary;
-
-				$this->registerCoreProvider(Preview\Movie::class, '/video\/.*/');
-			}
-		}
-	}
+    /** @var IConfig */
+    protected $config;
+
+    /** @var IRootFolder */
+    protected $rootFolder;
+
+    /** @var IAppData */
+    protected $appData;
+
+    /** @var EventDispatcherInterface */
+    protected $eventDispatcher;
+
+    /** @var Generator */
+    private $generator;
+
+    /** @var bool */
+    protected $providerListDirty = false;
+
+    /** @var bool */
+    protected $registeredCoreProviders = false;
+
+    /** @var array */
+    protected $providers = [];
+
+    /** @var array mime type => support status */
+    protected $mimeTypeSupportMap = [];
+
+    /** @var array */
+    protected $defaultProviders;
+
+    /** @var string */
+    protected $userId;
+
+    /**
+     * PreviewManager constructor.
+     *
+     * @param IConfig $config
+     * @param IRootFolder $rootFolder
+     * @param IAppData $appData
+     * @param EventDispatcherInterface $eventDispatcher
+     * @param string $userId
+     */
+    public function __construct(IConfig $config,
+                                IRootFolder $rootFolder,
+                                IAppData $appData,
+                                EventDispatcherInterface $eventDispatcher,
+                                $userId) {
+        $this->config = $config;
+        $this->rootFolder = $rootFolder;
+        $this->appData = $appData;
+        $this->eventDispatcher = $eventDispatcher;
+        $this->userId = $userId;
+    }
+
+    /**
+     * In order to improve lazy loading a closure can be registered which will be
+     * called in case preview providers are actually requested
+     *
+     * $callable has to return an instance of \OCP\Preview\IProvider or \OCP\Preview\IProviderV2
+     *
+     * @param string $mimeTypeRegex Regex with the mime types that are supported by this provider
+     * @param \Closure $callable
+     * @return void
+     */
+    public function registerProvider($mimeTypeRegex, \Closure $callable) {
+        if (!$this->config->getSystemValue('enable_previews', true)) {
+            return;
+        }
+
+        if (!isset($this->providers[$mimeTypeRegex])) {
+            $this->providers[$mimeTypeRegex] = [];
+        }
+        $this->providers[$mimeTypeRegex][] = $callable;
+        $this->providerListDirty = true;
+    }
+
+    /**
+     * Get all providers
+     * @return array
+     */
+    public function getProviders() {
+        if (!$this->config->getSystemValue('enable_previews', true)) {
+            return [];
+        }
+
+        $this->registerCoreProviders();
+        if ($this->providerListDirty) {
+            $keys = array_map('strlen', array_keys($this->providers));
+            array_multisort($keys, SORT_DESC, $this->providers);
+            $this->providerListDirty = false;
+        }
+
+        return $this->providers;
+    }
+
+    /**
+     * Does the manager have any providers
+     * @return bool
+     */
+    public function hasProviders() {
+        $this->registerCoreProviders();
+        return !empty($this->providers);
+    }
+
+    /**
+     * return a preview of a file
+     *
+     * @param string $file The path to the file where you want a thumbnail from
+     * @param int $maxX The maximum X size of the thumbnail. It can be smaller depending on the shape of the image
+     * @param int $maxY The maximum Y size of the thumbnail. It can be smaller depending on the shape of the image
+     * @param boolean $scaleUp Scale smaller images up to the thumbnail size or not. Might look ugly
+     * @return \OCP\IImage
+     * @deprecated 11 Use getPreview
+     */
+    public function createPreview($file, $maxX = 100, $maxY = 75, $scaleUp = false) {
+        try {
+            $userRoot = $this->rootFolder->getUserFolder($this->userId)->getParent();
+            $node = $userRoot->get($file);
+            if (!($file instanceof File)) {
+                throw new NotFoundException();
+            }
+
+            $preview = $this->getPreview($node, $maxX, $maxY);
+        } catch (\Exception $e) {
+            return new \OC_Image();
+        }
+
+        $previewImage = new \OC_Image();
+        $previewImage->loadFromData($preview->getContent());
+        return $previewImage;
+    }
+
+    /**
+     * Returns a preview of a file
+     *
+     * The cache is searched first and if nothing usable was found then a preview is
+     * generated by one of the providers
+     *
+     * @param File $file
+     * @param int $width
+     * @param int $height
+     * @param bool $crop
+     * @param string $mode
+     * @param string $mimeType
+     * @return ISimpleFile
+     * @throws NotFoundException
+     * @throws \InvalidArgumentException if the preview would be invalid (in case the original image is invalid)
+     * @since 11.0.0 - \InvalidArgumentException was added in 12.0.0
+     */
+    public function getPreview(File $file, $width = -1, $height = -1, $crop = false, $mode = IPreview::MODE_FILL, $mimeType = null) {
+        if ($this->generator === null) {
+            $this->generator = new Generator(
+                $this->config,
+                $this,
+                $this->appData,
+                new GeneratorHelper(
+                    $this->rootFolder,
+                    $this->config
+                ),
+                $this->eventDispatcher
+            );
+        }
+
+        return $this->generator->getPreview($file, $width, $height, $crop, $mode, $mimeType);
+    }
+
+    /**
+     * returns true if the passed mime type is supported
+     *
+     * @param string $mimeType
+     * @return boolean
+     */
+    public function isMimeSupported($mimeType = '*') {
+        if (!$this->config->getSystemValue('enable_previews', true)) {
+            return false;
+        }
+
+        if (isset($this->mimeTypeSupportMap[$mimeType])) {
+            return $this->mimeTypeSupportMap[$mimeType];
+        }
+
+        $this->registerCoreProviders();
+        $providerMimeTypes = array_keys($this->providers);
+        foreach ($providerMimeTypes as $supportedMimeType) {
+            if (preg_match($supportedMimeType, $mimeType)) {
+                $this->mimeTypeSupportMap[$mimeType] = true;
+                return true;
+            }
+        }
+        $this->mimeTypeSupportMap[$mimeType] = false;
+        return false;
+    }
+
+    /**
+     * Check if a preview can be generated for a file
+     *
+     * @param \OCP\Files\FileInfo $file
+     * @return bool
+     */
+    public function isAvailable(\OCP\Files\FileInfo $file) {
+        if (!$this->config->getSystemValue('enable_previews', true)) {
+            return false;
+        }
+
+        $this->registerCoreProviders();
+        if (!$this->isMimeSupported($file->getMimetype())) {
+            return false;
+        }
+
+        $mount = $file->getMountPoint();
+        if ($mount and !$mount->getOption('previews', true)){
+            return false;
+        }
+
+        foreach ($this->providers as $supportedMimeType => $providers) {
+            if (preg_match($supportedMimeType, $file->getMimetype())) {
+                foreach ($providers as $closure) {
+                    $provider = $closure();
+                    if (!($provider instanceof IProvider)) {
+                        continue;
+                    }
+
+                    /** @var $provider IProvider */
+                    if ($provider->isAvailable($file)) {
+                        return true;
+                    }
+                }
+            }
+        }
+        return false;
+    }
+
+    /**
+     * List of enabled default providers
+     *
+     * The following providers are enabled by default:
+     *  - OC\Preview\PNG
+     *  - OC\Preview\JPEG
+     *  - OC\Preview\GIF
+     *  - OC\Preview\BMP
+     *  - OC\Preview\HEIC
+     *  - OC\Preview\XBitmap
+     *  - OC\Preview\MarkDown
+     *  - OC\Preview\MP3
+     *  - OC\Preview\TXT
+     *
+     * The following providers are disabled by default due to performance or privacy concerns:
+     *  - OC\Preview\Font
+     *  - OC\Preview\Illustrator
+     *  - OC\Preview\Movie
+     *  - OC\Preview\MSOfficeDoc
+     *  - OC\Preview\MSOffice2003
+     *  - OC\Preview\MSOffice2007
+     *  - OC\Preview\OpenDocument
+     *  - OC\Preview\PDF
+     *  - OC\Preview\Photoshop
+     *  - OC\Preview\Postscript
+     *  - OC\Preview\StarOffice
+     *  - OC\Preview\SVG
+     *  - OC\Preview\TIFF
+     *
+     * @return array
+     */
+    protected function getEnabledDefaultProvider() {
+        if ($this->defaultProviders !== null) {
+            return $this->defaultProviders;
+        }
+
+        $imageProviders = [
+            Preview\PNG::class,
+            Preview\JPEG::class,
+            Preview\GIF::class,
+            Preview\BMP::class,
+            Preview\HEIC::class,
+            Preview\XBitmap::class
+        ];
+
+        $this->defaultProviders = $this->config->getSystemValue('enabledPreviewProviders', array_merge([
+            Preview\MarkDown::class,
+            Preview\MP3::class,
+            Preview\TXT::class,
+        ], $imageProviders));
+
+        if (in_array(Preview\Image::class, $this->defaultProviders)) {
+            $this->defaultProviders = array_merge($this->defaultProviders, $imageProviders);
+        }
+        $this->defaultProviders = array_unique($this->defaultProviders);
+        return $this->defaultProviders;
+    }
+
+    /**
+     * Register the default providers (if enabled)
+     *
+     * @param string $class
+     * @param string $mimeType
+     */
+    protected function registerCoreProvider($class, $mimeType, $options = []) {
+        if (in_array(trim($class, '\\'), $this->getEnabledDefaultProvider())) {
+            $this->registerProvider($mimeType, function () use ($class, $options) {
+                return new $class($options);
+            });
+        }
+    }
+
+    /**
+     * Register the default providers (if enabled)
+     */
+    protected function registerCoreProviders() {
+        if ($this->registeredCoreProviders) {
+            return;
+        }
+        $this->registeredCoreProviders = true;
+
+        $this->registerCoreProvider(Preview\TXT::class, '/text\/plain/');
+        $this->registerCoreProvider(Preview\MarkDown::class, '/text\/(x-)?markdown/');
+        $this->registerCoreProvider(Preview\PNG::class, '/image\/png/');
+        $this->registerCoreProvider(Preview\JPEG::class, '/image\/jpeg/');
+        $this->registerCoreProvider(Preview\GIF::class, '/image\/gif/');
+        $this->registerCoreProvider(Preview\BMP::class, '/image\/bmp/');
+        $this->registerCoreProvider(Preview\XBitmap::class, '/image\/x-xbitmap/');
+        $this->registerCoreProvider(Preview\MP3::class, '/audio\/mpeg/');
+
+        // SVG, Office and Bitmap require imagick
+        if (extension_loaded('imagick')) {
+            $checkImagick = new \Imagick();
+
+            $imagickProviders = [
+                'SVG'	=> ['mimetype' => '/image\/svg\+xml/', 'class' => Preview\SVG::class],
+                'TIFF'	=> ['mimetype' => '/image\/tiff/', 'class' => Preview\TIFF::class],
+                'PDF'	=> ['mimetype' => '/application\/pdf/', 'class' => Preview\PDF::class],
+                'AI'	=> ['mimetype' => '/application\/illustrator/', 'class' => Preview\Illustrator::class],
+                'PSD'	=> ['mimetype' => '/application\/x-photoshop/', 'class' => Preview\Photoshop::class],
+                'EPS'	=> ['mimetype' => '/application\/postscript/', 'class' => Preview\Postscript::class],
+                'TTF'	=> ['mimetype' => '/application\/(?:font-sfnt|x-font$)/', 'class' => Preview\Font::class],
+                'HEIC'  => ['mimetype' => '/image\/hei(f|c)/', 'class' => Preview\HEIC::class],
+            ];
+
+            foreach ($imagickProviders as $queryFormat => $provider) {
+                $class = $provider['class'];
+                if (!in_array(trim($class, '\\'), $this->getEnabledDefaultProvider())) {
+                    continue;
+                }
+
+                if (count($checkImagick->queryFormats($queryFormat)) === 1) {
+                    $this->registerCoreProvider($class, $provider['mimetype']);
+                }
+            }
+
+            if (count($checkImagick->queryFormats('PDF')) === 1) {
+                if (\OC_Helper::is_function_enabled('shell_exec')) {
+                    $officeFound = is_string($this->config->getSystemValue('preview_libreoffice_path', null));
+
+                    if (!$officeFound) {
+                        //let's see if there is libreoffice or openoffice on this machine
+                        $whichLibreOffice = shell_exec('command -v libreoffice');
+                        $officeFound = !empty($whichLibreOffice);
+                        if (!$officeFound) {
+                            $whichOpenOffice = shell_exec('command -v openoffice');
+                            $officeFound = !empty($whichOpenOffice);
+                        }
+                    }
+
+                    if ($officeFound) {
+                        $this->registerCoreProvider(Preview\MSOfficeDoc::class, '/application\/msword/');
+                        $this->registerCoreProvider(Preview\MSOffice2003::class, '/application\/vnd.ms-.*/');
+                        $this->registerCoreProvider(Preview\MSOffice2007::class, '/application\/vnd.openxmlformats-officedocument.*/');
+                        $this->registerCoreProvider(Preview\OpenDocument::class, '/application\/vnd.oasis.opendocument.*/');
+                        $this->registerCoreProvider(Preview\StarOffice::class, '/application\/vnd.sun.xml.*/');
+                    }
+                }
+            }
+        }
+
+        // Video requires avconv or ffmpeg
+        if (in_array(Preview\Movie::class, $this->getEnabledDefaultProvider())) {
+            $avconvBinary = \OC_Helper::findBinaryPath('avconv');
+            $ffmpegBinary = $avconvBinary ? null : \OC_Helper::findBinaryPath('ffmpeg');
+
+            if ($avconvBinary || $ffmpegBinary) {
+                // FIXME // a bit hacky but didn't want to use subclasses
+                \OC\Preview\Movie::$avconvBinary = $avconvBinary;
+                \OC\Preview\Movie::$ffmpegBinary = $ffmpegBinary;
+
+                $this->registerCoreProvider(Preview\Movie::class, '/video\/.*/');
+            }
+        }
+    }
 }

lib/private/Encryption/Update.php

Spacing +7 added lines, -7 removed lines

@@ -87,7 +87,7 @@ 
 			if ($params['itemType'] === 'file' || $params['itemType'] === 'folder') {
 				$path = Filesystem::getPath($params['fileSource']);
 				list($owner, $ownerPath) = $this->getOwnerPath($path);
-				$absPath = '/' . $owner . '/files/' . $ownerPath;
+				$absPath = '/'.$owner.'/files/'.$ownerPath;
 				$this->update($absPath);
 			}
 		}
@@ -103,7 +103,7 @@ 
 			if ($params['itemType'] === 'file' || $params['itemType'] === 'folder') {
 				$path = Filesystem::getPath($params['fileSource']);
 				list($owner, $ownerPath) = $this->getOwnerPath($path);
-				$absPath = '/' . $owner . '/files/' . $ownerPath;
+				$absPath = '/'.$owner.'/files/'.$ownerPath;
 				$this->update($absPath);
 			}
 		}
@@ -117,7 +117,7 @@ 
 	 */
 	public function postRestore($params) {
 		if ($this->encryptionManager->isEnabled()) {
-			$path = Filesystem::normalizePath('/' . $this->uid . '/files/' . $params['filePath']);
+			$path = Filesystem::normalizePath('/'.$this->uid.'/files/'.$params['filePath']);
 			$this->update($path);
 		}
 	}
@@ -131,12 +131,12 @@ 
 	public function postRename($params) {
 		$source = $params['oldpath'];
 		$target = $params['newpath'];
-		if(
+		if (
 			$this->encryptionManager->isEnabled() &&
 			dirname($source) !== dirname($target)
 		) {
 				list($owner, $ownerPath) = $this->getOwnerPath($target);
-				$absPath = '/' . $owner . '/files/' . $ownerPath;
+				$absPath = '/'.$owner.'/files/'.$ownerPath;
 				$this->update($absPath);
 		}
 	}
@@ -151,10 +151,10 @@ 
 	protected function getOwnerPath($path) {
 		$info = Filesystem::getFileInfo($path);
 		$owner = Filesystem::getOwner($path);
-		$view = new View('/' . $owner . '/files');
+		$view = new View('/'.$owner.'/files');
 		$path = $view->getPath($info->getId());
 		if ($path === null) {
-			throw new \InvalidArgumentException('No file found for ' . $info->getId());
+			throw new \InvalidArgumentException('No file found for '.$info->getId());
 		}
 
 		return array($owner, $path);

Indentation +157 added lines, -157 removed lines

@@ -33,162 +33,162 @@
  */
 class Update {
 
-	/** @var \OC\Files\View */
-	protected $view;
-
-	/** @var \OC\Encryption\Util */
-	protected $util;
-
-	 /** @var \OC\Files\Mount\Manager */
-	protected $mountManager;
-
-	/** @var \OC\Encryption\Manager */
-	protected $encryptionManager;
-
-	/** @var string */
-	protected $uid;
-
-	/** @var \OC\Encryption\File */
-	protected $file;
-
-	/**
-	 *
-	 * @param \OC\Files\View $view
-	 * @param \OC\Encryption\Util $util
-	 * @param \OC\Files\Mount\Manager $mountManager
-	 * @param \OC\Encryption\Manager $encryptionManager
-	 * @param \OC\Encryption\File $file
-	 * @param string $uid
-	 */
-	public function __construct(
-			View $view,
-			Util $util,
-			Mount\Manager $mountManager,
-			Manager $encryptionManager,
-			File $file,
-			$uid
-		) {
-
-		$this->view = $view;
-		$this->util = $util;
-		$this->mountManager = $mountManager;
-		$this->encryptionManager = $encryptionManager;
-		$this->file = $file;
-		$this->uid = $uid;
-	}
-
-	/**
-	 * hook after file was shared
-	 *
-	 * @param array $params
-	 */
-	public function postShared($params) {
-		if ($this->encryptionManager->isEnabled()) {
-			if ($params['itemType'] === 'file' || $params['itemType'] === 'folder') {
-				$path = Filesystem::getPath($params['fileSource']);
-				list($owner, $ownerPath) = $this->getOwnerPath($path);
-				$absPath = '/' . $owner . '/files/' . $ownerPath;
-				$this->update($absPath);
-			}
-		}
-	}
-
-	/**
-	 * hook after file was unshared
-	 *
-	 * @param array $params
-	 */
-	public function postUnshared($params) {
-		if ($this->encryptionManager->isEnabled()) {
-			if ($params['itemType'] === 'file' || $params['itemType'] === 'folder') {
-				$path = Filesystem::getPath($params['fileSource']);
-				list($owner, $ownerPath) = $this->getOwnerPath($path);
-				$absPath = '/' . $owner . '/files/' . $ownerPath;
-				$this->update($absPath);
-			}
-		}
-	}
-
-	/**
-	 * inform encryption module that a file was restored from the trash bin,
-	 * e.g. to update the encryption keys
-	 *
-	 * @param array $params
-	 */
-	public function postRestore($params) {
-		if ($this->encryptionManager->isEnabled()) {
-			$path = Filesystem::normalizePath('/' . $this->uid . '/files/' . $params['filePath']);
-			$this->update($path);
-		}
-	}
-
-	/**
-	 * inform encryption module that a file was renamed,
-	 * e.g. to update the encryption keys
-	 *
-	 * @param array $params
-	 */
-	public function postRename($params) {
-		$source = $params['oldpath'];
-		$target = $params['newpath'];
-		if(
-			$this->encryptionManager->isEnabled() &&
-			dirname($source) !== dirname($target)
-		) {
-				list($owner, $ownerPath) = $this->getOwnerPath($target);
-				$absPath = '/' . $owner . '/files/' . $ownerPath;
-				$this->update($absPath);
-		}
-	}
-
-	/**
-	 * get owner and path relative to data/<owner>/files
-	 *
-	 * @param string $path path to file for current user
-	 * @return array ['owner' => $owner, 'path' => $path]
-	 * @throw \InvalidArgumentException
-	 */
-	protected function getOwnerPath($path) {
-		$info = Filesystem::getFileInfo($path);
-		$owner = Filesystem::getOwner($path);
-		$view = new View('/' . $owner . '/files');
-		$path = $view->getPath($info->getId());
-		if ($path === null) {
-			throw new \InvalidArgumentException('No file found for ' . $info->getId());
-		}
-
-		return array($owner, $path);
-	}
-
-	/**
-	 * notify encryption module about added/removed users from a file/folder
-	 *
-	 * @param string $path relative to data/
-	 * @throws Exceptions\ModuleDoesNotExistsException
-	 */
-	public function update($path) {
-
-		$encryptionModule = $this->encryptionManager->getEncryptionModule();
-
-		// if the encryption module doesn't encrypt the files on a per-user basis
-		// we have nothing to do here.
-		if ($encryptionModule->needDetailedAccessList() === false) {
-			return;
-		}
-
-		// if a folder was shared, get a list of all (sub-)folders
-		if ($this->view->is_dir($path)) {
-			$allFiles = $this->util->getAllFiles($path);
-		} else {
-			$allFiles = array($path);
-		}
-
-
-
-		foreach ($allFiles as $file) {
-			$usersSharing = $this->file->getAccessList($file);
-			$encryptionModule->update($file, $this->uid, $usersSharing);
-		}
-	}
+    /** @var \OC\Files\View */
+    protected $view;
+
+    /** @var \OC\Encryption\Util */
+    protected $util;
+
+        /** @var \OC\Files\Mount\Manager */
+    protected $mountManager;
+
+    /** @var \OC\Encryption\Manager */
+    protected $encryptionManager;
+
+    /** @var string */
+    protected $uid;
+
+    /** @var \OC\Encryption\File */
+    protected $file;
+
+    /**
+     *
+     * @param \OC\Files\View $view
+     * @param \OC\Encryption\Util $util
+     * @param \OC\Files\Mount\Manager $mountManager
+     * @param \OC\Encryption\Manager $encryptionManager
+     * @param \OC\Encryption\File $file
+     * @param string $uid
+     */
+    public function __construct(
+            View $view,
+            Util $util,
+            Mount\Manager $mountManager,
+            Manager $encryptionManager,
+            File $file,
+            $uid
+        ) {
+
+        $this->view = $view;
+        $this->util = $util;
+        $this->mountManager = $mountManager;
+        $this->encryptionManager = $encryptionManager;
+        $this->file = $file;
+        $this->uid = $uid;
+    }
+
+    /**
+     * hook after file was shared
+     *
+     * @param array $params
+     */
+    public function postShared($params) {
+        if ($this->encryptionManager->isEnabled()) {
+            if ($params['itemType'] === 'file' || $params['itemType'] === 'folder') {
+                $path = Filesystem::getPath($params['fileSource']);
+                list($owner, $ownerPath) = $this->getOwnerPath($path);
+                $absPath = '/' . $owner . '/files/' . $ownerPath;
+                $this->update($absPath);
+            }
+        }
+    }
+
+    /**
+     * hook after file was unshared
+     *
+     * @param array $params
+     */
+    public function postUnshared($params) {
+        if ($this->encryptionManager->isEnabled()) {
+            if ($params['itemType'] === 'file' || $params['itemType'] === 'folder') {
+                $path = Filesystem::getPath($params['fileSource']);
+                list($owner, $ownerPath) = $this->getOwnerPath($path);
+                $absPath = '/' . $owner . '/files/' . $ownerPath;
+                $this->update($absPath);
+            }
+        }
+    }
+
+    /**
+     * inform encryption module that a file was restored from the trash bin,
+     * e.g. to update the encryption keys
+     *
+     * @param array $params
+     */
+    public function postRestore($params) {
+        if ($this->encryptionManager->isEnabled()) {
+            $path = Filesystem::normalizePath('/' . $this->uid . '/files/' . $params['filePath']);
+            $this->update($path);
+        }
+    }
+
+    /**
+     * inform encryption module that a file was renamed,
+     * e.g. to update the encryption keys
+     *
+     * @param array $params
+     */
+    public function postRename($params) {
+        $source = $params['oldpath'];
+        $target = $params['newpath'];
+        if(
+            $this->encryptionManager->isEnabled() &&
+            dirname($source) !== dirname($target)
+        ) {
+                list($owner, $ownerPath) = $this->getOwnerPath($target);
+                $absPath = '/' . $owner . '/files/' . $ownerPath;
+                $this->update($absPath);
+        }
+    }
+
+    /**
+     * get owner and path relative to data/<owner>/files
+     *
+     * @param string $path path to file for current user
+     * @return array ['owner' => $owner, 'path' => $path]
+     * @throw \InvalidArgumentException
+     */
+    protected function getOwnerPath($path) {
+        $info = Filesystem::getFileInfo($path);
+        $owner = Filesystem::getOwner($path);
+        $view = new View('/' . $owner . '/files');
+        $path = $view->getPath($info->getId());
+        if ($path === null) {
+            throw new \InvalidArgumentException('No file found for ' . $info->getId());
+        }
+
+        return array($owner, $path);
+    }
+
+    /**
+     * notify encryption module about added/removed users from a file/folder
+     *
+     * @param string $path relative to data/
+     * @throws Exceptions\ModuleDoesNotExistsException
+     */
+    public function update($path) {
+
+        $encryptionModule = $this->encryptionManager->getEncryptionModule();
+
+        // if the encryption module doesn't encrypt the files on a per-user basis
+        // we have nothing to do here.
+        if ($encryptionModule->needDetailedAccessList() === false) {
+            return;
+        }
+
+        // if a folder was shared, get a list of all (sub-)folders
+        if ($this->view->is_dir($path)) {
+            $allFiles = $this->util->getAllFiles($path);
+        } else {
+            $allFiles = array($path);
+        }
+
+
+
+        foreach ($allFiles as $file) {
+            $usersSharing = $this->file->getAccessList($file);
+            $encryptionModule->update($file, $this->uid, $usersSharing);
+        }
+    }
 
 }

lib/private/Encryption/Exceptions/ModuleAlreadyExistsException.php

Indentation +7 added lines, -7 removed lines

@@ -27,12 +27,12 @@
 
 class ModuleAlreadyExistsException extends GenericEncryptionException {
 
-	/**
-	 * @param string $id
-	 * @param string $name
-	 */
-	public function __construct($id, $name) {
-		parent::__construct('Id "' . $id . '" already used by encryption module "' . $name . '"');
-	}
+    /**
+     * @param string $id
+     * @param string $name
+     */
+    public function __construct($id, $name) {
+        parent::__construct('Id "' . $id . '" already used by encryption module "' . $name . '"');
+    }
 
 }

Spacing +1 added lines, -1 removed lines

@@ -32,7 +32,7 @@
 	 * @param string $name
 	 */
 	public function __construct($id, $name) {
-		parent::__construct('Id "' . $id . '" already used by encryption module "' . $name . '"');
+		parent::__construct('Id "'.$id.'" already used by encryption module "'.$name.'"');
 	}
 
 }

lib/private/Encryption/Exceptions/EncryptionHeaderToLargeException.php

Indentation +3 added lines, -3 removed lines

@@ -28,8 +28,8 @@
 
 class EncryptionHeaderToLargeException extends GenericEncryptionException {
 
-	public function __construct() {
-		parent::__construct('max header size exceeded');
-	}
+    public function __construct() {
+        parent::__construct('max header size exceeded');
+    }
 
 }

lib/private/Encryption/Exceptions/EncryptionHeaderKeyExistsException.php

Indentation +6 added lines, -6 removed lines

@@ -27,10 +27,10 @@
 
 class EncryptionHeaderKeyExistsException extends GenericEncryptionException {
 
-	/**
-	 * @param string $key
-	 */
-	public function __construct($key) {
-		parent::__construct('header key "'. $key . '" already reserved by ownCloud');
-	}
+    /**
+     * @param string $key
+     */
+    public function __construct($key) {
+        parent::__construct('header key "'. $key . '" already reserved by ownCloud');
+    }
 }

Spacing +1 added lines, -1 removed lines

@@ -31,6 +31,6 @@
 	 * @param string $key
 	 */
 	public function __construct($key) {
-		parent::__construct('header key "'. $key . '" already reserved by ownCloud');
+		parent::__construct('header key "'.$key.'" already reserved by ownCloud');
 	}
 }

lib/private/Encryption/Exceptions/EncryptionFailedException.php

Spacing +1 added lines, -1 removed lines

@@ -26,6 +26,6 @@
 
 use OCP\Encryption\Exceptions\GenericEncryptionException;
 
-class EncryptionFailedException extends GenericEncryptionException{
+class EncryptionFailedException extends GenericEncryptionException {
 
 }

lib/private/Encryption/Exceptions/EmptyEncryptionDataException.php

Spacing +1 added lines, -1 removed lines

@@ -26,6 +26,6 @@
 
 use OCP\Encryption\Exceptions\GenericEncryptionException;
 
-class EmptyEncryptionDataException extends GenericEncryptionException{
+class EmptyEncryptionDataException extends GenericEncryptionException {
 
 }

lib/private/Encryption/File.php

Spacing +1 added lines, -1 removed lines

@@ -58,7 +58,7 @@
 		// always add owner to the list of users with access to the file
 		$userIds = array($owner);
 
-		if (!$this->util->isFile($owner . '/' . $ownerPath)) {
+		if (!$this->util->isFile($owner.'/'.$ownerPath)) {
 			return array('users' => $userIds, 'public' => false);
 		}
 

Indentation +90 added lines, -90 removed lines

@@ -31,95 +31,95 @@
 
 class File implements \OCP\Encryption\IFile {
 
-	/** @var Util */
-	protected $util;
-
-	/** @var IRootFolder */
-	private $rootFolder;
-
-	/** @var IManager */
-	private $shareManager;
-
-	/**
-	 * cache results of already checked folders
-	 *
-	 * @var array
-	 */
-	protected $cache;
-
-	public function __construct(Util $util,
-								IRootFolder $rootFolder,
-								IManager $shareManager) {
-		$this->util = $util;
-		$this->cache = new CappedMemoryCache();
-		$this->rootFolder = $rootFolder;
-		$this->shareManager = $shareManager;
-	}
-
-
-	/**
-	 * get list of users with access to the file
-	 *
-	 * @param string $path to the file
-	 * @return array  ['users' => $uniqueUserIds, 'public' => $public]
-	 */
-	public function getAccessList($path) {
-
-		// Make sure that a share key is generated for the owner too
-		list($owner, $ownerPath) = $this->util->getUidAndFilename($path);
-
-		// always add owner to the list of users with access to the file
-		$userIds = array($owner);
-
-		if (!$this->util->isFile($owner . '/' . $ownerPath)) {
-			return array('users' => $userIds, 'public' => false);
-		}
-
-		$ownerPath = substr($ownerPath, strlen('/files'));
-		$userFolder = $this->rootFolder->getUserFolder($owner);
-		try {
-			$file = $userFolder->get($ownerPath);
-		} catch (NotFoundException $e) {
-			$file = null;
-		}
-		$ownerPath = $this->util->stripPartialFileExtension($ownerPath);
-
-		// first get the shares for the parent and cache the result so that we don't
-		// need to check all parents for every file
-		$parent = dirname($ownerPath);
-		$parentNode = $userFolder->get($parent);
-		if (isset($this->cache[$parent])) {
-			$resultForParents = $this->cache[$parent];
-		} else {
-			$resultForParents = $this->shareManager->getAccessList($parentNode);
-			$this->cache[$parent] = $resultForParents;
-		}
-		$userIds = array_merge($userIds, $resultForParents['users']);
-		$public = $resultForParents['public'] || $resultForParents['remote'];
-
-
-		// Find out who, if anyone, is sharing the file
-		if ($file !== null) {
-			$resultForFile = $this->shareManager->getAccessList($file, false);
-			$userIds = array_merge($userIds, $resultForFile['users']);
-			$public = $resultForFile['public'] || $resultForFile['remote'] || $public;
-		}
-
-		// check if it is a group mount
-		if (\OCP\App::isEnabled("files_external")) {
-			$mounts = \OC_Mount_Config::getSystemMountPoints();
-			foreach ($mounts as $mount) {
-				if ($mount['mountpoint'] == substr($ownerPath, 1, strlen($mount['mountpoint']))) {
-					$mountedFor = $this->util->getUserWithAccessToMountPoint($mount['applicable']['users'], $mount['applicable']['groups']);
-					$userIds = array_merge($userIds, $mountedFor);
-				}
-			}
-		}
-
-		// Remove duplicate UIDs
-		$uniqueUserIds = array_unique($userIds);
-
-		return array('users' => $uniqueUserIds, 'public' => $public);
-	}
+    /** @var Util */
+    protected $util;
+
+    /** @var IRootFolder */
+    private $rootFolder;
+
+    /** @var IManager */
+    private $shareManager;
+
+    /**
+     * cache results of already checked folders
+     *
+     * @var array
+     */
+    protected $cache;
+
+    public function __construct(Util $util,
+                                IRootFolder $rootFolder,
+                                IManager $shareManager) {
+        $this->util = $util;
+        $this->cache = new CappedMemoryCache();
+        $this->rootFolder = $rootFolder;
+        $this->shareManager = $shareManager;
+    }
+
+
+    /**
+     * get list of users with access to the file
+     *
+     * @param string $path to the file
+     * @return array  ['users' => $uniqueUserIds, 'public' => $public]
+     */
+    public function getAccessList($path) {
+
+        // Make sure that a share key is generated for the owner too
+        list($owner, $ownerPath) = $this->util->getUidAndFilename($path);
+
+        // always add owner to the list of users with access to the file
+        $userIds = array($owner);
+
+        if (!$this->util->isFile($owner . '/' . $ownerPath)) {
+            return array('users' => $userIds, 'public' => false);
+        }
+
+        $ownerPath = substr($ownerPath, strlen('/files'));
+        $userFolder = $this->rootFolder->getUserFolder($owner);
+        try {
+            $file = $userFolder->get($ownerPath);
+        } catch (NotFoundException $e) {
+            $file = null;
+        }
+        $ownerPath = $this->util->stripPartialFileExtension($ownerPath);
+
+        // first get the shares for the parent and cache the result so that we don't
+        // need to check all parents for every file
+        $parent = dirname($ownerPath);
+        $parentNode = $userFolder->get($parent);
+        if (isset($this->cache[$parent])) {
+            $resultForParents = $this->cache[$parent];
+        } else {
+            $resultForParents = $this->shareManager->getAccessList($parentNode);
+            $this->cache[$parent] = $resultForParents;
+        }
+        $userIds = array_merge($userIds, $resultForParents['users']);
+        $public = $resultForParents['public'] || $resultForParents['remote'];
+
+
+        // Find out who, if anyone, is sharing the file
+        if ($file !== null) {
+            $resultForFile = $this->shareManager->getAccessList($file, false);
+            $userIds = array_merge($userIds, $resultForFile['users']);
+            $public = $resultForFile['public'] || $resultForFile['remote'] || $public;
+        }
+
+        // check if it is a group mount
+        if (\OCP\App::isEnabled("files_external")) {
+            $mounts = \OC_Mount_Config::getSystemMountPoints();
+            foreach ($mounts as $mount) {
+                if ($mount['mountpoint'] == substr($ownerPath, 1, strlen($mount['mountpoint']))) {
+                    $mountedFor = $this->util->getUserWithAccessToMountPoint($mount['applicable']['users'], $mount['applicable']['groups']);
+                    $userIds = array_merge($userIds, $mountedFor);
+                }
+            }
+        }
+
+        // Remove duplicate UIDs
+        $uniqueUserIds = array_unique($userIds);
+
+        return array('users' => $uniqueUserIds, 'public' => $public);
+    }
 
 }

lib/private/Encryption/Keys/Storage.php

Spacing +19 added lines, -19 removed lines

@@ -66,8 +66,8 @@ 
 		$this->util = $util;
 
 		$this->encryption_base_dir = '/files_encryption';
-		$this->keys_base_dir = $this->encryption_base_dir .'/keys';
-		$this->backup_base_dir = $this->encryption_base_dir .'/backup';
+		$this->keys_base_dir = $this->encryption_base_dir.'/keys';
+		$this->backup_base_dir = $this->encryption_base_dir.'/backup';
 		$this->root_dir = $this->util->getKeyStorageRoot();
 	}
 
@@ -85,14 +85,14 @@ 
 	public function getFileKey($path, $keyId, $encryptionModuleId) {
 		$realFile = $this->util->stripPartialFileExtension($path);
 		$keyDir = $this->getFileKeyDir($encryptionModuleId, $realFile);
-		$key = $this->getKey($keyDir . $keyId);
+		$key = $this->getKey($keyDir.$keyId);
 
 		if ($key === '' && $realFile !== $path) {
 			// Check if the part file has keys and use them, if no normal keys
 			// exist. This is required to fix copyBetweenStorage() when we
 			// rename a .part file over storage borders.
 			$keyDir = $this->getFileKeyDir($encryptionModuleId, $path);
-			$key = $this->getKey($keyDir . $keyId);
+			$key = $this->getKey($keyDir.$keyId);
 		}
 
 		return $key;
@@ -119,7 +119,7 @@ 
 	 */
 	public function setFileKey($path, $keyId, $key, $encryptionModuleId) {
 		$keyDir = $this->getFileKeyDir($encryptionModuleId, $path);
-		return $this->setKey($keyDir . $keyId, $key);
+		return $this->setKey($keyDir.$keyId, $key);
 	}
 
 	/**
@@ -143,7 +143,7 @@ 
 	 */
 	public function deleteFileKey($path, $keyId, $encryptionModuleId) {
 		$keyDir = $this->getFileKeyDir($encryptionModuleId, $path);
-		return !$this->view->file_exists($keyDir . $keyId) || $this->view->unlink($keyDir . $keyId);
+		return !$this->view->file_exists($keyDir.$keyId) || $this->view->unlink($keyDir.$keyId);
 	}
 
 	/**
@@ -173,10 +173,10 @@ 
 	protected function constructUserKeyPath($encryptionModuleId, $keyId, $uid) {
 
 		if ($uid === null) {
-			$path = $this->root_dir . '/' . $this->encryption_base_dir . '/' . $encryptionModuleId . '/' . $keyId;
+			$path = $this->root_dir.'/'.$this->encryption_base_dir.'/'.$encryptionModuleId.'/'.$keyId;
 		} else {
-			$path = $this->root_dir . '/' . $uid . $this->encryption_base_dir . '/'
-				. $encryptionModuleId . '/' . $uid . '.' . $keyId;
+			$path = $this->root_dir.'/'.$uid.$this->encryption_base_dir.'/'
+				. $encryptionModuleId.'/'.$uid.'.'.$keyId;
 		}
 
 		return \OC\Files\Filesystem::normalizePath($path);
@@ -194,7 +194,7 @@ 
 
 		if ($this->view->file_exists($path)) {
 			if (isset($this->keyCache[$path])) {
-				$key =  $this->keyCache[$path];
+				$key = $this->keyCache[$path];
 			} else {
 				$key = $this->view->file_get_contents($path);
 				$this->keyCache[$path] = $key;
@@ -238,12 +238,12 @@ 
 
 		// in case of system wide mount points the keys are stored directly in the data directory
 		if ($this->util->isSystemWideMountPoint($filename, $owner)) {
-			$keyPath = $this->root_dir . '/' . $this->keys_base_dir . $filename . '/';
+			$keyPath = $this->root_dir.'/'.$this->keys_base_dir.$filename.'/';
 		} else {
-			$keyPath = $this->root_dir . '/' . $owner . $this->keys_base_dir . $filename . '/';
+			$keyPath = $this->root_dir.'/'.$owner.$this->keys_base_dir.$filename.'/';
 		}
 
-		return Filesystem::normalizePath($keyPath . $encryptionModuleId . '/', false);
+		return Filesystem::normalizePath($keyPath.$encryptionModuleId.'/', false);
 	}
 
 	/**
@@ -300,13 +300,13 @@ 
 	 * @since 12.0.0
 	 */
 	public function backupUserKeys($encryptionModuleId, $purpose, $uid) {
-		$source = $uid . $this->encryption_base_dir . '/' . $encryptionModuleId;
-		$backupDir = $uid . $this->backup_base_dir;
+		$source = $uid.$this->encryption_base_dir.'/'.$encryptionModuleId;
+		$backupDir = $uid.$this->backup_base_dir;
 		if (!$this->view->file_exists($backupDir)) {
 			$this->view->mkdir($backupDir);
 		}
 
-		$backupDir = $backupDir . '/' . $purpose . '.' . $encryptionModuleId . '.' . $this->getTimestamp();
+		$backupDir = $backupDir.'/'.$purpose.'.'.$encryptionModuleId.'.'.$this->getTimestamp();
 		$this->view->mkdir($backupDir);
 
 		return $this->view->copy($source, $backupDir);
@@ -332,9 +332,9 @@ 
 		$systemWideMountPoint = $this->util->isSystemWideMountPoint($relativePath, $owner);
 
 		if ($systemWideMountPoint) {
-			$systemPath = $this->root_dir . '/' . $this->keys_base_dir . $relativePath . '/';
+			$systemPath = $this->root_dir.'/'.$this->keys_base_dir.$relativePath.'/';
 		} else {
-			$systemPath = $this->root_dir . '/' . $owner . $this->keys_base_dir . $relativePath . '/';
+			$systemPath = $this->root_dir.'/'.$owner.$this->keys_base_dir.$relativePath.'/';
 		}
 
 		return  Filesystem::normalizePath($systemPath, false);
@@ -351,7 +351,7 @@ 
 			$sub_dirs = explode('/', ltrim($path, '/'));
 			$dir = '';
 			foreach ($sub_dirs as $sub_dir) {
-				$dir .= '/' . $sub_dir;
+				$dir .= '/'.$sub_dir;
 				if (!$this->view->is_dir($dir)) {
 					$this->view->mkdir($dir);
 				}

Indentation +340 added lines, -340 removed lines

@@ -32,345 +32,345 @@
 
 class Storage implements IStorage {
 
-	// hidden file which indicate that the folder is a valid key storage
-	const KEY_STORAGE_MARKER = '.oc_key_storage';
-
-	/** @var View */
-	private $view;
-
-	/** @var Util */
-	private $util;
-
-	// base dir where all the file related keys are stored
-	/** @var string */
-	private $keys_base_dir;
-
-	// root of the key storage default is empty which means that we use the data folder
-	/** @var string */
-	private $root_dir;
-
-	/** @var string */
-	private $encryption_base_dir;
-
-	/** @var string */
-	private $backup_base_dir;
-
-	/** @var array */
-	private $keyCache = [];
-
-	/**
-	 * @param View $view
-	 * @param Util $util
-	 */
-	public function __construct(View $view, Util $util) {
-		$this->view = $view;
-		$this->util = $util;
-
-		$this->encryption_base_dir = '/files_encryption';
-		$this->keys_base_dir = $this->encryption_base_dir .'/keys';
-		$this->backup_base_dir = $this->encryption_base_dir .'/backup';
-		$this->root_dir = $this->util->getKeyStorageRoot();
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function getUserKey($uid, $keyId, $encryptionModuleId) {
-		$path = $this->constructUserKeyPath($encryptionModuleId, $keyId, $uid);
-		return $this->getKey($path);
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function getFileKey($path, $keyId, $encryptionModuleId) {
-		$realFile = $this->util->stripPartialFileExtension($path);
-		$keyDir = $this->getFileKeyDir($encryptionModuleId, $realFile);
-		$key = $this->getKey($keyDir . $keyId);
-
-		if ($key === '' && $realFile !== $path) {
-			// Check if the part file has keys and use them, if no normal keys
-			// exist. This is required to fix copyBetweenStorage() when we
-			// rename a .part file over storage borders.
-			$keyDir = $this->getFileKeyDir($encryptionModuleId, $path);
-			$key = $this->getKey($keyDir . $keyId);
-		}
-
-		return $key;
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function getSystemUserKey($keyId, $encryptionModuleId) {
-		$path = $this->constructUserKeyPath($encryptionModuleId, $keyId, null);
-		return $this->getKey($path);
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function setUserKey($uid, $keyId, $key, $encryptionModuleId) {
-		$path = $this->constructUserKeyPath($encryptionModuleId, $keyId, $uid);
-		return $this->setKey($path, $key);
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function setFileKey($path, $keyId, $key, $encryptionModuleId) {
-		$keyDir = $this->getFileKeyDir($encryptionModuleId, $path);
-		return $this->setKey($keyDir . $keyId, $key);
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function setSystemUserKey($keyId, $key, $encryptionModuleId) {
-		$path = $this->constructUserKeyPath($encryptionModuleId, $keyId, null);
-		return $this->setKey($path, $key);
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function deleteUserKey($uid, $keyId, $encryptionModuleId) {
-		try {
-			$path = $this->constructUserKeyPath($encryptionModuleId, $keyId, $uid);
-			return !$this->view->file_exists($path) || $this->view->unlink($path);
-		} catch (NoUserException $e) {
-			// this exception can come from initMountPoints() from setupUserMounts()
-			// for a deleted user.
-			//
-			// It means, that:
-			// - we are not running in alternative storage mode because we don't call
-			// initMountPoints() in that mode
-			// - the keys were in the user's home but since the user was deleted, the
-			// user's home is gone and so are the keys
-			//
-			// So there is nothing to do, just ignore.
-		}
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function deleteFileKey($path, $keyId, $encryptionModuleId) {
-		$keyDir = $this->getFileKeyDir($encryptionModuleId, $path);
-		return !$this->view->file_exists($keyDir . $keyId) || $this->view->unlink($keyDir . $keyId);
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function deleteAllFileKeys($path) {
-		$keyDir = $this->getFileKeyDir('', $path);
-		return !$this->view->file_exists($keyDir) || $this->view->deleteAll($keyDir);
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function deleteSystemUserKey($keyId, $encryptionModuleId) {
-		$path = $this->constructUserKeyPath($encryptionModuleId, $keyId, null);
-		return !$this->view->file_exists($path) || $this->view->unlink($path);
-	}
-
-	/**
-	 * construct path to users key
-	 *
-	 * @param string $encryptionModuleId
-	 * @param string $keyId
-	 * @param string $uid
-	 * @return string
-	 */
-	protected function constructUserKeyPath($encryptionModuleId, $keyId, $uid) {
-
-		if ($uid === null) {
-			$path = $this->root_dir . '/' . $this->encryption_base_dir . '/' . $encryptionModuleId . '/' . $keyId;
-		} else {
-			$path = $this->root_dir . '/' . $uid . $this->encryption_base_dir . '/'
-				. $encryptionModuleId . '/' . $uid . '.' . $keyId;
-		}
-
-		return \OC\Files\Filesystem::normalizePath($path);
-	}
-
-	/**
-	 * read key from hard disk
-	 *
-	 * @param string $path to key
-	 * @return string
-	 */
-	private function getKey($path) {
-
-		$key = '';
-
-		if ($this->view->file_exists($path)) {
-			if (isset($this->keyCache[$path])) {
-				$key =  $this->keyCache[$path];
-			} else {
-				$key = $this->view->file_get_contents($path);
-				$this->keyCache[$path] = $key;
-			}
-		}
-
-		return $key;
-	}
-
-	/**
-	 * write key to disk
-	 *
-	 *
-	 * @param string $path path to key directory
-	 * @param string $key key
-	 * @return bool
-	 */
-	private function setKey($path, $key) {
-		$this->keySetPreparation(dirname($path));
-
-		$result = $this->view->file_put_contents($path, $key);
-
-		if (is_int($result) && $result > 0) {
-			$this->keyCache[$path] = $key;
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * get path to key folder for a given file
-	 *
-	 * @param string $encryptionModuleId
-	 * @param string $path path to the file, relative to data/
-	 * @return string
-	 */
-	private function getFileKeyDir($encryptionModuleId, $path) {
-
-		list($owner, $filename) = $this->util->getUidAndFilename($path);
-
-		// in case of system wide mount points the keys are stored directly in the data directory
-		if ($this->util->isSystemWideMountPoint($filename, $owner)) {
-			$keyPath = $this->root_dir . '/' . $this->keys_base_dir . $filename . '/';
-		} else {
-			$keyPath = $this->root_dir . '/' . $owner . $this->keys_base_dir . $filename . '/';
-		}
-
-		return Filesystem::normalizePath($keyPath . $encryptionModuleId . '/', false);
-	}
-
-	/**
-	 * move keys if a file was renamed
-	 *
-	 * @param string $source
-	 * @param string $target
-	 * @return boolean
-	 */
-	public function renameKeys($source, $target) {
-
-		$sourcePath = $this->getPathToKeys($source);
-		$targetPath = $this->getPathToKeys($target);
-
-		if ($this->view->file_exists($sourcePath)) {
-			$this->keySetPreparation(dirname($targetPath));
-			$this->view->rename($sourcePath, $targetPath);
-
-			return true;
-		}
-
-		return false;
-	}
-
-
-	/**
-	 * copy keys if a file was renamed
-	 *
-	 * @param string $source
-	 * @param string $target
-	 * @return boolean
-	 */
-	public function copyKeys($source, $target) {
-
-		$sourcePath = $this->getPathToKeys($source);
-		$targetPath = $this->getPathToKeys($target);
-
-		if ($this->view->file_exists($sourcePath)) {
-			$this->keySetPreparation(dirname($targetPath));
-			$this->view->copy($sourcePath, $targetPath);
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * backup keys of a given encryption module
-	 *
-	 * @param string $encryptionModuleId
-	 * @param string $purpose
-	 * @param string $uid
-	 * @return bool
-	 * @since 12.0.0
-	 */
-	public function backupUserKeys($encryptionModuleId, $purpose, $uid) {
-		$source = $uid . $this->encryption_base_dir . '/' . $encryptionModuleId;
-		$backupDir = $uid . $this->backup_base_dir;
-		if (!$this->view->file_exists($backupDir)) {
-			$this->view->mkdir($backupDir);
-		}
-
-		$backupDir = $backupDir . '/' . $purpose . '.' . $encryptionModuleId . '.' . $this->getTimestamp();
-		$this->view->mkdir($backupDir);
-
-		return $this->view->copy($source, $backupDir);
-	}
-
-	/**
-	 * get the current timestamp
-	 *
-	 * @return int
-	 */
-	protected function getTimestamp() {
-		return time();
-	}
-
-	/**
-	 * get system wide path and detect mount points
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	protected function getPathToKeys($path) {
-		list($owner, $relativePath) = $this->util->getUidAndFilename($path);
-		$systemWideMountPoint = $this->util->isSystemWideMountPoint($relativePath, $owner);
-
-		if ($systemWideMountPoint) {
-			$systemPath = $this->root_dir . '/' . $this->keys_base_dir . $relativePath . '/';
-		} else {
-			$systemPath = $this->root_dir . '/' . $owner . $this->keys_base_dir . $relativePath . '/';
-		}
-
-		return  Filesystem::normalizePath($systemPath, false);
-	}
-
-	/**
-	 * Make preparations to filesystem for saving a key file
-	 *
-	 * @param string $path relative to the views root
-	 */
-	protected function keySetPreparation($path) {
-		// If the file resides within a subdirectory, create it
-		if (!$this->view->file_exists($path)) {
-			$sub_dirs = explode('/', ltrim($path, '/'));
-			$dir = '';
-			foreach ($sub_dirs as $sub_dir) {
-				$dir .= '/' . $sub_dir;
-				if (!$this->view->is_dir($dir)) {
-					$this->view->mkdir($dir);
-				}
-			}
-		}
-	}
+    // hidden file which indicate that the folder is a valid key storage
+    const KEY_STORAGE_MARKER = '.oc_key_storage';
+
+    /** @var View */
+    private $view;
+
+    /** @var Util */
+    private $util;
+
+    // base dir where all the file related keys are stored
+    /** @var string */
+    private $keys_base_dir;
+
+    // root of the key storage default is empty which means that we use the data folder
+    /** @var string */
+    private $root_dir;
+
+    /** @var string */
+    private $encryption_base_dir;
+
+    /** @var string */
+    private $backup_base_dir;
+
+    /** @var array */
+    private $keyCache = [];
+
+    /**
+     * @param View $view
+     * @param Util $util
+     */
+    public function __construct(View $view, Util $util) {
+        $this->view = $view;
+        $this->util = $util;
+
+        $this->encryption_base_dir = '/files_encryption';
+        $this->keys_base_dir = $this->encryption_base_dir .'/keys';
+        $this->backup_base_dir = $this->encryption_base_dir .'/backup';
+        $this->root_dir = $this->util->getKeyStorageRoot();
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getUserKey($uid, $keyId, $encryptionModuleId) {
+        $path = $this->constructUserKeyPath($encryptionModuleId, $keyId, $uid);
+        return $this->getKey($path);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getFileKey($path, $keyId, $encryptionModuleId) {
+        $realFile = $this->util->stripPartialFileExtension($path);
+        $keyDir = $this->getFileKeyDir($encryptionModuleId, $realFile);
+        $key = $this->getKey($keyDir . $keyId);
+
+        if ($key === '' && $realFile !== $path) {
+            // Check if the part file has keys and use them, if no normal keys
+            // exist. This is required to fix copyBetweenStorage() when we
+            // rename a .part file over storage borders.
+            $keyDir = $this->getFileKeyDir($encryptionModuleId, $path);
+            $key = $this->getKey($keyDir . $keyId);
+        }
+
+        return $key;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getSystemUserKey($keyId, $encryptionModuleId) {
+        $path = $this->constructUserKeyPath($encryptionModuleId, $keyId, null);
+        return $this->getKey($path);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function setUserKey($uid, $keyId, $key, $encryptionModuleId) {
+        $path = $this->constructUserKeyPath($encryptionModuleId, $keyId, $uid);
+        return $this->setKey($path, $key);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function setFileKey($path, $keyId, $key, $encryptionModuleId) {
+        $keyDir = $this->getFileKeyDir($encryptionModuleId, $path);
+        return $this->setKey($keyDir . $keyId, $key);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function setSystemUserKey($keyId, $key, $encryptionModuleId) {
+        $path = $this->constructUserKeyPath($encryptionModuleId, $keyId, null);
+        return $this->setKey($path, $key);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function deleteUserKey($uid, $keyId, $encryptionModuleId) {
+        try {
+            $path = $this->constructUserKeyPath($encryptionModuleId, $keyId, $uid);
+            return !$this->view->file_exists($path) || $this->view->unlink($path);
+        } catch (NoUserException $e) {
+            // this exception can come from initMountPoints() from setupUserMounts()
+            // for a deleted user.
+            //
+            // It means, that:
+            // - we are not running in alternative storage mode because we don't call
+            // initMountPoints() in that mode
+            // - the keys were in the user's home but since the user was deleted, the
+            // user's home is gone and so are the keys
+            //
+            // So there is nothing to do, just ignore.
+        }
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function deleteFileKey($path, $keyId, $encryptionModuleId) {
+        $keyDir = $this->getFileKeyDir($encryptionModuleId, $path);
+        return !$this->view->file_exists($keyDir . $keyId) || $this->view->unlink($keyDir . $keyId);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function deleteAllFileKeys($path) {
+        $keyDir = $this->getFileKeyDir('', $path);
+        return !$this->view->file_exists($keyDir) || $this->view->deleteAll($keyDir);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function deleteSystemUserKey($keyId, $encryptionModuleId) {
+        $path = $this->constructUserKeyPath($encryptionModuleId, $keyId, null);
+        return !$this->view->file_exists($path) || $this->view->unlink($path);
+    }
+
+    /**
+     * construct path to users key
+     *
+     * @param string $encryptionModuleId
+     * @param string $keyId
+     * @param string $uid
+     * @return string
+     */
+    protected function constructUserKeyPath($encryptionModuleId, $keyId, $uid) {
+
+        if ($uid === null) {
+            $path = $this->root_dir . '/' . $this->encryption_base_dir . '/' . $encryptionModuleId . '/' . $keyId;
+        } else {
+            $path = $this->root_dir . '/' . $uid . $this->encryption_base_dir . '/'
+                . $encryptionModuleId . '/' . $uid . '.' . $keyId;
+        }
+
+        return \OC\Files\Filesystem::normalizePath($path);
+    }
+
+    /**
+     * read key from hard disk
+     *
+     * @param string $path to key
+     * @return string
+     */
+    private function getKey($path) {
+
+        $key = '';
+
+        if ($this->view->file_exists($path)) {
+            if (isset($this->keyCache[$path])) {
+                $key =  $this->keyCache[$path];
+            } else {
+                $key = $this->view->file_get_contents($path);
+                $this->keyCache[$path] = $key;
+            }
+        }
+
+        return $key;
+    }
+
+    /**
+     * write key to disk
+     *
+     *
+     * @param string $path path to key directory
+     * @param string $key key
+     * @return bool
+     */
+    private function setKey($path, $key) {
+        $this->keySetPreparation(dirname($path));
+
+        $result = $this->view->file_put_contents($path, $key);
+
+        if (is_int($result) && $result > 0) {
+            $this->keyCache[$path] = $key;
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * get path to key folder for a given file
+     *
+     * @param string $encryptionModuleId
+     * @param string $path path to the file, relative to data/
+     * @return string
+     */
+    private function getFileKeyDir($encryptionModuleId, $path) {
+
+        list($owner, $filename) = $this->util->getUidAndFilename($path);
+
+        // in case of system wide mount points the keys are stored directly in the data directory
+        if ($this->util->isSystemWideMountPoint($filename, $owner)) {
+            $keyPath = $this->root_dir . '/' . $this->keys_base_dir . $filename . '/';
+        } else {
+            $keyPath = $this->root_dir . '/' . $owner . $this->keys_base_dir . $filename . '/';
+        }
+
+        return Filesystem::normalizePath($keyPath . $encryptionModuleId . '/', false);
+    }
+
+    /**
+     * move keys if a file was renamed
+     *
+     * @param string $source
+     * @param string $target
+     * @return boolean
+     */
+    public function renameKeys($source, $target) {
+
+        $sourcePath = $this->getPathToKeys($source);
+        $targetPath = $this->getPathToKeys($target);
+
+        if ($this->view->file_exists($sourcePath)) {
+            $this->keySetPreparation(dirname($targetPath));
+            $this->view->rename($sourcePath, $targetPath);
+
+            return true;
+        }
+
+        return false;
+    }
+
+
+    /**
+     * copy keys if a file was renamed
+     *
+     * @param string $source
+     * @param string $target
+     * @return boolean
+     */
+    public function copyKeys($source, $target) {
+
+        $sourcePath = $this->getPathToKeys($source);
+        $targetPath = $this->getPathToKeys($target);
+
+        if ($this->view->file_exists($sourcePath)) {
+            $this->keySetPreparation(dirname($targetPath));
+            $this->view->copy($sourcePath, $targetPath);
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * backup keys of a given encryption module
+     *
+     * @param string $encryptionModuleId
+     * @param string $purpose
+     * @param string $uid
+     * @return bool
+     * @since 12.0.0
+     */
+    public function backupUserKeys($encryptionModuleId, $purpose, $uid) {
+        $source = $uid . $this->encryption_base_dir . '/' . $encryptionModuleId;
+        $backupDir = $uid . $this->backup_base_dir;
+        if (!$this->view->file_exists($backupDir)) {
+            $this->view->mkdir($backupDir);
+        }
+
+        $backupDir = $backupDir . '/' . $purpose . '.' . $encryptionModuleId . '.' . $this->getTimestamp();
+        $this->view->mkdir($backupDir);
+
+        return $this->view->copy($source, $backupDir);
+    }
+
+    /**
+     * get the current timestamp
+     *
+     * @return int
+     */
+    protected function getTimestamp() {
+        return time();
+    }
+
+    /**
+     * get system wide path and detect mount points
+     *
+     * @param string $path
+     * @return string
+     */
+    protected function getPathToKeys($path) {
+        list($owner, $relativePath) = $this->util->getUidAndFilename($path);
+        $systemWideMountPoint = $this->util->isSystemWideMountPoint($relativePath, $owner);
+
+        if ($systemWideMountPoint) {
+            $systemPath = $this->root_dir . '/' . $this->keys_base_dir . $relativePath . '/';
+        } else {
+            $systemPath = $this->root_dir . '/' . $owner . $this->keys_base_dir . $relativePath . '/';
+        }
+
+        return  Filesystem::normalizePath($systemPath, false);
+    }
+
+    /**
+     * Make preparations to filesystem for saving a key file
+     *
+     * @param string $path relative to the views root
+     */
+    protected function keySetPreparation($path) {
+        // If the file resides within a subdirectory, create it
+        if (!$this->view->file_exists($path)) {
+            $sub_dirs = explode('/', ltrim($path, '/'));
+            $dir = '';
+            foreach ($sub_dirs as $sub_dir) {
+                $dir .= '/' . $sub_dir;
+                if (!$this->view->is_dir($dir)) {
+                    $this->view->mkdir($dir);
+                }
+            }
+        }
+    }
 
 }