class.ilWkhtmlToPdfRenderer.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilWkhtmlToPdfRenderer implements ilRendererConfig, ilPDFRenderer
{
    protected ilWkhtmlToPdfConfig $config;
    protected ilLanguage $lng;
    protected ilLogger $log;

    public function __construct(bool $phpunit = false)
    {
        if (!$phpunit) {
            global $DIC;
            $this->setLanguage($DIC->language());
            $this->log = $DIC->logger()->root();
        }
    }

    protected function setLanguage(ilLanguage $lng): void
    {
        $this->lng = $lng;
    }

    public function addConfigElementsToForm(ilPropertyFormGUI $form, string $service, string $purpose): void
    {
        $gui = new ilWkhtmlToPdfConfigFormGUI();
        $gui->addConfigForm($form);
    }

    public function populateConfigElementsInForm(ilPropertyFormGUI $form, string $service, string $purpose, $config): void
    {
        $this->config = new ilWkhtmlToPdfConfig($config);
        $gui = new ilWkhtmlToPdfConfigFormGUI();
        $gui->populateForm($form, $this->config);
    }

    public function validateConfigInForm(ilPropertyFormGUI $form, string $service, string $purpose): bool
    {
        $gui = new ilWkhtmlToPdfConfigFormGUI();
        return $gui->validateForm($form);
    }

    public function getConfigFromForm(ilPropertyFormGUI $form, string $service, string $purpose): array
    {
        $gui = new ilWkhtmlToPdfConfigFormGUI();
        return $gui->getConfigFromForm($form);
    }

    public function getDefaultConfig(string $service, string $purpose): ilWkhtmlToPdfConfig
    {
        $config = new ilWkhtmlToPdfConfig();
        return $config;
    }

    public function generatePDF(string $service, string $purpose, $config, ilPDFGenerationJob $job): void
    {
        $html_file = $this->getHtmlTempName();
        $pages = $job->getPages();

        file_put_contents($html_file, implode('', $pages));
        $this->createPDFFileFromHTMLFile($html_file, $config, $job);
    }

    public function getHtmlTempName(): string
    {
        return $this->getTempFileName('html');
    }

    protected function getTempFileName(string $file_type): string
    {
        return ilFileUtils::ilTempnam() . '.' . $file_type;
    }

    public function createPDFFileFromHTMLFile(string $a_path_to_file, $config, ilPDFGenerationJob $job): void
    {
        $this->runCommandLine($a_path_to_file, $job->getFilename(), $config);
    }

    protected function runCommandLine(string $a_path_to_file, string $a_target, $config): void
    {
        $wkConfig = new ilWkhtmlToPdfConfig($config);
        $temp_file = $this->getPdfTempName();
        $args = $wkConfig->getCommandLineConfig() . ' ' . $a_path_to_file . ' ' . $temp_file . $this->redirectLog();
        $this->appendDefaultFontStyle($a_path_to_file, $wkConfig);
        $this->fixIconSizeForPatchedQt($a_path_to_file);
        $return_value = ilShellUtil::execQuoted($wkConfig->getWKHTMLToPdfDefaultPath(), $args);
        $this->log->debug('ilWebkitHtmlToPdfTransformer command line config: ' . $args);
        $this->checkReturnValueFromCommandLine($return_value, $temp_file, $a_target);
        unlink($a_path_to_file);
    }

    public function getPdfTempName(): string
    {
        return $this->getTempFileName('pdf');
    }

    protected function redirectLog(): string
    {
        return ' 2>&1 ';
    }

    protected function appendDefaultFontStyle(string $a_path_to_file, ilWkhtmlToPdfConfig $config): void
    {
        $backupStyle = $config->getOverwriteDefaultFont(true);
        $originalFile = file_get_contents($a_path_to_file) . $backupStyle;
        file_put_contents($a_path_to_file, $originalFile);
    }

    protected function fixIconSizeForPatchedQt(string $a_path_to_file): void
    {
        $style = '<style>div.questionPrintview img.small {height: 20px; width: 20px;}</style>';
        $originalFile = file_get_contents($a_path_to_file) . $style;
        file_put_contents($a_path_to_file, $originalFile);
    }


    public function prepareGenerationRequest(string $service, string $purpose): void
    {
        ilMathJax::getInstance()
                 ->init(ilMathJax::PURPOSE_PDF)
                 ->setRendering(ilMathJax::RENDER_SVG_AS_XML_EMBED);
    }

    protected function checkReturnValueFromCommandLine(array $return_value, string $temp_file, string $a_target): void
    {
        foreach ($return_value as $key => $value) {
            $this->log->debug('ilWebkitHtmlToPdfTransformer return value line ' . $key . ' : ' . $value);
        }
        if (file_exists($temp_file)) {
            $this->log->debug('ilWebkitHtmlToPdfTransformer file exists: ' . $temp_file . ' file size is :' . filesize($temp_file) . ' bytes, will be renamed to ' . $a_target);
            rename($temp_file, $a_target);
        } else {
            $this->log->info('ilWebkitHtmlToPdfTransformer error: ' . print_r($return_value, true));
        }
    }
}