gio/glocalfileenumerator.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 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, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  * Author: Alexander Larsson <alexl@redhat.com>
  21  */
  22
  23 #include <config.h>
  24
  25 #include <glib.h>
  26 #include <glocalfileenumerator.h>
  27 #include <glocalfileinfo.h>
  28 #include <glocalfile.h>
  29 #include <string.h>
  30 #include <stdlib.h>
  31 #include "glibintl.h"
  32
  33 #include "gioalias.h"
  34
  35 #define CHUNK_SIZE 1000
  36
  37   /* TODO:
  38    *  It would be nice to use the dirent->d_type to check file type without
  39    *  needing to stat each files on linux and other systems that support it.
  40    *  (question: does that following symlink or not?)
  41    */
  42
  43 #ifdef G_OS_WIN32
  44 #define USE_GDIR
  45 #endif
  46
  47 #ifndef USE_GDIR
  48
  49 #include <sys/types.h>
  50 #include <dirent.h>
  51 #include <errno.h>
  52
  53 typedef struct {
  54   char *name;
  55   long inode;
  56 } DirEntry;
  57
  58 #endif
  59
  60 struct _GLocalFileEnumerator
  61 {
  62   GFileEnumerator parent;
  63
  64   GFileAttributeMatcher *matcher;
  65   char *filename;
  66   char *attributes;
  67   GFileQueryInfoFlags flags;
  68
  69   gboolean got_parent_info;
  70   GLocalParentFileInfo parent_info;
  71
  72 #ifdef USE_GDIR
  73   GDir *dir;
  74 #else
  75   DIR *dir;
  76   DirEntry *entries;
  77   int entries_pos;
  78   gboolean at_end;
  79 #endif
  80
  81   gboolean follow_symlinks;
  82 };
  83
  84 #define g_local_file_enumerator_get_type _g_local_file_enumerator_get_type
  85 G_DEFINE_TYPE (GLocalFileEnumerator, g_local_file_enumerator, G_TYPE_FILE_ENUMERATOR);
  86
  87 static GFileInfo *g_local_file_enumerator_next_file (GFileEnumerator  *enumerator,
  88                                                      GCancellable     *cancellable,
  89                                                      GError          **error);
  90 static gboolean   g_local_file_enumerator_close     (GFileEnumerator  *enumerator,
  91                                                      GCancellable     *cancellable,
  92                                                      GError          **error);
  93
  94
  95 static void
  96 free_entries (GLocalFileEnumerator *local)
  97 {
  98 #ifndef USE_GDIR
  99   int i;
 100
 101   if (local->entries != NULL)
 102     {
 103       for (i = 0; local->entries[i].name != NULL; i++)
 104         g_free (local->entries[i].name);
 105
 106       g_free (local->entries);
 107     }
 108 #endif
 109 }
 110
 111 static void
 112 g_local_file_enumerator_finalize (GObject *object)
 113 {
 114   GLocalFileEnumerator *local;
 115
 116   local = G_LOCAL_FILE_ENUMERATOR (object);
 117
 118   g_free (local->filename);
 119   g_file_attribute_matcher_unref (local->matcher);
 120   if (local->dir)
 121     {
 122 #ifdef USE_GDIR
 123       g_dir_close (local->dir);
 124 #else
 125       closedir (local->dir);
 126 #endif
 127       local->dir = NULL;
 128     }
 129
 130   free_entries (local);
 131
 132   G_OBJECT_CLASS (g_local_file_enumerator_parent_class)->finalize (object);
 133 }
 134
 135
 136 static void
 137 g_local_file_enumerator_class_init (GLocalFileEnumeratorClass *klass)
 138 {
 139   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
 140   GFileEnumeratorClass *enumerator_class = G_FILE_ENUMERATOR_CLASS (klass);
 141
 142   gobject_class->finalize = g_local_file_enumerator_finalize;
 143
 144   enumerator_class->next_file = g_local_file_enumerator_next_file;
 145   enumerator_class->close_fn = g_local_file_enumerator_close;
 146 }
 147
 148 static void
 149 g_local_file_enumerator_init (GLocalFileEnumerator *local)
 150 {
 151 }
 152
 153 #ifdef USE_GDIR
 154 static void
 155 convert_file_to_io_error (GError **error,
 156                           GError  *file_error)
 157 {
 158   int new_code;
 159
 160   if (file_error == NULL)
 161     return;
 162
 163   new_code = G_IO_ERROR_FAILED;
 164
 165   if (file_error->domain == G_FILE_ERROR)
 166     {
 167       switch (file_error->code)
 168         {
 169         case G_FILE_ERROR_NOENT:
 170           new_code = G_IO_ERROR_NOT_FOUND;
 171           break;
 172         case G_FILE_ERROR_ACCES:
 173           new_code = G_IO_ERROR_PERMISSION_DENIED;
 174           break;
 175         case G_FILE_ERROR_NOTDIR:
 176           new_code = G_IO_ERROR_NOT_DIRECTORY;
 177           break;
 178         default:
 179           break;
 180         }
 181     }
 182
 183   g_set_error_literal (error, G_IO_ERROR,
 184                        new_code,
 185                        file_error->message);
 186 }
 187 #endif
 188
 189 GFileEnumerator *
 190 _g_local_file_enumerator_new (GLocalFile *file,
 191                               const char           *attributes,
 192                               GFileQueryInfoFlags   flags,
 193                               GCancellable         *cancellable,
 194                               GError              **error)
 195 {
 196   GLocalFileEnumerator *local;
 197   char *filename = g_file_get_path (G_FILE (file));
 198
 199 #ifdef USE_GDIR
 200   GError *dir_error;
 201   GDir *dir;
 202
 203   dir_error = NULL;
 204   dir = g_dir_open (filename, 0, error != NULL ? &dir_error : NULL);
 205   if (dir == NULL)
 206     {
 207       if (error != NULL)
 208         {
 209           convert_file_to_io_error (error, dir_error);
 210           g_error_free (dir_error);
 211         }
 212       g_free (filename);
 213       return NULL;
 214     }
 215 #else
 216   DIR *dir;
 217   int errsv;
 218
 219   dir = opendir (filename);
 220   if (dir == NULL)
 221     {
 222       errsv = errno;
 223
 224       g_set_error_literal (error, G_IO_ERROR,
 225                            g_io_error_from_errno (errsv),
 226                            g_strerror (errsv));
 227       g_free (filename);
 228       return NULL;
 229     }
 230
 231 #endif
 232
 233   local = g_object_new (G_TYPE_LOCAL_FILE_ENUMERATOR,
 234                         "container", file,
 235                         NULL);
 236
 237   local->dir = dir;
 238   local->filename = filename;
 239   local->matcher = g_file_attribute_matcher_new (attributes);
 240   local->flags = flags;
 241
 242   return G_FILE_ENUMERATOR (local);
 243 }
 244
 245 #ifndef USE_GDIR
 246 static int
 247 sort_by_inode (const void *_a, const void *_b)
 248 {
 249   const DirEntry *a, *b;
 250
 251   a = _a;
 252   b = _b;
 253   return a->inode - b->inode;
 254 }
 255
 256 static const char *
 257 next_file_helper (GLocalFileEnumerator *local)
 258 {
 259   struct dirent *entry;
 260   const char *filename;
 261   int i;
 262
 263   if (local->at_end)
 264     return NULL;
 265
 266   if (local->entries == NULL ||
 267       (local->entries[local->entries_pos].name == NULL))
 268     {
 269       if (local->entries == NULL)
 270         local->entries = g_new (DirEntry, CHUNK_SIZE + 1);
 271       else
 272         {
 273           /* Restart by clearing old names */
 274           for (i = 0; local->entries[i].name != NULL; i++)
 275             g_free (local->entries[i].name);
 276         }
 277
 278       for (i = 0; i < CHUNK_SIZE; i++)
 279         {
 280           entry = readdir (local->dir);
 281           while (entry
 282                  && (0 == strcmp (entry->d_name, ".") ||
 283                      0 == strcmp (entry->d_name, "..")))
 284             entry = readdir (local->dir);
 285
 286           if (entry)
 287             {
 288               local->entries[i].name = g_strdup (entry->d_name);
 289               local->entries[i].inode = entry->d_ino;
 290             }
 291           else
 292             break;
 293         }
 294       local->entries[i].name = NULL;
 295       local->entries_pos = 0;
 296
 297       qsort (local->entries, i, sizeof (DirEntry), sort_by_inode);
 298     }
 299
 300   filename = local->entries[local->entries_pos++].name;
 301   if (filename == NULL)
 302     local->at_end = TRUE;
 303
 304   return filename;
 305 }
 306
 307 #endif
 308
 309 static GFileInfo *
 310 g_local_file_enumerator_next_file (GFileEnumerator  *enumerator,
 311                                    GCancellable     *cancellable,
 312                                    GError          **error)
 313 {
 314   GLocalFileEnumerator *local = G_LOCAL_FILE_ENUMERATOR (enumerator);
 315   const char *filename;
 316   char *path;
 317   GFileInfo *info;
 318   GError *my_error;
 319
 320   if (!local->got_parent_info)
 321     {
 322       _g_local_file_info_get_parent_info (local->filename, local->matcher, &local->parent_info);
 323       local->got_parent_info = TRUE;
 324     }
 325
 326  next_file:
 327
 328 #ifdef USE_GDIR
 329   filename = g_dir_read_name (local->dir);
 330 #else
 331   filename = next_file_helper (local);
 332 #endif
 333
 334   if (filename == NULL)
 335     return NULL;
 336
 337   my_error = NULL;
 338   path = g_build_filename (local->filename, filename, NULL);
 339   info = _g_local_file_info_get (filename, path,
 340                                  local->matcher,
 341                                  local->flags,
 342                                  &local->parent_info,
 343                                  &my_error);
 344   g_free (path);
 345
 346   if (info == NULL)
 347     {
 348       /* Failed to get info */
 349       /* If the file does not exist there might have been a race where
 350        * the file was removed between the readdir and the stat, so we
 351        * ignore the file. */
 352       if (my_error->domain == G_IO_ERROR &&
 353           my_error->code == G_IO_ERROR_NOT_FOUND)
 354         {
 355           g_error_free (my_error);
 356           goto next_file;
 357         }
 358       else
 359         g_propagate_error (error, my_error);
 360     }
 361
 362   return info;
 363 }
 364
 365 static gboolean
 366 g_local_file_enumerator_close (GFileEnumerator  *enumerator,
 367                                GCancellable     *cancellable,
 368                                GError          **error)
 369 {
 370   GLocalFileEnumerator *local = G_LOCAL_FILE_ENUMERATOR (enumerator);
 371
 372   if (local->dir)
 373     {
 374 #ifdef USE_GDIR
 375       g_dir_close (local->dir);
 376 #else
 377       closedir (local->dir);
 378 #endif
 379       local->dir = NULL;
 380     }
 381
 382   return TRUE;
 383 }
 384
 385