wfUrlencodeTest.php

Go to the documentation of this file.

<?php
 
class WfUrlencodeTest extends MediaWikiTestCase {
    # ### TESTS ##############################################################
 
    public function testEncodingUrlWith( $input, $expected ) {
        $this->verifyEncodingFor( 'Apache', $input, $expected );
    }
 
    public function testEncodingUrlWithMicrosoftIis7( $input, $expected ) {
        $this->verifyEncodingFor( 'Microsoft-IIS/7', $input, $expected );
    }
 
    # ### HELPERS #############################################################
 
    private function verifyEncodingFor( $server, $input, $expectations ) {
        $expected = $this->extractExpect( $server, $expectations );
 
        // save up global
        $old = $_SERVER['SERVER_SOFTWARE'] ?? null;
        $_SERVER['SERVER_SOFTWARE'] = $server;
        wfUrlencode( null );
 
        // do the requested test
        $this->assertEquals(
            $expected,
            wfUrlencode( $input ),
            "Encoding '$input' for server '$server' should be '$expected'"
        );
 
        // restore global
        if ( $old === null ) {
            unset( $_SERVER['SERVER_SOFTWARE'] );
        } else {
            $_SERVER['SERVER_SOFTWARE'] = $old;
        }
        wfUrlencode( null );
    }
 
    private function extractExpect( $server, $expectations ) {
        if ( is_string( $expectations ) ) {
            return $expectations;
        } elseif ( is_array( $expectations ) ) {
            if ( !array_key_exists( $server, $expectations ) ) {
                throw new MWException( __METHOD__ . " expectation does not have any "
                    . "value for server name $server. Check the provider array.\n" );
            } else {
                return $expectations[$server];
            }
        } else {
            throw new MWException( __METHOD__ . " given invalid expectation for "
                . "'$server'. Should be a string or an array( <http server name> => <string> ).\n" );
        }
    }
 
    # ### PROVIDERS ###########################################################
 
    public static function provideURLS() {
        return [
            # ## RFC 1738 chars
            // + is not safe
            [ '+', '%2B' ],
            // & and = not safe in queries
            [ '&', '%26' ],
            [ '=', '%3D' ],
 
            [ ':', [
                'Apache' => ':',
                'Microsoft-IIS/7' => '%3A',
            ] ],
 
            // remaining chars do not need encoding
            [
                ';@$-_.!*',
                ';@$-_.!*',
            ],
 
            # ## Other tests
            // slash remain unchanged. %2F seems to break things
            [ '/', '/' ],
            // T105265
            [ '~', '~' ],
 
            // Other 'funnies' chars
            [ '[]', '%5B%5D' ],
            [ '<>', '%3C%3E' ],
 
            // Apostrophe is encoded
            [ '\'', '%27' ],
        ];
    }
}