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