2627594884

Build Type

github

Committed by GitHub

Commit Message

<a href="https://github.com/codeigniter4/shield/commit/<a class=hub.com/codeigniter4/shield/commit/<a class="double-link" href="https://git"><a class=hub.com/codeigniter4/shield/commit/<a class="double-link" href="https://git"><a class=hub.com/codeigniter4/shield/commit/<a class="double-link" href="https://git"><a class=hub.com/codeigniter4/shield/commit/a77dda1979231dd7f89a414f9a07b68b7c68fcb3">a77dda197">&lt;a href=&quot;https://github.com/codeigniter4/shield/commit/</a><a class="double-link" href="https://github.com/codeigniter4/shield/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/codeigniter4/shield/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/codeigniter4/shield/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/codeigniter4/shield/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/codeigniter4/shield/commit/a77dda1979231dd7f89a414f9a07b68b7c68fcb3">a77dda197</a><a href="https://github.com/codeigniter4/shield/commit/a77dda1979231dd7f89a414f9a07b68b7c68fcb3">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/codeigniter4/shield/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/codeigniter4/shield/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/codeigniter4/shield/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/codeigniter4/shield/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/codeigniter4/shield/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/codeigniter4/shield/commit/a77dda1979231dd7f89a414f9a07b68b7c68fcb3&quot;&gt;a77dda197&lt;/a&gt;&lt;a href=&quot;https://github.com/codeigniter4/shield/commit/a77dda1979231dd7f89a414f9a07b68b7c68fcb3&quot;&gt;&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/codeigniter4/shield/commit/&amp;lt;/a&amp;gt;&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://github.com/codeign... (continued)

Pull Request Pull Request #275: fix: UserModel::save() can't update User's email/password

Run Details

32 of 34 new or added lines in 4 files covered. (94.12%)

1324 of 1428 relevant lines covered (92.72%)

12.28 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

98.21

/src/Entities/User.php

<?php

namespace CodeIgniter\Shield\Entities;

use CodeIgniter\Database\Exceptions\DataException;
use CodeIgniter\Entity\Entity;
use CodeIgniter\Shield\Authentication\Authenticators\Session;
use CodeIgniter\Shield\Authentication\Traits\HasAccessTokens;
use CodeIgniter\Shield\Authorization\Traits\Authorizable;
use CodeIgniter\Shield\Models\LoginModel;
use CodeIgniter\Shield\Models\UserIdentityModel;

class User extends Entity
{
    use Authorizable;
    use HasAccessTokens;

    /**
     * @var UserIdentity[]|null
     */
    private ?array $identities = null;

    private ?string $email         = null;
    private ?string $password      = null;
    private ?string $password_hash = null;

    /**
     * @var string[]
     * @phpstan-var list<string>
     * @psalm-var list<string>
     */
    protected $dates = [
        'created_at',
        'updated_at',
        'deleted_at',
        'last_active',
    ];

    /**
     * @var array<string, string>
     */
    protected $casts = [
        'active'           => 'boolean',
        'force_pass_reset' => 'boolean',
        'permissions'      => 'array',
        'groups'           => 'array',
    ];

    /**
     * Returns the first identity of the given $type for this user.
     *
     * @param string $type See const ID_TYPE_* in Authenticator.
     *                     'email_2fa'|'email_activate'|'email_password'|'magic-link'|'access_token'
     */
    public function getIdentity(string $type): ?UserIdentity
    {
        $identities = $this->getIdentities($type);

        return count($identities) ? array_shift($identities) : null;
    }

    /**
     * ensures that all of the user's identities are loaded
     * into the instance for faster access later.
     */
    private function populateIdentities(): void
    {
        if ($this->identities === null) {
            /** @var UserIdentityModel $identityModel */
            $identityModel = model(UserIdentityModel::class);

            $this->identities = $identityModel->getIdentities($this);
        }
    }

    /**
     * Accessor method for this user's UserIdentity objects.
     * Will populate if they don't exist.
     *
     * @param string $type 'all' returns all identities.
     *
     * @return UserIdentity[]
     */
    public function getIdentities(string $type = 'all'): array
    {
        $this->populateIdentities();

        if ($type === 'all') {
            return $this->identities;
        }

        $identities = [];

        foreach ($this->identities as $identity) {
            if ($identity->type === $type) {
                $identities[] = $identity;
            }
        }

        return $identities;
    }

    /**
     * Creates a new identity for this user with an email/password
     * combination.
     *
     * @phpstan-param array{email: string, password: string} $credentials
     */
    public function createEmailIdentity(array $credentials): void
    {
        /** @var UserIdentityModel $identityModel */
        $identityModel = model(UserIdentityModel::class);

        $identityModel->createEmailIdentity($this, $credentials);
    }

    /**
     * Returns the user's Email/Password identity.
     */
    public function getEmailIdentity(): ?UserIdentity
    {
        return $this->getIdentity(Session::ID_TYPE_EMAIL_PASSWORD);
    }

