]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - classes/File_thumbnail.php
Verify that authenticated API calls are made from our domain name.
[quix0rs-gnu-social.git] / classes / File_thumbnail.php
index 064b454e2dd2a314d390d01b30883b858b6ee72c..e028409f0f0f62b4cdd278cf0a26bd244c1a7b1d 100644 (file)
@@ -17,9 +17,7 @@
  * 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';
+if (!defined('GNUSOCIAL')) { exit(1); }
 
 /**
  * Table Definition for file_thumbnail
@@ -27,39 +25,37 @@ require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
 
 class File_thumbnail extends Managed_DataObject
 {
-    ###START_AUTOCODE
-    /* the code below is auto generated do not remove the above tag */
-
     public $__table = 'file_thumbnail';                  // table name
     public $file_id;                         // int(4)  primary_key not_null
-    public $url;                             // varchar(255)  unique_key
-    public $width;                           // int(4)
-    public $height;                          // int(4)
+    public $urlhash;                         // varchar(64) indexed
+    public $url;                             // text
+    public $filename;                        // text
+    public $width;                           // int(4)  primary_key
+    public $height;                          // int(4)  primary_key
     public $modified;                        // timestamp()   not_null default_CURRENT_TIMESTAMP
 
-    /* Static get */
-    function staticGet($k,$v=NULL) { return Memcached_DataObject::staticGet('File_thumbnail',$k,$v); }
-
-    /* the code above is auto generated do not remove the tag below */
-    ###END_AUTOCODE
+    const URLHASH_ALG = 'sha256';
 
     public static function schemaDef()
     {
         return array(
             'fields' => array(
                 'file_id' => array('type' => 'int', 'not null' => true, 'description' => 'thumbnail for what URL/file'),
-                'url' => array('type' => 'varchar', 'length' => 255, 'description' => 'URL of thumbnail'),
+                'urlhash' => array('type' => 'varchar', 'length' => 64, 'description' => 'sha256 of url field if non-empty'),
+                'url' => array('type' => 'text', 'description' => 'URL of thumbnail'),
+                'filename' => array('type' => 'text', 'description' => 'if stored locally, filename is put here'),
                 'width' => array('type' => 'int', 'description' => 'width of thumbnail'),
                 'height' => array('type' => 'int', 'description' => 'height of thumbnail'),
                 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
             ),
-            'primary key' => array('file_id'),
+            'primary key' => array('file_id', 'width', 'height'),
+            'indexes' => array(
+                'file_thumbnail_file_id_idx' => array('file_id'),
+                'file_thumbnail_urlhash_idx' => array('urlhash'),
+            ),
             'foreign keys' => array(
                 'file_thumbnail_file_id_fkey' => array('file', array('file_id' => 'id')),
-            ),
-            'unique keys' => array(
-                'file_thumbnail_url_key' => array('url'),
-            ),
+            )
         );
     }
 
@@ -87,21 +83,150 @@ class File_thumbnail extends Managed_DataObject
         }
     }
 
+    /**
+     * Fetch an entry by using a File's id
+     *
+     * @param   File    $file       The File object we're getting a thumbnail for.
+     * @param   boolean $notNullUrl Originally remote thumbnails have a URL stored, we use this to find the "original"
+     *
+     * @return  File_thumbnail
+     * @throws  NoResultException if no File_thumbnail matched the criteria
+     */
+    static function byFile(File $file, $notNullUrl=true) {
+        $thumb = new File_thumbnail();
+        $thumb->file_id = $file->getID();
+        if ($notNullUrl) {
+            $thumb->whereAdd('url IS NOT NULL');
+        }
+        $thumb->limit(1);
+        if (!$thumb->find(true)) {
+            throw new NoResultException($thumb);
+        }
+        return $thumb;
+    }
+
     /**
      * Save a thumbnail record for the referenced file record.
      *
+     * FIXME: Add error handling
+     *
      * @param int $file_id
      * @param string $url
      * @param int $width
      * @param int $height
      */
-    static function saveThumbnail($file_id, $url, $width, $height)
+    static function saveThumbnail($file_id, $url, $width, $height, $filename=null)
     {
         $tn = new File_thumbnail;
         $tn->file_id = $file_id;
         $tn->url = $url;
+        $tn->filename = $filename;
         $tn->width = intval($width);
         $tn->height = intval($height);
         $tn->insert();
+        return $tn;
+    }
+
+    static function path($filename)
+    {
+        // TODO: Store thumbnails in their own directory and don't use File::path here
+        return File::path($filename);
+    }
+
+    static function url($filename)
+    {
+        // TODO: Store thumbnails in their own directory and don't use File::url here
+        return File::url($filename);
+    }
+
+    public function getPath()
+    {
+        $filepath = self::path($this->filename);
+        if (!file_exists($filepath)) {
+            throw new FileNotFoundException($filepath);
+        }
+        return $filepath;
+    }
+
+    public function getUrl()
+    {
+        if (!empty($this->filename) || $this->getFile()->isLocal()) {
+            // A locally stored File, so we can dynamically generate a URL.
+            $url = common_local_url('attachment_thumbnail', array('attachment'=>$this->file_id));
+            if (strpos($url, '?') === false) {
+                $url .= '?';
+            }
+            return $url . http_build_query(array('w'=>$this->width, 'h'=>$this->height));
+        }
+
+        // No local filename available, return the remote URL we have stored
+        return $this->url;
+    }
+
+    public function getHeight()
+    {
+        return $this->height;
+    }
+
+    public function getWidth()
+    {
+        return $this->width;
+    }
+
+    /**
+     * @throws UseFileAsThumbnailException from File_thumbnail->getUrl() for stuff like animated GIFs
+     */
+    public function getHtmlAttrs(array $orig=array(), $overwrite=true)
+    {
+        $attrs = [
+                'height' => $this->getHeight(),
+                'width'  => $this->getWidth(),
+                'src'    => $this->getUrl(),
+            ];
+        return $overwrite ? array_merge($orig, $attrs) : array_merge($attrs, $orig);
+    }
+
+    public function delete($useWhere=false)
+    {
+        if (!empty($this->filename) && file_exists(File_thumbnail::path($this->filename))) {
+            $deleted = @unlink(self::path($this->filename));
+            if (!$deleted) {
+                common_log(LOG_ERR, sprintf('Could not unlink existing file: "%s"', self::path($this->filename)));
+            }
+        }
+
+        return parent::delete($useWhere);
+    }
+
+    public function getFile()
+    {
+        return File::getByID($this->file_id);
+    }
+
+
+    static public function hashurl($url)
+    {
+        if (!mb_strlen($url)) {
+            throw new Exception('No URL provided to hash algorithm.');
+        }
+        return hash(self::URLHASH_ALG, $url);
+    }
+
+    public function onInsert()
+    {
+        $this->setUrlhash();
+    }
+
+    public function onUpdate($dataObject=false)
+    {
+        // if we have nothing to compare with OR it has changed from previous entry
+        if (!$dataObject instanceof Managed_DataObject || $this->url !== $dataObject->url) {
+            $this->setUrlhash();
+        }
+    }
+
+    public function setUrlhash()
+    {
+        $this->urlhash = mb_strlen($this->url)>0 ? self::hashurl($this->url) : null;
     }
 }