]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - classes/File_thumbnail.php
Merge branch 'master' into social-master
[quix0rs-gnu-social.git] / 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 $url;                             // text
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
35
36     public static function schemaDef()
37     {
38         return array(
39             'fields' => array(
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'),
46             ),
47             'primary key' => array('file_id', 'width', 'height'),
48             'indexes' => array(
49                 'file_thumbnail_file_id_idx' => array('file_id'),
50             ),
51             'foreign keys' => array(
52                 'file_thumbnail_file_id_fkey' => array('file', array('file_id' => 'id')),
53             )
54         );
55     }
56
57     /**
58      * Save oEmbed-provided thumbnail data
59      *
60      * @param object $data
61      * @param int $file_id
62      */
63     public static function saveNew($data, $file_id) {
64         // @TODO Must be an object (see below code)
65         assert(is_object($data));
66
67         if (!empty($data->thumbnail_url)) {
68             // Non-photo types such as video will usually
69             // show us a thumbnail, though it's not required.
70             self::saveThumbnail($file_id,
71                                 $data->thumbnail_url,
72                                 $data->thumbnail_width,
73                                 $data->thumbnail_height);
74         } else if ($data->type == 'photo') {
75             // The inline photo URL given should also fit within
76             // our requested thumbnail size, per oEmbed spec.
77             self::saveThumbnail($file_id,
78                                 $data->url,
79                                 $data->width,
80                                 $data->height);
81         }
82     }
83
84     /**
85      * Fetch an entry by using a File's id
86      */
87     static function byFile(File $file) {
88         $file_thumbnail = self::getKV('file_id', $file->id);
89         if (!$file_thumbnail instanceof File_thumbnail) {
90             throw new ServerException(sprintf('No File_thumbnail entry for File id==%u', $file->id));
91         }
92         return $file_thumbnail;
93     }
94
95     /**
96      * Save a thumbnail record for the referenced file record.
97      *
98      * FIXME: Add error handling
99      *
100      * @param int $file_id
101      * @param string $url
102      * @param int $width
103      * @param int $height
104      */
105     static function saveThumbnail($file_id, $url, $width, $height, $filename=null)
106     {
107         $tn = new File_thumbnail;
108         $tn->file_id = $file_id;
109         $tn->url = $url;
110         $tn->filename = $filename;
111         $tn->width = intval($width);
112         $tn->height = intval($height);
113         $tn->insert();
114         return $tn;
115     }
116
117     static function path($filename)
118     {
119         // TODO: Store thumbnails in their own directory and don't use File::path here
120         return File::path($filename);
121     }
122
123     static function url($filename)
124     {
125         // TODO: Store thumbnails in their own directory and don't use File::url here
126         return File::url($filename);
127     }
128
129     public function getPath()
130     {
131         $filepath = self::path($this->filename);
132         if (!file_exists($filepath)) {
133             throw new FileNotFoundException($filepath);
134         }
135         return $filepath;
136     }
137
138     public function getUrl()
139     {
140         if (!empty($this->getFile()->filename)) {
141             // A locally stored File, so we can dynamically generate a URL.
142             if (!empty($this->url)) {
143                 // Let's just clear this field as there is no point in having it for local files.
144                 $orig = clone($this);
145                 $this->url = null;
146                 $this->update($orig);
147             }
148             $url = common_local_url('attachment_thumbnail', array('attachment'=>$this->file_id));
149             if (strpos($url, '?') === false) {
150                 $url .= '?';
151             }
152             return $url . http_build_query(array('w'=>$this->width, 'h'=>$this->height));
153         }
154
155         // No local filename available, return the URL we have stored
156         return $this->url;
157     }
158
159     public function delete($useWhere=false)
160     {
161         if (!empty($this->filename) && file_exists(File_thumbnail::path($this->filename))) {
162             $deleted = @unlink(self::path($this->filename));
163             if (!$deleted) {
164                 common_log(LOG_ERR, sprintf('Could not unlink existing file: "%s"', self::path($this->filename)));
165             }
166         }
167
168         return parent::delete($useWhere);
169     }
170
171     public function getFile()
172     {
173         $file = new File();
174         $file->id = $this->file_id;
175         if (!$file->find(true)) {
176             throw new NoResultException($file);
177         }
178         return $file;
179     }
180 }