CustomTextExport.php

Go to the documentation of this file.

<?php
/*
 SPDX-FileCopyrightText: © 2025 Harshit Gandhi <gandhiharshit716@gmail.com>
 
 SPDX-License-Identifier: GPL-2.0-only
*/
 
namespace Fossology\Lib\Application;
 
use Fossology\Lib\Db\DbManager;
 
class CustomTextExport
{
  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 export($cp_pk=0, $generateJson=false)
  {
    $whereClause = "";
    $params = array();
 
    if ($cp_pk > 0) {
      $whereClause = "WHERE cp.cp_pk = $1";
      $params[] = $cp_pk;
    }
 
    $sql = "SELECT
              cp.text,
              cp.acknowledgement,
              cp.comments,
              cp.created_date,
              cp.is_active,
              u.user_name,
              g.group_name,
              STRING_AGG(CASE WHEN cplm.removing = false THEN lr.rf_shortname END, ', ' ORDER BY lr.rf_shortname) as licenses_to_add,
              STRING_AGG(CASE WHEN cplm.removing = true THEN lr.rf_shortname END, ', ' ORDER BY lr.rf_shortname) as licenses_to_remove
            FROM custom_phrase cp
            LEFT JOIN users u ON cp.user_fk = u.user_pk
            LEFT JOIN groups g ON cp.group_fk = g.group_pk
            LEFT JOIN custom_phrase_license_map cplm ON cp.cp_pk = cplm.cp_fk
            LEFT JOIN license_ref lr ON cplm.rf_fk = lr.rf_pk
            $whereClause
            GROUP BY cp.cp_pk, cp.text, cp.acknowledgement, cp.comments,
                     cp.created_date, cp.is_active, u.user_name, g.group_name
            ORDER BY cp.created_date DESC";
 
    $result = $this->dbManager->getRows($sql, $params);
 
    if ($generateJson) {
      return $this->createJson($result);
    } else {
      return $this->createCsvContent($result);
    }
  }
 
  private function createCsvContent($result)
  {
    $csv = '';
 
    // Add header row
    $headers = array(
      'Text',
      'Acknowledgement',
      'Comments',
      'Created Date',
      'Is Active',
      'Created By',
      'Group',
      'Licenses To Add',
      'Licenses To Remove'
    );
    $csv .= $this->arrayToCsvLine($headers);
 
    // Add data rows
    foreach ($result as $row) {
      $csvRow = array(
        $row['text'],
        $row['acknowledgement'] ?: '',
        $row['comments'] ?: '',
        $row['created_date'],
        $row['is_active'] ? 'true' : 'false',
        $row['user_name'] ?: '',
        $row['group_name'] ?: '',
        $row['licenses_to_add'] ?: '',
        $row['licenses_to_remove'] ?: ''
      );
      $csv .= $this->arrayToCsvLine($csvRow);
    }
 
    return $csv;
  }
 
  private function createJson($result)
  {
    $data = array();
 
    foreach ($result as $row) {
      $data[] = array(
        'text' => $row['text'],
        'acknowledgement' => $row['acknowledgement'] ?: '',
        'comments' => $row['comments'] ?: '',
        'created_date' => $row['created_date'],
        'is_active' => $row['is_active'] ? true : false,
        'created_by' => $row['user_name'] ?: '',
        'group' => $row['group_name'] ?: '',
        'licenses_to_add' => $row['licenses_to_add'] ? explode(', ', $row['licenses_to_add']) : array(),
        'licenses_to_remove' => $row['licenses_to_remove'] ? explode(', ', $row['licenses_to_remove']) : array()
      );
    }
 
    return json_encode($data, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE);
  }
 
  private function arrayToCsvLine($array)
  {
    $csvLine = '';
    foreach ($array as $key => $value) {
      if ($key > 0) {
        $csvLine .= $this->delimiter;
      }
 
      // Escape the value if it contains delimiter, enclosure, or newline
      if (strpos($value, $this->delimiter) !== false ||
          strpos($value, $this->enclosure) !== false ||
          strpos($value, "\n") !== false ||
          strpos($value, "\r") !== false) {
        $value = $this->enclosure . str_replace($this->enclosure, $this->enclosure . $this->enclosure, $value) . $this->enclosure;
      }
 
      $csvLine .= $value;
    }
    $csvLine .= "\n";
 
    return $csvLine;
  }
}