Issues in GithubClient.php - New Issues - Inspection of "- changed output of error when request data from g..." - ggoffy/wggithub - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( b00485...b911e4 )

by Goffy
created 2021-03-18 11:51 UTC
class/Github/GithubClient.php (6 issues)

Labels

Severity

<?php

declare(strict_types=1);

namespace XoopsModules\Wggithub\Github;

/*
 * You may not change or alter any portion of this comment or credits
 * of supporting developers from this source code or any supporting source code
 * which is considered copyrighted (c) material of the original comment or credit authors.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 */
/**
 * @copyright    XOOPS Project https://xoops.org/
 * @license      GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
 * @since
 * @author       Goffy - XOOPS Development Team
 */

use XoopsModules\Wggithub;
use XoopsModules\Wggithub\{
    Helper,
    Constants,
    Github
};

/**
 * Class GithubClient
 */
class GithubClient extends Api
{
    /**
     * @var string
     */
    public const BASE_URL = 'https://api2.github.com/';

    /**
     * @var string
     */
    //public $userAuth = 'myusername';

    /**
     * @var string
     */
    public $tokenAuth = 'mytoken';

    /**
     * @var object
     */
    private $helper = null;

    /**
     * Constructor
     *
     * @param null
     */
    public function __construct()
    {
        $this->helper = \XoopsModules\Wggithub\Helper::getInstance();
        $this->getSetting();
    }

    /**
     * @static function &getInstance
     *
     * @param null
     * @return GitHubClient of Api
     */
    public static function getInstance()
    {
        static $instance = false;
        if (!$instance) {
            $instance = new self();
        }

        return $instance;
    }

    public function testApi1($url) {
        $api = new Github\Api;
        $response = $api->get(static::BASE_URL . $url);
        $data = $api->decode($response);
        
        return $data;
    }

    public function testApi2($url) {
        $api = new Github\Api;

        $token = new Github\OAuth\Token('{myKey}', 'bearer', ['repo', 'user', 'public_repo']);
        $api->setToken($token);
        $response = $api->get(static::BASE_URL . $url);

        $data = $api->decode($response);

        /*
        $api = new Github\Api;

        $request = $api->createRequest('GET', $url, [], [], '');
        $response = $api->request($request);
        $data = (array)$api->decode($response);
        */

        return $data;
    }

    /**
     * Get repositories of given user
     *
     * @param     $username
     * @param int $per_page
     * @param int $page
     * @return array
     */
    public function getUserRepositories($username, $per_page = 100, $page = 1)
    {
        $url = static::BASE_URL . 'users/' . \rawurlencode($username) . '/repos?per_page=' . $per_page . '&page=' . $page;

        return $this->_get($url);

    }

    /**
     * Get repositories of given organisation
     *
     * @param     $org
     * @param int $per_page
     * @param int $page
     * @return array
     */
    public function getOrgRepositories($org, $per_page = 100, $page = 1)
    {
        $url = static::BASE_URL . 'orgs/' . \rawurlencode($org) . '/repos?per_page=' . $per_page . '&page=' . $page;

        return $this->_get($url);

    }

    /**
     * Get the readme content for a repository by its username and repository name.
     *
     * @param string $username   the user who owns the repository
     * @param string $repository the name of the repository
     * @return string|array the readme content
     */
    public function getReadme($username, $repository)
    {
        $url = static::BASE_URL . 'repos/' . \rawurlencode($username) . '/' . \rawurlencode($repository) . '/readme';

        return $this->_get($url, true);
    }

    /**
     * Get all releases
     *
     * @param string $username   the user who owns the repository
     * @param string $repository the name of the repository
     * @return array
     */
    public function getReleases($username, $repository)
    {
        $url = static::BASE_URL . 'repos/' . $username . '/' . $repository . '/releases';

        return $this->_get($url, true);
    }

    /**
     * Get latest release
     *
     * @param string $username   the user who owns the repository
     * @param string $repository the name of the repository
     * @param bool   $prerelease
     * @return array
     */
    public function getLatestRelease($username, $repository, $prerelease = false)
    {
        //function currently not used
        if ($prerelease) {
            $url = static::BASE_URL . 'repos/' . $username . '/' . $repository . '/releases';
        } else {
            $url = static::BASE_URL . 'repos/' . $username . '/' . $repository . '/releases/latest';
        }
        $result = $this->_get($url);

        if (\is_array($result) && \array_key_exists('error_code', $result)) {
            //TODO: improve error handling
            echo $result['message'];
            die;

        }
        if ($prerelease) {
            if (\is_array($result)) {
                return $result[0];
            } else {
                return [];
            }
        }

        return $result;

    }
    
    /**
     * Get content of repository
     *
     * @param  $username
     * @param  $repository
     * @return array
     */
    public function getRepositoryContent($username, $repository)
    {
        $url = static::BASE_URL . 'repos/'.rawurlencode($username).'/'.rawurlencode($repository).'/contents';

        return $this->_get($url);

    }

