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