DatasourceController::getDatasources() - Code Metrics - Inspection of "move timestamp logic into datasource #106" - Rello/analytics - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( dfddba...5403dd )

by Marcel
created 2021-02-08 19:32 UTC
DatasourceController::getDatasources() A

↳ Parent: DatasourceController
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0
<?php
/**
 * Analytics
 *
 * This file is licensed under the Affero General Public License version 3 or
 * later. See the LICENSE.md file.
 *
 * @author Marcel Scherello <[email protected]>
 * @copyright 2020 Marcel Scherello
 */

namespace OCA\Analytics\Controller;

use OCA\Analytics\Datasource\DatasourceEvent;
use OCA\Analytics\Datasource\ExternalFile;
use OCA\Analytics\Datasource\File;
use OCA\Analytics\Datasource\Github;
use OCA\Analytics\Datasource\Json;
use OCA\Analytics\Datasource\Regex;
use OCP\AppFramework\Controller;
use OCP\EventDispatcher\IEventDispatcher;
use OCP\Files\NotFoundException;
use OCP\IL10N;
use OCP\ILogger;
use OCP\IRequest;

class DatasourceController extends Controller
{
    private $logger;
    private $GithubService;
    private $FileService;
    private $ExternalFileService;
    private $RegexService;
    private $JsonService;
    /** @var IEventDispatcher */
    private $dispatcher;
    private $l10n;

    const DATASET_TYPE_GROUP = 0;
    const DATASET_TYPE_INTERNAL_FILE = 1;
    const DATASET_TYPE_INTERNAL_DB = 2;
    const DATASET_TYPE_GIT = 3;
    const DATASET_TYPE_EXTERNAL_FILE = 4;
    const DATASET_TYPE_REGEX = 5;
    const DATASET_TYPE_JSON = 6;

    public function __construct(
        string $AppName,
        IRequest $request,
        ILogger $logger,
        Github $GithubService,
        File $FileService,
        Regex $RegexService,
        Json $JsonService,
        ExternalFile $ExternalFileService,
        IL10N $l10n,
        IEventDispatcher $dispatcher
    )
    {
        parent::__construct($AppName, $request);
        $this->logger = $logger;
        $this->ExternalFileService = $ExternalFileService;
        $this->GithubService = $GithubService;
        $this->RegexService = $RegexService;
        $this->FileService = $FileService;
        $this->JsonService = $JsonService;
        $this->dispatcher = $dispatcher;
        $this->l10n = $l10n;
    }

    /**
     * get all datasource ids + names
     *
     * @NoAdminRequired
     */
    public function index()
    {
        $datasources = array();
        $result = array();
        foreach ($this->getDatasources() as $key => $class) {
            $datasources[$key] = $class->getName();
        }
        $result['datasources'] = $datasources;

        $options = array();
        foreach ($this->getDatasources() as $key => $class) {
            $options[$key] = $class->getTemplate();
        }
        $result['options'] = $options;

        return $result;
    }

    /**
     * get all datasource templates
     *
     * @NoAdminRequired
     * @return array
     */
    public function getTemplates()
    {
        $result = array();
        foreach ($this->getDatasources() as $key => $class) {
            $result[$key] = $class->getTemplate();
        }
        return $result;
    }

    /**
     * Get the data from a datasource;
     *
     * @NoAdminRequired
     * @param int $datasourceId
     * @param $option
     * @return array|NotFoundException
     */
    public function read(int $datasourceId, $option)
    {
        //$this->logger->debug('DatasourceController 66: Datasource Id: ' . $datasource . ', Option: ' . json_encode($option));
        $result = $this->getDatasources()[$datasourceId]->readData($option);

        if (isset($option['timestamp']) and $option['timestamp'] === 'true') {
            // if datasource should be timestamped/snapshoted
            // shift values by one dimension and stores date in second column
            $result['data'] = array_map(function ($tag) {
                $columns = count($tag);
                return array($tag[$columns - 2], $tag[$columns - 2], $tag[$columns - 1]);
            }, $result['data']);
            $result['data'] = $this->replaceDimension($result['data'], 1, date("Y-m-d H:i:s"));
        }
        return $result;
    }

    /**
     * combine internal and registered datasources
     * @return array
     */
    private function getDatasources()
    {
        return $this->getOwnDatasources() + $this->getRegisteredDatasources();
    }

    /**
     * map all internal datasources to their IDs
     * @return array
     */
    private function getOwnDatasources()
    {
        $datasources = [];
        $datasources[self::DATASET_TYPE_INTERNAL_FILE] = $this->FileService;
        $datasources[self::DATASET_TYPE_GIT] = $this->GithubService;
        $datasources[self::DATASET_TYPE_EXTERNAL_FILE] = $this->ExternalFileService;
        $datasources[self::DATASET_TYPE_REGEX] = $this->RegexService;
        $datasources[self::DATASET_TYPE_JSON] = $this->JsonService;
        return $datasources;
    }

    /**
     * map all registered datasources to their IDs
     * @return array
     */
    private function getRegisteredDatasources()
    {
        $datasources = [];
        $event = new DatasourceEvent();
        $this->dispatcher->dispatchTyped($event);

        foreach ($event->getDataSources() as $class) {
            $uniqueId = '99' . \OC::$server->get($class)->getId();

            if (isset($datasources[$uniqueId])) {
                $this->logger->logException(new \InvalidArgumentException('Datasource with the same ID already registered: ' . \OC::$server->get($class)->getName()), ['level' => ILogger::INFO]);
                $this->logger->logException(new \InvalidArgumentException('Datasource with the same ID already registered: ' . \OC::$server->get($class)->getName()), ['level' => /** @scrutinizer ignore-deprecated */ ILogger::INFO]);
                continue;
            }
            $datasources[$uniqueId] = \OC::$server->get($class);
        }
        return $datasources;
    }

    /**
     * replace all values of one dimension
     *
     * @NoAdminRequired
     * @param $Array
     * @param $Find
     * @param $Replace
     * @return array
     */
    private function replaceDimension($Array, $Find, $Replace)
    {
        if (is_array($Array)) {
            foreach ($Array as $Key => $Val) {
                if (is_array($Array[$Key])) {
                    $Array[$Key] = $this->replaceDimension($Array[$Key], $Find, $Replace);
                } else {
                    if ($Key === $Find) {
                        $Array[$Key] = $Replace;
                    }
                }
            }
        }
        return $Array;
    }
}
Rello / analytics

Push — master ( dfddba...5403dd )

DatasourceController::getDatasources() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
