123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469 |
- <?php
- namespace OC;
- use OC\AppFramework\Bootstrap\Coordinator;
- use OC\Preview\Generator;
- use OC\Preview\GeneratorHelper;
- use OC\Preview\IMagickSupport;
- use OCP\AppFramework\QueryException;
- use OCP\EventDispatcher\IEventDispatcher;
- use OCP\Files\File;
- use OCP\Files\IAppData;
- use OCP\Files\IRootFolder;
- use OCP\Files\NotFoundException;
- use OCP\Files\SimpleFS\ISimpleFile;
- use OCP\IBinaryFinder;
- use OCP\IConfig;
- use OCP\IPreview;
- use OCP\IServerContainer;
- use OCP\Preview\IProviderV2;
- use function array_key_exists;
- class PreviewManager implements IPreview {
- protected IConfig $config;
- protected IRootFolder $rootFolder;
- protected IAppData $appData;
- protected IEventDispatcher $eventDispatcher;
- private ?Generator $generator = null;
- private GeneratorHelper $helper;
- protected bool $providerListDirty = false;
- protected bool $registeredCoreProviders = false;
- protected array $providers = [];
-
- protected array $mimeTypeSupportMap = [];
- protected ?array $defaultProviders = null;
- protected ?string $userId;
- private Coordinator $bootstrapCoordinator;
-
- private array $loadedBootstrapProviders = [];
- private IServerContainer $container;
- private IBinaryFinder $binaryFinder;
- private IMagickSupport $imagickSupport;
- private bool $enablePreviews;
- public function __construct(
- IConfig $config,
- IRootFolder $rootFolder,
- IAppData $appData,
- IEventDispatcher $eventDispatcher,
- GeneratorHelper $helper,
- ?string $userId,
- Coordinator $bootstrapCoordinator,
- IServerContainer $container,
- IBinaryFinder $binaryFinder,
- IMagickSupport $imagickSupport
- ) {
- $this->config = $config;
- $this->rootFolder = $rootFolder;
- $this->appData = $appData;
- $this->eventDispatcher = $eventDispatcher;
- $this->helper = $helper;
- $this->userId = $userId;
- $this->bootstrapCoordinator = $bootstrapCoordinator;
- $this->container = $container;
- $this->binaryFinder = $binaryFinder;
- $this->imagickSupport = $imagickSupport;
- $this->enablePreviews = $config->getSystemValueBool('enable_previews', true);
- }
-
- public function registerProvider($mimeTypeRegex, \Closure $callable): void {
- if (!$this->enablePreviews) {
- return;
- }
- if (!isset($this->providers[$mimeTypeRegex])) {
- $this->providers[$mimeTypeRegex] = [];
- }
- $this->providers[$mimeTypeRegex][] = $callable;
- $this->providerListDirty = true;
- }
-
- public function getProviders(): array {
- if (!$this->enablePreviews) {
- return [];
- }
- $this->registerCoreProviders();
- $this->registerBootstrapProviders();
- if ($this->providerListDirty) {
- $keys = array_map('strlen', array_keys($this->providers));
- array_multisort($keys, SORT_DESC, $this->providers);
- $this->providerListDirty = false;
- }
- return $this->providers;
- }
-
- public function hasProviders(): bool {
- $this->registerCoreProviders();
- return !empty($this->providers);
- }
- private function getGenerator(): Generator {
- if ($this->generator === null) {
- $this->generator = new Generator(
- $this->config,
- $this,
- $this->appData,
- new GeneratorHelper(
- $this->rootFolder,
- $this->config
- ),
- $this->eventDispatcher
- );
- }
- return $this->generator;
- }
-
- public function getPreview(File $file, $width = -1, $height = -1, $crop = false, $mode = IPreview::MODE_FILL, $mimeType = null) {
- $this->throwIfPreviewsDisabled();
- $previewConcurrency = $this->getGenerator()->getNumConcurrentPreviews('preview_concurrency_all');
- $sem = Generator::guardWithSemaphore(Generator::SEMAPHORE_ID_ALL, $previewConcurrency);
- try {
- $preview = $this->getGenerator()->getPreview($file, $width, $height, $crop, $mode, $mimeType);
- } finally {
- Generator::unguardWithSemaphore($sem);
- }
- return $preview;
- }
-
- public function generatePreviews(File $file, array $specifications, $mimeType = null) {
- $this->throwIfPreviewsDisabled();
- return $this->getGenerator()->generatePreviews($file, $specifications, $mimeType);
- }
-
- public function isMimeSupported($mimeType = '*') {
- if (!$this->enablePreviews) {
- return false;
- }
- if (isset($this->mimeTypeSupportMap[$mimeType])) {
- return $this->mimeTypeSupportMap[$mimeType];
- }
- $this->registerCoreProviders();
- $this->registerBootstrapProviders();
- $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;
- }
-
- public function isAvailable(\OCP\Files\FileInfo $file): bool {
- if (!$this->enablePreviews) {
- 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 $providerClosure) {
- $provider = $this->helper->getProvider($providerClosure);
- if (!($provider instanceof IProviderV2)) {
- continue;
- }
- if ($provider->isAvailable($file)) {
- return true;
- }
- }
- }
- }
- return false;
- }
-
- protected function getEnabledDefaultProvider() {
- if ($this->defaultProviders !== null) {
- return $this->defaultProviders;
- }
- $imageProviders = [
- Preview\PNG::class,
- Preview\JPEG::class,
- Preview\GIF::class,
- Preview\BMP::class,
- Preview\XBitmap::class,
- Preview\Krita::class,
- Preview\WebP::class,
- ];
- $this->defaultProviders = $this->config->getSystemValue('enabledPreviewProviders', array_merge([
- Preview\MarkDown::class,
- Preview\MP3::class,
- Preview\TXT::class,
- Preview\OpenDocument::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;
- }
-
- protected function registerCoreProvider($class, $mimeType, $options = []) {
- if (in_array(trim($class, '\\'), $this->getEnabledDefaultProvider())) {
- $this->registerProvider($mimeType, function () use ($class, $options) {
- return new $class($options);
- });
- }
- }
-
- 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\WebP::class, '/image\/webp/');
- $this->registerCoreProvider(Preview\Krita::class, '/application\/x-krita/');
- $this->registerCoreProvider(Preview\MP3::class, '/audio\/mpeg/');
- $this->registerCoreProvider(Preview\OpenDocument::class, '/application\/vnd.oasis.opendocument.*/');
- $this->registerCoreProvider(Preview\Imaginary::class, Preview\Imaginary::supportedMimeTypes());
- $this->registerCoreProvider(Preview\ImaginaryPDF::class, Preview\ImaginaryPDF::supportedMimeTypes());
-
- if ($this->imagickSupport->hasExtension()) {
- $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\/(x-)?hei(f|c)/', 'class' => Preview\HEIC::class],
- 'TGA' => ['mimetype' => '/image\/(x-)?t(ar)?ga/', 'class' => Preview\TGA::class],
- 'SGI' => ['mimetype' => '/image\/(x-)?sgi/', 'class' => Preview\SGI::class],
- ];
- foreach ($imagickProviders as $queryFormat => $provider) {
- $class = $provider['class'];
- if (!in_array(trim($class, '\\'), $this->getEnabledDefaultProvider())) {
- continue;
- }
- if ($this->imagickSupport->supportsFormat($queryFormat)) {
- $this->registerCoreProvider($class, $provider['mimetype']);
- }
- }
- }
- $this->registerCoreProvidersOffice();
-
- if (in_array(Preview\Movie::class, $this->getEnabledDefaultProvider())) {
- $movieBinary = $this->config->getSystemValue('preview_ffmpeg_path', null);
- if (!is_string($movieBinary)) {
- $movieBinary = $this->binaryFinder->findBinaryPath('avconv');
- if (!is_string($movieBinary)) {
- $movieBinary = $this->binaryFinder->findBinaryPath('ffmpeg');
- }
- }
- if (is_string($movieBinary)) {
- $this->registerCoreProvider(Preview\Movie::class, '/video\/.*/', ["movieBinary" => $movieBinary]);
- }
- }
- }
- private function registerCoreProvidersOffice(): void {
- $officeProviders = [
- ['mimetype' => '/application\/msword/', 'class' => Preview\MSOfficeDoc::class],
- ['mimetype' => '/application\/vnd.ms-.*/', 'class' => Preview\MSOffice2003::class],
- ['mimetype' => '/application\/vnd.openxmlformats-officedocument.*/', 'class' => Preview\MSOffice2007::class],
- ['mimetype' => '/application\/vnd.oasis.opendocument.*/', 'class' => Preview\OpenDocument::class],
- ['mimetype' => '/application\/vnd.sun.xml.*/', 'class' => Preview\StarOffice::class],
- ['mimetype' => '/image\/emf/', 'class' => Preview\EMF::class],
- ];
- $findBinary = true;
- $officeBinary = false;
- foreach ($officeProviders as $provider) {
- $class = $provider['class'];
- if (!in_array(trim($class, '\\'), $this->getEnabledDefaultProvider())) {
- continue;
- }
- if ($findBinary) {
-
- $officeBinary = $this->config->getSystemValue('preview_libreoffice_path', false);
- if ($officeBinary === false) {
- $officeBinary = $this->binaryFinder->findBinaryPath('libreoffice');
- }
- if ($officeBinary === false) {
- $officeBinary = $this->binaryFinder->findBinaryPath('openoffice');
- }
- $findBinary = false;
- }
- if ($officeBinary) {
- $this->registerCoreProvider($class, $provider['mimetype'], ['officeBinary' => $officeBinary]);
- }
- }
- }
- private function registerBootstrapProviders(): void {
- $context = $this->bootstrapCoordinator->getRegistrationContext();
- if ($context === null) {
-
- return;
- }
- $providers = $context->getPreviewProviders();
- foreach ($providers as $provider) {
- $key = $provider->getMimeTypeRegex() . '-' . $provider->getService();
- if (array_key_exists($key, $this->loadedBootstrapProviders)) {
-
- continue;
- }
- $this->loadedBootstrapProviders[$key] = null;
- $this->registerProvider($provider->getMimeTypeRegex(), function () use ($provider) {
- try {
- return $this->container->get($provider->getService());
- } catch (QueryException $e) {
- return null;
- }
- });
- }
- }
-
- private function throwIfPreviewsDisabled(): void {
- if (!$this->enablePreviews) {
- throw new NotFoundException('Previews disabled');
- }
- }
- }
|