BULLETPROOF

SECURE PHP IMAGE UPLOADER

This class allows you to do two things! First is to upload images while cropping, resizing and watermarking it. The second is, to do the same as above but without uploading. It means, you can crop/resize/watermark any image any time. Please check examples.php for a complete guide.

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

=====

THE START: requiring and instantiating the class.

/** As usual: Require and call the class only */
require_once "ImageUploader\BulletProof.php";
$bulletProof = new ImageUploader\BulletProof;

SCENARIO 1: Uploading images with the default setting. (Less code)

/*
 *   This will use the default settings of the class and will upload only
 *   (jpg, gif, png, jpeg) images with sizes ranging from 0.1kb to max 30kbs
 *   It will also create a folder called "uploads" with chmod 0777 if it does not exist.
 */ 
if($_FILES){
    echo $bulletProof->upload($_FILES['picture']);
 }

SCENARIO 2: Upload images with different size/type/dimension (Moaarr code)

/*
 *   fileTypes() - What type of images to upload. ex: jpg, gif, png..
 *   uploadDir() - Create/Assing a folder name to store the uploads.
 *   limitSize() - Set a limit on the min and max image size for uploads (in bytes)
 *   limitDimension() - Set the MAX height and width of image upload  (in pixels)
 */
echo $bulletProof
        ->fileTypes(array("png", "jpeg"))
        ->uploadDir("my_pictures")
        ->limitSize(array("min"=>1000, "max"=>100000))
        ->limitDimension(array("height"=>100, "width"=>100));
        ->upload($_FILES['picture']);

/*  Always, use try/Catch to handle errors, if there are no errors the variable
 *   $bulletProof will contain the path/image of the uploaded image.
 *   So, you can simply store it in db or echo it like  <img src='$bulletProof' />;        
 */

SCENARIO 3: Shrink/Resize and upload image.

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

SCENARIO 4: Watermark and upload image.

/*
 *   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("jpeg"))
    ->uploadDir("watermarked")
    ->watermark('watermark.png', 'bottom-right'))
    ->upload($_FILES['logo']);

SCENARIO 5: Crop and upload image

/*
 *   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("jpeg"))
    ->uploadDir("watermarked")
    ->crop(array("height"=>40, "width"=>50))
    ->upload($_FILES['logo']);

Please check the examples.php for more functions and all tested examples.

NOTE:

The upload() method accepts two arguments. First the Image, and second (optional), a new name for the image. If you provide a name, it will be used as a new name for the upload, if not a 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 and handles any errors thrown from $_FILES[]['error'].
• It uses exif_imagetype() method to get the real mime/image type,
• Checks if MIME type exists in the expected image 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).

Whats next?

• Allow Image Resizing Done!
• Allow Image Watermarking Done!
• Allow Image Cropping Done!
• Handle Errors with Exceptions Done!
• Backward compatability for PHP 5.3 Done!
• Allow text watermarking <-- discontinued!

###License
Luke 3:11