]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - lib/mediafile.php
Last type-hint is an array, added.
[quix0rs-gnu-social.git] / lib / mediafile.php
index 4656122536e79b83ffd7ce134f0c1d0ad7265deb..9fe5432ad503273c47d35160a481dc84b6c5d3e7 100644 (file)
@@ -30,9 +30,7 @@
  * @link      http://status.net/
  */
 
-if (!defined('STATUSNET') && !defined('LACONICA')) {
-    exit(1);
-}
+if (!defined('GNUSOCIAL')) { exit(1); }
 
 class MediaFile
 {
@@ -43,21 +41,15 @@ class MediaFile
     var $fileurl       = null;
     var $short_fileurl = null;
     var $mimetype      = null;
-    var $thumbnailRecord = 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();
-        try {
-            $this->thumbnailRecord = $this->storeThumbnail();
-        } catch (UnsupportedMediaException $e) {
-            // FIXME: Add "unknown media" icon or something
-            $this->thumbnailRecord = null;
-        }
 
         $this->fileurl = common_local_url('attachment',
                                     array('attachment' => $this->fileRecord->id));
@@ -67,11 +59,9 @@ class MediaFile
         $this->maybeAddRedir($this->fileRecord->id, $this->short_fileurl);
     }
 
-    function attachToNotice($notice)
+    public function attachToNotice(Notice $notice)
     {
-        File_to_post::processNew($this->fileRecord->id, $notice->id);
-        $this->maybeAddRedir($this->fileRecord->id,
-                             common_local_url('file', array('notice' => $notice->id)));
+        File_to_post::processNew($this->fileRecord, $notice);
     }
 
     public function getPath()
@@ -84,97 +74,92 @@ class MediaFile
         return $this->short_fileurl;
     }
 
+    function getEnclosure()
+    {
+        return $this->getFile()->getEnclosure();
+    }
+
     function delete()
     {
         $filepath = File::path($this->filename);
         @unlink($filepath);
     }
 
