ApiHelper - Code Metrics - Inspection of "Require config option for API path, and use meta=s..." - x-tools/xtools - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#24)

unknown
created 2017-05-01 00:24 UTC
ApiHelper D

↳ Parent: Project
Complexity

Total Complexity
Size/Duplication

Total Lines	558
Duplicated Lines	6.81 %
Coupling/Cohesion

Components	1
Dependencies	9
Importance

Changes	2
Bugs	1	Features	0
Metric	Value
wmc	80
c	2
b	1
f	0
lcom	1
cbo	9
dl	38
loc	558
rs	4.8717
15 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	setUp()	0	15	4
D	getSiteInfo()	0	80	14
A	groups()	18	18	4
A	globalGroups()	18	18	4
A	namespaces()	0	4	1
C	getAdmins()	0	39	8
B	getBasicPageInfo()	0	34	4
B	displayTitles()	0	38	6
D	getPageAssessments()	0	91	14
A	getAssessmentBadgeURL()	0	12	3
A	getAssessmentsConfig()	0	8	2
A	projectHasPageAssessments()	0	4	1
B	massApi()	0	26	1
C	massApiInternal()	0	64	13
How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class
Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.
Complex classes like ApiHelper often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use ApiHelper, and based on these observations, apply Extract Interface, too.
<?php

namespace AppBundle\Helper;

use DateInterval;
use Mediawiki\Api\MediawikiApi;
use Mediawiki\Api\SimpleRequest;
use Mediawiki\Api\FluentRequest;
use Psr\Cache\CacheItemPoolInterface;
use Symfony\Component\Config\Definition\Exception\Exception;
use Symfony\Component\Debug\Exception\FatalErrorException;
use Symfony\Component\DependencyInjection\ContainerInterface;

class ApiHelper extends HelperBase
{
    /** @var MediawikiApi */
    private $api;

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

    /** @var CacheItemPoolInterface */
    protected $cache;

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

    public function __construct(ContainerInterface $container, LabsHelper $labsHelper)
    {
        $this->container = $container;
        $this->labsHelper = $labsHelper;
        $this->cache = $container->get('cache.app');
    }

    private function setUp($project)
    {
        if (!isset($this->api)) {
            $normalizedProject = $this->labsHelper->normalizeProject($project);
            $apiPath = $this->container->getParameter('api_path');

            try {
                $this->api = MediawikiApi::newFromApiEndpoint($normalizedProject . $apiPath);
            } catch (Exception $e) {
                // Do nothing...
            } catch (FatalErrorException $e) {
                // Do nothing...
            }
        }
    }

    /**
     * Get general siteinfo and namespaces for a project and cache it.
     * @param  string [$project] Base project domain with or without protocal, or database name
     *                           such as 'en.wikipedia.org', 'https://en.wikipedia.org' or 'enwiki'
     *                           Can be left blank for single wikis.
     * @return string[] with keys 'general' and 'namespaces'. General info will include 'dbName',
     *                           'wikiName', 'url', 'lang', 'articlePath', 'scriptPath',
     *                           'script', 'timezone', and 'timeOffset'
     */
    public function getSiteInfo($project = '')
    {
        $normalizedProject = $this->labsHelper->normalizeProject($project);

        if (!$normalizedProject) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            throw new Exception("Unable to find project '$project'");
        }

        if ($this->container->getParameter('app.single_wiki')) {
            $project = $this->container->getParameter('wiki_url');
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        } else {
            $project = "https://" . $normalizedProject;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        }

        $cacheKey = "siteinfo." . $normalizedProject;
        if ($this->cacheHas($cacheKey)) {
            return $this->cacheGet($cacheKey);
        }

        $this->setUp($normalizedProject);
        $params = [ 'meta'=>'siteinfo', 'siprop'=>'general|namespaces' ];
        $query = new SimpleRequest('query', $params);

        $result = [
            'general' => [],
            'namespaces' => []
        ];

