<?php
/*
- * Laconica - a distributed open-source microblogging tool
- * Copyright (C) 2008, 2009, Control Yourself, Inc.
+ * StatusNet - the distributed open-source microblogging tool
+ * Copyright (C) 2008, 2009, StatusNet, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-if (!defined('LACONICA')) { exit(1); }
-
-require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
+if (!defined('GNUSOCIAL')) { exit(1); }
/**
* Table Definition for file_thumbnail
*/
-class File_thumbnail extends Memcached_DataObject
+class File_thumbnail extends Managed_DataObject
{
- ###START_AUTOCODE
- /* the code below is auto generated do not remove the above tag */
-
public $__table = 'file_thumbnail'; // table name
- public $id; // int(11) not_null primary_key group_by
- public $file_id; // int(11) unique_key group_by
- public $url; // varchar(255) unique_key
- public $width; // int(11) group_by
- public $height; // int(11) group_by
+ public $file_id; // int(4) primary_key not_null
+ public $url; // text
+ public $filename; // text
+ public $width; // int(4) primary_key
+ public $height; // int(4) primary_key
+ public $modified; // timestamp() not_null default_CURRENT_TIMESTAMP
- /* Static get */
- function staticGet($k,$v=NULL) { return DB_DataObject::staticGet('File_thumbnail',$k,$v); }
+ public static function schemaDef()
+ {
+ return array(
+ 'fields' => array(
+ 'file_id' => array('type' => 'int', 'not null' => true, 'description' => 'thumbnail for what URL/file'),
+ 'url' => array('type' => 'text', 'description' => 'URL of thumbnail'),
+ 'filename' => array('type' => 'text', 'description' => 'if stored locally, filename is put here'),
+ 'width' => array('type' => 'int', 'description' => 'width of thumbnail'),
+ 'height' => array('type' => 'int', 'description' => 'height of thumbnail'),
+ 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
+ ),
+ 'primary key' => array('file_id', 'width', 'height'),
+ 'indexes' => array(
+ 'file_thumbnail_file_id_idx' => array('file_id'),
+ ),
+ 'foreign keys' => array(
+ 'file_thumbnail_file_id_fkey' => array('file', array('file_id' => 'id')),
+ )
+ );
+ }
- /* the code above is auto generated do not remove the tag below */
- ###END_AUTOCODE
+ /**
+ * Save oEmbed-provided thumbnail data
+ *
+ * @param object $data
+ * @param int $file_id
+ */
+ public static function saveNew($data, $file_id) {
+ if (!empty($data->thumbnail_url)) {
+ // Non-photo types such as video will usually
+ // show us a thumbnail, though it's not required.
+ self::saveThumbnail($file_id,
+ $data->thumbnail_url,
+ $data->thumbnail_width,
+ $data->thumbnail_height);
+ } else if ($data->type == 'photo') {
+ // The inline photo URL given should also fit within
+ // our requested thumbnail size, per oEmbed spec.
+ self::saveThumbnail($file_id,
+ $data->url,
+ $data->width,
+ $data->height);
+ }
+ }
- function saveNew($data, $file_id) {
+ /**
+ * Fetch an entry by using a File's id
+ */
+ static function byFile(File $file) {
+ $file_thumbnail = self::getKV('file_id', $file->getID());
+ if (!$file_thumbnail instanceof File_thumbnail) {
+ throw new ServerException(sprintf('No File_thumbnail entry for File id==%u', $file->getID()));
+ }
+ return $file_thumbnail;
+ }
+
+ /**
+ * Save a thumbnail record for the referenced file record.
+ *
+ * FIXME: Add error handling
+ *
+ * @param int $file_id
+ * @param string $url
+ * @param int $width
+ * @param int $height
+ */
+ static function saveThumbnail($file_id, $url, $width, $height, $filename=null)
+ {
$tn = new File_thumbnail;
$tn->file_id = $file_id;
- $tn->url = $data['thumbnail_url'];
- $tn->width = intval($data['thumbnail_width']);
- $tn->height = intval($data['thumbnail_height']);
+ $tn->url = $url;
+ $tn->filename = $filename;
+ $tn->width = intval($width);
+ $tn->height = intval($height);
$tn->insert();
+ return $tn;
}
-}
+ static function path($filename)
+ {
+ // TODO: Store thumbnails in their own directory and don't use File::path here
+ return File::path($filename);
+ }
+
+ static function url($filename)
+ {
+ // TODO: Store thumbnails in their own directory and don't use File::url here
+ return File::url($filename);
+ }
+
+ public function getPath()
+ {
+ $filepath = self::path($this->filename);
+ if (!file_exists($filepath)) {
+ throw new FileNotFoundException($filepath);
+ }
+ return $filepath;
+ }
+
+ public function getUrl()
+ {
+ if (!empty($this->filename) || $this->getFile()->isLocal()) {
+ // A locally stored File, so we can dynamically generate a URL.
+ if (!empty($this->url)) {
+ // Let's just clear this field as there is no point in having it for local files.
+ $orig = clone($this);
+ $this->url = '';
+ $this->update($orig);
+ }
+ $url = common_local_url('attachment_thumbnail', array('attachment'=>$this->file_id));
+ if (strpos($url, '?') === false) {
+ $url .= '?';
+ }
+ return $url . http_build_query(array('w'=>$this->width, 'h'=>$this->height));
+ }
+
+ // No local filename available, return the remote URL we have stored
+ return $this->url;
+ }
+
+ public function getHeight()
+ {
+ return $this->height;
+ }
+
+ public function getWidth()
+ {
+ return $this->width;
+ }
+
+ /**
+ * @throws UseFileAsThumbnailException from File_thumbnail->getUrl() for stuff like animated GIFs
+ */
+ public function getHtmlAttrs(array $orig=array(), $overwrite=true)
+ {
+ $attrs = [
+ 'height' => $this->getHeight(),
+ 'width' => $this->getWidth(),
+ 'src' => $this->getUrl(),
+ ];
+ return $overwrite ? array_merge($orig, $attrs) : array_merge($attrs, $orig);
+ }
+
+ public function delete($useWhere=false)
+ {
+ if (!empty($this->filename) && file_exists(File_thumbnail::path($this->filename))) {
+ $deleted = @unlink(self::path($this->filename));
+ if (!$deleted) {
+ common_log(LOG_ERR, sprintf('Could not unlink existing file: "%s"', self::path($this->filename)));
+ }
+ }
+
+ return parent::delete($useWhere);
+ }
+
+ public function getFile()
+ {
+ return File::getByID($this->file_id);
+ }
+}