3 # This program is in the public domain within the United States. Additionally,
4 # we waive copyright and related rights in the work worldwide through the CC0
5 # 1.0 Universal public domain dedication, which can be found at
6 # http://creativecommons.org/publicdomain/zero/1.0/
9 # This file contains functions to accept files being uplodad with the <input
10 # type="file" name="foo"> control.
16 # First, your <form> tag must contain this attribute:
17 # enctype="multipart/form-data"
19 # Second, you should indicate to the browser the maximum file size (in bytes)
20 # allowed for uploads with a hidden input field named MAX_FILE_SIZE. You can
21 # use the function upload_max_filesize() to get the maximum allowed size that
26 # <form action="foo.php" enctype="multipart/form-data" method="post">
27 # <input type="hidden" name="MAX_FILE_SIZE" value="2097152">
28 # <input type="file" name="photo">
29 # <input type="submit" name="save" value="Save">
36 # In the php code you can use either save_uploaded_file('photo',
37 # 'upload/dir/'); or save_uploaded_image('photo', 'upload/dir/'); The only
38 # difference being that save_uploaded_image() will convert gifs to PNGs.
40 # Both functions will generate a reasonable filename based on the filename
41 # passed from the browser (and on the mime-type if there's no extension) unless
42 # you specify a filename. See the comments above the function definitions below
45 # In a future version of save_uploaded_image(), when you specify a filename, it
46 # will check the image type of the uploaded image, and if it's different than
47 # the type you specified, it will convert the image for you.
50 $GLOBALS['mime_to_ext'] = array(
51 'text/plain' => 'txt',
52 'text/html' => 'html',
53 'image/jpeg' => 'jpg',
58 'application/pdf' => 'pdf'
61 $GLOBALS['ext_to_ext'] = array(
68 # return the upload_max_filesize in bytes
69 function upload_max_filesize() {
70 $max = ini_get('upload_max_filesize');
71 $postfix = strtolower(substr($max, -1));
73 return substr($max, 0, -1) * 1073741824;
74 } elseif($postfix == 'm') {
75 return substr($max, 0, -1) * 1048576;
76 } elseif ($postfix == 'k') {
77 return substr($max, 0, -1) * 1024;
84 # pass in the client's path that came from an html <input type="file"/> tag
86 # mime time used to generate extension ONLY IF it doesn't have one already.
87 function generate_filename($path, $mime = 'text/plain') {
89 $filename = strtolower($path);
91 # remove directories (unix, windows and mac paths)
92 $last = strrpos($filename, '/');
94 $last = strrpos($filename, '\\');
97 $last = strrpos($filename, ':');
100 $filename = substr($filename, $last + 1);
103 # replace symbols with underscores
104 $filename = preg_replace('|[^a-z0-9_.]|', '_', $filename);
106 # remove dots from the beginning (no invisible files)
107 $filename = preg_replace('|^\.*|', '', $filename);
109 if(strlen($filename > 80)) {
110 $filename = substr($filename, -80);
114 $last_dot = strrpos($filename, '.');
115 if($last_dot === false) {
117 if(isset($GLOBALS['mime_to_ext'][$mime])) {
118 $filename .= '.' . $GLOBALS['mime_to_ext'][$mime];
123 $basename = substr($filename, 0, $last_dot);
124 $ext = substr($filename, $last_dot + 1);
125 if(isset($GLOBALS['ext_to_ext'][$ext])) {
126 $ext .= $GLOBALS['ext_to_ext'][$ext];
128 $filename = $basename . '.' . $ext;
135 # Move uploaded file, and return the new filename.
137 # $key: Pass in the index into the $_FILES array (the name of the html input tag) and
138 # the path to the folder you'd like it saved to.
140 # $path: If path ends with a slash this function will generate a filename based
141 # on the client's name. If it ends with a period, the dot will be removed and
142 # the client's name appended. Otherwise $path will be used as the filename
143 # exactly as is, even if extensions differ between the client's name and $path.
145 # where user uploads "c:\foo\Bar baz.PDF" at <input name="in" type="file">
146 # save_uploaded_file('in', 'uploaded_pdfs/'); yeilds:
147 # "uploaded_pdfs/bar_baz.pdf"
148 # save_uploaded_file('in', 'uploaded_pdfs/prefix.'); yeilds:
149 # "uploaded_pdfs/prefixbar_baz.pdf"
150 # save_uploaded_file('in', 'uploaded_pdfs/qux.pdf'); yeilds:
151 # "uploaded_pdfs/qux.pdf"
152 function save_uploaded_file($key, $path) {
153 $end = substr($path, -1);
154 if($end == '.' || $end == '/') {
156 $path = substr($path, 0, -1);
158 $filename = $path . generate_filename($_FILES[$key]['name'], $_FILES[$key]['type']);
163 if(!move_uploaded_file($_FILES[$key]['tmp_name'], $filename)) {
170 # this function exists to deal with cases where binaries are installed in very
171 # standard places (like /usr/bin or /usr/local bin) and PHP's PATH environment
172 # variable is not set appropriately.
173 function path_to($prog, $or_die = true) {
174 $prog = preg_replace('|[^a-z0-9_.-]|i', '', $prog);
175 $prog = preg_replace('|^[-.]*|', '', $prog);
177 die('Invalid argument to path_to()');
180 if(!isset($GLOBALS["path_to_$prog"])) {
181 $ret = _path_to($prog, $or_die);
185 $GLOBALS["path_to_$prog"] = $ret;
188 return $GLOBALS["path_to_$prog"];
191 function _path_to($prog, $or_die) {
192 # relies on PHP's short-circuit mechanism
193 if(file_exists($path = "/usr/local/bin/$prog") ||
194 file_exists($path = "/usr/bin/$prog") ||
195 ($path = `which $prog` != '' && file_exists($path))) {
199 die("Failed to locate '$prog' executable.");
206 # returns new filename with .png extension
207 function gif_to_png($filename, $new_filename = 'just change extension') {
208 if($new_filename == 'just change extension') {
209 $new_filename = $filename;
210 $last_dot = strrpos($new_filename, '.');
211 if($last_dot !== false) {
212 $new_filename = substr($new_filename, 0, $last_dot);
214 $new_filename .= '.png';
217 imagemagick_convert($filename, $new_filename, "-colorspace sRGB", 'GIF to PNG conversion');
220 return $new_filename;
223 # make a thumbnail image.
225 # Thumbnail will have the same filename, except "_thumb" will be added right
226 # before the dot preceding the extension. so foo.png yields foo_thumb.png
228 # Thumbnail will retain aspect ratio, and be either $max_width wide or
229 # $max_height tall (or, if the aspect is just right, both)
230 function make_thumbnail($filename, $max_width = '70', $max_height = '70') {
231 $last_dot = strrpos($filename, '.');
232 if($last_dot === false) {
233 die("couldn't make thumbnail because filename has no extension.");
236 $thumb = substr($filename, 0, $last_dot);
238 $thumb .= substr($filename, $last_dot);
240 $max_width = format_int_70($max_width);
241 $height_width = format_int_70($height_width);
243 imagemagick_convert($filename, $thumb, "-geometry ${max_width}x$max_height", 'Thumbnail creation');
248 function exec_or_die($command, $doing_what) {
249 exec($command, $dummy, $ret);
251 $base = basename(preg_replace('| .*|', '', $command));
252 die("$doing_what failed. $base called exit($ret)");
256 # exec convert from imagemagick.
257 function imagemagick_convert($in_filename, $out_filename, $args, $doing_what = "Image conversion") {
258 $in = escapeshellarg($in_filename);
259 $out = escapeshellarg($out_filename);
260 $command = path_to('convert') . " $in $args $out";
262 exec_or_die($command, $doing_what);
265 # exec mogrify from imagemagick.
266 function imagemagick_mogrify($in_filename, $args, $doing_what = "Image conversion") {
267 $command = path_to('mogrify') . " $args " . escapeshellarg($in_filename);
269 exec_or_die($command, $doing_what);
272 function format_int_70($str) {
273 $str = preg_replace('|[^0-9]|', '', $str);
283 # The image will retain aspect ratio, and be either $max_width wide or
284 # $max_height tall (or, if the aspect is just right, both)
285 function resize_image($filename, $max_width = '70', $max_height = '70') {
286 $max_width = format_int_70($max_width);
287 $height_width = format_int_70($height_width);
289 imagimagick_mogrify($filename, "-geometry ${max_width}x$max_height");
292 # Argument: path to image file
294 # Return: string in the format WIDTHxHEIGHT, or boolean false
296 # Example: image_dimensions('uploads/foo.png'); ==> "124x58"
297 function image_dimensions($image) {
298 $identify = path_to('identify');
299 $command = "$identify -format '%wx%h' " . escapeshellarg($image);
300 $dimensions = rtrim(`$command`);
301 if($dimensions == '') {
308 # return an array of the width and height of the image passed.
309 # calls die() if this can't be done for any reason.
310 function image_w_h_or_die($filename) {
311 $wxh = image_dimensions($filename);
313 die("couldn't git image dimensions of $filename");
315 $wh = explode('x', $wxh);
316 if(count($wh) != 2) {
317 die("image $filename seems to have " . count($wh) . ' dimensions');
323 # Like save_uploaded_file() (above) except that it converts all images to PNG
324 # or JPEG, converts to sRGB colorspace, and optionally scales and/or creates a
325 # thumbnail. And, if $path ends with a period, the correct extension will be
328 # You are encouraged to use convert_uploaded_image() instead of this function,
329 # because it has a more useful return value.
331 # If the image_width and image_height parameters are above zero, then the image
332 # will be scaled (see below).
334 # If the thumb_width and thumb_height parameters are above zero, then a 2nd
335 # image will be created and scaled (see below) with the same name, except
336 # having "_thumb" added before the extension.
338 # Scaling: images are scaled (maintaining the aspect ratio) so they are as big
339 # as possible without either dimension being larger than what you specify.
341 # This function just returns the name of the main image. To get the dimensions
342 # and names, call convert_uploaded_image().
343 function save_uploaded_image($key, $path, $image_width = 0, $image_height = 0, $thumbnail_width = 0, $thumbnail_height = 0) {
344 $image_w_h_thumb_w_h = convert_uploaded_image($key, $path, $image_width, $image_height, $thumbnail_width, $thumbnail_height);
345 return preg_replace('| .*|', '', $image_w_h_thumb_w_h);
348 function ext_to_web_image_ext($in) {
349 if($in == 'png' || $in == 'gif') {
356 # this function is just like save_uploaded_image() above except that the return
357 # value is a string like "filename width height" or (if you specified both
358 # thumbnail dimensions) "image_filename image_width image_height thumb_filename
359 # thumb_width thumb_height"
363 # convert_uploaded_image('image', 'uploads/', 500, 500);
364 # might return: "uploads/foo.jpg 500 400"
365 # convert_uploaded_image('image', 'uploads/', 500, 500, 70, 70);
366 # might return: "uploads/foo.jpg 500 400 uploads/foo_thumb.jpg 70 56"
367 function convert_uploaded_image($key, $path, $image_width = 0, $image_height = 0, $thumb_width = 0, $thumb_height = 0) {
369 $tmp_filename = save_uploaded_file($key, $path . '__.');
370 $ext_rpos = strrpos($tmp_filename, '.');
371 if($ext_rpos === false) {
372 die('save_uploaded_file() gave us a filename with no extension.');
374 $tmp_base = substr($tmp_filename, 0, $ext_rpos);
375 $tmp_ext = substr($tmp_filename, $ext_rpos + 1);
376 if(substr($path, -1) == '/') {
377 $filename = $path . substr($tmp_base, strlen($path) + 2);
378 $filename .= '.' . ext_to_web_image_ext($tmp_ext);
379 } elseif(substr($path, -1) == '.') {
380 $filename = $path . ext_to_web_image_ext($tmp_ext);
385 $convert_params = '-colorspace sRGB -auto-orient';
386 if($image_width > 0 && $image_height > 0) {
387 $convert_params .= " -geometry ${image_width}x$image_height";
389 imagemagick_convert($tmp_filename, $filename, $convert_params);
390 unlink($tmp_filename);
391 list($w, $h) = image_w_h_or_die($filename);
392 $ret = "$filename $w $h";
393 if($thumb_width > 0 && $thumb_height > 0) {
394 $thumb_name = make_thumbnail($filename, $thumb_width, $thumb_height);
395 list($w, $h) = image_w_h_or_die($thumb_name);
396 $ret .= " $thumb_name $w $h";