UserEventHandler::checkSingleUserIsAdmin() - Code Metrics - Inspection of "Merge branch 'release/4.6.11.1'" - firefly-iii/firefly-iii - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f7eb78...e47b21 )

by James

created 2017-12-08 18:53 UTC

UserEventHandler::checkSingleUserIsAdmin() B

↳ Parent: Project

Complexity

Conditions	5
Paths	4

Size

Total Lines	34
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	34
rs	8.439
c	0
b	0
f	0
cc	5
eloc	18
nc	4
nop	1

<?php
/**
 * UserEventHandler.php
 * Copyright (c) 2017 [email protected]
 *
 * 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\Handlers\Events;

use FireflyIII\Events\RegisteredUser;
use FireflyIII\Events\RequestedNewPassword;
use FireflyIII\Events\UserChangedEmail;
use FireflyIII\Mail\ConfirmEmailChangeMail;
use FireflyIII\Mail\RegisteredUser as RegisteredUserMail;
use FireflyIII\Mail\RequestedNewPassword as RequestedNewPasswordMail;
use FireflyIII\Mail\UndoEmailChangeMail;
use FireflyIII\Models\Role;
use FireflyIII\Repositories\User\UserRepositoryInterface;
use FireflyIII\User;
use Illuminate\Auth\Events\Login;
use Log;
use Mail;
use Preferences;
use Swift_TransportException;

/**
 * Class UserEventHandler.
 *
 * This class responds to any events that have anything to do with the User object.
 *
 * The method name reflects what is being done. This is in the present tense.
 */
class UserEventHandler
{
    /**
     * This method will bestow upon a user the "owner" role if he is the first user in the system.
     *
     * @param RegisteredUser $event
     *
     * @return bool
     */
    public function attachUserRole(RegisteredUser $event): bool
    {
        /** @var UserRepositoryInterface $repository */
        $repository = app(UserRepositoryInterface::class);

        // first user ever?
        if (1 === $repository->count()) {
            $repository->attachRole($event->user, 'owner');
        }

        return true;
    }

    /**
     * @param Login $event
     *
     * @return bool
     */
    public function checkSingleUserIsAdmin(Login $event): bool
    {
        Log::debug('In checkSingleUserIsAdmin');

        $user  = $event->user;
        $count = User::count();

        if ($count > 1) {
            // if more than one user, do nothing.
            Log::debug(sprintf('System has %d users, will not change users roles.', $count));

            return true;
        }
        // user is only user but has admin role
        if ($count === 1 && $user->hasRole('owner')) {
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            Log::debug(sprintf('User #%d is only user but has role owner so all is well.', $user->id));
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}

            return true;
        }
        // user is the only user but does not have role "owner".
        $role = Role::where('name', 'owner')->first();
        if (is_null($role)) {
            // create role, does not exist. Very strange situation so let's raise a big fuss about it.
            $role = Role::create(['name' => 'owner', 'display_name' => 'Site Owner', 'description' => 'User runs this instance of FF3']);
            Log::error('Could not find role "owner". This is weird.');
        }

        Log::info(sprintf('Gave user #%d role #%d ("%s")', $user->id, $role->id, $role->name));
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        // give user the role
        $user->attachRole($role);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        $user->save();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

        return true;
    }

    /**
     * @param UserChangedEmail $event
     *
     * @return bool
     */
    public function sendEmailChangeConfirmMail(UserChangedEmail $event): bool
    {
        $newEmail  = $event->newEmail;
        $oldEmail  = $event->oldEmail;
        $user      = $event->user;
        $ipAddress = $event->ipAddress;
        $token     = Preferences::getForUser($user, 'email_change_confirm_token', 'invalid');
        $uri       = route('profile.confirm-email-change', [$token->data]);
        try {
            Mail::to($newEmail)->send(new ConfirmEmailChangeMail($newEmail, $oldEmail, $uri, $ipAddress));
            // @codeCoverageIgnoreStart
        } catch (Swift_TransportException $e) {
            Log::error($e->getMessage());
        }

        // @codeCoverageIgnoreEnd
        return true;
    }

    /**
     * @param UserChangedEmail $event
     *
     * @return bool
     */
    public function sendEmailChangeUndoMail(UserChangedEmail $event): bool
    {
        $newEmail  = $event->newEmail;
        $oldEmail  = $event->oldEmail;
        $user      = $event->user;
        $ipAddress = $event->ipAddress;
        $token     = Preferences::getForUser($user, 'email_change_undo_token', 'invalid');
        $uri       = route('profile.undo-email-change', [$token->data, hash('sha256', $oldEmail)]);
        try {
            Mail::to($oldEmail)->send(new UndoEmailChangeMail($newEmail, $oldEmail, $uri, $ipAddress));
            // @codeCoverageIgnoreStart
        } catch (Swift_TransportException $e) {
            Log::error($e->getMessage());
        }

        // @codeCoverageIgnoreEnd
        return true;
    }

    /**
     * @param RequestedNewPassword $event
     *
     * @return bool
     */
    public function sendNewPassword(RequestedNewPassword $event): bool
    {
        $email     = $event->user->email;
        $ipAddress = $event->ipAddress;
        $token     = $event->token;

        $url = route('password.reset', [$token]);

        // send email.
        try {
            Mail::to($email)->send(new RequestedNewPasswordMail($url, $ipAddress));
            // @codeCoverageIgnoreStart
        } catch (Swift_TransportException $e) {
            Log::error($e->getMessage());
        }

        // @codeCoverageIgnoreEnd

        return true;
    }

    /**
     * This method will send the user a registration mail, welcoming him or her to Firefly III.
     * This message is only sent when the configuration of Firefly III says so.
     *
     * @param RegisteredUser $event
     *
     * @return bool
     */
    public function sendRegistrationMail(RegisteredUser $event)
    {
        $sendMail = env('SEND_REGISTRATION_MAIL', true);
        if (!$sendMail) {
            return true; // @codeCoverageIgnore
        }
        // get the email address
        $email     = $event->user->email;
        $uri       = route('index');
        $ipAddress = $event->ipAddress;

        // send email.
        try {
            Mail::to($email)->send(new RegisteredUserMail($uri, $ipAddress));
            // @codeCoverageIgnoreStart
        } catch (Swift_TransportException $e) {
            Log::error($e->getMessage());
        }

        // @codeCoverageIgnoreEnd

        return true;
    }
}


