find_file() - Code Metrics - Inspection of "touch composer vendor licensing report script" - ktomk/pipelines - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — test ( 2b0c61...4b22aa )

by Tom
created 2024-10-10 06:56 UTC
find_file() A

↳ Parent: Project
Complexity

Conditions	4
Paths	4
Size

Total Lines	16
Code Lines	7
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
eloc	7
nc	4
nop	2
dl	0
loc	16
c	1
b	0
f	0
cc	4
rs	10
#!/usr/bin/env php
<?php

/*
 * this file is part of pipelines
 *
 * vendor-licensing - composer packages license information markdown report
 *
 * usage: script/vendor-licensing.php [--dev] [--] [<composer-dir>]
 *
 *   --dev            include require-dev packages
 *   <composer-dir>  path to directory with the composer.json to use
 *
 * obtain license information from composer packages
 * and turn them into a markdown report for the
 * pipelines HTML documentation
 *
 * markdown is written to stdout by default
 */

function _start()
{
    // --dev : include require-dev packages
    $config['dev'] = false;

    // <composer-dir> : directory having the composer.json
    $config['composer_dir'] = '';
    $config['composer_filename'] = 'composer.json';

    $argv = $_SERVER['argv'];

    if (isset($argv[1]) && '--dev' === $argv[1]) {
        $config['dev'] = true;
        array_splice($argv, 1, 1);
    }

    if (isset($argv[1]) && '--' === $argv[1]) {
        array_splice($argv, 1, 1);
    }

    if (isset($argv[1])) {
        $buffer = realpath(trim($argv[1]));
        is_string($buffer) && is_dir($buffer)
        or trigger_error(sprintf('not a directory: %s', trim($argv[1])), E_USER_ERROR);
        $config['composer_dir'] = $buffer;
        unset($buffer);
        array_splice($argv, 1, 1);
    }

    isset($argv[1])
    and trigger_error(sprintf("unknown option, argument or parameter: '%s'", $argv[1]), E_USER_ERROR);

    $srcDir = realpath($config['composer_dir']);
    is_string($srcDir) && is_dir($srcDir)
    or trigger_error(sprintf('composer-dir not a directory: %s', $config['composer_dir']), E_USER_ERROR);

    $composerFilePath = $srcDir . '/' . $config['composer_filename'];
    $project = json_decode((string)@file_get_contents($composerFilePath), true);
    is_array($project)
    or trigger_error(sprintf("not a composer.json: '%s'", $composerFilePath), E_USER_ERROR);

    $project += array('require' => array(), 'require-dev' => array());

    $require = $project['require'];
    $config['dev'] && $require += $project['require-dev'];
    $pkgs = packages($require, dirname($composerFilePath) . '/vendor');

    tpl_render_pkgs($pkgs);

    // done
    return 0;
}

register_shutdown_function(function ($_start) {

    $start = $_SERVER['REQUEST_TIME'];
    if (!is_float($start)) {
        $start = isset($_SERVER['REQUEST_TIME_FLOAT']) && is_float($_SERVER['REQUEST_TIME_FLOAT'])

            ? $_SERVER['REQUEST_TIME_FLOAT']
            : $_start;
    }
    $_SERVER['REQUEST_TIME'] = (int)$_SERVER['REQUEST_TIME_FLOAT'] = $_start;

    $argv = $_SERVER['argv'];
    if (!is_array($argv)) {
        $argv = array();
    }
    $argv = array_filter($argv, 'is_string');
    $_SERVER['argv'] = $argv;

    set_error_handler(function ($type, $message, $file, $line) {
        if ($type === E_USER_ERROR) {
            throw new ErrorException($message, 0, $type, $file, $line);
        }
        return false;
    });

    $error = null;
    try {
        $result = _start();
    } catch (Exception $error) {
        vfprintf(STDERR, "fatal: %s\n", array_slice(explode("\n", $error->getMessage()), 0, 1));
    }

    $time = microtime(true) - $_start;
    $php = vsprintf('%d.%d.%d', sscanf(PHP_VERSION, '%d.%d.%d'));
    $php = vsprintf('%d.%d.%d', /** @scrutinizer ignore-type */ sscanf(PHP_VERSION, '%d.%d.%d'));
    fprintf(STDERR, "%s: took %.5fs (php %s)\n", $argv[0], $time, $php);

    if (false === empty($result)) {
        exit(2);

    }
    exit($error ? 1 : 0);

}, microtime(true));

