htmlpurifier/tests/HTMLPurifier/GeneratorTest.php

<?php

class HTMLPurifier_GeneratorTest extends HTMLPurifier_Harness
{
    
    /**
     * Entity lookup table to help for a few tests.
     */
    private $_entity_lookup;
    
    public function __construct() {
        parent::__construct();
        $this->_entity_lookup = HTMLPurifier_EntityLookup::instance();
    }
    
    public function setUp() {
        parent::setUp();
        $this->config->set('Output', 'Newline', "\n");
    }
    
    /**
     * Creates a generator based on config and context member variables.
     */
    protected function createGenerator() {
        return new HTMLPurifier_Generator($this->config, $this->context);
    }
    
    protected function assertGenerateFromToken($token, $html) {
        $generator = $this->createGenerator();
        $result = $generator->generateFromToken($token);
        $this->assertIdentical($result, $html);
    }
    
    function test_generateFromToken_text() {
        $this->assertGenerateFromToken(
            new HTMLPurifier_Token_Text('Foobar.<>'),
            'Foobar.&lt;&gt;'
        );
    }
    
    function test_generateFromToken_startWithAttr() {
        $this->assertGenerateFromToken(
            new HTMLPurifier_Token_Start('a',
                array('href' => 'dyn?a=foo&b=bar')
            ),
            '<a href="dyn?a=foo&amp;b=bar">'
        );
    }
    
    function test_generateFromToken_end() {
        $this->assertGenerateFromToken(
            new HTMLPurifier_Token_End('b'),
            '</b>'
        );
    }
    
    function test_generateFromToken_emptyWithAttr() {
        $this->assertGenerateFromToken(
            new HTMLPurifier_Token_Empty('br',
                array('style' => 'font-family:"Courier New";')
            ),
            '<br style="font-family:&quot;Courier New&quot;;" />'
        );
    }
    
    function test_generateFromToken_startNoAttr() {
        $this->assertGenerateFromToken(
            new HTMLPurifier_Token_Start('asdf'),
            '<asdf>'
        );
    }
    
    function test_generateFromToken_emptyNoAttr() {
        $this->assertGenerateFromToken(
            new HTMLPurifier_Token_Empty('br'),
            '<br />'
        );
    }
    
    function test_generateFromToken_error() {
        $this->expectError('Cannot generate HTML from non-HTMLPurifier_Token object');
        $this->assertGenerateFromToken( null, '' );
    }
    
    function test_generateFromToken_() {
        $theta_char = $this->_entity_lookup->table['theta'];
        $this->assertGenerateFromToken(
            new HTMLPurifier_Token_Text($theta_char),
            $theta_char
        );
    }
    
    function assertGenerateAttributes($attr, $expect, $element = false) {
        $generator = $this->createGenerator();
        $result = $generator->generateAttributes($attr, $element);
        $this->assertIdentical($result, $expect);
    }
    
    function test_generateAttributes_blank() {
        $this->assertGenerateAttributes(array(), '');
    }
    
    function test_generateAttributes_basic() {
        $this->assertGenerateAttributes(
            array('href' => 'dyn?a=foo&b=bar'),
            'href="dyn?a=foo&amp;b=bar"'
        );
    }
    
    function test_generateAttributes_doubleQuote() {
        $this->assertGenerateAttributes(
            array('style' => 'font-family:"Courier New";'),
            'style="font-family:&quot;Courier New&quot;;"'
        );
    }
    
    function test_generateAttributes_singleQuote() {
        $this->assertGenerateAttributes(
            array('style' => 'font-family:\'Courier New\';'),
            'style="font-family:\'Courier New\';"'
        );
    }
    
    function test_generateAttributes_multiple() {
        $this->assertGenerateAttributes(
            array('src' => 'picture.jpg', 'alt' => 'Short & interesting'),
            'src="picture.jpg" alt="Short &amp; interesting"'
        );
    }
    
