berthojoris / bulletproof

PHP Image upload, watermark, shrink, crop with optimal security

BULLETPROOF

SECURE PHP IMAGE UPLOADER

This is a one-file solution for a secure upload, crop, resize & watermark images in PHP.

Enable php_exif extension in your php.ini before using this class.

=====

First Step;

/* as usual, require the src file and instanciate the class */
require_once  "src\bulletproof.php";
$bulletProof = new ImageUploader\BulletProof;

SCENARIO 1: Upload with the default settings. (Less code)

/* This example will use most of the default settings in the class and uploads
 * a (jpg, gif, png, jpeg) image types, with sizes ranging from 0.1kb to max 30kbs
 * It will also create a folder called "uploads" for the storage with chmod (permission)
 * 0666 if it does not exist. If you want to create your a folder, use ->uploadDir('dirName')
 *
 * Also, the variable $bulletProof will contain the upload directory, and the new image name
 * and its path (if the upload was a success). Which can be useful, for inserting the image
 * path/name your db, or show the image directly using: <img src=' <?= $bulletproof} ?> '/>
 */ 
if($_FILES){
    echo $bulletProof->upload($_FILES['picture']); //ex: uploads/blue_cat.jpg
}

SCENARIO 2: Upload image with custom Size, Type, Dimension & Upload Location.

/* Here is an example, of image upload with strict and costum choices */
$bulletProof
    ->fileTypes(array("png", "jpeg")) // accept only png and jpeg images
    ->uploadDir("pictures") // upload images to or create folder (if it does not exist)
    ->limitSize(array("min"=>1000, "max"=>55000)) // limit image size (in bytes)
    ->limitDimension(array("height"=>100, "width"=>120)); // limit image dimensions
    ->upload($_FILES['picture']);

SCENARIO 3: Shrink the image, and Upload.

/* shrink() - will shrink/resize the image according to the given dimensions (in pixels) 
 * NOTE, a folder called 'shrinked_images' will be created first to store the uploaded image
 */ 
$bulletProof
    ->fileTypes(array("jpg", "gif", "png", "jpeg"))
    ->uploadDir("shrinked_images")
    ->shrink(array("height"=>100, "width"=>200))
    ->upload($_FILES["pictures"]);

SCENARIO 4: Add a watermark and Upload.

/* watermark() - will accept two arguments.
 * First: The image to use as watermark. (best to use a PNG).
 * Second: The Location where to put your watermark on the image.
 * Location can be a string 'center', 'bottom-right', 'bottom-left', 'top-left'...
 */
$bulletProof
    ->fileTypes(array("png"))
    ->uploadDir("watermarked")
    ->watermark('watermark.png', 'bottom-right'))
    ->upload($_FILES['logo']);

SCENARIO 5: Crop and Upload.

/* crop() - Width and height (in pixels) for image crop.
 * crop is not like shrink, it simply will trim/cut the image
 * and return what is left, whereas shrink will not trim the image.
 */
$bulletProof
    ->fileTypes(array("png"))
    ->uploadDir("watermarked")
    ->crop(array("height"=>40, "width"=>50))
    ->upload($_FILES['logo']);

Please check the examples folder for list of boilerplate codes

Notes:

The upload() method accepts two arguments. First the Image, and second (optional), a new name for that image. If you provide a name, then the uploaded image will be renamed, otherwise a new random&unique name will be generated

// Uploaded file will be renamed 'cheeez' plus the file mime type i.e (jpg/png/gif...).
->upload($_FILES['fileName'], 'cheeez');

// file will be named ex '1531e4b0e3bc82_QPIJLMPKQNJGF' plus the mime type
->upload($_FILES['fileName']);

The change() method is different from upload() and should not be mixed. The change() will allow you to directly crop/resize/watermark an image that is already uploaded. Think of it like this: you have a buch of images on your server, you would like to watermark, then you can simply do a loop over them using glob() or watever, and watermark/crop/shrink all or a specific one.

// The change method is like accessing any file physically and making change to it. 
//CROP IMAGES
$change = $bulletProof
 	->crop(array("height"=>10, "width"=>10))
 	->change("crop", "my_pictures/awesome.gif");

// WATERMARK IMAGES
$change = $bulletProof
 	->watermark("logo.png", "center")
 	->change("watermark", "my_pictures/passport.gif");

// SHRINK IMAGES
$change = $bulletProof
 	->shrink(array("height"=>30, "width"=>50))
 	->change("shrink", "my_pictures/paris.jpg");

What makes this secure ?

• It checks any errors thrown from the $_FILES[]['error'] array.
• It uses exif_imagetype() method to get the real mime/image type,
• Checks if image type exists in the expected types ie. array('jpg', 'png', 'gif', 'jpeg')
• Checks getimagesize(); to see if the image has a valid width/height measurable in pixels.
• Uses is_uploaded_file() to check for a secure upload HTTP Post method, (extra security check).

Todo

• Allow Image Resizing Done.
• Allow Image Watermarking Done.
• Allow Image Cropping Done.
• Handle Errors with Exceptions Done.
• Backward compatability for PHP 5.3 Done.
• Single Responsibility Principle

License

Luke 3:11 ( Free; No license! )