2803748978

Build Type

github

Committed by GitHub

Commit Message

<a href="https://github.com/codeigniter4/shield/commit/<a class=hub.com/codeigniter4/shield/commit/e7e760dd7b56c48bf89ccdf80f09a9e2b4132fdf">e7e760dd7<a href="https://github.com/codeigniter4/shield/commit/e7e760dd7b56c48bf89ccdf80f09a9e2b4132fdf">">Merge </a><a class="double-link" href="https://github.com/codeigniter4/shield/commit/<a class="double-link" href="https://github.com/codeigniter4/shield/commit/8109aa2ad5e8b3bd7031bfd8b6c52b8bb31fed09">8109aa2ad</a>">8109aa2ad</a><a href="https://github.com/codeigniter4/shield/commit/e7e760dd7b56c48bf89ccdf80f09a9e2b4132fdf"> into e3cafec4a">e3cafec4a</a>

Pull Request Pull Request #345: Fix email deliverability error log

Run Details

10 of 12 new or added lines in 2 files covered. (83.33%)

1358 of 1462 relevant lines covered (92.89%)

15.46 hits per line

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

79.41

/src/Authentication/Actions/EmailActivator.php

<?php

namespace CodeIgniter\Shield\Authentication\Actions;

use CodeIgniter\Exceptions\PageNotFoundException;
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\RedirectResponse;
use CodeIgniter\Shield\Authentication\Authenticators\Session;
use CodeIgniter\Shield\Entities\User;
use CodeIgniter\Shield\Exceptions\LogicException;
use CodeIgniter\Shield\Exceptions\RuntimeException;
use CodeIgniter\Shield\Models\UserIdentityModel;

class EmailActivator implements ActionInterface
{
    private string $type = Session::ID_TYPE_EMAIL_ACTIVATE;

    /**
     * Shows the initial screen to the user telling them
     * that an email was just sent to them with a link
     * to confirm their email address.
     */
    public function show(): string
    {
        /** @var Session $authenticator */
        $authenticator = auth('session')->getAuthenticator();

        $user = $authenticator->getPendingUser();
        if ($user === null) {
            throw new RuntimeException('Cannot get the pending login User.');
        }

        $userEmail = $user->email;
        if ($userEmail === null) {
            throw new LogicException(
                'Email Activation needs user email address. user_id: ' . $user->id
            );
        }

        $code = $this->createIdentity($user);

        // Send the email
        helper('email');
        $email = emailer()->setFrom(setting('Email.fromEmail'), setting('Email.fromName') ?? '');
        $email->setTo($userEmail);
        $email->setSubject(lang('Auth.emailActivateSubject'));
        $email->setMessage(view(setting('Auth.views')['action_email_activate_email'], ['code' => $code]));

        if ($email->send(false) === false) {
            throw new RuntimeException('Cannot send email for user: ' . $user->email . ' '. $email->printDebugger(['headers']));
        }

        // Display the info page
        return view(setting('Auth.views')['action_email_activate_show'], ['user' => $user]);
    }

    /**
     * This method is unused.
     */
    public function handle(IncomingRequest $request)
    {
        throw new PageNotFoundException();
    }

    /**
     * Verifies the email address and code matches an
     * identity we have for that user.
     *
     * @return RedirectResponse|string
     */
    public function verify(IncomingRequest $request)
    {
        $token = $request->getVar('token');

        /** @var Session $authenticator */
        $authenticator = auth('session')->getAuthenticator();

        // No match - let them try again.
        if (! $authenticator->checkAction($this->type, $token)) {
            session()->setFlashdata('error', lang('Auth.invalidActivateToken'));

            return view(setting('Auth.views')['action_email_activate_show']);
        }

        $user = $authenticator->getUser();

        // Set the user active now
        $authenticator->activateUser($user);

        // Success!
        return redirect()->to(config('Auth')->registerRedirect())
            ->with('message', lang('Auth.registerSuccess'));
    }

    /**
     * Called from `RegisterController::registerAction()`
     */
    public function afterRegister(User $user): void
    {
        $this->createIdentity($user);
    }

    protected function createIdentity(User $user): string
    {
        /** @var UserIdentityModel $identityModel */
        $identityModel = model(UserIdentityModel::class);

        $generator = static fn (): string => random_string('nozero', 6);

        return $identityModel->createCodeIdentity(
            $user,
            [
                'type'  => $this->type,
                'name'  => 'register',
                'extra' => lang('Auth.needVerification'),
            ],
            $generator
        );
    }

