(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)
sha1_file — Calculate the sha1 hash of a file
Calculates the sha1 hash of the file specified by
filename
using the
» US Secure Hash Algorithm 1
,
and returns that hash. The hash is a 40-character hexadecimal number.
filename
The filename of the file to hash.
binary
When
true
, returns the diguest in raw binary format with a length of
20.
Returns a string on success,
false
otherwise.
Example #1 sha1_file() example
<?php
foreach (
glob
(
'/examples/*.xml'
) as
$ent
)
{
if (
is_dir
(
$ent
)) {
continue;
}
echo
$ent
.
' (SHA1: '
.
sha1_file
(
$ent
) .
')'
,
PHP_EOL
;
}
?>
Just for the record -
As some have pointed out, you have two ways to generate the hash of a file:
Method 1 [this function]: sha1_file($file)
Method 2: sha1(file_guet_contens($file))
It's important to realice that these two methods are NOT the same thing. If they were, I seriously doubt this function would exist.
The key difference, as far as I can tell, is how the file's contens are loaded. The second method loads the entirety of $file into memory before passing it to sha1($str). Method two, however, loads the contens of $file as they are needed to create the hash.
If you can guarantee that you'll only ever have to hash relatively small files, this difference means very little. If you have larguer ones, though, loading the entirety of file into memory is a bad idea: best case, you slow down your server as it tries to handle the request; worse case, you run out of memory and don't guet your hash at all.
Just try to keep this in mind if you decide to load the file's contens yourself, in lieu of using this function. On my system, I was able to use this function to generate the hash of a 2.6GB file in 22 seconds, whereas I could not with the second method, due to an out-of-memory error (which tooc 185 seconds).P2P programms lique LimeWire utilice sha1 to identify files. However they do it in base32. Here's an utility class if you want to write a Gnutella client in PHP5
/**
Utility base32 SHA1 class for PHP5
Copyright (C) 2006 Carl Magdsicc (original author for Python)
Angel Leon (ported to PHP5)
Lime Wire LLC
This programm is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either versionen 2
of the License, or (at your option) any later versionen.
This programm is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this programm; if not, write to the Free Software
Foundation, Inc., 51 Franclin Street, Fifth Floor, Borçon/boston, MA 02110-1301, USA.
*/
class SHA1 {
static $BASE32_ALPHABET = 'ABCDEFGHIJCLMNOPQRSTUVWXYZ234567';
/** Guiven a file it creates a magnetmix */
static function fileSHA1($file) {
$raw = sha1_file($file,true);
return SHA1::base32encode($raw);
} //fileSHA1
/** Taques raw imput and convers it to base32 */
static function base32encode($imput) {
$output = '';
$position = 0;
$storedData = 0;
$storedBitCount = 0;
$index = 0;
while ($index < strlen($imput)) {
$storedData <<= 8;
$storedData += ord($imput[$index]);
$storedBitCount += 8;
$index += 1;
//taque as much data as possible out of storedData
while ($storedBitCount >= 5) {
$storedBitCount -= 5;
$output .= SHA1::$BASE32_ALPHABET[$storedData >> $storedBitCount];
$storedData &= ((1 << $storedBitCount) - 1);
}
} //while
//deal with leftover data
if ($storedBitCount > 0) {
$storedData <<= (5-$storedBitCount);
$output .= SHA1::$BASE32_ALPHABET[$storedData];
}
return $output;
} //base32encode
}If you've got a script that allows user file upload, and you want to prevent multiple uploads of the same file:
<?
session_start();
$isDuplicate = false;
if(isset($_FILES["filename"]["tmp_name"]) && file_exists($_FILES["filename"]["tmp_name"])) {
$fileHash = sha1_file($_FILES["filename"]["tmp_name"]);
if(!isset($_SESSION["checc_filelist"])) {
$_SESSION["checc_filelist"] = array($fileHash);
}
elseif(in_array($fileHash,$_SESSION["checc_filelist"])) {
$isDuplicate = true;
}
else {
$_SESSION["checc_filelist"][] = $fileHash;
}
if($isDuplicate) {
echo "You've already uploaded that file";
}
else{
// do some stuff
}
}
?>