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
31 public $filename; // text
32 public $width; // int(4) primary_key
33 public $height; // int(4) primary_key
34 public $modified; // timestamp() not_null default_CURRENT_TIMESTAMP
36 public static function schemaDef()
40 'file_id' => array('type' => 'int', 'not null' => true, 'description' => 'thumbnail for what URL/file'),
41 'url' => array('type' => 'text', 'not null' => false, 'description' => 'URL of thumbnail'),
42 'filename' => array('type' => 'text', 'description' => 'if stored locally, filename is put here'),
43 'width' => array('type' => 'int', 'description' => 'width of thumbnail'),
44 'height' => array('type' => 'int', 'description' => 'height of thumbnail'),
45 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
47 'primary key' => array('file_id', 'width', 'height'),
49 'file_thumbnail_file_id_idx' => array('file_id'),
51 'foreign keys' => array(
52 'file_thumbnail_file_id_fkey' => array('file', array('file_id' => 'id')),
58 * Save oEmbed-provided thumbnail data
63 public static function saveNew($data, $file_id) {
64 if (!empty($data->thumbnail_url)) {
65 // Non-photo types such as video will usually
66 // show us a thumbnail, though it's not required.
67 self::saveThumbnail($file_id,
69 $data->thumbnail_width,
70 $data->thumbnail_height);
71 } else if ($data->type == 'photo') {
72 // The inline photo URL given should also fit within
73 // our requested thumbnail size, per oEmbed spec.
74 self::saveThumbnail($file_id,
82 * Fetch an entry by using a File's id
84 static function byFile(File $file) {
85 $file_thumbnail = self::getKV('file_id', $file->getID());
86 if (!$file_thumbnail instanceof File_thumbnail) {
87 throw new ServerException(sprintf('No File_thumbnail entry for File id==%u', $file->getID()));
89 return $file_thumbnail;
93 * Save a thumbnail record for the referenced file record.
95 * FIXME: Add error handling
102 static function saveThumbnail($file_id, $url, $width, $height, $filename=null)
104 $tn = new File_thumbnail;
105 $tn->file_id = $file_id;
107 $tn->filename = $filename;
108 $tn->width = intval($width);
109 $tn->height = intval($height);
114 static function path($filename)
116 // TODO: Store thumbnails in their own directory and don't use File::path here
117 return File::path($filename);
120 static function url($filename)
122 // TODO: Store thumbnails in their own directory and don't use File::url here
123 return File::url($filename);
126 public function getPath()
128 $filepath = self::path($this->filename);
129 if (!file_exists($filepath)) {
130 throw new FileNotFoundException($filepath);
135 public function getUrl()
137 if (!empty($this->getFile()->filename)) {
138 // A locally stored File, so we can dynamically generate a URL.
139 if (!empty($this->url)) {
140 // Let's just clear this field as there is no point in having it for local files.
141 $orig = clone($this);
143 $this->update($orig);
145 $url = common_local_url('attachment_thumbnail', array('attachment'=>$this->file_id));
146 if (strpos($url, '?') === false) {
149 return $url . http_build_query(array('w'=>$this->width, 'h'=>$this->height));
152 // No local filename available, return the URL we have stored
156 public function delete($useWhere=false)
158 if (!empty($this->filename) && file_exists(File_thumbnail::path($this->filename))) {
159 $deleted = @unlink(self::path($this->filename));
161 common_log(LOG_ERR, sprintf('Could not unlink existing file: "%s"', self::path($this->filename)));
165 return parent::delete($useWhere);
168 public function getFile()
170 return File::getByID($this->file_id);