class.ilWkhtmlToPdfRenderer.php

Go to the documentation of this file.

<?php

class ilWkhtmlToPdfRenderer implements ilRendererConfig, ilPDFRenderer
{
    protected static $instance = null;
    protected $config;
    protected $lng;

    public function __construct($phpunit = false)
    {
        if (!$phpunit) {
            global $DIC;
            $this->setLanguage($DIC['lng']);
        }
    }

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

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

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

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

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

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

    public function generatePDF($service, $purpose, $config, $job)
    {
        $html_file = $this->getHtmlTempName();
        file_put_contents($html_file, implode('', $job->getPages()));
        $this->createPDFFileFromHTMLFile($html_file, $config, $job);
    }

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

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

    public function createPDFFileFromHTMLFile($a_path_to_file, $config, $job)
    {
        if (is_array($a_path_to_file)) {
            $files_list_as_string = ' ';
            foreach ($a_path_to_file as $file) {
                if (file_exists($file)) {
                    $files_list_as_string .= ' ' . $files_list_as_string;
                }
            }
            $this->runCommandLine($files_list_as_string, $job->getFilename(), $config);
        } else {
            if (file_exists($a_path_to_file)) {
                $this->runCommandLine($a_path_to_file, $job->getFilename(), $config);
            }
        }
    }

    protected function runCommandLine($a_path_to_file, $a_target, $config)
    {
        global $DIC;
        $log = $DIC['ilLog'];
        $config = new ilWkhtmlToPdfConfig($config);
        $temp_file = $this->getPdfTempName();
        $args = $config->getCommandLineConfig() . ' ' . $a_path_to_file . ' ' . $temp_file . $this->redirectLog();
        $this->appendDefaultFontStyle($a_path_to_file, $config);
        $return_value = ilUtil::execQuoted($config->getWKHTMLToPdfDefaultPath(), $args);
        $log->debug('ilWebkitHtmlToPdfTransformer command line config: ' . $args);
        foreach ($return_value as $key => $value) {
            $log->debug('ilWebkitHtmlToPdfTransformer return value line ' . $key . ' : ' . $value);
        }
        if (file_exists($temp_file)) {
            $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 {
            $log->info('ilWebkitHtmlToPdfTransformer error: ' . print_r($return_value, true));
        }
        unlink($a_path_to_file);
    }

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

    protected function redirectLog()
    {
        return $redirect_log = ' 2>&1 ';
    }

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

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