HeadlineRenderer::setErrors() - Code Metrics - Inspection of "changelog" - mambax7/xoopsheadline - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 7b6eed...a3cd89 )

by Michael
created 2021-11-26 22:05 UTC
HeadlineRenderer::setErrors() A

↳ Parent: HeadlineRenderer
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	1
dl	0
loc	3
rs	10
c	0
b	0
f	0
<?php

declare(strict_types=1);

namespace XoopsModules\Xoopsheadline;

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

//use think\console\command\Help;

/**
 * @copyright    XOOPS Project (https://xoops.org)
 * @license      GNU GPL 2 or later (https://www.gnu.org/licenses/gpl-2.0.html)
 * @author      XOOPS Development Team, Kazumi Ono (AKA onokazu)
 */


require_once XOOPS_ROOT_PATH . '/class/template.php';

$helper = Helper::getInstance();
$helper->loadLanguage('main');

/**
 * Class HeadlineRenderer
 */
class HeadlineRenderer
{
    // holds reference to Headline class object
    protected $headline;
    protected $tpl;
    protected $feed;
    protected $block;
    protected $errors = [];
    // RSS2 SAX parser
    protected $parser;

    /**
     * HeadlineRenderer constructor.
     */
    public function __construct(Headline $headline)
    {
        $this->headline  = $headline;
        $this->tpl = new \XoopsTpl();
    }

    /**
     * @return int|bool
     */
    public function updateCache()
    {
        $helper = Helper::getInstance();
        /**
         * Update cache - first try using fopen and then cURL
         */
        $retval = false;
        if ($fp = @\fopen($this->headline->getVar('headline_rssurl'), 'r')) {  // successfully openned file using fopen
            $data = '';
            while (!\feof($fp)) {
                $data .= \fgets($fp, 4096);
            }
            \fclose($fp);
            $this->headline->setVar('headline_xml', $this->convertToUtf8($data));
            $this->headline->setVar('headline_updated', \time());
            $headlineHandler = $helper->getHandler('Headline');
            if (null !== $headlineHandler) {
                $retval = $headlineHandler->insert($this->headline);
            }
        } else {
            // failed open using fopen, now try cURL
            $ch = \curl_init($this->headline->getVar('headline_rssurl'));
            if (\curl_setopt($ch, \CURLOPT_RETURNTRANSFER, true)) {
                if ($data = \curl_exec($ch)) {
                    \curl_close($ch);
                    $this->headline->setVar('headline_xml', $this->convertToUtf8($data));
                    $this->headline->setVar('headline_xml', $this->convertToUtf8(/** @scrutinizer ignore-type */ $data));
                    $this->headline->setVar('headline_updated', \time());
                    $headlineHandler = $helper->getHandler('Headline');
                    if (null !== $headlineHandler) {
                        $retval = $headlineHandler->insert($this->headline);
                    }
                } else {
                    \curl_close($ch);
                    $errmsg = \sprintf(\_MD_XOOPSHEADLINE_NOTOPEN, $this->headline->getVar('headline_rssurl'));
                    $errmsg = \sprintf(\_MD_XOOPSHEADLINE_NOTOPEN, /** @scrutinizer ignore-type */ $this->headline->getVar('headline_rssurl'));
                    $this->setErrors($errmsg);
                }
            } else {
                $this->setErrors(\_MD_XOOPSHEADLINE_BADOPT);
            }
        }

        return $retval;
    }

    public function renderFeed(bool $force_update = false): bool
    {
        $retval = false;
        if ($force_update || $this->headline->cacheExpired()) {
            if (!$this->updateCache()) {
                return $retval;
            }
        }
        if ($this->_parse()) {
            $this->tpl->clear_all_assign();
            $this->tpl->assign('xoops_url', XOOPS_URL);
            $channel_data = $this->parser->getChannelData();
            \array_walk($channel_data, [$this, 'convertFromUtf8']);
            $this->tpl->assign_by_ref('channel', $channel_data);
            if (1 == $this->headline->getVar('headline_mainimg')) {
                $image_data = $this->parser->getImageData();
                \array_walk($image_data, [$this, 'convertFromUtf8']);
                $max_width  = 256;
                $max_height = 92;
                if (!isset($image_data['height']) || !isset($image_data['width'])) {
                    $image_size = @\getimagesize($image_data['url']);
                    if ($image_size) {
                        $image_data['width']  = $image_size[0];
                        $image_data['height'] = $image_size[1];
                    }
                }
                if (\array_key_exists('height', $image_data) && \array_key_exists('width', $image_data)
                    && ($image_data['width'] > 0)) {
                    $width_ratio  = $image_data['width'] / $max_width;
                    $height_ratio = $image_data['height'] / $max_height;
                    $scale        = \max($width_ratio, $height_ratio);
                    if ($scale > 1) {
                        $image_data['width']  = (int)($image_data['width'] / $scale);
                        $image_data['height'] = (int)($image_data['height'] / $scale);
                    }
                }
                $this->tpl->assign_by_ref('image', $image_data);
            }
            if (1 == $this->headline->getVar('headline_mainfull')) {
                $this->tpl->assign('show_full', true);
            } else {
                $this->tpl->assign('show_full', false);
            }
            $items = $this->parser->getItems();
            $count = \count($items);
            $max   = ($count > $this->headline->getVar('headline_mainmax')) ? $this->headline->getVar('headline_mainmax') : $count;
            for ($i = 0; $i < $max; ++$i) {
                \array_walk($items[$i], [$this, 'convertFromUtf8']);
                $this->tpl->append_by_ref('items', $items[$i]);
            }
            $this->tpl->assign(
                [
                    'lang_lastbuild'   => \_MD_XOOPSHEADLINE_LASTBUILD,
                    'lang_language'    => \_MD_XOOPSHEADLINE_LANGUAGE,
                    'lang_description' => \_MD_XOOPSHEADLINE_DESCRIPTION,
                    'lang_webmaster'   => \_MD_XOOPSHEADLINE_WEBMASTER,
                    'lang_category'    => \_MD_XOOPSHEADLINE_CATEGORY,
                    'lang_generator'   => \_MD_XOOPSHEADLINE_GENERATOR,
                    'lang_title'       => \_MD_XOOPSHEADLINE_TITLE,
                    'lang_pubdate'     => \_MD_XOOPSHEADLINE_PUBDATE,
                    //                                   'lang_description2' => _MD_XOOPSHEADLINE_DESCRIPTION2,
                    'lang_more'        => _MORE,
                ]
            );
            $this->feed = $this->tpl->fetch('db:xoopsheadline_feed.tpl');
            $retval     = true;
        }

        return $retval;
    }

