Saito\User\Upload\AvatarFilenameListener

Complexity

Total Complexity

12

Size/Duplication

Total Lines	108
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	implementedEvents()	0	5	1
A	change()	0	35	5
A	__construct()	0	3	1
A	onModelAfterSaveCommit()	0	9	3
A	deleteExistingFilesForUser()	0	8	2

<?php

declare(strict_types=1);

/**
 * Saito - The Threaded Web Forum
 *
 * @copyright Copyright (c) the Saito Project Developers
 * @link https://github.com/Schlaefer/Saito
 * @license http://opensource.org/licenses/MIT
 */

namespace Saito\User\Upload;

use App\Model\Entity\User;
use Cake\Core\Configure;
use Cake\Event\Event;
use Cake\Event\EventListenerInterface;
use Cake\Filesystem\Folder;
use Cake\ORM\Entity;
use Cake\Utility\Text;
use Proffer\Lib\ProfferPath;

/**
 * Handles files for Avatars-Images
 */
class AvatarFilenameListener implements EventListenerInterface
{
    /**
     * Upload root directory
     *
     * @var string
     */
    private $rootDirectory;

    /**
     * Constructor
     *
     * @param string $rootDirectory the upload root
     */
    public function __construct(string $rootDirectory)
    {
        $this->rootDirectory = $rootDirectory;
    }

    /**
     * {@inheritDoc}
     */
    public function implementedEvents()
    {
        return [
            'Proffer.afterPath' => 'change',
            'Model.afterSaveCommit' => 'onModelAfterSaveCommit',
        ];
    }

    /**
     * Rename a file and change it's upload folder before it's processed
     *
     * @param Event $event The event class with a subject of the entity
     * @param ProfferPath $path path
     * @return ProfferPath $path
     */
    public function change(Event $event, ProfferPath $path)
    {
        /** @var User $user */
        $user = $event->getSubject();

        if ($user->isDirty('avatar')) {
            $this->deleteExistingFilesForUser($user);
        }

        // Detect and select the right file extension
        switch ($user->get('avatar')['type']) {
            default:
            case "image/jpeg":
                $ext = '.jpg';
                break;
            case "image/png":
                $ext = '.png';
                break;
        }

        // `webroot/files/<table>/<field>/<seed>/<file>`

        $newFilename = Text::uuid() . $ext;

        // $path->setTable('avatars');

        $imgDir = $user->get('avatar_dir') ?: $user->get('id');
        $path->setSeed($imgDir);

        // Change the filename in both the path to be saved, and in the entity data for saving to the db
        $path->setFilename($newFilename);
        $user['avatar']['name'] = $newFilename;

        // Must return the modified path instance, so that things are saved in the right place
        return $path;
    }

    /**
     * Handle delete files if avatar is unset in DB
     *
     * Proffer only handles deleting an image when DB row is deleting, but
     * we don't delete the user, only set the avatar image null.
     *
     * @param Event $event event
     * @return void
     */
    public function onModelAfterSaveCommit(Event $event): void
    {
        /** @var User $user */
        $user = $event->getData('entity');
        $avatar = $user->get('avatar');
        if (!$user->isDirty('avatar') || !empty($avatar)) {
            return;
        }
        $this->deleteExistingFilesForUser($user);
    }

    /**
     * Delete existing avatar images for a user
     *
     * @param User $user user
     * @return void
     */
    private function deleteExistingFilesForUser(User $user): void
    {
        $dir = $user->get('id');
        if (!empty($dir)) {
            $folder = new Folder(
                $this->rootDirectory . '/users/avatar/' . $dir
            );
            $folder->delete();
        }
    }
}