Files
pae.co.at/trunk/proactiveenglish/lib/symfony/request/sfWebRequest.class.php
2017-03-02 21:57:21 -06:00

955 lines
24 KiB
PHP

<?php
/*
* This file is part of the symfony package.
* (c) 2004-2006 Fabien Potencier <fabien.potencier@symfony-project.com>
* (c) 2004-2006 Sean Kerr <sean@code-box.org>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
/**
* sfWebRequest class.
*
* This class manages web requests. It parses input from the request and store them as parameters.
* sfWebRequest is able to parse request with routing support enabled.
*
* @package symfony
* @subpackage request
* @author Fabien Potencier <fabien.potencier@symfony-project.com>
* @author Sean Kerr <sean@code-box.org>
* @version SVN: $Id: sfWebRequest.class.php 8817 2008-05-06 19:47:16Z fabien $
*/
class sfWebRequest extends sfRequest
{
/**
* A list of languages accepted by the browser.
* @var array
*/
protected $languages = null;
/**
* A list of charsets accepted by the browser
* @var array
*/
protected $charsets = null;
/**
* @var array List of content types accepted by the client.
*/
protected $acceptableContentTypes = null;
protected $pathInfoArray = null;
protected $relativeUrlRoot = null;
protected $filesInfos;
/**
* Retrieves an array of file information.
*
* @param string A file name
*
* @return array An associative array of file information, if the file exists, otherwise null
*/
public function getFile($name)
{
return ($this->hasFile($name) ? $this->getFileValues($name) : null);
}
/**
* Retrieves a file error.
*
* @param string A file name
*
* @return int One of the following error codes:
*
* - <b>UPLOAD_ERR_OK</b> (no error)
* - <b>UPLOAD_ERR_INI_SIZE</b> (the uploaded file exceeds the
* upload_max_filesize directive
* in php.ini)
* - <b>UPLOAD_ERR_FORM_SIZE</b> (the uploaded file exceeds the
* MAX_FILE_SIZE directive that
* was specified in the HTML form)
* - <b>UPLOAD_ERR_PARTIAL</b> (the uploaded file was only
* partially uploaded)
* - <b>UPLOAD_ERR_NO_FILE</b> (no file was uploaded)
*/
public function getFileError($name)
{
return ($this->hasFile($name) ? $this->getFileValue($name, 'error') : UPLOAD_ERR_NO_FILE);
}
/**
* Retrieves a file name.
*
* @param string A file nam.
*
* @return string A file name, if the file exists, otherwise null
*/
public function getFileName($name)
{
return ($this->hasFile($name) ? $this->getFileValue($name, 'name') : null);
}
/**
* Retrieves an array of file names.
*
* @return array An indexed array of file names
*/
public function getFileNames()
{
return array_keys($_FILES);
}
/**
* Retrieves an array of files.
*
* @return array An associative array of files
*/
public function getFiles()
{
return $_FILES;
}
/**
* Retrieves a file path.
*
* @param string A file name
*
* @return string A file path, if the file exists, otherwise null
*/
public function getFilePath($name)
{
return ($this->hasFile($name) ? $this->getFileValue($name, 'tmp_name') : null);
}
/**
* Retrieve a file size.
*
* @param string A file name
*
* @return int A file size, if the file exists, otherwise null
*/
public function getFileSize($name)
{
return ($this->hasFile($name) ? $this->getFileValue($name, 'size') : null);
}
/**
* Retrieves a file type.
*
* This may not be accurate. This is the mime-type sent by the browser
* during the upload.
*
* @param string A file name
*
* @return string A file type, if the file exists, otherwise null
*/
public function getFileType($name)
{
return ($this->hasFile($name) ? $this->getFileValue($name, 'type') : null);
}
/**
* Indicates whether or not a file exists.
*
* @param string A file name
*
* @return boolean true, if the file exists, otherwise false
*/
public function hasFile($name)
{
if (strpos($name, '['))
{
return !is_null(sfToolkit::getArrayValueForPath($this->filesInfos, $name));
}
else
{
return isset($this->filesInfos[$name]);
}
}
/**
* Indicates whether or not a file error exists.
*
* @param string A file name
*
* @return boolean true, if the file error exists, otherwise false
*/
public function hasFileError($name)
{
return ($this->hasFile($name) ? ($this->getFileValue($name, 'error') != UPLOAD_ERR_OK) : false);
}
/**
* Indicates whether or not any file errors occured.
*
* @return boolean true, if any file errors occured, otherwise false
*/
public function hasFileErrors()
{
foreach ($this->getFileNames() as $name)
{
if ($this->hasFileError($name) === true)
{
return true;
}
}
return false;
}
/**
* Indicates whether or not any files exist.
*
* @return boolean true, if any files exist, otherwise false
*/
public function hasFiles()
{
return (count($_FILES) > 0);
}
/**
* Retrieves a file value.
*
* @param string A file name
* @param string Value to search in the file
*
* @return string File value
*/
public function getFileValue($name, $key)
{
$fileInfos = $this->getFileValues($name);
return isset($fileInfos[$key]) ? $fileInfos[$key] : null;
}
/**
* Retrieves all the values from a file.
*
* @param string A file name
*
* @return array Associative list of the file values
*/
public function getFileValues($name)
{
if (strpos($name, '['))
{
return sfToolkit::getArrayValueForPath($this->filesInfos, $name);
}
else
{
return isset($this->filesInfos[$name]) ? $this->filesInfos[$name] : null;
}
}
/**
* Converts uploaded file array to a format following the $_GET and $POST naming convention.
*
* It's safe to pass an already converted array, in which case this method just returns the original array unmodified.
*
* @param array An array representing uploaded file information
*
* @return array An array of re-ordered uploaded file information
*/
protected function convertFileInformation($taintedFiles)
{
return $this->pathsToArray(preg_replace('#^(/[^/]+)?(/name|/type|/tmp_name|/error|/size)([^\s]*)( = [^\n]*)#m', '$1$3$2$4', $this->arrayToPaths($taintedFiles)));
}
/**
* Retrieves an extension for a given file.
*
* @param string A file name
*
* @return string Extension for the file
*/
public function getFileExtension($name)
{
static $mimeTypes = null;
$fileType = $this->getFileType($name);
if (!$fileType)
{
return '.bin';
}
if (is_null($mimeTypes))
{
$mimeTypes = unserialize(file_get_contents(sfConfig::get('sf_symfony_data_dir').'/data/mime_types.dat'));
}
return isset($mimeTypes[$fileType]) ? '.'.$mimeTypes[$fileType] : '.bin';
}
/**
* Initializes this sfRequest.
*
* @param sfContext A sfContext instance
* @param array An associative array of initialization parameters
* @param array An associative array of initialization attributes
*
* @return boolean true, if initialization completes successfully, otherwise false
*
* @throws <b>sfInitializationException</b> If an error occurs while initializing this Request
*/
public function initialize($context, $parameters = array(), $attributes = array())
{
parent::initialize($context, $parameters, $attributes);
if (isset($_SERVER['REQUEST_METHOD']))
{
switch ($_SERVER['REQUEST_METHOD'])
{
case 'GET':
$this->setMethod(self::GET);
break;
case 'POST':
$this->setMethod(self::POST);
break;
case 'PUT':
$this->setMethod(self::PUT);
break;
case 'DELETE':
$this->setMethod(self::DELETE);
break;
case 'HEAD':
$this->setMethod(self::HEAD);
break;
default:
$this->setMethod(self::GET);
}
}
else
{
// set the default method
$this->setMethod(self::GET);
}
// load parameters from GET/PATH_INFO/POST
$this->loadParameters();
}
/**
* Returns the array that contains all request information ($_SERVER or $_ENV).
*
* This information is stored in the [sf_path_info_array] constant.
*
* @return array Path information
*/
protected function getPathInfoArray()
{
if (!$this->pathInfoArray)
{
// parse PATH_INFO
switch (sfConfig::get('sf_path_info_array'))
{
case 'SERVER':
$this->pathInfoArray =& $_SERVER;
break;
case 'ENV':
default:
$this->pathInfoArray =& $_ENV;
}
}
return $this->pathInfoArray;
}
/**
* Retrieves the uniform resource identifier for the current web request.
*
* @return string Unified resource identifier
*/
public function getUri()
{
$pathArray = $this->getPathInfoArray();
if ($this->isAbsUri())
{
return $pathArray['REQUEST_URI'];
}
return $this->getUriPrefix().$pathArray['REQUEST_URI'];
}
/**
* See if the client is using absolute uri
*
* @return boolean true, if is absolute uri otherwise false
*/
public function isAbsUri()
{
$pathArray = $this->getPathInfoArray();
return preg_match('/^http/', $pathArray['REQUEST_URI']);
}
/**
* Returns Uri prefix, including protocol, hostname and server port.
*
* @return string Uniform resource identifier prefix
*/
public function getUriPrefix()
{
$pathArray = $this->getPathInfoArray();
if ($this->isSecure())
{
$standardPort = '443';
$proto = 'https';
}
else
{
$standardPort = '80';
$proto = 'http';
}
$port = $pathArray['SERVER_PORT'] == $standardPort || !$pathArray['SERVER_PORT'] ? '' : ':'.$pathArray['SERVER_PORT'];
return $proto.'://'.$pathArray['SERVER_NAME'].$port;
}
/**
* Retrieves the path info for the current web request.
*
* @return string Path info
*/
public function getPathInfo()
{
$pathInfo = '';
$pathArray = $this->getPathInfoArray();
// simulate PATH_INFO if needed
$sf_path_info_key = sfConfig::get('sf_path_info_key');
if (!isset($pathArray[$sf_path_info_key]) || !$pathArray[$sf_path_info_key])
{
if (isset($pathArray['REQUEST_URI']))
{
$script_name = $this->getScriptName();
$uri_prefix = $this->isAbsUri() ? $this->getUriPrefix() : '';
$pathInfo = preg_replace('/^'.preg_quote($uri_prefix, '/').'/','',$pathArray['REQUEST_URI']);
$pathInfo = preg_replace('/^'.preg_quote($script_name, '/').'/', '', $pathInfo);
$prefix_name = preg_replace('#/[^/]+$#', '', $script_name);
$pathInfo = preg_replace('/^'.preg_quote($prefix_name, '/').'/', '', $pathInfo);
$pathInfo = preg_replace('/'.preg_quote($pathArray['QUERY_STRING'], '/').'$/', '', $pathInfo);
}
}
else
{
$pathInfo = $pathArray[$sf_path_info_key];
if ($sf_relative_url_root = $this->getRelativeUrlRoot())
{
$pathInfo = preg_replace('/^'.str_replace('/', '\\/', $sf_relative_url_root).'\//', '', $pathInfo);
}
}
// for IIS
if (isset($_SERVER['SERVER_SOFTWARE']) && false !== stripos($_SERVER['SERVER_SOFTWARE'], 'iis') && $pos = stripos($pathInfo, '.php'))
{
$pathInfo = substr($pathInfo, $pos + 4);
}
if (!$pathInfo)
{
$pathInfo = '/';
}
return $pathInfo;
}
/**
* Loads GET, PATH_INFO and POST data into the parameter list.
*
*/
protected function loadParameters()
{
// merge GET parameters
if (get_magic_quotes_gpc())
{
$_GET = sfToolkit::stripslashesDeep($_GET);
}
$this->getParameterHolder()->addByRef($_GET);
$pathInfo = $this->getPathInfo();
if ($pathInfo)
{
// routing map defined?
$r = sfRouting::getInstance();
if ($r->hasRoutes())
{
$results = $r->parse($pathInfo);
if ($results !== null)
{
$this->getParameterHolder()->addByRef($results);
}
else
{
$this->setParameter('module', sfConfig::get('sf_error_404_module'));
$this->setParameter('action', sfConfig::get('sf_error_404_action'));
}
}
else
{
$array = explode('/', trim($pathInfo, '/'));
$count = count($array);
for ($i = 0; $i < $count; $i++)
{
// see if there's a value associated with this parameter,
// if not we're done with path data
if ($count > ($i + 1))
{
$this->getParameterHolder()->setByRef($array[$i], $array[++$i]);
}
}
}
}
$this->filesInfos = $this->convertFileInformation($_FILES);
// merge POST parameters
if (get_magic_quotes_gpc())
{
$_POST = sfToolkit::stripslashesDeep((array) $_POST);
}
$this->getParameterHolder()->addByRef($_POST);
// move symfony parameters in a protected namespace (parameters prefixed with _sf_)
foreach ($this->getParameterHolder()->getAll() as $key => $value)
{
if (0 === stripos($key, '_sf_'))
{
$this->getParameterHolder()->remove($key);
$this->setParameter($key, $value, 'symfony/request/sfWebRequest');
unset($_GET[$key]);
}
}
if (sfConfig::get('sf_logging_enabled'))
{
$this->getContext()->getLogger()->info(sprintf('{sfRequest} request parameters %s', str_replace("\n", '', var_export($this->getParameterHolder()->getAll(), true))));
}
}
/**
* Moves an uploaded file.
*
* @param string A file name
* @param string An absolute filesystem path to where you would like the
* file moved. This includes the new filename as well, since
* uploaded files are stored with random names
* @param int The octal mode to use for the new file
* @param boolean Indicates that we should make the directory before moving the file
* @param int The octal mode to use when creating the directory
*
* @return boolean true, if the file was moved, otherwise false
*
* @throws <b>sfFileException</b> If a major error occurs while attempting to move the file
*/
public function moveFile($name, $file, $fileMode = 0666, $create = true, $dirMode = 0777)
{
if ($this->hasFile($name) && $this->getFileValue($name, 'error') == UPLOAD_ERR_OK && $this->getFileValue($name, 'size') > 0)
{
// get our directory path from the destination filename
$directory = dirname($file);
if (!is_readable($directory))
{
$fmode = 0777;
if ($create && !@mkdir($directory, $dirMode, true))
{
// failed to create the directory
$error = 'Failed to create file upload directory "%s"';
$error = sprintf($error, $directory);
throw new sfFileException($error);
}
// chmod the directory since it doesn't seem to work on
// recursive paths
@chmod($directory, $dirMode);
}
else if (!is_dir($directory))
{
// the directory path exists but it's not a directory
$error = 'File upload path "%s" exists, but is not a directory';
$error = sprintf($error, $directory);
throw new sfFileException($error);
}
else if (!is_writable($directory))
{
// the directory isn't writable
$error = 'File upload path "%s" is not writable';
$error = sprintf($error, $directory);
throw new sfFileException($error);
}
if (@move_uploaded_file($this->getFileValue($name, 'tmp_name'), $file))
{
// chmod our file
@chmod($file, $fileMode);
return true;
}
}
return false;
}
/**
* Returns referer.
*
* @return string
*/
public function getReferer()
{
$pathArray = $this->getPathInfoArray();
return isset($pathArray['HTTP_REFERER']) ? $pathArray['HTTP_REFERER'] : '';
}
/**
* Returns current host name.
*
* @return string
*/
public function getHost()
{
$pathArray = $this->getPathInfoArray();
return isset($pathArray['HTTP_X_FORWARDED_HOST']) ? $pathArray['HTTP_X_FORWARDED_HOST'] : (isset($pathArray['HTTP_HOST']) ? $pathArray['HTTP_HOST'] : '');
}
/**
* Returns current script name.
*
* @return string
*/
public function getScriptName()
{
$pathArray = $this->getPathInfoArray();
return isset($pathArray['SCRIPT_NAME']) ? $pathArray['SCRIPT_NAME'] : (isset($pathArray['ORIG_SCRIPT_NAME']) ? $pathArray['ORIG_SCRIPT_NAME'] : '');
}
/**
* Returns request method.
*
* @return string
*/
public function getMethodName()
{
$pathArray = $this->getPathInfoArray();
return isset($pathArray['REQUEST_METHOD']) ? $pathArray['REQUEST_METHOD'] : 'GET';
}
/**
* Gets a list of languages acceptable by the client browser
*
* @return array Languages ordered in the user browser preferences
*/
public function getLanguages()
{
if ($this->languages)
{
return $this->languages;
}
if (!isset($_SERVER['HTTP_ACCEPT_LANGUAGE']))
{
return array();
}
$languages = $this->splitHttpAcceptHeader($_SERVER['HTTP_ACCEPT_LANGUAGE']);
foreach ($languages as $lang)
{
if (strstr($lang, '-'))
{
$codes = explode('-', $lang);
if ($codes[0] == 'i')
{
// Language not listed in ISO 639 that are not variants
// of any listed language, which can be registerd with the
// i-prefix, such as i-cherokee
if (count($codes) > 1)
{
$lang = $codes[1];
}
}
else
{
for ($i = 0, $max = count($codes); $i < $max; $i++)
{
if ($i == 0)
{
$lang = strtolower($codes[0]);
}
else
{
$lang .= '_'.strtoupper($codes[$i]);
}
}
}
}
$this->languages[] = $lang;
}
return $this->languages;
}
/**
* Gets a list of charsets acceptable by the client browser.
*
* @return array List of charsets in preferable order
*/
public function getCharsets()
{
if ($this->charsets)
{
return $this->charsets;
}
if (!isset($_SERVER['HTTP_ACCEPT_CHARSET']))
{
return array();
}
$this->charsets = $this->splitHttpAcceptHeader($_SERVER['HTTP_ACCEPT_CHARSET']);
return $this->charsets;
}
/**
* Gets a list of content types acceptable by the client browser
*
* @return array Languages ordered in the user browser preferences
*/
public function getAcceptableContentTypes()
{
if ($this->acceptableContentTypes)
{
return $this->acceptableContentTypes;
}
if (!isset($_SERVER['HTTP_ACCEPT']))
{
return array();
}
$this->acceptableContentTypes = $this->splitHttpAcceptHeader($_SERVER['HTTP_ACCEPT']);
return $this->acceptableContentTypes;
}
/**
* Returns true if the request is a XMLHttpRequest.
*
* It works if your JavaScript library set an X-Requested-With HTTP header.
* Works with Prototype, Mootools, jQuery, and perhaps others.
*
* @return Boolean true if the request is an XMLHttpRequest, false otherwise
*/
public function isXmlHttpRequest()
{
return ($this->getHttpHeader('X_REQUESTED_WITH') == 'XMLHttpRequest');
}
public function getHttpHeader($name, $prefix = 'http')
{
if ($prefix)
{
$prefix = strtoupper($prefix).'_';
}
$name = $prefix.strtoupper(strtr($name, '-', '_'));
$pathArray = $this->getPathInfoArray();
return isset($pathArray[$name]) ? stripslashes($pathArray[$name]) : null;
}
/**
* Gets a cookie value.
*
* @return mixed
*/
public function getCookie($name, $defaultValue = null)
{
$retval = $defaultValue;
if (isset($_COOKIE[$name]))
{
$retval = get_magic_quotes_gpc() ? stripslashes($_COOKIE[$name]) : $_COOKIE[$name];
}
return $retval;
}
/**
* Returns true if the current request is secure (HTTPS protocol).
*
* @return boolean
*/
public function isSecure()
{
$pathArray = $this->getPathInfoArray();
return (
(isset($pathArray['HTTPS']) && (strtolower($pathArray['HTTPS']) == 'on' || strtolower($pathArray['HTTPS']) == 1))
||
(isset($pathArray['HTTP_X_FORWARDED_PROTO']) && strtolower($pathArray['HTTP_X_FORWARDED_PROTO']) == 'https')
);
}
/**
* Retrieves relative root url.
*
* @return string URL
*/
public function getRelativeUrlRoot()
{
if ($this->relativeUrlRoot === null)
{
$this->relativeUrlRoot = sfConfig::get('sf_relative_url_root', preg_replace('#/[^/]+\.php5?$#', '', $this->getScriptName()));
}
return $this->relativeUrlRoot;
}
/**
* Sets the relative root url for the current web request.
*
* @param string Value for the url
*/
public function setRelativeUrlRoot($value)
{
$this->relativeUrlRoot = $value;
}
/**
* Executes the shutdown procedure.
*
*/
public function shutdown()
{
}
/**
* Splits an HTTP header for the current web request.
*
* @param string Header to split
*/
public function splitHttpAcceptHeader($header)
{
$values = array();
foreach (array_filter(explode(',', $header)) as $value)
{
// Cut off any q-value that might come after a semi-colon
if ($pos = strpos($value, ';'))
{
$q = (float) trim(substr($value, $pos + 3));
$value = trim(substr($value, 0, $pos));
}
else
{
$q = 1;
}
$values[$value] = $q;
}
arsort($values);
return array_keys($values);
}
/**
* Converts a string of paths separated by newlines into an array.
*
* Code adapted from http://www.shauninman.com/archive/2006/11/30/fixing_the_files_superglobal
* @author Shaun Inman (www.shauninman.com)
*
* @param string A string representing an array
*
* @return Array An array
*/
protected function pathsToArray($str)
{
$array = array();
$lines = explode("\n", trim($str));
if (!empty($lines[0]))
{
foreach ($lines as $line)
{
list($path, $value) = explode(' = ', $line);
$steps = explode('/', $path);
array_shift($steps);
$insertion =& $array;
foreach ($steps as $step)
{
if (!isset($insertion[$step]))
{
$insertion[$step] = array();
}
$insertion =& $insertion[$step];
}
$insertion = ctype_digit($value) ? (int) $value : $value;
}
}
return $array;
}
/**
* Converts an array into a string containing the path to each of its values separated by a newline.
*
* Code adapted from http://www.shauninman.com/archive/2006/11/30/fixing_the_files_superglobal
* @author Shaun Inman (www.shauninman.com)
*
* @param Array An array
*
* @return string A string representing the array
*/
protected function arrayToPaths($array = array(), $prefix = '')
{
$str = '';
$freshPrefix = $prefix;
foreach ($array as $key => $value)
{
$freshPrefix .= "/{$key}";
if (is_array($value))
{
$str .= $this->arrayToPaths($value, $freshPrefix);
$freshPrefix = $prefix;
}
else
{
$str .= "{$prefix}/{$key} = {$value}\n";
}
}
return $str;
}
}