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 = $_SERVER['SERVER_SOFTWARE'] ?? null;
  37                 $_SERVER['SERVER_SOFTWARE'] = $server;
  38                 wfUrlencode( null );
  39
  40                 // do the requested test
  41                 $this->assertEquals(
  42                         $expected,
  43                         wfUrlencode( $input ),
  44                         "Encoding '$input' for server '$server' should be '$expected'"
  45                 );
  46
  47                 // restore global
  48                 if ( $old === null ) {
  49                         unset( $_SERVER['SERVER_SOFTWARE'] );
  50                 } else {
  51                         $_SERVER['SERVER_SOFTWARE'] = $old;
  52                 }
  53                 wfUrlencode( null );
  54         }
  55
  56         /**
  57          * Interprets the provider array. Return expected value depending
  58          * the HTTP server name.
  59          */
  60         private function extractExpect( $server, $expectations ) {
  61                 if ( is_string( $expectations ) ) {
  62                         return $expectations;
  63                 } elseif ( is_array( $expectations ) ) {
  64                         if ( !array_key_exists( $server, $expectations ) ) {
  65                                 throw new MWException( __METHOD__ . " expectation does not have any "
  66                                         . "value for server name $server. Check the provider array.\n" );
  67                         } else {
  68                                 return $expectations[$server];
  69                         }
  70                 } else {
  71                         throw new MWException( __METHOD__ . " given invalid expectation for "
  72                                 . "'$server'. Should be a string or an array( <http server name> => <string> ).\n" );
  73                 }
  74         }
  75
  76         # ### PROVIDERS ###########################################################
  77
  78         /**
  79          * Format is either:
  80          *   [ 'input', 'expected' ];
  81          * Or:
  82          *   [ 'input',
  83          *       [ 'Apache', 'expected' ],
  84          *       [ 'Microsoft-IIS/7', 'expected' ],
  85          *   ],
  86          * If you want to add other HTTP server name, you will have to add a new
  87          * testing method much like the testEncodingUrlWith() method above.
  88          */
  89         public static function provideURLS() {
  90                 return [
  91                         # ## RFC 1738 chars
  92                         // + is not safe
  93                         [ '+', '%2B' ],
  94                         // & and = not safe in queries
  95                         [ '&', '%26' ],
  96                         [ '=', '%3D' ],
  97
  98                         [ ':', [
  99                                 'Apache' => ':',
 100                                 'Microsoft-IIS/7' => '%3A',
 101                         ] ],
 102
 103                         // remaining chars do not need encoding
 104                         [
 105                                 ';@$-_.!*',
 106                                 ';@$-_.!*',
 107                         ],
 108
 109                         # ## Other tests
 110                         // slash remain unchanged. %2F seems to break things
 111                         [ '/', '/' ],
 112                         // T105265
 113                         [ '~', '~' ],
 114
 115                         // Other 'funnies' chars
 116                         [ '[]', '%5B%5D' ],
 117                         [ '<>', '%3C%3E' ],
 118
 119                         // Apostrophe is encoded
 120                         [ '\'', '%27' ],
 121                 ];
 122         }
 123 }