File Manager

Editing File: /usr/local/cpanel/base/3rdparty/roundcube/plugins/carddav/src/DelayedPhotoLoader.php

<?php

/*
 * RCMCardDAV - CardDAV plugin for Roundcube webmail
 *
 * Copyright (C) 2011-2022 Benjamin Schieder <rcmcarddav@wegwerf.anderdonau.de>,
 *                         Michael Stilkerich <ms@mike2k.de>
 *
 * This file is part of RCMCardDAV.
 *
 * RCMCardDAV is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * RCMCardDAV 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with RCMCardDAV. If not, see <https://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace MStilkerich\RCMCardDAV;

use Exception;
use Sabre\VObject;
use Sabre\VObject\Component\VCard;
use MStilkerich\CardDavClient\AddressbookCollection;

/**
 * This class is intended to delay the processing of photos until first use, and cache for later use.
 *
 * Generally, photos that can be used as stored in the VCard will not be put to the cache. Only photos that are
 * processed are stored to roundcube cache to avoid reprocessing in the future. Currently, this processing can be:
 *   - Photo is referenced as external URI from the VCard and must be downloaded
 *   - Photo is cropped because of a set X-ABCROP-RECTANGLE parameter
 *
 * Instead of storing the final photo data in the data set returned to roundcube, an object of this class is stored.
 * When roundcube actually requires the data, an implicit conversion to string of the proxy object is triggered, which
 * then causes the photo to be either retrieved from the VCard, from the roundcube cache, or otherwise the processing is
 * done at this point in time.
 *
 * The goal of this mechanism is to perform the potentially expensive operation of photo processing only when the photo
 * is actually needed, and particularly not during the synchronization operation (for all photos that are part of the
 * synced vcards).
 *
 * @psalm-type PhotoCacheObject array{photoPropMd5: string, photo: string}
 */
