src/fu-unix-seekable-input-stream.c

/*
 * Copyright 2023 Richard Hughes <richard@hughsie.com>
 *
 * SPDX-License-Identifier: LGPL-2.1-or-later
 */

#define G_LOG_DOMAIN "FuUnixSeekableInputStream"

#include "config.h"

#include "fwupd-error.h"

#include "fu-unix-seekable-input-stream.h"

struct _FuUnixSeekableInputStream {
	GUnixInputStream parent_instance;
};

static void
fu_unix_seekable_input_stream_seekable_iface_init(GSeekableIface *iface);

/* see https://gitlab.gnome.org/GNOME/glib/-/issues/3200 for why this is needed */
G_DEFINE_TYPE_WITH_CODE(FuUnixSeekableInputStream,
			fu_unix_seekable_input_stream,
			G_TYPE_UNIX_INPUT_STREAM,
			G_IMPLEMENT_INTERFACE(G_TYPE_SEEKABLE,
					      fu_unix_seekable_input_stream_seekable_iface_init))

static goffset
fu_unix_seekable_input_stream_tell(GSeekable *seekable)
{
	goffset rc = lseek(g_unix_input_stream_get_fd(G_UNIX_INPUT_STREAM(seekable)), 0, SEEK_CUR);
	if (rc < 0)
		g_critical("cannot tell FuUnixSeekableInputStream: %s", fwupd_strerror(errno));
	return rc;
}

static gboolean
fu_unix_seekable_input_stream_can_seek(GSeekable *seekable)
{
	return lseek(g_unix_input_stream_get_fd(G_UNIX_INPUT_STREAM(seekable)), 0, SEEK_CUR) >= 0;
}

/* from glocalfileinputstream.c */
static int
fu_unix_seekable_input_stream_seek_type_to_lseek(GSeekType type)
{
	switch (type) {
	default:
	case G_SEEK_CUR:
		return SEEK_CUR;
	case G_SEEK_SET:
		return SEEK_SET;
	case G_SEEK_END:
		return SEEK_END;
	}
}

static gboolean
fu_unix_seekable_input_stream_seek(GSeekable *seekable,
				   goffset offset,
				   GSeekType type,
				   GCancellable *cancellable,
				   GError **error)
{
	FuUnixSeekableInputStream *self = FU_UNIX_SEEKABLE_INPUT_STREAM(seekable);
	goffset rc;

	g_return_val_if_fail(FU_IS_UNIX_SEEKABLE_INPUT_STREAM(self), FALSE);
	g_return_val_if_fail(error == NULL || *error == NULL, FALSE);

	rc = lseek(g_unix_input_stream_get_fd(G_UNIX_INPUT_STREAM(self)),
		   offset,
		   fu_unix_seekable_input_stream_seek_type_to_lseek(type));
	if (rc < 0) {
		g_set_error(error,
			    G_IO_ERROR, /* nocheck:error */
			    g_io_error_from_errno(errno),
			    "Error seeking file descriptor: %s",
			    fwupd_strerror(errno));
		return FALSE;
	}
	return TRUE;
}

static gboolean
fu_unix_seekable_input_stream_can_truncate(GSeekable *seekable)
{
	return FALSE;
}

static gboolean
fu_unix_seekable_input_stream_truncate(GSeekable *seekable,
				       goffset offset,
				       GCancellable *cancellable,
				       GError **error)
{
	/* using GIOError here as this will eventually go into GLib */
	g_set_error_literal(error,
			    G_IO_ERROR,		      /* nocheck:error */
			    G_IO_ERROR_NOT_SUPPORTED, /* nocheck:error */
			    "cannot truncate FuUnixSeekableInputStream");
	return FALSE;
}

static void
fu_unix_seekable_input_stream_seekable_iface_init(GSeekableIface *iface)
{
	iface->tell = fu_unix_seekable_input_stream_tell;
	iface->can_seek = fu_unix_seekable_input_stream_can_seek;
	iface->seek = fu_unix_seekable_input_stream_seek;
	iface->can_truncate = fu_unix_seekable_input_stream_can_truncate;
	iface->truncate_fn = fu_unix_seekable_input_stream_truncate;
}

/**
 * fu_unix_seekable_input_stream_new:
 * @fd: a UNIX file descriptor
 * @close_fd: %TRUE to close the file descriptor when done
 *
 * Creates a new seekable GUnixInputStream for the given fd.
 *
 * Returns: (transfer full): a #GInputStream
 *
 * Since: 2.0.0
 **/
GInputStream *
fu_unix_seekable_input_stream_new(gint fd, gboolean close_fd)
{
	return g_object_new(FU_TYPE_UNIX_SEEKABLE_INPUT_STREAM,
			    "fd",
			    fd,
			    "close-fd",
			    close_fd,
			    NULL);
}

static void
fu_unix_seekable_input_stream_class_init(FuUnixSeekableInputStreamClass *klass)
{
}

static void
fu_unix_seekable_input_stream_init(FuUnixSeekableInputStream *self)
{
}