DefaultController::aboutAction() - Code Metrics - Inspection of "Add links to docs on mediawiki.org; rm About page" - x-tools/xtools - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed
Push — master ( 53c877...bfb78e )

by MusikAnimal
created 2021-04-06 22:30 UTC
DefaultController::aboutAction() A

↳ Parent: DefaultController
Complexity

Conditions	1
Paths	1
Size

Total Lines	4
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	3
CRAP Score	1
Importance

Changes
Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	4
ccs	3
cts	3
cp	1
crap	1
rs	10
c	0
b	0
f	0
<?php
/**
 * This file contains only the DefaultController class.
 */

declare(strict_types=1);

namespace AppBundle\Controller;

use AppBundle\Model\Edit;
use AppBundle\Repository\ProjectRepository;
use MediaWiki\OAuthClient\Client;
use MediaWiki\OAuthClient\ClientConfig;
use MediaWiki\OAuthClient\Consumer;
use MediaWiki\OAuthClient\Exception;
use MediaWiki\OAuthClient\Token;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\Session\Session;
use Symfony\Component\HttpFoundation\Session\SessionInterface;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Symfony\Component\Routing\Annotation\Route;

/**
 * The DefaultController handles the homepage, about pages, and user authentication.
 */
class DefaultController extends XtoolsController
{
    /** @var Client The Oauth HTTP client. */
    protected $oauthClient;

    /**
     * Required to be defined by XtoolsController, though here it is unused.
     * @return string
     * @codeCoverageIgnore
     */
    public function getIndexRoute(): string
    {
        return 'homepage';
    }

    /**
     * Display the homepage.
     * @Route("/", name="homepage")
     * @Route("/index.php", name="homepageIndexPhp")
     * @return Response
     */
    public function indexAction(): Response
    {
        return $this->render('default/index.html.twig', [
            'xtPage' => 'home',
        ]);
    }

    /**
     * Display some configuration details, when in development mode.
     * @Route("/config", name="configPage")
     * @return Response
     * @codeCoverageIgnore
     */
    public function configAction(): Response
    {

        if ('dev' !== $this->container->getParameter('kernel.environment')) {
            throw new NotFoundHttpException();
        }

        $params = $this->container->getParameterBag()->all();
        $params = $this->container->/** @scrutinizer ignore-call */ getParameterBag()->all();

        foreach (array_keys($params) as $key) {
            if (false !== strpos($key, 'password')) {
                $params[$key] = '<REDACTED>';
            }
        }

        // replace this example code with whatever you need
        return $this->render('default/config.html.twig', [
            'xtTitle' => 'Config',
            'xtPageTitle' => 'Config',
            'xtPage' => 'index',
            'dump' => print_r($params, true),
        ]);
    }

    /**
     * Redirect to the default project (or Meta) for Oauth authentication.
     * @Route("/login", name="login")
     * @param SessionInterface $session
     * @return RedirectResponse
     * @throws Exception If initialization fails.
     */
    public function loginAction(SessionInterface $session): RedirectResponse
    {
        try {
            [ $next, $token ] = $this->getOauthClient()->initiate();
        } catch (Exception $oauthException) {
            throw $oauthException;
            // @TODO Make this work.
            //$this->addFlash('error', $oauthException->getMessage());
            //return $this->redirectToRoute('homepage');
        }

        // Save the request token to the session.
        $session->set('oauth_request_token', $token);
        return new RedirectResponse($next);
    }

    /**
     * Receive authentication credentials back from the Oauth wiki.
     * @Route("/oauth_callback", name="oauth_callback")
     * @Route("/oauthredirector.php", name="old_oauth_callback")
     * @param Request $request The HTTP request.
     * @param SessionInterface $session
     * @return RedirectResponse
     */
    public function oauthCallbackAction(Request $request, SessionInterface $session): RedirectResponse
    {
        // Give up if the required GET params don't exist.
        if (!$request->get('oauth_verifier')) {
            throw $this->createNotFoundException('No OAuth verifier given.');
        }

        // Complete authentication.
        $client = $this->getOauthClient();
        $token = $session->get('oauth_request_token');

        if (!is_a($token, Token::class)) {
            $this->addFlashMessage('notice', 'error-login');
            return $this->redirectToRoute('homepage');
        }

        $verifier = $request->get('oauth_verifier');
        $accessToken = $client->complete($token, $verifier);

        // Store access token, and remove request token.
        $session->set('oauth_access_token', $accessToken);
        $session->remove('oauth_request_token');

        // Store user identity.
        $ident = $client->identify($accessToken);
        $session->set('logged_in_user', $ident);

        // Store reference to the client.
        $session->set('oauth_client', $this->oauthClient);

        // Send back to homepage.
        return $this->redirectToRoute('homepage');
    }

