LabsHelper::databasePrepare() - Code Metrics - Inspection of "Edit Counter charts and data" - x-tools/xtools - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c332a3...b7b580 )

by Sam

created 2017-04-07 02:19 UTC

LabsHelper::databasePrepare() B

↳ Parent: LabsHelper

Complexity

Conditions	5
Paths	5

Size

Total Lines	54
Code Lines	30

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	54
rs	8.7449
cc	5
eloc	30
nc	5
nop	1

How to fix Long Method

<?php

namespace AppBundle\Helper;

use Symfony\Component\Config\Definition\Exception\Exception;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\VarDumper\VarDumper;

class LabsHelper
{
    /** @var string */
    protected $dbName;

    /** @var \Doctrine\DBAL\Connection */
    protected $client;

    /** @var ContainerInterface */
    protected $container;

    /** @var string */
    protected $url;

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

    public function checkEnabled($tool)
    {
        if (!$this->container->getParameter("enable.$tool")) {
            throw new NotFoundHttpException('This tool is disabled');
        }
    }

    /**
     * Is xTools connecting to MMF Labs?
     * @return boolean
     */
    public function isLabs()
    {
        return (bool)$this->container->getParameter('app.is_labs');
    }

    /**
     * Set up LabsHelper::$client and return the database name, wiki name, and URL of a given
     * project.
     * @todo: Handle failure better
     * @return string[] With keys 'dbName', 'wikiName', and 'url'.
     */
    public function databasePrepare($project = 'wiki')
    {
        if ($this->container->getParameter('app.single_wiki')) {
            $dbName = $this->container->getParameter('database_replica_name');
            $wikiName = 'wiki';
            $url = $this->container->getParameter('wiki_url');
        } else {
            // Grab the connection to the meta database
            $this->client = $this->container->get('doctrine')->getManager('meta')->getConnection();

            // Create the query we're going to run against the meta database
            $wikiQuery = $this->client->createQueryBuilder();
            $wikiQuery
                ->select([ 'dbName', 'name', 'url', 'lang' ])
                ->from('wiki')
                ->where($wikiQuery->expr()->eq('dbname', ':project'))
                // The meta database will have the project's URL stored as https://en.wikipedia.org
                // so we need to query for it accordingly, trying different variations the user
                // might have inputted.
                ->orwhere($wikiQuery->expr()->like('url', ':projectUrl'))
                ->orwhere($wikiQuery->expr()->like('url', ':projectUrl2'))
                ->setParameter('project', $project)
                ->setParameter('projectUrl', "https://$project")
                ->setParameter('projectUrl2', "https://$project.org");
            $wikiStatement = $wikiQuery->execute();

            // Fetch the wiki data
            $wikis = $wikiStatement->fetchAll();

            // Throw an exception if we can't find the wiki
            if (count($wikis) < 1) {
                // TODO: Fix so that we're rendering a flash rather than dying...
                throw new Exception("Unable to find project '$project'");
                // $this->container->get('controller')->addFlash('notice', ["nowiki", $project]);

                // return $this->container->redirectToRoute($route);

            }

            // Grab the data we need out of it, using the first result
            // (in the rare event there are more than one).
            $dbName = $wikis[0]['dbName'];
            $wikiName = $wikis[0]['name'];
            $url = $wikis[0]['url'];
            $lang = $wikis[0]['lang'];
        }

        if ($this->container->getParameter('app.is_labs') && substr($dbName, -2) != '_p') {
            $dbName .= '_p';
        }

        $this->dbName = $dbName;
        $this->url = $url;

        return [ 'dbName' => $dbName, 'wikiName' => $wikiName, 'url' => $url, 'lang' => $lang ];
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
    }

    /**
     * Get a list of all projects.
     */
    public function allProjects()
    {
        $wikiQuery = $this->client->createQueryBuilder();
        $wikiQuery->select([ 'dbName', 'name', 'url' ])->from('wiki');
        $stmt = $wikiQuery->execute();
        $out = $stmt->fetchAll();
        return $out;
    }

