zpng 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c80d32f2f6027ae69acc2f9f21142d89fe2d8bb24bd1625d2eae5470df90bc4
-  data.tar.gz: 76a0239f9c6d80fb7883f9c5e80c325ae74e94b72cf345ac6b0a168291ab75f3
+  metadata.gz: 24abc68e64e96c4df6b0626ce0f393a4de8e1363551f5a3deed4f77af3cf8402
+  data.tar.gz: ece0c993df0a99091a542f7db3f7ad95975eccffbf915d15f8d692ff83d7fdfe
 SHA512:
-  metadata.gz: 1402123bc6a4fb28084b3f2645b9df50877da1bd157b6e888f4f2bdde301d8d54cf8620a77d2fd6c6e0fc1615f712f14379549576d395a9185f8641c369db8a2
-  data.tar.gz: 497d257914ba09e8f482a311bf6c499bebb4c09622b1681ba1fab845d76175d4e94163bf05158ef1e7013a080ebc00befd49fec3f6a209d92ef0e50b9df61927
+  metadata.gz: 2716d2d131a293f5aeb04c8ef0d8b7423b41adfedb05507b8fec063a6d02b16e8ff5f652f6461e3114e05eb7210cf62b85898ab57e93aa798bb7477a09043f61
+  data.tar.gz: 8bd1800562ec76857d7164099e112224516d9f9fb11b4bb7a428f39e583b3820ac33f00ecd12569d1fe4ded091ae9d20cbc7c42e327370dec5d663fd0bd26a18

data/README.md

@@ -36,8 +36,10 @@ Usage
     
         -C, --crop GEOMETRY              crop image, {WIDTH}x{HEIGHT}+{X}+{Y},
                                          puts results on stdout unless --ascii given
+        -R, --rebuild NEW_FILENAME       rebuild image, useful in restoring borked images
     
         -A, --ascii                      Try to convert image to ASCII (works best with monochrome images)
+            --ascii-string STRING        Use specific string to map pixels to ASCII characters
         -N, --ansi                       Try to display image as ANSI colored text
         -2, --256                        Try to display image as 256-colored text
         -W, --wide                       Use 2 horizontal characters per one pixel
@@ -52,7 +54,7 @@ Usage
 
     [.] image size 35x35, 24bpp, COLOR_RGB
     [.] uncompressed imagedata size = 3710 bytes
-    [.] <Chunk #00 IHDR size=    13, crc=91bb240e, color=2, compression=0, depth=8, filter=0, height=35, interlace=0, width=35> CRC OK
+    [.] <Chunk #00 IHDR size=    13, crc=91bb240e, color=2, compression=0, depth=8, filter=0, height=35, interlace=0, offset=8, width=35> CRC OK
     [.] <Chunk #01 sRGB size=     1, crc=aece1ce9 > CRC OK
     [.] <Chunk #02 IDAT size=   399, crc=59790716 > CRC OK
     [.] <Chunk #03 IEND size=     0, crc=ae426082 > CRC OK
@@ -66,7 +68,7 @@ Usage
         01 ff ff ff 00 00 00 00  00 00 00 00 00 00 00 00  |................|
         00 00 00 00 00 00 00 00  00 00 00 00 00 00 00 00  |................| + 3678 bytes
     
-    [.] <Chunk #00 IHDR size=    13, crc=91bb240e, color=2, compression=0, depth=8, filter=0, height=35, idx=0, interlace=0, width=35> CRC OK
+    [.] <Chunk #00 IHDR size=    13, crc=91bb240e, color=2, compression=0, depth=8, filter=0, height=35, idx=0, interlace=0, offset=8, width=35> CRC OK
         00 00 00 23 00 00 00 23  08 02 00 00 00           |...#...#.....   |
     
     [.] <Chunk #01 sRGB size=     1, crc=aece1ce9 > CRC OK
@@ -84,7 +86,7 @@ Usage
 
     # zpng --chunks qr_aux_chunks.png
 
-    [.] <Chunk #00 IHDR size=    13, crc=36a28ef4, color=0, compression=0, depth=1, filter=0, height=35, interlace=0, width=35> CRC OK
+    [.] <Chunk #00 IHDR size=    13, crc=36a28ef4, color=0, compression=0, depth=1, filter=0, height=35, interlace=0, offset=8, width=35> CRC OK
     [.] <Chunk #01 gAMA size=     4, crc=0bfc6105 > CRC OK
     [.] <Chunk #02 sRGB size=     1, crc=aece1ce9 > CRC OK
     [.] <Chunk #03 cHRM size=    32, crc=9cba513c > CRC OK

data/VERSION

@@ -1 +1 @@
-0.3.4
+0.4.0

