tests/phpunit/includes/GlobalFunctions/wfUrlencodeTest.php

   1 <?php
   2
   3 /**
   4  * The function only need a string parameter and might react to IIS7.0
   5  *
   6  * @group GlobalFunctions
   7  * @covers ::wfUrlencode
   8  */
   9 class WfUrlencodeTest extends MediaWikiTestCase {
  10         # ### TESTS ##############################################################
  11
  12         /**
  13          * @dataProvider provideURLS
  14          */
  15         public function testEncodingUrlWith( $input, $expected ) {
  16                 $this->verifyEncodingFor( 'Apache', $input, $expected );
  17         }
  18
  19         /**
  20          * @dataProvider provideURLS
  21          */
  22         public function testEncodingUrlWithMicrosoftIis7( $input, $expected ) {
  23                 $this->verifyEncodingFor( 'Microsoft-IIS/7', $input, $expected );
  24         }
  25
  26         # ### HELPERS #############################################################
  27
  28         /**
  29          * Internal helper that actually run the test.
  30          * Called by the public methods testEncodingUrlWith...()
  31          */
  32         private function verifyEncodingFor( $server, $input, $expectations ) {
  33                 $expected = $this->extractExpect( $server, $expectations );
  34
  35                 // save up global
  36                 $old = isset( $_SERVER['SERVER_SOFTWARE'] )
  37                         ? $_SERVER['SERVER_SOFTWARE']
  38                         : null;
  39                 $_SERVER['SERVER_SOFTWARE'] = $server;
  40                 wfUrlencode( null );
  41
  42                 // do the requested test
  43                 $this->assertEquals(
  44                         $expected,
  45                         wfUrlencode( $input ),
  46                         "Encoding '$input' for server '$server' should be '$expected'"
  47                 );
  48
  49                 // restore global
  50                 if ( $old === null ) {
  51                         unset( $_SERVER['SERVER_SOFTWARE'] );
  52                 } else {
  53                         $_SERVER['SERVER_SOFTWARE'] = $old;
  54                 }
  55                 wfUrlencode( null );
  56         }
  57
  58         /**
  59          * Interprets the provider array. Return expected value depending
  60          * the HTTP server name.
  61          */
  62         private function extractExpect( $server, $expectations ) {
  63                 if ( is_string( $expectations ) ) {
  64                         return $expectations;
  65                 } elseif ( is_array( $expectations ) ) {
  66                         if ( !array_key_exists( $server, $expectations ) ) {
  67                                 throw new MWException( __METHOD__ . " expectation does not have any "
  68                                         . "value for server name $server. Check the provider array.\n" );
  69                         } else {
  70                                 return $expectations[$server];
  71                         }
  72                 } else {
  73                         throw new MWException( __METHOD__ . " given invalid expectation for "
  74                                 . "'$server'. Should be a string or an array( <http server name> => <string> ).\n" );
  75                 }
  76         }
  77
  78         # ### PROVIDERS ###########################################################
  79
  80         /**
  81          * Format is either:
  82          *   [ 'input', 'expected' ];
  83          * Or:
  84          *   [ 'input',
  85          *       [ 'Apache', 'expected' ],
  86          *       [ 'Microsoft-IIS/7', 'expected' ],
  87          *   ],
  88          * If you want to add other HTTP server name, you will have to add a new
  89          * testing method much like the testEncodingUrlWith() method above.
  90          */
  91         public static function provideURLS() {
  92                 return [
  93                         # ## RFC 1738 chars
  94                         // + is not safe
  95                         [ '+', '%2B' ],
  96                         // & and = not safe in queries
  97                         [ '&', '%26' ],
  98                         [ '=', '%3D' ],
  99
 100                         [ ':', [
 101                                 'Apache' => ':',
 102                                 'Microsoft-IIS/7' => '%3A',
 103                         ] ],
 104
 105                         // remaining chars do not need encoding
 106                         [
 107                                 ';@$-_.!*',
 108                                 ';@$-_.!*',
 109                         ],
 110
 111                         # ## Other tests
 112                         // slash remain unchanged. %2F seems to break things
 113                         [ '/', '/' ],
 114                         // T105265
 115                         [ '~', '~' ],
 116
 117                         // Other 'funnies' chars
 118                         [ '[]', '%5B%5D' ],
 119                         [ '<>', '%3C%3E' ],
 120
 121                         // Apostrophe is encoded
 122                         [ '\'', '%27' ],
 123                 ];
 124         }
 125 }