]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - classes/File.php
File width and height is now properly set for File
[quix0rs-gnu-social.git] / classes / File.php
index f3940346b3cf3b03bfaf86958991f423b80faa86..2925819c36e1f4fa2d0cd238cadae5756889f556 100644 (file)
  * along with this program.     If not, see <http://www.gnu.org/licenses/>.
  */
 
-if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
-
-require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
-require_once INSTALLDIR.'/classes/File_redirection.php';
-require_once INSTALLDIR.'/classes/File_oembed.php';
-require_once INSTALLDIR.'/classes/File_thumbnail.php';
-require_once INSTALLDIR.'/classes/File_to_post.php';
-//require_once INSTALLDIR.'/classes/File_redirection.php';
+if (!defined('GNUSOCIAL')) { exit(1); }
 
 /**
  * Table Definition for file
  */
 class File extends Managed_DataObject
 {
-    ###START_AUTOCODE
-    /* the code below is auto generated do not remove the above tag */
-
     public $__table = 'file';                            // table name
     public $id;                              // int(4)  primary_key not_null
     public $url;                             // varchar(255)  unique_key
@@ -45,12 +35,6 @@ class File extends Managed_DataObject
     public $filename;                        // varchar(255)
     public $modified;                        // timestamp()   not_null default_CURRENT_TIMESTAMP
 
-    /* Static get */
-    function staticGet($k,$v=NULL) { return Memcached_DataObject::staticGet('File',$k,$v); }
-
-    /* the code above is auto generated do not remove the tag below */
-    ###END_AUTOCODE
-
     public static function schemaDef()
     {
         return array(
@@ -63,6 +47,8 @@ class File extends Managed_DataObject
                 'date' => array('type' => 'int', 'description' => 'date of resource according to http query'),
                 'protected' => array('type' => 'int', 'description' => 'true when URL is private (needs login)'),
                 'filename' => array('type' => 'varchar', 'length' => 255, 'description' => 'if a local file, name of the file'),
+                'width' => array('type' => 'int', 'description' => 'width in pixels, if it can be described as such and data is available'),
+                'height' => array('type' => 'int', 'description' => 'height in pixels, if it can be described as such and data is available'),
 
                 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
             ),
@@ -84,14 +70,14 @@ class File extends Managed_DataObject
      * @param string $given_url
      * @return File
      */
-    function saveNew(array $redir_data, $given_url) {
+    public static function saveNew(array $redir_data, $given_url) {
 
         // I don't know why we have to keep doing this but I'm adding this last check to avoid
         // uniqueness bugs.
 
-        $x = File::staticGet('url', $given_url);
+        $x = File::getKV('url', $given_url);
         
-        if (empty($x)) {
+        if (!$x instanceof File) {
             $x = new File;
             $x->url = $given_url;
             if (!empty($redir_data['protected'])) $x->protected = $redir_data['protected'];
@@ -116,19 +102,26 @@ class File extends Managed_DataObject
      * @param string $given_url
      * @return boolean success
      */
-    public function saveOembed($redir_data, $given_url)
+    public function saveOembed(array $redir_data, $given_url)
     {
         if (isset($redir_data['type'])
-            && (('text/html' === substr($redir_data['type'], 0, 9) || 'application/xhtml+xml' === substr($redir_data['type'], 0, 21)))
-            && ($oembed_data = File_oembed::_getOembed($given_url))) {
-
-            $fo = File_oembed::staticGet('file_id', $this->id);
+                && (('text/html' === substr($redir_data['type'], 0, 9)
+                || 'application/xhtml+xml' === substr($redir_data['type'], 0, 21)))) {
+            try {
+                $oembed_data = File_oembed::_getOembed($given_url);
+            } catch (Exception $e) {
+                return false;
+            }
+            if ($oembed_data === false) {
+                return false;
+            }
+            $fo = File_oembed::getKV('file_id', $this->id);
 
-            if (empty($fo)) {
+            if ($fo instanceof File_oembed) {
+                common_log(LOG_WARNING, "Strangely, a File_oembed object exists for new file $file_id", __FILE__);
+            } else {
                 File_oembed::saveNew($oembed_data, $this->id);
                 return true;
-            } else {
-                common_log(LOG_WARNING, "Strangely, a File_oembed object exists for new file $file_id", __FILE__);
             }
         }
         return false;
@@ -156,9 +149,9 @@ class File extends Managed_DataObject
         if (empty($given_url)) return -1;   // error, no url to process
         $given_url = File_redirection::_canonUrl($given_url);
         if (empty($given_url)) return -1;   // error, no url to process
-        $file = File::staticGet('url', $given_url);
+        $file = File::getKV('url', $given_url);
         if (empty($file)) {
-            $file_redir = File_redirection::staticGet('url', $given_url);
+            $file_redir = File_redirection::getKV('url', $given_url);
             if (empty($file_redir)) {
                 // @fixme for new URLs this also looks up non-redirect data
                 // such as target content type, size, etc, which we need
@@ -200,7 +193,7 @@ class File extends Managed_DataObject
         }
 
         if (empty($x)) {
-            $x = File::staticGet('id', $file_id);
+            $x = File::getKV('id', $file_id);
             if (empty($x)) {
                 // @todo FIXME: This could possibly be a clearer message :)
                 // TRANS: Server exception thrown when... Robin thinks something is impossible!
@@ -214,8 +207,7 @@ class File extends Managed_DataObject
         return $x;
     }
 
-    function isRespectsQuota($user,$fileSize) {
-
+    public static function respectsQuota(Profile $scoped, $fileSize) {
         if ($fileSize > common_config('attachments', 'file_quota')) {
             // TRANS: Message used to be inserted as %2$s in  the text "No file may
             // TRANS: be larger than %1$d byte and the file you sent was %2$s.".
@@ -227,61 +219,72 @@ class File extends Managed_DataObject
             // TRANS: %1$d (used for plural) is the byte limit for uploads,
             // TRANS: %2$s is the proper form of "n bytes". This is the only ways to have
             // TRANS: gettext support multiple plurals in the same message, unfortunately...
-            return sprintf(_m('No file may be larger than %1$d byte and the file you sent was %2$s. Try to upload a smaller version.',
+            throw new ClientException(
+                    sprintf(_m('No file may be larger than %1$d byte and the file you sent was %2$s. Try to upload a smaller version.',
                               'No file may be larger than %1$d bytes and the file you sent was %2$s. Try to upload a smaller version.',
                               $fileQuota),
-                           $fileQuota, $fileSizeText);
+                    $fileQuota, $fileSizeText));
         }
 
-        $query = "select sum(size) as total from file join file_to_post on file_to_post.file_id = file.id join notice on file_to_post.post_id = notice.id where profile_id = {$user->id} and file.url like '%/notice/%/file'";
-        $this->query($query);
-        $this->fetch();
-        $total = $this->total + $fileSize;
+        $file = new File;
+
+        $query = "select sum(size) as total from file join file_to_post on file_to_post.file_id = file.id join notice on file_to_post.post_id = notice.id where profile_id = {$scoped->id} and file.url like '%/notice/%/file'";
+        $file->query($query);
+        $file->fetch();
+        $total = $file->total + $fileSize;
         if ($total > common_config('attachments', 'user_quota')) {
             // TRANS: Message given if an upload would exceed user quota.
             // TRANS: %d (number) is the user quota in bytes and is used for plural.
-            return sprintf(_m('A file this large would exceed your user quota of %d byte.',
+            throw new ClientException(
+                    sprintf(_m('A file this large would exceed your user quota of %d byte.',
                               'A file this large would exceed your user quota of %d bytes.',
                               common_config('attachments', 'user_quota')),
-                           common_config('attachments', 'user_quota'));
+                    common_config('attachments', 'user_quota')));
         }
         $query .= ' AND EXTRACT(month FROM file.modified) = EXTRACT(month FROM now()) and EXTRACT(year FROM file.modified) = EXTRACT(year FROM now())';
-        $this->query($query);
-        $this->fetch();
-        $total = $this->total + $fileSize;
+        $file->query($query);
+        $file->fetch();
+        $total = $file->total + $fileSize;
         if ($total > common_config('attachments', 'monthly_quota')) {
             // TRANS: Message given id an upload would exceed a user's monthly quota.
             // TRANS: $d (number) is the monthly user quota in bytes and is used for plural.
-            return sprintf(_m('A file this large would exceed your monthly quota of %d byte.',
+            throw new ClientException(
+                    sprintf(_m('A file this large would exceed your monthly quota of %d byte.',
                               'A file this large would exceed your monthly quota of %d bytes.',
                               common_config('attachments', 'monthly_quota')),
-                           common_config('attachments', 'monthly_quota'));
+                    common_config('attachments', 'monthly_quota')));
         }
         return true;
     }
 
     // where should the file go?
 
-    static function filename($profile, $basename, $mimetype)
+    static function filename(Profile $profile, $origname, $mimetype)
     {
-        require_once 'MIME/Type/Extension.php';
-
-        // We have to temporarily disable auto handling of PEAR errors...
-        PEAR::staticPushErrorHandling(PEAR_ERROR_RETURN);
-
-        $mte = new MIME_Type_Extension();
-        $ext = $mte->getExtension($mimetype);
-        if (PEAR::isError($ext)) {
-            $ext = strtolower(preg_replace('/\W/', '', $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);
         }
 
-        // Restore error handling.
-        PEAR::staticPopErrorHandling();
+        // Normalize and make the original filename more URL friendly.
+        $origname = basename($origname);
+        if (class_exists('Normalizer')) {
+            // http://php.net/manual/en/class.normalizer.php
+            // http://www.unicode.org/reports/tr15/
+            $origname = Normalizer::normalize($origname, Normalizer::FORM_KC);
+        }
+        $origname = preg_replace('/[^A-Za-z0-9\.\_]/', '_', $origname);
 
         $nickname = $profile->nickname;
-        $datestamp = strftime('%Y%m%dT%H%M%S', time());
-        $random = strtolower(common_confirmation_code(32));
-        return "$nickname-$datestamp-$random.$ext";
+        $datestamp = strftime('%Y%m%d', time());
+        do {
+            // generate new random strings until we don't run into a filename collision.
+            $random = strtolower(common_confirmation_code(16));
+            $filename = "$nickname-$datestamp-$origname-$random.$ext";
+        } while (file_exists(self::path($filename)));
+        return $filename;
     }
 
     /**
@@ -394,7 +397,7 @@ class File extends Managed_DataObject
             if(in_array($mimetype,$notEnclosureMimeTypes)){
                 // Never treat generic HTML links as an enclosure type!
                 // But if we have oEmbed info, we'll consider it golden.
-                $oembed = File_oembed::staticGet('file_id',$this->id);
+                $oembed = File_oembed::getKV('file_id',$this->id);
                 if($oembed && in_array($oembed->type, array('photo', 'video'))){
                     $mimetype = strtolower($oembed->mimetype);
                     $semicolon = strpos($mimetype,';');
@@ -431,12 +434,102 @@ class File extends Managed_DataObject
 
     /**
      * Get the attachment's thumbnail record, if any.
+     * Make sure you supply proper 'int' typed variables (or null).
+     *
+     * @param $width  int   Max width of thumbnail in pixels. (if null, use common_config values)
+     * @param $height int   Max height of thumbnail in pixels. (if null, square-crop to $width)
+     * @param $crop   bool  Crop to the max-values' aspect ratio
      *
      * @return File_thumbnail
      */
-    function getThumbnail()
+    public function getThumbnail($width=null, $height=null, $crop=false)
+    {
+        if ($this->width < 1 || $this->height < 1) {
+            // Old files may have 0 until migrated with scripts/upgrade.php
+            return null;
+        }
+
+        if ($width === null) {
+            $width = common_config('thumbnail', 'width');
+            $height = common_config('thumbnail', 'height');
+            $crop = common_config('thumbnail', 'crop');
+        }
+
+        if ($height === null) {
+            $height = $width;
+            $crop = true;
+        }
+        
+        // Get proper aspect ratio width and height before lookup
+        list($width, $height, $x, $y, $w2, $h2) =
+                                ImageFile::getScalingValues($this->width, $this->height, $width, $height, $crop);
+
+        // Doublecheck that parameters are sane and integers.
+        if ($width < 1 || $width > common_config('thumbnail', 'maxsize')
+                || $height < 1 || $height > common_config('thumbnail', 'maxsize')) {
+            // Fail on bad width parameter.
+            throw new ServerException('Bad thumbnail width or height parameter');
+        }
+
+        $params = array('file_id'=> $this->id,
+                        'width'  => $width,
+                        'height' => $height);
+        $thumb = File_thumbnail::pkeyGet($params);
+        if ($thumb === null) {
+            try {
+                $thumb = $this->generateThumbnail($width, $height, $crop);
+            } catch (UnsupportedMediaException $e) {
+                // FIXME: Add "unknown media" icon or something
+            } catch (ServerException $e) {
+                // Probably a remote media file, maybe not available locally
+            }
+        }
+        return $thumb;
+    }
+
+    /**
+     * Generate and store a thumbnail image for the uploaded file, if applicable.
+     * Call this only if you know what you're doing.
+     *
+     * @param $width  int    Maximum thumbnail width in pixels
+     * @param $height int    Maximum thumbnail height in pixels, if null, crop to $width
+     *
+     * @return File_thumbnail or null
+     */
+    protected function generateThumbnail($width, $height, $crop)
+    {
+        $width = intval($width);
+        if ($height === null) {
+            $height = $width;
+            $crop = true;
+        }
+
+        $image = ImageFile::fromFileObject($this);
+
+        list($width, $height, $x, $y, $w2, $h2) =
+                                $image->scaleToFit($width, $height, $crop);
+
+        $outname = "thumb-{$width}x{$height}-" . $this->filename;
+        $outpath = self::path($outname);
+
+        $image->resizeTo($outpath, $width, $height, $x, $y, $w2, $h2);
+
+        // Avoid deleting the original
+        if ($image->getPath() != $this->getPath()) {
+            $image->unlink();
+        }
+        return File_thumbnail::saveThumbnail($this->id,
+                                      self::url($outname),
+                                      $width, $height);
+    }
+
+    public function getPath()
+    {
+        return self::path($this->filename);
+    }
+    public function getUrl()
     {
-        return File_thumbnail::staticGet('file_id', $this->id);
+        return $this->url;
     }
 
     /**