2015-01-22 16:18:56 +00:00
|
|
|
<?php
|
|
|
|
|
2024-02-19 00:30:12 +00:00
|
|
|
namespace Wallabag\Entity;
|
2015-01-22 16:18:56 +00:00
|
|
|
|
2015-02-06 14:18:54 +00:00
|
|
|
use Doctrine\Common\Collections\ArrayCollection;
|
2015-01-22 16:18:56 +00:00
|
|
|
use Doctrine\ORM\Mapping as ORM;
|
2017-07-01 07:52:38 +00:00
|
|
|
use FOS\UserBundle\Model\User as BaseUser;
|
|
|
|
use JMS\Serializer\Annotation\Accessor;
|
2017-04-29 17:22:50 +00:00
|
|
|
use JMS\Serializer\Annotation\Groups;
|
2017-05-30 05:56:01 +00:00
|
|
|
use JMS\Serializer\Annotation\XmlRoot;
|
2023-07-02 06:27:07 +00:00
|
|
|
use Nelmio\ApiDocBundle\Annotation\Model;
|
|
|
|
use OpenApi\Annotations as OA;
|
2018-12-03 05:51:06 +00:00
|
|
|
use Scheb\TwoFactorBundle\Model\BackupCodeInterface;
|
2018-12-02 11:43:05 +00:00
|
|
|
use Scheb\TwoFactorBundle\Model\Email\TwoFactorInterface as EmailTwoFactorInterface;
|
|
|
|
use Scheb\TwoFactorBundle\Model\Google\TwoFactorInterface as GoogleTwoFactorInterface;
|
2015-12-22 09:16:34 +00:00
|
|
|
use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
|
2024-02-19 00:30:12 +00:00
|
|
|
use Wallabag\Entity\Api\Client;
|
|
|
|
use Wallabag\Helper\EntityTimestampsTrait;
|
2015-01-22 16:18:56 +00:00
|
|
|
|
|
|
|
/**
|
2015-05-30 11:52:26 +00:00
|
|
|
* User.
|
2015-01-22 16:18:56 +00:00
|
|
|
*
|
2017-05-30 05:56:01 +00:00
|
|
|
* @XmlRoot("user")
|
2024-02-19 00:30:12 +00:00
|
|
|
* @ORM\Entity(repositoryClass="Wallabag\Repository\UserRepository")
|
2015-10-24 13:28:02 +00:00
|
|
|
* @ORM\Table(name="`user`")
|
2015-02-06 13:18:01 +00:00
|
|
|
* @ORM\HasLifecycleCallbacks()
|
2015-03-27 23:10:39 +00:00
|
|
|
*
|
|
|
|
* @UniqueEntity("email")
|
|
|
|
* @UniqueEntity("username")
|
2015-01-22 16:18:56 +00:00
|
|
|
*/
|
2018-12-03 05:51:06 +00:00
|
|
|
class User extends BaseUser implements EmailTwoFactorInterface, GoogleTwoFactorInterface, BackupCodeInterface
|
2015-01-22 16:18:56 +00:00
|
|
|
{
|
2017-07-06 07:00:37 +00:00
|
|
|
use EntityTimestampsTrait;
|
|
|
|
|
2017-05-30 05:56:01 +00:00
|
|
|
/** @Serializer\XmlAttribute */
|
2015-01-22 16:18:56 +00:00
|
|
|
/**
|
2015-05-30 11:52:26 +00:00
|
|
|
* @var int
|
2015-01-22 16:18:56 +00:00
|
|
|
*
|
2015-02-06 13:18:01 +00:00
|
|
|
* @ORM\Column(name="id", type="integer")
|
2015-01-22 16:18:56 +00:00
|
|
|
* @ORM\Id
|
2015-02-06 13:18:01 +00:00
|
|
|
* @ORM\GeneratedValue(strategy="AUTO")
|
2017-05-30 05:56:01 +00:00
|
|
|
*
|
2023-07-02 06:27:07 +00:00
|
|
|
* @OA\Property(
|
|
|
|
* description="The unique numeric id of the user",
|
|
|
|
* type="int",
|
|
|
|
* example=12,
|
|
|
|
* )
|
|
|
|
*
|
2017-06-07 21:23:28 +00:00
|
|
|
* @Groups({"user_api", "user_api_with_client"})
|
2015-01-22 16:18:56 +00:00
|
|
|
*/
|
2015-08-18 09:08:45 +00:00
|
|
|
protected $id;
|
2015-01-22 16:18:56 +00:00
|
|
|
|
|
|
|
/**
|
2023-11-16 08:36:47 +00:00
|
|
|
* @var string|null
|
2015-01-22 16:18:56 +00:00
|
|
|
*
|
|
|
|
* @ORM\Column(name="name", type="text", nullable=true)
|
2017-05-30 05:56:01 +00:00
|
|
|
*
|
2023-07-02 06:27:07 +00:00
|
|
|
* @OA\Property(
|
|
|
|
* description="The personal Name of the user",
|
|
|
|
* type="string",
|
|
|
|
* example="Walla Baggger",
|
|
|
|
* )
|
|
|
|
*
|
2017-06-07 21:23:28 +00:00
|
|
|
* @Groups({"user_api", "user_api_with_client"})
|
2015-01-22 16:18:56 +00:00
|
|
|
*/
|
2015-08-18 09:08:45 +00:00
|
|
|
protected $name;
|
2015-03-07 22:25:36 +00:00
|
|
|
|
2017-05-30 05:56:01 +00:00
|
|
|
/**
|
|
|
|
* @var string
|
|
|
|
*
|
2023-07-02 06:27:07 +00:00
|
|
|
* @OA\Property(
|
|
|
|
* description="The unique username of the user",
|
|
|
|
* type="string",
|
|
|
|
* example="wallabag",
|
|
|
|
* )
|
|
|
|
*
|
2017-06-07 21:23:28 +00:00
|
|
|
* @Groups({"user_api", "user_api_with_client"})
|
2017-05-30 05:56:01 +00:00
|
|
|
*/
|
|
|
|
protected $username;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @var string
|
|
|
|
*
|
2023-07-02 06:27:07 +00:00
|
|
|
* @OA\Property(
|
|
|
|
* description="E-mail address of the user",
|
|
|
|
* type="string",
|
|
|
|
* example="wallabag@wallabag.io",
|
|
|
|
* )
|
|
|
|
*
|
2017-06-07 21:23:28 +00:00
|
|
|
* @Groups({"user_api", "user_api_with_client"})
|
2017-05-30 05:56:01 +00:00
|
|
|
*/
|
|
|
|
protected $email;
|
|
|
|
|
2015-02-06 13:18:01 +00:00
|
|
|
/**
|
2017-06-01 07:30:20 +00:00
|
|
|
* @var \DateTime
|
2015-02-06 13:18:01 +00:00
|
|
|
*
|
|
|
|
* @ORM\Column(name="created_at", type="datetime")
|
2017-05-30 05:56:01 +00:00
|
|
|
*
|
2023-07-02 06:27:07 +00:00
|
|
|
* @OA\Property(
|
|
|
|
* description="Creation date of the user account. (In ISO 8601 format)",
|
|
|
|
* type="string",
|
|
|
|
* example="2023-06-27T19:25:44+0000",
|
|
|
|
* )
|
|
|
|
*
|
2017-06-07 21:23:28 +00:00
|
|
|
* @Groups({"user_api", "user_api_with_client"})
|
2015-02-06 13:18:01 +00:00
|
|
|
*/
|
2015-08-18 09:08:45 +00:00
|
|
|
protected $createdAt;
|
2015-02-06 13:18:01 +00:00
|
|
|
|
|
|
|
/**
|
2017-06-01 07:30:20 +00:00
|
|
|
* @var \DateTime
|
2015-02-06 13:18:01 +00:00
|
|
|
*
|
|
|
|
* @ORM\Column(name="updated_at", type="datetime")
|
2017-05-30 05:56:01 +00:00
|
|
|
*
|
2023-07-02 06:27:07 +00:00
|
|
|
* @OA\Property(
|
|
|
|
* description="Update date of the user account. (In ISO 8601 format)",
|
|
|
|
* type="string",
|
|
|
|
* example="2023-06-27T19:37:30+0000",
|
|
|
|
* )
|
|
|
|
*
|
2017-06-07 21:23:28 +00:00
|
|
|
* @Groups({"user_api", "user_api_with_client"})
|
2015-02-06 13:18:01 +00:00
|
|
|
*/
|
2015-08-18 09:08:45 +00:00
|
|
|
protected $updatedAt;
|
2015-02-06 13:18:01 +00:00
|
|
|
|
2015-02-06 14:18:54 +00:00
|
|
|
/**
|
2024-02-19 00:30:12 +00:00
|
|
|
* @ORM\OneToMany(targetEntity="Wallabag\Entity\Entry", mappedBy="user", cascade={"remove"})
|
2015-02-06 14:18:54 +00:00
|
|
|
*/
|
2015-08-18 09:08:45 +00:00
|
|
|
protected $entries;
|
2015-02-06 14:18:54 +00:00
|
|
|
|
2015-02-23 21:55:06 +00:00
|
|
|
/**
|
2024-02-19 00:30:12 +00:00
|
|
|
* @ORM\OneToOne(targetEntity="Wallabag\Entity\Config", mappedBy="user", cascade={"remove"})
|
2015-02-23 21:55:06 +00:00
|
|
|
*/
|
2015-08-18 09:08:45 +00:00
|
|
|
protected $config;
|
2015-02-23 21:55:06 +00:00
|
|
|
|
2017-07-01 07:32:13 +00:00
|
|
|
/**
|
2024-02-19 00:30:12 +00:00
|
|
|
* @var ArrayCollection&iterable<\Wallabag\Entity\SiteCredential>
|
2017-07-01 07:32:13 +00:00
|
|
|
*
|
2024-02-19 00:30:12 +00:00
|
|
|
* @ORM\OneToMany(targetEntity="Wallabag\Entity\SiteCredential", mappedBy="user", cascade={"remove"})
|
2017-07-01 07:32:13 +00:00
|
|
|
*/
|
2017-07-03 09:49:46 +00:00
|
|
|
protected $siteCredentials;
|
2017-07-01 07:32:13 +00:00
|
|
|
|
2015-10-13 20:43:15 +00:00
|
|
|
/**
|
2024-02-19 00:30:12 +00:00
|
|
|
* @var ArrayCollection&iterable<\Wallabag\Entity\Api\Client>
|
2017-07-01 07:52:38 +00:00
|
|
|
*
|
2024-02-19 00:30:12 +00:00
|
|
|
* @ORM\OneToMany(targetEntity="Wallabag\Entity\Api\Client", mappedBy="user", cascade={"remove"})
|
2015-10-13 20:43:15 +00:00
|
|
|
*/
|
2017-07-01 07:52:38 +00:00
|
|
|
protected $clients;
|
2015-10-13 20:43:15 +00:00
|
|
|
|
|
|
|
/**
|
2017-07-01 07:52:38 +00:00
|
|
|
* @see getFirstClient() below
|
2017-06-07 21:23:28 +00:00
|
|
|
*
|
2023-07-02 06:27:07 +00:00
|
|
|
* @OA\Property(
|
|
|
|
* description="Default client created during user registration. Used for further authorization",
|
|
|
|
* ref=@Model(type=Client::class, groups={"user_api_with_client"})
|
|
|
|
* )
|
|
|
|
*
|
2017-07-01 07:52:38 +00:00
|
|
|
* @Groups({"user_api_with_client"})
|
|
|
|
* @Accessor(getter="getFirstClient")
|
2015-10-13 20:43:15 +00:00
|
|
|
*/
|
2017-07-01 07:52:38 +00:00
|
|
|
protected $default_client;
|
2015-10-13 20:43:15 +00:00
|
|
|
|
|
|
|
/**
|
2017-07-01 07:52:38 +00:00
|
|
|
* @ORM\Column(type="integer", nullable=true)
|
2015-10-13 20:43:15 +00:00
|
|
|
*/
|
2017-07-01 07:52:38 +00:00
|
|
|
private $authCode;
|
2015-10-13 20:43:15 +00:00
|
|
|
|
2016-10-24 19:56:28 +00:00
|
|
|
/**
|
2018-12-02 11:43:05 +00:00
|
|
|
* @ORM\Column(name="googleAuthenticatorSecret", type="string", nullable=true)
|
2016-10-24 19:56:28 +00:00
|
|
|
*/
|
2018-12-02 11:43:05 +00:00
|
|
|
private $googleAuthenticatorSecret;
|
2016-10-24 19:56:28 +00:00
|
|
|
|
2018-12-03 05:51:06 +00:00
|
|
|
/**
|
2022-12-21 09:57:38 +00:00
|
|
|
* @var array
|
|
|
|
*
|
2022-12-14 13:36:29 +00:00
|
|
|
* @ORM\Column(type="json", nullable=true)
|
2018-12-03 05:51:06 +00:00
|
|
|
*/
|
|
|
|
private $backupCodes;
|
|
|
|
|
2017-06-07 21:23:28 +00:00
|
|
|
/**
|
2018-12-02 11:43:05 +00:00
|
|
|
* @var bool
|
|
|
|
*
|
|
|
|
* @ORM\Column(type="boolean")
|
2017-06-07 21:23:28 +00:00
|
|
|
*/
|
2018-12-02 11:43:05 +00:00
|
|
|
private $emailTwoFactor = false;
|
2017-06-07 21:23:28 +00:00
|
|
|
|
2015-01-31 14:14:10 +00:00
|
|
|
public function __construct()
|
|
|
|
{
|
2015-08-18 09:08:45 +00:00
|
|
|
parent::__construct();
|
2015-09-20 20:37:27 +00:00
|
|
|
$this->entries = new ArrayCollection();
|
2016-04-12 09:36:01 +00:00
|
|
|
$this->roles = ['ROLE_USER'];
|
2015-01-31 14:14:10 +00:00
|
|
|
}
|
2015-02-06 13:18:01 +00:00
|
|
|
|
2015-01-22 16:18:56 +00:00
|
|
|
/**
|
2015-05-30 11:52:26 +00:00
|
|
|
* Set name.
|
|
|
|
*
|
|
|
|
* @param string $name
|
2015-01-22 16:18:56 +00:00
|
|
|
*
|
2015-02-06 13:18:01 +00:00
|
|
|
* @return User
|
2015-01-22 16:18:56 +00:00
|
|
|
*/
|
|
|
|
public function setName($name)
|
|
|
|
{
|
|
|
|
$this->name = $name;
|
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2015-05-30 11:52:26 +00:00
|
|
|
* Get name.
|
2015-01-22 16:18:56 +00:00
|
|
|
*
|
2015-01-31 18:09:34 +00:00
|
|
|
* @return string
|
2015-01-22 16:18:56 +00:00
|
|
|
*/
|
|
|
|
public function getName()
|
|
|
|
{
|
|
|
|
return $this->name;
|
|
|
|
}
|
|
|
|
|
2015-02-06 13:18:01 +00:00
|
|
|
/**
|
2017-06-01 07:36:01 +00:00
|
|
|
* @return \DateTime
|
2015-02-06 13:18:01 +00:00
|
|
|
*/
|
|
|
|
public function getCreatedAt()
|
|
|
|
{
|
|
|
|
return $this->createdAt;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2017-06-01 07:36:01 +00:00
|
|
|
* @return \DateTime
|
2015-02-06 13:18:01 +00:00
|
|
|
*/
|
|
|
|
public function getUpdatedAt()
|
|
|
|
{
|
|
|
|
return $this->updatedAt;
|
|
|
|
}
|
|
|
|
|
2015-02-06 14:18:54 +00:00
|
|
|
/**
|
|
|
|
* @return User
|
|
|
|
*/
|
|
|
|
public function addEntry(Entry $entry)
|
|
|
|
{
|
|
|
|
$this->entries[] = $entry;
|
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return ArrayCollection<Entry>
|
|
|
|
*/
|
|
|
|
public function getEntries()
|
|
|
|
{
|
|
|
|
return $this->entries;
|
|
|
|
}
|
|
|
|
|
2015-02-23 21:55:06 +00:00
|
|
|
/**
|
2015-05-30 11:52:26 +00:00
|
|
|
* Set config.
|
|
|
|
*
|
2015-02-23 21:55:06 +00:00
|
|
|
* @return User
|
|
|
|
*/
|
2024-02-19 08:31:30 +00:00
|
|
|
public function setConfig(?Config $config = null)
|
2015-02-23 21:55:06 +00:00
|
|
|
{
|
|
|
|
$this->config = $config;
|
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2015-05-30 11:52:26 +00:00
|
|
|
* Get config.
|
2015-02-23 21:55:06 +00:00
|
|
|
*
|
2015-10-02 12:51:41 +00:00
|
|
|
* @return Config
|
2015-02-23 21:55:06 +00:00
|
|
|
*/
|
|
|
|
public function getConfig()
|
|
|
|
{
|
|
|
|
return $this->config;
|
|
|
|
}
|
2015-10-13 20:43:15 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @return bool
|
|
|
|
*/
|
2018-12-02 11:43:05 +00:00
|
|
|
public function isEmailTwoFactor()
|
|
|
|
{
|
|
|
|
return $this->emailTwoFactor;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param bool $emailTwoFactor
|
|
|
|
*/
|
|
|
|
public function setEmailTwoFactor($emailTwoFactor)
|
2015-10-13 20:43:15 +00:00
|
|
|
{
|
2018-12-02 11:43:05 +00:00
|
|
|
$this->emailTwoFactor = $emailTwoFactor;
|
2015-10-13 20:43:15 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2018-12-02 11:43:05 +00:00
|
|
|
* Used in the user config form to be "like" the email option.
|
2015-10-13 20:43:15 +00:00
|
|
|
*/
|
2018-12-02 11:43:05 +00:00
|
|
|
public function isGoogleTwoFactor()
|
2015-10-13 20:43:15 +00:00
|
|
|
{
|
2018-12-02 11:43:05 +00:00
|
|
|
return $this->isGoogleAuthenticatorEnabled();
|
2015-10-13 20:43:15 +00:00
|
|
|
}
|
|
|
|
|
2018-12-02 11:43:05 +00:00
|
|
|
public function isEmailAuthEnabled(): bool
|
2015-10-13 20:43:15 +00:00
|
|
|
{
|
2018-12-02 11:43:05 +00:00
|
|
|
return $this->emailTwoFactor;
|
2015-10-13 20:43:15 +00:00
|
|
|
}
|
|
|
|
|
2018-12-02 11:43:05 +00:00
|
|
|
public function getEmailAuthCode(): string
|
2015-10-13 20:43:15 +00:00
|
|
|
{
|
|
|
|
return $this->authCode;
|
|
|
|
}
|
|
|
|
|
2018-12-02 11:43:05 +00:00
|
|
|
public function setEmailAuthCode(string $authCode): void
|
2015-10-13 20:43:15 +00:00
|
|
|
{
|
|
|
|
$this->authCode = $authCode;
|
|
|
|
}
|
|
|
|
|
2018-12-02 11:43:05 +00:00
|
|
|
public function getEmailAuthRecipient(): string
|
2015-10-13 20:43:15 +00:00
|
|
|
{
|
2018-12-02 11:43:05 +00:00
|
|
|
return $this->email;
|
2015-10-13 20:43:15 +00:00
|
|
|
}
|
|
|
|
|
2018-12-02 11:43:05 +00:00
|
|
|
public function isGoogleAuthenticatorEnabled(): bool
|
2015-10-13 20:43:15 +00:00
|
|
|
{
|
2018-12-02 11:43:05 +00:00
|
|
|
return $this->googleAuthenticatorSecret ? true : false;
|
|
|
|
}
|
2015-10-13 20:43:15 +00:00
|
|
|
|
2018-12-02 11:43:05 +00:00
|
|
|
public function getGoogleAuthenticatorUsername(): string
|
|
|
|
{
|
|
|
|
return $this->username;
|
|
|
|
}
|
2015-10-13 20:43:15 +00:00
|
|
|
|
2018-12-02 11:43:05 +00:00
|
|
|
public function getGoogleAuthenticatorSecret(): string
|
|
|
|
{
|
|
|
|
return $this->googleAuthenticatorSecret;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function setGoogleAuthenticatorSecret(?string $googleAuthenticatorSecret): void
|
|
|
|
{
|
|
|
|
$this->googleAuthenticatorSecret = $googleAuthenticatorSecret;
|
2015-10-13 20:43:15 +00:00
|
|
|
}
|
2016-10-24 19:56:28 +00:00
|
|
|
|
2024-02-19 08:31:30 +00:00
|
|
|
public function setBackupCodes(?array $codes = null)
|
2018-12-03 05:51:06 +00:00
|
|
|
{
|
|
|
|
$this->backupCodes = $codes;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function getBackupCodes()
|
|
|
|
{
|
|
|
|
return $this->backupCodes;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function isBackupCode(string $code): bool
|
|
|
|
{
|
2019-01-23 13:43:39 +00:00
|
|
|
return false === $this->findBackupCode($code) ? false : true;
|
2018-12-03 05:51:06 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
public function invalidateBackupCode(string $code): void
|
|
|
|
{
|
2019-01-23 13:43:39 +00:00
|
|
|
$key = $this->findBackupCode($code);
|
2018-12-03 05:51:06 +00:00
|
|
|
|
|
|
|
if (false !== $key) {
|
|
|
|
unset($this->backupCodes[$key]);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-10-24 19:56:28 +00:00
|
|
|
/**
|
|
|
|
* @return User
|
|
|
|
*/
|
|
|
|
public function addClient(Client $client)
|
|
|
|
{
|
|
|
|
$this->clients[] = $client;
|
|
|
|
|
|
|
|
return $this;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2023-11-16 08:36:47 +00:00
|
|
|
* @return ArrayCollection<Client>
|
2016-10-24 19:56:28 +00:00
|
|
|
*/
|
|
|
|
public function getClients()
|
|
|
|
{
|
|
|
|
return $this->clients;
|
|
|
|
}
|
2017-06-07 21:23:28 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Only used by the API when creating a new user it'll also return the first client (which was also created at the same time).
|
|
|
|
*
|
2021-08-05 20:33:04 +00:00
|
|
|
* @return Client|false
|
2017-06-07 21:23:28 +00:00
|
|
|
*/
|
|
|
|
public function getFirstClient()
|
|
|
|
{
|
2017-06-07 21:23:34 +00:00
|
|
|
if (!empty($this->clients)) {
|
|
|
|
return $this->clients->first();
|
2017-06-07 21:23:28 +00:00
|
|
|
}
|
2021-08-05 20:33:04 +00:00
|
|
|
|
|
|
|
return false;
|
2017-06-07 21:23:28 +00:00
|
|
|
}
|
2019-01-23 13:43:39 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Try to find a backup code from the list of backup codes of the current user.
|
|
|
|
*
|
|
|
|
* @param string $code Given code from the user
|
|
|
|
*
|
|
|
|
* @return string|false
|
|
|
|
*/
|
|
|
|
private function findBackupCode(string $code)
|
|
|
|
{
|
|
|
|
foreach ($this->backupCodes as $key => $backupCode) {
|
|
|
|
// backup code are hashed using `password_hash`
|
|
|
|
// see ConfigController->otpAppAction
|
|
|
|
if (password_verify($code, $backupCode)) {
|
|
|
|
return $key;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return false;
|
|
|
|
}
|
2015-01-22 16:18:56 +00:00
|
|
|
}
|