Skip to content

Firefly III: a personal finances manager

9.4 KB
Raw Blame
<?php

/**
 * UserController.php
 * Copyright (c) 2019 [email protected]
 *
 * This file is part of Firefly III (https://github.com/firefly-iii).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
declare(strict_types=1);

namespace FireflyIII\Http\Controllers\Admin;

use FireflyIII\Events\Security\System\NewInvitationCreated;
use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Http\Controllers\Controller;
use FireflyIII\Http\Middleware\IsDemoUser;
use FireflyIII\Http\Requests\InviteUserFormRequest;
use FireflyIII\Http\Requests\UserFormRequest;
use FireflyIII\Models\InvitedUser;
use FireflyIII\Repositories\User\UserRepositoryInterface;
use FireflyIII\Support\Facades\AppConfiguration;
use FireflyIII\Support\Facades\Preferences;
use FireflyIII\User;
use Illuminate\Contracts\View\Factory;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\RedirectResponse;
use Illuminate\Routing\Redirector;
use Illuminate\Support\Facades\Log;
use Illuminate\View\View;
use Psr\Container\ContainerExceptionInterface;
use Psr\Container\NotFoundExceptionInterface;

/**
 * Class UserController.
 */
final class UserController extends Controller
{
    protected bool $externalIdentity;
    private UserRepositoryInterface $repository;

    /**
     * UserController constructor.
     */
    public function __construct()
    {
        parent::__construct();

        $this->middleware(function ($request, $next) {
            app('view')->share('title', (string) trans('firefly.system_settings'));
            app('view')->share('mainTitleIcon', 'bi-cpu');
            $this->repository = app(UserRepositoryInterface::class);

            return $next($request);
        });
        $this->middleware(IsDemoUser::class)->except(['index', 'show']);
        $this->externalIdentity = 'web' !== config('firefly.authentication_guard');
    }

    public function delete(User $user): Factory|\Illuminate\Contracts\View\View|Redirector|RedirectResponse
    {
        if ($this->externalIdentity) {
            request()->session()->flash('error', trans('firefly.external_user_mgt_disabled'));

            return redirect(route('settings.users'));
        }

        $subTitle = (string) trans('firefly.delete_user', ['email' => $user->email]);

        return view('settings.users.delete', ['user' => $user, 'subTitle' => $subTitle]);
    }

    public function deleteInvite(InvitedUser $invitedUser): JsonResponse
    {
        Log::debug('Will now delete invitation');
        if (true === $invitedUser->redeemed) {
            Log::debug('Is already redeemed.');
            session()->flash('error', trans('firefly.invite_is_already_redeemed', ['address' => $invitedUser->email]));

            return response()->json(['success' => false]);
        }
        Log::debug('Delete!');
        session()->flash('success', trans('firefly.invite_is_deleted', ['address' => $invitedUser->email]));
        $this->repository->deleteInvite($invitedUser);

        return response()->json(['success' => true]);
    }

    /**
     * Destroy a user.
     */
    public function destroy(User $user): RedirectResponse
    {
        if ($this->externalIdentity) {
            request()->session()->flash('error', trans('firefly.external_user_mgt_disabled'));

            return redirect(route('settings.users'));
        }
        $this->repository->destroy($user);
        session()->flash('success', (string) trans('firefly.user_deleted'));

        return redirect(route('settings.users'));
    }

    /**
     * Edit user form.
     *
     * @return Factory|View
     */
    public function edit(User $user): Factory|\Illuminate\Contracts\View\View
    {
        $canEditDetails = true;
        if ($this->externalIdentity) {
            $canEditDetails = false;
        }
        // put previous url in session if not redirect from store (not "return_to_edit").
        if (true !== session('users.edit.fromUpdate')) {
            $this->rememberPreviousUrl('users.edit.url');
        }
        session()->forget('users.edit.fromUpdate');

        $subTitle       = (string) trans('firefly.edit_user', ['email' => $user->email]);
        $subTitleIcon   = 'bi-person';
        $currentUser    = auth()->user();
        $isAdmin        = $this->repository->hasRole($user, 'owner');
        $codes          = [
            ''              => (string) trans('firefly.no_block_code'),
            'bounced'       => (string) trans('firefly.block_code_bounced'),
            'expired'       => (string) trans('firefly.block_code_expired'),
            'email_changed' => (string) trans('firefly.block_code_email_changed'),
        ];

        return view('settings.users.edit', [
            'user'           => $user,
            'canEditDetails' => $canEditDetails,
            'subTitle'       => $subTitle,
            'subTitleIcon'   => $subTitleIcon,
            'codes'          => $codes,
            'currentUser'    => $currentUser,
            'isAdmin'        => $isAdmin,
        ]);
    }

