GNUsocial/gnu-social
4
0
Fork 1
Code Issues Releases Wiki Activity
da82048d77
gnu-social/lib/imagefile.php

623 lines
23 KiB
PHP
Raw Normal View History

Extract image management code to a helper function
2009-01-22 11:35:09 +00:00
<?php
/**
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
* GNU social - a federating social network
Extract image management code to a helper function
2009-01-22 11:35:09 +00:00
*
* Abstraction for an image file
*
* LICENCE: This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* @category Image
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
* @package GNUsocial
change controlyourself.ca to status.net
2009-08-25 23:19:04 +01:00
* @author Evan Prodromou <evan@status.net>
* @author Zach Copley <zach@status.net>
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
* @author Mikael Nordfeldth <mmn@hethane.se>
* @author Miguel Dantas <biodantasgs@gmail.com>
* @copyright 2008, 2019 Free Software Foundation http://fsf.org
Extract image management code to a helper function
2009-01-22 11:35:09 +00:00
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
* @link https://www.gnu.org/software/social/
Extract image management code to a helper function
2009-01-22 11:35:09 +00:00
*/
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
defined('GNUSOCIAL') || die();
Extract image management code to a helper function
2009-01-22 11:35:09 +00:00
/**
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
* A wrapper on uploaded images
Extract image management code to a helper function
2009-01-22 11:35:09 +00:00
*
* Makes it slightly easier to accept an image file from upload.
*
* @category Image
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
* @package GNUsocial
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
change controlyourself.ca to status.net
2009-08-25 23:19:04 +01:00
* @author Evan Prodromou <evan@status.net>
* @author Zach Copley <zach@status.net>
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
* @link https://www.gnu.org/software/social/
Extract image management code to a helper function
2009-01-22 11:35:09 +00:00
*/
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
class ImageFile extends MediaFile
Extract image management code to a helper function
2009-01-22 11:35:09 +00:00
{
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
public $type;
public $height;
public $width;
public $rotate = 0; // degrees to rotate for properly oriented image (extrapolated from EXIF etc.)
public $animated = null; // Animated image? (has more than 1 frame). null means untested
public $mimetype = null; // The _ImageFile_ mimetype, _not_ the originating File object
public function __construct($id, string $filepath)
Extract image management code to a helper function
2009-01-22 11:35:09 +00:00
{
Documentation and more understandable code.
2015-03-04 12:29:18 +00:00
// These do not have to be the same as fileRecord->filename for example,
// since we may have generated an image source file from something else!
Fixed #1134; Consolidated image scaling functions.
2009-02-05 00:32:15 +00:00
$this->filepath = $filepath;
barename wasn't used, let's rename it filename and use it
2015-01-25 01:27:02 +00:00
$this->filename = basename($filepath);
Two different functions for file size Made two different functions for file size in ImageFile; one uses the other. Also, use sprintf() for gettext msgs.
2009-02-05 21:32:58 +00:00
Fixed #1134; Consolidated image scaling functions.
2009-02-05 00:32:15 +00:00
$info = @getimagesize($this->filepath);
move image type checking to constructor, so checking will be done in all cases check if the relevant image handling function exists when deciding if the image type is supported
2010-03-12 01:12:32 +00:00
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
if (!(($info[2] == IMAGETYPE_GIF && function_exists('imagecreatefromgif')) ||
($info[2] == IMAGETYPE_JPEG && function_exists('imagecreatefromjpeg')) ||
($info[2] == IMAGETYPE_BMP && function_exists('imagecreatefrombmp')) ||
($info[2] == IMAGETYPE_WBMP && function_exists('imagecreatefromwbmp')) ||
($info[2] == IMAGETYPE_XBM && function_exists('imagecreatefromxbm')) ||
($info[2] == IMAGETYPE_PNG && function_exists('imagecreatefrompng')))) {
* fix some i18n and L10n issues * update/add translator documentation * remove superfluous whitespace
2011-01-28 23:33:13 +00:00
// TRANS: Exception thrown when trying to upload an unsupported image file format.
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
throw new UnsupportedMediaException(_m('Unsupported image format.'), $this->filepath);
move image type checking to constructor, so checking will be done in all cases check if the relevant image handling function exists when deciding if the image type is supported
2010-03-12 01:12:32 +00:00
}
ImageFile constructor changed to align with existing code Noone passed type, width or height to new ImageFile(...) and in all instances, both parameters were set (though $id is null on occasion).
2015-02-25 00:31:44 +00:00
$this->width = $info[0];
$this->height = $info[1];
$this->type = $info[2];
mimetype added to ImageFile
2015-02-25 00:33:32 +00:00
$this->mimetype = $info['mime'];
File_thumbnail fixes (run scripts/upgrade.php) We're now capable of doing image rotation for thumbnails based on EXIF orientation data. Also, thumbnails are tracked by filenames and thus we can delete them from storage when we feel like it.
2014-05-12 13:33:41 +01:00
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
parent::__construct(
$filepath,
$this->mimetype,
null /* filehash, MediaFile will calculate it */,
$id
);
strict type comparison
2016-04-18 14:04:03 +01:00
if ($this->type === IMAGETYPE_JPEG && function_exists('exif_read_data')) {
Only JPEG files (and TIFF, which we don't support) have EXIF
2014-05-12 13:45:23 +01:00
// Orientation value to rotate thumbnails properly
Issue #166 - we test exif data below, no need for error output
2016-03-21 01:56:47 +00:00
$exif = @exif_read_data($this->filepath);
Only JPEG files (and TIFF, which we don't support) have EXIF
2014-05-12 13:45:23 +01:00
if (is_array($exif) && isset($exif['Orientation'])) {
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
switch (intval($exif['Orientation'])) {
Only JPEG files (and TIFF, which we don't support) have EXIF
2014-05-12 13:45:23 +01:00
case 1: // top is top
$this->rotate = 0;
break;
case 3: // top is bottom
$this->rotate = 180;
break;
case 6: // top is right
$this->rotate = -90;
break;
case 8: // top is left
$this->rotate = 90;
break;
}
// If we ever write this back, Orientation should be set to '1'
File_thumbnail fixes (run scripts/upgrade.php) We're now capable of doing image rotation for thumbnails based on EXIF orientation data. Also, thumbnails are tracked by filenames and thus we can delete them from storage when we feel like it.
2014-05-12 13:33:41 +01:00
}
No need for ImageMagick to detected animated GIF
2015-01-25 21:45:25 +00:00
} elseif ($this->type === IMAGETYPE_GIF) {
$this->animated = $this->isAnimatedGif();
File_thumbnail fixes (run scripts/upgrade.php) We're now capable of doing image rotation for thumbnails based on EXIF orientation data. Also, thumbnails are tracked by filenames and thus we can delete them from storage when we feel like it.
2014-05-12 13:33:41 +01:00
}
Add support for plugins to resize images This also adds an event hook to get more metadata of the ImageFile. Such as if it's animated or so.
2014-06-05 11:59:38 +01:00
Event::handle('FillImageFileMetadata', array($this));
Extract image management code to a helper function
2009-01-22 11:35:09 +00:00
}
File width and height is now properly set for File
2014-04-22 11:09:24 +01:00
public static function fromFileObject(File $file)
{
$imgPath = null;
$media = common_get_mime_media($file->mimetype);
if (Event::handle('CreateFileImageThumbnailSource', array($file, &$imgPath, $media))) {
File handling changes for better logic Also prepares for StoreRemoteMediaPlugin, coming up...
2015-10-01 21:14:49 +01:00
if (empty($file->filename) && !file_exists($imgPath)) {
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
throw new UnsupportedMediaException(_m('File without filename could not get a thumbnail source.'));
Unnecessarily spammy logs for getThumbnail() When trying to create thumbnails for remote media that don't have the filename field set, we got a lot of output in the debug log.
2015-01-26 00:16:28 +00:00
}
SVG files can be used as thumbnails I guess
2015-03-05 10:59:11 +00:00
// First some mimetype specific exceptions
switch ($file->mimetype) {
case 'image/svg+xml':
UseFileAsThumbnailException uses direct File object now
2016-05-04 10:34:50 +01:00
throw new UseFileAsThumbnailException($file);
SVG files can be used as thumbnails I guess
2015-03-05 10:59:11 +00:00
}
// And we'll only consider it an image if it has such a media type
File width and height is now properly set for File
2014-04-22 11:09:24 +01:00
switch ($media) {
case 'image':
$imgPath = $file->getPath();
break;
default:
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
throw new UnsupportedMediaException(_m('Unsupported media format.'), $file->getPath());
File width and height is now properly set for File
2014-04-22 11:09:24 +01:00
}
}
if (!file_exists($imgPath)) {
FileNotFoundException is more proper here
2016-07-15 12:19:16 +01:00
throw new FileNotFoundException($imgPath);
File width and height is now properly set for File
2014-04-22 11:09:24 +01:00
}
try {
Default to avoid upscaling of thumbnails. 45x45=>450x450 is ugly
2016-02-10 03:40:10 +00:00
$image = new ImageFile($file->getID(), $imgPath);
Delete successfully generated thumbnail (temporary sources) too.
2016-07-15 11:52:01 +01:00
} catch (Exception $e) {
File width and height is now properly set for File
2014-04-22 11:09:24 +01:00
// Avoid deleting the original
Relatively experimental change to store thumbnails in 'file/thumb/' (by default)
2016-03-07 21:33:34 +00:00
try {
Delete successfully generated thumbnail (temporary sources) too.
2016-07-15 11:52:01 +01:00
if (strlen($imgPath) > 0 && $imgPath !== $file->getPath()) {
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
common_debug(__METHOD__.': Deleting temporary file that was created as image file' .
'thumbnail source: '._ve($imgPath));
Relatively experimental change to store thumbnails in 'file/thumb/' (by default)
2016-03-07 21:33:34 +00:00
@unlink($imgPath);
}
} catch (FileNotFoundException $e) {
// File reported (via getPath) that the original file
// doesn't exist anyway, so it's safe to delete $imgPath
@unlink($imgPath);
File width and height is now properly set for File
2014-04-22 11:09:24 +01:00
}
[FORMATING] Ran php-cs-fixer on lib/mediafile.php, lib/imagefile.php and classes/File.php
2019-06-09 23:26:48 +01:00
common_debug(sprintf(
'Exception %s caught when creating ImageFile for File id==%s ' .
'and imgPath==%s: %s',
get_class($e),
_ve($file->id),
_ve($imgPath),
_ve($e->getMessage())
));
Delete file on class destruction or we do it too quickly Source image was removed when trying to use it for resizeTo
2016-07-20 23:23:27 +01:00
throw $e;
File width and height is now properly set for File
2014-04-22 11:09:24 +01:00
}
return $image;
}
MediaFile thumbnail event hooks + VideoThumbnails plugin The exception thrown from MediaFile will be caught and simply result in no thumbnail at all right now. In the future we might use a catch-all and have a "cannot generate preview"-icon or something. VideoThumbnails requires php5-ffmpeg and php5-gd.
2014-04-16 18:14:26 +01:00
public function getPath()
{
if (!file_exists($this->filepath)) {
Throw more explicit exception in ImageFile
2015-02-25 00:14:27 +00:00
throw new FileNotFoundException($this->filepath);
MediaFile thumbnail event hooks + VideoThumbnails plugin The exception thrown from MediaFile will be caught and simply result in no thumbnail at all right now. In the future we might use a catch-all and have a "cannot generate preview"-icon or something. VideoThumbnails requires php5-ffmpeg and php5-gd.
2014-04-16 18:14:26 +01:00
}
return $this->filepath;
}
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
/**
* Process a file upload
*
* Uses MediaFile's `fromUpload` to do the majority of the work and reencodes the image,
* to mitigate injection attacks.
* @param string $param
* @param Profile|null $scoped
* @return ImageFile|MediaFile
* @throws ClientException
* @throws NoResultException
* @throws NoUploadedMediaException
* @throws ServerException
* @throws UnsupportedMediaException
* @throws UseFileAsThumbnailException
*/
public static function fromUpload(string $param='upload', Profile $scoped = null)
Extract image management code to a helper function
2009-01-22 11:35:09 +00:00
{
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
return parent::fromUpload($param, $scoped);
}
Two different functions for file size Made two different functions for file size in ImageFile; one uses the other. Also, use sprintf() for gettext msgs.
2009-02-05 21:32:58 +00:00
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
/**
* Several obscure file types should be normalized to PNG on resize.
*
* Keeps only PNG, JPEG and GIF
*
* @return int
*/
public function preferredType()
{
// Keep only JPEG and GIF in their orignal format
if ($this->type === IMAGETYPE_JPEG || $this->type === IMAGETYPE_GIF) {
return $this->type;
}
// We don't want to save some formats as they are rare, inefficient and antiquated
// thus we can't guarantee clients will support
// So just save it as PNG
return IMAGETYPE_PNG;
Fixed #1134; Consolidated image scaling functions.
2009-02-05 00:32:15 +00:00
}
Two different functions for file size Made two different functions for file size in ImageFile; one uses the other. Also, use sprintf() for gettext msgs.
2009-02-05 21:32:58 +00:00
Fix for ticket #3007: .bmp avatar uploads weren't being properly converted to PNG in all cases Part of the reported issue was previuosly fixed by dc497ed0 (smaller size images being blanked). This commit fixes the remaining bug with original-size avatars being left as BMP (which could include the 96px size for instance, which could cause problems in browsers not supporting BMP natively) Added ImageFile::copyTo() as a convenient alias for resizeTo() when not resizing; this performs the BMP/XPM/XBM->PNG conversion if needed, or copies the original file. Copying instead of using move_uploaded_file() is fine here since: a) the files are cleaned up on script completion anyway (vs moving to remove it) b) we're already performing getimagesize() and possibly load/resize on the file before this point (vs needing to move the file into a usable area to work with open_basedir restrictions that prevent working directly with uploaded files in the temp dir; since this would fail anyway, we lose nothing) ImageFile::preferredType() now works on $this->type instead of asking for one, to make it handier to use from outside. (This is still needed in order for calling code to generate a target filename.) Recommended for future: * additional consolidation between the various ways of uploading avatars (touched avatarsettings, grouplogo, and apiaccountupdateprofileimage with similar minor changes) * consolidate type checks and file naming into Avatar class
2011-01-24 20:22:47 +00:00
/**
* Copy the image file to the given destination.
Could not update avatar due to Bad Thumbnail parameters
2014-06-17 10:50:42 +01:00
*
* This function may modify the resulting file. Please use the
* returned ImageFile object to read metadata (width, height etc.)
Fix for ticket #3007: .bmp avatar uploads weren't being properly converted to PNG in all cases Part of the reported issue was previuosly fixed by dc497ed0 (smaller size images being blanked). This commit fixes the remaining bug with original-size avatars being left as BMP (which could include the 96px size for instance, which could cause problems in browsers not supporting BMP natively) Added ImageFile::copyTo() as a convenient alias for resizeTo() when not resizing; this performs the BMP/XPM/XBM->PNG conversion if needed, or copies the original file. Copying instead of using move_uploaded_file() is fine here since: a) the files are cleaned up on script completion anyway (vs moving to remove it) b) we're already performing getimagesize() and possibly load/resize on the file before this point (vs needing to move the file into a usable area to work with open_basedir restrictions that prevent working directly with uploaded files in the temp dir; since this would fail anyway, we lose nothing) ImageFile::preferredType() now works on $this->type instead of asking for one, to make it handier to use from outside. (This is still needed in order for calling code to generate a target filename.) Recommended for future: * additional consolidation between the various ways of uploading avatars (touched avatarsettings, grouplogo, and apiaccountupdateprofileimage with similar minor changes) * consolidate type checks and file naming into Avatar class
2011-01-24 20:22:47 +00:00
*
* @param string $outpath
Could not update avatar due to Bad Thumbnail parameters
2014-06-17 10:50:42 +01:00
* @return ImageFile the image stored at target path
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
* @throws ClientException
* @throws NoResultException
* @throws ServerException
* @throws UnsupportedMediaException
* @throws UseFileAsThumbnailException
Fix for ticket #3007: .bmp avatar uploads weren't being properly converted to PNG in all cases Part of the reported issue was previuosly fixed by dc497ed0 (smaller size images being blanked). This commit fixes the remaining bug with original-size avatars being left as BMP (which could include the 96px size for instance, which could cause problems in browsers not supporting BMP natively) Added ImageFile::copyTo() as a convenient alias for resizeTo() when not resizing; this performs the BMP/XPM/XBM->PNG conversion if needed, or copies the original file. Copying instead of using move_uploaded_file() is fine here since: a) the files are cleaned up on script completion anyway (vs moving to remove it) b) we're already performing getimagesize() and possibly load/resize on the file before this point (vs needing to move the file into a usable area to work with open_basedir restrictions that prevent working directly with uploaded files in the temp dir; since this would fail anyway, we lose nothing) ImageFile::preferredType() now works on $this->type instead of asking for one, to make it handier to use from outside. (This is still needed in order for calling code to generate a target filename.) Recommended for future: * additional consolidation between the various ways of uploading avatars (touched avatarsettings, grouplogo, and apiaccountupdateprofileimage with similar minor changes) * consolidate type checks and file naming into Avatar class
2011-01-24 20:22:47 +00:00
*/
[FORMATING] Ran php-cs-fixer on lib/mediafile.php, lib/imagefile.php and classes/File.php
2019-06-09 23:26:48 +01:00
public function copyTo($outpath)
Fix for ticket #3007: .bmp avatar uploads weren't being properly converted to PNG in all cases Part of the reported issue was previuosly fixed by dc497ed0 (smaller size images being blanked). This commit fixes the remaining bug with original-size avatars being left as BMP (which could include the 96px size for instance, which could cause problems in browsers not supporting BMP natively) Added ImageFile::copyTo() as a convenient alias for resizeTo() when not resizing; this performs the BMP/XPM/XBM->PNG conversion if needed, or copies the original file. Copying instead of using move_uploaded_file() is fine here since: a) the files are cleaned up on script completion anyway (vs moving to remove it) b) we're already performing getimagesize() and possibly load/resize on the file before this point (vs needing to move the file into a usable area to work with open_basedir restrictions that prevent working directly with uploaded files in the temp dir; since this would fail anyway, we lose nothing) ImageFile::preferredType() now works on $this->type instead of asking for one, to make it handier to use from outside. (This is still needed in order for calling code to generate a target filename.) Recommended for future: * additional consolidation between the various ways of uploading avatars (touched avatarsettings, grouplogo, and apiaccountupdateprofileimage with similar minor changes) * consolidate type checks and file naming into Avatar class
2011-01-24 20:22:47 +00:00
{
Could not update avatar due to Bad Thumbnail parameters
2014-06-17 10:50:42 +01:00
return new ImageFile(null, $this->resizeTo($outpath));
Fix for ticket #3007: .bmp avatar uploads weren't being properly converted to PNG in all cases Part of the reported issue was previuosly fixed by dc497ed0 (smaller size images being blanked). This commit fixes the remaining bug with original-size avatars being left as BMP (which could include the 96px size for instance, which could cause problems in browsers not supporting BMP natively) Added ImageFile::copyTo() as a convenient alias for resizeTo() when not resizing; this performs the BMP/XPM/XBM->PNG conversion if needed, or copies the original file. Copying instead of using move_uploaded_file() is fine here since: a) the files are cleaned up on script completion anyway (vs moving to remove it) b) we're already performing getimagesize() and possibly load/resize on the file before this point (vs needing to move the file into a usable area to work with open_basedir restrictions that prevent working directly with uploaded files in the temp dir; since this would fail anyway, we lose nothing) ImageFile::preferredType() now works on $this->type instead of asking for one, to make it handier to use from outside. (This is still needed in order for calling code to generate a target filename.) Recommended for future: * additional consolidation between the various ways of uploading avatars (touched avatarsettings, grouplogo, and apiaccountupdateprofileimage with similar minor changes) * consolidate type checks and file naming into Avatar class
2011-01-24 20:22:47 +00:00
}
Break out ImageFile->resizeTo() from ImageFile->resize(); allows resizing images to non-square sizes and to arbitrary destinations. Will be used for creating thumbnails as well as the originala use of cropping/sizing avatars.
2010-11-09 00:51:31 +00:00
/**
* Create and save a thumbnail image.
*
* @param string $outpath
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
* @param array $box width, height, boundary box (x,y,w,h) defaults to full image
Break out ImageFile->resizeTo() from ImageFile->resize(); allows resizing images to non-square sizes and to arbitrary destinations. Will be used for creating thumbnails as well as the originala use of cropping/sizing avatars.
2010-11-09 00:51:31 +00:00
* @return string full local filesystem filename
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
* @throws UnsupportedMediaException
* @throws UseFileAsThumbnailException
Break out ImageFile->resizeTo() from ImageFile->resize(); allows resizing images to non-square sizes and to arbitrary destinations. Will be used for creating thumbnails as well as the originala use of cropping/sizing avatars.
2010-11-09 00:51:31 +00:00
*/
[FORMATING] Ran php-cs-fixer on lib/mediafile.php, lib/imagefile.php and classes/File.php
2019-06-09 23:26:48 +01:00
public function resizeTo($outpath, array $box=array())
Fixed #1134; Consolidated image scaling functions.
2009-02-05 00:32:15 +00:00
{
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
$box['width'] = isset($box['width']) ? intval($box['width']) : $this->width;
Add support for plugins to resize images This also adds an event hook to get more metadata of the ImageFile. Such as if it's animated or so.
2014-06-05 11:59:38 +01:00
$box['height'] = isset($box['height']) ? intval($box['height']) : $this->height;
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
$box['x'] = isset($box['x']) ? intval($box['x']) : 0;
$box['y'] = isset($box['y']) ? intval($box['y']) : 0;
$box['w'] = isset($box['w']) ? intval($box['w']) : $this->width;
$box['h'] = isset($box['h']) ? intval($box['h']) : $this->height;
Add support for plugins to resize images This also adds an event hook to get more metadata of the ImageFile. Such as if it's animated or so.
2014-06-05 11:59:38 +01:00
Fixed #1134; Consolidated image scaling functions.
2009-02-05 00:32:15 +00:00
if (!file_exists($this->filepath)) {
* fix some i18n and L10n issues * update/add translator documentation * remove superfluous whitespace
2011-01-28 23:33:13 +00:00
// TRANS: Exception thrown during resize when image has been registered as present, but is no longer there.
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
throw new Exception(_m('Lost our file.'));
Fixed #1134; Consolidated image scaling functions.
2009-02-05 00:32:15 +00:00
}
whitespace and formatting
2009-02-09 17:06:06 +00:00
Could not update avatar due to Bad Thumbnail parameters
2014-06-17 10:50:42 +01:00
// Don't rotate/crop/scale if it isn't necessary
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
if ($box['width'] === $this->width
&& $box['height'] === $this->height
&& $box['x'] === 0
&& $box['y'] === 0
&& $box['w'] === $this->width
&& $box['h'] === $this->height
&& $this->type === $this->preferredType()) {
if (abs($this->rotate) == 90) {
Could not update avatar due to Bad Thumbnail parameters
2014-06-17 10:50:42 +01:00
// Box is rotated 90 degrees in either direction,
// so we have to redefine x to y and vice versa.
$tmp = $box['width'];
$box['width'] = $box['height'];
$box['height'] = $tmp;
$tmp = $box['x'];
$box['x'] = $box['y'];
$box['y'] = $tmp;
$tmp = $box['w'];
$box['w'] = $box['h'];
$box['h'] = $tmp;
}
Fixed #1152: Needless image scaling and poor JPG quality
2009-02-07 15:01:08 +00:00
}
Fixed #1134; Consolidated image scaling functions.
2009-02-05 00:32:15 +00:00
Add support for plugins to resize images This also adds an event hook to get more metadata of the ImageFile. Such as if it's animated or so.
2014-06-05 11:59:38 +01:00
if (Event::handle('StartResizeImageFile', array($this, $outpath, $box))) {
$this->resizeToFile($outpath, $box);
}
UseFileAsThumbnailException (helps support GIFs)
2014-06-17 10:54:05 +01:00
if (!file_exists($outpath)) {
UseFileAsThumbnailException uses direct File object now
2016-05-04 10:34:50 +01:00
if ($this->fileRecord instanceof File) {
throw new UseFileAsThumbnailException($this->fileRecord);
} else {
throw new UnsupportedMediaException('No local File object exists for ImageFile.');
}
UseFileAsThumbnailException (helps support GIFs)
2014-06-17 10:54:05 +01:00
}
Add support for plugins to resize images This also adds an event hook to get more metadata of the ImageFile. Such as if it's animated or so.
2014-06-05 11:59:38 +01:00
return $outpath;
}
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
/**
* Resizes a file. If $box is omitted, the size is not changed, but this is still useful,
* because it will reencode the image in the `self::prefferedType()` format. This only
* applies henceforward, not retroactively
*
* Increases the 'memory_limit' to the one in the 'attachments' section in the config, to
* enable the handling of bigger images, which can cause a peak of memory consumption, while
* encoding
* @param $outpath
* @param array $box
* @throws Exception
*/
Add support for plugins to resize images This also adds an event hook to get more metadata of the ImageFile. Such as if it's animated or so.
2014-06-05 11:59:38 +01:00
protected function resizeToFile($outpath, array $box)
{
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
$old_limit = ini_set('memory_limit', common_config('attachments', 'memory_limit'));
$image_src = null;
Fixed #1134; Consolidated image scaling functions.
2009-02-05 00:32:15 +00:00
switch ($this->type) {
Add support for plugins to resize images This also adds an event hook to get more metadata of the ImageFile. Such as if it's animated or so.
2014-06-05 11:59:38 +01:00
case IMAGETYPE_GIF:
Fixed #1134; Consolidated image scaling functions.
2009-02-05 00:32:15 +00:00
$image_src = imagecreatefromgif($this->filepath);
Extract image management code to a helper function
2009-01-22 11:35:09 +00:00
break;
Add support for plugins to resize images This also adds an event hook to get more metadata of the ImageFile. Such as if it's animated or so.
2014-06-05 11:59:38 +01:00
case IMAGETYPE_JPEG:
Fixed #1134; Consolidated image scaling functions.
2009-02-05 00:32:15 +00:00
$image_src = imagecreatefromjpeg($this->filepath);
break;
Add support for plugins to resize images This also adds an event hook to get more metadata of the ImageFile. Such as if it's animated or so.
2014-06-05 11:59:38 +01:00
case IMAGETYPE_PNG:
Fixed #1134; Consolidated image scaling functions.
2009-02-05 00:32:15 +00:00
$image_src = imagecreatefrompng($this->filepath);
break;
Add support for plugins to resize images This also adds an event hook to get more metadata of the ImageFile. Such as if it's animated or so.
2014-06-05 11:59:38 +01:00
case IMAGETYPE_BMP:
add image support for xbm, xpm, wbmp, and bmp image formats
2010-02-25 03:24:11 +00:00
$image_src = imagecreatefrombmp($this->filepath);
break;
Add support for plugins to resize images This also adds an event hook to get more metadata of the ImageFile. Such as if it's animated or so.
2014-06-05 11:59:38 +01:00
case IMAGETYPE_WBMP:
add image support for xbm, xpm, wbmp, and bmp image formats
2010-02-25 03:24:11 +00:00
$image_src = imagecreatefromwbmp($this->filepath);
break;
Add support for plugins to resize images This also adds an event hook to get more metadata of the ImageFile. Such as if it's animated or so.
2014-06-05 11:59:38 +01:00
case IMAGETYPE_XBM:
add image support for xbm, xpm, wbmp, and bmp image formats
2010-02-25 03:24:11 +00:00
$image_src = imagecreatefromxbm($this->filepath);
break;
Add support for plugins to resize images This also adds an event hook to get more metadata of the ImageFile. Such as if it's animated or so.
2014-06-05 11:59:38 +01:00
default:
* fix some i18n and L10n issues * update/add translator documentation * remove superfluous whitespace
2011-01-28 23:33:13 +00:00
// TRANS: Exception thrown when trying to resize an unknown file type.
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
throw new Exception(_m('Unknown file type'));
Fixed #1134; Consolidated image scaling functions.
2009-02-05 00:32:15 +00:00
}
File_thumbnail fixes (run scripts/upgrade.php) We're now capable of doing image rotation for thumbnails based on EXIF orientation data. Also, thumbnails are tracked by filenames and thus we can delete them from storage when we feel like it.
2014-05-12 13:33:41 +01:00
if ($this->rotate != 0) {
$image_src = imagerotate($image_src, $this->rotate, 0);
}
Add support for plugins to resize images This also adds an event hook to get more metadata of the ImageFile. Such as if it's animated or so.
2014-06-05 11:59:38 +01:00
$image_dest = imagecreatetruecolor($box['width'], $box['height']);
Two different functions for file size Made two different functions for file size in ImageFile; one uses the other. Also, use sprintf() for gettext msgs.
2009-02-05 21:32:58 +00:00
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
if ($this->type == IMAGETYPE_PNG || $this->type == IMAGETYPE_BMP) {
Fixed #1134; Consolidated image scaling functions.
2009-02-05 00:32:15 +00:00
$transparent_idx = imagecolortransparent($image_src);
Two different functions for file size Made two different functions for file size in ImageFile; one uses the other. Also, use sprintf() for gettext msgs.
2009-02-05 21:32:58 +00:00
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
if ($transparent_idx >= 0 && $transparent_idx < 255) {
Fixed #1134; Consolidated image scaling functions.
2009-02-05 00:32:15 +00:00
$transparent_color = imagecolorsforindex($image_src, $transparent_idx);
[FORMATING] Ran php-cs-fixer on lib/mediafile.php, lib/imagefile.php and classes/File.php
2019-06-09 23:26:48 +01:00
$transparent_idx = imagecolorallocate(
$image_dest,
$transparent_color['red'],
$transparent_color['green'],
$transparent_color['blue']
);
Fixed #1134; Consolidated image scaling functions.
2009-02-05 00:32:15 +00:00
imagefill($image_dest, 0, 0, $transparent_idx);
imagecolortransparent($image_dest, $transparent_idx);
} elseif ($this->type == IMAGETYPE_PNG) {
imagealphablending($image_dest, false);
$transparent = imagecolorallocatealpha($image_dest, 0, 0, 0, 127);
imagefill($image_dest, 0, 0, $transparent);
imagesavealpha($image_dest, true);
}
}
[FORMATING] Ran php-cs-fixer on lib/mediafile.php, lib/imagefile.php and classes/File.php
2019-06-09 23:26:48 +01:00
imagecopyresampled(
$image_dest,
$image_src,
0,
0,
$box['x'],
$box['y'],
$box['width'],
$box['height'],
$box['w'],
$box['h']
);
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
$type = $this->preferredType();
$ext = image_type_to_extension($type, true);
$outpath = preg_replace("/\.[^\.]+$/", $ext, $outpath);
Fixed #1134; Consolidated image scaling functions.
2009-02-05 00:32:15 +00:00
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
switch ($type) {
Fixed #1134; Consolidated image scaling functions.
2009-02-05 00:32:15 +00:00
case IMAGETYPE_GIF:
imagegif($image_dest, $outpath);
break;
case IMAGETYPE_JPEG:
Properly unlink all old avatars when deleting/uploading a new We're also now using $config['image']['jpegquality'] to determine the quality setting for resized images. To set Avatar max size, adjust $config['avatar']['maxsize'] The getAvatar call now throws exceptions too. Related changes applied. Now let's move Profile->avatarUrl to the Avatar class!
2013-10-01 10:37:59 +01:00
imagejpeg($image_dest, $outpath, common_config('image', 'jpegquality'));
Fixed #1134; Consolidated image scaling functions.
2009-02-05 00:32:15 +00:00
break;
case IMAGETYPE_PNG:
imagepng($image_dest, $outpath);
break;
default:
* fix some i18n and L10n issues * update/add translator documentation * remove superfluous whitespace
2011-01-28 23:33:13 +00:00
// TRANS: Exception thrown when trying resize an unknown file type.
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
throw new Exception(_m('Unknown file type'));
Extract image management code to a helper function
2009-01-22 11:35:09 +00:00
}
whitespace and formatting
2009-02-09 17:06:06 +00:00
Fixed #1152: Needless image scaling and poor JPG quality
2009-02-07 15:01:08 +00:00
imagedestroy($image_src);
imagedestroy($image_dest);
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
ini_set('memory_limit', $old_limit); // Restore the old memory limit
Break out ImageFile->resizeTo() from ImageFile->resize(); allows resizing images to non-square sizes and to arbitrary destinations. Will be used for creating thumbnails as well as the originala use of cropping/sizing avatars.
2010-11-09 00:51:31 +00:00
}
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
public function unlink()
Extract image management code to a helper function
2009-01-22 11:35:09 +00:00
{
ImageFile unlink function referenced bad path
2014-04-16 19:08:21 +01:00
@unlink($this->filepath);
Extract image management code to a helper function
2009-01-22 11:35:09 +00:00
}
Two different functions for file size Made two different functions for file size in ImageFile; one uses the other. Also, use sprintf() for gettext msgs.
2009-02-05 21:32:58 +00:00
Dynamically generate thumbnails (see full text) The File object now stores width and height of files that can supply this kind of information. Formats which we can not read natively in PHP do not currently benefit from this. However an event hook will be introduced later. The CreateFileImageThumbnail event is renamed to: CreateFileImageThumbnailSource to clarify that the hooks should not generate their own thumbnails but only the source image. Also it now accepts File objects, not MediaFile objects. The thumbnail generation is documented in the source code. For developers, call 'getThumbnail' on a File object and hope for the best. Default thumbnail sizes have increased to be more appealing.
2014-04-21 19:39:28 +01:00
public function scaleToFit($maxWidth=null, $maxHeight=null, $crop=null)
{
[FORMATING] Ran php-cs-fixer on lib/mediafile.php, lib/imagefile.php and classes/File.php
2019-06-09 23:26:48 +01:00
return self::getScalingValues(
$this->width,
$this->height,
$maxWidth,
$maxHeight,
$crop,
$this->rotate
);
Dynamically generate thumbnails (see full text) The File object now stores width and height of files that can supply this kind of information. Formats which we can not read natively in PHP do not currently benefit from this. However an event hook will be introduced later. The CreateFileImageThumbnail event is renamed to: CreateFileImageThumbnailSource to clarify that the hooks should not generate their own thumbnails but only the source image. Also it now accepts File objects, not MediaFile objects. The thumbnail generation is documented in the source code. For developers, call 'getThumbnail' on a File object and hope for the best. Default thumbnail sizes have increased to be more appealing.
2014-04-21 19:39:28 +01:00
}
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
/**
Dynamically generate thumbnails (see full text) The File object now stores width and height of files that can supply this kind of information. Formats which we can not read natively in PHP do not currently benefit from this. However an event hook will be introduced later. The CreateFileImageThumbnail event is renamed to: CreateFileImageThumbnailSource to clarify that the hooks should not generate their own thumbnails but only the source image. Also it now accepts File objects, not MediaFile objects. The thumbnail generation is documented in the source code. For developers, call 'getThumbnail' on a File object and hope for the best. Default thumbnail sizes have increased to be more appealing.
2014-04-21 19:39:28 +01:00
* Gets scaling values for images of various types. Cropping can be enabled.
*
* Values will scale _up_ to fit max values if cropping is enabled!
* With cropping disabled, the max value of each axis will be respected.
*
* @param $width int Original width
* @param $height int Original height
* @param $maxW int Resulting max width
* @param $maxH int Resulting max height
* @param $crop int Crop to the size (not preserving aspect ratio)
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
* @param int $rotate
* @return array
* @throws ServerException
Dynamically generate thumbnails (see full text) The File object now stores width and height of files that can supply this kind of information. Formats which we can not read natively in PHP do not currently benefit from this. However an event hook will be introduced later. The CreateFileImageThumbnail event is renamed to: CreateFileImageThumbnailSource to clarify that the hooks should not generate their own thumbnails but only the source image. Also it now accepts File objects, not MediaFile objects. The thumbnail generation is documented in the source code. For developers, call 'getThumbnail' on a File object and hope for the best. Default thumbnail sizes have increased to be more appealing.
2014-04-21 19:39:28 +01:00
*/
[FORMATING] Ran php-cs-fixer on lib/mediafile.php, lib/imagefile.php and classes/File.php
2019-06-09 23:26:48 +01:00
public static function getScalingValues(
$width,
$height,
$maxW=null,
$maxH=null,
$crop=null,
$rotate=0
) {
Dynamically generate thumbnails (see full text) The File object now stores width and height of files that can supply this kind of information. Formats which we can not read natively in PHP do not currently benefit from this. However an event hook will be introduced later. The CreateFileImageThumbnail event is renamed to: CreateFileImageThumbnailSource to clarify that the hooks should not generate their own thumbnails but only the source image. Also it now accepts File objects, not MediaFile objects. The thumbnail generation is documented in the source code. For developers, call 'getThumbnail' on a File object and hope for the best. Default thumbnail sizes have increased to be more appealing.
2014-04-21 19:39:28 +01:00
$maxW = $maxW ?: common_config('thumbnail', 'width');
$maxH = $maxH ?: common_config('thumbnail', 'height');
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
Dynamically generate thumbnails (see full text) The File object now stores width and height of files that can supply this kind of information. Formats which we can not read natively in PHP do not currently benefit from this. However an event hook will be introduced later. The CreateFileImageThumbnail event is renamed to: CreateFileImageThumbnailSource to clarify that the hooks should not generate their own thumbnails but only the source image. Also it now accepts File objects, not MediaFile objects. The thumbnail generation is documented in the source code. For developers, call 'getThumbnail' on a File object and hope for the best. Default thumbnail sizes have increased to be more appealing.
2014-04-21 19:39:28 +01:00
if ($maxW < 1 || ($maxH !== null && $maxH < 1)) {
throw new ServerException('Bad parameters for ImageFile::getScalingValues');
} elseif ($maxH === null) {
// if maxH is null, we set maxH to equal maxW and enable crop
$maxH = $maxW;
$crop = true;
}
File_thumbnail fixes (run scripts/upgrade.php) We're now capable of doing image rotation for thumbnails based on EXIF orientation data. Also, thumbnails are tracked by filenames and thus we can delete them from storage when we feel like it.
2014-05-12 13:33:41 +01:00
// Because GD doesn't understand EXIF orientation etc.
if (abs($rotate) == 90) {
$tmp = $width;
$width = $height;
$height = $tmp;
}
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
Dynamically generate thumbnails (see full text) The File object now stores width and height of files that can supply this kind of information. Formats which we can not read natively in PHP do not currently benefit from this. However an event hook will be introduced later. The CreateFileImageThumbnail event is renamed to: CreateFileImageThumbnailSource to clarify that the hooks should not generate their own thumbnails but only the source image. Also it now accepts File objects, not MediaFile objects. The thumbnail generation is documented in the source code. For developers, call 'getThumbnail' on a File object and hope for the best. Default thumbnail sizes have increased to be more appealing.
2014-04-21 19:39:28 +01:00
// Cropping data (for original image size). Default values, 0 and null,
// imply no cropping and with preserved aspect ratio (per axis).
$cx = 0; // crop x
$cy = 0; // crop y
$cw = null; // crop area width
$ch = null; // crop area height
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
Dynamically generate thumbnails (see full text) The File object now stores width and height of files that can supply this kind of information. Formats which we can not read natively in PHP do not currently benefit from this. However an event hook will be introduced later. The CreateFileImageThumbnail event is renamed to: CreateFileImageThumbnailSource to clarify that the hooks should not generate their own thumbnails but only the source image. Also it now accepts File objects, not MediaFile objects. The thumbnail generation is documented in the source code. For developers, call 'getThumbnail' on a File object and hope for the best. Default thumbnail sizes have increased to be more appealing.
2014-04-21 19:39:28 +01:00
if ($crop) {
$s_ar = $width / $height;
$t_ar = $maxW / $maxH;
$rw = $maxW;
$rh = $maxH;
// Source aspect ratio differs from target, recalculate crop points!
if ($s_ar > $t_ar) {
$cx = floor($width / 2 - $height * $t_ar / 2);
$cw = ceil($height * $t_ar);
} elseif ($s_ar < $t_ar) {
$cy = floor($height / 2 - $width / $t_ar / 2);
$ch = ceil($width / $t_ar);
}
} else {
$rw = $maxW;
$rh = ceil($height * $rw / $width);
// Scaling caused too large height, decrease to max accepted value
if ($rh > $maxH) {
$rh = $maxH;
$rw = ceil($width * $rh / $height);
}
}
return array(intval($rw), intval($rh),
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
intval($cx), intval($cy),
is_null($cw) ? $width : intval($cw),
is_null($ch) ? $height : intval($ch));
Dynamically generate thumbnails (see full text) The File object now stores width and height of files that can supply this kind of information. Formats which we can not read natively in PHP do not currently benefit from this. However an event hook will be introduced later. The CreateFileImageThumbnail event is renamed to: CreateFileImageThumbnailSource to clarify that the hooks should not generate their own thumbnails but only the source image. Also it now accepts File objects, not MediaFile objects. The thumbnail generation is documented in the source code. For developers, call 'getThumbnail' on a File object and hope for the best. Default thumbnail sizes have increased to be more appealing.
2014-04-21 19:39:28 +01:00
}
No need for ImageMagick to detected animated GIF
2015-01-25 21:45:25 +00:00
/**
* Animated GIF test, courtesy of frank at huddler dot com et al:
* http://php.net/manual/en/function.imagecreatefromgif.php#104473
* Modified so avoid landing inside of a header (and thus not matching our regexp).
*/
protected function isAnimatedGif()
{
if (!($fh = @fopen($this->filepath, 'rb'))) {
return false;
}
$count = 0;
//an animated gif contains multiple "frames", with each frame having a
//header made up of:
// * a static 4-byte sequence (\x00\x21\xF9\x04)
// * 4 variable bytes
// * a static 2-byte sequence (\x00\x2C)
// In total the header is maximum 10 bytes.
// We read through the file til we reach the end of the file, or we've found
// at least 2 frame headers
[FORMATING] Ran php-cs-fixer on lib/mediafile.php, lib/imagefile.php and classes/File.php
2019-06-09 23:26:48 +01:00
while (!feof($fh) && $count < 2) {
No need for ImageMagick to detected animated GIF
2015-01-25 21:45:25 +00:00
$chunk = fread($fh, 1024 * 100); //read 100kb at a time
$count += preg_match_all('#\x00\x21\xF9\x04.{4}\x00\x2C#s', $chunk, $matches);
// rewind in case we ended up in the middle of the header, but avoid
// infinite loop (i.e. don't rewind if we're already in the end).
if (!feof($fh) && ftell($fh) >= 9) {
fseek($fh, -9, SEEK_CUR);
}
}
fclose($fh);
2-frame GIF animations weren't recognised as animated
2016-05-04 10:57:55 +01:00
return $count >= 1; // number of animated frames apart from the original image
No need for ImageMagick to detected animated GIF
2015-01-25 21:45:25 +00:00
}
Move thumbnail algorithm mainly to ImageFile class
2015-03-04 12:12:42 +00:00
Default to avoid upscaling of thumbnails. 45x45=>450x450 is ugly
2016-02-10 03:40:10 +00:00
public function getFileThumbnail($width, $height, $crop, $upscale=false)
Move thumbnail algorithm mainly to ImageFile class
2015-03-04 12:12:42 +00:00
{
if (!$this->fileRecord instanceof File) {
throw new ServerException('No File object attached to this ImageFile object.');
}
if ($width === null) {
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
$width = common_config('thumbnail', 'width');
Move thumbnail algorithm mainly to ImageFile class
2015-03-04 12:12:42 +00:00
$height = common_config('thumbnail', 'height');
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
$crop = common_config('thumbnail', 'crop');
Move thumbnail algorithm mainly to ImageFile class
2015-03-04 12:12:42 +00:00
}
Default to avoid upscaling of thumbnails. 45x45=>450x450 is ugly
2016-02-10 03:40:10 +00:00
if (!$upscale) {
if ($width > $this->width) {
$width = $this->width;
}
if (!is_null($height) && $height > $this->height) {
$height = $this->height;
}
}
Move thumbnail algorithm mainly to ImageFile class
2015-03-04 12:12:42 +00:00
if ($height === null) {
$height = $width;
$crop = true;
}
// Get proper aspect ratio width and height before lookup
// We have to do it through an ImageFile object because of orientation etc.
// Only other solution would've been to rotate + rewrite uploaded files
// which we don't want to do because we like original, untouched data!
list($width, $height, $x, $y, $w, $h) = $this->scaleToFit($width, $height, $crop);
$thumb = File_thumbnail::pkeyGet(array(
Delete file on class destruction or we do it too quickly Source image was removed when trying to use it for resizeTo
2016-07-20 23:23:27 +01:00
'file_id'=> $this->fileRecord->getID(),
Move thumbnail algorithm mainly to ImageFile class
2015-03-04 12:12:42 +00:00
'width' => $width,
'height' => $height,
[MEDIA] ImageFile now extends MediaFile and validates images more aggressively. Default supported files need to use consistent names. Bumped version to 1.20.0 ImageFile has been changed to extend MediaFile and rely on it to partially validate files. This validation has been extended to not rely solely on Fileinfo, as it is disabled on some places. Now it'll try to use the shell command `file`, if Fileinfo isn't available. ImageFile now converts every new upload to PNG, except JPEG and GIF, which are kept, but still resized (to the same size), to remove possible scripts embedded therein. MediaFile::fromUpload will return an ImageFile if the uploaded file is an image or a MediaFile otherwise. MediaFile can be constructed with an id with value -1 to denote a temporary object, which is not added to the DB. This is useful to create a temporary object for representing images, so it can be used to rescale them. The supported attachment array needs to be populated with the result of calling `image_type_to_extension` for the appropriate image type, in the case of images. This is important so all parts of the code see the same extension for each image type (jpg vs jpeg). Added documentation to classes/File.php and to lib/MediaFile and lib/ImageFile
2019-06-07 14:08:27 +01:00
));
Move thumbnail algorithm mainly to ImageFile class
2015-03-04 12:12:42 +00:00
if ($thumb instanceof File_thumbnail) {
return $thumb;
}
$filename = $this->fileRecord->filehash ?: $this->filename; // Remote files don't have $this->filehash
$extension = File::guessMimeExtension($this->mimetype);
Delete file on class destruction or we do it too quickly Source image was removed when trying to use it for resizeTo
2016-07-20 23:23:27 +01:00
$outname = "thumb-{$this->fileRecord->getID()}-{$width}x{$height}-{$filename}." . $extension;
Move thumbnail algorithm mainly to ImageFile class
2015-03-04 12:12:42 +00:00
$outpath = File_thumbnail::path($outname);
// The boundary box for our resizing
$box = array('width'=>$width, 'height'=>$height,
'x'=>$x, 'y'=>$y,
'w'=>$w, 'h'=>$h);
// Doublecheck that parameters are sane and integers.
if ($box['width'] < 1 || $box['width'] > common_config('thumbnail', 'maxsize')
|| $box['height'] < 1 || $box['height'] > common_config('thumbnail', 'maxsize')
|| $box['w'] < 1 || $box['x'] >= $this->width
|| $box['h'] < 1 || $box['y'] >= $this->height) {
// Fail on bad width parameter. If this occurs, it's due to algorithm in ImageFile->scaleToFit
[FORMATING] Ran php-cs-fixer on lib/mediafile.php, lib/imagefile.php and classes/File.php
2019-06-09 23:26:48 +01:00
common_debug("Boundary box parameters for resize of {$this->filepath} : ".var_export($box, true));
Move thumbnail algorithm mainly to ImageFile class
2015-03-04 12:12:42 +00:00
throw new ServerException('Bad thumbnail size parameters.');
}
[FORMATING] Ran php-cs-fixer on lib/mediafile.php, lib/imagefile.php and classes/File.php
2019-06-09 23:26:48 +01:00
common_debug(sprintf(
'Generating a thumbnail of File id==%u of size %ux%u',
$this->fileRecord->getID(),
$width,
$height
));
Move thumbnail algorithm mainly to ImageFile class
2015-03-04 12:12:42 +00:00
// Perform resize and store into file
$this->resizeTo($outpath, $box);
Relatively experimental change to store thumbnails in 'file/thumb/' (by default)
2016-03-07 21:33:34 +00:00
try {
// Avoid deleting the original
if (!in_array($this->getPath(), [File::path($this->filename), File_thumbnail::path($this->filename)])) {
$this->unlink();
}
} catch (FileNotFoundException $e) {
// $this->getPath() says the file doesn't exist anyway, so no point in trying to delete it!
Move thumbnail algorithm mainly to ImageFile class
2015-03-04 12:12:42 +00:00
}
Relatively experimental change to store thumbnails in 'file/thumb/' (by default)
2016-03-07 21:33:34 +00:00
[FORMATING] Ran php-cs-fixer on lib/mediafile.php, lib/imagefile.php and classes/File.php
2019-06-09 23:26:48 +01:00
return File_thumbnail::saveThumbnail(
$this->fileRecord->getID(),
[MEDIA][UI] In case an attachment preview isn't possible, the name is displayed anyway
2019-06-16 00:41:54 +01:00
// no url since we generated it ourselves and can dynamically
// generate the url
null,
[FORMATING] Ran php-cs-fixer on lib/mediafile.php, lib/imagefile.php and classes/File.php
2019-06-09 23:26:48 +01:00
$width,
$height,
$outname
);
Move thumbnail algorithm mainly to ImageFile class
2015-03-04 12:12:42 +00:00
}
add image support for xbm, xpm, wbmp, and bmp image formats
2010-02-25 03:24:11 +00:00
}
Copy Permalink