Changeset 6748

Timestamp:

12/27/07 11:24:07 (1 year ago)

Author:

fabien

Message:

added sfValidatorFile

• added sfValidatorFile validator
  
• added support for files in sfForm (second argument of bind())
  
• deprecated all file related methods of sfWebRequest (see UPGRADE)
  
• moved mime_types to sfCompat10Plugin (there are now part of the sfValidatorFile class)
  
• small example on how to use the new validator with a form:
  

class TestForm? extends sfForm
{

public function configure()
{

$this->validatorSchema = new sfValidatorSchema(array(

'file' => new sfValidatorFile(),

));

$this->widgetSchema = new sfWidgetFormSchema(array(

'file' => new sfWidgetFormInputFile(),

));

$this->widgetSchema->setNameFormat('article[%s]');

}

}

class testActions extends sfActions
{

public function executeIndex($request)
{

$this->form = new TestForm?();
if ($request->isMethod('post'))
{

$this->form->bind($request->getParameter('article'), $request->getFiles('article'));
if ($this->form->isValid())
{

$file = $this->form->getValue('file');
$path = sfConfig::get('sf_web_dir').'/uploads/'.rand(1, 1000);
$extension = $file->getExtension($file->getOriginalExtension();

$file->save($path.'.'.$extension));

}

}

}

}

Files:

• branches/1.1/UPGRADE (modified) (3 diffs)
• branches/1.1/lib/form/sfForm.class.php (modified) (4 diffs)
• branches/1.1/lib/plugins/sfCompat10Plugin/data (added)
• branches/1.1/lib/plugins/sfCompat10Plugin/data/mime_types.dat (moved) (moved from branches/1.1/data/data/mime_types.dat)
• branches/1.1/lib/plugins/sfCompat10Plugin/data/mime_types.php (moved) (moved from branches/1.1/data/data/mime_types.php)
• branches/1.1/lib/request/sfRequest.class.php (modified) (1 diff)
• branches/1.1/lib/request/sfWebRequest.class.php (modified) (17 diffs)
• branches/1.1/lib/validator/sfValidatorFile.class.php (added)
• branches/1.1/test/unit/form/sfFormTest.php (modified) (2 diffs)
• branches/1.1/test/unit/validator/sfValidatorFileTest.php (added)

branches/1.1/UPGRADE

@@ -295 +295 @@
-  * `->removeError()`
-
+Deprecated methods in sfWebRequest
+----------------------------------
+
+The following methods of `sfWebRequest` have been deprecated and throw
+a `sfConfigurationException` if `sf_compat_10` is set to `false`:
+
+  * `->getFile()`
+  * `->getFileError()`
+  * `->getFileName()`
+  * `->getFileNames()`
+  * `->getFilePath()`
+  * `->getFileSize()`
+  * `->getFileType()`
+  * `->hasFile()`
+  * `->hasFileError()`
+  * `->hasFileErrors()`
+  * `->hasFiles()`
+  * `->getFileValue()`
+  * `->getFileValues()`
+  * `->getFileExtension()`
+  * `->moveFile()`
+
-sfValidator class
------------------
@@ -358 +380 @@
----------------
-
-
+
+
-
-    all:
@@ -365 +388 @@
-        param:
-          timeout:     1800     # session timeout in seconds
-

branches/1.1/lib/form/sfForm.class.php

