mirror of
https://github.com/Combodo/iTop.git
synced 2026-02-27 22:24:12 +01:00
cd5e5da526
#1071 Bulk Read access rights #1034 List of fields for Excel export #772 Some attributes not exportedvia export.php Main features: - list and order of the fields taken into account - interactive mode to specify all the parameters interactively (including the list and the order of fields) - same behavior for all the formats: html, CSV, spreadsheet, XML - new PDF export SVN:trunk[3606]
309 lines
8.3 KiB
PHP
309 lines
8.3 KiB
PHP
<?php
|
|
// Copyright (C) 2015 Combodo SARL
|
|
//
|
|
// This file is part of iTop.
|
|
//
|
|
// iTop is free software; you can redistribute it and/or modify
|
|
// it under the terms of the GNU Affero General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// iTop is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU Affero General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Affero General Public License
|
|
// along with iTop. If not, see <http://www.gnu.org/licenses/>
|
|
|
|
/**
|
|
* Bulk export: Excel (xlsx) export
|
|
*
|
|
* @copyright Copyright (C) 2015 Combodo SARL
|
|
* @license http://opensource.org/licenses/AGPL-3.0
|
|
*/
|
|
|
|
require_once(APPROOT.'application/xlsxwriter.class.php');
|
|
|
|
class ExcelBulkExport extends TabularBulkExport
|
|
{
|
|
protected $sData;
|
|
|
|
public function __construct()
|
|
{
|
|
parent::__construct();
|
|
$this->aStatusInfo['status'] = 'not_started';
|
|
$this->aStatusInfo['position'] = 0;
|
|
}
|
|
|
|
public function Cleanup()
|
|
{
|
|
@unlink($this->aStatusInfo['tmp_file']);
|
|
parent::Cleanup();
|
|
}
|
|
|
|
public function DisplayUsage(Page $oP)
|
|
{
|
|
$oP->p(" * xlsx format options:");
|
|
$oP->p(" *\tfields: the comma separated list of field codes to export (e.g: name,org_id,service_name...).");
|
|
}
|
|
|
|
|
|
public function EnumFormParts()
|
|
{
|
|
return array_merge(parent::EnumFormParts(), array('interactive_fields_xlsx' => array('interactive_fields_xlsx')));
|
|
}
|
|
|
|
public function DisplayFormPart(WebPage $oP, $sPartId)
|
|
{
|
|
switch($sPartId)
|
|
{
|
|
case 'interactive_fields_xlsx':
|
|
$this->GetInteractiveFieldsWidget($oP, 'interactive_fields_xlsx');
|
|
break;
|
|
|
|
default:
|
|
return parent:: DisplayFormPart($oP, $sPartId);
|
|
}
|
|
}
|
|
|
|
public function ReadParameters()
|
|
{
|
|
parent::ReadParameters();
|
|
$this->aStatusInfo['localize'] = !((bool)utils::ReadParam('no_localize', 0, true, 'integer'));
|
|
}
|
|
|
|
|
|
protected function SuggestField($aAliases, $sClass, $sAlias, $sAttCode)
|
|
{
|
|
switch($sAttCode)
|
|
{
|
|
case 'id': // replace 'id' by 'friendlyname'
|
|
$sAttCode = 'friendlyname';
|
|
break;
|
|
|
|
default:
|
|
$oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
|
|
if ($oAttDef instanceof AttributeExternalKey)
|
|
{
|
|
$sAttCode .= '_friendlyname';
|
|
}
|
|
}
|
|
|
|
return parent::SuggestField($aAliases, $sClass, $sAlias, $sAttCode);
|
|
}
|
|
|
|
public function GetHeader()
|
|
{
|
|
$oSet = new DBObjectSet($this->oSearch);
|
|
$this->aStatusInfo['status'] = 'retrieving';
|
|
$this->aStatusInfo['tmp_file'] = $this->MakeTmpFile('data');
|
|
$this->aStatusInfo['position'] = 0;
|
|
$this->aStatusInfo['total'] = $oSet->Count();
|
|
|
|
$aSelectedClasses = $this->oSearch->GetSelectedClasses();
|
|
$aTableHeaders = array();
|
|
foreach($this->aStatusInfo['fields'] as $sExtendedAttCode)
|
|
{
|
|
if (preg_match('/^([^\.]+)\.(.+)$/', $sExtendedAttCode, $aMatches))
|
|
{
|
|
$sAlias = $aMatches[1];
|
|
$sAttCode = $aMatches[2];
|
|
}
|
|
else
|
|
{
|
|
$sAlias = reset($aSelectedClasses);
|
|
$sAttCode = $sExtendedAttCode;
|
|
}
|
|
if (!array_key_exists($sAlias, $aSelectedClasses))
|
|
{
|
|
throw new Exception("Invalid alias '$sAlias' for the column '$sExtendedAttCode'. Availables aliases: '".implode("', '", array_keys($aSelectedClasses))."'");
|
|
}
|
|
$sClass = $aSelectedClasses[$sAlias];
|
|
|
|
$sFullAlias = '';
|
|
if (count($aSelectedClasses) > 1)
|
|
{
|
|
$sFullAlias = $sAlias.'.';
|
|
}
|
|
|
|
switch($sAttCode)
|
|
{
|
|
case 'id':
|
|
$aTableHeaders[] = array('label' => $sFullAlias.'id', 'type' => '0');
|
|
|
|
break;
|
|
|
|
default:
|
|
$oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
|
|
$sType = 'string';
|
|
if($oAttDef instanceof AttributeDateTime)
|
|
{
|
|
$sType = 'datetime';
|
|
}
|
|
$sLabel = $sAttCode;
|
|
if ($this->aStatusInfo['localize'])
|
|
{
|
|
$sLabel = $oAttDef->GetLabel();
|
|
}
|
|
|
|
$aTableHeaders[] = array('label' => $sFullAlias.$sLabel, 'type' => $sType);
|
|
}
|
|
}
|
|
|
|
$sRow = json_encode($aTableHeaders);
|
|
$hFile = @fopen($this->aStatusInfo['tmp_file'], 'ab');
|
|
if ($hFile === false)
|
|
{
|
|
throw new Exception('ExcelBulkExport: Failed to open temporary data file: "'.$this->aStatusInfo['tmp_file'].'" for writing.');
|
|
}
|
|
fwrite($hFile, $sRow."\n");
|
|
fclose($hFile);
|
|
return '';
|
|
}
|
|
|
|
public function GetNextChunk(&$aStatus)
|
|
{
|
|
$sRetCode = 'run';
|
|
$iPercentage = 0;
|
|
|
|
$hFile = fopen($this->aStatusInfo['tmp_file'], 'ab');
|
|
$oSet = new DBObjectSet($this->oSearch);
|
|
$aSelectedClasses = $this->oSearch->GetSelectedClasses();
|
|
$oSet->SetLimit($this->iChunkSize, $this->aStatusInfo['position']);
|
|
|
|
$aAliasByField = array();
|
|
$aColumnsToLoad = array();
|
|
|
|
// Prepare the list of aliases / columns to load
|
|
foreach($this->aStatusInfo['fields'] as $sExtendedAttCode)
|
|
{
|
|
if (preg_match('/^([^\.]+)\.(.+)$/', $sExtendedAttCode, $aMatches))
|
|
{
|
|
$sAlias = $aMatches[1];
|
|
$sAttCode = $aMatches[2];
|
|
}
|
|
else
|
|
{
|
|
$sAlias = reset($aSelectedClasses);
|
|
$sAttCode = $sExtendedAttCode;
|
|
}
|
|
|
|
if (!array_key_exists($sAlias, $aSelectedClasses))
|
|
{
|
|
throw new Exception("Invalid alias '$sAlias' for the column '$sExtendedAttCode'. Availables aliases: '".implode("', '", array_keys($aSelectedClasses))."'");
|
|
}
|
|
|
|
if (!array_key_exists($sAlias, $aColumnsToLoad))
|
|
{
|
|
$aColumnsToLoad[$sAlias] = array();
|
|
}
|
|
if ($sAttCode != 'id')
|
|
{
|
|
// id is not a real attribute code and, moreover, is always loaded
|
|
$aColumnsToLoad[$sAlias][] = $sAttCode;
|
|
}
|
|
$aAliasByField[$sExtendedAttCode] = array('alias' => $sAlias, 'attcode' => $sAttCode);
|
|
}
|
|
|
|
$iCount = 0;
|
|
$oSet->OptimizeColumnLoad($aColumnsToLoad);
|
|
$iPreviousTimeLimit = ini_get('max_execution_time');
|
|
$iLoopTimeLimit = MetaModel::GetConfig()->Get('max_execution_time_per_loop');
|
|
while($aRow = $oSet->FetchAssoc())
|
|
{
|
|
set_time_limit($iLoopTimeLimit);
|
|
$aData = array();
|
|
foreach($aAliasByField as $aAttCode)
|
|
{
|
|
$sField = '';
|
|
switch($aAttCode['attcode'])
|
|
{
|
|
case 'id':
|
|
$sField = $aRow[$aAttCode['alias']]->GetKey();
|
|
break;
|
|
|
|
default:
|
|
$sField = $aRow[$aAttCode['alias']]->Get($aAttCode['attcode']);
|
|
}
|
|
$aData[] = $sField;
|
|
}
|
|
fwrite($hFile, json_encode($aData)."\n");
|
|
$iCount++;
|
|
}
|
|
set_time_limit($iPreviousTimeLimit);
|
|
$this->aStatusInfo['position'] += $this->iChunkSize;
|
|
if ($this->aStatusInfo['total'] == 0)
|
|
{
|
|
$iPercentage = 100;
|
|
$sRetCode = 'done'; // Next phase (GetFooter) will be to build the xlsx file
|
|
}
|
|
else
|
|
{
|
|
$iPercentage = floor(min(100.0, 100.0*$this->aStatusInfo['position']/$this->aStatusInfo['total']));
|
|
}
|
|
if ($iCount < $this->iChunkSize)
|
|
{
|
|
$sRetCode = 'done';
|
|
}
|
|
$aStatus = array('code' => $sRetCode, 'message' => Dict::S('Core:BulkExport:RetrievingData'), 'percentage' => $iPercentage);
|
|
return ''; // The actual XLSX file is built in GetFooter();
|
|
}
|
|
|
|
public function GetFooter()
|
|
{
|
|
$hFile = @fopen($this->aStatusInfo['tmp_file'], 'rb');
|
|
if ($hFile === false)
|
|
{
|
|
throw new Exception('ExcelBulkExport: Failed to open temporary data file: "'.$this->aStatusInfo['tmp_file'].'" for reading.');
|
|
}
|
|
$sHeaders = fgets($hFile);
|
|
$aHeaders = json_decode($sHeaders, true);
|
|
|
|
$aData = array();
|
|
while($sLine = fgets($hFile))
|
|
{
|
|
$aRow = json_decode($sLine);
|
|
$aData[] = $aRow;
|
|
}
|
|
fclose($hFile);
|
|
|
|
$fStartExcel = microtime(true);
|
|
$writer = new XLSXWriter();
|
|
$writer->setAuthor(UserRights::GetUserFriendlyName());
|
|
$aHeaderTypes = array();
|
|
$aHeaderNames = array();
|
|
foreach($aHeaders as $Header)
|
|
{
|
|
$aHeaderNames[] = $Header['label'];
|
|
$aHeaderTypes[] = $Header['type'];
|
|
}
|
|
$writer->writeSheet($aData,'Sheet1', $aHeaderTypes, $aHeaderNames);
|
|
$fExcelTime = microtime(true) - $fStartExcel;
|
|
//$this->aStatistics['excel_build_duration'] = $fExcelTime;
|
|
|
|
$fTime = microtime(true);
|
|
$data = $writer->writeToString();
|
|
$fExcelSaveTime = microtime(true) - $fTime;
|
|
//$this->aStatistics['excel_write_duration'] = $fExcelSaveTime;
|
|
|
|
@unlink($this->aStatusInfo['tmp_file']);
|
|
|
|
return $data;
|
|
}
|
|
|
|
public function GetMimeType()
|
|
{
|
|
return 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet';
|
|
}
|
|
|
|
public function GetFileExtension()
|
|
{
|
|
return 'xlsx';
|
|
}
|
|
|
|
public function GetSupportedFormats()
|
|
{
|
|
return array('xlsx' => Dict::S('Core:BulkExport:XLSXFormat'));
|
|
}
|
|
} |