Changeset 10627

Timestamp:

08/03/08 10:52:28 (4 months ago)

Author:

fabien

Message:

refactored sfRequest

• removed the dependency on sfConfig by adding an $options argument to the constructor
  
• moved all 1.0 methods to a sfRequestCompat10 class in sfCompat10Plugin
  
• moved path_info_array, path_info_key, and relative_url_root configuration from settings.yml to factories.yml
  
• added a logging option
  

Files:

• branches/1.2/lib/config/config/factories.yml (modified) (1 diff)
• branches/1.2/lib/config/config/settings.yml (modified) (1 diff)
• branches/1.2/lib/config/sfFactoryConfigHandler.class.php (modified) (1 diff)
• branches/1.2/lib/plugins/sfCompat10Plugin/config/config.php (modified) (2 diffs)
• branches/1.2/lib/plugins/sfCompat10Plugin/lib/request (added)
• branches/1.2/lib/plugins/sfCompat10Plugin/lib/request/sfRequestCompat10.class.php (added)
• branches/1.2/lib/plugins/sfCompat10Plugin/test/unit/request/sfRequestTest.php (modified) (2 diffs)
• branches/1.2/lib/request/sfRequest.class.php (modified) (5 diffs)
• branches/1.2/lib/request/sfWebRequest.class.php (modified) (10 diffs)
• branches/1.2/lib/task/generator/skeleton/app/app/config/settings.yml (modified) (1 diff)

branches/1.2/lib/config/config/factories.yml

@@ -6 +6 @@
-    class: sfWebRequest
-    param:
+      logging:         %SF_LOGGING_ENABLED%
+      path_info_array: SERVER
+      path_info_key:   PATH_INFO
-      formats:
-        txt:  text/plain

branches/1.2/lib/config/config/settings.yml

@@ -64 +64 @@
-    strip_comments:         on         # Remove comments in core framework classes as defined in the core_compile.yml
-    max_forwards:           5
-    path_info_array:        SERVER
-    path_info_key:          PATH_INFO
-    url_format:             PATH
-

branches/1.2/lib/config/sfFactoryConfigHandler.class.php

@@ -91 +91 @@
-
-        case 'request':
-
+array(), 
-          break;
-

branches/1.2/lib/plugins/sfCompat10Plugin/config/config.php

@@ -7 +7 @@
-    class sfCompatAutoload extends sfSimpleAutoload
-    {
-
-    }
-
@@ -22 +21 @@
-  sfProjectConfiguration::getActive()->getConfigCache()->registerConfigHandler('modules/*/config/mailer.yml', 'sfDefineEnvironmentConfigHandler', array('prefix' => 'sf_mailer_', 'module' => 'yes'));
-
+  // register request compat methods
+  if ($this instanceof sfConfigCache)
+  {
+    // here if we are included from an admin generator module (for 1.0)
+    sfProjectConfiguration::getActive()->getEventDispatcher()->connect('request.method_not_found', array('sfRequestCompat10', 'call'));
+  }
+  else
+  {
+    $this->dispatcher->connect('request.method_not_found', array('sfRequestCompat10', 'call'));
+  }
+
-  // register the validation execution filter
-  sfConfig::set('sf_execution_filter', array('sfValidationExecutionFilter', array()));

branches/1.2/lib/plugins/sfCompat10Plugin/test/unit/request/sfRequestTest.php

