Extract media upload stuff into its own library class.

2 files changed, 341 insertions, 169 deletions

diff --git a/actions/newnotice.php b/actions/newnotice.php
index 9ee031f93..5100e79e1 100644
--- a/actions/newnotice.php
+++ b/actions/newnotice.php
@@ -33,7 +33,8 @@ if (!defined('STATUSNET') && !defined('LACONICA')) {
     exit(1);
 }
 
-require_once INSTALLDIR.'/lib/noticelist.php';
+require_once INSTALLDIR . '/lib/noticelist.php';
+require_once INSTALLDIR . '/lib/mediafile.php';
 
 /**
  * Action for posting new notices
@@ -113,33 +114,6 @@ class NewnoticeAction extends Action
         }
     }
 
-    function getUploadedFileType() {
-        require_once 'MIME/Type.php';
-
-        $cmd = &PEAR::getStaticProperty('MIME_Type', 'fileCmd');
-        $cmd = common_config('attachments', 'filecommand');
-
-        $filetype = MIME_Type::autoDetect($_FILES['attach']['tmp_name']);
-        if (in_array($filetype, common_config('attachments', 'supported'))) {
-            return $filetype;
-        }
-        $media = MIME_Type::getMedia($filetype);
-        if ('application' !== $media) {
-            $hint = sprintf(_(' Try using another %s format.'), $media);
-        } else {
-            $hint = '';
-        }
-        $this->clientError(sprintf(
-                                   _('%s is not a supported filetype on this server.'), $filetype) . $hint);
-    }
-
-    function isRespectsQuota($user) {
-        $file = new File;
-        $ret = $file->isRespectsQuota($user,$_FILES['attach']['size']);
-        if (true === $ret) return true;
-        $this->clientError($ret);
-    }
-
     /**
      * Save a new notice, based on arguments
      *
@@ -189,78 +163,35 @@ class NewnoticeAction extends Action
             $replyto = 'false';
         }
 
-        if (isset($_FILES['attach']['error'])) {
-            switch ($_FILES['attach']['error']) {
-             case UPLOAD_ERR_NO_FILE:
-                // no file uploaded, nothing to do
-                break;
+        $upload = null;
 
-             case UPLOAD_ERR_OK:
-                $mimetype = $this->getUploadedFileType();
-                if (!$this->isRespectsQuota($user)) {
-                    die('clientError() should trigger an exception before reaching here.');
-                }
-                break;
-
-             case UPLOAD_ERR_INI_SIZE:
-                $this->clientError(_('The uploaded file exceeds the upload_max_filesize directive in php.ini.'));
-
-             case UPLOAD_ERR_FORM_SIZE:
-                $this->clientError(_('The uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the HTML form.'));
-
-             case UPLOAD_ERR_PARTIAL:
-                $this->clientError(_('The uploaded file was only partially uploaded.'));
+        common_debug('looking for attachment');
 
-             case  UPLOAD_ERR_NO_TMP_DIR:
-                $this->clientError(_('Missing a temporary folder.'));
+        $upload = MediaFile::fromUpload('attach');
 
-             case UPLOAD_ERR_CANT_WRITE:
-                $this->clientError(_('Failed to write file to disk.'));
+        common_debug("uploaded file = " . var_export($upload, true));
 
-             case UPLOAD_ERR_EXTENSION:
-                $this->clientError(_('File upload stopped by extension.'));
+        if (isset($upload)) {
+            common_debug('newNotice: found an upload');
 
-             default:
-                die('Should never reach here.');
-            }
-        }
-
-        if (isset($mimetype)) {
-            $filename = $this->saveFile($mimetype);
-            if (empty($filename)) {
-                $this->clientError(_('Couldn\'t save file.'));
-            }
+                $content_shortened .= ' ' . $upload->shortUrl();
 
-            $fileRecord = $this->storeFile($filename, $mimetype);
+                common_debug('content w/upload = ' . $content_shortened);
 
-            $fileurl = common_local_url('attachment',
-                                        array('attachment' => $fileRecord->id));
-
-            // not sure this is necessary -- Zach
-            $this->maybeAddRedir($fileRecord->id, $fileurl);
-
-            $short_fileurl = common_shorten_url($fileurl);
-            if (!$short_fileurl) {
-                // todo -- Consider forcing default shortener if none selected?
-                $short_fileurl = $fileurl;
-            }
-            $content_shortened .= ' ' . $short_fileurl;
-
-            if (Notice::contentTooLong($content_shortened)) {
-                $this->deleteFile($filename);
-                $this->clientError(sprintf(_('Max notice size is %d chars, including attachment URL.'),
-                                           Notice::maxContent()));
-            }
-
-            // Also, not sure this is necessary -- Zach
-            $this->maybeAddRedir($fileRecord->id, $short_fileurl);
+                if (Notice::contentTooLong($content_shortened)) {
+                    $upload->delete();
+                    $this->clientError(sprintf(_('Max notice size is %d chars, including attachment URL.'),
+                                               Notice::maxContent()));
+                } else {
+                    common_debug('content not too long');
+                }
         }
 
         $notice = Notice::saveNew($user->id, $content_shortened, 'web', 1,
                                   ($replyto == 'false') ? null : $replyto);
 
-        if (isset($mimetype)) {
-            $this->attachFile($notice, $fileRecord);
+        if (isset($upload)) {
+            $upload->attachToNotice($notice);
         }
 
         common_broadcast_notice($notice);
@@ -288,87 +219,6 @@ class NewnoticeAction extends Action
         }
     }
 
-    function saveFile($mimetype) {
-
-        $cur = common_current_user();
-
-        if (empty($cur)) {
-            $this->serverError(_('Somehow lost the login in saveFile'));
-        }
-
-        $basename = basename($_FILES['attach']['name']);
-
-        $filename = File::filename($cur->getProfile(), $basename, $mimetype);
-
-        $filepath = File::path($filename);
-
-        if (move_uploaded_file($_FILES['attach']['tmp_name'], $filepath)) {
-            return $filename;
-        } else {
-            $this->clientError(_('File could not be moved to destination directory.'));
-        }
-    }
-
-    function deleteFile($filename)
-    {
-        $filepath = File::path($filename);
-        @unlink($filepath);
-    }
-
-    function storeFile($filename, $mimetype) {
-
-        $file = new File;
-        $file->filename = $filename;
-
-        $file->url = File::url($filename);
-
-        $filepath = File::path($filename);
-
-        $file->size = filesize($filepath);
-        $file->date = time();
-        $file->mimetype = $mimetype;
-
-        $file_id = $file->insert();
-
-        if (!$file_id) {
-            common_log_db_error($file, "INSERT", __FILE__);
-            $this->clientError(_('There was a database error while saving your file. Please try again.'));
-        }
-
-        return $file;
-    }
-
-    function rememberFile($file, $short)
-    {
-        $this->maybeAddRedir($file->id, $short);
-    }
-
-    function maybeAddRedir($file_id, $url)
-    {
-        $file_redir = File_redirection::staticGet('url', $url);
-
-        if (empty($file_redir)) {
-            $file_redir = new File_redirection;
-            $file_redir->url = $url;
-            $file_redir->file_id = $file_id;
-
-            $result = $file_redir->insert();
-
-            if (!$result) {
-                common_log_db_error($file_redir, "INSERT", __FILE__);
-                $this->clientError(_('There was a database error while saving your file. Please try again.'));
-            }
-        }
-    }
-
-    function attachFile($notice, $filerec)
-    {
-        File_to_post::processNew($filerec->id, $notice->id);
-
-        $this->maybeAddRedir($filerec->id,
-                             common_local_url('file', array('notice' => $notice->id)));
-    }
-
     /**
      * Show an Ajax-y error message
      *
diff --git a/lib/mediafile.php b/lib/mediafile.php
new file mode 100644
index 000000000..be101cdca
--- /dev/null
+++ b/lib/mediafile.php
@@ -0,0 +1,322 @@
+<?php
+/**
+ * StatusNet, the distributed open-source mMediaFileicroblogging tool
+ *
+ * Abstraction for a media files in general
+ *
+ * PHP version 5
+ *
+ * LICENCE: This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @category  Media
+ * @package   StatusNet
+ * @author    Zach Copley <zach@status.net>
+ * @copyright 2008-2009 StatusNet, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link      http://status.net/
+ */
+
+if (!defined('STATUSNET') && !defined('LACONICA')) {
+    exit(1);
+}
+
+class MediaFile 
+{
+    
+    var $filename      = null;
+    var $fileRecord    = null;
+    var $user          = null;
+    var $fileurl       = null;
+    var $short_fileurl = null;
+    var $mimetype      = null;
+
+    function __construct($user = null, $filename = null, $mimetype = null)
+    {
+        if ($user == null) {
+            $this->user = common_current_user();
+        }
+        
+        common_debug('in MediaFile constructor');
+        
+        $this->filename = $filename;
+        $this->mimetype = $mimetype;
+        
+        common_debug('storing file');
+        $this->fileRecord = $this->storeFile();
+        common_debug('finished storing file');
+        
+        $this->fileurl = common_local_url('attachment',
+                                    array('attachment' => $this->fileRecord->id));
+
+        common_debug('$this->fileurl() = ' . $this->fileurl);
+
+        // not sure this is necessary -- Zach
+        $this->maybeAddRedir($this->fileRecord->id, $this->fileurl);
+
+        common_debug('shortening file url');
+        $this->short_fileurl = common_shorten_url($this->fileurl);
+        common_debug('shortened file url =  ' . $short_fileurl);
+        
+        // Also, not sure this is necessary -- Zach
+        $this->maybeAddRedir($this->fileRecord->id, $this->short_fileurl);
+     
+        common_debug("MediaFile: end of constructor");
+    }
+    
+    function attachToNotice($notice)
+    {
+        common_debug('MediaFile::attachToNotice() -- doing File_to_post');
+        File_to_post::processNew($this->fileRecord->id, $notice->id);
+        common_debug('MediaFile done doing File_to_post');
+        
+        $this->maybeAddRedir($this->fileRecord->id,
+                             common_local_url('file', array('notice' => $notice->id)));                
+    }
+    
+    function shortUrl() 
+    {
+        return $this->short_fileurl;
+    }
+
+    function delete()
+    {
+        $filepath = File::path($this->filename);
+        @unlink($filepath);
+    }
+
+    function storeFile() {
+
+        $file = new File;
+        $file->filename = $this->filename;
+
+        common_debug('storing ' . $this->filename);
+
+        $file->url = File::url($this->filename);
+        common_debug('file->url = ' . $file->url);
+
+        $filepath = File::path($this->filename);
+        common_debug('filepath = ' . $filepath);
+
+        $file->size = filesize($filepath);
+        $file->date = time();
+        $file->mimetype = $this->mimetype;
+
+        $file_id = $file->insert();
+
+        if (!$file_id) {
+            
+            common_debug("storeFile: problem inserting new file");
+            common_log_db_error($file, "INSERT", __FILE__);
+            throw new ClientException(_('There was a database error while saving your file. Please try again.'));
+        }
+        
+        common_debug('finished storing file');
+
+        return $file;
+    }
+
+    function rememberFile($file, $short)
+    {
+        $this->maybeAddRedir($file->id, $short);
+    }
+
+    function maybeAddRedir($file_id, $url)
+    {
+        
+        common_debug("maybeAddRedir: looking up url: $url for file id $file_id");
+
+        $file_redir = File_redirection::staticGet('url', $url);
+
+        if (empty($file_redir)) {
+            
+            common_debug("maybeAddRedir: $url is not in the db");
+            
+            $file_redir = new File_redirection;
+            $file_redir->url = $url;
+            $file_redir->file_id = $file_id;
+
+            $result = $file_redir->insert();
+
+            if (!$result) {
+                common_log_db_error($file_redir, "INSERT", __FILE__);
+                throw new ClientException(_('There was a database error while saving your file. Please try again.'));
+            }
+        } else {
+         
+            common_debug("maybeAddRedir: no need to add $url, it's already in the db");
+        }
+    }
+
+    static function fromUpload($param = 'media')
+    {
+        common_debug("fromUpload: param = $param");
+        
+        if (!isset($_FILES[$param]['error'])){
+            common_debug('no file found');
+            return;
+        }
+        
+        switch ($_FILES[$param]['error']) {
+        case UPLOAD_ERR_OK: // success, jump out
+            break;
+        case UPLOAD_ERR_INI_SIZE:
+            throw new ClientException(_('The uploaded file exceeds the ' .
+                'upload_max_filesize directive in php.ini.'));
+            return;
+        case UPLOAD_ERR_FORM_SIZE:
+            throw new ClientException(
+                _('The uploaded file exceeds the MAX_FILE_SIZE directive' .
+                ' that was specified in the HTML form.'));
+            return;
+        case UPLOAD_ERR_PARTIAL:
+            @unlink($_FILES[$param]['tmp_name']);
+            throw new ClientException(_('The uploaded file was only' .
+                ' partially uploaded.'));
+            return;   
+        case UPLOAD_ERR_NO_TMP_DIR:
+            throw new ClientException(_('Missing a temporary folder.'));
+            return;
+        case UPLOAD_ERR_CANT_WRITE:
+            throw new ClientException(_('Failed to write file to disk.'));
+            return;
+        case UPLOAD_ERR_EXTENSION:
+            throw new ClientException(_('File upload stopped by extension.'));
+            return;
+        default:
+            throw new ClientException(_('System error uploading file.'));
+            return;
+        }
+        
+        $user = common_current_user();
+        
+        if (!MediaFile::respectsQuota($user, $_FILES['attach']['size'])) {
+            
+            // Should never actually get here
+            
+            @unlink($_FILES[$param]['tmp_name']);
+            throw new ClientException(_('File exceeds user\'s quota!'));
+            return;
+        }
+
+        $mimetype = MediaFile::getUploadedFileType($_FILES[$param]['tmp_name']);
+        
+        $filename = null;
+        
+        if (isset($mimetype)) {
+            
+            $basename = basename($_FILES[$param]['name']);
+            $filename = File::filename($user->getProfile(), $basename, $mimetype);
+            $filepath = File::path($filename);
+
+            common_debug("filepath = " . $filepath);
+
+            $result = move_uploaded_file($_FILES[$param]['tmp_name'], $filepath);
+            
+            if (!$result) {                
+                throw new ClientException(_('File could not be moved to destination directory.'));
+                return;
+            }
+            
+        } else {
+            throw new ClientException(_('Could not determine file\'s mime-type!'));
+            return;
+        }
+                
+        return new MediaFile($user, $filename, $mimetype);
+    }
+
+    static function fromFilehandle($user, $fh) {
+
+        $stream = stream_get_meta_data($fh);
+
+        if (MediaFile::respectsQuota($user, filesize($stream['uri']))) {
+            
+            // Should never actually get here
+                        
+            throw new ClientException(_('File exceeds user\'s quota!'));
+            return;
+        }
+
+        $mimetype = MediaFile::getUploadedFileType($fh);
+        
+        $filename = null;
+        
+        if (isset($mimetype)) {
+
+            $filename = File::filename($user->getProfile(), "email", $mimetype);
+
+            $filepath = File::path($filename);
+        
+            $result = copy($stream['uri'], $filepath) && chmod($filepath, 0664);
+        
+            if (!$result) {
+                throw new ClientException(_('File could not be moved to destination directory.' .
+                    $stream['uri'] . ' ' . $filepath));
+            }
+        } else {
+            throw new ClientException(_('Could not determine file\'s mime-type!'));
+            return;
+        }
+        
+        return new MediaFile($user, $filename, $mimetype);
+    }
+
+    static function getUploadedFileType($f) {
+        require_once 'MIME/Type.php';
+        
+        common_debug("in getUploadedFileType");
+
+        $cmd = &PEAR::getStaticProperty('MIME_Type', 'fileCmd');
+        $cmd = common_config('attachments', 'filecommand');
+        
+        $filetype = null;
+        
+        if (is_string($f)) {
+            
+            // assuming a filename
+            
+            $filetype = MIME_Type::autoDetect($f);
+        } else {
+            
+            // assuming a filehandle
+            
+            $stream  = stream_get_meta_data($f);
+            $filetype = MIME_Type::autoDetect($stream['uri']);
+        }
+        
+        if (in_array($filetype, common_config('attachments', 'supported'))) {
+            return $filetype;
+        }
+        $media = MIME_Type::getMedia($filetype);
+        if ('application' !== $media) {
+            $hint = sprintf(_(' Try using another %s format.'), $media);
+        } else {
+            $hint = '';
+        }
+        throw new ClientException(sprintf(
+            _('%s is not a supported filetype on this server.'), $filetype) . $hint);
+    }
+
+    static function respectsQuota($user, $filesize) 
+    {
+        $file = new File;
+        $result = $file->isRespectsQuota($user, $filesize);
+        if ($result === true) {
+            return true;
+        } else {
+            throw new ClientException($result);
+        }
+    }
+
+}
\ No newline at end of file