x-tools / xtools

src/Controller/GlobalContribsController.php

<?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 OpenApi\Annotations as OA;
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.
 */
class GlobalContribsController extends XtoolsController
{

    /**
     * @inheritDoc
     * @codeCoverageIgnore
     */
    public function getIndexRoute(): string
    {
        return 'GlobalContribs';
    }

    /**
     * GlobalContribs can be very slow, especially for wide IP ranges, so limit to max 500 results.
     * @inheritDoc
     * @codeCoverageIgnore
     */
    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")
     * @param string $centralAuthProject
     * @return Response
     */
    public function indexAction(string $centralAuthProject): 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($centralAuthProject);
        }

        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
     * @codeCoverageIgnore
     */
    public function getGlobalContribs(
        GlobalContribsRepository $globalContribsRepo,
        EditRepository $editRepo
    ): GlobalContribs {
        return new GlobalContribs(
            $globalContribsRepo,
            $this->pageRepo,
            $this->userRepo,
            $editRepo,
            $this->user,

It seems like $this->user can also be of type null; however, parameter $user of App\Model\GlobalContribs::__construct() does only seem to accept App\Model\User, maybe add an additional type check?

            $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}Z?",
     *     },
     *     defaults={
     *         "namespace"="all",
     *         "start"=false,
     *         "end"=false,
     *         "offset"=false,
     *     }
     * ),
     * @param GlobalContribsRepository $globalContribsRepo
     * @param EditRepository $editRepo
     * @param string $centralAuthProject
     * @return Response
     * @codeCoverageIgnore
     */
    public function resultsAction(
        GlobalContribsRepository $globalContribsRepo,
        EditRepository $editRepo,
        string $centralAuthProject
    ): Response {
        $globalContribs = $this->getGlobalContribs($globalContribsRepo, $editRepo);
        $defaultProject = $this->projectRepo->getProject($centralAuthProject);

        return $this->render('globalContribs/result.html.twig', [
            'xtTitle' => $this->user->getUsername(),

The method getUsername() does not exist on null.

            '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}Z?",
     *     },
     *     defaults={
     *         "namespace"="all",
     *         "start"=false,
     *         "end"=false,
     *         "offset"=false,
     *         "limit"=50,
     *     },
     *     methods={"GET"}
     * )
     * @OA\Tag(name="User API")
     * @OA\Get(description="Get contributions made by a user, IP or IP range across all Wikimedia projects.")
     * @OA\Parameter(ref="#/components/parameters/UsernameOrIp")
     * @OA\Parameter(ref="#/components/parameters/Namespace")
     * @OA\Parameter(ref="#/components/parameters/Start")
     * @OA\Parameter(ref="#/components/parameters/End")
     * @OA\Parameter(ref="#/components/parameters/Offset")
     * @OA\Response(
     *     response=200,
     *     description="Global contributions",
     *     @OA\JsonContent(
     *         @OA\Property(property="project", type="string", example="meta.wikimedia.org"),
     *         @OA\Property(property="username", ref="#/components/parameters/Username/schema"),
     *         @OA\Property(property="namespace", ref="#/components/schemas/Namespace"),
     *         @OA\Property(property="start", ref="#/components/parameters/Start/schema"),
     *         @OA\Property(property="end", ref="#/components/parameters/End/schema"),
     *         @OA\Property(property="globalcontribs", type="array",
     *             @OA\Items(ref="#/components/schemas/EditWithProject")
     *         ),
     *         @OA\Property(property="continue", type="date-time", example="2020-01-31T12:59:59Z"),
     *         @OA\Property(property="elapsed_time", ref="#/components/schemas/elapsed_time")
     *     )
     * )
     * @OA\Response(response=404, ref="#/components/responses/404")
     * @OA\Response(response=501, ref="#/components/responses/501")
     * @OA\Response(response=503, ref="#/components/responses/503")
     * @OA\Response(response=504, ref="#/components/responses/504")
     * @param GlobalContribsRepository $globalContribsRepo
     * @param EditRepository $editRepo
     * @param string $centralAuthProject
     * @return JsonResponse
     * @codeCoverageIgnore
     */
    public function resultsApiAction(
        GlobalContribsRepository $globalContribsRepo,
        EditRepository $editRepo,
        string $centralAuthProject
    ): JsonResponse {
        $this->recordApiUsage('user/globalcontribs');

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

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

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