123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356 |
- <?php
- defined('GNUSOCIAL') || die();
- class File_thumbnail extends Managed_DataObject
- {
- public $__table = 'file_thumbnail';
- public $file_id;
- public $urlhash;
- public $url;
- public $filename;
- public $width;
- public $height;
- public $modified;
- 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'),
- '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', 'not null' => true, 'description' => 'width of thumbnail'),
- 'height' => array('type' => 'int', 'not null' => true, '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_urlhash_idx' => array('urlhash'),
- ),
- 'foreign keys' => array(
- 'file_thumbnail_file_id_fkey' => array('file', array('file_id' => 'id')),
- )
- );
- }
-
- public static function fromFileObject(
- File $file,
- ?int $width = null,
- ?int $height = null,
- bool $crop = false,
- bool $force_still = true,
- ?bool $upscale = null
- ): File_thumbnail {
-
- $was_stored_remotely = $file->isStoredRemotely();
-
- $media = common_get_mime_media($file->mimetype);
- Event::handle('CreateFileImageThumbnailSource', [$file, &$imgPath, $media]);
-
- if ($was_stored_remotely) {
- $file = File::getById($file->getID());
- }
- if (file_exists($imgPath)) {
- $image = new ImageFile($file->getID(), $imgPath, null, $file->getUrl(false));
- } else {
- try {
- $image = ImageFile::fromFileObject($file);
- } catch (InvalidFilenameException $e) {
-
- $existing_thumb = File_thumbnail::byFile($file);
- $image = new ImageFile($file->getID(), $existing_thumb->getPath(), null, $existing_thumb->url);
- }
- }
- if ($image->animated && !common_config('thumbnail', 'animated')) {
-
-
- if (is_null(common_config('thumbnail', 'animated')) || !$force_still) {
- try {
-
- return File_thumbnail::byFile($file);
- } catch (NoResultException $e) {
-
- throw new UseFileAsThumbnailException($file);
- }
- }
- }
- return $image->getFileThumbnail(
- $width,
- $height,
- $crop,
- !is_null($upscale) ? $upscale : common_config('thumbnail', 'upscale')
- );
- }
-
- public static function saveNew($data, $file_id)
- {
- if (!empty($data->thumbnail_url)) {
-
-
- self::saveThumbnail(
- $file_id,
- $data->thumbnail_url,
- $data->thumbnail_width,
- $data->thumbnail_height
- );
- } elseif ($data->type == 'photo') {
-
-
- self::saveThumbnail(
- $file_id,
- $data->url,
- $data->width,
- $data->height
- );
- }
- }
-
- public 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');
- $thumb->limit(1);
- if (!$thumb->find(true)) {
- throw new NoResultException($thumb);
- }
- return $thumb;
- }
-
- public 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 = (int)$width;
- $tn->height = (int)$height;
- $tn->insert();
- return $tn;
- }
- public static function path($filename): string
- {
- File::tryFilename($filename);
-
- $dir = common_config('thumbnail', 'dir');
- if (!in_array($dir[mb_strlen($dir)-1], ['/', '\\'])) {
- $dir .= DIRECTORY_SEPARATOR;
- }
- return $dir . $filename;
- }
- public function getFilename()
- {
- return File::tryFilename($this->filename);
- }
-
- public function getPath(): string
- {
- $oldpath = File::path($this->getFilename());
- $thumbpath = self::path($this->getFilename());
-
-
- if (file_exists($oldpath) && !file_exists($thumbpath)) {
- try {
-
- $file_filename = $this->getFile()->getFilename();
- } catch (NoResultException $e) {
-
- throw new FileNotFoundException($thumbpath);
- } catch (InvalidFilenameException $e) {
-
-
-
- $file_filename = null;
- }
- if ($this->getFilename() === $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()
- {
- $url = common_local_url('attachment_thumbnail', ['attachment' => $this->getFile()->getID()]);
- if (strpos($url, '?') === false) {
- $url .= '?';
- }
- return $url . http_build_query(['w'=>$this->width, 'h'=>$this->height]);
- }
- public function getHeight()
- {
- return $this->height;
- }
- public function getWidth()
- {
- return $this->width;
- }
-
- 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());
-
- $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(): File
- {
- return File::getByID($this->file_id);
- }
- public function getFileId()
- {
- return $this->file_id;
- }
- public static 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 (!$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;
- }
- }
|