LicenseCsvExport.php

Go to the documentation of this file.

<?php
/*
 SPDX-FileCopyrightText: © 2015, 2021 Siemens AG
 
 SPDX-License-Identifier: GPL-2.0-only
*/
 
 
namespace Fossology\Lib\Application;
 
use Fossology\Lib\BusinessRules\LicenseMap;
use Fossology\Lib\Data\LicenseRef;
use Fossology\Lib\Db\DbManager;
 
class LicenseCsvExport
{
  protected $dbManager;
  protected $delimiter = ',';
  protected $enclosure = '"';
 
  public function __construct(DbManager $dbManager)
  {
    $this->dbManager = $dbManager;
  }
 
  public function setDelimiter($delimiter=',')
  {
    $this->delimiter = substr($delimiter,0,1);
  }
 
  public function setEnclosure($enclosure='"')
  {
    $this->enclosure = substr($enclosure,0,1);
  }
 
  public function createCsv($rf=0, $allCandidates=false, $generateJson=false)
  {
    $forAllCandidates = "WHERE marydone = true";
    if ($allCandidates) {
      $forAllCandidates = "";
    }
    $forGroupBy = " GROUP BY rf.rf_shortname, rf.rf_fullname, rf.rf_licensetype, rf.rf_spdx_id, rf.rf_text, rc.rf_shortname, rr.rf_shortname, rf.rf_url, rf.rf_notes, rf.rf_source, rf.rf_risk, gp.group_name";
    $sql = "WITH marydoneCand AS (
  SELECT * FROM license_candidate
  $forAllCandidates
), allLicenses AS (
SELECT DISTINCT ON(rf_pk) * FROM
  ONLY license_ref
  NATURAL FULL JOIN marydoneCand)
SELECT
  rf.rf_shortname AS shortname, rf.rf_fullname AS fullname, rf.rf_spdx_id AS spdx_id, rf.rf_licensetype as license_type, rf.rf_text AS text,
  rc.rf_shortname parent_shortname, rr.rf_shortname report_shortname, rf.rf_url AS url,
  rf.rf_notes AS notes, rf.rf_source AS source, rf.rf_risk AS risk, gp.group_name AS group,
  string_agg(ob_topic, ', ') obligations
FROM allLicenses AS rf
  LEFT OUTER JOIN obligation_map om ON om.rf_fk = rf.rf_pk
  LEFT OUTER JOIN obligation_ref ON ob_fk = ob_pk
  FULL JOIN groups AS gp ON gp.group_pk = rf.group_fk
  LEFT JOIN license_map mc ON mc.rf_fk=rf.rf_pk AND mc.usage=$2
  LEFT JOIN license_ref rc ON mc.rf_parent=rc.rf_pk
  LEFT JOIN license_map mr ON mr.rf_fk=rf.rf_pk AND mr.usage=$3
  LEFT JOIN license_ref rr ON mr.rf_parent=rr.rf_pk
WHERE rf.rf_detector_type=$1";
 
    $param = array(1, LicenseMap::CONCLUSION, LicenseMap::REPORT);
    if ($rf > 0) {
      $stmt = __METHOD__ . '.rf';
      $param[] = $rf;
      $sql .= ' AND rf.rf_pk = $'.count($param).$forGroupBy;
      $row = $this->dbManager->getSingleRow($sql,$param,$stmt);
      $vars = $row ? array( $row ) : array();
    } else {
      $stmt = __METHOD__;
      $sql .= $forGroupBy . ', rf.rf_pk ORDER BY rf.rf_pk';
      $this->dbManager->prepare($stmt,$sql);
      $res = $this->dbManager->execute($stmt,$param);
      $vars = $this->dbManager->fetchAll( $res );
      $this->dbManager->freeResult($res);
    }
    if ($generateJson) {
      return json_encode($vars, JSON_PRETTY_PRINT);
    } else {
      $out = fopen('php://output', 'w');
      ob_start();
      $head = array(
        'shortname', 'fullname', 'spdx_id', 'licensetype', 'text', 'parent_shortname',
        'report_shortname', 'url', 'notes', 'source', 'risk', 'group',
        'obligations');
      fputs($out, $bom =( chr(0xEF) . chr(0xBB) . chr(0xBF) ));
      fputcsv($out, $head, $this->delimiter, $this->enclosure);
      foreach ($vars as $row) {
        $row['spdx_id'] = LicenseRef::convertToSpdxId($row['shortname'],
          $row['spdx_id']);
        if (strlen($row['text']) > LicenseMap::MAX_CHAR_LIMIT) {
          $row['text'] = LicenseMap::TEXT_MAX_CHAR_LIMIT;
        }
        fputcsv($out, $row, $this->delimiter, $this->enclosure);
      }
      $content = ob_get_contents();
      ob_end_clean();
      return $content;
    }
  }
}