ilXlsFoParserTest.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\MockObject\Stub;
 
class ilXlsFoParserTest extends ilCertificateBaseTestCase
{
    private function verifyFoGeneratedFromXhtml(array $form_data, string $fo): void
    {
        $output = $this->createXlsFoParser()->parse($form_data);
 
        $this->assertSame($this->normalizeXml($fo), $this->normalizeXml($output));
    }
 
    private function createXlsFoParser(): ilXlsFoParser
    {
        $settings = $this->createStub(ilSetting::class);
        $settings->method('get')->willReturnArgument(0);
 
        $language = $this->getStubBuilder(ilLanguage::class)->disableOriginalConstructor()->onlyMethods(
            ['txt']
        )->getStub();
        $language->method('txt')->willReturnArgument(0);
 
        $page_formats = new ilPageFormats($language);
 
        $util_helper = $this->createStub(ilCertificateUtilHelper::class);
 
        $util_helper->method('stripSlashes')
                    ->willReturnArgument(0);
 
        $xmlChecker = new ilXMLChecker(new ILIAS\Data\Factory());
        $xslt_process = new ilCertificateXlstProcess();
 
        $language = $this->createStub(ilLanguage::class);
 
        $xsl_loader = new ilCertificateXlsFileLoader();
 
        return new ilXlsFoParser(
            $settings,
            $page_formats,
            $xmlChecker,
            $util_helper,
            $xslt_process,
            $language,
            $xsl_loader
        );
    }
 
    private function paragraphAlignments(string $certificate_text): array
    {
        $output = $this->createXlsFoParser()->parse([
            'certificate_text' => $certificate_text,
            'margin_body' => [
                'top' => '0cm',
                'right' => '2cm',
                'bottom' => '0cm',
                'left' => '2cm'
            ],
            'pageformat' => 'custom',
            'pagewidth' => '297mm',
            'pageheight' => '210mm'
        ]);
 
        $document = new DOMDocument();
        $document->loadXML($output);
        $xpath = new DOMXPath($document);
        $xpath->registerNamespace('fo', 'http://www.w3.org/1999/XSL/Format');
 
        $alignments = [];
        foreach ($xpath->query('//fo:flow/fo:block/fo:block') as $block) {
            $alignments[] = $block->getAttribute('text-align');
        }
 
        return $alignments;
    }
 
    private function normalizeXml(string $xml): string
    {
        $xml = str_replace(["\n", "\r", "\t"], '', $xml);
        $xml = preg_replace("/>(\s+)</", "><", $xml);
        $xml = preg_replace('# {2,}#', ' ', $xml);
        $xml = trim($xml);
 
        return $xml;
    }
 
    public function testParseWithNonCustomPageFormatting(): void
    {
        $formData = [
            'certificate_text' => '<xml> Some Context </xml>',
            'margin_body' => [
                'top' => '1cm',
                'right' => '2cm',
                'bottom' => '3cm',
                'left' => '4cm'
            ],
            'pageformat' => 'a4'
        ];
 
        $settings = $this->createStub(ilSetting::class);
 
        $settings->method('get')
                 ->willReturn('Something');
 
        $pageFormats = $this->createStub(ilPageFormats::class);
 
        $pageFormats->method('fetchPageFormats')
                    ->willReturn([
                        'a4' => [
                            'name' => 'A4',
                            'value' => 'a4',
                            'width' => '210mm',
                            'height' => '297mm'
                        ],
                    ]);
 
        $xmlChecker = new ilXMLChecker(new ILIAS\Data\Factory());
 
        $utilHelper = $this->createStub(ilCertificateUtilHelper::class);
 
        $utilHelper->method('stripSlashes')
                   ->willReturnOnConsecutiveCalls(
                       '297mm',
                       '210mm',
                       '1cm',
                       '2cm',
                       '3cm',
                       '4cm'
                   );
 
        $xlstProcess = $this->getMockBuilder(ilCertificateXlstProcess::class)
                            ->getMock();
 
        $xlstProcess
            ->expects($this->once())
            ->method('process')
            ->with(
                [
                    '/_xml' => '<html><body><xml> Some Context </xml></body></html>',
                    '/_xsl' => '<xml>Some XLS Content</xml>'
                ],
                [
                    'pageheight' => '297mm',
                    'pagewidth' => '210mm',
                    'backgroundimage' => '[BACKGROUND_IMAGE]',
                    'marginbody' => '1cm 2cm 3cm 4cm'
                ]
            )
            ->willReturn('Something Processed');
 
        $language = $this->createStub(ilLanguage::class);
 
        $certificateXlsFileLoader = $this->createStub(ilCertificateXlsFileLoader::class);
 
        $certificateXlsFileLoader->method('getXlsCertificateContent')
                                 ->willReturn('<xml>Some XLS Content</xml>');
 
        $xlsFoParser = new ilXlsFoParser(
            $settings,
            $pageFormats,
            $xmlChecker,
            $utilHelper,
            $xlstProcess,
            $language,
            $certificateXlsFileLoader
        );
 
        $output = $xlsFoParser->parse($formData);
 
        $this->assertSame('Something Processed', $output);
    }
 
