Project

pngcheck

0.0
No release in over a year
pngcheckmetanorma/pngcheck-rubyHomepageDocumentationSource CodeBug TrackerWiki
Ruby interface to pngcheck.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
99,444
Stars
3
Forks
0
Watchers
10
 Releases
Current version
0.3.1
Total releases
64
First release
2022-08-22
Latest release
2022-10-14
 Issues
Open Issues
1
Closed Issues
15
Total Issues
16
Issue Closure Rate
93%
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
2
Merged Pull Requests
15
Pull Request Acceptance Rate
88%
 Development
Primary Language
Ruby
Licenses
BSD-2-Clause
Average date of last 50 commits
2022-09-08
Reverse Dependencies
1

 Dependencies

Development

libpng-ruby
~> 0.6
rspec
~> 3.0
rubocop
~> 1.4

Runtime

bundler
~> 2.3, >= 2.3.22
ffi
~> 1.0
mini_portile2
~> 2.7
rake
~> 13.0
 Project Readme

test-and-release

PngCheck: PNG, JNG and MNG integrity checks

The pngcheck gem provides the PngCheck Ruby library, used to

  • verify the integrity of PNG, JNG and MNG files, through

    • checking the internal 32-bit CRCs ("checksums");

    • decompressing the image data;

  • dump almost all of the chunk-level information in the image in human-readable form, including:

    • print the basic statistics about an image (dimensions, bit depth, etc.);

    • list the color and transparency info in its palette (assuming it has one); or

    • to extract the embedded text annotations.

The PngCheck Ruby library is a wrapper around the original pngcheck tool from the libpng project.

Note
 PngCheck incorporates pngcheck version 3.0.3, as provided on the official website: http://www.libpng.org/pub/png/apps/pngcheck.html
Note
 The PngCheck Ruby library does not distribute nor modify the pngcheck GPL executables pngsplit and png-fix-IDAT-windowsize, and hence is not bound under the GPL license.

Installation

Add this line to your application’s Gemfile:

gem 'pngcheck'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install pngcheck

Usage

PngCheck status codes

PngCheck::STATUS_OK = 0
PngCheck::STATUS_WARNING = 1        # an error in some circumstances but not in all
PngCheck::STATUS_MINOR_ERROR = 3    # minor spec errors (e.g., out-of-range values)
PngCheck::STATUS_MAJOR_ERROR = 4    # file corruption, invalid chunk length/layout, etc.
PngCheck::STATUS_CRITICAL_ERROR = 5 # unexpected EOF or other file(system) error

File processing

status, info = PngCheck.analyze_file("spec/examples/correct.png")

Where:

  • status is file status code

  • info is either file content information for correct files, or error message for corrupt files

valid = PngCheck.check_file("spec/examples/correct.png")

Where:

  • valid is true if the file is correct

  • otherwise an exception is raised. Possible exception types are PngCheck::EmptyPngError, PngCheck::CorruptPngError

Memory buffer processing

data = File.binread("spec/examples/correct.png")
status, info = PngCheck.analyze_buffer(data)

Where:

  • status is the PngCheck status code

  • info is either file content information for correct files, or the error message for corrupt files

data = File.binread("spec/examples/correct.png")
valid = PngCheck.check_buffer(data)

Where:

  • valid is true if the buffer is correct image

  • otherwise an exception is raised. Possible exception types are PngCheck::EmptyPngError, PngCheck::CorruptPngError

Both exception classes have additional status attribute that is set to one of STATUX_XXX codes described above. We believe that exceptions with STATUS_WARNING can be ignored in the majority of applications.

Pre-validation with libpng-ruby

libpng-ruby is the Ruby wrapper library around libpng, commonly used to process PNG files in Ruby.

To prevent crashing libpng-ruby with corrupt PNG files, you may wish to pre-verify integrity of the PNG file before loading it with libpng-ruby. Any errors in the PNG will cause a PngCheck::CorruptPngError to be raised, hence skipping the libpng code.

The mechanism to do so is demonstrated below:

require 'png'
encoded = File.binread("spec/examples/correct.png")

begin
  PngCheck.check_buffer(encoded)
  dec = PNG::Decoder.new
  raw = dec << encoded
rescue PngCheck::CorruptPngError => e
  puts "Exception #{e.message}"
end

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/metanorma/pngcheck-ruby.

License

Open-sourced under the Ribose BSD-2 clause license. Copyright Ribose for all code excluding the pngcheck library.

The pngcheck library is provided under its original license as unmodified code, its license is located here.

Note
 The core code of the pngcheck library is licensed under the libpng 3-clause BSD license, while two additional executables pngsplit and png-fix-IDAT-windowsize are offered under GPL. Since the PngCheck Ruby library does not offer the GPL executables, the gem itself is offered under a BSD license instead of GPL.