gio/gvfs.c

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2006-2007 Red Hat, Inc.
   4  *
   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.1 of the License, or (at your option) any later version.
   9  *
  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.
  14  *
  15  * You should have received a copy of the GNU Lesser General
  16  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
  17  *
  18  * Author: Alexander Larsson <alexl@redhat.com>
  19  */
  20
  21 #include "config.h"
  22 #include <string.h>
  23 #include "gvfs.h"
  24 #include "glib-private.h"
  25 #include "glocalvfs.h"
  26 #include "gresourcefile.h"
  27 #include "giomodule-priv.h"
  28 #include "glibintl.h"
  29
  30
  31 /**
  32  * SECTION:gvfs
  33  * @short_description: Virtual File System
  34  * @include: gio/gio.h
  35  *
  36  * Entry point for using GIO functionality.
  37  *
  38  */
  39
  40 static GRWLock additional_schemes_lock;
  41
  42 typedef struct _GVfsPrivate {
  43   GHashTable *additional_schemes;
  44   char const **supported_schemes;
  45 } GVfsPrivate;
  46
  47 typedef struct {
  48   GVfsFileLookupFunc uri_func;
  49   gpointer uri_data;
  50   GDestroyNotify uri_destroy;
  51
  52   GVfsFileLookupFunc parse_name_func;
  53   gpointer parse_name_data;
  54   GDestroyNotify parse_name_destroy;
  55 } GVfsURISchemeData;
  56
  57 G_DEFINE_TYPE_WITH_PRIVATE (GVfs, g_vfs, G_TYPE_OBJECT)
  58
  59 static void
  60 g_vfs_dispose (GObject *object)
  61 {
  62   GVfs *vfs = G_VFS (object);
  63   GVfsPrivate *priv = g_vfs_get_instance_private (vfs);
  64
  65   g_clear_pointer (&priv->additional_schemes, g_hash_table_destroy);
  66   g_clear_pointer (&priv->supported_schemes, g_free);
  67
  68   G_OBJECT_CLASS (g_vfs_parent_class)->dispose (object);
  69 }
  70
  71 static void
  72 g_vfs_class_init (GVfsClass *klass)
  73 {
  74   GObjectClass *object_class = G_OBJECT_CLASS (klass);
  75   object_class->dispose = g_vfs_dispose;
  76 }
  77
  78 static GFile *
  79 resource_parse_name (GVfs       *vfs,
  80                      const char *parse_name,
  81                      gpointer    user_data)
  82 {
  83   if (g_str_has_prefix (parse_name, "resource:"))
  84     return _g_resource_file_new (parse_name);
  85
  86   return NULL;
  87 }
  88
  89 static GFile *
  90 resource_get_file_for_uri (GVfs       *vfs,
  91                            const char *uri,
  92                            gpointer    user_data)
  93 {
  94   return _g_resource_file_new (uri);
  95 }
  96
  97 static void
  98 g_vfs_uri_lookup_func_closure_free (gpointer data)
  99 {
 100   GVfsURISchemeData *closure = data;
 101
 102   if (closure->uri_destroy)
 103     closure->uri_destroy (closure->uri_data);
 104   if (closure->parse_name_destroy)
 105     closure->parse_name_destroy (closure->parse_name_data);
 106
 107   g_free (closure);
 108 }
 109
 110 static void
 111 g_vfs_init (GVfs *vfs)
 112 {
 113   GVfsPrivate *priv = g_vfs_get_instance_private (vfs);
 114   priv->additional_schemes =
 115     g_hash_table_new_full (g_str_hash, g_str_equal,
 116                            g_free, g_vfs_uri_lookup_func_closure_free);
 117
 118   g_vfs_register_uri_scheme (vfs, "resource",
 119                              resource_get_file_for_uri, NULL, NULL,
 120                              resource_parse_name, NULL, NULL);
 121 }
 122
 123 /**
 124  * g_vfs_is_active:
 125  * @vfs: a #GVfs.
 126  *
 127  * Checks if the VFS is active.
 128  *
 129  * Returns: %TRUE if construction of the @vfs was successful
 130  *     and it is now active.
 131  */
 132 gboolean
 133 g_vfs_is_active (GVfs *vfs)
 134 {
 135   GVfsClass *class;
 136
 137   g_return_val_if_fail (G_IS_VFS (vfs), FALSE);
 138
 139   class = G_VFS_GET_CLASS (vfs);
 140
 141   return (* class->is_active) (vfs);
 142 }
 143
 144
 145 /**
 146  * g_vfs_get_file_for_path:
 147  * @vfs: a #GVfs.
 148  * @path: a string containing a VFS path.
 149  *
 150  * Gets a #GFile for @path.
 151  *
 152  * Returns: (transfer full): a #GFile.
 153  *     Free the returned object with g_object_unref().
 154  */
 155 GFile *
 156 g_vfs_get_file_for_path (GVfs       *vfs,
 157                          const char *path)
 158 {
 159   GVfsClass *class;
 160
 161   g_return_val_if_fail (G_IS_VFS (vfs), NULL);
 162   g_return_val_if_fail (path != NULL, NULL);
 163
 164   class = G_VFS_GET_CLASS (vfs);
 165
 166   return (* class->get_file_for_path) (vfs, path);
 167 }
 168
 169 static GFile *
 170 parse_name_internal (GVfs       *vfs,
 171                      const char *parse_name)
 172 {
 173   GVfsPrivate *priv = g_vfs_get_instance_private (vfs);
 174   GHashTableIter iter;
 175   GVfsURISchemeData *closure;
 176   GFile *ret = NULL;
 177
 178   g_rw_lock_reader_lock (&additional_schemes_lock);
 179   g_hash_table_iter_init (&iter, priv->additional_schemes);
 180
 181   while (g_hash_table_iter_next (&iter, NULL, (gpointer *) &closure))
 182     {
 183       ret = closure->parse_name_func (vfs, parse_name,
 184                                       closure->parse_name_data);
 185
 186       if (ret)
 187         break;
 188     }
 189
 190   g_rw_lock_reader_unlock (&additional_schemes_lock);
 191
 192   return ret;
 193 }
 194
 195 static GFile *
 196 get_file_for_uri_internal (GVfs       *vfs,
 197                            const char *uri)
 198 {
 199   GVfsPrivate *priv = g_vfs_get_instance_private (vfs);
 200   GFile *ret = NULL;
 201   char *scheme;
 202   GVfsURISchemeData *closure;
 203
 204   scheme = g_uri_parse_scheme (uri);
 205   if (scheme == NULL)
 206     return NULL;
 207
 208   g_rw_lock_reader_lock (&additional_schemes_lock);
 209   closure = g_hash_table_lookup (priv->additional_schemes, scheme);
 210
 211   if (closure)
 212     ret = closure->uri_func (vfs, uri, closure->uri_data);
 213
 214   g_rw_lock_reader_unlock (&additional_schemes_lock);
 215
 216   g_free (scheme);
 217   return ret;
 218 }
 219
 220 /**
 221  * g_vfs_get_file_for_uri:
 222  * @vfs: a#GVfs.
 223  * @uri: a string containing a URI
 224  *
 225  * Gets a #GFile for @uri.
 226  *
 227  * This operation never fails, but the returned object
 228  * might not support any I/O operation if the URI
 229  * is malformed or if the URI scheme is not supported.
 230  *
 231  * Returns: (transfer full): a #GFile.
 232  *     Free the returned object with g_object_unref().
 233  */
 234 GFile *
 235 g_vfs_get_file_for_uri (GVfs       *vfs,
 236                         const char *uri)
 237 {
 238   GVfsClass *class;
 239   GFile *ret;
 240
 241   g_return_val_if_fail (G_IS_VFS (vfs), NULL);
 242   g_return_val_if_fail (uri != NULL, NULL);
 243
 244   class = G_VFS_GET_CLASS (vfs);
 245
 246   ret = get_file_for_uri_internal (vfs, uri);
 247   if (ret)
 248     return ret;
 249
 250   return (* class->get_file_for_uri) (vfs, uri);
 251 }
 252
 253 /**
 254  * g_vfs_get_supported_uri_schemes:
 255  * @vfs: a #GVfs.
 256  *
 257  * Gets a list of URI schemes supported by @vfs.
 258  *
 259  * Returns: (transfer none): a %NULL-terminated array of strings.
 260  *     The returned array belongs to GIO and must
 261  *     not be freed or modified.
 262  */
 263 const gchar * const *
 264 g_vfs_get_supported_uri_schemes (GVfs *vfs)
 265 {
 266   GVfsPrivate *priv;
 267
 268   g_return_val_if_fail (G_IS_VFS (vfs), NULL);
 269
 270   priv = g_vfs_get_instance_private (vfs);
 271
 272   if (!priv->supported_schemes)
 273     {
 274       GVfsClass *class;
 275       const char * const *default_schemes;
 276       const char *additional_scheme;
 277       GPtrArray *supported_schemes;
 278       GHashTableIter iter;
 279
 280       class = G_VFS_GET_CLASS (vfs);
 281
 282       default_schemes = (* class->get_supported_uri_schemes) (vfs);
 283       supported_schemes = g_ptr_array_new ();
 284
 285       for (; default_schemes && *default_schemes; default_schemes++)
 286         g_ptr_array_add (supported_schemes, (gpointer) *default_schemes);
 287
 288       g_rw_lock_reader_lock (&additional_schemes_lock);
 289       g_hash_table_iter_init (&iter, priv->additional_schemes);
 290
 291       while (g_hash_table_iter_next
 292              (&iter, (gpointer *) &additional_scheme, NULL))
 293         g_ptr_array_add (supported_schemes, (gpointer) additional_scheme);
 294
 295       g_rw_lock_reader_unlock (&additional_schemes_lock);
 296
 297       g_ptr_array_add (supported_schemes, NULL);
 298
 299       g_free (priv->supported_schemes);
 300       priv->supported_schemes =
 301         (char const **) g_ptr_array_free (supported_schemes, FALSE);
 302     }
 303
 304   return priv->supported_schemes;
 305 }
 306
 307 /**
 308  * g_vfs_parse_name:
 309  * @vfs: a #GVfs.
 310  * @parse_name: a string to be parsed by the VFS module.
 311  *
 312  * This operation never fails, but the returned object might
 313  * not support any I/O operations if the @parse_name cannot
 314  * be parsed by the #GVfs module.
 315  *
 316  * Returns: (transfer full): a #GFile for the given @parse_name.
 317  *     Free the returned object with g_object_unref().
 318  */
 319 GFile *
 320 g_vfs_parse_name (GVfs       *vfs,
 321                   const char *parse_name)
 322 {
 323   GVfsClass *class;
 324   GFile *ret;
 325
 326   g_return_val_if_fail (G_IS_VFS (vfs), NULL);
 327   g_return_val_if_fail (parse_name != NULL, NULL);
 328
 329   class = G_VFS_GET_CLASS (vfs);
 330
 331   ret = parse_name_internal (vfs, parse_name);
 332   if (ret)
 333     return ret;
 334
 335   return (* class->parse_name) (vfs, parse_name);
 336 }
 337
 338 /**
 339  * g_vfs_get_default:
 340  *
 341  * Gets the default #GVfs for the system.
 342  *
 343  * Returns: (transfer none): a #GVfs.
 344  */
 345 GVfs *
 346 g_vfs_get_default (void)
 347 {
 348   if (GLIB_PRIVATE_CALL (g_check_setuid) ())
 349     return g_vfs_get_local ();
 350   return _g_io_module_get_default (G_VFS_EXTENSION_POINT_NAME,
 351                                    "GIO_USE_VFS",
 352                                    (GIOModuleVerifyFunc)g_vfs_is_active);
 353 }
 354
 355 /**
 356  * g_vfs_get_local:
 357  *
 358  * Gets the local #GVfs for the system.
 359  *
 360  * Returns: (transfer none): a #GVfs.
 361  */
 362 GVfs *
 363 g_vfs_get_local (void)
 364 {
 365   static gsize vfs = 0;
 366
 367   if (g_once_init_enter (&vfs))
 368     g_once_init_leave (&vfs, (gsize)_g_local_vfs_new ());
 369
 370   return G_VFS (vfs);
 371 }
 372
 373 /**
 374  * g_vfs_register_uri_scheme:
 375  * @vfs: a #GVfs
 376  * @scheme: an URI scheme, e.g. "http"
 377  * @uri_func: (scope notified) (nullable): a #GVfsFileLookupFunc
 378  * @uri_data: (nullable): custom data passed to be passed to @uri_func, or %NULL
 379  * @uri_destroy: (nullable): function to be called when unregistering the
 380  *     URI scheme, or when @vfs is disposed, to free the resources used
 381  *     by the URI lookup function
 382  * @parse_name_func: (scope notified) (nullable): a #GVfsFileLookupFunc
 383  * @parse_name_data: (nullable): custom data passed to be passed to
 384  *     @parse_name_func, or %NULL
 385  * @parse_name_destroy: (nullable): function to be called when unregistering the
 386  *     URI scheme, or when @vfs is disposed, to free the resources used
 387  *     by the parse name lookup function
 388  *
 389  * Registers @uri_func and @parse_name_func as the #GFile URI and parse name
 390  * lookup functions for URIs with a scheme matching @scheme.
 391  * Note that @scheme is registered only within the running application, as
 392  * opposed to desktop-wide as it happens with GVfs backends.
 393  *
 394  * When a #GFile is requested with an URI containing @scheme (e.g. through
 395  * g_file_new_for_uri()), @uri_func will be called to allow a custom
 396  * constructor. The implementation of @uri_func should not be blocking, and
 397  * must not call g_vfs_register_uri_scheme() or g_vfs_unregister_uri_scheme().
 398  *
 399  * When g_file_parse_name() is called with a parse name obtained from such file,
 400  * @parse_name_func will be called to allow the #GFile to be created again. In
 401  * that case, it's responsibility of @parse_name_func to make sure the parse
 402  * name matches what the custom #GFile implementation returned when
 403  * g_file_get_parse_name() was previously called. The implementation of
 404  * @parse_name_func should not be blocking, and must not call
 405  * g_vfs_register_uri_scheme() or g_vfs_unregister_uri_scheme().
 406  *
 407  * It's an error to call this function twice with the same scheme. To unregister
 408  * a custom URI scheme, use g_vfs_unregister_uri_scheme().
 409  *
 410  * Returns: %TRUE if @scheme was successfully registered, or %FALSE if a handler
 411  *     for @scheme already exists.
 412  *
 413  * Since: 2.50
 414  */
 415 gboolean
 416 g_vfs_register_uri_scheme (GVfs              *vfs,
 417                            const char        *scheme,
 418                            GVfsFileLookupFunc uri_func,
 419                            gpointer           uri_data,
 420                            GDestroyNotify     uri_destroy,
 421                            GVfsFileLookupFunc parse_name_func,
 422                            gpointer           parse_name_data,
 423                            GDestroyNotify     parse_name_destroy)
 424 {
 425   GVfsPrivate *priv;
 426   GVfsURISchemeData *closure;
 427
 428   g_return_val_if_fail (G_IS_VFS (vfs), FALSE);
 429   g_return_val_if_fail (scheme != NULL, FALSE);
 430
 431   priv = g_vfs_get_instance_private (vfs);
 432
 433   g_rw_lock_reader_lock (&additional_schemes_lock);
 434   closure = g_hash_table_lookup (priv->additional_schemes, scheme);
 435   g_rw_lock_reader_unlock (&additional_schemes_lock);
 436
 437   if (closure != NULL)
 438     return FALSE;
 439
 440   closure = g_new0 (GVfsURISchemeData, 1);
 441   closure->uri_func = uri_func;
 442   closure->uri_data = uri_data;
 443   closure->uri_destroy = uri_destroy;
 444   closure->parse_name_func = parse_name_func;
 445   closure->parse_name_data = parse_name_data;
 446   closure->parse_name_destroy = parse_name_destroy;
 447
 448   g_rw_lock_writer_lock (&additional_schemes_lock);
 449   g_hash_table_insert (priv->additional_schemes, g_strdup (scheme), closure);
 450   g_rw_lock_writer_unlock (&additional_schemes_lock);
 451
 452   /* Invalidate supported schemes */
 453   g_clear_pointer (&priv->supported_schemes, g_free);
 454
 455   return TRUE;
 456 }
 457
 458 /**
 459  * g_vfs_unregister_uri_scheme:
 460  * @vfs: a #GVfs
 461  * @scheme: an URI scheme, e.g. "http"
 462  *
 463  * Unregisters the URI handler for @scheme previously registered with
 464  * g_vfs_register_uri_scheme().
 465  *
 466  * Returns: %TRUE if @scheme was successfully unregistered, or %FALSE if a
 467  *     handler for @scheme does not exist.
 468  *
 469  * Since: 2.50
 470  */
 471 gboolean
 472 g_vfs_unregister_uri_scheme (GVfs       *vfs,
 473                              const char *scheme)
 474 {
 475   GVfsPrivate *priv;
 476   gboolean res;
 477
 478   g_return_val_if_fail (G_IS_VFS (vfs), FALSE);
 479   g_return_val_if_fail (scheme != NULL, FALSE);
 480
 481   priv = g_vfs_get_instance_private (vfs);
 482
 483   g_rw_lock_writer_lock (&additional_schemes_lock);
 484   res = g_hash_table_remove (priv->additional_schemes, scheme);
 485   g_rw_lock_writer_unlock (&additional_schemes_lock);
 486
 487   if (res)
 488     {
 489       /* Invalidate supported schemes */
 490       g_clear_pointer (&priv->supported_schemes, g_free);
 491
 492       return TRUE;
 493     }
 494
 495   return FALSE;
 496 }