mirror of
				https://github.com/firefly-iii/firefly-iii.git
				synced 2025-10-31 18:54:58 +00:00 
			
		
		
		
	
		
			
				
	
	
		
			418 lines
		
	
	
		
			13 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
			
		
		
	
	
			418 lines
		
	
	
		
			13 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
| <?php
 | |
| /**
 | |
|  * ProfileController.php
 | |
|  * Copyright (c) 2017 thegrumpydictator@gmail.com
 | |
|  *
 | |
|  * This file is part of Firefly III.
 | |
|  *
 | |
|  * Firefly III is free software: you can redistribute it and/or modify
 | |
|  * it under the terms of the GNU General Public License as published by
 | |
|  * the Free Software Foundation, either version 3 of the License, or
 | |
|  * (at your option) any later version.
 | |
|  *
 | |
|  * Firefly III is distributed in the hope that it will be useful,
 | |
|  * but WITHOUT ANY WARRANTY; without even the implied warranty of
 | |
|  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 | |
|  * GNU General Public License for more details.
 | |
|  *
 | |
|  * You should have received a copy of the GNU General Public License
 | |
|  * along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
 | |
|  */
 | |
| declare(strict_types=1);
 | |
| 
 | |
| namespace FireflyIII\Http\Controllers;
 | |
| 
 | |
| use Auth;
 | |
| use FireflyIII\Events\UserChangedEmail;
 | |
| use FireflyIII\Exceptions\FireflyException;
 | |
| use FireflyIII\Exceptions\ValidationException;
 | |
| use FireflyIII\Http\Middleware\IsDemoUser;
 | |
| use FireflyIII\Http\Middleware\IsSandStormUser;
 | |
| use FireflyIII\Http\Requests\DeleteAccountFormRequest;
 | |
| use FireflyIII\Http\Requests\EmailFormRequest;
 | |
| use FireflyIII\Http\Requests\ProfileFormRequest;
 | |
| use FireflyIII\Http\Requests\TokenFormRequest;
 | |
| use FireflyIII\Models\Preference;
 | |
| use FireflyIII\Repositories\User\UserRepositoryInterface;
 | |
| use FireflyIII\User;
 | |
| use Google2FA;
 | |
| use Hash;
 | |
| use Illuminate\Contracts\Auth\Guard;
 | |
| use Log;
 | |
| use Preferences;
 | |
| use Session;
 | |
| use View;
 | |
| 
 | |
| /**
 | |
|  * Class ProfileController.
 | |
|  *
 | |
|  * @method Guard guard()
 | |
|  */
 | |
| class ProfileController extends Controller
 | |