    /**
     * All mapping tables to environment-specific names, as specified in config/table_map.yml
     * Used for example to convert revision -> revision_replica
     * https://wikitech.wikimedia.org/wiki/Help:Tool_Labs/Database#Tables_for_revision_or_logging_queries_involving_user_names_and_IDs
     *
     * @param string $table  Table name
     * @param string $dbName Database name
     *
     * @return string Converted table name
     */
    public function getTable($table, $dbName = null)
    {
        // Use the table specified in the table mapping configuration, if present.
        $mapped = false;
        if ($this->container->hasParameter("app.table.$table")) {
            $mapped = true;
            $table = $this->container->getParameter("app.table.$table");
        }

        // For 'revision' and 'logging' tables (actually views) on Labs, use the indexed versions
        // (that have some rows hidden, e.g. for revdeleted users).
        $isLoggingOrRevision = in_array($table, ['revision', 'logging', 'archive']);
        if (!$mapped && $isLoggingOrRevision && $this->isLabs()) {
            $table = $table."_userindex";
        }

        // Figure out database name.
        // Use class variable for the database name if not set via function parameter.
        $dbNameActual = $dbName ? $dbName : $this->dbName;
        if ($this->isLabs() && substr($dbNameActual, -2) != '_p') {
            // Append '_p' if this is labs.
            $dbNameActual .= '_p';
        }

        return $dbNameActual ? "$dbNameActual.$table" : $table;
    }

    // TODO: figure out how to use Doctrine to query host 'tools-db'
}


