glib/gio/tests/file.c
Colin Walters 978571d854 g_file_copy(): Ensure G_FILE_COPY_OVERWRITE preserves permissions
We need to close the stream *before* applying the file modes, because
g_file_replace() allocates a temporary file.  At the moment we're
applying the modes to the extant file, then immediately rename()ing
over it with the default perms.

This regressed with commit 166766a89f.

The real fix here is to have g_file_create_with_info() so that we can
atomically create a file with the permissions we want.

https://bugzilla.gnome.org/show_bug.cgi?id=696014
2013-03-25 16:32:39 -04:00

811 lines
22 KiB
C

#include <string.h>
#include <stdio.h>
#include <stdlib.h>
#include <gio/gio.h>
#include <gio/gfiledescriptorbased.h>
#ifdef G_OS_UNIX
#include <sys/stat.h>
#endif
static void
test_basic (void)
{
GFile *file;
gchar *s;
file = g_file_new_for_path ("./some/directory/testfile");
s = g_file_get_basename (file);
g_assert_cmpstr (s, ==, "testfile");
g_free (s);
s = g_file_get_uri (file);
g_assert (g_str_has_prefix (s, "file://"));
g_assert (g_str_has_suffix (s, "/some/directory/testfile"));
g_free (s);
g_assert (g_file_has_uri_scheme (file, "file"));
s = g_file_get_uri_scheme (file);
g_assert_cmpstr (s, ==, "file");
g_free (s);
g_object_unref (file);
}
static void
test_parent (void)
{
GFile *file;
GFile *file2;
GFile *parent;
GFile *root;
file = g_file_new_for_path ("./some/directory/testfile");
file2 = g_file_new_for_path ("./some/directory");
root = g_file_new_for_path ("/");
g_assert (g_file_has_parent (file, file2));
parent = g_file_get_parent (file);
g_assert (g_file_equal (parent, file2));
g_object_unref (parent);
g_assert (g_file_get_parent (root) == NULL);
g_object_unref (file);
g_object_unref (file2);
g_object_unref (root);
}
static void
test_child (void)
{
GFile *file;
GFile *child;
GFile *child2;
file = g_file_new_for_path ("./some/directory");
child = g_file_get_child (file, "child");
g_assert (g_file_has_parent (child, file));
child2 = g_file_get_child_for_display_name (file, "child2", NULL);
g_assert (g_file_has_parent (child2, file));
g_object_unref (child);
g_object_unref (child2);
g_object_unref (file);
}
static void
test_type (void)
{
GFile *file;
GFileType type;
GError *error = NULL;
file = g_file_new_for_path (SRCDIR "/file.c");
type = g_file_query_file_type (file, 0, NULL);
g_assert_cmpint (type, ==, G_FILE_TYPE_REGULAR);
g_object_unref (file);
file = g_file_new_for_path (SRCDIR "/schema-tests");
type = g_file_query_file_type (file, 0, NULL);
g_assert_cmpint (type, ==, G_FILE_TYPE_DIRECTORY);
g_file_read (file, NULL, &error);
g_assert_error (error, G_IO_ERROR, G_IO_ERROR_IS_DIRECTORY);
g_error_free (error);
g_object_unref (file);
}
typedef struct
{
GFile *file;
GFileMonitor *monitor;
GOutputStream *ostream;
GInputStream *istream;
GMainLoop *loop;
gint buffersize;
gint monitor_created;
gint monitor_deleted;
gint monitor_changed;
gchar *monitor_path;
gint pos;
gchar *data;
gchar *buffer;
guint timeout;
} CreateDeleteData;
static void
monitor_changed (GFileMonitor *monitor,
GFile *file,
GFile *other_file,
GFileMonitorEvent event_type,
gpointer user_data)
{
CreateDeleteData *data = user_data;
gchar *path;
path = g_file_get_path (file);
g_assert_cmpstr (data->monitor_path, ==, path);
g_free (path);
if (event_type == G_FILE_MONITOR_EVENT_CREATED)
data->monitor_created++;
if (event_type == G_FILE_MONITOR_EVENT_DELETED)
data->monitor_deleted++;
if (event_type == G_FILE_MONITOR_EVENT_CHANGED)
data->monitor_changed++;
}
static gboolean
quit_idle (gpointer user_data)
{
CreateDeleteData *data = user_data;
g_source_remove (data->timeout);
g_main_loop_quit (data->loop);
return FALSE;
}
static void
iclosed_cb (GObject *source,
GAsyncResult *res,
gpointer user_data)
{
CreateDeleteData *data = user_data;
GError *error;
gboolean ret;
error = NULL;
ret = g_input_stream_close_finish (data->istream, res, &error);
g_assert_no_error (error);
g_assert (ret);
g_assert (g_input_stream_is_closed (data->istream));
ret = g_file_delete (data->file, NULL, &error);
g_assert (ret);
g_assert_no_error (error);
/* work around file monitor bug:
* inotify events are only processed every 1000 ms, regardless
* of the rate limit set on the file monitor
*/
g_timeout_add (2000, quit_idle, data);
}
static void
read_cb (GObject *source,
GAsyncResult *res,
gpointer user_data)
{
CreateDeleteData *data = user_data;
GError *error;
gssize size;
error = NULL;
size = g_input_stream_read_finish (data->istream, res, &error);
g_assert_no_error (error);
data->pos += size;
if (data->pos < strlen (data->data))
{
g_input_stream_read_async (data->istream,
data->buffer + data->pos,
strlen (data->data) - data->pos,
0,
NULL,
read_cb,
data);
}
else
{
g_assert_cmpstr (data->buffer, ==, data->data);
g_assert (!g_input_stream_is_closed (data->istream));
g_input_stream_close_async (data->istream, 0, NULL, iclosed_cb, data);
}
}
static void
ipending_cb (GObject *source,
GAsyncResult *res,
gpointer user_data)
{
CreateDeleteData *data = user_data;
GError *error;
error = NULL;
g_input_stream_read_finish (data->istream, res, &error);
g_assert_error (error, G_IO_ERROR, G_IO_ERROR_PENDING);
g_error_free (error);
}
static void
skipped_cb (GObject *source,
GAsyncResult *res,
gpointer user_data)
{
CreateDeleteData *data = user_data;
GError *error;
gssize size;
error = NULL;
size = g_input_stream_skip_finish (data->istream, res, &error);
g_assert_no_error (error);
g_assert_cmpint (size, ==, data->pos);
g_input_stream_read_async (data->istream,
data->buffer + data->pos,
strlen (data->data) - data->pos,
0,
NULL,
read_cb,
data);
/* check that we get a pending error */
g_input_stream_read_async (data->istream,
data->buffer + data->pos,
strlen (data->data) - data->pos,
0,
NULL,
ipending_cb,
data);
}
static void
opened_cb (GObject *source,
GAsyncResult *res,
gpointer user_data)
{
GFileInputStream *base;
CreateDeleteData *data = user_data;
GError *error;
error = NULL;
base = g_file_read_finish (data->file, res, &error);
g_assert_no_error (error);
if (data->buffersize == 0)
data->istream = G_INPUT_STREAM (g_object_ref (base));
else
data->istream = g_buffered_input_stream_new_sized (G_INPUT_STREAM (base), data->buffersize);
g_object_unref (base);
data->buffer = g_new0 (gchar, strlen (data->data) + 1);
/* copy initial segment directly, then skip */
memcpy (data->buffer, data->data, 10);
data->pos = 10;
g_input_stream_skip_async (data->istream,
10,
0,
NULL,
skipped_cb,
data);
}
static void
oclosed_cb (GObject *source,
GAsyncResult *res,
gpointer user_data)
{
CreateDeleteData *data = user_data;
GError *error;
gboolean ret;
error = NULL;
ret = g_output_stream_close_finish (data->ostream, res, &error);
g_assert_no_error (error);
g_assert (ret);
g_assert (g_output_stream_is_closed (data->ostream));
g_file_read_async (data->file, 0, NULL, opened_cb, data);
}
static void
written_cb (GObject *source,
GAsyncResult *res,
gpointer user_data)
{
CreateDeleteData *data = user_data;
gssize size;
GError *error;
error = NULL;
size = g_output_stream_write_finish (data->ostream, res, &error);
g_assert_no_error (error);
data->pos += size;
if (data->pos < strlen (data->data))
{
g_output_stream_write_async (data->ostream,
data->data + data->pos,
strlen (data->data) - data->pos,
0,
NULL,
written_cb,
data);
}
else
{
g_assert (!g_output_stream_is_closed (data->ostream));
g_output_stream_close_async (data->ostream, 0, NULL, oclosed_cb, data);
}
}
static void
opending_cb (GObject *source,
GAsyncResult *res,
gpointer user_data)
{
CreateDeleteData *data = user_data;
GError *error;
error = NULL;
g_output_stream_write_finish (data->ostream, res, &error);
g_assert_error (error, G_IO_ERROR, G_IO_ERROR_PENDING);
g_error_free (error);
}
static void
created_cb (GObject *source,
GAsyncResult *res,
gpointer user_data)
{
GFileOutputStream *base;
CreateDeleteData *data = user_data;
GError *error;
error = NULL;
base = g_file_create_finish (G_FILE (source), res, &error);
g_assert_no_error (error);
g_assert (g_file_query_exists (data->file, NULL));
if (data->buffersize == 0)
data->ostream = G_OUTPUT_STREAM (g_object_ref (base));
else
data->ostream = g_buffered_output_stream_new_sized (G_OUTPUT_STREAM (base), data->buffersize);
g_object_unref (base);
g_output_stream_write_async (data->ostream,
data->data,
strlen (data->data),
0,
NULL,
written_cb,
data);
/* check that we get a pending error */
g_output_stream_write_async (data->ostream,
data->data,
strlen (data->data),
0,
NULL,
opending_cb,
data);
}
static gboolean
stop_timeout (gpointer data)
{
g_assert_not_reached ();
return FALSE;
}
/*
* This test does a fully async create-write-read-delete.
* Callbackistan.
*/
static void
test_create_delete (gconstpointer d)
{
GError *error;
CreateDeleteData *data;
GFileIOStream *iostream;
data = g_new0 (CreateDeleteData, 1);
data->buffersize = GPOINTER_TO_INT (d);
data->data = "abcdefghijklmnopqrstuvxyzABCDEFGHIJKLMNOPQRSTUVXYZ0123456789";
data->pos = 0;
data->file = g_file_new_tmp ("g_file_create_delete_XXXXXX",
&iostream, NULL);
g_assert (data->file != NULL);
g_object_unref (iostream);
data->monitor_path = g_file_get_path (data->file);
remove (data->monitor_path);
g_assert (!g_file_query_exists (data->file, NULL));
error = NULL;
data->monitor = g_file_monitor_file (data->file, 0, NULL, &error);
g_assert_no_error (error);
/* This test doesn't work with GPollFileMonitor, because it assumes
* that the monitor will notice a create immediately followed by a
* delete, rather than coalescing them into nothing.
*/
if (!strcmp (G_OBJECT_TYPE_NAME (data->monitor), "GPollFileMonitor"))
{
g_print ("skipping test for this GFileMonitor implementation");
goto skip;
}
g_file_monitor_set_rate_limit (data->monitor, 100);
g_signal_connect (data->monitor, "changed", G_CALLBACK (monitor_changed), data);
data->loop = g_main_loop_new (NULL, FALSE);
data->timeout = g_timeout_add (5000, stop_timeout, NULL);
g_file_create_async (data->file, 0, 0, NULL, created_cb, data);
g_main_loop_run (data->loop);
g_assert_cmpint (data->monitor_created, ==, 1);
g_assert_cmpint (data->monitor_deleted, ==, 1);
g_assert_cmpint (data->monitor_changed, >, 0);
g_assert (!g_file_monitor_is_cancelled (data->monitor));
g_file_monitor_cancel (data->monitor);
g_assert (g_file_monitor_is_cancelled (data->monitor));
g_main_loop_unref (data->loop);
g_object_unref (data->ostream);
g_object_unref (data->istream);
skip:
g_object_unref (data->monitor);
g_object_unref (data->file);
free (data->monitor_path);
g_free (data->buffer);
g_free (data);
}
static const gchar *replace_data =
"/**\n"
" * g_file_replace_contents_async:\n"
" * @file: input #GFile.\n"
" * @contents: string of contents to replace the file with.\n"
" * @length: the length of @contents in bytes.\n"
" * @etag: (allow-none): a new <link linkend=\"gfile-etag\">entity tag</link> for the @file, or %NULL\n"
" * @make_backup: %TRUE if a backup should be created.\n"
" * @flags: a set of #GFileCreateFlags.\n"
" * @cancellable: optional #GCancellable object, %NULL to ignore.\n"
" * @callback: a #GAsyncReadyCallback to call when the request is satisfied\n"
" * @user_data: the data to pass to callback function\n"
" * \n"
" * Starts an asynchronous replacement of @file with the given \n"
" * @contents of @length bytes. @etag will replace the document's\n"
" * current entity tag.\n"
" * \n"
" * When this operation has completed, @callback will be called with\n"
" * @user_user data, and the operation can be finalized with \n"
" * g_file_replace_contents_finish().\n"
" * \n"
" * If @cancellable is not %NULL, then the operation can be cancelled by\n"
" * triggering the cancellable object from another thread. If the operation\n"
" * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. \n"
" * \n"
" * If @make_backup is %TRUE, this function will attempt to \n"
" * make a backup of @file.\n"
" **/\n";
typedef struct
{
GFile *file;
const gchar *data;
GMainLoop *loop;
gboolean again;
} ReplaceLoadData;
static void replaced_cb (GObject *source,
GAsyncResult *res,
gpointer user_data);
static void
loaded_cb (GObject *source,
GAsyncResult *res,
gpointer user_data)
{
ReplaceLoadData *data = user_data;
gboolean ret;
GError *error;
gchar *contents;
gsize length;
error = NULL;
ret = g_file_load_contents_finish (data->file, res, &contents, &length, NULL, &error);
g_assert (ret);
g_assert_no_error (error);
g_assert_cmpint (length, ==, strlen (data->data));
g_assert_cmpstr (contents, ==, data->data);
g_free (contents);
if (data->again)
{
data->again = FALSE;
data->data = "pi pa po";
g_file_replace_contents_async (data->file,
data->data,
strlen (data->data),
NULL,
FALSE,
0,
NULL,
replaced_cb,
data);
}
else
{
error = NULL;
ret = g_file_delete (data->file, NULL, &error);
g_assert_no_error (error);
g_assert (ret);
g_assert (!g_file_query_exists (data->file, NULL));
g_main_loop_quit (data->loop);
}
}
static void
replaced_cb (GObject *source,
GAsyncResult *res,
gpointer user_data)
{
ReplaceLoadData *data = user_data;
GError *error;
error = NULL;
g_file_replace_contents_finish (data->file, res, NULL, &error);
g_assert_no_error (error);
g_file_load_contents_async (data->file, NULL, loaded_cb, data);
}
static void
test_replace_load (void)
{
ReplaceLoadData *data;
gchar *path;
GFileIOStream *iostream;
data = g_new0 (ReplaceLoadData, 1);
data->again = TRUE;
data->data = replace_data;
data->file = g_file_new_tmp ("g_file_replace_load_XXXXXX",
&iostream, NULL);
g_assert (data->file != NULL);
g_object_unref (iostream);
path = g_file_get_path (data->file);
remove (path);
g_assert (!g_file_query_exists (data->file, NULL));
data->loop = g_main_loop_new (NULL, FALSE);
g_file_replace_contents_async (data->file,
data->data,
strlen (data->data),
NULL,
FALSE,
0,
NULL,
replaced_cb,
data);
g_main_loop_run (data->loop);
g_main_loop_unref (data->loop);
g_object_unref (data->file);
g_free (data);
free (path);
}
static void
test_replace_cancel (void)
{
GFile *tmpdir, *file;
GFileOutputStream *ostream;
GFileEnumerator *fenum;
GFileInfo *info;
GCancellable *cancellable;
gchar *path;
gsize nwrote;
GError *error = NULL;
g_test_bug ("629301");
path = g_dir_make_tmp ("g_file_replace_cancel_XXXXXX", &error);
g_assert_no_error (error);
tmpdir = g_file_new_for_path (path);
g_free (path);
file = g_file_get_child (tmpdir, "file");
g_file_replace_contents (file,
replace_data,
strlen (replace_data),
NULL, FALSE, 0, NULL,
NULL, &error);
g_assert_no_error (error);
ostream = g_file_replace (file, NULL, TRUE, 0, NULL, &error);
g_assert_no_error (error);
g_output_stream_write_all (G_OUTPUT_STREAM (ostream),
replace_data, strlen (replace_data),
&nwrote, NULL, &error);
g_assert_no_error (error);
g_assert_cmpint (nwrote, ==, strlen (replace_data));
/* At this point there should be two files; the original and the
* temporary.
*/
fenum = g_file_enumerate_children (tmpdir, NULL, 0, NULL, &error);
g_assert_no_error (error);
info = g_file_enumerator_next_file (fenum, NULL, &error);
g_assert_no_error (error);
g_assert (info != NULL);
g_object_unref (info);
info = g_file_enumerator_next_file (fenum, NULL, &error);
g_assert_no_error (error);
g_assert (info != NULL);
g_object_unref (info);
g_file_enumerator_close (fenum, NULL, &error);
g_assert_no_error (error);
g_object_unref (fenum);
/* Make sure the temporary gets deleted even if we cancel. */
cancellable = g_cancellable_new ();
g_cancellable_cancel (cancellable);
g_output_stream_close (G_OUTPUT_STREAM (ostream), cancellable, &error);
g_assert_error (error, G_IO_ERROR, G_IO_ERROR_CANCELLED);
g_clear_error (&error);
g_object_unref (cancellable);
g_object_unref (ostream);
g_file_delete (file, NULL, &error);
g_assert_no_error (error);
g_object_unref (file);
/* This will only succeed if the temp file was deleted. */
g_file_delete (tmpdir, NULL, &error);
g_assert_no_error (error);
g_object_unref (tmpdir);
}
static void
on_file_deleted (GObject *object,
GAsyncResult *result,
gpointer user_data)
{
GError *local_error = NULL;
GMainLoop *loop = user_data;
(void) g_file_delete_finish ((GFile*)object, result, &local_error);
g_assert_no_error (local_error);
g_main_loop_quit (loop);
}
static void
test_async_delete (void)
{
GFile *file;
GFileIOStream *iostream;
GError *local_error = NULL;
GError **error = &local_error;
GMainLoop *loop;
file = g_file_new_tmp ("g_file_delete_XXXXXX",
&iostream, error);
g_assert_no_error (local_error);
g_object_unref (iostream);
g_assert (g_file_query_exists (file, NULL));
loop = g_main_loop_new (NULL, TRUE);
g_file_delete_async (file, G_PRIORITY_DEFAULT, NULL, on_file_deleted, loop);
g_main_loop_run (loop);
g_assert (!g_file_query_exists (file, NULL));
g_main_loop_unref (loop);
g_object_unref (file);
}
#ifdef G_OS_UNIX
static void
test_copy_preserve_mode (void)
{
GFile *tmpfile;
GFile *dest_tmpfile;
GFileInfo *dest_info;
GFileIOStream *iostream;
GError *local_error = NULL;
GError **error = &local_error;
guint32 romode = S_IFREG | 0600;
guint32 dest_mode;
tmpfile = g_file_new_tmp ("tmp-copy-preserve-modeXXXXXX",
&iostream, error);
g_assert_no_error (local_error);
g_io_stream_close ((GIOStream*)iostream, NULL, error);
g_assert_no_error (local_error);
g_clear_object (&iostream);
g_file_set_attribute (tmpfile, G_FILE_ATTRIBUTE_UNIX_MODE, G_FILE_ATTRIBUTE_TYPE_UINT32,
&romode, G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
NULL, error);
g_assert_no_error (local_error);
dest_tmpfile = g_file_new_tmp ("tmp-copy-preserve-modeXXXXXX",
&iostream, error);
g_assert_no_error (local_error);
g_io_stream_close ((GIOStream*)iostream, NULL, error);
g_assert_no_error (local_error);
g_clear_object (&iostream);
g_file_copy (tmpfile, dest_tmpfile, G_FILE_COPY_OVERWRITE | G_FILE_COPY_NOFOLLOW_SYMLINKS | G_FILE_COPY_ALL_METADATA,
NULL, NULL, NULL, error);
g_assert_no_error (local_error);
dest_info = g_file_query_info (dest_tmpfile, G_FILE_ATTRIBUTE_UNIX_MODE, G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
NULL, error);
g_assert_no_error (local_error);
dest_mode = g_file_info_get_attribute_uint32 (dest_info, G_FILE_ATTRIBUTE_UNIX_MODE);
g_assert_cmpint (dest_mode, ==, romode);
(void) g_file_delete (tmpfile, NULL, NULL);
(void) g_file_delete (dest_tmpfile, NULL, NULL);
g_clear_object (&tmpfile);
g_clear_object (&dest_tmpfile);
g_clear_object (&dest_info);
}
#endif
int
main (int argc, char *argv[])
{
g_test_init (&argc, &argv, NULL);
g_test_bug_base ("http://bugzilla.gnome.org/");
g_test_add_func ("/file/basic", test_basic);
g_test_add_func ("/file/parent", test_parent);
g_test_add_func ("/file/child", test_child);
g_test_add_func ("/file/type", test_type);
g_test_add_data_func ("/file/async-create-delete/0", GINT_TO_POINTER (0), test_create_delete);
g_test_add_data_func ("/file/async-create-delete/1", GINT_TO_POINTER (1), test_create_delete);
g_test_add_data_func ("/file/async-create-delete/10", GINT_TO_POINTER (10), test_create_delete);
g_test_add_data_func ("/file/async-create-delete/25", GINT_TO_POINTER (25), test_create_delete);
g_test_add_data_func ("/file/async-create-delete/4096", GINT_TO_POINTER (4096), test_create_delete);
g_test_add_func ("/file/replace-load", test_replace_load);
g_test_add_func ("/file/replace-cancel", test_replace_cancel);
g_test_add_func ("/file/async-delete", test_async_delete);
#ifdef G_OS_UNIX
g_test_add_func ("/file/copy-preserve-mode", test_copy_preserve_mode);
#endif
return g_test_run ();
}