class.ilDclContentExporter.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilDclContentExporter
{
    public const SOAP_FUNCTION_NAME = 'exportDataCollectionContent';
    public const EXPORT_EXCEL = 'xlsx';
    public const IN_PROGRESS_POSTFIX = '.prog';
    protected int $ref_id;
    protected ?int $table_id;
    protected array $filter;

    protected ilObjDataCollection $dcl;

    protected ilLanguage $lng;

    protected ilDclTable $table;
    private ilGlobalTemplateInterface $main_tpl;
    protected array $tables;

    public function __construct(int $ref_id, ?int $table_id, array $filter = [])
    {
        global $DIC;
        $this->main_tpl = $DIC->ui()->mainTemplate();
        $lng = $DIC['lng'];

        $this->ref_id = $ref_id;
        $this->table_id = $table_id;
        $this->filter = $filter;

        $this->dcl = new ilObjDataCollection($ref_id);
        $this->tables = ($table_id) ? [$this->dcl->getTableById($table_id)] : $this->dcl->getTables();

        $lng->loadLanguageModule('dcl');
        $this->lng = $lng;
    }

    public function sanitizeFilename(string $filename): string
    {
        $dangerous_filename_characters = [" ", '"', "'", "&", "/", "\\", "?", "#", "`"];

        return str_replace($dangerous_filename_characters, "_", iconv("utf-8", "ascii//TRANSLIT", $filename));
    }

    public function getExportContentPath(string $format): string
    {
        return ilExport::_getExportDirectory($this->dcl->getId(), $format, 'dcl') . '/';
    }

    protected function fillRowExcel(
        ilDclTable $table,
        ilExcel $worksheet,
        ilDclBaseRecordModel $record,
        int $row
    ): void {
        $col = 0;
        foreach ($table->getFields() as $field) {
            if ($field->getExportable()) {
                $record->fillRecordFieldExcelExport($worksheet, $row, $col, $field->getId());
            }
        }
    }

    protected function fillHeaderExcel(ilDclTable $table, ilExcel $worksheet, int $row): void
    {
        $col = 0;

        foreach ($table->getFields() as $field) {
            if ($field->getExportable()) {
                $field->fillHeaderExcel($worksheet, $row, $col);
            }
        }
    }

    protected function fillMetaExcel(ilDclTable $table, ilExcel $worksheet, int $row): void
    {
    }

    public function export(string $format = self::EXPORT_EXCEL, ?string $filepath = null, bool $send = false)
    {
        if (count($this->tables) == 0) {
            return;
        }

        if (empty($filepath)) {
            $filepath = $this->getExportContentPath($format);
            ilFileUtils::makeDirParents($filepath);

            $basename = (isset($this->table_id)) ? $this->tables[0]->getTitle() : 'complete';
            $filename = time() . '__' . $basename . "_" . date("Y-m-d_H-i");

            $filepath .= $this->sanitizeFilename($filename);
        } else {
            $filename = pathinfo($filepath, PATHINFO_FILENAME);
        }

        $in_progress_file = $filepath . self::IN_PROGRESS_POSTFIX;
        file_put_contents($in_progress_file, "");

        $data_available = false;
        $fields_available = false;
        $adapter = new ilExcel();
        if ($format == self::EXPORT_EXCEL) {
            foreach ($this->tables as $table) {
                ilDclCache::resetCache();

                $list = $table->getPartialRecords((string) $this->dcl->getRefId(), 'id', 'asc', null, 0, $this->filter);
                $data_available = $data_available || ($list['total'] > 0);
                $fields_available = $fields_available || (count($table->getExportableFields()) > 0);
                if ($list['total'] > 0 && count($table->getExportableFields()) > 0) {
                    // only 31 character-long table-titles are allowed
                    $title = substr($table->getTitle(), 0, 31);
                    $adapter->addSheet($title);
                    $row = 1;

                    $this->fillMetaExcel($table, $adapter, $row);

                    // #14813
                    $this->fillHeaderExcel($table, $adapter, $row);
                    $row++;

                    foreach ($list['records'] as $set) {
                        $this->fillRowExcel($table, $adapter, $set, $row);
                        $row++; // #14760
                    }

                    $data_available = true;
                }
            }
        }

        if (file_exists($in_progress_file)) {
            unlink($in_progress_file);
        }

        if (!$data_available || !$fields_available) {
            $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt('dcl_no_export_data_available'));
            return false;
        }

        $this->main_tpl->setOnScreenMessage($this->main_tpl::MESSAGE_TYPE_SUCCESS, $this->lng->txt('exp_file_created'), true);
        if ($send) {
            $adapter->sendToClient($filename);
        } else {
            $adapter->writeToFile($filepath);
        }
        return true;
    }

    public function exportAsync(string $format = self::EXPORT_EXCEL, ?string $filepath = null): mixed
    {
        global $DIC;
        $ilLog = $DIC['ilLog'];

        $method = self::SOAP_FUNCTION_NAME;

        $soap_params = [$this->dcl->getRefId()];
        array_push($soap_params, $this->table_id, $format, $filepath);

        $new_session_id = ilSession::_duplicate($_COOKIE[session_name()]);
        $client_id = $_COOKIE['ilClientId'];

        // Start cloning process using soap call
        $soap_client = new ilSoapClient();
        $soap_client->setResponseTimeout(5);
        $soap_client->enableWSDL(true);

        $ilLog->write(__METHOD__ . ': Trying to call Soap client...');

        array_unshift($soap_params, $new_session_id . '::' . $client_id);

        if ($soap_client->init()) {
            $ilLog->info('Calling soap ' . $method . ' method with params ' . print_r($soap_params, true));
            $res = $soap_client->call($method, $soap_params);
        } else {
            $ilLog->warning('SOAP clone call failed. Calling clone method manually');
            if (method_exists('ilSoapFunctions', $method)) {
                $res = ilSoapFunctions::$method(
                    $new_session_id . '::' . $client_id,
                    $this->dcl->getRefId(),
                    $this->table_id,
                    $format,
                    $filepath
                );
            } else {
                throw new ilDclException("SOAP call " . $method . " does not exists!");
            }
        }

        return $res;
    }
}