aboutsummaryrefslogtreecommitdiff
path: root/Foundation/GTMNSData+zlib.m
blob: 514477fa790c77e8cdf63d8804ac65a164346f5f (plain)
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
//
//  GTMNSData+zlib.m
//
//  Copyright 2007-2008 Google Inc.
//
//  Licensed under the Apache License, Version 2.0 (the "License"); you may not
//  use this file except in compliance with the License.  You may obtain a copy
//  of the License at
// 
//  http://www.apache.org/licenses/LICENSE-2.0
// 
//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
//  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
//  License for the specific language governing permissions and limitations under
//  the License.
//

#import "GTMNSData+zlib.h"
#import <zlib.h>
#import "GTMDefines.h"

#define kChunkSize 1024

@interface NSData (GTMZlibAdditionsPrivate)
+ (NSData *)gtm_dataByCompressingBytes:(const void *)bytes
                                length:(unsigned)length
                      compressionLevel:(int)level
                               useGzip:(BOOL)useGzip;
@end

@implementation NSData (GTMZlibAdditionsPrivate)
+ (NSData *)gtm_dataByCompressingBytes:(const void *)bytes
                                length:(unsigned)length
                      compressionLevel:(int)level
                               useGzip:(BOOL)useGzip {
  if (!bytes || !length) {
    return nil;
  }

  if (level == Z_DEFAULT_COMPRESSION) {
    // the default value is actually outside the range, so we have to let it
    // through specifically.
  } else if (level < Z_BEST_SPEED) {
    level = Z_BEST_SPEED;
  } else if (level > Z_BEST_COMPRESSION) {
    level = Z_BEST_COMPRESSION;
  }

  z_stream strm;
  bzero(&strm, sizeof(z_stream));

  int windowBits = 15; // the default
  int memLevel = 8; // the default
  if (useGzip) {
    windowBits += 16; // enable gzip header instead of zlib header
  }
  int retCode;
  if ((retCode = deflateInit2(&strm, level, Z_DEFLATED, windowBits,
                              memLevel, Z_DEFAULT_STRATEGY)) != Z_OK) {
    // COV_NF_START - no real way to force this in a unittest (we guard all args)
    _GTMDevLog(@"Failed to init for deflate w/ level %d, error %d",
               level, retCode);
    return nil;
    // COV_NF_END
  }

  // hint the size at 1/4 the input size
  NSMutableData *result = [NSMutableData dataWithCapacity:(length/4)];
  unsigned char output[kChunkSize];

  // setup the input
  strm.avail_in = length;
  strm.next_in = (unsigned char*)bytes;

  // loop to collect the data
  do {
    // update what we're passing in
    strm.avail_out = kChunkSize;
    strm.next_out = output;
    retCode = deflate(&strm, Z_FINISH);
    if ((retCode != Z_OK) && (retCode != Z_STREAM_END)) {
      // COV_NF_START - no real way to force this in a unittest
      // (in inflate, we can feed bogus/truncated data to test, but an error
      // here would be some internal issue w/in zlib, and there isn't any real
      // way to test it)
      _GTMDevLog(@"Error trying to deflate some of the payload, error %d",
                 retCode);
      deflateEnd(&strm);
      return nil;
      // COV_NF_END
    }
    // collect what we got
    unsigned gotBack = kChunkSize - strm.avail_out;
    if (gotBack > 0) {
      [result appendBytes:output length:gotBack];
    }

  } while (retCode == Z_OK);

  // if the loop exits, we used all input and the stream ended
  _GTMDevAssert(strm.avail_in == 0,
                @"thought we finished deflate w/o using all input, %u bytes left",
                strm.avail_in);
  _GTMDevAssert(retCode == Z_STREAM_END,
                @"thought we finished deflate w/o getting a result of stream end, code %d",
                retCode);

  // clean up
  deflateEnd(&strm);

  return result;
} // gtm_dataByCompressingBytes:length:compressionLevel:useGzip:
  

@end


@implementation NSData (GTMZLibAdditions)

+ (NSData *)gtm_dataByGzippingBytes:(const void *)bytes
                             length:(unsigned)length {
  return [self gtm_dataByCompressingBytes:bytes
                                   length:length
                         compressionLevel:Z_DEFAULT_COMPRESSION
                                  useGzip:YES];
} // gtm_dataByGzippingBytes:length:

