samayo / bulletproof

src/bulletproof.php

Indentation +451 added lines, -451 removed lines

@@ -15,456 +15,456 @@
 
 class Image implements \ArrayAccess
 {
-    /**
-     * @var string The new image name, to be provided or will be generated
-     */
-    protected $name;
-
-    /**
-     * @var int The image width in pixels
-     */
-    protected $width;
-
-    /**
-     * @var int The image height in pixels
-     */
-    protected $height;
-
-    /**
-     * @var string The image mime type (extension)
-     */
-    protected $mime;
-
-    /**
-     * @var string The full image path (dir + image + mime)
-     */
-    protected $path;
-
-    /**
-     * @var string The folder or image storage storage
-     */
-    protected $storage;
-
-    /**
-     * @var array The min and max image size allowed for upload (in bytes)
-     */
-    protected $size = array(100, 500000);
-
-    /**
-     * @var array The max height and width image allowed
-     */
-    protected $dimensions = array(5000, 5000);
-
-    /**
-     * @var array The mime types allowed for upload
-     */
-    protected $mimeTypes = array('jpeg', 'png', 'gif', 'jpg');
-
-    /**
-     * @var array list of known image types
-     */
-    protected $acceptedMimes = array(
-      1 => 'gif', 'jpeg', 'png', 'swf', 'psd',
-      'bmp', 'tiff', 'tiff', 'jpc', 'jp2', 'jpx',
-      'jb2', 'swc', 'iff', 'wbmp', 'xbm', 'ico', 'webp'
-    );
-
-    /**
-     * @var array error messages strings
-     */
-    protected $commonErrors = array(
-        UPLOAD_ERR_OK => '',
-        UPLOAD_ERR_INI_SIZE => 'Image is larger than the specified amount set by the server',
-        UPLOAD_ERR_FORM_SIZE => 'Image is larger than the specified amount specified by browser',
-        UPLOAD_ERR_PARTIAL => 'Image could not be fully uploaded. Please try again later',
-        UPLOAD_ERR_NO_FILE => 'Image is not found',
-        UPLOAD_ERR_NO_TMP_DIR => 'Can\'t write to disk, due to server configuration ( No tmp dir found )',
-        UPLOAD_ERR_CANT_WRITE => 'Failed to write file to disk. Please check you file permissions',
-        UPLOAD_ERR_EXTENSION => 'A PHP extension has halted this file upload process'
-    );
-
-    /**
-     * @var array storage for the global array
-     */
-    private $_files = array();
-
-    /**
-     * @var string storage for any errors
-     */
-    private $error = '';
-
-    /**
-     * @param array $_files represents the $_FILES array passed as dependency
-     */
-    public function __construct(array $_files = array())
-    {
-
-        /* check if php_exif is enabled */
-        if (!function_exists('exif_imagetype')) {
-          $this->error = 'Function \'exif_imagetype\' Not found. Please enable \'php_exif\' in your PHP.ini';
-          return false;
-      }
-
-      $this->_files = $_files;
-    }
-
-    /**
-     * \ArrayAccess unused method
-     * 
-     * @param mixed $offset
-     * @param mixed $value
-     */
-    public function offsetSet($offset, $value) {}
-
-    /**
-     * \ArrayAccess unused method
-     * 
-     * @param mixed $offset
-     */
-    public function offsetExists($offset){}
-
-    /**
-     * \ArrayAccess unused method
-     * 
-     * @param mixed $offset
-     */
-    public function offsetUnset($offset){}
-
-    /**
-     * \ArrayAccess - get array value from object
-     *
-     * @param mixed $offset
-     *
-     * @return string|bool
-     */
-    public function offsetGet($offset)
-    {
-        /* return false if $image['key'] isn't found */
-        if (!isset($this->_files[$offset])) {
-          $this->error = sprintf('No file input found with name: (%s)', $offset);
+	/**
+	 * @var string The new image name, to be provided or will be generated
+	 */
+	protected $name;
+
+	/**
+	 * @var int The image width in pixels
+	 */
+	protected $width;
+
+	/**
+	 * @var int The image height in pixels
+	 */
+	protected $height;
+
+	/**
+	 * @var string The image mime type (extension)
+	 */
+	protected $mime;
+
+	/**
+	 * @var string The full image path (dir + image + mime)
+	 */
+	protected $path;
+
+	/**
+	 * @var string The folder or image storage storage
+	 */
+	protected $storage;
+
+	/**
+	 * @var array The min and max image size allowed for upload (in bytes)
+	 */
+	protected $size = array(100, 500000);
+
+	/**
+	 * @var array The max height and width image allowed
+	 */
+	protected $dimensions = array(5000, 5000);
+
+	/**
+	 * @var array The mime types allowed for upload
+	 */
+	protected $mimeTypes = array('jpeg', 'png', 'gif', 'jpg');
+
+	/**
+	 * @var array list of known image types
+	 */
+	protected $acceptedMimes = array(
+	  1 => 'gif', 'jpeg', 'png', 'swf', 'psd',
+	  'bmp', 'tiff', 'tiff', 'jpc', 'jp2', 'jpx',
+	  'jb2', 'swc', 'iff', 'wbmp', 'xbm', 'ico', 'webp'
+	);
+
+	/**
+	 * @var array error messages strings
+	 */
+	protected $commonErrors = array(
+		UPLOAD_ERR_OK => '',
+		UPLOAD_ERR_INI_SIZE => 'Image is larger than the specified amount set by the server',
+		UPLOAD_ERR_FORM_SIZE => 'Image is larger than the specified amount specified by browser',
+		UPLOAD_ERR_PARTIAL => 'Image could not be fully uploaded. Please try again later',
+		UPLOAD_ERR_NO_FILE => 'Image is not found',
+		UPLOAD_ERR_NO_TMP_DIR => 'Can\'t write to disk, due to server configuration ( No tmp dir found )',
+		UPLOAD_ERR_CANT_WRITE => 'Failed to write file to disk. Please check you file permissions',
+		UPLOAD_ERR_EXTENSION => 'A PHP extension has halted this file upload process'
+	);
+
+	/**
+	 * @var array storage for the global array
+	 */
+	private $_files = array();
+
+	/**
+	 * @var string storage for any errors
+	 */
+	private $error = '';
+
+	/**
+	 * @param array $_files represents the $_FILES array passed as dependency
+	 */
+	public function __construct(array $_files = array())
+	{
+
+		/* check if php_exif is enabled */
+		if (!function_exists('exif_imagetype')) {
+		  $this->error = 'Function \'exif_imagetype\' Not found. Please enable \'php_exif\' in your PHP.ini';
+		  return false;
+	  }
+
+	  $this->_files = $_files;
+	}
+
+	/**
+	 * \ArrayAccess unused method
+	 * 
+	 * @param mixed $offset
+	 * @param mixed $value
+	 */
+	public function offsetSet($offset, $value) {}
+
+	/**
+	 * \ArrayAccess unused method
+	 * 
+	 * @param mixed $offset
+	 */
+	public function offsetExists($offset){}
+
+	/**
+	 * \ArrayAccess unused method
+	 * 
+	 * @param mixed $offset
+	 */
+	public function offsetUnset($offset){}
+
+	/**
+	 * \ArrayAccess - get array value from object
+	 *
+	 * @param mixed $offset
+	 *
+	 * @return string|bool
+	 */
+	public function offsetGet($offset)
+	{
+		/* return false if $image['key'] isn't found */
+		if (!isset($this->_files[$offset])) {
+		  $this->error = sprintf('No file input found with name: (%s)', $offset);
           
-          return false;
-        }
-
-      $this->_files = $this->_files[$offset];
-
-       /* check for common upload errors */
-      if (isset($this->_files['error'])) {
-        $this->error = $this->commonErrors[$this->_files['error']];
-      }
-
-      return $this->error ? false : true; 
-    }
-
-    /**
-     * Sets max image height and width limit.
-     *
-     * @param $maxWidth int max width value
-     * @param $maxHeight int max height value
-     *
-     * @return $this
-     */
-    public function setDimension($maxWidth, $maxHeight)
-    {
-      $this->dimensions = array($maxWidth, $maxHeight);
-
-      return $this;
-    }
-
-    /**
-     * Returns the full path of the image ex 'storage/image.mime'.
-     *
-     * @return string
-     */
-    public function getPath()
-    {
-      return $this->path = $this->getStorage() . '/' . $this->getName() . '.' . $this->getMime();
-    }
-
-    /**
-     * Returns the image size in bytes.
-     *
-     * @return int
-     */
-    public function getSize()
-    {
-      return (int) $this->_files['size'];
-    }
-
-    /**
-     * Define a min and max image size for uploading.
-     *
-     * @param $min int minimum value in bytes
-     * @param $max int maximum value in bytes
-     *
-     * @return $this
-     */
-    public function setSize($min, $max)
-    {
-      $this->size = array($min, $max);
-      return $this;
-    }
-
-    /**
-     * Returns a JSON format of the image width, height, name, mime ...
-     *
-     * @return string
-     */
-    public function getJson()
-    {
-      return json_encode(
-        array(
-          'name' => $this->name,
-          'mime' => $this->mime,
-          'height' => $this->height,
-          'width' => $this->width,
-          'size' => $this->_files['size'],
-          'storage' => $this->storage,
-          'path' => $this->path,
-        )
-      );
-    }
-
-    /**
-     * Returns the image mime type.
-     *
-     * @return null|string
-     */
-    public function getMime()
-    {
-      if (!$this->mime) {
-        $this->mime = $this->getImageMime($this->_files['tmp_name']);
-      }
-
-      return $this->mime;
-    }
-
-    /**
-     * Define a mime type for uploading.
-     *
-     * @param array $fileTypes
-     *
-     * @return $this
-     */
-    public function setMime(array $fileTypes)
-    {
-      $this->mimeTypes = $fileTypes;
-      return $this;
-    }
-
-    /**
-     * Gets the real image mime type.
-     *
-     * @param $tmp_name string The upload tmp directory
-     *
-     * @return null|string
-     */
-    protected function getImageMime($tmp_name)
-    {
-      $this->mime = @$this->acceptedMimes[exif_imagetype($tmp_name)];
-      if (!$this->mime) {
-        return null;
-      }
-
-      return $this->mime;
-    }
-
-    /**
-     * Returns error string
-     *
-     * @return string
-     */
-    public function getError()
-    {
-      return $this->error;
-    }
-
-    /**
-     * Returns the image name.
-     *
-     * @return string
-     */
-    public function getName()
-    {
-      return $this->name;
-    }
-
-    /**
-     * Provide image name if not provided.
-     *
-     * @param null $isNameProvided
-     *
-     * @return $this
-     */
-    public function setName($isNameProvided = null)
-    {
-      if ($isNameProvided) {
-        $this->name = filter_var($isNameProvided, FILTER_SANITIZE_STRING);
-      }else{
-        $this->name = uniqid('', true) . '_' . str_shuffle(implode(range('e', 'q')));
-      }
-
-      return $this;
-    }
-
-    /**
-     * Returns the image width.
-     *
-     * @return int
-     */
-    public function getWidth()
-    {
-      if ($this->width != null) {
-        return $this->width;
-      }
-
-      list($width) = getimagesize($this->_files['tmp_name']);
-
-      return $width;
-    }
-
-    /**
-     * Returns the image height in pixels.
-     *
-     * @return int
-     */
-    public function getHeight()
-    {
-      if ($this->height != null) {
-        return $this->height;
-      }
-
-      list(, $height) = getimagesize($this->_files['tmp_name']);
-
-      return $height;
-    }
-
-    /**
-     * Returns the storage / folder name.
-     *
-     * @return string
-     */
-    public function getStorage()
-    {
-      if (!$this->storage) {
-        $this->setStorage();
-      }
-
-      return $this->storage;
-    }
-
-    /**
-     * Validate directory/permission before creating a folder.
-     *
-     * @param $dir string the folder name to check
-     *
-     * @return bool
-     */
-    private function isDirectoryValid($dir)
-    {
-      return !file_exists($dir) && !is_dir($dir) || is_writable($dir);
-    }
-
-    /**
-     * Creates a storage for upload storage.
-     *
-     * @param $dir string the folder name to create
-     * @param int $permission chmod permission
-     *
-     * @return $this
-     */
-    public function setStorage($dir = 'uploads', $permission = 0666)
-    {
-      $isDirectoryValid = $this->isDirectoryValid($dir);
-
-      if (!$isDirectoryValid) {
-        $this->error = 'Can not create a directory  \''.$dir.'\', please check write permission';
-        return false;
-      }
-
-      $create = !is_dir($dir) ? @mkdir('' . $dir, (int) $permission, true) : true;
-
-      if (!$create) {
-        $this->error = 'Error! directory \'' . $dir . '\' could not be created';
-        return false;
-      }
-
-      $this->storage = $dir;
-
-      return $this;
-    }
-
-    /**
-     * Validate image size, dimension or mimetypes
-     *
-     * @return boolean
-     */
-    protected function constraintValidator()
-    {
-      /* check image for valid mime types and return mime */
-      $this->getImageMime($this->_files['tmp_name']);
-
-
-      /* validate image mime type */
-      if (!in_array($this->mime, $this->mimeTypes)) {
-        $this->error = sprintf('Invalid File! Only (%s) image types are allowed', implode(', ', $this->mimeTypes));
-        return false;
-      }
-
-      /* get image sizes */
-      list($minSize, $maxSize) = $this->size;
-
-
-      /* check image size based on the settings */
-      if ($this->_files['size'] < $minSize || $this->_files['size'] > $maxSize) {
-        $min = $minSize.' bytes ('.intval($minSize / 1000).' kb)';
-        $max = $maxSize.' bytes ('.intval($maxSize / 1000).' kb)';
-        $this->error = 'Image size should be minimum '.$min.', upto maximum '.$max;
-        return false;
-      }
-
-      /* check image dimension */
-      list($maxWidth, $maxHeight) = $this->dimensions;
-      $this->width = $this->getWidth();
-      $this->height = $this->getHeight();
-
-      if ($this->height > $maxHeight || $this->width > $maxWidth) {
-        $this->error = 'Image should be smaller than ' . $maxHeight . 'px in height, and smaller than ' . $maxWidth . 'px in width';
-        return false;
-      }
-
-      return true;
-    }
-
-    /**
-     * Validate and save (upload) file
-     *
-     * @return false|Image
-     */
-    public function upload()
-    {
-      if ($this->error !== '') {
-        return false;
-      }
-
-      $isValid = $this->constraintValidator();
-      $this->setName();
-
-      $isSuccess = $isValid && $this->isSaved($this->_files['tmp_name'], $this->getPath());
-
-      return $isSuccess ? $this : false;
-    }
-
-    /**
-     * Final upload method to be called, isolated for testing purposes.
-     *
-     * @param $tmp_name int the temporary storage of the image file
-     * @param $destination int upload destination
-     *
-     * @return bool
-     */
-    protected function isSaved($tmp_name, $destination)
-    {
-      return move_uploaded_file($tmp_name, $destination);
-    }
+		  return false;
+		}
+
+	  $this->_files = $this->_files[$offset];
+
+	   /* check for common upload errors */
+	  if (isset($this->_files['error'])) {
+		$this->error = $this->commonErrors[$this->_files['error']];
+	  }
+
+	  return $this->error ? false : true; 
+	}
+
+	/**
+	 * Sets max image height and width limit.
+	 *
+	 * @param $maxWidth int max width value
+	 * @param $maxHeight int max height value
+	 *
+	 * @return $this
+	 */
+	public function setDimension($maxWidth, $maxHeight)
+	{
+	  $this->dimensions = array($maxWidth, $maxHeight);
+
+	  return $this;
+	}
+
+	/**
+	 * Returns the full path of the image ex 'storage/image.mime'.
+	 *
+	 * @return string
+	 */
+	public function getPath()
+	{
+	  return $this->path = $this->getStorage() . '/' . $this->getName() . '.' . $this->getMime();
+	}
+
+	/**
+	 * Returns the image size in bytes.
+	 *
+	 * @return int
+	 */
+	public function getSize()
+	{
+	  return (int) $this->_files['size'];
+	}
+
+	/**
+	 * Define a min and max image size for uploading.
+	 *
+	 * @param $min int minimum value in bytes
+	 * @param $max int maximum value in bytes
+	 *
+	 * @return $this
+	 */
+	public function setSize($min, $max)
+	{
+	  $this->size = array($min, $max);
+	  return $this;
+	}
+
+	/**
+	 * Returns a JSON format of the image width, height, name, mime ...
+	 *
+	 * @return string
+	 */
+	public function getJson()
+	{
+	  return json_encode(
+		array(
+		  'name' => $this->name,
+		  'mime' => $this->mime,
+		  'height' => $this->height,
+		  'width' => $this->width,
+		  'size' => $this->_files['size'],
+		  'storage' => $this->storage,
+		  'path' => $this->path,
+		)
+	  );
+	}
+
+	/**
+	 * Returns the image mime type.
+	 *
+	 * @return null|string
+	 */
+	public function getMime()
+	{
+	  if (!$this->mime) {
+		$this->mime = $this->getImageMime($this->_files['tmp_name']);
+	  }
+
+	  return $this->mime;
+	}
+
+	/**
+	 * Define a mime type for uploading.
+	 *
+	 * @param array $fileTypes
+	 *
+	 * @return $this
+	 */
+	public function setMime(array $fileTypes)
+	{
+	  $this->mimeTypes = $fileTypes;
+	  return $this;
+	}
+
+	/**
+	 * Gets the real image mime type.
+	 *
+	 * @param $tmp_name string The upload tmp directory
+	 *
+	 * @return null|string
+	 */
+	protected function getImageMime($tmp_name)
+	{
+	  $this->mime = @$this->acceptedMimes[exif_imagetype($tmp_name)];
+	  if (!$this->mime) {
+		return null;
+	  }
+
+	  return $this->mime;
+	}
+
+	/**
+	 * Returns error string
+	 *
+	 * @return string
+	 */
+	public function getError()
+	{
+	  return $this->error;
+	}
+
+	/**
+	 * Returns the image name.
+	 *
+	 * @return string
+	 */
+	public function getName()
+	{
+	  return $this->name;
+	}
+
+	/**
+	 * Provide image name if not provided.
+	 *
+	 * @param null $isNameProvided
+	 *
+	 * @return $this
+	 */
+	public function setName($isNameProvided = null)
+	{
+	  if ($isNameProvided) {
+		$this->name = filter_var($isNameProvided, FILTER_SANITIZE_STRING);
+	  }else{
+		$this->name = uniqid('', true) . '_' . str_shuffle(implode(range('e', 'q')));
+	  }
+
+	  return $this;
+	}
+
+	/**
+	 * Returns the image width.
+	 *
+	 * @return int
+	 */
+	public function getWidth()
+	{
+	  if ($this->width != null) {
+		return $this->width;
+	  }
+
+	  list($width) = getimagesize($this->_files['tmp_name']);
+
+	  return $width;
+	}
+
+	/**
+	 * Returns the image height in pixels.
+	 *
+	 * @return int
+	 */
+	public function getHeight()
+	{
+	  if ($this->height != null) {
+		return $this->height;
+	  }
+
+	  list(, $height) = getimagesize($this->_files['tmp_name']);
+
+	  return $height;
+	}
+
+	/**
+	 * Returns the storage / folder name.
+	 *
+	 * @return string
+	 */
+	public function getStorage()
+	{
+	  if (!$this->storage) {
+		$this->setStorage();
+	  }
+
+	  return $this->storage;
+	}
+
+	/**
+	 * Validate directory/permission before creating a folder.
+	 *
+	 * @param $dir string the folder name to check
+	 *
+	 * @return bool
+	 */
+	private function isDirectoryValid($dir)
+	{
+	  return !file_exists($dir) && !is_dir($dir) || is_writable($dir);
+	}
+
+	/**
+	 * Creates a storage for upload storage.
+	 *
+	 * @param $dir string the folder name to create
+	 * @param int $permission chmod permission
+	 *
+	 * @return $this
+	 */
+	public function setStorage($dir = 'uploads', $permission = 0666)
+	{
+	  $isDirectoryValid = $this->isDirectoryValid($dir);
+
+	  if (!$isDirectoryValid) {
+		$this->error = 'Can not create a directory  \''.$dir.'\', please check write permission';
+		return false;
+	  }
+
+	  $create = !is_dir($dir) ? @mkdir('' . $dir, (int) $permission, true) : true;
+
+	  if (!$create) {
+		$this->error = 'Error! directory \'' . $dir . '\' could not be created';
+		return false;
+	  }
+
+	  $this->storage = $dir;
+
+	  return $this;
+	}
+
+	/**
+	 * Validate image size, dimension or mimetypes
+	 *
+	 * @return boolean
+	 */
+	protected function constraintValidator()
+	{
+	  /* check image for valid mime types and return mime */
+	  $this->getImageMime($this->_files['tmp_name']);
+
+
+	  /* validate image mime type */
+	  if (!in_array($this->mime, $this->mimeTypes)) {
+		$this->error = sprintf('Invalid File! Only (%s) image types are allowed', implode(', ', $this->mimeTypes));
+		return false;
+	  }
+
+	  /* get image sizes */
+	  list($minSize, $maxSize) = $this->size;
+
+
+	  /* check image size based on the settings */
+	  if ($this->_files['size'] < $minSize || $this->_files['size'] > $maxSize) {
+		$min = $minSize.' bytes ('.intval($minSize / 1000).' kb)';
+		$max = $maxSize.' bytes ('.intval($maxSize / 1000).' kb)';
+		$this->error = 'Image size should be minimum '.$min.', upto maximum '.$max;
+		return false;
+	  }
+
+	  /* check image dimension */
+	  list($maxWidth, $maxHeight) = $this->dimensions;
+	  $this->width = $this->getWidth();
+	  $this->height = $this->getHeight();
+
+	  if ($this->height > $maxHeight || $this->width > $maxWidth) {
+		$this->error = 'Image should be smaller than ' . $maxHeight . 'px in height, and smaller than ' . $maxWidth . 'px in width';
+		return false;
+	  }
+
+	  return true;
+	}
+
+	/**
+	 * Validate and save (upload) file
+	 *
+	 * @return false|Image
+	 */
+	public function upload()
+	{
+	  if ($this->error !== '') {
+		return false;
+	  }
+
+	  $isValid = $this->constraintValidator();
+	  $this->setName();
+
+	  $isSuccess = $isValid && $this->isSaved($this->_files['tmp_name'], $this->getPath());
+
+	  return $isSuccess ? $this : false;
+	}
+
+	/**
+	 * Final upload method to be called, isolated for testing purposes.
+	 *
+	 * @param $tmp_name int the temporary storage of the image file
+	 * @param $destination int upload destination
+	 *
+	 * @return bool
+	 */
+	protected function isSaved($tmp_name, $destination)
+	{
+	  return move_uploaded_file($tmp_name, $destination);
+	}
 }
\ No newline at end of file