    public function testParseButXmlCheckerFindsAnError(): never
    {
        $this->expectException(Exception::class);
 
        $formData = [
            'certificate_text' => '<xml> Some Context <xml>',
            'margin_body' => [
                'top' => '1cm',
                'right' => '2cm',
                'bottom' => '3cm',
                'left' => '4cm'
            ],
            'pageformat' => 'custom'
        ];
 
        $settings = $this->createStub(ilSetting::class);
 
        $settings->method('get')
                 ->willReturn('Something');
 
        $pageFormats = $this->createStub(ilPageFormats::class);
 
        $pageFormats->method('fetchPageFormats')
                    ->willReturn([
                        'a4' => [
                            'name' => 'A4',
                            'value' => 'a4',
                            'width' => '210mm',
                            'height' => '297mm'
                        ],
                    ]);
 
        $xmlChecker = new ilXMLChecker(new ILIAS\Data\Factory());
 
        $utilHelper = $this->createStub(ilCertificateUtilHelper::class);
 
        $xlstProcess = $this->createStub(ilCertificateXlstProcess::class);
 
        $language = $this->getMockBuilder(ilLanguage::class)
                         ->disableOriginalConstructor()
                         ->onlyMethods(['txt'])
                         ->getMock();
        $language->expects($this->once())->method('txt')->willReturn('certificate_not_well_formed');
 
        $certificateXlsFileLoader = $this->createStub(ilCertificateXlsFileLoader::class);
 
        $certificateXlsFileLoader->method('getXlsCertificateContent')
                                 ->willReturn('<xml>Some XLS Content</xml>');
 
        $xlsFoParser = new ilXlsFoParser(
            $settings,
            $pageFormats,
            $xmlChecker,
            $utilHelper,
            $xlstProcess,
            $language,
            $certificateXlsFileLoader
        );
 
        $xlsFoParser->parse($formData);
 
        $this->fail();
    }
 
