PostController::solved() - Code Metrics - Inspection of "Fixed PostController::solved() permission" - XetaIO/Xetaravel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — issue-47 ( 257fd0 )

by Fèvre

created 2018-03-15 12:59 UTC

PostController::solved() B

↳ Parent: PostController

Complexity

Conditions	3
Paths	3

Size

Total Lines	25
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	25
rs	8.8571
c	0
b	0
f	0
cc	3
eloc	16
nc	3
nop	1

<?php
namespace Xetaravel\Http\Controllers\Discuss;

use Carbon\Carbon;
use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;
use Xetaio\Mentions\Parser\MentionParser;
use Xetaravel\Models\DiscussConversation;
use Xetaravel\Models\DiscussPost;
use Xetaravel\Models\Repositories\DiscussPostRepository;
use Xetaravel\Models\Repositories\DiscussUserRepository;
use Xetaravel\Models\User;
use Xetaravel\Models\Validators\DiscussPostValidator;

class PostController extends Controller
{
    /**
     * Create a post for a conversation.
     *
     * @param \Illuminate\Http\Request $request
     *
     * @return \Illuminate\Http\RedirectResponse
     */
    public function create(Request $request): RedirectResponse
    {
        $conversation = DiscussConversation::findOrFail($request->conversation_id);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        // Users that have the permission "manage.discuss" can bypass this rule. (Default to Administrator)
        if (DiscussPost::isFlooding('xetaravel.flood.discuss.post') && !Auth::user()->hasPermission('manage.discuss')) {
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 back()
                ->withInput()
                ->with('danger', 'Wow, keep calm bro, and try to not flood !');
        }

        DiscussPostValidator::create($request->all())->validate();
        $post = DiscussPostRepository::create($request->all());
        $user = DiscussUserRepository::create($request->all());
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        $parser = new MentionParser($post);
        $content = $parser->parse($post->content);

        $post->content = $content;
        $post->save();

        return redirect()
            ->route('discuss.post.show', ['id' => $post->getKey()])
            ->with('success', 'Your reply has been posted successfully !');
    }

    /**
     * Redirect an user to a conversation, page and post.
     *
     * @param \Illuminate\Http\Request $request
     * @param int $id The ID of the post.
     *
     * @return \Illuminate\Http\RedirectResponse
     */
    public function show(Request $request, int $id): RedirectResponse

    {
        $post = DiscussPost::findOrFail($id);

        $postsBefore = DiscussPost::where([
            ['conversation_id', $post->conversation_id],
            ['created_at', '<', $post->created_at]
        ])->count();

        $postsPerPage = config('xetaravel.pagination.discuss.post_per_page');

        $page = floor($postsBefore / $postsPerPage) + 1;
        $page = ($page > 1) ? $page : 1;

        $request->session()->keep(['primary', 'danger', 'warning', 'success', 'info']);


        return redirect()
            ->route(
                'discuss.conversation.show',
                [
                    'slug' => $post->conversation->slug,
                    'id' => $post->conversation->id,
                    'page' => $page,
                    '#post-' . $post->getKey()
                ]
            );
    }

    /**
     * Handle a delete action for the post.
     *
     * @param \Illuminate\Http\Request $request
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param int $id
     *
     * @return \Illuminate\Http\RedirectResponse
     */
    public function delete(int $id): RedirectResponse
    {
        $post = DiscussPost::findOrFail($id);

        $this->authorize('delete', $post);

        if ($post->conversation->first_post_id == $post->getKey()) {
            return redirect()
                ->route('discuss.post.show', ['id' => $post->getKey()])
                ->with('danger', 'You can not delete the first post of a discussion !');
        }

        if ($post->delete()) {
            return redirect()
                ->route(
                    'discuss.conversation.show',
                    ['id' => $post->conversation->getKey(), 'slug' => $post->conversation->slug]
                )
                ->with('success', 'This post has been deleted successfully !');
        }

        return redirect()
            ->route('discuss.post.show', ['id' => $post->getKey()])
            ->with('danger', 'An error occurred while deleting this post !');
    }