    /**
     * If $email, $password, or $password_hash have been updated,
     * will update the user's email identity record with the
     * correct values.
     */
    public function saveEmailIdentity(): bool
    {
        if (empty($this->email) && empty($this->password) && empty($this->password_hash)) {
            return true;
        }

        $identity = $this->getEmailIdentity();
        if ($identity === null) {
            // Ensure we reload all identities
            $this->identities = null;

            $this->createEmailIdentity([
                'email'    => $this->email,
                'password' => '',
            ]);
            $identity = $this->getEmailIdentity();
        }

        if (! empty($this->email)) {
            $identity->secret = $this->email;
        }

        if (! empty($this->password)) {
            $identity->secret2 = service('passwords')->hash($this->password);
        }

        if (! empty($this->password_hash) && empty($this->password)) {
            $identity->secret2 = $this->password_hash;
        }

        /** @var UserIdentityModel $identityModel */
        $identityModel = model(UserIdentityModel::class);

        try {
            /** @throws DataException */
            $identityModel->save($identity);
        } catch (DataException $e) {
            // There may be no data to update.
            $messages = [
                lang('Database.emptyDataset', ['insert']),
                lang('Database.emptyDataset', ['update']),
            ];
            if (in_array($e->getMessage(), $messages, true)) {
                return true;
            }

            throw $e;
        }

        return true;
    }

    /**
     * Update the last used at date for an identity record.
     */
    public function touchIdentity(UserIdentity $identity): void
    {
        /** @var UserIdentityModel $identityModel */
        $identityModel = model(UserIdentityModel::class);

        $identityModel->touchIdentity($identity);
    }

    /**
     * Accessor method to grab the user's email address.
     * Will cache it in $this->email, since it has
     * to hit the database the first time to get it, most likely.
     */
    public function getEmail(): ?string
    {
        if ($this->email === null) {
            $this->email = $this->getEmailIdentity()->secret ?? null;
        }

        return $this->email;
    }

    public function setEmail(string $email): void
    {
        $this->email = $email;
    }

    public function getPassword(): ?string
    {
        return $this->password;
    }

    public function setPassword(string $password): User
    {
        $this->password = $password;

        return $this;
    }

    public function setPasswordHash(string $hash): User
    {
        $this->password_hash = $hash;

        return $this;
    }

    /**
     * Accessor method to grab the user's password hash.
     * Will cache it in $this->attributes, since it has
     * to hit the database the first time to get it, most likely.
     */
    public function getPasswordHash(): ?string
    {
        if ($this->password_hash === null) {
            $this->password_hash = $this->getEmailIdentity()->secret2 ?? null;
        }

        return $this->password_hash;
    }

    /**
     * Returns the last login information for this user as
     */
    public function lastLogin(): ?Login
    {
        /** @var LoginModel $logins */
        $logins = model(LoginModel::class);

        return $logins->lastLogin($this);
    }
}

