WebRequest.php

Go to the documentation of this file.

<?php
# Deal with importing all those nasssty globals and things
# 
# Copyright (C) 2003 Brion Vibber <brion@pobox.com>
# http://www.mediawiki.org/
# 
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or 
# (at your option) any later version.
# 
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
# 
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
# http://www.gnu.org/copyleft/gpl.html

# Hypothetically, we could use a WebRequest object to fake a
# self-contained request.

## Enable this to debug total elimination of register_globals
#define( "DEBUG_GLOBALS", 1 );

class WebRequest {
        function WebRequest() {
                if( defined('DEBUG_GLOBALS') ) error_reporting(E_ALL);

                $this->checkMagicQuotes();
                $this->checkRegisterGlobals();
        }

        function &fix_magic_quotes( &$arr ) {
                foreach( $arr as $key => $val ) {
                        if( is_array( $val ) ) {
                                $this->fix_magic_quotes( $arr[$key] );
                        } else {
                                $arr[$key] = stripslashes( $val );
                        }
                }
                return $arr;
        }
        
        function checkMagicQuotes() {
                if ( get_magic_quotes_gpc() ) {
                        $this->fix_magic_quotes( $_COOKIE );
                        $this->fix_magic_quotes( $_ENV );
                        $this->fix_magic_quotes( $_GET );
                        $this->fix_magic_quotes( $_POST );
                        $this->fix_magic_quotes( $_REQUEST );
                        $this->fix_magic_quotes( $_SERVER );
                } elseif( defined('DEBUG_GLOBALS') ) {
                        die("DEBUG_GLOBALS: turn on magic_quotes_gpc" );
                }
        }

        function checkRegisterGlobals() {
                if( ini_get( "register_globals" ) ) {
                        if( defined( "DEBUG_GLOBALS" ) ) {
                                die( "DEBUG_GLOBALS: Turn register_globals off!" );
                        }
                }
                /*
                else {
                        if( !defined( "DEBUG_GLOBALS" ) ) {
                                # Insecure, but at least it'll run
                                import_request_variables( "GPC" );
                        }
                }
                */
        }
        
        function getGPCVal( &$arr, $name, $default ) {
                if( isset( $arr[$name] ) ) {
                        return $arr[$name];
                } else {
                        return $default;
                }
        }
        
        function getGPCText( &$arr, $name, $default ) {
                # Text fields may be in an alternate encoding which we should check.
                # Also, strip CRLF line endings down to LF to achieve consistency.
                global $wgLang;
                if( isset( $arr[$name] ) ) {
                        return str_replace( "\r\n", "\n", $wgLang->recodeInput( $arr[$name] ) );
                } else {
                        return $default;
                }
        }
        
        function getVal( $name, $default = NULL ) {
                return $this->getGPCVal( $_REQUEST, $name, $default );
        }
        
        function getInt( $name, $default = 0 ) {
                return IntVal( $this->getVal( $name, $default ) );
        }
        
        function getBool( $name, $default = false ) {
                return $this->getVal( $name, $default ) ? true : false;
        }
        
        function getCheck( $name ) {
                # Checkboxes and buttons are only present when clicked
                # Presence connotes truth, abscense false
                $val = $this->getVal( $name, NULL );
                return isset( $val );
        }
        
        function getText( $name, $default = "" ) {
                return $this->getGPCText( $_REQUEST, $name, $default );
        }
        
        function getValues() {  
                $names = func_get_args();
                $retVal = array();
                foreach ( $names as $name ) { 
                        $value = $this->getVal( $name );
                        if ( !is_null( $value ) ) {
                                $retVal[$name] = $value;
                        }
                }
                return $retVal;
        }

        function wasPosted() {
                return $_SERVER['REQUEST_METHOD'] == 'POST';
        }
        
        function checkSessionCookie() {
                return isset( $_COOKIE[ini_get("session.name")] );
        }
        
        function getRequestURL() {
                return $_SERVER['REQUEST_URI'];
        }
        
        function getFullRequestURL() {
                global $wgServer;
                return $wgServer . $this->getRequestURL();
        }
        
        # Take an arbitrary query and rewrite the present URL to include it
        function appendQuery( $query ) {
                global $wgTitle;
                $basequery = "";
                foreach( $_GET as $var => $val ) {
                        if( $var == "title" ) continue;
                        $basequery .= "&" . urlencode( $var ) . "=" . urlencode( $val );
                }
                $basequery .= "&" . $query;
                
                # Trim the extra &
                $basequery = substr( $basequery, 1 );
                return $wgTitle->getLocalURL( $basequery );
        }
        
        function escapeAppendQuery( $query ) {
                return htmlspecialchars( $this->appendQuery( $query ) );
        }
        
}

?>

---