aboutsummaryrefslogtreecommitdiffstats
path: root/lib/private/PreviewManager.php
diff options
context:
space:
mode:
authorRoeland Jago Douma <rullzer@owncloud.com>2016-04-29 15:08:01 +0200
committerRoeland Jago Douma <rullzer@owncloud.com>2016-04-29 15:08:01 +0200
commitf52c5b31b6b92bc83e224413f4a8ae4ba7d11993 (patch)
tree09654a6d35089eab4b7b0deeda72cee522ae304f /lib/private/PreviewManager.php
parent66ebc2ee6fe09e1e8419f4b399cd2c7c155d533e (diff)
downloadnextcloud-server-f52c5b31b6b92bc83e224413f4a8ae4ba7d11993.tar.gz
nextcloud-server-f52c5b31b6b92bc83e224413f4a8ae4ba7d11993.zip
Move more from \OC to PSR-4
* \OC\OCSClient * \OC\Preview * \OC\PreviewManager * \OC\Repair * \OC\RepairException * \OC\Search * \OC\ServerContainer * \OC\ServerNotAvailableException * \OC\ServiceUnavailableException * \OC\Setup * \OC\Streamer * \OC\SubAdmin * \OC\SystemConfig * \OC\TagManager * \OC\Tags * \OC\TempManager * \OC\TemplateLayout * \OC\URLGenerator * \OC\Updater
Diffstat (limited to 'lib/private/PreviewManager.php')
-rw-r--r--lib/private/PreviewManager.php342
1 files changed, 342 insertions, 0 deletions
diff --git a/lib/private/PreviewManager.php b/lib/private/PreviewManager.php
new file mode 100644
index 00000000000..f3c7a4de0d0
--- /dev/null
+++ b/lib/private/PreviewManager.php
@@ -0,0 +1,342 @@
+<?php
+/**
+ * @author Joas Schilling <nickvergessen@owncloud.com>
+ * @author Morris Jobke <hey@morrisjobke.de>
+ * @author Olivier Paroz <github@oparoz.com>
+ * @author Robin Appelman <icewind@owncloud.com>
+ * @author Thomas Müller <thomas.mueller@tmit.eu>
+ *
+ * @copyright Copyright (c) 2016, ownCloud, Inc.
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program. If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+namespace OC;
+
+use OCP\IPreview;
+use OCP\Preview\IProvider;
+
+class PreviewManager implements IPreview {
+ /** @var \OCP\IConfig */
+ protected $config;
+
+ /** @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;
+
+ /**
+ * Constructor
+ *
+ * @param \OCP\IConfig $config
+ */
+ public function __construct(\OCP\IConfig $config) {
+ $this->config = $config;
+ }
+
+ /**
+ * 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
+ *
+ * @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
+ */
+ public function createPreview($file, $maxX = 100, $maxY = 75, $scaleUp = false) {
+ $preview = new \OC\Preview('', '/', $file, $maxX, $maxY, $scaleUp);
+ return $preview->getPreview();
+ }
+
+ /**
+ * 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\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 = [
+ 'OC\Preview\PNG',
+ 'OC\Preview\JPEG',
+ 'OC\Preview\GIF',
+ 'OC\Preview\BMP',
+ 'OC\Preview\XBitmap'
+ ];
+
+ $this->defaultProviders = $this->config->getSystemValue('enabledPreviewProviders', array_merge([
+ 'OC\Preview\MarkDown',
+ 'OC\Preview\MP3',
+ 'OC\Preview\TXT',
+ ], $imageProviders));
+
+ if (in_array('OC\Preview\Image', $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('OC\Preview\TXT', '/text\/plain/');
+ $this->registerCoreProvider('OC\Preview\MarkDown', '/text\/(x-)?markdown/');
+ $this->registerCoreProvider('OC\Preview\PNG', '/image\/png/');
+ $this->registerCoreProvider('OC\Preview\JPEG', '/image\/jpeg/');
+ $this->registerCoreProvider('OC\Preview\GIF', '/image\/gif/');
+ $this->registerCoreProvider('OC\Preview\BMP', '/image\/bmp/');
+ $this->registerCoreProvider('OC\Preview\XBitmap', '/image\/x-xbitmap/');
+ $this->registerCoreProvider('OC\Preview\MP3', '/audio\/mpeg/');
+
+ // SVG, Office and Bitmap require imagick
+ if (extension_loaded('imagick')) {
+ $checkImagick = new \Imagick();
+
+ $imagickProviders = [
+ 'SVG' => ['mimetype' => '/image\/svg\+xml/', 'class' => '\OC\Preview\SVG'],
+ 'TIFF' => ['mimetype' => '/image\/tiff/', 'class' => '\OC\Preview\TIFF'],
+ 'PDF' => ['mimetype' => '/application\/pdf/', 'class' => '\OC\Preview\PDF'],
+ 'AI' => ['mimetype' => '/application\/illustrator/', 'class' => '\OC\Preview\Illustrator'],
+ 'PSD' => ['mimetype' => '/application\/x-photoshop/', 'class' => '\OC\Preview\Photoshop'],
+ 'EPS' => ['mimetype' => '/application\/postscript/', 'class' => '\OC\Preview\Postscript'],
+ 'TTF' => ['mimetype' => '/application\/(?:font-sfnt|x-font$)/', 'class' => '\OC\Preview\Font'],
+ ];
+
+ 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) {
+ // Office previews are currently not supported on Windows
+ if (!\OC_Util::runningOnWindows() && \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('\OC\Preview\MSOfficeDoc', '/application\/msword/');
+ $this->registerCoreProvider('\OC\Preview\MSOffice2003', '/application\/vnd.ms-.*/');
+ $this->registerCoreProvider('\OC\Preview\MSOffice2007', '/application\/vnd.openxmlformats-officedocument.*/');
+ $this->registerCoreProvider('\OC\Preview\OpenDocument', '/application\/vnd.oasis.opendocument.*/');
+ $this->registerCoreProvider('\OC\Preview\StarOffice', '/application\/vnd.sun.xml.*/');
+ }
+ }
+ }
+ }
+
+ // Video requires avconv or ffmpeg and is therefor
+ // currently not supported on Windows.
+ if (in_array('OC\Preview\Movie', $this->getEnabledDefaultProvider()) && !\OC_Util::runningOnWindows()) {
+ $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('\OC\Preview\Movie', '/video\/.*/');
+ }
+ }
+ }
+}