    public function getType(): string
    {
        return $this->type;
    }
}

1	<?php
2
3	namespace CodeIgniter\Shield\Authentication\Actions;
4
5	use CodeIgniter\Exceptions\PageNotFoundException;
6	use CodeIgniter\HTTP\IncomingRequest;
7	use CodeIgniter\HTTP\RedirectResponse;
8	use CodeIgniter\Shield\Authentication\Authenticators\Session;
9	use CodeIgniter\Shield\Entities\User;
10	use CodeIgniter\Shield\Exceptions\LogicException;
11	use CodeIgniter\Shield\Exceptions\RuntimeException;
12	use CodeIgniter\Shield\Models\UserIdentityModel;
13
14	class EmailActivator implements ActionInterface
15	{
16	private string $type = Session::ID_TYPE_EMAIL_ACTIVATE;
17
18	/**
19	* Shows the initial screen to the user telling them
20	* that an email was just sent to them with a link
21	* to confirm their email address.
22	*/
23	public function show(): string
24	{
25	/** @var Session $authenticator */
26	$authenticator = auth('session')->getAuthenticator();	1✔
27
28	$user = $authenticator->getPendingUser();	1✔
29	if ($user === null) {	1✔
30	throw new RuntimeException('Cannot get the pending login User.');	×
31	}
32
33	$userEmail = $user->email;	1✔
34	if ($userEmail === null) {	1✔
35	throw new LogicException(	×
36	'Email Activation needs user email address. user_id: ' . $user->id	×
37	);
38	}
39
40	$code = $this->createIdentity($user);	1✔
41
42	// Send the email
43	helper('email');	1✔
44	$email = emailer()->setFrom(setting('Email.fromEmail'), setting('Email.fromName') ?? '');	1✔
45	$email->setTo($userEmail);	1✔
46	$email->setSubject(lang('Auth.emailActivateSubject'));	1✔
47	$email->setMessage(view(setting('Auth.views')['action_email_activate_email'], ['code' => $code]));	1✔
48
49	if ($email->send(false) === false) {	1✔
NEW 50	throw new RuntimeException('Cannot send email for user: ' . $user->email . ' '. $email->printDebugger(['headers']));	×
51	}
52
53	// Display the info page
54	return view(setting('Auth.views')['action_email_activate_show'], ['user' => $user]);	1✔
55	}
56
57	/**
58	* This method is unused.
59	*/
60	public function handle(IncomingRequest $request)
61	{
62	throw new PageNotFoundException();	×
63	}
64
65	/**
66	* Verifies the email address and code matches an
67	* identity we have for that user.
68	*
69	* @return RedirectResponse\|string
70	*/
71	public function verify(IncomingRequest $request)
72	{
73	$token = $request->getVar('token');	1✔
74
75	/** @var Session $authenticator */
76	$authenticator = auth('session')->getAuthenticator();	1✔
77
78	// No match - let them try again.
79	if (! $authenticator->checkAction($this->type, $token)) {	1✔
80	session()->setFlashdata('error', lang('Auth.invalidActivateToken'));	×
81
82	return view(setting('Auth.views')['action_email_activate_show']);	×
83	}
84
85	$user = $authenticator->getUser();	1✔
86
87	// Set the user active now
88	$authenticator->activateUser($user);	1✔
89
90	// Success!
91	return redirect()->to(config('Auth')->registerRedirect())	1✔
92	->with('message', lang('Auth.registerSuccess'));	1✔
93	}
94
95	/**
96	* Called from `RegisterController::registerAction()`
97	*/
98	public function afterRegister(User $user): void
99	{
100	$this->createIdentity($user);	1✔
101	}
102
103	protected function createIdentity(User $user): string
104	{
105	/** @var UserIdentityModel $identityModel */
106	$identityModel = model(UserIdentityModel::class);	2✔
107
108	$generator = static fn (): string => random_string('nozero', 6);	2✔
109
110	return $identityModel->createCodeIdentity(	2✔
111	$user,
112	[
113	'type' => $this->type,	2✔
114	'name' => 'register',
115	'extra' => lang('Auth.needVerification'),	2✔
116	],
117	$generator
118	);
119	}
120
121	public function getType(): string
122	{
123	return $this->type;	1✔
124	}
125	}

codeigniter4 / shield / 2803748978

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