htmlpurifier/tests/HTMLPurifier/AttrDef/URITest.php

<?php

require_once 'HTMLPurifier/AttrDefHarness.php';
require_once 'HTMLPurifier/AttrDef/URI.php';

// WARNING: INCOMPLETE UNIT TESTS!
// we are currently abstaining IPv6 and percent-encode fixing unit tests
// we also need to test all the configuration directives defined by this class

class HTMLPurifier_AttrDef_URITest extends HTMLPurifier_AttrDefHarness
{
    
    var $scheme, $components, $return_components;
    
    function testGenericURI() {
        
        generate_mock_once('HTMLPurifier_URIScheme');
        generate_mock_once('HTMLPurifier_URISchemeRegistry');
        
        $old_registry = HTMLPurifier_URISchemeRegistry::instance();
        
        // finally, lets get a copy of the actual class
        $this->def = new HTMLPurifier_AttrDef_URI();
        
        // initialize test inputs
        $uri = // input URI
        $components = // what components the URI should be parsed to
        $return_components = // return components
        $expect_uri = array(); // what reassembled URI to expect
        
        //////////////////////////////////////////////////////////////////////
        
        // test a regular instance, return identical URI
        $uri[0] = 'http://www.example.com/webhp?q=foo#result2';
        $components[0] = array(
            null,               // userinfo
            'www.example.com',  // host
            null,               // port
            '/webhp',           // path
            'q=foo'             // query
        );
        
        // test an amended URI (the actual logic is irrelevant)
        // test that user and port get parsed correctly (3.2.1 and 3.2.3)
        $uri[1] = 'http://user@authority.part:80/now/the/path?query#fragment';
        $components[1] = array(
            'user', 'authority.part', 80,
            '/now/the/path', 'query'
        );
        $return_components[1] = array( // removed port (it's standard)
            'user', 'authority.part', null, '/now/the/path', 'query'
        );
        $expect_uri[1] = 'http://user@authority.part/now/the/path?query#fragment';
        
        // percent encoded characters are not resolved during generic URI
        // parsing even though RFC 3986 defines this notation
        // also test what happens when query/fragment are missing
        $uri[2] = 'http://en.wikipedia.org/wiki/Clich%C3%A9';
        $components[2] = array(
            null, 'en.wikipedia.org', null, '/wiki/Clich%C3%A9', null
        );
        
        // test distinction between empty query and undefined query (above)
        $uri[3] = 'http://www.example.com/?#';
        $components[3] = array(null, 'www.example.com', null, '/', '');
        
        // path is always defined, even if empty
        $uri[4] = 'http://www.example.com';
        $components[4] = array(null, 'www.example.com', null, '', null);
        
        // test parsing of an opaque URI
        $uri[5] = 'mailto:bob@example.com';
        $components[5] = array(null, null, null, 'bob@example.com', null);
        
        // even though we don't resolve percent entities, we have to fix
        // improper percent-encodes. Taken one at a time:
        // %56 - V, which is an unreserved character
        // %fc - u with an umlaut, normalize to uppercase
        // %GJ - invalid characters in entity, encode %
        // %5 - prematurely terminated, encode %
        // %FC - u with umlaut, correct
        // note that Apache doesn't do such fixing, rather, it just claims
        // that the browser sent a "Bad Request".
        //$uri[6] = 'http://www.example.com/%56%fc%GJ%5%FC';
        //$components[6] = array('www.example.com', '/V%FC%25GJ%255%FC', null, null);
        //$expect_uri[6] = 'http://www.example.com/V%FC%25GJ%255%FC';
        
        // test IPv4 address (behavior may vary with configuration)
        $uri[7] = 'http://192.0.34.166/';
        $components[7] = array(null, '192.0.34.166', null, '/', null);
        
        // while it may look like an IPv4 address, it's really a reg-name.
        // don't destroy it
        $uri[8] = 'http://333.123.32.123/';
        $components[8] = array(null, '333.123.32.123', null, '/', null);
        
        // test IPv6 address, using amended form of RFC's example
        //$uri[9] = 'http://[2001:db8::7]/c=GB?objectClass?one';
        //$components[9] = array('[2001:db8::7]', '/c=GB', 'objectClass?one', null);
        
        // We will not implement punycode encoding, that's up to the browsers
        // We also will not implement percent to IDNA encoding transformations:
        // if you need to use an international domain in a link, make sure that
        // you've got it in UTF-8 and send it in raw (no encoding).
        
        // break the RFC a little and allow international characters
        // WARNING: UTF-8 encoded!
        $uri[10] = 'http://tūdaliņ.lv';
        $components[10] = array(null, 'tūdaliņ.lv', null, '', null);
        
        // test invalid IPv6 address and invalid reg-name
        //$uri[11] = 'http://[2001:0db8:85z3:08d3:1319:8a2e:0370:7334]';
        //$components[11] = array(null, '', null, null);
        
        // test invalid port
        $uri[12] = 'http://example.com:foobar';
        $components[12] = array(null, 'example.com', null, '', null);
        $expect_uri[12] = 'http://example.com';
        
        // test overlarge port (max is 65535, although this isn't official)
        $uri[13] = 'http://example.com:65536';
        $components[13] = array(null, 'example.com', null, '', null);
        $expect_uri[13] = 'http://example.com';
        
        // some spec abnf tests
        
        // "authority . path-abempty" omitted, it is a trivial case
        
        // "path-absolute", note this is different from path-rootless
        $uri[14] = 'http:/this/is/path';
        $components[14] = array(null, null, null, '/this/is/path', null);
        $expect_uri[14] = 'http:/this/is/path'; // do not munge scheme off
        
        // scheme munging is not being tested yet, it's an extra feature
        
        // "path-rootless" - this should not be used but is allowed
        $uri[15] = 'http:this/is/path';
        $components[15] = array(null, null, null, 'this/is/path', null);
        //$expect_uri[15] = 'this/is/path'; // munge scheme off
        
        // "path-empty" - a rather interesting case, remove the scheme
        $uri[16] = 'http:';
        $components[16] = array(null, null, null, '', null);
        //$expect_uri[16] = ''; // munge scheme off
        
        // test invalid scheme, components shouldn't be passed
        $uri[17] = 'javascript:alert("moo");';
        $expect_uri[17] = '';
        
        // relative URIs
        
        // test basic case
        $uri[18] = '/a/b';
        $components[18] = array(null, null, null, '/a/b', null);
        
        foreach ($uri as $i => $value) {
            
            // setUpAssertDef
            if ( isset($components[$i]) ) {
                $this->components = $components[$i];
            } else {
                $this->components = false;
            }
            if ( isset($return_components[$i]) ) {
                $this->return_components = $return_components[$i];
            } else {
                $this->return_components = $this->components;
            }
            
            // parameters
            if (!isset($expect_uri[$i])) {
                $expect_uri[$i] = $value; // untouched
            }
            
            // the read in values
            $this->config  = isset($config[$i])  ? $config[$i]  : null;
            $this->context = isset($context[$i]) ? $context[$i] : null;
            
            $this->assertDef($value, $expect_uri[$i], "Test $i: %s");
            
        }
        
        // reset to regular implementation
        HTMLPurifier_URISchemeRegistry::instance($old_registry);
        
    }
    