@@ -36 +36 @@
-    $isBound         = false,
-    $taintedValues   = array(),
+    $taintedFiles    = array(),
-    $values          = null,
-    $defaults        = array(),
@@ -111 +112 @@
-   *
-   * @param array An array of input values
-
-
+
+
+
-  {
-    $this->taintedValues = $taintedValues;
+    $this->taintedFiles  = $taintedFiles;
-    $this->isBound = true;
-    $this->resetFormFields();
@@ -120 +123 @@
-    try
-    {
-$this->taintedValues
+array_merge($this->taintedValues, self::convertFileInformation($this->taintedFiles))
-      $this->errorSchema = new sfValidatorErrorSchema($this->validatorSchema);
-
@@ -617 +620 @@
-    }
-  }
+
+  /**
+   * 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
+   */
+  static public function convertFileInformation($taintedFiles)
+  {
+    return self::pathsToArray(preg_replace('#^(/[^/]+)?(/name|/type|/tmp_name|/error|/size)([^\s]*)( = [^\n]*)#m', '$1$3$2$4', self::arrayToPaths($taintedFiles)));
+  }
+
+  /**
+   * 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
+   */
+  static public 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
+   */
+  static public function arrayToPaths($array = array(), $prefix = '')
+  {
+    $str = '';
+    $freshPrefix = $prefix;
+
+    foreach ($array as $key => $value)
+    {
+      $freshPrefix .= "/{$key}";
+
+      if (is_array($value))
+      {
+        $str .= self::arrayToPaths($value, $freshPrefix);
+        $freshPrefix = $prefix;
+      }
+      else
+      {
+        $str .= "{$prefix}/{$key} = {$value}\n";
+      }
+    }
+
+    return $str;
+  }
-}

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

