Delicious Bookmark this on Delicious Share on Facebook SlashdotSlashdot It! Digg! Digg



PHP : Function Reference : Filesystem Functions : is_uploaded_file

is_uploaded_file

Tells whether the file was uploaded via HTTP POST (PHP 4 >= 4.0.3, PHP 5)
bool is_uploaded_file ( string filename )

Returns TRUE if the file named by filename was uploaded via HTTP POST. This is useful to help ensure that a malicious user hasn't tried to trick the script into working on files upon which it should not be working--for instance, /etc/passwd.

This sort of check is especially important if there is any chance that anything done with uploaded files could reveal their contents to the user, or even to other users on the same system.

For proper working, the function is_uploaded_file() needs an argument like $_FILES['userfile']['tmp_name'], - the name of the uploaded file on the clients machine $_FILES['userfile']['name'] does not work.

Parameters

filename

The filename being checked.

Return Values

Returns TRUE on success or FALSE on failure.

Examples

Example 657. is_uploaded_file() example

<?php

if (is_uploaded_file($_FILES['userfile']['tmp_name'])) {
  echo
"File ". $_FILES['userfile']['name'] ." uploaded successfully.\n";
  echo
"Displaying contents\n";
 
readfile($_FILES['userfile']['tmp_name']);
} else {
  echo
"Possible file upload attack: ";
  echo
"filename '". $_FILES['userfile']['tmp_name'] . "'.";
}

?>


Example 658. is_uploaded_file() example for PHP 4 < 4.0.3

The following example will not work in versions of PHP 4 after 4.0.2. It depends on internal functionality of PHP which changed after that version.

<?php
/* Userland test for uploaded file. */
function is_uploaded_file_4_0_2($filename)
{
   if (!
$tmp_file = get_cfg_var('upload_tmp_dir')) {
       
$tmp_file = dirname(tempnam('', ''));
   }
   
$tmp_file .= '/' . basename($filename);
   
/* User might have trailing slash in php.ini... */
   
return (ereg_replace('/+', '/', $tmp_file) == $filename);
}

/* This is how to use it, since you also don't have
* move_uploaded_file() in these older versions: */
if (is_uploaded_file_4_0_2($HTTP_POST_FILES['userfile'])) {
   
copy($HTTP_POST_FILES['userfile'], "/place/to/put/uploaded/file");
} else {
   echo
"Possible file upload attack: filename '$HTTP_POST_FILES[userfile]'.";
}
?>


See Also
move_uploaded_file()
See Handling file uploadsfor a simple usage example.

Related Examples ( Source code ) » is_uploaded_file



Code Examples / Notes » is_uploaded_file

troels

to get the example to work on windows, youll have to add a line, that replaces backslashes with slashes. eg.: $filename = str_replace ("\\", "/", $filename);
also, as someone mentioned, globalizing $HTTP_POST_FILES is a good idea ...
<pre>
/* Userland test for uploaded file. */
function is_uploaded_file($filename)
{
global $HTTP_POST_FILES;
if (!$tmp_file = get_cfg_var("upload_tmp_dir")) {
$tmp_file = dirname(tempnam("", ""));
}
$tmp_file .= "/" . basename($filename);
/* User might have trailing slash in php.ini... */
// fix for win platform
$filename = str_replace ("\\", "/", $filename);
return (ereg_replace("/+", "/", $tmp_file) == $filename);
}
</pre>


itadmin

The example brought out does not work as supposed to:
function is_uploaded_file($filename) {
   if (!$tmp_file = get_cfg_var('upload_tmp_dir')) {
       $tmp_file = dirname(tempnam('', ''));
   }
   $tmp_file .= '/' . basename($filename);
   /* User might have trailing slash in php.ini... */
   return (ereg_replace('/+', '/', $tmp_file) == $filename);
}
It works only with files under ....4 or 5 kb, other files automatically get the size of 0 bytes. So something must be wrong here. Built-in is_uploaded_file() works good.


exonie

The description in the manual above says that the function needs an argument like:
<?php
$_FILES['userfile']['tmp_name']
?>
Which is incorrect! This variable returns the pathname of the temp file (with random filename) that is created by php and, besides, is a superglobal so there is no way that it is overridden to point to another file (by injection when register_globals is on for example). Which means that:
<?php
is_uploaded_file($_FILES['userfile']['tmp_name']);
?>
MUST always evaluate to true by definition which is, of course, useless.
The function is to be used only with variables that are prone to injection, which should not happen anyway since everyone should have their register globals off (finally we get rid of that in PHP6).
Only $_FILES['userfile']['name'] contains user submitted string and should be sanitized if it's to be used as a filename because it could (could it?) contain relative or absolute path or undesirable filename. The former is done simply with:
<?php
 $filename = basename($_FILES['userfile']['name']);
?>


r3gan

Remeber, if using $HTTP_POST_FILES inside a function and it doesn't seem to work, try globalizing the array:
function UploadFile() {
   global $HTTP_POST_FILES;
   // rest of your code here
}  // end UploadFile


