classes/File_thumbnail.php

   1 <?php
   2 /*
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2008, 2009, StatusNet, Inc.
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU Affero General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.     See the
  14  * GNU Affero General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Affero General Public License
  17  * along with this program.     If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 if (!defined('GNUSOCIAL')) { exit(1); }
  21
  22 /**
  23  * Table Definition for file_thumbnail
  24  */
  25
  26 class File_thumbnail extends Managed_DataObject
  27 {
  28     public $__table = 'file_thumbnail';                  // table name
  29     public $file_id;                         // int(4)  primary_key not_null
  30     public $urlhash;                         // varchar(64) indexed
  31     public $url;                             // text
  32     public $filename;                        // text
  33     public $width;                           // int(4)  primary_key
  34     public $height;                          // int(4)  primary_key
  35     public $modified;                        // timestamp()   not_null default_CURRENT_TIMESTAMP
  36
  37     const URLHASH_ALG = 'sha256';
  38
  39     public static function schemaDef()
  40     {
  41         return array(
  42             'fields' => array(
  43                 'file_id' => array('type' => 'int', 'not null' => true, 'description' => 'thumbnail for what URL/file'),
  44                 'urlhash' => array('type' => 'varchar', 'length' => 64, 'description' => 'sha256 of url field if non-empty'),
  45                 'url' => array('type' => 'text', 'description' => 'URL of thumbnail'),
  46                 'filename' => array('type' => 'text', 'description' => 'if stored locally, filename is put here'),
  47                 'width' => array('type' => 'int', 'description' => 'width of thumbnail'),
  48                 'height' => array('type' => 'int', 'description' => 'height of thumbnail'),
  49                 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
  50             ),
  51             'primary key' => array('file_id', 'width', 'height'),
  52             'indexes' => array(
  53                 'file_thumbnail_file_id_idx' => array('file_id'),
  54                 'file_thumbnail_urlhash_idx' => array('urlhash'),
  55             ),
  56             'foreign keys' => array(
  57                 'file_thumbnail_file_id_fkey' => array('file', array('file_id' => 'id')),
  58             )
  59         );
  60     }
  61
  62     /**
  63      * Save oEmbed-provided thumbnail data
  64      *
  65      * @param object $data
  66      * @param int $file_id
  67      */
  68     public static function saveNew($data, $file_id) {
  69         if (!empty($data->thumbnail_url)) {
  70             // Non-photo types such as video will usually
  71             // show us a thumbnail, though it's not required.
  72             self::saveThumbnail($file_id,
  73                                 $data->thumbnail_url,
  74                                 $data->thumbnail_width,
  75                                 $data->thumbnail_height);
  76         } else if ($data->type == 'photo') {
  77             // The inline photo URL given should also fit within
  78             // our requested thumbnail size, per oEmbed spec.
  79             self::saveThumbnail($file_id,
  80                                 $data->url,
  81                                 $data->width,
  82                                 $data->height);
  83         }
  84     }
  85
  86     /**
  87      * Fetch an entry by using a File's id
  88      *
  89      * @param   File    $file       The File object we're getting a thumbnail for.
  90      * @param   boolean $notNullUrl Originally remote thumbnails have a URL stored, we use this to find the "original"
  91      *
  92      * @return  File_thumbnail
  93      * @throws  NoResultException if no File_thumbnail matched the criteria
  94      */
  95     static function byFile(File $file, $notNullUrl=true) {
  96         $thumb = new File_thumbnail();
  97         $thumb->file_id = $file->getID();
  98         if ($notNullUrl) {
  99             $thumb->whereAdd('url IS NOT NULL');
 100         }
 101         $thumb->limit(1);
 102         if (!$thumb->find(true)) {
 103             throw new NoResultException($thumb);
 104         }
 105         return $thumb;
 106     }
 107
 108     /**
 109      * Save a thumbnail record for the referenced file record.
 110      *
 111      * FIXME: Add error handling
 112      *
 113      * @param int $file_id
 114      * @param string $url
 115      * @param int $width
 116      * @param int $height
 117      */
 118     static function saveThumbnail($file_id, $url, $width, $height, $filename=null)
 119     {
 120         $tn = new File_thumbnail;
 121         $tn->file_id = $file_id;
 122         $tn->url = $url;
 123         $tn->filename = $filename;
 124         $tn->width = intval($width);
 125         $tn->height = intval($height);
 126         $tn->insert();
 127         return $tn;
 128     }
 129
 130     static function path($filename)
 131     {
 132         // TODO: Store thumbnails in their own directory and don't use File::path here
 133         return File::path($filename);
 134     }
 135
 136     static function url($filename)
 137     {
 138         // TODO: Store thumbnails in their own directory and don't use File::url here
 139         return File::url($filename);
 140     }
 141
 142     public function getPath()
 143     {
 144         $filepath = self::path($this->filename);
 145         if (!file_exists($filepath)) {
 146             throw new FileNotFoundException($filepath);
 147         }
 148         return $filepath;
 149     }
 150
 151     public function getUrl()
 152     {
 153         if (!empty($this->filename) || $this->getFile()->isLocal()) {
 154             // A locally stored File, so we can dynamically generate a URL.
 155             $url = common_local_url('attachment_thumbnail', array('attachment'=>$this->file_id));
 156             if (strpos($url, '?') === false) {
 157                 $url .= '?';
 158             }
 159             return $url . http_build_query(array('w'=>$this->width, 'h'=>$this->height));
 160         }
 161
 162         // No local filename available, return the remote URL we have stored
 163         return $this->url;
 164     }
 165
 166     public function getHeight()
 167     {
 168         return $this->height;
 169     }
 170
 171     public function getWidth()
 172     {
 173         return $this->width;
 174     }
 175
 176     /**
 177      * @throws UseFileAsThumbnailException from File_thumbnail->getUrl() for stuff like animated GIFs
 178      */
 179     public function getHtmlAttrs(array $orig=array(), $overwrite=true)
 180     {
 181         $attrs = [
 182                 'height' => $this->getHeight(),
 183                 'width'  => $this->getWidth(),
 184                 'src'    => $this->getUrl(),
 185             ];
 186         return $overwrite ? array_merge($orig, $attrs) : array_merge($attrs, $orig);
 187     }
 188
 189     public function delete($useWhere=false)
 190     {
 191         if (!empty($this->filename) && file_exists(File_thumbnail::path($this->filename))) {
 192             $deleted = @unlink(self::path($this->filename));
 193             if (!$deleted) {
 194                 common_log(LOG_ERR, sprintf('Could not unlink existing file: "%s"', self::path($this->filename)));
 195             }
 196         }
 197
 198         return parent::delete($useWhere);
 199     }
 200
 201     public function getFile()
 202     {
 203         return File::getByID($this->file_id);
 204     }
 205
 206
 207     static public function hashurl($url)
 208     {
 209         if (!mb_strlen($url)) {
 210             throw new Exception('No URL provided to hash algorithm.');
 211         }
 212         return hash(self::URLHASH_ALG, $url);
 213     }
 214
 215     public function onInsert()
 216     {
 217         $this->setUrlhash();
 218     }
 219
 220     public function onUpdate($dataObject=false)
 221     {
 222         // if we have nothing to compare with OR it has changed from previous entry
 223         if (!$dataObject instanceof Managed_DataObject || $this->url !== $dataObject->url) {
 224             $this->setUrlhash();
 225         }
 226     }
 227
 228     public function setUrlhash()
 229     {
 230         $this->urlhash = mb_strlen($this->url)>0 ? self::hashurl($this->url) : null;
 231     }
 232 }