AppBundle\Controller\TopEditsController

Complexity

Total Complexity

28

Size/Duplication

Total Lines	245
Duplicated Lines	6.53 %

Coupling/Cohesion

Components	1
Dependencies	13

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
C	indexAction()	0	57	13
A	resultAction()	4	21	3
C	namespaceTopEdits()	0	72	7
B	singlePageTopEdits()	12	60	5

<?php

namespace AppBundle\Controller;

use AppBundle\Helper\ApiHelper;
use AppBundle\Helper\LabsHelper;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\VarDumper\VarDumper;
use Xtools\Page;
use Xtools\PagesRepository;
use Xtools\Project;
use Xtools\ProjectRepository;
use Xtools\User;
use Xtools\UserRepository;

class TopEditsController extends Controller
{

    /** @var LabsHelper */
    private $lh;

    /**
     * @Route("/topedits", name="topedits")
     * @Route("/topedits", name="topEdits")
     * @Route("/topedits/", name="topEditsSlash")
     * @Route("/topedits/index.php", name="topEditsIndex")
     */
    public function indexAction(Request $request)
    {
        $this->lh = $this->get("app.labs_helper");
        $this->lh->checkEnabled("topedits");

        $projectName = $request->query->get('project');
        $username = $request->query->get('username');
        $namespace = $request->query->get('namespace');
        $article = $request->query->get('article');

        if ($projectName != "" && $username != "" && $namespace != "" && $article != "") {
            return $this->redirectToRoute("TopEditsResults", [
                'project'=>$projectName,
                'username' => $username,
                'namespace'=>$namespace,
                'article'=>$article,
            ]);
        } elseif ($projectName != "" && $username != "" && $namespace != "") {
            return $this->redirectToRoute("TopEditsResults", [
                'project'=>$projectName,
                'username' => $username,
                'namespace'=>$namespace,
            ]);
        } elseif ($projectName != "" && $username != "") {
            return $this->redirectToRoute("TopEditsResults", [
                'project' => $projectName,
                'username' => $username,
            ]);
        } elseif ($projectName != "") {
            return $this->redirectToRoute("TopEditsResults", [ 'project'=>$projectName ]);
        }

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

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

$this->container of type object<Symfony\Component\DependencyInjection\ContainerInterface> is not a sub-type of object<Symfony\Component\DependencyInjection\Container>. It seems like you assume a concrete implementation of the interface Symfony\Component\DependencyInjection\ContainerInterface to be always present.

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

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

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

    /**
     * @Route("/topedits/{project}/{username}/{namespace}/{article}", name="TopEditsResults",
     *     requirements={"article"=".+"})
     */
    public function resultAction($project, $username, $namespace = 0, $article = "")
    {
        /** @var LabsHelper $lh */
        $this->lh = $this->get('app.labs_helper');
        $this->lh->checkEnabled('topedits');

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

$this->container of type object<Symfony\Component\DependencyInjection\ContainerInterface> is not a sub-type of object<Symfony\Component\DependencyInjection\Container>. It seems like you assume a concrete implementation of the interface Symfony\Component\DependencyInjection\ContainerInterface to be always present.

        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("topedits");
        }

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

$this->container of type object<Symfony\Component\DependencyInjection\ContainerInterface> is not a sub-type of object<Symfony\Component\DependencyInjection\Container>. It seems like you assume a concrete implementation of the interface Symfony\Component\DependencyInjection\ContainerInterface to be always present.

        if ($article === "") {
            return $this->namespaceTopEdits($user, $projectData, $namespace);
        } else {
            return $this->singlePageTopEdits($user, $projectData, $namespace, $article);
        }
    }

    /**
     * List top edits by this user for all pages in a particular namespace.
     * @param User $user The User.
     * @param Project $project The project.
     * @param integer|string $namespaceId The namespace ID or 'all'
     * @return \Symfony\Component\HttpFoundation\Response
     */
    protected function namespaceTopEdits(User $user, Project $project, $namespaceId)
    {
        // Make sure they've opted in to see this data.
        if (!$project->userHasOptedIn($user)) {
            $this->addFlash('notice', ['not-opted-in']);

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

            $title = $project->userOptInPage($user);
            $url = $project->getUrl().$project->getArticlePath().$title;
            $anchor = "<a href='".urlencode($url).">$title</a>";
            return $this->redirectToRoute('topedits', [$anchor]);
        }

        // Get list of namespaces.
        $namespaces = $project->getNamespaces();

        // Get the basic data about the pages edited by this user.
        $params = ['username'=>$user->getUsername()];
        $nsClause = '';
        $namespaceMsg = 'all-namespaces';
        if (is_numeric($namespaceId)) {
            $nsClause = 'AND page_namespace = :namespace';
            $params['namespace'] = $namespaceId;
            $namespaceMsg = str_replace(' ', '_', strtolower($namespaces[$namespaceId]));
        }
        $revTable = $this->lh->getTable('revision', $project->getDatabaseName());
        $pageTable = $this->lh->getTable('page', $project->getDatabaseName());
        $query = "SELECT page_namespace, page_title, page_is_redirect, COUNT(page_title) AS count
                FROM $pageTable JOIN $revTable ON page_id = rev_page
                WHERE rev_user_text = :username $nsClause
                GROUP BY page_namespace, page_title
                ORDER BY count DESC
                LIMIT 100";
        $conn = $this->getDoctrine()->getManager('replicas')->getConnection();

It seems like you code against a concrete implementation and not the interface Doctrine\Common\Persistence\ObjectManager as the method getConnection() does only exist in the following implementations of said interface: Doctrine\ORM\Decorator\EntityManagerDecorator, Doctrine\ORM\EntityManager.

        $editData = $conn->executeQuery($query, $params)->fetchAll();

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

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

        }

