MetaController::recordUsage() - Code Metrics - Inspection of "Meta: move usage API endpoint out of API namespace" - x-tools/xtools - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 7c7725...4cc8fe )

by MusikAnimal

created 2017-10-05 21:19 UTC

MetaController::recordUsage() B

↳ Parent: MetaController

Complexity

Conditions	7
Paths	8

Size

Total Lines	63
Code Lines	40

Duplication

Lines	22
Ratio	34.92 %

Importance

Changes

Metric	Value
dl	22
loc	63
rs	7.2689
c	0
b	0
f	0
cc	7
eloc	40
nc	8
nop	4

How to fix Long Method

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

namespace AppBundle\Controller;

use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\Request;
use DateTime;
use Symfony\Component\HttpFoundation\Response;

/**
 * This controller serves everything for the Meta tool.
 */
class MetaController extends Controller
{
    /**
     * Display the form.
     * @Route("/meta", name="meta")
     * @Route("/meta", name="Meta")
     * @Route("/meta/", name="MetaSlash")
     * @Route("/meta/index.php", name="MetaIndexPhp")
     * @param Request $request
     * @return Response
     */
    public function indexAction(Request $request)
    {
        $start = $request->query->get('start');
        $end = $request->query->get('end');

        if ($start != '' && $end != '') {
            return $this->redirectToRoute('MetaResult', [ 'start' => $start, 'end' => $end ]);
        }

        return $this->render('meta/index.html.twig', [
            'xtPage' => 'meta',
            'xtPageTitle' => 'tool-meta',
            'xtSubtitle' => 'tool-meta-desc',
        ]);
    }

