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