1	<?php
2
3	namespace CodeIgniter\Shield\Entities;
4
5	use CodeIgniter\Database\Exceptions\DataException;
6	use CodeIgniter\Entity\Entity;
7	use CodeIgniter\Shield\Authentication\Authenticators\Session;
8	use CodeIgniter\Shield\Authentication\Traits\HasAccessTokens;
9	use CodeIgniter\Shield\Authorization\Traits\Authorizable;
10	use CodeIgniter\Shield\Models\LoginModel;
11	use CodeIgniter\Shield\Models\UserIdentityModel;
12
13	class User extends Entity
14	{
15	use Authorizable;
16	use HasAccessTokens;
17
18	/**
19	* @var UserIdentity[]\|null
20	*/
21	private ?array $identities = null;
22
23	private ?string $email = null;
24	private ?string $password = null;
25	private ?string $password_hash = null;
26
27	/**
28	* @var string[]
29	* @phpstan-var list<string>
30	* @psalm-var list<string>
31	*/
32	protected $dates = [
33	'created_at',
34	'updated_at',
35	'deleted_at',
36	'last_active',
37	];
38
39	/**
40	* @var array<string, string>
41	*/
42	protected $casts = [
43	'active' => 'boolean',
44	'force_pass_reset' => 'boolean',
45	'permissions' => 'array',
46	'groups' => 'array',
47	];
48
49	/**
50	* Returns the first identity of the given $type for this user.
51	*
52	* @param string $type See const ID_TYPE_* in Authenticator.
53	* 'email_2fa'\|'email_activate'\|'email_password'\|'magic-link'\|'access_token'
54	*/
55	public function getIdentity(string $type): ?UserIdentity
56	{
57	$identities = $this->getIdentities($type);	29✔
58
59	return count($identities) ? array_shift($identities) : null;	29✔
60	}
61
62	/**
63	* ensures that all of the user's identities are loaded
64	* into the instance for faster access later.
65	*/
66	private function populateIdentities(): void
67	{
68	if ($this->identities === null) {	33✔
69	/** @var UserIdentityModel $identityModel */
70	$identityModel = model(UserIdentityModel::class);	33✔
71
72	$this->identities = $identityModel->getIdentities($this);	33✔
73	}
74	}
75
76	/**
77	* Accessor method for this user's UserIdentity objects.
78	* Will populate if they don't exist.
79	*
80	* @param string $type 'all' returns all identities.
81	*
82	* @return UserIdentity[]
83	*/
84	public function getIdentities(string $type = 'all'): array
85	{
86	$this->populateIdentities();	33✔
87
88	if ($type === 'all') {	33✔
89	return $this->identities;	3✔
90	}
91
92	$identities = [];	30✔
93
94	foreach ($this->identities as $identity) {	30✔
95	if ($identity->type === $type) {	29✔
96	$identities[] = $identity;	29✔
97	}
98	}
99
100	return $identities;	30✔
101	}
102
103	/**
104	* Creates a new identity for this user with an email/password
105	* combination.
106	*
107	* @phpstan-param array{email: string, password: string} $credentials
108	*/
109	public function createEmailIdentity(array $credentials): void
110	{
111	/** @var UserIdentityModel $identityModel */
112	$identityModel = model(UserIdentityModel::class);	42✔
113
114	$identityModel->createEmailIdentity($this, $credentials);	42✔
115	}
116
117	/**
118	* Returns the user's Email/Password identity.
119	*/
120	public function getEmailIdentity(): ?UserIdentity
121	{
122	return $this->getIdentity(Session::ID_TYPE_EMAIL_PASSWORD);	26✔
123	}
124
125	/**
126	* If $email, $password, or $password_hash have been updated,
127	* will update the user's email identity record with the
128	* correct values.
129	*/
130	public function saveEmailIdentity(): bool
131	{
132	if (empty($this->email) && empty($this->password) && empty($this->password_hash)) {	11✔
133	return true;	4✔
134	}
135
136	$identity = $this->getEmailIdentity();	8✔
137	if ($identity === null) {	8✔
138	// Ensure we reload all identities
139	$this->identities = null;	8✔
140
141	$this->createEmailIdentity([	8✔
142	'email' => $this->email,	8✔
143	'password' => '',
144	]);
145	$identity = $this->getEmailIdentity();	8✔
146	}
147
148	if (! empty($this->email)) {	8✔
149	$identity->secret = $this->email;	8✔
150	}
151
152	if (! empty($this->password)) {	8✔
153	$identity->secret2 = service('passwords')->hash($this->password);	6✔
154	}
155
156	if (! empty($this->password_hash) && empty($this->password)) {	8✔
157	$identity->secret2 = $this->password_hash;	3✔
158	}
159
160	/** @var UserIdentityModel $identityModel */
161	$identityModel = model(UserIdentityModel::class);	8✔
162
163	try {
164	/** @throws DataException */
165	$identityModel->save($identity);	8✔
166	} catch (DataException $e) {	1✔
167	// There may be no data to update.
168	$messages = [	1✔
169	lang('Database.emptyDataset', ['insert']),	1✔
170	lang('Database.emptyDataset', ['update']),	1✔
171	];
172	if (in_array($e->getMessage(), $messages, true)) {	1✔
173	return true;	1✔
174	}
175
NEW 176	throw $e;	×
177	}
178
179	return true;	7✔
180	}
181
182	/**
183	* Update the last used at date for an identity record.
184	*/
185	public function touchIdentity(UserIdentity $identity): void
186	{
187	/** @var UserIdentityModel $identityModel */
188	$identityModel = model(UserIdentityModel::class);	9✔
189
190	$identityModel->touchIdentity($identity);	9✔
191	}
192
193	/**
194	* Accessor method to grab the user's email address.
195	* Will cache it in $this->email, since it has
196	* to hit the database the first time to get it, most likely.
197	*/
198	public function getEmail(): ?string
199	{
200	if ($this->email === null) {	28✔
201	$this->email = $this->getEmailIdentity()->secret ?? null;	12✔
202	}
203
204	return $this->email;	28✔
205	}
206
207	public function setEmail(string $email): void
208	{
209	$this->email = $email;	36✔
210	}
211
212	public function getPassword(): ?string
213	{
214	return $this->password;	5✔
215	}
216
217	public function setPassword(string $password): User
218	{
219	$this->password = $password;	6✔
220
221	return $this;	6✔
222	}
223
224	public function setPasswordHash(string $hash): User
225	{
226	$this->password_hash = $hash;	16✔
227
228	return $this;	16✔
229	}
230
231	/**
232	* Accessor method to grab the user's password hash.
233	* Will cache it in $this->attributes, since it has
234	* to hit the database the first time to get it, most likely.
235	*/
236	public function getPasswordHash(): ?string
237	{
238	if ($this->password_hash === null) {	17✔
239	$this->password_hash = $this->getEmailIdentity()->secret2 ?? null;	8✔
240	}
241
242	return $this->password_hash;	17✔
243	}
244
245	/**
246	* Returns the last login information for this user as
247	*/
248	public function lastLogin(): ?Login
249	{
250	/** @var LoginModel $logins */
251	$logins = model(LoginModel::class);	1✔
252
253	return $logins->lastLogin($this);	1✔
254	}
255	}

codeigniter4 / shield / 2627594884

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous