fileView = new \OC\Files\View('/' . $user . '/' . $root); $this->userView = new \OC\Files\View('/' . $user); //set config $this->configMaxX = \OC_Config::getValue('preview_max_x', null); $this->configMaxY = \OC_Config::getValue('preview_max_y', null); $this->maxScaleFactor = \OC_Config::getValue('preview_max_scale_factor', 2); //save parameters $this->setFile($file); $this->setMaxX($maxX); $this->setMaxY($maxY); $this->setScalingUp($scalingUp); $this->preview = null; //check if there are preview backends if (empty(self::$providers)) { self::initProviders(); } if (empty(self::$providers) && \OC::$server->getConfig()->getSystemValue('enable_previews', true)) { \OC_Log::write('core', 'No preview providers exist', \OC_Log::ERROR); throw new \Exception('No preview providers'); } } /** * returns the path of the file you want a thumbnail from * @return string */ public function getFile() { return $this->file; } /** * returns the max width of the preview * @return integer */ public function getMaxX() { return $this->maxX; } /** * returns the max height of the preview * @return integer */ public function getMaxY() { return $this->maxY; } /** * returns whether or not scalingup is enabled * @return bool */ public function getScalingUp() { return $this->scalingUp; } /** * returns the name of the thumbnailfolder * @return string */ public function getThumbnailsFolder() { return self::THUMBNAILS_FOLDER; } /** * returns the max scale factor * @return string */ public function getMaxScaleFactor() { return $this->maxScaleFactor; } /** * returns the max width set in ownCloud's config * @return string */ public function getConfigMaxX() { return $this->configMaxX; } /** * returns the max height set in ownCloud's config * @return string */ public function getConfigMaxY() { return $this->configMaxY; } /** * @return false|Files\FileInfo|\OCP\Files\FileInfo */ protected function getFileInfo() { $absPath = $this->fileView->getAbsolutePath($this->file); $absPath = Files\Filesystem::normalizePath($absPath); if(array_key_exists($absPath, self::$deleteFileMapper)) { $this->info = self::$deleteFileMapper[$absPath]; } else if (!$this->info) { $this->info = $this->fileView->getFileInfo($this->file); } return $this->info; } /** * @return array|null */ private function getChildren() { $absPath = $this->fileView->getAbsolutePath($this->file); $absPath = Files\Filesystem::normalizePath($absPath); if (array_key_exists($absPath, self::$deleteChildrenMapper)) { return self::$deleteChildrenMapper[$absPath]; } return null; } /** * set the path of the file you want a thumbnail from * @param string $file * @return $this */ public function setFile($file) { $this->file = $file; $this->info = null; if ($file !== '') { $this->getFileInfo(); if($this->info instanceof \OCP\Files\FileInfo) { $this->mimeType = $this->info->getMimetype(); } } return $this; } /** * set mime type explicitly * @param string $mimeType */ public function setMimetype($mimeType) { $this->mimeType = $mimeType; } /** * set the the max width of the preview * @param int $maxX * @throws \Exception * @return \OC\Preview $this */ public function setMaxX($maxX = 1) { if ($maxX <= 0) { throw new \Exception('Cannot set width of 0 or smaller!'); } $configMaxX = $this->getConfigMaxX(); if (!is_null($configMaxX)) { if ($maxX > $configMaxX) { \OC_Log::write('core', 'maxX reduced from ' . $maxX . ' to ' . $configMaxX, \OC_Log::DEBUG); $maxX = $configMaxX; } } $this->maxX = $maxX; return $this; } /** * set the the max height of the preview * @param int $maxY * @throws \Exception * @return \OC\Preview $this */ public function setMaxY($maxY = 1) { if ($maxY <= 0) { throw new \Exception('Cannot set height of 0 or smaller!'); } $configMaxY = $this->getConfigMaxY(); if (!is_null($configMaxY)) { if ($maxY > $configMaxY) { \OC_Log::write('core', 'maxX reduced from ' . $maxY . ' to ' . $configMaxY, \OC_Log::DEBUG); $maxY = $configMaxY; } } $this->maxY = $maxY; return $this; } /** * set whether or not scalingup is enabled * @param bool $scalingUp * @return \OC\Preview $this */ public function setScalingup($scalingUp) { if ($this->getMaxScaleFactor() === 1) { $scalingUp = false; } $this->scalingUp = $scalingUp; return $this; } /** * @param bool $keepAspect * @return $this */ public function setKeepAspect($keepAspect) { $this->keepAspect = $keepAspect; return $this; } /** * check if all parameters are valid * @return bool */ public function isFileValid() { $file = $this->getFile(); if ($file === '') { \OC_Log::write('core', 'No filename passed', \OC_Log::DEBUG); return false; } if (!$this->fileView->file_exists($file)) { \OC_Log::write('core', 'File:"' . $file . '" not found', \OC_Log::DEBUG); return false; } return true; } /** * deletes previews of a file with specific x and y * @return bool */ public function deletePreview() { $file = $this->getFile(); $fileInfo = $this->getFileInfo($file); if($fileInfo !== null && $fileInfo !== false) { $fileId = $fileInfo->getId(); $previewPath = $this->buildCachePath($fileId); return $this->userView->unlink($previewPath); } return false; } /** * deletes all previews of a file */ public function deleteAllPreviews() { $toDelete = $this->getChildren(); $toDelete[] = $this->getFileInfo(); foreach ($toDelete as $delete) { if ($delete instanceof FileInfo) { /** @var \OCP\Files\FileInfo $delete */ $fileId = $delete->getId(); // getId() might return null, e.g. when the file is a // .ocTransferId*.part file from chunked file upload. if (!empty($fileId)) { $previewPath = $this->getPreviewPath($fileId); $this->userView->deleteAll($previewPath); $this->userView->rmdir($previewPath); } } } } /** * check if thumbnail or bigger version of thumbnail of file is cached * @param int $fileId fileId of the original image * @return string|false path to thumbnail if it exists or false */ public function isCached($fileId) { if (is_null($fileId)) { return false; } $preview = $this->buildCachePath($fileId); //does a preview with the wanted height and width already exist? if ($this->userView->file_exists($preview)) { return $preview; } return $this->isCachedBigger($fileId); } /** * check if a bigger version of thumbnail of file is cached * @param int $fileId fileId of the original image * @return string|false path to bigger thumbnail if it exists or false */ private function isCachedBigger($fileId) { if (is_null($fileId)) { return false; } // in order to not loose quality we better generate aspect preserving previews from the original file if ($this->keepAspect) { return false; } $maxX = $this->getMaxX(); //array for usable cached thumbnails $possibleThumbnails = $this->getPossibleThumbnails($fileId); foreach ($possibleThumbnails as $width => $path) { if ($width < $maxX) { continue; } else { return $path; } } return false; } /** * get possible bigger thumbnails of the given image * @param int $fileId fileId of the original image * @return array an array of paths to bigger thumbnails */ private function getPossibleThumbnails($fileId) { if (is_null($fileId)) { return array(); } $previewPath = $this->getPreviewPath($fileId); $wantedAspectRatio = (float) ($this->getMaxX() / $this->getMaxY()); //array for usable cached thumbnails $possibleThumbnails = array(); $allThumbnails = $this->userView->getDirectoryContent($previewPath); foreach ($allThumbnails as $thumbnail) { $name = rtrim($thumbnail['name'], '.png'); list($x, $y, $aspectRatio) = $this->getDimensionsFromFilename($name); if (abs($aspectRatio - $wantedAspectRatio) >= 0.000001 || $this->unscalable($x, $y) ) { continue; } $possibleThumbnails[$x] = $thumbnail['path']; } ksort($possibleThumbnails); return $possibleThumbnails; } /** * @param string $name * @return array */ private function getDimensionsFromFilename($name) { $size = explode('-', $name); $x = (int) $size[0]; $y = (int) $size[1]; $aspectRatio = (float) ($x / $y); return array($x, $y, $aspectRatio); } /** * @param int $x * @param int $y * @return bool */ private function unscalable($x, $y) { $maxX = $this->getMaxX(); $maxY = $this->getMaxY(); $scalingUp = $this->getScalingUp(); $maxScaleFactor = $this->getMaxScaleFactor(); if ($x < $maxX || $y < $maxY) { if ($scalingUp) { $scalefactor = $maxX / $x; if ($scalefactor > $maxScaleFactor) { return true; } } else { return true; } } return false; } /** * return a preview of a file * @return \OC_Image */ public function getPreview() { if (!is_null($this->preview) && $this->preview->valid()) { return $this->preview; } $this->preview = null; $file = $this->getFile(); $maxX = $this->getMaxX(); $maxY = $this->getMaxY(); $scalingUp = $this->getScalingUp(); $fileInfo = $this->getFileInfo($file); if($fileInfo === null || $fileInfo === false) { return new \OC_Image(); } $fileId = $fileInfo->getId(); $cached = $this->isCached($fileId); if ($cached) { $stream = $this->userView->fopen($cached, 'r'); $this->preview = null; if ($stream) { $image = new \OC_Image(); $image->loadFromFileHandle($stream); $this->preview = $image->valid() ? $image : null; $this->resizeAndCrop(); fclose($stream); } } if (is_null($this->preview)) { $preview = null; foreach (self::$providers as $supportedMimeType => $provider) { if (!preg_match($supportedMimeType, $this->mimeType)) { continue; } \OC_Log::write('core', 'Generating preview for "' . $file . '" with "' . get_class($provider) . '"', \OC_Log::DEBUG); /** @var $provider Provider */ $preview = $provider->getThumbnail($file, $maxX, $maxY, $scalingUp, $this->fileView); if (!($preview instanceof \OC_Image)) { continue; } $this->preview = $preview; $this->resizeAndCrop(); $previewPath = $this->getPreviewPath($fileId); $cachePath = $this->buildCachePath($fileId); if ($this->userView->is_dir($this->getThumbnailsFolder() . '/') === false) { $this->userView->mkdir($this->getThumbnailsFolder() . '/'); } if ($this->userView->is_dir($previewPath) === false) { $this->userView->mkdir($previewPath); } $this->userView->file_put_contents($cachePath, $preview->data()); break; } } if (is_null($this->preview)) { $this->preview = new \OC_Image(); } return $this->preview; } /** * @param null|string $mimeType * @throws NotFoundException */ public function showPreview($mimeType = null) { // Check if file is valid if($this->isFileValid() === false) { throw new NotFoundException('File not found.'); } \OCP\Response::enableCaching(3600 * 24); // 24 hours if (is_null($this->preview)) { $this->getPreview(); } if ($this->preview instanceof \OC_Image) { $this->preview->show($mimeType); } } /** * resize, crop and fix orientation * @return void */ private function resizeAndCrop() { $image = $this->preview; $x = $this->getMaxX(); $y = $this->getMaxY(); $scalingUp = $this->getScalingUp(); $maxScaleFactor = $this->getMaxScaleFactor(); if (!($image instanceof \OC_Image)) { \OC_Log::write('core', '$this->preview is not an instance of OC_Image', \OC_Log::DEBUG); return; } $realX = (int)$image->width(); $realY = (int)$image->height(); // compute $maxY and $maxX using the aspect of the generated preview if ($this->keepAspect) { $ratio = $realX / $realY; if($x / $ratio < $y) { // width restricted $y = $x / $ratio; } else { $x = $y * $ratio; } } if ($x === $realX && $y === $realY) { $this->preview = $image; return; } $factorX = $x / $realX; $factorY = $y / $realY; if ($factorX >= $factorY) { $factor = $factorX; } else { $factor = $factorY; } if ($scalingUp === false) { if ($factor > 1) { $factor = 1; } } if (!is_null($maxScaleFactor)) { if ($factor > $maxScaleFactor) { \OC_Log::write('core', 'scale factor reduced from ' . $factor . ' to ' . $maxScaleFactor, \OC_Log::DEBUG); $factor = $maxScaleFactor; } } $newXSize = (int)($realX * $factor); $newYSize = (int)($realY * $factor); $image->preciseResize($newXSize, $newYSize); if ($newXSize === $x && $newYSize === $y) { $this->preview = $image; return; } if ($newXSize >= $x && $newYSize >= $y) { $cropX = floor(abs($x - $newXSize) * 0.5); //don't crop previews on the Y axis, this sucks if it's a document. //$cropY = floor(abs($y - $newYsize) * 0.5); $cropY = 0; $image->crop($cropX, $cropY, $x, $y); $this->preview = $image; return; } if (($newXSize < $x || $newYSize < $y) && $scalingUp) { if ($newXSize > $x) { $cropX = floor(($newXSize - $x) * 0.5); $image->crop($cropX, 0, $x, $newYSize); } if ($newYSize > $y) { $cropY = floor(($newYSize - $y) * 0.5); $image->crop(0, $cropY, $newXSize, $y); } $newXSize = (int)$image->width(); $newYSize = (int)$image->height(); //create transparent background layer $backgroundLayer = imagecreatetruecolor($x, $y); $white = imagecolorallocate($backgroundLayer, 255, 255, 255); imagefill($backgroundLayer, 0, 0, $white); $image = $image->resource(); $mergeX = floor(abs($x - $newXSize) * 0.5); $mergeY = floor(abs($y - $newYSize) * 0.5); imagecopy($backgroundLayer, $image, $mergeX, $mergeY, 0, 0, $newXSize, $newYSize); //$black = imagecolorallocate(0,0,0); //imagecolortransparent($transparentlayer, $black); $image = new \OC_Image($backgroundLayer); $this->preview = $image; return; } } /** * register a new preview provider to be used * @param string $class * @param array $options */ public static function registerProvider($class, $options = array()) { /** * Only register providers that have been explicitly enabled * * The following providers are enabled by default: * - OC\Preview\Image * - OC\Preview\MP3 * - OC\Preview\TXT * - OC\Preview\MarkDown * * The following providers are disabled by default due to performance or privacy concerns: * - OC\Preview\MSOfficeDoc * - OC\Preview\MSOffice2003 * - OC\Preview\MSOffice2007 * - OC\Preview\OpenDocument * - OC\Preview\StarOffice * - OC\Preview\SVG * - OC\Preview\Movie * - OC\Preview\PDF * - OC\Preview\TIFF * - OC\Preview\Illustrator * - OC\Preview\Postscript * - OC\Preview\Photoshop */ if(empty(self::$enabledProviders)) { self::$enabledProviders = \OC::$server->getConfig()->getSystemValue('enabledPreviewProviders', array( 'OC\Preview\Image', 'OC\Preview\MP3', 'OC\Preview\TXT', 'OC\Preview\MarkDown', )); } if(in_array($class, self::$enabledProviders)) { self::$registeredProviders[] = array('class' => $class, 'options' => $options); } } /** * create instances of all the registered preview providers * @return void */ private static function initProviders() { if (!\OC::$server->getConfig()->getSystemValue('enable_previews', true)) { self::$providers = array(); return; } if (!empty(self::$providers)) { return; } self::registerCoreProviders(); foreach (self::$registeredProviders as $provider) { $class = $provider['class']; $options = $provider['options']; /** @var $object Provider */ $object = new $class($options); self::$providers[$object->getMimeType()] = $object; } $keys = array_map('strlen', array_keys(self::$providers)); array_multisort($keys, SORT_DESC, self::$providers); } protected static function registerCoreProviders() { self::registerProvider('OC\Preview\TXT'); self::registerProvider('OC\Preview\MarkDown'); self::registerProvider('OC\Preview\Image'); self::registerProvider('OC\Preview\MP3'); // SVG, Office and Bitmap require imagick if (extension_loaded('imagick')) { $checkImagick = new \Imagick(); $imagickProviders = array( 'SVG' => 'OC\Preview\SVG', 'TIFF' => 'OC\Preview\TIFF', 'PDF' => 'OC\Preview\PDF', 'AI' => 'OC\Preview\Illustrator', 'PSD' => 'OC\Preview\Photoshop', // Requires adding 'eps' => array('application/postscript', null), to lib/private/mimetypes.list.php 'EPS' => 'OC\Preview\Postscript', ); foreach ($imagickProviders as $queryFormat => $provider) { if (count($checkImagick->queryFormats($queryFormat)) === 1) { self::registerProvider($provider); } } 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(\OC::$server->getConfig()->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) { self::registerProvider('OC\Preview\MSOfficeDoc'); self::registerProvider('OC\Preview\MSOffice2003'); self::registerProvider('OC\Preview\MSOffice2007'); self::registerProvider('OC\Preview\OpenDocument'); self::registerProvider('OC\Preview\StarOffice'); } } } } // Video requires avconv or ffmpeg and is therefor // currently not supported on Windows. if (!\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; self::registerProvider('OC\Preview\Movie'); } } } /** * @param array $args */ public static function post_write($args) { self::post_delete($args, 'files/'); } /** * @param array $args */ public static function prepare_delete_files($args) { self::prepare_delete($args, 'files/'); } /** * @param array $args * @param string $prefix */ public static function prepare_delete($args, $prefix='') { $path = $args['path']; if (substr($path, 0, 1) === '/') { $path = substr($path, 1); } $view = new \OC\Files\View('/' . \OC_User::getUser() . '/' . $prefix); $absPath = Files\Filesystem::normalizePath($view->getAbsolutePath($path)); self::addPathToDeleteFileMapper($absPath, $view->getFileInfo($path)); if ($view->is_dir($path)) { $children = self::getAllChildren($view, $path); self::$deleteChildrenMapper[$absPath] = $children; } } /** * @param string $absolutePath * @param \OCP\Files\FileInfo $info */ private static function addPathToDeleteFileMapper($absolutePath, $info) { self::$deleteFileMapper[$absolutePath] = $info; } /** * @param \OC\Files\View $view * @param string $path * @return array */ private static function getAllChildren($view, $path) { $children = $view->getDirectoryContent($path); $childrensFiles = array(); $fakeRootLength = strlen($view->getRoot()); for ($i = 0; $i < count($children); $i++) { $child = $children[$i]; $childsPath = substr($child->getPath(), $fakeRootLength); if ($view->is_dir($childsPath)) { $children = array_merge( $children, $view->getDirectoryContent($childsPath) ); } else { $childrensFiles[] = $child; } } return $childrensFiles; } /** * @param array $args */ public static function post_delete_files($args) { self::post_delete($args, 'files/'); } /** * @param array $args * @param string $prefix */ public static function post_delete($args, $prefix='') { $path = Files\Filesystem::normalizePath($args['path']); $preview = new Preview(\OC_User::getUser(), $prefix, $path); $preview->deleteAllPreviews(); } /** * Check if a preview can be generated for a file * * @param \OC\Files\FileInfo $file * @return bool */ public static function isAvailable(\OC\Files\FileInfo $file) { if (!\OC_Config::getValue('enable_previews', true)) { return false; } $mount = $file->getMountPoint(); if ($mount and !$mount->getOption('previews', true)){ return false; } //check if there are preview backends if (empty(self::$providers)) { self::initProviders(); } foreach (self::$providers as $supportedMimeType => $provider) { /** * @var \OC\Preview\Provider $provider */ if (preg_match($supportedMimeType, $file->getMimetype())) { return $provider->isAvailable($file); } } return false; } /** * @param string $mimeType * @return bool */ public static function isMimeSupported($mimeType) { if (!\OC_Config::getValue('enable_previews', true)) { return false; } //check if there are preview backends if (empty(self::$providers)) { self::initProviders(); } foreach(self::$providers as $supportedMimetype => $provider) { if(preg_match($supportedMimetype, $mimeType)) { return true; } } return false; } /** * @param int $fileId * @return string */ private function buildCachePath($fileId) { $maxX = $this->getMaxX(); $maxY = $this->getMaxY(); $previewPath = $this->getPreviewPath($fileId); $preview = $previewPath . strval($maxX) . '-' . strval($maxY); if ($this->keepAspect) { $preview .= '-with-aspect'; } $preview .= '.png'; return $preview; } /** * @param int $fileId * @return string */ private function getPreviewPath($fileId) { return $this->getThumbnailsFolder() . '/' . $fileId . '/'; } }