    public function testParseWithCustomPageFormatting(): void
    {
        $formData = [
            'certificate_text' => '<xml> Some Context </xml>',
            'margin_body' => [
                'top' => '1cm',
                'right' => '2cm',
                'bottom' => '3cm',
                'left' => '4cm'
            ],
            'pageformat' => 'custom',
            'pagewidth' => '210mm',
            'pageheight' => '297mm'
        ];
 
        $settings = $this->createStub(ilSetting::class);
 
        $settings->method('get')
                 ->willReturn('Something');
 
        $pageFormats = $this->createStub(ilPageFormats::class);
 
        $pageFormats->method('fetchPageFormats')
                    ->willReturn([
                        'a4' => [
                            'name' => 'A4',
                            'value' => 'a4',
                            'width' => '210mm',
                            'height' => '297mm'
                        ],
                    ]);
 
        $xmlChecker = new ilXMLChecker(new ILIAS\Data\Factory());
 
        $utilHelper = $this->createStub(ilCertificateUtilHelper::class);
 
        $utilHelper->method('stripSlashes')
                   ->willReturnOnConsecutiveCalls(
                       '297mm',
                       '210mm',
                       '1cm',
                       '2cm',
                       '3cm',
                       '4cm'
                   );
 
        $xlstProcess = $this->getMockBuilder(ilCertificateXlstProcess::class)
                            ->getMock();
 
        $xlstProcess
            ->expects($this->once())
            ->method('process')
            ->with(
                [
                            '/_xml' => '<html><body><xml> Some Context </xml></body></html>',
                            '/_xsl' => '<xml>Some XLS Content</xml>'
                        ],
                [
                            'pageheight' => '297mm',
                            'pagewidth' => '210mm',
                            'backgroundimage' => '[BACKGROUND_IMAGE]',
                            'marginbody' => '1cm 2cm 3cm 4cm'
                        ]
            )
            ->willReturn('Something Processed');
 
        $language = $this->createStub(ilLanguage::class);
 
        $certificateXlsFileLoader = $this->createStub(ilCertificateXlsFileLoader::class);
 
        $certificateXlsFileLoader->method('getXlsCertificateContent')
                                 ->willReturn('<xml>Some XLS Content</xml>');
 
        $xlsFoParser = new ilXlsFoParser(
            $settings,
            $pageFormats,
            $xmlChecker,
            $utilHelper,
            $xlstProcess,
            $language,
            $certificateXlsFileLoader
        );
 
        $output = $xlsFoParser->parse($formData);
 
        $this->assertSame('Something Processed', $output);
    }
 
    public function testCommasWillBeConvertedToPointInDecimalSepartor(): void
    {
        $formData = [
            'certificate_text' => '<xml> Some Context </xml>',
            'margin_body' => [
                'top' => '1cm',
                'right' => '2cm',
                'bottom' => '3cm',
                'left' => '4cm'
            ],
            'pageformat' => 'custom',
            'pagewidth' => '210mm',
            'pageheight' => '297mm'
        ];
 
        $settings = $this->createStub(ilSetting::class);
 
        $settings->method('get')
                 ->willReturn('Something');
 
        $pageFormats = $this->createStub(ilPageFormats::class);
 
        $pageFormats->method('fetchPageFormats')
                    ->willReturn([
                        'a4' => [
                            'name' => 'A4',
                            'value' => 'a4',
                            'width' => '21,0mm',
                            'height' => '29,7mm'
                        ],
                    ]);
 
        $xmlChecker = new ilXMLChecker(new ILIAS\Data\Factory());
 
        $utilHelper = $this->createStub(ilCertificateUtilHelper::class);
 
        $utilHelper->method('stripSlashes')
                   ->willReturnOnConsecutiveCalls(
                       '29,7mm',
                       '21,0mm',
                       '1cm',
                       '2cm',
                       '3cm',
                       '4cm'
                   );
 
        $xlstProcess = $this->getMockBuilder(ilCertificateXlstProcess::class)
                            ->getMock();
 
        $xlstProcess
            ->expects($this->once())
            ->method('process')
            ->with(
                [
                            '/_xml' => '<html><body><xml> Some Context </xml></body></html>',
                            '/_xsl' => '<xml>Some XLS Content</xml>'
                        ],
                [
                            'pageheight' => '29.7mm',
                            'pagewidth' => '21.0mm',
                            'backgroundimage' => '[BACKGROUND_IMAGE]',
                            'marginbody' => '1cm 2cm 3cm 4cm'
                        ]
            )
            ->willReturn('Something Processed');
 
        $language = $this->createStub(ilLanguage::class);
 
        $certificateXlsFileLoader = $this->createStub(ilCertificateXlsFileLoader::class);
 
        $certificateXlsFileLoader->method('getXlsCertificateContent')
                                 ->willReturn('<xml>Some XLS Content</xml>');
 
        $xlsFoParser = new ilXlsFoParser(
            $settings,
            $pageFormats,
            $xmlChecker,
            $utilHelper,
            $xlstProcess,
            $language,
            $certificateXlsFileLoader
        );
 
        $output = $xlsFoParser->parse($formData);
 
        $this->assertSame('Something Processed', $output);
    }
 