/**
 * render packages as markdown
 *
 * @param array $pkgs
 */
function tpl_render_pkgs(array $pkgs)
{
    foreach ($pkgs as $pkg) {
        list($pkg, $lic, $lic_file) = array_values($pkg);
?>
### <?= tpl_func_name_nice($pkg) ?> (<?= tpl_func_spdx_full($lic) ?>)

From the package https://packagist.org/packages/<?= $pkg ?>


```
<?= strtr(rtrim(file_get_contents($lic_file)), '`', '#'), "\n"; ?>
```

#### SPDX

* Full Name: `<?= tpl_func_spdx_full($lic) ?>`
* Short Identifier: `<?= $lic ?>`
* Reference: <?= tpl_func_spdx_url($lic) ?>


<?php
    }
}

/**
 * SPDX license URL of short identifier
 *
 * @param string $lic short identifier
 *
 * @return string license URL
 */
function tpl_func_spdx_url($lic)
{
    return sprintf('https://spdx.org/licenses/%s.html', $lic);
}

/**
 * SPDX full name of short identifier
 *
 * @param string $lic short identifier
 *
 * @return string full license name
 */
function tpl_func_spdx_full($lic)
{
    $fuller = array(
        'MIT' => 'MIT License',
        'BSD-3-Clause' => 'BSD 3-Clause "New" or "Revised" License',
    );
    if (!isset($fuller[$lic])) {
        throw new RuntimeException(sprintf('Unable to resolve SPDX full license for "%s"', $lic));
    }
    return $fuller[$lic];
}

function tpl_func_name_nice($name)
{
    list($ven, $lib) = explode('/', $name, 2) + array(1 => null);
    return sprintf('%s', ucwords($lib, " \t\r\n\f\v-"));
}

/**
 * parse composer requires packages for licensing
 *
 * @param array $require
 * @param string $vendorFolder
 *
 * @return array packages information regarding licensing
 */
function packages(array $require, $vendorFolder)
{
    $packages = array();

    foreach ($require as $pkg => $ver) {
        $dir = $vendorFolder . '/' . $pkg;
        if (!is_dir($dir)) { // filter non-project packages, e.g. php and extensions
            continue;
        }
        $composer = find_file_down($dir, 'composer.json');
        if (null === $composer) {
            throw new UnexpectedValueException(sprintf('Unable to find composer.json in %s', $pkg));
        }
        $package = json_decode(file_get_contents($composer), true);
        $packages[$pkg] = array(
            'pkg' => $pkg,
            'lic' => $package['license'],
            'lic_file' => find_license_file(dirname($composer)),
        );
    }

    return $packages;
}

/**
 * find a file within a folder and all its subfolders
 *
 * @param string $folder
 * @param string $file
 *
 * @return string|null file found or null in case not found
 */
function find_file_down($folder, $file)
{
    $folders = array($folder);
    while ($folder = array_pop($folders)) {
        if (is_file($folder . '/' . $file)) {
            return $folder . '/' . $file;
        }
        foreach (array_diff((array)@scandir($folder), array('..', '.')) as $name) {
            if (is_dir($folder . '/' . $name)) {
                $folders[] = $folder . '/' . $name;
            }
        }
    }

    return null;
}

/**
 * @param string $folder
 * @param string|string[] ...$file
 *
 * @return null|string
 */
function find_file($folder, $file)
{
    $files = flatten(array_slice(func_get_args(), 1));
    if (empty($files)) {

        return null;
    }

    foreach ($files as $file) {

        if (is_file($folder . '/' . $file)) {

            return $folder . '/' . $file;
        }
    }

    return null;
}

/**
 * @param array $args
 *
 * @return array
 */
function flatten(array $args)
{
    $flattened = array();

    foreach ($args as $arg) {
        $values = is_array($arg) ? flatten($arg) : array($arg);
        foreach ($values as $value) {
            $flattened[] = $value;
        }
    }

    return $flattened;
}

/**
 * find license file in a folder
 *
 * @param string $folder
 *
 * @return string path to license file
 */
function find_license_file($folder, array $files = array('COPYING', 'LICENSE'))
{
    $license = find_file($folder, $files);
    if (null !== $license) {

        return $license;
    }

    throw new RuntimeException(sprintf('Unable to find license file in "%s"', $folder));
}

ktomk / pipelines

Push — test ( 2b0c61...4b22aa )

find_file() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