data/lib/zpng/chunk.rb

@@ -1,6 +1,9 @@
 module ZPNG
   class Chunk
-    attr_accessor :size, :type, :data, :crc, :idx
+    attr_accessor :size, :type, :data, :crc, :idx, :offset
+
+    KNOWN_TYPES = %w'IHDR PLTE IDAT IEND cHRM gAMA iCCP sBIT sRGB bKGD hIST tRNS pHYs sPLT tIME iTXt tEXt zTXt'
+    VALID_SIZE_RANGE = 0..((2**31)-1)
 
     include DeepCopyable
 
@@ -10,21 +13,27 @@ module ZPNG
       begin
         if const_defined?(type.upcase)
           klass = const_get(type.upcase)
-          klass.new(io)
-        else
-          Chunk.new(io)
+          return klass.new(io)
         end
       rescue NameError
         # invalid chunk type?
-        Chunk.new(io)
       end
+      # putting this out of rescue makes better non-confusing exception messages
+      # if exception occurs somewhere in Chunk.new
+      Chunk.new(io)
     end
 
     def initialize x = {}
       if x.respond_to?(:read)
         # IO
+        @offset = x.tell
         @size, @type = x.read(8).unpack('Na4')
-        @data        = x.read(size)
+        begin
+          @data = x.read(size)
+        rescue Errno::EINVAL
+          # TODO: show warning?
+          @data = x.read if size > VALID_SIZE_RANGE.end
+        end
         @crc         = x.read(4).to_s.unpack('N').first
       elsif x.respond_to?(:[])
         # Hash
@@ -66,6 +75,22 @@ module ZPNG
       expected_crc == crc
     end
 
+    def check checks = {type: true, crc: true, size: true}
+      checks.each do |check_type, check_mode|
+        case check_type
+        when :type
+          return false if check_mode != KNOWN_TYPES.include?(self.type)
+        when :crc
+          return false if check_mode != crc_ok?
+        when :size
+          return false if check_mode != VALID_SIZE_RANGE.include?(self.size)
+        end
+      end
+      true
+    end
+
+    def valid?; check; end
+
     def fix_crc!
       @crc = Zlib.crc32(data, Zlib.crc32(type))
     end

data/lib/zpng/cli.rb

@@ -52,6 +52,10 @@ module ZPNG
           @actions << [:crop, x]
         end
 
+        opts.on "-R", "--rebuild NEW_FILENAME", "rebuild image, useful in restoring borked images" do |x|
+          @actions << [:rebuild, x]
+        end
+
         opts.separator ""
         opts.on "-A", '--ascii', 'Try to convert image to ASCII (works best with monochrome images)' do
           @actions << :ascii
@@ -137,6 +141,10 @@ module ZPNG
       print @img.export unless @actions.include?(:ascii)
     end
 
+    def rebuild fname
+      File.binwrite(fname, @img.export)
+    end
+
     def load_file fname
       @img = Image.load fname, :verbose => @options[:verbose]+1
     end

data/lib/zpng/image.rb

@@ -108,11 +108,43 @@ module ZPNG
       end
     end
 
+    HEUR_CHUNK_SIZE_RANGE = -16..16
+
+    # assume previous chunk size is not right, try to iterate over neighbour data
+    def _apply_heuristics io, prev_chunk, chunk
+      prev_pos = io.tell
+      HEUR_CHUNK_SIZE_RANGE.each do |delta|
+        next if delta == 0
+        next if prev_chunk.data.size + delta < 0
+        io.seek(chunk.offset+delta, IO::SEEK_SET)
+        potential_chunk = Chunk.new(io)
+        if potential_chunk.valid?
+          STDERR.puts "[!] heuristics: found invalid chunk at offset #{chunk.offset}, but valid one at #{chunk.offset+delta}. using latter".red
+          if delta > 0
+            io.seek(chunk.offset, IO::SEEK_SET)
+            data = io.read(delta)
+            STDERR.puts "[!] #{delta} extra bytes of data: #{data.inspect}".red
+          else
+            io.seek(chunk.offset+delta, IO::SEEK_SET)
+          end
+          return true
+        end
+      end
+      false
+    end
+
     def _read_png io
+      prev_chunk = nil
       while !io.eof?
         chunk = Chunk.from_stream(io)
+        # heuristics
+        if prev_chunk && prev_chunk.check(type: true, crc: false) &&
+            chunk.check(type: false, crc: false) && chunk.data
+          redo if _apply_heuristics(io, prev_chunk, chunk)
+        end
         chunk.idx = @chunks.size
         @chunks << chunk
+        prev_chunk = chunk
         break if chunk.is_a?(Chunk::IEND)
       end
     end
