X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;ds=sidebyside;f=classes%2FFile_thumbnail.php;h=68cb2a737fb2a939e34beebbcfb14e394de78ca2;hb=b9a07330621b8c09339e33779798af46c517b7cd;hp=064b454e2dd2a314d390d01b30883b858b6ee72c;hpb=01c2c31c1e701f6946282dfcc23502464483d12d;p=quix0rs-gnu-social.git diff --git a/classes/File_thumbnail.php b/classes/File_thumbnail.php index 064b454e2d..68cb2a737f 100644 --- a/classes/File_thumbnail.php +++ b/classes/File_thumbnail.php @@ -17,9 +17,7 @@ * along with this program. If not, see . */ -if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); } - -require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; +if (!defined('GNUSOCIAL')) { exit(1); } /** * Table Definition for file_thumbnail @@ -27,39 +25,37 @@ require_once INSTALLDIR.'/classes/Memcached_DataObject.php'; 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 $file_id; // int(4) primary_key not_null - public $url; // varchar(255) unique_key - public $width; // int(4) - public $height; // int(4) + public $urlhash; // varchar(64) indexed + 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 Memcached_DataObject::staticGet('File_thumbnail',$k,$v); } - - /* the code above is auto generated do not remove the tag below */ - ###END_AUTOCODE + const URLHASH_ALG = 'sha256'; 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' => 'varchar', 'length' => 255, 'description' => 'URL of thumbnail'), + 'urlhash' => array('type' => 'varchar', 'length' => 64, 'description' => 'sha256 of url field if non-empty'), + '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'), + 'primary key' => array('file_id', 'width', 'height'), + 'indexes' => array( + 'file_thumbnail_file_id_idx' => array('file_id'), + 'file_thumbnail_urlhash_idx' => array('urlhash'), + ), 'foreign keys' => array( 'file_thumbnail_file_id_fkey' => array('file', array('file_id' => 'id')), - ), - 'unique keys' => array( - 'file_thumbnail_url_key' => array('url'), - ), + ) ); } @@ -87,21 +83,224 @@ class File_thumbnail extends Managed_DataObject } } + /** + * Fetch an entry by using a File's id + * + * @param File $file The File object we're getting a thumbnail for. + * @param boolean $notNullUrl Originally remote thumbnails have a URL stored, we use this to find the "original" + * + * @return File_thumbnail + * @throws NoResultException if no File_thumbnail matched the criteria + */ + static function byFile(File $file, $notNullUrl=true) { + $thumb = new File_thumbnail(); + $thumb->file_id = $file->getID(); + if ($notNullUrl) { + $thumb->whereAdd('url IS NOT NULL'); + } + $thumb->orderBy('modified ASC'); // the first created, a somewhat ugly hack + $thumb->limit(1); + if (!$thumb->find(true)) { + throw new NoResultException($thumb); + } + return $thumb; + } + /** * 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) + static function saveThumbnail($file_id, $url, $width, $height, $filename=null) { $tn = new File_thumbnail; $tn->file_id = $file_id; $tn->url = $url; + $tn->filename = $filename; $tn->width = intval($width); $tn->height = intval($height); $tn->insert(); + return $tn; + } + + static function path($filename) + { + File::tryFilename($filename); + + // NOTE: If this is left empty in default config, it will be set to File::path('thumb') + $dir = common_config('thumbnail', 'dir'); + + if (!in_array($dir[mb_strlen($dir)-1], ['/', '\\'])) { + $dir .= DIRECTORY_SEPARATOR; + } + + return $dir . $filename; + } + + static function url($filename) + { + File::tryFilename($filename); + + // FIXME: private site thumbnails? + + $path = common_config('thumbnail', 'path'); + if (empty($path)) { + return File::url('thumb')."/{$filename}"; + } + + $protocol = (GNUsocial::useHTTPS() ? 'https' : 'http'); + $server = common_config('thumbnail', 'server') ?: common_config('site', 'server'); + + if ($path[mb_strlen($path)-1] != '/') { + $path .= '/'; + } + if ($path[0] != '/') { + $path = '/'.$path; + } + + return $protocol.'://'.$server.$path.$filename; + } + + public function getFilename() + { + return File::tryFilename($this->filename); + } + + /** + * + * @return string full filesystem path to the locally stored thumbnail file + * @throws + */ + public function getPath() + { + $oldpath = File::path($this->getFilename()); + $thumbpath = self::path($this->getFilename()); + + // If we have a file in our old thumbnail storage path, move (or copy) it to the new one + // (if the if/elseif don't match, we have a $thumbpath just as we should and can return it) + if (file_exists($oldpath) && !file_exists($thumbpath)) { + try { + // let's get the filename of the File, to check below if it happens to be identical + $file_filename = $this->getFile()->getFilename(); + } catch (NoResultException $e) { + // reasonably the function calling us will handle the following as "File_thumbnail entry should be deleted" + throw new FileNotFoundException($thumbpath); + } catch (InvalidFilenameException $e) { + // invalid filename in getFile()->getFilename(), just + // means the File object isn't stored locally and that + // means it's safe to move it below. + $file_filename = null; + } + + if ($this->getFilename() === $file_filename) { + // special case where thumbnail file exactly matches stored File filename + common_debug('File filename and File_thumbnail filename match on '.$this->file_id.', copying instead'); + copy($oldpath, $thumbpath); + } elseif (!rename($oldpath, $thumbpath)) { + common_log(LOG_ERR, 'Could not move thumbnail from '._ve($oldpath).' to '._ve($thumbpath)); + throw new ServerException('Could not move thumbnail from old path to new path.'); + } else { + common_log(LOG_DEBUG, 'Moved thumbnail '.$this->file_id.' from '._ve($oldpath).' to '._ve($thumbpath)); + } + } elseif (!file_exists($thumbpath)) { + throw new FileNotFoundException($thumbpath); + } + + return $thumbpath; + } + + public function getUrl() + { + if (!empty($this->filename) || $this->getFile()->isLocal()) { + // A locally stored File, so we can dynamically generate a URL. + $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) + { + try { + $thumbpath = self::path($this->getFilename()); + // if file does not exist, try to delete it + $deleted = !file_exists($thumbpath) || @unlink($thumbpath); + if (!$deleted) { + common_log(LOG_ERR, 'Could not unlink existing thumbnail file: '._ve($thumbpath)); + } + } catch (InvalidFilenameException $e) { + common_log(LOG_ERR, 'Deleting object but not attempting deleting file: '._ve($e->getMessage())); + } + + return parent::delete($useWhere); + } + + public function getFile() + { + return File::getByID($this->file_id); + } + + public function getFileId() + { + return $this->file_id; + } + + static public function hashurl($url) + { + if (!mb_strlen($url)) { + throw new Exception('No URL provided to hash algorithm.'); + } + return hash(self::URLHASH_ALG, $url); + } + + public function onInsert() + { + $this->setUrlhash(); + } + + public function onUpdate($dataObject=false) + { + // if we have nothing to compare with OR it has changed from previous entry + if (!$dataObject instanceof Managed_DataObject || $this->url !== $dataObject->url) { + $this->setUrlhash(); + } + } + + public function setUrlhash() + { + $this->urlhash = mb_strlen($this->url)>0 ? self::hashurl($this->url) : null; } }