first commit

typo3/sysext/backend/Classes/Backend/Avatar/Avatar.php

@@ -0,0 +1,208 @@
+<?php
+
+namespace TYPO3\CMS\Backend\Backend\Avatar;
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+use TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
+use TYPO3\CMS\Core\Cache\CacheManager;
+use TYPO3\CMS\Core\Cache\Frontend\FrontendInterface;
+use TYPO3\CMS\Core\Service\DependencyOrderingService;
+use TYPO3\CMS\Core\Utility\GeneralUtility;
+use TYPO3\CMS\Core\Utility\PathUtility;
+use TYPO3\CMS\Fluid\View\StandaloneView;
+
+/**
+ * Main class to render an avatar image of a certain Backend user, resolving any avatar provider
+ * that takes care of fetching the image.
+ *
+ * See render() and getImgTag() as main entry points
+ */
+class Avatar
+{
+    /**
+     * Array of sorted and initialized avatar providers
+     *
+     * @var AvatarProviderInterface[]
+     */
+    protected $avatarProviders = [];
+
+    /**
+     * Renders an avatar based on a Fluid template which contains some base wrapper classes and does
+     * a simple caching functionality, used in Avatar ViewHelper for instance
+     *
+     * @param array $backendUser be_users record
+     * @param int $size width and height of the image
+     * @param bool $showIcon show the record icon
+     * @return string
+     */
+    public function render(array $backendUser = null, int $size = 32, bool $showIcon = false)
+    {
+        if (!is_array($backendUser)) {
+            $backendUser = $this->getBackendUser()->user;
+        }
+
+        $cacheId = 'avatar_' . md5(
+            $backendUser['uid'] . '/' .
+            (string)$size . '/' .
+            (string)$showIcon
+        );
+
+        $avatar = $this->getCache()->get($cacheId);
+
+        if (!$avatar) {
+            $this->validateSortAndInitiateAvatarProviders();
+            $view = $this->getFluidTemplateObject();
+
+            $view->assignMultiple([
+                'image' => $this->getImgTag($backendUser, $size),
+                'showIcon' => $showIcon,
+                'backendUser' => $backendUser
+            ]);
+            $avatar = $view->render();
+            $this->getCache()->set($cacheId, $avatar);
+        }
+
+        return $avatar;
+    }
+
+    /**
+     * Returns an HTML <img> tag for the avatar
+     *
+     * @param array $backendUser be_users record
+     * @param int $size
+     * @return string
+     */
+    public function getImgTag(array $backendUser = null, $size = 32)
+    {
+        if (!is_array($backendUser)) {
+            $backendUser = $this->getBackendUser()->user;
+        }
+
+        $avatarImage = false;
+        if ($backendUser !== null) {
+            $avatarImage = $this->getImage($backendUser, $size);
+        }
+
+        if (!$avatarImage) {
+            $avatarImage = GeneralUtility::makeInstance(
+                Image::class,
+                PathUtility::stripPathSitePrefix(GeneralUtility::getFileAbsFileName('EXT:core/Resources/Public/Icons/T3Icons/avatar/avatar-default.svg')),
+                $size,
+                $size
+            );
+        }
+        $imageTag = '<img src="' . htmlspecialchars($avatarImage->getUrl(true)) . '" ' .
+            'width="' . (int)$avatarImage->getWidth() . '" ' .
+            'height="' . (int)$avatarImage->getHeight() . '" />';
+
+        return $imageTag;
+    }
+
+    /**
+     * Get Image from first provider that returns one
+     *
+     * @param array $backendUser be_users record
+     * @param int $size
+     * @return Image|null
+     */
+    public function getImage(array $backendUser, $size)
+    {
+        foreach ($this->avatarProviders as $provider) {
+            $avatarImage = $provider->getImage($backendUser, $size);
+            if (!empty($avatarImage)) {
+                return $avatarImage;
+            }
+        }
+        return null;
+    }
+
+    /**
+     * Validates the registered avatar providers
+     *
+     * @throws \RuntimeException
+     */
+    protected function validateSortAndInitiateAvatarProviders()
+    {
+        $providers = $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['backend']['avatarProviders'] ?? [];
+        if (empty($providers)) {
+            return;
+        }
+        foreach ($providers as $identifier => $configuration) {
+            if (empty($configuration) || !is_array($configuration)) {
+                throw new \RuntimeException(
+                    'Missing configuration for avatar provider "' . $identifier . '".',
+                    1439317801
+                );
+            }
+            if (!is_string($configuration['provider']) || empty($configuration['provider']) || !class_exists($configuration['provider']) || !is_subclass_of(
+                $configuration['provider'],
+                AvatarProviderInterface::class
+            )) {
+                throw new \RuntimeException(
+                    'The avatar provider "' . $identifier . '" defines an invalid provider. Ensure the class exists and implements the "' . AvatarProviderInterface::class . '".',
+                    1439317802
+                );
+            }
+        }
+
+        $orderedProviders = GeneralUtility::makeInstance(DependencyOrderingService::class)->orderByDependencies($providers);
+
+        // Initializes providers
+        foreach ($orderedProviders as $configuration) {
+            $this->avatarProviders[] = GeneralUtility::makeInstance($configuration['provider']);
+        }
+    }
+
+    /**
+     * Returns the current BE user.
+     *
+     * @return BackendUserAuthentication
+     */
+    protected function getBackendUser()
+    {
+        return $GLOBALS['BE_USER'];
+    }
+
+    /**
+     * Returns a new standalone view, shorthand function
+     *
+     * @param string $filename Which templateFile should be used.
+     * @return StandaloneView
+     */
+    protected function getFluidTemplateObject(string $filename = null): StandaloneView
+    {
+        $view = GeneralUtility::makeInstance(StandaloneView::class);
+        $view->setLayoutRootPaths([GeneralUtility::getFileAbsFileName('EXT:backend/Resources/Private/Layouts')]);
+        $view->setPartialRootPaths([GeneralUtility::getFileAbsFileName('EXT:backend/Resources/Private/Partials')]);
+        $view->setTemplateRootPaths([GeneralUtility::getFileAbsFileName('EXT:backend/Resources/Private/Templates')]);
+
+        if ($filename === null) {
+            $filename = 'Main.html';
+        }
+
+        $view->setTemplatePathAndFilename(GeneralUtility::getFileAbsFileName('EXT:backend/Resources/Private/Templates/Avatar/' . $filename));
+
+        $view->getRequest()->setControllerExtensionName('Backend');
+        return $view;
+    }
+
+    /**
+     * @return FrontendInterface
+     */
+    protected function getCache()
+    {
+        return GeneralUtility::makeInstance(CacheManager::class)->getCache('cache_runtime');
+    }
+}