@@ -137,7 +169,7 @@ module ZPNG
       unless io.eof?
         offset     = io.tell
         @extradata << io.read
-        puts "[?] #{@extradata.last.size} bytes of extra data after image end (IEND), offset = 0x#{offset.to_s(16)}".red if @verbose >= 1
+        STDERR.puts "[?] #{@extradata.last.size} bytes of extra data after image end (IEND), offset = 0x#{offset.to_s(16)}".red if @verbose >= 1
       end
     end
 
@@ -250,16 +282,16 @@ module ZPNG
         r << zi.inflate(pos==0 ? data : data[pos..-1])
         if zi.total_in < data.size
           @extradata << data[zi.total_in..-1]
-          puts "[?] #{@extradata.last.size} bytes of extra data after zlib stream".red if @verbose >= 1
+          STDERR.puts "[?] #{@extradata.last.size} bytes of extra data after zlib stream".red if @verbose >= 1
         end
         # decompress OK
       rescue Zlib::BufError
         # tried to decompress, but got EOF - need more data
-        puts "[!] #{$!.inspect}".red if @verbose >= -1
+        STDERR.puts "[!] #{$!.inspect}".red if @verbose >= -1
         # collect any remaining data in decompress buffer
         r << zi.flush_next_out
       rescue Zlib::DataError
-        puts "[!] #{$!.inspect}".red if @verbose >= -1
+        STDERR.puts "[!] #{$!.inspect}".red if @verbose >= -1
         #p [pos, zi.total_in, zi.total_out, data.size, r.size]
         r << zi.flush_next_out
         # XXX TODO try to skip error and continue
@@ -273,7 +305,7 @@ module ZPNG
 #        pos = 0
 #        retry if pos < data.size
       rescue Zlib::NeedDict
-        puts "[!] #{$!.inspect}".red if @verbose >= -1
+        STDERR.puts "[!] #{$!.inspect}".red if @verbose >= -1
         # collect any remaining data in decompress buffer
         r << zi.flush_next_out
       end
@@ -288,7 +320,7 @@ module ZPNG
     def imagedata
       @imagedata ||=
         begin
-          puts "[?] no image header, assuming non-interlaced RGB".yellow unless header
+          STDERR.puts "[?] no image header, assuming non-interlaced RGB".yellow unless header
           data = _imagedata
           (data && data.size > 0) ? _safe_inflate(data) : ''
         end

data/lib/zpng/scan_line.rb

@@ -7,6 +7,8 @@ module ZPNG
     FILTER_AVERAGE        = 3
     FILTER_PAETH          = 4
 
+    VALID_FILTERS = FILTER_NONE..FILTER_PAETH
+
     attr_accessor :image, :idx, :filter, :offset, :bpp
     attr_writer :decoded_bytes
 
@@ -44,6 +46,10 @@ module ZPNG
       !@filter
     end
 
+    def valid_filter?
+      VALID_FILTERS.include?(@filter)
+    end
+
     # total scanline size in bytes, INCLUDING leading 'filter' byte
     def size
       @size ||=
@@ -286,7 +292,10 @@ module ZPNG
               )
             end
 
-          else raise "invalid ScanLine filter #{@filter}"
+          else
+            STDERR.puts "[!] #{self.class}: ##@idx: invalid filter #@filter, assuming FILTER_NONE".red
+            s = raw
+            raise
           end
 
           s

data/zpng.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: zpng 0.3.4 ruby lib
+# stub: zpng 0.4.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "zpng".freeze
-  s.version = "0.3.4"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Andrey \"Zed\" Zaikin".freeze]
-  s.date = "2022-01-29"
+  s.date = "2022-01-31"
   s.email = "zed.0xff@gmail.com".freeze
   s.executables = ["zpng".freeze]
   s.extra_rdoc_files = [
@@ -52,6 +52,7 @@ Gem::Specification.new do |s|
     "misc/chars.png",
     "misc/gen_ascii_map.rb",
     "samples/bad/000000.png",
+    "samples/bad/149511457-47db5096-662d-4221-84f9-1c2a0e20e323.png",
     "samples/bad/b1.png",
     "samples/captcha_4bpp.png",
     "samples/cats.png",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zpng
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors:
 - Andrey "Zed" Zaikin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-29 00:00:00.000000000 Z
+date: 2022-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -136,6 +136,7 @@ files:
 - misc/chars.png
 - misc/gen_ascii_map.rb
 - samples/bad/000000.png
+- samples/bad/149511457-47db5096-662d-4221-84f9-1c2a0e20e323.png
 - samples/bad/b1.png
 - samples/captcha_4bpp.png
 - samples/cats.png