]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - classes/File.php
Misses this file to merge. I like the comments.
[quix0rs-gnu-social.git] / classes / File.php
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
20 if (!defined('GNUSOCIAL')) { exit(1); }
21
22 /**
23  * Table Definition for file
24  */
25 class File extends Managed_DataObject
26 {
27     public $__table = 'file';                            // table name
28     public $id;                              // int(4)  primary_key not_null
29     public $urlhash;                         // varchar(64)  unique_key
30     public $url;                             // text
31     public $filehash;                        // varchar(64)     indexed
32     public $mimetype;                        // varchar(50)
33     public $size;                            // int(4)
34     public $title;                           // varchar(191)   not 255 because utf8mb4 takes more space
35     public $date;                            // int(4)
36     public $protected;                       // int(4)
37     public $filename;                        // varchar(191)   not 255 because utf8mb4 takes more space
38     public $width;                           // int(4)
39     public $height;                          // int(4)
40     public $modified;                        // timestamp()   not_null default_CURRENT_TIMESTAMP
41
42     const URLHASH_ALG = 'sha256';
43     const FILEHASH_ALG = 'sha256';
44
45     public static function schemaDef()
46     {
47         return array(
48             'fields' => array(
49                 'id' => array('type' => 'serial', 'not null' => true),
50                 'urlhash' => array('type' => 'varchar', 'length' => 64, 'not null' => true, 'description' => 'sha256 of destination URL (url field)'),
51                 'url' => array('type' => 'text', 'description' => 'destination URL after following possible redirections'),
52                 'filehash' => array('type' => 'varchar', 'length' => 64, 'not null' => false, 'description' => 'sha256 of the file contents, only for locally stored files of course'),
53                 'mimetype' => array('type' => 'varchar', 'length' => 50, 'description' => 'mime type of resource'),
54                 'size' => array('type' => 'int', 'description' => 'size of resource when available'),
55                 'title' => array('type' => 'varchar', 'length' => 191, 'description' => 'title of resource when available'),
56                 'date' => array('type' => 'int', 'description' => 'date of resource according to http query'),
57                 'protected' => array('type' => 'int', 'description' => 'true when URL is private (needs login)'),
58                 'filename' => array('type' => 'varchar', 'length' => 191, 'description' => 'if a local file, name of the file'),
59                 'width' => array('type' => 'int', 'description' => 'width in pixels, if it can be described as such and data is available'),
60                 'height' => array('type' => 'int', 'description' => 'height in pixels, if it can be described as such and data is available'),
61
62                 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
63             ),
64             'primary key' => array('id'),
65             'unique keys' => array(
66                 'file_urlhash_key' => array('urlhash'),
67             ),
68             'indexes' => array(
69                 'file_filehash_idx' => array('filehash'),
70             ),
71         );
72     }
73
74     function isProtected($url) {
75         return 'http://www.facebook.com/login.php' === $url;
76     }
77
78     /**
79      * Save a new file record.
80      *
81      * @param array $redir_data lookup data eg from File_redirection::where()
82      * @param string $given_url
83      * @return File
84      */
85     public static function saveNew(array $redir_data, $given_url) {
86
87         // I don't know why we have to keep doing this but I'm adding this last check to avoid
88         // uniqueness bugs.
89
90         $file = File::getKV('urlhash', self::hashurl($given_url));
91         
92         if (!$file instanceof File) {
93             $file = new File;
94             $file->urlhash = self::hashurl($given_url);
95             $file->url = $given_url;
96             if (!empty($redir_data['protected'])) $file->protected = $redir_data['protected'];
97             if (!empty($redir_data['title'])) $file->title = $redir_data['title'];
98             if (!empty($redir_data['type'])) $file->mimetype = $redir_data['type'];
99             if (!empty($redir_data['size'])) $file->size = intval($redir_data['size']);
100             if (isset($redir_data['time']) && $redir_data['time'] > 0) $file->date = intval($redir_data['time']);
101             $file_id = $file->insert();
102         }
103
104         Event::handle('EndFileSaveNew', array($file, $redir_data, $given_url));
105         assert ($file instanceof File);
106         return $file;
107     }
108
109     /**
110      * Go look at a URL and possibly save data about it if it's new:
111      * - follow redirect chains and store them in file_redirection
112      * - if a thumbnail is available, save it in file_thumbnail
113      * - save file record with basic info
114      * - optionally save a file_to_post record
115      * - return the File object with the full reference
116      *
117      * @fixme refactor this mess, it's gotten pretty scary.
118      * @param string $given_url the URL we're looking at
119      * @param int $notice_id (optional)
120      * @param bool $followRedirects defaults to true
121      *
122      * @return mixed File on success, -1 on some errors
123      *
124      * @throws ServerException on failure
125      */
126     public static function processNew($given_url, $notice_id=null, $followRedirects=true) {
127         if (empty($given_url)) {
128             throw new ServerException('No given URL to process');
129         }
130
131         $given_url = File_redirection::_canonUrl($given_url);
132         if (empty($given_url)) {
133             throw new ServerException('No canonical URL from given URL to process');
134         }
135
136         $file = null;
137
138         try {
139             $file = File::getByUrl($given_url);
140         } catch (NoResultException $e) {
141             // First check if we have a lookup trace for this URL already
142             try {
143                 $file_redir = File_redirection::getByUrl($given_url);
144                 $file = File::getKV('id', $file_redir->file_id);
145                 if (!$file instanceof File) {
146                     // File did not exist, let's clean up the File_redirection entry
147                     $file_redir->delete();
148                 }
149             } catch (NoResultException $e) {
150                 // We just wanted to doublecheck whether a File_thumbnail we might've had
151                 // actually referenced an existing File object.
152             }
153         }
154
155         // If we still don't have a File object, let's create one now!
156         if (!$file instanceof File) {
157             // @fixme for new URLs this also looks up non-redirect data
158             // such as target content type, size, etc, which we need
159             // for File::saveNew(); so we call it even if not following
160             // new redirects.
161             $redir_data = File_redirection::where($given_url);
162             if (is_array($redir_data)) {
163                 $redir_url = $redir_data['url'];
164             } elseif (is_string($redir_data)) {
165                 $redir_url = $redir_data;
166                 $redir_data = array();
167             } else {
168                 // TRANS: Server exception thrown when a URL cannot be processed.
169                 throw new ServerException(sprintf(_("Cannot process URL '%s'"), $given_url));
170             }
171
172             if ($redir_url === $given_url || !$followRedirects) {
173                 // Save the File object based on our lookup trace
174                 $file = File::saveNew($redir_data, $given_url);
175             } else {
176                 // This seems kind of messed up... for now skipping this part
177                 // if we're already under a redirect, so we don't go into
178                 // horrible infinite loops if we've been given an unstable
179                 // redirect (where the final destination of the first request
180                 // doesn't match what we get when we ask for it again).
181                 //
182                 // Seen in the wild with clojure.org, which redirects through
183                 // wikispaces for auth and appends session data in the URL params.
184                 $file = self::processNew($redir_url, $notice_id, /*followRedirects*/false);
185                 File_redirection::saveNew($redir_data, $file->id, $given_url);
186             }
187
188             if (!$file instanceof File) {
189                 // This should only happen if File::saveNew somehow did not return a File object,
190                 // though we have an assert for that in case the event there might've gone wrong.
191                 // If anything else goes wrong, there should've been an exception thrown.
192                 throw new ServerException('URL processing failed without new File object');
193             }
194         }
195
196         if (!empty($notice_id)) {
197             File_to_post::processNew($file->id, $notice_id);
198         }
199         return $file;
200     }
201
202     public static function respectsQuota(Profile $scoped, $fileSize) {
203         if ($fileSize > common_config('attachments', 'file_quota')) {
204             // TRANS: Message used to be inserted as %2$s in  the text "No file may
205             // TRANS: be larger than %1$d byte and the file you sent was %2$s.".
206             // TRANS: %1$d is the number of bytes of an uploaded file.
207             $fileSizeText = sprintf(_m('%1$d byte','%1$d bytes',$fileSize),$fileSize);
208
209             $fileQuota = common_config('attachments', 'file_quota');
210             // TRANS: Message given if an upload is larger than the configured maximum.
211             // TRANS: %1$d (used for plural) is the byte limit for uploads,
212             // TRANS: %2$s is the proper form of "n bytes". This is the only ways to have
213             // TRANS: gettext support multiple plurals in the same message, unfortunately...
214             throw new ClientException(
215                     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.',
216                               'No file may be larger than %1$d bytes and the file you sent was %2$s. Try to upload a smaller version.',
217                               $fileQuota),
218                     $fileQuota, $fileSizeText));
219         }
220
221         $file = new File;
222
223         $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'";
224         $file->query($query);
225         $file->fetch();
226         $total = $file->total + $fileSize;
227         if ($total > common_config('attachments', 'user_quota')) {
228             // TRANS: Message given if an upload would exceed user quota.
229             // TRANS: %d (number) is the user quota in bytes and is used for plural.
230             throw new ClientException(
231                     sprintf(_m('A file this large would exceed your user quota of %d byte.',
232                               'A file this large would exceed your user quota of %d bytes.',
233                               common_config('attachments', 'user_quota')),
234                     common_config('attachments', 'user_quota')));
235         }
236         $query .= ' AND EXTRACT(month FROM file.modified) = EXTRACT(month FROM now()) and EXTRACT(year FROM file.modified) = EXTRACT(year FROM now())';
237         $file->query($query);
238         $file->fetch();
239         $total = $file->total + $fileSize;
240         if ($total > common_config('attachments', 'monthly_quota')) {
241             // TRANS: Message given id an upload would exceed a user's monthly quota.
242             // TRANS: $d (number) is the monthly user quota in bytes and is used for plural.
243             throw new ClientException(
244                     sprintf(_m('A file this large would exceed your monthly quota of %d byte.',
245                               'A file this large would exceed your monthly quota of %d bytes.',
246                               common_config('attachments', 'monthly_quota')),
247                     common_config('attachments', 'monthly_quota')));
248         }
249         return true;
250     }
251
252     // where should the file go?
253
254     static function filename(Profile $profile, $origname, $mimetype)
255     {
256         $ext = self::guessMimeExtension($mimetype);
257
258         // Normalize and make the original filename more URL friendly.
259         $origname = basename($origname, ".$ext");
260         if (class_exists('Normalizer')) {
261             // http://php.net/manual/en/class.normalizer.php
262             // http://www.unicode.org/reports/tr15/
263             $origname = Normalizer::normalize($origname, Normalizer::FORM_KC);
264         }
265         $origname = preg_replace('/[^A-Za-z0-9\.\_]/', '_', $origname);
266
267         $nickname = $profile->getNickname();
268         $datestamp = strftime('%Y%m%d', time());
269         do {
270             // generate new random strings until we don't run into a filename collision.
271             $random = strtolower(common_confirmation_code(16));
272             $filename = "$nickname-$datestamp-$origname-$random.$ext";
273         } while (file_exists(self::path($filename)));
274         return $filename;
275     }
276
277     static function guessMimeExtension($mimetype)
278     {
279         try {
280             $ext = common_supported_mime_to_ext($mimetype);
281         } catch (Exception $e) {
282             // We don't support this mimetype, but let's guess the extension
283             $ext = substr(strrchr($mimetype, '/'), 1);
284         }
285         return strtolower($ext);
286     }
287
288     /**
289      * Validation for as-saved base filenames
290      */
291     static function validFilename($filename)
292     {
293         return preg_match('/^[A-Za-z0-9._-]+$/', $filename);
294     }
295
296     /**
297      * @throws ClientException on invalid filename
298      */
299     static function path($filename)
300     {
301         if (!self::validFilename($filename)) {
302             // TRANS: Client exception thrown if a file upload does not have a valid name.
303             throw new ClientException(_("Invalid filename."));
304         }
305         $dir = common_config('attachments', 'dir');
306
307         if ($dir[strlen($dir)-1] != '/') {
308             $dir .= '/';
309         }
310
311         return $dir . $filename;
312     }
313
314     static function url($filename)
315     {
316         if (!self::validFilename($filename)) {
317             // TRANS: Client exception thrown if a file upload does not have a valid name.
318             throw new ClientException(_("Invalid filename."));
319         }
320
321         if (common_config('site','private')) {
322
323             return common_local_url('getfile',
324                                 array('filename' => $filename));
325
326         }
327
328         if (GNUsocial::useHTTPS()) {
329
330             $sslserver = common_config('attachments', 'sslserver');
331
332             if (empty($sslserver)) {
333                 // XXX: this assumes that background dir == site dir + /file/
334                 // not true if there's another server
335                 if (is_string(common_config('site', 'sslserver')) &&
336                     mb_strlen(common_config('site', 'sslserver')) > 0) {
337                     $server = common_config('site', 'sslserver');
338                 } else if (common_config('site', 'server')) {
339                     $server = common_config('site', 'server');
340                 }
341                 $path = common_config('site', 'path') . '/file/';
342             } else {
343                 $server = $sslserver;
344                 $path   = common_config('attachments', 'sslpath');
345                 if (empty($path)) {
346                     $path = common_config('attachments', 'path');
347                 }
348             }
349
350             $protocol = 'https';
351         } else {
352             $path = common_config('attachments', 'path');
353             $server = common_config('attachments', 'server');
354
355             if (empty($server)) {
356                 $server = common_config('site', 'server');
357             }
358
359             $ssl = common_config('attachments', 'ssl');
360
361             $protocol = ($ssl) ? 'https' : 'http';
362         }
363
364         if ($path[strlen($path)-1] != '/') {
365             $path .= '/';
366         }
367
368         if ($path[0] != '/') {
369             $path = '/'.$path;
370         }
371
372         return $protocol.'://'.$server.$path.$filename;
373     }
374
375     function getEnclosure(){
376         $enclosure = (object) array();
377         foreach (array('title', 'url', 'date', 'modified', 'size', 'mimetype') as $key) {
378             $enclosure->$key = $this->$key;
379         }
380
381         $needMoreMetadataMimetypes = array(null, 'application/xhtml+xml');
382
383         if (!isset($this->filename) && in_array(common_bare_mime($enclosure->mimetype), $needMoreMetadataMimetypes)) {
384             // This fetches enclosure metadata for non-local links with unset/HTML mimetypes,
385             // which may be enriched through oEmbed or similar (implemented as plugins)
386             Event::handle('FileEnclosureMetadata', array($this, &$enclosure));
387         }
388         if (empty($enclosure->mimetype) || in_array(common_bare_mime($enclosure->mimetype), $needMoreMetadataMimetypes)) {
389             // This means we either don't know what it is, so it can't
390             // be shown as an enclosure, or it is an HTML link which
391             // does not link to a resource with further metadata.
392             throw new ServerException('Unknown enclosure mimetype, not enough metadata');
393         }
394         return $enclosure;
395     }
396
397     /**
398      * Get the attachment's thumbnail record, if any.
399      * Make sure you supply proper 'int' typed variables (or null).
400      *
401      * @param $width  int   Max width of thumbnail in pixels. (if null, use common_config values)
402      * @param $height int   Max height of thumbnail in pixels. (if null, square-crop to $width)
403      * @param $crop   bool  Crop to the max-values' aspect ratio
404      *
405      * @return File_thumbnail
406      *
407      * @throws UseFileAsThumbnailException  if the file is considered an image itself and should be itself as thumbnail
408      * @throws UnsupportedMediaException    if, despite trying, we can't understand how to make a thumbnail for this format
409      * @throws ServerException              on various other errors
410      */
411     public function getThumbnail($width=null, $height=null, $crop=false, $force_still=true)
412     {
413         // Get some more information about this file through our ImageFile class
414         $image = ImageFile::fromFileObject($this);
415         if ($image->animated && !common_config('thumbnail', 'animated')) {
416             // null  means "always use file as thumbnail"
417             // false means you get choice between frozen frame or original when calling getThumbnail
418             if (is_null(common_config('thumbnail', 'animated')) || !$force_still) {
419                 throw new UseFileAsThumbnailException($this->id);
420             }
421         }
422
423         return $image->getFileThumbnail($width, $height, $crop);
424     }
425
426     public function getPath()
427     {
428         $filepath = self::path($this->filename);
429         if (!file_exists($filepath)) {
430             throw new FileNotFoundException($filepath);
431         }
432         return $filepath;
433     }
434
435     public function getUrl()
436     {
437         if (!empty($this->filename)) {
438             // A locally stored file, so let's generate a URL for our instance.
439             $url = self::url($this->filename);
440             if (self::hashurl($url) !== $this->urlhash) {
441                 // For indexing purposes, in case we do a lookup on the 'url' field.
442                 // also we're fixing possible changes from http to https, or paths
443                 $this->updateUrl($url);
444             }
445             return $url;
446         }
447
448         // No local filename available, return the URL we have stored
449         return $this->url;
450     }
451
452     static public function getByUrl($url)
453     {
454         $file = new File();
455         $file->urlhash = self::hashurl($url);
456         if (!$file->find(true)) {
457             throw new NoResultException($file);
458         }
459         return $file;
460     }
461
462     /**
463      * @param   string  $hashstr    String of (preferrably lower case) hexadecimal characters, same as result of 'hash_file(...)'
464      */
465     static public function getByHash($hashstr, $alg=File::FILEHASH_ALG)
466     {
467         $file = new File();
468         $file->filehash = strtolower($hashstr);
469         if (!$file->find(true)) {
470             throw new NoResultException($file);
471         }
472         return $file;
473     }
474
475     public function updateUrl($url)
476     {
477         $file = File::getKV('urlhash', self::hashurl($url));
478         if ($file instanceof File) {
479             throw new ServerException('URL already exists in DB');
480         }
481         $sql = 'UPDATE %1$s SET urlhash=%2$s, url=%3$s WHERE urlhash=%4$s;';
482         $result = $this->query(sprintf($sql, $this->__table,
483                                              $this->_quote((string)self::hashurl($url)),
484                                              $this->_quote((string)$url),
485                                              $this->_quote((string)$this->urlhash)));
486         if ($result === false) {
487             common_log_db_error($this, 'UPDATE', __FILE__);
488             throw new ServerException("Could not UPDATE {$this->__table}.url");
489         }
490
491         return $result;
492     }
493
494     /**
495      * Blow the cache of notices that link to this URL
496      *
497      * @param boolean $last Whether to blow the "last" cache too
498      *
499      * @return void
500      */
501
502     function blowCache($last=false)
503     {
504         self::blow('file:notice-ids:%s', $this->urlhash);
505         if ($last) {
506             self::blow('file:notice-ids:%s;last', $this->urlhash);
507         }
508         self::blow('file:notice-count:%d', $this->id);
509     }
510
511     /**
512      * Stream of notices linking to this URL
513      *
514      * @param integer $offset   Offset to show; default is 0
515      * @param integer $limit    Limit of notices to show
516      * @param integer $since_id Since this notice
517      * @param integer $max_id   Before this notice
518      *
519      * @return array ids of notices that link to this file
520      */
521
522     function stream($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
523     {
524         $stream = new FileNoticeStream($this);
525         return $stream->getNotices($offset, $limit, $since_id, $max_id);
526     }
527
528     function noticeCount()
529     {
530         $cacheKey = sprintf('file:notice-count:%d', $this->id);
531         
532         $count = self::cacheGet($cacheKey);
533
534         if ($count === false) {
535
536             $f2p = new File_to_post();
537
538             $f2p->file_id = $this->id;
539
540             $count = $f2p->count();
541
542             self::cacheSet($cacheKey, $count);
543         } 
544
545         return $count;
546     }
547
548     public function isLocal()
549     {
550         return !empty($this->filename);
551     }
552
553     public function delete($useWhere=false)
554     {
555         // Delete the file, if it exists locally
556         if (!empty($this->filename) && file_exists(self::path($this->filename))) {
557             $deleted = @unlink(self::path($this->filename));
558             if (!$deleted) {
559                 common_log(LOG_ERR, sprintf('Could not unlink existing file: "%s"', self::path($this->filename)));
560             }
561         }
562
563         // Clear out related things in the database and filesystem, such as thumbnails
564         if (Event::handle('FileDeleteRelated', array($this))) {
565             $thumbs = new File_thumbnail();
566             $thumbs->file_id = $this->id;
567             if ($thumbs->find()) {
568                 while ($thumbs->fetch()) {
569                     $thumbs->delete();
570                 }
571             }
572         }
573
574         // And finally remove the entry from the database
575         return parent::delete($useWhere);
576     }
577
578     public function getTitle()
579     {
580         $title = $this->title ?: $this->filename;
581
582         return $title ?: null;
583     }
584
585     static public function hashurl($url)
586     {
587         if (empty($url)) {
588             throw new Exception('No URL provided to hash algorithm.');
589         }
590         return hash(self::URLHASH_ALG, $url);
591     }
592
593     static public function beforeSchemaUpdate()
594     {
595         $table = strtolower(get_called_class());
596         $schema = Schema::get();
597         $schemadef = $schema->getTableDef($table);
598
599         // 2015-02-19 We have to upgrade our table definitions to have the urlhash field populated
600         if (isset($schemadef['fields']['urlhash']) && isset($schemadef['unique keys']['file_urlhash_key'])) {
601             // We already have the urlhash field, so no need to migrate it.
602             return;
603         }
604         echo "\nFound old $table table, upgrading it to contain 'urlhash' field...";
605         // We have to create a urlhash that is _not_ the primary key,
606         // transfer data and THEN run checkSchema
607         $schemadef['fields']['urlhash'] = array (
608                                               'type' => 'varchar',
609                                               'length' => 64,
610                                               'not null' => true,
611                                               'description' => 'sha256 of destination URL (url field)',
612                                             );
613         $schemadef['fields']['url'] = array (
614                                               'type' => 'text',
615                                               'description' => 'destination URL after following possible redirections',
616                                             );
617         unset($schemadef['unique keys']);
618         $schema->ensureTable($table, $schemadef);
619         echo "DONE.\n";
620
621         $classname = ucfirst($table);
622         $tablefix = new $classname;
623         // urlhash is hash('sha256', $url) in the File table
624         echo "Updating urlhash fields in $table table...";
625         // Maybe very MySQL specific :(
626         $tablefix->query(sprintf('UPDATE %1$s SET %2$s=%3$s;',
627                             $schema->quoteIdentifier($table),
628                             'urlhash',
629                             // The line below is "result of sha256 on column `url`"
630                             'SHA2(url, 256)'));
631         echo "DONE.\n";
632         echo "Resuming core schema upgrade...";
633     }
634 }