luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-25 15:06:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

vfs: add g_vfs_register_uri_scheme()

Browse Source 
Add a new API to allow clients to register a custom GFile implementation
handling a particular URI scheme.
This can be useful for tests, but also for cases where a different URI
scheme is desired to be used with another custom GFile backend.

As an additional cleanup, we can use this to register the "resource" URI
scheme too.

Based on a patch by Jasper St. Pierre <jstpierre@mecheye.net>.

https://bugzilla.gnome.org/show_bug.cgi?id=767887
This commit is contained in:
Cosimo Cecchi 2016-06-20 11:42:56 -07:00 committed by Cosimo Cecchi
parent 4442bf2c95
commit 375b4ca65c
4 changed files with 403 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/reference/gio/gio-sections.txt
View File

@ -42,6 +42,7 @@ g_async_initable_get_type
<FILE>gvfs</FILE>
<TITLE>GVfs</TITLE>
GVfs
GVfsFileLookupFunc
G_VFS_EXTENSION_POINT_NAME
g_vfs_get_file_for_path
g_vfs_get_file_for_uri
@ -50,6 +51,8 @@ g_vfs_get_default
g_vfs_get_local
g_vfs_is_active
g_vfs_get_supported_uri_schemes
g_vfs_register_uri_scheme
g_vfs_unregister_uri_scheme
<SUBSECTION Standard>
GVfsClass
G_VFS

304
gio/gvfs.c
View File