    public static function nonBreakingSpaceIsAddedDataProvider(): Generator
    {
        $expected_fo_with_centered_block = <<<EOT
<?xml version="1.0"?>
<fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format" font-family="rpc_pdf_font">
    <fo:layout-master-set>
        <fo:simple-page-master master-name="ILIAS_certificate" page-height="297mm" page-width="210mm">
            <fo:region-body margin="1cm 2cm 3cm 4cm"/>
            <fo:region-before region-name="background-image" extent="0"/>
        </fo:simple-page-master>
    </fo:layout-master-set>
    <fo:page-sequence master-reference="ILIAS_certificate">
        <fo:static-content flow-name="background-image">
            <fo:block-container absolute-position="absolute" top="0cm" left="0cm" z-index="0">
                <fo:block>
                    <fo:external-graphic src="url([BACKGROUND_IMAGE])" content-height="297mm" content-width="210mm"/>
                </fo:block>
            </fo:block-container>
        </fo:static-content>
        <fo:flow flow-name="xsl-region-body">
            <fo:block>
                <fo:block text-align="center">&#160;</fo:block>
            </fo:block>
        </fo:flow>
    </fo:page-sequence>
</fo:root>
EOT;
 
        yield 'Centered Paragraph' => [
            [
                'certificate_text' => '<p style="text-align: center;"></p>',
                'margin_body' => [
                    'top' => '1cm',
                    'right' => '2cm',
                    'bottom' => '3cm',
                    'left' => '4cm'
                ],
                'pageformat' => 'custom',
                'pagewidth' => '210mm',
                'pageheight' => '297mm'
            ],
            $expected_fo_with_centered_block
        ];
 
        $expected_fo_with_centered_block = <<<EOT
<?xml version="1.0"?>
<fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format" font-family="rpc_pdf_font">
    <fo:layout-master-set>
        <fo:simple-page-master master-name="ILIAS_certificate" page-height="297mm" page-width="210mm">
            <fo:region-body margin="1cm 2cm 3cm 4cm"/>
            <fo:region-before region-name="background-image" extent="0"/>
        </fo:simple-page-master>
    </fo:layout-master-set>
    <fo:page-sequence master-reference="ILIAS_certificate">
        <fo:static-content flow-name="background-image">
            <fo:block-container absolute-position="absolute" top="0cm" left="0cm" z-index="0">
                <fo:block>
                    <fo:external-graphic src="url([BACKGROUND_IMAGE])" content-height="297mm" content-width="210mm"/>
                </fo:block>
            </fo:block-container>
        </fo:static-content>
        <fo:flow flow-name="xsl-region-body">
            <fo:block>
                <fo:block>&#160;</fo:block>
            </fo:block>
        </fo:flow>
    </fo:page-sequence>
</fo:root>
EOT;
 
        yield 'Empty paragraph marked as emptyrow' => [
            [
                'certificate_text' => '<p class="emptyrow"></p>',
                'margin_body' => [
                    'top' => '1cm',
                    'right' => '2cm',
                    'bottom' => '3cm',
                    'left' => '4cm'
                ],
                'pageformat' => 'custom',
                'pagewidth' => '210mm',
                'pageheight' => '297mm'
            ],
            $expected_fo_with_centered_block
        ];
 
        yield 'Empty paragraph' => [
            [
                'certificate_text' => '<p></p>',
                'margin_body' => [
                    'top' => '1cm',
                    'right' => '2cm',
                    'bottom' => '3cm',
                    'left' => '4cm'
                ],
                'pageformat' => 'custom',
                'pagewidth' => '210mm',
                'pageheight' => '297mm'
            ],
            $expected_fo_with_centered_block
        ];
    }
 