        try {
            $res = $this->api->getRequest($query);

            if (isset($res['query']['general'])) {
                $info = $res['query']['general'];
                $result['general'] = [
                    'wikiName' => $info['sitename'],
                    'dbName' => $info['wikiid'],
                    'url' => $info['server'],
                    'lang' => $info['lang'],
                    'articlePath' => $info['articlepath'],
                    'scriptPath' => $info['scriptpath'],
                    'script' => $info['script'],
                    'timezone' => $info['timezone'],
                    'timeOffset' => $info['timeoffset'],
                ];

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

            if (isset($res['query']['namespaces'])) {
                foreach ($res['query']['namespaces'] as $namespace) {
                    if ($namespace['id'] < 0) {
                        continue;
                    }

                    if (isset($namespace['name'])) {
                        $name = $namespace['name'];
                    } elseif (isset($namespace['*'])) {
                        $name = $namespace['*'];
                    } else {
                        continue;
                    }

                    // FIXME: Figure out a way to i18n-ize this
                    if ($name === '') {
                        $name = 'Article';
                    }

                    $result['namespaces'][$namespace['id']] = $name;
                }
            }

            $this->cacheSave($cacheKey, $result, 'P7D');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        } catch (Exception $e) {
            // The api returned an error!  Ignore
        }

        return $result;
class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    public function groups($project, $username)

    {
        $this->setUp($project);
        $params = [ "list"=>"users", "ususers"=>$username, "usprop"=>"groups" ];
        $query = new SimpleRequest('query', $params);
        $result = [];

        try {
            $res = $this->api->getRequest($query);
            if (isset($res["batchcomplete"]) && isset($res["query"]["users"][0]["groups"])) {
                $result = $res["query"]["users"][0]["groups"];
            }
        } catch (Exception $e) {
            // The api returned an error!  Ignore
        }

        return $result;
    }

    public function globalGroups($project, $username)

    {
        $this->setUp($project);
        $params = [ "meta"=>"globaluserinfo", "guiuser"=>$username, "guiprop"=>"groups" ];
        $query = new SimpleRequest('query', $params);
        $result = [];

        try {
            $res = $this->api->getRequest($query);
            if (isset($res["batchcomplete"]) && isset($res["query"]["globaluserinfo"]["groups"])) {
                $result = $res["query"]["globaluserinfo"]["groups"];
            }
        } catch (Exception $e) {
            // The api returned an error!  Ignore
        }

        return $result;
    }

    /**
     * Get a list of namespaces on the given project.
     *
     * @param string    $project such as en.wikipedia.org
     * @return string[] Array of namespace IDs (keys) to names (values).
     */
    public function namespaces($project)
    {
        return $this->getSiteInfo($project)['namespaces'];
    }

    public function getAdmins($project)
    {
        $params = [
            'list' => 'allusers',
            'augroup' => 'sysop|bureaucrat|steward|oversight|checkuser',
            'auprop' => 'groups',
            'aulimit' => '500',
        ];

        $result = [];
        $admins = $this->massApi($params, $project, 'allusers', 'aufrom')['allusers'];

        foreach ($admins as $admin) {
            $groups = [];
            if (in_array("sysop", $admin["groups"])) {
                $groups[] = "A";
            }
            if (in_array("bureaucrat", $admin["groups"])) {
                $groups[] = "B";
            }
            if (in_array("steward", $admin["groups"])) {
                $groups[] = "S" ;
            }
            if (in_array("checkuser", $admin["groups"])) {
                $groups[] = "CU";
            }
            if (in_array("oversight", $admin["groups"])) {
                $groups[] = "OS";
            }
            if (in_array("bot", $admin["groups"])) {
                $groups[] = "Bot";
            }
            $result[ $admin["name"] ] = [
                "groups" => implode('/', $groups)
            ];
        }

        return $result;
    }

    /**
     * Get basic info about a page via the API
     * @param  string  $project      Full domain of project (en.wikipedia.org)
     * @param  string  $page         Page title
     * @param  boolean $followRedir  Whether or not to resolve redirects
     * @return array   Associative array of data
     */
    public function getBasicPageInfo($project, $page, $followRedir)
    {
        $this->setUp($project);

        // @TODO: Also include 'extlinks' prop when we start checking for dead external links.
        $params = [
            'prop' => 'info|pageprops',
            'inprop' => 'protection|talkid|watched|watchers|notificationtimestamp|subjectid|url|readable',
            'converttitles' => '',
            // 'ellimit' => 20,

            // 'elexpandurl' => '',

            'titles' => $page,
            'formatversion' => 2
            // 'pageids' => $pageIds // FIXME: allow page IDs

        ];

        if ($followRedir) {
            $params['redirects'] = '';
        }

        $query = new SimpleRequest('query', $params);
        $result = [];

        try {
            $res = $this->api->getRequest($query);
            if (isset($res['query']['pages'])) {
                $result = $res['query']['pages'][0];
            }
        } catch (Exception $e) {
            // The api returned an error!  Ignore
        }

        return $result;
    }

    /**
     * Get HTML display titles of a set of pages (or the normal title if there's no display title).
     * This will send t/50 API requests where t is the number of titles supplied.
     * @param string $project The project.
     * @param string[] $pageTitles The titles to fetch.
     * @return string[] Keys are the original supplied title, and values are the display titles.
     */
    public function displayTitles($project, $pageTitles)
    {
        $this->setUp($project);
        $displayTitles = [];
        for ($n = 0; $n < count($pageTitles); $n += 50) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
            $titleSlice = array_slice($pageTitles, $n, 50);
            $params = [
                'prop' => 'info|pageprops',
                'inprop' => 'displaytitle',
                'titles' => join('|', $titleSlice),
            ];
            $query = new SimpleRequest('query', $params);
            $result = $this->api->getRequest($query);

            // Extract normalization info.
            $normalized = [];
            if (isset($result['query']['normalized'])) {
                array_map(
                    function ($e) use (&$normalized) {
                        $normalized[$e['to']] = $e['from'];
                    },
                    $result['query']['normalized']
                );
            }

            // Match up the normalized titles with the display titles and the original titles.
            foreach ($result['query']['pages'] as $pageInfo) {
                $displayTitle = isset($pageInfo['pageprops']['displaytitle'])
                    ? $pageInfo['pageprops']['displaytitle']
                    : $pageInfo['title'];
                $origTitle = isset($normalized[$pageInfo['title']])
                    ? $normalized[$pageInfo['title']] : $pageInfo['title'];
                $displayTitles[$origTitle] = $displayTitle;
            }
        }

        return $displayTitles;
    }