        // Get page info about these 100 pages, so we can use their display title.
        $titles = array_map(function ($e) use ($namespaces) {
            // If non-mainspace, prepend namespace to the titles.
            $ns = $e['page_namespace'];
            $nsTitle = $ns > 0 ? $namespaces[$e['page_namespace']] . ':' : '';
            return $nsTitle . $e['page_title'];
        }, $editData);
        /** @var ApiHelper $apiHelper */
        $apiHelper = $this->get('app.api_helper');
        $displayTitles = $apiHelper->displayTitles($project->getDomain(), $titles);

It seems like $project->getDomain() targeting Xtools\Project::getDomain() can also be of type false; however, AppBundle\Helper\ApiHelper::displayTitles() does only seem to accept string, did you maybe forget to handle an error condition?

        // Put all together, and return the view.
        $edits = [];
        foreach ($editData as $editDatum) {
            // If non-mainspace, prepend namespace to the titles.
            $ns = $editDatum['page_namespace'];
            $nsTitle = $ns > 0 ? $namespaces[$editDatum['page_namespace']] . ':' : '';
            $pageTitle = $nsTitle . $editDatum['page_title'];
            $editDatum['displaytitle'] = $displayTitles[$pageTitle];
            // $editDatum['page_title'] is retained without the namespace
            //  so we can link to TopEdits for that page
            $editDatum['page_title_ns'] = $pageTitle;
            $edits[] = $editDatum;
        }
        return $this->render('topedits/result_namespace.html.twig', [
            'xtPage' => 'topedits',
            'project' => $project,
            'user' => $user,
            'namespace' => $namespaceId,
            'edits' => $edits,
            'content_title' => $namespaceMsg,
        ]);
    }

    /**
     * List top edits by this user for a particular page.
     * @param User $user The user.
     * @param Project $project The project.
     * @param int $namespaceId The ID of the namespace of the page.
     * @param string $pageName The title (without namespace) of the page.
     * @return \Symfony\Component\HttpFoundation\RedirectResponse|\Symfony\Component\HttpFoundation\Response
     */
    protected function singlePageTopEdits(User $user, Project $project, $namespaceId, $pageName)
    {
        // Get the full page name (i.e. no namespace prefix if NS 0).
        $namespaces = $project->getNamespaces();
        $fullPageName = $namespaceId ? $namespaces[$namespaceId].':'.$pageName : $pageName;
        $page = new Page($project, $fullPageName);
        $pageRepo = new PagesRepository();
        $page->setRepository($pageRepo);

        if (!$page->exists()) {
            // Redirect if the page doesn't exist.
            $this->addFlash("notice", ["no-result", $pageName]);

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

            return $this->redirectToRoute("topedits");
        }

        // Get all revisions of this page by this user.
        $revTable = $this->lh->getTable('revision', $project->getDatabaseName());
        $query = "SELECT
                    revs.rev_id AS id,
                    revs.rev_timestamp AS timestamp,
                    (CAST(revs.rev_len AS SIGNED) - IFNULL(parentrevs.rev_len, 0)) AS length_change,
                    revs.rev_comment AS comment
                FROM $revTable AS revs
                    LEFT JOIN $revTable AS parentrevs ON (revs.rev_parent_id = parentrevs.rev_id)
                WHERE revs.rev_user_text IN (:username) AND revs.rev_page = :pageid
                ORDER BY revs.rev_timestamp DESC
            ";
        $params = ['username' => $user->getUsername(), 'pageid' => $page->getId()];
        $conn = $this->getDoctrine()->getManager('replicas')->getConnection();

It seems like you code against a concrete implementation and not the interface Doctrine\Common\Persistence\ObjectManager as the method getConnection() does only exist in the following implementations of said interface: Doctrine\ORM\Decorator\EntityManagerDecorator, Doctrine\ORM\EntityManager.

        $revisionsData = $conn->executeQuery($query, $params)->fetchAll();

        // Loop through all revisions and format dates, find totals, etc.
        $totalAdded = 0;
        $totalRemoved = 0;
        $revisions = [];
        foreach ($revisionsData as $revision) {

This code seems to be duplicated across your project.

            if ($revision['length_change'] > 0) {
                $totalAdded += $revision['length_change'];
            } else {
                $totalRemoved += $revision['length_change'];
            }
            $time = strtotime($revision['timestamp']);
            $revision['timestamp'] = $time; // formatted via Twig helper
            $revision['year'] = date('Y', $time);
            $revision['month'] = date('m', $time);
            $revisions[] = $revision;
        }

        // Send all to the template.
        return $this->render('topedits/result_article.html.twig', [
            'xtPage' => 'topedits',
            'project' => $project,
            'user' => $user,
            'page' => $page,
            'total_added' => $totalAdded,
            'total_removed' => $totalRemoved,
            'revisions' => $revisions,
            'revision_count' => count($revisions),
        ]);
    }
}