ReportService::search() - Code Metrics - Inspection of "Multiple reports per dataset #193" - Rello/analytics - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 0b1a33...6372a5 )

by Marcel
created 2021-10-13 21:13 UTC
ReportService::search() A

↳ Parent: ReportService
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	1
dl	0
loc	3
rs	10
<?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 2021 Marcel Scherello
 */

namespace OCA\Analytics\Service;

use OCA\Analytics\Activity\ActivityManager;
use OCA\Analytics\Controller\DatasourceController;
use OCA\Analytics\Db\DataloadMapper;
use OCA\Analytics\Db\ReportMapper;
use OCA\Analytics\Db\StorageMapper;
use OCP\AppFramework\Http\DataDownloadResponse;
use OCP\AppFramework\Http\DataResponse;
use OCP\Files\IRootFolder;
use OCP\ITagManager;
use Psr\Log\LoggerInterface;

class ReportService
{
    private $userId;
    private $logger;
    private $tagManager;
    private $ShareService;
    private $DatasetService;
    private $StorageMapper;
    private $ReportMapper;
    private $ThresholdService;
    private $DataloadMapper;
    private $ActivityManager;
    private $rootFolder;
    private $VariableService;

    public function __construct(
        $userId,
        LoggerInterface $logger,
        ITagManager $tagManager,
        ShareService $ShareService,
        DatasetService $DatasetService,
        StorageMapper $StorageMapper,
        ReportMapper $ReportMapper,
        ThresholdService $ThresholdService,
        DataloadMapper $DataloadMapper,
        ActivityManager $ActivityManager,
        IRootFolder $rootFolder,
        VariableService $VariableService
    )
    {
        $this->userId = $userId;
        $this->logger = $logger;
        $this->tagManager = $tagManager;
        $this->ShareService = $ShareService;
        $this->DatasetService = $DatasetService;
        $this->ThresholdService = $ThresholdService;
        $this->StorageMapper = $StorageMapper;
        $this->ReportMapper = $ReportMapper;
        $this->DataloadMapper = $DataloadMapper;
        $this->ActivityManager = $ActivityManager;
        $this->rootFolder = $rootFolder;
        $this->VariableService = $VariableService;
    }

    /**
     * get all reports
     *
     * @return DataResponse
     */
    public function index()
    {
        $ownReports = $this->ReportMapper->index();

        // get dataload indicators for icons shown in the advanced screen
        $dataloads = $this->DataloadMapper->getAllDataloadMetadata();
        foreach ($dataloads as $dataload) {
            $key = array_search($dataload['dataset'], array_column($ownReports, 'dataset'));
            if ($key !== '') {
                if ($dataload['schedules'] !== '' and $dataload['schedules'] !== null) {
                    $dataload['schedules'] = 1;
                } else {
                    $dataload['schedules'] = 0;
                }
                $ownReports[$key]['dataloads'] = $dataload['dataloads'];
                $ownReports[$key]['schedules'] = $dataload['schedules'];
            }
        }

        // get shared reports and remove doublicates
        $sharedReports = $this->ShareService->getSharedReports();
        foreach ($sharedReports as $sharedReport) {
            if (!array_search($sharedReport['id'], array_column($ownReports, 'id'))) {
                $sharedReport['type'] = '99';
                $sharedReport['parrent'] = '0';
                array_push($ownReports, $sharedReport);
            }
        }

        $favorites = $this->tagManager->load('analytics')->getFavorites();
        foreach ($ownReports as &$ownReport) {
            $hasTag = 0;
            if (is_array($favorites) and in_array($ownReport['id'], $favorites)) {
                $hasTag = 1;
            }
            $ownReport['favorite'] = $hasTag;
            $ownReport = $this->VariableService->replaceTextVariables($ownReport);
        }

        return new DataResponse($ownReports);
    }

    /**
     * get own report details
     *
     * @param int $reportId
     * @return array
     */
    public function read(int $reportId)
    {
        $ownReport = $this->ReportMapper->read($reportId);
        if (!empty($ownReport)) {
            $ownReport['permissions'] = \OCP\Constants::PERMISSION_UPDATE;
            $ownReport = $this->VariableService->replaceTextVariables($ownReport);
        }
        return $ownReport;
    }

    /**
     * get own reports which are marked as favorites
     *
     * @return array|bool
     */
    public function getOwnFavoriteReports()
    {
        $ownReports = $this->ReportMapper->index();
        $favorits = $this->tagManager->load('analytics')->getFavorites();
        $sharedReports = $this->ShareService->getSharedReports();

        foreach ($favorits as $favorite) {
            if (array_search($favorite, array_column($ownReports, 'id')) === false
                && array_search($favorite, array_column($sharedReports, 'id')) === false) {
                unset($favorits[$favorite]);
                $this->tagManager->load('analytics')->removeFromFavorites($favorite);
            }
        }

        return $favorits;
    }

