]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - classes/File.php
Core plugin list would not merge into $config
[quix0rs-gnu-social.git] / classes / File.php
index ba8332841409f936c5c3e28ad615fef34e479151..e3300e7e6870981de8684e251edb3f750d33e501 100644 (file)
@@ -29,8 +29,7 @@ require_once INSTALLDIR.'/classes/File_to_post.php';
 /**
  * Table Definition for file
  */
-
-class File extends Memcached_DataObject
+class File extends Managed_DataObject
 {
     ###START_AUTOCODE
     /* the code below is auto generated do not remove the above tag */
@@ -46,25 +45,33 @@ class File extends Memcached_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
 
-    function isProtected($url) {
-        return 'http://www.facebook.com/login.php' === $url;
+    public static function schemaDef()
+    {
+        return array(
+            'fields' => array(
+                'id' => array('type' => 'serial', 'not null' => true),
+                'url' => array('type' => 'varchar', 'length' => 255, 'description' => 'destination URL after following redirections'),
+                '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' => 255, 'description' => 'title of resource when available'),
+                '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'),
+
+                'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
+            ),
+            'primary key' => array('id'),
+            'unique keys' => array(
+                'file_url_key' => array('url'),
+            ),
+        );
     }
 
-    function getAttachments($post_id) {
-        $query = "select file.* from file join file_to_post on (file_id = file.id) join notice on (post_id = notice.id) where post_id = " . $this->escape($post_id);
-        $this->query($query);
-        $att = array();
-        while ($this->fetch()) {
-            $att[] = clone($this);
-        }
-        $this->free();
-        return $att;
+    function isProtected($url) {
+        return 'http://www.facebook.com/login.php' === $url;
     }
 
     /**
@@ -75,14 +82,22 @@ class File extends Memcached_DataObject
      * @return File
      */
     function saveNew(array $redir_data, $given_url) {
-        $x = new File;
-        $x->url = $given_url;
-        if (!empty($redir_data['protected'])) $x->protected = $redir_data['protected'];
-        if (!empty($redir_data['title'])) $x->title = $redir_data['title'];
-        if (!empty($redir_data['type'])) $x->mimetype = $redir_data['type'];
-        if (!empty($redir_data['size'])) $x->size = intval($redir_data['size']);
-        if (isset($redir_data['time']) && $redir_data['time'] > 0) $x->date = intval($redir_data['time']);
-        $file_id = $x->insert();
+
+        // I don't know why we have to keep doing this but I'm adding this last check to avoid
+        // uniqueness bugs.
+
+        $x = File::getKV('url', $given_url);
+        
+        if (empty($x)) {
+            $x = new File;
+            $x->url = $given_url;
+            if (!empty($redir_data['protected'])) $x->protected = $redir_data['protected'];
+            if (!empty($redir_data['title'])) $x->title = $redir_data['title'];
+            if (!empty($redir_data['type'])) $x->mimetype = $redir_data['type'];
+            if (!empty($redir_data['size'])) $x->size = intval($redir_data['size']);
+            if (isset($redir_data['time']) && $redir_data['time'] > 0) $x->date = intval($redir_data['time']);
+            $file_id = $x->insert();
+        }
 
         $x->saveOembed($redir_data, $given_url);
         return $x;
@@ -98,13 +113,13 @@ class File extends Memcached_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);
+            $fo = File_oembed::getKV('file_id', $this->id);
 
             if (empty($fo)) {
                 File_oembed::saveNew($oembed_data, $this->id);
@@ -116,14 +131,36 @@ class File extends Memcached_DataObject
         return false;
     }
 
-    function processNew($given_url, $notice_id=null) {
+    /**
+     * Go look at a URL and possibly save data about it if it's new:
+     * - follow redirect chains and store them in file_redirection
+     * - look up oEmbed data and save it in file_oembed
+     * - if a thumbnail is available, save it in file_thumbnail
+     * - save file record with basic info
+     * - optionally save a file_to_post record
+     * - return the File object with the full reference
+     *
+     * @fixme refactor this mess, it's gotten pretty scary.
+     * @param string $given_url the URL we're looking at
+     * @param int $notice_id (optional)
+     * @param bool $followRedirects defaults to true
+     *
+     * @return mixed File on success, -1 on some errors
+     *
+     * @throws ServerException on some errors
+     */
+    public function processNew($given_url, $notice_id=null, $followRedirects=true) {
         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
+                // for File::saveNew(); so we call it even if not following
+                // new redirects.
                 $redir_data = File_redirection::where($given_url);
                 if (is_array($redir_data)) {
                     $redir_url = $redir_data['url'];
@@ -131,14 +168,23 @@ class File extends Memcached_DataObject
                     $redir_url = $redir_data;
                     $redir_data = array();
                 } else {
-                    throw new ServerException("Can't process url '$given_url'");
+                    // TRANS: Server exception thrown when a URL cannot be processed.
+                    throw new ServerException(sprintf(_("Cannot process URL '%s'"), $given_url));
                 }
                 // TODO: max field length
-                if ($redir_url === $given_url || strlen($redir_url) > 255) {
+                if ($redir_url === $given_url || strlen($redir_url) > 255 || !$followRedirects) {
                     $x = File::saveNew($redir_data, $given_url);
                     $file_id = $x->id;
                 } else {
-                    $x = File::processNew($redir_url, $notice_id);
+                    // This seems kind of messed up... for now skipping this part
+                    // if we're already under a redirect, so we don't go into
+                    // horrible infinite loops if we've been given an unstable
+                    // redirect (where the final destination of the first request
+                    // doesn't match what we get when we ask for it again).
+                    //
+                    // Seen in the wild with clojure.org, which redirects through
+                    // wikispaces for auth and appends session data in the URL params.
+                    $x = File::processNew($redir_url, $notice_id, /*followRedirects*/false);
                     $file_id = $x->id;
                     File_redirection::saveNew($redir_data, $file_id, $given_url);
                 }
@@ -151,9 +197,11 @@ class File extends Memcached_DataObject
         }
 
         if (empty($x)) {
-            $x = File::staticGet($file_id);
+            $x = File::getKV('id', $file_id);
             if (empty($x)) {
-                throw new ServerException("Robin thinks something is impossible.");
+                // @todo FIXME: This could possibly be a clearer message :)
+                // TRANS: Server exception thrown when... Robin thinks something is impossible!
+                throw new ServerException(_('Robin thinks something is impossible.'));
             }
         }
 
@@ -163,27 +211,52 @@ class File extends Memcached_DataObject
         return $x;
     }
 
-    function isRespectsQuota($user,$fileSize) {
-
+    public static function respectsQuota(Profile $scoped, $fileSize) {
         if ($fileSize > common_config('attachments', 'file_quota')) {
-            return sprintf(_('No file may be larger than %d bytes ' .
-                             'and the file you sent was %d bytes. Try to upload a smaller version.'),
-                           common_config('attachments', 'file_quota'), $fileSize);
+            // 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.".
+            // TRANS: %1$d is the number of bytes of an uploaded file.
+            $fileSizeText = sprintf(_m('%1$d byte','%1$d bytes',$fileSize),$fileSize);
+
+            $fileQuota = common_config('attachments', 'file_quota');
+            // TRANS: Message given if an upload is larger than the configured maximum.
+            // 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...
+            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));
         }
 
-        $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')) {
-            return sprintf(_('A file this large would exceed your user quota of %d bytes.'), 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.
+            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')));
         }
         $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')) {
-            return sprintf(_('A file this large would exceed your monthly quota of %d bytes.'), 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.
+            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')));
         }
         return true;
     }
@@ -193,8 +266,19 @@ class File extends Memcached_DataObject
     static function filename($profile, $basename, $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));