-    function storeFile() {
+    public function getFile()
+    {
+        if (!$this->fileRecord instanceof File) {
+            throw new ServerException('File record did not exist for MediaFile');
+        }
+
+        return $this->fileRecord;
+    }
+
+    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->url      = File::url($this->filename);
-        $filepath       = File::path($this->filename);
+        $file->urlhash  = File::hashurl($fileurl);
+        $file->url      = $fileurl;
+        $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) {
+        if ($file_id===false) {
             common_log_db_error($file, "INSERT", __FILE__);
             // TRANS: Client exception thrown when a database error was thrown during a file upload operation.
             throw new ClientException(_('There was a database error while saving your file. Please try again.'));
         }
 
-        return $file;
-    }
-
-    /**
-     * Generate and store a thumbnail image for the uploaded file, if applicable.
-     *
-     * @return File_thumbnail or null
-     */
-    function storeThumbnail()
-    {
-        $imgPath = null;
-        $media = common_get_mime_media($this->mimetype);
-
-        if (Event::handle('CreateFileImageThumbnail', array($this, &$imgPath, $media))) {
-            switch ($media) {
-            case 'image':
-                $imgPath = $this->getPath();
-                break;
-            default: 
-                throw new UnsupportedMediaException(_('Unsupported media format.'), $this->getPath());
-            }
-        }
-        if (!file_exists($imgPath)) {
-            throw new ServerException(sprintf('Thumbnail source is not stored locally: %s', $imgPath));
-        }
-
+        // Set file geometrical properties if available
         try {
-            $image = new ImageFile($this->fileRecord->id, $imgPath);
-        } catch (UnsupportedMediaException $e) {
-            // Avoid deleting the original
-            if ($image->getPath() != $this->getPath()) {
+            $image = ImageFile::fromFileObject($file);
+            $orig = clone($file);
+            $file->width = $image->width;
+            $file->height = $image->height;
+            $file->update($orig);
+
+            // We have to cleanup after ImageFile, since it
+            // may have generated a temporary file from a
+            // video support plugin or something.
+            // FIXME: Do this more automagically.
+            if ($image->getPath() != $file->getPath()) {
                 $image->unlink();
             }
-            throw $e;
-        }
-
-        $outname = File::filename($this->scoped, 'thumb-' . $this->filename, $this->mimetype);
-        $outpath = File::path($outname);
-
-        $maxWidth = common_config('attachments', 'thumb_width');
-        $maxHeight = common_config('attachments', 'thumb_height');
-        list($width, $height) = $this->scaleToFit($image->width, $image->height, $maxWidth, $maxHeight);
-
-        $image->resizeTo($outpath, $width, $height);
-
-        // Avoid deleting the original
-        if ($image->getPath() != $this->getPath()) {
-            $image->unlink();
+        } catch (ServerException $e) {
+            // We just couldn't make out an image from the file. This
+            // does not have to be UnsupportedMediaException, as we can
+            // also get ServerException from files not existing etc.
         }
-        return File_thumbnail::saveThumbnail($this->fileRecord->id,
-                                      File::url($outname),
-                                      $width,
-                                      $height);
-    }
 
-    function scaleToFit($width, $height, $maxWidth, $maxHeight)
-    {
-        $aspect = $maxWidth / $maxHeight;
-        $w1 = $maxWidth;
-        $h1 = intval($height * $maxWidth / $width);
-        if ($h1 > $maxHeight) {
-            $w2 = intval($width * $maxHeight / $height);
-            $h2 = $maxHeight;
-            return array($w2, $h2);
-        }
-        return array($w1, $h1);
+        return $file;
     }
 
     function rememberFile($file, $short)
@@ -184,17 +169,17 @@ class MediaFile
 
     function maybeAddRedir($file_id, $url)
     {
-        $file_redir = File_redirection::getKV('url', $url);
-
-        if (empty($file_redir)) {
-
+        try {
+            $file_redir = File_redirection::getByUrl($url);
+        } catch (NoResultException $e) {
             $file_redir = new File_redirection;
+            $file_redir->urlhash = File::hashurl($url);
             $file_redir->url = $url;
             $file_redir->file_id = $file_id;
 
             $result = $file_redir->insert();
 
-            if (!$result) {
+            if ($result===false) {
                 common_log_db_error($file_redir, "INSERT", __FILE__);
                 // TRANS: Client exception thrown when a database error was thrown during a file upload operation.
                 throw new ClientException(_('There was a database error while saving your file. Please try again.'));
@@ -202,95 +187,133 @@ class MediaFile
         }
     }
 
-    static function fromUpload($param = 'media', Profile $scoped)
+    static function fromUpload($param='media', Profile $scoped=null)
     {
         if (is_null($scoped)) {
             $scoped = Profile::current();
         }
 
-        if (!isset($_FILES[$param]['error'])){
-            return;
+        // The existence of the "error" element means PHP has processed it properly even if it was ok.
+        if (!isset($_FILES[$param]) || !isset($_FILES[$param]['error'])) {
+            throw new NoUploadedMediaException($param);
         }
 
         switch ($_FILES[$param]['error']) {
-        case UPLOAD_ERR_OK: // success, jump out
-            break;
-        case UPLOAD_ERR_INI_SIZE:
-            // TRANS: Client exception thrown when an uploaded file is larger than set in php.ini.
-            throw new ClientException(_('The uploaded file exceeds the ' .
-                'upload_max_filesize directive in php.ini.'));
-        case UPLOAD_ERR_FORM_SIZE:
-            throw new ClientException(
+            case UPLOAD_ERR_OK: // success, jump out
+                break;
+            case UPLOAD_ERR_INI_SIZE:
+                // TRANS: Client exception thrown when an uploaded file is larger than set in php.ini.
+                throw new ClientException(_('The uploaded file exceeds the ' .
+                            'upload_max_filesize directive in php.ini.'));
+            case UPLOAD_ERR_FORM_SIZE:
+                throw new ClientException(
+                        // TRANS: Client exception.
+                        _('The uploaded file exceeds the MAX_FILE_SIZE directive' .
+                            ' that was specified in the HTML form.'));
+            case UPLOAD_ERR_PARTIAL:
+                @unlink($_FILES[$param]['tmp_name']);
                 // TRANS: Client exception.
-                _('The uploaded file exceeds the MAX_FILE_SIZE directive' .
-                ' that was specified in the HTML form.'));
-        case UPLOAD_ERR_PARTIAL:
-            @unlink($_FILES[$param]['tmp_name']);
-            // TRANS: Client exception.
-            throw new ClientException(_('The uploaded file was only' .
-                ' partially uploaded.'));
-        case UPLOAD_ERR_NO_FILE:
-            // No file; probably just a non-AJAX submission.
-            return;
-        case UPLOAD_ERR_NO_TMP_DIR:
-            // TRANS: Client exception thrown when a temporary folder is not present to store a file upload.
-            throw new ClientException(_('Missing a temporary folder.'));
-        case UPLOAD_ERR_CANT_WRITE:
-            // TRANS: Client exception thrown when writing to disk is not possible during a file upload operation.
-            throw new ClientException(_('Failed to write file to disk.'));
-        case UPLOAD_ERR_EXTENSION:
-            // TRANS: Client exception thrown when a file upload operation has been stopped by an extension.
-            throw new ClientException(_('File upload stopped by extension.'));
-        default:
-            common_log(LOG_ERR, __METHOD__ . ": Unknown upload error " .
-                $_FILES[$param]['error']);
-            // TRANS: Client exception thrown when a file upload operation has failed with an unknown reason.
-            throw new ClientException(_('System error uploading file.'));
+                throw new ClientException(_('The uploaded file was only' .
+                            ' partially uploaded.'));
+            case UPLOAD_ERR_NO_FILE:
+                // No file; probably just a non-AJAX submission.
+                throw new NoUploadedMediaException($param);
+            case UPLOAD_ERR_NO_TMP_DIR:
+                // TRANS: Client exception thrown when a temporary folder is not present to store a file upload.
+                throw new ClientException(_('Missing a temporary folder.'));
+            case UPLOAD_ERR_CANT_WRITE:
+                // TRANS: Client exception thrown when writing to disk is not possible during a file upload operation.
+                throw new ClientException(_('Failed to write file to disk.'));
+            case UPLOAD_ERR_EXTENSION:
+                // TRANS: Client exception thrown when a file upload operation has been stopped by an extension.
+                throw new ClientException(_('File upload stopped by extension.'));
+            default:
+                common_log(LOG_ERR, __METHOD__ . ": Unknown upload error " .
+                        $_FILES[$param]['error']);
+                // TRANS: Client exception thrown when a file upload operation has failed with an unknown reason.
+                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']);
+
+            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);
 
-        $result = move_uploaded_file($_FILES[$param]['tmp_name'], $filepath);
+            $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.'));
+            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']);
-
-        $filename = File::filename($scoped, "email", $mimetype);
-
-        $filepath = File::path($filename);
+        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']));
+
+            $mimetype = self::getUploadedMimeType($stream['uri']);
+
+            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);
     }
 
     /**
@@ -314,6 +337,7 @@ class MediaFile
         $unclearTypes = array('application/octet-stream',
                               'application/vnd.ms-office',
                               'application/zip',
+                              'text/html',  // Ironically, Wikimedia Commons' SVG_logo.svg is identified as text/html
                               // TODO: for XML we could do better content-based sniffing too
                               'text/xml');