class DelayedPhotoLoader
{
    /**
     * @var int MAX_PHOTO_SIZE Maximum size of a photo dimension in pixels.
     *   Used when a photo is cropped for the X-ABCROP-RECTANGLE extension.
     */
    private const MAX_PHOTO_SIZE = 256;

/** @var ?string $photoData After the first serialization, the result is cached in this attribute. */
    private $photoData = null;

/** @var VCard $vcard The VCard the photo belongs to */
    private $vcard;

/** @var AddressbookCollection $davAbook Access to the CardDAV addressbook */
    private $davAbook;

public function __construct(
        VCard $vcard,
        AddressbookCollection $davAbook
    ) {
        $this->vcard = $vcard;
        $this->davAbook = $davAbook;
    }

/**
     * Retrieves the picture data.
     *
     * This is done as the implicit string conversion to allow triggering the retrieval in roundcube's code when the
     * photo data is actually requested.
     */
    public function __toString(): string
    {
        if (isset($this->photoData)) {
            return $this->photoData;
        }

try {
            $this->photoData = $this->computePhotoFromProperty();
            return $this->photoData;
        } catch (Exception $e) {
            return "";
        }
    }

/**
     * Tells whether the vcard export has been performed already by this exporter.
     * @return bool True if toString() was _not_ previously executed.
     * @noinspection PhpUnused This method is used by the tests only.
     */
    public function pristine(): bool
    {
        return !isset($this->photoData);
    }

/**
     * Computes the photo data from the PHOTO property.
     *
     * Processing and cache retrieval/update are performed as necessary.
     *
     * @throws Exception if the an error occurs
     * @return string The processed photo data. Empty string if not photo included in vcard.
     */
    private function computePhotoFromProperty(): string
    {
        $vcard = $this->vcard;
        $photoProp = $vcard->PHOTO;
        if (!isset($photoProp)) {
            return "";
        }

// First we determine whether the photo needs processing (download/crop)
        $cropProp = $photoProp['X-ABCROP-RECTANGLE'];

// check if photo needs to be downloaded
        $photoUri = null;
        $kind = $photoProp['VALUE'];
        if (($kind instanceof VObject\Parameter) && strcasecmp('uri', (string) $kind) == 0) {
            if (preg_match('#^([[:alpha:]][[:alnum:]]*)://#', (string) $photoProp, $matches)) {
                $scheme = strtolower($matches[1]);
                if ($scheme === 'http' || $scheme === 'https') {
                    $photoUri = (string) $photoProp;
                } else {
                    $infra = Config::inst();
                    $logger = $infra->logger();
                    $msg = "Unsupported URI scheme $scheme for PHOTO property";
                    $logger->warning($msg);
                    throw new \Exception($msg);
                }
            }
        }

// true if the photo must be processed (downloaded/cropped) and the result should be cached
        // Photo that are stored inline in the VCard and provided as is will not be put in the cache
        $cachePhoto = ($cropProp instanceof VObject\Parameter) || isset($photoUri);

// check roundcube cache
        if ($cachePhoto) {
            $photoData = $this->fetchFromRoundcubeCache($photoProp);
            if (isset($photoData)) {
                return $photoData;
            }
        }

// retrieve PHOTO data
        if (isset($photoUri)) {
            $photoData = $this->downloadPhoto($photoUri);
        } else {
            $photoData = (string) $photoProp;
        }

// crop photo if needed
        if (isset($photoData) && ($cropProp instanceof VObject\Parameter)) {
            $photoData = $this->xabcropphoto($photoData, $cropProp) ?? $photoData;
        }

// store to cache if requested
        if (isset($photoData) && $cachePhoto) {
            $this->storeToRoundcubeCache($photoData, $photoProp);
        }

if (isset($photoData)) {
            return $photoData;
        }

throw new \Exception('PHOTO value could not be computed');
    }

private function downloadPhoto(string $uri): ?string
    {
        try {
            $response = $this->davAbook->downloadResource($uri);
            return $response['body'];
        } catch (Exception $e) {
            $logger = Config::inst()->logger();
            $logger->warning("downloadPhoto: Attempt to download photo from $uri failed: " . $e->getMessage());
        }

return null;
    }

/**
     * Fetches the photo for this property from the roundcube cache (if available).
     *
     * The function checks that the cache object still matches the photo property, otherwise the cache object is pruned
     * and this function returns null to trigger a recomputation.
     *
     * @return ?string Returns the photo data from the roundcube cache, null if not present or outdated.
     */
    private function fetchFromRoundcubeCache(VObject\Property $photoProp): ?string
    {
        $infra = Config::inst();
        $cache = $infra->cache();
        $logger = $infra->logger();

$key = $this->determineCacheKey();
        /** @var ?PhotoCacheObject $cacheObject */
        $cacheObject = $cache->get($key);

if (!isset($cacheObject)) {
            $logger->debug(__METHOD__ . ": Roundcube cache miss (key: $key)!");
            return null;
        }

$logger->debug(__METHOD__ . ": Roundcube cache hit (key: $key)!");
        if (md5($photoProp->serialize()) !== $cacheObject["photoPropMd5"]) {
            $cache->remove($key);
            return null;
        }

return $cacheObject["photo"];
    }

/**
     * Stores the photo data to the roundcube cache.
     *
     * The cache object includes a checksum that allows to check whether the stored object matches a possibly changed
     * PHOTO property on future retrieval.
     */
    private function storeToRoundcubeCache(string $photoData, VObject\Property $photoProp): void
    {
        $infra = Config::inst();
        $cache = $infra->cache();

$photoPropMd5 = md5($photoProp->serialize());
        $cacheObject = [
            'photoPropMd5' => $photoPropMd5,
            'photo' => $photoData
        ];

$key = $this->determineCacheKey();
        $cache->set($key, $cacheObject);
    }

/**
     * Compute the key for this photo property in the roundcube cache.
     *
     * The key is composed of the following components separated by _:
     *   - a prefix "photo" (namespace to separate from other uses by the plugin)
     *   - a component including the user id of the roundcube user (only keys of logged-in user can be retrieved);
     *     probably not needed as the cache itself is user-specific, but just in case.
     *   - a component containing the MD5 of the card UID (to find a photo cached for a VCard)
     */
    private function determineCacheKey(): string
    {
        $uid = (string) $this->vcard->UID;

if (!isset($_SESSION['user_id'])) {
            $infra = Config::inst();
            $logger = $infra->logger();
            $msg = "determineCacheKey: user must be logged on to use photo cache";
            $logger->error($msg);
            throw new \Exception($msg);
        }

$userid = (string) $_SESSION['user_id'];

$key  = "photo_";
        $key .= $userid . "_" ;
        $key .= md5($uid);

return $key;
    }

/******************************************************************************************************************
     ************                                   +         +         +                                  ************
     ************                               X-ABCROP-RECTANGLE Extension                               ************
     ************                                   +         +         +                                  ************
     *****************************************************************************************************************/

/**
     * Crops the given photo if the PHOTO property contains an X-ABCROP-RECTANGLE parameter.
     *
     * The parameter looks like this:
     * X-ABCROP-RECTANGLE=ABClipRect_1&60&179&181&181&qZ54yqewvBZj2mycxrnqsA==
     *
     *  - The 1st number is the horizontal offset (X) from the left
     *  - The 2nd number is the vertical offset (Y) from the bottom
     *  - The 3rd number is the crop width
     *  - The 4th number is the crop height
     *
     * For tests, this operation can be done using imagemagick, geometry is width x height +OffsetX +OffsetY
     *  convert raven.jpg -gravity SouthWest -crop '181x181+60+179' ravencrop.png
     *
     * The meaning of the base64 encoded last part of the parameter is unknown and ignored.
     *
     * @return ?string The resulting cropped photo as binary string. Null in case the given photo was not modified,
     *                 e.g. for lack of the X-ABCROP-RECTANGLE parameter or GD is not available.
     */
    private function xabcropphoto(string $photoData, VObject\Parameter $cropProp): ?string
    {
        if (!function_exists('gd_info')) {
            // @codeCoverageIgnoreStart
            return null;
            // @codeCoverageIgnoreEnd
        }

$parts = explode('&', (string) $cropProp);
        $x = intval($parts[1]);
        $y = intval($parts[2]);
        $w = intval($parts[3]);
        $h = intval($parts[4]);
        $dw = min($w, self::MAX_PHOTO_SIZE);
        $dh = min($h, self::MAX_PHOTO_SIZE);

$croppedPhoto = null;

($obStarted = ob_start())
            && ($src = imagecreatefromstring($photoData))
            && ($dst = imagecreatetruecolor($dw, $dh))
            && ($imgHeight = imagesy($src))
            && imagecopyresampled($dst, $src, 0, 0, $x, $imgHeight - $y - $h, $dw, $dh, $w, $h)
            && imagepng($dst)
            && ($croppedPhoto = ob_get_contents());

if ($obStarted) {
            ob_end_clean();
        }

return $croppedPhoto;
    }
}

// vim: ts=4:sw=4:expandtab:fenc=utf8:ff=unix:tw=120

Back to Directory File Manager