<?php
/**
 * Orange Management
 *
 * PHP Version 7.4
 *
 * @package   Modules\Media\Models
 * @copyright Dennis Eichhorn
 * @license   OMS License 1.0
 * @version   1.0.0
 * @link      https://orange-management.org
 */
declare(strict_types=1);

namespace Modules\Media\Models;

/**
 * Media class.
 *
 * @package Modules\Media\Models
 * @license OMS License 1.0
 * @link    https://orange-management.org
 * @since   1.0.0
 */
class Media implements \JsonSerializable
{
    /**
     * ID.
     *
     * @var   int
     * @since 1.0.0
     */
    protected int $id = 0;

    /**
     * Name.
     *
     * @var   string
     * @since 1.0.0
     */
    protected string $name = '';

    /**
     * Extension.
     *
     * @var   string
     * @since 1.0.0
     */
    protected string $extension = '';

    /**
     * File size in bytes.
     *
     * @var   int
     * @since 1.0.0
     */
    protected int $size = 0;

    /**
     * Author.
     *
     * @var   int
     * @since 1.0.0
     */
    protected $createdBy = 0;

    /**
     * Uploaded.
     *
     * @var   \DateTime
     * @since 1.0.0
     */
    protected \DateTime $createdAt;

    /**
     * Resource path.
     *
     * @var   string
     * @since 1.0.0
     */
    protected string $path = '';

    /**
     * Virtual path.
     *
     * @var   string
     * @since 1.0.0
     */
    protected string $virtualPath = '/';

    /**
     * Is path absolute?
     *
     * @var   bool
     * @since 1.0.0
     */
    protected bool $isAbsolute = false;

    /**
     * Is versioned.
     *
     * @var   bool
     * @since 1.0.0
     */
    protected bool $versioned = false;

    /**
     * Media Description.
     *
     * @var   string
     * @since 1.0.0
     */
    protected string $description = '';

    /**
     * Media Description.
     *
     * @var   string
     * @since 1.0.0
     */
    protected string $descriptionRaw = '';

    /**
     * Media encryption nonce.
     *
     * @var   null|string
     * @since 1.0.0
     */
    protected ?string $nonce = null;

    /**
     * Media password hash.
     *
     * @var   null|string
     * @since 1.0.0
     */
    protected ?string $password = null;

    /**
     * Constructor.
     *
     * @since 1.0.0
     */
    public function __construct()
    {
        $this->createdAt = new \DateTime();
    }

    /**
     * @return int
     *
     * @since 1.0.0
     */
    public function getId() : int
    {
        return $this->id;
    }

    /**
     * Encrypt the media file
     *
     * @param string      $password   Password to encrypt the file with
     * @param null|string $outputPath Output path of the encryption (null = replace file)
     *
     * @return void
     *
     * @since 1.0.0
     */
    public function encrypt(string $password, string $outputPath = null) : void
    {
        /**
         * @todo Orange-Management/Modules#185
         *  Sometimes it's important to protect sensitive information. Therefore an encryption for media files becomes necessary.
         *  The media module should allow to define a password (not encrypted on the hard drive)
         *  and an encryption checkbox which forces a password AND encrypts the file on the harddrive.
         */
    }

    /**
     * Decrypt the media file
     *
     * @param string      $password   Password to encrypt the file with
     * @param null|string $outputPath Output path of the encryption (null = replace file)
     *
     * @return void
     *
     * @since 1.0.0
     */
    public function decrypt(string $password, string $outputPath) : string
    {
        /**
         * @todo Orange-Management/Modules#185
         *  Sometimes it's important to protect sensitive information. Therefore an encryption for media files becomes necessary.
         *  The media module should allow to define a password (not encrypted on the hard drive)
         *  and an encryption checkbox which forces a password AND encrypts the file on the harddrive.
         */

        return '';
    }

    /**
     * Set encryption nonce
     *
     * @param null|string $nonce Nonce from encryption password
     *
     * @return void
     *
     * @since 1.0.0
     */
    public function setNonce(?string $nonce) : void
    {
        $this->nonce = $nonce;
    }

    /**
     * Is media file encrypted?
     *
     * @return bool
     *
     * @since 1.0.0
     */
    public function isEncrypted() : bool
    {
        return $this->nonce !== null;
    }

    /**
     * Set encryption password
     *
     * @param null|string $password Password
     *
     * @return void
     *
     * @since 1.0.0
     */
    public function setPassword(?string $password) : void
    {
        $this->password = $password;
    }

