* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
-
-require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
-require_once INSTALLDIR.'/classes/File_redirection.php';
-require_once INSTALLDIR.'/classes/File_oembed.php';
-require_once INSTALLDIR.'/classes/File_thumbnail.php';
-require_once INSTALLDIR.'/classes/File_to_post.php';
-//require_once INSTALLDIR.'/classes/File_redirection.php';
+if (!defined('GNUSOCIAL')) { exit(1); }
/**
* Table Definition for file
*/
-class File extends Memcached_DataObject
+class File extends Managed_DataObject
{
- ###START_AUTOCODE
- /* the code below is auto generated do not remove the above tag */
-
public $__table = 'file'; // table name
public $id; // int(4) primary_key not_null
public $url; // varchar(255) unique_key
public $filename; // varchar(255)
public $modified; // timestamp() not_null default_CURRENT_TIMESTAMP
- /* Static get */
- function staticGet($k,$v=NULL) { return Memcached_DataObject::staticGet('File',$k,$v); }
-
- /* the code above is auto generated do not remove the tag below */
- ###END_AUTOCODE
+ public static function schemaDef()
+ {
+ return array(
+ 'fields' => array(
+ 'id' => array('type' => 'serial', 'not null' => true),
+ 'url' => array('type' => 'varchar', 'length' => 255, 'description' => 'destination URL after following redirections'),
+ 'mimetype' => array('type' => 'varchar', 'length' => 50, 'description' => 'mime type of resource'),
+ 'size' => array('type' => 'int', 'description' => 'size of resource when available'),
+ 'title' => array('type' => 'varchar', 'length' => 255, 'description' => 'title of resource when available'),
+ 'date' => array('type' => 'int', 'description' => 'date of resource according to http query'),
+ 'protected' => array('type' => 'int', 'description' => 'true when URL is private (needs login)'),
+ 'filename' => array('type' => 'varchar', 'length' => 255, 'description' => 'if a local file, name of the file'),
+ 'width' => array('type' => 'int', 'description' => 'width in pixels, if it can be described as such and data is available'),
+ 'height' => array('type' => 'int', 'description' => 'height in pixels, if it can be described as such and data is available'),
+
+ 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
+ ),
+ 'primary key' => array('id'),
+ 'unique keys' => array(
+ 'file_url_key' => array('url'),
+ ),
+ );
+ }
function isProtected($url) {
return 'http://www.facebook.com/login.php' === $url;
}
- function getAttachments($post_id) {
- $query = "select file.* from file join file_to_post on (file_id = file.id) join notice on (post_id = notice.id) where post_id = " . $this->escape($post_id);
- $this->query($query);
- $att = array();
- while ($this->fetch()) {
- $att[] = clone($this);
- }
- $this->free();
- return $att;
- }
-
/**
* Save a new file record.
*
* @param string $given_url
* @return File
*/
- function saveNew(array $redir_data, $given_url) {
- $x = new File;
- $x->url = $given_url;
- if (!empty($redir_data['protected'])) $x->protected = $redir_data['protected'];
- if (!empty($redir_data['title'])) $x->title = $redir_data['title'];
- if (!empty($redir_data['type'])) $x->mimetype = $redir_data['type'];
- if (!empty($redir_data['size'])) $x->size = intval($redir_data['size']);
- if (isset($redir_data['time']) && $redir_data['time'] > 0) $x->date = intval($redir_data['time']);
- $file_id = $x->insert();
-
- $x->saveOembed($redir_data, $given_url);
- return $x;
- }
-
- /**
- * Save embedding information for this file, if applicable.
- *
- * Normally this won't need to be called manually, as File::saveNew()
- * takes care of it.
- *
- * @param array $redir_data lookup data eg from File_redirection::where()
- * @param string $given_url
- * @return boolean success
- */
- public function saveOembed($redir_data, $given_url)
- {
- if (isset($redir_data['type'])
- && (('text/html' === substr($redir_data['type'], 0, 9) || 'application/xhtml+xml' === substr($redir_data['type'], 0, 21)))
- && ($oembed_data = File_oembed::_getOembed($given_url))) {
-
- $fo = File_oembed::staticGet('file_id', $this->id);
-
- if (empty($fo)) {
- File_oembed::saveNew($oembed_data, $this->id);
- return true;
- } else {
- common_log(LOG_WARNING, "Strangely, a File_oembed object exists for new file $file_id", __FILE__);
- }
+ public static function saveNew(array $redir_data, $given_url) {
+
+ // I don't know why we have to keep doing this but I'm adding this last check to avoid
+ // uniqueness bugs.
+
+ $file = File::getKV('url', $given_url);
+
+ if (!$file instanceof File) {
+ $file = new File;
+ $file->url = $given_url;
+ if (!empty($redir_data['protected'])) $file->protected = $redir_data['protected'];
+ if (!empty($redir_data['title'])) $file->title = $redir_data['title'];
+ if (!empty($redir_data['type'])) $file->mimetype = $redir_data['type'];
+ if (!empty($redir_data['size'])) $file->size = intval($redir_data['size']);
+ if (isset($redir_data['time']) && $redir_data['time'] > 0) $file->date = intval($redir_data['time']);
+ $file_id = $file->insert();
}
- return false;
+
+ Event::handle('EndFileSaveNew', array($file, $redir_data, $given_url));
+ return $file;
}
/**
* Go look at a URL and possibly save data about it if it's new:
* - follow redirect chains and store them in file_redirection
- * - look up oEmbed data and save it in file_oembed
* - if a thumbnail is available, save it in file_thumbnail
* - save file record with basic info
* - optionally save a file_to_post record
if (empty($given_url)) return -1; // error, no url to process
$given_url = File_redirection::_canonUrl($given_url);
if (empty($given_url)) return -1; // error, no url to process
- $file = File::staticGet('url', $given_url);
+ $file = File::getKV('url', $given_url);
if (empty($file)) {
- $file_redir = File_redirection::staticGet('url', $given_url);
+ $file_redir = File_redirection::getKV('url', $given_url);
if (empty($file_redir)) {
// @fixme for new URLs this also looks up non-redirect data
// such as target content type, size, etc, which we need
}
if (empty($x)) {
- $x = File::staticGet($file_id);
+ $x = File::getKV('id', $file_id);
if (empty($x)) {
// @todo FIXME: This could possibly be a clearer message :)
// TRANS: Server exception thrown when... Robin thinks something is impossible!
return $x;
}
- function isRespectsQuota($user,$fileSize) {
-
+ public static function respectsQuota(Profile $scoped, $fileSize) {
if ($fileSize > common_config('attachments', 'file_quota')) {
+ // TRANS: Message used to be inserted as %2$s in the text "No file may
+ // TRANS: be larger than %1$d byte and the file you sent was %2$s.".
+ // TRANS: %1$d is the number of bytes of an uploaded file.
+ $fileSizeText = sprintf(_m('%1$d byte','%1$d bytes',$fileSize),$fileSize);
+
+ $fileQuota = common_config('attachments', 'file_quota');
// TRANS: Message given if an upload is larger than the configured maximum.
- // TRANS: %1$d is the byte limit for uploads, %2$d is the byte count for the uploaded file.
- // TRANS: %1$s is used for plural.
- return sprintf(_m('No file may be larger than %1$d byte and the file you sent was %2$d bytes. Try to upload a smaller version.',
- 'No file may be larger than %1$d bytes and the file you sent was %2$d bytes. Try to upload a smaller version.',
- common_config('attachments', 'file_quota')),
- common_config('attachments', 'file_quota'), $fileSize);
+ // TRANS: %1$d (used for plural) is the byte limit for uploads,
+ // TRANS: %2$s is the proper form of "n bytes". This is the only ways to have
+ // TRANS: gettext support multiple plurals in the same message, unfortunately...
+ throw new ClientException(
+ 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.',
+ 'No file may be larger than %1$d bytes and the file you sent was %2$s. Try to upload a smaller version.',
+ $fileQuota),
+ $fileQuota, $fileSizeText));
}
- $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 = {$user->id} and file.url like '%/notice/%/file'";
- $this->query($query);
- $this->fetch();
- $total = $this->total + $fileSize;
+ $file = new File;
+
+ $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'";
+ $file->query($query);
+ $file->fetch();
+ $total = $file->total + $fileSize;
if ($total > common_config('attachments', 'user_quota')) {
// TRANS: Message given if an upload would exceed user quota.
// TRANS: %d (number) is the user quota in bytes and is used for plural.
- return sprintf(_m('A file this large would exceed your user quota of %d byte.',
+ throw new ClientException(
+ sprintf(_m('A file this large would exceed your user quota of %d byte.',
'A file this large would exceed your user quota of %d bytes.',
common_config('attachments', 'user_quota')),
- common_config('attachments', 'user_quota'));
+ common_config('attachments', 'user_quota')));
}
$query .= ' AND EXTRACT(month FROM file.modified) = EXTRACT(month FROM now()) and EXTRACT(year FROM file.modified) = EXTRACT(year FROM now())';
- $this->query($query);
- $this->fetch();
- $total = $this->total + $fileSize;
+ $file->query($query);
+ $file->fetch();
+ $total = $file->total + $fileSize;
if ($total > common_config('attachments', 'monthly_quota')) {
// TRANS: Message given id an upload would exceed a user's monthly quota.
// TRANS: $d (number) is the monthly user quota in bytes and is used for plural.
- return sprintf(_m('A file this large would exceed your monthly quota of %d byte.',
+ throw new ClientException(
+ sprintf(_m('A file this large would exceed your monthly quota of %d byte.',
'A file this large would exceed your monthly quota of %d bytes.',
common_config('attachments', 'monthly_quota')),
- common_config('attachments', 'monthly_quota'));
+ common_config('attachments', 'monthly_quota')));
}
return true;
}
// where should the file go?
- static function filename($profile, $basename, $mimetype)
+ static function filename(Profile $profile, $origname, $mimetype)
{
- require_once 'MIME/Type/Extension.php';
-
- // We have to temporarily disable auto handling of PEAR errors...
- PEAR::staticPushErrorHandling(PEAR_ERROR_RETURN);
-
- $mte = new MIME_Type_Extension();
- $ext = $mte->getExtension($mimetype);
- if (PEAR::isError($ext)) {
- $ext = strtolower(preg_replace('/\W/', '', $mimetype));
+ try {
+ $ext = common_supported_mime_to_ext($mimetype);
+ } catch (Exception $e) {
+ // We don't support this mimetype, but let's guess the extension
+ $ext = substr(strrchr($mimetype, '/'), 1);
}
- // Restore error handling.
- PEAR::staticPopErrorHandling();
+ // Normalize and make the original filename more URL friendly.
+ $origname = basename($origname);
+ if (class_exists('Normalizer')) {
+ // http://php.net/manual/en/class.normalizer.php
+ // http://www.unicode.org/reports/tr15/
+ $origname = Normalizer::normalize($origname, Normalizer::FORM_KC);
+ }
+ $origname = preg_replace('/[^A-Za-z0-9\.\_]/', '_', $origname);
$nickname = $profile->nickname;
- $datestamp = strftime('%Y%m%dT%H%M%S', time());
- $random = strtolower(common_confirmation_code(32));
- return "$nickname-$datestamp-$random.$ext";
+ $datestamp = strftime('%Y%m%d', time());
+ do {
+ // generate new random strings until we don't run into a filename collision.
+ $random = strtolower(common_confirmation_code(16));
+ $filename = "$nickname-$datestamp-$origname-$random.$ext";
+ } while (file_exists(self::path($filename)));
+ return $filename;
}
/**
$enclosure->size=$this->size;
$enclosure->mimetype=$this->mimetype;
- if(! isset($this->filename)){
+ if (!isset($this->filename)) {
$notEnclosureMimeTypes = array(null,'text/html','application/xhtml+xml');
$mimetype = $this->mimetype;
if($mimetype != null){
if($semicolon){
$mimetype = substr($mimetype,0,$semicolon);
}
- if(in_array($mimetype,$notEnclosureMimeTypes)){
- // Never treat generic HTML links as an enclosure type!
- // But if we have oEmbed info, we'll consider it golden.
- $oembed = File_oembed::staticGet('file_id',$this->id);
- if($oembed && in_array($oembed->type, array('photo', 'video'))){
- $mimetype = strtolower($oembed->mimetype);
- $semicolon = strpos($mimetype,';');
- if($semicolon){
- $mimetype = substr($mimetype,0,$semicolon);
- }
- // @fixme uncertain if this is right.
- // we want to expose things like YouTube videos as
- // viewable attachments, but don't expose them as
- // downloadable enclosures.....?
- //if (in_array($mimetype, $notEnclosureMimeTypes)) {
- // return false;
- //} else {
- if($oembed->mimetype) $enclosure->mimetype=$oembed->mimetype;
- if($oembed->url) $enclosure->url=$oembed->url;
- if($oembed->title) $enclosure->title=$oembed->title;
- if($oembed->modified) $enclosure->modified=$oembed->modified;
- unset($oembed->size);
- //}
- } else {
- return false;
- }
+ if (in_array($mimetype, $notEnclosureMimeTypes)) {
+ Event::handle('FileEnclosureMetadata', array($this, &$enclosure));
}
}
return $enclosure;
/**
* Get the attachment's thumbnail record, if any.
+ * Make sure you supply proper 'int' typed variables (or null).
+ *
+ * @param $width int Max width of thumbnail in pixels. (if null, use common_config values)
+ * @param $height int Max height of thumbnail in pixels. (if null, square-crop to $width)
+ * @param $crop bool Crop to the max-values' aspect ratio
*
* @return File_thumbnail
*/
- function getThumbnail()
+ public function getThumbnail($width=null, $height=null, $crop=false)
{
- return File_thumbnail::staticGet('file_id', $this->id);
+ if (intval($this->width) < 1 || intval($this->height) < 1) {
+ // Old files may have 0 until migrated with scripts/upgrade.php
+ // For any legitimately unrepresentable ones, we could generate our
+ // own image (like a square with MIME type in text)
+ throw new UnsupportedMediaException('No image geometry available.');
+ }
+
+ if ($width === null) {
+ $width = common_config('thumbnail', 'width');
+ $height = common_config('thumbnail', 'height');
+ $crop = common_config('thumbnail', 'crop');
+ }
+
+ if ($height === null) {
+ $height = $width;
+ $crop = true;
+ }
+
+ // Get proper aspect ratio width and height before lookup
+ list($width, $height, $x, $y, $w2, $h2) =
+ ImageFile::getScalingValues($this->width, $this->height, $width, $height, $crop);
+
+ // Doublecheck that parameters are sane and integers.
+ if ($width < 1 || $width > common_config('thumbnail', 'maxsize')
+ || $height < 1 || $height > common_config('thumbnail', 'maxsize')) {
+ // Fail on bad width parameter. If this occurs, it's due to algorithm in ImageFile::getScalingValues
+ throw new ServerException('Bad thumbnail size parameters.');
+ }
+
+ $params = array('file_id'=> $this->id,
+ 'width' => $width,
+ 'height' => $height);
+ $thumb = File_thumbnail::pkeyGet($params);
+ if ($thumb === null) {
+ // throws exception on failure to generate thumbnail
+ $thumb = $this->generateThumbnail($width, $height, $crop);
+ }
+ return $thumb;
+ }
+
+ /**
+ * Generate and store a thumbnail image for the uploaded file, if applicable.
+ * Call this only if you know what you're doing.
+ *
+ * @param $width int Maximum thumbnail width in pixels
+ * @param $height int Maximum thumbnail height in pixels, if null, crop to $width
+ *
+ * @return File_thumbnail or null
+ */
+ protected function generateThumbnail($width, $height, $crop)
+ {
+ $width = intval($width);
+ if ($height === null) {
+ $height = $width;
+ $crop = true;
+ }
+
+ $image = ImageFile::fromFileObject($this);
+
+ list($width, $height, $x, $y, $w2, $h2) =
+ $image->scaleToFit($width, $height, $crop);
+
+ $outname = "thumb-{$width}x{$height}-" . $this->filename;
+ $outpath = self::path($outname);
+
+ $image->resizeTo($outpath, $width, $height, $x, $y, $w2, $h2);
+
+ // Avoid deleting the original
+ if ($image->getPath() != $this->getPath()) {
+ $image->unlink();
+ }
+ return File_thumbnail::saveThumbnail($this->id,
+ self::url($outname),
+ $width, $height);
+ }
+
+ public function getPath()
+ {
+ return self::path($this->filename);
+ }
+ public function getUrl()
+ {
+ return $this->url;
+ }
+
+ /**
+ * Blow the cache of notices that link to this URL
+ *
+ * @param boolean $last Whether to blow the "last" cache too
+ *
+ * @return void
+ */
+
+ function blowCache($last=false)
+ {
+ self::blow('file:notice-ids:%s', $this->url);
+ if ($last) {
+ self::blow('file:notice-ids:%s;last', $this->url);
+ }
+ self::blow('file:notice-count:%d', $this->id);
+ }
+
+ /**
+ * Stream of notices linking to this URL
+ *
+ * @param integer $offset Offset to show; default is 0
+ * @param integer $limit Limit of notices to show
+ * @param integer $since_id Since this notice
+ * @param integer $max_id Before this notice
+ *
+ * @return array ids of notices that link to this file
+ */
+
+ function stream($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
+ {
+ $stream = new FileNoticeStream($this);
+ return $stream->getNotices($offset, $limit, $since_id, $max_id);
+ }
+
+ function noticeCount()
+ {
+ $cacheKey = sprintf('file:notice-count:%d', $this->id);
+
+ $count = self::cacheGet($cacheKey);
+
+ if ($count === false) {
+
+ $f2p = new File_to_post();
+
+ $f2p->file_id = $this->id;
+
+ $count = $f2p->count();
+
+ self::cacheSet($cacheKey, $count);
+ }
+
+ return $count;
}
}