    /**
     * Mark as solved.
     *
     * @param int $id
     *
     * @return \Illuminate\Http\RedirectResponse
     */
    public function solved(int $id): RedirectResponse
    {
        $post = DiscussPost::findOrFail($id);

        $this->authorize('solved', $post);

        if ($post->getKey() == $post->conversation->solved_post_id) {
            return back()
                ->with('danger', 'This post is already the solved post !');
        }

        if (!is_null($post->conversation->solved_post_id)) {
            return back()
                ->with('danger', 'This conversation has already a solved post !');
        }
        $conversation = DiscussConversation::findOrFail($post->conversation_id);

        $conversation->solved_post_id = $post->getKey();
        $conversation->is_solved = true;
        $conversation->save();

        return redirect()
            ->route('discuss.conversation.show', ['slug' => $conversation->slug, 'id' => $conversation->getKey()])
            ->with('success', 'This reply as been marked as solved !');
    }

    /**
     * Handle an edit action for the post.
     *
     * @param Request $request
     * @param int $id The id of the post to edit.
     *
     * @return \Illuminate\Http\RedirectResponse
     */
    public function edit(Request $request, int $id) : RedirectResponse
    {
        $post = DiscussPost::findOrFail($id);

        if (!Auth::user()->can('update', $post)) {
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 back()
                ->with('danger', 'You\'re not authorized to edit this message.');
        }

        DiscussPostValidator::edit($request->all())->validate();

        $parser = new MentionParser($post);
        $content = $parser->parse($request->input('content'));


        $post->content = $content;
        $post->is_edited = true;
        $post->edit_count++;
        $post->edited_user_id = Auth::id();
        $post->edited_at = Carbon::now();
        $post->save();

        return redirect()
            ->route('discuss.post.show', ['id' => $id])
            ->with('success', 'Your post has been edited successfully !');
    }

    /**
     * Get the edit json template.
     *
     * @param int $id
     *
     * @return \Illuminate\Http\JsonResponse|\Illuminate\View\View

     */
    public function editTemplate(int $id)
    {
        $post = DiscussPost::find($id);

        if (!Auth::user()->can('update', $post) || !$post) {
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 response()->json([
                'error' => true,
                'message' => 'You\'re not authorized to edit this message or this message has been deleted.'
            ]);
        }

        return response(
            view('Discuss::post.editTemplate', ['post' => $post]),
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            200,
            ['Content-Type' => 'application/json']
        );
    }
}


Push — issue-47 ( 257fd0 )

PostController::solved() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