    /**
     * Get an OAuth client, configured to the default project.
     * (This shouldn't really be in this class, but oh well.)
     * @return Client
     * @codeCoverageIgnore
     */
    protected function getOauthClient(): Client
    {
        if ($this->oauthClient instanceof Client) {

            return $this->oauthClient;
        }
        $defaultProject = ProjectRepository::getProject(
            $this->getParameter('central_auth_project'),
            $this->container
        );
        $endpoint = $defaultProject->getUrl(false)
                    . $defaultProject->getScript()
                    . '?title=Special:OAuth';
        $conf = new ClientConfig($endpoint);
        $consumerKey = $this->getParameter('oauth_key');
        $consumerSecret =  $this->getParameter('oauth_secret');
        $conf->setConsumer(new Consumer($consumerKey, $consumerSecret));
        $this->oauthClient = new Client($conf);
        // Callback URL is hardcoded in the consumer registration.
        $this->oauthClient->setCallback('oob');
        return $this->oauthClient;
    }

    /**
     * Log out the user and return to the homepage.
     * @Route("/logout", name="logout")
     * @return RedirectResponse
     */
    public function logoutAction(): RedirectResponse
    {
        $this->get('session')->invalidate();
        return $this->redirectToRoute('homepage');
    }

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

    /**
     * Get domain name, URL, and API URL of the given project.
     * @Route("/api/project/normalize/{project}", name="ProjectApiNormalize")
     * @return JsonResponse
     */
    public function normalizeProjectApiAction(): JsonResponse
    {
        return $this->getFormattedApiResponse([
            'domain' => $this->project->getDomain(),
            'url' => $this->project->getUrl(),
            'api' => $this->project->getApiUrl(),
            'database' => $this->project->getDatabaseName(),
        ]);
    }

    /**
     * Get all namespaces of the given project. This endpoint also does the same thing
     * as the /project/normalize endpoint, returning other basic info about the project.
     * @Route("/api/project/namespaces/{project}", name="ProjectApiNamespaces")
     * @return JsonResponse
     */
    public function namespacesApiAction(): JsonResponse
    {
        return $this->getFormattedApiResponse([
            'domain' => $this->project->getDomain(),
            'url' => $this->project->getUrl(),
            'api' => $this->project->getApiUrl(),
            'database' => $this->project->getDatabaseName(),
            'namespaces' => $this->project->getNamespaces(),
        ]);
    }

    /**
     * Get assessment data for a given project.
     * @Route("/api/project/assessments/{project}", name="ProjectApiAssessments")
     * @return JsonResponse
     */
    public function projectAssessmentsApiAction(): JsonResponse
    {
        return $this->getFormattedApiResponse([
            'project' => $this->project->getDomain(),
            'assessments' => $this->project->getPageAssessments()->getConfig(),
        ]);
    }

    /**
     * Get assessment data for all projects.
     * @Route("/api/project/assessments", name="ApiAssessmentsConfig")
     * @return JsonResponse
     */
    public function assessmentsConfigApiAction(): JsonResponse
    {
        // Here there is no Project, so we don't use XtoolsController::getFormattedApiResponse().
        $response = new JsonResponse();
        $response->setEncodingOptions(JSON_NUMERIC_CHECK);
        $response->setStatusCode(Response::HTTP_OK);
        $response->setData([
            'projects' => array_keys($this->container->getParameter('assessments')),
            'projects' => array_keys(/** @scrutinizer ignore-type */ $this->container->getParameter('assessments')),
            'config' => $this->container->getParameter('assessments'),
        ]);

        return $response;
    }

    /**
     * Transform given wikitext to HTML using the XTools parser. Wikitext must be passed in as the query 'wikitext'.
     * @Route("/api/project/parser/{project}")
     * @return JsonResponse Safe HTML.
     */
    public function wikifyApiAction(): JsonResponse
    {
        return new JsonResponse(
            Edit::wikifyString($this->request->query->get('wikitext', ''), $this->project)
        );
    }
}

x-tools / xtools

Push — master ( 53c877...bfb78e )

DefaultController::aboutAction() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