1			<?php
2
3			namespace AppBundle\Helper;
4
5			use Symfony\Component\Config\Definition\Exception\Exception;
6			use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
7			use Symfony\Component\DependencyInjection\ContainerInterface;
8			use Symfony\Component\VarDumper\VarDumper;
9
10			class LabsHelper
11			{
12			/** @var string */
13			protected $dbName;
14
15			/** @var \Doctrine\DBAL\Connection */
16			protected $client;
17
18			/** @var ContainerInterface */
19			protected $container;
20
21			/** @var string */
22			protected $url;
23
24			public function __construct(ContainerInterface $container)
25			{
26			$this->container = $container;
27			}
28
29			public function checkEnabled($tool)
30			{
31			if (!$this->container->getParameter("enable.$tool")) {
32			throw new NotFoundHttpException('This tool is disabled');
33			}
34			}
35
36			/**
37			* Is xTools connecting to MMF Labs?
38			* @return boolean
39			*/
40			public function isLabs()
41			{
42			return (bool)$this->container->getParameter('app.is_labs');
43			}
44
45			/**
46			* Set up LabsHelper::$client and return the database name, wiki name, and URL of a given
47			* project.
48			* @todo: Handle failure better
49			* @return string[] With keys 'dbName', 'wikiName', and 'url'.
50			*/
51			public function databasePrepare($project = 'wiki')
52			{
53			if ($this->container->getParameter('app.single_wiki')) {
54			$dbName = $this->container->getParameter('database_replica_name');
55			$wikiName = 'wiki';
56			$url = $this->container->getParameter('wiki_url');
57			} else {
58			// Grab the connection to the meta database
59			$this->client = $this->container->get('doctrine')->getManager('meta')->getConnection();
60
61			// Create the query we're going to run against the meta database
62			$wikiQuery = $this->client->createQueryBuilder();
63			$wikiQuery
64			->select([ 'dbName', 'name', 'url', 'lang' ])
65			->from('wiki')
66			->where($wikiQuery->expr()->eq('dbname', ':project'))
67			// The meta database will have the project's URL stored as https://en.wikipedia.org
68			// so we need to query for it accordingly, trying different variations the user
69			// might have inputted.
70			->orwhere($wikiQuery->expr()->like('url', ':projectUrl'))
71			->orwhere($wikiQuery->expr()->like('url', ':projectUrl2'))
72			->setParameter('project', $project)
73			->setParameter('projectUrl', "https://$project")
74			->setParameter('projectUrl2', "https://$project.org");
75			$wikiStatement = $wikiQuery->execute();
76
77			// Fetch the wiki data
78			$wikis = $wikiStatement->fetchAll();
79
80			// Throw an exception if we can't find the wiki
81			if (count($wikis) < 1) {
82			// TODO: Fix so that we're rendering a flash rather than dying...
83			throw new Exception("Unable to find project '$project'");
84			// $this->container->get('controller')->addFlash('notice', ["nowiki", $project]);
			1 ignored issue – show Unused Code Comprehensibility introduced 2017-03-23 00:29 UTC by Report Bug Copy Issue Report `74%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
85			// return $this->container->redirectToRoute($route);
			1 ignored issue – show Unused Code Comprehensibility introduced 2017-03-23 00:29 UTC by Report Bug Copy Issue Report `67%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
86			}
87
88			// Grab the data we need out of it, using the first result
89			// (in the rare event there are more than one).
90			$dbName = $wikis[0]['dbName'];
91			$wikiName = $wikis[0]['name'];
92			$url = $wikis[0]['url'];
93			$lang = $wikis[0]['lang'];
94			}
95
96			if ($this->container->getParameter('app.is_labs') && substr($dbName, -2) != '_p') {
97			$dbName .= '_p';
98			}
99
100			$this->dbName = $dbName;
101			$this->url = $url;
102
103			return [ 'dbName' => $dbName, 'wikiName' => $wikiName, 'url' => $url, 'lang' => $lang ];
			0 ignored issues – show Bug introduced 2017-04-06 19:19 UTC by Report Bug Copy Issue Report The variable `$lang` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
104			}
105
106			/**
107			* Get a list of all projects.
108			*/
109			public function allProjects()
110			{
111			$wikiQuery = $this->client->createQueryBuilder();
112			$wikiQuery->select([ 'dbName', 'name', 'url' ])->from('wiki');
113			$stmt = $wikiQuery->execute();
114			$out = $stmt->fetchAll();
115			return $out;
116			}
117
118			/**
119			* All mapping tables to environment-specific names, as specified in config/table_map.yml
120			* Used for example to convert revision -> revision_replica
121			* https://wikitech.wikimedia.org/wiki/Help:Tool_Labs/Database#Tables_for_revision_or_logging_queries_involving_user_names_and_IDs
122			*
123			* @param string $table Table name
124			* @param string $dbName Database name
125			*
126			* @return string Converted table name
127			*/
128			public function getTable($table, $dbName = null)
129			{
130			// Use the table specified in the table mapping configuration, if present.
131			$mapped = false;
132			if ($this->container->hasParameter("app.table.$table")) {
133			$mapped = true;
134			$table = $this->container->getParameter("app.table.$table");
135			}
136
137			// For 'revision' and 'logging' tables (actually views) on Labs, use the indexed versions
138			// (that have some rows hidden, e.g. for revdeleted users).
139			$isLoggingOrRevision = in_array($table, ['revision', 'logging', 'archive']);
140			if (!$mapped && $isLoggingOrRevision && $this->isLabs()) {
141			$table = $table."_userindex";
142			}
143
144			// Figure out database name.
145			// Use class variable for the database name if not set via function parameter.
146			$dbNameActual = $dbName ? $dbName : $this->dbName;
147			if ($this->isLabs() && substr($dbNameActual, -2) != '_p') {
148			// Append '_p' if this is labs.
149			$dbNameActual .= '_p';
150			}
151
152			return $dbNameActual ? "$dbNameActual.$table" : $table;
153			}
154
155			// TODO: figure out how to use Doctrine to query host 'tools-db'
156			}
157

x-tools / xtools

Push — master ( c332a3...b7b580 )

LabsHelper::databasePrepare() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like