+        }
+
+        // Restore error handling.
+        PEAR::staticPopErrorHandling();
+
         $nickname = $profile->nickname;
         $datestamp = strftime('%Y%m%dT%H%M%S', time());
         $random = strtolower(common_confirmation_code(32));
@@ -215,7 +299,8 @@ class File extends Memcached_DataObject
     static function path($filename)
     {
         if (!self::validFilename($filename)) {
-            throw new ClientException("Invalid filename");
+            // TRANS: Client exception thrown if a file upload does not have a valid name.
+            throw new ClientException(_("Invalid filename."));
         }
         $dir = common_config('attachments', 'dir');
 
@@ -229,24 +314,42 @@ class File extends Memcached_DataObject
     static function url($filename)
     {
         if (!self::validFilename($filename)) {
-            throw new ClientException("Invalid filename");
+            // TRANS: Client exception thrown if a file upload does not have a valid name.
+            throw new ClientException(_("Invalid filename."));
         }
-        if(common_config('site','private')) {
+
+        if (common_config('site','private')) {
 
             return common_local_url('getfile',
                                 array('filename' => $filename));
 
-        } else {
-            $path = common_config('attachments', 'path');
+        }
 
-            if ($path[strlen($path)-1] != '/') {
-                $path .= '/';
-            }
+        if (StatusNet::isHTTPS()) {
+
+            $sslserver = common_config('attachments', 'sslserver');
 
-            if ($path[0] != '/') {
-                $path = '/'.$path;
+            if (empty($sslserver)) {
+                // XXX: this assumes that background dir == site dir + /file/
+                // not true if there's another server
+                if (is_string(common_config('site', 'sslserver')) &&
+                    mb_strlen(common_config('site', 'sslserver')) > 0) {
+                    $server = common_config('site', 'sslserver');
+                } else if (common_config('site', 'server')) {
+                    $server = common_config('site', 'server');
+                }
+                $path = common_config('site', 'path') . '/file/';
+            } else {
+                $server = $sslserver;
+                $path   = common_config('attachments', 'sslpath');
+                if (empty($path)) {
+                    $path = common_config('attachments', 'path');
+                }
             }
 
+            $protocol = 'https';
+        } else {
+            $path = common_config('attachments', 'path');
             $server = common_config('attachments', 'server');
 
             if (empty($server)) {
@@ -255,19 +358,18 @@ class File extends Memcached_DataObject
 
             $ssl = common_config('attachments', 'ssl');
 
-            if (is_null($ssl)) { // null -> guess
-                if (common_config('site', 'ssl') == 'always' &&
-                    !common_config('attachments', 'server')) {
-                    $ssl = true;
-                } else {
-                    $ssl = false;
-                }
-            }
-
             $protocol = ($ssl) ? 'https' : 'http';
+        }
+
+        if ($path[strlen($path)-1] != '/') {
+            $path .= '/';
+        }
 
-            return $protocol.'://'.$server.$path.$filename;
+        if ($path[0] != '/') {
+            $path = '/'.$path;
         }
+
+        return $protocol.'://'.$server.$path.$filename;
     }
 
     function getEnclosure(){
@@ -281,29 +383,38 @@ class File extends Memcached_DataObject
         $enclosure->mimetype=$this->mimetype;
 
         if(! isset($this->filename)){
-            $notEnclosureMimeTypes = array('text/html','application/xhtml+xml');
-            $mimetype = strtolower($this->mimetype);
+            $notEnclosureMimeTypes = array(null,'text/html','application/xhtml+xml');
+            $mimetype = $this->mimetype;
+            if($mimetype != null){
+                $mimetype = strtolower($this->mimetype);
+            }
             $semicolon = strpos($mimetype,';');
             if($semicolon){
                 $mimetype = substr($mimetype,0,$semicolon);
             }
             if(in_array($mimetype,$notEnclosureMimeTypes)){
-                $oembed = File_oembed::staticGet('file_id',$this->id);
-                if($oembed){
+                // Never treat generic HTML links as an enclosure type!
+                // But if we have oEmbed info, we'll consider it golden.
+                $oembed = File_oembed::getKV('file_id',$this->id);
+                if($oembed && in_array($oembed->type, array('photo', 'video'))){
                     $mimetype = strtolower($oembed->mimetype);
                     $semicolon = strpos($mimetype,';');
                     if($semicolon){
                         $mimetype = substr($mimetype,0,$semicolon);
                     }
-                    if(in_array($mimetype,$notEnclosureMimeTypes)){
-                        return false;
-                    }else{
+                    // @fixme uncertain if this is right.
+                    // we want to expose things like YouTube videos as
+                    // viewable attachments, but don't expose them as
+                    // downloadable enclosures.....?
+                    //if (in_array($mimetype, $notEnclosureMimeTypes)) {
+                    //    return false;
+                    //} else {
                         if($oembed->mimetype) $enclosure->mimetype=$oembed->mimetype;
                         if($oembed->url) $enclosure->url=$oembed->url;
                         if($oembed->title) $enclosure->title=$oembed->title;
                         if($oembed->modified) $enclosure->modified=$oembed->modified;
                         unset($oembed->size);
-                    }
+                    //}
                 } else {
                     return false;
                 }
@@ -318,5 +429,68 @@ class File extends Memcached_DataObject
         $enclosure = $this->getEnclosure();
         return !empty($enclosure);
     }
-}
 
+    /**
+     * Get the attachment's thumbnail record, if any.
+     *
+     * @return File_thumbnail
+     */
+    function getThumbnail()
+    {
+        return File_thumbnail::getKV('file_id', $this->id);
+    }
+
+    /**
+     * Blow the cache of notices that link to this URL
+     *
+     * @param boolean $last Whether to blow the "last" cache too
+     *
+     * @return void
+     */
+
+    function blowCache($last=false)
+    {
+        self::blow('file:notice-ids:%s', $this->url);
+        if ($last) {
+            self::blow('file:notice-ids:%s;last', $this->url);
+        }
+        self::blow('file:notice-count:%d', $this->id);
+    }
+
+    /**
+     * Stream of notices linking to this URL
+     *
+     * @param integer $offset   Offset to show; default is 0
+     * @param integer $limit    Limit of notices to show
+     * @param integer $since_id Since this notice
+     * @param integer $max_id   Before this notice
+     *
+     * @return array ids of notices that link to this file
+     */
+
+    function stream($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
+    {
+        $stream = new FileNoticeStream($this);
+        return $stream->getNotices($offset, $limit, $since_id, $max_id);
+    }
+
+    function noticeCount()
+    {
+        $cacheKey = sprintf('file:notice-count:%d', $this->id);
+        
+        $count = self::cacheGet($cacheKey);
+
+        if ($count === false) {
+
+            $f2p = new File_to_post();
+
+            $f2p->file_id = $this->id;
+
+            $count = $f2p->count();
+
+            self::cacheSet($cacheKey, $count);
+        } 
+
+        return $count;
+    }
+}