    #[DataProvider('nonBreakingSpaceIsAddedDataProvider')]
    public function testTransformingParagraphsWithNoTextAndNoChildrenResultsInNonBreakingSpaceXslFoBlock(
        array $form_data,
        string $fo
    ): void {
        $this->verifyFoGeneratedFromXhtml($form_data, $fo);
    }
 
    public static function noNonBreakingSpaceIsAddedDataProvider(): Generator
    {
        $expected_fo_with_centered_block = <<<EOT
<?xml version="1.0"?>
<fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format" font-family="rpc_pdf_font">
    <fo:layout-master-set>
        <fo:simple-page-master master-name="ILIAS_certificate" page-height="297mm" page-width="210mm">
            <fo:region-body margin="1cm 2cm 3cm 4cm"/>
            <fo:region-before region-name="background-image" extent="0"/>
        </fo:simple-page-master>
    </fo:layout-master-set>
    <fo:page-sequence master-reference="ILIAS_certificate">
        <fo:static-content flow-name="background-image">
            <fo:block-container absolute-position="absolute" top="0cm" left="0cm" z-index="0">
                <fo:block>
                    <fo:external-graphic src="url([BACKGROUND_IMAGE])" content-height="297mm" content-width="210mm"/>
                </fo:block>
            </fo:block-container>
        </fo:static-content>
        <fo:flow flow-name="xsl-region-body">
            <fo:block>
                <fo:block>[USER_FULLNAME]</fo:block>
            </fo:block>
        </fo:flow>
    </fo:page-sequence>
</fo:root>
EOT;
 
        yield 'Paragraph with Text' => [
            [
                'certificate_text' => '<p>[USER_FULLNAME]</p>',
                'margin_body' => [
                    'top' => '1cm',
                    'right' => '2cm',
                    'bottom' => '3cm',
                    'left' => '4cm'
                ],
                'pageformat' => 'custom',
                'pagewidth' => '210mm',
                'pageheight' => '297mm'
            ],
            $expected_fo_with_centered_block
        ];
 
        $expected_fo_with_centered_block = <<<EOT
<?xml version="1.0"?>
<fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format" font-family="rpc_pdf_font">
    <fo:layout-master-set>
        <fo:simple-page-master master-name="ILIAS_certificate" page-height="297mm" page-width="210mm">
            <fo:region-body margin="1cm 2cm 3cm 4cm"/>
            <fo:region-before region-name="background-image" extent="0"/>
        </fo:simple-page-master>
    </fo:layout-master-set>
    <fo:page-sequence master-reference="ILIAS_certificate">
        <fo:static-content flow-name="background-image">
            <fo:block-container absolute-position="absolute" top="0cm" left="0cm" z-index="0">
                <fo:block>
                    <fo:external-graphic src="url([BACKGROUND_IMAGE])" content-height="297mm" content-width="210mm"/>
                </fo:block>
            </fo:block-container>
        </fo:static-content>
        <fo:flow flow-name="xsl-region-body">
            <fo:block>
                <fo:block><fo:inline font-size="24pt">[USER_FULLNAME]</fo:inline></fo:block>
            </fo:block>
        </fo:flow>
    </fo:page-sequence>
</fo:root>
EOT;
 
        yield 'Paragraph with Nodes' => [
            [
                'certificate_text' => '<p><span style="font-size: 24pt;">[USER_FULLNAME]</span></p>',
                'margin_body' => [
                    'top' => '1cm',
                    'right' => '2cm',
                    'bottom' => '3cm',
                    'left' => '4cm'
                ],
                'pageformat' => 'custom',
                'pagewidth' => '210mm',
                'pageheight' => '297mm'
            ],
            $expected_fo_with_centered_block
        ];
    }
 
    #[DataProvider('noNonBreakingSpaceIsAddedDataProvider')]
    public function testTransformingParagraphsWithTextOrChildrenResultsNotInNonBreakingSpaceXslFoBlock(
        array $form_data,
        string $fo
    ): void {
        $this->verifyFoGeneratedFromXhtml($form_data, $fo);
    }
 