    /**
     * Get assessments of the given pages, if a supported project
     * @param  string       $project    Project such as en.wikipedia.org
     * @param  string|array $pageTitles Single page title or array of titles
     * @return array|null               Page assessments info or null if none found
     */
    public function getPageAssessments($project, $pageTitles)
    {
        // From config/assessments.yml
        $config = $this->getAssessmentsConfig();

        // return null if unsupported project
        if (!in_array($project, array_keys($config))) {
            return null;
        }

        $config = $config[$project];

        $params = [
            'prop' => 'pageassessments',
            'titles' => is_string($pageTitles) ? $pageTitles : implode('|', $pageTitles),
            'palimit' => 500,
        ];

        // get assessments for this page from the API
        $assessments = $this->massApi($params, $project, function ($data) {
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            return isset($data['pages'][0]['pageassessments']) ? $data['pages'][0]['pageassessments'] : [];
        }, 'pacontinue')['pages'];

        $decoratedAssessments = [];

        // Set the default decorations for the overall quality assessment
        // This will be replaced with the first valid class defined for any WikiProject
        $overallQuality = $config['class']['Unknown'];
        $overallQuality['value'] = '???';

        if (empty($assessments)) {
            return null;
        }

        // loop through each assessment and decorate with colors, category URLs and images, if applicable
        foreach ($assessments as $wikiproject => $assessment) {
            $classValue = $assessment['class'];

            // Use ??? as the presented value when the class is unknown or is not defined in the config
            if ($classValue === 'Unknown' || $classValue === '' || !isset($config['class'][$classValue])) {
                $classAttrs = $config['class']['Unknown'];
                $assessment['class']['value'] = '???';
                $assessment['class']['category'] = $classAttrs['category'];
                $assessment['class']['badge'] = "https://upload.wikimedia.org/wikipedia/commons/". $classAttrs['badge'];
            } else {
                $classAttrs = $config['class'][$classValue];
                $assessment['class'] = [
                    'value' => $classValue,
                    'color' => $classAttrs['color'],
                    'category' => $classAttrs['category'],
                ];

                // add full URL to badge icon
                if ($classAttrs['badge'] !== '') {
                    $assessment['class']['badge'] = "https://upload.wikimedia.org/wikipedia/commons/" .
                        $classAttrs['badge'];
                }

                if ($overallQuality['value'] === '???') {
                    $overallQuality = $assessment['class'];
                    $overallQuality['category'] = $classAttrs['category'];
                }
            }

            $importanceValue = $assessment['importance'];
            $importanceUnknown = $importanceValue === 'Unknown' || $importanceValue === '';

            if ($importanceUnknown || !isset($config['importance'][$importanceValue])) {
                $importanceAttrs = $config['importance']['Unknown'];
                $assessment['importance'] = $importanceAttrs;
                $assessment['importance']['value'] = '???';
                $assessment['importance']['category'] = $importanceAttrs['category'];
            } else {
                $importanceAttrs = $config['importance'][$importanceValue];
                $assessment['importance'] = [
                    'value' => $importanceValue,
                    'color' => $importanceAttrs['color'],
                    'weight' => $importanceAttrs['weight'], // numerical weight for sorting purposes
                    'category' => $importanceAttrs['category'],
                ];
            }

            $decoratedAssessments[$wikiproject] = $assessment;
        }

        return [
            'assessment' => $overallQuality,
            'wikiprojects' => $decoratedAssessments,
            'wikiproject_prefix' => $config['wikiproject_prefix']
        ];
    }

