ViewReview::mapPhpColors() - Code Metrics - mayflower/PHP_CodeBrowser - Measure and Improve Code Quality continuously with Scrutinizer

ViewReview::mapPhpColors() A
last analyzed 2024-03-19 22:32 UTC

↳ Parent: ViewReview
Complexity

Conditions	1
Paths	1
Size

Total Lines	5
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	1
eloc	2
c	1
b	0
f	0
nc	1
nop	1
dl	0
loc	5
rs	10
<?php

/**
 * View Review
 *
 * PHP Version 5.3.0
 *
 * Copyright (c) 2007-2010, Mayflower GmbH
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in
 *     the documentation and/or other materials provided with the
 *     distribution.
 *
 *   * Neither the name of Mayflower GmbH nor the names of his
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * @category PHP_CodeBrowser
 *
 * @author Elger Thiele <[email protected]>
 * @author Jan Mergler <[email protected]>
 * @author Simon Kohlmeyer <[email protected]>
 *
 * @copyright 2007-2010 Mayflower GmbH
 *
 * @license http://www.opensource.org/licenses/bsd-license.php  BSD License
 *
 * @version SVN: $Id$
 *
 * @link http://www.phpunit.de/
 *
 * @since File available since  0.1.0
 */

namespace PHPCodeBrowser\View;

use DOMDocument;
use DOMElement;
use DOMText;
use DOMXPath;
use PHPCodeBrowser\Helper\IOHelper;

/**
 * ViewReview
 *
 * This class is generating the highlighted and formatted html view for file.
 *
 * @category PHP_CodeBrowser
 *
 * @author Elger Thiele <[email protected]>
 * @author Jan Mergler <[email protected]>
 * @author Simon Kohlmeyer <[email protected]>
 *
 * @copyright 2007-2010 Mayflower GmbH
 *
 * @license http://www.opensource.org/licenses/bsd-license.php  BSD License
 *
 * @version Release: @package_version@
 *
 * @link http://www.phpunit.de/
 *
 * @since Class available since  0.1.0
 */
class ViewReview extends ViewAbstract
{
    /**
     * Highlight mapping.
     *
     * @var array
     */
    protected $phpHighlightColorMap;

    /**
     * Suffixes for php files.
     *
     * @var array
     */
    protected $phpSuffixes;

    /**
     * Default constructor
     *
     * Highlighting strings are set.
     *
     * @param string   $templateDir The directory containing the templates.
     * @param string   $outputDir   The directory where the reviews should be.
     * @param IOHelper $ioHelper    The IOHelper object to use for I/O.
     * @param array    $phpSuffixes The array with extensions of php files.
     */
    public function __construct(string $templateDir, string $outputDir, IOHelper $ioHelper, array $phpSuffixes = ['php'])
    {
        parent::__construct($templateDir, $outputDir, $ioHelper);

        $this->phpHighlightColorMap = [
            \ini_get('highlight.string')  => 'string',
            \ini_get('highlight.comment') => 'comment',
            \ini_get('highlight.keyword') => 'keyword',
            \ini_get('highlight.default') => 'default',
            \ini_get('highlight.html')    => 'html',
        ];

        $this->phpSuffixes = $phpSuffixes;
    }

    /**
     * Generating the Html code browser view for a given file.
     *
     * Issue list for each file will be marked in source code.
     * Source code is highlighted.
     * Generated Html source code is be saved as Html.
     *
     * @param array  $issueList        The issue list for given file
     * @param string $fileName
     * @param string $commonPathPrefix The prefix path all given files have
     *                                 in common
     * @param bool   $excludeOK
     *
     * @return void
     *
     * @see self::_formatIssues
     * @see self::_formatSourceCode
     * @see self::_generateJSCode
     */
    public function generate(array $issueList, string $fileName, string $commonPathPrefix, bool $excludeOK = false): void
    {
        $issues        = $this->formatIssues($issueList);
        $shortFilename = \substr($fileName, \strlen($commonPathPrefix));

        $data = [];

        $data['issues']   = $issueList;
        $data['filepath'] = $shortFilename;
        $data['source']   = $this->formatSourceCode($fileName, $issues);

        $depth           = \substr_count($shortFilename, DIRECTORY_SEPARATOR);
        $data['csspath'] = \str_repeat('../', \max($depth - 1, 0));

        //we want to exclude files without issues and there are no issues in this one
        if ($excludeOK && !$data['issues']) {
            return;
        }

        $this->ioHelper->createFile(
            $this->outputDir.$shortFilename.'.html',
            $this->render('review', $data)
        );
    }

