XmlLintTask::errorHandler() - Code Metrics - Inspection of "Scrutinizer issue fixes (#1576)" - phingofficial/phing - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — main ( cb6a7c...966a82 )

by Siad
created 2021-04-05 17:23 UTC
XmlLintTask::errorHandler() A

↳ Parent: XmlLintTask
Complexity

Conditions	1
Paths	1
Size

Total Lines	5
Code Lines	3
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	2
Importance

Changes
Metric	Value
eloc	3
c	0
b	0
f	0
dl	0
loc	5
rs	10
ccs	0
cts	4
cp	0
cc	1
nc	1
nop	5
crap	2
<?php

/**
 * 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.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the LGPL. For more information please see
 * <http://phing.info>.
 */

namespace Phing\Task\System;

use DOMDocument;
use Phing\Exception\BuildException;
use Phing\Io\File;
use Phing\Project;
use Phing\Task;
use Phing\Type\Element\FileSetAware;

/**
 * A XML lint task. Checking syntax of one or more XML files against an XML Schema using the DOM extension.
 *
 * @author  Knut Urdalen <[email protected]>
 */
class XmlLintTask extends Task
{
    use FileSetAware;

    protected $file; // the source file (from xml attribute)
    protected $schema; // the schema file (from xml attribute)
    protected $useRNG = false;

    protected $haltonfailure = true;

    /**
     * File to be performed syntax check on.
     */
    public function setFile(File $file): void
    {
        $this->file = $file;
    }

    /**
     * XML Schema Description file to validate against.
     * @param File $schema
     */
    public function setSchema(File $schema): void
    {
        $this->schema = $schema;
    }

    /**
     * Use RNG instead of DTD schema validation.
     *
     * @param bool $bool
     */
    public function setUseRNG(bool $bool): void
    {
        $this->useRNG = $bool;
    }

    /**
     * Sets the haltonfailure attribute.
     * @param bool $haltonfailure
     */
    public function setHaltonfailure(bool $haltonfailure): void
    {
        $this->haltonfailure = $haltonfailure;
    }

    /**
     * Execute lint check against PhingFile or a FileSet.
     *
     * {@inheritdoc}
     *
     * @throws BuildException
     */
    public function main()
    {
        libxml_use_internal_errors(true);
        if (isset($this->schema) && !file_exists($this->schema->getPath())) {
            throw new BuildException('Schema file not found: ' . $this->schema->getPath());
        }
        if (!isset($this->file) && 0 === count($this->filesets)) {
            throw new BuildException("Missing either a nested fileset or attribute 'file' set");
        }

        set_error_handler([$this, 'errorHandler']);
        if ($this->file instanceof File) {
            $this->lint($this->file->getPath());
        } else { // process filesets
            $project = $this->getProject();
            foreach ($this->filesets as $fs) {
                $ds = $fs->getDirectoryScanner($project);
                $files = $ds->getIncludedFiles();
                $dir = $fs->getDir($this->project)->getPath();
                foreach ($files as $file) {
                    $this->lint($dir . DIRECTORY_SEPARATOR . $file);
                }
            }
        }
        restore_error_handler();
    }

    /**
     * Local error handler to catch validation errors and log them through Phing.
     *
     * @param int    $level
     * @param string $message
     * @param string $file
     * @param int    $line
     * @param mixed  $context
     */
    public function errorHandler($level, $message, $file, $line, $context): void
    public function errorHandler($level, $message, /** @scrutinizer ignore-unused */ $file, $line, $context): void
    {
        $matches = [];
        preg_match('/^.*\(\): (.*)$/', $message, $matches);
        $this->log($matches[1], Project::MSG_ERR);
    }

    /**
     * @param $message
     *
     * @throws BuildException
     */
    protected function logError($message): void
    {
        if ($this->haltonfailure) {
            throw new BuildException($message);
        }

        $this->log($message, Project::MSG_ERR);
    }

    /**
     * Performs validation.
     *
     * @param string $file
     */
    protected function lint($file): void
    {
        if (file_exists($file)) {
            if (is_readable($file)) {
                $dom = new DOMDocument();
                if (false === $dom->load($file)) {
                    $this->libxmlGetErrors();
                    $this->logError($file . ' is not well-formed (See messages above)');
                } else {
                    if (isset($this->schema)) {
                        if ($this->useRNG) {
                            if ($dom->relaxNGValidate($this->schema->getPath())) {
                                $this->log($file . ' validated with RNG grammar');
                            } else {
                                $this->libxmlGetErrors();
                                $this->logError($file . ' fails to validate (See messages above)');
                            }
                        } else {
                            if ($dom->schemaValidate($this->schema->getPath())) {
                                $this->log($file . ' validated with schema');
                            } else {
                                $this->libxmlGetErrors();
                                $this->logError($file . ' fails to validate (See messages above)');
                            }
                        }
                    } else {
                        $this->log(
                            $file . ' is well-formed (not validated due to missing schema specification)'
                        );
                    }
                }
            } else {
                $this->logError('Permission denied to read file: ' . $file);
            }
        } else {
            $this->logError('File not found: ' . $file);
        }
    }

    private function libxmlGetErrors(): void
    {
        $errors = libxml_get_errors();
        foreach ($errors as $error) {
            [$severity, $message] = $this->libxmlGetError($error);
            $this->log($message, $severity === 'error' ? Project::MSG_ERR : Project::MSG_WARN);
        }
        libxml_clear_errors();
    }

    private function libxmlGetError($error): array
    {
        $return = '';
        $severity = '';
        switch ($error->level) {
            case LIBXML_ERR_WARNING:
                $return .= "Warning $error->code: ";
                $severity = 'warn';
                break;
            case LIBXML_ERR_ERROR:
                $return .= "Error $error->code: ";
                $severity = 'error';
                break;
            case LIBXML_ERR_FATAL:
                $return .= "Fatal Error $error->code: ";
                $severity = 'error';
                break;
        }
        $return .= trim($error->message);
        if ($error->file) {
            $return .=    " in $error->file";
        }
        $return .= " on line $error->line";

        return [$severity, $return];
    }
}

phingofficial / phing

Push — main ( cb6a7c...966a82 )

XmlLintTask::errorHandler() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