    /**
     * Show index of user manager.
     *
     * @return Factory|View
     *
     * @throws ContainerExceptionInterface
     * @throws FireflyException
     * @throws NotFoundExceptionInterface
     */
    public function index(): Factory|\Illuminate\Contracts\View\View
    {
        $subTitle       = (string) trans('firefly.user_administration');
        $subTitleIcon   = 'bi-people';
        $users          = $this->repository->all();
        $singleUserMode = (bool) AppConfiguration::get('single_user_mode', config('firefly.configuration.single_user_mode'))->data;
        $allowInvites   = false;
        if (!$this->externalIdentity && $singleUserMode) {
            // also registration enabled.
            $allowInvites = true;
        }

        $invitedUsers   = $this->repository->getInvitedUsers();

        // add meta stuff.
        $users->each(function (User $user): void {
            $user->isAdmin = $this->repository->hasRole($user, 'owner');
            $user->has2FA  = null !== $user->mfa_secret;
        });

        return view('settings.users.index', [
            'subTitle'     => $subTitle,
            'subTitleIcon' => $subTitleIcon,
            'users'        => $users,
            'allowInvites' => $allowInvites,
            'invitedUsers' => $invitedUsers,
        ]);
    }

    public function invite(InviteUserFormRequest $request): RedirectResponse
    {
        $address = (string) $request->input('invited_user');
        $invitee = $this->repository->inviteUser(auth()->user(), $address);
        session()->flash('info', trans('firefly.user_is_invited', ['address' => $address]));

        // event!
        event(new NewInvitationCreated($invitee));

        return redirect(route('settings.users'));
    }

    /**
     * Show single user.
     *
     * @return Factory|View
     */
    public function show(User $user): Factory|\Illuminate\Contracts\View\View
    {
        $title         = (string) trans('firefly.system_settings');
        $mainTitleIcon = 'bi-cpu';
        $subTitle      = (string) trans('firefly.single_user_administration', ['email' => $user->email]);
        $subTitleIcon  = 'bi-person';
        $information   = $this->repository->getUserData($user);

        return view('settings.users.show', [
            'title'         => $title,
            'mainTitleIcon' => $mainTitleIcon,
            'subTitle'      => $subTitle,
            'subTitleIcon'  => $subTitleIcon,
            'information'   => $information,
            'user'          => $user,
        ]);
    }

    /**
     * Update single user.
     *
     * @return RedirectResponse
     */
    public function update(UserFormRequest $request, User $user)
    {
        Log::debug('Actually here');
        $data     = $request->getUserData();

        // var_dump($data);

        // update password
        if (array_key_exists('password', $data) && '' !== $data['password']) {
            $this->repository->changePassword($user, $data['password']);
        }
        if (true === $data['is_owner']) {
            $this->repository->attachRole($user, 'owner');
            session()->flash('info', trans('firefly.give_admin_careful'));
        }
        if (false === $data['is_owner'] && $user->id !== auth()->user()->id) {
            $this->repository->removeRole($user, 'owner');
        }

        $this->repository->changeStatus($user, $data['blocked'], $data['blocked_code']);
        $this->repository->updateEmail($user, $data['email']);

        session()->flash('success', (string) trans('firefly.updated_user', ['email' => $user->email]));
        Preferences::mark();
        $redirect = redirect($this->getPreviousUrl('users.edit.url'));
        if (1 === (int) $request->input('return_to_edit')) {
            session()->put('users.edit.fromUpdate', true);

            $redirect = redirect(route('settings.users.edit', [$user->id]))->withInput(['return_to_edit' => 1]);
        }

        // redirect to previous URL.
        return $redirect;
    }
}