Merge "Change if/else to a ternary operator"
[lhc/web/wiklou.git] / includes / WebRequest.php
index 2abc3d2..87526fc 100644 (file)
@@ -62,17 +62,22 @@ class WebRequest {
        }
 
        /**
-        * Extract the PATH_INFO variable even when it isn't a reasonable
-        * value. On some large webhosts, PATH_INFO includes the script
-        * path as well as everything after it.
+        * Extract relevant query arguments from the http request uri's path
+        * to be merged with the normal php provided query arguments.
+        * Tries to use the REQUEST_URI data if available and parses it
+        * according to the wiki's configuration looking for any known pattern.
+        *
+        * If the REQUEST_URI is not provided we'll fall back on the PATH_INFO
+        * provided by the server if any and use that to set a 'title' parameter.
         *
         * @param $want string: If this is not 'all', then the function
         * will return an empty array if it determines that the URL is
         * inside a rewrite path.
         *
-        * @return Array: 'title' key is the title of the article.
+        * @return Array: Any query arguments found in path matches.
         */
        static public function getPathInfo( $want = 'all' ) {
+               global $wgUsePathInfo;
                // PATH_INFO is mangled due to http://bugs.php.net/bug.php?id=31892
                // And also by Apache 2.x, double slashes are converted to single slashes.
                // So we will use REQUEST_URI if possible.
@@ -93,40 +98,54 @@ class WebRequest {
                                        // Abort to keep from breaking...
                                        return $matches;
                                }
+
+                               $router = new PathRouter;
+
                                // Raw PATH_INFO style
-                               $matches = self::extractTitle( $path, "$wgScript/$1" );
+                               $router->add( "$wgScript/$1" );
+
+                               if( isset( $_SERVER['SCRIPT_NAME'] )
+                                       && preg_match( '/\.php5?/', $_SERVER['SCRIPT_NAME'] ) )
+                               {
+                                       # Check for SCRIPT_NAME, we handle index.php explicitly
+                                       # But we do have some other .php files such as img_auth.php
+                                       # Don't let root article paths clober the parsing for them
+                                       $router->add( $_SERVER['SCRIPT_NAME'] . "/$1" );
+                               }
 
                                global $wgArticlePath;
-                               if( !$matches && $wgArticlePath ) {
-                                       $matches = self::extractTitle( $path, $wgArticlePath );
+                               if( $wgArticlePath ) {
+                                       $router->add( $wgArticlePath );
                                }
 
                                global $wgActionPaths;
-                               if( !$matches && $wgActionPaths ) {
-                                       $matches = self::extractTitle( $path, $wgActionPaths, 'action' );
+                               if( $wgActionPaths ) {
+                                       $router->add( $wgActionPaths, array( 'action' => '$key' ) );
                                }
 
                                global $wgVariantArticlePath, $wgContLang;
-                               if( !$matches && $wgVariantArticlePath ) {
-                                       $variantPaths = array();
-                                       foreach( $wgContLang->getVariants() as $variant ) {
-                                               $variantPaths[$variant] =
-                                                       str_replace( '$2', $variant, $wgVariantArticlePath );
-                                       }
-                                       $matches = self::extractTitle( $path, $variantPaths, 'variant' );
+                               if( $wgVariantArticlePath ) {
+                                       $router->add( $wgVariantArticlePath,
+                                               array( 'variant' => '$2'),
+                                               array( '$2' => $wgContLang->getVariants() )
+                                       );
                                }
 
-                               wfRunHooks( 'WebRequestGetPathInfoRequestURI', array( $path, &$matches ) );
+                               wfRunHooks( 'WebRequestPathInfoRouter', array( $router ) );
+
+                               $matches = $router->parse( $path );
+                       }
+               } elseif ( $wgUsePathInfo ) {
+                       if ( isset( $_SERVER['ORIG_PATH_INFO'] ) && $_SERVER['ORIG_PATH_INFO'] != '' ) {
+                               // Mangled PATH_INFO
+                               // http://bugs.php.net/bug.php?id=31892
+                               // Also reported when ini_get('cgi.fix_pathinfo')==false
+                               $matches['title'] = substr( $_SERVER['ORIG_PATH_INFO'], 1 );
+
+                       } elseif ( isset( $_SERVER['PATH_INFO'] ) && ($_SERVER['PATH_INFO'] != '') ) {
+                               // Regular old PATH_INFO yay
+                               $matches['title'] = substr( $_SERVER['PATH_INFO'], 1 );
                        }
-               } elseif ( isset( $_SERVER['ORIG_PATH_INFO'] ) && $_SERVER['ORIG_PATH_INFO'] != '' ) {
-                       // Mangled PATH_INFO
-                       // http://bugs.php.net/bug.php?id=31892
-                       // Also reported when ini_get('cgi.fix_pathinfo')==false
-                       $matches['title'] = substr( $_SERVER['ORIG_PATH_INFO'], 1 );
-
-               } elseif ( isset( $_SERVER['PATH_INFO'] ) && ($_SERVER['PATH_INFO'] != '') ) {
-                       // Regular old PATH_INFO yay
-                       $matches['title'] = substr( $_SERVER['PATH_INFO'], 1 );
                }
 
                return $matches;
@@ -190,18 +209,14 @@ class WebRequest {
         * available variant URLs.
         */
        public function interpolateTitle() {
-               global $wgUsePathInfo;
-
                // bug 16019: title interpolation on API queries is useless and sometimes harmful
                if ( defined( 'MW_API' ) ) {
                        return;
                }
 
-               if ( $wgUsePathInfo ) {
-                       $matches = self::getPathInfo( 'title' );
-                       foreach( $matches as $key => $val) {
-                               $this->data[$key] = $_GET[$key] = $_REQUEST[$key] = $val;
-                       }
+               $matches = self::getPathInfo( 'title' );
+               foreach( $matches as $key => $val) {
+                       $this->data[$key] = $_GET[$key] = $_REQUEST[$key] = $val;
                }
        }
 
@@ -239,15 +254,18 @@ class WebRequest {
         * used for undoing the evil that is magic_quotes_gpc.
         *
         * @param $arr array: will be modified
-        * @param $recursion bool Used to modify behaviour based on recursion
+        * @param $topLevel bool Specifies if the array passed is from the top
+        * level of the source. In PHP5 magic_quotes only escapes the first level
+        * of keys that belong to an array.
         * @return array the original array
+        * @see http://www.php.net/manual/en/function.get-magic-quotes-gpc.php#49612
         */
-       private function &fix_magic_quotes( &$arr, $recursion = false ) {
+       private function &fix_magic_quotes( &$arr, $topLevel = true ) {
                $clean = array();
                foreach( $arr as $key => $val ) {
                        if( is_array( $val ) ) {
-                               $cleanKey = !$recursion ? stripslashes( $key ) : $key;
-                               $clean[$cleanKey] = $this->fix_magic_quotes( $arr[$key], true );
+                               $cleanKey = $topLevel ? stripslashes( $key ) : $key;
+                               $clean[$cleanKey] = $this->fix_magic_quotes( $arr[$key], false );
                        } else {
                                $cleanKey = stripslashes( $key );
                                $clean[$cleanKey] = stripslashes( $val );
@@ -279,8 +297,8 @@ class WebRequest {
        /**
         * Recursively normalizes UTF-8 strings in the given array.
         *
-        * @param $data string or array
-        * @return cleaned-up version of the given
+        * @param $data string|array
+        * @return array|string cleaned-up version of the given
         * @private
         */
        function normalizeUnicode( $data ) {
@@ -360,6 +378,23 @@ class WebRequest {
                return $ret;
        }
 
+       
+       /**
+        * Unset an arbitrary value from our get/post data.
+        *
+        * @param $key String: key name to use
+        * @return Mixed: old value if one was present, null otherwise
+        */
+       public function unsetVal( $key ) {
+               if ( !isset( $this->data[$key] ) ) {
+                       $ret = null;
+               } else {
+                       $ret = $this->data[$key];
+                       unset( $this->data[$key] );
+               }
+               return $ret;
+       }
+
        /**
         * Fetch an array from the input or return $default if it's not set.
         * If source was scalar, will return an array with a single element.
@@ -499,7 +534,7 @@ class WebRequest {
 
                $retVal = array();
                foreach ( $names as $name ) {
-                       $value = $this->getVal( $name );
+                       $value = $this->getGPCVal( $this->data, $name, null );
                        if ( !is_null( $value ) ) {
                                $retVal[$name] = $value;
                        }
@@ -524,7 +559,7 @@ class WebRequest {
         * @return Array
         */
         public function getQueryValues() {
-               return $_GET;
+               return $_GET;
         }
 
        /**
@@ -636,6 +671,7 @@ class WebRequest {
 
        /**
         * HTML-safe version of appendQuery().
+        * @deprecated: Deprecated in 1.20, warnings in 1.21, remove in 1.22.
         *
         * @param $query String: query string fragment; do not include initial '?'
         * @return String
@@ -724,6 +760,7 @@ class WebRequest {
         * @return integer
         */
        public function getFileSize( $key ) {
+               wfDeprecated( __METHOD__, '1.17' );
                $file = new WebRequestUpload( $this, $key );
                return $file->getSize();
        }
@@ -818,7 +855,7 @@ class WebRequest {
         * Get a request header, or false if it isn't set
         * @param $name String: case-insensitive header name
         *
-        * @return string|false
+        * @return string|bool False on failure
         */
        public function getHeader( $name ) {
                $this->initHeaders();
@@ -936,6 +973,7 @@ HTML;
         * @return bool
         */
        public function isPathInfoBad( $extWhitelist = array() ) {
+               wfDeprecated( __METHOD__, '1.17' );
                global $wgScriptExtension;
                $extWhitelist[] = ltrim( $wgScriptExtension, '.' );
                return IEUrlExtension::areServerVarsBad( $_SERVER, $extWhitelist );
@@ -943,9 +981,11 @@ HTML;
 
        /**
         * Parse the Accept-Language header sent by the client into an array
-        * @return array( languageCode => q-value ) sorted by q-value in descending order
+        * @return array array( languageCode => q-value ) sorted by q-value in descending order then
+        *                                                appearing time in the header in ascending order.
         * May contain the "language" '*', which applies to languages other than those explicitly listed.
         * This is aligned with rfc2616 section 14.4
+        * Preference for earlier languages appears in rfc3282 as an extension to HTTP/1.1.
         */
        public function getAcceptLang() {
                // Modified version of code found at http://www.thefutureoftheweb.com/blog/use-accept-language-header
@@ -959,32 +999,40 @@ HTML;
 
                // Break up string into pieces (languages and q factors)
                $lang_parse = null;
-               preg_match_all( '/([a-z]{1,8}(-[a-z]{1,8})?|\*)\s*(;\s*q\s*=\s*(1|0(\.[0-9]+)?)?)?/',
+               preg_match_all( '/([a-z]{1,8}(-[a-z]{1,8})*|\*)\s*(;\s*q\s*=\s*(1(\.0{0,3})?|0(\.[0-9]{0,3})?)?)?/',
                        $acceptLang, $lang_parse );
 
                if ( !count( $lang_parse[1] ) ) {
                        return array();
                }
 
-               // Create a list like "en" => 0.8
-               $langs = array_combine( $lang_parse[1], $lang_parse[4] );
+               $langcodes = $lang_parse[1];
+               $qvalues = $lang_parse[4];
+               $indices = range( 0, count( $lang_parse[1] ) - 1 );
+
                // Set default q factor to 1
-               foreach ( $langs as $lang => $val ) {
-                       if ( $val === '' ) {
-                               $langs[$lang] = 1;
-                       } elseif ( $val == 0 ) {
-                               unset($langs[$lang]);
+               foreach ( $indices as $index ) {
+                       if ( $qvalues[$index] === '' ) {
+                               $qvalues[$index] = 1;
+                       } elseif ( $qvalues[$index] == 0 ) {
+                               unset( $langcodes[$index], $qvalues[$index], $indices[$index] );
                        }
                }
 
-               // Sort list
-               arsort( $langs, SORT_NUMERIC );
+               // Sort list. First by $qvalues, then by order. Reorder $langcodes the same way
+               array_multisort( $qvalues, SORT_DESC, SORT_NUMERIC, $indices, $langcodes );
+
+               // Create a list like "en" => 0.8
+               $langs = array_combine( $langcodes, $qvalues );
+
                return $langs;
        }
 
        /**
         * Fetch the raw IP from the request
         *
+        * @since 1.19
+        *
         * @return String
         */
        protected function getRawIP() {
@@ -998,6 +1046,9 @@ HTML;
        /**
         * Work out the IP address based on various globals
         * For trusted proxies, use the XFF client IP (first of the chain)
+        * 
+        * @since 1.19
+        *
         * @return string
         */
        public function getIP() {
@@ -1178,7 +1229,7 @@ class FauxRequest extends WebRequest {
         * @param $wasPosted Bool: whether to treat the data as POST
         * @param $session Mixed: session array or null
         */
-       public function __construct( $data, $wasPosted = false, $session = null ) {
+       public function __construct( $data = array(), $wasPosted = false, $session = null ) {
                if( is_array( $data ) ) {
                        $this->data = $data;
                } else {
@@ -1189,6 +1240,10 @@ class FauxRequest extends WebRequest {
                        $this->session = $session;
        }
 
+       /**
+        * @param $method string
+        * @throws MWException
+        */
        private function notImplemented( $method ) {
                throw new MWException( "{$method}() not implemented" );
        }
@@ -1252,15 +1307,26 @@ class FauxRequest extends WebRequest {
                $this->headers[$name] = $val;
        }
 
+       /**
+        * @param $key
+        * @return mixed
+        */
        public function getSessionData( $key ) {
                if( isset( $this->session[$key] ) )
                        return $this->session[$key];
        }
 
+       /**
+        * @param $key
+        * @param $data
+        */
        public function setSessionData( $key, $data ) {
                $this->session[$key] = $data;
        }
 
+       /**
+        * @return array|Mixed|null
+        */
        public function getSessionArray() {
                return $this->session;
        }
@@ -1288,3 +1354,52 @@ class FauxRequest extends WebRequest {
                return '127.0.0.1';
        }
 }
+
+/**
+ * Similar to FauxRequest, but only fakes URL parameters and method
+ * (POST or GET) and use the base request for the remaining stuff
+ * (cookies, session and headers).
+ *
+ * @ingroup HTTP
+ * @since 1.19
+ */
+class DerivativeRequest extends FauxRequest {
+       private $base;
+
+       public function __construct( WebRequest $base, $data, $wasPosted = false ) {
+               $this->base = $base;
+               parent::__construct( $data, $wasPosted );
+       }
+
+       public function getCookie( $key, $prefix = null, $default = null ) {
+               return $this->base->getCookie( $key, $prefix, $default );
+       }
+
+       public function checkSessionCookie() {
+               return $this->base->checkSessionCookie();
+       }
+
+       public function getHeader( $name ) {
+               return $this->base->getHeader( $name );
+       }
+
+       public function getAllHeaders() {
+               return $this->base->getAllHeaders();
+       }
+
+       public function getSessionData( $key ) {
+               return $this->base->getSessionData( $key );
+       }
+
+       public function setSessionData( $key, $data ) {
+               $this->base->setSessionData( $key, $data );
+       }
+
+       public function getAcceptLang() {
+               return $this->base->getAcceptLang();
+       }
+
+       public function getIP() {
+               return $this->base->getIP();
+       }
+}