Merge pull request #69 from rakit/split-uploaded-file

Improve uploaded file validation

Author: emsifa

README.md

@@ -269,7 +269,8 @@ Below is list of all available validation rules
 * [required_without](#rule-required_without)
 * [required_with_all](#rule-required_with_all)
 * [required_without_all](#rule-required_without_all)
-* [uploaded_file](#rule-uploaded_file)
+* [uploaded_file](#rule-uploaded_file) (uploaded file)
+* [mimes](#rule-mimes) (uploaded file)
 * [default/defaults](#rule-default)
 * [email](#rule-email)
 * [uppercase](#rule-uppercase)
@@ -355,7 +356,7 @@ The field under validation must be present and not empty only if all of the othe
 The field under validation must be present and not empty only when all of the other specified fields are not present.
 
 <a id="rule-uploaded_file"></a>
-#### uploaded_file:min_size,max_size,file_type_a,file_type_b,...
+#### uploaded_file:min_size,max_size,extension_a,extension_b,...
 
 This rule will validate `$_FILES` data, but not for multiple uploaded files. 
 Field under this rule must be following rules below to be valid:
@@ -372,6 +373,12 @@ Here are some example definitions and explanations:
 * `uploaded_file:0,1M`: uploaded file size must be between 0 - 1 MB, but uploaded file is optional.
 * `required|uploaded_file:0,1M,png,jpeg`: uploaded file size must be between 0 - 1MB and mime types must be `image/jpeg` or `image/png`.
 
+
+<a id="rule-default"></a>
+#### mimes:extension_a,extension_b,...
+
+The `$_FILES` item under validation must have a MIME type corresponding to one of the listed extensions.
+
 <a id="rule-default"></a>
 #### default/defaults
 
@@ -468,18 +475,51 @@ The field under this rule must have a size greater or equal than the given numbe
 
 For string data, value corresponds to the number of characters. For numeric data, value corresponds to a given integer value. For an array, size corresponds to the count of the array.
 
+You can also validate uploaded file using this rule to validate minimum size of uploaded file.
+For example:
+
+```php
+$validation = $validator->validate([
+    'photo' => $_FILES['photo']
+], [
+    'photo' => 'required|min:1M'
+]);
+```
+
 <a id="rule-max"></a>
 #### max:number
 
 The field under this rule must have a size lower or equal than the given number. 
 Value size calculated in same way like `min` rule.
 
+You can also validate uploaded file using this rule to validate maximum size of uploaded file.
+For example:
+
+```php
+$validation = $validator->validate([
+    'photo' => $_FILES['photo']
+], [
+    'photo' => 'required|max:2M'
+]);
+```
+
 <a id="rule-between"></a>
 #### between:min,max
 
 The field under this rule must have a size between min and max params. 
 Value size calculated in same way like `min` and `max` rule.
 
+You can also validate uploaded file using this rule to validate size of uploaded file.
+For example:
+
+```php
+$validation = $validator->validate([
+    'photo' => $_FILES['photo']
+], [
+    'photo' => 'required|between:1M,2M'
+]);
+```
+
 <a id="rule-digits"></a>
 #### digits:value
 

composer.json

@@ -25,5 +25,11 @@
   "require-dev": {
     "phpunit/phpunit": "^6.5",
     "squizlabs/php_codesniffer": "^3"
+  },
+  "scripts": {
+    "test": [
+        "phpunit",
+        "phpcs"
+    ]
   }
 }

phpcs.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0"?>
+<ruleset name="Rakit validation coding standard">
+    <description>Rakit validation coding standard</description>
+
+    <!-- display progress -->
+    <arg value="p"/>
+    <!-- use colors in output -->
+    <arg name="colors"/>
+
+    <!-- inherit rules from: -->
+    <rule ref="PSR2"/>
+    <rule ref="Generic.Arrays.DisallowLongArraySyntax"/>
+
+    <!-- Paths to check -->
+    <file>src</file>
+    <file>tests</file>
+</ruleset>

src/Rules/After.php

@@ -7,7 +7,7 @@
 class After extends Rule
 {
 
-    use DateUtils;
+    use Traits\DateUtilsTrait;
 
     /** @var string */
     protected $message = "The :attribute must be a date after :time.";

src/Rules/Before.php

@@ -6,7 +6,7 @@
 
 class Before extends Rule
 {
-    use DateUtils;
+    use Traits\DateUtilsTrait;
 
     /** @var string */
     protected $message = "The :attribute must be a date before :time.";

src/Rules/Between.php

@@ -6,6 +6,7 @@
 
 class Between extends Rule
 {
+    use Traits\SizeTrait;
 
     /** @var string */
     protected $message = "The :attribute must be between :min and :max";
@@ -23,17 +24,15 @@ public function check($value): bool
     {
         $this->requireParameters($this->fillableParams);
 
-        $min = (int) $this->parameter('min');
-        $max = (int) $this->parameter('max');
+        $min = $this->getBytesSize($this->parameter('min'));
+        $max = $this->getBytesSize($this->parameter('max'));
 
-        if (is_int($value) || is_float($value)) {
-            return $value >= $min and $value <= $max;
-        } elseif (is_string($value)) {
-            return mb_strlen($value, 'UTF-8') >= $min and mb_strlen($value, 'UTF-8') <= $max;
-        } elseif (is_array($value)) {
-            return count($value) >= $min and count($value) <= $max;
-        } else {
+        $valueSize = $this->getValueSize($value);
+
+        if (!is_numeric($valueSize)) {
             return false;
         }
+
+        return ($valueSize >= $min && $valueSize <= $max);
     }
 }

src/Rules/Max.php

@@ -6,6 +6,7 @@
 
 class Max extends Rule
 {
+    use Traits\SizeTrait;
 
     /** @var string */
     protected $message = "The :attribute maximum is :max";
@@ -23,15 +24,13 @@ public function check($value): bool
     {
         $this->requireParameters($this->fillableParams);
 
-        $max = (int) $this->parameter('max');
-        if (is_int($value)) {
-            return $value <= $max;
-        } elseif (is_string($value)) {
-            return mb_strlen($value, 'UTF-8') <= $max;
-        } elseif (is_array($value)) {
-            return count($value) <= $max;
-        } else {
+        $max = $this->getBytesSize($this->parameter('max'));
+        $valueSize = $this->getValueSize($value);
+
+        if (!is_numeric($valueSize)) {
             return false;
         }
+
+        return $valueSize <= $max;
     }
 }

src/Rules/Mimes.php

@@ -0,0 +1,89 @@
+<?php
+
+namespace Rakit\Validation\Rules;
+
+use Rakit\Validation\Rule;
+use Rakit\Validation\MimeTypeGuesser;
+
+class Mimes extends Rule
+{
+    use Traits\FileTrait;
+
+    /** @var string */
+    protected $message = "The :attribute file type is not allowed";
+
+    /** @var string|int */
+    protected $maxSize = null;
+
+    /** @var string|int */
+    protected $minSize = null;
+
+    /** @var array */
+    protected $allowedTypes = [];
+
+    /**
+     * Given $params and assign $this->params
+     *
+     * @param array $params
+     * @return self
+     */
+    public function fillParameters(array $params): Rule
+    {
+        $this->allowTypes($params);
+        return $this;
+    }
+
+    /**
+     * Given $types and assign $this->params
+     *
+     * @param mixed $types
+     * @return self
+     */
+    public function allowTypes($types): Rule
+    {
+        if (is_string($types)) {
+            $types = explode('|', $types);
+        }
+
+        $this->params['allowed_types'] = $types;
+
+        return $this;
+    }
+
+    /**
+     * Check the $value is valid
+     *
+     * @param mixed $value
+     * @return bool
+     */
+    public function check($value): bool
+    {
+        $allowedTypes = $this->parameter('allowed_types');
+
+        // below is Required rule job
+        if (!$this->isValueFromUploadedFiles($value) or $value['error'] == UPLOAD_ERR_NO_FILE) {
+            return true;
+        }
+
+        if (!$this->isUploadedFile($value)) {
+            return false;
+        }
+
+        // just make sure there is no error
+        if ($value['error']) {
+            return false;
+        }
+
+        if (!empty($allowedTypes)) {
+            $guesser = new MimeTypeGuesser;
+            $ext = $guesser->getExtension($value['type']);
+            unset($guesser);
+
+            if (!in_array($ext, $allowedTypes)) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+}

src/Rules/Min.php

@@ -6,6 +6,7 @@
 
 class Min extends Rule
 {
+    use Traits\SizeTrait;
 
     /** @var string */
     protected $message = "The :attribute minimum is :min";
@@ -23,15 +24,13 @@ public function check($value): bool
     {
         $this->requireParameters($this->fillableParams);
 
-        $min = (int) $this->parameter('min');
-        if (is_int($value)) {
-            return $value >= $min;
-        } elseif (is_string($value)) {
-            return mb_strlen($value, 'UTF-8') >= $min;
-        } elseif (is_array($value)) {
-            return count($value) >= $min;
-        } else {
+        $min = $this->getBytesSize($this->parameter('min'));
+        $valueSize = $this->getValueSize($value);
+
+        if (!is_numeric($valueSize)) {
             return false;
         }
+
+        return $valueSize >= $min;
     }
 }

src/Rules/Required.php

@@ -6,7 +6,7 @@
 
 class Required extends Rule
 {
-    use FileTrait;
+    use Traits\FileTrait;
 
     /** @var bool */
     protected $implicit = true;