File_thumbnail.php 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305
  1. <?php
  2. /*
  3. * StatusNet - the distributed open-source microblogging tool
  4. * Copyright (C) 2008, 2009, StatusNet, Inc.
  5. *
  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.
  10. *
  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.
  15. *
  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/>.
  18. */
  19. if (!defined('GNUSOCIAL')) { exit(1); }
  20. /**
  21. * Table Definition for file_thumbnail
  22. */
  23. class File_thumbnail extends Managed_DataObject
  24. {
  25. public $__table = 'file_thumbnail'; // table name
  26. public $file_id; // int(4) primary_key not_null
  27. public $urlhash; // varchar(64) indexed
  28. public $url; // text
  29. public $filename; // text
  30. public $width; // int(4) primary_key
  31. public $height; // int(4) primary_key
  32. public $modified; // datetime() not_null default_CURRENT_TIMESTAMP
  33. const URLHASH_ALG = 'sha256';
  34. public static function schemaDef()
  35. {
  36. return array(
  37. 'fields' => array(
  38. 'file_id' => array('type' => 'int', 'not null' => true, 'description' => 'thumbnail for what URL/file'),
  39. 'urlhash' => array('type' => 'varchar', 'length' => 64, 'description' => 'sha256 of url field if non-empty'),
  40. 'url' => array('type' => 'text', 'description' => 'URL of thumbnail'),
  41. 'filename' => array('type' => 'text', 'description' => 'if stored locally, filename is put here'),
  42. 'width' => array('type' => 'int', 'description' => 'width of thumbnail'),
  43. 'height' => array('type' => 'int', 'description' => 'height of thumbnail'),
  44. 'modified' => array('type' => 'datetime', 'not null' => true, 'default' => 'CURRENT_TIMESTAMP', 'description' => 'date this record was modified'),
  45. ),
  46. 'primary key' => array('file_id', 'width', 'height'),
  47. 'indexes' => array(
  48. 'file_thumbnail_file_id_idx' => array('file_id'),
  49. 'file_thumbnail_urlhash_idx' => array('urlhash'),
  50. ),
  51. 'foreign keys' => array(
  52. 'file_thumbnail_file_id_fkey' => array('file', array('file_id' => 'id')),
  53. )
  54. );
  55. }
  56. /**
  57. * Save oEmbed-provided thumbnail data
  58. *
  59. * @param object $data
  60. * @param int $file_id
  61. */
  62. public static function saveNew($data, $file_id) {
  63. if (!empty($data->thumbnail_url)) {
  64. // Non-photo types such as video will usually
  65. // show us a thumbnail, though it's not required.
  66. self::saveThumbnail($file_id,
  67. $data->thumbnail_url,
  68. $data->thumbnail_width,
  69. $data->thumbnail_height);
  70. } else if ($data->type == 'photo') {
  71. // The inline photo URL given should also fit within
  72. // our requested thumbnail size, per oEmbed spec.
  73. self::saveThumbnail($file_id,
  74. $data->url,
  75. $data->width,
  76. $data->height);
  77. }
  78. }
  79. /**
  80. * Fetch an entry by using a File's id
  81. *
  82. * @param File $file The File object we're getting a thumbnail for.
  83. * @param boolean $notNullUrl Originally remote thumbnails have a URL stored, we use this to find the "original"
  84. *
  85. * @return File_thumbnail
  86. * @throws NoResultException if no File_thumbnail matched the criteria
  87. */
  88. static function byFile(File $file, $notNullUrl=true) {
  89. $thumb = new File_thumbnail();
  90. $thumb->file_id = $file->getID();
  91. if ($notNullUrl) {
  92. $thumb->whereAdd('url IS NOT NULL');
  93. }
  94. $thumb->orderBy('modified ASC'); // the first created, a somewhat ugly hack
  95. $thumb->limit(1);
  96. if (!$thumb->find(true)) {
  97. throw new NoResultException($thumb);
  98. }
  99. return $thumb;
  100. }
  101. /**
  102. * Save a thumbnail record for the referenced file record.
  103. *
  104. * FIXME: Add error handling
  105. *
  106. * @param int $file_id
  107. * @param string $url
  108. * @param int $width
  109. * @param int $height
  110. */
  111. static function saveThumbnail($file_id, $url, $width, $height, $filename=null)
  112. {
  113. $tn = new File_thumbnail;
  114. $tn->file_id = $file_id;
  115. $tn->url = $url;
  116. $tn->filename = $filename;
  117. $tn->width = intval($width);
  118. $tn->height = intval($height);
  119. $tn->insert();
  120. return $tn;
  121. }
  122. static function path($filename)
  123. {
  124. File::tryFilename($filename);
  125. // NOTE: If this is left empty in default config, it will be set to File::path('thumb')
  126. $dir = common_config('thumbnail', 'dir');
  127. if (!in_array($dir[mb_strlen($dir)-1], ['/', '\\'])) {
  128. $dir .= DIRECTORY_SEPARATOR;
  129. }
  130. return $dir . $filename;
  131. }
  132. static function url($filename)
  133. {
  134. File::tryFilename($filename);
  135. // FIXME: private site thumbnails?
  136. $path = common_config('thumbnail', 'path');
  137. if (empty($path)) {
  138. return File::url('thumb')."/{$filename}";
  139. }
  140. $protocol = (GNUsocial::useHTTPS() ? 'https' : 'http');
  141. $server = common_config('thumbnail', 'server') ?: common_config('site', 'server');
  142. if ($path[mb_strlen($path)-1] != '/') {
  143. $path .= '/';
  144. }
  145. if ($path[0] != '/') {
  146. $path = '/'.$path;
  147. }
  148. return $protocol.'://'.$server.$path.$filename;
  149. }
  150. public function getFilename()
  151. {
  152. return File::tryFilename($this->filename);
  153. }
  154. /**
  155. * @return string full filesystem path to the locally stored thumbnail file
  156. * @throws FileNotFoundException
  157. * @throws ServerException
  158. */
  159. public function getPath()
  160. {
  161. $oldpath = File::path($this->getFilename());
  162. $thumbpath = self::path($this->getFilename());
  163. // If we have a file in our old thumbnail storage path, move (or copy) it to the new one
  164. // (if the if/elseif don't match, we have a $thumbpath just as we should and can return it)
  165. if (file_exists($oldpath) && !file_exists($thumbpath)) {
  166. try {
  167. // let's get the filename of the File, to check below if it happens to be identical
  168. $file_filename = $this->getFile()->getFilename();
  169. } catch (NoResultException $e) {
  170. // reasonably the function calling us will handle the following as "File_thumbnail entry should be deleted"
  171. throw new FileNotFoundException($thumbpath);
  172. } catch (InvalidFilenameException $e) {
  173. // invalid filename in getFile()->getFilename(), just
  174. // means the File object isn't stored locally and that
  175. // means it's safe to move it below.
  176. $file_filename = null;
  177. }
  178. if ($this->getFilename() === $file_filename) {
  179. // special case where thumbnail file exactly matches stored File filename
  180. common_debug('File filename and File_thumbnail filename match on '.$this->file_id.', copying instead');
  181. copy($oldpath, $thumbpath);
  182. } elseif (!rename($oldpath, $thumbpath)) {
  183. common_log(LOG_ERR, 'Could not move thumbnail from '._ve($oldpath).' to '._ve($thumbpath));
  184. throw new ServerException('Could not move thumbnail from old path to new path.');
  185. } else {
  186. common_log(LOG_DEBUG, 'Moved thumbnail '.$this->file_id.' from '._ve($oldpath).' to '._ve($thumbpath));
  187. }
  188. } elseif (!file_exists($thumbpath)) {
  189. throw new FileNotFoundException($thumbpath);
  190. }
  191. return $thumbpath;
  192. }
  193. public function getUrl()
  194. {
  195. if (!empty($this->filename) || $this->getFile()->isLocal()) {
  196. // A locally stored File, so we can dynamically generate a URL.
  197. $url = common_local_url('attachment_thumbnail', array('attachment'=>$this->file_id));
  198. if (strpos($url, '?') === false) {
  199. $url .= '?';
  200. }
  201. return $url . http_build_query(array('w'=>$this->width, 'h'=>$this->height));
  202. }
  203. // No local filename available, return the remote URL we have stored
  204. return $this->url;
  205. }
  206. public function getHeight()
  207. {
  208. return $this->height;
  209. }
  210. public function getWidth()
  211. {
  212. return $this->width;
  213. }
  214. /**
  215. * @throws UseFileAsThumbnailException from File_thumbnail->getUrl() for stuff like animated GIFs
  216. */
  217. public function getHtmlAttrs(array $orig=array(), $overwrite=true)
  218. {
  219. $attrs = [ 'height' => $this->getHeight(),
  220. 'width' => $this->getWidth(),
  221. 'src' => $this->getUrl() ];
  222. return $overwrite ? array_merge($orig, $attrs) : array_merge($attrs, $orig);
  223. }
  224. public function delete($useWhere=false)
  225. {
  226. try {
  227. $thumbpath = self::path($this->getFilename());
  228. // if file does not exist, try to delete it
  229. $deleted = !file_exists($thumbpath) || @unlink($thumbpath);
  230. if (!$deleted) {
  231. common_log(LOG_ERR, 'Could not unlink existing thumbnail file: '._ve($thumbpath));
  232. }
  233. } catch (InvalidFilenameException $e) {
  234. common_log(LOG_ERR, 'Deleting object but not attempting deleting file: '._ve($e->getMessage()));
  235. }
  236. return parent::delete($useWhere);
  237. }
  238. public function getFile()
  239. {
  240. return File::getByID($this->file_id);
  241. }
  242. public function getFileId()
  243. {
  244. return $this->file_id;
  245. }
  246. static public function hashurl($url)
  247. {
  248. if (!mb_strlen($url)) {
  249. throw new Exception('No URL provided to hash algorithm.');
  250. }
  251. return hash(self::URLHASH_ALG, $url);
  252. }
  253. public function onInsert()
  254. {
  255. $this->setUrlhash();
  256. }
  257. public function onUpdate($dataObject=false)
  258. {
  259. // if we have nothing to compare with OR it has changed from previous entry
  260. if (!$dataObject instanceof Managed_DataObject || $this->url !== $dataObject->url) {
  261. $this->setUrlhash();
  262. }
  263. }
  264. public function setUrlhash()
  265. {
  266. $this->urlhash = mb_strlen($this->url)>0 ? self::hashurl($this->url) : null;
  267. }
  268. }