TopicController::subscribe() - Code Metrics - Inspection of "bugfix: pokazywanie dodanego komentarza na liscie" - adam-boduch/coyote - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 3b518a...cd2a02 )

by Adam
created 2021-11-13 14:33 UTC
TopicController::subscribe() A

↳ Parent: Project
Complexity

Conditions	2
Paths	2
Size

Total Lines	17
Code Lines	9
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	2
eloc	9
nc	2
nop	1
dl	0
loc	17
rs	9.9666
c	1
b	0
f	0
<?php

namespace Coyote\Http\Controllers\Forum;

use Coyote\Events\TopicSaved;
use Coyote\Forum;
use Coyote\Forum\Reason;
use Coyote\Http\Factories\CacheFactory;
use Coyote\Http\Resources\FlagResource;
use Coyote\Http\Resources\PollResource;
use Coyote\Http\Resources\PostCollection;
use Coyote\Http\Resources\TopicResource;
use Coyote\Repositories\Criteria\Forum\OnlyThoseWithAccess;
use Coyote\Repositories\Criteria\Post\WithSubscribers;
use Coyote\Repositories\Criteria\WithTrashed;
use Coyote\Repositories\Criteria\Post\WithTrashedInfo;
use Coyote\Services\Elasticsearch\Builders\Forum\MoreLikeThisBuilder;
use Coyote\Services\Flags;
use Coyote\Services\Forum\Tracker;
use Coyote\Services\Forum\TreeBuilder\Builder;
use Coyote\Services\Forum\TreeBuilder\JsonDecorator;
use Coyote\Services\Forum\TreeBuilder\ListDecorator;
use Coyote\Topic;
use Illuminate\Http\Request;

class TopicController extends BaseController
{
    use CacheFactory;

    /**
     * @var \Illuminate\Contracts\Auth\Access\Gate
     */
    private $gate;

    /**
     * @param Request $request
     * @param $forum
     * @param $topic
     * @return \Illuminate\Contracts\View\Factory|\Illuminate\Support\Collection|\Illuminate\View\View
     */
    public function index(Request $request, $forum, $topic)
    {
        $this->breadcrumb->push($topic->title, route('forum.topic', [$forum->slug, $topic->id, $topic->slug]));

        // get the topic (and forum) mark time value from middleware
        // @see \Coyote\Http\Middleware\ScrollToPost
        $markTime = $request->attributes->get('mark_time');

        $this->gate = $this->getGateFactory();

        // current page...
        $page = (int) $request->get('page');
        // number of posts per one page
        $perPage = $this->postsPerPage($request);

        // user with forum-update ability WILL see every post
        // NOTE: criteria MUST BE pushed before calling getPage() method!
        if ($this->gate->allows('delete', $forum)) {
            $this->post->pushCriteria(new WithTrashed());
            $this->post->pushCriteria(new WithTrashedInfo());

            // user is able to see real number of posts in this topic
            $topic->replies = $topic->replies_real;
        }

        // user wants to show certain post. we need to calculate page number based on post id.
        if ($request->filled('p')) {
            $page = $this->post->getPage(min(2147483647, (int) $request->get('p')), $topic->id, $perPage);
        }

        // show posts of last page if page parameter is higher than pages count
        $lastPage = max((int) ceil(($topic->replies + 1) / $perPage), 1);
        if ($page > $lastPage) {
            $page = $lastPage;
        }

        $this->post->pushCriteria(new WithSubscribers($this->userId));

        // magic happens here. get posts for given topic
        /* @var \Illuminate\Support\Collection $posts */
        $paginate = $this->post->lengthAwarePagination($topic, $page, $perPage);

        $this->pushForumCriteria(true);

        // create forum list for current user (according to user's privileges)
        $treeBuilder = new Builder($this->forum->list());
        $treeDecorator = new ListDecorator($treeBuilder);

        $userForums = $treeDecorator->build();

        // important: load topic owner so we can highlight user's login
        $page === 1 ? $topic->setRelation('firstPost', $paginate->first()) : $topic->load('firstPost');

        $tracker = Tracker::make($topic);

        $allForums = [];
        $reasons = null;

        if ($this->gate->allows('delete', $forum) || $this->gate->allows('move', $forum)) {
            $reasons = Reason::pluck('name', 'id')->toArray();

            $this->forum->resetCriteria();
            $this->pushForumCriteria(false);

            // forum list only for moderators
            $treeBuilder->setForums($this->forum->list());

            $allForums = (new JsonDecorator($treeBuilder))->build();
        }

        $resource = (new PostCollection($paginate))
            ->setRelations($topic, $forum)
            ->setTracker($tracker);

        $dateTime = $paginate->last()->created_at;
        // first, build array of posts with info which posts have been read
        // assign array ot posts variable. this is our skeleton! do not remove
        $posts = $resource->toResponse($this->request)->getData(true);

        // ..then, mark topic as read
        if ($markTime < $dateTime) {
            $tracker->asRead($dateTime);
        }

        if ($request->wantsJson()) {
            return $posts;
        }

        $topic->load('tags');

        return $this->view('forum.topic', compact('posts', 'forum', 'paginate', 'reasons'))->with([
            'mlt'           => $this->moreLikeThis($topic),
            'model'         => $topic, // we need eloquent model in twig to show information about locked/moved topic
            'topic'         => (new TopicResource($tracker))->resolve($request),
            'poll'          => $topic->poll ? (new PollResource($topic->poll))->resolve($request) : null,
            'is_writeable'  => $this->gate->allows('write', $forum) && $this->gate->allows('write', $topic),
            'all_forums'    => $allForums,
            'user_forums'   => $userForums,
            'description'   => excerpt(array_first($posts['data'])['text'], 100),
            'flags'         => $this->flags($forum)
        ]);
    }

    private function moreLikeThis(Topic $topic)
    {
        // build "more like this" block. it's important to send elasticsearch query before
        // send SQL query to database because search() method exists only in Model and not Builder class.
        return $this->getCacheFactory()->remember('mlt-post:' . $topic->id, now()->addDay(), function () use ($topic) {
            // it's important to reset criteria for the further queries
            $this->forum->resetCriteria();

            $this->forum->pushCriteria(new OnlyThoseWithAccess());

            $builder = new MoreLikeThisBuilder($topic, $this->forum->pluck('id'));

            // search related topics
            $mlt = $this->topic->search($builder);
            $mlt = $this->topic->search($builder);

            return $mlt;
        });
    }

    private function flags(Forum $forum): array
    {
        $flags = resolve(Flags::class)->fromModels([Topic::class])->permission('delete', [$forum])->get();

        return FlagResource::collection($flags)->toArray($this->request);

    }

    /**
     * @param \Coyote\Topic $topic
     */
    public function mark($topic)
    {
        $tracker = Tracker::make($topic);

        $tracker->asRead($topic->last_post_created_at);
    }
}

adam-boduch / coyote

Push — master ( 3b518a...cd2a02 )

TopicController::subscribe() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
