admin-folder-size.php

<?php
/*
  SPDX-FileCopyrightText: © 2023 Siemens AG
 
 SPDX-License-Identifier: GPL-2.0-only
*/
 
use Fossology\Lib\Dao\UploadDao;
use Fossology\Lib\Db\DbManager;
 
define("TITLE_SIZE_DASHBOARD", _("Folder and upload dashboard"));
 
class size_dashboard extends FO_Plugin
{
 
  private $dbManager;
 
  private $uploadDao;
 
  function __construct()
  {
    $this->Name = "size_dashboard";
    $this->Title = TITLE_SIZE_DASHBOARD;
    $this->MenuList = "Admin::Dashboards::Folder/Upload Proportions";
    $this->Dependency = array();
    $this->DBaccess = PLUGIN_DB_WRITE;
    parent::__construct();
    $this->dbManager = $GLOBALS['container']->get('db.manager');
    $this->uploadDao = $GLOBALS['container']->get('dao.upload');
  }
 
  function getFolderAndUploadSize($folderId)
  {
    $sql = 'INNER JOIN upload ON upload.pfile_fk=pfile.pfile_pk '.
           'INNER JOIN foldercontents ON upload.upload_pk=foldercontents.child_id '.
           'INNER JOIN upload_clearing ON upload.upload_pk=upload_clearing.upload_fk '.
           'WHERE parent_fk=$1';
    $statementName = __METHOD__."GetFolderSize";
    $folderSizesql = 'SELECT SUM(pfile_size) FROM pfile '.$sql;
    $row = $this->dbManager->getSingleRow($folderSizesql,array($folderId),$statementName);
    $folderSize = HumanSize($row['sum']);
 
    $dispSql = "SELECT DISTINCT ON (upload.upload_pk) upload_pk, upload_filename, pfile_size, " .
      "to_char(upload_ts, 'YYYY-MM-DD HH24:MI:SS') AS upload_ts, status_fk FROM pfile " . $sql . " ORDER BY upload.upload_pk";
    $statementNameDisp = __METHOD__ . "GetEachUploadSize";
    $results = $this->dbManager->getRows($dispSql, [$folderId], $statementNameDisp);
 
    $uploadIds = array_column($results, 'upload_pk');
    $durationBatch = $this->uploadDao->getClearingDurationsBatch($uploadIds);
 
    $var = '';
    foreach ($results as $result) {
      $clearingDuration = $durationBatch[$result["upload_pk"]] ?? ['NA', 0];
      $var .= "<tr><td align='left'>" . $result['upload_pk'] .
        "</td><td align='left'>" . $result['upload_filename'] .
        "</td><td align='left' data-order='{$result['pfile_size']}'>" .
        HumanSize($result['pfile_size']) .
        "</td><td align='left' data-order='{$clearingDuration[1]}'>$clearingDuration[0]</td>
        <td align='left'>{$result['upload_ts']}</td><td align='left'>" . $this->ConvertStatusToString($result['status_fk']) .
        "</td></tr>";
    }
    return [$var, $folderSize];
  }
 
  private function generateExportData($folderId, $format)
  {
    $results = $this->dbManager->getRows(
      "SELECT DISTINCT ON (upload.upload_pk) upload_pk, upload_filename, pfile_size, to_char(upload_ts, 'YYYY-MM-DD HH24:MI:SS') AS upload_ts, status_fk " .
      "FROM pfile " .
      "INNER JOIN upload ON upload.pfile_fk=pfile.pfile_pk " .
      "INNER JOIN foldercontents ON upload.upload_pk=foldercontents.child_id " .
      "INNER JOIN upload_clearing ON upload.upload_pk=upload_clearing.upload_fk " .
      "WHERE parent_fk=$1 ORDER BY upload.upload_pk",
      [$folderId],
      __METHOD__ . "ExportData"
    );
 
    $uploadIds = array_column($results, 'upload_pk');
    $durationBatch = $this->uploadDao->getClearingDurationsBatch($uploadIds);
 
    $data = [];
    foreach ($results as $row) {
      $clearingDuration = $durationBatch[$row["upload_pk"]] ?? ['NA', 0];
      $data[] = [
        'uploadid' => $row['upload_pk'],
        'name' => $row['upload_filename'],
        'size' => $row['pfile_size'],
        'duration' => $clearingDuration[1],
        'date' => $row['upload_ts'],
        'status' => $this->ConvertStatusToString($row['status_fk'])
      ];
    }
 
    switch ($format) {
      case 'csv':
        $this->outputCSV($data);
        break;
      case 'json':
        $this->outputJSON($data);
        break;
    }
  }
 
  private function ConvertStatusToString($status)
  {
    $statusString = 'Open';
    if ($status == 2) {
      $statusString = 'In progress';
    } else if ($status == 3) {
      $statusString = 'Closed';
    } else if ($status == 4) {
      $statusString = 'Rejected';
    }
 
    return $statusString;
  }
 
  private function outputCSV($data)
  {
    header('Content-Type: text/csv');
    header('Content-Disposition: attachment; filename="folder_export.csv"');
 
    $output = fopen('php://output', 'w');
    fputcsv($output, ['Upload id', 'Upload name', 'Size (bytes)', 'Clearing duration (seconds)', 'Upload date', 'Upload status']);
 
    foreach ($data as $row) {
      fputcsv($output, [
        $row['uploadid'],
        $row['name'],
        $row['size'],
        $row['duration'],
        $row['date'],
        $row['status']
      ]);
    }
    fclose($output);
    exit;
  }
 
  private function outputJSON($data)
  {
    header('Content-Type: application/json');
    header('Content-Disposition: attachment; filename="folder_export.json"');
    echo json_encode($data, JSON_PRETTY_PRINT);
    exit;
  }
 
  public function Output()
  {
    $exportFormat = GetParm('export', PARM_STRING);
    if (!empty($exportFormat) && in_array($exportFormat, ['csv', 'json'])) {
      $folderId = GetParm('folder', PARM_INTEGER);
      $this->generateExportData($folderId, $exportFormat);
    }
    /* If this is a POST, then process the request. */
    $folderId = GetParm('selectfolderid', PARM_INTEGER);
    if (empty($folderId)) {
      $folderId = FolderGetTop();
    }
    list($tableVars, $wholeFolderSize) = $this->getFolderAndUploadSize($folderId);
 
    /* Display the form */
    $formVars["onchangeURI"] = Traceback_uri() . "?mod=" . $this->Name . "&selectfolderid=";
    $formVars["folderListOption"] = FolderListOption(-1, 0, 1, $folderId);
    $formVars["tableVars"] = $tableVars;
    $formVars["wholeFolderSize"] = $wholeFolderSize;
    $formVars["currentFolderId"] = $folderId;
    $formVars["pluginName"] = $this->Name;
    return $this->renderString("admin-folder-size-form.html.twig", $formVars);
  }
}
$NewPlugin = new size_dashboard;