AppBundle\Controller\TopEditsController

Complexity

Total Complexity

25

Size/Duplication

Total Lines	229
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	12

Importance

Changes	3
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getProject()	0	15	2
C	indexAction()	0	46	12
A	resultAction()	0	15	2
B	namespaceTopEdits()	0	56	5
A	singlePageTopEdits()	0	57	4

<?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 Xtools\Page;
use Xtools\PagesRepository;
use Xtools\Project;
use Xtools\ProjectRepository;
use Xtools\User;

class TopEditsController extends Controller
{

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

    /**
     * Get the Project.
     * @todo This can probably be made more common.
     * @param string $projectIdent The domain name, database name, or URL of a project.
     * @return Project
     */
    protected function getProject($projectIdent)
    {
        $project = new Project($projectIdent);
        $projectRepo = new ProjectRepository();
        $projectRepo->setMetaConnection($this->get('doctrine')->getManager("meta")->getConnection());
        $projectRepo->setCache($this->get('cache.app'));
        if ($this->container->getParameter('app.single_wiki')) {
            $projectRepo->setSingleMetadata([
                'url' => $this->container->getParameter('wiki_url'),
                'dbname' => $this->container->getParameter('database_replica_name'),
            ]);
        }
        $project->setRepository($projectRepo);
        return $project;
    }

    /**
     * @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");

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

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

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

        $project = $this->getProject($project);

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

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

        $project = $this->getProject($project);
        $user = new User($username);

        if ($article === "") {
            return $this->namespaceTopEdits($user, $project, $namespace);
        } else {
            return $this->singlePageTopEdits($user, $project, $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 $namespace The namespace ID or 'all'
     * @return \Symfony\Component\HttpFoundation\Response
     */
    protected function namespaceTopEdits(User $user, Project $project, $namespace)
    {
        // Get list of namespaces.
        $namespaces = $project->getNamespaces();

        // Get the basic data about the pages edited by this user.
        $params = ['username'=>$user->getUsername()];
        $nsClause = '';
        $namespaceMsg = 'namespaces_all';
        if (is_numeric($namespace)) {
            $nsClause = 'AND page_namespace = :namespace';
            $params['namespace'] = $namespace;
            $namespaceMsg = str_replace(' ', '_', strtolower($namespaces[$namespace]));
        }
        $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", ["nocontribs"]);

array('nocontribs') 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) {
            return $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) {
            $pageTitle = $editDatum['page_title'];
            // If 'all' namespaces, prepend namespace to display title.
            $nsTitle = !is_numeric($namespace) ? $namespaces[$editDatum['page_namespace']].':' : '';
            $editDatum['displaytitle'] = $nsTitle.$displayTitles[$pageTitle];
            $edits[] = $editDatum;
        }
        return $this->render('topedits/result_namespace.html.twig', [
            'xtPage' => 'topedits',
            'project' => $project,
            'user' => $user,
            'namespace' => $namespace,
            'edits' => $edits,
            'content_title' => $namespaceMsg,
        ]);
    }

    /**
     * List top edits by this user for a particular page.
     * @param User $user
     * @param Project $project
     * @param string $pageName
     * @return \Symfony\Component\HttpFoundation\RedirectResponse|\Symfony\Component\HttpFoundation\Response
     */
    protected function singlePageTopEdits(User $user, Project $project, $pageName)
    {
        $page = new Page($project, $pageName);
        $pageRepo = new PagesRepository();
        $page->setRepository($pageRepo);
        
        if (!$page->exists()) {
            // Redirect if the page doesn't exist.
            $this->addFlash("notice", ["noresult", $pageName]);

array('noresult', $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) {
            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),
        ]);
    }
}