    /**
     * Get the image URL of the badge for the given page assessment
     * @param  string $project Project such as en.wikipedia.org
     * @param  string $class   Valid classification for project, such as 'Start', 'GA', etc.
     * @return string          URL to image
     */
    public function getAssessmentBadgeURL($project, $class)
    {
        $config = $this->getAssessmentsConfig();

        if (isset($config[$project]['class'][$class])) {
            return "https://upload.wikimedia.org/wikipedia/commons/" . $config[$project]['class'][$class]['badge'];
        } elseif (isset($config[$project]['class']['Unknown'])) {
            return "https://upload.wikimedia.org/wikipedia/commons/" . $config[$project]['class']['Unknown']['badge'];
        } else {
            return "";
        }
    }

    /**
     * Fetch assessments data from config/assessments.yml and cache in static variable
     * @return array Mappings of project/quality/class with badges, colors and category links
     */
    private function getAssessmentsConfig()
    {
        static $assessmentsConfig = null;
        if ($assessmentsConfig === null) {
            $assessmentsConfig = $this->container->getParameter('assessments');
        }
        return $assessmentsConfig;
    }

    /**
     * Does the given project support page assessments?
     * @param  string  $project Project to query, e.g. en.wikipedia.org
     * @return boolean True or false
     */
    public function projectHasPageAssessments($project)
    {
        return in_array($project, array_keys($this->getAssessmentsConfig()));
    }

