AppBundle\Controller\AutomatedEditsController

Complexity

Total Complexity

30

Size/Duplication

Total Lines	282
Duplicated Lines	1.42 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getToolShortname()	0	4	1
C	indexAction()	0	73	11
F	resultAction()	4	177	18

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

namespace AppBundle\Controller;

use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Xtools\ProjectRepository;
use Xtools\User;

/**
 * This controller serves the AutomatedEdits tool.
 */
class AutomatedEditsController extends Controller
{

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

    /**
     * Display the search form.
     * @Route("/autoedits", name="autoedits")
     * @Route("/automatededits", name="autoeditsLong")
     * @Route("/autoedits/index.php", name="autoeditsIndexPhp")
     * @Route("/automatededits/index.php", name="autoeditsLongIndexPhp")
     * @param Request $request The HTTP request.
     * @return Response
     */
    public function indexAction(Request $request)
    {
        // Pull the values out of the query string. These values default to
        // empty strings.
        $project = $request->query->get('project');
        $username = $request->query->get('username', $request->query->get('user'));
        $startDate = $request->query->get('start');
        $endDate = $request->query->get('end');

        // Redirect if the values are set.
        if ($project != "" && $username != "" && ($startDate != "" || $endDate != "")) {
            // Redirect to the route fully if we have the username project, and any date

            // Set start date to beginning of time if end date is provided
            // This is nasty, but necessary given URL structure
            if ($startDate === "") {
                $startDate = date('Y-m-d', 0);
            }

            return $this->redirectToRoute(
                "autoeditsResult",
                [
                    'project' => $project,
                    'username' => $username,
                    'start' => $startDate,
                    'end' => $endDate,
                ]
            );
        } elseif ($project != "" && $username != "") {
            // Redirect if we have the username and project
            return $this->redirectToRoute(
                "autoeditsResult",
                [
                    'project' => $project,
                    'username' => $username,
                ]
            );
        } elseif ($project != "") {
            // Redirect if we have the project name
            return $this->redirectToRoute(
                "autoeditsResult",
                [
                    'project' => $project
                ]
            );
        }

        /** @var ApiHelper */
        $api = $this->get("app.api_helper");

$api is not used, you could remove the assignment.

        // Set default project so we can populate the namespace selector.
        if (!$project) {
            $project = $this->container->getParameter('default_project');
        }

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

        // Default values for the variables to keep the template happy
        $namespaces = null;

        // If the project exists, actually populate the values
        if ($projectData->exists()) {
            $namespaces = $projectData->getNamespaces();
        }

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

    /**
     * Display the results.
     * @Route("/autoedits/{project}/{username}/{start}/{end}", name="autoeditsResult")
     * @param $project
     * @param $username
     * @param null $start
     * @param null $end
     * @return RedirectResponse|Response
     */
    public function resultAction($project, $username, $start = null, $end = null)
    {
        // Pull the labs helper and check if enabled
        $lh = $this->get('app.labs_helper');

        // Pull information about the project
        $projectData = ProjectRepository::getProject($project, $this->container);

        if (!$projectData->exists()) {

This code seems to be duplicated across your project.

            $this->addFlash('notice', ['invalid-project', $project]);

array('invalid-project', $project) is of type array<integer,?,{"0":"string","1":"?"}>, but the function expects a string.

            return $this->redirectToRoute('autoedits');
        }

        $dbName = $projectData->getDatabaseName();
        $projectUrl = $projectData->getUrl();

$projectUrl is not used, you could remove the assignment.

        // Grab our database connection
        $dbh = $this->get('doctrine')->getManager('replicas')->getConnection();

        // Validating the dates. If the dates are invalid, we'll redirect
        // to the project and username view.
        $invalidDates = (
            (isset($start) && strtotime($start) === false) ||
            (isset($end) && strtotime($end) === false)
        );
        if ($invalidDates) {
            // Make sure to add the flash notice first.
            $this->addFlash('notice', ['invalid-date']);

array('invalid-date') is of type array<integer,string,{"0":"string"}>, but the function expects a string.

            // Then redirect us!
            return $this->redirectToRoute(
                'autoeditsResult',
                [
                    'project' => $project,
                    'username' => $username,
                ]
            );
        }

        $user = new User($username);
        $username = $user->getUsername(); // use normalized user name

        // Now, load the semi-automated edit types.
        $AEBTypes = $this->getParameter('automated_tools');

        // Create a collection of queries that we're going to run.
        $queries = [];

        $revisionTable = $lh->getTable('revision', $dbName);
        $archiveTable = $lh->getTable('archive', $dbName);

        $condBegin = $start ? " AND rev_timestamp > :start " : null;
        $condEnd = $end ? " AND rev_timestamp < :end ": null;

        $regexes = [];

        foreach ($AEBTypes as $toolname => $values) {
            $toolname = $dbh->quote($toolname, \PDO::PARAM_STR);
            $regexes[] = $values['regex'];
            $regex = $dbh->quote($values['regex'], \PDO::PARAM_STR);

            $queries[] .= "
                SELECT $toolname AS toolname, COUNT(*) AS count
                FROM $revisionTable
                WHERE rev_user_text = :username
                AND rev_comment REGEXP $regex
                $condBegin
                $condEnd
            ";
        }

        // Query to get combined (semi)automated using for all edits
        // (some automated edits overlap)
        $allAETools = $dbh->quote(implode('|', $regexes), \PDO::PARAM_STR);
        $queries[] = "
            SELECT 'total_live' AS toolname, COUNT(*) AS count
            FROM $revisionTable
            WHERE rev_user_text = :username
            AND rev_comment REGEXP $allAETools
            $condBegin
            $condEnd
        ";

        // Next, add two simple queries for the live and deleted edits.
        $queries[] = "
            SELECT 'live' AS toolname, COUNT(*) AS count
            FROM $revisionTable
            WHERE rev_user_text = :username
            $condBegin
            $condEnd
        ";

        $condBegin = str_replace('rev_timestamp', 'ar_timestamp', $condBegin);
        $condEnd = str_replace('rev_timestamp', 'ar_timestamp', $condEnd);

        $queries[] = "
            SELECT 'deleted' AS toolname, COUNT(*) AS count
            FROM $archiveTable
            WHERE ar_user_text = :username
            $condBegin
            $condEnd
        ";

        // Create a big query and execute.
        $stmt = implode(' UNION ', $queries);

        $sth = $dbh->prepare($stmt);

        $sth->bindParam('username', $username);
        $sth->bindParam('start', $start);
        $sth->bindParam('end', $end);

        $sth->execute();

        // handling results
        $results = [];
        $total_semi = 0;
        $total = 0;

        while ($row = $sth->fetch()) {
            // Different variables need to get set if the tool is
            // the live edits or deleted edits.
            // If it is neither and greater than 0,
            // add them to the array we're rendering and to our running total
            $tool = $row['toolname'];
            if ($tool === 'live') {
                $total += $row['count'];
            } elseif ($tool === 'deleted') {
                $total += $row['count'];
            } elseif ($tool === 'total_live') {
                $total_semi = $row['count'];
            } elseif ($row['count'] > 0) {
                $results[$tool] = [
                    'link' => $AEBTypes[$tool]['link'],
                    'count' => $row['count'],
                ];
            }
        }

        // Inform user if no revisions found.
        if ($total === 0) {
            $this->addFlash('notice', ['no-contribs']);

array('no-contribs') is of type array<integer,string,{"0":"string"}>, but the function expects a string.

            return $this->redirectToRoute('autoedits');
        }

        // Sort the array and do some simple math.
        uasort($results, function ($a, $b) {
            return $b['count'] - $a['count'];
        });

        if ($total != 0) {
            $total_pct = ($total_semi / $total) * 100;
        } else {
            $total_pct = 0;
        }

        $ret = [
            'xtPage' => 'autoedits',
            'xtTitle' => $username,
            'user' => $user,
            'project' => $projectData,
            'semi_automated' => $results,
            'total_semi' => $total_semi,
            'total' => $total,
            'total_pct' => $total_pct,
        ];

        if (isset($start)) {
            $ret['start'] = $start;
        }
        if (isset($end)) {
            $ret['end'] = $end;
        }

        // Render the view with all variables set.
        return $this->render('autoEdits/result.html.twig', $ret);
    }
}