    public function testCssTextAlignOverridesStaleAlignAttribute(): void
    {
        $this->assertSame(
            ['center', 'center', 'left', 'right', 'justify', 'center'],
            $this->paragraphAlignments(
                '<p align="left" style="text-align: center;">Confirmation</p>'
                . '<p align="left" style="padding-left: 10px; text-align: center;">Line</p>'
                . '<p align="center" style="text-align: left;">Left again</p>'
                . '<p align="left" style="text-align: right;">Right</p>'
                . '<p align="left" style="text-align: justify;">Justified</p>'
                . '<p align="center">Legacy center</p>'
            )
        );
    }
 
    public function testStoredCertificateReloadsAlignmentAsCss(): void
    {
        $fo = $this->createXlsFoParser()->parse([
            'certificate_text' => '<p style="text-align: center;">Confirmation</p><p style="text-align: left;">Line</p>',
            'margin_body' => [
                'top' => '0cm',
                'right' => '2cm',
                'bottom' => '0cm',
                'left' => '2cm'
            ],
            'pageformat' => 'custom',
            'pagewidth' => '297mm',
            'pageheight' => '210mm'
        ]);
 
        $reloaded = (new ilFormFieldParser(new ilCertificateXlstProcess()))->fetchDefaultFormFields($fo);
 
        $this->assertStringNotContainsString('align=', $reloaded['certificate_text']);
        $this->assertStringContainsString('text-align: center', $reloaded['certificate_text']);
        $this->assertStringContainsString('text-align: left', $reloaded['certificate_text']);
        $this->assertSame(
            ['center', 'left'],
            $this->paragraphAlignments($reloaded['certificate_text'])
        );
    }
 
    public function testParagraphsWithoutDescendantTextKeepANonBreakingSpace(): void
    {
        $output = $this->createXlsFoParser()->parse([
            'certificate_text' =>
                '<p style="text-align: center;"><span style="font-size: 36pt;">Bestätigung</span></p>'
                . '<p style="text-align: center;"><span style="font-size: 36pt;"></span></p>'
                . '<p style="text-align: center;"><span style="font-size: 36pt;"></span></p>'
                . '<p style="text-align: center;"><strong><span style="font-size: 12pt;">Durch dieses Zertifikat wird bestätigt, dass</span></strong></p>'
                . '<p style="text-align: center;"><span style="font-size: 12pt;"><strong></strong></span></p>'
                . '<p style="text-align: center;"><span style="font-size: 12pt;"><strong>Zertifikats-ID: [CERTIFICATE_ID]</strong></span></p>',
            'margin_body' => [
                'top' => '0cm',
                'right' => '2cm',
                'bottom' => '0cm',
                'left' => '2cm'
            ],
            'pageformat' => 'custom',
            'pagewidth' => '297mm',
            'pageheight' => '210mm'
        ]);
 
        $document = new DOMDocument();
        $document->loadXML($output);
        $xpath = new DOMXPath($document);
        $xpath->registerNamespace('fo', 'http://www.w3.org/1999/XSL/Format');
 
        $blocks = [];
        foreach ($xpath->query('//fo:flow/fo:block/fo:block') as $block) {
            $blocks[] = $block;
        }
 
        $this->assertCount(6, $blocks);
        foreach ($blocks as $block) {
            $this->assertNotSame('', $block->textContent, $document->saveXML($block));
        }
 
        $this->assertSame('Bestätigung', $blocks[0]->textContent);
        $this->assertSame("\u{00A0}", $blocks[1]->textContent);
        $this->assertSame("\u{00A0}", $blocks[2]->textContent);
        $this->assertSame('Durch dieses Zertifikat wird bestätigt, dass', $blocks[3]->textContent);
        $this->assertSame("\u{00A0}", $blocks[4]->textContent);
        $this->assertSame('Zertifikats-ID: [CERTIFICATE_ID]', $blocks[5]->textContent);
    }
}