+ (NSData *)gtm_dataByGzippingData:(NSData *)data {
  return [self gtm_dataByCompressingBytes:[data bytes]
                                   length:[data length]
                         compressionLevel:Z_DEFAULT_COMPRESSION
                                  useGzip:YES];
} // gtm_dataByGzippingData:

+ (NSData *)gtm_dataByGzippingBytes:(const void *)bytes
                             length:(unsigned)length
                   compressionLevel:(int)level {
  return [self gtm_dataByCompressingBytes:bytes
                                   length:length
                         compressionLevel:level
                                  useGzip:YES];
} // gtm_dataByGzippingBytes:length:level:

+ (NSData *)gtm_dataByGzippingData:(NSData *)data
                  compressionLevel:(int)level {
  return [self gtm_dataByCompressingBytes:[data bytes]
                                   length:[data length]
                         compressionLevel:level
                                  useGzip:YES];
} // gtm_dataByGzippingData:level:

+ (NSData *)gtm_dataByDeflatingBytes:(const void *)bytes
                              length:(unsigned)length {
  return [self gtm_dataByCompressingBytes:bytes
                                   length:length
                         compressionLevel:Z_DEFAULT_COMPRESSION
                                  useGzip:NO];
} // gtm_dataByDeflatingBytes:length:

+ (NSData *)gtm_dataByDeflatingData:(NSData *)data {
  return [self gtm_dataByCompressingBytes:[data bytes]
                                   length:[data length]
                         compressionLevel:Z_DEFAULT_COMPRESSION
                                  useGzip:NO];
} // gtm_dataByDeflatingData:

+ (NSData *)gtm_dataByDeflatingBytes:(const void *)bytes
                              length:(unsigned)length
                    compressionLevel:(int)level {
  return [self gtm_dataByCompressingBytes:bytes
                                   length:length
                         compressionLevel:level
                                  useGzip:NO];
} // gtm_dataByDeflatingBytes:length:level:

+ (NSData *)gtm_dataByDeflatingData:(NSData *)data
                   compressionLevel:(int)level {
  return [self gtm_dataByCompressingBytes:[data bytes]
                                   length:[data length]
                         compressionLevel:level
                                  useGzip:NO];
} // gtm_dataByDeflatingData:level:

+ (NSData *)gtm_dataByInflatingBytes:(const void *)bytes
                              length:(unsigned)length {
  if (!bytes || !length) {
    return nil;
  }

  z_stream strm;
  bzero(&strm, sizeof(z_stream));

  // setup the input
  strm.avail_in = length;
  strm.next_in = (unsigned char*)bytes;

  int windowBits = 15; // 15 to enable any window size
  windowBits += 32; // and +32 to enable zlib or gzip header detection.
  int retCode;
  if ((retCode = inflateInit2(&strm, windowBits)) != Z_OK) {
    // COV_NF_START - no real way to force this in a unittest (we guard all args)
    _GTMDevLog(@"Failed to init for inflate, error %d", retCode);
    return nil;
    // COV_NF_END
  }

  // hint the size at 4x the input size
  NSMutableData *result = [NSMutableData dataWithCapacity:(length*4)];
  unsigned char output[kChunkSize];

  // loop to collect the data
  do {
    // update what we're passing in
    strm.avail_out = kChunkSize;
    strm.next_out = output;
    retCode = inflate(&strm, Z_NO_FLUSH);
    if ((retCode != Z_OK) && (retCode != Z_STREAM_END)) {
      _GTMDevLog(@"Error trying to inflate some of the payload, error %d",
                 retCode);
      inflateEnd(&strm);
      return nil;
    }
    // collect what we got
    unsigned gotBack = kChunkSize - strm.avail_out;
    if (gotBack > 0) {
      [result appendBytes:output length:gotBack];
    }

  } while (retCode == Z_OK);

  // make sure there wasn't more data tacked onto the end of a valid compressed
  // stream.
  if (strm.avail_in != 0) {
    _GTMDevLog(@"thought we finished inflate w/o using all input, %u bytes left",
               strm.avail_in);
    result = nil;
  }
  // the only way out of the loop was by hitting the end of the stream
  _GTMDevAssert(retCode == Z_STREAM_END,
                @"thought we finished inflate w/o getting a result of stream end, code %d",
                retCode);

  // clean up
  inflateEnd(&strm);

  return result;
} // gtm_dataByInflatingBytes:length:

+ (NSData *)gtm_dataByInflatingData:(NSData *)data {
  return [self gtm_dataByInflatingBytes:[data bytes]
                                 length:[data length]];
} // gtm_dataByInflatingData:

@end