1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2009 Red Hat, Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General
16 * Public License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18 * Boston, MA 02111-1307, USA.
20 * Author: Alexander Larsson <alexl@redhat.com>
25 #include "gzlibdecompressor.h"
31 #include "gfileinfo.h"
34 #include "gioenumtypes.h"
45 * SECTION:gzdecompressor
46 * @short_description: Zlib decompressor
49 * #GZlibDecompressor is an implementation of #GConverter that
50 * decompresses data compressed with zlib.
53 static void g_zlib_decompressor_iface_init (GConverterIface *iface);
66 struct _GZlibDecompressor
68 GObject parent_instance;
70 GZlibCompressorFormat format;
72 HeaderData *header_data;
76 g_zlib_decompressor_set_gzheader (GZlibDecompressor *decompressor)
78 if (decompressor->format != G_ZLIB_COMPRESSOR_FORMAT_GZIP)
81 if (decompressor->header_data != NULL)
83 if (decompressor->header_data->file_info)
84 g_object_unref (decompressor->header_data->file_info);
86 memset (decompressor->header_data, 0, sizeof (HeaderData));
90 decompressor->header_data = g_new0 (HeaderData, 1);
93 decompressor->header_data->gzheader.name = (Bytef*) &decompressor->header_data->filename;
94 /* We keep one byte to guarantee the string is 0-terminated */
95 decompressor->header_data->gzheader.name_max = 256;
97 if (inflateGetHeader (&decompressor->zstream, &decompressor->header_data->gzheader) != Z_OK)
98 g_warning ("unexpected zlib error: %s\n", decompressor->zstream.msg);
101 G_DEFINE_TYPE_WITH_CODE (GZlibDecompressor, g_zlib_decompressor, G_TYPE_OBJECT,
102 G_IMPLEMENT_INTERFACE (G_TYPE_CONVERTER,
103 g_zlib_decompressor_iface_init))
106 g_zlib_decompressor_finalize (GObject *object)
108 GZlibDecompressor *decompressor;
110 decompressor = G_ZLIB_DECOMPRESSOR (object);
112 inflateEnd (&decompressor->zstream);
114 if (decompressor->header_data != NULL)
116 if (decompressor->header_data->file_info)
117 g_object_unref (decompressor->header_data->file_info);
118 g_free (decompressor->header_data);
121 G_OBJECT_CLASS (g_zlib_decompressor_parent_class)->finalize (object);
126 g_zlib_decompressor_set_property (GObject *object,
131 GZlibDecompressor *decompressor;
133 decompressor = G_ZLIB_DECOMPRESSOR (object);
138 decompressor->format = g_value_get_enum (value);
142 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
149 g_zlib_decompressor_get_property (GObject *object,
154 GZlibDecompressor *decompressor;
156 decompressor = G_ZLIB_DECOMPRESSOR (object);
161 g_value_set_enum (value, decompressor->format);
165 if (decompressor->header_data)
166 g_value_set_object (value, decompressor->header_data->file_info);
168 g_value_set_object (value, NULL);
172 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
178 g_zlib_decompressor_init (GZlibDecompressor *decompressor)
183 g_zlib_decompressor_constructed (GObject *object)
185 GZlibDecompressor *decompressor;
188 decompressor = G_ZLIB_DECOMPRESSOR (object);
190 if (decompressor->format == G_ZLIB_COMPRESSOR_FORMAT_GZIP)
193 res = inflateInit2 (&decompressor->zstream, MAX_WBITS + 16);
195 else if (decompressor->format == G_ZLIB_COMPRESSOR_FORMAT_RAW)
197 /* Negative for gzip */
198 res = inflateInit2 (&decompressor->zstream, -MAX_WBITS);
201 res = inflateInit (&decompressor->zstream);
203 if (res == Z_MEM_ERROR )
204 g_error ("GZlibDecompressor: Not enough memory for zlib use");
207 g_warning ("unexpected zlib error: %s\n", decompressor->zstream.msg);
209 g_zlib_decompressor_set_gzheader (decompressor);
213 g_zlib_decompressor_class_init (GZlibDecompressorClass *klass)
215 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
217 gobject_class->finalize = g_zlib_decompressor_finalize;
218 gobject_class->constructed = g_zlib_decompressor_constructed;
219 gobject_class->get_property = g_zlib_decompressor_get_property;
220 gobject_class->set_property = g_zlib_decompressor_set_property;
222 g_object_class_install_property (gobject_class,
224 g_param_spec_enum ("format",
225 P_("compression format"),
226 P_("The format of the compressed data"),
227 G_TYPE_ZLIB_COMPRESSOR_FORMAT,
228 G_ZLIB_COMPRESSOR_FORMAT_ZLIB,
229 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
230 G_PARAM_STATIC_STRINGS));
233 * GZlibDecompressor:file-info:
235 * A #GFileInfo containing the information found in the GZIP header
236 * of the data stream processed, or %NULL if the header was not yet
237 * fully processed, is not present at all, or the compressor's
238 * #GZlibDecompressor:format property is not %G_ZLIB_COMPRESSOR_FORMAT_GZIP.
242 g_object_class_install_property (gobject_class,
244 g_param_spec_object ("file-info",
249 G_PARAM_STATIC_STRINGS));
253 * g_zlib_decompressor_new:
254 * @format: The format to use for the compressed data
256 * Creates a new #GZlibDecompressor.
258 * Returns: a new #GZlibDecompressor
263 g_zlib_decompressor_new (GZlibCompressorFormat format)
265 GZlibDecompressor *decompressor;
267 decompressor = g_object_new (G_TYPE_ZLIB_DECOMPRESSOR,
275 * g_zlib_decompressor_get_file_info:
276 * @decompressor: a #GZlibDecompressor
278 * Retrieves the #GFileInfo constructed from the GZIP header data
279 * of compressed data processed by @compressor, or %NULL if @decompressor's
280 * #GZlibDecompressor:format property is not %G_ZLIB_COMPRESSOR_FORMAT_GZIP,
281 * or the header data was not fully processed yet, or it not present in the
282 * data stream at all.
284 * Returns: (transfer none): a #GFileInfo, or %NULL
289 g_zlib_decompressor_get_file_info (GZlibDecompressor *decompressor)
291 g_return_val_if_fail (G_IS_ZLIB_DECOMPRESSOR (decompressor), NULL);
293 if (decompressor->header_data)
294 return decompressor->header_data->file_info;
300 g_zlib_decompressor_reset (GConverter *converter)
302 GZlibDecompressor *decompressor = G_ZLIB_DECOMPRESSOR (converter);
305 res = inflateReset (&decompressor->zstream);
307 g_warning ("unexpected zlib error: %s\n", decompressor->zstream.msg);
309 g_zlib_decompressor_set_gzheader (decompressor);
312 static GConverterResult
313 g_zlib_decompressor_convert (GConverter *converter,
318 GConverterFlags flags,
320 gsize *bytes_written,
323 GZlibDecompressor *decompressor;
326 decompressor = G_ZLIB_DECOMPRESSOR (converter);
328 decompressor->zstream.next_in = (void *)inbuf;
329 decompressor->zstream.avail_in = inbuf_size;
331 decompressor->zstream.next_out = outbuf;
332 decompressor->zstream.avail_out = outbuf_size;
334 res = inflate (&decompressor->zstream, Z_NO_FLUSH);
336 if (res == Z_DATA_ERROR || res == Z_NEED_DICT)
338 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_INVALID_DATA,
339 _("Invalid compressed data"));
340 return G_CONVERTER_ERROR;
343 if (res == Z_MEM_ERROR)
345 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_FAILED,
346 _("Not enough memory"));
347 return G_CONVERTER_ERROR;
350 if (res == Z_STREAM_ERROR)
352 g_set_error (error, G_IO_ERROR, G_IO_ERROR_FAILED,
353 _("Internal error: %s"), decompressor->zstream.msg);
354 return G_CONVERTER_ERROR;
357 if (res == Z_BUF_ERROR)
359 if (flags & G_CONVERTER_FLUSH)
360 return G_CONVERTER_FLUSHED;
362 /* Z_FINISH not set, so this means no progress could be made */
363 /* We do have output space, so this should only happen if we
364 have no input but need some */
366 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_PARTIAL_INPUT,
367 _("Need more input"));
368 return G_CONVERTER_ERROR;
371 g_assert (res == Z_OK || res == Z_STREAM_END);
373 *bytes_read = inbuf_size - decompressor->zstream.avail_in;
374 *bytes_written = outbuf_size - decompressor->zstream.avail_out;
376 if (decompressor->header_data != NULL &&
377 decompressor->header_data->gzheader.done == 1)
379 HeaderData *data = decompressor->header_data;
381 /* So we don't notify again */
382 data->gzheader.done = 2;
384 data->file_info = g_file_info_new ();
385 g_file_info_set_attribute_uint64 (data->file_info,
386 G_FILE_ATTRIBUTE_TIME_MODIFIED,
387 data->gzheader.time);
388 g_file_info_set_attribute_uint32 (data->file_info,
389 G_FILE_ATTRIBUTE_TIME_MODIFIED_USEC,
392 if (data->filename[0] != '\0')
393 g_file_info_set_attribute_byte_string (data->file_info,
394 G_FILE_ATTRIBUTE_STANDARD_NAME,
397 g_object_notify (G_OBJECT (decompressor), "file-info");
400 if (res == Z_STREAM_END)
401 return G_CONVERTER_FINISHED;
402 return G_CONVERTER_CONVERTED;
406 g_zlib_decompressor_iface_init (GConverterIface *iface)
408 iface->convert = g_zlib_decompressor_convert;
409 iface->reset = g_zlib_decompressor_reset;