class.ilUserAvatarResolver.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Language\Language;
use ILIAS\UI\Component\Symbol\Avatar\Avatar;
use ILIAS\UI\Factory;

class ilUserAvatarResolver
{
    private ilDBInterface $db;
    private \ILIAS\ResourceStorage\Services $irss;
    private Factory $ui;
    private Language $lng;
    private bool $letter_avatars_activated;
    private ilUserProfilePictureDefinition $flavour_definition;
    private string $size;
    private bool $is_current_user;
    private ilObjUser $for_user;
    private bool $has_public_upload = false;
    private bool $has_public_profile = false;
    private ilUserAvatarFactory $avatar_factory;
    private string $abbreviation = '';
    private ?string $rid = null;
    private bool $force_image = false;

    public function __construct(
        private int $user_id
    ) {
        global $DIC;
        $this->is_current_user = $DIC->user()->getId() === $this->user_id;
        $this->for_user = $this->is_current_user ? $DIC->user() : new ilObjUser($this->user_id);

        $this->db = $DIC->database();
        $this->irss = $DIC->resourceStorage();
        $this->ui = $DIC->ui()->factory();
        $this->lng = $DIC->language();
        $this->avatar_factory = $DIC["user.avatar.factory"];

        $this->letter_avatars_activated = (bool) $DIC->settings()->get('letter_avatars');
        $this->flavour_definition = new ilUserProfilePictureDefinition();
        $this->size = 'small';
        $this->readUserSettings();
    }

    private function readUserSettings(): void
    {
        $in = $this->db->in('usr_pref.keyword', ['public_upload', 'public_profile'], false, 'text');
        $res = $this->db->queryF(
            "
                        SELECT usr_data.rid, usr_pref.*
                        FROM usr_data LEFT JOIN usr_pref ON usr_pref.usr_id = usr_data.usr_id AND $in
                        WHERE usr_data.usr_id = %s",
            ['integer'],
            [$this->user_id]
        );

        while ($row = $this->db->fetchAssoc($res)) { // MUST be loop
            $this->rid = $row['rid'] ?? null;
            switch ($row['keyword']) {
                case 'public_upload':
                    $this->has_public_upload = $row['value'] === 'y';
                    break;
                case 'public_profile':
                    $this->has_public_profile = ($row['value'] === 'y' || $row['value'] === 'g');
                    break;
            }
        }

        if ($this->has_public_profile) {
            $sub_str_firstname = ilStr::subStr($this->for_user->getFirstname(), 0, 1);
            $sub_str_lastname = ilStr::subStr($this->for_user->getLastname(), 0, 1);
            $this->abbreviation = $sub_str_firstname . $sub_str_lastname;
        } else {
            $this->abbreviation = ilStr::subStr($this->for_user->getLogin(), 0, 2);
        }
    }

    public function hasProfilePicture(): bool
    {
        if (!$this->force_image) {
            if (!$this->has_public_profile || !$this->has_public_upload) {
                return false;
            }
        }

        if ($this->rid !== null && $this->irss->manage()->find($this->rid) !== null) {
            return true;
        }

        return false;
    }

    private function resolveProfilePicturePath(): string
    {
        $rid = $this->irss->manage()->find($this->rid);
        if ($rid === null) {
            return '';
        }
        $flavour = $this->irss->flavours()->get($rid, $this->flavour_definition);
        $urls = $this->irss->consume()->flavourUrls($flavour)->getURLsAsArray(false);

        $available_sizes = array_flip(array_keys($this->flavour_definition->getSizes()));
        $size_index = $available_sizes[$this->size];

        return $urls[$size_index] ?? '';
    }

    public function getAvatar(bool $name_as_set_as_text_closely = false): Avatar
    {
        if ($name_as_set_as_text_closely) {
            $alternative_text = $this->lng->txt("user_avatar");
        } elseif ($this->is_current_user && !$this->for_user->isAnonymous()) {
            $alternative_text = $this->lng->txt("current_user_avatar");
        } else {
            $alternative_text = $this->lng->txt("user_avatar_of") . " " . $this->for_user->getLogin();
        }

        if ($this->hasProfilePicture()) {
            $picture = $this->getLegacyPictureURL();
            return $this->ui->symbol()->avatar()->picture(
                $picture,
                $this->for_user->getLogin()
            )->withLabel($alternative_text);
        }

        // Fallback Image
        if ($this->letter_avatars_activated === false) {
            return $this->ui->symbol()->avatar()->picture(
                \ilUtil::getImagePath('placeholder/no_photo_xsmall.jpg'),
                $this->for_user->getLogin()
            );
        }

        return $this->ui->symbol()->avatar()->letter($this->abbreviation)->withLabel($alternative_text);
    }

    public function getUserPictureForVCard(): array
    {
        if (!$this->hasProfilePicture()) {
            return [null, null];
        }

        if ($this->rid !== null
            && $this->rid !== '-'
            && ($identification = $this->irss->manage()->find($this->rid)) !== null) {
            $flavour_streams = $this->irss->flavours()
                ->get($identification, $this->flavour_definition)
                ->getStreamResolvers();
            $available_sizes = array_flip(array_keys($this->flavour_definition->getSizes()));
            $size_index = $available_sizes[$this->size];
            if (!isset($flavour_streams[$size_index])) {
                return [null, null];
            }
            return [$flavour_streams[$size_index]->getStream()->__toString(), 'image/jpeg'];
        }

        return [null, null];
    }

    public function getLegacyPictureURL(): string
    {
        if ($this->hasProfilePicture()
            && $this->rid !== null && $this->rid !== '-') {
            return $this->resolveProfilePicturePath();
        }

        // LETTER AVATAR
        $avatar = $this->avatar_factory->avatar($this->size);
        $avatar->setName($this->abbreviation);
        $avatar->setUsrId($this->user_id);

        return $avatar->getUrl();
    }

    public function setForcePicture(bool $force_image): void
    {
        $this->force_image = $force_image;
    }

    public function setSize(string $size): void
    {
        $this->size = $size;
    }
}