    /**
     * Display the results.
     * @Route("/meta/{start}/{end}/{legacy}", name="MetaResult")
     * @param string $start    Start date
     * @param string $end      End date
     * @param string [$legacy] Non-blank value indicates to show stats for legacy XTools
     * @return Response
     */
    public function resultAction($start, $end, $legacy = false)
    {
        $db = $legacy ? 'toolsdb' : 'default';
        $table = $legacy ? 's51187__metadata.xtools_timeline' : 'usage_timeline';

        $client = $this->container
            ->get('doctrine')
            ->getManager($db)
            ->getConnection();

        $query = $client->prepare("SELECT * FROM $table
                                 WHERE date >= :start AND date <= :end");
        $query->bindParam('start', $start);
        $query->bindParam('end', $end);
        $query->execute();

        $data = $query->fetchAll();

        // Create array of totals, along with formatted timeline data as needed by Chart.js
        $totals = [];
        $dateLabels = [];
        $timeline = [];
        $startObj = new DateTime($start);
        $endObj = new DateTime($end);
        $numDays = (int) $endObj->diff($startObj)->format("%a");
        $grandSum = 0;

        // Generate array of date labels
        for ($dateObj = new DateTime($start); $dateObj <= $endObj; $dateObj->modify('+1 day')) {
            $dateLabels[] = $dateObj->format('Y-m-d');
        }

        foreach ($data as $entry) {
            if (!isset($totals[$entry['tool']])) {
                $totals[$entry['tool']] = (int) $entry['count'];

                // Create arrays for each tool, filled with zeros for each date in the timeline
                $timeline[$entry['tool']] = array_fill(0, $numDays, 0);
            } else {
                $totals[$entry['tool']] += (int) $entry['count'];
            }

            $date = new DateTime($entry['date']);
            $dateIndex = (int) $date->diff($startObj)->format("%a");
            $timeline[$entry['tool']][$dateIndex] = (int) $entry['count'];

            $grandSum += $entry['count'];
        }
        arsort($totals);

        return $this->render('meta/result.html.twig', [
            'xtPage' => 'meta',
            'start' => $start,
            'end' => $end,
            'data' => $data,
            'totals' => $totals,
            'grandSum' => $grandSum,
            'dateLabels' => $dateLabels,
            'timeline' => $timeline,
        ]);
    }

    /**
     * Record usage of a particular XTools tool. This is called automatically
     *   in base.html.twig via JavaScript so that it is done asynchronously
     * @Route("/meta/usage/{tool}/{project}/{token}")
     * @param  $request Request
     * @param  string $tool    Internal name of tool
     * @param  string $project Project domain such as en.wikipedia.org
     * @param  string $token   Unique token for this request, so we don't have people
     *                         meddling with these statistics
     * @return Response
     */
    public function recordUsage(Request $request, $tool, $project, $token)
    {
        // Validate method and token.
        if ($request->getMethod() !== 'PUT' || !$this->isCsrfTokenValid('intention', $token)) {
            throw $this->createAccessDeniedException('This endpoint is for internal use only.');
        }

        // Ready the response object.
        $response = new Response();
        $response->headers->set('Content-Type', 'application/json');

        // Don't update counts for tools that aren't enabled
        if (!$this->container->getParameter("enable.$tool")) {
            $response->setStatusCode(Response::HTTP_FORBIDDEN);
            $response->setContent(json_encode([
                'error' => 'This tool is disabled'
            ]));
            return $response;
        }

        $conn = $this->container->get('doctrine')->getManager('default')->getConnection();
        $date =  date('Y-m-d');

        // Increment count in timeline
        $existsSql = "SELECT 1 FROM usage_timeline
                      WHERE date = '$date'
                      AND tool = '$tool'";

        if (count($conn->query($existsSql)->fetchAll()) === 0) {

            $createSql = "INSERT INTO usage_timeline
                          VALUES(NULL, '$date', '$tool', 1)";
            $conn->query($createSql);
        } else {
            $updateSql = "UPDATE usage_timeline
                          SET count = count + 1
                          WHERE tool = '$tool'
                          AND date = '$date'";
            $conn->query($updateSql);
        }

        // Update per-project usage, if applicable
        if (!$this->container->getParameter('app.single_wiki')) {
            $existsSql = "SELECT 1 FROM usage_projects
                          WHERE tool = '$tool'
                          AND project = '$project'";

            if (count($conn->query($existsSql)->fetchAll()) === 0) {

                $createSql = "INSERT INTO usage_projects
                              VALUES(NULL, '$tool', '$project', 1)";
                $conn->query($createSql);
            } else {
                $updateSql = "UPDATE usage_projects
                              SET count = count + 1
                              WHERE tool = '$tool'
                              AND project = '$project'";
                $conn->query($updateSql);
            }
        }

        $response->setStatusCode(Response::HTTP_NO_CONTENT);
        $response->setContent(json_encode([]));
        return $response;
    }
}


1		<?php
2		/**
3		* This file contains only the MetaController 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 DateTime;
12		use Symfony\Component\HttpFoundation\Response;
13
14		/**
15		* This controller serves everything for the Meta tool.
16		*/
17		class MetaController extends Controller
18		{
19		/**
20		* Display the form.
21		* @Route("/meta", name="meta")
22		* @Route("/meta", name="Meta")
23		* @Route("/meta/", name="MetaSlash")
24		* @Route("/meta/index.php", name="MetaIndexPhp")
25		* @param Request $request
26		* @return Response
27		*/
28		public function indexAction(Request $request)
29		{
30		$start = $request->query->get('start');
31		$end = $request->query->get('end');
32
33		if ($start != '' && $end != '') {
34		return $this->redirectToRoute('MetaResult', [ 'start' => $start, 'end' => $end ]);
35		}
36
37		return $this->render('meta/index.html.twig', [
38		'xtPage' => 'meta',
39		'xtPageTitle' => 'tool-meta',
40		'xtSubtitle' => 'tool-meta-desc',
41		]);
42		}
43
44		/**
45		* Display the results.
46		* @Route("/meta/{start}/{end}/{legacy}", name="MetaResult")
47		* @param string $start Start date
48		* @param string $end End date
49		* @param string [$legacy] Non-blank value indicates to show stats for legacy XTools
50		* @return Response
51		*/
52		public function resultAction($start, $end, $legacy = false)
53		{
54		$db = $legacy ? 'toolsdb' : 'default';
55		$table = $legacy ? 's51187__metadata.xtools_timeline' : 'usage_timeline';
56
57		$client = $this->container
58		->get('doctrine')
59		->getManager($db)
60		->getConnection();
61
62		$query = $client->prepare("SELECT * FROM $table
63		WHERE date >= :start AND date <= :end");
64		$query->bindParam('start', $start);
65		$query->bindParam('end', $end);
66		$query->execute();
67
68		$data = $query->fetchAll();
69
70		// Create array of totals, along with formatted timeline data as needed by Chart.js
71		$totals = [];
72		$dateLabels = [];
73		$timeline = [];
74		$startObj = new DateTime($start);
75		$endObj = new DateTime($end);
76		$numDays = (int) $endObj->diff($startObj)->format("%a");
77		$grandSum = 0;
78
79		// Generate array of date labels
80		for ($dateObj = new DateTime($start); $dateObj <= $endObj; $dateObj->modify('+1 day')) {
81		$dateLabels[] = $dateObj->format('Y-m-d');
82		}
83
84		foreach ($data as $entry) {
85		if (!isset($totals[$entry['tool']])) {
86		$totals[$entry['tool']] = (int) $entry['count'];
87
88		// Create arrays for each tool, filled with zeros for each date in the timeline
89		$timeline[$entry['tool']] = array_fill(0, $numDays, 0);
90		} else {
91		$totals[$entry['tool']] += (int) $entry['count'];
92		}
93
94		$date = new DateTime($entry['date']);
95		$dateIndex = (int) $date->diff($startObj)->format("%a");
96		$timeline[$entry['tool']][$dateIndex] = (int) $entry['count'];
97
98		$grandSum += $entry['count'];
99		}
100		arsort($totals);
101
102		return $this->render('meta/result.html.twig', [
103		'xtPage' => 'meta',
104		'start' => $start,
105		'end' => $end,
106		'data' => $data,
107		'totals' => $totals,
108		'grandSum' => $grandSum,
109		'dateLabels' => $dateLabels,
110		'timeline' => $timeline,
111		]);
112		}
113
114		/**
115		* Record usage of a particular XTools tool. This is called automatically
116		* in base.html.twig via JavaScript so that it is done asynchronously
117		* @Route("/meta/usage/{tool}/{project}/{token}")
118		* @param $request Request
119		* @param string $tool Internal name of tool
120		* @param string $project Project domain such as en.wikipedia.org
121		* @param string $token Unique token for this request, so we don't have people
122		* meddling with these statistics
123		* @return Response
124		*/
125		public function recordUsage(Request $request, $tool, $project, $token)
126		{
127		// Validate method and token.
128		if ($request->getMethod() !== 'PUT' \|\| !$this->isCsrfTokenValid('intention', $token)) {
129		throw $this->createAccessDeniedException('This endpoint is for internal use only.');
130		}
131
132		// Ready the response object.
133		$response = new Response();
134		$response->headers->set('Content-Type', 'application/json');
135
136		// Don't update counts for tools that aren't enabled
137		if (!$this->container->getParameter("enable.$tool")) {
138		$response->setStatusCode(Response::HTTP_FORBIDDEN);
139		$response->setContent(json_encode([
140		'error' => 'This tool is disabled'
141		]));
142		return $response;
143		}
144
145		$conn = $this->container->get('doctrine')->getManager('default')->getConnection();
146		$date = date('Y-m-d');
147
148		// Increment count in timeline
149		$existsSql = "SELECT 1 FROM usage_timeline
150		WHERE date = '$date'
151		AND tool = '$tool'";
152
153	View Code Duplication	if (count($conn->query($existsSql)->fetchAll()) === 0) {
		0 ignored issues – show Duplication introduced 2017-06-26 17:17 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
154		$createSql = "INSERT INTO usage_timeline
155		VALUES(NULL, '$date', '$tool', 1)";
156		$conn->query($createSql);
157		} else {
158		$updateSql = "UPDATE usage_timeline
159		SET count = count + 1
160		WHERE tool = '$tool'
161		AND date = '$date'";
162		$conn->query($updateSql);
163		}
164
165		// Update per-project usage, if applicable
166		if (!$this->container->getParameter('app.single_wiki')) {
167		$existsSql = "SELECT 1 FROM usage_projects
168		WHERE tool = '$tool'
169		AND project = '$project'";
170
171	View Code Duplication	if (count($conn->query($existsSql)->fetchAll()) === 0) {
		0 ignored issues – show Duplication introduced 2017-06-26 17:17 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
172		$createSql = "INSERT INTO usage_projects
173		VALUES(NULL, '$tool', '$project', 1)";
174		$conn->query($createSql);
175		} else {
176		$updateSql = "UPDATE usage_projects
177		SET count = count + 1
178		WHERE tool = '$tool'
179		AND project = '$project'";
180		$conn->query($updateSql);
181		}
182		}
183
184		$response->setStatusCode(Response::HTTP_NO_CONTENT);
185		$response->setContent(json_encode([]));
186		return $response;
187		}
188		}
189

x-tools / xtools

Push — master ( 7c7725...4cc8fe )

MetaController::recordUsage() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like