pngcheck 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.rspec +1 -0
- data/.rubocop.yml +9 -0
- data/Gemfile +8 -0
- data/LICENSE.txt +53 -0
- data/README.adoc +161 -0
- data/Rakefile +17 -0
- data/bin/console +15 -0
- data/bin/rspec +32 -0
- data/bin/setup +8 -0
- data/ext/Makefile +4 -0
- data/ext/extconf.rb +8 -0
- data/ext/wrapper.c +106 -0
- data/lib/pngcheck/recipe.rb +69 -0
- data/lib/pngcheck/version.rb +5 -0
- data/lib/pngcheck.rb +78 -0
- data/pngcheck.gemspec +37 -0
- metadata +133 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 3108a01f5219fca06fb7a8c20da83f2c022e434a03992ad0fd9490acae9b9f7d
|
4
|
+
data.tar.gz: d959ab0ef00e06b62d4a610ed6ea8cd2250e92fbdc2679bdc1325e9f08f08882
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 5525ee60d5c00b76fd9991d06e64f9ded140d2a88f238a7130abcb2c0e7bc96b53d4d5fda926a044198d02d2fe0ae790b0cc63a47acecaf1a9925c915b66290d
|
7
|
+
data.tar.gz: d210466936f5539db834065e3a5348b6e6ba2befeac712127d565bb7c05b23b06d3889a281399634c949f0193cf54182ee85324548ece65f8ce098b49690dc1b
|
data/.rspec
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
--require spec_helper
|
data/.rubocop.yml
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,53 @@
|
|
1
|
+
BSD 2-Clause License
|
2
|
+
|
3
|
+
Copyright (c) 2022, Ribose Inc.
|
4
|
+
All rights reserved.
|
5
|
+
|
6
|
+
Redistribution and use in source and binary forms, with or without
|
7
|
+
modification, are permitted provided that the following conditions are met:
|
8
|
+
|
9
|
+
* Redistributions of source code must retain the above copyright notice, this
|
10
|
+
list of conditions and the following disclaimer.
|
11
|
+
|
12
|
+
* Redistributions in binary form must reproduce the above copyright notice,
|
13
|
+
this list of conditions and the following disclaimer in the documentation
|
14
|
+
and/or other materials provided with the distribution.
|
15
|
+
|
16
|
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
17
|
+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
18
|
+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
19
|
+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
20
|
+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
21
|
+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
22
|
+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
23
|
+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
24
|
+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
25
|
+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
26
|
+
|
27
|
+
|
28
|
+
This module includes original pngcheck software [http://www.libpng.org/pub/png/apps/pngcheck.html]
|
29
|
+
that is distributed under the follwoing license:
|
30
|
+
|
31
|
+
Copyright 1995-2020 by Alexander Lehmann <lehmann@usa.net>,
|
32
|
+
Andreas Dilger <adilger@enel.ucalgary.ca>,
|
33
|
+
Glenn Randers-Pehrson <randeg@alum.rpi.edu>,
|
34
|
+
Greg Roelofs <newt@pobox.com>,
|
35
|
+
John Bowler <jbowler@acm.org>,
|
36
|
+
Tom Lane <tgl@sss.pgh.pa.us>
|
37
|
+
|
38
|
+
Permission to use, copy, modify, and distribute this software and its
|
39
|
+
documentation for any purpose and without fee is hereby granted, provided
|
40
|
+
that the above copyright notice appear in all copies and that both that
|
41
|
+
copyright notice and this permission notice appear in supporting
|
42
|
+
documentation. This software is provided "as is" without express or
|
43
|
+
implied warranty.
|
44
|
+
|
45
|
+
|
46
|
+
[This license applies to pngcheck.c and its associated makefiles and
|
47
|
+
documentation in the main directory. The files in the "gpl" subdirectory--
|
48
|
+
specifically, pngsplit.c and png-fix-IDAT-windowsize.c--are licensed under the
|
49
|
+
GNU General Public License. The files in "amiga" subdirectory are Copyright
|
50
|
+
2003 Simon Goodwin and were contributed without an explicit license statement,
|
51
|
+
but insofar as the "gpl" subdirectory didn't exist at the time, it's safe to
|
52
|
+
assume their intended license was similar to pngcheck's, just with Simon's
|
53
|
+
copyright replacing the one above.]
|
data/README.adoc
ADDED
@@ -0,0 +1,161 @@
|
|
1
|
+
image:https://github.com/metanorma/pngcheck-ruby/actions/workflows/test-and-release.yml/badge.svg["test-and-release", link="https://github.com/metanorma/pngcheck-ruby/actions/workflows/test-and-release.yml"]
|
2
|
+
|
3
|
+
== PngCheck: PNG, JNG and MNG integrity checks
|
4
|
+
|
5
|
+
The `pngcheck` gem provides the `PngCheck` Ruby library, used to
|
6
|
+
|
7
|
+
* verify the integrity of PNG, JNG and MNG files, through
|
8
|
+
|
9
|
+
** checking the internal 32-bit CRCs ("checksums");
|
10
|
+
** decompressing the image data;
|
11
|
+
|
12
|
+
* dump *almost* all of the chunk-level information in the image in
|
13
|
+
human-readable form, including:
|
14
|
+
|
15
|
+
** print the basic statistics about an image (dimensions, bit depth, etc.);
|
16
|
+
** list the color and transparency info in its palette (assuming it has one); or
|
17
|
+
** to extract the embedded text annotations.
|
18
|
+
|
19
|
+
The `PngCheck` Ruby library is a wrapper around the original
|
20
|
+
http://www.libpng.org/pub/png/apps/pngcheck.html[`pngcheck`] tool
|
21
|
+
from the http://www.libpng.org/pub/png/libpng.html[`libpng`] project.
|
22
|
+
|
23
|
+
NOTE: `PngCheck` incorporates
|
24
|
+
http://www.libpng.org/pub/png/apps/pngcheck.html[`pngcheck`] version 3.0.3, as
|
25
|
+
provided on the official website:
|
26
|
+
http://www.libpng.org/pub/png/apps/pngcheck.html
|
27
|
+
|
28
|
+
NOTE: The `PngCheck` Ruby library does not distribute nor modify the `pngcheck`
|
29
|
+
GPL executables `pngsplit` and `png-fix-IDAT-windowsize`, and hence is not bound
|
30
|
+
under the GPL license.
|
31
|
+
|
32
|
+
=== Installation
|
33
|
+
|
34
|
+
Add this line to your application's Gemfile:
|
35
|
+
|
36
|
+
[source,ruby]
|
37
|
+
----
|
38
|
+
gem 'pngcheck'
|
39
|
+
----
|
40
|
+
|
41
|
+
And then execute:
|
42
|
+
|
43
|
+
[source,sh]
|
44
|
+
----
|
45
|
+
$ bundle install
|
46
|
+
----
|
47
|
+
|
48
|
+
Or install it yourself as:
|
49
|
+
[source,sh]
|
50
|
+
----
|
51
|
+
$ gem install pngcheck
|
52
|
+
----
|
53
|
+
|
54
|
+
=== Usage
|
55
|
+
|
56
|
+
==== PngCeck status codes
|
57
|
+
|
58
|
+
[source,ruby]
|
59
|
+
----
|
60
|
+
PngCheck::STATUS_OK = 0
|
61
|
+
PngCheck::STATUS_WARNING = 1 # an error in some circumstances but not in all
|
62
|
+
PngCheck::STATUS_MINOR_ERROR = 3 # minor spec errors (e.g., out-of-range values)
|
63
|
+
PngCheck::STATUS_MAJOR_ERROR = 4 # file corruption, invalid chunk length/layout, etc.
|
64
|
+
PngCheck::STATUS_CRITICAL_ERROR = 5 # unexpected EOF or other file(system) error
|
65
|
+
----
|
66
|
+
|
67
|
+
==== File processing
|
68
|
+
|
69
|
+
[source,ruby]
|
70
|
+
----
|
71
|
+
status, info = PngCheck.analyze_file("spec/examples/correct.png")
|
72
|
+
----
|
73
|
+
|
74
|
+
Where:
|
75
|
+
|
76
|
+
* `status` is file status code
|
77
|
+
* `info` is either file content information for correct files, or error message for corrupt files
|
78
|
+
|
79
|
+
[source,ruby]
|
80
|
+
----
|
81
|
+
valid = PngCheck.check_file("spec/examples/correct.png")
|
82
|
+
----
|
83
|
+
|
84
|
+
Where:
|
85
|
+
|
86
|
+
* `valid` is `true` if the file is correct
|
87
|
+
* otherwise an exception of type `PngCheck::CorruptPngError` is raised
|
88
|
+
|
89
|
+
|
90
|
+
==== Memory buffer processing
|
91
|
+
|
92
|
+
[source,ruby]
|
93
|
+
----
|
94
|
+
data = File.binread("spec/examples/correct.png")
|
95
|
+
status, info = PngCheck.analyze_buffer(data)
|
96
|
+
----
|
97
|
+
|
98
|
+
Where:
|
99
|
+
|
100
|
+
* `status` is the PngCheck status code
|
101
|
+
* `info` is either file content information for correct files, or the error
|
102
|
+
message for corrupt files
|
103
|
+
|
104
|
+
|
105
|
+
[source,ruby]
|
106
|
+
----
|
107
|
+
data = File.binread("spec/examples/correct.png")
|
108
|
+
valid = PngCheck.check_buffer(data)
|
109
|
+
----
|
110
|
+
|
111
|
+
Where:
|
112
|
+
|
113
|
+
* `valid` is `true` if the file is correct
|
114
|
+
* otherwise an exception of type `PngCheck::CorruptPngError` is raised
|
115
|
+
|
116
|
+
|
117
|
+
==== Pre-validation with libpng-ruby
|
118
|
+
|
119
|
+
`libpng-ruby` is the Ruby wrapper library around `libpng`, commonly used to
|
120
|
+
process PNG files in Ruby.
|
121
|
+
|
122
|
+
To prevent crashing libpng-ruby with corrupt PNG files, you may wish to
|
123
|
+
pre-verify integrity of the PNG file before loading it with `libpng-ruby`.
|
124
|
+
Any errors in the PNG will cause a `PngCheck::CorruptPngError` to be raised,
|
125
|
+
hence skipping the `libpng` code.
|
126
|
+
|
127
|
+
The mechanism to do so is demonstrated below:
|
128
|
+
|
129
|
+
[source,ruby]
|
130
|
+
----
|
131
|
+
require 'png'
|
132
|
+
encoded = File.binread("spec/examples/correct.png")
|
133
|
+
|
134
|
+
begin
|
135
|
+
PngCheck.check_buffer(encoded)
|
136
|
+
dec = PNG::Decoder.new
|
137
|
+
raw = dec << encoded
|
138
|
+
rescue PngCheck::CorruptPngError => e
|
139
|
+
puts "Exception #{e.message}"
|
140
|
+
end
|
141
|
+
----
|
142
|
+
|
143
|
+
|
144
|
+
=== Contributing
|
145
|
+
|
146
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/metanorma/pngcheck-ruby.
|
147
|
+
|
148
|
+
=== License
|
149
|
+
|
150
|
+
Open-sourced under the link:LICENSE.txt[Ribose BSD-2 clause license].
|
151
|
+
Copyright Ribose for all code excluding the `pngcheck` library.
|
152
|
+
|
153
|
+
The `pngcheck` library is provided under its original license as unmodified
|
154
|
+
code, its license is located
|
155
|
+
http://www.libpng.org/pub/png/src/pngcheck-3.0.3.LICENSE[here].
|
156
|
+
|
157
|
+
NOTE: The core code of the `pngcheck` library is licensed under the
|
158
|
+
http://www.libpng.org/pub/png/src/libpng-LICENSE.txt[libpng 3-clause BSD license],
|
159
|
+
while two additional executables `pngsplit` and `png-fix-IDAT-windowsize` are
|
160
|
+
offered under GPL. Since the `PngCheck` Ruby library does not offer the GPL
|
161
|
+
executables, the gem itself is offered under a BSD license instead of GPL.
|
data/Rakefile
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require "bundler/gem_tasks"
|
4
|
+
require "rspec/core/rake_task"
|
5
|
+
|
6
|
+
RSpec::Core::RakeTask.new(:spec)
|
7
|
+
|
8
|
+
require "rubocop/rake_task"
|
9
|
+
RuboCop::RakeTask.new
|
10
|
+
|
11
|
+
task default: %i[spec rubocop]
|
12
|
+
|
13
|
+
task :compile do
|
14
|
+
require_relative "ext/extconf"
|
15
|
+
end
|
16
|
+
|
17
|
+
task spec: :compile
|
data/bin/console
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
require "bundler/setup"
|
5
|
+
require "pngcheck"
|
6
|
+
|
7
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
8
|
+
# with your gem easier. You can also use a different console, if you like.
|
9
|
+
|
10
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
11
|
+
# require "pry"
|
12
|
+
# Pry.start
|
13
|
+
|
14
|
+
require "irb"
|
15
|
+
IRB.start(__FILE__)
|
data/bin/rspec
ADDED
@@ -0,0 +1,32 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
#
|
5
|
+
# This file was generated by Bundler.
|
6
|
+
#
|
7
|
+
# The application 'rspec' is installed as part of a gem, and
|
8
|
+
# this file is here to facilitate running it.
|
9
|
+
#
|
10
|
+
|
11
|
+
require "pathname"
|
12
|
+
ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
|
13
|
+
Pathname.new(__FILE__).realpath)
|
14
|
+
|
15
|
+
bundle_binstub = File.expand_path("bundle", __dir__)
|
16
|
+
|
17
|
+
if File.file?(bundle_binstub)
|
18
|
+
if /This file was generated by Bundler/.match?(File.read(bundle_binstub, 300))
|
19
|
+
load(bundle_binstub)
|
20
|
+
else
|
21
|
+
msg <<END_HEREDOC
|
22
|
+
Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
|
23
|
+
Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.
|
24
|
+
END_HEREDOC
|
25
|
+
abort(msg)
|
26
|
+
end
|
27
|
+
end
|
28
|
+
|
29
|
+
require "rubygems"
|
30
|
+
require "bundler/setup"
|
31
|
+
|
32
|
+
load Gem.bin_path("rspec-core", "rspec")
|
data/bin/setup
ADDED
data/ext/Makefile
ADDED
data/ext/extconf.rb
ADDED
data/ext/wrapper.c
ADDED
@@ -0,0 +1,106 @@
|
|
1
|
+
#ifdef _WIN32
|
2
|
+
# include <windows.h>
|
3
|
+
# include <share.h>
|
4
|
+
# include <io.h>
|
5
|
+
# include <stdio.h>
|
6
|
+
#endif
|
7
|
+
|
8
|
+
#include <sys/stat.h>
|
9
|
+
#include <fcntl.h>
|
10
|
+
#include <errno.h>
|
11
|
+
|
12
|
+
#ifdef _WIN32
|
13
|
+
/* https://github.com/Arryboom/fmemopen_windows */
|
14
|
+
|
15
|
+
FILE *fmemopen(void *buf, size_t len, char *type) {
|
16
|
+
int fd;
|
17
|
+
FILE *fp;
|
18
|
+
char tp[MAX_PATH - 13];
|
19
|
+
char fn[MAX_PATH + 1];
|
20
|
+
int * pfd = &fd;
|
21
|
+
int retner = -1;
|
22
|
+
char tfname[] = "MemTF_";
|
23
|
+
if (!GetTempPathA(sizeof(tp), tp)) return NULL;
|
24
|
+
if (!GetTempFileNameA(tp, tfname, 0, fn)) return NULL;
|
25
|
+
retner = _sopen_s(pfd, fn, _O_CREAT | _O_SHORT_LIVED | _O_TEMPORARY | _O_RDWR | _O_BINARY | _O_NOINHERIT, _SH_DENYRW, _S_IREAD | _S_IWRITE);
|
26
|
+
if (retner != 0) return NULL;
|
27
|
+
if (fd == -1) return NULL;
|
28
|
+
fp = _fdopen(fd, "wb+");
|
29
|
+
if (!fp) {
|
30
|
+
_close(fd);
|
31
|
+
return NULL;
|
32
|
+
}
|
33
|
+
fwrite(buf, len, 1, fp);
|
34
|
+
rewind(fp);
|
35
|
+
return fp;
|
36
|
+
}
|
37
|
+
#endif
|
38
|
+
|
39
|
+
#include "pngcheck.c"
|
40
|
+
|
41
|
+
#define EXTRA_MESSAGE_SIZE 1024
|
42
|
+
|
43
|
+
void failed_to_open(char *extra_msg, char *fname) {
|
44
|
+
snprintf(extra_msg, EXTRA_MESSAGE_SIZE, "Failed to open %s: %s\n", fname, strerror(errno));
|
45
|
+
extra_msg[EXTRA_MESSAGE_SIZE-1] = 0;
|
46
|
+
}
|
47
|
+
|
48
|
+
void failed_to_dup(char *extra_msg, char *fmt) {
|
49
|
+
snprintf(extra_msg, EXTRA_MESSAGE_SIZE, fmt, strerror(errno));
|
50
|
+
extra_msg[EXTRA_MESSAGE_SIZE-1] = 0;
|
51
|
+
}
|
52
|
+
|
53
|
+
int pngcheck_inner(FILE* fp, char *fname, char *cname, char *extra_msg) {
|
54
|
+
int rc = kCriticalError;
|
55
|
+
int fd = open(cname, O_WRONLY);
|
56
|
+
if (fd == -1) {
|
57
|
+
failed_to_open(extra_msg, cname);
|
58
|
+
}
|
59
|
+
else {
|
60
|
+
int stdout_copy = dup(STDOUT_FILENO);
|
61
|
+
if (stdout_copy == -1) {
|
62
|
+
failed_to_dup(extra_msg, "Failed to save stdout: %s\n");
|
63
|
+
}
|
64
|
+
else {
|
65
|
+
if (dup2(fd, STDOUT_FILENO) == -1) {
|
66
|
+
failed_to_dup(extra_msg, "Failed to reassign stdout: %s\n");
|
67
|
+
}
|
68
|
+
else {
|
69
|
+
rc = pngcheck(fp, fname, 0, NULL);
|
70
|
+
fflush(stdout);
|
71
|
+
}
|
72
|
+
dup2(stdout_copy, STDOUT_FILENO);
|
73
|
+
}
|
74
|
+
close(fd);
|
75
|
+
}
|
76
|
+
return rc;
|
77
|
+
}
|
78
|
+
|
79
|
+
int pngcheck_file(char *fname, char *cname, char *extra_msg) {
|
80
|
+
int rc = kCriticalError;
|
81
|
+
extra_msg[0] = 0;
|
82
|
+
FILE* fp = fopen(fname, "rb");
|
83
|
+
if (fp == NULL) {
|
84
|
+
failed_to_open(extra_msg, fname);
|
85
|
+
}
|
86
|
+
else {
|
87
|
+
rc = pngcheck_inner(fp, fname, cname, extra_msg);
|
88
|
+
fclose(fp);
|
89
|
+
}
|
90
|
+
return rc;
|
91
|
+
}
|
92
|
+
|
93
|
+
int pngcheck_buffer(char *data, int size, char *cname, char *extra_msg) {
|
94
|
+
int rc = kCriticalError;
|
95
|
+
extra_msg[0] = 0;
|
96
|
+
char* fname = "[memory buffer]";
|
97
|
+
FILE* fp = fmemopen(data, size, "rb");
|
98
|
+
if (fp == NULL) {
|
99
|
+
failed_to_open(extra_msg, fname);
|
100
|
+
}
|
101
|
+
else {
|
102
|
+
rc = pngcheck_inner(fp, fname, cname, extra_msg);
|
103
|
+
fclose(fp);
|
104
|
+
}
|
105
|
+
return rc;
|
106
|
+
}
|
@@ -0,0 +1,69 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require "mini_portile2"
|
4
|
+
require "pathname"
|
5
|
+
|
6
|
+
module PngCheck
|
7
|
+
class Recipe < MiniPortile
|
8
|
+
ROOT = Pathname.new(File.expand_path("../..", __dir__))
|
9
|
+
|
10
|
+
def initialize
|
11
|
+
super("pngcheck", "3.0.3")
|
12
|
+
|
13
|
+
@files << {
|
14
|
+
url: "http://www.libpng.org/pub/png/src/pngcheck-3.0.3.tar.gz",
|
15
|
+
sha256: "c36a4491634af751f7798ea421321642f9590faa032eccb0dd5fb4533609dee6", # rubocop:disable Layout/LineLength
|
16
|
+
}
|
17
|
+
|
18
|
+
@target = ROOT.join(@target).to_s
|
19
|
+
@printed = {}
|
20
|
+
end
|
21
|
+
|
22
|
+
def make_cmd
|
23
|
+
if MiniPortile.windows?
|
24
|
+
+"gcc -shared -fPIC -Wall -O -DUSE_ZLIB -o pngcheck.dll wrapper.c -lz"
|
25
|
+
else
|
26
|
+
+"gcc -shared -fPIC -Wall -O -DUSE_ZLIB -o pngcheck.so wrapper.c -lz"
|
27
|
+
end
|
28
|
+
end
|
29
|
+
|
30
|
+
def cook_if_not
|
31
|
+
cook unless File.exist?(checkpoint)
|
32
|
+
end
|
33
|
+
|
34
|
+
def cook
|
35
|
+
super
|
36
|
+
FileUtils.touch(checkpoint)
|
37
|
+
end
|
38
|
+
|
39
|
+
def checkpoint
|
40
|
+
File.join(@target, "#{name}-#{version}-#{host}.installed")
|
41
|
+
end
|
42
|
+
|
43
|
+
def configure
|
44
|
+
FileUtils.cp(ROOT.join("ext", "wrapper.c"), work_path, verbose: false)
|
45
|
+
end
|
46
|
+
|
47
|
+
def install
|
48
|
+
libs = Dir.glob(File.join(work_path, "*"))
|
49
|
+
.grep(%r{/(?:lib)?[a-zA-Z0-9\-]+\.(?:so|dylib|dll)$})
|
50
|
+
|
51
|
+
FileUtils.cp_r(libs, ROOT.join("lib", "pngcheck"), verbose: false)
|
52
|
+
end
|
53
|
+
|
54
|
+
def execute(action, command, command_opts = {})
|
55
|
+
super(action, command, command_opts.merge(debug: false))
|
56
|
+
end
|
57
|
+
|
58
|
+
def message(text)
|
59
|
+
return super unless text.start_with?("\rDownloading")
|
60
|
+
|
61
|
+
match = text.match(/(\rDownloading .*)\(\s*\d+%\)/)
|
62
|
+
pattern = match ? match[1] : text
|
63
|
+
return if @printed[pattern]
|
64
|
+
|
65
|
+
@printed[pattern] = true
|
66
|
+
super
|
67
|
+
end
|
68
|
+
end
|
69
|
+
end
|
data/lib/pngcheck.rb
ADDED
@@ -0,0 +1,78 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require "ffi"
|
4
|
+
require "tempfile"
|
5
|
+
require_relative "pngcheck/version"
|
6
|
+
|
7
|
+
module PngCheck
|
8
|
+
class CorruptPngError < StandardError; end
|
9
|
+
|
10
|
+
STATUS_OK = 0
|
11
|
+
STATUS_WARNING = 1 # an error in some circumstances but not in all
|
12
|
+
STATUS_MINOR_ERROR = 3 # minor spec errors (e.g., out-of-range values)
|
13
|
+
STATUS_MAJOR_ERROR = 4 # file corruption, invalid chunk length/layout, etc.
|
14
|
+
STATUS_CRITICAL_ERROR = 5 # unexpected EOF or other file(system) error
|
15
|
+
|
16
|
+
EXTRA_MESSAGE_SIZE = 1024
|
17
|
+
|
18
|
+
extend FFI::Library
|
19
|
+
|
20
|
+
lib_filename = FFI::Platform.windows? ? "pngcheck.dll" : "pngcheck.so"
|
21
|
+
ffi_lib File.expand_path("pngcheck/#{lib_filename}", __dir__)
|
22
|
+
.gsub("/", File::ALT_SEPARATOR || File::SEPARATOR)
|
23
|
+
|
24
|
+
# int pngcheck_file(char *fname, char *cname, char *extra_message)
|
25
|
+
typedef :string, :file_path
|
26
|
+
typedef :pointer, :extra_message
|
27
|
+
typedef :int, :status
|
28
|
+
attach_function :pngcheck_file, %i[file_path file_path extra_message],
|
29
|
+
:status
|
30
|
+
# int pngcheck_string(char *data, int size, char *cname, char *extra_message)
|
31
|
+
typedef :pointer, :data
|
32
|
+
typedef :int, :size
|
33
|
+
attach_function :pngcheck_buffer, %i[data size file_path extra_message],
|
34
|
+
:status
|
35
|
+
|
36
|
+
@@semaphore = Mutex.new
|
37
|
+
|
38
|
+
class << self
|
39
|
+
def analyze_file(path)
|
40
|
+
Tempfile.open("captured-stream-") do |captured_stream|
|
41
|
+
extra_msg = FFI::Buffer.alloc_out(EXTRA_MESSAGE_SIZE, 1, false)
|
42
|
+
@@semaphore.lock
|
43
|
+
status = pngcheck_file(path, captured_stream.path, extra_msg)
|
44
|
+
@@semaphore.unlock
|
45
|
+
# we assume that pngcheck_file returns either captured_stream
|
46
|
+
# or extra message but not both
|
47
|
+
[status, captured_stream.read + extra_msg.get_string(16)]
|
48
|
+
end
|
49
|
+
end
|
50
|
+
|
51
|
+
def check_file(path)
|
52
|
+
status, info = analyze_file(path)
|
53
|
+
raise CorruptPngError.new info unless status == STATUS_OK
|
54
|
+
|
55
|
+
true
|
56
|
+
end
|
57
|
+
|
58
|
+
def analyze_buffer(data)
|
59
|
+
Tempfile.open("captured-stream-") do |captured_stream|
|
60
|
+
extra_msg = FFI::Buffer.alloc_out(EXTRA_MESSAGE_SIZE, 1, false)
|
61
|
+
mem_buf = FFI::MemoryPointer.new(:char, data.bytesize)
|
62
|
+
mem_buf.put_bytes(0, data)
|
63
|
+
@@semaphore.lock
|
64
|
+
status = pngcheck_buffer(mem_buf, data.bytesize, captured_stream.path,
|
65
|
+
extra_msg)
|
66
|
+
@@semaphore.unlock
|
67
|
+
[status, captured_stream.read + extra_msg.get_string(16)]
|
68
|
+
end
|
69
|
+
end
|
70
|
+
|
71
|
+
def check_buffer(data)
|
72
|
+
status, info = analyze_buffer(data)
|
73
|
+
raise CorruptPngError.new info unless status == STATUS_OK
|
74
|
+
|
75
|
+
true
|
76
|
+
end
|
77
|
+
end
|
78
|
+
end
|
data/pngcheck.gemspec
ADDED
@@ -0,0 +1,37 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require_relative "lib/pngcheck/version"
|
4
|
+
|
5
|
+
Gem::Specification.new do |spec|
|
6
|
+
spec.name = "pngcheck"
|
7
|
+
spec.version = PngCheck::VERSION
|
8
|
+
spec.authors = ["Ribose Inc."]
|
9
|
+
spec.email = ["open.source@ribose.com"]
|
10
|
+
|
11
|
+
spec.summary = "Ruby interface to pngcheck."
|
12
|
+
spec.homepage = "https://github.com/metanorma/pngcheck-ruby"
|
13
|
+
spec.license = "BSD-2-Clause"
|
14
|
+
spec.required_ruby_version = ">= 2.7.0"
|
15
|
+
|
16
|
+
spec.metadata["homepage_uri"] = spec.homepage
|
17
|
+
spec.metadata["source_code_uri"] = spec.homepage
|
18
|
+
spec.metadata["changelog_uri"] = spec.homepage
|
19
|
+
|
20
|
+
spec.files = Dir.chdir(File.expand_path(__dir__)) do
|
21
|
+
`git ls-files -z`.split("\x0").reject do |f|
|
22
|
+
(f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|github|travis|circleci)|appveyor)}) # rubocop:disable Layout/LineLength
|
23
|
+
end
|
24
|
+
end
|
25
|
+
spec.bindir = "bin"
|
26
|
+
spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
|
27
|
+
spec.require_paths = ["lib"]
|
28
|
+
|
29
|
+
spec.add_runtime_dependency "ffi", "~> 1.0"
|
30
|
+
spec.add_runtime_dependency "mini_portile2", "~> 2.7"
|
31
|
+
|
32
|
+
spec.add_development_dependency "libpng-ruby", "~> 0.6"
|
33
|
+
spec.add_development_dependency "rspec", "~> 3.0"
|
34
|
+
spec.add_development_dependency "rubocop", "~> 1.4"
|
35
|
+
|
36
|
+
spec.extensions = ["ext/extconf.rb"]
|
37
|
+
end
|
metadata
ADDED
@@ -0,0 +1,133 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: pngcheck
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Ribose Inc.
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2022-08-22 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: ffi
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.0'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: mini_portile2
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '2.7'
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '2.7'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: libpng-ruby
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0.6'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0.6'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: rspec
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '3.0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '3.0'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: rubocop
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - "~>"
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '1.4'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - "~>"
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '1.4'
|
83
|
+
description:
|
84
|
+
email:
|
85
|
+
- open.source@ribose.com
|
86
|
+
executables: []
|
87
|
+
extensions:
|
88
|
+
- ext/extconf.rb
|
89
|
+
extra_rdoc_files: []
|
90
|
+
files:
|
91
|
+
- ".rspec"
|
92
|
+
- ".rubocop.yml"
|
93
|
+
- Gemfile
|
94
|
+
- LICENSE.txt
|
95
|
+
- README.adoc
|
96
|
+
- Rakefile
|
97
|
+
- bin/console
|
98
|
+
- bin/rspec
|
99
|
+
- bin/setup
|
100
|
+
- ext/Makefile
|
101
|
+
- ext/extconf.rb
|
102
|
+
- ext/wrapper.c
|
103
|
+
- lib/pngcheck.rb
|
104
|
+
- lib/pngcheck/recipe.rb
|
105
|
+
- lib/pngcheck/version.rb
|
106
|
+
- pngcheck.gemspec
|
107
|
+
homepage: https://github.com/metanorma/pngcheck-ruby
|
108
|
+
licenses:
|
109
|
+
- BSD-2-Clause
|
110
|
+
metadata:
|
111
|
+
homepage_uri: https://github.com/metanorma/pngcheck-ruby
|
112
|
+
source_code_uri: https://github.com/metanorma/pngcheck-ruby
|
113
|
+
changelog_uri: https://github.com/metanorma/pngcheck-ruby
|
114
|
+
post_install_message:
|
115
|
+
rdoc_options: []
|
116
|
+
require_paths:
|
117
|
+
- lib
|
118
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
119
|
+
requirements:
|
120
|
+
- - ">="
|
121
|
+
- !ruby/object:Gem::Version
|
122
|
+
version: 2.7.0
|
123
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
124
|
+
requirements:
|
125
|
+
- - ">="
|
126
|
+
- !ruby/object:Gem::Version
|
127
|
+
version: '0'
|
128
|
+
requirements: []
|
129
|
+
rubygems_version: 3.3.7
|
130
|
+
signing_key:
|
131
|
+
specification_version: 4
|
132
|
+
summary: Ruby interface to pngcheck.
|
133
|
+
test_files: []
|