EditCounterController::setUpEditCounter() - Code Metrics - Inspection of "EditCounter: require API secret for use of interna..." - x-tools/xtools - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b130be...d8cd50 )

by MusikAnimal

created 2017-10-04 22:25 UTC

EditCounterController::setUpEditCounter() B

↳ Parent: EditCounterController

Complexity

Conditions	5
Paths	4

Size

Total Lines	24
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	24
rs	8.5125
c	0
b	0
f	0
cc	5
eloc	14
nc	4
nop	3

<?php
/**
 * This file contains only the EditCounterController class.
 */

namespace AppBundle\Controller;

use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\JsonResponse;
use Xtools\EditCounter;
use Xtools\EditCounterRepository;
use Xtools\Page;
use Xtools\Project;
use Xtools\ProjectRepository;
use Xtools\User;
use Xtools\UserRepository;

/**
 * Class EditCounterController
 */
class EditCounterController extends Controller
{

    /** @var User The user being queried. */
    protected $user;

    /** @var Project The project being queried. */
    protected $project;

    /** @var EditCounter The edit-counter, that does all the work. */
    protected $editCounter;

    /**
     * Get the tool's shortname.
     * @return string
     */
    public function getToolShortname()
    {
        return 'ec';
    }

    /**
     * Every action in this controller (other than 'index') calls this first.
     * If a response is returned, the calling action is expected to return it.
     * @param string|bool $project The project name.
     * @param string|bool $username The username.
     * @param string $key API key, as given in the reuqest. Omit this for actions
     *   that are public (only /api/ec actions should pass this in).
     * @return null|RedirectResponse
     */
    protected function setUpEditCounter($project = false, $username = false, $key = null)
    {
        if ($key && $key !== $this->container->getParameter('secret')) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            throw $this->createAccessDeniedException('This endpoint is for internal use only.');
        }

        $this->project = ProjectRepository::getProject($project, $this->container);

        $this->user = UserRepository::getUser($username, $this->container);


        // Don't continue if the user doesn't exist.
        if (!$this->user->existsOnProject($this->project)) {
            $this->addFlash('notice', 'user-not-found');
            return $this->redirectToRoute('ec', ['project' => $project]);
        }

        // Get an edit-counter if we don't already have it set.
        if ($this->editCounter instanceof EditCounter) {
            return;
        }
        $editCounterRepo = new EditCounterRepository();
        $editCounterRepo->setContainer($this->container);

