1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
|
require_relative 'fastimage_parsing/image_base'
require_relative 'fastimage_parsing/stream_util'
require_relative 'fastimage_parsing/avif'
require_relative 'fastimage_parsing/bmp'
require_relative 'fastimage_parsing/exif'
require_relative 'fastimage_parsing/fiber_stream'
require_relative 'fastimage_parsing/gif'
require_relative 'fastimage_parsing/heic'
require_relative 'fastimage_parsing/ico'
require_relative 'fastimage_parsing/iso_bmff'
require_relative 'fastimage_parsing/jpeg'
require_relative 'fastimage_parsing/jxl'
require_relative 'fastimage_parsing/jxlc'
require_relative 'fastimage_parsing/png'
require_relative 'fastimage_parsing/psd'
require_relative 'fastimage_parsing/svg'
require_relative 'fastimage_parsing/tiff'
require_relative 'fastimage_parsing/type_parser'
require_relative 'fastimage_parsing/webp'
class FastImage
include FastImageParsing
attr_reader :bytes_read
class FastImageException < StandardError # :nodoc:
end
class UnknownImageType < FastImageException # :nodoc:
end
class ImageFetchFailure < FastImageException # :nodoc:
end
class SizeNotFound < FastImageException # :nodoc:
end
class CannotParseImage < FastImageException # :nodoc:
end
class BadImageURI < FastImageException # :nodoc:
end
DefaultTimeout = 2 unless const_defined?(:DefaultTimeout)
LocalFileChunkSize = 256 unless const_defined?(:LocalFileChunkSize)
private
Parsers = {
:bmp => Bmp,
:gif => Gif,
:jpeg => Jpeg,
:png => Png,
:tiff => Tiff,
:psd => Psd,
:heic => Heic,
:heif => Heic,
:webp => Webp,
:svg => Svg,
:ico => Ico,
:cur => Ico,
:jxl => Jxl,
:avif => Avif
}.freeze
public
SUPPORTED_IMAGE_TYPES = Parsers.keys.freeze
# Returns an array containing the width and height of the image.
# It will return nil if the image could not be fetched, or if the image type was not recognised.
#
# By default there is a timeout of 2 seconds for opening and reading from a remote server.
# This can be changed by passing a :timeout => number_of_seconds in the options.
#
# If you wish FastImage to raise if it cannot size the image for any reason, then pass
# :raise_on_failure => true in the options.
#
# FastImage knows about GIF, JPEG, BMP, TIFF, ICO, CUR, PNG, HEIC/HEIF, AVIF, PSD, SVG, WEBP and JXL files.
#
# === Example
#
# require 'fastimage'
#
# FastImage.size("https://switchstep.com/images/ios.gif")
# => [196, 283]
# FastImage.size("http://switchstep.com/images/ss_logo.png")
# => [300, 300]
# FastImage.size("https://upload.wikimedia.org/wikipedia/commons/0/09/Jpeg_thumb_artifacts_test.jpg")
# => [1280, 800]
# FastImage.size("https://eeweb.engineering.nyu.edu/~yao/EL5123/image/lena_gray.bmp")
# => [512, 512]
# FastImage.size("test/fixtures/test.jpg")
# => [882, 470]
# FastImage.size("http://switchstep.com/does_not_exist")
# => nil
# FastImage.size("http://switchstep.com/does_not_exist", :raise_on_failure=>true)
# => raises FastImage::ImageFetchFailure
# FastImage.size("http://switchstep.com/images/favicon.ico", :raise_on_failure=>true)
# => [16, 16]
# FastImage.size("http://switchstep.com/foo.ics", :raise_on_failure=>true)
# => raises FastImage::UnknownImageType
# FastImage.size("http://switchstep.com/images/favicon.ico", :raise_on_failure=>true, :timeout=>0.01)
# => raises FastImage::ImageFetchFailure
# FastImage.size("http://switchstep.com/images/faulty.jpg", :raise_on_failure=>true)
# => raises FastImage::SizeNotFound
#
# === Supported options
# [:timeout]
# Overrides the default timeout of 2 seconds. Applies both to reading from and opening the http connection.
# [:raise_on_failure]
# If set to true causes an exception to be raised if the image size cannot be found for any reason.
#
def self.size(uri, options={})
new(uri, options).size
end
# Returns an symbol indicating the image type fetched from a uri.
# It will return nil if the image could not be fetched, or if the image type was not recognised.
#
# By default there is a timeout of 2 seconds for opening and reading from a remote server.
# This can be changed by passing a :timeout => number_of_seconds in the options.
#
# If you wish FastImage to raise if it cannot find the type of the image for any reason, then pass
# :raise_on_failure => true in the options.
#
# === Example
#
# require 'fastimage'
#
# FastImage.type("https://switchstep.com/images/ios.gif")
# => :gif
# FastImage.type("http://switchstep.com/images/ss_logo.png")
# => :png
# FastImage.type("https://upload.wikimedia.org/wikipedia/commons/0/09/Jpeg_thumb_artifacts_test.jpg")
# => :jpeg
# FastImage.type("https://eeweb.engineering.nyu.edu/~yao/EL5123/image/lena_gray.bmp")
# => :bmp
# FastImage.type("test/fixtures/test.jpg")
# => :jpeg
# FastImage.type("http://switchstep.com/does_not_exist")
# => nil
# File.open("/some/local/file.gif", "r") {|io| FastImage.type(io)}
# => :gif
# FastImage.type("test/fixtures/test.tiff")
# => :tiff
# FastImage.type("test/fixtures/test.psd")
# => :psd
#
# === Supported options
# [:timeout]
# Overrides the default timeout of 2 seconds. Applies both to reading from and opening the http connection.
# [:raise_on_failure]
# If set to true causes an exception to be raised if the image type cannot be found for any reason.
#
def self.type(uri, options={})
new(uri, options).type
end
# Returns a boolean value indicating the image is animated.
# It will return nil if the image could not be fetched, or if the image type was not recognised.
#
# By default there is a timeout of 2 seconds for opening and reading from a remote server.
# This can be changed by passing a :timeout => number_of_seconds in the options.
#
# If you wish FastImage to raise if it cannot find the type of the image for any reason, then pass
# :raise_on_failure => true in the options.
#
# === Example
#
# require 'fastimage'
#
# FastImage.animated?("test/fixtures/test.gif")
# => false
# FastImage.animated?("test/fixtures/animated.gif")
# => true
#
# === Supported options
# [:timeout]
# Overrides the default timeout of 2 seconds. Applies both to reading from and opening the http connection.
# [:raise_on_failure]
# If set to true causes an exception to be raised if the image type cannot be found for any reason.
#
def self.animated?(uri, options={})
new(uri, options).animated
end
def initialize(uri, options={})
@uri = uri
@options = {
:timeout => DefaultTimeout,
:raise_on_failure => false,
:proxy => nil,
:http_header => {}
}.merge(options)
end
def type
@property = :type
fetch unless defined?(@type)
@type
end
def size
@property = :size
begin
fetch unless defined?(@size)
rescue CannotParseImage
end
raise SizeNotFound if @options[:raise_on_failure] && !@size
@size
end
def orientation
size unless defined?(@size)
@orientation ||= 1 if @size
end
def width
size && @size[0]
end
def height
size && @size[1]
end
def animated
@property = :animated
fetch unless defined?(@animated)
@animated
end
def content_length
@property = :content_length
fetch unless defined?(@content_length)
@content_length
end
# find an appropriate method to fetch the image according to the passed parameter
def fetch
raise BadImageURI if @uri.nil?
if @uri.respond_to?(:read)
fetch_using_read(@uri)
elsif @uri.start_with?('data:')
fetch_using_base64(@uri)
else
begin
@parsed_uri = URI.parse(@uri)
rescue URI::InvalidURIError
fetch_using_file_open
else
if @parsed_uri.scheme == "http" || @parsed_uri.scheme == "https"
fetch_using_http
else
fetch_using_file_open
end
end
end
raise SizeNotFound if @options[:raise_on_failure] && @property == :size && !@size
rescue Timeout::Error, SocketError, Errno::ECONNREFUSED, Errno::EHOSTUNREACH, Errno::ECONNRESET,
Errno::ENETUNREACH, ImageFetchFailure, Net::HTTPBadResponse, EOFError, Errno::ENOENT,
OpenSSL::SSL::SSLError
raise ImageFetchFailure if @options[:raise_on_failure]
rescue UnknownImageType, BadImageURI, CannotParseImage
raise if @options[:raise_on_failure]
ensure
@uri.rewind if @uri.respond_to?(:rewind)
end
private
def fetch_using_http
@redirect_count = 0
fetch_using_http_from_parsed_uri
end
# Some invalid locations need escaping
def escaped_location(location)
begin
URI(location)
rescue URI::InvalidURIError
::URI::DEFAULT_PARSER.escape(location)
else
location
end
end
def fetch_using_http_from_parsed_uri
raise ImageFetchFailure unless @parsed_uri.is_a?(URI::HTTP)
http_header = {'Accept-Encoding' => 'identity'}.merge(@options[:http_header])
setup_http
@http.request_get(@parsed_uri.request_uri, http_header) do |res|
if res.is_a?(Net::HTTPRedirection) && @redirect_count < 4
@redirect_count += 1
begin
location = res['Location']
raise ImageFetchFailure if location.nil? || location.empty?
@parsed_uri = URI.join(@parsed_uri, escaped_location(location))
rescue URI::InvalidURIError
else
fetch_using_http_from_parsed_uri
break
end
end
raise ImageFetchFailure unless res.is_a?(Net::HTTPSuccess)
@content_length = res.content_length
break if @property == :content_length
read_fiber = Fiber.new do
res.read_body do |str|
Fiber.yield str
end
nil
end
case res['content-encoding']
when 'deflate', 'gzip', 'x-gzip'
begin
gzip = Zlib::GzipReader.new(FiberStream.new(read_fiber))
rescue FiberError, Zlib::GzipFile::Error
raise CannotParseImage
end
read_fiber = Fiber.new do
while data = gzip.readline
Fiber.yield data
end
nil
end
end
parse_packets FiberStream.new(read_fiber)
break # needed to actively quit out of the fetch
end
end
def protocol_relative_url?(url)
url.start_with?("//")
end
def proxy_uri
begin
if @options[:proxy]
proxy = URI.parse(@options[:proxy])
else
proxy = ENV['http_proxy'] && ENV['http_proxy'] != "" ? URI.parse(ENV['http_proxy']) : nil
end
rescue URI::InvalidURIError
proxy = nil
end
proxy
end
def setup_http
proxy = proxy_uri
if proxy
@http = Net::HTTP::Proxy(proxy.host, proxy.port, proxy.user, proxy.password).new(@parsed_uri.host, @parsed_uri.port)
else
@http = Net::HTTP.new(@parsed_uri.host, @parsed_uri.port)
end
@http.use_ssl = (@parsed_uri.scheme == "https")
@http.verify_mode = OpenSSL::SSL::VERIFY_NONE
@http.open_timeout = @options[:timeout]
@http.read_timeout = @options[:timeout]
end
def fetch_using_read(readable)
return @content_length = readable.size if @property == :content_length && readable.respond_to?(:size)
readable.rewind if readable.respond_to?(:rewind)
# Pathnames respond to read, but always return the first
# chunk of the file unlike an IO (even though the
# docuementation for it refers to IO). Need to supply
# an offset in this case.
if readable.is_a?(Pathname)
read_fiber = Fiber.new do
offset = 0
while str = readable.read(LocalFileChunkSize, offset)
Fiber.yield str
offset += LocalFileChunkSize
end
nil
end
else
read_fiber = Fiber.new do
while str = readable.read(LocalFileChunkSize)
Fiber.yield str
end
nil
end
end
parse_packets FiberStream.new(read_fiber)
end
def fetch_using_file_open
return @content_length = File.size?(@uri) if @property == :content_length
File.open(@uri) do |s|
fetch_using_read(s)
end
end
def fetch_using_base64(uri)
decoded = begin
uri.split(',')[1].unpack("m").first
rescue
raise CannotParseImage
end
fetch_using_read StringIO.new(decoded)
end
def parse_packets(stream)
@stream = stream
begin
@type = TypeParser.new(@stream).type unless defined?(@type)
result = case @property
when :type
@type
when :size
parse_size
when :animated
parse_animated
end
if result != nil
# extract exif orientation if it was found
if @property == :size && result.size == 3
@orientation = result.pop
else
@orientation = 1
end
instance_variable_set("@#{@property}", result)
else
raise CannotParseImage
end
rescue FiberError
raise CannotParseImage
end
end
def parser_class
klass = Parsers[@type]
raise UnknownImageType unless klass
klass
end
def parse_size
parser_class.new(@stream).dimensions
end
def parse_animated
parser_class.new(@stream).animated?
end
end
|