Leolo's guassian2 patch
[imager.git] / limits.c
CommitLineData
77157728
TC
1/*
2=head1 NAME
3
4limits.c - manages data/functions for limiting the sizes of images read from files.
5
6=head1 SYNOPSIS
7
8 // user code
9 if (!i_set_image_file_limits(max_width, max_height, max_bytes)) {
10 // error
11 }
12 i_get_image_file_limits(&max_width, &max_height, &max_bytes);
13
14 // file reader implementations
15 if (!i_int_check_image_file_limits(width, height, channels, sizeof(i_sample_t))) {
16 // error handling
17 }
18
19=head1 DESCRIPTION
20
21Manage limits for image files read by Imager.
22
23Setting a value of zero means that limit will be ignored.
12db268a
TC
24
25=over
26
27=cut
77157728
TC
28 */
29
d896d49c 30#define IMAGER_NO_CONTEXT
92bda632 31#include "imageri.h"
77157728 32
87deb14c 33/*
abffffed
TC
34=item im_set_image_file_limits(ctx, width, height, bytes)
35X<im_set_image_file_limits API>X<i_set_image_file_limits API>
87deb14c 36=category Files
abffffed 37=synopsis im_set_image_file_limits(aIMCTX, 500, 500, 1000000);
87deb14c
TC
38=synopsis i_set_image_file_limits(500, 500, 1000000);
39
40Set limits on the sizes of images read by Imager.
41
42Setting a limit to 0 means that limit is ignored.
43
44Negative limits result in failure.
45
8d14daab
TC
46Parameters:
47
48=over
49
50=item *
51
52i_img_dim width, height - maximum width and height.
53
54=item *
55
85cae6e7
TC
56size_t bytes - maximum size in memory in bytes. A value of zero sets
57this limit to one gigabyte.
8d14daab
TC
58
59=back
60
87deb14c
TC
61Returns non-zero on success.
62
abffffed
TC
63Also callable as C<i_set_image_file_limits(width, height, bytes)>.
64
87deb14c
TC
65=cut
66*/
67
77157728 68int
d896d49c 69im_set_image_file_limits(pIMCTX, i_img_dim width, i_img_dim height, size_t bytes) {
77157728
TC
70 i_clear_error();
71
72 if (width < 0) {
73 i_push_error(0, "width must be non-negative");
74 return 0;
75 }
76 if (height < 0) {
77 i_push_error(0, "height must be non-negative");
78 return 0;
79 }
77157728 80
d896d49c
TC
81 aIMCTX->max_width = width;
82 aIMCTX->max_height = height;
83 aIMCTX->max_bytes = bytes ? bytes : DEF_BYTES_LIMIT;
77157728
TC
84
85 return 1;
86}
87
87deb14c 88/*
abffffed
TC
89=item im_get_image_file_limits(ctx, &width, &height, &bytes)
90X<im_get_image_file_limits API>X<i_get_image_file_limits>
87deb14c 91=category Files
abffffed 92=synopsis im_get_image_file_limits(aIMCTX, &width, &height, &bytes)
87deb14c
TC
93=synopsis i_get_image_file_limits(&width, &height, &bytes)
94
95Retrieves the file limits set by i_set_image_file_limits().
96
8d14daab
TC
97=over
98
99=item *
100
101i_img_dim *width, *height - the maximum width and height of the image.
102
103=item *
104
105size_t *bytes - size in memory of the image in bytes.
106
107=back
108
abffffed
TC
109Also callable as C<i_get_image_file_limits(&width, &height, &bytes)>.
110
87deb14c
TC
111=cut
112*/
113
77157728 114int
d896d49c
TC
115im_get_image_file_limits(pIMCTX, i_img_dim *width, i_img_dim *height, size_t *bytes) {
116 im_clear_error(aIMCTX);
77157728 117
d896d49c
TC
118 *width = aIMCTX->max_width;
119 *height = aIMCTX->max_height;
120 *bytes = aIMCTX->max_bytes;
77157728
TC
121
122 return 1;
123}
124
87deb14c 125/*
abffffed
TC
126=item im_int_check_image_file_limits(width, height, channels, sample_size)
127X<im_int_check_image_file_limits API>X<i_int_check_image_file_limits>
87deb14c 128=category Files
abffffed
TC
129=synopsis im_int_check_image_file_limits(aIMCTX, width, height, channels, sizeof(i_sample_t))
130=synopsis i_int_check_image_file_limits(width, height, channels, sizeof(i_sample_t))
87deb14c
TC
131
132Checks the size of a file in memory against the configured image file
133limits.
134
135This also range checks the values to those permitted by Imager and
136checks for overflows in calculating the size.
137
138Returns non-zero if the file is within limits.
139
140This function is intended to be called by image file read functions.
141
abffffed
TC
142Also callable as C<i_int_check_image_file_limits(width, height, channels, sizeof(i_sample_t)>.
143
87deb14c
TC
144=cut
145*/
146
77157728 147int
d896d49c 148im_int_check_image_file_limits(pIMCTX, i_img_dim width, i_img_dim height, int channels, size_t sample_size) {
8d14daab 149 size_t bytes;
d896d49c 150 im_clear_error(aIMCTX);
77157728
TC
151
152 if (width <= 0) {
d896d49c 153 im_push_errorf(aIMCTX, 0, "file size limit - image width of %" i_DF " is not positive",
8d14daab 154 i_DFc(width));
77157728
TC
155 return 0;
156 }
d896d49c
TC
157 if (aIMCTX->max_width && width > aIMCTX->max_width) {
158 im_push_errorf(aIMCTX, 0, "file size limit - image width of %" i_DF " exceeds limit of %" i_DF,
159 i_DFc(width), i_DFc(aIMCTX->max_width));
77157728
TC
160 return 0;
161 }
162
163 if (height <= 0) {
d896d49c 164 im_push_errorf(aIMCTX, 0, "file size limit - image height of %" i_DF " is not positive",
8d14daab 165 i_DFc(height));
77157728
TC
166 return 0;
167 }
168
d896d49c
TC
169 if (aIMCTX->max_height && height > aIMCTX->max_height) {
170 im_push_errorf(aIMCTX, 0, "file size limit - image height of %" i_DF
171 " exceeds limit of %" i_DF, i_DFc(height), i_DFc(aIMCTX->max_height));
77157728
TC
172 return 0;
173 }
174
175 if (channels < 1 || channels > MAXCHANNELS) {
d896d49c 176 im_push_errorf(aIMCTX, 0, "file size limit - channels %d out of range",
77157728
TC
177 channels);
178 return 0;
179 }
180
181 if (sample_size < 1 || sample_size > sizeof(long double)) {
d896d49c 182 im_push_errorf(aIMCTX, 0, "file size limit - sample_size %ld out of range",
8d14daab 183 (long)sample_size);
77157728
TC
184 return 0;
185 }
186
187 /* This overflow check is a bit more paranoid than usual.
188 We don't protect it under max_bytes since we always want to check
189 for overflow.
190 */
5caa40a6 191 bytes = width * height * channels * sample_size;
77157728
TC
192 if (bytes / width != height * channels * sample_size
193 || bytes / height != width * channels * sample_size) {
d896d49c 194 im_push_error(aIMCTX, 0, "file size limit - integer overflow calculating storage");
77157728
TC
195 return 0;
196 }
d896d49c
TC
197 if (aIMCTX->max_bytes) {
198 if (bytes > aIMCTX->max_bytes) {
199 im_push_errorf(aIMCTX, 0, "file size limit - storage size of %lu "
8d14daab 200 "exceeds limit of %lu", (unsigned long)bytes,
d896d49c 201 (unsigned long)aIMCTX->max_bytes);
77157728
TC
202 return 0;
203 }
204 }
205
206 return 1;
207}