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         if (!File::validFilename($filename)) {
 133             // TRANS: Client exception thrown if a file upload does not have a valid name.
 134             throw new ClientException(_('Invalid filename.'));
 135         }
 136
 137         // NOTE: If this is empty, it will be set to File::path('thumb')
 138         $dir = common_config('thumbnail', 'dir');
 139
 140         if (!in_array($dir[mb_strlen($dir)-1], ['/', '\\'])) {
 141             $dir .= DIRECTORY_SEPARATOR;
 142         }
 143
 144         return $dir . $filename;
 145     }
 146
 147     static function url($filename)
 148     {
 149         if (!File::validFilename($filename)) {
 150             // TRANS: Client exception thrown if a file upload does not have a valid name.
 151             throw new ClientException(_('Invalid filename.'));
 152         }
 153
 154         // FIXME: private site thumbnails?
 155
 156         $path = common_config('thumbnail', 'path');
 157         if (empty($path)) {
 158             return File::url('thumb')."/{$filename}";
 159         }
 160
 161         $protocol = (GNUsocial::useHTTPS() ? 'https' : 'http');
 162         $server = common_config('thumbnail', 'server') ?: common_config('site', 'server');
 163
 164         if ($path[mb_strlen($path)-1] != '/') {
 165             $path .= '/';
 166         }
 167         if ($path[0] != '/') {
 168             $path = '/'.$path;
 169         }
 170
 171         return $protocol.'://'.$server.$path.$filename;
 172     }
 173
 174     public function getFilename()
 175     {
 176         if (!File::validFilename($this->filename)) {
 177             // TRANS: Client exception thrown if a file upload does not have a valid name.
 178             throw new ClientException(_("Invalid filename."));
 179         }
 180         return $this->filename;
 181     }
 182
 183     public function getPath()
 184     {
 185         $oldpath = File::path($this->getFilename());
 186         $thumbpath = self::path($this->getFilename());
 187
 188         // If we have a file in our old thumbnail storage path, move it to the new one
 189         if (file_exists($oldpath) && !file_exists($thumbpath)) {
 190             if ($this->getFilename() === $this->getFile()->filename) {
 191                 // special case where thumbnail file exactly matches stored File filename
 192                 common_debug('File filename and File_thumbnail filename match on '.$this->file_id.', copying instead');
 193                 copy($oldpath, $thumbpath);
 194             } elseif (!rename($oldpath, $thumbpath)) {
 195                 common_log(LOG_ERR, 'Could not move thumbnail from '._ve($oldpath).' to '._ve($thumbpath));
 196                 throw new ServerException('Could not move thumbnail from old path to new path.');
 197             } else {
 198                 common_log(LOG_DEBUG, 'Moved thumbnail '.$this->file_id.' from '._ve($oldpath).' to '._ve($thumbpath));
 199             }
 200         } elseif (!file_exists($thumbpath)) {
 201             throw new FileNotFoundException($thumbpath);
 202         }
 203         return $thumbpath;
 204     }
 205
 206     public function getUrl()
 207     {
 208         if (!empty($this->filename) || $this->getFile()->isLocal()) {
 209             // A locally stored File, so we can dynamically generate a URL.
 210             $url = common_local_url('attachment_thumbnail', array('attachment'=>$this->file_id));
 211             if (strpos($url, '?') === false) {
 212                 $url .= '?';
 213             }
 214             return $url . http_build_query(array('w'=>$this->width, 'h'=>$this->height));
 215         }
 216
 217         // No local filename available, return the remote URL we have stored
 218         return $this->url;
 219     }
 220
 221     public function getHeight()
 222     {
 223         return $this->height;
 224     }
 225
 226     public function getWidth()
 227     {
 228         return $this->width;
 229     }
 230
 231     /**
 232      * @throws UseFileAsThumbnailException from File_thumbnail->getUrl() for stuff like animated GIFs
 233      */
 234     public function getHtmlAttrs(array $orig=array(), $overwrite=true)
 235     {
 236         $attrs = [
 237                 'height' => $this->getHeight(),
 238                 'width'  => $this->getWidth(),
 239                 'src'    => $this->getUrl(),
 240             ];
 241         return $overwrite ? array_merge($orig, $attrs) : array_merge($attrs, $orig);
 242     }
 243
 244     public function delete($useWhere=false)
 245     {
 246         if (!empty($this->filename)) {
 247             try {
 248                 $deleted = @unlink($this->getPath());
 249                 if (!$deleted) {
 250                     common_log(LOG_ERR, 'Could not unlink existing thumbnail file: '._ve($this->getPath()));
 251                 }
 252             } catch (FileNotFoundException $e) {
 253                 common_log(LOG_INFO, 'Thumbnail already gone from '._ve($e->path));
 254             }
 255         }
 256
 257         return parent::delete($useWhere);
 258     }
 259
 260     public function getFile()
 261     {
 262         return File::getByID($this->file_id);
 263     }
 264
 265
 266     static public function hashurl($url)
 267     {
 268         if (!mb_strlen($url)) {
 269             throw new Exception('No URL provided to hash algorithm.');
 270         }
 271         return hash(self::URLHASH_ALG, $url);
 272     }
 273
 274     public function onInsert()
 275     {
 276         $this->setUrlhash();
 277     }
 278
 279     public function onUpdate($dataObject=false)
 280     {
 281         // if we have nothing to compare with OR it has changed from previous entry
 282         if (!$dataObject instanceof Managed_DataObject || $this->url !== $dataObject->url) {
 283             $this->setUrlhash();
 284         }
 285     }
 286
 287     public function setUrlhash()
 288     {
 289         $this->urlhash = mb_strlen($this->url)>0 ? self::hashurl($this->url) : null;
 290     }
 291 }