ylearn

Regarding topcat's suggested change, I am split on doing that.  I don't like showing users errors that may give them more information than they should have (or show that I haven't provided for that particular error).  But I want to know when there are errors that fall to the default case so I can fix my code.  What I will typically do is write them to the error log something like this modification to metaltoad's post (takes into account the possibility of multi-line errors which error_log doesn't handle well):
<?php
   default: //a default error, just in case!  :)
       echo "There was a problem with your upload.";
       $err_msg = "Unrecognized file POST error: ".$HTTP_POST_FILES['userfile']['error'];
       if ((strpos($err_msg, "\n") === 0) {
           $err_lines = explode("\n", $err_msg);
           foreach ($err_lines as $msg) {
               error_log($msg, 0);
           }
       } else {
           error_log($err_msg, 0)
       }
       break;
?>


beer undrscr nomaed

Regarding the comment of info at metaltoad dot net
@ 19-Feb-2003 04:03
<?php
// ... yada yada yada...
preg_match("/.exe$|.com$|.bat$|.zip$|.doc$|.txt$/i", $HTTP_POST_FILES['userfile']['name']))
// ... yada yada yada...
?>
This will not work. It will, but not correctly.
You shuld escape the . (dot) for the preg function,
and escape the $ (dollar) sign for PHP, or use
single-quoted string...
The syntax should be (much shorter and neater):
<?php
// ... yada yada yada...
preg_match('/\\.(exe|com|bat|zip|doc|txt)$/i', $_FILES['userfile']['name']))
// ... yada yada yada...
?>


23-apr-2005 08:29

make use u got the enctype="multipart/form-data" in ur form tag otrherwise nothing works... took me two hours to find that out.......

ylearn

Just looked at what I posted again and found several mistakes of the major and minor sort.  That's what I get for posting before I finish my coffee.  This should work better (i.e. should work in the first place):
<?php
  default: //a default error, just in case!  :)
      echo "There was a problem with your upload.";
      $err_msg = "Unrecognized file POST error: ".$HTTP_POST_FILES['userfile']['error'];
      if (!(strpos($err_msg, "\n") === false)) {
          $err_lines = explode("\n", $err_msg);
          foreach ($err_lines as $msg) {
              error_log($msg, 0);
          }
      } else {
          error_log($err_msg, 0);
      }
      break;
?>


topcat

Just a little tip to info at metaltoad's comment:
It's good practice to print error code when it can't be recognized:
  default: //print the error code
    echo "Unrecognized error code: ".$HTTP_POST_FILES['userfile']['error'];
    break;


uramihsayibok, gmail, com

It isn't mentioned anywhere that I've seen, but $filename *is* case-sensitive on Windows.
It means that while C:\Windows\TEMP\php123.tmp may have been uploaded, C:\Windows\Temp\php123.tmp was not.
I found this out because I was using realpath() on the filename which 'fixed' the case (my Temp folder is in titlecase, not uppercase - thank you Vista).
Anyways, the problem was that PHP used %TEMP% to determine the destination for the uploaded file, and %TEMP% used the all-capitals version of the path. Changing it to use titlecase instead + restarting Apache fixed the problem.


juk

If your $_FILES and $_POST are empty, this can be due to
- the limit set by post_max_size in php.ini
- the limit set by upload_max_filesize in php.ini
Unfortunately the first limit is not reported back as an error code in $_FILES['error'].


phpnetmark

If you are importing the uploaded file into a BLOB field in a mysql database and you are using LOAD_FILE() sql statement then be aware that  mysql checks max-allowed-packet mysql variable.
- if the size of the binary file LOAD_FILE is importing is bigger than
max-allowed-packet size then it LOAD_FILE will return null.
You can specify max-allowed-packet size in the call to mysqld eg:
./bin/safe_mysqld --user=mysql --max-allowed-packet=16M &
Full info on this variable is available here:
http://www.mysql.com/doc/en/Packet_too_large.html


gordon luk

If the $_FILES array suddenly goes mysteriously empty, even though your form seems correct, you should check the disk space available for your temporary folder partition. In my installation, all file uploads failed without warning. After much gnashing of teeth, I tried freeing up additional space, after which file uploads suddenly worked again.

lots2learn

if files are not getting uploaded and $_FILE array is empty ..and your code looks fine..then check php.ini file..the file_uploads option should be turned 'On' to allow file uploads. Turn it on and restart apache to have effect .

vbudov_yahoo.com

Before moving the file in to place it's also a good idea to check if file with the same name already exists on the server.
If file exists then create unique name for the new file.
$num=1;
while (file_exists($destination)){    
$num++; // if previous file name existed then thy another number+_+filename                                                                                                      
$file_name = $num."_".$_FILES['userfile']['name'];
$destination = $uploadpath.$file_name;
}                                                                                                                                  
move_uploaded_file( $source, $destination );


info

As of PHP 4.2.0, rather than automatically assuming a failed file uploaded is a file attack, you can use the error code associated with the file upload to check and see why the upload failed.  This error code is stored in the userfile array (ex: $HTTP_POST_FILES['userfile']['error']).
Here's an example of a switch:
if (is_uploaded_file($userfile)) {
 
 //include code to copy tmp file to final location here...
 
}else{
 switch($HTTP_POST_FILES['userfile']['error']){
   case 0: //no error; possible file attack!
     echo "There was a problem with your upload.";
     break;
   case 1: //uploaded file exceeds the upload_max_filesize directive in php.ini
     echo "The file you are trying to upload is too big.";
     break;
   case 2: //uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the html form
     echo "The file you are trying to upload is too big.";
     break;
   case 3: //uploaded file was only partially uploaded
     echo "The file you are trying upload was only partially uploaded.";
     break;
   case 4: //no file was uploaded
     echo "You must select an image for upload.";
     break;
   default: //a default error, just in case!  :)
     echo "There was a problem with your upload.";
     break;
}
Additionally, by testing the 'name' element of the file upload array, you can filter out unwanted file types (.exe, .zip, .bat, etc).  Here's an example of a filter that can be added before testing to see if the file was uploaded:
//rejects all .exe, .com, .bat, .zip, .doc and .txt files
if(preg_match("/.exe$|.com$|.bat$|.zip$|.doc$|.txt$/i", $HTTP_POST_FILES['userfile']['name'])){
 exit("You cannot upload this type of file.");
}
//if file is not rejected by the filter, continue normally
if (is_uploaded_file($userfile)) {
/*rest of code*/


alexandre

A very helpful upload class is available at verot.net
http://www.verot.net/php_class_upload.htm
Hope this helps
Alexandre Plennevaux


tejas

<FORM ENCTYPE="multipart/form-data" ACTION="_URL_" METHOD=POST>
Upload this file: <INPUT NAME="userfile" TYPE="file">
<INPUT TYPE="submit" VALUE="Send File"></FORM>
This html code will display a text area with file upload button. The form tag is bit different than the normal form tag used ( see the encrypte =).
Now let us go to the php part to handle the uploaded file. We have In PHP 3, the following variables will be defined within the destination script upon a successful upload, assuming that register_globals is turned on in php3.ini. If track_vars is turned on, they will also be available in PHP 3 within the global
array $HTTP_POST_VARS. Note that the following variable names assume the use of the file upload name 'userfile', as used in the example above:
   * $userfile - The temporary filename in which the uploaded file was stored on the server machine.
   * $userfile_name - The original name or path of the file on the sender's system.
   * $userfile_size - The size of the uploaded file in bytes.
   * $userfile_type - The mime type of the file if the browser provided this information. An example would be "image/gif".
With all these info we will make our script ready to handle the files.
Let us check the file size and we will not allow file size more than 250 KB to get uploaded to our server. Here we are using a flag $file_upload to false for processing the file upload.
if ($userfile_size >250000){$msg=$msg."Your uploaded file size is more than 250KB so please reduce the file size and then upload. Visit the help page to know how to reduce the file size.
";
$file_upload="false";}
Now let us check the file extension and only jpg or gif file pictures we will allow into our server. We will check this by using $userfile_type extension
if (!($userfile_type =="image/pjpeg" OR $userfile_type=="image/gif")){$msg=$msg."Your uploaded file must be of JPG or GIF. Other file types are not allowed
";
$file_upload="false";}
We will limit ourselves to these two type checks and if we find our $file_upload variable is not "false" then we can upload the file. This part is very simple in PHP and can be done in one step. Before that let us decide the file directory name where we will be placing the file. $add is the path with the file name relative to the script running this code where the uploaded file will be stored.
$add="upload/$userfile_name"; // the path with the file name where the file will be stored, upload is the directory name.
Now let us copy the file to server. The command move_uploaded_file will does that job for us and if the action is successful then it will return true.
if(move_uploaded_file ($userfile, $add)){
// do your coding here to give a thanks message or any other thing.
}else{echo "Failed to upload file Contact Site admin to fix the problem";}
Thats all... the file is placed in our directory (name: upload)


Change Language


Follow Navioo On Twitter
basename
chgrp
chmod
chown
clearstatcache
copy
delete
dirname
disk_free_space
disk_total_space
diskfreespace
fclose
feof
fflush
fgetc
fgetcsv
fgets
fgetss
file_exists
file_get_contents
file_put_contents
file
fileatime
filectime
filegroup
fileinode
filemtime
fileowner
fileperms
filesize
filetype
flock
fnmatch
fopen
fpassthru
fputcsv
fputs
fread
fscanf
fseek
fstat
ftell
ftruncate
fwrite
glob
is_dir
is_executable
is_file
is_link
is_readable
is_uploaded_file
is_writable
is_writeable
lchgrp
lchown
link
linkinfo
lstat
mkdir
move_uploaded_file
parse_ini_file
pathinfo
pclose
popen
readfile
readlink
realpath
rename
rewind
rmdir
set_file_buffer
stat
symlink
tempnam
tmpfile
touch
umask
unlink
eXTReMe Tracker