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 "gzlibcompressor.h"
31 #include "gfileinfo.h"
34 #include "gioenumtypes.h"
46 * SECTION:gzcompressor
47 * @short_description: Zlib compressor
50 * #GZlibCompressor is an implementation of #GConverter that
51 * compresses data using zlib.
54 static void g_zlib_compressor_iface_init (GConverterIface *iface);
61 struct _GZlibCompressor
63 GObject parent_instance;
65 GZlibCompressorFormat format;
73 g_zlib_compressor_set_gzheader (GZlibCompressor *compressor)
75 const gchar *filename;
77 if (compressor->format != G_ZLIB_COMPRESSOR_FORMAT_GZIP ||
78 compressor->file_info == NULL)
81 memset (&compressor->gzheader, 0, sizeof (gz_header));
82 compressor->gzheader.os = 0x03; /* Unix */
84 filename = g_file_info_get_name (compressor->file_info);
85 compressor->gzheader.name = (Bytef *) filename;
86 compressor->gzheader.name_max = filename ? strlen (filename) + 1 : 0;
88 compressor->gzheader.time =
89 (uLong) g_file_info_get_attribute_uint64 (compressor->file_info,
90 G_FILE_ATTRIBUTE_TIME_MODIFIED);
92 if (deflateSetHeader (&compressor->zstream, &compressor->gzheader) != Z_OK)
93 g_warning ("unexpected zlib error: %s\n", compressor->zstream.msg);
96 G_DEFINE_TYPE_WITH_CODE (GZlibCompressor, g_zlib_compressor, G_TYPE_OBJECT,
97 G_IMPLEMENT_INTERFACE (G_TYPE_CONVERTER,
98 g_zlib_compressor_iface_init))
101 g_zlib_compressor_finalize (GObject *object)
103 GZlibCompressor *compressor;
105 compressor = G_ZLIB_COMPRESSOR (object);
107 deflateEnd (&compressor->zstream);
109 if (compressor->file_info)
110 g_object_unref (compressor->file_info);
112 G_OBJECT_CLASS (g_zlib_compressor_parent_class)->finalize (object);
117 g_zlib_compressor_set_property (GObject *object,
122 GZlibCompressor *compressor;
124 compressor = G_ZLIB_COMPRESSOR (object);
129 compressor->format = g_value_get_enum (value);
133 compressor->level = g_value_get_int (value);
137 g_zlib_compressor_set_file_info (compressor, g_value_get_object (value));
141 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
148 g_zlib_compressor_get_property (GObject *object,
153 GZlibCompressor *compressor;
155 compressor = G_ZLIB_COMPRESSOR (object);
160 g_value_set_enum (value, compressor->format);
164 g_value_set_int (value, compressor->level);
168 g_value_set_object (value, compressor->file_info);
172 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
178 g_zlib_compressor_init (GZlibCompressor *compressor)
183 g_zlib_compressor_constructed (GObject *object)
185 GZlibCompressor *compressor;
188 compressor = G_ZLIB_COMPRESSOR (object);
190 if (compressor->format == G_ZLIB_COMPRESSOR_FORMAT_GZIP)
193 res = deflateInit2 (&compressor->zstream,
194 compressor->level, Z_DEFLATED,
198 else if (compressor->format == G_ZLIB_COMPRESSOR_FORMAT_RAW)
200 /* negative wbits for raw */
201 res = deflateInit2 (&compressor->zstream,
202 compressor->level, Z_DEFLATED,
207 res = deflateInit (&compressor->zstream, compressor->level);
209 if (res == Z_MEM_ERROR )
210 g_error ("GZlibCompressor: Not enough memory for zlib use");
213 g_warning ("unexpected zlib error: %s\n", compressor->zstream.msg);
215 g_zlib_compressor_set_gzheader (compressor);
219 g_zlib_compressor_class_init (GZlibCompressorClass *klass)
221 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
223 gobject_class->finalize = g_zlib_compressor_finalize;
224 gobject_class->constructed = g_zlib_compressor_constructed;
225 gobject_class->get_property = g_zlib_compressor_get_property;
226 gobject_class->set_property = g_zlib_compressor_set_property;
228 g_object_class_install_property (gobject_class,
230 g_param_spec_enum ("format",
231 P_("compression format"),
232 P_("The format of the compressed data"),
233 G_TYPE_ZLIB_COMPRESSOR_FORMAT,
234 G_ZLIB_COMPRESSOR_FORMAT_ZLIB,
235 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
236 G_PARAM_STATIC_STRINGS));
237 g_object_class_install_property (gobject_class,
239 g_param_spec_int ("level",
240 P_("compression level"),
241 P_("The level of compression from 0 (no compression) to 9 (most compression), -1 for the default level"),
245 G_PARAM_CONSTRUCT_ONLY |
246 G_PARAM_STATIC_STRINGS));
249 * GZlibCompressor:file-info:
251 * If set to a non-%NULL #GFileInfo object, and #GZlibCompressor:format is
252 * %G_ZLIB_COMPRESSOR_FORMAT_GZIP, the compressor will write the file name
253 * and modification time from the file info to the the GZIP header.
257 g_object_class_install_property (gobject_class,
259 g_param_spec_object ("file-info",
264 G_PARAM_STATIC_STRINGS));
268 * g_zlib_compressor_new:
269 * @format: The format to use for the compressed data
270 * @level: compression level (0-9), -1 for default
272 * Creates a new #GZlibCompressor.
274 * Returns: a new #GZlibCompressor
279 g_zlib_compressor_new (GZlibCompressorFormat format,
282 GZlibCompressor *compressor;
284 compressor = g_object_new (G_TYPE_ZLIB_COMPRESSOR,
293 * g_zlib_compressor_get_file_info:
294 * @compressor: a #GZlibCompressor
296 * Returns the #GZlibCompressor:file-info property.
298 * Returns: (transfer none): a #GFileInfo, or %NULL
303 g_zlib_compressor_get_file_info (GZlibCompressor *compressor)
305 g_return_val_if_fail (G_IS_ZLIB_COMPRESSOR (compressor), NULL);
307 return compressor->file_info;
311 * g_zlib_compressor_set_file_info:
312 * @compressor: a #GZlibCompressor
313 * @file_info: (allow-none): a #GFileInfo
315 * Sets @file_info in @compressor. If non-%NULL, and @compressor's
316 * #GZlibCompressor:format property is %G_ZLIB_COMPRESSOR_FORMAT_GZIP,
317 * it will be used to set the file name and modification time in
318 * the GZIP header of the compressed data.
320 * Note: it is an error to call this function while a compression is in
321 * progress; it may only be called immediately after creation of @compressor,
322 * or after resetting it with g_converter_reset().
327 g_zlib_compressor_set_file_info (GZlibCompressor *compressor,
328 GFileInfo *file_info)
330 g_return_if_fail (G_IS_ZLIB_COMPRESSOR (compressor));
332 if (file_info == compressor->file_info)
335 if (compressor->file_info)
336 g_object_unref (compressor->file_info);
338 g_object_ref (file_info);
339 compressor->file_info = file_info;
340 g_object_notify (G_OBJECT (compressor), "file-info");
342 g_zlib_compressor_set_gzheader (compressor);
346 g_zlib_compressor_reset (GConverter *converter)
348 GZlibCompressor *compressor = G_ZLIB_COMPRESSOR (converter);
351 res = deflateReset (&compressor->zstream);
353 g_warning ("unexpected zlib error: %s\n", compressor->zstream.msg);
355 /* deflateReset reset the header too, so re-set it */
356 g_zlib_compressor_set_gzheader (compressor);
359 static GConverterResult
360 g_zlib_compressor_convert (GConverter *converter,
365 GConverterFlags flags,
367 gsize *bytes_written,
370 GZlibCompressor *compressor;
374 compressor = G_ZLIB_COMPRESSOR (converter);
376 compressor->zstream.next_in = (void *)inbuf;
377 compressor->zstream.avail_in = inbuf_size;
379 compressor->zstream.next_out = outbuf;
380 compressor->zstream.avail_out = outbuf_size;
383 if (flags & G_CONVERTER_INPUT_AT_END)
385 else if (flags & G_CONVERTER_FLUSH)
386 flush = Z_SYNC_FLUSH;
388 res = deflate (&compressor->zstream, flush);
390 if (res == Z_MEM_ERROR)
392 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_FAILED,
393 _("Not enough memory"));
394 return G_CONVERTER_ERROR;
397 if (res == Z_STREAM_ERROR)
399 g_set_error (error, G_IO_ERROR, G_IO_ERROR_FAILED,
400 _("Internal error: %s"), compressor->zstream.msg);
401 return G_CONVERTER_ERROR;
404 if (res == Z_BUF_ERROR)
406 if (flags & G_CONVERTER_FLUSH)
407 return G_CONVERTER_FLUSHED;
409 /* We do have output space, so this should only happen if we
410 have no input but need some */
412 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_PARTIAL_INPUT,
413 _("Need more input"));
414 return G_CONVERTER_ERROR;
417 if (res == Z_OK || res == Z_STREAM_END)
419 *bytes_read = inbuf_size - compressor->zstream.avail_in;
420 *bytes_written = outbuf_size - compressor->zstream.avail_out;
422 if (res == Z_STREAM_END)
423 return G_CONVERTER_FINISHED;
424 return G_CONVERTER_CONVERTED;
427 g_assert_not_reached ();
431 g_zlib_compressor_iface_init (GConverterIface *iface)
433 iface->convert = g_zlib_compressor_convert;
434 iface->reset = g_zlib_compressor_reset;