3 * StatusNet, the distributed open-source microblogging tool
5 * Abstraction for media files in general
7 * TODO: combine with ImageFile?
11 * LICENCE: This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Affero General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU Affero General Public License for more details.
21 * You should have received a copy of the GNU Affero General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
26 * @author Robin Millette <robin@millette.info>
27 * @author Zach Copley <zach@status.net>
28 * @copyright 2008-2009 StatusNet, Inc.
29 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
30 * @link http://status.net/
33 if (!defined('GNUSOCIAL')) { exit(1); }
37 protected $scoped = null;
40 var $fileRecord = null;
42 var $short_fileurl = null;
45 function __construct(Profile $scoped, $filename = null, $mimetype = null)
47 $this->scoped = $scoped;
49 $this->filename = $filename;
50 $this->mimetype = $mimetype;
51 $this->fileRecord = $this->storeFile();
53 $this->fileurl = common_local_url('attachment',
54 array('attachment' => $this->fileRecord->id));
56 $this->maybeAddRedir($this->fileRecord->id, $this->fileurl);
57 $this->short_fileurl = common_shorten_url($this->fileurl);
58 $this->maybeAddRedir($this->fileRecord->id, $this->short_fileurl);
61 public function attachToNotice(Notice $notice)
63 File_to_post::processNew($this->fileRecord->id, $notice->id);
66 public function getPath()
68 return File::path($this->filename);
73 return $this->short_fileurl;
78 $filepath = File::path($this->filename);
82 public function getFile()
84 if (!$this->fileRecord instanceof File) {
85 throw new ServerException('File record did not exist for MediaFile');
88 return $this->fileRecord;
91 protected function storeFile()
93 $fileurl = File::url($this->filename);
97 $file->filename = $this->filename;
98 $file->urlhash = File::hashurl($fileurl);
99 $file->url = $fileurl;
100 $filepath = File::path($this->filename);
101 $file->size = filesize($filepath);
102 $file->date = time();
103 $file->mimetype = $this->mimetype;
105 $file_id = $file->insert();
107 if ($file_id===false) {
108 common_log_db_error($file, "INSERT", __FILE__);
109 // TRANS: Client exception thrown when a database error was thrown during a file upload operation.
110 throw new ClientException(_('There was a database error while saving your file. Please try again.'));
113 // Set file geometrical properties if available
115 $image = ImageFile::fromFileObject($file);
116 $orig = clone($file);
117 $file->width = $image->width;
118 $file->height = $image->height;
119 $file->update($orig);
121 // We have to cleanup after ImageFile, since it
122 // may have generated a temporary file from a
123 // video support plugin or something.
124 // FIXME: Do this more automagically.
125 if ($image->getPath() != $file->getPath()) {
128 } catch (ServerException $e) {
129 // We just couldn't make out an image from the file. This
130 // does not have to be UnsupportedMediaException, as we can
131 // also get ServerException from files not existing etc.
137 function rememberFile($file, $short)
139 $this->maybeAddRedir($file->id, $short);
142 function maybeAddRedir($file_id, $url)
144 $file_redir = File_redirection::getKV('url', $url);
146 if (!$file_redir instanceof File_redirection) {
147 $file_redir = new File_redirection;
148 $file_redir->url = $url;
149 $file_redir->file_id = $file_id;
151 $result = $file_redir->insert();
153 if ($result===false) {
154 common_log_db_error($file_redir, "INSERT", __FILE__);
155 // TRANS: Client exception thrown when a database error was thrown during a file upload operation.
156 throw new ClientException(_('There was a database error while saving your file. Please try again.'));
161 static function fromUpload($param='media', Profile $scoped=null)
163 if (is_null($scoped)) {
164 $scoped = Profile::current();
167 // The existence of the "error" element means PHP has processed it properly even if it was ok.
168 if (!isset($_FILES[$param]) || !isset($_FILES[$param]['error'])) {
169 throw new NoUploadedMediaException($param);
172 switch ($_FILES[$param]['error']) {
173 case UPLOAD_ERR_OK: // success, jump out
175 case UPLOAD_ERR_INI_SIZE:
176 // TRANS: Client exception thrown when an uploaded file is larger than set in php.ini.
177 throw new ClientException(_('The uploaded file exceeds the ' .
178 'upload_max_filesize directive in php.ini.'));
179 case UPLOAD_ERR_FORM_SIZE:
180 throw new ClientException(
181 // TRANS: Client exception.
182 _('The uploaded file exceeds the MAX_FILE_SIZE directive' .
183 ' that was specified in the HTML form.'));
184 case UPLOAD_ERR_PARTIAL:
185 @unlink($_FILES[$param]['tmp_name']);
186 // TRANS: Client exception.
187 throw new ClientException(_('The uploaded file was only' .
188 ' partially uploaded.'));
189 case UPLOAD_ERR_NO_FILE:
190 // No file; probably just a non-AJAX submission.
191 throw new NoUploadedMediaException($param);
192 case UPLOAD_ERR_NO_TMP_DIR:
193 // TRANS: Client exception thrown when a temporary folder is not present to store a file upload.
194 throw new ClientException(_('Missing a temporary folder.'));
195 case UPLOAD_ERR_CANT_WRITE:
196 // TRANS: Client exception thrown when writing to disk is not possible during a file upload operation.
197 throw new ClientException(_('Failed to write file to disk.'));
198 case UPLOAD_ERR_EXTENSION:
199 // TRANS: Client exception thrown when a file upload operation has been stopped by an extension.
200 throw new ClientException(_('File upload stopped by extension.'));
202 common_log(LOG_ERR, __METHOD__ . ": Unknown upload error " .
203 $_FILES[$param]['error']);
204 // TRANS: Client exception thrown when a file upload operation has failed with an unknown reason.
205 throw new ClientException(_('System error uploading file.'));
208 // Throws exception if additional size does not respect quota
209 File::respectsQuota($scoped, $_FILES[$param]['size']);
211 $mimetype = self::getUploadedMimeType($_FILES[$param]['tmp_name'],
212 $_FILES[$param]['name']);
214 $basename = basename($_FILES[$param]['name']);
215 $filename = File::filename($scoped, $basename, $mimetype);
216 $filepath = File::path($filename);
218 $result = move_uploaded_file($_FILES[$param]['tmp_name'], $filepath);
221 // TRANS: Client exception thrown when a file upload operation fails because the file could
222 // TRANS: not be moved from the temporary folder to the permanent file location.
223 throw new ClientException(_('File could not be moved to destination directory.'));
226 return new MediaFile($scoped, $filename, $mimetype);
229 static function fromFilehandle($fh, Profile $scoped) {
231 $stream = stream_get_meta_data($fh);
233 File::respectsQuota($scoped, filesize($stream['uri']));
235 $mimetype = self::getUploadedMimeType($stream['uri']);
237 $filename = File::filename($scoped, "email", $mimetype);
239 $filepath = File::path($filename);
241 $result = copy($stream['uri'], $filepath) && chmod($filepath, 0664);
244 // TRANS: Client exception thrown when a file upload operation fails because the file could
245 // TRANS: not be moved from the temporary folder to the permanent file location.
246 throw new ClientException(_('File could not be moved to destination directory.' .
247 $stream['uri'] . ' ' . $filepath));
250 return new MediaFile($scoped, $filename, $mimetype);
254 * Attempt to identify the content type of a given file.
256 * @param string $filepath filesystem path as string (file must exist)
257 * @param string $originalFilename (optional) for extension-based detection
260 * @fixme this seems to tie a front-end error message in, kinda confusing
262 * @throws ClientException if type is known, but not supported for local uploads
264 static function getUploadedMimeType($filepath, $originalFilename=false) {
265 // We only accept filenames to existing files
266 $mimelookup = new finfo(FILEINFO_MIME_TYPE);
267 $mimetype = $mimelookup->file($filepath);
269 // Unclear types are such that we can't really tell by the auto
270 // detect what they are (.bin, .exe etc. are just "octet-stream")
271 $unclearTypes = array('application/octet-stream',
272 'application/vnd.ms-office',
274 // TODO: for XML we could do better content-based sniffing too
277 $supported = common_config('attachments', 'supported');
279 // If we didn't match, or it is an unclear match
280 if ($originalFilename && (!$mimetype || in_array($mimetype, $unclearTypes))) {
282 $type = common_supported_ext_to_mime($originalFilename);
284 } catch (Exception $e) {
285 // Extension not found, so $mimetype is our best guess
289 // If $config['attachments']['supported'] equals boolean true, accept any mimetype
290 if ($supported === true || array_key_exists($mimetype, $supported)) {
291 // FIXME: Don't know if it always has a mimetype here because
292 // finfo->file CAN return false on error: http://php.net/finfo_file
293 // so if $supported === true, this may return something unexpected.
297 // We can conclude that we have failed to get the MIME type
298 $media = common_get_mime_media($mimetype);
299 if ('application' !== $media) {
300 // TRANS: Client exception thrown trying to upload a forbidden MIME type.
301 // TRANS: %1$s is the file type that was denied, %2$s is the application part of
302 // TRANS: the MIME type that was denied.
303 $hint = sprintf(_('"%1$s" is not a supported file type on this server. ' .
304 'Try using another %2$s format.'), $mimetype, $media);
306 // TRANS: Client exception thrown trying to upload a forbidden MIME type.
307 // TRANS: %s is the file type that was denied.
308 $hint = sprintf(_('"%s" is not a supported file type on this server.'), $mimetype);
310 throw new ClientException($hint);