public $id; // int(4) primary_key not_null
public $urlhash; // varchar(64) unique_key
public $url; // text
+ public $filehash; // varchar(64) indexed
public $mimetype; // varchar(50)
public $size; // int(4)
public $title; // varchar(191) not 255 because utf8mb4 takes more space
public $modified; // timestamp() not_null default_CURRENT_TIMESTAMP
const URLHASH_ALG = 'sha256';
+ const FILEHASH_ALG = 'sha256';
public static function schemaDef()
{
'id' => array('type' => 'serial', 'not null' => true),
'urlhash' => array('type' => 'varchar', 'length' => 64, 'not null' => true, 'description' => 'sha256 of destination URL (url field)'),
'url' => array('type' => 'text', 'description' => 'destination URL after following possible redirections'),
+ 'filehash' => array('type' => 'varchar', 'length' => 64, 'not null' => false, 'description' => 'sha256 of the file contents, only for locally stored files of course'),
'mimetype' => array('type' => 'varchar', 'length' => 50, 'description' => 'mime type of resource'),
'size' => array('type' => 'int', 'description' => 'size of resource when available'),
'title' => array('type' => 'varchar', 'length' => 191, 'description' => 'title of resource when available'),
'unique keys' => array(
'file_urlhash_key' => array('urlhash'),
),
+ 'indexes' => array(
+ 'file_filehash_idx' => array('filehash'),
+ ),
);
}
static function filename(Profile $profile, $origname, $mimetype)
{
- try {
- $ext = common_supported_mime_to_ext($mimetype);
- } catch (Exception $e) {
- // We don't support this mimetype, but let's guess the extension
- $ext = substr(strrchr($mimetype, '/'), 1);
- }
+ $ext = self::guessMimeExtension($mimetype);
// Normalize and make the original filename more URL friendly.
$origname = basename($origname, ".$ext");
return $filename;
}
+ static function guessMimeExtension($mimetype)
+ {
+ try {
+ $ext = common_supported_mime_to_ext($mimetype);
+ } catch (Exception $e) {
+ // We don't support this mimetype, but let's guess the extension
+ $ext = substr(strrchr($mimetype, '/'), 1);
+ }
+ return strtolower($ext);
+ }
+
/**
* Validation for as-saved base filenames
*/
public function getPath()
{
- return self::path($this->filename);
+ $filepath = self::path($this->filename);
+ if (!file_exists($filepath)) {
+ throw new FileNotFoundException($filepath);
+ }
+ return $filepath;
}
public function getUrl()
return $file;
}
+ /**
+ * @param string $hashstr String of (preferrably lower case) hexadecimal characters, same as result of 'hash_file(...)'
+ */
+ static public function getByHash($hashstr, $alg=File::FILEHASH_ALG)
+ {
+ $file = new File();
+ $file->filehash = strtolower($hashstr);
+ if (!$file->find(true)) {
+ throw new NoResultException($file);
+ }
+ return $file;
+ }
+
public function updateUrl($url)
{
$file = File::getKV('urlhash', self::hashurl($url));
var $short_fileurl = null;
var $mimetype = null;
- function __construct(Profile $scoped, $filename = null, $mimetype = null)
+ function __construct(Profile $scoped, $filename = null, $mimetype = null, $filehash = null)
{
$this->scoped = $scoped;
$this->filename = $filename;
$this->mimetype = $mimetype;
+ $this->filehash = $filehash;
$this->fileRecord = $this->storeFile();
$this->fileurl = common_local_url('attachment',
protected function storeFile()
{
+ $filepath = File::path($this->filename);
+ if (!empty($this->filename) && $this->filehash === null) {
+ // Calculate if we have an older upload method somewhere (Qvitter) that
+ // doesn't do this before calling new MediaFile on its local files...
+ $this->filehash = hash_file(File::FILEHASH_ALG, $filepath);
+ if ($this->filehash === false) {
+ throw new ServerException('Could not read file for hashing');
+ }
+ }
+
+ try {
+ $file = File::getByHash($this->filehash);
+ // We're done here. Yes. Already. We assume sha256 won't collide on us anytime soon.
+ return $file;
+ } catch (NoResultException $e) {
+ // Well, let's just continue below.
+ }
+
$fileurl = File::url($this->filename);
$file = new File;
$file->filename = $this->filename;
$file->urlhash = File::hashurl($fileurl);
$file->url = $fileurl;
- $filepath = File::path($this->filename);
+ $file->filehash = $this->filehash;
$file->size = filesize($filepath);
+ if ($file->size === false) {
+ throw new ServerException('Could not read file to get its size');
+ }
$file->date = time();
$file->mimetype = $this->mimetype;
+
$file_id = $file->insert();
if ($file_id===false) {
throw new ClientException(_('System error uploading file.'));
}
- // Throws exception if additional size does not respect quota
- File::respectsQuota($scoped, $_FILES[$param]['size']);
+ // TODO: Make documentation clearer that this won't work for files >2GiB because
+ // PHP is stupid in its 32bit head. But noone accepts 2GiB files with PHP
+ // anyway... I hope.
+ $filehash = hash_file(File::FILEHASH_ALG, $_FILES[$param]['tmp_name']);
+
+ try {
+ $file = File::getByHash($filehash);
+ // If no exception is thrown the file exists locally, so we'll use that and just add redirections.
+ $filename = $file->filename;
+ $mimetype = $file->mimetype;
+
+ } catch (NoResultException $e) {
+ // We have to save the upload as a new local file. This is the normal course of action.
- $mimetype = self::getUploadedMimeType($_FILES[$param]['tmp_name'],
- $_FILES[$param]['name']);
+ // Throws exception if additional size does not respect quota
+ // This test is only needed, of course, if we're uploading something new.
+ File::respectsQuota($scoped, $_FILES[$param]['size']);
- $basename = basename($_FILES[$param]['name']);
- $filename = File::filename($scoped, $basename, $mimetype);
- $filepath = File::path($filename);
+ $mimetype = self::getUploadedMimeType($_FILES[$param]['tmp_name'], $_FILES[$param]['name']);
- $result = move_uploaded_file($_FILES[$param]['tmp_name'], $filepath);
+ switch (common_config('attachments', 'filename_base')) {
+ case 'upload':
+ $basename = basename($_FILES[$param]['name']);
+ $filename = File::filename($scoped, $basename, $mimetype);
+ break;
+ case 'hash':
+ default:
+ $filename = strtolower($filehash) . '.' . File::guessMimeExtension($mimetype);
+ }
+ $filepath = File::path($filename);
- if (!$result) {
- // TRANS: Client exception thrown when a file upload operation fails because the file could
- // TRANS: not be moved from the temporary folder to the permanent file location.
- throw new ClientException(_('File could not be moved to destination directory.'));
+ $result = move_uploaded_file($_FILES[$param]['tmp_name'], $filepath);
+
+ if (!$result) {
+ // TRANS: Client exception thrown when a file upload operation fails because the file could
+ // TRANS: not be moved from the temporary folder to the permanent file location.
+ throw new ClientException(_('File could not be moved to destination directory.'));
+ }
}
- return new MediaFile($scoped, $filename, $mimetype);
+ return new MediaFile($scoped, $filename, $mimetype, $filehash);
}
static function fromFilehandle($fh, Profile $scoped) {
-
$stream = stream_get_meta_data($fh);
+ // So far we're only handling filehandles originating from tmpfile(),
+ // so we can always do hash_file on $stream['uri'] as far as I can tell!
+ $filehash = hash_file(File::FILEHASH_ALG, $stream['uri']);
- File::respectsQuota($scoped, filesize($stream['uri']));
-
- $mimetype = self::getUploadedMimeType($stream['uri']);
+ try {
+ $file = File::getByHash($filehash);
+ // Already have it, so let's reuse the locally stored File
+ $filename = $file->filename;
+ $mimetype = $file->mimetype;
+ } catch (NoResultException $e) {
+ File::respectsQuota($scoped, filesize($stream['uri']));
- $filename = File::filename($scoped, "email", $mimetype);
+ $mimetype = self::getUploadedMimeType($stream['uri']);
- $filepath = File::path($filename);
+ switch (common_config('attachments', 'filename_base')) {
+ case 'upload':
+ $filename = File::filename($scoped, "email", $mimetype);
+ break;
+ case 'hash':
+ default:
+ $filename = strtolower($filehash) . '.' . File::guessMimeExtension($mimetype);
+ }
+ $filepath = File::path($filename);
- $result = copy($stream['uri'], $filepath) && chmod($filepath, 0664);
+ $result = copy($stream['uri'], $filepath) && chmod($filepath, 0664);
- if (!$result) {
- // TRANS: Client exception thrown when a file upload operation fails because the file could
- // TRANS: not be moved from the temporary folder to the permanent file location.
- throw new ClientException(_('File could not be moved to destination directory.' .
- $stream['uri'] . ' ' . $filepath));
+ if (!$result) {
+ // TRANS: Client exception thrown when a file upload operation fails because the file could
+ // TRANS: not be moved from the temporary folder to the permanent file location.
+ throw new ClientException(_('File could not be moved to destination directory.' .
+ $stream['uri'] . ' ' . $filepath));
+ }
}
- return new MediaFile($scoped, $filename, $mimetype);
+ return new MediaFile($scoped, $filename, $mimetype, $filehash);
}
/**