    /**
     * create new blank report
     *
     * @return int
     */
    public function create(): int
    {
        $this->ActivityManager->triggerEvent(0, ActivityManager::OBJECT_DATASET, ActivityManager::SUBJECT_DATASET_ADD);
        return $this->ReportMapper->create();
    }

    /**
     * copy an existing report with the current navigation status
     *
     * @NoAdminRequired
     * @param int $reportId
     * @param $chartoptions
     * @param $dataoptions
     * @param $filteroptions
     * @return int
     */
    public function createCopy(int $reportId, $chartoptions, $dataoptions, $filteroptions)
    {

        $newId = $this->ReportMapper->create();
        $template = $this->ReportMapper->read($reportId);
        $this->ReportMapper->update($newId,
            $template['name'] . ' copy',
            $template['subheader'],
            $template['parent'],
            $template['type'],
            $template['dataset'],
            $template['link'],
            $template['visualization'],
            $template['chart'],
            $template['chartoptions'],
            $template['dataoptions'],
            $template['dimension1'],
            $template['dimension2'],
            $template['value']);
        $this->ReportMapper->updateOptions($newId, $chartoptions, $dataoptions, $filteroptions);
        return $newId;
    }

    /**
     * create new report
     *
     * @param string $file
     * @return int
     */
    public function createFromFile($file = '')
    {
        $this->ActivityManager->triggerEvent(0, ActivityManager::OBJECT_DATASET, ActivityManager::SUBJECT_DATASET_ADD);
        $reportId = $this->ReportMapper->create();

        if ($file !== '') {
            $name = explode('.', end(explode('/', $file)))[0];
            $subheader = $file;
            $parent = 0;
            $type = DatasourceController::DATASET_TYPE_FILE;
            $link = $file;
            $visualization = 'table';
            $chart = 'line';
            $this->update($reportId, $name, $subheader, $parent, $type, $link, $visualization, $chart, '', '');
                   update($reportId, $name, $subheader, $parent, $type, $link, $visualization, $chart, '', '');
        }
        return $reportId;
    }

    /**
     * update report details
     *
     * @param int $reportId
     * @param $name
     * @param $subheader
     * @param int $parent
     * @param int $type
     * @param int $dataset
     * @param $link
     * @param $visualization
     * @param $chart
     * @param $chartoptions
     * @param $dataoptions
     * @param null $dimension1

     * @param null $dimension2

     * @param null $value

     * @return bool
     * @throws \OCP\DB\Exception
     */
    public function update(int $reportId, $name, $subheader, int $parent, int $type, int $dataset, $link, $visualization, $chart, $chartoptions, $dataoptions, $dimension1 = null, $dimension2 = null, $value = null)
    {
        if ($type === DatasourceController::DATASET_TYPE_GROUP) {
            $parent = 0;
        }
        if ($type === DatasourceController::DATASET_TYPE_INTERNAL_DB && $dataset === 0) { // New dataset
            $dataset = $this->DatasetService->create($name, $dimension1, $dimension2, $value);
        }
        return $this->ReportMapper->update($reportId, $name, $subheader, $parent, $type, $dataset, $link, $visualization, $chart, $chartoptions, $dataoptions, $dimension1, $dimension2, $value);
    }

    /**
     * set/remove the favorite flag for a report
     *
     * @param int $reportId
     * @param string $favorite
     * @return bool
     */
    public function setFavorite(int $reportId, string $favorite)
    {
        if ($favorite === 'true') {
            $return = $this->tagManager->load('analytics')->addToFavorites($reportId);
        } else {
            $return = $this->tagManager->load('analytics')->removeFromFavorites($reportId);
        }
        return $return;
    }