@@ -12 +12 @@
-/**
- * sfRequest provides methods for manipulating client request information such
-errors 
+
- * request method originally sent by the user.
- *

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

@@ -95 +95 @@
-  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;
-  }
@@ -118 +123 @@
-  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;
-  }
@@ -130 +140 @@
-  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;
-  }
@@ -140 +155 @@
-  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);
-  }
@@ -146 +166 @@
-   * Retrieves an array of files.
-   *
-
-
-
-
-
+
+
+
+
+
+
-  }
-
@@ -162 +183 @@
-  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;
-  }
@@ -174 +200 @@
-  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;
-  }
@@ -189 +220 @@
-  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;
-  }
@@ -201 +237 @@
-  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))
-    {
@@ -220 +261 @@
-  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;
-  }
@@ -230 +276 @@
-  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)
-    {
@@ -248 +299 @@
-  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);
-  }
@@ -261 +317 @@
-  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))
-    {
@@ -280 +341 @@
-  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))
-    {
@@ -305 +371 @@
-  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.');
+    }
+
-    $fileType = $this->getFileType($name);
-
@@ -312 +383 @@
-    }
-
-data_dir').'
+lib_dir').'/plugins/sfCompat10Plugin
-
-    return isset($mimeTypes[$fileType]) ? '.'.$mimeTypes[$fileType] : '.bin';
@@ -451 +522 @@
-  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)
-    {

branches/1.1/test/unit/form/sfFormTest.php

@@ -11 +11 @@
-require_once(dirname(__FILE__).'/../../bootstrap/unit.php');
-
-1
+8
-
-class FormTest extends sfForm
@@ -212 +212 @@
-  $t->is($w['authors'][$i][sfForm::getCSRFFieldName()], null, '->embedFormForEach() removes the CSRF token for the embedded forms');
-}
+
+// ::convertFileInformation()
+$t->diag('::convertFileInformation()');
+$input = array(
+  'file' => array(
+    'name' => 'test1.txt',
+    'type' => 'text/plain',
+    'tmp_name' => '/tmp/test1.txt',
+    'error' => 0,
+    'size' => 100,
+  ),
+  'file1' => array(
+    'name' => 'test2.txt',
+    'type' => 'text/plain',
+    'tmp_name' => '/tmp/test1.txt',
+    'error' => 0,
+    'size' => 200,
+  ),
+);
+$t->is_deeply(sfForm::convertFileInformation($input), $input, '::convertFileInformation() converts $_FILES to be coherent with $_GET and $_POST naming convention');
+
+$input = array(
+  'article' => array(
+    'name' => array(
+      'file1' => 'test1.txt',
+      'file2' => 'test2.txt',
+    ),
+    'type' => array(
+      'file1' => 'text/plain',
+      'file2' => 'text/plain',
+    ),
+    'tmp_name' => array(
+      'file1' => '/tmp/test1.txt',
+      'file2' => '/tmp/test2.txt',
+    ),
+    'error' => array(
+      'file1' => 0,
+      'file2' => 0,
+    ),
+    'size' => array(
+      'file1' => 100,
+      'file2' => 200,
+    ),
+  ),
+);
+$expected = array(
+  'article' => array(
+    'file1' => array(
+      'name' => 'test1.txt',
+      'type' => 'text/plain',
+      'tmp_name' => '/tmp/test1.txt',
+      'error' => 0,
+      'size' => 100,
+    ),
+    'file2' => array(
+      'name' => 'test2.txt',
+      'type' => 'text/plain',
+      'tmp_name' => '/tmp/test2.txt',
+      'error' => 0,
+      'size' => 200,
+    ),
+  ),
+);
+$t->is_deeply(sfForm::convertFileInformation($input), $expected, '::convertFileInformation() converts $_FILES to be coherent with $_GET and $_POST naming convention');
+$t->is_deeply(sfForm::convertFileInformation($expected), $expected, '::convertFileInformation() converts $_FILES to be coherent with $_GET and $_POST naming convention');
+
+$input = array(
+  'article' => array(
+    'name' => array(
+      'files' => array(
+        'file1' => 'test1.txt',
+        'file2' => 'test2.txt',
+      ),
+    ),
+    'type' => array(
+      'files' => array(
+        'file1' => 'text/plain',
+        'file2' => 'text/plain',
+      ),
+    ),
+    'tmp_name' => array(
+      'files' => array(
+        'file1' => '/tmp/test1.txt',
+        'file2' => '/tmp/test2.txt',
+      ),
+    ),
+    'error' => array(
+      'files' => array(
+        'file1' => 0,
+        'file2' => 0,
+      ),
+    ),
+    'size' => array(
+      'files' => array(
+        'file1' => 100,
+        'file2' => 200,
+      ),
+    ),
+  ),
+);
+$expected = array(
+  'article' => array(
+    'files' => array(
+      'file1' => array(
+        'name' => 'test1.txt',
+        'type' => 'text/plain',
+        'tmp_name' => '/tmp/test1.txt',
+        'error' => 0,
+        'size' => 100,
+      ),
+      'file2' => array(
+        'name' => 'test2.txt',
+        'type' => 'text/plain',
+        'tmp_name' => '/tmp/test2.txt',
+        'error' => 0,
+        'size' => 200,
+      ),
+    )
+  ),
+);
+$t->is_deeply(sfForm::convertFileInformation($input), $expected, '::convertFileInformation() converts $_FILES to be coherent with $_GET and $_POST naming convention');
+$t->is_deeply(sfForm::convertFileInformation($expected), $expected, '::convertFileInformation() converts $_FILES to be coherent with $_GET and $_POST naming convention');
+
+$input = array(
+  'name' => array(
+    'file1' => 'test1.txt',
+    'file2' => 'test2.txt',
+  ),
+  'type' => array(
+    'file1' => 'text/plain',
+    'file2' => 'text/plain',
+  ),
+  'tmp_name' => array(
+    'file1' => '/tmp/test1.txt',
+    'file2' => '/tmp/test2.txt',
+  ),
+  'error' => array(
+    'file1' => 0,
+    'file2' => 0,
+  ),
+  'size' => array(
+    'file1' => 100,
+    'file2' => 200,
+  ),
+);
+$expected = array(
+  'file1' => array(
+    'name' => 'test1.txt',
+    'type' => 'text/plain',
+    'tmp_name' => '/tmp/test1.txt',
+    'error' => 0,
+    'size' => 100,
+  ),
+  'file2' => array(
+    'name' => 'test2.txt',
+    'type' => 'text/plain',
+    'tmp_name' => '/tmp/test2.txt',
+    'error' => 0,
+    'size' => 200,
+  ),
+);
+$t->is_deeply(sfForm::convertFileInformation($input), $expected, '::convertFileInformation() converts $_FILES to be coherent with $_GET and $_POST naming convention');
+$t->is_deeply(sfForm::convertFileInformation($expected), $expected, '::convertFileInformation() converts $_FILES to be coherent with $_GET and $_POST naming convention');