X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=classes%2FFile.php;h=8991616f82e54d825f68c981c0d1ab3071c84743;hb=02418cffd81389bd3a7e17daf9eac259ac0b9439;hp=8d0623bf489023ca0a08ee28d5a424fa5a02ddb2;hpb=06d4cecf7f03adae35a50375cc4e91c9eda1fc9e;p=quix0rs-gnu-social.git diff --git a/classes/File.php b/classes/File.php index 8d0623bf48..8991616f82 100644 --- a/classes/File.php +++ b/classes/File.php @@ -24,41 +24,49 @@ if (!defined('GNUSOCIAL')) { exit(1); } */ class File extends Managed_DataObject { - ###START_AUTOCODE - /* the code below is auto generated do not remove the above tag */ - public $__table = 'file'; // table name public $id; // int(4) primary_key not_null - public $url; // varchar(255) unique_key + public $urlhash; // varchar(64) unique_key + public $url; // text + public $filehash; // varchar(64) indexed public $mimetype; // varchar(50) public $size; // int(4) - public $title; // varchar(255) + public $title; // varchar(191) not 255 because utf8mb4 takes more space public $date; // int(4) public $protected; // int(4) - public $filename; // varchar(255) + public $filename; // varchar(191) not 255 because utf8mb4 takes more space + public $width; // int(4) + public $height; // int(4) public $modified; // timestamp() not_null default_CURRENT_TIMESTAMP - /* the code above is auto generated do not remove the tag below */ - ###END_AUTOCODE + const URLHASH_ALG = 'sha256'; + const FILEHASH_ALG = 'sha256'; public static function schemaDef() { return array( 'fields' => array( 'id' => array('type' => 'serial', 'not null' => true), - 'url' => array('type' => 'varchar', 'length' => 255, 'description' => 'destination URL after following redirections'), + 'urlhash' => array('type' => 'varchar', 'length' => 64, 'not null' => true, 'description' => 'sha256 of destination URL (url field)'), + 'url' => array('type' => 'text', 'description' => 'destination URL after following possible redirections'), + 'filehash' => array('type' => 'varchar', 'length' => 64, 'not null' => false, 'description' => 'sha256 of the file contents, only for locally stored files of course'), 'mimetype' => array('type' => 'varchar', 'length' => 50, 'description' => 'mime type of resource'), 'size' => array('type' => 'int', 'description' => 'size of resource when available'), - 'title' => array('type' => 'varchar', 'length' => 255, 'description' => 'title of resource when available'), + 'title' => array('type' => 'varchar', 'length' => 191, 'description' => 'title of resource when available'), 'date' => array('type' => 'int', 'description' => 'date of resource according to http query'), 'protected' => array('type' => 'int', 'description' => 'true when URL is private (needs login)'), - 'filename' => array('type' => 'varchar', 'length' => 255, 'description' => 'if a local file, name of the file'), + 'filename' => array('type' => 'varchar', 'length' => 191, 'description' => 'if a local file, name of the file'), + 'width' => array('type' => 'int', 'description' => 'width in pixels, if it can be described as such and data is available'), + 'height' => array('type' => 'int', 'description' => 'height in pixels, if it can be described as such and data is available'), 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'), ), 'primary key' => array('id'), 'unique keys' => array( - 'file_url_key' => array('url'), + 'file_urlhash_key' => array('urlhash'), + ), + 'indexes' => array( + 'file_filehash_idx' => array('filehash'), ), ); } @@ -74,67 +82,37 @@ class File extends Managed_DataObject * @param string $given_url * @return File */ - function saveNew(array $redir_data, $given_url) { + public static function saveNew(array $redir_data, $given_url) { // I don't know why we have to keep doing this but I'm adding this last check to avoid // uniqueness bugs. - $x = File::getKV('url', $given_url); + $file = File::getKV('urlhash', self::hashurl($given_url)); - if (!$x instanceof File) { - $x = new File; - $x->url = $given_url; - if (!empty($redir_data['protected'])) $x->protected = $redir_data['protected']; - if (!empty($redir_data['title'])) $x->title = $redir_data['title']; - if (!empty($redir_data['type'])) $x->mimetype = $redir_data['type']; - if (!empty($redir_data['size'])) $x->size = intval($redir_data['size']); - if (isset($redir_data['time']) && $redir_data['time'] > 0) $x->date = intval($redir_data['time']); - $file_id = $x->insert(); - } - - $x->saveOembed($redir_data, $given_url); - return $x; - } - - /** - * Save embedding information for this file, if applicable. - * - * Normally this won't need to be called manually, as File::saveNew() - * takes care of it. - * - * @param array $redir_data lookup data eg from File_redirection::where() - * @param string $given_url - * @return boolean success - */ - public function saveOembed(array $redir_data, $given_url) - { - if (isset($redir_data['type']) - && (('text/html' === substr($redir_data['type'], 0, 9) - || 'application/xhtml+xml' === substr($redir_data['type'], 0, 21)))) { - try { - $oembed_data = File_oembed::_getOembed($given_url); - } catch (Exception $e) { - return false; - } - if ($oembed_data === false) { - return false; - } - $fo = File_oembed::getKV('file_id', $this->id); - - if ($fo instanceof File_oembed) { - common_log(LOG_WARNING, "Strangely, a File_oembed object exists for new file $file_id", __FILE__); - } else { - File_oembed::saveNew($oembed_data, $this->id); - return true; + if (!$file instanceof File) { + $file = new File; + $file->urlhash = self::hashurl($given_url); + $file->url = $given_url; + if (!empty($redir_data['protected'])) $file->protected = $redir_data['protected']; + if (!empty($redir_data['title'])) $file->title = $redir_data['title']; + if (!empty($redir_data['type'])) $file->mimetype = $redir_data['type']; + if (!empty($redir_data['size'])) $file->size = intval($redir_data['size']); + if (isset($redir_data['time']) && $redir_data['time'] > 0) $file->date = intval($redir_data['time']); + $file_id = $file->insert(); + + if ($file_id === false) { + throw new ServerException('File/URL metadata could not be saved to the database.'); } } - return false; + + Event::handle('EndFileSaveNew', array($file, $redir_data, $given_url)); + assert ($file instanceof File); + return $file; } /** * Go look at a URL and possibly save data about it if it's new: * - follow redirect chains and store them in file_redirection - * - look up oEmbed data and save it in file_oembed * - if a thumbnail is available, save it in file_thumbnail * - save file record with basic info * - optionally save a file_to_post record @@ -142,73 +120,87 @@ class File extends Managed_DataObject * * @fixme refactor this mess, it's gotten pretty scary. * @param string $given_url the URL we're looking at - * @param int $notice_id (optional) + * @param Notice $notice (optional) * @param bool $followRedirects defaults to true * * @return mixed File on success, -1 on some errors * - * @throws ServerException on some errors + * @throws ServerException on failure */ - public function processNew($given_url, $notice_id=null, $followRedirects=true) { - if (empty($given_url)) return -1; // error, no url to process + public static function processNew($given_url, Notice $notice=null, $followRedirects=true) { + if (empty($given_url)) { + throw new ServerException('No given URL to process'); + } + $given_url = File_redirection::_canonUrl($given_url); - if (empty($given_url)) return -1; // error, no url to process - $file = File::getKV('url', $given_url); - if (empty($file)) { - $file_redir = File_redirection::getKV('url', $given_url); - if (empty($file_redir)) { - // @fixme for new URLs this also looks up non-redirect data - // such as target content type, size, etc, which we need - // for File::saveNew(); so we call it even if not following - // new redirects. - $redir_data = File_redirection::where($given_url); - if (is_array($redir_data)) { - $redir_url = $redir_data['url']; - } elseif (is_string($redir_data)) { - $redir_url = $redir_data; - $redir_data = array(); - } else { - // TRANS: Server exception thrown when a URL cannot be processed. - throw new ServerException(sprintf(_("Cannot process URL '%s'"), $given_url)); - } - // TODO: max field length - if ($redir_url === $given_url || strlen($redir_url) > 255 || !$followRedirects) { - $x = File::saveNew($redir_data, $given_url); - $file_id = $x->id; - } else { - // This seems kind of messed up... for now skipping this part - // if we're already under a redirect, so we don't go into - // horrible infinite loops if we've been given an unstable - // redirect (where the final destination of the first request - // doesn't match what we get when we ask for it again). - // - // Seen in the wild with clojure.org, which redirects through - // wikispaces for auth and appends session data in the URL params. - $x = File::processNew($redir_url, $notice_id, /*followRedirects*/false); - $file_id = $x->id; - File_redirection::saveNew($redir_data, $file_id, $given_url); + if (empty($given_url)) { + throw new ServerException('No canonical URL from given URL to process'); + } + + $file = null; + + try { + $file = File::getByUrl($given_url); + } catch (NoResultException $e) { + // First check if we have a lookup trace for this URL already + try { + $file_redir = File_redirection::getByUrl($given_url); + $file = File::getKV('id', $file_redir->file_id); + if (!$file instanceof File) { + // File did not exist, let's clean up the File_redirection entry + $file_redir->delete(); } - } else { - $file_id = $file_redir->file_id; + } catch (NoResultException $e) { + // We just wanted to doublecheck whether a File_thumbnail we might've had + // actually referenced an existing File object. } - } else { - $file_id = $file->id; - $x = $file; } - if (empty($x)) { - $x = File::getKV('id', $file_id); - if (empty($x)) { - // @todo FIXME: This could possibly be a clearer message :) - // TRANS: Server exception thrown when... Robin thinks something is impossible! - throw new ServerException(_('Robin thinks something is impossible.')); + // If we still don't have a File object, let's create one now! + if (!$file instanceof File) { + // @fixme for new URLs this also looks up non-redirect data + // such as target content type, size, etc, which we need + // for File::saveNew(); so we call it even if not following + // new redirects. + $redir_data = File_redirection::where($given_url); + if (is_array($redir_data)) { + $redir_url = $redir_data['url']; + } elseif (is_string($redir_data)) { + $redir_url = $redir_data; + $redir_data = array(); + } else { + // TRANS: Server exception thrown when a URL cannot be processed. + throw new ServerException(sprintf(_("Cannot process URL '%s'"), $given_url)); + } + + if ($redir_url === $given_url || !$followRedirects) { + // Save the File object based on our lookup trace + $file = File::saveNew($redir_data, $given_url); + } else { + // This seems kind of messed up... for now skipping this part + // if we're already under a redirect, so we don't go into + // horrible infinite loops if we've been given an unstable + // redirect (where the final destination of the first request + // doesn't match what we get when we ask for it again). + // + // Seen in the wild with clojure.org, which redirects through + // wikispaces for auth and appends session data in the URL params. + $file = self::processNew($redir_url, $notice, /*followRedirects*/false); + File_redirection::saveNew($redir_data, $file->id, $given_url); + } + + if (!$file instanceof File) { + // This should only happen if File::saveNew somehow did not return a File object, + // though we have an assert for that in case the event there might've gone wrong. + // If anything else goes wrong, there should've been an exception thrown. + throw new ServerException('URL processing failed without new File object'); } } - if (!empty($notice_id)) { - File_to_post::processNew($file_id, $notice_id); + if ($notice instanceof Notice) { + File_to_post::processNew($file, $notice); } - return $x; + return $file; } public static function respectsQuota(Profile $scoped, $fileSize) { @@ -261,9 +253,41 @@ class File extends Managed_DataObject return true; } + public function getFilename() + { + if (!self::validFilename($this->filename)) { + // TRANS: Client exception thrown if a file upload does not have a valid name. + throw new ClientException(_("Invalid filename.")); + } + return $this->filename; + } + // where should the file go? - static function filename($profile, $basename, $mimetype) + static function filename(Profile $profile, $origname, $mimetype) + { + $ext = self::guessMimeExtension($mimetype); + + // Normalize and make the original filename more URL friendly. + $origname = basename($origname, ".$ext"); + if (class_exists('Normalizer')) { + // http://php.net/manual/en/class.normalizer.php + // http://www.unicode.org/reports/tr15/ + $origname = Normalizer::normalize($origname, Normalizer::FORM_KC); + } + $origname = preg_replace('/[^A-Za-z0-9\.\_]/', '_', $origname); + + $nickname = $profile->getNickname(); + $datestamp = strftime('%Y%m%d', time()); + do { + // generate new random strings until we don't run into a filename collision. + $random = strtolower(common_confirmation_code(16)); + $filename = "$nickname-$datestamp-$origname-$random.$ext"; + } while (file_exists(self::path($filename))); + return $filename; + } + + static function guessMimeExtension($mimetype) { try { $ext = common_supported_mime_to_ext($mimetype); @@ -271,11 +295,7 @@ class File extends Managed_DataObject // We don't support this mimetype, but let's guess the extension $ext = substr(strrchr($mimetype, '/'), 1); } - - $nickname = $profile->nickname; - $datestamp = strftime('%Y%m%dT%H%M%S', time()); - $random = strtolower(common_confirmation_code(32)); - return "$nickname-$datestamp-$random.$ext"; + return strtolower($ext); } /** @@ -318,7 +338,7 @@ class File extends Managed_DataObject } - if (StatusNet::isHTTPS()) { + if (GNUsocial::useHTTPS()) { $sslserver = common_config('attachments', 'sslserver'); @@ -367,75 +387,121 @@ class File extends Managed_DataObject function getEnclosure(){ $enclosure = (object) array(); - $enclosure->title=$this->title; - $enclosure->url=$this->url; - $enclosure->title=$this->title; - $enclosure->date=$this->date; - $enclosure->modified=$this->modified; - $enclosure->size=$this->size; - $enclosure->mimetype=$this->mimetype; - - if(! isset($this->filename)){ - $notEnclosureMimeTypes = array(null,'text/html','application/xhtml+xml'); - $mimetype = $this->mimetype; - if($mimetype != null){ - $mimetype = strtolower($this->mimetype); - } - $semicolon = strpos($mimetype,';'); - if($semicolon){ - $mimetype = substr($mimetype,0,$semicolon); - } - if(in_array($mimetype,$notEnclosureMimeTypes)){ - // Never treat generic HTML links as an enclosure type! - // But if we have oEmbed info, we'll consider it golden. - $oembed = File_oembed::getKV('file_id',$this->id); - if($oembed && in_array($oembed->type, array('photo', 'video'))){ - $mimetype = strtolower($oembed->mimetype); - $semicolon = strpos($mimetype,';'); - if($semicolon){ - $mimetype = substr($mimetype,0,$semicolon); - } - // @fixme uncertain if this is right. - // we want to expose things like YouTube videos as - // viewable attachments, but don't expose them as - // downloadable enclosures.....? - //if (in_array($mimetype, $notEnclosureMimeTypes)) { - // return false; - //} else { - if($oembed->mimetype) $enclosure->mimetype=$oembed->mimetype; - if($oembed->url) $enclosure->url=$oembed->url; - if($oembed->title) $enclosure->title=$oembed->title; - if($oembed->modified) $enclosure->modified=$oembed->modified; - unset($oembed->size); - //} - } else { - return false; - } - } + foreach (array('title', 'url', 'date', 'modified', 'size', 'mimetype') as $key) { + $enclosure->$key = $this->$key; } - return $enclosure; - } - // quick back-compat hack, since there's still code using this - function isEnclosure() - { - $enclosure = $this->getEnclosure(); - return !empty($enclosure); + $needMoreMetadataMimetypes = array(null, 'application/xhtml+xml'); + + if (!isset($this->filename) && in_array(common_bare_mime($enclosure->mimetype), $needMoreMetadataMimetypes)) { + // This fetches enclosure metadata for non-local links with unset/HTML mimetypes, + // which may be enriched through oEmbed or similar (implemented as plugins) + Event::handle('FileEnclosureMetadata', array($this, &$enclosure)); + } + if (empty($enclosure->mimetype) || in_array(common_bare_mime($enclosure->mimetype), $needMoreMetadataMimetypes)) { + // This means we either don't know what it is, so it can't + // be shown as an enclosure, or it is an HTML link which + // does not link to a resource with further metadata. + throw new ServerException('Unknown enclosure mimetype, not enough metadata'); + } + return $enclosure; } /** * Get the attachment's thumbnail record, if any. + * Make sure you supply proper 'int' typed variables (or null). + * + * @param $width int Max width of thumbnail in pixels. (if null, use common_config values) + * @param $height int Max height of thumbnail in pixels. (if null, square-crop to $width) + * @param $crop bool Crop to the max-values' aspect ratio * * @return File_thumbnail + * + * @throws UseFileAsThumbnailException if the file is considered an image itself and should be itself as thumbnail + * @throws UnsupportedMediaException if, despite trying, we can't understand how to make a thumbnail for this format + * @throws ServerException on various other errors */ - function getThumbnail() + public function getThumbnail($width=null, $height=null, $crop=false, $force_still=true) { - return File_thumbnail::getKV('file_id', $this->id); + // Get some more information about this file through our ImageFile class + $image = ImageFile::fromFileObject($this); + if ($image->animated && !common_config('thumbnail', 'animated')) { + // null means "always use file as thumbnail" + // false means you get choice between frozen frame or original when calling getThumbnail + if (is_null(common_config('thumbnail', 'animated')) || !$force_still) { + throw new UseFileAsThumbnailException($this->id); + } + } + + return $image->getFileThumbnail($width, $height, $crop); } public function getPath() { - return self::path($this->filename); + $filepath = self::path($this->filename); + if (!file_exists($filepath)) { + throw new FileNotFoundException($filepath); + } + return $filepath; + } + + public function getUrl() + { + if (!empty($this->filename)) { + // A locally stored file, so let's generate a URL for our instance. + $url = self::url($this->filename); + if (self::hashurl($url) !== $this->urlhash) { + // For indexing purposes, in case we do a lookup on the 'url' field. + // also we're fixing possible changes from http to https, or paths + $this->updateUrl($url); + } + return $url; + } + + // No local filename available, return the URL we have stored + return $this->url; + } + + static public function getByUrl($url) + { + $file = new File(); + $file->urlhash = self::hashurl($url); + if (!$file->find(true)) { + throw new NoResultException($file); + } + return $file; + } + + /** + * @param string $hashstr String of (preferrably lower case) hexadecimal characters, same as result of 'hash_file(...)' + */ + static public function getByHash($hashstr, $alg=File::FILEHASH_ALG) + { + $file = new File(); + $file->filehash = strtolower($hashstr); + if (!$file->find(true)) { + throw new NoResultException($file); + } + return $file; + } + + public function updateUrl($url) + { + $file = File::getKV('urlhash', self::hashurl($url)); + if ($file instanceof File) { + throw new ServerException('URL already exists in DB'); + } + $sql = 'UPDATE %1$s SET urlhash=%2$s, url=%3$s WHERE urlhash=%4$s;'; + $result = $this->query(sprintf($sql, $this->tableName(), + $this->_quote((string)self::hashurl($url)), + $this->_quote((string)$url), + $this->_quote((string)$this->urlhash))); + if ($result === false) { + common_log_db_error($this, 'UPDATE', __FILE__); + throw new ServerException("Could not UPDATE {$this->tableName()}.url"); + } + + return $result; } /** @@ -448,9 +514,9 @@ class File extends Managed_DataObject function blowCache($last=false) { - self::blow('file:notice-ids:%s', $this->url); + self::blow('file:notice-ids:%s', $this->id); if ($last) { - self::blow('file:notice-ids:%s;last', $this->url); + self::blow('file:notice-ids:%s;last', $this->id); } self::blow('file:notice-count:%d', $this->id); } @@ -491,4 +557,132 @@ class File extends Managed_DataObject return $count; } + + public function isLocal() + { + return !empty($this->filename); + } + + public function delete($useWhere=false) + { + // Delete the file, if it exists locally + if (!empty($this->filename) && file_exists(self::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))); + } + } + + // Clear out related things in the database and filesystem, such as thumbnails + if (Event::handle('FileDeleteRelated', array($this))) { + $thumbs = new File_thumbnail(); + $thumbs->file_id = $this->id; + if ($thumbs->find()) { + while ($thumbs->fetch()) { + $thumbs->delete(); + } + } + + $f2p = new File_to_post(); + $f2p->file_id = $this->id; + if ($f2p->find()) { + while ($f2p->fetch()) { + $f2p->delete(); + } + } + } + + // And finally remove the entry from the database + return parent::delete($useWhere); + } + + public function getTitle() + { + $title = $this->title ?: $this->filename; + + return $title ?: null; + } + + static public function hashurl($url) + { + if (empty($url)) { + throw new Exception('No URL provided to hash algorithm.'); + } + return hash(self::URLHASH_ALG, $url); + } + + static public function beforeSchemaUpdate() + { + $table = strtolower(get_called_class()); + $schema = Schema::get(); + $schemadef = $schema->getTableDef($table); + + // 2015-02-19 We have to upgrade our table definitions to have the urlhash field populated + if (isset($schemadef['fields']['urlhash']) && isset($schemadef['unique keys']['file_urlhash_key'])) { + // We already have the urlhash field, so no need to migrate it. + return; + } + echo "\nFound old $table table, upgrading it to contain 'urlhash' field..."; + + $file = new File(); + $file->query(sprintf('SELECT id, LEFT(url, 191) AS shortenedurl, COUNT(*) AS c FROM %1$s WHERE LENGTH(url)>191 GROUP BY shortenedurl HAVING c > 1', $schema->quoteIdentifier($table))); + print "\nFound {$file->N} URLs with too long entries in file table\n"; + while ($file->fetch()) { + // We've got a URL that is too long for our future file table + // so we'll cut it. We could save the original URL, but there is + // no guarantee it is complete anyway since the previous max was 255 chars. + $dupfile = new File(); + // First we find file entries that would be duplicates of this when shortened + // ... and we'll just throw the dupes out the window for now! It's already so borken. + $dupfile->query(sprintf('SELECT * FROM file WHERE LEFT(url, 191) = "%1$s"', $file->shortenedurl)); + // Leave one of the URLs in the database by using ->find(true) (fetches first entry) + if ($dupfile->find(true)) { + print "\nShortening url entry for $table id: {$file->id} ["; + $orig = clone($dupfile); + $dupfile->url = $file->shortenedurl; // make sure it's only 191 chars from now on + $dupfile->update($orig); + print "\nDeleting duplicate entries of too long URL on $table id: {$file->id} ["; + // only start deleting with this fetch. + while($dupfile->fetch()) { + print "."; + $dupfile->delete(); + } + print "]\n"; + } else { + print "\nWarning! URL suddenly disappeared from database: {$file->url}\n"; + } + } + echo "...and now all the non-duplicates which are longer than 191 characters...\n"; + $file->query('UPDATE file SET url=LEFT(url, 191) WHERE LENGTH(url)>191'); + + echo "\n...now running hacky pre-schemaupdate change for $table:"; + // We have to create a urlhash that is _not_ the primary key, + // transfer data and THEN run checkSchema + $schemadef['fields']['urlhash'] = array ( + 'type' => 'varchar', + 'length' => 64, + 'not null' => false, // this is because when adding column, all entries will _be_ NULL! + 'description' => 'sha256 of destination URL (url field)', + ); + $schemadef['fields']['url'] = array ( + 'type' => 'text', + 'description' => 'destination URL after following possible redirections', + ); + unset($schemadef['unique keys']); + $schema->ensureTable($table, $schemadef); + echo "DONE.\n"; + + $classname = ucfirst($table); + $tablefix = new $classname; + // urlhash is hash('sha256', $url) in the File table + echo "Updating urlhash fields in $table table..."; + // Maybe very MySQL specific :( + $tablefix->query(sprintf('UPDATE %1$s SET %2$s=%3$s;', + $schema->quoteIdentifier($table), + 'urlhash', + // The line below is "result of sha256 on column `url`" + 'SHA2(url, 256)')); + echo "DONE.\n"; + echo "Resuming core schema upgrade..."; + } }