    /**
     * Import Report from File
     *
     * @param string|null $path
     * @param string|null $raw
     * @return int
     * @throws \OCP\Files\NotFoundException
     * @throws \OCP\Files\NotPermittedException
     */
    public function import(string $path = null, string $raw = null)
    {
        if ($path !== '') {
            $file = $this->rootFolder->getUserFolder($this->userId)->get($path);
            $data = $file->getContent();
            $data = $file->getContent();
        } else if ($raw !== null) {
            $data = $raw;
        } else {
            return false;

        }
        $data = json_decode($data, true);

        $dataset = $data['dataset'];
        isset($dataset['name']) ? $name = $dataset['name'] : $name = '';
        isset($dataset['subheader']) ? $subheader = $dataset['subheader'] : $subheader = '';
        $parent = 0;
        isset($dataset['type']) ? $type = $dataset['type'] : $type = null;
        isset($dataset['link']) ? $link = $dataset['link'] : $link = null;
        isset($dataset['visualization']) ? $visualization = $dataset['visualization'] : $visualization = null;
        isset($dataset['chart']) ? $chart = $dataset['chart'] : $chart = null;
        isset($dataset['chartoptions']) ? $chartoptions = $dataset['chartoptions'] : $chartoptions = null;
        isset($dataset['dataoptions']) ? $dataoptions = $dataset['dataoptions'] : $dataoptions = null;
        isset($dataset['filteroptions']) ? $filteroptions = $dataset['filteroptions'] : $filteroptions = null;
        isset($dataset['dimension1']) ? $dimension1 = $dataset['dimension1'] : $dimension1 = null;
        isset($dataset['dimension2']) ? $dimension2 = $dataset['dimension2'] : $dimension2 = null;
        isset($dataset['value']) ? $value = $dataset['value'] : $value = null;

        $reportId = $this->ReportMapper->create();
        $this->ReportMapper->update($reportId, $name, $subheader, $parent, $type, $link, $visualization, $chart, $chartoptions, $dataoptions, $dimension1, $dimension2, $value, $filteroptions);

        foreach ($data['dataload'] as $dataload) {
            isset($dataload['datasource']) ? $datasource = $dataload['datasource'] : $datasource = null;
            isset($dataload['name']) ? $name = $dataload['name'] : $name = null;
            isset($dataload['option']) ? $option = $dataload['option'] : $option = null;
            $schedule = null;

            /**todo**/
            $dataloadId = $this->DataloadMapper->create($reportId, $datasource);
            $this->DataloadMapper->update($dataloadId, $name, $option, $schedule);
        }

        foreach ($data['threshold'] as $threshold) {
            isset($threshold['dimension1']) ? $dimension1 = $threshold['dimension1'] : $dimension1 = null;
            isset($threshold['value']) ? $value = $threshold['value'] : $value = null;
            isset($threshold['option']) ? $option = $threshold['option'] : $option = null;
            isset($threshold['severity']) ? $severity = $threshold['severity'] : $severity = null;
            $this->ThresholdService->create($reportId, $dimension1, $option, $value, $severity);
        }

        foreach ($data['data'] as $dData) {
            isset($dData[0]) ? $dimension1 = $dData[0] : $dimension1 = null;
            isset($dData[1]) ? $dimension2 = $dData[1] : $dimension2 = null;
            isset($dData[2]) ? $value = $dData[2] : $value = null;
            $this->StorageMapper->create($reportId, $dimension1, $dimension2, $value);
        }

        if (isset($data['favorite'])) {
            $this->setFavorite($reportId, $data['favorite']);
        }

        return $reportId;
    }

    /**
     * Export Report
     *
     * @param int $reportId
     * @return DataDownloadResponse
     */
    public function export(int $reportId)
    {
        /**todo**/
        $result = array();
        $result['dataset'] = $this->ReportMapper->read($reportId);
        $result['dataload'] = $this->DataloadMapper->read($datasetId);

        $result['threshold'] = $this->ThresholdService->read($reportId);
        $result['favorite'] = '';

        if ($result['dataset']['type'] === DatasourceController::DATASET_TYPE_INTERNAL_DB) {
            $result['data'] = $this->StorageMapper->read($datasetId);
        }

        unset($result['dataset']['id'], $result['dataset']['user_id'], $result['dataset']['user_id'], $result['dataset']['parent']);
        $data = json_encode($result);
        return new DataDownloadResponse($data, $result['dataset']['name'] . '.export.txt', 'text/plain; charset=utf-8');
    }

    /**
     * Delete Dataset and all depending objects
     *
     * @param int $reportId
     * @return bool
     */
    public function delete(int $reportId): bool
    {
        $this->ShareService->deleteShareByReport($reportId);
        $this->StorageMapper->deleteByDataset($reportId);
        /**todo**/
        // delete dataset when last report
        $this->ReportMapper->delete($reportId);
        $this->ThresholdService->deleteThresholdByReport($reportId);
        $this->DataloadMapper->deleteDataloadByDataset($reportId);
        $this->ActivityManager->triggerEvent(0, ActivityManager::OBJECT_DATASET, ActivityManager::SUBJECT_DATASET_DELETE);
        $this->setFavorite($reportId, 'false');
        return true;
    }

    /**
     * Update report options
     *
     * @param int $reportId
     * @param $chartoptions
     * @param $dataoptions
     * @param $filteroptions
     * @return bool
     */
    public function updateOptions(int $reportId, $chartoptions, $dataoptions, $filteroptions)
    {
        return $this->ReportMapper->updateOptions($reportId, $chartoptions, $dataoptions, $filteroptions);
    }

    /**
     * get report refresh options
     *
     * @NoAdminRequired
     * @param int $reportId
     * @param $refresh
     * @return bool
     */
    public function updateRefresh(int $reportId, $refresh)
    {
        return $this->ReportMapper->updateRefresh($reportId, $refresh);
    }

    /**
     * search for reports
     *
     * @param string $searchString
     * @return array
     */
    public function search(string $searchString)
    {
        return $this->ReportMapper->search($searchString);
    }

}
Rello / analytics

Push — master ( 0b1a33...6372a5 )

ReportService::search() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
