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
25 class File extends Managed_DataObject
27 public $__table = 'file'; // table name
28 public $id; // int(4) primary_key not_null
29 public $url; // varchar(255) unique_key
30 public $mimetype; // varchar(50)
31 public $size; // int(4)
32 public $title; // varchar(255)
33 public $date; // int(4)
34 public $protected; // int(4)
35 public $filename; // varchar(255)
36 public $width; // int(4)
37 public $height; // int(4)
38 public $modified; // timestamp() not_null default_CURRENT_TIMESTAMP
40 public static function schemaDef()
44 'id' => array('type' => 'serial', 'not null' => true),
45 'url' => array('type' => 'varchar', 'length' => 255, 'description' => 'destination URL after following redirections'),
46 'mimetype' => array('type' => 'varchar', 'length' => 50, 'description' => 'mime type of resource'),
47 'size' => array('type' => 'int', 'description' => 'size of resource when available'),
48 'title' => array('type' => 'varchar', 'length' => 255, 'description' => 'title of resource when available'),
49 'date' => array('type' => 'int', 'description' => 'date of resource according to http query'),
50 'protected' => array('type' => 'int', 'description' => 'true when URL is private (needs login)'),
51 'filename' => array('type' => 'varchar', 'length' => 255, 'description' => 'if a local file, name of the file'),
52 'width' => array('type' => 'int', 'description' => 'width in pixels, if it can be described as such and data is available'),
53 'height' => array('type' => 'int', 'description' => 'height in pixels, if it can be described as such and data is available'),
55 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
57 'primary key' => array('id'),
58 'unique keys' => array(
59 'file_url_key' => array('url'),
64 function isProtected($url) {
65 return 'http://www.facebook.com/login.php' === $url;
69 * Save a new file record.
71 * @param array $redir_data lookup data eg from File_redirection::where()
72 * @param string $given_url
75 public static function saveNew(array $redir_data, $given_url) {
77 // I don't know why we have to keep doing this but I'm adding this last check to avoid
80 $file = File::getKV('url', $given_url);
82 if (!$file instanceof File) {
84 $file->url = $given_url;
85 if (!empty($redir_data['protected'])) $file->protected = $redir_data['protected'];
86 if (!empty($redir_data['title'])) $file->title = $redir_data['title'];
87 if (!empty($redir_data['type'])) $file->mimetype = $redir_data['type'];
88 if (!empty($redir_data['size'])) $file->size = intval($redir_data['size']);
89 if (isset($redir_data['time']) && $redir_data['time'] > 0) $file->date = intval($redir_data['time']);
90 $file_id = $file->insert();
93 Event::handle('EndFileSaveNew', array($file, $redir_data, $given_url));
94 assert ($file instanceof File);
99 * Go look at a URL and possibly save data about it if it's new:
100 * - follow redirect chains and store them in file_redirection
101 * - if a thumbnail is available, save it in file_thumbnail
102 * - save file record with basic info
103 * - optionally save a file_to_post record
104 * - return the File object with the full reference
106 * @fixme refactor this mess, it's gotten pretty scary.
107 * @param string $given_url the URL we're looking at
108 * @param int $notice_id (optional)
109 * @param bool $followRedirects defaults to true
111 * @return mixed File on success, -1 on some errors
113 * @throws ServerException on failure
115 public static function processNew($given_url, $notice_id=null, $followRedirects=true) {
116 if (empty($given_url)) {
117 throw new ServerException('No given URL to process');
120 $given_url = File_redirection::_canonUrl($given_url);
121 if (empty($given_url)) {
122 throw new ServerException('No canonical URL from given URL to process');
125 $file = File::getKV('url', $given_url);
126 if (!$file instanceof File) {
127 // First check if we have a lookup trace for this URL already
128 $file_redir = File_redirection::getKV('url', $given_url);
129 if ($file_redir instanceof File_redirection) {
130 $file = File::getKV('id', $file_redir->file_id);
131 if (!$file instanceof File) {
132 // File did not exist, let's clean up the File_redirection entry
133 $file_redir->delete();
137 // If we still don't have a File object, let's create one now!
138 if (!$file instanceof File) {
139 // @fixme for new URLs this also looks up non-redirect data
140 // such as target content type, size, etc, which we need
141 // for File::saveNew(); so we call it even if not following
143 $redir_data = File_redirection::where($given_url);
144 if (is_array($redir_data)) {
145 $redir_url = $redir_data['url'];
146 } elseif (is_string($redir_data)) {
147 $redir_url = $redir_data;
148 $redir_data = array();
150 // TRANS: Server exception thrown when a URL cannot be processed.
151 throw new ServerException(sprintf(_("Cannot process URL '%s'"), $given_url));
154 // TODO: max field length
155 if ($redir_url === $given_url || strlen($redir_url) > 255 || !$followRedirects) {
156 // Save the File object based on our lookup trace
157 $file = File::saveNew($redir_data, $given_url);
159 // This seems kind of messed up... for now skipping this part
160 // if we're already under a redirect, so we don't go into
161 // horrible infinite loops if we've been given an unstable
162 // redirect (where the final destination of the first request
163 // doesn't match what we get when we ask for it again).
165 // Seen in the wild with clojure.org, which redirects through
166 // wikispaces for auth and appends session data in the URL params.
167 $file = self::processNew($redir_url, $notice_id, /*followRedirects*/false);
168 File_redirection::saveNew($redir_data, $file->id, $given_url);
172 if (!$file instanceof File) {
173 // This should only happen if File::saveNew somehow did not return a File object,
174 // though we have an assert for that in case the event there might've gone wrong.
175 // If anything else goes wrong, there should've been an exception thrown.
176 throw new ServerException('URL processing failed without new File object');
180 if (!empty($notice_id)) {
181 File_to_post::processNew($file->id, $notice_id);
186 public static function respectsQuota(Profile $scoped, $fileSize) {
187 if ($fileSize > common_config('attachments', 'file_quota')) {
188 // TRANS: Message used to be inserted as %2$s in the text "No file may
189 // TRANS: be larger than %1$d byte and the file you sent was %2$s.".
190 // TRANS: %1$d is the number of bytes of an uploaded file.
191 $fileSizeText = sprintf(_m('%1$d byte','%1$d bytes',$fileSize),$fileSize);
193 $fileQuota = common_config('attachments', 'file_quota');
194 // TRANS: Message given if an upload is larger than the configured maximum.
195 // TRANS: %1$d (used for plural) is the byte limit for uploads,
196 // TRANS: %2$s is the proper form of "n bytes". This is the only ways to have
197 // TRANS: gettext support multiple plurals in the same message, unfortunately...
198 throw new ClientException(
199 sprintf(_m('No file may be larger than %1$d byte and the file you sent was %2$s. Try to upload a smaller version.',
200 'No file may be larger than %1$d bytes and the file you sent was %2$s. Try to upload a smaller version.',
202 $fileQuota, $fileSizeText));
207 $query = "select sum(size) as total from file join file_to_post on file_to_post.file_id = file.id join notice on file_to_post.post_id = notice.id where profile_id = {$scoped->id} and file.url like '%/notice/%/file'";
208 $file->query($query);
210 $total = $file->total + $fileSize;
211 if ($total > common_config('attachments', 'user_quota')) {
212 // TRANS: Message given if an upload would exceed user quota.
213 // TRANS: %d (number) is the user quota in bytes and is used for plural.
214 throw new ClientException(
215 sprintf(_m('A file this large would exceed your user quota of %d byte.',
216 'A file this large would exceed your user quota of %d bytes.',
217 common_config('attachments', 'user_quota')),
218 common_config('attachments', 'user_quota')));
220 $query .= ' AND EXTRACT(month FROM file.modified) = EXTRACT(month FROM now()) and EXTRACT(year FROM file.modified) = EXTRACT(year FROM now())';
221 $file->query($query);
223 $total = $file->total + $fileSize;
224 if ($total > common_config('attachments', 'monthly_quota')) {
225 // TRANS: Message given id an upload would exceed a user's monthly quota.
226 // TRANS: $d (number) is the monthly user quota in bytes and is used for plural.
227 throw new ClientException(
228 sprintf(_m('A file this large would exceed your monthly quota of %d byte.',
229 'A file this large would exceed your monthly quota of %d bytes.',
230 common_config('attachments', 'monthly_quota')),
231 common_config('attachments', 'monthly_quota')));
236 // where should the file go?
238 static function filename(Profile $profile, $origname, $mimetype)
241 $ext = common_supported_mime_to_ext($mimetype);
242 } catch (Exception $e) {
243 // We don't support this mimetype, but let's guess the extension
244 $ext = substr(strrchr($mimetype, '/'), 1);
247 // Normalize and make the original filename more URL friendly.
248 $origname = basename($origname, ".$ext");
249 if (class_exists('Normalizer')) {
250 // http://php.net/manual/en/class.normalizer.php
251 // http://www.unicode.org/reports/tr15/
252 $origname = Normalizer::normalize($origname, Normalizer::FORM_KC);
254 $origname = preg_replace('/[^A-Za-z0-9\.\_]/', '_', $origname);
256 $nickname = $profile->getNickname();
257 $datestamp = strftime('%Y%m%d', time());
259 // generate new random strings until we don't run into a filename collision.
260 $random = strtolower(common_confirmation_code(16));
261 $filename = "$nickname-$datestamp-$origname-$random.$ext";
262 } while (file_exists(self::path($filename)));
267 * Validation for as-saved base filenames
269 static function validFilename($filename)
271 return preg_match('/^[A-Za-z0-9._-]+$/', $filename);
275 * @throws ClientException on invalid filename
277 static function path($filename)
279 if (!self::validFilename($filename)) {
280 // TRANS: Client exception thrown if a file upload does not have a valid name.
281 throw new ClientException(_("Invalid filename."));
283 $dir = common_config('attachments', 'dir');
285 if ($dir[strlen($dir)-1] != '/') {
289 return $dir . $filename;
292 static function url($filename)
294 if (!self::validFilename($filename)) {
295 // TRANS: Client exception thrown if a file upload does not have a valid name.
296 throw new ClientException(_("Invalid filename."));
299 if (common_config('site','private')) {
301 return common_local_url('getfile',
302 array('filename' => $filename));
306 if (StatusNet::useHTTPS()) {
308 $sslserver = common_config('attachments', 'sslserver');
310 if (empty($sslserver)) {
311 // XXX: this assumes that background dir == site dir + /file/
312 // not true if there's another server
313 if (is_string(common_config('site', 'sslserver')) &&
314 mb_strlen(common_config('site', 'sslserver')) > 0) {
315 $server = common_config('site', 'sslserver');
316 } else if (common_config('site', 'server')) {
317 $server = common_config('site', 'server');
319 $path = common_config('site', 'path') . '/file/';
321 $server = $sslserver;
322 $path = common_config('attachments', 'sslpath');
324 $path = common_config('attachments', 'path');
330 $path = common_config('attachments', 'path');
331 $server = common_config('attachments', 'server');
333 if (empty($server)) {
334 $server = common_config('site', 'server');
337 $ssl = common_config('attachments', 'ssl');
339 $protocol = ($ssl) ? 'https' : 'http';
342 if ($path[strlen($path)-1] != '/') {
346 if ($path[0] != '/') {
350 return $protocol.'://'.$server.$path.$filename;
353 function getEnclosure(){
354 $enclosure = (object) array();
355 foreach (array('title', 'url', 'date', 'modified', 'size', 'mimetype') as $key) {
356 $enclosure->$key = $this->$key;
359 $needMoreMetadataMimetypes = array(null, 'application/xhtml+xml');
361 if (!isset($this->filename) && in_array(common_bare_mime($enclosure->mimetype), $needMoreMetadataMimetypes)) {
362 // This fetches enclosure metadata for non-local links with unset/HTML mimetypes,
363 // which may be enriched through oEmbed or similar (implemented as plugins)
364 Event::handle('FileEnclosureMetadata', array($this, &$enclosure));
366 if (empty($enclosure->mimetype) || in_array(common_bare_mime($enclosure->mimetype), $needMoreMetadataMimetypes)) {
367 // This means we either don't know what it is, so it can't
368 // be shown as an enclosure, or it is an HTML link which
369 // does not link to a resource with further metadata.
370 throw new ServerException('Unknown enclosure mimetype, not enough metadata');
376 * Get the attachment's thumbnail record, if any.
377 * Make sure you supply proper 'int' typed variables (or null).
379 * @param $width int Max width of thumbnail in pixels. (if null, use common_config values)
380 * @param $height int Max height of thumbnail in pixels. (if null, square-crop to $width)
381 * @param $crop bool Crop to the max-values' aspect ratio
383 * @return File_thumbnail
385 public function getThumbnail($width=null, $height=null, $crop=false, $force_still=true)
387 // Get some more information about this file through our ImageFile class
388 $image = ImageFile::fromFileObject($this);
389 if ($image->animated && !common_config('thumbnail', 'animated')) {
390 // null means "always use file as thumbnail"
391 // false means you get choice between frozen frame or original when calling getThumbnail
392 if (is_null(common_config('thumbnail', 'animated')) || !$force_still) {
393 throw new UseFileAsThumbnailException($this->id);
397 if ($width === null) {
398 $width = common_config('thumbnail', 'width');
399 $height = common_config('thumbnail', 'height');
400 $crop = common_config('thumbnail', 'crop');
403 if ($height === null || $height < 1) {
408 // Debug log (convert crop to int to have TRUE being displayed as 1 and FALSE as 0)
409 common_debug('[' . __METHOD__ . ':' . __LINE__ . ']: width=' . $width . ',height=' . $height . ',crop=' . intval($crop));
411 // Get proper aspect ratio width and height before lookup
412 // We have to do it through an ImageFile object because of orientation etc.
413 // Only other solution would've been to rotate + rewrite uploaded files.
414 list($width, $height, $x, $y, $w, $h) =
415 $image->scaleToFit($width, $height, $crop);
417 $params = array('file_id'=> $this->id,
419 'height' => $height);
420 $thumb = File_thumbnail::pkeyGet($params);
421 if ($thumb instanceof File_thumbnail) {
425 // throws exception on failure to generate thumbnail
426 $outname = "thumb-{$width}x{$height}-" . $image->filename;
427 $outpath = self::path($outname);
429 // The boundary box for our resizing
430 $box = array('width'=>$width, 'height'=>$height,
434 // Doublecheck that parameters are sane and integers.
435 if ($box['width'] < 1 || $box['width'] > common_config('thumbnail', 'maxsize')
436 || $box['height'] < 1 || $box['height'] > common_config('thumbnail', 'maxsize')
437 || $box['w'] < 1 || $box['x'] >= $image->width
438 || $box['h'] < 1 || $box['y'] >= $image->height) {
439 // Fail on bad width parameter. If this occurs, it's due to algorithm in ImageFile->scaleToFit
440 common_debug("Boundary box parameters for resize of {$image->filepath} : ".var_export($box,true));
441 throw new ServerException('Bad thumbnail size parameters. maxsize=' .
442 common_config('thumbnail', 'maxsize') .
443 ',box[width]=' . $box['width'] .
444 ',box[height]=' . $box['height'] .
445 ',box[w]=' . $box['w'] .
446 ',box[h]=' . $box['h'] .
447 ',box[x]=' . $box['x'] .
448 ',box[y]=' . $box['y'] .
449 ',this->width=' . $this->width .
450 ',this->heigh=' . $this->height .
451 ',this->filepath=' . $this->filepath .
452 ',this->filename=' . $this->filename
456 common_debug(sprintf('Generating a thumbnail of File id==%u of size %ux%u', $this->id, $width, $height));
457 // Perform resize and store into file
458 $image->resizeTo($outpath, $box);
460 // Avoid deleting the original
461 if ($image->getPath() != self::path($image->filename)) {
464 return File_thumbnail::saveThumbnail($this->id,
470 public function getPath()
472 return self::path($this->filename);
475 public function getUrl()
477 if (!empty($this->filename)) {
478 // A locally stored file, so let's generate a URL for our instance.
479 $url = self::url($this->filename);
480 if ($url != $this->url) {
481 // For indexing purposes, in case we do a lookup on the 'url' field.
482 // also we're fixing possible changes from http to https, or paths
483 $this->updateUrl($url);
488 // No local filename available, return the URL we have stored
492 public function updateUrl($url)
494 $file = File::getKV('url', $url);
495 if ($file instanceof File) {
496 throw new ServerException('URL already exists in DB');
498 $sql = 'UPDATE %1$s SET url=%2$s WHERE url=%3$s;';
499 $result = $this->query(sprintf($sql, $this->__table,
500 $this->_quote((string)$url),
501 $this->_quote((string)$this->url)));
502 if ($result === false) {
503 common_log_db_error($this, 'UPDATE', __FILE__);
504 throw new ServerException("Could not UPDATE {$this->__table}.url");
511 * Blow the cache of notices that link to this URL
513 * @param boolean $last Whether to blow the "last" cache too
518 function blowCache($last=false)
520 self::blow('file:notice-ids:%s', $this->url);
522 self::blow('file:notice-ids:%s;last', $this->url);
524 self::blow('file:notice-count:%d', $this->id);
528 * Stream of notices linking to this URL
530 * @param integer $offset Offset to show; default is 0
531 * @param integer $limit Limit of notices to show
532 * @param integer $since_id Since this notice
533 * @param integer $max_id Before this notice
535 * @return array ids of notices that link to this file
538 function stream($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
540 $stream = new FileNoticeStream($this);
541 return $stream->getNotices($offset, $limit, $since_id, $max_id);
544 function noticeCount()
546 $cacheKey = sprintf('file:notice-count:%d', $this->id);
548 $count = self::cacheGet($cacheKey);
550 if ($count === false) {
552 $f2p = new File_to_post();
554 $f2p->file_id = $this->id;
556 $count = $f2p->count();
558 self::cacheSet($cacheKey, $count);
564 public function isLocal()
566 return !empty($this->filename);
569 public function delete($useWhere=false)
571 // Delete the file, if it exists locally
572 if (!empty($this->filename) && file_exists(self::path($this->filename))) {
573 $deleted = @unlink(self::path($this->filename));
575 common_log(LOG_ERR, sprintf('Could not unlink existing file: "%s"', self::path($this->filename)));
579 // Clear out related things in the database and filesystem, such as thumbnails
580 if (Event::handle('FileDeleteRelated', array($this))) {
581 $thumbs = new File_thumbnail();
582 $thumbs->file_id = $this->id;
583 if ($thumbs->find()) {
584 while ($thumbs->fetch()) {
590 // And finally remove the entry from the database
591 return parent::delete($useWhere);
594 public function getTitle()
596 $title = $this->title ?: $this->filename;
598 return $title ?: null;