| {
 | |
|     /**
 | |
|      * ProfileController constructor.
 | |
|      */
 | |
|     public function __construct()
 | |
|     {
 | |
|         parent::__construct();
 | |
| 
 | |
|         $this->middleware(
 | |
|             function ($request, $next) {
 | |
|                 app('view')->share('title', trans('firefly.profile'));
 | |
|                 app('view')->share('mainTitleIcon', 'fa-user');
 | |
| 
 | |
|                 return $next($request);
 | |
|             }
 | |
|         );
 | |
|         $this->middleware(IsDemoUser::class)->except(['index']);
 | |
|         $this->middleware(IsSandStormUser::class)->except('index');
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * @return View
 | |
|      */
 | |
|     public function changeEmail()
 | |
|     {
 | |
|         $title        = auth()->user()->email;
 | |
|         $email        = auth()->user()->email;
 | |
|         $subTitle     = strval(trans('firefly.change_your_email'));
 | |
|         $subTitleIcon = 'fa-envelope';
 | |
| 
 | |
|         return view('profile.change-email', compact('title', 'subTitle', 'subTitleIcon', 'email'));
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * @return View
 | |
|      */
 | |
|     public function changePassword()
 | |
|     {
 | |
|         $title        = auth()->user()->email;
 | |
|         $subTitle     = strval(trans('firefly.change_your_password'));
 | |
|         $subTitleIcon = 'fa-key';
 | |
| 
 | |
|         return view('profile.change-password', compact('title', 'subTitle', 'subTitleIcon'));
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * View that generates a 2FA code for the user.
 | |
|      *
 | |
|      * @return View
 | |
|      */
 | |
|     public function code()
 | |
|     {
 | |
|         $domain = $this->getDomain();
 | |
|         $secret = Google2FA::generateSecretKey();
 | |
|         Session::flash('two-factor-secret', $secret);
 | |
|         $image = Google2FA::getQRCodeInline($domain, auth()->user()->email, $secret, 200);
 | |
| 
 | |
|         return view('profile.code', compact('image'));
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * @param UserRepositoryInterface $repository
 | |
|      * @param string                  $token
 | |
|      *
 | |
|      * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
 | |
|      *
 | |
|      * @throws FireflyException
 | |
|      */
 | |
|     public function confirmEmailChange(UserRepositoryInterface $repository, string $token)
 | |
|     {
 | |
|         // find preference with this token value.
 | |
|         $set  = Preferences::findByName('email_change_confirm_token');
 | |
|         $user = null;
 | |
|         Log::debug(sprintf('Found %d preferences', $set->count()));
 | |
|         /** @var Preference $preference */
 | |
|         foreach ($set as $preference) {
 | |
|             if ($preference->data === $token) {
 | |
|                 Log::debug('Found user');
 | |
|                 $user = $preference->user;
 | |
|             }
 | |
|         }
 | |
|         // update user to clear blocked and blocked_code.
 | |
|         if (null === $user) {
 | |
|             Log::debug('Found no user');
 | |
|             throw new FireflyException('Invalid token.');
 | |
|         }
 | |
|         Log::debug('Will unblock user.');
 | |
|         $repository->unblockUser($user);
 | |
| 
 | |
|         // return to login.
 | |
|         Session::flash('success', strval(trans('firefly.login_with_new_email')));
 | |
| 
 | |
|         return redirect(route('login'));
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * @return View
 | |
|      */
 | |
|     public function deleteAccount()
 | |
|     {
 | |
|         $title        = auth()->user()->email;
 | |
|         $subTitle     = strval(trans('firefly.delete_account'));
 | |
|         $subTitleIcon = 'fa-trash';
 | |
| 
 | |
|         return view('profile.delete-account', compact('title', 'subTitle', 'subTitleIcon'));
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
 | |
|      */
 | |
|     public function deleteCode()
 | |
|     {
 | |
|         Preferences::delete('twoFactorAuthEnabled');
 | |
|         Preferences::delete('twoFactorAuthSecret');
 | |
|         Session::flash('success', strval(trans('firefly.pref_two_factor_auth_disabled')));
 | |
|         Session::flash('info', strval(trans('firefly.pref_two_factor_auth_remove_it')));
 | |
| 
 | |
|         return redirect(route('profile.index'));
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
 | |
|      */
 | |
|     public function enable2FA(UserRepositoryInterface $repository)
 | |
|     {
 | |
|         if ($repository->hasRole(auth()->user(), 'demo')) {
 | |
|             return redirect(route('profile.index'));
 | |
|         }
 | |
|         $hasTwoFactorAuthSecret = (null !== Preferences::get('twoFactorAuthSecret'));
 | |
| 
 | |
|         // if we don't have a valid secret yet, redirect to the code page to get one.
 | |
|         if (!$hasTwoFactorAuthSecret) {
 | |
|             return redirect(route('profile.code'));
 | |
|         }
 | |
| 
 | |
|         // If FF3 already has a secret, just set the two factor auth enabled to 1,
 | |
|         // and let the user continue with the existing secret.
 | |
| 
 | |
|         Preferences::set('twoFactorAuthEnabled', 1);
 | |
| 
 | |
|         return redirect(route('profile.index'));
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * @return View
 | |
|      */
 | |
|     public function index()
 | |
|     {
 | |
|         $subTitle   = auth()->user()->email;
 | |
|         $userId     = auth()->user()->id;
 | |
|         $enabled2FA = intval(Preferences::get('twoFactorAuthEnabled', 0)->data) === 1;
 | |
| 
 | |
|         // get access token or create one.
 | |
|         $accessToken = Preferences::get('access_token', null);
 | |
|         if (null === $accessToken) {
 | |
|             $token       = auth()->user()->generateAccessToken();
 | |
|             $accessToken = Preferences::set('access_token', $token);
 | |
|         }
 | |
| 
 | |
|         return view('profile.index', compact('subTitle', 'userId', 'accessToken', 'enabled2FA'));
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * @param EmailFormRequest        $request
 | |
|      * @param UserRepositoryInterface $repository
 | |
|      *
 | |
|      * @return $this|\Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
 | |
|      */
 | |
|     public function postChangeEmail(EmailFormRequest $request, UserRepositoryInterface $repository)
 | |
|     {
 | |
|         /** @var User $user */
 | |
|         $user     = auth()->user();
 | |
|         $newEmail = $request->string('email');
 | |
|         $oldEmail = $user->email;
 | |
|         if ($newEmail === $user->email) {
 | |
|             Session::flash('error', strval(trans('firefly.email_not_changed')));
 | |
| 
 | |
|             return redirect(route('profile.change-email'))->withInput();
 | |
|         }
 | |
|         $existing = $repository->findByEmail($newEmail);
 | |
|         if (null !== $existing) {
 | |
|             // force user logout.
 | |
|             Auth::guard()->logout();
 | |
|             $request->session()->invalidate();
 | |
| 
 | |
|             Session::flash('success', strval(trans('firefly.email_changed')));
 | |
| 
 | |
|             return redirect(route('index'));
 | |
|         }
 | |
| 
 | |
|         // now actually update user:
 | |
|         $repository->changeEmail($user, $newEmail);
 | |
| 
 | |
|         // call event.
 | |
|         $ipAddress = $request->ip();
 | |
|         event(new UserChangedEmail($user, $newEmail, $oldEmail, $ipAddress));
 | |
| 
 | |
|         // force user logout.
 | |
|         Auth::guard()->logout();
 | |
|         $request->session()->invalidate();
 | |
|         Session::flash('success', strval(trans('firefly.email_changed')));
 | |
| 
 | |
|         return redirect(route('index'));
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * @param ProfileFormRequest      $request
 | |
|      * @param UserRepositoryInterface $repository
 | |
|      *
 | |
|      * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
 | |
|      */
 | |
|     public function postChangePassword(ProfileFormRequest $request, UserRepositoryInterface $repository)
 | |
|     {
 | |
|         // the request has already validated both new passwords must be equal.
 | |
|         $current = $request->get('current_password');
 | |
|         $new     = $request->get('new_password');
 | |
| 
 | |
|         try {
 | |
|             $this->validatePassword(auth()->user(), $current, $new);
 | |
|         } catch (ValidationException $e) {
 | |
|             Session::flash('error', $e->getMessage());
 | |
| 
 | |
|             return redirect(route('profile.change-password'));
 | |
|         }
 | |
| 
 | |
|         $repository->changePassword(auth()->user(), $request->get('new_password'));
 | |
|         Session::flash('success', strval(trans('firefly.password_changed')));
 | |
| 
 | |
|         return redirect(route('profile.index'));
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * @param TokenFormRequest $request
 | |
|      *
 | |
|      * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
 | |
|      * @SuppressWarnings(PHPMD.UnusedFormalParameter) // it's unused but the class does some validation.
 | |
|      */
 | |
|     public function postCode(TokenFormRequest $request)
 | |
|     {
 | |
|         Preferences::set('twoFactorAuthEnabled', 1);
 | |
|         Preferences::set('twoFactorAuthSecret', Session::get('two-factor-secret'));
 | |
| 
 | |
|         Session::flash('success', strval(trans('firefly.saved_preferences')));
 | |
|         Preferences::mark();
 | |
| 
 | |
|         return redirect(route('profile.index'));
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * @param UserRepositoryInterface  $repository
 | |
|      * @param DeleteAccountFormRequest $request
 | |
|      *
 | |
|      * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
 | |
|      */
 | |
|     public function postDeleteAccount(UserRepositoryInterface $repository, DeleteAccountFormRequest $request)
 | |
|     {
 | |
|         if (!Hash::check($request->get('password'), auth()->user()->password)) {
 | |
|             Session::flash('error', strval(trans('firefly.invalid_password')));
 | |
| 
 | |
|             return redirect(route('profile.delete-account'));
 | |
|         }
 | |
|         $user = auth()->user();
 | |
|         Log::info(sprintf('User #%d has opted to delete their account', auth()->user()->id));
 | |
|         // make repository delete user:
 | |
|         auth()->logout();
 | |
|         Session::flush();
 | |
|         $repository->destroy($user);
 | |
| 
 | |
|         return redirect(route('index'));
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
 | |
|      */
 | |
|     public function regenerate()
 | |
|     {
 | |
|         $token = auth()->user()->generateAccessToken();
 | |
|         Preferences::set('access_token', $token);
 | |
|         Session::flash('success', strval(trans('firefly.token_regenerated')));
 | |
| 
 | |
|         return redirect(route('profile.index'));
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * @param UserRepositoryInterface $repository
 | |
|      * @param string                  $token
 | |
|      * @param string                  $hash
 | |
|      *
 | |
|      * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
 | |
|      *
 | |
|      * @throws FireflyException
 | |
|      */
 | |
|     public function undoEmailChange(UserRepositoryInterface $repository, string $token, string $hash)
 | |
|     {
 | |
|         // find preference with this token value.
 | |
|         $set  = Preferences::findByName('email_change_undo_token');
 | |
|         $user = null;
 | |
|         /** @var Preference $preference */
 | |
|         foreach ($set as $preference) {
 | |
|             if ($preference->data === $token) {
 | |
|                 $user = $preference->user;
 | |
|             }
 | |
|         }
 | |
|         if (null === $user) {
 | |
|             throw new FireflyException('Invalid token.');
 | |
|         }
 | |
| 
 | |
|         // found user.
 | |
|         // which email address to return to?
 | |
|         $set = Preferences::beginsWith($user, 'previous_email_');
 | |
|         /** @var string $match */
 | |
|         $match = null;
 | |
|         foreach ($set as $entry) {
 | |
|             $hashed = hash('sha256', $entry->data);
 | |
|             if ($hashed === $hash) {
 | |
|                 $match = $entry->data;
 | |
|                 break;
 | |
|             }
 | |
|         }
 | |
|         if (null === $match) {
 | |
|             throw new FireflyException('Invalid token.');
 | |
|         }
 | |
|         // change user back
 | |
|         // now actually update user:
 | |
|         $repository->changeEmail($user, $match);
 | |
|         $repository->unblockUser($user);
 | |
| 
 | |
|         // return to login.
 | |
|         Session::flash('success', strval(trans('firefly.login_with_old_email')));
 | |
| 
 | |
|         return redirect(route('login'));
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * @param User   $user
 | |
|      * @param string $current
 | |
|      * @param string $new
 | |
|      *
 | |
|      * @return bool
 | |
|      *
 | |
|      * @throws ValidationException
 | |
|      */
 | |
|     protected function validatePassword(User $user, string $current, string $new): bool
 | |
|     {
 | |
|         if (!Hash::check($current, $user->password)) {
 | |
|             throw new ValidationException(strval(trans('firefly.invalid_current_password')));
 | |
|         }
 | |
| 
 | |
|         if ($current === $new) {
 | |
|             throw new ValidationException(strval(trans('firefly.should_change')));
 | |
|         }
 | |
| 
 | |
|         return true;
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * @return string
 | |
|      */
 | |
|     private function getDomain(): string
 | |
|     {
 | |
|         $url   = url()->to('/');
 | |
|         $parts = parse_url($url);
 | |
| 
 | |
|         return $parts['host'];
 | |
|     }
 | |
| }
 |