1		<?php
2		namespace Xetaravel\Http\Controllers\Discuss;
3
4		use Carbon\Carbon;
5		use Illuminate\Http\RedirectResponse;
6		use Illuminate\Http\Request;
7		use Illuminate\Support\Facades\Auth;
8		use Xetaio\Mentions\Parser\MentionParser;
9		use Xetaravel\Models\DiscussConversation;
10		use Xetaravel\Models\DiscussPost;
11		use Xetaravel\Models\Repositories\DiscussPostRepository;
12		use Xetaravel\Models\Repositories\DiscussUserRepository;
13		use Xetaravel\Models\User;
14		use Xetaravel\Models\Validators\DiscussPostValidator;
15
16		class PostController extends Controller
17		{
18		/**
19		* Create a post for a conversation.
20		*
21		* @param \Illuminate\Http\Request $request
22		*
23		* @return \Illuminate\Http\RedirectResponse
24		*/
25		public function create(Request $request): RedirectResponse
26		{
27		$conversation = DiscussConversation::findOrFail($request->conversation_id);
		0 ignored issues – show Unused Code introduced 2017-06-14 23:44 UTC by Report Bug Copy Issue Report `$conversation` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
28
29		// Users that have the permission "manage.discuss" can bypass this rule. (Default to Administrator)
30	View Code Duplication	if (DiscussPost::isFlooding('xetaravel.flood.discuss.post') && !Auth::user()->hasPermission('manage.discuss')) {
		0 ignored issues – show Bug introduced 2018-03-12 23:31 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 `hasPermission()` does only exist in the following implementations of said interface: `Xetaravel\Models\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... Duplication introduced 2018-03-15 02:58 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
31		return back()
32		->withInput()
33		->with('danger', 'Wow, keep calm bro, and try to not flood !');
34		}
35
36		DiscussPostValidator::create($request->all())->validate();
37		$post = DiscussPostRepository::create($request->all());
38		$user = DiscussUserRepository::create($request->all());
		0 ignored issues – show Unused Code introduced 2017-06-14 23:44 UTC by Report Bug Copy Issue Report `$user` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
39
40		$parser = new MentionParser($post);
41		$content = $parser->parse($post->content);
42
43		$post->content = $content;
44		$post->save();
45
46		return redirect()
47		->route('discuss.post.show', ['id' => $post->getKey()])
48		->with('success', 'Your reply has been posted successfully !');
49		}
50
51		/**
52		* Redirect an user to a conversation, page and post.
53		*
54		* @param \Illuminate\Http\Request $request
55		* @param int $id The ID of the post.
56		*
57		* @return \Illuminate\Http\RedirectResponse
58		*/
59	View Code Duplication	public function show(Request $request, int $id): RedirectResponse
		0 ignored issues – show Duplication introduced 2018-03-11 13:12 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
60		{
61		$post = DiscussPost::findOrFail($id);
62
63		$postsBefore = DiscussPost::where([
64		['conversation_id', $post->conversation_id],
65		['created_at', '<', $post->created_at]
66		])->count();
67
68		$postsPerPage = config('xetaravel.pagination.discuss.post_per_page');
69
70		$page = floor($postsBefore / $postsPerPage) + 1;
71		$page = ($page > 1) ? $page : 1;
72
73		$request->session()->keep(['primary', 'danger', 'warning', 'success', 'info']);
		0 ignored issues – show Bug introduced 2017-06-14 23:44 UTC by Report Bug Copy Issue Report The method `keep()` does not seem to exist on `object<Symfony\Component...ssion\SessionInterface>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
74
75		return redirect()
76		->route(
77		'discuss.conversation.show',
78		[
79		'slug' => $post->conversation->slug,
80		'id' => $post->conversation->id,
81		'page' => $page,
82		'#post-' . $post->getKey()
83		]
84		);
85		}
86
87		/**
88		* Handle a delete action for the post.
89		*
90		* @param \Illuminate\Http\Request $request
		0 ignored issues – show Bug introduced 2017-07-03 11:07 UTC by Report Bug Copy Issue Report There is no parameter named `$request`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
91		* @param int $id
92		*
93		* @return \Illuminate\Http\RedirectResponse
94		*/
95		public function delete(int $id): RedirectResponse
96		{
97		$post = DiscussPost::findOrFail($id);
98
99		$this->authorize('delete', $post);
100
101		if ($post->conversation->first_post_id == $post->getKey()) {
102		return redirect()
103		->route('discuss.post.show', ['id' => $post->getKey()])
104		->with('danger', 'You can not delete the first post of a discussion !');
105		}
106
107		if ($post->delete()) {
108		return redirect()
109		->route(
110		'discuss.conversation.show',
111		['id' => $post->conversation->getKey(), 'slug' => $post->conversation->slug]
112		)
113		->with('success', 'This post has been deleted successfully !');
114		}
115
116		return redirect()
117		->route('discuss.post.show', ['id' => $post->getKey()])
118		->with('danger', 'An error occurred while deleting this post !');
119		}
120
121		/**
122		* Mark as solved.
123		*
124		* @param int $id
125		*
126		* @return \Illuminate\Http\RedirectResponse
127		*/
128		public function solved(int $id): RedirectResponse
129		{
130		$post = DiscussPost::findOrFail($id);
131
132		$this->authorize('solved', $post);
133
134		if ($post->getKey() == $post->conversation->solved_post_id) {
135		return back()
136		->with('danger', 'This post is already the solved post !');
137		}
138
139		if (!is_null($post->conversation->solved_post_id)) {
140		return back()
141		->with('danger', 'This conversation has already a solved post !');
142		}
143		$conversation = DiscussConversation::findOrFail($post->conversation_id);
144
145		$conversation->solved_post_id = $post->getKey();
146		$conversation->is_solved = true;
147		$conversation->save();
148
149		return redirect()
150		->route('discuss.conversation.show', ['slug' => $conversation->slug, 'id' => $conversation->getKey()])
151		->with('success', 'This reply as been marked as solved !');
152		}
153
154		/**
155		* Handle an edit action for the post.
156		*
157		* @param Request $request
158		* @param int $id The id of the post to edit.
159		*
160		* @return \Illuminate\Http\RedirectResponse
161		*/
162		public function edit(Request $request, int $id) : RedirectResponse
163		{
164		$post = DiscussPost::findOrFail($id);
165
166		if (!Auth::user()->can('update', $post)) {
		0 ignored issues – show Bug introduced 2017-07-03 11:07 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 `can()` does only exist in the following implementations of said interface: `Illuminate\Foundation\Auth\User`, `Tests\vendor\Models\User`, `Xetaravel\Models\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...
167		return back()
168		->with('danger', 'You\'re not authorized to edit this message.');
169		}
170
171		DiscussPostValidator::edit($request->all())->validate();
172
173		$parser = new MentionParser($post);
174		$content = $parser->parse($request->input('content'));
		0 ignored issues – show Bug introduced 2018-03-13 16:26 UTC by Report Bug Copy Issue Report It seems like `$request->input('content')` targeting `Illuminate\Http\Concerns...ractsWithInput::input()` can also be of type `array`; however, `Xetaio\Mentions\Parser\MentionParser::parse()` does only seem to accept `null\|string`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
175
176		$post->content = $content;
177		$post->is_edited = true;
178		$post->edit_count++;
179		$post->edited_user_id = Auth::id();
180		$post->edited_at = Carbon::now();
181		$post->save();
182
183		return redirect()
184		->route('discuss.post.show', ['id' => $id])
185		->with('success', 'Your post has been edited successfully !');
186		}
187
188		/**
189		* Get the edit json template.
190		*
191		* @param int $id
192		*
193		* @return \Illuminate\Http\JsonResponse\|\Illuminate\View\View
		0 ignored issues – show Documentation introduced 2017-07-03 11:07 UTC by Report Bug Copy Issue Report Should the return type not be `\Symfony\Component\HttpFoundation\Response`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
194		*/
195		public function editTemplate(int $id)
196		{
197		$post = DiscussPost::find($id);
198
199		if (!Auth::user()->can('update', $post) \|\| !$post) {
		0 ignored issues – show Bug introduced 2017-07-03 11:07 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 `can()` does only exist in the following implementations of said interface: `Illuminate\Foundation\Auth\User`, `Tests\vendor\Models\User`, `Xetaravel\Models\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...
200		return response()->json([
201		'error' => true,
202		'message' => 'You\'re not authorized to edit this message or this message has been deleted.'
203		]);
204		}
205
206		return response(
207		view('Discuss::post.editTemplate', ['post' => $post]),
		0 ignored issues – show Documentation introduced 2017-07-03 11:07 UTC by Report Bug Copy Issue Report `view('Discuss::post.edit...array('post' => $post))` is of type `object<Illuminate\View\V...Contracts\View\Factory>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
208		200,
209		['Content-Type' => 'application/json']
210		);
211		}
212		}
213

XetaIO / Xetaravel

Push — issue-47 ( 257fd0 )

PostController::solved() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like