typo3/sysext/backend/Classes/Backend/Avatar/AvatarProviderInterface.php

@@ -0,0 +1,30 @@
+<?php
+namespace TYPO3\CMS\Backend\Backend\Avatar;
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+/**
+ * Contract for avatar providers that ensure how an avater should be rendered for a given Backend User
+ */
+interface AvatarProviderInterface
+{
+    /**
+     * Returns an Image object, prepared for output, based on a given be_users record
+     *
+     * @param array $backendUser be_users record
+     * @param int $size
+     * @return Image|null
+     */
+    public function getImage(array $backendUser, $size);
+}

typo3/sysext/backend/Classes/Backend/Avatar/DefaultAvatarProvider.php

@@ -0,0 +1,100 @@
+<?php
+namespace TYPO3\CMS\Backend\Backend\Avatar;
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+use TYPO3\CMS\Core\Database\ConnectionPool;
+use TYPO3\CMS\Core\Resource\Exception\FileDoesNotExistException;
+use TYPO3\CMS\Core\Resource\ProcessedFile;
+use TYPO3\CMS\Core\Resource\ResourceFactory;
+use TYPO3\CMS\Core\Utility\GeneralUtility;
+
+/**
+ * Avatar Provider used for rendering avatars based on local files (based on FAL), stored in the be_users.avatar
+ * relation field with sys_file_reference.
+ */
+class DefaultAvatarProvider implements AvatarProviderInterface
+{
+    /**
+     * Return an Image object for rendering the avatar, based on a FAL-based file
+     *
+     * @param array $backendUser be_users record
+     * @param int $size
+     * @return Image|null
+     */
+    public function getImage(array $backendUser, $size)
+    {
+        $fileUid = $this->getAvatarFileUid($backendUser['uid']);
+        if ($fileUid === 0) {
+            // Early return if there is no valid image file UID
+            return null;
+        }
+        // Get file object
+        try {
+            $file = ResourceFactory::getInstance()->getFileObject($fileUid);
+            $processedImage = $file->process(
+                ProcessedFile::CONTEXT_IMAGECROPSCALEMASK,
+                ['width' => $size . 'c', 'height' => $size . 'c']
+            );
+
+            $image = GeneralUtility::makeInstance(
+                Image::class,
+                $processedImage->getPublicUrl(),
+                $processedImage->getProperty('width'),
+                $processedImage->getProperty('height')
+            );
+        } catch (FileDoesNotExistException $e) {
+            // No image found
+            $image = null;
+        }
+
+        return $image;
+    }
+
+    /**
+     * Get the sys_file UID of the avatar of the given backend user ID
+     *
+     * @param int $backendUserId the UID of the be_users record
+     * @return int the sys_file UID or 0 if none found
+     */
+    protected function getAvatarFileUid($backendUserId)
+    {
+        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable('sys_file_reference');
+        $fileUid = $queryBuilder
+            ->select('uid_local')
+            ->from('sys_file_reference')
+            ->where(
+                $queryBuilder->expr()->eq(
+                    'tablenames',
+                    $queryBuilder->createNamedParameter('be_users', \PDO::PARAM_STR)
+                ),
+                $queryBuilder->expr()->eq(
+                    'fieldname',
+                    $queryBuilder->createNamedParameter('avatar', \PDO::PARAM_STR)
+                ),
+                $queryBuilder->expr()->eq(
+                    'table_local',
+                    $queryBuilder->createNamedParameter('sys_file', \PDO::PARAM_STR)
+                ),
+                $queryBuilder->expr()->eq(
+                    'uid_foreign',
+                    $queryBuilder->createNamedParameter((int)$backendUserId, \PDO::PARAM_INT)
+                )
+            )
+            ->execute()
+            ->fetchColumn();
+
+        return (int)$fileUid;
+    }
+}