        $this->editCounter = new EditCounter($this->project, $this->user);
        $this->editCounter->setRepository($editCounterRepo);
    }

    /**
     * The initial GET request that displays the search form.
     *
     * @Route("/ec", name="ec")
     * @Route("/ec", name="EditCounter")
     * @Route("/ec/", name="EditCounterSlash")
     * @Route("/ec/index.php", name="EditCounterIndexPhp")
     * @Route("/ec/{project}", name="EditCounterProject")
     *
     * @param Request $request
     * @param string|null $project
     * @return RedirectResponse|Response
     */
    public function indexAction(Request $request, $project = null)
    {
        $queryProject = $request->query->get('project');
        $username = $request->query->get('username', $request->query->get('user'));

        if (($project || $queryProject) && $username) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $routeParams = ['project' => ($project ?: $queryProject), 'username' => $username];
            return $this->redirectToRoute('EditCounterResult', $routeParams);
        } elseif (!$project && $queryProject) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            return $this->redirectToRoute('EditCounterProject', ['project' => $queryProject]);
        }

        $project = ProjectRepository::getProject($project, $this->container);
        if (!$project->exists()) {
            $project = ProjectRepository::getDefaultProject($this->container);
        }

        // Otherwise fall through.
        return $this->render('editCounter/index.html.twig', [
            'xtPageTitle' => 'tool-ec',
            'xtSubtitle' => 'tool-ec-desc',
            'xtPage' => 'ec',
            'project' => $project,
        ]);
    }

    /**
     * Display all results.
     * @Route("/ec/{project}/{username}", name="EditCounterResult")
     * @param Request $request
     * @param string $project
     * @param string $username
     * @return Response
     */
    public function resultAction(Request $request, $project, $username)

    {
        $ret = $this->setUpEditCounter($project, $username);
        if ($ret instanceof RedirectResponse) {
            return $ret;
        }

        // Asynchronously collect some of the data that will be shown.
        // If multithreading is turned off, the normal getters in the views will
        // collect the necessary data synchronously.
        if ($this->container->getParameter('app.multithread')) {
            $this->editCounter->prepareData($this->container);

        }

        // FIXME: is this needed? It shouldn't ever be a subrequest here in the resultAction.
        $isSubRequest = $this->container->get('request_stack')->getParentRequest() !== null;

        return $this->render('editCounter/result.html.twig', [
            'xtTitle' => $this->user->getUsername() . ' - ' . $this->project->getTitle(),
            'xtPage' => 'ec',
            'base_dir' => realpath($this->getParameter('kernel.root_dir').'/..'),
            'is_sub_request' => $isSubRequest,
            'user' => $this->user,
            'project' => $this->project,
            'ec' => $this->editCounter,
        ]);
    }

    /**
     * Display the general statistics section.
     * @Route("/ec-generalstats/{project}/{username}", name="EditCounterGeneralStats")
     * @param string $project
     * @param string $username
     * @return Response
     */
    public function generalStatsAction($project, $username)

    {
        $ret = $this->setUpEditCounter($project, $username);
        if ($ret instanceof RedirectResponse) {
            return $ret;
        }

        $isSubRequest = $this->get('request_stack')->getParentRequest() !== null;
        return $this->render('editCounter/general_stats.html.twig', [
            'xtTitle' => $this->user->getUsername(),
            'xtPage' => 'ec',
            'is_sub_request' => $isSubRequest,
            'user' => $this->user,
            'project' => $this->project,
            'ec' => $this->editCounter,
        ]);
    }

    /**
     * Display the namespace totals section.
     * @Route("/ec-namespacetotals/{project}/{username}", name="EditCounterNamespaceTotals")
     * @param Request $request
     * @param string $project
     * @param string $username
     * @return Response
     */
    public function namespaceTotalsAction(Request $request, $project, $username)

    {
        $ret = $this->setUpEditCounter($project, $username);
        if ($ret instanceof RedirectResponse) {
            return $ret;
        }

        $isSubRequest = $this->get('request_stack')->getParentRequest() !== null;
        return $this->render('editCounter/namespace_totals.html.twig', [
            'xtTitle' => $this->user->getUsername(),
            'xtPage' => 'ec',
            'is_sub_request' => $isSubRequest,
            'user' => $this->user,
            'project' => $this->project,
            'ec' => $this->editCounter,
        ]);
    }

    /**
     * Display the timecard section.
     * @Route("/ec-timecard/{project}/{username}", name="EditCounterTimecard")
     * @param string $project
     * @param string $username
     * @return Response
     */
    public function timecardAction($project, $username)

    {
        $ret = $this->setUpEditCounter($project, $username);
        if ($ret instanceof RedirectResponse) {
            return $ret;
        }

        $isSubRequest = $this->get('request_stack')->getParentRequest() !== null;
        $optedInPage = $this->project
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
            ->getRepository()
            ->getPage($this->project, $this->project->userOptInPage($this->user));
        return $this->render('editCounter/timecard.html.twig', [
            'xtTitle' => $this->user->getUsername(),
            'xtPage' => 'ec',
            'is_sub_request' => $isSubRequest,
            'user' => $this->user,
            'project' => $this->project,
            'ec' => $this->editCounter,
            'opted_in_page' => $optedInPage,
        ]);
    }

    /**
     * Display the year counts section.
     * @Route("/ec-yearcounts/{project}/{username}", name="EditCounterYearCounts")
     * @param string $project
     * @param string $username
     * @return Response
     */
    public function yearcountsAction($project, $username)

    {
        $ret = $this->setUpEditCounter($project, $username);
        if ($ret instanceof RedirectResponse) {
            return $ret;
        }

        $isSubRequest = $this->container->get('request_stack')->getParentRequest() !== null;
        return $this->render('editCounter/yearcounts.html.twig', [
            'xtTitle' => $this->user->getUsername(),
            'xtPage' => 'ec',
            'is_sub_request' => $isSubRequest,
            'user' => $this->user,
            'project' => $this->project,
            'ec' => $this->editCounter,
        ]);
    }

    /**
     * Display the month counts section.
     * @Route("/ec-monthcounts/{project}/{username}", name="EditCounterMonthCounts")
     * @param Request $request
     * @param string $project
     * @param string $username
     * @return Response
     */
    public function monthcountsAction(Request $request, $project, $username)

    {
        $ret = $this->setUpEditCounter($project, $username);
        if ($ret instanceof RedirectResponse) {
            return $ret;
        }

        $isSubRequest = $this->container->get('request_stack')->getParentRequest() !== null;
        $optedInPage = $this->project
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
            ->getRepository()
            ->getPage($this->project, $this->project->userOptInPage($this->user));
        return $this->render('editCounter/monthcounts.html.twig', [
            'xtTitle' => $this->user->getUsername(),
            'xtPage' => 'ec',
            'is_sub_request' => $isSubRequest,
            'user' => $this->user,
            'project' => $this->project,
            'ec' => $this->editCounter,
            'opted_in_page' => $optedInPage,
        ]);
    }

    /**
     * Display the latest global edits section.
     * @Route("/ec-latestglobal/{project}/{username}", name="EditCounterLatestGlobal")
     * @param Request $request The HTTP request.
     * @param string $project The project name.
     * @param string $username The username.
     * @return Response
     */
    public function latestglobalAction(Request $request, $project, $username)

    {
        $ret = $this->setUpEditCounter($project, $username);
        if ($ret instanceof RedirectResponse) {
            return $ret;
        }

        $isSubRequest = $request->get('htmlonly')
                        || $this->container->get('request_stack')->getParentRequest() !== null;
        return $this->render('editCounter/latest_global.html.twig', [
            'xtTitle' => $this->user->getUsername(),
            'xtPage' => 'ec',
            'is_sub_request' => $isSubRequest,
            'user' => $this->user,
            'project' => $this->project,
            'ec' => $this->editCounter,
        ]);
    }


    /**
     * Below are internal API endpoints for the Edit Counter.
     * All only respond with JSON and only to requests passing in the value
     * of the 'secret' parameter. This should not be used in JavaScript or clientside
     * applications, rather only used internally.
     */

    /**
     * Get (most) of the general statistics as JSON.
     * @Route("/api/ec/pairdata/{project}/{username}/{key}", name="EditCounterApiPairData")
     * @param Request $request
     * @param string $project
     * @param string $username
     * @param string $key API key.
     * @return JsonResponse
     */
    public function pairDataApiAction(Request $request, $project, $username, $key)

    {
        $ret = $this->setUpEditCounter($project, $username, $key);
        if ($ret instanceof RedirectResponse) {
            return $ret;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }

        return new JsonResponse(
            $this->editCounter->getPairData(),
            Response::HTTP_OK
        );
    }

    /**
     * Get various log counts for the user as JSON.
     * @Route("/api/ec/logcounts/{project}/{username}/{key}", name="EditCounterApiLogCounts")
     * @param Request $request
     * @param string $project
     * @param string $username
     * @param string $key API key.
     * @return JsonResponse
     */
    public function logCountsApiAction(Request $request, $project, $username, $key)

    {
        $ret = $this->setUpEditCounter($project, $username, $key);
        if ($ret instanceof RedirectResponse) {
            return $ret;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }

        return new JsonResponse(
            $this->editCounter->getLogCounts(),
            Response::HTTP_OK
        );
    }

    /**
     * Get edit sizes for the user as JSON.
     * @Route("/api/ec/editsizes/{project}/{username}/{key}", name="EditCounterApiEditSizes")
     * @param Request $request
     * @param string $project
     * @param string $username
     * @param string $key API key.
     * @return JsonResponse
     */
    public function editSizesApiAction(Request $request, $project, $username, $key)

    {
        $ret = $this->setUpEditCounter($project, $username, $key);
        if ($ret instanceof RedirectResponse) {
            return $ret;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }

        return new JsonResponse(
            $this->editCounter->getEditSizeData(),
            Response::HTTP_OK
        );
    }

    /**
     * Get the namespace totals for the user as JSON.
     * @Route("/api/ec/namespacetotals/{project}/{username}/{key}", name="EditCounterApiNamespaceTotals")
     * @param Request $request
     * @param string $project
     * @param string $username
     * @param string $key API key.
     * @return Response
     */
    public function namespaceTotalsApiAction(Request $request, $project, $username, $key)

    {
        $ret = $this->setUpEditCounter($project, $username, $key);
        if ($ret instanceof RedirectResponse) {
            return $ret;
        }

        return new JsonResponse(
            $this->editCounter->namespaceTotals(),
            Response::HTTP_OK
        );
    }

    /**
     * Display or fetch the month counts for the user.
     * @Route("/api/ec/monthcounts/{project}/{username}/{key}", name="EditCounterApiMonthCounts")
     * @param Request $request
     * @param string $project
     * @param string $username
     * @param string $key API key.
     * @return Response
     */
    public function monthcountsApiAction(Request $request, $project, $username, $key)

    {
        $ret = $this->setUpEditCounter($project, $username, $key);
        if ($ret instanceof RedirectResponse) {
            return $ret;
        }

        return new JsonResponse(
            $this->editCounter->monthCounts(),
            Response::HTTP_OK
        );
    }
}


