GlobalContribsController::getGlobalContribs() - Code Metrics - Inspection of "Rewrite to use dependency injection and extend Abs..." - x-tools/xtools - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — main (#442)

by MusikAnimal
created 2023-03-14 17:47 UTC
GlobalContribsController::getGlobalContribs() A

↳ Parent: GlobalContribsController
Complexity

Conditions	1
Paths	1
Size

Total Lines	15
Code Lines	11
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	11
nc	1
nop	2
dl	0
loc	15
rs	9.9
c	0
b	0
f	0
<?php

declare(strict_types = 1);

namespace App\Controller;

use App\Model\Edit;
use App\Model\GlobalContribs;
use App\Repository\EditRepository;
use App\Repository\GlobalContribsRepository;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;

/**
 * This controller serves the search form and results for the Global Contributions tool.
 * @codeCoverageIgnore
 */
class GlobalContribsController extends XtoolsController
{

    /**
     * Get the name of the tool's index route. This is also the name of the associated model.
     * @return string
     * @codeCoverageIgnore
     */
    public function getIndexRoute(): string
    {
        return 'GlobalContribs';
    }

    /**
     * GlobalContribs can be very slow, especially for wide IP ranges, so limit to max 500 results.
     * @inheritDoc
     */
    public function maxLimit(): int
    {
        return 500;
    }

    /**
     * The search form.
     * @Route("/globalcontribs", name="GlobalContribs")
     * @Route("/ec-latestglobal", name="EditCounterLatestGlobalIndex")
     * @Route("/ec-latestglobal-contributions", name="EditCounterLatestGlobalContribsIndex")
     * @Route("/ec-latestglobaledits", name="EditCounterLatestGlobalEditsIndex")
     * @return Response
     */
    public function indexAction(): Response
    {
        // Redirect if username is given.
        if (isset($this->params['username'])) {
            return $this->redirectToRoute('GlobalContribsResult', $this->params);
        }

        // FIXME: Nasty hack until T226072 is resolved.
        $project = $this->projectRepo->getProject($this->i18n->getLang().'.wikipedia');
        if (!$project->exists()) {
            $project = $this->projectRepo->getProject($this->getParameter('central_auth_project'));
        }

        return $this->render('globalContribs/index.html.twig', array_merge([
            'xtPage' => 'GlobalContribs',
            'xtPageTitle' => 'tool-globalcontribs',
            'xtSubtitle' => 'tool-globalcontribs-desc',
            'project' => $project,

            // Defaults that will get overridden if in $this->params.
            'namespace' => 'all',
            'start' => '',
            'end' => '',
        ], $this->params));
    }

    /**
     * @param GlobalContribsRepository $globalContribsRepo
     * @param EditRepository $editRepo
     * @return GlobalContribs
     */
    public function getGlobalContribs(
        GlobalContribsRepository $globalContribsRepo,
        EditRepository $editRepo
    ): GlobalContribs {
        return new GlobalContribs(
            $globalContribsRepo,
            $this->pageRepo,
            $this->userRepo,
            $editRepo,
            $this->user,
            /** @scrutinizer ignore-type */ $this->user,
            $this->namespace,
            $this->start,
            $this->end,
            $this->offset,
            $this->limit
        );
    }

    /**
     * Display the latest global edits tool. First two routes are legacy.
     * @Route(
     *     "/ec-latestglobal-contributions/{project}/{username}",
     *     name="EditCounterLatestGlobalContribs",
     *     requirements={
     *         "username"="(ipr-.+\/\d+[^\/])|([^\/]+)",
     *     },
     *     defaults={
     *         "project"="",
     *         "namespace"="all"
     *     }
     * )
     * @Route(
     *     "/ec-latestglobal/{project}/{username}",
     *     name="EditCounterLatestGlobal",
     *     requirements={
     *         "username"="(ipr-.+\/\d+[^\/])|([^\/]+)",
     *     },
     *     defaults={
     *         "project"="",
     *         "namespace"="all"
     *     }
     * ),
     * @Route(
     *     "/globalcontribs/{username}/{namespace}/{start}/{end}/{offset}",
     *     name="GlobalContribsResult",
     *     requirements={
     *         "username"="(ipr-.+\/\d+[^\/])|([^\/]+)",
     *         "namespace"="|all|\d+",
     *         "start"="|\d*|\d{4}-\d{2}-\d{2}",
     *         "end"="|\d{4}-\d{2}-\d{2}",
     *         "offset"="|\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}",
     *     },
     *     defaults={
     *         "namespace"="all",
     *         "start"=false,
     *         "end"=false,
     *         "offset"=false,
     *     }
     * ),
     * @param GlobalContribsRepository $globalContribsRepo
     * @param EditRepository $editRepo
     * @return Response
     * @codeCoverageIgnore
     */
    public function resultsAction(GlobalContribsRepository $globalContribsRepo, EditRepository $editRepo): Response
    {
        $globalContribs = $this->getGlobalContribs($globalContribsRepo, $editRepo);
        $defaultProject = $this->projectRepo->getProject($this->getParameter('central_auth_project'));

        return $this->render('globalContribs/result.html.twig', [
            'xtTitle' => $this->user->getUsername(),
            'xtTitle' => $this->user->/** @scrutinizer ignore-call */ getUsername(),
            'xtPage' => 'GlobalContribs',
            'is_sub_request' => $this->isSubRequest,
            'user' => $this->user,
            'project' => $defaultProject,
            'gc' => $globalContribs,
        ]);
    }

    /************************ API endpoints ************************/

    /**
     * Get global edits made by a user, IP or IP range.
     * @Route(
     *     "/api/user/globalcontribs/{username}/{namespace}/{start}/{end}/{offset}",
     *     name="UserApiGlobalContribs",
     *     requirements={
     *         "username"="(ipr-.+\/\d+[^\/])|([^\/]+)",
     *         "namespace"="|all|\d+",
     *         "start"="|\d*|\d{4}-\d{2}-\d{2}",
     *         "end"="|\d{4}-\d{2}-\d{2}",
     *         "offset"="|\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}",
     *     },
     *     defaults={
     *         "namespace"="all",
     *         "start"=false,
     *         "end"=false,
     *         "offset"=false,
     *         "limit"=50,
     *     },
     * )
     * @param GlobalContribsRepository $globalContribsRepo
     * @param EditRepository $editRepo
     * @return JsonResponse
     */
    public function resultsApiAction(
        GlobalContribsRepository $globalContribsRepo,
        EditRepository $editRepo
    ): JsonResponse {
        $this->recordApiUsage('user/globalcontribs');

        $globalContribs = $this->getGlobalContribs($globalContribsRepo, $editRepo);
        $defaultProject = $this->projectRepo->getProject($this->getParameter('central_auth_project'));
        $this->project = $defaultProject;

        $results = $globalContribs->globalEdits();
        $results = array_map(function (Edit $edit) {
            return $edit->getForJson(true, true);
        }, array_values($results));
        $results = $this->addFullPageTitlesAndContinue('globalcontribs', [], $results);

        return $this->getFormattedApiResponse($results);
    }
}

x-tools / xtools

Pull Request — main (#442)

GlobalContribsController::getGlobalContribs() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
