XoopsModules\Wggithub\ReadmesHandler

Complexity

Total Complexity

30

Size/Duplication

Total Lines	252
Duplicated Lines	0 %

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
C	updateTableReadmes()	0	50	12
A	getCountReadmes()	0	5	1
A	get()	0	3	1
A	__construct()	0	3	1
A	create()	0	3	1
A	getReadmesCriteria()	0	7	1
A	getAllReadmes()	0	5	1
A	getInsertId()	0	3	1
A	convertMD()	0	9	1
B	updateReadmes()	0	57	9
A	updateRepoReadme()	0	10	1

<?php

namespace XoopsModules\Wggithub;

/*
 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.
*/

/**
 * wgGitHub module for xoops
 *
 * @copyright      2020 XOOPS Project (https://xooops.org)
 * @license        GPL 2.0 or later
 * @package        wggithub
 * @since          1.0
 * @min_xoops      2.5.10
 * @author         Goffy - XOOPS Development Team - Email:<goffy@wedega.com> - Website:<https://wedega.com>
 */

use XoopsModules\Wggithub;
use XoopsModules\Wggithub\{
    Constants,

This use statement conflicts with another class in this namespace, XoopsModules\Wggithub\Constants. Consider defining an alias.

    MDParser
};


/**
 * Class Object Handler Readmes
 */
class ReadmesHandler extends \XoopsPersistableObjectHandler

The type XoopsPersistableObjectHandler was not found. Maybe you did not declare it correctly or list all dependencies?

