src/libcaptive/client/directory.c

   1 /* $Id$
   2  * captive vfs 'directory' interface to reactos
   3  * Copyright (C) 2002-2003 Jan Kratochvil <project-captive@jankratochvil.net>
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; exactly version 2 of June 1991 is required
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  17  */
  18
  19
  20 #include "config.h"
  21
  22 #include "captive/client-directory.h"   /* self */
  23 #include "lib.h"
  24 #include <glib/gmessages.h>
  25 #include "captive/unicode.h"
  26 #include "reactos/ntos/types.h" /* for HANDLE */
  27 #include "reactos/ddk/iotypes.h"        /* for IO_STATUS_BLOCK */
  28 #include "reactos/ddk/iofuncs.h"        /* for IoCreateFile() */
  29 #include "captive/sandbox.h"
  30
  31
  32 static gpointer captive_directory_object_parent_class=NULL;
  33
  34
  35 static GnomeVFSResult captive_directory_close(CaptiveDirectoryObject *captive_directory_object);
  36
  37 static void captive_directory_object_finalize(CaptiveDirectoryObject *captive_directory_object)
  38 {
  39 GnomeVFSResult errvfsresult;
  40
  41         g_return_if_fail(captive_directory_object!=NULL);
  42
  43         errvfsresult=captive_directory_close(captive_directory_object);
  44         g_assert(errvfsresult==GNOME_VFS_OK);
  45
  46         G_OBJECT_CLASS(captive_directory_object_parent_class)->finalize((GObject *)captive_directory_object);
  47 }
  48
  49
  50 static void captive_directory_object_class_init(CaptiveDirectoryObjectClass *class)
  51 {
  52 GObjectClass *gobject_class=G_OBJECT_CLASS(class);
  53
  54         captive_directory_object_parent_class=g_type_class_ref(G_TYPE_OBJECT);
  55         gobject_class->finalize=(void (*)(GObject *object))captive_directory_object_finalize;
  56 }
  57
  58
  59 static void captive_directory_object_init(CaptiveDirectoryObject *captive_directory_object)
  60 {
  61         captive_directory_object->dir_Handle=NULL;
  62         captive_directory_object->read_first=TRUE;
  63 }
  64
  65
  66 GType captive_directory_object_get_type(void)
  67 {
  68 static GType captive_directory_object_type=0;
  69
  70         if (!captive_directory_object_type) {
  71 static const GTypeInfo captive_directory_object_info={
  72                                 sizeof(CaptiveDirectoryObjectClass),
  73                                 NULL,   /* base_init */
  74                                 NULL,   /* base_finalize */
  75                                 (GClassInitFunc)captive_directory_object_class_init,
  76                                 NULL,   /* class_finalize */
  77                                 NULL,   /* class_data */
  78                                 sizeof(CaptiveDirectoryObject),
  79                                 5,      /* n_preallocs */
  80                                 (GInstanceInitFunc)captive_directory_object_init,
  81                                 };
  82
  83                 captive_directory_object_type=g_type_register_static(G_TYPE_OBJECT,
  84                                 "CaptiveDirectoryObject",&captive_directory_object_info,0);
  85                 }
  86
  87         return captive_directory_object_type;
  88 }
  89
  90
  91 GnomeVFSResult captive_directory_new_open(CaptiveDirectoryObject **captive_directory_object_return,const gchar *pathname)
  92 {
  93 GnomeVFSResult errvfsresult;
  94 OBJECT_ATTRIBUTES dir_ObjectAttributes;
  95 HANDLE dir_Handle;
  96 IO_STATUS_BLOCK dir_IoStatusBlock;
  97 NTSTATUS err;
  98 CaptiveDirectoryObject *captive_directory_object;
  99
 100         if (CAPTIVE_IS_SANDBOX_PARENT())
 101                 return captive_sandbox_parent_directory_new_open(captive_directory_object_return,pathname);
 102
 103         g_return_val_if_fail(captive_directory_object_return!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 104         g_return_val_if_fail(pathname!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 105
 106         *captive_directory_object_return=NULL;
 107
 108         errvfsresult=captive_ObjectAttributes_init(pathname,&dir_ObjectAttributes);
 109         g_return_val_if_fail(errvfsresult==GNOME_VFS_OK,errvfsresult);
 110
 111         /* wanted: * IoCreateFile()->ObCreateObject(,,,IoFileObjectType)->
 112          * ->(IoFileObjectType->Create==IopCreateFile)()->IoMountVolume()
 113          */
 114         err=IoCreateFile(
 115                         &dir_Handle,    /* FileHandle */
 116                         FILE_LIST_DIRECTORY,    /* DesiredAccess */
 117                         &dir_ObjectAttributes,  /* ObjectAttributes */
 118                         &dir_IoStatusBlock,     /* IoStatusBlock */
 119                         NULL,   /* AllocationSize; ignored for open */
 120                         FILE_ATTRIBUTE_NORMAL,  /* FileAttributes; ignored for open */
 121                         FILE_SHARE_WRITE,       /* ShareAccess; 0 means exclusive */
 122                         FILE_OPEN,      /* CreateDisposition */
 123                         /* FILE_SYNCHRONOUS_IO_{,NON}ALERT: We need to allow W32 filesystem
 124                          * any waits to not to let it return STATUS_CANT_WAIT us.
 125                          * Alertability should have only effect on asynchronous events
 126                          * from KeWaitForSingleObject() by setting/clearing its parameter 'Alertable'.
 127                          */
 128                         FILE_DIRECTORY_FILE|FILE_SYNCHRONOUS_IO_ALERT,  /* CreateOptions */
 129                         NULL,   /* EaBuffer */
 130                         0,      /* EaLength */
 131                         CreateFileTypeNone,     /* CreateFileType */
 132                         NULL,   /* ExtraCreateParameters */
 133                         0);     /* Options */
 134         g_free(dir_ObjectAttributes.ObjectName);        /* left from captive_gnomevfs_uri_parent_init() */
 135         g_return_val_if_fail(NT_SUCCESS(err)==NT_SUCCESS(dir_IoStatusBlock.Status),GNOME_VFS_ERROR_GENERIC);
 136         g_return_val_if_fail(NT_SUCCESS(err),GNOME_VFS_ERROR_GENERIC);
 137         g_return_val_if_fail(dir_IoStatusBlock.Information==FILE_OPENED,GNOME_VFS_ERROR_GENERIC);
 138
 139         captive_directory_object=g_object_new(
 140                         CAPTIVE_DIRECTORY_TYPE_OBJECT,  /* object_type */
 141                         NULL);  /* first_property_name; FIXME: support properties */
 142
 143         captive_directory_object->dir_Handle=dir_Handle;
 144
 145         *captive_directory_object_return=captive_directory_object;
 146         return GNOME_VFS_OK;
 147 }
 148
 149
 150 static GnomeVFSResult FileIdBothDirInformation_to_GnomeVFSFileInfo(GnomeVFSFileInfo *file_info,
 151                 FILE_ID_BOTH_DIR_INFORMATION *FileIdBothDirInformation,IO_STATUS_BLOCK *IoStatusBlock)
 152 {
 153 UNICODE_STRING FileName_UnicodeString;
 154 BOOLEAN errBOOLEAN;
 155 ULONG tmp_ULONG;
 156
 157         g_return_val_if_fail(file_info!=NULL,GNOME_VFS_ERROR_GENERIC);
 158         g_return_val_if_fail(FileIdBothDirInformation!=NULL,GNOME_VFS_ERROR_GENERIC);
 159
 160         g_return_val_if_fail(NT_SUCCESS(IoStatusBlock->Status),GNOME_VFS_ERROR_GENERIC);
 161         /* do not exceed the returned buffer by this record;
 162          * '->NextEntryOffset' is ==0 as we used 'ReturnSingleEntry==TRUE'
 163          */
 164         g_assert((gpointer)(((char *)FileIdBothDirInformation)+FileIdBothDirInformation->NextEntryOffset)
 165                         <=(gpointer)(((char *)FileIdBothDirInformation)+IoStatusBlock->Information));
 166
 167         file_info->valid_fields=0;
 168
 169         FileName_UnicodeString.Length=FileIdBothDirInformation->FileNameLength;
 170         FileName_UnicodeString.MaximumLength=FileIdBothDirInformation->FileNameLength
 171                         +sizeof(*FileIdBothDirInformation->FileName);   /* 0-terminator */
 172         g_assert((gpointer)(((char *)FileIdBothDirInformation->FileName)+FileName_UnicodeString.Length)
 173                         <=(gpointer)(((char *)FileIdBothDirInformation)+IoStatusBlock->Information));
 174                                         /* ensure we fit below '->IoStatusBlock->Information' at least without the 0-terminator */
 175         FileIdBothDirInformation->FileName[FileIdBothDirInformation->FileNameLength
 176                         /sizeof(*FileIdBothDirInformation->FileName)]=0;        /* 0-terminate it */
 177         FileName_UnicodeString.Buffer=FileIdBothDirInformation->FileName;
 178         file_info->name=captive_UnicodeString_to_utf8_malloc(&FileName_UnicodeString);
 179         /* '->name' assumed for 'file_info->valid_fields' */
 180
 181         /* FIXME: What is 'FILE_ATTRIBUTE_NORMAL'? */
 182         switch (FileIdBothDirInformation->FileAttributes & (0
 183                         | FILE_ATTRIBUTE_DIRECTORY
 184                         | FILE_ATTRIBUTE_DEVICE)) {
 185                 case 0:                        file_info->type=GNOME_VFS_FILE_TYPE_REGULAR;   break;
 186                 case FILE_ATTRIBUTE_DIRECTORY: file_info->type=GNOME_VFS_FILE_TYPE_DIRECTORY; break;
 187                 case FILE_ATTRIBUTE_DEVICE:    file_info->type=GNOME_VFS_FILE_TYPE_SOCKET;
 188                         /* or GNOME_VFS_FILE_TYPE_CHARACTER_DEVICE or GNOME_VFS_FILE_TYPE_BLOCK_DEVICE ? */
 189                         break;
 190                 default:                       file_info->type=GNOME_VFS_FILE_TYPE_UNKNOWN;   break;
 191                 }
 192         file_info->valid_fields|=GNOME_VFS_FILE_INFO_FIELDS_TYPE;
 193
 194         /* we use 0600 for r/w files, 0400 for FILE_ATTRIBUTE_READONLY */
 195         file_info->permissions=GNOME_VFS_PERM_USER_READ;
 196         if (file_info->type==GNOME_VFS_FILE_TYPE_DIRECTORY)
 197                 file_info->permissions|=GNOME_VFS_PERM_USER_EXEC;
 198         if (!(FileIdBothDirInformation->FileAttributes & FILE_ATTRIBUTE_READONLY))
 199                 file_info->permissions|=GNOME_VFS_PERM_USER_WRITE;
 200         file_info->valid_fields|=GNOME_VFS_FILE_INFO_FIELDS_PERMISSIONS;
 201
 202         file_info->size=FileIdBothDirInformation->EndOfFile.QuadPart;
 203         file_info->valid_fields|=GNOME_VFS_FILE_INFO_FIELDS_SIZE;
 204
 205         file_info->block_count=FileIdBothDirInformation->AllocationSize.QuadPart/512;
 206         file_info->valid_fields|=GNOME_VFS_FILE_INFO_FIELDS_BLOCK_COUNT;
 207
 208         file_info->flags=GNOME_VFS_FILE_FLAGS_LOCAL;
 209         file_info->valid_fields|=GNOME_VFS_FILE_INFO_FIELDS_FLAGS;
 210
 211         if (FileIdBothDirInformation->LastAccessTime.QuadPart) {        /* it may be 0 if not set */
 212                 errBOOLEAN=RtlTimeToSecondsSince1970(&FileIdBothDirInformation->LastAccessTime,&tmp_ULONG);
 213                 g_assert(errBOOLEAN==TRUE);
 214                 file_info->atime=tmp_ULONG;
 215                 file_info->valid_fields|=GNOME_VFS_FILE_INFO_FIELDS_ATIME;
 216                 }
 217
 218         /* it may be 0 if not set */
 219         if (FileIdBothDirInformation->LastWriteTime.QuadPart || FileIdBothDirInformation->ChangeTime.QuadPart) {
 220                 errBOOLEAN=RtlTimeToSecondsSince1970(
 221                                 /* take the more recent (==bigger) time: */
 222                                 (FileIdBothDirInformation->LastWriteTime.QuadPart > FileIdBothDirInformation->ChangeTime.QuadPart
 223                                                 ? &FileIdBothDirInformation->LastWriteTime : &FileIdBothDirInformation->ChangeTime),
 224                                 &tmp_ULONG);
 225                 g_assert(errBOOLEAN==TRUE);
 226                 file_info->mtime=tmp_ULONG;
 227                 file_info->valid_fields|=GNOME_VFS_FILE_INFO_FIELDS_MTIME;
 228                 }
 229
 230         if (FileIdBothDirInformation->CreationTime.QuadPart) {  /* it may be 0 if not set */
 231                 errBOOLEAN=RtlTimeToSecondsSince1970(&FileIdBothDirInformation->CreationTime,&tmp_ULONG);
 232                 g_assert(errBOOLEAN==TRUE);
 233                 file_info->ctime=tmp_ULONG;
 234                 file_info->valid_fields|=GNOME_VFS_FILE_INFO_FIELDS_CTIME;
 235                 }
 236
 237         return GNOME_VFS_OK;
 238 }
 239
 240
 241 static GnomeVFSResult captive_directory_close(CaptiveDirectoryObject *captive_directory_object)
 242 {
 243 NTSTATUS err;
 244 HANDLE dir_Handle;
 245
 246         if (CAPTIVE_IS_SANDBOX_PARENT())
 247                 return captive_sandbox_parent_directory_close(captive_directory_object);
 248
 249         g_return_val_if_fail(captive_directory_object!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 250         g_return_val_if_fail(captive_directory_object->dir_Handle!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);        /* already closed */
 251
 252         dir_Handle=captive_directory_object->dir_Handle;
 253         captive_directory_object->dir_Handle=NULL;
 254         err=NtClose(dir_Handle);
 255         g_return_val_if_fail(NT_SUCCESS(err),GNOME_VFS_ERROR_GENERIC);
 256
 257         return GNOME_VFS_OK;
 258 }
 259
 260
 261 GnomeVFSResult captive_directory_read(CaptiveDirectoryObject *captive_directory_object,GnomeVFSFileInfo *file_info)
 262 {
 263 NTSTATUS err;
 264 IO_STATUS_BLOCK dir_IoStatusBlock;
 265 FILE_ID_BOTH_DIR_INFORMATION *FileIdBothDirInformation;
 266 GnomeVFSResult errvfsresult;
 267
 268         if (CAPTIVE_IS_SANDBOX_PARENT())
 269                 return captive_sandbox_parent_directory_read(captive_directory_object,file_info);
 270
 271         g_return_val_if_fail(captive_directory_object!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 272         g_return_val_if_fail(captive_directory_object->dir_Handle!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 273         g_return_val_if_fail(file_info!=NULL,GNOME_VFS_ERROR_BAD_PARAMETERS);
 274
 275         FileIdBothDirInformation=(void *)captive_directory_object->QueryDirectory_buf;
 276         err=NtQueryDirectoryFile(
 277                         captive_directory_object->dir_Handle,   /* FileHandle */
 278                         NULL,   /* PEvent; completion signalling; optional */
 279                         NULL,   /* ApcRoutine; optional */
 280                         NULL,   /* ApcContext; optional */
 281                         &dir_IoStatusBlock,     /* IoStatusBlock */
 282                         (gpointer)captive_directory_object->QueryDirectory_buf, /* FileInformation */
 283                         sizeof(captive_directory_object->QueryDirectory_buf)    /* Length */
 284                                         -sizeof(*FileIdBothDirInformation->FileName),   /* reserve space for 0-terminator */
 285                         FileIdBothDirectoryInformation, /* FileInformationClass; =>FILE_ID_BOTH_DIR_INFORMATION */
 286                         TRUE,   /* ReturnSingleEntry */
 287                         NULL,   /* FileName; wildcards possible; optional */
 288                         captive_directory_object->read_first);  /* RestartScan */
 289         captive_directory_object->read_first=FALSE;
 290         if (err==STATUS_NO_MORE_FILES)
 291                 return GNOME_VFS_ERROR_EOF;
 292         g_return_val_if_fail(NT_SUCCESS(err),GNOME_VFS_ERROR_GENERIC);
 293
 294         errvfsresult=FileIdBothDirInformation_to_GnomeVFSFileInfo(file_info,FileIdBothDirInformation,
 295                         &dir_IoStatusBlock);
 296         g_return_val_if_fail(errvfsresult==GNOME_VFS_OK,errvfsresult);
 297
 298         return GNOME_VFS_OK;
 299 }