    /**
     * Highlighter method for PHP source code
     *
     * The source code is highlighted by PHP native method.
     * Afterwords a DOMDocument will be generated with each
     * line in a separate node.
     *
     * @param string $sourceCode The PHP source code
     *
     * @return DOMDocument
     */
    protected function highlightPhpCode(string $sourceCode): DOMDocument
    {
        $code = \highlight_string($sourceCode, true);

        if (\extension_loaded('mbstring') && !\mb_check_encoding($code, 'UTF-8')) {
        if (\extension_loaded('mbstring') && !\mb_check_encoding(/** @scrutinizer ignore-type */ $code, 'UTF-8')) {
            $detectOrder   = (array) \mb_detect_order();
            $detectOrder[] = 'iso-8859-1';

            $encoding = \mb_detect_encoding($code, $detectOrder, true);
            $encoding = \mb_detect_encoding(/** @scrutinizer ignore-type */ $code, $detectOrder, true);

            if (false === $encoding) {
                \error_log('Error detecting file encoding');
            }

            $code = \mb_convert_encoding(
                $code,
                /** @scrutinizer ignore-type */ $code,
                'UTF-8',
                $encoding
            );
        }

        $sourceDom = new DOMDocument();
        $sourceDom->loadHTML('<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>'.$code);
        $sourceDom->loadHTML('<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>'./** @scrutinizer ignore-type */ $code);

        //fetch <code>-><span>->children from php generated html
        $sourceElements = $sourceDom->getElementsByTagName('code')->item(0)
            ->childNodes->item(0)->childNodes;

        //create target dom
        $targetDom  = new DOMDocument();
        $targetNode = $targetDom->createElement('ol');
        $targetNode->setAttribute('class', 'code');
        $targetDom->appendChild($targetNode);

        $liElement = $targetDom->createElement('li');
        $targetNode->appendChild($liElement);

        // iterate through all <span> elements
        foreach ($sourceElements as $sourceElement) {
            if ($sourceElement instanceof DOMText) {
                $span            = $targetDom->createElement('span');
                $span->nodeValue = \htmlspecialchars($sourceElement->wholeText, ENT_COMPAT);
                $liElement->appendChild($span);
            }

            if (!$sourceElement instanceof DOMElement) {
                continue;
            }

            if ('br' === $sourceElement->tagName) {
                // create new li and new line
                $liElement = $targetDom->createElement('li');
                $targetNode->appendChild($liElement);

                continue;
            }

            $elementClass = $this->mapPhpColors(
                $sourceElement->getAttribute('style')
            );

            foreach ($sourceElement->childNodes as $sourceChildElement) {
                if ($sourceChildElement instanceof DOMElement
                    && 'br' === $sourceChildElement->tagName
                ) {
                    // create new li and new line
                    $liElement = $targetDom->createElement('li');
                    $targetNode->appendChild($liElement);
                } else {
                    // append content to current li element
                    $span            = $targetDom->createElement('span');
                    $span->nodeValue = \htmlspecialchars($sourceChildElement->textContent, ENT_COMPAT);
                    $span->setAttribute('class', $elementClass);
                    $liElement->appendChild($span);
                }
            }
        }

        return $targetDom;
    }

    /**
     * Return colors defined in ini files.
     *
     * @param string $style The given style name, e.g. "comment"
     *
     * @return string
     */
    protected function mapPhpColors(string $style): string
    {
        $color = \substr($style, 7);

        return $this->phpHighlightColorMap[$color];
    }

    /**
     * Highlighting source code of given file.
     *
     * Php code is using native php highlighter.
     * If PEAR Text_Highlighter is installed all defined files in $highlightMap
     * will be highlighted as well.
     *
     * @param string $file The filename / real path to file
     *
     * @return DOMDocument Html representation of parsed source code
     */
    protected function highlightCode(string $file): DOMDocument
    {
        $sourceCode = $this->ioHelper->loadFile($file);
        $extension  = \pathinfo($file, PATHINFO_EXTENSION);

        if (\in_array($extension, $this->phpSuffixes, true)) {
            return $this->highlightPhpCode($sourceCode);
        }

        $sourceCode = \preg_replace(['/^.*$/m', '/ /'], ['<li>$0</li>', '&nbsp;'], \htmlentities($sourceCode, ENT_COMPAT));
        $sourceCode = '<div class="code"><ol class="code">'.$sourceCode.'</ol></div>';
        $sourceCode = $this->stripInvalidXml($sourceCode);

        $doc = new DOMDocument();
        $doc->loadHTML($sourceCode);

        return $doc;
    }

    /**
     * Source code is highlighted an formatted.
     *
     * Besides highlighting, whole lines will be marked with different colors
     * and JQuery functions (like tooltips) are integrated.
     *
     * @param string $filename     The file to format
     * @param array  $outputIssues Sorted issueList by line number
     *
     * @return string Html formatted string
     */
    private function formatSourceCode(string $filename, array $outputIssues): string
    {
        $sourceDom = $this->highlightCode($filename);
        $xpath     = new DOMXPath($sourceDom);
        $lines     = $xpath->query('//ol/li');

        // A shortcut to prevent possible trouble with log(0)
        // Note that this is exactly what will happen anyways.
        if ($lines->length === 0) {
            return $sourceDom->saveHTML();
        }

        $lineNumber = 0;
        $linePlaces = \floor(\log($lines->length, 10)) + 1;

        foreach ($lines as $line) {
            /**
             * @var DOMElement $line
             */
            $line = $line;
            ++$lineNumber;
            $line->setAttribute('id', 'line_'.$lineNumber);

            $lineClasses = [
                ($lineNumber % 2 === 0) ? 'odd' : 'even',
            ];

            if (isset($outputIssues[$lineNumber])) {
                $lineClasses[] = 'hasIssues';
                $message       = '|';

                foreach ($outputIssues[$lineNumber] as $issue) {
                    $message .= \sprintf(
                        '
                        <div class="tooltip">
                            <div class="title %s">%s</div>
                            <div class="text">%s</div>
                        </div>
                        ',
                        $issue->getFoundBy(),
                        $issue->getFoundBy(),
                        $issue->getDescription()
                    );
                }

                $line->setAttribute('title', $message);
            }

            // Add line number
            $nuSpan = $sourceDom->createElement('span');
            $nuSpan->setAttribute('class', 'lineNumber');

            for ($i = 0; $i < $linePlaces - \strlen((string) $lineNumber); ++$i) {
                $nuSpan->appendChild($sourceDom->createEntityReference('nbsp'));
            }

            $nuSpan->appendChild($sourceDom->createTextNode((string) $lineNumber));
            $nuSpan->appendChild($sourceDom->createEntityReference('nbsp'));
            $line->insertBefore($nuSpan, $line->firstChild);

            //create anchor for the new line
            $anchor = $sourceDom->createElement('a');
            $anchor->setAttribute('name', 'line_'.$lineNumber);
            $line->appendChild($anchor);

            $lineErrorCount = (isset($outputIssues[$lineNumber])
                               ? \count($outputIssues[$lineNumber])
                               : 0);

            // set li css class depending on line errors
            switch ($lineErrorCount) {
                case 0:
                    break;
                case 1:
                    $lineClasses[] = $outputIssues[$lineNumber][0]->getFoundBy();

                    break;
                case 1 < $lineErrorCount:
                    $lineClasses[] = 'moreErrors';

                    break;

                // This can't happen, count always returns >= 0
                // @codeCoverageIgnoreStart
                default:
                    break;

                // @codeCoverageIgnoreEnd
            }

            $line->setAttribute('class', \implode(' ', $lineClasses));
        }

        return $sourceDom->saveHTML();
    }

    /**
     * Sorting a list of issues combining issues matching same line number
     * for each file.
     *
     * @param array $issueList List of issues
     *
     * @return array
     */
    private function formatIssues(array $issueList): array
    {
        $outputIssues = [];

        foreach ($issueList as $issue) {
            for ($i = $issue->getLineStart(); $i <= $issue->getLineEnd(); ++$i) {
                $outputIssues[$i][] = $issue;
            }
        }

        return $outputIssues;
    }

    /**
     * Removes invalid XML
     *
     * @access private
     *
     * @param string $value
     *
     * @return string
     */
    private function stripInvalidXml(string $value): string
    {
        $ret = '';

        if (empty($value)) {
            return $ret;
        }

        $length = \strlen($value);

        for ($i = 0; $i < $length; ++$i) {
            $current = \ord($value[$i]);

            if ((0x9 === $current)
                || (0xA === $current)
                || (0xD === $current)
                || (($current >= 0x20) && ($current <= 0xD7FF))
                || (($current >= 0xE000) && ($current <= 0xFFFD))
                || (($current >= 0x10000) && ($current <= 0x10FFFF))
            ) {
                $ret .= \chr($current);
            } else {
                $ret .= ' ';
            }
        }

        return $ret;
    }
}

mayflower / PHP_CodeBrowser

ViewReview::mapPhpColors() A last analyzed 2024-03-19 22:32 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ViewReview::mapPhpColors() A
last analyzed 2024-03-19 22:32 UTC