@ -37,16 +37,87 @@
*
*/
G_DEFINE_TYPE (GVfs, g_vfs, G_TYPE_OBJECT);
static GRWLock additional_schemes_lock;
typedef struct _GVfsPrivate {
GHashTable *additional_schemes;
char const **supported_schemes;
} GVfsPrivate;
typedef struct {
GVfsFileLookupFunc uri_func;
gpointer uri_data;
GDestroyNotify uri_destroy;
GVfsFileLookupFunc parse_name_func;
gpointer parse_name_data;
GDestroyNotify parse_name_destroy;
} GVfsURISchemeData;
G_DEFINE_TYPE_WITH_PRIVATE (GVfs, g_vfs, G_TYPE_OBJECT);
static void
g_vfs_dispose (GObject *object)
{
GVfs *vfs = G_VFS (object);
GVfsPrivate *priv = g_vfs_get_instance_private (vfs);
g_clear_pointer (&priv->additional_schemes, g_hash_table_destroy);
g_clear_pointer (&priv->supported_schemes, g_free);
G_OBJECT_CLASS (g_vfs_parent_class)->dispose (object);
}
static void
g_vfs_class_init (GVfsClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
object_class->dispose = g_vfs_dispose;
}
static GFile *
resource_parse_name (GVfs *vfs,
const char *parse_name,
gpointer user_data)
{
if (g_str_has_prefix (parse_name, "resource:"))
return _g_resource_file_new (parse_name);
return NULL;
}
static GFile *
resource_get_file_for_uri (GVfs *vfs,
const char *uri,
gpointer user_data)
{
return _g_resource_file_new (uri);
}
static void
g_vfs_uri_lookup_func_closure_free (gpointer data)
{
GVfsURISchemeData *closure = data;
if (closure->uri_destroy)
closure->uri_destroy (closure->uri_data);
if (closure->parse_name_destroy)
closure->parse_name_destroy (closure->parse_name_data);
g_free (closure);
}
static void
g_vfs_init (GVfs *vfs)
{
GVfsPrivate *priv = g_vfs_get_instance_private (vfs);
priv->additional_schemes =
g_hash_table_new_full (g_str_hash, g_str_equal,
g_free, g_vfs_uri_lookup_func_closure_free);
g_vfs_register_uri_scheme (vfs, "resource",
resource_get_file_for_uri, NULL, NULL,
resource_parse_name, NULL, NULL);
}
/**
@ -95,6 +166,58 @@ g_vfs_get_file_for_path (GVfs *vfs,
return (* class->get_file_for_path) (vfs, path);
}
static GFile *
parse_name_internal (GVfs *vfs,
const char *parse_name)
{
GVfsPrivate *priv = g_vfs_get_instance_private (vfs);
GHashTableIter iter;
GVfsURISchemeData *closure;
GFile *ret = NULL;
g_rw_lock_reader_lock (&additional_schemes_lock);
g_hash_table_iter_init (&iter, priv->additional_schemes);
while (TRUE)
{
if (g_hash_table_iter_next (&iter, NULL, (gpointer *) &closure))
ret = closure->parse_name_func (vfs, parse_name,
closure->parse_name_data);
if (ret)
break;
}
g_rw_lock_reader_unlock (&additional_schemes_lock);
return ret;
}
static GFile *
get_file_for_uri_internal (GVfs *vfs,
const char *uri)
{
GVfsPrivate *priv = g_vfs_get_instance_private (vfs);
GFile *ret = NULL;
char *scheme;
GVfsURISchemeData *closure;
scheme = g_uri_parse_scheme (uri);
if (scheme == NULL)
return NULL;
g_rw_lock_reader_lock (&additional_schemes_lock);
closure = g_hash_table_lookup (priv->additional_schemes, scheme);
if (closure)
ret = closure->uri_func (vfs, uri, closure->uri_data);
g_rw_lock_reader_unlock (&additional_schemes_lock);
g_free (scheme);
return ret;
}
/**
* g_vfs_get_file_for_uri:
* @vfs: a#GVfs.
@ -114,19 +237,16 @@ g_vfs_get_file_for_uri (GVfs *vfs,
const char *uri)
{
GVfsClass *class;
GFile *ret;
g_return_val_if_fail (G_IS_VFS (vfs), NULL);
g_return_val_if_fail (uri != NULL, NULL);
class = G_VFS_GET_CLASS (vfs);
/* This is an unfortunate placement, but we really
* need to check this before chaining to the vfs,
* because we want to support resource uris for
* all vfs:es, even those that predate resources.
*/
if (g_str_has_prefix (uri, "resource:"))
return _g_resource_file_new (uri);
ret = get_file_for_uri_internal (vfs, uri);
if (ret)
return ret;
return (* class->get_file_for_uri) (vfs, uri);
}
@ -144,13 +264,44 @@ g_vfs_get_file_for_uri (GVfs *vfs,
const gchar * const *
g_vfs_get_supported_uri_schemes (GVfs *vfs)
{
GVfsClass *class;
GVfsPrivate *priv;
g_return_val_if_fail (G_IS_VFS (vfs), NULL);
class = G_VFS_GET_CLASS (vfs);
priv = g_vfs_get_instance_private (vfs);
return (* class->get_supported_uri_schemes) (vfs);
if (!priv->supported_schemes)
{
GVfsClass *class;
const char * const *default_schemes;
const char *additional_scheme;
GPtrArray *supported_schemes;
GHashTableIter iter;
int idx;
class = G_VFS_GET_CLASS (vfs);
default_schemes = (* class->get_supported_uri_schemes) (vfs);
supported_schemes = g_ptr_array_new ();
for (idx = 0; idx < G_N_ELEMENTS (default_schemes); idx++)
g_ptr_array_add (supported_schemes, (gpointer) default_schemes[idx]);
g_rw_lock_reader_lock (&additional_schemes_lock);
g_hash_table_iter_init (&iter, priv->additional_schemes);
while (g_hash_table_iter_next
(&iter, (gpointer *) &additional_scheme, NULL))
g_ptr_array_add (supported_schemes, (gpointer) additional_scheme);
g_rw_lock_reader_unlock (&additional_schemes_lock);
g_free (priv->supported_schemes);
priv->supported_schemes =
(char const **) g_ptr_array_free (supported_schemes, FALSE);
}
return priv->supported_schemes;
}
/**
@ -170,14 +321,16 @@ g_vfs_parse_name (GVfs *vfs,
const char *parse_name)
{
GVfsClass *class;
GFile *ret;
g_return_val_if_fail (G_IS_VFS (vfs), NULL);
g_return_val_if_fail (parse_name != NULL, NULL);
class = G_VFS_GET_CLASS (vfs);
if (g_str_has_prefix (parse_name, "resource:"))
return _g_resource_file_new (parse_name);
ret = parse_name_internal (vfs, parse_name);
if (ret)
return ret;
return (* class->parse_name) (vfs, parse_name);
}
@ -216,3 +369,128 @@ g_vfs_get_local (void)
return G_VFS (vfs);
}
/**
* g_vfs_register_uri_scheme:
* @vfs: a #GVfs
* @scheme: an URI scheme, e.g. "http"
* @uri_func: (scope notified) (nullable): a #GVfsFileLookupFunc
* @uri_data: (nullable): custom data passed to be passed to @uri_func, or %NULL
* @uri_destroy: (nullable): function to be called when unregistering the
* URI scheme, or when @vfs is disposed, to free the resources used
* by the URI lookup function
* @parse_name_func: (scope notified) (nullable): a #GVfsFileLookupFunc
* @parse_name_data: (nullable): custom data passed to be passed to
* @parse_name_func, or %NULL
* @parse_name_destroy: (nullable): function to be called when unregistering the
* URI scheme, or when @vfs is disposed, to free the resources used
* by the parse name lookup function
*
* Registers @uri_func and @parse_name_func as the #GFile URI and parse name
* lookup functions for URIs with a scheme matching @scheme.
* Note that @scheme is registered only within the running application, as
* opposed to desktop-wide as it happens with GVfs backends.
*
* When a #GFile is requested with an URI containing @scheme (e.g. through
* g_file_new_for_uri()), @uri_func will be called to allow a custom
* constructor. The implementation of @uri_func should not be blocking, and
* must not call g_vfs_register_uri_scheme() or g_vfs_unregister_uri_scheme().
*
* When g_file_parse_name() is called with a parse name obtained from such file,
* @parse_name_func will be called to allow the #GFile to be created again. In
* that case, it's responsibility of @parse_name_func to make sure the parse
* name matches what the custom #GFile implementation returned when
* g_file_get_parse_name() was previously called. The implementation of
* @parse_name_func should not be blocking, and must not call
* g_vfs_register_uri_scheme() or g_vfs_unregister_uri_scheme().
*
* It's an error to call this function twice with the same scheme. To unregister
* a custom URI scheme, use g_vfs_unregister_uri_scheme().
*
* Returns: %TRUE if @scheme was successfully registered, or %FALSE if a handler
* for @scheme already exists.
*
* Since: 2.50
*/
gboolean
g_vfs_register_uri_scheme (GVfs *vfs,
const char *scheme,
GVfsFileLookupFunc uri_func,
gpointer uri_data,
GDestroyNotify uri_destroy,
GVfsFileLookupFunc parse_name_func,
gpointer parse_name_data,
GDestroyNotify parse_name_destroy)
{
GVfsPrivate *priv;
GVfsURISchemeData *closure;
g_return_val_if_fail (G_IS_VFS (vfs), FALSE);
g_return_val_if_fail (scheme != NULL, FALSE);
priv = g_vfs_get_instance_private (vfs);
g_rw_lock_reader_lock (&additional_schemes_lock);
closure = g_hash_table_lookup (priv->additional_schemes, scheme);
g_rw_lock_reader_unlock (&additional_schemes_lock);
if (closure != NULL)
return FALSE;
closure = g_new0 (GVfsURISchemeData, 1);
closure->uri_func = uri_func;
closure->uri_data = uri_data;
closure->uri_destroy = uri_destroy;
closure->parse_name_func = parse_name_func;
closure->parse_name_data = parse_name_data;
closure->parse_name_destroy = parse_name_destroy;
g_rw_lock_writer_lock (&additional_schemes_lock);
g_hash_table_insert (priv->additional_schemes, g_strdup (scheme), closure);
g_rw_lock_writer_unlock (&additional_schemes_lock);
/* Invalidate supported schemes */
g_clear_pointer (&priv->supported_schemes, g_free);
return TRUE;
}
/**
* g_vfs_unregister_uri_scheme:
* @vfs: a #GVfs
* @scheme: an URI scheme, e.g. "http"
*
* Unregisters the URI handler for @scheme previously registered with
* g_vfs_register_uri_scheme().
*
* Returns: %TRUE if @scheme was successfully unregistered, or %FALSE if a
* handler for @scheme does not exist.
*
* Since: 2.50
*/
gboolean
g_vfs_unregister_uri_scheme (GVfs *vfs,
const char *scheme)
{
GVfsPrivate *priv;
gboolean res;
g_return_val_if_fail (G_IS_VFS (vfs), FALSE);
g_return_val_if_fail (scheme != NULL, FALSE);
priv = g_vfs_get_instance_private (vfs);
g_rw_lock_writer_lock (&additional_schemes_lock);
res = g_hash_table_remove (priv->additional_schemes, scheme);
g_rw_lock_writer_unlock (&additional_schemes_lock);
if (res)
{
/* Invalidate supported schemes */
g_clear_pointer (&priv->supported_schemes, g_free);
return TRUE;
}
return FALSE;
}

36
gio/gvfs.h
View File

@ -36,6 +36,28 @@ G_BEGIN_DECLS
#define G_IS_VFS(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_VFS))
#define G_IS_VFS_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_VFS))
/**
* GVfsFileLookupFunc:
* @vfs: a #GVfs
* @identifier: the identifier to lookup a #GFile for. This can either
* be an URI or a parse name as returned by g_file_get_parse_name()
* @user_data: user data passed to the function
*
* This function type is used by g_vfs_register_uri_scheme() to make it
* possible for a client to associate an URI scheme to a different #GFile
* implementation.
*
* The client should return a reference to the new file that has been
* created for @uri, or %NULL to continue with the default implementation.
*
* Returns: (transfer full): a #GFile for @identifier.
*
* Since: 2.50
*/
typedef GFile * (* GVfsFileLookupFunc) (GVfs *vfs,
const char *identifier,
gpointer user_data);
/**
* G_VFS_EXTENSION_POINT_NAME:
*
@ -127,6 +149,20 @@ GVfs * g_vfs_get_default (void);
GLIB_AVAILABLE_IN_ALL
GVfs * g_vfs_get_local (void);
GLIB_AVAILABLE_IN_2_50
gboolean g_vfs_register_uri_scheme (GVfs *vfs,
const char *scheme,
GVfsFileLookupFunc uri_func,
gpointer uri_data,
GDestroyNotify uri_destroy,
GVfsFileLookupFunc parse_name_func,
gpointer parse_name_data,
GDestroyNotify parse_name_destroy);
GLIB_AVAILABLE_IN_2_50
gboolean g_vfs_unregister_uri_scheme (GVfs *vfs,
const char *scheme);
G_END_DECLS
#endif /* __G_VFS_H__ */

73
gio/tests/vfs.c
View File

@ -23,6 +23,78 @@
#include <gio/gio.h>
static GFile *
test_vfs_parse_name (GVfs *vfs,
const char *parse_name,
gpointer user_data)
{
GFile *file = NULL;
if (g_strcmp0 ((parse_name), "testfile") == 0)
{
file = g_file_new_for_uri ("file:///");
g_object_set_data (G_OBJECT (file), "testfile", GINT_TO_POINTER (1));
}
return file;
}
static GFile *
test_vfs_lookup (GVfs *vfs,
const char *uri,
gpointer user_data)
{
GFile *file;
file = g_file_new_for_uri ("file:///");
g_object_set_data (G_OBJECT (file), "testfile", GINT_TO_POINTER (1));
return file;
}
static void
test_register_scheme (void)
{
GVfs *vfs;
GFile *file;
const gchar * const *schemes;
gboolean res;
vfs = g_vfs_get_default ();
g_assert_nonnull (vfs);
g_assert_true (g_vfs_is_active (vfs));
res = g_vfs_unregister_uri_scheme (vfs, "test");
g_assert_false (res);
res = g_vfs_register_uri_scheme (vfs, "test",
test_vfs_lookup, NULL, NULL,
test_vfs_parse_name, NULL, NULL);
g_assert_true (res);
schemes = g_vfs_get_supported_uri_schemes (vfs);
g_assert_true (g_strv_contains (schemes, "test"));
file = g_file_new_for_uri ("test:///foo");
g_assert_cmpint (GPOINTER_TO_INT (g_object_get_data (G_OBJECT (file), "testfile")), ==, 1);
g_object_unref (file);
file = g_file_parse_name ("testfile");
g_assert_cmpint (GPOINTER_TO_INT (g_object_get_data (G_OBJECT (file), "testfile")), ==, 1);
g_object_unref (file);
res = g_vfs_register_uri_scheme (vfs, "test",
test_vfs_lookup, NULL, NULL,
test_vfs_parse_name, NULL, NULL);
g_assert_false (res);
res = g_vfs_unregister_uri_scheme (vfs, "test");
g_assert_true (res);
file = g_file_new_for_uri ("test:///foo");
g_assert_null (g_object_get_data (G_OBJECT (file), "testfile"));
g_object_unref (file);
}
static void
test_local (void)
{
@ -49,6 +121,7 @@ main (int argc, char *argv[])
g_test_init (&argc, &argv, NULL);
g_test_add_func ("/gvfs/local", test_local);
g_test_add_func ("/gvfs/register-scheme", test_register_scheme);
return g_test_run ();
}