{
	/**
	 * Constructor
	 *
	 * @param \XoopsDatabase $db
	 */
	public function __construct(\XoopsDatabase $db)

The type XoopsDatabase was not found. Maybe you did not declare it correctly or list all dependencies?

	{
		parent::__construct($db, 'wggithub_readmes', Readmes::class, 'rm_id', 'rm_name');
	}

	/**
	 * @param bool $isNew
	 *
	 * @return object
	 */
	public function create($isNew = true)
	{
		return parent::create($isNew);
	}

	/**
	 * retrieve a field
	 *
	 * @param int $i field id
	 * @param null fields

The type XoopsModules\Wggithub\fields was not found. Maybe you did not declare it correctly or list all dependencies?

	 * @return mixed reference to the {@link Get} object
	 */
	public function get($i = null, $fields = null)
	{
		return parent::get($i, $fields);
	}

	/**
	 * get inserted id
	 *
	 * @param null
	 * @return int reference to the {@link Get} object
	 */
	public function getInsertId()
	{
		return $this->db->getInsertId();
	}

	/**
	 * Get Count Readmes in the database
	 * @param int    $start
	 * @param int    $limit
	 * @param string $sort
	 * @param string $order
	 * @return int
	 */
	public function getCountReadmes($start = 0, $limit = 0, $sort = 'rm_id ASC, rm_name', $order = 'ASC')
	{
		$crCountReadmes = new \CriteriaCompo();

The type CriteriaCompo was not found. Maybe you did not declare it correctly or list all dependencies?

		$crCountReadmes = $this->getReadmesCriteria($crCountReadmes, $start, $limit, $sort, $order);
		return $this->getCount($crCountReadmes);
	}

	/**
	 * Get All Readmes in the database
	 * @param int    $start
	 * @param int    $limit
	 * @param string $sort
	 * @param string $order
	 * @return array
	 */
	public function getAllReadmes($start = 0, $limit = 0, $sort = 'rm_id ASC, rm_name', $order = 'ASC')
	{
		$crAllReadmes = new \CriteriaCompo();
		$crAllReadmes = $this->getReadmesCriteria($crAllReadmes, $start, $limit, $sort, $order);
		return $this->getAll($crAllReadmes);
	}

	/**
	 * Get Criteria Readmes
	 * @param        $crReadmes
	 * @param int    $start
	 * @param int    $limit
	 * @param string $sort
	 * @param string $order
	 * @return int
	 */
	private function getReadmesCriteria($crReadmes, $start, $limit, $sort, $order)
	{
		$crReadmes->setStart($start);
		$crReadmes->setLimit($limit);
		$crReadmes->setSort($sort);
		$crReadmes->setOrder($order);
		return $crReadmes;
	}

    /**
     * Update table requests
     *
     * @return boolean
     */
    public function updateTableReadmes()
    {
        $helper = Wggithub\Helper::getInstance();
        $repositoriesHandler = $helper->getHandler('Repositories');
        $readmesHandler = $helper->getHandler('Readmes');

        $libRepositories = new Wggithub\Github\Repositories();

        $submitter = isset($GLOBALS['xoopsUser']) && \is_object($GLOBALS['xoopsUser']) ? $GLOBALS['xoopsUser']->getVar('uid') : 0;

        $repositoriesCount = $repositoriesHandler->getCount();
        if ($repositoriesCount > 0) {
            $repositoriesAll = $repositoriesHandler->getAll();
            foreach (\array_keys($repositoriesAll) as $i) {
                $repoId = $repositoriesAll[$i]->getVar('repo_id');
                $repoStatus = $repositoriesAll[$i]->getVar('repo_status');
                $crReadmes = new \CriteriaCompo();
                $crReadmes->add(new \Criteria('rm_repoid', $repoId));

The type Criteria was not found. Maybe you did not declare it correctly or list all dependencies?

                $readmesCount = $readmesHandler->getCount($crReadmes);
                if (Constants::STATUS_NEW === $repoStatus || Constants::STATUS_UPDATED === $repoStatus || 0 == $readmesCount) {
                    $readme = $libRepositories->getReadme($repositoriesAll[$i]->getVar('repo_user'), $repositoriesAll[$i]->getVar('repo_name'));
                    if ($readmesCount > 0) {
                        $readmesAll = $readmesHandler->getAll($crReadmes);
                        foreach (\array_keys($readmesAll) as $j) {
                            $rmId = $readmesAll[$j]->getVar('rm_id');
                        }
                        unset($crReadmes, $readmesAll);
                        $readmesObj = $readmesHandler->get($rmId);

The variable $rmId does not seem to be defined for all execution paths leading up to this point.

                    } else {
                        $readmesObj = $readmesHandler->create();
                    }
                }
                if (\is_array($readme)) {

The variable $readme does not seem to be defined for all execution paths leading up to this point.

                    $readmesObj->setVar('rm_repoid', $repoId);

The variable $readmesObj does not seem to be defined for all execution paths leading up to this point.

                    $readmesObj->setVar('rm_name', $readme['name']);
                    $readmesObj->setVar('rm_type', $readme['type']);
                    $readmesObj->setVar('rm_content', $readme['content']);
                    $readmesObj->setVar('rm_encoding', $readme['encoding']);
                    $readmesObj->setVar('rm_downloadurl', $readme['download_url']);
                    $readmesObj->setVar('rm_datecreated',time());
                    $readmesObj->setVar('rm_submitter', $submitter);
                    // Insert Data
                    if (!$readmesHandler->insert($readmesObj)) {
                        return false;
                    }
                }
            }
        }

        return true;
    }


    /**
     * Update table requests
     *
     * @param $repoId
     * @param $userName
     * @param $repoName
     * @return boolean
     */
    public function updateReadmes($repoId, $userName, $repoName)
    {
        $helper = Wggithub\Helper::getInstance();
        $readmesHandler = $helper->getHandler('Readmes');

        $libRepositories = new Wggithub\Github\Repositories();

        $submitter = isset($GLOBALS['xoopsUser']) && \is_object($GLOBALS['xoopsUser']) ? $GLOBALS['xoopsUser']->getVar('uid') : 0;

        $readme = $libRepositories->getReadme($userName, $repoName);
        if (false === $readme) {

The condition false === $readme is always false.

            return false;
        }
        if (count($readme) > 0) {

It seems like $readme can also be of type string; however, parameter $var of count() does only seem to accept Countable|array, maybe add an additional type check?

            if (array_key_exists('message', $readme)) {

It seems like $readme can also be of type string; however, parameter $search of array_key_exists() does only seem to accept array, maybe add an additional type check?

                // not readme found
                // must return true otherwise releases will not be loaded
                return true;
            }
            $rmId = 0;
            $crReadmes = new \CriteriaCompo();
            $crReadmes->add(new \Criteria('rm_repoid', $repoId));
            $readmesAll = $readmesHandler->getAll($crReadmes);
            foreach (\array_keys($readmesAll) as $j) {
                $rmId = $readmesAll[$j]->getVar('rm_id');
            }
            unset($crReadmes, $readmesAll);
            if ($rmId > 0) {
                $readmesObj = $readmesHandler->get($rmId);
            } else {
                $readmesObj = $readmesHandler->create();
            }
            $readmesObj->setVar('rm_repoid', $repoId);
            $readmesObj->setVar('rm_name', $readme['name']);
            $readmesObj->setVar('rm_type', $readme['type']);
            /*
             * TODO
            $contentDecoded = base64_decode($this->getVar('rm_content', 'n'));
            if ('.MD' == substr(strtoupper($readme['name']), -3)) {
                $contentClean = convertMD($contentDecoded);
            } else {
                $contentClean = $contentDecoded;
            }
            $readmesObj->setVar('rm_content', $contentClean);
            */
            $readmesObj->setVar('rm_content', $readme['content']);
            $readmesObj->setVar('rm_encoding', $readme['encoding']);
            $readmesObj->setVar('rm_downloadurl', $readme['download_url']);
            $readmesObj->setVar('rm_datecreated',time());
            $readmesObj->setVar('rm_submitter', $submitter);
            // Insert Data
            if (!$readmesHandler->insert($readmesObj)) {
                return false;
            }
        }

        return true;
    }

    /**
     * TODO
     * convert md file content into clean text
     * and replace relative path for images into full path
     *
     * @param $contentDecoded
     * @return string
     */
    public function convertMD($contentDecoded)
    {
        // parse MD file
        $Parsedown = new MDParser\Parsedown();
        $contentClean = $Parsedown->text($contentDecoded);

        //replace image links

        return $contentClean;
    }

    /**
     * Update table repositories with readme information
     *
     * @return boolean
     */
    public function updateRepoReadme()
    {
        // update repo_readme
        $sql = 'UPDATE ' . $GLOBALS['xoopsDB']->prefix('wggithub_repositories') . ' INNER JOIN ' . $GLOBALS['xoopsDB']->prefix('wggithub_readmes');
        $sql .= ' ON ' . $GLOBALS['xoopsDB']->prefix('wggithub_repositories') . '.repo_id = ' . $GLOBALS['xoopsDB']->prefix('wggithub_readmes') . '.rm_repoid ';
        $sql .= 'SET ' . $GLOBALS['xoopsDB']->prefix('wggithub_repositories') . '.repo_readme = 1 ';
        $sql .= 'WHERE (((' . $GLOBALS['xoopsDB']->prefix('wggithub_readmes') . '.rm_id)>0));';
        $GLOBALS['xoopsDB']->queryF($sql);

        return true;
    }
}