FOSSology  4.5.1
Open Source License Compliance by Open Source Software
admin-folder-size.php
1 <?php
2 /*
3  SPDX-FileCopyrightText: © 2023 Siemens AG
4 
5  SPDX-License-Identifier: GPL-2.0-only
6 */
7 
10 
11 define("TITLE_SIZE_DASHBOARD", _("Folder and upload dashboard"));
12 
14 {
15 
17  private $dbManager;
18 
22  private $uploadDao;
23 
24  function __construct()
25  {
26  $this->Name = "size_dashboard";
27  $this->Title = TITLE_SIZE_DASHBOARD;
28  $this->MenuList = "Admin::Dashboards::Folder/Upload Proportions";
29  $this->Dependency = array();
30  $this->DBaccess = PLUGIN_DB_WRITE;
31  parent::__construct();
32  $this->dbManager = $GLOBALS['container']->get('db.manager');
33  $this->uploadDao = $GLOBALS['container']->get('dao.upload');
34  }
35 
41  function getFolderAndUploadSize($folderId)
42  {
43  $sql = 'INNER JOIN upload ON upload.pfile_fk=pfile.pfile_pk '.
44  'INNER JOIN foldercontents ON upload.upload_pk=foldercontents.child_id '.
45  'WHERE parent_fk=$1;';
46  $statementName = __METHOD__."GetFolderSize";
47  $folderSizesql = 'SELECT SUM(pfile_size) FROM pfile '.$sql;
48  $row = $this->dbManager->getSingleRow($folderSizesql,array($folderId),$statementName);
49  $folderSize = HumanSize($row['sum']);
50 
51  $statementName = __METHOD__."GetEachUploadSize";
52  $dispSql = "SELECT upload_pk, upload_filename, pfile_size, " .
53  "to_char(upload_ts, 'YYYY-MM-DD HH24:MI:SS') AS upload_ts FROM pfile " . $sql;
54  $results = $this->dbManager->getRows($dispSql, [$folderId], $statementName);
55  $var = '';
56  foreach ($results as $result) {
57  $clearingDuration = $this->uploadDao->getClearingDuration($result["upload_pk"]);
58  $var .= "<tr><td align='left'>" . $result['upload_filename'] .
59  "</td><td align='left' data-order='{$result['pfile_size']}'>" .
60  HumanSize($result['pfile_size']) .
61  "</td><td align='left' data-order='{$clearingDuration[1]}'>$clearingDuration[0]</td>
62  <td align='left'>{$result['upload_ts']}</td></tr>";
63  }
64  return [$var, $folderSize];
65  }
66 
72  private function generateExportData($folderId, $format)
73  {
74  $results = $this->dbManager->getRows(
75  "SELECT upload_pk, upload_filename, pfile_size, to_char(upload_ts, 'YYYY-MM-DD HH24:MI:SS') AS upload_ts " .
76  "FROM pfile " .
77  "INNER JOIN upload ON upload.pfile_fk=pfile.pfile_pk " .
78  "INNER JOIN foldercontents ON upload.upload_pk=foldercontents.child_id " .
79  "WHERE parent_fk=$1",
80  [$folderId],
81  __METHOD__."ExportData"
82  );
83 
84  $data = [];
85  foreach ($results as $row) {
86  $clearingDuration = $this->uploadDao->getClearingDuration($row["upload_pk"]);
87  $data[] = [
88  'name' => $row['upload_filename'],
89  'size' => $row['pfile_size'],
90  'duration' => $clearingDuration[1],
91  'date' => $row['upload_ts']
92  ];
93  }
94 
95  switch ($format) {
96  case 'csv':
97  $this->outputCSV($data);
98  break;
99  case 'json':
100  $this->outputJSON($data);
101  break;
102  }
103  }
104 
109  private function outputCSV($data)
110  {
111  header('Content-Type: text/csv');
112  header('Content-Disposition: attachment; filename="folder_export.csv"');
113 
114  $output = fopen('php://output', 'w');
115  fputcsv($output, ['Upload Name', 'Size (bytes)', 'Clearing Duration (seconds)', 'Upload Date']);
116 
117  foreach ($data as $row) {
118  fputcsv($output, [
119  $row['name'],
120  $row['size'],
121  $row['duration'],
122  $row['date']
123  ]);
124  }
125  fclose($output);
126  exit;
127  }
128 
133  private function outputJSON($data)
134  {
135  header('Content-Type: application/json');
136  header('Content-Disposition: attachment; filename="folder_export.json"');
137  echo json_encode($data, JSON_PRETTY_PRINT);
138  exit;
139  }
140 
144  public function Output()
145  {
146  $exportFormat = GetParm('export', PARM_STRING);
147  if (!empty($exportFormat) && in_array($exportFormat, ['csv', 'json'])) {
148  $folderId = GetParm('folder', PARM_INTEGER);
149  $this->generateExportData($folderId, $exportFormat);
150  }
151  /* If this is a POST, then process the request. */
152  $folderId = GetParm('selectfolderid', PARM_INTEGER);
153  if (empty($folderId)) {
154  $folderId = FolderGetTop();
155  }
156  list($tableVars, $wholeFolderSize) = $this->getFolderAndUploadSize($folderId);
157 
158  /* Display the form */
159  $formVars["onchangeURI"] = Traceback_uri() . "?mod=" . $this->Name . "&selectfolderid=";
160  $formVars["folderListOption"] = FolderListOption(-1, 0, 1, $folderId);
161  $formVars["tableVars"] = $tableVars;
162  $formVars["wholeFolderSize"] = $wholeFolderSize;
163  $formVars["currentFolderId"] = $folderId;
164  $formVars["pluginName"] = $this->Name;
165  return $this->renderString("admin-folder-size-form.html.twig", $formVars);
166  }
167 }
168 $NewPlugin = new size_dashboard;
This is the Plugin class. All plugins should:
Definition: FO_Plugin.php:57
renderString($templateName, $vars=null)
Definition: FO_Plugin.php:414
getFolderAndUploadSize($folderId)
Given a folder's ID function will get size of the folder and uploads under it.
__construct()
base constructor. Most plugins will just use this
Output()
Generate the text for this plugin.
outputJSON($data)
Outputs data in JSON format.
generateExportData($folderId, $format)
Generate export data in CSV or JSON format for a given folder ID.
outputCSV($data)
Outputs data in CSV format.
FolderListOption($ParentFolder, $Depth, $IncludeTop=1, $SelectId=-1, $linkParent=false, $OldParent=0)
Create the folder tree, using OPTION tags.
FolderGetTop()
DEPRECATED! Find the top-of-tree folder_pk for the current user.
Traceback_uri()
Get the URI without query to this location.
Definition: common-parm.php:97
const PARM_INTEGER
Definition: common-parm.php:14
const PARM_STRING
Definition: common-parm.php:18
GetParm($parameterName, $parameterType)
This function will retrieve the variables and check data types.
Definition: common-parm.php:46
HumanSize( $bytes)
Translate a byte number to a proper type, xxx bytes to xxx B/KB/MB/GB/TB/PB.
Definition: common-ui.php:100
#define PLUGIN_DB_WRITE
Plugin requires write permission on DB.
Definition: libfossology.h:38
fo_dbManager * dbManager
fo_dbManager object
Definition: process.c:16