typo3/sysext/backend/Classes/Backend/Avatar/Image.php

@@ -0,0 +1,86 @@
+<?php
+namespace TYPO3\CMS\Backend\Backend\Avatar;
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+use TYPO3\CMS\Core\Core\Environment;
+use TYPO3\CMS\Core\Utility\GeneralUtility;
+use TYPO3\CMS\Core\Utility\PathUtility;
+
+/**
+ * Acts as a pseudo model for holding all information of an avatar image
+ * Holds url + dimensions of avatar image
+ */
+class Image
+{
+    /**
+     * Url of avatar image. Needs to be relative to the website root or an absolute URL.
+     *
+     * @var string
+     */
+    protected $url;
+
+    /**
+     * @var int
+     */
+    protected $width;
+
+    /**
+     * @var int
+     */
+    protected $height;
+
+    /**
+     * @param string $url url of image. Needs to be relative to the website root or an absolute URL.
+     * @param int $width width of image
+     * @param int $height height of image
+     */
+    public function __construct($url, $width, $height)
+    {
+        $this->url = $url;
+        $this->width = (int)$width;
+        $this->height = (int)$height;
+    }
+
+    /**
+     * Fetches the URL to the the avatar image
+     *
+     * @param bool $relativeToCurrentScript Determines whether the URL returned should be relative to the current script, in case it is relative at all.
+     * @return string
+     */
+    public function getUrl($relativeToCurrentScript = false)
+    {
+        $url = $this->url;
+        if ($relativeToCurrentScript && !GeneralUtility::isValidUrl($url)) {
+            $url = PathUtility::getAbsoluteWebPath(Environment::getPublicPath() . '/' . $url);
+        }
+        return $url;
+    }
+
+    /**
+     * @return int
+     */
+    public function getWidth()
+    {
+        return $this->width;
+    }
+
+    /**
+     * @return int
+     */
+    public function getHeight()
+    {
+        return $this->height;
+    }
+}