    /**
     * Compare user password with password of the media file
     *
     * @param string $password User password
     *
     * @return bool
     *
     * @since 1.0.0
     */
    public function comparePassword(string $password) : bool
    {
        return \password_verify($password, $this->password ?? '');
    }

    /**
     * Compare nonce with encryption nonce of the media file
     *
     * @param string $nonce User nonce
     *
     * @return bool
     *
     * @since 1.0.0
     */
    public function compareNonce(string $nonce) : bool
    {
        return \hash_equals($this->nonce, $nonce);
    }

    /**
     * @return bool
     *
     * @since 1.0.0
     */
    public function isAbsolute() : bool
    {
        return $this->isAbsolute;
    }

    /**
     * @return void
     *
     * @since 1.0.0
     */
    public function setAbsolute(bool $absolute) : void
    {
        $this->isAbsolute = $absolute;
    }

    /**
     * @return int|\phpOMS\Account\Account
     *
     * @since 1.0.0
     */
    public function getCreatedBy()
    {
        return $this->createdBy;
    }

    /**
     * @return \DateTime
     *
     * @since 1.0.0
     */
    public function getCreatedAt() : \DateTime
    {
        return $this->createdAt ?? new \DateTime('now');
    }

    /**
     * @return string
     *
     * @since 1.0.0
     */
    public function getExtension() : string
    {
        return $this->extension;
    }

    /**
     * @return string
     *
     * @since 1.0.0
     */
    public function getPath() : string
    {
        return $this->path;
    }

     /**
     * @return string
     *
     * @since 1.0.0
     */
    public function getVirtualPath() : string
    {
        return $this->virtualPath;
    }

    /**
     * @return string
     *
     * @since 1.0.0
     */
    public function getName() : string
    {
        return $this->name;
    }

    /**
     * @return string
     *
     * @since 1.0.0
     */
    public function getDescription() : string
    {
        return $this->description;
    }

    /**
     * @return string
     *
     * @since 1.0.0
     */
    public function getDescriptionRaw() : string
    {
        return $this->descriptionRaw;
    }

    /**
     * @return int
     *
     * @since 1.0.0
     */
    public function getSize() : int
    {
        return $this->size;
    }

    /**
     * @return bool
     *
     * @since 1.0.0
     */
    public function isVersioned() : bool
    {
        return $this->versioned;
    }

    /**
     * @param mixed $createdBy Creator
     *
     * @return void
     *
     * @since 1.0.0
     */
    public function setCreatedBy($createdBy) : void
    {
        $this->createdBy = $createdBy;
    }

    /**
     * @param string $extension Extension
     *
     * @return void
     *
     * @since 1.0.0
     */
    public function setExtension(string $extension) : void
    {
        $this->extension = $extension;
    }

    /**
     * @param string $path $filepath
     *
     * @return void
     *
     * @since 1.0.0
     */
    public function setPath(string $path) : void
    {
        $this->path = \str_replace('\\', '/', $path);
    }

    /**
     * @param string $path $filepath
     *
     * @return void
     *
     * @since 1.0.0
     */
    public function setVirtualPath(string $path) : void
    {
        $this->virtualPath = \str_replace('\\', '/', $path);
    }

    /**
     * @param string $name Media name (not file name)
     *
     * @return void
     *
     * @since 1.0.0
     */
    public function setName(string $name) : void
    {
        $this->name = $name;
    }

    /**
     * @param string $description Media description
     *
     * @return void
     *
     * @since 1.0.0
     */
    public function setDescription(string $description) : void
    {
        $this->description = $description;
    }

    /**
     * @param string $description Media description
     *
     * @return void
     *
     * @since 1.0.0
     */
    public function setDescriptionRaw(string $description) : void
    {
        $this->descriptionRaw = $description;
    }

    /**
     * @param int $size Filesize
     *
     * @return void
     *
     * @since 1.0.0
     */
    public function setSize(int $size) : void
    {
        $this->size = $size;
    }

    /**
     * @param bool $versioned File is version controlled
     *
     * @return void
     *
     * @since 1.0.0
     */
    public function setVersioned(bool $versioned) : void
    {
        $this->versioned = $versioned;
    }

    /**
     * {@inheritdoc}
     */
    public function toArray() : array
    {
        return [
            'id'          => $this->id,
            'name'        => $this->name,
            'description' => $this->description,
            'extension'   => $this->extension,
            'size'        => $this->size,
        ];
    }

    /**
     * {@inheritdoc}
     */
    public function jsonSerialize()
    {
        return $this->toArray();
    }
}