xref: /webtrees/app/Http/RequestHandlers/PasswordRequestAction.php (revision ea517a3bcde172a7403de36143979b17050fb005) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2021 webtrees development team
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <https://www.gnu.org/licenses/>.
16 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Http\RequestHandlers;
21
22use Fig\Http\Message\StatusCodeInterface;
23use Fisharebest\Webtrees\Carbon;
24use Fisharebest\Webtrees\FlashMessages;
25use Fisharebest\Webtrees\I18N;
26use Fisharebest\Webtrees\Log;
27use Fisharebest\Webtrees\Services\EmailService;
28use Fisharebest\Webtrees\Services\UserService;
29use Fisharebest\Webtrees\SiteUser;
30use Fisharebest\Webtrees\Tree;
31use Fisharebest\Webtrees\User;
32use Illuminate\Support\Str;
33use Psr\Http\Message\ResponseInterface;
34use Psr\Http\Message\ServerRequestInterface;
35use Psr\Http\Server\RequestHandlerInterface;
36
37use function e;
38use function random_int;
39use function redirect;
40use function route;
41use function view;
42
43/**
44 * Request a new password.
45 */
46class PasswordRequestAction implements RequestHandlerInterface, StatusCodeInterface
47{
48    private const TOKEN_LENGTH = 40;
49
50    private EmailService $email_service;
51
52    private UserService $user_service;
53
54    /**
55     * PasswordRequestForm constructor.
56     *
57     * @param EmailService $email_service
58     * @param UserService  $user_service
59     */
60    public function __construct(EmailService $email_service, UserService $user_service)
61    {
62        $this->user_service  = $user_service;
63        $this->email_service = $email_service;
64    }
65
66    /**
67     * @param ServerRequestInterface $request
68     *
69     * @return ResponseInterface
70     */
71    public function handle(ServerRequestInterface $request): ResponseInterface
72    {
73        $tree = $request->getAttribute('tree');
74
75        $params = (array) $request->getParsedBody();
76
77        $email = $params['email'] ?? '';
78        $user  = $this->user_service->findByEmail($email);
79
80        if ($user instanceof User) {
81            $token  = Str::random(self::TOKEN_LENGTH);
82            $expire = (string) Carbon::now()->addHour()->getTimestamp();
83            $url    = route(PasswordResetPage::class, [
84                'token' => $token,
85                'tree'  => $tree instanceof Tree ? $tree->name() : null,
86            ]);
87
88            $user->setPreference('password-token', $token);
89            $user->setPreference('password-token-expire', $expire);
90
91            $this->email_service->send(
92                new SiteUser(),
93                $user,
94                new SiteUser(),
95                I18N::translate('Request a new password'),
96                view('emails/password-request-text', ['url' => $url, 'user' => $user]),
97                view('emails/password-request-html', ['url' => $url, 'user' => $user])
98            );
99
100            Log::addAuthenticationLog('Password request for user: ' . $user->userName());
101        } else {
102            // Email takes a few seconds to send.  An instant response would allow
103            // an attacker to use the speed of the response to infer whether an account exists.
104            usleep(random_int(500000, 2000000));
105        }
106
107        // For security, send a success message even when we fail.
108        $message1 = I18N::translate('A password reset link has been sent to “%s”.', e($email));
109        $message2 = I18N::translate('This link is valid for one hour.');
110        FlashMessages::addMessage($message1 . '<br>' . $message2, 'success');
111
112        return redirect(route(LoginPage::class, ['tree' => $tree instanceof Tree ? $tree->name() : null]));
113    }
114}
115