    /**
     * Get github content
     *
     * @param      $url
     * @param bool $skipError
     * @return array|bool
     */
    public function _get($url, $skipError = false)
    {
        $error = false;
        $errMsg = '';

        $logsHandler = $this->helper->getHandler('Logs');
        $logsHandler->updateTableLogs(Constants::LOG_TYPE_REQUEST, $url, 'START');
        $api = new Github\Api;
        $token = new Github\OAuth\Token($this->tokenAuth, 'bearer', ['repo', 'user', 'public_repo']);
        $api->setToken($token);
        $response = $api->get($url);
        $code = $response->getCode();
        if (\in_array($code, [200, 201], true)) {
            $logsHandler->updateTableLogs(Constants::LOG_TYPE_REQUEST, $url, 'OK');
        } else {
            if ($skipError) {
                $logsHandler->updateTableLogs(Constants::LOG_TYPE_ERROR, $errMsg, 'Skipped');
                return false;
            } else {
                $error = true;
                $errMsg = $response->getContent();
                $logsHandler->updateTableLogs(Constants::LOG_TYPE_ERROR, $errMsg, 'ERROR ' . $code);
            }
        }
        if ($error) {
            //catch common errors
            switch ($code) {
                case 401:
                    $message = \_MA_WGGITHUB_READGH_ERROR_API_401;
                    break;
                case 403:
                    /*if (\strpos($errMsg, 'API rate limit exceeded') > 0) {$GLOBALS['xoopsTpl']->assign('apiexceed', true);}*/
                    $message = \_MA_WGGITHUB_READGH_ERROR_API_403;
                    break;
                case 404:
                    $message = \_MA_WGGITHUB_READGH_ERROR_API_404;
                    break;
                case 405:
                    $message = \_MA_WGGITHUB_READGH_ERROR_API_405;
                    break;
                case 0:
                default:
                    $message = \_MA_WGGITHUB_READGH_ERROR_API . '(' .$code . ' - ' .  $errMsg . ')';
                    break;
            }
            redirect_header('index.php?op=api_error&amp;message='. $message . '&amp;url='. $url, 5, $message);
            //throw new \RuntimeException('"' . $message . '"');
        } else {
            $data = (array)$api->decode($response);
        }

        return $data;
    }

    /**
     * Execute update of repositories and all related tables
     * @param string $dirName
     * @return bool
     */
    public function executeUpdate($dirName = '')
    {
        $helper = Helper::getInstance();
        $directoriesHandler = $helper->getHandler('Directories');
        $repositoriesHandler = $helper->getHandler('Repositories');
        $releasesHandler = $helper->getHandler('Releases');
        $readmesHandler = $helper->getHandler('Readmes');
        $logsHandler = $helper->getHandler('Logs');

        $logsHandler->updateTableLogs(Constants::LOG_TYPE_UPDATE_START, '', 'OK');
        $crDirectories = new \CriteriaCompo();
        if ('' !== $dirName) {
            $crDirectories->add(new \Criteria('dir_name', $dirName));
        } else {
            $crDirectories->add(new \Criteria('dir_autoupdate', 1));
        }
        $crDirectories->add(new \Criteria('dir_online', 1));
        $directoriesAll = $directoriesHandler->getAll($crDirectories);
        // Get All Directories
        $directories = [];
        foreach (\array_keys($directoriesAll) as $i) {
            $directories[$i] = $directoriesAll[$i]->getValuesDirectories();
            $dirName = $directoriesAll[$i]->getVar('dir_name');
            $dirContent = $directoriesAll[$i]->getVar('dir_content');
            $repos = [];
            for ($j = 1; $j <= 9; $j++) {
                $repos[$j] = [];
                if (Constants::DIRECTORY_TYPE_ORG == $directoriesAll[$i]->getVar('dir_type')) {
                    $repos = $this->getOrgRepositories($dirName, 100, $j);
                } else {
                    $repos = $this->getUserRepositories($dirName, 100, $j);
                }
                if (false === $repos) {
                    return false;
                    break 1;
                }
                if (\count($repos) > 0) {
                    $repositoriesHandler->updateTableRepositories($dirName, $repos, true, $dirContent);
                } else {
                    break 1;
                }
                if (\count($repos) < 100) {
                    break 1;
                }
            }
        }
        unset($directories);

        $releasesHandler->updateRepoReleases();
        $readmesHandler->updateRepoReadme();

        $logsHandler->updateTableLogs(Constants::LOG_TYPE_UPDATE_END, '', 'OK');

        return true;
    }

    /**
     * Get primary setting
     *
     * @return bool|array
     */
    private function getSetting()
    {
        $settingsHandler = $this->helper->getHandler('Settings');
        $setting = $settingsHandler->getPrimarySetting();

        if (0 == \count($setting)) {
            \redirect_header(\XOOPS_URL . '/index.php', 3, \_AM_WGGITHUB_THEREARENT_SETTINGS);
            /** @scrutinizer ignore-call */ \redirect_header(\XOOPS_URL . '/index.php', 3, \_AM_WGGITHUB_THEREARENT_SETTINGS);
        }
        //$this->userAuth = $setting['user'];
        $this->tokenAuth = $setting['token'];

        return true;
    }
}

ggoffy / wggithub

Push — master ( b00485...b911e4 )

class/Github/GithubClient.php (6 issues)

Labels

Severity

Introduced By

Duplication Side-by-Side

Filter issues like