    function test_generateAttributes_specialChar() {
        $theta_char = $this->_entity_lookup->table['theta'];
        $this->assertGenerateAttributes(
            array('title' => 'Theta is ' . $theta_char),
            'title="Theta is ' . $theta_char . '"'
        );
    }
    
    
    function test_generateAttributes_minimized() {
        $this->config->set('HTML', 'Doctype', 'HTML 4.01 Transitional');
        $this->assertGenerateAttributes(
            array('compact' => 'compact'), 'compact', 'menu'
        );
    }
    
    function test_generateFromTokens() {
        
        $this->assertGeneration(
            array(
                new HTMLPurifier_Token_Start('b'),
                new HTMLPurifier_Token_Text('Foobar!'),
                new HTMLPurifier_Token_End('b')
            ),
            '<b>Foobar!</b>'
        );
        
    }
    
    protected function assertGeneration($tokens, $expect) {
        $generator = new HTMLPurifier_Generator($this->config, $this->context);
        $result = $generator->generateFromTokens($tokens);
        $this->assertIdentical($expect, $result);
    }
    
    function test_generateFromTokens_Scripting() {
        $this->assertGeneration(
            array(
                new HTMLPurifier_Token_Start('script'),
                new HTMLPurifier_Token_Text('alert(3 < 5);'),
                new HTMLPurifier_Token_End('script')
            ),
            "<script><!--//--><![CDATA[//><!--\nalert(3 < 5);\n//--><!]]></script>"
        );
    }
    
    function test_generateFromTokens_Scripting_missingCloseTag() {
        $this->assertGeneration(
            array(
                new HTMLPurifier_Token_Start('script'),
                new HTMLPurifier_Token_Text('alert(3 < 5);'),
            ),
            "<script>alert(3 &lt; 5);"
        );
    }
    
    function test_generateFromTokens_Scripting_doubleBlock() {
        $this->assertGeneration(
            array(
                new HTMLPurifier_Token_Start('script'),
                new HTMLPurifier_Token_Text('alert(3 < 5);'),
                new HTMLPurifier_Token_Text('foo();'),
                new HTMLPurifier_Token_End('script')
            ),
            "<script>alert(3 &lt; 5);foo();</script>"
        );
    }
    
    function test_generateFromTokens_Scripting_disableWrapper() {
        $this->config->set('Output', 'CommentScriptContents', false);
        $this->assertGeneration(
            array(
                new HTMLPurifier_Token_Start('script'),
                new HTMLPurifier_Token_Text('alert(3 < 5);'),
                new HTMLPurifier_Token_End('script')
            ),
            "<script>alert(3 &lt; 5);</script>"
        );
    }
    
    function test_generateFromTokens_XHTMLoff() {
        $this->config->set('HTML', 'XHTML', false);
        
        // omit trailing slash
        $this->assertGeneration(
            array( new HTMLPurifier_Token_Empty('br') ),
            '<br>'
        );
        
        // there should be a test for attribute minimization, but it is
        // impossible for something like that to happen due to our current
        // definitions! fix it later
        
        // namespaced attributes must be dropped
        $this->assertGeneration(
            array( new HTMLPurifier_Token_Start('p', array('xml:lang'=>'fr')) ),
            '<p>'
        );
        
    }
    
    function test_generateFromTokens_TidyFormat() {
        // abort test if tidy isn't loaded
        if (!extension_loaded('tidy')) return;
        
        // just don't test; Tidy is exploding on me.
        return;
        
        $this->config->set('Core', 'TidyFormat', true);
        $this->config->set('Output', 'Newline', "\n");
        
        // nice wrapping please
        $this->assertGeneration(
            array(
                new HTMLPurifier_Token_Start('div'),
                new HTMLPurifier_Token_Text('Text'),
                new HTMLPurifier_Token_End('div')
            ),
            "<div>\n  Text\n</div>\n"
        );
        
    }
    
    function test_generateFromTokens_sortAttr() {
        $this->config->set('Output', 'SortAttr', true);
        
        $this->assertGeneration(
            array( new HTMLPurifier_Token_Start('p', array('b'=>'c', 'a'=>'d')) ),
            '<p a="d" b="c">'
        );
        
    }
    
}