GitHub Access Token became invalid

Push — master ( f7eb78...e47b21 )

UserEventHandler::checkSingleUserIsAdmin() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

1			<?php
2			/**
3			* UserEventHandler.php
4			* Copyright (c) 2017 [email protected]
5			*
6			* This file is part of Firefly III.
7			*
8			* Firefly III is free software: you can redistribute it and/or modify
9			* it under the terms of the GNU General Public License as published by
10			* the Free Software Foundation, either version 3 of the License, or
11			* (at your option) any later version.
12			*
13			* Firefly III is distributed in the hope that it will be useful,
14			* but WITHOUT ANY WARRANTY; without even the implied warranty of
15			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16			* GNU General Public License for more details.
17			*
18			* You should have received a copy of the GNU General Public License
19			* along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
20			*/
21			declare(strict_types=1);
22
23			namespace FireflyIII\Handlers\Events;
24
25			use FireflyIII\Events\RegisteredUser;
26			use FireflyIII\Events\RequestedNewPassword;
27			use FireflyIII\Events\UserChangedEmail;
28			use FireflyIII\Mail\ConfirmEmailChangeMail;
29			use FireflyIII\Mail\RegisteredUser as RegisteredUserMail;
30			use FireflyIII\Mail\RequestedNewPassword as RequestedNewPasswordMail;
31			use FireflyIII\Mail\UndoEmailChangeMail;
32			use FireflyIII\Models\Role;
33			use FireflyIII\Repositories\User\UserRepositoryInterface;
34			use FireflyIII\User;
35			use Illuminate\Auth\Events\Login;
36			use Log;
37			use Mail;
38			use Preferences;
39			use Swift_TransportException;
40
41			/**
42			* Class UserEventHandler.
43			*
44			* This class responds to any events that have anything to do with the User object.
45			*
46			* The method name reflects what is being done. This is in the present tense.
47			*/
48			class UserEventHandler
49			{
50			/**
51			* This method will bestow upon a user the "owner" role if he is the first user in the system.
52			*
53			* @param RegisteredUser $event
54			*
55			* @return bool
56			*/
57			public function attachUserRole(RegisteredUser $event): bool
58			{
59			/** @var UserRepositoryInterface $repository */
60			$repository = app(UserRepositoryInterface::class);
61
62			// first user ever?
63			if (1 === $repository->count()) {
64			$repository->attachRole($event->user, 'owner');
65			}
66
67			return true;
68			}
69
70			/**
71			* @param Login $event
72			*
73			* @return bool
74			*/
75			public function checkSingleUserIsAdmin(Login $event): bool
76			{
77			Log::debug('In checkSingleUserIsAdmin');
78
79			$user = $event->user;
80			$count = User::count();
81
82			if ($count > 1) {
83			// if more than one user, do nothing.
84			Log::debug(sprintf('System has %d users, will not change users roles.', $count));
85
86			return true;
87			}
88			// user is only user but has admin role
89			if ($count === 1 && $user->hasRole('owner')) {
			0 ignored issues – show Bug introduced 2017-12-05 19:54 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Illuminate\Contracts\Auth\Authenticatable` as the method `hasRole()` does only exist in the following implementations of said interface: `FireflyIII\User`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
90			Log::debug(sprintf('User #%d is only user but has role owner so all is well.', $user->id));
			0 ignored issues – show Bug introduced 2017-12-05 19:54 UTC by Report Bug Copy Issue Report Accessing `id` on the interface `Illuminate\Contracts\Auth\Authenticatable` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
91
92			return true;
93			}
94			// user is the only user but does not have role "owner".
95			$role = Role::where('name', 'owner')->first();
96			if (is_null($role)) {
97			// create role, does not exist. Very strange situation so let's raise a big fuss about it.
98			$role = Role::create(['name' => 'owner', 'display_name' => 'Site Owner', 'description' => 'User runs this instance of FF3']);
99			Log::error('Could not find role "owner". This is weird.');
100			}
101
102			Log::info(sprintf('Gave user #%d role #%d ("%s")', $user->id, $role->id, $role->name));
			0 ignored issues – show Bug introduced 2017-12-05 19:54 UTC by Report Bug Copy Issue Report Accessing `id` on the interface `Illuminate\Contracts\Auth\Authenticatable` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
103			// give user the role
104			$user->attachRole($role);
			0 ignored issues – show Bug introduced 2017-12-05 19:54 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Illuminate\Contracts\Auth\Authenticatable` as the method `attachRole()` does only exist in the following implementations of said interface: `FireflyIII\User`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
105			$user->save();
			0 ignored issues – show Bug introduced 2017-12-05 19:54 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Illuminate\Contracts\Auth\Authenticatable` as the method `save()` does only exist in the following implementations of said interface: `FireflyIII\User`, `Illuminate\Foundation\Auth\User`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
106
107			return true;
108			}
109
110			/**
111			* @param UserChangedEmail $event
112			*
113			* @return bool
114			*/
115			public function sendEmailChangeConfirmMail(UserChangedEmail $event): bool
116			{
117			$newEmail = $event->newEmail;
118			$oldEmail = $event->oldEmail;
119			$user = $event->user;
120			$ipAddress = $event->ipAddress;
121			$token = Preferences::getForUser($user, 'email_change_confirm_token', 'invalid');
122			$uri = route('profile.confirm-email-change', [$token->data]);
123			try {
124			Mail::to($newEmail)->send(new ConfirmEmailChangeMail($newEmail, $oldEmail, $uri, $ipAddress));
125			// @codeCoverageIgnoreStart
126			} catch (Swift_TransportException $e) {
127			Log::error($e->getMessage());
128			}
129
130			// @codeCoverageIgnoreEnd
131			return true;
132			}
133
134			/**
135			* @param UserChangedEmail $event
136			*
137			* @return bool
138			*/
139			public function sendEmailChangeUndoMail(UserChangedEmail $event): bool
140			{
141			$newEmail = $event->newEmail;
142			$oldEmail = $event->oldEmail;
143			$user = $event->user;
144			$ipAddress = $event->ipAddress;
145			$token = Preferences::getForUser($user, 'email_change_undo_token', 'invalid');
146			$uri = route('profile.undo-email-change', [$token->data, hash('sha256', $oldEmail)]);
147			try {
148			Mail::to($oldEmail)->send(new UndoEmailChangeMail($newEmail, $oldEmail, $uri, $ipAddress));
149			// @codeCoverageIgnoreStart
150			} catch (Swift_TransportException $e) {
151			Log::error($e->getMessage());
152			}
153
154			// @codeCoverageIgnoreEnd
155			return true;
156			}
157
158			/**
159			* @param RequestedNewPassword $event
160			*
161			* @return bool
162			*/
163			public function sendNewPassword(RequestedNewPassword $event): bool
164			{
165			$email = $event->user->email;
166			$ipAddress = $event->ipAddress;
167			$token = $event->token;
168
169			$url = route('password.reset', [$token]);
170
171			// send email.
172			try {
173			Mail::to($email)->send(new RequestedNewPasswordMail($url, $ipAddress));
174			// @codeCoverageIgnoreStart
175			} catch (Swift_TransportException $e) {
176			Log::error($e->getMessage());
177			}
178
179			// @codeCoverageIgnoreEnd
180
181			return true;
182			}
183
184			/**
185			* This method will send the user a registration mail, welcoming him or her to Firefly III.
186			* This message is only sent when the configuration of Firefly III says so.
187			*
188			* @param RegisteredUser $event
189			*
190			* @return bool
191			*/
192			public function sendRegistrationMail(RegisteredUser $event)
193			{
194			$sendMail = env('SEND_REGISTRATION_MAIL', true);
195			if (!$sendMail) {
196			return true; // @codeCoverageIgnore
197			}
198			// get the email address
199			$email = $event->user->email;
200			$uri = route('index');
201			$ipAddress = $event->ipAddress;
202
203			// send email.
204			try {
205			Mail::to($email)->send(new RegisteredUserMail($uri, $ipAddress));
206			// @codeCoverageIgnoreStart
207			} catch (Swift_TransportException $e) {
208			Log::error($e->getMessage());
209			}
210
211			// @codeCoverageIgnoreEnd
212
213			return true;
214			}
215			}
216

firefly-iii / firefly-iii

GitHub Access Token became invalid

Push — master ( f7eb78...e47b21 )

UserEventHandler::checkSingleUserIsAdmin() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like