    /**
     * Make mass API requests to MediaWiki API
     * The API normally limits to 500 pages, but gives you a 'continue' value
     *   to finish iterating through the resource.
     * Adapted from https://github.com/MusikAnimal/pageviews
     * @param  array       $params        Associative array of params to pass to API
     * @param  string      $project       Project to query, e.g. en.wikipedia.org
     * @param  string|func $dataKey       The key for the main chunk of data, in the query hash
     *                                    (e.g. 'categorymembers' for API:Categorymembers).
     *                                    If this is a function it is given the response data,
     *                                    and expected to return the data we want to concatentate.
     * @param  string      [$continueKey] the key to look in the continue hash, if present
     *                                    (e.g. 'cmcontinue' for API:Categorymembers)
     * @param  integer     [$limit]       Max number of pages to fetch
     * @return array                      Associative array with data
     */
    public function massApi($params, $project, $dataKey, $continueKey = 'continue', $limit = 5000)
    {
        $this->setUp($project);

        // Passed by reference to massApiInternal so we can keep track of
        //   everything we need during the recursive calls
        // The magically essential part here is $data['promise'] which we'll
        //   wait to be resolved
        $data = [
            'params' => $params,
            'project' => $project,
            'continueKey' => $continueKey,
            'dataKey' => $dataKey,
            'limit' => $limit,
            'resolveData' => [
                'pages' => []
            ],
            'continueValue' => null,
            'promise' => new \GuzzleHttp\Promise\Promise(),
        ];

        // wait for all promises to complete, even if some of them fail
        \GuzzleHttp\Promise\settle($this->massApiInternal($data))->wait();

        return $data['resolveData'];
    }

    /**
     * Internal function used by massApi() to make recursive calls
     * @param  array &$data Everything we need to keep track of, as defined in massApi()
     * @return null         Nothing. $data['promise']->then is used to continue flow of
     *                      execution after all recursive calls are complete
     */
    private function massApiInternal(&$data)
    {
        $requestData = array_merge([
            'action' => 'query',
            'format' => 'json',
            'formatversion' => '2',
        ], $data['params']);

        if ($data['continueValue']) {
            $requestData[$data['continueKey']] = $data['continueValue'];
        }

        $query = FluentRequest::factory()->setAction('query')->setParams($requestData);
        $innerPromise = $this->api->getRequestAsync($query);

        $innerPromise->then(function ($result) use (&$data) {
            // some failures come back as 200s, so we still resolve and let the outer function handle it
            if (isset($result['error']) || !isset($result['query'])) {
                return $data['promise']->resolve($data);
            }

            $dataKey = $data['dataKey'];
            $isFinished = false;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

            // allow custom function to parse the data we want, if provided
            if (is_callable($dataKey)) {
                $data['resolveData']['pages'] = array_merge(
                    $data['resolveData']['pages'],
                    $data['dataKey']($result['query'])
                );
                $isFinished = count($data['resolveData']['pages']) >= $data['limit'];
            } else {
                // append new data to data from last request. We might want both 'pages' and dataKey
                if (isset($result['query']['pages'])) {
                    $data['resolveData']['pages'] = array_merge(
                        $data['resolveData']['pages'],
                        $result['query']['pages']
                    );
                }
                if ($result['query'][$dataKey]) {
                    $newValues = isset($data['resolveData'][$dataKey]) ? $data['resolveData'][$dataKey] : [];
                    $data['resolveData'][$dataKey] = array_merge($newValues, $result['query'][$dataKey]);
                }

                // If pages is not the collection we want, it will be either an empty array or one entry with
                //   basic page info depending on what API we're hitting. So resolveData[dataKey] will hit the limit
                $isFinished = count($data['resolveData']['pages']) >= $data['limit'] ||
                    count($data['resolveData'][$dataKey]) >= $data['limit'];
            }

            // make recursive call if needed, waiting 100ms
            if (!$isFinished && isset($result['continue']) && isset($result['continue'][$data['continueKey']])) {
                usleep(100000);
                $data['continueValue'] = $result['continue'][$data['continueKey']];
                return $this->massApiInternal($data);
            } else {
                // indicate there were more entries than the limit
                if ($result['continue']) {
                    $data['resolveData']['continue'] = true;
                }
                $data['promise']->resolve($data);
            }
        });
    }
}

x-tools / xtools