    public function renderBlock(bool $force_update = false): bool
    {
        $retval = false;
        if ($force_update || $this->headline->cacheExpired()) {
            if (!$this->updateCache()) {
                return $retval;
            }
        }
        if ($this->_parse()) {
            $this->tpl->clear_all_assign();
            $this->tpl->assign('xoops_url', XOOPS_URL);
            $channel_data = $this->parser->getChannelData();
            \array_walk($channel_data, [$this, 'convertFromUtf8']);
            $this->tpl->assign_by_ref('channel', $channel_data);
            if (1 == $this->headline->getVar('headline_blockimg')) {
                $image_data = $this->parser->getImageData();
                \array_walk($image_data, [$this, 'convertFromUtf8']);
                $this->tpl->assign_by_ref('image', $image_data);
            }
            $items = $this->parser->getItems();
            $count = \count($items);
            $max   = ($count > $this->headline->getVar('headline_blockmax')) ? $this->headline->getVar('headline_blockmax') : $count;
            for ($i = 0; $i < $max; ++$i) {
                \array_walk($items[$i], [$this, 'convertFromUtf8']);
                $this->tpl->append_by_ref('items', $items[$i]);
            }
            $this->tpl->assign(
                [
                    'site_name' => $this->headline->getVar('headline_name'),
                    'site_url'  => $this->headline->getVar('headline_url'),
                    'site_id'   => $this->headline->getVar('headline_id'),
                ]
            );

            $this->block = $this->tpl->fetch('db:blocks/headline_block.tpl');
            $retval      = true;
        }

        return $retval;
    }

    protected function &_parse(): bool
    {
        $retval = true;
        if (!isset($this->parser)) {
            require_once XOOPS_ROOT_PATH . '/class/xml/rss/xmlrss2parser.php';
            $temp         = $this->headline->getVar('headline_xml');
            $this->parser = new \XoopsXmlRss2Parser($temp);
            switch ($this->headline->getVar('headline_encoding')) {
                case 'utf-8':
                    $this->parser->useUtfEncoding();
                    break;
                case 'us-ascii':
                    $this->parser->useAsciiEncoding();
                    break;
                default:
                    $this->parser->useIsoEncoding();
                    break;
            }
            $result = $this->parser->parse();
            if (!$result) {
                $this->setErrors($this->parser->getErrors(false));
                $this->setErrors(/** @scrutinizer ignore-type */ $this->parser->getErrors(false));
                unset($this->parser);
                $retval = false;
            }
        }

        return $retval;
    }

    /**
     * @return mixed
     */
    public function &getFeed()
    {
        return $this->feed;
    }

    /**
     * @return mixed
     */
    public function &getBlock()
    {
        return $this->block;
    }


    protected function setErrors(string $err): void
    {
        $this->errors[] = $err;
    }

    /**
     * @return array|string
     */
    public function &getErrors(bool $ashtml = true)
    {
        if ($ashtml) {
            $retval = '';
            if (\count($this->errors) > 0) {
                foreach ($this->errors as $error) {
                    $retval .= $error . '<br>';
                }
            }
        } else {
            $retval = $this->errors;
        }

        return $retval;
    }

    // abstract
    // overide this method in /language/your_language/headlinerenderer.php
    // this method is called by the array_walk function
    // return void

    /**
     * @param $value
     * @param $key
     */
    public function convertFromUtf8(&$value, $key): void
    public function convertFromUtf8(&$value, /** @scrutinizer ignore-unused */ $key): void
    {
    }

    // abstract
    // overide this method in /language/your_language/headlinerenderer.php
    // return string

    public function &convertToUtf8(string &$xmlfile): string
    {
        if ('iso-8859-1' === \mb_strtolower($this->headline->getVar('headline_encoding'))) {
            $xmlfile = utf8_encode($xmlfile);
        }

        return $xmlfile;
    }
}

mambax7 / xoopsheadline

Push — master ( 7b6eed...a3cd89 )

HeadlineRenderer::setErrors() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
