silverstripe / silverstripe-mimevalidator

code/MimeUploadValidator.php

Doc Comments +1 added lines, -1 removed lines

@@ -28,7 +28,7 @@
      * Check if the temporary file has a valid MIME type for it's extension.
      *
      * @uses finfo php extension
-     * @return boolean|null
+     * @return boolean
      */
     public function isValidMime()
     {

Indentation +138 added lines, -138 removed lines

@@ -6,144 +6,144 @@
  */
 class MimeUploadValidator extends Upload_Validator
 {
-    /**
-     * The preg_replace() pattern to use against MIME types. Used to strip out
-     * useless characters so matching of MIME types can be fuzzy.
-     *
-     * @var string Regexp pattern
-     */
-    protected $filterPattern = '/.*[\/\.\-\+]/i';
-
-    public function setFilterPattern($pattern)
-    {
-        $this->filterPattern = $pattern;
-    }
-
-    public function getFilterPattern()
-    {
-        return $this->filterPattern;
-    }
-
-    /**
-     * Check if the temporary file has a valid MIME type for it's extension.
-     *
-     * @uses finfo php extension
-     * @return boolean|null
-     */
-    public function isValidMime()
-    {
-        $extension = strtolower(pathinfo($this->tmpFile['name'], PATHINFO_EXTENSION));
-
-                // we can't check filenames without an extension or no temp file path, let them pass validation.
-                if (!$extension || !$this->tmpFile['tmp_name']) {
-                    return true;
-                }
-
-        $expectedMimes = $this->getExpectedMimeTypes($this->tmpFile);
-        if (empty($expectedMimes)) {
-            throw new MimeUploadValidator_Exception(
-                sprintf('Could not find a MIME type for extension %s', $extension)
-            );
-        }
-
-        $finfo = new finfo(FILEINFO_MIME_TYPE);
-        $foundMime = $finfo->file($this->tmpFile['tmp_name']);
-        if (!$foundMime) {
-            throw new MimeUploadValidator_Exception(
-                sprintf('Could not find a MIME type for file %s', $this->tmpFile['tmp_name'])
-            );
-        }
-
-        foreach ($expectedMimes as $expected) {
-            if ($this->compareMime($foundMime, $expected)) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-    /**
-     * Fetches an array of valid mimetypes.
-     *
-     * @return array
-     */
-    public function getExpectedMimeTypes($tmpFile)
-    {
-        $extension = strtolower(pathinfo($tmpFile['name'], PATHINFO_EXTENSION));
-
-        // if the finfo php extension isn't loaded, we can't complete this check.
-        if (!class_exists('finfo')) {
-            throw new MimeUploadValidator_Exception('PHP extension finfo is not loaded');
-        }
-
-        // Attempt to figure out which mime types are expected/acceptable here.
-        $expectedMimes = array();
-
-        // Get the mime types set in framework core
-        $knownMimes = Config::inst()->get('HTTP', 'MimeTypes');
-        if (isset($knownMimes[$extension])) {
-            $expectedMimes[] = $knownMimes[$extension];
-        }
-
-        // Get the mime types and their variations from mimevalidator
-        $knownMimes = Config::inst()->get(get_class($this), 'MimeTypes');
-        if (isset($knownMimes[$extension])) {
-            if (is_array($knownMimes[$extension])) {
-                $expectedMimes += $knownMimes[$extension];
-            } else {
-                $expectedMimes[] = $knownMimes[$extension];
-            }
-        }
-        return $expectedMimes;
-    }
-
-    /**
-     * Check two MIME types roughly match eachother.
-     *
-     * Before we check MIME types, remove known prefixes "vnd.", "x-" etc.
-     * If there is a suffix, we'll use that to compare. Examples:
-     *
-     * application/x-json = json
-     * application/json = json
-     * application/xhtml+xml = xml
-     * application/xml = xml
-     *
-     * @param string $first The first MIME type to compare to the second
-     * @param string $second The second MIME type to compare to the first
-     * @return boolean
-     */
-    public function compareMime($first, $second)
-    {
-        return preg_replace($this->filterPattern, '', $first) === preg_replace($this->filterPattern, '', $second);
-    }
-
-    public function validate()
-    {
-        if (parent::validate() === false) {
-            return false;
-        }
-
-        try {
-            $result = $this->isValidMime();
-            if ($result === false) {
-                $this->errors[] = _t(
-                    'File.INVALIDMIME',
-                    'File extension does not match known MIME type'
-                );
-                return false;
-            }
-        } catch (MimeUploadValidator_Exception $e) {
-            $this->errors[] = _t(
-                'File.FAILEDMIMECHECK',
-                'MIME validation failed: {message}',
-                'Argument 1: Message about why MIME type detection failed',
-                array('message' => $e->getMessage())
-            );
-            return false;
-        }
-
-        return true;
-    }
+	/**
+	 * The preg_replace() pattern to use against MIME types. Used to strip out
+	 * useless characters so matching of MIME types can be fuzzy.
+	 *
+	 * @var string Regexp pattern
+	 */
+	protected $filterPattern = '/.*[\/\.\-\+]/i';
+
+	public function setFilterPattern($pattern)
+	{
+		$this->filterPattern = $pattern;
+	}
+
+	public function getFilterPattern()
+	{
+		return $this->filterPattern;
+	}
+
+	/**
+	 * Check if the temporary file has a valid MIME type for it's extension.
+	 *
+	 * @uses finfo php extension
+	 * @return boolean|null
+	 */
+	public function isValidMime()
+	{
+		$extension = strtolower(pathinfo($this->tmpFile['name'], PATHINFO_EXTENSION));
+
+				// we can't check filenames without an extension or no temp file path, let them pass validation.
+				if (!$extension || !$this->tmpFile['tmp_name']) {
+					return true;
+				}
+
+		$expectedMimes = $this->getExpectedMimeTypes($this->tmpFile);
+		if (empty($expectedMimes)) {
+			throw new MimeUploadValidator_Exception(
+				sprintf('Could not find a MIME type for extension %s', $extension)
+			);
+		}
+
+		$finfo = new finfo(FILEINFO_MIME_TYPE);
+		$foundMime = $finfo->file($this->tmpFile['tmp_name']);
+		if (!$foundMime) {
+			throw new MimeUploadValidator_Exception(
+				sprintf('Could not find a MIME type for file %s', $this->tmpFile['tmp_name'])
+			);
+		}
+
+		foreach ($expectedMimes as $expected) {
+			if ($this->compareMime($foundMime, $expected)) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+	/**
+	 * Fetches an array of valid mimetypes.
+	 *
+	 * @return array
+	 */
+	public function getExpectedMimeTypes($tmpFile)
+	{
+		$extension = strtolower(pathinfo($tmpFile['name'], PATHINFO_EXTENSION));
+
+		// if the finfo php extension isn't loaded, we can't complete this check.
+		if (!class_exists('finfo')) {
+			throw new MimeUploadValidator_Exception('PHP extension finfo is not loaded');
+		}
+
+		// Attempt to figure out which mime types are expected/acceptable here.
+		$expectedMimes = array();
+
+		// Get the mime types set in framework core
+		$knownMimes = Config::inst()->get('HTTP', 'MimeTypes');
+		if (isset($knownMimes[$extension])) {
+			$expectedMimes[] = $knownMimes[$extension];
+		}
+
+		// Get the mime types and their variations from mimevalidator
+		$knownMimes = Config::inst()->get(get_class($this), 'MimeTypes');
+		if (isset($knownMimes[$extension])) {
+			if (is_array($knownMimes[$extension])) {
+				$expectedMimes += $knownMimes[$extension];
+			} else {
+				$expectedMimes[] = $knownMimes[$extension];
+			}
+		}
+		return $expectedMimes;
+	}
+
+	/**
+	 * Check two MIME types roughly match eachother.
+	 *
+	 * Before we check MIME types, remove known prefixes "vnd.", "x-" etc.
+	 * If there is a suffix, we'll use that to compare. Examples:
+	 *
+	 * application/x-json = json
+	 * application/json = json
+	 * application/xhtml+xml = xml
+	 * application/xml = xml
+	 *
+	 * @param string $first The first MIME type to compare to the second
+	 * @param string $second The second MIME type to compare to the first
+	 * @return boolean
+	 */
+	public function compareMime($first, $second)
+	{
+		return preg_replace($this->filterPattern, '', $first) === preg_replace($this->filterPattern, '', $second);
+	}
+
+	public function validate()
+	{
+		if (parent::validate() === false) {
+			return false;
+		}
+
+		try {
+			$result = $this->isValidMime();
+			if ($result === false) {
+				$this->errors[] = _t(
+					'File.INVALIDMIME',
+					'File extension does not match known MIME type'
+				);
+				return false;
+			}
+		} catch (MimeUploadValidator_Exception $e) {
+			$this->errors[] = _t(
+				'File.FAILEDMIMECHECK',
+				'MIME validation failed: {message}',
+				'Argument 1: Message about why MIME type detection failed',
+				array('message' => $e->getMessage())
+			);
+			return false;
+		}
+
+		return true;
+	}
 }
 
 class MimeUploadValidator_Exception extends Exception

tests/MimeUploadValidatorTest.php

Indentation +65 added lines, -65 removed lines

@@ -1,79 +1,79 @@
 <?php
 class MimeUploadValidatorTest extends SapphireTest
 {
-    public function testInvalidFileExtensionValidatingMimeType()
-    {
-        // setup plaintext file with invalid extension
-        $tmpFileName = 'UploadTest-testUpload.jpg';
-        $tmpFilePath = TEMP_FOLDER . '/' . $tmpFileName;
-        $tmpFileContent = '';
-        for ($i=0; $i<10000; $i++) {
-            $tmpFileContent .= '0';
-        }
-        file_put_contents($tmpFilePath, $tmpFileContent);
+	public function testInvalidFileExtensionValidatingMimeType()
+	{
+		// setup plaintext file with invalid extension
+		$tmpFileName = 'UploadTest-testUpload.jpg';
+		$tmpFilePath = TEMP_FOLDER . '/' . $tmpFileName;
+		$tmpFileContent = '';
+		for ($i=0; $i<10000; $i++) {
+			$tmpFileContent .= '0';
+		}
+		file_put_contents($tmpFilePath, $tmpFileContent);
 
-        // emulates the $_FILES array
-        $tmpFile = array(
-            'name' => $tmpFileName,
-            'size' => filesize($tmpFilePath),
-            'tmp_name' => $tmpFilePath,
-            'extension' => 'jpg',
-            'error' => UPLOAD_ERR_OK,
-        );
+		// emulates the $_FILES array
+		$tmpFile = array(
+			'name' => $tmpFileName,
+			'size' => filesize($tmpFilePath),
+			'tmp_name' => $tmpFilePath,
+			'extension' => 'jpg',
+			'error' => UPLOAD_ERR_OK,
+		);
 
-        $u = new Upload();
-        $u->setValidator(new MimeUploadValidator());
-        $result = $u->load($tmpFile);
-        $errors = $u->getErrors();
-        $this->assertFalse($result, 'Load failed because file extension does not match excepted MIME type');
-        $this->assertEquals('File extension does not match known MIME type', $errors[0]);
+		$u = new Upload();
+		$u->setValidator(new MimeUploadValidator());
+		$result = $u->load($tmpFile);
+		$errors = $u->getErrors();
+		$this->assertFalse($result, 'Load failed because file extension does not match excepted MIME type');
+		$this->assertEquals('File extension does not match known MIME type', $errors[0]);
 
-        unlink($tmpFilePath);
-    }
+		unlink($tmpFilePath);
+	}
 
 
-    public function testGetExpectedMimeTypes()
-    {
-        // Setup a file with a capitalised extension and try to match it against a lowercase file.
-        $tmpFileName = 'text.TXT';
-        $tmpFilePath = TEMP_FOLDER . '/' . $tmpFileName;
-        $tmpFileContent = '';
-        for ($i=0; $i<10000; $i++) {
-            $tmpFileContent .= '0';
-        }
-        file_put_contents($tmpFilePath, $tmpFileContent);
+	public function testGetExpectedMimeTypes()
+	{
+		// Setup a file with a capitalised extension and try to match it against a lowercase file.
+		$tmpFileName = 'text.TXT';
+		$tmpFilePath = TEMP_FOLDER . '/' . $tmpFileName;
+		$tmpFileContent = '';
+		for ($i=0; $i<10000; $i++) {
+			$tmpFileContent .= '0';
+		}
+		file_put_contents($tmpFilePath, $tmpFileContent);
 
-        $validator = new MimeUploadValidator();
-        $tmpFile = array(
-            'name' => $tmpFileName,
-            'tmp_name' => $tmpFilePath,
-        );
-        $expected = $validator->getExpectedMimeTypes($tmpFile);
-        $this->assertCount(1, $expected);
-        $this->assertContains('text/plain', $expected);
+		$validator = new MimeUploadValidator();
+		$tmpFile = array(
+			'name' => $tmpFileName,
+			'tmp_name' => $tmpFilePath,
+		);
+		$expected = $validator->getExpectedMimeTypes($tmpFile);
+		$this->assertCount(1, $expected);
+		$this->assertContains('text/plain', $expected);
 
-        unlink($tmpFilePath);
+		unlink($tmpFilePath);
 
-        // Test a physical ico file with capitalised extension
-        $tmpFile = array(
-            'name' => 'favicon.ICO',
-            'tmp_name' => 'assets/favicon.ICO',
-        );
-        $expected = $validator->getExpectedMimeTypes($tmpFile);
-        $this->assertCount(3, $expected);
-    }
+		// Test a physical ico file with capitalised extension
+		$tmpFile = array(
+			'name' => 'favicon.ICO',
+			'tmp_name' => 'assets/favicon.ICO',
+		);
+		$expected = $validator->getExpectedMimeTypes($tmpFile);
+		$this->assertCount(3, $expected);
+	}
 
-    public function testMimeComparison()
-    {
-        $validator = new MimeUploadValidator();
+	public function testMimeComparison()
+	{
+		$validator = new MimeUploadValidator();
 
-        $this->assertTrue($validator->compareMime('application/xhtml+xml', 'application/xml'));
-        $this->assertTrue($validator->compareMime('application/vnd.text', 'application/text'));
-        $this->assertTrue($validator->compareMime('application/vnd.vnd.text', 'application/text'));
-        $this->assertTrue($validator->compareMime('application/x-text', 'application/text'));
-        $this->assertTrue($validator->compareMime('application/gzip', 'application/gzip'));
-        $this->assertTrue($validator->compareMime('application/x-gzip', 'application/gzip'));
-        $this->assertFalse($validator->compareMime('application/png', 'application/json'));
-        $this->assertFalse($validator->compareMime('text/plain', 'text/json'));
-    }
+		$this->assertTrue($validator->compareMime('application/xhtml+xml', 'application/xml'));
+		$this->assertTrue($validator->compareMime('application/vnd.text', 'application/text'));
+		$this->assertTrue($validator->compareMime('application/vnd.vnd.text', 'application/text'));
+		$this->assertTrue($validator->compareMime('application/x-text', 'application/text'));
+		$this->assertTrue($validator->compareMime('application/gzip', 'application/gzip'));
+		$this->assertTrue($validator->compareMime('application/x-gzip', 'application/gzip'));
+		$this->assertFalse($validator->compareMime('application/png', 'application/json'));
+		$this->assertFalse($validator->compareMime('text/plain', 'text/json'));
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -7,7 +7,7 @@ 
         $tmpFileName = 'UploadTest-testUpload.jpg';
         $tmpFilePath = TEMP_FOLDER . '/' . $tmpFileName;
         $tmpFileContent = '';
-        for ($i=0; $i<10000; $i++) {
+        for ($i = 0; $i < 10000; $i++) {
             $tmpFileContent .= '0';
         }
         file_put_contents($tmpFilePath, $tmpFileContent);
@@ -38,7 +38,7 @@ 
         $tmpFileName = 'text.TXT';
         $tmpFilePath = TEMP_FOLDER . '/' . $tmpFileName;
         $tmpFileContent = '';
-        for ($i=0; $i<10000; $i++) {
+        for ($i = 0; $i < 10000; $i++) {
             $tmpFileContent .= '0';
         }
         file_put_contents($tmpFilePath, $tmpFileContent);