3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2008, 2009, StatusNet, Inc.
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.
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.
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/>.
20 if (!defined('GNUSOCIAL')) { exit(1); }
23 * Table Definition for file_thumbnail
26 class File_thumbnail extends Managed_DataObject
28 public $__table = 'file_thumbnail'; // table name
29 public $file_id; // int(4) primary_key not_null
30 public $urlhash; // varchar(64) indexed
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
37 const URLHASH_ALG = 'sha256';
39 public static function schemaDef()
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'),
51 'primary key' => array('file_id', 'width', 'height'),
53 'file_thumbnail_file_id_idx' => array('file_id'),
54 'file_thumbnail_urlhash_idx' => array('urlhash'),
56 'foreign keys' => array(
57 'file_thumbnail_file_id_fkey' => array('file', array('file_id' => 'id')),
63 * Save oEmbed-provided thumbnail data
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,
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,
87 * Fetch an entry by using a File's id
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"
92 * @return File_thumbnail
93 * @throws NoResultException if no File_thumbnail matched the criteria
95 static function byFile(File $file, $notNullUrl=true) {
96 $thumb = new File_thumbnail();
97 $thumb->file_id = $file->getID();
99 $thumb->whereAdd('url IS NOT NULL');
101 $thumb->orderBy('modified ASC'); // the first created, a somewhat ugly hack
103 if (!$thumb->find(true)) {
104 throw new NoResultException($thumb);
110 * Save a thumbnail record for the referenced file record.
112 * FIXME: Add error handling
114 * @param int $file_id
119 static function saveThumbnail($file_id, $url, $width, $height, $filename=null)
121 $tn = new File_thumbnail;
122 $tn->file_id = $file_id;
124 $tn->filename = $filename;
125 $tn->width = intval($width);
126 $tn->height = intval($height);
131 static function path($filename)
133 File::tryFilename($filename);
135 // NOTE: If this is left empty in default config, it will be set to File::path('thumb')
136 $dir = common_config('thumbnail', 'dir');
138 if (!in_array($dir[mb_strlen($dir)-1], ['/', '\\'])) {
139 $dir .= DIRECTORY_SEPARATOR;
142 return $dir . $filename;
145 static function url($filename)
147 File::tryFilename($filename);
149 // FIXME: private site thumbnails?
151 $path = common_config('thumbnail', 'path');
153 return File::url('thumb')."/{$filename}";
156 $protocol = (GNUsocial::useHTTPS() ? 'https' : 'http');
157 $server = common_config('thumbnail', 'server') ?: common_config('site', 'server');
159 if ($path[mb_strlen($path)-1] != '/') {
162 if ($path[0] != '/') {
166 return $protocol.'://'.$server.$path.$filename;
169 public function getFilename()
171 return File::tryFilename($this->filename);
176 * @return string full filesystem path to the locally stored thumbnail file
179 public function getPath()
181 $oldpath = File::path($this->getFilename());
182 $thumbpath = self::path($this->getFilename());
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)) {
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;
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.');
208 common_log(LOG_DEBUG, 'Moved thumbnail '.$this->file_id.' from '._ve($oldpath).' to '._ve($thumbpath));
210 } elseif (!file_exists($thumbpath)) {
211 throw new FileNotFoundException($thumbpath);
217 public function getUrl()
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) {
225 return $url . http_build_query(array('w'=>$this->width, 'h'=>$this->height));
228 // No local filename available, return the remote URL we have stored
232 public function getHeight()
234 return $this->height;
237 public function getWidth()
243 * @throws UseFileAsThumbnailException from File_thumbnail->getUrl() for stuff like animated GIFs
245 public function getHtmlAttrs(array $orig=array(), $overwrite=true)
248 'height' => $this->getHeight(),
249 'width' => $this->getWidth(),
250 'src' => $this->getUrl(),
252 return $overwrite ? array_merge($orig, $attrs) : array_merge($attrs, $orig);
255 public function delete($useWhere=false)
258 $thumbpath = self::path($this->getFilename());
259 // if file does not exist, try to delete it
260 $deleted = !file_exists($thumbpath) || @unlink($thumbpath);
262 common_log(LOG_ERR, 'Could not unlink existing thumbnail file: '._ve($thumbpath));
264 } catch (InvalidFilenameException $e) {
265 common_log(LOG_ERR, 'Deleting object but not attempting deleting file: '._ve($e->getMessage()));
268 return parent::delete($useWhere);
271 public function getFile()
273 return File::getByID($this->file_id);
276 public function getFileId()
278 return $this->file_id;
281 static public function hashurl($url)
283 if (!mb_strlen($url)) {
284 throw new Exception('No URL provided to hash algorithm.');
286 return hash(self::URLHASH_ALG, $url);
289 public function onInsert()
294 public function onUpdate($dataObject=false)
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) {
302 public function setUrlhash()
304 $this->urlhash = mb_strlen($this->url)>0 ? self::hashurl($this->url) : null;