Push — master ( b130be...d8cd50 )

EditCounterController::setUpEditCounter() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

1			<?php
2			/**
3			* This file contains only the EditCounterController class.
4			*/
5
6			namespace AppBundle\Controller;
7
8			use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
9			use Symfony\Bundle\FrameworkBundle\Controller\Controller;
10			use Symfony\Component\HttpFoundation\Request;
11			use Symfony\Component\HttpFoundation\Response;
12			use Symfony\Component\HttpFoundation\RedirectResponse;
13			use Symfony\Component\HttpFoundation\JsonResponse;
14			use Xtools\EditCounter;
15			use Xtools\EditCounterRepository;
16			use Xtools\Page;
17			use Xtools\Project;
18			use Xtools\ProjectRepository;
19			use Xtools\User;
20			use Xtools\UserRepository;
21
22			/**
23			* Class EditCounterController
24			*/
25			class EditCounterController extends Controller
26			{
27
28			/** @var User The user being queried. */
29			protected $user;
30
31			/** @var Project The project being queried. */
32			protected $project;
33
34			/** @var EditCounter The edit-counter, that does all the work. */
35			protected $editCounter;
36
37			/**
38			* Get the tool's shortname.
39			* @return string
40			*/

x-tools / xtools

Push — master ( b130be...d8cd50 )

EditCounterController::setUpEditCounter() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like