    function setUpAssertDef() {
        // $fake_registry isn't the real mock, because due to PHP 4 weirdness
        // I cannot set a default value to function parameters that are passed
        // by reference. So we use the value instance() returns.
        $fake_registry = new HTMLPurifier_URISchemeRegistryMock($this);
        $registry =& HTMLPurifier_URISchemeRegistry::instance($fake_registry);
        
        // now, let's at a pseudo-scheme to the registry
        $this->scheme =& new HTMLPurifier_URISchemeMock($this);
        
        // here are the schemes we will support with overloaded mocks
        $registry->setReturnReference('getScheme', $this->scheme, array('http', $this->config));
        $registry->setReturnReference('getScheme', $this->scheme, array('mailto', $this->config));
        
        // default return value is false (meaning no scheme defined: reject)
        $registry->setReturnValue('getScheme', false, array('*', $this->config));
        
        if ($this->components === false) {
            $this->scheme->expectNever('validateComponents');
        } else {
            $this->components[] = $this->config; // append the configuration
            $this->scheme->setReturnValue(
                'validateComponents', $this->return_components, $this->components);
            $this->scheme->expectOnce('validateComponents', $this->components);
        }
    }
    
    function tearDownAssertDef() {
        $this->scheme->tally();
    }
    
}

?>