* * @author Arthur Schiwon * @author Christoph Wurst * @author Daniel Kesselberg * @author Jacob Neplokh * @author Joas Schilling * @author John Molakvoæ * @author Morris Jobke * @author Roeland Jago Douma * * @license GNU AGPL version 3 or any later version * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as * published by the Free Software Foundation, either version 3 of the * License, or (at your option) any later version. * * 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 * along with this program. If not, see . * */ namespace OCA\DAV\CardDAV; use OCP\Files\IAppData; use OCP\Files\NotFoundException; use OCP\Files\NotPermittedException; use OCP\Files\SimpleFS\ISimpleFile; use OCP\Files\SimpleFS\ISimpleFolder; use Sabre\CardDAV\Card; use Sabre\VObject\Document; use Sabre\VObject\Parameter; use Sabre\VObject\Property\Binary; use Sabre\VObject\Reader; use Psr\Log\LoggerInterface; class PhotoCache { /** @var array */ public const ALLOWED_CONTENT_TYPES = [ 'image/png' => 'png', 'image/jpeg' => 'jpg', 'image/gif' => 'gif', 'image/vnd.microsoft.icon' => 'ico', ]; protected IAppData $appData; protected LoggerInterface $logger; /** * PhotoCache constructor. */ public function __construct(IAppData $appData, LoggerInterface $logger) { $this->appData = $appData; $this->logger = $logger; } /** * @throws NotFoundException */ public function get(int $addressBookId, string $cardUri, int $size, Card $card): ISimpleFile { $folder = $this->getFolder($addressBookId, $cardUri); if ($this->isEmpty($folder)) { $this->init($folder, $card); } if (!$this->hasPhoto($folder)) { throw new NotFoundException(); } if ($size !== -1) { $size = 2 ** ceil(log($size) / log(2)); } return $this->getFile($folder, $size); } private function isEmpty(ISimpleFolder $folder): bool { return $folder->getDirectoryListing() === []; } /** * @throws NotPermittedException */ private function init(ISimpleFolder $folder, Card $card): void { $data = $this->getPhoto($card); if ($data === false || !isset($data['Content-Type'])) { $folder->newFile('nophoto', ''); return; } $contentType = $data['Content-Type']; $extension = self::ALLOWED_CONTENT_TYPES[$contentType] ?? null; if ($extension === null) { $folder->newFile('nophoto', ''); return; } $file = $folder->newFile('photo.' . $extension); $file->putContent($data['body']); } private function hasPhoto(ISimpleFolder $folder): bool { return !$folder->fileExists('nophoto'); } /** * @param float|-1 $size */ private function getFile(ISimpleFolder $folder, $size): ISimpleFile { $ext = $this->getExtension($folder); if ($size === -1) { $path = 'photo.' . $ext; } else { $path = 'photo.' . $size . '.' . $ext; } try { $file = $folder->getFile($path); } catch (NotFoundException $e) { if ($size <= 0) { throw new NotFoundException; } $photo = new \OCP\Image(); /** @var ISimpleFile $file */ $file = $folder->getFile('photo.' . $ext); $photo->loadFromData($file->getContent()); $ratio = $photo->width() / $photo->height(); if ($ratio < 1) { $ratio = 1 / $ratio; } $size = (int) ($size * $ratio); if ($size !== -1) { $photo->resize($size); } try { $file = $folder->newFile($path); $file->putContent($photo->data()); } catch (NotPermittedException $e) { } } return $file; } /** * @throws NotFoundException * @throws NotPermittedException */ private function getFolder(int $addressBookId, string $cardUri, bool $createIfNotExists = true): ISimpleFolder { $hash = md5($addressBookId . ' ' . $cardUri); try { return $this->appData->getFolder($hash); } catch (NotFoundException $e) { if ($createIfNotExists) { return $this->appData->newFolder($hash); } else { throw $e; } } } /** * Get the extension of the avatar. If there is no avatar throw Exception * * @throws NotFoundException */ private function getExtension(ISimpleFolder $folder): string { foreach (self::ALLOWED_CONTENT_TYPES as $extension) { if ($folder->fileExists('photo.' . $extension)) { return $extension; } } throw new NotFoundException('Avatar not found'); } /** * @param Card $node * @return false|array{body: string, Content-Type: string} */ private function getPhoto(Card $node) { try { $vObject = $this->readCard($node->get()); return $this->getPhotoFromVObject($vObject); } catch (\Exception $e) { $this->logger->error('Exception during vcard photo parsing', [ 'exception' => $e ]); } return false; } /** * @return false|array{body: string, Content-Type: string} */ public function getPhotoFromVObject(Document $vObject) { try { if (!$vObject->PHOTO) { return false; } $photo = $vObject->PHOTO; $val = $photo->getValue(); // handle data URI. e.g PHOTO;VALUE=URI:data:image/jpeg;base64,/9j/4AAQSkZJRgABAQE if ($photo->getValueType() === 'URI') { $parsed = \Sabre\URI\parse($val); // only allow data:// if ($parsed['scheme'] !== 'data') { return false; } if (substr_count($parsed['path'], ';') === 1) { [$type] = explode(';', $parsed['path']); } $val = file_get_contents($val); } else { // get type if binary data $type = $this->getBinaryType($photo); } if (empty($type) || !isset(self::ALLOWED_CONTENT_TYPES[$type])) { $type = 'application/octet-stream'; } return [ 'Content-Type' => $type, 'body' => $val ]; } catch (\Exception $e) { $this->logger->error('Exception during vcard photo parsing', [ 'exception' => $e ]); } return false; } private function readCard(string $cardData): Document { return Reader::read($cardData); } /** * @param Binary $photo * @return string */ private function getBinaryType(Binary $photo) { $params = $photo->parameters(); if (isset($params['TYPE']) || isset($params['MEDIATYPE'])) { /** @var Parameter $typeParam */ $typeParam = isset($params['TYPE']) ? $params['TYPE'] : $params['MEDIATYPE']; $type = $typeParam->getValue(); if (strpos($type, 'image/') === 0) { return $type; } else { return 'image/' . strtolower($type); } } return ''; } /** * @param int $addressBookId * @param string $cardUri * @throws NotPermittedException */ public function delete($addressBookId, $cardUri) { try { $folder = $this->getFolder($addressBookId, $cardUri, false); $folder->delete(); } catch (NotFoundException $e) { // that's OK, nothing to do } } }