reportgenerator.php

<?php
/*
 SPDX-FileCopyrightText: © 2023 Sushant Kumar <sushantmishra02102002@gmail.com>
 
 SPDX-License-Identifier: GPL-2.0-only
*/
 
namespace Fossology\CycloneDX;
 
use Fossology\Lib\Data\LicenseRef;
 
class BomReportGenerator
{
  public function createComponent(array $componentData): array
  {
    return $this->generateComponent($componentData);
  }
 
  public function createHash($algorithm, $content): array
  {
    return $this->generateHash($algorithm, $content);
  }
 
  public function createLicense(array $licenseData): array
  {
    return $this->generateLicense($licenseData);
  }
 
  public function generateReport($bomdata): array
  {
    $report = [
      'bomFormat' => 'CycloneDX',
      '$schema' => 'http://cyclonedx.org/schema/bom-1.7.schema.json',
      'specVersion' => '1.7',
      'version' => 1,
      'serialNumber' => 'urn:uuid:'. uuid_create(UUID_TYPE_TIME),
      'metadata' => [
        'timestamp' => date('c'),
        'tools' => [
          'components' => [
            [
              'type' => 'application',
              'vendor' => 'FOSSology',
              'name' => 'FOSSology',
              'version' => $bomdata['tool-version'],
              'bom-ref' => 'tool-fossology'
            ],
            [
              'type' => 'application',
              'vendor' => 'FOSSology',
              'name' => 'FOSSology Scanners',
              'version' => $bomdata['tool-version'],
              'bom-ref' => 'tool-fossology-scanners'
            ]
          ]
        ],
        'authors' => [
          [
            'name' => 'FOSSology Analyst',
            'bom-ref' => 'person-fossology-analyst'
          ]
        ],
        'component' => $bomdata['maincomponent']
      ],
      'components' => $bomdata['components']
    ];
 
    if (isset($bomdata['citations']) && !empty($bomdata['citations'])) {
      $report['citations'] = $bomdata['citations'];
    }
 
    if (!empty($bomdata['externalReferences'])) {
      $report['externalReferences'] = $bomdata['externalReferences'];
    }
 
    return $report;
  }
 
  private function generateComponent(array $componentData): array
  {
    $component = [
      'type' => $componentData['type'],
      'name' => $componentData['name']
    ];
 
    if (array_key_exists('version', $componentData) && !empty($componentData['version'])) {
      $component['version'] = $componentData['version'];
    }
 
    if (array_key_exists('mimeType', $componentData) && !empty($componentData['mimeType'])) {
      $component['mime-type'] = $componentData['mimeType'];
    }
 
    if (array_key_exists('bomref', $componentData) && !empty($componentData['bomref'])) {
      $component['bom-ref'] = $componentData['bomref'];
    }
 
    if (array_key_exists('scope', $componentData) && !empty($componentData['scope'])) {
      $component['scope'] = $componentData['scope'];
    } else {
      $component['scope'] = 'required';
    }
 
    if (array_key_exists('hashes', $componentData) && !empty($componentData['hashes'])) {
      $component['hashes'] = $componentData['hashes'];
    }
 
    if (array_key_exists('licenses', $componentData) && !empty($componentData['licenses'])) {
      $component['licenses'] = $componentData['licenses'];
    }
 
    if (array_key_exists('copyright', $componentData) && !empty($componentData['copyright'])) {
      $component['copyright'] = $componentData['copyright'];
    }
 
    if (array_key_exists('purl', $componentData) && !empty($componentData['purl'])) {
      $component['purl'] = $componentData['purl'];
    }
 
    if (array_key_exists('description', $componentData) && !empty($componentData['description'])) {
      $component['description'] = $componentData['description'];
    }
 
    if (array_key_exists('externalReferences', $componentData) && !empty($componentData['externalReferences'])) {
      $component['externalReferences'] = $componentData['externalReferences'];
    }
 
    $properties = [];
    if (array_key_exists('acknowledgements', $componentData) && !empty($componentData['acknowledgements'])) {
      $properties[] = [
        'name' => 'fossology:acknowledgement',
        'value' => $componentData['acknowledgements']
      ];
    }
    if (array_key_exists('comments', $componentData) && !empty($componentData['comments'])) {
      $properties[] = [
        'name' => 'fossology:comment',
        'value' => $componentData['comments']
      ];
    }
    if (!empty($properties)) {
      $component['properties'] = $properties;
    }
 
    return $component;
  }
 
  private function generateLicense(array $licenseData): array
  {
    $license = [];
 
    // Check license ID is a LicenseRef
    if (array_key_exists('id', $licenseData) && !empty($licenseData['id']) &&
      stripos($licenseData['id'], LicenseRef::SPDXREF_PREFIX) === 0) {
      if (array_key_exists('bom-ref', $licenseData) && !empty($licenseData['bom-ref'])) {
        $license['expressionDetailed'] = [
          'value' => $licenseData['id'],
          'bom-ref' => $licenseData['bom-ref']
        ];
        if (array_key_exists('acknowledgement', $licenseData) && !empty($licenseData['acknowledgement'])) {
          $license['expressionDetailed']['acknowledgement'] = $licenseData['acknowledgement'];
        }
      } else {
        $license['expression'] = $licenseData['id'];
      }
      return $license;
    }
 
    if (array_key_exists('id', $licenseData) && !empty($licenseData['id'])) {
      $license['license']['id'] = $licenseData['id'];
    } else if (array_key_exists('name', $licenseData) && !empty($licenseData['name'])) {
      $license['license']['name'] = $licenseData['name'];
    }
 
    if (array_key_exists('bom-ref', $licenseData) && !empty($licenseData['bom-ref'])) {
      $license['license']['bom-ref'] = $licenseData['bom-ref'];
    }
 
    if (array_key_exists('acknowledgement', $licenseData) && !empty($licenseData['acknowledgement'])) {
      $license['license']['acknowledgement'] = $licenseData['acknowledgement'];
    }
 
    if (array_key_exists('url', $licenseData) && !empty($licenseData['url'])) {
      $license['license']['url'] = $licenseData['url'];
    }
 
    if (array_key_exists('textContent', $licenseData) && !empty($licenseData['textContent'])) {
      $license['license']['text'] = [
        'content' => $licenseData['textContent'],
        'contentType' => $licenseData['textContentType'],
        'encoding' => 'base64'
      ];
    }
 
    return $license;
  }
 
  private function generateHash(string $algorithm, string $content): array
  {
    return [
      'alg' => $algorithm,
      'content' => $content
    ];
  }
}