@@ -11 +11 @@
-require_once(dirname(__FILE__).'/../../bootstrap/unit.php');
-
-sfConfig::set('sf_compat_10', true);
-
-class myRequest extends sfRequest
-{
@@ -24 +22 @@
-
-$dispatcher = new sfEventDispatcher();
+$dispatcher->connect('request.method_not_found', array('sfRequestCompat10', 'call'));
+
-$request = new myRequest($dispatcher);
-

branches/1.2/lib/request/sfRequest.class.php

@@ -60 +60 @@
-
-  protected
-    $errors          = array(),
-    $dispatcher      = null,
-    $method          = null,
+    $options         = array(),
-    $parameterHolder = null,
-    $config          = null,
-    $attributeHolder = null;
-
@@ -72 +71 @@
-   * @see initialize()
-   */
-
-
-
+, $options = array()
+
+, $options
-  }
-
@@ -88 +87 @@
-   * @throws <b>sfInitializationException</b> If an error occurs while initializing this sfRequest
-   */
-
+, $options = array()
-  {
-    $this->dispatcher = $dispatcher;
+
+    $this->options = $options;
+
+    if (!isset($this->options['logging']))
+    {
+      $this->options['logging'] = false;
+    }
-
-    // initialize parameter and attribute holders
@@ -126 +132 @@
-
-  /**
-   * Retrieves an error message.
-   *
-   * @param  string $name  An error name
-   *
-   * @return string An error message, if the error exists, otherwise null
-   */
-  public function getError($name)
-  {
-    if (!sfConfig::get('sf_compat_10'))
-    {
-      throw new sfConfigurationException('You must set "compat_10" to true if you want to use this method which is deprecated.');
-    }
-
-    return isset($this->errors[$name]) ? $this->errors[$name] : null;
-  }
-
-  /**
-   * Retrieves an array of error names.
-   *
-   * @return array An indexed array of error names
-   */
-  public function getErrorNames()
-  {
-    if (!sfConfig::get('sf_compat_10'))
-    {
-      throw new sfConfigurationException('You must set "compat_10" to true if you want to use this method which is deprecated.');
-    }
-
-    return array_keys($this->errors);
-  }
-
-  /**
-   * Retrieves an array of errors.
-   *
-   * @return array An associative array of errors
-   */
-  public function getErrors()
-  {
-    if (!sfConfig::get('sf_compat_10'))
-    {
-      throw new sfConfigurationException('You must set "compat_10" to true if you want to use this method which is deprecated.');
-    }
-
-    return $this->errors;
-  }
-
-  /**
-   * Retrieves this request's method.
-   *
@@ -182 +141 @@
-  {
-    return $this->method;
-  }
-
-  /**
-   * Indicates whether or not an error exists.
-   *
-   * @param  string $name  An error name
-   *
-   * @return bool true, if the error exists, otherwise false
-   */
-  public function hasError($name)
-  {
-    if (!sfConfig::get('sf_compat_10'))
-    {
-      throw new sfConfigurationException('You must set "compat_10" to true if you want to use this method which is deprecated.');
-    }
-
-    return array_key_exists($name, $this->errors);
-  }
-
-  /**
-   * Indicates whether or not any errors exist.
-   *
-   * @return bool true, if any error exist, otherwise false
-   */
-  public function hasErrors()
-  {
-    if (!sfConfig::get('sf_compat_10'))
-    {
-      throw new sfConfigurationException('You must set "compat_10" to true if you want to use this method which is deprecated.');
-    }
-
-    return count($this->errors) > 0;
-  }
-
-  /**
-   * Removes an error.
-   *
-   * @param  string $name  An error name
-   *
-   * @return string An error message, if the error was removed, otherwise null
-   */
-  public function removeError($name)
-  {
-    if (!sfConfig::get('sf_compat_10'))
-    {
-      throw new sfConfigurationException('You must set "compat_10" to true if you want to use this method which is deprecated.');
-    }
-
-    $retval = null;
-
-    if (isset($this->errors[$name]))
-    {
-      $retval = $this->errors[$name];
-
-      unset($this->errors[$name]);
-    }
-
-    return $retval;
-  }
-
-  /**
-   * Sets an error.
-   *
-   * @param string $name     An error name
-   * @param string $message  An error message
-   *
-   */
-  public function setError($name, $message)
-  {
-    if (!sfConfig::get('sf_compat_10'))
-    {
-      throw new sfConfigurationException('You must set "compat_10" to true if you want to use this method which is deprecated.');
-    }
-
-    if (sfConfig::get('sf_logging_enabled'))
-    {
-      $this->dispatcher->notify(new sfEvent($this, 'application.log', array(sprintf('Error in form for parameter "%s" (with message "%s")', $name, $message))));
-    }
-
-    $this->errors[$name] = $message;
-  }
-
-  /**
-   * Sets an array of errors
-   *
-   * If an existing error name matches any of the keys in the supplied
-   * array, the associated message will be overridden.
-   *
-   * @param array $erros An associative array of errors and their associated messages
-   *
-   */
-  public function setErrors($errors)
-  {
-    if (!sfConfig::get('sf_compat_10'))
-    {
-      throw new sfConfigurationException('You must set "compat_10" to true if you want to use this method which is deprecated.');
-    }
-
-    $this->errors = array_merge($this->errors, $errors);
-  }
-

branches/1.2/lib/request/sfWebRequest.class.php

@@ -46 +46 @@
-   * @throws <b>sfInitializationException</b> If an error occurs while initializing this sfRequest
-   */
-
-
-
+, $options = array()
+
+, $options
-
-    if (isset($_SERVER['REQUEST_METHOD']))
@@ -84 +84 @@
-    }
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    }
-
@@ -94 +107 @@
-
-  /**
-   * Retrieves an array of file information.
-   *
-   * @param  string $name  A file name
-   *
-   * @return array An associative array of file information, if the file exists, otherwise null
-   */
-  public function getFile($name)
-  {
-    if (!sfConfig::get('sf_compat_10'))
-    {
-      throw new sfConfigurationException('You must set "compat_10" to true if you want to use this method which is deprecated.');
-    }
-
-    return $this->hasFile($name) ? $this->getFileValues($name) : null;
-  }
-
-  /**
-   * Retrieves a file error.
-   *
-   * @param  string $name  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)
-  {
-    if (!sfConfig::get('sf_compat_10'))
-    {
-      throw new sfConfigurationException('You must set "compat_10" to true if you want to use this method which is deprecated.');
-    }
-
-    return $this->hasFile($name) ? $this->getFileValue($name, 'error') : UPLOAD_ERR_NO_FILE;
-  }
-
-  /**
-   * Retrieves a file name.
-   *
-   * @param  string $name  A file nam.
-   *
-   * @return string A file name, if the file exists, otherwise null
-   */
-  public function getFileName($name)
-  {
-    if (!sfConfig::get('sf_compat_10'))
-    {
-      throw new sfConfigurationException('You must set "compat_10" to true if you want to use this method which is deprecated.');
-    }
-
-    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()
-  {
-    if (!sfConfig::get('sf_compat_10'))
-    {
-      throw new sfConfigurationException('You must set "compat_10" to true if you want to use this method which is deprecated.');
-    }
-
-    return array_keys($_FILES);
-  }
-
-  /**
-   * Retrieves an array of files.
-   *
-   * @param  string $key  A key
-   * @return array  An associative array of files
-   */
-  public function getFiles($key = null)
-  {
-    return is_null($key) ? $_FILES : (isset($_FILES[$key]) ? $_FILES[$key] : array());
-  }
-
-  /**
-   * Retrieves a file path.
-   *
-   * @param  string $name  A file name
-   *
-   * @return string A file path, if the file exists, otherwise null
-   */
-  public function getFilePath($name)
-  {
-    if (!sfConfig::get('sf_compat_10'))
-    {
-      throw new sfConfigurationException('You must set "compat_10" to true if you want to use this method which is deprecated.');
-    }
-
-    return $this->hasFile($name) ? $this->getFileValue($name, 'tmp_name') : null;
-  }
-
-  /**
-   * Retrieve a file size.
-   *
-   * @param  string $name  A file name
-   *
-   * @return int A file size, if the file exists, otherwise null
-   */
-  public function getFileSize($name)
-  {
-    if (!sfConfig::get('sf_compat_10'))
-    {
-      throw new sfConfigurationException('You must set "compat_10" to true if you want to use this method which is deprecated.');
-    }
-
-    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 $name  A file name
-   *
-   * @return string A file type, if the file exists, otherwise null
-   */
-  public function getFileType($name)
-  {
-    if (!sfConfig::get('sf_compat_10'))
-    {
-      throw new sfConfigurationException('You must set "compat_10" to true if you want to use this method which is deprecated.');
-    }
-
-    return $this->hasFile($name) ? $this->getFileValue($name, 'type') : null;
-  }
-
-  /**
-   * Indicates whether or not a file exists.
-   *
-   * @param  string $name  A file name
-   *
-   * @return bool true, if the file exists, otherwise false
-   */
-  public function hasFile($name)
-  {
-    if (!sfConfig::get('sf_compat_10'))
-    {
-      throw new sfConfigurationException('You must set "compat_10" to true if you want to use this method which is deprecated.');
-    }
-
-    if (preg_match('/^(.+?)\[(.+?)\]$/', $name, $match))
-    {
-      return isset($_FILES[$match[1]]['name'][$match[2]]);
-    }
-    else
-    {
-      return isset($_FILES[$name]);
-    }
-  }
-
-  /**
-   * Indicates whether or not a file error exists.
-   *
-   * @param  string $name  A file name
-   *
-   * @return bool true, if the file error exists, otherwise false
-   */
-  public function hasFileError($name)
-  {
-    if (!sfConfig::get('sf_compat_10'))
-    {
-      throw new sfConfigurationException('You must set "compat_10" to true if you want to use this method which is deprecated.');
-    }
-
-    return $this->hasFile($name) ? ($this->getFileValue($name, 'error') != UPLOAD_ERR_OK) : false;
-  }
-
-  /**
-   * Indicates whether or not any file errors occured.
-   *
-   * @return bool true, if any file errors occured, otherwise false
-   */
-  public function hasFileErrors()
-  {
-    if (!sfConfig::get('sf_compat_10'))
-    {
-      throw new sfConfigurationException('You must set "compat_10" to true if you want to use this method which is deprecated.');
-    }
-
-    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()
-  {
-    if (!sfConfig::get('sf_compat_10'))
-    {
-      throw new sfConfigurationException('You must set "compat_10" to true if you want to use this method which is deprecated.');
-    }
-
-    return (count($_FILES) > 0);
-  }
-
-  /**
-   * Retrieves a file value.
-   *
-   * @param string $name A file name
-   * @param string $key Value to search in the file
-   * 
-   * @return string File value
-   */
-  public function getFileValue($name, $key)
-  {
-    if (!sfConfig::get('sf_compat_10'))
-    {
-      throw new sfConfigurationException('You must set "compat_10" to true if you want to use this method which is deprecated.');
-    }
-
-    if (preg_match('/^(.+?)\[(.+?)\]$/', $name, $match))
-    {
-      return $_FILES[$match[1]][$key][$match[2]];
-    }
-    else
-    {
-      return $_FILES[$name][$key];
-    }
-  }
-
-  /**
-   * Retrieves all the values from a file.
-   *
-   * @param  string $name  A file name
-   *
-   * @return array Associative list of the file values
-   */
-  public function getFileValues($name)
-  {
-    if (!sfConfig::get('sf_compat_10'))
-    {
-      throw new sfConfigurationException('You must set "compat_10" to true if you want to use this method which is deprecated.');
-    }
-
-    if (preg_match('/^(.+?)\[(.+?)\]$/', $name, $match))
-    {
-      return array(
-        'name'     => $_FILES[$match[1]]['name'][$match[2]],
-        'type'     => $_FILES[$match[1]]['type'][$match[2]],
-        'tmp_name' => $_FILES[$match[1]]['tmp_name'][$match[2]],
-        'error'    => $_FILES[$match[1]]['error'][$match[2]],
-        'size'     => $_FILES[$match[1]]['size'][$match[2]],
-      );
-    }
-    else
-    {
-      return $_FILES[$name];
-    }
-  }
-
-  /**
-   * Retrieves an extension for a given file.
-   *
-   * @param  string $name  A file name
-   *
-   * @return string Extension for the file
-   */
-  public function getFileExtension($name)
-  {
-    if (!sfConfig::get('sf_compat_10'))
-    {
-      throw new sfConfigurationException('You must set "compat_10" to true if you want to use this method which is deprecated.');
-    }
-
-    static $mimeTypes = null;
-
-    $fileType = $this->getFileType($name);
-
-    if (!$fileType)
-    {
-      return '.bin';
-    }
-
-    if (is_null($mimeTypes))
-    {
-      $mimeTypes = unserialize(file_get_contents(sfConfig::get('sf_symfony_lib_dir').'/plugins/sfCompat10Plugin/data/mime_types.dat'));
-    }
-
-    return isset($mimeTypes[$fileType]) ? '.'.$mimeTypes[$fileType] : '.bin';
-  }
-
-  /**
-   * Retrieves the uniform resource identifier for the current web request.
-   *
@@ -474 +180 @@
-
-    // simulate PATH_INFO if needed
-sfConfig::get('sf_path_info_key', 'PATH_INFO')
+$this->options['path_info_key']
-    if (!isset($pathArray[$sf_path_info_key]) || !$pathArray[$sf_path_info_key])
-    {
@@ -491 +197 @@
-    {
-      $pathInfo = $pathArray[$sf_path_info_key];
-sf_relative_url_r
-
-sf_relative_url_r
+relativeUrlR
+
+relativeUrlR
-      }
-    }
@@ -524 +230 @@
-  {
-    return $this->requestParameters;
-  }
-
-  /**
-   * Moves an uploaded file.
-   *
-   * @param string $name      A file name
-   * @param string $file      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    $fileMode  The octal mode to use for the new file
-   * @param bool   $create    Indicates that we should make the directory before moving the file
-   * @param int    $dirMode   The octal mode to use when creating the directory
-   *
-   * @return bool 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 (!sfConfig::get('sf_compat_10'))
-    {
-      throw new sfConfigurationException('You must set "compat_10" to true if you want to use this method which is deprecated.');
-    }
-
-    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
-          throw new sfFileException(sprintf('Failed to create file upload directory "%s".', $directory));
-        }
-
-        // 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
-        throw new sfFileException(sprintf('File upload path "%s" exists, but is not a directory.', $directory));
-      }
-      else if (!is_writable($directory))
-      {
-        // the directory isn't writable
-        throw new sfFileException(sprintf('File upload path "%s" is not writable.', $directory));
-      }
-
-      if (@move_uploaded_file($this->getFileValue($name, 'tmp_name'), $file))
-      {
-        // chmod our file
-        @chmod($file, $fileMode);
-
-        return true;
-      }
-    }
-
-    return false;
-  }
-
@@ -849 +491 @@
-  public function getRelativeUrlRoot()
-  {
-
-
-
+
+
+
+
+
+
+
+
+
+
-    }
-
@@ -908 +557 @@
-    {
-      // parse PATH_INFO
-sfConfig::get('sf_path_info_array', 'SERVER')
+$this->options['path_info_array']
-      {
-        case 'SERVER':
@@ -1007 +656 @@
-
-  /**
+   * Retrieves an array of files.
+   *
+   * @param  string $key  A key
+   * @return array  An associative array of files
+   */
+  static public function getFiles($key = null)
+  {
+    return is_null($key) ? $_FILES : (isset($_FILES[$key]) ? $_FILES[$key] : array());
+  }
+
+  /**
-   * Returns the value of a GET parameter.
-   *
@@ -1138 +798 @@
-    }
-
-sfConfig::get('sf_logging_enabled')
+$this->options['logging']
-    {
-      $this->dispatcher->notify(new sfEvent($this, 'application.log', array(sprintf('Request parameters %s', str_replace("\n", '', var_export($this->getParameterHolder()->getAll(), true))))));

branches/1.2/lib/task/generator/skeleton/app/app/config/settings.yml

@@ -87 +87 @@
-#    strip_comments:         on         # Remove comments in core framework classes as defined in the core_compile.yml
-#    max_forwards:           5
-#    path_info_array:        SERVER
-#    path_info_key:          PATH_INFO
-#    url_format:             PATH
-#